adorn-api 1.0.15 → 1.0.17

package/dist/compiler/schema/index.d.ts

@@ -3,4 +3,6 @@
  */
 export { typeToJsonSchema, createSchemaContext } from './typeToJsonSchema.js';
 export type { JsonSchema, SchemaContext } from './types.js';
+export { partitionSchemas, SchemaPartitioner, type PartitionStrategy, type SchemaGroup, type PartitioningResult, type SchemaComplexity, calculateSchemaComplexity, } from './partitioner.js';
+export { generateModularOpenAPI, generateLazyOpenAPI, type SplitOpenAPIConfig, type SplitOpenAPIResult, } from './splitOpenapi.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/compiler/schema/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/compiler/schema/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EACL,gBAAgB,EAChB,mBAAmB,EACpB,MAAM,uBAAuB,CAAC;AAC/B,YAAY,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/compiler/schema/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EACL,gBAAgB,EAChB,mBAAmB,EACpB,MAAM,uBAAuB,CAAC;AAC/B,YAAY,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAG5D,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,KAAK,iBAAiB,EACtB,KAAK,WAAW,EAChB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,yBAAyB,GAC1B,MAAM,kBAAkB,CAAC;AAG1B,OAAO,EACL,sBAAsB,EACtB,mBAAmB,EACnB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,GACxB,MAAM,mBAAmB,CAAC"}

package/dist/compiler/schema/partitioner.d.ts

@@ -0,0 +1,85 @@
+/**
+ * Smart OpenAPI Schema Partitioner
+ * Automatically partitions schemas into optimal groups based on heuristics
+ */
+import type { Graph } from "../graph/types.js";
+import type { SchemaGraph } from "../graph/schemaGraph.js";
+import type { JsonSchema } from "./types.js";
+/**
+ * Partitioning strategy options
+ */
+export type PartitionStrategy = 'auto' | 'none' | 'controller' | 'dependency' | 'size';
+/**
+ * Schema complexity metrics
+ */
+export interface SchemaComplexity {
+    propertyCount: number;
+    nestedDepth: number;
+    refCount: number;
+    hasUnion: boolean;
+    hasIntersection: boolean;
+    hasEnum: boolean;
+    jsonSize: number;
+}
+/**
+ * A group of schemas for partitioning
+ */
+export interface SchemaGroup {
+    name: string;
+    schemas: Map<string, JsonSchema>;
+    complexity: number;
+    dependencies: string[];
+}
+/**
+ * Partitioning result with metadata
+ */
+export interface PartitioningResult {
+    shouldSplit: boolean;
+    strategy: PartitionStrategy;
+    groups: SchemaGroup[];
+    recommendation: string;
+    metrics: {
+        totalSchemas: number;
+        averageComplexity: number;
+        avgDependencyDensity: number;
+        controllerGroups: number;
+    };
+}
+/**
+ * Configuration for partitioning
+ */
+export interface PartitionerConfig {
+    strategy?: PartitionStrategy;
+    threshold?: number;
+    maxGroupSize?: number;
+    complexityThreshold?: number;
+    verbose?: boolean;
+}
+/**
+ * Calculate complexity metrics for a schema
+ */
+export declare function calculateSchemaComplexity(schema: JsonSchema): SchemaComplexity;
+/**
+ * Main partitioning function with smart auto-detection
+ */
+export declare function partitionSchemas(schemas: Map<string, JsonSchema>, graph: Graph, schemaGraph: SchemaGraph, config?: PartitionerConfig): PartitioningResult;
+/**
+ * Export partitioner class for advanced use cases
+ */
+export declare class SchemaPartitioner {
+    private config;
+    constructor(config?: PartitionerConfig);
+    /**
+     * Partition schemas with the configured strategy
+     */
+    partition(schemas: Map<string, JsonSchema>, graph: Graph, schemaGraph: SchemaGraph): PartitioningResult;
+    /**
+     * Set the partitioning strategy
+     */
+    setStrategy(strategy: PartitionStrategy): void;
+    /**
+     * Get current configuration
+     */
+    getConfig(): Readonly<Required<PartitionerConfig>>;
+}
+//# sourceMappingURL=partitioner.d.ts.map

