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

package/dist/es/models/IInputPath.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IInputPath.js.map

package/dist/es/models/IInputPath.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IInputPath.js","sourceRoot":"","sources":["../../../src/models/IInputPath.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HttpMethod, HttpStatusCode } from \"@twin.org/web\";\n\n/**\n * The resulting details for a REST path.\n */\nexport interface IInputPath {\n\t/**\n\t * The path.\n\t */\n\tpath: string;\n\n\t/**\n\t * The REST method.\n\t */\n\tmethod: HttpMethod;\n\n\t/**\n\t * The parameters contained in the path.\n\t */\n\tpathParameters: string[];\n\n\t/**\n\t * The id of the operation.\n\t */\n\toperationId: string;\n\n\t/**\n\t * Summary of what task the operation performs.\n\t */\n\tsummary: string;\n\n\t/**\n\t * Tags for the operation.\n\t */\n\ttag: string;\n\n\t/**\n\t * The request type.\n\t */\n\trequestType?: string;\n\n\t/**\n\t * The request mime type.\n\t */\n\trequestMimeType?: string;\n\n\t/**\n\t * Example objects for the request.\n\t */\n\trequestExamples?: {\n\t\tid: string;\n\t\tdescription?: string;\n\t\trequest: unknown;\n\t}[];\n\n\t/**\n\t * The response type.\n\t */\n\tresponseType: {\n\t\tstatusCode: HttpStatusCode;\n\t\ttype: string;\n\t\tmimeType?: string;\n\t\tdescription?: string;\n\t\texamples?: {\n\t\t\tid: string;\n\t\t\tdescription?: string;\n\t\t\tresponse: unknown;\n\t\t}[];\n\t}[];\n\n\t/**\n\t * Response codes.\n\t */\n\tresponseCodes: string[];\n\n\t/**\n\t * Skip authentication for this path.\n\t */\n\tskipAuth: boolean;\n}\n"]}

package/dist/es/models/IInputResult.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IInputResult.js.map

package/dist/es/models/IInputResult.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IInputResult.js","sourceRoot":"","sources":["../../../src/models/IInputResult.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IInputPath } from \"./IInputPath.js\";\n\n/**\n * The set of path results for a package.\n */\nexport interface IInputResult {\n\t/**\n\t * The paths.\n\t */\n\tpaths: IInputPath[];\n\n\t/**\n\t * The tags.\n\t */\n\ttags: {\n\t\t/**\n\t\t * The name of the tag.\n\t\t */\n\t\tname: string;\n\n\t\t/**\n\t\t * Description for the tag.\n\t\t */\n\t\tdescription: string;\n\t}[];\n}\n"]}

package/dist/es/models/IRestRoute.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IRestRoute.js.map

