@objectstack/spec 0.8.2 → 0.9.0

package/dist/api/documentation.zod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentation.zod.d.ts","sourceRoot":"","sources":["../../src/api/documentation.zod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AAMH;;;;GAIG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;iBAa9B,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE;;;;GAIG;AACH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;iBA6BtC,CAAC;AAEH,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAEhF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA2D5B,CAAC;AAEH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAM5D;;GAEG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;EAU3B,CAAC;AAEH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAEhE;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAgDnC,CAAC;AAEH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE1E;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;iBAkC/B,CAAC;AAEH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAElE;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAoBlC,CAAC;AAEH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAMxE;;;;GAIG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;iBAmBlC,CAAC;AAEH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAExE;;;;GAIG;AACH,eAAO,MAAM,4BAA4B;;;;;iBAYvC,CAAC;AAEH,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC;AAElF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA0EvC,CAAC;AAEH,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC;AAMlF;;;;GAIG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAmB1C,CAAC;AAEH,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAC;AAMxF;;GAEG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;aACxB,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,UAAU,CAAC;CAC1E,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;aACnB,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,UAAU,CAAC;CACrE,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;aACb,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,UAAU,CAAC;CAC/D,CAAC"}

package/dist/api/documentation.zod.js

@@ -0,0 +1,487 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenApiSpec = exports.ApiTestCollection = exports.ApiDocumentationConfig = exports.GeneratedApiDocumentationSchema = exports.ApiDocumentationConfigSchema = exports.CodeGenerationTemplateSchema = exports.ApiChangelogEntrySchema = exports.ApiTestCollectionSchema = exports.ApiTestRequestSchema = exports.ApiTestingUiConfigSchema = exports.ApiTestingUiType = exports.OpenApiSpecSchema = exports.OpenApiSecuritySchemeSchema = exports.OpenApiServerSchema = void 0;
+const zod_1 = require("zod");
+/**
+ * API Documentation & Testing Interface Protocol
+ *
+ * Provides schemas for generating interactive API documentation and testing
+ * interfaces similar to Swagger UI, GraphQL Playground, Postman, etc.
+ *
+ * Features:
+ * - OpenAPI/Swagger specification generation
+ * - Interactive API testing playground
+ * - API versioning and changelog
+ * - Code generation templates
+ * - Mock server configuration
+ *
+ * Architecture Alignment:
+ * - Swagger UI: Interactive API documentation
+ * - Postman: API testing collections
+ * - GraphQL Playground: GraphQL-specific testing
+ * - Redoc: Documentation rendering
+ *
+ * @example Documentation Config
+ * ```typescript
+ * const docConfig: ApiDocumentationConfig = {
+ *   enabled: true,
+ *   title: 'ObjectStack API',
+ *   version: '1.0.0',
+ *   servers: [{ url: 'https://api.example.com', description: 'Production' }],
+ *   ui: {
+ *     type: 'swagger-ui',
+ *     theme: 'light',
+ *     enableTryItOut: true
+ *   }
+ * }
+ * ```
+ */
+// ==========================================
+// OpenAPI Specification
+// ==========================================
+/**
+ * OpenAPI Server Schema
+ *
+ * Server configuration for OpenAPI specification.
+ */
+exports.OpenApiServerSchema = zod_1.z.object({
+    /** Server URL */
+    url: zod_1.z.string().url().describe('Server base URL'),
+    /** Server description */
+    description: zod_1.z.string().optional().describe('Server description'),
+    /** Server variables */
+    variables: zod_1.z.record(zod_1.z.string(), zod_1.z.object({
+        default: zod_1.z.string(),
+        description: zod_1.z.string().optional(),
+        enum: zod_1.z.array(zod_1.z.string()).optional(),
+    })).optional().describe('URL template variables'),
+});
+/**
+ * OpenAPI Security Scheme Schema
+ *
+ * Security scheme definition for OpenAPI.
+ */
+exports.OpenApiSecuritySchemeSchema = zod_1.z.object({
+    /** Security scheme type */
+    type: zod_1.z.enum(['apiKey', 'http', 'oauth2', 'openIdConnect']).describe('Security type'),
+    /** Scheme name */
+    scheme: zod_1.z.string().optional().describe('HTTP auth scheme (bearer, basic, etc.)'),
+    /** Bearer format */
+    bearerFormat: zod_1.z.string().optional().describe('Bearer token format (e.g., JWT)'),
+    /** API key name */
+    name: zod_1.z.string().optional().describe('API key parameter name'),
+    /** API key location */
+    in: zod_1.z.enum(['header', 'query', 'cookie']).optional().describe('API key location'),
+    /** OAuth flows */
+    flows: zod_1.z.object({
+        implicit: zod_1.z.any().optional(),
+        password: zod_1.z.any().optional(),
+        clientCredentials: zod_1.z.any().optional(),
+        authorizationCode: zod_1.z.any().optional(),
+    }).optional().describe('OAuth2 flows'),
+    /** OpenID Connect URL */
+    openIdConnectUrl: zod_1.z.string().url().optional().describe('OpenID Connect discovery URL'),
+    /** Description */
+    description: zod_1.z.string().optional().describe('Security scheme description'),
+});
+/**
+ * OpenAPI Specification Schema
+ *
+ * Complete OpenAPI 3.0 specification structure.
+ *
+ * @see https://swagger.io/specification/
+ *
+ * @example
+ * ```json
+ * {
+ *   "openapi": "3.0.0",
+ *   "info": {
+ *     "title": "ObjectStack API",
+ *     "version": "1.0.0",
+ *     "description": "ObjectStack unified API"
+ *   },
+ *   "servers": [
+ *     { "url": "https://api.example.com" }
+ *   ],
+ *   "paths": { ... },
+ *   "components": { ... }
+ * }
+ * ```
+ */
+exports.OpenApiSpecSchema = zod_1.z.object({
+    /** OpenAPI version */
+    openapi: zod_1.z.string().default('3.0.0').describe('OpenAPI specification version'),
+    /** API information */
+    info: zod_1.z.object({
+        title: zod_1.z.string().describe('API title'),
+        version: zod_1.z.string().describe('API version'),
+        description: zod_1.z.string().optional().describe('API description'),
+        termsOfService: zod_1.z.string().url().optional().describe('Terms of service URL'),
+        contact: zod_1.z.object({
+            name: zod_1.z.string().optional(),
+            url: zod_1.z.string().url().optional(),
+            email: zod_1.z.string().email().optional(),
+        }).optional(),
+        license: zod_1.z.object({
+            name: zod_1.z.string(),
+            url: zod_1.z.string().url().optional(),
+        }).optional(),
+    }).describe('API metadata'),
+    /** Servers */
+    servers: zod_1.z.array(exports.OpenApiServerSchema).optional().default([]).describe('API servers'),
+    /** API paths */
+    paths: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).describe('API paths and operations'),
+    /** Reusable components */
+    components: zod_1.z.object({
+        schemas: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).optional(),
+        responses: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).optional(),
+        parameters: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).optional(),
+        examples: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).optional(),
+        requestBodies: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).optional(),
+        headers: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).optional(),
+        securitySchemes: zod_1.z.record(zod_1.z.string(), exports.OpenApiSecuritySchemeSchema).optional(),
+        links: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).optional(),
+        callbacks: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).optional(),
+    }).optional().describe('Reusable components'),
+    /** Security requirements */
+    security: zod_1.z.array(zod_1.z.record(zod_1.z.string(), zod_1.z.array(zod_1.z.string()))).optional()
+        .describe('Global security requirements'),
+    /** Tags */
+    tags: zod_1.z.array(zod_1.z.object({
+        name: zod_1.z.string(),
+        description: zod_1.z.string().optional(),
+        externalDocs: zod_1.z.object({
+            description: zod_1.z.string().optional(),
+            url: zod_1.z.string().url(),
+        }).optional(),
+    })).optional().describe('Tag definitions'),
+    /** External documentation */
+    externalDocs: zod_1.z.object({
+        description: zod_1.z.string().optional(),
+        url: zod_1.z.string().url(),
+    }).optional().describe('External documentation'),
+});
+// ==========================================
+// API Testing Playground
+// ==========================================
+/**
+ * API Testing UI Type
+ */
+exports.ApiTestingUiType = zod_1.z.enum([
+    'swagger-ui', // Swagger UI
+    'redoc', // Redoc
+    'rapidoc', // RapiDoc
+    'stoplight', // Stoplight Elements
+    'scalar', // Scalar API Reference
+    'graphql-playground', // GraphQL Playground
+    'graphiql', // GraphiQL
+    'postman', // Postman-like interface
+    'custom', // Custom implementation
+]);
+/**
+ * API Testing UI Configuration Schema
+ *
+ * Configuration for interactive API testing interface.
+ *
+ * @example Swagger UI Config
+ * ```json
+ * {
+ *   "type": "swagger-ui",
+ *   "path": "/api-docs",
+ *   "theme": "light",
+ *   "enableTryItOut": true,
+ *   "enableFilter": true,
+ *   "enableCors": true,
+ *   "defaultModelsExpandDepth": 1
+ * }
+ * ```
+ */
+exports.ApiTestingUiConfigSchema = zod_1.z.object({
+    /** UI type */
+    type: exports.ApiTestingUiType.describe('Testing UI implementation'),
+    /** UI path */
+    path: zod_1.z.string().default('/api-docs').describe('URL path for documentation UI'),
+    /** UI theme */
+    theme: zod_1.z.enum(['light', 'dark', 'auto']).default('light').describe('UI color theme'),
+    /** Enable try-it-out feature */
+    enableTryItOut: zod_1.z.boolean().default(true).describe('Enable interactive API testing'),
+    /** Enable filtering */
+    enableFilter: zod_1.z.boolean().default(true).describe('Enable endpoint filtering'),
+    /** Enable CORS for testing */
+    enableCors: zod_1.z.boolean().default(true).describe('Enable CORS for browser testing'),
+    /** Default expand depth for models */
+    defaultModelsExpandDepth: zod_1.z.number().int().min(-1).default(1)
+        .describe('Default expand depth for schemas (-1 = fully expand)'),
+    /** Display request duration */
+    displayRequestDuration: zod_1.z.boolean().default(true).describe('Show request duration'),
+    /** Syntax highlighting */
+    syntaxHighlighting: zod_1.z.boolean().default(true).describe('Enable syntax highlighting'),
+    /** Custom CSS URL */
+    customCssUrl: zod_1.z.string().url().optional().describe('Custom CSS stylesheet URL'),
+    /** Custom JavaScript URL */
+    customJsUrl: zod_1.z.string().url().optional().describe('Custom JavaScript URL'),
+    /** Layout options */
+    layout: zod_1.z.object({
+        showExtensions: zod_1.z.boolean().default(false).describe('Show vendor extensions'),
+        showCommonExtensions: zod_1.z.boolean().default(false).describe('Show common extensions'),
+        deepLinking: zod_1.z.boolean().default(true).describe('Enable deep linking'),
+        displayOperationId: zod_1.z.boolean().default(false).describe('Display operation IDs'),
+        defaultModelRendering: zod_1.z.enum(['example', 'model']).default('example')
+            .describe('Default model rendering mode'),
+        defaultModelsExpandDepth: zod_1.z.number().int().default(1).describe('Models expand depth'),
+        defaultModelExpandDepth: zod_1.z.number().int().default(1).describe('Single model expand depth'),
+        docExpansion: zod_1.z.enum(['list', 'full', 'none']).default('list')
+            .describe('Documentation expansion mode'),
+    }).optional().describe('Layout configuration'),
+});
+/**
+ * API Test Request Schema
+ *
+ * Represents a saved/example API test request.
+ *
+ * @example
+ * ```json
+ * {
+ *   "name": "Get Customer by ID",
+ *   "description": "Retrieves a customer record",
+ *   "method": "GET",
+ *   "url": "/api/v1/data/customer/123",
+ *   "headers": {
+ *     "Authorization": "Bearer {{token}}"
+ *   },
+ *   "variables": {
+ *     "token": "sample_token"
+ *   }
+ * }
+ * ```
+ */
+exports.ApiTestRequestSchema = zod_1.z.object({
+    /** Request name */
+    name: zod_1.z.string().describe('Test request name'),
+    /** Request description */
+    description: zod_1.z.string().optional().describe('Request description'),
+    /** HTTP method */
+    method: zod_1.z.enum(['GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'HEAD', 'OPTIONS'])
+        .describe('HTTP method'),
+    /** Request URL */
+    url: zod_1.z.string().describe('Request URL (can include variables)'),
+    /** Request headers */
+    headers: zod_1.z.record(zod_1.z.string(), zod_1.z.string()).optional().default({})
+        .describe('Request headers'),
+    /** Query parameters */
+    queryParams: zod_1.z.record(zod_1.z.string(), zod_1.z.union([zod_1.z.string(), zod_1.z.number(), zod_1.z.boolean()]))
+        .optional().default({}).describe('Query parameters'),
+    /** Request body */
+    body: zod_1.z.any().optional().describe('Request body'),
+    /** Environment variables */
+    variables: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).optional().default({})
+        .describe('Template variables'),
+    /** Expected response */
+    expectedResponse: zod_1.z.object({
+        statusCode: zod_1.z.number().int(),
+        body: zod_1.z.any().optional(),
+    }).optional().describe('Expected response for validation'),
+});
+/**
+ * API Test Collection Schema
+ *
+ * Collection of test requests (similar to Postman collections).
+ *
+ * @example
+ * ```json
+ * {
+ *   "name": "Customer API Tests",
+ *   "description": "Test collection for customer endpoints",
+ *   "variables": {
+ *     "baseUrl": "https://api.example.com",
+ *     "apiKey": "test_key"
+ *   },
+ *   "requests": [...]
+ * }
+ * ```
+ */
+exports.ApiTestCollectionSchema = zod_1.z.object({
+    /** Collection name */
+    name: zod_1.z.string().describe('Collection name'),
+    /** Collection description */
+    description: zod_1.z.string().optional().describe('Collection description'),
+    /** Collection variables */
+    variables: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).optional().default({})
+        .describe('Shared variables'),
+    /** Test requests */
+    requests: zod_1.z.array(exports.ApiTestRequestSchema).describe('Test requests in this collection'),
+    /** Folders/grouping */
+    folders: zod_1.z.array(zod_1.z.object({
+        name: zod_1.z.string(),
+        description: zod_1.z.string().optional(),
+        requests: zod_1.z.array(exports.ApiTestRequestSchema),
+    })).optional().describe('Request folders for organization'),
+});
+// ==========================================
+// API Documentation Configuration
+// ==========================================
+/**
+ * API Changelog Entry Schema
+ *
+ * Documents changes in API versions.
+ */
+exports.ApiChangelogEntrySchema = zod_1.z.object({
+    /** Version */
+    version: zod_1.z.string().describe('API version'),
+    /** Release date */
+    date: zod_1.z.string().date().describe('Release date'),
+    /** Changes */
+    changes: zod_1.z.object({
+        added: zod_1.z.array(zod_1.z.string()).optional().default([]).describe('New features'),
+        changed: zod_1.z.array(zod_1.z.string()).optional().default([]).describe('Changes'),
+        deprecated: zod_1.z.array(zod_1.z.string()).optional().default([]).describe('Deprecations'),
+        removed: zod_1.z.array(zod_1.z.string()).optional().default([]).describe('Removed features'),
+        fixed: zod_1.z.array(zod_1.z.string()).optional().default([]).describe('Bug fixes'),
+        security: zod_1.z.array(zod_1.z.string()).optional().default([]).describe('Security fixes'),
+    }).describe('Version changes'),
+    /** Migration guide */
+    migrationGuide: zod_1.z.string().optional().describe('Migration guide URL or text'),
+});
+/**
+ * Code Generation Template Schema
+ *
+ * Templates for generating client code.
+ */
+exports.CodeGenerationTemplateSchema = zod_1.z.object({
+    /** Language/framework */
+    language: zod_1.z.string().describe('Target language/framework (e.g., typescript, python, curl)'),
+    /** Template name */
+    name: zod_1.z.string().describe('Template name'),
+    /** Template content */
+    template: zod_1.z.string().describe('Code template with placeholders'),
+    /** Template variables */
+    variables: zod_1.z.array(zod_1.z.string()).optional().describe('Required template variables'),
+});
+/**
+ * API Documentation Configuration Schema
+ *
+ * Complete configuration for API documentation and testing interface.
+ *
+ * @example
+ * ```json
+ * {
+ *   "enabled": true,
+ *   "title": "ObjectStack API Documentation",
+ *   "version": "1.0.0",
+ *   "description": "Unified API for ObjectStack platform",
+ *   "servers": [
+ *     { "url": "https://api.example.com", "description": "Production" }
+ *   ],
+ *   "ui": {
+ *     "type": "swagger-ui",
+ *     "theme": "light",
+ *     "enableTryItOut": true
+ *   },
+ *   "generateOpenApi": true,
+ *   "generateTestCollections": true
+ * }
+ * ```
+ */
+exports.ApiDocumentationConfigSchema = zod_1.z.object({
+    /** Enable documentation */
+    enabled: zod_1.z.boolean().default(true).describe('Enable API documentation'),
+    /** Documentation title */
+    title: zod_1.z.string().default('API Documentation').describe('Documentation title'),
+    /** API version */
+    version: zod_1.z.string().describe('API version'),
+    /** API description */
+    description: zod_1.z.string().optional().describe('API description'),
+    /** Server configurations */
+    servers: zod_1.z.array(exports.OpenApiServerSchema).optional().default([])
+        .describe('API server URLs'),
+    /** UI configuration */
+    ui: exports.ApiTestingUiConfigSchema.optional().describe('Testing UI configuration'),
+    /** Generate OpenAPI spec */
+    generateOpenApi: zod_1.z.boolean().default(true).describe('Generate OpenAPI 3.0 specification'),
+    /** Generate test collections */
+    generateTestCollections: zod_1.z.boolean().default(true)
+        .describe('Generate API test collections'),
+    /** Test collections */
+    testCollections: zod_1.z.array(exports.ApiTestCollectionSchema).optional().default([])
+        .describe('Predefined test collections'),
+    /** API changelog */
+    changelog: zod_1.z.array(exports.ApiChangelogEntrySchema).optional().default([])
+        .describe('API version changelog'),
+    /** Code generation templates */
+    codeTemplates: zod_1.z.array(exports.CodeGenerationTemplateSchema).optional().default([])
+        .describe('Code generation templates'),
+    /** Terms of service */
+    termsOfService: zod_1.z.string().url().optional().describe('Terms of service URL'),
+    /** Contact information */
+    contact: zod_1.z.object({
+        name: zod_1.z.string().optional(),
+        url: zod_1.z.string().url().optional(),
+        email: zod_1.z.string().email().optional(),
+    }).optional().describe('Contact information'),
+    /** License */
+    license: zod_1.z.object({
+        name: zod_1.z.string(),
+        url: zod_1.z.string().url().optional(),
+    }).optional().describe('API license'),
+    /** External documentation */
+    externalDocs: zod_1.z.object({
+        description: zod_1.z.string().optional(),
+        url: zod_1.z.string().url(),
+    }).optional().describe('External documentation link'),
+    /** Security schemes */
+    securitySchemes: zod_1.z.record(zod_1.z.string(), exports.OpenApiSecuritySchemeSchema).optional()
+        .describe('Security scheme definitions'),
+    /** Global tags */
+    tags: zod_1.z.array(zod_1.z.object({
+        name: zod_1.z.string(),
+        description: zod_1.z.string().optional(),
+        externalDocs: zod_1.z.object({
+            description: zod_1.z.string().optional(),
+            url: zod_1.z.string().url(),
+        }).optional(),
+    })).optional().describe('Global tag definitions'),
+});
+// ==========================================
+// API Documentation Generation
+// ==========================================
+/**
+ * Generated API Documentation Schema
+ *
+ * Output of documentation generation process.
+ */
+exports.GeneratedApiDocumentationSchema = zod_1.z.object({
+    /** OpenAPI specification */
+    openApiSpec: exports.OpenApiSpecSchema.optional().describe('Generated OpenAPI specification'),
+    /** Test collections */
+    testCollections: zod_1.z.array(exports.ApiTestCollectionSchema).optional()
+        .describe('Generated test collections'),
+    /** Markdown documentation */
+    markdown: zod_1.z.string().optional().describe('Generated markdown documentation'),
+    /** HTML documentation */
+    html: zod_1.z.string().optional().describe('Generated HTML documentation'),
+    /** Generation timestamp */
+    generatedAt: zod_1.z.string().datetime().describe('Generation timestamp'),
+    /** Source APIs */
+    sourceApis: zod_1.z.array(zod_1.z.string()).describe('Source API IDs used for generation'),
+});
+// ==========================================
+// Helper Functions
+// ==========================================
+/**
+ * Helper to create API documentation config
+ */
+exports.ApiDocumentationConfig = Object.assign(exports.ApiDocumentationConfigSchema, {
+    create: (config) => config,
+});
+/**
+ * Helper to create API test collection
+ */
+exports.ApiTestCollection = Object.assign(exports.ApiTestCollectionSchema, {
+    create: (config) => config,
+});
+/**
+ * Helper to create OpenAPI specification
+ */
+exports.OpenApiSpec = Object.assign(exports.OpenApiSpecSchema, {
+    create: (config) => config,
+});

