@palantir/pack.state.core 0.1.0 → 0.1.1

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

@@ -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>;

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;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;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;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

@@ -10,6 +10,12 @@ 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;
@@ -37,6 +43,12 @@ 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;

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,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,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,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",
+  "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.document-schema.model-types": "0.1.0",
-    "@palantir/pack.core": "0.1.0"
+    "@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"
+    "@palantir/pack.monorepo.tsconfig": "~0.4.3"
   },
   "publishConfig": {
     "access": "public"

package/src/service/BaseYjsDocumentService.ts

@@ -127,6 +127,14 @@ export abstract class BaseYjsDocumentService<TDoc extends InternalYjsDoc = Inter
     metadata: DocumentMetadata,
     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 }>>;
 
   readonly createDocRef = <const T extends DocumentSchema>(
     id: DocumentId,

package/src/service/InMemoryDocumentService.ts

@@ -104,6 +104,36 @@ class InMemoryDocumentService extends BaseYjsDocumentService {
     return Promise.resolve(docRef);
   };
 
+  readonly searchDocuments = <T extends DocumentSchema>(
+    documentTypeName: string,
+    schema: T,
+    options?: {
+      documentName?: string;
+      limit?: number;
+    },
+  ): Promise<ReadonlyArray<DocumentMetadata & { readonly id: DocumentId }>> => {
+    const results: Array<DocumentMetadata & { readonly id: DocumentId }> = [];
+    const { documentName, limit } = options ?? {};
+
+    for (const [docId, internalDoc] of this.documents.entries()) {
+      if (internalDoc.metadata?.documentTypeName === documentTypeName) {
+        if (documentName && !internalDoc.metadata.name.includes(documentName)) {
+          continue;
+        }
+        results.push({
+          ...internalDoc.metadata,
+          id: docId as DocumentId,
+        });
+
+        if (limit && results.length >= limit) {
+          break;
+        }
+      }
+    }
+
+    return Promise.resolve(results);
+  };
+
   // Lifecycle method implementations
   protected onMetadataSubscriptionOpened(
     internalDoc: InternalYjsDoc,

package/src/types/DocumentRefImpl.ts

@@ -63,10 +63,30 @@ export const createDocRef = <const D extends DocumentSchema>(
   return new DocumentRefImpl(app, id, schema);
 };
 
+/**
+ * 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 function invalidDocRef<D extends DocumentSchema = DocumentSchema>(): DocumentRef<D> {
   return INVALID_DOC_REF as 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 function isValidDocRef<D extends DocumentSchema = DocumentSchema>(
   docRef: DocumentRef<D>,
 ): docRef is DocumentRef<D> {

package/src/types/DocumentService.ts

@@ -87,6 +87,13 @@ 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;
@@ -96,6 +103,15 @@ export interface DocumentService {
     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,

package/src/types/RecordCollectionRefImpl.ts

@@ -54,10 +54,33 @@ export const createRecordCollectionRef = <const M extends Model>(
   return new RecordCollectionRefImpl(documentService, docRef, model);
 };
 
+/**
+ * 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 function invalidRecordCollectionRef<M extends Model = Model>(): RecordCollectionRef<M> {
   return INVALID_RECORD_COLLECTION_REF as 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 function isValidRecordCollectionRef<M extends Model = Model>(
   collectionRef: RecordCollectionRef<M>,
 ): collectionRef is RecordCollectionRef<M> {

package/src/types/RecordRefImpl.ts

@@ -49,10 +49,35 @@ export const createRecordRef = <const M extends Model>(
   return new RecordRefImpl(documentService, docRef, id, model);
 };
 
+/**
+ * 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 function invalidRecordRef<M extends Model = Model>(): RecordRef<M> {
   return INVALID_RECORD_REF as 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 function isValidRecordRef<M extends Model = Model>(
   recordRef: RecordRef<M>,
 ): recordRef is RecordRef<M> {

package/src/types/StateModule.ts

@@ -73,6 +73,15 @@ export interface StateModule {
     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>>;
@@ -199,6 +208,17 @@ export class StateModuleImpl implements StateModule {
     return this.documentService.createDocument(metadata, schema);
   }
 
+  async searchDocuments<T extends DocumentSchema>(
+    documentTypeName: string,
+    schema: T,
+    options?: {
+      documentName?: string;
+      limit?: number;
+    },
+  ): Promise<ReadonlyArray<DocumentMetadata & { readonly id: DocumentId }>> {
+    return this.documentService.searchDocuments(documentTypeName, schema, options);
+  }
+
   async getDocumentSnapshot<T extends DocumentSchema>(
     docRef: DocumentRef<T>,
   ): Promise<DocumentState<T>> {