@vfarcic/dot-ai
Version:
AI-powered development productivity platform that enhances software development workflows through intelligent automation and AI-driven assistance
238 lines • 8.12 kB
TypeScript
/**
* Prompts Endpoint Schemas
*
* Schemas for the /api/v1/prompts and /api/v1/prompts/:promptName endpoints.
* PRD #354: REST API Route Registry with Auto-Generated OpenAPI and Test Fixtures
*/
import { z } from 'zod';
/**
* Prompt argument definition
*/
export declare const PromptArgumentSchema: z.ZodObject<{
name: z.ZodString;
description: z.ZodOptional<z.ZodString>;
required: z.ZodOptional<z.ZodBoolean>;
}, z.core.$strip>;
export type PromptArgument = z.infer<typeof PromptArgumentSchema>;
/**
* Prompt information in list
*/
export declare const PromptInfoSchema: z.ZodObject<{
name: z.ZodString;
description: z.ZodOptional<z.ZodString>;
arguments: z.ZodOptional<z.ZodArray<z.ZodObject<{
name: z.ZodString;
description: z.ZodOptional<z.ZodString>;
required: z.ZodOptional<z.ZodBoolean>;
}, z.core.$strip>>>;
}, z.core.$strip>;
export type PromptInfo = z.infer<typeof PromptInfoSchema>;
/**
* Prompts list response data
* GET /api/v1/prompts
*/
export declare const PromptsListDataSchema: z.ZodObject<{
prompts: z.ZodArray<z.ZodObject<{
name: z.ZodString;
description: z.ZodOptional<z.ZodString>;
arguments: z.ZodOptional<z.ZodArray<z.ZodObject<{
name: z.ZodString;
description: z.ZodOptional<z.ZodString>;
required: z.ZodOptional<z.ZodBoolean>;
}, z.core.$strip>>>;
}, z.core.$strip>>;
}, z.core.$strip>;
export type PromptsListData = z.infer<typeof PromptsListDataSchema>;
export declare const PromptsListResponseSchema: z.ZodObject<{
success: z.ZodLiteral<true>;
data: z.ZodObject<{
prompts: z.ZodArray<z.ZodObject<{
name: z.ZodString;
description: z.ZodOptional<z.ZodString>;
arguments: z.ZodOptional<z.ZodArray<z.ZodObject<{
name: z.ZodString;
description: z.ZodOptional<z.ZodString>;
required: z.ZodOptional<z.ZodBoolean>;
}, z.core.$strip>>>;
}, z.core.$strip>>;
}, z.core.$strip>;
meta: z.ZodOptional<z.ZodObject<{
timestamp: z.ZodString;
requestId: z.ZodOptional<z.ZodString>;
version: z.ZodString;
}, z.core.$strip>>;
}, z.core.$strip>;
export type PromptsListResponse = z.infer<typeof PromptsListResponseSchema>;
/**
* Prompt message content
*/
export declare const PromptMessageSchema: z.ZodObject<{
role: z.ZodEnum<{
user: "user";
system: "system";
assistant: "assistant";
}>;
content: z.ZodObject<{
type: z.ZodLiteral<"text">;
text: z.ZodString;
}, z.core.$strip>;
}, z.core.$strip>;
export type PromptMessage = z.infer<typeof PromptMessageSchema>;
/**
* Supporting file for folder-based skills (base64-encoded)
*/
export declare const PromptFileSchema: z.ZodObject<{
path: z.ZodString;
content: z.ZodString;
}, z.core.$strip>;
export type PromptFileData = z.infer<typeof PromptFileSchema>;
/**
* Prompt get response data
* POST /api/v1/prompts/:promptName
*/
export declare const PromptGetDataSchema: z.ZodObject<{
description: z.ZodOptional<z.ZodString>;
messages: z.ZodArray<z.ZodObject<{
role: z.ZodEnum<{
user: "user";
system: "system";
assistant: "assistant";
}>;
content: z.ZodObject<{
type: z.ZodLiteral<"text">;
text: z.ZodString;
}, z.core.$strip>;
}, z.core.$strip>>;
files: z.ZodOptional<z.ZodArray<z.ZodObject<{
path: z.ZodString;
content: z.ZodString;
}, z.core.$strip>>>;
}, z.core.$strip>;
export type PromptGetData = z.infer<typeof PromptGetDataSchema>;
export declare const PromptGetResponseSchema: z.ZodObject<{
success: z.ZodLiteral<true>;
data: z.ZodObject<{
description: z.ZodOptional<z.ZodString>;
messages: z.ZodArray<z.ZodObject<{
role: z.ZodEnum<{
user: "user";
system: "system";
assistant: "assistant";
}>;
content: z.ZodObject<{
type: z.ZodLiteral<"text">;
text: z.ZodString;
}, z.core.$strip>;
}, z.core.$strip>>;
files: z.ZodOptional<z.ZodArray<z.ZodObject<{
path: z.ZodString;
content: z.ZodString;
}, z.core.$strip>>>;
}, z.core.$strip>;
meta: z.ZodOptional<z.ZodObject<{
timestamp: z.ZodString;
requestId: z.ZodOptional<z.ZodString>;
version: z.ZodString;
}, z.core.$strip>>;
}, z.core.$strip>;
export type PromptGetResponse = z.infer<typeof PromptGetResponseSchema>;
/**
* Prompt get request body
*/
export declare const PromptGetRequestSchema: z.ZodObject<{
arguments: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
}, z.core.$strip>;
export type PromptGetRequest = z.infer<typeof PromptGetRequestSchema>;
/**
* Prompts endpoint error schemas
*/
export declare const PromptNotFoundErrorSchema: z.ZodObject<{
success: z.ZodLiteral<false>;
meta: z.ZodOptional<z.ZodObject<{
timestamp: z.ZodString;
requestId: z.ZodOptional<z.ZodString>;
version: z.ZodString;
}, z.core.$strip>>;
error: z.ZodObject<{
code: z.ZodLiteral<"NOT_FOUND">;
message: z.ZodString;
details: z.ZodOptional<z.ZodAny>;
}, z.core.$strip>;
}, z.core.$strip>;
export declare const PromptValidationErrorSchema: z.ZodObject<{
success: z.ZodLiteral<false>;
meta: z.ZodOptional<z.ZodObject<{
timestamp: z.ZodString;
requestId: z.ZodOptional<z.ZodString>;
version: z.ZodString;
}, z.core.$strip>>;
error: z.ZodObject<{
code: z.ZodLiteral<"VALIDATION_ERROR">;
message: z.ZodString;
details: z.ZodOptional<z.ZodAny>;
}, z.core.$strip>;
}, z.core.$strip>;
export declare const PromptsListErrorSchema: z.ZodObject<{
success: z.ZodLiteral<false>;
meta: z.ZodOptional<z.ZodObject<{
timestamp: z.ZodString;
requestId: z.ZodOptional<z.ZodString>;
version: z.ZodString;
}, z.core.$strip>>;
error: z.ZodObject<{
code: z.ZodLiteral<"PROMPTS_LIST_ERROR">;
message: z.ZodString;
details: z.ZodOptional<z.ZodAny>;
}, z.core.$strip>;
}, z.core.$strip>;
export declare const PromptGetErrorSchema: z.ZodObject<{
success: z.ZodLiteral<false>;
meta: z.ZodOptional<z.ZodObject<{
timestamp: z.ZodString;
requestId: z.ZodOptional<z.ZodString>;
version: z.ZodString;
}, z.core.$strip>>;
error: z.ZodObject<{
code: z.ZodLiteral<"PROMPT_GET_ERROR">;
message: z.ZodString;
details: z.ZodOptional<z.ZodAny>;
}, z.core.$strip>;
}, z.core.$strip>;
/**
* Prompts cache refresh response data
* POST /api/v1/prompts/refresh
*/
export declare const PromptsCacheRefreshDataSchema: z.ZodObject<{
refreshed: z.ZodBoolean;
promptsLoaded: z.ZodNumber;
source: z.ZodString;
}, z.core.$strip>;
export type PromptsCacheRefreshData = z.infer<typeof PromptsCacheRefreshDataSchema>;
export declare const PromptsCacheRefreshResponseSchema: z.ZodObject<{
success: z.ZodLiteral<true>;
data: z.ZodObject<{
refreshed: z.ZodBoolean;
promptsLoaded: z.ZodNumber;
source: z.ZodString;
}, z.core.$strip>;
meta: z.ZodOptional<z.ZodObject<{
timestamp: z.ZodString;
requestId: z.ZodOptional<z.ZodString>;
version: z.ZodString;
}, z.core.$strip>>;
}, z.core.$strip>;
export type PromptsCacheRefreshResponse = z.infer<typeof PromptsCacheRefreshResponseSchema>;
export declare const PromptsCacheRefreshErrorSchema: z.ZodObject<{
success: z.ZodLiteral<false>;
meta: z.ZodOptional<z.ZodObject<{
timestamp: z.ZodString;
requestId: z.ZodOptional<z.ZodString>;
version: z.ZodString;
}, z.core.$strip>>;
error: z.ZodObject<{
code: z.ZodLiteral<"PROMPTS_CACHE_REFRESH_ERROR">;
message: z.ZodString;
details: z.ZodOptional<z.ZodAny>;
}, z.core.$strip>;
}, z.core.$strip>;
//# sourceMappingURL=prompts.d.ts.map