@palantir/pack.state.core 0.1.0-beta.2 → 0.1.0

package/src/types/DocumentRefImpl.ts

@@ -16,12 +16,17 @@
 
 import type { PackAppInternal } from "@palantir/pack.core";
 import type {
+  ActivityEvent,
   DocumentId,
   DocumentMetadata,
   DocumentRef,
   DocumentSchema,
   DocumentState,
+  EditDescription,
   Model,
+  ModelData,
+  PresenceEvent,
+  PresenceSubscriptionOptions,
   RecordCollectionRef,
   Unsubscribe,
 } from "@palantir/pack.document-schema.model-types";
@@ -39,8 +44,14 @@ const INVALID_DOC_REF: DocumentRef = Object.freeze(
     getRecords: () => {
       throw new Error("Invalid document reference");
     },
+    onActivity: () => () => {},
     onMetadataChange: () => () => {},
+    onPresence: () => () => {},
     onStateChange: () => () => {},
+    updateCustomPresence: () => {},
+    withTransaction: () => {
+      throw new Error("Invalid document reference");
+    },
   } as const,
 );
 
@@ -84,15 +95,42 @@ class DocumentRefImpl<T extends DocumentSchema> implements DocumentRef<T> {
     return this.#stateModule.getCreateRecordCollectionRef(this, model);
   }
 
+  onActivity(
+    callback: (docRef: DocumentRef<T>, event: ActivityEvent) => void,
+  ): Unsubscribe {
+    return this.#stateModule.onActivity(this, callback);
+  }
+
   onMetadataChange(
     cb: (docRef: DocumentRef<T>, metadata: DocumentMetadata) => void,
   ): Unsubscribe {
     return this.#stateModule.onMetadataChange(this, cb);
   }
 
+  onPresence(
+    callback: (docRef: DocumentRef<T>, event: PresenceEvent) => void,
+    options?: PresenceSubscriptionOptions,
+  ): Unsubscribe {
+    return this.#stateModule.onPresence(this, callback, options);
+  }
+
   onStateChange(
     callback: (docRef: DocumentRef<T>) => void,
   ): Unsubscribe {
     return this.#stateModule.onStateChange(this, callback);
   }
+
+  updateCustomPresence<M extends Model = Model>(
+    model: M,
+    eventData: ModelData<M>,
+  ): void {
+    this.#stateModule.updateCustomPresence(this, model, eventData);
+  }
+
+  withTransaction(
+    fn: () => void,
+    description?: EditDescription,
+  ): void {
+    this.#stateModule.withTransaction(this, fn, description);
+  }
 }

package/src/types/DocumentService.ts

