@verdant-web/common 1.11.0 → 1.12.0

package/dist/cjs/presence.d.ts

@@ -1,27 +1,27 @@
-export interface UserInfo<Profile, Presence> {
-    /**
-     * This is the ID representing the user who is utilizing a
-     * replica client to connect to the storage network.
-     * One user may have multiple replica clients active at once,
-     * but their presence will only reflect the most recent
-     * replica used.
-     */
-    id: string;
-    /**
-     * This is the ID representing the replica client that is
-     * connected to the storage network. This is used to
-     * identify the client when sending messages to it.
-     */
-    replicaId: string;
-    /**
-     * This is the user's server profile. This data is associated
-     * with the logged in user of the app and cannot be modified
-     * by the local replica directly.
-     */
-    profile: Profile;
-    /**
-     * Presence info which can update frequently as a replica
-     * makes changes. The shape of presence is up to you.
-     */
-    presence: Presence;
-}
+export interface UserInfo<Profile, Presence> {
+    /**
+     * This is the ID representing the user who is utilizing a
+     * replica client to connect to the storage network.
+     * One user may have multiple replica clients active at once,
+     * but their presence will only reflect the most recent
+     * replica used.
+     */
+    id: string;
+    /**
+     * This is the ID representing the replica client that is
+     * connected to the storage network. This is used to
+     * identify the client when sending messages to it.
+     */
+    replicaId: string;
+    /**
+     * This is the user's server profile. This data is associated
+     * with the logged in user of the app and cannot be modified
+     * by the local replica directly.
+     */
+    profile: Profile;
+    /**
+     * Presence info which can update frequently as a replica
+     * makes changes. The shape of presence is up to you.
+     */
+    presence: Presence;
+}

package/dist/cjs/presence.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=presence.js.map

package/dist/cjs/protocol.d.ts

