@aidc-toolkit/app-extension 1.0.22-beta → 1.0.24-beta

package/src/descriptor.ts

@@ -1,11 +1,15 @@
-import type { AppExtension } from "./app-extension.js";
-import { LibProxy } from "./lib-proxy.js";
-import type { ErrorExtends, TypedFunction } from "./types.js";
+import type { TypedFunction } from "@aidc-toolkit/core";
+import type { AppExtension } from "./app-extension";
+import { LibProxy } from "./lib-proxy";
+import type { ErrorExtends } from "./type";
 
 /**
  * Core descriptor.
  */
 interface Descriptor {
+    /**
+     * Name.
+     */
     readonly name: string;
 }
 
@@ -167,12 +171,12 @@ type ProxyClassType<ThrowError extends boolean, TError extends ErrorExtends<Thro
 let pendingParameterDescriptors: ParameterDescriptor[] = [];
 
 /**
- * Class method descriptors, keyed on declaration class name and method name.
+ * Class method descriptors map, keyed on declaration class name and method name.
  */
 const classMethodsDescriptorsMap = new Map<string, MethodDescriptor[]>();
 
 /**
- * Class descriptors, keyed on declaration class name.
+ * Class descriptors map, keyed on declaration class name.
  */
 const classDescriptorsMap = new Map<string, ClassDescriptor>();
 
@@ -309,11 +313,11 @@ export function ProxyClass<ThrowError extends boolean, TError extends ErrorExten
 }
 
 /**
- * Get class descriptors.
+ * Get class descriptors map.
  *
  * @returns
- * Class descriptors.
+ * Class descriptors map.
  */
