@aidc-toolkit/core 0.9.4 → 0.9.6-beta

package/dist/index.cjs

@@ -0,0 +1,128 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  I18NEnvironment: () => I18NEnvironment,
+  i18nAddResourceBundle: () => i18nAddResourceBundle,
+  i18nAssertValidResources: () => i18nAssertValidResources,
+  i18nInit: () => i18nInit,
+  i18next: () => i18n_default
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/locale/i18n.ts
+var import_i18next = __toESM(require("i18next"), 1);
+var import_i18next_browser_languagedetector = __toESM(require("i18next-browser-languagedetector"), 1);
+var import_i18next_cli_language_detector = __toESM(require("i18next-cli-language-detector"), 1);
+var i18n_default = import_i18next.default;
+var pendingResourceBundles = [];
+var I18NEnvironment = /* @__PURE__ */ ((I18NEnvironment2) => {
+  I18NEnvironment2[I18NEnvironment2["CLI"] = 0] = "CLI";
+  I18NEnvironment2[I18NEnvironment2["Server"] = 1] = "Server";
+  I18NEnvironment2[I18NEnvironment2["Browser"] = 2] = "Browser";
+  return I18NEnvironment2;
+})(I18NEnvironment || {});
+async function i18nInit(environment, debug = false) {
+  let initialized;
+  if (pendingResourceBundles !== void 0) {
+    initialized = true;
+    let module2;
+    switch (environment) {
+      case 0 /* CLI */:
+        module2 = import_i18next_cli_language_detector.default;
+        break;
+      case 2 /* Browser */:
+        module2 = import_i18next_browser_languagedetector.default;
+        break;
+      default:
+        throw new Error("Not supported");
+    }
+    const initResourceBundles = pendingResourceBundles;
+    pendingResourceBundles = void 0;
+    await import_i18next.default.use(module2).init({
+      fallbackLng: "en",
+      debug,
+      resources: {}
+    }).then(() => {
+      import_i18next.default.services.formatter?.add("toLowerCase", (value) => typeof value === "string" ? value.toLowerCase() : String(value));
+      for (const initResourceBundle of initResourceBundles) {
+        i18nAddResourceBundle(initResourceBundle.lng, initResourceBundle.ns, initResourceBundle.resources);
+      }
+    });
+  } else {
+    initialized = false;
+  }
+  return initialized;
+}
+function i18nAddResourceBundle(lng, ns, resources) {
+  if (pendingResourceBundles !== void 0) {
+    pendingResourceBundles.push({
+      lng,
+      ns,
+      resources
+    });
+  } else {
+    import_i18next.default.addResourceBundle(lng, ns, resources);
+  }
+}
+function i18nAssertValidResources(enResources, lng, lngResources, parent) {
+  const enResourcesMap = new Map(Object.entries(enResources));
+  const lngResourcesMap = new Map(Object.entries(lngResources));
+  const isLocale = lng.includes("-");
+  for (const [enKey, enValue] of enResourcesMap) {
+    const lngValue = lngResourcesMap.get(enKey);
+    if (lngValue !== void 0) {
+      const enValueType = typeof enValue;
+      const lngValueType = typeof lngValue;
+      if (lngValueType !== enValueType) {
+        throw new Error(`Invalid value type ${lngValueType} for key ${parent === void 0 ? "" : `${parent}.`}${enKey} in ${lng} resources`);
+      }
+      if (enValueType === "object") {
+        i18nAssertValidResources(enValue, lng, lngValue, `${parent === void 0 ? "" : `${parent}.`}${enKey}`);
+      }
+    } else if (!isLocale) {
+      throw new Error(`Missing key ${parent === void 0 ? "" : `${parent}.`}${enKey} from ${lng} resources`);
+    }
+  }
+  for (const [lngKey] of lngResourcesMap) {
+    if (!enResourcesMap.has(lngKey)) {
+      throw new Error(`Extraneous key ${parent === void 0 ? "" : `${parent}.`}${lngKey} in ${lng} resources`);
+    }
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  I18NEnvironment,
+  i18nAddResourceBundle,
+  i18nAssertValidResources,
+  i18nInit,
+  i18next
+});

package/dist/index.d.cts

