@rocicorp/zero 0.0.202410040740 → 0.0.202410040818

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

@@ -0,0 +1,26 @@
+import type { LogContext } from '@rocicorp/logger';
+import type { LazyStore } from '../dag/lazy-store.js';
+import type { Store } from '../dag/store.js';
+import type { FormatVersion } from '../format-version-enum.js';
+import type { ClientID } from '../sync/ids.js';
+import type { MutatorDefs } from '../types.js';
+/**
+ * Persists the client's memdag state to the client's perdag client group.
+ *
+ * Persists the base snapshot from memdag to the client's perdag client group,
+ * but only if it’s newer than the client's perdag client group’s base snapshot.
+ * The base snapshot is persisted by gathering all memory-only chunks in the dag
+ * subgraph rooted at the base snapshot's commit and writing them to the perdag.
+ * Once the base snapshot is persisted, rebases onto this new base snapshot all
+ * local commits from the client's perdag client group that are not already
+ * reflected in the base snapshot.
+ *
+ * Whether or not the base snapshot is persisted, rebases onto the client's
+ * perdag client group all memdag local commits not already in the client's
+ * perdag client group's history.
+ *
+ * Also updates the `lastMutationIDs` and `lastServerAckdMutationIDs` properties
+ * of the client's client group's entry in the `ClientGroupMap`.
+ */
+export declare function persistDD31(lc: LogContext, clientID: ClientID, memdag: LazyStore, perdag: Store, mutators: MutatorDefs, closed: () => boolean, formatVersion: FormatVersion, onGatherMemOnlyChunksForTest?: () => Promise<void>): Promise<void>;
+//# sourceMappingURL=persist.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"persist.d.ts","sourceRoot":"","sources":["../../../../../replicache/src/persist/persist.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,kBAAkB,CAAC;AAGjD,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,sBAAsB,CAAC;AACpD,OAAO,KAAK,EAAO,KAAK,EAAQ,MAAM,iBAAiB,CAAC;AAexD,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,2BAA2B,CAAC;AAE7D,OAAO,KAAK,EAAgB,QAAQ,EAAC,MAAM,gBAAgB,CAAC;AAC5D,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,aAAa,CAAC;AAgB7C;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAsB,WAAW,CAC/B,EAAE,EAAE,UAAU,EACd,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,SAAS,EACjB,MAAM,EAAE,KAAK,EACb,QAAQ,EAAE,WAAW,EACrB,MAAM,EAAE,MAAM,OAAO,EACrB,aAAa,EAAE,aAAa,EAC5B,4BAA4B,sBAA0B,GACrD,OAAO,CAAC,IAAI,CAAC,CA4Kf"}

package/out/replicache/src/persist/refresh.d.ts

@@ -0,0 +1,13 @@
+import type { LogContext } from '@rocicorp/logger';
+import type { LazyStore } from '../dag/lazy-store.js';
+import type { Store } from '../dag/store.js';
+import type { FormatVersion } from '../format-version-enum.js';
+import { type DiffComputationConfig, DiffsMap } from '../sync/diff.js';
+import type { ClientID } from '../sync/ids.js';
+import type { MutatorDefs } from '../types.js';
+/**
+ * This returns the diff between the state of the btree before and after
+ * refresh. It returns `undefined` if the refresh was aborted.
+ */
+export declare function refresh(lc: LogContext, memdag: LazyStore, perdag: Store, clientID: ClientID, mutators: MutatorDefs, diffConfig: DiffComputationConfig, closed: () => boolean, formatVersion: FormatVersion): Promise<DiffsMap | undefined>;
+//# sourceMappingURL=refresh.d.ts.map

