@forge/bridge 2.2.1 → 2.3.0-next.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,23 @@
1
1
  # @forge/bridge
2
2
 
3
+ ## 2.3.0-next.2
4
+
5
+ ### Minor Changes
6
+
7
+ - 27af6ce4: Add showFlag API to open flags in products
8
+
9
+ ## 2.3.0-next.1
10
+
11
+ ### Minor Changes
12
+
13
+ - ae90999: Add router.reload()
14
+
15
+ ## 2.3.0-next.0
16
+
17
+ ### Minor Changes
18
+
19
+ - d307c8f: Add on and emit methods to Events API
20
+
3
21
  ## 2.2.1
4
22
 
5
23
  ### Patch Changes
@@ -0,0 +1,6 @@
1
+ import { Subscription } from '../types';
2
+ export declare const events: {
3
+ emit: (event: string, payload?: any) => Promise<void>;
4
+ on: (event: string, callback: (payload?: any) => any) => Promise<Subscription>;
5
+ };
6
+ //# sourceMappingURL=events.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/events/events.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAYxC,eAAO,MAAM,MAAM;kBARE,MAAM,YAAY,GAAG,KAAG,OAAO,CAAC,IAAI,CAAC;gBAIvC,MAAM,uBAAuB,GAAG,KAAK,GAAG,KAAG,OAAO,CAAC,YAAY,CAAC;CAOlF,CAAC"}
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.events = void 0;
4
+ const bridge_1 = require("../bridge");
5
+ const callBridge = bridge_1.getCallBridge();
6
+ const emit = (event, payload) => {
7
+ return callBridge('emit', { event, payload });
8
+ };
9
+ const on = (event, callback) => {
10
+ return callBridge('on', { event, callback });
11
+ };
12
+ exports.events = {
13
+ emit,
14
+ on
15
+ };
@@ -0,0 +1,2 @@
1
+ export * from './events';
2
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/events/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC"}
@@ -0,0 +1,4 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const tslib_1 = require("tslib");
4
+ tslib_1.__exportStar(require("./events"), exports);
@@ -0,0 +1,20 @@
1
+ export declare type FlagAppearance = 'info' | 'success' | 'warning' | 'error';
2
+ export declare type FlagType = FlagAppearance;
3
+ export interface Flag {
4
+ close: () => Promise<boolean | void>;
5
+ }
6
+ export interface FlagAction {
7
+ text: string;
8
+ onClick: () => void;
9
+ }
10
+ export interface FlagOptions {
11
+ id: number | string;
12
+ title?: string;
13
+ description?: string;
14
+ type?: FlagType;
15
+ appearance?: FlagAppearance;
16
+ actions?: FlagAction[];
17
+ isAutoDismiss?: boolean;
18
+ }
19
+ export declare const showFlag: (options: FlagOptions) => Flag;
20
+ //# sourceMappingURL=flag.d.ts.map
@@ -0,0 +1 @@
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"}
@@ -0,0 +1,20 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.showFlag = void 0;
4
+ const tslib_1 = require("tslib");
5
+ const bridge_1 = require("../bridge");
6
+ const errors_1 = require("../errors");
7
+ const callBridge = bridge_1.getCallBridge();
8
+ exports.showFlag = (options) => {
9
+ var _a;
10
+ if (!options.id) {
11
+ throw new errors_1.BridgeAPIError('"id" must be defined in flag options');
12
+ }
13
+ const result = callBridge('showFlag', Object.assign(Object.assign({}, options), { type: (_a = options.type) !== null && _a !== void 0 ? _a : 'info' }));
14
+ return {
15
+ close: () => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
16
+ yield result;
17
+ return callBridge('closeFlag', { id: options.id });
18
+ })
19
+ };
20
+ };
@@ -0,0 +1,2 @@
1
+ export { showFlag, FlagOptions } from './flag';
2
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
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"}
@@ -0,0 +1,4 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ var flag_1 = require("./flag");
4
+ Object.defineProperty(exports, "showFlag", { enumerable: true, get: function () { return flag_1.showFlag; } });
package/out/index.d.ts CHANGED
@@ -3,4 +3,6 @@ export * from './view';
3
3
  export * from './router';
4
4
  export * from './modal';
5
5
  export * from './fetch';
6
+ export * from './flag';
7
+ export * from './events';
6
8
  //# sourceMappingURL=index.d.ts.map
@@ -1 +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"}
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,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC"}
package/out/index.js CHANGED
@@ -6,3 +6,5 @@ tslib_1.__exportStar(require("./view"), exports);
6
6
  tslib_1.__exportStar(require("./router"), exports);
7
7
  tslib_1.__exportStar(require("./modal"), exports);
8
8
  tslib_1.__exportStar(require("./fetch"), exports);
9
+ tslib_1.__exportStar(require("./flag"), exports);
10
+ tslib_1.__exportStar(require("./events"), exports);
@@ -1,5 +1,6 @@
1
1
  export declare const router: {
2
2
  navigate: (url: string) => Promise<void>;
3
3
  open: (url: string) => Promise<void>;
4
+ reload: () => Promise<void>;
4
5
  };
5
6
  //# sourceMappingURL=router.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../../src/router/router.ts"],"names":[],"mappings":"AAQA,eAAO,MAAM,MAAM;oBAJG,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC;gBAE5B,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC;CAKzC,CAAC"}
1
+ {"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../../src/router/router.ts"],"names":[],"mappings":"AAUA,eAAO,MAAM,MAAM;oBANG,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC;gBAE5B,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC;kBAEtB,OAAO,CAAC,IAAI,CAAC;CAMhC,CAAC"}
@@ -6,7 +6,9 @@ const bridge_1 = require("../bridge");
6
6
  const callBridge = bridge_1.getCallBridge();
7
7
  const navigate = (url) => tslib_1.__awaiter(void 0, void 0, void 0, function* () { return callBridge('navigate', { url, type: 'same-tab' }); });
8
8
  const open = (url) => tslib_1.__awaiter(void 0, void 0, void 0, function* () { return callBridge('navigate', { url, type: 'new-tab' }); });
9
+ const reload = () => tslib_1.__awaiter(void 0, void 0, void 0, function* () { return callBridge('reload'); });
9
10
  exports.router = {
10
11
  navigate,
11
- open
12
+ open,
13
+ reload
12
14
  };
package/out/types.d.ts CHANGED
@@ -6,4 +6,7 @@ export declare type ProductFetchResponse = {
6
6
  body?: string;
7
7
  } & Pick<ResponseInit, 'headers' | 'status' | 'statusText'>;
8
8
  export declare type FullContext = {};
9
+ export declare type Subscription = {
10
+ unsubscribe: () => void;
11
+ };
9
12
  //# sourceMappingURL=types.d.ts.map
@@ -1 +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;IAAE,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAAC,YAAY,EAAE,SAAS,GAAG,QAAQ,GAAG,YAAY,CAAC,CAAC;AAE/G,oBAAY,WAAW,GAAG,EAAE,CAAC"}
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;IAAE,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAAC,YAAY,EAAE,SAAS,GAAG,QAAQ,GAAG,YAAY,CAAC,CAAC;AAE/G,oBAAY,WAAW,GAAG,EAAE,CAAC;AAE7B,oBAAY,YAAY,GAAG;IACzB,WAAW,EAAE,MAAM,IAAI,CAAC;CACzB,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@forge/bridge",
3
- "version": "2.2.1",
3
+ "version": "2.3.0-next.2",
4
4
  "description": "Forge bridge API for custom UI apps",
5
5
  "author": "Atlassian",
6
6
  "license": "UNLICENSED",