@@ -0,0 +1,64 @@
+import i18next from 'i18next';
+export { default as i18next } from 'i18next';
+
+/**
+ * Internationalization operating environment.
+ */
+declare enum I18NEnvironment {
+    /**
+     * Command-line interface (e.g., unit tests).
+     */
+    CLI = 0,
+    /**
+     * Web server.
+     */
+    Server = 1,
+    /**
+     * Web browser.
+     */
+    Browser = 2
+}
+/**
+ * Initialize internationalization.
+ *
+ * @param environment
+ * Environment in which the application is running.
+ *
+ * @param debug
+ * Debug setting.
+ *
+ * @returns
+ * True if initialization was completed, false if skipped (already initialized).
+ */
+declare function i18nInit(environment: I18NEnvironment, debug?: boolean): Promise<boolean>;
+/**
+ * Add a resource bundle.
+ *
+ * @param lng
+ * Language.
+ *
+ * @param ns
+ * Namespace.
+ *
+ * @param resources
+ * Resources.
+ */
+declare function i18nAddResourceBundle(lng: string, ns: string, resources: object): void;
+/**
+ * Assert that language resources are a type match for English (default) resources.
+ *
+ * @param enResources
+ * English resources.
+ *
+ * @param lng
+ * Language.
+ *
+ * @param lngResources
+ * Language resources.
+ *
+ * @param parent
+ * Parent key name (set recursively).
+ */
+declare function i18nAssertValidResources(enResources: object, lng: string, lngResources: object, parent?: string): void;
+
+export { I18NEnvironment, i18nAddResourceBundle, i18nAssertValidResources, i18nInit };

package/dist/index.d.ts

@@ -0,0 +1,64 @@
+import i18next from 'i18next';
+export { default as i18next } from 'i18next';
+
+/**
+ * Internationalization operating environment.
+ */
+declare enum I18NEnvironment {
+    /**
+     * Command-line interface (e.g., unit tests).
+     */
+    CLI = 0,
+    /**
+     * Web server.
+     */
+    Server = 1,
+    /**
+     * Web browser.
+     */
+    Browser = 2
+}
+/**
+ * Initialize internationalization.
+ *
+ * @param environment
+ * Environment in which the application is running.
+ *
+ * @param debug
+ * Debug setting.
+ *
+ * @returns
+ * True if initialization was completed, false if skipped (already initialized).
+ */
+declare function i18nInit(environment: I18NEnvironment, debug?: boolean): Promise<boolean>;
+/**
+ * Add a resource bundle.
+ *
+ * @param lng
+ * Language.
+ *
+ * @param ns
+ * Namespace.
+ *
+ * @param resources
+ * Resources.
+ */
+declare function i18nAddResourceBundle(lng: string, ns: string, resources: object): void;
+/**
+ * Assert that language resources are a type match for English (default) resources.
+ *
+ * @param enResources
+ * English resources.
+ *
+ * @param lng
+ * Language.
+ *
+ * @param lngResources
+ * Language resources.
+ *
+ * @param parent
+ * Parent key name (set recursively).
+ */
+declare function i18nAssertValidResources(enResources: object, lng: string, lngResources: object, parent?: string): void;
+
+export { I18NEnvironment, i18nAddResourceBundle, i18nAssertValidResources, i18nInit };

package/dist/index.js

