@getflip/bridge 0.1.0-alpha.1 → 0.1.0-alpha.10

package/README.md

@@ -7,9 +7,13 @@ App or Flip Admin Console.
 
 - [Installation](#installation)
 - [Usage](#usage)
+- [Methods](#methods)
   - [Internationalization](#internationalization)
   - [Navigation](#navigation)
   - [Theming](#theming)
+  - [User Interface](#user-interface)
+- [Events](#events)
+- [Error Handling](#error-handling)
 - [Development](#development)
 
 ## Installation
@@ -25,13 +29,27 @@ yarn add @getflip/bridge
 The library exposes a set of functions and listeners you can use to communicate
 with the Flip App and Flip Admin Console (host app for short).
 
+**Before using the provided functions, you have to call the `initFlipBridge`
+function to set up the Flip Bridge.**
+
+```js
+import { initFlipBridge } from "@getflip/bridge";
+
+initFlipBridge({
+  debug: true,
+  hostAppOrigin: "http://localhost:4200", // has to be the origin of the targeted host app
+});
+```
+
+## Methods
+
 ### Internationalization
 
 #### `getAvailableLangs`
 
 Get all available languages of the host app.
 
-**Returns** `string[]`
+**Returns** `Promise<string[]>`
 
 **Example**
 
@@ -45,7 +63,7 @@ const availableLanguages = await getAvailableLangs(); // e.g. ['de', 'en', 'fr',
 
 Get the current language of the host app.
 
-**Returns** `string`
+**Returns** `Promise<string>`
 
 **Example**
 
@@ -61,7 +79,9 @@ const currentLanguage = await getLang(); // e.g. 'en'
 
 Navigate to a specific route.
 
-**Returns** `boolean`
+**Param** `string`
+
+**Returns** `Promise<boolean>`
 
 **Example**
 
@@ -77,22 +97,249 @@ await navigate("/my-app/settings");
 
 Get the current theme.
 
-**Returns** `'light' | 'dark'`
+**Returns**
+
+```js
+Promise<{
+  activeTheme: "light" | "dark";
+  preferredTheme: "light" | "dark" | undefined;
+}>
+```
 
 **Example**
 
 ```js
 import { getTheme } from "@getflip/bridge";
 
-const currentTheme = await getTheme(); // e.g. 'light'
+const theme = await getTheme();
+```
+
+### User Interface
+
+#### `createDialog`
+
+Creates a modal dialog rendered by the host app.
+
+**Param**
+
+```js
+{
+  hideLabel?: boolean;
+  id: string;
+  intent?: 'primary' | 'critical';
+  label: string;
+  text: string;
+  primaryAction?: {
+    label: string;
+  };
+  secondaryAction?: {
+    label: string;
+  };
+}
+```
+
+**Returns**
+
+```js
+Promise<{
+  id: string;
+  open: () => Promise<boolean>;
+  close: () => Promise<boolean>;
+  destroy: () => Promise<boolean>;
+}>
+```
+
+**Example**
+
+```js
+import { createDialog } from "@getflip/bridge";
+
+const dialog = await createDialog({
+  id: "my-dialog",
+  label: "My Dialog",
+  text: "Lorem ipsum",
+  primaryAction: {
+    label: "Close",
+  },
+});
+
+await dialog.open();
+```
+
+#### `openDialog`
+
+Opens a dialog.
+
+**Param**
+
+```js
+{
+  id: string; // the dialog id
+}
+```
+
+**Returns** `Promise<boolean>`
+
+**Example**
+
+```js
+import { createDialog, openDialog } from "@getflip/bridge";
+
+await createDialog({
+  id: "my-dialog",
+  label: "My Dialog",
+  text: "Lorem ipsum",
+});
+
+await openDialog({ id: "my-dialog" });
 ```
 
+#### `closeDialog`
+
+Closes a dialog.
+
+**Param**
+
+```js
+{
+  id: string; // the dialog id
+}
+```
+
+**Returns** `Promise<boolean>`
+
+**Example**
+
+```js
+import { closeDialog } from "@getflip/bridge";
+
+await closeDialog({ id: "my-dialog" });
+```
+
+#### `destroyDialog`
+
+Destroys a dialog, removing it from the DOM.
+
+**Param**
+
+```js
+{
+  id: string; // the dialog id
+}
+```
+
+**Returns** `Promise<boolean>`
+
+**Example**
+
+```js
+import { destroyDialog } from "@getflip/bridge";
+
+await destroyDialog({ id: "my-dialog" });
+```
+
+## Events
+
+Use the `subscribe` functions to subscribe to events.
+
+```js
+import { subscribe, BridgeEventType } from "@getflip/bridge";
+
+const unsubscribe = await subscribe(BridgeEventType.THEME_CHANGE, (event) => {
+  console.log(event.data);
+});
+
+// …
+
+await unsubscribe();
+```
+
+### `LANG_CHANGE`
+
+Fires when the user selected language changes.
+
+**Event**
+
+```js
+{
+  data: string; // e.g. 'en'
+  type: BridgeEventType.LANG_CHANGE;
+}
+```
+
+### `PRIMARY_ACTION_CLICK`
+
+Fires when the primary action button of a dialog or modal is clicked.
+
+**Event**
+
+```js
+{
+  data: {
+    parentId: string; // id of the action's dialog or modal
+  }
+  type: BridgeEventType.PRIMARY_ACTION_CLICK;
+}
+```
+
+### `SECONDARY_ACTION_CLICK`
+
+Fires when the secondary action button of a dialog or modal is clicked.
+
+**Event**
+
+```js
+{
+  data: {
+    parentId: string; // id of the action's dialog or modal
+  }
+  type: BridgeEventType.SECONDARY_ACTION_CLICK;
+}
+```
+
+### `THEME_CHANGE`
+
+Fires when the user theme changes.
+
+**Event**
+
+```js
+{
+  data: {
+    activeTheme: "light" | "dark";
+    preferredTheme: "light" | "dark" | undefined;
+  }
+  type: BridgeEventType.THEME_CHANGE;
+}
+```
+
+## Error Handling
+
+All provided functions return promises that throw an error if the execution
+failed. The errors have the following format.
+
+```js
+{
+  code: BridgeErrorCode; // e.g. 'FORBIDDEN_ORIGIN'
+}
+```
+
+### `FORBIDDEN_ORIGIN`
+
+Thrown when the origin of the requesting app is not allowed by the host app.
+Please check if your app is correctly registered in the Flip Partner Dashboard
+and the `hostAppOrigin` option is set (see [Usage](#usage)).
+
+### `INVALID_REQUEST`
+
+The host app identified the request as invalid. This typically occurs when the
+provided parameters are invalid.
+
 ## Development
 
 Start the compiler in watch mode for local development:
 
 ```
-yarn
 yarn dev
 ```
 

package/dist/dialog/dialog.d.ts

@@ -0,0 +1,10 @@
+import { CloseDialogRequest, CloseDialogRequestParams, CreateDialogRequestParams, DestroyDialogRequest, DestroyDialogRequestParams, OpenDialogRequest, OpenDialogRequestParams } from "./dialog.types";
+export declare function createDialog(params: CreateDialogRequestParams): Promise<{
+    id: string;
+    open: () => Promise<import("../types").BridgeError | OpenDialogRequest>;
+    close: () => Promise<import("../types").BridgeError | CloseDialogRequest>;
+    destroy: () => Promise<import("../types").BridgeError | DestroyDialogRequest>;
+} | undefined>;
+export declare function openDialog(params: OpenDialogRequestParams): Promise<import("../types").BridgeError | OpenDialogRequest>;
+export declare function closeDialog(params: CloseDialogRequestParams): Promise<import("../types").BridgeError | CloseDialogRequest>;
+export declare function destroyDialog(params: DestroyDialogRequestParams): Promise<import("../types").BridgeError | DestroyDialogRequest>;

package/dist/dialog/dialog.js

@@ -0,0 +1,45 @@
+import { v4 as uuidv4 } from "uuid";
+import { makeRequest } from "../messaging";
+import { BridgeMethod } from "../types";
+export async function createDialog(params) {
+    const request = {
+        id: uuidv4(),
+        method: BridgeMethod.CREATE_DIALOG,
+        params,
+    };
+    const result = await makeRequest(request);
+    if (!result) {
+        return;
+    }
+    return {
+        id: params.id,
+        open: async () => openDialog({ id: params.id }),
+        close: async () => closeDialog({ id: params.id }),
+        destroy: async () => destroyDialog({ id: params.id }),
+    };
+}
+export async function openDialog(params) {
+    const request = {
+        id: uuidv4(),
+        method: BridgeMethod.OPEN_DIALOG,
+        params,
+    };
+    return makeRequest(request);
+}
+export async function closeDialog(params) {
+    const request = {
+        id: uuidv4(),
+        method: BridgeMethod.CLOSE_DIALOG,
+        params,
+    };
+    return makeRequest(request);
+}
+export async function destroyDialog(params) {
+    const request = {
+        id: uuidv4(),
+        method: BridgeMethod.DESTROY_DIALOG,
+        params,
+    };
+    return makeRequest(request);
+}
+//# sourceMappingURL=dialog.js.map

package/dist/dialog/dialog.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dialog.js","sourceRoot":"","sources":["../../src/dialog/dialog.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,MAAM,CAAC;AACpC,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAYxC,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,MAAiC;IAClE,MAAM,OAAO,GAAwB;QACnC,EAAE,EAAE,MAAM,EAAE;QACZ,MAAM,EAAE,YAAY,CAAC,aAAa;QAClC,MAAM;KACP,CAAC;IAEF,MAAM,MAAM,GAAG,MAAM,WAAW,CAAsB,OAAO,CAAC,CAAC;IAE/D,IAAI,CAAC,MAAM,EAAE;QACX,OAAO;KACR;IAED,OAAO;QACL,EAAE,EAAE,MAAM,CAAC,EAAE;QACb,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC;QAC/C,KAAK,EAAE,KAAK,IAAI,EAAE,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC;QACjD,OAAO,EAAE,KAAK,IAAI,EAAE,CAAC,aAAa,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC;KACtD,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,MAA+B;IAC9D,MAAM,OAAO,GAAsB;QACjC,EAAE,EAAE,MAAM,EAAE;QACZ,MAAM,EAAE,YAAY,CAAC,WAAW;QAChC,MAAM;KACP,CAAC;IAEF,OAAO,WAAW,CAAoB,OAAO,CAAC,CAAC;AACjD,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,MAAgC;IAChE,MAAM,OAAO,GAAuB;QAClC,EAAE,EAAE,MAAM,EAAE;QACZ,MAAM,EAAE,YAAY,CAAC,YAAY;QACjC,MAAM;KACP,CAAC;IAEF,OAAO,WAAW,CAAqB,OAAO,CAAC,CAAC;AAClD,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,MAAkC;IACpE,MAAM,OAAO,GAAyB;QACpC,EAAE,EAAE,MAAM,EAAE;QACZ,MAAM,EAAE,YAAY,CAAC,cAAc;QACnC,MAAM;KACP,CAAC;IAEF,OAAO,WAAW,CAAuB,OAAO,CAAC,CAAC;AACpD,CAAC"}

package/dist/dialog/dialog.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/dialog/dialog.spec.js

@@ -0,0 +1,83 @@
+import { BridgeMethod } from "../types";
+import { closeDialog, createDialog, destroyDialog, openDialog } from "./dialog";
+jest.mock("../messaging", () => {
+    const originalModule = jest.requireActual("../messaging");
+    return Object.assign(Object.assign({ __esModule: true }, originalModule), { makeRequest: async (request) => {
+            originalModule.makeRequest(request);
+            return true;
+        } });
+});
+describe("dialog", () => {
+    beforeAll(() => {
+        global.flipBridgeOptions = { hostAppOrigin: "http://localhost" };
+    });
+    test("'createDialog' sends correct request", async () => {
+        const params = {
+            hideLabel: false,
+            id: "my-dialog",
+            label: "My Dialog",
+            text: "Lorem ipsum",
+            intent: "critical",
+            primaryAction: {
+                label: "Primary",
+            },
+            secondaryAction: {
+                label: "Secondary",
+            },
+        };
+        const spy = jest.fn();
+        window.top.postMessage = spy;
+        const response = await createDialog(params);
+        expect(spy).toHaveBeenCalledWith({
+            id: spy.mock.calls[0][0].id,
+            method: BridgeMethod.CREATE_DIALOG,
+            params,
+        }, "http://localhost");
+        expect(response === null || response === void 0 ? void 0 : response.id).toBe(params.id);
+        expect(typeof (response === null || response === void 0 ? void 0 : response.close)).toBe("function");
+        expect(typeof (response === null || response === void 0 ? void 0 : response.open)).toBe("function");
+    });
+    test("'openDialog' sends correct request", async () => {
+        const params = {
+            id: "my-dialog",
+        };
+        const spy = jest.fn();
+        window.top.postMessage = spy;
+        const response = await openDialog(params);
+        expect(spy).toHaveBeenCalledWith({
+            id: spy.mock.calls[0][0].id,
+            method: BridgeMethod.OPEN_DIALOG,
+            params,
+        }, "http://localhost");
+        expect(response).toBe(true);
+    });
+    test("'closeDialog' sends correct request", async () => {
+        const params = {
+            id: "my-dialog",
+        };
+        const spy = jest.fn();
+        window.top.postMessage = spy;
+        const response = await closeDialog(params);
+        expect(spy).toHaveBeenCalledWith({
+            id: spy.mock.calls[0][0].id,
+            method: BridgeMethod.CLOSE_DIALOG,
+            params,
+        }, "http://localhost");
+        expect(response).toBe(true);
+    });
+    test("'destroyDialog' sends correct request", async () => {
+        const params = {
+            id: "my-dialog",
+        };
+        const spy = jest.fn();
+        window.top.postMessage = spy;
+        const response = await destroyDialog(params);
+        expect(spy).toHaveBeenCalledWith({
+            id: spy.mock.calls[0][0].id,
+            method: BridgeMethod.DESTROY_DIALOG,
+            params,
+        }, "http://localhost");
+        expect(response).toBe(true);
+    });
+});
+//# sourceMappingURL=dialog.spec.js.map

package/dist/dialog/dialog.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dialog.spec.js","sourceRoot":"","sources":["../../src/dialog/dialog.spec.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAQhF,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,GAAG,EAAE;IAC7B,MAAM,cAAc,GAAG,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;IAE1D,qCACE,UAAU,EAAE,IAAI,IACb,cAAc,KACjB,WAAW,EAAE,KAAK,EAAE,OAAsB,EAAE,EAAE;YAC5C,cAAc,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;YACpC,OAAO,IAAI,CAAC;QACd,CAAC,IACD;AACJ,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE;IACtB,SAAS,CAAC,GAAG,EAAE;QACZ,MAAc,CAAC,iBAAiB,GAAG,EAAE,aAAa,EAAE,kBAAkB,EAAE,CAAC;IAC5E,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,sCAAsC,EAAE,KAAK,IAAI,EAAE;QACtD,MAAM,MAAM,GAA8B;YACxC,SAAS,EAAE,KAAK;YAChB,EAAE,EAAE,WAAW;YACf,KAAK,EAAE,WAAW;YAClB,IAAI,EAAE,aAAa;YACnB,MAAM,EAAE,UAAU;YAClB,aAAa,EAAE;gBACb,KAAK,EAAE,SAAS;aACjB;YACD,eAAe,EAAE;gBACf,KAAK,EAAE,WAAW;aACnB;SACF,CAAC;QAEF,MAAM,GAAG,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;QAErB,MAAM,CAAC,GAAW,CAAC,WAAW,GAAG,GAAG,CAAC;QAEtC,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,MAAM,CAAC,CAAC;QAE5C,MAAM,CAAC,GAAG,CAAC,CAAC,oBAAoB,CAC9B;YACE,EAAE,EAAE,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE;YAC3B,MAAM,EAAE,YAAY,CAAC,aAAa;YAClC,MAAM;SACP,EACD,kBAAkB,CACnB,CAAC;QAEF,MAAM,CAAC,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QACrC,MAAM,CAAC,OAAO,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,KAAK,CAAA,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAChD,MAAM,CAAC,OAAO,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,IAAI,CAAA,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;QACpD,MAAM,MAAM,GAA4B;YACtC,EAAE,EAAE,WAAW;SAChB,CAAC;QAEF,MAAM,GAAG,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;QAErB,MAAM,CAAC,GAAW,CAAC,WAAW,GAAG,GAAG,CAAC;QAEtC,MAAM,QAAQ,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,CAAC;QAE1C,MAAM,CAAC,GAAG,CAAC,CAAC,oBAAoB,CAC9B;YACE,EAAE,EAAE,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE;YAC3B,MAAM,EAAE,YAAY,CAAC,WAAW;YAChC,MAAM;SACP,EACD,kBAAkB,CACnB,CAAC;QAEF,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;QACrD,MAAM,MAAM,GAA6B;YACvC,EAAE,EAAE,WAAW;SAChB,CAAC;QAEF,MAAM,GAAG,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;QAErB,MAAM,CAAC,GAAW,CAAC,WAAW,GAAG,GAAG,CAAC;QAEtC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,MAAM,CAAC,CAAC;QAE3C,MAAM,CAAC,GAAG,CAAC,CAAC,oBAAoB,CAC9B;YACE,EAAE,EAAE,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE;YAC3B,MAAM,EAAE,YAAY,CAAC,YAAY;YACjC,MAAM;SACP,EACD,kBAAkB,CACnB,CAAC;QAEF,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,uCAAuC,EAAE,KAAK,IAAI,EAAE;QACvD,MAAM,MAAM,GAA+B;YACzC,EAAE,EAAE,WAAW;SAChB,CAAC;QAEF,MAAM,GAAG,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;QAErB,MAAM,CAAC,GAAW,CAAC,WAAW,GAAG,GAAG,CAAC;QAEtC,MAAM,QAAQ,GAAG,MAAM,aAAa,CAAC,MAAM,CAAC,CAAC;QAE7C,MAAM,CAAC,GAAG,CAAC,CAAC,oBAAoB,CAC9B;YACE,EAAE,EAAE,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE;YAC3B,MAAM,EAAE,YAAY,CAAC,cAAc;YACnC,MAAM;SACP,EACD,kBAAkB,CACnB,CAAC;QAEF,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/dialog/dialog.types.d.ts

@@ -0,0 +1,33 @@
+import { FlipDialogIntent } from "@getflip/swirl-components/dist/types/components/flip-dialog/flip-dialog";
+import { BridgeRequest } from "../messaging/messaging.types";
+import { BridgeMethod } from "../types";
+export type CreateDialogRequestParams = {
+    hideLabel?: boolean;
+    id: string;
+    intent?: FlipDialogIntent;
+    label: string;
+    text: string;
+    primaryAction?: {
+        label: string;
+    };
+    secondaryAction?: {
+        label: string;
+    };
+};
+export type OpenDialogRequestParams = {
+    id: string;
+};
+export type CloseDialogRequestParams = {
+    id: string;
+};
+export type DestroyDialogRequestParams = {
+    id: string;
+};
+export type CreateDialogRequest = BridgeRequest<BridgeMethod.CREATE_DIALOG, CreateDialogRequestParams>;
+export type OpenDialogRequest = BridgeRequest<BridgeMethod.OPEN_DIALOG, OpenDialogRequestParams>;
+export type CloseDialogRequest = BridgeRequest<BridgeMethod.CLOSE_DIALOG, CloseDialogRequestParams>;
+export type DestroyDialogRequest = BridgeRequest<BridgeMethod.DESTROY_DIALOG, CloseDialogRequestParams>;
+export type CreateDialogResult = boolean;
+export type OpenDialogResult = boolean;
+export type CloseDialogResult = boolean;
+export type DestroyDialogResult = boolean;

package/dist/dialog/dialog.types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=dialog.types.js.map

package/dist/dialog/dialog.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dialog.types.js","sourceRoot":"","sources":["../../src/dialog/dialog.types.ts"],"names":[],"mappings":""}

package/dist/dialog/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./dialog.types";
+export * from "./dialog";

package/dist/dialog/index.js

@@ -0,0 +1,3 @@
+export * from "./dialog.types";
+export * from "./dialog";
+//# sourceMappingURL=index.js.map

package/dist/dialog/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/dialog/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,UAAU,CAAC"}

package/dist/events/events.d.ts

@@ -0,0 +1,3 @@
+import { BridgeEvent, BridgeEventType, SubscribeOptions, UnsubscribeFunction } from "./events.types";
+export declare function subscribe<EventDataType = unknown>(type: BridgeEventType, callback: (event?: BridgeEvent<EventDataType>) => void, options?: SubscribeOptions): Promise<UnsubscribeFunction>;
+export declare function isEvent(message: Object): message is BridgeEvent;

package/dist/events/events.js

@@ -0,0 +1,44 @@
+import { v4 as uuidv4 } from "uuid";
+import { log } from "../logging";
+import { isAllowedOrigin, makeRequest } from "../messaging";
+import { BridgeMethod } from "../types";
+import { BridgeEventType, } from "./events.types";
+export async function subscribe(type, callback, options) {
+    const subscriptionId = (options === null || options === void 0 ? void 0 : options.id) || uuidv4();
+    const subscribeRequest = {
+        id: uuidv4(),
+        method: BridgeMethod.SUBSCRIBE,
+        params: { id: subscriptionId, type },
+    };
+    const eventHandler = (event) => {
+        if (!isAllowedOrigin(event.origin) ||
+            !isEvent(event.data) ||
+            event.data.type !== type ||
+            event.data.id !== subscriptionId) {
+            return;
+        }
+        log("handleEvent", event.data);
+        callback(event.data);
+    };
+    window.addEventListener("message", eventHandler);
+    const subscribed = await makeRequest(subscribeRequest);
+    if (!subscribed) {
+        window.removeEventListener("message", eventHandler);
+        throw new Error(`Could not subscribe to event "${type}".`);
+    }
+    return async () => {
+        const unsubscribeRequest = {
+            id: uuidv4(),
+            method: BridgeMethod.UNSUBSCRIBE,
+            params: { id: subscriptionId, type },
+        };
+        await makeRequest(unsubscribeRequest);
+        window.removeEventListener("message", eventHandler);
+    };
+}
+export function isEvent(message) {
+    return (typeof message === "object" &&
+        "type" in message &&
+        Object.values(BridgeEventType).includes(message.type));
+}
+//# sourceMappingURL=events.js.map

package/dist/events/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../../src/events/events.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,MAAM,CAAC;AACpC,OAAO,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC;AACjC,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAEL,eAAe,GAOhB,MAAM,gBAAgB,CAAC;AAExB,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,IAAqB,EACrB,QAAsD,EACtD,OAA0B;IAE1B,MAAM,cAAc,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,EAAE,KAAI,MAAM,EAAE,CAAC;IAE/C,MAAM,gBAAgB,GAAqB;QACzC,EAAE,EAAE,MAAM,EAAE;QACZ,MAAM,EAAE,YAAY,CAAC,SAAS;QAC9B,MAAM,EAAE,EAAE,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE;KACrC,CAAC;IAEF,MAAM,YAAY,GAAG,CAAC,KAA+C,EAAE,EAAE;QACvE,IACE,CAAC,eAAe,CAAC,KAAK,CAAC,MAAM,CAAC;YAC9B,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC;YACpB,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI;YACxB,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,cAAc,EAChC;YACA,OAAO;SACR;QAED,GAAG,CAAC,aAAa,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;QAE/B,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACvB,CAAC,CAAC;IAEF,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;IAEjD,MAAM,UAAU,GAAG,MAAM,WAAW,CAAkB,gBAAgB,CAAC,CAAC;IAExE,IAAI,CAAC,UAAU,EAAE;QACf,MAAM,CAAC,mBAAmB,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;QACpD,MAAM,IAAI,KAAK,CAAC,iCAAiC,IAAI,IAAI,CAAC,CAAC;KAC5D;IAED,OAAO,KAAK,IAAI,EAAE;QAChB,MAAM,kBAAkB,GAAuB;YAC7C,EAAE,EAAE,MAAM,EAAE;YACZ,MAAM,EAAE,YAAY,CAAC,WAAW;YAChC,MAAM,EAAE,EAAE,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE;SACrC,CAAC;QAEF,MAAM,WAAW,CAAoB,kBAAkB,CAAC,CAAC;QAEzD,MAAM,CAAC,mBAAmB,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;IACtD,CAAC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,OAAe;IACrC,OAAO,CACL,OAAO,OAAO,KAAK,QAAQ;QAC3B,MAAM,IAAI,OAAO;QACjB,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAuB,CAAC,CACzE,CAAC;AACJ,CAAC"}

package/dist/events/events.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/events/events.spec.js

@@ -0,0 +1,64 @@
+import { subscribe } from "./events";
+import { BridgeEventType } from "./events.types";
+jest.mock("../messaging", () => {
+    const originalModule = jest.requireActual("../messaging");
+    return Object.assign(Object.assign({ __esModule: true }, originalModule), { makeRequest: async (request) => {
+            originalModule.makeRequest(request);
+            return true;
+        } });
+});
+describe("events", () => {
+    beforeEach(() => {
+        global.flipBridgeOptions = { hostAppOrigin: "http://localhost" };
+    });
+    test("'subscribe' sends subscription request", async () => {
+        const spy = jest.fn();
+        window.top.postMessage = spy;
+        subscribe(BridgeEventType.LANG_CHANGE, () => { });
+        expect(spy).toHaveBeenCalledWith({
+            id: spy.mock.calls[0][0].id,
+            method: "SUBSCRIBE",
+            params: {
+                id: spy.mock.calls[0][0].params.id,
+                type: "LANG_CHANGE",
+            },
+        }, "http://localhost");
+    });
+    test("'subscribe' registers listener with callback function", async () => {
+        const callback = jest.fn();
+        const unsubscribe = await subscribe(BridgeEventType.LANG_CHANGE, callback, {
+            id: "SUBSCRIPTION_ID",
+        });
+        global.dispatchEvent(new MessageEvent("message", {
+            source: window,
+            origin: global.flipBridgeOptions.hostAppOrigin,
+            data: {
+                data: "DATA",
+                id: "SUBSCRIPTION_ID",
+                type: BridgeEventType.LANG_CHANGE,
+            },
+        }));
+        expect(callback).toHaveBeenCalledWith({
+            data: "DATA",
+            id: "SUBSCRIPTION_ID",
+            type: "LANG_CHANGE",
+        });
+        await unsubscribe();
+    });
+    test("'subscribe' returns function to unsubscribe", async () => {
+        const spy = jest.fn();
+        window.top.postMessage = spy;
+        const unsubscribe = await subscribe(BridgeEventType.LANG_CHANGE, () => { });
+        expect(typeof unsubscribe).toBe("function");
+        await unsubscribe();
+        expect(spy).toHaveBeenCalledWith({
+            id: spy.mock.calls[1][0].id,
+            method: "UNSUBSCRIBE",
+            params: {
+                id: spy.mock.calls[1][0].params.id,
+                type: "LANG_CHANGE",
+            },
+        }, "http://localhost");
+    });
+});
+//# sourceMappingURL=events.spec.js.map

package/dist/events/events.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.spec.js","sourceRoot":"","sources":["../../src/events/events.spec.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AACrC,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAEjD,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,GAAG,EAAE;IAC7B,MAAM,cAAc,GAAG,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;IAE1D,qCACE,UAAU,EAAE,IAAI,IACb,cAAc,KACjB,WAAW,EAAE,KAAK,EAAE,OAAsB,EAAE,EAAE;YAC5C,cAAc,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;YACpC,OAAO,IAAI,CAAC;QACd,CAAC,IACD;AACJ,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE;IACtB,UAAU,CAAC,GAAG,EAAE;QACb,MAAc,CAAC,iBAAiB,GAAG,EAAE,aAAa,EAAE,kBAAkB,EAAE,CAAC;IAC5E,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;QACxD,MAAM,GAAG,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;QAErB,MAAM,CAAC,GAAW,CAAC,WAAW,GAAG,GAAG,CAAC;QAEtC,SAAS,CAAC,eAAe,CAAC,WAAW,EAAE,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QAEjD,MAAM,CAAC,GAAG,CAAC,CAAC,oBAAoB,CAC9B;YACE,EAAE,EAAE,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE;YAC3B,MAAM,EAAE,WAAW;YACnB,MAAM,EAAE;gBACN,EAAE,EAAE,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE;gBAClC,IAAI,EAAE,aAAa;aACpB;SACF,EACD,kBAAkB,CACnB,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,uDAAuD,EAAE,KAAK,IAAI,EAAE;QACvE,MAAM,QAAQ,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;QAE3B,MAAM,WAAW,GAAG,MAAM,SAAS,CAAC,eAAe,CAAC,WAAW,EAAE,QAAQ,EAAE;YACzE,EAAE,EAAE,iBAAiB;SACtB,CAAC,CAAC;QAEH,MAAM,CAAC,aAAa,CAClB,IAAI,YAAY,CAAC,SAAS,EAAE;YAC1B,MAAM,EAAE,MAAM;YACd,MAAM,EAAG,MAAc,CAAC,iBAAiB,CAAC,aAAa;YACvD,IAAI,EAAE;gBACJ,IAAI,EAAE,MAAM;gBACZ,EAAE,EAAE,iBAAiB;gBACrB,IAAI,EAAE,eAAe,CAAC,WAAW;aAClC;SACF,CAAC,CACH,CAAC;QAEF,MAAM,CAAC,QAAQ,CAAC,CAAC,oBAAoB,CAAC;YACpC,IAAI,EAAE,MAAM;YACZ,EAAE,EAAE,iBAAiB;YACrB,IAAI,EAAE,aAAa;SACpB,CAAC,CAAC;QAEH,MAAM,WAAW,EAAE,CAAC;IACtB,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;QAC7D,MAAM,GAAG,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;QAErB,MAAM,CAAC,GAAW,CAAC,WAAW,GAAG,GAAG,CAAC;QAEtC,MAAM,WAAW,GAAG,MAAM,SAAS,CAAC,eAAe,CAAC,WAAW,EAAE,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QAC3E,MAAM,CAAC,OAAO,WAAW,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE5C,MAAM,WAAW,EAAE,CAAC;QACpB,MAAM,CAAC,GAAG,CAAC,CAAC,oBAAoB,CAC9B;YACE,EAAE,EAAE,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE;YAC3B,MAAM,EAAE,aAAa;YACrB,MAAM,EAAE;gBACN,EAAE,EAAE,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE;gBAClC,IAAI,EAAE,aAAa;aACpB;SACF,EACD,kBAAkB,CACnB,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/events/events.types.d.ts

@@ -0,0 +1,27 @@
+import { BridgeRequest } from "../messaging/messaging.types";
+import { BridgeMethod } from "../types";
+export declare enum BridgeEventType {
+    PRIMARY_ACTION_CLICK = "PRIMARY_ACTION_CLICK",
+    LANG_CHANGE = "LANG_CHANGE",
+    SECONDARY_ACTION_CLICK = "SECONDARY_ACTION_CLICK",
+    THEME_CHANGE = "THEME_CHANGE"
+}
+export type BridgeEvent<DataType = unknown> = {
+    data?: DataType;
+    id: string;
+    type: BridgeEventType;
+};
+export type SubscribeRequest = BridgeRequest<BridgeMethod.SUBSCRIBE, {
+    id: string;
+    type: BridgeEventType;
+}>;
+export type UnsubscribeRequest = BridgeRequest<BridgeMethod.UNSUBSCRIBE, {
+    id: string;
+    type: BridgeEventType;
+}>;
+export type SubscribeResult = boolean;
+export type UnsubscribeResult = boolean;
+export type UnsubscribeFunction = () => Promise<void>;
+export type SubscribeOptions = {
+    id?: string;
+};