@dustid/dust-go-connect 0.1.0 → 0.1.1

package/lib/chromeWebView.d.ts

@@ -0,0 +1,9 @@
+import { Dispatcher } from './dispatcher';
+import { DustGoConnector } from './types';
+export declare class ChromeWebViewDustGoConnector extends Dispatcher implements DustGoConnector {
+    static detected: boolean;
+    constructor();
+    rewriteRedirect(url: URL): URL;
+    showScanner(): void;
+    hideScanner(): void;
+}

package/lib/chromeWebView.js

@@ -0,0 +1,23 @@
+var _a, _b;
+import { Dispatcher } from './dispatcher';
+export class ChromeWebViewDustGoConnector extends Dispatcher {
+    constructor() {
+        var _a, _b;
+        if (!((_b = (_a = globalThis.window) === null || _a === void 0 ? void 0 : _a.chrome) === null || _b === void 0 ? void 0 : _b.webview)) {
+            throw new Error('Could not init ChromeWebViewDustGoConnector');
+        }
+        super();
+    }
+    rewriteRedirect(url) {
+        return url;
+    }
+    showScanner() {
+        var _a, _b, _c;
+        (_c = (_b = (_a = globalThis.window) === null || _a === void 0 ? void 0 : _a.chrome) === null || _b === void 0 ? void 0 : _b.webview) === null || _c === void 0 ? void 0 : _c.postMessage('show');
+    }
+    hideScanner() {
+        var _a, _b, _c;
+        (_c = (_b = (_a = globalThis.window) === null || _a === void 0 ? void 0 : _a.chrome) === null || _b === void 0 ? void 0 : _b.webview) === null || _c === void 0 ? void 0 : _c.postMessage('hide');
+    }
+}
+ChromeWebViewDustGoConnector.detected = Boolean((_b = (_a = globalThis.window) === null || _a === void 0 ? void 0 : _a.chrome) === null || _b === void 0 ? void 0 : _b.webview);

package/lib/dispatcher.d.ts

@@ -0,0 +1,43 @@
+import type { EventType, ScanCallback, ScanEvent } from "./types";
+export declare class Dispatcher {
+    private callbacks;
+    /**
+     * Adds an event listener for the specified event type and id.
+     * * @param id - A unique identifier for the event listener. This allows multiple listeners for the same event type.
+     * * @param cb - The callback function to be called when the event is dispatched. The type of the callback depends on the event type:
+     * */
+    add(id: string, cb: ScanCallback): void;
+    /**
+     * Checks if an event listener exists for the specified event type and id.
+     * */
+    has(id: string): boolean;
+    /**
+     * Remove all event listeners.
+     */
+    clear(): void;
+    /**
+     * Removes an event listener for the specified event type and id.
+     *
+     * @param event - The type of event to stop listening for, either "scan", "show", or "hide".
+     * @param id - The unique identifier for the event listener to be removed. If not provided, all listeners for the specified event type are removed.
+     * if no id is provided, all listeners for that event type are removed.
+     * */
+    remove(id?: string): void;
+    /**
+     * Fires the specified event, calling all registered callbacks for that event type.
+     * */
+    dispatch(event: ScanEvent): void;
+    /**
+     * @deprecated
+     * This keeps compatibility with the previous dispatch API.
+     * Still currently used by the `dust-go` react native package.
+     *
+     * @param event - The type of event to dispatch, either "scan", "show", or "hide".
+     * @param data - The data to be passed to the event listeners.
+     * For "scan" events, this should include a `data` string and optionally `metadata`.
+     * */
+    dispatchEvent(event: EventType, data: {
+        data: string;
+        metadata?: Record<string, any>;
+    }): void;
+}

package/lib/dispatcher.js

