@forge/bridge 3.5.1-next.4 → 4.0.0-next.6

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @forge/bridge
 
+## 4.0.0-next.6
+
+### Major Changes
+
+- a27f856: Ensure locale returned from getContext() is in the correct format and confirms the Forge Supported Locale Codes.
+
+  Additionally, add new APIs for Forge i18n support.
+
+  - `i18n.getTranslations` - Add i18n.getTranslations api to fetch i18n resources from Forge apps
+  - `i18n.createTranslationFunction` - Creates a translation function (i.e. `t`) to support content translation for Forge apps
+
+### Patch Changes
+
+- Updated dependencies [c81fa57]
+  - @forge/i18n@0.0.1-next.10
+
+## 3.5.1-next.5
+
+### Patch Changes
+
+- @forge/i18n@0.0.1-next.9
+
 ## 3.5.1-next.4
 
 ### Patch Changes

package/out/i18n/index.d.ts

@@ -0,0 +1,6 @@
+import { type ForgeSupportedLocaleCode, type GetTranslationsOptions, type GetTranslationsResult } from '@forge/i18n';
+export declare const resetTranslationsCache: () => void;
+export declare const getTranslations: (locale?: ForgeSupportedLocaleCode | null, options?: GetTranslationsOptions) => Promise<GetTranslationsResult>;
+export declare type TranslationFunction = (i18nKey: string, defaultValue?: string) => string;
+export declare const createTranslationFunction: (locale?: ForgeSupportedLocaleCode | null) => Promise<TranslationFunction>;
+//# sourceMappingURL=index.d.ts.map

package/out/i18n/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/i18n/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,qBAAqB,EAM3B,MAAM,aAAa,CAAC;AAuBrB,eAAO,MAAM,sBAAsB,QAAO,IAEzC,CAAC;AAEF,eAAO,MAAM,eAAe,YAClB,wBAAwB,GAAG,IAAI,YAC9B,sBAAsB,KAG9B,QAAQ,qBAAqB,CAO/B,CAAC;AAUF,oBAAY,mBAAmB,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC;AASrF,eAAO,MAAM,yBAAyB,YAC5B,wBAAwB,GAAG,IAAI,KACtC,QAAQ,mBAAmB,CAS7B,CAAC"}

package/out/i18n/index.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTranslationFunction = exports.getTranslations = exports.resetTranslationsCache = void 0;
+const tslib_1 = require("tslib");
+const i18n_1 = require("@forge/i18n");
+const view_1 = require("../view");
+const frontendResourcesAccessor = {
+    getI18nInfoConfig: () => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+        const resp = yield fetch(`./${i18n_1.I18N_BUNDLE_FOLDER_NAME}/${i18n_1.I18N_INFO_FILE_NAME}`);
+        if (!resp.ok) {
+            throw new Error('Failed to get i18n info config: ' + resp.statusText);
+        }
+        const info = (yield resp.json());
+        return info.config;
+    }),
+    getTranslationResource: (locale) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+        const resp = yield fetch(`./${i18n_1.I18N_BUNDLE_FOLDER_NAME}/${locale}.json`);
+        if (!resp.ok) {
+            throw new Error(`Failed to get translation resource for locale: ${locale}`);
+        }
+        return resp.json();
+    })
+};
+const translationsGetter = new i18n_1.TranslationsGetter(frontendResourcesAccessor);
+const resetTranslationsCache = () => {
+    translationsGetter.reset();
+};
+exports.resetTranslationsCache = resetTranslationsCache;
+const getTranslations = (locale = null, options = {
+    fallback: true
+}) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+    let targetLocale = locale;
+    if (!targetLocale) {
+        const context = yield view_1.view.getContext();
+        targetLocale = context.locale;
+    }
+    return yield translationsGetter.getTranslations(targetLocale, options);
+});
+exports.getTranslations = getTranslations;
+const createTranslationFunction = (locale = null) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+    let targetLocale = locale;
+    if (!targetLocale) {
+        const context = yield view_1.view.getContext();
+        targetLocale = context.locale;
+    }
+    const translator = new i18n_1.Translator(targetLocale, translationsGetter);
+    yield translator.init();
+    return (i18nKey, defaultValue) => { var _a, _b; return (_b = (_a = translator.translate(i18nKey)) !== null && _a !== void 0 ? _a : defaultValue) !== null && _b !== void 0 ? _b : i18nKey; };
+});
+exports.createTranslationFunction = createTranslationFunction;

package/out/index.d.ts

@@ -6,4 +6,5 @@ export * from './modal';
 export * from './fetch';
 export * from './flag';
 export * from './events';
+export * as i18n from './i18n';
 //# sourceMappingURL=index.d.ts.map

package/out/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC;AAChC,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC;AAChC,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC"}

