@kubb/oas 3.2.0 → 3.3.1

package/dist/index.js

@@ -1,5 +1,12 @@
-export { Oas, isOpenApiV3_1Document, isOptional, isParameterObject, isReference, isRequired } from './chunk-X2CIM2ZZ.js';
+import { matchesMimeType } from 'oas/utils';
 export { findSchemaDefinition, matchesMimeType } from 'oas/utils';
+import { isRef } from 'oas/types';
+import { isPlainObject } from 'remeda';
+import { loadConfig, bundle } from '@redocly/openapi-core';
+import OASNormalize from 'oas-normalize';
+import swagger2openapi from 'swagger2openapi';
+import BaseOas from 'oas';
+import jsonpointer from 'jsonpointer';
 
 // src/types.ts
 var HttpMethods = {
@@ -12,7 +19,243 @@ var HttpMethods = {
   OPTIONS: "options",
   TRACE: "trace"
 };
+var Oas = class extends BaseOas {
+  #options = {};
+  document = void 0;
+  constructor({ oas, user }, options = {}) {
+    if (typeof oas === "string") {
+      oas = JSON.parse(oas);
+    }
+    super(oas, user);
+    this.document = oas;
+    this.#options = options;
+  }
+  get($ref) {
+    const origRef = $ref;
+    $ref = $ref.trim();
+    if ($ref === "") {
+      return false;
+    }
+    if ($ref.startsWith("#")) {
+      $ref = globalThis.decodeURIComponent($ref.substring(1));
+    } else {
+      return null;
+    }
+    const current = jsonpointer.get(this.api, $ref);
+    if (!current) {
+      throw new Error(`Could not find a definition for ${origRef}.`);
+    }
+    return current;
+  }
+  set($ref, value) {
+    $ref = $ref.trim();
+    if ($ref === "") {
+      return false;
+    }
+    if ($ref.startsWith("#")) {
+      $ref = globalThis.decodeURIComponent($ref.substring(1));
+      jsonpointer.set(this.api, $ref, value);
+    }
+  }
+  resolveDiscriminators() {
+    const schemas = this.api.components?.schemas || {};
+    Object.entries(schemas).forEach(([key, schemaObject]) => {
+      if ("discriminator" in schemaObject) {
+        const { mapping = {}, propertyName } = schemaObject.discriminator || {};
+        Object.entries(mapping).forEach(([mappingKey, mappingValue]) => {
+          if (mappingValue) {
+            const childSchema = this.get(mappingValue);
+            const property = childSchema.properties?.[propertyName];
+            if (property) {
+              childSchema.properties[propertyName] = {
+                ...childSchema.properties[propertyName],
+                enum: [...property?.enum?.filter((value) => value !== mappingKey) ?? [], mappingKey]
+              };
+              childSchema.required = [...childSchema.required ?? [], propertyName];
+              this.set(mappingValue, childSchema);
+            }
+          }
+        });
+      }
+    });
+  }
+  dereferenceWithRef(schema) {
+    if (isReference(schema)) {
+      return {
+        ...this.get(schema.$ref),
+        $ref: schema.$ref
+      };
+    }
+    return schema;
+  }
+  /**
+   * Oas does not have a getResponseBody(contentType)
+   */
+  #getResponseBodyFactory(responseBody) {
+    function hasResponseBody(res = responseBody) {
+      return !!res;
+    }
+    return (contentType) => {
+      if (!hasResponseBody(responseBody)) {
+        return false;
+      }
+      if (isReference(responseBody)) {
+        return false;
+      }
+      if (!responseBody.content) {
+        return false;
+      }
+      if (contentType) {
+        if (!(contentType in responseBody.content)) {
+          return false;
+        }
+        return responseBody.content[contentType];
+      }
+      let availablecontentType = void 0;
+      const contentTypes = Object.keys(responseBody.content);
+      contentTypes.forEach((mt) => {
+        if (!availablecontentType && matchesMimeType.json(mt)) {
+          availablecontentType = mt;
+        }
+      });
+      if (!availablecontentType) {
+        contentTypes.forEach((mt) => {
+          if (!availablecontentType) {
+            availablecontentType = mt;
+          }
+        });
+      }
+      if (availablecontentType) {
+        return [availablecontentType, responseBody.content[availablecontentType], ...responseBody.description ? [responseBody.description] : []];
+      }
+      return false;
+    };
+  }
+  getResponseSchema(operation, statusCode) {
+    if (operation.schema.responses) {
+      Object.keys(operation.schema.responses).forEach((key) => {
+        const schema2 = operation.schema.responses[key];
+        const $ref = isReference(schema2) ? schema2.$ref : void 0;
+        if (schema2 && $ref) {
+          operation.schema.responses[key] = this.get($ref);
+        }
+      });
+    }
+    const getResponseBody = this.#getResponseBodyFactory(operation.getResponseByStatusCode(statusCode));
+    const { contentType } = this.#options;
+    const responseBody = getResponseBody(contentType);
+    if (responseBody === false) {
+      return {};
+    }
+    const schema = Array.isArray(responseBody) ? responseBody[1].schema : responseBody.schema;
+    if (!schema) {
+      return {};
+    }
+    return this.dereferenceWithRef(schema);
+  }
+  getRequestSchema(operation) {
+    const { contentType } = this.#options;
+    if (operation.schema.requestBody) {
+      operation.schema.requestBody = this.dereferenceWithRef(operation.schema.requestBody);
+    }
+    const requestBody = operation.getRequestBody(contentType);
+    if (requestBody === false) {
+      return void 0;
+    }
+    const schema = Array.isArray(requestBody) ? requestBody[1].schema : requestBody.schema;
+    if (!schema) {
+      return void 0;
+    }
+    return this.dereferenceWithRef(schema);
+  }
+  getParametersSchema(operation, inKey) {
+    const { contentType = operation.getContentType() } = this.#options;
+    const params = operation.getParameters().map((schema) => {
+      return this.dereferenceWithRef(schema);
+    }).filter((v) => v.in === inKey);
+    if (!params.length) {
+      return null;
+    }
+    return params.reduce(
+      (schema, pathParameters) => {
+        const property = pathParameters.content?.[contentType]?.schema ?? pathParameters.schema;
+        const required = [...schema.required || [], pathParameters.required ? pathParameters.name : void 0].filter(Boolean);
+        return {
+          ...schema,
+          description: schema.description,
+          deprecated: schema.deprecated,
+          example: schema.example,
+          required,
+          properties: {
+            ...schema.properties,
+            [pathParameters.name]: {
+              description: pathParameters.description,
+              ...property
+            }
+          }
+        };
+      },
+      { type: "object", required: [], properties: {} }
+    );
+  }
+  async valdiate() {
+    const oasNormalize = new OASNormalize(this.api, {
+      enablePaths: true,
+      colorizeErrors: true
+    });
+    await oasNormalize.validate({
+      convertToLatest: true,
+      parser: {
+        validate: {
+          colorizeErrors: true
+        }
+      }
+    });
+  }
+};
+
+// src/utils.ts
+function isOpenApiV2Document(doc) {
+  return doc && isPlainObject(doc) && !("openapi" in doc);
+}
+function isOpenApiV3_1Document(doc) {
+  return doc && isPlainObject(doc) && "openapi" in doc && doc.openapi.startsWith("3.1");
+}
+function isParameterObject(obj) {
+  return obj && "in" in obj;
+}
+function isReference(obj) {
+  return !!obj && isRef(obj);
+}
+function isRequired(schema) {
+  if (!schema) {
+    return false;
+  }
+  return Array.isArray(schema.required) ? !!schema.required?.length : !!schema.required;
+}
+function isOptional(schema) {
+  return !isRequired(schema);
+}
+async function parse(pathOrApi, oasClass = Oas) {
+  if (typeof pathOrApi === "string") {
+    const config = await loadConfig();
+    const bundleResults = await bundle({ ref: pathOrApi, config, base: pathOrApi });
+    return parse(bundleResults.bundle.parsed);
+  }
+  const oasNormalize = new OASNormalize(pathOrApi, {
+    enablePaths: true,
+    colorizeErrors: true
+  });
+  const document = await oasNormalize.load();
+  if (isOpenApiV2Document(document)) {
+    const { openapi } = await swagger2openapi.convertObj(document, {
+      anchors: true
+    });
+    return new oasClass({ oas: openapi });
+  }
+  return new oasClass({ oas: document });
+}
 
