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

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.
Files changed (72) hide show
  1. package/README.md +253 -6
  2. package/dist/dialog/dialog.d.ts +10 -0
  3. package/dist/dialog/dialog.js +45 -0
  4. package/dist/dialog/dialog.js.map +1 -0
  5. package/dist/dialog/dialog.spec.d.ts +1 -0
  6. package/dist/dialog/dialog.spec.js +83 -0
  7. package/dist/dialog/dialog.spec.js.map +1 -0
  8. package/dist/dialog/dialog.types.d.ts +33 -0
  9. package/dist/dialog/dialog.types.js +2 -0
  10. package/dist/dialog/dialog.types.js.map +1 -0
  11. package/dist/dialog/index.d.ts +2 -0
  12. package/dist/dialog/index.js +3 -0
  13. package/dist/dialog/index.js.map +1 -0
  14. package/dist/events/events.d.ts +3 -0
  15. package/dist/events/events.js +44 -0
  16. package/dist/events/events.js.map +1 -0
  17. package/dist/events/events.spec.d.ts +1 -0
  18. package/dist/events/events.spec.js +64 -0
  19. package/dist/events/events.spec.js.map +1 -0
  20. package/dist/events/events.types.d.ts +27 -0
  21. package/dist/events/events.types.js +8 -0
  22. package/dist/events/events.types.js.map +1 -0
  23. package/dist/events/index.d.ts +2 -0
  24. package/dist/events/index.js +3 -0
  25. package/dist/events/index.js.map +1 -0
  26. package/dist/i18n/i18n.spec.d.ts +1 -0
  27. package/dist/i18n/i18n.spec.js +27 -0
  28. package/dist/i18n/i18n.spec.js.map +1 -0
  29. package/dist/i18n/i18n.types.d.ts +2 -1
  30. package/dist/index.cjs.js +240 -0
  31. package/dist/index.cjs.js.map +1 -0
  32. package/dist/index.d.ts +10 -0
  33. package/dist/index.js +10 -0
  34. package/dist/index.js.map +1 -1
  35. package/dist/index.mjs +228 -0
  36. package/dist/index.mjs.map +1 -0
  37. package/dist/index.spec.d.ts +1 -0
  38. package/dist/index.spec.js +20 -0
  39. package/dist/index.spec.js.map +1 -0
  40. package/dist/logging/logging.js +2 -1
  41. package/dist/logging/logging.js.map +1 -1
  42. package/dist/logging/logging.spec.d.ts +1 -0
  43. package/dist/logging/logging.spec.js +19 -0
  44. package/dist/logging/logging.spec.js.map +1 -0
  45. package/dist/messaging/index.d.ts +1 -0
  46. package/dist/messaging/index.js +1 -0
  47. package/dist/messaging/index.js.map +1 -1
  48. package/dist/messaging/messaging.d.ts +12 -1
  49. package/dist/messaging/messaging.js +52 -25
  50. package/dist/messaging/messaging.js.map +1 -1
  51. package/dist/messaging/messaging.spec.d.ts +1 -0
  52. package/dist/messaging/messaging.spec.js +59 -0
  53. package/dist/messaging/messaging.spec.js.map +1 -0
  54. package/dist/messaging/messaging.types.d.ts +11 -0
  55. package/dist/messaging/messaging.types.js +2 -0
  56. package/dist/messaging/messaging.types.js.map +1 -0
  57. package/dist/navigation/navigation.js.map +1 -1
  58. package/dist/navigation/navigation.spec.d.ts +1 -0
  59. package/dist/navigation/navigation.spec.js +22 -0
  60. package/dist/navigation/navigation.spec.js.map +1 -0
  61. package/dist/navigation/navigation.types.d.ts +3 -2
  62. package/dist/theming/theming.spec.d.ts +1 -0
  63. package/dist/theming/theming.spec.js +19 -0
  64. package/dist/theming/theming.spec.js.map +1 -0
  65. package/dist/theming/theming.types.d.ts +3 -2
  66. package/dist/types.d.ts +22 -13
  67. package/dist/types.js +7 -0
  68. package/dist/types.js.map +1 -1
  69. package/package.json +17 -4
  70. package/dist/bridge.d.ts +0 -7
  71. package/dist/bridge.js +0 -19
  72. package/dist/bridge.js.map +0 -1
