@keq-request/cli 5.0.0-alpha.23 → 5.0.0-alpha.24

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 ## 5.0.0-alpha.6 (2025-09-17)
 
+## 5.0.0-alpha.24
+
+### Major Changes
+
+- 2ead9d0: **BREAKING CHANGE:** operationIdFactory is removed, please use OverwriteOperationIdPlugin instead.
+
+### Minor Changes
+
+- 0a2eb2f: **Feat:** server-sent event support.
+
+### Patch Changes
+
+- Updated dependencies [0a2eb2f]
+  - keq@5.0.0-alpha.24
+
 ## 5.0.0-alpha.23
 
 ### Minor Changes

package/dist/cli.cjs

@@ -147,29 +147,8 @@ var IgnoreMatcher = class _IgnoreMatcher {
   }
 };
 
-// src/types/qs.ts
-var import_typebox = require("@sinclair/typebox");
-
-// src/constants/qs-array-format.ts
-var QsArrayFormat = /* @__PURE__ */ ((QsArrayFormat2) => {
-  QsArrayFormat2["brackets"] = "brackets";
-  QsArrayFormat2["indices"] = "indices";
-  QsArrayFormat2["repeat"] = "repeat";
-  QsArrayFormat2["comma"] = "comma";
-  QsArrayFormat2["space"] = "space";
-  QsArrayFormat2["pipe"] = "pipe";
-  return QsArrayFormat2;
-})(QsArrayFormat || {});
-
-// src/types/qs.ts
-var Qs = import_typebox.Type.Object({
-  indices: import_typebox.Type.Optional(import_typebox.Type.Boolean()),
-  arrayFormat: import_typebox.Type.Optional(import_typebox.Type.Enum(QsArrayFormat)),
-  allowDots: import_typebox.Type.Optional(import_typebox.Type.Boolean())
-});
-
 // src/types/runtime-config.ts
