@itwin/core-i18n 3.5.0-dev.8 → 3.5.1

package/CHANGELOG.md

@@ -1,6 +1,77 @@
 # Change Log - @itwin/core-i18n
 
-This log was last generated on Thu, 01 Sep 2022 14:37:22 GMT and should not be manually modified.
+This log was last generated on Thu, 15 Dec 2022 16:38:28 GMT and should not be manually modified.
+
+## 3.5.1
+Thu, 15 Dec 2022 16:38:28 GMT
+
+_Version update only_
+
+## 3.5.0
+Wed, 07 Dec 2022 19:12:37 GMT
+
+### Updates
+
+- add i18n tests
+
+## 3.4.7
+Wed, 30 Nov 2022 14:28:19 GMT
+
+_Version update only_
+
+## 3.4.6
+Tue, 22 Nov 2022 14:24:19 GMT
+
+_Version update only_
+
+## 3.4.5
+Thu, 17 Nov 2022 21:32:50 GMT
+
+_Version update only_
+
+## 3.4.4
+Thu, 10 Nov 2022 19:32:17 GMT
+
+_Version update only_
+
+## 3.4.3
+Fri, 28 Oct 2022 13:34:58 GMT
+
+_Version update only_
+
+## 3.4.2
+Mon, 24 Oct 2022 13:23:45 GMT
+
+_Version update only_
+
+## 3.4.1
+Mon, 17 Oct 2022 20:06:51 GMT
+
+_Version update only_
+
+## 3.4.0
+Thu, 13 Oct 2022 20:24:47 GMT
+
+### Updates
+
+- Add webpack:test to build:ci
+- Replace deprecated i18next-xhr-backend with i18next-http-backend, and add some ITwinLocalization tests
+- Updated Node types declaration to support latest v16
+
+## 3.3.5
+Tue, 27 Sep 2022 11:50:59 GMT
+
+_Version update only_
+
+## 3.3.4
+Thu, 08 Sep 2022 19:00:05 GMT
+
+_Version update only_
+
+## 3.3.3
+Tue, 06 Sep 2022 20:54:19 GMT
+
+_Version update only_
 
 ## 3.3.2
 Thu, 01 Sep 2022 14:37:22 GMT

package/lib/cjs/ITwinLocalization.d.ts