@@ -0,0 +1,77 @@
+export class Dispatcher {
+    constructor() {
+        this.callbacks = new Map();
+    }
+    /**
+     * Adds an event listener for the specified event type and id.
+     * * @param id - A unique identifier for the event listener. This allows multiple listeners for the same event type.
+     * * @param cb - The callback function to be called when the event is dispatched. The type of the callback depends on the event type:
+     * */
+    add(id, cb) {
+        this.callbacks.set(id, cb);
+    }
+    /**
+     * Checks if an event listener exists for the specified event type and id.
+     * */
+    has(id) {
+        return this.callbacks.has(id);
+    }
+    /**
+     * Remove all event listeners.
+     */
+    clear() {
+        this.callbacks.clear();
+    }
+    /**
+     * Removes an event listener for the specified event type and id.
+     *
+     * @param event - The type of event to stop listening for, either "scan", "show", or "hide".
+     * @param id - The unique identifier for the event listener to be removed. If not provided, all listeners for the specified event type are removed.
+     * if no id is provided, all listeners for that event type are removed.
+     * */
+    remove(id) {
+        if (!id && !this.callbacks.size) {
+            return;
+        }
+        if (!id) {
+            this.callbacks.clear();
+            return;
+        }
+        this.callbacks.delete(id);
+    }
+    /**
+     * Fires the specified event, calling all registered callbacks for that event type.
+     * */
+    dispatch(event) {
+        this.callbacks.forEach((cb) => {
+            cb(event);
+        });
+    }
+    /**
+     * @deprecated
+     * This keeps compatibility with the previous dispatch API.
+     * Still currently used by the `dust-go` react native package.
+     *
+     * @param event - The type of event to dispatch, either "scan", "show", or "hide".
+     * @param data - The data to be passed to the event listeners.
+     * For "scan" events, this should include a `data` string and optionally `metadata`.
+     * */
+    dispatchEvent(event, data) {
+        switch (event) {
+            case "scan":
+                this.dispatch({
+                    type: "scan",
+                    payload: data,
+                });
+                break;
+            case "hide":
+            case "show":
+                this.dispatch({
+                    type: event,
+                });
+                break;
+            default:
+                throw new Error(`Unknown event type: ${event}`);
+        }
+    }
+}

package/lib/index.d.ts

@@ -0,0 +1,14 @@
+import { ChromeWebView, DustGoConnector, ReactNativeWebView, ScanPayload } from "./types";
+declare global {
+    interface Window {
+        dustGoConnector?: DustGoConnector;
+        ReactNativeWebView?: ReactNativeWebView;
+        chrome?: ChromeWebView;
+    }
+}
+/**
+ * Presents the scanner, and awaits a scan.
+ * Rejects if scanner is hidden.
+ * */
+export declare const scanAsync: () => Promise<ScanPayload>;
+export declare const connector: DustGoConnector | undefined;

package/lib/index.js

@@ -0,0 +1,37 @@
+var _a;
+import { ChromeWebViewDustGoConnector } from "./chromeWebView";
+import { ReactNativeWebViewDustGoConnector } from "./reactNativeWebView";
+/**
+ * Presents the scanner, and awaits a scan.
+ * Rejects if scanner is hidden.
+ * */
+export const scanAsync = () => {
+    return new Promise((resolve, reject) => {
+        if (!window.dustGoConnector) {
+            reject("DUST Go connector is not present");
+            return;
+        }
+        const id = Math.random().toString(36).substring(2, 15);
+        const connector = window.dustGoConnector;
+        connector.showScanner();
+        const res = (val) => {
+            switch (val.type) {
+                case "scan":
+                    resolve(val.payload);
+                    break;
+                case "hide":
+                    reject("Scanner was hidden");
+                    break;
+            }
+            connector.remove(id);
+        };
+        connector.add(id, res);
+    });
+};
+if (ReactNativeWebViewDustGoConnector.detected) {
+    globalThis.window.dustGoConnector = new ReactNativeWebViewDustGoConnector();
+}
+else if (ChromeWebViewDustGoConnector.detected) {
+    globalThis.window.dustGoConnector = new ChromeWebViewDustGoConnector();
+}
+export const connector = (_a = globalThis.window) === null || _a === void 0 ? void 0 : _a.dustGoConnector;

package/lib/reactNativeWebView.d.ts

@@ -0,0 +1,10 @@
+import { Dispatcher } from './dispatcher';
+import { DustGoConnector } from './types';
+export declare class ReactNativeWebViewDustGoConnector extends Dispatcher implements DustGoConnector {
+    private appId;
+    static detected: boolean;
+    constructor();
+    rewriteRedirect(url: URL): URL;
+    showScanner(): void;
+    hideScanner(): void;
+}

package/lib/reactNativeWebView.js

