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

package/build/types/types/DocumentRefImpl.d.ts

@@ -1,5 +1,25 @@
 import type { PackAppInternal } from "@palantir/pack.core";
 import type { DocumentId, DocumentRef, DocumentSchema } from "@palantir/pack.document-schema.model-types";
 export declare const createDocRef: <const D extends DocumentSchema>(app: PackAppInternal, id: DocumentId, schema: D) => DocumentRef<D>;
+/**
+* Get an invalid document reference. This is a stable reference that can be
+* used to represent a non-existent or invalid document.
+*
+* Not to be confused with a valid reference to a non-existent document, an
+* invalid reference is one that is not properly initialized. For example, code
+* that initializes with an undefined or empty documentId might produce an
+* invalid document reference rather than propagate nullish types.
+*
+* Most operations on an invalid reference are no-ops. For the rest, it is
+* recommended to check for validity using {@link isValidDocRef} before
+* performing operations.
+*/
 export declare function invalidDocRef<D extends DocumentSchema = DocumentSchema>(): DocumentRef<D>;
+/**
+* Check if a document reference is an invalid reference.
+* Not to be confused with a valid reference to a non-existent document, an invalid reference is one that is not properly initialized.
+* For example, code that initializes with an undefined or empty documentId might produce an invalid document reference rather than
+* propagate nullish types, as most operations on an invalid reference are no-ops. For the rest, it is recommended to check for
+* validity using this function before performing operations.
+*/
 export declare function isValidDocRef<D extends DocumentSchema = DocumentSchema>(docRef: DocumentRef<D>): docRef is DocumentRef<D>;

package/build/types/types/DocumentRefImpl.d.ts.map

@@ -1 +1 @@
-{"mappings":"AAgBA,cAAc,uBAAuB;AACrC,cACE,YAEA,aACA,sBAKK;AAoBP,OAAO,cAAM,qBAAsB,UAAU,gBAC3C,KAAK,iBACL,IAAI,YACJ,QAAQ,MACP,YAAY;AAIf,OAAO,iBAAS,cAAc,UAAU,iBAAiB,mBAAmB,YAAY;AAIxF,OAAO,iBAAS,cAAc,UAAU,iBAAiB,gBACvD,QAAQ,YAAY,KACnB,UAAU,YAAY","names":[],"sources":["../../../src/types/DocumentRefImpl.ts"],"version":3,"file":"DocumentRefImpl.d.ts"}
+{"mappings":"AAgBA,cAAc,uBAAuB;AACrC,cAEE,YAEA,aACA,sBASK;AA0BP,OAAO,cAAM,qBAAsB,UAAU,gBAC3C,KAAK,iBACL,IAAI,YACJ,QAAQ,MACP,YAAY;;;;;;;;;;;;;;AAiBf,OAAO,iBAAS,cAAc,UAAU,iBAAiB,mBAAmB,YAAY;;;;;;;;AAWxF,OAAO,iBAAS,cAAc,UAAU,iBAAiB,gBACvD,QAAQ,YAAY,KACnB,UAAU,YAAY","names":[],"sources":["../../../src/types/DocumentRefImpl.ts"],"version":3,"file":"DocumentRefImpl.d.ts"}

package/build/types/types/DocumentService.d.ts

@@ -1,5 +1,5 @@
 import type { Unsubscribe } from "@palantir/pack.core";