package/out/replicache/src/persist/refresh.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"refresh.d.ts","sourceRoot":"","sources":["../../../../../replicache/src/persist/refresh.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,kBAAkB,CAAC;AAEjD,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,sBAAsB,CAAC;AACpD,OAAO,KAAK,EAAC,KAAK,EAAC,MAAM,iBAAiB,CAAC;AAe3C,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,2BAA2B,CAAC;AAE7D,OAAO,EACL,KAAK,qBAAqB,EAC1B,QAAQ,EAET,MAAM,iBAAiB,CAAC;AACzB,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,aAAa,CAAC;AA6B7C;;;GAGG;AACH,wBAAsB,OAAO,CAC3B,EAAE,EAAE,UAAU,EACd,MAAM,EAAE,SAAS,EACjB,MAAM,EAAE,KAAK,EACb,QAAQ,EAAE,QAAQ,EAClB,QAAQ,EAAE,WAAW,EACrB,UAAU,EAAE,qBAAqB,EACjC,MAAM,EAAE,MAAM,OAAO,EACrB,aAAa,EAAE,aAAa,GAC3B,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC,CA6N/B"}

package/out/replicache/src/process-scheduler.d.ts

@@ -0,0 +1,20 @@
+import { requestIdle as defaultRequestIdle } from './request-idle.js';
+export declare class ProcessScheduler {
+    #private;
+    /**
+     * Supports scheduling a `process` to be run with certain constraints.
+     *  - Process runs are never concurrent.
+     *  - Multiple calls to schedule will be fulfilled by a single process
+     *    run started after the call to schedule.  A call is never fulfilled by an
+     *    already running process run.  This can be thought of as debouncing.
+     *  - Process runs are throttled so that the process runs at most once every
+     *    `throttleMs`.
+     *  - Process runs try to run during an idle period, but will delay at most
+     *    `idleTimeoutMs`.
+     *  - Scheduled runs which have not completed when `abortSignal` is aborted
+     *    will reject with an `AbortError`.
+     */
+    constructor(process: () => Promise<void>, idleTimeoutMs: number, throttleMs: number, abortSignal: AbortSignal, requestIdle?: typeof defaultRequestIdle);
+    schedule(): Promise<void>;
+}
+//# sourceMappingURL=process-scheduler.d.ts.map

package/out/replicache/src/process-scheduler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"process-scheduler.d.ts","sourceRoot":"","sources":["../../../../replicache/src/process-scheduler.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,WAAW,IAAI,kBAAkB,EAAC,MAAM,mBAAmB,CAAC;AAEpE,qBAAa,gBAAgB;;IAW3B;;;;;;;;;;;;OAYG;gBAED,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,EAC5B,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAClB,WAAW,EAAE,WAAW,EACxB,WAAW,4BAAqB;IAoBlC,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;CAwC1B"}

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