@@ -1,145 +1,145 @@
-import { DocumentBaseline } from './baseline.js';
-import { Operation } from './operation.js';
-import { UserInfo } from './presence.js';
-export declare type HeartbeatMessage = {
-    type: 'heartbeat';
-    timestamp: string;
-    replicaId: string;
-};
-export declare type HeartbeatResponseMessage = {
-    type: 'heartbeat-response';
-};
-/**
- * Used by clients to indicate they have
- * successfully applied all operations from the
- * server up to this one. Uses the nonce from the
- * operation rebroadcast message as the ack.
- */
-export declare type AckMessage = {
-    type: 'ack';
-    replicaId: string;
-    timestamp?: string;
-    nonce?: string;
-};
-export declare type OperationMessage = {
-    type: 'op';
-    replicaId: string;
-    operations: Operation[];
-    timestamp: string;
-};
-export declare type OperationRebroadcastMessage = {
-    type: 'op-re';
-    operations: Operation[];
-    baselines: DocumentBaseline[];
-    replicaId: string;
-    globalAckTimestamp: string | undefined;
-    ackThisNonce?: string;
-};
-export declare type SyncMessage = {
-    type: 'sync';
-    /** This client's replica ID */
-    replicaId: string;
-    /** the logical time this message was sent */
-    timestamp: string;
-    /** Any new operations created since the requested time */
-    operations: Operation[];
-    /** Any new baselines created since the requested time */
-    baselines: DocumentBaseline[];
-    /** the schema version known by this client */
-    schemaVersion: number;
-    /**
-     * the client may have lost its local data, in which
-     * case it may set this flag to be treated as a new client
-     * and receive a full baseline
-     */
-    resyncAll?: boolean;
-    /**
-     * timestamp of when the replica changes began. null means
-     * full changeset from start of time
-     */
-    since: string | null;
-};
-export declare type SyncResponseMessage = {
-    type: 'sync-resp';
-    operations: Operation[];
-    baselines: DocumentBaseline[];
-    /**
-     * If this flag is set, the client should discard local data
-     * and reset to incoming data only. Used when a client requested
-     * resyncAll in its sync message, or for clients which have been
-     * offline for too long. When specified true, provideChangesSince
-     * should be ignored.
-     */
-    overwriteLocalData: boolean;
-    /**
-     * Update client on the global ack
-     */
-    globalAckTimestamp: string | undefined;
-    /**
-     * A map of connected clients' presences values
-     */
-    peerPresence: Record<string, UserInfo<any, any>>;
-    /**
-     * The timestamp sent in the original sync message -
-     * this confirms the server has received the client's
-     * state up to this point. Subsequent syncs should not
-     * include operations or baselines older than this timestamp.
-     */
-    ackedTimestamp: string;
-    /**
-     * The client should respond with a sync-ack containing
-     * this nonce to confirm it has received this message if
-     * it is not undefined
-     */
-    ackThisNonce?: string;
-};
-/** @deprecated use ack */
-export declare type SyncAckMessage = {
-    type: 'sync-ack';
-    /** The client's replica ID */
-    replicaId: string;
-    /** the logical time this message was sent */
-    timestamp: string;
-    /** the nonce sent in the sync-resp message */
-    nonce: string;
-};
-export declare type PresenceUpdateMessage = {
-    type: 'presence-update';
-    /** The client's replica ID */
-    replicaId: string;
-    /** new presence value */
-    presence: any;
-};
-export declare type PresenceChangedMessage = {
-    type: 'presence-changed';
-    /** The client's replica ID */
-    replicaId: string;
-    userInfo: UserInfo<any, any>;
-};
-/**
- * This is only emitted when all of a user's replicas
- * go offline.
- */
-export declare type PresenceOfflineMessage = {
-    type: 'presence-offline';
-    userId: string;
-    /** The last replicaID seen by the server before the user was offline */
-    replicaId: string;
-};
-export declare type GlobalAckMessage = {
-    type: 'global-ack';
-    timestamp: string;
-};
-export declare type ForbiddenMessage = {
-    type: 'forbidden';
-};
-export declare type ServerAckMessage = {
-    type: 'server-ack';
-    timestamp: string;
-};
-export declare type ServerNeedSinceMessage = {
-    type: 'need-since';
-    since: string | null;
-};
-export declare type ClientMessage = HeartbeatMessage | SyncMessage | OperationMessage | AckMessage | SyncAckMessage | PresenceUpdateMessage;
-export declare type ServerMessage = HeartbeatResponseMessage | SyncResponseMessage | OperationRebroadcastMessage | PresenceChangedMessage | PresenceOfflineMessage | GlobalAckMessage | ForbiddenMessage | ServerAckMessage | ServerNeedSinceMessage;
+import { DocumentBaseline } from './baseline.js';
+import { Operation } from './operation.js';
+import { UserInfo } from './presence.js';
+export declare type HeartbeatMessage = {
+    type: 'heartbeat';
+    timestamp: string;
+    replicaId: string;
+};
+export declare type HeartbeatResponseMessage = {
+    type: 'heartbeat-response';
+};
+/**
+ * Used by clients to indicate they have
+ * successfully applied all operations from the
+ * server up to this one. Uses the nonce from the
+ * operation rebroadcast message as the ack.
+ */
+export declare type AckMessage = {
+    type: 'ack';
+    replicaId: string;
+    timestamp?: string;
+    nonce?: string;
+};
+export declare type OperationMessage = {
+    type: 'op';
+    replicaId: string;
+    operations: Operation[];
+    timestamp: string;
+};
+export declare type OperationRebroadcastMessage = {
+    type: 'op-re';
+    operations: Operation[];
+    baselines: DocumentBaseline[];
+    replicaId: string;
+    globalAckTimestamp: string | undefined;
+    ackThisNonce?: string;
+};
+export declare type SyncMessage = {
+    type: 'sync';
+    /** This client's replica ID */
+    replicaId: string;
+    /** the logical time this message was sent */
+    timestamp: string;
+    /** Any new operations created since the requested time */
+    operations: Operation[];
+    /** Any new baselines created since the requested time */
+    baselines: DocumentBaseline[];
+    /** the schema version known by this client */
+    schemaVersion: number;
+    /**
+     * the client may have lost its local data, in which
+     * case it may set this flag to be treated as a new client
+     * and receive a full baseline
+     */
+    resyncAll?: boolean;
+    /**
+     * timestamp of when the replica changes began. null means
+     * full changeset from start of time
+     */
+    since: string | null;
+};
+export declare type SyncResponseMessage = {
+    type: 'sync-resp';
+    operations: Operation[];
+    baselines: DocumentBaseline[];
+    /**
+     * If this flag is set, the client should discard local data
+     * and reset to incoming data only. Used when a client requested
+     * resyncAll in its sync message, or for clients which have been
+     * offline for too long. When specified true, provideChangesSince
+     * should be ignored.
+     */
+    overwriteLocalData: boolean;
+    /**
+     * Update client on the global ack
+     */
+    globalAckTimestamp: string | undefined;
+    /**
+     * A map of connected clients' presences values
+     */
+    peerPresence: Record<string, UserInfo<any, any>>;
+    /**
+     * The timestamp sent in the original sync message -
+     * this confirms the server has received the client's
+     * state up to this point. Subsequent syncs should not
+     * include operations or baselines older than this timestamp.
+     */
+    ackedTimestamp: string;
+    /**
+     * The client should respond with a sync-ack containing
+     * this nonce to confirm it has received this message if
+     * it is not undefined
+     */
+    ackThisNonce?: string;
+};
+/** @deprecated use ack */
+export declare type SyncAckMessage = {
+    type: 'sync-ack';
+    /** The client's replica ID */
+    replicaId: string;
+    /** the logical time this message was sent */
+    timestamp: string;
+    /** the nonce sent in the sync-resp message */
+    nonce: string;
+};
+export declare type PresenceUpdateMessage = {
+    type: 'presence-update';
+    /** The client's replica ID */
+    replicaId: string;
+    /** new presence value */
+    presence: any;
+};
+export declare type PresenceChangedMessage = {
+    type: 'presence-changed';
+    /** The client's replica ID */
+    replicaId: string;
+    userInfo: UserInfo<any, any>;
+};
+/**
+ * This is only emitted when all of a user's replicas
+ * go offline.
+ */
+export declare type PresenceOfflineMessage = {
+    type: 'presence-offline';
+    userId: string;
+    /** The last replicaID seen by the server before the user was offline */
+    replicaId: string;
+};
+export declare type GlobalAckMessage = {
+    type: 'global-ack';
+    timestamp: string;
+};
+export declare type ForbiddenMessage = {
+    type: 'forbidden';
+};
+export declare type ServerAckMessage = {
+    type: 'server-ack';
+    timestamp: string;
+};
+export declare type ServerNeedSinceMessage = {
+    type: 'need-since';
+    since: string | null;
+};
+export declare type ClientMessage = HeartbeatMessage | SyncMessage | OperationMessage | AckMessage | SyncAckMessage | PresenceUpdateMessage;
+export declare type ServerMessage = HeartbeatResponseMessage | SyncResponseMessage | OperationRebroadcastMessage | PresenceChangedMessage | PresenceOfflineMessage | GlobalAckMessage | ForbiddenMessage | ServerAckMessage | ServerNeedSinceMessage;

