@trapi/swagger 0.2.17 → 0.3.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.
Files changed (71) hide show
  1. package/LICENSE +1 -1
  2. package/README.MD +7 -0
  3. package/dist/config/utils/validator.d.ts.map +1 -1
  4. package/dist/config/utils/validator.js +6 -6
  5. package/dist/config/utils/validator.js.map +1 -1
  6. package/dist/index.d.ts +1 -0
  7. package/dist/index.d.ts.map +1 -1
  8. package/dist/index.js +1 -0
  9. package/dist/index.js.map +1 -1
  10. package/dist/metadata.d.ts +3 -1
  11. package/dist/metadata.d.ts.map +1 -1
  12. package/dist/metadata.js +16 -18
  13. package/dist/metadata.js.map +1 -1
  14. package/dist/{utils.d.ts → module.d.ts} +2 -2
  15. package/dist/module.d.ts.map +1 -0
  16. package/dist/{utils.js → module.js} +5 -5
  17. package/dist/module.js.map +1 -0
  18. package/dist/specification/abstract.d.ts +10 -9
  19. package/dist/specification/abstract.d.ts.map +1 -1
  20. package/dist/specification/abstract.js +25 -28
  21. package/dist/specification/abstract.js.map +1 -1
  22. package/dist/specification/index.d.ts +2 -0
  23. package/dist/specification/index.d.ts.map +1 -1
  24. package/dist/specification/index.js +2 -0
  25. package/dist/specification/index.js.map +1 -1
  26. package/dist/specification/module.d.ts +5 -0
  27. package/dist/specification/module.d.ts.map +1 -0
  28. package/dist/specification/{utils.js → module.js} +6 -18
  29. package/dist/specification/module.js.map +1 -0
  30. package/dist/specification/utils/character.d.ts +3 -0
  31. package/dist/specification/utils/character.d.ts.map +1 -0
  32. package/dist/specification/utils/character.js +22 -0
  33. package/dist/specification/utils/character.js.map +1 -0
  34. package/dist/specification/utils/index.d.ts +2 -0
  35. package/dist/specification/utils/index.d.ts.map +1 -0
  36. package/dist/specification/utils/index.js +24 -0
  37. package/dist/specification/utils/index.js.map +1 -0
  38. package/dist/specification/v2/index.d.ts +5 -5
  39. package/dist/specification/v2/index.d.ts.map +1 -1
  40. package/dist/specification/v2/index.js +22 -20
  41. package/dist/specification/v2/index.js.map +1 -1
  42. package/dist/specification/v3/index.d.ts +6 -5
  43. package/dist/specification/v3/index.d.ts.map +1 -1
  44. package/dist/specification/v3/index.js +39 -22
  45. package/dist/specification/v3/index.js.map +1 -1
  46. package/dist/utils/index.d.ts +5 -0
  47. package/dist/utils/index.d.ts.map +1 -0
  48. package/dist/utils/index.js +27 -0
  49. package/dist/utils/index.js.map +1 -0
  50. package/dist/utils/object.d.ts +2 -0
  51. package/dist/utils/object.d.ts.map +1 -0
  52. package/dist/utils/object.js +14 -0
  53. package/dist/utils/object.js.map +1 -0
  54. package/dist/utils/package-json.d.ts +3 -0
  55. package/dist/utils/package-json.d.ts.map +1 -0
  56. package/dist/utils/package-json.js +35 -0
  57. package/dist/utils/package-json.js.map +1 -0
  58. package/dist/utils/path.d.ts +2 -0
  59. package/dist/utils/path.d.ts.map +1 -0
  60. package/dist/utils/path.js +21 -0
  61. package/dist/utils/path.js.map +1 -0
  62. package/dist/utils/yup.d.ts +5 -0
  63. package/dist/utils/yup.d.ts.map +1 -0
  64. package/dist/utils/yup.js +17 -0
  65. package/dist/utils/yup.js.map +1 -0
  66. package/package.json +10 -6
  67. package/dist/specification/utils.d.ts +0 -7
  68. package/dist/specification/utils.d.ts.map +0 -1
  69. package/dist/specification/utils.js.map +0 -1
  70. package/dist/utils.d.ts.map +0 -1
  71. package/dist/utils.js.map +0 -1