@@ -0,0 +1,61 @@
+import type { ReadonlyJSONValue } from '../../shared/src/json.js';
+import type { Cookie } from './cookies.js';
+import type { ClientStateNotFoundResponse, VersionNotSupportedResponse } from './error-responses.js';
+import type { HTTPRequestInfo } from './http-request-info.js';
+import type { PatchOperation, PatchOperationInternal } from './patch-operation.js';
+import type { ClientID } from './sync/ids.js';
+import type { PullRequest } from './sync/pull.js';
+export type PullerResultV0 = {
+    response?: PullResponseV0 | undefined;
+    httpRequestInfo: HTTPRequestInfo;
+};
+export type PullerResultV1 = {
+    response?: PullResponseV1 | undefined;
+    httpRequestInfo: HTTPRequestInfo;
+};
+export type PullerResult = PullerResultV1 | PullerResultV0;
+/**
+ * Puller is the function type used to do the fetch part of a pull.
+ *
+ * Puller needs to support dealing with pull request of version 0 and 1. Version
+ * 0 is used when doing mutation recovery of old clients. If a
+ * {@link PullRequestV1} is passed in the n a {@link PullerResultV1} should
+ * be returned. We do a runtime assert to make this is the case.
+ *
+ * If you do not support old clients you can just throw if `pullVersion` is `0`,
+ */
+export type Puller = (requestBody: PullRequest, requestID: string) => Promise<PullerResult>;
+/**
+ * The shape of a pull response under normal circumstances.
+ */
+export type PullResponseOKV0 = {
+    cookie?: ReadonlyJSONValue | undefined;
+    lastMutationID: number;
+    patch: PatchOperation[];
+};
+/**
+ * The shape of a pull response under normal circumstances.
+ */
+export type PullResponseOKV1 = {
+    cookie: Cookie;
+    lastMutationIDChanges: Record<ClientID, number>;
+    patch: PatchOperation[];
+};
+export type PullResponseOKV1Internal = {
+    cookie: Cookie;
+    lastMutationIDChanges: Record<ClientID, number>;
+    patch: PatchOperationInternal[];
+};
+/**
+ * PullResponse defines the shape and type of the response of a pull. This is
+ * the JSON you should return from your pull server endpoint.
+ */
+export type PullResponseV0 = PullResponseOKV0 | ClientStateNotFoundResponse | VersionNotSupportedResponse;
+/**
+ * PullResponse defines the shape and type of the response of a pull. This is
+ * the JSON you should return from your pull server endpoint.
+ */
+export type PullResponseV1 = PullResponseOKV1 | ClientStateNotFoundResponse | VersionNotSupportedResponse;
+export type PullResponseV1Internal = PullResponseOKV1Internal | ClientStateNotFoundResponse | VersionNotSupportedResponse;
+export type PullResponse = PullResponseV1 | PullResponseV0;
+//# sourceMappingURL=puller.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"puller.d.ts","sourceRoot":"","sources":["../../../../replicache/src/puller.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,oBAAoB,CAAC;AAC1D,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,cAAc,CAAC;AACzC,OAAO,KAAK,EACV,2BAA2B,EAC3B,2BAA2B,EAC5B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,wBAAwB,CAAC;AAC5D,OAAO,KAAK,EACV,cAAc,EACd,sBAAsB,EACvB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,eAAe,CAAC;AAC5C,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,gBAAgB,CAAC;AAEhD,MAAM,MAAM,cAAc,GAAG;IAC3B,QAAQ,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;IACtC,eAAe,EAAE,eAAe,CAAC;CAClC,CAAC;AAKF,MAAM,MAAM,cAAc,GAAG;IAC3B,QAAQ,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;IACtC,eAAe,EAAE,eAAe,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,cAAc,GAAG,cAAc,CAAC;AAE3D;;;;;;;;;GASG;AACH,MAAM,MAAM,MAAM,GAAG,CACnB,WAAW,EAAE,WAAW,EACxB,SAAS,EAAE,MAAM,KACd,OAAO,CAAC,YAAY,CAAC,CAAC;AAE3B;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAC;IACvC,cAAc,EAAE,MAAM,CAAC;IACvB,KAAK,EAAE,cAAc,EAAE,CAAC;CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,EAAE,MAAM,CAAC;IAGf,qBAAqB,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAChD,KAAK,EAAE,cAAc,EAAE,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,MAAM,EAAE,MAAM,CAAC;IAGf,qBAAqB,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAChD,KAAK,EAAE,sBAAsB,EAAE,CAAC;CACjC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,cAAc,GACtB,gBAAgB,GAChB,2BAA2B,GAC3B,2BAA2B,CAAC;AAEhC;;;GAGG;AACH,MAAM,MAAM,cAAc,GACtB,gBAAgB,GAChB,2BAA2B,GAC3B,2BAA2B,CAAC;AAEhC,MAAM,MAAM,sBAAsB,GAC9B,wBAAwB,GACxB,2BAA2B,GAC3B,2BAA2B,CAAC;AAEhC,MAAM,MAAM,YAAY,GAAG,cAAc,GAAG,cAAc,CAAC"}

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

