@twin.org/merge-locales 0.0.1-next.1 → 0.0.1-next.2

package/dist/cjs/index.cjs

@@ -0,0 +1,183 @@
+'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 _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 buildCommandMergeLocales(program) {
+    program
+        .option(core.I18n.formatMessage("commands.merge-locales.options.config.param"), core.I18n.formatMessage("commands.merge-locales.options.config.description"))
+        .action(async (opts) => {
+        await actionCommandMergeLocales(opts);
+    });
+}
+/**
+ * Action the root command.
+ * @param opts The options for the command.
+ * @param opts.config The optional configuration file.
+ */
+async function actionCommandMergeLocales(opts) {
+    let config;
+    if (core.Is.stringValue(opts.config)) {
+        try {
+            const configJson = path.resolve(opts.config);
+            cliCore.CLIDisplay.value(core.I18n.formatMessage("commands.merge-locales.labels.configJson"), configJson);
+            cliCore.CLIDisplay.break();
+            cliCore.CLIDisplay.task(core.I18n.formatMessage("commands.merge-locales.progress.loadingConfigJson"));
+            cliCore.CLIDisplay.break();
+            config = await cliCore.CLIUtils.readJsonFile(configJson);
+            cliCore.CLIDisplay.break();
+        }
+        catch (err) {
+            throw new core.GeneralError("commands", "commands.merge-locales.configFailed", undefined, err);
+        }
+        if (core.Is.empty(config)) {
+            throw new core.GeneralError("commands", "commands.merge-locales.configFailed");
+        }
+    }
+    await mergeLocales(process.cwd(), config ?? {});
+    cliCore.CLIDisplay.done();
+}
+/**
+ * Merge the locales.
+ * @param workingDirectory The folder the app was run from.
+ * @param config The configuration for the app.
+ */
+async function mergeLocales(workingDirectory, config) {
+    cliCore.CLIDisplay.value(core.I18n.formatMessage("commands.merge-locales.labels.workingDirectory"), workingDirectory);
+    const outputDirectory = path.resolve(config.outputDirectory ?? "./dist/locales");
+    const locales = config.locales ?? [];
+    const includePackages = config.includePackages ?? [];
+    const excludePackages = config.excludePackages ?? [];
+    if (locales.length === 0) {
+        locales.push({ label: "English", code: "en" });
+    }
+    cliCore.CLIDisplay.value(core.I18n.formatMessage("commands.merge-locales.labels.outputDirectory"), outputDirectory);
+    const npmRoot = await cliCore.CLIUtils.findNpmRoot(workingDirectory);
+    cliCore.CLIDisplay.value(core.I18n.formatMessage("commands.merge-locales.labels.npmRoot"), npmRoot);
+    cliCore.CLIDisplay.break();
+    cliCore.CLIDisplay.task(core.I18n.formatMessage("commands.merge-locales.progress.creatingOutputDirectory"), outputDirectory);
+    try {
+        await promises.rm(outputDirectory, { recursive: true });
+    }
+    catch { }
+    await promises.mkdir(outputDirectory, { recursive: true });
+    let packageNames = [];
+    const packageJson = await findDependencies(npmRoot, path.join(workingDirectory, "package.json"), packageNames);
+    excludePackages.push("@twin.org/merge-locales");
+    excludePackages.push("@twin.org/nameof");
+    excludePackages.push("@twin.org/nameof-transformer");
+    packageNames = packageNames.filter(pkg => !excludePackages.includes(pkg));
+    packageNames.push(...includePackages);
+    cliCore.CLIDisplay.break();
+    cliCore.CLIDisplay.section(core.I18n.formatMessage("commands.merge-locales.labels.sourcePackages"));
+    for (const packageName of packageNames) {
+        cliCore.CLIDisplay.value("", packageName, 1);
+    }
+    cliCore.CLIDisplay.break();
+    const localeDictionaries = {};
+    if (core.Is.stringValue(packageJson.name)) {
+        await mergePackageLocales(path.join(workingDirectory, "locales"), packageJson.name, locales, localeDictionaries);
+    }
+    for (const packageName of packageNames) {
+        const packageLocalDirectory = path.join(npmRoot, packageName, "locales");
+        await mergePackageLocales(packageLocalDirectory, packageName, locales, localeDictionaries);
+    }
+    cliCore.CLIDisplay.break();
+    cliCore.CLIDisplay.task(core.I18n.formatMessage("commands.merge-locales.progress.writingMergedLocales"));
+    for (const localeDictionary in localeDictionaries) {
+        const localeFile = path.join(outputDirectory, `${localeDictionary}.json`);
+        cliCore.CLIDisplay.value(core.I18n.formatMessage("commands.merge-locales.labels.writingLocale"), localeFile, 1);
+        await promises.writeFile(localeFile, JSON.stringify(localeDictionaries[localeDictionary], null, 2), "utf8");
+    }
+    cliCore.CLIDisplay.break();
+}
+/**
+ * Merge the locales for a package.
+ * @param packageLocalDirectory The root of the NPM packages.
+ * @param packageName The name of the package.
+ * @param locales The locales to merge.
+ * @internal
+ */
+async function mergePackageLocales(packageLocalDirectory, packageName, locales, localeDictionaries) {
+    cliCore.CLIDisplay.task(core.I18n.formatMessage("commands.merge-locales.progress.mergingLocalesForPackage"), packageName);
+    if (await cliCore.CLIUtils.dirExists(packageLocalDirectory)) {
+        for (const locale of locales) {
+            const localeFile = path.join(packageLocalDirectory, `${locale.code}.json`);
+            if (await cliCore.CLIUtils.dirExists(localeFile)) {
+                cliCore.CLIDisplay.value(core.I18n.formatMessage("commands.merge-locales.labels.mergingLocale"), locale.code, 1);
+                const localeDictionary = await cliCore.CLIUtils.readJsonFile(localeFile);
+                if (!localeDictionaries[locale.code]) {
+                    localeDictionaries[locale.code] = {};
+                }
+                localeDictionaries[locale.code] = core.ObjectHelper.merge(localeDictionaries[locale.code], localeDictionary);
+            }
+        }
+    }
+    cliCore.CLIDisplay.break();
+}
+/**
+ * Find dependencies for the package.
+ * @param npmRoot The root of the NPM packages.
+ * @param packageJsonPath The path to the package.json.
+ * @param packageNames The package names to add to.
+ * @returns The package details.
+ * @internal
+ */
+async function findDependencies(npmRoot, packageJsonPath, packageNames) {
+    const packageJson = await cliCore.CLIUtils.readJsonFile(packageJsonPath);
+    if (core.Is.objectValue(packageJson?.dependencies)) {
+        for (const pkg in packageJson.dependencies) {
+            if (pkg.startsWith("@twin.org") && !packageNames.includes(pkg)) {
+                packageNames.push(pkg);
+                const packagePath = path.join(npmRoot, pkg, "package.json");
+                await findDependencies(npmRoot, packagePath, packageNames);
+            }
+        }
+    }
+    return packageJson ?? {};
+}
+
+// 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 Merge Locales",
+            appName: "merge-locales",
+            version: "0.0.1-next.2",
+            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) {
+        buildCommandMergeLocales(program);
+    }
+}
+
+exports.CLI = CLI;
+exports.actionCommandMergeLocales = actionCommandMergeLocales;
+exports.buildCommandMergeLocales = buildCommandMergeLocales;
+exports.mergeLocales = mergeLocales;

