swagger-typescript-api 10.0.0 → 10.0.2

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 (56) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +284 -260
  3. package/index.d.ts +7 -1
  4. package/index.js +115 -115
  5. package/package.json +116 -113
  6. package/src/apiConfig.js +30 -30
  7. package/src/common.js +28 -28
  8. package/src/components.js +3 -5
  9. package/src/config.js +4 -0
  10. package/src/constants.js +7 -0
  11. package/src/filePrefix.js +14 -14
  12. package/src/files.js +6 -6
  13. package/src/formatFileContent.js +13 -6
  14. package/src/index.js +271 -270
  15. package/src/logger.js +59 -59
  16. package/src/modelNames.js +78 -78
  17. package/src/modelTypes.js +31 -30
  18. package/src/output.js +165 -166
  19. package/src/prettierOptions.js +23 -23
  20. package/src/render/utils/fmtToJSDocLine.js +10 -10
  21. package/src/render/utils/index.js +31 -23
  22. package/src/render/utils/templateRequire.js +17 -17
  23. package/src/routeNames.js +46 -46
  24. package/src/routes.js +4 -1
  25. package/src/schema.js +87 -64
  26. package/src/swagger.js +4 -1
  27. package/src/templates.js +155 -132
  28. package/src/translators/JavaScript.js +60 -60
  29. package/src/typeFormatters.js +121 -75
  30. package/src/utils/id.js +9 -9
  31. package/src/utils/random.js +14 -14
  32. package/src/utils/resolveName.js +97 -97
  33. package/templates/README.md +17 -13
  34. package/templates/base/README.md +7 -7
  35. package/templates/base/data-contract-jsdoc.ejs +32 -0
  36. package/templates/base/data-contracts.ejs +28 -0
  37. package/templates/base/enum-data-contract.ejs +15 -0
  38. package/templates/base/{http-client.eta → http-client.ejs} +2 -2
  39. package/templates/base/http-clients/{axios-http-client.eta → axios-http-client.ejs} +133 -145
  40. package/templates/base/http-clients/{fetch-http-client.eta → fetch-http-client.ejs} +222 -222
  41. package/templates/base/interface-data-contract.ejs +10 -0
  42. package/templates/base/object-field-jsdoc.ejs +28 -0
  43. package/templates/base/{route-docs.eta → route-docs.ejs} +31 -31
  44. package/templates/base/{route-name.eta → route-name.ejs} +42 -42
  45. package/templates/base/{route-type.eta → route-type.ejs} +21 -21
  46. package/templates/base/type-data-contract.ejs +15 -0
  47. package/templates/default/README.md +6 -6
  48. package/templates/default/{api.eta → api.ejs} +65 -65
  49. package/templates/default/{procedure-call.eta → procedure-call.ejs} +98 -98
  50. package/templates/default/{route-types.eta → route-types.ejs} +28 -28
  51. package/templates/modular/README.md +6 -6
  52. package/templates/modular/{api.eta → api.ejs} +28 -28
  53. package/templates/modular/{procedure-call.eta → procedure-call.ejs} +98 -98
  54. package/templates/modular/{route-types.eta → route-types.ejs} +18 -18
  55. package/CHANGELOG.md +0 -866
  56. package/templates/base/data-contracts.eta +0 -45
package/templates/base/data-contracts.eta DELETED
@@ -1,45 +0,0 @@
1
- <%
2
- const { modelTypes, utils } = it;
3
- const { formatDescription, require, _ } = utils;
4
-
5
-
6
- const dataContractTemplates = {
7
- enum: (contract) => {
8
- return `enum ${contract.name} {\r\n${contract.content} \r\n }`;
9
- },
10
- interface: (contract) => {
11
- return `interface ${contract.name} {\r\n${contract.content}}`;
12
- },
13
- type: (contract) => {
14
- return `type ${contract.name} = ${contract.content}`;
15
- },
16
- }
17
-
18
- const createDescription = (contract) => {
19
- if (!contract.typeData) return _.compact([contract.description]);
20
-
21
- return _.compact([
22
- contract.description && formatDescription(contract.description),
23
- contract.typeData.deprecated === true && '@deprecated',
24
- !_.isUndefined(contract.typeData.format) && `@format ${contract.typeData.format}`,
25
- !_.isUndefined(contract.typeData.minimum) && `@min ${contract.typeData.minimum}`,
26
- !_.isUndefined(contract.typeData.maximum) && `@max ${contract.typeData.maximum}`,
27
- !_.isUndefined(contract.typeData.pattern) && `@pattern ${contract.typeData.pattern}`,
28
- !_.isUndefined(contract.typeData.example) && `@example ${
29
- _.isObject(contract.typeData.example) ? JSON.stringify(contract.typeData.example) : contract.typeData.example
30
- }`,
31
- ]);
32
- }
33
- %>
34
- <% modelTypes.forEach((contract) => { %>
35
- <% const description = createDescription(contract); %>
36
- <% if (description.length) { %>
37
- /**
38
- <%~ description.map(part => `* ${part}`).join("\n") %>
39
-
40
- */
41
- <% } %>
42
- export <%~ (dataContractTemplates[contract.typeIdentifier] || dataContractTemplates.type)(contract) %>
43
-
44
-
45
- <% }) %>