dome-embedded-app-sdk 0.2.4-experimental.5 → 0.2.4

package/dist/card-sdk.d.ts

@@ -0,0 +1,184 @@
+import { DomeEmbeddedAppSdk, ClientMessageType } from "./dome-sdk";
+type CardPermissionsMap = Record<string, string>;
+interface CardUserRole {
+    key?: string;
+    name?: string;
+    description?: string | null;
+    abbr?: string;
+}
+export interface CardKeyBlobV1 {
+    v: 1;
+    seed: number;
+    obf: number[];
+}
+export type CardKeyBlob = CardKeyBlobV1;
+export declare function getKeyFromBlob(blob: CardKeyBlob): Uint8Array;
+export declare enum CardPermission {
+    READ = "r",
+    WRITE = "w",
+    FORWARD = "f",
+    SHARE = "s",
+    DOWNLOAD = "d"
+}
+export declare const cardPermission: typeof CardPermission;
+export interface CardEventHandler {
+    onInit: (data: any) => void;
+    onError: (data: {
+        error_code: string | number;
+        message: string;
+        data: any;
+    }) => void;
+    onFileChange: (data: {
+        iuid: string;
+        data: {
+            data: {
+                type: string;
+                value: any;
+            };
+            link: {
+                url: string;
+            };
+            meta: any;
+            perms: any;
+            from_cache: boolean;
+        };
+    }) => void;
+    onRefreshRequest?: (data: any) => void;
+}
+export type CardFsCallback<T = any> = (payload: T) => void;
+export interface CardFsReadResult {
+    name?: string;
+    iuid?: string | null;
+    object?: any;
+    data?: any;
+    is_stale: boolean;
+    is_complete: boolean;
+}
+export interface CardFsReadHandler {
+    next: CardFsCallback<CardFsReadResult>;
+    error?: CardFsCallback<Error>;
+}
+/**
+ * Use CardSdk to create webapp cards
+ */
+export declare class CardSdk extends DomeEmbeddedAppSdk {
+    private static instance;
+    private handler;
+    private cryptoA01;
+    private static readonly FS_RESPONSE_TIMEOUT_MS;
+    private static readonly FS_READ_RETENTION_MS;
+    private static readonly CARD_FS_ACK_TIMEOUT_MS;
+    private static readonly DEFAULT_ROLE_PERMISSIONS;
+    dataStore: any;
+    private accessToken;
+    devMode: boolean;
+    permission: CardPermissionsMap | null;
+    userRole: CardUserRole | null;
+    cardFS: {
+        read: (name: string, handler: CardFsReadHandler, allowStale?: boolean) => void;
+        readById: (iuid: string, handler: CardFsReadHandler, allowStale?: boolean) => void;
+        write: (name: string, fileData: any, onResult?: CardFsCallback) => Promise<any>;
+        writeById: (iuid: string, fileData: any, onResult?: CardFsCallback) => Promise<any>;
+        delete: (name: string, onResult?: CardFsCallback) => Promise<any>;
+        deleteById: (iuid: string, onResult?: CardFsCallback) => Promise<any>;
+        list: (onResult?: CardFsCallback) => Promise<any>;
+    };
+    private fsReadRequests;
+    private fsWriteRequests;
+    private cardFsCache;
+    private containerIuid?;
+    private pendingAcks;
+    private buildCardFsMessagePayload;
+    private assertValidReadHandler;
+    private invokeReadHandlerNext;
+    private invokeReadHandlerError;
+    private sanitizeReadData;
+    private getCardIuid;
+    private ensureCardFsCache;
+    private supportsParentCardFs;
+    private shouldUseCardFsFallback;
+    private constructor();
+    /**
+     * Static initialization method to get or create the singleton instance of CardSdk.
+     * @param secret - The card developer secret key
+     * @param handler - (Optional) Handler for different events emitted by the SDK
+     * @returns The singleton CardSdk instance
+     */
+    static init(secret: string, handler?: CardEventHandler, options?: {
+        devMode?: boolean;
+    }): Promise<CardSdk>;
+    /**
+     * Method to set or update the handler object.
+     * @param handler - Custom handler for different message types
+     */
+    setHandler(handler: CardEventHandler): void;
+    /**
+     * Sends a deep link request to the parent directly from the card.
+     */
+    openDeepLink(href: string): void;
+    /**
+     * Checks if the user has the requested permission.
+     * @param permission - A value from CardPermission enum (e.g CardPermission.READ, CardPermission.WRITE)
+     * @returns Boolean based on the permission presence
+     */
+    hasPerm(permission: CardPermission): boolean;
+    /**
+     * Checks if the permissions allow reading
+     * @returns - True if the permission string allows read access to user
+     */
+    canRead(): boolean;
+    /**
+     * Checks if the permissions allow writing
+     * @returns - True if the permission string allows write access to user
+     */
+    canWrite(): boolean;
+    private deriveSecretSeed;
+    private getCardIuidEnc;
+    private requestAf1DataFromParent;
+    private fetchAf1Data;
+    private initializeCardSdk;
+    private sendInit;
+    private getWebappDetails;
+    private sendMessageWithAck;
+    private resolvePendingAckByType;
+    protected handleMessage: (type: ClientMessageType, data: any) => void;
+    private cardsFsRead;
+    private cardsFsReadById;
+    private cardsFsReadInternal;
+    private cardsFsWrite;
+    private cardsFsWriteById;
+    private cardsFsWriteInternal;
+    private cardsFsDelete;
+    private cardsFsDeleteById;
+    private cardsFsDeleteInternal;
+    private cardsFsList;
+    private handleFsReadDataMessage;
+    private clearFsReadRequest;
+    private failFsReadRequest;
+    private clearFsWriteRequest;
+    private failFsWriteRequest;
+    private handleFsWriteSuccess;
+    private handleFsWriteError;
+    private cardsFsReadFallback;
+    private cardsFsWriteFallback;
+    private cardsFsDeleteFallback;
+    private cardsFsListFallback;
+    private authHeader;
+    private fetchDocumentMetadataByTarget;
+    private fetchDocumentMetadataByIuid;
+    private normalizeDocumentsResponse;
+    private fetchDocumentMetadataByName;
+    private fetchAllDocuments;
+    private fetchDocumentPayload;
+    private fetchDocumentData;
+    private buildFileFormData;
+    private upsertDocumentViaApi;
+    private formatErrorMessage;
+    private sendEventError;
+    setFileDirty(data: {
+        iuid: string;
+        ts_m: number;
+    }): void;
+    getUsername(userObj: any): string;
+}
+export {};

