raffel 0.1.2

package/dist/docs/generators/schema-converter.js

@@ -0,0 +1,370 @@
+/**
+ * Schema Converter
+ *
+ * Converts Zod schemas (or other validation schemas) to JSON Schema
+ * for use in USD documentation generation.
+ */
+import { zodToJsonSchema } from 'zod-to-json-schema';
+import { getValidator } from '../../validation/index.js';
+/**
+ * Create a schema registry for collecting converted schemas
+ */
+export function createSchemaRegistry() {
+    const schemas = new Map();
+    return {
+        schemas,
+        add(name, schema) {
+            const converted = convertSchema(schema);
+            schemas.set(name, converted);
+            return converted;
+        },
+        ref(name) {
+            return { $ref: `#/components/schemas/${name}` };
+        },
+        toObject() {
+            const result = {};
+            for (const [name, schema] of schemas) {
+                result[name] = schema;
+            }
+            return result;
+        },
+    };
+}
+/**
+ * Check if a value looks like a Zod schema
+ * Supports both Zod 3 (has _def) and Zod 4 (has def and toJSONSchema)
+ */
+export function isZodSchema(schema) {
+    if (schema === null || typeof schema !== 'object')
+        return false;
+    const obj = schema;
+    // Zod 4: has toJSONSchema method and def property
+    if (typeof obj.toJSONSchema === 'function' && 'def' in obj) {
+        return true;
+    }
+    // Zod 3: has _def property
+    if ('_def' in obj && typeof obj._def === 'object') {
+        return true;
+    }
+    return false;
+}
+/**
+ * Check if schema is Zod 4 (has native toJSONSchema method)
+ */
+function isZod4Schema(schema) {
+    return (schema !== null &&
+        typeof schema === 'object' &&
+        typeof schema.toJSONSchema === 'function');
+}
+/**
+ * Check if a value is already a JSON Schema
+ */
+export function isJsonSchema(schema) {
+    if (!schema || typeof schema !== 'object')
+        return false;
+    const obj = schema;
+    // Not JSON Schema if it's a Zod 4 schema (has toJSONSchema method)
+    if (typeof obj.toJSONSchema === 'function')
+        return false;
+    // Not JSON Schema if it has Zod 4's def property
+    if ('def' in obj)
+        return false;
+    // Not JSON Schema if it looks like a Zod 3 type (has _def)
+    if ('_def' in obj)
+        return false;
+    // Has common JSON Schema keywords
+    return ('type' in obj ||
+        '$ref' in obj ||
+        'anyOf' in obj ||
+        'oneOf' in obj ||
+        'allOf' in obj ||
+        'properties' in obj ||
+        'items' in obj);
+}
+/**
+ * Convert any supported schema to JSON Schema
+ *
+ * Supports:
+ * - Zod schemas
+ * - Already-JSON-Schema objects
+ * - Custom validator schemas (via registered validator)
+ */
+export function convertSchema(schema, options = {}) {
+    if (!schema) {
+        return { type: 'object' };
+    }
+    // Already JSON Schema
+    if (isJsonSchema(schema)) {
+        return cleanJsonSchema(schema);
+    }
+    // Zod 4: Use native toJSONSchema() method
+    if (isZod4Schema(schema)) {
+        try {
+            const jsonSchema = schema.toJSONSchema();
+            return cleanJsonSchema(jsonSchema);
+        }
+        catch {
+            // Continue to other methods
+        }
+    }
+    // Zod 3: Use zod-to-json-schema library
+    if (isZodSchema(schema) && !isZod4Schema(schema)) {
+        try {
+            const jsonSchema = zodToJsonSchema(schema, {
+                $refStrategy: options.useRefs ? 'root' : 'none',
+                target: 'openApi3',
+            });
+            return cleanJsonSchema(jsonSchema);
+        }
+        catch {
+            // Continue to fallback
+        }
+    }
+    // Handle non-standard Zod output format (with def/shape but no toJSONSchema)
+    if (schema && typeof schema === 'object') {
+        const schemaObj = schema;
+        if ('def' in schemaObj && typeof schemaObj.def === 'object' && schemaObj.def !== null) {
+            return normalizeNonStandardSchema(schemaObj);
+        }
+    }
+    // Try registered validator for non-Zod schemas
+    const validator = getValidator();
+    if (validator?.toJsonSchema) {
+        try {
+            if (validator.isValidSchema(schema)) {
+                const result = validator.toJsonSchema(schema);
+                // Only use if result looks like standard JSON Schema
+                if (result && Object.keys(result).length > 0 && !('def' in result)) {
+                    return cleanJsonSchema(result);
+                }
+            }
+        }
+        catch {
+            // Continue to fallback
+        }
+    }
+    // Fallback to generic object
+    return { type: 'object' };
+}
+/**
+ * Normalize non-standard Zod output format to standard JSON Schema
+ */
+function normalizeNonStandardSchema(schema) {
+    const def = schema.def;
+    // Handle object with shape
+    if (def.type === 'object' && def.shape) {
+        const shape = def.shape;
+        const properties = {};
+        for (const [key, val] of Object.entries(shape)) {
+            properties[key] = convertSchema(val);
+        }
+        return { type: 'object', properties };
+    }
+    // Handle default values
+    if (def.type === 'default' && def.innerType) {
+        const inner = convertSchema(def.innerType);
+        if (def.defaultValue !== undefined) {
+            return { ...inner, default: def.defaultValue };
+        }
+        return inner;
+    }
+    // Handle primitive types
+    if (def.type === 'string') {
+        const result = { type: 'string' };
+        if (schema.format)
+            result.format = String(schema.format);
+        if (schema.minLength)
+            result.minLength = Number(schema.minLength);
+        if (schema.maxLength)
+            result.maxLength = Number(schema.maxLength);
+        return result;
+    }
+    if (def.type === 'number') {
+        return { type: 'number' };
+    }
+    if (def.type === 'integer') {
+        return { type: 'integer' };
+    }
+    if (def.type === 'boolean') {
+        return { type: 'boolean' };
+    }
+    // Fallback
+    return { type: 'object' };
+}
+/**
+ * Convert a schema and register it with a name
+ */
+export function convertAndRegister(registry, name, schema) {
+    return registry.add(name, schema);
+}
+/**
+ * Clean JSON Schema by removing unnecessary properties
+ */
+function cleanJsonSchema(schema) {
+    if (typeof schema !== 'object' || schema === null) {
+        return schema;
+    }
+    const result = {};
+    for (const [key, value] of Object.entries(schema)) {
+        // Skip $schema property (not needed in OpenAPI/USD)
+        if (key === '$schema')
+            continue;
+        // Recursively clean nested objects
+        if (value && typeof value === 'object' && !Array.isArray(value)) {
+            result[key] = cleanJsonSchema(value);
+        }
+        else if (Array.isArray(value)) {
+            result[key] = value.map((item) => item && typeof item === 'object' ? cleanJsonSchema(item) : item);
+        }
+        else {
+            result[key] = value;
+        }
+    }
+    return result;
+}
+/**
+ * Extract parameters from a schema based on path template
+ *
+ * @param schema - The input schema
+ * @param pathTemplate - The path template (e.g., '/users/{id}')
+ */
+export function extractParameters(schema, pathTemplate) {
+    const result = {
+        path: [],
+        query: [],
+        header: [],
+    };
+    if (!schema)
+        return result;
+    const jsonSchema = convertSchema(schema);
+    // Extract path parameter names from template
+    const pathParamNames = new Set();
+    const pathParamMatches = pathTemplate.match(/\{(\w+)\}/g);
+    if (pathParamMatches) {
+        for (const match of pathParamMatches) {
+            pathParamNames.add(match.slice(1, -1));
+        }
+    }
+    // If schema has properties, extract them
+    if (jsonSchema.type === 'object' && jsonSchema.properties) {
+        const required = new Set(jsonSchema.required ?? []);
+        for (const [name, propSchema] of Object.entries(jsonSchema.properties)) {
+            const prop = propSchema;
+            if (pathParamNames.has(name)) {
+                // Path parameter
+                result.path.push({
+                    name,
+                    schema: prop,
+                    required: true, // Path params are always required
+                    description: prop.description,
+                });
+            }
+            else if (name.startsWith('header_') || name.startsWith('h_')) {
+                // Header parameter (by naming convention)
+                const headerName = name.replace(/^(header_|h_)/, '');
+                result.header.push({
+                    name: headerName,
+                    schema: prop,
+                    required: required.has(name),
+                    description: prop.description,
+                });
+            }
+            else {
+                // Query parameter (default for non-path, non-header)
+                result.query.push({
+                    name,
+                    schema: prop,
+                    required: required.has(name),
+                    description: prop.description,
+                });
+            }
+        }
+    }
+    else {
+        // If not an object schema, treat entire schema as body
+        result.body = jsonSchema;
+    }
+    return result;
+}
+/**
+ * Generate a schema name from a handler name
+ *
+ * @example
+ * generateSchemaName('users.get', 'Input') => 'UsersGetInput'
+ * generateSchemaName('users.list', 'Output') => 'UsersListOutput'
+ * generateSchemaName('users.create', 'Error1Data') => 'UsersCreateError1Data'
+ */
+export function generateSchemaName(handlerName, suffix) {
+    const parts = handlerName.split('.');
+    const camelCase = parts
+        .map((part) => part.charAt(0).toUpperCase() + part.slice(1))
+        .join('');
+    return `${camelCase}${suffix}`;
+}
+/**
+ * Create a reference schema
+ */
+export function createRef(schemaName) {
+    return { $ref: `#/components/schemas/${schemaName}` };
+}
+/**
+ * Create an array schema
+ */
+export function createArraySchema(itemSchema) {
+    return {
+        type: 'array',
+        items: itemSchema,
+    };
+}
+/**
+ * Create a paginated response schema
+ */
+export function createPaginatedSchema(itemSchema) {
+    return {
+        type: 'object',
+        properties: {
+            data: {
+                type: 'array',
+                items: itemSchema,
+            },
+            total: { type: 'integer', description: 'Total number of items' },
+            page: { type: 'integer', description: 'Current page number' },
+            limit: { type: 'integer', description: 'Items per page' },
+            pages: { type: 'integer', description: 'Total number of pages' },
+        },
+        required: ['data', 'total'],
+    };
+}
+/**
+ * Create a standard error schema
+ */
+export function createErrorSchema() {
+    return {
+        type: 'object',
+        required: ['code', 'message'],
+        properties: {
+            code: {
+                type: 'string',
+                description: 'Error code identifier',
+            },
+            message: {
+                type: 'string',
+                description: 'Human-readable error message',
+            },
+            status: {
+                type: 'integer',
+                description: 'HTTP status code',
+            },
+            details: {
+                type: 'object',
+                description: 'Additional error details',
+                additionalProperties: true,
+            },
+            requestId: {
+                type: 'string',
+                description: 'Request ID for tracking',
+            },
+        },
+    };
+}
+//# sourceMappingURL=schema-converter.js.map

