skillguard/lib/api-zod/src/generated/api.ts

/**
 * Generated by orval v8.9.1 🍺
 * Do not edit manually.
 * Api
 * API specification
 * OpenAPI spec version: 0.1.0
 */
import * as zod from 'zod';


/**
 * Returns server health status
 * @summary Health check
 */
export const HealthCheckResponse = zod.object({
  "status": zod.string()
})


/**
 * Aggregated statistics across all scans.
 * @summary Dashboard summary
 */
export const GetDashboardResponse = zod.object({
  "totalScans": zod.number(),
  "avgRiskScore": zod.number(),
  "verdictCounts": zod.object({
  "pass": zod.number(),
  "review": zod.number(),
  "block": zod.number()
}),
  "severityTotals": zod.object({
  "critical": zod.number(),
  "high": zod.number(),
  "medium": zod.number(),
  "low": zod.number(),
  "info": zod.number()
}),
  "axisTotals": zod.object({
  "security": zod.number(),
  "privacy": zod.number()
}),
  "recentScans": zod.array(zod.object({
  "id": zod.number(),
  "name": zod.string(),
  "description": zod.string().nullish().describe('AI-generated summary of the skill\'s purpose (null when no AI description is available)'),
  "source": zod.enum(['zip', 'file', 'text']),
  "status": zod.enum(['completed', 'failed']),
  "verdict": zod.enum(['pass', 'review', 'block']),
  "riskScore": zod.number(),
  "fileCount": zod.number(),
  "aiUsed": zod.boolean(),
  "aiError": zod.string().nullish(),
  "findingCounts": zod.object({
  "critical": zod.number(),
  "high": zod.number(),
  "medium": zod.number(),
  "low": zod.number(),
  "info": zod.number(),
  "security": zod.number(),
  "privacy": zod.number(),
  "total": zod.number()
}),
  "fingerprint": zod.string().describe('Deterministic hash over all files (path + per-file hash)'),
  "relation": zod.union([zod.literal('new'),zod.literal('identical'),zod.literal('modified'),zod.literal(null)]).nullable().describe('Relation to previously stored skills'),
  "similarity": zod.number().nullable().describe('Content-aware similarity (0-100) to the compared skill (identical files count fully, changed text files use line-level similarity)'),
  "comparedScanId": zod.number().nullable().describe('The scan this one was compared against, if any'),
  "createdAt": zod.string()
})),
  "topRules": zod.array(zod.object({
  "ruleId": zod.string(),
  "title": zod.string(),
  "axis": zod.enum(['security', 'privacy']),
  "count": zod.number()
}))
})


/**
 * @summary List scan history
 */
export const ListScansResponseItem = zod.object({
  "id": zod.number(),
  "name": zod.string(),
  "description": zod.string().nullish().describe('AI-generated summary of the skill\'s purpose (null when no AI description is available)'),
  "source": zod.enum(['zip', 'file', 'text']),
  "status": zod.enum(['completed', 'failed']),
  "verdict": zod.enum(['pass', 'review', 'block']),
  "riskScore": zod.number(),
  "fileCount": zod.number(),
  "aiUsed": zod.boolean(),
  "aiError": zod.string().nullish(),
  "findingCounts": zod.object({
  "critical": zod.number(),
  "high": zod.number(),
  "medium": zod.number(),
  "low": zod.number(),
  "info": zod.number(),
  "security": zod.number(),
  "privacy": zod.number(),
  "total": zod.number()
}),
  "fingerprint": zod.string().describe('Deterministic hash over all files (path + per-file hash)'),
  "relation": zod.union([zod.literal('new'),zod.literal('identical'),zod.literal('modified'),zod.literal(null)]).nullable().describe('Relation to previously stored skills'),
  "similarity": zod.number().nullable().describe('Content-aware similarity (0-100) to the compared skill (identical files count fully, changed text files use line-level similarity)'),
  "comparedScanId": zod.number().nullable().describe('The scan this one was compared against, if any'),
  "createdAt": zod.string()
})
export const ListScansResponse = zod.array(ListScansResponseItem)


/**
 * Accepts a skill as a base64 ZIP archive, a single base64 file, or pasted text, runs the static rule engine and (optionally) the configured AI analysis, and returns the completed report.
 * @summary Upload a skill and run an audit
 */