@@ -0,0 +1,35 @@
1
+ "use strict";
2
+ /*
3
+ * Copyright (c) 2021-2022.
4
+ * Author Peter Placzek (tada5hi)
5
+ * For the full copyright and license information,
6
+ * view the LICENSE file that was distributed with this source code.
7
+ */
8
+ var __importDefault = (this && this.__importDefault) || function (mod) {
9
+ return (mod && mod.__esModule) ? mod : { "default": mod };
10
+ };
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.getPackageJsonStringValue = exports.loadPackageJson = void 0;
13
+ const fs_1 = __importDefault(require("fs"));
14
+ const path_1 = __importDefault(require("path"));
15
+ const cachedFileContent = {};
16
+ function loadPackageJson(workingDir) {
17
+ const filePath = path_1.default.join(workingDir, 'package.json');
18
+ if (Object.prototype.hasOwnProperty.call(cachedFileContent, filePath)) {
19
+ return cachedFileContent[filePath];
20
+ }
21
+ const rawContent = fs_1.default.readFileSync(filePath, { encoding: 'utf-8' });
22
+ return JSON.parse(rawContent);
23
+ }
24
+ exports.loadPackageJson = loadPackageJson;
25
+ function getPackageJsonStringValue(workingDir, key, defaultValue = '') {
26
+ try {
27
+ const record = loadPackageJson(workingDir);
28
+ return record[key] || defaultValue;
29
+ }
30
+ catch (e) {
31
+ return defaultValue;
32
+ }
33
+ }
34
+ exports.getPackageJsonStringValue = getPackageJsonStringValue;
35
+ //# sourceMappingURL=package-json.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"package-json.js","sourceRoot":"","sources":["../../src/utils/package-json.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;AAEH,4CAAoB;AACpB,gDAAwB;AAExB,MAAM,iBAAiB,GAAyC,EAAE,CAAC;AAEnE,SAAgB,eAAe,CAAC,UAAkB;IAC9C,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;IAEvD,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,iBAAiB,EAAE,QAAQ,CAAC,EAAE;QACnE,OAAO,iBAAiB,CAAC,QAAQ,CAAC,CAAC;KACtC;IAED,MAAM,UAAU,GAAG,YAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;IAEpE,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;AAClC,CAAC;AAVD,0CAUC;AAED,SAAgB,yBAAyB,CACrC,UAAkB,EAClB,GAAW,EACX,YAAY,GAAG,EAAE;IAEjB,IAAI;QACA,MAAM,MAAM,GAAG,eAAe,CAAC,UAAU,CAAC,CAAC;QAE3C,OAAO,MAAM,CAAC,GAAG,CAAC,IAAI,YAAY,CAAC;KACtC;IAAC,OAAO,CAAC,EAAE;QACR,OAAO,YAAY,CAAC;KACvB;AACL,CAAC;AAZD,8DAYC"}
@@ -0,0 +1,2 @@
1
+ export declare function normalizePathParameters(str: string): string;
2
+ //# sourceMappingURL=path.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"path.d.ts","sourceRoot":"","sources":["../../src/utils/path.ts"],"names":[],"mappings":"AAOA,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,MAAM,GAAI,MAAM,CAY5D"}
@@ -0,0 +1,21 @@
1
+ "use strict";
2
+ /*
3
+ * Copyright (c) 2021-2022.
4
+ * Author Peter Placzek (tada5hi)
5
+ * For the full copyright and license information,
6
+ * view the LICENSE file that was distributed with this source code.
7
+ */
8
+ Object.defineProperty(exports, "__esModule", { value: true });
9
+ exports.normalizePathParameters = void 0;
10
+ function normalizePathParameters(str) {
11
+ // <:id> -> {id}
12
+ // todo: maybe escaping / is necessary
13
+ str = str.replace(/<:([^/]+)>/g, '{$1}');
14
+ // :id -> {id}
15
+ str = str.replace(/:([^/]+)/g, '{$1}');
16
+ // <id> -> {id}
17
+ str = str.replace(/<([^/]+)>/g, '{$1}');
18
+ return str;
19
+ }
20
+ exports.normalizePathParameters = normalizePathParameters;
21
+ //# sourceMappingURL=path.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"path.js","sourceRoot":"","sources":["../../src/utils/path.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,SAAgB,uBAAuB,CAAC,GAAW;IAC/C,gBAAgB;IAChB,sCAAsC;IACtC,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;IAEzC,cAAc;IACd,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IAEvC,eAAe;IACf,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;IAExC,OAAO,GAAG,CAAC;AACf,CAAC;AAZD,0DAYC"}
@@ -0,0 +1,5 @@
1
+ import Lazy from 'yup/lib/Lazy';
2
+ import Reference from 'yup/lib/Reference';
3
+ import { AnySchema } from 'yup/lib/schema';
4
+ export declare function mapYupRuleToDictionary<T>(map: any, rule: T): Record<string, AnySchema | Reference | Lazy<any, any> | T>;
5
+ //# sourceMappingURL=yup.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"yup.d.ts","sourceRoot":"","sources":["../../src/utils/yup.ts"],"names":[],"mappings":"AAOA,OAAO,IAAI,MAAM,cAAc,CAAC;AAChC,OAAO,SAAS,MAAM,mBAAmB,CAAC;AAC1C,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,wBAAgB,sBAAsB,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,GAAI,MAAM,CAAC,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CASxH"}
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+ /*
3
+ * Copyright (c) 2021.
4
+ * Author Peter Placzek (tada5hi)
5
+ * For the full copyright and license information,
6
+ * view the LICENSE file that was distributed with this source code.
7
+ */
8
+ Object.defineProperty(exports, "__esModule", { value: true });
9
+ exports.mapYupRuleToDictionary = void 0;
10
+ function mapYupRuleToDictionary(map, rule) {
11
+ if (!map) {
12
+ return {};
13
+ }
14
+ return Object.keys(map).reduce((newMap, key) => (Object.assign(Object.assign({}, newMap), { [key]: rule })), {});
15
+ }
16
+ exports.mapYupRuleToDictionary = mapYupRuleToDictionary;
17
+ //# sourceMappingURL=yup.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"yup.js","sourceRoot":"","sources":["../../src/utils/yup.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAMH,SAAgB,sBAAsB,CAAI,GAAQ,EAAE,IAAO;IACvD,IAAI,CAAC,GAAG,EAAE;QACN,OAAO,EAAE,CAAC;KACb;IAED,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC,iCACzC,MAAM,KACT,CAAC,GAAG,CAAC,EAAE,IAAI,IACb,EAAE,EAAE,CAAC,CAAC;AACZ,CAAC;AATD,wDASC"}
package/package.json CHANGED
@@ -6,7 +6,7 @@
6
6
  "url": "https://github.com/tada5hi"
