@sdk-it/spec 0.21.0 → 0.22.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 (58) hide show
  1. package/dist/index.d.ts +10 -0
  2. package/dist/index.d.ts.map +1 -1
  3. package/dist/index.js +2629 -2
  4. package/dist/index.js.map +4 -4
  5. package/dist/lib/find-polymorphic-varients.d.ts +15 -0
  6. package/dist/lib/find-polymorphic-varients.d.ts.map +1 -0
  7. package/dist/lib/find-polymorphic-varients.test.d.ts +2 -0
  8. package/dist/lib/find-polymorphic-varients.test.d.ts.map +1 -0
  9. package/dist/lib/find-unique-schema-name.d.ts +3 -0
  10. package/dist/lib/find-unique-schema-name.d.ts.map +1 -0
  11. package/dist/lib/format-name.d.ts +2 -0
  12. package/dist/lib/format-name.d.ts.map +1 -0
  13. package/dist/lib/get-ref-usage.d.ts +3 -0
  14. package/dist/lib/get-ref-usage.d.ts.map +1 -0
  15. package/dist/lib/is-primitive-schema.d.ts +3 -0
  16. package/dist/lib/is-primitive-schema.d.ts.map +1 -0
  17. package/dist/lib/loaders/load-spec.d.ts.map +1 -1
  18. package/dist/lib/loaders/postman/postman-converter.d.ts.map +1 -1
  19. package/dist/lib/metadata.d.ts +22 -0
  20. package/dist/lib/metadata.d.ts.map +1 -0
  21. package/dist/lib/operation.d.ts +62 -18
  22. package/dist/lib/operation.d.ts.map +1 -1
  23. package/dist/lib/pagination/pagination-result.d.ts.map +1 -1
  24. package/dist/lib/pagination/pagination.d.ts +1 -1
  25. package/dist/lib/pagination/pagination.d.ts.map +1 -1
  26. package/dist/lib/security.d.ts +10 -0
  27. package/dist/lib/security.d.ts.map +1 -0
  28. package/dist/lib/sidebar.d.ts +2 -2
  29. package/dist/lib/sidebar.d.ts.map +1 -1
  30. package/dist/lib/tune.d.ts +11 -0
  31. package/dist/lib/tune.d.ts.map +1 -0
  32. package/dist/lib/tune.test.d.ts +2 -0
  33. package/dist/lib/tune.test.d.ts.map +1 -0
  34. package/package.json +8 -4
  35. package/dist/lib/loaders/load-spec.js +0 -27
  36. package/dist/lib/loaders/load-spec.js.map +0 -7
  37. package/dist/lib/loaders/local-loader.js +0 -20
  38. package/dist/lib/loaders/local-loader.js.map +0 -7
  39. package/dist/lib/loaders/postman/postman-converter.js +0 -486
  40. package/dist/lib/loaders/postman/postman-converter.js.map +0 -7
  41. package/dist/lib/loaders/postman/spec-types.js +0 -1
  42. package/dist/lib/loaders/postman/spec-types.js.map +0 -7
  43. package/dist/lib/loaders/remote-loader.js +0 -29
  44. package/dist/lib/loaders/remote-loader.js.map +0 -7
  45. package/dist/lib/operation.js +0 -425
  46. package/dist/lib/operation.js.map +0 -7
  47. package/dist/lib/operation.test.js +0 -261
  48. package/dist/lib/operation.test.js.map +0 -7
  49. package/dist/lib/pagination/pagination-result.js +0 -237
  50. package/dist/lib/pagination/pagination-result.js.map +0 -7
  51. package/dist/lib/pagination/pagination-result.test.js +0 -548
  52. package/dist/lib/pagination/pagination-result.test.js.map +0 -7
  53. package/dist/lib/pagination/pagination.js +0 -199
  54. package/dist/lib/pagination/pagination.js.map +0 -7
  55. package/dist/lib/pagination/pagination.test.js +0 -380
  56. package/dist/lib/pagination/pagination.test.js.map +0 -7
  57. package/dist/lib/sidebar.js +0 -81
  58. package/dist/lib/sidebar.js.map +0 -7
