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

package/dist/cjs/index.cjs

@@ -5,6 +5,7 @@ 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 web = require('@twin.org/web');
 var tsJsonSchemaGenerator = require('ts-json-schema-generator');
 
@@ -195,7 +196,7 @@ async function tsToOpenApi(config, outputFile, workingDirectory) {
         compilerOptions: {}
     }, undefined, "\t"));
     const openApi = {
-        openapi: "3.1.0",
+        openapi: toolsCore.OpenApiHelper.API_VERSION,
         info: {
             title: config.title,
             description: config.description,
@@ -239,7 +240,20 @@ async function tsToOpenApi(config, outputFile, workingDirectory) {
         }
     }
     cliCore.CLIDisplay.task(core.I18n.formatMessage("commands.ts-to-openapi.progress.generatingSchemas"));
-    const schemas = await generateSchemas(typeRoots, types, workingDirectory);
+    const autoExpandTypes = config.autoExpandTypes ?? [];
+    const defaultExpandTypes = ["/ObjectOrArray<.*>/"];
+    for (const defaultType of defaultExpandTypes) {
+        if (!autoExpandTypes.includes(defaultType)) {
+            autoExpandTypes.push(defaultType);
+        }
+    }
+    const schemas = await generateSchemas(typeRoots, types, autoExpandTypes, workingDirectory);
+    for (const type in schemas) {
+        if (core.Is.object(config.overrides?.[type])) {
+            cliCore.CLIDisplay.task(core.I18n.formatMessage("commands.ts-to-openapi.progress.overridingSchema"));
+            schemas[type] = config.overrides?.[type];
+        }
+    }
     const usedCommonResponseTypes = [];
     for (let i = 0; i < inputResults.length; i++) {
         const result = inputResults[i];
@@ -665,7 +679,7 @@ async function finaliseOutput(usedCommonResponseTypes, schemas, openApi, securit
         delete finalSchemas[type];
     }
     for (const type in finalSchemas) {
-        processArrays(finalSchemas[type]);
+        toolsCore.JsonSchemaHelper.processArrays(finalSchemas[type]);
     }
     const schemaKeys = Object.keys(finalSchemas);
     schemaKeys.sort();
@@ -698,7 +712,7 @@ async function finaliseOutput(usedCommonResponseTypes, schemas, openApi, securit
     // Remove the array [] from the type names
     // eslint-disable-next-line unicorn/better-regex
     json = json.replace(/#\/components\/schemas\/(.*)\[\]/g, "#/components/schemas/ListOf$1");
-    json = normaliseTypeName(json);
+    json = toolsCore.JsonSchemaHelper.normaliseTypeName(json);
     // Remove external references
     for (const finalExternal in finalExternals) {
         json = json.replace(new RegExp(`"#/components/schemas/${core.StringHelper.stripPrefix(finalExternal)}"`, "g"), `"${finalExternals[finalExternal]}"`);
@@ -828,7 +842,7 @@ async function processPackageRestDetails(restRoutes) {
  * @returns Nothing.
  * @internal
  */
-async function generateSchemas(modelDirWildcards, types, outputWorkingDir) {
+async function generateSchemas(modelDirWildcards, types, autoExpandTypes, outputWorkingDir) {
     const allSchemas = {};
     const arraySingularTypes = [];
     for (const type of types) {
@@ -852,13 +866,17 @@ async function generateSchemas(modelDirWildcards, types, 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, types, referencedSchemas);
+    toolsCore.JsonSchemaHelper.extractTypes(allSchemas, [
+        ...types,
+        ...autoExpandTypes.map(t => (t.startsWith("/") && t.endsWith("/") ? new RegExp(t) : t))
+    ], referencedSchemas);
+    toolsCore.JsonSchemaHelper.expandTypes(referencedSchemas, autoExpandTypes);
     for (const arraySingularType of arraySingularTypes) {
         referencedSchemas[`${arraySingularType}[]`] = {
             type: "array",
@@ -869,74 +887,6 @@ async function generateSchemas(modelDirWildcards, types, outputWorkingDir) {
     }
     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(normaliseTypeName(schema.$ref).replace("#/definitions/", ""));
-    }
-    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);
-    }
-}
 /**
  * Tidy up the schemas for use in OpenAPI context.
  * @param props The properties to tidy up.
@@ -1087,79 +1037,6 @@ async function loadPackages(tsToOpenApiConfig, outputWorkingDir, typeRoots) {
     }
     return restRoutes;
 }
-/**
- * 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);
-            delete schemaObject.items;
-        }
-        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.
@@ -1179,7 +1056,7 @@ class CLI extends cliCore.CLIBase {
         return this.execute({
             title: "TWIN TypeScript To OpenAPI",
             appName: "ts-to-openapi",
-            version: "0.0.1", // x-release-please-version
+            version: "0.0.2-next.2", // x-release-please-version
             icon: "⚙️ ",
             supportsEnvFiles: false,
             overrideOutputWidth: options?.overrideOutputWidth

package/dist/esm/index.mjs

@@ -2,7 +2,8 @@ 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, ObjectHelper, ArrayHelper } from '@twin.org/core';
+import { I18n, GeneralError, Is, StringHelper, ObjectHelper } from '@twin.org/core';
+import { OpenApiHelper, JsonSchemaHelper } from '@twin.org/tools-core';
 import { HttpStatusCode, MimeTypes } from '@twin.org/web';
 import { createGenerator } from 'ts-json-schema-generator';
 
@@ -192,7 +193,7 @@ async function tsToOpenApi(config, outputFile, workingDirectory) {
         compilerOptions: {}
     }, undefined, "\t"));
     const openApi = {
-        openapi: "3.1.0",
+        openapi: OpenApiHelper.API_VERSION,
         info: {
             title: config.title,
             description: config.description,
@@ -236,7 +237,20 @@ async function tsToOpenApi(config, outputFile, workingDirectory) {
         }
     }
     CLIDisplay.task(I18n.formatMessage("commands.ts-to-openapi.progress.generatingSchemas"));
-    const schemas = await generateSchemas(typeRoots, types, workingDirectory);
+    const autoExpandTypes = config.autoExpandTypes ?? [];
+    const defaultExpandTypes = ["/ObjectOrArray<.*>/"];
+    for (const defaultType of defaultExpandTypes) {
+        if (!autoExpandTypes.includes(defaultType)) {
+            autoExpandTypes.push(defaultType);
+        }
+    }
+    const schemas = await generateSchemas(typeRoots, types, autoExpandTypes, workingDirectory);
+    for (const type in schemas) {
+        if (Is.object(config.overrides?.[type])) {
+            CLIDisplay.task(I18n.formatMessage("commands.ts-to-openapi.progress.overridingSchema"));
+            schemas[type] = config.overrides?.[type];
+        }
+    }
     const usedCommonResponseTypes = [];
     for (let i = 0; i < inputResults.length; i++) {
         const result = inputResults[i];
@@ -662,7 +676,7 @@ async function finaliseOutput(usedCommonResponseTypes, schemas, openApi, securit
         delete finalSchemas[type];
     }
     for (const type in finalSchemas) {
-        processArrays(finalSchemas[type]);
+        JsonSchemaHelper.processArrays(finalSchemas[type]);
     }
     const schemaKeys = Object.keys(finalSchemas);
     schemaKeys.sort();
@@ -695,7 +709,7 @@ async function finaliseOutput(usedCommonResponseTypes, schemas, openApi, securit
     // Remove the array [] from the type names
     // eslint-disable-next-line unicorn/better-regex
     json = json.replace(/#\/components\/schemas\/(.*)\[\]/g, "#/components/schemas/ListOf$1");
-    json = normaliseTypeName(json);
+    json = JsonSchemaHelper.normaliseTypeName(json);
     // Remove external references
     for (const finalExternal in finalExternals) {
         json = json.replace(new RegExp(`"#/components/schemas/${StringHelper.stripPrefix(finalExternal)}"`, "g"), `"${finalExternals[finalExternal]}"`);
@@ -825,7 +839,7 @@ async function processPackageRestDetails(restRoutes) {
  * @returns Nothing.
  * @internal
  */
-async function generateSchemas(modelDirWildcards, types, outputWorkingDir) {
+async function generateSchemas(modelDirWildcards, types, autoExpandTypes, outputWorkingDir) {
     const allSchemas = {};
     const arraySingularTypes = [];
     for (const type of types) {
@@ -849,13 +863,17 @@ async function generateSchemas(modelDirWildcards, types, 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, types, referencedSchemas);
+    JsonSchemaHelper.extractTypes(allSchemas, [
+        ...types,
+        ...autoExpandTypes.map(t => (t.startsWith("/") && t.endsWith("/") ? new RegExp(t) : t))
+    ], referencedSchemas);
+    JsonSchemaHelper.expandTypes(referencedSchemas, autoExpandTypes);
     for (const arraySingularType of arraySingularTypes) {
         referencedSchemas[`${arraySingularType}[]`] = {
             type: "array",
@@ -866,74 +884,6 @@ async function generateSchemas(modelDirWildcards, types, outputWorkingDir) {
     }
     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(normaliseTypeName(schema.$ref).replace("#/definitions/", ""));
-    }
-    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);
-    }
-}
 /**
  * Tidy up the schemas for use in OpenAPI context.
  * @param props The properties to tidy up.
@@ -1084,79 +1034,6 @@ async function loadPackages(tsToOpenApiConfig, outputWorkingDir, typeRoots) {
     }
     return restRoutes;
 }
-/**
- * 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);
-            delete schemaObject.items;
-        }
-        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.
@@ -1176,7 +1053,7 @@ class CLI extends CLIBase {
         return this.execute({
             title: "TWIN TypeScript To OpenAPI",
             appName: "ts-to-openapi",
-            version: "0.0.1", // x-release-please-version
+            version: "0.0.2-next.2", // x-release-please-version
             icon: "⚙️ ",
             supportsEnvFiles: false,
             overrideOutputWidth: options?.overrideOutputWidth

package/dist/locales/en.json

@@ -284,6 +284,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/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,46 @@
 # @twin.org/ts-to-openapi - Changelog
 
+## [0.0.2-next.2](https://github.com/twinfoundation/tools/compare/ts-to-openapi-v0.0.2-next.1...ts-to-openapi-v0.0.2-next.2) (2025-07-17)
+
+
+### Features
+
+* improve auto expand types ([6181d1d](https://github.com/twinfoundation/tools/commit/6181d1daded1f91323195cf7efbc2f1881f38b41))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/tools-core bumped from 0.0.2-next.1 to 0.0.2-next.2
+
+## [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)
 
 

package/docs/reference/interfaces/ITsToOpenApiConfig.md

@@ -101,3 +101,23 @@ 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`\]: `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,6 +1,6 @@
 {
 	"name": "@twin.org/ts-to-openapi",
-	"version": "0.0.1",
+	"version": "0.0.2-next.2",
 	"description": "Tool to convert TypeScript REST route definitions to OpenAPI Specifications",
 	"repository": {
 		"type": "git",
@@ -14,14 +14,14 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/api-models": "^0.0.1-next.1",
-		"@twin.org/cli-core": "^0.0.1",
-		"@twin.org/core": "^0.0.1",
-		"@twin.org/nameof": "^0.0.1",
-		"@twin.org/web": "^0.0.1",
-		"ajv": "8.17.1",
+		"@twin.org/api-models": "next",
+		"@twin.org/cli-core": "next",
+		"@twin.org/core": "next",
+		"@twin.org/nameof": "next",
+		"@twin.org/tools-core": "0.0.2-next.2",
+		"@twin.org/web": "next",
 		"commander": "14.0.0",
-		"glob": "11.0.2",
+		"glob": "11.0.3",
 		"ts-json-schema-generator": "2.4.0"
 	},
 	"main": "./dist/cjs/index.cjs",

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;

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

@@ -1,54 +0,0 @@
-import type { IJsonSchema } from "./IJsonSchema";
-import type { IOpenApiPathMethod } from "./IOpenApiPathMethod";
-import type { IOpenApiSecurityScheme } from "./IOpenApiSecurityScheme";
-/**
- * The Open API config definition.
- */
-export interface IOpenApi {
-    /**
-     * The open api version.
-     */
-    openapi: string;
-    /**
-     * Info.
-     */
-    info: {
-        title: string;
-        version: string;
-        description: string;
-        license?: {
-            name: string;
-            url: string;
-        };
-    };
-    /**
-     * The servers for the endpoints.
-     */
-    servers?: {
-        url: string;
-    }[];
-    /**
-     * Tags for the endpoints.
-     */
-    tags?: {
-        name: string;
-        description: string;
-    }[];
-    /**
-     * The paths.
-     */
-    paths: {
-        [path: string]: {
-            [method: string]: IOpenApiPathMethod;
-        };
-    };
-    /**
-     * The components.
-     */
-    components?: {
-        schemas?: IJsonSchema;
-        securitySchemes?: {
-            [name: string]: IOpenApiSecurityScheme;
-        };
-    };
-}

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

@@ -1,13 +0,0 @@
-/**
- * The Open API config definition.
- */
-export interface IOpenApiExample {
-    /**
-     * The summary of the example.
-     */
-    summary?: string;
-    /**
-     * The value of the example.
-     */
-    value: unknown;
-}

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

@@ -1,19 +0,0 @@
-/**
- * The Open API config definition.
- */
-export interface IOpenApiHeader {
-    /**
-     * The schema of the header.
-     */
-    schema?: {
-        type: string;
-    };
-    /**
-     * The description of the header.
-     */
-    description?: string;
-    /**
-     * The format of the header.
-     */
-    format?: string;
-}

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

@@ -1,65 +0,0 @@
-import type { IJsonSchema } from "./IJsonSchema";
-import type { IOpenApiExample } from "./IOpenApiExample";
-import type { IOpenApiResponse } from "./IOpenApiResponse";
-import type { JsonTypeName } from "./jsonTypeName";
-/**
- * The Open API config definition.
- */
-export interface IOpenApiPathMethod {
-    /**
-     * The operation id.
-     */
-    operationId: string;
-    /**
-     * Summary.
-     */
-    summary: string;
-    /**
-     * Tags.
-     */
-    tags?: string[];
-    /**
-     * Parameters.
-     */
-    parameters?: {
-        name: string;
-        in: string;
-        description?: string;
-        required: boolean;
-        schema: {
-            type?: JsonTypeName | JsonTypeName[];
-            enum?: IJsonSchema[];
-            $ref?: string;
-        };
-        style?: string;
-    }[];
-    /**
-     * Request body.
-     */
-    requestBody?: {
-        required: boolean;
-        description?: string;
-        content?: {
-            [contentType: string]: {
-                schema: {
-                    $ref: string;
-                };
-                examples?: {
-                    [id: string]: IOpenApiExample;
-                };
-            };
-        };
-    };
-    /**
-     * Response body.
-     */
-    responses?: {
-        [code: string]: IOpenApiResponse;
-    };
-    /**
-     * Security model for the API.
-     */
-    security?: {
-        [name: string]: string[];
-    }[];
-}

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

@@ -1,32 +0,0 @@
-import type { IOpenApiExample } from "./IOpenApiExample";
-import type { IOpenApiHeader } from "./IOpenApiHeader";
-/**
- * The Open API config definition.
- */
-export interface IOpenApiResponse {
-    /**
-     * Descriptions for the response.
-     */
-    description?: string;
-    /**
-     * Content for the response.
-     */
-    content?: {
-        [contentType: string]: {
-            schema: {
-                type?: string;
-                format?: string;
-                $ref?: string;
-            };
-            examples?: {
-                [id: string]: IOpenApiExample;
-            };
-        };
-    };
-    /**
-     * The headers for the response.
-     */
-    headers?: {
-        [id: string]: IOpenApiHeader;
-    };
-}

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

@@ -1,25 +0,0 @@
-/**
- * The Open API config definition for security scheme.
- */
-export interface IOpenApiSecurityScheme {
-    /**
-     * The type of the security schema.
-     */
-    type?: string;
-    /**
-     * The scheme method.
-     */
-    scheme?: string;
-    /**
-     * The bearer format.
-     */
-    bearerFormat?: string;
-    /**
-     * Where is the token located.
-     */
-    in?: string;
-    /**
-     * What is the name of the token.
-     */
-    name?: string;
-}

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;
-    };
-}

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

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