@rocicorp/zero 0.0.0-202410031711

package/out/replicache/src/subscriptions.d.ts

@@ -0,0 +1,140 @@
+import type { LogContext } from '@rocicorp/logger';
+import type { Diff, IndexDiff, NoIndexDiff } from './btree/node.js';
+import type { ScanOptions } from './db/scan.js';
+import type { DiffComputationConfig, DiffsMap } from './sync/diff.js';
+import { type ReadTransaction } from './transactions.js';
+import type { QueryInternal } from './types.js';
+declare const enum InvokeKind {
+    InitialRun = 0,
+    Regular = 1
+}
+export interface Subscription<R> {
+    hasIndexSubscription(indexName: string): boolean;
+    invoke(tx: ReadTransaction, kind: InvokeKind, diffs: DiffsMap | undefined): Promise<R>;
+    matches(diffs: DiffsMap): boolean;
+    updateDeps(keys: ReadonlySet<string>, scans: ReadonlyArray<Readonly<ScanSubscriptionInfo>>): void;
+    readonly onData: (result: R) => void;
+    readonly onError: ((error: unknown) => void) | undefined;
+    readonly onDone: (() => void) | undefined;
+}
+export declare class SubscriptionImpl<R> implements Subscription<R> {
+    #private;
+    readonly onError: ((error: unknown) => void) | undefined;
+    readonly onDone: (() => void) | undefined;
+    constructor(body: (tx: ReadTransaction) => Promise<R>, onData: (result: R) => void, onError: ((error: unknown) => void) | undefined, onDone: (() => void) | undefined, isEqual?: (a: R, b: R) => boolean);
+    hasIndexSubscription(indexName: string): boolean;
+    invoke(tx: ReadTransaction, _kind: InvokeKind, _diffs: DiffsMap | undefined): Promise<R>;
+    matches(diffs: DiffsMap): boolean;
+    updateDeps(keys: ReadonlySet<string>, scans: readonly Readonly<ScanSubscriptionInfo>[]): void;
+    onData(result: R): void;
+}
+export { SubscriptionImpl as SubscriptionImplForTesting };
+/**
+ * Function that gets passed into {@link Replicache.experimentalWatch} and gets
+ * called when the data in Replicache changes.
+ *
+ * @experimental This type is experimental and may change in the future.
+ */
+export type WatchNoIndexCallback = (diff: NoIndexDiff) => void;
+export type WatchCallbackForOptions<Options extends WatchOptions> = Options extends WatchIndexOptions ? WatchIndexCallback : WatchNoIndexCallback;
+/**
+ * Function that gets passed into {@link Replicache.experimentalWatch} when doing a
+ * watch on a secondary index map and gets called when the data in Replicache
+ * changes.
+ *
+ * @experimental This type is experimental and may change in the future.
+ */
+export type WatchIndexCallback = (diff: IndexDiff) => void;
+/**
+ * Options for {@link Replicache.experimentalWatch}.
+ *
+ * @experimental This interface is experimental and may change in the future.
+ */
+export type WatchOptions = WatchIndexOptions | WatchNoIndexOptions;
+/**
+ * Options object passed to {@link Replicache.experimentalWatch}. This is for an
+ * index watch.
+ */
+export type WatchIndexOptions = WatchNoIndexOptions & {
+    /**
+     * When provided, the `watch` is limited to the changes that apply to the index map.
+     */
+    indexName: string;
+};
+/**
+ * Options object passed to {@link Replicache.experimentalWatch}. This is for a non
+ * index watch.
+ */
+export type WatchNoIndexOptions = {
+    /**
+     * When provided, the `watch` is limited to changes where the `key` starts
+     * with `prefix`.
+     */
+    prefix?: string | undefined;
+    /**
+     * When this is set to `true` (default is `false`), the `watch` callback will
+     * be called once asynchronously when watch is called. The arguments in that
+     * case is a diff where we consider all the existing values in Replicache as
+     * being added.
+     */
+    initialValuesInFirstDiff?: boolean | undefined;
+};
+export type WatchCallback = (diff: Diff) => void;
+export declare class WatchSubscription implements Subscription<Diff | undefined> {
+    #private;
+    readonly onError: ((error: unknown) => void) | undefined;
+    readonly onDone: (() => void) | undefined;
+    constructor(callback: WatchCallback, options?: WatchOptions);
+    hasIndexSubscription(indexName: string): boolean;
+    onData(result: Diff | undefined): void;
+    invoke(tx: ReadTransaction, kind: InvokeKind, diffs: DiffsMap | undefined): Promise<Diff | undefined>;
+    matches(diffs: DiffsMap): boolean;
+    updateDeps(_keys: ReadonlySet<string>, _scans: readonly Readonly<ScanSubscriptionInfo>[]): void;
+}
+/**
+ * The options passed to {@link Replicache.subscribe}.
+ */
+export interface SubscribeOptions<R> {
+    /**
+     * Called when the return value of the body function changes.
+     */
+    onData: (result: R) => void;
+    /**
+     * If present, called when an error occurs.
+     */
+    onError?: ((error: unknown) => void) | undefined;
+    /**
+     * If present, called when the subscription is removed/done.
+     */
+    onDone?: (() => void) | undefined;
+    /**
+     * If present this function is used to determine if the value returned by the
+     * body function has changed. If not provided a JSON deep equality check is
+     * used.
+     */
+    isEqual?: ((a: R, b: R) => boolean) | undefined;
+}
+export type UnknownSubscription = Subscription<unknown>;
+export interface SubscriptionsManager extends DiffComputationConfig {
+    clear(): void;
+    fire(diffs: DiffsMap): Promise<void>;
+    hasPendingSubscriptionRuns: boolean;
+    add<R>(subscription: Subscription<R>): () => void;
+}
+export declare class SubscriptionsManagerImpl implements SubscriptionsManager {
+    #private;
+    hasPendingSubscriptionRuns: boolean;
+    constructor(queryInternal: QueryInternal, lc: LogContext);
+    add<R>(subscription: Subscription<R>): () => void;
+    clear(): void;
+    fire(diffs: DiffsMap): Promise<void>;
+    callCallbacks(subs: readonly Subscription<unknown>[], results: PromiseSettledResult<unknown>[]): void;
+    shouldComputeDiffs(): boolean;
+    shouldComputeDiffsForIndex(indexName: string): boolean;
+}
+export type ScanSubscriptionInfo = {
+    options: ScanOptions;
+    inclusiveLimitKey?: string | undefined;
+};
+export declare function scanInfoMatchesKey(scanInfo: ScanSubscriptionInfo, changeIndexName: string, changedKey: string): boolean;
+//# sourceMappingURL=subscriptions.d.ts.map

