@keq-request/cli 5.0.0-alpha.12 → 5.0.0-alpha.14

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 export { defineKeqConfig } from './define-keq-config.js';
 export { RuntimeConfig } from './types/runtime-config.js';
 export { FileNamingStyle } from './constants/file-naming-style.js';
+export { QsArrayFormat } from './constants/qs-array-format.js';
 export { Compiler } from './compiler/compiler.js';
 export { Plugin } from './types/plugin.js';
 export { Artifact } from './tasks/utils/artifact.js';

package/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;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AACzD,OAAO,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAA;AAElE,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAA;AACjD,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAA;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAA;AACrE,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAA;AACrE,OAAO,EAAE,mBAAmB,EAAE,MAAM,uCAAuC,CAAA;AAC3E,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AAC3D,OAAO,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAA;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AACzD,OAAO,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAA;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAA;AAE9D,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAA;AACjD,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAA;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAA;AACrE,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAA;AACrE,OAAO,EAAE,mBAAmB,EAAE,MAAM,uCAAuC,CAAA;AAC3E,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAA;AAC3D,OAAO,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAA"}

package/dist/index.js

@@ -1076,7 +1076,10 @@ function createPersistArtifactTask() {
     title: "Write files",
     task: async (context, task) => {
       if (!context.setup) throw new Error("Please run setup task first.");
-      if (!context.compiled) throw new Error("Please run compile task first.");
+      if (!context.compiled) {
+        task.skip("No compiled artifacts to persist.");
+        return;
+      }
       const rc = context.setup.rc;
       const artifacts = context.compiled.artifacts;
       for (const artifact of artifacts) {
@@ -1207,11 +1210,12 @@ function generateArray(schema, alias) {
   return "any[]";
 }
 function indent(space, text) {
+  if (text === "") return "";
   const indentation = " ".repeat(space);
   return text.split("\n").map((line) => `${indentation}${line}`).join("\n");
 }
 function generateObject(schema, alias) {
-  if (!schema.properties || !Object.keys(schema.properties).length) {
+  if ((!schema.properties || R11.isEmpty(schema.properties)) && (!schema.additionalProperties || R11.isEmpty(schema.additionalProperties))) {
     return "object";
   }
   const $properties = Object.entries(schema.properties || {}).map(([propertyName, propertySchema]) => {
@@ -1381,15 +1385,17 @@ function toComment(msg) {
 
 // src/tasks/utils/dependency.ts
 var DependencyIdentifier = class {
-  constructor(name, alias) {
+  constructor(name, alias, type = false) {
     this.name = name;
     this.alias = alias;
+    this.type = type;
   }
   toCode() {
+    const $type = this.type ? "type " : "";
     if (this.alias) {
-      return `${this.name} as ${this.alias}`;
+      return `${$type}${this.name} as ${this.alias}`;
     }
-    return this.name;
+    return `${$type}${this.name}`;
   }
 };
 var Dependency = class {
@@ -1400,6 +1406,11 @@ var Dependency = class {
   constructor(source, identifiers, belongTo, options) {
     this.source = source;
     this.identifiers = identifiers.map((i) => typeof i === "string" ? new DependencyIdentifier(i) : i);
+    if (options?.type) {
+      for (const identifier of this.identifiers) {
+        identifier.type = true;
+      }
+    }
     this.export = !!options?.export;
     this.belongTo = belongTo;
   }
@@ -1571,7 +1582,10 @@ async function compileSchemaDefinition(options) {
     const artifact = new Artifact({
       id: filepath,
       filepath,
-      content: ""
+      content: [
+        "/* @anchor:file:start */",
+        "/* @anchor:file:end */"
+      ].join("\n")
     });
     for (const schemaDefinition of schemaDefinitions2 || []) {
       const dependentArtifact = artifacts.find(isArtifactCompiledBy(schemaDefinition));
@@ -1587,7 +1601,7 @@ async function compileSchemaDefinition(options) {
 }
 
 // src/tasks/compile/utils/compile-operation-definition.ts
-import * as R17 from "ramda";
+import * as R18 from "ramda";
 
 // src/renderer/operation-type/index.ts
 import * as R15 from "ramda";
@@ -1684,7 +1698,7 @@ async function operationTypeRenderer(operationDefinition, alias = R15.identity)
     $parameterBodies || void 0,
     $requestParameters,
     "",
-    `export interface Operation<STATUS extends keyof ${typeName("ResponseBodies")}, CONTENT_TYPE extends keyof ${typeName("ParameterBodies")}> extends KeqOperation {`,
+    `export interface Operation<STATUS extends keyof ${typeName("ResponseBodies")}, CONTENT_TYPE extends ${$parameterBodies ? `keyof ${typeName("ParameterBodies")}` : "string"} > extends KeqOperation {`,
     `  requestParams: ${typeName("RouteParameters")} & { [key: string]: KeqPathParameterInit }`,
     `  requestQuery: ${typeName("RequestQuery")} & { [key: string]: KeqQueryInit }`,
     `  requestHeaders: ${typeName("RequestHeaders")} & { [key: string]: string | number }`,
@@ -1713,7 +1727,12 @@ function generateParameters(name, parameters, alias) {
 }
 
 // src/renderer/operation-request/index.ts
+import * as R17 from "ramda";
+
+// src/renderer/operation-request/request-body.ts
 import * as R16 from "ramda";
+
+// src/renderer/operation-request/error-to-comment.ts
 function errorToComment(err, mediaType) {
   const $err = String(err).split("\n").map(((line) => ` * ${line}`)).join("\n");
   return [
@@ -1723,6 +1742,34 @@ function errorToComment(err, mediaType) {
     " */"
   ].join("\n");
 }
+
+// src/renderer/operation-request/request-body.ts
+function requestBodyFormDataPropertyRenderer(propertyName, propertySchema, mediaType, operationDefinition) {
+  try {
+    const $propertyName = JSON.stringify(propertyName);
+    const schema = JsonSchemaUtils.isRef(propertySchema) ? SwaggerUtils.dereferenceDeep(propertySchema.$ref, operationDefinition.document.swagger) : propertySchema;
+    if (schema.type === "string" && schema.format === "binary" || schema.contentMediaType === "application/octet-stream") {
+      return `if (args && ${$propertyName} in args && args[${$propertyName}]) req.attach(${$propertyName}, args[${$propertyName}])`;
+    } else if (schema.type === "string" || schema.type === "array" && schema.items && schema.items.type === "string") {
+      return `if (args && ${$propertyName} in args && args[${$propertyName}] !== undefined) req.field(${$propertyName}, args[${$propertyName}])`;
+    } else if (schema.type === "number" || schema.type === "integer") {
+      return `if (args && ${$propertyName} in args && args[${$propertyName}] !== undefined) req.field(${$propertyName}, String(args[${$propertyName}]))`;
+    }
+    return `if (args && ${$propertyName} in args && args[${$propertyName}] !== undefined) req.field(${$propertyName}, String(args[${$propertyName}]) /* type is non-string in schema; triggers type coercion here */)`;
+  } catch (err) {
+    return errorToComment(err, mediaType);
+  }
+}
+function requestBodyPropertyRenderer(propertyName, propertySchema, mediaType, operationDefinition) {
+  if (mediaType === "application/json") {
+    const $propertyName = JSON.stringify(propertyName);
+    return `if (args && ${$propertyName} in args) req.send({ ${$propertyName}: args[${$propertyName}] })`;
+  } else if (mediaType === "multipart/form-data") {
+    return requestBodyFormDataPropertyRenderer(propertyName, propertySchema, mediaType, operationDefinition);
+  } else {
+    throw new Error(`Unsupported media type: ${mediaType}`);
+  }
+}
 function requestBodyRenderer(operationDefinition, typeName) {
   const { operation } = operationDefinition;
   const requestBodyContent = operation.requestBody?.content || {};
@@ -1733,22 +1780,10 @@ function requestBodyRenderer(operationDefinition, typeName) {
       if (schema.type !== "object") return;
       const properties = schema.properties || {};
       return Object.entries(properties).map(([propertyName, propertySchema]) => {
-        const $propertyName = JSON.stringify(propertyName);
-        if (mediaType === "application/json") {
-          return `  if (args && ${$propertyName} in args) req.send({ ${$propertyName}: args[${$propertyName}] })`;
-        } else if (mediaType === "multipart/form-data") {
-          try {
-            const schema2 = JsonSchemaUtils.isRef(propertySchema) ? SwaggerUtils.dereferenceDeep(propertySchema.$ref, operationDefinition.document.swagger) : propertySchema;
-            if (schema2.type === "string" && schema2.format === "binary" || schema2.contentMediaType === "application/octet-stream") {
-              return `  if (args && ${$propertyName} in args && args[${$propertyName}]) req.attach(${$propertyName}, args[${$propertyName}])`;
-            }
-            return `  if (args && ${$propertyName} in args && args[${$propertyName}] !== undefined) req.field(${$propertyName}, args[${$propertyName}])`;
-          } catch (err) {
-            return indent(2, errorToComment(err, mediaType));
-          }
-        } else {
-          throw new Error(`Unsupported media type: ${mediaType}`);
-        }
+        return indent(
+          2,
+          requestBodyPropertyRenderer(propertyName, propertySchema, mediaType, operationDefinition)
+        );
       }).join("\n");
     } catch (err) {
       return indent(2, errorToComment(err, mediaType));
@@ -1756,6 +1791,8 @@ function requestBodyRenderer(operationDefinition, typeName) {
   }).filter(R16.isNotNil).join("\n");
   return $requestBody;
 }
+
+// src/renderer/operation-request/index.ts
 function requestHeadersRenderer(operationDefinition, typeName) {
   const { operation } = operationDefinition;
   const $headers = (operation.parameters || []).filter((p) => !JsonSchemaUtils.isRef(p)).filter((p) => p.in === "header").map((p) => `  if (args && ${JSON.stringify(p.name)} in args) req.header(${JSON.stringify(p.name)}, args[${JSON.stringify(p.name)}])`).concat("").join("\n");
@@ -1765,7 +1802,7 @@ function requestQueryRenderer(operationDefinition, qs, typeName) {
   const { operation } = operationDefinition;
   const $query = (operation.parameters || []).filter((p) => !JsonSchemaUtils.isRef(p)).filter((p) => p.in === "query").map((p) => {
     const option = qs(p);
-    const $option = !option || R16.isEmpty(option) ? "" : `, ${JSON.stringify(option)}`;
+    const $option = !option || R17.isEmpty(option) ? "" : `, ${JSON.stringify(option)}`;
     return `  if (args && ${JSON.stringify(p.name)} in args) req.query(${JSON.stringify(p.name)}, args[${JSON.stringify(p.name)}]${$option})`;
   }).concat("").join("\n");
   return $query;
@@ -1797,9 +1834,9 @@ function operationDeclarationRenderer(operationDefinition, typeName) {
   const { operationId } = operationDefinition;
   const mediaTypes = getRequestMediaTypes(operationDefinition);
   if (mediaTypes.length === 0) {
-    return `function ${operationId}<STATUS extends keyof ${typeName("ResponseBodies")}>(args?: ${typeName("RequestParameters")}): Keq<Operation<STATUS, never>>`;
+    return `function ${operationId}<STATUS extends keyof ${typeName("ResponseBodies")}, CONTENT_TYPE extends never = never>(args?: ${typeName("RequestParameters")}): Keq<Operation<STATUS, CONTENT_TYPE>>`;
   } else if (mediaTypes.length === 1) {
-    return `function ${operationId}<STATUS extends keyof ${typeName("ResponseBodies")}>(args?: ${typeName("RequestParameters")}): Keq<Operation<STATUS, ${JSON.stringify(mediaTypes[0])}>>`;
+    return `function ${operationId}<STATUS extends keyof ${typeName("ResponseBodies")}, CONTENT_TYPE extends ${JSON.stringify(mediaTypes[0])} = ${JSON.stringify(mediaTypes[0])}>(args?: ${typeName("RequestParameters")}): Keq<Operation<STATUS, CONTENT_TYPE>>`;
   } else if (mediaTypes.length > 1) {
     return `function ${operationId}<STATUS extends keyof ${typeName("ResponseBodies")}, CONTENT_TYPE extends ${typeName("RequestParameters")}["content-type"]>(args?: Extract<${typeName("RequestParameters")}, { "content-type": CONTENT_TYPE }>): Keq<Operation<STATUS, CONTENT_TYPE>>`;
   }
@@ -1811,6 +1848,7 @@ async function operationRequestRenderer(operationDefinition, options) {
   if (!operation.responses) return "";
   const typeName = typeNameFactory(operationDefinition);
   const moduleName = operationDefinition.module.name;
+  const $method = method.toLowerCase();
   const $queryParameters = requestQueryRenderer(operationDefinition, qs, typeName);
   const $headerParameters = requestHeadersRenderer(operationDefinition, typeName);
   const $pathParameters = requestPathParametersRenderer(operationDefinition, typeName);
@@ -1826,7 +1864,7 @@ async function operationRequestRenderer(operationDefinition, options) {
     "",
     "/* @anchor:operation-declaration */",
     `export ${$operationDeclaration} {`,
-    `  const req = request.post<${typeName("ResponseBodies")}[STATUS]>("${pathname}")`,
+    `  const req = request.${$method}<${typeName("ResponseBodies")}[STATUS]>("${pathname}")`,
     "    .option('module', { name: moduleName, pathname, method })",
     "",
     $mediaType || void 0,
@@ -1847,13 +1885,13 @@ async function operationRequestRenderer(operationDefinition, options) {
     "  /* @anchor:body:end */",
     "",
     "  /* @anchor:operation-return */",
-    `  return req as ReturnType<typeof ${operationId}>`,
+    `  return req as ReturnType<typeof ${operationId}<STATUS${$operationDeclaration.includes("CONTENT_TYPE") ? ", CONTENT_TYPE" : ""}>>`,
     "}",
     "",
     `${operationId}.pathname = pathname`,
     `${operationId}.method = method`,
     "/* @anchor:file:end */"
-  ].filter(R16.isNotNil).join("\n");
+  ].filter(R17.isNotNil).join("\n");
 }
 
 // src/tasks/compile/utils/compile-operation-definition.ts
@@ -1950,7 +1988,8 @@ async function compileOperationDefinition(options) {
         "Operation",
         typeName("ResponseBodies"),
         typeName("RequestParameters")
-      ]
+      ],
+      { type: true }
     );
     artifact.addDependence(
       typeArtifact,
@@ -1959,11 +1998,11 @@ async function compileOperationDefinition(options) {
         `${typeName("RequestHeaders")}`,
         `${typeName("RequestBodies")}`
       ],
-      { export: true }
+      { export: true, type: true }
     );
     return await compiler.hooks.afterCompileOperationRequest.promise(artifact, operationDefinition, task);
   }
-  const artifacts = R17.unnest(
+  const artifacts = R18.unnest(
     await Promise.all(
       operationDefinitions.map(async (operationDefinition) => {
         const typeArtifact = await createTypeArtifact(operationDefinition);
@@ -1972,7 +2011,7 @@ async function compileOperationDefinition(options) {
       })
     )
   );
-  const operationDefinitionsGroupByModuleName = R17.groupBy(
+  const operationDefinitionsGroupByModuleName = R18.groupBy(
     (operationDefinition) => operationDefinition.module.name,
     operationDefinitions
   );
@@ -1981,7 +2020,10 @@ async function compileOperationDefinition(options) {
     const artifact = new Artifact({
       id: filepath,
       filepath,
-      content: ""
+      content: [
+        "/* @anchor:file:start */",
+        "/* @anchor:file:end */"
+      ].join("\n")
     });
     for (const operationDefinition of operationDefinitions2 || []) {
       const dependentArtifact = artifacts.find((artifact2) => artifact2.filepath === genOperationRequestFilepath(operationDefinition));
@@ -1999,14 +2041,12 @@ async function compileOperationDefinition(options) {
 // src/renderer/request/index.ts
 async function requestRenderer() {
   return [
-    "import { KeqRequest } from 'keq'",
-    "",
     "/* @anchor:file:start */",
     "",
     "/* @anchor:request-declaration */",
     "export const request = new KeqRequest()",
     "",
-    "/* @anchor:file:end"
+    "/* @anchor:file:end */"
   ].join("\n");
 }
 
@@ -2019,13 +2059,15 @@ function main6(compiler) {
       const rc = context.setup.rc;
       const matcher = context.setup.matcher;
       const documents = context.shaken.documents.filter((document) => !matcher.isModuleIgnored(document.module));
-      const requestArtifact = await compiler.hooks.afterCompileKeqRequest.promise(
-        new Artifact({
-          id: "request",
-          filepath: "request",
-          content: await requestRenderer(),
-          extensionName: ".ts"
-        }),
+      let requestArtifact = new Artifact({
+        id: "request",
+        filepath: "request",
+        content: await requestRenderer(),
+        extensionName: ".ts"
+      });
+      requestArtifact.addDependence("keq", ["KeqRequest"]);
+      requestArtifact = await compiler.hooks.afterCompileKeqRequest.promise(
+        requestArtifact,
         task
       );
       const schemaDefinitions = documents.flatMap((document) => document.schemas);
@@ -2116,7 +2158,7 @@ function createInteractiveTask(options) {
 }
 
 // src/compiler/intercepter/perfect-error-message.ts
-import * as R18 from "ramda";
+import * as R19 from "ramda";
 function perfectErrorMessage() {
   return {
     register: (tap) => {
@@ -2148,8 +2190,8 @@ function perfectErrorMessage() {
       }
       if (tap.type === "async") {
         tap.fn = (...args) => {
-          const callback = R18.last(args);
-          return fn(...R18.init(args), (err, result) => {
+          const callback = R19.last(args);
+          return fn(...R19.init(args), (err, result) => {
             prefix(err);
             return callback(err, result);
           });
@@ -2240,11 +2282,11 @@ var Compiler = class {
       [
         createSetupTask(this, options),
         createDownloadTask(this, { skipIgnoredModules: !options.interactive }),
-        createValidateTask(this, { enabled: !!options.build }),
+        createValidateTask(this),
         createInteractiveTask({ enabled: !!options.interactive, ...typeof options.interactive === "object" ? options.interactive : { mode: "except" } }),
         createShakingTask(this, { enabled: !!options.build, ...typeof options.build === "object" ? options.build.shaking : void 0 }),
         createCompileTask(this, { enabled: !!options.build }),
-        createPersistTask(this, { enabled: !!options.build })
+        createPersistTask(this)
       ],
       {
         concurrent: false,
@@ -2268,6 +2310,7 @@ export {
   FileNamingStyle,
   ModuleDefinition,
   OperationDefinition,
+  QsArrayFormat,
   RuntimeConfig,
   SchemaDefinition,
   defineKeqConfig