@novice1/api-doc-json-helper 0.1.3 → 1.0.0-alpha.1
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/lib/openapi.d.ts +3 -2
- package/lib/openapi.js +7 -18
- package/lib/openapi.js.map +1 -1
- package/lib/postman.d.ts +3 -2
- package/lib/postman.js +7 -18
- package/lib/postman.js.map +1 -1
- package/package.json +8 -3
package/lib/openapi.d.ts
CHANGED
|
@@ -6,8 +6,9 @@ import { AdditionalProperties, DiscriminatorObject, XMLObject, ExampleObject, Re
|
|
|
6
6
|
export declare class OpenAPIJsonHelper implements OpenAPIHelperInterface {
|
|
7
7
|
protected _schema: object;
|
|
8
8
|
protected _isRequired: boolean;
|
|
9
|
-
|
|
10
|
-
|
|
9
|
+
constructor({ value: schema }: {
|
|
10
|
+
value?: object | unknown;
|
|
11
|
+
}, isRequired?: boolean);
|
|
11
12
|
getFirstItem(): OpenAPIJsonHelper | undefined;
|
|
12
13
|
getChildren(): Record<string, OpenAPIJsonHelper>;
|
|
13
14
|
getAlternatives(): OpenAPIJsonHelper[];
|
package/lib/openapi.js
CHANGED
|
@@ -5,24 +5,12 @@ exports.OpenAPIJsonHelper = void 0;
|
|
|
5
5
|
* JSON schema (draft-07) helper for \@novice1/api-doc-generator
|
|
6
6
|
*/
|
|
7
7
|
class OpenAPIJsonHelper {
|
|
8
|
-
constructor(schema = {}, isRequired) {
|
|
8
|
+
constructor({ value: schema = {} }, isRequired) {
|
|
9
9
|
this._isRequired = false;
|
|
10
10
|
this._schema = {};
|
|
11
11
|
if (schema && typeof schema === 'object') {
|
|
12
12
|
const s = schema;
|
|
13
13
|
this._schema = s;
|
|
14
|
-
if (OpenAPIJsonHelper.schemaProperty && OpenAPIJsonHelper.schemaProperty in s) {
|
|
15
|
-
const s2 = s[OpenAPIJsonHelper.schemaProperty];
|
|
16
|
-
if (s2 && typeof s2 === 'object') {
|
|
17
|
-
this._schema = s2;
|
|
18
|
-
}
|
|
19
|
-
}
|
|
20
|
-
if (!('type' in this._schema)) {
|
|
21
|
-
this._schema = {
|
|
22
|
-
type: 'object',
|
|
23
|
-
properties: this._schema
|
|
24
|
-
};
|
|
25
|
-
}
|
|
26
14
|
}
|
|
27
15
|
if (isRequired) {
|
|
28
16
|
this._isRequired = isRequired;
|
|
@@ -31,7 +19,7 @@ class OpenAPIJsonHelper {
|
|
|
31
19
|
getFirstItem() {
|
|
32
20
|
const schema = this._schema;
|
|
33
21
|
if ('items' in schema && typeof schema.items === 'object') {
|
|
34
|
-
return new OpenAPIJsonHelper(schema.items);
|
|
22
|
+
return new OpenAPIJsonHelper({ value: schema.items });
|
|
35
23
|
}
|
|
36
24
|
return;
|
|
37
25
|
}
|
|
@@ -42,7 +30,7 @@ class OpenAPIJsonHelper {
|
|
|
42
30
|
const properties = schema.properties;
|
|
43
31
|
for (const p in properties) {
|
|
44
32
|
const isRequired = 'required' in schema && Array.isArray(schema.required) && schema.required.includes(p);
|
|
45
|
-
r[p] = new OpenAPIJsonHelper(properties[p], isRequired);
|
|
33
|
+
r[p] = new OpenAPIJsonHelper({ value: properties[p] }, isRequired);
|
|
46
34
|
}
|
|
47
35
|
}
|
|
48
36
|
return r;
|
|
@@ -52,7 +40,7 @@ class OpenAPIJsonHelper {
|
|
|
52
40
|
const schema = this._schema;
|
|
53
41
|
if ('oneOf' in schema && Array.isArray(schema.oneOf)) {
|
|
54
42
|
for (const p of schema.oneOf) {
|
|
55
|
-
r.push(new OpenAPIJsonHelper(p));
|
|
43
|
+
r.push(new OpenAPIJsonHelper({ value: p }));
|
|
56
44
|
}
|
|
57
45
|
}
|
|
58
46
|
return r;
|
|
@@ -117,7 +105,9 @@ class OpenAPIJsonHelper {
|
|
|
117
105
|
return;
|
|
118
106
|
}
|
|
119
107
|
isValid() {
|
|
120
|
-
return !!(this._schema && typeof this._schema === 'object'
|
|
108
|
+
return !!(this._schema && typeof this._schema === 'object' &&
|
|
109
|
+
(('type' in this._schema && typeof this._schema.type === 'string') ||
|
|
110
|
+
('oneOf' in this._schema && Array.isArray(this._schema.oneOf))));
|
|
121
111
|
}
|
|
122
112
|
getType() {
|
|
123
113
|
let r = '';
|
|
@@ -218,5 +208,4 @@ class OpenAPIJsonHelper {
|
|
|
218
208
|
}
|
|
219
209
|
}
|
|
220
210
|
exports.OpenAPIJsonHelper = OpenAPIJsonHelper;
|
|
221
|
-
OpenAPIJsonHelper.schemaProperty = '';
|
|
222
211
|
//# sourceMappingURL=openapi.js.map
|
package/lib/openapi.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"openapi.js","sourceRoot":"","sources":["../src/openapi.ts"],"names":[],"mappings":";;;AAUA;;GAEG;AACH,MAAa,iBAAiB;
|
|
1
|
+
{"version":3,"file":"openapi.js","sourceRoot":"","sources":["../src/openapi.ts"],"names":[],"mappings":";;;AAUA;;GAEG;AACH,MAAa,iBAAiB;IAI1B,YAAY,EAAE,KAAK,EAAE,MAAM,GAAG,EAAE,EAAgC,EAAE,UAAoB;QAF5E,gBAAW,GAAG,KAAK,CAAA;QAGzB,IAAI,CAAC,OAAO,GAAG,EAAE,CAAA;QACjB,IAAI,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YACvC,MAAM,CAAC,GAAG,MAAiC,CAAA;YAC3C,IAAI,CAAC,OAAO,GAAG,CAAC,CAAA;QACpB,CAAC;QACD,IAAI,UAAU,EAAE,CAAC;YACb,IAAI,CAAC,WAAW,GAAG,UAAU,CAAA;QACjC,CAAC;IACL,CAAC;IAED,YAAY;QAER,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAA;QAE3B,IAAI,OAAO,IAAI,MAAM,IAAI,OAAO,MAAM,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;YACxD,OAAO,IAAI,iBAAiB,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,CAAA;QACzD,CAAC;QAED,OAAM;IACV,CAAC;IACD,WAAW;QACP,MAAM,CAAC,GAAsC,EAAE,CAAC;QAChD,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAA;QAC3B,IAAI,YAAY,IAAI,MAAM,IAAI,OAAO,MAAM,CAAC,UAAU,KAAK,QAAQ,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;YACvF,MAAM,UAAU,GAA4B,MAAM,CAAC,UAAqC,CAAA;YACxF,KAAK,MAAM,CAAC,IAAI,UAAU,EAAE,CAAC;gBACzB,MAAM,UAAU,GAAY,UAAU,IAAI,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;gBACjH,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,iBAAiB,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,EAAE,UAAU,CAAC,CAAA;YACtE,CAAC;QACL,CAAC;QACD,OAAO,CAAC,CAAC;IACb,CAAC;IACD,eAAe;QACX,MAAM,CAAC,GAAwB,EAAE,CAAA;QACjC,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAA;QAC3B,IAAI,OAAO,IAAI,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YACnD,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBAC3B,CAAC,CAAC,IAAI,CAAC,IAAI,iBAAiB,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;YAC/C,CAAC;QACL,CAAC;QACD,OAAO,CAAC,CAAA;IACZ,CAAC;IACD,QAAQ;QACJ,OAAO,KAAK,CAAA;IAChB,CAAC;IACD,QAAQ;QACJ,OAAM;IACV,CAAC;IACD,uBAAuB;QACnB,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAA;QAC3B,OAAO,CAAC,CAAC,CAAC,sBAAsB,IAAI,MAAM,IAAI,MAAM,CAAC,oBAAoB,CAAC,CAAA;IAC9E,CAAC;IACD,uBAAuB;QACnB,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAA;QAC3B,OAAO,sBAAsB,IAAI,MAAM,IAAK,MAAM,CAAC,oBAA6C,CAAA;IACpG,CAAC;IACD,MAAM;QACF,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAA;QAC3B,OAAO,CAAC,CAAC,CAAC,MAAM,IAAI,MAAM,IAAI,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAA;IAClE,CAAC;IACD,MAAM;QACF,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAA;QAC3B,OAAO,MAAM,IAAI,MAAM,IAAI,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAA;IACxF,CAAC;IACD,gBAAgB;QACZ,OAAO,KAAK,CAAA;IAChB,CAAC;IACD,gBAAgB;QACZ,OAAM;IACV,CAAC;IACD,MAAM;QACF,OAAO,KAAK,CAAA;IAChB,CAAC;IACD,MAAM;QACF,OAAM;IACV,CAAC;IACD,WAAW;QACP,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAA;QAC3B,OAAO,CAAC,CAAC,CAAC,UAAU,IAAI,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAA;IACrE,CAAC;IACD,WAAW;QACP,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAA;QAC3B,IAAI,UAAU,IAAI,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YACzD,MAAM,CAAC,GAAoD,EAAE,CAAC;YAC9D,IAAI,CAAC,GAAG,CAAC,CAAA;YACT,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;gBAClC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG;oBACR,KAAK;iBACR,CAAA;gBACD,CAAC,EAAE,CAAA;YACP,CAAC;YACD,OAAO,CAAC,CAAA;QACZ,CAAC;QACD,OAAM;IACV,CAAC;IACD,WAAW;QACP,OAAO,KAAK,CAAA;IAChB,CAAC;IACD,WAAW;QACP,OAAM;IACV,CAAC;IACD,OAAO;QACH,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,KAAK,QAAQ;YACtD,CACI,CAAC,MAAM,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,QAAQ,CAAC;gBACjE,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAEjE,CAAC,CAAA;IACV,CAAC;IACD,OAAO;QACH,IAAI,CAAC,GAAG,EAAE,CAAA;QAEV,IAAI,MAAM,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAClE,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAA;QACzB,CAAC;QAED,IAAI,QAAQ,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;YACtE,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAA;QAC3B,CAAC;QAED,OAAO,CAAC,CAAC;IACb,CAAC;IACD,cAAc;QACV,IAAI,CAAC,GAAG,EAAE,CAAA;QAEV,IAAI,aAAa,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,QAAQ,EAAE,CAAC;YAChF,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAA;QAChC,CAAC;QAED,OAAO,CAAC,CAAC;IACb,CAAC;IACD,UAAU;QACN,OAAO,IAAI,CAAC,WAAW,CAAA;IAC3B,CAAC;IACD,QAAQ;QACJ,OAAO,CAAC,CAAC,CAAC,aAAa,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAA;IACxE,CAAC;IACD,eAAe;QACX,OAAO,CAAC,CAAC,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,IAAI,WAAW,CAAC,CAAA;IACtF,CAAC;IACD,eAAe;QACX,OAAO,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAA;IACvE,CAAC;IACD,eAAe;QACX,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAA;QAC3B,OAAO,CAAC,CAAC,CAAC,UAAU,IAAI,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;IAC/F,CAAC;IACD,eAAe;QACX,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAA;QAC3B,IAAI,UAAU,IAAI,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YACnF,OAAO,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;QAC7B,CAAC;QACD,OAAM;IACV,CAAC;IACD,YAAY;QACR,OAAO,CAAC,CAAC,CAAC,YAAY,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;IACtE,CAAC;IACD,gBAAgB;QACZ,IAAI,CAAC,GAAG,KAAK,CAAC;QACd,IAAI,MAAM,IAAI,IAAI,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7D,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAA;YAC/B,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAA;QAC/C,CAAC;QACD,OAAO,CAAC,CAAC;IACb,CAAC;IACD,OAAO;QACH,IAAI,CAAC,GAAc,EAAE,CAAA;QACrB,IAAI,MAAM,IAAI,IAAI,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7D,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAA;QACzB,CAAC;QACD,OAAO,CAAC,CAAC;IACb,CAAC;IACD,MAAM;QACF,OAAO,eAAe,IAAI,IAAI,CAAC,OAAO,IAAI,UAAU,IAAI,IAAI,CAAC,OAAO,IAAI,SAAS,IAAI,IAAI,CAAC,OAAO,IAAI,WAAW,IAAI,IAAI,CAAC,OAAO,CAAA;IACpI,CAAC;IACD,MAAM;QACF,OAAO,eAAe,IAAI,IAAI,CAAC,OAAO,IAAI,UAAU,IAAI,IAAI,CAAC,OAAO,IAAI,SAAS,IAAI,IAAI,CAAC,OAAO,IAAI,WAAW,IAAI,IAAI,CAAC,OAAO,CAAA;IACpI,CAAC;IACD,MAAM;QACF,IAAI,eAAe,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,KAAK,QAAQ,EAAE,CAAC;YACpF,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAA;QACrC,CAAC;QACD,IAAI,UAAU,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAA;QAChC,CAAC;QACD,IAAI,SAAS,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;YACxE,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAA;QAC/B,CAAC;QACD,IAAI,WAAW,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,KAAK,QAAQ,EAAE,CAAC;YAC5E,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAA;QACjC,CAAC;QACD,OAAM;IACV,CAAC;IACD,MAAM;QACF,IAAI,eAAe,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,KAAK,QAAQ,EAAE,CAAC;YACpF,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAA;QACrC,CAAC;QACD,IAAI,UAAU,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAA;QAChC,CAAC;QACD,IAAI,SAAS,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;YACxE,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAA;QAC/B,CAAC;QACD,IAAI,WAAW,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,KAAK,QAAQ,EAAE,CAAC;YAC5E,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAA;QACjC,CAAC;QACD,OAAM;IACV,CAAC;IACD,OAAO;QACH,OAAO,EAAE,CAAA;IACb,CAAC;CAEJ;AAzND,8CAyNC"}
|
package/lib/postman.d.ts
CHANGED
|
@@ -3,8 +3,9 @@ import { XMLObject } from '@novice1/api-doc-generator/lib/generators/openapi/def
|
|
|
3
3
|
export declare class PostmanJsonHelper implements PostmanHelperInterface {
|
|
4
4
|
protected _schema: object;
|
|
5
5
|
protected _isRequired: boolean;
|
|
6
|
-
|
|
7
|
-
|
|
6
|
+
constructor({ value: schema }: {
|
|
7
|
+
value?: object | unknown;
|
|
8
|
+
}, isRequired?: boolean);
|
|
8
9
|
getFirstItem(): PostmanJsonHelper | undefined;
|
|
9
10
|
getChildren(): Record<string, PostmanJsonHelper>;
|
|
10
11
|
getAlternatives(): PostmanJsonHelper[];
|
package/lib/postman.js
CHANGED
|
@@ -2,24 +2,12 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.PostmanJsonHelper = void 0;
|
|
4
4
|
class PostmanJsonHelper {
|
|
5
|
-
constructor(schema = {}, isRequired) {
|
|
5
|
+
constructor({ value: schema = {} }, isRequired) {
|
|
6
6
|
this._isRequired = false;
|
|
7
7
|
this._schema = {};
|
|
8
8
|
if (schema && typeof schema === 'object') {
|
|
9
9
|
const s = schema;
|
|
10
10
|
this._schema = s;
|
|
11
|
-
if (PostmanJsonHelper.schemaProperty && PostmanJsonHelper.schemaProperty in s) {
|
|
12
|
-
const s2 = s[PostmanJsonHelper.schemaProperty];
|
|
13
|
-
if (s2 && typeof s2 === 'object') {
|
|
14
|
-
this._schema = s2;
|
|
15
|
-
}
|
|
16
|
-
}
|
|
17
|
-
if (!('type' in this._schema)) {
|
|
18
|
-
this._schema = {
|
|
19
|
-
type: 'object',
|
|
20
|
-
properties: this._schema
|
|
21
|
-
};
|
|
22
|
-
}
|
|
23
11
|
}
|
|
24
12
|
if (isRequired) {
|
|
25
13
|
this._isRequired = isRequired;
|
|
@@ -28,7 +16,7 @@ class PostmanJsonHelper {
|
|
|
28
16
|
getFirstItem() {
|
|
29
17
|
const schema = this._schema;
|
|
30
18
|
if ('items' in schema && typeof schema.items === 'object') {
|
|
31
|
-
return new PostmanJsonHelper(schema.items);
|
|
19
|
+
return new PostmanJsonHelper({ value: schema.items });
|
|
32
20
|
}
|
|
33
21
|
return;
|
|
34
22
|
}
|
|
@@ -39,7 +27,7 @@ class PostmanJsonHelper {
|
|
|
39
27
|
const properties = schema.properties;
|
|
40
28
|
for (const p in properties) {
|
|
41
29
|
const isRequired = 'required' in schema && Array.isArray(schema.required) && schema.required.includes(p);
|
|
42
|
-
r[p] = new PostmanJsonHelper(properties[p], isRequired);
|
|
30
|
+
r[p] = new PostmanJsonHelper({ value: properties[p] }, isRequired);
|
|
43
31
|
}
|
|
44
32
|
}
|
|
45
33
|
return r;
|
|
@@ -49,7 +37,7 @@ class PostmanJsonHelper {
|
|
|
49
37
|
const schema = this._schema;
|
|
50
38
|
if ('oneOf' in schema && Array.isArray(schema.oneOf)) {
|
|
51
39
|
for (const p of schema.oneOf) {
|
|
52
|
-
r.push(new PostmanJsonHelper(p));
|
|
40
|
+
r.push(new PostmanJsonHelper({ value: p }));
|
|
53
41
|
}
|
|
54
42
|
}
|
|
55
43
|
return r;
|
|
@@ -58,7 +46,9 @@ class PostmanJsonHelper {
|
|
|
58
46
|
return;
|
|
59
47
|
}
|
|
60
48
|
isValid() {
|
|
61
|
-
return !!(this._schema && typeof this._schema === 'object'
|
|
49
|
+
return !!(this._schema && typeof this._schema === 'object' &&
|
|
50
|
+
(('type' in this._schema && typeof this._schema.type === 'string') ||
|
|
51
|
+
('oneOf' in this._schema && Array.isArray(this._schema.oneOf))));
|
|
62
52
|
}
|
|
63
53
|
getType() {
|
|
64
54
|
let r = '';
|
|
@@ -159,5 +149,4 @@ class PostmanJsonHelper {
|
|
|
159
149
|
}
|
|
160
150
|
}
|
|
161
151
|
exports.PostmanJsonHelper = PostmanJsonHelper;
|
|
162
|
-
PostmanJsonHelper.schemaProperty = '';
|
|
163
152
|
//# sourceMappingURL=postman.js.map
|
package/lib/postman.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"postman.js","sourceRoot":"","sources":["../src/postman.ts"],"names":[],"mappings":";;;AAIA,MAAa,iBAAiB;
|
|
1
|
+
{"version":3,"file":"postman.js","sourceRoot":"","sources":["../src/postman.ts"],"names":[],"mappings":";;;AAIA,MAAa,iBAAiB;IAI1B,YAAY,EAAE,KAAK,EAAE,MAAM,GAAG,EAAE,EAAgC,EAAE,UAAoB;QAF5E,gBAAW,GAAG,KAAK,CAAA;QAGzB,IAAI,CAAC,OAAO,GAAG,EAAE,CAAA;QACjB,IAAI,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YACvC,MAAM,CAAC,GAAG,MAAiC,CAAA;YAC3C,IAAI,CAAC,OAAO,GAAG,CAAC,CAAA;QACpB,CAAC;QACD,IAAI,UAAU,EAAE,CAAC;YACb,IAAI,CAAC,WAAW,GAAG,UAAU,CAAA;QACjC,CAAC;IACL,CAAC;IACD,YAAY;QAER,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAA;QAE3B,IAAI,OAAO,IAAI,MAAM,IAAI,OAAO,MAAM,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;YACxD,OAAO,IAAI,iBAAiB,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,CAAA;QACzD,CAAC;QAED,OAAM;IACV,CAAC;IACD,WAAW;QACP,MAAM,CAAC,GAAsC,EAAE,CAAC;QAChD,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAA;QAC3B,IAAI,YAAY,IAAI,MAAM,IAAI,OAAO,MAAM,CAAC,UAAU,KAAK,QAAQ,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;YACvF,MAAM,UAAU,GAA4B,MAAM,CAAC,UAAqC,CAAA;YACxF,KAAK,MAAM,CAAC,IAAI,UAAU,EAAE,CAAC;gBACzB,MAAM,UAAU,GAAY,UAAU,IAAI,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;gBACjH,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,iBAAiB,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,EAAE,UAAU,CAAC,CAAA;YACtE,CAAC;QACL,CAAC;QACD,OAAO,CAAC,CAAC;IACb,CAAC;IACD,eAAe;QACX,MAAM,CAAC,GAAwB,EAAE,CAAA;QACjC,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAA;QAC3B,IAAI,OAAO,IAAI,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YACnD,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBAC3B,CAAC,CAAC,IAAI,CAAC,IAAI,iBAAiB,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;YAC/C,CAAC;QACL,CAAC;QACD,OAAO,CAAC,CAAA;IACZ,CAAC;IACD,MAAM;QACF,OAAM;IACV,CAAC;IACD,OAAO;QACH,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,KAAK,QAAQ;YACtD,CACI,CAAC,MAAM,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,QAAQ,CAAC;gBACjE,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAEjE,CAAC,CAAA;IACV,CAAC;IACD,OAAO;QACH,IAAI,CAAC,GAAG,EAAE,CAAA;QAEV,IAAI,MAAM,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAClE,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAA;QACzB,CAAC;QAED,IAAI,QAAQ,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;YACtE,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAA;QAC3B,CAAC;QAED,OAAO,CAAC,CAAC;IACb,CAAC;IACD,cAAc;QACV,IAAI,CAAC,GAAG,EAAE,CAAA;QAEV,IAAI,aAAa,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,QAAQ,EAAE,CAAC;YAChF,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAA;QAChC,CAAC;QAED,OAAO,CAAC,CAAC;IACb,CAAC;IACD,UAAU;QACN,OAAO,IAAI,CAAC,WAAW,CAAA;IAC3B,CAAC;IACD,QAAQ;QACJ,OAAO,CAAC,CAAC,CAAC,aAAa,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAA;IACxE,CAAC;IACD,eAAe;QACX,OAAO,CAAC,CAAC,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,IAAI,WAAW,CAAC,CAAA;IACtF,CAAC;IACD,eAAe;QACX,OAAO,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAA;IACvE,CAAC;IACD,eAAe;QACX,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAA;QAC3B,OAAO,CAAC,CAAC,CAAC,UAAU,IAAI,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;IAC/F,CAAC;IACD,eAAe;QACX,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAA;QAC3B,IAAI,UAAU,IAAI,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YACnF,OAAO,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;QAC7B,CAAC;QACD,OAAM;IACV,CAAC;IACD,YAAY;QACR,OAAO,CAAC,CAAC,CAAC,YAAY,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;IACtE,CAAC;IACD,gBAAgB;QACZ,IAAI,CAAC,GAAG,KAAK,CAAC;QACd,IAAI,MAAM,IAAI,IAAI,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7D,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAA;YAC/B,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAA;QAC/C,CAAC;QACD,OAAO,CAAC,CAAC;IACb,CAAC;IACD,OAAO;QACH,IAAI,CAAC,GAAc,EAAE,CAAA;QACrB,IAAI,MAAM,IAAI,IAAI,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7D,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAA;QACzB,CAAC;QACD,OAAO,CAAC,CAAC;IACb,CAAC;IACD,MAAM;QACF,OAAO,eAAe,IAAI,IAAI,CAAC,OAAO,IAAI,UAAU,IAAI,IAAI,CAAC,OAAO,IAAI,SAAS,IAAI,IAAI,CAAC,OAAO,IAAI,WAAW,IAAI,IAAI,CAAC,OAAO,CAAA;IACpI,CAAC;IACD,MAAM;QACF,OAAO,eAAe,IAAI,IAAI,CAAC,OAAO,IAAI,UAAU,IAAI,IAAI,CAAC,OAAO,IAAI,SAAS,IAAI,IAAI,CAAC,OAAO,IAAI,WAAW,IAAI,IAAI,CAAC,OAAO,CAAA;IACpI,CAAC;IACD,MAAM;QACF,IAAI,eAAe,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,KAAK,QAAQ,EAAE,CAAC;YACpF,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAA;QACrC,CAAC;QACD,IAAI,UAAU,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAA;QAChC,CAAC;QACD,IAAI,SAAS,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;YACxE,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAA;QAC/B,CAAC;QACD,IAAI,WAAW,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,KAAK,QAAQ,EAAE,CAAC;YAC5E,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAA;QACjC,CAAC;QACD,OAAM;IACV,CAAC;IACD,MAAM;QACF,IAAI,eAAe,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,KAAK,QAAQ,EAAE,CAAC;YACpF,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAA;QACrC,CAAC;QACD,IAAI,UAAU,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAA;QAChC,CAAC;QACD,IAAI,SAAS,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;YACxE,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAA;QAC/B,CAAC;QACD,IAAI,WAAW,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,KAAK,QAAQ,EAAE,CAAC;YAC5E,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAA;QACjC,CAAC;QACD,OAAM;IACV,CAAC;IACD,OAAO;QACH,OAAO,EAAE,CAAA;IACb,CAAC;CACJ;AA/JD,8CA+JC"}
|
package/package.json
CHANGED
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@novice1/api-doc-json-helper",
|
|
3
|
-
"version": "0.1
|
|
3
|
+
"version": "1.0.0-alpha.1",
|
|
4
4
|
"description": "",
|
|
5
5
|
"main": "lib/index.js",
|
|
6
6
|
"scripts": {
|
|
7
7
|
"build": "tsc",
|
|
8
|
-
"lint": "eslint ."
|
|
8
|
+
"lint": "eslint .",
|
|
9
|
+
"test": "ts-node ./test/usage.test.ts"
|
|
9
10
|
},
|
|
10
11
|
"repository": {
|
|
11
12
|
"type": "git",
|
|
@@ -24,16 +25,20 @@
|
|
|
24
25
|
"json"
|
|
25
26
|
],
|
|
26
27
|
"dependencies": {
|
|
27
|
-
"@novice1/api-doc-generator": "^0.
|
|
28
|
+
"@novice1/api-doc-generator": "^1.0.0-alpha.0",
|
|
28
29
|
"tslib": "^2.8.1"
|
|
29
30
|
},
|
|
30
31
|
"devDependencies": {
|
|
31
32
|
"@eslint/eslintrc": "^3.3.1",
|
|
32
33
|
"@eslint/js": "^9.25.1",
|
|
34
|
+
"@novice1/routing": "^2.0.0",
|
|
33
35
|
"@stylistic/eslint-plugin-js": "^4.2.0",
|
|
36
|
+
"@types/chai": "^5.2.1",
|
|
37
|
+
"@types/express": "^5.0.1",
|
|
34
38
|
"@types/node": "^22.14.1",
|
|
35
39
|
"@typescript-eslint/eslint-plugin": "^8.31.0",
|
|
36
40
|
"@typescript-eslint/parser": "^8.31.0",
|
|
41
|
+
"chai": "^5.2.0",
|
|
37
42
|
"eslint": "^9.25.1",
|
|
38
43
|
"kaukau": "^4.1.5",
|
|
39
44
|
"ts-node": "^10.9.2",
|