@kubb/oas 2.14.0 → 2.16.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -23,7 +23,8 @@ var __privateMethod = (obj, member, method) => {
23
23
 
24
24
  // src/utils.ts
25
25
  import { isRef, isSchema } from "oas/types";
26
- import { isObject } from "remeda";
26
+ import openapiFormat from "openapi-format";
27
+ import { isObject, mergeDeep } from "remeda";
27
28
  function isOpenApiV2Document(doc) {
28
29
  return doc && isObject(doc) && !("openapi" in doc);
29
30
  }
@@ -42,6 +43,42 @@ function isRequired(schema) {
42
43
  }
43
44
  return Array.isArray(schema.required) ? !!schema.required?.length : !!schema.required;
44
45
  }
46
+ async function filterAndSort(data, options = {}) {
47
+ const mergedOptions = mergeDeep(
48
+ {
49
+ sort: true,
50
+ sortSet: {
51
+ root: ["openapi", "info", "servers", "paths", "components", "tags", "x-tagGroups", "externalDocs"],
52
+ get: ["operationId", "summary", "description", "parameters", "requestBody", "responses"],
53
+ post: ["operationId", "summary", "description", "parameters", "requestBody", "responses"],
54
+ put: ["operationId", "summary", "description", "parameters", "requestBody", "responses"],
55
+ patch: ["operationId", "summary", "description", "parameters", "requestBody", "responses"],
56
+ delete: ["operationId", "summary", "description", "parameters", "requestBody", "responses"],
57
+ parameters: ["name", "in", "description", "required", "schema"],
58
+ requestBody: ["description", "required", "content"],
59
+ responses: ["description", "headers", "content", "links"],
60
+ content: [],
61
+ components: ["parameters", "schemas"],
62
+ schema: ["description", "type", "items", "properties", "format", "example", "default"],
63
+ schemas: ["description", "type", "items", "properties", "format", "example", "default"],
64
+ properties: ["description", "type", "items", "format", "example", "default", "enum"]
65
+ },
66
+ sortComponentsSet: {},
67
+ filterSet: {
68
+ unusedComponents: options.filterSet ? ["requestBodies", "schemas", "parameters", "responses"] : []
69
+ },
70
+ casingSet: {}
71
+ },
72
+ options
73
+ );
74
+ const restFilter = await openapiFormat.openapiFilter(data, mergedOptions);
75
+ data = restFilter.data;
76
+ const resFormat = await openapiFormat.openapiSort(data, mergedOptions);
77
+ data = resFormat.data;
78
+ const resChangeCase = await openapiFormat.openapiChangeCase(data, mergedOptions);
79
+ data = resChangeCase.data;
80
+ return data;
81
+ }
45
82
 
46
83
  // src/Oas.ts
47
84
  import BaseOas from "oas";
@@ -196,6 +233,7 @@ export {
196
233
  isParameterObject,
197
234
  isReference,
198
235
  isRequired,
236
+ filterAndSort,
199
237
  Oas
200
238
  };
