@sdk-it/spec 0.46.11 → 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.
Files changed (176) hide show
  1. package/README.md +8 -4
  2. package/dist/index.d.ts +2 -1
  3. package/dist/index.d.ts.map +1 -1
  4. package/dist/index.js +2 -1
  5. package/dist/index.js.map +2 -2
  6. package/dist/lib/external-documents.d.ts +4 -1
  7. package/dist/lib/external-documents.d.ts.map +1 -1
  8. package/dist/lib/external-documents.js +27 -20
  9. package/dist/lib/external-documents.js.map +2 -2
  10. package/dist/lib/finalize-operations.d.ts +8 -0
  11. package/dist/lib/finalize-operations.d.ts.map +1 -0
  12. package/dist/lib/finalize-operations.js +134 -0
  13. package/dist/lib/finalize-operations.js.map +7 -0
  14. package/dist/lib/find-polymorphic-varients.d.ts.map +1 -1
  15. package/dist/lib/find-polymorphic-varients.js +3 -2
  16. package/dist/lib/find-polymorphic-varients.js.map +2 -2
  17. package/dist/lib/find-unique-schema-name.d.ts.map +1 -1
  18. package/dist/lib/for-each-operation.d.ts +3 -2
  19. package/dist/lib/for-each-operation.d.ts.map +1 -1
  20. package/dist/lib/for-each-operation.js +9 -4
  21. package/dist/lib/for-each-operation.js.map +2 -2
  22. package/dist/lib/format-name.d.ts.map +1 -1
  23. package/dist/lib/get-ref-usage.d.ts.map +1 -1
  24. package/dist/lib/get-ref-usage.js +1 -2
  25. package/dist/lib/get-ref-usage.js.map +2 -2
  26. package/dist/lib/guess/guess-resource.d.ts.map +1 -1
  27. package/dist/lib/guess/guess-resource.js +4 -4
  28. package/dist/lib/guess/guess-resource.js.map +2 -2
  29. package/dist/lib/ir.d.ts +2 -2
  30. package/dist/lib/ir.d.ts.map +1 -1
  31. package/dist/lib/ir.js +5 -3
  32. package/dist/lib/ir.js.map +2 -2
  33. package/dist/lib/is-primitive-schema.d.ts +12 -0
  34. package/dist/lib/is-primitive-schema.d.ts.map +1 -1
  35. package/dist/lib/is-primitive-schema.js +34 -1
  36. package/dist/lib/is-primitive-schema.js.map +2 -2
  37. package/dist/lib/is.d.ts +10 -1
  38. package/dist/lib/is.d.ts.map +1 -1
  39. package/dist/lib/is.js +20 -9
  40. package/dist/lib/is.js.map +2 -2
  41. package/dist/lib/loaders/load-spec.d.ts +9 -2
  42. package/dist/lib/loaders/load-spec.d.ts.map +1 -1
  43. package/dist/lib/loaders/load-spec.js +15 -20
  44. package/dist/lib/loaders/load-spec.js.map +2 -2
  45. package/dist/lib/loaders/local-loader.d.ts.map +1 -1
  46. package/dist/lib/loaders/postman/postman-converter.d.ts +1 -1
  47. package/dist/lib/loaders/postman/postman-converter.d.ts.map +1 -1
  48. package/dist/lib/loaders/postman/postman-converter.js +2 -3
  49. package/dist/lib/loaders/postman/postman-converter.js.map +2 -2
  50. package/dist/lib/loaders/postman/spec-types.d.ts.map +1 -1
  51. package/dist/lib/loaders/remote-loader.d.ts.map +1 -1
  52. package/dist/lib/loaders/remote-loader.js +4 -3
  53. package/dist/lib/loaders/remote-loader.js.map +2 -2
  54. package/dist/lib/metadata.d.ts +3 -9
  55. package/dist/lib/metadata.d.ts.map +1 -1
  56. package/dist/lib/metadata.js +22 -17
  57. package/dist/lib/metadata.js.map +2 -2
  58. package/dist/lib/operation-input.d.ts +33 -0
  59. package/dist/lib/operation-input.d.ts.map +1 -0
  60. package/dist/lib/operation-input.js +189 -0
  61. package/dist/lib/operation-input.js.map +7 -0
  62. package/dist/lib/options.d.ts +5 -6
  63. package/dist/lib/options.d.ts.map +1 -1
  64. package/dist/lib/options.js +0 -6
  65. package/dist/lib/options.js.map +2 -2
  66. package/dist/lib/overview-docs/doc-text-utils.d.ts +13 -13
  67. package/dist/lib/overview-docs/doc-text-utils.d.ts.map +1 -1
  68. package/dist/lib/overview-docs/overview-auth.d.ts.map +1 -1
  69. package/dist/lib/overview-docs/overview-auth.js.map +2 -2
  70. package/dist/lib/overview-docs/overview-docs.d.ts.map +1 -1
  71. package/dist/lib/overview-docs/overview-errors.d.ts.map +1 -1
  72. package/dist/lib/overview-docs/overview-errors.js +8 -5
  73. package/dist/lib/overview-docs/overview-errors.js.map +2 -2
  74. package/dist/lib/overview-docs/overview-page.d.ts.map +1 -1
  75. package/dist/lib/overview-docs/overview-page.js +2 -3
  76. package/dist/lib/overview-docs/overview-page.js.map +2 -2
  77. package/dist/lib/overview-docs/overview-pagination.d.ts.map +1 -1
  78. package/dist/lib/overview-docs/overview-sdks.d.ts.map +1 -1
  79. package/dist/lib/overview-docs/overview-sdks.js +2 -1
  80. package/dist/lib/overview-docs/overview-sdks.js.map +2 -2
  81. package/dist/lib/overview-docs/types.d.ts.map +1 -1
  82. package/dist/lib/overview-docs/types.js +1 -1
  83. package/dist/lib/overview-docs/types.js.map +2 -2
  84. package/dist/lib/pagination/guess-pagination.d.ts.map +1 -1
  85. package/dist/lib/pagination/guess-pagination.js.map +2 -2
  86. package/dist/lib/pagination/pagination-result.d.ts +3 -3
  87. package/dist/lib/pagination/pagination-result.d.ts.map +1 -1
  88. package/dist/lib/pagination/pagination-result.js +6 -3
  89. package/dist/lib/pagination/pagination-result.js.map +2 -2
  90. package/dist/lib/pagination/pagination.d.ts +31 -1
  91. package/dist/lib/pagination/pagination.d.ts.map +1 -1
  92. package/dist/lib/pagination/pagination.js +30 -11
  93. package/dist/lib/pagination/pagination.js.map +2 -2
  94. package/dist/lib/processing-plugins/bundle-external-refs.d.ts +13 -6
  95. package/dist/lib/processing-plugins/bundle-external-refs.d.ts.map +1 -1
  96. package/dist/lib/processing-plugins/bundle-external-refs.js +33 -18
  97. package/dist/lib/processing-plugins/bundle-external-refs.js.map +2 -2
  98. package/dist/lib/processing-plugins/canonicalize-spec.d.ts +2 -2
  99. package/dist/lib/processing-plugins/canonicalize-spec.d.ts.map +1 -1
  100. package/dist/lib/processing-plugins/canonicalize-spec.js.map +2 -2
  101. package/dist/lib/processing-plugins/create-default-processing-plugins.d.ts +4 -3
  102. package/dist/lib/processing-plugins/create-default-processing-plugins.d.ts.map +1 -1
  103. package/dist/lib/processing-plugins/create-default-processing-plugins.js +8 -3
  104. package/dist/lib/processing-plugins/create-default-processing-plugins.js.map +2 -2
  105. package/dist/lib/processing-plugins/enrich-examples.d.ts +4 -4
  106. package/dist/lib/processing-plugins/enrich-examples.d.ts.map +1 -1
  107. package/dist/lib/processing-plugins/enrich-examples.js +1 -1
  108. package/dist/lib/processing-plugins/enrich-examples.js.map +2 -2
  109. package/dist/lib/processing-plugins/extract-inline-schemas.d.ts +2 -2
  110. package/dist/lib/processing-plugins/extract-inline-schemas.d.ts.map +1 -1
  111. package/dist/lib/processing-plugins/extract-inline-schemas.js.map +2 -2
  112. package/dist/lib/processing-plugins/extract-overview-docs.d.ts +2 -2
  113. package/dist/lib/processing-plugins/extract-overview-docs.d.ts.map +1 -1
  114. package/dist/lib/processing-plugins/extract-overview-docs.js +4 -1
  115. package/dist/lib/processing-plugins/extract-overview-docs.js.map +2 -2
  116. package/dist/lib/processing-plugins/index.d.ts.map +1 -1
  117. package/dist/lib/processing-plugins/infer-pagination.d.ts +2 -2
  118. package/dist/lib/processing-plugins/infer-pagination.d.ts.map +1 -1
  119. package/dist/lib/processing-plugins/infer-pagination.js +5 -6
  120. package/dist/lib/processing-plugins/infer-pagination.js.map +2 -2
  121. package/dist/lib/processing-plugins/normalize-operation-ids.d.ts +2 -2
  122. package/dist/lib/processing-plugins/normalize-operation-ids.d.ts.map +1 -1
  123. package/dist/lib/processing-plugins/normalize-operation-ids.js.map +2 -2
  124. package/dist/lib/processing-plugins/normalize-parameters.d.ts +2 -2
  125. package/dist/lib/processing-plugins/normalize-parameters.d.ts.map +1 -1
  126. package/dist/lib/processing-plugins/normalize-parameters.js.map +2 -2
  127. package/dist/lib/processing-plugins/normalize-paths.d.ts +2 -2
  128. package/dist/lib/processing-plugins/normalize-paths.d.ts.map +1 -1
  129. package/dist/lib/processing-plugins/normalize-paths.js.map +2 -2
  130. package/dist/lib/processing-plugins/normalize-request-bodies.d.ts +9 -3
  131. package/dist/lib/processing-plugins/normalize-request-bodies.d.ts.map +1 -1
  132. package/dist/lib/processing-plugins/normalize-request-bodies.js +36 -15
  133. package/dist/lib/processing-plugins/normalize-request-bodies.js.map +2 -2
  134. package/dist/lib/processing-plugins/normalize-responses.d.ts +2 -2
  135. package/dist/lib/processing-plugins/normalize-responses.d.ts.map +1 -1
  136. package/dist/lib/processing-plugins/normalize-responses.js +11 -15
  137. package/dist/lib/processing-plugins/normalize-responses.js.map +2 -2
  138. package/dist/lib/processing-plugins/normalize-schemas.d.ts +2 -2
  139. package/dist/lib/processing-plugins/normalize-schemas.d.ts.map +1 -1
  140. package/dist/lib/processing-plugins/normalize-schemas.js +14 -4
  141. package/dist/lib/processing-plugins/normalize-schemas.js.map +2 -2
  142. package/dist/lib/processing-plugins/normalize-security.d.ts +2 -2
  143. package/dist/lib/processing-plugins/normalize-security.d.ts.map +1 -1
  144. package/dist/lib/processing-plugins/normalize-security.js +6 -5
  145. package/dist/lib/processing-plugins/normalize-security.js.map +2 -2
  146. package/dist/lib/processing-plugins/normalize-tags.d.ts +8 -2
  147. package/dist/lib/processing-plugins/normalize-tags.d.ts.map +1 -1
  148. package/dist/lib/processing-plugins/normalize-tags.js +35 -1
  149. package/dist/lib/processing-plugins/normalize-tags.js.map +2 -2
  150. package/dist/lib/processing-plugins/resolve-security-scheme-uris.d.ts +13 -2
  151. package/dist/lib/processing-plugins/resolve-security-scheme-uris.d.ts.map +1 -1
  152. package/dist/lib/processing-plugins/resolve-security-scheme-uris.js +58 -38
  153. package/dist/lib/processing-plugins/resolve-security-scheme-uris.js.map +2 -2
  154. package/dist/lib/processing.d.ts +25 -11
  155. package/dist/lib/processing.d.ts.map +1 -1
  156. package/dist/lib/processing.js +53 -16
  157. package/dist/lib/processing.js.map +2 -2
  158. package/dist/lib/reserved-keywords.d.ts.map +1 -1
  159. package/dist/lib/sidebar.d.ts +5 -4
  160. package/dist/lib/sidebar.d.ts.map +1 -1
  161. package/dist/lib/sidebar.js +46 -23
  162. package/dist/lib/sidebar.js.map +2 -2
  163. package/dist/lib/tag.d.ts.map +1 -1
  164. package/dist/lib/types.d.ts +34 -12
  165. package/dist/lib/types.d.ts.map +1 -1
  166. package/dist/lib/types.js +11 -0
  167. package/dist/lib/types.js.map +3 -3
  168. package/dist/lib/walk-schemas.d.ts +4 -2
  169. package/dist/lib/walk-schemas.d.ts.map +1 -1
  170. package/dist/lib/walk-schemas.js +15 -13
  171. package/dist/lib/walk-schemas.js.map +2 -2
  172. package/package.json +17 -6
  173. package/dist/lib/create-operation.d.ts +0 -28
  174. package/dist/lib/create-operation.d.ts.map +0 -1
  175. package/dist/lib/create-operation.js +0 -62
  176. package/dist/lib/create-operation.js.map +0 -7
