database-devtools 0.1.0

package/dist/handleDeviceSnapshot-cYGuitSc.d.cts

@@ -0,0 +1,116 @@
+import { DeviceStatusPayload, RegisterMessage, PongMessage, RefreshRequestMessage, ExportSnapshotRequestMessage, TransactionAckMessage, WriteAckMessage, BeginTransactionRequestMessage, CommitTransactionRequestMessage, RollbackTransactionRequestMessage, WriteRequestMessage, DevToolsRole, DeviceMetadata, SnapshotUploadRequestedMessage, ExportSnapshotErrorMessage, RefreshStatusMessage, SnapshotReadyMessage, RefreshErrorMessage, BeginTransactionMessage, CommitTransactionMessage, RollbackTransactionMessage, ExecuteWriteMessage, TransactionStatusMessage, WriteResultMessage, WriteErrorMessage } from './types/protocol.cjs';
+import { a as WriteOperation } from './write-C3toEIMs.cjs';
+import { D as DatabaseAdapter } from './adapter-BjJm71wW.cjs';
+
+type ConnectionState = 'connecting' | 'connected' | 'reconnecting' | 'disconnected';
+type TransactionState = 'idle' | 'opening' | 'open' | 'committing' | 'rolling_back';
+type DevToolsClientOptions = {
+    serverUrl?: string;
+    role?: DevToolsRole;
+    deviceId?: string;
+    metadata?: DeviceMetadata;
+    WebSocketImpl?: typeof WebSocket;
+    onConnect?: () => void;
+    onDisconnect?: () => void;
+    onConnectionStateChange?: (state: ConnectionState) => void;
+    onDeviceStatus?: (status: DeviceStatusPayload) => void;
+    onSnapshotUploadRequested?: (message: SnapshotUploadRequestedMessage) => void;
+    onExportSnapshotError?: (message: ExportSnapshotErrorMessage) => void;
+    onRefreshStatus?: (message: RefreshStatusMessage) => void;
+    onSnapshotReady?: (message: SnapshotReadyMessage) => void;
+    onRefreshError?: (message: RefreshErrorMessage) => void;
+    onBeginTransaction?: (message: BeginTransactionMessage) => void;
+    onCommitTransaction?: (message: CommitTransactionMessage) => void;
+    onRollbackTransaction?: (message: RollbackTransactionMessage) => void;
+    onExecuteWrite?: (message: ExecuteWriteMessage) => void;
+    onTransactionStatus?: (message: TransactionStatusMessage) => void;
+    onWriteResult?: (message: WriteResultMessage) => void;
+    onWriteError?: (message: WriteErrorMessage) => void;
+    onTransactionStateChange?: (state: TransactionState) => void;
+    onError?: (error: Error) => void;
+};
+type DevToolsClient = {
+    connect: () => void;
+    disconnect: () => void;
+    getConnectionState: () => ConnectionState;
+    getLastConnectionError: () => string | null;
+    getDeviceStatus: () => DeviceStatusPayload | null;
+    getDeviceId: () => string | undefined;
+    getServerUrl: () => string;
+    setServerUrl: (url: string) => void;
+    send: (message: ClientMessageInput) => void;
+    requestRefresh: (deviceId: string) => void;
+    requestExportSnapshot: () => void;
+    sendTransactionAck: (message: Omit<TransactionAckMessage, 'timestamp' | 'type'>) => void;
+    sendWriteAck: (message: Omit<WriteAckMessage, 'timestamp' | 'type'>) => void;
+    beginTransaction: (deviceId: string) => Promise<void>;
+    commitTransaction: () => Promise<void>;
+    rollbackTransaction: () => Promise<void>;
+    executeWrite: (operation: WriteOperation) => Promise<{
+        rowsAffected: number;
+    }>;
+    getTransactionState: () => TransactionState;
+    getActiveTransactionId: () => string | null;
+};
+type ClientMessageInput = Omit<RegisterMessage, 'timestamp'> | Omit<PongMessage, 'timestamp'> | Omit<RefreshRequestMessage, 'timestamp'> | Omit<ExportSnapshotRequestMessage, 'timestamp'> | Omit<TransactionAckMessage, 'timestamp'> | Omit<WriteAckMessage, 'timestamp'> | Omit<BeginTransactionRequestMessage, 'timestamp'> | Omit<CommitTransactionRequestMessage, 'timestamp'> | Omit<RollbackTransactionRequestMessage, 'timestamp'> | Omit<WriteRequestMessage, 'timestamp'>;
+declare function createDevToolsClient(options?: DevToolsClientOptions): DevToolsClient;
+
+type ResolveProjectDatabaseUrlOptions = {
+    useSameOriginApi?: boolean;
+};
+declare function resolveProjectDatabaseUrl(serverUrl: string, options?: ResolveProjectDatabaseUrlOptions): string;
+declare function resolveProjectDatabaseMetaUrl(serverUrl: string, options?: ResolveProjectDatabaseUrlOptions): string;
+declare function resolveProjectDatabasesUrl(serverUrl: string, options?: ResolveProjectDatabaseUrlOptions): string;
+
+type ProjectDatabaseMeta = {
+    exists: boolean;
+    relativePath?: string;
+    absolutePath?: string;
+    kind?: string;
+    mimeType?: string;
+    databaseName?: string;
+    size?: number;
+    updatedAt?: number;
+    source?: 'active' | 'device';
+    deviceId?: string;
+};
+type ListedProjectDatabase = {
+    id: string;
+    label: string;
+    relativePath: string;
+    source: 'active' | 'device';
+    deviceId?: string;
+    bundleId?: string;
+    storageKey?: string;
+    databaseName?: string;
+    size: number;
+    updatedAt: number;
+};
+/** @deprecated Use device-scoped `fetchDeviceExportMeta` instead. Proxies to the newest device export. */
+declare function fetchProjectDatabaseMeta(serverUrl: string, options?: ResolveProjectDatabaseUrlOptions): Promise<ProjectDatabaseMeta>;
+/** @deprecated Use device-scoped `fetchDeviceExportDatabase` instead. Proxies to the newest device export. */
+declare function fetchProjectDatabase(serverUrl: string, options?: ResolveProjectDatabaseUrlOptions): Promise<ArrayBuffer>;
+/** @deprecated Use `fetchDeviceExports` instead. */
+declare function fetchProjectDatabases(serverUrl: string, options?: ResolveProjectDatabaseUrlOptions): Promise<ListedProjectDatabase[]>;
+
+type DeviceExportMeta = ProjectDatabaseMeta;
+type ListedDeviceExport = ListedProjectDatabase;
+declare function fetchDeviceExportMeta(serverUrl: string, deviceId: string, options?: ResolveProjectDatabaseUrlOptions): Promise<DeviceExportMeta>;
+declare function fetchDeviceExportDatabase(serverUrl: string, deviceId: string, options?: ResolveProjectDatabaseUrlOptions): Promise<ArrayBuffer>;
+declare function fetchDeviceExports(serverUrl: string, options?: ResolveProjectDatabaseUrlOptions): Promise<ListedDeviceExport[]>;
+
+declare function resolveDeviceExportDatabaseUrl(serverUrl: string, deviceId: string, options?: ResolveProjectDatabaseUrlOptions): string;
+declare function resolveDeviceExportDatabaseMetaUrl(serverUrl: string, deviceId: string, options?: ResolveProjectDatabaseUrlOptions): string;
+declare function resolveDeviceExportsUrl(serverUrl: string, options?: ResolveProjectDatabaseUrlOptions): string;
+
+declare function fetchSnapshot(downloadUrl: string): Promise<ArrayBuffer>;
+
+type HandleDeviceSnapshotOptions = {
+    /** WebSocket URL of the connected hub — used to build the upload URL on mobile. */
+    hubServerUrl?: string;
+    /** This mobile client's device ID — upload is ignored when it does not match. */
+    deviceId?: string;
+};
+declare function handleDeviceSnapshotUpload(database: DatabaseAdapter | undefined, message: SnapshotUploadRequestedMessage, options?: HandleDeviceSnapshotOptions): Promise<void>;
+
+export { type ConnectionState as C, type DevToolsClient as D, type HandleDeviceSnapshotOptions as H, type ListedDeviceExport as L, type ProjectDatabaseMeta as P, type ResolveProjectDatabaseUrlOptions as R, type TransactionState as T, type DevToolsClientOptions as a, type DeviceExportMeta as b, type ListedProjectDatabase as c, createDevToolsClient as d, fetchDeviceExportMeta as e, fetchDeviceExportDatabase as f, fetchDeviceExports as g, fetchProjectDatabase as h, fetchProjectDatabaseMeta as i, fetchProjectDatabases as j, fetchSnapshot as k, handleDeviceSnapshotUpload as l, resolveDeviceExportDatabaseUrl as m, resolveDeviceExportsUrl as n, resolveProjectDatabaseMetaUrl as o, resolveProjectDatabaseUrl as p, resolveProjectDatabasesUrl as q, resolveDeviceExportDatabaseMetaUrl as r };