package/out/index.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.i18n = void 0;
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./invoke"), exports);
 tslib_1.__exportStar(require("./invoke-remote"), exports);
@@ -9,3 +10,4 @@ tslib_1.__exportStar(require("./modal"), exports);
 tslib_1.__exportStar(require("./fetch"), exports);
 tslib_1.__exportStar(require("./flag"), exports);
 tslib_1.__exportStar(require("./events"), exports);
+exports.i18n = tslib_1.__importStar(require("./i18n"));

package/out/types.d.ts

@@ -1,3 +1,4 @@
+import { type ForgeSupportedLocaleCode } from '@forge/i18n';
 export declare type InvokePayload = {
     [key in number | string]: any;
 };
@@ -16,7 +17,7 @@ export interface FullContext {
     extension: ExtensionData;
     license?: LicenseDetails;
     localId: string;
-    locale: string;
+    locale: ForgeSupportedLocaleCode;
     moduleKey: string;
     siteUrl: string;
     timezone: string;

package/out/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,oBAAY,aAAa,GAAG;KACzB,GAAG,IAAI,MAAM,GAAG,MAAM,GAAG,GAAG;CAC9B,CAAC;AAEF,oBAAY,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;AAExD,oBAAY,oBAAoB,GAAG;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IACnC,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,GAAG,IAAI,CAAC,YAAY,EAAE,QAAQ,GAAG,YAAY,CAAC,CAAC;AAEhD,MAAM,WAAW,WAAW;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,aAAa,CAAC;IACzB,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB;AACD,UAAU,aAAa;IACrB,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,OAAO,CAAC;IAChB,aAAa,EAAE,MAAM,CAAC;IACtB,gBAAgB,EAAE,MAAM,CAAC;IACzB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,YAAY,EAAE,OAAO,CAAC;IACtB,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,wBAAwB,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,IAAI,EAAE,MAAM,CAAC;CACd;AAED,oBAAY,YAAY,GAAG;IACzB,WAAW,EAAE,MAAM,IAAI,CAAC;CACzB,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,wBAAwB,EAAE,MAAM,aAAa,CAAC;AAE5D,oBAAY,aAAa,GAAG;KACzB,GAAG,IAAI,MAAM,GAAG,MAAM,GAAG,GAAG;CAC9B,CAAC;AAEF,oBAAY,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;AAExD,oBAAY,oBAAoB,GAAG;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IACnC,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,GAAG,IAAI,CAAC,YAAY,EAAE,QAAQ,GAAG,YAAY,CAAC,CAAC;AAEhD,MAAM,WAAW,WAAW;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,aAAa,CAAC;IACzB,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,wBAAwB,CAAC;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB;AACD,UAAU,aAAa;IACrB,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,OAAO,CAAC;IAChB,aAAa,EAAE,MAAM,CAAC;IACtB,gBAAgB,EAAE,MAAM,CAAC;IACzB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,YAAY,EAAE,OAAO,CAAC;IACtB,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,wBAAwB,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,IAAI,EAAE,MAAM,CAAC;CACd;AAED,oBAAY,YAAY,GAAG;IACzB,WAAW,EAAE,MAAM,IAAI,CAAC;CACzB,CAAC"}

package/out/view/getContext.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getContext.d.ts","sourceRoot":"","sources":["../../src/view/getContext.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAIvC,eAAO,MAAM,UAAU,QAAO,QAAQ,WAAW,CAEhD,CAAC"}
+{"version":3,"file":"getContext.d.ts","sourceRoot":"","sources":["../../src/view/getContext.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAKvC,eAAO,MAAM,UAAU,QAAa,QAAQ,WAAW,CAStD,CAAC"}

package/out/view/getContext.js

@@ -1,9 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getContext = void 0;
+const tslib_1 = require("tslib");
 const bridge_1 = require("../bridge");
+const i18n_1 = require("@forge/i18n");
 const callBridge = (0, bridge_1.getCallBridge)();
-const getContext = () => {
-    return callBridge('getContext');
-};
+const getContext = () => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+    var _a;
+    const context = yield callBridge('getContext');
+    const locale = context === null || context === void 0 ? void 0 : context.locale;
+    if (locale) {
+        context.locale = (_a = (0, i18n_1.ensureLocale)(locale)) !== null && _a !== void 0 ? _a : locale;
+    }
+    return context;
+});
 exports.getContext = getContext;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/bridge",
-  "version": "3.5.1-next.4",
+  "version": "4.0.0-next.6",
   "description": "Forge bridge API for custom UI apps",
   "author": "Atlassian",
   "license": "UNLICENSED",
@@ -14,7 +14,7 @@
   },
   "dependencies": {
     "@types/history": "^4.7.11",
-    "@forge/i18n": "0.0.1-next.8"
+    "@forge/i18n": "0.0.1-next.10"
   },
   "devDependencies": {
     "history": "5.3.0",