@@ -0,0 +1,19 @@
1
+ import { log } from "./logging";
2
+ describe("logging", () => {
3
+ test("'log' logs to console if in debug mode", async () => {
4
+ global.flipBridgeOptions = {
5
+ debug: true,
6
+ };
7
+ const spy = jest.spyOn(global.console, "log").mockImplementation();
8
+ log("Message 1", { details: "details" });
9
+ expect(spy).toHaveBeenCalledWith("Message 1 – ", { details: "details" });
10
+ global.flipBridgeOptions = {
11
+ debug: false,
12
+ };
13
+ log("Message 2", { details: "details" });
14
+ expect(spy).not.toHaveBeenCalledWith("Message 2 – ", {
15
+ details: "details",
16
+ });
17
+ });
18
+ });
19
+ //# sourceMappingURL=logging.spec.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"logging.spec.js","sourceRoot":"","sources":["../../src/logging/logging.spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAEhC,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;IACvB,IAAI,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;QACvD,MAAc,CAAC,iBAAiB,GAAG;YAClC,KAAK,EAAE,IAAI;SACZ,CAAC;QAEF,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,kBAAkB,EAAE,CAAC;QAEnE,GAAG,CAAC,WAAW,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC;QACzC,MAAM,CAAC,GAAG,CAAC,CAAC,oBAAoB,CAAC,cAAc,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC;QAExE,MAAc,CAAC,iBAAiB,GAAG;YAClC,KAAK,EAAE,KAAK;SACb,CAAC;QAEF,GAAG,CAAC,WAAW,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC;QACzC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,oBAAoB,CAAC,cAAc,EAAE;YACnD,OAAO,EAAE,SAAS;SACnB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
@@ -1 +1,2 @@
1
+ export * from "./messaging.types";
1
2
  export * from "./messaging";
@@ -1,2 +1,3 @@
1
+ export * from "./messaging.types";
1
2
  export * from "./messaging";
2
3
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/messaging/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/messaging/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC"}
@@ -1,4 +1,15 @@
1
- import { BridgeError, BridgeRequest } from "../types";
1
+ import { BridgeError } from "../types";
2
+ import { BridgeRequest, BridgeResponse } from "./messaging.types";
3
+ declare global {
4
+ interface Window {
5
+ FlipFlutter: {
6
+ postMessage: (message: string) => void;
7
+ };
8
+ }
9
+ }
10
+ export declare function isFlutterApp(): boolean;
2
11
  export declare function postMessage(message: BridgeRequest): void;
3
12
  export declare function makeRequest<Result>(request: BridgeRequest): Promise<Result | BridgeError>;
13
+ export declare function getRequestHandler<Result>(request: BridgeRequest, resolve: (value: Result | PromiseLike<Result>) => void, reject: (error: BridgeError) => void): (event: MessageEvent<BridgeResponse>) => void;
14
+ export declare function isResponse(message: Object): message is BridgeResponse;
4
15
  export declare function isAllowedOrigin(origin: string): boolean;
@@ -1,43 +1,70 @@
1
1
  import { log } from "../logging";
