@osdk/client 2.5.0-beta.1 → 2.5.0-beta.2

package/build/types/observable/internal/testUtils/observeObject/expectStandardObserveObject.d.ts

@@ -0,0 +1,26 @@
+import type { ObjectTypeDefinition, PrimaryKeyType } from "@osdk/api";
+import type { TypedObjectPayload } from "../../../ObjectPayload.js";
+import type { Store } from "../../Store.js";
+import type { MockedSingleSubCallback } from "../../testUtils.js";
+/**
+* Utility function for testing object observation behavior
+*
+* This function provides the following guarantees:
+* - Validates the initial "loading" state is emitted
+* - Waits for the subscription callback to be called again
+* - Validates the "loaded" state with the expected object containing apiName and primaryKey
+* - Returns both the observed object and mock subscription function for further assertions
+*
+* @param cache - The Store instance to use for observation
+* @param apiName - The API name for the object to observe
+* @param primaryKey - The primary key of the object to observe
+* @returns A promise that resolves to the observed object and the mocked subscription callback
+*/
+export declare function expectStandardObserveObject<T extends ObjectTypeDefinition>({ cache, type, primaryKey }: {
+	cache: Store
+	type: T
+	primaryKey: PrimaryKeyType<T>
+}): Promise<{
+	payload: TypedObjectPayload<T>
+	subFn: MockedSingleSubCallback
+}>;

package/build/types/observable/internal/testUtils/observeObject/expectStandardObserveObject.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cAAc,sBAAsB,sBAAsB,WAAY;AAEtE,cAAc,0BAA0B,2BAA4B;AACpE,cAAc,aAAa,gBAAiB;AAC5C,cAAc,+BAA+B,oBAAqB;;;;;;;;;;;;;;;AAwBlE,OAAO,iBAAe,4BACpB,UAAU,sBAEV,EAAE,OAAO,MAAM,YAId,EAJ4B;CAC3B,OAAO;CACP,MAAM;CACN,YAAY,eAAe;AAC5B,IACA,QAAQ;CACT,SAAS,mBAAmB;CAC5B,OAAO;AACR","names":[],"sources":["../../../../../../src/observable/internal/testUtils/observeObject/expectStandardObserveObject.ts"],"version":3,"file":"expectStandardObserveObject.d.ts"}

package/build/types/observable/internal/testUtils.d.ts

@@ -4,9 +4,11 @@ import type { Observer } from "rxjs";
 import type { Mock, MockedObject } from "vitest";
 import type { Client } from "../../Client.js";
 import type { ObjectHolder } from "../../object/convertWireToOsdkObjects/ObjectHolder.js";
+import type { SpecificLinkPayload } from "../LinkPayload.js";
 import type { ListPayload } from "../ListPayload.js";
 import type { ObjectPayload } from "../ObjectPayload.js";
-import type { OrderBy, Status, Unsubscribable } from "../ObservableClient.js";
+import type { OrderBy, Status } from "../ObservableClient/common.js";
+import type { Unsubscribable } from "../Unsubscribable.js";
 import type { Entry } from "./Layer.js";
 import type { ListQueryOptions } from "./ListQuery.js";
 import type { OptimisticId } from "./OptimisticId.js";
@@ -21,27 +23,47 @@ export interface MockClientHelper {
 		orderBy: Record<string, "asc" | "desc" | undefined>
 	}) => DeferredPromise<PageResult<Partial<Osdk.Instance<Q>>>>;
 }
+/**
+* Testing utilities for ObservableClient implementation.
+* - Mock creation helpers for client, observers, and callbacks
+* - Expectation utilities for validating payloads
+* - Tools for managing test lifecycle and cleanup
+* - Creates a colorized logger for test environments
+*/
 export declare function createTestLogger(bindings: Record<string, any>, options?: {
 	level?: string
 	msgPrefix?: string
 }): Logger;
+/**
+* Creates mocked client helpers with deferred promise control
+*/
 export declare function createClientMockHelper(): MockClientHelper;
