@celljs/openapi 0.0.0-stage → 4.3.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 (115) hide show
  1. package/README.md +87 -2
  2. package/cell.yml +14 -0
  3. package/esm/common/annotation.d.ts +60 -0
  4. package/esm/common/annotation.js +73 -0
  5. package/esm/common/annotation.js.map +1 -0
  6. package/esm/common/constants.d.ts +11 -0
  7. package/esm/common/constants.js +12 -0
  8. package/esm/common/constants.js.map +1 -0
  9. package/esm/common/index.d.ts +3 -0
  10. package/esm/common/index.js +4 -0
  11. package/esm/common/index.js.map +1 -0
  12. package/esm/common/openapi-protocol.d.ts +143 -0
  13. package/esm/common/openapi-protocol.js +2 -0
  14. package/esm/common/openapi-protocol.js.map +1 -0
  15. package/esm/node/index.d.ts +6 -0
  16. package/esm/node/index.js +7 -0
  17. package/esm/node/index.js.map +1 -0
  18. package/esm/node/module.d.ts +3 -0
  19. package/esm/node/module.js +4 -0
  20. package/esm/node/module.js.map +1 -0
  21. package/esm/node/openapi-document-provider.d.ts +39 -0
  22. package/esm/node/openapi-document-provider.js +310 -0
  23. package/esm/node/openapi-document-provider.js.map +1 -0
  24. package/esm/node/openapi-middleware.d.ts +17 -0
  25. package/esm/node/openapi-middleware.js +76 -0
  26. package/esm/node/openapi-middleware.js.map +1 -0
  27. package/esm/node/openapi-node-protocol.d.ts +7 -0
  28. package/esm/node/openapi-node-protocol.js +4 -0
  29. package/esm/node/openapi-node-protocol.js.map +1 -0
  30. package/esm/node/openapi-path-util.d.ts +10 -0
  31. package/esm/node/openapi-path-util.js +84 -0
  32. package/esm/node/openapi-path-util.js.map +1 -0
  33. package/esm/node/schema-builder.d.ts +39 -0
  34. package/esm/node/schema-builder.js +271 -0
  35. package/esm/node/schema-builder.js.map +1 -0
  36. package/esm/node/swagger-ui.d.ts +10 -0
  37. package/esm/node/swagger-ui.js +31 -0
  38. package/esm/node/swagger-ui.js.map +1 -0
  39. package/esm/package.json +3 -0
  40. package/lib/common/annotation.d.ts +61 -0
  41. package/lib/common/annotation.d.ts.map +1 -0
  42. package/lib/common/annotation.js +86 -0
  43. package/lib/common/annotation.js.map +1 -0
  44. package/lib/common/constants.d.ts +12 -0
  45. package/lib/common/constants.d.ts.map +1 -0
  46. package/lib/common/constants.js +15 -0
  47. package/lib/common/constants.js.map +1 -0
  48. package/lib/common/index.d.ts +4 -0
  49. package/lib/common/index.d.ts.map +1 -0
  50. package/lib/common/index.js +20 -0
  51. package/lib/common/index.js.map +1 -0
  52. package/lib/common/openapi-protocol.d.ts +144 -0
  53. package/lib/common/openapi-protocol.d.ts.map +1 -0
  54. package/lib/common/openapi-protocol.js +3 -0
  55. package/lib/common/openapi-protocol.js.map +1 -0
  56. package/lib/node/index.d.ts +7 -0
  57. package/lib/node/index.d.ts.map +1 -0
  58. package/lib/node/index.js +23 -0
  59. package/lib/node/index.js.map +1 -0
  60. package/lib/node/module.d.ts +4 -0
  61. package/lib/node/module.d.ts.map +1 -0
  62. package/lib/node/module.js +6 -0
  63. package/lib/node/module.js.map +1 -0
  64. package/lib/node/openapi-document-provider.d.ts +40 -0
  65. package/lib/node/openapi-document-provider.d.ts.map +1 -0
  66. package/lib/node/openapi-document-provider.js +313 -0
  67. package/lib/node/openapi-document-provider.js.map +1 -0
  68. package/lib/node/openapi-middleware.d.ts +18 -0
  69. package/lib/node/openapi-middleware.d.ts.map +1 -0
  70. package/lib/node/openapi-middleware.js +79 -0
  71. package/lib/node/openapi-middleware.js.map +1 -0
  72. package/lib/node/openapi-node-protocol.d.ts +8 -0
  73. package/lib/node/openapi-node-protocol.d.ts.map +1 -0
  74. package/lib/node/openapi-node-protocol.js +7 -0
  75. package/lib/node/openapi-node-protocol.js.map +1 -0
  76. package/lib/node/openapi-path-util.d.ts +11 -0
  77. package/lib/node/openapi-path-util.d.ts.map +1 -0
  78. package/lib/node/openapi-path-util.js +87 -0
  79. package/lib/node/openapi-path-util.js.map +1 -0
  80. package/lib/node/openapi.spec.d.ts +30 -0
  81. package/lib/node/openapi.spec.d.ts.map +1 -0
  82. package/lib/node/openapi.spec.js +268 -0
  83. package/lib/node/openapi.spec.js.map +1 -0
  84. package/lib/node/schema-builder.d.ts +40 -0
  85. package/lib/node/schema-builder.d.ts.map +1 -0
  86. package/lib/node/schema-builder.js +275 -0
  87. package/lib/node/schema-builder.js.map +1 -0
  88. package/lib/node/schema-builder.spec.d.ts +2 -0
  89. package/lib/node/schema-builder.spec.d.ts.map +1 -0
  90. package/lib/node/schema-builder.spec.js +143 -0
  91. package/lib/node/schema-builder.spec.js.map +1 -0
  92. package/lib/node/swagger-ui.d.ts +11 -0
  93. package/lib/node/swagger-ui.d.ts.map +1 -0
  94. package/lib/node/swagger-ui.js +34 -0
  95. package/lib/node/swagger-ui.js.map +1 -0
  96. package/lib/package.spec.d.ts +2 -0
  97. package/lib/package.spec.d.ts.map +1 -0
  98. package/lib/package.spec.js +7 -0
  99. package/lib/package.spec.js.map +1 -0
  100. package/package.json +77 -4
  101. package/src/common/annotation.ts +130 -0
  102. package/src/common/constants.ts +12 -0
  103. package/src/common/index.ts +3 -0
  104. package/src/common/openapi-protocol.ts +154 -0
  105. package/src/node/index.ts +6 -0
  106. package/src/node/module.ts +4 -0
  107. package/src/node/openapi-document-provider.ts +334 -0
  108. package/src/node/openapi-middleware.ts +59 -0
  109. package/src/node/openapi-node-protocol.ts +11 -0
  110. package/src/node/openapi-path-util.ts +75 -0
  111. package/src/node/openapi.spec.ts +219 -0
  112. package/src/node/schema-builder.spec.ts +124 -0
  113. package/src/node/schema-builder.ts +282 -0
  114. package/src/node/swagger-ui.ts +38 -0
  115. package/src/package.spec.ts +5 -0