package/dist/es/models/IRestRoute.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IRestRoute.js","sourceRoot":"","sources":["../../../src/models/IRestRoute.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HttpMethod } from \"@twin.org/web\";\n\n/**\n * Interface which defines a REST route.\n */\nexport interface IRestRoute {\n\t/**\n\t * The id of the operation.\n\t */\n\toperationId: string;\n\n\t/**\n\t * The path to use for routing.\n\t */\n\tpath: string;\n\n\t/**\n\t * Skips the authentication for this route.\n\t */\n\tskipAuth?: boolean;\n\n\t/**\n\t * Summary of what task the operation performs.\n\t */\n\tsummary: string;\n\n\t/**\n\t * Tag for the operation.\n\t */\n\ttag: string;\n\n\t/**\n\t * The http method.\n\t */\n\tmethod: HttpMethod;\n\n\t/**\n\t * The type of the request object.\n\t */\n\trequestType?: {\n\t\t/**\n\t\t * The object type for the request.\n\t\t */\n\t\ttype: string;\n\n\t\t/**\n\t\t * The mime type of the request, defaults to \"application/json\" if there is a body.\n\t\t */\n\t\tmimeType?: string;\n\n\t\t/**\n\t\t * Example objects for the request.\n\t\t */\n\t\texamples?: {\n\t\t\t/**\n\t\t\t * Example objects for the request.\n\t\t\t */\n\t\t\tid: string;\n\n\t\t\t/**\n\t\t\t * Description of the example.\n\t\t\t */\n\t\t\tdescription?: string;\n\n\t\t\t/**\n\t\t\t * The example request object.\n\t\t\t */\n\t\t\trequest: unknown;\n\t\t}[];\n\t};\n\n\t/**\n\t * The type of the response object.\n\t */\n\tresponseType?: {\n\t\t/**\n\t\t * The object type of the response.\n\t\t */\n\t\ttype: string;\n\n\t\t/**\n\t\t * The mime type of the response, defaults to \"application/json\" if there is a body.\n\t\t */\n\t\tmimeType?: string;\n\n\t\t/**\n\t\t * Example objects of the response.\n\t\t */\n\t\texamples?: {\n\t\t\t/**\n\t\t\t * Example objects for the request.\n\t\t\t */\n\t\t\tid: string;\n\n\t\t\t/**\n\t\t\t * Description of the example.\n\t\t\t */\n\t\t\tdescription?: string;\n\n\t\t\t/**\n\t\t\t * The example response object.\n\t\t\t */\n\t\t\tresponse: unknown;\n\t\t}[];\n\t}[];\n\n\t/**\n\t * Exclude the route from being included in the spec file.\n\t */\n\texcludeFromSpec?: boolean;\n\n\t/**\n\t * The handler module.\n\t */\n\thandler: () => Promise<unknown>;\n}\n"]}

package/dist/es/models/IRestRouteEntryPoints.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IRestRouteEntryPoints.js.map

package/dist/es/models/IRestRouteEntryPoints.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IRestRouteEntryPoints.js","sourceRoot":"","sources":["../../../src/models/IRestRouteEntryPoints.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IRestRoute } from \"./IRestRoute.js\";\nimport type { ITag } from \"./ITag.js\";\n\n/**\n * Route entry points are used for exposing the routes from a package.\n */\nexport interface IRestRouteEntryPoint {\n\t/**\n\t * The name of the routes.\n\t */\n\tname: string;\n\n\t/**\n\t * The default base route name for the routes.\n\t */\n\tdefaultBaseRoute: string;\n\n\t/**\n\t * The tags for the routes.\n\t */\n\ttags: ITag[];\n\n\t/**\n\t * The method to generate the routes.\n\t */\n\tgenerateRoutes: (baseRouteName: string, componentName: string) => IRestRoute[];\n}\n"]}

package/dist/es/models/ITag.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=ITag.js.map

package/dist/es/models/ITag.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITag.js","sourceRoot":"","sources":["../../../src/models/ITag.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Tag for routes used to generate OpenAPI information.\n */\nexport interface ITag {\n\t/**\n\t * The name of the tag.\n\t */\n\tname: string;\n\n\t/**\n\t * Description for the tag.\n\t */\n\tdescription: string;\n}\n"]}

package/dist/es/models/ITsToOpenApiConfig.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ITsToOpenApiConfig.js.map

