@twin.org/tools-core 0.0.3-next.15 → 0.0.3-next.16

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 (132) hide show
  1. package/dist/es/index.js +20 -11
  2. package/dist/es/index.js.map +1 -1
  3. package/dist/es/models/ITypeScriptToSchemaContext.js +2 -0
  4. package/dist/es/models/ITypeScriptToSchemaContext.js.map +1 -0
  5. package/dist/es/models/ITypeScriptToSchemaDiagnostics.js +4 -0
  6. package/dist/es/models/ITypeScriptToSchemaDiagnostics.js.map +1 -0
  7. package/dist/es/models/ITypeScriptToSchemaOptions.js +4 -0
  8. package/dist/es/models/ITypeScriptToSchemaOptions.js.map +1 -0
  9. package/dist/es/utils/constants.js +43 -0
  10. package/dist/es/utils/constants.js.map +1 -0
  11. package/dist/es/utils/diagnosticReporter.js +32 -0
  12. package/dist/es/utils/diagnosticReporter.js.map +1 -0
  13. package/dist/es/utils/disallowedTypeGuard.js +151 -0
  14. package/dist/es/utils/disallowedTypeGuard.js.map +1 -0
  15. package/dist/es/utils/enum.js +152 -0
  16. package/dist/es/utils/enum.js.map +1 -0
  17. package/dist/es/utils/fileUtils.js +130 -0
  18. package/dist/es/utils/fileUtils.js.map +1 -0
  19. package/dist/es/utils/importTypeQuerySchemaResolver.js +328 -0
  20. package/dist/es/utils/importTypeQuerySchemaResolver.js.map +1 -0
  21. package/dist/es/utils/indexSignaturePatternResolver.js +94 -0
  22. package/dist/es/utils/indexSignaturePatternResolver.js.map +1 -0
  23. package/dist/es/utils/intersectionSchemaMerger.js +85 -0
  24. package/dist/es/utils/intersectionSchemaMerger.js.map +1 -0
  25. package/dist/es/utils/jsonSchemaBuilder.js +3189 -0
  26. package/dist/es/utils/jsonSchemaBuilder.js.map +1 -0
  27. package/dist/es/utils/mappedTypeSchemaResolver.js +231 -0
  28. package/dist/es/utils/mappedTypeSchemaResolver.js.map +1 -0
  29. package/dist/es/utils/objectTransformer.js +162 -0
  30. package/dist/es/utils/objectTransformer.js.map +1 -0
  31. package/dist/es/utils/regEx.js +128 -0
  32. package/dist/es/utils/regEx.js.map +1 -0
  33. package/dist/es/utils/resolver.js +164 -0
  34. package/dist/es/utils/resolver.js.map +1 -0
  35. package/dist/es/utils/templateLiteralPatternBuilder.js +94 -0
  36. package/dist/es/utils/templateLiteralPatternBuilder.js.map +1 -0
  37. package/dist/es/utils/typeScriptToSchema.js +102 -0
  38. package/dist/es/utils/typeScriptToSchema.js.map +1 -0
  39. package/dist/es/utils/utility.js +134 -0
  40. package/dist/es/utils/utility.js.map +1 -0
  41. package/dist/es/utils/utilityTypeSchemaMapper.js +412 -0
  42. package/dist/es/utils/utilityTypeSchemaMapper.js.map +1 -0
  43. package/dist/types/index.d.ts +20 -11
  44. package/dist/types/models/ITypeScriptToSchemaContext.d.ts +64 -0
  45. package/dist/types/models/ITypeScriptToSchemaDiagnostics.d.ts +31 -0
  46. package/dist/types/models/ITypeScriptToSchemaOptions.d.ts +22 -0
  47. package/dist/types/utils/constants.d.ts +13 -0
  48. package/dist/types/utils/diagnosticReporter.d.ts +17 -0
  49. package/dist/types/utils/disallowedTypeGuard.d.ts +16 -0
  50. package/dist/types/utils/enum.d.ts +42 -0
  51. package/dist/types/utils/fileUtils.d.ts +66 -0
  52. package/dist/types/utils/importTypeQuerySchemaResolver.d.ts +52 -0
  53. package/dist/types/utils/indexSignaturePatternResolver.d.ts +21 -0
  54. package/dist/types/utils/intersectionSchemaMerger.d.ts +16 -0
  55. package/dist/types/utils/jsonSchemaBuilder.d.ts +721 -0
  56. package/dist/types/utils/mappedTypeSchemaResolver.d.ts +46 -0
  57. package/dist/types/utils/objectTransformer.d.ts +33 -0
  58. package/dist/types/utils/regEx.d.ts +24 -0
  59. package/dist/types/utils/resolver.d.ts +16 -0
  60. package/dist/types/utils/templateLiteralPatternBuilder.d.ts +12 -0
  61. package/dist/types/utils/typeScriptToSchema.d.ts +31 -0
  62. package/dist/types/utils/utility.d.ts +58 -0
  63. package/dist/types/utils/utilityTypeSchemaMapper.d.ts +92 -0
  64. package/docs/changelog.md +15 -1
  65. package/docs/examples.md +55 -148
  66. package/docs/reference/classes/Constants.md +29 -0
  67. package/docs/reference/classes/DiagnosticReporter.md +49 -0
  68. package/docs/reference/classes/DisallowedTypeGuard.md +35 -0
  69. package/docs/reference/classes/Enum.md +93 -0
  70. package/docs/reference/classes/FileUtils.md +237 -0
  71. package/docs/reference/classes/ImportTypeQuerySchemaResolver.md +87 -0
  72. package/docs/reference/classes/IndexSignaturePatternResolver.md +69 -0
  73. package/docs/reference/classes/IntersectionSchemaMerger.md +48 -0
  74. package/docs/reference/classes/JsonSchemaBuilder.md +2772 -0
  75. package/docs/reference/classes/MappedTypeSchemaResolver.md +211 -0
  76. package/docs/reference/classes/ObjectTransformer.md +119 -0
  77. package/docs/reference/classes/RegEx.md +99 -0
  78. package/docs/reference/classes/Resolver.md +41 -0
  79. package/docs/reference/classes/TemplateLiteralPatternBuilder.md +35 -0
  80. package/docs/reference/classes/TypeScriptToSchema.md +91 -0
  81. package/docs/reference/classes/Utility.md +164 -0
  82. package/docs/reference/classes/UtilityTypeSchemaMapper.md +341 -0
  83. package/docs/reference/index.md +20 -14
  84. package/docs/reference/interfaces/ITypeScriptToSchemaContext.md +113 -0
  85. package/docs/reference/interfaces/ITypeScriptToSchemaDiagnostics.md +55 -0
  86. package/docs/reference/interfaces/ITypeScriptToSchemaOptions.md +44 -0
  87. package/locales/en.json +30 -1
  88. package/package.json +3 -2
  89. package/dist/es/models/IJsonSchema.js +0 -2
  90. package/dist/es/models/IJsonSchema.js.map +0 -1
  91. package/dist/es/models/IOpenApi.js +0 -2
  92. package/dist/es/models/IOpenApi.js.map +0 -1
  93. package/dist/es/models/IOpenApiExample.js +0 -4
  94. package/dist/es/models/IOpenApiExample.js.map +0 -1
  95. package/dist/es/models/IOpenApiHeader.js +0 -4
  96. package/dist/es/models/IOpenApiHeader.js.map +0 -1
  97. package/dist/es/models/IOpenApiPathMethod.js +0 -2
  98. package/dist/es/models/IOpenApiPathMethod.js.map +0 -1
  99. package/dist/es/models/IOpenApiResponse.js +0 -2
  100. package/dist/es/models/IOpenApiResponse.js.map +0 -1
  101. package/dist/es/models/IOpenApiSecurityScheme.js +0 -4
  102. package/dist/es/models/IOpenApiSecurityScheme.js.map +0 -1
  103. package/dist/es/models/IPackageJson.js +0 -4
  104. package/dist/es/models/IPackageJson.js.map +0 -1
  105. package/dist/es/models/jsonTypeName.js +0 -2
  106. package/dist/es/models/jsonTypeName.js.map +0 -1
  107. package/dist/es/utils/jsonSchemaHelper.js +0 -282
  108. package/dist/es/utils/jsonSchemaHelper.js.map +0 -1
  109. package/dist/es/utils/openApiHelper.js +0 -12
  110. package/dist/es/utils/openApiHelper.js.map +0 -1
  111. package/dist/types/models/IJsonSchema.d.ts +0 -5
  112. package/dist/types/models/IOpenApi.d.ts +0 -54
  113. package/dist/types/models/IOpenApiExample.d.ts +0 -13
  114. package/dist/types/models/IOpenApiHeader.d.ts +0 -19
  115. package/dist/types/models/IOpenApiPathMethod.d.ts +0 -65
  116. package/dist/types/models/IOpenApiResponse.d.ts +0 -32
  117. package/dist/types/models/IOpenApiSecurityScheme.d.ts +0 -25
  118. package/dist/types/models/IPackageJson.d.ts +0 -15
  119. package/dist/types/models/jsonTypeName.d.ts +0 -5
  120. package/dist/types/utils/jsonSchemaHelper.d.ts +0 -78
  121. package/dist/types/utils/openApiHelper.d.ts +0 -9
  122. package/docs/reference/classes/JsonSchemaHelper.md +0 -233
  123. package/docs/reference/classes/OpenApiHelper.md +0 -21
  124. package/docs/reference/interfaces/IOpenApi.md +0 -103
  125. package/docs/reference/interfaces/IOpenApiExample.md +0 -19
  126. package/docs/reference/interfaces/IOpenApiHeader.md +0 -31
  127. package/docs/reference/interfaces/IOpenApiPathMethod.md +0 -119
  128. package/docs/reference/interfaces/IOpenApiResponse.md +0 -35
  129. package/docs/reference/interfaces/IOpenApiSecurityScheme.md +0 -43
  130. package/docs/reference/interfaces/IPackageJson.md +0 -23
  131. package/docs/reference/type-aliases/IJsonSchema.md +0 -5
  132. package/docs/reference/type-aliases/JsonTypeName.md +0 -5
