@getflip/bridge 0.1.0-alpha.1

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 (51) hide show
  1. package/LICENSE.md +25 -0
  2. package/README.md +101 -0
  3. package/dist/bridge.d.ts +7 -0
  4. package/dist/bridge.js +19 -0
  5. package/dist/bridge.js.map +1 -0
  6. package/dist/i18n/i18n.d.ts +3 -0
  7. package/dist/i18n/i18n.js +18 -0
  8. package/dist/i18n/i18n.js.map +1 -0
  9. package/dist/i18n/i18n.types.d.ts +5 -0
  10. package/dist/i18n/i18n.types.js +2 -0
  11. package/dist/i18n/i18n.types.js.map +1 -0
  12. package/dist/i18n/index.d.ts +2 -0
  13. package/dist/i18n/index.js +3 -0
  14. package/dist/i18n/index.js.map +1 -0
  15. package/dist/index.d.ts +4 -0
  16. package/dist/index.js +5 -0
  17. package/dist/index.js.map +1 -0
  18. package/dist/logging/index.d.ts +1 -0
  19. package/dist/logging/index.js +2 -0
  20. package/dist/logging/index.js.map +1 -0
  21. package/dist/logging/logging.d.ts +1 -0
  22. package/dist/logging/logging.js +7 -0
  23. package/dist/logging/logging.js.map +1 -0
  24. package/dist/messaging/index.d.ts +1 -0
  25. package/dist/messaging/index.js +2 -0
  26. package/dist/messaging/index.js.map +1 -0
  27. package/dist/messaging/messaging.d.ts +4 -0
  28. package/dist/messaging/messaging.js +43 -0
  29. package/dist/messaging/messaging.js.map +1 -0
  30. package/dist/navigation/index.d.ts +2 -0
  31. package/dist/navigation/index.js +3 -0
  32. package/dist/navigation/index.js.map +1 -0
  33. package/dist/navigation/navigation.d.ts +1 -0
  34. package/dist/navigation/navigation.js +12 -0
  35. package/dist/navigation/navigation.js.map +1 -0
  36. package/dist/navigation/navigation.types.d.ts +5 -0
  37. package/dist/navigation/navigation.types.js +2 -0
  38. package/dist/navigation/navigation.types.js.map +1 -0
  39. package/dist/theming/index.d.ts +2 -0
  40. package/dist/theming/index.js +3 -0
  41. package/dist/theming/index.js.map +1 -0
  42. package/dist/theming/theming.d.ts +2 -0
  43. package/dist/theming/theming.js +11 -0
  44. package/dist/theming/theming.js.map +1 -0
  45. package/dist/theming/theming.types.d.ts +7 -0
  46. package/dist/theming/theming.types.js +2 -0
  47. package/dist/theming/theming.types.js.map +1 -0
  48. package/dist/types.d.ts +31 -0
  49. package/dist/types.js +12 -0
  50. package/dist/types.js.map +1 -0
  51. package/package.json +24 -0
