@twin.org/ts-to-openapi 0.0.1-next.9 → 0.0.2-next.1

package/dist/types/models/IOpenApi.d.ts

@@ -1,4 +1,4 @@
-import type { JSONSchema7 } from "json-schema";
+import type { IJsonSchema } from "@twin.org/tools-core";
 import type { IOpenApiPathMethod } from "./IOpenApiPathMethod";
 import type { IOpenApiSecurityScheme } from "./IOpenApiSecurityScheme";
 /**
@@ -46,7 +46,7 @@ export interface IOpenApi {
      * The components.
      */
     components?: {
-        schemas?: JSONSchema7;
+        schemas?: IJsonSchema;
         securitySchemes?: {
             [name: string]: IOpenApiSecurityScheme;
         };

package/dist/types/models/IOpenApiPathMethod.d.ts

@@ -1,4 +1,4 @@
-import type { JSONSchema7Type, JSONSchema7TypeName } from "json-schema";
+import type { IJsonSchema, JsonTypeName } from "@twin.org/tools-core";
 import type { IOpenApiExample } from "./IOpenApiExample";
 import type { IOpenApiResponse } from "./IOpenApiResponse";
 /**
@@ -26,8 +26,8 @@ export interface IOpenApiPathMethod {
         description?: string;
         required: boolean;
         schema: {
-            type?: JSONSchema7TypeName | JSONSchema7TypeName[];
-            enum?: JSONSchema7Type[];
+            type?: JsonTypeName | JsonTypeName[];
+            enum?: IJsonSchema[];
             $ref?: string;
         };
         style?: string;

package/dist/types/models/ITsToOpenApiConfig.d.ts

@@ -1,3 +1,4 @@
+import type { IJsonSchema } from "@twin.org/tools-core";
 import type { ITsToOpenApiConfigEntryPoint } from "./ITsToOpenApiConfigEntryPoint";
 /**
  * Configuration for the API.
@@ -58,4 +59,14 @@ export interface ITsToOpenApiConfig {
     externalReferences?: {
         [id: string]: string;
     };
+    /**
+     * Override for specific types, to be used when the type cannot be generated automatically, or is generated incorrectly.
+     */
+    overrides?: {
+        [id: string]: IJsonSchema;
+    };
+    /**
+     * The types to automatically expand inline in type definitions, reg ex string matches.
+     */
+    autoExpandTypes?: string[];
 }

package/docs/changelog.md

@@ -1,5 +1,226 @@
 # @twin.org/ts-to-openapi - Changelog
 