@@ -1,99 +1,100 @@
-/** @packageDocumentation
- * @module Localization
- */
-import { i18n, InitOptions, Module, TOptionsBase } from "i18next";
-import { DetectorOptions } from "i18next-browser-languagedetector";
-import { BackendOptions } from "i18next-http-backend";
-import type { Localization } from "@itwin/core-common";
-/** Options for ITwinLocalization
- *  @public
- */
-export interface LocalizationOptions {
-    urlTemplate?: string;
-    backendPlugin?: Module;
-    detectorPlugin?: Module;
-    initOptions?: InitOptions;
-    backendHttpOptions?: BackendOptions;
-    detectorOptions?: DetectorOptions;
-}
-/** Supplies localizations for iTwin.js
- * @note this class uses the [i18next](https://www.i18next.com/) package.
- * @public
- */
-export declare class ITwinLocalization implements Localization {
-    i18next: i18n;
-    private readonly _initOptions;
-    private readonly _backendOptions;
-    private readonly _detectionOptions;
-    private readonly _namespaces;
-    constructor(options?: LocalizationOptions);
-    initialize(namespaces: string[]): Promise<void>;
-    /** Replace all instances of `%{key}` within a string with the translations of those keys.
-     * For example:
-     * ``` ts
-     * "MyKeys": {
-     *   "Key1": "First value",
-     *   "Key2": "Second value"
-     *  }
-     * ```
-     *
-     * ``` ts
-     * i18.translateKeys("string with %{MyKeys.Key1} followed by %{MyKeys.Key2}!"") // returns "string with First Value followed by Second Value!"
-     * ```
-     * @param line The input line, potentially containing %{keys}.
-     * @returns The line with all %{keys} translated
-     * @public
-     */
-    getLocalizedKeys(line: string): string;
-    /** Return the translated value of a key.
-     * @param key - the key that matches a property in the JSON localization file.
-     * @note The key includes the namespace, which identifies the particular localization file that contains the property,
-     * followed by a colon, followed by the property in the JSON file.
-     * For example:
-     * ``` ts
-     * const dataString: string = IModelApp.localization.getLocalizedString("iModelJs:BackgroundMap.BingDataAttribution");
-     *  ```
-     * assigns to dataString the string with property BackgroundMap.BingDataAttribution from the iModelJs.json localization file.
-     * @returns The string corresponding to the first key that resolves.
-     * @throws Error if no keys resolve to a string.
-     * @public
-     */
-    getLocalizedString(key: string | string[], options?: TOptionsBase): string;
-    /** Similar to `getLocalizedString` but the namespace is a separate param and the key does not include the namespace.
-     * @param namespace - the namespace that identifies the particular localization file that contains the property.
-     * @param key - the key that matches a property in the JSON localization file.
-     * @returns The string corresponding to the first key that resolves.
-     * @throws Error if no keys resolve to a string.
-     * @internal
-     */
-    getLocalizedStringWithNamespace(namespace: string, key: string | string[], options?: TOptionsBase): string;
-    /** Gets the English translation.
-     * @param namespace - the namespace that identifies the particular localization file that contains the property.
-     * @param key - the key that matches a property in the JSON localization file.
-     * @returns The string corresponding to the first key that resolves.
-     * @throws Error if no keys resolve to a string.
-     * @internal
-     */
-    getEnglishString(namespace: string, key: string | string[], options?: TOptionsBase): string;
-    /** Get the promise for an already registered Namespace.
-     * @param name - the name of the namespace
-     * @public
-     */
-    getNamespacePromise(name: string): Promise<void> | undefined;
-    /** @internal */
-    getLanguageList(): readonly string[];
-    /** override the language detected in the browser  */
-    changeLanguage(language: string): Promise<void>;
-    /** Register a new Namespace and return it. If the namespace is already registered, it will be returned.
-     * @param name - the name of the namespace, which is the base name of the JSON file that contains the localization properties.
-     * @note - The registerNamespace method starts fetching the appropriate version of the JSON localization file from the server,
-     * based on the current locale. To make sure that fetch is complete before performing translations from this namespace, await
-     * fulfillment of the readPromise Promise property of the returned LocalizationNamespace.
-     * @see [Localization in iTwin.js]($docs/learning/frontend/Localization.md)
-     * @public
-     */
-    registerNamespace(name: string): Promise<void>;
-    /** @internal */
-    unregisterNamespace(name: string): void;
-}
+/** @packageDocumentation
+ * @module Localization
+ */
+import { i18n, InitOptions, Module, TOptionsBase } from "i18next";
+import { DetectorOptions } from "i18next-browser-languagedetector";
+import { BackendOptions } from "i18next-http-backend";
+import type { Localization } from "@itwin/core-common";
+/** Options for ITwinLocalization
+ *  @public
+ */
+export interface LocalizationOptions {
+    urlTemplate?: string;
+    backendPlugin?: Module;
+    detectorPlugin?: Module;
+    initOptions?: InitOptions;
+    backendHttpOptions?: BackendOptions;
+    detectorOptions?: DetectorOptions;
+}
+/** Supplies localizations for iTwin.js
+ * @note this class uses the [i18next](https://www.i18next.com/) package.
+ * @public
+ */
+export declare class ITwinLocalization implements Localization {
+    i18next: i18n;
+    private readonly _initOptions;
+    private readonly _backendOptions;
+    private readonly _detectionOptions;
+    private readonly _namespaces;
+    constructor(options?: LocalizationOptions);
+    initialize(namespaces: string[]): Promise<void>;
+    /** Replace all instances of `%{key}` within a string with the translations of those keys.
+     * For example:
+     * ``` ts
+     * "MyKeys": {
+     *   "Key1": "First value",
+     *   "Key2": "Second value"
+     *  }
+     * ```
+     *
+     * ``` ts
+     * i18.translateKeys("string with %{MyKeys.Key1} followed by %{MyKeys.Key2}!"") // returns "string with First Value followed by Second Value!"
+     * ```
+     * @param line The input line, potentially containing %{keys}.
+     * @returns The line with all %{keys} translated
+     * @public
+     */
+    getLocalizedKeys(line: string): string;
+    /** Return the translated value of a key.
+     * @param key - the key that matches a property in the JSON localization file.
+     * @note The key includes the namespace, which identifies the particular localization file that contains the property,
+     * followed by a colon, followed by the property in the JSON file.
+     * For example:
+     * ``` ts
+     * const dataString: string = IModelApp.localization.getLocalizedString("iModelJs:BackgroundMap.BingDataAttribution");
+     *  ```
+     * assigns to dataString the string with property BackgroundMap.BingDataAttribution from the iModelJs.json localization file.
+     * @returns The string corresponding to the first key that resolves.
+     * @throws Error if no keys resolve to a string.
+     * @public
+     */
+    getLocalizedString(key: string | string[], options?: TOptionsBase): string;
+    /** Similar to `getLocalizedString` but the default namespace is a separate parameter and the key does not need
+     * to include a namespace. If a key includes a namespace, that namespace will be used for interpolating that key.
+     * @param namespace - the namespace that identifies the particular localization file that contains the property.
+     * @param key - the key that matches a property in the JSON localization file.
+     * @returns The string corresponding to the first key that resolves.
+     * @throws Error if no keys resolve to a string.
+     * @internal
+     */
+    getLocalizedStringWithNamespace(namespace: string, key: string | string[], options?: TOptionsBase): string;
+    /** Gets the English translation.
+     * @param namespace - the namespace that identifies the particular localization file that contains the property.
+     * @param key - the key that matches a property in the JSON localization file.
+     * @returns The string corresponding to the first key that resolves.
+     * @throws Error if no keys resolve to a string.
+     * @internal
+     */
+    getEnglishString(namespace: string, key: string | string[], options?: TOptionsBase): string;
+    /** Get the promise for an already registered Namespace.
+     * @param name - the name of the namespace
+     * @public
+     */
+    getNamespacePromise(name: string): Promise<void> | undefined;
+    /** @internal */
+    getLanguageList(): readonly string[];
+    /** override the language detected in the browser  */
+    changeLanguage(language: string): Promise<void>;
+    /** Register a new Namespace and return it. If the namespace is already registered, it will be returned.
+     * @param name - the name of the namespace, which is the base name of the JSON file that contains the localization properties.
+     * @note - The registerNamespace method starts fetching the appropriate version of the JSON localization file from the server,
+     * based on the current locale. To make sure that fetch is complete before performing translations from this namespace, await
+     * fulfillment of the readPromise Promise property of the returned LocalizationNamespace.
+     * @see [Localization in iTwin.js]($docs/learning/frontend/Localization.md)
+     * @public
+     */
+    registerNamespace(name: string): Promise<void>;
+    /** @internal */
+    unregisterNamespace(name: string): void;
+}
 //# sourceMappingURL=ITwinLocalization.d.ts.map