package/out/replicache/src/subscriptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscriptions.d.ts","sourceRoot":"","sources":["../../../../replicache/src/subscriptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,kBAAkB,CAAC;AAKjD,OAAO,KAAK,EACV,IAAI,EAEJ,SAAS,EAGT,WAAW,EACZ,MAAM,iBAAiB,CAAC;AAGzB,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,cAAc,CAAC;AAC9C,OAAO,KAAK,EAAC,qBAAqB,EAAE,QAAQ,EAAC,MAAM,gBAAgB,CAAC;AACpE,OAAO,EACL,KAAK,eAAe,EAErB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,YAAY,CAAC;AAE9C,mBAAW,UAAU;IACnB,UAAU,IAAA;IACV,OAAO,IAAA;CACR;AAED,MAAM,WAAW,YAAY,CAAC,CAAC;IAC7B,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC;IAEjD,MAAM,CACJ,EAAE,EAAE,eAAe,EACnB,IAAI,EAAE,UAAU,EAChB,KAAK,EAAE,QAAQ,GAAG,SAAS,GAC1B,OAAO,CAAC,CAAC,CAAC,CAAC;IAEd,OAAO,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO,CAAC;IAElC,UAAU,CACR,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC,EACzB,KAAK,EAAE,aAAa,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAC,GACnD,IAAI,CAAC;IAER,QAAQ,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,IAAI,CAAC;IACrC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IACzD,QAAQ,CAAC,MAAM,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,SAAS,CAAC;CAC3C;AAOD,qBAAa,gBAAgB,CAAC,CAAC,CAAE,YAAW,YAAY,CAAC,CAAC,CAAC;;IAOzD,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IACzD,QAAQ,CAAC,MAAM,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,SAAS,CAAC;gBAIxC,IAAI,EAAE,CAAC,EAAE,EAAE,eAAe,KAAK,OAAO,CAAC,CAAC,CAAC,EACzC,MAAM,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,IAAI,EAC3B,OAAO,EAAE,CAAC,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC,GAAG,SAAS,EAC/C,MAAM,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,SAAS,EAEhC,OAAO,GAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,OAA8C;IASzE,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;IAShD,MAAM,CACJ,EAAE,EAAE,eAAe,EACnB,KAAK,EAAE,UAAU,EACjB,MAAM,EAAE,QAAQ,GAAG,SAAS,GAC3B,OAAO,CAAC,CAAC,CAAC;IAIb,OAAO,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO;IAUjC,UAAU,CACR,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC,EACzB,KAAK,EAAE,SAAS,QAAQ,CAAC,oBAAoB,CAAC,EAAE,GAC/C,IAAI;IAKP,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,IAAI;CASxB;AAED,OAAO,EAAC,gBAAgB,IAAI,0BAA0B,EAAC,CAAC;AAExD;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,IAAI,EAAE,WAAW,KAAK,IAAI,CAAC;AAE/D,MAAM,MAAM,uBAAuB,CAAC,OAAO,SAAS,YAAY,IAC9D,OAAO,SAAS,iBAAiB,GAAG,kBAAkB,GAAG,oBAAoB,CAAC;AAEhF;;;;;;GAMG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI,CAAC;AAE3D;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;AAEnE;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,mBAAmB,GAAG;IACpD;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE5B;;;;;OAKG;IACH,wBAAwB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAChD,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,CAAC,IAAI,EAAE,IAAI,KAAK,IAAI,CAAC;AAEjD,qBAAa,iBAAkB,YAAW,YAAY,CAAC,IAAI,GAAG,SAAS,CAAC;;IAMtE,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC,GAAG,SAAS,CAAa;IACrE,QAAQ,CAAC,MAAM,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,SAAS,CAAa;gBAE1C,QAAQ,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,YAAY;IAO3D,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;IAIhD,MAAM,CAAC,MAAM,EAAE,IAAI,GAAG,SAAS,GAAG,IAAI;IAMtC,MAAM,CACJ,EAAE,EAAE,eAAe,EACnB,IAAI,EAAE,UAAU,EAChB,KAAK,EAAE,QAAQ,GAAG,SAAS,GAC1B,OAAO,CAAC,IAAI,GAAG,SAAS,CAAC;IAuE5B,OAAO,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO;IASjC,UAAU,CACR,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,EAC1B,MAAM,EAAE,SAAS,QAAQ,CAAC,oBAAoB,CAAC,EAAE,GAChD,IAAI;CAGR;AAgCD;;GAEG;AACH,MAAM,WAAW,gBAAgB,CAAC,CAAC;IACjC;;OAEG;IACH,MAAM,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IAEjD;;OAEG;IACH,MAAM,CAAC,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,SAAS,CAAC;IAElC;;;;OAIG;IACH,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,OAAO,CAAC,GAAG,SAAS,CAAC;CACjD;AAED,MAAM,MAAM,mBAAmB,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;AAIxD,MAAM,WAAW,oBAAqB,SAAQ,qBAAqB;IACjE,KAAK,IAAI,IAAI,CAAC;IACd,IAAI,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACrC,0BAA0B,EAAE,OAAO,CAAC;IACpC,GAAG,CAAC,CAAC,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,CAAC;CACnD;AAED,qBAAa,wBAAyB,YAAW,oBAAoB;;IAKnE,0BAA0B,UAAS;gBAEvB,aAAa,EAAE,aAAa,EAAE,EAAE,EAAE,UAAU;IAKxD,GAAG,CAAC,CAAC,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI;IASjD,KAAK,IAAI,IAAI;IAOP,IAAI,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAoC1C,aAAa,CACX,IAAI,EAAE,SAAS,YAAY,CAAC,OAAO,CAAC,EAAE,EACtC,OAAO,EAAE,oBAAoB,CAAC,OAAO,CAAC,EAAE;IAkC1C,kBAAkB,IAAI,OAAO;IAI7B,0BAA0B,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;CAQvD;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,OAAO,EAAE,WAAW,CAAC;IACrB,iBAAiB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACxC,CAAC;AAwCF,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,oBAAoB,EAC9B,eAAe,EAAE,MAAM,EACvB,UAAU,EAAE,MAAM,GACjB,OAAO,CA6ET"}

package/out/replicache/src/sync/diff.d.ts

