@twin.org/ts-to-schema 0.0.1-next.9 → 0.0.1

package/docs/changelog.md

@@ -1,5 +1,204 @@
 # @twin.org/ts-to-schema - Changelog
 
-## v0.0.1-next.9
+## 0.0.1 (2025-07-03)
+
+
+### Features
+
+* release to production ([ad24b7e](https://github.com/twinfoundation/tools/commit/ad24b7eb16784165b6c93b5c48788199f0e17526))
+
+## [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)
+
+
+### Features
+
+* move package to framework repo ([4490bda](https://github.com/twinfoundation/tools/commit/4490bda472d4dc8ddfe931e2fce81f3411de9ab3))
+
+## [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)
+
+
+### Features
+
+* improve schema type name normalisation ([1a18b26](https://github.com/twinfoundation/tools/commit/1a18b267d87e9179bda01b396b256c450ae2889e))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nameof bumped from 0.0.1-next.27 to 0.0.1-next.28
+  * devDependencies
+    * @twin.org/merge-locales bumped from 0.0.1-next.27 to 0.0.1-next.28
+    * @twin.org/nameof-transformer bumped from 0.0.1-next.27 to 0.0.1-next.28
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.1-next.27 to 0.0.1-next.28
+
+## [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)
+
+
+### Miscellaneous Chores
+
+* **ts-to-schema:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nameof bumped from 0.0.1-next.26 to 0.0.1-next.27
+  * devDependencies
+    * @twin.org/merge-locales bumped from 0.0.1-next.26 to 0.0.1-next.27
+    * @twin.org/nameof-transformer bumped from 0.0.1-next.26 to 0.0.1-next.27
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.1-next.26 to 0.0.1-next.27
+
+## [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)
+
+
+### Features
+
+* use most recent JSON schema specs ([4598cbf](https://github.com/twinfoundation/tools/commit/4598cbf29f7b82dba4a9f3b19f81dfe66f5a6060))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nameof bumped from 0.0.1-next.25 to 0.0.1-next.26
+  * devDependencies
+    * @twin.org/merge-locales bumped from 0.0.1-next.25 to 0.0.1-next.26
+    * @twin.org/nameof-transformer bumped from 0.0.1-next.25 to 0.0.1-next.26
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.1-next.25 to 0.0.1-next.26
+
+## [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)
+
+
+### Features
+
+* add ts-to-schema overrides ([3c54504](https://github.com/twinfoundation/tools/commit/3c5450468eb998204a75576b7791a7ca4027da62))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nameof bumped from 0.0.1-next.24 to 0.0.1-next.25
+  * devDependencies
+    * @twin.org/merge-locales bumped from 0.0.1-next.24 to 0.0.1-next.25
+    * @twin.org/nameof-transformer bumped from 0.0.1-next.24 to 0.0.1-next.25
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.1-next.24 to 0.0.1-next.25
+
+## [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)
+
+
+### Miscellaneous Chores
+
+* **ts-to-schema:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nameof bumped from 0.0.1-next.23 to 0.0.1-next.24
+  * devDependencies
+    * @twin.org/merge-locales bumped from 0.0.1-next.23 to 0.0.1-next.24
+    * @twin.org/nameof-transformer bumped from 0.0.1-next.23 to 0.0.1-next.24
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.1-next.23 to 0.0.1-next.24
+
+## [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)
+
+
+### Miscellaneous Chores
+
+* **ts-to-schema:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nameof bumped from 0.0.1-next.22 to 0.0.1-next.23
+  * devDependencies
+    * @twin.org/merge-locales bumped from 0.0.1-next.22 to 0.0.1-next.23
+    * @twin.org/nameof-transformer bumped from 0.0.1-next.22 to 0.0.1-next.23
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.1-next.22 to 0.0.1-next.23
+
+## [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)
+
+
+### Features
+
+* generate schemas as individual entities ([9f372ab](https://github.com/twinfoundation/tools/commit/9f372abdfc27aba93b303c7b214991919c0c18c3))
+
+
+### Bug Fixes
+
+* remove debugging ([4def3d1](https://github.com/twinfoundation/tools/commit/4def3d1ef6a41a3b3358f864214e6a7ec3f9c638))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nameof bumped from 0.0.1-next.21 to 0.0.1-next.22
+  * devDependencies
+    * @twin.org/merge-locales bumped from 0.0.1-next.21 to 0.0.1-next.22
+    * @twin.org/nameof-transformer bumped from 0.0.1-next.21 to 0.0.1-next.22
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.1-next.21 to 0.0.1-next.22
+
+## [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)
+
+
+### Features
+
+* use shared store mechanism ([#31](https://github.com/twinfoundation/tools/issues/31)) ([d9fe68b](https://github.com/twinfoundation/tools/commit/d9fe68b903d1268c7cb3c64772df5cb78fd63667))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nameof bumped from 0.0.1-next.20 to 0.0.1-next.21
+  * devDependencies
+    * @twin.org/merge-locales bumped from 0.0.1-next.20 to 0.0.1-next.21
+    * @twin.org/nameof-transformer bumped from 0.0.1-next.20 to 0.0.1-next.21
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.1-next.20 to 0.0.1-next.21
+
+## [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)
+
+
+### Miscellaneous Chores
+
+* **ts-to-schema:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nameof bumped from 0.0.1-next.19 to 0.0.1-next.20
+  * devDependencies
+    * @twin.org/merge-locales bumped from 0.0.1-next.19 to 0.0.1-next.20
+    * @twin.org/nameof-transformer bumped from 0.0.1-next.19 to 0.0.1-next.20
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.1-next.19 to 0.0.1-next.20
+
+## [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)
+
+
+### Miscellaneous Chores
+
+* **ts-to-schema:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nameof bumped from 0.0.1-next.18 to 0.0.1-next.19
+  * devDependencies
+    * @twin.org/merge-locales bumped from 0.0.1-next.18 to 0.0.1-next.19
+    * @twin.org/nameof-transformer bumped from 0.0.1-next.18 to 0.0.1-next.19
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.1-next.18 to 0.0.1-next.19
+
+## v0.0.1-next.18
 
 - Initial Release

package/docs/reference/classes/CLI.md

@@ -8,13 +8,13 @@ The main entry point for the CLI.
 
 ## Constructors
 
-### new CLI()
+### Constructor
 
-> **new CLI**(): [`CLI`](CLI.md)
+> **new CLI**(): `CLI`
 
 #### Returns
 
-[`CLI`](CLI.md)
+`CLI`
 
 #### Inherited from
 
@@ -24,25 +24,31 @@ The main entry point for the CLI.
 
 ### run()
 
-> **run**(`argv`, `localesDirectory`?, `options`?): `Promise`\<`number`\>
+> **run**(`argv`, `localesDirectory?`, `options?`): `Promise`\<`number`\>
 
 Run the app.
 
 #### Parameters
 
-• **argv**: `string`[]
+##### argv
+
+`string`[]
 
 The process arguments.
 
-• **localesDirectory?**: `string`
+##### localesDirectory?
+
+`string`
 
 The directory for the locales, default to relative to the script.
 
-• **options?**
+##### options?
 
 Additional options.
 
-• **options.overrideOutputWidth?**: `number`
+###### overrideOutputWidth?
+
+`number`
 
 Override the output width.
 
@@ -62,7 +68,9 @@ Configure any options or actions at the root program level.
 
 #### Parameters
 
-• **program**: `Command`
+##### program
+
+`Command`
 
 The root program command.
 

package/docs/reference/functions/actionCommandTsToSchema.md

@@ -6,15 +6,21 @@ Action the root command.
 
 ## Parameters
 
-• **configFile**: `string`
+### configFile
+
+`string`
 
 The optional configuration file.
 
-• **outputFolder**: `string`
+### outputFolder
+
+`string`
 
 The output folder for the schemas.
 
-• **opts**: `unknown`
+### opts
+
+`unknown`
 
 The options for the command.
 

package/docs/reference/functions/buildCommandTsToSchema.md

@@ -6,7 +6,9 @@ Build the root command to be consumed by the CLI.
 
 ## Parameters
 
-• **program**: `Command`
+### program
+
+`Command`
 
 The command to build on.
 

package/docs/reference/functions/tsToSchema.md

@@ -6,15 +6,21 @@ Convert the TypeScript definitions to JSON Schemas.
 
 ## Parameters
 
-• **config**: [`ITsToSchemaConfig`](../interfaces/ITsToSchemaConfig.md)
+### config
+
+[`ITsToSchemaConfig`](../interfaces/ITsToSchemaConfig.md)
 
 The configuration for the app.
 
-• **outputFolder**: `string`
+### outputFolder
+
+`string`
 
 The location of the folder to output the JSON schemas.
 
-• **workingDirectory**: `string`
+### workingDirectory
+
+`string`
 
 The folder the app was run from.
 

package/docs/reference/interfaces/ITsToSchemaConfig.md

@@ -12,19 +12,11 @@ The base url for the type references e.g. https://schema.twindev.org/my-namespac
 
 ***
 
-### sources
-
-> **sources**: `string`[]
-
-The list of glob sources that can be used to generate the schemas.
-
-***
-
 ### types
 
 > **types**: `string`[]
 
-The list of types to generate.
+The source files to generate the types from.
 
 ***
 
@@ -36,4 +28,16 @@ External type references
 
 #### Index Signature
 
- \[`id`: `string`\]: `string`
+\[`id`: `string`\]: `string`
+
+***
+
+### overrides?
+
+> `optional` **overrides**: `object`
+
+Override for specific types, to be used when the type cannot be generated automatically, or is generated incorrectly.
+
+#### Index Signature
+
+\[`id`: `string`\]: `AnySchemaObject`

package/locales/en.json

@@ -22,8 +22,8 @@
 			"progress": {
 				"loadingConfigJson": "Loading Config JSON",
 				"creatingWorkingDir": "Creating Working Directory",
-				"generatingSchemas": "Generating Schemas",
-				"finalisingSchemas": "Finalising Schemas",
+				"generatingSchema": "Generating Schema",
+				"overridingSchema": "Overriding Schema",
 				"writingSchemas": "Writing Schemas",
 				"writingSchema": "Writing Schema",
 				"models": "Models"

package/package.json

@@ -1,11 +1,11 @@
 {
 	"name": "@twin.org/ts-to-schema",
-	"version": "0.0.1-next.9",
+	"version": "0.0.1",
 	"description": "Tool to convert TypeScript definitions to JSON schemas",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/twinfoundation/tools.git",
-		"directory": "packages/ts-to-schema"
+		"directory": "apps/ts-to-schema"
 	},
 	"author": "martyn.janes@iota.org",
 	"license": "Apache-2.0",
@@ -14,22 +14,22 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/cli-core": "next",
-		"@twin.org/core": "next",
-		"@twin.org/nameof": "0.0.1-next.9",
-		"commander": "12.1.0",
-		"glob": "11.0.0",
-		"jsonschema": "1.4.1",
-		"ts-json-schema-generator": "2.4.0-next.1"
+		"@twin.org/cli-core": "^0.0.1",
+		"@twin.org/core": "^0.0.1",
+		"@twin.org/nameof": "^0.0.1",
+		"ajv": "8.17.1",
+		"commander": "14.0.0",
+		"glob": "11.0.2",
+		"ts-json-schema-generator": "2.4.0"
 	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
+			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs",
-			"types": "./dist/types/index.d.ts"
+			"import": "./dist/esm/index.mjs"
 		}
 	},
 	"files": [