@twin.org/ts-to-schema 0.0.1-next.2 → 0.0.1-next.3

package/dist/cjs/index.cjs

@@ -0,0 +1,253 @@
+'use strict';
+
+var path = require('node:path');
+var node_url = require('node:url');
+var cliCore = require('@twin.org/cli-core');
+var promises = require('node:fs/promises');
+var core = require('@twin.org/core');
+var tsJsonSchemaGenerator = require('ts-json-schema-generator');
+
+var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Build the root command to be consumed by the CLI.
+ * @param program The command to build on.
+ */
+function buildCommandTsToSchema(program) {
+    program
+        .argument(core.I18n.formatMessage("commands.ts-to-schema.options.config.param"), core.I18n.formatMessage("commands.ts-to-schema.options.config.description"))
+        .argument(core.I18n.formatMessage("commands.ts-to-schema.options.output-folder.param"), core.I18n.formatMessage("commands.ts-to-schema.options.output-folder.description"))
+        .action(async (config, outputFolder, opts) => {
+        await actionCommandTsToSchema(config, outputFolder);
+    });
+}
+/**
+ * Action the root command.
+ * @param configFile The optional configuration file.
+ * @param outputFolder The output folder for the schemas.
+ * @param opts The options for the command.
+ */
+async function actionCommandTsToSchema(configFile, outputFolder, opts) {
+    let outputWorkingDir;
+    try {
+        let config;
+        const fullConfigFile = path.resolve(configFile);
+        const fullOutputFolder = path.resolve(outputFolder);
+        outputWorkingDir = path.join(fullOutputFolder, "working");
+        cliCore.CLIDisplay.value(core.I18n.formatMessage("commands.ts-to-schema.labels.configJson"), fullConfigFile);
+        cliCore.CLIDisplay.value(core.I18n.formatMessage("commands.ts-to-schema.labels.outputFolder"), fullOutputFolder);
+        cliCore.CLIDisplay.value(core.I18n.formatMessage("commands.ts-to-schema.labels.outputWorkingDir"), outputWorkingDir);
+        cliCore.CLIDisplay.break();
+        try {
+            cliCore.CLIDisplay.task(core.I18n.formatMessage("commands.ts-to-schema.progress.loadingConfigJson"));
+            cliCore.CLIDisplay.break();
+            config = await cliCore.CLIUtils.readJsonFile(fullConfigFile);
+        }
+        catch (err) {
+            throw new core.GeneralError("commands", "commands.ts-to-schema.configFailed", undefined, err);
+        }
+        if (core.Is.empty(config)) {
+            throw new core.GeneralError("commands", "commands.ts-to-schema.configFailed");
+        }
+        cliCore.CLIDisplay.task(core.I18n.formatMessage("commands.ts-to-schema.progress.creatingWorkingDir"));
+        await promises.mkdir(outputWorkingDir, { recursive: true });
+        cliCore.CLIDisplay.break();
+        await tsToSchema(config ?? {}, fullOutputFolder, outputWorkingDir);
+        cliCore.CLIDisplay.break();
+        cliCore.CLIDisplay.done();
+    }
+    finally {
+        try {
+            if (outputWorkingDir) {
+                await promises.rm(outputWorkingDir, { recursive: true });
+            }
+        }
+        catch { }
+    }
+}
+/**
+ * Convert the TypeScript definitions to JSON Schemas.
+ * @param config The configuration for the app.
+ * @param outputFolder The location of the folder to output the JSON schemas.
+ * @param workingDirectory The folder the app was run from.
+ */
+async function tsToSchema(config, outputFolder, workingDirectory) {
+    await promises.writeFile(path.join(workingDirectory, "tsconfig.json"), JSON.stringify({
+        compilerOptions: {}
+    }, undefined, "\t"));
+    cliCore.CLIDisplay.task(core.I18n.formatMessage("commands.ts-to-schema.progress.generatingSchemas"));
+    const schemas = await generateSchemas(config.sources, config.types, workingDirectory);
+    cliCore.CLIDisplay.break();
+    cliCore.CLIDisplay.task(core.I18n.formatMessage("commands.ts-to-schema.progress.writingSchemas"));
+    for (const type of config.types) {
+        if (core.Is.empty(schemas[type])) {
+            throw new core.GeneralError("commands", "commands.ts-to-schema.schemaNotFound", { type });
+        }
+        let content = JSON.stringify(schemas[type], undefined, "\t");
+        if (core.Is.objectValue(config.externalReferences)) {
+            for (const external in config.externalReferences) {
+                content = content.replace(new RegExp(`#/definitions/${external}`, "g"), config.externalReferences[external]);
+            }
+        }
+        content = content.replace(/#\/definitions\/I?/g, config.baseUrl);
+        const filename = path.join(outputFolder, `${core.StringHelper.stripPrefix(type)}.json`);
+        cliCore.CLIDisplay.value(core.I18n.formatMessage("commands.ts-to-schema.progress.writingSchema"), filename, 1);
+        await promises.writeFile(filename, content);
+    }
+}
+/**
+ * Generate schemas for the models.
+ * @param modelDirWildcards The filenames for all the models.
+ * @param types The types of the schema objects.
+ * @param outputWorkingDir The working directory.
+ * @returns Nothing.
+ * @internal
+ */
+async function generateSchemas(modelDirWildcards, types, outputWorkingDir) {
+    const allSchemas = {};
+    const arraySingularTypes = [];
+    for (const type of types) {
+        if (type.endsWith("[]")) {
+            const singularType = type.slice(0, -2);
+            arraySingularTypes.push(singularType);
+            if (!types.includes(singularType)) {
+                types.push(singularType);
+            }
+        }
+    }
+    for (const files of modelDirWildcards) {
+        cliCore.CLIDisplay.value(core.I18n.formatMessage("commands.ts-to-schema.progress.models"), files.replace(/\\/g, "/"), 1);
+        const generator = tsJsonSchemaGenerator.createGenerator({
+            path: files.replace(/\\/g, "/"),
+            type: "*",
+            tsconfig: path.join(outputWorkingDir, "tsconfig.json"),
+            skipTypeCheck: true,
+            expose: "all"
+        });
+        const schema = generator.createSchema("*");
+        if (schema.definitions) {
+            for (const def in schema.definitions) {
+                // Remove the partial markers
+                let defSub = def.replace(/^Partial<(.*?)>/g, "$1");
+                // Cleanup the generic markers
+                defSub = defSub.replace(/</g, "%3C").replace(/>/g, "%3E");
+                allSchemas[defSub] = schema.definitions[def];
+            }
+        }
+    }
+    const referencedSchemas = {};
+    extractTypes(allSchemas, types, referencedSchemas);
+    for (const arraySingularType of arraySingularTypes) {
+        referencedSchemas[`${arraySingularType}[]`] = {
+            type: "array",
+            items: {
+                $ref: `#/components/schemas/${arraySingularType}`
+            }
+        };
+    }
+    return referencedSchemas;
+}
+/**
+ * Extract the required types from all the known schemas.
+ * @param allSchemas All the known schemas.
+ * @param requiredTypes The required types.
+ * @param referencedSchemas The references schemas.
+ * @internal
+ */
+function extractTypes(allSchemas, requiredTypes, referencedSchemas) {
+    for (const type of requiredTypes) {
+        if (allSchemas[type] && !referencedSchemas[type]) {
+            referencedSchemas[type] = allSchemas[type];
+            extractTypesFromSchema(allSchemas, allSchemas[type], referencedSchemas);
+        }
+    }
+}
+/**
+ * Extract type from properties definition.
+ * @param allTypes All the known types.
+ * @param schema The schema to extract from.
+ * @param output The output types.
+ * @internal
+ */
+function extractTypesFromSchema(allTypes, schema, output) {
+    const additionalTypes = [];
+    if (core.Is.stringValue(schema.$ref)) {
+        additionalTypes.push(schema.$ref.replace("#/definitions/", "").replace(/^Partial%3C(.*?)%3E/g, "$1"));
+    }
+    else if (core.Is.object(schema.items)) {
+        if (core.Is.arrayValue(schema.items)) {
+            for (const itemSchema of schema.items) {
+                extractTypesFromSchema(allTypes, itemSchema, output);
+            }
+        }
+        else {
+            extractTypesFromSchema(allTypes, schema.items, output);
+        }
+    }
+    else if (core.Is.object(schema.properties) || core.Is.object(schema.additionalProperties)) {
+        if (core.Is.object(schema.properties)) {
+            for (const prop in schema.properties) {
+                const p = schema.properties[prop];
+                if (core.Is.object(p)) {
+                    extractTypesFromSchema(allTypes, p, output);
+                }
+            }
+        }
+        if (core.Is.object(schema.additionalProperties)) {
+            extractTypesFromSchema(allTypes, schema.additionalProperties, output);
+        }
+    }
+    else if (core.Is.arrayValue(schema.anyOf)) {
+        for (const prop of schema.anyOf) {
+            if (core.Is.object(prop)) {
+                extractTypesFromSchema(allTypes, prop, output);
+            }
+        }
+    }
+    else if (core.Is.arrayValue(schema.oneOf)) {
+        for (const prop of schema.oneOf) {
+            if (core.Is.object(prop)) {
+                extractTypesFromSchema(allTypes, prop, output);
+            }
+        }
+    }
+    if (additionalTypes.length > 0) {
+        extractTypes(allTypes, additionalTypes, output);
+    }
+}
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The main entry point for the CLI.
+ */
+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.
+     * @returns The exit code.
+     */
+    async run(argv, localesDirectory) {
+        return this.execute({
+            title: "TWIN TypeScript To Schema",
+            appName: "ts-to-schema",
+            version: "0.0.1-next.3",
+            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);
+    }
+    /**
+     * Configure any options or actions at the root program level.
+     * @param program The root program command.
+     */
+    configureRoot(program) {
+        buildCommandTsToSchema(program);
+    }
+}
+
+exports.CLI = CLI;
+exports.actionCommandTsToSchema = actionCommandTsToSchema;
+exports.buildCommandTsToSchema = buildCommandTsToSchema;
+exports.tsToSchema = tsToSchema;

package/dist/esm/index.mjs

@@ -0,0 +1,247 @@
+import path from 'node:path';
+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 } from '@twin.org/core';
+import { createGenerator } from 'ts-json-schema-generator';
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Build the root command to be consumed by the CLI.
+ * @param program The command to build on.
+ */
+function buildCommandTsToSchema(program) {
+    program
+        .argument(I18n.formatMessage("commands.ts-to-schema.options.config.param"), I18n.formatMessage("commands.ts-to-schema.options.config.description"))
+        .argument(I18n.formatMessage("commands.ts-to-schema.options.output-folder.param"), I18n.formatMessage("commands.ts-to-schema.options.output-folder.description"))
+        .action(async (config, outputFolder, opts) => {
+        await actionCommandTsToSchema(config, outputFolder);
+    });
+}
+/**
+ * Action the root command.
+ * @param configFile The optional configuration file.
+ * @param outputFolder The output folder for the schemas.
+ * @param opts The options for the command.
+ */
+async function actionCommandTsToSchema(configFile, outputFolder, opts) {
+    let outputWorkingDir;
+    try {
+        let config;
+        const fullConfigFile = path.resolve(configFile);
+        const fullOutputFolder = path.resolve(outputFolder);
+        outputWorkingDir = path.join(fullOutputFolder, "working");
+        CLIDisplay.value(I18n.formatMessage("commands.ts-to-schema.labels.configJson"), fullConfigFile);
+        CLIDisplay.value(I18n.formatMessage("commands.ts-to-schema.labels.outputFolder"), fullOutputFolder);
+        CLIDisplay.value(I18n.formatMessage("commands.ts-to-schema.labels.outputWorkingDir"), outputWorkingDir);
+        CLIDisplay.break();
+        try {
+            CLIDisplay.task(I18n.formatMessage("commands.ts-to-schema.progress.loadingConfigJson"));
+            CLIDisplay.break();
+            config = await CLIUtils.readJsonFile(fullConfigFile);
+        }
+        catch (err) {
+            throw new GeneralError("commands", "commands.ts-to-schema.configFailed", undefined, err);
+        }
+        if (Is.empty(config)) {
+            throw new GeneralError("commands", "commands.ts-to-schema.configFailed");
+        }
+        CLIDisplay.task(I18n.formatMessage("commands.ts-to-schema.progress.creatingWorkingDir"));
+        await mkdir(outputWorkingDir, { recursive: true });
+        CLIDisplay.break();
+        await tsToSchema(config ?? {}, fullOutputFolder, outputWorkingDir);
+        CLIDisplay.break();
+        CLIDisplay.done();
+    }
+    finally {
+        try {
+            if (outputWorkingDir) {
+                await rm(outputWorkingDir, { recursive: true });
+            }
+        }
+        catch { }
+    }
+}
+/**
+ * Convert the TypeScript definitions to JSON Schemas.
+ * @param config The configuration for the app.
+ * @param outputFolder The location of the folder to output the JSON schemas.
+ * @param workingDirectory The folder the app was run from.
+ */
+async function tsToSchema(config, outputFolder, workingDirectory) {
+    await writeFile(path.join(workingDirectory, "tsconfig.json"), JSON.stringify({
+        compilerOptions: {}
+    }, undefined, "\t"));
+    CLIDisplay.task(I18n.formatMessage("commands.ts-to-schema.progress.generatingSchemas"));
+    const schemas = await generateSchemas(config.sources, config.types, workingDirectory);
+    CLIDisplay.break();
+    CLIDisplay.task(I18n.formatMessage("commands.ts-to-schema.progress.writingSchemas"));
+    for (const type of config.types) {
+        if (Is.empty(schemas[type])) {
+            throw new GeneralError("commands", "commands.ts-to-schema.schemaNotFound", { type });
+        }
+        let content = JSON.stringify(schemas[type], undefined, "\t");
+        if (Is.objectValue(config.externalReferences)) {
+            for (const external in config.externalReferences) {
+                content = content.replace(new RegExp(`#/definitions/${external}`, "g"), config.externalReferences[external]);
+            }
+        }
+        content = content.replace(/#\/definitions\/I?/g, config.baseUrl);
+        const filename = path.join(outputFolder, `${StringHelper.stripPrefix(type)}.json`);
+        CLIDisplay.value(I18n.formatMessage("commands.ts-to-schema.progress.writingSchema"), filename, 1);
+        await writeFile(filename, content);
+    }
+}
+/**
+ * Generate schemas for the models.
+ * @param modelDirWildcards The filenames for all the models.
+ * @param types The types of the schema objects.
+ * @param outputWorkingDir The working directory.
+ * @returns Nothing.
+ * @internal
+ */
+async function generateSchemas(modelDirWildcards, types, outputWorkingDir) {
+    const allSchemas = {};
+    const arraySingularTypes = [];
+    for (const type of types) {
+        if (type.endsWith("[]")) {
+            const singularType = type.slice(0, -2);
+            arraySingularTypes.push(singularType);
+            if (!types.includes(singularType)) {
+                types.push(singularType);
+            }
+        }
+    }
+    for (const files of modelDirWildcards) {
+        CLIDisplay.value(I18n.formatMessage("commands.ts-to-schema.progress.models"), files.replace(/\\/g, "/"), 1);
+        const generator = createGenerator({
+            path: files.replace(/\\/g, "/"),
+            type: "*",
+            tsconfig: path.join(outputWorkingDir, "tsconfig.json"),
+            skipTypeCheck: true,
+            expose: "all"
+        });
+        const schema = generator.createSchema("*");
+        if (schema.definitions) {
+            for (const def in schema.definitions) {
+                // Remove the partial markers
+                let defSub = def.replace(/^Partial<(.*?)>/g, "$1");
+                // Cleanup the generic markers
+                defSub = defSub.replace(/</g, "%3C").replace(/>/g, "%3E");
+                allSchemas[defSub] = schema.definitions[def];
+            }
+        }
+    }
+    const referencedSchemas = {};
+    extractTypes(allSchemas, types, referencedSchemas);
+    for (const arraySingularType of arraySingularTypes) {
+        referencedSchemas[`${arraySingularType}[]`] = {
+            type: "array",
+            items: {
+                $ref: `#/components/schemas/${arraySingularType}`
+            }
+        };
+    }
+    return referencedSchemas;
+}
+/**
+ * Extract the required types from all the known schemas.
+ * @param allSchemas All the known schemas.
+ * @param requiredTypes The required types.
+ * @param referencedSchemas The references schemas.
+ * @internal
+ */
+function extractTypes(allSchemas, requiredTypes, referencedSchemas) {
+    for (const type of requiredTypes) {
+        if (allSchemas[type] && !referencedSchemas[type]) {
+            referencedSchemas[type] = allSchemas[type];
+            extractTypesFromSchema(allSchemas, allSchemas[type], referencedSchemas);
+        }
+    }
+}
+/**
+ * Extract type from properties definition.
+ * @param allTypes All the known types.
+ * @param schema The schema to extract from.
+ * @param output The output types.
+ * @internal
+ */
+function extractTypesFromSchema(allTypes, schema, output) {
+    const additionalTypes = [];
+    if (Is.stringValue(schema.$ref)) {
+        additionalTypes.push(schema.$ref.replace("#/definitions/", "").replace(/^Partial%3C(.*?)%3E/g, "$1"));
+    }
+    else if (Is.object(schema.items)) {
+        if (Is.arrayValue(schema.items)) {
+            for (const itemSchema of schema.items) {
+                extractTypesFromSchema(allTypes, itemSchema, output);
+            }
+        }
+        else {
+            extractTypesFromSchema(allTypes, schema.items, output);
+        }
+    }
+    else if (Is.object(schema.properties) || Is.object(schema.additionalProperties)) {
+        if (Is.object(schema.properties)) {
+            for (const prop in schema.properties) {
+                const p = schema.properties[prop];
+                if (Is.object(p)) {
+                    extractTypesFromSchema(allTypes, p, output);
+                }
+            }
+        }
+        if (Is.object(schema.additionalProperties)) {
+            extractTypesFromSchema(allTypes, schema.additionalProperties, output);
+        }
+    }
+    else if (Is.arrayValue(schema.anyOf)) {
+        for (const prop of schema.anyOf) {
+            if (Is.object(prop)) {
+                extractTypesFromSchema(allTypes, prop, output);
+            }
+        }
+    }
+    else if (Is.arrayValue(schema.oneOf)) {
+        for (const prop of schema.oneOf) {
+            if (Is.object(prop)) {
+                extractTypesFromSchema(allTypes, prop, output);
+            }
+        }
+    }
+    if (additionalTypes.length > 0) {
+        extractTypes(allTypes, additionalTypes, output);
+    }
+}
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The main entry point for the CLI.
+ */
+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.
+     * @returns The exit code.
+     */
+    async run(argv, localesDirectory) {
+        return this.execute({
+            title: "TWIN TypeScript To Schema",
+            appName: "ts-to-schema",
+            version: "0.0.1-next.3",
+            icon: "⚙️ ",
+            supportsEnvFiles: false
+        }, localesDirectory ?? path.join(path.dirname(fileURLToPath(import.meta.url)), "../locales"), argv);
+    }
+    /**
+     * Configure any options or actions at the root program level.
+     * @param program The root program command.
+     */
+    configureRoot(program) {
+        buildCommandTsToSchema(program);
+    }
+}
+
+export { CLI, actionCommandTsToSchema, buildCommandTsToSchema, tsToSchema };