@@ -0,0 +1,87 @@
+// src/locale/i18n.ts
+import i18next from "i18next";
+import I18nextBrowserLanguageDetector from "i18next-browser-languagedetector";
+import I18nextCLILanguageDetector from "i18next-cli-language-detector";
+var i18n_default = i18next;
+var pendingResourceBundles = [];
+var I18NEnvironment = /* @__PURE__ */ ((I18NEnvironment2) => {
+  I18NEnvironment2[I18NEnvironment2["CLI"] = 0] = "CLI";
+  I18NEnvironment2[I18NEnvironment2["Server"] = 1] = "Server";
+  I18NEnvironment2[I18NEnvironment2["Browser"] = 2] = "Browser";
+  return I18NEnvironment2;
+})(I18NEnvironment || {});
+async function i18nInit(environment, debug = false) {
+  let initialized;
+  if (pendingResourceBundles !== void 0) {
+    initialized = true;
+    let module;
+    switch (environment) {
+      case 0 /* CLI */:
+        module = I18nextCLILanguageDetector;
+        break;
+      case 2 /* Browser */:
+        module = I18nextBrowserLanguageDetector;
+        break;
+      default:
+        throw new Error("Not supported");
+    }
+    const initResourceBundles = pendingResourceBundles;
+    pendingResourceBundles = void 0;
+    await i18next.use(module).init({
+      fallbackLng: "en",
+      debug,
+      resources: {}
+    }).then(() => {
+      i18next.services.formatter?.add("toLowerCase", (value) => typeof value === "string" ? value.toLowerCase() : String(value));
+      for (const initResourceBundle of initResourceBundles) {
+        i18nAddResourceBundle(initResourceBundle.lng, initResourceBundle.ns, initResourceBundle.resources);
+      }
+    });
+  } else {
+    initialized = false;
+  }
+  return initialized;
+}
+function i18nAddResourceBundle(lng, ns, resources) {
+  if (pendingResourceBundles !== void 0) {
+    pendingResourceBundles.push({
+      lng,
+      ns,
+      resources
+    });
+  } else {
+    i18next.addResourceBundle(lng, ns, resources);
+  }
+}
+function i18nAssertValidResources(enResources, lng, lngResources, parent) {
+  const enResourcesMap = new Map(Object.entries(enResources));
+  const lngResourcesMap = new Map(Object.entries(lngResources));
+  const isLocale = lng.includes("-");
+  for (const [enKey, enValue] of enResourcesMap) {
+    const lngValue = lngResourcesMap.get(enKey);
+    if (lngValue !== void 0) {
+      const enValueType = typeof enValue;
+      const lngValueType = typeof lngValue;
+      if (lngValueType !== enValueType) {
+        throw new Error(`Invalid value type ${lngValueType} for key ${parent === void 0 ? "" : `${parent}.`}${enKey} in ${lng} resources`);
+      }
+      if (enValueType === "object") {
+        i18nAssertValidResources(enValue, lng, lngValue, `${parent === void 0 ? "" : `${parent}.`}${enKey}`);
+      }
+    } else if (!isLocale) {
+      throw new Error(`Missing key ${parent === void 0 ? "" : `${parent}.`}${enKey} from ${lng} resources`);
+    }
+  }
+  for (const [lngKey] of lngResourcesMap) {
+    if (!enResourcesMap.has(lngKey)) {
+      throw new Error(`Extraneous key ${parent === void 0 ? "" : `${parent}.`}${lngKey} in ${lng} resources`);
+    }
+  }
+}
+export {
+  I18NEnvironment,
+  i18nAddResourceBundle,
+  i18nAssertValidResources,
+  i18nInit,
+  i18n_default as i18next
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aidc-toolkit/core",
-  "version": "0.9.4",
+  "version": "0.9.6-beta",
   "description": "Core functionality for AIDC Toolkit",
   "type": "module",
   "main": "dist/index.js",
@@ -19,19 +19,20 @@
     "url": "https://www.linkedin.com/in/kdean"
   },
   "scripts": {
-    "eslint": "eslint .",
+    "lint": "eslint .",
     "build": "tsup src/index.ts --clean --format cjs,esm --dts",
     "build-doc": "npm run build && tsc src/index.ts --outDir dist --target esnext --moduleResolution nodenext --module nodenext --emitDeclarationOnly --declaration --declarationMap"
   },
   "devDependencies": {
-    "@aidc-toolkit/dev": "^0.9.4",
-    "eslint": "^9.15.0",
+    "@aidc-toolkit/dev": "^0.9.6-beta",
+    "eslint": "^9.16.0",
     "ts-node": "^10.9.2",
     "tsup": "^8.3.5",
-    "typescript": "^5.6.3"
+    "typescript": "^5.7.2"
   },
   "dependencies": {
-    "i18next": "^23.16.5",
+    "@rollup/rollup-linux-x64-gnu": "^4.28.0",
+    "i18next": "^24.0.5",
     "i18next-browser-languagedetector": "^8.0.0",
     "i18next-cli-language-detector": "^1.1.8"
   }

package/src/locale/i18n.ts

@@ -1,4 +1,4 @@
-import i18next from "i18next";
+import i18next, { type LanguageDetectorModule } from "i18next";
 import I18nextBrowserLanguageDetector from "i18next-browser-languagedetector";
 import I18nextCLILanguageDetector from "i18next-cli-language-detector";
 