package/dist/docs/generators/schema-converter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-converter.js","sourceRoot":"","sources":["../../../src/docs/generators/schema-converter.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AAEpD,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AA4BxD;;GAEG;AACH,MAAM,UAAU,oBAAoB;IAClC,MAAM,OAAO,GAAG,IAAI,GAAG,EAAqB,CAAA;IAE5C,OAAO;QACL,OAAO;QAEP,GAAG,CAAC,IAAY,EAAE,MAAe;YAC/B,MAAM,SAAS,GAAG,aAAa,CAAC,MAAM,CAAC,CAAA;YACvC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,SAAS,CAAC,CAAA;YAC5B,OAAO,SAAS,CAAA;QAClB,CAAC;QAED,GAAG,CAAC,IAAY;YACd,OAAO,EAAE,IAAI,EAAE,wBAAwB,IAAI,EAAE,EAAE,CAAA;QACjD,CAAC;QAED,QAAQ;YACN,MAAM,MAAM,GAA8B,EAAE,CAAA;YAC5C,KAAK,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC;gBACrC,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAA;YACvB,CAAC;YACD,OAAO,MAAM,CAAA;QACf,CAAC;KACF,CAAA;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,WAAW,CAAC,MAAe;IACzC,IAAI,MAAM,KAAK,IAAI,IAAI,OAAO,MAAM,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAA;IAC/D,MAAM,GAAG,GAAG,MAAiC,CAAA;IAE7C,kDAAkD;IAClD,IAAI,OAAO,GAAG,CAAC,YAAY,KAAK,UAAU,IAAI,KAAK,IAAI,GAAG,EAAE,CAAC;QAC3D,OAAO,IAAI,CAAA;IACb,CAAC;IAED,2BAA2B;IAC3B,IAAI,MAAM,IAAI,GAAG,IAAI,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAClD,OAAO,IAAI,CAAA;IACb,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC;AAED;;GAEG;AACH,SAAS,YAAY,CAAC,MAAe;IACnC,OAAO,CACL,MAAM,KAAK,IAAI;QACf,OAAO,MAAM,KAAK,QAAQ;QAC1B,OAAQ,MAAkC,CAAC,YAAY,KAAK,UAAU,CACvE,CAAA;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,YAAY,CAAC,MAAe;IAC1C,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAA;IACvD,MAAM,GAAG,GAAG,MAAiC,CAAA;IAE7C,mEAAmE;IACnE,IAAI,OAAO,GAAG,CAAC,YAAY,KAAK,UAAU;QAAE,OAAO,KAAK,CAAA;IAExD,iDAAiD;IACjD,IAAI,KAAK,IAAI,GAAG;QAAE,OAAO,KAAK,CAAA;IAE9B,2DAA2D;IAC3D,IAAI,MAAM,IAAI,GAAG;QAAE,OAAO,KAAK,CAAA;IAE/B,kCAAkC;IAClC,OAAO,CACL,MAAM,IAAI,GAAG;QACb,MAAM,IAAI,GAAG;QACb,OAAO,IAAI,GAAG;QACd,OAAO,IAAI,GAAG;QACd,OAAO,IAAI,GAAG;QACd,YAAY,IAAI,GAAG;QACnB,OAAO,IAAI,GAAG,CACf,CAAA;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,aAAa,CAC3B,MAAe,EACf,UAAmC,EAAE;IAErC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAA;IAC3B,CAAC;IAED,sBAAsB;IACtB,IAAI,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC;QACzB,OAAO,eAAe,CAAC,MAAM,CAAC,CAAA;IAChC,CAAC;IAED,0CAA0C;IAC1C,IAAI,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC;QACzB,IAAI,CAAC;YACH,MAAM,UAAU,GAAG,MAAM,CAAC,YAAY,EAAe,CAAA;YACrD,OAAO,eAAe,CAAC,UAAU,CAAC,CAAA;QACpC,CAAC;QAAC,MAAM,CAAC;YACP,4BAA4B;QAC9B,CAAC;IACH,CAAC;IAED,wCAAwC;IACxC,IAAI,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC;QACjD,IAAI,CAAC;YACH,MAAM,UAAU,GAAG,eAAe,CAAC,MAAa,EAAE;gBAChD,YAAY,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM;gBAC/C,MAAM,EAAE,UAAU;aACnB,CAAC,CAAA;YACF,OAAO,eAAe,CAAC,UAAuB,CAAC,CAAA;QACjD,CAAC;QAAC,MAAM,CAAC;YACP,uBAAuB;QACzB,CAAC;IACH,CAAC;IAED,6EAA6E;IAC7E,IAAI,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QACzC,MAAM,SAAS,GAAG,MAAiC,CAAA;QACnD,IAAI,KAAK,IAAI,SAAS,IAAI,OAAO,SAAS,CAAC,GAAG,KAAK,QAAQ,IAAI,SAAS,CAAC,GAAG,KAAK,IAAI,EAAE,CAAC;YACtF,OAAO,0BAA0B,CAAC,SAAS,CAAC,CAAA;QAC9C,CAAC;IACH,CAAC;IAED,+CAA+C;IAC/C,MAAM,SAAS,GAAG,YAAY,EAAE,CAAA;IAChC,IAAI,SAAS,EAAE,YAAY,EAAE,CAAC;QAC5B,IAAI,CAAC;YACH,IAAI,SAAS,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;gBACpC,MAAM,MAAM,GAAG,SAAS,CAAC,YAAY,CAAC,MAAM,CAAC,CAAA;gBAC7C,qDAAqD;gBACrD,IAAI,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,CAAC,KAAK,IAAI,MAAM,CAAC,EAAE,CAAC;oBACnE,OAAO,eAAe,CAAC,MAAmB,CAAC,CAAA;gBAC7C,CAAC;YACH,CAAC;QACH,CAAC;QAAC,MAAM,CAAC;YACP,uBAAuB;QACzB,CAAC;IACH,CAAC;IAED,6BAA6B;IAC7B,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAA;AAC3B,CAAC;AAED;;GAEG;AACH,SAAS,0BAA0B,CAAC,MAA+B;IACjE,MAAM,GAAG,GAAG,MAAM,CAAC,GAA8B,CAAA;IAEjD,2BAA2B;IAC3B,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,IAAI,GAAG,CAAC,KAAK,EAAE,CAAC;QACvC,MAAM,KAAK,GAAG,GAAG,CAAC,KAAgC,CAAA;QAClD,MAAM,UAAU,GAA8B,EAAE,CAAA;QAEhD,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAC/C,UAAU,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC,GAAG,CAAC,CAAA;QACtC,CAAC;QAED,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAA;IACvC,CAAC;IAED,wBAAwB;IACxB,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,IAAI,GAAG,CAAC,SAAS,EAAE,CAAC;QAC5C,MAAM,KAAK,GAAG,aAAa,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;QAC1C,IAAI,GAAG,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;YACnC,OAAO,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,YAAoC,EAAE,CAAA;QACxE,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAED,yBAAyB;IACzB,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC1B,MAAM,MAAM,GAAc,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAA;QAC5C,IAAI,MAAM,CAAC,MAAM;YAAE,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;QACxD,IAAI,MAAM,CAAC,SAAS;YAAE,MAAM,CAAC,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;QACjE,IAAI,MAAM,CAAC,SAAS;YAAE,MAAM,CAAC,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;QACjE,OAAO,MAAM,CAAA;IACf,CAAC;IAED,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC1B,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAA;IAC3B,CAAC;IAED,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC3B,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,CAAA;IAC5B,CAAC;IAED,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC3B,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,CAAA;IAC5B,CAAC;IAED,WAAW;IACX,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAA;AAC3B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAChC,QAAiC,EACjC,IAAY,EACZ,MAAe;IAEf,OAAO,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;AACnC,CAAC;AAED;;GAEG;AACH,SAAS,eAAe,CAAC,MAAiB;IACxC,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QAClD,OAAO,MAAM,CAAA;IACf,CAAC;IAED,MAAM,MAAM,GAA4B,EAAE,CAAA;IAE1C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAClD,oDAAoD;QACpD,IAAI,GAAG,KAAK,SAAS;YAAE,SAAQ;QAE/B,mCAAmC;QACnC,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAChE,MAAM,CAAC,GAAG,CAAC,GAAG,eAAe,CAAC,KAAkB,CAAC,CAAA;QACnD,CAAC;aAAM,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAChC,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAC/B,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,eAAe,CAAC,IAAiB,CAAC,CAAC,CAAC,CAAC,IAAI,CAC7E,CAAA;QACH,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;QACrB,CAAC;IACH,CAAC;IAED,OAAO,MAAmB,CAAA;AAC5B,CAAC;AAeD;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAC/B,MAAe,EACf,YAAoB;IAEpB,MAAM,MAAM,GAAwB;QAClC,IAAI,EAAE,EAAE;QACR,KAAK,EAAE,EAAE;QACT,MAAM,EAAE,EAAE;KACX,CAAA;IAED,IAAI,CAAC,MAAM;QAAE,OAAO,MAAM,CAAA;IAE1B,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,CAAA;IAExC,6CAA6C;IAC7C,MAAM,cAAc,GAAG,IAAI,GAAG,EAAU,CAAA;IACxC,MAAM,gBAAgB,GAAG,YAAY,CAAC,KAAK,CAAC,YAAY,CAAC,CAAA;IACzD,IAAI,gBAAgB,EAAE,CAAC;QACrB,KAAK,MAAM,KAAK,IAAI,gBAAgB,EAAE,CAAC;YACrC,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;QACxC,CAAC;IACH,CAAC;IAED,yCAAyC;IACzC,IAAI,UAAU,CAAC,IAAI,KAAK,QAAQ,IAAI,UAAU,CAAC,UAAU,EAAE,CAAC;QAC1D,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,QAAoB,IAAI,EAAE,CAAC,CAAA;QAE/D,KAAK,MAAM,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;YACvE,MAAM,IAAI,GAAG,UAAuB,CAAA;YAEpC,IAAI,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC7B,iBAAiB;gBACjB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;oBACf,IAAI;oBACJ,MAAM,EAAE,IAAI;oBACZ,QAAQ,EAAE,IAAI,EAAE,kCAAkC;oBAClD,WAAW,EAAE,IAAI,CAAC,WAAW;iBAC9B,CAAC,CAAA;YACJ,CAAC;iBAAM,IAAI,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC/D,0CAA0C;gBAC1C,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC,CAAA;gBACpD,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;oBACjB,IAAI,EAAE,UAAU;oBAChB,MAAM,EAAE,IAAI;oBACZ,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC;oBAC5B,WAAW,EAAE,IAAI,CAAC,WAAW;iBAC9B,CAAC,CAAA;YACJ,CAAC;iBAAM,CAAC;gBACN,qDAAqD;gBACrD,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;oBAChB,IAAI;oBACJ,MAAM,EAAE,IAAI;oBACZ,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC;oBAC5B,WAAW,EAAE,IAAI,CAAC,WAAW;iBAC9B,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;IACH,CAAC;SAAM,CAAC;QACN,uDAAuD;QACvD,MAAM,CAAC,IAAI,GAAG,UAAU,CAAA;IAC1B,CAAC;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,kBAAkB,CAAC,WAAmB,EAAE,MAAc;IACpE,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IACpC,MAAM,SAAS,GAAG,KAAK;SACpB,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAC3D,IAAI,CAAC,EAAE,CAAC,CAAA;IACX,OAAO,GAAG,SAAS,GAAG,MAAM,EAAE,CAAA;AAChC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,SAAS,CAAC,UAAkB;IAC1C,OAAO,EAAE,IAAI,EAAE,wBAAwB,UAAU,EAAE,EAAE,CAAA;AACvD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAAC,UAAqB;IACrD,OAAO;QACL,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,UAAU;KAClB,CAAA;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,UAAqB;IACzD,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,IAAI,EAAE;gBACJ,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE,UAAU;aAClB;YACD,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,uBAAuB,EAAE;YAChE,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,qBAAqB,EAAE;YAC7D,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,gBAAgB,EAAE;YACzD,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,uBAAuB,EAAE;SACjE;QACD,QAAQ,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC;KAC5B,CAAA;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,iBAAiB;IAC/B,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC;QAC7B,UAAU,EAAE;YACV,IAAI,EAAE;gBACJ,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,uBAAuB;aACrC;YACD,OAAO,EAAE;gBACP,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,8BAA8B;aAC5C;YACD,MAAM,EAAE;gBACN,IAAI,EAAE,SAAS;gBACf,WAAW,EAAE,kBAAkB;aAChC;YACD,OAAO,EAAE;gBACP,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,0BAA0B;gBACvC,oBAAoB,EAAE,IAAI;aAC3B;YACD,SAAS,EAAE;gBACT,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,yBAAyB;aACvC;SACF;KACF,CAAA;AACH,CAAC"}