export const CreateScanBody = zod.object({
  "name": zod.string().nullish().describe('Optional display name for the scan'),
  "source": zod.enum(['zip', 'file', 'text']),
  "useAi": zod.boolean().describe('Whether to also run the configured AI analysis'),
  "contentBase64": zod.string().nullish().describe('Base64 content for source=zip or source=file'),
  "filename": zod.string().nullish().describe('Original filename for source=file or source=zip'),
  "text": zod.string().nullish().describe('Raw skill text for source=text')
})


/**
 * Returns a file-level diff between the current scan (id) and a previously stored scan (otherId), including line-by-line diffs for modified text files.
 * @summary Compare two scans on the file level
 */
export const CompareScansParams = zod.object({
  "id": zod.coerce.number(),
  "otherId": zod.coerce.number()
})

export const CompareScansResponse = zod.object({
  "current": zod.object({
  "id": zod.number(),
  "name": zod.string(),
  "verdict": zod.enum(['pass', 'review', 'block']),
  "riskScore": zod.number(),
  "fileCount": zod.number(),
  "fingerprint": zod.string(),
  "createdAt": zod.string()
}),
  "previous": zod.object({
  "id": zod.number(),
  "name": zod.string(),
  "verdict": zod.enum(['pass', 'review', 'block']),
  "riskScore": zod.number(),
  "fileCount": zod.number(),
  "fingerprint": zod.string(),
  "createdAt": zod.string()
}),
  "files": zod.array(zod.object({
  "path": zod.string(),
  "status": zod.enum(['unchanged', 'modified', 'added', 'removed']),
  "previousHash": zod.string().nullable(),
  "currentHash": zod.string().nullable(),
  "previousSize": zod.number().nullable(),
  "currentSize": zod.number().nullable(),
  "previousHasContent": zod.boolean().nullable(),
  "currentHasContent": zod.boolean().nullable(),
  "lineDiff": zod.union([zod.array(zod.object({
  "type": zod.enum(['context', 'add', 'remove']),
  "text": zod.string(),
  "previousLine": zod.number().nullable(),
  "currentLine": zod.number().nullable()
})),zod.null()])
}))
})


/**
 * Returns every scan in the same fingerprint lineage as the given scan (linked by an identical fingerprint or by the comparedScanId chain), newest first, so the full version history of a skill can be shown on a timeline without re-scanning.
 * @summary Get the version timeline for a skill family
 */
export const GetScanLineageParams = zod.object({
  "id": zod.coerce.number()
})

export const GetScanLineageResponseItem = zod.object({
  "id": zod.number(),
  "name": zod.string(),
  "verdict": zod.enum(['pass', 'review', 'block']),
  "riskScore": zod.number(),
  "relation": zod.union([zod.literal('new'),zod.literal('identical'),zod.literal('modified'),zod.literal(null)]).nullable().describe('Relation of this version to the one it was compared against'),
  "similarity": zod.number().nullable().describe('Content-aware similarity (0-100) to its compared version'),
  "comparedScanId": zod.number().nullable().describe('The prior version this scan was compared against, if any'),
  "fingerprint": zod.string(),
  "createdAt": zod.string()
})
export const GetScanLineageResponse = zod.array(GetScanLineageResponseItem)


/**
 * @summary Get a scan report with findings
 */
export const GetScanParams = zod.object({
  "id": zod.coerce.number()
})

