@voidhash/mimic 0.0.1 → 0.0.3

package/dist/client/ClientDocument.d.cts

@@ -0,0 +1,161 @@
+import { AnyPresence, Infer, PresenceEntry } from "../Presence.cjs";
+import { Transaction } from "../Transaction.cjs";
+import { AnyPrimitive, InferProxy, InferState } from "../primitives/shared.cjs";
+import { Transport } from "./Transport.cjs";
+
+//#region src/client/ClientDocument.d.ts
+declare namespace ClientDocument_d_exports {
+  export { ClientDocument, ClientDocumentListener, ClientDocumentOptions, ClientPresence, PresenceListener, make };
+}
+/**
+ * Listener for presence changes.
+ */
+interface PresenceListener<_TData> {
+  /** Called when any presence changes (self or others) */
+  readonly onPresenceChange?: () => void;
+}
+/**
+ * Presence API exposed on the ClientDocument.
+ */
+interface ClientPresence<TData> {
+  /**
+   * Returns this client's connection ID (set after receiving presence_snapshot).
+   * Returns undefined before the snapshot is received.
+   */
+  readonly selfId: () => string | undefined;
+  /**
+   * Returns this client's current presence data.
+   * Returns undefined if not set.
+   */
+  readonly self: () => TData | undefined;
+  /**
+   * Returns a map of other clients' presence data.
+   * Keys are connection IDs.
+   */
+  readonly others: () => ReadonlyMap<string, PresenceEntry<TData>>;
+  /**
+   * Returns all presence entries including self.
+   */
+  readonly all: () => ReadonlyMap<string, PresenceEntry<TData>>;
+  /**
+   * Sets this client's presence data.
+   * Validates against the presence schema before sending.
+   * @throws ParseError if validation fails
+   */
+  readonly set: (data: TData) => void;
+  /**
+   * Clears this client's presence data.
+   */
+  readonly clear: () => void;
+  /**
+   * Subscribes to presence changes.
+   * @returns Unsubscribe function
+   */
+  readonly subscribe: (listener: PresenceListener<TData>) => () => void;
+}
+/**
+ * Options for creating a ClientDocument.
+ */
+interface ClientDocumentOptions<TSchema extends AnyPrimitive, TPresence extends AnyPresence | undefined = undefined> {
+  /** The schema defining the document structure */
+  readonly schema: TSchema;
+  /** Transport for server communication */
+  readonly transport: Transport;
+  /** Initial state (optional, will sync from server if not provided) */
+  readonly initialState?: InferState<TSchema>;
+  /** Initial server version (optional) */
+  readonly initialVersion?: number;
+  /** Called when server rejects a transaction */
+  readonly onRejection?: (transaction: Transaction, reason: string) => void;
+  /** Called when optimistic state changes */
+  readonly onStateChange?: (state: InferState<TSchema> | undefined) => void;
+  /** Called when connection status changes */
+  readonly onConnectionChange?: (connected: boolean) => void;
+  /** Called when client is fully initialized and ready */
+  readonly onReady?: () => void;
+  /** Timeout in ms for pending transactions (default: 30000) */
+  readonly transactionTimeout?: number;
+  /** Timeout in ms for initialization (default: 10000) */
+  readonly initTimeout?: number;
+  /** Enable debug logging for all activity (default: false) */
+  readonly debug?: boolean;
+  /**
+   * Optional presence schema for ephemeral per-user data.
+   * When provided, enables the presence API on the ClientDocument.
+   */
+  readonly presence?: TPresence;
+  /** Initial presence data, that will be set on the ClientDocument when it is created */
+  readonly initialPresence?: TPresence extends AnyPresence ? Infer<TPresence> : undefined;
+}
+/**
+ * Listener callbacks for subscribing to ClientDocument events.
+ */
+interface ClientDocumentListener<TSchema extends AnyPrimitive> {
+  /** Called when optimistic state changes */
+  readonly onStateChange?: (state: InferState<TSchema> | undefined) => void;
+  /** Called when connection status changes */
+  readonly onConnectionChange?: (connected: boolean) => void;
+  /** Called when client is fully initialized and ready */
+  readonly onReady?: () => void;
+}
+/**
+ * A ClientDocument provides optimistic updates with server synchronization.
+ */
+interface ClientDocument<TSchema extends AnyPrimitive, TPresence extends AnyPresence | undefined = undefined> {
+  /** The schema defining this document's structure */
+  readonly schema: TSchema;
+  /** Root proxy for accessing and modifying document data (optimistic) */
+  readonly root: InferProxy<TSchema>;
+  /** Returns the current optimistic state (server + pending) */
+  get(): InferState<TSchema> | undefined;
+  /** Returns the confirmed server state */
+  getServerState(): InferState<TSchema> | undefined;
+  /** Returns the current server version */
+  getServerVersion(): number;
+  /** Returns pending transactions count */
+  getPendingCount(): number;
+  /** Returns whether there are pending transactions */
+  hasPendingChanges(): boolean;
+  /**
+   * Runs a function within a transaction.
+   * Changes are applied optimistically and sent to the server.
+   */
+  transaction<R>(fn: (root: InferProxy<TSchema>) => R): R;
+  /**
+   * Connects to the server and starts syncing.
+   */
+  connect(): Promise<void>;
+  /**
+   * Disconnects from the server.
+   */
+  disconnect(): void;
+  /**
+   * Returns whether currently connected to the server.
+   */
+  isConnected(): boolean;
+  /**
+   * Forces a full resync from the server.
+   */
+  resync(): void;
+  /**
+   * Returns whether the client is fully initialized and ready.
+   */
+  isReady(): boolean;
+  /**
+   * Subscribes to document events (state changes, connection changes, ready).
+   * @returns Unsubscribe function
+   */
+  subscribe(listener: ClientDocumentListener<TSchema>): () => void;
+  /**
+   * Presence API for ephemeral per-user data.
+   * Only available when presence schema is provided in options.
+   */
+  readonly presence: TPresence extends AnyPresence ? ClientPresence<Infer<TPresence>> : undefined;
+}
+/**
+ * Creates a new ClientDocument for the given schema.
+ */
+declare const make: <TSchema extends AnyPrimitive, TPresence extends AnyPresence | undefined = undefined>(options: ClientDocumentOptions<TSchema, TPresence>) => ClientDocument<TSchema, TPresence>;
+//#endregion
+export { ClientDocument_d_exports };
+//# sourceMappingURL=ClientDocument.d.cts.map

