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

package/dist/plugins.js

@@ -27,7 +27,7 @@ var EslintPlugin = class _EslintPlugin {
   }
 };
 
-// src/plugins/prettier/index.ts
+// src/plugins/prettier/prettier.plugin.ts
 import { exec } from "child_process";
 import { promisify } from "util";
 var execAsync = promisify(exec);
@@ -88,12 +88,6 @@ import * as changeCase6 from "change-case";
 // src/models/artifact.ts
 import * as path from "path";
 
-// 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) {
@@ -172,7 +166,6 @@ var HeaderComment = [
 var Artifact = class {
   id;
   filepath;
-  warns = [];
   content;
   extensionName;
   anchor = new Anchor(this);
@@ -185,20 +178,8 @@ var Artifact = class {
   get dirname() {
     return path.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}`;
   }
 };
 
@@ -408,7 +389,6 @@ var logger = {
 };
 
 // src/models/api-document_v3_1.ts
-import { openapiShakingSync } from "@opendoc/openapi-shaking";
 var ApiDocumentV3_1 = class _ApiDocumentV3_1 {
   module;
   specification;
@@ -451,31 +431,6 @@ var ApiDocumentV3_1 = class _ApiDocumentV3_1 {
     }
     return false;
   }
-  sharking(filter) {
-    const isAccepted = (pathname, method, operation) => {
-      if (!SupportedMethods.includes(method)) return false;
-      const operationDefinition = new OperationDefinition({
-        method,
-        pathname,
-        operation,
-        module: this.module,
-        document: this
-      });
-      return filter(operationDefinition);
-    };
-    const sharkedSwagger = 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());
   }
@@ -840,25 +795,6 @@ function dereferenceOperation(swagger) {
   return removeUndefinedRef(shadow);
 }
 
-// src/utils/openapi-utils/update-operation-id.ts
-import * as R11 from "ramda";
-function updateOperationId(swagger, fn) {
-  const shadow = R11.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/openapi-utils/dereference-deep.ts
 function dereferenceDeep($ref, swagger) {
   const stack = [$ref];
@@ -886,6 +822,31 @@ function To3_1(openapi) {
   return specification;
 }
 
+// src/utils/openapi-utils/map-operation.ts
+import * as R11 from "ramda";
+function mapOperation(specification, mapper) {
+  const shadow = R11.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;
@@ -893,7 +854,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;
 };
 
@@ -912,7 +875,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");
@@ -994,7 +962,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");
   }
@@ -1073,8 +1041,21 @@ ${msg}`);
   }
 };
 
-// src/transformers/operation-definition/typescript-helper.ts
+// src/transformers/operation-definition/typescript-snippet.ts
 import * as R13 from "ramda";