package/dist/locales/en.json

@@ -0,0 +1,248 @@
+{
+  "error": {
+    "commands": {
+      "ts-to-schema": {
+        "configFailed": "Configuration failed to load.",
+        "schemaNotFound": "Could not find the requested schema in the generated types \"{type}\"."
+      },
+      "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}."
+      }
+    },
+    "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"
+    },
+    "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-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"
+      }
+    }
+  },
+  "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."
+      }
+    }
+  },
+  "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"
+  }
+}

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/ts-to-schema - Changelog
 
-## v0.0.1-next.2
+## v0.0.1-next.3
 
 - Initial Release

package/docs/reference/interfaces/ITsToSchemaConfig.md

@@ -34,6 +34,6 @@ The list of types to generate.
 
 External type references
 
-#### Index signature
+#### Index Signature
 
  \[`id`: `string`\]: `string`

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/ts-to-schema",
-	"version": "0.0.1-next.2",
+	"version": "0.0.1-next.3",
 	"description": "Tool to convert TypeScript definitions to JSON schemas",
 	"repository": {
 		"type": "git",
@@ -30,15 +30,15 @@
 	"dependencies": {
 		"@twin.org/cli-core": "next",
 		"@twin.org/core": "next",
-		"@twin.org/nameof": "0.0.1-next.2",
+		"@twin.org/nameof": "0.0.1-next.3",
 		"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",
+		"@twin.org/merge-locales": "0.0.1-next.3",
+		"@twin.org/nameof-transformer": "0.0.1-next.3",
 		"@types/node": "22.5.5",
 		"@vitest/coverage-v8": "2.1.1",
 		"copyfiles": "2.4.1",