@@ -0,0 +1,31 @@
+import type { InternalDiff } from '../btree/node.js';
+import type { Read } from '../dag/store.js';
+import { Commit, type Meta } from '../db/commit.js';
+import type { FormatVersion } from '../format-version.js';
+import type { Hash } from '../hash.js';
+/**
+ * Interface allowing different diff functions to skip costly diff computations.
+ */
+export interface DiffComputationConfig {
+    shouldComputeDiffs(): boolean;
+    shouldComputeDiffsForIndex(name: string): boolean;
+}
+/**
+ * The diffs in different indexes. The key of the map is the index name.
+ * "" is used for the primary index.
+ */
+export declare class DiffsMap extends Map<string, InternalDiff> {
+    set(key: string, value: InternalDiff): this;
+}
+/**
+ * Diffs the state of the db at two different hashes.
+ * It will include the primary indexes as well as all the secondary indexes.
+ */
+export declare function diff(oldHash: Hash, newHash: Hash, read: Read, diffConfig: DiffComputationConfig, formatVersion: FormatVersion): Promise<DiffsMap>;
+/**
+ * Diffs the state of the db at two different commits.
+ * It will include the primary indexes as well as all the secondary indexes.
+ */
+export declare function diffCommits(oldCommit: Commit<Meta>, newCommit: Commit<Meta>, read: Read, diffConfig: DiffComputationConfig, formatVersion: FormatVersion): Promise<DiffsMap>;
+export declare function addDiffsForIndexes(mainCommit: Commit<Meta>, syncCommit: Commit<Meta>, read: Read, diffsMap: DiffsMap, diffConfig: DiffComputationConfig, formatVersion: FormatVersion): Promise<void>;
+//# sourceMappingURL=diff.d.ts.map

package/out/replicache/src/sync/diff.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"diff.d.ts","sourceRoot":"","sources":["../../../../../replicache/src/sync/diff.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,kBAAkB,CAAC;AAEnD,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,iBAAiB,CAAC;AAC1C,OAAO,EAAC,MAAM,EAAkB,KAAK,IAAI,EAAC,MAAM,iBAAiB,CAAC;AAElE,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,sBAAsB,CAAC;AACxD,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,YAAY,CAAC;AAErC;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,kBAAkB,IAAI,OAAO,CAAC;IAC9B,0BAA0B,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;CACnD;AAED;;;GAGG;AACH,qBAAa,QAAS,SAAQ,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC;IAC5C,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,GAAG,IAAI;CAMrD;AAED;;;GAGG;AACH,wBAAsB,IAAI,CACxB,OAAO,EAAE,IAAI,EACb,OAAO,EAAE,IAAI,EACb,IAAI,EAAE,IAAI,EACV,UAAU,EAAE,qBAAqB,EACjC,aAAa,EAAE,aAAa,GAC3B,OAAO,CAAC,QAAQ,CAAC,CAOnB;AAED;;;GAGG;AAEH,wBAAsB,WAAW,CAC/B,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,EACvB,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,EACvB,IAAI,EAAE,IAAI,EACV,UAAU,EAAE,qBAAqB,EACjC,aAAa,EAAE,aAAa,GAC3B,OAAO,CAAC,QAAQ,CAAC,CAqBnB;AAED,wBAAsB,kBAAkB,CACtC,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,EACxB,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,EACxB,IAAI,EAAE,IAAI,EACV,QAAQ,EAAE,QAAQ,EAClB,UAAU,EAAE,qBAAqB,EACjC,aAAa,EAAE,aAAa,iBA+B7B"}

package/out/replicache/src/sync/ids.d.ts

@@ -0,0 +1,13 @@
+import * as valita from '../../../shared/src/valita.js';
+/**
+ * The ID describing a group of clients. All clients in the same group share a
+ * persistent storage (IDB).
+ */
+export type ClientGroupID = string;
+export declare const clientGroupIDSchema: valita.Type<ClientGroupID>;
+/**
+ * The ID describing a client.
+ */
+export type ClientID = string;
+export declare const clientIDSchema: valita.Type<ClientID>;
+//# sourceMappingURL=ids.d.ts.map

package/out/replicache/src/sync/ids.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ids.d.ts","sourceRoot":"","sources":["../../../../../replicache/src/sync/ids.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,sBAAsB,CAAC;AAE/C;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AAEnC,eAAO,MAAM,mBAAmB,EAAE,MAAM,CAAC,IAAI,CAAC,aAAa,CAAmB,CAAC;AAE/E;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAE9B,eAAO,MAAM,cAAc,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAmB,CAAC"}

package/out/replicache/src/sync/patch.d.ts

@@ -0,0 +1,5 @@
+import type { LogContext } from '@rocicorp/logger';
+import type { Write } from '../db/write.js';
+import type { PatchOperationInternal } from '../patch-operation.js';
+export declare function apply(lc: LogContext, dbWrite: Write, patch: readonly PatchOperationInternal[]): Promise<void>;
+//# sourceMappingURL=patch.d.ts.map

package/out/replicache/src/sync/patch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"patch.d.ts","sourceRoot":"","sources":["../../../../../replicache/src/sync/patch.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,kBAAkB,CAAC;AAGjD,OAAO,KAAK,EAAC,KAAK,EAAC,MAAM,gBAAgB,CAAC;AAM1C,OAAO,KAAK,EAAC,sBAAsB,EAAC,MAAM,uBAAuB,CAAC;AAElE,wBAAsB,KAAK,CACzB,EAAE,EAAE,UAAU,EACd,OAAO,EAAE,KAAK,EACd,KAAK,EAAE,SAAS,sBAAsB,EAAE,GACvC,OAAO,CAAC,IAAI,CAAC,CA2Cf"}

package/out/replicache/src/sync/pull-error.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This error is thrown when the puller fails for any reason.
+ */
+export declare class PullError extends Error {
+    name: string;
+    causedBy?: Error | undefined;
+    constructor(causedBy?: Error);
+}
+//# sourceMappingURL=pull-error.d.ts.map

package/out/replicache/src/sync/pull-error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pull-error.d.ts","sourceRoot":"","sources":["../../../../../replicache/src/sync/pull-error.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,qBAAa,SAAU,SAAQ,KAAK;IAClC,IAAI,SAAe;IAKnB,QAAQ,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;gBACjB,QAAQ,CAAC,EAAE,KAAK;CAI7B"}

package/out/replicache/src/sync/pull.d.ts

