@forge/bridge 4.3.0 → 4.4.0-next.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @forge/bridge
 
+## 4.4.0-next.0
+
+### Minor Changes
+
+- d516a64: Update router.navigate to allow navigation to an object containing a specified target and context properties
+
 ## 4.3.0
 
 ### Minor Changes

package/out/index.d.ts

@@ -1,3 +1,4 @@
+export { NavigationTarget } from './router/targets';
 export * from './invoke';
 export * from './invoke-remote';
 export * from './view';

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;AACzB,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAEpD,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,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.i18n = void 0;
+exports.i18n = exports.NavigationTarget = void 0;
 const tslib_1 = require("tslib");
+var targets_1 = require("./router/targets");
+Object.defineProperty(exports, "NavigationTarget", { enumerable: true, get: function () { return targets_1.NavigationTarget; } });
 tslib_1.__exportStar(require("./invoke"), exports);
 tslib_1.__exportStar(require("./invoke-remote"), exports);
 tslib_1.__exportStar(require("./view"), exports);

package/out/router/router.d.ts

@@ -1,6 +1,9 @@
+import { NavigationLocation } from './types';
+declare type Navigate = (location: string | NavigationLocation) => Promise<void>;
 export declare const router: {
-    navigate: (url: string) => Promise<void>;
-    open: (url: string) => Promise<void>;
+    navigate: Navigate;
+    open: Navigate;
     reload: () => Promise<void>;
 };
+export {};
 //# sourceMappingURL=router.d.ts.map

package/out/router/router.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../../src/router/router.ts"],"names":[],"mappings":"AAUA,eAAO,MAAM,MAAM;oBANG,MAAM,KAAK,QAAQ,IAAI,CAAC;gBAE5B,MAAM,KAAK,QAAQ,IAAI,CAAC;kBAEtB,QAAQ,IAAI,CAAC;CAMhC,CAAC"}
+{"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../../src/router/router.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAI7C,aAAK,QAAQ,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,kBAAkB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AA2CzE,eAAO,MAAM,MAAM;;;kBAFC,QAAQ,IAAI,CAAC;CAMhC,CAAC"}

package/out/router/router.js

@@ -3,8 +3,28 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.router = void 0;
 const bridge_1 = require("../bridge");
 const callBridge = (0, bridge_1.getCallBridge)();