package/dist/client/ClientDocument.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ClientDocument.d.cts","names":[],"sources":["../../src/client/ClientDocument.ts"],"sourcesContent":[],"mappings":";;;;;;;;;;;;UA6CiB;;;;;;;UAQA;EARA;AAQjB;;;EAiB6C,SAAA,MAAA,EAAA,GAAA,GAAA,MAAA,GAAA,SAAA;EAApB;;;;EAYF,SAAA,IAAA,EAAA,GAAA,GAlBA,KAkBA,GAAA,SAAA;EAW2B;;;AAMlD;EACkB,SAAA,MAAA,EAAA,GAAA,GA9BO,WA8BP,CAAA,MAAA,EA9B2B,aA8B3B,CA9BkD,KA8BlD,CAAA,CAAA;EACE;;;EAO2B,SAAA,GAAA,EAAA,GAAA,GAjCzB,WAiCyB,CAAA,MAAA,EAjCL,aAiCK,CAjCkB,KAiClB,CAAA,CAAA;EAArB;;;;;EA0BG,SAAA,GAAA,EAAA,CAAA,IAAA,EApDN,KAoDM,EAAA,GAAA,IAAA;EAAkB;;;EAAqC,SAAA,KAAA,EAAA,GAAA,GAAA,IAAA;EAMnE;;;;EAEsC,SAAA,SAAA,EAAA,CAAA,QAAA,EAjDtB,gBAiDsB,CAjDL,KAiDK,CAAA,EAAA,GAAA,GAAA,GAAA,IAAA;AAUvD;;;;AAQsC,UA7DrB,qBA6DqB,CAAA,gBA5DpB,YA4DoB,EAAA,kBA3DlB,WA2DkB,GAAA,SAAA,GAAA,SAAA,CAAA,CAAA;EAArB;EAGa,SAAA,MAAA,EA3DX,OA2DW;EAArB;EAGgC,SAAA,SAAA,EA5DnB,SA4DmB;EAArB;EAe6B,SAAA,YAAA,CAAA,EAzEvB,UAyEuB,CAzEF,OAyEE,CAAA;EAArB;EAAkC,SAAA,cAAA,CAAA,EAAA,MAAA;EAAI;EAKrD,SAAA,WAAA,CAAA,EAAA,CAAA,WAAA,EAzEI,WAyEJ,EAAA,MAAA,EAAA,MAAA,EAAA,GAAA,IAAA;EA0BgC;EAAvB,SAAA,aAAA,CAAA,EAAA,CAAA,KAAA,EA/Fa,UA+Fb,CA/FkC,OA+FlC,CAAA,GAAA,SAAA,EAAA,GAAA,IAAA;EAMD;EAAkB,SAAA,kBAAA,CAAA,EAAA,CAAA,SAAA,EAAA,OAAA,EAAA,GAAA,IAAA;EACH;EAAf,SAAA,OAAA,CAAA,EAAA,GAAA,GAAA,IAAA;EAAf;EAAc,SAAA,kBAAA,CAAA,EAAA,MAAA;EAWP;EACK,SAAA,WAAA,CAAA,EAAA,MAAA;EACE;EAEa,SAAA,KAAA,CAAA,EAAA,OAAA;EAAS;;;;EACvC,SAAA,QAAA,CAAA,EAvGmB,SAuGnB;EAAc;6BArGY,kBAAkB,cAAuB,MAAe;;;;;UAMpE,uCAAuC;;mCAErB,WAAqB;;;;;;;;;UAUvC,+BACC,gCACE;;mBAGD;;iBAGF,WAAqB;;SAG7B,WAAqB;;oBAGV,WAAqB;;;;;;;;;;;4BAeb,WAAqB,aAAa,IAAI;;;;aAKrD;;;;;;;;;;;;;;;;;;;;;sBA0BS,uBAAuB;;;;;qBAMxB,kBAAkB,cACjC,eAAe,MAAe;;;;;cAWvB,uBACK,gCACE,8CAET,sBAAsB,SAAS,eACvC,eAAe,SAAS"}

