keq 2.8.13 → 2.8.14

package/packages/cli/dist/index.d.ts

@@ -1,5 +1,5 @@
-export { defineKeqConfig } from './define-keq-config.js';
-export { RuntimeConfig, Plugin, } from './types/index.js';
+export { defineConfig } from './define-config.js';
+export type { RawConfig as Config, Plugin, } from './types/index.js';
 export { FileNamingStyle, QsArrayFormat, } from './constants/index.js';
 export { Compiler, CompilerContext, TaskWrapper, } from './compiler/index.js';
 export { Artifact, ModuleDefinition, SchemaDefinition, OperationDefinition, ApiDocumentV3_1, Asset, } from './models/index.js';

package/packages/cli/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAA;AAExD,OAAO,EACL,aAAa,EACb,MAAM,GACP,MAAM,kBAAkB,CAAA;AAEzB,OAAO,EACL,eAAe,EACf,aAAa,GACd,MAAM,sBAAsB,CAAA;AAE7B,OAAO,EACL,QAAQ,EACR,eAAe,EACf,WAAW,GACZ,MAAM,qBAAqB,CAAA;AAE5B,OAAO,EACL,QAAQ,EACR,gBAAgB,EAChB,gBAAgB,EAChB,mBAAmB,EACnB,eAAe,EACf,KAAK,GACN,MAAM,mBAAmB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAEjD,YAAY,EACV,SAAS,IAAI,MAAM,EACnB,MAAM,GACP,MAAM,kBAAkB,CAAA;AAEzB,OAAO,EACL,eAAe,EACf,aAAa,GACd,MAAM,sBAAsB,CAAA;AAE7B,OAAO,EACL,QAAQ,EACR,eAAe,EACf,WAAW,GACZ,MAAM,qBAAqB,CAAA;AAE5B,OAAO,EACL,QAAQ,EACR,gBAAgB,EAChB,gBAAgB,EAChB,mBAAmB,EACnB,eAAe,EACf,KAAK,GACN,MAAM,mBAAmB,CAAA"}

package/packages/cli/dist/index.js