export const GetScanResponse = zod.object({
  "id": zod.number(),
  "name": zod.string(),
  "description": zod.string().nullish().describe('AI-generated summary of the skill\'s purpose (null when no AI description is available)'),
  "source": zod.enum(['zip', 'file', 'text']),
  "status": zod.enum(['completed', 'failed']),
  "verdict": zod.enum(['pass', 'review', 'block']),
  "riskScore": zod.number(),
  "fileCount": zod.number(),
  "aiUsed": zod.boolean(),
  "aiError": zod.string().nullish(),
  "findingCounts": zod.object({
  "critical": zod.number(),
  "high": zod.number(),
  "medium": zod.number(),
  "low": zod.number(),
  "info": zod.number(),
  "security": zod.number(),
  "privacy": zod.number(),
  "total": zod.number()
}),
  "fingerprint": zod.string().describe('Deterministic hash over all files (path + per-file hash)'),
  "relation": zod.union([zod.literal('new'),zod.literal('identical'),zod.literal('modified'),zod.literal(null)]).nullable().describe('Relation to previously stored skills'),
  "similarity": zod.number().nullable().describe('Content-aware similarity (0-100) to the compared skill (identical files count fully, changed text files use line-level similarity)'),
  "comparedScanId": zod.number().nullable().describe('The scan this one was compared against, if any'),
  "createdAt": zod.string()
}).and(zod.object({
  "files": zod.array(zod.object({
  "path": zod.string(),
  "kind": zod.enum(['instruction', 'script', 'resource']),
  "language": zod.string().nullish(),
  "size": zod.number(),
  "hash": zod.string().describe('SHA-256 hash of the file content'),
  "hasContent": zod.boolean().describe('Whether the text content was stored (false for binary files)')
})),
  "findings": zod.array(zod.object({
  "id": zod.number(),
  "ruleId": zod.string(),
  "axis": zod.enum(['security', 'privacy']),
  "severity": zod.enum(['critical', 'high', 'medium', 'low', 'info']),
  "title": zod.string(),
  "description": zod.string(),
  "remediation": zod.string().nullish(),
  "file": zod.string().nullish(),
  "line": zod.number().nullish(),
  "snippet": zod.string().nullish(),
  "detectedBy": zod.enum(['static', 'ai'])
})),
  "checkpoints": zod.array(zod.object({
  "id": zod.string(),
  "label": zod.string(),
  "category": zod.string(),
  "axis": zod.union([zod.literal('security'),zod.literal('privacy'),zod.literal(null)]).nullish(),
  "severity": zod.union([zod.literal('critical'),zod.literal('high'),zod.literal('medium'),zod.literal('low'),zod.literal('info'),zod.literal(null)]).nullish(),
  "status": zod.enum(['pass', 'flagged', 'skipped', 'error']),
  "findingCount": zod.number(),
  "scoreDelta": zod.number(),
  "detectedBy": zod.union([zod.literal('static'),zod.literal('ai'),zod.literal(null)]).nullish()
}).describe('A single inspection step (Prüfschritt) with its partial assessment (Teilbewertung).')),
  "checkCount": zod.number().describe('How often a skill with this exact fingerprint was scanned'),
  "comparedScan": zod.union([zod.object({
  "id": zod.number(),
  "name": zod.string(),
  "verdict": zod.enum(['pass', 'review', 'block']),
  "riskScore": zod.number(),
  "createdAt": zod.string()
}),zod.null()])
}))


/**
 * @summary Delete a scan report
 */
export const DeleteScanParams = zod.object({
  "id": zod.coerce.number()
})


/**
 * @summary Generate the AI description for an existing scan
 */
export const GenerateScanDescriptionParams = zod.object({
  "id": zod.coerce.number()
})