package/dist/api/errors.zod.d.ts

@@ -23,10 +23,10 @@ export declare const ErrorCategory: z.ZodEnum<{
     validation: "validation";
     authorization: "authorization";
     server: "server";
-    not_found: "not_found";
+    maintenance: "maintenance";
     conflict: "conflict";
+    not_found: "not_found";
     rate_limit: "rate_limit";
-    maintenance: "maintenance";
 }>;
 export type ErrorCategory = z.infer<typeof ErrorCategory>;
 /**
@@ -277,10 +277,10 @@ export declare const EnhancedApiErrorSchema: z.ZodObject<{
         validation: "validation";
         authorization: "authorization";
         server: "server";
-        not_found: "not_found";
+        maintenance: "maintenance";
         conflict: "conflict";
+        not_found: "not_found";
         rate_limit: "rate_limit";
-        maintenance: "maintenance";
     }>>;
     httpStatus: z.ZodOptional<z.ZodNumber>;
     retryable: z.ZodDefault<z.ZodBoolean>;
@@ -437,10 +437,10 @@ export declare const ErrorResponseSchema: z.ZodObject<{
             validation: "validation";
             authorization: "authorization";
             server: "server";
-            not_found: "not_found";
+            maintenance: "maintenance";
             conflict: "conflict";
+            not_found: "not_found";
             rate_limit: "rate_limit";
-            maintenance: "maintenance";
         }>>;
         httpStatus: z.ZodOptional<z.ZodNumber>;
         retryable: z.ZodDefault<z.ZodBoolean>;

package/dist/api/graphql.zod.d.ts

@@ -157,8 +157,8 @@ export declare const GraphQLQueryConfigSchema: z.ZodObject<{
             gt: "gt";
             gte: "gte";
             eq: "eq";
-            ne: "ne";
             contains: "contains";
+            ne: "ne";
             notIn: "notIn";
             isNull: "isNull";
             isNotNull: "isNotNull";
@@ -619,8 +619,8 @@ export declare const GraphQLConfigSchema: z.ZodObject<{
                     gt: "gt";
                     gte: "gte";
                     eq: "eq";
-                    ne: "ne";
                     contains: "contains";
+                    ne: "ne";
                     notIn: "notIn";
                     isNull: "isNull";
                     isNotNull: "isNotNull";
@@ -995,8 +995,8 @@ export declare const GraphQLConfig: z.ZodObject<{
                     gt: "gt";
                     gte: "gte";
                     eq: "eq";
-                    ne: "ne";
                     contains: "contains";
+                    ne: "ne";
                     notIn: "notIn";
                     isNull: "isNull";
                     isNotNull: "isNotNull";