@@ -16,13 +16,17 @@
 
 import type { Unsubscribe } from "@palantir/pack.core";
 import type {
+  ActivityEvent,
   DocumentId,
   DocumentMetadata,
   DocumentRef,
   DocumentSchema,
   DocumentState,
+  EditDescription,
   Model,
   ModelData,
+  PresenceEvent,
+  PresenceSubscriptionOptions,
   RecordCollectionRef,
   RecordId,
   RecordRef,
@@ -126,6 +130,12 @@ export interface DocumentService {
     partialState: Partial<ModelData<R>>,
   ) => Promise<void>;
 
+  readonly withTransaction: (
+    docRef: DocumentRef,
+    fn: () => void,
+    description?: EditDescription,
+  ) => void;
+
   // Collection methods
   readonly getRecord: <M extends Model>(
     collection: RecordCollectionRef<M>,
@@ -170,16 +180,33 @@ export interface DocumentService {
     callback: RecordCollectionChangeCallback<M>,
   ) => Unsubscribe;
 
+  readonly onActivity: <T extends DocumentSchema>(
+    docRef: DocumentRef<T>,
+    callback: (docRef: DocumentRef<T>, event: ActivityEvent) => void,
+  ) => Unsubscribe;
+
   readonly onMetadataChange: <T extends DocumentSchema>(
     docRef: DocumentRef<T>,
     callback: DocumentMetadataChangeCallback<T>,
   ) => Unsubscribe;
 
+  readonly onPresence: <T extends DocumentSchema>(
+    docRef: DocumentRef<T>,
+    callback: (docRef: DocumentRef<T>, event: PresenceEvent) => void,
+    options?: PresenceSubscriptionOptions,
+  ) => Unsubscribe;
+
   readonly onStateChange: <T extends DocumentSchema>(
     docRef: DocumentRef<T>,
     callback: DocumentStateChangeCallback<T>,
   ) => Unsubscribe;
 
+  readonly updateCustomPresence: <M extends Model>(
+    docRef: DocumentRef,
+    model: M,
+    eventData: ModelData<M>,
+  ) => void;
+
   readonly onRecordChanged: <M extends Model>(
     record: RecordRef<M>,
     callback: RecordChangeCallback<M>,

package/src/types/StateModule.ts

@@ -21,13 +21,17 @@ import {
   type Unsubscribe,
 } from "@palantir/pack.core";
 import type {
+  ActivityEvent,
   DocumentId,
   DocumentMetadata,
   DocumentRef,
   DocumentSchema,
   DocumentState,
+  EditDescription,
   Model,
   ModelData,
+  PresenceEvent,
+  PresenceSubscriptionOptions,
   RecordCollectionRef,
   RecordId,
   RecordRef,
@@ -73,16 +77,33 @@ export interface StateModule {
     docRef: DocumentRef<T>,
   ) => Promise<DocumentState<T>>;
 
+  readonly onActivity: <T extends DocumentSchema>(
+    docRef: DocumentRef<T>,
+    callback: (docRef: DocumentRef<T>, event: ActivityEvent) => void,
+  ) => Unsubscribe;
+
   readonly onMetadataChange: <T extends DocumentSchema>(
     docRef: DocumentRef<T>,
     cb: (docRef: DocumentRef<T>, metadata: DocumentMetadata) => void,
   ) => Unsubscribe;
 
+  readonly onPresence: <T extends DocumentSchema>(
+    docRef: DocumentRef<T>,
+    callback: (docRef: DocumentRef<T>, event: PresenceEvent) => void,
+    options?: PresenceSubscriptionOptions,
+  ) => Unsubscribe;
+
   readonly onStateChange: <T extends DocumentSchema>(
     docRef: DocumentRef<T>,
     cb: (docRef: DocumentRef<T>) => void,
   ) => Unsubscribe;
 
+  readonly updateCustomPresence: <M extends Model>(
+    docRef: DocumentRef,
+    model: M,
+    eventData: ModelData<M>,
+  ) => void;
+
   readonly getRecordSnapshot: <R extends Model>(
     recordRef: RecordRef<R>,
   ) => Promise<ModelData<R>>;
@@ -112,6 +133,12 @@ export interface StateModule {
     partialState: Partial<ModelData<R>>,
   ) => Promise<void>;
 
+  readonly withTransaction: (
+    docRef: DocumentRef,
+    fn: () => void,
+    description?: EditDescription,
+  ) => void;
+
   readonly onRecordChanged: <M extends Model>(
     record: RecordRef<M>,
     callback: RecordChangeCallback<M>,
@@ -178,6 +205,13 @@ export class StateModuleImpl implements StateModule {
     return this.documentService.getDocumentSnapshot(docRef);
   }
 
+  onActivity<T extends DocumentSchema>(
+    docRef: DocumentRef<T>,
+    callback: (docRef: DocumentRef<T>, event: ActivityEvent) => void,
+  ): Unsubscribe {
+    return this.documentService.onActivity(docRef, callback);
+  }
+
   onMetadataChange<T extends DocumentSchema>(
     docRef: DocumentRef<T>,
     cb: (doc: DocumentRef<T>, metadata: DocumentMetadata) => void,
@@ -185,6 +219,14 @@ export class StateModuleImpl implements StateModule {
     return this.documentService.onMetadataChange(docRef, cb);
   }
 
+  onPresence<T extends DocumentSchema>(
+    docRef: DocumentRef<T>,
+    callback: (docRef: DocumentRef<T>, event: PresenceEvent) => void,
+    options?: PresenceSubscriptionOptions,
+  ): Unsubscribe {
+    return this.documentService.onPresence(docRef, callback, options);
+  }
+
   onStateChange<T extends DocumentSchema>(
     docRef: DocumentRef<T>,
     cb: (docRef: DocumentRef<T>) => void,
@@ -192,6 +234,14 @@ export class StateModuleImpl implements StateModule {
     return this.documentService.onStateChange(docRef, cb);
   }
 
+  updateCustomPresence<M extends Model>(
+    docRef: DocumentRef,
+    model: M,
+    eventData: ModelData<M>,
+  ): void {
+    this.documentService.updateCustomPresence(docRef, model, eventData);
+  }
+
   async getRecordSnapshot<R extends Model>(
     recordRef: RecordRef<R>,
   ): Promise<ModelData<R>> {
@@ -212,6 +262,14 @@ export class StateModuleImpl implements StateModule {
     return this.documentService.updateRecord(recordRef, partialState);
   }
 
+  withTransaction(
+    docRef: DocumentRef,
+    fn: () => void,
+    description?: EditDescription,
+  ): void {
+    this.documentService.withTransaction(docRef, fn, description);
+  }
+
   // Collection methods
   getCreateRecordCollectionRef<M extends Model>(
     docRef: DocumentRef,