package/dist/cjs/protocol.js

@@ -1,4 +1,4 @@
-"use strict";
-// client ID, and therefore library ID, is inferred
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+// client ID, and therefore library ID, is inferred
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=protocol.js.map

package/dist/cjs/refs.d.ts

@@ -1,5 +1,5 @@
-import { FileRef } from './files.js';
-import { ObjectRef } from './operation.js';
-export declare function isRef(obj: any): boolean;
-export declare function compareRefs(a: any, b: any): boolean;
-export declare type Ref = ObjectRef | FileRef;
+import { FileRef } from './files.js';
+import { ObjectRef } from './operation.js';
+export declare function isRef(obj: any): boolean;
+export declare function compareRefs(a: any, b: any): boolean;
+export declare type Ref = ObjectRef | FileRef;

package/dist/cjs/refs.js

@@ -1,22 +1,22 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.compareRefs = exports.isRef = void 0;
-const files_js_1 = require("./files.js");
-const operation_js_1 = require("./operation.js");
-function isRef(obj) {
-    return (0, operation_js_1.isObjectRef)(obj) || (0, files_js_1.isFileRef)(obj);
-}
-exports.isRef = isRef;
-function compareRefs(a, b) {
-    if (a === b)
-        return true;
-    if (!isRef(a) || !isRef(b))
-        return false;
-    if (a['@@type'] !== b['@@type'])
-        return false;
-    if (a.id !== b.id)
-        return false;
-    return true;
-}
-exports.compareRefs = compareRefs;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.compareRefs = exports.isRef = void 0;
+const files_js_1 = require("./files.js");
+const operation_js_1 = require("./operation.js");
+function isRef(obj) {
+    return (0, operation_js_1.isObjectRef)(obj) || (0, files_js_1.isFileRef)(obj);
+}
+exports.isRef = isRef;
+function compareRefs(a, b) {
+    if (a === b)
+        return true;
+    if (!isRef(a) || !isRef(b))
+        return false;
+    if (a['@@type'] !== b['@@type'])
+        return false;
+    if (a.id !== b.id)
+        return false;
+    return true;
+}
+exports.compareRefs = compareRefs;
 //# sourceMappingURL=refs.js.map

