@forge/bridge 4.2.0 → 4.3.0-next.0-experimental-d6acbbd

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @forge/bridge
 
+## 4.3.0-next.0-experimental-d6acbbd
+
+### Minor Changes
+
+- d516a64: Update router.navigate to allow navigation to an object containing a specified target and context properties
+- e771326: Adding types for userAccess field as a part of license decoupling M1
+
+## 4.3.0-next.0
+
+### Minor Changes
+
+- e771326: Adding types for userAccess field as a part of license decoupling M1
+
 ## 4.2.0
 
 ### Minor Changes

package/out/router/router.d.ts

@@ -1,6 +1,20 @@
+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>;
+    NAVIGATION_TARGET: {
+        readonly CONTENT_VIEW: "contentView";
+        readonly CONTENT_EDIT: "contentEdit";
+        readonly CONTENT_LIST: "contentList";
+        readonly SPACE_VIEW: "spaceView";
+        readonly MODULE: "module";
+        readonly USER_PROFILE: "userProfile";
+        readonly DASHBOARD: "dashboard";
+        readonly ISSUE: "issue";
+        readonly PROJECT_SETTINGS_DETAILS: "projectSettingsDetails";
+    };
 };
+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":"AAEA,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;;;;;;;;;;;;CAOhC,CAAC"}

package/out/router/router.js

@@ -2,12 +2,34 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.router = void 0;
 const bridge_1 = require("../bridge");
+const targets_1 = require("./targets");
 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,
     open,
-    reload
+    reload,
+    NAVIGATION_TARGET: targets_1.NAVIGATION_TARGET
 };

package/out/router/targets.d.ts

@@ -0,0 +1,12 @@
+export declare const NAVIGATION_TARGET: {
+    readonly CONTENT_VIEW: "contentView";
+    readonly CONTENT_EDIT: "contentEdit";
+    readonly CONTENT_LIST: "contentList";
+    readonly SPACE_VIEW: "spaceView";
+    readonly MODULE: "module";
+    readonly USER_PROFILE: "userProfile";
+    readonly DASHBOARD: "dashboard";
+    readonly ISSUE: "issue";
+    readonly PROJECT_SETTINGS_DETAILS: "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,iBAAiB;;;;;;;;;;CAqCpB,CAAC"}

package/out/router/targets.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NAVIGATION_TARGET = void 0;
+exports.NAVIGATION_TARGET = {
+    CONTENT_VIEW: 'contentView',
+    CONTENT_EDIT: 'contentEdit',
+    CONTENT_LIST: 'contentList',
+    SPACE_VIEW: 'spaceView',
+    MODULE: 'module',
+    USER_PROFILE: 'userProfile',
+    DASHBOARD: 'dashboard',
+    ISSUE: 'issue',
+    PROJECT_SETTINGS_DETAILS: 'projectSettingsDetails'
+};

package/out/router/types.d.ts

@@ -0,0 +1,49 @@
+import { NAVIGATION_TARGET } from './targets';
+declare type ContentView = {
+    target: typeof NAVIGATION_TARGET.CONTENT_VIEW;
+    contentId: string;
+    version?: string;
+};
+declare type ContentEdit = {
+    target: typeof NAVIGATION_TARGET.CONTENT_EDIT;
+    contentId: string;
+};
+declare type SpaceView = {
+    target: typeof NAVIGATION_TARGET.SPACE_VIEW;
+    spaceKey: string;
+};
+declare type ContentList = {
+    target: typeof NAVIGATION_TARGET.CONTENT_LIST;
+    contentType: 'page' | 'blogpost' | 'customContent';
+} & ({
+    contentType: 'page' | 'blogpost';
+    spaceKey: string;
+} | {
+    contentType: 'customContent';
+    moduleKey: string;
+});
+declare type Module = {
+    target: typeof NAVIGATION_TARGET.MODULE;
+    moduleKey: string;
+    spaceKey?: string;
+    projectKey?: string;
+};
+declare type UserProfile = {
+    target: typeof NAVIGATION_TARGET.USER_PROFILE;
+    accountId: string;
+};
+declare type Dashboard = {
+    target: typeof NAVIGATION_TARGET.DASHBOARD;
+    dashboardId: string;
+};
+declare type Issue = {
+    target: typeof NAVIGATION_TARGET.ISSUE;
+    issueKey: string;
+};
+declare type ProjectSettingsDetails = {
+    target: typeof NAVIGATION_TARGET.PROJECT_SETTINGS_DETAILS;
+    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,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAG9C,aAAK,WAAW,GAAG;IACjB,MAAM,EAAE,OAAO,iBAAiB,CAAC,YAAY,CAAC;IAC9C,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,aAAK,WAAW,GAAG;IACjB,MAAM,EAAE,OAAO,iBAAiB,CAAC,YAAY,CAAC;IAC9C,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,aAAK,SAAS,GAAG;IACf,MAAM,EAAE,OAAO,iBAAiB,CAAC,UAAU,CAAC;IAC5C,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,aAAK,WAAW,GAAG;IACjB,MAAM,EAAE,OAAO,iBAAiB,CAAC,YAAY,CAAC;IAC9C,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,iBAAiB,CAAC,MAAM,CAAC;IACxC,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,iBAAiB,CAAC,YAAY,CAAC;IAC9C,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAGF,aAAK,SAAS,GAAG;IACf,MAAM,EAAE,OAAO,iBAAiB,CAAC,SAAS,CAAC;IAC3C,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,aAAK,KAAK,GAAG;IACX,MAAM,EAAE,OAAO,iBAAiB,CAAC,KAAK,CAAC;IACvC,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,aAAK,sBAAsB,GAAG;IAC5B,MAAM,EAAE,OAAO,iBAAiB,CAAC,wBAAwB,CAAC;IAC1D,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/out/types.d.ts

@@ -16,6 +16,9 @@ export declare enum ExtensionEnvironment {
     STAGING = "STAGING",
     PRODUCTION = "PRODUCTION"
 }
+declare type UserAccessDetails = {
+    hasAccess: boolean;
+};
 export declare type EnvironmentType = keyof typeof ExtensionEnvironment;
 export interface FullContext {
     accountId?: string;
@@ -32,6 +35,7 @@ export interface FullContext {
     timezone: string;
     theme?: Partial<ThemeState> | null;
     surfaceColor?: string | null;
+    userAccess?: UserAccessDetails;
 }
 interface ExtensionData {
     [k: string]: any;

package/out/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,wBAAwB,EAAE,MAAM,aAAa,CAAC;AAC5D,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD,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,oBAAY,oBAAoB;IAC9B,WAAW,gBAAgB;IAC3B,OAAO,YAAY;IACnB,UAAU,eAAe;CAC1B;AAED,oBAAY,eAAe,GAAG,MAAM,OAAO,oBAAoB,CAAC;AAEhE,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,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,eAAe,CAAC;IACjC,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;IACjB,KAAK,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;IACnC,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;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;AAC5D,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD,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,oBAAY,oBAAoB;IAC9B,WAAW,gBAAgB;IAC3B,OAAO,YAAY;IACnB,UAAU,eAAe;CAC1B;AAED,aAAK,iBAAiB,GAAG;IACvB,SAAS,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,oBAAY,eAAe,GAAG,MAAM,OAAO,oBAAoB,CAAC;AAEhE,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,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,eAAe,CAAC;IACjC,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;IACjB,KAAK,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;IACnC,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,UAAU,CAAC,EAAE,iBAAiB,CAAC;CAChC;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/package.json

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