package/dist/docs/generators/streams-generator.d.ts

@@ -0,0 +1,85 @@
+/**
+ * Streams Generator for USD
+ *
+ * Converts Raffel streams to USD Streams specification (x-usd.streams).
+ */
+import type { USDStreams, USDSchema, USDContentTypes } from '../../usd/index.js';
+import type { Registry } from '../../core/registry.js';
+import type { SchemaRegistry, HandlerSchema } from '../../validation/index.js';
+import type { HandlerMeta } from '../../types/index.js';
+/**
+ * Streams generation options
+ */
+export interface StreamsGeneratorOptions {
+    /** Include backpressure metadata */
+    includeBackpressure?: boolean;
+    /** Default security requirement */
+    defaultSecurity?: Array<Record<string, string[]>>;
+    /** Protocol content types */
+    contentTypes?: USDContentTypes;
+}
+/**
+ * Streams generation context
+ */
+export interface StreamsGeneratorContext {
+    /** Handler registry */
+    registry: Registry;
+    /** Schema registry for input/output schemas */
+    schemaRegistry?: SchemaRegistry;
+}
+/**
+ * Streams generation result
+ */
+export interface StreamsGeneratorResult {
+    /** USD Streams specification */
+    streams: USDStreams;
+    /** Component schemas used */
+    schemas: Record<string, USDSchema>;
+}
+/**
+ * Generate USD Streams specification from registered streams
+ */
+export declare function generateStreams(ctx: StreamsGeneratorContext, options?: StreamsGeneratorOptions): StreamsGeneratorResult;
+/**
+ * Helper to create an SSE stream definition for manual configuration
+ */
+export declare function createSSEStreamConfig(options: {
+    name: string;
+    description?: string;
+    eventSchema?: unknown;
+    inputSchema?: unknown;
+    tags?: string[];
+}): {
+    name: string;
+    meta: Partial<HandlerMeta>;
+    schema: Partial<HandlerSchema>;
+};
+/**
+ * Helper to create a bidirectional stream definition for manual configuration
+ */
+export declare function createBidiStreamConfig(options: {
+    name: string;
+    description?: string;
+    clientMessageSchema?: unknown;
+    serverMessageSchema?: unknown;
+    tags?: string[];
+}): {
+    name: string;
+    meta: Partial<HandlerMeta>;
+    schema: Partial<HandlerSchema>;
+};
+/**
+ * Generate stream auth security schemes
+ *
+ * Documents the available authentication methods for SSE/fetch streams:
+ * - Cookie session: Automatic with EventSource, uses session cookie
+ * - Bearer token (query): For EventSource, token in ?token= param
+ * - Bearer token (header): For fetch API streams, Authorization header
+ * - API key (query): For EventSource, key in ?apiKey= param
+ */
+export declare function generateStreamAuthSchemes(): Record<string, import('../../usd/index.js').USDSecurityScheme>;
+/**
+ * Generate standard stream events for SSE compatibility
+ */
+export declare function generateStreamEvents(): Record<string, USDSchema>;
+//# sourceMappingURL=streams-generator.d.ts.map