package/dist/dome-sdk.d.ts

@@ -1,33 +1,40 @@
 export declare enum ViewerMessageType {
     CONNECTION_SUCCESS = "CONNECTION_SUCCESS",
-    INIT = "INIT",// Indicates the app is initialized
-    REQUEST_SAVE = "REQUEST_SAVE",// Request to save data in the parent
-    REQUEST_CLOSE = "REQUEST_CLOSE",// Request to save data in the parent
-    REQUEST_INITIAL_DATA = "REQUEST_INITIAL_DATA",// Request to load initial data from the parent
-    SET_DIRTY = "SET_DIRTY",// Indicates the app has unsaved changes
-    SEND_CLOSE = "SEND_CLOSE",// Signals the app is ready to close
+    INIT = "INIT",
+    REQUEST_SAVE = "REQUEST_SAVE",
+    REQUEST_CLOSE = "REQUEST_CLOSE",
+    REQUEST_INITIAL_DATA = "REQUEST_INITIAL_DATA",
+    SET_DIRTY = "SET_DIRTY",
+    SEND_CLOSE = "SEND_CLOSE",
     SEND_EXCEPTION = "SEND_EXCEPTION"
 }
-declare enum ClientMessageType {
+export declare enum ClientMessageType {
     CONNECT = "CONNECT",
-    REQUEST_CLOSE = "REQUEST_CLOSE",// Requests the app to close
-    REQUEST_SAVE = "REQUEST_SAVE",// Requests the app for data to be saved
-    SAVE_ERROR = "SAVE_ERROR",// Sends status of the save event
-    SAVE_SUCCESS = "SAVE_SUCCESS",// Sends status of the save event
+    REQUEST_CLOSE = "REQUEST_CLOSE",
+    REQUEST_SAVE = "REQUEST_SAVE",
+    SAVE_ERROR = "SAVE_ERROR",
+    SAVE_SUCCESS = "SAVE_SUCCESS",
     DATA_CHANGE = "DATA_CHANGE",
     FILE_DATA = "FILE_DATA",
     WRITE_FILE_ACK = "WRITE_FILE_ACK",
     READ_FILE_ACK = "READ_FILE_ACK",
-    DELETE_FILE_ACK = "DELETE_FILE_ACK",// Cards FS delete response
-    LIST_FILES_ACK = "LIST_FILES_ACK",// Cards FS list response
+    DELETE_FILE_ACK = "DELETE_FILE_ACK",
+    LIST_FILES_ACK = "LIST_FILES_ACK",
     INIT_ACK = "INIT_ACK",
     AF1_DATA_TOKEN_ACK = "AF1_DATA_TOKEN_ACK",
     ERROR = "ERROR",
     REFRESH = "REFRESH"
 }
-interface SaveStatusData {
-    status: 'success' | 'error';
-    message: string;
+export declare enum CardMessageType {
+    APP_READY = "APP_READY",
+    INIT = "INIT",
+    READ_FILE = "READ_FILE",
+    WRITE_FILE = "WRITE_FILE",
+    DELETE_FILE = "DELETE_FILE",
+    LIST_FILES = "LIST_FILES",
+    FILE_DIRTY = "FILE_DIRTY",
+    OPEN_DEEPLINK = "OPEN_DEEPLINK",
+    AF1_DATA_TOKEN = "AF1_DATA_TOKEN"
 }
 export interface HostInfo {
     type: string;
@@ -48,42 +55,7 @@ export interface HostCapabilities {
 export type HostDetails = HostInfo & {
     capabilities?: HostCapabilities;
 };
-export interface ViewerEventHandler {
-    onInitialData: (data: {
-        doc: Document;
-        ui: UiProps;
-        isNewFile: boolean;
-        perms: any;
-        config?: Record<string, any>;
-    }) => void;
-    onDataChange?: (data: {
-        doc: Document;
-        perms: any;
-        userConsent: "override" | null;
-    }) => void;
-    onCloseRequest: () => void;
-    onSaveRequest: () => void;
-}
-export interface Document {
-    data: any;
-    name: string;
-    type: string;
-}
-export interface UiProps {
-    theme: string;
-}
-type CardPermissionsMap = Record<string, string>;
-interface CardUserRole {
-    key?: string;
-    name?: string;
-    description?: string | null;
-    abbr?: string;
-}
-/**
- * DomeEmbeddedAppSdk:
- * Base SDK class providing methods to send messages to the parent application.
- */
-declare class DomeEmbeddedAppSdk {
+export declare class DomeEmbeddedAppSdk {
     private readonly targetOrigin;
     protected isAppReady: boolean;
     protected port2: MessagePort | null;
@@ -92,303 +64,16 @@ declare class DomeEmbeddedAppSdk {
     protected parentCapabilities: HostCapabilities | null;
     private readonly handleDeepLinkClick;
     constructor();
-    /**
-     * Detects the host (iOS, Android, or Web) and saves it.
-     */
     private detectHost;
-    /**
-     * Listens for deep link anchor clicks on web to forward them to the parent app.
-     */
     private setupDeepLinkInterception;
-    /**
-     * Sends an OPEN_DEEPLINK message when the href uses an allowed protocol.
-     * @returns true if the message was dispatched, false otherwise.
-     */
     protected emitDeepLink(href: string): boolean;
     protected updateParentContext(host?: HostInfo | null, capabilities?: HostCapabilities | null): void;
     getHost(): HostDetails;
-    /**
-    * Method to send messages to the parent application.
-    * Ensures the parent window exists and sends a structured message with type and data.
-    * @param type - The type of message being sent
-    * @param data - (Optional) payload data for the message
-    */
     protected sendMessage(type: ViewerMessageType | CardMessageType, data?: any): void;
-    /**
-     * Notifies the parent application that the app is ready, if it hasn’t already.
-     */
     protected sendAppInit(): void;
-    /**
-     * Safely invokes a function from the handler object if it exists.
-     * and logs a warning if the handler is not provided for the given message type.
-     *
-     * @param eventName - Name of the event method to be invoked from the handler.
-     * @param handlerObj - The handler object that contains the message handling methods.
-     * @param data - (Optional) The data to be passed to the handler function if invoked.
-     */
-    protected safeInvoke<T extends ViewerEventHandler | CardEventHandler>(eventName: keyof T, handlerObj: T, data?: any): void;
+    protected safeInvoke<T extends Record<string, any>>(eventName: keyof T, handlerObj: T, data?: any): void;
     protected setupParentConnection(): Promise<void>;
     private notifyConnectionSuccess;
     private handlePortMessage;
     protected handleMessage(type: string, data: any): void;
 }
-/**
- * ViewerSdk:
- * A subclass of DomeEmbeddedAppSdk specifically for document viewer applications.
- * It includes additional methods and properties to manage app interactions.
- */
-export declare class ViewerSdk extends DomeEmbeddedAppSdk {
-    private static instance;
-    private static initialized;
-    private handler;
-    private pendingRequests;
-    private pendingInitAck;
-    private constructor();
-    /**
-     * Static initialization method to get or create the singleton instance of ViewerSdk.
-     * Allows setting the handler during initialization.
-     * @param handler - (Optional) Custom handler for different message types
-     * @returns The singleton ViewerSdk instance
-     */
-    static init(handler?: ViewerEventHandler): ViewerSdk;
-    /**
-     * Method to set or update the handler object.
-     * @param handler - Custom handler for different message types
-     */
-    setHandler(handler: ViewerEventHandler): void;
-    /**
-     * Checks if the given permissions string allows reading.
-     * @param perms - The permissions string.
-     * @returns - True if the permission string includes read access.
-     */
-    canRead(perms?: string): boolean;
-    /**
-     * Checks if the given permissions string allows writing.
-     * @param perms - The permissions string.
-     * @returns - True if the permission string includes write access.
-     */
-    canWrite(perms?: string): boolean;
-    initializeViewerSdk(): void;
-    /**
-     * Sends a request to the parent application to retrieve initial data.
-     */
-    requestInitialData(): void;
-    /**
-     * Sends a request to the parent application to save data.
-     * @param doc - payload data to be saved
-     * @param isDataDirty - Boolean indicating indicating modified data
-     */
-    requestSave(doc: Document, isDataDirty: boolean): Promise<SaveStatusData>;
-    private handleOnSave;
-    /**
-     * Sets the viewer's "dirty" state, indicating modified data.
-     * @param isDirty - Boolean indicating whether the viewer has modified data
-     */
-    setDirty(isDirty: boolean): void;
-    /**
-     * Sends a close request to the parent, with information on whether the data is dirty.
-     * @param doc - Latest document data
-     * @param isDataDirty - Boolean indicating indicating modified data
-     */
-    sendClose(doc: Document, isDataDirty: boolean): void;
-    /**
-     * Sends an exception to parent.
-     * @param error - An error object with name and message or an error string
-     */
-    sendException(error: {
-        name?: string;
-        message: string;
-    } | string): void;
-    protected handleMessage(type: ClientMessageType, data: any): void;
-}
-export declare enum CardMessageType {
-    APP_READY = "APP_READY",// Indicates the app is ready to be interacted with
-    INIT = "INIT",// Event to send the init key to the viewer
-    READ_FILE = "READ_FILE",
-    WRITE_FILE = "WRITE_FILE",
-    DELETE_FILE = "DELETE_FILE",
-    LIST_FILES = "LIST_FILES",
-    FILE_DIRTY = "FILE_DIRTY",
-    OPEN_DEEPLINK = "OPEN_DEEPLINK",// Sends a deep link href back to the parent
-    AF1_DATA_TOKEN = "AF1_DATA_TOKEN"
-}
-export declare enum CardPermission {
-    READ = "r",
-    WRITE = "w",
-    FORWARD = "f",
-    SHARE = "s",
-    DOWNLOAD = "d"
-}
-export declare const cardPermission: typeof CardPermission;
-export interface CardEventHandler {
-    onInit: (data: any) => void;
-    onError: (data: {
-        error_code: string | number;
-        message: string;
-        data: any;
-    }) => void;
-    onFileChange: (data: {
-        iuid: string;
-        data: {
-            data: {
-                type: string;
-                value: any;
-            };
-            link: {
-                url: string;
-            };
-            meta: any;
-            perms: any;
-            from_cache: boolean;
-        };
-    }) => void;
-    onRefreshRequest: (data: any) => void;
-}
-export type CardFsCallback<T = any> = (payload: T) => void;
-export interface CardFsReadResult {
-    name?: string;
-    iuid?: string | null;
-    object?: any;
-    data?: any;
-    is_stale: boolean;
-    is_complete: boolean;
-}
-export interface CardFsReadHandler {
-    next: CardFsCallback<CardFsReadResult>;
-    error?: CardFsCallback<Error>;
-}
-/**
- * Use CardSdk to create webapp cards
- */
-export declare class CardSdk extends DomeEmbeddedAppSdk {
-    private static instance;
-    private handler;
-    private cryptoA01;
-    private static readonly FS_RESPONSE_TIMEOUT_MS;
-    private static readonly FS_READ_RETENTION_MS;
-    private static readonly CARD_FS_ACK_TIMEOUT_MS;
-    private static readonly DEFAULT_ROLE_PERMISSIONS;
-    dataStore: any;
-    private accessToken;
-    devMode: boolean;
-    permission: CardPermissionsMap | null;
-    userRole: CardUserRole | null;
-    cardFS: {
-        read: (name: string, handler: CardFsReadHandler, allowStale?: boolean) => void;
-        readById: (iuid: string, handler: CardFsReadHandler, allowStale?: boolean) => void;
-        write: (name: string, fileData: any, onResult?: CardFsCallback) => Promise<any>;
-        writeById: (iuid: string, fileData: any, onResult?: CardFsCallback) => Promise<any>;
-        delete: (name: string, onResult?: CardFsCallback) => Promise<any>;
-        deleteById: (iuid: string, onResult?: CardFsCallback) => Promise<any>;
-        list: (onResult?: CardFsCallback) => Promise<any>;
-    };
-    private fsReadRequests;
-    private fsWriteRequests;
-    private cardFsCache;
-    private containerIuid?;
-    private pendingAcks;
-    private buildCardFsMessagePayload;
-    private assertValidReadHandler;
-    private invokeReadHandlerNext;
-    private invokeReadHandlerError;
-    private sanitizeReadData;
-    private getCardIuid;
-    private ensureCardFsCache;
-    private supportsParentCardFs;
-    private shouldUseCardFsFallback;
-    private constructor();
-    /**
-     * Static initialization method to get or create the singleton instance of CardSdk.
-     * @param secret - The card developer secret key
-     * @param handler - (Optional) Handler for different events emitted by the SDK
-     * @returns The singleton CardSdk instance
-     */
-    static init(secret: string, handler?: CardEventHandler, options?: {
-        devMode?: boolean;
-    }): Promise<CardSdk>;
-    /**
-     * Method to set or update the handler object.
-     * @param handler - Custom handler for different message types
-     */
-    setHandler(handler: CardEventHandler): void;
-    /**
-     * Sends a deep link request to the parent directly from the card.
-     */
-    openDeepLink(href: string): void;
-    /**
-     * Checks if the user has the requested permission.
-     * @param permission - A value from CardPermission enum (e.g CardPermission.READ, CardPermission.WRITE)
-     * @returns Boolean based on the permission presence
-     */
-    hasPerm(permission: CardPermission): boolean;
-    /**
-     * Checks if the permissions allow reading
-     * @returns - True if the permission string allows read access to user
-     */
-    canRead(): boolean;
-    /**
-     * Checks if the permissions allow writing
-     * @returns - True if the permission string allows write access to user
-     */
-    canWrite(): boolean;
-    private deriveSecretSeed;
-    private getCardIuidEnc;
-    private requestAf1DataFromParent;
-    private fetchAf1Data;
-    private initializeCardSdk;
-    private sendInit;
-    private getWebappDetails;
-    private sendMessageWithAck;
-    private resolvePendingAckByType;
-    protected handleMessage: (type: ClientMessageType, data: any) => void;
-    private cardsFsRead;
-    private cardsFsReadById;
-    private cardsFsReadInternal;
-    private cardsFsWrite;
-    private cardsFsWriteById;
-    private cardsFsWriteInternal;
-    private cardsFsDelete;
-    private cardsFsDeleteById;
-    private cardsFsDeleteInternal;
-    private cardsFsList;
-    private handleFsReadDataMessage;
-    private clearFsReadRequest;
-    private failFsReadRequest;
-    private clearFsWriteRequest;
-    private failFsWriteRequest;
-    private handleFsWriteSuccess;
-    private handleFsWriteError;
-    private cardsFsReadFallback;
-    private cardsFsWriteFallback;
-    private cardsFsDeleteFallback;
-    private cardsFsListFallback;
-    private authHeader;
-    private jsonHeaders;
-    private fetchDocumentMetadataByTarget;
-    private fetchDocumentMetadataByIuid;
-    private normalizeDocumentsResponse;
-    private extractHttpErrorMessage;
-    private fetchDocumentMetadataByName;
-    private fetchAllDocuments;
-    private fetchDocumentPayload;
-    private fetchDocumentData;
-    private buildFileFormData;
-    private upsertDocumentViaApi;
-    /**
-     * Get document associated with the current card
-     */
-    getDocumentAttachedToCard(card_iuid: string, document_name?: string): Promise<any>;
-    /**
-     * Save document attached to current card
-     */
-    postDocumentAttachedToCard(card_iuid: string, document: any): Promise<any>;
-    getCardDocument(card_iuid: string, doc_name: string): Promise<Response>;
-    private formatErrorMessage;
-    private sendEventError;
-    setFileDirty(data: {
-        iuid: string;
-        ts_m: number;
-    }): void;
-    getUsername(userObj: any): string;
-}
-export {};

package/dist/index.d.ts

@@ -1,5 +1,7 @@
-export { ViewerSdk, CardSdk } from "./dome-sdk";
+export { DomeEmbeddedAppSdk, ViewerMessageType, CardMessageType, ClientMessageType, } from "./dome-sdk";
+export type { HostInfo, HostCapabilities, HostDetails } from "./dome-sdk";
+export { ViewerSdk } from "./viewer-sdk";
+export type { ViewerEventHandler, Document, UiProps } from "./viewer-sdk";
+export { CardSdk, CardPermission, cardPermission, getKeyFromBlob } from "./card-sdk";
+export type { CardEventHandler, CardFsCallback, CardFsReadResult, CardFsReadHandler, CardKeyBlob, CardKeyBlobV1, } from "./card-sdk";
 export { CryptoA01 } from "./crypto";
-export type { ViewerMessageType, ViewerEventHandler, Document, UiProps } from "./dome-sdk";
-export type { CardMessageType, CardEventHandler } from "./dome-sdk";
-export { CardPermission, cardPermission } from "./dome-sdk";