@twin.org/ts-to-schema 0.0.1-next.10

package/docs/reference/classes/CLI.md

@@ -0,0 +1,75 @@
+# 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`?, `options`?): `Promise`\<`number`\>
+
+Run the app.
+
+#### Parameters
+
+• **argv**: `string`[]
+
+The process arguments.
+
+• **localesDirectory?**: `string`
+
+The directory for the locales, default to relative to the script.
+
+• **options?**
+
+Additional options.
+
+• **options.overrideOutputWidth?**: `number`
+
+Override the output width.
+
+#### 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/actionCommandTsToSchema.md

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

package/docs/reference/functions/buildCommandTsToSchema.md

@@ -0,0 +1,15 @@
+# Function: buildCommandTsToSchema()
+
+> **buildCommandTsToSchema**(`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/tsToSchema.md

@@ -0,0 +1,23 @@
+# Function: tsToSchema()
+
+> **tsToSchema**(`config`, `outputFolder`, `workingDirectory`): `Promise`\<`void`\>
+
+Convert the TypeScript definitions to JSON Schemas.
+
+## Parameters
+
+• **config**: [`ITsToSchemaConfig`](../interfaces/ITsToSchemaConfig.md)
+
+The configuration for the app.
+
+• **outputFolder**: `string`
+
+The location of the folder to output the JSON schemas.
+
+• **workingDirectory**: `string`
+
+The folder the app was run from.
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/reference/index.md

@@ -0,0 +1,15 @@
+# @twin.org/ts-to-schema
+
+## Classes
+
+- [CLI](classes/CLI.md)
+
+## Interfaces
+
+- [ITsToSchemaConfig](interfaces/ITsToSchemaConfig.md)
+
+## Functions
+
+- [buildCommandTsToSchema](functions/buildCommandTsToSchema.md)
+- [actionCommandTsToSchema](functions/actionCommandTsToSchema.md)
+- [tsToSchema](functions/tsToSchema.md)

package/docs/reference/interfaces/ITsToSchemaConfig.md

@@ -0,0 +1,39 @@
+# Interface: ITsToSchemaConfig
+
+Configuration for the tool.
+
+## Properties
+
+### baseUrl
+
+> **baseUrl**: `string`
+
+The base url for the type references e.g. https://schema.twindev.org/my-namespace/.
+
+***
+
+### sources
+
+> **sources**: `string`[]
+
+The list of glob sources that can be used to generate the schemas.
+
+***
+
+### types
+
+> **types**: `string`[]
+
+The list of types to generate.
+
+***
+
+### externalReferences?
+
+> `optional` **externalReferences**: `object`
+
+External type references
+
+#### Index Signature
+
+ \[`id`: `string`\]: `string`

package/locales/en.json

@@ -0,0 +1,38 @@
+{
+	"error": {
+		"commands": {
+			"ts-to-schema": {
+				"configFailed": "Configuration failed to load.",
+				"schemaNotFound": "Could not find the requested schema in the generated types \"{type}\"."
+			}
+		}
+	},
+	"commands": {
+		"ts-to-schema": {
+			"options": {
+				"config": {
+					"param": "'<'config'>'",
+					"description": "Path to the JSON configuration file."
+				},
+				"output-folder": {
+					"param": "'<'output-folder'>'",
+					"description": "The folder to write the schema files."
+				}
+			},
+			"progress": {
+				"loadingConfigJson": "Loading Config JSON",
+				"creatingWorkingDir": "Creating Working Directory",
+				"generatingSchemas": "Generating Schemas",
+				"finalisingSchemas": "Finalising Schemas",
+				"writingSchemas": "Writing Schemas",
+				"writingSchema": "Writing Schema",
+				"models": "Models"
+			},
+			"labels": {
+				"configJson": "Config JSON",
+				"outputFolder": "Output Folder",
+				"outputWorkingDir": "Output Working Directory"
+			}
+		}
+	}
+}

package/package.json

@@ -0,0 +1,47 @@
+{
+	"name": "@twin.org/ts-to-schema",
+	"version": "0.0.1-next.10",
+	"description": "Tool to convert TypeScript definitions to JSON schemas",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/tools.git",
+		"directory": "packages/ts-to-schema"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@twin.org/cli-core": "next",
+		"@twin.org/core": "next",
+		"@twin.org/nameof": "0.0.1-next.10",
+		"commander": "12.1.0",
+		"glob": "11.0.0",
+		"jsonschema": "1.4.1",
+		"ts-json-schema-generator": "2.4.0-next.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-schema": "bin/index.js"
+	}
+}