@@ -0,0 +1,82 @@
+import type { LogContext } from '@rocicorp/logger';
+import { type ReadonlyJSONValue } from '../../../shared/src/json.js';
+import { type Cookie } from '../cookies.js';
+import type { Store } from '../dag/store.js';
+import { Commit, type LocalMeta, type LocalMetaSDD, type Meta } from '../db/commit.js';
+import { FormatVersion } from '../format-version.js';
+import { type FrozenJSONValue } from '../frozen-json.js';
+import { type Hash } from '../hash.js';
+import type { HTTPRequestInfo } from '../http-request-info.js';
+import type { Puller, PullResponseOKV0, PullResponseOKV1Internal, PullResponseV0, PullResponseV1 } from '../puller.js';
+import { type DiffComputationConfig, DiffsMap } from './diff.js';
+import type { ClientGroupID, ClientID } from './ids.js';
+export declare const PULL_VERSION_SDD = 0;
+export declare const PULL_VERSION_DD31 = 1;
+/**
+ * The JSON value used as the body when doing a POST to the [pull
+ * endpoint](/reference/server-pull).
+ */
+export type PullRequest = PullRequestV1 | PullRequestV0;
+/**
+ * The JSON value used as the body when doing a POST to the [pull
+ * endpoint](/reference/server-pull). This is the legacy version (V0) and it is
+ * still used when recovering mutations from old clients.
+ */
+export type PullRequestV0 = {
+    pullVersion: 0;
+    schemaVersion: string;
+    profileID: string;
+    cookie: ReadonlyJSONValue;
+    clientID: ClientID;
+    lastMutationID: number;
+};
+/**
+ * The JSON value used as the body when doing a POST to the [pull
+ * endpoint](/reference/server-pull).
+ */
+export type PullRequestV1 = {
+    pullVersion: 1;
+    schemaVersion: string;
+    profileID: string;
+    cookie: Cookie;
+    clientGroupID: ClientGroupID;
+};
+export declare function isPullRequestV1(pr: PullRequest): pr is PullRequestV1;
+export type BeginPullResponseV1 = {
+    httpRequestInfo: HTTPRequestInfo;
+    pullResponse?: PullResponseV1;
+    syncHead: Hash;
+};
+export type BeginPullResponseV0 = {
+    httpRequestInfo: HTTPRequestInfo;
+    pullResponse?: PullResponseV0;
+    syncHead: Hash;
+};
+export declare function beginPullV0(profileID: string, clientID: ClientID, schemaVersion: string, puller: Puller, requestID: string, store: Store, formatVersion: FormatVersion, lc: LogContext, createSyncBranch?: boolean): Promise<BeginPullResponseV0>;
+export declare function beginPullV1(profileID: string, clientID: ClientID, clientGroupID: ClientGroupID, schemaVersion: string, puller: Puller, requestID: string, store: Store, formatVersion: FormatVersion, lc: LogContext, createSyncBranch?: boolean): Promise<BeginPullResponseV1>;
+export declare function handlePullResponseV0(lc: LogContext, store: Store, expectedBaseCookie: ReadonlyJSONValue, response: PullResponseOKV0, clientID: ClientID, formatVersion: FormatVersion): Promise<HandlePullResponseResult>;
+export declare enum HandlePullResponseResultType {
+    Applied = 0,
+    NoOp = 1,
+    CookieMismatch = 2
+}
+type HandlePullResponseResult = {
+    type: HandlePullResponseResultType.Applied;
+    syncHead: Hash;
+} | {
+    type: HandlePullResponseResultType.NoOp | HandlePullResponseResultType.CookieMismatch;
+};
+export declare function handlePullResponseV1(lc: LogContext, store: Store, expectedBaseCookie: FrozenJSONValue, response: PullResponseOKV1Internal, clientID: ClientID, formatVersion: FormatVersion): Promise<HandlePullResponseResult>;
+type MaybeEndPullResultBase<M extends Meta> = {
+    replayMutations?: Commit<M>[];
+    syncHead: Hash;
+    diffs: DiffsMap;
+};
+export type MaybeEndPullResultV0 = MaybeEndPullResultBase<LocalMetaSDD>;
+export declare function maybeEndPull<M extends LocalMeta>(store: Store, lc: LogContext, expectedSyncHead: Hash, clientID: ClientID, diffConfig: DiffComputationConfig, formatVersion: FormatVersion): Promise<{
+    syncHead: Hash;
+    replayMutations: Commit<M>[];
+    diffs: DiffsMap;
+}>;
+export {};
+//# sourceMappingURL=pull.d.ts.map

package/out/replicache/src/sync/pull.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pull.d.ts","sourceRoot":"","sources":["../../../../../replicache/src/sync/pull.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,kBAAkB,CAAC;AAEjD,OAAO,EAAY,KAAK,iBAAiB,EAAC,MAAM,oBAAoB,CAAC;AAGrE,OAAO,EAAiB,KAAK,MAAM,EAAC,MAAM,eAAe,CAAC;AAC1D,OAAO,KAAK,EAAC,KAAK,EAAC,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EAGL,MAAM,EAKN,KAAK,SAAS,EACd,KAAK,YAAY,EAEjB,KAAK,IAAI,EAEV,MAAM,iBAAiB,CAAC;AAQzB,OAAO,EAAC,aAAa,EAAC,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAa,KAAK,eAAe,EAAC,MAAM,mBAAmB,CAAC;AAKnE,OAAO,EAAY,KAAK,IAAI,EAAC,MAAM,YAAY,CAAC;AAChD,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,yBAAyB,CAAC;AAC7D,OAAO,KAAK,EACV,MAAM,EAIN,gBAAgB,EAChB,wBAAwB,EACxB,cAAc,EACd,cAAc,EACf,MAAM,cAAc,CAAC;AAItB,OAAO,EAEL,KAAK,qBAAqB,EAC1B,QAAQ,EACT,MAAM,WAAW,CAAC;AACnB,OAAO,KAAK,EAAC,aAAa,EAAE,QAAQ,EAAC,MAAM,UAAU,CAAC;AAKtD,eAAO,MAAM,gBAAgB,IAAI,CAAC;AAClC,eAAO,MAAM,iBAAiB,IAAI,CAAC;AAEnC;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,aAAa,GAAG,aAAa,CAAC;AAExD;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,WAAW,EAAE,CAAC,CAAC;IAIf,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,iBAAiB,CAAC;IAE1B,QAAQ,EAAE,QAAQ,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,WAAW,EAAE,CAAC,CAAC;IAIf,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IAEf,aAAa,EAAE,aAAa,CAAC;CAC9B,CAAC;AAEF,wBAAgB,eAAe,CAAC,EAAE,EAAE,WAAW,GAAG,EAAE,IAAI,aAAa,CAEpE;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,eAAe,EAAE,eAAe,CAAC;IACjC,YAAY,CAAC,EAAE,cAAc,CAAC;IAC9B,QAAQ,EAAE,IAAI,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,eAAe,EAAE,eAAe,CAAC;IACjC,YAAY,CAAC,EAAE,cAAc,CAAC;IAC9B,QAAQ,EAAE,IAAI,CAAC;CAChB,CAAC;AAEF,wBAAsB,WAAW,CAC/B,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,QAAQ,EAClB,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,KAAK,EACZ,aAAa,EAAE,aAAa,EAC5B,EAAE,EAAE,UAAU,EACd,gBAAgB,UAAO,GACtB,OAAO,CAAC,mBAAmB,CAAC,CAiE9B;AAED,wBAAsB,WAAW,CAC/B,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,QAAQ,EAClB,aAAa,EAAE,aAAa,EAC5B,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,KAAK,EACZ,aAAa,EAAE,aAAa,EAC5B,EAAE,EAAE,UAAU,EACd,gBAAgB,UAAO,GACtB,OAAO,CAAC,mBAAmB,CAAC,CA6D9B;AAkCD,wBAAgB,oBAAoB,CAClC,EAAE,EAAE,UAAU,EACd,KAAK,EAAE,KAAK,EACZ,kBAAkB,EAAE,iBAAiB,EACrC,QAAQ,EAAE,gBAAgB,EAC1B,QAAQ,EAAE,QAAQ,EAClB,aAAa,EAAE,aAAa,GAC3B,OAAO,CAAC,wBAAwB,CAAC,CAoInC;AAED,oBAAY,4BAA4B;IACtC,OAAO,IAAA;IACP,IAAI,IAAA;IACJ,cAAc,IAAA;CACf;AAED,KAAK,wBAAwB,GACzB;IACE,IAAI,EAAE,4BAA4B,CAAC,OAAO,CAAC;IAC3C,QAAQ,EAAE,IAAI,CAAC;CAChB,GACD;IACE,IAAI,EACA,4BAA4B,CAAC,IAAI,GACjC,4BAA4B,CAAC,cAAc,CAAC;CACjD,CAAC;AAUN,wBAAgB,oBAAoB,CAClC,EAAE,EAAE,UAAU,EACd,KAAK,EAAE,KAAK,EACZ,kBAAkB,EAAE,eAAe,EACnC,QAAQ,EAAE,wBAAwB,EAClC,QAAQ,EAAE,QAAQ,EAClB,aAAa,EAAE,aAAa,GAC3B,OAAO,CAAC,wBAAwB,CAAC,CA6FnC;AAED,KAAK,sBAAsB,CAAC,CAAC,SAAS,IAAI,IAAI;IAC5C,eAAe,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9B,QAAQ,EAAE,IAAI,CAAC;IACf,KAAK,EAAE,QAAQ,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,sBAAsB,CAAC,YAAY,CAAC,CAAC;AAExE,wBAAgB,YAAY,CAAC,CAAC,SAAS,SAAS,EAC9C,KAAK,EAAE,KAAK,EACZ,EAAE,EAAE,UAAU,EACd,gBAAgB,EAAE,IAAI,EACtB,QAAQ,EAAE,QAAQ,EAClB,UAAU,EAAE,qBAAqB,EACjC,aAAa,EAAE,aAAa,GAC3B,OAAO,CAAC;IACT,QAAQ,EAAE,IAAI,CAAC;IACf,eAAe,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;IAC7B,KAAK,EAAE,QAAQ,CAAC;CACjB,CAAC,CAiJD"}

