Class AutomergeHistorySidecar

Implements

HistorySidecar

Index

Constructors

Methods

at branch branches clear diff entries load merge record save

Constructors

constructor

new AutomergeHistorySidecar(
opts?: AutomergeHistorySidecarOptions,
): AutomergeHistorySidecar
Parameters
- Optionalopts: AutomergeHistorySidecarOptions
Returns AutomergeHistorySidecar

Methods

at

at(at: string | Date, branch?: string): Promise<HistoryEntry | null>
The entry whose at is closest to (and not after) at.
Parameters
- at: string | Date
- Optionalbranch: string
Returns Promise<HistoryEntry | null>

Implementation of HistorySidecar.at

branch

branch(name: string, fromEntryId?: string): Promise<BranchInfo>
Create a new branch off fromEntryId (defaults to head of main).
Parameters
- name: string
- OptionalfromEntryId: string
Returns Promise<BranchInfo>

Implementation of HistorySidecar.branch

branches

branches(): Promise<BranchInfo[]>

All known branches, in creation order.

Returns Promise<BranchInfo[]>

Implementation of HistorySidecar.branches

clear

clear(): Promise<void>

Remove all entries / branches.

Returns Promise<void>

Implementation of HistorySidecar.clear

diff

diff(fromEntryId: string, toEntryId: string): Promise<HistoryDiff>
Per-entity-id diff between two entries.
Parameters
- fromEntryId: string
- toEntryId: string
Returns Promise<HistoryDiff>

Implementation of HistorySidecar.diff

entries

entries(branch?: string): Promise<HistoryEntry[]>
All entries, oldest first, optionally filtered to one branch.
Parameters
- Optionalbranch: string
Returns Promise<HistoryEntry[]>

Implementation of HistorySidecar.entries

load

load(serialised: Uint8Array): void
Replace the internal doc. Used by tests + restore flows.
Parameters
- serialised: Uint8Array
Returns void

merge

merge(
    branch: string,
    into: string,
    mergedSnapshot: IfcxFile,
): Promise<HistoryEntry>
Merge branch into into. Returns a synthetic merge entry — apps compute the merged snapshot themselves (typically by replaying Y-update logs through mergeBranch).
Parameters
- branch: string
- into: string
- mergedSnapshot: IfcxFile
Returns Promise<HistoryEntry>

Implementation of HistorySidecar.merge

record

record(
    input: {
        authorClientId?: number;
        branch?: string;
        diff?: IfcxFile;
        label?: string;
        snapshot: IfcxFile;
    },
): Promise<HistoryEntry>
Append a new entry to a branch (default 'main').
Parameters
- input: {
      authorClientId?: number;
      branch?: string;
      diff?: IfcxFile;
      label?: string;
      snapshot: IfcxFile;
  }
Returns Promise<HistoryEntry>

Implementation of HistorySidecar.record

save

save(): Uint8Array

Serialise the entire history doc. Use to persist across restarts.

Returns Uint8Array