@verdant-web/common 2.4.0 → 2.5.0

package/dist/esm/index.d.ts

@@ -8,7 +8,8 @@ export * from './utils.js';
 export * from './indexes.js';
 export { migrate, migrationRange, createDefaultMigration, createMigration, } from './migration.js';
 export type { Migration, MigrationIndexDescription, MigrationEngine, } from './migration.js';
-export type { UserInfo } from './presence.js';
+export type * from './presence.js';
+export { initialInternalPresence } from './presence.js';
 export * from './patch.js';
 export * from './oids.js';
 export * from './oidsLegacy.js';

package/dist/esm/index.js

@@ -7,6 +7,7 @@ export * from './schema/index.js';
 export * from './utils.js';
 export * from './indexes.js';
 export { migrate, migrationRange, createDefaultMigration, createMigration, } from './migration.js';
+export { initialInternalPresence } from './presence.js';
 export * from './patch.js';
 export * from './oids.js';
 export * from './oidsLegacy.js';

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,OAAO,EACN,OAAO,EACP,cAAc,EACd,sBAAsB,EACtB,eAAe,GACf,MAAM,gBAAgB,CAAC;AAOxB,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,WAAW,CAAC;AAC1B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAE3B,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAC3E,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,OAAO,EACN,OAAO,EACP,cAAc,EACd,sBAAsB,EACtB,eAAe,GACf,MAAM,gBAAgB,CAAC;AAOxB,OAAO,EAAE,uBAAuB,EAAE,MAAM,eAAe,CAAC;AACxD,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,WAAW,CAAC;AAC1B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAE3B,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAC3E,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC"}

package/dist/esm/presence.d.ts

@@ -24,4 +24,17 @@ export interface UserInfo<Profile, Presence> {
      * makes changes. The shape of presence is up to you.
      */
     presence: Presence;
+    /**
+     * This is the internal presence data that Verdant uses
+     * for some built-in presence functionality. The client
+     * should manage it transparently to the user.
+     */
+    internal: VerdantInternalPresence;
+}
+export type UserInfoUpdate<Profile = any, Presence = any> = Omit<UserInfo<Profile, Presence>, 'internal' | 'profile'> & {
+    internal?: VerdantInternalPresence;
+};
+export interface VerdantInternalPresence {
+    viewId?: string;
 }
+export declare const initialInternalPresence: VerdantInternalPresence;

package/dist/esm/presence.js

@@ -1,2 +1,2 @@
-export {};
+export const initialInternalPresence = {};
 //# sourceMappingURL=presence.js.map

package/dist/esm/presence.js.map

@@ -1 +1 @@
-{"version":3,"file":"presence.js","sourceRoot":"","sources":["../../src/presence.ts"],"names":[],"mappings":""}
+{"version":3,"file":"presence.js","sourceRoot":"","sources":["../../src/presence.ts"],"names":[],"mappings":"AAgDA,MAAM,CAAC,MAAM,uBAAuB,GAA4B,EAAE,CAAC"}

package/dist/esm/protocol.d.ts

@@ -1,6 +1,6 @@
 import { DocumentBaseline } from './baseline.js';
 import { Operation } from './operation.js';
-import { UserInfo } from './presence.js';
+import { UserInfo, VerdantInternalPresence } from './presence.js';
 export type HeartbeatMessage = {
     type: 'heartbeat';
     timestamp: string;
@@ -108,7 +108,9 @@ export type PresenceUpdateMessage = {
     /** The client's replica ID */
     replicaId: string;
     /** new presence value */
-    presence: any;
+    presence?: any;
+    /** presence that is internal to verdant */
+    internal?: VerdantInternalPresence;
 };
 export type PresenceChangedMessage = {
     type: 'presence-changed';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdant-web/common",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "access": "public",
   "type": "module",
   "exports": {

package/src/index.ts

@@ -17,7 +17,8 @@ export type {
 	MigrationIndexDescription,
 	MigrationEngine,
 } from './migration.js';
-export type { UserInfo } from './presence.js';
+export type * from './presence.js';
+export { initialInternalPresence } from './presence.js';
 export * from './patch.js';
 export * from './oids.js';
 export * from './oidsLegacy.js';

package/src/presence.ts

@@ -26,4 +26,24 @@ export interface UserInfo<Profile, Presence> {
 	 * makes changes. The shape of presence is up to you.
 	 */
 	presence: Presence;
+
+	/**
+	 * This is the internal presence data that Verdant uses
+	 * for some built-in presence functionality. The client
+	 * should manage it transparently to the user.
+	 */
+	internal: VerdantInternalPresence;
 }
+
+export type UserInfoUpdate<Profile = any, Presence = any> = Omit<
+	UserInfo<Profile, Presence>,
+	'internal' | 'profile'
+> & {
+	internal?: VerdantInternalPresence;
+};
+
+export interface VerdantInternalPresence {
+	viewId?: string;
+}
+
+export const initialInternalPresence: VerdantInternalPresence = {};

package/src/protocol.ts

@@ -1,8 +1,12 @@
 // client ID, and therefore library ID, is inferred
 
 import { DocumentBaseline } from './baseline.js';
-import { Operation, OperationPatch } from './operation.js';
-import { UserInfo } from './presence.js';
+import { Operation } from './operation.js';
+import {
+	UserInfo,
+	UserInfoUpdate,
+	VerdantInternalPresence,
+} from './presence.js';
 
 export type HeartbeatMessage = {
 	type: 'heartbeat';
@@ -124,7 +128,9 @@ export type PresenceUpdateMessage = {
 	/** The client's replica ID */
 	replicaId: string;
 	/** new presence value */
-	presence: any;
+	presence?: any;
+	/** presence that is internal to verdant */
+	internal?: VerdantInternalPresence;
 };
 
 export type PresenceChangedMessage = {