@abraca/dabra 1.3.4 → 1.5.0

package/dist/index.d.ts

@@ -528,6 +528,23 @@ declare class AbracadabraClient {
     refCountsRepaired: number;
     blobsSwept: number;
   }>;
+  /** List snapshot metadata for a document. */
+  listSnapshots(docId: string, opts?: {
+    limit?: number;
+    offset?: number;
+  }): Promise<SnapshotMeta[]>;
+  /** Fetch a single snapshot including its base64-encoded data blob. */
+  getSnapshot(docId: string, version: number): Promise<SnapshotData>;
+  /** Create a manual snapshot of the current document state. */
+  createSnapshot(docId: string, opts?: {
+    label?: string;
+  }): Promise<SnapshotCreateResult>;
+  /** Delete a specific snapshot version. Requires manage permission. */
+  deleteSnapshot(docId: string, version: number): Promise<void>;
+  /** Restore a snapshot by merging it forward into the current document state. */
+  restoreSnapshot(docId: string, version: number): Promise<SnapshotRestoreResult>;
+  /** Fork a snapshot into a new document. */
+  forkSnapshot(docId: string, version: number): Promise<SnapshotForkResult>;
   /** Health check — no auth required. */
   health(): Promise<HealthStatus>;
   /**
@@ -1202,6 +1219,33 @@ interface EffectivePermissionsResponse {
   permissions: EffectivePermissionEntry[];
   default_role: string;
 }
+interface SnapshotMeta {
+  version: number;
+  size_bytes: number;
+  trigger: string;
+  label?: string | null;
+  created_by?: string | null;
+  created_at: number;
+}
+interface SnapshotData extends SnapshotMeta {
+  data: string;
+}
+interface SnapshotCreateResult {
+  version: number;
+  size_bytes: number;
+  label?: string | null;
+}
+interface SnapshotRestoreResult {
+  restored_from: number;
+  diff_bytes: number;
+}
+interface SnapshotForkResult {
+  doc_id: string;
+  forked_from: {
+    doc_id: string;
+    version: number;
+  };
+}
 interface HealthStatus {
   status: string;
   version: string;
@@ -2816,4 +2860,4 @@ declare function wrapSeed(seed: Uint8Array, wrappingKeyBytes: Uint8Array): Promi
  */
 declare function unwrapSeed(ciphertext: ArrayBuffer, iv: Uint8Array, wrappingKeyBytes: Uint8Array): Promise<Uint8Array>;
 //#endregion