export const GenerateScanDescriptionResponse = zod.object({
  "id": zod.number(),
  "name": zod.string(),
  "description": zod.string().nullish().describe('AI-generated summary of the skill\'s purpose (null when no AI description is available)'),
  "source": zod.enum(['zip', 'file', 'text']),
  "status": zod.enum(['completed', 'failed']),
  "verdict": zod.enum(['pass', 'review', 'block']),
  "riskScore": zod.number(),
  "fileCount": zod.number(),
  "aiUsed": zod.boolean(),
  "aiError": zod.string().nullish(),
  "findingCounts": zod.object({
  "critical": zod.number(),
  "high": zod.number(),
  "medium": zod.number(),
  "low": zod.number(),
  "info": zod.number(),
  "security": zod.number(),
  "privacy": zod.number(),
  "total": zod.number()
}),
  "fingerprint": zod.string().describe('Deterministic hash over all files (path + per-file hash)'),
  "relation": zod.union([zod.literal('new'),zod.literal('identical'),zod.literal('modified'),zod.literal(null)]).nullable().describe('Relation to previously stored skills'),
  "similarity": zod.number().nullable().describe('Content-aware similarity (0-100) to the compared skill (identical files count fully, changed text files use line-level similarity)'),
  "comparedScanId": zod.number().nullable().describe('The scan this one was compared against, if any'),
  "createdAt": zod.string()
}).and(zod.object({
  "files": zod.array(zod.object({
  "path": zod.string(),
  "kind": zod.enum(['instruction', 'script', 'resource']),
  "language": zod.string().nullish(),
  "size": zod.number(),
  "hash": zod.string().describe('SHA-256 hash of the file content'),
  "hasContent": zod.boolean().describe('Whether the text content was stored (false for binary files)')
})),
  "findings": zod.array(zod.object({
  "id": zod.number(),
  "ruleId": zod.string(),
  "axis": zod.enum(['security', 'privacy']),
  "severity": zod.enum(['critical', 'high', 'medium', 'low', 'info']),
  "title": zod.string(),
  "description": zod.string(),
  "remediation": zod.string().nullish(),
  "file": zod.string().nullish(),
  "line": zod.number().nullish(),
  "snippet": zod.string().nullish(),
  "detectedBy": zod.enum(['static', 'ai'])
})),
  "checkpoints": zod.array(zod.object({
  "id": zod.string(),
  "label": zod.string(),
  "category": zod.string(),
  "axis": zod.union([zod.literal('security'),zod.literal('privacy'),zod.literal(null)]).nullish(),
  "severity": zod.union([zod.literal('critical'),zod.literal('high'),zod.literal('medium'),zod.literal('low'),zod.literal('info'),zod.literal(null)]).nullish(),
  "status": zod.enum(['pass', 'flagged', 'skipped', 'error']),
  "findingCount": zod.number(),
  "scoreDelta": zod.number(),
  "detectedBy": zod.union([zod.literal('static'),zod.literal('ai'),zod.literal(null)]).nullish()
}).describe('A single inspection step (Prüfschritt) with its partial assessment (Teilbewertung).')),
  "checkCount": zod.number().describe('How often a skill with this exact fingerprint was scanned'),
  "comparedScan": zod.union([zod.object({
  "id": zod.number(),
  "name": zod.string(),
  "verdict": zod.enum(['pass', 'review', 'block']),
  "riskScore": zod.number(),
  "createdAt": zod.string()
}),zod.null()])
}))


/**
 * @summary List configured AI providers
 */
export const ListProvidersResponseItem = zod.object({
  "id": zod.number(),
  "name": zod.string(),
  "apiType": zod.enum(['openai', 'anthropic', 'custom']),
  "baseUrl": zod.string(),
  "model": zod.string(),
  "enabled": zod.boolean(),
  "hasToken": zod.boolean(),
  "tokenPreview": zod.string().describe('Masked preview of the stored token (e.g. \"sk-...abcd\")'),
  "createdAt": zod.string()
})
export const ListProvidersResponse = zod.array(ListProvidersResponseItem)


/**
 * @summary Create an AI provider
 */





export const CreateProviderBody = zod.object({
  "name": zod.string().min(1),
  "apiType": zod.enum(['openai', 'anthropic', 'custom']),
  "baseUrl": zod.string().min(1),
  "model": zod.string().min(1),
  "apiToken": zod.string().optional(),
  "enabled": zod.boolean().optional()
})


/**
 * @summary Update an AI provider
 */
export const UpdateProviderParams = zod.object({
  "id": zod.coerce.number()
})






export const UpdateProviderBody = zod.object({
  "name": zod.string().min(1).optional(),
  "apiType": zod.enum(['openai', 'anthropic', 'custom']).optional(),
  "baseUrl": zod.string().min(1).optional(),
  "model": zod.string().min(1).optional(),
  "apiToken": zod.string().optional().describe('Provide to replace the stored token; omit to keep existing'),
  "enabled": zod.boolean().optional()
})

export const UpdateProviderResponse = zod.object({
  "id": zod.number(),
  "name": zod.string(),
  "apiType": zod.enum(['openai', 'anthropic', 'custom']),
  "baseUrl": zod.string(),
  "model": zod.string(),
  "enabled": zod.boolean(),
  "hasToken": zod.boolean(),
  "tokenPreview": zod.string().describe('Masked preview of the stored token (e.g. \"sk-...abcd\")'),
  "createdAt": zod.string()
})


