@novice1/api-doc-json-helper 1.0.5 → 1.0.7
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.
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { OpenAPIHelperInterface } from '@novice1/api-doc-generator';
|
|
2
|
-
import { AdditionalProperties, DiscriminatorObject, XMLObject, ExampleObject, ReferenceObject, EncodingObject } from '@novice1/api-doc-generator/lib/generators/openapi/definitions';
|
|
2
|
+
import { AdditionalProperties, DiscriminatorObject, XMLObject, ExampleObject, ReferenceObject, EncodingObject, SchemaObject } from '@novice1/api-doc-generator/lib/generators/openapi/definitions';
|
|
3
3
|
import { BaseJsonHelper } from './BaseJsonHelper';
|
|
4
4
|
/**
|
|
5
5
|
* JSON schema (draft-07) helper for \@novice1/api-doc-generator
|
|
@@ -22,4 +22,5 @@ export declare class OpenAPIJsonHelper extends BaseJsonHelper implements OpenAPI
|
|
|
22
22
|
getExamples(): Record<string, ExampleObject | ReferenceObject> | undefined;
|
|
23
23
|
hasEncoding(): boolean;
|
|
24
24
|
getEncoding(): Record<string, EncodingObject> | undefined;
|
|
25
|
+
getAnyOf(): SchemaObject[];
|
|
25
26
|
}
|
package/lib/OpenAPIJsonHelper.js
CHANGED
|
@@ -55,11 +55,12 @@ class OpenAPIJsonHelper extends BaseJsonHelper_1.BaseJsonHelper {
|
|
|
55
55
|
}
|
|
56
56
|
hasRef() {
|
|
57
57
|
const schema = this._schema;
|
|
58
|
-
return !!('$ref' in schema && typeof schema.$ref === 'string');
|
|
58
|
+
return !!('$ref' in schema && typeof schema.$ref === 'string') || !!('$id' in schema && typeof schema.$id === 'string');
|
|
59
59
|
}
|
|
60
60
|
getRef() {
|
|
61
61
|
const schema = this._schema;
|
|
62
|
-
return '$ref' in schema && typeof schema.$ref === 'string' ? schema.$ref :
|
|
62
|
+
return '$ref' in schema && typeof schema.$ref === 'string' ? schema.$ref :
|
|
63
|
+
'$id' in schema && typeof schema.$id === 'string' ? schema.$id : undefined;
|
|
63
64
|
}
|
|
64
65
|
hasDiscriminator() {
|
|
65
66
|
return !!('discriminator' in this._schema &&
|
|
@@ -112,6 +113,20 @@ class OpenAPIJsonHelper extends BaseJsonHelper_1.BaseJsonHelper {
|
|
|
112
113
|
getEncoding() {
|
|
113
114
|
return this.getMeta('encoding');
|
|
114
115
|
}
|
|
116
|
+
getAnyOf() {
|
|
117
|
+
let r = [];
|
|
118
|
+
if ('enum' in this._schema && Array.isArray(this._schema.enum)) {
|
|
119
|
+
r = this._schema.enum;
|
|
120
|
+
}
|
|
121
|
+
else if ('anyOf' in this._schema && Array.isArray(this._schema.anyOf)) {
|
|
122
|
+
for (const p of this._schema.anyOf) {
|
|
123
|
+
if (p && typeof p === 'object') {
|
|
124
|
+
r.push(p);
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
return r;
|
|
129
|
+
}
|
|
115
130
|
}
|
|
116
131
|
exports.OpenAPIJsonHelper = OpenAPIJsonHelper;
|
|
117
132
|
//# sourceMappingURL=OpenAPIJsonHelper.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OpenAPIJsonHelper.js","sourceRoot":"","sources":["../src/OpenAPIJsonHelper.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"OpenAPIJsonHelper.js","sourceRoot":"","sources":["../src/OpenAPIJsonHelper.ts"],"names":[],"mappings":";;;AAUA,qDAAkD;AAElD;;GAEG;AACH,MAAa,iBAAkB,SAAQ,+BAAc;IAGjD,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,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAA;IACpD,CAAC;IACD,QAAQ;QACJ,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QACnC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC5B,OAAO,KAAK,CAAA;QAChB,CAAC;QACD,OAAO,EAAE,CAAA;IACb,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,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,MAAM,IAAI,OAAO,MAAM,CAAC,GAAG,KAAK,QAAQ,CAAC,CAAA;IAC3H,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;YACtE,KAAK,IAAI,MAAM,IAAI,OAAO,MAAM,CAAC,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAA;IAClF,CAAC;IACD,gBAAgB;QACZ,OAAO,CAAC,CAAC,CAAC,eAAe,IAAI,IAAI,CAAC,OAAO;YACrC,IAAI,CAAC,OAAO,CAAC,aAAa;YAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,KAAK,QAAQ;YAC9C,cAAc,IAAI,IAAI,CAAC,OAAO,CAAC,aAAa;YAC5C,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,YAAY;YACvC,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,YAAY,KAAK,QAAQ,CAAC,CAAA;IACpE,CAAC;IACD,gBAAgB;QACZ,OAAO,eAAe,IAAI,IAAI,CAAC,OAAO;YAClC,IAAI,CAAC,OAAO,CAAC,aAAa;YAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,KAAK,QAAQ;YAC9C,cAAc,IAAI,IAAI,CAAC,OAAO,CAAC,aAAa;YAC5C,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,YAAY;YACvC,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,YAAY,KAAK,QAAQ,CAAC,CAAC;YACxD,IAAI,CAAC,OAAO,CAAC,aAAqC,CAAC,CAAC;YACpD,SAAS,CAAA;IACtB,CAAC;IACD,MAAM;QACF,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QACnC,OAAO,CAAC,CAAC,CAAC,OAAO,IAAI,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAA;IACrD,CAAC;IACD,MAAM;QACF,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAA0B,CAAA;IACvD,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,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;QAC7C,OAAO,CAAC,CAAC,CAAC,YAAY,IAAI,OAAO,YAAY,KAAK,QAAQ,CAAC,CAAA;IAC/D,CAAC;IACD,WAAW;QACP,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAA+C,CAAA;IACjF,CAAC;IACD,QAAQ;QACJ,IAAI,CAAC,GAAmB,EAAE,CAAA;QAC1B,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;aAAM,IAAI,OAAO,IAAI,IAAI,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACtE,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;gBACjC,IAAI,CAAC,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;oBAC7B,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;gBACb,CAAC;YACL,CAAC;QACL,CAAC;QACD,OAAO,CAAC,CAAC;IACb,CAAC;CACJ;AA9HD,8CA8HC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@novice1/api-doc-json-helper",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.7",
|
|
4
4
|
"description": "",
|
|
5
5
|
"main": "lib/index.js",
|
|
6
6
|
"scripts": {
|
|
@@ -25,23 +25,23 @@
|
|
|
25
25
|
"json"
|
|
26
26
|
],
|
|
27
27
|
"dependencies": {
|
|
28
|
-
"@novice1/api-doc-generator": "^1.
|
|
28
|
+
"@novice1/api-doc-generator": "^1.2.4",
|
|
29
29
|
"tslib": "^2.8.1"
|
|
30
30
|
},
|
|
31
31
|
"devDependencies": {
|
|
32
|
-
"@eslint/eslintrc": "^3.3.
|
|
33
|
-
"@eslint/js": "^9.
|
|
32
|
+
"@eslint/eslintrc": "^3.3.3",
|
|
33
|
+
"@eslint/js": "^9.39.1",
|
|
34
34
|
"@novice1/routing": "^2.0.0",
|
|
35
|
-
"@stylistic/eslint-plugin
|
|
36
|
-
"@types/chai": "^5.2.
|
|
37
|
-
"@types/express": "^5.0.
|
|
38
|
-
"@types/node": "^
|
|
39
|
-
"@typescript-eslint/eslint-plugin": "^8.
|
|
40
|
-
"@typescript-eslint/parser": "^8.
|
|
41
|
-
"chai": "^
|
|
42
|
-
"eslint": "^9.
|
|
43
|
-
"kaukau": "^4.1.
|
|
35
|
+
"@stylistic/eslint-plugin": "^5.6.1",
|
|
36
|
+
"@types/chai": "^5.2.3",
|
|
37
|
+
"@types/express": "^5.0.5",
|
|
38
|
+
"@types/node": "^24.10.1",
|
|
39
|
+
"@typescript-eslint/eslint-plugin": "^8.48.0",
|
|
40
|
+
"@typescript-eslint/parser": "^8.48.0",
|
|
41
|
+
"chai": "^6.2.1",
|
|
42
|
+
"eslint": "^9.39.1",
|
|
43
|
+
"kaukau": "^4.1.7",
|
|
44
44
|
"ts-node": "^10.9.2",
|
|
45
|
-
"typescript": "^5.
|
|
45
|
+
"typescript": "^5.9.3"
|
|
46
46
|
}
|
|
47
47
|
}
|