package/dist/esm/index.mjs

@@ -160,7 +160,7 @@ class CLI extends CLIBase {
         return this.execute({
             title: "TWIN Merge Locales",
             appName: "merge-locales",
-            version: "0.0.1-next.1",
+            version: "0.0.1-next.2",
             icon: "⚙️ ",
             supportsEnvFiles: false
         }, localesDirectory ?? path.join(path.dirname(fileURLToPath(import.meta.url)), "../locales"), argv);

package/dist/locales/en.json

@@ -1,40 +1,244 @@
 {
-	"error": {
-		"commands": {
-			"merge-locales": {
-				"configFailed": "Configuration failed to load."
-			}
-		}
-	},
-	"commands": {
-		"merge-locales": {
-			"options": {
-				"config": {
-					"param": "--config '<'file'>'",
-					"description": "Path to the JSON configuration file."
-				}
-			},
-			"progress": {
-				"loadingConfigJson": "Loading Config JSON",
-				"creatingOutputDirectory": "Creating Output Directory",
-				"writingMergedLocales": "Writing Merged Locales",
-				"mergingLocalesForPackage": "Merging Locales for Package"
-			},
-			"labels": {
-				"configJson": "Config JSON",
-				"workingDirectory": "Working Directory",
-				"outputDirectory": "Output Directory",
-				"npmRoot": "NPM Root",
-				"sourcePackages": "Source Packages",
-				"writingLocale": "Writing Locale",
-				"mergingLocale": "Merging Locale"
-			}
-		}
-	},
-	"cli": {
-		"progress": {
-			"done": "Done.",
-			"error": "Error"
-		}
-	}
-}
+  "error": {
+    "commands": {
+      "merge-locales": {
+        "configFailed": "Configuration failed to load."
+      },
+      "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": {
+    "merge-locales": {
+      "options": {
+        "config": {
+          "param": "--config '<'file'>'",
+          "description": "Path to the JSON configuration file."
+        }
+      },
+      "progress": {
+        "loadingConfigJson": "Loading Config JSON",
+        "creatingOutputDirectory": "Creating Output Directory",
+        "writingMergedLocales": "Writing Merged Locales",
+        "mergingLocalesForPackage": "Merging Locales for Package"
+      },
+      "labels": {
+        "configJson": "Config JSON",
+        "workingDirectory": "Working Directory",
+        "outputDirectory": "Output Directory",
+        "npmRoot": "NPM Root",
+        "sourcePackages": "Source Packages",
+        "writingLocale": "Writing Locale",
+        "mergingLocale": "Merging Locale"
+      }
+    }
+  },
+  "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-openapi - Changelog
 
-## v0.0.1
+## v0.0.1-next.2
 
 - Initial Release

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/merge-locales",
-	"version": "0.0.1-next.1",
+	"version": "0.0.1-next.2",
 	"description": "Tool to merge locale files from all dependencies",
 	"repository": {
 		"type": "git",
@@ -28,16 +28,14 @@
 		"dist": "npm run clean && npm run build && npm run merge-locales && npm run test && npm run bundle && npm run docs"
 	},
 	"dependencies": {
-		"@gtsc/core": "npm:@twin.org/core@next",
-		"@gtsc/crypto": "npm:@twin.org/crypto@next",
 		"@twin.org/cli-core": "next",
 		"@twin.org/core": "next",
-		"@twin.org/nameof": "0.0.1-next.1",
+		"@twin.org/nameof": "0.0.1-next.2",
 		"commander": "12.1.0",
 		"glob": "11.0.0"
 	},
 	"devDependencies": {
-		"@twin.org/nameof-transformer": "0.0.1-next.1",
+		"@twin.org/nameof-transformer": "0.0.1-next.2",
 		"@types/node": "22.5.5",
 		"@vitest/coverage-v8": "2.1.1",
 		"copyfiles": "2.4.1",