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

package/dist/cjs/index.cjs

@@ -79,23 +79,30 @@ async function tsToSchema(config, outputFolder, workingDirectory) {
     cliCore.CLIDisplay.break();
     cliCore.CLIDisplay.task(core.I18n.formatMessage("commands.ts-to-schema.progress.writingSchemas"));
     for (const typeSource of config.types) {
-        cliCore.CLIDisplay.task(core.I18n.formatMessage("commands.ts-to-schema.progress.generatingSchema"));
         const typeSourceParts = typeSource.split("/");
         const type = core.StringHelper.pascalCase(typeSourceParts[typeSourceParts.length - 1].replace(/(\.d)?\.ts$/, ""), false);
-        const schemas = await generateSchemas(typeSource, type, workingDirectory);
-        if (core.Is.empty(schemas[type])) {
-            throw new core.GeneralError("commands", "commands.ts-to-schema.schemaNotFound", { type });
+        let content;
+        if (core.Is.object(config.overrides?.[type])) {
+            cliCore.CLIDisplay.task(core.I18n.formatMessage("commands.ts-to-schema.progress.overridingSchema"));
+            content = JSON.stringify(config.overrides?.[type], undefined, "\t");
         }
-        let content = JSON.stringify(schemas[type], undefined, "\t");
-        if (core.Is.objectValue(config.externalReferences)) {
-            for (const external in config.externalReferences) {
-                content = content.replace(new RegExp(`#/definitions/${external}`, "g"), config.externalReferences[external]);
+        else {
+            cliCore.CLIDisplay.task(core.I18n.formatMessage("commands.ts-to-schema.progress.generatingSchema"));
+            const schemas = await generateSchemas(typeSource, type, workingDirectory);
+            if (core.Is.empty(schemas[type])) {
+                throw new core.GeneralError("commands", "commands.ts-to-schema.schemaNotFound", { type });
+            }
+            content = JSON.stringify(schemas[type], undefined, "\t");
+            if (core.Is.objectValue(config.externalReferences)) {
+                for (const external in config.externalReferences) {
+                    content = content.replace(new RegExp(`#/definitions/${external}`, "g"), config.externalReferences[external]);
+                }
             }
+            // First replace all types that start with II to a single I with the new base url
+            content = content.replace(/#\/definitions\/II(.*)/g, `${config.baseUrl}I$1`);
+            // Then other types starting with capitals (optionally interfaces starting with I)
+            content = content.replace(/#\/definitions\/I?([A-Z].*)/g, `${config.baseUrl}$1`);
         }
-        // First replace all types that start with II to a single I with the new base url
-        content = content.replace(/#\/definitions\/II(.*)/g, `${config.baseUrl}I$1`);
-        // Then other types starting with capitals (optionally interfaces starting with I)
-        content = content.replace(/#\/definitions\/I?([A-Z].*)/g, `${config.baseUrl}$1`);
         const filename = path.join(outputFolder, `${core.StringHelper.stripPrefix(type)}.json`);
         cliCore.CLIDisplay.value(core.I18n.formatMessage("commands.ts-to-schema.progress.writingSchema"), filename, 1);
         await promises.writeFile(filename, `${content}\n`);
@@ -220,7 +227,7 @@ class CLI extends cliCore.CLIBase {
         return this.execute({
             title: "TWIN TypeScript To Schema",
             appName: "ts-to-schema",
-            version: "0.0.1-next.24", // x-release-please-version
+            version: "0.0.1-next.25", // x-release-please-version
             icon: "⚙️ ",
             supportsEnvFiles: false,
             overrideOutputWidth: options?.overrideOutputWidth

package/dist/esm/index.mjs

@@ -76,23 +76,30 @@ async function tsToSchema(config, outputFolder, workingDirectory) {
     CLIDisplay.break();
     CLIDisplay.task(I18n.formatMessage("commands.ts-to-schema.progress.writingSchemas"));
     for (const typeSource of config.types) {
-        CLIDisplay.task(I18n.formatMessage("commands.ts-to-schema.progress.generatingSchema"));
         const typeSourceParts = typeSource.split("/");
         const type = StringHelper.pascalCase(typeSourceParts[typeSourceParts.length - 1].replace(/(\.d)?\.ts$/, ""), false);
-        const schemas = await generateSchemas(typeSource, type, workingDirectory);
-        if (Is.empty(schemas[type])) {
-            throw new GeneralError("commands", "commands.ts-to-schema.schemaNotFound", { type });
+        let content;
+        if (Is.object(config.overrides?.[type])) {
+            CLIDisplay.task(I18n.formatMessage("commands.ts-to-schema.progress.overridingSchema"));
+            content = JSON.stringify(config.overrides?.[type], undefined, "\t");
         }
-        let content = JSON.stringify(schemas[type], undefined, "\t");
-        if (Is.objectValue(config.externalReferences)) {
-            for (const external in config.externalReferences) {
-                content = content.replace(new RegExp(`#/definitions/${external}`, "g"), config.externalReferences[external]);
+        else {
+            CLIDisplay.task(I18n.formatMessage("commands.ts-to-schema.progress.generatingSchema"));
+            const schemas = await generateSchemas(typeSource, type, workingDirectory);
+            if (Is.empty(schemas[type])) {
+                throw new GeneralError("commands", "commands.ts-to-schema.schemaNotFound", { type });
+            }
+            content = JSON.stringify(schemas[type], undefined, "\t");
+            if (Is.objectValue(config.externalReferences)) {
+                for (const external in config.externalReferences) {
+                    content = content.replace(new RegExp(`#/definitions/${external}`, "g"), config.externalReferences[external]);
+                }
             }
+            // First replace all types that start with II to a single I with the new base url
+            content = content.replace(/#\/definitions\/II(.*)/g, `${config.baseUrl}I$1`);
+            // Then other types starting with capitals (optionally interfaces starting with I)
+            content = content.replace(/#\/definitions\/I?([A-Z].*)/g, `${config.baseUrl}$1`);
         }
-        // First replace all types that start with II to a single I with the new base url
-        content = content.replace(/#\/definitions\/II(.*)/g, `${config.baseUrl}I$1`);
-        // Then other types starting with capitals (optionally interfaces starting with I)
-        content = content.replace(/#\/definitions\/I?([A-Z].*)/g, `${config.baseUrl}$1`);
         const filename = path.join(outputFolder, `${StringHelper.stripPrefix(type)}.json`);
         CLIDisplay.value(I18n.formatMessage("commands.ts-to-schema.progress.writingSchema"), filename, 1);
         await writeFile(filename, `${content}\n`);
@@ -217,7 +224,7 @@ class CLI extends CLIBase {
         return this.execute({
             title: "TWIN TypeScript To Schema",
             appName: "ts-to-schema",
-            version: "0.0.1-next.24", // x-release-please-version
+            version: "0.0.1-next.25", // x-release-please-version
             icon: "⚙️ ",
             supportsEnvFiles: false,
             overrideOutputWidth: options?.overrideOutputWidth

package/dist/locales/en.json

@@ -80,6 +80,8 @@
 			"array": "Property \"{property}\" must be an array, it is \"{value}\"",
 			"arrayValue": "Property \"{property}\" must be an array with at least one item",
 			"arrayOneOf": "Property \"{property}\" must be one of [{options}], it is \"{value}\"",
+			"arrayStartsWith": "Property \"{property}\" must be an array starting with [{startValues}], it is \"{value}\"",
+			"arrayEndsWith": "Property \"{property}\" must be an array ending with [{endValues}], it is \"{value}\"",
 			"uint8Array": "Property \"{property}\" must be a Uint8Array, it is \"{value}\"",
 			"function": "Property \"{property}\" must be a function, it is \"{value}\"",
 			"urn": "Property \"{property}\" must be a Urn formatted string, it is \"{value}\"",
@@ -250,6 +252,7 @@
 				"loadingConfigJson": "Loading Config JSON",
 				"creatingWorkingDir": "Creating Working Directory",
 				"generatingSchema": "Generating Schema",
+				"overridingSchema": "Overriding Schema",
 				"writingSchemas": "Writing Schemas",
 				"writingSchema": "Writing Schema",
 				"models": "Models"

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

@@ -0,0 +1,5 @@
+import type { JsonSchemaDraft202012Object } from "@hyperjump/json-schema/draft-2020-12";
+/**
+ * Default schema type.
+ */
+export type IJsonSchema = JsonSchemaDraft202012Object;

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

@@ -1,3 +1,4 @@
+import type { IJsonSchema } from "./IJsonSchema";
 /**
  * Configuration for the tool.
  */
@@ -16,4 +17,10 @@ export interface ITsToSchemaConfig {
     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;
+    };
 }

package/docs/changelog.md

@@ -1,5 +1,23 @@
 # @twin.org/ts-to-schema - Changelog
 
+## [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)
 
 

package/docs/reference/interfaces/ITsToSchemaConfig.md

@@ -29,3 +29,15 @@ External type references
 #### Index Signature
 
 \[`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`\]: `JsonSchemaDraft202012Object`

package/locales/en.json

@@ -23,6 +23,7 @@
 				"loadingConfigJson": "Loading Config JSON",
 				"creatingWorkingDir": "Creating Working Directory",
 				"generatingSchema": "Generating Schema",
+				"overridingSchema": "Overriding Schema",
 				"writingSchemas": "Writing Schemas",
 				"writingSchema": "Writing Schema",
 				"models": "Models"

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/ts-to-schema",
-	"version": "0.0.1-next.24",
+	"version": "0.0.1-next.25",
 	"description": "Tool to convert TypeScript definitions to JSON schemas",
 	"repository": {
 		"type": "git",
@@ -14,12 +14,13 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
+		"@hyperjump/json-pointer": "1.1.1",
+		"@hyperjump/json-schema": "1.14.1",
 		"@twin.org/cli-core": "next",
 		"@twin.org/core": "next",
-		"@twin.org/nameof": "0.0.1-next.24",
-		"commander": "13.1.0",
-		"glob": "11.0.1",
-		"jsonschema": "1.5.0",
+		"@twin.org/nameof": "0.0.1-next.25",
+		"commander": "14.0.0",
+		"glob": "11.0.2",
 		"ts-json-schema-generator": "2.4.0"
 	},
 	"main": "./dist/cjs/index.cjs",