@@ -0,0 +1,33 @@
+import { type ClientStateNotFoundResponse, type VersionNotSupportedResponse } from './error-responses.js';
+import { type HTTPRequestInfo } from './http-request-info.js';
+import type { PushRequest } from './sync/push.js';
+export type PusherResult = {
+    response?: PushResponse | undefined;
+    httpRequestInfo: HTTPRequestInfo;
+};
+/**
+ * The response from a push can contain information about error conditions.
+ */
+export type PushResponse = ClientStateNotFoundResponse | VersionNotSupportedResponse;
+export declare function assertPusherResult(v: unknown): asserts v is PusherResult;
+/**
+ * Pusher is the function type used to do the fetch part of a push. The request
+ * is a POST request where the body is JSON with the type {@link PushRequest}.
+ *
+ * The return value should either be a {@link HTTPRequestInfo} or a
+ * {@link PusherResult}. The reason for the two different return types is that
+ * we didn't use to care about the response body of the push request. The
+ * default pusher implementation checks if the response body is JSON and if it
+ * matches the type {@link PusherResponse}. If it does, it is included in the
+ * return value.
+ */
+export type Pusher = (requestBody: PushRequest, requestID: string) => Promise<PusherResult>;
+/**
+ * This error is thrown when the pusher fails for any reason.
+ */
+export declare class PushError extends Error {
+    name: string;
+    causedBy?: Error | undefined;
+    constructor(causedBy?: Error);
+}
+//# sourceMappingURL=pusher.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pusher.d.ts","sourceRoot":"","sources":["../../../../replicache/src/pusher.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,KAAK,2BAA2B,EAEhC,KAAK,2BAA2B,EACjC,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAEL,KAAK,eAAe,EACrB,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,gBAAgB,CAAC;AAEhD,MAAM,MAAM,YAAY,GAAG;IACzB,QAAQ,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IACpC,eAAe,EAAE,eAAe,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,YAAY,GACpB,2BAA2B,GAC3B,2BAA2B,CAAC;AAEhC,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,CAAC,IAAI,YAAY,CAMxE;AASD;;;;;;;;;;GAUG;AACH,MAAM,MAAM,MAAM,GAAG,CACnB,WAAW,EAAE,WAAW,EACxB,SAAS,EAAE,MAAM,KACd,OAAO,CAAC,YAAY,CAAC,CAAC;AAE3B;;GAEG;AACH,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/replicache-impl.d.ts