package/out/replicache/src/sync/push.d.ts

@@ -0,0 +1,65 @@
+import type { LogContext } from '@rocicorp/logger';
+import type { ReadonlyJSONValue } from '../../../shared/src/json.js';
+import type { Store } from '../dag/store.js';
+import { type Pusher, type PusherResult } from '../pusher.js';
+import { type ClientGroupID, type ClientID } from './ids.js';
+export declare const PUSH_VERSION_SDD = 0;
+export declare const PUSH_VERSION_DD31 = 1;
+/**
+ * Mutation describes a single mutation done on the client. This is the legacy
+ * version (V0) and it is used when recovering mutations from old clients.
+ */
+export type MutationV0 = {
+    readonly id: number;
+    readonly name: string;
+    readonly args: ReadonlyJSONValue;
+    readonly timestamp: number;
+};
+/**
+ * Mutation describes a single mutation done on the client.
+ */
+export type MutationV1 = {
+    readonly id: number;
+    readonly name: string;
+    readonly args: ReadonlyJSONValue;
+    readonly timestamp: number;
+    readonly clientID: ClientID;
+};
+/**
+ * The JSON value used as the body when doing a POST to the [push
+ * endpoint](/reference/server-push). This is the legacy version (V0) and it is
+ * still used when recovering mutations from old clients.
+ */
+export type PushRequestV0 = {
+    pushVersion: 0;
+    /**
+     * `schemaVersion` can optionally be used to specify to the push endpoint
+     * version information about the mutators the app is using (e.g., format of
+     * mutator args).
+     */
+    schemaVersion: string;
+    profileID: string;
+    clientID: ClientID;
+    mutations: MutationV0[];
+};
+/**
+ * The JSON value used as the body when doing a POST to the [push
+ * endpoint](/reference/server-push).
+ */
+export type PushRequestV1 = {
+    pushVersion: 1;
+    /**
+     * `schemaVersion` can optionally be used to specify to the push endpoint
+     * version information about the mutators the app is using (e.g., format of
+     * mutator args).
+     */
+    schemaVersion: string;
+    profileID: string;
+    clientGroupID: ClientGroupID;
+    mutations: MutationV1[];
+};
+export type PushRequest = PushRequestV0 | PushRequestV1;
+export declare function assertPushRequestV0(value: unknown): asserts value is PushRequestV0;
+export declare function assertPushRequestV1(value: unknown): asserts value is PushRequestV1;
+export declare function push(requestID: string, store: Store, lc: LogContext, profileID: string, clientGroupID: ClientGroupID | undefined, clientID: ClientID, pusher: Pusher, schemaVersion: string, pushVersion: typeof PUSH_VERSION_SDD | typeof PUSH_VERSION_DD31): Promise<PusherResult | undefined>;
+//# sourceMappingURL=push.d.ts.map

package/out/replicache/src/sync/push.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"push.d.ts","sourceRoot":"","sources":["../../../../../replicache/src/sync/push.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,kBAAkB,CAAC;AAGjD,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,oBAAoB,CAAC;AAE1D,OAAO,KAAK,EAAC,KAAK,EAAC,MAAM,iBAAiB,CAAC;AAU3C,OAAO,EAEL,KAAK,MAAM,EACX,KAAK,YAAY,EAElB,MAAM,cAAc,CAAC;AAItB,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,QAAQ,EAGd,MAAM,UAAU,CAAC;AAElB,eAAO,MAAM,gBAAgB,IAAI,CAAC;AAClC,eAAO,MAAM,iBAAiB,IAAI,CAAC;AAEnC;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC;IACjC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC5B,CAAC;AASF;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC;IACjC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;CAC7B,CAAC;AAcF;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,WAAW,EAAE,CAAC,CAAC;IACf;;;;OAIG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;IAElB,QAAQ,EAAE,QAAQ,CAAC;IACnB,SAAS,EAAE,UAAU,EAAE,CAAC;CACzB,CAAC;AAUF;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,WAAW,EAAE,CAAC,CAAC;IACf;;;;OAIG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;IAElB,aAAa,EAAE,aAAa,CAAC;IAC7B,SAAS,EAAE,UAAU,EAAE,CAAC;CACzB,CAAC;AAUF,MAAM,MAAM,WAAW,GAAG,aAAa,GAAG,aAAa,CAAC;AAExD,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,OAAO,GACb,OAAO,CAAC,KAAK,IAAI,aAAa,CAEhC;AAED,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,OAAO,GACb,OAAO,CAAC,KAAK,IAAI,aAAa,CAEhC;AA4BD,wBAAsB,IAAI,CACxB,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,KAAK,EACZ,EAAE,EAAE,UAAU,EACd,SAAS,EAAE,MAAM,EACjB,aAAa,EAAE,aAAa,GAAG,SAAS,EACxC,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,MAAM,EACd,aAAa,EAAE,MAAM,EACrB,WAAW,EAAE,OAAO,gBAAgB,GAAG,OAAO,iBAAiB,GAC9D,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC,CA+DnC"}