2
- import { BridgeErrorCode, } from "../types";
3
- const hostAppOrigin = process.env.HOST_APP_ORIGIN || "http://localhost:4200";
2
+ import { BridgeErrorCode } from "../types";
3
+ export function isFlutterApp() {
4
+ return "FlipFlutter" in window;
5
+ }
4
6
  export function postMessage(message) {
5
- if (!window.top) {
7
+ var _a, _b;
8
+ const isFlutter = isFlutterApp();
9
+ if (!window.top && !isFlutter) {
6
10
  return;
7
11
  }
8
- window.top.postMessage(message, hostAppOrigin);
12
+ const hostAppOrigin = (_a = window.flipBridgeOptions) === null || _a === void 0 ? void 0 : _a.hostAppOrigin;
13
+ if (!hostAppOrigin) {
14
+ throw Error(`Please call 'initFlipBridge'.`);
15
+ }
16
+ if (isFlutter) {
17
+ window.FlipFlutter.postMessage(JSON.stringify(message));
18
+ }
19
+ else {
20
+ (_b = window.top) === null || _b === void 0 ? void 0 : _b.postMessage(message, hostAppOrigin);
21
+ }
9
22
  log("postMessage", {
10
23
  message,
24
+ isFlutter,
11
25
  targetOrigin: hostAppOrigin,
12
26
  });
13
27
  }
14
28
  export function makeRequest(request) {
15
29
  return new Promise((resolve, reject) => {
16
- const handler = (event) => {
17
- if (!isAllowedOrigin(event.origin)) {
18
- reject({
19
- code: BridgeErrorCode.FORBIDDEN_ORIGIN,
20
- });
21
- return;
22
- }
23
- if (event.data.id === request.id) {
24
- log("handleResponse", event.data);
25
- window.removeEventListener("message", handler);
26
- if (event.data.error) {
27
- reject(event.data.error);
28
- }
29
- else {
30
- resolve(event.data.result);
31
- }
32
- }
33
- };
30
+ const handler = getRequestHandler(request, resolve, reject);
34
31
  window.addEventListener("message", handler);
35
32
  postMessage(request);
36
33
  });
37
34
  }
35
+ export function getRequestHandler(request, resolve, reject) {
36
+ const handler = (event) => {
37
+ if (!isResponse(event.data) || event.data.id !== request.id) {
38
+ return;
39
+ }
40
+ if (!isAllowedOrigin(event.origin)) {
41
+ reject({
42
+ code: BridgeErrorCode.FORBIDDEN_ORIGIN,
43
+ });
44
+ return;
45
+ }
46
+ log("handleResponse", event.data);
47
+ window.removeEventListener("message", handler);
48
+ if (event.data.error) {
49
+ reject(event.data.error);
50
+ }
51
+ else {
52
+ resolve(event.data.result);
53
+ }
54
+ };
55
+ return handler;
56
+ }
57
+ export function isResponse(message) {
58
+ return (typeof message === "object" &&
59
+ "id" in message &&
60
+ ("result" in message || "error" in message));
61
+ }
38
62
  export function isAllowedOrigin(origin) {
39
- // TODO: check origin
40
- console.log(origin);
41
- return true;
63
+ var _a;
64
+ if (isFlutterApp()) {
65
+ return true;
66
+ }
67
+ const hostAppOrigin = (_a = window.flipBridgeOptions) === null || _a === void 0 ? void 0 : _a.hostAppOrigin;
68
+ return origin === hostAppOrigin;
42
69
  }
43
70
  //# sourceMappingURL=messaging.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"messaging.js","sourceRoot":"","sources":["../../src/messaging/messaging.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC;AACjC,OAAO,EAEL,eAAe,GAGhB,MAAM,UAAU,CAAC;AAElB,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,IAAI,uBAAuB,CAAC;AAE7E,MAAM,UAAU,WAAW,CAAC,OAAsB;IAChD,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE;QACf,OAAO;KACR;IAED,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;IAE/C,GAAG,CAAC,aAAa,EAAE;QACjB,OAAO;QACP,YAAY,EAAE,aAAa;KAC5B,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,WAAW,CACzB,OAAsB;IAEtB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,CAAC,KAAmC,EAAE,EAAE;YACtD,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE;gBAClC,MAAM,CAAC;oBACL,IAAI,EAAE,eAAe,CAAC,gBAAgB;iBACxB,CAAC,CAAC;gBAElB,OAAO;aACR;YAED,IAAI,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,OAAO,CAAC,EAAE,EAAE;gBAChC,GAAG,CAAC,gBAAgB,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;gBAElC,MAAM,CAAC,mBAAmB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;gBAE/C,IAAI,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE;oBACpB,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,KAAoB,CAAC,CAAC;iBACzC;qBAAM;oBACL,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,MAAgB,CAAC,CAAC;iBACtC;aACF;QACH,CAAC,CAAC;QAEF,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QAC5C,WAAW,CAAC,OAAO,CAAC,CAAC;IACvB,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,MAAc;IAC5C,qBAAqB;IACrB,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAEpB,OAAO,IAAI,CAAC;AACd,CAAC"}
1
+ {"version":3,"file":"messaging.js","sourceRoot":"","sources":["../../src/messaging/messaging.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC;AACjC,OAAO,EAAe,eAAe,EAAE,MAAM,UAAU,CAAC;AAWxD,MAAM,UAAU,YAAY;IAC1B,OAAO,aAAa,IAAI,MAAM,CAAC;AACjC,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,OAAsB;;IAChD,MAAM,SAAS,GAAG,YAAY,EAAE,CAAC;IAEjC,IAAI,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,SAAS,EAAE;QAC7B,OAAO;KACR;IAED,MAAM,aAAa,GAAG,MAAA,MAAM,CAAC,iBAAiB,0CAAE,aAAa,CAAC;IAE9D,IAAI,CAAC,aAAa,EAAE;QAClB,MAAM,KAAK,CAAC,+BAA+B,CAAC,CAAC;KAC9C;IAED,IAAI,SAAS,EAAE;QACb,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;KACzD;SAAM;QACL,MAAA,MAAM,CAAC,GAAG,0CAAE,WAAW,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;KACjD;IAED,GAAG,CAAC,aAAa,EAAE;QACjB,OAAO;QACP,SAAS;QACT,YAAY,EAAE,aAAa;KAC5B,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,WAAW,CACzB,OAAsB;IAEtB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAE5D,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QAC5C,WAAW,CAAC,OAAO,CAAC,CAAC;IACvB,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,iBAAiB,CAC/B,OAAsB,EACtB,OAAsD,EACtD,MAAoC;IAEpC,MAAM,OAAO,GAAG,CAAC,KAAmC,EAAE,EAAE;QACtD,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,OAAO,CAAC,EAAE,EAAE;YAC3D,OAAO;SACR;QAED,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE;YAClC,MAAM,CAAC;gBACL,IAAI,EAAE,eAAe,CAAC,gBAAgB;aACxB,CAAC,CAAC;YAElB,OAAO;SACR;QAED,GAAG,CAAC,gBAAgB,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;QAElC,MAAM,CAAC,mBAAmB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QAE/C,IAAI,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE;YACpB,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,KAAoB,CAAC,CAAC;SACzC;aAAM;YACL,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,MAAgB,CAAC,CAAC;SACtC;IACH,CAAC,CAAC;IAEF,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,OAAe;IACxC,OAAO,CACL,OAAO,OAAO,KAAK,QAAQ;QAC3B,IAAI,IAAI,OAAO;QACf,CAAC,QAAQ,IAAI,OAAO,IAAI,OAAO,IAAI,OAAO,CAAC,CAC5C,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,MAAc;;IAC5C,IAAI,YAAY,EAAE,EAAE;QAClB,OAAO,IAAI,CAAC;KACb;IAED,MAAM,aAAa,GAAG,MAAA,MAAM,CAAC,iBAAiB,0CAAE,aAAa,CAAC;IAE9D,OAAO,MAAM,KAAK,aAAa,CAAC;AAClC,CAAC"}
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,59 @@
1
+ import { BridgeErrorCode, BridgeMethod } from "../types";
2
+ import { isAllowedOrigin, isFlutterApp, isResponse, postMessage, } from "./messaging";
3
+ describe("messaging", () => {
4
+ const request = {
5
+ id: "ID",
6
+ method: BridgeMethod.NAVIGATE,
7
+ params: { path: "/" },
8
+ };
9
+ beforeEach(() => {
10
+ global.flipBridgeOptions = { hostAppOrigin: "http://localhost" };
11
+ });
12
+ test("'postMessage' fails without init call", async () => {
13
+ global.flipBridgeOptions = undefined;
14
+ const postMessageWrapper = () => postMessage(request);
15
+ expect(postMessageWrapper).toThrowError("Please call 'initFlipBridge'.");
16
+ });
17
+ test("'postMessage' posts a request", async () => {
18
+ const spy = jest.fn();
19
+ window.top.postMessage = spy;
20
+ postMessage(request);
21
+ expect(spy).toHaveBeenCalledWith(request, "http://localhost");
22
+ });
23
+ test("'postMessage' posts a request within the Flutter app", async () => {
24
+ const spy = jest.fn();
25
+ global.FlipFlutter = { postMessage: spy };
26
+ postMessage(request);
27
+ expect(isFlutterApp()).toBeTruthy();
28
+ expect(spy).toHaveBeenCalledWith(JSON.stringify(request));
29
+ delete global.FlipFlutter;
30
+ });
31
+ test("'isResponse' checks response type", async () => {
32
+ expect(isResponse({})).toBe(false);
33
+ expect(isResponse({
34
+ id: "test",
35
+ })).toBe(false);
36
+ expect(isResponse({
37
+ id: "test",
38
+ error: {
39
+ code: BridgeErrorCode.FORBIDDEN_ORIGIN,
40
+ },
41
+ })).toBe(true);
42
+ expect(isResponse({
43
+ id: "test",
44
+ result: true,
45
+ })).toBe(true);
46
+ expect(isResponse({
47
+ error: {
48
+ code: BridgeErrorCode.FORBIDDEN_ORIGIN,
49
+ },
50
+ })).toBe(false);
51
+ });
52
+ test("'isAllowedOrigin' validates origins", async () => {
53
+ expect(isAllowedOrigin("http://")).toBe(false);
54
+ expect(isAllowedOrigin("")).toBe(false);
55
+ expect(isAllowedOrigin("http://localhost:3000")).toBe(false);
56
+ expect(isAllowedOrigin("http://localhost")).toBe(true);
57
+ });
58
+ });
59
+ //# sourceMappingURL=messaging.spec.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"messaging.spec.js","sourceRoot":"","sources":["../../src/messaging/messaging.spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAEzD,OAAO,EACL,eAAe,EACf,YAAY,EACZ,UAAU,EACV,WAAW,GACZ,MAAM,aAAa,CAAC;AAErB,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IACzB,MAAM,OAAO,GAAkB;QAC7B,EAAE,EAAE,IAAI;QACR,MAAM,EAAE,YAAY,CAAC,QAAQ;QAC7B,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE;KACtB,CAAC;IAEF,UAAU,CAAC,GAAG,EAAE;QACb,MAAc,CAAC,iBAAiB,GAAG,EAAE,aAAa,EAAE,kBAAkB,EAAE,CAAC;IAC5E,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,uCAAuC,EAAE,KAAK,IAAI,EAAE;QACtD,MAAc,CAAC,iBAAiB,GAAG,SAAS,CAAC;QAE9C,MAAM,kBAAkB,GAAG,GAAG,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAEtD,MAAM,CAAC,kBAAkB,CAAC,CAAC,YAAY,CAAC,+BAA+B,CAAC,CAAC;IAC3E,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,+BAA+B,EAAE,KAAK,IAAI,EAAE;QAC/C,MAAM,GAAG,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;QAErB,MAAM,CAAC,GAAW,CAAC,WAAW,GAAG,GAAG,CAAC;QAEtC,WAAW,CAAC,OAAO,CAAC,CAAC;QACrB,MAAM,CAAC,GAAG,CAAC,CAAC,oBAAoB,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,sDAAsD,EAAE,KAAK,IAAI,EAAE;QACtE,MAAM,GAAG,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;QAErB,MAAc,CAAC,WAAW,GAAG,EAAE,WAAW,EAAE,GAAG,EAAE,CAAC;QAEnD,WAAW,CAAC,OAAO,CAAC,CAAC;QAErB,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC;QACpC,MAAM,CAAC,GAAG,CAAC,CAAC,oBAAoB,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;QAE1D,OAAQ,MAAc,CAAC,WAAW,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,mCAAmC,EAAE,KAAK,IAAI,EAAE;QACnD,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAEnC,MAAM,CACJ,UAAU,CAAC;YACT,EAAE,EAAE,MAAM;SACX,CAAC,CACH,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAEd,MAAM,CACJ,UAAU,CAAC;YACT,EAAE,EAAE,MAAM;YACV,KAAK,EAAE;gBACL,IAAI,EAAE,eAAe,CAAC,gBAAgB;aACvC;SACF,CAAC,CACH,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEb,MAAM,CACJ,UAAU,CAAC;YACT,EAAE,EAAE,MAAM;YACV,MAAM,EAAE,IAAI;SACb,CAAC,CACH,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEb,MAAM,CACJ,UAAU,CAAC;YACT,KAAK,EAAE;gBACL,IAAI,EAAE,eAAe,CAAC,gBAAgB;aACvC;SACF,CAAC,CACH,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAChB,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;QACrD,MAAM,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/C,MAAM,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxC,MAAM,CAAC,eAAe,CAAC,uBAAuB,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC7D,MAAM,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
@@ -0,0 +1,11 @@
1
+ import { BridgeError, BridgeMethod, BridgeMethodResultMapping } from "../types";
2
+ export type BridgeRequest<WithMethod extends BridgeMethod | unknown = unknown, WithParams = Record<string, unknown> | Array<unknown>> = {
3
+ id: string;
4
+ method: WithMethod;
5
+ params?: WithParams;
6
+ };
7
+ export type BridgeResponse<ForMethod extends BridgeMethod | unknown = unknown> = {
8
+ id: string;
9
+ error?: BridgeError;
10
+ result?: ForMethod extends BridgeMethod ? BridgeMethodResultMapping[ForMethod] : unknown;
11
+ };
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=messaging.types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"messaging.types.js","sourceRoot":"","sources":["../../src/messaging/messaging.types.ts"],"names":[],"mappings":""}
@@ -1 +1 @@
1
- {"version":3,"file":"navigation.js","sourceRoot":"","sources":["../../src/navigation/navigation.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;AAGxC,MAAM,UAAU,QAAQ,CAAC,IAAY;IACnC,MAAM,OAAO,GAAoB;QAC/B,EAAE,EAAE,MAAM,EAAE;QACZ,MAAM,EAAE,YAAY,CAAC,QAAQ;QAC7B,MAAM,EAAE,EAAE,IAAI,EAAE;KACjB,CAAC;IAEF,OAAO,WAAW,CAAoB,OAAO,CAAC,CAAC;AACjD,CAAC"}
1
+ {"version":3,"file":"navigation.js","sourceRoot":"","sources":["../../src/navigation/navigation.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;AAGxC,MAAM,UAAU,QAAQ,CAAC,IAAY;IACnC,MAAM,OAAO,GAAoB;QAC/B,EAAE,EAAE,MAAM,EAAE;QACZ,MAAM,EAAE,YAAY,CAAC,QAAQ;QAC7B,MAAM,EAAE,EAAE,IAAI,EAAE;KACjB,CAAC;IAEF,OAAO,WAAW,CAAiB,OAAO,CAAC,CAAC;AAC9C,CAAC"}
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,22 @@
1
+ import { makeRequest } from "../messaging";
2
+ import { navigate } from "./navigation";
3
+ jest.mock("../messaging", () => ({
4
+ makeRequest: jest.fn(),
5
+ }));
6
+ describe("navigation", () => {
7
+ beforeAll(() => {
8
+ global.flipBridgeOptions = { hostAppOrigin: "http://localhost" };
9
+ });
10
+ test("'navigate' sends correct request", async () => {
11
+ await navigate("/route");
12
+ const makeRequestMock = makeRequest;
13
+ expect(makeRequestMock).toHaveBeenCalledWith({
14
+ id: makeRequestMock.mock.calls[0][0].id,
15
+ method: "NAVIGATE",
16
+ params: {
17
+ path: "/route",
18
+ },
19
+ });
20
+ });
21
+ });
22
+ //# sourceMappingURL=navigation.spec.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"navigation.spec.js","sourceRoot":"","sources":["../../src/navigation/navigation.spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAExC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,GAAG,EAAE,CAAC,CAAC;IAC/B,WAAW,EAAE,IAAI,CAAC,EAAE,EAAE;CACvB,CAAC,CAAC,CAAC;AAEJ,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IAC1B,SAAS,CAAC,GAAG,EAAE;QACZ,MAAc,CAAC,iBAAiB,GAAG,EAAE,aAAa,EAAE,kBAAkB,EAAE,CAAC;IAC5E,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;QAClD,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAEzB,MAAM,eAAe,GAAG,WAEvB,CAAC;QAEF,MAAM,CAAC,eAAe,CAAC,CAAC,oBAAoB,CAAC;YAC3C,EAAE,EAAE,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE;YACvC,MAAM,EAAE,UAAU;YAClB,MAAM,EAAE;gBACN,IAAI,EAAE,QAAQ;aACf;SACF,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
@@ -1,5 +1,6 @@
1
- import { BridgeMethod, BridgeRequest } from "../types";
1
+ import { BridgeMethod } from "../types";
2
+ import { BridgeRequest } from "../messaging/messaging.types";
2
3
  export type NavigateRequest = BridgeRequest<BridgeMethod.NAVIGATE, {
3
4
  path: string;
4
5
  }>;
5
- export type GetNavigateResult = boolean;
6
+ export type NavigateResult = boolean;
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,19 @@
1
+ import { makeRequest } from "../messaging";
2
+ import { getTheme } from "./theming";
3
+ jest.mock("../messaging", () => ({
4
+ makeRequest: jest.fn(),
5
+ }));
6
+ describe("theming", () => {
7
+ beforeAll(() => {
8
+ global.flipBridgeOptions = { hostAppOrigin: "http://localhost" };
9
+ });
10
+ test("'getTheme' sends correct request", async () => {
11
+ await getTheme();
12
+ const makeRequestMock = makeRequest;
13
+ expect(makeRequestMock).toHaveBeenCalledWith({
14
+ id: makeRequestMock.mock.calls[0][0].id,
15
+ method: "GET_THEME",
16
+ });
17
+ });
18
+ });
19
+ //# sourceMappingURL=theming.spec.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"theming.spec.js","sourceRoot":"","sources":["../../src/theming/theming.spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAErC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,GAAG,EAAE,CAAC,CAAC;IAC/B,WAAW,EAAE,IAAI,CAAC,EAAE,EAAE;CACvB,CAAC,CAAC,CAAC;AAEJ,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;IACvB,SAAS,CAAC,GAAG,EAAE;QACZ,MAAc,CAAC,iBAAiB,GAAG,EAAE,aAAa,EAAE,kBAAkB,EAAE,CAAC;IAC5E,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;QAClD,MAAM,QAAQ,EAAE,CAAC;QAEjB,MAAM,eAAe,GAAG,WAEvB,CAAC;QAEF,MAAM,CAAC,eAAe,CAAC,CAAC,oBAAoB,CAAC;YAC3C,EAAE,EAAE,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE;YACvC,MAAM,EAAE,WAAW;SACpB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
@@ -1,7 +1,8 @@
1
1
  import { FlipTheme } from "@getflip/swirl-components/dist/types/components/flip-theme-provider/flip-theme-provider";
2
- import { BridgeMethod, BridgeRequest } from "../types";
2
+ import { BridgeMethod } from "../types";
3
+ import { BridgeRequest } from "../messaging/messaging.types";
3
4
  export type GetThemeRequest = BridgeRequest<BridgeMethod.GET_THEME, undefined>;
4
5
  export type GetThemeResult = {
5
6
  activeTheme: FlipTheme;
6
- preferredTheme: FlipTheme;
7
+ preferredTheme: FlipTheme | undefined;
7
8
  };
package/dist/types.d.ts CHANGED
@@ -1,31 +1,40 @@
1
+ import { CloseDialogResult, CreateDialogResult, DestroyDialogResult, OpenDialogResult } from "./dialog";
2
+ import { SubscribeResult, UnsubscribeResult } from "./events/events.types";
1
3
  import { GetAvailableLangsResult, GetLangResult } from "./i18n";
2
- import { GetNavigateResult } from "./navigation";
4
+ import { NavigateResult } from "./navigation";
3
5
  import { GetThemeResult } from "./theming";
4
- export type BridgeRequest<WithMethod extends BridgeMethod | unknown = unknown, WithParams = Record<string, unknown> | Array<unknown>> = {
5
- id: string;
6
- method: WithMethod;
7
- params?: WithParams;
8
- };
9
- export type BridgeResponse<ForMethod extends BridgeMethod | unknown = unknown> = {
10
- id: string;
11
- error?: BridgeError;
12
- result: ForMethod extends BridgeMethod ? BridgeMethodResultMapping[ForMethod] : unknown;
6
+ export type BridgeOptions = {
7
+ debug?: boolean;
8
+ hostAppOrigin: string;
13
9
  };
14
10
  export type BridgeError = {
15
11
  code: BridgeErrorCode;
16
12
  };
17
13
  export declare enum BridgeErrorCode {
18
- FORBIDDEN_ORIGIN = "FORBIDDEN_ORIGIN"
14
+ FORBIDDEN_ORIGIN = "FORBIDDEN_ORIGIN",
15
+ INVALID_REQUEST = "INVALID_REQUEST"
19
16
  }
20
17
  export declare enum BridgeMethod {
18
+ CLOSE_DIALOG = "CLOSE_DIALOG",
19
+ CREATE_DIALOG = "CREATE_DIALOG",
20
+ DESTROY_DIALOG = "DESTROY_DIALOG",
21
21
  GET_AVAILABLE_LANGS = "GET_AVAILABLE_LANGS",
22
22
  GET_LANG = "GET_LANG",
23
23
  GET_THEME = "GET_THEME",
24
- NAVIGATE = "NAVIGATE"
24
+ NAVIGATE = "NAVIGATE",
25
+ OPEN_DIALOG = "OPEN_DIALOG",
26
+ SUBSCRIBE = "SUBSCRIBE",
27
+ UNSUBSCRIBE = "UNSUBSCRIBE"
25
28
  }
26
29
  export type BridgeMethodResultMapping = {
30
+ [BridgeMethod.CLOSE_DIALOG]: CloseDialogResult;
31
+ [BridgeMethod.CREATE_DIALOG]: CreateDialogResult;
32
+ [BridgeMethod.DESTROY_DIALOG]: DestroyDialogResult;
27
33
  [BridgeMethod.GET_AVAILABLE_LANGS]: GetAvailableLangsResult;
28
34
  [BridgeMethod.GET_LANG]: GetLangResult;
29
35
  [BridgeMethod.GET_THEME]: GetThemeResult;
30
- [BridgeMethod.NAVIGATE]: GetNavigateResult;
36
+ [BridgeMethod.NAVIGATE]: NavigateResult;
37
+ [BridgeMethod.OPEN_DIALOG]: OpenDialogResult;
38
+ [BridgeMethod.SUBSCRIBE]: SubscribeResult;
39
+ [BridgeMethod.UNSUBSCRIBE]: UnsubscribeResult;
31
40
  };
package/dist/types.js CHANGED
@@ -1,12 +1,19 @@
1
1
  export var BridgeErrorCode;
2
2
  (function (BridgeErrorCode) {
3
3
  BridgeErrorCode["FORBIDDEN_ORIGIN"] = "FORBIDDEN_ORIGIN";
4
+ BridgeErrorCode["INVALID_REQUEST"] = "INVALID_REQUEST";
4
5
  })(BridgeErrorCode || (BridgeErrorCode = {}));
5
6
  export var BridgeMethod;
6
7
  (function (BridgeMethod) {
8
+ BridgeMethod["CLOSE_DIALOG"] = "CLOSE_DIALOG";
9
+ BridgeMethod["CREATE_DIALOG"] = "CREATE_DIALOG";
10
+ BridgeMethod["DESTROY_DIALOG"] = "DESTROY_DIALOG";
7
11
  BridgeMethod["GET_AVAILABLE_LANGS"] = "GET_AVAILABLE_LANGS";
8
12
  BridgeMethod["GET_LANG"] = "GET_LANG";
9
13
  BridgeMethod["GET_THEME"] = "GET_THEME";
10
14
  BridgeMethod["NAVIGATE"] = "NAVIGATE";
15
+ BridgeMethod["OPEN_DIALOG"] = "OPEN_DIALOG";
16
+ BridgeMethod["SUBSCRIBE"] = "SUBSCRIBE";
17
+ BridgeMethod["UNSUBSCRIBE"] = "UNSUBSCRIBE";
11
18
  })(BridgeMethod || (BridgeMethod = {}));
12
19
  //# sourceMappingURL=types.js.map
package/dist/types.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AA0BA,MAAM,CAAN,IAAY,eAEX;AAFD,WAAY,eAAe;IACzB,wDAAqC,CAAA;AACvC,CAAC,EAFW,eAAe,KAAf,eAAe,QAE1B;AAED,MAAM,CAAN,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,2DAA2C,CAAA;IAC3C,qCAAqB,CAAA;IACrB,uCAAuB,CAAA;IACvB,qCAAqB,CAAA;AACvB,CAAC,EALW,YAAY,KAAZ,YAAY,QAKvB"}
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAoBA,MAAM,CAAN,IAAY,eAGX;AAHD,WAAY,eAAe;IACzB,wDAAqC,CAAA;IACrC,sDAAmC,CAAA;AACrC,CAAC,EAHW,eAAe,KAAf,eAAe,QAG1B;AAED,MAAM,CAAN,IAAY,YAWX;AAXD,WAAY,YAAY;IACtB,6CAA6B,CAAA;IAC7B,+CAA+B,CAAA;IAC/B,iDAAiC,CAAA;IACjC,2DAA2C,CAAA;IAC3C,qCAAqB,CAAA;IACrB,uCAAuB,CAAA;IACvB,qCAAqB,CAAA;IACrB,2CAA2B,CAAA;IAC3B,uCAAuB,CAAA;IACvB,2CAA2B,CAAA;AAC7B,CAAC,EAXW,YAAY,KAAZ,YAAY,QAWvB"}
package/package.json CHANGED
@@ -1,24 +1,37 @@
1
1
  {
2
2
  "name": "@getflip/bridge",
3
- "version": "0.1.0-alpha.1",
3
+ "version": "0.1.0-alpha.10",
4
4
  "description": "Flip JavaScript Bridge for external integrations.",
5
- "main": "dist/index.js",
5
+ "main": "dist/index.cjs.js",
6
+ "module": "dist/index.mjs",
7
+ "types": "dist/index.d.ts",
6
8
  "repository": "https://github.com/getflip/swirl",
7
9
  "license": "SEE LICENSE IN LICENSE.md",
8
10
  "files": [
9
11
  "dist/"
10
12
  ],
11
13
  "scripts": {
12
- "build": "tsc",
14
+ "build": "rimraf dist && tsc && rollup -c rollup.config.mjs",
13
15
  "dev": "tsc -w",
14
- "start": "yarn dev"
16
+ "start": "yarn dev",
17
+ "test": "jest",
18
+ "test:watch": "jest --watchAll"
15
19
  },
16
20
  "dependencies": {
17
21
  "@getflip/swirl-components": "^0.8.4",
18
22
  "uuid": "^9.0.0"
19
23
  },
20
24
  "devDependencies": {
25
+ "@babel/core": "^7.20.5",
26
+ "@babel/preset-env": "^7.20.2",
27
+ "@babel/preset-typescript": "^7.18.6",
28
+ "@rollup/plugin-typescript": "^10.0.1",
29
+ "@types/jest": "^27.0.3",
21
30
  "@types/uuid": "^8.3.4",
31
+ "babel-jest": "^29.3.1",
32
+ "jest": "^27.4.5",
33
+ "rimraf": "^3.0.2",
34
+ "rollup": "^3.5.1",
22
35
  "typescript": "^4.9.3"
23
36
  }
24
37
  }
package/dist/bridge.d.ts DELETED
@@ -1,7 +0,0 @@
1
- declare global {
2
- interface Window {
3
- flipBridgeConnected: boolean;
4
- }
5
- }
6
- export declare function connectBridge(): void;
7
- export declare function disconnectBridge(): void;
package/dist/bridge.js DELETED
@@ -1,19 +0,0 @@
1
- import { handleResponse } from "./messaging";
2
- function handlePostMessage(event) {
3
- handleResponse(event.data);
4
- }
5
- export function connectBridge() {
6
- if (window.flipBridgeConnected) {
7
- return;
8
- }
9
- window.addEventListener("message", handlePostMessage);
10
- window.flipBridgeConnected = true;
11
- }
12
- export function disconnectBridge() {
13
- if (!window.flipBridgeConnected) {
14
- return;
15
- }
16
- window.removeEventListener("message", handlePostMessage);
17
- window.flipBridgeConnected = false;
18
- }
19
- //# sourceMappingURL=bridge.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"bridge.js","sourceRoot":"","sources":["../src/bridge.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAQ7C,SAAS,iBAAiB,CAAC,KAAmB;IAC5C,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AAC7B,CAAC;AAED,MAAM,UAAU,aAAa;IAC3B,IAAI,MAAM,CAAC,mBAAmB,EAAE;QAC9B,OAAO;KACR;IAED,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;IACtD,MAAM,CAAC,mBAAmB,GAAG,IAAI,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,gBAAgB;IAC9B,IAAI,CAAC,MAAM,CAAC,mBAAmB,EAAE;QAC/B,OAAO;KACR;IAED,MAAM,CAAC,mBAAmB,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;IACzD,MAAM,CAAC,mBAAmB,GAAG,KAAK,CAAC;AACrC,CAAC"}