package/LICENSE.md ADDED
@@ -0,0 +1,25 @@
1
+ Copyright (c) 2022-present Flip GmbH
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining a copy of
4
+ this software and associated documentation files (the "Software"), to deal in
5
+ the Software without restriction, including without limitation the rights to
6
+ use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
7
+ the Software, and to permit persons to whom the Software is furnished to do so,
8
+ subject to the following conditions:
9
+
10
+ The above copyright notice and this permission notice shall be included in all
11
+ copies or substantial portions of the Software.
12
+
13
+ The rights granted above may only be exercised to develop and distribute
14
+ applications that integrate or interoperate with Flip software or services, and
15
+ in the case of external, stand-alone applications that do not embed directly
16
+ inside Flip, the rights granted above may only be exercised to develop and
17
+ distribute applications that are dissimilar and visually distinct from Flip
18
+ products and services, as determined by Flip in its sole discretion.
19
+
20
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
22
+ FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
23
+ COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
24
+ IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
25
+ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,101 @@
1
+ # Flip Bridge
2
+
3
+ The Flip Bridge handles communication between your embeddable apps and the Flip
4
+ App or Flip Admin Console.
5
+
6
+ **Contents**
7
+
8
+ - [Installation](#installation)
9
+ - [Usage](#usage)
10
+ - [Internationalization](#internationalization)
11
+ - [Navigation](#navigation)
12
+ - [Theming](#theming)
13
+ - [Development](#development)
14
+
15
+ ## Installation
16
+
17
+ ```sh
18
+ npm install --save @getflip/bridge
19
+ # or
20
+ yarn add @getflip/bridge
21
+ ```
22
+
23
+ ## Usage
24
+
25
+ The library exposes a set of functions and listeners you can use to communicate
26
+ with the Flip App and Flip Admin Console (host app for short).
27
+
28
+ ### Internationalization
29
+
30
+ #### `getAvailableLangs`
31
+
32
+ Get all available languages of the host app.
33
+
34
+ **Returns** `string[]`
35
+
36
+ **Example**
37
+
38
+ ```js
39
+ import { getAvailableLangs } from "@getflip/bridge";
40
+
41
+ const availableLanguages = await getAvailableLangs(); // e.g. ['de', 'en', 'fr', …]
42
+ ```
43
+
44
+ #### `getLang`
45
+
46
+ Get the current language of the host app.
47
+
48
+ **Returns** `string`
49
+
50
+ **Example**
51
+
52
+ ```js
53
+ import { getLang } from "@getflip/bridge";
54
+
55
+ const currentLanguage = await getLang(); // e.g. 'en'
56
+ ```
57
+
58
+ ### Navigation
59
+
60
+ #### `navigate`
61
+
62
+ Navigate to a specific route.
63
+
64
+ **Returns** `boolean`
65
+
66
+ **Example**
67
+
68
+ ```js
69
+ import { navigate } from "@getflip/bridge";
70
+
71
+ await navigate("/my-app/settings");
72
+ ```
73
+
74
+ ### Theming
75
+
76
+ #### `getTheme`
77
+
78
+ Get the current theme.
79
+
80
+ **Returns** `'light' | 'dark'`
81
+
82
+ **Example**
83
+
84
+ ```js
85
+ import { getTheme } from "@getflip/bridge";
86
+
87
+ const currentTheme = await getTheme(); // e.g. 'light'
88
+ ```
89
+
90
+ ## Development
91
+
92
+ Start the compiler in watch mode for local development:
93
+
94
+ ```
95
+ yarn
96
+ yarn dev
97
+ ```
98
+
99
+ Production builds and releases are managed via our Github workflows. Make sure
100
+ to create a Changeset using `yarn changeset` if you want to trigger a new
101
+ release.
@@ -0,0 +1,7 @@
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 ADDED
@@ -0,0 +1,19 @@
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
@@ -0,0 +1 @@
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"}
@@ -0,0 +1,3 @@
1
+ import { GetAvailableLangsResult } from "./i18n.types";
2
+ export declare function getAvailableLangs(): Promise<import("../types").BridgeError | GetAvailableLangsResult>;
3
+ export declare function getLang(): Promise<string | import("../types").BridgeError>;
@@ -0,0 +1,18 @@
1
+ import { v4 as uuidv4 } from "uuid";
2
+ import { makeRequest } from "../messaging";
3
+ import { BridgeMethod } from "../types";
4
+ export function getAvailableLangs() {
5
+ const request = {
6
+ id: uuidv4(),
7
+ method: BridgeMethod.GET_AVAILABLE_LANGS,
8
+ };
9
+ return makeRequest(request);
10
+ }
11
+ export function getLang() {
12
+ const request = {
13
+ id: uuidv4(),
14
+ method: BridgeMethod.GET_LANG,
15
+ };
16
+ return makeRequest(request);
17
+ }
18
+ //# sourceMappingURL=i18n.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"i18n.js","sourceRoot":"","sources":["../../src/i18n/i18n.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;AAQxC,MAAM,UAAU,iBAAiB;IAC/B,MAAM,OAAO,GAA6B;QACxC,EAAE,EAAE,MAAM,EAAE;QACZ,MAAM,EAAE,YAAY,CAAC,mBAAmB;KACzC,CAAC;IAEF,OAAO,WAAW,CAA0B,OAAO,CAAC,CAAC;AACvD,CAAC;AAED,MAAM,UAAU,OAAO;IACrB,MAAM,OAAO,GAAmB;QAC9B,EAAE,EAAE,MAAM,EAAE;QACZ,MAAM,EAAE,YAAY,CAAC,QAAQ;KAC9B,CAAC;IAEF,OAAO,WAAW,CAAgB,OAAO,CAAC,CAAC;AAC7C,CAAC"}
@@ -0,0 +1,5 @@
1
+ import { BridgeMethod, BridgeRequest } from "../types";
2
+ export type GetAvailableLangsRequest = BridgeRequest<BridgeMethod.GET_AVAILABLE_LANGS, undefined>;
3
+ export type GetAvailableLangsResult = string[];
4
+ export type GetLangRequest = BridgeRequest<BridgeMethod.GET_LANG, undefined>;
5
+ export type GetLangResult = string;
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=i18n.types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"i18n.types.js","sourceRoot":"","sources":["../../src/i18n/i18n.types.ts"],"names":[],"mappings":""}
@@ -0,0 +1,2 @@
1
+ export * from "./i18n.types";
2
+ export * from "./i18n";
@@ -0,0 +1,3 @@
1
+ export * from "./i18n.types";
2
+ export * from "./i18n";
3
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/i18n/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,QAAQ,CAAC"}
@@ -0,0 +1,4 @@
1
+ export * from "./types";
2
+ export * from "./i18n";
3
+ export * from "./navigation";
4
+ export * from "./theming";
package/dist/index.js ADDED
@@ -0,0 +1,5 @@
1
+ export * from "./types";
2
+ export * from "./i18n";
3
+ export * from "./navigation";
4
+ export * from "./theming";
5
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AAExB,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC"}
@@ -0,0 +1 @@
1
+ export * from "./logging";
@@ -0,0 +1,2 @@
1
+ export * from "./logging";
2
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/logging/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC"}
@@ -0,0 +1 @@
1
+ export declare function log(message: string, details: unknown): void;
@@ -0,0 +1,7 @@
1
+ const debug = process.env.NODE_ENV === "development";
2
+ export function log(message, details) {
3
+ if (debug) {
4
+ console.log(`${message} – `, details);
5
+ }
6
+ }
7
+ //# sourceMappingURL=logging.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"logging.js","sourceRoot":"","sources":["../../src/logging/logging.ts"],"names":[],"mappings":"AAAA,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,aAAa,CAAC;AAErD,MAAM,UAAU,GAAG,CAAC,OAAe,EAAE,OAAgB;IACnD,IAAI,KAAK,EAAE;QACT,OAAO,CAAC,GAAG,CAAC,GAAG,OAAO,KAAK,EAAE,OAAO,CAAC,CAAC;KACvC;AACH,CAAC"}
@@ -0,0 +1 @@
1
+ export * from "./messaging";
@@ -0,0 +1,2 @@
1
+ export * from "./messaging";
2
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/messaging/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC"}
@@ -0,0 +1,4 @@
1
+ import { BridgeError, BridgeRequest } from "../types";
2
+ export declare function postMessage(message: BridgeRequest): void;
3
+ export declare function makeRequest<Result>(request: BridgeRequest): Promise<Result | BridgeError>;
4
+ export declare function isAllowedOrigin(origin: string): boolean;
@@ -0,0 +1,43 @@
1
+ import { log } from "../logging";
2
+ import { BridgeErrorCode, } from "../types";
3
+ const hostAppOrigin = process.env.HOST_APP_ORIGIN || "http://localhost:4200";
4
+ export function postMessage(message) {
5
+ if (!window.top) {
6
+ return;
7
+ }
8
+ window.top.postMessage(message, hostAppOrigin);
9
+ log("postMessage", {
10
+ message,
11
+ targetOrigin: hostAppOrigin,
12
+ });
13
+ }
14
+ export function makeRequest(request) {
15
+ 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
+ };
34
+ window.addEventListener("message", handler);
35
+ postMessage(request);
36
+ });
37
+ }
38
+ export function isAllowedOrigin(origin) {
39
+ // TODO: check origin
40
+ console.log(origin);
41
+ return true;
42
+ }
43
+ //# sourceMappingURL=messaging.js.map
@@ -0,0 +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"}
@@ -0,0 +1,2 @@
1
+ export * from "./navigation.types";
2
+ export * from "./navigation";
@@ -0,0 +1,3 @@
1
+ export * from "./navigation.types";
2
+ export * from "./navigation";
3
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/navigation/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC"}
@@ -0,0 +1 @@
1
+ export declare function navigate(path: string): Promise<boolean | import("../types").BridgeError>;
@@ -0,0 +1,12 @@
1
+ import { v4 as uuidv4 } from "uuid";
2
+ import { makeRequest } from "../messaging";
3
+ import { BridgeMethod } from "../types";
4
+ export function navigate(path) {
5
+ const request = {
6
+ id: uuidv4(),
7
+ method: BridgeMethod.NAVIGATE,
8
+ params: { path },
9
+ };
10
+ return makeRequest(request);
11
+ }
12
+ //# sourceMappingURL=navigation.js.map
@@ -0,0 +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"}
@@ -0,0 +1,5 @@
1
+ import { BridgeMethod, BridgeRequest } from "../types";
2
+ export type NavigateRequest = BridgeRequest<BridgeMethod.NAVIGATE, {
3
+ path: string;
4
+ }>;
5
+ export type GetNavigateResult = boolean;
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=navigation.types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"navigation.types.js","sourceRoot":"","sources":["../../src/navigation/navigation.types.ts"],"names":[],"mappings":""}
@@ -0,0 +1,2 @@
1
+ export * from "./theming.types";
2
+ export * from "./theming";
@@ -0,0 +1,3 @@
1
+ export * from "./theming.types";
2
+ export * from "./theming";
3
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/theming/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,WAAW,CAAC"}
@@ -0,0 +1,2 @@
1
+ import { GetThemeResult } from "./theming.types";
2
+ export declare function getTheme(): Promise<import("../types").BridgeError | GetThemeResult>;
@@ -0,0 +1,11 @@
1
+ import { v4 as uuidv4 } from "uuid";
2
+ import { makeRequest } from "../messaging";
3
+ import { BridgeMethod } from "../types";
4
+ export function getTheme() {
5
+ const request = {
6
+ id: uuidv4(),
7
+ method: BridgeMethod.GET_THEME,
8
+ };
9
+ return makeRequest(request);
10
+ }
11
+ //# sourceMappingURL=theming.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"theming.js","sourceRoot":"","sources":["../../src/theming/theming.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;IACtB,MAAM,OAAO,GAAoB;QAC/B,EAAE,EAAE,MAAM,EAAE;QACZ,MAAM,EAAE,YAAY,CAAC,SAAS;KAC/B,CAAC;IAEF,OAAO,WAAW,CAAiB,OAAO,CAAC,CAAC;AAC9C,CAAC"}
@@ -0,0 +1,7 @@
1
+ import { FlipTheme } from "@getflip/swirl-components/dist/types/components/flip-theme-provider/flip-theme-provider";
2
+ import { BridgeMethod, BridgeRequest } from "../types";
3
+ export type GetThemeRequest = BridgeRequest<BridgeMethod.GET_THEME, undefined>;
4
+ export type GetThemeResult = {
5
+ activeTheme: FlipTheme;
6
+ preferredTheme: FlipTheme;
7
+ };
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=theming.types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"theming.types.js","sourceRoot":"","sources":["../../src/theming/theming.types.ts"],"names":[],"mappings":""}
@@ -0,0 +1,31 @@
1
+ import { GetAvailableLangsResult, GetLangResult } from "./i18n";
2
+ import { GetNavigateResult } from "./navigation";
3
+ 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;
13
+ };
14
+ export type BridgeError = {
15
+ code: BridgeErrorCode;
16
+ };
17
+ export declare enum BridgeErrorCode {
18
+ FORBIDDEN_ORIGIN = "FORBIDDEN_ORIGIN"
19
+ }
20
+ export declare enum BridgeMethod {
21
+ GET_AVAILABLE_LANGS = "GET_AVAILABLE_LANGS",
22
+ GET_LANG = "GET_LANG",
23
+ GET_THEME = "GET_THEME",
24
+ NAVIGATE = "NAVIGATE"
25
+ }
26
+ export type BridgeMethodResultMapping = {
27
+ [BridgeMethod.GET_AVAILABLE_LANGS]: GetAvailableLangsResult;
28
+ [BridgeMethod.GET_LANG]: GetLangResult;
29
+ [BridgeMethod.GET_THEME]: GetThemeResult;
30
+ [BridgeMethod.NAVIGATE]: GetNavigateResult;
31
+ };
package/dist/types.js ADDED
@@ -0,0 +1,12 @@
1
+ export var BridgeErrorCode;
2
+ (function (BridgeErrorCode) {
3
+ BridgeErrorCode["FORBIDDEN_ORIGIN"] = "FORBIDDEN_ORIGIN";
4
+ })(BridgeErrorCode || (BridgeErrorCode = {}));
5
+ export var BridgeMethod;
6
+ (function (BridgeMethod) {
7
+ BridgeMethod["GET_AVAILABLE_LANGS"] = "GET_AVAILABLE_LANGS";
8
+ BridgeMethod["GET_LANG"] = "GET_LANG";
9
+ BridgeMethod["GET_THEME"] = "GET_THEME";
10
+ BridgeMethod["NAVIGATE"] = "NAVIGATE";
11
+ })(BridgeMethod || (BridgeMethod = {}));
12
+ //# sourceMappingURL=types.js.map
@@ -0,0 +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"}
package/package.json ADDED
@@ -0,0 +1,24 @@
1
+ {
2
+ "name": "@getflip/bridge",
3
+ "version": "0.1.0-alpha.1",
4
+ "description": "Flip JavaScript Bridge for external integrations.",
5
+ "main": "dist/index.js",
6
+ "repository": "https://github.com/getflip/swirl",
7
+ "license": "SEE LICENSE IN LICENSE.md",
8
+ "files": [
9
+ "dist/"
10
+ ],
11
+ "scripts": {
12
+ "build": "tsc",
13
+ "dev": "tsc -w",
14
+ "start": "yarn dev"
15
+ },
16
+ "dependencies": {
17
+ "@getflip/swirl-components": "^0.8.4",
18
+ "uuid": "^9.0.0"
19
+ },
20
+ "devDependencies": {
21
+ "@types/uuid": "^8.3.4",
22
+ "typescript": "^4.9.3"
23
+ }
24
+ }