@tellescope/schema 1.238.0 → 1.239.0

package/lib/cjs/generate-openapi.d.ts

@@ -0,0 +1,106 @@
+#!/usr/bin/env npx ts-node
+/**
+ * OpenAPI 3.0 Specification Generator for Tellescope API
+ *
+ * This script generates an OpenAPI 3.0 JSON specification from the Tellescope schema.
+ * It reads the schema definitions and produces a complete API documentation.
+ *
+ * Usage:
+ *   cd packages/public/schema
+ *   npx ts-node src/generate-openapi.ts [output-path]
+ *
+ *   Default output: ./openapi.json
+ */
+interface OpenAPISchemaType {
+    type?: string;
+    format?: string;
+    items?: OpenAPISchemaType;
+    properties?: Record<string, OpenAPISchemaType>;
+    additionalProperties?: OpenAPISchemaType | boolean;
+    $ref?: string;
+    oneOf?: OpenAPISchemaType[];
+    anyOf?: OpenAPISchemaType[];
+    example?: any;
+    required?: string[];
+    nullable?: boolean;
+    description?: string;
+    enum?: string[];
+    pattern?: string;
+    minimum?: number;
+    maximum?: number;
+}
+interface OpenAPIParameter {
+    name: string;
+    in: 'path' | 'query' | 'header' | 'cookie';
+    required?: boolean;
+    schema: OpenAPISchemaType;
+    description?: string;
+}
+interface OpenAPIRequestBody {
+    required?: boolean;
+    content: {
+        'application/json': {
+            schema: OpenAPISchemaType;
+        };
+    };
+}
+interface OpenAPIResponse {
+    description: string;
+    content?: {
+        'application/json': {
+            schema: OpenAPISchemaType;
+        };
+    };
+}
+interface OpenAPIOperation {
+    summary?: string;
+    description?: string;
+    tags?: string[];
+    operationId?: string;
+    security?: Array<Record<string, string[]>>;
+    parameters?: OpenAPIParameter[];
+    requestBody?: OpenAPIRequestBody;
+    responses: Record<string, OpenAPIResponse | {
+        $ref: string;
+    }>;
+}
+interface OpenAPIPathItem {
+    get?: OpenAPIOperation;
+    post?: OpenAPIOperation;
+    patch?: OpenAPIOperation;
+    put?: OpenAPIOperation;
+    delete?: OpenAPIOperation;
+}
+interface OpenAPISpec {
+    openapi: string;
+    info: {
+        title: string;
+        version: string;
+        description: string;
+        contact?: {
+            email?: string;
+            url?: string;
+        };
+    };
+    servers: Array<{
+        url: string;
+        description: string;
+    }>;
+    paths: Record<string, OpenAPIPathItem>;
+    components: {
+        schemas: Record<string, OpenAPISchemaType>;
+        securitySchemes: Record<string, any>;
+        responses: Record<string, OpenAPIResponse>;
+    };
+    tags: Array<{
+        name: string;
+        description?: string;
+    }>;
+    security: Array<Record<string, string[]>>;
+}
+/**
+ * Generate the complete OpenAPI specification
+ */
+declare function generateOpenAPISpec(): OpenAPISpec;
+export { generateOpenAPISpec, OpenAPISpec };
+//# sourceMappingURL=generate-openapi.d.ts.map

package/lib/cjs/generate-openapi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-openapi.d.ts","sourceRoot":"","sources":["../../src/generate-openapi.ts"],"names":[],"mappings":";AACA;;;;;;;;;;;GAWG;AAWH,UAAU,iBAAiB;IACzB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,iBAAiB,CAAA;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAA;IAC9C,oBAAoB,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAA;IAClD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,iBAAiB,EAAE,CAAA;IAC3B,KAAK,CAAC,EAAE,iBAAiB,EAAE,CAAA;IAC3B,OAAO,CAAC,EAAE,GAAG,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,UAAU,gBAAgB;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAA;IAC1C,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,MAAM,EAAE,iBAAiB,CAAA;IACzB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,UAAU,kBAAkB;IAC1B,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,OAAO,EAAE;QACP,kBAAkB,EAAE;YAClB,MAAM,EAAE,iBAAiB,CAAA;SAC1B,CAAA;KACF,CAAA;CACF;AAED,UAAU,eAAe;IACvB,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE;QACR,kBAAkB,EAAE;YAClB,MAAM,EAAE,iBAAiB,CAAA;SAC1B,CAAA;KACF,CAAA;CACF;AAED,UAAU,gBAAgB;IACxB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAA;IAC1C,UAAU,CAAC,EAAE,gBAAgB,EAAE,CAAA;IAC/B,WAAW,CAAC,EAAE,kBAAkB,CAAA;IAChC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;CAC9D;AAED,UAAU,eAAe;IACvB,GAAG,CAAC,EAAE,gBAAgB,CAAA;IACtB,IAAI,CAAC,EAAE,gBAAgB,CAAA;IACvB,KAAK,CAAC,EAAE,gBAAgB,CAAA;IACxB,GAAG,CAAC,EAAE,gBAAgB,CAAA;IACtB,MAAM,CAAC,EAAE,gBAAgB,CAAA;CAC1B;AAED,UAAU,WAAW;IACnB,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE;QACJ,KAAK,EAAE,MAAM,CAAA;QACb,OAAO,EAAE,MAAM,CAAA;QACf,WAAW,EAAE,MAAM,CAAA;QACnB,OAAO,CAAC,EAAE;YAAE,KAAK,CAAC,EAAE,MAAM,CAAC;YAAC,GAAG,CAAC,EAAE,MAAM,CAAA;SAAE,CAAA;KAC3C,CAAA;IACD,OAAO,EAAE,KAAK,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IACpD,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAA;IACtC,UAAU,EAAE;QACV,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAA;QAC1C,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;QACpC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAA;KAC3C,CAAA;IACD,IAAI,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IACnD,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAA;CAC1C;AAo/BD;;GAEG;AACH,iBAAS,mBAAmB,IAAI,WAAW,CA6G1C;AAuCD,OAAO,EAAE,mBAAmB,EAAE,WAAW,EAAE,CAAA"}