@osdk/api 2.5.0-beta.1 → 2.5.0-beta.3

package/build/types/OsdkObjectFrom.d.ts

@@ -1,5 +1,5 @@
 import type { DefaultToFalse, OsdkObjectLinksObject } from "./definitions/LinkDefinitions.js";
-import type { NullabilityAdherence } from "./object/FetchPageArgs.js";
+import type { NullabilityAdherence, ObjectSetArgs } from "./object/FetchPageArgs.js";
 import type { UnionIfTrue } from "./object/FetchPageResult.js";
 import type { InterfaceDefinition, InterfaceMetadata } from "./ontology/InterfaceDefinition.js";
 import type { ObjectOrInterfaceDefinition, PropertyKeys } from "./ontology/ObjectOrInterface.js";
@@ -23,6 +23,11 @@ export type MapPropNamesToObjectType<
 	P extends ValidOsdkPropParams<FROM>,
 	OPTIONS extends never | "$rid" | "$allBaseProperties" = never
 > = "$allBaseProperties" extends OPTIONS ? PropertyKeys<FROM> extends P ? PropertyKeys<TO> : PropMapToObject<FROM, TO>[JustProps<FROM, P> & keyof PropMapToObject<FROM, TO>] : PropMapToObject<FROM, TO>[JustProps<FROM, P> & keyof PropMapToObject<FROM, TO>];
+type NamespaceOf<S extends string> = S extends `${infer Before}.${infer After}` ? After extends `${string}.${string}` ? `${Before}.${NamespaceOf<After>}` : Before : never;
+type MaybeStripNamespaces<
+	S extends string,
+	TO extends InterfaceDefinition
+> = S extends `${NamespaceOf<S>}.${infer Rest}` ? NamespaceOf<S> extends NamespaceOf<ApiNameAsString<TO>> ? Rest : S : S;
 export type PropMapToInterface<
 	FROM extends ObjectTypeDefinition,
 	TO extends InterfaceDefinition
@@ -31,7 +36,7 @@ export type MapPropNamesToInterface<
 	FROM extends ObjectTypeDefinition,
 	TO extends InterfaceDefinition,
 	P extends ValidOsdkPropParams<FROM>
