@dustid/dust-go-connect 0.1.6 → 0.1.8

package/README.md

@@ -62,20 +62,24 @@ webview isn't paused while the scanner is presented.
 ```typescript
 type ScanPayload =
   | {
-      type: 'dust'
+      type: 'DUST'
       data: string
       metadata?: ScanSettings
     }
   | {
-      type: 'qr'
+      type: 'QR'
       data: string
       metadata?: Record<string, any>
     }
-  | { type: 'barcode'; data: string; metadata?: Record<string, any> }
-  | { type: 'data_matrix'; data: string; metadata?: Record<string, any> }
-  | { type: 'nfc'; data: string; metadata?: Record<string, any> }
+  | { type: 'BARCODE'; data: string; metadata?: Record<string, any> }
+  | { type: 'DATA_MATRIX'; data: string; metadata?: Record<string, any> }
+  | { type: 'NFC'; data: string; metadata?: Record<string, any> }
 ```
 
+`ScanSettings` can include optional Android Dragon capture fields:
+`captureSource`, `usbVendorId`, `usbProductId`, `usbDeviceName`,
+`androidCameraId`, `dragonBackend`, and `dragonErrorCode`.
+
 | Scan Events                             |
 | --------------------------------------- |
 | `{ type: 'scan', payload: ScanPayload}` |

package/lib/chromeWebView.d.ts

@@ -1,9 +1,11 @@
 import { Dispatcher } from './dispatcher';
-import { type DustGoConnector } from './types';
+import { type AuthSessionResult, type DustGoConnector } from './types';
 export declare class ChromeWebViewDustGoConnector extends Dispatcher implements DustGoConnector {
     static detected: boolean;
     constructor();
+    get appScheme(): string;
     rewriteRedirect(url: URL): URL;
+    openAuthSession(): Promise<AuthSessionResult>;
     showScanner(): void;
     hideScanner(): void;
 }

package/lib/dispatcher.d.ts