-import type { DocumentId, DocumentMetadata, DocumentRef, DocumentSchema, DocumentState, Model, ModelData, RecordCollectionRef, RecordId, RecordRef } from "@palantir/pack.document-schema.model-types";
+import type { ActivityEvent, DocumentId, DocumentMetadata, DocumentRef, DocumentSchema, DocumentState, EditDescription, Model, ModelData, PresenceEvent, PresenceSubscriptionOptions, RecordCollectionRef, RecordId, RecordRef } from "@palantir/pack.document-schema.model-types";
 export declare const DocumentLoadStatus: {
 	readonly UNLOADED: "unloaded";
 	readonly LOADING: "loading";
@@ -31,10 +31,23 @@ export type DocumentStateChangeCallback<T extends DocumentSchema = DocumentSchem
 export type RecordCollectionChangeCallback<M extends Model = Model> = (items: readonly RecordRef<M>[]) => void;
 export type RecordChangeCallback<M extends Model = Model> = (snapshot: ModelData<M>, record: RecordRef<M>) => void;
 export type RecordDeleteCallback<M extends Model = Model> = (record: RecordRef<M>) => void;
+/**
+* Base interface for specific document service implementations.
+* The DocumentService is responsible for persisting document state,
+* metadata, and providing methods to subscribe and interact with documents.
+*
+* The main implementation communicates with the Foundry platform (see @palantir/pack.state.foundry).
+*/
 export interface DocumentService {
 	readonly hasMetadataSubscriptions: boolean;
 	readonly hasStateSubscriptions: boolean;
 	readonly createDocument: <T extends DocumentSchema>(metadata: DocumentMetadata, schema: T) => Promise<DocumentRef<T>>;
+	readonly searchDocuments: <T extends DocumentSchema>(documentTypeName: string, schema: T, options?: {
+		documentName?: string;
+		limit?: number;
+	}) => Promise<ReadonlyArray<DocumentMetadata & {
+		readonly id: DocumentId;
+	}>>;
 	readonly createDocRef: <const T extends DocumentSchema>(id: DocumentId, schema: T) => DocumentRef<T>;
 	readonly getCreateRecordCollectionRef: <const M extends Model>(docRef: DocumentRef, model: M) => RecordCollectionRef<M>;
 	readonly getCreateRecordRef: <const M extends Model>(docRef: DocumentRef, id: RecordId, model: M) => RecordRef<M>;
@@ -42,6 +55,7 @@ export interface DocumentService {
 	readonly getRecordSnapshot: <R extends Model>(record: RecordRef<R>) => Promise<ModelData<R>>;
 	readonly setRecord: <R extends Model>(record: RecordRef<R>, state: ModelData<R>) => Promise<void>;
 	readonly updateRecord: <R extends Model>(record: RecordRef<R>, partialState: Partial<ModelData<R>>) => Promise<void>;
+	readonly withTransaction: (docRef: DocumentRef, fn: () => void, description?: EditDescription) => void;
 	readonly getRecord: <M extends Model>(collection: RecordCollectionRef<M>, id: RecordId) => RecordRef<M> | undefined;
 	readonly hasRecord: <M extends Model>(collection: RecordCollectionRef<M>, id: RecordId) => boolean;
 	readonly setCollectionRecord: <M extends Model>(collection: RecordCollectionRef<M>, id: RecordId, state: ModelData<M>) => Promise<void>;
@@ -51,8 +65,11 @@ export interface DocumentService {
 	readonly onCollectionItemsAdded: <M extends Model>(collection: RecordCollectionRef<M>, callback: RecordCollectionChangeCallback<M>) => Unsubscribe;
 	readonly onCollectionItemsChanged: <M extends Model>(collection: RecordCollectionRef<M>, callback: RecordCollectionChangeCallback<M>) => Unsubscribe;
 	readonly onCollectionItemsDeleted: <M extends Model>(collection: RecordCollectionRef<M>, 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>) => Unsubscribe;
 	readonly onRecordDeleted: <M extends Model>(record: RecordRef<M>, callback: RecordDeleteCallback<M>) => Unsubscribe;
 	readonly getDocumentStatus: <T extends DocumentSchema>(docRef: DocumentRef<T>) => DocumentStatus;

package/build/types/types/DocumentService.d.ts.map

@@ -1 +1 @@
-{"mappings":"AAgBA,cAAc,mBAAmB;AACjC,cACE,YACA,kBACA,aACA,gBACA,eACA,OACA,WACA,qBACA,UACA,iBACK;AAEP,OAAO,cAAM;UACX,UAAU;UACV,SAAS;UACT,QAAQ;UACR,OAAO;;AAET,YAAY,4BAA4B,gCAAgC;AAExE,OAAO,cAAM;UACX,cAAc;UACd,YAAY;UACZ,WAAW;UACX,OAAO;;AAET,YAAY,4BAA4B,gCAAgC;AAExE,YAAY,qBAAqB;UACtB;UACA,MAAM;UACN,MAAM;;AAGjB,YAAY,iBAAiB;UAClB,UAAU;UACV,MAAM;UACN;UACA;;AAGX,YAAY,gCACV,QAAQ,aACR,QAAQ;AAGV,YAAY,+BACV,UAAU,iBAAiB,mBACxB,QAAQ,YAAY,IAAI,UAAU;AAEvC,YAAY,4BACV,UAAU,iBAAiB,mBACxB,QAAQ,YAAY;AAEzB,YAAY,+BAA+B,UAAU,QAAQ,UAC3D,gBAAgB,UAAU;AAG5B,YAAY,qBAAqB,UAAU,QAAQ,UACjD,UAAU,UAAU,IACpB,QAAQ,UAAU;AAGpB,YAAY,qBAAqB,UAAU,QAAQ,UACjD,QAAQ,UAAU;AAGpB,iBAAiB,gBAAgB;UACtB;UACA;UAEA,iBAAiB,UAAU,gBAClC,UAAU,kBACV,QAAQ,MACL,QAAQ,YAAY;UAEhB,qBAAqB,UAAU,gBACtC,IAAI,YACJ,QAAQ,MACL,YAAY;UAER,qCAAqC,UAAU,OACtD,QAAQ,aACR,OAAO,MACJ,oBAAoB;UAEhB,2BAA2B,UAAU,OAC5C,QAAQ,aACR,IAAI,UACJ,OAAO,MACJ,UAAU;UAEN,sBAAsB,UAAU,gBACvC,QAAQ,YAAY,OACjB,QAAQ,cAAc;UAElB,oBAAoB,UAAU,OACrC,QAAQ,UAAU,OACf,QAAQ,UAAU;UAEd,YAAY,UAAU,OAC7B,QAAQ,UAAU,IAClB,OAAO,UAAU,OACd;UAEI,eAAe,UAAU,OAChC,QAAQ,UAAU,IAClB,cAAc,QAAQ,UAAU,QAC7B;UAGI,YAAY,UAAU,OAC7B,YAAY,oBAAoB,IAChC,IAAI,aACD,UAAU;UAEN,YAAY,UAAU,OAC7B,YAAY,oBAAoB,IAChC,IAAI;UAGG,sBAAsB,UAAU,OACvC,YAAY,oBAAoB,IAChC,IAAI,UACJ,OAAO,UAAU,OACd;UAEI,eAAe,UAAU,OAChC,QAAQ,UAAU,OACf;UAEI,oBAAoB,UAAU,OACrC,YAAY,oBAAoB;UAGzB,uBAAuB,UAAU,OACxC,YAAY,oBAAoB,OAC7B,UAAU;UAEN,yBAAyB,UAAU,OAC1C,YAAY,oBAAoB,IAChC,UAAU,+BAA+B,OACtC;UAEI,2BAA2B,UAAU,OAC5C,YAAY,oBAAoB,IAChC,UAAU,+BAA+B,OACtC;UAEI,2BAA2B,UAAU,OAC5C,YAAY,oBAAoB,IAChC,UAAU,+BAA+B,OACtC;UAEI,mBAAmB,UAAU,gBACpC,QAAQ,YAAY,IACpB,UAAU,+BAA+B,OACtC;UAEI,gBAAgB,UAAU,gBACjC,QAAQ,YAAY,IACpB,UAAU,4BAA4B,OACnC;UAEI,kBAAkB,UAAU,OACnC,QAAQ,UAAU,IAClB,UAAU,qBAAqB,OAC5B;UAEI,kBAAkB,UAAU,OACnC,QAAQ,UAAU,IAClB,UAAU,qBAAqB,OAC5B;UAGI,oBAAoB,UAAU,gBACrC,QAAQ,YAAY,OACjB;UAEI,iBAAiB,UAAU,gBAClC,QAAQ,YAAY,IACpB,UAAU,iCACP;UAEI,sBAAsB,UAAU,gBACvC,QAAQ,YAAY,OACjB;UAEI,kBAAkB,UAAU,gBACnC,QAAQ,YAAY,OACjB","names":[],"sources":["../../../src/types/DocumentService.ts"],"version":3,"file":"DocumentService.d.ts"}
+{"mappings":"AAgBA,cAAc,mBAAmB;AACjC,cACE,eACA,YACA,kBACA,aACA,gBACA,eACA,iBACA,OACA,WACA,eACA,6BACA,qBACA,UACA,iBACK;AAEP,OAAO,cAAM;UACX,UAAU;UACV,SAAS;UACT,QAAQ;UACR,OAAO;;AAET,YAAY,4BAA4B,gCAAgC;AAExE,OAAO,cAAM;UACX,cAAc;UACd,YAAY;UACZ,WAAW;UACX,OAAO;;AAET,YAAY,4BAA4B,gCAAgC;AAExE,YAAY,qBAAqB;UACtB;UACA,MAAM;UACN,MAAM;;AAGjB,YAAY,iBAAiB;UAClB,UAAU;UACV,MAAM;UACN;UACA;;AAGX,YAAY,gCACV,QAAQ,aACR,QAAQ;AAGV,YAAY,+BACV,UAAU,iBAAiB,mBACxB,QAAQ,YAAY,IAAI,UAAU;AAEvC,YAAY,4BACV,UAAU,iBAAiB,mBACxB,QAAQ,YAAY;AAEzB,YAAY,+BAA+B,UAAU,QAAQ,UAC3D,gBAAgB,UAAU;AAG5B,YAAY,qBAAqB,UAAU,QAAQ,UACjD,UAAU,UAAU,IACpB,QAAQ,UAAU;AAGpB,YAAY,qBAAqB,UAAU,QAAQ,UACjD,QAAQ,UAAU;;;;;;;;AAUpB,iBAAiB,gBAAgB;UACtB;UACA;UAEA,iBAAiB,UAAU,gBAClC,UAAU,kBACV,QAAQ,MACL,QAAQ,YAAY;UAEhB,kBAAkB,UAAU,gBACnC,0BACA,QAAQ,GACR,UAAU;EACR;EACA;OAEC,QAAQ,cAAc,mBAAmB;WAAW,IAAI;;UAEpD,qBAAqB,UAAU,gBACtC,IAAI,YACJ,QAAQ,MACL,YAAY;UAER,qCAAqC,UAAU,OACtD,QAAQ,aACR,OAAO,MACJ,oBAAoB;UAEhB,2BAA2B,UAAU,OAC5C,QAAQ,aACR,IAAI,UACJ,OAAO,MACJ,UAAU;UAEN,sBAAsB,UAAU,gBACvC,QAAQ,YAAY,OACjB,QAAQ,cAAc;UAElB,oBAAoB,UAAU,OACrC,QAAQ,UAAU,OACf,QAAQ,UAAU;UAEd,YAAY,UAAU,OAC7B,QAAQ,UAAU,IAClB,OAAO,UAAU,OACd;UAEI,eAAe,UAAU,OAChC,QAAQ,UAAU,IAClB,cAAc,QAAQ,UAAU,QAC7B;UAEI,kBACP,QAAQ,aACR,gBACA,cAAc;UAIP,YAAY,UAAU,OAC7B,YAAY,oBAAoB,IAChC,IAAI,aACD,UAAU;UAEN,YAAY,UAAU,OAC7B,YAAY,oBAAoB,IAChC,IAAI;UAGG,sBAAsB,UAAU,OACvC,YAAY,oBAAoB,IAChC,IAAI,UACJ,OAAO,UAAU,OACd;UAEI,eAAe,UAAU,OAChC,QAAQ,UAAU,OACf;UAEI,oBAAoB,UAAU,OACrC,YAAY,oBAAoB;UAGzB,uBAAuB,UAAU,OACxC,YAAY,oBAAoB,OAC7B,UAAU;UAEN,yBAAyB,UAAU,OAC1C,YAAY,oBAAoB,IAChC,UAAU,+BAA+B,OACtC;UAEI,2BAA2B,UAAU,OAC5C,YAAY,oBAAoB,IAChC,UAAU,+BAA+B,OACtC;UAEI,2BAA2B,UAAU,OAC5C,YAAY,oBAAoB,IAChC,UAAU,+BAA+B,OACtC;UAEI,aAAa,UAAU,gBAC9B,QAAQ,YAAY,IACpB,WAAW,QAAQ,YAAY,IAAI,OAAO,2BACvC;UAEI,mBAAmB,UAAU,gBACpC,QAAQ,YAAY,IACpB,UAAU,+BAA+B,OACtC;UAEI,aAAa,UAAU,gBAC9B,QAAQ,YAAY,IACpB,WAAW,QAAQ,YAAY,IAAI,OAAO,wBAC1C,UAAU,gCACP;UAEI,gBAAgB,UAAU,gBACjC,QAAQ,YAAY,IACpB,UAAU,4BAA4B,OACnC;UAEI,uBAAuB,UAAU,OACxC,QAAQ,aACR,OAAO,GACP,WAAW,UAAU;UAGd,kBAAkB,UAAU,OACnC,QAAQ,UAAU,IAClB,UAAU,qBAAqB,OAC5B;UAEI,kBAAkB,UAAU,OACnC,QAAQ,UAAU,IAClB,UAAU,qBAAqB,OAC5B;UAGI,oBAAoB,UAAU,gBACrC,QAAQ,YAAY,OACjB;UAEI,iBAAiB,UAAU,gBAClC,QAAQ,YAAY,IACpB,UAAU,iCACP;UAEI,sBAAsB,UAAU,gBACvC,QAAQ,YAAY,OACjB;UAEI,kBAAkB,UAAU,gBACnC,QAAQ,YAAY,OACjB","names":[],"sources":["../../../src/types/DocumentService.ts"],"version":3,"file":"DocumentService.d.ts"}

package/build/types/types/RecordCollectionRefImpl.d.ts

@@ -1,5 +1,28 @@
 import type { DocumentRef, Model, RecordCollectionRef } from "@palantir/pack.document-schema.model-types";
 import type { DocumentService } from "./DocumentService.js";
 export declare const createRecordCollectionRef: <const M extends Model>(documentService: DocumentService, docRef: DocumentRef, model: M) => RecordCollectionRef<M>;
+/**
+* Get an invalid record collection reference. This is a stable reference that
+* can be used to represent an invalid record collection.
+*
+* Not to be confused with a valid reference to a non-existent record
+* collection, an invalid reference is one that is not properly initialized. For
+* example, code that initializes with an undefined or empty model might produce
+* an invalid record collection reference rather than propagate nullish types.
+*
+* Most operations on an invalid reference are no-ops. For the rest, it is
+* recommended to check for validity using {@link isValidRecordCollectionRef}
+* before performing operations.
+*/
 export declare function invalidRecordCollectionRef<M extends Model = Model>(): RecordCollectionRef<M>;
+/**
+* Check if a record collection reference is a valid reference.
+*
+* Not to be confused with a valid reference to a non-existent record
+* collection, an invalid reference is one that is not properly initialized.
+*
+* Most operations on an invalid reference are no-ops. For the rest, it is
+* recommended to check for validity using this function before performing
+* operations.
+*/
 export declare function isValidRecordCollectionRef<M extends Model = Model>(collectionRef: RecordCollectionRef<M>): collectionRef is RecordCollectionRef<M>;

package/build/types/types/RecordCollectionRefImpl.d.ts.map

@@ -1 +1 @@
-{"mappings":"AAgBA,cACE,aACA,OAEA,2BAIK;AAGP,cAAc,uBAAuB;AAqBrC,OAAO,cAAM,kCAAmC,UAAU,OACxD,iBAAiB,iBACjB,QAAQ,aACR,OAAO,MACN,oBAAoB;AAIvB,OAAO,iBAAS,2BAA2B,UAAU,QAAQ,UAAU,oBAAoB;AAI3F,OAAO,iBAAS,2BAA2B,UAAU,QAAQ,OAC3D,eAAe,oBAAoB,KAClC,iBAAiB,oBAAoB","names":[],"sources":["../../../src/types/RecordCollectionRefImpl.ts"],"version":3,"file":"RecordCollectionRefImpl.d.ts"}
+{"mappings":"AAgBA,cACE,aACA,OAEA,2BAIK;AAGP,cAAc,uBAAuB;AAqBrC,OAAO,cAAM,kCAAmC,UAAU,OACxD,iBAAiB,iBACjB,QAAQ,aACR,OAAO,MACN,oBAAoB;;;;;;;;;;;;;;AAiBvB,OAAO,iBAAS,2BAA2B,UAAU,QAAQ,UAAU,oBAAoB;;;;;;;;;;;AAc3F,OAAO,iBAAS,2BAA2B,UAAU,QAAQ,OAC3D,eAAe,oBAAoB,KAClC,iBAAiB,oBAAoB","names":[],"sources":["../../../src/types/RecordCollectionRefImpl.ts"],"version":3,"file":"RecordCollectionRefImpl.d.ts"}

package/build/types/types/RecordRefImpl.d.ts

@@ -1,5 +1,30 @@
 import type { DocumentRef, Model, RecordId, RecordRef } from "@palantir/pack.document-schema.model-types";
 import type { DocumentService } from "./DocumentService.js";
 export declare const createRecordRef: <const M extends Model>(documentService: DocumentService, docRef: DocumentRef, id: RecordId, model: M) => RecordRef<M>;
+/**
+* Get an invalid record reference. This is a stable reference that can be used
+* to represent an invalid record.
+*
+* Not to be confused with a valid reference to a non-existent record, an
+* invalid reference is one that is not properly initialized. For example, code
+* that initializes with an undefined or empty recordId might produce an
+* invalid record reference rather than propagate nullish types.
+*
+* Most operations on an invalid reference are no-ops. For the rest, it is
+* recommended to check for validity using {@link isValidRecordRef} before
+* performing operations.
+*/
 export declare function invalidRecordRef<M extends Model = Model>(): RecordRef<M>;
+/**
+* Check if a record reference is a valid reference.
+*
+* Not to be confused with a valid reference to a non-existent record, an
+* invalid reference is one that is not properly initialized.
+*
+* For example, code that initializes with an undefined or empty recordId might
+* produce an invalid record reference rather than propagate nullish types, as
+* most operations on an invalid reference are no-ops. For the rest, it is
+* recommended to check for validity using this function before performing
+* operations.
+*/
 export declare function isValidRecordRef<M extends Model = Model>(recordRef: RecordRef<M>): recordRef is RecordRef<M>;

package/build/types/types/RecordRefImpl.d.ts.map

@@ -1 +1 @@
-{"mappings":"AAgBA,cACE,aACA,OAEA,UACA,iBAEK;AAGP,cAAc,uBAAuB;AAgBrC,OAAO,cAAM,wBAAyB,UAAU,OAC9C,iBAAiB,iBACjB,QAAQ,aACR,IAAI,UACJ,OAAO,MACN,UAAU;AAIb,OAAO,iBAAS,iBAAiB,UAAU,QAAQ,UAAU,UAAU;AAIvE,OAAO,iBAAS,iBAAiB,UAAU,QAAQ,OACjD,WAAW,UAAU,KACpB,aAAa,UAAU","names":[],"sources":["../../../src/types/RecordRefImpl.ts"],"version":3,"file":"RecordRefImpl.d.ts"}
+{"mappings":"AAgBA,cACE,aACA,OAEA,UACA,iBAEK;AAGP,cAAc,uBAAuB;AAgBrC,OAAO,cAAM,wBAAyB,UAAU,OAC9C,iBAAiB,iBACjB,QAAQ,aACR,IAAI,UACJ,OAAO,MACN,UAAU;;;;;;;;;;;;;;AAiBb,OAAO,iBAAS,iBAAiB,UAAU,QAAQ,UAAU,UAAU;;;;;;;;;;;;;AAgBvE,OAAO,iBAAS,iBAAiB,UAAU,QAAQ,OACjD,WAAW,UAAU,KACpB,aAAa,UAAU","names":[],"sources":["../../../src/types/RecordRefImpl.ts"],"version":3,"file":"RecordRefImpl.d.ts"}

package/build/types/types/StateModule.d.ts

@@ -1,5 +1,5 @@
 import { type ModuleKey, type PackAppInternal, type Unsubscribe } from "@palantir/pack.core";
-import type { DocumentId, DocumentMetadata, DocumentRef, DocumentSchema, DocumentState, Model, ModelData, RecordCollectionRef, RecordId, RecordRef } from "@palantir/pack.document-schema.model-types";
+import type { ActivityEvent, DocumentId, DocumentMetadata, DocumentRef, DocumentSchema, DocumentState, EditDescription, Model, ModelData, PresenceEvent, PresenceSubscriptionOptions, RecordCollectionRef, RecordId, RecordRef } from "@palantir/pack.document-schema.model-types";
 import type { DocumentService, RecordChangeCallback, RecordCollectionChangeCallback, RecordDeleteCallback } from "./DocumentService.js";
 export declare const STATE_MODULE_ACCESSOR = "state";
 export declare const STATE_MODULE_KEY: ModuleKey<StateModuleImpl>;
@@ -10,15 +10,25 @@ export interface StateModule {
 	readonly createDocRef: <const T extends DocumentSchema>(id: DocumentId, schema: T) => DocumentRef<T>;
 	readonly createRecordRef: <const M extends Model>(docRef: DocumentRef, id: RecordId, model: M) => RecordRef<M>;
 	readonly createDocument: <T extends DocumentSchema>(metadata: DocumentMetadata, schema: T) => Promise<DocumentRef<T>>;
+	readonly searchDocuments: <T extends DocumentSchema>(documentTypeName: string, schema: T, options?: {
+		documentName?: string;
+		limit?: number;
+	}) => Promise<ReadonlyArray<DocumentMetadata & {
+		readonly id: DocumentId;
+	}>>;
 	readonly getDocumentSnapshot: <T extends DocumentSchema>(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>>;
 	readonly onCollectionItemsAdded: <M extends Model>(collection: RecordCollectionRef<M>, callback: RecordCollectionChangeCallback<M>) => Unsubscribe;
 	readonly onCollectionItemsChanged: <M extends Model>(collection: RecordCollectionRef<M>, callback: RecordCollectionChangeCallback<M>) => Unsubscribe;
 	readonly onCollectionItemsDeleted: <M extends Model>(collection: RecordCollectionRef<M>, callback: RecordCollectionChangeCallback<M>) => Unsubscribe;
 	readonly setRecord: <R extends Model>(recordRef: RecordRef<R>, state: ModelData<R>) => Promise<void>;
 	readonly updateRecord: <R extends Model>(recordRef: RecordRef<R>, 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>) => Unsubscribe;
 	readonly onRecordDeleted: <M extends Model>(record: RecordRef<M>, callback: RecordDeleteCallback<M>) => Unsubscribe;
 	readonly deleteRecord: <M extends Model>(record: RecordRef<M>) => Promise<void>;
@@ -33,12 +43,22 @@ export declare class StateModuleImpl implements StateModule {
 	createDocRef<const T extends DocumentSchema>(id: DocumentId, schema: T): DocumentRef<T>;
 	createRecordRef<const M extends Model>(docRef: DocumentRef, id: RecordId, model: M): RecordRef<M>;
 	createDocument<T extends DocumentSchema>(metadata: DocumentMetadata, schema: T): Promise<DocumentRef<T>>;
+	searchDocuments<T extends DocumentSchema>(documentTypeName: string, schema: T, options?: {
+		documentName?: string;
+		limit?: number;
+	}): Promise<ReadonlyArray<DocumentMetadata & {
+		readonly id: DocumentId;
+	}>>;
 	getDocumentSnapshot<T extends DocumentSchema>(docRef: DocumentRef<T>): Promise<DocumentState<T>>;
+	onActivity<T extends DocumentSchema>(docRef: DocumentRef<T>, callback: (docRef: DocumentRef<T>, event: ActivityEvent) => void): Unsubscribe;
 	onMetadataChange<T extends DocumentSchema>(docRef: DocumentRef<T>, cb: (doc: DocumentRef<T>, metadata: DocumentMetadata) => void): Unsubscribe;
+	onPresence<T extends DocumentSchema>(docRef: DocumentRef<T>, callback: (docRef: DocumentRef<T>, event: PresenceEvent) => void, options?: PresenceSubscriptionOptions): Unsubscribe;
 	onStateChange<T extends DocumentSchema>(docRef: DocumentRef<T>, cb: (docRef: DocumentRef<T>) => void): Unsubscribe;
+	updateCustomPresence<M extends Model>(docRef: DocumentRef, model: M, eventData: ModelData<M>): void;
 	getRecordSnapshot<R extends Model>(recordRef: RecordRef<R>): Promise<ModelData<R>>;
 	setRecord<R extends Model>(recordRef: RecordRef<R>, state: ModelData<R>): Promise<void>;
 	updateRecord<R extends Model>(recordRef: RecordRef<R>, partialState: Partial<ModelData<R>>): Promise<void>;
+	withTransaction(docRef: DocumentRef, fn: () => void, description?: EditDescription): void;
 	getCreateRecordCollectionRef<M extends Model>(docRef: DocumentRef, model: M): RecordCollectionRef<M>;
 	getRecord<M extends Model>(collection: RecordCollectionRef<M>, id: RecordId): RecordRef<M> | undefined;
 	hasRecord<M extends Model>(collection: RecordCollectionRef<M>, id: RecordId): boolean;

package/build/types/types/StateModule.d.ts.map

@@ -1 +1 @@
-{"mappings":"AAgBA,cAEO,gBACA,sBACA,mBACA;AACP,cACE,YACA,kBACA,aACA,gBACA,eACA,OACA,WACA,qBACA,UACA,iBACK;AAEP,cACE,iBACA,sBACA,gCACA,4BACK;AAGP,OAAO,cAAM,wBAAwB;AACrC,OAAO,cAAMA,kBAAkB,UAAU;AAQzC,YAAY,gBAAgB,KAAK,IAAI;WAAY,wBAAwB;;AAEzE,iBAAiB,YAAY;UAClB,qBAAqB,UAAU,gBACtC,IAAI,YACJ,QAAQ,MACL,YAAY;UAER,wBAAwB,UAAU,OACzC,QAAQ,aACR,IAAI,UACJ,OAAO,MACJ,UAAU;UAEN,iBAAiB,UAAU,gBAClC,UAAU,kBACV,QAAQ,MACL,QAAQ,YAAY;UAEhB,sBAAsB,UAAU,gBACvC,QAAQ,YAAY,OACjB,QAAQ,cAAc;UAElB,mBAAmB,UAAU,gBACpC,QAAQ,YAAY,IACpB,KAAK,QAAQ,YAAY,IAAI,UAAU,8BACpC;UAEI,gBAAgB,UAAU,gBACjC,QAAQ,YAAY,IACpB,KAAK,QAAQ,YAAY,gBACtB;UAEI,oBAAoB,UAAU,OACrC,WAAW,UAAU,OAClB,QAAQ,UAAU;UAEd,yBAAyB,UAAU,OAC1C,YAAY,oBAAoB,IAChC,UAAU,+BAA+B,OACtC;UAEI,2BAA2B,UAAU,OAC5C,YAAY,oBAAoB,IAChC,UAAU,+BAA+B,OACtC;UAEI,2BAA2B,UAAU,OAC5C,YAAY,oBAAoB,IAChC,UAAU,+BAA+B,OACtC;UAEI,YAAY,UAAU,OAC7B,WAAW,UAAU,IACrB,OAAO,UAAU,OACd;UAEI,eAAe,UAAU,OAChC,WAAW,UAAU,IACrB,cAAc,QAAQ,UAAU,QAC7B;UAEI,kBAAkB,UAAU,OACnC,QAAQ,UAAU,IAClB,UAAU,qBAAqB,OAC5B;UAEI,kBAAkB,UAAU,OACnC,QAAQ,UAAU,IAClB,UAAU,qBAAqB,OAC5B;UAEI,eAAe,UAAU,OAChC,QAAQ,UAAU,OACf;UAGI,oBAAoB,UAAU,gBACrC,QAAQ,YAAY,OACjB,WAAW,gBAAgB;UAEvB,iBAAiB,UAAU,gBAClC,QAAQ,YAAY,IACpB,UAAU,WAAW,gBAAgB,mBAAmB,OACrD;UAEI,sBAAsB,UAAU,gBACvC,QAAQ,YAAY,OACjB;UAEI,kBAAkB,UAAU,gBACnC,QAAQ,YAAY,OACjB;;AAGP,OAAO,cAAM,2BAA2B,YAAY;CAEhD;CADF,YACE,AAAiBC,iBAAiB;CAGpC,mBAAmB,UAAU,gBAC3B,IAAI,YACJ,QAAQ,IACP,YAAY;CAIf,sBAAsB,UAAU,OAC9B,QAAQ,aACR,IAAI,UACJ,OAAO,IACN,UAAU;CAIb,AAAM,eAAe,UAAU,gBAC7B,UAAU,kBACV,QAAQ,IACP,QAAQ,YAAY;CAIvB,AAAM,oBAAoB,UAAU,gBAClC,QAAQ,YAAY,KACnB,QAAQ,cAAc;CAIzB,iBAAiB,UAAU,gBACzB,QAAQ,YAAY,IACpB,KAAK,KAAK,YAAY,IAAI,UAAU,4BACnC;CAIH,cAAc,UAAU,gBACtB,QAAQ,YAAY,IACpB,KAAK,QAAQ,YAAY,cACxB;CAIH,AAAM,kBAAkB,UAAU,OAChC,WAAW,UAAU,KACpB,QAAQ,UAAU;CAIrB,AAAM,UAAU,UAAU,OACxB,WAAW,UAAU,IACrB,OAAO,UAAU,KAChB;CAIH,AAAM,aAAa,UAAU,OAC3B,WAAW,UAAU,IACrB,cAAc,QAAQ,UAAU,MAC/B;CAKH,6BAA6B,UAAU,OACrC,QAAQ,aACR,OAAO,IACN,oBAAoB;CAKvB,UAAU,UAAU,OAClB,YAAY,oBAAoB,IAChC,IAAI,WACH,UAAU;CAIb,UAAU,UAAU,OAClB,YAAY,oBAAoB,IAChC,IAAI;CAKN,AAAM,oBAAoB,UAAU,OAClC,YAAY,oBAAoB,IAChC,IAAI,UACJ,OAAO,UAAU,KAChB;CAIH,kBAAkB,UAAU,OAC1B,YAAY,oBAAoB;CAKlC,qBAAqB,UAAU,OAC7B,YAAY,oBAAoB,KAC/B,UAAU;CAIb,gBAAgB,UAAU,OACxB,QAAQ,UAAU,IAClB,UAAU,qBAAqB,KAC9B;CAIH,gBAAgB,UAAU,OACxB,QAAQ,UAAU,IAClB,UAAU,qBAAqB,KAC9B;CAIH,uBAAuB,UAAU,OAC/B,YAAY,oBAAoB,IAChC,UAAU,+BAA+B,KACxC;CAIH,yBAAyB,UAAU,OACjC,YAAY,oBAAoB,IAChC,UAAU,+BAA+B,KACxC;CAIH,yBAAyB,UAAU,OACjC,YAAY,oBAAoB,IAChC,UAAU,+BAA+B,KACxC;CAKH,kBAAkB,UAAU,gBAC1B,QAAQ,YAAY,KACnB,WAAW,gBAAgB;CAI9B,eAAe,UAAU,gBACvB,QAAQ,YAAY,IACpB,UAAU,WAAW,gBAAgB,mBAAmB,KACvD;CAIH,AAAM,oBAAoB,UAAU,gBAClC,QAAQ,YAAY,KACnB;CAIH,AAAM,gBAAgB,UAAU,gBAC9B,QAAQ,YAAY,KACnB;CAIH,AAAM,aAAa,UAAU,OAC3B,QAAQ,UAAU,KACjB;;AAKL,OAAO,iBAAS,eAAe,KAAK,kBAAkB","names":["STATE_MODULE_KEY: ModuleKey<StateModuleImpl>","documentService: DocumentService"],"sources":["../../../src/types/StateModule.ts"],"version":3,"file":"StateModule.d.ts"}
+{"mappings":"AAgBA,cAEO,gBACA,sBACA,mBACA;AACP,cACE,eACA,YACA,kBACA,aACA,gBACA,eACA,iBACA,OACA,WACA,eACA,6BACA,qBACA,UACA,iBACK;AAEP,cACE,iBACA,sBACA,gCACA,4BACK;AAGP,OAAO,cAAM,wBAAwB;AACrC,OAAO,cAAMA,kBAAkB,UAAU;AAQzC,YAAY,gBAAgB,KAAK,IAAI;WAAY,wBAAwB;;AAEzE,iBAAiB,YAAY;UAClB,qBAAqB,UAAU,gBACtC,IAAI,YACJ,QAAQ,MACL,YAAY;UAER,wBAAwB,UAAU,OACzC,QAAQ,aACR,IAAI,UACJ,OAAO,MACJ,UAAU;UAEN,iBAAiB,UAAU,gBAClC,UAAU,kBACV,QAAQ,MACL,QAAQ,YAAY;UAEhB,kBAAkB,UAAU,gBACnC,0BACA,QAAQ,GACR,UAAU;EACR;EACA;OAEC,QAAQ,cAAc,mBAAmB;WAAW,IAAI;;UAEpD,sBAAsB,UAAU,gBACvC,QAAQ,YAAY,OACjB,QAAQ,cAAc;UAElB,aAAa,UAAU,gBAC9B,QAAQ,YAAY,IACpB,WAAW,QAAQ,YAAY,IAAI,OAAO,2BACvC;UAEI,mBAAmB,UAAU,gBACpC,QAAQ,YAAY,IACpB,KAAK,QAAQ,YAAY,IAAI,UAAU,8BACpC;UAEI,aAAa,UAAU,gBAC9B,QAAQ,YAAY,IACpB,WAAW,QAAQ,YAAY,IAAI,OAAO,wBAC1C,UAAU,gCACP;UAEI,gBAAgB,UAAU,gBACjC,QAAQ,YAAY,IACpB,KAAK,QAAQ,YAAY,gBACtB;UAEI,uBAAuB,UAAU,OACxC,QAAQ,aACR,OAAO,GACP,WAAW,UAAU;UAGd,oBAAoB,UAAU,OACrC,WAAW,UAAU,OAClB,QAAQ,UAAU;UAEd,yBAAyB,UAAU,OAC1C,YAAY,oBAAoB,IAChC,UAAU,+BAA+B,OACtC;UAEI,2BAA2B,UAAU,OAC5C,YAAY,oBAAoB,IAChC,UAAU,+BAA+B,OACtC;UAEI,2BAA2B,UAAU,OAC5C,YAAY,oBAAoB,IAChC,UAAU,+BAA+B,OACtC;UAEI,YAAY,UAAU,OAC7B,WAAW,UAAU,IACrB,OAAO,UAAU,OACd;UAEI,eAAe,UAAU,OAChC,WAAW,UAAU,IACrB,cAAc,QAAQ,UAAU,QAC7B;UAEI,kBACP,QAAQ,aACR,gBACA,cAAc;UAGP,kBAAkB,UAAU,OACnC,QAAQ,UAAU,IAClB,UAAU,qBAAqB,OAC5B;UAEI,kBAAkB,UAAU,OACnC,QAAQ,UAAU,IAClB,UAAU,qBAAqB,OAC5B;UAEI,eAAe,UAAU,OAChC,QAAQ,UAAU,OACf;UAGI,oBAAoB,UAAU,gBACrC,QAAQ,YAAY,OACjB,WAAW,gBAAgB;UAEvB,iBAAiB,UAAU,gBAClC,QAAQ,YAAY,IACpB,UAAU,WAAW,gBAAgB,mBAAmB,OACrD;UAEI,sBAAsB,UAAU,gBACvC,QAAQ,YAAY,OACjB;UAEI,kBAAkB,UAAU,gBACnC,QAAQ,YAAY,OACjB;;AAGP,OAAO,cAAM,2BAA2B,YAAY;CAEhD;CADF,YACE,AAAiBC,iBAAiB;CAGpC,mBAAmB,UAAU,gBAC3B,IAAI,YACJ,QAAQ,IACP,YAAY;CAIf,sBAAsB,UAAU,OAC9B,QAAQ,aACR,IAAI,UACJ,OAAO,IACN,UAAU;CAIb,AAAM,eAAe,UAAU,gBAC7B,UAAU,kBACV,QAAQ,IACP,QAAQ,YAAY;CAIvB,AAAM,gBAAgB,UAAU,gBAC9B,0BACA,QAAQ,GACR,UAAU;EACR;EACA;KAED,QAAQ,cAAc,mBAAmB;WAAW,IAAI;;CAI3D,AAAM,oBAAoB,UAAU,gBAClC,QAAQ,YAAY,KACnB,QAAQ,cAAc;CAIzB,WAAW,UAAU,gBACnB,QAAQ,YAAY,IACpB,WAAW,QAAQ,YAAY,IAAI,OAAO,yBACzC;CAIH,iBAAiB,UAAU,gBACzB,QAAQ,YAAY,IACpB,KAAK,KAAK,YAAY,IAAI,UAAU,4BACnC;CAIH,WAAW,UAAU,gBACnB,QAAQ,YAAY,IACpB,WAAW,QAAQ,YAAY,IAAI,OAAO,wBAC1C,UAAU,8BACT;CAIH,cAAc,UAAU,gBACtB,QAAQ,YAAY,IACpB,KAAK,QAAQ,YAAY,cACxB;CAIH,qBAAqB,UAAU,OAC7B,QAAQ,aACR,OAAO,GACP,WAAW,UAAU;CAKvB,AAAM,kBAAkB,UAAU,OAChC,WAAW,UAAU,KACpB,QAAQ,UAAU;CAIrB,AAAM,UAAU,UAAU,OACxB,WAAW,UAAU,IACrB,OAAO,UAAU,KAChB;CAIH,AAAM,aAAa,UAAU,OAC3B,WAAW,UAAU,IACrB,cAAc,QAAQ,UAAU,MAC/B;CAIH,gBACE,QAAQ,aACR,gBACA,cAAc;CAMhB,6BAA6B,UAAU,OACrC,QAAQ,aACR,OAAO,IACN,oBAAoB;CAKvB,UAAU,UAAU,OAClB,YAAY,oBAAoB,IAChC,IAAI,WACH,UAAU;CAIb,UAAU,UAAU,OAClB,YAAY,oBAAoB,IAChC,IAAI;CAKN,AAAM,oBAAoB,UAAU,OAClC,YAAY,oBAAoB,IAChC,IAAI,UACJ,OAAO,UAAU,KAChB;CAIH,kBAAkB,UAAU,OAC1B,YAAY,oBAAoB;CAKlC,qBAAqB,UAAU,OAC7B,YAAY,oBAAoB,KAC/B,UAAU;CAIb,gBAAgB,UAAU,OACxB,QAAQ,UAAU,IAClB,UAAU,qBAAqB,KAC9B;CAIH,gBAAgB,UAAU,OACxB,QAAQ,UAAU,IAClB,UAAU,qBAAqB,KAC9B;CAIH,uBAAuB,UAAU,OAC/B,YAAY,oBAAoB,IAChC,UAAU,+BAA+B,KACxC;CAIH,yBAAyB,UAAU,OACjC,YAAY,oBAAoB,IAChC,UAAU,+BAA+B,KACxC;CAIH,yBAAyB,UAAU,OACjC,YAAY,oBAAoB,IAChC,UAAU,+BAA+B,KACxC;CAKH,kBAAkB,UAAU,gBAC1B,QAAQ,YAAY,KACnB,WAAW,gBAAgB;CAI9B,eAAe,UAAU,gBACvB,QAAQ,YAAY,IACpB,UAAU,WAAW,gBAAgB,mBAAmB,KACvD;CAIH,AAAM,oBAAoB,UAAU,gBAClC,QAAQ,YAAY,KACnB;CAIH,AAAM,gBAAgB,UAAU,gBAC9B,QAAQ,YAAY,KACnB;CAIH,AAAM,aAAa,UAAU,OAC3B,QAAQ,UAAU,KACjB;;AAKL,OAAO,iBAAS,eAAe,KAAK,kBAAkB","names":["STATE_MODULE_KEY: ModuleKey<StateModuleImpl>","documentService: DocumentService"],"sources":["../../../src/types/StateModule.ts"],"version":3,"file":"StateModule.d.ts"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@palantir/pack.state.core",
-  "version": "0.1.0-beta.2",
+  "version": "0.1.1",
   "description": "PACK State logic and utilities",
   "license": "Apache-2.0",
   "repository": {
@@ -32,8 +32,8 @@
     "remeda": "^2.32.0",
     "tiny-invariant": "^1.3.3",
     "yjs": "^13.6.27",
-    "@palantir/pack.core": "0.1.0-beta.2",
-    "@palantir/pack.document-schema.model-types": "0.1.0-beta.3"
+    "@palantir/pack.document-schema.model-types": "0.1.1",
+    "@palantir/pack.core": "0.1.1"
   },
   "peerDependencies": {
     "zod": "^4.1.0"
@@ -44,7 +44,7 @@
     "tslib": "^2.8.1",
     "typescript": "^5.9.2",
     "vitest-mock-extended": "^3.1.0",
-    "@palantir/pack.monorepo.tsconfig": "~0.4.0-beta.1"
+    "@palantir/pack.monorepo.tsconfig": "~0.4.3"
   },
   "publishConfig": {
     "access": "public"
@@ -58,8 +58,8 @@
   "type": "module",
   "scripts": {
     "clean": "rimraf .turbo build dist lib test-output *.tgz tsconfig.tsbuildinfo",
-    "lint": "eslint ./src ; dprint check --config $(find-up dprint.json) --allow-no-files",
-    "lint:fix": "eslint ./src --fix ; dprint fmt --config $(find-up dprint.json) --allow-no-files",
+    "lint": "eslint ./src && dprint check --config $(find-up dprint.json) --allow-no-files",
+    "lint:fix": "eslint ./src --fix && dprint fmt --config $(find-up dprint.json) --allow-no-files",
     "test": "vitest run --passWithNoTests -u",
     "test:watch": "vitest --passWithNoTests",
     "transpileBrowser": "monorepo-transpile -f esm -m bundle -t browser",

package/src/__tests__/Transaction.test.ts

@@ -0,0 +1,321 @@
+/*
+ * Copyright 2025 Palantir Technologies, Inc. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { PackAppInternal } from "@palantir/pack.core";
+import type {
+  DocumentMetadata,
+  DocumentRef,
+  DocumentSchema,
+  Model,
+  RecordId,
+  RecordRef,
+} from "@palantir/pack.document-schema.model-types";
+import { Metadata } from "@palantir/pack.document-schema.model-types";
+import { beforeEach, describe, expect, it, vi } from "vitest";
+import type * as Y from "yjs";
+import { z } from "zod";
+import { DOCUMENT_SERVICE_MODULE_KEY } from "../DocumentServiceModule.js";
+import type { BaseYjsDocumentService } from "../service/BaseYjsDocumentService.js";
+import { getStateModule } from "../types/StateModule.js";
+import { createTestApp } from "./testUtils.js";
+
+const TEST_SECURITY = {
+  discretionary: {
+    editors: [],
+    owners: [],
+    viewers: [],
+  },
+  mandatory: {
+    classification: ["MU"],
+    markings: [],
+  },
+};
+
+interface User {
+  email: string;
+  id: string;
+  name: string;
+}
+
+const createSchemaWithRecords = () => {
+  const userSchema = z.object({
+    email: z.email(),
+    id: z.string(),
+    name: z.string(),
+  });
+
+  const UserModel: Model<User, typeof userSchema> = {
+    __type: {} as User,
+    zodSchema: userSchema,
+    [Metadata]: {
+      name: "User",
+    },
+  };
+
+  return {
+    User: UserModel,
+    [Metadata]: {
+      version: 1,
+    },
+  } as const satisfies DocumentSchema;
+};
+
+describe("Transaction Batching", () => {
+  let app: PackAppInternal;
+  let docRef: DocumentRef<ReturnType<typeof createSchemaWithRecords>>;
+  let schema: ReturnType<typeof createSchemaWithRecords>;
+
+  beforeEach(async () => {
+    app = createTestApp();
+    const stateModule = getStateModule(app);
+
+    const metadata: DocumentMetadata = {
+      documentTypeName: "TestType",
+      name: "Test Document",
+      ontologyRid: "test-ontology-rid",
+      security: TEST_SECURITY,
+    };
+
+    schema = createSchemaWithRecords();
+    docRef = await stateModule.createDocument(metadata, schema);
+  });
+
+  it("should batch multiple setRecord operations into single Y.js transaction", async () => {
+    const collection = docRef.getRecords(schema.User);
+    const stateModule = getStateModule(app);
+
+    let stateChangeCount = 0;
+    const unsubscribe = stateModule.onStateChange(docRef, () => {
+      stateChangeCount++;
+    });
+
+    await new Promise(resolve => setTimeout(resolve, 10));
+    const initialCount = stateChangeCount;
+
+    const userId1 = "user1" as RecordId;
+    const userId2 = "user2" as RecordId;
+    const userId3 = "user3" as RecordId;
+
+    docRef.withTransaction(() => {
+      void collection.set(userId1, { email: "alice@example.com", id: "user1", name: "Alice" });
+      void collection.set(userId2, { email: "bob@example.com", id: "user2", name: "Bob" });
+      void collection.set(userId3, { email: "charlie@example.com", id: "user3", name: "Charlie" });
+    });
+
+    await new Promise(resolve => setTimeout(resolve, 10));
+    expect(stateChangeCount - initialCount).toBe(1);
+
+    const record1 = collection.get(userId1)!;
+    const record2 = collection.get(userId2)!;
+    const record3 = collection.get(userId3)!;
+
+    const snapshot1 = await record1.getSnapshot();
+    const snapshot2 = await record2.getSnapshot();
+    const snapshot3 = await record3.getSnapshot();
+
+    expect(snapshot1).toEqual({ email: "alice@example.com", id: "user1", name: "Alice" });
+    expect(snapshot2).toEqual({ email: "bob@example.com", id: "user2", name: "Bob" });
+    expect(snapshot3).toEqual({ email: "charlie@example.com", id: "user3", name: "Charlie" });
+
+    unsubscribe();
+  });
+
+  it("should batch mixed operations (set, update, delete) into single transaction", async () => {
+    const collection = docRef.getRecords(schema.User);
+    const stateModule = getStateModule(app);
+
+    const userId1 = "user1" as RecordId;
+    const userId2 = "user2" as RecordId;
+    const userId3 = "user3" as RecordId;
+
+    await collection.set(userId1, { email: "alice@example.com", id: "user1", name: "Alice" });
+    await collection.set(userId2, { email: "bob@example.com", id: "user2", name: "Bob" });
+
+    let stateChangeCount = 0;
+    const unsubscribe = stateModule.onStateChange(docRef, () => {
+      stateChangeCount++;
+    });
+
+    await new Promise(resolve => setTimeout(resolve, 10));
+    const initialCount = stateChangeCount;
+
+    const record1 = collection.get(userId1)!;
+
+    docRef.withTransaction(() => {
+      void stateModule.updateRecord(record1, { name: "Alice Updated" });
+      void collection.delete(userId2);
+      void collection.set(userId3, { email: "charlie@example.com", id: "user3", name: "Charlie" });
+    });
+
+    await new Promise(resolve => setTimeout(resolve, 10));
+    expect(stateChangeCount - initialCount).toBe(1);
+
+    const snapshot1 = await record1.getSnapshot();
+    expect(snapshot1.name).toBe("Alice Updated");
+
+    const record3 = collection.get(userId3)!;
+    const snapshot3 = await record3.getSnapshot();
+    expect(snapshot3).toEqual({ email: "charlie@example.com", id: "user3", name: "Charlie" });
+
+    unsubscribe();
+  });
+
+  it("should trigger collection callbacks once after transaction completes", async () => {
+    const collection = docRef.getRecords(schema.User);
+    const stateModule = getStateModule(app);
+
+    const addedCallback = vi.fn();
+    const unsubscribe = stateModule.onCollectionItemsAdded(collection, addedCallback);
+
+    const userId1 = "user1" as RecordId;
+    const userId2 = "user2" as RecordId;
+    const userId3 = "user3" as RecordId;
+
+    docRef.withTransaction(() => {
+      void collection.set(userId1, { email: "alice@example.com", id: "user1", name: "Alice" });
+      void collection.set(userId2, { email: "bob@example.com", id: "user2", name: "Bob" });
+      void collection.set(userId3, { email: "charlie@example.com", id: "user3", name: "Charlie" });
+    });
+
+    await new Promise(resolve => setTimeout(resolve, 10));
+
+    expect(addedCallback).toHaveBeenCalledTimes(1);
+    const addedRecords = addedCallback.mock.calls[0]?.[0] as readonly RecordRef[] | undefined;
+    expect(addedRecords).toBeDefined();
+    expect(addedRecords).toHaveLength(3);
+
+    unsubscribe();
+  });
+
+  it("should handle nested transactions correctly (Y.js transact is reentrant)", async () => {
+    const collection = docRef.getRecords(schema.User);
+    const stateModule = getStateModule(app);
+
+    let stateChangeCount = 0;
+    const unsubscribe = stateModule.onStateChange(docRef, () => {
+      stateChangeCount++;
+    });
+
+    await new Promise(resolve => setTimeout(resolve, 10));
+    const initialCount = stateChangeCount;
+
+    const userId1 = "user1" as RecordId;
+    const userId2 = "user2" as RecordId;
+
+    docRef.withTransaction(() => {
+      void collection.set(userId1, { email: "alice@example.com", id: "user1", name: "Alice" });
+
+      docRef.withTransaction(() => {
+        void collection.set(userId2, { email: "bob@example.com", id: "user2", name: "Bob" });
+      });
+    });
+
+    await new Promise(resolve => setTimeout(resolve, 10));
+    expect(stateChangeCount - initialCount).toBe(1);
+
+    const record1 = collection.get(userId1)!;
+    const record2 = collection.get(userId2)!;
+
+    const snapshot1 = await record1.getSnapshot();
+    const snapshot2 = await record2.getSnapshot();
+
+    expect(snapshot1).toEqual({ email: "alice@example.com", id: "user1", name: "Alice" });
+    expect(snapshot2).toEqual({ email: "bob@example.com", id: "user2", name: "Bob" });
+
+    unsubscribe();
+  });
+
+  it("should work correctly when operations are called without transaction", async () => {
+    const collection = docRef.getRecords(schema.User);
+    const stateModule = getStateModule(app);
+
+    let stateChangeCount = 0;
+    const unsubscribe = stateModule.onStateChange(docRef, () => {
+      stateChangeCount++;
+    });
+
+    await new Promise(resolve => setTimeout(resolve, 10));
+    const initialCount = stateChangeCount;
+
+    const userId1 = "user1" as RecordId;
+    const userId2 = "user2" as RecordId;
+
+    await collection.set(userId1, { email: "alice@example.com", id: "user1", name: "Alice" });
+    await collection.set(userId2, { email: "bob@example.com", id: "user2", name: "Bob" });
+
+    await new Promise(resolve => setTimeout(resolve, 10));
+    expect(stateChangeCount - initialCount).toBe(2);
+
+    const record1 = collection.get(userId1)!;
+    const record2 = collection.get(userId2)!;
+
+    const snapshot1 = await record1.getSnapshot();
+    const snapshot2 = await record2.getSnapshot();
+
+    expect(snapshot1).toEqual({ email: "alice@example.com", id: "user1", name: "Alice" });
+    expect(snapshot2).toEqual({ email: "bob@example.com", id: "user2", name: "Bob" });
+
+    unsubscribe();
+  });
+
+  it("should handle empty transaction", () => {
+    let transactionRan = false;
+
+    docRef.withTransaction(() => {
+      transactionRan = true;
+    });
+
+    expect(transactionRan).toBe(true);
+  });
+
+  it("should pass description as origin to Y.js transaction", async () => {
+    const collection = docRef.getRecords(schema.User);
+    const documentService = app.getModule(DOCUMENT_SERVICE_MODULE_KEY);
+
+    const userId1 = "user1" as RecordId;
+    const userData = { email: "alice@example.com", id: "user1", name: "Alice" };
+
+    const description = {
+      data: userData,
+      model: schema.User,
+    };
+
+    let capturedOrigin: unknown = undefined;
+
+    const yDoc = (documentService as BaseYjsDocumentService)
+      .getYDocForTesting(docRef.id);
+
+    if (!yDoc) {
+      throw new Error("Document not found");
+    }
+
+    const updateHandler = (_update: Uint8Array, origin: unknown, _doc: Y.Doc) => {
+      capturedOrigin = origin;
+    };
+
+    yDoc.on("update", updateHandler);
+
+    docRef.withTransaction(() => {
+      void collection.set(userId1, userData);
+    }, description);
+
+    await new Promise(resolve => setTimeout(resolve, 10));
+
+    expect(capturedOrigin).toEqual(description);
+
+    yDoc.off("update", updateHandler);
+  });
+});

package/src/__tests__/testUtils.ts

@@ -46,8 +46,7 @@ export function createTestApp(
       logger: config.logger ?? consoleLogger({}),
       osdkClient: mockClient,
       remote: {
-        packApiPath: "/pack/api",
-        packWsPath: "/pack/ws",
+        packWsPath: "/api/v2/packSubscriptions",
         baseUrl: "http://localhost",
         fetchFn: fetch,
         ...config.remote,