-export { HttpMethods };
+export { HttpMethods, Oas, isOpenApiV3_1Document, isOptional, isParameterObject, isReference, isRequired, parse };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/types.ts"],"names":[],"mappings":";;;;AAeO,IAAM,WAAc,GAAA;AAAA,EACzB,GAAK,EAAA,KAAA;AAAA,EACL,IAAM,EAAA,MAAA;AAAA,EACN,GAAK,EAAA,KAAA;AAAA,EACL,KAAO,EAAA,OAAA;AAAA,EACP,MAAQ,EAAA,QAAA;AAAA,EACR,IAAM,EAAA,MAAA;AAAA,EACN,OAAS,EAAA,SAAA;AAAA,EACT,KAAO,EAAA;AACT","file":"index.js","sourcesContent":["import type * as OasTypes from 'oas/types'\n\n// external packages\nexport type { Operation } from 'oas/operation'\nexport type { HttpMethods as HttpMethod } from 'oas/types'\nexport type * as OasTypes from 'oas/types'\nexport type { OpenAPIV3, OpenAPIV3_1 } from 'openapi-types'\n\nexport type contentType = 'application/json' | (string & {})\n\nexport type SchemaObject = OasTypes.SchemaObject & {\n  'x-nullable'?: boolean\n  $ref?: string\n}\n\nexport const HttpMethods = {\n  GET: 'get',\n  POST: 'post',\n  PUT: 'put',\n  PATCH: 'patch',\n  DELETE: 'delete',\n  HEAD: 'head',\n  OPTIONS: 'options',\n  TRACE: 'trace',\n} satisfies Record<Uppercase<OasTypes.HttpMethods>, OasTypes.HttpMethods>\n"]}
+{"version":3,"sources":["../src/types.ts","../src/Oas.ts","../src/utils.ts"],"names":["schema","OASNormalize"],"mappings":";;;;;;;;;;;AAeO,IAAM,WAAc,GAAA;AAAA,EACzB,GAAK,EAAA,KAAA;AAAA,EACL,IAAM,EAAA,MAAA;AAAA,EACN,GAAK,EAAA,KAAA;AAAA,EACL,KAAO,EAAA,OAAA;AAAA,EACP,MAAQ,EAAA,QAAA;AAAA,EACR,IAAM,EAAA,MAAA;AAAA,EACN,OAAS,EAAA,SAAA;AAAA,EACT,KAAO,EAAA;AACT;ACPa,IAAA,GAAA,GAAN,cAAwC,OAAQ,CAAA;AAAA,EACrD,WAAoB,EAAC;AAAA,EACrB,QAAiB,GAAA,KAAA,CAAA;AAAA,EAEjB,YAAY,EAAE,GAAA,EAAK,MAA2D,EAAA,OAAA,GAAmB,EAAI,EAAA;AACnG,IAAI,IAAA,OAAO,QAAQ,QAAU,EAAA;AAC3B,MAAM,GAAA,GAAA,IAAA,CAAK,MAAM,GAAG,CAAA;AAAA;AAGtB,IAAA,KAAA,CAAM,KAAoB,IAAI,CAAA;AAE9B,IAAA,IAAA,CAAK,QAAW,GAAA,GAAA;AAChB,IAAA,IAAA,CAAK,QAAW,GAAA,OAAA;AAAA;AAClB,EAEA,IAAI,IAAc,EAAA;AAChB,IAAA,MAAM,OAAU,GAAA,IAAA;AAChB,IAAA,IAAA,GAAO,KAAK,IAAK,EAAA;AACjB,IAAA,IAAI,SAAS,EAAI,EAAA;AACf,MAAO,OAAA,KAAA;AAAA;AAET,IAAI,IAAA,IAAA,CAAK,UAAW,CAAA,GAAG,CAAG,EAAA;AACxB,MAAA,IAAA,GAAO,UAAW,CAAA,kBAAA,CAAmB,IAAK,CAAA,SAAA,CAAU,CAAC,CAAC,CAAA;AAAA,KACjD,MAAA;AACL,MAAO,OAAA,IAAA;AAAA;AAET,IAAA,MAAM,OAAU,GAAA,WAAA,CAAY,GAAI,CAAA,IAAA,CAAK,KAAK,IAAI,CAAA;AAE9C,IAAA,IAAI,CAAC,OAAS,EAAA;AACZ,MAAA,MAAM,IAAI,KAAA,CAAM,CAAmC,gCAAA,EAAA,OAAO,CAAG,CAAA,CAAA,CAAA;AAAA;AAE/D,IAAO,OAAA,OAAA;AAAA;AACT,EAEA,GAAA,CAAI,MAAc,KAAgB,EAAA;AAChC,IAAA,IAAA,GAAO,KAAK,IAAK,EAAA;AACjB,IAAA,IAAI,SAAS,EAAI,EAAA;AACf,MAAO,OAAA,KAAA;AAAA;AAET,IAAI,IAAA,IAAA,CAAK,UAAW,CAAA,GAAG,CAAG,EAAA;AACxB,MAAA,IAAA,GAAO,UAAW,CAAA,kBAAA,CAAmB,IAAK,CAAA,SAAA,CAAU,CAAC,CAAC,CAAA;AAEtD,MAAA,WAAA,CAAY,GAAI,CAAA,IAAA,CAAK,GAAK,EAAA,IAAA,EAAM,KAAK,CAAA;AAAA;AACvC;AACF,EAEA,qBAA8B,GAAA;AAC5B,IAAA,MAAM,OAAW,GAAA,IAAA,CAAK,GAAI,CAAA,UAAA,EAAY,WAAW,EAAC;AAElD,IAAO,MAAA,CAAA,OAAA,CAAQ,OAAO,CAAE,CAAA,OAAA,CAAQ,CAAC,CAAC,GAAA,EAAK,YAAY,CAAM,KAAA;AACvD,MAAA,IAAI,mBAAmB,YAAc,EAAA;AACnC,QAAM,MAAA,EAAE,UAAU,EAAC,EAAG,cAAkB,GAAA,YAAA,CAAa,iBAAiB,EAAC;AAEvE,QAAO,MAAA,CAAA,OAAA,CAAQ,OAAO,CAAE,CAAA,OAAA,CAAQ,CAAC,CAAC,UAAA,EAAY,YAAY,CAAM,KAAA;AAC9D,UAAA,IAAI,YAAc,EAAA;AAChB,YAAM,MAAA,WAAA,GAAc,IAAK,CAAA,GAAA,CAAI,YAAY,CAAA;AACzC,YAAM,MAAA,QAAA,GAAW,WAAY,CAAA,UAAA,GAAa,YAAY,CAAA;AAEtD,YAAA,IAAI,QAAU,EAAA;AACZ,cAAY,WAAA,CAAA,UAAA,CAAW,YAAY,CAAI,GAAA;AAAA,gBACrC,GAAG,WAAY,CAAA,UAAA,CAAW,YAAY,CAAA;AAAA,gBACtC,IAAM,EAAA,CAAC,GAAI,QAAA,EAAU,IAAM,EAAA,MAAA,CAAO,CAAC,KAAA,KAAU,KAAU,KAAA,UAAU,CAAK,IAAA,IAAK,UAAU;AAAA,eACvF;AAEA,cAAA,WAAA,CAAY,WAAW,CAAC,GAAI,YAAY,QAAY,IAAA,IAAK,YAAY,CAAA;AAErE,cAAK,IAAA,CAAA,GAAA,CAAI,cAAc,WAAW,CAAA;AAAA;AACpC;AACF,SACD,CAAA;AAAA;AACH,KACD,CAAA;AAAA;AACH,EAEA,mBAAmB,MAAkB,EAAA;AACnC,IAAI,IAAA,WAAA,CAAY,MAAM,CAAG,EAAA;AACvB,MAAO,OAAA;AAAA,QACL,GAAG,IAAA,CAAK,GAAI,CAAA,MAAA,CAAO,IAAI,CAAA;AAAA,QACvB,MAAM,MAAO,CAAA;AAAA,OACf;AAAA;AAGF,IAAO,OAAA,MAAA;AAAA;AACT;AAAA;AAAA;AAAA,EAKA,wBAAwB,YAAoI,EAAA;AAC1J,IAAS,SAAA,eAAA,CAAgB,MAAM,YAAqC,EAAA;AAClE,MAAA,OAAO,CAAC,CAAC,GAAA;AAAA;AAGX,IAAA,OAAO,CAAC,WAAgB,KAAA;AACtB,MAAI,IAAA,CAAC,eAAgB,CAAA,YAAY,CAAG,EAAA;AAClC,QAAO,OAAA,KAAA;AAAA;AAGT,MAAI,IAAA,WAAA,CAAY,YAAY,CAAG,EAAA;AAG7B,QAAO,OAAA,KAAA;AAAA;AAGT,MAAI,IAAA,CAAC,aAAa,OAAS,EAAA;AACzB,QAAO,OAAA,KAAA;AAAA;AAGT,MAAA,IAAI,WAAa,EAAA;AACf,QAAI,IAAA,EAAE,WAAe,IAAA,YAAA,CAAa,OAAU,CAAA,EAAA;AAC1C,UAAO,OAAA,KAAA;AAAA;AAGT,QAAO,OAAA,YAAA,CAAa,QAAQ,WAAW,CAAA;AAAA;AAKzC,MAAA,IAAI,oBAA2C,GAAA,KAAA,CAAA;AAC/C,MAAA,MAAM,YAAe,GAAA,MAAA,CAAO,IAAK,CAAA,YAAA,CAAa,OAAO,CAAA;AACrD,MAAa,YAAA,CAAA,OAAA,CAAQ,CAAC,EAAe,KAAA;AACnC,QAAA,IAAI,CAAC,oBAAA,IAAwB,eAAgB,CAAA,IAAA,CAAK,EAAE,CAAG,EAAA;AACrD,UAAuB,oBAAA,GAAA,EAAA;AAAA;AACzB,OACD,CAAA;AAED,MAAA,IAAI,CAAC,oBAAsB,EAAA;AACzB,QAAa,YAAA,CAAA,OAAA,CAAQ,CAAC,EAAe,KAAA;AACnC,UAAA,IAAI,CAAC,oBAAsB,EAAA;AACzB,YAAuB,oBAAA,GAAA,EAAA;AAAA;AACzB,SACD,CAAA;AAAA;AAGH,MAAA,IAAI,oBAAsB,EAAA;AACxB,QAAA,OAAO,CAAC,oBAAA,EAAsB,YAAa,CAAA,OAAA,CAAQ,oBAAoB,CAAI,EAAA,GAAI,YAAa,CAAA,WAAA,GAAc,CAAC,YAAA,CAAa,WAAW,CAAA,GAAI,EAAG,CAAA;AAAA;AAG5I,MAAO,OAAA,KAAA;AAAA,KACT;AAAA;AACF,EAEA,iBAAA,CAAkB,WAAsB,UAA2C,EAAA;AACjF,IAAI,IAAA,SAAA,CAAU,OAAO,SAAW,EAAA;AAC9B,MAAA,MAAA,CAAO,KAAK,SAAU,CAAA,MAAA,CAAO,SAAS,CAAE,CAAA,OAAA,CAAQ,CAAC,GAAQ,KAAA;AACvD,QAAA,MAAMA,OAAS,GAAA,SAAA,CAAU,MAAO,CAAA,SAAA,CAAW,GAAG,CAAA;AAC9C,QAAA,MAAM,IAAO,GAAA,WAAA,CAAYA,OAAM,CAAA,GAAIA,QAAO,IAAO,GAAA,KAAA,CAAA;AAEjD,QAAA,IAAIA,WAAU,IAAM,EAAA;AAClB,UAAA,SAAA,CAAU,OAAO,SAAW,CAAA,GAAG,CAAI,GAAA,IAAA,CAAK,IAAI,IAAI,CAAA;AAAA;AAClD,OACD,CAAA;AAAA;AAGH,IAAA,MAAM,kBAAkB,IAAK,CAAA,uBAAA,CAAwB,SAAU,CAAA,uBAAA,CAAwB,UAAU,CAAC,CAAA;AAElG,IAAM,MAAA,EAAE,WAAY,EAAA,GAAI,IAAK,CAAA,QAAA;AAC7B,IAAM,MAAA,YAAA,GAAe,gBAAgB,WAAW,CAAA;AAEhD,IAAA,IAAI,iBAAiB,KAAO,EAAA;AAE1B,MAAA,OAAO,EAAC;AAAA;AAGV,IAAM,MAAA,MAAA,GAAS,MAAM,OAAQ,CAAA,YAAY,IAAI,YAAa,CAAA,CAAC,CAAE,CAAA,MAAA,GAAS,YAAa,CAAA,MAAA;AAEnF,IAAA,IAAI,CAAC,MAAQ,EAAA;AAGX,MAAA,OAAO,EAAC;AAAA;AAGV,IAAO,OAAA,IAAA,CAAK,mBAAmB,MAAM,CAAA;AAAA;AACvC,EAEA,iBAAiB,SAAgD,EAAA;AAC/D,IAAM,MAAA,EAAE,WAAY,EAAA,GAAI,IAAK,CAAA,QAAA;AAE7B,IAAI,IAAA,SAAA,CAAU,OAAO,WAAa,EAAA;AAChC,MAAA,SAAA,CAAU,OAAO,WAAc,GAAA,IAAA,CAAK,kBAAmB,CAAA,SAAA,CAAU,OAAO,WAAW,CAAA;AAAA;AAGrF,IAAM,MAAA,WAAA,GAAc,SAAU,CAAA,cAAA,CAAe,WAAW,CAAA;AAExD,IAAA,IAAI,gBAAgB,KAAO,EAAA;AACzB,MAAO,OAAA,KAAA,CAAA;AAAA;AAGT,IAAM,MAAA,MAAA,GAAS,MAAM,OAAQ,CAAA,WAAW,IAAI,WAAY,CAAA,CAAC,CAAE,CAAA,MAAA,GAAS,WAAY,CAAA,MAAA;AAEhF,IAAA,IAAI,CAAC,MAAQ,EAAA;AACX,MAAO,OAAA,KAAA,CAAA;AAAA;AAGT,IAAO,OAAA,IAAA,CAAK,mBAAmB,MAAM,CAAA;AAAA;AACvC,EAEA,mBAAA,CAAoB,WAAsB,KAAyD,EAAA;AACjG,IAAA,MAAM,EAAE,WAAc,GAAA,SAAA,CAAU,cAAe,EAAA,KAAM,IAAK,CAAA,QAAA;AAC1D,IAAA,MAAM,SAAS,SACZ,CAAA,aAAA,EACA,CAAA,GAAA,CAAI,CAAC,MAAW,KAAA;AACf,MAAO,OAAA,IAAA,CAAK,mBAAmB,MAAM,CAAA;AAAA,KACtC,CACA,CAAA,MAAA,CAAO,CAAC,CAAM,KAAA,CAAA,CAAE,OAAO,KAAK,CAAA;AAE/B,IAAI,IAAA,CAAC,OAAO,MAAQ,EAAA;AAClB,MAAO,OAAA,IAAA;AAAA;AAGT,IAAA,OAAO,MAAO,CAAA,MAAA;AAAA,MACZ,CAAC,QAAQ,cAAmB,KAAA;AAC1B,QAAA,MAAM,WAAW,cAAe,CAAA,OAAA,GAAU,WAAW,CAAA,EAAG,UAAW,cAAe,CAAA,MAAA;AAClF,QAAA,MAAM,QAAW,GAAA,CAAC,GAAI,MAAA,CAAO,YAAa,EAAC,EAAY,cAAe,CAAA,QAAA,GAAW,cAAe,CAAA,IAAA,GAAO,KAAS,CAAA,CAAA,CAAE,OAAO,OAAO,CAAA;AAEhI,QAAO,OAAA;AAAA,UACL,GAAG,MAAA;AAAA,UACH,aAAa,MAAO,CAAA,WAAA;AAAA,UACpB,YAAY,MAAO,CAAA,UAAA;AAAA,UACnB,SAAS,MAAO,CAAA,OAAA;AAAA,UAChB,QAAA;AAAA,UACA,UAAY,EAAA;AAAA,YACV,GAAG,MAAO,CAAA,UAAA;AAAA,YACV,CAAC,cAAe,CAAA,IAAI,GAAG;AAAA,cACrB,aAAa,cAAe,CAAA,WAAA;AAAA,cAC5B,GAAG;AAAA;AACL;AACF,SACF;AAAA,OACF;AAAA,MACA,EAAE,MAAM,QAAU,EAAA,QAAA,EAAU,EAAI,EAAA,UAAA,EAAY,EAAG;AAAA,KACjD;AAAA;AACF,EAEA,MAAM,QAAW,GAAA;AACf,IAAA,MAAM,YAAe,GAAA,IAAI,YAAa,CAAA,IAAA,CAAK,GAAK,EAAA;AAAA,MAC9C,WAAa,EAAA,IAAA;AAAA,MACb,cAAgB,EAAA;AAAA,KACjB,CAAA;AAED,IAAA,MAAM,aAAa,QAAS,CAAA;AAAA,MAC1B,eAAiB,EAAA,IAAA;AAAA,MACjB,MAAQ,EAAA;AAAA,QACN,QAAU,EAAA;AAAA,UACR,cAAgB,EAAA;AAAA;AAClB;AACF,KACD,CAAA;AAAA;AAEL;;;AC/PO,SAAS,oBAAoB,GAAqC,EAAA;AACvE,EAAA,OAAO,GAAO,IAAA,aAAA,CAAc,GAAG,CAAA,IAAK,EAAE,SAAa,IAAA,GAAA,CAAA;AACrD;AAKO,SAAS,sBAAsB,GAAuC,EAAA;AAC3E,EAAO,OAAA,GAAA,IAAO,cAAoC,GAAG,CAAA,IAAK,aAAa,GAAO,IAAA,GAAA,CAAI,OAAQ,CAAA,UAAA,CAAW,KAAK,CAAA;AAC5G;AAMO,SAAS,kBAAkB,GAA6D,EAAA;AAC7F,EAAA,OAAO,OAAO,IAAQ,IAAA,GAAA;AACxB;AAEO,SAAS,YAAY,GAA+E,EAAA;AACzG,EAAA,OAAO,CAAC,CAAC,GAAO,IAAA,KAAA,CAAM,GAAG,CAAA;AAC3B;AAEO,SAAS,WAAW,MAAgC,EAAA;AACzD,EAAA,IAAI,CAAC,MAAQ,EAAA;AACX,IAAO,OAAA,KAAA;AAAA;AAGT,EAAA,OAAO,KAAM,CAAA,OAAA,CAAQ,MAAO,CAAA,QAAQ,CAAI,GAAA,CAAC,CAAC,MAAA,CAAO,QAAU,EAAA,MAAA,GAAS,CAAC,CAAC,MAAO,CAAA,QAAA;AAC/E;AAEO,SAAS,WAAW,MAAgC,EAAA;AACzD,EAAO,OAAA,CAAC,WAAW,MAAM,CAAA;AAC3B;AAEA,eAAsB,KAAA,CAAM,SAAiC,EAAA,QAAA,GAAuB,GAAmB,EAAA;AACrG,EAAI,IAAA,OAAO,cAAc,QAAU,EAAA;AAEjC,IAAM,MAAA,MAAA,GAAS,MAAM,UAAW,EAAA;AAChC,IAAM,MAAA,aAAA,GAAgB,MAAM,MAAO,CAAA,EAAE,KAAK,SAAW,EAAA,MAAA,EAAQ,IAAM,EAAA,SAAA,EAAW,CAAA;AAE9E,IAAO,OAAA,KAAA,CAAM,aAAc,CAAA,MAAA,CAAO,MAAM,CAAA;AAAA;AAG1C,EAAM,MAAA,YAAA,GAAe,IAAIC,YAAAA,CAAa,SAAW,EAAA;AAAA,IAC/C,WAAa,EAAA,IAAA;AAAA,IACb,cAAgB,EAAA;AAAA,GACjB,CAAA;AACD,EAAM,MAAA,QAAA,GAAY,MAAM,YAAA,CAAa,IAAK,EAAA;AAE1C,EAAI,IAAA,mBAAA,CAAoB,QAAQ,CAAG,EAAA;AACjC,IAAA,MAAM,EAAE,OAAQ,EAAA,GAAI,MAAM,eAAA,CAAgB,WAAW,QAAU,EAAA;AAAA,MAC7D,OAAS,EAAA;AAAA,KACV,CAAA;AAED,IAAA,OAAO,IAAI,QAAA,CAAS,EAAE,GAAA,EAAK,SAAwB,CAAA;AAAA;AAGrD,EAAA,OAAO,IAAI,QAAA,CAAS,EAAE,GAAA,EAAK,UAAU,CAAA;AACvC","file":"index.js","sourcesContent":["import type * as OasTypes from 'oas/types'\n\n// external packages\nexport type { Operation } from 'oas/operation'\nexport type { HttpMethods as HttpMethod } from 'oas/types'\nexport type * as OasTypes from 'oas/types'\nexport type { OpenAPIV3, OpenAPIV3_1 } from 'openapi-types'\n\nexport type contentType = 'application/json' | (string & {})\n\nexport type SchemaObject = OasTypes.SchemaObject & {\n  'x-nullable'?: boolean\n  $ref?: string\n}\n\nexport const HttpMethods = {\n  GET: 'get',\n  POST: 'post',\n  PUT: 'put',\n  PATCH: 'patch',\n  DELETE: 'delete',\n  HEAD: 'head',\n  OPTIONS: 'options',\n  TRACE: 'trace',\n} satisfies Record<Uppercase<OasTypes.HttpMethods>, OasTypes.HttpMethods>\n","import BaseOas from 'oas'\nimport OASNormalize from 'oas-normalize'\nimport { matchesMimeType } from 'oas/utils'\n\nimport jsonpointer from 'jsonpointer'\n\nimport { isReference } from './utils.ts'\n\nimport type { Operation } from 'oas/operation'\nimport type { MediaTypeObject, OASDocument, ResponseObject, SchemaObject, User } from 'oas/types'\nimport type { OasTypes, OpenAPIV3 } from './index.ts'\nimport type { contentType } from './types.ts'\n\ntype Options = {\n  contentType?: contentType\n}\n\nexport class Oas<const TOAS = unknown> extends BaseOas {\n  #options: Options = {}\n  document: TOAS = undefined as unknown as TOAS\n\n  constructor({ oas, user }: { oas: TOAS | OASDocument | string; user?: User }, options: Options = {}) {\n    if (typeof oas === 'string') {\n      oas = JSON.parse(oas)\n    }\n\n    super(oas as OASDocument, user)\n\n    this.document = oas as TOAS\n    this.#options = options\n  }\n\n  get($ref: string) {\n    const origRef = $ref\n    $ref = $ref.trim()\n    if ($ref === '') {\n      return false\n    }\n    if ($ref.startsWith('#')) {\n      $ref = globalThis.decodeURIComponent($ref.substring(1))\n    } else {\n      return null\n    }\n    const current = jsonpointer.get(this.api, $ref)\n\n    if (!current) {\n      throw new Error(`Could not find a definition for ${origRef}.`)\n    }\n    return current\n  }\n\n  set($ref: string, value: unknown) {\n    $ref = $ref.trim()\n    if ($ref === '') {\n      return false\n    }\n    if ($ref.startsWith('#')) {\n      $ref = globalThis.decodeURIComponent($ref.substring(1))\n\n      jsonpointer.set(this.api, $ref, value)\n    }\n  }\n\n  resolveDiscriminators(): void {\n    const schemas = (this.api.components?.schemas || {}) as Record<string, OasTypes.SchemaObject>\n\n    Object.entries(schemas).forEach(([key, schemaObject]) => {\n      if ('discriminator' in schemaObject) {\n        const { mapping = {}, propertyName } = (schemaObject.discriminator || {}) as OpenAPIV3.DiscriminatorObject\n\n        Object.entries(mapping).forEach(([mappingKey, mappingValue]) => {\n          if (mappingValue) {\n            const childSchema = this.get(mappingValue)\n            const property = childSchema.properties?.[propertyName] as SchemaObject\n\n            if (property) {\n              childSchema.properties[propertyName] = {\n                ...childSchema.properties[propertyName],\n                enum: [...(property?.enum?.filter((value) => value !== mappingKey) ?? []), mappingKey],\n              }\n\n              childSchema.required = [...(childSchema.required ?? []), propertyName]\n\n              this.set(mappingValue, childSchema)\n            }\n          }\n        })\n      }\n    })\n  }\n\n  dereferenceWithRef(schema?: unknown) {\n    if (isReference(schema)) {\n      return {\n        ...this.get(schema.$ref),\n        $ref: schema.$ref,\n      }\n    }\n\n    return schema\n  }\n\n  /**\n   * Oas does not have a getResponseBody(contentType)\n   */\n  #getResponseBodyFactory(responseBody: boolean | ResponseObject): (contentType?: string) => MediaTypeObject | false | [string, MediaTypeObject, ...string[]] {\n    function hasResponseBody(res = responseBody): res is ResponseObject {\n      return !!res\n    }\n\n    return (contentType) => {\n      if (!hasResponseBody(responseBody)) {\n        return false\n      }\n\n      if (isReference(responseBody)) {\n        // If the request body is still a `$ref` pointer we should return false because this library\n        // assumes that you've run dereferencing beforehand.\n        return false\n      }\n\n      if (!responseBody.content) {\n        return false\n      }\n\n      if (contentType) {\n        if (!(contentType in responseBody.content)) {\n          return false\n        }\n\n        return responseBody.content[contentType]!\n      }\n\n      // Since no media type was supplied we need to find either the first JSON-like media type that\n      // we've got, or the first available of anything else if no JSON-like media types are present.\n      let availablecontentType: string | undefined = undefined\n      const contentTypes = Object.keys(responseBody.content)\n      contentTypes.forEach((mt: string) => {\n        if (!availablecontentType && matchesMimeType.json(mt)) {\n          availablecontentType = mt\n        }\n      })\n\n      if (!availablecontentType) {\n        contentTypes.forEach((mt: string) => {\n          if (!availablecontentType) {\n            availablecontentType = mt\n          }\n        })\n      }\n\n      if (availablecontentType) {\n        return [availablecontentType, responseBody.content[availablecontentType]!, ...(responseBody.description ? [responseBody.description] : [])]\n      }\n\n      return false\n    }\n  }\n\n  getResponseSchema(operation: Operation, statusCode: string | number): SchemaObject {\n    if (operation.schema.responses) {\n      Object.keys(operation.schema.responses).forEach((key) => {\n        const schema = operation.schema.responses![key]\n        const $ref = isReference(schema) ? schema.$ref : undefined\n\n        if (schema && $ref) {\n          operation.schema.responses![key] = this.get($ref)\n        }\n      })\n    }\n\n    const getResponseBody = this.#getResponseBodyFactory(operation.getResponseByStatusCode(statusCode))\n\n    const { contentType } = this.#options\n    const responseBody = getResponseBody(contentType)\n\n    if (responseBody === false) {\n      // return empty object because response will always be defined(request does not need a body)\n      return {}\n    }\n\n    const schema = Array.isArray(responseBody) ? responseBody[1].schema : responseBody.schema\n\n    if (!schema) {\n      // return empty object because response will always be defined(request does not need a body)\n\n      return {}\n    }\n\n    return this.dereferenceWithRef(schema)\n  }\n\n  getRequestSchema(operation: Operation): SchemaObject | undefined {\n    const { contentType } = this.#options\n\n    if (operation.schema.requestBody) {\n      operation.schema.requestBody = this.dereferenceWithRef(operation.schema.requestBody)\n    }\n\n    const requestBody = operation.getRequestBody(contentType)\n\n    if (requestBody === false) {\n      return undefined\n    }\n\n    const schema = Array.isArray(requestBody) ? requestBody[1].schema : requestBody.schema\n\n    if (!schema) {\n      return undefined\n    }\n\n    return this.dereferenceWithRef(schema)\n  }\n\n  getParametersSchema(operation: Operation, inKey: 'path' | 'query' | 'header'): SchemaObject | null {\n    const { contentType = operation.getContentType() } = this.#options\n    const params = operation\n      .getParameters()\n      .map((schema) => {\n        return this.dereferenceWithRef(schema)\n      })\n      .filter((v) => v.in === inKey)\n\n    if (!params.length) {\n      return null\n    }\n\n    return params.reduce(\n      (schema, pathParameters) => {\n        const property = pathParameters.content?.[contentType]?.schema ?? (pathParameters.schema as SchemaObject)\n        const required = [...(schema.required || ([] as any)), pathParameters.required ? pathParameters.name : undefined].filter(Boolean)\n\n        return {\n          ...schema,\n          description: schema.description,\n          deprecated: schema.deprecated,\n          example: schema.example,\n          required,\n          properties: {\n            ...schema.properties,\n            [pathParameters.name]: {\n              description: pathParameters.description,\n              ...property,\n            },\n          },\n        }\n      },\n      { type: 'object', required: [], properties: {} } as SchemaObject,\n    )\n  }\n\n  async valdiate() {\n    const oasNormalize = new OASNormalize(this.api, {\n      enablePaths: true,\n      colorizeErrors: true,\n    })\n\n    await oasNormalize.validate({\n      convertToLatest: true,\n      parser: {\n        validate: {\n          colorizeErrors: true,\n        },\n      },\n    })\n  }\n}\n","import { isRef, isSchema } from 'oas/types'\nimport { isPlainObject } from 'remeda'\n\nimport { bundle, loadConfig } from '@redocly/openapi-core'\nimport OASNormalize from 'oas-normalize'\nimport type { OASDocument } from 'oas/types'\nimport type { ParameterObject, SchemaObject } from 'oas/types'\nimport type { OpenAPI, OpenAPIV2, OpenAPIV3, OpenAPIV3_1 } from 'openapi-types'\nimport swagger2openapi from 'swagger2openapi'\nimport { Oas } from './Oas.ts'\n\nexport function isOpenApiV2Document(doc: any): doc is OpenAPIV2.Document {\n  return doc && isPlainObject(doc) && !('openapi' in doc)\n}\nexport function isOpenApiV3Document(doc: any): doc is OpenAPIV3.Document {\n  return doc && isPlainObject(doc) && 'openapi' in doc\n}\n\nexport function isOpenApiV3_1Document(doc: any): doc is OpenAPIV3_1.Document {\n  return doc && isPlainObject<OpenAPIV3_1.Document>(doc) && 'openapi' in doc && doc.openapi.startsWith('3.1')\n}\n\nexport function isJSONSchema(obj?: unknown): obj is SchemaObject {\n  return !!obj && isSchema(obj)\n}\n\nexport function isParameterObject(obj: ParameterObject | SchemaObject): obj is ParameterObject {\n  return obj && 'in' in obj\n}\n\nexport function isReference(obj?: unknown): obj is OpenAPIV3.ReferenceObject | OpenAPIV3_1.ReferenceObject {\n  return !!obj && isRef(obj)\n}\n\nexport function isRequired(schema?: SchemaObject): boolean {\n  if (!schema) {\n    return false\n  }\n\n  return Array.isArray(schema.required) ? !!schema.required?.length : !!schema.required\n}\n\nexport function isOptional(schema?: SchemaObject): boolean {\n  return !isRequired(schema)\n}\n\nexport async function parse(pathOrApi: string | OASDocument, oasClass: typeof Oas = Oas): Promise<Oas> {\n  if (typeof pathOrApi === 'string') {\n    // resolve external refs\n    const config = await loadConfig()\n    const bundleResults = await bundle({ ref: pathOrApi, config, base: pathOrApi })\n\n    return parse(bundleResults.bundle.parsed)\n  }\n\n  const oasNormalize = new OASNormalize(pathOrApi, {\n    enablePaths: true,\n    colorizeErrors: true,\n  })\n  const document = (await oasNormalize.load()) as OpenAPI.Document\n\n  if (isOpenApiV2Document(document)) {\n    const { openapi } = await swagger2openapi.convertObj(document, {\n      anchors: true,\n    })\n\n    return new oasClass({ oas: openapi as OASDocument })\n  }\n\n  return new oasClass({ oas: document })\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/oas",
-  "version": "3.2.0",
+  "version": "3.3.1",
   "description": "Oas helpers",
   "keywords": [
     "typescript",
@@ -23,11 +23,6 @@
       "require": "./dist/index.cjs",
       "default": "./dist/index.cjs"
     },
-    "./parser": {
-      "import": "./dist/parser.js",
-      "require": "./dist/parser.cjs",
-      "default": "./dist/parser.cjs"
-    },
     "./infer": {
       "import": "./dist/infer.js",
       "require": "./dist/infer.cjs",
@@ -41,9 +36,6 @@
   "types": "./dist/index.d.cts",
   "typesVersions": {
     "*": {
-      "parser": [
-        "./dist/parser.d.ts"
-      ],
       "infer": [
         "./dist/infer.d.ts"
       ]
@@ -70,11 +62,11 @@
   "devDependencies": {
     "@stoplight/yaml": "^4.3.0",
     "@types/swagger2openapi": "^7.0.4",
-    "expect-type": "^0.20.0",
+    "expect-type": "^1.1.0",
     "tsup": "^8.3.5",
     "typescript": "^5.7.2",
-    "@kubb/config-ts": "3.2.0",
-    "@kubb/config-tsup": "3.2.0"
+    "@kubb/config-ts": "3.3.1",
+    "@kubb/config-tsup": "3.3.1"
   },
   "engines": {
     "node": ">=20"

package/src/index.ts

@@ -1,5 +1,5 @@
 export * from './types.ts'
 export { findSchemaDefinition, matchesMimeType } from 'oas/utils'
-export { isRequired, isOptional, isReference, isParameterObject, isOpenApiV3_1Document } from './utils.ts'
+export { isRequired, isOptional, isReference, isParameterObject, isOpenApiV3_1Document, parse } from './utils.ts'
 export { Oas } from './Oas.ts'
 export type { Infer, Model, RequestParams, Response } from './infer/index.ts'

package/src/utils.ts

@@ -1,8 +1,13 @@
 import { isRef, isSchema } from 'oas/types'
 import { isPlainObject } from 'remeda'
 
+import { bundle, loadConfig } from '@redocly/openapi-core'
+import OASNormalize from 'oas-normalize'
+import type { OASDocument } from 'oas/types'
 import type { ParameterObject, SchemaObject } from 'oas/types'
-import type { OpenAPIV2, OpenAPIV3, OpenAPIV3_1 } from 'openapi-types'
+import type { OpenAPI, OpenAPIV2, OpenAPIV3, OpenAPIV3_1 } from 'openapi-types'
+import swagger2openapi from 'swagger2openapi'
+import { Oas } from './Oas.ts'
 
 export function isOpenApiV2Document(doc: any): doc is OpenAPIV2.Document {
   return doc && isPlainObject(doc) && !('openapi' in doc)
@@ -38,3 +43,29 @@ export function isRequired(schema?: SchemaObject): boolean {
 export function isOptional(schema?: SchemaObject): boolean {
   return !isRequired(schema)
 }
+
+export async function parse(pathOrApi: string | OASDocument, oasClass: typeof Oas = Oas): Promise<Oas> {
+  if (typeof pathOrApi === 'string') {
+    // resolve external refs
+    const config = await loadConfig()
+    const bundleResults = await bundle({ ref: pathOrApi, config, base: pathOrApi })
+
+    return parse(bundleResults.bundle.parsed)
+  }
+
+  const oasNormalize = new OASNormalize(pathOrApi, {
+    enablePaths: true,
+    colorizeErrors: true,
+  })
+  const document = (await oasNormalize.load()) as OpenAPI.Document
+
+  if (isOpenApiV2Document(document)) {
+    const { openapi } = await swagger2openapi.convertObj(document, {
+      anchors: true,
+    })
+
+    return new oasClass({ oas: openapi as OASDocument })
+  }
+
+  return new oasClass({ oas: document })
+}

package/dist/Oas-Br0yKhGF.d.cts

@@ -1,42 +0,0 @@
-import BaseOas from 'oas';
-import { Operation } from 'oas/operation';
-import * as OasTypes from 'oas/types';
-import { OASDocument, User, SchemaObject as SchemaObject$1 } from 'oas/types';
-
-type contentType = 'application/json' | (string & {});
-type SchemaObject = OasTypes.SchemaObject & {
-    'x-nullable'?: boolean;
-    $ref?: string;
-};
-declare const HttpMethods: {
-    GET: "get";
-    POST: "post";
-    PUT: "put";
-    PATCH: "patch";
-    DELETE: "delete";
-    HEAD: "head";
-    OPTIONS: "options";
-    TRACE: "trace";
-};
-
-type Options = {
-    contentType?: contentType;
-};
-declare class Oas<const TOAS = unknown> extends BaseOas {
-    #private;
-    document: TOAS;
-    constructor({ oas, user }: {
-        oas: TOAS | OASDocument | string;
-        user?: User;
-    }, options?: Options);
-    get($ref: string): any;
-    set($ref: string, value: unknown): false | undefined;
-    resolveDiscriminators(): void;
-    dereferenceWithRef(schema?: unknown): any;
-    getResponseSchema(operation: Operation, statusCode: string | number): SchemaObject$1;
-    getRequestSchema(operation: Operation): SchemaObject$1 | undefined;
-    getParametersSchema(operation: Operation, inKey: 'path' | 'query' | 'header'): SchemaObject$1 | null;
-    valdiate(): Promise<void>;
-}
-
-export { HttpMethods as H, Oas as O, type SchemaObject as S, type contentType as c };

package/dist/Oas-Br0yKhGF.d.ts

@@ -1,42 +0,0 @@
-import BaseOas from 'oas';
-import { Operation } from 'oas/operation';
-import * as OasTypes from 'oas/types';
-import { OASDocument, User, SchemaObject as SchemaObject$1 } from 'oas/types';
-
-type contentType = 'application/json' | (string & {});
-type SchemaObject = OasTypes.SchemaObject & {
-    'x-nullable'?: boolean;
-    $ref?: string;
-};
-declare const HttpMethods: {
-    GET: "get";
-    POST: "post";
-    PUT: "put";
-    PATCH: "patch";
-    DELETE: "delete";
-    HEAD: "head";
-    OPTIONS: "options";
-    TRACE: "trace";
-};
-
-type Options = {
-    contentType?: contentType;
-};
-declare class Oas<const TOAS = unknown> extends BaseOas {
-    #private;
-    document: TOAS;
-    constructor({ oas, user }: {
-        oas: TOAS | OASDocument | string;
-        user?: User;
-    }, options?: Options);
-    get($ref: string): any;
-    set($ref: string, value: unknown): false | undefined;
-    resolveDiscriminators(): void;
-    dereferenceWithRef(schema?: unknown): any;
-    getResponseSchema(operation: Operation, statusCode: string | number): SchemaObject$1;
-    getRequestSchema(operation: Operation): SchemaObject$1 | undefined;
-    getParametersSchema(operation: Operation, inKey: 'path' | 'query' | 'header'): SchemaObject$1 | null;
-    valdiate(): Promise<void>;
-}
-
-export { HttpMethods as H, Oas as O, type SchemaObject as S, type contentType as c };