@forge/bridge 2.3.0-next.1 → 2.4.0-next.0

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @forge/bridge
 
+## 2.4.0-next.0
+
+### Minor Changes
+
+- 14cd9b02: Add a new view.refresh() method
+
+## 2.3.0
+
+### Minor Changes
+
+- ae90999: Add router.reload()
+- 27af6ce: Add showFlag API to open flags in products
+- d307c8f: Add on and emit methods to Events API
+
+## 2.3.0-next.2
+
+### Minor Changes
+
+- 27af6ce4: Add showFlag API to open flags in products
+
 ## 2.3.0-next.1
 
 ### Minor Changes

package/out/flag/flag.d.ts

@@ -0,0 +1,20 @@
+export declare type FlagAppearance = 'info' | 'success' | 'warning' | 'error';
+export declare type FlagType = FlagAppearance;
+export interface Flag {
+    close: () => Promise<boolean | void>;
+}
+export interface FlagAction {
+    text: string;
+    onClick: () => void;
+}
+export interface FlagOptions {
+    id: number | string;
+    title?: string;
+    description?: string;
+    type?: FlagType;
+    appearance?: FlagAppearance;
+    actions?: FlagAction[];
+    isAutoDismiss?: boolean;
+}
+export declare const showFlag: (options: FlagOptions) => Flag;
+//# sourceMappingURL=flag.d.ts.map

package/out/flag/flag.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"flag.d.ts","sourceRoot":"","sources":["../../src/flag/flag.ts"],"names":[],"mappings":"AAGA,oBAAY,cAAc,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC;AACtE,oBAAY,QAAQ,GAAG,cAAc,CAAC;AAEtC,MAAM,WAAW,IAAI;IACnB,KAAK,EAAE,MAAM,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,GAAG,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IAKrB,IAAI,CAAC,EAAE,QAAQ,CAAC;IAIhB,UAAU,CAAC,EAAE,cAAc,CAAC;IAC5B,OAAO,CAAC,EAAE,UAAU,EAAE,CAAC;IACvB,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAID,eAAO,MAAM,QAAQ,YAAa,WAAW,KAAG,IAgB/C,CAAC"}

package/out/flag/flag.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.showFlag = void 0;
+const tslib_1 = require("tslib");
+const bridge_1 = require("../bridge");
+const errors_1 = require("../errors");
+const callBridge = bridge_1.getCallBridge();
+exports.showFlag = (options) => {
+    var _a;
+    if (!options.id) {
+        throw new errors_1.BridgeAPIError('"id" must be defined in flag options');
+    }
+    const result = callBridge('showFlag', Object.assign(Object.assign({}, options), { type: (_a = options.type) !== null && _a !== void 0 ? _a : 'info' }));
+    return {
+        close: () => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+            yield result;
+            return callBridge('closeFlag', { id: options.id });
+        })
+    };
+};

package/out/flag/index.d.ts

@@ -0,0 +1,2 @@
+export { showFlag, FlagOptions } from './flag';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/flag/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC"}

package/out/flag/index.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var flag_1 = require("./flag");
+Object.defineProperty(exports, "showFlag", { enumerable: true, get: function () { return flag_1.showFlag; } });

package/out/index.d.ts

@@ -3,5 +3,6 @@ export * from './view';
 export * from './router';
 export * from './modal';
 export * from './fetch';
+export * from './flag';
 export * from './events';
 //# 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,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC"}

package/out/index.js

@@ -6,4 +6,5 @@ tslib_1.__exportStar(require("./view"), exports);
 tslib_1.__exportStar(require("./router"), exports);
 tslib_1.__exportStar(require("./modal"), exports);
 tslib_1.__exportStar(require("./fetch"), exports);
+tslib_1.__exportStar(require("./flag"), exports);
 tslib_1.__exportStar(require("./events"), exports);

package/out/view/refresh.d.ts

@@ -0,0 +1,2 @@
+export declare const refresh: (payload?: any) => Promise<void>;
+//# sourceMappingURL=refresh.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"refresh.d.ts","sourceRoot":"","sources":["../../src/view/refresh.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,OAAO,aAAoB,GAAG,kBAK1C,CAAC"}

package/out/view/refresh.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.refresh = void 0;
+const tslib_1 = require("tslib");
+const bridge_1 = require("../bridge");
+const errors_1 = require("../errors");
+const callBridge = bridge_1.getCallBridge();
+exports.refresh = (payload) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+    const success = yield callBridge('refresh', payload);
+    if (success === false) {
+        throw new errors_1.BridgeAPIError("this resource's view is not refreshable.");
+    }
+});

package/out/view/view.d.ts

@@ -1,6 +1,7 @@
 export declare const view: {
     submit: (payload?: any) => Promise<void>;
     close: (payload?: any) => Promise<void>;
+    refresh: (payload?: any) => Promise<void>;
     createHistory: () => Promise<import("history").History<unknown>>;
     getContext: () => Promise<import("../types").FullContext>;
 };

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

@@ -1 +1 @@
-{"version":3,"file":"view.d.ts","sourceRoot":"","sources":["../../src/view/view.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,IAAI;;;;;CAKhB,CAAC"}
+{"version":3,"file":"view.d.ts","sourceRoot":"","sources":["../../src/view/view.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,IAAI;;;;;;CAMhB,CAAC"}

package/out/view/view.js

@@ -3,11 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.view = void 0;
 const submit_1 = require("./submit");
 const close_1 = require("./close");
+const refresh_1 = require("./refresh");
 const createHistory_1 = require("./createHistory");
 const getContext_1 = require("./getContext");
 exports.view = {
     submit: submit_1.submit,
     close: close_1.close,
+    refresh: refresh_1.refresh,
     createHistory: createHistory_1.createHistory,
     getContext: getContext_1.getContext
 };

package/package.json

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