api-core-lib 12.0.50 → 12.0.52

package/dist/cli.cjs

@@ -25,124 +25,16 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 
 // src/cli.ts
 var import_commander = require("commander");
-var import_path2 = __toESM(require("path"), 1);
+var import_path3 = __toESM(require("path"), 1);
 
 // src/generator/index.ts
-var import_fs = __toESM(require("fs"), 1);
-var import_path = __toESM(require("path"), 1);
+var import_path2 = __toESM(require("path"), 1);
 var import_axios = __toESM(require("axios"), 1);
 var import_chalk = __toESM(require("chalk"), 1);
 var import_dotenv = __toESM(require("dotenv"), 1);
-var import_json_schema_to_typescript = require("json-schema-to-typescript");
-async function runGenerator(options) {
-  console.log(import_chalk.default.cyan.bold("\u{1F680} Starting API Core Lib Code Generator..."));
-  console.log(import_chalk.default.gray(`Output directory: ${options.output}`));
-  console.log(import_chalk.default.gray(`.env path: ${options.envPath}`));
-  console.log("\n" + import_chalk.default.blue("Step 1: Loading environment variables..."));
-  import_dotenv.default.config({ path: options.envPath });
-  const specUrl = process.env.OPENAPI_SPEC_URL || (process.env.API_URL ? `${process.env.API_URL}/docs-json` : null) || (process.env.NEXT_PUBLIC_API_URL ? `${process.env.NEXT_PUBLIC_API_URL}/docs-json` : null);
-  if (!specUrl) {
-    console.error(import_chalk.default.red.bold("\n\u274C Error: API specification URL not found."));
-    console.error(import_chalk.default.red("Please define either OPENAPI_SPEC_URL or API_URL/NEXT_PUBLIC_API_URL in your .env file."));
-    process.exit(1);
-  }
-  console.log(import_chalk.default.green("\u2713 Environment variables loaded."));
-  let tempSpecPath = "";
-  try {
-    console.log("\n" + import_chalk.default.blue(`Step 2: Fetching OpenAPI spec from ${specUrl}...`));
-    const response = await import_axios.default.get(specUrl, { timeout: 15e3 });
-    const spec = response.data;
-    if (!spec.openapi || !spec.paths || !spec.components?.schemas) {
-      throw new Error('Invalid OpenAPI specification file. "openapi", "paths", or "components.schemas" property is missing.');
-    }
-    console.log(import_chalk.default.green(`\u2713 OpenAPI spec fetched successfully.`));
-    console.log("\n" + import_chalk.default.blue("Step 3: Parsing spec and generating API modules..."));
-    const modules = parseSpecToModules(spec);
-    const modulesOutputPath = import_path.default.join(options.output, "modules");
-    if (!import_fs.default.existsSync(modulesOutputPath)) {
-      import_fs.default.mkdirSync(modulesOutputPath, { recursive: true });
-    }
-    for (const moduleName in modules) {
-      const moduleData = modules[moduleName];
-      const moduleFolderPath = import_path.default.join(modulesOutputPath, moduleName);
-      if (!import_fs.default.existsSync(moduleFolderPath)) {
-        import_fs.default.mkdirSync(moduleFolderPath, { recursive: true });
-      }
-      const typesFilePath = import_path.default.join(moduleFolderPath, "types.ts");
-      let typesContent = `// This file is auto-generated by the API generator. Do not edit.
-
-`;
-      const allModuleTypes = getAllReferencedTypes(moduleData.types, spec.components.schemas);
-      for (const typeName of allModuleTypes) {
-        const schema = spec.components.schemas[typeName];
-        if (schema) {
-          const tsType = await (0, import_json_schema_to_typescript.compile)(spec, typeName, {
-            bannerComment: "",
-            additionalProperties: false,
-            style: {
-              bracketSpacing: true,
-              printWidth: 120,
-              semi: true,
-              singleQuote: true,
-              tabWidth: 2,
-              trailingComma: "es5",
-              useTabs: false
-            }
-          });
-          typesContent += tsType + "\n";
-        }
-      }
-      import_fs.default.writeFileSync(typesFilePath, typesContent);
-      const allTypeNames = [...allModuleTypes];
-      const actionsTypeParts = Object.entries(moduleData.actions).map(
-        ([actionName, actionData]) => `  ${actionName}: ActionConfigModule<${actionData._inputType}, ${actionData._outputType}>;`
-      );
-      const actionsTypeDefinition = `{
-${actionsTypeParts.join("\n")}
-}`;
-      const actionsValueParts = Object.entries(moduleData.actions).map(
-        ([actionName, actionData]) => {
-          const { _inputType, _outputType, ...config } = actionData;
-          return `    ${actionName}: ${JSON.stringify(config, null, 2).replace(/\n/g, "\n    ")}`;
-        }
-      );
-      const actionsValueDefinition = `{
-${actionsValueParts.join(",\n")}
-  }`;
-      const configFilePath = import_path.default.join(moduleFolderPath, "config.ts");
-      const typesImportStatement = allTypeNames.length > 0 ? `import type { ${allTypeNames.join(", ")} } from './types';` : `// No custom types used in this module.`;
-      const configContent = `
-import type { ApiModuleConfig, ActionConfigModule, QueryOptions } from 'api-core-lib';
-${typesImportStatement}
+var import_json_schema_ref_parser = __toESM(require("@apidevtools/json-schema-ref-parser"), 1);
 
-export const ${moduleName}Module: ApiModuleConfig<${actionsTypeDefinition}> = {
-  baseEndpoint: '${moduleData.baseEndpoint}',
-  actions: ${actionsValueDefinition},
-};
-`;
-      import_fs.default.writeFileSync(configFilePath, configContent);
-      console.log(import_chalk.default.green(`\u2713 Module generated: ${moduleName}/ (config.ts, types.ts)`));
-    }
-    console.log(import_chalk.default.green("\u2713 All custom modules generated."));
-    console.log(import_chalk.default.bold.green("\n\u{1F389} API generation complete! All files are located in:"));
-    console.log(import_chalk.default.bold.cyan(options.output));
-  } catch (error) {
-    console.error(import_chalk.default.red.bold("\n\u274C An error occurred during generation:"));
-    if (error.response) {
-      console.error(import_chalk.default.red(`Network Error: ${error.message} (Status: ${error.response.status})`));
-    } else if (error.stderr) {
-      console.error(import_chalk.default.red(`Command Execution Error: ${error.message}`));
-      console.error(import_chalk.default.gray(error.stderr.toString()));
-    } else {
-      console.error(import_chalk.default.red(error.message));
-    }
-    process.exit(1);
-  } finally {
-    if (tempSpecPath && import_fs.default.existsSync(tempSpecPath)) {
-      console.log(import_chalk.default.gray("\nTemporary spec file cleaned up."));
-    }
-  }
-}
+// src/generator/spec-parser.ts
 function parseSpecToModules(spec) {
   const modules = {};
   for (const apiPath in spec.paths) {
@@ -150,34 +42,14 @@ function parseSpecToModules(spec) {
       const endpoint = spec.paths[apiPath][method];
       if (!endpoint.tags || endpoint.tags.length === 0) continue;
       const tagName = endpoint.tags[0];
-      const moduleName = tagName.replace(/[^a-zA-Z0-9]/g, "").replace(/Central|Tenant/g, "") + "Api";
+      const moduleName = sanitizeTagName(tagName) + "Api";
       if (!modules[moduleName]) {
         const commonPath = apiPath.substring(0, apiPath.lastIndexOf("/"));
         modules[moduleName] = { baseEndpoint: commonPath || "/", actions: {}, types: /* @__PURE__ */ new Set() };
       }
-      const requestBody = endpoint.requestBody?.content?.["application/json"]?.schema;
-      const successResponse = endpoint.responses["200"] || endpoint.responses["201"];
-      const responseSchema = successResponse?.content?.["application/json"]?.schema;
-      let outputType = "unknown";
-      if (responseSchema) {
-        if (responseSchema.$ref) {
-          outputType = refToTypeName(responseSchema.$ref);
-        } else if (responseSchema.type === "array" && responseSchema.items?.$ref) {
-          outputType = `${refToTypeName(responseSchema.items.$ref)}[]`;
-        }
-      }
-      let inputType = "undefined";
-      if (requestBody) {
-        if (requestBody.$ref) {
-          inputType = refToTypeName(requestBody.$ref);
-        } else if (requestBody.type === "object") {
-          inputType = "any";
-        }
-      } else if ((endpoint.parameters || []).some((p) => p.in === "query")) {
-        inputType = "QueryOptions";
-      }
+      const { inputType, outputType } = getInputOutputTypes(endpoint);
       [inputType, outputType].forEach((t) => {
-        if (t && t !== "unknown" && t !== "undefined" && t !== "any" && t !== "QueryOptions") {
+        if (t && !["unknown", "undefined", "any", "QueryOptions"].includes(t)) {
           modules[moduleName].types.add(t.replace("[]", ""));
         }
       });
@@ -197,23 +69,36 @@ function parseSpecToModules(spec) {
   }
   return modules;
 }
-function getAllReferencedTypes(initialTypes, allSchemas) {
-  const finalTypes = new Set(initialTypes);
-  const queue = [...initialTypes];
-  while (queue.length > 0) {
-    const typeName = queue.shift();
-    if (!typeName) continue;
-    const schemaString = JSON.stringify(allSchemas[typeName] || {});
-    const references = schemaString.match(/"\$ref":\s*"#\/components\/schemas\/([^"]+)"/g) || [];
-    for (const ref of references) {
-      const referencedTypeName = ref.split("/").pop()?.replace(/"/g, "") || "";
-      if (referencedTypeName && !finalTypes.has(referencedTypeName)) {
-        finalTypes.add(referencedTypeName);
-        queue.push(referencedTypeName);
-      }
+function getInputOutputTypes(endpoint) {
+  const requestBody = endpoint.requestBody?.content?.["application/json"]?.schema;
+  const successResponse = endpoint.responses["200"] || endpoint.responses["201"];
+  const responseSchema = successResponse?.content?.["application/json"]?.schema;
+  let outputType = "unknown";
+  if (responseSchema) {
+    if (responseSchema.title) {
+      outputType = responseSchema.title.replace(/\[\]/g, "") + (responseSchema.type === "array" ? "[]" : "");
+    } else if (responseSchema.$ref) {
+      outputType = refToTypeName(responseSchema.$ref);
+    } else if (responseSchema.type === "array" && (responseSchema.items?.title || responseSchema.items?.$ref)) {
+      outputType = (responseSchema.items.title || refToTypeName(responseSchema.items.$ref)) + "[]";
+    }
+  }
+  let inputType = "undefined";
+  if (requestBody) {
+    if (requestBody.title) {
+      inputType = requestBody.title;
+    } else if (requestBody.$ref) {
+      inputType = refToTypeName(requestBody.$ref);
+    } else if (requestBody.type === "object") {
+      inputType = "any";
     }
+  } else if ((endpoint.parameters || []).some((p) => p.in === "query")) {
+    inputType = "QueryOptions";
   }
-  return finalTypes;
+  return { inputType, outputType };
+}
+function sanitizeTagName(tagName) {
+  return tagName.replace(/[^a-zA-Z0-9]/g, "").replace(/Central|Tenant/g, "");
 }
 function sanitizeActionName(operationId) {
   if (!operationId) return `unnamedAction_${Date.now()}`;
@@ -225,10 +110,139 @@ function refToTypeName(ref) {
   return ref.split("/").pop() || "unknown";
 }
 
+// src/generator/file-generator.ts
+var import_fs = __toESM(require("fs"), 1);
+var import_path = __toESM(require("path"), 1);
+var import_json_schema_to_typescript = require("json-schema-to-typescript");
+async function generateModuleFiles(moduleName, moduleData, spec, outputDir) {
+  const moduleFolderPath = import_path.default.join(outputDir, moduleName);
+  if (!import_fs.default.existsSync(moduleFolderPath)) {
+    import_fs.default.mkdirSync(moduleFolderPath, { recursive: true });
+  }
+  await generateTypesFile(moduleFolderPath, moduleData.types, spec);
+  await generateConfigFile(moduleFolderPath, moduleName, moduleData, moduleData.types);
+}
+async function generateTypesFile(moduleFolderPath, typeNames, spec) {
+  let typesContent = `// This file is auto-generated by the API generator. Do not edit.
+
+`;
+  const allSchemas = spec.components?.schemas || {};
+  for (const typeName of typeNames) {
+    const schema = allSchemas[typeName];
+    if (schema) {
+      const tsType = await (0, import_json_schema_to_typescript.compile)(schema, typeName, {
+        bannerComment: "",
+        additionalProperties: false,
+        style: {
+          bracketSpacing: true,
+          printWidth: 120,
+          semi: true,
+          singleQuote: true,
+          tabWidth: 2,
+          trailingComma: "es5",
+          useTabs: false
+        }
+      });
+      typesContent += tsType + "\n";
+    }
+  }
+  const typesFilePath = import_path.default.join(moduleFolderPath, "types.ts");
+  import_fs.default.writeFileSync(typesFilePath, typesContent);
+}
+async function generateConfigFile(moduleFolderPath, moduleName, moduleData, typeNames) {
+  const typeNamesArray = [...typeNames];
+  const typesImportStatement = typeNamesArray.length > 0 ? `import type { ${typeNamesArray.join(", ")} } from './types';` : ``;
+  const actionsTypeParts = Object.entries(moduleData.actions).map(
+    ([actionName, actionData]) => `  ${actionName}: ActionConfigModule<${actionData._inputType}, ${actionData._outputType}>;`
+  );
+  const actionsTypeDefinition = `{
+${actionsTypeParts.join("\n")}
+}`;
+  const actionsValueParts = Object.entries(moduleData.actions).map(
+    ([actionName, actionData]) => {
+      const { _inputType, _outputType, ...config } = actionData;
+      return `    ${actionName}: ${JSON.stringify(config, null, 2).replace(/\n/g, "\n    ")}`;
+    }
+  );
+  const actionsValueDefinition = `{
+${actionsValueParts.join(",\n")}
+  }`;
+  const configContent = `
+import type { ApiModuleConfig, ActionConfigModule, QueryOptions } from 'api-core-lib';
+${typesImportStatement}
+
+export const ${moduleName}Module: ApiModuleConfig<${actionsTypeDefinition}> = {
+  baseEndpoint: '${moduleData.baseEndpoint}',
+  actions: ${actionsValueDefinition},
+};
+`;
+  const configFilePath = import_path.default.join(moduleFolderPath, "config.ts");
+  import_fs.default.writeFileSync(configFilePath, configContent);
+}
+
+// src/generator/index.ts
+async function runGenerator(options) {
+  console.log(import_chalk.default.cyan.bold("\u{1F680} Starting API Core Lib Code Generator..."));
+  console.log(import_chalk.default.gray(`Output directory: ${options.output}`));
+  console.log(import_chalk.default.gray(`.env path: ${options.envPath}`));
+  console.log("\n" + import_chalk.default.blue("Step 1: Loading environment variables..."));
+  import_dotenv.default.config({ path: options.envPath });
+  const specUrl = getSpecUrl();
+  console.log(import_chalk.default.green("\u2713 Environment variables loaded."));
+  try {
+    console.log("\n" + import_chalk.default.blue(`Step 2: Fetching OpenAPI spec from ${specUrl}...`));
+    const response = await import_axios.default.get(specUrl, { timeout: 15e3 });
+    let spec = response.data;
+    if (!spec.openapi || !spec.paths) {
+      throw new Error('Invalid OpenAPI specification file. "openapi" or "paths" property is missing.');
+    }
+    console.log(import_chalk.default.green("\u2713 OpenAPI spec fetched successfully."));
+    console.log(import_chalk.default.blue("Step 2.5: Dereferencing all $refs in the spec..."));
+    spec = await import_json_schema_ref_parser.default.dereference(spec);
+    console.log(import_chalk.default.green("\u2713 Spec dereferenced successfully."));
+    console.log("\n" + import_chalk.default.blue("Step 3: Parsing spec and generating API modules..."));
+    const modules = parseSpecToModules(spec);
+    const modulesOutputPath = import_path2.default.join(options.output, "modules");
+    for (const moduleName in modules) {
+      const moduleData = modules[moduleName];
+      await generateModuleFiles(moduleName, moduleData, spec, modulesOutputPath);
+      console.log(import_chalk.default.green(`\u2713 Module generated: ${moduleName}/ (config.ts, types.ts)`));
+    }
+    console.log(import_chalk.default.green("\u2713 All custom modules generated."));
+    console.log(import_chalk.default.bold.green("\n\u{1F389} API generation complete! All files are located in:"));
+    console.log(import_chalk.default.bold.cyan(options.output));
+  } catch (error) {
+    handleGenerationError(error);
+  }
+}
+function getSpecUrl() {
+  const specUrl = process.env.OPENAPI_SPEC_URL || (process.env.API_URL ? `${process.env.API_URL}/docs-json` : null) || (process.env.NEXT_PUBLIC_API_URL ? `${process.env.NEXT_PUBLIC_API_URL}/docs-json` : null);
+  if (!specUrl) {
+    console.error(import_chalk.default.red.bold("\n\u274C Error: API specification URL not found."));
+    console.error(import_chalk.default.red("Please define either OPENAPI_SPEC_URL or API_URL/NEXT_PUBLIC_API_URL in your .env file."));
+    process.exit(1);
+  }
+  return specUrl;
+}
+function handleGenerationError(error) {
+  console.error(import_chalk.default.red.bold("\n\u274C An error occurred during generation:"));
+  if (error.message.includes("$ref")) {
+    console.error(import_chalk.default.red(error.message));
+  } else if (error.response) {
+    console.error(import_chalk.default.red(`Network Error: ${error.message} (Status: ${error.response.status})`));
+  } else if (error.stderr) {
+    console.error(import_chalk.default.red(`Command Execution Error: ${error.message}`));
+    console.error(import_chalk.default.gray(error.stderr.toString()));
+  } else {
+    console.error(import_chalk.default.red(error.message));
+  }
+  process.exit(1);
+}
+
 // src/cli.ts
 console.log("API Core Lib - Code Generator");
-import_commander.program.option("-o, --output <path>", "Output directory for generated files", "src/lib/api-generated").option("--env-path <path>", ".env file path", import_path2.default.resolve(process.cwd(), ".env")).action((options) => {
-  const absoluteOutputPath = import_path2.default.resolve(process.cwd(), options.output);
+import_commander.program.option("-o, --output <path>", "Output directory for generated files", "src/lib/api-generated").option("--env-path <path>", ".env file path", import_path3.default.resolve(process.cwd(), ".env")).action((options) => {
+  const absoluteOutputPath = import_path3.default.resolve(process.cwd(), options.output);
   runGenerator({ ...options, output: absoluteOutputPath });
 });
 import_commander.program.parse(process.argv);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "api-core-lib",
-  "version": "12.0.50",
+  "version": "12.0.52",
   "description": "A flexible and powerful API client library for modern web applications.",
   "type": "module",
   "exports": {
@@ -35,6 +35,7 @@
     "react-dom": ">=19.0.0"
   },
   "dependencies": {
+    "@apidevtools/json-schema-ref-parser": "^14.2.0",
     "axios": "^1.6.8",
     "axios-retry": "^4.1.0",
     "chalk": "^4.1.2",