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

package/docs/reference/classes/CLI.md

@@ -0,0 +1,67 @@
+# Class: CLI
+
+The main entry point for the CLI.
+
+## Extends
+
+- `CLIBase`
+
+## Constructors
+
+### new CLI()
+
+> **new CLI**(): [`CLI`](CLI.md)
+
+#### Returns
+
+[`CLI`](CLI.md)
+
+#### Inherited from
+
+`CLIBase.constructor`
+
+## Methods
+
+### run()
+
+> **run**(`argv`, `localesDirectory`?): `Promise`\<`number`\>
+
+Run the app.
+
+#### Parameters
+
+• **argv**: `string`[]
+
+The process arguments.
+
+• **localesDirectory?**: `string`
+
+The directory for the locales, default to relative to the script.
+
+#### Returns
+
+`Promise`\<`number`\>
+
+The exit code.
+
+***
+
+### configureRoot()
+
+> `protected` **configureRoot**(`program`): `void`
+
+Configure any options or actions at the root program level.
+
+#### Parameters
+
+• **program**: `Command`
+
+The root program command.
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+`CLIBase.configureRoot`

package/docs/reference/functions/actionCommandTsToOpenApi.md

@@ -0,0 +1,23 @@
+# Function: actionCommandTsToOpenApi()
+
+> **actionCommandTsToOpenApi**(`configFile`, `outputFile`, `opts`): `Promise`\<`void`\>
+
+Action the root command.
+
+## Parameters
+
+• **configFile**: `string`
+
+The optional configuration file.
+
+• **outputFile**: `string`
+
+The output file for the generation OpenApi spec.
+
+• **opts**: `unknown`
+
+The options for the command.
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/reference/functions/buildCommandTsToOpenApi.md

@@ -0,0 +1,15 @@
+# Function: buildCommandTsToOpenApi()
+
+> **buildCommandTsToOpenApi**(`program`): `void`
+
+Build the root command to be consumed by the CLI.
+
+## Parameters
+
+• **program**: `Command`
+
+The command to build on.
+
+## Returns
+
+`void`

package/docs/reference/functions/tsToOpenApi.md

@@ -0,0 +1,23 @@
+# Function: tsToOpenApi()
+
+> **tsToOpenApi**(`config`, `outputFile`, `workingDirectory`): `Promise`\<`void`\>
+
+Convert the TypeScript definitions to OpenAPI spec.
+
+## Parameters
+
+• **config**: [`ITsToOpenApiConfig`](../interfaces/ITsToOpenApiConfig.md)
+
+The configuration for the app.
+
+• **outputFile**: `string`
+
+The location of the file to output the OpenAPI spec.
+
+• **workingDirectory**: `string`
+
+The folder the app was run from.
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/reference/index.md

@@ -0,0 +1,16 @@
+# @twin.org/ts-to-openapi
+
+## Classes
+
+- [CLI](classes/CLI.md)
+
+## Interfaces
+
+- [ITsToOpenApiConfig](interfaces/ITsToOpenApiConfig.md)
+- [ITsToOpenApiConfigEntryPoint](interfaces/ITsToOpenApiConfigEntryPoint.md)
+
+## Functions
+
+- [buildCommandTsToOpenApi](functions/buildCommandTsToOpenApi.md)
+- [actionCommandTsToOpenApi](functions/actionCommandTsToOpenApi.md)
+- [tsToOpenApi](functions/tsToOpenApi.md)

package/docs/reference/interfaces/ITsToOpenApiConfig.md

@@ -0,0 +1,79 @@
+# Interface: ITsToOpenApiConfig
+
+Configuration for the API.
+
+## Properties
+
+### title
+
+> **title**: `string`
+
+Title of the API.
+
+***
+
+### version
+
+> **version**: `string`
+
+The version.
+
+***
+
+### description
+
+> **description**: `string`
+
+Description of the API.
+
+***
+
+### licenseName
+
+> **licenseName**: `string`
+
+The license to use.
+
+***
+
+### licenseUrl
+
+> **licenseUrl**: `string`
+
+The license URL.
+
+***
+
+### servers
+
+> **servers**: `string`[]
+
+The servers for the endpoints.
+
+***
+
+### authMethods?
+
+> `optional` **authMethods**: `string`[]
+
+The authentication methods.
+
+***
+
+### restRoutes
+
+> **restRoutes**: `object`[]
+
+The packages containing routes.
+
+***
+
+### externalReferences?
+
+> `optional` **externalReferences**: `object`
+
+External type references
+
+#### Index Signature
+
+ \[`id`: `string`\]: `string`

package/docs/reference/interfaces/ITsToOpenApiConfigEntryPoint.md

@@ -0,0 +1,27 @@
+# Interface: ITsToOpenApiConfigEntryPoint
+
+Configuration for the API.
+
+## Properties
+
+### name
+
+> **name**: `string`
+
+Match the name of the exported entry point.
+
+***
+
+### baseRoutePath?
+
+> `optional` **baseRoutePath**: `string`
+
+The base route path to use, defaults to the one in the entry point.
+
+***
+
+### operationIdDistinguisher?
+
+> `optional` **operationIdDistinguisher**: `string`
+
+If using the same routes on multiple paths use the distinguisher to avoid operationId clashes, will be appended to operationIds.

package/locales/en.json

@@ -0,0 +1,45 @@
+{
+	"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}\"."
+			}
+		}
+	},
+	"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/package.json

@@ -0,0 +1,78 @@
+{
+	"name": "@twin.org/ts-to-openapi",
+	"version": "0.0.1-next.2",
+	"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"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"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/web": "next",
+		"commander": "12.1.0",
+		"glob": "11.0.0",
+		"jsonschema": "1.4.1",
+		"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": {
+		".": {
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs",
+			"types": "./dist/types/index.d.ts"
+		}
+	},
+	"files": [
+		"bin",
+		"dist/cjs",
+		"dist/esm",
+		"dist/locales",
+		"dist/types",
+		"locales",
+		"docs"
+	],
+	"bin": {
+		"ts-to-openapi": "bin/index.js"
+	}
+}