@@ -0,0 +1,29 @@
+var _a;
+import { Dispatcher } from './dispatcher';
+export class ReactNativeWebViewDustGoConnector extends Dispatcher {
+    constructor() {
+        var _a, _b;
+        if (!((_a = globalThis.window) === null || _a === void 0 ? void 0 : _a.ReactNativeWebView)) {
+            throw new Error('Could not init ReactNativeWebViewDustGoConnector');
+        }
+        const raw = (_b = globalThis.window) === null || _b === void 0 ? void 0 : _b.ReactNativeWebView.injectedObjectJson();
+        const parsed = JSON.parse(raw !== null && raw !== void 0 ? raw : '{}');
+        if (!('appId' in parsed) || !(typeof parsed.appId === 'string')) {
+            throw new Error('Could not validate injected JSON');
+        }
+        super();
+        this.appId = parsed.appId;
+    }
+    rewriteRedirect(url) {
+        return new URL(url.href.replace(url.protocol, `${this.appId}:`));
+    }
+    showScanner() {
+        var _a, _b;
+        (_b = (_a = globalThis.window) === null || _a === void 0 ? void 0 : _a.ReactNativeWebView) === null || _b === void 0 ? void 0 : _b.postMessage('show');
+    }
+    hideScanner() {
+        var _a, _b;
+        (_b = (_a = globalThis.window) === null || _a === void 0 ? void 0 : _a.ReactNativeWebView) === null || _b === void 0 ? void 0 : _b.postMessage('hide');
+    }
+}
+ReactNativeWebViewDustGoConnector.detected = Boolean((_a = globalThis.window) === null || _a === void 0 ? void 0 : _a.ReactNativeWebView);

package/lib/types.d.ts

@@ -0,0 +1,72 @@
+export type ChromeWebView = {
+    webview?: {
+        postMessage(val: string): void;
+    };
+};
+export type ReactNativeWebView = {
+    postMessage(val: string): void;
+    injectedObjectJson(): string | undefined;
+};
+export type EventType = "scan" | "hide" | "show";
+export type ScanPayload = {
+    data: string;
+    metadata?: Record<string, any>;
+};
+export type ScanEvent = {
+    type: "scan";
+    payload: ScanPayload;
+} | {
+    type: "hide";
+} | {
+    type: "show";
+};
+export type ScanCallback = (event: ScanEvent) => void;
+export interface DustGoConnector {
+    showScanner(): void;
+    hideScanner(): void;
+    /**
+     * Rewrites the URL protocol for redirection on different platforms.
+     *
+     * e.g. `https://example.com/scan?data=123` to `dustgo://example.com/scan?data=123`
+     * */
+    rewriteRedirect(url: URL): URL;
+    /**
+     * Adds an event listener for the specified event type and id.
+     * @param id - A unique identifier for the event listener. This allows multiple listeners for the same event type.
+     * @param cb - The callback function to be called when the event is dispatched. The type of the callback depends on the event type:
+     * */
+    add(id: string, cb: ScanCallback): void;
+    /**
+     * Removes an event listener for the specified event type and id.
+     *
+     * @param event - The type of event to stop listening for, either "scan", "show", or "hide".
+     * @param id - The unique identifier for the event listener to be removed. If not provided, all listeners for the specified event type are removed.
+     * if no id is provided, all listeners for that event type are removed.
+     * */
+    remove(id: string): void;
+    /**
+     * Remove all event listeners.
+     */
+    clear(): void;
+    /**
+     * Checks if an event listener exists for the specified event type and id.
+     * */
+    has(id: string): boolean;
+    /**
+     * Fires the specified event, calling all registered callbacks for that event type.
+     * */
+    dispatch(event: ScanEvent): void;
+    /**
+     * @deprecated
+     * This keeps compatibility with the previous dispatch API.
+     * Still currently used by the `dust-go` react native package.
+     *
+     * @param event - The type of event to dispatch, either "scan", "show", or "hide".
+     * @param data - The data to be passed to the event listeners.
+     * For "scan" events, this should include a `data` string and optionally `metadata`.
+     */
+    dispatchEvent(event: EventType, data: {
+        data: string;
+        metadata?: Record<string, any>;
+    }): void;
+}

package/lib/types.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dustid/dust-go-connect",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "A library for connecting a fronten application to the DUST GO react natie application",
   "main": "./lib/index.js",
   "files": [
@@ -23,6 +23,18 @@
     "email": "",
     "url": "https://github.com/sweeneytr"
   },
+  "contributors": [
+    {
+      "name": "Daniel Capecci",
+      "email": "dcapecci@dustidentity.com",
+      "url": ""
+    },
+    {
+      "name": "Chris Mcgee",
+      "email": "",
+      "url": ""
+    }
+  ],
   "engines": {
     "node": ">=12.0"
   },