@@ -56,12 +56,13 @@ export async function i18nInit(environment: I18NEnvironment, debug = false): Pro
     // Skip if initialization is not pending.
     if (pendingResourceBundles !== undefined) {
         initialized = true;
-
-        let module: object;
+        
+        let module: Parameters<typeof i18next.use>[0];
 
         switch (environment) {
             case I18NEnvironment.CLI:
-                module = I18nextCLILanguageDetector;
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- Pending resolution of https://github.com/neet/i18next-cli-language-detector/issues/281.
+                module = I18nextCLILanguageDetector as unknown as LanguageDetectorModule;
                 break;
 
             case I18NEnvironment.Browser:
@@ -77,13 +78,13 @@ export async function i18nInit(environment: I18NEnvironment, debug = false): Pro
         // No need to manage pending resource bundles past this point.
         pendingResourceBundles = undefined;
 
-        await i18next.use(module as never).init({
+        await i18next.use(module).init({
             fallbackLng: "en",
             debug,
             resources: {}
         }).then(() => {
             // Add toLowerCase function.
-            i18next.services.formatter?.add("toLowerCase", value => (value as string).toLowerCase());
+            i18next.services.formatter?.add("toLowerCase", value => typeof value === "string" ? value.toLowerCase() : String(value));
 
             // Add pending resource bundles.
             for (const initResourceBundle of initResourceBundles) {

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,32 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Platform**
- - OS: [e.g. Windows, iOS]
- - Browser [e.g. chrome, safari]
- - Browser Version [e.g. 22]
-
-**Additional context**
-Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,20 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-
-**Additional context**
-Add any other context or screenshots about the feature request here.

package/.github/workflows/npm-publish.yml

@@ -1,32 +0,0 @@
-# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
-# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
-
-name: Node.js Package
-
-on:
-  release:
-    types: [created]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 22
-      - run: npm ci
-
-  publish-npm:
-    needs: build
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 22
-          registry-url: https://registry.npmjs.org/
-      - run: npm ci
-      - run: npm publish --access public
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/.idea/core.iml

@@ -1,9 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="JAVA_MODULE" version="4">
-  <component name="NewModuleRootManager" inherit-compiler-output="true">
-    <exclude-output />
-    <content url="file://$MODULE_DIR$" />
-    <orderEntry type="inheritedJdk" />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
-</module>

package/.idea/inspectionProfiles/Project_Default.xml

@@ -1,7 +0,0 @@
-<component name="InspectionProjectProfileManager">
-  <profile version="1.0">
-    <option name="myName" value="Project Default" />
-    <inspection_tool class="Eslint" enabled="true" level="WARNING" enabled_by_default="true" />
-    <inspection_tool class="UpdateDependencyToLatestVersion" enabled="true" level="WARNING" enabled_by_default="true" editorAttributes="WARNING_ATTRIBUTES" />
-  </profile>
-</component>

package/.idea/misc.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectRootManager" version="2" languageLevel="JDK_21" default="true" project-jdk-name="openjdk-21" project-jdk-type="JavaSDK">
-    <output url="file://$PROJECT_DIR$/out" />
-  </component>
-</project>

package/.idea/modules.xml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/core.iml" filepath="$PROJECT_DIR$/.idea/core.iml" />
-    </modules>
-  </component>
-</project>

package/.idea/runConfigurations/build.xml

@@ -1,12 +0,0 @@
-<component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="build" type="js.build_tools.npm" nameIsGenerated="true">
-    <package-json value="$PROJECT_DIR$/package.json" />
-    <command value="run" />
-    <scripts>
-      <script value="build" />
-    </scripts>
-    <node-interpreter value="project" />
-    <envs />
-    <method v="2" />
-  </configuration>
-</component>

package/.idea/runConfigurations/build_dev.xml

@@ -1,12 +0,0 @@
-<component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="build-dev" type="js.build_tools.npm" nameIsGenerated="true">
-    <package-json value="$PROJECT_DIR$/package.json" />
-    <command value="run" />
-    <scripts>
-      <script value="build-dev" />
-    </scripts>
-    <node-interpreter value="project" />
-    <envs />
-    <method v="2" />
-  </configuration>
-</component>

package/.idea/runConfigurations/eslint.xml

@@ -1,12 +0,0 @@
-<component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="eslint" type="js.build_tools.npm" nameIsGenerated="true">
-    <package-json value="$PROJECT_DIR$/package.json" />
-    <command value="run" />
-    <scripts>
-      <script value="eslint" />
-    </scripts>
-    <node-interpreter value="project" />
-    <envs />
-    <method v="2" />
-  </configuration>
-</component>

package/.idea/vcs.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="$PROJECT_DIR$" vcs="Git" />
-  </component>
-</project>