-> = PropMapToInterface<FROM, TO>[JustProps<FROM, P> & keyof PropMapToInterface<FROM, TO>];
+> = MaybeStripNamespaces<PropMapToInterface<FROM, TO>[JustProps<FROM, P> & keyof PropMapToInterface<FROM, TO>], TO>;
 /**
 * Older version of this helper that allows for `$rid` and co in
 * the properties field.
@@ -66,6 +71,12 @@ export type Osdk<
 	OPTIONS extends string = never,
 	P extends PropertyKeys<Q> = PropertyKeys<Q>
 > = IsNever<OPTIONS> extends true ? Osdk.Instance<Q, never, P> : IsAny<OPTIONS> extends true ? Osdk.Instance<Q, never, P> : (IsNever<Exclude<OPTIONS, "$rid">>) extends true ? Osdk.Instance<Q, OPTIONS & "$rid", P> : Osdk.Instance<Q, ("$rid" extends OPTIONS ? "$rid" : never), ExtractPropsKeysFromOldPropsStyle<Q, OPTIONS>>;
+export type MaybeScore<
+	T extends Osdk.Instance<any>,
+	ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<any>
+> = ORDER_BY_OPTIONS extends "relevance" ? T & {
+	$score: number
+} : T;
 export declare namespace Osdk {
 	type Instance<
 		Q extends ObjectOrInterfaceDefinition,

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

@@ -1 +1 @@
-{"mappings":"AAgBA,cACE,gBACA,6BACK,kCAAmC;AAC1C,cAAc,4BAA4B,2BAA4B;AACtE,cAAc,mBAAmB,6BAA8B;AAC/D,cACE,qBACA,yBACK,mCAAoC;AAC3C,cACE,6BACA,oBACK,iCAAkC;AACzC,cACE,qBACA,gBACA,4BACK,oCAAqC;AAC5C,cAAc,yBAAyB,iCAAkC;AACzE,cAAc,gBAAgB,eAAgB;KAYzC,wBACD,SACA,SACA,YACA;KAEC,oBAAoB,UAAU,+BAC/B,wBACA,aAAa;AAEjB,YAAY,gBACV,UAAU,+BACR,oBAAoB,GAAG;AAE3B,YAAY;CACV,UAAU;CACV,UAAU,oBAAoB;IAC5B,UAAU,SAAS,aAAa,KAChC,QAAQ,GAAG;AAEf,YAAY;CACV,aAAa;CACb,WAAW;IACT,YAAY,oBAAoB,IAAI,iBAAiB,gBAAgB;AAEzE,YAAY;CACV,aAAa;CACb,WAAW;CACX,UAAU,oBAAoB;CAC9B,wBAAwB,SAAS;IAC/B,6BAA6B,UAC7B,aAAa,cAAc,IAAI,aAAa,MAC5C,gBACA,MACA,IACA,UAAU,MAAM,WAAW,gBAAgB,MAAM,OACjD,gBACA,MACA,IACA,UAAU,MAAM,WAAW,gBAAgB,MAAM;AAErD,YAAY;CACV,aAAa;CACb,WAAW;IACT,YACF,oBAAoB,MAAM,wBAC1B,gBAAgB;AAElB,YAAY;CACV,aAAa;CACb,WAAW;CACX,UAAU,oBAAoB;IAC5B,mBACF,MACA,IACA,UAAU,MAAM,WAAW,mBAAmB,MAAM;;;;;;;;AAQtD,YAAY;CACV,aAAa;CACb,WAAW,YAAY;CACvB,UAAU,oBAAoB;CAC9B,wBAAwB,SAAS;IAC/B,WAAW,OAAO,IAClB,WAAW,wBACT,YACE,yBAAyB,MAAM,IAAI,GAAG,UACtC,UAAU,SAAS,OAAO,OAC1B,WAGJ,WAAW,sBAAsB,aAAa,wBAC1C,YACE,wBAAwB,MAAM,IAAI,IAClC,UAAU,SAAS,OAAO,OAC1B;;AAOV,YAAY,YACV,aAAa,+BACX,aAAa,sBAAsB,8BACnC;AAEJ,YAAY,QAAQ,MAAM,qBAAqB,OAAO;KAEjD;CACH,UAAU;CACV,UAAU,oBAAoB;IAC5B,UAAU,SAAS,aAAa,KAChC,QAAQ,GAAG,YAAY,eAAe;AAE1C,YAAY,MAAM,qBAAqB,WAC5B,qBAAqB,QAAQ,OACpC;AAEJ,YAAY;CACV,UAAU;CACV,UAAU,aAAa;CACvB,oBAAoB;IAClB,QAAQ,WAAW,OAAO,UAAU,eAAe,aAAa,KAChE,MAAM,WAAW,OAAO,aAAa,KACrC;;;;AAKJ,YAAY;CACV,UAAU;CACV;CACA,UAAU,aAAa,KAAK,aAAa;IAGzC,QAAQ,iBAAiB,OAAO,KAAK,SAAS,UAAU,KACpD,MAAM,iBAAiB,OAAO,KAAK,SAAS,UAAU,MAErD,QAAQ,QAAQ,SAAS,kBAAkB,OAC1C,KAAK,SAAS,GAAG,UAAU,QAAQ,KAGrC,KAAK,SACL,IACC,eAAe,UAAU,iBAC1B,kCAAkC,GAAG;AAG3C,yBAAiB;MACH;EACV,UAAU;EACV,wBAAwB,SAAS;EACjC,UAAU,aAAa,KAAK,aAAa;EACzC,UAAU,eAAe,qBAAqB,CAAE;KAE9C,SAAS,KACT,KACA,oBAAoB,GAAG,UAEvB,aAAa,GAAG,IAAI,YAAY,CAAE,KAAI,QAAQ,WAE5C,qBAAqB,CAAE,OACpB,WAAW,KAAI,kBAAkB,kBAAkB,EAAE,SAC1D;WACS,OAAO,UAAU;GAAE;EAAiB,IAAG,EAAE,eAC9C,UAAU,uBAAuB,sBAAsB;WAGlD,MAAM,cAAc,YAAY,IACvCA,MAAM,mBACH,KAAK,SACR,OACA,SACA,aAAa,GAAG,OAAO,GAAG;WAGnB,SAAS,kBAAkB,aAAa,IAC/CC,gBACI,KAAK,SAAS,QAAQ,gBAErB,KAAK,cAAa,oBACjB,GACA,SAAS,SAEZ,KAAK,SAAS,GAAG,SAAS,IAAI;WAE1B,8CAA8C,UACrD,uBAAuB;GACrB,gBAAgB;EACjB,IACC;GACA,gBAAgB;GAChB,mBAAmB;EACpB;CACJ,KAEE,QAAQ,iBAAiB,OAAO,CAAE,IACjC,MAAM,iBAAiB,OAAO,CAAE,IAChC,eAAe,UAAU;WAAW;CAAc,IAClD,CAAE;;;;;;;;;AAUV,YAAY,oBAAoB,UAAU,wBACxC,QAAQ,WAAW,eACf,gBAAgB,YAChB,eAAe,YACf;;;;;;AAON,YAAY,iBAAiB,qBAC3B,QAAQ,WAAW,eACf,eAAe,WAAW,gBAC1B;AAEN,YAAY,2BAA2B,qBACrC,QAAQ,WAAW,eACf,eAAe,WAAW,gBAC1B;AAGN,YAAY;CACV;CACA,UAAU,uBAAuB,qBAAqB;CACtD,oBAAoB;IAClB,iBAAiB,KAAK,2BAA2B","names":["type: NEW_Q | string","updatedObject?:\n          | Osdk.Instance<Q, any, NEW_PROPS>\n          | {\n            [K in NEW_PROPS]?: CompileTimeMetadata<\n              Q\n            >[\"props\"][K];\n          }"],"sources":["../../src/OsdkObjectFrom.ts"],"version":3,"file":"OsdkObjectFrom.d.ts"}
+{"mappings":"AAgBA,cACE,gBACA,6BACK,kCAAmC;AAC1C,cACE,sBACA,qBACK,2BAA4B;AACnC,cAAc,mBAAmB,6BAA8B;AAC/D,cACE,qBACA,yBACK,mCAAoC;AAC3C,cACE,6BACA,oBACK,iCAAkC;AACzC,cACE,qBACA,gBACA,4BACK,oCAAqC;AAC5C,cAAc,yBAAyB,iCAAkC;AACzE,cAAc,gBAAgB,eAAgB;KAYzC,wBACD,SACA,SACA,YACA;KAEC,oBAAoB,UAAU,+BAC/B,wBACA,aAAa;AAEjB,YAAY,gBACV,UAAU,+BACR,oBAAoB,GAAG;AAE3B,YAAY;CACV,UAAU;CACV,UAAU,oBAAoB;IAC5B,UAAU,SAAS,aAAa,KAChC,QAAQ,GAAG;AAEf,YAAY;CACV,aAAa;CACb,WAAW;IACT,YAAY,oBAAoB,IAAI,iBAAiB,gBAAgB;AAEzE,YAAY;CACV,aAAa;CACb,WAAW;CACX,UAAU,oBAAoB;CAC9B,wBAAwB,SAAS;IAC/B,6BAA6B,UAC7B,aAAa,cAAc,IAAI,aAAa,MAC5C,gBACA,MACA,IACA,UAAU,MAAM,WAAW,gBAAgB,MAAM,OACjD,gBACA,MACA,IACA,UAAU,MAAM,WAAW,gBAAgB,MAAM;KAEhD,YAAY,oBAAoB,mBAAmB,gBAAgB,UACpE,yCAAyC,UAAU,YAAY,WAC/D;KAGC;CAAqB;CAAkB,WAAW;IACrD,aAAa,YAAY,YAAY,SACjC,YAAY,WAAW,YAAY,gBAAgB,OAAO,OAAO,IACjE;AAEN,YAAY;CACV,aAAa;CACb,WAAW;IACT,YACF,oBAAoB,MAAM,wBAC1B,gBAAgB;AAElB,YAAY;CACV,aAAa;CACb,WAAW;CACX,UAAU,oBAAoB;IAC5B,qBACF,mBACE,MACA,IACA,UAAU,MAAM,WAAW,mBAAmB,MAAM,MACtD;;;;;;;;AASF,YAAY;CACV,aAAa;CACb,WAAW,YAAY;CACvB,UAAU,oBAAoB;CAC9B,wBAAwB,SAAS;IAC/B,WAAW,OAAO,IAClB,WAAW,wBACT,YACE,yBAAyB,MAAM,IAAI,GAAG,UACtC,UAAU,SAAS,OAAO,OAC1B,WAGJ,WAAW,sBAAsB,aAAa,wBAC1C,YACE,wBAAwB,MAAM,IAAI,IAClC,UAAU,SAAS,OAAO,OAC1B;;AAOV,YAAY,YACV,aAAa,+BACX,aAAa,sBAAsB,8BACnC;AAEJ,YAAY,QAAQ,MAAM,qBAAqB,OAAO;KAEjD;CACH,UAAU;CACV,UAAU,oBAAoB;IAC5B,UAAU,SAAS,aAAa,KAChC,QAAQ,GAAG,YAAY,eAAe;AAE1C,YAAY,MAAM,qBAAqB,WAC5B,qBAAqB,QAAQ,OACpC;AAEJ,YAAY;CACV,UAAU;CACV,UAAU,aAAa;CACvB,oBAAoB;IAClB,QAAQ,WAAW,OAAO,UAAU,eAAe,aAAa,KAChE,MAAM,WAAW,OAAO,aAAa,KACrC;;;;AAKJ,YAAY;CACV,UAAU;CACV;CACA,UAAU,aAAa,KAAK,aAAa;IAGzC,QAAQ,iBAAiB,OAAO,KAAK,SAAS,UAAU,KACpD,MAAM,iBAAiB,OAAO,KAAK,SAAS,UAAU,MAErD,QAAQ,QAAQ,SAAS,kBAAkB,OAC1C,KAAK,SAAS,GAAG,UAAU,QAAQ,KAGrC,KAAK,SACL,IACC,eAAe,UAAU,iBAC1B,kCAAkC,GAAG;AAG3C,YAAY;CACV,UAAU,KAAK;CACf,yBAAyB,cAAc;IACrC,yBAAyB,cAAc,IAAI;CAAE;AAAgB,IAAG;AAEpE,yBAAiB;MACH;EACV,UAAU;EACV,wBAAwB,SAAS;EACjC,UAAU,aAAa,KAAK,aAAa;EACzC,UAAU,eAAe,qBAAqB,CAAE;KAE9C,SAAS,KACT,KACA,oBAAoB,GAAG,UAEvB,aAAa,GAAG,IAAI,YAAY,CAAE,KAAI,QAAQ,WAE5C,qBAAqB,CAAE,OACpB,WAAW,KAAI,kBAAkB,kBAAkB,EAAE,SAC1D;WACS,OAAO,UAAU;GAAE;EAAiB,IAAG,EAAE,eAC9C,UAAU,uBAAuB,sBAAsB;WAGlD,MAAM,cAAc,YAAY,IACvCA,MAAM,mBACH,KAAK,SACR,OACA,SACA,aAAa,GAAG,OAAO,GAAG;WAGnB,SAAS,kBAAkB,aAAa,IAC/CC,gBACI,KAAK,SAAS,QAAQ,gBAErB,KAAK,cAAa,oBACjB,GACA,SAAS,SAEZ,KAAK,SAAS,GAAG,SAAS,IAAI;WAE1B,8CAA8C,UACrD,uBAAuB;GACrB,gBAAgB;EACjB,IACC;GACA,gBAAgB;GAChB,mBAAmB;EACpB;CACJ,KAEE,QAAQ,iBAAiB,OAAO,CAAE,IACjC,MAAM,iBAAiB,OAAO,CAAE,IAChC,eAAe,UAAU;WAAW;CAAc,IAClD,CAAE;;;;;;;;;AAUV,YAAY,oBAAoB,UAAU,wBACxC,QAAQ,WAAW,eACf,gBAAgB,YAChB,eAAe,YACf;;;;;;AAON,YAAY,iBAAiB,qBAC3B,QAAQ,WAAW,eACf,eAAe,WAAW,gBAC1B;AAEN,YAAY,2BAA2B,qBACrC,QAAQ,WAAW,eACf,eAAe,WAAW,gBAC1B;AAGN,YAAY;CACV;CACA,UAAU,uBAAuB,qBAAqB;CACtD,oBAAoB;IAClB,iBAAiB,KAAK,2BAA2B","names":["type: NEW_Q | string","updatedObject?:\n          | Osdk.Instance<Q, any, NEW_PROPS>\n          | {\n            [K in NEW_PROPS]?: CompileTimeMetadata<\n              Q\n            >[\"props\"][K];\n          }"],"sources":["../../src/OsdkObjectFrom.ts"],"version":3,"file":"OsdkObjectFrom.d.ts"}

package/build/types/experimental/fetchPageByRid.d.ts

@@ -9,7 +9,14 @@ type fetchPageByRidFn = <
 	const S extends NullabilityAdherence,
 	const T extends boolean
 >(objectType: Q, rids: string[], options?: FetchPageArgs<Q, L, R, any, S, T>) => Promise<FetchPageResult<Q, L, R, S, T>>;
-export declare const __EXPERIMENTAL__NOT_SUPPORTED_YET__fetchPageByRid: Experiment<"2.2.0", "__EXPERIMENTAL__NOT_SUPPORTED_YET__fetchPageByRid", {
+export type FetchPageByRidPayload = {
 	fetchPageByRid: fetchPageByRidFn
-}>;
+	fetchPageByRidNoType: fetchPageByRidNoTypeFn
+};
+type fetchPageByRidNoTypeFn = <
+	const R extends boolean,
+	const S extends NullabilityAdherence,
+	const T extends boolean
+>(rids: readonly string[], options?: FetchPageArgs<ObjectOrInterfaceDefinition, any, R, any, S, T>) => Promise<FetchPageResult<ObjectOrInterfaceDefinition, any, R, S, T>>;
+export declare const __EXPERIMENTAL__NOT_SUPPORTED_YET__fetchPageByRid: Experiment<"2.2.0", "__EXPERIMENTAL__NOT_SUPPORTED_YET__fetchPageByRid", FetchPageByRidPayload>;
 export {};

package/build/types/experimental/fetchPageByRid.d.ts.map

@@ -1 +1 @@
-{"mappings":"AAgBA,cACE,eACA,4BACK,4BAA6B;AACpC,cAAc,uBAAuB,8BAA+B;AAEpE,cACE,6BACA,oBACK,kCAAmC;AAC1C,cAAc,kBAAkB,iBAAkB;KAE7C;CACH,UAAU;OACJ,UAAU,aAAa;OACvB;OACA,UAAU;OACV;EAENA,YAAY,GACZC,gBACAC,UAAU,cAAc,GAAG,GAAG,QAAQ,GAAG,OACtC,QAAQ,gBAAgB,GAAG,GAAG,GAAG,GAAG;AAEzC,OAAO,cAAMC,mDAAmD,WAC9D,SACA,qDACA;CAAE,gBAAgB;AAAkB","names":["objectType: Q","rids: string[]","options?: FetchPageArgs<Q, L, R, any, S, T>","__EXPERIMENTAL__NOT_SUPPORTED_YET__fetchPageByRid: Experiment<\n  \"2.2.0\",\n  \"__EXPERIMENTAL__NOT_SUPPORTED_YET__fetchPageByRid\",\n  { fetchPageByRid: fetchPageByRidFn }\n>"],"sources":["../../../src/experimental/fetchPageByRid.ts"],"version":3,"file":"fetchPageByRid.d.ts"}
+{"mappings":"AAgBA,cACE,eACA,4BACK,4BAA6B;AACpC,cAAc,uBAAuB,8BAA+B;AAEpE,cACE,6BACA,oBACK,kCAAmC;AAC1C,cAAc,kBAAkB,iBAAkB;KAE7C;CACH,UAAU;OACJ,UAAU,aAAa;OACvB;OACA,UAAU;OACV;EAENA,YAAY,GACZC,gBACAC,UAAU,cAAc,GAAG,GAAG,QAAQ,GAAG,OACtC,QAAQ,gBAAgB,GAAG,GAAG,GAAG,GAAG;AAEzC,YAAY,wBAAwB;CAClC,gBAAgB;CAChB,sBAAsB;AACvB;KAEI;OACG;OACA,UAAU;OACV;EAENC,yBACAC,UAAU,cAAc,kCAAkC,QAAQ,GAAG,OAClE,QAAQ,gBAAgB,kCAAkC,GAAG,GAAG;AAErE,OAAO,cAAMC,mDAAmD,WAC9D,SACA,qDACA","names":["objectType: Q","rids: string[]","options?: FetchPageArgs<Q, L, R, any, S, T>","rids: readonly string[]","options?: FetchPageArgs<ObjectOrInterfaceDefinition, any, R, any, S, T>","__EXPERIMENTAL__NOT_SUPPORTED_YET__fetchPageByRid: Experiment<\n  \"2.2.0\",\n  \"__EXPERIMENTAL__NOT_SUPPORTED_YET__fetchPageByRid\",\n  FetchPageByRidPayload\n>"],"sources":["../../../src/experimental/fetchPageByRid.ts"],"version":3,"file":"fetchPageByRid.d.ts"}

package/build/types/index.d.ts

@@ -38,7 +38,7 @@ export type { InterfaceQueryDataType, ObjectQueryDataType, ObjectSetQueryDataTyp
 export type { BaseWirePropertyTypes, WirePropertyTypes } from "./ontology/WirePropertyTypes.js";
 export type { ObjectIdentifiers, OsdkBase, PrimaryKeyType } from "./OsdkBase.js";
 export type { OsdkObject } from "./OsdkObject.js";
-export type { ConvertProps, Osdk } from "./OsdkObjectFrom.js";
+export type { ConvertProps, MaybeScore, Osdk } from "./OsdkObjectFrom.js";
 export type { PageResult } from "./PageResult.js";
 export type { Range, ThreeDimensionalAggregation, TwoDimensionalAggregation } from "./queries/Aggregations.js";
 export type { QueryParam, QueryResult } from "./queries/Queries.js";

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

@@ -1 +1 @@
-{"mappings":"AAgBA,cAAc,kCAAkC;AAChD,cACE,oBACA,aACA,0BACA,oBACA,+BACK;AACP,SAAS,kBAAkB;AAC3B,cAAc,4BAA4B;AAC1C,cAAc,qBAAqB;AACnC,cAAc,sEAAsE;AACpF,cAAc,oCAAoC;AAClD,cAAc,uCAAuC;AACrD,cAAc,yBAAyB;AACvC,cAAc,2BAA2B;AACzC,cAAc,wBAAwB;AACtC,SAAS,2BAA2B;AACpC,cACE,sBACA,kBACA,4BACA,mBACK;AACP,cACE,8BACA,8BACK;AACP,cACE,uBACA,0BACK;AACP,cAAc,uBAAuB;AACrC,SAAS,uBAAuB;AAChC,cACE,kBACA,eACA,oBACK;AACP,cACE,uBACA,oBACA,uBACA,6BACK;AACP,cACE,iCACK;AACP,cAAc,YAAY,wBAAwB;AAClD,cACE,eACA,SACA,UACA,eACA,sBACA,eACA,WACA,uBACK;AACP,cACE,iBACA,wBACK;AACP,cACE,OACA,eACA,gBACA,mBACK;AACP,SAAS,YAAY;AACrB,cAAc,cAAc;AAC5B,cAAc,qBAAqB;AACnC,cAAc,iBAAiB;AAC/B,cAAc,6BAA6B;AAC3C,cACE,kBACA,sBACK;AACP,cACE,qBACA,yBACK;AACP,cACE,6BACA,oBACK;AACP,cAAc,uBAAuB;AACrC,cACE,qBACA,gBACA,sBACA,aACA,oBACK;AACP,cAAc,wBAAwB;AACtC,cAAc,uBAAuB;AACrC,cACE,wBACA,qBACA,wBACA,yBACA,iBACA,eACA,0BACA,4CACA,gDACK;AACP,cACE,uBACA,yBACK;AACP,cACE,mBACA,UACA,sBACK;AACP,cAAc,kBAAkB;AAChC,cAAc,cAAc,YAAY;AACxC,cAAc,kBAAkB;AAChC,cACE,OACA,6BACA,iCACK;AACP,cAAc,YAAY,mBAAmB;AAC7C,SAAS,iCAAiC;AAC1C,cACE,uBACA,iBACA,oBACA,uBACK;AACP,cAAc,YAAY,iBAAiB;AAC3C;AACA,cAAc,cAAc","names":[],"sources":["../../src/index.ts"],"version":3,"file":"index.d.ts"}
+{"mappings":"AAgBA,cAAc,kCAAkC;AAChD,cACE,oBACA,aACA,0BACA,oBACA,+BACK;AACP,SAAS,kBAAkB;AAC3B,cAAc,4BAA4B;AAC1C,cAAc,qBAAqB;AACnC,cAAc,sEAAsE;AACpF,cAAc,oCAAoC;AAClD,cAAc,uCAAuC;AACrD,cAAc,yBAAyB;AACvC,cAAc,2BAA2B;AACzC,cAAc,wBAAwB;AACtC,SAAS,2BAA2B;AACpC,cACE,sBACA,kBACA,4BACA,mBACK;AACP,cACE,8BACA,8BACK;AACP,cACE,uBACA,0BACK;AACP,cAAc,uBAAuB;AACrC,SAAS,uBAAuB;AAChC,cACE,kBACA,eACA,oBACK;AACP,cACE,uBACA,oBACA,uBACA,6BACK;AACP,cACE,iCACK;AACP,cAAc,YAAY,wBAAwB;AAClD,cACE,eACA,SACA,UACA,eACA,sBACA,eACA,WACA,uBACK;AACP,cACE,iBACA,wBACK;AACP,cACE,OACA,eACA,gBACA,mBACK;AACP,SAAS,YAAY;AACrB,cAAc,cAAc;AAC5B,cAAc,qBAAqB;AACnC,cAAc,iBAAiB;AAC/B,cAAc,6BAA6B;AAC3C,cACE,kBACA,sBACK;AACP,cACE,qBACA,yBACK;AACP,cACE,6BACA,oBACK;AACP,cAAc,uBAAuB;AACrC,cACE,qBACA,gBACA,sBACA,aACA,oBACK;AACP,cAAc,wBAAwB;AACtC,cAAc,uBAAuB;AACrC,cACE,wBACA,qBACA,wBACA,yBACA,iBACA,eACA,0BACA,4CACA,gDACK;AACP,cACE,uBACA,yBACK;AACP,cACE,mBACA,UACA,sBACK;AACP,cAAc,kBAAkB;AAChC,cAAc,cAAc,YAAY,YAAY;AACpD,cAAc,kBAAkB;AAChC,cACE,OACA,6BACA,iCACK;AACP,cAAc,YAAY,mBAAmB;AAC7C,SAAS,iCAAiC;AAC1C,cACE,uBACA,iBACA,oBACA,uBACK;AACP,cAAc,YAAY,iBAAiB;AAC3C;AACA,cAAc,cAAc","names":[],"sources":["../../src/index.ts"],"version":3,"file":"index.d.ts"}

package/build/types/object/FetchPageArgs.d.ts

@@ -12,15 +12,20 @@ export declare namespace ObjectSetArgs {
 		$select?: readonly (OBJECT_KEYS | RDP_KEYS)[];
 		$includeRid?: boolean;
 	}
-	interface OrderBy<L extends string = never> {
-		$orderBy?: { [K in L]? : "asc" | "desc" };
+	type OrderByOptions<L extends string> = { [K in L]? : "asc" | "desc" } | "relevance";
+	interface OrderBy<
+		ORDER_BY_OPTIONS extends OrderByOptions<L>,
+		L extends string = never
+	> {
+		$orderBy?: ORDER_BY_OPTIONS;
 	}
 	interface AsyncIter<
 		Q extends ObjectOrInterfaceDefinition,
 		K extends PropertyKeys<Q> = never,
 		T extends boolean = false,
-		RDP_KEYS extends string = never
-	> extends Select<K, RDP_KEYS>, OrderBy<K> {
+		RDP_KEYS extends string = never,
+		ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<K> = never
+	> extends Select<K, RDP_KEYS>, OrderBy<ORDER_BY_OPTIONS, K> {
 		$__UNSTABLE_useOldInterfaceApis?: boolean;
 		$includeAllBaseObjectProperties?: PropertyKeys<Q> extends K ? T : never;
 	}
@@ -28,8 +33,9 @@ export declare namespace ObjectSetArgs {
 		Q extends ObjectOrInterfaceDefinition,
 		K extends PropertyKeys<Q> = never,
 		T extends boolean = false,
-		RDP_KEYS extends string = never
-	> extends AsyncIter<Q, K, T, RDP_KEYS> {
+		RDP_KEYS extends string = never,
+		ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<K> = never
+	> extends AsyncIter<Q, K, T, RDP_KEYS, ORDER_BY_OPTIONS> {
 		$nextPageToken?: string;
 		$pageSize?: number;
 	}
@@ -46,8 +52,9 @@ export interface SelectArg<
 }
 export interface OrderByArg<
 	Q extends ObjectOrInterfaceDefinition,
-	L extends string = PropertyKeys<Q>
-> extends ObjectSetArgs.OrderBy<L> {}
+	L extends string = PropertyKeys<Q>,
+	ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<L> = never
+> extends ObjectSetArgs.OrderBy<ORDER_BY_OPTIONS, L> {}
 export type SelectArgToKeys<
 	Q extends ObjectOrInterfaceDefinition,
 	A extends SelectArg<Q, any, any>
@@ -59,8 +66,9 @@ export interface FetchPageArgs<
 	A extends Augments = never,
 	S extends NullabilityAdherence = NullabilityAdherence.Default,
 	T extends boolean = false,
-	RDP_KEYS extends string = never
-> extends AsyncIterArgs<Q, K, R, A, S, T, RDP_KEYS> {
+	RDP_KEYS extends string = never,
+	ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<K> = {}
+> extends AsyncIterArgs<Q, K, R, A, S, T, RDP_KEYS, ORDER_BY_OPTIONS> {
 	$nextPageToken?: string;
 	$pageSize?: number;
 }
@@ -71,8 +79,9 @@ export interface AsyncIterArgs<
 	A extends Augments = never,
 	S extends NullabilityAdherence = NullabilityAdherence.Default,
 	T extends boolean = false,
-	RDP_KEYS extends string = never
-> extends SelectArg<Q, K, R, S, RDP_KEYS>, OrderByArg<Q, PropertyKeys<Q> | RDP_KEYS> {
+	RDP_KEYS extends string = never,
+	ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<K> = never
+> extends SelectArg<Q, K, R, S, RDP_KEYS>, OrderByArg<Q, PropertyKeys<Q> | RDP_KEYS, ORDER_BY_OPTIONS> {
 	$__UNSTABLE_useOldInterfaceApis?: boolean;
 	$includeAllBaseObjectProperties?: PropertyKeys<Q> extends K ? T : never;
 }

package/build/types/object/FetchPageArgs.d.ts.map

@@ -1 +1 @@
-{"mappings":"AAgBA,cACE,6BACA,oBACK,kCAAmC;AAC1C,cAAc,2BAA2B,qCAAsC;AAE/E,YAAY,uBAAuB,QAAQ,UAAU;AACrD,yBAAiB;MACH,UAAU;;AAGxB,yBAAiB;WACE;EACf;EACA;GACA;EACA,oBAAoB,cAAc;EAClC;CACD;WAEgB,QACf,0BACA;EACA,cACG,KAAK,MAAK,QAAQ;CAEtB;WAEgB;EACf,UAAU;EACV,UAAU,aAAa;EACvB,oBAAoB;EACpB;WACQ,OAAO,GAAG,WAAW,QAAQ,GAAG;EACxC;EACA,kCAAkC,aAAa,WAAW,IAAI;CAC/D;WAEgB;EACf,UAAU;EACV,UAAU,aAAa;EACvB,oBAAoB;EACpB;WACQ,UAAU,GAAG,GAAG,GAAG,UAAU;EACrC;EACA;CACD;;AAGH,iBAAiB;CACf,UAAU;CACV,mBAAmB,aAAa;CAChC,oBAAoB;CACpB,UAAU,uBAAuB,qBAAqB;CACtD;EACA;CACA,mBAAmB;CACnB,cAAc;AACf;AAED,iBAAiB;CACf,UAAU;CACV,mBAAmB,aAAa;UACxB,cAAc,QAAQ,GAAG,CAClC;AAED,YAAY;CACV,UAAU;CACV,UAAU,UAAU;IAClB,UAAU,UAAU,YAAY,aAAa,KAC7C,EAAE,uCAAuC,EAAE,qBAC3C,aAAa;AAEjB,iBAAiB;CACf,UAAU;CACV,mBAAmB,aAAa;CAChC,oBAAoB;CACpB,UAAU;CACV,UAAU,uBAAuB,qBAAqB;CACtD,oBAAoB;CACpB;UACQ,cAAc,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,UAAU;CAClD;CACA;AACD;AAED,iBAAiB;CACf,UAAU;CACV,mBAAmB,aAAa;CAChC,oBAAoB;CACpB,UAAU;CACV,UAAU,uBAAuB,qBAAqB;CACtD,oBAAoB;CACpB;UAEA,UAAU,GAAG,GAAG,GAAG,GAAG,WACtB,WAAW,GAAG,aAAa,KAAK,UAClC;CACE;CACA,kCAAkC,aAAa,WAAW,IAAI;AAC/D;AAED,YAAY;CACV,UAAU;CACV;OACK,KAAK,oBAAoB,GAAG,cAAa;AAEhD,YAAY,WAAW","names":[],"sources":["../../../src/object/FetchPageArgs.ts"],"version":3,"file":"FetchPageArgs.d.ts"}
+{"mappings":"AAgBA,cACE,6BACA,oBACK,kCAAmC;AAC1C,cAAc,2BAA2B,qCAAsC;AAE/E,YAAY,uBAAuB,QAAQ,UAAU;AACrD,yBAAiB;MACH,UAAU;;AAGxB,yBAAiB;WACE;EACf;EACA;GACA;EACA,oBAAoB,cAAc;EAClC;CACD;MAEW,eAAe,uBAEtB,KAAK,MAAK,QAAQ,WAEnB;WAEa;EACf,yBAAyB,eAAe;EACxC;GACA;EACA,WAAW;CACZ;WAEgB;EACf,UAAU;EACV,UAAU,aAAa;EACvB,oBAAoB;EACpB;EACA,yBAAyB,cAAc,eAAe;WAC9C,OAAO,GAAG,WAAW,QAAQ,kBAAkB,GAAG;EAC1D;EACA,kCAAkC,aAAa,WAAW,IAAI;CAC/D;WAEgB;EACf,UAAU;EACV,UAAU,aAAa;EACvB,oBAAoB;EACpB;EACA,yBAAyB,cAAc,eAAe;WAC9C,UAAU,GAAG,GAAG,GAAG,UAAU,kBAAkB;EACvD;EACA;CACD;;AAGH,iBAAiB;CACf,UAAU;CACV,mBAAmB,aAAa;CAChC,oBAAoB;CACpB,UAAU,uBAAuB,qBAAqB;CACtD;EACA;CACA,mBAAmB;CACnB,cAAc;AACf;AAED,iBAAiB;CACf,UAAU;CACV,mBAAmB,aAAa;CAChC,yBAAyB,cAAc,eAAe;UAC9C,cAAc,QAAQ,kBAAkB,GAAG,CACpD;AAED,YAAY;CACV,UAAU;CACV,UAAU,UAAU;IAClB,UAAU,UAAU,YAAY,aAAa,KAC7C,EAAE,uCAAuC,EAAE,qBAC3C,aAAa;AAEjB,iBAAiB;CACf,UAAU;CACV,mBAAmB,aAAa;CAChC,oBAAoB;CACpB,UAAU;CACV,UAAU,uBAAuB,qBAAqB;CACtD,oBAAoB;CACpB;CACA,yBAAyB,cAAc,eAAe,KAAK,CAAE;UACrD,cAAc,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,UAAU,kBAAkB;CACpE;CACA;AACD;AAED,iBAAiB;CACf,UAAU;CACV,mBAAmB,aAAa;CAChC,oBAAoB;CACpB,UAAU;CACV,UAAU,uBAAuB,qBAAqB;CACtD,oBAAoB;CACpB;CACA,yBAAyB,cAAc,eAAe;UAEtD,UAAU,GAAG,GAAG,GAAG,GAAG,WACtB,WAAW,GAAG,aAAa,KAAK,UAAU,kBAC5C;CACE;CACA,kCAAkC,aAAa,WAAW,IAAI;AAC/D;AAED,YAAY;CACV,UAAU;CACV;OACK,KAAK,oBAAoB,GAAG,cAAa;AAEhD,YAAY,WAAW","names":[],"sources":["../../../src/object/FetchPageArgs.ts"],"version":3,"file":"FetchPageArgs.d.ts"}

package/build/types/object/FetchPageResult.d.ts

@@ -1,8 +1,8 @@
 import type { ObjectOrInterfaceDefinition, PropertyKeys } from "../ontology/ObjectOrInterface.js";
 import type { SimplePropertyDef } from "../ontology/SimplePropertyDef.js";
-import type { ExtractOptions, IsNever, Osdk } from "../OsdkObjectFrom.js";
+import type { ExtractOptions, IsNever, MaybeScore, Osdk } from "../OsdkObjectFrom.js";
 import type { PageResult } from "../PageResult.js";
-import type { NullabilityAdherence } from "./FetchPageArgs.js";
+import type { NullabilityAdherence, ObjectSetArgs } from "./FetchPageArgs.js";
 /** exposed for a test */
 export type RespectNullability<S extends NullabilityAdherence> = S extends false ? false : true;
 /** exposed for a test */
