@aidc-toolkit/core 1.0.23-beta → 1.0.24-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 +170 -0
- package/dist/index.d.ts +166 -14
- package/dist/index.js +112 -1
- package/dist/index.js.map +1 -1
- package/package.json +7 -10
- package/src/index.ts +4 -1
- package/src/locale/i18n.ts +0 -91
- package/src/logger.ts +47 -0
- package/src/type-helper.ts +87 -0
- package/src/type.ts +44 -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/dist/index.js
CHANGED
|
@@ -1,3 +1,115 @@
|
|
|
1
|
+
// src/type-helper.ts
|
|
2
|
+
function omitOrPick(omitting, o, ...keys) {
|
|
3
|
+
return Object.fromEntries(Object.entries(o).filter(([key]) => keys.includes(key) !== omitting));
|
|
4
|
+
}
|
|
5
|
+
function omit(o, ...keys) {
|
|
6
|
+
return omitOrPick(true, o, ...keys);
|
|
7
|
+
}
|
|
8
|
+
function pick(o, ...keys) {
|
|
9
|
+
return omitOrPick(false, o, ...keys);
|
|
10
|
+
}
|
|
11
|
+
function propertyAs(o, key) {
|
|
12
|
+
return key in o ? {
|
|
13
|
+
// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- Force cast.
|
|
14
|
+
[key]: o[key]
|
|
15
|
+
} : {};
|
|
16
|
+
}
|
|
17
|
+
function isNullish(argument) {
|
|
18
|
+
return argument === null || argument === void 0;
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
// src/logger.ts
|
|
22
|
+
import { Logger } from "tslog";
|
|
23
|
+
var LogLevels = {
|
|
24
|
+
Silly: 0,
|
|
25
|
+
Trace: 1,
|
|
26
|
+
Debug: 2,
|
|
27
|
+
Info: 3,
|
|
28
|
+
Warn: 4,
|
|
29
|
+
Error: 5,
|
|
30
|
+
Fatal: 6
|
|
31
|
+
};
|
|
32
|
+
function getLogger(logLevel) {
|
|
33
|
+
let minLevel;
|
|
34
|
+
if (typeof logLevel === "string") {
|
|
35
|
+
if (logLevel in LogLevels) {
|
|
36
|
+
minLevel = LogLevels[logLevel];
|
|
37
|
+
} else {
|
|
38
|
+
throw new Error(`Unknown log level ${logLevel}`);
|
|
39
|
+
}
|
|
40
|
+
} else {
|
|
41
|
+
minLevel = logLevel ?? LogLevels.Info;
|
|
42
|
+
}
|
|
43
|
+
return new Logger({
|
|
44
|
+
minLevel
|
|
45
|
+
});
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
// src/locale/i18n.ts
|
|
49
|
+
import I18nextBrowserLanguageDetector from "i18next-browser-languagedetector";
|
|
50
|
+
import I18nextCLILanguageDetector from "i18next-cli-language-detector";
|
|
51
|
+
var I18nEnvironments = {
|
|
52
|
+
/**
|
|
53
|
+
* Command-line interface (e.g., unit tests).
|
|
54
|
+
*/
|
|
55
|
+
CLI: 0,
|
|
56
|
+
/**
|
|
57
|
+
* Web server.
|
|
58
|
+
*/
|
|
59
|
+
Server: 1,
|
|
60
|
+
/**
|
|
61
|
+
* Web browser.
|
|
62
|
+
*/
|
|
63
|
+
Browser: 2
|
|
64
|
+
};
|
|
65
|
+
function toLowerCase(s) {
|
|
66
|
+
return s.split(" ").map((word) => /[a-z]/.test(word) ? word.toLowerCase() : word).join(" ");
|
|
67
|
+
}
|
|
68
|
+
async function i18nCoreInit(i18next, environment, debug, defaultNS, ...resources) {
|
|
69
|
+
if (!i18next.isInitialized) {
|
|
70
|
+
const mergedResource = {};
|
|
71
|
+
for (const resource of resources) {
|
|
72
|
+
for (const [language, resourceLanguage] of Object.entries(resource)) {
|
|
73
|
+
if (!(language in mergedResource)) {
|
|
74
|
+
mergedResource[language] = {};
|
|
75
|
+
}
|
|
76
|
+
const mergedResourceLanguage = mergedResource[language];
|
|
77
|
+
for (const [namespace, resourceKey] of Object.entries(resourceLanguage)) {
|
|
78
|
+
mergedResourceLanguage[namespace] = resourceKey;
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
let module;
|
|
83
|
+
switch (environment) {
|
|
84
|
+
case I18nEnvironments.CLI:
|
|
85
|
+
module = I18nextCLILanguageDetector;
|
|
86
|
+
break;
|
|
87
|
+
case I18nEnvironments.Browser:
|
|
88
|
+
module = I18nextBrowserLanguageDetector;
|
|
89
|
+
break;
|
|
90
|
+
default:
|
|
91
|
+
throw new Error("Not supported");
|
|
92
|
+
}
|
|
93
|
+
await i18next.use(module).init({
|
|
94
|
+
debug,
|
|
95
|
+
resources: mergedResource,
|
|
96
|
+
fallbackLng: "en",
|
|
97
|
+
defaultNS
|
|
98
|
+
}).then(() => {
|
|
99
|
+
i18next.services.formatter?.add("toLowerCase", (value) => typeof value === "string" ? toLowerCase(value) : String(value));
|
|
100
|
+
});
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
export {
|
|
104
|
+
I18nEnvironments,
|
|
105
|
+
LogLevels,
|
|
106
|
+
getLogger,
|
|
107
|
+
i18nCoreInit,
|
|
108
|
+
isNullish,
|
|
109
|
+
omit,
|
|
110
|
+
pick,
|
|
111
|
+
propertyAs
|
|
112
|
+
};
|
|
1
113
|
/*!
|
|
2
114
|
* Copyright © 2024-2025 Dolphin Data Development Ltd. and AIDC Toolkit
|
|
3
115
|
* contributors
|
|
@@ -14,5 +126,4 @@
|
|
|
14
126
|
* See the License for the specific language governing permissions and
|
|
15
127
|
* limitations under the License.
|
|
16
128
|
*/
|
|
17
|
-
export * from "./locale/i18n.js";
|
|
18
129
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"
|
|
1
|
+
{"version":3,"sources":["../src/type-helper.ts","../src/logger.ts","../src/locale/i18n.ts"],"sourcesContent":["/**\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":";AAeA,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,SAAS,cAAc;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,OAAO;AAAA,IACd;AAAA,EACJ,CAAC;AACL;;;AC7CA,OAAO,oCAAoC;AAC3C,OAAO,gCAAgC;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,QAAI;AAEJ,YAAQ,aAAa;AAAA,MACjB,KAAK,iBAAiB;AAGlB,iBAAS;AACT;AAAA,MAEJ,KAAK,iBAAiB;AAClB,iBAAS;AACT;AAAA,MAEJ;AACI,cAAM,IAAI,MAAM,eAAe;AAAA,IACvC;AAEA,UAAM,QAAQ,IAAI,MAAM,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":[]}
|
package/package.json
CHANGED
|
@@ -1,14 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aidc-toolkit/core",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.24-beta",
|
|
4
4
|
"description": "Core functionality for AIDC Toolkit",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.js",
|
|
7
7
|
"homepage": "https://aidc-toolkit.com/",
|
|
8
|
-
"repository":
|
|
9
|
-
"type": "git",
|
|
10
|
-
"url": "git+https://github.com/aidc-toolkit/core.git"
|
|
11
|
-
},
|
|
8
|
+
"repository": "aidc-toolkit/core",
|
|
12
9
|
"bugs": {
|
|
13
10
|
"url": "https://github.com/aidc-toolkit/core/issues"
|
|
14
11
|
},
|
|
@@ -20,17 +17,17 @@
|
|
|
20
17
|
},
|
|
21
18
|
"scripts": {
|
|
22
19
|
"lint": "eslint",
|
|
23
|
-
"build:
|
|
24
|
-
"build:
|
|
25
|
-
"build:release": "npm run build:core -- node_modules/@aidc-toolkit/dev/tsconfig-build.json",
|
|
20
|
+
"build:dev": "tsup --define.mode=dev",
|
|
21
|
+
"build:release": "tsup",
|
|
26
22
|
"build:doc": "npm run build:dev"
|
|
27
23
|
},
|
|
28
24
|
"devDependencies": {
|
|
29
25
|
"@aidc-toolkit/dev": "beta"
|
|
30
26
|
},
|
|
31
27
|
"dependencies": {
|
|
32
|
-
"i18next": "^25.
|
|
28
|
+
"i18next": "^25.7.0",
|
|
33
29
|
"i18next-browser-languagedetector": "^8.2.0",
|
|
34
|
-
"i18next-cli-language-detector": "^1.1.8"
|
|
30
|
+
"i18next-cli-language-detector": "^1.1.8",
|
|
31
|
+
"tslog": "^4.10.2"
|
|
35
32
|
}
|
|
36
33
|
}
|
package/src/index.ts
CHANGED
|
@@ -14,4 +14,7 @@
|
|
|
14
14
|
* See the License for the specific language governing permissions and
|
|
15
15
|
* limitations under the License.
|
|
16
16
|
*/
|
|
17
|
-
export * from "./
|
|
17
|
+
export type * from "./type";
|
|
18
|
+
export * from "./type-helper";
|
|
19
|
+
export * from "./logger";
|
|
20
|
+
export * from "./locale/i18n";
|
package/src/locale/i18n.ts
CHANGED
|
@@ -34,97 +34,6 @@ export const I18nEnvironments = {
|
|
|
34
34
|
*/
|
|
35
35
|
export type I18nEnvironment = typeof I18nEnvironments[keyof typeof I18nEnvironments];
|
|
36
36
|
|
|
37
|
-
/**
|
|
38
|
-
* Parse parameter names in a resource string.
|
|
39
|
-
*
|
|
40
|
-
* @param s
|
|
41
|
-
* Resource string.
|
|
42
|
-
*
|
|
43
|
-
* @returns
|
|
44
|
-
* Array of parameter names.
|
|
45
|
-
*/
|
|
46
|
-
function parseParameterNames(s: string): string[] {
|
|
47
|
-
const parameterRegExp = /\{\{.+?}}/g;
|
|
48
|
-
|
|
49
|
-
const parameterNames: string[] = [];
|
|
50
|
-
|
|
51
|
-
let match: RegExpExecArray | null;
|
|
52
|
-
|
|
53
|
-
while ((match = parameterRegExp.exec(s)) !== null) {
|
|
54
|
-
parameterNames.push(match[1]);
|
|
55
|
-
}
|
|
56
|
-
|
|
57
|
-
return parameterNames;
|
|
58
|
-
}
|
|
59
|
-
|
|
60
|
-
/**
|
|
61
|
-
* Assert that language resources are a type match for English (default) resources.
|
|
62
|
-
*
|
|
63
|
-
* @param enResources
|
|
64
|
-
* English resources.
|
|
65
|
-
*
|
|
66
|
-
* @param lng
|
|
67
|
-
* Language.
|
|
68
|
-
*
|
|
69
|
-
* @param lngResources
|
|
70
|
-
* Language resources.
|
|
71
|
-
*
|
|
72
|
-
* @param parent
|
|
73
|
-
* Parent key name (set recursively).
|
|
74
|
-
*/
|
|
75
|
-
export function i18nAssertValidResources(enResources: object, lng: string, lngResources: object, parent?: string): void {
|
|
76
|
-
const enResourcesMap = new Map<string, object>(Object.entries(enResources));
|
|
77
|
-
const lngResourcesMap = new Map<string, object>(Object.entries(lngResources));
|
|
78
|
-
|
|
79
|
-
const isLocale = lng.includes("-");
|
|
80
|
-
|
|
81
|
-
for (const [enKey, enValue] of enResourcesMap) {
|
|
82
|
-
const enFullKey = `${parent === undefined ? "" : `${parent}.`}${enKey}`;
|
|
83
|
-
|
|
84
|
-
const lngValue = lngResourcesMap.get(enKey);
|
|
85
|
-
|
|
86
|
-
if (lngValue !== undefined) {
|
|
87
|
-
const enValueType = typeof enValue;
|
|
88
|
-
const lngValueType = typeof lngValue;
|
|
89
|
-
|
|
90
|
-
if (lngValueType !== enValueType) {
|
|
91
|
-
throw new Error(`Mismatched value type ${lngValueType} for key ${enFullKey} in ${lng} resources (expected ${enValueType})`);
|
|
92
|
-
}
|
|
93
|
-
|
|
94
|
-
if (enValueType === "string") {
|
|
95
|
-
// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- Value is known to be string.
|
|
96
|
-
const enParameterNames = parseParameterNames(enValue as unknown as string);
|
|
97
|
-
|
|
98
|
-
// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- Value is known to be string.
|
|
99
|
-
const lngParameterNames = parseParameterNames(lngValue as unknown as string);
|
|
100
|
-
|
|
101
|
-
for (const enParameterName of enParameterNames) {
|
|
102
|
-
if (!lngParameterNames.includes(enParameterName)) {
|
|
103
|
-
throw new Error(`Missing parameter ${enParameterName} for key ${enFullKey} in ${lng} resources`);
|
|
104
|
-
}
|
|
105
|
-
}
|
|
106
|
-
|
|
107
|
-
for (const lngParameterName of lngParameterNames) {
|
|
108
|
-
if (!enParameterNames.includes(lngParameterName)) {
|
|
109
|
-
throw new Error(`Extraneous parameter ${lngParameterName} for key ${enFullKey} in ${lng} resources`);
|
|
110
|
-
}
|
|
111
|
-
}
|
|
112
|
-
} else if (enValueType === "object") {
|
|
113
|
-
i18nAssertValidResources(enValue, lng, lngValue, `${parent === undefined ? "" : `${parent}.`}${enKey}`);
|
|
114
|
-
}
|
|
115
|
-
// Locale falls back to raw language so ignore if missing.
|
|
116
|
-
} else if (!isLocale) {
|
|
117
|
-
throw new Error(`Missing key ${enFullKey} in ${lng} resources`);
|
|
118
|
-
}
|
|
119
|
-
}
|
|
120
|
-
|
|
121
|
-
for (const [lngKey] of lngResourcesMap) {
|
|
122
|
-
if (!enResourcesMap.has(lngKey)) {
|
|
123
|
-
throw new Error(`Extraneous key ${parent === undefined ? "" : `${parent}.`}${lngKey} in ${lng} resources`);
|
|
124
|
-
}
|
|
125
|
-
}
|
|
126
|
-
}
|
|
127
|
-
|
|
128
37
|
/**
|
|
129
38
|
* Convert a string to lower case, skipping words that are all upper case.
|
|
130
39
|
*
|
package/src/logger.ts
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
import { Logger } from "tslog";
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Log levels.
|
|
5
|
+
*/
|
|
6
|
+
export const LogLevels = {
|
|
7
|
+
Silly: 0,
|
|
8
|
+
Trace: 1,
|
|
9
|
+
Debug: 2,
|
|
10
|
+
Info: 3,
|
|
11
|
+
Warn: 4,
|
|
12
|
+
Error: 5,
|
|
13
|
+
Fatal: 6
|
|
14
|
+
} as const;
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
* Log level.
|
|
18
|
+
*/
|
|
19
|
+
export type LogLevel = typeof LogLevels[keyof typeof LogLevels];
|
|
20
|
+
|
|
21
|
+
/**
|
|
22
|
+
* Get a simple logger with an optional log level.
|
|
23
|
+
*
|
|
24
|
+
* @param logLevel
|
|
25
|
+
* Log level as enumeration value or string if any.
|
|
26
|
+
*
|
|
27
|
+
* @returns
|
|
28
|
+
* Logger.
|
|
29
|
+
*/
|
|
30
|
+
export function getLogger(logLevel?: string | number): Logger<unknown> {
|
|
31
|
+
let minLevel: number;
|
|
32
|
+
|
|
33
|
+
if (typeof logLevel === "string") {
|
|
34
|
+
if (logLevel in LogLevels) {
|
|
35
|
+
// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- String exists as a key.
|
|
36
|
+
minLevel = LogLevels[logLevel as keyof typeof LogLevels];
|
|
37
|
+
} else {
|
|
38
|
+
throw new Error(`Unknown log level ${logLevel}`);
|
|
39
|
+
}
|
|
40
|
+
} else {
|
|
41
|
+
minLevel = logLevel ?? LogLevels.Info;
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
return new Logger({
|
|
45
|
+
minLevel
|
|
46
|
+
});
|
|
47
|
+
}
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Create an object with omitted or picked entries.
|
|
3
|
+
*
|
|
4
|
+
* @param omitting
|
|
5
|
+
* True if omitting.
|
|
6
|
+
*
|
|
7
|
+
* @param o
|
|
8
|
+
* Object.
|
|
9
|
+
*
|
|
10
|
+
* @param keys
|
|
11
|
+
* Keys to omit or pick.
|
|
12
|
+
*
|
|
13
|
+
* @returns
|
|
14
|
+
* Edited object.
|
|
15
|
+
*/
|
|
16
|
+
function 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> {
|
|
17
|
+
// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- Key and value types are known.
|
|
18
|
+
return Object.fromEntries(Object.entries(o).filter(([key]) => keys.includes(key as K) !== omitting)) as ReturnType<typeof omitOrPick<Omitting, T, K>>;
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
/**
|
|
22
|
+
* Create an object with omitted entries.
|
|
23
|
+
*
|
|
24
|
+
* @param o
|
|
25
|
+
* Object.
|
|
26
|
+
*
|
|
27
|
+
* @param keys
|
|
28
|
+
* Keys to omit.
|
|
29
|
+
*
|
|
30
|
+
* @returns
|
|
31
|
+
* Edited object.
|
|
32
|
+
*/
|
|
33
|
+
export function omit<T extends object, K extends keyof T>(o: T, ...keys: K[]): Omit<T, K> {
|
|
34
|
+
return omitOrPick(true, o, ...keys);
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* Create an object with picked entries.
|
|
39
|
+
*
|
|
40
|
+
* @param o
|
|
41
|
+
* Object.
|
|
42
|
+
*
|
|
43
|
+
* @param keys
|
|
44
|
+
* Keys to pick.
|
|
45
|
+
*
|
|
46
|
+
* @returns
|
|
47
|
+
* Edited object.
|
|
48
|
+
*/
|
|
49
|
+
export function pick<T extends object, K extends keyof T>(o: T, ...keys: K[]): Pick<T, K> {
|
|
50
|
+
return omitOrPick(false, o, ...keys);
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
/**
|
|
54
|
+
* Cast a property as a more narrow type.
|
|
55
|
+
*
|
|
56
|
+
* @param o
|
|
57
|
+
* Object.
|
|
58
|
+
*
|
|
59
|
+
* @param key
|
|
60
|
+
* Key of property to cast.
|
|
61
|
+
*
|
|
62
|
+
* @returns
|
|
63
|
+
* Single-key object with property cast as desired type.
|
|
64
|
+
*/
|
|
65
|
+
export 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>> {
|
|
66
|
+
// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- Type is determined by condition.
|
|
67
|
+
return (key in o ?
|
|
68
|
+
{
|
|
69
|
+
// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- Force cast.
|
|
70
|
+
[key]: o[key] as TAsType
|
|
71
|
+
} :
|
|
72
|
+
{}
|
|
73
|
+
) as ReturnType<typeof propertyAs<TAsType, T, K>>;
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
/**
|
|
77
|
+
* Determine if argument is nullish. Application extension may pass `null` or `undefined` to missing parameters.
|
|
78
|
+
*
|
|
79
|
+
* @param argument
|
|
80
|
+
* Argument.
|
|
81
|
+
*
|
|
82
|
+
* @returns
|
|
83
|
+
* True if argument is undefined or null.
|
|
84
|
+
*/
|
|
85
|
+
export function isNullish<T>(argument: T | null | undefined): argument is null | undefined {
|
|
86
|
+
return argument === null || argument === undefined;
|
|
87
|
+
}
|
package/src/type.ts
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Typed function, applicable to any function, stricter than {@link Function}.
|
|
3
|
+
*/
|
|
4
|
+
export type TypedFunction<TMethod extends (...args: Parameters<TMethod>) => ReturnType<TMethod>> = (...args: Parameters<TMethod>) => ReturnType<TMethod>;
|
|
5
|
+
|
|
6
|
+
/**
|
|
7
|
+
* Typed synchronous function, applicable to any function that doesn't return a Promise.
|
|
8
|
+
*/
|
|
9
|
+
export type TypedSyncFunction<TMethod extends TypedFunction<TMethod>> = [ReturnType<TMethod>] extends [PromiseLike<unknown>] ? never : TypedFunction<TMethod>;
|
|
10
|
+
|
|
11
|
+
/**
|
|
12
|
+
* Determine the fundamental promised type. This is stricter than `Awaited\<Type\>` in that it requires a Promise.
|
|
13
|
+
*/
|
|
14
|
+
type PromisedType<T> = [T] extends [PromiseLike<infer TPromised>] ? TPromised : never;
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
* Typed asynchronous function, applicable to any function that returns a Promise.
|
|
18
|
+
*/
|
|
19
|
+
export type TypedAsyncFunction<TMethod extends (...args: Parameters<TMethod>) => PromiseLike<PromisedType<ReturnType<TMethod>>>> = (...args: Parameters<TMethod>) => Promise<PromisedType<ReturnType<TMethod>>>;
|
|
20
|
+
|
|
21
|
+
/**
|
|
22
|
+
* Nullishable type. Extends a type by allowing `null` and `undefined`.
|
|
23
|
+
*/
|
|
24
|
+
export type Nullishable<T> = T | null | undefined;
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
* Non-nullishable type. If T is an object type, it is spread and attributes within it are made non-nullishable.
|
|
28
|
+
* Equivalent to a deep `Required\<T\>` for an object and `NonNullable\<T\>` for any other type.
|
|
29
|
+
*/
|
|
30
|
+
export type NonNullishable<T> = T extends object ? {
|
|
31
|
+
[P in keyof T]-?: NonNullishable<T[P]>
|
|
32
|
+
} : NonNullable<T>;
|
|
33
|
+
|
|
34
|
+
/**
|
|
35
|
+
* Make some keys within a type optional.
|
|
36
|
+
*/
|
|
37
|
+
export type Optional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
|
|
38
|
+
|
|
39
|
+
/**
|
|
40
|
+
* Type to restrict property keys to those that are strings and that support a specified type.
|
|
41
|
+
*/
|
|
42
|
+
export type PropertyKeys<T, TProperty> = {
|
|
43
|
+
[K in keyof T]: K extends string ? T[K] extends TProperty ? K : never : never;
|
|
44
|
+
}[keyof T];
|
package/tsup.config.ts
ADDED
package/typedoc.json
CHANGED
package/dist/index.d.ts.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,cAAc,kBAAkB,CAAC"}
|
package/dist/locale/i18n.d.ts
DELETED
|
@@ -1,68 +0,0 @@
|
|
|
1
|
-
import type { i18n, Resource } from "i18next";
|
|
2
|
-
/**
|
|
3
|
-
* Locale strings type for generic manipulation.
|
|
4
|
-
*/
|
|
5
|
-
export interface LocaleResources {
|
|
6
|
-
[key: string]: LocaleResources | string;
|
|
7
|
-
}
|
|
8
|
-
/**
|
|
9
|
-
* Internationalization operating environments.
|
|
10
|
-
*/
|
|
11
|
-
export declare const I18nEnvironments: {
|
|
12
|
-
/**
|
|
13
|
-
* Command-line interface (e.g., unit tests).
|
|
14
|
-
*/
|
|
15
|
-
readonly CLI: 0;
|
|
16
|
-
/**
|
|
17
|
-
* Web server.
|
|
18
|
-
*/
|
|
19
|
-
readonly Server: 1;
|
|
20
|
-
/**
|
|
21
|
-
* Web browser.
|
|
22
|
-
*/
|
|
23
|
-
readonly Browser: 2;
|
|
24
|
-
};
|
|
25
|
-
/**
|
|
26
|
-
* Internationalization operating environment.
|
|
27
|
-
*/
|
|
28
|
-
export type I18nEnvironment = typeof I18nEnvironments[keyof typeof I18nEnvironments];
|
|
29
|
-
/**
|
|
30
|
-
* Assert that language resources are a type match for English (default) resources.
|
|
31
|
-
*
|
|
32
|
-
* @param enResources
|
|
33
|
-
* English resources.
|
|
34
|
-
*
|
|
35
|
-
* @param lng
|
|
36
|
-
* Language.
|
|
37
|
-
*
|
|
38
|
-
* @param lngResources
|
|
39
|
-
* Language resources.
|
|
40
|
-
*
|
|
41
|
-
* @param parent
|
|
42
|
-
* Parent key name (set recursively).
|
|
43
|
-
*/
|
|
44
|
-
export declare function i18nAssertValidResources(enResources: object, lng: string, lngResources: object, parent?: string): void;
|
|
45
|
-
/**
|
|
46
|
-
* Initialize internationalization.
|
|
47
|
-
*
|
|
48
|
-
* @param i18next
|
|
49
|
-
* Internationalization object. As multiple objects exists, this parameter represents the one for the module for which
|
|
50
|
-
* internationalization is being initialized.
|
|
51
|
-
*
|
|
52
|
-
* @param environment
|
|
53
|
-
* Environment in which the application is running.
|
|
54
|
-
*
|
|
55
|
-
* @param debug
|
|
56
|
-
* Debug setting.
|
|
57
|
-
*
|
|
58
|
-
* @param defaultNS
|
|
59
|
-
* Default namespace.
|
|
60
|
-
*
|
|
61
|
-
* @param resources
|
|
62
|
-
* Resources.
|
|
63
|
-
*
|
|
64
|
-
* @returns
|
|
65
|
-
* Void promise.
|
|
66
|
-
*/
|
|
67
|
-
export declare function i18nCoreInit(i18next: i18n, environment: I18nEnvironment, debug: boolean, defaultNS: string, ...resources: Resource[]): Promise<void>;
|
|
68
|
-
//# sourceMappingURL=i18n.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"i18n.d.ts","sourceRoot":"","sources":["../../src/locale/i18n.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAA0B,QAAQ,EAAE,MAAM,SAAS,CAAC;AAItE;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,GAAG,MAAM,CAAC;CAC3C;AAED;;GAEG;AACH,eAAO,MAAM,gBAAgB;IACzB;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;CAEG,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,OAAO,gBAAgB,CAAC,MAAM,OAAO,gBAAgB,CAAC,CAAC;AAyBrF;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,wBAAwB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAmDtH;AAgBD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAsB,YAAY,CAAC,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,eAAe,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,SAAS,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAiD1J"}
|