@@ -1,81 +0,0 @@
1
- import { camelcase } from "stringcase";
2
- import { forEachOperation } from "./operation";
3
- function createOAIMeta(spec) {
4
- spec.paths ??= {};
5
- const navigationGroups = {
6
- default: { id: "default", title: "General" }
7
- };
8
- const groups = {};
9
- forEachOperation({ spec }, (entry, operation) => {
10
- const tag = entry.tag;
11
- groups[tag] ??= {
12
- id: tag,
13
- title: tag,
14
- description: spec.tags?.find((t) => t.name === tag)?.description,
15
- navigationGroup: "default",
16
- sections: []
17
- };
18
- groups[tag].sections.push({
19
- type: "endpoint",
20
- key: operation.operationId,
21
- path: entry.path
22
- });
23
- });
24
- return {
25
- groups: Object.values(groups),
26
- navigationGroups: Object.values(navigationGroups)
27
- };
28
- }
29
- function getOperationById(spec, operationId) {
30
- let operation;
31
- forEachOperation({ spec }, (entry, op) => {
32
- if (op.operationId === operationId) {
33
- operation = op;
34
- }
35
- });
36
- return operation;
37
- }
38
- function toSidebar(spec) {
39
- const openapi = spec;
40
- const sidebar = [];
41
- const oaiMeta = openapi["x-oaiMeta"] ?? createOAIMeta(spec);
42
- for (const navGroup of oaiMeta.navigationGroups) {
43
- const group = oaiMeta.groups.filter(
44
- (group2) => group2.navigationGroup === navGroup.id
45
- );
46
- if (group.length === 0)
47
- continue;
48
- const groupItems = [];
49
- for (const item of group) {
50
- const subitems = (item.sections ?? []).filter((it) => it.type === "endpoint").map((section) => {
51
- const operation = getOperationById(spec, section.key);
52
- const title = operation?.["x-oaiMeta"]?.name || operation?.summary || section.key;
53
- return {
54
- id: section.key,
55
- title,
56
- url: `${item.id}/${camelcase(section.key)}`
57
- };
58
- });
59
- if (subitems.length === 0)
60
- continue;
61
- groupItems.push({
62
- id: item.id,
63
- title: item.title,
64
- url: `/${item.id}`,
65
- description: item.description,
66
- items: subitems
67
- });
68
- }
69
- if (groupItems.length === 0)
70
- continue;
71
- sidebar.push({
72
- category: navGroup.title,
73
- items: groupItems
74
- });
75
- }
76
- return sidebar;
77
- }
78
- export {
79
- toSidebar
80
- };
81
- //# sourceMappingURL=sidebar.js.map
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["../../src/lib/sidebar.ts"],
4
- "sourcesContent": ["import type { OpenAPIObject, OperationObject } from 'openapi3-ts/oas31';\nimport { camelcase } from 'stringcase';\n\nimport { type TunedOperationObject, forEachOperation } from './operation';\n\nexport type ChildNavItem = {\n id: string;\n title: string;\n url: string;\n};\n\nexport type NavItem = {\n id: string;\n title: string;\n description?: string;\n url: string;\n items?: ChildNavItem[];\n};\n\nexport type CategoryItem = {\n category: string;\n description?: string;\n items: NavItem[];\n};\n\nexport type SidebarData = CategoryItem[];\n\nfunction createOAIMeta(spec: OpenAPIObject): XOaiMeta {\n spec.paths ??= {};\n const navigationGroups: Record<string, NavigationGroup> = {\n default: { id: 'default', title: 'General' },\n };\n const groups: Record<string, Group> = {};\n\n forEachOperation({ spec }, (entry, operation) => {\n const tag = entry.tag;\n groups[tag] ??= {\n id: tag,\n title: tag,\n description: spec.tags?.find((t) => t.name === tag)?.description,\n navigationGroup: 'default',\n sections: [],\n };\n groups[tag].sections.push({\n type: 'endpoint',\n key: operation.operationId,\n path: entry.path,\n });\n });\n\n return {\n groups: Object.values(groups),\n navigationGroups: Object.values(navigationGroups),\n };\n}\n\nfunction getOperationById(spec: OpenAPIObject, operationId: string) {\n let operation: TunedOperationObject | undefined;\n forEachOperation({ spec }, (entry, op) => {\n if (op.operationId === operationId) {\n operation = op;\n }\n });\n return operation;\n}\n\nexport function toSidebar(spec: OpenAPIObject) {\n const openapi: OpenAPIObject & { 'x-oaiMeta': XOaiMeta } = spec as any;\n const sidebar: SidebarData = [];\n const oaiMeta = openapi['x-oaiMeta'] ?? createOAIMeta(spec);\n for (const navGroup of oaiMeta.navigationGroups) {\n const group = oaiMeta.groups.filter(\n (group) => group.navigationGroup === navGroup.id,\n );\n if (group.length === 0) continue;\n const groupItems: NavItem[] = [];\n for (const item of group) {\n const subitems: ChildNavItem[] = (item.sections ?? [])\n .filter((it) => it.type === 'endpoint')\n .map((section) => {\n const operation = getOperationById(spec, section.key);\n const title =\n operation?.['x-oaiMeta']?.name || operation?.summary || section.key;\n return {\n id: section.key,\n title,\n url: `${item.id}/${camelcase(section.key)}`,\n };\n });\n if (subitems.length === 0) continue;\n groupItems.push({\n id: item.id,\n title: item.title,\n url: `/${item.id}`,\n description: item.description,\n items: subitems,\n });\n }\n if (groupItems.length === 0) continue;\n sidebar.push({\n category: navGroup.title,\n items: groupItems,\n });\n }\n return sidebar;\n}\n\nexport interface XOaiMeta {\n navigationGroups: NavigationGroup[];\n groups: Group[];\n}\n\nexport interface Group {\n id: string;\n title: string;\n description?: string;\n navigationGroup: string;\n sections: Section[];\n beta?: boolean;\n legacy?: boolean;\n}\n\nexport interface Section {\n type: 'endpoint' | 'object';\n key: string;\n path: string;\n}\n\nexport interface NavigationGroup {\n id: string;\n title: string;\n beta?: boolean;\n}\n"],
5
- "mappings": "AACA,SAAS,iBAAiB;AAE1B,SAAoC,wBAAwB;AAwB5D,SAAS,cAAc,MAA+B;AACpD,OAAK,UAAU,CAAC;AAChB,QAAM,mBAAoD;AAAA,IACxD,SAAS,EAAE,IAAI,WAAW,OAAO,UAAU;AAAA,EAC7C;AACA,QAAM,SAAgC,CAAC;AAEvC,mBAAiB,EAAE,KAAK,GAAG,CAAC,OAAO,cAAc;AAC/C,UAAM,MAAM,MAAM;AAClB,WAAO,GAAG,MAAM;AAAA,MACd,IAAI;AAAA,MACJ,OAAO;AAAA,MACP,aAAa,KAAK,MAAM,KAAK,CAAC,MAAM,EAAE,SAAS,GAAG,GAAG;AAAA,MACrD,iBAAiB;AAAA,MACjB,UAAU,CAAC;AAAA,IACb;AACA,WAAO,GAAG,EAAE,SAAS,KAAK;AAAA,MACxB,MAAM;AAAA,MACN,KAAK,UAAU;AAAA,MACf,MAAM,MAAM;AAAA,IACd,CAAC;AAAA,EACH,CAAC;AAED,SAAO;AAAA,IACL,QAAQ,OAAO,OAAO,MAAM;AAAA,IAC5B,kBAAkB,OAAO,OAAO,gBAAgB;AAAA,EAClD;AACF;AAEA,SAAS,iBAAiB,MAAqB,aAAqB;AAClE,MAAI;AACJ,mBAAiB,EAAE,KAAK,GAAG,CAAC,OAAO,OAAO;AACxC,QAAI,GAAG,gBAAgB,aAAa;AAClC,kBAAY;AAAA,IACd;AAAA,EACF,CAAC;AACD,SAAO;AACT;AAEO,SAAS,UAAU,MAAqB;AAC7C,QAAM,UAAqD;AAC3D,QAAM,UAAuB,CAAC;AAC9B,QAAM,UAAU,QAAQ,WAAW,KAAK,cAAc,IAAI;AAC1D,aAAW,YAAY,QAAQ,kBAAkB;AAC/C,UAAM,QAAQ,QAAQ,OAAO;AAAA,MAC3B,CAACA,WAAUA,OAAM,oBAAoB,SAAS;AAAA,IAChD;AACA,QAAI,MAAM,WAAW;AAAG;AACxB,UAAM,aAAwB,CAAC;AAC/B,eAAW,QAAQ,OAAO;AACxB,YAAM,YAA4B,KAAK,YAAY,CAAC,GACjD,OAAO,CAAC,OAAO,GAAG,SAAS,UAAU,EACrC,IAAI,CAAC,YAAY;AAChB,cAAM,YAAY,iBAAiB,MAAM,QAAQ,GAAG;AACpD,cAAM,QACJ,YAAY,WAAW,GAAG,QAAQ,WAAW,WAAW,QAAQ;AAClE,eAAO;AAAA,UACL,IAAI,QAAQ;AAAA,UACZ;AAAA,UACA,KAAK,GAAG,KAAK,EAAE,IAAI,UAAU,QAAQ,GAAG,CAAC;AAAA,QAC3C;AAAA,MACF,CAAC;AACH,UAAI,SAAS,WAAW;AAAG;AAC3B,iBAAW,KAAK;AAAA,QACd,IAAI,KAAK;AAAA,QACT,OAAO,KAAK;AAAA,QACZ,KAAK,IAAI,KAAK,EAAE;AAAA,QAChB,aAAa,KAAK;AAAA,QAClB,OAAO;AAAA,MACT,CAAC;AAAA,IACH;AACA,QAAI,WAAW,WAAW;AAAG;AAC7B,YAAQ,KAAK;AAAA,MACX,UAAU,SAAS;AAAA,MACnB,OAAO;AAAA,IACT,CAAC;AAAA,EACH;AACA,SAAO;AACT;",
6
- "names": ["group"]
7
- }