package/dist/cjs/replica.d.ts

@@ -1,28 +1,28 @@
-export interface ReplicaInfo {
-    id: string;
-    ackedLogicalTime: string | null;
-}
-/**
- * Different token types allow different replica client behaviors.
- * - Realtime: allows the client to subscribe to realtime events.
- * - Push: allows the client to push and pull data with HTTP, but not use realtime.
- * - PassivePush: allows the client to push and pull data with HTTP, but offline changes
- *     will be discarded on reconnect.
- * - PassiveRealtime: allows the client to subscribe to realtime events, but offline changes
- * 		 will be discarded on reconnect.
- * - ReadOnlyPull: the client may only pull changes using HTTP. It may not subscribe
- *     to realtime events or push changes.
- * - ReadOnlyRealtime: the client may only subscribe to realtime events or pull from HTTP.
- *     It may not push changes.
- *
- * Choosing the right token type can optimize client storage metrics significantly when
- * many replicas are connecting to a library.
- */
-export declare enum ReplicaType {
-    Realtime = 0,
-    Push = 1,
-    PassiveRealtime = 2,
-    PassivePush = 3,
-    ReadOnlyPull = 4,
-    ReadOnlyRealtime = 5
-}
+export interface ReplicaInfo {
+    id: string;
+    ackedLogicalTime: string | null;
+}
+/**
+ * Different token types allow different replica client behaviors.
+ * - Realtime: allows the client to subscribe to realtime events.
+ * - Push: allows the client to push and pull data with HTTP, but not use realtime.
+ * - PassivePush: allows the client to push and pull data with HTTP, but offline changes
+ *     will be discarded on reconnect.
+ * - PassiveRealtime: allows the client to subscribe to realtime events, but offline changes
+ * 		 will be discarded on reconnect.
+ * - ReadOnlyPull: the client may only pull changes using HTTP. It may not subscribe
+ *     to realtime events or push changes.
+ * - ReadOnlyRealtime: the client may only subscribe to realtime events or pull from HTTP.
+ *     It may not push changes.
+ *
+ * Choosing the right token type can optimize client storage metrics significantly when
+ * many replicas are connecting to a library.
+ */
+export declare enum ReplicaType {
+    Realtime = 0,
+    Push = 1,
+    PassiveRealtime = 2,
+    PassivePush = 3,
+    ReadOnlyPull = 4,
+    ReadOnlyRealtime = 5
+}

package/dist/cjs/replica.js

