@enonic-types/lib-i18n 7.16.2 → 8.0.0-A2

package/i18n.d.ts

@@ -9,7 +9,7 @@ export interface LocalizeParams {
     locale?: string | string[];
     values?: string[];
     bundles?: string[];
-    application?: string;
+    fallbackMessage?: string;
 }
 /**
  * Internationalization functions.
@@ -28,29 +28,29 @@ export interface LocalizeParams {
  * @param {string} params.key The property key.
  * @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.
  * @param {string[]} [params.values] Optional placeholder values.
- * @param {string[]} [params.bundles] Optional list of bundle names.
- * @param {string} [params.application] Application key where to find resource bundles. Defaults to current application.
+ * @param {string[]} [params.bundles] Optional list of message bundle names.
+ * @param {string} [params.fallbackMessage] Optional fallback message to use if the phrase is not found. Default is "NOT_TRANSLATED".
  *
- * @returns {string} The localized string.
+ * @returns {string} The localized string, or a fallback message if the phrase is not found.
  */
 export declare function localize(params: LocalizeParams): string;
 /**
  * This function returns all phrases for the given locale and bundles.
  *
  * @param {string|string[]} locale A string-representation of a locale, or an array of locales in preferred order.
- * @param {string[]} bundles List of bundle names.  Bundle names are specified as paths, relative to the `src/main/resources` folder.
+ * @param {string[]} [bundles] Optional list of message bundle names.
  *
  * @returns {object} An object of all phrases.
  *
  * @example
  * i18nLib.getPhrases('en', ['i18n/phrases'])
  */
-export declare function getPhrases(locale: string | string[], bundles: string[]): Record<string, string>;
+export declare function getPhrases(locale: string | string[], bundles?: string[]): Record<string, string>;
 /**
  * This function returns the list of supported locale codes for the specified bundles.
  *
- * @param {string[]} bundles List of bundle names.
+ * @param {string[]} [bundles] Optional list of message bundle names.
  *
  * @returns {string[]} A list of supported locale codes for the specified bundles.
  */
-export declare function getSupportedLocales(bundles: string[]): string[];
+export declare function getSupportedLocales(bundles?: string[]): string[];

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@enonic-types/lib-i18n",
-    "version": "7.16.2",
+    "version": "8.0.0-A2",
     "description": "Type definitions for lib-i18n.",
     "types": "i18n.d.ts",
     "files": [
@@ -27,7 +27,7 @@
     },
     "homepage": "https://github.com/enonic/xp/tree/master#readme",
     "dependencies": {
-        "@enonic-types/core": "7.16.2"
+        "@enonic-types/core": "8.0.0-A2"
     },
     "publishConfig": {
         "access": "public"