@objectstack/service-i18n 4.0.4 → 4.1.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 +6 -8
- package/package.json +31 -6
- package/.turbo/turbo-build.log +0 -22
- package/CHANGELOG.md +0 -170
- package/src/file-i18n-adapter.test.ts +0 -221
- package/src/file-i18n-adapter.ts +0 -193
- package/src/i18n-service-plugin.test.ts +0 -280
- package/src/i18n-service-plugin.ts +0 -198
- package/src/index.ts +0 -6
- package/tsconfig.json +0 -17
package/README.md
CHANGED
|
@@ -258,18 +258,16 @@ await i18n.reload();
|
|
|
258
258
|
Translate metadata labels automatically:
|
|
259
259
|
|
|
260
260
|
```typescript
|
|
261
|
-
import {
|
|
261
|
+
import { ObjectSchema, Field } from '@objectstack/spec/data';
|
|
262
262
|
|
|
263
|
-
const contact =
|
|
263
|
+
const contact = ObjectSchema.create({
|
|
264
264
|
name: 'contact',
|
|
265
265
|
label: 'i18n:objects.contact.label', // References translation key
|
|
266
|
-
fields:
|
|
267
|
-
{
|
|
268
|
-
name: 'name',
|
|
266
|
+
fields: {
|
|
267
|
+
name: Field.text({
|
|
269
268
|
label: 'i18n:fields.contact.name',
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
],
|
|
269
|
+
}),
|
|
270
|
+
},
|
|
273
271
|
});
|
|
274
272
|
|
|
275
273
|
// Translation file: locales/en-US/metadata.json
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@objectstack/service-i18n",
|
|
3
|
-
"version": "4.0
|
|
3
|
+
"version": "4.1.0",
|
|
4
4
|
"license": "Apache-2.0",
|
|
5
5
|
"description": "I18n Service for ObjectStack — implements II18nService with file-based locale loading",
|
|
6
6
|
"type": "module",
|
|
@@ -14,13 +14,38 @@
|
|
|
14
14
|
}
|
|
15
15
|
},
|
|
16
16
|
"dependencies": {
|
|
17
|
-
"@objectstack/core": "4.0
|
|
18
|
-
"@objectstack/spec": "4.0
|
|
17
|
+
"@objectstack/core": "4.1.0",
|
|
18
|
+
"@objectstack/spec": "4.1.0"
|
|
19
19
|
},
|
|
20
20
|
"devDependencies": {
|
|
21
|
-
"@types/node": "^25.
|
|
22
|
-
"typescript": "^6.0.
|
|
23
|
-
"vitest": "^4.1.
|
|
21
|
+
"@types/node": "^25.9.1",
|
|
22
|
+
"typescript": "^6.0.3",
|
|
23
|
+
"vitest": "^4.1.7"
|
|
24
|
+
},
|
|
25
|
+
"keywords": [
|
|
26
|
+
"objectstack",
|
|
27
|
+
"service",
|
|
28
|
+
"i18n",
|
|
29
|
+
"l10n",
|
|
30
|
+
"translations"
|
|
31
|
+
],
|
|
32
|
+
"author": "ObjectStack",
|
|
33
|
+
"repository": {
|
|
34
|
+
"type": "git",
|
|
35
|
+
"url": "https://github.com/objectstack-ai/framework.git",
|
|
36
|
+
"directory": "packages/services/service-i18n"
|
|
37
|
+
},
|
|
38
|
+
"homepage": "https://objectstack.ai/docs",
|
|
39
|
+
"bugs": "https://github.com/objectstack-ai/framework/issues",
|
|
40
|
+
"publishConfig": {
|
|
41
|
+
"access": "public"
|
|
42
|
+
},
|
|
43
|
+
"files": [
|
|
44
|
+
"dist",
|
|
45
|
+
"README.md"
|
|
46
|
+
],
|
|
47
|
+
"engines": {
|
|
48
|
+
"node": ">=18.0.0"
|
|
24
49
|
},
|
|
25
50
|
"scripts": {
|
|
26
51
|
"build": "tsup --config ../../../tsup.config.ts",
|
package/.turbo/turbo-build.log
DELETED
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
> @objectstack/service-i18n@4.0.4 build /home/runner/work/framework/framework/packages/services/service-i18n
|
|
3
|
-
> tsup --config ../../../tsup.config.ts
|
|
4
|
-
|
|
5
|
-
[34mCLI[39m Building entry: src/index.ts
|
|
6
|
-
[34mCLI[39m Using tsconfig: tsconfig.json
|
|
7
|
-
[34mCLI[39m tsup v8.5.1
|
|
8
|
-
[34mCLI[39m Using tsup config: /home/runner/work/framework/framework/tsup.config.ts
|
|
9
|
-
[34mCLI[39m Target: es2020
|
|
10
|
-
[34mCLI[39m Cleaning output folder
|
|
11
|
-
[34mESM[39m Build start
|
|
12
|
-
[34mCJS[39m Build start
|
|
13
|
-
[32mCJS[39m [1mdist/index.cjs [22m[32m8.50 KB[39m
|
|
14
|
-
[32mCJS[39m [1mdist/index.cjs.map [22m[32m18.42 KB[39m
|
|
15
|
-
[32mCJS[39m ⚡️ Build success in 123ms
|
|
16
|
-
[32mESM[39m [1mdist/index.js [22m[32m6.84 KB[39m
|
|
17
|
-
[32mESM[39m [1mdist/index.js.map [22m[32m18.02 KB[39m
|
|
18
|
-
[32mESM[39m ⚡️ Build success in 130ms
|
|
19
|
-
[34mDTS[39m Build start
|
|
20
|
-
[32mDTS[39m ⚡️ Build success in 16111ms
|
|
21
|
-
[32mDTS[39m [1mdist/index.d.ts [22m[32m4.41 KB[39m
|
|
22
|
-
[32mDTS[39m [1mdist/index.d.cts [22m[32m4.41 KB[39m
|
package/CHANGELOG.md
DELETED
|
@@ -1,170 +0,0 @@
|
|
|
1
|
-
# @objectstack/service-i18n
|
|
2
|
-
|
|
3
|
-
## 4.0.4
|
|
4
|
-
|
|
5
|
-
### Patch Changes
|
|
6
|
-
|
|
7
|
-
- Updated dependencies [326b66b]
|
|
8
|
-
- @objectstack/spec@4.0.4
|
|
9
|
-
- @objectstack/core@4.0.4
|
|
10
|
-
|
|
11
|
-
## 4.0.3
|
|
12
|
-
|
|
13
|
-
### Patch Changes
|
|
14
|
-
|
|
15
|
-
- @objectstack/spec@4.0.3
|
|
16
|
-
- @objectstack/core@4.0.3
|
|
17
|
-
|
|
18
|
-
## 4.0.2
|
|
19
|
-
|
|
20
|
-
### Patch Changes
|
|
21
|
-
|
|
22
|
-
- Updated dependencies [5f659e9]
|
|
23
|
-
- @objectstack/spec@4.0.2
|
|
24
|
-
- @objectstack/core@4.0.2
|
|
25
|
-
|
|
26
|
-
## 4.0.0
|
|
27
|
-
|
|
28
|
-
### Patch Changes
|
|
29
|
-
|
|
30
|
-
- Updated dependencies [f08ffc3]
|
|
31
|
-
- Updated dependencies [e0b0a78]
|
|
32
|
-
- @objectstack/spec@4.0.0
|
|
33
|
-
- @objectstack/core@4.0.0
|
|
34
|
-
|
|
35
|
-
## 3.3.1
|
|
36
|
-
|
|
37
|
-
### Patch Changes
|
|
38
|
-
|
|
39
|
-
- 772dc3f: fix i18n
|
|
40
|
-
- @objectstack/spec@3.3.1
|
|
41
|
-
- @objectstack/core@3.3.1
|
|
42
|
-
|
|
43
|
-
## 3.3.0
|
|
44
|
-
|
|
45
|
-
### Patch Changes
|
|
46
|
-
|
|
47
|
-
- @objectstack/spec@3.3.0
|
|
48
|
-
- @objectstack/core@3.3.0
|
|
49
|
-
|
|
50
|
-
## 3.2.9
|
|
51
|
-
|
|
52
|
-
### Patch Changes
|
|
53
|
-
|
|
54
|
-
- @objectstack/spec@3.2.9
|
|
55
|
-
- @objectstack/core@3.2.9
|
|
56
|
-
|
|
57
|
-
## 3.2.8
|
|
58
|
-
|
|
59
|
-
### Patch Changes
|
|
60
|
-
|
|
61
|
-
- @objectstack/spec@3.2.8
|
|
62
|
-
- @objectstack/core@3.2.8
|
|
63
|
-
|
|
64
|
-
## 3.2.7
|
|
65
|
-
|
|
66
|
-
### Patch Changes
|
|
67
|
-
|
|
68
|
-
- @objectstack/spec@3.2.7
|
|
69
|
-
- @objectstack/core@3.2.7
|
|
70
|
-
|
|
71
|
-
## 3.2.6
|
|
72
|
-
|
|
73
|
-
### Patch Changes
|
|
74
|
-
|
|
75
|
-
- 83151bc: fix i18n
|
|
76
|
-
- @objectstack/spec@3.2.6
|
|
77
|
-
- @objectstack/core@3.2.6
|
|
78
|
-
|
|
79
|
-
## 3.2.5
|
|
80
|
-
|
|
81
|
-
### Patch Changes
|
|
82
|
-
|
|
83
|
-
- @objectstack/spec@3.2.5
|
|
84
|
-
- @objectstack/core@3.2.5
|
|
85
|
-
|
|
86
|
-
## 3.2.4
|
|
87
|
-
|
|
88
|
-
### Patch Changes
|
|
89
|
-
|
|
90
|
-
- @objectstack/spec@3.2.4
|
|
91
|
-
- @objectstack/core@3.2.4
|
|
92
|
-
|
|
93
|
-
## 3.2.3
|
|
94
|
-
|
|
95
|
-
### Patch Changes
|
|
96
|
-
|
|
97
|
-
- @objectstack/spec@3.2.3
|
|
98
|
-
- @objectstack/core@3.2.3
|
|
99
|
-
|
|
100
|
-
## 3.2.2
|
|
101
|
-
|
|
102
|
-
### Patch Changes
|
|
103
|
-
|
|
104
|
-
- Updated dependencies [46defbb]
|
|
105
|
-
- @objectstack/spec@3.2.2
|
|
106
|
-
- @objectstack/core@3.2.2
|
|
107
|
-
|
|
108
|
-
## 3.2.1
|
|
109
|
-
|
|
110
|
-
### Patch Changes
|
|
111
|
-
|
|
112
|
-
- Updated dependencies [850b546]
|
|
113
|
-
- @objectstack/spec@3.2.1
|
|
114
|
-
- @objectstack/core@3.2.1
|
|
115
|
-
|
|
116
|
-
## 3.2.0
|
|
117
|
-
|
|
118
|
-
### Patch Changes
|
|
119
|
-
|
|
120
|
-
- Updated dependencies [5901c29]
|
|
121
|
-
- @objectstack/spec@3.2.0
|
|
122
|
-
- @objectstack/core@3.2.0
|
|
123
|
-
|
|
124
|
-
## 3.1.1
|
|
125
|
-
|
|
126
|
-
### Patch Changes
|
|
127
|
-
|
|
128
|
-
- Updated dependencies [953d667]
|
|
129
|
-
- @objectstack/spec@3.1.1
|
|
130
|
-
- @objectstack/core@3.1.1
|
|
131
|
-
|
|
132
|
-
## 3.1.0
|
|
133
|
-
|
|
134
|
-
### Patch Changes
|
|
135
|
-
|
|
136
|
-
- Updated dependencies [0088830]
|
|
137
|
-
- @objectstack/spec@3.1.0
|
|
138
|
-
- @objectstack/core@3.1.0
|
|
139
|
-
|
|
140
|
-
## 3.0.11
|
|
141
|
-
|
|
142
|
-
### Patch Changes
|
|
143
|
-
|
|
144
|
-
- Updated dependencies [92d9d99]
|
|
145
|
-
- @objectstack/spec@3.0.11
|
|
146
|
-
- @objectstack/core@3.0.11
|
|
147
|
-
|
|
148
|
-
## 3.0.10
|
|
149
|
-
|
|
150
|
-
### Patch Changes
|
|
151
|
-
|
|
152
|
-
- Updated dependencies [d1e5d31]
|
|
153
|
-
- @objectstack/spec@3.0.10
|
|
154
|
-
- @objectstack/core@3.0.10
|
|
155
|
-
|
|
156
|
-
## 3.0.9
|
|
157
|
-
|
|
158
|
-
### Patch Changes
|
|
159
|
-
|
|
160
|
-
- Updated dependencies [15e0df6]
|
|
161
|
-
- @objectstack/spec@3.0.9
|
|
162
|
-
- @objectstack/core@3.0.9
|
|
163
|
-
|
|
164
|
-
## 3.0.8
|
|
165
|
-
|
|
166
|
-
### Patch Changes
|
|
167
|
-
|
|
168
|
-
- Updated dependencies [5a968a2]
|
|
169
|
-
- @objectstack/spec@3.0.8
|
|
170
|
-
- @objectstack/core@3.0.8
|
|
@@ -1,221 +0,0 @@
|
|
|
1
|
-
// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.
|
|
2
|
-
|
|
3
|
-
import { describe, it, expect, beforeEach, afterEach } from 'vitest';
|
|
4
|
-
import { FileI18nAdapter } from './file-i18n-adapter';
|
|
5
|
-
import type { II18nService } from '@objectstack/spec/contracts';
|
|
6
|
-
import * as fs from 'node:fs';
|
|
7
|
-
import * as path from 'node:path';
|
|
8
|
-
import * as os from 'node:os';
|
|
9
|
-
|
|
10
|
-
describe('FileI18nAdapter', () => {
|
|
11
|
-
it('should implement II18nService contract', () => {
|
|
12
|
-
const i18n: II18nService = new FileI18nAdapter();
|
|
13
|
-
expect(typeof i18n.t).toBe('function');
|
|
14
|
-
expect(typeof i18n.getTranslations).toBe('function');
|
|
15
|
-
expect(typeof i18n.loadTranslations).toBe('function');
|
|
16
|
-
expect(typeof i18n.getLocales).toBe('function');
|
|
17
|
-
expect(typeof i18n.getDefaultLocale).toBe('function');
|
|
18
|
-
expect(typeof i18n.setDefaultLocale).toBe('function');
|
|
19
|
-
});
|
|
20
|
-
|
|
21
|
-
it('should default to "en" locale', () => {
|
|
22
|
-
const i18n = new FileI18nAdapter();
|
|
23
|
-
expect(i18n.getDefaultLocale()).toBe('en');
|
|
24
|
-
});
|
|
25
|
-
|
|
26
|
-
it('should use custom default locale', () => {
|
|
27
|
-
const i18n = new FileI18nAdapter({ defaultLocale: 'zh-CN' });
|
|
28
|
-
expect(i18n.getDefaultLocale()).toBe('zh-CN');
|
|
29
|
-
});
|
|
30
|
-
|
|
31
|
-
it('should set and get default locale', () => {
|
|
32
|
-
const i18n = new FileI18nAdapter();
|
|
33
|
-
i18n.setDefaultLocale('ja');
|
|
34
|
-
expect(i18n.getDefaultLocale()).toBe('ja');
|
|
35
|
-
});
|
|
36
|
-
|
|
37
|
-
it('should return empty translations for unknown locale', () => {
|
|
38
|
-
const i18n = new FileI18nAdapter();
|
|
39
|
-
expect(i18n.getTranslations('fr')).toEqual({});
|
|
40
|
-
});
|
|
41
|
-
|
|
42
|
-
it('should return empty locales when no translations loaded', () => {
|
|
43
|
-
const i18n = new FileI18nAdapter();
|
|
44
|
-
expect(i18n.getLocales()).toEqual([]);
|
|
45
|
-
});
|
|
46
|
-
|
|
47
|
-
it('should load and retrieve translations', () => {
|
|
48
|
-
const i18n = new FileI18nAdapter();
|
|
49
|
-
i18n.loadTranslations('en', { greeting: 'Hello' });
|
|
50
|
-
i18n.loadTranslations('zh-CN', { greeting: '你好' });
|
|
51
|
-
|
|
52
|
-
expect(i18n.getLocales()).toContain('en');
|
|
53
|
-
expect(i18n.getLocales()).toContain('zh-CN');
|
|
54
|
-
expect(i18n.getTranslations('en')).toEqual({ greeting: 'Hello' });
|
|
55
|
-
expect(i18n.getTranslations('zh-CN')).toEqual({ greeting: '你好' });
|
|
56
|
-
});
|
|
57
|
-
|
|
58
|
-
it('should merge translations when loading into existing locale', () => {
|
|
59
|
-
const i18n = new FileI18nAdapter();
|
|
60
|
-
i18n.loadTranslations('en', { greeting: 'Hello' });
|
|
61
|
-
i18n.loadTranslations('en', { farewell: 'Goodbye' });
|
|
62
|
-
|
|
63
|
-
expect(i18n.getTranslations('en')).toEqual({
|
|
64
|
-
greeting: 'Hello',
|
|
65
|
-
farewell: 'Goodbye',
|
|
66
|
-
});
|
|
67
|
-
});
|
|
68
|
-
|
|
69
|
-
it('should translate a simple key', () => {
|
|
70
|
-
const i18n = new FileI18nAdapter();
|
|
71
|
-
i18n.loadTranslations('en', { greeting: 'Hello' });
|
|
72
|
-
|
|
73
|
-
expect(i18n.t('greeting', 'en')).toBe('Hello');
|
|
74
|
-
});
|
|
75
|
-
|
|
76
|
-
it('should return key when translation is missing', () => {
|
|
77
|
-
const i18n = new FileI18nAdapter();
|
|
78
|
-
expect(i18n.t('missing.key', 'en')).toBe('missing.key');
|
|
79
|
-
});
|
|
80
|
-
|
|
81
|
-
it('should resolve nested dot-notation keys', () => {
|
|
82
|
-
const i18n = new FileI18nAdapter();
|
|
83
|
-
i18n.loadTranslations('en', {
|
|
84
|
-
objects: {
|
|
85
|
-
account: {
|
|
86
|
-
label: 'Account',
|
|
87
|
-
},
|
|
88
|
-
},
|
|
89
|
-
});
|
|
90
|
-
|
|
91
|
-
expect(i18n.t('objects.account.label', 'en')).toBe('Account');
|
|
92
|
-
});
|
|
93
|
-
|
|
94
|
-
it('should interpolate parameters', () => {
|
|
95
|
-
const i18n = new FileI18nAdapter();
|
|
96
|
-
i18n.loadTranslations('en', { greeting: 'Hello, {{name}}!' });
|
|
97
|
-
|
|
98
|
-
expect(i18n.t('greeting', 'en', { name: 'World' })).toBe('Hello, World!');
|
|
99
|
-
});
|
|
100
|
-
|
|
101
|
-
it('should keep placeholder when parameter is missing', () => {
|
|
102
|
-
const i18n = new FileI18nAdapter();
|
|
103
|
-
i18n.loadTranslations('en', { greeting: 'Hello, {{name}}!' });
|
|
104
|
-
|
|
105
|
-
expect(i18n.t('greeting', 'en', {})).toBe('Hello, {{name}}!');
|
|
106
|
-
});
|
|
107
|
-
|
|
108
|
-
it('should fallback to fallback locale when key not found', () => {
|
|
109
|
-
const i18n = new FileI18nAdapter({ fallbackLocale: 'en' });
|
|
110
|
-
i18n.loadTranslations('en', { greeting: 'Hello' });
|
|
111
|
-
|
|
112
|
-
expect(i18n.t('greeting', 'zh-CN')).toBe('Hello');
|
|
113
|
-
});
|
|
114
|
-
|
|
115
|
-
it('should not fallback when key exists in requested locale', () => {
|
|
116
|
-
const i18n = new FileI18nAdapter({ fallbackLocale: 'en' });
|
|
117
|
-
i18n.loadTranslations('en', { greeting: 'Hello' });
|
|
118
|
-
i18n.loadTranslations('zh-CN', { greeting: '你好' });
|
|
119
|
-
|
|
120
|
-
expect(i18n.t('greeting', 'zh-CN')).toBe('你好');
|
|
121
|
-
});
|
|
122
|
-
|
|
123
|
-
it('should return key when neither locale nor fallback has translation', () => {
|
|
124
|
-
const i18n = new FileI18nAdapter({ fallbackLocale: 'en' });
|
|
125
|
-
i18n.loadTranslations('en', { greeting: 'Hello' });
|
|
126
|
-
|
|
127
|
-
expect(i18n.t('missing.key', 'zh-CN')).toBe('missing.key');
|
|
128
|
-
});
|
|
129
|
-
|
|
130
|
-
it('should deep-merge nested objects from multiple plugins', () => {
|
|
131
|
-
const i18n = new FileI18nAdapter();
|
|
132
|
-
|
|
133
|
-
// Plugin 1: CRM objects
|
|
134
|
-
i18n.loadTranslations('en', {
|
|
135
|
-
objects: {
|
|
136
|
-
account: { label: 'Account', fields: { name: { label: 'Account Name' } } },
|
|
137
|
-
contact: { label: 'Contact' },
|
|
138
|
-
},
|
|
139
|
-
apps: { crm: { label: 'CRM' } },
|
|
140
|
-
});
|
|
141
|
-
|
|
142
|
-
// Plugin 2: HR objects
|
|
143
|
-
i18n.loadTranslations('en', {
|
|
144
|
-
objects: {
|
|
145
|
-
department: { label: 'Department', fields: { name: { label: 'Department Name' } } },
|
|
146
|
-
employee: { label: 'Employee' },
|
|
147
|
-
},
|
|
148
|
-
apps: { hr: { label: 'HR' } },
|
|
149
|
-
});
|
|
150
|
-
|
|
151
|
-
const data = i18n.getTranslations('en');
|
|
152
|
-
|
|
153
|
-
// Both plugins' objects must be preserved (not overwritten)
|
|
154
|
-
expect(i18n.t('objects.account.label', 'en')).toBe('Account');
|
|
155
|
-
expect(i18n.t('objects.contact.label', 'en')).toBe('Contact');
|
|
156
|
-
expect(i18n.t('objects.department.label', 'en')).toBe('Department');
|
|
157
|
-
expect(i18n.t('objects.employee.label', 'en')).toBe('Employee');
|
|
158
|
-
expect(i18n.t('objects.account.fields.name.label', 'en')).toBe('Account Name');
|
|
159
|
-
expect(i18n.t('objects.department.fields.name.label', 'en')).toBe('Department Name');
|
|
160
|
-
|
|
161
|
-
// Both plugins' apps must be preserved
|
|
162
|
-
expect((data as any).apps.crm.label).toBe('CRM');
|
|
163
|
-
expect((data as any).apps.hr.label).toBe('HR');
|
|
164
|
-
});
|
|
165
|
-
|
|
166
|
-
describe('file-based loading', () => {
|
|
167
|
-
let tmpDir: string;
|
|
168
|
-
|
|
169
|
-
beforeEach(() => {
|
|
170
|
-
tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'i18n-test-'));
|
|
171
|
-
});
|
|
172
|
-
|
|
173
|
-
afterEach(() => {
|
|
174
|
-
fs.rmSync(tmpDir, { recursive: true, force: true });
|
|
175
|
-
});
|
|
176
|
-
|
|
177
|
-
it('should load translations from JSON files in a directory', () => {
|
|
178
|
-
fs.writeFileSync(
|
|
179
|
-
path.join(tmpDir, 'en.json'),
|
|
180
|
-
JSON.stringify({ greeting: 'Hello', objects: { account: { label: 'Account' } } }),
|
|
181
|
-
);
|
|
182
|
-
fs.writeFileSync(
|
|
183
|
-
path.join(tmpDir, 'zh-CN.json'),
|
|
184
|
-
JSON.stringify({ greeting: '你好', objects: { account: { label: '客户' } } }),
|
|
185
|
-
);
|
|
186
|
-
|
|
187
|
-
const i18n = new FileI18nAdapter({ localesDir: tmpDir });
|
|
188
|
-
|
|
189
|
-
expect(i18n.getLocales()).toContain('en');
|
|
190
|
-
expect(i18n.getLocales()).toContain('zh-CN');
|
|
191
|
-
expect(i18n.t('greeting', 'en')).toBe('Hello');
|
|
192
|
-
expect(i18n.t('greeting', 'zh-CN')).toBe('你好');
|
|
193
|
-
expect(i18n.t('objects.account.label', 'en')).toBe('Account');
|
|
194
|
-
expect(i18n.t('objects.account.label', 'zh-CN')).toBe('客户');
|
|
195
|
-
});
|
|
196
|
-
|
|
197
|
-
it('should ignore non-JSON files in the directory', () => {
|
|
198
|
-
fs.writeFileSync(path.join(tmpDir, 'en.json'), JSON.stringify({ greeting: 'Hello' }));
|
|
199
|
-
fs.writeFileSync(path.join(tmpDir, 'notes.txt'), 'not a translation file');
|
|
200
|
-
|
|
201
|
-
const i18n = new FileI18nAdapter({ localesDir: tmpDir });
|
|
202
|
-
|
|
203
|
-
expect(i18n.getLocales()).toEqual(['en']);
|
|
204
|
-
});
|
|
205
|
-
|
|
206
|
-
it('should skip malformed JSON files gracefully', () => {
|
|
207
|
-
fs.writeFileSync(path.join(tmpDir, 'en.json'), JSON.stringify({ greeting: 'Hello' }));
|
|
208
|
-
fs.writeFileSync(path.join(tmpDir, 'bad.json'), '{invalid json');
|
|
209
|
-
|
|
210
|
-
const i18n = new FileI18nAdapter({ localesDir: tmpDir });
|
|
211
|
-
|
|
212
|
-
expect(i18n.getLocales()).toEqual(['en']);
|
|
213
|
-
expect(i18n.t('greeting', 'en')).toBe('Hello');
|
|
214
|
-
});
|
|
215
|
-
|
|
216
|
-
it('should handle non-existent directory gracefully', () => {
|
|
217
|
-
const i18n = new FileI18nAdapter({ localesDir: '/nonexistent/path' });
|
|
218
|
-
expect(i18n.getLocales()).toEqual([]);
|
|
219
|
-
});
|
|
220
|
-
});
|
|
221
|
-
});
|
package/src/file-i18n-adapter.ts
DELETED
|
@@ -1,193 +0,0 @@
|
|
|
1
|
-
// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.
|
|
2
|
-
|
|
3
|
-
import type { II18nService } from '@objectstack/spec/contracts';
|
|
4
|
-
import * as fs from 'node:fs';
|
|
5
|
-
import * as path from 'node:path';
|
|
6
|
-
|
|
7
|
-
/**
|
|
8
|
-
* Configuration options for FileI18nAdapter.
|
|
9
|
-
*/
|
|
10
|
-
export interface FileI18nAdapterOptions {
|
|
11
|
-
/** Default locale (e.g. 'en') */
|
|
12
|
-
defaultLocale?: string;
|
|
13
|
-
/** Directory containing locale files (JSON). Each file should be named `{locale}.json`. */
|
|
14
|
-
localesDir?: string;
|
|
15
|
-
/** Fallback locale when a key is not found in the requested locale */
|
|
16
|
-
fallbackLocale?: string;
|
|
17
|
-
}
|
|
18
|
-
|
|
19
|
-
/**
|
|
20
|
-
* Resolve a nested key in a translations object using dot notation.
|
|
21
|
-
*
|
|
22
|
-
* @param data - Translation data object
|
|
23
|
-
* @param key - Dot-separated key (e.g. 'objects.account.label')
|
|
24
|
-
* @returns The resolved string value, or undefined if not found
|
|
25
|
-
*/
|
|
26
|
-
function resolveKey(data: Record<string, unknown>, key: string): string | undefined {
|
|
27
|
-
const parts = key.split('.');
|
|
28
|
-
let current: unknown = data;
|
|
29
|
-
for (const part of parts) {
|
|
30
|
-
if (current == null || typeof current !== 'object') return undefined;
|
|
31
|
-
current = (current as Record<string, unknown>)[part];
|
|
32
|
-
}
|
|
33
|
-
return typeof current === 'string' ? current : undefined;
|
|
34
|
-
}
|
|
35
|
-
|
|
36
|
-
/**
|
|
37
|
-
* Deep-merge two plain objects recursively.
|
|
38
|
-
* Arrays and non-plain-object values from `source` overwrite those in `target`.
|
|
39
|
-
*/
|
|
40
|
-
function deepMerge(
|
|
41
|
-
target: Record<string, unknown>,
|
|
42
|
-
source: Record<string, unknown>,
|
|
43
|
-
): Record<string, unknown> {
|
|
44
|
-
const result: Record<string, unknown> = { ...target };
|
|
45
|
-
for (const key of Object.keys(source)) {
|
|
46
|
-
const tVal = target[key];
|
|
47
|
-
const sVal = source[key];
|
|
48
|
-
if (
|
|
49
|
-
tVal && sVal
|
|
50
|
-
&& typeof tVal === 'object' && !Array.isArray(tVal)
|
|
51
|
-
&& typeof sVal === 'object' && !Array.isArray(sVal)
|
|
52
|
-
) {
|
|
53
|
-
result[key] = deepMerge(
|
|
54
|
-
tVal as Record<string, unknown>,
|
|
55
|
-
sVal as Record<string, unknown>,
|
|
56
|
-
);
|
|
57
|
-
} else {
|
|
58
|
-
result[key] = sVal;
|
|
59
|
-
}
|
|
60
|
-
}
|
|
61
|
-
return result;
|
|
62
|
-
}
|
|
63
|
-
|
|
64
|
-
/**
|
|
65
|
-
* Interpolate parameters into a translated string.
|
|
66
|
-
* Replaces `{{paramName}}` with the corresponding value from params.
|
|
67
|
-
*
|
|
68
|
-
* @param template - Template string with `{{key}}` placeholders
|
|
69
|
-
* @param params - Parameter map
|
|
70
|
-
* @returns Interpolated string
|
|
71
|
-
*/
|
|
72
|
-
function interpolate(template: string, params: Record<string, unknown>): string {
|
|
73
|
-
return template.replace(/\{\{(\w+)\}\}/g, (_match, key: string) => {
|
|
74
|
-
return params[key] != null ? String(params[key]) : `{{${key}}}`;
|
|
75
|
-
});
|
|
76
|
-
}
|
|
77
|
-
|
|
78
|
-
/**
|
|
79
|
-
* File-based I18n adapter implementing II18nService.
|
|
80
|
-
*
|
|
81
|
-
* Loads JSON translation files from a directory on disk.
|
|
82
|
-
* Each file should be named `{locale}.json` and contain a flat or nested
|
|
83
|
-
* key-value map of translations.
|
|
84
|
-
*
|
|
85
|
-
* Supports:
|
|
86
|
-
* - Dot-notation key resolution (e.g. 'objects.account.label')
|
|
87
|
-
* - Parameter interpolation via `{{paramName}}` syntax
|
|
88
|
-
* - Fallback locale for missing translations
|
|
89
|
-
* - Runtime translation loading via loadTranslations()
|
|
90
|
-
*
|
|
91
|
-
* Suitable for server-side rendering, CLI tools, and development environments.
|
|
92
|
-
*
|
|
93
|
-
* @example
|
|
94
|
-
* ```ts
|
|
95
|
-
* const i18n = new FileI18nAdapter({
|
|
96
|
-
* defaultLocale: 'en',
|
|
97
|
-
* localesDir: './i18n',
|
|
98
|
-
* fallbackLocale: 'en',
|
|
99
|
-
* });
|
|
100
|
-
*
|
|
101
|
-
* i18n.t('objects.account.label', 'zh-CN'); // '客户'
|
|
102
|
-
* i18n.t('greeting', 'en', { name: 'World' }); // 'Hello, World!'
|
|
103
|
-
* ```
|
|
104
|
-
*/
|
|
105
|
-
export class FileI18nAdapter implements II18nService {
|
|
106
|
-
private readonly translations = new Map<string, Record<string, unknown>>();
|
|
107
|
-
private defaultLocale: string;
|
|
108
|
-
private readonly fallbackLocale: string | undefined;
|
|
109
|
-
|
|
110
|
-
constructor(options: FileI18nAdapterOptions = {}) {
|
|
111
|
-
this.defaultLocale = options.defaultLocale ?? 'en';
|
|
112
|
-
this.fallbackLocale = options.fallbackLocale;
|
|
113
|
-
|
|
114
|
-
if (options.localesDir) {
|
|
115
|
-
this.loadFromDirectory(options.localesDir);
|
|
116
|
-
}
|
|
117
|
-
}
|
|
118
|
-
|
|
119
|
-
t(key: string, locale: string, params?: Record<string, unknown>): string {
|
|
120
|
-
// Try requested locale
|
|
121
|
-
let value = this.resolveFromLocale(key, locale);
|
|
122
|
-
|
|
123
|
-
// Try fallback locale
|
|
124
|
-
if (value === undefined && this.fallbackLocale && this.fallbackLocale !== locale) {
|
|
125
|
-
value = this.resolveFromLocale(key, this.fallbackLocale);
|
|
126
|
-
}
|
|
127
|
-
|
|
128
|
-
// Return key if not found
|
|
129
|
-
if (value === undefined) return key;
|
|
130
|
-
|
|
131
|
-
// Interpolate parameters
|
|
132
|
-
if (params && Object.keys(params).length > 0) {
|
|
133
|
-
return interpolate(value, params);
|
|
134
|
-
}
|
|
135
|
-
|
|
136
|
-
return value;
|
|
137
|
-
}
|
|
138
|
-
|
|
139
|
-
getTranslations(locale: string): Record<string, unknown> {
|
|
140
|
-
return this.translations.get(locale) ?? {};
|
|
141
|
-
}
|
|
142
|
-
|
|
143
|
-
loadTranslations(locale: string, translations: Record<string, unknown>): void {
|
|
144
|
-
const existing = this.translations.get(locale);
|
|
145
|
-
if (existing) {
|
|
146
|
-
// Deep-merge so multiple plugins can contribute to the same nested keys
|
|
147
|
-
// (e.g. each plugin adds its own objects under `objects.*`)
|
|
148
|
-
this.translations.set(locale, deepMerge(existing, translations));
|
|
149
|
-
} else {
|
|
150
|
-
this.translations.set(locale, { ...translations });
|
|
151
|
-
}
|
|
152
|
-
}
|
|
153
|
-
|
|
154
|
-
getLocales(): string[] {
|
|
155
|
-
return Array.from(this.translations.keys());
|
|
156
|
-
}
|
|
157
|
-
|
|
158
|
-
getDefaultLocale(): string {
|
|
159
|
-
return this.defaultLocale;
|
|
160
|
-
}
|
|
161
|
-
|
|
162
|
-
setDefaultLocale(locale: string): void {
|
|
163
|
-
this.defaultLocale = locale;
|
|
164
|
-
}
|
|
165
|
-
|
|
166
|
-
/**
|
|
167
|
-
* Load all JSON translation files from a directory.
|
|
168
|
-
* Each file should be named `{locale}.json`.
|
|
169
|
-
*/
|
|
170
|
-
private loadFromDirectory(dir: string): void {
|
|
171
|
-
if (!fs.existsSync(dir)) return;
|
|
172
|
-
|
|
173
|
-
const files = fs.readdirSync(dir);
|
|
174
|
-
for (const file of files) {
|
|
175
|
-
if (!file.endsWith('.json')) continue;
|
|
176
|
-
const locale = file.replace(/\.json$/, '');
|
|
177
|
-
const filePath = path.join(dir, file);
|
|
178
|
-
try {
|
|
179
|
-
const content = fs.readFileSync(filePath, 'utf-8');
|
|
180
|
-
const data = JSON.parse(content) as Record<string, unknown>;
|
|
181
|
-
this.translations.set(locale, data);
|
|
182
|
-
} catch {
|
|
183
|
-
// Skip files that can't be parsed
|
|
184
|
-
}
|
|
185
|
-
}
|
|
186
|
-
}
|
|
187
|
-
|
|
188
|
-
private resolveFromLocale(key: string, locale: string): string | undefined {
|
|
189
|
-
const data = this.translations.get(locale);
|
|
190
|
-
if (!data) return undefined;
|
|
191
|
-
return resolveKey(data, key);
|
|
192
|
-
}
|
|
193
|
-
}
|
|
@@ -1,280 +0,0 @@
|
|
|
1
|
-
// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.
|
|
2
|
-
|
|
3
|
-
import { describe, it, expect, vi, beforeEach } from 'vitest';
|
|
4
|
-
import { I18nServicePlugin } from './i18n-service-plugin';
|
|
5
|
-
import type { IHttpRequest, IHttpResponse, RouteHandler } from '@objectstack/spec/contracts';
|
|
6
|
-
|
|
7
|
-
// ---------------------------------------------------------------------------
|
|
8
|
-
// Mocks
|
|
9
|
-
// ---------------------------------------------------------------------------
|
|
10
|
-
|
|
11
|
-
function createMockHttpServer() {
|
|
12
|
-
const routes = new Map<string, RouteHandler>();
|
|
13
|
-
return {
|
|
14
|
-
get: vi.fn((path: string, handler: RouteHandler) => { routes.set(`GET:${path}`, handler); }),
|
|
15
|
-
post: vi.fn(),
|
|
16
|
-
put: vi.fn(),
|
|
17
|
-
delete: vi.fn(),
|
|
18
|
-
patch: vi.fn(),
|
|
19
|
-
use: vi.fn(),
|
|
20
|
-
listen: vi.fn().mockResolvedValue(undefined),
|
|
21
|
-
close: vi.fn().mockResolvedValue(undefined),
|
|
22
|
-
/** Test helper: retrieve a registered handler */
|
|
23
|
-
_getHandler(method: string, path: string): RouteHandler | undefined {
|
|
24
|
-
return routes.get(`${method}:${path}`);
|
|
25
|
-
},
|
|
26
|
-
};
|
|
27
|
-
}
|
|
28
|
-
|
|
29
|
-
function createMockPluginContext(services: Record<string, any> = {}) {
|
|
30
|
-
const hooks = new Map<string, Array<(...args: any[]) => Promise<void>>>();
|
|
31
|
-
return {
|
|
32
|
-
registerService: vi.fn(),
|
|
33
|
-
getService: vi.fn((name: string) => {
|
|
34
|
-
if (services[name]) return services[name];
|
|
35
|
-
throw new Error(`Service '${name}' not found`);
|
|
36
|
-
}),
|
|
37
|
-
getServices: vi.fn(() => new Map(Object.entries(services))),
|
|
38
|
-
hook: vi.fn((name: string, handler: (...args: any[]) => Promise<void>) => {
|
|
39
|
-
if (!hooks.has(name)) hooks.set(name, []);
|
|
40
|
-
hooks.get(name)!.push(handler);
|
|
41
|
-
}),
|
|
42
|
-
trigger: vi.fn(async (name: string, ...args: any[]) => {
|
|
43
|
-
const handlers = hooks.get(name) ?? [];
|
|
44
|
-
for (const h of handlers) await h(...args);
|
|
45
|
-
}),
|
|
46
|
-
logger: {
|
|
47
|
-
info: vi.fn(),
|
|
48
|
-
warn: vi.fn(),
|
|
49
|
-
error: vi.fn(),
|
|
50
|
-
debug: vi.fn(),
|
|
51
|
-
},
|
|
52
|
-
getKernel: vi.fn(),
|
|
53
|
-
replaceService: vi.fn(),
|
|
54
|
-
};
|
|
55
|
-
}
|
|
56
|
-
|
|
57
|
-
function createMockReq(overrides: Partial<IHttpRequest> = {}): IHttpRequest {
|
|
58
|
-
return {
|
|
59
|
-
params: {},
|
|
60
|
-
query: {},
|
|
61
|
-
headers: {},
|
|
62
|
-
method: 'GET',
|
|
63
|
-
path: '/',
|
|
64
|
-
...overrides,
|
|
65
|
-
};
|
|
66
|
-
}
|
|
67
|
-
|
|
68
|
-
function createMockRes(): IHttpResponse & { _data: any; _status: number } {
|
|
69
|
-
const res: any = {
|
|
70
|
-
_data: null,
|
|
71
|
-
_status: 200,
|
|
72
|
-
json(data: any) { res._data = data; },
|
|
73
|
-
send(data: string) { res._data = data; },
|
|
74
|
-
status(code: number) { res._status = code; return res; },
|
|
75
|
-
header() { return res; },
|
|
76
|
-
};
|
|
77
|
-
return res;
|
|
78
|
-
}
|
|
79
|
-
|
|
80
|
-
// ---------------------------------------------------------------------------
|
|
81
|
-
// Tests
|
|
82
|
-
// ---------------------------------------------------------------------------
|
|
83
|
-
|
|
84
|
-
describe('I18nServicePlugin', () => {
|
|
85
|
-
let httpServer: ReturnType<typeof createMockHttpServer>;
|
|
86
|
-
let ctx: ReturnType<typeof createMockPluginContext>;
|
|
87
|
-
|
|
88
|
-
beforeEach(() => {
|
|
89
|
-
httpServer = createMockHttpServer();
|
|
90
|
-
ctx = createMockPluginContext({ 'http-server': httpServer });
|
|
91
|
-
});
|
|
92
|
-
|
|
93
|
-
// -- Service registration -------------------------------------------------
|
|
94
|
-
|
|
95
|
-
describe('init', () => {
|
|
96
|
-
it('should register i18n service during init', async () => {
|
|
97
|
-
const plugin = new I18nServicePlugin();
|
|
98
|
-
await plugin.init!(ctx as any);
|
|
99
|
-
|
|
100
|
-
expect(ctx.registerService).toHaveBeenCalledWith('i18n', expect.any(Object));
|
|
101
|
-
});
|
|
102
|
-
|
|
103
|
-
it('should pass options to the FileI18nAdapter', async () => {
|
|
104
|
-
const plugin = new I18nServicePlugin({ defaultLocale: 'zh-CN' });
|
|
105
|
-
await plugin.init!(ctx as any);
|
|
106
|
-
|
|
107
|
-
const registeredService = ctx.registerService.mock.calls[0][1];
|
|
108
|
-
expect(registeredService.getDefaultLocale()).toBe('zh-CN');
|
|
109
|
-
});
|
|
110
|
-
});
|
|
111
|
-
|
|
112
|
-
// -- Route self-registration ----------------------------------------------
|
|
113
|
-
|
|
114
|
-
describe('route self-registration', () => {
|
|
115
|
-
it('should register a kernel:ready hook during start', async () => {
|
|
116
|
-
const plugin = new I18nServicePlugin();
|
|
117
|
-
await plugin.init!(ctx as any);
|
|
118
|
-
await plugin.start!(ctx as any);
|
|
119
|
-
|
|
120
|
-
expect(ctx.hook).toHaveBeenCalledWith('kernel:ready', expect.any(Function));
|
|
121
|
-
});
|
|
122
|
-
|
|
123
|
-
it('should register i18n routes when http-server is available', async () => {
|
|
124
|
-
const plugin = new I18nServicePlugin();
|
|
125
|
-
await plugin.init!(ctx as any);
|
|
126
|
-
await plugin.start!(ctx as any);
|
|
127
|
-
|
|
128
|
-
// Simulate kernel:ready
|
|
129
|
-
await ctx.trigger('kernel:ready');
|
|
130
|
-
|
|
131
|
-
expect(httpServer.get).toHaveBeenCalledWith('/api/v1/i18n/locales', expect.any(Function));
|
|
132
|
-
expect(httpServer.get).toHaveBeenCalledWith('/api/v1/i18n/translations/:locale', expect.any(Function));
|
|
133
|
-
expect(httpServer.get).toHaveBeenCalledWith('/api/v1/i18n/labels/:object/:locale', expect.any(Function));
|
|
134
|
-
});
|
|
135
|
-
|
|
136
|
-
it('should respect custom basePath', async () => {
|
|
137
|
-
const plugin = new I18nServicePlugin({ basePath: '/custom/i18n' });
|
|
138
|
-
await plugin.init!(ctx as any);
|
|
139
|
-
await plugin.start!(ctx as any);
|
|
140
|
-
|
|
141
|
-
await ctx.trigger('kernel:ready');
|
|
142
|
-
|
|
143
|
-
expect(httpServer.get).toHaveBeenCalledWith('/custom/i18n/locales', expect.any(Function));
|
|
144
|
-
expect(httpServer.get).toHaveBeenCalledWith('/custom/i18n/translations/:locale', expect.any(Function));
|
|
145
|
-
expect(httpServer.get).toHaveBeenCalledWith('/custom/i18n/labels/:object/:locale', expect.any(Function));
|
|
146
|
-
});
|
|
147
|
-
|
|
148
|
-
it('should skip route registration when registerRoutes is false', async () => {
|
|
149
|
-
const plugin = new I18nServicePlugin({ registerRoutes: false });
|
|
150
|
-
await plugin.init!(ctx as any);
|
|
151
|
-
await plugin.start!(ctx as any);
|
|
152
|
-
|
|
153
|
-
expect(ctx.hook).not.toHaveBeenCalled();
|
|
154
|
-
});
|
|
155
|
-
|
|
156
|
-
it('should gracefully skip routes when http-server is not available', async () => {
|
|
157
|
-
const ctxNoHttp = createMockPluginContext({}); // no http-server
|
|
158
|
-
const plugin = new I18nServicePlugin();
|
|
159
|
-
await plugin.init!(ctxNoHttp as any);
|
|
160
|
-
await plugin.start!(ctxNoHttp as any);
|
|
161
|
-
|
|
162
|
-
await ctxNoHttp.trigger('kernel:ready');
|
|
163
|
-
|
|
164
|
-
expect(ctxNoHttp.logger.warn).toHaveBeenCalledWith(
|
|
165
|
-
expect.stringContaining('No HTTP server available'),
|
|
166
|
-
);
|
|
167
|
-
});
|
|
168
|
-
});
|
|
169
|
-
|
|
170
|
-
// -- Route handler behavior -----------------------------------------------
|
|
171
|
-
|
|
172
|
-
describe('route handlers', () => {
|
|
173
|
-
async function setupPlugin(options: ConstructorParameters<typeof I18nServicePlugin>[0] = {}) {
|
|
174
|
-
const plugin = new I18nServicePlugin(options);
|
|
175
|
-
await plugin.init!(ctx as any);
|
|
176
|
-
// Load some translations after init so the service has data
|
|
177
|
-
const i18n = ctx.registerService.mock.calls[0][1];
|
|
178
|
-
i18n.loadTranslations('en', { greeting: 'Hello', 'o.account.fields.name': 'Account Name' });
|
|
179
|
-
i18n.loadTranslations('zh-CN', { greeting: '你好', 'o.account.fields.name': '账户名称' });
|
|
180
|
-
await plugin.start!(ctx as any);
|
|
181
|
-
await ctx.trigger('kernel:ready');
|
|
182
|
-
return { plugin, i18n };
|
|
183
|
-
}
|
|
184
|
-
|
|
185
|
-
it('GET /locales should return all available locales', async () => {
|
|
186
|
-
await setupPlugin();
|
|
187
|
-
|
|
188
|
-
const handler = httpServer._getHandler('GET', '/api/v1/i18n/locales')!;
|
|
189
|
-
expect(handler).toBeDefined();
|
|
190
|
-
|
|
191
|
-
const req = createMockReq();
|
|
192
|
-
const res = createMockRes();
|
|
193
|
-
await handler(req, res);
|
|
194
|
-
|
|
195
|
-
expect(res._data).toEqual({
|
|
196
|
-
data: {
|
|
197
|
-
locales: [
|
|
198
|
-
{ code: 'en', label: 'en', isDefault: true },
|
|
199
|
-
{ code: 'zh-CN', label: 'zh-CN', isDefault: false },
|
|
200
|
-
],
|
|
201
|
-
},
|
|
202
|
-
});
|
|
203
|
-
});
|
|
204
|
-
|
|
205
|
-
it('GET /translations/:locale should return translations for the given locale', async () => {
|
|
206
|
-
await setupPlugin();
|
|
207
|
-
|
|
208
|
-
const handler = httpServer._getHandler('GET', '/api/v1/i18n/translations/:locale')!;
|
|
209
|
-
expect(handler).toBeDefined();
|
|
210
|
-
|
|
211
|
-
const req = createMockReq({ params: { locale: 'en' } });
|
|
212
|
-
const res = createMockRes();
|
|
213
|
-
await handler(req, res);
|
|
214
|
-
|
|
215
|
-
expect(res._data).toEqual({
|
|
216
|
-
data: {
|
|
217
|
-
locale: 'en',
|
|
218
|
-
translations: { greeting: 'Hello', 'o.account.fields.name': 'Account Name' },
|
|
219
|
-
},
|
|
220
|
-
});
|
|
221
|
-
});
|
|
222
|
-
|
|
223
|
-
it('GET /translations/:locale should return 400 when locale is missing', async () => {
|
|
224
|
-
await setupPlugin();
|
|
225
|
-
|
|
226
|
-
const handler = httpServer._getHandler('GET', '/api/v1/i18n/translations/:locale')!;
|
|
227
|
-
const req = createMockReq({ params: {} });
|
|
228
|
-
const res = createMockRes();
|
|
229
|
-
await handler(req, res);
|
|
230
|
-
|
|
231
|
-
expect(res._status).toBe(400);
|
|
232
|
-
expect(res._data).toEqual({ error: 'Missing locale parameter' });
|
|
233
|
-
});
|
|
234
|
-
|
|
235
|
-
it('GET /labels/:object/:locale should derive field labels from translation bundle', async () => {
|
|
236
|
-
await setupPlugin();
|
|
237
|
-
|
|
238
|
-
const handler = httpServer._getHandler('GET', '/api/v1/i18n/labels/:object/:locale')!;
|
|
239
|
-
expect(handler).toBeDefined();
|
|
240
|
-
|
|
241
|
-
const req = createMockReq({ params: { object: 'account', locale: 'en' } });
|
|
242
|
-
const res = createMockRes();
|
|
243
|
-
await handler(req, res);
|
|
244
|
-
|
|
245
|
-
expect(res._data).toEqual({
|
|
246
|
-
data: {
|
|
247
|
-
object: 'account',
|
|
248
|
-
locale: 'en',
|
|
249
|
-
labels: { name: 'Account Name' },
|
|
250
|
-
},
|
|
251
|
-
});
|
|
252
|
-
});
|
|
253
|
-
|
|
254
|
-
it('GET /labels/:object/:locale should return 400 when params are missing', async () => {
|
|
255
|
-
await setupPlugin();
|
|
256
|
-
|
|
257
|
-
const handler = httpServer._getHandler('GET', '/api/v1/i18n/labels/:object/:locale')!;
|
|
258
|
-
const req = createMockReq({ params: {} });
|
|
259
|
-
const res = createMockRes();
|
|
260
|
-
await handler(req, res);
|
|
261
|
-
|
|
262
|
-
expect(res._status).toBe(400);
|
|
263
|
-
expect(res._data).toEqual({ error: 'Missing object or locale parameter' });
|
|
264
|
-
});
|
|
265
|
-
});
|
|
266
|
-
|
|
267
|
-
// -- Plugin metadata -------------------------------------------------------
|
|
268
|
-
|
|
269
|
-
describe('plugin metadata', () => {
|
|
270
|
-
it('should have correct plugin name', () => {
|
|
271
|
-
const plugin = new I18nServicePlugin();
|
|
272
|
-
expect(plugin.name).toBe('com.objectstack.service.i18n');
|
|
273
|
-
});
|
|
274
|
-
|
|
275
|
-
it('should have version', () => {
|
|
276
|
-
const plugin = new I18nServicePlugin();
|
|
277
|
-
expect(plugin.version).toBe('1.0.0');
|
|
278
|
-
});
|
|
279
|
-
});
|
|
280
|
-
});
|
|
@@ -1,198 +0,0 @@
|
|
|
1
|
-
// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.
|
|
2
|
-
|
|
3
|
-
import type { Plugin, PluginContext } from '@objectstack/core';
|
|
4
|
-
import type { IHttpServer, IHttpRequest, IHttpResponse } from '@objectstack/spec/contracts';
|
|
5
|
-
import type { II18nService } from '@objectstack/spec/contracts';
|
|
6
|
-
import { FileI18nAdapter } from './file-i18n-adapter.js';
|
|
7
|
-
import type { FileI18nAdapterOptions } from './file-i18n-adapter.js';
|
|
8
|
-
|
|
9
|
-
/**
|
|
10
|
-
* Configuration options for the I18nServicePlugin.
|
|
11
|
-
*/
|
|
12
|
-
export interface I18nServicePluginOptions {
|
|
13
|
-
/** Default locale (default: 'en') */
|
|
14
|
-
defaultLocale?: string;
|
|
15
|
-
/** Directory containing locale JSON files */
|
|
16
|
-
localesDir?: string;
|
|
17
|
-
/** Fallback locale for missing translations */
|
|
18
|
-
fallbackLocale?: string;
|
|
19
|
-
/**
|
|
20
|
-
* Whether to automatically register i18n REST routes with the HTTP server.
|
|
21
|
-
* When true (default), the plugin registers `/api/v1/i18n/*` endpoints
|
|
22
|
-
* via the `kernel:ready` hook. When false or no HTTP server is available,
|
|
23
|
-
* routes are skipped but the i18n service is still available via the kernel.
|
|
24
|
-
* @default true
|
|
25
|
-
*/
|
|
26
|
-
registerRoutes?: boolean;
|
|
27
|
-
/**
|
|
28
|
-
* Base path for i18n REST routes.
|
|
29
|
-
* @default '/api/v1/i18n'
|
|
30
|
-
*/
|
|
31
|
-
basePath?: string;
|
|
32
|
-
}
|
|
33
|
-
|
|
34
|
-
/**
|
|
35
|
-
* I18nServicePlugin — Production II18nService implementation.
|
|
36
|
-
*
|
|
37
|
-
* Registers an i18n service with the kernel during the init phase,
|
|
38
|
-
* and self-registers REST endpoints (`/api/v1/i18n/*`) with the HTTP
|
|
39
|
-
* server during the `kernel:ready` hook.
|
|
40
|
-
*
|
|
41
|
-
* REST route self-registration follows the same autonomous plugin pattern
|
|
42
|
-
* used by AuthPlugin, WorkflowPlugin, and other service plugins — RestServer
|
|
43
|
-
* is not involved.
|
|
44
|
-
*
|
|
45
|
-
* @example
|
|
46
|
-
* ```ts
|
|
47
|
-
* import { ObjectKernel } from '@objectstack/core';
|
|
48
|
-
* import { I18nServicePlugin } from '@objectstack/service-i18n';
|
|
49
|
-
*
|
|
50
|
-
* const kernel = new ObjectKernel();
|
|
51
|
-
* kernel.use(new I18nServicePlugin({
|
|
52
|
-
* defaultLocale: 'en',
|
|
53
|
-
* localesDir: './i18n',
|
|
54
|
-
* fallbackLocale: 'en',
|
|
55
|
-
* }));
|
|
56
|
-
* await kernel.bootstrap();
|
|
57
|
-
*
|
|
58
|
-
* const i18n = kernel.getService('i18n');
|
|
59
|
-
* i18n.t('objects.account.label', 'en'); // 'Account'
|
|
60
|
-
* ```
|
|
61
|
-
*/
|
|
62
|
-
export class I18nServicePlugin implements Plugin {
|
|
63
|
-
name = 'com.objectstack.service.i18n';
|
|
64
|
-
version = '1.0.0';
|
|
65
|
-
type = 'standard';
|
|
66
|
-
|
|
67
|
-
private readonly options: I18nServicePluginOptions;
|
|
68
|
-
private i18n: II18nService | null = null;
|
|
69
|
-
|
|
70
|
-
constructor(options: I18nServicePluginOptions = {}) {
|
|
71
|
-
this.options = options;
|
|
72
|
-
}
|
|
73
|
-
|
|
74
|
-
async init(ctx: PluginContext): Promise<void> {
|
|
75
|
-
const adapterOptions: FileI18nAdapterOptions = {
|
|
76
|
-
defaultLocale: this.options.defaultLocale,
|
|
77
|
-
localesDir: this.options.localesDir,
|
|
78
|
-
fallbackLocale: this.options.fallbackLocale,
|
|
79
|
-
};
|
|
80
|
-
|
|
81
|
-
this.i18n = new FileI18nAdapter(adapterOptions);
|
|
82
|
-
ctx.registerService('i18n', this.i18n);
|
|
83
|
-
ctx.logger.info(
|
|
84
|
-
`I18nServicePlugin: registered file-based i18n adapter (default: ${this.i18n.getDefaultLocale?.() ?? 'en'})`,
|
|
85
|
-
);
|
|
86
|
-
}
|
|
87
|
-
|
|
88
|
-
async start(ctx: PluginContext): Promise<void> {
|
|
89
|
-
// Defer HTTP route registration to kernel:ready hook.
|
|
90
|
-
// This ensures all plugins (including HonoServerPlugin) have completed
|
|
91
|
-
// their init and start phases before we attempt to look up the
|
|
92
|
-
// http-server service — making I18nServicePlugin resilient to plugin
|
|
93
|
-
// loading order.
|
|
94
|
-
if (this.options.registerRoutes !== false) {
|
|
95
|
-
ctx.hook('kernel:ready', async () => {
|
|
96
|
-
let httpServer: IHttpServer | null = null;
|
|
97
|
-
try {
|
|
98
|
-
httpServer = ctx.getService<IHttpServer>('http-server');
|
|
99
|
-
} catch {
|
|
100
|
-
// Service not found — expected in MSW/mock mode
|
|
101
|
-
}
|
|
102
|
-
|
|
103
|
-
if (httpServer) {
|
|
104
|
-
this.registerI18nRoutes(httpServer, ctx);
|
|
105
|
-
} else {
|
|
106
|
-
ctx.logger.warn(
|
|
107
|
-
'No HTTP server available — i18n routes not registered. ' +
|
|
108
|
-
'i18n service is still available programmatically via kernel.getService("i18n").'
|
|
109
|
-
);
|
|
110
|
-
}
|
|
111
|
-
});
|
|
112
|
-
}
|
|
113
|
-
}
|
|
114
|
-
|
|
115
|
-
/**
|
|
116
|
-
* Register i18n REST routes with the HTTP server.
|
|
117
|
-
*
|
|
118
|
-
* Routes:
|
|
119
|
-
* - GET /api/v1/i18n/locales → list available locales
|
|
120
|
-
* - GET /api/v1/i18n/translations/:locale → get translations for a locale
|
|
121
|
-
* - GET /api/v1/i18n/labels/:object/:locale → get field labels for an object
|
|
122
|
-
*/
|
|
123
|
-
private registerI18nRoutes(httpServer: IHttpServer, ctx: PluginContext): void {
|
|
124
|
-
if (!this.i18n) return;
|
|
125
|
-
|
|
126
|
-
const basePath = this.options.basePath || '/api/v1/i18n';
|
|
127
|
-
const i18n = this.i18n;
|
|
128
|
-
|
|
129
|
-
// GET /i18n/locales
|
|
130
|
-
httpServer.get(`${basePath}/locales`, async (_req: IHttpRequest, res: IHttpResponse) => {
|
|
131
|
-
try {
|
|
132
|
-
const locales = i18n.getLocales();
|
|
133
|
-
const defaultLocale = i18n.getDefaultLocale?.() ?? 'en';
|
|
134
|
-
res.json({
|
|
135
|
-
data: {
|
|
136
|
-
locales: locales.map((code) => ({
|
|
137
|
-
code,
|
|
138
|
-
label: code,
|
|
139
|
-
isDefault: code === defaultLocale,
|
|
140
|
-
})),
|
|
141
|
-
},
|
|
142
|
-
});
|
|
143
|
-
} catch (error: any) {
|
|
144
|
-
res.status(500).json({ error: error.message });
|
|
145
|
-
}
|
|
146
|
-
});
|
|
147
|
-
|
|
148
|
-
// GET /i18n/translations/:locale
|
|
149
|
-
httpServer.get(`${basePath}/translations/:locale`, async (req: IHttpRequest, res: IHttpResponse) => {
|
|
150
|
-
try {
|
|
151
|
-
const locale = req.params.locale;
|
|
152
|
-
if (!locale) {
|
|
153
|
-
res.status(400).json({ error: 'Missing locale parameter' });
|
|
154
|
-
return;
|
|
155
|
-
}
|
|
156
|
-
const translations = i18n.getTranslations(locale);
|
|
157
|
-
res.json({ data: { locale, translations } });
|
|
158
|
-
} catch (error: any) {
|
|
159
|
-
res.status(500).json({ error: error.message });
|
|
160
|
-
}
|
|
161
|
-
});
|
|
162
|
-
|
|
163
|
-
// GET /i18n/labels/:object/:locale
|
|
164
|
-
httpServer.get(`${basePath}/labels/:object/:locale`, async (req: IHttpRequest, res: IHttpResponse) => {
|
|
165
|
-
try {
|
|
166
|
-
const objectName = req.params.object;
|
|
167
|
-
const locale = req.params.locale;
|
|
168
|
-
if (!objectName || !locale) {
|
|
169
|
-
res.status(400).json({ error: 'Missing object or locale parameter' });
|
|
170
|
-
return;
|
|
171
|
-
}
|
|
172
|
-
// Some implementations may provide a dedicated getFieldLabels method
|
|
173
|
-
const hasGetFieldLabels = 'getFieldLabels' in i18n
|
|
174
|
-
&& typeof (i18n as Record<string, unknown>)['getFieldLabels'] === 'function';
|
|
175
|
-
if (hasGetFieldLabels) {
|
|
176
|
-
const labels = (i18n as II18nService & { getFieldLabels(obj: string, loc: string): Record<string, string> })
|
|
177
|
-
.getFieldLabels(objectName, locale);
|
|
178
|
-
res.json({ data: { object: objectName, locale, labels } });
|
|
179
|
-
} else {
|
|
180
|
-
// Fallback: derive field labels from full translation bundle
|
|
181
|
-
const translations = i18n.getTranslations(locale);
|
|
182
|
-
const prefix = `o.${objectName}.fields.`;
|
|
183
|
-
const labels: Record<string, string> = {};
|
|
184
|
-
for (const [key, value] of Object.entries(translations)) {
|
|
185
|
-
if (key.startsWith(prefix)) {
|
|
186
|
-
labels[key.substring(prefix.length)] = value as string;
|
|
187
|
-
}
|
|
188
|
-
}
|
|
189
|
-
res.json({ data: { object: objectName, locale, labels } });
|
|
190
|
-
}
|
|
191
|
-
} catch (error: any) {
|
|
192
|
-
res.status(500).json({ error: error.message });
|
|
193
|
-
}
|
|
194
|
-
});
|
|
195
|
-
|
|
196
|
-
ctx.logger.info(`I18n routes registered: ${basePath}/locales, ${basePath}/translations/:locale, ${basePath}/labels/:object/:locale`);
|
|
197
|
-
}
|
|
198
|
-
}
|
package/src/index.ts
DELETED
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.
|
|
2
|
-
|
|
3
|
-
export { I18nServicePlugin } from './i18n-service-plugin.js';
|
|
4
|
-
export type { I18nServicePluginOptions } from './i18n-service-plugin.js';
|
|
5
|
-
export { FileI18nAdapter } from './file-i18n-adapter.js';
|
|
6
|
-
export type { FileI18nAdapterOptions } from './file-i18n-adapter.js';
|
package/tsconfig.json
DELETED