package/dist/client/ClientDocument.d.mts

@@ -0,0 +1,162 @@
+import { AnyPresence, Infer, PresenceEntry } from "../Presence.mjs";
+import { Transaction } from "../Transaction.mjs";
+import { AnyPrimitive, InferProxy, InferState } from "../primitives/shared.mjs";
+import "../Primitive.mjs";
+import { Transport } from "./Transport.mjs";
+
+//#region src/client/ClientDocument.d.ts
+declare namespace ClientDocument_d_exports {
+  export { ClientDocument, ClientDocumentListener, ClientDocumentOptions, ClientPresence, PresenceListener, make };
+}
+/**
+ * Listener for presence changes.
+ */
+interface PresenceListener<_TData> {
+  /** Called when any presence changes (self or others) */
+  readonly onPresenceChange?: () => void;
+}
+/**
+ * Presence API exposed on the ClientDocument.
+ */
+interface ClientPresence<TData> {
+  /**
+   * Returns this client's connection ID (set after receiving presence_snapshot).
+   * Returns undefined before the snapshot is received.
+   */
+  readonly selfId: () => string | undefined;
+  /**
+   * Returns this client's current presence data.
+   * Returns undefined if not set.
+   */
+  readonly self: () => TData | undefined;
+  /**
+   * Returns a map of other clients' presence data.
+   * Keys are connection IDs.
+   */
+  readonly others: () => ReadonlyMap<string, PresenceEntry<TData>>;
+  /**
+   * Returns all presence entries including self.
+   */
+  readonly all: () => ReadonlyMap<string, PresenceEntry<TData>>;
+  /**
+   * Sets this client's presence data.
+   * Validates against the presence schema before sending.
+   * @throws ParseError if validation fails
+   */
+  readonly set: (data: TData) => void;
+  /**
+   * Clears this client's presence data.
+   */
+  readonly clear: () => void;
+  /**
+   * Subscribes to presence changes.
+   * @returns Unsubscribe function
+   */
+  readonly subscribe: (listener: PresenceListener<TData>) => () => void;
+}
+/**
+ * Options for creating a ClientDocument.
+ */
+interface ClientDocumentOptions<TSchema extends AnyPrimitive, TPresence extends AnyPresence | undefined = undefined> {
+  /** The schema defining the document structure */
+  readonly schema: TSchema;
+  /** Transport for server communication */
+  readonly transport: Transport;
+  /** Initial state (optional, will sync from server if not provided) */
+  readonly initialState?: InferState<TSchema>;
+  /** Initial server version (optional) */
+  readonly initialVersion?: number;
+  /** Called when server rejects a transaction */
+  readonly onRejection?: (transaction: Transaction, reason: string) => void;
+  /** Called when optimistic state changes */
+  readonly onStateChange?: (state: InferState<TSchema> | undefined) => void;
+  /** Called when connection status changes */
+  readonly onConnectionChange?: (connected: boolean) => void;
+  /** Called when client is fully initialized and ready */
+  readonly onReady?: () => void;
+  /** Timeout in ms for pending transactions (default: 30000) */
+  readonly transactionTimeout?: number;
+  /** Timeout in ms for initialization (default: 10000) */
+  readonly initTimeout?: number;
+  /** Enable debug logging for all activity (default: false) */
+  readonly debug?: boolean;
+  /**
+   * Optional presence schema for ephemeral per-user data.
+   * When provided, enables the presence API on the ClientDocument.
+   */
+  readonly presence?: TPresence;
+  /** Initial presence data, that will be set on the ClientDocument when it is created */
+  readonly initialPresence?: TPresence extends AnyPresence ? Infer<TPresence> : undefined;
+}
+/**
+ * Listener callbacks for subscribing to ClientDocument events.
+ */
+interface ClientDocumentListener<TSchema extends AnyPrimitive> {
+  /** Called when optimistic state changes */
+  readonly onStateChange?: (state: InferState<TSchema> | undefined) => void;
+  /** Called when connection status changes */
+  readonly onConnectionChange?: (connected: boolean) => void;
+  /** Called when client is fully initialized and ready */
+  readonly onReady?: () => void;
+}
+/**
+ * A ClientDocument provides optimistic updates with server synchronization.
+ */
+interface ClientDocument<TSchema extends AnyPrimitive, TPresence extends AnyPresence | undefined = undefined> {
+  /** The schema defining this document's structure */
+  readonly schema: TSchema;
+  /** Root proxy for accessing and modifying document data (optimistic) */
+  readonly root: InferProxy<TSchema>;
+  /** Returns the current optimistic state (server + pending) */
+  get(): InferState<TSchema> | undefined;
+  /** Returns the confirmed server state */
+  getServerState(): InferState<TSchema> | undefined;
+  /** Returns the current server version */
+  getServerVersion(): number;
+  /** Returns pending transactions count */
+  getPendingCount(): number;
+  /** Returns whether there are pending transactions */
+  hasPendingChanges(): boolean;
+  /**
+   * Runs a function within a transaction.
+   * Changes are applied optimistically and sent to the server.
+   */
+  transaction<R>(fn: (root: InferProxy<TSchema>) => R): R;
+  /**
+   * Connects to the server and starts syncing.
+   */
+  connect(): Promise<void>;
+  /**
+   * Disconnects from the server.
+   */
+  disconnect(): void;
+  /**
+   * Returns whether currently connected to the server.
+   */
+  isConnected(): boolean;
+  /**
+   * Forces a full resync from the server.
+   */
+  resync(): void;
+  /**
+   * Returns whether the client is fully initialized and ready.
+   */
+  isReady(): boolean;
+  /**
+   * Subscribes to document events (state changes, connection changes, ready).
+   * @returns Unsubscribe function
+   */
+  subscribe(listener: ClientDocumentListener<TSchema>): () => void;
+  /**
+   * Presence API for ephemeral per-user data.
+   * Only available when presence schema is provided in options.
+   */
+  readonly presence: TPresence extends AnyPresence ? ClientPresence<Infer<TPresence>> : undefined;
+}
+/**
+ * Creates a new ClientDocument for the given schema.
+ */
+declare const make: <TSchema extends AnyPrimitive, TPresence extends AnyPresence | undefined = undefined>(options: ClientDocumentOptions<TSchema, TPresence>) => ClientDocument<TSchema, TPresence>;
+//#endregion
+export { ClientDocument_d_exports };
+//# sourceMappingURL=ClientDocument.d.mts.map

