@twin.org/ts-to-schema 0.0.1-next.9 → 0.0.2-next.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/docs/changelog.md CHANGED
@@ -1,5 +1,229 @@
1
1
  # @twin.org/ts-to-schema - Changelog
2
2
 
3
- ## v0.0.1-next.9
3
+ ## [0.0.2-next.1](https://github.com/twinfoundation/tools/compare/ts-to-schema-v0.0.2-next.0...ts-to-schema-v0.0.2-next.1) (2025-07-14)
4
+
5
+
6
+ ### Features
7
+
8
+ * add support for auto expand types ([dd1e10a](https://github.com/twinfoundation/tools/commit/dd1e10a5b2fea6f80890ff6f3971f48e239cb4c1))
9
+ * add ts-to-schema overrides ([3c54504](https://github.com/twinfoundation/tools/commit/3c5450468eb998204a75576b7791a7ca4027da62))
10
+ * generate schemas as individual entities ([9f372ab](https://github.com/twinfoundation/tools/commit/9f372abdfc27aba93b303c7b214991919c0c18c3))
11
+ * improve schema type name normalisation ([1a18b26](https://github.com/twinfoundation/tools/commit/1a18b267d87e9179bda01b396b256c450ae2889e))
12
+ * move package to framework repo ([4490bda](https://github.com/twinfoundation/tools/commit/4490bda472d4dc8ddfe931e2fce81f3411de9ab3))
13
+ * use most recent JSON schema specs ([4598cbf](https://github.com/twinfoundation/tools/commit/4598cbf29f7b82dba4a9f3b19f81dfe66f5a6060))
14
+ * use shared store mechanism ([#31](https://github.com/twinfoundation/tools/issues/31)) ([d9fe68b](https://github.com/twinfoundation/tools/commit/d9fe68b903d1268c7cb3c64772df5cb78fd63667))
15
+
16
+
17
+ ### Bug Fixes
18
+
19
+ * remove debugging ([4def3d1](https://github.com/twinfoundation/tools/commit/4def3d1ef6a41a3b3358f864214e6a7ec3f9c638))
20
+
21
+
22
+ ### Dependencies
23
+
24
+ * The following workspace dependencies were updated
25
+ * dependencies
26
+ * @twin.org/tools-core bumped from 0.0.2-next.0 to 0.0.2-next.1
27
+
28
+ ## 0.0.1 (2025-07-03)
29
+
30
+
31
+ ### Features
32
+
33
+ * release to production ([ad24b7e](https://github.com/twinfoundation/tools/commit/ad24b7eb16784165b6c93b5c48788199f0e17526))
34
+
35
+ ## [0.0.1-next.29](https://github.com/twinfoundation/tools/compare/ts-to-schema-v0.0.1-next.28...ts-to-schema-v0.0.1-next.29) (2025-07-02)
36
+
37
+
38
+ ### Features
39
+
40
+ * move package to framework repo ([4490bda](https://github.com/twinfoundation/tools/commit/4490bda472d4dc8ddfe931e2fce81f3411de9ab3))
41
+
42
+ ## [0.0.1-next.28](https://github.com/twinfoundation/tools/compare/ts-to-schema-v0.0.1-next.27...ts-to-schema-v0.0.1-next.28) (2025-06-18)
43
+
44
+
45
+ ### Features
46
+
47
+ * improve schema type name normalisation ([1a18b26](https://github.com/twinfoundation/tools/commit/1a18b267d87e9179bda01b396b256c450ae2889e))
48
+
49
+
50
+ ### Dependencies
51
+
52
+ * The following workspace dependencies were updated
53
+ * dependencies
54
+ * @twin.org/nameof bumped from 0.0.1-next.27 to 0.0.1-next.28
55
+ * devDependencies
56
+ * @twin.org/merge-locales bumped from 0.0.1-next.27 to 0.0.1-next.28
57
+ * @twin.org/nameof-transformer bumped from 0.0.1-next.27 to 0.0.1-next.28
58
+ * @twin.org/nameof-vitest-plugin bumped from 0.0.1-next.27 to 0.0.1-next.28
59
+
60
+ ## [0.0.1-next.27](https://github.com/twinfoundation/tools/compare/ts-to-schema-v0.0.1-next.26...ts-to-schema-v0.0.1-next.27) (2025-06-17)
61
+
62
+
63
+ ### Miscellaneous Chores
64
+
65
+ * **ts-to-schema:** Synchronize repo versions
66
+
67
+
68
+ ### Dependencies
69
+
70
+ * The following workspace dependencies were updated
71
+ * dependencies
72
+ * @twin.org/nameof bumped from 0.0.1-next.26 to 0.0.1-next.27
73
+ * devDependencies
74
+ * @twin.org/merge-locales bumped from 0.0.1-next.26 to 0.0.1-next.27
75
+ * @twin.org/nameof-transformer bumped from 0.0.1-next.26 to 0.0.1-next.27
76
+ * @twin.org/nameof-vitest-plugin bumped from 0.0.1-next.26 to 0.0.1-next.27
77
+
78
+ ## [0.0.1-next.26](https://github.com/twinfoundation/tools/compare/ts-to-schema-v0.0.1-next.25...ts-to-schema-v0.0.1-next.26) (2025-06-11)
79
+
80
+
81
+ ### Features
82
+
83
+ * use most recent JSON schema specs ([4598cbf](https://github.com/twinfoundation/tools/commit/4598cbf29f7b82dba4a9f3b19f81dfe66f5a6060))
84
+
85
+
86
+ ### Dependencies
87
+
88
+ * The following workspace dependencies were updated
89
+ * dependencies
90
+ * @twin.org/nameof bumped from 0.0.1-next.25 to 0.0.1-next.26
91
+ * devDependencies
92
+ * @twin.org/merge-locales bumped from 0.0.1-next.25 to 0.0.1-next.26
93
+ * @twin.org/nameof-transformer bumped from 0.0.1-next.25 to 0.0.1-next.26
94
+ * @twin.org/nameof-vitest-plugin bumped from 0.0.1-next.25 to 0.0.1-next.26
95
+
96
+ ## [0.0.1-next.25](https://github.com/twinfoundation/tools/compare/ts-to-schema-v0.0.1-next.24...ts-to-schema-v0.0.1-next.25) (2025-06-10)
97
+
98
+
99
+ ### Features
100
+
101
+ * add ts-to-schema overrides ([3c54504](https://github.com/twinfoundation/tools/commit/3c5450468eb998204a75576b7791a7ca4027da62))
102
+
103
+
104
+ ### Dependencies
105
+
106
+ * The following workspace dependencies were updated
107
+ * dependencies
108
+ * @twin.org/nameof bumped from 0.0.1-next.24 to 0.0.1-next.25
109
+ * devDependencies
110
+ * @twin.org/merge-locales bumped from 0.0.1-next.24 to 0.0.1-next.25
111
+ * @twin.org/nameof-transformer bumped from 0.0.1-next.24 to 0.0.1-next.25
112
+ * @twin.org/nameof-vitest-plugin bumped from 0.0.1-next.24 to 0.0.1-next.25
113
+
114
+ ## [0.0.1-next.24](https://github.com/twinfoundation/tools/compare/ts-to-schema-v0.0.1-next.23...ts-to-schema-v0.0.1-next.24) (2025-06-05)
115
+
116
+
117
+ ### Miscellaneous Chores
118
+
119
+ * **ts-to-schema:** Synchronize repo versions
120
+
121
+
122
+ ### Dependencies
123
+
124
+ * The following workspace dependencies were updated
125
+ * dependencies
126
+ * @twin.org/nameof bumped from 0.0.1-next.23 to 0.0.1-next.24
127
+ * devDependencies
128
+ * @twin.org/merge-locales bumped from 0.0.1-next.23 to 0.0.1-next.24
129
+ * @twin.org/nameof-transformer bumped from 0.0.1-next.23 to 0.0.1-next.24
130
+ * @twin.org/nameof-vitest-plugin bumped from 0.0.1-next.23 to 0.0.1-next.24
131
+
132
+ ## [0.0.1-next.23](https://github.com/twinfoundation/tools/compare/ts-to-schema-v0.0.1-next.22...ts-to-schema-v0.0.1-next.23) (2025-06-03)
133
+
134
+
135
+ ### Miscellaneous Chores
136
+
137
+ * **ts-to-schema:** Synchronize repo versions
138
+
139
+
140
+ ### Dependencies
141
+
142
+ * The following workspace dependencies were updated
143
+ * dependencies
144
+ * @twin.org/nameof bumped from 0.0.1-next.22 to 0.0.1-next.23
145
+ * devDependencies
146
+ * @twin.org/merge-locales bumped from 0.0.1-next.22 to 0.0.1-next.23
147
+ * @twin.org/nameof-transformer bumped from 0.0.1-next.22 to 0.0.1-next.23
148
+ * @twin.org/nameof-vitest-plugin bumped from 0.0.1-next.22 to 0.0.1-next.23
149
+
150
+ ## [0.0.1-next.22](https://github.com/twinfoundation/tools/compare/ts-to-schema-v0.0.1-next.21...ts-to-schema-v0.0.1-next.22) (2025-06-03)
151
+
152
+
153
+ ### Features
154
+
155
+ * generate schemas as individual entities ([9f372ab](https://github.com/twinfoundation/tools/commit/9f372abdfc27aba93b303c7b214991919c0c18c3))
156
+
157
+
158
+ ### Bug Fixes
159
+
160
+ * remove debugging ([4def3d1](https://github.com/twinfoundation/tools/commit/4def3d1ef6a41a3b3358f864214e6a7ec3f9c638))
161
+
162
+
163
+ ### Dependencies
164
+
165
+ * The following workspace dependencies were updated
166
+ * dependencies
167
+ * @twin.org/nameof bumped from 0.0.1-next.21 to 0.0.1-next.22
168
+ * devDependencies
169
+ * @twin.org/merge-locales bumped from 0.0.1-next.21 to 0.0.1-next.22
170
+ * @twin.org/nameof-transformer bumped from 0.0.1-next.21 to 0.0.1-next.22
171
+ * @twin.org/nameof-vitest-plugin bumped from 0.0.1-next.21 to 0.0.1-next.22
172
+
173
+ ## [0.0.1-next.21](https://github.com/twinfoundation/tools/compare/ts-to-schema-v0.0.1-next.20...ts-to-schema-v0.0.1-next.21) (2025-04-17)
174
+
175
+
176
+ ### Features
177
+
178
+ * use shared store mechanism ([#31](https://github.com/twinfoundation/tools/issues/31)) ([d9fe68b](https://github.com/twinfoundation/tools/commit/d9fe68b903d1268c7cb3c64772df5cb78fd63667))
179
+
180
+
181
+ ### Dependencies
182
+
183
+ * The following workspace dependencies were updated
184
+ * dependencies
185
+ * @twin.org/nameof bumped from 0.0.1-next.20 to 0.0.1-next.21
186
+ * devDependencies
187
+ * @twin.org/merge-locales bumped from 0.0.1-next.20 to 0.0.1-next.21
188
+ * @twin.org/nameof-transformer bumped from 0.0.1-next.20 to 0.0.1-next.21
189
+ * @twin.org/nameof-vitest-plugin bumped from 0.0.1-next.20 to 0.0.1-next.21
190
+
191
+ ## [0.0.1-next.20](https://github.com/twinfoundation/tools/compare/ts-to-schema-v0.0.1-next.19...ts-to-schema-v0.0.1-next.20) (2025-03-28)
192
+
193
+
194
+ ### Miscellaneous Chores
195
+
196
+ * **ts-to-schema:** Synchronize repo versions
197
+
198
+
199
+ ### Dependencies
200
+
201
+ * The following workspace dependencies were updated
202
+ * dependencies
203
+ * @twin.org/nameof bumped from 0.0.1-next.19 to 0.0.1-next.20
204
+ * devDependencies
205
+ * @twin.org/merge-locales bumped from 0.0.1-next.19 to 0.0.1-next.20
206
+ * @twin.org/nameof-transformer bumped from 0.0.1-next.19 to 0.0.1-next.20
207
+ * @twin.org/nameof-vitest-plugin bumped from 0.0.1-next.19 to 0.0.1-next.20
208
+
209
+ ## [0.0.1-next.19](https://github.com/twinfoundation/tools/compare/ts-to-schema-v0.0.1-next.18...ts-to-schema-v0.0.1-next.19) (2025-03-26)
210
+
211
+
212
+ ### Miscellaneous Chores
213
+
214
+ * **ts-to-schema:** Synchronize repo versions
215
+
216
+
217
+ ### Dependencies
218
+
219
+ * The following workspace dependencies were updated
220
+ * dependencies
221
+ * @twin.org/nameof bumped from 0.0.1-next.18 to 0.0.1-next.19
222
+ * devDependencies
223
+ * @twin.org/merge-locales bumped from 0.0.1-next.18 to 0.0.1-next.19
224
+ * @twin.org/nameof-transformer bumped from 0.0.1-next.18 to 0.0.1-next.19
225
+ * @twin.org/nameof-vitest-plugin bumped from 0.0.1-next.18 to 0.0.1-next.19
226
+
227
+ ## v0.0.1-next.18
4
228
 
5
229
  - Initial Release
@@ -8,13 +8,13 @@ The main entry point for the CLI.
8
8
 
9
9
  ## Constructors
10
10
 
11
- ### new CLI()
11
+ ### Constructor
12
12
 
13
- > **new CLI**(): [`CLI`](CLI.md)
13
+ > **new CLI**(): `CLI`
14
14
 
15
15
  #### Returns
16
16
 
17
- [`CLI`](CLI.md)
17
+ `CLI`
18
18
 
19
19
  #### Inherited from
20
20
 
@@ -24,25 +24,31 @@ The main entry point for the CLI.
24
24
 
25
25
  ### run()
26
26
 
27
- > **run**(`argv`, `localesDirectory`?, `options`?): `Promise`\<`number`\>
27
+ > **run**(`argv`, `localesDirectory?`, `options?`): `Promise`\<`number`\>
28
28
 
29
29
  Run the app.
30
30
 
31
31
  #### Parameters
32
32
 
33
- **argv**: `string`[]
33
+ ##### argv
34
+
35
+ `string`[]
34
36
 
35
37
  The process arguments.
36
38
 
37
- **localesDirectory?**: `string`
39
+ ##### localesDirectory?
40
+
41
+ `string`
38
42
 
39
43
  The directory for the locales, default to relative to the script.
40
44
 
41
- **options?**
45
+ ##### options?
42
46
 
43
47
  Additional options.
44
48
 
45
- **options.overrideOutputWidth?**: `number`
49
+ ###### overrideOutputWidth?
50
+
51
+ `number`
46
52
 
47
53
  Override the output width.
48
54
 
@@ -62,7 +68,9 @@ Configure any options or actions at the root program level.
62
68
 
63
69
  #### Parameters
64
70
 
65
- **program**: `Command`
71
+ ##### program
72
+
73
+ `Command`
66
74
 
67
75
  The root program command.
68
76
 
@@ -6,15 +6,21 @@ Action the root command.
6
6
 
7
7
  ## Parameters
8
8
 
9
- **configFile**: `string`
9
+ ### configFile
10
+
11
+ `string`
10
12
 
11
13
  The optional configuration file.
12
14
 
13
- **outputFolder**: `string`
15
+ ### outputFolder
16
+
17
+ `string`
14
18
 
15
19
  The output folder for the schemas.
16
20
 
17
- **opts**: `unknown`
21
+ ### opts
22
+
23
+ `unknown`
18
24
 
19
25
  The options for the command.
20
26
 
@@ -6,7 +6,9 @@ Build the root command to be consumed by the CLI.
6
6
 
7
7
  ## Parameters
8
8
 
9
- **program**: `Command`
9
+ ### program
10
+
11
+ `Command`
10
12
 
11
13
  The command to build on.
12
14
 
@@ -6,15 +6,21 @@ Convert the TypeScript definitions to JSON Schemas.
6
6
 
7
7
  ## Parameters
8
8
 
9
- **config**: [`ITsToSchemaConfig`](../interfaces/ITsToSchemaConfig.md)
9
+ ### config
10
+
11
+ [`ITsToSchemaConfig`](../interfaces/ITsToSchemaConfig.md)
10
12
 
11
13
  The configuration for the app.
12
14
 
13
- **outputFolder**: `string`
15
+ ### outputFolder
16
+
17
+ `string`
14
18
 
15
19
  The location of the folder to output the JSON schemas.
16
20
 
17
- **workingDirectory**: `string`
21
+ ### workingDirectory
22
+
23
+ `string`
18
24
 
19
25
  The folder the app was run from.
20
26
 
@@ -12,28 +12,40 @@ The base url for the type references e.g. https://schema.twindev.org/my-namespac
12
12
 
13
13
  ***
14
14
 
15
- ### sources
15
+ ### types
16
16
 
17
- > **sources**: `string`[]
17
+ > **types**: `string`[]
18
18
 
19
- The list of glob sources that can be used to generate the schemas.
19
+ The source files to generate the types from.
20
20
 
21
21
  ***
22
22
 
23
- ### types
23
+ ### externalReferences?
24
24
 
25
- > **types**: `string`[]
25
+ > `optional` **externalReferences**: `object`
26
+
27
+ External type references.
28
+
29
+ #### Index Signature
26
30
 
27
- The list of types to generate.
31
+ \[`id`: `string`\]: `string`
28
32
 
29
33
  ***
30
34
 
31
- ### externalReferences?
35
+ ### overrides?
32
36
 
33
- > `optional` **externalReferences**: `object`
37
+ > `optional` **overrides**: `object`
34
38
 
35
- External type references
39
+ Override for specific types, to be used when the type cannot be generated automatically, or is generated incorrectly.
36
40
 
37
41
  #### Index Signature
38
42
 
39
- \[`id`: `string`\]: `string`
43
+ \[`id`: `string`\]: `AnySchemaObject`
44
+
45
+ ***
46
+
47
+ ### autoExpandTypes?
48
+
49
+ > `optional` **autoExpandTypes**: `string`[]
50
+
51
+ The types to automatically expand inline in type definitions, reg ex string matches.
package/locales/en.json CHANGED
@@ -22,8 +22,8 @@
22
22
  "progress": {
23
23
  "loadingConfigJson": "Loading Config JSON",
24
24
  "creatingWorkingDir": "Creating Working Directory",
25
- "generatingSchemas": "Generating Schemas",
26
- "finalisingSchemas": "Finalising Schemas",
25
+ "generatingSchema": "Generating Schema",
26
+ "overridingSchema": "Overriding Schema",
27
27
  "writingSchemas": "Writing Schemas",
28
28
  "writingSchema": "Writing Schema",
29
29
  "models": "Models"
package/package.json CHANGED
@@ -1,11 +1,11 @@
1
1
  {
2
2
  "name": "@twin.org/ts-to-schema",
3
- "version": "0.0.1-next.9",
3
+ "version": "0.0.2-next.1",
4
4
  "description": "Tool to convert TypeScript definitions to JSON schemas",
5
5
  "repository": {
6
6
  "type": "git",
7
7
  "url": "git+https://github.com/twinfoundation/tools.git",
8
- "directory": "packages/ts-to-schema"
8
+ "directory": "apps/ts-to-schema"
9
9
  },
10
10
  "author": "martyn.janes@iota.org",
11
11
  "license": "Apache-2.0",
@@ -16,20 +16,20 @@
16
16
  "dependencies": {
17
17
  "@twin.org/cli-core": "next",
18
18
  "@twin.org/core": "next",
19
- "@twin.org/nameof": "0.0.1-next.9",
20
- "commander": "12.1.0",
21
- "glob": "11.0.0",
22
- "jsonschema": "1.4.1",
23
- "ts-json-schema-generator": "2.4.0-next.1"
19
+ "@twin.org/nameof": "next",
20
+ "@twin.org/tools-core": "0.0.2-next.1",
21
+ "commander": "14.0.0",
22
+ "glob": "11.0.2",
23
+ "ts-json-schema-generator": "2.4.0"
24
24
  },
25
25
  "main": "./dist/cjs/index.cjs",
26
26
  "module": "./dist/esm/index.mjs",
27
27
  "types": "./dist/types/index.d.ts",
28
28
  "exports": {
29
29
  ".": {
30
+ "types": "./dist/types/index.d.ts",
30
31
  "require": "./dist/cjs/index.cjs",
31
- "import": "./dist/esm/index.mjs",
32
- "types": "./dist/types/index.d.ts"
32
+ "import": "./dist/esm/index.mjs"
33
33
  }
34
34
  },
35
35
  "files": [