@rocicorp/zero 0.23.2025082700 → 0.23.2025082901

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

@@ -1,298 +0,0 @@
-import type { LogContext } from '@rocicorp/logger';
-import type { MaybePromise } from '../../shared/src/types.ts';
-import type { StoreProvider } from './kv/store.ts';
-import type { PendingMutation } from './pending-mutations.ts';
-import type { Puller } from './puller.ts';
-import type { Pusher } from './pusher.ts';
-import { ReplicacheImpl } from './replicache-impl.ts';
-import type { ReplicacheOptions } from './replicache-options.ts';
-import type { SubscribeOptions, WatchCallbackForOptions, WatchNoIndexCallback, WatchOptions } from './subscriptions.ts';
-import type { ReadTransaction } from './transactions.ts';
-import type { MakeMutators, MutatorDefs, Poke, RequestOptions, UpdateNeededReason } from './types.ts';
-type MakeImpl = <MD extends MutatorDefs>(options: ReplicacheOptions<MD>) => ReplicacheImpl<MD>;
-export declare function setMakeImplForTest(testMakeImpl: MakeImpl): void;
-export declare function restoreMakeImplForTest(): void;
-export declare const httpStatusUnauthorized = 401;
-/**
- * Returns the name of the IDB database that will be used for a particular Replicache instance.
- * @param name The name of the Replicache instance (i.e., the `name` field of `ReplicacheOptions`).
- * @param schemaVersion The schema version of the database (i.e., the `schemaVersion` field of `ReplicacheOptions`).
- * @returns
- */
-export declare function makeIDBName(name: string, schemaVersion?: string): string;
-declare function makeIDBNameInternal(name: string, schemaVersion: string | undefined, formatVersion: number): string;
-export { makeIDBNameInternal as makeIDBNameForTesting };
-export declare class Replicache<MD extends MutatorDefs = {}> {
-    #private;
-    constructor(options: ReplicacheOptions<MD>);
-    /** The URL to use when doing a pull request. */
-    get pullURL(): string;
-    set pullURL(value: string);
-    /** The URL to use when doing a push request. */
-    get pushURL(): string;
-    set pushURL(value: string);
-    /** The authorization token used when doing a push request. */
-    get auth(): string;
-    set auth(value: string);
-    /** The name of the Replicache database. Populated by {@link ReplicacheOptions#name}. */
-    get name(): string;
-    /**
-     * 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. */
-    get schemaVersion(): string;
-    /**
-     * The mutators that was registered in the constructor.
-     */
-    get 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.
-     */
-    get pullInterval(): number | null;
-    set pullInterval(value: number | null);
-    /**
-     * The delay between when a change is made to Replicache and when Replicache
-     * attempts to push that change.
-     */
-    get pushDelay(): number;
-    set pushDelay(value: number);
-    /**
-     * The function to use to pull data from the server.
-     */
-    get puller(): Puller;
-    set puller(value: Puller);
-    /**
-     * The function to use to push data to the server.
-     */
-    get pusher(): Pusher;
-    set pusher(value: Pusher);
-    /**
-     * 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]);
-     * ```
-     */
-    get onSync(): ((syncing: boolean) => void) | null;
-    set onSync(value: ((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.
-     */
-    get onClientStateNotFound(): (() => void) | null;
-    set onClientStateNotFound(value: (() => 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 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.
-     */
-    get onUpdateNeeded(): ((reason: UpdateNeededReason) => void) | null;
-    set onUpdateNeeded(value: ((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.
-     */
-    get getAuth(): (() => MaybePromise<string | null | undefined>) | null | undefined;
-    set getAuth(value: (() => MaybePromise<string | null | undefined>) | null | undefined);
-    /**
-     * 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.
-     */
-    get onOnlineChange(): ((online: boolean) => void) | null;
-    set onOnlineChange(value: ((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>;
-    /**
-     * 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: Poke): 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>;
-    /**
-     * 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[]>;
-}
-/**
- * Wrapper error class that should be reported as error (logger.error)
- */
-export declare class ReportError extends Error {
-}
-export declare function getKVStoreProvider(lc: LogContext, kvStore: 'mem' | 'idb' | StoreProvider | undefined): StoreProvider;
-//# sourceMappingURL=replicache.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"replicache.d.ts","sourceRoot":"","sources":["../../../../replicache/src/replicache.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,kBAAkB,CAAC;AACjD,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,2BAA2B,CAAC;AAO5D,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,wBAAwB,CAAC;AAC5D,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,aAAa,CAAC;AACxC,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,aAAa,CAAC;AACxC,OAAO,EAAC,cAAc,EAAC,MAAM,sBAAsB,CAAC;AACpD,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,yBAAyB,CAAC;AAC/D,OAAO,KAAK,EACV,gBAAgB,EAChB,uBAAuB,EACvB,oBAAoB,EACpB,YAAY,EACb,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,mBAAmB,CAAC;AACvD,OAAO,KAAK,EACV,YAAY,EACZ,WAAW,EACX,IAAI,EACJ,cAAc,EACd,kBAAkB,EACnB,MAAM,YAAY,CAAC;AAEpB,KAAK,QAAQ,GAAG,CAAC,EAAE,SAAS,WAAW,EACrC,OAAO,EAAE,iBAAiB,CAAC,EAAE,CAAC,KAC3B,cAAc,CAAC,EAAE,CAAC,CAAC;AAOxB,wBAAgB,kBAAkB,CAAC,YAAY,EAAE,QAAQ,QAExD;AAED,wBAAgB,sBAAsB,SAErC;AAED,eAAO,MAAM,sBAAsB,MAAM,CAAC;AAE1C;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,CAExE;AAED,iBAAS,mBAAmB,CAC1B,IAAI,EAAE,MAAM,EACZ,aAAa,EAAE,MAAM,GAAG,SAAS,EACjC,aAAa,EAAE,MAAM,GACpB,MAAM,CAGR;AAED,OAAO,EAAC,mBAAmB,IAAI,qBAAqB,EAAC,CAAC;AAGtD,qBAAa,UAAU,CAAC,EAAE,SAAS,WAAW,GAAG,EAAE;;gBAGrC,OAAO,EAAE,iBAAiB,CAAC,EAAE,CAAC;IAI1C,gDAAgD;IAChD,IAAI,OAAO,IAAI,MAAM,CAEpB;IACD,IAAI,OAAO,CAAC,KAAK,EAAE,MAAM,EAExB;IAED,gDAAgD;IAChD,IAAI,OAAO,IAAI,MAAM,CAEpB;IACD,IAAI,OAAO,CAAC,KAAK,EAAE,MAAM,EAExB;IAED,8DAA8D;IAC9D,IAAI,IAAI,IAAI,MAAM,CAEjB;IACD,IAAI,IAAI,CAAC,KAAK,EAAE,MAAM,EAErB;IAED,wFAAwF;IACxF,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;;OAGG;IACH,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED,qEAAqE;IACrE,IAAI,aAAa,IAAI,MAAM,CAE1B;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,YAAY,CAAC,EAAE,CAAC,CAE7B;IAED;;;;OAIG;IACH,IAAI,YAAY,IAAI,MAAM,GAAG,IAAI,CAEhC;IACD,IAAI,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,EAEpC;IAED;;;OAGG;IACH,IAAI,SAAS,IAAI,MAAM,CAEtB;IACD,IAAI,SAAS,CAAC,KAAK,EAAE,MAAM,EAE1B;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,MAAM,CAEnB;IACD,IAAI,MAAM,CAAC,KAAK,EAAE,MAAM,EAEvB;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,MAAM,CAEnB;IACD,IAAI,MAAM,CAAC,KAAK,EAAE,MAAM,EAEvB;IAED;;;OAGG;IACH,IAAI,cAAc,IAAI,QAAQ,CAAC,cAAc,CAAC,CAE7C;IAED;;;;;;;;;;;;;;OAcG;IACH,IAAI,MAAM,IAAI,CAAC,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC,GAAG,IAAI,CAEhD;IACD,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC,GAAG,IAAI,EAEpD;IAED;;;;;;;;OAQG;IACH,IAAI,qBAAqB,IAAI,CAAC,MAAM,IAAI,CAAC,GAAG,IAAI,CAE/C;IACD,IAAI,qBAAqB,CAAC,KAAK,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,IAAI,EAEnD;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,cAAc,IAAI,CAAC,CAAC,MAAM,EAAE,kBAAkB,KAAK,IAAI,CAAC,GAAG,IAAI,CAElE;IACD,IAAI,cAAc,CAAC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,kBAAkB,KAAK,IAAI,CAAC,GAAG,IAAI,EAEtE;IAED;;;;OAIG;IACH,IAAI,OAAO,IACP,CAAC,MAAM,YAAY,CAAC,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC,CAAC,GAC/C,IAAI,GACJ,SAAS,CAEZ;IACD,IAAI,OAAO,CACT,KAAK,EAAE,CAAC,MAAM,YAAY,CAAC,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC,CAAC,GAAG,IAAI,GAAG,SAAS,EAG1E;IAED;;;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,IAAI,cAAc,IAAI,CAAC,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC,GAAG,IAAI,CAEvD;IACD,IAAI,cAAc,CAAC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC,GAAG,IAAI,EAE3D;IAED;;;;;OAKG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED;;;;;OAKG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED;;;;OAIG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAItB;;;;;;;;;;;;;;;;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;IACH,IAAI,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAI/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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;IAIb;;;;;;;;;;;;;;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;IAQb;;;;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;;;;;;;OAOG;IACH,4BAA4B,IAAI,OAAO,CAAC,SAAS,eAAe,EAAE,CAAC;CAGpE;AAED;;GAEG;AACH,qBAAa,WAAY,SAAQ,KAAK;CAAG;AAMzC,wBAAgB,kBAAkB,CAChC,EAAE,EAAE,UAAU,EACd,OAAO,EAAE,KAAK,GAAG,KAAK,GAAG,aAAa,GAAG,SAAS,GACjD,aAAa,CAgBf"}

package/out/zero-react-native/src/store.d.ts

@@ -1,4 +0,0 @@
-import { type SQLiteDatabaseManagerOptions } from '../../replicache/src/kv/sqlite-store.ts';
-import type { StoreProvider } from '../../replicache/src/kv/store.ts';
-export declare const expoSQLiteStoreProvider: (opts?: Partial<Omit<SQLiteDatabaseManagerOptions, "journalMode">>) => StoreProvider;
-//# sourceMappingURL=store.d.ts.map

package/out/zero-react-native/src/store.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../../../../zero-react-native/src/store.ts"],"names":[],"mappings":"AAKA,OAAO,EAIL,KAAK,4BAA4B,EAClC,MAAM,yCAAyC,CAAC;AACjD,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,kCAAkC,CAAC;AAgCpE,eAAO,MAAM,uBAAuB,GAClC,OAAO,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE,aAAa,CAAC,CAAC,KAChE,aAkBD,CAAC"}