package/out/replicache/src/sync/request-id.d.ts

@@ -0,0 +1,10 @@
+import type { ClientID } from './ids.js';
+/**
+ * Returns a new requestID of the form <client ID>-<session ID>-<request
+ * count>. The request count enables one to find the request following or
+ * preceding a given request. The sessionid scopes the request count, ensuring
+ * the requestID is probabilistically unique across restarts (which is good
+ * enough).
+ */
+export declare function newRequestID(clientID: ClientID): string;
+//# sourceMappingURL=request-id.d.ts.map

package/out/replicache/src/sync/request-id.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-id.d.ts","sourceRoot":"","sources":["../../../../../replicache/src/sync/request-id.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,UAAU,CAAC;AAcvC;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAUvD"}

package/out/replicache/src/sync/sync-head-name.d.ts

@@ -0,0 +1,2 @@
+export declare const SYNC_HEAD_NAME = "sync";
+//# sourceMappingURL=sync-head-name.d.ts.map

package/out/replicache/src/sync/sync-head-name.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sync-head-name.d.ts","sourceRoot":"","sources":["../../../../../replicache/src/sync/sync-head-name.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,cAAc,SAAS,CAAC"}

package/out/replicache/src/test-license-key.d.ts

@@ -0,0 +1,3 @@
+/** @deprecated */
+export declare const TEST_LICENSE_KEY = "This key only good for automated testing";
+//# sourceMappingURL=test-license-key.d.ts.map

package/out/replicache/src/test-license-key.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-license-key.d.ts","sourceRoot":"","sources":["../../../../replicache/src/test-license-key.ts"],"names":[],"mappings":"AAAA,kBAAkB;AAClB,eAAO,MAAM,gBAAgB,6CAA6C,CAAC"}

package/out/replicache/src/to-error.d.ts

@@ -0,0 +1,2 @@
+export declare function toError(e: unknown): Error;
+//# sourceMappingURL=to-error.d.ts.map

package/out/replicache/src/to-error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"to-error.d.ts","sourceRoot":"","sources":["../../../../replicache/src/to-error.ts"],"names":[],"mappings":"AAAA,wBAAgB,OAAO,CAAC,CAAC,EAAE,OAAO,GAAG,KAAK,CAKzC"}

package/out/replicache/src/transaction-closed-error.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This error is thrown when you try to call methods on a closed transaction.
+ */
+export declare class TransactionClosedError extends Error {
+    constructor();
+}
+export type Closed = {
+    closed: boolean;
+};
+export declare function throwIfClosed(tx: Closed): void;
+export declare function rejectIfClosed(tx: Closed): undefined | Promise<never>;
+//# sourceMappingURL=transaction-closed-error.d.ts.map

package/out/replicache/src/transaction-closed-error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction-closed-error.d.ts","sourceRoot":"","sources":["../../../../replicache/src/transaction-closed-error.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,KAAK;;CAIhD;AAED,MAAM,MAAM,MAAM,GAAG;IAAC,MAAM,EAAE,OAAO,CAAA;CAAC,CAAC;AAEvC,wBAAgB,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAI9C;AAED,wBAAgB,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,KAAK,CAAC,CAErE"}

package/out/replicache/src/transactions.d.ts