+
+// 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;
@@ -1083,27 +1064,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() {
@@ -1419,8 +1415,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 */",
@@ -1807,7 +1802,6 @@ var MicroFunctionGenerator = class _MicroFunctionGenerator {
       id: _MicroFunctionGenerator.getOperationDefinitionArtifactId(operationDefinition),
       filepath,
       content: OperationDefinitionTransformer.toMicroFunction(operationDefinition, {
-        qs: rc.qs,
         esm: rc.esm,
         getOperationDefinitionDeclarationFilepath(operationDefinition2) {
           const relativePath = path7.relative(
@@ -1969,7 +1963,6 @@ var NestjsModuleGenerator = class _NestjsModuleGenerator {
       filepath,
       content: ApiDocumentTransformer.toNestjsClient(document, {
         esm: rc.esm,
-        qs: rc.qs,
         getOperationDefinitionDeclarationFilepath(operationDefinition) {
           const relativePath = path8.relative(
             dirpath,
@@ -2119,7 +2112,7 @@ var DownloadLocalFilePlugin = class _DownloadLocalFilePlugin {
 };
 
 // src/plugins/shaking/shaking.plugin.ts
-import { openapiShakingSync as openapiShakingSync2 } from "@opendoc/openapi-shaking";
+import { openapiShakingSync } from "@opendoc/openapi-shaking";
 var ShakingPlugin = class _ShakingPlugin {
   apply(compiler) {
     compiler.hooks.beforeCompile.tap(_ShakingPlugin.name, (task) => {
@@ -2129,6 +2122,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;
@@ -2140,10 +2134,10 @@ var ShakingPlugin = class _ShakingPlugin {
         document
       }));
     };
-    const sharkedSwagger = openapiShakingSync2(
+    const sharkedSwagger = openapiShakingSync(
       document.specification,
       isAccepted,
-      { tolerant: true }
+      { tolerant: rc.tolerant }
     );
     return new ApiDocumentV3_1(
       sharkedSwagger,
@@ -2237,6 +2231,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;
@@ -2261,6 +2260,82 @@ var InitializePlugin = class _InitializePlugin {
     }
   }
 };
+
+// src/plugins/overwrite-operation-id/overwrite-operation-id.plugin.ts
+var OverwriteOperationIdPlugin = class _OverwriteOperationIdPlugin {
+  constructor(factory) {
+    this.factory = factory;
+  }
+  apply(compiler) {
+    compiler.hooks.afterDownload.tap(_OverwriteOperationIdPlugin.name, () => {
+      const documents = compiler.context.documents;
+      const factory = this.factory;
+      compiler.context.documents = documents.map((document) => {
+        const spec = OpenapiUtils.mapOperation(
+          document.specification,
+          (method, pathname, operation) => {
+            const operationId = factory({ method, pathname, operation, module: document.module });
+            if (typeof operationId === "string") {
+              if (operationId.length === 0) {
+                throw new Exception(document.module, `The generated operationId for [${method.toUpperCase()} ${pathname}] is an empty string.`);
+              }
+              operation.operationId = operationId;
+              return operation;
+            }
+            return operation;
+          }
+        );
+        return new ApiDocumentV3_1(spec, document.module);
+      });
+    });
+  }
+};
+
+// src/plugins/overwrite-query-options/overwrite-query-options.plugin.ts
+var QsArrayFormatUnion = Object.values(QsArrayFormat);
+var OverwriteQueryOptionsPlugin = class _OverwriteQueryOptionsPlugin {
+  constructor(factory) {
+    this.factory = factory;
+  }
+  apply(compiler) {
+    compiler.hooks.afterDownload.tap(_OverwriteQueryOptionsPlugin.name, (task) => {
+      const documents = compiler.context.documents;
+      const factory = this.factory;
+      compiler.context.documents = documents.map((document) => {
+        const specification = OpenapiUtils.mapParameter(
+          document.specification,
+          (method, pathname, operation, parameter) => {
+            const qsOptions = typeof factory === "function" ? factory({ parameter, operation, pathname, method, module: document.module }) : factory;
+            if (!qsOptions) return parameter;
+            if (qsOptions.arrayFormat) {
+              if (!QsArrayFormatUnion.includes(qsOptions.arrayFormat)) {
+                throw new Exception(document.module, `The 'arrayFormat' value '${qsOptions.arrayFormat}' for the query parameter '${parameter.name}' in [${method.toUpperCase()} ${pathname}] is invalid.`);
+              }
+              parameter["x-qs-array-format"] = qsOptions.arrayFormat;
+            }
+            if (qsOptions.allowDots !== void 0) {
+              if (typeof qsOptions.allowDots !== "boolean") {
+                throw new Exception(document.module, `The 'allowDots' value for the query parameter '${parameter.name}' in [${method.toUpperCase()} ${pathname}] must be a boolean.`);
+              }
+              parameter["x-qs-allow-dots"] = Boolean(qsOptions.allowDots);
+            }
+            if (qsOptions.indices !== void 0) {
+              if (typeof qsOptions.indices !== "boolean") {
+                throw new Exception(document.module, `The 'indices' value for the query parameter '${parameter.name}' in [${method.toUpperCase()} ${pathname}] must be a boolean.`);
+              }
+              parameter["x-qs-indices"] = Boolean(qsOptions.indices);
+            }
+            return parameter;
+          }
+        );
+        return new ApiDocumentV3_1(
+          specification,
+          document.module
+        );
+      });
+    });
+  }
+};
 export {
   BodyFallbackPlugin,
   ChineseToPinyinPlugin,
@@ -2278,6 +2353,8 @@ export {
   NestjsModuleGenerator,
   OPERATION_GENERATOR,
   OperationDeclarationGenerator,
+  OverwriteOperationIdPlugin,
+  OverwriteQueryOptionsPlugin,
   PrettierPlugin,
   RequestGenerator,
   SCHEMA_GENERATOR,