+/**
+* Manages test subscriptions with automatic cleanup
+*/
 export declare function createDefer(): (x: Unsubscribable) => Unsubscribable;
+export declare function expectSingleLinkCallAndClear<T extends ObjectTypeDefinition>(subFn: MockedObject<Observer<SpecificLinkPayload | undefined>>, resolvedList: ObjectHolder[] | Osdk.Instance<T>[] | undefined, payloadOptions?: Omit<Partial<SpecificLinkPayload>, "resolvedList">): SpecificLinkPayload | undefined;
 export declare function expectSingleListCallAndClear<T extends ObjectTypeDefinition>(subFn: MockedObject<Observer<ListPayload | undefined>>, resolvedList: ObjectHolder[] | Osdk.Instance<T>[], payloadOptions?: Omit<Partial<ListPayload>, "resolvedList">): void;
-export declare function expectSingleObjectCallAndClear<T extends ObjectTypeDefinition>(subFn: MockedObject<Observer<ObjectPayload | undefined>>, object: Osdk.Instance<T> | undefined, status?: Status): void;
+/**
+* Validates object payload emissions in tests
+*/
+export declare function expectSingleObjectCallAndClear<T extends ObjectTypeDefinition>(subFn: MockedObject<Observer<ObjectPayload | undefined>>, object: Osdk.Instance<T> | undefined, status?: Status): ObjectPayload | undefined;
 export declare function waitForCall(subFn: Mock<(e: any) => void> | MockedObject<Observer<any>>, times?: number): Promise<void>;
 export declare function expectNoMoreCalls(observer: MockedObject<Observer<any>>): void;
