@rivinia/i18n 0.3.3 → 0.4.0
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 +374 -153
- package/cli/rivinia-i18n-keys.mjs +165 -0
- package/fesm2022/{rivinia-i18n-http-loader.impl-DVlKmSDL.mjs → rivinia-i18n-http-loader.impl--BRii7w1.mjs} +5 -3
- package/fesm2022/rivinia-i18n-http-loader.impl--BRii7w1.mjs.map +1 -0
- package/fesm2022/{rivinia-i18n-json-loader.impl-VXwAmyWL.mjs → rivinia-i18n-json-loader.impl-Bq-W-UW9.mjs} +5 -3
- package/fesm2022/rivinia-i18n-json-loader.impl-Bq-W-UW9.mjs.map +1 -0
- package/fesm2022/rivinia-i18n-loader-url-B9SlR1XB.mjs +11 -0
- package/fesm2022/rivinia-i18n-loader-url-B9SlR1XB.mjs.map +1 -0
- package/fesm2022/{rivinia-i18n-remote-loader.impl-XKqdLHoJ.mjs → rivinia-i18n-remote-loader.impl-CqKS6JWN.mjs} +4 -3
- package/fesm2022/rivinia-i18n-remote-loader.impl-CqKS6JWN.mjs.map +1 -0
- package/fesm2022/rivinia-i18n.mjs +397 -62
- package/fesm2022/rivinia-i18n.mjs.map +1 -1
- package/package.json +5 -2
- package/types/rivinia-i18n.d.ts +204 -50
- package/fesm2022/rivinia-i18n-http-loader.impl-DVlKmSDL.mjs.map +0 -1
- package/fesm2022/rivinia-i18n-json-loader.impl-VXwAmyWL.mjs.map +0 -1
- package/fesm2022/rivinia-i18n-remote-loader.impl-XKqdLHoJ.mjs.map +0 -1
|
@@ -0,0 +1,165 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
/**
|
|
3
|
+
* `rivinia-i18n-keys` — generates the typed-key registry for `@rivinia/i18n`.
|
|
4
|
+
*
|
|
5
|
+
* npx rivinia-i18n-keys
|
|
6
|
+
* npx rivinia-i18n-keys --source public/i18n/en.json --out src/i18n-keys.d.ts
|
|
7
|
+
* npx rivinia-i18n-keys --check # CI: exit 1 when the file is stale
|
|
8
|
+
*
|
|
9
|
+
* Nested objects flatten to dot paths, only string leaves become keys, keys
|
|
10
|
+
* are sorted for stable diffs, and quotes are escaped. No dependencies.
|
|
11
|
+
*/
|
|
12
|
+
import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'node:fs';
|
|
13
|
+
import { dirname, relative, resolve } from 'node:path';
|
|
14
|
+
|
|
15
|
+
const DEFAULTS = Object.freeze({
|
|
16
|
+
source: 'public/i18n/en.json',
|
|
17
|
+
out: 'src/i18n-keys.d.ts',
|
|
18
|
+
});
|
|
19
|
+
|
|
20
|
+
const PREFIX = '[rivinia/i18n]';
|
|
21
|
+
|
|
22
|
+
function main(argv) {
|
|
23
|
+
const args = parseArgs(argv);
|
|
24
|
+
if (args.error) {
|
|
25
|
+
console.error(`${PREFIX} ${args.error}`);
|
|
26
|
+
printHelp();
|
|
27
|
+
return 1;
|
|
28
|
+
}
|
|
29
|
+
if (args.help) {
|
|
30
|
+
printHelp();
|
|
31
|
+
return 0;
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
const sourcePath = resolve(args.source ?? DEFAULTS.source);
|
|
35
|
+
const outPath = resolve(args.out ?? DEFAULTS.out);
|
|
36
|
+
|
|
37
|
+
if (!existsSync(sourcePath)) {
|
|
38
|
+
console.error(`${PREFIX} Source dictionary not found: ${sourcePath}`);
|
|
39
|
+
return 1;
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
let dictionary;
|
|
43
|
+
try {
|
|
44
|
+
dictionary = JSON.parse(readFileSync(sourcePath, 'utf8'));
|
|
45
|
+
} catch (error) {
|
|
46
|
+
console.error(`${PREFIX} Could not parse ${sourcePath}: ${error.message}`);
|
|
47
|
+
return 1;
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
const keys = [];
|
|
51
|
+
flatten(dictionary, '', keys);
|
|
52
|
+
keys.sort();
|
|
53
|
+
const output = render(keys);
|
|
54
|
+
|
|
55
|
+
if (args.check) {
|
|
56
|
+
const current = existsSync(outPath) ? readFileSync(outPath, 'utf8') : null;
|
|
57
|
+
if (current === output) {
|
|
58
|
+
console.log(`${PREFIX} ${outPath} is up to date (${keys.length} keys).`);
|
|
59
|
+
return 0;
|
|
60
|
+
}
|
|
61
|
+
console.error(
|
|
62
|
+
`${PREFIX} ${outPath} is stale. Regenerate it:\n` +
|
|
63
|
+
` npx rivinia-i18n-keys --source ${relative(process.cwd(), sourcePath)} ` +
|
|
64
|
+
`--out ${relative(process.cwd(), outPath)}`,
|
|
65
|
+
);
|
|
66
|
+
return 1;
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
mkdirSync(dirname(outPath), { recursive: true });
|
|
70
|
+
writeFileSync(outPath, output, 'utf8');
|
|
71
|
+
console.log(`${PREFIX} Wrote ${keys.length} keys to ${outPath}.`);
|
|
72
|
+
return 0;
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
function parseArgs(argv) {
|
|
76
|
+
const args = {};
|
|
77
|
+
for (let i = 0; i < argv.length; i++) {
|
|
78
|
+
const arg = argv[i];
|
|
79
|
+
if (arg === '--check') {
|
|
80
|
+
args.check = true;
|
|
81
|
+
} else if (arg === '--help' || arg === '-h') {
|
|
82
|
+
args.help = true;
|
|
83
|
+
} else if (arg === '--source' || arg === '--out') {
|
|
84
|
+
const value = argv[i + 1];
|
|
85
|
+
if (value === undefined || value.startsWith('--')) {
|
|
86
|
+
return { error: `${arg} needs a path.` };
|
|
87
|
+
}
|
|
88
|
+
args[arg.slice(2)] = value;
|
|
89
|
+
i++;
|
|
90
|
+
} else if (arg.startsWith('--source=')) {
|
|
91
|
+
args.source = arg.slice('--source='.length);
|
|
92
|
+
} else if (arg.startsWith('--out=')) {
|
|
93
|
+
args.out = arg.slice('--out='.length);
|
|
94
|
+
} else {
|
|
95
|
+
return { error: `Unknown option: ${arg}` };
|
|
96
|
+
}
|
|
97
|
+
}
|
|
98
|
+
return args;
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
function flatten(value, prefix, out) {
|
|
102
|
+
if (Array.isArray(value)) {
|
|
103
|
+
warn(`Skipping array at "${prefix || '(root)'}" — arrays are not keys.`);
|
|
104
|
+
return;
|
|
105
|
+
}
|
|
106
|
+
if (value !== null && typeof value === 'object') {
|
|
107
|
+
for (const [key, child] of Object.entries(value)) {
|
|
108
|
+
flatten(child, prefix ? `${prefix}.${key}` : key, out);
|
|
109
|
+
}
|
|
110
|
+
return;
|
|
111
|
+
}
|
|
112
|
+
if (typeof value === 'string') {
|
|
113
|
+
out.push(prefix);
|
|
114
|
+
return;
|
|
115
|
+
}
|
|
116
|
+
warn(`Skipping non-string value at "${prefix || '(root)'}" (${typeOf(value)}).`);
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
function typeOf(value) {
|
|
120
|
+
if (value === null) return 'null';
|
|
121
|
+
return typeof value;
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
function warn(message) {
|
|
125
|
+
console.warn(`${PREFIX} ${message}`);
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
function render(keys) {
|
|
129
|
+
const union = keys.length === 0 ? 'never' : keys.map((key) => `'${escapeKey(key)}'`).join(' | ');
|
|
130
|
+
return [
|
|
131
|
+
'// Generated by @rivinia/i18n. Do not edit.',
|
|
132
|
+
"import '@rivinia/i18n';",
|
|
133
|
+
'',
|
|
134
|
+
"declare module '@rivinia/i18n' {",
|
|
135
|
+
' interface RiviniaI18nKeyRegistry {',
|
|
136
|
+
` readonly keys: ${union};`,
|
|
137
|
+
' }',
|
|
138
|
+
'}',
|
|
139
|
+
'',
|
|
140
|
+
].join('\n');
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
function escapeKey(key) {
|
|
144
|
+
return key.replace(/\\/g, '\\\\').replace(/'/g, "\\'");
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
function printHelp() {
|
|
148
|
+
console.log(
|
|
149
|
+
[
|
|
150
|
+
'rivinia-i18n-keys — generate typed translation keys for @rivinia/i18n',
|
|
151
|
+
'',
|
|
152
|
+
'Usage:',
|
|
153
|
+
' rivinia-i18n-keys [--source <json>] [--out <d.ts>]',
|
|
154
|
+
' rivinia-i18n-keys --check',
|
|
155
|
+
'',
|
|
156
|
+
'Options:',
|
|
157
|
+
` --source Dictionary to read (default: ${DEFAULTS.source})`,
|
|
158
|
+
` --out Declaration file to write (default: ${DEFAULTS.out})`,
|
|
159
|
+
' --check Exit 1 when --out is missing or stale (for CI)',
|
|
160
|
+
' --help Show this help',
|
|
161
|
+
].join('\n'),
|
|
162
|
+
);
|
|
163
|
+
}
|
|
164
|
+
|
|
165
|
+
process.exitCode = main(process.argv.slice(2));
|
|
@@ -1,10 +1,12 @@
|
|
|
1
|
+
import { t as resolveLoaderUrl } from "./rivinia-i18n-loader-url-B9SlR1XB.mjs";
|
|
1
2
|
var HttpLoader = class {
|
|
2
3
|
_options;
|
|
3
4
|
constructor(_options) {
|
|
4
5
|
this._options = _options;
|
|
5
6
|
}
|
|
6
|
-
async load(language) {
|
|
7
|
-
const
|
|
7
|
+
async load(language, context) {
|
|
8
|
+
const built = this._options.buildUrl?.(language) ?? `${this._options.endpoint}/${language}`;
|
|
9
|
+
const url = resolveLoaderUrl(built, context);
|
|
8
10
|
const response = await fetch(url, { method: this._options.method ?? "GET" });
|
|
9
11
|
if (!response.ok) throw new Error(`[rivinia/i18n] Failed to load "${url}": ${response.statusText}`);
|
|
10
12
|
return response.json();
|
|
@@ -12,4 +14,4 @@ var HttpLoader = class {
|
|
|
12
14
|
};
|
|
13
15
|
export { HttpLoader };
|
|
14
16
|
|
|
15
|
-
//# sourceMappingURL=rivinia-i18n-http-loader.impl
|
|
17
|
+
//# sourceMappingURL=rivinia-i18n-http-loader.impl--BRii7w1.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"rivinia-i18n-http-loader.impl--BRii7w1.mjs","names":[],"sources":["../../../projects/i18n/src/lib/services/http-loader.impl.ts"],"sourcesContent":["import type { HttpLoaderOptions, LoaderContext, TranslationLoader } from '../models/loaders';\nimport { resolveLoaderUrl } from '../utils/loader-url';\n\nexport class HttpLoader<L extends string = string> implements TranslationLoader<L> {\n constructor(private readonly _options: HttpLoaderOptions) {}\n\n async load(language: L, context?: LoaderContext): Promise<Record<string, unknown>> {\n const built = this._options.buildUrl?.(language) ?? `${this._options.endpoint}/${language}`;\n const url = resolveLoaderUrl(built, context);\n const response = await fetch(url, { method: this._options.method ?? 'GET' });\n if (!response.ok) {\n throw new Error(`[rivinia/i18n] Failed to load \"${url}\": ${response.statusText}`);\n }\n return response.json();\n }\n}\n"],"mappings":";AAGA,IAAa,aAAb,MAAuB;CACQ;CAA7B,YAA6B,UAA2B;EAA3B,KAAA,WAAA;CAA8B;CAE3D,MAAM,KAAK,UAAa,SAAuB;EAC7C,MAAM,QAAQ,KAAK,SAAS,WAAW,QAAQ,KAAK,GAAG,KAAK,SAAS,SAAQ,GAAI;EACjF,MAAM,MAAM,iBAAiB,OAAO,OAAO;EAC3C,MAAM,WAAW,MAAM,MAAM,KAAK,EAAE,QAAQ,KAAK,SAAS,UAAU,MAAK,CAAE;EAC3E,IAAI,CAAC,SAAS,IACZ,MAAM,IAAI,MAAM,kCAAkC,IAAG,KAAM,SAAS,YAAY;EAElF,OAAO,SAAS,KAAI;CACtB;AACD"}
|
|
@@ -1,11 +1,13 @@
|
|
|
1
|
+
import { t as resolveLoaderUrl } from "./rivinia-i18n-loader-url-B9SlR1XB.mjs";
|
|
1
2
|
const DEFAULT_BASE_PATH = "i18n";
|
|
2
3
|
var JsonLoader = class {
|
|
3
4
|
_options;
|
|
4
5
|
constructor(_options) {
|
|
5
6
|
this._options = _options;
|
|
6
7
|
}
|
|
7
|
-
async load(language) {
|
|
8
|
-
const
|
|
8
|
+
async load(language, context) {
|
|
9
|
+
const basePath = this._options?.path ?? DEFAULT_BASE_PATH;
|
|
10
|
+
const url = resolveLoaderUrl(`${basePath}/${language}.json`, context);
|
|
9
11
|
const response = await fetch(url);
|
|
10
12
|
if (!response.ok) throw new Error(`[rivinia/i18n] Failed to load "${url}": ${response.statusText}`);
|
|
11
13
|
return response.json();
|
|
@@ -13,4 +15,4 @@ var JsonLoader = class {
|
|
|
13
15
|
};
|
|
14
16
|
export { JsonLoader };
|
|
15
17
|
|
|
16
|
-
//# sourceMappingURL=rivinia-i18n-json-loader.impl-
|
|
18
|
+
//# sourceMappingURL=rivinia-i18n-json-loader.impl-Bq-W-UW9.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"rivinia-i18n-json-loader.impl-Bq-W-UW9.mjs","names":[],"sources":["../../../projects/i18n/src/lib/services/json-loader.impl.ts"],"sourcesContent":["import type { LoaderContext, TranslationLoader } from '../models/loaders';\nimport { resolveLoaderUrl } from '../utils/loader-url';\n\nconst DEFAULT_BASE_PATH = 'i18n';\n\nexport class JsonLoader<L extends string = string> implements TranslationLoader<L> {\n constructor(private readonly _options?: { path?: string }) {}\n\n async load(language: L, context?: LoaderContext): Promise<Record<string, unknown>> {\n const basePath = this._options?.path ?? DEFAULT_BASE_PATH;\n const url = resolveLoaderUrl(`${basePath}/${language}.json`, context);\n const response = await fetch(url);\n if (!response.ok) {\n throw new Error(`[rivinia/i18n] Failed to load \"${url}\": ${response.statusText}`);\n }\n return response.json();\n }\n}\n"],"mappings":";AAGA,MAAM,oBAAoB;AAE1B,IAAa,aAAb,MAAuB;CACQ;CAA7B,YAA6B,UAA4B;EAA5B,KAAA,WAAA;CAA+B;CAE5D,MAAM,KAAK,UAAa,SAAuB;EAC7C,MAAM,WAAW,KAAK,UAAU,QAAQ;EACxC,MAAM,MAAM,iBAAiB,GAAG,SAAQ,GAAI,SAAQ,QAAS,OAAO;EACpE,MAAM,WAAW,MAAM,MAAM,GAAG;EAChC,IAAI,CAAC,SAAS,IACZ,MAAM,IAAI,MAAM,kCAAkC,IAAG,KAAM,SAAS,YAAY;EAElF,OAAO,SAAS,KAAI;CACtB;AACD"}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
function resolveLoaderUrl(url, context) {
|
|
2
|
+
if (!context?.isServer) return url;
|
|
3
|
+
try {
|
|
4
|
+
return new URL(url, context.baseUrl).href;
|
|
5
|
+
} catch {
|
|
6
|
+
return url;
|
|
7
|
+
}
|
|
8
|
+
}
|
|
9
|
+
export { resolveLoaderUrl as t };
|
|
10
|
+
|
|
11
|
+
//# sourceMappingURL=rivinia-i18n-loader-url-B9SlR1XB.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"rivinia-i18n-loader-url-B9SlR1XB.mjs","names":[],"sources":["../../../projects/i18n/src/lib/utils/loader-url.ts"],"sourcesContent":["import type { LoaderContext } from '../models/loaders';\n\n/**\n * Resolves a loader URL for the current platform.\n *\n * The browser already resolves a relative `fetch()` URL against\n * `document.baseURI`, so the string is passed through untouched (a consumer's\n * `fetch` mock keeps seeing the same URL it always saw). On the server there\n * is no document, so a relative URL is resolved against `context.baseUrl`.\n *\n * Absolute URLs are never rewritten, and a base that cannot be parsed leaves\n * the input unchanged — a loader must not throw while building a URL.\n */\nexport function resolveLoaderUrl(url: string, context?: LoaderContext): string {\n if (!context?.isServer) return url;\n try {\n return new URL(url, context.baseUrl).href;\n } catch {\n return url;\n }\n}\n"],"mappings":"AAaA,SAAgB,iBAAiB,KAAa,SAAuB;CACnE,IAAI,CAAC,SAAS,UAAU,OAAO;CAC/B,IAAI;EACF,OAAO,IAAI,IAAI,KAAK,QAAQ,OAAO,CAAC,CAAC;CACvC,QAAQ;EACN,OAAO;CACT;AACF"}
|
|
@@ -1,10 +1,11 @@
|
|
|
1
|
+
import { t as resolveLoaderUrl } from "./rivinia-i18n-loader-url-B9SlR1XB.mjs";
|
|
1
2
|
var RemoteLoader = class {
|
|
2
3
|
_options;
|
|
3
4
|
constructor(_options) {
|
|
4
5
|
this._options = _options;
|
|
5
6
|
}
|
|
6
|
-
async load(language) {
|
|
7
|
-
const url = this._options.url(language);
|
|
7
|
+
async load(language, context) {
|
|
8
|
+
const url = resolveLoaderUrl(this._options.url(language), context);
|
|
8
9
|
const response = await fetch(url, { headers: this._options.headers });
|
|
9
10
|
if (!response.ok) throw new Error(`[rivinia/i18n] Failed to load "${url}": ${response.statusText}`);
|
|
10
11
|
return response.json();
|
|
@@ -12,4 +13,4 @@ var RemoteLoader = class {
|
|
|
12
13
|
};
|
|
13
14
|
export { RemoteLoader };
|
|
14
15
|
|
|
15
|
-
//# sourceMappingURL=rivinia-i18n-remote-loader.impl-
|
|
16
|
+
//# sourceMappingURL=rivinia-i18n-remote-loader.impl-CqKS6JWN.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"rivinia-i18n-remote-loader.impl-CqKS6JWN.mjs","names":[],"sources":["../../../projects/i18n/src/lib/services/remote-loader.impl.ts"],"sourcesContent":["import type { LoaderContext, RemoteLoaderOptions, TranslationLoader } from '../models/loaders';\nimport { resolveLoaderUrl } from '../utils/loader-url';\n\nexport class RemoteLoader<L extends string = string> implements TranslationLoader<L> {\n constructor(private readonly _options: RemoteLoaderOptions) {}\n\n async load(language: L, context?: LoaderContext): Promise<Record<string, unknown>> {\n const url = resolveLoaderUrl(this._options.url(language), context);\n const response = await fetch(url, { headers: this._options.headers });\n if (!response.ok) {\n throw new Error(`[rivinia/i18n] Failed to load \"${url}\": ${response.statusText}`);\n }\n return response.json();\n }\n}\n"],"mappings":";AAGA,IAAa,eAAb,MAAyB;CACM;CAA7B,YAA6B,UAA6B;EAA7B,KAAA,WAAA;CAAgC;CAE7D,MAAM,KAAK,UAAa,SAAuB;EAC7C,MAAM,MAAM,iBAAiB,KAAK,SAAS,IAAI,QAAQ,GAAG,OAAO;EACjE,MAAM,WAAW,MAAM,MAAM,KAAK,EAAE,SAAS,KAAK,SAAS,QAAO,CAAE;EACpE,IAAI,CAAC,SAAS,IACZ,MAAM,IAAI,MAAM,kCAAkC,IAAG,KAAM,SAAS,YAAY;EAElF,OAAO,SAAS,KAAI;CACtB;AACD"}
|