@@ -25,8 +25,9 @@ export type FetchPageResult<
 	L extends PropertyKeys<Q>,
 	R extends boolean,
 	S extends NullabilityAdherence,
-	T extends boolean = false
-> = PageResult<PropertyKeys<Q> extends L ? Osdk.Instance<Q, ExtractOptions<R, S, T>> : Osdk.Instance<Q, ExtractOptions<R, S, T>, L>>;
+	T extends boolean = false,
+	ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<L> = {}
+> = PageResult<MaybeScore<Osdk.Instance<Q, ExtractOptions<R, S, T>, PropertyKeys<Q> extends L ? never : L>, ORDER_BY_OPTIONS>>;
 /**
 * Helper type for converting fetch options into an Osdk object
 */
@@ -36,6 +37,7 @@ export type SingleOsdkResult<
 	R extends boolean,
 	S extends NullabilityAdherence,
 	RDPs extends Record<string, SimplePropertyDef> = {},
-	T extends boolean = false
-> = Osdk.Instance<Q, ExtractOptions<R, S, T>, PropertyKeys<Q> extends L ? PropertyKeys<Q> : PropertyKeys<Q> & L, { [K in Extract<keyof RDPs, L>] : RDPs[K] }>;
+	T extends boolean = false,
+	ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<L> = {}
+> = MaybeScore<Osdk.Instance<Q, ExtractOptions<R, S, T>, PropertyKeys<Q> extends L ? PropertyKeys<Q> : PropertyKeys<Q> & L, { [K in Extract<keyof RDPs, L>] : RDPs[K] }>, ORDER_BY_OPTIONS>;
 export type IsAny<T> = unknown extends T ? [keyof T] extends [never] ? false : true : false;