-export declare function mockSingleSubCallback(): MockedObject<Observer<ObjectPayload | undefined>> & {
+export type MockedSingleSubCallback = MockedObject<Observer<ObjectPayload | undefined>> & {
 	expectLoadingAndLoaded: (q: {
 		loading?: unknown
 		loaded: unknown
 	}) => Promise<void>
 };
+export declare function mockSingleSubCallback(): MockedSingleSubCallback;
 export declare function mockObserver<T>(): MockedObject<Observer<T>>;
 export declare function mockListSubCallback(): MockedObject<Observer<ListPayload | undefined>>;
+export declare function mockLinkSubCallback(): MockedObject<Observer<SpecificLinkPayload | undefined>>;
 export declare function cacheEntryContaining(x: Partial<Entry<any>>): Entry<any>;
 export declare function objectPayloadContaining(x: Partial<ObjectPayload>): ObjectPayload;
 export declare function listPayloadContaining(x: Partial<ListPayload>): ListPayload;
+export declare function linkPayloadContaining(x: Partial<SpecificLinkPayload>): SpecificLinkPayload;
 export declare function applyCustomMatchers(): void;
 interface CustomMatchers<R = any> {
 	toBeGreaterThan: (n: number) => R;

package/build/types/observable/internal/testUtils.d.ts.map

@@ -1 +1 @@
-{"mappings":"AAgBA,cAEE,oBAEA,qBACA,QACA,6BAEA,sBACA,MAEA,YACA,mBACK,WAAY;AAEnB,cAAc,uBAAuB,SAAU;AAE/C,cAAc,gBAAgB,MAAO;AAErC,cAAc,MAAM,oBAAoB,QAAS;AAGjD,cAAc,cAAc,iBAAkB;AAE9C,cAAc,oBAAoB,uDAAwD;AAC1F,cAAc,mBAAmB,mBAAoB;AACrD,cAAc,qBAAqB,qBAAsB;AACzD,cAAc,SAAS,QAAQ,sBAAsB,wBAAyB;AAC9E,cAAc,aAAa,YAAa;AACxC,cAAc,wBAAwB,gBAAiB;AAGvD,cAAc,oBAAoB,mBAAoB;AACtD,cAAc,aAAa,YAAa;AAIxC,iBAAiB,iBAAiB;CAChC,QAAQ,KAAK,UAAU;CAEvB,2BAA2B,gBAAgB,QAAQ;CAEnD,mBAAmB,UAAU,sBAC3BA,2CACG,gBACH,QACE,KAAK,SAAS;CAIlB,8BAA8B,gBAC5B,MACI,KAAK,SAAS,yCAAyC,CAAE,KACzD;CAIN,oBACE,UAAU,sBAEVC,WAAW;EACT,OAAO;EACP,SAAS,eAAe,QAAQ;CACjC,MACE,gBACH,WAAW,QAAQ,KAAK,SAAS;AAEpC;AAcD,OAAO,iBAAS,iBACdC,UAAU,qBACVC,UAAU;CAAE;CAAgB;AAAoB,IAC/C;AA+DH,OAAO,iBAAS,0BAA0B;AA8J1C,OAAO,iBAAS,gBAcQC,GAAG,mBAAiB;AAM5C,OAAO,iBAAS,6BAA6B,UAAU,sBACrDC,OAAO,aAAa,SAAS,2BAC7BC,cAAc,iBAAiB,KAAK,SAAS,MAC7CC,iBAAgB,KAAK,QAAQ,cAAc;AAgB7C,OAAO,iBAAS,+BAA+B,UAAU,sBACvDC,OAAO,aAAa,SAAS,6BAC7BC,QAAQ,KAAK,SAAS,gBACtBC,SAAS;AAWX,OAAO,iBAAe,YACpBC,OAAO,MAAMC,mBAAmB,aAAa,gBAC7CC,iBACC;AAiBH,OAAO,iBAAS,kBACdC,UAAU,aACR;AAUJ,OAAO,iBAAS,yBACZ,aACA,SAAS,8BAET;CAGA,yBAAyBC,GAAG;EAC1B;EACA;CACD,MAAK;AACP;AAmDH,OAAO,iBAAS,aAAa,MAAM,aAAa,SAAS;AAUzD,OAAO,iBAAS,uBAAuB,aACrC,SAAS;AAKX,OAAO,iBAAS,qBAAqBC,GAAG,QAAQ,cAAc;AAoB9D,OAAO,iBAAS,wBACdC,GAAG,QAAQ,iBACV;AASH,OAAO,iBAAS,sBACdC,GAAG,QAAQ,eACV;AAWH,OAAO,iBAAS;UAWN,eAAe,SAAS;CAChC,kBAAkBC,cAAc;AACjC;UAES,yBAAyB,SAAS;CAC1C,kBAAkBA,cAAc;AACjC;eAEc,SAAS;WACZ,UAAU,iBAAiB,eAAe,GAAG,CAAE;WAC/C,qCAAqC,yBAAyB,CAAE;AAC3E;;;;;;;;;;;;;AAcD,OAAO,iBAAS,WACd,UAAU,uBAAuB,qBAEjCC,OAAO,OACP,EACE,MACA,OACA,SAKD,EAJE;CACD,MAAM,KAAK,GAAG,YAAY;CAC1B,OAAO,YAAY;CACnB,SAAS,QAAQ;AAClB,GACDC,SAAS,iBAAiB,KAAK,SAAS,MACxC,EAAE,cAA+C,GAA/B;CAAE,eAAe;AAAc,GACjDC,OAAM;AAsBR,OAAO,iBAAS,UACdF,OAAO,OACPG,cACAC,aACC;AAKH,OAAO,iBAAS,aAAa,UAAU,6BACrCJ,OAAO,OACPK,OAAO,KAAK,SAAS,IACrB,EAAE,cAA+C,GAA/B;CAAE,eAAe;AAAc,IAChD,KAAK,SAAS","names":["expectedId?: string | number | boolean","expected?: {\n      where: WhereClause<any>;\n      orderBy: Record<string, \"asc\" | \"desc\" | undefined>;\n    }","bindings: Record<string, any>","options?: { level?: string; msgPrefix?: string }","x: Unsubscribable","subFn: MockedObject<Observer<ListPayload | undefined>>","resolvedList: ObjectHolder[] | Osdk.Instance<T>[]","payloadOptions: Omit<Partial<ListPayload>, \"resolvedList\">","subFn: MockedObject<Observer<ObjectPayload | undefined>>","object: Osdk.Instance<T> | undefined","status?: Status","subFn: Mock<(e: any) => void> | MockedObject<Observer<any>>","e: any","times: number","observer: MockedObject<\n    Observer<any>\n  >","q: {\n      loading?: unknown;\n      loaded: unknown;\n    }","x: Partial<Entry<any>>","x: Partial<ObjectPayload>","x: Partial<ListPayload>","n: number","store: Store","objects: ObjectHolder[] | Osdk.Instance<T>[]","opts: ListQueryOptions","type: string","pk: number","value: Osdk.Instance<T>"],"sources":["../../../../src/observable/internal/testUtils.ts"],"version":3,"file":"testUtils.d.ts"}
+{"mappings":"AAgBA,cAEE,oBAEA,qBACA,QACA,6BAEA,sBACA,MAEA,YACA,mBACK,WAAY;AAGnB,cAAc,uBAAuB,SAAU;AAE/C,cAAc,gBAAgB,MAAO;AAErC,cAAc,MAAM,oBAAoB,QAAS;AAGjD,cAAc,cAAc,iBAAkB;AAE9C,cAAc,oBAAoB,uDAAwD;AAC1F,cAAc,2BAA2B,mBAAoB;AAC7D,cAAc,mBAAmB,mBAAoB;AACrD,cAAc,qBAAqB,qBAAsB;AACzD,cAAc,SAAS,cAAc,+BAAgC;AACrE,cAAc,sBAAsB,sBAAuB;AAC3D,cAAc,aAAa,YAAa;AACxC,cAAc,wBAAwB,gBAAiB;AAGvD,cAAc,oBAAoB,mBAAoB;AACtD,cAAc,aAAa,YAAa;AAIxC,iBAAiB,iBAAiB;CAChC,QAAQ,KAAK,UAAU;CAEvB,2BAA2B,gBAAgB,QAAQ;CAEnD,mBAAmB,UAAU,sBAC3BA,2CACG,gBACH,QACE,KAAK,SAAS;CAIlB,8BAA8B,gBAC5B,MACI,KAAK,SAAS,yCAAyC,CAAE,KACzD;CAIN,oBACE,UAAU,sBAEVC,WAAW;EACT,OAAO;EACP,SAAS,eAAe,QAAQ;CACjC,MACE,gBACH,WAAW,QAAQ,KAAK,SAAS;AAEpC;;;;;;;;AAiBD,OAAO,iBAAS,iBACdC,UAAU,qBACVC,UAAU;CAAE;CAAgB;AAAoB,IAC/C;;;;AAkEH,OAAO,iBAAS,0BAA0B;;;;AAiK1C,OAAO,iBAAS,gBAcQC,GAAG,mBAAiB;AAM5C,OAAO,iBAAS,6BAA6B,UAAU,sBACrDC,OAAO,aAAa,SAAS,mCAC7BC,cAAc,iBAAiB,KAAK,SAAS,kBAC7CC,iBAAgB,KAAK,QAAQ,sBAAsB,kBAClD;AAkBH,OAAO,iBAAS,6BAA6B,UAAU,sBACrDC,OAAO,aAAa,SAAS,2BAC7BC,cAAc,iBAAiB,KAAK,SAAS,MAC7CC,iBAAgB,KAAK,QAAQ,cAAc;;;;AAmB7C,OAAO,iBAAS,+BAA+B,UAAU,sBACvDC,OAAO,aAAa,SAAS,6BAC7BC,QAAQ,KAAK,SAAS,gBACtBC,SAAS,SACR;AAaH,OAAO,iBAAe,YACpBC,OAAO,MAAMC,mBAAmB,aAAa,gBAC7CC,iBACC;AA4BH,OAAO,iBAAS,kBACdC,UAAU,aACR;AAUJ,YAAY,0BACR,aAAa,SAAS,8BACtB;CAGA,yBAAyBC,GAAG;EAC1B;EACA;CACD,MAAK;AACP;AAEH,OAAO,iBAAS,yBAAyB;AAkDzC,OAAO,iBAAS,aAAa,MAAM,aAAa,SAAS;AAWzD,OAAO,iBAAS,uBAAuB,aACrC,SAAS;AAMX,OAAO,iBAAS,uBAAuB,aACrC,SAAS;AAKX,OAAO,iBAAS,qBAAqBC,GAAG,QAAQ,cAAc;AAoB9D,OAAO,iBAAS,wBACdC,GAAG,QAAQ,iBACV;AASH,OAAO,iBAAS,sBACdC,GAAG,QAAQ,eACV;AAWH,OAAO,iBAAS,sBACdC,GAAG,QAAQ,uBACV;AAWH,OAAO,iBAAS;UAWN,eAAe,SAAS;CAChC,kBAAkBC,cAAc;AACjC;UAES,yBAAyB,SAAS;CAC1C,kBAAkBA,cAAc;AACjC;eAEc,SAAS;WACZ,UAAU,iBAAiB,eAAe,GAAG,CAAE;WAC/C,qCAAqC,yBAAyB,CAAE;AAC3E;;;;;;;;;;;;;AAcD,OAAO,iBAAS,WACd,UAAU,uBAAuB,qBAEjCC,OAAO,OACP,EACE,MACA,OACA,SAKD,EAJE;CACD,MAAM,KAAK,GAAG,YAAY;CAC1B,OAAO,YAAY;CACnB,SAAS,QAAQ;AAClB,GACDC,SAAS,iBAAiB,KAAK,SAAS,MACxC,EAAE,cAA+C,GAA/B;CAAE,eAAe;AAAc,GACjDC,OAAM;AAsBR,OAAO,iBAAS,UACdF,OAAO,OACPG,cACAC,aACC;AAKH,OAAO,iBAAS,aAAa,UAAU,6BACrCJ,OAAO,OACPK,OAAO,KAAK,SAAS,IACrB,EAAE,cAA+C,GAA/B;CAAE,eAAe;AAAc,IAChD,KAAK,SAAS","names":["expectedId?: string | number | boolean","expected?: {\n      where: WhereClause<any>;\n      orderBy: Record<string, \"asc\" | \"desc\" | undefined>;\n    }","bindings: Record<string, any>","options?: { level?: string; msgPrefix?: string }","x: Unsubscribable","subFn: MockedObject<Observer<SpecificLinkPayload | undefined>>","resolvedList: ObjectHolder[] | Osdk.Instance<T>[] | undefined","payloadOptions: Omit<Partial<SpecificLinkPayload>, \"resolvedList\">","subFn: MockedObject<Observer<ListPayload | undefined>>","resolvedList: ObjectHolder[] | Osdk.Instance<T>[]","payloadOptions: Omit<Partial<ListPayload>, \"resolvedList\">","subFn: MockedObject<Observer<ObjectPayload | undefined>>","object: Osdk.Instance<T> | undefined","status?: Status","subFn: Mock<(e: any) => void> | MockedObject<Observer<any>>","e: any","times: number","observer: MockedObject<\n    Observer<any>\n  >","q: {\n      loading?: unknown;\n      loaded: unknown;\n    }","x: Partial<Entry<any>>","x: Partial<ObjectPayload>","x: Partial<ListPayload>","x: Partial<SpecificLinkPayload>","n: number","store: Store","objects: ObjectHolder[] | Osdk.Instance<T>[]","opts: ListQueryOptions","type: string","pk: number","value: Osdk.Instance<T>"],"sources":["../../../../src/observable/internal/testUtils.ts"],"version":3,"file":"testUtils.d.ts"}

package/build/types/public/unstable-do-not-use.d.ts

@@ -1,7 +1,9 @@
 export { augment } from "../object/fetchPage.js";
 export type { ActionSignatureFromDef } from "../actions/applyAction.js";
 export { createObservableClient } from "../observable/ObservableClient.js";
-export type { ObservableClient, ObserveObjectArgs, ObserveObjectsArgs, Observer, Unsubscribable } from "../observable/ObservableClient.js";
-export type { OsdkConfig } from "../public-utils/osdkConfig.js";
+export type { ObservableClient, ObserveObjectArgs, ObserveObjectsArgs, Unsubscribable } from "../observable/ObservableClient.js";
+export type { Observer } from "../observable/ObservableClient/common.js";
+export type { ObserveLinks } from "../observable/ObservableClient/ObserveLink.js";
 export { getMetaTagContent, getOsdkConfig } from "../public-utils/osdkConfig.js";
+export type { OsdkConfig } from "../public-utils/osdkConfig.js";
 export { createClientWithTransaction } from "../createClient.js";

package/build/types/public/unstable-do-not-use.d.ts.map

@@ -1 +1 @@
-{"mappings":"AAgBA,SAAS,eAAe;AAGxB,cAAc,8BAA8B;AAC5C,SAAS,8BAA8B;AACvC,cACE,kBACA,mBACA,oBACA,UACA,sBACK;AACP,cAAc,kBAAkB;AAChC,SACE,mBACA,qBACK;AAEP,SAAS,mCAAmC","names":[],"sources":["../../../src/public/unstable-do-not-use.ts"],"version":3,"file":"unstable-do-not-use.d.ts"}
+{"mappings":"AAgBA,SAAS,eAAe;AAGxB,cAAc,8BAA8B;AAC5C,SAAS,8BAA8B;AACvC,cACE,kBACA,mBACA,oBACA,sBACK;AACP,cAAc,gBAAgB;AAC9B,cAAc,oBAAoB;AAClC,SACE,mBACA,qBACK;AACP,cAAc,kBAAkB;AAEhC,SAAS,mCAAmC","names":[],"sources":["../../../src/public/unstable-do-not-use.ts"],"version":3,"file":"unstable-do-not-use.d.ts"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@osdk/client",
-  "version": "2.5.0-beta.1",
+  "version": "2.5.0-beta.2",
   "description": "",
   "access": "public",
   "license": "Apache-2.0",
@@ -47,8 +47,8 @@
     }
   },
   "dependencies": {
-    "@osdk/foundry.core": "2.25.0",
-    "@osdk/foundry.ontologies": "2.25.0",
+    "@osdk/foundry.core": "2.26.0",
+    "@osdk/foundry.ontologies": "2.26.0",
     "@osdk/shared.client": "^1.0.1",
     "@osdk/shared.client2": "^1.0.0",
     "@types/geojson": "^7946.0.14",
@@ -65,12 +65,12 @@
     "tiny-invariant": "^1.3.1",
     "type-fest": "^4.18.2",
     "ws": "^8.18.0",
-    "@osdk/api": "2.5.0-beta.1",
-    "@osdk/client.unstable": "2.5.0-beta.1",
-    "@osdk/generator-converters": "2.5.0-beta.1",
+    "@osdk/api": "2.5.0-beta.2",
+    "@osdk/client.unstable": "2.5.0-beta.2",
+    "@osdk/shared.client.impl": "~1.5.0-beta.1",
+    "@osdk/generator-converters": "2.5.0-beta.2",
     "@osdk/shared.net.errors": "~2.5.0-beta.1",
-    "@osdk/shared.net.fetch": "~1.5.0-beta.1",
-    "@osdk/shared.client.impl": "~1.5.0-beta.1"
+    "@osdk/shared.net.fetch": "~1.5.0-beta.1"
   },
   "devDependencies": {
     "@microsoft/api-documenter": "^7.26.5",
@@ -91,10 +91,10 @@
     "ts-expect": "^1.3.0",
     "typescript": "~5.5.4",
     "zod": "^3.23.8",
-    "@osdk/client.test.ontology": "~2.5.0-beta.1",
+    "@osdk/client.test.ontology": "~2.5.0-beta.2",
     "@osdk/monorepo.api-extractor": "~0.4.0-beta.1",
     "@osdk/monorepo.tsconfig": "~0.4.0-beta.1",
-    "@osdk/shared.test": "~2.5.0-beta.1"
+    "@osdk/shared.test": "~2.5.0-beta.2"
   },
   "publishConfig": {
     "access": "public"