loro-repo 0.4.0 → 0.5.0

package/dist/index.d.cts

@@ -1,10 +1,60 @@
 import { Flock } from "@loro-dev/flock";
 import { Frontiers, LoroDoc } from "loro-crdt";
-import { JoinError, JoinResponseOk, RoomId, UpdateError } from "loro-protocol";
+import { RoomId } from "loro-protocol";
+import { LoroAdaptorConfig } from "loro-adaptors/loro";
 import { LoroWebsocketClientOptions } from "loro-websocket";
-import { FlockAdaptorConfig } from "loro-adaptors/flock";
 
 //#region src/types.d.ts
+/**
+ * Construction options for creating a `LoroRepo` instance.
+ */
+interface LoroRepoOptions {
+  /**
+   * Transport adapter responsible for fetching and pushing CRDT bundles.
+   * Omit when operating fully offline or within pure tests.
+   */
+  readonly transportAdapter?: TransportAdapter;
+  /**
+   * Storage adapter that hydrates snapshots and persists incremental updates.
+   */
+  readonly storageAdapter?: StorageAdapter;
+  /**
+   * Optional adapter that moves asset payloads while keeping metadata in sync.
+   */
+  readonly assetTransportAdapter?: AssetTransportAdapter;
+  /**
+   * Debounce duration in milliseconds before persisting document frontier metadata
+   * after local edits. Defaults to 1000 ms when omitted.
+   */
+  readonly docFrontierDebounceMs?: number;
+}
+/**
+ * Persists metadata, documents, and asset payloads on behalf of the repo.
+ */
+interface StorageAdapter {
+  init?(): Promise<void>;
+  close?(): void;
+  /**
+   * Writes document snapshots, queued updates, assets, or meta bundles to durable storage.
+   */
+  save(payload: StorageSavePayload): Promise<void>;
+  /**
+   * Optionally deletes an asset payload during garbage collection.
+   */
+  deleteAsset?(assetId: AssetId): Promise<void>;
+  /**
+   * Loads a stored document by hydrating the persisted snapshot and replaying any queued updates.
+   */
+  loadDoc(docId: string): Promise<LoroDoc | undefined>;
+  /**
+   * Loads the repository-level metadata replica, if present.
+   */
+  loadMeta(): Promise<Flock | undefined>;
+  /**
+   * Loads a cached asset payload, if present.
+   */
+  loadAsset(assetId: AssetId): Promise<Uint8Array | undefined>;
+}
 type GlobalBlob = typeof globalThis extends {
   Blob: infer B;
 } ? B : {
@@ -39,29 +89,6 @@ type JsonObject = {
  * Synchronisation lanes available to repo consumers.
  */
 type SyncScope = "meta" | "doc" | "full";
-/**
- * Construction options for creating a `LoroRepo` instance.
- */
-interface LoroRepoOptions<_Meta extends JsonObject = JsonObject> {
-  /**
-   * Transport adapter responsible for fetching and pushing CRDT bundles.
-   * Omit when operating fully offline or within pure tests.
-   */
-  readonly transportAdapter?: TransportAdapter;
-  /**
-   * Storage adapter that hydrates snapshots and persists incremental updates.
-   */
-  readonly storageAdapter?: StorageAdapter;
-  /**
-   * Optional adapter that moves asset payloads while keeping metadata in sync.
-   */
-  readonly assetTransportAdapter?: AssetTransportAdapter;
-  /**
-   * Debounce duration in milliseconds before persisting document frontier metadata
-   * after local edits. Defaults to 1000 ms when omitted.
-   */
-  readonly docFrontierDebounceMs?: number;
-}
 /**
  * Parameters accepted by `LoroRepo.sync`.
  */
@@ -147,45 +174,6 @@ interface TransportAdapter {
    * Subscribes to live document updates, returning a cleanup handle.
    */
   joinDocRoom(docId: string, loroDoc: LoroDoc, params?: TransportJoinParams): TransportSubscription;
-  /**
-   * Optional callback invoked upon successful join responses.
-   */
-  handleJoinResponse?(response: JoinResponseOk): void;
-  /**
-   * Optional callback surfaced when joining a room fails.
-   */
-  handleJoinError?(error: JoinError): void;
-  /**
-   * Optional callback for update-level failures (e.g., decoding errors).
-   */
-  handleUpdateError?(error: UpdateError): void;
-}
-/**
- * Persists metadata, documents, and asset payloads on behalf of the repo.
- */
-interface StorageAdapter {
-  init?(): Promise<void>;
-  close?(): void;
-  /**
-   * Writes document snapshots, queued updates, assets, or meta bundles to durable storage.
-   */
-  save(payload: StorageSavePayload): Promise<void>;
-  /**
-   * Optionally deletes an asset payload during garbage collection.
-   */
-  deleteAsset?(assetId: AssetId): Promise<void>;
-  /**
-   * Loads a stored document by hydrating the persisted snapshot and replaying any queued updates.
-   */
-  loadDoc(docId: string): Promise<LoroDoc | undefined>;
-  /**
-   * Loads the repository-level metadata replica, if present.
-   */
-  loadMeta(): Promise<Flock | undefined>;
-  /**
-   * Loads a cached asset payload, if present.
-   */
-  loadAsset(assetId: AssetId): Promise<Uint8Array | undefined>;
 }
 /**
  * Union describing the kinds of payloads persisted via the storage adapter.
@@ -428,74 +416,6 @@ interface RepoEventFilter<Meta extends JsonObject = JsonObject> {
   readonly by?: ReadonlyArray<RepoEventBy>;
 }
 //#endregion
-//#region src/loro-adaptor.d.ts
-type RepoFlockAdaptorConfig = FlockAdaptorConfig;
-//#endregion
-//#region src/transport/websocket.d.ts
-interface WebSocketTransportOptions {
-  /**
-   * WebSocket endpoint provided to the loro-websocket client.
-   */
-  readonly url: string;
-  /**
-   * Optional loro-websocket client configuration.
-   */
-  readonly client?: Omit<LoroWebsocketClientOptions, "url">;
-  /**
-   * Metadata room identifier. When omitted, metadata synchronisation is disabled.
-   */
-  readonly metadataRoomId?: string;
-  /**
-   * Overrides the CRDT type advertised for the metadata room (defaults to `%FLO`).
-   * Only `%FLO` is supported.
-   */
-  readonly metadataCrdtType?: string;
-  /**
-   * Optional adaptor configuration for metadata joins.
-   */
-  readonly metadataAdaptorConfig?: RepoFlockAdaptorConfig;
-  /**
-   * Static auth payload for metadata joins.
-   */
-  readonly metadataAuth?: Uint8Array;
-  /**
-   * Factory that maps document ids to room identifiers. Defaults to the doc id.
-   */
-  readonly docRoomId?: (docId: string) => string;
-  /**
-   * Optional auth provider for document joins.
-   */
-  readonly docAuth?: (docId: string) => Uint8Array | undefined;
-}
-/**
- * loro-websocket backed {@link TransportAdapter} implementation for LoroRepo.
- */
-declare class WebSocketTransportAdapter implements TransportAdapter {
-  private readonly options;
-  private client?;
-  private metadataSession?;
-  private readonly docSessions;
-  constructor(options: WebSocketTransportOptions);
-  connect(_options?: {
-    timeout?: number;
-  }): Promise<void>;
-  close(): Promise<void>;
-  isConnected(): boolean;
-  syncMeta(flock: Flock, options?: {
-    timeout?: number;
-  }): Promise<TransportSyncResult>;
-  joinMetaRoom(flock: Flock, params?: TransportJoinParams): TransportSubscription;
-  syncDoc(docId: string, doc: LoroDoc, options?: {
-    timeout?: number;
-  }): Promise<TransportSyncResult>;
-  joinDocRoom(docId: string, doc: LoroDoc, params?: TransportJoinParams): TransportSubscription;
-  private ensureClient;
-  private ensureMetadataSession;
-  private teardownMetadataSession;
-  private ensureDocSession;
-  private leaveDocSession;
-}
-//#endregion
 //#region src/transport/broadcast-channel.d.ts
 interface BroadcastChannelTransportOptions {
   /**
@@ -626,9 +546,70 @@ declare class FileSystemStorageAdaptor implements StorageAdapter {
   private assetPath;
 }
 //#endregion
+//#region src/transport/websocket.d.ts
+interface WebSocketTransportOptions {
+  /**
+   * WebSocket endpoint provided to the loro-websocket client.
+   */
+  readonly url: string;
+  /**
+   * Metadata room identifier. Defaults to "repo:meta".
+   */
+  readonly metadataRoomId?: string;
+  /**
+   * Optional loro-websocket client configuration.
+   */
+  readonly client?: Omit<LoroWebsocketClientOptions, "url">;
+  /**
+   * Optional adaptor configuration for metadata joins.
+   */
+  readonly metadataAdaptorConfig?: LoroAdaptorConfig;
+  /**
+   * Static auth payload for metadata joins.
+   */
+  readonly metadataAuth?: Uint8Array | (() => Promise<Uint8Array>);
+  /**
+   * Factory that maps document ids to room identifiers. Defaults to the doc id.
+   */
+  readonly docRoomId?: (docId: string) => string;
+  /**
+   * Optional auth provider for document joins.
+   */
+  readonly docAuth?: (docId: string) => Promise<Uint8Array>;
+}
+/**
+ * loro-websocket backed {@link TransportAdapter} implementation for LoroRepo.
+ * It uses loro-protocol as the underlying protocol for the transport.
+ */
+declare class WebSocketTransportAdapter implements TransportAdapter {
+  private readonly options;
+  private client?;
+  private metadataSession?;
+  private readonly docSessions;
+  constructor(options: WebSocketTransportOptions);
+  connect(_options?: {
+    timeout?: number;
+  }): Promise<void>;
+  close(): Promise<void>;
+  isConnected(): boolean;
+  syncMeta(flock: Flock, options?: {
+    timeout?: number;
+  }): Promise<TransportSyncResult>;
+  joinMetaRoom(flock: Flock, params?: TransportJoinParams): TransportSubscription;
+  syncDoc(docId: string, doc: LoroDoc, options?: {
+    timeout?: number;
+  }): Promise<TransportSyncResult>;
+  joinDocRoom(docId: string, doc: LoroDoc, params?: TransportJoinParams): TransportSubscription;
+  private ensureClient;
+  private ensureMetadataSession;
+  private teardownMetadataSession;
+  private ensureDocSession;
+  private leaveDocSession;
+}
+//#endregion
 //#region src/index.d.ts
 declare class LoroRepo<Meta extends JsonObject = JsonObject> {
-  readonly options: LoroRepoOptions<Meta>;
+  readonly options: LoroRepoOptions;
   private _destroyed;
   private readonly transport?;
   private readonly storage?;
@@ -642,7 +623,7 @@ declare class LoroRepo<Meta extends JsonObject = JsonObject> {
   private readonly state;
   private readonly syncRunner;
   private constructor();
-  static create<Meta extends JsonObject = JsonObject>(options: LoroRepoOptions<Meta>): Promise<LoroRepo<Meta>>;
+  static create<Meta extends JsonObject = JsonObject>(options: LoroRepoOptions): Promise<LoroRepo<Meta>>;
   /**
    * Load meta from storage.
    *

package/dist/index.d.ts

@@ -1,11 +1,60 @@
 import { Flock } from "@loro-dev/flock";
-import { LoroAdaptor } from "loro-adaptors/loro";
-import { JoinError, JoinResponseOk, RoomId, UpdateError } from "loro-protocol";
-import { LoroWebsocketClientOptions } from "loro-websocket";
 import { Frontiers, LoroDoc } from "loro-crdt";
-import { FlockAdaptor, FlockAdaptorConfig } from "loro-adaptors/flock";
+import { LoroAdaptorConfig } from "loro-adaptors/loro";
+import { RoomId } from "loro-protocol";
+import { LoroWebsocketClientOptions } from "loro-websocket";
 
 //#region src/types.d.ts
+/**
+ * Construction options for creating a `LoroRepo` instance.
+ */
+interface LoroRepoOptions {
+  /**
+   * Transport adapter responsible for fetching and pushing CRDT bundles.
+   * Omit when operating fully offline or within pure tests.
+   */
+  readonly transportAdapter?: TransportAdapter;
+  /**
+   * Storage adapter that hydrates snapshots and persists incremental updates.
+   */
+  readonly storageAdapter?: StorageAdapter;
+  /**
+   * Optional adapter that moves asset payloads while keeping metadata in sync.
+   */
+  readonly assetTransportAdapter?: AssetTransportAdapter;
+  /**
+   * Debounce duration in milliseconds before persisting document frontier metadata
+   * after local edits. Defaults to 1000 ms when omitted.
+   */
+  readonly docFrontierDebounceMs?: number;
+}
+/**
+ * Persists metadata, documents, and asset payloads on behalf of the repo.
+ */
+interface StorageAdapter {
+  init?(): Promise<void>;
+  close?(): void;
+  /**
+   * Writes document snapshots, queued updates, assets, or meta bundles to durable storage.
+   */
+  save(payload: StorageSavePayload): Promise<void>;
+  /**
+   * Optionally deletes an asset payload during garbage collection.
+   */
+  deleteAsset?(assetId: AssetId): Promise<void>;
+  /**
+   * Loads a stored document by hydrating the persisted snapshot and replaying any queued updates.
+   */
+  loadDoc(docId: string): Promise<LoroDoc | undefined>;
+  /**
+   * Loads the repository-level metadata replica, if present.
+   */
+  loadMeta(): Promise<Flock | undefined>;
+  /**
+   * Loads a cached asset payload, if present.
+   */
+  loadAsset(assetId: AssetId): Promise<Uint8Array | undefined>;
+}
 type GlobalBlob = typeof globalThis extends {
   Blob: infer B;
 } ? B : {
@@ -40,29 +89,6 @@ type JsonObject = {
  * Synchronisation lanes available to repo consumers.
  */
 type SyncScope = "meta" | "doc" | "full";
-/**
- * Construction options for creating a `LoroRepo` instance.
- */
-interface LoroRepoOptions<_Meta extends JsonObject = JsonObject> {
-  /**
-   * Transport adapter responsible for fetching and pushing CRDT bundles.
-   * Omit when operating fully offline or within pure tests.
-   */
-  readonly transportAdapter?: TransportAdapter;
-  /**
-   * Storage adapter that hydrates snapshots and persists incremental updates.
-   */
-  readonly storageAdapter?: StorageAdapter;
-  /**
-   * Optional adapter that moves asset payloads while keeping metadata in sync.
-   */
-  readonly assetTransportAdapter?: AssetTransportAdapter;
-  /**
-   * Debounce duration in milliseconds before persisting document frontier metadata
-   * after local edits. Defaults to 1000 ms when omitted.
-   */
-  readonly docFrontierDebounceMs?: number;
-}
 /**
  * Parameters accepted by `LoroRepo.sync`.
  */
@@ -148,45 +174,6 @@ interface TransportAdapter {
    * Subscribes to live document updates, returning a cleanup handle.
    */
   joinDocRoom(docId: string, loroDoc: LoroDoc, params?: TransportJoinParams): TransportSubscription;
-  /**
-   * Optional callback invoked upon successful join responses.
-   */
-  handleJoinResponse?(response: JoinResponseOk): void;
-  /**
-   * Optional callback surfaced when joining a room fails.
-   */
-  handleJoinError?(error: JoinError): void;
-  /**
-   * Optional callback for update-level failures (e.g., decoding errors).
-   */
-  handleUpdateError?(error: UpdateError): void;
-}
-/**
- * Persists metadata, documents, and asset payloads on behalf of the repo.
- */
-interface StorageAdapter {
-  init?(): Promise<void>;
-  close?(): void;
-  /**
-   * Writes document snapshots, queued updates, assets, or meta bundles to durable storage.
-   */
-  save(payload: StorageSavePayload): Promise<void>;
-  /**
-   * Optionally deletes an asset payload during garbage collection.
-   */
-  deleteAsset?(assetId: AssetId): Promise<void>;
-  /**
-   * Loads a stored document by hydrating the persisted snapshot and replaying any queued updates.
-   */
-  loadDoc(docId: string): Promise<LoroDoc | undefined>;
-  /**
-   * Loads the repository-level metadata replica, if present.
-   */
-  loadMeta(): Promise<Flock | undefined>;
-  /**
-   * Loads a cached asset payload, if present.
-   */
-  loadAsset(assetId: AssetId): Promise<Uint8Array | undefined>;
 }
 /**
  * Union describing the kinds of payloads persisted via the storage adapter.
@@ -429,74 +416,6 @@ interface RepoEventFilter<Meta extends JsonObject = JsonObject> {
   readonly by?: ReadonlyArray<RepoEventBy>;
 }
 //#endregion
-//#region src/loro-adaptor.d.ts
-type RepoFlockAdaptorConfig = FlockAdaptorConfig;
-//#endregion
-//#region src/transport/websocket.d.ts
-interface WebSocketTransportOptions {
-  /**
-   * WebSocket endpoint provided to the loro-websocket client.
-   */
-  readonly url: string;
-  /**
-   * Optional loro-websocket client configuration.
-   */
-  readonly client?: Omit<LoroWebsocketClientOptions, "url">;
-  /**
-   * Metadata room identifier. When omitted, metadata synchronisation is disabled.
-   */
-  readonly metadataRoomId?: string;
-  /**
-   * Overrides the CRDT type advertised for the metadata room (defaults to `%FLO`).
-   * Only `%FLO` is supported.
-   */
-  readonly metadataCrdtType?: string;
-  /**
-   * Optional adaptor configuration for metadata joins.
-   */
-  readonly metadataAdaptorConfig?: RepoFlockAdaptorConfig;
-  /**
-   * Static auth payload for metadata joins.
-   */
-  readonly metadataAuth?: Uint8Array;
-  /**
-   * Factory that maps document ids to room identifiers. Defaults to the doc id.
-   */
-  readonly docRoomId?: (docId: string) => string;
-  /**
-   * Optional auth provider for document joins.
-   */
-  readonly docAuth?: (docId: string) => Uint8Array | undefined;
-}
-/**
- * loro-websocket backed {@link TransportAdapter} implementation for LoroRepo.
- */
-declare class WebSocketTransportAdapter implements TransportAdapter {
-  private readonly options;
-  private client?;
-  private metadataSession?;
-  private readonly docSessions;
-  constructor(options: WebSocketTransportOptions);
-  connect(_options?: {
-    timeout?: number;
-  }): Promise<void>;
-  close(): Promise<void>;
-  isConnected(): boolean;
-  syncMeta(flock: Flock, options?: {
-    timeout?: number;
-  }): Promise<TransportSyncResult>;
-  joinMetaRoom(flock: Flock, params?: TransportJoinParams): TransportSubscription;
-  syncDoc(docId: string, doc: LoroDoc, options?: {
-    timeout?: number;
-  }): Promise<TransportSyncResult>;
-  joinDocRoom(docId: string, doc: LoroDoc, params?: TransportJoinParams): TransportSubscription;
-  private ensureClient;
-  private ensureMetadataSession;
-  private teardownMetadataSession;
-  private ensureDocSession;
-  private leaveDocSession;
-}
-//#endregion
 //#region src/transport/broadcast-channel.d.ts
 interface BroadcastChannelTransportOptions {
   /**
@@ -627,9 +546,70 @@ declare class FileSystemStorageAdaptor implements StorageAdapter {
   private assetPath;
 }
 //#endregion
+//#region src/transport/websocket.d.ts
+interface WebSocketTransportOptions {
+  /**
+   * WebSocket endpoint provided to the loro-websocket client.
+   */
+  readonly url: string;
+  /**
+   * Metadata room identifier. Defaults to "repo:meta".
+   */
+  readonly metadataRoomId?: string;
+  /**
+   * Optional loro-websocket client configuration.
+   */
+  readonly client?: Omit<LoroWebsocketClientOptions, "url">;
+  /**
+   * Optional adaptor configuration for metadata joins.
+   */
+  readonly metadataAdaptorConfig?: LoroAdaptorConfig;
+  /**
+   * Static auth payload for metadata joins.
+   */
+  readonly metadataAuth?: Uint8Array | (() => Promise<Uint8Array>);
+  /**
+   * Factory that maps document ids to room identifiers. Defaults to the doc id.
+   */
+  readonly docRoomId?: (docId: string) => string;
+  /**
+   * Optional auth provider for document joins.
+   */
+  readonly docAuth?: (docId: string) => Promise<Uint8Array>;
+}
+/**
+ * loro-websocket backed {@link TransportAdapter} implementation for LoroRepo.
+ * It uses loro-protocol as the underlying protocol for the transport.
+ */
+declare class WebSocketTransportAdapter implements TransportAdapter {
+  private readonly options;
+  private client?;
+  private metadataSession?;
+  private readonly docSessions;
+  constructor(options: WebSocketTransportOptions);
+  connect(_options?: {
+    timeout?: number;
+  }): Promise<void>;
+  close(): Promise<void>;
+  isConnected(): boolean;
+  syncMeta(flock: Flock, options?: {
+    timeout?: number;
+  }): Promise<TransportSyncResult>;
+  joinMetaRoom(flock: Flock, params?: TransportJoinParams): TransportSubscription;
+  syncDoc(docId: string, doc: LoroDoc, options?: {
+    timeout?: number;
+  }): Promise<TransportSyncResult>;
+  joinDocRoom(docId: string, doc: LoroDoc, params?: TransportJoinParams): TransportSubscription;
+  private ensureClient;
+  private ensureMetadataSession;
+  private teardownMetadataSession;
+  private ensureDocSession;
+  private leaveDocSession;
+}
+//#endregion
 //#region src/index.d.ts
 declare class LoroRepo<Meta extends JsonObject = JsonObject> {
-  readonly options: LoroRepoOptions<Meta>;
+  readonly options: LoroRepoOptions;
   private _destroyed;
   private readonly transport?;
   private readonly storage?;
@@ -643,7 +623,7 @@ declare class LoroRepo<Meta extends JsonObject = JsonObject> {
   private readonly state;
   private readonly syncRunner;
   private constructor();
-  static create<Meta extends JsonObject = JsonObject>(options: LoroRepoOptions<Meta>): Promise<LoroRepo<Meta>>;
+  static create<Meta extends JsonObject = JsonObject>(options: LoroRepoOptions): Promise<LoroRepo<Meta>>;
   /**
    * Load meta from storage.
    *