package/lib/cjs/ITwinLocalization.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ITwinLocalization.d.ts","sourceRoot":"","sources":["../../src/ITwinLocalization.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAgB,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAC3E,OAAuC,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AACnG,OAAgB,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAE/D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAIvD;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,kBAAkB,CAAC,EAAE,cAAc,CAAC;IACpC,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC;AAED;;;GAGG;AACH,qBAAa,iBAAkB,YAAW,YAAY;IAC7C,OAAO,EAAE,IAAI,CAAC;IACrB,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAc;IAC3C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAiB;IACjD,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAkB;IACpD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAoC;gBAE7C,OAAO,CAAC,EAAE,mBAAmB;IA+BnC,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IA4B5D;;;;;;;;;;;;;;;OAeG;IACI,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAI7C;;;;;;;;;;;;OAYG;IACI,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,MAAM;IAcjF;;;;;;OAMG;IACI,+BAA+B,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,MAAM;IAcjH;;;;;;OAMG;IACI,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,MAAM;IAalG;;;OAGG;IACI,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,SAAS;IAInE,gBAAgB;IACT,eAAe,IAAI,SAAS,MAAM,EAAE;IAI3C,qDAAqD;IACxC,cAAc,CAAC,QAAQ,EAAE,MAAM;IAI5C;;;;;;;OAOG;IACU,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAqC3D,gBAAgB;IACT,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;CAG/C"}
+{"version":3,"file":"ITwinLocalization.d.ts","sourceRoot":"","sources":["../../src/ITwinLocalization.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAgB,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAC3E,OAAuC,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AACnG,OAAgB,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAE/D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAIvD;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,kBAAkB,CAAC,EAAE,cAAc,CAAC;IACpC,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC;AAED;;;GAGG;AACH,qBAAa,iBAAkB,YAAW,YAAY;IAC7C,OAAO,EAAE,IAAI,CAAC;IACrB,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAc;IAC3C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAiB;IACjD,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAkB;IACpD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAoC;gBAE7C,OAAO,CAAC,EAAE,mBAAmB;IA+BnC,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IA4B5D;;;;;;;;;;;;;;;OAeG;IACI,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAI7C;;;;;;;;;;;;OAYG;IACI,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,MAAM;IAcjF;;;;;;;OAOG;IACI,+BAA+B,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,MAAM;IAcjH;;;;;;OAMG;IACI,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,MAAM;IAkBlG;;;OAGG;IACI,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,SAAS;IAInE,gBAAgB;IACT,eAAe,IAAI,SAAS,MAAM,EAAE;IAI3C,qDAAqD;IACxC,cAAc,CAAC,QAAQ,EAAE,MAAM;IAI5C;;;;;;;OAOG;IACU,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAqC3D,gBAAgB;IACT,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;CAG/C"}