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

package/dist/cjs/index.cjs

@@ -607,6 +607,7 @@ async function finaliseOutput(usedCommonResponseTypes, schemas, openApi, securit
         }
     }
     const substituteSchemas = [];
+    const finalExternals = {};
     // Remove the I, < and > from names
     const finalSchemas = {};
     for (const schema in schemas) {
@@ -629,8 +630,10 @@ async function finaliseOutput(usedCommonResponseTypes, schemas, openApi, securit
         // If the schema is external then remove it from the final schemas
         if (core.Is.object(externalReferences)) {
             for (const external in externalReferences) {
-                if (new RegExp(`^${external}$`).test(schema)) {
+                const re = new RegExp(`^I?${external}(?<!Request|Response)$`);
+                if (re.test(schema)) {
                     skipSchema = true;
+                    finalExternals[core.StringHelper.stripPrefix(schema)] = schema.replace(re, externalReferences[external]);
                     break;
                 }
             }
@@ -659,6 +662,9 @@ async function finaliseOutput(usedCommonResponseTypes, schemas, openApi, securit
     if (finalSchemas.HttpStatusCode) {
         delete finalSchemas.HttpStatusCode;
     }
+    if (finalSchemas.Uint8Array) {
+        delete finalSchemas.Uint8Array;
+    }
     const schemaKeys = Object.keys(finalSchemas);
     schemaKeys.sort();
     const sortedSchemas = {};
@@ -669,7 +675,7 @@ async function finaliseOutput(usedCommonResponseTypes, schemas, openApi, securit
         schemas: sortedSchemas,
         securitySchemes
     };
-    let json = JSON.stringify(openApi, undefined, "    ");
+    let json = JSON.stringify(openApi, undefined, "\t");
     // Remove the reference only schemas, repeating until no more substitutions
     let performedSubstitution;
     do {
@@ -695,17 +701,15 @@ async function finaliseOutput(usedCommonResponseTypes, schemas, openApi, securit
     // Cleanup the generic markers
     json = json.replace(/%3Cunknown%3E/g, "");
     // Remove external references
-    if (core.Is.objectValue(externalReferences)) {
-        for (const external in externalReferences) {
-            json = json.replace(new RegExp(`#/components/schemas/${core.StringHelper.stripPrefix(external)}`, "g"), externalReferences[external]);
-        }
+    for (const finalExternal in finalExternals) {
+        json = json.replace(new RegExp(`"#/components/schemas/${core.StringHelper.stripPrefix(finalExternal)}"`, "g"), `"${finalExternals[finalExternal]}"`);
     }
     cliCore.CLIDisplay.task(core.I18n.formatMessage("commands.ts-to-openapi.progress.writingOutputFile"), outputFile);
     try {
         await promises.mkdir(path.dirname(outputFile), { recursive: true });
     }
     catch { }
-    await promises.writeFile(outputFile, json);
+    await promises.writeFile(outputFile, `${json}\n`);
 }
 /**
  * Build the security schemas from the config.
@@ -1098,16 +1102,19 @@ class CLI extends cliCore.CLIBase {
      * Run the app.
      * @param argv The process arguments.
      * @param localesDirectory The directory for the locales, default to relative to the script.
+     * @param options Additional options.
+     * @param options.overrideOutputWidth Override the output width.
      * @returns The exit code.
      */
-    async run(argv, localesDirectory) {
+    async run(argv, localesDirectory, options) {
         return this.execute({
             title: "TWIN TypeScript To OpenAPI",
             appName: "ts-to-openapi",
-            version: "0.0.1-next.2",
+            version: "0.0.1-next.20", // x-release-please-version
             icon: "⚙️ ",
-            supportsEnvFiles: false
-        }, localesDirectory ?? path.join(path.dirname(node_url.fileURLToPath((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.src || new URL('index.cjs', document.baseURI).href)))), "../locales"), argv);
+            supportsEnvFiles: false,
+            overrideOutputWidth: options?.overrideOutputWidth
+        }, localesDirectory ?? path.join(path.dirname(node_url.fileURLToPath((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('index.cjs', document.baseURI).href)))), "../locales"), argv);
     }
     /**
      * Configure any options or actions at the root program level.

package/dist/esm/index.mjs

@@ -604,6 +604,7 @@ async function finaliseOutput(usedCommonResponseTypes, schemas, openApi, securit
         }
     }
     const substituteSchemas = [];
+    const finalExternals = {};
     // Remove the I, < and > from names
     const finalSchemas = {};
     for (const schema in schemas) {
@@ -626,8 +627,10 @@ async function finaliseOutput(usedCommonResponseTypes, schemas, openApi, securit
         // If the schema is external then remove it from the final schemas
         if (Is.object(externalReferences)) {
             for (const external in externalReferences) {
-                if (new RegExp(`^${external}$`).test(schema)) {
+                const re = new RegExp(`^I?${external}(?<!Request|Response)$`);
+                if (re.test(schema)) {
                     skipSchema = true;
+                    finalExternals[StringHelper.stripPrefix(schema)] = schema.replace(re, externalReferences[external]);
                     break;
                 }
             }
@@ -656,6 +659,9 @@ async function finaliseOutput(usedCommonResponseTypes, schemas, openApi, securit
     if (finalSchemas.HttpStatusCode) {
         delete finalSchemas.HttpStatusCode;
     }
+    if (finalSchemas.Uint8Array) {
+        delete finalSchemas.Uint8Array;
+    }
     const schemaKeys = Object.keys(finalSchemas);
     schemaKeys.sort();
     const sortedSchemas = {};
@@ -666,7 +672,7 @@ async function finaliseOutput(usedCommonResponseTypes, schemas, openApi, securit
         schemas: sortedSchemas,
         securitySchemes
     };
-    let json = JSON.stringify(openApi, undefined, "    ");
+    let json = JSON.stringify(openApi, undefined, "\t");
     // Remove the reference only schemas, repeating until no more substitutions
     let performedSubstitution;
     do {
@@ -692,17 +698,15 @@ async function finaliseOutput(usedCommonResponseTypes, schemas, openApi, securit
     // Cleanup the generic markers
     json = json.replace(/%3Cunknown%3E/g, "");
     // Remove external references
-    if (Is.objectValue(externalReferences)) {
-        for (const external in externalReferences) {
-            json = json.replace(new RegExp(`#/components/schemas/${StringHelper.stripPrefix(external)}`, "g"), externalReferences[external]);
-        }
+    for (const finalExternal in finalExternals) {
+        json = json.replace(new RegExp(`"#/components/schemas/${StringHelper.stripPrefix(finalExternal)}"`, "g"), `"${finalExternals[finalExternal]}"`);
     }
     CLIDisplay.task(I18n.formatMessage("commands.ts-to-openapi.progress.writingOutputFile"), outputFile);
     try {
         await mkdir(path.dirname(outputFile), { recursive: true });
     }
     catch { }
-    await writeFile(outputFile, json);
+    await writeFile(outputFile, `${json}\n`);
 }
 /**
  * Build the security schemas from the config.
@@ -1095,15 +1099,18 @@ class CLI extends CLIBase {
      * Run the app.
      * @param argv The process arguments.
      * @param localesDirectory The directory for the locales, default to relative to the script.
+     * @param options Additional options.
+     * @param options.overrideOutputWidth Override the output width.
      * @returns The exit code.
      */
-    async run(argv, localesDirectory) {
+    async run(argv, localesDirectory, options) {
         return this.execute({
             title: "TWIN TypeScript To OpenAPI",
             appName: "ts-to-openapi",
-            version: "0.0.1-next.2",
+            version: "0.0.1-next.20", // x-release-please-version
             icon: "⚙️ ",
-            supportsEnvFiles: false
+            supportsEnvFiles: false,
+            overrideOutputWidth: options?.overrideOutputWidth
         }, localesDirectory ?? path.join(path.dirname(fileURLToPath(import.meta.url)), "../locales"), argv);
     }
     /**

package/dist/locales/en.json

@@ -1,274 +1,301 @@
 {
-  "error": {
-    "commands": {
-      "ts-to-openapi": {
-        "configFailed": "Configuration failed to load.",
-        "missingRestRoutesEntryPoints": "Missing REST routes method \"{method}\" in package \"{package}\".",
-        "missingRestRoutesEntryPoint": "Missing REST routes entryPoint \"{entryPoint}\" in package \"{package}\".",
-        "unsupportedProperties": "Unsupported properties found in the request object \"{keys}\"."
-      },
-      "common": {
-        "missingEnv": "The \"{option}\" option is configured as an environment variable, but there is no environment variable with the name \"{value}\" set.",
-        "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}."
-      }
-    },
-    "baseRestClient": {
-      "missingRouteProp": "Missing route parameter in data \"{routeProp}\" for route \"{route}\"",
-      "decodingFailed": "Decoding JSON failed for route \"{route}\"",
-      "failureStatusText": "The request to the API failed: \"{statusText}\""
-    },
-    "validation": {
-      "beEmpty": "{fieldName} must be empty",
-      "beNotEmpty": "{fieldName} must not be empty",
-      "beText": "{fieldName} must be text",
-      "beTextValue": "{fieldName} must contain some text",
-      "beTextMinMax": "{fieldName} must be longer than {minLength} and shorter than {maxLength} characters",
-      "beTextMin": "{fieldName} must be longer than {minLength} characters",
-      "beTextMax": "{fieldName} must be shorter than {maxLength} characters",
-      "beNumber": "{fieldName} must be a number",
-      "beNumberMinMax": "{fieldName} must be >= {minValue} and <= {maxValue}",
-      "beNumberMin": "{fieldName} must be >= {minValue}",
-      "beNumberMax": "{fieldName} must be <= {maxValue}",
-      "beWholeNumber": "{fieldName} must be a whole number",
-      "beWholeNumberMinMax": "{fieldName} must be a whole number >= {minValue} and <= {maxValue}",
-      "beWholeNumberMin": "{fieldName} must be a whole number >= {minValue}",
-      "beWholeNumberMax": "{fieldName} must be a whole number <= {maxValue}",
-      "beBigInteger": "{fieldName} must be a bigint",
-      "beBigIntegerMinMax": "{fieldName} must be a bigint >= {minValue} and <= {maxValue}",
-      "beBigIntegerMin": "{fieldName} must be a bigint >= {minValue}",
-      "beBigIntegerMax": "{fieldName} must be a bigint <= {maxValue}",
-      "beBoolean": "{fieldName} must be true or false",
-      "beDate": "{fieldName} must be a date",
-      "beDateTime": "{fieldName} must be a date/time",
-      "beTime": "{fieldName} must be a time",
-      "beTimestampMilliseconds": "{fieldName} must be a timestamp in milliseconds",
-      "beTimestampSeconds": "{fieldName} must be a timestamp in seconds",
-      "beObject": "{fieldName} must be an object",
-      "beArray": "{fieldName} must be an array",
-      "beArrayValue": "{fieldName} must be an array with at least one item",
-      "beIncluded": "{fieldName} is unrecognised",
-      "beByteArray": "{fieldName} must be a byte array",
-      "beUrn": "{fieldName} must be a correctly formatted urn",
-      "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"
-    },
-    "guard": {
-      "undefined": "Property \"{property}\" must be defined, it is \"{value}\"",
-      "string": "Property \"{property}\" must be a string, it is \"{value}\"",
-      "stringEmpty": "Property \"{property}\" must have a value, it is empty",
-      "stringBase64": "Property \"{property}\" must be a base64 encoded string, it is \"{value}\"",
-      "stringBase64Url": "Property \"{property}\" must be a base64 url encoded string, it is \"{value}\"",
-      "stringHex": "Property \"{property}\" must be a hex string, it is \"{value}\"",
-      "stringHexLength": "Property \"{property}\" must be a hex string of length \"{options}\", it is \"{value}\"",
-      "number": "Property \"{property}\" must be a number, it is \"{value}\"",
-      "integer": "Property \"{property}\" must be an integer, it is \"{value}\"",
-      "bigint": "Property \"{property}\" must be a bigint, it is \"{value}\"",
-      "boolean": "Property \"{property}\" must be a boolean, it is \"{value}\"",
-      "date": "Property \"{property}\" must be a date, it is \"{value}\"",
-      "timestampMilliseconds": "Property \"{property}\" must be a timestamp in milliseconds, it is \"{value}\"",
-      "timestampSeconds": "Property \"{property}\" must be a timestamp in seconds, it is \"{value}\"",
-      "objectUndefined": "Property \"{property}\" must be an object, it is \"undefined\"",
-      "object": "Property \"{property}\" must be an object, it is \"{value}\"",
-      "objectValue": "Property \"{property}\" must be an object, with at least one property, it is \"{value}\"",
-      "array": "Property \"{property}\" must be an array, it is \"{value}\"",
-      "arrayValue": "Property \"{property}\" must be an array with at least one item",
-      "arrayOneOf": "Property \"{property}\" must be one of [{options}], it is \"{value}\"",
-      "uint8Array": "Property \"{property}\" must be a Uint8Array, it is \"{value}\"",
-      "function": "Property \"{property}\" must be a function, it is \"{value}\"",
-      "urn": "Property \"{property}\" must be a Urn formatted string, it is \"{value}\"",
-      "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}"
-    },
-    "objectHelper": {
-      "failedBytesToJSON": "Failed converting bytes to JSON"
-    },
-    "common": {
-      "notImplementedMethod": "The method \"{method}\" has not been implemented",
-      "validation": "Validation failed"
-    },
-    "factory": {
-      "noUnregister": "There is no {typeName} registered with the name \"{name}\"",
-      "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"
-    },
-    "fetchHelper": {
-      "decodingJSON": "Decoding JSON failed for route \"{route}\"",
-      "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"
-    },
-    "jwt": {
-      "noKeyOrSigner": "No key or signer was provided for JWT creation",
-      "noKeyOrVerifier": "No key or verifier was provided for JWT creation"
-    },
-    "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}\""
-    },
-    "secp256k1": {
-      "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}\""
-    },
-    "sha256": {
-      "bitSize": "Only 224 or 256 bits are supported, it is \"{bitSize}\""
-    },
-    "hmacSha256": {
-      "bitSize": "Only 224 or 256 bits are supported, it is \"{bitSize}\""
-    },
-    "hmacSha512": {
-      "bitSize": "Only 224, 256, 384 or 512 bits are supported, it is \"{bitSize}\""
-    },
-    "base32": {
-      "invalidCharacter": "Data contains a character \"{invalidCharacter}\" which is not in the charset"
-    },
-    "base64": {
-      "length4Multiple": "Invalid length should be a multiple of 4, it is \"{value}\""
-    },
-    "bech32": {
-      "decodeFailed": "The address contains decoding failed for address \"{bech32}\"",
-      "invalidChecksum": "The address contains an invalid checksum in address, \"{bech32}\"",
-      "separatorMisused": "The separator character '1' should only be used between hrp and data, \"{bech32}\"",
-      "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"
-    },
-    "slip0010": {
-      "invalidSeed": "The seed is invalid \"{seed}\""
-    }
-  },
-  "commands": {
-    "ts-to-openapi": {
-      "options": {
-        "config": {
-          "param": "'<'config'>'",
-          "description": "Path to the JSON configuration file."
-        },
-        "output-file": {
-          "param": "'<'output-file'>'",
-          "description": "The JSON file to write the OpenAPI spec."
-        }
-      },
-      "progress": {
-        "loadingConfigJson": "Loading Config JSON",
-        "creatingWorkingDir": "Creating Working Directory",
-        "creatingSecuritySchemas": "Creating Security Schemas",
-        "generatingSchemas": "Generating Schemas",
-        "finalisingSchemas": "Finalising Schemas",
-        "writingOutputFile": "Writing Output File",
-        "models": "Models",
-        "installingNpmPackages": "Installing NPM Packages",
-        "processingPackage": "Processing Package",
-        "importingModule": "Importing Module",
-        "processingRoutes": "Processing Routes"
-      },
-      "labels": {
-        "configJson": "Config JSON",
-        "outputFile": "Output File",
-        "outputWorkingDir": "Output Working Directory",
-        "route": "Route"
-      }
-    }
-  },
-  "errorNames": {
-    "error": "Error",
-    "generalError": "General",
-    "guardError": "Guard",
-    "conflictError": "Conflict",
-    "notFoundError": "Not Found",
-    "notSupportedError": "Not Supported",
-    "alreadyExistsError": "Already Exists",
-    "notImplementedError": "Not Implemented",
-    "validationError": "Validation",
-    "unprocessableError": "Unprocessable"
-  },
-  "validation": {
-    "defaultFieldName": "The field"
-  },
-  "errorMessages": {
-    "fetch": "Fetch"
-  },
-  "cli": {
-    "progress": {
-      "done": "Done.",
-      "error": "Error",
-      "loadingEnvFiles": "Loading env files",
-      "pleaseWait": "Please wait...",
-      "writingJsonFile": "Writing JSON file",
-      "writingEnvFile": "Writing env file",
-      "readingJsonFile": "Reading JSON file",
-      "readingEnvFile": "Reading env file"
-    },
-    "options": {
-      "lang": {
-        "param": "--lang '<'lang'>'",
-        "description": "The language to display the output in."
-      },
-      "load-env": {
-        "param": "--load-env [env...]",
-        "description": "Load the env files to initialise any environment variables."
-      },
-      "no-console": {
-        "param": "--no-console",
-        "description": "Hides the output in the console."
-      },
-      "json": {
-        "param": "--json '<'filename'>'",
-        "description": "Creates a JSON file containing the output."
-      },
-      "env": {
-        "param": "--env '<'filename'>'",
-        "description": "Creates an env file containing the output."
-      },
-      "merge-json": {
-        "param": "--merge-json",
-        "description": "If the JSON file already exists merge the data instead of overwriting."
-      },
-      "merge-env": {
-        "param": "--merge-env",
-        "description": "If the env file already exists merge the data instead of overwriting."
-      }
-    }
-  }
-}
+	"error": {
+		"baseRestClient": {
+			"missingRouteProp": "Missing route parameter in data \"{routeProp}\" for route \"{route}\"",
+			"decodingFailed": "Decoding JSON failed for route \"{route}\"",
+			"failureStatusText": "The request to the API failed: \"{statusText}\""
+		},
+		"validation": {
+			"beEmpty": "{fieldName} must be empty",
+			"beNotEmpty": "{fieldName} must not be empty",
+			"beText": "{fieldName} must be text",
+			"beTextValue": "{fieldName} must contain some text",
+			"beTextMinMax": "{fieldName} must be longer than {minLength} and shorter than {maxLength} characters",
+			"beTextMin": "{fieldName} must be longer than {minLength} characters",
+			"beTextMax": "{fieldName} must be shorter than {maxLength} characters",
+			"beTextBase58": "{fieldName} must be text formatted using Base58 characters",
+			"beTextBase64": "{fieldName} must be text formatted using Base64 characters",
+			"beTextHex": "{fieldName} must be text formatted using Hex characters",
+			"beTextRegExp": "{fieldName} must be text formatted using the matching pattern {format}",
+			"beNumber": "{fieldName} must be a number",
+			"beNumberMinMax": "{fieldName} must be >= {minValue} and <= {maxValue}",
+			"beNumberMin": "{fieldName} must be >= {minValue}",
+			"beNumberMax": "{fieldName} must be <= {maxValue}",
+			"beWholeNumber": "{fieldName} must be a whole number",
+			"beWholeNumberMinMax": "{fieldName} must be a whole number >= {minValue} and <= {maxValue}",
+			"beWholeNumberMin": "{fieldName} must be a whole number >= {minValue}",
+			"beWholeNumberMax": "{fieldName} must be a whole number <= {maxValue}",
+			"beBigInteger": "{fieldName} must be a bigint",
+			"beBigIntegerMinMax": "{fieldName} must be a bigint >= {minValue} and <= {maxValue}",
+			"beBigIntegerMin": "{fieldName} must be a bigint >= {minValue}",
+			"beBigIntegerMax": "{fieldName} must be a bigint <= {maxValue}",
+			"beBoolean": "{fieldName} must be true or false",
+			"beDate": "{fieldName} must be a date",
+			"beDateTime": "{fieldName} must be a date/time",
+			"beTime": "{fieldName} must be a time",
+			"beTimestampMilliseconds": "{fieldName} must be a timestamp in milliseconds",
+			"beTimestampSeconds": "{fieldName} must be a timestamp in seconds",
+			"beObject": "{fieldName} must be an object",
+			"beArray": "{fieldName} must be an array",
+			"beArrayValue": "{fieldName} must be an array with at least one item",
+			"beIncluded": "{fieldName} is unrecognised",
+			"beByteArray": "{fieldName} must be a byte array",
+			"beUrn": "{fieldName} must be a correctly formatted urn",
+			"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"
+		},
+		"guard": {
+			"undefined": "Property \"{property}\" must be defined, it is \"{value}\"",
+			"string": "Property \"{property}\" must be a string, it is \"{value}\"",
+			"stringEmpty": "Property \"{property}\" must have a value, it is empty",
+			"stringBase64": "Property \"{property}\" must be a base64 encoded string, it is \"{value}\"",
+			"stringBase64Url": "Property \"{property}\" must be a base64 url encoded string, it is \"{value}\"",
+			"stringBase58": "Property \"{property}\" must be a base58 encoded string, it is \"{value}\"",
+			"stringHex": "Property \"{property}\" must be a hex string, it is \"{value}\"",
+			"stringHexLength": "Property \"{property}\" must be a hex string of length \"{options}\", it is \"{value}\"",
+			"stringJson": "Property \"{property}\" must be a JSON string",
+			"number": "Property \"{property}\" must be a number, it is \"{value}\"",
+			"integer": "Property \"{property}\" must be an integer, it is \"{value}\"",
+			"bigint": "Property \"{property}\" must be a bigint, it is \"{value}\"",
+			"boolean": "Property \"{property}\" must be a boolean, it is \"{value}\"",
+			"date": "Property \"{property}\" must be a date, it is \"{value}\"",
+			"timestampMilliseconds": "Property \"{property}\" must be a timestamp in milliseconds, it is \"{value}\"",
+			"timestampSeconds": "Property \"{property}\" must be a timestamp in seconds, it is \"{value}\"",
+			"objectUndefined": "Property \"{property}\" must be an object, it is \"undefined\"",
+			"object": "Property \"{property}\" must be an object, it is \"{value}\"",
+			"objectValue": "Property \"{property}\" must be an object, with at least one property, it is \"{value}\"",
+			"array": "Property \"{property}\" must be an array, it is \"{value}\"",
+			"arrayValue": "Property \"{property}\" must be an array with at least one item",
+			"arrayOneOf": "Property \"{property}\" must be one of [{options}], it is \"{value}\"",
+			"uint8Array": "Property \"{property}\" must be a Uint8Array, it is \"{value}\"",
+			"function": "Property \"{property}\" must be a function, it is \"{value}\"",
+			"urn": "Property \"{property}\" must be a Urn formatted string, it is \"{value}\"",
+			"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}"
+		},
+		"objectHelper": {
+			"failedBytesToJSON": "Failed converting bytes to JSON",
+			"cannotSetArrayIndex": "Cannot set property \"{property}\" using index \"{index}\" as it is not an array",
+			"cannotSetProperty": "Cannot set property \"{property}\" when the target is not an object"
+		},
+		"common": {
+			"notImplementedMethod": "The method \"{method}\" has not been implemented",
+			"validation": "Validation failed"
+		},
+		"factory": {
+			"noUnregister": "There is no {typeName} registered with the name \"{name}\"",
+			"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"
+		},
+		"base32": {
+			"invalidCharacter": "Data contains a character \"{invalidCharacter}\" which is not in the charset"
+		},
+		"base64": {
+			"length4Multiple": "Invalid length should be a multiple of 4, it is \"{value}\""
+		},
+		"base58": {
+			"invalidCharacter": "Data contains a character \"{invalidCharacter}\" which is not in the charset"
+		},
+		"jsonHelper": {
+			"failedPatch": "Failed to patch the JSON object, patch index \"{index}\" failed"
+		},
+		"fetchHelper": {
+			"decodingJSON": "Decoding JSON failed for route \"{route}\"",
+			"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"
+		},
+		"jwt": {
+			"noKeyOrSigner": "No key or signer was provided for JWT creation",
+			"noKeyOrVerifier": "No key or verifier was provided for JWT creation",
+			"verifyFailed": "Failed to verify JWT",
+			"invalidTokenParts": "The JSON Web Token could not be parsed, it should contain three parts separated by dots",
+			"invalidSigningBytes": "The signing bytes are invalid, it should contain two parts separated by a dot"
+		},
+		"jwk": {
+			"jwkImportFailed": "Failed to import JWK"
+		},
+		"jws": {
+			"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}\""
+		},
+		"secp256k1": {
+			"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}\""
+		},
+		"sha256": {
+			"bitSize": "Only 224 or 256 bits are supported, it is \"{bitSize}\""
+		},
+		"sha3": {
+			"bitSize": "Only 224, 256, 384 or 512 bits are supported, it is \"{bitSize}\""
+		},
+		"hmacSha256": {
+			"bitSize": "Only 224 or 256 bits are supported, it is \"{bitSize}\""
+		},
+		"hmacSha512": {
+			"bitSize": "Only 224, 256, 384 or 512 bits are supported, it is \"{bitSize}\""
+		},
+		"bech32": {
+			"decodeFailed": "The address contains decoding failed for address \"{bech32}\"",
+			"invalidChecksum": "The address contains an invalid checksum in address, \"{bech32}\"",
+			"separatorMisused": "The separator character '1' should only be used between hrp and data, \"{bech32}\"",
+			"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"
+		},
+		"slip0010": {
+			"invalidSeed": "The seed is invalid \"{seed}\""
+		},
+		"commands": {
+			"common": {
+				"missingEnv": "The \"{option}\" option is configured as an environment variable, but there is no environment variable with the name \"{value}\" set.",
+				"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}."
+			},
+			"ts-to-openapi": {
+				"configFailed": "Configuration failed to load.",
+				"missingRestRoutesEntryPoints": "Missing REST routes method \"{method}\" in package \"{package}\".",
+				"missingRestRoutesEntryPoint": "Missing REST routes entryPoint \"{entryPoint}\" in package \"{package}\".",
+				"unsupportedProperties": "Unsupported properties found in the request object \"{keys}\"."
+			}
+		}
+	},
+	"errorNames": {
+		"error": "Error",
+		"generalError": "General",
+		"guardError": "Guard",
+		"conflictError": "Conflict",
+		"notFoundError": "Not Found",
+		"notSupportedError": "Not Supported",
+		"alreadyExistsError": "Already Exists",
+		"notImplementedError": "Not Implemented",
+		"validationError": "Validation",
+		"unprocessableError": "Unprocessable"
+	},
+	"validation": {
+		"defaultFieldName": "The field"
+	},
+	"errorMessages": {
+		"fetch": "Fetch"
+	},
+	"cli": {
+		"progress": {
+			"done": "Done.",
+			"error": "Error",
+			"loadingEnvFiles": "Loading env files",
+			"pleaseWait": "Please wait...",
+			"writingJsonFile": "Writing JSON file",
+			"writingEnvFile": "Writing env file",
+			"readingJsonFile": "Reading JSON file",
+			"readingEnvFile": "Reading env file"
+		},
+		"options": {
+			"lang": {
+				"param": "--lang '<'lang'>'",
+				"description": "The language to display the output in."
+			},
+			"load-env": {
+				"param": "--load-env [env...]",
+				"description": "Load the env files to initialise any environment variables."
+			},
+			"no-console": {
+				"param": "--no-console",
+				"description": "Hides the output in the console."
+			},
+			"json": {
+				"param": "--json '<'filename'>'",
+				"description": "Creates a JSON file containing the output."
+			},
+			"env": {
+				"param": "--env '<'filename'>'",
+				"description": "Creates an env file containing the output."
+			},
+			"merge-json": {
+				"param": "--merge-json",
+				"description": "If the JSON file already exists merge the data instead of overwriting."
+			},
+			"merge-env": {
+				"param": "--merge-env",
+				"description": "If the env file already exists merge the data instead of overwriting."
+			}
+		}
+	},
+	"commands": {
+		"ts-to-openapi": {
+			"options": {
+				"config": {
+					"param": "'<'config'>'",
+					"description": "Path to the JSON configuration file."
+				},
+				"output-file": {
+					"param": "'<'output-file'>'",
+					"description": "The JSON file to write the OpenAPI spec."
+				}
+			},
+			"progress": {
+				"loadingConfigJson": "Loading Config JSON",
+				"creatingWorkingDir": "Creating Working Directory",
+				"creatingSecuritySchemas": "Creating Security Schemas",
+				"generatingSchemas": "Generating Schemas",
+				"finalisingSchemas": "Finalising Schemas",
+				"writingOutputFile": "Writing Output File",
+				"models": "Models",
+				"installingNpmPackages": "Installing NPM Packages",
+				"processingPackage": "Processing Package",
+				"importingModule": "Importing Module",
+				"processingRoutes": "Processing Routes"
+			},
+			"labels": {
+				"configJson": "Config JSON",
+				"outputFile": "Output File",
+				"outputWorkingDir": "Output Working Directory",
+				"route": "Route"
+			}
+		}
+	}
+}

package/dist/types/cli.d.ts

@@ -8,9 +8,13 @@ export declare class CLI extends CLIBase {
      * Run the app.
      * @param argv The process arguments.
      * @param localesDirectory The directory for the locales, default to relative to the script.
+     * @param options Additional options.
+     * @param options.overrideOutputWidth Override the output width.
      * @returns The exit code.
      */
-    run(argv: string[], localesDirectory?: string): Promise<number>;
+    run(argv: string[], localesDirectory?: string, options?: {
+        overrideOutputWidth?: number;
+    }): Promise<number>;
     /**
      * Configure any options or actions at the root program level.
      * @param program The root program command.

package/docs/changelog.md

@@ -1,5 +1,41 @@
 # @twin.org/ts-to-openapi - Changelog
 
-## v0.0.4
+## [0.0.1-next.20](https://github.com/twinfoundation/tools/compare/ts-to-openapi-v0.0.1-next.19...ts-to-openapi-v0.0.1-next.20) (2025-03-28)
+
+
+### Miscellaneous Chores
+
+* **ts-to-openapi:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nameof bumped from 0.0.1-next.19 to 0.0.1-next.20
+  * devDependencies
+    * @twin.org/merge-locales bumped from 0.0.1-next.19 to 0.0.1-next.20
+    * @twin.org/nameof-transformer bumped from 0.0.1-next.19 to 0.0.1-next.20
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.1-next.19 to 0.0.1-next.20
+
+## [0.0.1-next.19](https://github.com/twinfoundation/tools/compare/ts-to-openapi-v0.0.1-next.18...ts-to-openapi-v0.0.1-next.19) (2025-03-26)
+
+
+### Miscellaneous Chores
+
+* **ts-to-openapi:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nameof bumped from 0.0.1-next.18 to 0.0.1-next.19
+  * devDependencies
+    * @twin.org/merge-locales bumped from 0.0.1-next.18 to 0.0.1-next.19
+    * @twin.org/nameof-transformer bumped from 0.0.1-next.18 to 0.0.1-next.19
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.1-next.18 to 0.0.1-next.19
+
+## v0.0.1-next.18
 
 - Initial Release

package/docs/reference/classes/CLI.md

@@ -24,20 +24,34 @@ The main entry point for the CLI.
 
 ### run()
 
-> **run**(`argv`, `localesDirectory`?): `Promise`\<`number`\>
+> **run**(`argv`, `localesDirectory`?, `options`?): `Promise`\<`number`\>
 
 Run the app.
 
 #### Parameters
 
-• **argv**: `string`[]
+##### argv
+
+`string`[]
 
 The process arguments.
 
-• **localesDirectory?**: `string`
+##### localesDirectory?
+
+`string`
 
 The directory for the locales, default to relative to the script.
 
+##### options?
+
+Additional options.
+
+###### overrideOutputWidth?
+
+`number`
+
+Override the output width.
+
 #### Returns
 
 `Promise`\<`number`\>
@@ -54,7 +68,9 @@ Configure any options or actions at the root program level.
 
 #### Parameters
 
-• **program**: `Command`
+##### program
+
+`Command`
 
 The root program command.
 

package/docs/reference/functions/actionCommandTsToOpenApi.md

@@ -6,15 +6,21 @@ Action the root command.
 
 ## Parameters
 
-• **configFile**: `string`
+### configFile
+
+`string`
 
 The optional configuration file.
 
-• **outputFile**: `string`
+### outputFile
+
+`string`
 
 The output file for the generation OpenApi spec.
 
-• **opts**: `unknown`
+### opts
+
+`unknown`
 
 The options for the command.
 

package/docs/reference/functions/buildCommandTsToOpenApi.md

@@ -6,7 +6,9 @@ Build the root command to be consumed by the CLI.
 
 ## Parameters
 
-• **program**: `Command`
+### program
+
+`Command`
 
 The command to build on.
 

package/docs/reference/functions/tsToOpenApi.md

@@ -6,15 +6,21 @@ Convert the TypeScript definitions to OpenAPI spec.
 
 ## Parameters
 
-• **config**: [`ITsToOpenApiConfig`](../interfaces/ITsToOpenApiConfig.md)
+### config
+
+[`ITsToOpenApiConfig`](../interfaces/ITsToOpenApiConfig.md)
 
 The configuration for the app.
 
-• **outputFile**: `string`
+### outputFile
+
+`string`
 
 The location of the file to output the OpenAPI spec.
 
-• **workingDirectory**: `string`
+### workingDirectory
+
+`string`
 
 The folder the app was run from.
 

package/docs/reference/interfaces/ITsToOpenApiConfig.md

@@ -66,6 +66,30 @@ The authentication methods.
 
 The packages containing routes.
 
+#### package?
+
+> `optional` **package**: `string`
+
+The package containing the routes.
+
+#### version?
+
+> `optional` **version**: `string`
+
+The version of the package to use, defaults to latest.
+
+#### packageRoot?
+
+> `optional` **packageRoot**: `string`
+
+To point to a local instance of a package use this property instead of package/version.
+
+#### entryPoints?
+
+> `optional` **entryPoints**: [`ITsToOpenApiConfigEntryPoint`](ITsToOpenApiConfigEntryPoint.md)[]
+
+The rest entry points to include, defaults to all exported entry points.
+
 ***
 
 ### externalReferences?
@@ -76,4 +100,4 @@ External type references
 
 #### Index Signature
 
- \[`id`: `string`\]: `string`
+\[`id`: `string`\]: `string`

package/package.json

@@ -1,11 +1,11 @@
 {
 	"name": "@twin.org/ts-to-openapi",
-	"version": "0.0.1-next.2",
+	"version": "0.0.1-next.20",
 	"description": "Tool to convert TypeScript REST route definitions to OpenAPI Specifications",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/twinfoundation/tools.git",
-		"directory": "packages/ts-to-openapi"
+		"directory": "apps/ts-to-openapi"
 	},
 	"author": "martyn.janes@iota.org",
 	"license": "Apache-2.0",
@@ -13,54 +13,25 @@
 	"engines": {
 		"node": ">=20.0.0"
 	},
-	"scripts": {
-		"clean": "rimraf dist coverage",
-		"build": "tspc",
-		"merge-locales": "merge-locales",
-		"test": "vitest --run --config ./vitest.config.ts --no-cache",
-		"coverage": "vitest --run --coverage --config ./vitest.config.ts --no-cache",
-		"bundle:esm": "rollup --config rollup.config.mjs --environment MODULE:esm",
-		"bundle:cjs": "rollup --config rollup.config.mjs --environment MODULE:cjs",
-		"bundle": "npm run bundle:esm && npm run bundle:cjs",
-		"docs:clean": "rimraf docs/reference",
-		"docs:generate": "typedoc",
-		"docs": "npm run docs:clean && npm run docs:generate",
-		"dist": "npm run clean && npm run build && npm run merge-locales && npm run test && npm run bundle && npm run docs"
-	},
 	"dependencies": {
 		"@twin.org/api-models": "next",
 		"@twin.org/cli-core": "next",
 		"@twin.org/core": "next",
-		"@twin.org/nameof": "0.0.1-next.2",
+		"@twin.org/nameof": "0.0.1-next.20",
 		"@twin.org/web": "next",
-		"commander": "12.1.0",
-		"glob": "11.0.0",
-		"jsonschema": "1.4.1",
+		"commander": "13.1.0",
+		"glob": "11.0.1",
+		"jsonschema": "1.5.0",
 		"ts-json-schema-generator": "2.4.0-next.1"
 	},
-	"devDependencies": {
-		"@twin.org/merge-locales": "0.0.1-next.2",
-		"@twin.org/nameof-transformer": "0.0.1-next.2",
-		"@types/node": "22.5.5",
-		"@vitest/coverage-v8": "2.1.1",
-		"copyfiles": "2.4.1",
-		"rimraf": "6.0.1",
-		"rollup": "4.21.3",
-		"rollup-plugin-typescript2": "0.36.0",
-		"ts-patch": "3.2.1",
-		"typedoc": "0.26.7",
-		"typedoc-plugin-markdown": "4.2.7",
-		"typescript": "5.6.2",
-		"vitest": "2.1.1"
-	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
+			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs",
-			"types": "./dist/types/index.d.ts"
+			"import": "./dist/esm/index.mjs"
 		}
 	},
 	"files": [