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

package/dist/cjs/index.cjs

@@ -196,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,
@@ -241,7 +241,7 @@ async function tsToOpenApi(config, outputFile, workingDirectory) {
     }
     cliCore.CLIDisplay.task(core.I18n.formatMessage("commands.ts-to-openapi.progress.generatingSchemas"));
     const autoExpandTypes = config.autoExpandTypes ?? [];
-    const defaultExpandTypes = ["ObjectOrArray<.*>"];
+    const defaultExpandTypes = ["/ObjectOrArray<.*>/"];
     for (const defaultType of defaultExpandTypes) {
         if (!autoExpandTypes.includes(defaultType)) {
             autoExpandTypes.push(defaultType);
@@ -665,7 +665,6 @@ async function finaliseOutput(usedCommonResponseTypes, schemas, openApi, securit
                 if (/I[A-Z]/.test(finalName)) {
                     finalName = finalName.slice(1);
                 }
-                finalName = finalName.replace("<", "_").replace(">", "_");
                 if (finalName.endsWith("[]")) {
                     finalName = `ListOf${finalName.slice(0, -2)}`;
                 }
@@ -872,7 +871,10 @@ async function generateSchemas(modelDirWildcards, types, autoExpandTypes, output
         }
     }
     const referencedSchemas = {};
-    toolsCore.JsonSchemaHelper.extractTypes(allSchemas, [...types, ...autoExpandTypes], 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}[]`] = {
@@ -1053,7 +1055,7 @@ class CLI extends cliCore.CLIBase {
         return this.execute({
             title: "TWIN TypeScript To OpenAPI",
             appName: "ts-to-openapi",
-            version: "0.0.2-next.1", // x-release-please-version
+            version: "0.0.2-next.3", // x-release-please-version
             icon: "⚙️ ",
             supportsEnvFiles: false,
             overrideOutputWidth: options?.overrideOutputWidth

package/dist/esm/index.mjs

@@ -3,7 +3,7 @@ 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 } from '@twin.org/core';
-import { JsonSchemaHelper } from '@twin.org/tools-core';
+import { OpenApiHelper, JsonSchemaHelper } from '@twin.org/tools-core';
 import { HttpStatusCode, MimeTypes } from '@twin.org/web';
 import { createGenerator } from 'ts-json-schema-generator';
 
@@ -193,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,
@@ -238,7 +238,7 @@ async function tsToOpenApi(config, outputFile, workingDirectory) {
     }
     CLIDisplay.task(I18n.formatMessage("commands.ts-to-openapi.progress.generatingSchemas"));
     const autoExpandTypes = config.autoExpandTypes ?? [];
-    const defaultExpandTypes = ["ObjectOrArray<.*>"];
+    const defaultExpandTypes = ["/ObjectOrArray<.*>/"];
     for (const defaultType of defaultExpandTypes) {
         if (!autoExpandTypes.includes(defaultType)) {
             autoExpandTypes.push(defaultType);
@@ -662,7 +662,6 @@ async function finaliseOutput(usedCommonResponseTypes, schemas, openApi, securit
                 if (/I[A-Z]/.test(finalName)) {
                     finalName = finalName.slice(1);
                 }
-                finalName = finalName.replace("<", "_").replace(">", "_");
                 if (finalName.endsWith("[]")) {
                     finalName = `ListOf${finalName.slice(0, -2)}`;
                 }
@@ -869,7 +868,10 @@ async function generateSchemas(modelDirWildcards, types, autoExpandTypes, output
         }
     }
     const referencedSchemas = {};
-    JsonSchemaHelper.extractTypes(allSchemas, [...types, ...autoExpandTypes], 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}[]`] = {
@@ -1050,7 +1052,7 @@ class CLI extends CLIBase {
         return this.execute({
             title: "TWIN TypeScript To OpenAPI",
             appName: "ts-to-openapi",
-            version: "0.0.2-next.1", // x-release-please-version
+            version: "0.0.2-next.3", // x-release-please-version
             icon: "⚙️ ",
             supportsEnvFiles: false,
             overrideOutputWidth: options?.overrideOutputWidth

package/docs/changelog.md

@@ -1,5 +1,33 @@
 # @twin.org/ts-to-openapi - Changelog
 
+## [0.0.2-next.3](https://github.com/twinfoundation/tools/compare/ts-to-openapi-v0.0.2-next.2...ts-to-openapi-v0.0.2-next.3) (2025-08-05)
+
+
+### Features
+
+* improve type name normalisation ([1fe28e5](https://github.com/twinfoundation/tools/commit/1fe28e567593e46a41a833fbba95fe4cd958f525))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/tools-core bumped from 0.0.2-next.2 to 0.0.2-next.3
+
+## [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)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/ts-to-openapi",
-	"version": "0.0.2-next.1",
+	"version": "0.0.2-next.3",
 	"description": "Tool to convert TypeScript REST route definitions to OpenAPI Specifications",
 	"repository": {
 		"type": "git",
@@ -18,10 +18,10 @@
 		"@twin.org/cli-core": "next",
 		"@twin.org/core": "next",
 		"@twin.org/nameof": "next",
-		"@twin.org/tools-core": "0.0.2-next.1",
+		"@twin.org/tools-core": "0.0.2-next.3",
 		"@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/IOpenApi.d.ts

@@ -1,54 +0,0 @@
-import type { IJsonSchema } from "@twin.org/tools-core";
-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,64 +0,0 @@
-import type { IJsonSchema, JsonTypeName } from "@twin.org/tools-core";
-import type { IOpenApiExample } from "./IOpenApiExample";
-import type { IOpenApiResponse } from "./IOpenApiResponse";
-/**
- * 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;
-}