@osdk/client 2.5.0-beta.7 → 2.5.0-beta.9

package/build/types/observable/internal/list/ListQuery.d.ts

@@ -1,4 +1,4 @@
-import type { Osdk, PageResult } from "@osdk/api";
+import type { Logger, ObjectOrInterfaceDefinition, ObjectSet, ObjectTypeDefinition, Osdk, PageResult, PropertyKeys } from "@osdk/api";
 import type { Observable, Subscription } from "rxjs";
 import type { InterfaceHolder } from "../../../object/convertWireToOsdkObjects/InterfaceHolder.js";
 import type { ObjectHolder } from "../../../object/convertWireToOsdkObjects/ObjectHolder.js";
@@ -26,21 +26,26 @@ type ExtractRelevantObjectsResult = Record<"added" | "modified", {
 	sortaMatches: Set<(ObjectHolder | InterfaceHolder)>
 }>;
 /**
-* Implements filtered and sorted object collection queries.
+* Base class for filtered and sorted object collection queries.
 * - Handles where clause filtering and orderBy sorting
 * - Manages pagination through fetchMore
 * - Auto-updates when matching objects change
 * - Uses canonicalized cache keys for consistency
 */
-export declare class ListQuery extends BaseListQuery<ListCacheKey, ListPayload, ListQueryOptions> {
+export declare abstract class ListQuery extends BaseListQuery<ListCacheKey, ListPayload, ListQueryOptions> {
 	#private;
+	protected apiName: string;
 	/**
 	* Register changes to the cache specific to ListQuery
 	*/
 	protected registerCacheChanges(batch: BatchContext): void;
-	constructor(store: Store, subject: Observable<SubjectPayload<ListCacheKey>>, apiType: "object" | "interface", apiName: string, whereClause: Canonical<SimpleWhereClause>, orderBy: Canonical<Record<string, "asc" | "desc" | undefined>>, cacheKey: ListCacheKey, opts: ListQueryOptions);
+	constructor(store: Store, subject: Observable<SubjectPayload<ListCacheKey>>, apiName: string, whereClause: Canonical<SimpleWhereClause>, orderBy: Canonical<Record<string, "asc" | "desc" | undefined>>, cacheKey: ListCacheKey, opts: ListQueryOptions);
 	get canonicalWhere(): Canonical<SimpleWhereClause>;
 	/**
+	* Create the ObjectSet for this query.
+	*/
+	protected abstract createObjectSet(store: Store): ObjectSet<ObjectTypeDefinition>;
+	/**
 	* Implements fetchPageData from BaseCollectionQuery template method
 	* Fetches a page of data
 	*/
@@ -56,7 +61,11 @@ export declare class ListQuery extends BaseListQuery<ListCacheKey, ListPayload,
 	* @param apiName to invalidate
 	* @returns
 	*/
-	revalidateObjectType: (apiName: string) => Promise<void>;
+	abstract revalidateObjectType(apiName: string): Promise<void>;
+	/**
+	* Postprocess fetched data.
+	*/
+	protected abstract postProcessFetchedData(data: Osdk.Instance<any>[]): Promise<Osdk.Instance<any>[]>;
 	invalidateObjectType: (objectType: string, changes: Changes | undefined) => Promise<void>;
 	/**
 	* Note: This method is not async because I want it to return right after it
@@ -68,8 +77,30 @@ export declare class ListQuery extends BaseListQuery<ListCacheKey, ListPayload,
 	*          revalidation is complete. Otherwise, undefined.
 	*/
 	maybeUpdateAndRevalidate: (changes: Changes, optimisticId: OptimisticId | undefined) => Promise<void> | undefined;
-	protected _extractRelevantObjects(changes: Changes): ExtractRelevantObjectsResult;
+	protected _extractAndCategorizeRelevantObjects(changes: Changes): ExtractRelevantObjectsResult;
+	/**
+	* Extract relevant objects for this query type.
+	*/
+	protected abstract extractRelevantObjects(changes: Changes): ExtractRelevantObjectsResult;
 	registerStreamUpdates(sub: Subscription): void;
+	protected onOswSuccessfulSubscription(): void;
+	protected onOswOutOfDate(): void;
+	protected onOswError(errors: {
+		subscriptionClosed: boolean
+		error: any
+	}): void;
+	protected onOswChange({ object: objOrIface, state }: ObjectUpdate<ObjectTypeDefinition, string>): void;
+	protected onOswRemoved(objOrIface: Osdk.Instance<ObjectTypeDefinition, never, string, {}>, logger: Logger | undefined): void;
 }
 export declare function isListCacheKey(cacheKey: CacheKey): cacheKey is ListCacheKey;
+/**
+* Copied from @osdk/api
+*/
+type ObjectUpdate<
+	O extends ObjectOrInterfaceDefinition,
+	P extends PropertyKeys<O>
+> = {
+	object: Osdk.Instance<O, never, P>
+	state: "ADDED_OR_UPDATED" | "REMOVED"
+};
 export {};

package/build/types/observable/internal/list/ListQuery.d.ts.map

@@ -1 +1 @@
-{"mappings":"AAgBA,cAKE,MACA,kBAEK,WAAY;AAEnB,cAAc,YAAY,oBAAoB,MAAO;AAGrD,cAAc,uBAAuB,6DAA8D;AAKnG,cACE,oBACK,0DAA2D;AAClE,cAAc,mBAAmB,sBAAuB;AACxD,cAAc,cAAc,kCAAmC;AAC/D,SAAS,qBAAqB,+BAAgC;AAC9D,cAAc,oBAAoB,oBAAqB;AACvD,cAAc,gBAAgB,gBAAiB;AAC/C,cAAc,iBAAiB,iBAAkB;AACjD,cAAc,eAA4C,eAAgB;AAC1E,cAAc,aAAa,aAAc;AAGzC,cAAc,oBAAoB,oBAAqB;AACvD,cAAc,yBAAyB,yBAA0B;AAEjE,cAAc,aAAa,aAAc;AACzC,cAAc,sBAAsB,sBAAuB;AAC3D,cAAc,oBAAoB,mBAAoB;AACtD,cAAc,wBAAwB,uBAAwB;AAE9D,OAAO,cAAM,eAAe;AAC5B,OAAO,cAAM,WAAW;AACxB,OAAO,cAAM,YAAY;AACzB,OAAO,cAAM,eAAe;KAEvB,+BAA+B,OAAO,UAAU,YAAY;CAC/D,MAAM,eAAe;CACrB,eAAe,KAAK,eAAe;CACnC,cAAc,KAAK,eAAe;AACnC;;;;;;;;AASD,OAAO,cAAM,kBAAkB,cAC7B,cACA,aACA,kBACA;;;;;CAcA,UAAU,qBAAqBA,OAAO;CAItC,YACEC,OAAO,OACPC,SAAS,WAAW,eAAe,gBACnCC,SAAS,WAAW,aACpBC,iBACAC,aAAa,UAAU,oBACvBC,SAAS,UAAU,eAAe,QAAQ,sBAC1CC,UAAU,cACVC,MAAM;CAoCR,IAAI,kBAAkB,UAAU;;;;;CAQhC,UAAgB,cACdC,QAAQ,0BACP,QAAQ,WAAW,KAAK;;;;CAqC3B,UAAU,iBACRC,gBACAC,SAAS,QACTX,OAAO,eACN,MAAM;;;;;;;;CAgBT,uBACEI,oBACC;CAqBH,uBACEQ,oBACAC,SAAS,wBACR;;;;;;;;;;CAkBH,2BACEC,SAAS,SACTC,cAAc,6BACb;CA+HH,UAAU,wBACRD,SAAS,UACR;CAoEH,sBAAsBE,KAAK;AAwJ5B;AAsDD,OAAO,iBAAS,eACdC,UAAU,WACT,YAAY","names":["batch: BatchContext","store: Store","subject: Observable<SubjectPayload<ListCacheKey>>","apiType: \"object\" | \"interface\"","apiName: string","whereClause: Canonical<SimpleWhereClause>","orderBy: Canonical<Record<string, \"asc\" | \"desc\" | undefined>>","cacheKey: ListCacheKey","opts: ListQueryOptions","signal: AbortSignal | undefined","error: unknown","_status: Status","objectType: string","changes: Changes | undefined","changes: Changes","optimisticId: OptimisticId | undefined","sub: Subscription","cacheKey: CacheKey"],"sources":["../../../../../src/observable/internal/list/ListQuery.ts"],"version":3,"file":"ListQuery.d.ts"}
+{"mappings":"AAgBA,cACE,QACA,6BACA,WACA,sBACA,MACA,YACA,oBACK,WAAY;AACnB,cAAc,YAAY,oBAAoB,MAAO;AAGrD,cAAc,uBAAuB,6DAA8D;AACnG,cACE,oBACK,0DAA2D;AAClE,cAAc,mBAAmB,sBAAuB;AACxD,cAAc,cAAc,kCAAmC;AAC/D,SAAS,qBAAqB,+BAAgC;AAC9D,cAAc,oBAAoB,oBAAqB;AACvD,cAAc,gBAAgB,gBAAiB;AAC/C,cAAc,iBAAiB,iBAAkB;AACjD,cAAc,eAA4C,eAAgB;AAC1E,cAAc,aAAa,aAAc;AAGzC,cAAc,oBAAoB,oBAAqB;AACvD,cAAc,yBAAyB,yBAA0B;AAEjE,cAAc,aAAa,aAAc;AACzC,cAAc,sBAAsB,sBAAuB;AAC3D,cAAc,oBAAoB,mBAAoB;AACtD,cAAc,wBAAwB,uBAAwB;AAE9D,OAAO,cAAM,eAAe;AAC5B,OAAO,cAAM,WAAW;AACxB,OAAO,cAAM,YAAY;AACzB,OAAO,cAAM,eAAe;KAEvB,+BAA+B,OAAO,UAAU,YAAY;CAC/D,MAAM,eAAe;CACrB,eAAe,KAAK,eAAe;CACnC,cAAc,KAAK,eAAe;AACnC;;;;;;;;AASD,OAAO,uBAAe,kBAAkB,cACtC,cACA,aACA,kBACA;;CAGA,UAAU;;;;CAUV,UAAU,qBAAqBA,OAAO;CAItC,YACEC,OAAO,OACPC,SAAS,WAAW,eAAe,gBACnCC,iBACAC,aAAa,UAAU,oBACvBC,SAAS,UAAU,eAAe,QAAQ,sBAC1CC,UAAU,cACVC,MAAM;CA+BR,IAAI,kBAAkB,UAAU;;;;CAOhC,mBAAmB,gBACjBN,OAAO,QACN,UAAU;;;;;CAMb,UAAgB,cACdO,QAAQ,0BACP,QAAQ,WAAW,KAAK;;;;CA4B3B,UAAU,iBACRC,gBACAC,SAAS,QACTV,OAAO,eACN,MAAM;;;;;;;;CAgBT,SAAS,qBAAqBG,kBAAkB;;;;CAKhD,mBAAmB,uBACjBQ,MAAM,KAAK,kBACV,QAAQ,KAAK;CAEhB,uBACEC,oBACAC,SAAS,wBACR;;;;;;;;;;CAkBH,2BACEC,SAAS,SACTC,cAAc,6BACb;CAiIH,UAAU,qCACRD,SAAS,UACR;;;;CAmBH,mBAAmB,uBACjBA,SAAS,UACR;CAEH,sBAAsBE,KAAK;CAgC3B,UAAU;CAQV,UAAU;CAQV,UAAU,WAAWC,QAAQ;EAC3B;EACA;CACD;CASD,UAAU,YACR,EAAE,QAAQ,YAAY,OAAmD,EAA1C,aAAa;CA8B9C,UAAU,aACRC,YAAY,KAAK,SAAS,qCAAqC,CAAE,IACjEC,QAAQ;AA2DX;AAED,OAAO,iBAAS,eACdC,UAAU,WACT,YAAY;;;;KAOV;CACH,UAAU;CACV,UAAU,aAAa;IACrB;CACF,QAAQ,KAAK,SAAS,UAAU;CAChC,OAAO,qBAAqB;AAC7B","names":["batch: BatchContext","store: Store","subject: Observable<SubjectPayload<ListCacheKey>>","apiName: string","whereClause: Canonical<SimpleWhereClause>","orderBy: Canonical<Record<string, \"asc\" | \"desc\" | undefined>>","cacheKey: ListCacheKey","opts: ListQueryOptions","signal: AbortSignal | undefined","error: unknown","_status: Status","data: Osdk.Instance<any>[]","objectType: string","changes: Changes | undefined","changes: Changes","optimisticId: OptimisticId | undefined","sub: Subscription","errors: {\n    subscriptionClosed: boolean;\n    error: any;\n  }","objOrIface: Osdk.Instance<ObjectTypeDefinition, never, string, {}>","logger: Logger | undefined","cacheKey: CacheKey"],"sources":["../../../../../src/observable/internal/list/ListQuery.ts"],"version":3,"file":"ListQuery.d.ts"}

package/build/types/observable/internal/list/ListsHelper.d.ts

@@ -9,7 +9,7 @@ import type { OrderByCanonicalizer } from "../OrderByCanonicalizer.js";
 import type { QuerySubscription } from "../QuerySubscription.js";
 import type { Store } from "../Store.js";
 import type { WhereClauseCanonicalizer } from "../WhereClauseCanonicalizer.js";
-import { ListQuery } from "./ListQuery.js";
+import type { ListQuery } from "./ListQuery.js";
 export declare class ListsHelper extends AbstractHelper<ListQuery, ObserveListOptions<ObjectTypeDefinition | InterfaceDefinition>> {
 	whereCanonicalizer: WhereClauseCanonicalizer;
 	orderByCanonicalizer: OrderByCanonicalizer;

package/build/types/observable/internal/list/ListsHelper.d.ts.map

@@ -1 +1 @@
-{"mappings":"AAgBA,cAAc,qBAAqB,4BAA4B,WAAY;AAC3E,cAAc,mBAAmB,sBAAuB;AACxD,cAAc,0BAA0B,2BAA4B;AACpE,cAAc,gBAAgB,kCAAmC;AACjE,SAAS,sBAAsB,sBAAuB;AACtD,cAAc,iBAAiB,iBAAkB;AACjD,cAAc,qBAAqB,qBAAsB;AACzD,cAAc,4BAA4B,4BAA6B;AACvE,cAAc,yBAAyB,yBAA0B;AACjE,cAAc,aAAa,aAAc;AACzC,cAAc,gCAAgC,gCAAiC;AAE/E,SAAS,iBAAiB,gBAAiB;AAE3C,OAAO,cAAM,oBAAoB,eAC/B,WACA,mBAAmB,uBAAuB,sBAC1C;CACA,oBAAoB;CACpB,sBAAsB;CAEtB,YACEA,OAAO,OACPC,WAAW,UAAU,gBACrBC,oBAAoB,0BACpBC,sBAAsB;CAQxB,QAAQ,UAAU,uBAAuB,qBACvCC,SAAS,mBAAmB,IAC5BC,OAAO,SAAS,eACf,kBAAkB;CASrB,SAAS,UAAU,uBAAuB,qBACxCD,SAAS,mBAAmB,KAC3B;AA0BJ","names":["store: Store","cacheKeys: CacheKeys<KnownCacheKey>","whereCanonicalizer: WhereClauseCanonicalizer","orderByCanonicalizer: OrderByCanonicalizer","options: ObserveListOptions<T>","subFn: Observer<ListPayload>"],"sources":["../../../../../src/observable/internal/list/ListsHelper.ts"],"version":3,"file":"ListsHelper.d.ts"}
+{"mappings":"AAgBA,cAAc,qBAAqB,4BAA4B,WAAY;AAC3E,cAAc,mBAAmB,sBAAuB;AACxD,cAAc,0BAA0B,2BAA4B;AACpE,cAAc,gBAAgB,kCAAmC;AACjE,SAAS,sBAAsB,sBAAuB;AACtD,cAAc,iBAAiB,iBAAkB;AACjD,cAAc,qBAAqB,qBAAsB;AACzD,cAAc,4BAA4B,4BAA6B;AACvE,cAAc,yBAAyB,yBAA0B;AACjE,cAAc,aAAa,aAAc;AACzC,cAAc,gCAAgC,gCAAiC;AAG/E,cAAc,iBAAiB,gBAAiB;AAGhD,OAAO,cAAM,oBAAoB,eAC/B,WACA,mBAAmB,uBAAuB,sBAC1C;CACA,oBAAoB;CACpB,sBAAsB;CAEtB,YACEA,OAAO,OACPC,WAAW,UAAU,gBACrBC,oBAAoB,0BACpBC,sBAAsB;CAQxB,QAAQ,UAAU,uBAAuB,qBACvCC,SAAS,mBAAmB,IAC5BC,OAAO,SAAS,eACf,kBAAkB;CASrB,SAAS,UAAU,uBAAuB,qBACxCD,SAAS,mBAAmB,KAC3B;AA4BJ","names":["store: Store","cacheKeys: CacheKeys<KnownCacheKey>","whereCanonicalizer: WhereClauseCanonicalizer","orderByCanonicalizer: OrderByCanonicalizer","options: ObserveListOptions<T>","subFn: Observer<ListPayload>"],"sources":["../../../../../src/observable/internal/list/ListsHelper.ts"],"version":3,"file":"ListsHelper.d.ts"}

package/build/types/observable/internal/list/ObjectListQuery.d.ts

@@ -0,0 +1,18 @@
+import type { ObjectSet, ObjectTypeDefinition, Osdk } from "@osdk/api";
+import type { InterfaceHolder } from "../../../object/convertWireToOsdkObjects/InterfaceHolder.js";
+import type { ObjectHolder } from "../../../object/convertWireToOsdkObjects/ObjectHolder.js";
+import type { Changes } from "../Changes.js";
+import type { Store } from "../Store.js";
+import { ListQuery } from "./ListQuery.js";
+type ExtractRelevantObjectsResult = Record<"added" | "modified", {
+	all: (ObjectHolder | InterfaceHolder)[]
+	strictMatches: Set<(ObjectHolder | InterfaceHolder)>
+	sortaMatches: Set<(ObjectHolder | InterfaceHolder)>
+}>;
+export declare class ObjectListQuery extends ListQuery {
+	protected createObjectSet(store: Store): ObjectSet<ObjectTypeDefinition>;
+	revalidateObjectType(apiName: string): Promise<void>;
+	protected postProcessFetchedData(data: Osdk.Instance<any>[]): Promise<Osdk.Instance<any>[]>;
+	protected extractRelevantObjects(changes: Changes): ExtractRelevantObjectsResult;
+}
+export {};

package/build/types/observable/internal/list/ObjectListQuery.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cAAc,WAAW,sBAAsB,YAAY,WAAY;AACvE,cAAc,uBAAuB,6DAA8D;AACnG,cAAc,oBAAoB,0DAA2D;AAC7F,cAAc,eAAe,eAAgB;AAC7C,cAAc,aAAa,aAAc;AACzC,SAAuB,iBAAiB,gBAAiB;KAEpD,+BAA+B,OAAO,UAAU,YAAY;CAC/D,MAAM,eAAe;CACrB,eAAe,KAAK,eAAe;CACnC,cAAc,KAAK,eAAe;AACnC;AAED,OAAO,cAAM,wBAAwB,UAAU;CAC7C,UAAU,gBAAgBA,OAAO,QAAQ,UAAU;CAQnD,AAAM,qBAAqBC,kBAAkB;CAM7C,UAAU,uBACRC,MAAM,KAAK,kBACV,QAAQ,KAAK;CAIhB,UAAU,uBACRC,SAAS,UACR;AAgBJ","names":["store: Store","apiName: string","data: Osdk.Instance<any>[]","changes: Changes"],"sources":["../../../../../src/observable/internal/list/ObjectListQuery.ts"],"version":3,"file":"ObjectListQuery.d.ts"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@osdk/client",
-  "version": "2.5.0-beta.7",
+  "version": "2.5.0-beta.9",
   "description": "",
   "access": "public",
   "license": "Apache-2.0",
@@ -65,12 +65,12 @@
     "tiny-invariant": "^1.3.3",
     "type-fest": "^4.41.0",
     "ws": "^8.18.3",
-    "@osdk/api": "2.5.0-beta.7",
+    "@osdk/api": "2.5.0-beta.9",
     "@osdk/shared.client.impl": "~1.5.0-beta.2",
+    "@osdk/client.unstable": "2.5.0-beta.9",
     "@osdk/shared.net.errors": "~2.5.0-beta.2",
     "@osdk/shared.net.fetch": "~1.5.0-beta.2",
-    "@osdk/generator-converters": "2.5.0-beta.7",
-    "@osdk/client.unstable": "2.5.0-beta.7"
+    "@osdk/generator-converters": "2.5.0-beta.9"
   },
   "devDependencies": {
     "@microsoft/api-documenter": "^7.26.32",
@@ -91,10 +91,10 @@
     "ts-expect": "^1.3.0",
     "typescript": "~5.5.4",
     "zod": "^3.25.76",
+    "@osdk/client.test.ontology": "~2.5.0-beta.9",
     "@osdk/monorepo.api-extractor": "~0.4.0-beta.1",
-    "@osdk/client.test.ontology": "~2.5.0-beta.7",
-    "@osdk/monorepo.tsconfig": "~0.4.0-beta.1",
-    "@osdk/shared.test": "~2.5.0-beta.5"
+    "@osdk/shared.test": "~2.5.0-beta.5",
+    "@osdk/monorepo.tsconfig": "~0.4.0-beta.1"
   },
   "publishConfig": {
     "access": "public"