@@ -0,0 +1,156 @@
+import type { LogContext } from '@rocicorp/logger';
+import type { JSONValue, ReadonlyJSONValue } from '../../shared/src/json.js';
+import { type IndexKey } from './db/index.js';
+import type { Read } from './db/read.js';
+import type { Write } from './db/write.js';
+import type { IndexDefinition } from './index-defs.js';
+import type { ScanResult } from './scan-iterator.js';
+import { type ScanIndexOptions, type ScanNoIndexOptions, type ScanOptions } from './scan-options.js';
+import type { ScanSubscriptionInfo } from './subscriptions.js';
+import type { ClientID } from './sync/ids.js';
+export type TransactionEnvironment = 'client' | 'server';
+export type TransactionLocation = TransactionEnvironment;
+export type TransactionReason = 'initial' | 'rebase' | 'authoritative';
+/**
+ * Basic deep readonly type. It works for {@link JSONValue}.
+ */
+export type DeepReadonly<T> = T extends null | boolean | string | number | undefined ? T : DeepReadonlyObject<T>;
+export type DeepReadonlyObject<T> = {
+    readonly [K in keyof T]: DeepReadonly<T[K]>;
+};
+/**
+ * ReadTransactions are used with {@link Replicache.query} and
+ * {@link Replicache.subscribe} and allows read operations on the
+ * database.
+ */
+export interface ReadTransaction {
+    readonly clientID: ClientID;
+    /** @deprecated Use {@link ReadTransaction.location} instead. */
+    readonly environment: TransactionLocation;
+    readonly location: TransactionLocation;
+    /**
+     * Get a single value from the database. If the `key` is not present this
+     * returns `undefined`.
+     *
+     * Important: The returned JSON is readonly and should not be modified. This
+     * is only enforced statically by TypeScript and there are no runtime checks
+     * for performance reasons. If you mutate the return value you will get
+     * undefined behavior.
+     */
+    get(key: string): Promise<ReadonlyJSONValue | undefined>;
+    get<T extends JSONValue>(key: string): Promise<DeepReadonly<T> | undefined>;
+    /** Determines if a single `key` is present in the database. */
+    has(key: string): Promise<boolean>;
+    /** Whether the database is empty. */
+    isEmpty(): Promise<boolean>;
+    /**
+     * Gets many values from the database. This returns a {@link ScanResult} which
+     * implements `AsyncIterable`. It also has methods to iterate over the
+     * {@link ScanResult.keys | keys} and {@link ScanResult.entries | entries}.
+     *
+     * If `options` has an `indexName`, then this does a scan over an index with
+     * that name. A scan over an index uses a tuple for the key consisting of
+     * `[secondary: string, primary: string]`.
+     *
+     * If the {@link ScanResult} is used after the `ReadTransaction` has been closed
+     * it will throw a {@link TransactionClosedError}.
+     *
+     * Important: The returned JSON is readonly and should not be modified. This
+     * is only enforced statically by TypeScript and there are no runtime checks
+     * for performance reasons. If you mutate the return value you will get
+     * undefined behavior.
+     */
+    scan(options: ScanIndexOptions): ScanResult<IndexKey, ReadonlyJSONValue>;
+    scan(options?: ScanNoIndexOptions): ScanResult<string, ReadonlyJSONValue>;
+    scan(options?: ScanOptions): ScanResult<IndexKey | string, ReadonlyJSONValue>;
+    scan<V extends ReadonlyJSONValue>(options: ScanIndexOptions): ScanResult<IndexKey, DeepReadonly<V>>;
+    scan<V extends ReadonlyJSONValue>(options?: ScanNoIndexOptions): ScanResult<string, DeepReadonly<V>>;
+    scan<V extends ReadonlyJSONValue>(options?: ScanOptions): ScanResult<IndexKey | string, DeepReadonly<V>>;
+}
+export declare class ReadTransactionImpl implements ReadTransaction {
+    readonly clientID: ClientID;
+    readonly dbtx: Read;
+    protected readonly _lc: LogContext;
+    /**
+     * The location in which this transaction is being used. This is either `client` or `server`.
+     */
+    readonly location: TransactionLocation;
+    /** @deprecated Use {@link ReadTransaction.location} instead. */
+    readonly environment: TransactionLocation;
+    constructor(clientID: ClientID, dbRead: Read, lc: LogContext, rpcName?: string);
+    get(key: string): Promise<ReadonlyJSONValue | undefined>;
+    has(key: string): Promise<boolean>;
+    isEmpty(): Promise<boolean>;
+    scan(options: ScanIndexOptions): ScanResult<IndexKey, ReadonlyJSONValue>;
+    scan(options?: ScanNoIndexOptions): ScanResult<string, ReadonlyJSONValue>;
+    scan(options?: ScanOptions): ScanResult<IndexKey | string, ReadonlyJSONValue>;
+    scan<V extends ReadonlyJSONValue>(options: ScanIndexOptions): ScanResult<IndexKey, DeepReadonly<V>>;
+    scan<V extends ReadonlyJSONValue>(options?: ScanNoIndexOptions): ScanResult<string, DeepReadonly<V>>;
+    scan<V extends ReadonlyJSONValue>(options?: ScanOptions): ScanResult<IndexKey | string, DeepReadonly<V>>;
+}
+export declare class SubscriptionTransactionWrapper implements ReadTransaction {
+    #private;
+    constructor(tx: ReadTransactionImpl);
+    get environment(): TransactionLocation;
+    get location(): TransactionLocation;
+    get clientID(): string;
+    isEmpty(): Promise<boolean>;
+    get(key: string): Promise<ReadonlyJSONValue | undefined>;
+    has(key: string): Promise<boolean>;
+    scan(options: ScanIndexOptions): ScanResult<IndexKey, ReadonlyJSONValue>;
+    scan(options?: ScanNoIndexOptions): ScanResult<string, ReadonlyJSONValue>;
+    scan(options?: ScanOptions): ScanResult<IndexKey | string, ReadonlyJSONValue>;
+    scan<V extends ReadonlyJSONValue>(options: ScanIndexOptions): ScanResult<IndexKey, DeepReadonly<V>>;
+    scan<V extends ReadonlyJSONValue>(options?: ScanNoIndexOptions): ScanResult<string, DeepReadonly<V>>;
+    scan<V extends ReadonlyJSONValue>(options?: ScanOptions): ScanResult<IndexKey | string, DeepReadonly<V>>;
+    get keys(): ReadonlySet<string>;
+    get scans(): ScanSubscriptionInfo[];
+}
+/**
+ * WriteTransactions are used with *mutators* which are registered using
+ * {@link ReplicacheOptions.mutators} and allows read and write operations on the
+ * database.
+ */
+export interface WriteTransaction extends ReadTransaction {
+    /**
+     * The ID of the mutation that is being applied.
+     */
+    readonly mutationID: number;
+    /**
+     * The reason for the transaction. This can be `initial`, `rebase` or `authoriative`.
+     */
+    readonly reason: TransactionReason;
+    /**
+     * Sets a single `value` in the database. The value will be frozen (using
+     * `Object.freeze`) in debug mode.
+     */
+    set(key: string, value: ReadonlyJSONValue): Promise<void>;
+    /**
+     * @deprecated Use {@link WriteTransaction.set} instead.
+     */
+    put(key: string, value: ReadonlyJSONValue): Promise<void>;
+    /**
+     * Removes a `key` and its value from the database. Returns `true` if there was a
+     * `key` to remove.
+     */
+    del(key: string): Promise<boolean>;
+}
+export declare class WriteTransactionImpl extends ReadTransactionImpl implements WriteTransaction {
+    readonly dbtx: Write;
+    readonly reason: TransactionReason;
+    readonly mutationID: number;
+    constructor(clientID: ClientID, mutationID: number, reason: TransactionReason, dbWrite: Write, lc: LogContext, rpcName?: string);
+    put(key: string, value: ReadonlyJSONValue): Promise<void>;
+    set(key: string, value: ReadonlyJSONValue): Promise<void>;
+    del(key: string): Promise<boolean>;
+}
+export type CreateIndexDefinition = IndexDefinition & {
+    name: string;
+};
+type Entry<Key, Value> = readonly [key: Key, value: Value];
+type IndexKeyEntry<Value> = Entry<IndexKey, Value>;
+type StringKeyEntry<Value> = Entry<string, Value>;
+export type EntryForOptions<Options extends ScanOptions, V> = Options extends ScanIndexOptions ? IndexKeyEntry<V> : StringKeyEntry<V>;
+export declare function fromKeyForNonIndexScan(options: ScanNoIndexOptions | undefined): string;
+export {};
+//# sourceMappingURL=transactions.d.ts.map

