@parallelworks/api-docs 0.1.4

package/dist/openapi.js

@@ -0,0 +1,259 @@
+// Constants
+export const HTTP_METHOD_COLORS = {
+    get: {
+        bg: 'bg-emerald-100 dark:bg-emerald-900/30',
+        text: 'text-emerald-700 dark:text-emerald-400',
+        border: 'border-emerald-200 dark:border-emerald-800',
+    },
+    post: {
+        bg: 'bg-blue-100 dark:bg-blue-900/30',
+        text: 'text-blue-700 dark:text-blue-400',
+        border: 'border-blue-200 dark:border-blue-800',
+    },
+    put: {
+        bg: 'bg-amber-100 dark:bg-amber-900/30',
+        text: 'text-amber-700 dark:text-amber-400',
+        border: 'border-amber-200 dark:border-amber-800',
+    },
+    patch: {
+        bg: 'bg-orange-100 dark:bg-orange-900/30',
+        text: 'text-orange-700 dark:text-orange-400',
+        border: 'border-orange-200 dark:border-orange-800',
+    },
+    delete: {
+        bg: 'bg-red-100 dark:bg-red-900/30',
+        text: 'text-red-700 dark:text-red-400',
+        border: 'border-red-200 dark:border-red-800',
+    },
+    options: {
+        bg: 'bg-purple-100 dark:bg-purple-900/30',
+        text: 'text-purple-700 dark:text-purple-400',
+        border: 'border-purple-200 dark:border-purple-800',
+    },
+    head: {
+        bg: 'bg-slate-100 dark:bg-slate-900/30',
+        text: 'text-slate-700 dark:text-slate-400',
+        border: 'border-slate-200 dark:border-slate-800',
+    },
+    trace: {
+        bg: 'bg-slate-100 dark:bg-slate-900/30',
+        text: 'text-slate-700 dark:text-slate-400',
+        border: 'border-slate-200 dark:border-slate-800',
+    },
+};
+// Utilities
+export function slugify(str) {
+    return str
+        .toLowerCase()
+        .replace(/[^a-z0-9]+/g, '-')
+        .replace(/^-|-$/g, '');
+}
+export function createEndpointSlug(method, path) {
+    const pathSlug = path
+        .replace(/^\/api\//, '')
+        .replace(/\{([^}]+)\}/g, '_$1_')
+        .replace(/\//g, '-')
+        .replace(/^-|-$/g, '');
+    return `${method}-${pathSlug}`;
+}
+export function resolveRef(ref, spec) {
+    const parts = ref.replace('#/', '').split('/');
+    let result = spec;
+    for (const part of parts) {
+        if (result && typeof result === 'object' && part in result) {
+            result = result[part];
+        }
+        else {
+            return undefined;
+        }
+    }
+    return result;
+}
+export function getRefName(ref) {
+    return ref.split('/').pop() || ref;
+}
+export function isPublicOperation(operation) {
+    return !operation['x-internal'];
+}
+export function generateExampleFromSchema(schema, spec, visitedRefs = new Set(), depth = 0) {
+    if (depth > 5) {
+        return null;
+    }
+    if (schema.example !== undefined) {
+        return schema.example;
+    }
+    if (schema.examples && schema.examples.length > 0) {
+        return schema.examples[0];
+    }
+    if (schema.$ref) {
+        if (visitedRefs.has(schema.$ref)) {
+            return `{${getRefName(schema.$ref)}}`;
+        }
+        if (spec) {
+            const resolvedSchema = resolveRef(schema.$ref, spec);
+            if (resolvedSchema) {
+                const newVisitedRefs = new Set(visitedRefs);
+                newVisitedRefs.add(schema.$ref);
+                return generateExampleFromSchema(resolvedSchema, spec, newVisitedRefs, depth + 1);
+            }
+        }
+        return `{${getRefName(schema.$ref)}}`;
+    }
+    if (schema.allOf && schema.allOf.length > 0) {
+        const result = {};
+        for (const subSchema of schema.allOf) {
+            const subExample = generateExampleFromSchema(subSchema, spec, visitedRefs, depth + 1);
+            if (typeof subExample === 'object' &&
+                subExample !== null &&
+                !Array.isArray(subExample)) {
+                Object.assign(result, subExample);
+            }
+        }
+        return Object.keys(result).length > 0 ? result : null;
+    }
+    if (schema.oneOf && schema.oneOf.length > 0) {
+        return generateExampleFromSchema(schema.oneOf[0], spec, visitedRefs, depth + 1);
+    }
+    if (schema.anyOf && schema.anyOf.length > 0) {
+        return generateExampleFromSchema(schema.anyOf[0], spec, visitedRefs, depth + 1);
+    }
+    const types = Array.isArray(schema.type) ? schema.type : [schema.type];
+    const primaryType = types.find(t => t !== 'null') || types[0];
+    if (schema.enum && schema.enum.length > 0) {
+        return schema.enum[0];
+    }
+    switch (primaryType) {
+        case 'object': {
+            if (!schema.properties || Object.keys(schema.properties).length === 0) {
+                return {};
+            }
+            const result = {};
+            for (const [propName, propSchema] of Object.entries(schema.properties)) {
+                const propExample = generateExampleFromSchema(propSchema, spec, visitedRefs, depth + 1);
+                if (propExample !== undefined) {
+                    result[propName] = propExample;
+                }
+            }
+            return result;
+        }
+        case 'array': {
+            if (schema.items) {
+                const itemExample = generateExampleFromSchema(schema.items, spec, visitedRefs, depth + 1);
+                return itemExample !== undefined ? [itemExample] : [];
+            }
+            return [];
+        }
+        case 'string': {
+            if (schema.format === 'date-time') {
+                return '2024-01-15T10:30:00Z';
+            }
+            if (schema.format === 'date') {
+                return '2024-01-15';
+            }
+            if (schema.format === 'email') {
+                return 'user@example.com';
+            }
+            if (schema.format === 'uri' || schema.format === 'url') {
+                return 'https://example.com';
+            }
+            if (schema.format === 'uuid') {
+                return '550e8400-e29b-41d4-a716-446655440000';
+            }
+            if (schema.format === 'hostname') {
+                return 'example.com';
+            }
+            if (schema.format === 'ipv4') {
+                return '192.168.1.1';
+            }
+            if (schema.format === 'ipv6') {
+                return '2001:0db8:85a3:0000:0000:8a2e:0370:7334';
+            }
+            return 'string';
+        }
+        case 'integer':
+        case 'number': {
+            if (schema.minimum !== undefined) {
+                return schema.minimum;
+            }
+            if (schema.maximum !== undefined) {
+                return Math.min(schema.maximum, 100);
+            }
+            return primaryType === 'integer' ? 0 : 0.0;
+        }
+        case 'boolean':
+            return schema.default !== undefined ? schema.default : true;
+        case 'null':
+            return null;
+        default:
+            return null;
+    }
+}
+/** Synchronous — consumers must fetch the spec before calling. */
+export function parseOpenAPISpecFromData(spec) {
+    const tagEndpointsMap = new Map();
+    const allEndpoints = [];
+    const methods = [
+        'get',
+        'post',
+        'put',
+        'patch',
+        'delete',
+        'options',
+        'head',
+        'trace',
+    ];
+    for (const [path, pathItem] of Object.entries(spec.paths)) {
+        for (const method of methods) {
+            const operation = pathItem[method];
+            if (!operation || !isPublicOperation(operation)) {
+                continue;
+            }
+            const tag = operation.tags?.[0] || 'Other';
+            const endpoint = {
+                path,
+                method,
+                operation,
+                slug: createEndpointSlug(method, path),
+                tag,
+            };
+            allEndpoints.push(endpoint);
+            const existing = tagEndpointsMap.get(tag);
+            if (existing) {
+                existing.push(endpoint);
+            }
+            else {
+                tagEndpointsMap.set(tag, [endpoint]);
+            }
+        }
+    }
+    const tags = [];
+    const specTags = spec.tags || [];
+    for (const specTag of specTags) {
+        const endpoints = tagEndpointsMap.get(specTag.name) || [];
+        if (endpoints.length > 0) {
+            tags.push({
+                name: specTag.name,
+                description: specTag.description,
+                slug: slugify(specTag.name),
+                endpoints,
+            });
+        }
+    }
+    for (const [tagName, endpoints] of tagEndpointsMap) {
+        if (!tags.find(t => t.name === tagName)) {
+            tags.push({
+                name: tagName,
+                slug: slugify(tagName),
+                endpoints,
+            });
+        }
+    }
+    return {
+        info: spec.info,
+        tags,
+        endpoints: allEndpoints,
+        securitySchemes: spec.components?.securitySchemes || {},
+        schemas: spec.components?.schemas || {},
+    };
+}
+//# sourceMappingURL=openapi.js.map

package/dist/openapi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"openapi.js","sourceRoot":"","sources":["../src/openapi.ts"],"names":[],"mappings":"AASA,YAAY;AAEZ,MAAM,CAAC,MAAM,kBAAkB,GAG3B;IACF,GAAG,EAAE;QACH,EAAE,EAAE,uCAAuC;QAC3C,IAAI,EAAE,wCAAwC;QAC9C,MAAM,EAAE,4CAA4C;KACrD;IACD,IAAI,EAAE;QACJ,EAAE,EAAE,iCAAiC;QACrC,IAAI,EAAE,kCAAkC;QACxC,MAAM,EAAE,sCAAsC;KAC/C;IACD,GAAG,EAAE;QACH,EAAE,EAAE,mCAAmC;QACvC,IAAI,EAAE,oCAAoC;QAC1C,MAAM,EAAE,wCAAwC;KACjD;IACD,KAAK,EAAE;QACL,EAAE,EAAE,qCAAqC;QACzC,IAAI,EAAE,sCAAsC;QAC5C,MAAM,EAAE,0CAA0C;KACnD;IACD,MAAM,EAAE;QACN,EAAE,EAAE,+BAA+B;QACnC,IAAI,EAAE,gCAAgC;QACtC,MAAM,EAAE,oCAAoC;KAC7C;IACD,OAAO,EAAE;QACP,EAAE,EAAE,qCAAqC;QACzC,IAAI,EAAE,sCAAsC;QAC5C,MAAM,EAAE,0CAA0C;KACnD;IACD,IAAI,EAAE;QACJ,EAAE,EAAE,mCAAmC;QACvC,IAAI,EAAE,oCAAoC;QAC1C,MAAM,EAAE,wCAAwC;KACjD;IACD,KAAK,EAAE;QACL,EAAE,EAAE,mCAAmC;QACvC,IAAI,EAAE,oCAAoC;QAC1C,MAAM,EAAE,wCAAwC;KACjD;CACF,CAAA;AAED,YAAY;AAEZ,MAAM,UAAU,OAAO,CAAC,GAAW;IACjC,OAAO,GAAG;SACP,WAAW,EAAE;SACb,OAAO,CAAC,aAAa,EAAE,GAAG,CAAC;SAC3B,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAA;AAC1B,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,MAAc,EAAE,IAAY;IAC7D,MAAM,QAAQ,GAAG,IAAI;SAClB,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC;SACvB,OAAO,CAAC,cAAc,EAAE,MAAM,CAAC;SAC/B,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;SACnB,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAA;IACxB,OAAO,GAAG,MAAM,IAAI,QAAQ,EAAE,CAAA;AAChC,CAAC;AAED,MAAM,UAAU,UAAU,CACxB,GAAW,EACX,IAAiB;IAEjB,MAAM,KAAK,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAC9C,IAAI,MAAM,GAAY,IAAI,CAAA;IAC1B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,IAAI,IAAI,MAAM,EAAE,CAAC;YAC3D,MAAM,GAAI,MAAkC,CAAC,IAAI,CAAC,CAAA;QACpD,CAAC;aAAM,CAAC;YACN,OAAO,SAAS,CAAA;QAClB,CAAC;IACH,CAAC;IACD,OAAO,MAAuB,CAAA;AAChC,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,GAAW;IACpC,OAAO,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,IAAI,GAAG,CAAA;AACpC,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,SAA2B;IAC3D,OAAO,CAAC,SAAS,CAAC,YAAY,CAAC,CAAA;AACjC,CAAC;AAED,MAAM,UAAU,yBAAyB,CACvC,MAAqB,EACrB,IAAkB,EAClB,WAAW,GAAgB,IAAI,GAAG,EAAE,EACpC,KAAK,GAAG,CAAC;IAET,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;QACd,OAAO,IAAI,CAAA;IACb,CAAC;IAED,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QACjC,OAAO,MAAM,CAAC,OAAO,CAAA;IACvB,CAAC;IACD,IAAI,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAClD,OAAO,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;IAC3B,CAAC;IAED,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;QAChB,IAAI,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;YACjC,OAAO,IAAI,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAA;QACvC,CAAC;QACD,IAAI,IAAI,EAAE,CAAC;YACT,MAAM,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;YACpD,IAAI,cAAc,EAAE,CAAC;gBACnB,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,CAAA;gBAC3C,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;gBAC/B,OAAO,yBAAyB,CAC9B,cAAc,EACd,IAAI,EACJ,cAAc,EACd,KAAK,GAAG,CAAC,CACV,CAAA;YACH,CAAC;QACH,CAAC;QACD,OAAO,IAAI,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAA;IACvC,CAAC;IAED,IAAI,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5C,MAAM,MAAM,GAA4B,EAAE,CAAA;QAC1C,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YACrC,MAAM,UAAU,GAAG,yBAAyB,CAC1C,SAAS,EACT,IAAI,EACJ,WAAW,EACX,KAAK,GAAG,CAAC,CACV,CAAA;YACD,IACE,OAAO,UAAU,KAAK,QAAQ;gBAC9B,UAAU,KAAK,IAAI;gBACnB,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAC1B,CAAC;gBACD,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;YACnC,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAA;IACvD,CAAC;IAED,IAAI,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5C,OAAO,yBAAyB,CAC9B,MAAM,CAAC,KAAK,CAAC,CAAC,CAAE,EAChB,IAAI,EACJ,WAAW,EACX,KAAK,GAAG,CAAC,CACV,CAAA;IACH,CAAC;IACD,IAAI,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5C,OAAO,yBAAyB,CAC9B,MAAM,CAAC,KAAK,CAAC,CAAC,CAAE,EAChB,IAAI,EACJ,WAAW,EACX,KAAK,GAAG,CAAC,CACV,CAAA;IACH,CAAC;IAED,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IACtE,MAAM,WAAW,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,CAAA;IAE7D,IAAI,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1C,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACvB,CAAC;IAED,QAAQ,WAAW,EAAE,CAAC;QACpB,KAAK,QAAQ,EAAE,CAAC;YACd,IAAI,CAAC,MAAM,CAAC,UAAU,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACtE,OAAO,EAAE,CAAA;YACX,CAAC;YACD,MAAM,MAAM,GAA4B,EAAE,CAAA;YAC1C,KAAK,MAAM,CAAC,QAAQ,EAAE,UAAU,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;gBACvE,MAAM,WAAW,GAAG,yBAAyB,CAC3C,UAAU,EACV,IAAI,EACJ,WAAW,EACX,KAAK,GAAG,CAAC,CACV,CAAA;gBACD,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;oBAC9B,MAAM,CAAC,QAAQ,CAAC,GAAG,WAAW,CAAA;gBAChC,CAAC;YACH,CAAC;YACD,OAAO,MAAM,CAAA;QACf,CAAC;QAED,KAAK,OAAO,EAAE,CAAC;YACb,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBACjB,MAAM,WAAW,GAAG,yBAAyB,CAC3C,MAAM,CAAC,KAAsB,EAC7B,IAAI,EACJ,WAAW,EACX,KAAK,GAAG,CAAC,CACV,CAAA;gBACD,OAAO,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;YACvD,CAAC;YACD,OAAO,EAAE,CAAA;QACX,CAAC;QAED,KAAK,QAAQ,EAAE,CAAC;YACd,IAAI,MAAM,CAAC,MAAM,KAAK,WAAW,EAAE,CAAC;gBAClC,OAAO,sBAAsB,CAAA;YAC/B,CAAC;YACD,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;gBAC7B,OAAO,YAAY,CAAA;YACrB,CAAC;YACD,IAAI,MAAM,CAAC,MAAM,KAAK,OAAO,EAAE,CAAC;gBAC9B,OAAO,kBAAkB,CAAA;YAC3B,CAAC;YACD,IAAI,MAAM,CAAC,MAAM,KAAK,KAAK,IAAI,MAAM,CAAC,MAAM,KAAK,KAAK,EAAE,CAAC;gBACvD,OAAO,qBAAqB,CAAA;YAC9B,CAAC;YACD,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;gBAC7B,OAAO,sCAAsC,CAAA;YAC/C,CAAC;YACD,IAAI,MAAM,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;gBACjC,OAAO,aAAa,CAAA;YACtB,CAAC;YACD,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;gBAC7B,OAAO,aAAa,CAAA;YACtB,CAAC;YACD,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;gBAC7B,OAAO,yCAAyC,CAAA;YAClD,CAAC;YACD,OAAO,QAAQ,CAAA;QACjB,CAAC;QAED,KAAK,SAAS,CAAC;QACf,KAAK,QAAQ,EAAE,CAAC;YACd,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;gBACjC,OAAO,MAAM,CAAC,OAAO,CAAA;YACvB,CAAC;YACD,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;gBACjC,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,EAAE,GAAG,CAAC,CAAA;YACtC,CAAC;YACD,OAAO,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAA;QAC5C,CAAC;QAED,KAAK,SAAS;YACZ,OAAO,MAAM,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAA;QAE7D,KAAK,MAAM;YACT,OAAO,IAAI,CAAA;QAEb;YACE,OAAO,IAAI,CAAA;IACf,CAAC;AACH,CAAC;AAED,kEAAkE;AAClE,MAAM,UAAU,wBAAwB,CAAC,IAAiB;IACxD,MAAM,eAAe,GAAG,IAAI,GAAG,EAAyB,CAAA;IACxD,MAAM,YAAY,GAAkB,EAAE,CAAA;IACtC,MAAM,OAAO,GAAG;QACd,KAAK;QACL,MAAM;QACN,KAAK;QACL,OAAO;QACP,QAAQ;QACR,SAAS;QACT,MAAM;QACN,OAAO;KACC,CAAA;IAEV,KAAK,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1D,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,MAAM,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAA;YAClC,IAAI,CAAC,SAAS,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,EAAE,CAAC;gBAChD,SAAQ;YACV,CAAC;YAED,MAAM,GAAG,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,OAAO,CAAA;YAC1C,MAAM,QAAQ,GAAgB;gBAC5B,IAAI;gBACJ,MAAM;gBACN,SAAS;gBACT,IAAI,EAAE,kBAAkB,CAAC,MAAM,EAAE,IAAI,CAAC;gBACtC,GAAG;aACJ,CAAA;YAED,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;YAE3B,MAAM,QAAQ,GAAG,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;YACzC,IAAI,QAAQ,EAAE,CAAC;gBACb,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;YACzB,CAAC;iBAAM,CAAC;gBACN,eAAe,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAA;YACtC,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,IAAI,GAAa,EAAE,CAAA;IACzB,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,IAAI,EAAE,CAAA;IAEhC,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,MAAM,SAAS,GAAG,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,CAAA;QACzD,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzB,IAAI,CAAC,IAAI,CAAC;gBACR,IAAI,EAAE,OAAO,CAAC,IAAI;gBAClB,WAAW,EAAE,OAAO,CAAC,WAAW;gBAChC,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;gBAC3B,SAAS;aACV,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;IAED,KAAK,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,eAAe,EAAE,CAAC;QACnD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,EAAE,CAAC;YACxC,IAAI,CAAC,IAAI,CAAC;gBACR,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC;gBACtB,SAAS;aACV,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;IAED,OAAO;QACL,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,IAAI;QACJ,SAAS,EAAE,YAAY;QACvB,eAAe,EAAE,IAAI,CAAC,UAAU,EAAE,eAAe,IAAI,EAAE;QACvD,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,OAAO,IAAI,EAAE;KACxC,CAAA;AACH,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,150 @@
+export interface OpenAPISpec {
+    openapi: string;
+    info: OpenAPIInfo;
+    paths: Record<string, OpenAPIPathItem>;
+    components?: OpenAPIComponents;
+    tags?: OpenAPITag[];
+    externalDocs?: OpenAPIExternalDocs;
+}
+export interface OpenAPIInfo {
+    title: string;
+    version: string;
+    description?: string;
+    contact?: {
+        name?: string;
+        url?: string;
+        email?: string;
+    };
+    termsOfService?: string;
+}
+export interface OpenAPITag {
+    name: string;
+    description?: string;
+}
+export interface OpenAPIExternalDocs {
+    description?: string;
+    url: string;
+}
+export interface OpenAPIPathItem {
+    get?: OpenAPIOperation;
+    post?: OpenAPIOperation;
+    put?: OpenAPIOperation;
+    patch?: OpenAPIOperation;
+    delete?: OpenAPIOperation;
+    options?: OpenAPIOperation;
+    head?: OpenAPIOperation;
+    trace?: OpenAPIOperation;
+    parameters?: OpenAPIParameter[];
+}
+export interface OpenAPIOperation {
+    operationId?: string;
+    summary?: string;
+    description?: string;
+    tags?: string[];
+    parameters?: OpenAPIParameter[];
+    requestBody?: OpenAPIRequestBody;
+    responses: Record<string, OpenAPIResponse>;
+    deprecated?: boolean;
+    security?: Array<Record<string, string[]>>;
+    'x-internal'?: boolean;
+}
+export interface OpenAPIParameter {
+    name: string;
+    in: 'query' | 'header' | 'path' | 'cookie';
+    description?: string;
+    required?: boolean;
+    deprecated?: boolean;
+    schema?: OpenAPISchema;
+    example?: unknown;
+    examples?: Record<string, {
+        value: unknown;
+    }>;
+}
+export interface OpenAPIRequestBody {
+    description?: string;
+    required?: boolean;
+    content: Record<string, OpenAPIMediaType>;
+}
+export interface OpenAPIResponse {
+    description: string;
+    content?: Record<string, OpenAPIMediaType>;
+    headers?: Record<string, OpenAPIHeader>;
+}
+export interface OpenAPIHeader {
+    description?: string;
+    schema?: OpenAPISchema;
+}
+export interface OpenAPIMediaType {
+    schema?: OpenAPISchema;
+    example?: unknown;
+    examples?: Record<string, {
+        value: unknown;
+        summary?: string;
+        description?: string;
+    }>;
+}
+export interface OpenAPIDiscriminator {
+    propertyName: string;
+    mapping?: Record<string, string>;
+}
+export interface OpenAPISchema {
+    type?: string | string[];
+    title?: string;
+    format?: string;
+    description?: string;
+    properties?: Record<string, OpenAPISchema>;
+    items?: OpenAPISchema;
+    required?: string[];
+    enum?: unknown[];
+    $ref?: string;
+    allOf?: OpenAPISchema[];
+    oneOf?: OpenAPISchema[];
+    anyOf?: OpenAPISchema[];
+    discriminator?: OpenAPIDiscriminator;
+    additionalProperties?: boolean | OpenAPISchema;
+    minimum?: number;
+    maximum?: number;
+    minLength?: number;
+    maxLength?: number;
+    pattern?: string;
+    default?: unknown;
+    example?: unknown;
+    examples?: unknown[];
+    readOnly?: boolean;
+    writeOnly?: boolean;
+    nullable?: boolean;
+    deprecated?: boolean;
+}
+export interface OpenAPIComponents {
+    schemas?: Record<string, OpenAPISchema>;
+    securitySchemes?: Record<string, OpenAPISecurityScheme>;
+}
+export interface OpenAPISecurityScheme {
+    type: 'apiKey' | 'http' | 'oauth2' | 'openIdConnect';
+    description?: string;
+    name?: string;
+    in?: 'query' | 'header' | 'cookie';
+    scheme?: string;
+    bearerFormat?: string;
+}
+export interface APIEndpoint {
+    path: string;
+    method: 'get' | 'post' | 'put' | 'patch' | 'delete' | 'options' | 'head' | 'trace';
+    operation: OpenAPIOperation;
+    slug: string;
+    tag: string;
+}
+export interface APITag {
+    name: string;
+    description?: string | undefined;
+    slug: string;
+    endpoints: APIEndpoint[];
+}
+export interface ParsedAPISpec {
+    info: OpenAPIInfo;
+    tags: APITag[];
+    endpoints: APIEndpoint[];
+    securitySchemes: Record<string, OpenAPISecurityScheme>;
+    schemas: Record<string, OpenAPISchema>;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,WAAW,CAAA;IACjB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAA;IACtC,UAAU,CAAC,EAAE,iBAAiB,CAAA;IAC9B,IAAI,CAAC,EAAE,UAAU,EAAE,CAAA;IACnB,YAAY,CAAC,EAAE,mBAAmB,CAAA;CACnC;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,EAAE;QACR,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,KAAK,CAAC,EAAE,MAAM,CAAA;KACf,CAAA;IACD,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,mBAAmB;IAClC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,GAAG,EAAE,MAAM,CAAA;CACZ;AAED,MAAM,WAAW,eAAe;IAC9B,GAAG,CAAC,EAAE,gBAAgB,CAAA;IACtB,IAAI,CAAC,EAAE,gBAAgB,CAAA;IACvB,GAAG,CAAC,EAAE,gBAAgB,CAAA;IACtB,KAAK,CAAC,EAAE,gBAAgB,CAAA;IACxB,MAAM,CAAC,EAAE,gBAAgB,CAAA;IACzB,OAAO,CAAC,EAAE,gBAAgB,CAAA;IAC1B,IAAI,CAAC,EAAE,gBAAgB,CAAA;IACvB,KAAK,CAAC,EAAE,gBAAgB,CAAA;IACxB,UAAU,CAAC,EAAE,gBAAgB,EAAE,CAAA;CAChC;AAED,MAAM,WAAW,gBAAgB;IAC/B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,UAAU,CAAC,EAAE,gBAAgB,EAAE,CAAA;IAC/B,WAAW,CAAC,EAAE,kBAAkB,CAAA;IAChC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAA;IAC1C,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAA;IAC1C,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAA;IAC1C,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,MAAM,CAAC,EAAE,aAAa,CAAA;IACtB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,KAAK,EAAE,OAAO,CAAA;KAAE,CAAC,CAAA;CAC9C;AAED,MAAM,WAAW,kBAAkB;IACjC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;CAC1C;AAED,MAAM,WAAW,eAAe;IAC9B,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;CACxC;AAED,MAAM,WAAW,aAAa;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,MAAM,CAAC,EAAE,aAAa,CAAA;CACvB;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,CAAC,EAAE,aAAa,CAAA;IACtB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CACf,MAAM,EACN;QAAE,KAAK,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,CAC3D,CAAA;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC,YAAY,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CACjC;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACxB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;IAC1C,KAAK,CAAC,EAAE,aAAa,CAAA;IACrB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB,IAAI,CAAC,EAAE,OAAO,EAAE,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,aAAa,EAAE,CAAA;IACvB,KAAK,CAAC,EAAE,aAAa,EAAE,CAAA;IACvB,KAAK,CAAC,EAAE,aAAa,EAAE,CAAA;IACvB,aAAa,CAAC,EAAE,oBAAoB,CAAA;IACpC,oBAAoB,CAAC,EAAE,OAAO,GAAG,aAAa,CAAA;IAC9C,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB;AAED,MAAM,WAAW,iBAAiB;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;IACvC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAA;CACxD;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,eAAe,CAAA;IACpD,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,EAAE,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAA;IAClC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAID,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EACF,KAAK,GACL,MAAM,GACN,KAAK,GACL,OAAO,GACP,QAAQ,GACR,SAAS,GACT,MAAM,GACN,OAAO,CAAA;IACX,SAAS,EAAE,gBAAgB,CAAA;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;CACZ;AAED,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,WAAW,EAAE,CAAA;CACzB;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,WAAW,CAAA;IACjB,IAAI,EAAE,MAAM,EAAE,CAAA;IACd,SAAS,EAAE,WAAW,EAAE,CAAA;IACxB,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAA;IACtD,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;CACvC"}

package/dist/types.js

@@ -0,0 +1 @@
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@parallelworks/api-docs",
+  "version": "0.1.4",
+  "description": "Shared React components and utilities for OpenAPI documentation",
+  "license": "MIT",
+  "author": "Parallel Works <support@parallelworks.com>",
+  "homepage": "https://parallelworks.com/docs",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/parallelworks/core.git",
+    "directory": "packages/api-docs"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./components": {
+      "types": "./dist/components/index.d.ts",
+      "import": "./dist/components/index.js"
+    }
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  },
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "react": "^18.0.0 || ^19.0.0"
+  },
+  "dependencies": {
+    "classnames": "^2.5.1"
+  },
+  "devDependencies": {
+    "@types/react": "19.2.17",
+    "typescript": "^7.0.0"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "clean": "rm -rf dist"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts"
+}