-const navigate = async (url) => callBridge('navigate', { url, type: 'same-tab' });
-const open = async (url) => callBridge('navigate', { url, type: 'new-tab' });
+const navigate = async (location) => {
+    if (typeof location === 'string') {
+        return callBridge('navigate', { url: location, type: 'same-tab' });
+    }
+    else {
+        if (!(location === null || location === void 0 ? void 0 : location.target)) {
+            throw new Error('target is required for navigation');
+        }
+        return callBridge('navigate', { ...location, type: 'same-tab' });
+    }
+};
+const open = async (location) => {
+    if (typeof location === 'string') {
+        return callBridge('navigate', { url: location, type: 'new-tab' });
+    }
+    else {
+        if (!(location === null || location === void 0 ? void 0 : location.target)) {
+            throw new Error('target is required for navigation');
+        }
+        return callBridge('navigate', { ...location, type: 'new-tab' });
+    }
+};
 const reload = async () => callBridge('reload');
 exports.router = {
     navigate,

package/out/router/targets.d.ts

@@ -0,0 +1,12 @@
+export declare const NavigationTarget: {
+    readonly ContentView: "contentView";
+    readonly ContentEdit: "contentEdit";
+    readonly ContentList: "contentList";
+    readonly SpaceView: "spaceView";
+    readonly Module: "module";
+    readonly UserProfile: "userProfile";
+    readonly Dashboard: "dashboard";
+    readonly Issue: "issue";
+    readonly ProjectSettingsDetails: "projectSettingsDetails";
+};
+//# sourceMappingURL=targets.d.ts.map

package/out/router/targets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"targets.d.ts","sourceRoot":"","sources":["../../src/router/targets.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,gBAAgB;;;;;;;;;;CAqCnB,CAAC"}

package/out/router/targets.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NavigationTarget = void 0;
+exports.NavigationTarget = {
+    ContentView: 'contentView',
+    ContentEdit: 'contentEdit',
+    ContentList: 'contentList',
+    SpaceView: 'spaceView',
+    Module: 'module',
+    UserProfile: 'userProfile',
+    Dashboard: 'dashboard',
+    Issue: 'issue',
+    ProjectSettingsDetails: 'projectSettingsDetails'
+};

package/out/router/types.d.ts

@@ -0,0 +1,49 @@
+import { NavigationTarget } from './targets';
+declare type ContentView = {
+    target: typeof NavigationTarget.ContentView;
+    contentId: string;
+    version?: string;
+};
+declare type ContentEdit = {
+    target: typeof NavigationTarget.ContentEdit;
+    contentId: string;
+};
+declare type SpaceView = {
+    target: typeof NavigationTarget.SpaceView;
+    spaceKey: string;
+};
+declare type ContentList = {
+    target: typeof NavigationTarget.ContentList;
+    contentType: 'page' | 'blogpost' | 'customContent';
+} & ({
+    contentType: 'page' | 'blogpost';
+    spaceKey: string;
+} | {
+    contentType: 'customContent';
+    moduleKey: string;
+});
+declare type Module = {
+    target: typeof NavigationTarget.Module;
+    moduleKey: string;
+    spaceKey?: string;
+    projectKey?: string;
+};
+declare type UserProfile = {
+    target: typeof NavigationTarget.UserProfile;
+    accountId: string;
+};
+declare type Dashboard = {
+    target: typeof NavigationTarget.Dashboard;
+    dashboardId: string;
+};
+declare type Issue = {
+    target: typeof NavigationTarget.Issue;
+    issueKey: string;
+};
+declare type ProjectSettingsDetails = {
+    target: typeof NavigationTarget.ProjectSettingsDetails;
+    projectKey: string;
+};
+export declare type NavigationLocation = ContentView | ContentEdit | SpaceView | UserProfile | ContentList | Module | Dashboard | Issue | ProjectSettingsDetails;
+export {};
+//# sourceMappingURL=types.d.ts.map

package/out/router/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/router/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAG7C,aAAK,WAAW,GAAG;IACjB,MAAM,EAAE,OAAO,gBAAgB,CAAC,WAAW,CAAC;IAC5C,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,aAAK,WAAW,GAAG;IACjB,MAAM,EAAE,OAAO,gBAAgB,CAAC,WAAW,CAAC;IAC5C,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,aAAK,SAAS,GAAG;IACf,MAAM,EAAE,OAAO,gBAAgB,CAAC,SAAS,CAAC;IAC1C,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,aAAK,WAAW,GAAG;IACjB,MAAM,EAAE,OAAO,gBAAgB,CAAC,WAAW,CAAC;IAC5C,WAAW,EAAE,MAAM,GAAG,UAAU,GAAG,eAAe,CAAC;CACpD,GAAG,CACA;IACE,WAAW,EAAE,MAAM,GAAG,UAAU,CAAC;IACjC,QAAQ,EAAE,MAAM,CAAC;CAClB,GACD;IACE,WAAW,EAAE,eAAe,CAAC;IAC7B,SAAS,EAAE,MAAM,CAAC;CACnB,CACJ,CAAC;AAGF,aAAK,MAAM,GAAG;IACZ,MAAM,EAAE,OAAO,gBAAgB,CAAC,MAAM,CAAC;IACvC,SAAS,EAAE,MAAM,CAAC;IAElB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,aAAK,WAAW,GAAG;IACjB,MAAM,EAAE,OAAO,gBAAgB,CAAC,WAAW,CAAC;IAC5C,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAGF,aAAK,SAAS,GAAG;IACf,MAAM,EAAE,OAAO,gBAAgB,CAAC,SAAS,CAAC;IAC1C,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,aAAK,KAAK,GAAG;IACX,MAAM,EAAE,OAAO,gBAAgB,CAAC,KAAK,CAAC;IACtC,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,aAAK,sBAAsB,GAAG;IAC5B,MAAM,EAAE,OAAO,gBAAgB,CAAC,sBAAsB,CAAC;IACvD,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,oBAAY,kBAAkB,GAC1B,WAAW,GACX,WAAW,GACX,SAAS,GACT,WAAW,GACX,WAAW,GACX,MAAM,GACN,SAAS,GACT,KAAK,GACL,sBAAsB,CAAC"}

package/out/router/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/bridge",
-  "version": "4.3.0",
+  "version": "4.4.0-next.0",
   "description": "Forge bridge API for custom UI apps",
   "author": "Atlassian",
   "license": "UNLICENSED",