201
- //# sourceMappingURL=chunk-2SLQJGDM.js.map
239
+ //# sourceMappingURL=chunk-ADBW4NBH.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/utils.ts","../src/Oas.ts"],"sourcesContent":["import { isRef, isSchema } from 'oas/types'\nimport openapiFormat from 'openapi-format'\nimport { isObject, mergeDeep } from 'remeda'\n\nimport type { OASDocument, ParameterObject, SchemaObject } from 'oas/types'\nimport type { OpenAPIV2, OpenAPIV3, OpenAPIV3_1 } from 'openapi-types'\n\nexport function isOpenApiV2Document(doc: any): doc is OpenAPIV2.Document {\n return doc && isObject(doc) && !('openapi' in doc)\n}\nexport function isOpenApiV3Document(doc: any): doc is OpenAPIV3.Document {\n return doc && isObject(doc) && 'openapi' in doc\n}\n\nexport function isOpenApiV3_1Document(doc: any): doc is OpenAPIV3_1.Document {\n return doc && isObject(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 async function filterAndSort(data: OASDocument, options: openapiFormat.Options = {}): Promise<OASDocument> {\n const mergedOptions = mergeDeep(\n {\n sort: true,\n sortSet: {\n root: ['openapi', 'info', 'servers', 'paths', 'components', 'tags', 'x-tagGroups', 'externalDocs'],\n get: ['operationId', 'summary', 'description', 'parameters', 'requestBody', 'responses'],\n post: ['operationId', 'summary', 'description', 'parameters', 'requestBody', 'responses'],\n put: ['operationId', 'summary', 'description', 'parameters', 'requestBody', 'responses'],\n patch: ['operationId', 'summary', 'description', 'parameters', 'requestBody', 'responses'],\n delete: ['operationId', 'summary', 'description', 'parameters', 'requestBody', 'responses'],\n parameters: ['name', 'in', 'description', 'required', 'schema'],\n requestBody: ['description', 'required', 'content'],\n responses: ['description', 'headers', 'content', 'links'],\n content: [],\n components: ['parameters', 'schemas'],\n schema: ['description', 'type', 'items', 'properties', 'format', 'example', 'default'],\n schemas: ['description', 'type', 'items', 'properties', 'format', 'example', 'default'],\n properties: ['description', 'type', 'items', 'format', 'example', 'default', 'enum'],\n },\n sortComponentsSet: {},\n filterSet: {\n unusedComponents: options.filterSet ? ['requestBodies', 'schemas', 'parameters', 'responses'] : [],\n },\n casingSet: {},\n },\n options as Record<string, unknown>,\n ) as openapiFormat.Options\n\n const restFilter = await openapiFormat.openapiFilter(data, mergedOptions)\n data = restFilter.data\n\n const resFormat = await openapiFormat.openapiSort(data, mergedOptions)\n data = resFormat.data\n\n const resChangeCase = await openapiFormat.openapiChangeCase(data, mergedOptions)\n data = resChangeCase.data\n\n return data\n}\n","import BaseOas from 'oas'\nimport OASNormalize from 'oas-normalize'\nimport { findSchemaDefinition, matchesMimeType } from 'oas/utils'\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 { 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 dereferenceWithRef(schema?: unknown) {\n if (isReference(schema)) {\n return {\n ...findSchemaDefinition(schema.$ref, this.api),\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] = findSchemaDefinition($ref, this.api)\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 }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAAA,SAAS,OAAO,gBAAgB;AAChC,OAAO,mBAAmB;AAC1B,SAAS,UAAU,iBAAiB;AAK7B,SAAS,oBAAoB,KAAqC;AACvE,SAAO,OAAO,SAAS,GAAG,KAAK,EAAE,aAAa;AAChD;AAKO,SAAS,sBAAsB,KAAuC;AAC3E,SAAO,OAAO,SAAS,GAAG,KAAK,aAAa,OAAO,IAAI,QAAQ,WAAW,KAAK;AACjF;AAMO,SAAS,kBAAkB,KAA6D;AAC7F,SAAO,OAAO,QAAQ;AACxB;AAEO,SAAS,YAAY,KAA+E;AACzG,SAAO,CAAC,CAAC,OAAO,MAAM,GAAG;AAC3B;AAEO,SAAS,WAAW,QAAgC;AACzD,MAAI,CAAC,QAAQ;AACX,WAAO;AAAA,EACT;AAEA,SAAO,MAAM,QAAQ,OAAO,QAAQ,IAAI,CAAC,CAAC,OAAO,UAAU,SAAS,CAAC,CAAC,OAAO;AAC/E;AAEA,eAAsB,cAAc,MAAmB,UAAiC,CAAC,GAAyB;AAChH,QAAM,gBAAgB;AAAA,IACpB;AAAA,MACE,MAAM;AAAA,MACN,SAAS;AAAA,QACP,MAAM,CAAC,WAAW,QAAQ,WAAW,SAAS,cAAc,QAAQ,eAAe,cAAc;AAAA,QACjG,KAAK,CAAC,eAAe,WAAW,eAAe,cAAc,eAAe,WAAW;AAAA,QACvF,MAAM,CAAC,eAAe,WAAW,eAAe,cAAc,eAAe,WAAW;AAAA,QACxF,KAAK,CAAC,eAAe,WAAW,eAAe,cAAc,eAAe,WAAW;AAAA,QACvF,OAAO,CAAC,eAAe,WAAW,eAAe,cAAc,eAAe,WAAW;AAAA,QACzF,QAAQ,CAAC,eAAe,WAAW,eAAe,cAAc,eAAe,WAAW;AAAA,QAC1F,YAAY,CAAC,QAAQ,MAAM,eAAe,YAAY,QAAQ;AAAA,QAC9D,aAAa,CAAC,eAAe,YAAY,SAAS;AAAA,QAClD,WAAW,CAAC,eAAe,WAAW,WAAW,OAAO;AAAA,QACxD,SAAS,CAAC;AAAA,QACV,YAAY,CAAC,cAAc,SAAS;AAAA,QACpC,QAAQ,CAAC,eAAe,QAAQ,SAAS,cAAc,UAAU,WAAW,SAAS;AAAA,QACrF,SAAS,CAAC,eAAe,QAAQ,SAAS,cAAc,UAAU,WAAW,SAAS;AAAA,QACtF,YAAY,CAAC,eAAe,QAAQ,SAAS,UAAU,WAAW,WAAW,MAAM;AAAA,MACrF;AAAA,MACA,mBAAmB,CAAC;AAAA,MACpB,WAAW;AAAA,QACT,kBAAkB,QAAQ,YAAY,CAAC,iBAAiB,WAAW,cAAc,WAAW,IAAI,CAAC;AAAA,MACnG;AAAA,MACA,WAAW,CAAC;AAAA,IACd;AAAA,IACA;AAAA,EACF;AAEA,QAAM,aAAa,MAAM,cAAc,cAAc,MAAM,aAAa;AACxE,SAAO,WAAW;AAElB,QAAM,YAAY,MAAM,cAAc,YAAY,MAAM,aAAa;AACrE,SAAO,UAAU;AAEjB,QAAM,gBAAgB,MAAM,cAAc,kBAAkB,MAAM,aAAa;AAC/E,SAAO,cAAc;AAErB,SAAO;AACT;;;AC7EA,OAAO,aAAa;AACpB,OAAO,kBAAkB;AACzB,SAAS,sBAAsB,uBAAuB;AAFtD;AAcO,IAAM,MAAN,cAAwC,QAAQ;AAAA,EAIrD,YAAY,EAAE,KAAK,KAAK,GAAsD,UAAmB,CAAC,GAAG;AACnG,QAAI,OAAO,QAAQ,UAAU;AAC3B,YAAM,KAAK,MAAM,GAAG;AAAA,IACtB;AAEA,UAAM,KAAoB,IAAI;AAoBhC;AAAA;AAAA;AAAA;AA5BA,iCAAoB,CAAC;AACrB,oBAAiB;AASf,SAAK,WAAW;AAChB,uBAAK,UAAW;AAAA,EAClB;AAAA,EAEA,mBAAmB,QAAkB;AACnC,QAAI,YAAY,MAAM,GAAG;AACvB,aAAO;AAAA,QACL,GAAG,qBAAqB,OAAO,MAAM,KAAK,GAAG;AAAA,QAC7C,MAAM,OAAO;AAAA,MACf;AAAA,IACF;AAEA,WAAO;AAAA,EACT;AAAA,EA2DA,kBAAkB,WAAsB,YAA2C;AACjF,QAAI,UAAU,OAAO,WAAW;AAC9B,aAAO,KAAK,UAAU,OAAO,SAAS,EAAE,QAAQ,CAAC,QAAQ;AACvD,cAAMA,UAAS,UAAU,OAAO,UAAW,GAAG;AAC9C,cAAM,OAAO,YAAYA,OAAM,IAAIA,QAAO,OAAO;AAEjD,YAAIA,WAAU,MAAM;AAClB,oBAAU,OAAO,UAAW,GAAG,IAAI,qBAAqB,MAAM,KAAK,GAAG;AAAA,QACxE;AAAA,MACF,CAAC;AAAA,IACH;AAEA,UAAM,kBAAkB,sBAAK,oDAAL,WAA6B,UAAU,wBAAwB,UAAU;AAEjG,UAAM,EAAE,YAAY,IAAI,mBAAK;AAC7B,UAAM,eAAe,gBAAgB,WAAW;AAEhD,QAAI,iBAAiB,OAAO;AAE1B,aAAO,CAAC;AAAA,IACV;AAEA,UAAM,SAAS,MAAM,QAAQ,YAAY,IAAI,aAAa,CAAC,EAAE,SAAS,aAAa;AAEnF,QAAI,CAAC,QAAQ;AAGX,aAAO,CAAC;AAAA,IACV;AAEA,WAAO,KAAK,mBAAmB,MAAM;AAAA,EACvC;AAAA,EAEA,iBAAiB,WAAgD;AAC/D,UAAM,EAAE,YAAY,IAAI,mBAAK;AAE7B,QAAI,UAAU,OAAO,aAAa;AAChC,gBAAU,OAAO,cAAc,KAAK,mBAAmB,UAAU,OAAO,WAAW;AAAA,IACrF;AAEA,UAAM,cAAc,UAAU,eAAe,WAAW;AAExD,QAAI,gBAAgB,OAAO;AACzB,aAAO;AAAA,IACT;AAEA,UAAM,SAAS,MAAM,QAAQ,WAAW,IAAI,YAAY,CAAC,EAAE,SAAS,YAAY;AAEhF,QAAI,CAAC,QAAQ;AACX,aAAO;AAAA,IACT;AAEA,WAAO,KAAK,mBAAmB,MAAM;AAAA,EACvC;AAAA,EAEA,oBAAoB,WAAsB,OAAyD;AACjG,UAAM,EAAE,cAAc,UAAU,eAAe,EAAE,IAAI,mBAAK;AAC1D,UAAM,SAAS,UACZ,cAAc,EACd,IAAI,CAAC,WAAW;AACf,aAAO,KAAK,mBAAmB,MAAM;AAAA,IACvC,CAAC,EACA,OAAO,CAAC,MAAM,EAAE,OAAO,KAAK;AAE/B,QAAI,CAAC,OAAO,QAAQ;AAClB,aAAO;AAAA,IACT;AAEA,WAAO,OAAO;AAAA,MACZ,CAAC,QAAQ,mBAAmB;AAC1B,cAAM,WAAW,eAAe,UAAU,WAAW,GAAG,UAAW,eAAe;AAClF,cAAM,WAAW,CAAC,GAAI,OAAO,YAAa,CAAC,GAAY,eAAe,WAAW,eAAe,OAAO,MAAS,EAAE,OAAO,OAAO;AAEhI,eAAO;AAAA,UACL,GAAG;AAAA,UACH,aAAa,OAAO;AAAA,UACpB,YAAY,OAAO;AAAA,UACnB,SAAS,OAAO;AAAA,UAChB;AAAA,UACA,YAAY;AAAA,YACV,GAAG,OAAO;AAAA,YACV,CAAC,eAAe,IAAI,GAAG;AAAA,cACrB,aAAa,eAAe;AAAA,cAC5B,GAAG;AAAA,YACL;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,MACA,EAAE,MAAM,UAAU,UAAU,CAAC,GAAG,YAAY,CAAC,EAAE;AAAA,IACjD;AAAA,EACF;AAAA,EAEA,MAAM,WAAW;AACf,UAAM,eAAe,IAAI,aAAa,KAAK,KAAK;AAAA,MAC9C,aAAa;AAAA,MACb,gBAAgB;AAAA,IAClB,CAAC;AAED,UAAM,aAAa,SAAS;AAAA,EAC9B;AACF;AAtLE;AA4BA;AAAA,4BAAuB,SAAC,cAAoI;AAC1J,WAAS,gBAAgB,MAAM,cAAqC;AAClE,WAAO,CAAC,CAAC;AAAA,EACX;AAEA,SAAO,CAAC,gBAAgB;AACtB,QAAI,CAAC,gBAAgB,YAAY,GAAG;AAClC,aAAO;AAAA,IACT;AAEA,QAAI,YAAY,YAAY,GAAG;AAG7B,aAAO;AAAA,IACT;AAEA,QAAI,CAAC,aAAa,SAAS;AACzB,aAAO;AAAA,IACT;AAEA,QAAI,aAAa;AACf,UAAI,EAAE,eAAe,aAAa,UAAU;AAC1C,eAAO;AAAA,MACT;AAEA,aAAO,aAAa,QAAQ,WAAW;AAAA,IACzC;AAIA,QAAI,uBAA2C;AAC/C,UAAM,eAAe,OAAO,KAAK,aAAa,OAAO;AACrD,iBAAa,QAAQ,CAAC,OAAe;AACnC,UAAI,CAAC,wBAAwB,gBAAgB,KAAK,EAAE,GAAG;AACrD,+BAAuB;AAAA,MACzB;AAAA,IACF,CAAC;AAED,QAAI,CAAC,sBAAsB;AACzB,mBAAa,QAAQ,CAAC,OAAe;AACnC,YAAI,CAAC,sBAAsB;AACzB,iCAAuB;AAAA,QACzB;AAAA,MACF,CAAC;AAAA,IACH;AAEA,QAAI,sBAAsB;AACxB,aAAO,CAAC,sBAAsB,aAAa,QAAQ,oBAAoB,GAAI,GAAI,aAAa,cAAc,CAAC,aAAa,WAAW,IAAI,CAAC,CAAE;AAAA,IAC5I;AAEA,WAAO;AAAA,EACT;AACF;","names":["schema"]}
@@ -23,6 +23,7 @@ var __privateMethod = (obj, member, method) => {
23
23
 
24
24
  // src/utils.ts
25
25
  var _types = require('oas/types');
26
+ var _openapiformat = require('openapi-format'); var _openapiformat2 = _interopRequireDefault(_openapiformat);
26
27
  var _remeda = require('remeda');
27
28
  function isOpenApiV2Document(doc) {
28
29
  return doc && _remeda.isObject.call(void 0, doc) && !("openapi" in doc);
@@ -42,6 +43,42 @@ function isRequired(schema) {
42
43
  }
43
44
  return Array.isArray(schema.required) ? !!_optionalChain([schema, 'access', _ => _.required, 'optionalAccess', _2 => _2.length]) : !!schema.required;
44
45
  }
46
+ async function filterAndSort(data, options = {}) {
47
+ const mergedOptions = _remeda.mergeDeep.call(void 0,
48
+ {
49
+ sort: true,
50
+ sortSet: {
51
+ root: ["openapi", "info", "servers", "paths", "components", "tags", "x-tagGroups", "externalDocs"],
52
+ get: ["operationId", "summary", "description", "parameters", "requestBody", "responses"],
53
+ post: ["operationId", "summary", "description", "parameters", "requestBody", "responses"],
54
+ put: ["operationId", "summary", "description", "parameters", "requestBody", "responses"],
55
+ patch: ["operationId", "summary", "description", "parameters", "requestBody", "responses"],
56
+ delete: ["operationId", "summary", "description", "parameters", "requestBody", "responses"],
57
+ parameters: ["name", "in", "description", "required", "schema"],
58
+ requestBody: ["description", "required", "content"],
59
+ responses: ["description", "headers", "content", "links"],
60
+ content: [],
61
+ components: ["parameters", "schemas"],
62
+ schema: ["description", "type", "items", "properties", "format", "example", "default"],
63
+ schemas: ["description", "type", "items", "properties", "format", "example", "default"],
64
+ properties: ["description", "type", "items", "format", "example", "default", "enum"]
65
+ },
66
+ sortComponentsSet: {},
67
+ filterSet: {
68
+ unusedComponents: options.filterSet ? ["requestBodies", "schemas", "parameters", "responses"] : []
69
+ },
70
+ casingSet: {}
71
+ },
72
+ options
73
+ );
74
+ const restFilter = await _openapiformat2.default.openapiFilter(data, mergedOptions);
75
+ data = restFilter.data;
76
+ const resFormat = await _openapiformat2.default.openapiSort(data, mergedOptions);
77
+ data = resFormat.data;
78
+ const resChangeCase = await _openapiformat2.default.openapiChangeCase(data, mergedOptions);
79
+ data = resChangeCase.data;
80
+ return data;
81
+ }
45
82
 
46
83
  // src/Oas.ts
47
84
  var _oas = require('oas'); var _oas2 = _interopRequireDefault(_oas);
@@ -197,5 +234,6 @@ getResponseBodyFactory_fn = function(responseBody) {
197
234
 
198
235
 
199
236
 
200
- exports.isOpenApiV2Document = isOpenApiV2Document; exports.isOpenApiV3_1Document = isOpenApiV3_1Document; exports.isParameterObject = isParameterObject; exports.isReference = isReference; exports.isRequired = isRequired; exports.Oas = Oas;
201
- //# sourceMappingURL=chunk-EPQ73VUM.cjs.map
237
+
238
+ exports.isOpenApiV2Document = isOpenApiV2Document; exports.isOpenApiV3_1Document = isOpenApiV3_1Document; exports.isParameterObject = isParameterObject; exports.isReference = isReference; exports.isRequired = isRequired; exports.filterAndSort = filterAndSort; exports.Oas = Oas;
239
+ //# sourceMappingURL=chunk-XYGNER5L.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/utils.ts","../src/Oas.ts"],"names":["schema"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAAA,SAAS,OAAO,gBAAgB;AAChC,OAAO,mBAAmB;AAC1B,SAAS,UAAU,iBAAiB;AAK7B,SAAS,oBAAoB,KAAqC;AACvE,SAAO,OAAO,SAAS,GAAG,KAAK,EAAE,aAAa;AAChD;AAKO,SAAS,sBAAsB,KAAuC;AAC3E,SAAO,OAAO,SAAS,GAAG,KAAK,aAAa,OAAO,IAAI,QAAQ,WAAW,KAAK;AACjF;AAMO,SAAS,kBAAkB,KAA6D;AAC7F,SAAO,OAAO,QAAQ;AACxB;AAEO,SAAS,YAAY,KAA+E;AACzG,SAAO,CAAC,CAAC,OAAO,MAAM,GAAG;AAC3B;AAEO,SAAS,WAAW,QAAgC;AACzD,MAAI,CAAC,QAAQ;AACX,WAAO;AAAA,EACT;AAEA,SAAO,MAAM,QAAQ,OAAO,QAAQ,IAAI,CAAC,CAAC,OAAO,UAAU,SAAS,CAAC,CAAC,OAAO;AAC/E;AAEA,eAAsB,cAAc,MAAmB,UAAiC,CAAC,GAAyB;AAChH,QAAM,gBAAgB;AAAA,IACpB;AAAA,MACE,MAAM;AAAA,MACN,SAAS;AAAA,QACP,MAAM,CAAC,WAAW,QAAQ,WAAW,SAAS,cAAc,QAAQ,eAAe,cAAc;AAAA,QACjG,KAAK,CAAC,eAAe,WAAW,eAAe,cAAc,eAAe,WAAW;AAAA,QACvF,MAAM,CAAC,eAAe,WAAW,eAAe,cAAc,eAAe,WAAW;AAAA,QACxF,KAAK,CAAC,eAAe,WAAW,eAAe,cAAc,eAAe,WAAW;AAAA,QACvF,OAAO,CAAC,eAAe,WAAW,eAAe,cAAc,eAAe,WAAW;AAAA,QACzF,QAAQ,CAAC,eAAe,WAAW,eAAe,cAAc,eAAe,WAAW;AAAA,QAC1F,YAAY,CAAC,QAAQ,MAAM,eAAe,YAAY,QAAQ;AAAA,QAC9D,aAAa,CAAC,eAAe,YAAY,SAAS;AAAA,QAClD,WAAW,CAAC,eAAe,WAAW,WAAW,OAAO;AAAA,QACxD,SAAS,CAAC;AAAA,QACV,YAAY,CAAC,cAAc,SAAS;AAAA,QACpC,QAAQ,CAAC,eAAe,QAAQ,SAAS,cAAc,UAAU,WAAW,SAAS;AAAA,QACrF,SAAS,CAAC,eAAe,QAAQ,SAAS,cAAc,UAAU,WAAW,SAAS;AAAA,QACtF,YAAY,CAAC,eAAe,QAAQ,SAAS,UAAU,WAAW,WAAW,MAAM;AAAA,MACrF;AAAA,MACA,mBAAmB,CAAC;AAAA,MACpB,WAAW;AAAA,QACT,kBAAkB,QAAQ,YAAY,CAAC,iBAAiB,WAAW,cAAc,WAAW,IAAI,CAAC;AAAA,MACnG;AAAA,MACA,WAAW,CAAC;AAAA,IACd;AAAA,IACA;AAAA,EACF;AAEA,QAAM,aAAa,MAAM,cAAc,cAAc,MAAM,aAAa;AACxE,SAAO,WAAW;AAElB,QAAM,YAAY,MAAM,cAAc,YAAY,MAAM,aAAa;AACrE,SAAO,UAAU;AAEjB,QAAM,gBAAgB,MAAM,cAAc,kBAAkB,MAAM,aAAa;AAC/E,SAAO,cAAc;AAErB,SAAO;AACT;;;AC7EA,OAAO,aAAa;AACpB,OAAO,kBAAkB;AACzB,SAAS,sBAAsB,uBAAuB;AAFtD;AAcO,IAAM,MAAN,cAAwC,QAAQ;AAAA,EAIrD,YAAY,EAAE,KAAK,KAAK,GAAsD,UAAmB,CAAC,GAAG;AACnG,QAAI,OAAO,QAAQ,UAAU;AAC3B,YAAM,KAAK,MAAM,GAAG;AAAA,IACtB;AAEA,UAAM,KAAoB,IAAI;AAoBhC;AAAA;AAAA;AAAA;AA5BA,iCAAoB,CAAC;AACrB,oBAAiB;AASf,SAAK,WAAW;AAChB,uBAAK,UAAW;AAAA,EAClB;AAAA,EAEA,mBAAmB,QAAkB;AACnC,QAAI,YAAY,MAAM,GAAG;AACvB,aAAO;AAAA,QACL,GAAG,qBAAqB,OAAO,MAAM,KAAK,GAAG;AAAA,QAC7C,MAAM,OAAO;AAAA,MACf;AAAA,IACF;AAEA,WAAO;AAAA,EACT;AAAA,EA2DA,kBAAkB,WAAsB,YAA2C;AACjF,QAAI,UAAU,OAAO,WAAW;AAC9B,aAAO,KAAK,UAAU,OAAO,SAAS,EAAE,QAAQ,CAAC,QAAQ;AACvD,cAAMA,UAAS,UAAU,OAAO,UAAW,GAAG;AAC9C,cAAM,OAAO,YAAYA,OAAM,IAAIA,QAAO,OAAO;AAEjD,YAAIA,WAAU,MAAM;AAClB,oBAAU,OAAO,UAAW,GAAG,IAAI,qBAAqB,MAAM,KAAK,GAAG;AAAA,QACxE;AAAA,MACF,CAAC;AAAA,IACH;AAEA,UAAM,kBAAkB,sBAAK,oDAAL,WAA6B,UAAU,wBAAwB,UAAU;AAEjG,UAAM,EAAE,YAAY,IAAI,mBAAK;AAC7B,UAAM,eAAe,gBAAgB,WAAW;AAEhD,QAAI,iBAAiB,OAAO;AAE1B,aAAO,CAAC;AAAA,IACV;AAEA,UAAM,SAAS,MAAM,QAAQ,YAAY,IAAI,aAAa,CAAC,EAAE,SAAS,aAAa;AAEnF,QAAI,CAAC,QAAQ;AAGX,aAAO,CAAC;AAAA,IACV;AAEA,WAAO,KAAK,mBAAmB,MAAM;AAAA,EACvC;AAAA,EAEA,iBAAiB,WAAgD;AAC/D,UAAM,EAAE,YAAY,IAAI,mBAAK;AAE7B,QAAI,UAAU,OAAO,aAAa;AAChC,gBAAU,OAAO,cAAc,KAAK,mBAAmB,UAAU,OAAO,WAAW;AAAA,IACrF;AAEA,UAAM,cAAc,UAAU,eAAe,WAAW;AAExD,QAAI,gBAAgB,OAAO;AACzB,aAAO;AAAA,IACT;AAEA,UAAM,SAAS,MAAM,QAAQ,WAAW,IAAI,YAAY,CAAC,EAAE,SAAS,YAAY;AAEhF,QAAI,CAAC,QAAQ;AACX,aAAO;AAAA,IACT;AAEA,WAAO,KAAK,mBAAmB,MAAM;AAAA,EACvC;AAAA,EAEA,oBAAoB,WAAsB,OAAyD;AACjG,UAAM,EAAE,cAAc,UAAU,eAAe,EAAE,IAAI,mBAAK;AAC1D,UAAM,SAAS,UACZ,cAAc,EACd,IAAI,CAAC,WAAW;AACf,aAAO,KAAK,mBAAmB,MAAM;AAAA,IACvC,CAAC,EACA,OAAO,CAAC,MAAM,EAAE,OAAO,KAAK;AAE/B,QAAI,CAAC,OAAO,QAAQ;AAClB,aAAO;AAAA,IACT;AAEA,WAAO,OAAO;AAAA,MACZ,CAAC,QAAQ,mBAAmB;AAC1B,cAAM,WAAW,eAAe,UAAU,WAAW,GAAG,UAAW,eAAe;AAClF,cAAM,WAAW,CAAC,GAAI,OAAO,YAAa,CAAC,GAAY,eAAe,WAAW,eAAe,OAAO,MAAS,EAAE,OAAO,OAAO;AAEhI,eAAO;AAAA,UACL,GAAG;AAAA,UACH,aAAa,OAAO;AAAA,UACpB,YAAY,OAAO;AAAA,UACnB,SAAS,OAAO;AAAA,UAChB;AAAA,UACA,YAAY;AAAA,YACV,GAAG,OAAO;AAAA,YACV,CAAC,eAAe,IAAI,GAAG;AAAA,cACrB,aAAa,eAAe;AAAA,cAC5B,GAAG;AAAA,YACL;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,MACA,EAAE,MAAM,UAAU,UAAU,CAAC,GAAG,YAAY,CAAC,EAAE;AAAA,IACjD;AAAA,EACF;AAAA,EAEA,MAAM,WAAW;AACf,UAAM,eAAe,IAAI,aAAa,KAAK,KAAK;AAAA,MAC9C,aAAa;AAAA,MACb,gBAAgB;AAAA,IAClB,CAAC;AAED,UAAM,aAAa,SAAS;AAAA,EAC9B;AACF;AAtLE;AA4BA;AAAA,4BAAuB,SAAC,cAAoI;AAC1J,WAAS,gBAAgB,MAAM,cAAqC;AAClE,WAAO,CAAC,CAAC;AAAA,EACX;AAEA,SAAO,CAAC,gBAAgB;AACtB,QAAI,CAAC,gBAAgB,YAAY,GAAG;AAClC,aAAO;AAAA,IACT;AAEA,QAAI,YAAY,YAAY,GAAG;AAG7B,aAAO;AAAA,IACT;AAEA,QAAI,CAAC,aAAa,SAAS;AACzB,aAAO;AAAA,IACT;AAEA,QAAI,aAAa;AACf,UAAI,EAAE,eAAe,aAAa,UAAU;AAC1C,eAAO;AAAA,MACT;AAEA,aAAO,aAAa,QAAQ,WAAW;AAAA,IACzC;AAIA,QAAI,uBAA2C;AAC/C,UAAM,eAAe,OAAO,KAAK,aAAa,OAAO;AACrD,iBAAa,QAAQ,CAAC,OAAe;AACnC,UAAI,CAAC,wBAAwB,gBAAgB,KAAK,EAAE,GAAG;AACrD,+BAAuB;AAAA,MACzB;AAAA,IACF,CAAC;AAED,QAAI,CAAC,sBAAsB;AACzB,mBAAa,QAAQ,CAAC,OAAe;AACnC,YAAI,CAAC,sBAAsB;AACzB,iCAAuB;AAAA,QACzB;AAAA,MACF,CAAC;AAAA,IACH;AAEA,QAAI,sBAAsB;AACxB,aAAO,CAAC,sBAAsB,aAAa,QAAQ,oBAAoB,GAAI,GAAI,aAAa,cAAc,CAAC,aAAa,WAAW,IAAI,CAAC,CAAE;AAAA,IAC5I;AAEA,WAAO;AAAA,EACT;AACF","sourcesContent":["import { isRef, isSchema } from 'oas/types'\nimport openapiFormat from 'openapi-format'\nimport { isObject, mergeDeep } from 'remeda'\n\nimport type { OASDocument, ParameterObject, SchemaObject } from 'oas/types'\nimport type { OpenAPIV2, OpenAPIV3, OpenAPIV3_1 } from 'openapi-types'\n\nexport function isOpenApiV2Document(doc: any): doc is OpenAPIV2.Document {\n return doc && isObject(doc) && !('openapi' in doc)\n}\nexport function isOpenApiV3Document(doc: any): doc is OpenAPIV3.Document {\n return doc && isObject(doc) && 'openapi' in doc\n}\n\nexport function isOpenApiV3_1Document(doc: any): doc is OpenAPIV3_1.Document {\n return doc && isObject(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 async function filterAndSort(data: OASDocument, options: openapiFormat.Options = {}): Promise<OASDocument> {\n const mergedOptions = mergeDeep(\n {\n sort: true,\n sortSet: {\n root: ['openapi', 'info', 'servers', 'paths', 'components', 'tags', 'x-tagGroups', 'externalDocs'],\n get: ['operationId', 'summary', 'description', 'parameters', 'requestBody', 'responses'],\n post: ['operationId', 'summary', 'description', 'parameters', 'requestBody', 'responses'],\n put: ['operationId', 'summary', 'description', 'parameters', 'requestBody', 'responses'],\n patch: ['operationId', 'summary', 'description', 'parameters', 'requestBody', 'responses'],\n delete: ['operationId', 'summary', 'description', 'parameters', 'requestBody', 'responses'],\n parameters: ['name', 'in', 'description', 'required', 'schema'],\n requestBody: ['description', 'required', 'content'],\n responses: ['description', 'headers', 'content', 'links'],\n content: [],\n components: ['parameters', 'schemas'],\n schema: ['description', 'type', 'items', 'properties', 'format', 'example', 'default'],\n schemas: ['description', 'type', 'items', 'properties', 'format', 'example', 'default'],\n properties: ['description', 'type', 'items', 'format', 'example', 'default', 'enum'],\n },\n sortComponentsSet: {},\n filterSet: {\n unusedComponents: options.filterSet ? ['requestBodies', 'schemas', 'parameters', 'responses'] : [],\n },\n casingSet: {},\n },\n options as Record<string, unknown>,\n ) as openapiFormat.Options\n\n const restFilter = await openapiFormat.openapiFilter(data, mergedOptions)\n data = restFilter.data\n\n const resFormat = await openapiFormat.openapiSort(data, mergedOptions)\n data = resFormat.data\n\n const resChangeCase = await openapiFormat.openapiChangeCase(data, mergedOptions)\n data = resChangeCase.data\n\n return data\n}\n","import BaseOas from 'oas'\nimport OASNormalize from 'oas-normalize'\nimport { findSchemaDefinition, matchesMimeType } from 'oas/utils'\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 { 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 dereferenceWithRef(schema?: unknown) {\n if (isReference(schema)) {\n return {\n ...findSchemaDefinition(schema.$ref, this.api),\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] = findSchemaDefinition($ref, this.api)\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 }\n}\n"]}
package/dist/index.cjs CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
 
6
6
 
7
- var _chunkEPQ73VUMcjs = require('./chunk-EPQ73VUM.cjs');
7
+ var _chunkXYGNER5Lcjs = require('./chunk-XYGNER5L.cjs');
8
8
 
9
9
  // src/types.ts
10
10
  var HttpMethods = {
@@ -29,5 +29,5 @@ var _utils = require('oas/utils');
29
29
 
30
30
 
31
31
 
32
- exports.HttpMethods = HttpMethods; exports.Oas = _chunkEPQ73VUMcjs.Oas; exports.findSchemaDefinition = _utils.findSchemaDefinition; exports.isOpenApiV3_1Document = _chunkEPQ73VUMcjs.isOpenApiV3_1Document; exports.isParameterObject = _chunkEPQ73VUMcjs.isParameterObject; exports.isReference = _chunkEPQ73VUMcjs.isReference; exports.isRequired = _chunkEPQ73VUMcjs.isRequired; exports.matchesMimeType = _utils.matchesMimeType;
32
+ exports.HttpMethods = HttpMethods; exports.Oas = _chunkXYGNER5Lcjs.Oas; exports.findSchemaDefinition = _utils.findSchemaDefinition; exports.isOpenApiV3_1Document = _chunkXYGNER5Lcjs.isOpenApiV3_1Document; exports.isParameterObject = _chunkXYGNER5Lcjs.isParameterObject; exports.isReference = _chunkXYGNER5Lcjs.isReference; exports.isRequired = _chunkXYGNER5Lcjs.isRequired; exports.matchesMimeType = _utils.matchesMimeType;
33
33
  //# sourceMappingURL=index.cjs.map
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/types.ts","../src/index.ts"],"names":[],"mappings":";;;;;;;;;AAeO,IAAM,cAAc;AAAA,EACzB,KAAK;AAAA,EACL,MAAM;AAAA,EACN,KAAK;AAAA,EACL,OAAO;AAAA,EACP,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,SAAS;AAAA,EACT,OAAO;AACT;;;ACvBA,SAAS,sBAAsB,uBAAuB","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","export * from './types.ts'\nexport { findSchemaDefinition, matchesMimeType } from 'oas/utils'\nexport { isRequired, isReference, isParameterObject, isOpenApiV3_1Document } from './utils.ts'\nexport { Oas } from './Oas.ts'\nexport type { Infer, Model, RequestParams, Response } from './infer/index.ts'\n"]}
1
+ {"version":3,"sources":["../src/types.ts","../src/index.ts"],"names":[],"mappings":";;;;;;;;;AAeO,IAAM,cAAc;AAAA,EACzB,KAAK;AAAA,EACL,MAAM;AAAA,EACN,KAAK;AAAA,EACL,OAAO;AAAA,EACP,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,SAAS;AAAA,EACT,OAAO;AACT;;;ACrBA,SAAS,sBAAsB,uBAAuB","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 './typings.d.ts'\n\nexport * from './types.ts'\nexport { findSchemaDefinition, matchesMimeType } from 'oas/utils'\nexport { isRequired, isReference, isParameterObject, isOpenApiV3_1Document } from './utils.ts'\nexport { Oas } from './Oas.ts'\nexport type { Infer, Model, RequestParams, Response } from './infer/index.ts'\n"]}
package/dist/index.d.cts CHANGED
@@ -12,6 +12,58 @@ import { JSONSchema, FromSchema } from 'json-schema-to-ts';
12
12
  export { Operation } from 'oas/operation';
13
13
  import 'oas';
14
14
 
15
+ declare module 'openapi-format' {
16
+ interface Options {
17
+ verbose?: boolean
18
+ 'no-sort'?: boolean
19
+ sort?: boolean
20
+ output?: string
21
+ sortSet?: {
22
+ root?: Array<'openapi' | 'info' | 'servers' | 'paths' | 'components' | 'tags' | 'x-tagGroups' | 'externalDocs'>
23
+ get?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>
24
+ post?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>
25
+ put?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>
26
+ patch?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>
27
+ delete?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>
28
+ parameters?: Array<'name' | 'in' | 'description' | 'required' | 'schema'>
29
+ requestBody?: Array<'description' | 'required' | 'content'>
30
+ responses?: Array<'description' | 'headers' | 'content' | 'links'>
31
+ content?: Array<string>
32
+ components?: Array<'parameters' | 'schemas'>
33
+ schema?: Array<'description' | 'type' | 'items' | 'properties' | 'format' | 'example' | 'default'>
34
+ schemas?: Array<'description' | 'type' | 'items' | 'properties' | 'format' | 'example' | 'default'>
35
+ properties?: Array<'description' | 'type' | 'items' | 'format' | 'example' | 'default' | 'enum'>
36
+ }
37
+ filterSet?: {
38
+ methods?: Array<'get' | 'post' | 'put' | 'patch' | 'delete'>
39
+ inverseMethods?: Array<'get' | 'post' | 'put' | 'patch' | 'delete'>
40
+ tags?: Array<string>
41
+ inverseTags?: Array<string>
42
+ operationIds?: Array<string>
43
+ inverseOperationIds?: Array<string>
44
+ operations?: Array<string>
45
+ flags?: Array<string>
46
+ inverseFlags?: Array<string>
47
+ flagValues?: Array<string>
48
+ inverseFlagValues?: Array<string>
49
+ stripFlags?: Array<string>
50
+ responseContent?: Array<string>
51
+ inverseResponseContent?: Array<string>
52
+ unusedComponents?: Array<'requestBodies' | 'schemas' | 'parameters' | 'responses'>
53
+ }
54
+ sortComponentsSet?: {}
55
+ casingSet?: {}
56
+ }
57
+ function parseFile(path: string): Promise<unknown>
58
+
59
+ function openapiFilter<TOas>(document: TOas, options: Options): { data: Toas; resultData: { unusedComp: any } }
60
+
61
+ function openapiSort<TOas>(document: TOas, options: Options): { data: Toas; resultData: { unusedComp: any } }
62
+ function openapiChangeCase<TOas>(document: TOas, options: Options): { data: Toas; resultData: { unusedComp: any } }
63
+
64
+ function stringify<TOas>(document: TOas, options: Options): string
65
+ }
66
+
15
67
  declare function isOpenApiV3_1Document(doc: any): doc is OpenAPIV3_1.Document;
16
68
  declare function isParameterObject(obj: ParameterObject | SchemaObject): obj is ParameterObject;
17
69
  declare function isReference(obj?: unknown): obj is OpenAPIV3.ReferenceObject | OpenAPIV3_1.ReferenceObject;
package/dist/index.d.ts CHANGED
@@ -12,6 +12,58 @@ import { JSONSchema, FromSchema } from 'json-schema-to-ts';
12
12
  export { Operation } from 'oas/operation';
13
13
  import 'oas';
14
14
 
15
+ declare module 'openapi-format' {
16
+ interface Options {
17
+ verbose?: boolean
18
+ 'no-sort'?: boolean
19
+ sort?: boolean
20
+ output?: string
21
+ sortSet?: {
22
+ root?: Array<'openapi' | 'info' | 'servers' | 'paths' | 'components' | 'tags' | 'x-tagGroups' | 'externalDocs'>
23
+ get?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>
24
+ post?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>
25
+ put?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>
26
+ patch?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>
27
+ delete?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>
28
+ parameters?: Array<'name' | 'in' | 'description' | 'required' | 'schema'>
29
+ requestBody?: Array<'description' | 'required' | 'content'>
30
+ responses?: Array<'description' | 'headers' | 'content' | 'links'>
31
+ content?: Array<string>
32
+ components?: Array<'parameters' | 'schemas'>
33
+ schema?: Array<'description' | 'type' | 'items' | 'properties' | 'format' | 'example' | 'default'>
34
+ schemas?: Array<'description' | 'type' | 'items' | 'properties' | 'format' | 'example' | 'default'>
35
+ properties?: Array<'description' | 'type' | 'items' | 'format' | 'example' | 'default' | 'enum'>
36
+ }
37
+ filterSet?: {
38
+ methods?: Array<'get' | 'post' | 'put' | 'patch' | 'delete'>
39
+ inverseMethods?: Array<'get' | 'post' | 'put' | 'patch' | 'delete'>
40
+ tags?: Array<string>
41
+ inverseTags?: Array<string>
42
+ operationIds?: Array<string>
43
+ inverseOperationIds?: Array<string>
44
+ operations?: Array<string>
45
+ flags?: Array<string>
46
+ inverseFlags?: Array<string>
47
+ flagValues?: Array<string>
48
+ inverseFlagValues?: Array<string>
49
+ stripFlags?: Array<string>
50
+ responseContent?: Array<string>
51
+ inverseResponseContent?: Array<string>
52
+ unusedComponents?: Array<'requestBodies' | 'schemas' | 'parameters' | 'responses'>
53
+ }
54
+ sortComponentsSet?: {}
55
+ casingSet?: {}
56
+ }
57
+ function parseFile(path: string): Promise<unknown>
58
+
59
+ function openapiFilter<TOas>(document: TOas, options: Options): { data: Toas; resultData: { unusedComp: any } }
60
+
61
+ function openapiSort<TOas>(document: TOas, options: Options): { data: Toas; resultData: { unusedComp: any } }
62
+ function openapiChangeCase<TOas>(document: TOas, options: Options): { data: Toas; resultData: { unusedComp: any } }
63
+
64
+ function stringify<TOas>(document: TOas, options: Options): string
65
+ }
66
+
15
67
  declare function isOpenApiV3_1Document(doc: any): doc is OpenAPIV3_1.Document;
16
68
  declare function isParameterObject(obj: ParameterObject | SchemaObject): obj is ParameterObject;
17
69
  declare function isReference(obj?: unknown): obj is OpenAPIV3.ReferenceObject | OpenAPIV3_1.ReferenceObject;
package/dist/index.js CHANGED
@@ -4,7 +4,7 @@ import {
4
4
  isParameterObject,
5
5
  isReference,
6
6
  isRequired
7
- } from "./chunk-2SLQJGDM.js";
7
+ } from "./chunk-ADBW4NBH.js";
8
8
 
9
9
  // src/types.ts
10
10
  var HttpMethods = {
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/types.ts","../src/index.ts"],"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","export * from './types.ts'\nexport { findSchemaDefinition, matchesMimeType } from 'oas/utils'\nexport { isRequired, isReference, isParameterObject, isOpenApiV3_1Document } from './utils.ts'\nexport { Oas } from './Oas.ts'\nexport type { Infer, Model, RequestParams, Response } from './infer/index.ts'\n"],"mappings":";;;;;;;;;AAeO,IAAM,cAAc;AAAA,EACzB,KAAK;AAAA,EACL,MAAM;AAAA,EACN,KAAK;AAAA,EACL,OAAO;AAAA,EACP,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,SAAS;AAAA,EACT,OAAO;AACT;;;ACvBA,SAAS,sBAAsB,uBAAuB;","names":[]}
1
+ {"version":3,"sources":["../src/types.ts","../src/index.ts"],"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 './typings.d.ts'\n\nexport * from './types.ts'\nexport { findSchemaDefinition, matchesMimeType } from 'oas/utils'\nexport { isRequired, isReference, isParameterObject, isOpenApiV3_1Document } from './utils.ts'\nexport { Oas } from './Oas.ts'\nexport type { Infer, Model, RequestParams, Response } from './infer/index.ts'\n"],"mappings":";;;;;;;;;AAeO,IAAM,cAAc;AAAA,EACzB,KAAK;AAAA,EACL,MAAM;AAAA,EACN,KAAK;AAAA,EACL,OAAO;AAAA,EACP,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,SAAS;AAAA,EACT,OAAO;AACT;;;ACrBA,SAAS,sBAAsB,uBAAuB;","names":[]}
package/dist/parser.cjs CHANGED
@@ -1,12 +1,13 @@
1
1
  "use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
2
2
 
3
3
 
4
- var _chunkEPQ73VUMcjs = require('./chunk-EPQ73VUM.cjs');
4
+
5
+ var _chunkXYGNER5Lcjs = require('./chunk-XYGNER5L.cjs');
5
6
 
6
7
  // src/parser/index.ts
7
8
  var _oasnormalize = require('oas-normalize'); var _oasnormalize2 = _interopRequireDefault(_oasnormalize);
8
9
  var _swagger2openapi = require('swagger2openapi'); var _swagger2openapi2 = _interopRequireDefault(_swagger2openapi);
9
- async function parse(pathOrApi) {
10
+ async function parse(pathOrApi, options = {}) {
10
11
  const oasNormalize = new (0, _oasnormalize2.default)(pathOrApi, {
11
12
  enablePaths: true,
12
13
  colorizeErrors: true
@@ -17,11 +18,13 @@ async function parse(pathOrApi) {
17
18
  } catch (e) {
18
19
  document = await oasNormalize.load();
19
20
  }
20
- if (_chunkEPQ73VUMcjs.isOpenApiV2Document.call(void 0, document)) {
21
- const { openapi: oas } = await _swagger2openapi2.default.convertObj(document, { anchors: true });
22
- return new (0, _chunkEPQ73VUMcjs.Oas)({ oas });
21
+ if (_chunkXYGNER5Lcjs.isOpenApiV2Document.call(void 0, document)) {
22
+ const { openapi } = await _swagger2openapi2.default.convertObj(document, { anchors: true });
23
+ const oas2 = await _chunkXYGNER5Lcjs.filterAndSort.call(void 0, openapi, options);
24
+ return new (0, _chunkXYGNER5Lcjs.Oas)({ oas: oas2 });
23
25
  }
24
- return new (0, _chunkEPQ73VUMcjs.Oas)({ oas: document });
26
+ const oas = await _chunkXYGNER5Lcjs.filterAndSort.call(void 0, document, options);
27
+ return new (0, _chunkXYGNER5Lcjs.Oas)({ oas });
25
28
  }
26
29
 
27
30
 
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/parser/index.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,kBAAkB;AACzB,OAAO,qBAAqB;AAQ5B,eAAsB,MAAM,WAA+C;AACzE,QAAM,eAAe,IAAI,aAAa,WAAW;AAAA,IAC/C,aAAa;AAAA,IACb,gBAAgB;AAAA,EAClB,CAAC;AACD,MAAI;AAEJ,MAAI;AAEF,eAAW,MAAM,aAAa,OAAO;AAAA,EACvC,SAAS,GAAG;AACV,eAAY,MAAM,aAAa,KAAK;AAAA,EACtC;AAEA,MAAI,oBAAoB,QAAQ,GAAG;AACjC,UAAM,EAAE,SAAS,IAAI,IAAI,MAAM,gBAAgB,WAAW,UAAU,EAAE,SAAS,KAAK,CAAC;AAErF,WAAO,IAAI,IAAI,EAAE,IAAwB,CAAC;AAAA,EAC5C;AAEA,SAAO,IAAI,IAAI,EAAE,KAAK,SAAS,CAAC;AAClC","sourcesContent":["import OASNormalize from 'oas-normalize'\nimport swagger2openapi from 'swagger2openapi'\n\nimport { Oas } from '../Oas.ts'\nimport { isOpenApiV2Document } from '../utils.ts'\n\nimport type { OASDocument } from 'oas/types'\nimport type { OpenAPI } from 'openapi-types'\n\nexport async function parse(pathOrApi: string | OASDocument): Promise<Oas> {\n const oasNormalize = new OASNormalize(pathOrApi, {\n enablePaths: true,\n colorizeErrors: true,\n })\n let document: OpenAPI.Document\n\n try {\n // resolve external refs\n document = await oasNormalize.bundle()\n } catch (e) {\n document = (await oasNormalize.load()) as OpenAPI.Document\n }\n\n if (isOpenApiV2Document(document)) {\n const { openapi: oas } = await swagger2openapi.convertObj(document, { anchors: true })\n\n return new Oas({ oas: oas as OASDocument })\n }\n\n return new Oas({ oas: document })\n}\n"]}
1
+ {"version":3,"sources":["../src/parser/index.ts"],"names":["oas"],"mappings":";;;;;;;AAAA,OAAO,kBAAkB;AACzB,OAAO,qBAAqB;AAkD5B,eAAsB,MAAM,WAAiC,UAAyB,CAAC,GAAiB;AACtG,QAAM,eAAe,IAAI,aAAa,WAAW;AAAA,IAC/C,aAAa;AAAA,IACb,gBAAgB;AAAA,EAClB,CAAC;AACD,MAAI;AAEJ,MAAI;AAEF,eAAW,MAAM,aAAa,OAAO;AAAA,EACvC,SAAS,GAAG;AACV,eAAY,MAAM,aAAa,KAAK;AAAA,EACtC;AAEA,MAAI,oBAAoB,QAAQ,GAAG;AACjC,UAAM,EAAE,QAAQ,IAAI,MAAM,gBAAgB,WAAW,UAAU,EAAE,SAAS,KAAK,CAAC;AAEhF,UAAMA,OAAM,MAAM,cAAc,SAAwB,OAAO;AAE/D,WAAO,IAAI,IAAI,EAAE,KAAKA,KAAmB,CAAC;AAAA,EAC5C;AAEA,QAAM,MAAM,MAAM,cAAc,UAAyB,OAAO;AAEhE,SAAO,IAAI,IAAI,EAAE,IAAI,CAAC;AACxB","sourcesContent":["import OASNormalize from 'oas-normalize'\nimport swagger2openapi from 'swagger2openapi'\n\nimport { Oas } from '../Oas.ts'\nimport { filterAndSort, isOpenApiV2Document } from '../utils.ts'\n\nimport type { OASDocument } from 'oas/types'\nimport type { OpenAPI } from 'openapi-types'\n\nexport type FormatOptions = {\n verbose?: boolean\n 'no-sort'?: boolean\n sort?: boolean\n output?: string\n sortSet?: {\n root?: Array<'openapi' | 'info' | 'servers' | 'paths' | 'components' | 'tags' | 'x-tagGroups' | 'externalDocs'>\n get?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>\n post?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>\n put?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>\n patch?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>\n delete?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>\n parameters?: Array<'name' | 'in' | 'description' | 'required' | 'schema'>\n requestBody?: Array<'description' | 'required' | 'content'>\n responses?: Array<'description' | 'headers' | 'content' | 'links'>\n content?: Array<string>\n components?: Array<'parameters' | 'schemas'>\n schema?: Array<'description' | 'type' | 'items' | 'properties' | 'format' | 'example' | 'default'>\n schemas?: Array<'description' | 'type' | 'items' | 'properties' | 'format' | 'example' | 'default'>\n properties?: Array<'description' | 'type' | 'items' | 'format' | 'example' | 'default' | 'enum'>\n }\n filterSet?: {\n methods?: Array<'get' | 'post' | 'put' | 'patch' | 'delete'>\n inverseMethods?: Array<'get' | 'post' | 'put' | 'patch' | 'delete'>\n tags?: Array<string>\n inverseTags?: Array<string>\n operationIds?: Array<string>\n inverseOperationIds?: Array<string>\n operations?: Array<string>\n flags?: Array<string>\n inverseFlags?: Array<string>\n flagValues?: Array<string>\n inverseFlagValues?: Array<string>\n stripFlags?: Array<string>\n responseContent?: Array<string>\n inverseResponseContent?: Array<string>\n unusedComponents?: Array<'requestBodies' | 'schemas' | 'parameters' | 'responses'>\n }\n sortComponentsSet?: {}\n casingSet?: {}\n}\n\nexport async function parse(pathOrApi: string | OASDocument, options: FormatOptions = {}): Promise<Oas> {\n const oasNormalize = new OASNormalize(pathOrApi, {\n enablePaths: true,\n colorizeErrors: true,\n })\n let document: OpenAPI.Document\n\n try {\n // resolve external refs\n document = await oasNormalize.bundle()\n } catch (e) {\n document = (await oasNormalize.load()) as OpenAPI.Document\n }\n\n if (isOpenApiV2Document(document)) {\n const { openapi } = await swagger2openapi.convertObj(document, { anchors: true })\n\n const oas = await filterAndSort(openapi as OASDocument, options)\n\n return new Oas({ oas: oas as OASDocument })\n }\n\n const oas = await filterAndSort(document as OASDocument, options)\n\n return new Oas({ oas })\n}\n"]}
package/dist/parser.d.cts CHANGED
@@ -3,6 +3,47 @@ import { OASDocument } from 'oas/types';
3
3
  import 'oas';
4
4
  import 'oas/operation';
5
5
 
6
- declare function parse(pathOrApi: string | OASDocument): Promise<Oas>;
6
+ type FormatOptions = {
7
+ verbose?: boolean;
8
+ 'no-sort'?: boolean;
9
+ sort?: boolean;
10
+ output?: string;
11
+ sortSet?: {
12
+ root?: Array<'openapi' | 'info' | 'servers' | 'paths' | 'components' | 'tags' | 'x-tagGroups' | 'externalDocs'>;
13
+ get?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>;
14
+ post?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>;
15
+ put?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>;
16
+ patch?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>;
17
+ delete?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>;
18
+ parameters?: Array<'name' | 'in' | 'description' | 'required' | 'schema'>;
19
+ requestBody?: Array<'description' | 'required' | 'content'>;
20
+ responses?: Array<'description' | 'headers' | 'content' | 'links'>;
21
+ content?: Array<string>;
22
+ components?: Array<'parameters' | 'schemas'>;
23
+ schema?: Array<'description' | 'type' | 'items' | 'properties' | 'format' | 'example' | 'default'>;
24
+ schemas?: Array<'description' | 'type' | 'items' | 'properties' | 'format' | 'example' | 'default'>;
25
+ properties?: Array<'description' | 'type' | 'items' | 'format' | 'example' | 'default' | 'enum'>;
26
+ };
27
+ filterSet?: {
28
+ methods?: Array<'get' | 'post' | 'put' | 'patch' | 'delete'>;
29
+ inverseMethods?: Array<'get' | 'post' | 'put' | 'patch' | 'delete'>;
30
+ tags?: Array<string>;
31
+ inverseTags?: Array<string>;
32
+ operationIds?: Array<string>;
33
+ inverseOperationIds?: Array<string>;
34
+ operations?: Array<string>;
35
+ flags?: Array<string>;
36
+ inverseFlags?: Array<string>;
37
+ flagValues?: Array<string>;
38
+ inverseFlagValues?: Array<string>;
39
+ stripFlags?: Array<string>;
40
+ responseContent?: Array<string>;
41
+ inverseResponseContent?: Array<string>;
42
+ unusedComponents?: Array<'requestBodies' | 'schemas' | 'parameters' | 'responses'>;
43
+ };
44
+ sortComponentsSet?: {};
45
+ casingSet?: {};
46
+ };
47
+ declare function parse(pathOrApi: string | OASDocument, options?: FormatOptions): Promise<Oas>;
7
48
 
8
- export { parse };
49
+ export { type FormatOptions, parse };
package/dist/parser.d.ts CHANGED
@@ -3,6 +3,47 @@ import { OASDocument } from 'oas/types';
3
3
  import 'oas';
4
4
  import 'oas/operation';
5
5
 
6
- declare function parse(pathOrApi: string | OASDocument): Promise<Oas>;
6
+ type FormatOptions = {
7
+ verbose?: boolean;
8
+ 'no-sort'?: boolean;
9
+ sort?: boolean;
10
+ output?: string;
11
+ sortSet?: {
12
+ root?: Array<'openapi' | 'info' | 'servers' | 'paths' | 'components' | 'tags' | 'x-tagGroups' | 'externalDocs'>;
13
+ get?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>;
14
+ post?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>;
15
+ put?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>;
16
+ patch?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>;
17
+ delete?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>;
18
+ parameters?: Array<'name' | 'in' | 'description' | 'required' | 'schema'>;
19
+ requestBody?: Array<'description' | 'required' | 'content'>;
20
+ responses?: Array<'description' | 'headers' | 'content' | 'links'>;
21
+ content?: Array<string>;
22
+ components?: Array<'parameters' | 'schemas'>;
23
+ schema?: Array<'description' | 'type' | 'items' | 'properties' | 'format' | 'example' | 'default'>;
24
+ schemas?: Array<'description' | 'type' | 'items' | 'properties' | 'format' | 'example' | 'default'>;
25
+ properties?: Array<'description' | 'type' | 'items' | 'format' | 'example' | 'default' | 'enum'>;
26
+ };
27
+ filterSet?: {
28
+ methods?: Array<'get' | 'post' | 'put' | 'patch' | 'delete'>;
29
+ inverseMethods?: Array<'get' | 'post' | 'put' | 'patch' | 'delete'>;
30
+ tags?: Array<string>;
31
+ inverseTags?: Array<string>;
32
+ operationIds?: Array<string>;
33
+ inverseOperationIds?: Array<string>;
34
+ operations?: Array<string>;
35
+ flags?: Array<string>;
36
+ inverseFlags?: Array<string>;
37
+ flagValues?: Array<string>;
38
+ inverseFlagValues?: Array<string>;
39
+ stripFlags?: Array<string>;
40
+ responseContent?: Array<string>;
41
+ inverseResponseContent?: Array<string>;
42
+ unusedComponents?: Array<'requestBodies' | 'schemas' | 'parameters' | 'responses'>;
43
+ };
44
+ sortComponentsSet?: {};
45
+ casingSet?: {};
46
+ };
47
+ declare function parse(pathOrApi: string | OASDocument, options?: FormatOptions): Promise<Oas>;
7
48
 
8
- export { parse };
49
+ export { type FormatOptions, parse };
package/dist/parser.js CHANGED
@@ -1,12 +1,13 @@
1
1
  import {
2
2
  Oas,
3
+ filterAndSort,
3
4
  isOpenApiV2Document
4
- } from "./chunk-2SLQJGDM.js";
5
+ } from "./chunk-ADBW4NBH.js";
5
6
 
6
7
  // src/parser/index.ts
7
8
  import OASNormalize from "oas-normalize";
8
9
  import swagger2openapi from "swagger2openapi";
9
- async function parse(pathOrApi) {
10
+ async function parse(pathOrApi, options = {}) {
10
11
  const oasNormalize = new OASNormalize(pathOrApi, {
11
12
  enablePaths: true,
12
13
  colorizeErrors: true
@@ -18,10 +19,12 @@ async function parse(pathOrApi) {
18
19
  document = await oasNormalize.load();
19
20
  }
20
21
  if (isOpenApiV2Document(document)) {
21
- const { openapi: oas } = await swagger2openapi.convertObj(document, { anchors: true });
22
- return new Oas({ oas });
22
+ const { openapi } = await swagger2openapi.convertObj(document, { anchors: true });
23
+ const oas2 = await filterAndSort(openapi, options);
24
+ return new Oas({ oas: oas2 });
23
25
  }
24
- return new Oas({ oas: document });
26
+ const oas = await filterAndSort(document, options);
27
+ return new Oas({ oas });
25
28
  }
26
29
  export {
27
30
  parse
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/parser/index.ts"],"sourcesContent":["import OASNormalize from 'oas-normalize'\nimport swagger2openapi from 'swagger2openapi'\n\nimport { Oas } from '../Oas.ts'\nimport { isOpenApiV2Document } from '../utils.ts'\n\nimport type { OASDocument } from 'oas/types'\nimport type { OpenAPI } from 'openapi-types'\n\nexport async function parse(pathOrApi: string | OASDocument): Promise<Oas> {\n const oasNormalize = new OASNormalize(pathOrApi, {\n enablePaths: true,\n colorizeErrors: true,\n })\n let document: OpenAPI.Document\n\n try {\n // resolve external refs\n document = await oasNormalize.bundle()\n } catch (e) {\n document = (await oasNormalize.load()) as OpenAPI.Document\n }\n\n if (isOpenApiV2Document(document)) {\n const { openapi: oas } = await swagger2openapi.convertObj(document, { anchors: true })\n\n return new Oas({ oas: oas as OASDocument })\n }\n\n return new Oas({ oas: document })\n}\n"],"mappings":";;;;;;AAAA,OAAO,kBAAkB;AACzB,OAAO,qBAAqB;AAQ5B,eAAsB,MAAM,WAA+C;AACzE,QAAM,eAAe,IAAI,aAAa,WAAW;AAAA,IAC/C,aAAa;AAAA,IACb,gBAAgB;AAAA,EAClB,CAAC;AACD,MAAI;AAEJ,MAAI;AAEF,eAAW,MAAM,aAAa,OAAO;AAAA,EACvC,SAAS,GAAG;AACV,eAAY,MAAM,aAAa,KAAK;AAAA,EACtC;AAEA,MAAI,oBAAoB,QAAQ,GAAG;AACjC,UAAM,EAAE,SAAS,IAAI,IAAI,MAAM,gBAAgB,WAAW,UAAU,EAAE,SAAS,KAAK,CAAC;AAErF,WAAO,IAAI,IAAI,EAAE,IAAwB,CAAC;AAAA,EAC5C;AAEA,SAAO,IAAI,IAAI,EAAE,KAAK,SAAS,CAAC;AAClC;","names":[]}
1
+ {"version":3,"sources":["../src/parser/index.ts"],"sourcesContent":["import OASNormalize from 'oas-normalize'\nimport swagger2openapi from 'swagger2openapi'\n\nimport { Oas } from '../Oas.ts'\nimport { filterAndSort, isOpenApiV2Document } from '../utils.ts'\n\nimport type { OASDocument } from 'oas/types'\nimport type { OpenAPI } from 'openapi-types'\n\nexport type FormatOptions = {\n verbose?: boolean\n 'no-sort'?: boolean\n sort?: boolean\n output?: string\n sortSet?: {\n root?: Array<'openapi' | 'info' | 'servers' | 'paths' | 'components' | 'tags' | 'x-tagGroups' | 'externalDocs'>\n get?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>\n post?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>\n put?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>\n patch?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>\n delete?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>\n parameters?: Array<'name' | 'in' | 'description' | 'required' | 'schema'>\n requestBody?: Array<'description' | 'required' | 'content'>\n responses?: Array<'description' | 'headers' | 'content' | 'links'>\n content?: Array<string>\n components?: Array<'parameters' | 'schemas'>\n schema?: Array<'description' | 'type' | 'items' | 'properties' | 'format' | 'example' | 'default'>\n schemas?: Array<'description' | 'type' | 'items' | 'properties' | 'format' | 'example' | 'default'>\n properties?: Array<'description' | 'type' | 'items' | 'format' | 'example' | 'default' | 'enum'>\n }\n filterSet?: {\n methods?: Array<'get' | 'post' | 'put' | 'patch' | 'delete'>\n inverseMethods?: Array<'get' | 'post' | 'put' | 'patch' | 'delete'>\n tags?: Array<string>\n inverseTags?: Array<string>\n operationIds?: Array<string>\n inverseOperationIds?: Array<string>\n operations?: Array<string>\n flags?: Array<string>\n inverseFlags?: Array<string>\n flagValues?: Array<string>\n inverseFlagValues?: Array<string>\n stripFlags?: Array<string>\n responseContent?: Array<string>\n inverseResponseContent?: Array<string>\n unusedComponents?: Array<'requestBodies' | 'schemas' | 'parameters' | 'responses'>\n }\n sortComponentsSet?: {}\n casingSet?: {}\n}\n\nexport async function parse(pathOrApi: string | OASDocument, options: FormatOptions = {}): Promise<Oas> {\n const oasNormalize = new OASNormalize(pathOrApi, {\n enablePaths: true,\n colorizeErrors: true,\n })\n let document: OpenAPI.Document\n\n try {\n // resolve external refs\n document = await oasNormalize.bundle()\n } catch (e) {\n document = (await oasNormalize.load()) as OpenAPI.Document\n }\n\n if (isOpenApiV2Document(document)) {\n const { openapi } = await swagger2openapi.convertObj(document, { anchors: true })\n\n const oas = await filterAndSort(openapi as OASDocument, options)\n\n return new Oas({ oas: oas as OASDocument })\n }\n\n const oas = await filterAndSort(document as OASDocument, options)\n\n return new Oas({ oas })\n}\n"],"mappings":";;;;;;;AAAA,OAAO,kBAAkB;AACzB,OAAO,qBAAqB;AAkD5B,eAAsB,MAAM,WAAiC,UAAyB,CAAC,GAAiB;AACtG,QAAM,eAAe,IAAI,aAAa,WAAW;AAAA,IAC/C,aAAa;AAAA,IACb,gBAAgB;AAAA,EAClB,CAAC;AACD,MAAI;AAEJ,MAAI;AAEF,eAAW,MAAM,aAAa,OAAO;AAAA,EACvC,SAAS,GAAG;AACV,eAAY,MAAM,aAAa,KAAK;AAAA,EACtC;AAEA,MAAI,oBAAoB,QAAQ,GAAG;AACjC,UAAM,EAAE,QAAQ,IAAI,MAAM,gBAAgB,WAAW,UAAU,EAAE,SAAS,KAAK,CAAC;AAEhF,UAAMA,OAAM,MAAM,cAAc,SAAwB,OAAO;AAE/D,WAAO,IAAI,IAAI,EAAE,KAAKA,KAAmB,CAAC;AAAA,EAC5C;AAEA,QAAM,MAAM,MAAM,cAAc,UAAyB,OAAO;AAEhE,SAAO,IAAI,IAAI,EAAE,IAAI,CAAC;AACxB;","names":["oas"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kubb/oas",
3
- "version": "2.14.0",
3
+ "version": "2.16.0",
4
4
  "description": "Oas helpers",
5
5
  "keywords": [
6
6
  "typescript",
@@ -52,12 +52,14 @@
52
52
  "json-schema-to-ts": "^3.0.1",
53
53
  "oas": "^24.2.2",
54
54
  "oas-normalize": "^11.0.4",
55
+ "openapi-format": "^1.17.0",
55
56
  "openapi-types": "^12.1.3",
56
57
  "remeda": "^1.61.0",
57
58
  "swagger2openapi": "^7.0.8",
58
59
  "ts-toolbelt": "^9.6.0"
59
60
  },
60
61
  "devDependencies": {
62
+ "@stoplight/yaml": "^4.3.0",
61
63
  "@types/swagger2openapi": "^7.0.4",
62
64
  "expect-type": "^0.19.0",
63
65
  "tsup": "^8.0.2",
package/src/Oas.ts CHANGED
@@ -1,10 +1,13 @@
1
1
  import BaseOas from 'oas'
2
2
  import OASNormalize from 'oas-normalize'
3
+ import { findSchemaDefinition, matchesMimeType } from 'oas/utils'
4
+
5
+ import { isReference } from './utils.ts'
6
+
3
7
  import type { Operation } from 'oas/operation'
4
8
  import type { MediaTypeObject, OASDocument, ResponseObject, SchemaObject, User } from 'oas/types'
5
- import { findSchemaDefinition, matchesMimeType } from 'oas/utils'
6
9
  import type { contentType } from './types.ts'
7
- import { isReference } from './utils.ts'
10
+
8
11
  type Options = {
9
12
  contentType?: contentType
10
13
  }
package/src/index.ts CHANGED
@@ -1,3 +1,5 @@
1
+ import './typings.d.ts'
2
+
1
3
  export * from './types.ts'
2
4
  export { findSchemaDefinition, matchesMimeType } from 'oas/utils'
3
5
  export { isRequired, isReference, isParameterObject, isOpenApiV3_1Document } from './utils.ts'
@@ -1,6 +1,6 @@
1
- import type { OasTypes } from '@kubb/oas'
2
1
  import type { Fn, Pipe, Tuples } from 'hotscript'
3
2
  import type { FromSchema, JSONSchema } from 'json-schema-to-ts'
3
+ import type { OasTypes } from '../types.ts'
4
4
 
5
5
  type Checks<TParamType = never> = {
6
6
  Required: { required: true }
@@ -1,5 +1,5 @@
1
- import type { OasTypes } from '@kubb/oas'
2
1
  import type { FromSchema, JSONSchema } from 'json-schema-to-ts'
2
+ import type { OasTypes } from '../types.ts'
3
3
 
4
4
  type Checks<TName extends string | number | symbol = never> = {
5
5
  ModelWithSchemas: {
@@ -1,7 +1,7 @@
1
- import type { OasTypes } from '@kubb/oas'
2
1
  import type { SplitByDelimiter, TupleToUnion } from '@kubb/types'
3
2
  import type { Pipe, Strings, Tuples } from 'hotscript'
4
3
  import type { FromSchema, JSONSchema } from 'json-schema-to-ts'
4
+ import type { OasTypes } from '../types.ts'
5
5
  import type { MethodMap, ParamMap, PathMap } from './mappers.ts'
6
6
  import type { SecurityParamsBySecurityRef } from './security.ts'
7
7
 
@@ -1,5 +1,5 @@
1
- import type { OasTypes } from '@kubb/oas'
2
1
  import type { FromSchema } from 'json-schema-to-ts'
2
+ import type { OasTypes } from '../types.ts'
3
3
  import type { MethodMap, PathMap, StatusMap } from './mappers.ts'
4
4
 
5
5
  type Checks = {
@@ -2,12 +2,54 @@ import OASNormalize from 'oas-normalize'
2
2
  import swagger2openapi from 'swagger2openapi'
3
3
 
4
4
  import { Oas } from '../Oas.ts'
5
- import { isOpenApiV2Document } from '../utils.ts'
5
+ import { filterAndSort, isOpenApiV2Document } from '../utils.ts'
6
6
 
7
7
  import type { OASDocument } from 'oas/types'
8
8
  import type { OpenAPI } from 'openapi-types'
9
9
 
10
- export async function parse(pathOrApi: string | OASDocument): Promise<Oas> {
10
+ export type FormatOptions = {
11
+ verbose?: boolean
12
+ 'no-sort'?: boolean
13
+ sort?: boolean
14
+ output?: string
15
+ sortSet?: {
16
+ root?: Array<'openapi' | 'info' | 'servers' | 'paths' | 'components' | 'tags' | 'x-tagGroups' | 'externalDocs'>
17
+ get?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>
18
+ post?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>
19
+ put?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>
20
+ patch?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>
21
+ delete?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>
22
+ parameters?: Array<'name' | 'in' | 'description' | 'required' | 'schema'>
23
+ requestBody?: Array<'description' | 'required' | 'content'>
24
+ responses?: Array<'description' | 'headers' | 'content' | 'links'>
25
+ content?: Array<string>
26
+ components?: Array<'parameters' | 'schemas'>
27
+ schema?: Array<'description' | 'type' | 'items' | 'properties' | 'format' | 'example' | 'default'>
28
+ schemas?: Array<'description' | 'type' | 'items' | 'properties' | 'format' | 'example' | 'default'>
29
+ properties?: Array<'description' | 'type' | 'items' | 'format' | 'example' | 'default' | 'enum'>
30
+ }
31
+ filterSet?: {
32
+ methods?: Array<'get' | 'post' | 'put' | 'patch' | 'delete'>
33
+ inverseMethods?: Array<'get' | 'post' | 'put' | 'patch' | 'delete'>
34
+ tags?: Array<string>
35
+ inverseTags?: Array<string>
36
+ operationIds?: Array<string>
37
+ inverseOperationIds?: Array<string>
38
+ operations?: Array<string>
39
+ flags?: Array<string>
40
+ inverseFlags?: Array<string>
41
+ flagValues?: Array<string>
42
+ inverseFlagValues?: Array<string>
43
+ stripFlags?: Array<string>
44
+ responseContent?: Array<string>
45
+ inverseResponseContent?: Array<string>
46
+ unusedComponents?: Array<'requestBodies' | 'schemas' | 'parameters' | 'responses'>
47
+ }
48
+ sortComponentsSet?: {}
49
+ casingSet?: {}
50
+ }
51
+
52
+ export async function parse(pathOrApi: string | OASDocument, options: FormatOptions = {}): Promise<Oas> {
11
53
  const oasNormalize = new OASNormalize(pathOrApi, {
12
54
  enablePaths: true,
13
55
  colorizeErrors: true,
@@ -22,10 +64,14 @@ export async function parse(pathOrApi: string | OASDocument): Promise<Oas> {
22
64
  }
23
65
 
24
66
  if (isOpenApiV2Document(document)) {
25
- const { openapi: oas } = await swagger2openapi.convertObj(document, { anchors: true })
67
+ const { openapi } = await swagger2openapi.convertObj(document, { anchors: true })
68
+
69
+ const oas = await filterAndSort(openapi as OASDocument, options)
26
70
 
27
71
  return new Oas({ oas: oas as OASDocument })
28
72
  }
29
73
 
30
- return new Oas({ oas: document })
74
+ const oas = await filterAndSort(document as OASDocument, options)
75
+
76
+ return new Oas({ oas })
31
77
  }
@@ -0,0 +1,51 @@
1
+ declare module 'openapi-format' {
2
+ interface Options {
3
+ verbose?: boolean
4
+ 'no-sort'?: boolean
5
+ sort?: boolean
6
+ output?: string
7
+ sortSet?: {
8
+ root?: Array<'openapi' | 'info' | 'servers' | 'paths' | 'components' | 'tags' | 'x-tagGroups' | 'externalDocs'>
9
+ get?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>
10
+ post?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>
11
+ put?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>
12
+ patch?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>
13
+ delete?: Array<'operationId' | 'summary' | 'description' | 'parameters' | 'requestBody' | 'responses'>
14
+ parameters?: Array<'name' | 'in' | 'description' | 'required' | 'schema'>
15
+ requestBody?: Array<'description' | 'required' | 'content'>
16
+ responses?: Array<'description' | 'headers' | 'content' | 'links'>
17
+ content?: Array<string>
18
+ components?: Array<'parameters' | 'schemas'>
19
+ schema?: Array<'description' | 'type' | 'items' | 'properties' | 'format' | 'example' | 'default'>
20
+ schemas?: Array<'description' | 'type' | 'items' | 'properties' | 'format' | 'example' | 'default'>
21
+ properties?: Array<'description' | 'type' | 'items' | 'format' | 'example' | 'default' | 'enum'>
22
+ }
23
+ filterSet?: {
24
+ methods?: Array<'get' | 'post' | 'put' | 'patch' | 'delete'>
25
+ inverseMethods?: Array<'get' | 'post' | 'put' | 'patch' | 'delete'>
26
+ tags?: Array<string>
27
+ inverseTags?: Array<string>
28
+ operationIds?: Array<string>
29
+ inverseOperationIds?: Array<string>
30
+ operations?: Array<string>
31
+ flags?: Array<string>
32
+ inverseFlags?: Array<string>
33
+ flagValues?: Array<string>
34
+ inverseFlagValues?: Array<string>
35
+ stripFlags?: Array<string>
36
+ responseContent?: Array<string>
37
+ inverseResponseContent?: Array<string>
38
+ unusedComponents?: Array<'requestBodies' | 'schemas' | 'parameters' | 'responses'>
39
+ }
40
+ sortComponentsSet?: {}
41
+ casingSet?: {}
42
+ }
43
+ function parseFile(path: string): Promise<unknown>
44
+
45
+ function openapiFilter<TOas>(document: TOas, options: Options): { data: Toas; resultData: { unusedComp: any } }
46
+
47
+ function openapiSort<TOas>(document: TOas, options: Options): { data: Toas; resultData: { unusedComp: any } }
48
+ function openapiChangeCase<TOas>(document: TOas, options: Options): { data: Toas; resultData: { unusedComp: any } }
49
+
50
+ function stringify<TOas>(document: TOas, options: Options): string
51
+ }
package/src/utils.ts CHANGED
@@ -1,7 +1,8 @@
1
- import type { ParameterObject, SchemaObject } from 'oas/types'
2
1
  import { isRef, isSchema } from 'oas/types'
3
- import { isObject } from 'remeda'
2
+ import openapiFormat from 'openapi-format'
3
+ import { isObject, mergeDeep } from 'remeda'
4
4
 
5
+ import type { OASDocument, ParameterObject, SchemaObject } from 'oas/types'
5
6
  import type { OpenAPIV2, OpenAPIV3, OpenAPIV3_1 } from 'openapi-types'
6
7
 
7
8
  export function isOpenApiV2Document(doc: any): doc is OpenAPIV2.Document {
@@ -34,3 +35,44 @@ export function isRequired(schema?: SchemaObject): boolean {
34
35
 
35
36
  return Array.isArray(schema.required) ? !!schema.required?.length : !!schema.required
36
37
  }
38
+
39
+ export async function filterAndSort(data: OASDocument, options: openapiFormat.Options = {}): Promise<OASDocument> {
40
+ const mergedOptions = mergeDeep(
41
+ {
42
+ sort: true,
43
+ sortSet: {
44
+ root: ['openapi', 'info', 'servers', 'paths', 'components', 'tags', 'x-tagGroups', 'externalDocs'],
45
+ get: ['operationId', 'summary', 'description', 'parameters', 'requestBody', 'responses'],
46
+ post: ['operationId', 'summary', 'description', 'parameters', 'requestBody', 'responses'],
47
+ put: ['operationId', 'summary', 'description', 'parameters', 'requestBody', 'responses'],
48
+ patch: ['operationId', 'summary', 'description', 'parameters', 'requestBody', 'responses'],
49
+ delete: ['operationId', 'summary', 'description', 'parameters', 'requestBody', 'responses'],
50
+ parameters: ['name', 'in', 'description', 'required', 'schema'],
51
+ requestBody: ['description', 'required', 'content'],
52
+ responses: ['description', 'headers', 'content', 'links'],
53
+ content: [],
54
+ components: ['parameters', 'schemas'],
55
+ schema: ['description', 'type', 'items', 'properties', 'format', 'example', 'default'],
56
+ schemas: ['description', 'type', 'items', 'properties', 'format', 'example', 'default'],
57
+ properties: ['description', 'type', 'items', 'format', 'example', 'default', 'enum'],
58
+ },
59
+ sortComponentsSet: {},
60
+ filterSet: {
61
+ unusedComponents: options.filterSet ? ['requestBodies', 'schemas', 'parameters', 'responses'] : [],
62
+ },
63
+ casingSet: {},
64
+ },
65
+ options as Record<string, unknown>,
66
+ ) as openapiFormat.Options
67
+
68
+ const restFilter = await openapiFormat.openapiFilter(data, mergedOptions)
69
+ data = restFilter.data
70
+
71
+ const resFormat = await openapiFormat.openapiSort(data, mergedOptions)
72
+ data = resFormat.data
73
+
74
+ const resChangeCase = await openapiFormat.openapiChangeCase(data, mergedOptions)
75
+ data = resChangeCase.data
76
+
77
+ return data
78
+ }
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../src/utils.ts","../src/Oas.ts"],"sourcesContent":["import type { ParameterObject, SchemaObject } from 'oas/types'\nimport { isRef, isSchema } from 'oas/types'\nimport { isObject } from 'remeda'\n\nimport type { OpenAPIV2, OpenAPIV3, OpenAPIV3_1 } from 'openapi-types'\n\nexport function isOpenApiV2Document(doc: any): doc is OpenAPIV2.Document {\n return doc && isObject(doc) && !('openapi' in doc)\n}\nexport function isOpenApiV3Document(doc: any): doc is OpenAPIV3.Document {\n return doc && isObject(doc) && 'openapi' in doc\n}\n\nexport function isOpenApiV3_1Document(doc: any): doc is OpenAPIV3_1.Document {\n return doc && isObject(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","import BaseOas from 'oas'\nimport OASNormalize from 'oas-normalize'\nimport type { Operation } from 'oas/operation'\nimport type { MediaTypeObject, OASDocument, ResponseObject, SchemaObject, User } from 'oas/types'\nimport { findSchemaDefinition, matchesMimeType } from 'oas/utils'\nimport type { contentType } from './types.ts'\nimport { isReference } from './utils.ts'\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 dereferenceWithRef(schema?: unknown) {\n if (isReference(schema)) {\n return {\n ...findSchemaDefinition(schema.$ref, this.api),\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] = findSchemaDefinition($ref, this.api)\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 }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AACA,SAAS,OAAO,gBAAgB;AAChC,SAAS,gBAAgB;AAIlB,SAAS,oBAAoB,KAAqC;AACvE,SAAO,OAAO,SAAS,GAAG,KAAK,EAAE,aAAa;AAChD;AAKO,SAAS,sBAAsB,KAAuC;AAC3E,SAAO,OAAO,SAAS,GAAG,KAAK,aAAa,OAAO,IAAI,QAAQ,WAAW,KAAK;AACjF;AAMO,SAAS,kBAAkB,KAA6D;AAC7F,SAAO,OAAO,QAAQ;AACxB;AAEO,SAAS,YAAY,KAA+E;AACzG,SAAO,CAAC,CAAC,OAAO,MAAM,GAAG;AAC3B;AAEO,SAAS,WAAW,QAAgC;AACzD,MAAI,CAAC,QAAQ;AACX,WAAO;AAAA,EACT;AAEA,SAAO,MAAM,QAAQ,OAAO,QAAQ,IAAI,CAAC,CAAC,OAAO,UAAU,SAAS,CAAC,CAAC,OAAO;AAC/E;;;ACnCA,OAAO,aAAa;AACpB,OAAO,kBAAkB;AAGzB,SAAS,sBAAsB,uBAAuB;AAJtD;AAWO,IAAM,MAAN,cAAwC,QAAQ;AAAA,EAIrD,YAAY,EAAE,KAAK,KAAK,GAAsD,UAAmB,CAAC,GAAG;AACnG,QAAI,OAAO,QAAQ,UAAU;AAC3B,YAAM,KAAK,MAAM,GAAG;AAAA,IACtB;AAEA,UAAM,KAAoB,IAAI;AAoBhC;AAAA;AAAA;AAAA;AA5BA,iCAAoB,CAAC;AACrB,oBAAiB;AASf,SAAK,WAAW;AAChB,uBAAK,UAAW;AAAA,EAClB;AAAA,EAEA,mBAAmB,QAAkB;AACnC,QAAI,YAAY,MAAM,GAAG;AACvB,aAAO;AAAA,QACL,GAAG,qBAAqB,OAAO,MAAM,KAAK,GAAG;AAAA,QAC7C,MAAM,OAAO;AAAA,MACf;AAAA,IACF;AAEA,WAAO;AAAA,EACT;AAAA,EA2DA,kBAAkB,WAAsB,YAA2C;AACjF,QAAI,UAAU,OAAO,WAAW;AAC9B,aAAO,KAAK,UAAU,OAAO,SAAS,EAAE,QAAQ,CAAC,QAAQ;AACvD,cAAMA,UAAS,UAAU,OAAO,UAAW,GAAG;AAC9C,cAAM,OAAO,YAAYA,OAAM,IAAIA,QAAO,OAAO;AAEjD,YAAIA,WAAU,MAAM;AAClB,oBAAU,OAAO,UAAW,GAAG,IAAI,qBAAqB,MAAM,KAAK,GAAG;AAAA,QACxE;AAAA,MACF,CAAC;AAAA,IACH;AAEA,UAAM,kBAAkB,sBAAK,oDAAL,WAA6B,UAAU,wBAAwB,UAAU;AAEjG,UAAM,EAAE,YAAY,IAAI,mBAAK;AAC7B,UAAM,eAAe,gBAAgB,WAAW;AAEhD,QAAI,iBAAiB,OAAO;AAE1B,aAAO,CAAC;AAAA,IACV;AAEA,UAAM,SAAS,MAAM,QAAQ,YAAY,IAAI,aAAa,CAAC,EAAE,SAAS,aAAa;AAEnF,QAAI,CAAC,QAAQ;AAGX,aAAO,CAAC;AAAA,IACV;AAEA,WAAO,KAAK,mBAAmB,MAAM;AAAA,EACvC;AAAA,EAEA,iBAAiB,WAAgD;AAC/D,UAAM,EAAE,YAAY,IAAI,mBAAK;AAE7B,QAAI,UAAU,OAAO,aAAa;AAChC,gBAAU,OAAO,cAAc,KAAK,mBAAmB,UAAU,OAAO,WAAW;AAAA,IACrF;AAEA,UAAM,cAAc,UAAU,eAAe,WAAW;AAExD,QAAI,gBAAgB,OAAO;AACzB,aAAO;AAAA,IACT;AAEA,UAAM,SAAS,MAAM,QAAQ,WAAW,IAAI,YAAY,CAAC,EAAE,SAAS,YAAY;AAEhF,QAAI,CAAC,QAAQ;AACX,aAAO;AAAA,IACT;AAEA,WAAO,KAAK,mBAAmB,MAAM;AAAA,EACvC;AAAA,EAEA,oBAAoB,WAAsB,OAAyD;AACjG,UAAM,EAAE,cAAc,UAAU,eAAe,EAAE,IAAI,mBAAK;AAC1D,UAAM,SAAS,UACZ,cAAc,EACd,IAAI,CAAC,WAAW;AACf,aAAO,KAAK,mBAAmB,MAAM;AAAA,IACvC,CAAC,EACA,OAAO,CAAC,MAAM,EAAE,OAAO,KAAK;AAE/B,QAAI,CAAC,OAAO,QAAQ;AAClB,aAAO;AAAA,IACT;AAEA,WAAO,OAAO;AAAA,MACZ,CAAC,QAAQ,mBAAmB;AAC1B,cAAM,WAAW,eAAe,UAAU,WAAW,GAAG,UAAW,eAAe;AAClF,cAAM,WAAW,CAAC,GAAI,OAAO,YAAa,CAAC,GAAY,eAAe,WAAW,eAAe,OAAO,MAAS,EAAE,OAAO,OAAO;AAEhI,eAAO;AAAA,UACL,GAAG;AAAA,UACH,aAAa,OAAO;AAAA,UACpB,YAAY,OAAO;AAAA,UACnB,SAAS,OAAO;AAAA,UAChB;AAAA,UACA,YAAY;AAAA,YACV,GAAG,OAAO;AAAA,YACV,CAAC,eAAe,IAAI,GAAG;AAAA,cACrB,aAAa,eAAe;AAAA,cAC5B,GAAG;AAAA,YACL;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,MACA,EAAE,MAAM,UAAU,UAAU,CAAC,GAAG,YAAY,CAAC,EAAE;AAAA,IACjD;AAAA,EACF;AAAA,EAEA,MAAM,WAAW;AACf,UAAM,eAAe,IAAI,aAAa,KAAK,KAAK;AAAA,MAC9C,aAAa;AAAA,MACb,gBAAgB;AAAA,IAClB,CAAC;AAED,UAAM,aAAa,SAAS;AAAA,EAC9B;AACF;AAtLE;AA4BA;AAAA,4BAAuB,SAAC,cAAoI;AAC1J,WAAS,gBAAgB,MAAM,cAAqC;AAClE,WAAO,CAAC,CAAC;AAAA,EACX;AAEA,SAAO,CAAC,gBAAgB;AACtB,QAAI,CAAC,gBAAgB,YAAY,GAAG;AAClC,aAAO;AAAA,IACT;AAEA,QAAI,YAAY,YAAY,GAAG;AAG7B,aAAO;AAAA,IACT;AAEA,QAAI,CAAC,aAAa,SAAS;AACzB,aAAO;AAAA,IACT;AAEA,QAAI,aAAa;AACf,UAAI,EAAE,eAAe,aAAa,UAAU;AAC1C,eAAO;AAAA,MACT;AAEA,aAAO,aAAa,QAAQ,WAAW;AAAA,IACzC;AAIA,QAAI,uBAA2C;AAC/C,UAAM,eAAe,OAAO,KAAK,aAAa,OAAO;AACrD,iBAAa,QAAQ,CAAC,OAAe;AACnC,UAAI,CAAC,wBAAwB,gBAAgB,KAAK,EAAE,GAAG;AACrD,+BAAuB;AAAA,MACzB;AAAA,IACF,CAAC;AAED,QAAI,CAAC,sBAAsB;AACzB,mBAAa,QAAQ,CAAC,OAAe;AACnC,YAAI,CAAC,sBAAsB;AACzB,iCAAuB;AAAA,QACzB;AAAA,MACF,CAAC;AAAA,IACH;AAEA,QAAI,sBAAsB;AACxB,aAAO,CAAC,sBAAsB,aAAa,QAAQ,oBAAoB,GAAI,GAAI,aAAa,cAAc,CAAC,aAAa,WAAW,IAAI,CAAC,CAAE;AAAA,IAC5I;AAEA,WAAO;AAAA,EACT;AACF;","names":["schema"]}
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../src/utils.ts","../src/Oas.ts"],"names":["schema"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AACA,SAAS,OAAO,gBAAgB;AAChC,SAAS,gBAAgB;AAIlB,SAAS,oBAAoB,KAAqC;AACvE,SAAO,OAAO,SAAS,GAAG,KAAK,EAAE,aAAa;AAChD;AAKO,SAAS,sBAAsB,KAAuC;AAC3E,SAAO,OAAO,SAAS,GAAG,KAAK,aAAa,OAAO,IAAI,QAAQ,WAAW,KAAK;AACjF;AAMO,SAAS,kBAAkB,KAA6D;AAC7F,SAAO,OAAO,QAAQ;AACxB;AAEO,SAAS,YAAY,KAA+E;AACzG,SAAO,CAAC,CAAC,OAAO,MAAM,GAAG;AAC3B;AAEO,SAAS,WAAW,QAAgC;AACzD,MAAI,CAAC,QAAQ;AACX,WAAO;AAAA,EACT;AAEA,SAAO,MAAM,QAAQ,OAAO,QAAQ,IAAI,CAAC,CAAC,OAAO,UAAU,SAAS,CAAC,CAAC,OAAO;AAC/E;;;ACnCA,OAAO,aAAa;AACpB,OAAO,kBAAkB;AAGzB,SAAS,sBAAsB,uBAAuB;AAJtD;AAWO,IAAM,MAAN,cAAwC,QAAQ;AAAA,EAIrD,YAAY,EAAE,KAAK,KAAK,GAAsD,UAAmB,CAAC,GAAG;AACnG,QAAI,OAAO,QAAQ,UAAU;AAC3B,YAAM,KAAK,MAAM,GAAG;AAAA,IACtB;AAEA,UAAM,KAAoB,IAAI;AAoBhC;AAAA;AAAA;AAAA;AA5BA,iCAAoB,CAAC;AACrB,oBAAiB;AASf,SAAK,WAAW;AAChB,uBAAK,UAAW;AAAA,EAClB;AAAA,EAEA,mBAAmB,QAAkB;AACnC,QAAI,YAAY,MAAM,GAAG;AACvB,aAAO;AAAA,QACL,GAAG,qBAAqB,OAAO,MAAM,KAAK,GAAG;AAAA,QAC7C,MAAM,OAAO;AAAA,MACf;AAAA,IACF;AAEA,WAAO;AAAA,EACT;AAAA,EA2DA,kBAAkB,WAAsB,YAA2C;AACjF,QAAI,UAAU,OAAO,WAAW;AAC9B,aAAO,KAAK,UAAU,OAAO,SAAS,EAAE,QAAQ,CAAC,QAAQ;AACvD,cAAMA,UAAS,UAAU,OAAO,UAAW,GAAG;AAC9C,cAAM,OAAO,YAAYA,OAAM,IAAIA,QAAO,OAAO;AAEjD,YAAIA,WAAU,MAAM;AAClB,oBAAU,OAAO,UAAW,GAAG,IAAI,qBAAqB,MAAM,KAAK,GAAG;AAAA,QACxE;AAAA,MACF,CAAC;AAAA,IACH;AAEA,UAAM,kBAAkB,sBAAK,oDAAL,WAA6B,UAAU,wBAAwB,UAAU;AAEjG,UAAM,EAAE,YAAY,IAAI,mBAAK;AAC7B,UAAM,eAAe,gBAAgB,WAAW;AAEhD,QAAI,iBAAiB,OAAO;AAE1B,aAAO,CAAC;AAAA,IACV;AAEA,UAAM,SAAS,MAAM,QAAQ,YAAY,IAAI,aAAa,CAAC,EAAE,SAAS,aAAa;AAEnF,QAAI,CAAC,QAAQ;AAGX,aAAO,CAAC;AAAA,IACV;AAEA,WAAO,KAAK,mBAAmB,MAAM;AAAA,EACvC;AAAA,EAEA,iBAAiB,WAAgD;AAC/D,UAAM,EAAE,YAAY,IAAI,mBAAK;AAE7B,QAAI,UAAU,OAAO,aAAa;AAChC,gBAAU,OAAO,cAAc,KAAK,mBAAmB,UAAU,OAAO,WAAW;AAAA,IACrF;AAEA,UAAM,cAAc,UAAU,eAAe,WAAW;AAExD,QAAI,gBAAgB,OAAO;AACzB,aAAO;AAAA,IACT;AAEA,UAAM,SAAS,MAAM,QAAQ,WAAW,IAAI,YAAY,CAAC,EAAE,SAAS,YAAY;AAEhF,QAAI,CAAC,QAAQ;AACX,aAAO;AAAA,IACT;AAEA,WAAO,KAAK,mBAAmB,MAAM;AAAA,EACvC;AAAA,EAEA,oBAAoB,WAAsB,OAAyD;AACjG,UAAM,EAAE,cAAc,UAAU,eAAe,EAAE,IAAI,mBAAK;AAC1D,UAAM,SAAS,UACZ,cAAc,EACd,IAAI,CAAC,WAAW;AACf,aAAO,KAAK,mBAAmB,MAAM;AAAA,IACvC,CAAC,EACA,OAAO,CAAC,MAAM,EAAE,OAAO,KAAK;AAE/B,QAAI,CAAC,OAAO,QAAQ;AAClB,aAAO;AAAA,IACT;AAEA,WAAO,OAAO;AAAA,MACZ,CAAC,QAAQ,mBAAmB;AAC1B,cAAM,WAAW,eAAe,UAAU,WAAW,GAAG,UAAW,eAAe;AAClF,cAAM,WAAW,CAAC,GAAI,OAAO,YAAa,CAAC,GAAY,eAAe,WAAW,eAAe,OAAO,MAAS,EAAE,OAAO,OAAO;AAEhI,eAAO;AAAA,UACL,GAAG;AAAA,UACH,aAAa,OAAO;AAAA,UACpB,YAAY,OAAO;AAAA,UACnB,SAAS,OAAO;AAAA,UAChB;AAAA,UACA,YAAY;AAAA,YACV,GAAG,OAAO;AAAA,YACV,CAAC,eAAe,IAAI,GAAG;AAAA,cACrB,aAAa,eAAe;AAAA,cAC5B,GAAG;AAAA,YACL;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,MACA,EAAE,MAAM,UAAU,UAAU,CAAC,GAAG,YAAY,CAAC,EAAE;AAAA,IACjD;AAAA,EACF;AAAA,EAEA,MAAM,WAAW;AACf,UAAM,eAAe,IAAI,aAAa,KAAK,KAAK;AAAA,MAC9C,aAAa;AAAA,MACb,gBAAgB;AAAA,IAClB,CAAC;AAED,UAAM,aAAa,SAAS;AAAA,EAC9B;AACF;AAtLE;AA4BA;AAAA,4BAAuB,SAAC,cAAoI;AAC1J,WAAS,gBAAgB,MAAM,cAAqC;AAClE,WAAO,CAAC,CAAC;AAAA,EACX;AAEA,SAAO,CAAC,gBAAgB;AACtB,QAAI,CAAC,gBAAgB,YAAY,GAAG;AAClC,aAAO;AAAA,IACT;AAEA,QAAI,YAAY,YAAY,GAAG;AAG7B,aAAO;AAAA,IACT;AAEA,QAAI,CAAC,aAAa,SAAS;AACzB,aAAO;AAAA,IACT;AAEA,QAAI,aAAa;AACf,UAAI,EAAE,eAAe,aAAa,UAAU;AAC1C,eAAO;AAAA,MACT;AAEA,aAAO,aAAa,QAAQ,WAAW;AAAA,IACzC;AAIA,QAAI,uBAA2C;AAC/C,UAAM,eAAe,OAAO,KAAK,aAAa,OAAO;AACrD,iBAAa,QAAQ,CAAC,OAAe;AACnC,UAAI,CAAC,wBAAwB,gBAAgB,KAAK,EAAE,GAAG;AACrD,+BAAuB;AAAA,MACzB;AAAA,IACF,CAAC;AAED,QAAI,CAAC,sBAAsB;AACzB,mBAAa,QAAQ,CAAC,OAAe;AACnC,YAAI,CAAC,sBAAsB;AACzB,iCAAuB;AAAA,QACzB;AAAA,MACF,CAAC;AAAA,IACH;AAEA,QAAI,sBAAsB;AACxB,aAAO,CAAC,sBAAsB,aAAa,QAAQ,oBAAoB,GAAI,GAAI,aAAa,cAAc,CAAC,aAAa,WAAW,IAAI,CAAC,CAAE;AAAA,IAC5I;AAEA,WAAO;AAAA,EACT;AACF","sourcesContent":["import type { ParameterObject, SchemaObject } from 'oas/types'\nimport { isRef, isSchema } from 'oas/types'\nimport { isObject } from 'remeda'\n\nimport type { OpenAPIV2, OpenAPIV3, OpenAPIV3_1 } from 'openapi-types'\n\nexport function isOpenApiV2Document(doc: any): doc is OpenAPIV2.Document {\n return doc && isObject(doc) && !('openapi' in doc)\n}\nexport function isOpenApiV3Document(doc: any): doc is OpenAPIV3.Document {\n return doc && isObject(doc) && 'openapi' in doc\n}\n\nexport function isOpenApiV3_1Document(doc: any): doc is OpenAPIV3_1.Document {\n return doc && isObject(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","import BaseOas from 'oas'\nimport OASNormalize from 'oas-normalize'\nimport type { Operation } from 'oas/operation'\nimport type { MediaTypeObject, OASDocument, ResponseObject, SchemaObject, User } from 'oas/types'\nimport { findSchemaDefinition, matchesMimeType } from 'oas/utils'\nimport type { contentType } from './types.ts'\nimport { isReference } from './utils.ts'\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 dereferenceWithRef(schema?: unknown) {\n if (isReference(schema)) {\n return {\n ...findSchemaDefinition(schema.$ref, this.api),\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] = findSchemaDefinition($ref, this.api)\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 }\n}\n"]}