-export { AbracadabraBaseProvider, AbracadabraBaseProviderConfiguration, AbracadabraClient, AbracadabraClientConfig, AbracadabraOutgoingMessageArguments, AbracadabraProvider, AbracadabraProviderConfiguration, AbracadabraWS, AbracadabraWSConfiguration, AbracadabraWebRTC, type AbracadabraWebRTCConfiguration, AbracadabraWebSocketConn, AuthMessageType, AuthorizedScope, AwarenessError, BackgroundSyncManager, type BackgroundSyncManagerOptions, BackgroundSyncPersistence, BroadcastChannelSync, CHANNEL_NAMES, CloseEvent, CompleteAbracadabraBaseProviderConfiguration, CompleteAbracadabraWSConfiguration, CompleteHocuspocusProviderConfiguration, CompleteHocuspocusProviderWebsocketConfiguration, ConnectionTimeout, Constructable, ConstructableOutgoingMessage, CryptoIdentity, CryptoIdentityKeystore, DEFAULT_FILE_CHUNK_SIZE, DEFAULT_ICE_SERVERS, DataChannelRouter, DevicePairingChannel, type DevicePairingConfig, DeviceRegistrationService, type DeviceServerStatus, type DeviceTier, type DocEncryptionInfo, DocKeyManager, type DocSyncState, DocumentCache, type DocumentCacheOptions, DocumentMeta, E2EAbracadabraProvider, E2EEChannel, type E2EEIdentity, E2EOfflineStore, EffectivePermissionEntry, EffectivePermissionsResponse, EffectiveRole, EncryptedYMap, EncryptedYText, FileBlobStore, FileTransferChannel, FileTransferHandle, type FileTransferMeta, type FileTransferStatus, Forbidden, HealthStatus, HocusPocusWebSocket, HocuspocusProvider, HocuspocusProviderConfiguration, HocuspocusProviderWebsocket, HocuspocusProviderWebsocketConfiguration, HocuspocusWebSocket, type IdentityDeviceEntry, type IdentityDocConfiguration, IdentityDocProvider, type IdentityProfile, type IdentityServerEntry, type IdentitySpaceEntry, InviteRow, KEY_EXCHANGE_CHANNEL, ManualSignaling, type ManualSignalingBlob, MessageTooBig, MessageType, OfflineStore, OutgoingMessageArguments, OutgoingMessageInterface, type PairingRequest, type PairingResult, PeerConnection, type PeerInfo, type PeerState, PendingSubdoc, PermissionEntry, PublicKeyInfo, ResetConnection, SearchIndex, SearchResult, ServerInfo, type SignalingIncoming, type SignalingOutgoing, SignalingSocket, SpaceMeta, StatesArray, SubdocMessage, SubdocRegisteredEvent, Unauthorized, UploadInfo, UploadMeta, UploadQueueEntry, UploadQueueStatus, UserProfile, WebSocketStatus, WsReadyStates, YjsDataChannel, attachUpdatedAtObserver, awarenessStatesToArray, wordlist as bip39Wordlist, decryptField, deriveIdentityDocId, deriveSeedWrappingKey, encryptField, generateMnemonic, makeEncryptedYMap, makeEncryptedYText, mnemonicToEd25519Seed, mnemonicToKeyPair, onAuthenticatedParameters, onAuthenticationFailedParameters, onAwarenessChangeParameters, onAwarenessUpdateParameters, onCloseParameters, onDisconnectParameters, onMessageParameters, onOpenParameters, onOutgoingMessageParameters, onStatelessParameters, onStatusParameters, onSubdocLoadedParameters, onSubdocRegisteredParameters, onSyncedParameters, onUnsyncedChangesParameters, readAuthMessage, unwrapSeed, validateMnemonic, wrapSeed, writeAuthenticated, writeAuthentication, writePermissionDenied, writeTokenSyncRequest };
+export { AbracadabraBaseProvider, AbracadabraBaseProviderConfiguration, AbracadabraClient, AbracadabraClientConfig, AbracadabraOutgoingMessageArguments, AbracadabraProvider, AbracadabraProviderConfiguration, AbracadabraWS, AbracadabraWSConfiguration, AbracadabraWebRTC, type AbracadabraWebRTCConfiguration, AbracadabraWebSocketConn, AuthMessageType, AuthorizedScope, AwarenessError, BackgroundSyncManager, type BackgroundSyncManagerOptions, BackgroundSyncPersistence, BroadcastChannelSync, CHANNEL_NAMES, CloseEvent, CompleteAbracadabraBaseProviderConfiguration, CompleteAbracadabraWSConfiguration, CompleteHocuspocusProviderConfiguration, CompleteHocuspocusProviderWebsocketConfiguration, ConnectionTimeout, Constructable, ConstructableOutgoingMessage, CryptoIdentity, CryptoIdentityKeystore, DEFAULT_FILE_CHUNK_SIZE, DEFAULT_ICE_SERVERS, DataChannelRouter, DevicePairingChannel, type DevicePairingConfig, DeviceRegistrationService, type DeviceServerStatus, type DeviceTier, type DocEncryptionInfo, DocKeyManager, type DocSyncState, DocumentCache, type DocumentCacheOptions, DocumentMeta, E2EAbracadabraProvider, E2EEChannel, type E2EEIdentity, E2EOfflineStore, EffectivePermissionEntry, EffectivePermissionsResponse, EffectiveRole, EncryptedYMap, EncryptedYText, FileBlobStore, FileTransferChannel, FileTransferHandle, type FileTransferMeta, type FileTransferStatus, Forbidden, HealthStatus, HocusPocusWebSocket, HocuspocusProvider, HocuspocusProviderConfiguration, HocuspocusProviderWebsocket, HocuspocusProviderWebsocketConfiguration, HocuspocusWebSocket, type IdentityDeviceEntry, type IdentityDocConfiguration, IdentityDocProvider, type IdentityProfile, type IdentityServerEntry, type IdentitySpaceEntry, InviteRow, KEY_EXCHANGE_CHANNEL, ManualSignaling, type ManualSignalingBlob, MessageTooBig, MessageType, OfflineStore, OutgoingMessageArguments, OutgoingMessageInterface, type PairingRequest, type PairingResult, PeerConnection, type PeerInfo, type PeerState, PendingSubdoc, PermissionEntry, PublicKeyInfo, ResetConnection, SearchIndex, SearchResult, ServerInfo, type SignalingIncoming, type SignalingOutgoing, SignalingSocket, SnapshotCreateResult, SnapshotData, SnapshotForkResult, SnapshotMeta, SnapshotRestoreResult, SpaceMeta, StatesArray, SubdocMessage, SubdocRegisteredEvent, Unauthorized, UploadInfo, UploadMeta, UploadQueueEntry, UploadQueueStatus, UserProfile, WebSocketStatus, WsReadyStates, YjsDataChannel, attachUpdatedAtObserver, awarenessStatesToArray, wordlist as bip39Wordlist, decryptField, deriveIdentityDocId, deriveSeedWrappingKey, encryptField, generateMnemonic, makeEncryptedYMap, makeEncryptedYText, mnemonicToEd25519Seed, mnemonicToKeyPair, onAuthenticatedParameters, onAuthenticationFailedParameters, onAwarenessChangeParameters, onAwarenessUpdateParameters, onCloseParameters, onDisconnectParameters, onMessageParameters, onOpenParameters, onOutgoingMessageParameters, onStatelessParameters, onStatusParameters, onSubdocLoadedParameters, onSubdocRegisteredParameters, onSyncedParameters, onUnsyncedChangesParameters, readAuthMessage, unwrapSeed, validateMnemonic, wrapSeed, writeAuthenticated, writeAuthentication, writePermissionDenied, writeTokenSyncRequest };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abraca/dabra",
-  "version": "1.3.4",
+  "version": "1.5.0",
   "description": "abracadabra provider",
   "keywords": [
     "abracadabra",

package/src/AbracadabraClient.ts

@@ -10,6 +10,11 @@ import type {
 	ServerInfo,
 	InviteRow,
 	SpaceMeta,
+	SnapshotMeta,
+	SnapshotData,
+	SnapshotCreateResult,
+	SnapshotRestoreResult,
+	SnapshotForkResult,
 } from "./types.ts";
 import type { DocEncryptionInfo } from "./types.ts";
 import type { DocumentCache } from "./DocumentCache.ts";
@@ -699,6 +704,56 @@ export class AbracadabraClient {
 		return this.request("POST", "/admin/storage/repair");
 	}
 
+	// ── Snapshots ────────────────────────────────────────────────────────────
+
+	/** List snapshot metadata for a document. */
+	async listSnapshots(docId: string, opts?: { limit?: number; offset?: number }): Promise<SnapshotMeta[]> {
+		const params = new URLSearchParams();
+		if (opts?.limit != null) params.set("limit", String(opts.limit));
+		if (opts?.offset != null) params.set("offset", String(opts.offset));
+		const qs = params.toString();
+		const res = await this.request<{ snapshots: SnapshotMeta[] }>(
+			"GET", `/docs/${encodeURIComponent(docId)}/snapshots${qs ? `?${qs}` : ""}`,
+		);
+		return res.snapshots;
+	}
+
+	/** Fetch a single snapshot including its base64-encoded data blob. */
+	async getSnapshot(docId: string, version: number): Promise<SnapshotData> {
+		return this.request<SnapshotData>(
+			"GET", `/docs/${encodeURIComponent(docId)}/snapshots/${version}`,
+		);
+	}
+
+	/** Create a manual snapshot of the current document state. */
+	async createSnapshot(docId: string, opts?: { label?: string }): Promise<SnapshotCreateResult> {
+		return this.request<SnapshotCreateResult>(
+			"POST", `/docs/${encodeURIComponent(docId)}/snapshots`,
+			{ body: opts ?? {} },
+		);
+	}
+
+	/** Delete a specific snapshot version. Requires manage permission. */
+	async deleteSnapshot(docId: string, version: number): Promise<void> {
+		await this.request("DELETE", `/docs/${encodeURIComponent(docId)}/snapshots/${version}`);
+	}
+
+	/** Restore a snapshot by merging it forward into the current document state. */
+	async restoreSnapshot(docId: string, version: number): Promise<SnapshotRestoreResult> {
+		return this.request<SnapshotRestoreResult>(
+			"POST", `/docs/${encodeURIComponent(docId)}/snapshots/${version}/restore`,
+			{ body: {} },
+		);
+	}
+
+	/** Fork a snapshot into a new document. */
+	async forkSnapshot(docId: string, version: number): Promise<SnapshotForkResult> {
+		return this.request<SnapshotForkResult>(
+			"POST", `/docs/${encodeURIComponent(docId)}/snapshots/${version}/fork`,
+			{ body: {} },
+		);
+	}
+
 	// ── System ───────────────────────────────────────────────────────────────
 
 	/** Health check — no auth required. */

package/src/types.ts

@@ -226,6 +226,37 @@ export interface EffectivePermissionsResponse {
   default_role: string;
 }
 
+// ── Snapshots ────────────────────────────────────────────────────────────────
+
+export interface SnapshotMeta {
+  version: number;
+  size_bytes: number;
+  trigger: string;
+  label?: string | null;
+  created_by?: string | null;
+  created_at: number;
+}
+
+export interface SnapshotData extends SnapshotMeta {
+  data: string;
+}
+
+export interface SnapshotCreateResult {
+  version: number;
+  size_bytes: number;
+  label?: string | null;
+}
+
+export interface SnapshotRestoreResult {
+  restored_from: number;
+  diff_bytes: number;
+}
+
+export interface SnapshotForkResult {
+  doc_id: string;
+  forked_from: { doc_id: string; version: number };
+}
+
 export interface HealthStatus {
   status: string;
   version: string;