@palantir/pack.state.core 0.2.2 → 0.3.0

package/build/types/service/BaseYjsDocumentService.d.ts

@@ -2,7 +2,8 @@ import type { Logger } from "@osdk/api";
 import type { PackAppInternal, Unsubscribe } from "@palantir/pack.core";
 import { type ActivityEvent, type DocumentId, type DocumentMetadata, type DocumentRef, type DocumentSchema, type DocumentState, type EditDescription, type Model, type ModelData, type PresenceEvent, type RecordCollectionRef, type RecordId, type RecordRef } from "@palantir/pack.document-schema.model-types";
 import * as Y from "yjs";
-import type { DocumentMetadataChangeCallback, DocumentService, DocumentStateChangeCallback, DocumentStatus, DocumentStatusChangeCallback, DocumentSyncStatus, RecordChangeCallback, RecordCollectionChangeCallback, RecordDeleteCallback } from "../types/DocumentService.js";
+import type { CreateDocumentMetadata } from "../types/CreateDocumentMetadata.js";
+import type { DocumentMetadataChangeCallback, DocumentService, DocumentStateChangeCallback, DocumentStatus, DocumentStatusChangeCallback, DocumentSyncStatus, RecordChangeCallback, RecordCollectionChangeCallback, RecordDeleteCallback, SearchDocumentsResult } from "../types/DocumentService.js";
 import { DocumentLiveStatus, DocumentLoadStatus } from "../types/DocumentService.js";
 export interface RecordCollectionSubscriptions<M extends Model = Model> {
 	added?: Set<RecordCollectionChangeCallback<M>>;
@@ -42,6 +43,9 @@ export interface InternalYjsDoc {
 	readonly statusSubscribers: Set<DocumentStatusChangeCallback>;
 	readonly yjsCollectionHandlers: Map<string, () => void>;
 }
+export interface BaseYjsDocumentServiceOptions {
+	readonly isDemo?: boolean;
+}
 /**
 * Base class for document services that use Y.js for local state management.
 * Provides common Y.js operations for both in-memory and backend services.
@@ -52,20 +56,20 @@ export declare abstract class BaseYjsDocumentService<TDoc extends InternalYjsDoc
 	protected readonly app: PackAppInternal;
 	protected readonly logger: Logger;
 	protected readonly documents: Map<DocumentId, TDoc>;
-	constructor(app: PackAppInternal, logger: Logger);
+	protected readonly isDemo?: boolean;
+	constructor(app: PackAppInternal, logger: Logger, options?: BaseYjsDocumentServiceOptions);
 	abstract get hasMetadataSubscriptions(): boolean;
 	abstract get hasStateSubscriptions(): boolean;
-	abstract readonly createDocument: <T extends DocumentSchema>(metadata: DocumentMetadata, schema: T) => Promise<DocumentRef<T>>;
+	abstract readonly createDocument: <T extends DocumentSchema>(metadata: CreateDocumentMetadata, schema: T) => Promise<DocumentRef<T>>;
 	abstract readonly searchDocuments: <T extends DocumentSchema>(documentTypeName: string, schema: T, options?: {
 		documentName?: string;
-		limit?: number;
-	}) => Promise<ReadonlyArray<DocumentMetadata & {
-		readonly id: DocumentId;
-	}>>;
+		pageSize?: number;
+		pageToken?: string;
+	}) => Promise<SearchDocumentsResult>;
 	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>;
-	protected abstract createInternalDoc(ref: DocumentRef, metadata?: DocumentMetadata, yDoc?: Y.Doc): TDoc;
+	protected abstract createInternalDoc(ref: DocumentRef, metadata?: CreateDocumentMetadata, yDoc?: Y.Doc): TDoc;
 	/**
 	* Called when the first metadata subscription is opened for a document.
 	* Implementation must:
@@ -119,7 +123,7 @@ export declare abstract class BaseYjsDocumentService<TDoc extends InternalYjsDoc
 	/**
 	* Get existing internal doc or create one with placeholder metadata for lazy initialization
 	*/
-	protected getCreateInternalDoc<T extends DocumentSchema>(ref: DocumentRef<T>, metadata?: DocumentMetadata, initialYDoc?: Y.Doc): {
+	protected getCreateInternalDoc<T extends DocumentSchema>(ref: DocumentRef<T>, metadata?: CreateDocumentMetadata, initialYDoc?: Y.Doc): {
 		internalDocRef: DocumentRef<T>;
 		internalDoc: TDoc;
 		wasExisting: boolean;

package/build/types/service/BaseYjsDocumentService.d.ts.map

@@ -1 +1 @@
-{"mappings":"AAkBA,cAAc,cAAc;AAC5B,cAAc,iBAAiB,mBAAmB;AAClD,cACO,oBACA,iBACA,uBACA,kBACA,qBACA,oBACA,sBAEA,YACA,gBACA,oBACA,0BACA,eACA,iBACA;AAGP,YAAY,OAAO;AAEnB,cACE,gCACA,iBACA,6BACA,gBACA,8BACA,oBACA,sBACA,gCACA,4BACK;AACP,SAAS,oBAAoB,0BAA0B;AAKvD,iBAAiB,8BAA8B,UAAU,QAAQ,OAAO;CACtE,QAAQ,IAAI,+BAA+B;CAC3C,UAAU,IAAI,+BAA+B;CAC7C,UAAU,IAAI,+BAA+B;;AAG/C,iBAAiB,kBAAkB,UAAU,QAAQ,OAAO;UACjD,KAAK,UAAU;CACxB,UAAU,IAAI,qBAAqB;CACnC,UAAU,IAAI,qBAAqB;;AAGrC,iBAAiB,eAAe;;;;;;;;CAQ9B,KAAK,QAAQ;CACb,WAAW;UACF,QAAQ;UACR,MAAM,EAAE;CACjB;CAGA,gBAAgB;CAChB,YAAY;CACZ;CACA;CAIA;CACA;UAGS,gBAAgB,YAAY,QAAQ;UACpC,YAAY,YAAY,IAAI,UAAU,QAAQ;UAG9C,yBAAyB,YAAY;UACrC,qBAAqB,IAAI;UACzB,qBAAqB,IAAI,UAAU;UACnC,qBAAqB,IAAI;UACzB,mBAAmB,IAAI;UAEvB,uBAAuB;;;;;;;;AASlC,OAAO,uBAAe,uBAAuB,aAAa,iBAAiB,2BAC9D,gBACb;CAII,wBAAwB;CACxB,2BAA2B;CAJ7B,mBAAmB,WAAW,IAAI,YAAY;CAE9C,YACE,AAAmBA,KAAK,iBACxB,AAAmBC,QAAQ;CAG7B,aAAa;CACb,aAAa;CACb,kBAAkB,iBAAiB,UAAU,gBAC3C,UAAU,kBACV,QAAQ,MACL,QAAQ,YAAY;CACzB,kBAAkB,kBAAkB,UAAU,gBAC5C,0BACA,QAAQ,GACR,UAAU;EACR;EACA;OAEC,QAAQ,cAAc,mBAAmB;WAAW,IAAI;;CAE7D,SAAS,qBAAsB,UAAU,gBACvC,IAAI,YACJ,QAAQ,MACP,YAAY;CAQf,SAAS,qCAAsC,UAAU,OACvD,QAAQ,aACR,OAAO,MACN,oBAAoB;CAcvB,SAAS,2BAA4B,UAAU,OAC7C,QAAQ,aACR,IAAI,UACJ,OAAO,MACN,UAAU;CAoBb,mBAAmB,kBACjB,KAAK,aACL,WAAW,kBACX,OAAO,EAAE,MACR;;;;;;;;;CAUH,mBAAmB,6BACjB,aAAa,MACb,QAAQ;;;;;;;;;CAWV,mBAAmB,yBACjB,aAAa,MACb,QAAQ;;;;;CAOV,mBAAmB,6BACjB,aAAa,MACb,QAAQ;;;;;CAOV,mBAAmB,yBACjB,aAAa,MACb,QAAQ;CAGV,mBAAmB,wBAAyB,UAAU,gBACpD,KAAK,YAAY,IACjB,UAAU,iCACT;CA+BH,UAAU,iBAAiB,aAAa;CAgBxC,UAAU,wBACR,aAAa,MACb,QAAQ;CAaV,UAAU,qBACR,aAAa,MACb,QAAQ,aACR,QAAQ;EACN,OAAO;EACP,OAAO;EACP;;CAkBJ,UAAU,iBACR,aAAa,MACb,QAAQ,aACR,QAAQ;EACN,OAAO;EACP,OAAO;EACP;;;;;;CAsBJ,UAAU,aAAa,UAAU,OAC/B,WAAW,UAAU,IACrB,OAAO,UAAU;;;;CAMnB,UAAU,eAAe,QAAQ,iBAAiB,EAAE;;;;CASpD,UAAU,qBAAqB,UAAU,gBACvC,KAAK,YAAY,IACjB,WAAW,kBACX,cAAc,EAAE,MACf;EAAE,gBAAgB,YAAY;EAAI,aAAa;EAAM;;CA8BxD,SAAS,sBAAuB,UAAU,gBACxC,QAAQ,YAAY,OACnB,QAAQ,cAAc;CAQzB,SAAS,oBAAqB,UAAU,OACtC,WAAW,UAAU,OACpB,QAAQ,UAAU;CAcrB,UAAU,0BAA0B,UAAU,OAC5C,aAAa,MACb,WAAW,UAAU,KACpB,UAAU;CAQb,SAAS,YAAa,UAAU,OAC9B,WAAW,UAAU,IACrB,OAAO,UAAU,OAChB;CAuBH,SAAS,eAAgB,UAAU,OACjC,WAAW,UAAU,IACrB,cAAc,QAAQ,UAAU,QAC/B;CAwBH,SAAS,kBACP,QAAQ,aACR,gBACA,cAAc;CAWhB,iBAAiB,UAAU,gBACzB,QAAQ,YAAY,IACpB,UAAU,+BAA+B,KACxC;CA+BH,SAAS,WAAW,UAAU,gBAC5B,QAAQ,YAAY,IACpB,WAAW,QAAQ,YAAY,IAAI,OAAO,yBACzC;CAEH,SAAS,WAAW,UAAU,gBAC5B,QAAQ,YAAY,IACpB,WAAW,QAAQ,YAAY,IAAI,OAAO,yBACzC;CAEH,SAAS,qBAAqB,UAAU,OACtC,QAAQ,aACR,OAAO,GACP,WAAW,UAAU;CAGvB,SAAS,gBAAiB,UAAU,gBAClC,QAAQ,YAAY,IACpB,UAAU,4BAA4B,OACrC;CAoDH,UAAU,eAAe,OAAO,aAAa;CAO7C,UAAU,0BACR,aAAa,MACb,QAAQ,aACR,UAAU;CAOZ,UAAU,uBAAuB,aAAa,MAAM,QAAQ;CAM5D,eAAe,OAAO,YAAY,UAAU;CAW5C,UAAU,4BAA4B,UAAU,OAC9C,aAAa,MACb,YAAY,oBAAoB,IAChC,UAAU,UACV,YAAY,UAAU,YAAY;CA2BpC,UAAU,wBAAwB,UAAU,OAC1C,WAAW,UAAU,IACrB,YAAY,YAAY;CAkD1B,SAAS,YAAa,UAAU,OAC9B,YAAY,oBAAoB,IAChC,IAAI,aACH,UAAU;CAYb,SAAS,YAAa,UAAU,OAC9B,YAAY,oBAAoB,IAChC,IAAI;CASN,SAAS,sBAAuB,UAAU,OACxC,YAAY,oBAAoB,IAChC,IAAI,UACJ,OAAO,UAAU,OAChB;CAMH,SAAS,eAAgB,UAAU,OACjC,QAAQ,UAAU,OACjB;CAkBH,SAAS,oBAAqB,UAAU,OACtC,YAAY,oBAAoB;CASlC,SAAS,uBAAwB,UAAU,OACzC,YAAY,oBAAoB,OAC/B,UAAU;CAUb,SAAS,yBAA0B,UAAU,OAC3C,YAAY,oBAAoB,IAChC,UAAU,+BAA+B,OACxC;CAWH,SAAS,2BAA4B,UAAU,OAC7C,YAAY,oBAAoB,IAChC,UAAU,+BAA+B,OACxC;CAWH,SAAS,2BAA4B,UAAU,OAC7C,YAAY,oBAAoB,IAChC,UAAU,+BAA+B,OACxC;CAYH,SAAS,kBAAmB,UAAU,OACpC,QAAQ,UAAU,IAClB,UAAU,qBAAqB,OAC9B;CAsDH,SAAS,kBAAmB,UAAU,OACpC,QAAQ,UAAU,IAClB,UAAU,qBAAqB,OAC9B;CA4CH,QAAQ;CAaR,QAAQ;CAwBR,QAAQ;CA+CR,QAAQ;CAsHR,QAAQ;CAaR,QAAQ;CAyBR,SAAS,oBAAqB,UAAU,gBACtC,QAAQ,YAAY,OACnB;CAUH,SAAS,iBAAkB,UAAU,gBACnC,QAAQ,YAAY,IACpB,UAAU,iCACT;CAqBH,SAAS,sBAA6B,UAAU,gBAC9C,QAAQ,YAAY,OACnB;CAyBH,SAAS,kBAAyB,UAAU,gBAC1C,QAAQ,YAAY,OACnB","names":["app: PackAppInternal","logger: Logger"],"sources":["../../../src/service/BaseYjsDocumentService.ts"],"version":3,"file":"BaseYjsDocumentService.d.ts"}
+{"mappings":"AAkBA,cAAc,cAAc;AAC5B,cAAc,iBAAiB,mBAAmB;AAClD,cACO,oBACA,iBACA,uBACA,kBACA,qBACA,oBACA,sBAEA,YACA,gBACA,oBACA,0BACA,eACA,iBACA;AAGP,YAAY,OAAO;AACnB,cAAc,8BAA8B;AAE5C,cACE,gCACA,iBACA,6BACA,gBACA,8BACA,oBACA,sBACA,gCACA,sBACA,6BACK;AACP,SAAS,oBAAoB,0BAA0B;AAKvD,iBAAiB,8BAA8B,UAAU,QAAQ,OAAO;CACtE,QAAQ,IAAI,+BAA+B;CAC3C,UAAU,IAAI,+BAA+B;CAC7C,UAAU,IAAI,+BAA+B;;AAG/C,iBAAiB,kBAAkB,UAAU,QAAQ,OAAO;UACjD,KAAK,UAAU;CACxB,UAAU,IAAI,qBAAqB;CACnC,UAAU,IAAI,qBAAqB;;AAGrC,iBAAiB,eAAe;;;;;;;;CAQ9B,KAAK,QAAQ;CACb,WAAW;UACF,QAAQ;UACR,MAAM,EAAE;CACjB;CAGA,gBAAgB;CAChB,YAAY;CACZ;CACA;CAIA;CACA;UAGS,gBAAgB,YAAY,QAAQ;UACpC,YAAY,YAAY,IAAI,UAAU,QAAQ;UAG9C,yBAAyB,YAAY;UACrC,qBAAqB,IAAI;UACzB,qBAAqB,IAAI,UAAU;UACnC,qBAAqB,IAAI;UACzB,mBAAmB,IAAI;UAEvB,uBAAuB;;AAGlC,iBAAiB,8BAA8B;UACpC;;;;;;;;AASX,OAAO,uBAAe,uBAAuB,aAAa,iBAAiB,2BAC9D,gBACb;CAKI,wBAAwB;CACxB,2BAA2B;CAL7B,mBAAmB,WAAW,IAAI,YAAY;CAC9C,mBAAmB;CAEnB,YACE,AAAmBA,KAAK,iBACxB,AAAmBC,QAAQ,QAC3B,UAAU;CAKZ,aAAa;CACb,aAAa;CACb,kBAAkB,iBAAiB,UAAU,gBAC3C,UAAU,wBACV,QAAQ,MACL,QAAQ,YAAY;CACzB,kBAAkB,kBAAkB,UAAU,gBAC5C,0BACA,QAAQ,GACR,UAAU;EACR;EACA;EACA;OAEC,QAAQ;CAEb,SAAS,qBAAsB,UAAU,gBACvC,IAAI,YACJ,QAAQ,MACP,YAAY;CAQf,SAAS,qCAAsC,UAAU,OACvD,QAAQ,aACR,OAAO,MACN,oBAAoB;CAcvB,SAAS,2BAA4B,UAAU,OAC7C,QAAQ,aACR,IAAI,UACJ,OAAO,MACN,UAAU;CAoBb,mBAAmB,kBACjB,KAAK,aACL,WAAW,wBACX,OAAO,EAAE,MACR;;;;;;;;;CAUH,mBAAmB,6BACjB,aAAa,MACb,QAAQ;;;;;;;;;CAWV,mBAAmB,yBACjB,aAAa,MACb,QAAQ;;;;;CAOV,mBAAmB,6BACjB,aAAa,MACb,QAAQ;;;;;CAOV,mBAAmB,yBACjB,aAAa,MACb,QAAQ;CAGV,mBAAmB,wBAAyB,UAAU,gBACpD,KAAK,YAAY,IACjB,UAAU,iCACT;CA+BH,UAAU,iBAAiB,aAAa;CAgBxC,UAAU,wBACR,aAAa,MACb,QAAQ;CAaV,UAAU,qBACR,aAAa,MACb,QAAQ,aACR,QAAQ;EACN,OAAO;EACP,OAAO;EACP;;CAmBJ,UAAU,iBACR,aAAa,MACb,QAAQ,aACR,QAAQ;EACN,OAAO;EACP,OAAO;EACP;;;;;;CAuBJ,UAAU,aAAa,UAAU,OAC/B,WAAW,UAAU,IACrB,OAAO,UAAU;;;;CAMnB,UAAU,eAAe,QAAQ,iBAAiB,EAAE;;;;CASpD,UAAU,qBAAqB,UAAU,gBACvC,KAAK,YAAY,IACjB,WAAW,wBACX,cAAc,EAAE,MACf;EAAE,gBAAgB,YAAY;EAAI,aAAa;EAAM;;CA8BxD,SAAS,sBAAuB,UAAU,gBACxC,QAAQ,YAAY,OACnB,QAAQ,cAAc;CAQzB,SAAS,oBAAqB,UAAU,OACtC,WAAW,UAAU,OACpB,QAAQ,UAAU;CAcrB,UAAU,0BAA0B,UAAU,OAC5C,aAAa,MACb,WAAW,UAAU,KACpB,UAAU;CAQb,SAAS,YAAa,UAAU,OAC9B,WAAW,UAAU,IACrB,OAAO,UAAU,OAChB;CAuBH,SAAS,eAAgB,UAAU,OACjC,WAAW,UAAU,IACrB,cAAc,QAAQ,UAAU,QAC/B;CAwBH,SAAS,kBACP,QAAQ,aACR,gBACA,cAAc;CAWhB,iBAAiB,UAAU,gBACzB,QAAQ,YAAY,IACpB,UAAU,+BAA+B,KACxC;CA+BH,SAAS,WAAW,UAAU,gBAC5B,QAAQ,YAAY,IACpB,WAAW,QAAQ,YAAY,IAAI,OAAO,yBACzC;CAEH,SAAS,WAAW,UAAU,gBAC5B,QAAQ,YAAY,IACpB,WAAW,QAAQ,YAAY,IAAI,OAAO,yBACzC;CAEH,SAAS,qBAAqB,UAAU,OACtC,QAAQ,aACR,OAAO,GACP,WAAW,UAAU;CAGvB,SAAS,gBAAiB,UAAU,gBAClC,QAAQ,YAAY,IACpB,UAAU,4BAA4B,OACrC;CAoDH,UAAU,eAAe,OAAO,aAAa;CAO7C,UAAU,0BACR,aAAa,MACb,QAAQ,aACR,UAAU;CAOZ,UAAU,uBAAuB,aAAa,MAAM,QAAQ;CAM5D,eAAe,OAAO,YAAY,UAAU;CAW5C,UAAU,4BAA4B,UAAU,OAC9C,aAAa,MACb,YAAY,oBAAoB,IAChC,UAAU,UACV,YAAY,UAAU,YAAY;CA2BpC,UAAU,wBAAwB,UAAU,OAC1C,WAAW,UAAU,IACrB,YAAY,YAAY;CAkD1B,SAAS,YAAa,UAAU,OAC9B,YAAY,oBAAoB,IAChC,IAAI,aACH,UAAU;CAYb,SAAS,YAAa,UAAU,OAC9B,YAAY,oBAAoB,IAChC,IAAI;CASN,SAAS,sBAAuB,UAAU,OACxC,YAAY,oBAAoB,IAChC,IAAI,UACJ,OAAO,UAAU,OAChB;CAMH,SAAS,eAAgB,UAAU,OACjC,QAAQ,UAAU,OACjB;CAkBH,SAAS,oBAAqB,UAAU,OACtC,YAAY,oBAAoB;CASlC,SAAS,uBAAwB,UAAU,OACzC,YAAY,oBAAoB,OAC/B,UAAU;CAUb,SAAS,yBAA0B,UAAU,OAC3C,YAAY,oBAAoB,IAChC,UAAU,+BAA+B,OACxC;CAWH,SAAS,2BAA4B,UAAU,OAC7C,YAAY,oBAAoB,IAChC,UAAU,+BAA+B,OACxC;CAWH,SAAS,2BAA4B,UAAU,OAC7C,YAAY,oBAAoB,IAChC,UAAU,+BAA+B,OACxC;CAYH,SAAS,kBAAmB,UAAU,OACpC,QAAQ,UAAU,IAClB,UAAU,qBAAqB,OAC9B;CAsDH,SAAS,kBAAmB,UAAU,OACpC,QAAQ,UAAU,IAClB,UAAU,qBAAqB,OAC9B;CA4CH,QAAQ;CAaR,QAAQ;CAwBR,QAAQ;CA+CR,QAAQ;CAsHR,QAAQ;CAaR,QAAQ;CAyBR,SAAS,oBAAqB,UAAU,gBACtC,QAAQ,YAAY,OACnB;CAUH,SAAS,iBAAkB,UAAU,gBACnC,QAAQ,YAAY,IACpB,UAAU,iCACT;CAqBH,SAAS,sBAA6B,UAAU,gBAC9C,QAAQ,YAAY,OACnB;CAyBH,SAAS,kBAAyB,UAAU,gBAC1C,QAAQ,YAAY,OACnB","names":["app: PackAppInternal","logger: Logger"],"sources":["../../../src/service/BaseYjsDocumentService.ts"],"version":3,"file":"BaseYjsDocumentService.d.ts"}

package/build/types/service/InMemoryDocumentService.d.ts.map

@@ -1 +1 @@
-{"mappings":"AAgBA,cAAc,mBAAmB,uBAAoC;AAerE,cAAc,uBAAuB;AAGrC,SAAS,8BAA8B;AAEvC,iBAAiB,+BAA+B;;;;;UAKrC;;AAGX,OAAO,iBAAS,oCACd,EAAE,wBAA8B,iCAC/B,kBAAkB;AAQrB,OAAO,iBAAS,sCACd,KAAK,iBACL,SAAS,iCACR","names":[],"sources":["../../../src/service/InMemoryDocumentService.ts"],"version":3,"file":"InMemoryDocumentService.d.ts"}
+{"mappings":"AAgBA,cAAc,mBAAmB,uBAAoC;AAgBrE,cAAc,uBAA8C;AAG5D,SAAS,8BAA8B;AAEvC,iBAAiB,+BAA+B;;;;;UAKrC;;AAGX,OAAO,iBAAS,oCACd,EAAE,wBAA8B,iCAC/B,kBAAkB;AAQrB,OAAO,iBAAS,sCACd,KAAK,iBACL,SAAS,iCACR","names":[],"sources":["../../../src/service/InMemoryDocumentService.ts"],"version":3,"file":"InMemoryDocumentService.d.ts"}

package/build/types/types/CreateDocumentMetadata.d.ts

@@ -0,0 +1,6 @@
+import type { DocumentSecurity } from "@palantir/pack.document-schema.model-types";
+export interface CreateDocumentMetadata {
+	readonly name: string;
+	readonly documentTypeName: string;
+	readonly security?: DocumentSecurity;
+}

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

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cAAc,wBAAwB;AAEtC,iBAAiB,uBAAuB;UAC7B;UACA;UACA,WAAW","names":[],"sources":["../../../src/types/CreateDocumentMetadata.ts"],"version":3,"file":"CreateDocumentMetadata.d.ts"}

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

@@ -1,5 +1,6 @@
 import type { Unsubscribe } from "@palantir/pack.core";
 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 { CreateDocumentMetadata } from "./CreateDocumentMetadata.js";
 export declare const DocumentLoadStatus: {
 	readonly UNLOADED: "unloaded";
 	readonly LOADING: "loading";
@@ -16,6 +17,11 @@ export declare const DocumentLiveStatus: {
 export type DocumentLiveStatus = typeof DocumentLiveStatus[keyof typeof DocumentLiveStatus];
 export type DocumentSyncStatus = {
 	readonly error?: unknown;
+	/**
+	* When true, indicates this is a demo/test service not connected to real Foundry.
+	* UI can use this to display a badge or indicator that data is local-only.
+	*/
+	readonly isDemo?: boolean;
 	readonly live: DocumentLiveStatus;
 	readonly load: DocumentLoadStatus;
 };
@@ -32,6 +38,15 @@ export type RecordCollectionChangeCallback<M extends Model = Model> = (items: re
 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;
 /**
+* Result of a document search operation, including pagination information.
+*/
+export interface SearchDocumentsResult {
+	readonly data: ReadonlyArray<DocumentMetadata & {
+		readonly id: DocumentId;
+	}>;
+	readonly nextPageToken?: string;
+}
+/**
 * 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.
@@ -41,13 +56,12 @@ export type RecordDeleteCallback<M extends Model = Model> = (record: RecordRef<M
 export interface DocumentService {
 	readonly hasMetadataSubscriptions: boolean;
 	readonly hasStateSubscriptions: boolean;
-	readonly createDocument: <T extends DocumentSchema>(metadata: DocumentMetadata, schema: T) => Promise<DocumentRef<T>>;
+	readonly createDocument: <T extends DocumentSchema>(metadata: CreateDocumentMetadata, 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;
-	}>>;
+		pageSize?: number;
+		pageToken?: string;
+	}) => Promise<SearchDocumentsResult>;
 	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>;

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

@@ -1 +1 @@
-{"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"}
+{"mappings":"AAgBA,cAAc,mBAAmB;AACjC,cACE,eACA,YACA,kBACA,aACA,gBACA,eACA,iBACA,OACA,WACA,eACA,6BACA,qBACA,UACA,iBACK;AACP,cAAc,8BAA8B;AAE5C,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;;;;;UAKA;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;;;;AAMpB,iBAAiB,sBAAsB;UAC5B,MAAM,cAAc,mBAAmB;WAAW,IAAI;;UACtD;;;;;;;;;AAUX,iBAAiB,gBAAgB;UACtB;UACA;UAEA,iBAAiB,UAAU,gBAClC,UAAU,wBACV,QAAQ,MACL,QAAQ,YAAY;UAEhB,kBAAkB,UAAU,gBACnC,0BACA,QAAQ,GACR,UAAU;EACR;EACA;EACA;OAEC,QAAQ;UAEJ,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/StateModule.d.ts

@@ -1,6 +1,7 @@
-import { type ModuleKey, type PackAppInternal, type Unsubscribe } from "@palantir/pack.core";
+import type { ModuleKey, PackApp, PackAppInternal, Unsubscribe } from "@palantir/pack.core";
 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";
+import type { CreateDocumentMetadata } from "./CreateDocumentMetadata.js";
+import type { DocumentService, RecordChangeCallback, RecordCollectionChangeCallback, RecordDeleteCallback, SearchDocumentsResult } from "./DocumentService.js";
 export declare const STATE_MODULE_ACCESSOR = "state";
 export declare const STATE_MODULE_KEY: ModuleKey<StateModuleImpl>;
 export type WithStateModule<T> = T & {
@@ -9,13 +10,12 @@ export type WithStateModule<T> = T & {
 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 createDocument: <T extends DocumentSchema>(metadata: CreateDocumentMetadata, 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;
-	}>>;
+		pageSize?: number;
+		pageToken?: string;
+	}) => Promise<SearchDocumentsResult>;
 	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;
@@ -42,13 +42,12 @@ export declare class StateModuleImpl implements StateModule {
 	constructor(documentService: DocumentService);
 	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>>;
+	createDocument<T extends DocumentSchema>(metadata: CreateDocumentMetadata, schema: T): Promise<DocumentRef<T>>;
 	searchDocuments<T extends DocumentSchema>(documentTypeName: string, schema: T, options?: {
 		documentName?: string;
-		limit?: number;
-	}): Promise<ReadonlyArray<DocumentMetadata & {
-		readonly id: DocumentId;
-	}>>;
+		pageSize?: number;
+		pageToken?: string;
+	}): Promise<SearchDocumentsResult>;
 	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;
@@ -76,4 +75,4 @@ export declare class StateModuleImpl implements StateModule {
 	waitForDataLoad<T extends DocumentSchema>(docRef: DocumentRef<T>): Promise<void>;
 	deleteRecord<M extends Model>(record: RecordRef<M>): Promise<void>;
 }
-export declare function getStateModule(app: PackAppInternal): StateModule;
+export declare function getStateModule(app: PackApp | PackAppInternal): StateModule;

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

@@ -1 +1 @@
-{"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"}
+{"mappings":"AAgBA,cAAc,WAAW,SAAS,iBAAiB,mBAAmB;AAEtE,cACE,eACA,YACA,kBACA,aACA,gBACA,eACA,iBACA,OACA,WACA,eACA,6BACA,qBACA,UACA,iBACK;AAEP,cAAc,8BAA8B;AAC5C,cACE,iBACA,sBACA,gCACA,sBACA,6BACK;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,wBACV,QAAQ,MACL,QAAQ,YAAY;UAEhB,kBAAkB,UAAU,gBACnC,0BACA,QAAQ,GACR,UAAU;EACR;EACA;EACA;OAEC,QAAQ;UAEJ,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,wBACV,QAAQ,IACP,QAAQ,YAAY;CAIvB,AAAM,gBAAgB,UAAU,gBAC9B,0BACA,QAAQ,GACR,UAAU;EACR;EACA;EACA;KAED,QAAQ;CAIX,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,UAAU,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.2.2",
+  "version": "0.3.0",
   "description": "PACK State logic and utilities",
   "license": "Apache-2.0",
   "repository": {
@@ -28,21 +28,21 @@
     }
   },
   "dependencies": {
-    "@osdk/api": "~2.4.2",
+    "@osdk/api": "~2.5.2",
     "remeda": "^2.32.0",
     "tiny-invariant": "^1.3.3",
     "yjs": "^13.6.27",
-    "@palantir/pack.core": "0.2.0",
-    "@palantir/pack.document-schema.model-types": "0.2.2"
+    "@palantir/pack.document-schema.model-types": "0.3.0",
+    "@palantir/pack.core": "0.2.1"
   },
   "peerDependencies": {
     "zod": "^4.1.0"
   },
   "devDependencies": {
-    "@osdk/client": "~2.4.2",
-    "rimraf": "^6.0.1",
+    "@osdk/client": "~2.5.2",
+    "rimraf": "^6.1.2",
     "tslib": "^2.8.1",
-    "typescript": "^5.9.2",
+    "typescript": "^5.9.3",
     "vitest-mock-extended": "^3.1.0",
     "@palantir/pack.monorepo.tsconfig": "~0.4.3"
   },

package/src/__tests__/testUtils.ts

@@ -42,8 +42,9 @@ export function createTestApp(
         appId: "test-app-id",
         ...config.app,
       },
-      isTestMode: config.isTestMode ?? true,
+      isDemoMode: config.isDemoMode ?? true,
       logger: config.logger ?? consoleLogger({}),
+      ontologyRid: config.ontologyRid ?? Promise.resolve("ri.ontology...test"),
       osdkClient: mockClient,
       remote: {
         packWsPath: "/api/v2/packSubscriptions",

package/src/index.ts

@@ -15,8 +15,13 @@
  */
 
 export { createDocumentServiceConfig, getDocumentService } from "./DocumentServiceModule.js";
-export { BaseYjsDocumentService, type InternalYjsDoc } from "./service/BaseYjsDocumentService.js";
+export {
+  BaseYjsDocumentService,
+  type BaseYjsDocumentServiceOptions,
+  type InternalYjsDoc,
+} from "./service/BaseYjsDocumentService.js";
 export { createInMemoryDocumentServiceConfig } from "./service/InMemoryDocumentService.js";
+export type { CreateDocumentMetadata } from "./types/CreateDocumentMetadata.js";
 export { createDocRef, invalidDocRef, isValidDocRef } from "./types/DocumentRefImpl.js";
 export { DocumentLiveStatus, DocumentLoadStatus } from "./types/DocumentService.js";
 export type {
@@ -26,6 +31,7 @@ export type {
   DocumentStatus,
   DocumentStatusChangeCallback,
   DocumentSyncStatus,
+  SearchDocumentsResult,
 } from "./types/DocumentService.js";
 export type { WithDocumentServiceInit } from "./types/DocumentServiceConfig.js";
 export {

package/src/service/BaseYjsDocumentService.ts

@@ -37,6 +37,7 @@ import {
 import { isDeepEqual } from "remeda";
 import invariant from "tiny-invariant";
 import * as Y from "yjs";
+import type { CreateDocumentMetadata } from "../types/CreateDocumentMetadata.js";
 import { createDocRef } from "../types/DocumentRefImpl.js";
 import type {
   DocumentMetadataChangeCallback,
@@ -48,6 +49,7 @@ import type {
   RecordChangeCallback,
   RecordCollectionChangeCallback,
   RecordDeleteCallback,
+  SearchDocumentsResult,
 } from "../types/DocumentService.js";
 import { DocumentLiveStatus, DocumentLoadStatus } from "../types/DocumentService.js";
 import { createRecordCollectionRef } from "../types/RecordCollectionRefImpl.js";
@@ -105,6 +107,10 @@ export interface InternalYjsDoc {
   readonly yjsCollectionHandlers: Map<string, () => void>;
 }
 
+export interface BaseYjsDocumentServiceOptions {
+  readonly isDemo?: boolean;
+}
+
 /**
  * Base class for document services that use Y.js for local state management.
  * Provides common Y.js operations for both in-memory and backend services.
@@ -115,16 +121,20 @@ export abstract class BaseYjsDocumentService<TDoc extends InternalYjsDoc = Inter
   implements DocumentService
 {
   protected readonly documents: Map<DocumentId, TDoc> = new Map();
+  protected readonly isDemo?: boolean;
 
   constructor(
     protected readonly app: PackAppInternal,
     protected readonly logger: Logger,
-  ) {}
+    options?: BaseYjsDocumentServiceOptions,
+  ) {
+    this.isDemo = options?.isDemo;
+  }
 
   abstract get hasMetadataSubscriptions(): boolean;
   abstract get hasStateSubscriptions(): boolean;
   abstract readonly createDocument: <T extends DocumentSchema>(
-    metadata: DocumentMetadata,
+    metadata: CreateDocumentMetadata,
     schema: T,
   ) => Promise<DocumentRef<T>>;
   abstract readonly searchDocuments: <T extends DocumentSchema>(
@@ -132,9 +142,10 @@ export abstract class BaseYjsDocumentService<TDoc extends InternalYjsDoc = Inter
     schema: T,
     options?: {
       documentName?: string;
-      limit?: number;
+      pageSize?: number;
+      pageToken?: string;
     },
-  ) => Promise<ReadonlyArray<DocumentMetadata & { readonly id: DocumentId }>>;
+  ) => Promise<SearchDocumentsResult>;
 
   readonly createDocRef = <const T extends DocumentSchema>(
     id: DocumentId,
@@ -190,7 +201,7 @@ export abstract class BaseYjsDocumentService<TDoc extends InternalYjsDoc = Inter
 
   protected abstract createInternalDoc(
     ref: DocumentRef,
-    metadata?: DocumentMetadata,
+    metadata?: CreateDocumentMetadata,
     yDoc?: Y.Doc,
   ): TDoc;
 
@@ -314,6 +325,7 @@ export abstract class BaseYjsDocumentService<TDoc extends InternalYjsDoc = Inter
   ): void {
     if (update.load != null || update.live != null) {
       internalDoc.metadataStatus = {
+        isDemo: this.isDemo,
         load: update.load ?? internalDoc.metadataStatus.load,
         live: update.live ?? internalDoc.metadataStatus.live,
       };
@@ -338,6 +350,7 @@ export abstract class BaseYjsDocumentService<TDoc extends InternalYjsDoc = Inter
   ): void {
     if (update.load != null || update.live != null) {
       internalDoc.dataStatus = {
+        isDemo: this.isDemo,
         load: update.load ?? internalDoc.dataStatus.load,
         live: update.live ?? internalDoc.dataStatus.live,
       };
@@ -374,7 +387,7 @@ export abstract class BaseYjsDocumentService<TDoc extends InternalYjsDoc = Inter
    */
   protected getCreateInternalDoc<T extends DocumentSchema>(
     ref: DocumentRef<T>,
-    metadata?: DocumentMetadata,
+    metadata?: CreateDocumentMetadata,
     initialYDoc?: Y.Doc,
   ): { internalDocRef: DocumentRef<T>; internalDoc: TDoc; wasExisting: boolean } {
     const { id, schema } = ref;

package/src/service/InMemoryDocumentService.ts

@@ -28,8 +28,9 @@ import type {
   PresenceSubscriptionOptions,
 } from "@palantir/pack.document-schema.model-types";
 import { createDocumentServiceConfig } from "../DocumentServiceModule.js";
+import type { CreateDocumentMetadata } from "../types/CreateDocumentMetadata.js";
 import { createDocRef } from "../types/DocumentRefImpl.js";
-import type { DocumentService } from "../types/DocumentService.js";
+import type { DocumentService, SearchDocumentsResult } from "../types/DocumentService.js";
 import { DocumentLoadStatus } from "../types/DocumentService.js";
 import type { InternalYjsDoc } from "./BaseYjsDocumentService.js";
 import { BaseYjsDocumentService } from "./BaseYjsDocumentService.js";
@@ -90,7 +91,7 @@ class InMemoryDocumentService extends BaseYjsDocumentService {
   }
 
   readonly createDocument = <T extends DocumentSchema>(
-    metadata: DocumentMetadata,
+    metadata: CreateDocumentMetadata,
     schema: T,
   ): Promise<DocumentRef<T>> => {
     const id = generateDocumentId();
@@ -107,11 +108,12 @@ class InMemoryDocumentService extends BaseYjsDocumentService {
     schema: T,
     options?: {
       documentName?: string;
-      limit?: number;
+      pageSize?: number;
+      pageToken?: string;
     },
-  ): Promise<ReadonlyArray<DocumentMetadata & { readonly id: DocumentId }>> => {
+  ): Promise<SearchDocumentsResult> => {
     const results: Array<DocumentMetadata & { readonly id: DocumentId }> = [];
-    const { documentName, limit } = options ?? {};
+    const { documentName, pageSize } = options ?? {};
 
     for (const [docId, internalDoc] of this.documents.entries()) {
       if (internalDoc.metadata?.documentTypeName === documentTypeName) {
@@ -123,13 +125,14 @@ class InMemoryDocumentService extends BaseYjsDocumentService {
           id: docId as DocumentId,
         });
 
-        if (limit && results.length >= limit) {
+        if (pageSize && results.length >= pageSize) {
           break;
         }
       }
     }
 
-    return Promise.resolve(results);
+    // In-memory service doesn't support pagination
+    return Promise.resolve({ data: results, nextPageToken: undefined });
   };
 
   // Lifecycle method implementations

package/src/types/CreateDocumentMetadata.ts

@@ -0,0 +1,23 @@
+/*
+ * 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 { DocumentSecurity } from "@palantir/pack.document-schema.model-types";
+
+export interface CreateDocumentMetadata {
+  readonly name: string;
+  readonly documentTypeName: string;
+  readonly security?: DocumentSecurity;
+}

package/src/types/DocumentService.ts

@@ -31,6 +31,7 @@ import type {
   RecordId,
   RecordRef,
 } from "@palantir/pack.document-schema.model-types";
+import type { CreateDocumentMetadata } from "./CreateDocumentMetadata.js";
 
 export const DocumentLoadStatus = {
   UNLOADED: "unloaded", // Not yet loaded
@@ -50,6 +51,11 @@ export type DocumentLiveStatus = typeof DocumentLiveStatus[keyof typeof Document
 
 export type DocumentSyncStatus = {
   readonly error?: unknown;
+  /**
+   * When true, indicates this is a demo/test service not connected to real Foundry.
+   * UI can use this to display a badge or indicator that data is local-only.
+   */
+  readonly isDemo?: boolean;
   readonly live: DocumentLiveStatus;
   readonly load: DocumentLoadStatus;
 };
@@ -87,6 +93,14 @@ export type RecordDeleteCallback<M extends Model = Model> = (
   record: RecordRef<M>,
 ) => void;
 
+/**
+ * Result of a document search operation, including pagination information.
+ */
+export interface SearchDocumentsResult {
+  readonly data: ReadonlyArray<DocumentMetadata & { readonly id: DocumentId }>;
+  readonly nextPageToken?: string;
+}
+
 /**
  * Base interface for specific document service implementations.
  * The DocumentService is responsible for persisting document state,
@@ -99,7 +113,7 @@ export interface DocumentService {
   readonly hasStateSubscriptions: boolean;
 
   readonly createDocument: <T extends DocumentSchema>(
-    metadata: DocumentMetadata,
+    metadata: CreateDocumentMetadata,
     schema: T,
   ) => Promise<DocumentRef<T>>;
 
@@ -108,9 +122,10 @@ export interface DocumentService {
     schema: T,
     options?: {
       documentName?: string;
-      limit?: number;
+      pageSize?: number;
+      pageToken?: string;
     },
-  ) => Promise<ReadonlyArray<DocumentMetadata & { readonly id: DocumentId }>>;
+  ) => Promise<SearchDocumentsResult>;
 
   readonly createDocRef: <const T extends DocumentSchema>(
     id: DocumentId,

package/src/types/StateModule.ts

@@ -14,12 +14,8 @@
  * limitations under the License.
  */
 
-import {
-  assertIsAppInternal,
-  type ModuleKey,
-  type PackAppInternal,
-  type Unsubscribe,
-} from "@palantir/pack.core";
+import type { ModuleKey, PackApp, PackAppInternal, Unsubscribe } from "@palantir/pack.core";
+import { assertIsAppInternal } from "@palantir/pack.core";
 import type {
   ActivityEvent,
   DocumentId,
@@ -37,11 +33,13 @@ import type {
   RecordRef,
 } from "@palantir/pack.document-schema.model-types";
 import { DOCUMENT_SERVICE_MODULE_KEY } from "../DocumentServiceModule.js";
+import type { CreateDocumentMetadata } from "./CreateDocumentMetadata.js";
 import type {
   DocumentService,
   RecordChangeCallback,
   RecordCollectionChangeCallback,
   RecordDeleteCallback,
+  SearchDocumentsResult,
 } from "./DocumentService.js";
 
 // Ensure state module is accessible on PackApp instances.
@@ -69,7 +67,7 @@ export interface StateModule {
   ) => RecordRef<M>;
 
   readonly createDocument: <T extends DocumentSchema>(
-    metadata: DocumentMetadata,
+    metadata: CreateDocumentMetadata,
     schema: T,
   ) => Promise<DocumentRef<T>>;
 
@@ -78,9 +76,10 @@ export interface StateModule {
     schema: T,
     options?: {
       documentName?: string;
-      limit?: number;
+      pageSize?: number;
+      pageToken?: string;
     },
-  ) => Promise<ReadonlyArray<DocumentMetadata & { readonly id: DocumentId }>>;
+  ) => Promise<SearchDocumentsResult>;
 
   readonly getDocumentSnapshot: <T extends DocumentSchema>(
     docRef: DocumentRef<T>,
@@ -202,7 +201,7 @@ export class StateModuleImpl implements StateModule {
   }
 
   async createDocument<T extends DocumentSchema>(
-    metadata: DocumentMetadata,
+    metadata: CreateDocumentMetadata,
     schema: T,
   ): Promise<DocumentRef<T>> {
     return this.documentService.createDocument(metadata, schema);
@@ -213,9 +212,10 @@ export class StateModuleImpl implements StateModule {
     schema: T,
     options?: {
       documentName?: string;
-      limit?: number;
+      pageSize?: number;
+      pageToken?: string;
     },
-  ): Promise<ReadonlyArray<DocumentMetadata & { readonly id: DocumentId }>> {
+  ): Promise<SearchDocumentsResult> {
     return this.documentService.searchDocuments(documentTypeName, schema, options);
   }
 
@@ -401,7 +401,7 @@ export class StateModuleImpl implements StateModule {
   }
 }
 
-export function getStateModule(app: PackAppInternal): StateModule {
+export function getStateModule(app: PackApp | PackAppInternal): StateModule {
   assertIsAppInternal(app);
   return app.getModule(STATE_MODULE_KEY);
 }