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

package/dist/cjs/index.cjs

@@ -5,12 +5,12 @@ var node_url = require('node:url');
 var cliCore = require('@twin.org/cli-core');
 var promises = require('node:fs/promises');
 var core = require('@twin.org/core');
+var toolsCore = require('@twin.org/tools-core');
 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.
@@ -89,7 +89,14 @@ async function tsToSchema(config, outputFolder, workingDirectory) {
         }
         else {
             cliCore.CLIDisplay.task(core.I18n.formatMessage("commands.ts-to-schema.progress.generatingSchema"));
-            const schemas = await generateSchemas(typeSource, type, workingDirectory);
+            const autoExpandTypes = config.autoExpandTypes ?? [];
+            const defaultExpandTypes = ["ObjectOrArray<.*>"];
+            for (const defaultType of defaultExpandTypes) {
+                if (!autoExpandTypes.includes(defaultType)) {
+                    autoExpandTypes.push(defaultType);
+                }
+            }
+            const schemas = await generateSchemas(typeSource, type, autoExpandTypes, workingDirectory);
             if (core.Is.empty(schemas[type])) {
                 throw new core.GeneralError("commands", "commands.ts-to-schema.schemaNotFound", { type });
             }
@@ -115,11 +122,12 @@ async function tsToSchema(config, outputFolder, workingDirectory) {
  * Generate schemas for the models.
  * @param modelDirWildcards The filenames for all the models.
  * @param types The types of the schema objects.
+ * @param autoExpandTypes The types to automatically expand.
  * @param outputWorkingDir The working directory.
  * @returns Nothing.
  * @internal
  */
-async function generateSchemas(typeSource, type, outputWorkingDir) {
+async function generateSchemas(typeSource, type, autoExpandTypes, outputWorkingDir) {
     const allSchemas = {};
     cliCore.CLIDisplay.value(core.I18n.formatMessage("commands.ts-to-schema.progress.models"), typeSource, 1);
     const generator = tsJsonSchemaGenerator.createGenerator({
@@ -132,82 +140,15 @@ async function generateSchemas(typeSource, type, outputWorkingDir) {
     const schema = generator.createSchema("*");
     if (schema.definitions) {
         for (const def in schema.definitions) {
-            const defSub = normaliseTypeName(def);
+            const defSub = toolsCore.JsonSchemaHelper.normaliseTypeName(def);
             allSchemas[defSub] = schema.definitions[def];
         }
     }
     const referencedSchemas = {};
-    extractTypes(allSchemas, [type], referencedSchemas);
+    toolsCore.JsonSchemaHelper.extractTypes(allSchemas, [type, ...autoExpandTypes], referencedSchemas);
+    toolsCore.JsonSchemaHelper.expandTypes(referencedSchemas, autoExpandTypes);
     return referencedSchemas;
 }
-/**
- * Extract the required types from all the known schemas.
- * @param allSchemas All the known schemas.
- * @param requiredTypes The required types.
- * @param referencedSchemas The references schemas.
- * @internal
- */
-function extractTypes(allSchemas, requiredTypes, referencedSchemas) {
-    for (const type of requiredTypes) {
-        if (allSchemas[type] && !referencedSchemas[type]) {
-            referencedSchemas[type] = allSchemas[type];
-            extractTypesFromSchema(allSchemas, allSchemas[type], referencedSchemas);
-        }
-    }
-}
-/**
- * Extract type from properties definition.
- * @param allTypes All the known types.
- * @param schema The schema to extract from.
- * @param output The output types.
- * @internal
- */
-function extractTypesFromSchema(allTypes, schema, output) {
-    const additionalTypes = [];
-    if (core.Is.stringValue(schema.$ref)) {
-        additionalTypes.push(schema.$ref.replace("#/definitions/", "").replace(/^Partial%3C(.*?)%3E/g, "$1"));
-    }
-    else if (core.Is.object(schema.items)) {
-        if (core.Is.arrayValue(schema.items)) {
-            for (const itemSchema of schema.items) {
-                extractTypesFromSchema(allTypes, itemSchema, output);
-            }
-        }
-        else {
-            extractTypesFromSchema(allTypes, schema.items, output);
-        }
-    }
-    else if (core.Is.object(schema.properties) || core.Is.object(schema.additionalProperties)) {
-        if (core.Is.object(schema.properties)) {
-            for (const prop in schema.properties) {
-                const p = schema.properties[prop];
-                if (core.Is.object(p)) {
-                    extractTypesFromSchema(allTypes, p, output);
-                }
-            }
-        }
-        if (core.Is.object(schema.additionalProperties)) {
-            extractTypesFromSchema(allTypes, schema.additionalProperties, output);
-        }
-    }
-    else if (core.Is.arrayValue(schema.anyOf)) {
-        for (const prop of schema.anyOf) {
-            if (core.Is.object(prop)) {
-                extractTypesFromSchema(allTypes, prop, output);
-            }
-        }
-    }
-    else if (core.Is.arrayValue(schema.oneOf)) {
-        for (const prop of schema.oneOf) {
-            if (core.Is.object(prop)) {
-                extractTypesFromSchema(allTypes, prop, output);
-            }
-        }
-    }
-    if (additionalTypes.length > 0) {
-        extractTypes(allTypes, additionalTypes, output);
-    }
-}
 /**
  * Process the schema object to ensure it has the correct properties.
  * @param schemaObject The schema object to process.
@@ -216,88 +157,15 @@ function extractTypesFromSchema(allTypes, schema, output) {
  * @returns The finalised schema object.
  */
 function finaliseSchema(schemaObject, baseUrl, type) {
-    processArrays(schemaObject);
+    toolsCore.JsonSchemaHelper.processArrays(schemaObject);
     const { description, ...rest } = schemaObject;
     return {
-        $schema: SCHEMA_VERSION,
+        $schema: toolsCore.JsonSchemaHelper.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);
-            }
-        }
-    }
-}
-/**
- * Cleanup TypeScript markers from the type name.
- * @param typeName The definition string to clean up.
- * @returns The cleaned up definition string.
- */
-function normaliseTypeName(typeName) {
-    // Remove the partial markers
-    let sTypeName = typeName.replace(/^Partial<(.*?)>/g, "$1");
-    sTypeName = sTypeName.replace(/Partial%3CI(.*?)%3E/g, "$1");
-    // Remove the omit markers
-    sTypeName = sTypeName.replace(/^Omit<(.*?),.*>/g, "$1");
-    sTypeName = sTypeName.replace(/Omit%3CI(.*?)%2C.*%3E/g, "$1");
-    // Remove the pick markers
-    sTypeName = sTypeName.replace(/^Pick<(.*?),.*>/g, "$1");
-    sTypeName = sTypeName.replace(/Pick%3CI(.*?)%2C.*%3E/g, "$1");
-    // Cleanup the generic markers
-    sTypeName = sTypeName.replace(/</g, "%3C").replace(/>/g, "%3E");
-    sTypeName = sTypeName.replace(/%3Cunknown%3E/g, "");
-    return sTypeName;
-}
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
@@ -317,7 +185,7 @@ class CLI extends cliCore.CLIBase {
         return this.execute({
             title: "TWIN TypeScript To Schema",
             appName: "ts-to-schema",
-            version: "0.0.1", // x-release-please-version
+            version: "0.0.2-next.1", // x-release-please-version
             icon: "⚙️ ",
             supportsEnvFiles: false,
             overrideOutputWidth: options?.overrideOutputWidth

package/dist/esm/index.mjs

@@ -2,12 +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, ArrayHelper } from '@twin.org/core';
+import { I18n, GeneralError, Is, StringHelper } from '@twin.org/core';
+import { JsonSchemaHelper } from '@twin.org/tools-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.
@@ -86,7 +86,14 @@ async function tsToSchema(config, outputFolder, workingDirectory) {
         }
         else {
             CLIDisplay.task(I18n.formatMessage("commands.ts-to-schema.progress.generatingSchema"));
-            const schemas = await generateSchemas(typeSource, type, workingDirectory);
+            const autoExpandTypes = config.autoExpandTypes ?? [];
+            const defaultExpandTypes = ["ObjectOrArray<.*>"];
+            for (const defaultType of defaultExpandTypes) {
+                if (!autoExpandTypes.includes(defaultType)) {
+                    autoExpandTypes.push(defaultType);
+                }
+            }
+            const schemas = await generateSchemas(typeSource, type, autoExpandTypes, workingDirectory);
             if (Is.empty(schemas[type])) {
                 throw new GeneralError("commands", "commands.ts-to-schema.schemaNotFound", { type });
             }
@@ -112,11 +119,12 @@ async function tsToSchema(config, outputFolder, workingDirectory) {
  * Generate schemas for the models.
  * @param modelDirWildcards The filenames for all the models.
  * @param types The types of the schema objects.
+ * @param autoExpandTypes The types to automatically expand.
  * @param outputWorkingDir The working directory.
  * @returns Nothing.
  * @internal
  */
-async function generateSchemas(typeSource, type, outputWorkingDir) {
+async function generateSchemas(typeSource, type, autoExpandTypes, outputWorkingDir) {
     const allSchemas = {};
     CLIDisplay.value(I18n.formatMessage("commands.ts-to-schema.progress.models"), typeSource, 1);
     const generator = createGenerator({
@@ -129,82 +137,15 @@ async function generateSchemas(typeSource, type, outputWorkingDir) {
     const schema = generator.createSchema("*");
     if (schema.definitions) {
         for (const def in schema.definitions) {
-            const defSub = normaliseTypeName(def);
+            const defSub = JsonSchemaHelper.normaliseTypeName(def);
             allSchemas[defSub] = schema.definitions[def];
         }
     }
     const referencedSchemas = {};
-    extractTypes(allSchemas, [type], referencedSchemas);
+    JsonSchemaHelper.extractTypes(allSchemas, [type, ...autoExpandTypes], referencedSchemas);
+    JsonSchemaHelper.expandTypes(referencedSchemas, autoExpandTypes);
     return referencedSchemas;
 }
-/**
- * Extract the required types from all the known schemas.
- * @param allSchemas All the known schemas.
- * @param requiredTypes The required types.
- * @param referencedSchemas The references schemas.
- * @internal
- */
-function extractTypes(allSchemas, requiredTypes, referencedSchemas) {
-    for (const type of requiredTypes) {
-        if (allSchemas[type] && !referencedSchemas[type]) {
-            referencedSchemas[type] = allSchemas[type];
-            extractTypesFromSchema(allSchemas, allSchemas[type], referencedSchemas);
-        }
-    }
-}
-/**
- * Extract type from properties definition.
- * @param allTypes All the known types.
- * @param schema The schema to extract from.
- * @param output The output types.
- * @internal
- */
-function extractTypesFromSchema(allTypes, schema, output) {
-    const additionalTypes = [];
-    if (Is.stringValue(schema.$ref)) {
-        additionalTypes.push(schema.$ref.replace("#/definitions/", "").replace(/^Partial%3C(.*?)%3E/g, "$1"));
-    }
-    else if (Is.object(schema.items)) {
-        if (Is.arrayValue(schema.items)) {
-            for (const itemSchema of schema.items) {
-                extractTypesFromSchema(allTypes, itemSchema, output);
-            }
-        }
-        else {
-            extractTypesFromSchema(allTypes, schema.items, output);
-        }
-    }
-    else if (Is.object(schema.properties) || Is.object(schema.additionalProperties)) {
-        if (Is.object(schema.properties)) {
-            for (const prop in schema.properties) {
-                const p = schema.properties[prop];
-                if (Is.object(p)) {
-                    extractTypesFromSchema(allTypes, p, output);
-                }
-            }
-        }
-        if (Is.object(schema.additionalProperties)) {
-            extractTypesFromSchema(allTypes, schema.additionalProperties, output);
-        }
-    }
-    else if (Is.arrayValue(schema.anyOf)) {
-        for (const prop of schema.anyOf) {
-            if (Is.object(prop)) {
-                extractTypesFromSchema(allTypes, prop, output);
-            }
-        }
-    }
-    else if (Is.arrayValue(schema.oneOf)) {
-        for (const prop of schema.oneOf) {
-            if (Is.object(prop)) {
-                extractTypesFromSchema(allTypes, prop, output);
-            }
-        }
-    }
-    if (additionalTypes.length > 0) {
-        extractTypes(allTypes, additionalTypes, output);
-    }
-}
 /**
  * Process the schema object to ensure it has the correct properties.
  * @param schemaObject The schema object to process.
@@ -213,88 +154,15 @@ function extractTypesFromSchema(allTypes, schema, output) {
  * @returns The finalised schema object.
  */
 function finaliseSchema(schemaObject, baseUrl, type) {
-    processArrays(schemaObject);
+    JsonSchemaHelper.processArrays(schemaObject);
     const { description, ...rest } = schemaObject;
     return {
-        $schema: SCHEMA_VERSION,
+        $schema: JsonSchemaHelper.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);
-            }
-        }
-    }
-}
-/**
- * Cleanup TypeScript markers from the type name.
- * @param typeName The definition string to clean up.
- * @returns The cleaned up definition string.
- */
-function normaliseTypeName(typeName) {
-    // Remove the partial markers
-    let sTypeName = typeName.replace(/^Partial<(.*?)>/g, "$1");
-    sTypeName = sTypeName.replace(/Partial%3CI(.*?)%3E/g, "$1");
-    // Remove the omit markers
-    sTypeName = sTypeName.replace(/^Omit<(.*?),.*>/g, "$1");
-    sTypeName = sTypeName.replace(/Omit%3CI(.*?)%2C.*%3E/g, "$1");
-    // Remove the pick markers
-    sTypeName = sTypeName.replace(/^Pick<(.*?),.*>/g, "$1");
-    sTypeName = sTypeName.replace(/Pick%3CI(.*?)%2C.*%3E/g, "$1");
-    // Cleanup the generic markers
-    sTypeName = sTypeName.replace(/</g, "%3C").replace(/>/g, "%3E");
-    sTypeName = sTypeName.replace(/%3Cunknown%3E/g, "");
-    return sTypeName;
-}
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
@@ -314,7 +182,7 @@ class CLI extends CLIBase {
         return this.execute({
             title: "TWIN TypeScript To Schema",
             appName: "ts-to-schema",
-            version: "0.0.1", // x-release-please-version
+            version: "0.0.2-next.1", // x-release-please-version
             icon: "⚙️ ",
             supportsEnvFiles: false,
             overrideOutputWidth: options?.overrideOutputWidth

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

@@ -1,4 +1,4 @@
-import type { IJsonSchema } from "./IJsonSchema";
+import type { IJsonSchema } from "@twin.org/tools-core";
 /**
  * Configuration for the tool.
  */
@@ -12,7 +12,7 @@ export interface ITsToSchemaConfig {
      */
     types: string[];
     /**
-     * External type references
+     * External type references.
      */
     externalReferences?: {
         [id: string]: string;
@@ -23,4 +23,8 @@ export interface ITsToSchemaConfig {
     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,30 @@
 # @twin.org/ts-to-schema - Changelog
 
+## [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)
+
+
+### Features
+
+* 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))
+* 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
+
+* remove debugging ([4def3d1](https://github.com/twinfoundation/tools/commit/4def3d1ef6a41a3b3358f864214e6a7ec3f9c638))
+
+
+### 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)
 
 

package/docs/reference/interfaces/ITsToSchemaConfig.md

@@ -24,7 +24,7 @@ The source files to generate the types from.
 
 > `optional` **externalReferences**: `object`
 
-External type references
+External type references.
 
 #### Index Signature
 
@@ -41,3 +41,11 @@ Override for specific types, to be used when the type cannot be generated automa
 #### Index Signature
 
 \[`id`: `string`\]: `AnySchemaObject`
+
+***
+
+### autoExpandTypes?
+
+> `optional` **autoExpandTypes**: `string`[]
+
+The types to automatically expand inline in type definitions, reg ex string matches.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/ts-to-schema",
-	"version": "0.0.1",
+	"version": "0.0.2-next.1",
 	"description": "Tool to convert TypeScript definitions to JSON schemas",
 	"repository": {
 		"type": "git",
@@ -14,10 +14,10 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/cli-core": "^0.0.1",
-		"@twin.org/core": "^0.0.1",
-		"@twin.org/nameof": "^0.0.1",
-		"ajv": "8.17.1",
+		"@twin.org/cli-core": "next",
+		"@twin.org/core": "next",
+		"@twin.org/nameof": "next",
+		"@twin.org/tools-core": "0.0.2-next.1",
 		"commander": "14.0.0",
 		"glob": "11.0.2",
 		"ts-json-schema-generator": "2.4.0"

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

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