@keq-request/cli 5.0.0-alpha.18 → 5.0.0-alpha.20

package/dist/index.js

@@ -68,7 +68,7 @@ var RuntimeConfig = Type2.Object({
   ])),
   debug: Type2.Optional(Type2.Boolean({ default: false })),
   /**
-   * Whether to tolerate wrong swagger structure
+   * Whether to tolerate wrong openapi/swagger structure
    */
   tolerant: Type2.Optional(Type2.Boolean({ default: false })),
   plugins: Type2.Optional(Type2.Array(Type2.Any(), { default: [] }))
@@ -534,14 +534,14 @@ var logger = {
 import { openapiShakingSync } from "@opendoc/openapi-shaking";
 var ApiDocumentV3_1 = class _ApiDocumentV3_1 {
   module;
-  swagger;
-  constructor(swagger, module) {
+  specification;
+  constructor(specification, module) {
     this.module = module;
-    this.swagger = swagger;
+    this.specification = specification;
   }
   get schemas() {
     const module = this.module;
-    return Object.entries(this.swagger.components?.schemas || {}).map(([name, schema]) => new SchemaDefinition({
+    return Object.entries(this.specification.components?.schemas || {}).map(([name, schema]) => new SchemaDefinition({
       id: `#/components/schemas/${name}`,
       name,
       schema,
@@ -551,7 +551,7 @@ var ApiDocumentV3_1 = class _ApiDocumentV3_1 {
   }
   get operations() {
     const module = this.module;
-    return Object.entries(this.swagger.paths || {}).flatMap(([pathname, pathItem]) => Object.entries(pathItem || {}).filter(([method]) => SupportedMethods.includes(method.toLowerCase())).map(([method, operation]) => new OperationDefinition({
+    return Object.entries(this.specification.paths || {}).flatMap(([pathname, pathItem]) => Object.entries(pathItem || {}).filter(([method]) => SupportedMethods.includes(method.toLowerCase())).map(([method, operation]) => new OperationDefinition({
       method,
       pathname,
       operation,
@@ -560,18 +560,18 @@ var ApiDocumentV3_1 = class _ApiDocumentV3_1 {
     })));
   }
   isEmpty() {
-    return R6.isEmpty(this.swagger.paths);
+    return R6.isEmpty(this.specification.paths);
   }
   dereference($ref) {
     if ($ref.startsWith("#/")) {
       return this.schemas.find((schema) => schema.id === $ref);
     }
-    logger.warn(`The $ref(${$ref}) is not defined in ${this.module.name} swagger.`);
+    logger.warn(`The $ref(${$ref}) is not defined in ${this.module.name} openapi/swagger.`);
   }
   isRefDefined($ref) {
     if ($ref.startsWith("#/")) {
       const path9 = $ref.replace("#/", "").split("/");
-      return R6.path(path9, this.swagger) !== void 0;
+      return R6.path(path9, this.specification) !== void 0;
     }
     return false;
   }
@@ -588,7 +588,7 @@ var ApiDocumentV3_1 = class _ApiDocumentV3_1 {
       return filter2(operationDefinition);
     };
     const sharkedSwagger = openapiShakingSync(
-      this.swagger,
+      this.specification,
       isAccepted,
       { tolerant: true }
     );
@@ -611,14 +611,14 @@ var Debugger = class {
   constructor(rc) {
     this.rc = rc;
   }
-  writeSwagger(fullpath, swagger) {
+  writeOpenapi(fullpath, openapi) {
     if (this.rc?.debug) {
-      void fs4.writeJSON(fullpath, swagger, { spaces: 2 });
+      void fs4.writeJSON(fullpath, openapi, { spaces: 2 });
     }
   }
 };
 
-// src/utils/swagger-utils/dereference.ts
+// src/utils/openapi-utils/dereference.ts
 function dereference($ref, swagger) {
   let value;
   for (const key of $ref.split("/")) {
@@ -632,17 +632,17 @@ function dereference($ref, swagger) {
   return value;
 }
 
-// src/utils/swagger-utils/dereference-operation.ts
+// src/utils/openapi-utils/dereference-operation.ts
 import * as R9 from "ramda";
 import jsonpointer2 from "jsonpointer";
 import { JSONPath as JSONPath4 } from "jsonpath-plus";
 
-// src/utils/swagger-utils/remove-undefined-ref.ts
+// src/utils/openapi-utils/remove-undefined-ref.ts
 import * as R8 from "ramda";
 import jsonpointer from "jsonpointer";
 import { JSONPath as JSONPath3 } from "jsonpath-plus";
 
-// src/utils/swagger-utils/is-ref-defined.ts
+// src/utils/openapi-utils/is-ref-defined.ts
 import * as R7 from "ramda";
 function isRefDefined($ref, swagger) {
   if ($ref.startsWith("#/")) {
@@ -652,7 +652,7 @@ function isRefDefined($ref, swagger) {
   return false;
 }
 
-// src/utils/swagger-utils/remove-undefined-ref.ts
+// src/utils/openapi-utils/remove-undefined-ref.ts
 function removeUndefinedRef(swagger) {
   const shadow = R8.clone(swagger);
   const matches = JSONPath3({
@@ -668,7 +668,7 @@ function removeUndefinedRef(swagger) {
   return shadow;
 }
 
-// src/utils/swagger-utils/dereference-operation.ts
+// src/utils/openapi-utils/dereference-operation.ts
 function dereferencePathObject(swagger) {
   const matches = JSONPath4({
     path: "$.paths.*.$ref^",
@@ -676,7 +676,7 @@ function dereferencePathObject(swagger) {
     resultType: "all"
   });
   for (const match of matches) {
-    const value = SwaggerUtils.dereference(match.value.$ref, swagger);
+    const value = OpenapiUtils.dereference(match.value.$ref, swagger);
     jsonpointer2.set(swagger, match.pointer, value);
   }
 }
@@ -687,7 +687,7 @@ function dereferenceRequestBody(swagger) {
     resultType: "all"
   });
   for (const match of matches) {
-    const value = SwaggerUtils.dereference(match.value.$ref, swagger);
+    const value = OpenapiUtils.dereference(match.value.$ref, swagger);
     jsonpointer2.set(swagger, match.pointer, value);
   }
 }
@@ -705,7 +705,7 @@ function dereferenceResponses(swagger) {
     })
   ];
   for (const match of matches) {
-    const value = SwaggerUtils.dereference(match.value.$ref, swagger);
+    const value = OpenapiUtils.dereference(match.value.$ref, swagger);
     jsonpointer2.set(swagger, match.pointer, value);
   }
 }
@@ -716,7 +716,7 @@ function dereferenceParameters(swagger) {
     resultType: "all"
   });
   for (const match of matches) {
-    const value = SwaggerUtils.dereference(match.value.$ref, swagger);
+    const value = OpenapiUtils.dereference(match.value.$ref, swagger);
     jsonpointer2.set(swagger, match.pointer, value);
   }
 }
@@ -729,7 +729,7 @@ function dereferenceOperation(swagger) {
   return removeUndefinedRef(shadow);
 }
 
-// src/utils/swagger-utils/update-operation-id.ts
+// src/utils/openapi-utils/update-operation-id.ts
 import * as R10 from "ramda";
 function updateOperationId(swagger, fn) {
   const shadow = R10.clone(swagger);
@@ -776,7 +776,7 @@ var JsonSchemaUtils = class {
   static isMixed = isMixed;
 };
 
-// src/utils/swagger-utils/dereference-deep.ts
+// src/utils/openapi-utils/dereference-deep.ts
 function dereferenceDeep($ref, swagger) {
   const stack = [$ref];
   let value;
@@ -796,8 +796,8 @@ function dereferenceDeep($ref, swagger) {
   return value;
 }
 
-// src/utils/swagger-utils/index.ts
-var SwaggerUtils = class {
+// src/utils/openapi-utils/index.ts
+var OpenapiUtils = class {
   static isRefDefined = isRefDefined;
   static dereference = dereference;
   static dereferenceDeep = dereferenceDeep;
@@ -809,10 +809,10 @@ var SwaggerUtils = class {
 // src/tasks/utils/api-document.ts
 var ApiDocument = class _ApiDocument {
   module;
-  swagger;
-  constructor(swagger, module) {
+  specification;
+  constructor(specification, module) {
     this.module = module;
-    this.swagger = swagger;
+    this.specification = specification;
   }
   static cache = /* @__PURE__ */ new Map();
   static async download(url) {
@@ -823,14 +823,14 @@ var ApiDocument = class _ApiDocument {
       content = await res.text();
     } catch (e) {
       if (e instanceof Error) {
-        e.message = `Unable get the swagger file from ${url}: ${e.message}`;
+        e.message = `Unable get the openapi/swagger file from ${url}: ${e.message}`;
       }
       throw e;
     }
     try {
       return JSON.parse(content);
     } catch (e) {
-      throw new Error(`The swagger file get from url isn't json: ${url}`);
+      throw new Error(`The openapi/swagger file get from url isn't json: ${url}`);
     }
   }
   static async read(filePath) {
@@ -848,17 +848,17 @@ var ApiDocument = class _ApiDocument {
     if (this.cache.has(moduleDefinition.address)) {
       return this.cache.get(moduleDefinition.address);
     }
-    const swagger = validUrl.isUri(address) ? await this.download(address) : await this.read(address);
-    return new _ApiDocument(swagger, moduleDefinition);
+    const openapi = validUrl.isUri(address) ? await this.download(address) : await this.read(address);
+    return new _ApiDocument(openapi, moduleDefinition);
   }
   async validate() {
-    return await validate(this.swagger);
+    return await validate(this.specification);
   }
   // remove chinese and special symbols
   fix() {
-    const swagger = fixSwagger(this.swagger);
+    const openapi = fixSwagger(this.specification);
     return new _ApiDocument(
-      swagger,
+      openapi,
       new ModuleDefinition(
         this.module.name,
         `file://${this.module.name}.fixed.json`
@@ -868,22 +868,22 @@ var ApiDocument = class _ApiDocument {
   // eslint-disable-next-line @typescript-eslint/require-await
   async toV3_1(rc) {
     const debug = new Debugger(rc);
-    let swagger = this.swagger;
-    const { specification } = upgrade(swagger);
-    swagger = specification;
-    debug.writeSwagger(`.keq/${this.module.name}.3_1.json`, swagger);
-    swagger = SwaggerUtils.dereferenceOperation(swagger);
-    debug.writeSwagger(`.keq/${this.module.name}.3_1.sharked.json`, swagger);
+    let spec = this.specification;
+    const { specification } = upgrade(spec);
+    spec = specification;
+    debug.writeOpenapi(`.keq/${this.module.name}.3_1.json`, spec);
+    spec = OpenapiUtils.dereferenceOperation(spec);
+    debug.writeOpenapi(`.keq/${this.module.name}.3_1.sharked.json`, spec);
     if (rc?.operationIdFactory) {
       const operationIdFactory = rc.operationIdFactory;
-      swagger = SwaggerUtils.updateOperationId(
-        swagger,
+      spec = OpenapiUtils.updateOperationId(
+        spec,
         (method, pathname, operation) => operationIdFactory({ method, pathname, operation, module: this.module })
       );
-      debug.writeSwagger(`.keq/${this.module.name}.3_1.formatted.json`, swagger);
+      debug.writeOpenapi(`.keq/${this.module.name}.3_1.formatted.json`, spec);
     }
     return new ApiDocumentV3_1(
-      swagger,
+      spec,
       new ModuleDefinition(
         this.module.name,
         `file://${this.module.name}.v3_1.json`
@@ -969,12 +969,12 @@ function main3() {
           task: async (ctx, task2) => {
             const { valid, errors } = await document.validate();
             if (!valid) {
-              const message = `${document.module.name} module swagger file does not conform to the openapi@3.1 standard specifications or have grammatical errors, which may cause unexpected errors: 
+              const message = `${document.module.name} module openapi/swagger file does not conform to the openapi@3.1 standard specifications or have grammatical errors, which may cause unexpected errors: 
 ${errors?.map((e) => `  - ${e.message}`).join("\n")}`;
               task2.output = message;
             }
             const fixedDocument = document.fix();
-            debug.writeSwagger(`.keq/${document.module.name}.fixed.json`, fixedDocument.swagger);
+            debug.writeOpenapi(`.keq/${document.module.name}.fixed.json`, fixedDocument.specification);
             const v3_1Document = await fixedDocument.toV3_1(rc);
             ctx.validated.documents.push(v3_1Document);
           }
@@ -1649,7 +1649,7 @@ function parameterBodies(operationDefinition, alias = R15.identity, typeName) {
   if (operation.requestBody && !JsonSchemaUtils.isRef(operation.requestBody)) {
     const $mediaTypes = Object.entries(operation.requestBody.content || {}).map(([mediaType, mediaTypeObject]) => [mediaType, mediaTypeObject.schema]).map(([mediaType, schemaOrRef]) => {
       if (!schemaOrRef) return `${JSON.stringify(mediaType)}: unknown`;
-      const schema = JsonSchemaUtils.isRef(schemaOrRef) ? SwaggerUtils.dereferenceDeep(schemaOrRef.$ref, operationDefinition.document.swagger) : schemaOrRef;
+      const schema = JsonSchemaUtils.isRef(schemaOrRef) ? OpenapiUtils.dereferenceDeep(schemaOrRef.$ref, operationDefinition.document.specification) : schemaOrRef;
       if (schema.type === "object" || schema.properties) {
         return `${JSON.stringify(mediaType)}: ${generateSchema(schemaOrRef, alias)} & { [key: string]: any }`;
       }
@@ -1749,7 +1749,7 @@ function errorToComment(err, mediaType) {
 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;
+    const schema = JsonSchemaUtils.isRef(propertySchema) ? OpenapiUtils.dereferenceDeep(propertySchema.$ref, operationDefinition.document.specification) : 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") {
@@ -1778,7 +1778,7 @@ function requestBodyRenderer(operationDefinition, typeName) {
   const $requestBody = Object.entries(requestBodyContent).map(([mediaType, mediaTypeObject]) => {
     if (!mediaTypeObject.schema) return;
     try {
-      const schema = JsonSchemaUtils.isRef(mediaTypeObject.schema) ? SwaggerUtils.dereferenceDeep(mediaTypeObject.schema.$ref, operationDefinition.document.swagger) : mediaTypeObject.schema;
+      const schema = JsonSchemaUtils.isRef(mediaTypeObject.schema) ? OpenapiUtils.dereferenceDeep(mediaTypeObject.schema.$ref, operationDefinition.document.specification) : mediaTypeObject.schema;
       if (schema.type !== "object") return;
       const properties = schema.properties || {};
       return Object.entries(properties).map(([propertyName, propertySchema]) => {