package/dist/compiler/schema/partitioner.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"partitioner.d.ts","sourceRoot":"","sources":["../../../src/compiler/schema/partitioner.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,KAAK,EAAU,MAAM,mBAAmB,CAAC;AACvD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE7C;;GAEG;AACH,MAAM,MAAM,iBAAiB,GACzB,MAAM,GACN,MAAM,GACN,YAAY,GACZ,YAAY,GACZ,MAAM,CAAC;AAEX;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;IAClB,eAAe,EAAE,OAAO,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,EAAE,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,WAAW,EAAE,OAAO,CAAC;IACrB,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,MAAM,EAAE,WAAW,EAAE,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE;QACP,YAAY,EAAE,MAAM,CAAC;QACrB,iBAAiB,EAAE,MAAM,CAAC;QAC1B,oBAAoB,EAAE,MAAM,CAAC;QAC7B,gBAAgB,EAAE,MAAM,CAAC;KAC1B,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,EAAE,iBAAiB,CAAC;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAaD;;GAEG;AACH,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,UAAU,GAAG,gBAAgB,CAqD9E;AAiTD;;GAEG;AACH,wBAAgB,gBAAgB,CAC9B,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,EAChC,KAAK,EAAE,KAAK,EACZ,WAAW,EAAE,WAAW,EACxB,MAAM,GAAE,iBAAsB,GAC7B,kBAAkB,CA4EpB;AAED;;GAEG;AACH,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,MAAM,CAA8B;gBAEhC,MAAM,GAAE,iBAAsB;IAI1C;;OAEG;IACH,SAAS,CACP,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,EAChC,KAAK,EAAE,KAAK,EACZ,WAAW,EAAE,WAAW,GACvB,kBAAkB;IAIrB;;OAEG;IACH,WAAW,CAAC,QAAQ,EAAE,iBAAiB,GAAG,IAAI;IAI9C;;OAEG;IACH,SAAS,IAAI,QAAQ,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC;CAGnD"}

package/dist/compiler/schema/splitOpenapi.d.ts

@@ -0,0 +1,39 @@
+import type { OpenAPI31 } from "./openapi.js";
+import type { PartitioningResult } from "./partitioner.js";
+/**
+ * Configuration for modular OpenAPI generation
+ */
+export interface SplitOpenAPIConfig {
+    outputDir: string;
+    schemasDir?: string;
+    createIndexFile?: boolean;
+    prettyPrint?: boolean;
+}
+/**
+ * Result of modular OpenAPI generation
+ */
+export interface SplitOpenAPIResult {
+    mainSpec: string;
+    schemaFiles: string[];
+    indexFile?: string;
+    totalSize: number;
+    splitEnabled: boolean;
+}
+/**
+ * Generate modular OpenAPI specification with split schema files
+ */
+export declare function generateModularOpenAPI(openapi: OpenAPI31, partitioning: PartitioningResult, config: SplitOpenAPIConfig): SplitOpenAPIResult;
+/**
+ * Generate a lightweight OpenAPI spec that references external files
+ * This is useful for Swagger UI lazy loading
+ */
+export declare function generateLazyOpenAPI(openapi: OpenAPI31, partitioning: PartitioningResult): OpenAPI31;
+/**
+ * Get the file path for a schema group
+ */
+export declare function getSchemaFilePath(groupName: string, outputDir: string, schemasDir?: string): string;
+/**
+ * Check if a schema exists in a specific file
+ */
+export declare function schemaExistsInFile(schemaName: string, outputDir: string, groupName: string): boolean;
+//# sourceMappingURL=splitOpenapi.d.ts.map

package/dist/compiler/schema/splitOpenapi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"splitOpenapi.d.ts","sourceRoot":"","sources":["../../../src/compiler/schema/splitOpenapi.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,KAAK,EAAE,kBAAkB,EAAe,MAAM,kBAAkB,CAAC;AAExE;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,OAAO,CAAC;CACvB;AAsHD;;GAEG;AACH,wBAAgB,sBAAsB,CACpC,OAAO,EAAE,SAAS,EAClB,YAAY,EAAE,kBAAkB,EAChC,MAAM,EAAE,kBAAkB,GACzB,kBAAkB,CA0EpB;AA0CD;;;GAGG;AACH,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,SAAS,EAClB,YAAY,EAAE,kBAAkB,GAC/B,SAAS,CAuBX;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAC/B,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EACjB,UAAU,GAAE,MAAkB,GAC7B,MAAM,CAGR;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,GAChB,OAAO,CAaT"}