-var import_typebox2 = require("@sinclair/typebox");
+var import_typebox = require("@sinclair/typebox");
 
 // src/constants/file-naming-style.ts
 var FileNamingStyle = /* @__PURE__ */ ((FileNamingStyle2) => {
@@ -188,12 +167,12 @@ var FileNamingStyle = /* @__PURE__ */ ((FileNamingStyle2) => {
 })(FileNamingStyle || {});
 
 // src/types/runtime-config.ts
-var RuntimeConfig = import_typebox2.Type.Object({
-  mode: import_typebox2.Type.Optional(
-    import_typebox2.Type.Union([
-      import_typebox2.Type.Literal("micro-function"),
-      import_typebox2.Type.Literal("nestjs-module"),
-      import_typebox2.Type.Literal("none")
+var RuntimeConfig = import_typebox.Type.Object({
+  mode: import_typebox.Type.Optional(
+    import_typebox.Type.Union([
+      import_typebox.Type.Literal("micro-function"),
+      import_typebox.Type.Literal("nestjs-module"),
+      import_typebox.Type.Literal("none")
     ], { default: "micro-function" })
   ),
   /**
@@ -202,27 +181,22 @@ var RuntimeConfig = import_typebox2.Type.Object({
    * 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: import_typebox2.Type.Optional(import_typebox2.Type.Boolean({ default: false })),
+  esm: import_typebox.Type.Optional(import_typebox.Type.Boolean({ default: false })),
   /**
    * Output directory for generated files
    */
-  outdir: import_typebox2.Type.String({ default: `${process.cwd()}/api` }),
+  outdir: import_typebox.Type.String({ default: `${process.cwd()}/api` }),
   /**
    * File naming style for generated files
    */
-  fileNamingStyle: import_typebox2.Type.Enum(FileNamingStyle, { default: "snakeCase" /* snakeCase */ }),
-  modules: import_typebox2.Type.Record(import_typebox2.Type.String(), import_typebox2.Type.String()),
-  operationIdFactory: import_typebox2.Type.Optional(import_typebox2.Type.Function([import_typebox2.Type.Any()], import_typebox2.Type.String())),
-  qs: import_typebox2.Type.Optional(import_typebox2.Type.Union([
-    Qs,
-    import_typebox2.Type.Function([import_typebox2.Type.Any()], Qs)
-  ])),
-  debug: import_typebox2.Type.Optional(import_typebox2.Type.Boolean({ default: false })),
+  fileNamingStyle: import_typebox.Type.Enum(FileNamingStyle, { default: "snakeCase" /* snakeCase */ }),
+  modules: import_typebox.Type.Record(import_typebox.Type.String(), import_typebox.Type.String()),
+  debug: import_typebox.Type.Optional(import_typebox.Type.Boolean({ default: false })),
   /**
    * Whether to tolerate wrong openapi/swagger structure
    */
-  tolerant: import_typebox2.Type.Optional(import_typebox2.Type.Boolean({ default: false })),
-  plugins: import_typebox2.Type.Optional(import_typebox2.Type.Array(import_typebox2.Type.Any(), { default: [] }))
+  tolerant: import_typebox.Type.Optional(import_typebox.Type.Boolean({ default: false })),
+  plugins: import_typebox.Type.Optional(import_typebox.Type.Array(import_typebox.Type.Any(), { default: [] }))
 });
 
 // src/compiler/tasks/setup/utils/validate-modules.ts
@@ -300,20 +274,13 @@ function main(compiler, options) {
         await import_fs_extra2.default.ensureDir(".keq");
         rc.debug = true;
       }
-      if (options?.tolerant) {
-        rc.tolerant = true;
-      }
+      rc.tolerant = Boolean(rc.tolerant);
       const packageJsonInfo = findNearestPackageJson();
       if (packageJsonInfo) {
         const moduleSystem = getProjectModuleSystem(packageJsonInfo);
         rc.esm = moduleSystem === "esm";
       }
       context.rc = rc;
-      if (rc.plugins && rc.plugins.length) {
-        for (const plugin of rc.plugins) {
-          plugin.apply(compiler);
-        }
-      }
       let matcher = new IgnoreMatcher([]);
       if (result.filepath) {
         const ignoreFilepath = import_path.default.resolve(import_path.default.dirname(result.filepath), ".keqignore");
@@ -362,12 +329,6 @@ var import_openapi_parser2 = require("@scalar/openapi-parser");
 // src/models/artifact.ts
 var path3 = __toESM(require("path"), 1);
 
-// src/models/utils/to-comment.ts
-function toComment(msg) {
-  if (!msg) return "";
-  return msg.split("\n").map((str) => `// ${str}`).join("\n");
-}
-
 // src/models/anchor.ts
 var AnchorBlock = class {
   constructor(artifact) {
@@ -446,7 +407,6 @@ var HeaderComment = [
 var Artifact = class {
   id;
   filepath;
-  warns = [];
   content;
   extensionName;
   anchor = new Anchor(this);
@@ -459,20 +419,8 @@ var Artifact = class {
   get dirname() {
     return path3.dirname(this.filepath);
   }
-  addWarn(message) {
-    this.warns.push(message);
-  }
   renderer() {
-    let $warns = "";
-    if (this.warns.length) {
-      $warns = toComment([
-        "!!! Here is some Problems !!!",
-        "",
-        this.warns
-      ].join("\n"));
-      $warns += "\n\n";
-    }
-    return `${HeaderComment}${$warns}${this.content}`;
+    return `${HeaderComment}${this.content}`;
   }
 };
 
@@ -663,7 +611,6 @@ var OperationDefinition = class {
 };
 
 // src/models/api-document_v3_1.ts
-var import_openapi_shaking = require("@opendoc/openapi-shaking");
 var ApiDocumentV3_1 = class _ApiDocumentV3_1 {
   module;
   specification;
@@ -706,31 +653,6 @@ var ApiDocumentV3_1 = class _ApiDocumentV3_1 {
     }
     return false;
   }
-  sharking(filter2) {
-    const isAccepted = (pathname, method, operation) => {
-      if (!SupportedMethods.includes(method)) return false;
-      const operationDefinition = new OperationDefinition({
-        method,
-        pathname,
-        operation,
-        module: this.module,
-        document: this
-      });
-      return filter2(operationDefinition);
-    };
-    const sharkedSwagger = (0, import_openapi_shaking.openapiShakingSync)(
-      this.specification,
-      isAccepted,
-      { tolerant: true }
-    );
-    return new _ApiDocumentV3_1(
-      sharkedSwagger,
-      new ModuleDefinition(
-        this.module.name,
-        `file://${this.module.name}.v3_1.sharked.json`
-      )
-    );
-  }
   static unknown() {
     return new _ApiDocumentV3_1({}, ModuleDefinition.unknown());
   }
@@ -868,25 +790,6 @@ function dereferenceOperation(swagger) {
   return removeUndefinedRef(shadow);
 }
 
-// src/utils/openapi-utils/update-operation-id.ts
-var R9 = __toESM(require("ramda"), 1);
-function updateOperationId(swagger, fn) {
-  const shadow = R9.clone(swagger);
-  for (const [pathname, pathItem] of Object.entries(shadow.paths || {})) {
-    for (const m in pathItem) {
-      const method = m.toLowerCase();
-      if (!SupportedMethods.includes(method)) continue;
-      if (typeof pathItem[m] !== "object" || Array.isArray(pathItem[m]) || pathItem[m] === null) continue;
-      const operation = pathItem[m];
-      const operationId = fn(method, pathname, operation);
-      if (typeof operationId === "string" && operationId.length > 0) {
-        operation.operationId = operationId;
-      }
-    }
-  }
-  return shadow;
-}
-
 // src/utils/json-schema-utils/is-array.ts
 function isArray(schema) {
   return schema.type === "array";
@@ -942,6 +845,31 @@ function To3_1(openapi) {
   return specification;
 }
 
+// src/utils/openapi-utils/map-operation.ts
+var R9 = __toESM(require("ramda"), 1);
+function mapOperation(specification, mapper) {
+  const shadow = R9.clone(specification);
+  for (const [pathname, pathItem] of Object.entries(shadow.paths || {})) {
+    for (const m in pathItem) {
+      const method = m.toLowerCase();
+      if (!SupportedMethods.includes(method)) continue;
+      if (typeof pathItem[m] !== "object" || Array.isArray(pathItem[m]) || pathItem[m] === null) continue;
+      const operation = pathItem[m];
+      pathItem[m] = mapper(method, pathname, operation);
+    }
+  }
+  return shadow;
+}
+
+// src/utils/openapi-utils/map-parameter.ts
+function mapParameter(specification, mapper) {
+  return mapOperation(specification, (method, pathname, operation) => {
+    if (!operation.parameters) return operation;
+    operation.parameters = operation.parameters.map((parameter) => mapper(method, pathname, operation, parameter));
+    return operation;
+  });
+}
+
 // src/utils/openapi-utils/index.ts
 var OpenapiUtils = class {
   static isRefDefined = isRefDefined;
@@ -949,7 +877,9 @@ var OpenapiUtils = class {
   static dereferenceDeep = dereferenceDeep;
   static removeUndefinedRef = removeUndefinedRef;
   static dereferenceOperation = dereferenceOperation;
-  static updateOperationId = updateOperationId;
+  static mapOperation = mapOperation;
+  static mapParameter = mapParameter;
+  // static updateOperationId = updateOperationId
   static to3_1 = To3_1;
 };
 
@@ -976,7 +906,7 @@ function main2(compiler, options) {
             if (!content) {
               throw new Exception(moduleDefinition, `Cannot download document from ${moduleDefinition.address}`);
             }
-            let spec = JSON.parse(content);
+            const spec = JSON.parse(content);
             const { valid, errors } = await (0, import_openapi_parser2.validate)(spec);
             if (!valid) {
               const message = `${moduleDefinition.name} module openapi/swagger file does not conform to the openapi specifications or have grammatical errors, which may cause unexpected errors: 
@@ -984,14 +914,6 @@ ${errors?.map((e) => `  - ${e.message}`).join("\n")}`;
               task2.output = message;
             }
             OpenapiUtils.dereferenceOperation(spec);
-            const rc2 = context.rc;
-            if (rc2?.operationIdFactory) {
-              const operationIdFactory = rc2.operationIdFactory;
-              spec = OpenapiUtils.updateOperationId(
-                spec,
-                (method, pathname, operation) => operationIdFactory({ method, pathname, operation, module: moduleDefinition })
-              );
-            }
             const document = new ApiDocumentV3_1(
               spec,
               moduleDefinition
@@ -1235,7 +1157,7 @@ function perfectErrorMessage() {
 // src/plugins/eslint/index.ts
 var import_eslint = require("eslint");
 
-// src/plugins/prettier/index.ts
+// src/plugins/prettier/prettier.plugin.ts
 var import_child_process = require("child_process");
 var import_util = require("util");
 var execAsync = (0, import_util.promisify)(import_child_process.exec);
@@ -1517,7 +1439,12 @@ var DeclarationRenderer2 = class {
     }
     const $responses = Object.entries(operation.responses).map(([statusCode, response]) => {
       if (!JsonSchemaUtils.isRef(response)) {
-        const $value = Object.values(response.content || {}).map((mediaTypeObject) => mediaTypeObject.schema).filter((schema) => !!schema).map((schema) => JsonSchemaTransformer.toDeclaration(schema, options)).join(" | ");
+        const $value = Object.entries(response.content || {}).map(([mediaType, mediaTypeObject]) => [mediaType, mediaTypeObject.schema]).map(([mediaType, schema]) => {
+          if (mediaType.includes("text/event-stream")) return "ReadableStream<ServerSentEvent>";
+          if (mediaType.includes("multipart/form-data")) return "FormData";
+          if (!schema) return "unknown";
+          return JsonSchemaTransformer.toDeclaration(schema, options);
+        }).join(" | ");
         return indent(2, `${statusCode}: ${$value || "void"}`);
       }
     }).join("\n");
@@ -1599,7 +1526,7 @@ var DeclarationRenderer2 = class {
       return `import type { ${schemaName} as ${alias(schemaName)} } from "${filepath}"`;
     }).map((str) => str.replace(/ from "(\.\.?\/.+?)(\.ts|\.mts|\.cts|\.js|\.cjs|\.mjs)?"/, this.options.esm ? ' from "$1.js"' : ' from "$1"'));
     return [
-      'import type { KeqOperation, KeqPathParameterInit, KeqQueryInit } from "keq"',
+      'import type { KeqOperation, KeqPathParameterInit, KeqQueryInit, ServerSentEvent } from "keq"',
       ...$schemaDefinitions
     ].join("\n");
   }
@@ -1665,8 +1592,21 @@ var DeclarationRenderer2 = class {
 // src/transformers/operation-definition/micro-function.renderer.ts
 var R17 = __toESM(require("ramda"), 1);
 
-// src/transformers/operation-definition/typescript-helper.ts
+// src/transformers/operation-definition/typescript-snippet.ts
 var R16 = __toESM(require("ramda"), 1);
+
+// src/constants/qs-array-format.ts
+var QsArrayFormat = /* @__PURE__ */ ((QsArrayFormat2) => {
+  QsArrayFormat2["brackets"] = "brackets";
+  QsArrayFormat2["indices"] = "indices";
+  QsArrayFormat2["repeat"] = "repeat";
+  QsArrayFormat2["comma"] = "comma";
+  QsArrayFormat2["space"] = "space";
+  QsArrayFormat2["pipe"] = "pipe";
+  return QsArrayFormat2;
+})(QsArrayFormat || {});
+
+// src/transformers/operation-definition/typescript-snippet.ts
 var OperationDefinitionSnippet = class {
   constructor(operationDefinition, options) {
     this.operationDefinition = operationDefinition;
@@ -1675,27 +1615,42 @@ var OperationDefinitionSnippet = class {
   }
   typeName;
   getQsParameters(parameter) {
-    if (typeof this.options.qs === "function") {
-      return this.options.qs(parameter);
-    } else if (typeof this.options.qs === "object") {
-      return this.options.qs;
-    }
+    let arrayFormat;
+    let allowDots;
+    let indices;
     const style = parameter.style || "form";
     const explode = parameter.explode ?? true;
-    if (style === "deepObject") {
-      return { arrayFormat: "brackets" };
-    } else if (explode) {
-      return { arrayFormat: "repeat" };
+    if ("x-qs-array-format" in parameter) {
+      arrayFormat = parameter["x-qs-array-format"];
     } else {
-      if (style === "form") {
-        return { arrayFormat: "comma" };
-      } else if (style === "spaceDelimited") {
-        return { arrayFormat: "space" };
-      } else if (style === "pipeDelimited") {
-        return { arrayFormat: "pipe" };
+      if (style === "deepObject") {
+        arrayFormat = "brackets" /* brackets */;
+      } else if (explode) {
+        arrayFormat = "repeat" /* repeat */;
+      } else {
+        if (style === "form") {
+          arrayFormat = "comma" /* comma */;
+        } else if (style === "spaceDelimited") {
+          arrayFormat = "space" /* space */;
+        } else if (style === "pipeDelimited") {
+          arrayFormat = "pipe" /* pipe */;
+        }
       }
     }
-    return {};
+    if ("x-qs-allow-dots" in parameter) {
+      allowDots = Boolean(parameter["x-qs-allow-dots"]);
+    }
+    if ("x-qs-indices" in parameter) {
+      indices = Boolean(parameter["x-qs-indices"]);
+    }
+    if (arrayFormat || allowDots !== void 0 || indices !== void 0) {
+      return {
+        ...arrayFormat ? { arrayFormat } : {},
+        ...allowDots !== void 0 ? { allowDots } : {},
+        ...indices !== void 0 ? { indices } : {}
+      };
+    }
+    return void 0;
   }
   // render: "if (args && 'Authorization' in args) req.header('Authorization', args['Authorization'])"
   renderRequestHeaders() {
@@ -2011,8 +1966,7 @@ var NestjsClientRenderer = class {
     const moduleName = changeCase2.pascalCase(this.document.module.name);
     const $dependencies = this.renderDependencies();
     const $operations = this.document.operations.map((operation) => OperationDefinitionTransformer.toNestjsMethod(operation, {
-      esm: this.options.esm,
-      qs: this.options.qs
+      esm: this.options.esm
     })).join("\n\n");
     return [
       "/* @anchor:file:start */",
@@ -2399,7 +2353,6 @@ var MicroFunctionGenerator = class _MicroFunctionGenerator {
       id: _MicroFunctionGenerator.getOperationDefinitionArtifactId(operationDefinition),
       filepath,
       content: OperationDefinitionTransformer.toMicroFunction(operationDefinition, {
-        qs: rc.qs,
         esm: rc.esm,
         getOperationDefinitionDeclarationFilepath(operationDefinition2) {
           const relativePath = path10.relative(
@@ -2524,7 +2477,6 @@ var NestjsModuleGenerator = class _NestjsModuleGenerator {
       filepath,
       content: ApiDocumentTransformer.toNestjsClient(document, {
         esm: rc.esm,
-        qs: rc.qs,
         getOperationDefinitionDeclarationFilepath(operationDefinition) {
           const relativePath = path11.relative(
             dirpath,
@@ -2661,7 +2613,7 @@ var DownloadLocalFilePlugin = class _DownloadLocalFilePlugin {
 };
 
 // src/plugins/shaking/shaking.plugin.ts
-var import_openapi_shaking2 = require("@opendoc/openapi-shaking");
+var import_openapi_shaking = require("@opendoc/openapi-shaking");
 var ShakingPlugin = class _ShakingPlugin {
   apply(compiler) {
     compiler.hooks.beforeCompile.tap(_ShakingPlugin.name, (task) => {
@@ -2671,6 +2623,7 @@ var ShakingPlugin = class _ShakingPlugin {
     });
   }
   shaking(compiler, document) {
+    const rc = compiler.context.rc;
     const matcher = compiler.context.matcher;
     const isAccepted = (pathname, method, operation) => {
       if (!SupportedMethods.includes(method)) return false;
@@ -2682,10 +2635,10 @@ var ShakingPlugin = class _ShakingPlugin {
         document
       }));
     };
-    const sharkedSwagger = (0, import_openapi_shaking2.openapiShakingSync)(
+    const sharkedSwagger = (0, import_openapi_shaking.openapiShakingSync)(
       document.specification,
       isAccepted,
-      { tolerant: true }
+      { tolerant: rc.tolerant }
     );
     return new ApiDocumentV3_1(
       sharkedSwagger,
@@ -2779,6 +2732,11 @@ var InitializePlugin = class _InitializePlugin {
       } else if (rc.mode === "nestjs-module") {
         new GenerateNestjsModulePlugin().apply(compiler);
       }
+      if (rc.plugins && rc.plugins.length) {
+        for (const plugin of rc.plugins) {
+          plugin.apply(compiler);
+        }
+      }
     });
     if (this.options.includes && this.options.includes.length) {
       const modulesIncludes = this.options.includes;
@@ -2804,6 +2762,9 @@ var InitializePlugin = class _InitializePlugin {
   }
 };
 
+// src/plugins/overwrite-query-options/overwrite-query-options.plugin.ts
+var QsArrayFormatUnion = Object.values(QsArrayFormat);
+
 // src/compiler/compiler.ts
 var Compiler = class {
   constructor(options) {