package/build/types/object/FetchPageResult.d.ts.map

@@ -1 +1 @@
-{"mappings":"AAgBA,cACE,6BACA,oBACK,kCAAmC;AAC1C,cAAc,yBAAyB,kCAAmC;AAC1E,cAAc,gBAAgB,SAAS,YAAY,sBAAuB;AAC1E,cAAc,kBAAkB,kBAAmB;AACnD,cAAc,4BAA4B,oBAAqB;;AAG/D,YAAY,mBAAmB,UAAU,wBAAwB,UAAU,QACvE,QACA;;AAGJ,YAAY;CAAa;CAAkB;CAAgC;IACzE,QAAQ,WAAW,eACf,uBAAuB,OAAO,IAC9B,IAAI;;AAGV,YAAY;CACV;CACA;CACA;IACE,QAAQ,WAAW,eACnB,sBAAsB,OAAO,IAAI,IACjC;;;;AAKJ,YAAY;CACV,UAAU;CACV,UAAU,aAAa;CACvB;CACA,UAAU;CACV,oBAAoB;IAClB,WACF,aAAa,WAAW,IAAI,KAAK,SAAS,GAAG,eAAe,GAAG,GAAG,MAC9D,KAAK,SAAS,GAAG,eAAe,GAAG,GAAG,IAAI;;;;AAMhD,YAAY;CACV,UAAU;CACV,UAAU,aAAa,YAAY;CACnC;CACA,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;CACnD,oBAAoB;IAClB,KAAK,SACP,GACA,eAAe,GAAG,GAAG,IACrB,aAAa,WAAW,IAAI,aAAa,KAAK,aAAa,KAAK,MAC7D,KAAK,cAAc,MAAM,MAAK,KAAK;AAGxC,YAAY,MAAM,qBAAqB,WAC5B,qBAAqB,QAAQ,OACpC","names":[],"sources":["../../../src/object/FetchPageResult.ts"],"version":3,"file":"FetchPageResult.d.ts"}
+{"mappings":"AAgBA,cACE,6BACA,oBACK,kCAAmC;AAC1C,cAAc,yBAAyB,kCAAmC;AAC1E,cACE,gBACA,SACA,YACA,YACK,sBAAuB;AAC9B,cAAc,kBAAkB,kBAAmB;AACnD,cAAc,sBAAsB,qBAAqB,oBAAqB;;AAG9E,YAAY,mBAAmB,UAAU,wBAAwB,UAAU,QACvE,QACA;;AAGJ,YAAY;CAAa;CAAkB;CAAgC;IACzE,QAAQ,WAAW,eACf,uBAAuB,OAAO,IAC9B,IAAI;;AAGV,YAAY;CACV;CACA;CACA;IACE,QAAQ,WAAW,eACnB,sBAAsB,OAAO,IAAI,IACjC;;;;AAKJ,YAAY;CACV,UAAU;CACV,UAAU,aAAa;CACvB;CACA,UAAU;CACV,oBAAoB;CACpB,yBAAyB,cAAc,eAAe,KAAK,CAAE;IAC3D,WACF,WACE,KAAK,SACH,GACA,eAAe,GAAG,GAAG,IACrB,aAAa,WAAW,YAAY,IAEtC;;;;AAOJ,YAAY;CACV,UAAU;CACV,UAAU,aAAa,YAAY;CACnC;CACA,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;CACnD,oBAAoB;CACpB,yBAAyB,cAAc,eAAe,KAAK,CAAE;IAC3D,WACF,KAAK,SACH,GACA,eAAe,GAAG,GAAG,IACrB,aAAa,WAAW,IAAI,aAAa,KAAK,aAAa,KAAK,MAC7D,KAAK,cAAc,MAAM,MAAK,KAAK,OAExC;AAGF,YAAY,MAAM,qBAAqB,WAC5B,qBAAqB,QAAQ,OACpC","names":[],"sources":["../../../src/object/FetchPageResult.ts"],"version":3,"file":"FetchPageResult.d.ts"}