@@ -0,0 +1,321 @@
+import { LogContext } from '@rocicorp/logger';
+import type { MaybePromise } from '../../shared/src/types.js';
+import { type Cookie } from './cookies.js';
+import { LazyStore } from './dag/lazy-store.js';
+import { type Store } from './dag/store.js';
+import { type Hash } from './hash.js';
+import { type PendingMutation } from './pending-mutations.js';
+import { type ClientMap } from './persist/clients.js';
+import type { Puller } from './puller.js';
+import { type Pusher } from './pusher.js';
+import type { ReplicacheOptions } from './replicache-options.js';
+import { type SubscribeOptions, type SubscriptionsManager, type WatchCallbackForOptions, type WatchNoIndexCallback, type WatchOptions } from './subscriptions.js';
+import type { ReadTransaction } from './transactions.js';
+import type { BeginPullResult, MakeMutators, MutatorDefs, PokeInternal, QueryInternal, RequestOptions, UpdateNeededReason } from './types.js';
+/** @deprecated Not used any more */
+export interface MakeSubscriptionsManager {
+    (queryInternal: QueryInternal, lc: LogContext): SubscriptionsManager;
+}
+export interface ReplicacheImplOptions {
+    /**
+     * Defaults to true.
+     */
+    enableMutationRecovery?: boolean | undefined;
+    /**
+     * Defaults to true.
+     */
+    enableScheduledPersist?: boolean | undefined;
+    /**
+     * Defaults to true.
+     */
+    enableScheduledRefresh?: boolean | undefined;
+    /**
+     * Defaults to true.
+     */
+    enablePullAndPushInOpen?: boolean | undefined;
+    /**
+     * @deprecated Not used anymore.
+     */
+    makeSubscriptionsManager?: unknown;
+    /**
+     * Default is `true`.  If `false` if an exact match client group
+     * is not found, a new client group is always made instead of forking
+     * from an existing client group.
+     */
+    enableClientGroupForking?: boolean | undefined;
+}
+export declare class ReplicacheImpl<MD extends MutatorDefs = {}> {
+    #private;
+    /** The URL to use when doing a pull request. */
+    pullURL: string;
+    /** The URL to use when doing a push request. */
+    pushURL: string;
+    /** The authorization token used when doing a push request. */
+    auth: string;
+    /** The name of the Replicache database. Populated by {@link ReplicacheOptions#name}. */
+    readonly name: string;
+    readonly subscriptions: SubscriptionsManager;
+    /**
+     * Client groups gets disabled when the server does not know about it.
+     * A disabled client group prevents the client from pushing and pulling.
+     */
+    isClientGroupDisabled: boolean;
+    lastMutationID: number;
+    /**
+     * This is the name Replicache uses for the IndexedDB database where data is
+     * stored.
+     */
+    get idbName(): string;
+    /** The schema version of the data understood by this application. */
+    readonly schemaVersion: string;
+    /**
+     * The mutators that was registered in the constructor.
+     */
+    readonly mutate: MakeMutators<MD>;
+    /**
+     * The duration between each periodic {@link pull}. Setting this to `null`
+     * disables periodic pull completely. Pull will still happen if you call
+     * {@link pull} manually.
+     */
+    pullInterval: number | null;
+    /**
+     * The delay between when a change is made to Replicache and when Replicache
+     * attempts to push that change.
+     */
+    pushDelay: number;
+    /**
+     * The function to use to pull data from the server.
+     */
+    puller: Puller;
+    /**
+     * The function to use to push data to the server.
+     */
+    pusher: Pusher;
+    readonly memdag: LazyStore;
+    readonly perdag: Store;
+    /**
+     * The options used to control the {@link pull} and push request behavior. This
+     * object is live so changes to it will affect the next pull or push call.
+     */
+    get requestOptions(): Required<RequestOptions>;
+    /**
+     * `onSync(true)` is called when Replicache transitions from no push or pull
+     * happening to at least one happening. `onSync(false)` is called in the
+     * opposite case: when Replicache transitions from at least one push or pull
+     * happening to none happening.
+     *
+     * This can be used in a React like app by doing something like the following:
+     *
+     * ```js
+     * const [syncing, setSyncing] = useState(false);
+     * useEffect(() => {
+     *   rep.onSync = setSyncing;
+     * }, [rep]);
+     * ```
+     */
+    onSync: ((syncing: boolean) => void) | null;
+    /**
+     * `onClientStateNotFound` is called when the persistent client has been
+     * garbage collected. This can happen if the client has no pending mutations
+     * and has not been used for a while.
+     *
+     * The default behavior is to reload the page (using `location.reload()`). Set
+     * this to `null` or provide your own function to prevent the page from
+     * reloading automatically.
+     */
+    onClientStateNotFound: (() => void) | null;
+    /**
+     * `onUpdateNeeded` is called when a code update is needed.
+     *
+     * A code update can be needed because:
+     * - the server no longer supports the {@link pushVersion},
+     *   {@link pullVersion} or {@link schemaVersion} of the current code.
+     * - a new Replicache client has created a new client group, because its code
+     *   has different mutators, indexes, schema version and/or format version
+     *   from this Replicache client. This is likely due to the new client having
+     *   newer code. A code update is needed to be able to locally sync with this
+     *   new Replicache client (i.e. to sync while offline, the clients can still
+     *   sync with each other via the server).
+     *
+     * The default behavior is to reload the page (using `location.reload()`). Set
+     * this to `null` or provide your own function to prevent the page from
+     * reloading automatically. You may want to provide your own function to
+     * display a toast to inform the end user there is a new version of your app
+     * available and prompting them to refresh.
+     */
+    onUpdateNeeded: ((reason: UpdateNeededReason) => void) | null;
+    /**
+     * This gets called when we get an HTTP unauthorized (401) response from the
+     * push or pull endpoint. Set this to a function that will ask your user to
+     * reauthenticate.
+     */
+    getAuth: (() => MaybePromise<string | null | undefined>) | null | undefined;
+    onPushInvoked: () => undefined;
+    onBeginPull: () => undefined;
+    onRecoverMutations: (r: Promise<boolean>) => Promise<boolean>;
+    constructor(options: ReplicacheOptions<MD>, implOptions?: ReplicacheImplOptions);
+    /**
+     * The browser profile ID for this browser profile. Every instance of Replicache
+     * browser-profile-wide shares the same profile ID.
+     */
+    get profileID(): Promise<string>;
+    /**
+     * The client ID for this instance of Replicache. Each instance of Replicache
+     * gets a unique client ID.
+     */
+    get clientID(): string;
+    /**
+     * The client group ID for this instance of Replicache. Instances of
+     * Replicache will have the same client group ID if and only if they have
+     * the same name, mutators, indexes, schema version, format version, and
+     * browser profile.
+     */
+    get clientGroupID(): Promise<string>;
+    /**
+     * `onOnlineChange` is called when the {@link online} property changes. See
+     * {@link online} for more details.
+     */
+    onOnlineChange: ((online: boolean) => void) | null;
+    /**
+     * A rough heuristic for whether the client is currently online. Note that
+     * there is no way to know for certain whether a client is online - the next
+     * request can always fail. This property returns true if the last sync attempt succeeded,
+     * and false otherwise.
+     */
+    get online(): boolean;
+    /**
+     * Whether the Replicache database has been closed. Once Replicache has been
+     * closed it no longer syncs and you can no longer read or write data out of
+     * it. After it has been closed it is pretty much useless and should not be
+     * used any more.
+     */
+    get closed(): boolean;
+    /**
+     * Closes this Replicache instance.
+     *
+     * When closed all subscriptions end and no more read or writes are allowed.
+     */
+    close(): Promise<void>;
+    maybeEndPull(syncHead: Hash, requestID: string): Promise<void>;
+    /**
+     * Push pushes pending changes to the {@link pushURL}.
+     *
+     * You do not usually need to manually call push. If {@link pushDelay} is
+     * non-zero (which it is by default) pushes happen automatically shortly after
+     * mutations.
+     *
+     * If the server endpoint fails push will be continuously retried with an
+     * exponential backoff.
+     *
+     * @param [now=false] If true, push will happen immediately and ignore
+     *   {@link pushDelay}, {@link RequestOptions.minDelayMs} as well as the
+     *   exponential backoff in case of errors.
+     * @returns A promise that resolves when the next push completes. In case of
+     * errors the first error will reject the returned promise. Subsequent errors
+     * will not be reflected in the promise.
+     */
+    push({ now }?: {
+        now?: boolean | undefined;
+    }): Promise<void>;
+    /**
+     * Pull pulls changes from the {@link pullURL}. If there are any changes local
+     * changes will get replayed on top of the new server state.
+     *
+     * If the server endpoint fails pull will be continuously retried with an
+     * exponential backoff.
+     *
+     * @param [now=false] If true, pull will happen immediately and ignore
+     *   {@link RequestOptions.minDelayMs} as well as the exponential backoff in
+     *   case of errors.
+     * @returns A promise that resolves when the next pull completes. In case of
+     * errors the first error will reject the returned promise. Subsequent errors
+     * will not be reflected in the promise.
+     */
+    pull({ now }?: {
+        now?: boolean | undefined;
+    }): Promise<void>;
+    /**
+     * Applies an update from the server to Replicache.
+     * Throws an error if cookie does not match. In that case the server thinks
+     * this client has a different cookie than it does; the caller should disconnect
+     * from the server and re-register, which transmits the cookie the client actually
+     * has.
+     *
+     * @experimental This method is under development and its semantics will change.
+     */
+    poke(poke: PokeInternal): Promise<void>;
+    beginPull(): Promise<BeginPullResult>;
+    persist(): Promise<void>;
+    refresh(): Promise<void>;
+    disableClientGroup(): Promise<void>;
+    /**
+     * Subscribe to the result of a {@link query}. The `body` function is
+     * evaluated once and its results are returned via `onData`.
+     *
+     * Thereafter, each time the the result of `body` changes, `onData` is fired
+     * again with the new result.
+     *
+     * `subscribe()` goes to significant effort to avoid extraneous work
+     * re-evaluating subscriptions:
+     *
+     * 1. subscribe tracks the keys that `body` accesses each time it runs. `body`
+     *    is only re-evaluated when those keys change.
+     * 2. subscribe only re-fires `onData` in the case that a result changes by
+     *    way of the `isEqual` option which defaults to doing a deep JSON value
+     *    equality check.
+     *
+     * Because of (1), `body` must be a pure function of the data in Replicache.
+     * `body` must not access anything other than the `tx` parameter passed to it.
+     *
+     * Although subscribe is as efficient as it can be, it is somewhat constrained
+     * by the goal of returning an arbitrary computation of the cache. For even
+     * better performance (but worse dx), see {@link experimentalWatch}.
+     *
+     * If an error occurs in the `body` the `onError` function is called if
+     * present. Otherwise, the error is logged at log level 'error'.
+     *
+     * To cancel the subscription, call the returned function.
+     *
+     * @param body The function to evaluate to get the value to pass into
+     *    `onData`.
+     * @param options Options is either a function or an object. If it is a
+     *    function it is equivalent to passing it as the `onData` property of an
+     *    object.
+     */
+    subscribe<R>(body: (tx: ReadTransaction) => Promise<R>, options: SubscribeOptions<R> | ((result: R) => void)): () => void;
+    /**
+     * Watches Replicache for changes.
+     *
+     * The `callback` gets called whenever the underlying data changes and the
+     * `key` changes matches the `prefix` of {@link ExperimentalWatchIndexOptions} or
+     * {@link ExperimentalWatchNoIndexOptions} if present. If a change
+     * occurs to the data but the change does not impact the key space the
+     * callback is not called. In other words, the callback is never called with
+     * an empty diff.
+     *
+     * This gets called after commit (a mutation or a rebase).
+     *
+     * @experimental This method is under development and its semantics will
+     * change.
+     */
+    experimentalWatch(callback: WatchNoIndexCallback): () => void;
+    experimentalWatch<Options extends WatchOptions>(callback: WatchCallbackForOptions<Options>, options?: Options): () => void;
+    /**
+     * Query is used for read transactions. It is recommended to use transactions
+     * to ensure you get a consistent view across multiple calls to `get`, `has`
+     * and `scan`.
+     */
+    query<R>(body: (tx: ReadTransaction) => Promise<R> | R): Promise<R>;
+    get cookie(): Promise<Cookie>;
+    recoverMutations(preReadClientMap?: ClientMap): Promise<boolean>;
+    /**
+     * List of pending mutations. The order of this is from oldest to newest.
+     *
+     * Gives a list of local mutations that have `mutationID` >
+     * `syncHead.mutationID` that exists on the main client group.
+     *
+     * @experimental This method is experimental and may change in the future.
+     */
+    experimentalPendingMutations(): Promise<readonly PendingMutation[]>;
+}
+//# sourceMappingURL=replicache-impl.d.ts.map