7
7
  },
8
8
  "license": "MIT",
9
- "version": "0.2.17",
9
+ "version": "0.3.1",
10
10
  "description": "Generate Swagger files from a decorator APIs.",
11
11
  "keywords": [
12
12
  "typescript",
@@ -36,17 +36,21 @@
36
36
  },
37
37
  "devDependencies": {
38
38
  "@types/yamljs": "^0.2.31",
39
+ "@types/yup": "^0.32.0",
39
40
  "jest": "^27.5.1",
40
41
  "rimraf": "^3.0.2"
41
42
  },
42
43
  "dependencies": {
43
- "@trapi/metadata": "^0.1.8",
44
- "@trapi/metadata-utils": "^0.0.5",
45
- "yamljs": "^0.3.0"
44
+ "@trapi/decorator": "^0.0.2",
45
+ "@trapi/metadata": "^0.2.1",
46
+ "merge": "^2.1.1",
47
+ "yamljs": "^0.3.0",
48
+ "yup": "^0.32.11"
46
49
  },
47
50
  "repository": {
48
51
  "type": "git",
49
- "url": "git+https://github.com/Tada5hi/trapi.git"
52
+ "url": "git+https://github.com/Tada5hi/trapi.git",
53
+ "directory": "packages/swagger"
50
54
  },
51
55
  "bugs": {
52
56
  "url": "https://github.com/Tada5hi/trapi/issues"
@@ -63,5 +67,5 @@
63
67
  "access": "public"
64
68
  },
65
69
  "engineStrict": true,
66
- "gitHead": "12fc7cc4be787779fee81bedb9a4cff0e2f5055d"
70
+ "gitHead": "769f19ac38122c322327fe2ab7633306115cdf5f"
67
71
  }