@@ -1,28 +0,0 @@
1
- import type { ReferenceObject, SchemaObject } from 'openapi3-ts/oas31';
2
- import type { TunedOperationObject } from './types.js';
3
- export declare function createOperation(options: {
4
- name: string;
5
- group: string;
6
- security?: string[];
7
- parameters?: {
8
- query?: Record<string, {
9
- schema: SchemaObject;
10
- required?: boolean;
11
- }>;
12
- path?: Record<string, {
13
- schema: SchemaObject;
14
- required?: boolean;
15
- }>;
16
- header?: Record<string, {
17
- schema: SchemaObject;
18
- required?: boolean;
19
- }>;
20
- cookie?: Record<string, {
21
- schema: SchemaObject;
22
- required?: boolean;
23
- }>;
24
- };
25
- response: Record<string, SchemaObject | Record<string, SchemaObject>>;
26
- request?: Record<string, ReferenceObject>;
27
- }): TunedOperationObject;
28
- //# sourceMappingURL=create-operation.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"create-operation.d.ts","sourceRoot":"","sources":["../../src/lib/create-operation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,eAAe,EAEf,YAAY,EACb,MAAM,mBAAmB,CAAC;AAI3B,OAAO,KAAK,EAAwB,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAE7E,wBAAgB,eAAe,CAAC,OAAO,EAAE;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,UAAU,CAAC,EAAE;QACX,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;YAAE,MAAM,EAAE,YAAY,CAAC;YAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;SAAE,CAAC,CAAC;QACrE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;YAAE,MAAM,EAAE,YAAY,CAAC;YAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;SAAE,CAAC,CAAC;QACpE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;YAAE,MAAM,EAAE,YAAY,CAAC;YAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;SAAE,CAAC,CAAC;QACtE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;YAAE,MAAM,EAAE,YAAY,CAAC;YAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;SAAE,CAAC,CAAC;KACvE,CAAC;IACF,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC;IACtE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;CAC3C,GAAG,oBAAoB,CA8DvB"}
@@ -1,62 +0,0 @@
1
- import { isEmpty } from "@sdk-it/core/utils.js";
2
- function createOperation(options) {
3
- const parameters = [];
4
- if (!isEmpty(options.parameters)) {
5
- const locations = ["query", "path", "header", "cookie"];
6
- for (const location of locations) {
7
- const locationParams = options.parameters[location];
8
- if (locationParams) {
9
- for (const [name, param] of Object.entries(locationParams)) {
10
- parameters.push({
11
- name,
12
- in: location,
13
- required: param.required ?? false,
14
- schema: param.schema
15
- });
16
- }
17
- }
18
- }
19
- }
20
- const responses = {};
21
- for (const [key, schema] of Object.entries(options.response)) {
22
- const [statusCode, contentType] = key.split(/-(.*)/);
23
- if (!contentType) {
24
- throw new Error(
25
- `Response key "${key}" must be in the format "statusCode-contentType"`
26
- );
27
- }
28
- responses[statusCode] ??= {
29
- description: `Response for ${statusCode}`,
30
- content: {}
31
- };
32
- if (contentType === "headers") {
33
- responses[statusCode].headers = schema;
34
- } else {
35
- responses[statusCode].content[contentType] = {
36
- schema
37
- };
38
- }
39
- }
40
- let requestBody = void 0;
41
- if (options.request) {
42
- requestBody = { description: "Request body", content: {} };
43
- for (const [contentType, schema] of Object.entries(options.request)) {
44
- requestBody.content[contentType] = { schema };
45
- }
46
- }
47
- return {
48
- security: (options.security ?? []).map((name) => ({
49
- [name]: []
50
- })),
51
- "x-fn-name": options.name,
52
- operationId: options.name,
53
- tags: [options.group],
54
- parameters,
55
- responses,
56
- requestBody
57
- };
58
- }
59
- export {
60
- createOperation
61
- };
62
- //# sourceMappingURL=create-operation.js.map
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["../../src/lib/create-operation.ts"],
4
- "sourcesContent": ["import type {\n ParameterObject,\n ReferenceObject,\n ResponsesObject,\n SchemaObject,\n} from 'openapi3-ts/oas31';\n\nimport { isEmpty } from '@sdk-it/core/utils.js';\n\nimport type { OurRequestBodyObject, TunedOperationObject } from './types.js';\n\nexport function createOperation(options: {\n name: string;\n group: string;\n security?: string[];\n parameters?: {\n query?: Record<string, { schema: SchemaObject; required?: boolean }>;\n path?: Record<string, { schema: SchemaObject; required?: boolean }>;\n header?: Record<string, { schema: SchemaObject; required?: boolean }>;\n cookie?: Record<string, { schema: SchemaObject; required?: boolean }>;\n };\n response: Record<string, SchemaObject | Record<string, SchemaObject>>; // Key is statusCode-contentType\n request?: Record<string, ReferenceObject>;\n}): TunedOperationObject {\n const parameters: ParameterObject[] = [];\n if (!isEmpty(options.parameters)) {\n const locations = ['query', 'path', 'header', 'cookie'] as const;\n for (const location of locations) {\n const locationParams = options.parameters[location];\n if (locationParams) {\n for (const [name, param] of Object.entries(locationParams)) {\n parameters.push({\n name,\n in: location,\n required: param.required ?? false,\n schema: param.schema,\n });\n }\n }\n }\n }\n const responses: ResponsesObject = {};\n\n for (const [key, schema] of Object.entries(options.response)) {\n const [statusCode, contentType] = key.split(/-(.*)/); // Split on the first dash\n if (!contentType) {\n throw new Error(\n `Response key \"${key}\" must be in the format \"statusCode-contentType\"`,\n );\n }\n responses[statusCode] ??= {\n description: `Response for ${statusCode}`,\n content: {},\n };\n\n if (contentType === 'headers') {\n responses[statusCode].headers = schema;\n } else {\n responses[statusCode].content[contentType] = {\n schema: schema,\n };\n }\n }\n\n let requestBody: OurRequestBodyObject | undefined = undefined;\n\n if (options.request) {\n requestBody = { description: 'Request body', content: {} };\n\n for (const [contentType, schema] of Object.entries(options.request)) {\n requestBody.content[contentType] = { schema: schema };\n }\n }\n\n return {\n security: (options.security ?? []).map((name) => ({\n [name]: [],\n })),\n 'x-fn-name': options.name,\n operationId: options.name,\n tags: [options.group],\n parameters,\n responses,\n requestBody: requestBody as any,\n };\n}\n"],
5
- "mappings": "AAOA,SAAS,eAAe;AAIjB,SAAS,gBAAgB,SAYP;AACvB,QAAM,aAAgC,CAAC;AACvC,MAAI,CAAC,QAAQ,QAAQ,UAAU,GAAG;AAChC,UAAM,YAAY,CAAC,SAAS,QAAQ,UAAU,QAAQ;AACtD,eAAW,YAAY,WAAW;AAChC,YAAM,iBAAiB,QAAQ,WAAW,QAAQ;AAClD,UAAI,gBAAgB;AAClB,mBAAW,CAAC,MAAM,KAAK,KAAK,OAAO,QAAQ,cAAc,GAAG;AAC1D,qBAAW,KAAK;AAAA,YACd;AAAA,YACA,IAAI;AAAA,YACJ,UAAU,MAAM,YAAY;AAAA,YAC5B,QAAQ,MAAM;AAAA,UAChB,CAAC;AAAA,QACH;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACA,QAAM,YAA6B,CAAC;AAEpC,aAAW,CAAC,KAAK,MAAM,KAAK,OAAO,QAAQ,QAAQ,QAAQ,GAAG;AAC5D,UAAM,CAAC,YAAY,WAAW,IAAI,IAAI,MAAM,OAAO;AACnD,QAAI,CAAC,aAAa;AAChB,YAAM,IAAI;AAAA,QACR,iBAAiB,GAAG;AAAA,MACtB;AAAA,IACF;AACA,cAAU,UAAU,MAAM;AAAA,MACxB,aAAa,gBAAgB,UAAU;AAAA,MACvC,SAAS,CAAC;AAAA,IACZ;AAEA,QAAI,gBAAgB,WAAW;AAC7B,gBAAU,UAAU,EAAE,UAAU;AAAA,IAClC,OAAO;AACL,gBAAU,UAAU,EAAE,QAAQ,WAAW,IAAI;AAAA,QAC3C;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,MAAI,cAAgD;AAEpD,MAAI,QAAQ,SAAS;AACnB,kBAAc,EAAE,aAAa,gBAAgB,SAAS,CAAC,EAAE;AAEzD,eAAW,CAAC,aAAa,MAAM,KAAK,OAAO,QAAQ,QAAQ,OAAO,GAAG;AACnE,kBAAY,QAAQ,WAAW,IAAI,EAAE,OAAe;AAAA,IACtD;AAAA,EACF;AAEA,SAAO;AAAA,IACL,WAAW,QAAQ,YAAY,CAAC,GAAG,IAAI,CAAC,UAAU;AAAA,MAChD,CAAC,IAAI,GAAG,CAAC;AAAA,IACX,EAAE;AAAA,IACF,aAAa,QAAQ;AAAA,IACrB,aAAa,QAAQ;AAAA,IACrB,MAAM,CAAC,QAAQ,KAAK;AAAA,IACpB;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;",
6
- "names": []
7
- }