@classytic/arc 1.0.0

package/dist/docs/index.d.ts

@@ -0,0 +1,166 @@
+import { FastifyPluginAsync } from 'fastify';
+
+/**
+ * OpenAPI Spec Generator
+ *
+ * Auto-generates OpenAPI 3.0 specification from Arc resource registry.
+ *
+ * @example
+ * import { openApiPlugin } from '@classytic/arc/docs';
+ *
+ * await fastify.register(openApiPlugin, {
+ *   title: 'My API',
+ *   version: '1.0.0',
+ * });
+ *
+ * // Spec available at /_docs/openapi.json
+ */
+
+interface OpenApiOptions {
+    /** API title */
+    title?: string;
+    /** API version */
+    version?: string;
+    /** API description */
+    description?: string;
+    /** Server URL */
+    serverUrl?: string;
+    /** Route prefix for spec endpoint (default: '/_docs') */
+    prefix?: string;
+    /** API prefix for all resource paths (e.g., '/api/v1') */
+    apiPrefix?: string;
+    /** Auth roles required to access spec (default: [] = public) */
+    authRoles?: string[];
+    /** Include internal routes (default: false) */
+    includeInternal?: boolean;
+    /** Custom OpenAPI extensions */
+    extensions?: Record<string, unknown>;
+}
+interface OpenApiSpec {
+    openapi: string;
+    info: {
+        title: string;
+        version: string;
+        description?: string;
+    };
+    servers?: Array<{
+        url: string;
+        description?: string;
+    }>;
+    paths: Record<string, PathItem>;
+    components: {
+        schemas: Record<string, SchemaObject>;
+        securitySchemes?: Record<string, SecurityScheme>;
+    };
+    tags: Array<{
+        name: string;
+        description?: string;
+    }>;
+    security?: Array<Record<string, string[]>>;
+}
+interface PathItem {
+    get?: Operation;
+    post?: Operation;
+    put?: Operation;
+    patch?: Operation;
+    delete?: Operation;
+    options?: Operation;
+    head?: Operation;
+}
+interface Operation {
+    tags: string[];
+    summary: string;
+    description?: string;
+    operationId: string;
+    parameters?: Parameter[];
+    requestBody?: RequestBody;
+    responses: Record<string, Response>;
+    security?: Array<Record<string, string[]>>;
+}
+interface Parameter {
+    name: string;
+    in: 'path' | 'query' | 'header';
+    required?: boolean;
+    schema: SchemaObject;
+    description?: string;
+}
+interface RequestBody {
+    required?: boolean;
+    content: Record<string, {
+        schema: SchemaObject;
+    }>;
+}
+interface Response {
+    description: string;
+    content?: Record<string, {
+        schema: SchemaObject;
+    }>;
+}
+interface SchemaObject {
+    type?: string;
+    format?: string;
+    properties?: Record<string, SchemaObject>;
+    items?: SchemaObject;
+    required?: string[];
+    $ref?: string;
+    description?: string;
+    example?: unknown;
+    additionalProperties?: boolean | SchemaObject;
+    enum?: string[];
+    minimum?: number;
+    maximum?: number;
+    minLength?: number;
+    maxLength?: number;
+    pattern?: string;
+}
+interface SecurityScheme {
+    type: string;
+    scheme?: string;
+    bearerFormat?: string;
+    in?: string;
+    name?: string;
+}
+declare const openApiPlugin: FastifyPluginAsync<OpenApiOptions>;
+declare const _default$1: FastifyPluginAsync<OpenApiOptions>;
+
+/**
+ * Scalar API Reference Plugin
+ *
+ * Beautiful, modern API documentation UI.
+ * Lighter and more modern than Swagger UI.
+ *
+ * @example
+ * import { scalarPlugin } from '@classytic/arc/docs';
+ *
+ * await fastify.register(scalarPlugin, {
+ *   routePrefix: '/docs',
+ *   specUrl: '/_docs/openapi.json',
+ * });
+ *
+ * // UI available at /docs
+ */
+
+interface ScalarOptions {
+    /** Route prefix for UI (default: '/docs') */
+    routePrefix?: string;
+    /** OpenAPI spec URL (default: '/_docs/openapi.json') */
+    specUrl?: string;
+    /** Page title */
+    title?: string;
+    /** Theme (default: 'default') */
+    theme?: 'default' | 'alternate' | 'moon' | 'purple' | 'solarized' | 'bluePlanet' | 'saturn' | 'kepler' | 'mars' | 'deepSpace';
+    /** Show sidebar (default: true) */
+    showSidebar?: boolean;
+    /** Dark mode (default: false) */
+    darkMode?: boolean;
+    /** Auth roles required to access docs */
+    authRoles?: string[];
+    /** Custom CSS */
+    customCss?: string;
+    /** Favicon URL */
+    favicon?: string;
+}
+declare const scalarPlugin: FastifyPluginAsync<ScalarOptions>;
+declare const _default: FastifyPluginAsync<ScalarOptions>;
+
+export { type OpenApiOptions, type OpenApiSpec, type ScalarOptions, _default$1 as openApiPlugin, openApiPlugin as openApiPluginFn, _default as scalarPlugin, scalarPlugin as scalarPluginFn };