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

package/dist/cjs/index.cjs

@@ -10,6 +10,7 @@ var tsJsonSchemaGenerator = require('ts-json-schema-generator');
 var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
+const SCHEMA_VERSION = "https://json-schema.org/draft/2020-12/schema";
 /**
  * Build the root command to be consumed by the CLI.
  * @param program The command to build on.
@@ -81,10 +82,10 @@ async function tsToSchema(config, outputFolder, workingDirectory) {
     for (const typeSource of config.types) {
         const typeSourceParts = typeSource.split("/");
         const type = core.StringHelper.pascalCase(typeSourceParts[typeSourceParts.length - 1].replace(/(\.d)?\.ts$/, ""), false);
-        let content;
+        let schemaObject;
         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");
+            schemaObject = config.overrides?.[type];
         }
         else {
             cliCore.CLIDisplay.task(core.I18n.formatMessage("commands.ts-to-schema.progress.generatingSchema"));
@@ -92,17 +93,19 @@ async function tsToSchema(config, outputFolder, 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]);
-                }
+            schemaObject = schemas[type];
+        }
+        schemaObject = finaliseSchema(schemaObject, config.baseUrl, type);
+        let content = JSON.stringify(schemaObject, 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`);
@@ -208,6 +211,76 @@ function extractTypesFromSchema(allTypes, schema, output) {
         extractTypes(allTypes, additionalTypes, output);
     }
 }
+/**
+ * Process the schema object to ensure it has the correct properties.
+ * @param schemaObject The schema object to process.
+ * @param baseUrl The base URL for the schema references.
+ * @param type The type of the schema object.
+ * @returns The finalised schema object.
+ */
+function finaliseSchema(schemaObject, baseUrl, type) {
+    processArrays(schemaObject);
+    const { description, ...rest } = schemaObject;
+    return {
+        $schema: SCHEMA_VERSION,
+        $id: `${baseUrl}${core.StringHelper.stripPrefix(type)}`,
+        description,
+        ...rest
+    };
+}
+/**
+ * Process arrays in the schema object.
+ * @param schemaObject The schema object to process.
+ */
+function processArrays(schemaObject) {
+    if (core.Is.object(schemaObject)) {
+        // latest specs have singular items in `items` property
+        // and multiple items in prefixItems, so update the schema accordingly
+        // https://www.learnjsonschema.com/2020-12/applicator/items/
+        // https://www.learnjsonschema.com/2020-12/applicator/prefixitems/
+        const schemaItems = schemaObject.items;
+        if (core.Is.array(schemaItems) || core.Is.object(schemaItems)) {
+            schemaObject.prefixItems = core.ArrayHelper.fromObjectOrArray(schemaItems);
+            schemaObject.items = false;
+        }
+        const additionalItems = schemaObject.additionalItems;
+        if (core.Is.array(additionalItems) || core.Is.object(additionalItems)) {
+            schemaObject.items = core.ArrayHelper.fromObjectOrArray(additionalItems)[0];
+            delete schemaObject.additionalItems;
+        }
+        processSchemaDictionary(schemaObject.properties);
+        processArrays(schemaObject.additionalProperties);
+        processSchemaArray(schemaObject.allOf);
+        processSchemaArray(schemaObject.anyOf);
+        processSchemaArray(schemaObject.oneOf);
+    }
+}
+/**
+ * Process arrays in the schema object.
+ * @param schemaDictionary The schema object to process.
+ */
+function processSchemaDictionary(schemaDictionary) {
+    if (core.Is.object(schemaDictionary)) {
+        for (const item of Object.values(schemaDictionary)) {
+            if (core.Is.object(item)) {
+                processArrays(item);
+            }
+        }
+    }
+}
+/**
+ * Process arrays in the schema object.
+ * @param schemaArray The schema object to process.
+ */
+function processSchemaArray(schemaArray) {
+    if (core.Is.arrayValue(schemaArray)) {
+        for (const item of schemaArray) {
+            if (core.Is.object(item)) {
+                processArrays(item);
+            }
+        }
+    }
+}
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
@@ -227,7 +300,7 @@ class CLI extends cliCore.CLIBase {
         return this.execute({
             title: "TWIN TypeScript To Schema",
             appName: "ts-to-schema",
-            version: "0.0.1-next.25", // x-release-please-version
+            version: "0.0.1-next.27", // x-release-please-version
             icon: "⚙️ ",
             supportsEnvFiles: false,
             overrideOutputWidth: options?.overrideOutputWidth

package/dist/esm/index.mjs

@@ -2,11 +2,12 @@ import path from 'node:path';
 import { fileURLToPath } from 'node:url';
 import { CLIDisplay, CLIUtils, CLIBase } from '@twin.org/cli-core';
 import { mkdir, rm, writeFile } from 'node:fs/promises';
-import { I18n, GeneralError, Is, StringHelper } from '@twin.org/core';
+import { I18n, GeneralError, Is, StringHelper, ArrayHelper } from '@twin.org/core';
 import { createGenerator } from 'ts-json-schema-generator';
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
+const SCHEMA_VERSION = "https://json-schema.org/draft/2020-12/schema";
 /**
  * Build the root command to be consumed by the CLI.
  * @param program The command to build on.
@@ -78,10 +79,10 @@ async function tsToSchema(config, outputFolder, workingDirectory) {
     for (const typeSource of config.types) {
         const typeSourceParts = typeSource.split("/");
         const type = StringHelper.pascalCase(typeSourceParts[typeSourceParts.length - 1].replace(/(\.d)?\.ts$/, ""), false);
-        let content;
+        let schemaObject;
         if (Is.object(config.overrides?.[type])) {
             CLIDisplay.task(I18n.formatMessage("commands.ts-to-schema.progress.overridingSchema"));
-            content = JSON.stringify(config.overrides?.[type], undefined, "\t");
+            schemaObject = config.overrides?.[type];
         }
         else {
             CLIDisplay.task(I18n.formatMessage("commands.ts-to-schema.progress.generatingSchema"));
@@ -89,17 +90,19 @@ async function tsToSchema(config, outputFolder, 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]);
-                }
+            schemaObject = schemas[type];
+        }
+        schemaObject = finaliseSchema(schemaObject, config.baseUrl, type);
+        let content = JSON.stringify(schemaObject, 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`);
@@ -205,6 +208,76 @@ function extractTypesFromSchema(allTypes, schema, output) {
         extractTypes(allTypes, additionalTypes, output);
     }
 }
+/**
+ * Process the schema object to ensure it has the correct properties.
+ * @param schemaObject The schema object to process.
+ * @param baseUrl The base URL for the schema references.
+ * @param type The type of the schema object.
+ * @returns The finalised schema object.
+ */
+function finaliseSchema(schemaObject, baseUrl, type) {
+    processArrays(schemaObject);
+    const { description, ...rest } = schemaObject;
+    return {
+        $schema: SCHEMA_VERSION,
+        $id: `${baseUrl}${StringHelper.stripPrefix(type)}`,
+        description,
+        ...rest
+    };
+}
+/**
+ * Process arrays in the schema object.
+ * @param schemaObject The schema object to process.
+ */
+function processArrays(schemaObject) {
+    if (Is.object(schemaObject)) {
+        // latest specs have singular items in `items` property
+        // and multiple items in prefixItems, so update the schema accordingly
+        // https://www.learnjsonschema.com/2020-12/applicator/items/
+        // https://www.learnjsonschema.com/2020-12/applicator/prefixitems/
+        const schemaItems = schemaObject.items;
+        if (Is.array(schemaItems) || Is.object(schemaItems)) {
+            schemaObject.prefixItems = ArrayHelper.fromObjectOrArray(schemaItems);
+            schemaObject.items = false;
+        }
+        const additionalItems = schemaObject.additionalItems;
+        if (Is.array(additionalItems) || Is.object(additionalItems)) {
+            schemaObject.items = ArrayHelper.fromObjectOrArray(additionalItems)[0];
+            delete schemaObject.additionalItems;
+        }
+        processSchemaDictionary(schemaObject.properties);
+        processArrays(schemaObject.additionalProperties);
+        processSchemaArray(schemaObject.allOf);
+        processSchemaArray(schemaObject.anyOf);
+        processSchemaArray(schemaObject.oneOf);
+    }
+}
+/**
+ * Process arrays in the schema object.
+ * @param schemaDictionary The schema object to process.
+ */
+function processSchemaDictionary(schemaDictionary) {
+    if (Is.object(schemaDictionary)) {
+        for (const item of Object.values(schemaDictionary)) {
+            if (Is.object(item)) {
+                processArrays(item);
+            }
+        }
+    }
+}
+/**
+ * Process arrays in the schema object.
+ * @param schemaArray The schema object to process.
+ */
+function processSchemaArray(schemaArray) {
+    if (Is.arrayValue(schemaArray)) {
+        for (const item of schemaArray) {
+            if (Is.object(item)) {
+                processArrays(item);
+            }
+        }
+    }
+}
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
@@ -224,7 +297,7 @@ class CLI extends CLIBase {
         return this.execute({
             title: "TWIN TypeScript To Schema",
             appName: "ts-to-schema",
-            version: "0.0.1-next.25", // x-release-please-version
+            version: "0.0.1-next.27", // x-release-please-version
             icon: "⚙️ ",
             supportsEnvFiles: false,
             overrideOutputWidth: options?.overrideOutputWidth

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

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

package/docs/changelog.md

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

package/docs/reference/interfaces/ITsToSchemaConfig.md

@@ -40,4 +40,4 @@ Override for specific types, to be used when the type cannot be generated automa
 
 #### Index Signature
 
-\[`id`: `string`\]: `JsonSchemaDraft202012Object`
+\[`id`: `string`\]: `AnySchemaObject`

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/ts-to-schema",
-	"version": "0.0.1-next.25",
+	"version": "0.0.1-next.27",
 	"description": "Tool to convert TypeScript definitions to JSON schemas",
 	"repository": {
 		"type": "git",
@@ -14,11 +14,10 @@
 		"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.25",
+		"@twin.org/nameof": "0.0.1-next.27",
+		"ajv": "8.17.1",
 		"commander": "14.0.0",
 		"glob": "11.0.2",
 		"ts-json-schema-generator": "2.4.0"