@@ -1,4 +1,4 @@
-import type { EventType, ScanCallback, ScanEvent } from './types';
+import type { ConnectorEvent, EventType, ScanCallback } from './types';
 export declare class Dispatcher {
     private callbacks;
     /**
@@ -26,7 +26,7 @@ export declare class Dispatcher {
     /**
      * Fires the specified event, calling all registered callbacks for that event type.
      * */
-    dispatch(event: ScanEvent): void;
+    dispatch(event: ConnectorEvent): void;
     /**
      * @deprecated
      * This keeps compatibility with the previous dispatch API.

package/lib/index.d.ts

@@ -1,5 +1,5 @@
-import type { ChromeWebView, DustGoConnector, ReactNativeWebView, ScanPayload } from './types';
-export type { DustGoConnector, ScanEvent, ScanPayload } from './types';
+import type { AuthSessionResult, ChromeWebView, DustGoConnector, ReactNativeWebView, ScanPayload } from './types';
+export type { AuthSessionResult, AuthSessionResultEvent, ConnectorEvent, DustGoConnector, OpenAuthSessionMessage, ScanEvent, ScanPayload, } from './types';
 declare global {
     interface Window {
         dustGoConnector?: DustGoConnector;
@@ -12,4 +12,12 @@ declare global {
  * Rejects if scanner is hidden.
  * */
 export declare const scanAsync: () => Promise<ScanPayload>;
+/**
+ * Opens an authentication URL in the system browser via the native app.
+ * Returns a promise that resolves with the auth session result.
+ *
+ * @param url - The authentication URL to open (must be HTTPS).
+ * @param redirectUrl - The callback URL the auth server will redirect to.
+ */
+export declare const openAuthSessionAsync: (url: string, redirectUrl?: string) => Promise<AuthSessionResult>;
 export declare const connector: DustGoConnector | undefined;

package/lib/index.js

@@ -1 +1 @@
-class w{callbacks=new Map;add(o,e){this.callbacks.set(o,e)}has(o){return this.callbacks.has(o)}clear(){this.callbacks.clear()}remove(o){if(!o&&!this.callbacks.size)return;if(!o){this.callbacks.clear();return}this.callbacks.delete(o)}dispatch(o){this.callbacks.forEach((e)=>{e(o)})}dispatchEvent(o,e){switch(o){case"scan":this.dispatch({type:"scan",payload:{type:"dust",data:e.data,metadata:e.metadata||{}}});break;case"hide":case"show":this.dispatch({type:o});break;default:throw Error(`Unknown event type: ${o}`)}}}class r extends w{static detected=Boolean(globalThis.window?.chrome?.webview);constructor(){if(!globalThis.window?.chrome?.webview)throw Error("Could not init ChromeWebViewDustGoConnector");super()}rewriteRedirect(o){return o}showScanner(){globalThis.window?.chrome?.webview?.postMessage("show")}hideScanner(){globalThis.window?.chrome?.webview?.postMessage("hide")}}class i extends w{appId;static detected=Boolean(globalThis.window?.ReactNativeWebView);constructor(){if(!globalThis.window?.ReactNativeWebView)throw Error("Could not init ReactNativeWebViewDustGoConnector");let o=globalThis.window?.ReactNativeWebView.injectedObjectJson(),e=JSON.parse(o??"{}");if(!("appId"in e)||typeof e.appId!=="string")throw Error("Could not validate injected JSON");super();this.appId=e.appId}rewriteRedirect(o){return new URL(o.href.replace(o.protocol,`${this.appId}:`))}showScanner(){globalThis.window?.ReactNativeWebView?.postMessage("show")}hideScanner(){globalThis.window?.ReactNativeWebView?.postMessage("hide")}}var a=()=>{return new Promise((o,e)=>{if(!window.dustGoConnector){e("DUST Go connector is not present");return}let n=Math.random().toString(36).substring(2,15),s=window.dustGoConnector;s.showScanner();let p=(t)=>{switch(t.type){case"scan":o(t.payload);break;case"hide":e("Scanner was hidden");break}s.remove(n)};s.add(n,p)})};if(i.detected)globalThis.window.dustGoConnector=new i;else if(r.detected)globalThis.window.dustGoConnector=new r;var C=globalThis.window?.dustGoConnector;export{a as scanAsync,C as connector};
+class t{callbacks=new Map;add(e,s){this.callbacks.set(e,s)}has(e){return this.callbacks.has(e)}clear(){this.callbacks.clear()}remove(e){if(!e&&!this.callbacks.size)return;if(!e){this.callbacks.clear();return}this.callbacks.delete(e)}dispatch(e){if(e.type==="authSessionResult")return;this.callbacks.forEach((s)=>{s(e)})}dispatchEvent(e,s){switch(e){case"scan":{let o=(s.type??"DUST").toUpperCase(),i=o==="QR"||o==="BARCODE"||o==="DATA_MATRIX"||o==="NFC"?o:"DUST";this.dispatch({type:"scan",payload:{type:i,data:s.data,metadata:s.metadata||{}}})}break;case"hide":case"show":this.dispatch({type:e});break;default:throw Error(`Unknown event type: ${e}`)}}}class n extends t{static detected=Boolean(globalThis.window?.chrome?.webview);constructor(){if(!globalThis.window?.chrome?.webview)throw Error("Could not init ChromeWebViewDustGoConnector");super()}get appScheme(){return""}rewriteRedirect(e){return e}openAuthSession(){return Promise.resolve({type:"error",message:"Not supported in Chrome WebView"})}showScanner(){globalThis.window?.chrome?.webview?.postMessage("show")}hideScanner(){globalThis.window?.chrome?.webview?.postMessage("hide")}}class r extends t{_appScheme="dustgo";pendingAuthSessions=new Map;static detected=Boolean(globalThis.window?.ReactNativeWebView?.postMessage);constructor(){if(!globalThis.window?.ReactNativeWebView?.postMessage)throw Error("Could not init ReactNativeWebViewDustGoConnector");super();let e=this.readInjectedBridgeConfig();this._appScheme=e.appScheme??e.appId??this._appScheme}get appScheme(){return this.getResolvedAppScheme()}rewriteRedirect(e){let s=this.getResolvedAppScheme();return new URL(e.href.replace(e.protocol,`${s}:`))}openAuthSession(e,s){let o=Math.random().toString(36).substring(2,15),i=s??`${this.appScheme}://auth-callback`;return new Promise((p)=>{this.pendingAuthSessions.set(o,{resolve:p}),globalThis.window?.ReactNativeWebView?.postMessage(JSON.stringify({type:"openAuthSession",id:o,url:e,redirectUrl:i}))})}dispatch(e){if(e.type==="authSessionResult"){let s=this.pendingAuthSessions.get(e.id);if(s)s.resolve(e.result),this.pendingAuthSessions.delete(e.id);return}super.dispatch(e)}getResolvedAppScheme(){let e=this.readInjectedBridgeConfig();return e.appScheme??e.appId??this._appScheme}showScanner(){globalThis.window?.ReactNativeWebView?.postMessage("show")}hideScanner(){globalThis.window?.ReactNativeWebView?.postMessage("hide")}readInjectedBridgeConfig(){try{let e=globalThis.window?.ReactNativeWebView?.injectedObjectJson?.();if(!e)return{};let s=JSON.parse(e);return{appId:typeof s.appId==="string"?s.appId:void 0,appScheme:typeof s.appScheme==="string"?s.appScheme:void 0}}catch{return{}}}}var d=()=>{return new Promise((e,s)=>{if(!window.dustGoConnector){s("DUST Go connector is not present");return}let o=Math.random().toString(36).substring(2,15),i=window.dustGoConnector;i.showScanner();let p=(h)=>{switch(h.type){case"scan":e(h.payload);break;case"hide":s("Scanner was hidden");break}i.remove(o)};i.add(o,p)})},l=(e,s)=>{if(!window.dustGoConnector)return Promise.resolve({type:"error",message:"DUST Go connector is not present"});return window.dustGoConnector.openAuthSession(e,s)};if(r.detected)globalThis.window.dustGoConnector=new r;else if(n.detected)globalThis.window.dustGoConnector=new n;var R=globalThis.window?.dustGoConnector;export{d as scanAsync,l as openAuthSessionAsync,R as connector};

package/lib/reactNativeWebView.d.ts

@@ -1,10 +1,16 @@
 import { Dispatcher } from './dispatcher';
-import type { DustGoConnector } from './types';
+import type { AuthSessionResult, ConnectorEvent, DustGoConnector } from './types';
 export declare class ReactNativeWebViewDustGoConnector extends Dispatcher implements DustGoConnector {
-    private appId;
+    private _appScheme;
+    private pendingAuthSessions;
     static detected: boolean;
     constructor();
+    get appScheme(): string;
     rewriteRedirect(url: URL): URL;
+    openAuthSession(url: string, redirectUrl?: string): Promise<AuthSessionResult>;
+    dispatch(event: ConnectorEvent): void;
+    private getResolvedAppScheme;
     showScanner(): void;
     hideScanner(): void;
+    private readInjectedBridgeConfig;
 }

package/lib/types.d.ts

@@ -5,10 +5,11 @@ export type ChromeWebView = {
 };
 export type ReactNativeWebView = {
     postMessage(val: string): void;
-    injectedObjectJson(): string | undefined;
+    injectedObjectJson?(): string | undefined;
 };
 export type EventType = 'scan' | 'hide' | 'show';
 export type ScanSettings = {
+    deviceId?: string | null;
     brand?: string | null;
     deviceName?: string | null;
     deviceType?: 'DESKTOP' | 'PHONE' | 'TABLET' | 'TV' | 'UNKNOWN' | null;
@@ -37,32 +38,46 @@ export type ScanSettings = {
     longitude?: number | null;
     accuracy?: number | null;
     tapToFocusCount?: number | null;
+    captureSource?: 'INTERNAL_CAMERA' | 'EXTERNAL_CAMERA' | 'DRAGON_UVC' | null;
+    usbVendorId?: number | null;
+    usbProductId?: number | null;
+    usbDeviceName?: string | null;
+    androidCameraId?: string | null;
+    cameraId?: string | null;
+    selectedLens?: string | null;
+    dragonBackend?: 'camera2_external' | 'uvc_native' | 'none' | null;
+    dragonErrorCode?: string | null;
+    calibrationVersion?: string | null;
+    calibrationId?: string | null;
+    calibrationConfidence?: number | null;
+    calibrationZoom?: number | null;
 };
+export type ScanMetadata = ScanSettings & Record<string, any>;
 export type EnrollMetadata = {
     latitude?: number;
     longitude?: number;
     accuracy?: number;
 };
 export type ScanPayload = {
-    type: 'dust';
+    type: 'DUST';
     data: string;
-    metadata?: ScanSettings;
+    metadata?: ScanMetadata;
 } | {
-    type: 'qr';
+    type: 'QR';
     data: string;
-    metadata?: Record<string, any>;
+    metadata?: ScanMetadata;
 } | {
-    type: 'barcode';
+    type: 'BARCODE';
     data: string;
-    metadata?: Record<string, any>;
+    metadata?: ScanMetadata;
 } | {
-    type: 'data_matrix';
+    type: 'DATA_MATRIX';
     data: string;
-    metadata?: Record<string, any>;
+    metadata?: ScanMetadata;
 } | {
-    type: 'nfc';
+    type: 'NFC';
     data: string;
-    metadata?: Record<string, any>;
+    metadata?: ScanMetadata;
 };
 export type ScanEvent = {
     type: 'scan';
@@ -72,16 +87,52 @@ export type ScanEvent = {
 } | {
     type: 'show';
 };
+export type AuthSessionResult = {
+    type: 'success';
+    url: string;
+} | {
+    type: 'cancel';
+} | {
+    type: 'error';
+    message: string;
+};
+export type AuthSessionResultEvent = {
+    type: 'authSessionResult';
+    id: string;
+    result: AuthSessionResult;
+};
+/** Union of all events the connector can dispatch. */
+export type ConnectorEvent = ScanEvent | AuthSessionResultEvent;
+export type OpenAuthSessionMessage = {
+    type: 'openAuthSession';
+    id: string;
+    url: string;
+    redirectUrl: string;
+};
 export type ScanCallback = (event: ScanEvent) => void;
 export interface DustGoConnector {
     showScanner(): void;
     hideScanner(): void;
+    /** The custom URL scheme of the host app (e.g. `"dustgo"`). */
+    readonly appScheme: string;
     /**
+     * @deprecated Use {@link openAuthSession} instead for OAuth/OIDC flows.
+     *
      * 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;
+    /**
+     * Opens a URL in the system browser for authentication purposes.
+     * The native app opens the URL as-is (no modification).
+     * Returns a promise that resolves with the auth session result.
+     *
+     * @param url - The authentication URL to open (must be HTTPS).
+     * @param redirectUrl - The callback URL the auth server will redirect to.
+     *   Defaults to `${appScheme}://auth-callback` if not provided.
+     */
+    openAuthSession(url: string, redirectUrl?: string): Promise<AuthSessionResult>;
     /**
      * 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.
@@ -107,7 +158,7 @@ export interface DustGoConnector {
     /**
      * Fires the specified event, calling all registered callbacks for that event type.
      * */
-    dispatch(event: ScanEvent): void;
+    dispatch(event: ConnectorEvent): void;
     /**
      * @deprecated
      * This keeps compatibility with the previous dispatch API.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dustid/dust-go-connect",
-  "version": "0.1.6",
+  "version": "0.1.8",
   "description": "A library for connecting a frontend application to the DUST GO react native application",
   "main": "./lib/index.js",
   "files": [
@@ -47,14 +47,12 @@
   ],
   "homepage": "https://go.dustid.io",
   "devDependencies": {
-    "@biomejs/biome": "^2.2.6",
+    "@biomejs/biome": "^2.4.4",
     "@ryansonshine/commitizen": "^4.2.8",
     "@ryansonshine/cz-conventional-changelog": "^3.3.4",
     "@types/jest": "^27.5.2",
     "@types/node": "^12.20.55",
-    "@typescript-eslint/eslint-plugin": "^4.33.0",
-    "@typescript-eslint/parser": "^4.33.0",
-    "bun-types": "^1.3.0",
+    "bun-types": "^1.3.9",
     "conventional-changelog-conventionalcommits": "^5.0.0",
     "husky": "^6.0.0",
     "jest": "^27.5.1",
@@ -63,7 +61,7 @@
     "ts-jest": "^27.1.5",
     "ts-node": "^10.9.2",
     "typedoc": "^0.26.11",
-    "typedoc-plugin-markdown": "^4.9.0",
+    "typedoc-plugin-markdown": "^4.10.0",
     "typescript": "^5.9.3"
   },
   "config": {
@@ -72,7 +70,7 @@
     }
   },
   "lint-staged": {
-    "*.ts": "eslint --cache --cache-location .eslintcache --fix"
+    "*.ts": "bun biome lint --fix --unsafe"
   },
   "release": {
     "branches": [