package/dist/client/ClientDocument.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ClientDocument.d.mts","names":[],"sources":["../../src/client/ClientDocument.ts"],"sourcesContent":[],"mappings":";;;;;;;;;;;;;UA6CiB;;;;;;;UAQA;;AARjB;AAQA;;EAiBoE,SAAA,MAAA,EAAA,GAAA,GAAA,MAAA,GAAA,SAAA;EAAvB;;;;EAKvB,SAAA,IAAA,EAAA,GAAA,GAXC,KAWD,GAAA,SAAA;EAOC;;;;EAiBN,SAAA,MAAA,EAAA,GAAA,GA7BQ,WA6Ba,CAAA,MAAA,EA7BO,aA6BP,CA7B8B,KA6B9B,CAAA,CAAA;EACpB;;;EAMI,SAAA,GAAA,EAAA,GAAA,GA/BA,WA+BA,CAAA,MAAA,EA/BoB,aA+BpB,CA/B2C,KA+B3C,CAAA,CAAA;EAEyB;;;;;EAwBzB,SAAA,GAAA,EAAA,CAAA,IAAA,EAlDC,KAkDD,EAAA,GAAA,IAAA;EAEO;;;EAAyC,SAAA,KAAA,EAAA,GAAA,GAAA,IAAA;EAAc;AAMpF;;;EAEmC,SAAA,SAAA,EAAA,CAAA,QAAA,EAjDF,gBAiDE,CAjDe,KAiDf,CAAA,EAAA,GAAA,GAAA,GAAA,IAAA;;AAUnC;;;AAKmB,UA1DF,qBA0DE,CAAA,gBAzDD,YAyDC,EAAA,kBAxDC,WAwDD,GAAA,SAAA,GAAA,SAAA,CAAA,CAAA;EAGmB;EAArB,SAAA,MAAA,EAxDE,OAwDF;EAGa;EAArB,SAAA,SAAA,EAzDa,SAyDb;EAGgC;EAArB,SAAA,YAAA,CAAA,EA1DM,UA0DN,CA1D2B,OA0D3B,CAAA;EAe6B;EAArB,SAAA,cAAA,CAAA,EAAA,MAAA;EAAkC;EAAI,SAAA,WAAA,CAAA,EAAA,CAAA,WAAA,EApEjD,WAoEiD,EAAA,MAAA,EAAA,MAAA,EAAA,GAAA,IAAA;EAKrD;EA0BgC,SAAA,aAAA,CAAA,EAAA,CAAA,KAAA,EA/FV,UA+FU,CA/FW,OA+FX,CAAA,GAAA,SAAA,EAAA,GAAA,IAAA;EAAvB;EAMD,SAAA,kBAAA,CAAA,EAAA,CAAA,SAAA,EAAA,OAAA,EAAA,GAAA,IAAA;EAAkB;EACH,SAAA,OAAA,CAAA,EAAA,GAAA,GAAA,IAAA;EAAf;EAAf,SAAA,kBAAA,CAAA,EAAA,MAAA;EAAc;EAWP,SAo6BZ,WAAA,CAAA,EAAA,MAAA;EAn6BiB;EACE,SAAA,KAAA,CAAA,EAAA,OAAA;EAEa;;;;EACN,SAAA,QAAA,CAAA,EAvGL,SAuGK;EAAxB;EAAc,SAAA,eAAA,CAAA,EArGY,SAqGZ,SArG8B,WAqG9B,GArGqD,KAqGrD,CArGoE,SAqGpE,CAAA,GAAA,SAAA;;;;;UA/FA,uCAAuC;;mCAErB,WAAqB;;;;;;;;;UAUvC,+BACC,gCACE;;mBAGD;;iBAGF,WAAqB;;SAG7B,WAAqB;;oBAGV,WAAqB;;;;;;;;;;;4BAeb,WAAqB,aAAa,IAAI;;;;aAKrD;;;;;;;;;;;;;;;;;;;;;sBA0BS,uBAAuB;;;;;qBAMxB,kBAAkB,cACjC,eAAe,MAAe;;;;;cAWvB,uBACK,gCACE,8CAET,sBAAsB,SAAS,eACvC,eAAe,SAAS"}