package/build/types/objectSet/ObjectSet.d.ts

@@ -9,7 +9,7 @@ import type { DerivedObjectOrInterfaceDefinition, ObjectOrInterfaceDefinition, P
 import type { CompileTimeMetadata, ObjectTypeDefinition } from "../ontology/ObjectTypeDefinition.js";
 import type { SimplePropertyDef } from "../ontology/SimplePropertyDef.js";
 import type { PrimaryKeyType } from "../OsdkBase.js";
-import type { ExtractAllPropertiesOption, ExtractOptions, ExtractRidOption, Osdk } from "../OsdkObjectFrom.js";
+import type { ExtractAllPropertiesOption, ExtractOptions, ExtractRidOption, MaybeScore, Osdk } from "../OsdkObjectFrom.js";
 import type { PageResult } from "../PageResult.js";
 import type { LinkedType, LinkNames } from "../util/LinkUtils.js";
 import type { BaseObjectSet } from "./BaseObjectSet.js";
@@ -29,17 +29,18 @@ type SubSelectKeys<
 > = SubSelectKeysHelper<Q, Extract$Select<X>>;
 type NOOP<T> = T extends (...args: any[]) => any ? T : T extends abstract new (...args: any[]) => any ? T : { [K in keyof T] : T[K] };
 type SubSelectRDPsHelper<
-	X extends ValidFetchPageArgs<any, any> | ValidAsyncIterArgs<any, any>,
+	X extends ValidFetchPageArgs<any, any, any> | ValidAsyncIterArgs<any, any>,
 	DEFAULT extends string
 > = [X] extends [never] ? DEFAULT : (X["$select"] & string[])[number] & DEFAULT;
 type SubSelectRDPs<
 	RDPs extends Record<string, SimplePropertyDef>,
-	X extends ValidFetchPageArgs<any, RDPs> | ValidAsyncIterArgs<any, RDPs>
+	X extends ValidFetchPageArgs<any, RDPs, any> | ValidAsyncIterArgs<any, RDPs>
 > = [RDPs] extends [never] ? never : NOOP<{ [K in SubSelectRDPsHelper<X, string & keyof RDPs>] : RDPs[K] }>;
 export interface MinimalObjectSet<
 	Q extends ObjectOrInterfaceDefinition,
-	RDPs extends Record<string, SimplePropertyDef> = {}
-> extends BaseObjectSet<Q>, FetchPage<Q, RDPs>, AsyncIter<Q, RDPs>, Where<Q, RDPs> {}
+	RDPs extends Record<string, SimplePropertyDef> = {},
+	ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<PropertyKeys<Q>> = {}
+> extends BaseObjectSet<Q>, FetchPage<Q, RDPs>, AsyncIter<Q, RDPs, ORDER_BY_OPTIONS>, Where<Q, RDPs> {}
 export type ExtractOptions2<X extends FetchPageArgs<any, any, any, any, any, any, any>> = [X] extends [never] ? never : ExtractRidOption<X["$includeRid"] extends true ? true : false> | ExtractAllPropertiesOption<X["$includeAllBaseObjectProperties"] extends true ? true : false>;
 type Extract$Select<X extends FetchPageArgs<any, any>> = NonNullable<X["$select"]>[number];
 interface FetchPage<
@@ -51,8 +52,9 @@ interface FetchPage<
 }
 type ValidFetchPageArgs<
 	Q extends ObjectOrInterfaceDefinition,
-	RDPs extends Record<string, SimplePropertyDef>
-> = ObjectSetArgs.FetchPage<Q, PropertyKeys<Q>, boolean, string & keyof RDPs>;
+	RDPs extends Record<string, SimplePropertyDef>,
+	ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<PropertyKeys<Q>>
+> = ObjectSetArgs.FetchPage<Q, PropertyKeys<Q>, boolean, string & keyof RDPs, ORDER_BY_OPTIONS>;
 type ValidAsyncIterArgs<
 	Q extends ObjectOrInterfaceDefinition,
 	RDPs extends Record<string, SimplePropertyDef>
@@ -78,8 +80,9 @@ interface FetchPageSignature<
 		R extends boolean,
 		const A extends Augments,
 		S extends NullabilityAdherence = NullabilityAdherence.Default,