@@ -0,0 +1,275 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.SchemaUtil = exports.SchemaBuilder = exports.ClassValidatorUtil = exports.EnumUtil = void 0;
4
+ const common_1 = require("../common");
5
+ const PRIMITIVES = new Map([
6
+ [String, { type: 'string' }],
7
+ [Number, { type: 'number' }],
8
+ [Boolean, { type: 'boolean' }],
9
+ [Date, { type: 'string', format: 'date-time' }],
10
+ [Object, { type: 'object' }],
11
+ [Array, { type: 'array', items: {} }],
12
+ ]);
13
+ /** Types that say nothing about the data: `Promise` of an async method, `any` / interfaces (`Object`) are handled by the caller. */
14
+ const OPAQUE = new Set([Promise, Function, Symbol]);
15
+ /** class-validator constraints (by name) that describe a schema. */
16
+ const CONSTRAINTS = {
17
+ isString: s => setType(s, 'string'),
18
+ isInt: s => setType(s, 'integer'),
19
+ isNumber: s => setType(s, 'number'),
20
+ isBoolean: s => setType(s, 'boolean'),
21
+ isObject: s => setType(s, 'object'),
22
+ isDate: s => setType(s, 'string', 'date-time'),
23
+ isDateString: s => setType(s, 'string', 'date-time'),
24
+ isIso8601: s => setType(s, 'string', 'date-time'),
25
+ isEmail: s => setType(s, 'string', 'email'),
26
+ isUrl: s => setType(s, 'string', 'uri'),
27
+ isUuid: s => setType(s, 'string', 'uuid'),
28
+ isNumberString: s => setType(s, 'string'),
29
+ isBooleanString: s => setType(s, 'string'),
30
+ isArray: s => {
31
+ setType(s, 'array');
32
+ s.items = s.items || {};
33
+ },
34
+ isEnum: (s, c) => setEnum(s, EnumUtil.values(c[0])),
35
+ isIn: (s, c) => setEnum(s, [...c[0]]),
36
+ min: (s, c) => {
37
+ s.minimum = c[0];
38
+ },
39
+ max: (s, c) => {
40
+ s.maximum = c[0];
41
+ },
42
+ isPositive: s => {
43
+ s.minimum = 0;
44
+ s.exclusiveMinimum = true;
45
+ },
46
+ isNegative: s => {
47
+ s.maximum = 0;
48
+ s.exclusiveMaximum = true;
49
+ },
50
+ minLength: (s, c) => {
51
+ s.minLength = c[0];
52
+ },
53
+ maxLength: (s, c) => {
54
+ s.maxLength = c[0];
55
+ },
56
+ isLength: (s, c) => {
57
+ s.minLength = c[0];
58
+ if (c[1] !== undefined) {
59
+ s.maxLength = c[1];
60
+ }
61
+ },
62
+ matches: (s, c) => {
63
+ s.pattern = c[0] instanceof RegExp ? c[0].source : String(c[0]);
64
+ },
65
+ arrayMinSize: (s, c) => {
66
+ s.minItems = c[0];
67
+ },
68
+ arrayMaxSize: (s, c) => {
69
+ s.maxItems = c[0];
70
+ },
71
+ };
72
+ function setType(schema, type, format) {
73
+ delete schema.$ref;
74
+ delete schema.allOf;
75
+ schema.type = type;
76
+ if (format) {
77
+ schema.format = format;
78
+ }
79
+ else {
80
+ delete schema.format;
81
+ }
82
+ if (type !== 'array') {
83
+ delete schema.items;
84
+ }
85
+ }
86
+ /** The type of an enum follows its values: the TypeScript type of an enum property may be missing or `Object`. */
87
+ function setEnum(schema, values) {
88
+ schema.enum = values;
89
+ if (schema.$ref || schema.allOf || (schema.type && schema.type !== 'object') || !values.length) {
90
+ return;
91
+ }
92
+ if (values.every(v => typeof v === 'string')) {
93
+ setType(schema, 'string');
94
+ }
95
+ else if (values.every(v => typeof v === 'number')) {
96
+ setType(schema, values.every(v => Number.isInteger(v)) ? 'integer' : 'number');
97
+ }
98
+ }
99
+ var EnumUtil;
100
+ (function (EnumUtil) {
101
+ /** The values of a list or a TypeScript enum (without the reverse entries of numeric enums). */
102
+ function values(enumOrValues) {
103
+ if (Array.isArray(enumOrValues)) {
104
+ return [...enumOrValues];
105
+ }
106
+ return Object.keys(enumOrValues)
107
+ .filter(key => typeof enumOrValues[enumOrValues[key]] !== 'number')
108
+ .map(key => enumOrValues[key]);
109
+ }
110
+ EnumUtil.values = values;
111
+ })(EnumUtil || (exports.EnumUtil = EnumUtil = {}));
112
+ var ClassValidatorUtil;
113
+ (function (ClassValidatorUtil) {
114
+ function metadatas(target) {
115
+ const storage = globalThis.classValidatorMetadataStorage;
116
+ if (!storage || typeof storage.getTargetValidationMetadatas !== 'function') {
117
+ return [];
118
+ }
119
+ try {
120
+ return storage.getTargetValidationMetadatas(target, '', true, false) || [];
121
+ }
122
+ catch (_a) {
123
+ return [];
124
+ }
125
+ }
126
+ ClassValidatorUtil.metadatas = metadatas;
127
+ })(ClassValidatorUtil || (exports.ClassValidatorUtil = ClassValidatorUtil = {}));
128
+ /**
129
+ * Turns types into schemas; classes become `components.schemas` entries referred to by `$ref`.
130
+ * One instance builds one document.
131
+ */
132
+ class SchemaBuilder {
133
+ constructor() {
134
+ this.schemas = {};
135
+ this.names = new Map();
136
+ }
137
+ /** The schema of a type, or undefined when the type says nothing (`Promise`, `void`). */
138
+ resolve(type) {
139
+ if (type === undefined || type === null) {
140
+ return undefined;
141
+ }
142
+ if (Array.isArray(type)) {
143
+ return { type: 'array', items: this.resolve(type[0]) || {} };
144
+ }
145
+ if (typeof type === 'string') {
146
+ return { type };
147
+ }
148
+ const primitive = PRIMITIVES.get(type);
149
+ if (primitive) {
150
+ return structuredClone(primitive);
151
+ }
152
+ if (OPAQUE.has(type) || typeof type !== 'function') {
153
+ return undefined;
154
+ }
155
+ return { $ref: `#/components/schemas/${this.define(type)}` };
156
+ }
157
+ /** The schema of a class, inline: its properties from @ApiProperty and class-validator decorators. */
158
+ build(target) {
159
+ const properties = {};
160
+ const optional = new Set();
161
+ const required = new Set();
162
+ for (const metadata of ClassValidatorUtil.metadatas(target)) {
163
+ const key = metadata.propertyName;
164
+ properties[key] = properties[key] || this.designType(target, key);
165
+ const schema = properties[key];
166
+ if (metadata.type === 'conditionalValidation') {
167
+ optional.add(key);
168
+ continue;
169
+ }
170
+ const apply = metadata.name && CONSTRAINTS[metadata.name];
171
+ if (!apply) {
172
+ continue;
173
+ }
174
+ if (metadata.each) {
175
+ setType(schema, 'array');
176
+ schema.items = schema.items || {};
177
+ apply(schema.items, metadata.constraints || []);
178
+ }
179
+ else {
180
+ apply(schema, metadata.constraints || []);
181
+ }
182
+ }
183
+ for (const { key, options } of this.apiProperties(target)) {
184
+ properties[key] = this.fromOptions(options, properties[key] || this.designType(target, key));
185
+ if (options.required === false) {
186
+ optional.add(key);
187
+ }
188
+ else if (options.required === true) {
189
+ required.add(key);
190
+ }
191
+ }
192
+ const schema = { type: 'object', properties: {} };
193
+ const requiredList = [];
194
+ for (const [key, property] of Object.entries(properties)) {
195
+ schema.properties[key] = SchemaUtil.normalize(property);
196
+ if (required.has(key) || !optional.has(key)) {
197
+ requiredList.push(key);
198
+ }
199
+ }
200
+ if (requiredList.length) {
201
+ schema.required = requiredList;
202
+ }
203
+ return schema;
204
+ }
205
+ /** Applies @ApiProperty-like options to the schema found from the TypeScript type. */
206
+ fromOptions(options, found = {}) {
207
+ const { type, required, enum: values, items, ...rest } = options;
208
+ let schema = { ...found };
209
+ if (type !== undefined) {
210
+ const resolved = this.resolve(type) || {};
211
+ if (resolved.$ref || resolved.type !== found.type) {
212
+ schema = {};
213
+ for (const key of ['description', 'example', 'enum', 'nullable']) {
214
+ if (found[key] !== undefined) {
215
+ schema[key] = found[key];
216
+ }
217
+ }
218
+ }
219
+ Object.assign(schema, resolved);
220
+ }
221
+ if (values !== undefined) {
222
+ setEnum(schema, EnumUtil.values(values));
223
+ }
224
+ if (items !== undefined) {
225
+ schema.items = items;
226
+ }
227
+ return Object.assign(schema, rest);
228
+ }
229
+ designType(target, key) {
230
+ return this.resolve(Reflect.getMetadata('design:type', target.prototype, key)) || {};
231
+ }
232
+ /** @ApiProperty metadata of the class and its parents, parents first; a subclass entry replaces the parent's. */
233
+ apiProperties(target) {
234
+ const chain = [];
235
+ for (let current = target; current && current !== Function.prototype; current = Object.getPrototypeOf(current)) {
236
+ chain.unshift(current);
237
+ }
238
+ const merged = new Map();
239
+ for (const current of chain) {
240
+ for (const metadata of (Reflect.getOwnMetadata(common_1.OPENAPI_METADATA_KEY.properties, current) || [])) {
241
+ merged.set(metadata.key, metadata);
242
+ }
243
+ }
244
+ return [...merged.values()];
245
+ }
246
+ define(target) {
247
+ const existing = this.names.get(target);
248
+ if (existing) {
249
+ return existing;
250
+ }
251
+ const base = target.name || 'Anonymous';
252
+ let name = base;
253
+ for (let i = 2; this.schemas[name]; i++) {
254
+ name = `${base}${i}`;
255
+ }
256
+ this.names.set(target, name);
257
+ this.schemas[name] = {};
258
+ this.schemas[name] = this.build(target);
259
+ return name;
260
+ }
261
+ }
262
+ exports.SchemaBuilder = SchemaBuilder;
263
+ var SchemaUtil;
264
+ (function (SchemaUtil) {
265
+ /** OpenAPI 3.0 ignores the siblings of `$ref`: keep them by wrapping the reference in `allOf`. */
266
+ function normalize(schema) {
267
+ if (schema.$ref && Object.keys(schema).length > 1) {
268
+ const { $ref, ...rest } = schema;
269
+ return { allOf: [{ $ref }], ...rest };
270
+ }
271
+ return schema;
272
+ }
273
+ SchemaUtil.normalize = normalize;
274
+ })(SchemaUtil || (exports.SchemaUtil = SchemaUtil = {}));
275
+ //# sourceMappingURL=schema-builder.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"schema-builder.js","sourceRoot":"","sources":["../../src/node/schema-builder.ts"],"names":[],"mappings":";;;AAAA,sCAAuJ;AAEvJ,MAAM,UAAU,GAAG,IAAI,GAAG,CAAwB;IAC9C,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;IAC5B,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;IAC5B,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;IAC9B,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC;IAC/C,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;IAC5B,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;CACxC,CAAC,CAAC;AAEH,oIAAoI;AACpI,MAAM,MAAM,GAAG,IAAI,GAAG,CAAU,CAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;AAE7D,oEAAoE;AACpE,MAAM,WAAW,GAAuE;IACpF,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,QAAQ,CAAC;IACnC,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,SAAS,CAAC;IACjC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,QAAQ,CAAC;IACnC,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,SAAS,CAAC;IACrC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,QAAQ,CAAC;IACnC,MAAM,EAAE,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,QAAQ,EAAE,WAAW,CAAC;IAC9C,YAAY,EAAE,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,QAAQ,EAAE,WAAW,CAAC;IACpD,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,QAAQ,EAAE,WAAW,CAAC;IACjD,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC;IAC3C,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC;IACvC,MAAM,EAAE,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC;IACzC,cAAc,EAAE,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,QAAQ,CAAC;IACzC,eAAe,EAAE,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,QAAQ,CAAC;IAC1C,OAAO,EAAE,CAAC,CAAC,EAAE;QACT,OAAO,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;QACpB,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;IAC5B,CAAC;IACD,MAAM,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACnD,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACrC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QACV,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACrB,CAAC;IACD,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QACV,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACrB,CAAC;IACD,UAAU,EAAE,CAAC,CAAC,EAAE;QACZ,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC;QACd,CAAC,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAC9B,CAAC;IACD,UAAU,EAAE,CAAC,CAAC,EAAE;QACZ,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC;QACd,CAAC,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAC9B,CAAC;IACD,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QAChB,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACvB,CAAC;IACD,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QAChB,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACvB,CAAC;IACD,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QACf,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACnB,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;YACrB,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACvB,CAAC;IACL,CAAC;IACD,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QACd,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACpE,CAAC;IACD,YAAY,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QACnB,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACtB,CAAC;IACD,YAAY,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QACnB,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACtB,CAAC;CACJ,CAAC;AAEF,SAAS,OAAO,CAAC,MAAoB,EAAE,IAA0B,EAAE,MAAe;IAC9E,OAAO,MAAM,CAAC,IAAI,CAAC;IACnB,OAAO,MAAM,CAAC,KAAK,CAAC;IACpB,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,IAAI,MAAM,EAAE,CAAC;QACT,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC;IAC3B,CAAC;SAAM,CAAC;QACJ,OAAO,MAAM,CAAC,MAAM,CAAC;IACzB,CAAC;IACD,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;QACnB,OAAO,MAAM,CAAC,KAAK,CAAC;IACxB,CAAC;AACL,CAAC;AAED,kHAAkH;AAClH,SAAS,OAAO,CAAC,MAAoB,EAAE,MAAa;IAChD,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC;IACrB,IAAI,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QAC7F,OAAO;IACX,CAAC;IACD,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,EAAE,CAAC;QAC3C,OAAO,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC9B,CAAC;SAAM,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,EAAE,CAAC;QAClD,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;IACnF,CAAC;AACL,CAAC;AAED,IAAiB,QAAQ,CAUxB;AAVD,WAAiB,QAAQ;IACrB,gGAAgG;IAChG,SAAgB,MAAM,CAAC,YAAyC;QAC5D,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;YAC9B,OAAO,CAAC,GAAG,YAAY,CAAC,CAAC;QAC7B,CAAC;QACD,OAAO,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC;aAC3B,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,OAAO,YAAY,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,KAAK,QAAQ,CAAC;aAClE,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC;IACvC,CAAC;IAPe,SAAA,MAAM,SAOrB,CAAA;AACL,CAAC,EAVgB,QAAQ,aAAR,QAAQ,GAAR,QAAQ,QAUxB;AAWD,IAAiB,kBAAkB,CAYlC;AAZD,WAAiB,kBAAkB;IAC/B,SAAgB,SAAS,CAAC,MAAmB;QACzC,MAAM,OAAO,GAAI,UAAkB,CAAC,6BAA6B,CAAC;QAClE,IAAI,CAAC,OAAO,IAAI,OAAO,OAAO,CAAC,4BAA4B,KAAK,UAAU,EAAE,CAAC;YACzE,OAAO,EAAE,CAAC;QACd,CAAC;QACD,IAAI,CAAC;YACD,OAAO,OAAO,CAAC,4BAA4B,CAAC,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;QAC/E,CAAC;mBAAO,CAAC;YACL,OAAO,EAAE,CAAC;QACd,CAAC;IACL,CAAC;IAVe,mBAAA,SAAS,YAUxB,CAAA;AACL,CAAC,EAZgB,kBAAkB,aAAlB,kBAAkB,GAAlB,kBAAkB,QAYlC;AAED;;;GAGG;AACH;IAAA;QACa,YAAO,GAAiC,EAAE,CAAC;QAEjC,UAAK,GAAG,IAAI,GAAG,EAAuB,CAAC;IAiI9D,CAAC;IA/HG,yFAAyF;IACzF,OAAO,CAAC,IAAyB;QAC7B,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YACtC,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACtB,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAY,CAAC,IAAI,EAAE,EAAE,CAAC;QAC5E,CAAC;QACD,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC3B,OAAO,EAAE,IAAI,EAAE,CAAC;QACpB,CAAC;QACD,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,SAAS,EAAE,CAAC;YACZ,OAAO,eAAe,CAAC,SAAS,CAAC,CAAC;QACtC,CAAC;QACD,IAAI,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,OAAO,IAAI,KAAK,UAAU,EAAE,CAAC;YACjD,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,wBAAwB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;IACjE,CAAC;IAED,sGAAsG;IACtG,KAAK,CAAC,MAAmB;QACrB,MAAM,UAAU,GAAiC,EAAE,CAAC;QACpD,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;QACnC,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;QACnC,KAAK,MAAM,QAAQ,IAAI,kBAAkB,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1D,MAAM,GAAG,GAAG,QAAQ,CAAC,YAAY,CAAC;YAClC,UAAU,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;YAClE,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;YAC/B,IAAI,QAAQ,CAAC,IAAI,KAAK,uBAAuB,EAAE,CAAC;gBAC5C,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBAClB,SAAS;YACb,CAAC;YACD,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC1D,IAAI,CAAC,KAAK,EAAE,CAAC;gBACT,SAAS;YACb,CAAC;YACD,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC;gBAChB,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;gBACzB,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,IAAI,EAAE,CAAC;gBAClC,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC;YACpD,CAAC;iBAAM,CAAC;gBACJ,KAAK,CAAC,MAAM,EAAE,QAAQ,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC;YAC9C,CAAC;QACL,CAAC;QACD,KAAK,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;YACxD,UAAU,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;YAC7F,IAAI,OAAO,CAAC,QAAQ,KAAK,KAAK,EAAE,CAAC;gBAC7B,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACtB,CAAC;iBAAM,IAAI,OAAO,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;gBACnC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACtB,CAAC;QACL,CAAC;QACD,MAAM,MAAM,GAAiB,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;QAChE,MAAM,YAAY,GAAa,EAAE,CAAC;QAClC,KAAK,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;YACtD,MAAM,CAAC,UAA2C,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;YAC1F,IAAI,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC1C,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC3B,CAAC;QACL,CAAC;QACD,IAAI,YAAY,CAAC,MAAM,EAAE,CAAC;YACtB,MAAM,CAAC,QAAQ,GAAG,YAAY,CAAC;QACnC,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,sFAAsF;IACtF,WAAW,CAAC,OAA2B,EAAE,KAAK,GAAiB,EAAE;QAC7D,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;QACjE,IAAI,MAAM,GAAiB,EAAE,GAAG,KAAK,EAAE,CAAC;QACxC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACrB,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YAC1C,IAAI,QAAQ,CAAC,IAAI,IAAI,QAAQ,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,EAAE,CAAC;gBAChD,MAAM,GAAG,EAAE,CAAC;gBACZ,KAAK,MAAM,GAAG,IAAI,CAAC,aAAa,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,CAAC;oBAC/D,IAAI,KAAK,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE,CAAC;wBAC3B,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;oBAC7B,CAAC;gBACL,CAAC;YACL,CAAC;YACD,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QACpC,CAAC;QACD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACvB,OAAO,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;QAC7C,CAAC;QACD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACtB,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,CAAC;QACD,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACvC,CAAC;IAES,UAAU,CAAC,MAAmB,EAAE,GAAW;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,aAAa,EAAE,MAAM,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;IACzF,CAAC;IAED,iHAAiH;IACvG,aAAa,CAAC,MAAmB;QACvC,MAAM,KAAK,GAAkB,EAAE,CAAC;QAChC,KAAK,IAAI,OAAO,GAAG,MAAM,EAAE,OAAO,IAAI,OAAO,KAAK,QAAQ,CAAC,SAAS,EAAE,OAAO,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC;YAC7G,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAC3B,CAAC;QACD,MAAM,MAAM,GAAG,IAAI,GAAG,EAA+B,CAAC;QACtD,KAAK,MAAM,OAAO,IAAI,KAAK,EAAE,CAAC;YAC1B,KAAK,MAAM,QAAQ,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,6BAAoB,CAAC,UAAU,EAAE,OAAO,CAAC,IAAI,EAAE,CAA0B,EAAE,CAAC;gBACvH,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;YACvC,CAAC;QACL,CAAC;QACD,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IAChC,CAAC;IAES,MAAM,CAAC,MAAmB;QAChC,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACxC,IAAI,QAAQ,EAAE,CAAC;YACX,OAAO,QAAQ,CAAC;QACpB,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,IAAI,WAAW,CAAC;QACxC,IAAI,IAAI,GAAG,IAAI,CAAC;QAChB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YACtC,IAAI,GAAG,GAAG,IAAI,GAAG,CAAC,EAAE,CAAC;QACzB,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAC7B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;QACxB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;;AAED,IAAiB,UAAU,CAS1B;AATD,WAAiB,UAAU;IACvB,kGAAkG;IAClG,SAAgB,SAAS,CAAC,MAAoB;QAC1C,IAAI,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChD,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;YACjC,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC;QAC1C,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IANe,WAAA,SAAS,YAMxB,CAAA;AACL,CAAC,EATgB,UAAU,aAAV,UAAU,GAAV,UAAU,QAS1B"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=schema-builder.spec.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"schema-builder.spec.d.ts","sourceRoot":"","sources":["../../src/node/schema-builder.spec.ts"],"names":[],"mappings":""}
@@ -0,0 +1,143 @@
1
+ "use strict";
2
+ var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
3
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
4
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
5
+ else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
6
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
7
+ };
8
+ var __metadata = (this && this.__metadata) || function (k, v) {
9
+ if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
10
+ };
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ const bun_test_1 = require("bun:test");
13
+ const class_validator_1 = require("class-validator");
14
+ const common_1 = require("../common");
15
+ const openapi_path_util_1 = require("./openapi-path-util");
16
+ const schema_builder_1 = require("./schema-builder");
17
+ const swagger_ui_1 = require("./swagger-ui");
18
+ var Role;
19
+ (function (Role) {
20
+ Role["Admin"] = "admin";
21
+ Role["Member"] = "member";
22
+ })(Role || (Role = {}));
23
+ var Level;
24
+ (function (Level) {
25
+ Level[Level["Low"] = 0] = "Low";
26
+ Level[Level["High"] = 1] = "High";
27
+ })(Level || (Level = {}));
28
+ class Address {
29
+ }
30
+ __decorate([
31
+ (0, class_validator_1.IsString)(),
32
+ __metadata("design:type", String)
33
+ ], Address.prototype, "city", void 0);
34
+ class CreateUser {
35
+ }
36
+ __decorate([
37
+ (0, class_validator_1.IsString)(),
38
+ (0, class_validator_1.Length)(2, 20),
39
+ __metadata("design:type", String)
40
+ ], CreateUser.prototype, "name", void 0);
41
+ __decorate([
42
+ (0, class_validator_1.IsInt)(),
43
+ (0, class_validator_1.Min)(0),
44
+ (0, class_validator_1.Max)(150),
45
+ (0, class_validator_1.IsOptional)(),
46
+ __metadata("design:type", Number)
47
+ ], CreateUser.prototype, "age", void 0);
48
+ __decorate([
49
+ (0, class_validator_1.IsEmail)(),
50
+ __metadata("design:type", String)
51
+ ], CreateUser.prototype, "email", void 0);
52
+ __decorate([
53
+ (0, class_validator_1.IsEnum)(Role),
54
+ __metadata("design:type", String)
55
+ ], CreateUser.prototype, "role", void 0);
56
+ __decorate([
57
+ (0, class_validator_1.ValidateNested)(),
58
+ __metadata("design:type", Address)
59
+ ], CreateUser.prototype, "address", void 0);
60
+ __decorate([
61
+ (0, common_1.ApiProperty)({ type: [String], description: 'Labels' }),
62
+ __metadata("design:type", Array)
63
+ ], CreateUser.prototype, "tags", void 0);
64
+ __decorate([
65
+ (0, common_1.ApiPropertyOptional)({ example: 'hi' }),
66
+ __metadata("design:type", String)
67
+ ], CreateUser.prototype, "note", void 0);
68
+ class Node {
69
+ }
70
+ __decorate([
71
+ (0, common_1.ApiProperty)(),
72
+ __metadata("design:type", String)
73
+ ], Node.prototype, "name", void 0);
74
+ __decorate([
75
+ (0, common_1.ApiProperty)({ type: [Node] }),
76
+ __metadata("design:type", Array)
77
+ ], Node.prototype, "children", void 0);
78
+ (0, bun_test_1.describe)('OpenApiPathUtil', () => {
79
+ (0, bun_test_1.it)('expands optional parts', () => {
80
+ (0, bun_test_1.expect)(openapi_path_util_1.OpenApiPathUtil.expand('/users(/:id)')).toEqual(['/users', '/users/:id']);
81
+ (0, bun_test_1.expect)(openapi_path_util_1.OpenApiPathUtil.expand('/a(/:b(/:c))')).toEqual(['/a', '/a/:b', '/a/:b/:c']);
82
+ (0, bun_test_1.expect)(openapi_path_util_1.OpenApiPathUtil.expand('/plain')).toEqual(['/plain']);
83
+ });
84
+ (0, bun_test_1.it)('converts parameters and wildcards', () => {
85
+ (0, bun_test_1.expect)(openapi_path_util_1.OpenApiPathUtil.convert('/users/:id/posts/:postId')).toEqual({ path: '/users/{id}/posts/{postId}', names: ['id', 'postId'] });
86
+ (0, bun_test_1.expect)(openapi_path_util_1.OpenApiPathUtil.convert('/files/*')).toEqual({ path: '/files/{_}', names: ['_'] });
87
+ (0, bun_test_1.expect)(openapi_path_util_1.OpenApiPathUtil.convert('/a\\*b')).toEqual({ path: '/a*b', names: [] });
88
+ });
89
+ });
90
+ (0, bun_test_1.describe)('SchemaBuilder', () => {
91
+ (0, bun_test_1.it)('reads class-validator and @ApiProperty metadata', () => {
92
+ const builder = new schema_builder_1.SchemaBuilder();
93
+ (0, bun_test_1.expect)(builder.resolve(CreateUser)).toEqual({ $ref: '#/components/schemas/CreateUser' });
94
+ (0, bun_test_1.expect)(builder.schemas.CreateUser).toEqual({
95
+ type: 'object',
96
+ properties: {
97
+ name: { type: 'string', minLength: 2, maxLength: 20 },
98
+ age: { type: 'integer', minimum: 0, maximum: 150 },
99
+ email: { type: 'string', format: 'email' },
100
+ role: { type: 'string', enum: ['admin', 'member'] },
101
+ address: { $ref: '#/components/schemas/Address' },
102
+ tags: { type: 'array', items: { type: 'string' }, description: 'Labels' },
103
+ note: { type: 'string', example: 'hi' },
104
+ },
105
+ required: ['name', 'email', 'role', 'address', 'tags'],
106
+ });
107
+ (0, bun_test_1.expect)(builder.schemas.Address).toEqual({ type: 'object', properties: { city: { type: 'string' } }, required: ['city'] });
108
+ });
109
+ (0, bun_test_1.it)('handles recursive classes and primitives', () => {
110
+ var _a;
111
+ const builder = new schema_builder_1.SchemaBuilder();
112
+ builder.resolve(Node);
113
+ (0, bun_test_1.expect)((_a = builder.schemas.Node.properties) === null || _a === void 0 ? void 0 : _a.children).toEqual({ type: 'array', items: { $ref: '#/components/schemas/Node' } });
114
+ (0, bun_test_1.expect)(builder.resolve(Date)).toEqual({ type: 'string', format: 'date-time' });
115
+ (0, bun_test_1.expect)(builder.resolve(Promise)).toBeUndefined();
116
+ (0, bun_test_1.expect)(builder.resolve('integer')).toEqual({ type: 'integer' });
117
+ (0, bun_test_1.expect)(builder.fromOptions({ enum: Level }, { type: 'object' })).toEqual({ type: 'integer', enum: [0, 1] });
118
+ });
119
+ (0, bun_test_1.it)('gives classes with the same name different schema names', () => {
120
+ const builder = new schema_builder_1.SchemaBuilder();
121
+ const A = class Item {
122
+ };
123
+ const B = class Item {
124
+ };
125
+ (0, bun_test_1.expect)(builder.resolve(A)).toEqual({ $ref: '#/components/schemas/Item' });
126
+ (0, bun_test_1.expect)(builder.resolve(B)).toEqual({ $ref: '#/components/schemas/Item2' });
127
+ });
128
+ });
129
+ (0, bun_test_1.describe)('EnumUtil', () => {
130
+ (0, bun_test_1.it)('drops the reverse entries of numeric enums', () => {
131
+ (0, bun_test_1.expect)(schema_builder_1.EnumUtil.values(Level)).toEqual([0, 1]);
132
+ (0, bun_test_1.expect)(schema_builder_1.EnumUtil.values(Role)).toEqual(['admin', 'member']);
133
+ });
134
+ });
135
+ (0, bun_test_1.describe)('SwaggerUiUtil', () => {
136
+ (0, bun_test_1.it)('escapes what it puts in the page', () => {
137
+ const html = swagger_ui_1.SwaggerUiUtil.render({ title: '<x>', url: '/a</script>', cdn: 'https://cdn.example/ui/' });
138
+ (0, bun_test_1.expect)(html).toContain('<title>&#60;x&#62;</title>');
139
+ (0, bun_test_1.expect)(html).toContain('"/a\\u003c/script>"');
140
+ (0, bun_test_1.expect)(html).toContain('href="https://cdn.example/ui/swagger-ui.css"');
141
+ });
142
+ });
143
+ //# sourceMappingURL=schema-builder.spec.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"schema-builder.spec.js","sourceRoot":"","sources":["../../src/node/schema-builder.spec.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,uCAAgD;AAChD,qDAAiH;AACjH,sCAA6D;AAC7D,2DAAsD;AACtD,qDAA2D;AAC3D,6CAA6C;AAE7C,IAAK,IAGJ;AAHD,WAAK,IAAI;IACL,uBAAe,CAAA;IACf,yBAAiB,CAAA;AACrB,CAAC,EAHI,IAAI,KAAJ,IAAI,QAGR;AACD,IAAK,KAGJ;AAHD,WAAK,KAAK;IACN,+BAAG,CAAA;IACH,iCAAI,CAAA;AACR,CAAC,EAHI,KAAK,KAAL,KAAK,QAGT;AAED,MAAM,OAAO;CAGZ;AADG;IADC,IAAA,0BAAQ,GAAE;;qCACE;AAGjB,MAAM,UAAU;CAyBf;AAtBG;IAFC,IAAA,0BAAQ,GAAE;IACV,IAAA,wBAAM,EAAC,CAAC,EAAE,EAAE,CAAC;;wCACD;AAMb;IAJC,IAAA,uBAAK,GAAE;IACP,IAAA,qBAAG,EAAC,CAAC,CAAC;IACN,IAAA,qBAAG,EAAC,GAAG,CAAC;IACR,IAAA,4BAAU,GAAE;;uCACA;AAGb;IADC,IAAA,yBAAO,GAAE;;yCACI;AAGd;IADC,IAAA,wBAAM,EAAC,IAAI,CAAC;;wCACF;AAGX;IADC,IAAA,gCAAc,GAAE;8BACR,OAAO;2CAAC;AAGjB;IADC,IAAA,oBAAW,EAAC,EAAE,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC;;wCACxC;AAGf;IADC,IAAA,4BAAmB,EAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;;wCACzB;AAGlB,MAAM,IAAI;CAMT;AAJG;IADC,IAAA,oBAAW,GAAE;;kCACD;AAGb;IADC,IAAA,oBAAW,EAAC,EAAE,IAAI,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;;sCACb;AAGrB,IAAA,mBAAQ,EAAC,iBAAiB,EAAE,GAAG,EAAE;IAC7B,IAAA,aAAE,EAAC,wBAAwB,EAAE,GAAG,EAAE;QAC9B,IAAA,iBAAM,EAAC,mCAAe,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC;QACjF,IAAA,iBAAM,EAAC,mCAAe,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC;QACpF,IAAA,iBAAM,EAAC,mCAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;IAEH,IAAA,aAAE,EAAC,mCAAmC,EAAE,GAAG,EAAE;QACzC,IAAA,iBAAM,EAAC,mCAAe,CAAC,OAAO,CAAC,0BAA0B,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,4BAA4B,EAAE,KAAK,EAAE,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;QACrI,IAAA,iBAAM,EAAC,mCAAe,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC1F,IAAA,iBAAM,EAAC,mCAAe,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;IACnF,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,IAAA,mBAAQ,EAAC,eAAe,EAAE,GAAG,EAAE;IAC3B,IAAA,aAAE,EAAC,iDAAiD,EAAE,GAAG,EAAE;QACvD,MAAM,OAAO,GAAG,IAAI,8BAAa,EAAE,CAAC;QACpC,IAAA,iBAAM,EAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,iCAAiC,EAAE,CAAC,CAAC;QACzF,IAAA,iBAAM,EAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC;YACvC,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACR,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE;gBACrD,GAAG,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE;gBAClD,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE;gBAC1C,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE;gBACnD,OAAO,EAAE,EAAE,IAAI,EAAE,8BAA8B,EAAE;gBACjD,IAAI,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,WAAW,EAAE,QAAQ,EAAE;gBACzE,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE;aAC1C;YACD,QAAQ,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,CAAC;SACzD,CAAC,CAAC;QACH,IAAA,iBAAM,EAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAC9H,CAAC,CAAC,CAAC;IAEH,IAAA,aAAE,EAAC,0CAA0C,EAAE,GAAG,EAAE;;QAChD,MAAM,OAAO,GAAG,IAAI,8BAAa,EAAE,CAAC;QACpC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACtB,IAAA,iBAAM,EAAC,MAAA,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,0CAAE,QAAQ,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,2BAA2B,EAAE,EAAE,CAAC,CAAC;QAC3H,IAAA,iBAAM,EAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC;QAC/E,IAAA,iBAAM,EAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;QACjD,IAAA,iBAAM,EAAC,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;QAChE,IAAA,iBAAM,EAAC,OAAO,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;IAChH,CAAC,CAAC,CAAC;IAEH,IAAA,aAAE,EAAC,yDAAyD,EAAE,GAAG,EAAE;QAC/D,MAAM,OAAO,GAAG,IAAI,8BAAa,EAAE,CAAC;QACpC,MAAM,CAAC,GAAG,MAAM,IAAI;SAAG,CAAC;QACxB,MAAM,CAAC,GAAG,MAAM,IAAI;SAAG,CAAC;QACxB,IAAA,iBAAM,EAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,2BAA2B,EAAE,CAAC,CAAC;QAC1E,IAAA,iBAAM,EAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,4BAA4B,EAAE,CAAC,CAAC;IAC/E,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,IAAA,mBAAQ,EAAC,UAAU,EAAE,GAAG,EAAE;IACtB,IAAA,aAAE,EAAC,4CAA4C,EAAE,GAAG,EAAE;QAClD,IAAA,iBAAM,EAAC,yBAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAC/C,IAAA,iBAAM,EAAC,yBAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,IAAA,mBAAQ,EAAC,eAAe,EAAE,GAAG,EAAE;IAC3B,IAAA,aAAE,EAAC,kCAAkC,EAAE,GAAG,EAAE;QACxC,MAAM,IAAI,GAAG,0BAAa,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,aAAa,EAAE,GAAG,EAAE,yBAAyB,EAAE,CAAC,CAAC;QACxG,IAAA,iBAAM,EAAC,IAAI,CAAC,CAAC,SAAS,CAAC,4BAA4B,CAAC,CAAC;QACrD,IAAA,iBAAM,EAAC,IAAI,CAAC,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC;QAC9C,IAAA,iBAAM,EAAC,IAAI,CAAC,CAAC,SAAS,CAAC,8CAA8C,CAAC,CAAC;IAC3E,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}
@@ -0,0 +1,11 @@
1
+ export interface SwaggerUiPageOptions {
2
+ title: string;
3
+ /** URL of the OpenAPI document. */
4
+ url: string;
5
+ /** Base URL of swagger-ui-dist. */
6
+ cdn: string;
7
+ }
8
+ export declare namespace SwaggerUiUtil {
9
+ function render({ title, url, cdn }: SwaggerUiPageOptions): string;
10
+ }
11
+ //# sourceMappingURL=swagger-ui.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"swagger-ui.d.ts","sourceRoot":"","sources":["../../src/node/swagger-ui.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,oBAAoB;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,mCAAmC;IACnC,GAAG,EAAE,MAAM,CAAC;IACZ,mCAAmC;IACnC,GAAG,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,aAAa,CAAC;IAC3B,SAAgB,MAAM,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,oBAAoB,GAAG,MAAM,CAmBxE;CASJ"}
@@ -0,0 +1,34 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.SwaggerUiUtil = void 0;
4
+ var SwaggerUiUtil;
5
+ (function (SwaggerUiUtil) {
6
+ function render({ title, url, cdn }) {
7
+ const base = cdn.replace(/\/+$/, '');
8
+ return `<!doctype html>
9
+ <html lang="en">
10
+ <head>
11
+ <meta charset="utf-8">
12
+ <meta name="viewport" content="width=device-width, initial-scale=1">
13
+ <title>${escapeHtml(title)}</title>
14
+ <link rel="stylesheet" href="${escapeHtml(base)}/swagger-ui.css">
15
+ </head>
16
+ <body>
17
+ <div id="swagger-ui"></div>
18
+ <script src="${escapeHtml(base)}/swagger-ui-bundle.js" crossorigin></script>
19
+ <script>
20
+ window.ui = SwaggerUIBundle({ url: ${scriptValue(url)}, dom_id: '#swagger-ui', deepLinking: true });
21
+ </script>
22
+ </body>
23
+ </html>
24
+ `;
25
+ }
26
+ SwaggerUiUtil.render = render;
27
+ function escapeHtml(text) {
28
+ return text.replace(/[&<>"']/g, c => `&#${c.charCodeAt(0)};`);
29
+ }
30
+ function scriptValue(value) {
31
+ return JSON.stringify(value).replace(/</g, '\\u003c');
32
+ }
33
+ })(SwaggerUiUtil || (exports.SwaggerUiUtil = SwaggerUiUtil = {}));
34
+ //# sourceMappingURL=swagger-ui.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"swagger-ui.js","sourceRoot":"","sources":["../../src/node/swagger-ui.ts"],"names":[],"mappings":";;;AAQA,IAAiB,aAAa,CA6B7B;AA7BD,WAAiB,aAAa;IAC1B,SAAgB,MAAM,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAwB;QAC5D,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACrC,OAAO;;;;;SAKN,UAAU,CAAC,KAAK,CAAC;+BACK,UAAU,CAAC,IAAI,CAAC;;;;eAIhC,UAAU,CAAC,IAAI,CAAC;;qCAEM,WAAW,CAAC,GAAG,CAAC;;;;CAIpD,CAAC;IACE,CAAC;IAnBe,cAAA,MAAM,SAmBrB,CAAA;IAED,SAAS,UAAU,CAAC,IAAY;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IAClE,CAAC;IAED,SAAS,WAAW,CAAC,KAAa;QAC9B,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IAC1D,CAAC;AACL,CAAC,EA7BgB,aAAa,aAAb,aAAa,GAAb,aAAa,QA6B7B"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=package.spec.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"package.spec.d.ts","sourceRoot":"","sources":["../src/package.spec.ts"],"names":[],"mappings":""}
@@ -0,0 +1,7 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const bun_test_1 = require("bun:test");
4
+ (0, bun_test_1.describe)('openapi package', () => {
5
+ (0, bun_test_1.it)('support code coverage statistics', () => { });
6
+ });
7
+ //# sourceMappingURL=package.spec.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"package.spec.js","sourceRoot":"","sources":["../src/package.spec.ts"],"names":[],"mappings":";;AAAA,uCAAwC;AAExC,IAAA,mBAAQ,EAAC,iBAAiB,EAAE,GAAG,EAAE;IAC7B,IAAA,aAAE,EAAC,kCAAkC,EAAE,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;AACrD,CAAC,CAAC,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,79 @@
1
1
  {
2
2
  "name": "@celljs/openapi",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
6
- }
3
+ "version": "4.3.0",
4
+ "description": "Generates the OpenAPI document of Cell controllers and serves it with Swagger UI",
5
+ "keywords": [
6
+ "cell-component",
7
+ "openapi",
8
+ "swagger"
9
+ ],
10
+ "homepage": "https://github.com/cellbang/cell",
11
+ "bugs": {
12
+ "url": "https://github.com/cellbang/cell/issues"
13
+ },
14
+ "repository": {
15
+ "type": "git",
16
+ "url": "https://github.com/cellbang/cell.git"
17
+ },
18
+ "license": "MIT",
19
+ "engines": {
20
+ "node": ">=18.0.0"
21
+ },
22
+ "main": "lib/common/index.js",
23
+ "typings": "lib/common/index.d.ts",
24
+ "files": [
25
+ "lib",
26
+ "esm",
27
+ "src",
28
+ "cell.yml"
29
+ ],
30
+ "scripts": {
31
+ "build": "tsc -b && bun ../../scripts/build-esm.ts",
32
+ "clean": "rm -rf lib esm *.tsbuildinfo",
33
+ "test": "bun test --preload reflect-metadata ./lib",
34
+ "watch": "tsc -b -w --preserveWatchOutput"
35
+ },
36
+ "dependencies": {
37
+ "@celljs/core": "4.3.0",
38
+ "@celljs/http": "4.3.0",
39
+ "@celljs/mvc": "4.3.0",
40
+ "@celljs/web": "4.3.0"
41
+ },
42
+ "devDependencies": {
43
+ "class-validator": "^0.14.4"
44
+ },
45
+ "publishConfig": {
46
+ "access": "public"
47
+ },
48
+ "exports": {
49
+ ".": {
50
+ "import": "./esm/common/index.js",
51
+ "default": "./lib/common/index.js"
52
+ },
53
+ "./package.json": "./package.json",
54
+ "./lib/common": {
55
+ "import": "./esm/common/index.js",
56
+ "default": "./lib/common/index.js"
57
+ },
58
+ "./lib/node": {
59
+ "import": "./esm/node/index.js",
60
+ "default": "./lib/node/index.js"
61
+ },
62
+ "./lib/*.js": {
63
+ "import": "./esm/*.js",
64
+ "default": "./lib/*.js"
65
+ },
66
+ "./lib/*": {
67
+ "import": "./esm/*.js",
68
+ "default": "./lib/*.js"
69
+ },
70
+ "./*": "./*"
71
+ },
72
+ "cell": {
73
+ "modules": {
74
+ "backend": [
75
+ "lib/node/module"
76
+ ]
77
+ }
78
+ }
79
+ }