-## v0.0.1-next.9
+## [0.0.2-next.1](https://github.com/twinfoundation/tools/compare/ts-to-openapi-v0.0.2-next.0...ts-to-openapi-v0.0.2-next.1) (2025-07-14)
+
+
+### Features
+
+* add latest json schema features ([494293f](https://github.com/twinfoundation/tools/commit/494293f4252b9c7d4a20790ec157fc9d8c96c3d2))
+* add support for auto expand types ([dd1e10a](https://github.com/twinfoundation/tools/commit/dd1e10a5b2fea6f80890ff6f3971f48e239cb4c1))
+* add ts-to-schema overrides ([3c54504](https://github.com/twinfoundation/tools/commit/3c5450468eb998204a75576b7791a7ca4027da62))
+* generate schemas as individual entities ([9f372ab](https://github.com/twinfoundation/tools/commit/9f372abdfc27aba93b303c7b214991919c0c18c3))
+* improve schema type name normalisation ([1a18b26](https://github.com/twinfoundation/tools/commit/1a18b267d87e9179bda01b396b256c450ae2889e))
+* move package to framework repo ([4490bda](https://github.com/twinfoundation/tools/commit/4490bda472d4dc8ddfe931e2fce81f3411de9ab3))
+* strip Omit types ([3a079f9](https://github.com/twinfoundation/tools/commit/3a079f9abe8127c5b44a2b9382babf2f19629d08))
+* use most recent JSON schema specs ([4598cbf](https://github.com/twinfoundation/tools/commit/4598cbf29f7b82dba4a9f3b19f81dfe66f5a6060))
+* use shared store mechanism ([#31](https://github.com/twinfoundation/tools/issues/31)) ([d9fe68b](https://github.com/twinfoundation/tools/commit/d9fe68b903d1268c7cb3c64772df5cb78fd63667))
+
+
+### Bug Fixes
+
+* fix locale resource name ([53ad5b5](https://github.com/twinfoundation/tools/commit/53ad5b56f19a5082f16a4f1e4a761e114dce8250))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/tools-core bumped from 0.0.2-next.0 to 0.0.2-next.1
+
+## 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-openapi-v0.0.1-next.28...ts-to-openapi-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-openapi-v0.0.1-next.27...ts-to-openapi-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-openapi-v0.0.1-next.26...ts-to-openapi-v0.0.1-next.27) (2025-06-17)
+
+
+### Features
+
+* add latest json schema features ([494293f](https://github.com/twinfoundation/tools/commit/494293f4252b9c7d4a20790ec157fc9d8c96c3d2))
+
+
+### 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-openapi-v0.0.1-next.25...ts-to-openapi-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-openapi-v0.0.1-next.24...ts-to-openapi-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-openapi-v0.0.1-next.23...ts-to-openapi-v0.0.1-next.24) (2025-06-05)
+
+
+### Features
+
+* strip Omit types ([3a079f9](https://github.com/twinfoundation/tools/commit/3a079f9abe8127c5b44a2b9382babf2f19629d08))
+
+
+### 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-openapi-v0.0.1-next.22...ts-to-openapi-v0.0.1-next.23) (2025-06-03)
+
+
+### Bug Fixes
+
+* fix locale resource name ([53ad5b5](https://github.com/twinfoundation/tools/commit/53ad5b56f19a5082f16a4f1e4a761e114dce8250))
+
+
+### 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-openapi-v0.0.1-next.21...ts-to-openapi-v0.0.1-next.22) (2025-06-03)
+
+
+### Features
+
+* generate schemas as individual entities ([9f372ab](https://github.com/twinfoundation/tools/commit/9f372abdfc27aba93b303c7b214991919c0c18c3))
+
+
+### 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-openapi-v0.0.1-next.20...ts-to-openapi-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-openapi-v0.0.1-next.19...ts-to-openapi-v0.0.1-next.20) (2025-03-28)
+
+
+### Miscellaneous Chores
+
+* **ts-to-openapi:** 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-openapi-v0.0.1-next.18...ts-to-openapi-v0.0.1-next.19) (2025-03-26)
+
+
+### Miscellaneous Chores
+
+* **ts-to-openapi:** 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/actionCommandTsToOpenApi.md

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

package/docs/reference/functions/buildCommandTsToOpenApi.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/tsToOpenApi.md

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

package/docs/reference/interfaces/ITsToOpenApiConfig.md

@@ -66,6 +66,30 @@ The authentication methods.
 
 The packages containing routes.
 
+#### package?
+
+> `optional` **package**: `string`
+
+The package containing the routes.
+
+#### version?
+
+> `optional` **version**: `string`
+
+The version of the package to use, defaults to latest.
+
+#### packageRoot?
+
+> `optional` **packageRoot**: `string`
+
+To point to a local instance of a package use this property instead of package/version.
+
+#### entryPoints?
+
+> `optional` **entryPoints**: [`ITsToOpenApiConfigEntryPoint`](ITsToOpenApiConfigEntryPoint.md)[]
+
+The rest entry points to include, defaults to all exported entry points.
+
 ***
 
 ### externalReferences?
@@ -76,4 +100,24 @@ 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`
+
+***
+
+### autoExpandTypes?
+
+> `optional` **autoExpandTypes**: `string`[]
+
+The types to automatically expand inline in type definitions, reg ex string matches.

package/locales/en.json

@@ -26,6 +26,7 @@
 				"creatingWorkingDir": "Creating Working Directory",
 				"creatingSecuritySchemas": "Creating Security Schemas",
 				"generatingSchemas": "Generating Schemas",
+				"overridingSchema": "Overriding Schema",
 				"finalisingSchemas": "Finalising Schemas",
 				"writingOutputFile": "Writing Output File",
 				"models": "Models",

package/package.json

@@ -1,11 +1,11 @@
 {
 	"name": "@twin.org/ts-to-openapi",
-	"version": "0.0.1-next.9",
+	"version": "0.0.2-next.1",
 	"description": "Tool to convert TypeScript REST route definitions to OpenAPI Specifications",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/twinfoundation/tools.git",
-		"directory": "packages/ts-to-openapi"
+		"directory": "apps/ts-to-openapi"
 	},
 	"author": "martyn.janes@iota.org",
 	"license": "Apache-2.0",
@@ -17,21 +17,21 @@
 		"@twin.org/api-models": "next",
 		"@twin.org/cli-core": "next",
 		"@twin.org/core": "next",
-		"@twin.org/nameof": "0.0.1-next.9",
+		"@twin.org/nameof": "next",
+		"@twin.org/tools-core": "0.0.2-next.1",
 		"@twin.org/web": "next",
-		"commander": "12.1.0",
-		"glob": "11.0.0",
-		"jsonschema": "1.4.1",
-		"ts-json-schema-generator": "2.4.0-next.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": [

package/dist/types/models/IPackageJson.d.ts

@@ -1,15 +0,0 @@
-/**
- * Configuration for each individual package.
- */
-export interface IPackageJson {
-    /**
-     * The name of the package.
-     */
-    name: string;
-    /**
-     * The dependencies for the package.
-     */
-    dependencies?: {
-        [id: string]: string;
-    };
-}