package/out/replicache/src/replicache-impl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"replicache-impl.d.ts","sourceRoot":"","sources":["../../../../replicache/src/replicache-impl.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,UAAU,EAAC,MAAM,kBAAkB,CAAC;AAO5D,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,qBAAqB,CAAC;AAGtD,OAAO,EAAe,KAAK,MAAM,EAAC,MAAM,cAAc,CAAC;AACvD,OAAO,EAAC,SAAS,EAAC,MAAM,qBAAqB,CAAC;AAE9C,OAAO,EAAsC,KAAK,KAAK,EAAC,MAAM,gBAAgB,CAAC;AAmB/E,OAAO,EAAwB,KAAK,IAAI,EAAgB,MAAM,WAAW,CAAC;AAY1E,OAAO,EACL,KAAK,eAAe,EAErB,MAAM,wBAAwB,CAAC;AAQhC,OAAO,EACL,KAAK,SAAS,EAIf,MAAM,sBAAsB,CAAC;AAgB9B,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,aAAa,CAAC;AACxC,OAAO,EAAC,KAAK,MAAM,EAAY,MAAM,aAAa,CAAC;AACnD,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,yBAAyB,CAAC;AAQ/D,OAAO,EACL,KAAK,gBAAgB,EAErB,KAAK,oBAAoB,EAGzB,KAAK,uBAAuB,EAC5B,KAAK,oBAAoB,EACzB,KAAK,YAAY,EAElB,MAAM,oBAAoB,CAAC;AAS5B,OAAO,KAAK,EAAC,eAAe,EAAmB,MAAM,mBAAmB,CAAC;AAEzE,OAAO,KAAK,EACV,eAAe,EAEf,YAAY,EACZ,WAAW,EAEX,YAAY,EACZ,aAAa,EACb,cAAc,EACd,kBAAkB,EACnB,MAAM,YAAY,CAAC;AAkCpB,oCAAoC;AACpC,MAAM,WAAW,wBAAwB;IACvC,CAAC,aAAa,EAAE,aAAa,EAAE,EAAE,EAAE,UAAU,GAAG,oBAAoB,CAAC;CACtE;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,sBAAsB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAE7C;;OAEG;IACH,sBAAsB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAE7C;;OAEG;IACH,sBAAsB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAE7C;;OAEG;IACH,uBAAuB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAE9C;;OAEG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAChD;AAGD,qBAAa,cAAc,CAAC,EAAE,SAAS,WAAW,GAAG,EAAE;;IACrD,gDAAgD;IAChD,OAAO,EAAE,MAAM,CAAC;IAEhB,gDAAgD;IAChD,OAAO,EAAE,MAAM,CAAC;IAEhB,8DAA8D;IAC9D,IAAI,EAAE,MAAM,CAAC;IAEb,wFAAwF;IACxF,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB,QAAQ,CAAC,aAAa,EAAE,oBAAoB,CAAC;IAG7C;;;OAGG;IACH,qBAAqB,UAAS;IAI9B,cAAc,EAAE,MAAM,CAAK;IAE3B;;;OAGG;IACH,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED,qEAAqE;IACrE,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAkB/B;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC,EAAE,CAAC,CAAC;IASlC;;;;OAIG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAIlB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC;IAC3B,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC;IAwBvB;;;OAGG;IACH,IAAI,cAAc,IAAI,QAAQ,CAAC,cAAc,CAAC,CAE7C;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC,GAAG,IAAI,CAAQ;IAEnD;;;;;;;;OAQG;IACH,qBAAqB,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,IAAI,CAAU;IAEpD;;;;;;;;;;;;;;;;;;OAkBG;IACH,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,kBAAkB,KAAK,IAAI,CAAC,GAAG,IAAI,CAAU;IAEvE;;;;OAIG;IACH,OAAO,EAAE,CAAC,MAAM,YAAY,CAAC,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC,CAAC,GAAG,IAAI,GAAG,SAAS,CACpE;IAGP,aAAa,kBAAmB;IAChC,WAAW,kBAAmB;IAC9B,kBAAkB,MAAO,OAAO,CAAC,OAAO,CAAC,sBAAO;gBAG9C,OAAO,EAAE,iBAAiB,CAAC,EAAE,CAAC,EAC9B,WAAW,GAAE,qBAA0B;IAqPzC;;;OAGG;IACH,IAAI,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC,CAE/B;IAED;;;OAGG;IACH,IAAI,QAAQ,IAAI,MAAM,CAErB;IAED;;;;;OAKG;IACH,IAAI,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC,CAEnC;IAED;;;OAGG;IACH,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC,GAAG,IAAI,CAAQ;IAE1D;;;;;OAKG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED;;;;;OAKG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED;;;;OAIG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IA6BtB,YAAY,CAAC,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAmRpE;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CAAC,EAAC,GAAW,EAAC;;KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvC;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,EAAC,GAAW,EAAC;;KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvC;;;;;;;;OAQG;IACG,IAAI,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAgDvC,SAAS,IAAI,OAAO,CAAC,eAAe,CAAC;IA6CrC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAsCxB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAkDxB,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC;IA+DzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,SAAS,CAAC,CAAC,EACT,IAAI,EAAE,CAAC,EAAE,EAAE,eAAe,KAAK,OAAO,CAAC,CAAC,CAAC,EACzC,OAAO,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,IAAI,CAAC,GACnD,MAAM,IAAI;IAWb;;;;;;;;;;;;;;OAcG;IACH,iBAAiB,CAAC,QAAQ,EAAE,oBAAoB,GAAG,MAAM,IAAI;IAC7D,iBAAiB,CAAC,OAAO,SAAS,YAAY,EAC5C,QAAQ,EAAE,uBAAuB,CAAC,OAAO,CAAC,EAC1C,OAAO,CAAC,EAAE,OAAO,GAChB,MAAM,IAAI;IAUb;;;;OAIG;IACH,KAAK,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,eAAe,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAInE,IAAI,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,CAc5B;IA4HD,gBAAgB,CAAC,gBAAgB,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC;IAehE;;;;;;;OAOG;IACH,4BAA4B,IAAI,OAAO,CAAC,SAAS,eAAe,EAAE,CAAC;CAGpE"}