loro-repo 0.0.0 → 0.2.0

package/dist/index.d.cts

@@ -15,6 +15,14 @@ type GlobalBlob = typeof globalThis extends {
  * Binary content accepted by asset ingestion helpers.
  */
 type AssetContent = GlobalBlob | ArrayBufferView | ReadableStream<Uint8Array>;
+interface RepoAssetMetadata {
+  readonly assetId: AssetId;
+  readonly size: number;
+  readonly createdAt: number;
+  readonly mime?: string;
+  readonly policy?: string;
+  readonly tag?: string;
+}
 /**
  * JSON-compatible leaf value used for document metadata.
  */
@@ -565,52 +573,66 @@ declare class IndexedDBStorageAdaptor implements StorageAdapter {
   private createError;
 }
 //#endregion
-//#region src/index.d.ts
-interface RepoAssetMetadata {
-  readonly assetId: AssetId;
-  readonly size: number;
-  readonly createdAt: number;
-  readonly mime?: string;
-  readonly policy?: string;
-  readonly tag?: string;
+//#region src/storage/filesystem.d.ts
+interface FileSystemStorageAdaptorOptions {
+  /**
+   * Base directory where metadata, document snapshots, and assets will be stored.
+   * Defaults to `.loro-repo` inside the current working directory.
+   */
+  readonly baseDir?: string;
+  /**
+   * Subdirectory dedicated to document persistence. Defaults to `docs`.
+   */
+  readonly docsDirName?: string;
+  /**
+   * Subdirectory dedicated to asset blobs. Defaults to `assets`.
+   */
+  readonly assetsDirName?: string;
+  /**
+   * File name for the metadata snapshot bundle. Defaults to `meta.json`.
+   */
+  readonly metaFileName?: string;
 }
+declare class FileSystemStorageAdaptor implements StorageAdapter {
+  private readonly baseDir;
+  private readonly docsDir;
+  private readonly assetsDir;
+  private readonly metaPath;
+  private readonly initPromise;
+  private updateCounter;
+  constructor(options?: FileSystemStorageAdaptorOptions);
+  save(payload: StorageSavePayload): Promise<void>;
+  deleteAsset(assetId: AssetId): Promise<void>;
+  loadDoc(docId: string): Promise<LoroDoc | undefined>;
+  loadMeta(): Promise<Flock | undefined>;
+  loadAsset(assetId: AssetId): Promise<Uint8Array | undefined>;
+  private ensureLayout;
+  private writeDocSnapshot;
+  private enqueueDocUpdate;
+  private writeAsset;
+  private docDir;
+  private docSnapshotPath;
+  private docUpdatesDir;
+  private assetPath;
+}
+//#endregion
+//#region src/index.d.ts
 declare class LoroRepo<Meta extends JsonObject = JsonObject> {
   readonly options: LoroRepoOptions<Meta>;
   private readonly transport?;
   private readonly storage?;
-  private readonly assetTransport?;
   private readonly docFactory;
   private metaFlock;
-  private readonly metadata;
-  private readonly docs;
-  private readonly docRefs;
-  private readonly docSubscriptions;
-  private readonly docAssets;
-  private readonly assets;
-  private readonly orphanedAssets;
-  private readonly assetToDocRefs;
-  private readonly docFrontierKeys;
-  private readonly docFrontierUpdates;
-  private readonly docPersistedVersions;
-  private readonly docFrontierDebounceMs;
-  private readonly watchers;
-  private readonly eventByStack;
-  private metaRoomSubscription?;
-  private unsubscribeMetaFlock?;
-  private readyPromise?;
+  private readonly eventBus;
+  private readonly docManager;
+  private readonly metadataManager;
+  private readonly assetManager;
+  private readonly flockHydrator;
+  private readonly state;
+  private readonly syncRunner;
   constructor(options: LoroRepoOptions<Meta>);
   ready(): Promise<void>;
-  private initialize;
   sync(options?: RepoSyncOptions): Promise<void>;
-  private refreshDocMetadataEntry;
-  private refreshDocAssetsEntry;
-  private refreshAssetMetadataEntry;
-  private refreshDocFrontierKeys;
-  private readDocMetadataFromFlock;
-  private readDocAssetsFromFlock;
-  private readAssetMetadataFromFlock;
-  private handleAssetRemoval;
-  private emit;
   joinMetaRoom(params?: TransportJoinParams): Promise<TransportSubscription>;
   joinDocRoom(docId: string, params?: TransportJoinParams): Promise<TransportSubscription>;
   close(): Promise<void>;
@@ -636,35 +658,9 @@ declare class LoroRepo<Meta extends JsonObject = JsonObject> {
   unlinkAsset(docId: string, assetId: AssetId): Promise<void>;
   listAssets(docId: string): Promise<RepoAssetMetadata[]>;
   ensureAsset(assetId: AssetId): Promise<AssetDownload>;
-  private createAssetDownload;
-  private materializeAsset;
-  private updateDocAssetMetadata;
   gcAssets(options?: GarbageCollectionOptions): Promise<number>;
-  private onDocHandleClose;
-  private ensureDoc;
-  private materializeDetachedDoc;
-  private exportDocSnapshot;
   private persistMeta;
-  private persistDoc;
-  private persistDocUpdate;
-  private pushEventBy;
-  private popEventBy;
-  private resolveEventBy;
-  private ensureMetaLiveMonitor;
-  private applyMetaFlockEvents;
-  private registerDoc;
-  private ensureDocSubscription;
-  private rememberAsset;
-  private scheduleDocFrontierUpdate;
-  private mergeRepoEventBy;
-  private runScheduledDocFrontierUpdate;
-  private flushScheduledDocFrontierUpdate;
-  private onDocEvent;
-  private getAssetMetadata;
-  private updateDocFrontiers;
-  private hydrateMetadataFromFlock;
-  private shouldNotify;
 }
 //#endregion
-export { AssetContent, AssetDownload, AssetId, AssetTransportAdapter, AssetUploadMetadata, BroadcastChannelTransportAdapter, type BroadcastChannelTransportOptions, GarbageCollectionOptions, IndexedDBStorageAdaptor, type IndexedDBStorageAdaptorOptions, JsonObject, JsonValue, LinkAssetOptions, ListDocQuery, LoroRepo, LoroRepoOptions, RepoAssetMetadata, RepoDocHandle, RepoDocMeta, RepoEvent, RepoEventBy, RepoEventFilter, RepoEventListener, type RepoSyncOptions, RepoWatchHandle, StorageAdapter, StorageSavePayload, SyncScope, TransportAdapter, type TransportJoinParams, type TransportSubscription, TransportSyncRequest, type TransportSyncResult, UploadAssetOptions, UpsertDocMetaOptions, WebSocketTransportAdapter, WebSocketTransportOptions };
+export { AssetContent, AssetDownload, AssetId, AssetTransportAdapter, AssetUploadMetadata, BroadcastChannelTransportAdapter, type BroadcastChannelTransportOptions, FileSystemStorageAdaptor, type FileSystemStorageAdaptorOptions, GarbageCollectionOptions, IndexedDBStorageAdaptor, type IndexedDBStorageAdaptorOptions, JsonObject, JsonValue, LinkAssetOptions, ListDocQuery, LoroRepo, LoroRepoOptions, RepoAssetMetadata, RepoDocHandle, RepoDocMeta, RepoEvent, RepoEventBy, RepoEventFilter, RepoEventListener, type RepoSyncOptions, RepoWatchHandle, StorageAdapter, StorageSavePayload, SyncScope, TransportAdapter, type TransportJoinParams, type TransportSubscription, TransportSyncRequest, type TransportSyncResult, UploadAssetOptions, UpsertDocMetaOptions, WebSocketTransportAdapter, WebSocketTransportOptions };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { Flock } from "@loro-dev/flock";
 import { Frontiers, LoroDoc } from "loro-crdt";
-import { FlockAdaptor, FlockAdaptorConfig } from "loro-adaptors";
+import { FlockAdaptor, FlockAdaptorConfig, LoroAdaptor } from "loro-adaptors";
 import { JoinError, JoinResponseOk, RoomId, UpdateError } from "loro-protocol";
 import { LoroWebsocketClientOptions } from "loro-websocket";
 
@@ -15,6 +15,14 @@ type GlobalBlob = typeof globalThis extends {
  * Binary content accepted by asset ingestion helpers.
  */
 type AssetContent = GlobalBlob | ArrayBufferView | ReadableStream<Uint8Array>;
+interface RepoAssetMetadata {
+  readonly assetId: AssetId;
+  readonly size: number;
+  readonly createdAt: number;
+  readonly mime?: string;
+  readonly policy?: string;
+  readonly tag?: string;
+}
 /**
  * JSON-compatible leaf value used for document metadata.
  */
@@ -565,52 +573,66 @@ declare class IndexedDBStorageAdaptor implements StorageAdapter {
   private createError;
 }
 //#endregion
-//#region src/index.d.ts
-interface RepoAssetMetadata {
-  readonly assetId: AssetId;
-  readonly size: number;
-  readonly createdAt: number;
-  readonly mime?: string;
-  readonly policy?: string;
-  readonly tag?: string;
+//#region src/storage/filesystem.d.ts
+interface FileSystemStorageAdaptorOptions {
+  /**
+   * Base directory where metadata, document snapshots, and assets will be stored.
+   * Defaults to `.loro-repo` inside the current working directory.
+   */
+  readonly baseDir?: string;
+  /**
+   * Subdirectory dedicated to document persistence. Defaults to `docs`.
+   */
+  readonly docsDirName?: string;
+  /**
+   * Subdirectory dedicated to asset blobs. Defaults to `assets`.
+   */
+  readonly assetsDirName?: string;
+  /**
+   * File name for the metadata snapshot bundle. Defaults to `meta.json`.
+   */
+  readonly metaFileName?: string;
 }
+declare class FileSystemStorageAdaptor implements StorageAdapter {
+  private readonly baseDir;
+  private readonly docsDir;
+  private readonly assetsDir;
+  private readonly metaPath;
+  private readonly initPromise;
+  private updateCounter;
+  constructor(options?: FileSystemStorageAdaptorOptions);
+  save(payload: StorageSavePayload): Promise<void>;
+  deleteAsset(assetId: AssetId): Promise<void>;
+  loadDoc(docId: string): Promise<LoroDoc | undefined>;
+  loadMeta(): Promise<Flock | undefined>;
+  loadAsset(assetId: AssetId): Promise<Uint8Array | undefined>;
+  private ensureLayout;
+  private writeDocSnapshot;
+  private enqueueDocUpdate;
+  private writeAsset;
+  private docDir;
+  private docSnapshotPath;
+  private docUpdatesDir;
+  private assetPath;
+}
+//#endregion
+//#region src/index.d.ts
 declare class LoroRepo<Meta extends JsonObject = JsonObject> {
   readonly options: LoroRepoOptions<Meta>;
   private readonly transport?;
   private readonly storage?;
-  private readonly assetTransport?;
   private readonly docFactory;
   private metaFlock;
-  private readonly metadata;
-  private readonly docs;
-  private readonly docRefs;
-  private readonly docSubscriptions;
-  private readonly docAssets;
-  private readonly assets;
-  private readonly orphanedAssets;
-  private readonly assetToDocRefs;
-  private readonly docFrontierKeys;
-  private readonly docFrontierUpdates;
-  private readonly docPersistedVersions;
-  private readonly docFrontierDebounceMs;
-  private readonly watchers;
-  private readonly eventByStack;
-  private metaRoomSubscription?;
-  private unsubscribeMetaFlock?;
-  private readyPromise?;
+  private readonly eventBus;
+  private readonly docManager;
+  private readonly metadataManager;
+  private readonly assetManager;
+  private readonly flockHydrator;
+  private readonly state;
+  private readonly syncRunner;
   constructor(options: LoroRepoOptions<Meta>);
   ready(): Promise<void>;
-  private initialize;
   sync(options?: RepoSyncOptions): Promise<void>;
-  private refreshDocMetadataEntry;
-  private refreshDocAssetsEntry;
-  private refreshAssetMetadataEntry;
-  private refreshDocFrontierKeys;
-  private readDocMetadataFromFlock;
-  private readDocAssetsFromFlock;
-  private readAssetMetadataFromFlock;
-  private handleAssetRemoval;
-  private emit;
   joinMetaRoom(params?: TransportJoinParams): Promise<TransportSubscription>;
   joinDocRoom(docId: string, params?: TransportJoinParams): Promise<TransportSubscription>;
   close(): Promise<void>;
@@ -636,35 +658,9 @@ declare class LoroRepo<Meta extends JsonObject = JsonObject> {
   unlinkAsset(docId: string, assetId: AssetId): Promise<void>;
   listAssets(docId: string): Promise<RepoAssetMetadata[]>;
   ensureAsset(assetId: AssetId): Promise<AssetDownload>;
-  private createAssetDownload;
-  private materializeAsset;
-  private updateDocAssetMetadata;
   gcAssets(options?: GarbageCollectionOptions): Promise<number>;
-  private onDocHandleClose;
-  private ensureDoc;
-  private materializeDetachedDoc;
-  private exportDocSnapshot;
   private persistMeta;
-  private persistDoc;
-  private persistDocUpdate;
-  private pushEventBy;
-  private popEventBy;
-  private resolveEventBy;
-  private ensureMetaLiveMonitor;
-  private applyMetaFlockEvents;
-  private registerDoc;
-  private ensureDocSubscription;
-  private rememberAsset;
-  private scheduleDocFrontierUpdate;
-  private mergeRepoEventBy;
-  private runScheduledDocFrontierUpdate;
-  private flushScheduledDocFrontierUpdate;
-  private onDocEvent;
-  private getAssetMetadata;
-  private updateDocFrontiers;
-  private hydrateMetadataFromFlock;
-  private shouldNotify;
 }
 //#endregion
-export { AssetContent, AssetDownload, AssetId, AssetTransportAdapter, AssetUploadMetadata, BroadcastChannelTransportAdapter, type BroadcastChannelTransportOptions, GarbageCollectionOptions, IndexedDBStorageAdaptor, type IndexedDBStorageAdaptorOptions, JsonObject, JsonValue, LinkAssetOptions, ListDocQuery, LoroRepo, LoroRepoOptions, RepoAssetMetadata, RepoDocHandle, RepoDocMeta, RepoEvent, RepoEventBy, RepoEventFilter, RepoEventListener, type RepoSyncOptions, RepoWatchHandle, StorageAdapter, StorageSavePayload, SyncScope, TransportAdapter, type TransportJoinParams, type TransportSubscription, TransportSyncRequest, type TransportSyncResult, UploadAssetOptions, UpsertDocMetaOptions, WebSocketTransportAdapter, WebSocketTransportOptions };
+export { AssetContent, AssetDownload, AssetId, AssetTransportAdapter, AssetUploadMetadata, BroadcastChannelTransportAdapter, type BroadcastChannelTransportOptions, FileSystemStorageAdaptor, type FileSystemStorageAdaptorOptions, GarbageCollectionOptions, IndexedDBStorageAdaptor, type IndexedDBStorageAdaptorOptions, JsonObject, JsonValue, LinkAssetOptions, ListDocQuery, LoroRepo, LoroRepoOptions, RepoAssetMetadata, RepoDocHandle, RepoDocMeta, RepoEvent, RepoEventBy, RepoEventFilter, RepoEventListener, type RepoSyncOptions, RepoWatchHandle, StorageAdapter, StorageSavePayload, SyncScope, TransportAdapter, type TransportJoinParams, type TransportSubscription, TransportSyncRequest, type TransportSyncResult, UploadAssetOptions, UpsertDocMetaOptions, WebSocketTransportAdapter, WebSocketTransportOptions };
 //# sourceMappingURL=index.d.ts.map