package/docs/reference/interfaces/IOpenApiPathMethod.md DELETED
@@ -1,119 +0,0 @@
1
- # Interface: IOpenApiPathMethod
2
-
3
- The Open API config definition.
4
-
5
- ## Properties
6
-
7
- ### operationId
8
-
9
- > **operationId**: `string`
10
-
11
- The operation id.
12
-
13
- ***
14
-
15
- ### summary
16
-
17
- > **summary**: `string`
18
-
19
- Summary.
20
-
21
- ***
22
-
23
- ### tags?
24
-
25
- > `optional` **tags**: `string`[]
26
-
27
- Tags.
28
-
29
- ***
30
-
31
- ### parameters?
32
-
33
- > `optional` **parameters**: `object`[]
34
-
35
- Parameters.
36
-
37
- #### name
38
-
39
- > **name**: `string`
40
-
41
- #### in
42
-
43
- > **in**: `string`
44
-
45
- #### description?
46
-
47
- > `optional` **description**: `string`
48
-
49
- #### required
50
-
51
- > **required**: `boolean`
52
-
53
- #### schema
54
-
55
- > **schema**: `object`
56
-
57
- ##### schema.type?
58
-
59
- > `optional` **type**: `"string"` \| `"number"` \| `"boolean"` \| `"object"` \| `"integer"` \| `"null"` \| `"array"` \| (`"string"` \| `"number"` \| `"boolean"` \| `"object"` \| `"integer"` \| `"null"` \| `"array"`)[]
60
-
61
- ##### schema.enum?
62
-
63
- > `optional` **enum**: `AnySchemaObject`[]
64
-
65
- ##### schema.$ref?
66
-
67
- > `optional` **$ref**: `string`
68
-
69
- #### style?
70
-
71
- > `optional` **style**: `string`
72
-
73
- ***
74
-
75
- ### requestBody?
76
-
77
- > `optional` **requestBody**: `object`
78
-
79
- Request body.
80
-
81
- #### required
82
-
83
- > **required**: `boolean`
84
-
85
- #### description?
86
-
87
- > `optional` **description**: `string`
88
-
89
- #### content?
90
-
91
- > `optional` **content**: `object`
92
-
93
- ##### Index Signature
94
-
95
- \[`contentType`: `string`\]: `object`
96
-
97
- ***
98
-
99
- ### responses?
100
-
101
- > `optional` **responses**: `object`
102
-
103
- Response body.
104
-
105
- #### Index Signature
106
-
107
- \[`code`: `string`\]: [`IOpenApiResponse`](IOpenApiResponse.md)
108
-
109
- ***
110
-
111
- ### security?
112
-
113
- > `optional` **security**: `object`[]
114
-
115
- Security model for the API.
116
-
117
- #### Index Signature
118
-
119
- \[`name`: `string`\]: `string`[]
package/docs/reference/interfaces/IOpenApiResponse.md DELETED
@@ -1,35 +0,0 @@
1
- # Interface: IOpenApiResponse
2
-
3
- The Open API config definition.
4
-
5
- ## Properties
6
-
7
- ### description?
8
-
9
- > `optional` **description**: `string`
10
-
11
- Descriptions for the response.
12
-
13
- ***
14
-
15
- ### content?
16
-
17
- > `optional` **content**: `object`
18
-
19
- Content for the response.
20
-
21
- #### Index Signature
22
-
23
- \[`contentType`: `string`\]: `object`
24
-
25
- ***
26
-
27
- ### headers?
28
-
29
- > `optional` **headers**: `object`
30
-
31
- The headers for the response.
32
-
33
- #### Index Signature
34
-
35
- \[`id`: `string`\]: [`IOpenApiHeader`](IOpenApiHeader.md)
package/docs/reference/interfaces/IOpenApiSecurityScheme.md DELETED
@@ -1,43 +0,0 @@
1
- # Interface: IOpenApiSecurityScheme
2
-
3
- The Open API config definition for security scheme.
4
-
5
- ## Properties
6
-
7
- ### type?
8
-
9
- > `optional` **type**: `string`
10
-
11
- The type of the security schema.
12
-
13
- ***
14
-
15
- ### scheme?
16
-
17
- > `optional` **scheme**: `string`
18
-
19
- The scheme method.
20
-
21
- ***
22
-
23
- ### bearerFormat?
24
-
25
- > `optional` **bearerFormat**: `string`
26
-
27
- The bearer format.
28
-
29
- ***
30
-
31
- ### in?
32
-
33
- > `optional` **in**: `string`
34
-
35
- Where is the token located.
36
-
37
- ***
38
-
39
- ### name?
40
-
41
- > `optional` **name**: `string`
42
-
43
- What is the name of the token.
package/docs/reference/interfaces/IPackageJson.md DELETED
@@ -1,23 +0,0 @@
1
- # Interface: IPackageJson
2
-
3
- Configuration for each individual package.
4
-
5
- ## Properties
6
-
7
- ### name
8
-
9
- > **name**: `string`
10
-
11
- The name of the package.
12
-
13
- ***
14
-
15
- ### dependencies?
16
-
17
- > `optional` **dependencies**: `object`
18
-
19
- The dependencies for the package.
20
-
21
- #### Index Signature
22
-
23
- \[`id`: `string`\]: `string`
package/docs/reference/type-aliases/IJsonSchema.md DELETED
@@ -1,5 +0,0 @@
1
- # Type Alias: IJsonSchema
2
-
3
- > **IJsonSchema** = `AnySchemaObject`
4
-
5
- Default schema type.
package/docs/reference/type-aliases/JsonTypeName.md DELETED
@@ -1,5 +0,0 @@
1
- # Type Alias: JsonTypeName
2
-
3
- > **JsonTypeName** = `JSONType`
4
-
5
- Default schema type.