@aidc-toolkit/core 1.0.24-beta → 1.0.26-beta

package/dist/index.cjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/index.ts","../src/type-helper.ts","../src/logger.ts","../src/locale/i18n.ts"],"sourcesContent":["/*!\n * Copyright © 2024-2025 Dolphin Data Development Ltd. and AIDC Toolkit\n * contributors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nexport type * from \"./type\";\nexport * from \"./type-helper\";\nexport * from \"./logger\";\nexport * from \"./locale/i18n\";\n","/**\n * Create an object with omitted or picked entries.\n *\n * @param omitting\n * True if omitting.\n *\n * @param o\n * Object.\n *\n * @param keys\n * Keys to omit or pick.\n *\n * @returns\n * Edited object.\n */\nfunction omitOrPick<Omitting extends boolean, T extends object, K extends keyof T>(omitting: Omitting, o: T, ...keys: K[]): Omitting extends true ? Omit<T, K> : Pick<T, K> {\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- Key and value types are known.\n    return Object.fromEntries(Object.entries(o).filter(([key]) => keys.includes(key as K) !== omitting)) as ReturnType<typeof omitOrPick<Omitting, T, K>>;\n}\n\n/**\n * Create an object with omitted entries.\n *\n * @param o\n * Object.\n *\n * @param keys\n * Keys to omit.\n *\n * @returns\n * Edited object.\n */\nexport function omit<T extends object, K extends keyof T>(o: T, ...keys: K[]): Omit<T, K> {\n    return omitOrPick(true, o, ...keys);\n}\n\n/**\n * Create an object with picked entries.\n *\n * @param o\n * Object.\n *\n * @param keys\n * Keys to pick.\n *\n * @returns\n * Edited object.\n */\nexport function pick<T extends object, K extends keyof T>(o: T, ...keys: K[]): Pick<T, K> {\n    return omitOrPick(false, o, ...keys);\n}\n\n/**\n * Cast a property as a more narrow type.\n *\n * @param o\n * Object.\n *\n * @param key\n * Key of property to cast.\n *\n * @returns\n * Single-key object with property cast as desired type.\n */\nexport function propertyAs<TAsType extends T[K], T extends object, K extends keyof T>(o: T, key: K): Readonly<Omit<T, K> extends T ? Partial<Record<K, TAsType>> : Record<K, TAsType>> {\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- Type is determined by condition.\n    return (key in o ?\n        {\n            // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- Force cast.\n            [key]: o[key] as TAsType\n        } :\n        {}\n    ) as ReturnType<typeof propertyAs<TAsType, T, K>>;\n}\n\n/**\n * Determine if argument is nullish. Application extension may pass `null` or `undefined` to missing parameters.\n *\n * @param argument\n * Argument.\n *\n * @returns\n * True if argument is undefined or null.\n */\nexport function isNullish<T>(argument: T | null | undefined): argument is null | undefined {\n    return argument === null || argument === undefined;\n}\n","import { Logger } from \"tslog\";\n\n/**\n * Log levels.\n */\nexport const LogLevels = {\n    Silly: 0,\n    Trace: 1,\n    Debug: 2,\n    Info: 3,\n    Warn: 4,\n    Error: 5,\n    Fatal: 6\n} as const;\n\n/**\n * Log level.\n */\nexport type LogLevel = typeof LogLevels[keyof typeof LogLevels];\n\n/**\n * Get a simple logger with an optional log level.\n *\n * @param logLevel\n * Log level as enumeration value or string if any.\n *\n * @returns\n * Logger.\n */\nexport function getLogger(logLevel?: string | number): Logger<unknown> {\n    let minLevel: number;\n\n    if (typeof logLevel === \"string\") {\n        if (logLevel in LogLevels) {\n            // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- String exists as a key.\n            minLevel = LogLevels[logLevel as keyof typeof LogLevels];\n        } else {\n            throw new Error(`Unknown log level ${logLevel}`);\n        }\n    } else {\n        minLevel = logLevel ?? LogLevels.Info;\n    }\n\n    return new Logger({\n        minLevel\n    });\n}\n","import type { i18n, LanguageDetectorModule, Resource } from \"i18next\";\nimport I18nextBrowserLanguageDetector from \"i18next-browser-languagedetector\";\nimport I18nextCLILanguageDetector from \"i18next-cli-language-detector\";\n\n/**\n * Locale strings type for generic manipulation.\n */\nexport interface LocaleResources {\n    [key: string]: LocaleResources | string;\n}\n\n/**\n * Internationalization operating environments.\n */\nexport const I18nEnvironments = {\n    /**\n     * Command-line interface (e.g., unit tests).\n     */\n    CLI: 0,\n\n    /**\n     * Web server.\n     */\n    Server: 1,\n\n    /**\n     * Web browser.\n     */\n    Browser: 2\n} as const;\n\n/**\n * Internationalization operating environment.\n */\nexport type I18nEnvironment = typeof I18nEnvironments[keyof typeof I18nEnvironments];\n\n/**\n * Convert a string to lower case, skipping words that are all upper case.\n *\n * @param s\n * String.\n *\n * @returns\n * Lower case string.\n */\nfunction toLowerCase(s: string): string {\n    // Words with no lower case letters are preserved as they are likely mnemonics.\n    return s.split(\" \").map(word => /[a-z]/.test(word) ? word.toLowerCase() : word).join(\" \");\n}\n\n/**\n * Initialize internationalization.\n *\n * @param i18next\n * Internationalization object. As multiple objects exists, this parameter represents the one for the module for which\n * internationalization is being initialized.\n *\n * @param environment\n * Environment in which the application is running.\n *\n * @param debug\n * Debug setting.\n *\n * @param defaultNS\n * Default namespace.\n *\n * @param resources\n * Resources.\n *\n * @returns\n * Void promise.\n */\nexport async function i18nCoreInit(i18next: i18n, environment: I18nEnvironment, debug: boolean, defaultNS: string, ...resources: Resource[]): Promise<void> {\n    // Initialization may be called more than once.\n    if (!i18next.isInitialized) {\n        const mergedResource: Resource = {};\n\n        // Merge resources.\n        for (const resource of resources) {\n            // Merge languages.\n            for (const [language, resourceLanguage] of Object.entries(resource)) {\n                if (!(language in mergedResource)) {\n                    mergedResource[language] = {};\n                }\n\n                const mergedResourceLanguage = mergedResource[language];\n\n                // Merge namespaces.\n                for (const [namespace, resourceKey] of Object.entries(resourceLanguage)) {\n                    mergedResourceLanguage[namespace] = resourceKey;\n                }\n            }\n        }\n\n        let module: Parameters<typeof i18next.use>[0];\n\n        switch (environment) {\n            case I18nEnvironments.CLI:\n                // TODO Refactor when https://github.com/neet/i18next-cli-language-detector/issues/281 resolved.\n                // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- Per above.\n                module = I18nextCLILanguageDetector as unknown as LanguageDetectorModule;\n                break;\n\n            case I18nEnvironments.Browser:\n                module = I18nextBrowserLanguageDetector;\n                break;\n\n            default:\n                throw new Error(\"Not supported\");\n        }\n\n        await i18next.use(module).init({\n            debug,\n            resources: mergedResource,\n            fallbackLng: \"en\",\n            defaultNS\n        }).then(() => {\n            // Add toLowerCase function.\n            i18next.services.formatter?.add(\"toLowerCase\", value => typeof value === \"string\" ? toLowerCase(value) : String(value));\n        });\n    }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACeA,SAAS,WAA0E,UAAoB,MAAS,MAA4D;AAExK,SAAO,OAAO,YAAY,OAAO,QAAQ,CAAC,EAAE,OAAO,CAAC,CAAC,GAAG,MAAM,KAAK,SAAS,GAAQ,MAAM,QAAQ,CAAC;AACvG;AAcO,SAAS,KAA0C,MAAS,MAAuB;AACtF,SAAO,WAAW,MAAM,GAAG,GAAG,IAAI;AACtC;AAcO,SAAS,KAA0C,MAAS,MAAuB;AACtF,SAAO,WAAW,OAAO,GAAG,GAAG,IAAI;AACvC;AAcO,SAAS,WAAsE,GAAM,KAA2F;AAEnL,SAAQ,OAAO,IACX;AAAA;AAAA,IAEI,CAAC,GAAG,GAAG,EAAE,GAAG;AAAA,EAChB,IACA,CAAC;AAET;AAWO,SAAS,UAAa,UAA8D;AACvF,SAAO,aAAa,QAAQ,aAAa;AAC7C;;;ACtFA,mBAAuB;AAKhB,IAAM,YAAY;AAAA,EACrB,OAAO;AAAA,EACP,OAAO;AAAA,EACP,OAAO;AAAA,EACP,MAAM;AAAA,EACN,MAAM;AAAA,EACN,OAAO;AAAA,EACP,OAAO;AACX;AAgBO,SAAS,UAAU,UAA6C;AACnE,MAAI;AAEJ,MAAI,OAAO,aAAa,UAAU;AAC9B,QAAI,YAAY,WAAW;AAEvB,iBAAW,UAAU,QAAkC;AAAA,IAC3D,OAAO;AACH,YAAM,IAAI,MAAM,qBAAqB,QAAQ,EAAE;AAAA,IACnD;AAAA,EACJ,OAAO;AACH,eAAW,YAAY,UAAU;AAAA,EACrC;AAEA,SAAO,IAAI,oBAAO;AAAA,IACd;AAAA,EACJ,CAAC;AACL;;;AC7CA,8CAA2C;AAC3C,2CAAuC;AAYhC,IAAM,mBAAmB;AAAA;AAAA;AAAA;AAAA,EAI5B,KAAK;AAAA;AAAA;AAAA;AAAA,EAKL,QAAQ;AAAA;AAAA;AAAA;AAAA,EAKR,SAAS;AACb;AAgBA,SAAS,YAAY,GAAmB;AAEpC,SAAO,EAAE,MAAM,GAAG,EAAE,IAAI,UAAQ,QAAQ,KAAK,IAAI,IAAI,KAAK,YAAY,IAAI,IAAI,EAAE,KAAK,GAAG;AAC5F;AAwBA,eAAsB,aAAa,SAAe,aAA8B,OAAgB,cAAsB,WAAsC;AAExJ,MAAI,CAAC,QAAQ,eAAe;AACxB,UAAM,iBAA2B,CAAC;AAGlC,eAAW,YAAY,WAAW;AAE9B,iBAAW,CAAC,UAAU,gBAAgB,KAAK,OAAO,QAAQ,QAAQ,GAAG;AACjE,YAAI,EAAE,YAAY,iBAAiB;AAC/B,yBAAe,QAAQ,IAAI,CAAC;AAAA,QAChC;AAEA,cAAM,yBAAyB,eAAe,QAAQ;AAGtD,mBAAW,CAAC,WAAW,WAAW,KAAK,OAAO,QAAQ,gBAAgB,GAAG;AACrE,iCAAuB,SAAS,IAAI;AAAA,QACxC;AAAA,MACJ;AAAA,IACJ;AAEA,QAAIA;AAEJ,YAAQ,aAAa;AAAA,MACjB,KAAK,iBAAiB;AAGlB,QAAAA,UAAS,qCAAAC;AACT;AAAA,MAEJ,KAAK,iBAAiB;AAClB,QAAAD,UAAS,wCAAAE;AACT;AAAA,MAEJ;AACI,cAAM,IAAI,MAAM,eAAe;AAAA,IACvC;AAEA,UAAM,QAAQ,IAAIF,OAAM,EAAE,KAAK;AAAA,MAC3B;AAAA,MACA,WAAW;AAAA,MACX,aAAa;AAAA,MACb;AAAA,IACJ,CAAC,EAAE,KAAK,MAAM;AAEV,cAAQ,SAAS,WAAW,IAAI,eAAe,WAAS,OAAO,UAAU,WAAW,YAAY,KAAK,IAAI,OAAO,KAAK,CAAC;AAAA,IAC1H,CAAC;AAAA,EACL;AACJ;","names":["module","I18nextCLILanguageDetector","I18nextBrowserLanguageDetector"]}

package/dist/index.d.cts

@@ -1,170 +0,0 @@
-import { Logger } from 'tslog';
-import { i18n, Resource } from 'i18next';
-
-/**
- * Typed function, applicable to any function, stricter than {@link Function}.
- */
-type TypedFunction<TMethod extends (...args: Parameters<TMethod>) => ReturnType<TMethod>> = (...args: Parameters<TMethod>) => ReturnType<TMethod>;
-/**
- * Typed synchronous function, applicable to any function that doesn't return a Promise.
- */
-type TypedSyncFunction<TMethod extends TypedFunction<TMethod>> = [ReturnType<TMethod>] extends [PromiseLike<unknown>] ? never : TypedFunction<TMethod>;
-/**
- * Determine the fundamental promised type. This is stricter than `Awaited\<Type\>` in that it requires a Promise.
- */
-type PromisedType<T> = [T] extends [PromiseLike<infer TPromised>] ? TPromised : never;
-/**
- * Typed asynchronous function, applicable to any function that returns a Promise.
- */
-type TypedAsyncFunction<TMethod extends (...args: Parameters<TMethod>) => PromiseLike<PromisedType<ReturnType<TMethod>>>> = (...args: Parameters<TMethod>) => Promise<PromisedType<ReturnType<TMethod>>>;
-/**
- * Nullishable type. Extends a type by allowing `null` and `undefined`.
- */
-type Nullishable<T> = T | null | undefined;
-/**
- * Non-nullishable type. If T is an object type, it is spread and attributes within it are made non-nullishable.
- * Equivalent to a deep `Required\<T\>` for an object and `NonNullable\<T\>` for any other type.
- */
-type NonNullishable<T> = T extends object ? {
-    [P in keyof T]-?: NonNullishable<T[P]>;
-} : NonNullable<T>;
-/**
- * Make some keys within a type optional.
- */
-type Optional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
-/**
- * Type to restrict property keys to those that are strings and that support a specified type.
- */
-type PropertyKeys<T, TProperty> = {
-    [K in keyof T]: K extends string ? T[K] extends TProperty ? K : never : never;
-}[keyof T];
-
-/**
- * Create an object with omitted entries.
- *
- * @param o
- * Object.
- *
- * @param keys
- * Keys to omit.
- *
- * @returns
- * Edited object.
- */
-declare function omit<T extends object, K extends keyof T>(o: T, ...keys: K[]): Omit<T, K>;
-/**
- * Create an object with picked entries.
- *
- * @param o
- * Object.
- *
- * @param keys
- * Keys to pick.
- *
- * @returns
- * Edited object.
- */
-declare function pick<T extends object, K extends keyof T>(o: T, ...keys: K[]): Pick<T, K>;
-/**
- * Cast a property as a more narrow type.
- *
- * @param o
- * Object.
- *
- * @param key
- * Key of property to cast.
- *
- * @returns
- * Single-key object with property cast as desired type.
- */
-declare function propertyAs<TAsType extends T[K], T extends object, K extends keyof T>(o: T, key: K): Readonly<Omit<T, K> extends T ? Partial<Record<K, TAsType>> : Record<K, TAsType>>;
-/**
- * Determine if argument is nullish. Application extension may pass `null` or `undefined` to missing parameters.
- *
- * @param argument
- * Argument.
- *
- * @returns
- * True if argument is undefined or null.
- */
-declare function isNullish<T>(argument: T | null | undefined): argument is null | undefined;
-
-/**
- * Log levels.
- */
-declare const LogLevels: {
-    readonly Silly: 0;
-    readonly Trace: 1;
-    readonly Debug: 2;
-    readonly Info: 3;
-    readonly Warn: 4;
-    readonly Error: 5;
-    readonly Fatal: 6;
-};
-/**
- * Log level.
- */
-type LogLevel = typeof LogLevels[keyof typeof LogLevels];
-/**
- * Get a simple logger with an optional log level.
- *
- * @param logLevel
- * Log level as enumeration value or string if any.
- *
- * @returns
- * Logger.
- */
-declare function getLogger(logLevel?: string | number): Logger<unknown>;
-
-/**
- * Locale strings type for generic manipulation.
- */
-interface LocaleResources {
-    [key: string]: LocaleResources | string;
-}
-/**
- * Internationalization operating environments.
- */
-declare const I18nEnvironments: {
-    /**
-     * Command-line interface (e.g., unit tests).
-     */
-    readonly CLI: 0;
-    /**
-     * Web server.
-     */
-    readonly Server: 1;
-    /**
-     * Web browser.
-     */
-    readonly Browser: 2;
-};
-/**
- * Internationalization operating environment.
- */
-type I18nEnvironment = typeof I18nEnvironments[keyof typeof I18nEnvironments];
-/**
- * Initialize internationalization.
- *
- * @param i18next
- * Internationalization object. As multiple objects exists, this parameter represents the one for the module for which
- * internationalization is being initialized.
- *
- * @param environment
- * Environment in which the application is running.
- *
- * @param debug
- * Debug setting.
- *
- * @param defaultNS
- * Default namespace.
- *
- * @param resources
- * Resources.
- *
- * @returns
- * Void promise.
- */
-declare function i18nCoreInit(i18next: i18n, environment: I18nEnvironment, debug: boolean, defaultNS: string, ...resources: Resource[]): Promise<void>;
-
-export { type I18nEnvironment, I18nEnvironments, type LocaleResources, type LogLevel, LogLevels, type NonNullishable, type Nullishable, type Optional, type PropertyKeys, type TypedAsyncFunction, type TypedFunction, type TypedSyncFunction, getLogger, i18nCoreInit, isNullish, omit, pick, propertyAs };