@sdk-it/spec 0.46.10 → 0.47.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.
- package/README.md +8 -4
- package/dist/index.d.ts +2 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2 -1
- package/dist/index.js.map +2 -2
- package/dist/lib/external-documents.d.ts +10 -0
- package/dist/lib/external-documents.d.ts.map +1 -0
- package/dist/lib/external-documents.js +61 -0
- package/dist/lib/external-documents.js.map +7 -0
- package/dist/lib/finalize-operations.d.ts +8 -0
- package/dist/lib/finalize-operations.d.ts.map +1 -0
- package/dist/lib/finalize-operations.js +134 -0
- package/dist/lib/finalize-operations.js.map +7 -0
- package/dist/lib/find-polymorphic-varients.d.ts.map +1 -1
- package/dist/lib/find-polymorphic-varients.js +3 -2
- package/dist/lib/find-polymorphic-varients.js.map +2 -2
- package/dist/lib/find-unique-schema-name.d.ts.map +1 -1
- package/dist/lib/for-each-operation.d.ts +3 -2
- package/dist/lib/for-each-operation.d.ts.map +1 -1
- package/dist/lib/for-each-operation.js +9 -4
- package/dist/lib/for-each-operation.js.map +2 -2
- package/dist/lib/format-name.d.ts.map +1 -1
- package/dist/lib/get-ref-usage.d.ts.map +1 -1
- package/dist/lib/get-ref-usage.js +1 -2
- package/dist/lib/get-ref-usage.js.map +2 -2
- package/dist/lib/guess/guess-resource.d.ts.map +1 -1
- package/dist/lib/guess/guess-resource.js +4 -4
- package/dist/lib/guess/guess-resource.js.map +2 -2
- package/dist/lib/ir.d.ts +2 -2
- package/dist/lib/ir.d.ts.map +1 -1
- package/dist/lib/ir.js +5 -3
- package/dist/lib/ir.js.map +2 -2
- package/dist/lib/is-primitive-schema.d.ts +12 -0
- package/dist/lib/is-primitive-schema.d.ts.map +1 -1
- package/dist/lib/is-primitive-schema.js +34 -1
- package/dist/lib/is-primitive-schema.js.map +2 -2
- package/dist/lib/is.d.ts +10 -1
- package/dist/lib/is.d.ts.map +1 -1
- package/dist/lib/is.js +20 -9
- package/dist/lib/is.js.map +2 -2
- package/dist/lib/loaders/load-spec.d.ts +9 -2
- package/dist/lib/loaders/load-spec.d.ts.map +1 -1
- package/dist/lib/loaders/load-spec.js +15 -20
- package/dist/lib/loaders/load-spec.js.map +2 -2
- package/dist/lib/loaders/local-loader.d.ts.map +1 -1
- package/dist/lib/loaders/postman/postman-converter.d.ts +1 -1
- package/dist/lib/loaders/postman/postman-converter.d.ts.map +1 -1
- package/dist/lib/loaders/postman/postman-converter.js +2 -3
- package/dist/lib/loaders/postman/postman-converter.js.map +2 -2
- package/dist/lib/loaders/postman/spec-types.d.ts.map +1 -1
- package/dist/lib/loaders/remote-loader.d.ts.map +1 -1
- package/dist/lib/loaders/remote-loader.js +4 -3
- package/dist/lib/loaders/remote-loader.js.map +2 -2
- package/dist/lib/metadata.d.ts +3 -9
- package/dist/lib/metadata.d.ts.map +1 -1
- package/dist/lib/metadata.js +22 -17
- package/dist/lib/metadata.js.map +2 -2
- package/dist/lib/operation-input.d.ts +33 -0
- package/dist/lib/operation-input.d.ts.map +1 -0
- package/dist/lib/operation-input.js +189 -0
- package/dist/lib/operation-input.js.map +7 -0
- package/dist/lib/options.d.ts +5 -6
- package/dist/lib/options.d.ts.map +1 -1
- package/dist/lib/options.js +0 -6
- package/dist/lib/options.js.map +2 -2
- package/dist/lib/overview-docs/doc-text-utils.d.ts +13 -13
- package/dist/lib/overview-docs/doc-text-utils.d.ts.map +1 -1
- package/dist/lib/overview-docs/overview-auth.d.ts.map +1 -1
- package/dist/lib/overview-docs/overview-auth.js.map +2 -2
- package/dist/lib/overview-docs/overview-docs.d.ts.map +1 -1
- package/dist/lib/overview-docs/overview-errors.d.ts.map +1 -1
- package/dist/lib/overview-docs/overview-errors.js +8 -5
- package/dist/lib/overview-docs/overview-errors.js.map +2 -2
- package/dist/lib/overview-docs/overview-page.d.ts.map +1 -1
- package/dist/lib/overview-docs/overview-page.js +2 -3
- package/dist/lib/overview-docs/overview-page.js.map +2 -2
- package/dist/lib/overview-docs/overview-pagination.d.ts.map +1 -1
- package/dist/lib/overview-docs/overview-sdks.d.ts.map +1 -1
- package/dist/lib/overview-docs/overview-sdks.js +2 -1
- package/dist/lib/overview-docs/overview-sdks.js.map +2 -2
- package/dist/lib/overview-docs/types.d.ts.map +1 -1
- package/dist/lib/overview-docs/types.js +1 -1
- package/dist/lib/overview-docs/types.js.map +2 -2
- package/dist/lib/pagination/guess-pagination.d.ts.map +1 -1
- package/dist/lib/pagination/guess-pagination.js.map +2 -2
- package/dist/lib/pagination/pagination-result.d.ts +3 -3
- package/dist/lib/pagination/pagination-result.d.ts.map +1 -1
- package/dist/lib/pagination/pagination-result.js +6 -3
- package/dist/lib/pagination/pagination-result.js.map +2 -2
- package/dist/lib/pagination/pagination.d.ts +31 -1
- package/dist/lib/pagination/pagination.d.ts.map +1 -1
- package/dist/lib/pagination/pagination.js +30 -11
- package/dist/lib/pagination/pagination.js.map +2 -2
- package/dist/lib/processing-plugins/bundle-external-refs.d.ts +17 -0
- package/dist/lib/processing-plugins/bundle-external-refs.d.ts.map +1 -0
- package/dist/lib/processing-plugins/bundle-external-refs.js +241 -0
- package/dist/lib/processing-plugins/bundle-external-refs.js.map +7 -0
- package/dist/lib/processing-plugins/canonicalize-spec.d.ts +2 -2
- package/dist/lib/processing-plugins/canonicalize-spec.d.ts.map +1 -1
- package/dist/lib/processing-plugins/canonicalize-spec.js.map +2 -2
- package/dist/lib/processing-plugins/create-default-processing-plugins.d.ts +4 -3
- package/dist/lib/processing-plugins/create-default-processing-plugins.d.ts.map +1 -1
- package/dist/lib/processing-plugins/create-default-processing-plugins.js +10 -3
- package/dist/lib/processing-plugins/create-default-processing-plugins.js.map +2 -2
- package/dist/lib/processing-plugins/enrich-examples.d.ts +4 -4
- package/dist/lib/processing-plugins/enrich-examples.d.ts.map +1 -1
- package/dist/lib/processing-plugins/enrich-examples.js +1 -1
- package/dist/lib/processing-plugins/enrich-examples.js.map +2 -2
- package/dist/lib/processing-plugins/extract-inline-schemas.d.ts +2 -2
- package/dist/lib/processing-plugins/extract-inline-schemas.d.ts.map +1 -1
- package/dist/lib/processing-plugins/extract-inline-schemas.js.map +2 -2
- package/dist/lib/processing-plugins/extract-overview-docs.d.ts +2 -2
- package/dist/lib/processing-plugins/extract-overview-docs.d.ts.map +1 -1
- package/dist/lib/processing-plugins/extract-overview-docs.js +4 -1
- package/dist/lib/processing-plugins/extract-overview-docs.js.map +2 -2
- package/dist/lib/processing-plugins/index.d.ts +1 -0
- package/dist/lib/processing-plugins/index.d.ts.map +1 -1
- package/dist/lib/processing-plugins/index.js +1 -0
- package/dist/lib/processing-plugins/index.js.map +2 -2
- package/dist/lib/processing-plugins/infer-pagination.d.ts +2 -2
- package/dist/lib/processing-plugins/infer-pagination.d.ts.map +1 -1
- package/dist/lib/processing-plugins/infer-pagination.js +5 -6
- package/dist/lib/processing-plugins/infer-pagination.js.map +2 -2
- package/dist/lib/processing-plugins/normalize-operation-ids.d.ts +2 -2
- package/dist/lib/processing-plugins/normalize-operation-ids.d.ts.map +1 -1
- package/dist/lib/processing-plugins/normalize-operation-ids.js.map +2 -2
- package/dist/lib/processing-plugins/normalize-parameters.d.ts +2 -2
- package/dist/lib/processing-plugins/normalize-parameters.d.ts.map +1 -1
- package/dist/lib/processing-plugins/normalize-parameters.js.map +2 -2
- package/dist/lib/processing-plugins/normalize-paths.d.ts +2 -2
- package/dist/lib/processing-plugins/normalize-paths.d.ts.map +1 -1
- package/dist/lib/processing-plugins/normalize-paths.js.map +2 -2
- package/dist/lib/processing-plugins/normalize-request-bodies.d.ts +9 -3
- package/dist/lib/processing-plugins/normalize-request-bodies.d.ts.map +1 -1
- package/dist/lib/processing-plugins/normalize-request-bodies.js +36 -15
- package/dist/lib/processing-plugins/normalize-request-bodies.js.map +2 -2
- package/dist/lib/processing-plugins/normalize-responses.d.ts +2 -2
- package/dist/lib/processing-plugins/normalize-responses.d.ts.map +1 -1
- package/dist/lib/processing-plugins/normalize-responses.js +11 -15
- package/dist/lib/processing-plugins/normalize-responses.js.map +2 -2
- package/dist/lib/processing-plugins/normalize-schemas.d.ts +2 -2
- package/dist/lib/processing-plugins/normalize-schemas.d.ts.map +1 -1
- package/dist/lib/processing-plugins/normalize-schemas.js +14 -4
- package/dist/lib/processing-plugins/normalize-schemas.js.map +2 -2
- package/dist/lib/processing-plugins/normalize-security.d.ts +2 -2
- package/dist/lib/processing-plugins/normalize-security.d.ts.map +1 -1
- package/dist/lib/processing-plugins/normalize-security.js +6 -5
- package/dist/lib/processing-plugins/normalize-security.js.map +2 -2
- package/dist/lib/processing-plugins/normalize-tags.d.ts +8 -2
- package/dist/lib/processing-plugins/normalize-tags.d.ts.map +1 -1
- package/dist/lib/processing-plugins/normalize-tags.js +35 -1
- package/dist/lib/processing-plugins/normalize-tags.js.map +2 -2
- package/dist/lib/processing-plugins/resolve-security-scheme-uris.d.ts +13 -2
- package/dist/lib/processing-plugins/resolve-security-scheme-uris.d.ts.map +1 -1
- package/dist/lib/processing-plugins/resolve-security-scheme-uris.js +68 -90
- package/dist/lib/processing-plugins/resolve-security-scheme-uris.js.map +2 -2
- package/dist/lib/processing.d.ts +25 -11
- package/dist/lib/processing.d.ts.map +1 -1
- package/dist/lib/processing.js +53 -16
- package/dist/lib/processing.js.map +2 -2
- package/dist/lib/reserved-keywords.d.ts.map +1 -1
- package/dist/lib/sidebar.d.ts +5 -4
- package/dist/lib/sidebar.d.ts.map +1 -1
- package/dist/lib/sidebar.js +46 -23
- package/dist/lib/sidebar.js.map +2 -2
- package/dist/lib/tag.d.ts.map +1 -1
- package/dist/lib/types.d.ts +34 -12
- package/dist/lib/types.d.ts.map +1 -1
- package/dist/lib/types.js +11 -0
- package/dist/lib/types.js.map +3 -3
- package/dist/lib/walk-schemas.d.ts +4 -2
- package/dist/lib/walk-schemas.d.ts.map +1 -1
- package/dist/lib/walk-schemas.js +15 -13
- package/dist/lib/walk-schemas.js.map +2 -2
- package/package.json +17 -6
- package/dist/lib/create-operation.d.ts +0 -28
- package/dist/lib/create-operation.d.ts.map +0 -1
- package/dist/lib/create-operation.js +0 -62
- package/dist/lib/create-operation.js.map +0 -7
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../../../src/lib/processing-plugins/normalize-responses.ts"],
|
|
4
|
-
"sourcesContent": ["import
|
|
5
|
-
"mappings": "
|
|
4
|
+
"sourcesContent": ["import type {\n MediaTypeObject,\n OperationObject,\n ResponseObject,\n} from 'openapi3-ts/oas31';\n\nimport { isRef, parseRef, resolveRef } from '@sdk-it/core/ref.js';\nimport { isEmpty, pascalcase } from '@sdk-it/core/utils.js';\n\nimport { findUniqueSchemaName } from '../find-unique-schema-name.js';\nimport { iterateOperations } from '../for-each-operation.js';\nimport {\n isBinaryContentType,\n isSseContentType,\n isStreamingContentType,\n isSuccessStatusCode,\n isTextContentType,\n parseJsonContentType,\n} from '../is.js';\nimport type { ResponsesConfig } from '../options.js';\nimport type { DocumentPlugin } from '../processing.js';\nimport type { ProcessingDocument, ResponseBody } from '../types.js';\n\nfunction normalizeOperationResponses(\n spec: ProcessingDocument,\n operationId: string,\n operation: OperationObject,\n responsesConfig?: ResponsesConfig,\n) {\n const responses = operation.responses ?? {};\n operation.responses ??= {};\n let foundSuccessResponse = false;\n for (const status in responses) {\n operation.responses[status] = structuredClone(\n resolveRef<ResponseObject>(spec, responses[status]),\n );\n\n if (status !== 'default' && isSuccessStatusCode(status)) {\n foundSuccessResponse = true;\n }\n }\n\n if (!foundSuccessResponse) {\n operation.responses['200'] = {\n description: 'OK',\n content: {\n 'application/json': {\n schema: {},\n },\n },\n };\n }\n\n for (const status in operation.responses) {\n const response: ResponseObject = operation.responses[status];\n const statusCode = +status;\n response.content ??= {};\n response['x-body'] = responseBody(response);\n\n if (\n !responsesConfig?.flattenErrorResponses &&\n !isSuccessStatusCode(status)\n ) {\n continue;\n }\n\n let responseName: string | undefined;\n for (const [contentType, mediaType] of Object.entries(response.content)) {\n const body = mediaBody(contentType, response.headers);\n if (body === 'text' && !describesString(spec, mediaType.schema)) {\n // Clients read a text body as a string, so its output is a string\n // unless its schema already describes one.\n mediaType.schema = { type: 'string' };\n }\n if (isRef(mediaType.schema)) {\n const { model } = parseRef(mediaType.schema.$ref);\n Object.assign(spec.components.schemas[model], {\n 'x-responsebody': true,\n });\n responseName ??= model;\n continue;\n }\n const outputName =\n statusCode !== 200\n ? findUniqueSchemaName(spec, `${pascalcase(operationId)}${status}`, [\n 'output',\n 'payload',\n 'result',\n ])\n : findUniqueSchemaName(spec, operationId, [\n 'output',\n 'payload',\n 'result',\n ]);\n responseName ??= outputName;\n\n if (body === 'json') {\n if (isEmpty(mediaType.schema)) {\n spec.components.schemas[outputName] = {\n type: 'object',\n additionalProperties: true,\n };\n }\n } else if (body === 'binary' && isEmpty(mediaType.schema)) {\n mediaType.schema = { type: 'string', format: 'binary' };\n }\n\n spec.components.schemas[outputName] = {\n ...spec.components.schemas[outputName],\n ...mediaType.schema,\n 'x-responsebody': true,\n 'x-response-group': operationId,\n };\n operation.responses[status].content[contentType].schema = {\n $ref: `#/components/schemas/${outputName}`,\n };\n }\n if (responseName) {\n response['x-response-name'] = responseName;\n }\n }\n\n return operation.responses;\n}\n\nfunction responseBody(response: ResponseObject): ResponseBody {\n if (isEmpty(response.content)) {\n return 'empty';\n }\n if (hasHeader(response.headers, 'Transfer-Encoding')) {\n return 'stream';\n }\n for (const contentType of Object.keys(response.content)) {\n const body = mediaBody(contentType, response.headers);\n if (body) {\n return body;\n }\n }\n return 'stream';\n}\n\nfunction mediaBody(\n contentType: string,\n headers: ResponseObject['headers'],\n): ResponseBody | undefined {\n const isOctetStream = isStreamingContentType(\n normalizeContentType(contentType),\n );\n if (isOctetStream && !hasHeader(headers, 'Content-Disposition')) {\n return 'stream';\n }\n if (isOctetStream || isBinaryContentType(contentType)) {\n return 'binary';\n }\n if (parseJsonContentType(contentType)) {\n return 'json';\n }\n if (isSseContentType(contentType)) {\n return 'sse';\n }\n if (isTextContentType(contentType)) {\n return 'text';\n }\n return undefined;\n}\n\nfunction normalizeContentType(contentType: string) {\n return contentType.split(';')[0].trim().toLowerCase();\n}\n\nfunction hasHeader(headers: ResponseObject['headers'], name: string) {\n if (!headers) {\n return false;\n }\n const target = name.toLowerCase();\n return Object.keys(headers).some((key) => key.toLowerCase() === target);\n}\n\nexport function normalizeResponses(): DocumentPlugin {\n return {\n name: 'normalize-responses',\n process({ spec, options, report }) {\n for (const { entry, operation } of iterateOperations(spec)) {\n if (!operation.operationId) {\n throw new Error(\n `Cannot normalize responses before assigning an operation ID for ${entry.method.toUpperCase()} ${entry.path}`,\n );\n }\n const hadSuccessResponse = Object.keys(operation.responses ?? {}).some(\n isSuccessStatusCode,\n );\n operation.responses = normalizeOperationResponses(\n spec,\n operation.operationId,\n operation,\n options.responses,\n );\n if (!hadSuccessResponse) {\n report({\n severity: 'warning',\n code: 'success-response-added',\n message: 'Added a default 200 success response',\n path: `${entry.method.toUpperCase()} ${entry.path}`,\n });\n }\n }\n },\n };\n}\n\nfunction describesString(\n spec: ProcessingDocument,\n schema: MediaTypeObject['schema'],\n) {\n return schema !== undefined && resolveRef(spec, schema).type === 'string';\n}\n"],
|
|
5
|
+
"mappings": "AAMA,SAAS,OAAO,UAAU,kBAAkB;AAC5C,SAAS,SAAS,kBAAkB;AAEpC,SAAS,4BAA4B;AACrC,SAAS,yBAAyB;AAClC;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAKP,SAAS,4BACP,MACA,aACA,WACA,iBACA;AACA,QAAM,YAAY,UAAU,aAAa,CAAC;AAC1C,YAAU,cAAc,CAAC;AACzB,MAAI,uBAAuB;AAC3B,aAAW,UAAU,WAAW;AAC9B,cAAU,UAAU,MAAM,IAAI;AAAA,MAC5B,WAA2B,MAAM,UAAU,MAAM,CAAC;AAAA,IACpD;AAEA,QAAI,WAAW,aAAa,oBAAoB,MAAM,GAAG;AACvD,6BAAuB;AAAA,IACzB;AAAA,EACF;AAEA,MAAI,CAAC,sBAAsB;AACzB,cAAU,UAAU,KAAK,IAAI;AAAA,MAC3B,aAAa;AAAA,MACb,SAAS;AAAA,QACP,oBAAoB;AAAA,UAClB,QAAQ,CAAC;AAAA,QACX;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,aAAW,UAAU,UAAU,WAAW;AACxC,UAAM,WAA2B,UAAU,UAAU,MAAM;AAC3D,UAAM,aAAa,CAAC;AACpB,aAAS,YAAY,CAAC;AACtB,aAAS,QAAQ,IAAI,aAAa,QAAQ;AAE1C,QACE,CAAC,iBAAiB,yBAClB,CAAC,oBAAoB,MAAM,GAC3B;AACA;AAAA,IACF;AAEA,QAAI;AACJ,eAAW,CAAC,aAAa,SAAS,KAAK,OAAO,QAAQ,SAAS,OAAO,GAAG;AACvE,YAAM,OAAO,UAAU,aAAa,SAAS,OAAO;AACpD,UAAI,SAAS,UAAU,CAAC,gBAAgB,MAAM,UAAU,MAAM,GAAG;AAG/D,kBAAU,SAAS,EAAE,MAAM,SAAS;AAAA,MACtC;AACA,UAAI,MAAM,UAAU,MAAM,GAAG;AAC3B,cAAM,EAAE,MAAM,IAAI,SAAS,UAAU,OAAO,IAAI;AAChD,eAAO,OAAO,KAAK,WAAW,QAAQ,KAAK,GAAG;AAAA,UAC5C,kBAAkB;AAAA,QACpB,CAAC;AACD,yBAAiB;AACjB;AAAA,MACF;AACA,YAAM,aACJ,eAAe,MACX,qBAAqB,MAAM,GAAG,WAAW,WAAW,CAAC,GAAG,MAAM,IAAI;AAAA,QAChE;AAAA,QACA;AAAA,QACA;AAAA,MACF,CAAC,IACD,qBAAqB,MAAM,aAAa;AAAA,QACtC;AAAA,QACA;AAAA,QACA;AAAA,MACF,CAAC;AACP,uBAAiB;AAEjB,UAAI,SAAS,QAAQ;AACnB,YAAI,QAAQ,UAAU,MAAM,GAAG;AAC7B,eAAK,WAAW,QAAQ,UAAU,IAAI;AAAA,YACpC,MAAM;AAAA,YACN,sBAAsB;AAAA,UACxB;AAAA,QACF;AAAA,MACF,WAAW,SAAS,YAAY,QAAQ,UAAU,MAAM,GAAG;AACzD,kBAAU,SAAS,EAAE,MAAM,UAAU,QAAQ,SAAS;AAAA,MACxD;AAEA,WAAK,WAAW,QAAQ,UAAU,IAAI;AAAA,QACpC,GAAG,KAAK,WAAW,QAAQ,UAAU;AAAA,QACrC,GAAG,UAAU;AAAA,QACb,kBAAkB;AAAA,QAClB,oBAAoB;AAAA,MACtB;AACA,gBAAU,UAAU,MAAM,EAAE,QAAQ,WAAW,EAAE,SAAS;AAAA,QACxD,MAAM,wBAAwB,UAAU;AAAA,MAC1C;AAAA,IACF;AACA,QAAI,cAAc;AAChB,eAAS,iBAAiB,IAAI;AAAA,IAChC;AAAA,EACF;AAEA,SAAO,UAAU;AACnB;AAEA,SAAS,aAAa,UAAwC;AAC5D,MAAI,QAAQ,SAAS,OAAO,GAAG;AAC7B,WAAO;AAAA,EACT;AACA,MAAI,UAAU,SAAS,SAAS,mBAAmB,GAAG;AACpD,WAAO;AAAA,EACT;AACA,aAAW,eAAe,OAAO,KAAK,SAAS,OAAO,GAAG;AACvD,UAAM,OAAO,UAAU,aAAa,SAAS,OAAO;AACpD,QAAI,MAAM;AACR,aAAO;AAAA,IACT;AAAA,EACF;AACA,SAAO;AACT;AAEA,SAAS,UACP,aACA,SAC0B;AAC1B,QAAM,gBAAgB;AAAA,IACpB,qBAAqB,WAAW;AAAA,EAClC;AACA,MAAI,iBAAiB,CAAC,UAAU,SAAS,qBAAqB,GAAG;AAC/D,WAAO;AAAA,EACT;AACA,MAAI,iBAAiB,oBAAoB,WAAW,GAAG;AACrD,WAAO;AAAA,EACT;AACA,MAAI,qBAAqB,WAAW,GAAG;AACrC,WAAO;AAAA,EACT;AACA,MAAI,iBAAiB,WAAW,GAAG;AACjC,WAAO;AAAA,EACT;AACA,MAAI,kBAAkB,WAAW,GAAG;AAClC,WAAO;AAAA,EACT;AACA,SAAO;AACT;AAEA,SAAS,qBAAqB,aAAqB;AACjD,SAAO,YAAY,MAAM,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,YAAY;AACtD;AAEA,SAAS,UAAU,SAAoC,MAAc;AACnE,MAAI,CAAC,SAAS;AACZ,WAAO;AAAA,EACT;AACA,QAAM,SAAS,KAAK,YAAY;AAChC,SAAO,OAAO,KAAK,OAAO,EAAE,KAAK,CAAC,QAAQ,IAAI,YAAY,MAAM,MAAM;AACxE;AAEO,SAAS,qBAAqC;AACnD,SAAO;AAAA,IACL,MAAM;AAAA,IACN,QAAQ,EAAE,MAAM,SAAS,OAAO,GAAG;AACjC,iBAAW,EAAE,OAAO,UAAU,KAAK,kBAAkB,IAAI,GAAG;AAC1D,YAAI,CAAC,UAAU,aAAa;AAC1B,gBAAM,IAAI;AAAA,YACR,mEAAmE,MAAM,OAAO,YAAY,CAAC,IAAI,MAAM,IAAI;AAAA,UAC7G;AAAA,QACF;AACA,cAAM,qBAAqB,OAAO,KAAK,UAAU,aAAa,CAAC,CAAC,EAAE;AAAA,UAChE;AAAA,QACF;AACA,kBAAU,YAAY;AAAA,UACpB;AAAA,UACA,UAAU;AAAA,UACV;AAAA,UACA,QAAQ;AAAA,QACV;AACA,YAAI,CAAC,oBAAoB;AACvB,iBAAO;AAAA,YACL,UAAU;AAAA,YACV,MAAM;AAAA,YACN,SAAS;AAAA,YACT,MAAM,GAAG,MAAM,OAAO,YAAY,CAAC,IAAI,MAAM,IAAI;AAAA,UACnD,CAAC;AAAA,QACH;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;AAEA,SAAS,gBACP,MACA,QACA;AACA,SAAO,WAAW,UAAa,WAAW,MAAM,MAAM,EAAE,SAAS;AACnE;",
|
|
6
6
|
"names": []
|
|
7
7
|
}
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
export declare function normalizeSchemas():
|
|
1
|
+
import type { IRPlugin } from '../processing.js';
|
|
2
|
+
export declare function normalizeSchemas(): IRPlugin;
|
|
3
3
|
//# sourceMappingURL=normalize-schemas.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"normalize-schemas.d.ts","
|
|
1
|
+
{"version":3,"file":"normalize-schemas.d.ts","sources":["../../../src/lib/processing-plugins/normalize-schemas.ts"],"names":[],"mappings":"AAcA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAqNjD,wBAAgB,gBAAgB,IAAI,QAAQ,CAO3C"}
|
|
@@ -8,6 +8,15 @@ import { coerceTypes } from "../is.js";
|
|
|
8
8
|
function normalizeSchemaObjects(spec, schemas, visited = /* @__PURE__ */ new Set()) {
|
|
9
9
|
for (const schema of schemas) {
|
|
10
10
|
if (isRef(schema)) continue;
|
|
11
|
+
if (schema.required !== void 0 && !Array.isArray(schema.required)) {
|
|
12
|
+
delete schema.required;
|
|
13
|
+
}
|
|
14
|
+
for (const [key, property] of Object.entries(schema.properties ?? {})) {
|
|
15
|
+
const flag = notRef(property) ? property.required : void 0;
|
|
16
|
+
if (flag === true) {
|
|
17
|
+
schema.required = uniq([...schema.required ?? [], key]);
|
|
18
|
+
}
|
|
19
|
+
}
|
|
11
20
|
if (!isEmpty(schema.properties)) {
|
|
12
21
|
schema.type ??= "object";
|
|
13
22
|
delete schema.oneOf;
|
|
@@ -146,15 +155,16 @@ function normalizeSchemaObjects(spec, schemas, visited = /* @__PURE__ */ new Set
|
|
|
146
155
|
const otherTypes = schema[kind].filter(
|
|
147
156
|
(item) => resolveRef(spec, item).type !== "null"
|
|
148
157
|
);
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
158
|
+
const [only] = otherTypes;
|
|
159
|
+
const droppedNull = otherTypes.length !== schema[kind].length;
|
|
160
|
+
if (otherTypes.length === 1 && !(droppedNull && isRef(only))) {
|
|
152
161
|
Object.assign(schema, only);
|
|
153
162
|
delete schema[kind];
|
|
154
163
|
if (droppedNull && notRef(only)) {
|
|
155
164
|
const types = coerceTypes(only, false);
|
|
156
165
|
if (types.length) {
|
|
157
|
-
|
|
166
|
+
const typesWithNull = [...types, "null"];
|
|
167
|
+
schema.type = uniq(typesWithNull);
|
|
158
168
|
}
|
|
159
169
|
}
|
|
160
170
|
continue;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../../../src/lib/processing-plugins/normalize-schemas.ts"],
|
|
4
|
-
"sourcesContent": ["import { mergeWith, uniq } from 'lodash-es';\nimport assert from 'node:assert';\nimport type {
|
|
5
|
-
"mappings": "AAAA,SAAS,WAAW,YAAY;AAChC,OAAO,YAAY;
|
|
4
|
+
"sourcesContent": ["import { mergeWith, uniq } from 'lodash-es';\nimport assert from 'node:assert';\nimport type {\n ReferenceObject,\n SchemaObject,\n SchemaObjectType,\n} from 'openapi3-ts/oas31';\n\nimport { isEmpty, isRef, notRef, resolveRef, snakecase } from '@sdk-it/core';\n\nimport { findVarients } from '../find-polymorphic-varients.js';\nimport { formatName } from '../format-name.js';\nimport { isPrimitiveSchema } from '../is-primitive-schema.js';\nimport { coerceTypes } from '../is.js';\nimport type { IRPlugin } from '../processing.js';\nimport type { IR } from '../types.js';\n\nfunction normalizeSchemaObjects(\n spec: IR,\n schemas: (SchemaObject | ReferenceObject)[],\n visited = new Set<string>(),\n) {\n for (const schema of schemas) {\n if (isRef(schema)) continue;\n\n // JSON Schema lists required names on the parent object. An OAS 3.0 style\n // `required: true` on a property moves there; any other non-array\n // `required` (a boolean on the schema itself) says nothing and goes.\n if (schema.required !== undefined && !Array.isArray(schema.required)) {\n delete schema.required;\n }\n for (const [key, property] of Object.entries(schema.properties ?? {})) {\n // The document breaks its own type here, so read the value as it is.\n const flag: unknown = notRef(property) ? property.required : undefined;\n if (flag === true) {\n schema.required = uniq([...(schema.required ?? []), key]);\n }\n }\n\n if (!isEmpty(schema.properties)) {\n schema.type ??= 'object';\n delete schema.oneOf;\n delete schema.anyOf;\n normalizeSchemaObjects(spec, Object.values(schema.properties), visited);\n for (const [key, value] of Object.entries(schema.properties)) {\n if (notRef(value) && isPrimitiveSchema(value)) {\n value.default ??= schema.default?.[key];\n delete schema.default?.[key];\n }\n }\n delete schema.default;\n }\n\n if (!isEmpty(schema['x-properties'])) {\n normalizeSchemaObjects(\n spec,\n Object.values(schema['x-properties']),\n visited,\n );\n }\n\n if (!isEmpty(schema.items)) {\n delete schema.oneOf;\n delete schema.anyOf;\n schema.type = 'array';\n normalizeSchemaObjects(spec, [schema.items], visited);\n const items = resolveRef<SchemaObject>(spec, schema.items);\n if (Array.isArray(items.default)) {\n schema.default ??= structuredClone(items.default);\n }\n delete items.default;\n }\n\n if (!isEmpty(schema.anyOf) && !isEmpty(schema.oneOf)) {\n delete schema.anyOf;\n }\n\n if (isEmpty(schema.enum)) {\n delete schema.enum;\n }\n\n if (!isEmpty(schema.enum)) {\n if (schema.enum.length === 1) {\n schema.const = schema.enum[0];\n delete schema.enum;\n } else {\n const valuesSet = new Set<string>();\n const valuesList = [];\n for (const value of schema.enum) {\n const formattedValue = formatName(snakecase(formatName(value)));\n if (!valuesSet.has(formattedValue)) {\n valuesSet.add(formattedValue);\n valuesList.push(value);\n }\n }\n schema.enum = valuesList;\n }\n delete schema.allOf;\n }\n\n if (schema.const !== undefined) {\n schema.default = schema.const;\n }\n\n if (!isEmpty(schema.allOf)) {\n const schemas = schema.allOf;\n const resolved = schemas.map((item) =>\n resolveRef<SchemaObject>(spec, item),\n );\n const hasObjects = resolved.some((item) => item.type === 'object');\n const hasOtherTypes = resolved.some(\n (item) => item.type && item.type !== 'object',\n );\n if (hasObjects && hasOtherTypes) {\n assert(false, `allOf must be an object`);\n }\n mergeWith(\n schema,\n ...resolved.map((resolvedSchema, index) => {\n const sourceSchema = schemas[index];\n if (isRef(sourceSchema)) {\n if (visited.has(sourceSchema.$ref)) {\n throw new Error(\n `Circular allOf reference detected: ${[\n ...visited,\n sourceSchema.$ref,\n ].join(' -> ')}`,\n );\n }\n normalizeSchemaObjects(\n spec,\n [resolvedSchema],\n new Set(visited).add(sourceSchema.$ref),\n );\n } else {\n normalizeSchemaObjects(spec, [resolvedSchema], visited);\n }\n return resolvedSchema;\n }),\n unionRequired,\n );\n delete schema.allOf;\n } else {\n delete schema.allOf;\n }\n\n if (\n schema.type === 'object' &&\n isEmpty(schema.properties) &&\n typeof schema.additionalProperties === 'object' &&\n !isEmpty(schema.additionalProperties) &&\n notRef(schema.additionalProperties) &&\n !isEmpty(schema.additionalProperties.properties)\n ) {\n normalizeSchemaObjects(\n spec,\n Object.values(schema.additionalProperties.properties),\n visited,\n );\n }\n\n for (const kind of ['oneOf', 'anyOf'] as const) {\n if (!isEmpty(schema[kind])) {\n delete schema.type;\n normalizeSchemaObjects(spec, schema[kind], visited);\n if (isEmpty(schema[kind])) {\n continue;\n }\n\n let enumSchemaIndex = -1;\n const enumValues: string[] = [];\n for (let index = 0; index < schema[kind].length; index++) {\n const item = schema[kind][index];\n if (notRef(item) && item.type === 'string') {\n if (item.enum && item.enum.length > 1) {\n enumValues.push(...item.enum);\n if (enumSchemaIndex === -1) {\n enumSchemaIndex = index;\n }\n }\n }\n }\n if (enumSchemaIndex !== -1) {\n const enumSchema = schema[kind][enumSchemaIndex];\n if (notRef(enumSchema)) {\n enumSchema.enum = uniq(enumValues);\n }\n schema[kind] = schema[kind].filter(\n (item, index) => index === enumSchemaIndex || isRef(item),\n );\n }\n const otherTypes = schema[kind].filter(\n (item) => resolveRef<SchemaObject>(spec, item).type !== 'null',\n );\n const [only] = otherTypes;\n const droppedNull = otherTypes.length !== schema[kind].length;\n // A $ref cannot carry null, so a nullable $ref keeps its union.\n if (otherTypes.length === 1 && !(droppedNull && isRef(only))) {\n Object.assign(schema, only);\n delete schema[kind];\n if (droppedNull && notRef(only)) {\n const types = coerceTypes(only, false);\n if (types.length) {\n const typesWithNull: SchemaObjectType[] = [...types, 'null'];\n schema.type = uniq(typesWithNull);\n }\n }\n continue;\n }\n\n schema['x-varients'] = findVarients(spec, schema[kind]);\n } else {\n delete schema[kind];\n }\n }\n }\n}\n\n// allOf is a conjunction, so a value must carry every part's required\n// properties; lodash's default merge would overwrite the arrays by index.\nfunction unionRequired(target: unknown, source: unknown, key: string) {\n if (key === 'required' && Array.isArray(target) && Array.isArray(source)) {\n return uniq([...target, ...source]);\n }\n return undefined;\n}\n\nexport function normalizeSchemas(): IRPlugin {\n return {\n name: 'normalize-schemas',\n process({ spec }) {\n normalizeSchemaObjects(spec, Object.values(spec.components.schemas));\n },\n };\n}\n"],
|
|
5
|
+
"mappings": "AAAA,SAAS,WAAW,YAAY;AAChC,OAAO,YAAY;AAOnB,SAAS,SAAS,OAAO,QAAQ,YAAY,iBAAiB;AAE9D,SAAS,oBAAoB;AAC7B,SAAS,kBAAkB;AAC3B,SAAS,yBAAyB;AAClC,SAAS,mBAAmB;AAI5B,SAAS,uBACP,MACA,SACA,UAAU,oBAAI,IAAY,GAC1B;AACA,aAAW,UAAU,SAAS;AAC5B,QAAI,MAAM,MAAM,EAAG;AAKnB,QAAI,OAAO,aAAa,UAAa,CAAC,MAAM,QAAQ,OAAO,QAAQ,GAAG;AACpE,aAAO,OAAO;AAAA,IAChB;AACA,eAAW,CAAC,KAAK,QAAQ,KAAK,OAAO,QAAQ,OAAO,cAAc,CAAC,CAAC,GAAG;AAErE,YAAM,OAAgB,OAAO,QAAQ,IAAI,SAAS,WAAW;AAC7D,UAAI,SAAS,MAAM;AACjB,eAAO,WAAW,KAAK,CAAC,GAAI,OAAO,YAAY,CAAC,GAAI,GAAG,CAAC;AAAA,MAC1D;AAAA,IACF;AAEA,QAAI,CAAC,QAAQ,OAAO,UAAU,GAAG;AAC/B,aAAO,SAAS;AAChB,aAAO,OAAO;AACd,aAAO,OAAO;AACd,6BAAuB,MAAM,OAAO,OAAO,OAAO,UAAU,GAAG,OAAO;AACtE,iBAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,OAAO,UAAU,GAAG;AAC5D,YAAI,OAAO,KAAK,KAAK,kBAAkB,KAAK,GAAG;AAC7C,gBAAM,YAAY,OAAO,UAAU,GAAG;AACtC,iBAAO,OAAO,UAAU,GAAG;AAAA,QAC7B;AAAA,MACF;AACA,aAAO,OAAO;AAAA,IAChB;AAEA,QAAI,CAAC,QAAQ,OAAO,cAAc,CAAC,GAAG;AACpC;AAAA,QACE;AAAA,QACA,OAAO,OAAO,OAAO,cAAc,CAAC;AAAA,QACpC;AAAA,MACF;AAAA,IACF;AAEA,QAAI,CAAC,QAAQ,OAAO,KAAK,GAAG;AAC1B,aAAO,OAAO;AACd,aAAO,OAAO;AACd,aAAO,OAAO;AACd,6BAAuB,MAAM,CAAC,OAAO,KAAK,GAAG,OAAO;AACpD,YAAM,QAAQ,WAAyB,MAAM,OAAO,KAAK;AACzD,UAAI,MAAM,QAAQ,MAAM,OAAO,GAAG;AAChC,eAAO,YAAY,gBAAgB,MAAM,OAAO;AAAA,MAClD;AACA,aAAO,MAAM;AAAA,IACf;AAEA,QAAI,CAAC,QAAQ,OAAO,KAAK,KAAK,CAAC,QAAQ,OAAO,KAAK,GAAG;AACpD,aAAO,OAAO;AAAA,IAChB;AAEA,QAAI,QAAQ,OAAO,IAAI,GAAG;AACxB,aAAO,OAAO;AAAA,IAChB;AAEA,QAAI,CAAC,QAAQ,OAAO,IAAI,GAAG;AACzB,UAAI,OAAO,KAAK,WAAW,GAAG;AAC5B,eAAO,QAAQ,OAAO,KAAK,CAAC;AAC5B,eAAO,OAAO;AAAA,MAChB,OAAO;AACL,cAAM,YAAY,oBAAI,IAAY;AAClC,cAAM,aAAa,CAAC;AACpB,mBAAW,SAAS,OAAO,MAAM;AAC/B,gBAAM,iBAAiB,WAAW,UAAU,WAAW,KAAK,CAAC,CAAC;AAC9D,cAAI,CAAC,UAAU,IAAI,cAAc,GAAG;AAClC,sBAAU,IAAI,cAAc;AAC5B,uBAAW,KAAK,KAAK;AAAA,UACvB;AAAA,QACF;AACA,eAAO,OAAO;AAAA,MAChB;AACA,aAAO,OAAO;AAAA,IAChB;AAEA,QAAI,OAAO,UAAU,QAAW;AAC9B,aAAO,UAAU,OAAO;AAAA,IAC1B;AAEA,QAAI,CAAC,QAAQ,OAAO,KAAK,GAAG;AAC1B,YAAMA,WAAU,OAAO;AACvB,YAAM,WAAWA,SAAQ;AAAA,QAAI,CAAC,SAC5B,WAAyB,MAAM,IAAI;AAAA,MACrC;AACA,YAAM,aAAa,SAAS,KAAK,CAAC,SAAS,KAAK,SAAS,QAAQ;AACjE,YAAM,gBAAgB,SAAS;AAAA,QAC7B,CAAC,SAAS,KAAK,QAAQ,KAAK,SAAS;AAAA,MACvC;AACA,UAAI,cAAc,eAAe;AAC/B,eAAO,OAAO,yBAAyB;AAAA,MACzC;AACA;AAAA,QACE;AAAA,QACA,GAAG,SAAS,IAAI,CAAC,gBAAgB,UAAU;AACzC,gBAAM,eAAeA,SAAQ,KAAK;AAClC,cAAI,MAAM,YAAY,GAAG;AACvB,gBAAI,QAAQ,IAAI,aAAa,IAAI,GAAG;AAClC,oBAAM,IAAI;AAAA,gBACR,sCAAsC;AAAA,kBACpC,GAAG;AAAA,kBACH,aAAa;AAAA,gBACf,EAAE,KAAK,MAAM,CAAC;AAAA,cAChB;AAAA,YACF;AACA;AAAA,cACE;AAAA,cACA,CAAC,cAAc;AAAA,cACf,IAAI,IAAI,OAAO,EAAE,IAAI,aAAa,IAAI;AAAA,YACxC;AAAA,UACF,OAAO;AACL,mCAAuB,MAAM,CAAC,cAAc,GAAG,OAAO;AAAA,UACxD;AACA,iBAAO;AAAA,QACT,CAAC;AAAA,QACD;AAAA,MACF;AACA,aAAO,OAAO;AAAA,IAChB,OAAO;AACL,aAAO,OAAO;AAAA,IAChB;AAEA,QACE,OAAO,SAAS,YAChB,QAAQ,OAAO,UAAU,KACzB,OAAO,OAAO,yBAAyB,YACvC,CAAC,QAAQ,OAAO,oBAAoB,KACpC,OAAO,OAAO,oBAAoB,KAClC,CAAC,QAAQ,OAAO,qBAAqB,UAAU,GAC/C;AACA;AAAA,QACE;AAAA,QACA,OAAO,OAAO,OAAO,qBAAqB,UAAU;AAAA,QACpD;AAAA,MACF;AAAA,IACF;AAEA,eAAW,QAAQ,CAAC,SAAS,OAAO,GAAY;AAC9C,UAAI,CAAC,QAAQ,OAAO,IAAI,CAAC,GAAG;AAC1B,eAAO,OAAO;AACd,+BAAuB,MAAM,OAAO,IAAI,GAAG,OAAO;AAClD,YAAI,QAAQ,OAAO,IAAI,CAAC,GAAG;AACzB;AAAA,QACF;AAEA,YAAI,kBAAkB;AACtB,cAAM,aAAuB,CAAC;AAC9B,iBAAS,QAAQ,GAAG,QAAQ,OAAO,IAAI,EAAE,QAAQ,SAAS;AACxD,gBAAM,OAAO,OAAO,IAAI,EAAE,KAAK;AAC/B,cAAI,OAAO,IAAI,KAAK,KAAK,SAAS,UAAU;AAC1C,gBAAI,KAAK,QAAQ,KAAK,KAAK,SAAS,GAAG;AACrC,yBAAW,KAAK,GAAG,KAAK,IAAI;AAC5B,kBAAI,oBAAoB,IAAI;AAC1B,kCAAkB;AAAA,cACpB;AAAA,YACF;AAAA,UACF;AAAA,QACF;AACA,YAAI,oBAAoB,IAAI;AAC1B,gBAAM,aAAa,OAAO,IAAI,EAAE,eAAe;AAC/C,cAAI,OAAO,UAAU,GAAG;AACtB,uBAAW,OAAO,KAAK,UAAU;AAAA,UACnC;AACA,iBAAO,IAAI,IAAI,OAAO,IAAI,EAAE;AAAA,YAC1B,CAAC,MAAM,UAAU,UAAU,mBAAmB,MAAM,IAAI;AAAA,UAC1D;AAAA,QACF;AACA,cAAM,aAAa,OAAO,IAAI,EAAE;AAAA,UAC9B,CAAC,SAAS,WAAyB,MAAM,IAAI,EAAE,SAAS;AAAA,QAC1D;AACA,cAAM,CAAC,IAAI,IAAI;AACf,cAAM,cAAc,WAAW,WAAW,OAAO,IAAI,EAAE;AAEvD,YAAI,WAAW,WAAW,KAAK,EAAE,eAAe,MAAM,IAAI,IAAI;AAC5D,iBAAO,OAAO,QAAQ,IAAI;AAC1B,iBAAO,OAAO,IAAI;AAClB,cAAI,eAAe,OAAO,IAAI,GAAG;AAC/B,kBAAM,QAAQ,YAAY,MAAM,KAAK;AACrC,gBAAI,MAAM,QAAQ;AAChB,oBAAM,gBAAoC,CAAC,GAAG,OAAO,MAAM;AAC3D,qBAAO,OAAO,KAAK,aAAa;AAAA,YAClC;AAAA,UACF;AACA;AAAA,QACF;AAEA,eAAO,YAAY,IAAI,aAAa,MAAM,OAAO,IAAI,CAAC;AAAA,MACxD,OAAO;AACL,eAAO,OAAO,IAAI;AAAA,MACpB;AAAA,IACF;AAAA,EACF;AACF;AAIA,SAAS,cAAc,QAAiB,QAAiB,KAAa;AACpE,MAAI,QAAQ,cAAc,MAAM,QAAQ,MAAM,KAAK,MAAM,QAAQ,MAAM,GAAG;AACxE,WAAO,KAAK,CAAC,GAAG,QAAQ,GAAG,MAAM,CAAC;AAAA,EACpC;AACA,SAAO;AACT;AAEO,SAAS,mBAA6B;AAC3C,SAAO;AAAA,IACL,MAAM;AAAA,IACN,QAAQ,EAAE,KAAK,GAAG;AAChB,6BAAuB,MAAM,OAAO,OAAO,KAAK,WAAW,OAAO,CAAC;AAAA,IACrE;AAAA,EACF;AACF;",
|
|
6
6
|
"names": ["schemas"]
|
|
7
7
|
}
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
export declare function normalizeSecurity():
|
|
1
|
+
import type { DocumentPlugin } from '../processing.js';
|
|
2
|
+
export declare function normalizeSecurity(): DocumentPlugin;
|
|
3
3
|
//# sourceMappingURL=normalize-security.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"normalize-security.d.ts","
|
|
1
|
+
{"version":3,"file":"normalize-security.d.ts","sources":["../../../src/lib/processing-plugins/normalize-security.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD,wBAAgB,iBAAiB,IAAI,cAAc,CAuElD"}
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { isJsonObject } from "../external-documents.js";
|
|
1
2
|
import { iterateOperations } from "../for-each-operation.js";
|
|
2
3
|
function normalizeSecurity() {
|
|
3
4
|
return {
|
|
@@ -70,13 +71,13 @@ function normalizeSecurity() {
|
|
|
70
71
|
};
|
|
71
72
|
}
|
|
72
73
|
function invalidSecurityScheme(scheme) {
|
|
73
|
-
const value = scheme;
|
|
74
|
+
const value = isJsonObject(scheme) ? scheme : {};
|
|
74
75
|
switch (value.type) {
|
|
75
76
|
case "apiKey":
|
|
76
77
|
if (typeof value.name !== "string" || value.name.length === 0) {
|
|
77
78
|
return "apiKey security schemes require a name";
|
|
78
79
|
}
|
|
79
|
-
if (
|
|
80
|
+
if (value.in !== "header" && value.in !== "query" && value.in !== "cookie") {
|
|
80
81
|
return "apiKey security schemes require header, query, or cookie in";
|
|
81
82
|
}
|
|
82
83
|
return void 0;
|
|
@@ -87,10 +88,10 @@ function invalidSecurityScheme(scheme) {
|
|
|
87
88
|
case "openIdConnect":
|
|
88
89
|
return typeof value.openIdConnectUrl === "string" && value.openIdConnectUrl.length > 0 ? void 0 : "OpenID Connect security schemes require openIdConnectUrl";
|
|
89
90
|
case "oauth2": {
|
|
90
|
-
|
|
91
|
+
const flows = value.flows;
|
|
92
|
+
if (!isJsonObject(flows)) {
|
|
91
93
|
return "OAuth2 security schemes require flows";
|
|
92
94
|
}
|
|
93
|
-
const flows = value.flows;
|
|
94
95
|
const requiredUrls = {
|
|
95
96
|
implicit: ["authorizationUrl"],
|
|
96
97
|
password: ["tokenUrl"],
|
|
@@ -106,7 +107,7 @@ function invalidSecurityScheme(scheme) {
|
|
|
106
107
|
}
|
|
107
108
|
for (const [flowName, fields] of configured) {
|
|
108
109
|
const flow = flows[flowName];
|
|
109
|
-
if (!flow
|
|
110
|
+
if (!isJsonObject(flow) || !isJsonObject(flow.scopes)) {
|
|
110
111
|
return `OAuth2 ${flowName} flow requires scopes`;
|
|
111
112
|
}
|
|
112
113
|
for (const field of fields) {
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../../../src/lib/processing-plugins/normalize-security.ts"],
|
|
4
|
-
"sourcesContent": ["import type { OpenAPISecuritySchemeObject } from '@sdk-it/core';\n\nimport { iterateOperations } from '../for-each-operation.js';\nimport type {
|
|
5
|
-
"mappings": "AAEA,SAAS,yBAAyB;AAG3B,SAAS,
|
|
4
|
+
"sourcesContent": ["import type { OpenAPISecuritySchemeObject } from '@sdk-it/core';\n\nimport { isJsonObject } from '../external-documents.js';\nimport { iterateOperations } from '../for-each-operation.js';\nimport type { DocumentPlugin } from '../processing.js';\n\nexport function normalizeSecurity(): DocumentPlugin {\n return {\n name: 'normalize-security',\n process({ spec, report }) {\n for (const [name, scheme] of Object.entries(\n spec.components.securitySchemes,\n )) {\n const message = invalidSecurityScheme(scheme);\n if (message) {\n report({\n code: 'invalid-security-scheme',\n severity: 'error',\n path: `components.securitySchemes.${name}`,\n message,\n });\n }\n }\n for (const { entry, operation } of iterateOperations(spec)) {\n operation.security = structuredClone(\n operation.security ?? spec.security ?? [],\n );\n const path = `${entry.method.toUpperCase()} ${entry.path}`;\n for (const requirement of operation.security) {\n const targets = new Map<string, string>();\n for (const [name, values] of Object.entries(requirement)) {\n const scheme = spec.components.securitySchemes[name];\n if (!scheme) {\n // OpenAPI 3.2 allows external URI references here, but no\n // generator can emit a credential for one.\n report({\n code: 'unresolved-security-scheme',\n severity: 'error',\n path,\n message: `Security scheme ${name} must be resolved in components.securitySchemes`,\n });\n continue;\n }\n if (scheme.type === 'oauth2') {\n const availableScopes = new Set(\n Object.values(scheme.flows ?? {}).flatMap((flow) =>\n Object.keys(flow?.scopes ?? {}),\n ),\n );\n for (const scope of values) {\n if (!availableScopes.has(scope)) {\n report({\n code: 'unknown-oauth-scope',\n severity: 'error',\n path,\n message: `OAuth2 scheme ${name} does not declare scope ${scope}`,\n });\n }\n }\n }\n const target = credentialTarget(scheme);\n const existing = target ? targets.get(target) : undefined;\n if (target && existing) {\n report({\n code: 'conflicting-security-target',\n severity: 'error',\n path,\n message: `Security schemes ${existing} and ${name} both use ${target}`,\n });\n } else if (target) {\n targets.set(target, name);\n }\n }\n }\n }\n },\n };\n}\n\nfunction invalidSecurityScheme(scheme: unknown): string | undefined {\n const value = isJsonObject(scheme) ? scheme : {};\n switch (value.type) {\n case 'apiKey':\n if (typeof value.name !== 'string' || value.name.length === 0) {\n return 'apiKey security schemes require a name';\n }\n if (\n value.in !== 'header' &&\n value.in !== 'query' &&\n value.in !== 'cookie'\n ) {\n return 'apiKey security schemes require header, query, or cookie in';\n }\n return undefined;\n case 'http':\n return typeof value.scheme === 'string' && value.scheme.length > 0\n ? undefined\n : 'HTTP security schemes require a scheme';\n case 'mutualTLS':\n return undefined;\n case 'openIdConnect':\n return typeof value.openIdConnectUrl === 'string' &&\n value.openIdConnectUrl.length > 0\n ? undefined\n : 'OpenID Connect security schemes require openIdConnectUrl';\n case 'oauth2': {\n const flows = value.flows;\n if (!isJsonObject(flows)) {\n return 'OAuth2 security schemes require flows';\n }\n const requiredUrls: Record<string, string[]> = {\n implicit: ['authorizationUrl'],\n password: ['tokenUrl'],\n clientCredentials: ['tokenUrl'],\n authorizationCode: ['authorizationUrl', 'tokenUrl'],\n deviceAuthorization: ['deviceAuthorizationUrl', 'tokenUrl'],\n };\n const configured = Object.entries(requiredUrls).filter(\n ([flow]) => flows[flow] !== undefined,\n );\n if (configured.length === 0) {\n return 'OAuth2 security schemes require at least one flow';\n }\n for (const [flowName, fields] of configured) {\n const flow = flows[flowName];\n if (!isJsonObject(flow) || !isJsonObject(flow.scopes)) {\n return `OAuth2 ${flowName} flow requires scopes`;\n }\n for (const field of fields) {\n if (typeof flow[field] !== 'string' || flow[field].length === 0) {\n return `OAuth2 ${flowName} flow requires ${field}`;\n }\n }\n }\n return undefined;\n }\n default:\n return `Unsupported security scheme type ${String(value.type)}`;\n }\n}\n\nfunction credentialTarget(\n scheme: OpenAPISecuritySchemeObject,\n): string | undefined {\n switch (scheme.type) {\n case 'apiKey': {\n if (!scheme.in || !scheme.name) return undefined;\n const name =\n scheme.in === 'header' ? scheme.name.toLowerCase() : scheme.name;\n return `${scheme.in}:${name}`;\n }\n case 'http':\n case 'oauth2':\n case 'openIdConnect':\n return 'header:authorization';\n case 'mutualTLS':\n return 'transport:client-certificate';\n }\n}\n"],
|
|
5
|
+
"mappings": "AAEA,SAAS,oBAAoB;AAC7B,SAAS,yBAAyB;AAG3B,SAAS,oBAAoC;AAClD,SAAO;AAAA,IACL,MAAM;AAAA,IACN,QAAQ,EAAE,MAAM,OAAO,GAAG;AACxB,iBAAW,CAAC,MAAM,MAAM,KAAK,OAAO;AAAA,QAClC,KAAK,WAAW;AAAA,MAClB,GAAG;AACD,cAAM,UAAU,sBAAsB,MAAM;AAC5C,YAAI,SAAS;AACX,iBAAO;AAAA,YACL,MAAM;AAAA,YACN,UAAU;AAAA,YACV,MAAM,8BAA8B,IAAI;AAAA,YACxC;AAAA,UACF,CAAC;AAAA,QACH;AAAA,MACF;AACA,iBAAW,EAAE,OAAO,UAAU,KAAK,kBAAkB,IAAI,GAAG;AAC1D,kBAAU,WAAW;AAAA,UACnB,UAAU,YAAY,KAAK,YAAY,CAAC;AAAA,QAC1C;AACA,cAAM,OAAO,GAAG,MAAM,OAAO,YAAY,CAAC,IAAI,MAAM,IAAI;AACxD,mBAAW,eAAe,UAAU,UAAU;AAC5C,gBAAM,UAAU,oBAAI,IAAoB;AACxC,qBAAW,CAAC,MAAM,MAAM,KAAK,OAAO,QAAQ,WAAW,GAAG;AACxD,kBAAM,SAAS,KAAK,WAAW,gBAAgB,IAAI;AACnD,gBAAI,CAAC,QAAQ;AAGX,qBAAO;AAAA,gBACL,MAAM;AAAA,gBACN,UAAU;AAAA,gBACV;AAAA,gBACA,SAAS,mBAAmB,IAAI;AAAA,cAClC,CAAC;AACD;AAAA,YACF;AACA,gBAAI,OAAO,SAAS,UAAU;AAC5B,oBAAM,kBAAkB,IAAI;AAAA,gBAC1B,OAAO,OAAO,OAAO,SAAS,CAAC,CAAC,EAAE;AAAA,kBAAQ,CAAC,SACzC,OAAO,KAAK,MAAM,UAAU,CAAC,CAAC;AAAA,gBAChC;AAAA,cACF;AACA,yBAAW,SAAS,QAAQ;AAC1B,oBAAI,CAAC,gBAAgB,IAAI,KAAK,GAAG;AAC/B,yBAAO;AAAA,oBACL,MAAM;AAAA,oBACN,UAAU;AAAA,oBACV;AAAA,oBACA,SAAS,iBAAiB,IAAI,2BAA2B,KAAK;AAAA,kBAChE,CAAC;AAAA,gBACH;AAAA,cACF;AAAA,YACF;AACA,kBAAM,SAAS,iBAAiB,MAAM;AACtC,kBAAM,WAAW,SAAS,QAAQ,IAAI,MAAM,IAAI;AAChD,gBAAI,UAAU,UAAU;AACtB,qBAAO;AAAA,gBACL,MAAM;AAAA,gBACN,UAAU;AAAA,gBACV;AAAA,gBACA,SAAS,oBAAoB,QAAQ,QAAQ,IAAI,aAAa,MAAM;AAAA,cACtE,CAAC;AAAA,YACH,WAAW,QAAQ;AACjB,sBAAQ,IAAI,QAAQ,IAAI;AAAA,YAC1B;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;AAEA,SAAS,sBAAsB,QAAqC;AAClE,QAAM,QAAQ,aAAa,MAAM,IAAI,SAAS,CAAC;AAC/C,UAAQ,MAAM,MAAM;AAAA,IAClB,KAAK;AACH,UAAI,OAAO,MAAM,SAAS,YAAY,MAAM,KAAK,WAAW,GAAG;AAC7D,eAAO;AAAA,MACT;AACA,UACE,MAAM,OAAO,YACb,MAAM,OAAO,WACb,MAAM,OAAO,UACb;AACA,eAAO;AAAA,MACT;AACA,aAAO;AAAA,IACT,KAAK;AACH,aAAO,OAAO,MAAM,WAAW,YAAY,MAAM,OAAO,SAAS,IAC7D,SACA;AAAA,IACN,KAAK;AACH,aAAO;AAAA,IACT,KAAK;AACH,aAAO,OAAO,MAAM,qBAAqB,YACvC,MAAM,iBAAiB,SAAS,IAC9B,SACA;AAAA,IACN,KAAK,UAAU;AACb,YAAM,QAAQ,MAAM;AACpB,UAAI,CAAC,aAAa,KAAK,GAAG;AACxB,eAAO;AAAA,MACT;AACA,YAAM,eAAyC;AAAA,QAC7C,UAAU,CAAC,kBAAkB;AAAA,QAC7B,UAAU,CAAC,UAAU;AAAA,QACrB,mBAAmB,CAAC,UAAU;AAAA,QAC9B,mBAAmB,CAAC,oBAAoB,UAAU;AAAA,QAClD,qBAAqB,CAAC,0BAA0B,UAAU;AAAA,MAC5D;AACA,YAAM,aAAa,OAAO,QAAQ,YAAY,EAAE;AAAA,QAC9C,CAAC,CAAC,IAAI,MAAM,MAAM,IAAI,MAAM;AAAA,MAC9B;AACA,UAAI,WAAW,WAAW,GAAG;AAC3B,eAAO;AAAA,MACT;AACA,iBAAW,CAAC,UAAU,MAAM,KAAK,YAAY;AAC3C,cAAM,OAAO,MAAM,QAAQ;AAC3B,YAAI,CAAC,aAAa,IAAI,KAAK,CAAC,aAAa,KAAK,MAAM,GAAG;AACrD,iBAAO,UAAU,QAAQ;AAAA,QAC3B;AACA,mBAAW,SAAS,QAAQ;AAC1B,cAAI,OAAO,KAAK,KAAK,MAAM,YAAY,KAAK,KAAK,EAAE,WAAW,GAAG;AAC/D,mBAAO,UAAU,QAAQ,kBAAkB,KAAK;AAAA,UAClD;AAAA,QACF;AAAA,MACF;AACA,aAAO;AAAA,IACT;AAAA,IACA;AACE,aAAO,oCAAoC,OAAO,MAAM,IAAI,CAAC;AAAA,EACjE;AACF;AAEA,SAAS,iBACP,QACoB;AACpB,UAAQ,OAAO,MAAM;AAAA,IACnB,KAAK,UAAU;AACb,UAAI,CAAC,OAAO,MAAM,CAAC,OAAO,KAAM,QAAO;AACvC,YAAM,OACJ,OAAO,OAAO,WAAW,OAAO,KAAK,YAAY,IAAI,OAAO;AAC9D,aAAO,GAAG,OAAO,EAAE,IAAI,IAAI;AAAA,IAC7B;AAAA,IACA,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AACH,aAAO;AAAA,IACT,KAAK;AACH,aAAO;AAAA,EACX;AACF;",
|
|
6
6
|
"names": []
|
|
7
7
|
}
|
|
@@ -1,3 +1,9 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
|
|
1
|
+
import type { DocumentPlugin } from '../processing.js';
|
|
2
|
+
/**
|
|
3
|
+
* Gives each operation one group tag, and keeps every group defined: an
|
|
4
|
+
* authored definition takes the group's name (the authored name stays as its
|
|
5
|
+
* summary), a tag's parent follows the rename, and a group nothing defines
|
|
6
|
+
* gets a definition, so a host finds the definition of every operation's tag.
|
|
7
|
+
*/
|
|
8
|
+
export declare function normalizeTags(): DocumentPlugin;
|
|
3
9
|
//# sourceMappingURL=normalize-tags.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"normalize-tags.d.ts","
|
|
1
|
+
{"version":3,"file":"normalize-tags.d.ts","sources":["../../../src/lib/processing-plugins/normalize-tags.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD;;;;;GAKG;AACH,wBAAgB,aAAa,IAAI,cAAc,CAiD9C"}
|
|
@@ -4,11 +4,45 @@ function normalizeTags() {
|
|
|
4
4
|
return {
|
|
5
5
|
name: "normalize-tags",
|
|
6
6
|
process({ spec, options }) {
|
|
7
|
+
const renamed = /* @__PURE__ */ new Map();
|
|
8
|
+
const groups = /* @__PURE__ */ new Set();
|
|
7
9
|
for (const { entry, operation } of iterateOperations(spec)) {
|
|
8
10
|
const tag = options.tag(operation, entry.path);
|
|
11
|
+
const group = snakecase(tag);
|
|
12
|
+
const [authored] = operation.tags ?? [];
|
|
13
|
+
if (authored !== void 0) {
|
|
14
|
+
renamed.set(authored, group);
|
|
15
|
+
}
|
|
16
|
+
groups.add(group);
|
|
9
17
|
operation["x-fn-group"] = tag;
|
|
10
|
-
operation.tags = [
|
|
18
|
+
operation.tags = [group];
|
|
11
19
|
}
|
|
20
|
+
const definitions = /* @__PURE__ */ new Map();
|
|
21
|
+
for (const authored of spec.tags) {
|
|
22
|
+
const name = renamed.get(authored.name) ?? authored.name;
|
|
23
|
+
if (definitions.has(name)) {
|
|
24
|
+
continue;
|
|
25
|
+
}
|
|
26
|
+
const definition = name === authored.name ? { ...authored } : {
|
|
27
|
+
...authored,
|
|
28
|
+
name,
|
|
29
|
+
summary: authored.summary ?? authored.name
|
|
30
|
+
};
|
|
31
|
+
if (authored.parent !== void 0) {
|
|
32
|
+
definition.parent = renamed.get(authored.parent) ?? authored.parent;
|
|
33
|
+
}
|
|
34
|
+
definitions.set(name, definition);
|
|
35
|
+
}
|
|
36
|
+
for (const [authored, group] of renamed) {
|
|
37
|
+
definitions.getOrInsertComputed(group, (name) => ({
|
|
38
|
+
name,
|
|
39
|
+
summary: authored
|
|
40
|
+
}));
|
|
41
|
+
}
|
|
42
|
+
for (const group of groups) {
|
|
43
|
+
definitions.getOrInsertComputed(group, (name) => ({ name }));
|
|
44
|
+
}
|
|
45
|
+
spec.tags = [...definitions.values()];
|
|
12
46
|
}
|
|
13
47
|
};
|
|
14
48
|
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../../../src/lib/processing-plugins/normalize-tags.ts"],
|
|
4
|
-
"sourcesContent": ["import { snakecase } from '@sdk-it/core/utils.js';\n\nimport { iterateOperations } from '../for-each-operation.js';\nimport type {
|
|
5
|
-
"mappings": "
|
|
4
|
+
"sourcesContent": ["import type { TagObject } from 'openapi3-ts/oas32';\n\nimport { snakecase } from '@sdk-it/core/utils.js';\n\nimport { iterateOperations } from '../for-each-operation.js';\nimport type { DocumentPlugin } from '../processing.js';\n\n/**\n * Gives each operation one group tag, and keeps every group defined: an\n * authored definition takes the group's name (the authored name stays as its\n * summary), a tag's parent follows the rename, and a group nothing defines\n * gets a definition, so a host finds the definition of every operation's tag.\n */\nexport function normalizeTags(): DocumentPlugin {\n return {\n name: 'normalize-tags',\n process({ spec, options }) {\n const renamed = new Map<string, string>();\n const groups = new Set<string>();\n for (const { entry, operation } of iterateOperations(spec)) {\n const tag = options.tag(operation, entry.path);\n const group = snakecase(tag);\n const [authored] = operation.tags ?? [];\n if (authored !== undefined) {\n renamed.set(authored, group);\n }\n groups.add(group);\n operation['x-fn-group'] = tag;\n operation.tags = [group];\n }\n\n const definitions = new Map<string, TagObject>();\n for (const authored of spec.tags) {\n const name = renamed.get(authored.name) ?? authored.name;\n if (definitions.has(name)) {\n continue;\n }\n const definition: TagObject =\n name === authored.name\n ? { ...authored }\n : {\n ...authored,\n name,\n summary: authored.summary ?? authored.name,\n };\n if (authored.parent !== undefined) {\n definition.parent = renamed.get(authored.parent) ?? authored.parent;\n }\n definitions.set(name, definition);\n }\n for (const [authored, group] of renamed) {\n definitions.getOrInsertComputed(group, (name) => ({\n name,\n summary: authored,\n }));\n }\n for (const group of groups) {\n definitions.getOrInsertComputed(group, (name) => ({ name }));\n }\n spec.tags = [...definitions.values()];\n },\n };\n}\n"],
|
|
5
|
+
"mappings": "AAEA,SAAS,iBAAiB;AAE1B,SAAS,yBAAyB;AAS3B,SAAS,gBAAgC;AAC9C,SAAO;AAAA,IACL,MAAM;AAAA,IACN,QAAQ,EAAE,MAAM,QAAQ,GAAG;AACzB,YAAM,UAAU,oBAAI,IAAoB;AACxC,YAAM,SAAS,oBAAI,IAAY;AAC/B,iBAAW,EAAE,OAAO,UAAU,KAAK,kBAAkB,IAAI,GAAG;AAC1D,cAAM,MAAM,QAAQ,IAAI,WAAW,MAAM,IAAI;AAC7C,cAAM,QAAQ,UAAU,GAAG;AAC3B,cAAM,CAAC,QAAQ,IAAI,UAAU,QAAQ,CAAC;AACtC,YAAI,aAAa,QAAW;AAC1B,kBAAQ,IAAI,UAAU,KAAK;AAAA,QAC7B;AACA,eAAO,IAAI,KAAK;AAChB,kBAAU,YAAY,IAAI;AAC1B,kBAAU,OAAO,CAAC,KAAK;AAAA,MACzB;AAEA,YAAM,cAAc,oBAAI,IAAuB;AAC/C,iBAAW,YAAY,KAAK,MAAM;AAChC,cAAM,OAAO,QAAQ,IAAI,SAAS,IAAI,KAAK,SAAS;AACpD,YAAI,YAAY,IAAI,IAAI,GAAG;AACzB;AAAA,QACF;AACA,cAAM,aACJ,SAAS,SAAS,OACd,EAAE,GAAG,SAAS,IACd;AAAA,UACE,GAAG;AAAA,UACH;AAAA,UACA,SAAS,SAAS,WAAW,SAAS;AAAA,QACxC;AACN,YAAI,SAAS,WAAW,QAAW;AACjC,qBAAW,SAAS,QAAQ,IAAI,SAAS,MAAM,KAAK,SAAS;AAAA,QAC/D;AACA,oBAAY,IAAI,MAAM,UAAU;AAAA,MAClC;AACA,iBAAW,CAAC,UAAU,KAAK,KAAK,SAAS;AACvC,oBAAY,oBAAoB,OAAO,CAAC,UAAU;AAAA,UAChD;AAAA,UACA,SAAS;AAAA,QACX,EAAE;AAAA,MACJ;AACA,iBAAW,SAAS,QAAQ;AAC1B,oBAAY,oBAAoB,OAAO,CAAC,UAAU,EAAE,KAAK,EAAE;AAAA,MAC7D;AACA,WAAK,OAAO,CAAC,GAAG,YAAY,OAAO,CAAC;AAAA,IACtC;AAAA,EACF;AACF;",
|
|
6
6
|
"names": []
|
|
7
7
|
}
|
|
@@ -1,9 +1,20 @@
|
|
|
1
|
-
import type
|
|
1
|
+
import { type OpenAPIDocument } from '@sdk-it/core';
|
|
2
|
+
import { type Documents } from '../external-documents.js';
|
|
3
|
+
import type { DocumentPlugin } from '../processing.js';
|
|
2
4
|
/**
|
|
3
5
|
* OpenAPI 3.2 lets a security requirement key be a URI of a Security Scheme
|
|
4
6
|
* Object instead of a `components.securitySchemes` name. Generators key
|
|
5
7
|
* credentials by scheme name, so each URI is fetched, registered locally, and
|
|
6
8
|
* the requirement rewritten to point at the registered name.
|
|
7
9
|
*/
|
|
8
|
-
export declare function resolveSecuritySchemeUris():
|
|
10
|
+
export declare function resolveSecuritySchemeUris(): DocumentPlugin;
|
|
11
|
+
/**
|
|
12
|
+
* Registers the scheme behind each URI requirement key under a local name and
|
|
13
|
+
* rewrites the requirement to it. Every document read is recorded in
|
|
14
|
+
* `documents`; the URIs that could not be resolved are returned.
|
|
15
|
+
*/
|
|
16
|
+
export declare function registerExternalSecuritySchemes(spec: OpenAPIDocument, documents: Documents): Promise<{
|
|
17
|
+
uri: string;
|
|
18
|
+
error: unknown;
|
|
19
|
+
}[]>;
|
|
9
20
|
//# sourceMappingURL=resolve-security-scheme-uris.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"resolve-security-scheme-uris.d.ts","
|
|
1
|
+
{"version":3,"file":"resolve-security-scheme-uris.d.ts","sources":["../../../src/lib/processing-plugins/resolve-security-scheme-uris.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,KAAK,eAAe,EAIrB,MAAM,cAAc,CAAC;AAEtB,OAAO,EACL,KAAK,SAAS,EAOf,MAAM,0BAA0B,CAAC;AAElC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD;;;;;GAKG;AACH,wBAAgB,yBAAyB,IAAI,cAAc,CAe1D;AAED;;;;GAIG;AACH,wBAAsB,+BAA+B,CACnD,IAAI,EAAE,eAAe,EACrB,SAAS,EAAE,SAAS;SAUG,MAAM;WAAS,OAAO;KAiC9C"}
|
|
@@ -1,57 +1,71 @@
|
|
|
1
|
-
import { fileURLToPath } from "node:url";
|
|
2
1
|
import {
|
|
3
2
|
followRef,
|
|
4
3
|
isRef
|
|
5
4
|
} from "@sdk-it/core";
|
|
5
|
+
import {
|
|
6
|
+
availableName,
|
|
7
|
+
documentUrl,
|
|
8
|
+
isJsonObject,
|
|
9
|
+
loadDocument,
|
|
10
|
+
readPointer,
|
|
11
|
+
splitFragment
|
|
12
|
+
} from "../external-documents.js";
|
|
6
13
|
import { iterateOperations } from "../for-each-operation.js";
|
|
7
|
-
import { loadFile } from "../loaders/load-spec.js";
|
|
8
14
|
function resolveSecuritySchemeUris() {
|
|
9
15
|
return {
|
|
10
16
|
name: "resolve-security-scheme-uris",
|
|
11
17
|
async process({ spec, report }) {
|
|
12
|
-
const
|
|
13
|
-
const
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
}
|
|
21
|
-
const documents = /* @__PURE__ */ new Map();
|
|
22
|
-
const registered = /* @__PURE__ */ new Map();
|
|
23
|
-
for (const uri of uris) {
|
|
24
|
-
try {
|
|
25
|
-
const scheme = await resolveScheme(uri, spec, documents);
|
|
26
|
-
const [alias] = Object.entries(spec.components.securitySchemes).find(
|
|
27
|
-
([, registeredScheme]) => registeredScheme === scheme
|
|
28
|
-
) ?? [];
|
|
29
|
-
const name = alias ?? availableName(spec, schemeName(uri));
|
|
30
|
-
spec.components.securitySchemes[name] = scheme;
|
|
31
|
-
registered.set(uri, name);
|
|
32
|
-
} catch (error) {
|
|
33
|
-
report({
|
|
34
|
-
code: "unresolvable-security-scheme-uri",
|
|
35
|
-
severity: "error",
|
|
36
|
-
path: uri,
|
|
37
|
-
message: `Could not resolve security scheme URI ${uri}: ${error instanceof Error ? error.message : String(error)}`
|
|
38
|
-
});
|
|
39
|
-
}
|
|
40
|
-
}
|
|
41
|
-
for (const requirement of requirements) {
|
|
42
|
-
for (const [uri, name] of registered) {
|
|
43
|
-
if (Object.hasOwn(requirement, uri)) {
|
|
44
|
-
requirement[name] = requirement[uri];
|
|
45
|
-
delete requirement[uri];
|
|
46
|
-
}
|
|
47
|
-
}
|
|
18
|
+
const failures = await registerExternalSecuritySchemes(spec, /* @__PURE__ */ new Map());
|
|
19
|
+
for (const { uri, error } of failures) {
|
|
20
|
+
report({
|
|
21
|
+
code: "unresolvable-security-scheme-uri",
|
|
22
|
+
severity: "error",
|
|
23
|
+
path: uri,
|
|
24
|
+
message: `Could not resolve security scheme URI ${uri}: ${Error.isError(error) ? error.message : String(error)}`
|
|
25
|
+
});
|
|
48
26
|
}
|
|
49
27
|
}
|
|
50
28
|
};
|
|
51
29
|
}
|
|
30
|
+
async function registerExternalSecuritySchemes(spec, documents) {
|
|
31
|
+
const requirements = collectRequirements(spec);
|
|
32
|
+
const uris = new Set(
|
|
33
|
+
requirements.flatMap((requirement) => Object.keys(requirement)).filter(
|
|
34
|
+
(key) => !spec.components?.securitySchemes?.[key] && isUriKey(key)
|
|
35
|
+
)
|
|
36
|
+
);
|
|
37
|
+
const failures = [];
|
|
38
|
+
if (!uris.size) {
|
|
39
|
+
return failures;
|
|
40
|
+
}
|
|
41
|
+
const schemes = (spec.components ??= {}).securitySchemes ??= {};
|
|
42
|
+
const registered = /* @__PURE__ */ new Map();
|
|
43
|
+
for (const uri of uris) {
|
|
44
|
+
try {
|
|
45
|
+
const scheme = await resolveScheme(uri, spec, documents);
|
|
46
|
+
const [alias] = Object.entries(schemes).find(
|
|
47
|
+
([, registeredScheme]) => registeredScheme === scheme
|
|
48
|
+
) ?? [];
|
|
49
|
+
const name = alias ?? availableName(schemes, schemeName(uri));
|
|
50
|
+
schemes[name] = scheme;
|
|
51
|
+
registered.set(uri, name);
|
|
52
|
+
} catch (error) {
|
|
53
|
+
failures.push({ uri, error });
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
for (const requirement of requirements) {
|
|
57
|
+
for (const [uri, name] of registered) {
|
|
58
|
+
if (Object.hasOwn(requirement, uri)) {
|
|
59
|
+
requirement[name] = requirement[uri];
|
|
60
|
+
delete requirement[uri];
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
return failures;
|
|
65
|
+
}
|
|
52
66
|
function collectRequirements(spec) {
|
|
53
67
|
const requirements = [...spec.security ?? []];
|
|
54
|
-
for (const { operation } of iterateOperations(spec)) {
|
|
68
|
+
for (const { operation } of iterateOperations({ paths: spec.paths ?? {} })) {
|
|
55
69
|
requirements.push(...operation.security ?? []);
|
|
56
70
|
}
|
|
57
71
|
return requirements;
|
|
@@ -61,60 +75,31 @@ function isUriKey(key) {
|
|
|
61
75
|
}
|
|
62
76
|
async function resolveScheme(uri, spec, documents) {
|
|
63
77
|
const [location, fragment] = splitFragment(uri);
|
|
64
|
-
const document = location ? await
|
|
78
|
+
const document = location ? await schemeDocument(location, spec, documents) : spec;
|
|
65
79
|
let scheme = fragment ? readPointer(document, fragment) : document;
|
|
66
80
|
if (isRef(scheme)) {
|
|
67
81
|
scheme = followRef(document, scheme.$ref);
|
|
68
82
|
}
|
|
69
|
-
if (scheme
|
|
83
|
+
if (!isSecurityScheme(scheme)) {
|
|
70
84
|
return Promise.reject(
|
|
71
85
|
new Error("the target is not a Security Scheme Object")
|
|
72
86
|
);
|
|
73
87
|
}
|
|
74
88
|
return scheme;
|
|
75
89
|
}
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
const url = new URL(location, base);
|
|
86
|
-
if (url.href === base) {
|
|
87
|
-
return Promise.resolve(spec);
|
|
88
|
-
}
|
|
89
|
-
let pending = documents.get(url.href);
|
|
90
|
-
if (!pending) {
|
|
91
|
-
pending = loadFile(
|
|
92
|
-
url.protocol === "file:" ? fileURLToPath(url) : url.href
|
|
93
|
-
);
|
|
94
|
-
documents.set(url.href, pending);
|
|
95
|
-
}
|
|
96
|
-
return pending;
|
|
97
|
-
}
|
|
98
|
-
function isAbsolute(location) {
|
|
99
|
-
return URL.canParse(location);
|
|
90
|
+
const securitySchemeTypes = [
|
|
91
|
+
"apiKey",
|
|
92
|
+
"http",
|
|
93
|
+
"mutualTLS",
|
|
94
|
+
"oauth2",
|
|
95
|
+
"openIdConnect"
|
|
96
|
+
];
|
|
97
|
+
function isSecurityScheme(value) {
|
|
98
|
+
return isJsonObject(value) && securitySchemeTypes.some((type) => type === value.type);
|
|
100
99
|
}
|
|
101
|
-
function
|
|
102
|
-
const
|
|
103
|
-
return
|
|
104
|
-
}
|
|
105
|
-
function readPointer(document, fragment) {
|
|
106
|
-
let current = document;
|
|
107
|
-
for (const segment of fragment.split("/")) {
|
|
108
|
-
if (!segment) {
|
|
109
|
-
continue;
|
|
110
|
-
}
|
|
111
|
-
const key = decodeURIComponent(segment).replaceAll("~1", "/").replaceAll("~0", "~");
|
|
112
|
-
if (current === null || typeof current !== "object" || !(key in current)) {
|
|
113
|
-
throw new Error(`no value at pointer #${fragment}`);
|
|
114
|
-
}
|
|
115
|
-
current = current[key];
|
|
116
|
-
}
|
|
117
|
-
return current;
|
|
100
|
+
function schemeDocument(location, spec, documents) {
|
|
101
|
+
const url = documentUrl(location, spec.$self);
|
|
102
|
+
return url.href === spec.$self ? spec : loadDocument(url, documents);
|
|
118
103
|
}
|
|
119
104
|
function schemeName(uri) {
|
|
120
105
|
const [location, fragment] = splitFragment(uri);
|
|
@@ -125,15 +110,8 @@ function schemeName(uri) {
|
|
|
125
110
|
function lastSegment(value) {
|
|
126
111
|
return value.split("/").filter(Boolean).at(-1);
|
|
127
112
|
}
|
|
128
|
-
function availableName(spec, candidate) {
|
|
129
|
-
let name = candidate;
|
|
130
|
-
let suffix = 2;
|
|
131
|
-
while (spec.components.securitySchemes[name]) {
|
|
132
|
-
name = `${candidate}${suffix++}`;
|
|
133
|
-
}
|
|
134
|
-
return name;
|
|
135
|
-
}
|
|
136
113
|
export {
|
|
114
|
+
registerExternalSecuritySchemes,
|
|
137
115
|
resolveSecuritySchemeUris
|
|
138
116
|
};
|
|
139
117
|
//# sourceMappingURL=resolve-security-scheme-uris.js.map
|