package/out/replicache/src/transactions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transactions.d.ts","sourceRoot":"","sources":["../../../../replicache/src/transactions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,kBAAkB,CAAC;AAEjD,OAAO,KAAK,EAAC,SAAS,EAAE,iBAAiB,EAAC,MAAM,oBAAoB,CAAC;AACrE,OAAO,EAAC,KAAK,QAAQ,EAAiB,MAAM,eAAe,CAAC;AAC5D,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,cAAc,CAAC;AACvC,OAAO,KAAK,EAAC,KAAK,EAAC,MAAM,eAAe,CAAC;AAEzC,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,oBAAoB,CAAC;AAEnD,OAAO,EAEL,KAAK,gBAAgB,EACrB,KAAK,kBAAkB,EACvB,KAAK,WAAW,EAGjB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAC,oBAAoB,EAAC,MAAM,oBAAoB,CAAC;AAC7D,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,eAAe,CAAC;AAG5C,MAAM,MAAM,sBAAsB,GAAG,QAAQ,GAAG,QAAQ,CAAC;AACzD,MAAM,MAAM,mBAAmB,GAAG,sBAAsB,CAAC;AACzD,MAAM,MAAM,iBAAiB,GAAG,SAAS,GAAG,QAAQ,GAAG,eAAe,CAAC;AAEvE;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,CAAC,SAC3B,IAAI,GACJ,OAAO,GACP,MAAM,GACN,MAAM,GACN,SAAS,GACT,CAAC,GACD,kBAAkB,CAAC,CAAC,CAAC,CAAC;AAE1B,MAAM,MAAM,kBAAkB,CAAC,CAAC,IAAI;IAClC,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC5C,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,gEAAgE;IAChE,QAAQ,CAAC,WAAW,EAAE,mBAAmB,CAAC;IAC1C,QAAQ,CAAC,QAAQ,EAAE,mBAAmB,CAAC;IAEvC;;;;;;;;OAQG;IAEH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC,CAAC;IACzD,GAAG,CAAC,CAAC,SAAS,SAAS,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;IAE5E,+DAA+D;IAC/D,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEnC,qCAAqC;IACrC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAE5B;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CAAC,OAAO,EAAE,gBAAgB,GAAG,UAAU,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC;IACzE,IAAI,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,UAAU,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAC1E,IAAI,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,UAAU,CAAC,QAAQ,GAAG,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAE9E,IAAI,CAAC,CAAC,SAAS,iBAAiB,EAC9B,OAAO,EAAE,gBAAgB,GACxB,UAAU,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;IACzC,IAAI,CAAC,CAAC,SAAS,iBAAiB,EAC9B,OAAO,CAAC,EAAE,kBAAkB,GAC3B,UAAU,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;IACvC,IAAI,CAAC,CAAC,SAAS,iBAAiB,EAC9B,OAAO,CAAC,EAAE,WAAW,GACpB,UAAU,CAAC,QAAQ,GAAG,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;CACnD;AAID,qBAAa,mBAAoB,YAAW,eAAe;IACzD,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACpB,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,UAAU,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,mBAAmB,CAAC;IACvC,gEAAgE;IAChE,QAAQ,CAAC,WAAW,EAAE,mBAAmB,CAAC;gBAGxC,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,IAAI,EACZ,EAAE,EAAE,UAAU,EACd,OAAO,SAAwB;IAWjC,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;IASlD,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAMlC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC;IAKjC,IAAI,CAAC,OAAO,EAAE,gBAAgB,GAAG,UAAU,CAAC,QAAQ,EAAE,iBAAiB,CAAC;IACxE,IAAI,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,UAAU,CAAC,MAAM,EAAE,iBAAiB,CAAC;IACzE,IAAI,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,UAAU,CAAC,QAAQ,GAAG,MAAM,EAAE,iBAAiB,CAAC;IAE7E,IAAI,CAAC,CAAC,SAAS,iBAAiB,EAC9B,OAAO,EAAE,gBAAgB,GACxB,UAAU,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;IACxC,IAAI,CAAC,CAAC,SAAS,iBAAiB,EAC9B,OAAO,CAAC,EAAE,kBAAkB,GAC3B,UAAU,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;IACtC,IAAI,CAAC,CAAC,SAAS,iBAAiB,EAC9B,OAAO,CAAC,EAAE,WAAW,GACpB,UAAU,CAAC,QAAQ,GAAG,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;CAOlD;AAsBD,qBAAa,8BAA+B,YAAW,eAAe;;gBAKxD,EAAE,EAAE,mBAAmB;IAInC,IAAI,WAAW,IAAI,mBAAmB,CAErC;IAED,IAAI,QAAQ,IAAI,mBAAmB,CAElC;IAED,IAAI,QAAQ,IAAI,MAAM,CAErB;IAED,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC;IAM3B,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAMxD,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAKlC,IAAI,CAAC,OAAO,EAAE,gBAAgB,GAAG,UAAU,CAAC,QAAQ,EAAE,iBAAiB,CAAC;IACxE,IAAI,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,UAAU,CAAC,MAAM,EAAE,iBAAiB,CAAC;IACzE,IAAI,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,UAAU,CAAC,QAAQ,GAAG,MAAM,EAAE,iBAAiB,CAAC;IAE7E,IAAI,CAAC,CAAC,SAAS,iBAAiB,EAC9B,OAAO,EAAE,gBAAgB,GACxB,UAAU,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;IACxC,IAAI,CAAC,CAAC,SAAS,iBAAiB,EAC9B,OAAO,CAAC,EAAE,kBAAkB,GAC3B,UAAU,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;IACtC,IAAI,CAAC,CAAC,SAAS,iBAAiB,EAC9B,OAAO,CAAC,EAAE,WAAW,GACpB,UAAU,CAAC,QAAQ,GAAG,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;IAejD,IAAI,IAAI,IAAI,WAAW,CAAC,MAAM,CAAC,CAE9B;IAED,IAAI,KAAK,IAAI,oBAAoB,EAAE,CAElC;CACF;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACvD;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,iBAAiB,CAAC;IAEnC;;;OAGG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1D;;OAEG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1D;;;OAGG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CACpC;AAED,qBAAa,oBACX,SAAQ,mBACR,YAAW,gBAAgB;IAG3B,SAAiB,IAAI,EAAE,KAAK,CAAC;IAC7B,QAAQ,CAAC,MAAM,EAAE,iBAAiB,CAAC;IACnC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;gBAG1B,QAAQ,EAAE,QAAQ,EAClB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,iBAAiB,EACzB,OAAO,EAAE,KAAK,EACd,EAAE,EAAE,UAAU,EACd,OAAO,SAAyB;IAOlC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAInD,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAK/D,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;CAGnC;AAED,MAAM,MAAM,qBAAqB,GAAG,eAAe,GAAG;IAAC,IAAI,EAAE,MAAM,CAAA;CAAC,CAAC;AAErE,KAAK,KAAK,CAAC,GAAG,EAAE,KAAK,IAAI,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;AAE3D,KAAK,aAAa,CAAC,KAAK,IAAI,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;AAEnD,KAAK,cAAc,CAAC,KAAK,IAAI,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AAElD,MAAM,MAAM,eAAe,CACzB,OAAO,SAAS,WAAW,EAC3B,CAAC,IACC,OAAO,SAAS,gBAAgB,GAAG,aAAa,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;AAiB5E,wBAAgB,sBAAsB,CACpC,OAAO,EAAE,kBAAkB,GAAG,SAAS,GACtC,MAAM,CAUR"}