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

package/dist/cjs/index.cjs

@@ -32,7 +32,7 @@ const HTTP_STATUS_CODE_MAP = {
         responseType: "IBadRequestResponse",
         example: {
             name: "GeneralError",
-            message: "component.error",
+            message: "errorMessage",
             properties: {
                 foo: "bar"
             }
@@ -43,7 +43,7 @@ const HTTP_STATUS_CODE_MAP = {
         responseType: "IUnauthorizedResponse",
         example: {
             name: "UnauthorizedError",
-            message: "component.error"
+            message: "errorMessage"
         }
     },
     forbidden: {
@@ -51,7 +51,7 @@ const HTTP_STATUS_CODE_MAP = {
         responseType: "IForbiddenResponse",
         example: {
             name: "NotImplementedError",
-            message: "component.error",
+            message: "errorMessage",
             properties: {
                 method: "aMethod"
             }
@@ -62,7 +62,7 @@ const HTTP_STATUS_CODE_MAP = {
         responseType: "INotFoundResponse",
         example: {
             name: "NotFoundError",
-            message: "component.error",
+            message: "errorMessage",
             properties: {
                 notFoundId: "1"
             }
@@ -73,7 +73,7 @@ const HTTP_STATUS_CODE_MAP = {
         responseType: "IConflictResponse",
         example: {
             name: "ConflictError",
-            message: "component.error",
+            message: "errorMessage",
             properties: {
                 conflicts: ["1"]
             }
@@ -84,7 +84,7 @@ const HTTP_STATUS_CODE_MAP = {
         responseType: "IInternalServerErrorResponse",
         example: {
             name: "InternalServerError",
-            message: "component.error"
+            message: "errorMessage"
         }
     },
     unprocessableEntity: {
@@ -92,7 +92,7 @@ const HTTP_STATUS_CODE_MAP = {
         responseType: "IUnprocessableEntityResponse",
         example: {
             name: "UnprocessableError",
-            message: "component.error"
+            message: "errorMessage"
         }
     }
 };
@@ -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);
@@ -438,12 +438,13 @@ async function tsToOpenApi(config, outputFile, workingDirectory) {
             if (requestObject?.properties) {
                 // If there are any properties other than body, query, pathParams and headers
                 // we should throw an error as we don't know what to do with them
-                const otherKeys = Object.keys(requestObject.properties).filter(k => !["body", "query", "pathParams", "headers"].includes(k));
+                const otherKeys = Object.keys(requestObject.properties).filter(k => !["body", "query", "pathParams", "headers", "authentication"].includes(k));
                 if (otherKeys.length > 0) {
                     throw new core.GeneralError("commands", "commands.ts-to-openapi.unsupportedProperties", {
                         keys: otherKeys.join(", ")
                     });
                 }
+                delete requestObject.properties.authentication;
                 // If there is a path params object convert these to params
                 if (core.Is.object(requestObject.properties.pathParams)) {
                     for (const pathParam of pathQueryHeaderParams) {
@@ -600,7 +601,7 @@ async function tsToOpenApi(config, outputFile, workingDirectory) {
             }
         }
     }
-    await finaliseOutput(usedCommonResponseTypes, schemas, openApi, securitySchemes, config.externalReferences, outputFile);
+    await finaliseOutput(usedCommonResponseTypes, schemas, openApi, securitySchemes, config.externalReferences, autoExpandTypes, outputFile);
 }
 /**
  * Finalise the schemas and output the spec.
@@ -609,9 +610,10 @@ async function tsToOpenApi(config, outputFile, workingDirectory) {
  * @param openApi The OpenAPI spec.
  * @param securitySchemes The security schemes.
  * @param externalReferences The external references.
+ * @param autoExpandTypes The auto expand types.
  * @param outputFile The output file.
  */
-async function finaliseOutput(usedCommonResponseTypes, schemas, openApi, securitySchemes, externalReferences, outputFile) {
+async function finaliseOutput(usedCommonResponseTypes, schemas, openApi, securitySchemes, externalReferences, autoExpandTypes, outputFile) {
     cliCore.CLIDisplay.break();
     cliCore.CLIDisplay.task(core.I18n.formatMessage("commands.ts-to-openapi.progress.finalisingSchemas"));
     // Remove the response codes that we haven't used
@@ -652,6 +654,15 @@ async function finaliseOutput(usedCommonResponseTypes, schemas, openApi, securit
                 }
             }
         }
+        // We can remove any auto expand types from the final schema as they
+        // will have been expanded inline so no need to keep them
+        for (const autoExpandType of autoExpandTypes) {
+            const regExp = toolsCore.JsonSchemaHelper.stringToRegEx(autoExpandType);
+            if (regExp.test(schema)) {
+                skipSchema = true;
+                break;
+            }
+        }
         if (!skipSchema) {
             // If the final schema has no properties and is just a ref to another object type
             // then replace the references with that of the referenced type
@@ -665,7 +676,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)}`;
                 }
@@ -1053,7 +1063,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.10", // 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';
 
@@ -29,7 +29,7 @@ const HTTP_STATUS_CODE_MAP = {
         responseType: "IBadRequestResponse",
         example: {
             name: "GeneralError",
-            message: "component.error",
+            message: "errorMessage",
             properties: {
                 foo: "bar"
             }
@@ -40,7 +40,7 @@ const HTTP_STATUS_CODE_MAP = {
         responseType: "IUnauthorizedResponse",
         example: {
             name: "UnauthorizedError",
-            message: "component.error"
+            message: "errorMessage"
         }
     },
     forbidden: {
@@ -48,7 +48,7 @@ const HTTP_STATUS_CODE_MAP = {
         responseType: "IForbiddenResponse",
         example: {
             name: "NotImplementedError",
-            message: "component.error",
+            message: "errorMessage",
             properties: {
                 method: "aMethod"
             }
@@ -59,7 +59,7 @@ const HTTP_STATUS_CODE_MAP = {
         responseType: "INotFoundResponse",
         example: {
             name: "NotFoundError",
-            message: "component.error",
+            message: "errorMessage",
             properties: {
                 notFoundId: "1"
             }
@@ -70,7 +70,7 @@ const HTTP_STATUS_CODE_MAP = {
         responseType: "IConflictResponse",
         example: {
             name: "ConflictError",
-            message: "component.error",
+            message: "errorMessage",
             properties: {
                 conflicts: ["1"]
             }
@@ -81,7 +81,7 @@ const HTTP_STATUS_CODE_MAP = {
         responseType: "IInternalServerErrorResponse",
         example: {
             name: "InternalServerError",
-            message: "component.error"
+            message: "errorMessage"
         }
     },
     unprocessableEntity: {
@@ -89,7 +89,7 @@ const HTTP_STATUS_CODE_MAP = {
         responseType: "IUnprocessableEntityResponse",
         example: {
             name: "UnprocessableError",
-            message: "component.error"
+            message: "errorMessage"
         }
     }
 };
@@ -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);
@@ -435,12 +435,13 @@ async function tsToOpenApi(config, outputFile, workingDirectory) {
             if (requestObject?.properties) {
                 // If there are any properties other than body, query, pathParams and headers
                 // we should throw an error as we don't know what to do with them
-                const otherKeys = Object.keys(requestObject.properties).filter(k => !["body", "query", "pathParams", "headers"].includes(k));
+                const otherKeys = Object.keys(requestObject.properties).filter(k => !["body", "query", "pathParams", "headers", "authentication"].includes(k));
                 if (otherKeys.length > 0) {
                     throw new GeneralError("commands", "commands.ts-to-openapi.unsupportedProperties", {
                         keys: otherKeys.join(", ")
                     });
                 }
+                delete requestObject.properties.authentication;
                 // If there is a path params object convert these to params
                 if (Is.object(requestObject.properties.pathParams)) {
                     for (const pathParam of pathQueryHeaderParams) {
@@ -597,7 +598,7 @@ async function tsToOpenApi(config, outputFile, workingDirectory) {
             }
         }
     }
-    await finaliseOutput(usedCommonResponseTypes, schemas, openApi, securitySchemes, config.externalReferences, outputFile);
+    await finaliseOutput(usedCommonResponseTypes, schemas, openApi, securitySchemes, config.externalReferences, autoExpandTypes, outputFile);
 }
 /**
  * Finalise the schemas and output the spec.
@@ -606,9 +607,10 @@ async function tsToOpenApi(config, outputFile, workingDirectory) {
  * @param openApi The OpenAPI spec.
  * @param securitySchemes The security schemes.
  * @param externalReferences The external references.
+ * @param autoExpandTypes The auto expand types.
  * @param outputFile The output file.
  */
-async function finaliseOutput(usedCommonResponseTypes, schemas, openApi, securitySchemes, externalReferences, outputFile) {
+async function finaliseOutput(usedCommonResponseTypes, schemas, openApi, securitySchemes, externalReferences, autoExpandTypes, outputFile) {
     CLIDisplay.break();
     CLIDisplay.task(I18n.formatMessage("commands.ts-to-openapi.progress.finalisingSchemas"));
     // Remove the response codes that we haven't used
@@ -649,6 +651,15 @@ async function finaliseOutput(usedCommonResponseTypes, schemas, openApi, securit
                 }
             }
         }
+        // We can remove any auto expand types from the final schema as they
+        // will have been expanded inline so no need to keep them
+        for (const autoExpandType of autoExpandTypes) {
+            const regExp = JsonSchemaHelper.stringToRegEx(autoExpandType);
+            if (regExp.test(schema)) {
+                skipSchema = true;
+                break;
+            }
+        }
         if (!skipSchema) {
             // If the final schema has no properties and is just a ref to another object type
             // then replace the references with that of the referenced type
@@ -662,7 +673,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)}`;
                 }
@@ -1050,7 +1060,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.10", // x-release-please-version
             icon: "⚙️ ",
             supportsEnvFiles: false,
             overrideOutputWidth: options?.overrideOutputWidth

package/dist/locales/en.json

@@ -44,8 +44,13 @@
 			"beUrl": "{fieldName} must be a correctly formatted url",
 			"beJSON": "{fieldName} must be correctly formatted JSON",
 			"beEmail": "{fieldName} must be a correctly formatted e-mail address",
-			"failed": "Validation failed",
-			"failedObject": "Validation of \"{objectName}\" failed"
+			"minLengthRequired": "The value length should be at least {minLength}, it is {actualLength}",
+			"maxLengthRequired": "The value length should be at most {maxLength}, it is {actualLength}",
+			"repeatedCharacters": "The value should not contain repeated characters in sequence",
+			"atLeastOneLowerCase": "The value should contain at least one lowercase character",
+			"atLeastOneUpperCase": "The value should contain at least one uppercase character",
+			"atLeastOneNumber": "The value should contain at least one number",
+			"atLeastOneSpecialChar": "The value should contain at least one symbol"
 		},
 		"guard": {
 			"undefined": "Property \"{property}\" must be defined, it is \"{value}\"",
@@ -78,9 +83,7 @@
 			"url": "Property \"{property}\" must be a Url formatted string, it is \"{value}\"",
 			"email": "Property \"{property}\" must be string in e-mail format, it is \"{value}\"",
 			"length32Multiple": "Property \"{property}\" should be a multiple of 32, it is {value}",
-			"lengthEntropy": "Property \"{property}\" should be a multiple of 4, >=16 and <= 32, it is {value}",
-			"length3Multiple": "Property \"{property}\" should be a multiple of 3, it is {value}",
-			"greaterThan0": "Property \"{property}\" must be greater than zero, it is {value}"
+			"lengthEntropy": "Property \"{property}\" should be a multiple of 4, >=16 and <= 32, it is {value}"
 		},
 		"objectHelper": {
 			"failedBytesToJSON": "Failed converting bytes to JSON",
@@ -96,7 +99,7 @@
 			"noGet": "The requested {typeName} \"{name}\" does not exist in the factory"
 		},
 		"bitString": {
-			"outOfRange": "The index should be >= 0 and less than the length of the bit string"
+			"outOfRange": "The index should be >= 0 and less than the length of the bit string, the index is \"{index}\" and the number of bit is \"{numberBits}\""
 		},
 		"base32": {
 			"invalidCharacter": "Data contains a character \"{invalidCharacter}\" which is not in the charset"
@@ -111,11 +114,12 @@
 			"failedPatch": "Failed to patch the JSON object, patch index \"{index}\" failed"
 		},
 		"fetchHelper": {
-			"decodingJSON": "Decoding JSON failed for route \"{route}\"",
+			"decodingJSON": "Decoding JSON failed for route \"{url}\"",
 			"failureStatusText": "The request to the API failed: \"{statusText}\"",
 			"connectivity": "The request failed, the API could be offline, or there are other connectivity issues",
 			"timeout": "The request timed out",
-			"general": "A general failure occurred during the request"
+			"general": "A general failure occurred during the request",
+			"retryLimitExceeded": "The retry limit was exceeded for route \"{url}\""
 		},
 		"jwt": {
 			"noKeyOrSigner": "No key or signer was provided for JWT creation",
@@ -131,10 +135,6 @@
 			"createFailed": "Failed to create JWS",
 			"verifyFailed": "Failed to verify JWS"
 		},
-		"bip39": {
-			"missingMnemonicWord": "The mnemonic contains a word not in the wordlist, \"{value}\"",
-			"checksumMismatch": "The checksum does not match \"{newChecksum}\" != \"{checksumBits}\""
-		},
 		"ed25519": {
 			"privateKeyLength": "The private key length is incorrect, it should be \"{requiredSize}\" but is \"{actualSize}\"",
 			"publicKeyLength": "The public key length is incorrect, it should be \"{requiredSize}\" but is \"{actualSize}\""
@@ -143,13 +143,6 @@
 			"privateKeyLength": "The private key length is incorrect, it should be \"{requiredSize}\" but is \"{actualSize}\"",
 			"publicKeyLength": "The public key length is incorrect, it should be \"{requiredSize}\" but is \"{actualSize}\""
 		},
-		"x25519": {
-			"invalidPublicKey": "Invalid Ed25519 Public Key"
-		},
-		"blake2b": {
-			"outputLength64": "The output length should be between 1 and 64, it is \"{outputLength}\"",
-			"keyLength64": "The key length should be between 1 and 64, it is \"{keyLength}\""
-		},
 		"sha512": {
 			"bitSize": "Only 224, 256, 384 or 512 bits are supported, it is \"{bitSize}\""
 		},
@@ -172,17 +165,6 @@
 			"lowerUpper": "The address my use either lowercase or uppercase, \"{bech32}\"",
 			"dataTooShort": "The address does not contain enough data to decode, \"{bech32}\""
 		},
-		"pbkdf2": {
-			"keyTooLong": "The requested key length \"{keyLength}\" is too long, based on the \"{macLength}\""
-		},
-		"chaCha20Poly1305": {
-			"noAadWithData": "You can not set the aad when there is already data",
-			"noAuthTag": "Can not finalise when the auth tag is not set",
-			"authenticationFailed": "The data could not be authenticated",
-			"authTagDecrypting": "Can not get the auth tag when decrypting",
-			"authTagEncrypting": "Can not set the auth tag when encrypting",
-			"noAuthTagSet": "The auth tag has not been set"
-		},
 		"bip44": {
 			"unsupportedKeyType": "The key type \"{keyType}\" is not supported"
 		},
@@ -195,7 +177,6 @@
 				"optionInvalidHex": "The \"{option}\" does not appear to be hex. \"{value}\"",
 				"optionInvalidBase64": "The \"{option}\" does not appear to be base64. \"{value}\"",
 				"optionInvalidHexBase64": "The \"{option}\" does not appear to be hex or base64. \"{value}\"",
-				"optionInvalidBech32": "The \"{option}\" does not appear to be bech32. \"{value}\"",
 				"optionMinValue": "The \"{option}\" option must be greater than or equal to {minValue}, it is {value}.",
 				"optionMaxValue": "The \"{option}\" option must be less than or equal to {maxValue}, it is {value}."
 			},
@@ -217,7 +198,8 @@
 		"alreadyExistsError": "Already Exists",
 		"notImplementedError": "Not Implemented",
 		"validationError": "Validation",
-		"unprocessableError": "Unprocessable"
+		"unprocessableError": "Unprocessable",
+		"unauthorizedError": "Unauthorized"
 	},
 	"validation": {
 		"defaultFieldName": "The field"
@@ -225,6 +207,11 @@
 	"errorMessages": {
 		"fetch": "Fetch"
 	},
+	"warn": {
+		"common": {
+			"devOnlyTool": "This tool is intended to be used for development purposes, it is not recommended for use in production scenarios."
+		}
+	},
 	"cli": {
 		"progress": {
 			"done": "Done.",

package/docs/changelog.md

@@ -1,5 +1,131 @@
 # @twin.org/ts-to-openapi - Changelog
 
+## [0.0.2-next.10](https://github.com/twinfoundation/tools/compare/ts-to-openapi-v0.0.2-next.9...ts-to-openapi-v0.0.2-next.10) (2025-10-09)
+
+
+### Features
+
+* add validate-locales ([97bb11f](https://github.com/twinfoundation/tools/commit/97bb11fd9e6ed400e7fa69671075ba78f36ca6e6))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/tools-core bumped from 0.0.2-next.9 to 0.0.2-next.10
+
+## [0.0.2-next.9](https://github.com/twinfoundation/tools/compare/ts-to-openapi-v0.0.2-next.8...ts-to-openapi-v0.0.2-next.9) (2025-09-23)
+
+
+### Features
+
+* add support for authentication property ([ba002c2](https://github.com/twinfoundation/tools/commit/ba002c2c641618ffe7664269179bca6e9fbc9655))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/tools-core bumped from 0.0.2-next.8 to 0.0.2-next.9
+
+## [0.0.2-next.8](https://github.com/twinfoundation/tools/compare/ts-to-openapi-v0.0.2-next.7...ts-to-openapi-v0.0.2-next.8) (2025-09-05)
+
+
+### Features
+
+* tighten the types included with the regex matching ([e54909b](https://github.com/twinfoundation/tools/commit/e54909bded4a19d00560dd3ec783e9146580bda3))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/tools-core bumped from 0.0.2-next.7 to 0.0.2-next.8
+
+## [0.0.2-next.7](https://github.com/twinfoundation/tools/compare/ts-to-openapi-v0.0.2-next.6...ts-to-openapi-v0.0.2-next.7) (2025-08-29)
+
+
+### Features
+
+* eslint migration to flat config ([25acfcf](https://github.com/twinfoundation/tools/commit/25acfcf4c4e0c496fffeaf67659fe171bc15199a))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/tools-core bumped from 0.0.2-next.6 to 0.0.2-next.7
+
+## [0.0.2-next.6](https://github.com/twinfoundation/tools/compare/ts-to-openapi-v0.0.2-next.5...ts-to-openapi-v0.0.2-next.6) (2025-08-21)
+
+
+### Features
+
+* remove auto expanded types from final output ([18e05dc](https://github.com/twinfoundation/tools/commit/18e05dc88f71a0a27b79d1d076b1261b42d2c4c2))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/tools-core bumped from 0.0.2-next.5 to 0.0.2-next.6
+
+## [0.0.2-next.5](https://github.com/twinfoundation/tools/compare/ts-to-openapi-v0.0.2-next.4...ts-to-openapi-v0.0.2-next.5) (2025-08-19)
+
+
+### Features
+
+* correctly handle auto expand types ([57fce0f](https://github.com/twinfoundation/tools/commit/57fce0f9ec4a0876665d70adc6e885f6feb3caf7))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/tools-core bumped from 0.0.2-next.4 to 0.0.2-next.5
+
+## [0.0.2-next.4](https://github.com/twinfoundation/tools/compare/ts-to-openapi-v0.0.2-next.3...ts-to-openapi-v0.0.2-next.4) (2025-08-19)
+
+
+### Miscellaneous Chores
+
+* **ts-to-openapi:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/tools-core bumped from 0.0.2-next.3 to 0.0.2-next.4
+
+## [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/docs/examples.md

@@ -254,7 +254,7 @@ The generated `output.json` should be:
             }
           },
           {
-            "name": "pageSize",
+            "name": "limit",
             "description": "The maximum number of entities in a page.",
             "in": "query",
             "required": false,

package/locales/.validate-ignore

@@ -0,0 +1 @@
+^errorMessage$

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/ts-to-openapi",
-	"version": "0.0.2-next.1",
+	"version": "0.0.2-next.10",
 	"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.10",
 		"@twin.org/web": "next",
-		"commander": "14.0.0",
-		"glob": "11.0.2",
+		"commander": "14.0.1",
+		"glob": "11.0.3",
 		"ts-json-schema-generator": "2.4.0"
 	},
 	"main": "./dist/cjs/index.cjs",
@@ -45,5 +45,17 @@
 	],
 	"bin": {
 		"ts-to-openapi": "bin/index.js"
-	}
+	},
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"tools"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/tools/issues"
+	},
+	"homepage": "https://twindev.org"
 }

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