package/dist/es/models/ITsToOpenApiConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITsToOpenApiConfig.js","sourceRoot":"","sources":["../../../src/models/ITsToOpenApiConfig.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonSchema } from \"@twin.org/tools-core\";\nimport type { ITsToOpenApiConfigEntryPoint } from \"./ITsToOpenApiConfigEntryPoint.js\";\n\n/**\n * Configuration for the API.\n */\nexport interface ITsToOpenApiConfig {\n\t/**\n\t * Title of the API.\n\t */\n\ttitle: string;\n\n\t/**\n\t * The version.\n\t */\n\tversion: string;\n\n\t/**\n\t * Description of the API.\n\t */\n\tdescription: string;\n\n\t/**\n\t * The license to use.\n\t */\n\tlicenseName: string;\n\n\t/**\n\t * The license URL.\n\t */\n\tlicenseUrl: string;\n\n\t/**\n\t * The servers for the endpoints.\n\t */\n\tservers: string[];\n\n\t/**\n\t * The authentication methods.\n\t */\n\tauthMethods?: (\"basic\" | \"jwtBearer\" | \"jwtCookie\" | string)[];\n\n\t/**\n\t * The packages containing routes.\n\t */\n\trestRoutes: {\n\t\t/**\n\t\t * The package containing the routes.\n\t\t */\n\t\tpackage?: string;\n\n\t\t/**\n\t\t * The version of the package to use, defaults to latest.\n\t\t */\n\t\tversion?: string;\n\n\t\t/**\n\t\t * To point to a local instance of a package use this property instead of package/version.\n\t\t */\n\t\tpackageRoot?: string;\n\n\t\t/**\n\t\t * The rest entry points to include, defaults to all exported entry points.\n\t\t */\n\t\tentryPoints?: ITsToOpenApiConfigEntryPoint[];\n\t}[];\n\n\t/**\n\t * External type references\n\t */\n\texternalReferences?: { [id: string]: string };\n\n\t/**\n\t * Override for specific types, to be used when the type cannot be generated automatically, or is generated incorrectly.\n\t */\n\toverrides?: {\n\t\t[id: string]: IJsonSchema;\n\t};\n\n\t/**\n\t * The types to automatically expand inline in type definitions, reg ex string matches.\n\t */\n\tautoExpandTypes?: string[];\n}\n"]}

package/dist/es/models/ITsToOpenApiConfigEntryPoint.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=ITsToOpenApiConfigEntryPoint.js.map

package/dist/es/models/ITsToOpenApiConfigEntryPoint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITsToOpenApiConfigEntryPoint.js","sourceRoot":"","sources":["../../../src/models/ITsToOpenApiConfigEntryPoint.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Configuration for the API.\n */\nexport interface ITsToOpenApiConfigEntryPoint {\n\t/**\n\t * Match the name of the exported entry point.\n\t */\n\tname: string;\n\n\t/**\n\t * The base route path to use, defaults to the one in the entry point.\n\t */\n\tbaseRoutePath?: string;\n\n\t/**\n\t * If using the same routes on multiple paths use the distinguisher to avoid operationId clashes, will be appended to operationIds.\n\t */\n\toperationIdDistinguisher?: string;\n}\n"]}

package/dist/locales/en.json

@@ -1,9 +1,20 @@
 {
 	"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}\""
+		"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}\"",
+				"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}\"."
+			}
 		},
 		"validation": {
 			"beEmpty": "{fieldName} must be empty",
@@ -44,8 +55,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 +94,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 +110,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 +125,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 +146,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 +154,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,63 +176,13 @@
 			"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}\""
-		},
-		"rsa": {
-			"noPrivateKey": "Private key is required for this operation",
-			"invalidKeySize": "Invalid RSA key size"
-		},
-		"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"
-	},
 	"warn": {
 		"common": {
 			"devOnlyTool": "This tool is intended to be used for development purposes, it is not recommended for use in production scenarios."
@@ -276,6 +230,25 @@
 			}
 		}
 	},