@@ -1,11 +1,8 @@
-// src/define-keq-config.ts
-function defineKeqConfig(config) {
+// src/define-config.ts
+function defineConfig(config) {
   return config;
 }
 
-// src/types/runtime-config.ts
-import { Type } from "@sinclair/typebox";
-
 // src/constants/file-naming-style.ts
 var FileNamingStyle = /* @__PURE__ */ ((FileNamingStyle2) => {
   FileNamingStyle2["camelCase"] = "camelCase";
@@ -22,39 +19,6 @@ var FileNamingStyle = /* @__PURE__ */ ((FileNamingStyle2) => {
   return FileNamingStyle2;
 })(FileNamingStyle || {});
 
-// src/types/runtime-config.ts
-var RuntimeConfig = Type.Object({
-  mode: Type.Optional(
-    Type.Union([
-      Type.Literal("micro-function"),
-      Type.Literal("nestjs-module"),
-      Type.Literal("none")
-    ], { default: "micro-function" })
-  ),
-  /**
-   * Whether to generate ES Module code
-   *
-   * If not specified, the module system will be inferred from the nearest package.json "type" field
-   * or defaults to "cjs" if no package.json is found.
-   */
-  esm: Type.Optional(Type.Boolean({ default: false })),
-  /**
-   * Output directory for generated files
-   */
-  outdir: Type.String({ default: `${process.cwd()}/api` }),
-  /**
-   * File naming style for generated files
-   */
-  fileNamingStyle: Type.Enum(FileNamingStyle, { default: "snakeCase" /* snakeCase */ }),
-  modules: Type.Record(Type.String(), Type.String()),
-  debug: Type.Optional(Type.Boolean({ default: false })),
-  /**
-   * Whether to tolerate wrong openapi/swagger structure
-   */
-  tolerant: Type.Optional(Type.Boolean({ default: false })),
-  plugins: Type.Optional(Type.Array(Type.Any(), { default: [] }))
-});
-
 // src/constants/qs-array-format.ts
 var QsArrayFormat = /* @__PURE__ */ ((QsArrayFormat2) => {
   QsArrayFormat2["brackets"] = "brackets";
@@ -84,7 +48,6 @@ import { AsyncParallelHook, AsyncSeriesBailHook, AsyncSeriesHook, SyncHook } fro
 // src/compiler/tasks/setup/index.ts
 import fs3 from "fs-extra";
 import path2 from "path";
-import { Value } from "@sinclair/typebox/value";
 import { cosmiconfig } from "cosmiconfig";
 
 // src/utils/ignore-matcher.ts
@@ -178,35 +141,6 @@ var IgnoreMatcher = class _IgnoreMatcher {
   }
 };
 
-// src/compiler/tasks/setup/utils/validate-modules.ts
-import * as R2 from "ramda";
-import validator from "validator";
-function validateModules(modules) {
-  const keys2 = Object.keys(modules);
-  for (const key of keys2) {
-    if (!/^[A-Za-z_][A-Za-z0-9_$]*$/.test(key)) {
-      throw new Error(`Module name "${key}" is not valid. It must start with a letter or underscore, and can only contain letters, numbers, and underscores.`);
-    }
-  }
-  const keysGroupByLowerCase = R2.groupBy(R2.toLower, keys2);
-  for (const groupKey in keysGroupByLowerCase) {
-    const keys3 = keysGroupByLowerCase[groupKey] || [];
-    if (keys3.length > 1) {
-      throw new Error(`Module names ${keys3.map((name) => `"${name}"`).join(", ")} are case-insensitively duplicated.`);
-    }
-  }
-  for (const key in modules) {
-    const address = modules[key];
-    if (validator.isURL(address, { require_host: true, require_protocol: true, protocols: ["http", "https"] })) {
-      continue;
-    }
-    if (/^(\/|\.\/|\.\.\/)/.test(address)) {
-      continue;
-    }
-    throw new Error(`Module address "${address}" of module "${key}" is not valid. It must be a URL or a local path.`);
-  }
-}
-
 // src/compiler/tasks/setup/utils/find-nearest-package-json.ts
 import fs2 from "fs";
 import path from "path";
@@ -233,6 +167,111 @@ function getProjectModuleSystem(pkgInfo) {
   return "cjs";
 }
 
+// src/compiler/tasks/setup/utils/parse-runtime-config.ts
+import { Value } from "@sinclair/typebox/value";
+
+// src/types/address.ts
+import { Type } from "@sinclair/typebox";
+var Address = Type.Object({
+  url: Type.String(),
+  headers: Type.Optional(Type.Record(Type.String(), Type.String(), { default: {} })),
+  encoding: Type.Optional(
+    Type.Union([
+      Type.Literal("utf8"),
+      Type.Literal("ascii")
+    ], { default: "utf8" })
+  )
+});
+
+// src/types/runtime-config.ts
+import * as R2 from "ramda";
+import { Type as Type2 } from "@sinclair/typebox";
+
+// src/utils/is-valid-url.ts
+var URL_REGEX = /^[a-zA-Z][a-zA-Z0-9+.-]*:\/\/(?:[^\s@]+@)?[^\s/:?#]*(?::\d+)?(?:\/[^\s?#]*)?(?:\?[^\s#]*)?(?:#[^\s]*)?$/;
+function isValidURL(url) {
+  return URL_REGEX.test(url);
+}
+
+// src/types/runtime-config.ts
+var Modules = Type2.Transform(
+  Type2.Record(
+    Type2.String(),
+    Type2.Union([Type2.String(), Address])
+  )
+).Decode((value) => {
+  const keys2 = Object.keys(value);
+  for (const key of keys2) {
+    if (!/^[A-Za-z_][A-Za-z0-9_$]*$/.test(key)) {
+      throw new Error(`Module name "${key}" is not valid. It must start with a letter or underscore, and can only contain letters, numbers, and underscores.`);
+    }
+  }
+  const keysGroupByLowerCase = R2.groupBy(R2.toLower, keys2);
+  for (const groupKey in keysGroupByLowerCase) {
+    const keys3 = keysGroupByLowerCase[groupKey] || [];
+    if (keys3.length > 1) {
+      throw new Error(`Module names ${keys3.map((name) => `"${name}"`).join(", ")} are case-insensitively duplicated.`);
+    }
+  }
+  for (const key in value) {
+    const url = typeof value[key] === "string" ? value[key] : value[key].url;
+    if (isValidURL(url)) continue;
+    throw new Error(`The ${JSON.stringify(url)} of module "${key}" is not a valid URL.`);
+  }
+  return R2.map(
+    (item) => typeof item !== "string" ? item : { url: item, headers: {}, encoding: "utf8" },
+    value
+  );
+}).Encode((value) => value);
+var RawConfig = Type2.Object({
+  mode: Type2.Optional(
+    Type2.Union([
+      Type2.Literal("micro-function"),
+      Type2.Literal("nestjs-module"),
+      Type2.Literal("none")
+    ], { default: "micro-function" })
+  ),
+  /**
+   * Whether to generate ES Module code
+   *
+   * If not specified, the module system will be inferred from the nearest package.json "type" field
+   * or defaults to "cjs" if no package.json is found.
+   */
+  esm: Type2.Optional(Type2.Boolean({ default: false })),
+  /**
+   * Output directory for generated files
+   */
+  outdir: Type2.String({ default: `${process.cwd()}/api` }),
+  /**
+   * File naming style for generated files
+   */
+  fileNamingStyle: Type2.Enum(FileNamingStyle, { default: "snakeCase" /* snakeCase */ }),
+  modules: Modules,
+  debug: Type2.Optional(Type2.Boolean({ default: false })),
+  /**
+   * Whether to tolerate wrong openapi/swagger structure
+   */
+  tolerant: Type2.Optional(Type2.Boolean({ default: false })),
+  plugins: Type2.Optional(Type2.Array(Type2.Unsafe(Type2.Any()), { default: [] }))
+});
+
+// src/compiler/tasks/setup/utils/parse-runtime-config.ts
+function parseRuntimeConfig(data) {
+  try {
+    const originalPlugins = typeof data === "object" && data !== null && "plugins" in data ? data.plugins : void 0;
+    const parsed = Value.Parse(RawConfig, data);
+    if (originalPlugins !== void 0) {
+      parsed.plugins = originalPlugins;
+    }
+    return parsed;
+  } catch (error) {
+    if (error instanceof Error) {
+      error.message = `Invalid Config: ${error.message}`;
+    }
+    throw error;
+  }
+}
+
 // src/compiler/tasks/setup/index.ts
 var explore = cosmiconfig("keq");
 function main(compiler, options) {
@@ -242,13 +281,7 @@ function main(compiler, options) {
       if (!result || "isEmpty" in result && result.isEmpty) {
         throw new Error("Cannot find config file.");
       }
-      if (!Value.Check(RuntimeConfig, result.config)) {
-        const errors = [...Value.Errors(RuntimeConfig, result.config)];
-        const message = errors.map(({ path: path13, message: message2 }) => `${path13}: ${message2}`).join("\n");
-        throw new Error(`Invalid Config: ${message}`);
-      }
-      const rc = Value.Default(RuntimeConfig, result.config);
-      validateModules(rc.modules);
+      const rc = parseRuntimeConfig(result.config);
       if (options?.debug) {
         await fs3.ensureDir(".keq");
         rc.debug = true;
@@ -412,10 +445,14 @@ var ModuleDefinition = class _ModuleDefinition {
   address;
   constructor(name, address) {
     this.name = name;
-    this.address = address;
+    if (typeof address === "string") {
+      this.address = { url: address, headers: {}, encoding: "utf8" };
+    } else {
+      this.address = address;
+    }
   }
   static unknown() {
-    return new _ModuleDefinition("", "");
+    return new _ModuleDefinition("", { url: "", headers: {}, encoding: "utf8" });
   }
 };
 
@@ -888,10 +925,10 @@ function main2(compiler, options) {
               task2.skip(`(${moduleDefinition.name}) is ignored`);
               return;
             }
-            task2.output = `Downloaded from ${moduleDefinition.address}`;
+            task2.output = `Downloaded from ${moduleDefinition.address.url}`;
             const content = await compiler.hooks.download.promise(moduleDefinition.address, moduleDefinition, task2);
             if (!content) {
-              throw new Exception(moduleDefinition, `Cannot download document from ${moduleDefinition.address}`);
+              throw new Exception(moduleDefinition, `Cannot download document from ${moduleDefinition.address.url}`);
             }
             const spec = JSON.parse(content);
             const { valid, errors } = await validate(spec);
@@ -2537,24 +2574,25 @@ var GenerateNestjsModulePlugin = class _GenerateNestjsModulePlugin {
 import { fixSwagger } from "swagger-fix";
 
 // src/plugins/download-http-file/download-http-file.plugin.ts
-import * as validUrl from "valid-url";
 var DownloadHttpFilePlugin = class _DownloadHttpFilePlugin {
   apply(compiler) {
     compiler.hooks.download.tapPromise(_DownloadHttpFilePlugin.name, async (address, task) => {
-      if (!validUrl.isUri(address)) return void 0;
+      const { url } = address;
+      if (!url.startsWith("http://") && !url.startsWith("https://")) return void 0;
       const content = await this.download(address);
       const spec = this.deserialize(content);
       return JSON.stringify(spec);
     });
   }
   async download(address) {
+    const { url, headers } = address;
     try {
-      const res = await fetch(address);
+      const res = await fetch(url, { headers });
       if (res.status >= 400) throw new Error(`failed with status code ${res.status}`);
       return await res.text();
     } catch (e) {
       if (e instanceof Error) {
-        e.message = `Unable get the openapi/swagger file from ${address}: ${e.message}`;
+        e.message = `Unable get the openapi/swagger file from ${url}: ${e.message}`;
       }
       throw e;
     }
@@ -2570,17 +2608,21 @@ var DownloadHttpFilePlugin = class _DownloadHttpFilePlugin {
 import * as path12 from "path";
 import * as fs5 from "fs/promises";
 import * as yaml from "js-yaml";
+import { fileURLToPath } from "url";
 var DownloadLocalFilePlugin = class _DownloadLocalFilePlugin {
   apply(compiler) {
     compiler.hooks.download.tapPromise(_DownloadLocalFilePlugin.name, async (address, task) => {
-      if (!address.startsWith("./") && !address.startsWith("/") && !address.startsWith("../")) return void 0;
-      const fileExt = path12.extname(address);
-      const content = await fs5.readFile(address, "utf8");
+      const { url, encoding } = address;
+      if (!url.startsWith("file://")) return void 0;
+      const filepath = fileURLToPath(url);
+      const fileExt = path12.extname(filepath);
+      const content = await fs5.readFile(filepath, encoding);
+      const str = typeof content === "string" ? content : content.toString(encoding);
       if ([".yml", ".yaml"].includes(fileExt)) {
-        const value = yaml.load(content);
+        const value = yaml.load(str);
         return JSON.stringify(OpenapiUtils.to3_1(value));
       } else if (fileExt === ".json") {
-        return JSON.stringify(OpenapiUtils.to3_1(JSON.parse(content)));
+        return JSON.stringify(OpenapiUtils.to3_1(JSON.parse(str)));
       }
     });
   }
@@ -2618,7 +2660,11 @@ var ShakingPlugin = class _ShakingPlugin {
       sharkedSwagger,
       new ModuleDefinition(
         document.module.name,
-        `file://${document.module.name}.v3_1.sharked.json`
+        {
+          url: `memory://${document.module.name}.v3_1.sharked.json`,
+          headers: {},
+          encoding: "utf8"
+        }
       )
     );
   }
@@ -2801,8 +2847,7 @@ export {
   ModuleDefinition,
   OperationDefinition,
   QsArrayFormat,
-  RuntimeConfig,
   SchemaDefinition,
-  defineKeqConfig
+  defineConfig
 };
 //# sourceMappingURL=index.js.map