-		T extends boolean = false
-	>(args?: FetchPageArgs<Q, L, R, A, S, T>): Promise<PageResult<Osdk.Instance<Q, ExtractOptions<R, S, T>, NoInfer<SubSelectKeys<Q, NonNullable<typeof args>>>, SubSelectRDPs<RDPs, NonNullable<typeof args>>>>>;
+		T extends boolean = false,
+		ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<L> = {}
+	>(args?: FetchPageArgs<Q, L, R, A, S, T, never, ORDER_BY_OPTIONS>): Promise<PageResult<MaybeScore<Osdk.Instance<Q, ExtractOptions<R, S, T>, NoInfer<SubSelectKeys<Q, NonNullable<typeof args>>>, SubSelectRDPs<RDPs, NonNullable<typeof args>>>, ORDER_BY_OPTIONS>>>;
 }
 interface NearestNeighbors<Q extends ObjectOrInterfaceDefinition> {
 	/**
@@ -119,8 +122,9 @@ interface FetchPageWithErrorsSignature<
 		R extends boolean,
 		const A extends Augments,
 		S extends NullabilityAdherence = NullabilityAdherence.Default,
-		T extends boolean = false
-	>(args?: FetchPageArgs<Q, L, R, A, S, T>): Promise<Result<PageResult<Osdk.Instance<Q, ExtractOptions<R, S, T>, NoInfer<SubSelectKeys<Q, NonNullable<typeof args>>>, SubSelectRDPs<RDPs, NonNullable<typeof args>>>>>>;
+		T extends boolean = false,
+		ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<L> = {}
+	>(args?: FetchPageArgs<Q, L, R, A, S, T, never, ORDER_BY_OPTIONS>): Promise<Result<PageResult<MaybeScore<Osdk.Instance<Q, ExtractOptions<R, S, T>, NoInfer<SubSelectKeys<Q, NonNullable<typeof args>>>, SubSelectRDPs<RDPs, NonNullable<typeof args>>>, ORDER_BY_OPTIONS>>>>;
 }
 interface Where<
 	Q extends ObjectOrInterfaceDefinition,
@@ -140,7 +144,8 @@ interface Where<
 }
 interface AsyncIterSignature<
 	Q extends ObjectOrInterfaceDefinition,
-	RDPs extends Record<string, SimplePropertyDef> = {}
+	RDPs extends Record<string, SimplePropertyDef> = {},
+	ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<PropertyKeys<Q>> = {}
 > {
 	/**
 	* Returns an async iterator to load all objects of this type
@@ -164,14 +169,16 @@ interface AsyncIterSignature<
 		R extends boolean,
 		const A extends Augments,
 		S extends NullabilityAdherence = NullabilityAdherence.Default,
-		T extends boolean = false
-	>(args?: AsyncIterArgs<Q, L, R, A, S, T>): AsyncIterableIterator<Osdk.Instance<Q, ExtractOptions<R, S, T>, NoInfer<SubSelectKeys<Q, NonNullable<typeof args>>>, SubSelectRDPs<RDPs, NonNullable<typeof args>>>>;
+		T extends boolean = false,
+		ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<PropertyKeys<Q>> = {}
+	>(args?: AsyncIterArgs<Q, L, R, A, S, T, never, ORDER_BY_OPTIONS>): AsyncIterableIterator<MaybeScore<Osdk.Instance<Q, ExtractOptions<R, S, T>, NoInfer<SubSelectKeys<Q, NonNullable<typeof args>>>, SubSelectRDPs<RDPs, NonNullable<typeof args>>>, ORDER_BY_OPTIONS>>;
 }
 interface AsyncIter<
 	Q extends ObjectOrInterfaceDefinition,
-	RDPs extends Record<string, SimplePropertyDef> = {}
+	RDPs extends Record<string, SimplePropertyDef> = {},
+	ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<PropertyKeys<Q>> = {}
 > {
-	asyncIter: AsyncIterSignature<Q, RDPs>;
+	asyncIter: AsyncIterSignature<Q, RDPs, ORDER_BY_OPTIONS>;
 }
 interface WithProperties<
 	Q extends ObjectOrInterfaceDefinition = any,
@@ -304,6 +311,7 @@ interface Subscribe<Q extends ObjectOrInterfaceDefinition> {
 interface ObjectSetCleanedTypes<
 	Q extends ObjectOrInterfaceDefinition,
 	D extends Record<string, SimplePropertyDef>,
-	MERGED extends ObjectOrInterfaceDefinition & Q
-> extends MinimalObjectSet<Q, D>, WithProperties<Q, D>, Aggregate<MERGED>, SetArithmetic<MERGED>, PivotTo<Q>, FetchOne<Q, D>, Subscribe<MERGED>, NearestNeighbors<Q> {}
+	MERGED extends ObjectOrInterfaceDefinition & Q,
+	ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<PropertyKeys<Q>> = {}
+> extends MinimalObjectSet<Q, D, ORDER_BY_OPTIONS>, WithProperties<Q, D>, Aggregate<MERGED>, SetArithmetic<MERGED>, PivotTo<Q>, FetchOne<Q, D>, Subscribe<MERGED>, NearestNeighbors<Q> {}
 export {};

package/build/types/objectSet/ObjectSet.d.ts.map

@@ -1 +1 @@
-{"mappings":"AAgBA,cAAc,qBAAqB,+BAAgC;AACnE,cAAc,sEAAsE,yCAA0C;AAC9H,cAAc,2BAA2B,qCAAsC;AAC/E,cAAc,mBAAmB,6BAA8B;AAC/D,cAAc,8BAA8B,yCAA0C;AACtF,cACE,eACA,UACA,eACA,sBACA,eACA,iBACK,4BAA6B;AACpC,cAAc,cAAc,qBAAsB;AAClD,cACE,oCACA,6BACA,oBACK,kCAAmC;AAC1C,cACE,qBACA,4BACK,qCAAsC;AAC7C,cAAc,yBAAyB,kCAAmC;AAC1E,cAAc,sBAAsB,gBAAiB;AACrD,cACE,4BACA,gBACA,kBACA,YACK,sBAAuB;AAC9B,cAAc,kBAAkB,kBAAmB;AACnD,cAAc,YAAY,iBAAiB,sBAAuB;AAClE,cAAc,qBAAqB,oBAAqB;AACxD,cAAc,6BAA6B,wBAAyB;KAE/D;CACH,UAAU;CACV,UAAU,eAAe,qBAAqB,CAAE;IAC9C,mCAAmC,sBAAsB,GAAG;KAE3D,WACH,UACI,qBACA,eAAe,uBAChB,qBAAqB,CAAE,IACxB,UAAU,qBAAqB,CAAE,IACjC,UAAU,eAAe,qBAAqB,IAC9C,CAAE;KAOD;CACH,UAAU;CACV;KACG,qBAAqB,aAAa,KACnC,aAAa,WAAW,IAAI,aAAa,KACzC,IAAI,aAAa;KAEhB;CACH,UAAU;CACV,UAAU,UAAU,GAAG,aAAa;IAClC,oBAAoB,GAAG,eAAe;KAErC,KAAK,KAAK,WAAW,GAAG,sBAAsB,IAC/C,wBAAuB,GAAG,sBAAsB,OAC7C,WAAW,KAAI,EAAE;KAEnB;CACH,UAAU,+BAA+B;CACzC;KACG,qBAAqB,WACrB,EAAE,iCAAiC;KAEnC;CACH,aAAa,eAAe;CAC5B,UAAU,wBAAwB,QAAQ,wBAAwB;KAC/D,gCACD,QAAQ,KAAK,oBAAoB,kBAAkB,SAAQ,KAAK;AAEpE,iBAAiB;CACf,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;UAEnD,cAAc,IACd,UAAU,GAAG,OACb,UAAU,GAAG,OACb,MAAM,GAAG,MACX,CACC;AAED,YAAY,gBACV,UAAU,qDACP,6BAEC,iBAAiB,EAAE,uBAAuB,OAAO,OAAO,SACxD,2BACA,EAAE,2CAA2C,OAAO,OAAO;KAG5D,eAAe,UAAU,2BAA2B,YACvD,EAAE;UAGM;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;EACnD;UACS,WAAW,mBAAmB,GAAG;UACjC,qBAAqB,6BAA6B,GAAG;AAC/D;KAEI;CACH,UAAU;CACV,aAAa,eAAe;IAC1B,cAAc,UAChB,GACA,aAAa,4BAEE;KAGZ;CACH,UAAU;CACV,aAAa,eAAe;IAE1B,cAAc,UACd,GACA,aAAa,IACb,sBACe,QAEf,cACA,yBAKA,qBACe;UAGT;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;EACnD;;;;;;;;;;;;;;EAcE,UAAU,aAAa,qBAAqB;EAC5C;QACM,UAAU;EAChB,UAAU,uBAAuB,qBAAqB;EACtD,oBAAoB;GAEpBA,OAAO,cAAc,GAAG,GAAG,GAAG,GAAG,GAAG,KACnC,QACD,WACE,KAAK,SACH,GACA,eAAe,GAAG,GAAG,IACrB,QAAQ,cAAc,GAAG,mBAAmB,SAC5C,cAAc,MAAM,mBAAmB;AAI9C;UAES,iBAAiB,UAAU,6BAA6B;;;;;;;;;;;;;UAcvD,mBACPC,0BACAC,sBACAC,UAAU,aAAa,SAAS,GAAG;AAEtC;UAES;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;EACnD;;;;;;;;;;;;;;;;EAgBE,UAAU,aAAa,qBAAqB;EAC5C;QACM,UAAU;EAChB,UAAU,uBAAuB,qBAAqB;EACtD,oBAAoB;GAEpBH,OAAO,cAAc,GAAG,GAAG,GAAG,GAAG,GAAG,KACnC,QACD,OACE,WACE,KAAK,SACH,GACA,eAAe,GAAG,GAAG,IACrB,QAAQ,cAAc,GAAG,mBAAmB,SAC5C,cAAc,MAAM,mBAAmB;AAKhD;UAGS;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;EACnD;;;;;;;;;;;UAWS,QACPI,QAAQ,YAAY,eAAe,GAAG;AAEzC;UAES;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;EACnD;;;;;;;;;EASC,UAAU,mBAAmB,GAAG,eAC/BC,OAAO,IACN,sBACD,KAAK,SACH,GACA,gBAAgB,IAChB,cAAc,GAAG,IACjB,cAAc,MAAM;;;;;;;;;;EAatB,UAAU,aAAa,qBAAqB;EAC5C;QACM,UAAU;EAChB,UAAU,uBAAuB,qBAAqB;EACtD,oBAAoB;GAEpBC,OAAO,cAAc,GAAG,GAAG,GAAG,GAAG,GAAG,KACnC,sBACD,KAAK,SACH,GACA,eAAe,GAAG,GAAG,IACrB,QAAQ,cAAc,GAAG,mBAAmB,SAC5C,cAAc,MAAM,mBAAmB;AAG5C;UAES;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;EACnD;CACA,WAAW,mBAAmB,GAAG;AAClC;UAES;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;EACnD;UACS,iBACP,YAAY,eAAe,oBAE3BC,WAAW,WAAW,OAAM,uBAAuB,GAAG,IAAI,UACvD,UACH,MAEG,YAAY,YAAY,QAAO,iBAAiB,MAAM,IAAI,MACvD,iBAAiB,OAAO,KAAK;AAItC;AAED,iBAAiB;CACf,UAAU;CAGV,sBACI,cAAc,KACd,eAAe;UAEnB,sBACE,GACA,WAAW,gBACX,eAAe,GAAG,WAAW,iBAEjC,CACC;UAGS,UACR,UAAU,6BACV;;;;;;;;;;;;;;;;;;;;;;;;UAwBS,YAAY,WAAW,cAAc,IAC5CC,KAAK,+DAA+D,GAAG,QACpE,QAAQ,oBAAoB,GAAG;AACrC;UAGS,cACR,UAAU,6BACV;;;;;;;;;;UAUS,QACP,GAAG,YAAY,cAAc,oBAAoB,GAAG;;;;;;;;;;UAY7C,YACP,GAAG,YAAY,cAAc,oBAAoB,GAAG;;;;;;;;;;UAY7C,WACP,GAAG,YAAY,cAAc,oBAAoB,GAAG;AAEvD;UAGS,QACR,UAAU,6BACV;;;;;;UAMS,UAAU,UAAU,UAAU,IACrCC,MAAM,MACH,UAAU,WAAW,GAAG;AAC9B;UAES;CACR,UAAU;CACV,aAAa,eAAe;EAC5B;;;;;QAKQ,UAAU,aAAa,qBAAqB;QAC5C;QACA,UAAU,QAAQ,UAAU,qBAAqB;GAEvDC,YAAY,eAAe,IAC3BC,UAAU,UAAU,GAAG,GAAG,GAAG,KAC5B,QACD,KAAK,SACH,GACA,eAAe,GAAG,IAClB,QAAQ,cAAc,GAAG;EAAE,SAAS,MAAM;CAAI,KAC9C,cAAc,MAAM;EAAE,SAAS,MAAM;CAAI;AAG9C;UAES;CACR,UAAU;CACV,aAAa,eAAe;EAC5B;;;;;QAKQ,UAAU,aAAa,qBAAqB;QAC5C;QACA,UAAU,QAAQ,UAAU,qBAAqB;GAEvDD,YAAY,eAAe,IAC3BC,UAAU,UAAU,GAAG,GAAG,GAAG,KAC5B,QACD,OACE,KAAK,SACH,GACA,eAAe,GAAG,IAClB,QAAQ,cAAc,GAAG;EAAE,SAAS,MAAM;CAAI,KAC9C,cAAc,MAAM;EAAE,SAAS,MAAM;CAAI;AAIhD;UAES;CACR,UAAU;CACV,aAAa,eAAe;EAC5B;CACA,UAAU,UAAU,uBAAuB,kBAAkB,GAAG;CAChE,oBAAoB,UAAU,uBAC1B,4BAA4B,GAAG;AAEpC;UAGS,UACR,UAAU,6BACV;;;;;;;UAOS,kBACD,UAAU,aAAa,IAE7BC,UAAU,sBAAsB,SAAS,GAAG,IAC5CC,OAAO,sBAAsB,QAAQ,GAAG,OACrC;EAAE;CAAyB;AACjC;UAES;CACR,UAAU;CACV,UAAU,eAAe;CACzB,eAAe,8BAA8B;UAE7C,iBAAiB,GAAG,IACpB,eAAe,GAAG,IAClB,UAAU,SACV,cAAc,SACd,QAAQ,IACR,SAAS,GAAG,IACZ,UAAU,SACV,iBAAiB,GACnB,CACC","names":["args?: FetchPageArgs<Q, L, R, A, S, T>","query: string | number[]","numNeighbors: number","property: PropertyKeys.Filtered<Q, \"vector\">","clause: WhereClause<MergeObjectSet<Q, RDPs>>","args?: X","args?: AsyncIterArgs<Q, L, R, A, S, T>","clause: { [K in keyof NEW]: DerivedPropertyCreator<Q, NEW[K]> }","req: AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy<Q, AO>","type: L","primaryKey: PrimaryKeyType<Q>","options?: SelectArg<Q, L, R, S>","listener: ObjectSetSubscription.Listener<Q, P>","opts?: ObjectSetSubscription.Options<Q, P>"],"sources":["../../../src/objectSet/ObjectSet.ts"],"version":3,"file":"ObjectSet.d.ts"}
+{"mappings":"AAgBA,cAAc,qBAAqB,+BAAgC;AACnE,cAAc,sEAAsE,yCAA0C;AAC9H,cAAc,2BAA2B,qCAAsC;AAC/E,cAAc,mBAAmB,6BAA8B;AAC/D,cAAc,8BAA8B,yCAA0C;AACtF,cACE,eACA,UACA,eACA,sBACA,eACA,iBACK,4BAA6B;AACpC,cAAc,cAAc,qBAAsB;AAClD,cACE,oCACA,6BACA,oBACK,kCAAmC;AAC1C,cACE,qBACA,4BACK,qCAAsC;AAC7C,cAAc,yBAAyB,kCAAmC;AAC1E,cAAc,sBAAsB,gBAAiB;AACrD,cACE,4BACA,gBACA,kBACA,YACA,YACK,sBAAuB;AAC9B,cAAc,kBAAkB,kBAAmB;AACnD,cAAc,YAAY,iBAAiB,sBAAuB;AAClE,cAAc,qBAAqB,oBAAqB;AACxD,cAAc,6BAA6B,wBAAyB;KAE/D;CACH,UAAU;CACV,UAAU,eAAe,qBAAqB,CAAE;IAC9C,mCAAmC,sBAAsB,GAAG;KAE3D,WACH,UACI,qBACA,eAAe,uBAChB,qBAAqB,CAAE,IACxB,UAAU,qBAAqB,CAAE,IACjC,UAAU,eAAe,qBAAqB,IAC9C,CAAE;KAOD;CACH,UAAU;CACV;KACG,qBAAqB,aAAa,KACnC,aAAa,WAAW,IAAI,aAAa,KACzC,IAAI,aAAa;KAEhB;CACH,UAAU;CACV,UAAU,UAAU,GAAG,aAAa;IAClC,oBAAoB,GAAG,eAAe;KAErC,KAAK,KAAK,WAAW,GAAG,sBAAsB,IAC/C,wBAAuB,GAAG,sBAAsB,OAC7C,WAAW,KAAI,EAAE;KAEnB;CACH,UAAU,oCAAoC;CAC9C;KACG,qBAAqB,WACrB,EAAE,iCAAiC;KAEnC;CACH,aAAa,eAAe;CAC5B,UAAU,wBAAwB,aAAa,wBAAwB;KACpE,gCACD,QAAQ,KAAK,oBAAoB,kBAAkB,SAAQ,KAAK;AAEpE,iBAAiB;CACf,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;CACnD,yBAAyB,cAAc,eAAe,aAAa,MAAM,CAAE;UAE3E,cAAc,IACd,UAAU,GAAG,OACb,UAAU,GAAG,MAAM,mBACnB,MAAM,GAAG,MACX,CACC;AAED,YAAY,gBACV,UAAU,qDACP,6BAEC,iBAAiB,EAAE,uBAAuB,OAAO,OAAO,SACxD,2BACA,EAAE,2CAA2C,OAAO,OAAO;KAG5D,eAAe,UAAU,2BAA2B,YACvD,EAAE;UAGM;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;EACnD;UACS,WAAW,mBAAmB,GAAG;UACjC,qBAAqB,6BAA6B,GAAG;AAC/D;KAEI;CACH,UAAU;CACV,aAAa,eAAe;CAC5B,yBAAyB,cAAc,eAAe,aAAa;IACjE,cAAc,UAChB,GACA,aAAa,4BAEE,MACf;KAGG;CACH,UAAU;CACV,aAAa,eAAe;IAE1B,cAAc,UACd,GACA,aAAa,IACb,sBACe,QAEf,cACA,yBAKA,qBACe;UAGT;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;EACnD;;;;;;;;;;;;;;EAcE,UAAU,aAAa,qBAAqB;EAC5C;QACM,UAAU;EAChB,UAAU,uBAAuB,qBAAqB;EACtD,oBAAoB;EACpB,yBAAyB,cAAc,eAAe,KAAK,CAAE;GAE7DA,OAAO,cAAc,GAAG,GAAG,GAAG,GAAG,GAAG,UAAU,oBAC7C,QACD,WACE,WACE,KAAK,SACH,GACA,eAAe,GAAG,GAAG,IACrB,QAAQ,cAAc,GAAG,mBAAmB,SAC5C,cAAc,MAAM,mBAAmB,SAEzC;AAIP;UAES,iBAAiB,UAAU,6BAA6B;;;;;;;;;;;;;UAcvD,mBACPC,0BACAC,sBACAC,UAAU,aAAa,SAAS,GAAG;AAEtC;UAES;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;EACnD;;;;;;;;;;;;;;;;EAgBE,UAAU,aAAa,qBAAqB;EAC5C;QACM,UAAU;EAChB,UAAU,uBAAuB,qBAAqB;EACtD,oBAAoB;EACpB,yBAAyB,cAAc,eAAe,KAAK,CAAE;GAE7DH,OAAO,cAAc,GAAG,GAAG,GAAG,GAAG,GAAG,UAAU,oBAC7C,QACD,OACE,WACE,WACE,KAAK,SACH,GACA,eAAe,GAAG,GAAG,IACrB,QAAQ,cAAc,GAAG,mBAAmB,SAC5C,cAAc,MAAM,mBAAmB,SAEzC;AAKT;UAGS;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;EACnD;;;;;;;;;;;UAWS,QACPI,QAAQ,YAAY,eAAe,GAAG;AAEzC;UAES;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;CACnD,yBAAyB,cAAc,eAAe,aAAa,MAAM,CAAE;EAC3E;;;;;;;;;EASC,UAAU,mBAAmB,GAAG,eAC/BC,OAAO,IACN,sBACD,KAAK,SACH,GACA,gBAAgB,IAChB,cAAc,GAAG,IACjB,cAAc,MAAM;;;;;;;;;;EAatB,UAAU,aAAa,qBAAqB;EAC5C;QACM,UAAU;EAChB,UAAU,uBAAuB,qBAAqB;EACtD,oBAAoB;EACpB,yBAAyB,cAAc,eAAe,aAAa,MAAM,CAAE;GAE3EC,OAAO,cAAc,GAAG,GAAG,GAAG,GAAG,GAAG,UAAU,oBAC7C,sBACD,WACE,KAAK,SACH,GACA,eAAe,GAAG,GAAG,IACrB,QAAQ,cAAc,GAAG,mBAAmB,SAC5C,cAAc,MAAM,mBAAmB,SAEzC;AAGL;UAES;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;CACnD,yBAAyB,cAAc,eAAe,aAAa,MAAM,CAAE;EAC3E;CACA,WAAW,mBAAmB,GAAG,MAAM;AACxC;UAES;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;EACnD;UACS,iBACP,YAAY,eAAe,oBAE3BC,WAAW,WAAW,OAAM,uBAAuB,GAAG,IAAI,UACvD,UACH,MAEG,YAAY,YAAY,QAAO,iBAAiB,MAAM,IAAI,MACvD,iBAAiB,OAAO,KAAK;AAItC;AAED,iBAAiB;CACf,UAAU;CAGV,sBACI,cAAc,KACd,eAAe;UAEnB,sBACE,GACA,WAAW,gBACX,eAAe,GAAG,WAAW,iBAEjC,CACC;UAGS,UACR,UAAU,6BACV;;;;;;;;;;;;;;;;;;;;;;;;UAwBS,YAAY,WAAW,cAAc,IAC5CC,KAAK,+DAA+D,GAAG,QACpE,QAAQ,oBAAoB,GAAG;AACrC;UAGS,cACR,UAAU,6BACV;;;;;;;;;;UAUS,QACP,GAAG,YAAY,cAAc,oBAAoB,GAAG;;;;;;;;;;UAY7C,YACP,GAAG,YAAY,cAAc,oBAAoB,GAAG;;;;;;;;;;UAY7C,WACP,GAAG,YAAY,cAAc,oBAAoB,GAAG;AAEvD;UAGS,QACR,UAAU,6BACV;;;;;;UAMS,UAAU,UAAU,UAAU,IACrCC,MAAM,MACH,UAAU,WAAW,GAAG;AAC9B;UAES;CACR,UAAU;CACV,aAAa,eAAe;EAC5B;;;;;QAKQ,UAAU,aAAa,qBAAqB;QAC5C;QACA,UAAU,QAAQ,UAAU,qBAAqB;GAEvDC,YAAY,eAAe,IAC3BC,UAAU,UAAU,GAAG,GAAG,GAAG,KAC5B,QACD,KAAK,SACH,GACA,eAAe,GAAG,IAClB,QAAQ,cAAc,GAAG;EAAE,SAAS,MAAM;CAAI,KAC9C,cAAc,MAAM;EAAE,SAAS,MAAM;CAAI;AAG9C;UAES;CACR,UAAU;CACV,aAAa,eAAe;EAC5B;;;;;QAKQ,UAAU,aAAa,qBAAqB;QAC5C;QACA,UAAU,QAAQ,UAAU,qBAAqB;GAEvDD,YAAY,eAAe,IAC3BC,UAAU,UAAU,GAAG,GAAG,GAAG,KAC5B,QACD,OACE,KAAK,SACH,GACA,eAAe,GAAG,IAClB,QAAQ,cAAc,GAAG;EAAE,SAAS,MAAM;CAAI,KAC9C,cAAc,MAAM;EAAE,SAAS,MAAM;CAAI;AAIhD;UAES;CACR,UAAU;CACV,aAAa,eAAe;EAC5B;CACA,UAAU,UAAU,uBAAuB,kBAAkB,GAAG;CAChE,oBAAoB,UAAU,uBAC1B,4BAA4B,GAAG;AAEpC;UAGS,UACR,UAAU,6BACV;;;;;;;UAOS,kBACD,UAAU,aAAa,IAE7BC,UAAU,sBAAsB,SAAS,GAAG,IAC5CC,OAAO,sBAAsB,QAAQ,GAAG,OACrC;EAAE;CAAyB;AACjC;UAES;CACR,UAAU;CACV,UAAU,eAAe;CACzB,eAAe,8BAA8B;CAC7C,yBAAyB,cAAc,eAAe,aAAa,MAAM,CAAE;UAE3E,iBAAiB,GAAG,GAAG,mBACvB,eAAe,GAAG,IAClB,UAAU,SACV,cAAc,SACd,QAAQ,IACR,SAAS,GAAG,IACZ,UAAU,SACV,iBAAiB,GACnB,CACC","names":["args?: FetchPageArgs<Q, L, R, A, S, T, never, ORDER_BY_OPTIONS>","query: string | number[]","numNeighbors: number","property: PropertyKeys.Filtered<Q, \"vector\">","clause: WhereClause<MergeObjectSet<Q, RDPs>>","args?: X","args?: AsyncIterArgs<Q, L, R, A, S, T, never, ORDER_BY_OPTIONS>","clause: { [K in keyof NEW]: DerivedPropertyCreator<Q, NEW[K]> }","req: AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy<Q, AO>","type: L","primaryKey: PrimaryKeyType<Q>","options?: SelectArg<Q, L, R, S>","listener: ObjectSetSubscription.Listener<Q, P>","opts?: ObjectSetSubscription.Options<Q, P>"],"sources":["../../../src/objectSet/ObjectSet.ts"],"version":3,"file":"ObjectSet.d.ts"}

package/build/types/ontology/ObjectTypeDefinition.d.ts

@@ -55,6 +55,7 @@ export declare namespace ObjectMetadata {
 		type: WirePropertyTypes;
 		multiplicity?: boolean;
 		nullable?: boolean;
+		valueTypeApiName?: string;
 	}
 	interface Link<
 		Q extends ObjectTypeDefinition,

package/build/types/ontology/ObjectTypeDefinition.d.ts.map

@@ -1 +1 @@
-{"mappings":"AAgBA,cAAc,oBAAoB,oBAAqB;AACvD,cACE,6BACA,oBACK,wBAAyB;AAChC,cAAc,uBAAuB,sBAAuB;AAC5D,cAAc,qBAAqB,oBAAqB;AACxD,cAAc,yBAAyB,wBAAyB;AAEhE,YAAY,oBAAoB,UAAU;CAAE,uBAAuB,CAAE;AAAE,KACrE,YACE,EAAE;AAGN,YAAY;CACV,UAAU;CACV,UAAU,aAAa;IACrB,oBAAoB,GAAG,cAAc;AAEzC,YAAY,8BAA8B;CACxC,MAAM,WAAW;CACjB;CACA;CACA;CACA,YAAY,YAAY,eAAe;CACvC;;;;;;CAMA,aAAa;AACd;AAED,iBAAiB,iCAAiC;CAChD,MAAM,WAAW;CACjB;CACA;CACA;CACA;AACD;AAED,iBAAiB,aAAa,UAAU,8BAA8B;CACpE,0BAA0B;AAC3B;AAED,iBAAiB,uBAAuB,4BAA4B;CAClE,MAAM;CACN,8BAA8B;CAC9B,0BAA0B;CAC1B,OAAO,eAEL,eAAe;CAEjB,gBAAgB;CAChB,MAAM;CACN,YAAY;CACZ;CACA,QAAQ;CACR,cAAc,eAEZ;CAKF,qBAAqB,eAEnB;AAKH;AAED,yBAAiB;WACE,SAAS;EACxB;EACA;EACA;EACA,MAAM;EACN;EACA;CACD;WAEgB;EACf,UAAU;EACV;GACA;EACA,uBAAuB;EACvB,YAAY,EAAE;EACd,cAAc;CACf;;AAGH,iBAAiB,qBAAqB;CACpC,MAAM;CACN;CACA,eAAe;CACf,uBACI,iBACA;AACL;AAED,YAAY,wBACV,UAAU,8BAEF,oBAAoB,GAAG;AAGjC,iBAAiB;CACf,UAAU;CACV,UAAU,aAAa,iBAAiB;CACxC,UAAU,UAAU,WAAW;UACvB,eAAe,SAAS;CAChC,MAAM;CACN,cAAc,UAAU,UAAU,OAAO;CACzC,UAAU,UAAU,aAAa,OAAO;AACzC;AAED,YAAY,gBACR,WACA,iBACA,eACA;KAEC,uBAAuB,WAAW,cAAc;KAEhD,gBAAgB;CACnB,MAAM;CACN;CACA;AACD;KAEI,OAAO","names":[],"sources":["../../../src/ontology/ObjectTypeDefinition.ts"],"version":3,"file":"ObjectTypeDefinition.d.ts"}
+{"mappings":"AAgBA,cAAc,oBAAoB,oBAAqB;AACvD,cACE,6BACA,oBACK,wBAAyB;AAChC,cAAc,uBAAuB,sBAAuB;AAC5D,cAAc,qBAAqB,oBAAqB;AACxD,cAAc,yBAAyB,wBAAyB;AAEhE,YAAY,oBAAoB,UAAU;CAAE,uBAAuB,CAAE;AAAE,KACrE,YACE,EAAE;AAGN,YAAY;CACV,UAAU;CACV,UAAU,aAAa;IACrB,oBAAoB,GAAG,cAAc;AAEzC,YAAY,8BAA8B;CACxC,MAAM,WAAW;CACjB;CACA;CACA;CACA,YAAY,YAAY,eAAe;CACvC;;;;;;CAMA,aAAa;AACd;AAED,iBAAiB,iCAAiC;CAChD,MAAM,WAAW;CACjB;CACA;CACA;CACA;AACD;AAED,iBAAiB,aAAa,UAAU,8BAA8B;CACpE,0BAA0B;AAC3B;AAED,iBAAiB,uBAAuB,4BAA4B;CAClE,MAAM;CACN,8BAA8B;CAC9B,0BAA0B;CAC1B,OAAO,eAEL,eAAe;CAEjB,gBAAgB;CAChB,MAAM;CACN,YAAY;CACZ;CACA,QAAQ;CACR,cAAc,eAEZ;CAKF,qBAAqB,eAEnB;AAKH;AAED,yBAAiB;WACE,SAAS;EACxB;EACA;EACA;EACA,MAAM;EACN;EACA;EACA;CACD;WAEgB;EACf,UAAU;EACV;GACA;EACA,uBAAuB;EACvB,YAAY,EAAE;EACd,cAAc;CACf;;AAGH,iBAAiB,qBAAqB;CACpC,MAAM;CACN;CACA,eAAe;CACf,uBACI,iBACA;AACL;AAED,YAAY,wBACV,UAAU,8BAEF,oBAAoB,GAAG;AAGjC,iBAAiB;CACf,UAAU;CACV,UAAU,aAAa,iBAAiB;CACxC,UAAU,UAAU,WAAW;UACvB,eAAe,SAAS;CAChC,MAAM;CACN,cAAc,UAAU,UAAU,OAAO;CACzC,UAAU,UAAU,aAAa,OAAO;AACzC;AAED,YAAY,gBACR,WACA,iBACA,eACA;KAEC,uBAAuB,WAAW,cAAc;KAEhD,gBAAgB;CACnB,MAAM;CACN;CACA;AACD;KAEI,OAAO","names":[],"sources":["../../../src/ontology/ObjectTypeDefinition.ts"],"version":3,"file":"ObjectTypeDefinition.d.ts"}

package/build/types/public/unstable.d.ts

@@ -1,7 +1,7 @@
 export type { Experiment, ExperimentFns } from "../experimental/Experiment.js";
 export { __EXPERIMENTAL__NOT_SUPPORTED_YET__createMediaReference } from "../experimental/createMediaReference.js";
 export { __EXPERIMENTAL__NOT_SUPPORTED_YET__fetchOneByRid } from "../experimental/fetchOneByRid.js";
-export { __EXPERIMENTAL__NOT_SUPPORTED_YET__fetchPageByRid } from "../experimental/fetchPageByRid.js";
+export { __EXPERIMENTAL__NOT_SUPPORTED_YET__fetchPageByRid, type FetchPageByRidPayload } from "../experimental/fetchPageByRid.js";
 export { __EXPERIMENTAL__NOT_SUPPORTED_YET__getBulkLinks } from "../experimental/getBulkLinks.js";
 export type { EXPERIMENTAL_BulkLinkResult } from "../objectSet/BulkLinkResult.js";
 export type { MinimalObjectSet } from "../objectSet/ObjectSet.js";

package/build/types/public/unstable.d.ts.map

@@ -1 +1 @@
-{"mappings":"AAgBA,cAAc,YAAY,qBAAqB;AAE/C,SAAS,+DAA+D;AACxE,SAAS,wDAAwD;AACjE,SAAS,yDAAyD;AAClE,SAAS,uDAAuD;AAEhE,cAAc,mCAAmC;AACjD,cAAc,wBAAwB","names":[],"sources":["../../../src/public/unstable.ts"],"version":3,"file":"unstable.d.ts"}
+{"mappings":"AAgBA,cAAc,YAAY,qBAAqB;AAE/C,SAAS,+DAA+D;AACxE,SAAS,wDAAwD;AACjE,SACE,wDACK,6BACA;AACP,SAAS,uDAAuD;AAEhE,cAAc,mCAAmC;AACjD,cAAc,wBAAwB","names":[],"sources":["../../../src/public/unstable.ts"],"version":3,"file":"unstable.d.ts"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@osdk/api",
-  "version": "2.5.0-beta.1",
+  "version": "2.5.0-beta.3",
   "description": "",
   "access": "public",
   "license": "Apache-2.0",
@@ -48,8 +48,8 @@
     "@microsoft/api-extractor": "^7.52.7",
     "ts-expect": "^1.3.0",
     "typescript": "~5.5.4",
-    "@osdk/monorepo.api-extractor": "~0.4.0-beta.1",
-    "@osdk/monorepo.tsconfig": "~0.4.0-beta.1"
+    "@osdk/monorepo.tsconfig": "~0.4.0-beta.1",
+    "@osdk/monorepo.api-extractor": "~0.4.0-beta.1"
   },
   "publishConfig": {
     "access": "public"