@enonic-types/lib-i18n 0.1.1 → 7.11.0-B3
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 +12 -4
- package/i18n.d.ts +55 -55
- package/package.json +33 -32
package/README.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
## Install
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
npm i --save-dev @enonic/lib-i18n
|
|
8
|
+
npm i --save-dev @enonic-types/lib-i18n
|
|
9
9
|
```
|
|
10
10
|
|
|
11
11
|
## Use
|
|
@@ -13,6 +13,7 @@ npm i --save-dev @enonic/lib-i18n
|
|
|
13
13
|
Add the corresponding types to your `tsconfig.json` file that is used for application's server-side TypeScript code.
|
|
14
14
|
|
|
15
15
|
`tsconfig.json`
|
|
16
|
+
|
|
16
17
|
```json
|
|
17
18
|
{
|
|
18
19
|
"compilerOptions": {
|
|
@@ -25,9 +26,11 @@ Add the corresponding types to your `tsconfig.json` file that is used for applic
|
|
|
25
26
|
|
|
26
27
|
### Require and custom imports
|
|
27
28
|
|
|
28
|
-
To make `require` work out of box, you must install and add the `@enonic-types/global` types. Aside from providing definitions for XP
|
|
29
|
+
To make `require` work out of the box, you must install and add the `@enonic-types/global` types. Aside from providing definitions for XP
|
|
30
|
+
global objects, e.g. `log`, `app`, `__`, etc, requiring a library by the default path will return typed object.
|
|
29
31
|
|
|
30
32
|
`tsconfig.json`
|
|
33
|
+
|
|
31
34
|
```diff
|
|
32
35
|
{
|
|
33
36
|
"compilerOptions": {
|
|
@@ -40,17 +43,21 @@ To make `require` work out of box, you must install and add the `@enonic-types/g
|
|
|
40
43
|
```
|
|
41
44
|
|
|
42
45
|
`example.ts`
|
|
46
|
+
|
|
43
47
|
```ts
|
|
44
48
|
const {localize, getPhrases, getSupportedLocales} = require('/lib/xp/i18n');
|
|
45
49
|
```
|
|
46
50
|
|
|
47
|
-
More detailed explanation on how it works and how to type custom import function can be
|
|
51
|
+
More detailed explanation on how it works and how to type custom import function can be
|
|
52
|
+
found [here](https://developer.enonic.com/docs/xp/stable/api).
|
|
48
53
|
|
|
49
54
|
### ES6-style import
|
|
50
55
|
|
|
51
|
-
If you are planning to use `import` in your code and transpile it with the default `tsc` TypeScript compiler, you'll need to add proper
|
|
56
|
+
If you are planning to use `import` in your code and transpile it with the default `tsc` TypeScript compiler, you'll need to add proper
|
|
57
|
+
types mapping to your configuration.
|
|
52
58
|
|
|
53
59
|
`tsconfig.json`
|
|
60
|
+
|
|
54
61
|
```diff
|
|
55
62
|
{
|
|
56
63
|
"compilerOptions": {
|
|
@@ -66,6 +73,7 @@ If you are planning to use `import` in your code and transpile it with the defau
|
|
|
66
73
|
```
|
|
67
74
|
|
|
68
75
|
`example.ts`
|
|
76
|
+
|
|
69
77
|
```ts
|
|
70
78
|
import {localize, getPhrases, getSupportedLocales} from '/lib/xp/i18n';
|
|
71
79
|
```
|
package/i18n.d.ts
CHANGED
|
@@ -1,55 +1,55 @@
|
|
|
1
|
-
declare global {
|
|
2
|
-
interface XpLibraries {
|
|
3
|
-
'/lib/xp/i18n': typeof import('./i18n');
|
|
4
|
-
}
|
|
5
|
-
}
|
|
6
|
-
export interface LocalizeParams {
|
|
7
|
-
key: string;
|
|
8
|
-
locale?: string | string[];
|
|
9
|
-
values?: string[];
|
|
10
|
-
bundles?: string[];
|
|
11
|
-
application?: string;
|
|
12
|
-
}
|
|
13
|
-
/**
|
|
14
|
-
* Internationalization functions.
|
|
15
|
-
*
|
|
16
|
-
* @example
|
|
17
|
-
* var i18nLib = require('/lib/xp/i18n');
|
|
18
|
-
*
|
|
19
|
-
* @module i18n
|
|
20
|
-
*/
|
|
21
|
-
/**
|
|
22
|
-
* This function localizes a phrase.
|
|
23
|
-
*
|
|
24
|
-
* @example-ref examples/i18n/localize.js
|
|
25
|
-
*
|
|
26
|
-
* @param {object} params JSON with the parameters.
|
|
27
|
-
* @param {string} params.key The property key.
|
|
28
|
-
* @param {string|string[]} [params.locale] A string-representation of a locale, or an array of locales in preferred order. If the locale is not set, the site language is used.
|
|
29
|
-
* @param {string[]} [params.values] Optional placeholder values.
|
|
30
|
-
* @param {string[]} [params.bundles] Optional list of bundle names.
|
|
31
|
-
* @param {string} [params.application] Application key where to find resource bundles. Defaults to current application.
|
|
32
|
-
*
|
|
33
|
-
* @returns {string} The localized string.
|
|
34
|
-
*/
|
|
35
|
-
export declare function localize(params: LocalizeParams): string;
|
|
36
|
-
/**
|
|
37
|
-
* This function returns all phrases for the given locale and bundles.
|
|
38
|
-
*
|
|
39
|
-
* @param {string|string[]} locale A string-representation of a locale, or an array of locales in preferred order.
|
|
40
|
-
* @param {string[]} bundles List of bundle names. Bundle names are specified as paths, relative to the `src/main/resources` folder.
|
|
41
|
-
*
|
|
42
|
-
* @returns {object} An object of all phrases.
|
|
43
|
-
*
|
|
44
|
-
* @example
|
|
45
|
-
* i18nLib.getPhrases('en', ['i18n/phrases'])
|
|
46
|
-
*/
|
|
47
|
-
export declare function getPhrases(locale: string | string[], bundles: string[]): Record<string, string>;
|
|
48
|
-
/**
|
|
49
|
-
* This function returns the list of supported locale codes for the specified bundles.
|
|
50
|
-
*
|
|
51
|
-
* @param {string[]} bundles List of bundle names.
|
|
52
|
-
*
|
|
53
|
-
* @returns {string[]} A list of supported locale codes for the specified bundles.
|
|
54
|
-
*/
|
|
55
|
-
export declare function getSupportedLocales(bundles: string[]): string[];
|
|
1
|
+
declare global {
|
|
2
|
+
interface XpLibraries {
|
|
3
|
+
'/lib/xp/i18n': typeof import('./i18n');
|
|
4
|
+
}
|
|
5
|
+
}
|
|
6
|
+
export interface LocalizeParams {
|
|
7
|
+
key: string;
|
|
8
|
+
locale?: string | string[];
|
|
9
|
+
values?: string[];
|
|
10
|
+
bundles?: string[];
|
|
11
|
+
application?: string;
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* Internationalization functions.
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* var i18nLib = require('/lib/xp/i18n');
|
|
18
|
+
*
|
|
19
|
+
* @module i18n
|
|
20
|
+
*/
|
|
21
|
+
/**
|
|
22
|
+
* This function localizes a phrase.
|
|
23
|
+
*
|
|
24
|
+
* @example-ref examples/i18n/localize.js
|
|
25
|
+
*
|
|
26
|
+
* @param {object} params JSON with the parameters.
|
|
27
|
+
* @param {string} params.key The property key.
|
|
28
|
+
* @param {string|string[]} [params.locale] A string-representation of a locale, or an array of locales in preferred order. If the locale is not set, the site language is used.
|
|
29
|
+
* @param {string[]} [params.values] Optional placeholder values.
|
|
30
|
+
* @param {string[]} [params.bundles] Optional list of bundle names.
|
|
31
|
+
* @param {string} [params.application] Application key where to find resource bundles. Defaults to current application.
|
|
32
|
+
*
|
|
33
|
+
* @returns {string} The localized string.
|
|
34
|
+
*/
|
|
35
|
+
export declare function localize(params: LocalizeParams): string;
|
|
36
|
+
/**
|
|
37
|
+
* This function returns all phrases for the given locale and bundles.
|
|
38
|
+
*
|
|
39
|
+
* @param {string|string[]} locale A string-representation of a locale, or an array of locales in preferred order.
|
|
40
|
+
* @param {string[]} bundles List of bundle names. Bundle names are specified as paths, relative to the `src/main/resources` folder.
|
|
41
|
+
*
|
|
42
|
+
* @returns {object} An object of all phrases.
|
|
43
|
+
*
|
|
44
|
+
* @example
|
|
45
|
+
* i18nLib.getPhrases('en', ['i18n/phrases'])
|
|
46
|
+
*/
|
|
47
|
+
export declare function getPhrases(locale: string | string[], bundles: string[]): Record<string, string>;
|
|
48
|
+
/**
|
|
49
|
+
* This function returns the list of supported locale codes for the specified bundles.
|
|
50
|
+
*
|
|
51
|
+
* @param {string[]} bundles List of bundle names.
|
|
52
|
+
*
|
|
53
|
+
* @returns {string[]} A list of supported locale codes for the specified bundles.
|
|
54
|
+
*/
|
|
55
|
+
export declare function getSupportedLocales(bundles: string[]): string[];
|
package/package.json
CHANGED
|
@@ -1,32 +1,33 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "@enonic-types/lib-i18n",
|
|
3
|
-
"version": "
|
|
4
|
-
"description": "Type definitions for lib-i18n.",
|
|
5
|
-
"types": "i18n.d.ts",
|
|
6
|
-
"files": [
|
|
7
|
-
"i18n.d.ts"
|
|
8
|
-
],
|
|
9
|
-
"repository": {
|
|
10
|
-
"type": "git",
|
|
11
|
-
"url": "git+https://github.com/enonic/xp.git#master"
|
|
12
|
-
},
|
|
13
|
-
"keywords": [
|
|
14
|
-
"enonic",
|
|
15
|
-
"enonic-xp",
|
|
16
|
-
"lib-i18n",
|
|
17
|
-
"i18n",
|
|
18
|
-
"types",
|
|
19
|
-
"typescript"
|
|
20
|
-
],
|
|
21
|
-
"contributors": [
|
|
22
|
-
"Mikita Taukachou <edloidas@gmail.com> (https://edloidas.github.io/)"
|
|
23
|
-
],
|
|
24
|
-
"license": "Apache-2.0",
|
|
25
|
-
"bugs": {
|
|
26
|
-
"url": "https://github.com/enonic/xp/issues"
|
|
27
|
-
},
|
|
28
|
-
"homepage": "https://github.com/enonic/xp/tree/master#readme",
|
|
29
|
-
"
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"name": "@enonic-types/lib-i18n",
|
|
3
|
+
"version": "7.11.0-B3",
|
|
4
|
+
"description": "Type definitions for lib-i18n.",
|
|
5
|
+
"types": "i18n.d.ts",
|
|
6
|
+
"files": [
|
|
7
|
+
"i18n.d.ts"
|
|
8
|
+
],
|
|
9
|
+
"repository": {
|
|
10
|
+
"type": "git",
|
|
11
|
+
"url": "git+https://github.com/enonic/xp.git#master"
|
|
12
|
+
},
|
|
13
|
+
"keywords": [
|
|
14
|
+
"enonic",
|
|
15
|
+
"enonic-xp",
|
|
16
|
+
"lib-i18n",
|
|
17
|
+
"i18n",
|
|
18
|
+
"types",
|
|
19
|
+
"typescript"
|
|
20
|
+
],
|
|
21
|
+
"contributors": [
|
|
22
|
+
"Mikita Taukachou <edloidas@gmail.com> (https://edloidas.github.io/)"
|
|
23
|
+
],
|
|
24
|
+
"license": "Apache-2.0",
|
|
25
|
+
"bugs": {
|
|
26
|
+
"url": "https://github.com/enonic/xp/issues"
|
|
27
|
+
},
|
|
28
|
+
"homepage": "https://github.com/enonic/xp/tree/master#readme",
|
|
29
|
+
"dependencies": {},
|
|
30
|
+
"publishConfig": {
|
|
31
|
+
"access": "public"
|
|
32
|
+
}
|
|
33
|
+
}
|