@honestjs/rpc-plugin 1.3.0 → 1.4.1

package/dist/index.js

@@ -36,7 +36,6 @@ __export(index_exports, {
   DEFAULT_OPTIONS: () => DEFAULT_OPTIONS,
   GENERIC_TYPES: () => GENERIC_TYPES,
   LOG_PREFIX: () => LOG_PREFIX,
-  OpenApiGeneratorService: () => OpenApiGeneratorService,
   RPCPlugin: () => RPCPlugin,
   RouteAnalyzerService: () => RouteAnalyzerService,
   SchemaGeneratorService: () => SchemaGeneratorService,
@@ -55,7 +54,7 @@ module.exports = __toCommonJS(index_exports);
 
 // src/rpc.plugin.ts
 var import_fs2 = __toESM(require("fs"));
-var import_path4 = __toESM(require("path"));
+var import_path3 = __toESM(require("path"));
 var import_ts_morph = require("ts-morph");
 
 // src/constants/defaults.ts
@@ -63,7 +62,13 @@ var DEFAULT_OPTIONS = {
   controllerPattern: "src/modules/*/*.controller.ts",
   tsConfigPath: "tsconfig.json",
   outputDir: "./generated/rpc",
-  generateOnInit: true
+  generateOnInit: true,
+  context: {
+    namespace: "rpc",
+    keys: {
+      artifact: "artifact"
+    }
+  }
 };
 var LOG_PREFIX = "[ RPCPlugin ]";
 var BUILTIN_UTILITY_TYPES = /* @__PURE__ */ new Set([
@@ -125,22 +130,22 @@ var import_path2 = __toESM(require("path"));
 // src/utils/path-utils.ts
 function buildFullPath(basePath, parameters) {
   if (!basePath || typeof basePath !== "string") return "/";
-  let path5 = basePath;
+  let path4 = basePath;
   if (parameters && Array.isArray(parameters)) {
     for (const param of parameters) {
       if (param.data && typeof param.data === "string" && param.data.startsWith(":")) {
         const paramName = param.data.slice(1);
-        path5 = path5.replace(`:${paramName}`, `\${${paramName}}`);
+        path4 = path4.replace(`:${paramName}`, `\${${paramName}}`);
       }
     }
   }
-  return path5;
+  return path4;
 }
 function buildFullApiPath(route) {
   const prefix = route.prefix || "";
   const version = route.version || "";
   const routePath = route.route || "";
-  const path5 = route.path || "";
+  const path4 = route.path || "";
   let fullPath = "";
   if (prefix && prefix !== "/") {
     fullPath += prefix.replace(/^\/+|\/+$/g, "");
@@ -151,9 +156,9 @@ function buildFullApiPath(route) {
   if (routePath && routePath !== "/") {
     fullPath += `/${routePath.replace(/^\/+|\/+$/g, "")}`;
   }
-  if (path5 && path5 !== "/") {
-    fullPath += `/${path5.replace(/^\/+|\/+$/g, "")}`;
-  } else if (path5 === "/") {
+  if (path4 && path4 !== "/") {
+    fullPath += `/${path4.replace(/^\/+|\/+$/g, "")}`;
+  } else if (path4 === "/") {
     fullPath += "/";
   }
   if (fullPath && !fullPath.startsWith("/")) fullPath = "/" + fullPath;
@@ -509,192 +514,6 @@ ${this.generateControllerMethods(controllerGroups)}
   }
 };
 
-// src/services/openapi-generator.service.ts
-var import_promises3 = __toESM(require("fs/promises"));
-var import_path3 = __toESM(require("path"));
-var OpenApiGeneratorService = class {
-  constructor(outputDir) {
-    this.outputDir = outputDir;
-  }
-  async generateSpec(routes, schemas, options) {
-    await import_promises3.default.mkdir(this.outputDir, { recursive: true });
-    const schemaMap = this.buildSchemaMap(schemas);
-    const spec = this.buildSpec(routes, schemaMap, options);
-    const outputPath = import_path3.default.join(this.outputDir, options.outputFile);
-    await import_promises3.default.writeFile(outputPath, JSON.stringify(spec, null, 2), "utf-8");
-    return outputPath;
-  }
-  buildSpec(routes, schemaMap, options) {
-    const spec = {
-      openapi: "3.0.3",
-      info: {
-        title: options.title,
-        version: options.version,
-        description: options.description
-      },
-      paths: {},
-      components: { schemas: schemaMap }
-    };
-    if (options.servers.length > 0) {
-      spec.servers = options.servers.map((s) => ({ ...s }));
-    }
-    for (const route of routes) {
-      const apiPath = this.toOpenApiPath(buildFullApiPath(route));
-      const method = safeToString(route.method).toLowerCase();
-      if (!spec.paths[apiPath]) {
-        spec.paths[apiPath] = {};
-      }
-      spec.paths[apiPath][method] = this.buildOperation(route, schemaMap);
-    }
-    return spec;
-  }
-  buildOperation(route, schemaMap) {
-    const controllerName = safeToString(route.controller).replace(/Controller$/, "");
-    const handlerName = safeToString(route.handler);
-    const parameters = route.parameters || [];
-    const operation = {
-      operationId: handlerName,
-      tags: [controllerName],
-      responses: this.buildResponses(route.returns, schemaMap)
-    };
-    const openApiParams = this.buildParameters(parameters);
-    if (openApiParams.length > 0) {
-      operation.parameters = openApiParams;
-    }
-    const requestBody = this.buildRequestBody(parameters, schemaMap);
-    if (requestBody) {
-      operation.requestBody = requestBody;
-    }
-    return operation;
-  }
-  buildParameters(parameters) {
-    const result = [];
-    for (const param of parameters) {
-      if (param.decoratorType === "param") {
-        result.push({
-          name: param.data ?? param.name,
-          in: "path",
-          required: true,
-          schema: this.tsTypeToJsonSchema(param.type)
-        });
-      } else if (param.decoratorType === "query") {
-        if (param.data) {
-          result.push({
-            name: param.data,
-            in: "query",
-            required: param.required === true,
-            schema: this.tsTypeToJsonSchema(param.type)
-          });
-        } else {
-          result.push({
-            name: param.name,
-            in: "query",
-            required: param.required === true,
-            schema: this.tsTypeToJsonSchema(param.type)
-          });
-        }
-      }
-    }
-    return result;
-  }
-  buildRequestBody(parameters, schemaMap) {
-    const bodyParams = parameters.filter((p) => p.decoratorType === "body");
-    if (bodyParams.length === 0) return null;
-    const bodyParam = bodyParams[0];
-    const typeName = this.extractBaseTypeName(bodyParam.type);
-    let schema;
-    if (typeName && schemaMap[typeName]) {
-      schema = { $ref: `#/components/schemas/${typeName}` };
-    } else {
-      schema = { type: "object" };
-    }
-    return {
-      required: true,
-      content: {
-        "application/json": { schema }
-      }
-    };
-  }
-  buildResponses(returns, schemaMap) {
-    const responseSchema = this.resolveResponseSchema(returns, schemaMap);
-    if (!responseSchema) {
-      return { "200": { description: "Successful response" } };
-    }
-    return {
-      "200": {
-        description: "Successful response",
-        content: {
-          "application/json": { schema: responseSchema }
-        }
-      }
-    };
-  }
-  resolveResponseSchema(returns, schemaMap) {
-    if (!returns) return null;
-    let innerType = returns;
-    const promiseMatch = returns.match(/^Promise<(.+)>$/);
-    if (promiseMatch) {
-      innerType = promiseMatch[1];
-    }
-    const isArray = innerType.endsWith("[]");
-    const baseType = isArray ? innerType.slice(0, -2) : innerType;
-    if (["string", "number", "boolean"].includes(baseType)) {
-      const primitiveSchema = this.tsTypeToJsonSchema(baseType);
-      return isArray ? { type: "array", items: primitiveSchema } : primitiveSchema;
-    }
-    if (["void", "any", "unknown"].includes(baseType)) return null;
-    if (schemaMap[baseType]) {
-      const ref = { $ref: `#/components/schemas/${baseType}` };
-      return isArray ? { type: "array", items: ref } : ref;
-    }
-    return null;
-  }
-  buildSchemaMap(schemas) {
-    const result = {};
-    for (const schemaInfo of schemas) {
-      const definition = schemaInfo.schema?.definitions?.[schemaInfo.type];
-      if (definition) {
-        result[schemaInfo.type] = definition;
-      }
-    }
-    return result;
-  }
-  /**
-   * Converts Express-style `:param` path to OpenAPI `{param}` syntax
-   */
-  toOpenApiPath(expressPath) {
-    return expressPath.replace(/:(\w+)/g, "{$1}");
-  }
-  tsTypeToJsonSchema(tsType) {
-    switch (tsType) {
-      case "number":
-        return { type: "number" };
-      case "boolean":
-        return { type: "boolean" };
-      case "string":
-      default:
-        return { type: "string" };
-    }
-  }
-  /**
-   * Extracts the base type name from a TS type string, stripping
-   * wrappers like `Partial<...>`, `...[]`, `Promise<...>`.
-   */
-  extractBaseTypeName(tsType) {
-    if (!tsType) return null;
-    let type = tsType;
-    const promiseMatch = type.match(/^Promise<(.+)>$/);
-    if (promiseMatch) type = promiseMatch[1];
-    type = type.replace(/\[\]$/, "");
-    const genericMatch = type.match(/^\w+<(\w+)>$/);
-    if (genericMatch) type = genericMatch[1];
-    if (["string", "number", "boolean", "any", "void", "unknown", "object"].includes(type)) {
-      return null;
-    }
-    return type;
-  }
-};
-
 // src/services/route-analyzer.service.ts
 var import_honestjs = require("honestjs");
 var RouteAnalyzerService = class {
@@ -771,7 +590,7 @@ var RouteAnalyzerService = class {
       version: route.version,
       route: route.route,
       path: route.path,
-      fullPath: buildFullPath(route.path, route.parameters),
+      fullPath: buildFullApiPath(route),
       parameters,
       returns
     };
@@ -989,41 +808,31 @@ var RPCPlugin = class {
   tsConfigPath;
   outputDir;
   generateOnInit;
+  contextNamespace;
+  contextArtifactKey;
   // Services
   routeAnalyzer;
   schemaGenerator;
   clientGenerator;
-  openApiGenerator;
-  openApiOptions;
   // Shared ts-morph project
   project = null;
   // Internal state
   analyzedRoutes = [];
   analyzedSchemas = [];
   generatedInfo = null;
+  app = null;
   constructor(options = {}) {
     this.controllerPattern = options.controllerPattern ?? DEFAULT_OPTIONS.controllerPattern;
-    this.tsConfigPath = options.tsConfigPath ?? import_path4.default.resolve(process.cwd(), DEFAULT_OPTIONS.tsConfigPath);
-    this.outputDir = options.outputDir ?? import_path4.default.resolve(process.cwd(), DEFAULT_OPTIONS.outputDir);
+    this.tsConfigPath = options.tsConfigPath ?? import_path3.default.resolve(process.cwd(), DEFAULT_OPTIONS.tsConfigPath);
+    this.outputDir = options.outputDir ?? import_path3.default.resolve(process.cwd(), DEFAULT_OPTIONS.outputDir);
     this.generateOnInit = options.generateOnInit ?? DEFAULT_OPTIONS.generateOnInit;
+    this.contextNamespace = options.context?.namespace ?? DEFAULT_OPTIONS.context.namespace;
+    this.contextArtifactKey = options.context?.keys?.artifact ?? DEFAULT_OPTIONS.context.keys.artifact;
     this.routeAnalyzer = new RouteAnalyzerService();
     this.schemaGenerator = new SchemaGeneratorService(this.controllerPattern, this.tsConfigPath);
     this.clientGenerator = new ClientGeneratorService(this.outputDir);
-    this.openApiOptions = this.resolveOpenApiOptions(options.openapi);
-    this.openApiGenerator = this.openApiOptions ? new OpenApiGeneratorService(this.outputDir) : null;
     this.validateConfiguration();
   }
-  resolveOpenApiOptions(input) {
-    if (!input) return null;
-    const opts = input === true ? {} : input;
-    return {
-      title: opts.title ?? "API",
-      version: opts.version ?? "1.0.0",
-      description: opts.description ?? "",
-      servers: opts.servers ?? [],
-      outputFile: opts.outputFile ?? "openapi.json"
-    };
-  }
   /**
    * Validates the plugin configuration
    */
@@ -1042,6 +851,12 @@ var RPCPlugin = class {
     if (!this.outputDir?.trim()) {
       errors.push("Output directory cannot be empty");
     }
+    if (!this.contextNamespace?.trim()) {
+      errors.push("Context namespace cannot be empty");
+    }
+    if (!this.contextArtifactKey?.trim()) {
+      errors.push("Context artifact key cannot be empty");
+    }
     if (errors.length > 0) {
       throw new Error(`Configuration validation failed: ${errors.join(", ")}`);
     }
@@ -1053,8 +868,10 @@ var RPCPlugin = class {
    * Called after all modules are registered
    */
   afterModulesRegistered = async (app, hono) => {
+    this.app = app;
     if (this.generateOnInit) {
       await this.analyzeEverything();
+      this.publishArtifact(app);
     }
   };
   /**
@@ -1063,9 +880,6 @@ var RPCPlugin = class {
   async analyzeEverything(force = false) {
     try {
       this.log("Starting comprehensive RPC analysis...");
-      this.analyzedRoutes = [];
-      this.analyzedSchemas = [];
-      this.generatedInfo = null;
       this.dispose();
       this.project = new import_ts_morph.Project({ tsConfigFilePath: this.tsConfigPath });
       this.project.addSourceFilesAtPaths([this.controllerPattern]);
@@ -1074,23 +888,22 @@ var RPCPlugin = class {
         const currentHash = computeHash(filePaths);
         const stored = readChecksum(this.outputDir);
         if (stored && stored.hash === currentHash && this.outputFilesExist()) {
-          this.log("Source files unchanged \u2014 skipping regeneration");
-          this.dispose();
-          return;
+          if (this.loadArtifactFromDisk()) {
+            this.log("Source files unchanged \u2014 skipping regeneration");
+            this.dispose();
+            return;
+          }
+          this.log("Source files unchanged but cached artifact missing/invalid \u2014 regenerating");
         }
       }
+      this.analyzedRoutes = [];
+      this.analyzedSchemas = [];
+      this.generatedInfo = null;
       this.analyzedRoutes = await this.routeAnalyzer.analyzeControllerMethods(this.project);
       this.analyzedSchemas = await this.schemaGenerator.generateSchemas(this.project);
       this.generatedInfo = await this.clientGenerator.generateClient(this.analyzedRoutes, this.analyzedSchemas);
-      if (this.openApiGenerator && this.openApiOptions) {
-        const specPath = await this.openApiGenerator.generateSpec(
-          this.analyzedRoutes,
-          this.analyzedSchemas,
-          this.openApiOptions
-        );
-        this.log(`OpenAPI spec generated: ${specPath}`);
-      }
       await writeChecksum(this.outputDir, { hash: computeHash(filePaths), files: filePaths });
+      this.writeArtifactToDisk();
       this.log(
         `\u2705 RPC analysis complete: ${this.analyzedRoutes.length} routes, ${this.analyzedSchemas.length} schemas`
       );
@@ -1106,6 +919,9 @@ var RPCPlugin = class {
    */
   async analyze(force = true) {
     await this.analyzeEverything(force);
+    if (this.app) {
+      this.publishArtifact(this.app);
+    }
   }
   /**
    * Get the analyzed routes
@@ -1129,11 +945,42 @@ var RPCPlugin = class {
    * Checks whether expected output files exist on disk
    */
   outputFilesExist() {
-    if (!import_fs2.default.existsSync(import_path4.default.join(this.outputDir, "client.ts"))) return false;
-    if (this.openApiOptions) {
-      return import_fs2.default.existsSync(import_path4.default.join(this.outputDir, this.openApiOptions.outputFile));
+    return import_fs2.default.existsSync(import_path3.default.join(this.outputDir, "client.ts")) && import_fs2.default.existsSync(import_path3.default.join(this.outputDir, "rpc-artifact.json"));
+  }
+  getArtifactPath() {
+    return import_path3.default.join(this.outputDir, "rpc-artifact.json");
+  }
+  writeArtifactToDisk() {
+    const artifact = {
+      routes: this.analyzedRoutes,
+      schemas: this.analyzedSchemas
+    };
+    import_fs2.default.mkdirSync(this.outputDir, { recursive: true });
+    import_fs2.default.writeFileSync(this.getArtifactPath(), JSON.stringify(artifact));
+  }
+  loadArtifactFromDisk() {
+    try {
+      const raw = import_fs2.default.readFileSync(this.getArtifactPath(), "utf8");
+      const parsed = JSON.parse(raw);
+      if (!Array.isArray(parsed.routes) || !Array.isArray(parsed.schemas)) {
+        return false;
+      }
+      this.analyzedRoutes = parsed.routes;
+      this.analyzedSchemas = parsed.schemas;
+      this.generatedInfo = null;
+      return true;
+    } catch {
+      return false;
     }
-    return true;
+  }
+  publishArtifact(app) {
+    app.getContext().set(this.getArtifactContextKey(), {
+      routes: this.analyzedRoutes,
+      schemas: this.analyzedSchemas
+    });
+  }
+  getArtifactContextKey() {
+    return `${this.contextNamespace}.${this.contextArtifactKey}`;
   }
   /**
    * Cleanup resources to prevent memory leaks
@@ -1168,7 +1015,6 @@ var RPCPlugin = class {
   DEFAULT_OPTIONS,
   GENERIC_TYPES,
   LOG_PREFIX,
-  OpenApiGeneratorService,
   RPCPlugin,
   RouteAnalyzerService,
   SchemaGeneratorService,