@loro-dev/flock 3.0.0 → 4.0.0

package/dist/index.d.mts

@@ -4,6 +4,7 @@ type ExportOptions = {
   from?: VersionVector;
   hooks?: ExportHooks;
   pruneTombstonesBefore?: number;
+  peerId?: string;
 };
 type ImportOptions = {
   bundle: ExportBundle;
@@ -13,7 +14,11 @@ type VersionVectorEntry = {
   physicalTime: number;
   logicalCounter: number;
 };
-type VersionVector = Record<string, VersionVectorEntry>;
+interface VersionVector {
+  [peer: string]: VersionVectorEntry | undefined;
+}
+declare function encodeVersionVector(vector: VersionVector): Uint8Array;
+declare function decodeVersionVector(bytes: Uint8Array): VersionVector;
 type Value = string | number | boolean | null | Array<Value> | {
   [key: string]: Value;
 };
@@ -33,6 +38,11 @@ type EntryClock = {
   logicalCounter: number;
   peerId: string;
 };
+type EntryInfo = {
+  data?: Value;
+  metadata: MetadataMap;
+  clock: EntryClock;
+};
 type ExportPayload = {
   data?: Value;
   metadata?: MetadataMap;
@@ -134,6 +144,14 @@ declare class Flock {
    */
   delete(key: KeyPart[], now?: number): void;
   get(key: KeyPart[]): Value | undefined;
+  /**
+   * Returns the full entry payload (data, metadata, and clock) for a key.
+   *
+   * Unlike `get`, this distinguishes between a missing key (`undefined`) and a
+   * tombstone (returns the clock and metadata with `data` omitted). Metadata is
+   * cloned and defaults to `{}` when absent.
+   */
+  getEntry(key: KeyPart[]): EntryInfo | undefined;
   merge(other: Flock): void;
   version(): VersionVector;
   private exportJsonInternal;
@@ -146,6 +164,7 @@ declare class Flock {
   private importJsonWithHooks;
   importJson(bundle: ExportBundle): ImportReport;
   importJson(options: ImportOptions): Promise<ImportReport>;
+  importJsonStr(bundle: string): ImportReport;
   getMaxPhysicalTime(): number;
   peerId(): string;
   digest(): string;
@@ -156,5 +175,5 @@ declare class Flock {
   subscribe(listener: (batch: EventBatch) => void): () => void;
 }
 //#endregion
-export { EntryClock, Event, EventBatch, EventPayload, ExportBundle, ExportHookContext, ExportHooks, ExportPayload, ExportRecord, Flock, ImportAccept, ImportDecision, ImportHookContext, ImportHooks, ImportPayload, ImportReport, ImportSkip, KeyPart, MetadataMap, PutHookContext, PutHooks, PutPayload, PutWithMetaOptions, ScanBound, ScanOptions, ScanRow, Value, VersionVector, VersionVectorEntry };
+export { EntryClock, EntryInfo, Event, EventBatch, EventPayload, ExportBundle, ExportHookContext, ExportHooks, ExportPayload, ExportRecord, Flock, ImportAccept, ImportDecision, ImportHookContext, ImportHooks, ImportPayload, ImportReport, ImportSkip, KeyPart, MetadataMap, PutHookContext, PutHooks, PutPayload, PutWithMetaOptions, ScanBound, ScanOptions, ScanRow, Value, VersionVector, VersionVectorEntry, decodeVersionVector, encodeVersionVector };
 //# sourceMappingURL=index.d.mts.map

package/dist/index.d.ts

@@ -4,6 +4,7 @@ type ExportOptions = {
   from?: VersionVector;
   hooks?: ExportHooks;
   pruneTombstonesBefore?: number;
+  peerId?: string;
 };
 type ImportOptions = {
   bundle: ExportBundle;
@@ -13,7 +14,11 @@ type VersionVectorEntry = {
   physicalTime: number;
   logicalCounter: number;
 };
-type VersionVector = Record<string, VersionVectorEntry>;
+interface VersionVector {
+  [peer: string]: VersionVectorEntry | undefined;
+}
+declare function encodeVersionVector(vector: VersionVector): Uint8Array;
+declare function decodeVersionVector(bytes: Uint8Array): VersionVector;
 type Value = string | number | boolean | null | Array<Value> | {
   [key: string]: Value;
 };
@@ -33,6 +38,11 @@ type EntryClock = {
   logicalCounter: number;
   peerId: string;
 };
+type EntryInfo = {
+  data?: Value;
+  metadata: MetadataMap;
+  clock: EntryClock;
+};
 type ExportPayload = {
   data?: Value;
   metadata?: MetadataMap;
@@ -134,6 +144,14 @@ declare class Flock {
    */
   delete(key: KeyPart[], now?: number): void;
   get(key: KeyPart[]): Value | undefined;
+  /**
+   * Returns the full entry payload (data, metadata, and clock) for a key.
+   *
+   * Unlike `get`, this distinguishes between a missing key (`undefined`) and a
+   * tombstone (returns the clock and metadata with `data` omitted). Metadata is
+   * cloned and defaults to `{}` when absent.
+   */
+  getEntry(key: KeyPart[]): EntryInfo | undefined;
   merge(other: Flock): void;
   version(): VersionVector;
   private exportJsonInternal;
@@ -146,6 +164,7 @@ declare class Flock {
   private importJsonWithHooks;
   importJson(bundle: ExportBundle): ImportReport;
   importJson(options: ImportOptions): Promise<ImportReport>;
+  importJsonStr(bundle: string): ImportReport;
   getMaxPhysicalTime(): number;
   peerId(): string;
   digest(): string;
@@ -156,5 +175,5 @@ declare class Flock {
   subscribe(listener: (batch: EventBatch) => void): () => void;
 }
 //#endregion
-export { EntryClock, Event, EventBatch, EventPayload, ExportBundle, ExportHookContext, ExportHooks, ExportPayload, ExportRecord, Flock, ImportAccept, ImportDecision, ImportHookContext, ImportHooks, ImportPayload, ImportReport, ImportSkip, KeyPart, MetadataMap, PutHookContext, PutHooks, PutPayload, PutWithMetaOptions, ScanBound, ScanOptions, ScanRow, Value, VersionVector, VersionVectorEntry };
+export { EntryClock, EntryInfo, Event, EventBatch, EventPayload, ExportBundle, ExportHookContext, ExportHooks, ExportPayload, ExportRecord, Flock, ImportAccept, ImportDecision, ImportHookContext, ImportHooks, ImportPayload, ImportReport, ImportSkip, KeyPart, MetadataMap, PutHookContext, PutHooks, PutPayload, PutWithMetaOptions, ScanBound, ScanOptions, ScanRow, Value, VersionVector, VersionVectorEntry, decodeVersionVector, encodeVersionVector };
 //# sourceMappingURL=index.d.ts.map