@icanbwell/types 7.17.0 → 8.0.0

package/frontend-telemetry.js

@@ -1,6 +1,6 @@
-/**
- * Error Codes should be used in combination with the BwellError
- * They categorize known error conditions and provide a mechanism for customized error handling.
+/**
+ * Error Codes should be used in combination with the BwellError
+ * They categorize known error conditions and provide a mechanism for customized error handling.
  */
 var ErrorCode;
 (function (ErrorCode) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@icanbwell/types",
-  "version": "7.17.0",
+  "version": "8.0.0",
   "typedoc": {
     "entryPoint": "./src/index.ts",
     "tsconfig": "./tsconfig.lib.json"
@@ -36,8 +36,8 @@
       "import": "./frontend-telemetry.js"
     }
   },
-  "repoVersion": "17.49.0",
-  "description": "@icanbwell/types. repo version: 17.49.0",
+  "repoVersion": "18.0.0",
+  "description": "@icanbwell/types. repo version: 18.0.0",
   "peerDependencies": {
     "react-native": "0.x",
     "react-native-biometrics": "3.x",

package/src/embeddable-core.d.ts

@@ -1 +1 @@
-export type EmbeddableLoaderAttribute = 'error' | 'loading';
+export type EmbeddableLoaderAttribute = 'error' | 'loading';

package/src/frontend-telemetry.d.ts

@@ -1,44 +1,44 @@
-/**
- * Error Codes should be used in combination with the BwellError
- * They categorize known error conditions and provide a mechanism for customized error handling.
- */
-export declare enum ErrorCode {
-    /** Client or client key is unknown */
-    CLIENT_UNKNOWN = "CLIENT_UNKNOWN",
-    /** Insufficient feature services defined by embeddable  */
-    INSUFFICIENT_SERVICES = "INSUFFICIENT_SERVICES",
-    /** Method called before initialization */
-    METHOD_CALLED_BEFORE_INITIALIZATION = "METHOD_CALLED_BEFORE_INITIALIZATION",
-    /** General initialization failure of Bwell object */
-    BWELL_INITIALIZATION = "BWELL_INITIALIZATION",
-    /** Error durring token exchange */
-    TOKEN_EXCHANGE = "TOKEN_EXCHANGE",
-    /** Required user claims (clientFhirPersonId, clientFhirPatientId) missing from ID token */
-    MISSING_REQUIRED_USER_CLAIMS = "MISSING_REQUIRED_USER_CLAIMS",
-    /** Defines an error while executing a route */
-    ROUTE_ACTION = "ROUTE_ACTION",
-    /** Defines an error while initializing the navigation service delegate */
-    ROUTE_NAVIGATION_DELEGATE = "ROUTE_NAVIGATION_DELEGATE",
-    /** Specifies the the route is unknown */
-    ROUTE_UNKNOWN = "ROUTE_UNKNOWN",
-    /** An elementId in the route definition does not have a matching element in the registry */
-    ROUTE_ELEMENT_UNKNOWN = "ROUTE_ELEMENT_UNKNOWN",
-    /** Hook or Consumer used outside of a React Provider */
-    PROVIDER_UNDEFINED = "PROVIDER_UNDEFINED",
-    /** Permission is not granted by the user */
-    INSUFFICIENT_PERMISSIONS = "INSUFFICIENT_PERMISSIONS",
-    /** Configuration Error */
-    CONFIGURATION_ERROR = "CONFIGURATION_ERROR",
-    /** Network Error */
-    NETWORK = "NETWORK",
-    /** Unknown error */
-    UNKNOWN = "UNKNOWN"
-}
-export type ErrorDetails = {
-    message: string;
-    errorCode: ErrorCode;
-};
-export type ErrorContext = {
-    errorDetails: ErrorDetails;
-    resetError: () => void;
-};
+/**
+ * Error Codes should be used in combination with the BwellError
+ * They categorize known error conditions and provide a mechanism for customized error handling.
+ */
+export declare enum ErrorCode {
+    /** Client or client key is unknown */
+    CLIENT_UNKNOWN = "CLIENT_UNKNOWN",
+    /** Insufficient feature services defined by embeddable  */
+    INSUFFICIENT_SERVICES = "INSUFFICIENT_SERVICES",
+    /** Method called before initialization */
+    METHOD_CALLED_BEFORE_INITIALIZATION = "METHOD_CALLED_BEFORE_INITIALIZATION",
+    /** General initialization failure of Bwell object */
+    BWELL_INITIALIZATION = "BWELL_INITIALIZATION",
+    /** Error durring token exchange */
+    TOKEN_EXCHANGE = "TOKEN_EXCHANGE",
+    /** Required user claims (clientFhirPersonId, clientFhirPatientId) missing from ID token */
+    MISSING_REQUIRED_USER_CLAIMS = "MISSING_REQUIRED_USER_CLAIMS",
+    /** Defines an error while executing a route */
+    ROUTE_ACTION = "ROUTE_ACTION",
+    /** Defines an error while initializing the navigation service delegate */
+    ROUTE_NAVIGATION_DELEGATE = "ROUTE_NAVIGATION_DELEGATE",
+    /** Specifies the the route is unknown */
+    ROUTE_UNKNOWN = "ROUTE_UNKNOWN",
+    /** An elementId in the route definition does not have a matching element in the registry */
+    ROUTE_ELEMENT_UNKNOWN = "ROUTE_ELEMENT_UNKNOWN",
+    /** Hook or Consumer used outside of a React Provider */
+    PROVIDER_UNDEFINED = "PROVIDER_UNDEFINED",
+    /** Permission is not granted by the user */
+    INSUFFICIENT_PERMISSIONS = "INSUFFICIENT_PERMISSIONS",
+    /** Configuration Error */
+    CONFIGURATION_ERROR = "CONFIGURATION_ERROR",
+    /** Network Error */
+    NETWORK = "NETWORK",
+    /** Unknown error */
+    UNKNOWN = "UNKNOWN"
+}
+export type ErrorDetails = {
+    message: string;
+    errorCode: ErrorCode;
+};
+export type ErrorContext = {
+    errorDetails: ErrorDetails;
+    resetError: () => void;
+};

package/src/index.d.ts

@@ -1,54 +1,54 @@
-export * from './lib';
-export * from './frontend-telemetry';
-export * from './native-plugins';
-export * from './embeddable-core';
-export type { PluginKeys, INativeBridge } from './native-bridge';
-export declare const PageTransitionEventKey = "pagetransition";
-export type PageTransitionEventPayload = {
-    id?: string;
-    path: string;
-    pageTitle?: string;
-};
-/**
- * Configuration returned by the bootstrap endpoint for RUM.
- * The `configurations` field is a JSON-encoded string containing
- * vendor-specific RUM SDK init parameters.
- */
-export type RumConfiguration = {
-    enabled: boolean;
-    configurations: string;
-};
-/**
- * The `Telemetry` type represents the configuration for telemetry settings.
- * It can be either a boolean value or an object containing boolean flags for individual telemetry features.
- *
- * If the `Telemetry` variable is a boolean, all three telemetry features will be set to that boolean value.
- *
- * If the `Telemetry` variable is an object, you can individually enable/disable specific telemetry features
- * using boolean flags:
- *
- * - `logging`: Set to `true` to enable logging, `false` to disable. When logging is disabled, logs (such as logs, errors, infos, debugs) will be output to the development console instead of Sentry.
- *
- * - `tracing`: Set to `true` to enable tracing, `false` to disable. When tracing is disabled, Otel traces will be logged to the development console.
- *
- * - `rum`: Set to `true` to enable Real User Monitoring (RUM), `false` to disable. The behavior of disabling RUM is to be determined (TBD).
- *
- * Examples:
- *
- * ```typescript
- * // Example 1: Set all telemetry features to true
- * const telemetry1: Telemetry = true;
- *
- * // Example 2: Set individual telemetry features using an object
- * const telemetry2: Telemetry = {
- *   logging: true,  // Enable logging
- *   tracing: false, // Disable tracing
- *   rum: true       // Enable RUM
- * };
- * ```
- */
-export type Telemetry = boolean | {
-    logging?: boolean;
-    tracing?: boolean;
-    rum?: boolean;
-};
+export * from './lib';
+export * from './frontend-telemetry';
+export * from './native-plugins';
+export * from './embeddable-core';
+export type { PluginKeys, INativeBridge } from './native-bridge';
+export declare const PageTransitionEventKey = "pagetransition";
+export type PageTransitionEventPayload = {
+    id?: string;
+    path: string;
+    pageTitle?: string;
+};
+/**
+ * Configuration returned by the bootstrap endpoint for RUM.
+ * The `configurations` field is a JSON-encoded string containing
+ * vendor-specific RUM SDK init parameters.
+ */
+export type RumConfiguration = {
+    enabled: boolean;
+    configurations: string;
+};
+/**
+ * The `Telemetry` type represents the configuration for telemetry settings.
+ * It can be either a boolean value or an object containing boolean flags for individual telemetry features.
+ *
+ * If the `Telemetry` variable is a boolean, all three telemetry features will be set to that boolean value.
+ *
+ * If the `Telemetry` variable is an object, you can individually enable/disable specific telemetry features
+ * using boolean flags:
+ *
+ * - `logging`: Set to `true` to enable logging, `false` to disable. When logging is disabled, logs (such as logs, errors, infos, debugs) will be output to the development console instead of Sentry.
+ *
+ * - `tracing`: Set to `true` to enable tracing, `false` to disable. When tracing is disabled, Otel traces will be logged to the development console.
+ *
+ * - `rum`: Set to `true` to enable Real User Monitoring (RUM), `false` to disable. The behavior of disabling RUM is to be determined (TBD).
+ *
+ * Examples:
+ *
+ * ```typescript
+ * // Example 1: Set all telemetry features to true
+ * const telemetry1: Telemetry = true;
+ *
+ * // Example 2: Set individual telemetry features using an object
+ * const telemetry2: Telemetry = {
+ *   logging: true,  // Enable logging
+ *   tracing: false, // Disable tracing
+ *   rum: true       // Enable RUM
+ * };
+ * ```
+ */
+export type Telemetry = boolean | {
+    logging?: boolean;
+    tracing?: boolean;
+    rum?: boolean;
+};

package/src/lib/apiClient.d.ts

@@ -1,9 +1,9 @@
-import type { RestLink } from 'apollo-link-rest';
-export type QueryResponse<T> = {
-    __typename: string;
-} & T;
-export type ApiMap = {
-    default?: string;
-    rest?: RestLink.Options;
-    [apiName: string]: string | any;
-};
+import type { RestLink } from 'apollo-link-rest';
+export type QueryResponse<T> = {
+    __typename: string;
+} & T;
+export type ApiMap = {
+    default?: string;
+    rest?: RestLink.Options;
+    [apiName: string]: string | any;
+};

package/src/lib/identityProvider.d.ts

@@ -1,15 +1,15 @@
-export type IdentityProviderName = 'cognito' | 'descope';
-export declare const DESCOPE_IDENTITY_PROVIDER: IdentityProviderName;
-export type IdentityProvider = {
-    name: IdentityProviderName;
-    projectId: string;
-    issuer?: string;
-    providerConfig?: {
-        tenantId?: string;
-        flows?: {
-            name: string;
-            id: string;
-        }[];
-        authDomain?: string;
-    };
-};
+export type IdentityProviderName = 'cognito' | 'descope';
+export declare const DESCOPE_IDENTITY_PROVIDER: IdentityProviderName;
+export type IdentityProvider = {
+    name: IdentityProviderName;
+    projectId: string;
+    issuer?: string;
+    providerConfig?: {
+        tenantId?: string;
+        flows?: {
+            name: string;
+            id: string;
+        }[];
+        authDomain?: string;
+    };
+};

package/src/lib/index.d.ts

@@ -1,3 +1,3 @@
-export * from './apiClient';
-export * from './identityProvider';
-export * from './utils';
+export * from './apiClient';
+export * from './identityProvider';
+export * from './utils';

package/src/lib/utils.d.ts

@@ -1 +1 @@
-export type PublicInterface<T> = Pick<T, keyof T>;
+export type PublicInterface<T> = Pick<T, keyof T>;

package/src/native-bridge.d.ts

@@ -1,257 +1,257 @@
-import type rnBiometrics from 'react-native-biometrics';
-import { BiometryTypes } from 'react-native-biometrics';
-import type TypedEmitter from 'typed-emitter';
-import type { OnAuthSuccessEventKey, OnAuthSuccessEventData, ErrorEventKey, ErrorEventData } from './native-components';
-import { openSettings, PermissionStatus } from 'react-native-permissions';
-import { PageTransitionEventKey, PageTransitionEventPayload } from '.';
-import { Platform } from 'react-native';
-export type NativeEvents<T = any> = {
-    openwebview: (url: string) => void;
-    closewebview: (data: T) => void;
-    reloadwebview: (preserveSession?: boolean) => void;
-    nativebridgedependencies: (nativeBridgeDependencies: PluginKeys[]) => void;
-    [OnAuthSuccessEventKey]: (data: OnAuthSuccessEventData) => void;
-    [ErrorEventKey]: (data: ErrorEventData) => void;
-    [PageTransitionEventKey]: (data: PageTransitionEventPayload) => void;
-};
-export type NativeBridgeEmittableEvents = Pick<NativeEvents, 'onauthsuccess' | 'error' | 'nativebridgedependencies'>;
-export type NativeEventEmitter = TypedEmitter<NativeEvents>;
-export type NativeEmittableEventEmitter = TypedEmitter<NativeBridgeEmittableEvents>;
-export interface IWebview {
-    open(url: string): void;
-    close<T>(data: T): void;
-    reload(preserveSession?: boolean): void;
-    isWithin: boolean;
-}
-type IBiometryInformation = {
-    biometryType: keyof typeof BiometryTypes | undefined;
-    error: string | undefined;
-};
-export interface IBiometrics {
-    isAvailable(): Promise<boolean>;
-    getBiometryInformation(): Promise<IBiometryInformation>;
-    biometricKeysExist(): ReturnType<Awaited<rnBiometrics['biometricKeysExist']>>;
-    createKeys(): ReturnType<Awaited<rnBiometrics['createKeys']>>;
-    createSignature(createSignatureOptions: Parameters<rnBiometrics['createSignature']>[0]): ReturnType<Awaited<rnBiometrics['createSignature']>>;
-    deleteKeys(): ReturnType<Awaited<rnBiometrics['deleteKeys']>>;
-    requestPermission(): Promise<PermissionStatus>;
-    checkPermission(): Promise<PermissionStatus>;
-}
-export type IEvents = Pick<NativeEventEmitter, 'emit'>;
-export interface IStorage {
-    /**
-     * Set a key value pair in storage.
-     * @param {string} key - Key to be used for storage persistance.
-     * @param {string} value - Value to be persisted.
-     * @return {void}
-     */
-    setItem(key: string, value: string): Promise<void>;
-    /**
-     * Extract data from storage based on supplied key.
-     * @param {string} key - Key to determine data to be extracted from storage.
-     * @return {string} Keyed data from storage.
-     */
-    getItem(key: string): Promise<string | null>;
-    /**
-     * Remove data from storage based on supplied key.
-     * @param {string} key - Key to determine what key/value to remove from storage.
-     * @return {void}
-     */
-    removeItem(key: string): Promise<void>;
-}
-export interface ICamera {
-    isAvailable(): Promise<boolean>;
-    requestPermission(): Promise<PermissionStatus>;
-    checkPermission(): Promise<PermissionStatus>;
-    requestRollPermission(): Promise<PermissionStatus>;
-    checkRollPermission(): Promise<PermissionStatus>;
-}
-export type AllowedDocumentType = 'image/png' | 'image/jpeg' | 'image/svg+xml' | 'application/pdf';
-export type DownloadLocation = 'Files' | 'Photos';
-export interface IDocumentDownload {
-    isAvailable(fileType: string): Promise<boolean>;
-    writeFile(filename: string, dataURL: string): Promise<DownloadLocation>;
-    requestPermission(fileType: string): Promise<GlobalPermissionStatus>;
-    checkPermission(fileType: string): Promise<GlobalPermissionStatus>;
-}
-export interface GeoOptions {
-    timeout?: number;
-    maximumAge?: number;
-    enableHighAccuracy?: boolean;
-}
-export interface GeoError {
-    code: number;
-    message: string;
-    PERMISSION_DENIED: number;
-    POSITION_UNAVAILABLE: number;
-    TIMEOUT: number;
-}
-export interface GeoCoordinates {
-    latitude: number;
-    longitude: number;
-    altitude: number | null;
-    accuracy: number;
-    altitudeAccuracy: number | null;
-    heading: number | null;
-    speed: number | null;
-}
-export interface GeoPosition {
-    coords: GeoCoordinates;
-    timestamp: number;
-}
-export interface IGeolocation {
-    isAvailable(): Promise<boolean>;
-    getCurrentPosition(options?: GeoOptions): Promise<GeoPosition>;
-    requestPermission(): Promise<GlobalPermissionStatus>;
-    checkPermission(): Promise<GlobalPermissionStatus>;
-}
-export type PrintOptions = {
-    html: string;
-    filePath?: never;
-} | {
-    html?: never;
-    filePath: string;
-};
-export interface IPrint {
-    print(options: PrintOptions): Promise<boolean | undefined>;
-}
-export type DocumentPickerResult = {
-    type: string | null;
-    name: string | null;
-    size: number | null;
-    base64: string;
-};
-export interface IDocumentPicker {
-    pickMultiple(): Promise<DocumentPickerResult[]>;
-    pickSingle(): Promise<DocumentPickerResult>;
-    requestPermission(): Promise<PermissionStatus>;
-    checkPermission(): Promise<PermissionStatus>;
-}
-export interface IPushNotifications {
-    isAvailable(): Promise<boolean>;
-    getDeviceToken(): Promise<string>;
-    requestPermission(): Promise<GlobalPermissionStatus>;
-    checkPermission(): Promise<GlobalPermissionStatus>;
-}
-export interface IUtils {
-    getPlatform(): Promise<typeof Platform.OS>;
-    getBundleId(): Promise<string | undefined>;
-}
-export interface ISystem {
-    openSettings: typeof openSettings;
-}
-export type DeepLinkType = {
-    scheme: string;
-    webUrl: string;
-};
-export interface IDeepLink {
-    openLink(deepLink: DeepLinkType, target?: string): Promise<void>;
-}
-export interface IConnectDevicesSessionUser {
-    userID: string;
-    organizationID: string;
-    accessToken: string;
-}
-export interface SyncRecord {
-    date: string;
-    metric: string;
-    value: number;
-    unit: string;
-}
-export interface IConnectDevices {
-    startSession(user: IConnectDevicesSessionUser): Promise<void>;
-    syncData(daysToFetch?: number): Promise<SyncRecord[]>;
-    refreshData(daysToFetch?: number): Promise<SyncRecord[]>;
-    endSession(): Promise<void>;
-    getCurrentUser(): Promise<IConnectDevicesSessionUser | null>;
-    checkPermissions(): Promise<boolean>;
-}
-export interface PasskeyCredentialDescriptor {
-    type: string;
-    id: string;
-    transports?: string[];
-}
-export interface PasskeyCreateRequest {
-    challenge: string;
-    rp: {
-        id: string;
-        name: string;
-    };
-    user: {
-        id: string;
-        name: string;
-        displayName: string;
-    };
-    pubKeyCredParams: Array<{
-        type: string;
-        alg: number;
-    }>;
-    timeout?: number;
-    excludeCredentials?: PasskeyCredentialDescriptor[];
-    authenticatorSelection?: {
-        authenticatorAttachment?: string;
-        requireResidentKey?: boolean;
-        residentKey?: string;
-        userVerification?: string;
-    };
-    attestation?: string;
-}
-export interface PasskeyCreateResult {
-    id: string;
-    rawId: string;
-    type?: string;
-    authenticatorAttachment?: string;
-    response: {
-        clientDataJSON: string;
-        attestationObject: string;
-    };
-}
-export interface PasskeyGetRequest {
-    challenge: string;
-    rpId: string;
-    timeout?: number;
-    allowCredentials?: PasskeyCredentialDescriptor[];
-    userVerification?: string;
-}
-export interface PasskeyGetResult {
-    id: string;
-    rawId: string;
-    type?: string;
-    authenticatorAttachment?: string;
-    response: {
-        authenticatorData: string;
-        clientDataJSON: string;
-        signature: string;
-        userHandle: string;
-    };
-}
-export interface IPasskey {
-    /** Whether the device supports passkeys (Android 28+ / iOS 15+). */
-    isSupported(): Promise<boolean>;
-    /** Perform a FIDO2 credential registration (navigator.credentials.create). */
-    create(request: PasskeyCreateRequest): Promise<PasskeyCreateResult>;
-    /** Perform a FIDO2 credential assertion (navigator.credentials.get). */
-    get(request: PasskeyGetRequest): Promise<PasskeyGetResult>;
-}
-export interface INativeBridge {
-    connectDevices: IConnectDevices;
-    webview: IWebview;
-    biometrics: IBiometrics;
-    events: IEvents;
-    storage: IStorage;
-    camera: ICamera;
-    geolocation: IGeolocation;
-    print: IPrint;
-    documentDownload: IDocumentDownload;
-    documentPicker: IDocumentPicker;
-    pushNotifications: IPushNotifications;
-    system: ISystem;
-    deepLink: IDeepLink;
-    utils: IUtils;
-    passkey: IPasskey;
-    reloadView(preserveSession?: boolean): void;
-}
-export type GlobalPermissionStatus = PermissionStatus | PermissionState;
-export type PluginKeys = Exclude<keyof INativeBridge, 'webview' | 'reloadView'>;
-export type MethodKeys<T extends PluginKeys> = keyof INativeBridge[T];
-export {};
+import type rnBiometrics from 'react-native-biometrics';
+import { BiometryTypes } from 'react-native-biometrics';
+import type TypedEmitter from 'typed-emitter';
+import type { OnAuthSuccessEventKey, OnAuthSuccessEventData, ErrorEventKey, ErrorEventData } from './native-components';
+import { openSettings, PermissionStatus } from 'react-native-permissions';
+import { PageTransitionEventKey, PageTransitionEventPayload } from '.';
+import { Platform } from 'react-native';
+export type NativeEvents<T = any> = {
+    openwebview: (url: string) => void;
+    closewebview: (data: T) => void;
+    reloadwebview: (preserveSession?: boolean) => void;
+    nativebridgedependencies: (nativeBridgeDependencies: PluginKeys[]) => void;
+    [OnAuthSuccessEventKey]: (data: OnAuthSuccessEventData) => void;
+    [ErrorEventKey]: (data: ErrorEventData) => void;
+    [PageTransitionEventKey]: (data: PageTransitionEventPayload) => void;
+};
+export type NativeBridgeEmittableEvents = Pick<NativeEvents, 'onauthsuccess' | 'error' | 'nativebridgedependencies'>;
+export type NativeEventEmitter = TypedEmitter<NativeEvents>;
+export type NativeEmittableEventEmitter = TypedEmitter<NativeBridgeEmittableEvents>;
+export interface IWebview {
+    open(url: string): void;
+    close<T>(data: T): void;
+    reload(preserveSession?: boolean): void;
+    isWithin: boolean;
+}
+type IBiometryInformation = {
+    biometryType: keyof typeof BiometryTypes | undefined;
+    error: string | undefined;
+};
+export interface IBiometrics {
+    isAvailable(): Promise<boolean>;
+    getBiometryInformation(): Promise<IBiometryInformation>;
+    biometricKeysExist(): ReturnType<Awaited<rnBiometrics['biometricKeysExist']>>;
+    createKeys(): ReturnType<Awaited<rnBiometrics['createKeys']>>;
+    createSignature(createSignatureOptions: Parameters<rnBiometrics['createSignature']>[0]): ReturnType<Awaited<rnBiometrics['createSignature']>>;
+    deleteKeys(): ReturnType<Awaited<rnBiometrics['deleteKeys']>>;
+    requestPermission(): Promise<PermissionStatus>;
+    checkPermission(): Promise<PermissionStatus>;
+}
+export type IEvents = Pick<NativeEventEmitter, 'emit'>;
+export interface IStorage {
+    /**
+     * Set a key value pair in storage.
+     * @param {string} key - Key to be used for storage persistance.
+     * @param {string} value - Value to be persisted.
+     * @return {void}
+     */
+    setItem(key: string, value: string): Promise<void>;
+    /**
+     * Extract data from storage based on supplied key.
+     * @param {string} key - Key to determine data to be extracted from storage.
+     * @return {string} Keyed data from storage.
+     */
+    getItem(key: string): Promise<string | null>;
+    /**
+     * Remove data from storage based on supplied key.
+     * @param {string} key - Key to determine what key/value to remove from storage.
+     * @return {void}
+     */
+    removeItem(key: string): Promise<void>;
+}
+export interface ICamera {
+    isAvailable(): Promise<boolean>;
+    requestPermission(): Promise<PermissionStatus>;
+    checkPermission(): Promise<PermissionStatus>;
+    requestRollPermission(): Promise<PermissionStatus>;
+    checkRollPermission(): Promise<PermissionStatus>;
+}
+export type AllowedDocumentType = 'image/png' | 'image/jpeg' | 'image/svg+xml' | 'application/pdf';
+export type DownloadLocation = 'Files' | 'Photos';
+export interface IDocumentDownload {
+    isAvailable(fileType: string): Promise<boolean>;
+    writeFile(filename: string, dataURL: string): Promise<DownloadLocation>;
+    requestPermission(fileType: string): Promise<GlobalPermissionStatus>;
+    checkPermission(fileType: string): Promise<GlobalPermissionStatus>;
+}
+export interface GeoOptions {
+    timeout?: number;
+    maximumAge?: number;
+    enableHighAccuracy?: boolean;
+}
+export interface GeoError {
+    code: number;
+    message: string;
+    PERMISSION_DENIED: number;
+    POSITION_UNAVAILABLE: number;
+    TIMEOUT: number;
+}
+export interface GeoCoordinates {
+    latitude: number;
+    longitude: number;
+    altitude: number | null;
+    accuracy: number;
+    altitudeAccuracy: number | null;
+    heading: number | null;
+    speed: number | null;
+}
+export interface GeoPosition {
+    coords: GeoCoordinates;
+    timestamp: number;
+}
+export interface IGeolocation {
+    isAvailable(): Promise<boolean>;
+    getCurrentPosition(options?: GeoOptions): Promise<GeoPosition>;
+    requestPermission(): Promise<GlobalPermissionStatus>;
+    checkPermission(): Promise<GlobalPermissionStatus>;
+}
+export type PrintOptions = {
+    html: string;
+    filePath?: never;
+} | {
+    html?: never;
+    filePath: string;
+};
+export interface IPrint {
+    print(options: PrintOptions): Promise<boolean | undefined>;
+}
+export type DocumentPickerResult = {
+    type: string | null;
+    name: string | null;
+    size: number | null;
+    base64: string;
+};
+export interface IDocumentPicker {
+    pickMultiple(): Promise<DocumentPickerResult[]>;
+    pickSingle(): Promise<DocumentPickerResult>;
+    requestPermission(): Promise<PermissionStatus>;
+    checkPermission(): Promise<PermissionStatus>;
+}
+export interface IPushNotifications {
+    isAvailable(): Promise<boolean>;
+    getDeviceToken(): Promise<string>;
+    requestPermission(): Promise<GlobalPermissionStatus>;
+    checkPermission(): Promise<GlobalPermissionStatus>;
+}
+export interface IUtils {
+    getPlatform(): Promise<typeof Platform.OS>;
+    getBundleId(): Promise<string | undefined>;
+}
+export interface ISystem {
+    openSettings: typeof openSettings;
+}
+export type DeepLinkType = {
+    scheme: string;
+    webUrl: string;
+};
+export interface IDeepLink {
+    openLink(deepLink: DeepLinkType, target?: string): Promise<void>;
+}
+export interface IConnectDevicesSessionUser {
+    userID: string;
+    organizationID: string;
+    accessToken: string;
+}
+export interface SyncRecord {
+    date: string;
+    metric: string;
+    value: number;
+    unit: string;
+}
+export interface IConnectDevices {
+    startSession(user: IConnectDevicesSessionUser): Promise<void>;
+    syncData(daysToFetch?: number): Promise<SyncRecord[]>;
+    refreshData(daysToFetch?: number): Promise<SyncRecord[]>;
+    endSession(): Promise<void>;
+    getCurrentUser(): Promise<IConnectDevicesSessionUser | null>;
+    checkPermissions(): Promise<boolean>;
+}
+export interface PasskeyCredentialDescriptor {
+    type: string;
+    id: string;
+    transports?: string[];
+}
+export interface PasskeyCreateRequest {
+    challenge: string;
+    rp: {
+        id: string;
+        name: string;
+    };
+    user: {
+        id: string;
+        name: string;
+        displayName: string;
+    };
+    pubKeyCredParams: Array<{
+        type: string;
+        alg: number;
+    }>;
+    timeout?: number;
+    excludeCredentials?: PasskeyCredentialDescriptor[];
+    authenticatorSelection?: {
+        authenticatorAttachment?: string;
+        requireResidentKey?: boolean;
+        residentKey?: string;
+        userVerification?: string;
+    };
+    attestation?: string;
+}
+export interface PasskeyCreateResult {
+    id: string;
+    rawId: string;
+    type?: string;
+    authenticatorAttachment?: string;
+    response: {
+        clientDataJSON: string;
+        attestationObject: string;
+    };
+}
+export interface PasskeyGetRequest {
+    challenge: string;
+    rpId: string;
+    timeout?: number;
+    allowCredentials?: PasskeyCredentialDescriptor[];
+    userVerification?: string;
+}
+export interface PasskeyGetResult {
+    id: string;
+    rawId: string;
+    type?: string;
+    authenticatorAttachment?: string;
+    response: {
+        authenticatorData: string;
+        clientDataJSON: string;
+        signature: string;
+        userHandle: string;
+    };
+}
+export interface IPasskey {
+    /** Whether the device supports passkeys (Android 28+ / iOS 15+). */
+    isSupported(): Promise<boolean>;
+    /** Perform a FIDO2 credential registration (navigator.credentials.create). */
+    create(request: PasskeyCreateRequest): Promise<PasskeyCreateResult>;
+    /** Perform a FIDO2 credential assertion (navigator.credentials.get). */
+    get(request: PasskeyGetRequest): Promise<PasskeyGetResult>;
+}
+export interface INativeBridge {
+    connectDevices: IConnectDevices;
+    webview: IWebview;
+    biometrics: IBiometrics;
+    events: IEvents;
+    storage: IStorage;
+    camera: ICamera;
+    geolocation: IGeolocation;
+    print: IPrint;
+    documentDownload: IDocumentDownload;
+    documentPicker: IDocumentPicker;
+    pushNotifications: IPushNotifications;
+    system: ISystem;
+    deepLink: IDeepLink;
+    utils: IUtils;
+    passkey: IPasskey;
+    reloadView(preserveSession?: boolean): void;
+}
+export type GlobalPermissionStatus = PermissionStatus | PermissionState;
+export type PluginKeys = Exclude<keyof INativeBridge, 'webview' | 'reloadView'>;
+export type MethodKeys<T extends PluginKeys> = keyof INativeBridge[T];
+export {};

package/src/native-components.d.ts

@@ -1,51 +1,51 @@
-import { NativeModuleMap } from './native-plugins';
-import { PageTransitionEventKey, PageTransitionEventPayload, Telemetry } from '.';
-export type OnAuthSuccessEventData = {
-    user: {
-        id: string;
-    };
-};
-export type ErrorEventData = {
-    name: string;
-    message: string;
-    errorCode?: string;
-};
-export declare const OnAuthSuccessEventKey = "onauthsuccess";
-export declare const ErrorEventKey = "error";
-export type EventKeyToDataMap = {
-    [OnAuthSuccessEventKey]: OnAuthSuccessEventData;
-    [ErrorEventKey]: ErrorEventData;
-    [PageTransitionEventKey]: PageTransitionEventPayload;
-};
-type OnEventData<T extends keyof EventKeyToDataMap> = {
-    key: T;
-    data: EventKeyToDataMap[T];
-};
-type Path = {
-    value: string;
-    onResetValue: () => void;
-};
-export type ComponentViewBaseProps = {
-    clientKey: string;
-    initialPath?: string;
-    path?: Path;
-    onEvent?: <T extends keyof EventKeyToDataMap>(data: OnEventData<T>) => void;
-    debug?: boolean;
-    nativeModules?: NativeModuleMap;
-    telemetry?: Telemetry;
-} & ({
-    /** Supply the auth strategy. Defaults to `jwe` which will require a `userToken` prop.
-     *
-     * _NOTE_: TS can say `authStrategy` missing. Can be resolved by supplying `userToken`. */
-    authStrategy?: 'jwe';
-    userToken: string;
-    webOrigin?: never;
-} | {
-    authStrategy: 'credential';
-    userToken?: never;
-    /** Optional override for the WebView origin. When set, `window.origin` inside the WebView
-     * will be `https://<webOrigin>`. Used to align the WebView origin with passkey RP ID domains.
-     * Example: `sub.domain.com` */
-    webOrigin?: string;
-});
-export {};
+import { NativeModuleMap } from './native-plugins';
+import { PageTransitionEventKey, PageTransitionEventPayload, Telemetry } from '.';
+export type OnAuthSuccessEventData = {
+    user: {
+        id: string;
+    };
+};
+export type ErrorEventData = {
+    name: string;
+    message: string;
+    errorCode?: string;
+};
+export declare const OnAuthSuccessEventKey = "onauthsuccess";
+export declare const ErrorEventKey = "error";
+export type EventKeyToDataMap = {
+    [OnAuthSuccessEventKey]: OnAuthSuccessEventData;
+    [ErrorEventKey]: ErrorEventData;
+    [PageTransitionEventKey]: PageTransitionEventPayload;
+};
+type OnEventData<T extends keyof EventKeyToDataMap> = {
+    key: T;
+    data: EventKeyToDataMap[T];
+};
+type Path = {
+    value: string;
+    onResetValue: () => void;
+};
+export type ComponentViewBaseProps = {
+    clientKey: string;
+    initialPath?: string;
+    path?: Path;
+    onEvent?: <T extends keyof EventKeyToDataMap>(data: OnEventData<T>) => void;
+    debug?: boolean;
+    nativeModules?: NativeModuleMap;
+    telemetry?: Telemetry;
+} & ({
+    /** Supply the auth strategy. Defaults to `jwe` which will require a `userToken` prop.
+     *
+     * _NOTE_: TS can say `authStrategy` missing. Can be resolved by supplying `userToken`. */
+    authStrategy?: 'jwe';
+    userToken: string;
+    webOrigin?: never;
+} | {
+    authStrategy: 'credential';
+    userToken?: never;
+    /** Optional override for the WebView origin. When set, `window.origin` inside the WebView
+     * will be `https://<webOrigin>`. Used to align the WebView origin with passkey RP ID domains.
+     * Example: `sub.domain.com` */
+    webOrigin?: string;
+});
+export {};

package/src/native-plugins.d.ts

@@ -1,39 +1,39 @@
-import type * as androidLocationEnabler from 'react-native-android-location-enabler';
-import type biometrics from 'react-native-biometrics';
-import type documentPicker from '@react-native-documents/picker';
-import type fileSystem from 'react-native-fs';
-import type * as pushNotifications from 'react-native-notifications';
-import type permissions from 'react-native-permissions';
-import type print from 'react-native-print';
-import type storage from '@react-native-async-storage/async-storage';
-import type * as cameraRoll from '@react-native-camera-roll/camera-roll';
-import type geolocation from '@react-native-community/geolocation';
-import type deviceInfo from 'react-native-device-info';
-import type * as connectDevicesCore from '@validic-mobile/react-native-inform-core';
-import type * as connectDevicesHealthConnect from '@validic-mobile/react-native-inform-healthconnect';
-import type * as connectDevicesHealthKit from '@validic-mobile/react-native-inform-healthkit';
-export interface PasskeyModule {
-    isSupported(): boolean;
-    create(request: import('./native-bridge').PasskeyCreateRequest): Promise<import('./native-bridge').PasskeyCreateResult>;
-    get(request: import('./native-bridge').PasskeyGetRequest): Promise<import('./native-bridge').PasskeyGetResult>;
-}
-export type NativePackage = '@react-native-async-storage/async-storage' | '@react-native-community/geolocation' | '@react-native-camera-roll/camera-roll' | 'react-native-biometrics' | 'react-native-permissions' | 'react-native-print' | 'react-native-webview' | 'react-native-fs' | '@react-native-documents/picker' | 'react-native-notifications' | 'react-native-device-info' | 'react-native-android-location-enabler' | '@validic-mobile/react-native-inform-core' | '@validic-mobile/react-native-inform-healthconnect' | '@validic-mobile/react-native-inform-healthkit' | 'react-native-passkey';
-export type NativePackages = Array<NativePackage>;
-export type NativeModuleMap = {
-    androidLocationEnabler?: typeof androidLocationEnabler;
-    biometrics?: typeof biometrics;
-    permissions?: typeof permissions;
-    cameraRoll?: typeof cameraRoll;
-    fileSystem?: typeof fileSystem;
-    documentPicker?: typeof documentPicker;
-    geolocation?: typeof geolocation;
-    print?: typeof print;
-    storage?: typeof storage;
-    pushNotifications?: typeof pushNotifications;
-    deviceInfo?: typeof deviceInfo;
-    connectDevicesCore?: typeof connectDevicesCore;
-    connectDevicesHealthConnect?: typeof connectDevicesHealthConnect;
-    connectDevicesHealthKit?: typeof connectDevicesHealthKit;
-    passkey?: PasskeyModule;
-};
-export type NativeModules = (keyof NativeModuleMap)[];
+import type * as androidLocationEnabler from 'react-native-android-location-enabler';
+import type biometrics from 'react-native-biometrics';
+import type documentPicker from '@react-native-documents/picker';
+import type fileSystem from 'react-native-fs';
+import type * as pushNotifications from 'react-native-notifications';
+import type permissions from 'react-native-permissions';
+import type print from 'react-native-print';
+import type storage from '@react-native-async-storage/async-storage';
+import type * as cameraRoll from '@react-native-camera-roll/camera-roll';
+import type geolocation from '@react-native-community/geolocation';
+import type deviceInfo from 'react-native-device-info';
+import type * as connectDevicesCore from '@validic-mobile/react-native-inform-core';
+import type * as connectDevicesHealthConnect from '@validic-mobile/react-native-inform-healthconnect';
+import type * as connectDevicesHealthKit from '@validic-mobile/react-native-inform-healthkit';
+export interface PasskeyModule {
+    isSupported(): boolean;
+    create(request: import('./native-bridge').PasskeyCreateRequest): Promise<import('./native-bridge').PasskeyCreateResult>;
+    get(request: import('./native-bridge').PasskeyGetRequest): Promise<import('./native-bridge').PasskeyGetResult>;
+}
+export type NativePackage = '@react-native-async-storage/async-storage' | '@react-native-community/geolocation' | '@react-native-camera-roll/camera-roll' | 'react-native-biometrics' | 'react-native-permissions' | 'react-native-print' | 'react-native-webview' | 'react-native-fs' | '@react-native-documents/picker' | 'react-native-notifications' | 'react-native-device-info' | 'react-native-android-location-enabler' | '@validic-mobile/react-native-inform-core' | '@validic-mobile/react-native-inform-healthconnect' | '@validic-mobile/react-native-inform-healthkit' | 'react-native-passkey';
+export type NativePackages = Array<NativePackage>;
+export type NativeModuleMap = {
+    androidLocationEnabler?: typeof androidLocationEnabler;
+    biometrics?: typeof biometrics;
+    permissions?: typeof permissions;
+    cameraRoll?: typeof cameraRoll;
+    fileSystem?: typeof fileSystem;
+    documentPicker?: typeof documentPicker;
+    geolocation?: typeof geolocation;
+    print?: typeof print;
+    storage?: typeof storage;
+    pushNotifications?: typeof pushNotifications;
+    deviceInfo?: typeof deviceInfo;
+    connectDevicesCore?: typeof connectDevicesCore;
+    connectDevicesHealthConnect?: typeof connectDevicesHealthConnect;
+    connectDevicesHealthKit?: typeof connectDevicesHealthKit;
+    passkey?: PasskeyModule;
+};
+export type NativeModules = (keyof NativeModuleMap)[];