@@ -1,29 +1,29 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ReplicaType = void 0;
-/**
- * Different token types allow different replica client behaviors.
- * - Realtime: allows the client to subscribe to realtime events.
- * - Push: allows the client to push and pull data with HTTP, but not use realtime.
- * - PassivePush: allows the client to push and pull data with HTTP, but offline changes
- *     will be discarded on reconnect.
- * - PassiveRealtime: allows the client to subscribe to realtime events, but offline changes
- * 		 will be discarded on reconnect.
- * - ReadOnlyPull: the client may only pull changes using HTTP. It may not subscribe
- *     to realtime events or push changes.
- * - ReadOnlyRealtime: the client may only subscribe to realtime events or pull from HTTP.
- *     It may not push changes.
- *
- * Choosing the right token type can optimize client storage metrics significantly when
- * many replicas are connecting to a library.
- */
-var ReplicaType;
-(function (ReplicaType) {
-    ReplicaType[ReplicaType["Realtime"] = 0] = "Realtime";
-    ReplicaType[ReplicaType["Push"] = 1] = "Push";
-    ReplicaType[ReplicaType["PassiveRealtime"] = 2] = "PassiveRealtime";
-    ReplicaType[ReplicaType["PassivePush"] = 3] = "PassivePush";
-    ReplicaType[ReplicaType["ReadOnlyPull"] = 4] = "ReadOnlyPull";
-    ReplicaType[ReplicaType["ReadOnlyRealtime"] = 5] = "ReadOnlyRealtime";
-})(ReplicaType = exports.ReplicaType || (exports.ReplicaType = {}));
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReplicaType = void 0;
+/**
+ * Different token types allow different replica client behaviors.
+ * - Realtime: allows the client to subscribe to realtime events.
+ * - Push: allows the client to push and pull data with HTTP, but not use realtime.
+ * - PassivePush: allows the client to push and pull data with HTTP, but offline changes
+ *     will be discarded on reconnect.
+ * - PassiveRealtime: allows the client to subscribe to realtime events, but offline changes
+ * 		 will be discarded on reconnect.
+ * - ReadOnlyPull: the client may only pull changes using HTTP. It may not subscribe
+ *     to realtime events or push changes.
+ * - ReadOnlyRealtime: the client may only subscribe to realtime events or pull from HTTP.
+ *     It may not push changes.
+ *
+ * Choosing the right token type can optimize client storage metrics significantly when
+ * many replicas are connecting to a library.
+ */
+var ReplicaType;
+(function (ReplicaType) {
+    ReplicaType[ReplicaType["Realtime"] = 0] = "Realtime";
+    ReplicaType[ReplicaType["Push"] = 1] = "Push";
+    ReplicaType[ReplicaType["PassiveRealtime"] = 2] = "PassiveRealtime";
+    ReplicaType[ReplicaType["PassivePush"] = 3] = "PassivePush";
+    ReplicaType[ReplicaType["ReadOnlyPull"] = 4] = "ReadOnlyPull";
+    ReplicaType[ReplicaType["ReadOnlyRealtime"] = 5] = "ReadOnlyRealtime";
+})(ReplicaType = exports.ReplicaType || (exports.ReplicaType = {}));
 //# sourceMappingURL=replica.js.map

package/dist/cjs/schema/defaults.d.ts

@@ -1,4 +1,4 @@
-import type { StorageFieldSchema, StorageCollectionSchema } from './types.js';
-export declare function addFieldDefaults(collection: StorageCollectionSchema, value: any): any;
-export declare function traverseCollectionFieldsAndApplyDefaults(value: any, field: StorageFieldSchema): any;
-export declare function getFieldDefault(field: StorageFieldSchema): any;
+import type { StorageFieldSchema, StorageCollectionSchema } from './types.js';
+export declare function addFieldDefaults(collection: StorageCollectionSchema, value: any): any;
+export declare function traverseCollectionFieldsAndApplyDefaults(value: any, field: StorageFieldSchema): any;
+export declare function getFieldDefault(field: StorageFieldSchema): any;