@aidc-toolkit/core 1.0.23-beta → 1.0.25-beta
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +22 -16
- package/dist/index.cjs +173 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +230 -0
- package/dist/index.d.ts +226 -14
- package/dist/index.js +112 -1
- package/dist/index.js.map +1 -1
- package/package.json +8 -11
- package/src/index.ts +4 -1
- package/src/locale/i18n.ts +4 -90
- package/src/logger.ts +52 -0
- package/src/type-helper.ts +117 -0
- package/src/type.ts +75 -0
- package/tsup.config.ts +3 -0
- package/typedoc.json +1 -3
- package/dist/index.d.ts.map +0 -1
- package/dist/locale/i18n.d.ts +0 -68
- package/dist/locale/i18n.d.ts.map +0 -1
- package/dist/locale/i18n.js +0 -174
- package/dist/locale/i18n.js.map +0 -1
package/README.md
CHANGED
|
@@ -16,6 +16,14 @@ Unless required by applicable law or agreed to in writing, software distributed
|
|
|
16
16
|
|
|
17
17
|
The AIDC Toolkit `core` package contains artefacts to support other AIDC Toolkit packages; it does not itself provide any of the functionality of the AIDC Toolkit. It is a required dependency for all AIDC Toolkit packages.
|
|
18
18
|
|
|
19
|
+
## Types
|
|
20
|
+
|
|
21
|
+
Generic types that go beyond TypeScript's utility types are defined here. The types are designed to provide even greater type safety.
|
|
22
|
+
|
|
23
|
+
## Logger
|
|
24
|
+
|
|
25
|
+
This is a simple wrapper around [tslog](https://tslog.js.org) to support command-line applications in the AIDC Toolkit build process.
|
|
26
|
+
|
|
19
27
|
## Internationalization
|
|
20
28
|
|
|
21
29
|
All AIDC Toolkit packages require internationalization. The localization functionality in this package, built on the robust and popular [`i18next`](https://i18next.com) package, simplifies initialization and allows packages to share a common internationalization engine. Each package, up to and including the client application, is responsible for initializing internationalization for each of the AIDC Toolkit packages on which it depends.
|
|
@@ -27,12 +35,12 @@ All AIDC Toolkit packages require internationalization. The localization functio
|
|
|
27
35
|
Packages install their resources as follows in `i18n.ts` or similar:
|
|
28
36
|
|
|
29
37
|
```typescript
|
|
30
|
-
import {
|
|
38
|
+
import { i18nCoreInit, type I18nEnvironment } from "@aidc-toolkit/core";
|
|
31
39
|
import { dependency1Resources, i18nDependency1Init } from "@aidc-toolkit/dependency1";
|
|
32
40
|
import { dependency2Resources, i18nDependency2Init } from "@aidc-toolkit/dependency2";
|
|
33
41
|
import i18next, { type i18n, type Resource } from "i18next";
|
|
34
|
-
import { localeStrings as enLocaleStrings } from "./en/locale-strings
|
|
35
|
-
import { localeStrings as frLocaleStrings } from "./fr/locale-strings
|
|
42
|
+
import { localeStrings as enLocaleStrings } from "./en/locale-strings";
|
|
43
|
+
import { localeStrings as frLocaleStrings } from "./fr/locale-strings";
|
|
36
44
|
|
|
37
45
|
export const packageNS = "aidct_package";
|
|
38
46
|
|
|
@@ -41,8 +49,6 @@ export const packageNS = "aidct_package";
|
|
|
41
49
|
*/
|
|
42
50
|
export type PackageLocaleStrings = typeof enLocaleStrings;
|
|
43
51
|
|
|
44
|
-
i18nAssertValidResources(enLocaleStrings, "fr", frLocaleStrings);
|
|
45
|
-
|
|
46
52
|
/**
|
|
47
53
|
* Package resources.
|
|
48
54
|
*/
|
|
@@ -82,7 +88,7 @@ The resource types are declared in `i18next.d.ts` or similar:
|
|
|
82
88
|
```typescript
|
|
83
89
|
import type { Dependency1LocaleStrings } from "@aidc-toolkit/dependency1";
|
|
84
90
|
import type { Dependency2LocaleStrings } from "@aidc-toolkit/dependency2";
|
|
85
|
-
import type { PackageLocaleStrings } from "./i18n
|
|
91
|
+
import type { PackageLocaleStrings } from "./i18n";
|
|
86
92
|
|
|
87
93
|
/**
|
|
88
94
|
* Internationalization module.
|
|
@@ -104,13 +110,13 @@ declare module "i18next" {
|
|
|
104
110
|
|
|
105
111
|
Support is available for the following environments:
|
|
106
112
|
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
113
|
+
- [Command-line interface](#command-line-interface)
|
|
114
|
+
- Unit tests
|
|
115
|
+
- Batch applications
|
|
116
|
+
- Web server - **NOT YET IMPLEMENTED**
|
|
117
|
+
- [Web browser](#web-browser)
|
|
112
118
|
|
|
113
|
-
### Command-
|
|
119
|
+
### Command-Line Interface
|
|
114
120
|
|
|
115
121
|
Initializing internationalization for a command-line interface application is straightforward:
|
|
116
122
|
|
|
@@ -118,14 +124,14 @@ Initializing internationalization for a command-line interface application is st
|
|
|
118
124
|
await i18nPackageInit(I18nEnvironment.CLI);
|
|
119
125
|
```
|
|
120
126
|
|
|
121
|
-
### Web
|
|
127
|
+
### Web Browser
|
|
122
128
|
|
|
123
129
|
Initializing internationalization for a web browser requires awaiting the fulfillment of the `Promise` returned by the call to the initialization function before rendering any content. For example, in the React framework, this may be accomplished with a component like this:
|
|
124
130
|
|
|
125
131
|
```typescript jsx
|
|
126
132
|
import { I18nEnvironment } from "@aidc-toolkit/core";
|
|
127
133
|
import { type ReactElement, type ReactNode, useEffect, useState } from "react";
|
|
128
|
-
import { i18nPackageInit, i18nextPackage } from "./locale/i18n
|
|
134
|
+
import { i18nPackageInit, i18nextPackage } from "./locale/i18n";
|
|
129
135
|
|
|
130
136
|
/**
|
|
131
137
|
* I18n wrapper properties.
|
|
@@ -169,8 +175,8 @@ The component would then wrap the application as follows:
|
|
|
169
175
|
|
|
170
176
|
```typescript jsx
|
|
171
177
|
import { type ReactElement, StrictMode } from "react";
|
|
172
|
-
import { App } from "./App
|
|
173
|
-
import { I18n } from "./I18n
|
|
178
|
+
import { App } from "./App";
|
|
179
|
+
import { I18n } from "./I18n";
|
|
174
180
|
|
|
175
181
|
/**
|
|
176
182
|
* Index.
|
package/dist/index.cjs
ADDED
|
@@ -0,0 +1,173 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __create = Object.create;
|
|
3
|
+
var __defProp = Object.defineProperty;
|
|
4
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
5
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
6
|
+
var __getProtoOf = Object.getPrototypeOf;
|
|
7
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
8
|
+
var __export = (target, all) => {
|
|
9
|
+
for (var name in all)
|
|
10
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
11
|
+
};
|
|
12
|
+
var __copyProps = (to, from, except, desc) => {
|
|
13
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
14
|
+
for (let key of __getOwnPropNames(from))
|
|
15
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
16
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
17
|
+
}
|
|
18
|
+
return to;
|
|
19
|
+
};
|
|
20
|
+
var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
|
|
21
|
+
// If the importer is in node compatibility mode or this is not an ESM
|
|
22
|
+
// file that has been converted to a CommonJS file using a Babel-
|
|
23
|
+
// compatible transform (i.e. "__esModule" has not been set), then set
|
|
24
|
+
// "default" to the CommonJS "module.exports" for node compatibility.
|
|
25
|
+
isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
|
|
26
|
+
mod
|
|
27
|
+
));
|
|
28
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
29
|
+
|
|
30
|
+
// src/index.ts
|
|
31
|
+
var index_exports = {};
|
|
32
|
+
__export(index_exports, {
|
|
33
|
+
I18nEnvironments: () => I18nEnvironments,
|
|
34
|
+
LogLevels: () => LogLevels,
|
|
35
|
+
getLogger: () => getLogger,
|
|
36
|
+
i18nCoreInit: () => i18nCoreInit,
|
|
37
|
+
isNullish: () => isNullish,
|
|
38
|
+
omit: () => omit,
|
|
39
|
+
pick: () => pick,
|
|
40
|
+
propertyAs: () => propertyAs
|
|
41
|
+
});
|
|
42
|
+
module.exports = __toCommonJS(index_exports);
|
|
43
|
+
|
|
44
|
+
// src/type-helper.ts
|
|
45
|
+
function omitOrPick(omitting, o, ...keys) {
|
|
46
|
+
return Object.fromEntries(Object.entries(o).filter(([key]) => keys.includes(key) !== omitting));
|
|
47
|
+
}
|
|
48
|
+
function omit(o, ...keys) {
|
|
49
|
+
return omitOrPick(true, o, ...keys);
|
|
50
|
+
}
|
|
51
|
+
function pick(o, ...keys) {
|
|
52
|
+
return omitOrPick(false, o, ...keys);
|
|
53
|
+
}
|
|
54
|
+
function propertyAs(o, key) {
|
|
55
|
+
return key in o ? {
|
|
56
|
+
// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- Force cast.
|
|
57
|
+
[key]: o[key]
|
|
58
|
+
} : {};
|
|
59
|
+
}
|
|
60
|
+
function isNullish(argument) {
|
|
61
|
+
return argument === null || argument === void 0;
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
// src/logger.ts
|
|
65
|
+
var import_tslog = require("tslog");
|
|
66
|
+
var LogLevels = {
|
|
67
|
+
Silly: 0,
|
|
68
|
+
Trace: 1,
|
|
69
|
+
Debug: 2,
|
|
70
|
+
Info: 3,
|
|
71
|
+
Warn: 4,
|
|
72
|
+
Error: 5,
|
|
73
|
+
Fatal: 6
|
|
74
|
+
};
|
|
75
|
+
function getLogger(logLevel) {
|
|
76
|
+
let minLevel;
|
|
77
|
+
if (typeof logLevel === "string") {
|
|
78
|
+
if (logLevel in LogLevels) {
|
|
79
|
+
minLevel = LogLevels[logLevel];
|
|
80
|
+
} else {
|
|
81
|
+
throw new Error(`Unknown log level ${logLevel}`);
|
|
82
|
+
}
|
|
83
|
+
} else {
|
|
84
|
+
minLevel = logLevel ?? LogLevels.Info;
|
|
85
|
+
}
|
|
86
|
+
return new import_tslog.Logger({
|
|
87
|
+
minLevel
|
|
88
|
+
});
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
// src/locale/i18n.ts
|
|
92
|
+
var import_i18next_browser_languagedetector = __toESM(require("i18next-browser-languagedetector"), 1);
|
|
93
|
+
var import_i18next_cli_language_detector = __toESM(require("i18next-cli-language-detector"), 1);
|
|
94
|
+
var I18nEnvironments = {
|
|
95
|
+
/**
|
|
96
|
+
* Command-line interface (e.g., unit tests).
|
|
97
|
+
*/
|
|
98
|
+
CLI: 0,
|
|
99
|
+
/**
|
|
100
|
+
* Web server.
|
|
101
|
+
*/
|
|
102
|
+
Server: 1,
|
|
103
|
+
/**
|
|
104
|
+
* Web browser.
|
|
105
|
+
*/
|
|
106
|
+
Browser: 2
|
|
107
|
+
};
|
|
108
|
+
function toLowerCase(s) {
|
|
109
|
+
return s.split(" ").map((word) => /[a-z]/.test(word) ? word.toLowerCase() : word).join(" ");
|
|
110
|
+
}
|
|
111
|
+
async function i18nCoreInit(i18next, environment, debug, defaultNS, ...resources) {
|
|
112
|
+
if (!i18next.isInitialized) {
|
|
113
|
+
const mergedResource = {};
|
|
114
|
+
for (const resource of resources) {
|
|
115
|
+
for (const [language, resourceLanguage] of Object.entries(resource)) {
|
|
116
|
+
if (!(language in mergedResource)) {
|
|
117
|
+
mergedResource[language] = {};
|
|
118
|
+
}
|
|
119
|
+
const mergedResourceLanguage = mergedResource[language];
|
|
120
|
+
for (const [namespace, resourceKey] of Object.entries(resourceLanguage)) {
|
|
121
|
+
mergedResourceLanguage[namespace] = resourceKey;
|
|
122
|
+
}
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
let module2;
|
|
126
|
+
switch (environment) {
|
|
127
|
+
case I18nEnvironments.CLI:
|
|
128
|
+
module2 = import_i18next_cli_language_detector.default;
|
|
129
|
+
break;
|
|
130
|
+
case I18nEnvironments.Browser:
|
|
131
|
+
module2 = import_i18next_browser_languagedetector.default;
|
|
132
|
+
break;
|
|
133
|
+
default:
|
|
134
|
+
throw new Error("Not supported");
|
|
135
|
+
}
|
|
136
|
+
await i18next.use(module2).init({
|
|
137
|
+
debug,
|
|
138
|
+
resources: mergedResource,
|
|
139
|
+
fallbackLng: "en",
|
|
140
|
+
defaultNS
|
|
141
|
+
}).then(() => {
|
|
142
|
+
i18next.services.formatter?.add("toLowerCase", (value) => typeof value === "string" ? toLowerCase(value) : String(value));
|
|
143
|
+
});
|
|
144
|
+
}
|
|
145
|
+
}
|
|
146
|
+
// Annotate the CommonJS export names for ESM import in node:
|
|
147
|
+
0 && (module.exports = {
|
|
148
|
+
I18nEnvironments,
|
|
149
|
+
LogLevels,
|
|
150
|
+
getLogger,
|
|
151
|
+
i18nCoreInit,
|
|
152
|
+
isNullish,
|
|
153
|
+
omit,
|
|
154
|
+
pick,
|
|
155
|
+
propertyAs
|
|
156
|
+
});
|
|
157
|
+
/*!
|
|
158
|
+
* Copyright © 2024-2025 Dolphin Data Development Ltd. and AIDC Toolkit
|
|
159
|
+
* contributors
|
|
160
|
+
*
|
|
161
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
162
|
+
* you may not use this file except in compliance with the License.
|
|
163
|
+
* You may obtain a copy of the License at
|
|
164
|
+
*
|
|
165
|
+
* https://www.apache.org/licenses/LICENSE-2.0
|
|
166
|
+
*
|
|
167
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
168
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
169
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
170
|
+
* See the License for the specific language governing permissions and
|
|
171
|
+
* limitations under the License.
|
|
172
|
+
*/
|
|
173
|
+
//# sourceMappingURL=index.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"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 * @template Omitting\n * Type representation of `omitting` parameter for return type determination.\n *\n * @template T\n * Object type.\n *\n * @template K\n * Object key type.\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 * @template T\n * Object type.\n *\n * @template K\n * Object key type.\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 * @template T\n * Object type.\n *\n * @template K\n * Object key type.\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 * @template T\n * Object type.\n *\n * @template K\n * Object key type.\n *\n * @template TAsType\n * Desired 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<T extends object, K extends keyof T, TAsType extends T[K]>(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<T, K, TAsType>>;\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(argument: unknown): 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 key.\n */\nexport type LogLevelKey = keyof typeof LogLevels;\n\n/**\n * Log level.\n */\nexport type LogLevel = typeof LogLevels[LogLevelKey];\n\n/**\n * Get a simple logger with an optional log level.\n *\n * @param logLevel\n * Log level as enumeration value or string.\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 LogLevelKey];\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 key.\n */\nexport type I18nEnvironmentKey = keyof typeof I18nEnvironments;\n\n/**\n * Internationalization operating environment.\n */\nexport type I18nEnvironment = typeof I18nEnvironments[I18nEnvironmentKey];\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;;;ACwBA,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;AAoBO,SAAS,KAA0C,MAAS,MAAuB;AACtF,SAAO,WAAW,MAAM,GAAG,GAAG,IAAI;AACtC;AAoBO,SAAS,KAA0C,MAAS,MAAuB;AACtF,SAAO,WAAW,OAAO,GAAG,GAAG,IAAI;AACvC;AAuBO,SAAS,WAAsE,GAAM,KAA2F;AAEnL,SAAQ,OAAO,IACX;AAAA;AAAA,IAEI,CAAC,GAAG,GAAG,EAAE,GAAG;AAAA,EAChB,IACA,CAAC;AAET;AAWO,SAAS,UAAU,UAAiD;AACvE,SAAO,aAAa,QAAQ,aAAa;AAC7C;;;ACpHA,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;AAqBO,SAAS,UAAU,UAA6C;AACnE,MAAI;AAEJ,MAAI,OAAO,aAAa,UAAU;AAC9B,QAAI,YAAY,WAAW;AAEvB,iBAAW,UAAU,QAAuB;AAAA,IAChD,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;;;AClDA,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;AAqBA,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
ADDED
|
@@ -0,0 +1,230 @@
|
|
|
1
|
+
import { Logger } from 'tslog';
|
|
2
|
+
import { i18n, Resource } from 'i18next';
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* Typed function, applicable to any function, stricter than {@linkcode Function}.
|
|
6
|
+
*
|
|
7
|
+
* @template TFunction
|
|
8
|
+
* Function type.
|
|
9
|
+
*/
|
|
10
|
+
type TypedFunction<TFunction extends (...args: Parameters<TFunction>) => ReturnType<TFunction>> = (...args: Parameters<TFunction>) => ReturnType<TFunction>;
|
|
11
|
+
/**
|
|
12
|
+
* Typed synchronous function, applicable to any function that doesn't return a {@linkcode Promise}.
|
|
13
|
+
*
|
|
14
|
+
* @template TFunction
|
|
15
|
+
* Function type.
|
|
16
|
+
*/
|
|
17
|
+
type TypedSyncFunction<TFunction extends TypedFunction<TFunction>> = [ReturnType<TFunction>] extends [PromiseLike<unknown>] ? never : TypedFunction<TFunction>;
|
|
18
|
+
/**
|
|
19
|
+
* Determine the fundamental promised type. This is stricter than `Awaited<Type>` in that it requires a {@linkcode
|
|
20
|
+
* Promise}.
|
|
21
|
+
*
|
|
22
|
+
* @template T
|
|
23
|
+
* Promised type.
|
|
24
|
+
*/
|
|
25
|
+
type PromisedType<T> = [T] extends [PromiseLike<infer TPromised>] ? TPromised : never;
|
|
26
|
+
/**
|
|
27
|
+
* Typed asynchronous function, applicable to any function that returns a {@linkcode Promise}.
|
|
28
|
+
*
|
|
29
|
+
* @template TFunction
|
|
30
|
+
* Function type.
|
|
31
|
+
*/
|
|
32
|
+
type TypedAsyncFunction<TMethod extends (...args: Parameters<TMethod>) => PromiseLike<PromisedType<ReturnType<TMethod>>>> = (...args: Parameters<TMethod>) => Promise<PromisedType<ReturnType<TMethod>>>;
|
|
33
|
+
/**
|
|
34
|
+
* Nullishable type. Extends a type by allowing `null` and `undefined`.
|
|
35
|
+
*
|
|
36
|
+
* @template T
|
|
37
|
+
* Type.
|
|
38
|
+
*/
|
|
39
|
+
type Nullishable<T> = T | null | undefined;
|
|
40
|
+
/**
|
|
41
|
+
* Non-nullishable type. If T is an object type, it is spread and attributes within it are made non-nullishable.
|
|
42
|
+
* Equivalent to a deep `Required<T>` for an object and `NonNullable<T>` for any other type.
|
|
43
|
+
*
|
|
44
|
+
* @template T
|
|
45
|
+
* Type.
|
|
46
|
+
*/
|
|
47
|
+
type NonNullishable<T> = T extends object ? {
|
|
48
|
+
[P in keyof T]-?: NonNullishable<T[P]>;
|
|
49
|
+
} : NonNullable<T>;
|
|
50
|
+
/**
|
|
51
|
+
* Make some keys within a type optional.
|
|
52
|
+
*
|
|
53
|
+
* @template T
|
|
54
|
+
* Object type.
|
|
55
|
+
*
|
|
56
|
+
* @template K
|
|
57
|
+
* Object key type.
|
|
58
|
+
*/
|
|
59
|
+
type Optional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
|
|
60
|
+
/**
|
|
61
|
+
* Type to restrict property keys to those that are strings and that support a specified type.
|
|
62
|
+
*
|
|
63
|
+
* @template T
|
|
64
|
+
* Object type.
|
|
65
|
+
*
|
|
66
|
+
* @template P
|
|
67
|
+
* Object property type.
|
|
68
|
+
*/
|
|
69
|
+
type PropertyKeys<T, P> = {
|
|
70
|
+
[K in keyof T]: K extends string ? T[K] extends P ? K : never : never;
|
|
71
|
+
}[keyof T];
|
|
72
|
+
|
|
73
|
+
/**
|
|
74
|
+
* Create an object with omitted entries.
|
|
75
|
+
*
|
|
76
|
+
* @template T
|
|
77
|
+
* Object type.
|
|
78
|
+
*
|
|
79
|
+
* @template K
|
|
80
|
+
* Object key type.
|
|
81
|
+
*
|
|
82
|
+
* @param o
|
|
83
|
+
* Object.
|
|
84
|
+
*
|
|
85
|
+
* @param keys
|
|
86
|
+
* Keys to omit.
|
|
87
|
+
*
|
|
88
|
+
* @returns
|
|
89
|
+
* Edited object.
|
|
90
|
+
*/
|
|
91
|
+
declare function omit<T extends object, K extends keyof T>(o: T, ...keys: K[]): Omit<T, K>;
|
|
92
|
+
/**
|
|
93
|
+
* Create an object with picked entries.
|
|
94
|
+
*
|
|
95
|
+
* @template T
|
|
96
|
+
* Object type.
|
|
97
|
+
*
|
|
98
|
+
* @template K
|
|
99
|
+
* Object key type.
|
|
100
|
+
*
|
|
101
|
+
* @param o
|
|
102
|
+
* Object.
|
|
103
|
+
*
|
|
104
|
+
* @param keys
|
|
105
|
+
* Keys to pick.
|
|
106
|
+
*
|
|
107
|
+
* @returns
|
|
108
|
+
* Edited object.
|
|
109
|
+
*/
|
|
110
|
+
declare function pick<T extends object, K extends keyof T>(o: T, ...keys: K[]): Pick<T, K>;
|
|
111
|
+
/**
|
|
112
|
+
* Cast a property as a more narrow type.
|
|
113
|
+
*
|
|
114
|
+
* @template T
|
|
115
|
+
* Object type.
|
|
116
|
+
*
|
|
117
|
+
* @template K
|
|
118
|
+
* Object key type.
|
|
119
|
+
*
|
|
120
|
+
* @template TAsType
|
|
121
|
+
* Desired type.
|
|
122
|
+
*
|
|
123
|
+
* @param o
|
|
124
|
+
* Object.
|
|
125
|
+
*
|
|
126
|
+
* @param key
|
|
127
|
+
* Key of property to cast.
|
|
128
|
+
*
|
|
129
|
+
* @returns
|
|
130
|
+
* Single-key object with property cast as desired type.
|
|
131
|
+
*/
|
|
132
|
+
declare function propertyAs<T extends object, K extends keyof T, TAsType extends T[K]>(o: T, key: K): Readonly<Omit<T, K> extends T ? Partial<Record<K, TAsType>> : Record<K, TAsType>>;
|
|
133
|
+
/**
|
|
134
|
+
* Determine if argument is nullish. Application extension may pass `null` or `undefined` to missing parameters.
|
|
135
|
+
*
|
|
136
|
+
* @param argument
|
|
137
|
+
* Argument.
|
|
138
|
+
*
|
|
139
|
+
* @returns
|
|
140
|
+
* True if argument is undefined or null.
|
|
141
|
+
*/
|
|
142
|
+
declare function isNullish(argument: unknown): argument is null | undefined;
|
|
143
|
+
|
|
144
|
+
/**
|
|
145
|
+
* Log levels.
|
|
146
|
+
*/
|
|
147
|
+
declare const LogLevels: {
|
|
148
|
+
readonly Silly: 0;
|
|
149
|
+
readonly Trace: 1;
|
|
150
|
+
readonly Debug: 2;
|
|
151
|
+
readonly Info: 3;
|
|
152
|
+
readonly Warn: 4;
|
|
153
|
+
readonly Error: 5;
|
|
154
|
+
readonly Fatal: 6;
|
|
155
|
+
};
|
|
156
|
+
/**
|
|
157
|
+
* Log level key.
|
|
158
|
+
*/
|
|
159
|
+
type LogLevelKey = keyof typeof LogLevels;
|
|
160
|
+
/**
|
|
161
|
+
* Log level.
|
|
162
|
+
*/
|
|
163
|
+
type LogLevel = typeof LogLevels[LogLevelKey];
|
|
164
|
+
/**
|
|
165
|
+
* Get a simple logger with an optional log level.
|
|
166
|
+
*
|
|
167
|
+
* @param logLevel
|
|
168
|
+
* Log level as enumeration value or string.
|
|
169
|
+
*
|
|
170
|
+
* @returns
|
|
171
|
+
* Logger.
|
|
172
|
+
*/
|
|
173
|
+
declare function getLogger(logLevel?: string | number): Logger<unknown>;
|
|
174
|
+
|
|
175
|
+
/**
|
|
176
|
+
* Locale strings type for generic manipulation.
|
|
177
|
+
*/
|
|
178
|
+
interface LocaleResources {
|
|
179
|
+
[key: string]: LocaleResources | string;
|
|
180
|
+
}
|
|
181
|
+
/**
|
|
182
|
+
* Internationalization operating environments.
|
|
183
|
+
*/
|
|
184
|
+
declare const I18nEnvironments: {
|
|
185
|
+
/**
|
|
186
|
+
* Command-line interface (e.g., unit tests).
|
|
187
|
+
*/
|
|
188
|
+
readonly CLI: 0;
|
|
189
|
+
/**
|
|
190
|
+
* Web server.
|
|
191
|
+
*/
|
|
192
|
+
readonly Server: 1;
|
|
193
|
+
/**
|
|
194
|
+
* Web browser.
|
|
195
|
+
*/
|
|
196
|
+
readonly Browser: 2;
|
|
197
|
+
};
|
|
198
|
+
/**
|
|
199
|
+
* Internationalization operating environment key.
|
|
200
|
+
*/
|
|
201
|
+
type I18nEnvironmentKey = keyof typeof I18nEnvironments;
|
|
202
|
+
/**
|
|
203
|
+
* Internationalization operating environment.
|
|
204
|
+
*/
|
|
205
|
+
type I18nEnvironment = typeof I18nEnvironments[I18nEnvironmentKey];
|
|
206
|
+
/**
|
|
207
|
+
* Initialize internationalization.
|
|
208
|
+
*
|
|
209
|
+
* @param i18next
|
|
210
|
+
* Internationalization object. As multiple objects exists, this parameter represents the one for the module for which
|
|
211
|
+
* internationalization is being initialized.
|
|
212
|
+
*
|
|
213
|
+
* @param environment
|
|
214
|
+
* Environment in which the application is running.
|
|
215
|
+
*
|
|
216
|
+
* @param debug
|
|
217
|
+
* Debug setting.
|
|
218
|
+
*
|
|
219
|
+
* @param defaultNS
|
|
220
|
+
* Default namespace.
|
|
221
|
+
*
|
|
222
|
+
* @param resources
|
|
223
|
+
* Resources.
|
|
224
|
+
*
|
|
225
|
+
* @returns
|
|
226
|
+
* Void promise.
|
|
227
|
+
*/
|
|
228
|
+
declare function i18nCoreInit(i18next: i18n, environment: I18nEnvironment, debug: boolean, defaultNS: string, ...resources: Resource[]): Promise<void>;
|
|
229
|
+
|
|
230
|
+
export { type I18nEnvironment, type I18nEnvironmentKey, I18nEnvironments, type LocaleResources, type LogLevel, type LogLevelKey, LogLevels, type NonNullishable, type Nullishable, type Optional, type PromisedType, type PropertyKeys, type TypedAsyncFunction, type TypedFunction, type TypedSyncFunction, getLogger, i18nCoreInit, isNullish, omit, pick, propertyAs };
|