package/dist/express.cjs

@@ -970,25 +970,78 @@ var import_express2 = require("express");
 var import_node_fs2 = require("fs");
 var import_node_path3 = require("path");
 var import_swagger_ui_express = __toESM(require("swagger-ui-express"), 1);
+var DEFAULT_SWAGGER_UI_OPTIONS = {
+  docExpansion: "none",
+  // Collapse all by default for better performance
+  filter: true,
+  // Show filter input
+  showRequestDuration: true,
+  // Show request duration
+  displayRequestDuration: true,
+  operationsSorter: "alpha",
+  // Sort operations alphabetically
+  tagsSorter: "alpha",
+  // Sort tags alphabetically
+  persistAuthorization: true
+  // Persist authorization across reloads
+};
+function isSplitMode(openapiPath) {
+  const schemasDir = (0, import_node_path3.join)(openapiPath, "..", "schemas");
+  return (0, import_node_fs2.existsSync)(schemasDir);
+}
+function createSchemaRouter(artifactsDir) {
+  const router = (0, import_express2.Router)();
+  const schemasDir = (0, import_node_path3.isAbsolute)(artifactsDir) ? (0, import_node_path3.resolve)(artifactsDir, "schemas") : (0, import_node_path3.resolve)(process.cwd(), artifactsDir, "schemas");
+  router.get("/schemas/:filename", (req, res, next) => {
+    const { filename } = req.params;
+    const filePath = (0, import_node_path3.resolve)(schemasDir, filename);
+    if (!(0, import_node_fs2.existsSync)(filePath)) {
+      return res.status(404).json({ error: "Schema file not found" });
+    }
+    try {
+      const content = (0, import_node_fs2.readFileSync)(filePath, "utf-8");
+      res.setHeader("Content-Type", "application/json");
+      res.send(content);
+    } catch (error) {
+      next(error);
+    }
+  });
+  return router;
+}
 function setupSwagger(options = {}) {
   const {
     artifactsDir = ".adorn",
     jsonPath = "/docs/openapi.json",
     uiPath = "/docs",
-    swaggerOptions = {}
+    swaggerOptions = {},
+    swaggerUiOptions = {}
   } = options;
   const router = (0, import_express2.Router)();
+  const openApiPath = (0, import_node_path3.isAbsolute)(artifactsDir) ? (0, import_node_path3.resolve)(artifactsDir, "openapi.json") : (0, import_node_path3.resolve)(process.cwd(), artifactsDir, "openapi.json");
+  const splitMode = isSplitMode(openApiPath);
   router.get(jsonPath, (req, res) => {
-    const openApiPath = (0, import_node_path3.isAbsolute)(artifactsDir) ? (0, import_node_path3.resolve)(artifactsDir, "openapi.json") : (0, import_node_path3.resolve)(process.cwd(), artifactsDir, "openapi.json");
+    if (!(0, import_node_fs2.existsSync)(openApiPath)) {
+      return res.status(404).json({ error: "OpenAPI spec not found" });
+    }
     const content = (0, import_node_fs2.readFileSync)(openApiPath, "utf-8");
     res.setHeader("Content-Type", "application/json");
     res.send(content);
   });
+  if (splitMode) {
+    router.use("/schemas", createSchemaRouter(artifactsDir));
+  }
+  const mergedSwaggerOptions = {
+    ...DEFAULT_SWAGGER_UI_OPTIONS,
+    ...swaggerOptions
+  };
   router.use(uiPath, import_swagger_ui_express.default.serve, import_swagger_ui_express.default.setup(null, {
     swaggerOptions: {
       url: jsonPath,
-      ...swaggerOptions
-    }
+      ...mergedSwaggerOptions,
+      // Add support for external $ref references in split mode
+      supportedSubmitMethods: ["get", "put", "post", "delete", "options", "head", "patch"]
+    },
+    ...swaggerUiOptions
   }));
   return router;
 }
@@ -1079,8 +1132,10 @@ function bootstrap(options) {
             jsonPath: swaggerJsonPath,
             uiPath: swaggerPath,
             swaggerOptions: {
-              servers: [{ url: serverUrl }]
-            }
+              servers: [{ url: serverUrl }],
+              ...options.swaggerOptions
+            },
+            swaggerUiOptions: options.swaggerUiOptions
           })
         );
       }