package/dist/docs/generators/streams-generator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"streams-generator.d.ts","sourceRoot":"","sources":["../../../src/docs/generators/streams-generator.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EACV,UAAU,EAGV,SAAS,EAET,eAAe,EAChB,MAAM,oBAAoB,CAAA;AAE3B,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAA;AACtD,OAAO,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AAC9E,OAAO,KAAK,EAAmB,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAIxE;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,oCAAoC;IACpC,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B,mCAAmC;IACnC,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAA;IACjD,6BAA6B;IAC7B,YAAY,CAAC,EAAE,eAAe,CAAA;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,uBAAuB;IACvB,QAAQ,EAAE,QAAQ,CAAA;IAClB,+CAA+C;IAC/C,cAAc,CAAC,EAAE,cAAc,CAAA;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,gCAAgC;IAChC,OAAO,EAAE,UAAU,CAAA;IACnB,6BAA6B;IAC7B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;CACnC;AAED;;GAEG;AACH,wBAAgB,eAAe,CAC7B,GAAG,EAAE,uBAAuB,EAC5B,OAAO,GAAE,uBAA4B,GACpC,sBAAsB,CAkCxB;AA6JD;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE;IAC7C,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;CAChB,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IAAC,MAAM,EAAE,OAAO,CAAC,aAAa,CAAC,CAAA;CAAE,CAc/E;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,EAAE;IAC9C,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;CAChB,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IAAC,MAAM,EAAE,OAAO,CAAC,aAAa,CAAC,CAAA;CAAE,CAc/E;AAED;;;;;;;;GAQG;AACH,wBAAgB,yBAAyB,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,oBAAoB,EAAE,iBAAiB,CAAC,CAoC1G;AAED;;GAEG;AACH,wBAAgB,oBAAoB,IAAI,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAuChE"}