+	"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",
+		"unauthorizedError": "Unauthorized"
+	},
+	"validation": {
+		"defaultFieldName": "The field"
+	},
+	"errorMessages": {
+		"fetch": "Fetch"
+	},
 	"commands": {
 		"ts-to-openapi": {
 			"options": {

package/dist/types/commands/tsToOpenApi.d.ts

@@ -1,5 +1,5 @@
 import type { Command } from "commander";
-import type { ITsToOpenApiConfig } from "../models/ITsToOpenApiConfig";
+import type { ITsToOpenApiConfig } from "../models/ITsToOpenApiConfig.js";
 /**
  * Build the root command to be consumed by the CLI.
  * @param program The command to build on.

package/dist/types/index.d.ts

@@ -1,4 +1,4 @@
-export * from "./cli";
-export * from "./commands/tsToOpenApi";
-export * from "./models/ITsToOpenApiConfig";
-export * from "./models/ITsToOpenApiConfigEntryPoint";
+export * from "./cli.js";
+export * from "./commands/tsToOpenApi.js";
+export * from "./models/ITsToOpenApiConfig.js";
+export * from "./models/ITsToOpenApiConfigEntryPoint.js";

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

@@ -1,5 +1,4 @@
-import type { ITag } from "@twin.org/api-models";
-import type { IInputPath } from "./IInputPath";
+import type { IInputPath } from "./IInputPath.js";
 /**
  * The set of path results for a package.
  */
@@ -11,5 +10,14 @@ export interface IInputResult {
     /**
      * The tags.
      */
-    tags: ITag[];
+    tags: {
+        /**
+         * The name of the tag.
+         */
+        name: string;
+        /**
+         * Description for the tag.
+         */
+        description: string;
+    }[];
 }

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

@@ -0,0 +1,98 @@
+import type { HttpMethod } from "@twin.org/web";
+/**
+ * Interface which defines a REST route.
+ */
+export interface IRestRoute {
+    /**
+     * The id of the operation.
+     */
+    operationId: string;
+    /**
+     * The path to use for routing.
+     */
+    path: string;
+    /**
+     * Skips the authentication for this route.
+     */
+    skipAuth?: boolean;
+    /**
+     * Summary of what task the operation performs.
+     */
+    summary: string;
+    /**
+     * Tag for the operation.
+     */
+    tag: string;
+    /**
+     * The http method.
+     */
+    method: HttpMethod;
+    /**
+     * The type of the request object.
+     */
+    requestType?: {
+        /**
+         * The object type for the request.
+         */
+        type: string;
+        /**
+         * The mime type of the request, defaults to "application/json" if there is a body.
+         */
+        mimeType?: string;
+        /**
+         * Example objects for the request.
+         */
+        examples?: {
+            /**
+             * Example objects for the request.
+             */
+            id: string;
+            /**
+             * Description of the example.
+             */
+            description?: string;
+            /**
+             * The example request object.
+             */
+            request: unknown;
+        }[];
+    };
+    /**
+     * The type of the response object.
+     */
+    responseType?: {
+        /**
+         * The object type of the response.
+         */
+        type: string;
+        /**
+         * The mime type of the response, defaults to "application/json" if there is a body.
+         */
+        mimeType?: string;
+        /**
+         * Example objects of the response.
+         */
+        examples?: {
+            /**
+             * Example objects for the request.
+             */
+            id: string;
+            /**
+             * Description of the example.
+             */
+            description?: string;
+            /**
+             * The example response object.
+             */
+            response: unknown;
+        }[];
+    }[];
+    /**
+     * Exclude the route from being included in the spec file.
+     */
+    excludeFromSpec?: boolean;
+    /**
+     * The handler module.
+     */
+    handler: () => Promise<unknown>;
+}

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

@@ -0,0 +1,23 @@
+import type { IRestRoute } from "./IRestRoute.js";
+import type { ITag } from "./ITag.js";
+/**
+ * Route entry points are used for exposing the routes from a package.
+ */
+export interface IRestRouteEntryPoint {
+    /**
+     * The name of the routes.
+     */
+    name: string;
+    /**
+     * The default base route name for the routes.
+     */
+    defaultBaseRoute: string;
+    /**
+     * The tags for the routes.
+     */
+    tags: ITag[];
+    /**
+     * The method to generate the routes.
+     */
+    generateRoutes: (baseRouteName: string, componentName: string) => IRestRoute[];
+}

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

@@ -0,0 +1,13 @@
+/**
+ * Tag for routes used to generate OpenAPI information.
+ */
+export interface ITag {
+    /**
+     * The name of the tag.
+     */
+    name: string;
+    /**
+     * Description for the tag.
+     */
+    description: string;
+}

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

@@ -1,5 +1,5 @@
 import type { IJsonSchema } from "@twin.org/tools-core";
-import type { ITsToOpenApiConfigEntryPoint } from "./ITsToOpenApiConfigEntryPoint";
+import type { ITsToOpenApiConfigEntryPoint } from "./ITsToOpenApiConfigEntryPoint.js";
 /**
  * Configuration for the API.
  */

package/docs/changelog.md

@@ -1,5 +1,69 @@
 # @twin.org/ts-to-openapi - Changelog
 
+## [0.0.3-next.1](https://github.com/twinfoundation/tools/compare/ts-to-openapi-v0.0.3-next.0...ts-to-openapi-v0.0.3-next.1) (2025-11-10)
+
+
+### Features
+
+* add context id features ([#54](https://github.com/twinfoundation/tools/issues/54)) ([41ad65d](https://github.com/twinfoundation/tools/commit/41ad65d5ae33d0533d32a2864cd94e5c35e56c76))
+* add latest json schema features ([494293f](https://github.com/twinfoundation/tools/commit/494293f4252b9c7d4a20790ec157fc9d8c96c3d2))
+* add support for authentication property ([ba002c2](https://github.com/twinfoundation/tools/commit/ba002c2c641618ffe7664269179bca6e9fbc9655))
+* 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))
+* add validate-locales ([97bb11f](https://github.com/twinfoundation/tools/commit/97bb11fd9e6ed400e7fa69671075ba78f36ca6e6))
+* correctly handle auto expand types ([57fce0f](https://github.com/twinfoundation/tools/commit/57fce0f9ec4a0876665d70adc6e885f6feb3caf7))
+* eslint migration to flat config ([25acfcf](https://github.com/twinfoundation/tools/commit/25acfcf4c4e0c496fffeaf67659fe171bc15199a))
+* generate schemas as individual entities ([9f372ab](https://github.com/twinfoundation/tools/commit/9f372abdfc27aba93b303c7b214991919c0c18c3))
+* improve auto expand types ([6181d1d](https://github.com/twinfoundation/tools/commit/6181d1daded1f91323195cf7efbc2f1881f38b41))
+* improve schema type name normalisation ([1a18b26](https://github.com/twinfoundation/tools/commit/1a18b267d87e9179bda01b396b256c450ae2889e))
+* improve type name normalisation ([1fe28e5](https://github.com/twinfoundation/tools/commit/1fe28e567593e46a41a833fbba95fe4cd958f525))
+* move package to framework repo ([4490bda](https://github.com/twinfoundation/tools/commit/4490bda472d4dc8ddfe931e2fce81f3411de9ab3))
+* remove auto expanded types from final output ([18e05dc](https://github.com/twinfoundation/tools/commit/18e05dc88f71a0a27b79d1d076b1261b42d2c4c2))
+* strip Omit types ([3a079f9](https://github.com/twinfoundation/tools/commit/3a079f9abe8127c5b44a2b9382babf2f19629d08))
+* tighten the types included with the regex matching ([e54909b](https://github.com/twinfoundation/tools/commit/e54909bded4a19d00560dd3ec783e9146580bda3))
+* 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.3-next.0 to 0.0.3-next.1
+
+## [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)
 
 

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.8",
+	"version": "0.0.3-next.1",
 	"description": "Tool to convert TypeScript REST route definitions to OpenAPI Specifications",
 	"repository": {
 		"type": "git",
@@ -14,30 +14,27 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@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.8",
+		"@twin.org/tools-core": "0.0.3-next.1",
 		"@twin.org/web": "next",
-		"commander": "14.0.0",
+		"commander": "14.0.2",
 		"glob": "11.0.3",
 		"ts-json-schema-generator": "2.4.0"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		}
 	},
 	"files": [
 		"bin",
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/locales",
 		"dist/types",
 		"locales",
@@ -45,5 +42,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"
 }