-export function getClassDescriptors(): ReadonlyMap<string, ClassDescriptor> {
+export function getClassDescriptorsMap(): ReadonlyMap<string, ClassDescriptor> {
     return classDescriptorsMap;
 }

package/src/generator/descriptor.ts

@@ -1,4 +1,4 @@
-import type { BaseParameterDescriptor, ClassDescriptor, MethodDescriptor } from "../descriptor.js";
+import type { BaseParameterDescriptor, ClassDescriptor, MethodDescriptor } from "../descriptor";
 
 /**
  * Localization.

package/src/generator/generator.ts

@@ -1,14 +1,14 @@
 import { I18nEnvironments } from "@aidc-toolkit/core";
 import type { ParseKeys } from "i18next";
-import { expandParameterDescriptor, getClassDescriptors } from "../descriptor.js";
-import { appExtensionResources, i18nAppExtensionInit, i18nextAppExtension } from "../locale/i18n.js";
+import { expandParameterDescriptor, getClassDescriptorsMap } from "../descriptor";
+import { appExtensionResources, i18nAppExtensionInit, i18nextAppExtension } from "../locale/i18n";
 import type {
     FunctionLocalization,
     Localization,
     ParameterLocalization,
     ProxyFunctionDescriptor,
     ProxyObjectDescriptor
-} from "./descriptor.js";
+} from "./descriptor";
 
 /**
  * Abstract generator.
@@ -187,7 +187,7 @@ export abstract class Generator {
         this.initialize();
 
         try {
-            for (const classDescriptor of getClassDescriptors().values()) {
+            for (const classDescriptor of getClassDescriptorsMap().values()) {
                 const namespace = classDescriptor.namespace;
                 const namespacePrefix = namespace === undefined ? "" : `${namespace}.`;
                 const className = classDescriptor.name;

package/src/generator/index.ts

@@ -1,2 +1,2 @@
-export type * from "./descriptor.js";
-export * from "./generator.js";
+export type * from "./descriptor";
+export * from "./generator";

package/src/generator/{locale-strings-generator.ts → locale-resources-generator.ts}

@@ -1,10 +1,9 @@
-import type { LocaleStrings } from "@aidc-toolkit/core";
+import { getLogger, type LocaleResources } from "@aidc-toolkit/core";
 import * as fs from "node:fs";
 import * as path from "node:path";
-import { expandParameterDescriptor, type ParameterDescriptor } from "../descriptor.js";
-import type { ProxyFunctionDescriptor } from "./descriptor.js";
-import { Generator } from "./generator.js";
-import { logger } from "./logger.js";
+import { expandParameterDescriptor, type ParameterDescriptor } from "../descriptor";
+import type { ProxyFunctionDescriptor } from "./descriptor";
+import { Generator } from "./generator";
 
 /**
  * Parameters sequencer entry.
@@ -32,45 +31,50 @@ interface ParametersSequencerEntry {
 type ParametersSequencer = Record<string, ParametersSequencerEntry>;
 
 /**
- * Format of locale strings module.
+ * Format of locale resources module.
  */
-interface LocaleStringsModule {
+interface LocaleResourcesModule {
     /**
-     * Locale strings.
+     * Locale resources.
      */
-    localeStrings: LocaleStrings;
+    LocaleResources: LocaleResources;
 }
 
 /**
- * Locale strings generator.
+ * Locale resources generator.
  */
-class LocaleStringsGenerator extends Generator {
+class LocaleResourcesGenerator extends Generator {
     /**
-     * Locale strings import path.
+     * Locale resources import path.
      */
     private static readonly IMPORT_PATH = "../app-extension/src/locale";
 
+    /**
+     * Logger.
+     */
+    private readonly _logger = getLogger();
+
     /**
      * Parameters sequencer.
      */
     private readonly _parametersSequencer: ParametersSequencer = {};
 
     /**
-     * Parameters locale strings.
+     * Parameters locale resources.
      */
-    private readonly _parametersLocaleStrings: LocaleStrings = {};
+    private readonly _parametersLocaleResources: LocaleResources = {};
 
     /**
-     * Functions locale strings.
+     * Functions locale resources.
      */
-    private readonly _functionsLocaleStrings: LocaleStrings = {};
+    private readonly _functionsLocaleResources: LocaleResources = {};
 
     /**
-     * Locale strings.
+     * Locale resources.
      */
-    private readonly _localeStrings: LocaleStrings = {
-        Parameters: this._parametersLocaleStrings,
-        Functions: this._functionsLocaleStrings
+    private readonly _LocaleResources: LocaleResources = {
+        Parameters: this._parametersLocaleResources,
+        Functions: this._functionsLocaleResources
     };
 
     /**
@@ -167,35 +171,35 @@ class LocaleStringsGenerator extends Generator {
             this.saveParameterSequence(parameterDescriptor, true);
         }
 
-        let functionsLocaleStrings = this._functionsLocaleStrings;
+        let functionsLocaleResources = this._functionsLocaleResources;
 
         if (namespace !== undefined) {
-            if (!(namespace in functionsLocaleStrings)) {
-                const namespaceFunctionsLocaleStrings: LocaleStrings = {};
+            if (!(namespace in functionsLocaleResources)) {
+                const namespaceFunctionsLocaleResources: LocaleResources = {};
 
                 // Add namespace and navigate to it.
-                functionsLocaleStrings[namespace] = namespaceFunctionsLocaleStrings;
-                functionsLocaleStrings = namespaceFunctionsLocaleStrings;
+                functionsLocaleResources[namespace] = namespaceFunctionsLocaleResources;
+                functionsLocaleResources = namespaceFunctionsLocaleResources;
             } else {
                 // Navigate to namespace.
                 // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- Entry is never a string.
-                functionsLocaleStrings = functionsLocaleStrings[namespace] as LocaleStrings;
+                functionsLocaleResources = functionsLocaleResources[namespace] as LocaleResources;
             }
         }
 
-        if (functionName in functionsLocaleStrings) {
+        if (functionName in functionsLocaleResources) {
             throw new Error(`Duplicate function "${functionName}"`);
         }
 
         // Add function.
-        functionsLocaleStrings[functionName] = {
+        functionsLocaleResources[functionName] = {
             name: functionName,
             description: "*** LOCALIZATION REQUIRED ***"
         };
     }
 
     /**
-     * Merge source locale strings into existing destination locale strings.
+     * Merge source locale resources into existing destination locale resources.
      *
      * @param logChanges
      * If true, changes are logged. Limits output when processing multiple sources.
@@ -203,67 +207,67 @@ class LocaleStringsGenerator extends Generator {
      * @param parentKey
      * Parent key for logging purposes.
      *
-     * @param sourceLocaleStrings
-     * Source locale strings.
+     * @param sourceLocaleResources
+     * Source locale resources.
      *
-     * @param destinationLocaleStrings
-     * Destination locale strings.
+     * @param destinationLocaleResources
+     * Destination locale resources.
      *
      * @param addMissing
-     * Add missing if true; applies to locale strings that are not regional.
+     * Add missing if true; applies to locale resources that are not regional.
      *
      * @returns
-     * Merged locale strings.
+     * Merged locale resources.
      */
-    private static merge(logChanges: boolean, parentKey: string, sourceLocaleStrings: LocaleStrings, destinationLocaleStrings: LocaleStrings, addMissing: boolean): LocaleStrings {
+    private merge(logChanges: boolean, parentKey: string, sourceLocaleResources: LocaleResources, destinationLocaleResources: LocaleResources, addMissing: boolean): LocaleResources {
         // Some entries at the top are not part of the generator output.
         const deleteMissing = parentKey.length !== 0;
 
-        const newDestinationLocaleStrings: LocaleStrings = {};
+        const newDestinationLocaleResources: LocaleResources = {};
 
         // Copy over or delete any destination keys that are not in source.
-        for (const [key, destinationValue] of Object.entries(destinationLocaleStrings)) {
-            if (!(key in sourceLocaleStrings)) {
+        for (const [key, destinationValue] of Object.entries(destinationLocaleResources)) {
+            if (!(key in sourceLocaleResources)) {
                 if (!deleteMissing) {
-                    newDestinationLocaleStrings[key] = destinationValue;
+                    newDestinationLocaleResources[key] = destinationValue;
                 } else if (logChanges) {
-                    logger.info(`Deleting ${parentKey}${key}...`);
+                    this._logger.info(`Deleting ${parentKey}${key}...`);
                 }
             }
         }
 
-        for (const [key, sourceValue] of Object.entries(sourceLocaleStrings)) {
-            if (!(key in destinationLocaleStrings)) {
+        for (const [key, sourceValue] of Object.entries(sourceLocaleResources)) {
+            if (!(key in destinationLocaleResources)) {
                 if (addMissing) {
                     if (logChanges) {
-                        logger.info(`Adding ${parentKey}${key}...`);
+                        this._logger.info(`Adding ${parentKey}${key}...`);
                     }
 
-                    newDestinationLocaleStrings[key] = sourceValue;
+                    newDestinationLocaleResources[key] = sourceValue;
                 }
             } else {
-                const destinationValue = destinationLocaleStrings[key];
+                const destinationValue = destinationLocaleResources[key];
 
                 if (typeof sourceValue === "object" && typeof destinationValue === "object") {
-                    newDestinationLocaleStrings[key] = LocaleStringsGenerator.merge(logChanges, `${parentKey}${key}.`, sourceValue, destinationValue, addMissing);
+                    newDestinationLocaleResources[key] = this.merge(logChanges, `${parentKey}${key}.`, sourceValue, destinationValue, addMissing);
                 } else if (typeof sourceValue === "string" && typeof destinationValue === "string") {
-                    newDestinationLocaleStrings[key] = destinationValue;
+                    newDestinationLocaleResources[key] = destinationValue;
                 } else {
                     throw new Error(`Mismatched types at ${parentKey}${key}`);
                 }
             }
         }
 
-        return newDestinationLocaleStrings;
+        return newDestinationLocaleResources;
     }
 
     /**
-     * Build parameters locale strings by going through parameters sequencer.
+     * Build parameters locale resources by going through parameters sequencer.
      *
      * @param parametersSequencer
      * Parameters sequencer.
      */
-    private buildParametersLocaleStrings(parametersSequencer: ParametersSequencer): void {
+    private buildParametersLocaleResources(parametersSequencer: ParametersSequencer): void {
         const entries = Object.entries(parametersSequencer);
 
         // Sort the entries as defined by the descriptors.
@@ -295,14 +299,14 @@ class LocaleStringsGenerator extends Generator {
 
         for (const [parameterName, parametersSequencerEntry] of entries) {
             if (parametersSequencerEntry.isUsed) {
-                this._parametersLocaleStrings[parameterName] = {
+                this._parametersLocaleResources[parameterName] = {
                     name: parameterName,
                     description: "*** LOCALIZATION REQUIRED ***"
                 };
             }
 
             if (parametersSequencerEntry.parametersSequencerOrNull !== null) {
-                this.buildParametersLocaleStrings(parametersSequencerEntry.parametersSequencerOrNull);
+                this.buildParametersLocaleResources(parametersSequencerEntry.parametersSequencerOrNull);
             }
         }
     }
@@ -322,10 +326,10 @@ class LocaleStringsGenerator extends Generator {
      * @returns
      * Output string.
      */
-    private static buildOutput(prefix: string, value: LocaleStrings | string, indentLevel: number): string {
+    private static buildOutput(prefix: string, value: LocaleResources | string, indentLevel: number): string {
         return `${"    ".repeat(indentLevel)}${prefix} ${typeof value === "object" ?
             `{\n${
-                Object.entries(value).map(entry => LocaleStringsGenerator.buildOutput(`${entry[0]}:`, entry[1], indentLevel + 1)).join(",\n")
+                Object.entries(value).map(entry => LocaleResourcesGenerator.buildOutput(`${entry[0]}:`, entry[1], indentLevel + 1)).join(",\n")
             }\n${"    ".repeat(indentLevel)}}` :
             // JSON.stringify() will apply quotes as appropriate.
             JSON.stringify(value)
@@ -337,22 +341,22 @@ class LocaleStringsGenerator extends Generator {
      */
     protected async finalize(success: boolean): Promise<void> {
         if (success) {
-            this.buildParametersLocaleStrings(this._parametersSequencer);
+            this.buildParametersLocaleResources(this._parametersSequencer);
 
-            await Promise.all(fs.readdirSync(LocaleStringsGenerator.IMPORT_PATH, {
+            await Promise.all(fs.readdirSync(LocaleResourcesGenerator.IMPORT_PATH, {
                 withFileTypes: true
             }).filter(entry => entry.isDirectory()).map(async (entry) => {
-                const localeStringsSource = path.resolve(LocaleStringsGenerator.IMPORT_PATH, entry.name, "locale-strings.ts");
+                const LocaleResourcesSource = path.resolve(LocaleResourcesGenerator.IMPORT_PATH, entry.name, "locale-resources.ts");
 
-                await import(localeStringsSource).then((module) => {
+                await import(LocaleResourcesSource).then((module) => {
                     // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- Module format is known.
-                    const localeStrings = LocaleStringsGenerator.merge(entry.name === "en", "", this._localeStrings, (module as LocaleStringsModule).localeStrings, !entry.name.includes("-"));
+                    const LocaleResources = this.merge(entry.name === "en", "", this._LocaleResources, (module as LocaleResourcesModule).LocaleResources, !entry.name.includes("-"));
 
-                    fs.writeFileSync(localeStringsSource, `${LocaleStringsGenerator.buildOutput("export const localeStrings =", localeStrings, 0)};\n`);
+                    fs.writeFileSync(LocaleResourcesSource, `${LocaleResourcesGenerator.buildOutput("export default", LocaleResources, 0)};\n`);
                 });
             }));
         }
     }
 }
 
-await new LocaleStringsGenerator().generate();
+await new LocaleResourcesGenerator().generate();

package/src/gs1/character-set-proxy.ts

@@ -1,12 +1,12 @@
 import { AI39_CREATOR, AI82_CREATOR } from "@aidc-toolkit/gs1";
-import type { AppExtension } from "../app-extension.js";
-import { expandParameterDescriptor, ProxyClass } from "../descriptor.js";
-import type { ErrorExtends } from "../types.js";
+import type { AppExtension } from "../app-extension";
+import { expandParameterDescriptor, ProxyClass } from "../descriptor";
+import type { ErrorExtends } from "../type";
 import {
     exclusionAllNumericParameterDescriptor,
     exclusionNoneParameterDescriptor
-} from "../utility/character-set-descriptor.js";
-import { CharacterSetProxy } from "../utility/character-set-proxy.js";
+} from "../utility/character-set-descriptor";
+import { CharacterSetProxy } from "../utility";
 
 @ProxyClass({
     namespace: "GS1",

package/src/gs1/check-proxy.ts

@@ -6,9 +6,9 @@ import {
     isValidPriceOrWeightCheckDigit,
     priceOrWeightCheckDigit
 } from "@aidc-toolkit/gs1";
-import { type ParameterDescriptor, ProxyClass, ProxyMethod, ProxyParameter, Types } from "../descriptor.js";
-import { LibProxy } from "../lib-proxy.js";
-import type { ErrorExtends, Matrix, MatrixResultError, ResultError } from "../types.js";
+import { type ParameterDescriptor, ProxyClass, ProxyMethod, ProxyParameter, Types } from "../descriptor";
+import { LibProxy } from "../lib-proxy";
+import type { ErrorExtends, Matrix, MatrixResultError, ResultError } from "../type";
 
 const checkSParameterDescriptor: ParameterDescriptor = {
     name: "checkS",

package/src/gs1/identifier-proxy.ts

@@ -1,3 +1,4 @@
+import { isNullish, type Nullishable } from "@aidc-toolkit/core";
 import {
     CPID_VALIDATOR,
     GCN_VALIDATOR,
@@ -34,7 +35,7 @@ import {
     SSCC_VALIDATOR
 } from "@aidc-toolkit/gs1";
 import { Sequence } from "@aidc-toolkit/utility";
-import type { AppExtension } from "../app-extension.js";
+import type { AppExtension } from "../app-extension";
 import {
     expandParameterDescriptor,
     type ParameterDescriptor,
@@ -42,17 +43,17 @@ import {
     ProxyMethod,
     ProxyParameter,
     Types
-} from "../descriptor.js";
-import { LibProxy } from "../lib-proxy.js";
-import { i18nextAppExtension } from "../locale/i18n.js";
-import { type ErrorExtends, isNullish, type Matrix, type MatrixResultError, type Nullishable } from "../types.js";
-import { exclusionAllNumericParameterDescriptor } from "../utility/character-set-descriptor.js";
-import { StringProxy } from "../utility/string-proxy.js";
+} from "../descriptor";
+import { LibProxy } from "../lib-proxy";
+import { i18nextAppExtension } from "../locale/i18n";
+import type { ErrorExtends, Matrix, MatrixResultError } from "../type";
+import { exclusionAllNumericParameterDescriptor } from "../utility/character-set-descriptor";
+import { StringProxy } from "../utility/string-proxy";
 import {
     countParameterDescriptor,
     startValueParameterDescriptor,
     valueParameterDescriptor
-} from "../utility/transformer-descriptor.js";
+} from "../utility/transformer-descriptor";
 
 const identifierParameterDescriptor: ParameterDescriptor = {
     name: "identifier",

package/src/gs1/index.ts

@@ -1,3 +1,3 @@
-export * from "./character-set-proxy.js";
-export * from "./check-proxy.js";
-export * from "./identifier-proxy.js";
+export * from "./character-set-proxy";
+export * from "./check-proxy";
+export * from "./identifier-proxy";

package/src/index.ts

@@ -14,12 +14,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export * from "./locale/i18n.js";
-export * from "./types.js";
-export * from "./app-extension.js";
-export * from "./lib-proxy.js";
-export * from "./descriptor.js";
-export * from "./app-utility-proxy.js";
-export * from "./utility/index.js";
-export * as GS1 from "./gs1/index.js";
-export * from "./generator/index.js";
+export * from "./locale/i18n";
+export type * from "./type";
+export * from "./app-extension";
+export * from "./lib-proxy";
+export * from "./descriptor";
+export * from "./app-utility-proxy";
+export * from "./utility/index";
+export * as GS1 from "./gs1/index";
+export * from "./generator/index";

package/src/lib-proxy.ts

@@ -1,7 +1,7 @@
 import { mapIterable } from "@aidc-toolkit/utility";
-import type { AppExtension } from "./app-extension.js";
-import { i18nextAppExtension } from "./locale/i18n.js";
-import type { ErrorExtends, Matrix, MatrixResultError, ResultError } from "./types.js";
+import type { AppExtension } from "./app-extension";
+import { i18nextAppExtension } from "./locale/i18n";
+import type { ErrorExtends, Matrix, MatrixResultError, ResultError } from "./type";
 
 /**
  * Library proxy.

package/src/locale/en/{locale-strings.ts → locale-resources.ts}

@@ -1,4 +1,4 @@
-export const localeStrings = {
+export default {
     AppExtension: {
         sequenceCountMustBeLessThanOrEqualTo: "Sequence count {{sequenceCount, number}} must be less than or equal to {{maximumSequenceCount, number}}"
     },

package/src/locale/fr/{locale-strings.ts → locale-resources.ts}

@@ -1,4 +1,4 @@
-export const localeStrings = {
+export default {
     AppExtension: {
         sequenceCountMustBeLessThanOrEqualTo: "Le nombre de séquences {{sequenceCount, number}} doit être inférieur ou égal à {{maximumSequenceCount, number}}"
     },

package/src/locale/i18n.ts

@@ -1,28 +1,26 @@
-import { i18nAssertValidResources, i18nCoreInit, type I18nEnvironment } from "@aidc-toolkit/core";
+import { i18nCoreInit, type I18nEnvironment } from "@aidc-toolkit/core";
 import { gs1Resources, i18nGS1Init } from "@aidc-toolkit/gs1";
 import { i18nUtilityInit, utilityResources } from "@aidc-toolkit/utility";
 import i18next, { type i18n, type Resource } from "i18next";
-import { localeStrings as enLocaleStrings } from "./en/locale-strings.js";
-import { localeStrings as frLocaleStrings } from "./fr/locale-strings.js";
+import enLocaleResources from "./en/locale-resources";
+import frLocaleResources from "./fr/locale-resources";
 
 export const appExtensionNS = "aidct_app_extension";
 
 /**
- * Locale strings type is extracted from the English locale strings object.
+ * Locale resources type is extracted from the English locale resources object.
  */
-export type AppExtensionLocaleStrings = typeof enLocaleStrings;
-
-i18nAssertValidResources(enLocaleStrings, "fr", frLocaleStrings);
+export type AppExtensionLocaleResources = typeof enLocaleResources;
 
 /**
  * App extension resources.
  */
 export const appExtensionResources: Resource = {
     en: {
-        aidct_app_extension: enLocaleStrings
+        aidct_app_extension: enLocaleResources
     },
     fr: {
-        aidct_app_extension: frLocaleStrings
+        aidct_app_extension: frLocaleResources
     }
 };
 

package/src/locale/i18next.d.ts

@@ -1,6 +1,6 @@
-import type { GS1LocaleStrings } from "@aidc-toolkit/gs1";
-import type { UtilityLocaleStrings } from "@aidc-toolkit/utility";
-import type { AppExtensionLocaleStrings } from "./i18n.js";
+import type { GS1LocaleResources } from "@aidc-toolkit/gs1";
+import type { UtilityLocaleResources } from "@aidc-toolkit/utility";
+import type { AppExtensionLocaleResources } from "./i18n";
 
 /**
  * Internationalization module.
@@ -12,9 +12,9 @@ declare module "i18next" {
     interface CustomTypeOptions {
         defaultNS: "aidct_app_extension";
         resources: {
-            aidct_utility: UtilityLocaleStrings;
-            aidct_gs1: GS1LocaleStrings;
-            aidct_app_extension: AppExtensionLocaleStrings;
+            aidct_utility: UtilityLocaleResources;
+            aidct_gs1: GS1LocaleResources;
+            aidct_app_extension: AppExtensionLocaleResources;
         };
     }
 }