/**
 * @summary Delete an AI provider
 */
export const DeleteProviderParams = zod.object({
  "id": zod.coerce.number()
})


/**
 * @summary Test the connection to an AI provider
 */
export const TestProviderParams = zod.object({
  "id": zod.coerce.number()
})

export const TestProviderResponse = zod.object({
  "ok": zod.boolean(),
  "message": zod.string().nullish()
})


/**
 * @summary Test a provider connection with ad-hoc configuration
 */



export const TestProviderConnectionBody = zod.object({
  "apiType": zod.enum(['openai', 'anthropic', 'custom']),
  "baseUrl": zod.string().min(1),
  "model": zod.string().optional().describe('Optional model to exercise with a full request; when omitted the test verifies credentials via the models endpoint instead'),
  "apiToken": zod.string().optional().describe('Token to use for the test; omit or leave empty to fall back to the stored token of providerId'),
  "providerId": zod.number().optional().describe('When apiToken is empty, fall back to this saved provider\'s stored token')
})

export const TestProviderConnectionResponse = zod.object({
  "ok": zod.boolean(),
  "message": zod.string().nullish()
})


/**
 * Queries the provider's models endpoint with the supplied ad-hoc configuration (or the stored token of providerId when the token is omitted) and returns the discovered model IDs.
 * @summary List the available models for a provider configuration
 */



export const ListProviderModelsBody = zod.object({
  "apiType": zod.enum(['openai', 'anthropic', 'custom']),
  "baseUrl": zod.string().min(1),
  "apiToken": zod.string().optional().describe('Token to use for the request; omit or leave empty to fall back to the stored token of providerId'),
  "providerId": zod.number().optional().describe('When apiToken is empty, fall back to this saved provider\'s stored token')
})

export const ListProviderModelsResponse = zod.object({
  "ok": zod.boolean(),
  "models": zod.array(zod.string()),
  "message": zod.string().nullish()
})


/**
 * @summary List configurable AI prompts
 */
export const ListPromptsResponseItem = zod.object({
  "id": zod.number(),
  "key": zod.string(),
  "name": zod.string(),
  "content": zod.string(),
  "updatedAt": zod.string()
})
export const ListPromptsResponse = zod.array(ListPromptsResponseItem)


/**
 * @summary Update an AI prompt
 */
export const UpdatePromptParams = zod.object({
  "id": zod.coerce.number()
})





export const UpdatePromptBody = zod.object({
  "name": zod.string().min(1).optional(),
  "content": zod.string().min(1).optional()
})

export const UpdatePromptResponse = zod.object({
  "id": zod.number(),
  "key": zod.string(),
  "name": zod.string(),
  "content": zod.string(),
  "updatedAt": zod.string()
})


/**
 * @summary List the static rule catalog
 */
export const ListRulesResponseItem = zod.object({
  "id": zod.number(),
  "ruleId": zod.string(),
  "axis": zod.enum(['security', 'privacy']),
  "category": zod.string(),
  "title": zod.string(),
  "description": zod.string(),
  "severity": zod.enum(['critical', 'high', 'medium', 'low', 'info']),
  "detectionType": zod.enum(['regex', 'heuristic', 'ai']),
  "enabled": zod.boolean()
})
export const ListRulesResponse = zod.array(ListRulesResponseItem)


/**
 * @summary Update a rule's severity or enabled state
 */
export const UpdateRuleParams = zod.object({
  "id": zod.coerce.number()
})

export const UpdateRuleBody = zod.object({
  "severity": zod.enum(['critical', 'high', 'medium', 'low', 'info']).optional(),
  "enabled": zod.boolean().optional()
})

export const UpdateRuleResponse = zod.object({
  "id": zod.number(),
  "ruleId": zod.string(),
  "axis": zod.enum(['security', 'privacy']),
  "category": zod.string(),
  "title": zod.string(),
  "description": zod.string(),
  "severity": zod.enum(['critical', 'high', 'medium', 'low', 'info']),
  "detectionType": zod.enum(['regex', 'heuristic', 'ai']),
  "enabled": zod.boolean()
})