@@ -1,7 +0,0 @@
1
- import { GeneratorOutput, MetadataGenerator } from '@trapi/metadata';
2
- import { Specification } from './type';
3
- import { AbstractSpecGenerator } from './abstract';
4
- export declare function removeRepeatingCharacter(str: string, character: string): string;
5
- export declare function removeFinalCharacter(str: string, character: string): string;
6
- export declare function createSpecGenerator(metadata: GeneratorOutput | MetadataGenerator, config?: Specification.Config): AbstractSpecGenerator<any, any>;
7
- //# sourceMappingURL=utils.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/specification/utils.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAC;AACvC,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAInD,wBAAgB,wBAAwB,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAI,MAAM,CAEhF;AAED,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,UAMlE;AAED,wBAAgB,mBAAmB,CAC/B,QAAQ,EAAE,eAAe,GAAG,iBAAiB,EAC7C,MAAM,GAAE,aAAa,CAAC,MAAW,mCAkBpC"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/specification/utils.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,8CAA8C;AAC9C,8CAAqE;AACrE,iCAAuC;AAEvC,6BAA6C;AAC7C,6BAA6C;AAE7C,SAAgB,wBAAwB,CAAC,GAAW,EAAE,SAAiB;IACnE,OAAO,GAAG,CAAC,OAAO,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC;AAC/C,CAAC;AAFD,4DAEC;AAED,SAAgB,oBAAoB,CAAC,GAAW,EAAE,SAAiB;IAC/D,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,SAAS,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE;QAC/D,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;KAC1B;IAED,OAAO,GAAG,CAAC;AACf,CAAC;AAND,oDAMC;AAED,SAAgB,mBAAmB,CAC/B,QAA6C,EAC7C,SAA+B,EAAE;IAEjC,MAAM,IAAI,GAAoB,QAAQ,YAAY,4BAAiB,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;IAErG,MAAM,YAAY,GAAsC,MAAM,CAAC,aAAa,IAAI,oBAAa,CAAC,mBAAmB,CAAC,EAAE,CAAC;IAErH,IAAI,aAA8C,CAAC;IAEnD,QAAQ,YAAY,EAAE;QAClB,KAAK,oBAAa,CAAC,mBAAmB,CAAC,EAAE;YACrC,aAAa,GAAG,IAAI,0BAAqB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YACxD,MAAM;QACV,KAAK,oBAAa,CAAC,mBAAmB,CAAC,EAAE;YACrC,aAAa,GAAG,IAAI,0BAAqB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YACxD,MAAM;KACb;IAED,OAAO,aAAa,CAAC;AACzB,CAAC;AApBD,kDAoBC"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,eAAe,EAAE,MAAM,IAAI,cAAc,EAA2B,MAAM,iBAAiB,CAAC;AACrG,OAAO,EAAE,aAAa,EAAuB,MAAM,iBAAiB,CAAC;AACrE,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,MAAM,QAAQ,CAAC;AAEpE,wBAAsB,qBAAqB,CACvC,MAAM,EAAE;IACJ,QAAQ,EAAE,cAAc,CAAC;IACzB,OAAO,EAAE,aAAa,CAAC,MAAM,CAAA;CAChC,EACD,QAAQ,CAAC,EAAE,eAAe,GAAG,OAAO,GACrC,OAAO,CAAC,MAAM,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,CAAC,CAS7D"}
package/dist/utils.js.map DELETED
@@ -1 +0,0 @@
1
- {"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;;;;;;;AAEH,8CAAqG;AACrG,mDAAqE;AAGrE,SAAsB,qBAAqB,CACvC,MAGC,EACD,QAAoC;;QAEpC,MAAM,iBAAiB,GAAG,IAAA,kCAAuB,EAAC,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAE7E,MAAM,QAAQ,GAAG,iBAAiB,CAAC,QAAQ,EAAE,CAAC;QAE9C,MAAM,aAAa,GAAG,IAAA,mCAAmB,EAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;QAEpE,aAAa,CAAC,KAAK,EAAE,CAAC;QACtB,OAAO,aAAa,CAAC,IAAI,EAAE,CAAC;IAChC,CAAC;CAAA;AAfD,sDAeC"}