@osdk/api 2.1.0-beta.9 → 2.2.0-beta.1

package/build/types/mapping/DurationMapping.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"AAgBA,OAAO,cAAMA,qBAAqB;CAChC,KAAK;CACL,SAAS;CACT,KAAK;CACL,QAAQ;CACR,SAAS;CACT,IAAI;CACJ,KAAK;CACL,MAAM;CACN,OAAO;CACP,KAAK;CACL,MAAM;CACN,IAAI;CACJ,MAAM;CACN,OAAO;CACP,KAAK;CACL,OAAO;CACP,QAAQ;CACR,IAAI;CACJ,MAAM;CACN,OAAO;AACR","names":["TimeDurationMapping: {\n  sec: \"SECONDS\";\n  seconds: \"SECONDS\";\n  min: \"MINUTES\";\n  minute: \"MINUTES\";\n  minutes: \"MINUTES\";\n  hr: \"HOURS\";\n  hrs: \"HOURS\";\n  hour: \"HOURS\";\n  hours: \"HOURS\";\n  day: \"DAYS\";\n  days: \"DAYS\";\n  wk: \"WEEKS\";\n  week: \"WEEKS\";\n  weeks: \"WEEKS\";\n  mos: \"MONTHS\";\n  month: \"MONTHS\";\n  months: \"MONTHS\";\n  yr: \"YEARS\";\n  year: \"YEARS\";\n  years: \"YEARS\";\n}"],"sources":["../../../src/mapping/DurationMapping.ts"],"version":3,"file":"DurationMapping.d.ts"}

package/build/types/mapping/PropertyValueMapping.d.ts

@@ -0,0 +1,57 @@
+import type { Attachment, AttachmentUpload } from "../object/Attachment.js";
+import type { Media } from "../object/Media.js";
+import type { GeotimeSeriesProperty, TimeSeriesProperty } from "../timeseries/timeseries.js";
+/**
+* Map from the PropertyDefinition type to the typescript type that we return
+*/
+export interface PropertyValueWireToClient {
+	attachment: Attachment;
+	boolean: boolean;
+	byte: number;
+	datetime: string;
+	decimal: string;
+	double: number;
+	float: number;
+	geopoint: GeoJSON.Point;
+	geoshape: GeoJSON.GeoJSON;
+	integer: number;
+	long: string;
+	marking: string;
+	mediaReference: Media;
+	short: number;
+	string: string;
+	timestamp: string;
+	numericTimeseries: TimeSeriesProperty<number>;
+	stringTimeseries: TimeSeriesProperty<string>;
+	sensorTimeseries: TimeSeriesProperty<string | number>;
+	geotimeSeriesReference: GeotimeSeriesProperty<GeoJSON.Point>;
+}
+export type GetClientPropertyValueFromWire<T extends keyof PropertyValueWireToClient | Record<string, keyof PropertyValueWireToClient>> = T extends keyof PropertyValueWireToClient ? PropertyValueWireToClient[T] : T extends Record<string, keyof PropertyValueWireToClient> ? { [K in keyof T] : PropertyValueWireToClient[T[K]] } : never;
+/**
+* Map from the PropertyDefinition type to the typescript type that we accept
+*/
+export interface PropertyValueClientToWire {
+	attachment: string | AttachmentUpload | Blob & {
+		readonly name: string
+	};
+	boolean: boolean;
+	byte: number;
+	datetime: string;
+	decimal: string | number;
+	double: number;
+	float: number;
+	geopoint: GeoJSON.Point;
+	geoshape: GeoJSON.GeoJSON;
+	integer: number;
+	long: string | number;
+	marking: string;
+	short: number;
+	string: string;
+	timestamp: string;
+	mediaReference: Media;
+	numericTimeseries: TimeSeriesProperty<number>;
+	stringTimeseries: TimeSeriesProperty<string>;
+	sensorTimeseries: TimeSeriesProperty<string | number>;
+	geotimeSeriesReference: GeotimeSeriesProperty<GeoJSON.Point>;
+}
+export type GetWirePropertyValueFromClient<T extends keyof PropertyValueClientToWire | Record<string, keyof PropertyValueClientToWire>> = T extends keyof PropertyValueClientToWire ? PropertyValueClientToWire[T] : T extends Record<string, keyof PropertyValueClientToWire> ? { [K in keyof T] : PropertyValueClientToWire[T[K]] } : never;

package/build/types/mapping/PropertyValueMapping.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cAAc,YAAY,wBAAwB,yBAA0B;AAC5E,cAAc,aAAa,oBAAqB;AAChD,cACE,uBACA,0BACK,6BAA8B;;;;AAKrC,iBAAiB,0BAA0B;CACzC,YAAY;CACZ;CACA;CACA;CACA;CACA;CACA;CACA,UAAU,QAAQ;CAClB,UAAU,QAAQ;CAClB;CACA;CACA;CACA,gBAAgB;CAChB;CACA;CACA;CACA,mBAAmB;CACnB,kBAAkB;CAClB,kBAAkB;CAClB,wBAAwB,sBAAsB,QAAQ;AACvD;AAED,YAAY,+BACV,gBACU,4BACN,qBAAqB,8BACvB,gBAAgB,4BAA4B,0BAA0B,KACtE,UAAU,qBAAqB,gCAC1B,WAAW,KAAI,0BAA0B,EAAE;;;;AAMpD,iBAAiB,0BAA0B;CACzC,qBAAqB,mBAAmB,OAAO;WAAW;CAAc;CACxE;CACA;CACA;CACA;CACA;CACA;CACA,UAAU,QAAQ;CAClB,UAAU,QAAQ;CAClB;CACA;CACA;CACA;CACA;CACA;CACA,gBAAgB;CAChB,mBAAmB;CACnB,kBAAkB;CAClB,kBAAkB;CAClB,wBAAwB,sBAAsB,QAAQ;AACvD;AACD,YAAY,+BACV,gBACU,4BACN,qBAAqB,8BACvB,gBAAgB,4BAA4B,0BAA0B,KACtE,UAAU,qBAAqB,gCAC1B,WAAW,KAAI,0BAA0B,EAAE","names":[],"sources":["../../../src/mapping/PropertyValueMapping.ts"],"version":3,"file":"PropertyValueMapping.d.ts"}

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

@@ -0,0 +1,21 @@
+export interface Attachment {
+	rid: string;
+	/**
+	* Fetches metadata for an attachment
+	*/
+	fetchMetadata(): Promise<AttachmentMetadata>;
+	/**
+	* Fetches actual content of attachment in Blob form
+	*/
+	fetchContents(): Promise<Response>;
+}
+export interface AttachmentUpload {
+	readonly name: string;
+	readonly data: Blob;
+}
+export interface AttachmentMetadata {
+	rid: string;
+	filename: string;
+	sizeBytes: number;
+	mediaType: string;
+}

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

@@ -0,0 +1 @@
+{"mappings":"AAgBA,iBAAiB,WAAW;CAC1B;;;;CAIA,iBAAiB,QAAQ;;;;CAIzB,iBAAiB,QAAQ;AAC1B;AAED,iBAAiB,iBAAiB;UACvB;UACA,MAAM;AAChB;AAED,iBAAiB,mBAAmB;CAClC;CACA;CACA;CACA;AACD","names":[],"sources":["../../../src/object/Attachment.ts"],"version":3,"file":"Attachment.d.ts"}

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

@@ -0,0 +1,49 @@
+import type { ObjectOrInterfaceDefinition, PropertyKeys } from "../ontology/ObjectOrInterface.js";
+import type { CompileTimeMetadata } from "../ontology/ObjectTypeDefinition.js";
+export type NullabilityAdherence = false | "throw" | "drop";
+export declare namespace NullabilityAdherence {
+	type Default = "throw";
+}
+export interface SelectArg<
+	Q extends ObjectOrInterfaceDefinition,
+	L extends PropertyKeys<Q> = PropertyKeys<Q>,
+	R extends boolean = false,
+	S extends NullabilityAdherence = NullabilityAdherence.Default
+> {
+	$select?: readonly L[];
+	$includeRid?: R;
+}
+export interface OrderByArg<
+	Q extends ObjectOrInterfaceDefinition,
+	L extends PropertyKeys<Q> = PropertyKeys<Q>
+> {
+	$orderBy?: { [K in L]? : "asc" | "desc" };
+}
+export type SelectArgToKeys<
+	Q extends ObjectOrInterfaceDefinition,
+	A extends SelectArg<Q, any, any>
+> = A extends SelectArg<Q, never> ? PropertyKeys<Q> : A["$select"] extends readonly string[] ? A["$select"][number] : PropertyKeys<Q>;
+export interface FetchPageArgs<
+	Q extends ObjectOrInterfaceDefinition,
+	K extends PropertyKeys<Q> = PropertyKeys<Q>,
+	R extends boolean = false,
+	A extends Augments = never,
+	S extends NullabilityAdherence = NullabilityAdherence.Default
+> extends AsyncIterArgs<Q, K, R, A, S> {
+	$nextPageToken?: string;
+	$pageSize?: number;
+}
+export interface AsyncIterArgs<
+	Q extends ObjectOrInterfaceDefinition,
+	K extends PropertyKeys<Q> = PropertyKeys<Q>,
+	R extends boolean = false,
+	A extends Augments = never,
+	S extends NullabilityAdherence = NullabilityAdherence.Default
+> extends SelectArg<Q, K, R, S>, OrderByArg<Q, PropertyKeys<Q>> {
+	$__UNSTABLE_useOldInterfaceApis?: boolean;
+}
+export type Augment<
+	X extends ObjectOrInterfaceDefinition,
+	T extends string
+> = { [K in CompileTimeMetadata<X>["apiName"]] : T[] };
+export type Augments = Record<string, string[]>;

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

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cACE,6BACA,oBACK,kCAAmC;AAC1C,cAAc,2BAA2B,qCAAsC;AAE/E,YAAY,uBAAuB,QAAQ,UAAU;AACrD,yBAAiB;MACH,UAAU;;AAGxB,iBAAiB;CACf,UAAU;CACV,UAAU,aAAa,KAAK,aAAa;CACzC,oBAAoB;CACpB,UAAU,uBAAuB,qBAAqB;EACtD;CACA,mBAAmB;CACnB,cAAc;AACf;AAED,iBAAiB;CACf,UAAU;CACV,UAAU,aAAa,KAAK,aAAa;EACzC;CACA,cACG,KAAK,MAAK,QAAQ;AAEtB;AAED,YAAY;CACV,UAAU;CACV,UAAU,UAAU;IAClB,UAAU,UAAU,YAAY,aAAa,KAC7C,EAAE,uCAAuC,EAAE,qBAC3C,aAAa;AAEjB,iBAAiB;CACf,UAAU;CACV,UAAU,aAAa,KAAK,aAAa;CACzC,oBAAoB;CACpB,UAAU;CACV,UAAU,uBAAuB,qBAAqB;UAC9C,cAAc,GAAG,GAAG,GAAG,GAAG,GAAG;CACrC;CACA;AACD;AAED,iBAAiB;CACf,UAAU;CACV,UAAU,aAAa,KAAK,aAAa;CACzC,oBAAoB;CACpB,UAAU;CACV,UAAU,uBAAuB,qBAAqB;UAC9C,UAAU,GAAG,GAAG,GAAG,IAAI,WAAW,GAAG,aAAa,IAAI;CAC9D;AACD;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

@@ -0,0 +1,39 @@
+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 { PageResult } from "../PageResult.js";
+import type { NullabilityAdherence } from "./FetchPageArgs.js";
+/** exposed for a test */
+export type RespectNullability<S extends NullabilityAdherence> = S extends false ? false : true;
+/** exposed for a test */
+export type UnionIfFalse<
+	S extends string,
+	JUST_S_IF_TRUE extends boolean,
+	E
+> = IsNever<S> extends true ? never : JUST_S_IF_TRUE extends true ? S : S | E;
+/** exposed for a test */
+export type UnionIfTrue<
+	S extends string,
+	UNION_IF_TRUE extends boolean,
+	E extends string
+> = IsNever<S> extends true ? never : UNION_IF_TRUE extends true ? S | E : S;
+/**
+* Helper type for converting fetch options into an Osdk object
+*/
+export type FetchPageResult<
+	Q extends ObjectOrInterfaceDefinition,
+	L extends PropertyKeys<Q>,
+	R extends boolean,
+	S extends NullabilityAdherence
+> = PageResult<PropertyKeys<Q> extends L ? Osdk.Instance<Q, ExtractOptions<R, S>> : Osdk.Instance<Q, ExtractOptions<R, S>, L>>;
+/**
+* Helper type for converting fetch options into an Osdk object
+*/
+export type SingleOsdkResult<
+	Q extends ObjectOrInterfaceDefinition,
+	L extends PropertyKeys<Q> | (keyof RDPs & string),
+	R extends boolean,
+	S extends NullabilityAdherence,
+	RDPs extends Record<string, SimplePropertyDef> = {}
+> = Osdk.Instance<Q, ExtractOptions<R, S>, PropertyKeys<Q> extends L ? PropertyKeys<Q> : PropertyKeys<Q> & L, { [K in Extract<keyof RDPs, L>] : RDPs[K] }>;
+export type IsAny<T> = unknown extends T ? [keyof T] extends [never] ? false : true : false;

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

@@ -0,0 +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;IACR,WACF,aAAa,WAAW,IAAI,KAAK,SAAS,GAAG,eAAe,GAAG,MAC3D,KAAK,SAAS,GAAG,eAAe,GAAG,IAAI;;;;AAM7C,YAAY;CACV,UAAU;CACV,UAAU,aAAa,YAAY;CACnC;CACA,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;IACjD,KAAK,SACP,GACA,eAAe,GAAG,IAClB,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"}

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

@@ -0,0 +1,32 @@
+export interface Media {
+	/**
+	* Fetches metadata for media reference property
+	*/
+	fetchMetadata(): Promise<MediaMetadata>;
+	/**
+	* Fetches content of a media reference property
+	*/
+	fetchContents(): Promise<Response>;
+}
+/**
+* Unique identifier of a media item in Foundry.
+*/
+export interface MediaReference {
+	mimeType: string;
+	reference: {
+		type: "mediaSetViewItem"
+		mediaSetViewItem: {
+			mediaItemRid: string
+			mediaSetRid: string
+			mediaSetViewRid: string
+		}
+	};
+}
+/**
+* Metadata of a media item
+*/
+export interface MediaMetadata {
+	path?: string;
+	sizeBytes: number;
+	mediaType: string;
+}

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

@@ -0,0 +1 @@
+{"mappings":"AAgBA,iBAAiB,MAAM;;;;CAIrB,iBAAiB,QAAQ;;;;CAIzB,iBAAiB,QAAQ;AAC1B;;;;AAKD,iBAAiB,eAAe;CAC9B;CACA,WAAW;EACT,MAAM;EACN,kBAAkB;GAChB;GACA;GACA;EACD;CACF;AACF;;;;AAKD,iBAAiB,cAAc;CAC7B;CACA;CACA;AACD","names":[],"sources":["../../../src/object/Media.ts"],"version":3,"file":"Media.d.ts"}

package/build/types/object/ObjectDefinitions.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/types/object/ObjectDefinitions.test.d.ts.map

@@ -0,0 +1 @@
+{"mappings":"","names":[],"sources":["../../../src/object/ObjectDefinitions.test.ts"],"version":3,"file":"ObjectDefinitions.test.d.ts"}

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

@@ -0,0 +1,21 @@
+export type ErrorResult = {
+	error: Error
+	value?: never
+};
+export type OkResult<V> = {
+	value: V
+	error?: never
+};
+export type Result<V> = OkResult<V> | ErrorResult;
+/**
+* Check if a result was successfully received
+* @param a - result wrapped value
+* @returns whether a result has a value in it
+*/
+export declare function isOk<X>(a: Result<X>): a is OkResult<X>;
+/**
+* Check if a result contains an error value
+* @param a Result wrapped value
+* @returns whether a result has an error in it
+*/
+export declare function isError<X>(a: Result<X>): a is ErrorResult;

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

@@ -0,0 +1 @@
+{"mappings":"AAgBA,YAAY,cAAc;CAAE,OAAO;CAAO;AAAe;AACzD,YAAY,SAAS,KAAK;CAAE,OAAO;CAAG;AAAe;AACrD,YAAY,OAAO,KAAK,SAAS,KAAK;;;;;;AAOtC,OAAO,iBAAS,KAAK,GAAGA,GAAG,OAAO,KAAK,KAAK,SAAS;;;;;;AASrD,OAAO,iBAAS,QAAQ,GAAGA,GAAG,OAAO,KAAK,KAAK","names":["a: Result<X>"],"sources":["../../../src/object/Result.ts"],"version":3,"file":"Result.d.ts"}

package/build/{esm → types}/objectSet/BaseObjectSet.d.ts

@@ -1,7 +1,6 @@
 import type { ObjectOrInterfaceDefinition } from "../ontology/ObjectOrInterface.js";
 export interface BaseObjectSet<Q extends ObjectOrInterfaceDefinition> {
-    readonly $objectSetInternals: {
-        def: Q;
-    };
+	readonly $objectSetInternals: {
+		def: Q
+	};
 }
-//# sourceMappingURL=BaseObjectSet.d.ts.map

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

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cAAc,mCAAmC,kCAAmC;AAGpF,iBAAiB,cAAc,UAAU,6BAA6B;UAC3D,qBAAqB;EAAE,KAAK;CAAG;AACzC","names":[],"sources":["../../../src/objectSet/BaseObjectSet.ts"],"version":3,"file":"BaseObjectSet.d.ts"}

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

@@ -0,0 +1,7 @@
+import type { OsdkBase } from "../OsdkBase.js";
+export interface EXPERIMENTAL_BulkLinkResult {
+	object: OsdkBase<any>;
+	linkApiName: string;
+	otherObjectApiName: string | undefined;
+	otherObjectPk: unknown;
+}

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

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cAAc,gBAAgB,gBAAiB;AAE/C,iBAAiB,4BAA4B;CAC3C,QAAQ;CACR;CACA;CACA;AACD","names":[],"sources":["../../../src/objectSet/BulkLinkResult.ts"],"version":3,"file":"BulkLinkResult.d.ts"}

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

@@ -0,0 +1,217 @@
+import type { AggregateOpts } from "../aggregate/AggregateOpts.js";
+import type { AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy } from "../aggregate/AggregateOptsThatErrors.js";
+import type { AggregationsResults } from "../aggregate/AggregationsResults.js";
+import type { WhereClause } from "../aggregate/WhereClause.js";
+import type { DerivedProperty } from "../derivedProperties/DerivedProperty.js";
+import type { AsyncIterArgs, Augments, FetchPageArgs, NullabilityAdherence, SelectArg } from "../object/FetchPageArgs.js";
+import type { Result } from "../object/Result.js";
+import type { DerivedObjectOrInterfaceDefinition, ObjectOrInterfaceDefinition, PropertyKeys } from "../ontology/ObjectOrInterface.js";
+import type { CompileTimeMetadata, ObjectTypeDefinition } from "../ontology/ObjectTypeDefinition.js";
+import type { SimplePropertyDef } from "../ontology/SimplePropertyDef.js";
+import type { PrimaryKeyType } from "../OsdkBase.js";
+import type { ExtractOptions, Osdk } from "../OsdkObjectFrom.js";
+import type { PageResult } from "../PageResult.js";
+import type { LinkedType, LinkNames } from "../util/LinkUtils.js";
+import type { BaseObjectSet } from "./BaseObjectSet.js";
+import type { ObjectSetSubscription } from "./ObjectSetListener.js";
+type MergeObjectSet<
+	Q extends ObjectOrInterfaceDefinition,
+	D extends ObjectSet<Q> | Record<string, SimplePropertyDef> = {}
+> = D extends Record<string, SimplePropertyDef> ? DerivedObjectOrInterfaceDefinition.WithDerivedProperties<Q, D> : Q;
+type ExtractRdp<D extends ObjectSet<any, any> | Record<string, SimplePropertyDef>> = D extends Record<string, SimplePropertyDef> ? D : {};
+export interface MinimalObjectSet<
+	Q extends ObjectOrInterfaceDefinition,
+	RDPs extends Record<string, SimplePropertyDef> = {}
+> extends BaseObjectSet<Q>, FetchPage<Q, RDPs>, AsyncIter<Q, RDPs>, Where<Q, RDPs> {}
+interface FetchPage<
+	Q extends ObjectOrInterfaceDefinition,
+	RDPs extends Record<string, SimplePropertyDef> = {}
+> {
+	/**
+	* Gets a page of objects of this type, with a result wrapper
+	* @param args - Args to specify next page token and page size, if applicable
+	* @example
+	*  const myObjs = await objectSet.fetchPage({
+	$pageSize: 10,
+	$nextPageToken: "nextPage"
+	});
+	const myObjsResult = myObjs.data;
+	
+	* @returns a page of objects
+	*/
+	readonly fetchPage: <
+		L extends PropertyKeys<Q, RDPs>,
+		R extends boolean,
+		const A extends Augments,
+		S extends NullabilityAdherence = NullabilityAdherence.Default
+	>(args?: FetchPageArgs<Q, L, R, A, S>) => Promise<PageResult<Osdk.Instance<Q, ExtractOptions<R, S>, PropertyKeys<Q> extends L ? PropertyKeys<Q> : PropertyKeys<Q> & L, { [K in Extract<keyof RDPs, L>] : RDPs[K] }>>>;
+	/**
+	* Gets a page of objects of this type, with a result wrapper
+	* @param args - Args to specify next page token and page size, if applicable
+	* @example
+	*  const myObjs = await objectSet.fetchPage({
+	$pageSize: 10,
+	$nextPageToken: "nextPage"
+	});
+	
+	if(isOk(myObjs)){
+	const myObjsResult = myObjs.value.data;
+	}
+	* @returns a page of objects, wrapped in a result wrapper
+	*/
+	readonly fetchPageWithErrors: <
+		L extends PropertyKeys<Q, RDPs>,
+		R extends boolean,
+		const A extends Augments,
+		S extends NullabilityAdherence = NullabilityAdherence.Default
+	>(args?: FetchPageArgs<Q, L, R, A, S>) => Promise<Result<PageResult<Osdk.Instance<Q, ExtractOptions<R, S>, PropertyKeys<Q> extends L ? PropertyKeys<Q> : PropertyKeys<Q> & L, { [K in Extract<keyof RDPs, L>] : RDPs[K] }>>>>;
+}
+interface Where<
+	Q extends ObjectOrInterfaceDefinition,
+	RDPs extends Record<string, SimplePropertyDef> = {}
+> {
+	/**
+	* Allows you to filter an object set with a given clause
+	* @param clause - Takes a filter clause
+	* @example
+	* await client(Office).where({
+	meetingRooms: { $contains: "Grand Central" },
+	meetingRoomCapacities: { $contains: 30 },
+	});
+	* @returns an objectSet
+	*/
+	readonly where: (clause: WhereClause<MergeObjectSet<Q, RDPs>>) => this;
+}
+interface AsyncIter<
+	Q extends ObjectOrInterfaceDefinition,
+	RDPs extends Record<string, SimplePropertyDef> = {}
+> {
+	/**
+	* Returns an async iterator to load all objects of this type
+	* @example
+	* for await (const obj of myObjectSet.asyncIter()){
+	* // Handle obj
+	* }
+	* @returns an async iterator to load all objects
+	*/
+	readonly asyncIter: <
+		L extends PropertyKeys<Q, RDPs>,
+		R extends boolean,
+		const A extends Augments,
+		S extends NullabilityAdherence = NullabilityAdherence.Default
+	>(args?: AsyncIterArgs<Q, L, R, A, S>) => AsyncIterableIterator<Osdk.Instance<Q, ExtractOptions<R, S>, PropertyKeys<Q> extends L ? PropertyKeys<Q> : PropertyKeys<Q> & L, { [K in Extract<keyof RDPs, L>] : RDPs[K] }>>;
+}
+interface WithProperties<
+	Q extends ObjectOrInterfaceDefinition = any,
+	RDPs extends Record<string, SimplePropertyDef> = {}
+> {
+	readonly withProperties: <NEW extends Record<string, SimplePropertyDef>>(clause: { [K in keyof NEW] : DerivedProperty.Selector<Q, NEW[K]> }) => ObjectSet<Q, { [NN in keyof NEW | keyof RDPs] : NN extends keyof NEW ? NEW[NN] : NN extends keyof RDPs ? RDPs[NN] : never }>;
+}
+export interface ObjectSet<
+	Q extends ObjectOrInterfaceDefinition = any,
+	UNUSED_OR_RDP extends ObjectSet<Q, any> | Record<string, SimplePropertyDef> = ObjectSet<Q, any>
+> extends ObjectSetCleanedTypes<Q, ExtractRdp<UNUSED_OR_RDP>, MergeObjectSet<Q, UNUSED_OR_RDP>> {}
+interface Aggregate<Q extends ObjectOrInterfaceDefinition> {
+	/**
+	* Aggregate on a field in an object type
+	* @param req - an aggregation request where you can select fields and choose how to aggregate, e.g., max, min, avg, and also choose
+	* whether or not you order your results. You can also specify a groupBy field to group your aggregations
+	* @example
+	* const testAggregateCountWithGroups = await client(BoundariesUsState)
+	.aggregate({
+	$select: {
+	$count: "unordered",
+	"latitude:max": "unordered",
+	"latitude:min": "unordered",
+	"latitude:avg": "unordered",
+	},
+	$groupBy: {
+	usState: "exact",
+	longitude: {
+	$fixedWidth: 10,
+	},
+	},
+	});
+	
+	* @returns aggregation results, sorted in the groups based on the groupBy clause (if applicable)
+	*/
+	readonly aggregate: <AO extends AggregateOpts<Q>>(req: AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy<Q, AO>) => Promise<AggregationsResults<Q, AO>>;
+}
+interface SetArithmetic<Q extends ObjectOrInterfaceDefinition> {
+	/**
+	* Unions object sets together
+	* @param objectSets - objectSets you want to union with
+	* @example
+	* const unionObjectSet = complexFilteredEmployeeObjectSet.union(
+	simpleFilteredEmployeeObjectSet,
+	);
+	* @returns the unioned object set
+	*/
+	readonly union: (...objectSets: ReadonlyArray<CompileTimeMetadata<Q>["objectSet"]>) => this;
+	/**
+	* Computes the intersection of object sets
+	* @param objectSets - objectSets you want to intersect with
+	* @example
+	* const intersectedObjectSet = complexFilteredEmployeeObjectSet.intersect(
+	simpleFilteredEmployeeObjectSet,
+	);
+	* @returns the intersected object set
+	*/
+	readonly intersect: (...objectSets: ReadonlyArray<CompileTimeMetadata<Q>["objectSet"]>) => this;
+	/**
+	* Computes the subtraction of object sets
+	* @param objectSets - objectSets you want to subtract from
+	* @example
+	* const subtractObjectSet = complexFilteredEmployeeObjectSet.subtract(
+	simpleFilteredEmployeeObjectSet,
+	);
+	* @returns the subtract object set
+	*/
+	readonly subtract: (...objectSets: ReadonlyArray<CompileTimeMetadata<Q>["objectSet"]>) => this;
+}
+interface PivotTo<Q extends ObjectOrInterfaceDefinition> {
+	/**
+	* Pivots the object set over to all its linked objects of the specified type
+	* @param type - The linked object type you want to pivot to
+	* @returns an object set of the specified linked type
+	*/
+	readonly pivotTo: <L extends LinkNames<Q>>(type: L) => CompileTimeMetadata<LinkedType<Q, L>>["objectSet"];
+}
+interface FetchOne<
+	Q extends ObjectOrInterfaceDefinition,
+	RDPs extends Record<string, SimplePropertyDef>
+> {
+	/**
+	* Fetches one object with the specified primary key, without a result wrapper
+	*/
+	readonly fetchOne: Q extends ObjectTypeDefinition ? <
+		const L extends PropertyKeys<Q, RDPs>,
+		const R extends boolean,
+		const S extends false | "throw" = NullabilityAdherence.Default
+	>(primaryKey: PrimaryKeyType<Q>, options?: SelectArg<Q, L, R, S>) => Promise<Osdk.Instance<Q, ExtractOptions<R, S>, PropertyKeys<Q> extends L ? PropertyKeys<Q> : PropertyKeys<Q> & L, { [K in Extract<keyof RDPs, L>] : RDPs[K] }>> : never;
+	/**
+	* Fetches one object with the specified primary key, with a result wrapper
+	*/
+	readonly fetchOneWithErrors: Q extends ObjectTypeDefinition ? <
+		L extends PropertyKeys<Q, RDPs>,
+		R extends boolean,
+		S extends false | "throw" = NullabilityAdherence.Default
+	>(primaryKey: PrimaryKeyType<Q>, options?: SelectArg<Q, L, R, S>) => Promise<Result<Osdk.Instance<Q, ExtractOptions<R, S>, PropertyKeys<Q> extends L ? PropertyKeys<Q> : PropertyKeys<Q> & L, { [K in Extract<keyof RDPs, L>] : RDPs[K] }>>> : never;
+}
+interface Subscribe<Q extends ObjectOrInterfaceDefinition> {
+	/**
+	* Request updates when the objects in an object set are added, updated, or removed.
+	* @param listener - The handlers to be executed during the lifecycle of the subscription.
+	* @param opts - Options to modify what properties are returned on subscription updates.
+	* @returns an object containing a function to unsubscribe.
+	*/
+	readonly subscribe: <const P extends PropertyKeys<Q>>(listener: ObjectSetSubscription.Listener<Q, P>, opts?: ObjectSetSubscription.Options<Q, P>) => {
+		unsubscribe: () => void
+	};
+}
+interface ObjectSetCleanedTypes<
+	Q extends ObjectOrInterfaceDefinition,
+	D extends Record<string, SimplePropertyDef>,
+	MERGED extends ObjectOrInterfaceDefinition
+> extends MinimalObjectSet<Q, D>, WithProperties<Q, D>, Aggregate<MERGED>, SetArithmetic<MERGED>, PivotTo<MERGED>, FetchOne<Q, D>, Subscribe<MERGED> {}
+export {};

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

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cAAc,qBAAqB,+BAAgC;AACnE,cAAc,sEAAsE,yCAA0C;AAC9H,cAAc,2BAA2B,qCAAsC;AAC/E,cAAc,mBAAmB,6BAA8B;AAC/D,cAAc,uBAAuB,yCAA0C;AAC/E,cACE,eACA,UACA,eACA,sBACA,iBACK,4BAA6B;AACpC,cAAc,cAAc,qBAAsB;AAElD,cACE,oCACA,6BACA,oBACK,kCAAmC;AAC1C,cACE,qBACA,4BACK,qCAAsC;AAC7C,cAAc,yBAAyB,kCAAmC;AAC1E,cAAc,sBAAsB,gBAAiB;AACrD,cAAc,gBAAgB,YAAY,sBAAuB;AACjE,cAAc,kBAAkB,kBAAmB;AACnD,cAAc,YAAY,iBAAiB,sBAAuB;AAClE,cAAc,qBAAqB,oBAAqB;AACxD,cAAc,6BAA6B,wBAAyB;KAE/D;CACH,UAAU;CACV,UAAU,UAAU,KAAK,eAAe,qBAAqB,CAAE;IAC7D,UAAU,eAAe,qBACzB,mCAAmC,sBAAsB,GAAG,KAC5D;KAEC,WACH,UAAU,sBAAsB,eAAe,sBAC7C,UAAU,eAAe,qBAAqB,IAAI,CAAE;AAExD,iBAAiB;CACf,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;UAEnD,cAAc,IACd,UAAU,GAAG,OACb,UAAU,GAAG,OACb,MAAM,GAAG,MACX,CACC;UAGS;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;EACnD;;;;;;;;;;;;;UAaS;EACP,UAAU,aAAa,GAAG;EAC1B;QACM,UAAU;EAChB,UAAU,uBAAuB,qBAAqB;GAEtDA,OAAO,cAAc,GAAG,GAAG,GAAG,GAAG,OAC9B,QACH,WACE,KAAK,SACH,GACA,eAAe,GAAG,IAClB,aAAa,WAAW,IAAI,aAAa,KAAK,aAAa,KAAK,MAC7D,KAAK,cAAc,MAAM,MAAK,KAAK;;;;;;;;;;;;;;;UAmBnC;EACP,UAAU,aAAa,GAAG;EAC1B;QACM,UAAU;EAChB,UAAU,uBAAuB,qBAAqB;GAEtDA,OAAO,cAAc,GAAG,GAAG,GAAG,GAAG,OAC9B,QACH,OACE,WACE,KAAK,SACH,GACA,eAAe,GAAG,IAClB,aAAa,WAAW,IAAI,aAAa,KAAK,aAAa,KAAK,MAC7D,KAAK,cAAc,MAAM,MAAK,KAAK;AAK/C;UAGS;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;EACnD;;;;;;;;;;;UAWS,QACPC,QAAQ,YAAY,eAAe,GAAG;AAEzC;UAES;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;EACnD;;;;;;;;;UASS;EACP,UAAU,aAAa,GAAG;EAC1B;QACM,UAAU;EAChB,UAAU,uBAAuB,qBAAqB;GAEtDC,OAAO,cAAc,GAAG,GAAG,GAAG,GAAG,OAC9B,sBACH,KAAK,SACH,GACA,eAAe,GAAG,IAClB,aAAa,WAAW,IAAI,aAAa,KAAK,aAAa,KAAK,MAC7D,KAAK,cAAc,MAAM,MAAK,KAAK;AAG3C;UAOS;CACR,UAAU;CACV,aAAa,eAAe,qBAAqB,CAAE;EACnD;UACS,iBACP,YAAY,eAAe,oBAE3BC,WAAW,WAAW,OAAM,gBAAgB,SAAS,GAAG,IAAI,UACzD,UACH,MAEG,YAAY,YAAY,QAAO,iBAAiB,MAAM,IAAI,MACvD,iBAAiB,OAAO,KAAK;AAItC;AAED,iBAAiB;CACf,UAAU;CAGV,sBAAsB,UAAU,UAAU,eAAe,qBACvD,UAAU;UAEZ,sBACE,GACA,WAAW,gBACX,eAAe,GAAG,gBAEtB,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,oBAAoB,WAAW,GAAG,IAAI;AAC5C;UAES;CACR,UAAU;CACV,aAAa,eAAe;EAC5B;;;;UAIS,UAAU,UAAU;QACnB,UAAU,aAAa,GAAG;QAC1B;QACA,UAAU,QAAQ,UAAU,qBAAqB;GAEvDC,YAAY,eAAe,IAC3BC,UAAU,UAAU,GAAG,GAAG,GAAG,OAC1B,QACH,KAAK,SACH,GACA,eAAe,GAAG,IAClB,aAAa,WAAW,IAAI,aAAa,KAAK,aAAa,KAAK,MAC7D,KAAK,cAAc,MAAM,MAAK,KAAK;;;;UAQnC,oBAAoB,UAAU;EACnC,UAAU,aAAa,GAAG;EAC1B;EACA,UAAU,QAAQ,UAAU,qBAAqB;GAEjDD,YAAY,eAAe,IAC3BC,UAAU,UAAU,GAAG,GAAG,GAAG,OAC1B,QACH,OACE,KAAK,SACH,GACA,eAAe,GAAG,IAClB,aAAa,WAAW,IAAI,aAAa,KAAK,aAAa,KAAK,MAC7D,KAAK,cAAc,MAAM,MAAK,KAAK;AAK/C;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;UAEf,iBAAiB,GAAG,IACpB,eAAe,GAAG,IAClB,UAAU,SACV,cAAc,SACd,QAAQ,SACR,SAAS,GAAG,IACZ,UAAU,QACZ,CACC","names":["args?: FetchPageArgs<Q, L, R, A, S>","clause: WhereClause<MergeObjectSet<Q, RDPs>>","args?: AsyncIterArgs<Q, L, R, A, S>","clause: { [K in keyof NEW]: DerivedProperty.Selector<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/objectSet/ObjectSet.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1 @@
+{"mappings":"","names":[],"sources":["../../../src/objectSet/ObjectSet.test.ts"],"version":3,"file":"ObjectSet.test.d.ts"}

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

@@ -0,0 +1,43 @@
+import type { ObjectOrInterfaceDefinition, PropertyKeys } from "../ontology/ObjectOrInterface.js";
+import type { Osdk } from "../OsdkObjectFrom.js";
+export declare namespace ObjectSetSubscription {
+	interface Listener<
+		O extends ObjectOrInterfaceDefinition,
+		P extends PropertyKeys<O> = PropertyKeys<O>
+	> {
+		/**
+		* Specific objects have changed and can be immediately updated
+		*/
+		onChange?: (objectUpdate: ObjectUpdate<O, P>) => void;
+		/**
+		* The subscription has been successfully established and updates can be expected to be received.
+		*/
+		onSuccessfulSubscription?: () => void;
+		/**
+		* The ObjectSet has become outdated and should be re-fetched in its entirety.
+		* This is also sent when the subscription is first initialized.
+		*/
+		onOutOfDate?: () => void;
+		/**
+		* There was a fatal error with the subscription process. The subscription will close or will not be established.
+		*/
+		onError?: (errors: {
+			subscriptionClosed: boolean
+			error: any
+		}) => void;
+	}
+	interface Options<
+		O extends ObjectOrInterfaceDefinition,
+		P extends PropertyKeys<O> = PropertyKeys<O>
+	> {
+		properties?: Array<P>;
+	}
+}
+type ObjectUpdate<
+	O extends ObjectOrInterfaceDefinition,
+	P extends PropertyKeys<O>
+> = {
+	object: Osdk.Instance<O, never, P>
+	state: "ADDED_OR_UPDATED" | "REMOVED"
+};
+export {};

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

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cACE,6BACA,oBACK,kCAAmC;AAC1C,cAAc,YAAY,sBAAuB;AAEjD,yBAAiB;WACE;EACf,UAAU;EACV,UAAU,aAAa,KAAK,aAAa;GACzC;;;;EAIA,YACEA,cAAc,aAAa,GAAG;;;;EAMhC;;;;;EAMA;;;;EAKA,WAAWC,QAAQ;GAAE;GAA6B;EAAY;CAC/D;WAQgB;EACf,UAAU;EACV,UAAU,aAAa,KAAK,aAAa;GACzC;EACA,aAAa,MAAM;CACpB;;KAGE;CACH,UAAU;CACV,UAAU,aAAa;IACrB;CACF,QAAQ,KAAK,SAAS,UAAU;CAChC,OAAO,qBAAqB;AAC7B","names":["objectUpdate: ObjectUpdate<O, P>","errors: { subscriptionClosed: boolean; error: any }"],"sources":["../../../src/objectSet/ObjectSetListener.ts"],"version":3,"file":"ObjectSetListener.d.ts"}

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

@@ -0,0 +1,55 @@
+import type { OsdkMetadata } from "../OsdkMetadata.js";
+import type { InterfaceDefinition } from "./InterfaceDefinition.js";
+import type { ObjectTypeDefinition, ReleaseStatus } from "./ObjectTypeDefinition.js";
+export interface ActionMetadata {
+	type: "action";
+	apiName: string;
+	description?: string;
+	displayName?: string;
+	parameters: Record<any, ActionMetadata.Parameter<any>>;
+	modifiedEntities?: Partial<Record<any, {
+		created: boolean
+		modified: boolean
+	}>>;
+	status: ReleaseStatus;
+	rid: string;
+}
+export declare namespace ActionMetadata {
+	interface Parameter<T_Target extends ObjectTypeDefinition = never> {
+		type: DataType.BaseActionParameterTypes | DataType.Object<any> | DataType.ObjectSet<any> | DataType.Interface<any> | DataType.Struct<any>;
+		description?: string;
+		multiplicity?: boolean;
+		nullable?: boolean;
+	}
+	namespace DataType {
+		type BaseActionParameterTypes = "boolean" | "string" | "integer" | "long" | "double" | "datetime" | "timestamp" | "attachment" | "marking" | "mediaReference" | "objectType";
+		interface Object<T_Target extends ObjectTypeDefinition = never> {
+			__OsdkTargetType?: T_Target;
+			type: "object";
+			object: T_Target["apiName"];
+		}
+		interface Interface<T_Target extends InterfaceDefinition = never> {
+			__OsdkTargetType?: T_Target;
+			type: "interface";
+			interface: T_Target["apiName"];
+		}
+		interface ObjectSet<T_Target extends ObjectTypeDefinition = never> {
+			__OsdkTargetType?: T_Target;
+			type: "objectSet";
+			objectSet: T_Target["apiName"];
+		}
+		interface Struct<T extends Record<string, DataType.BaseActionParameterTypes>> {
+			type: "struct";
+			struct: T;
+		}
+	}
+}
+export interface ActionCompileTimeMetadata<T> {
+	signatures: T;
+}
+export interface ActionDefinition<T_signatures = never> {
+	type: "action";
+	apiName: string;
+	osdkMetadata?: OsdkMetadata;
+	__DefinitionMetadata?: ActionCompileTimeMetadata<T_signatures> & ActionMetadata;
+}

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

@@ -0,0 +1 @@
+{"mappings":"AAgBA,cAAc,oBAAoB,oBAAqB;AACvD,cAAc,2BAA2B,0BAA2B;AACpE,cACE,sBACA,qBACK,2BAA4B;AAEnC,iBAAiB,eAAe;CAC9B,MAAM;CACN;CACA;CACA;CACA,YAAY,YAAY,eAAe;CACvC,mBAAmB,QACjB,YAAY;EACV;EACA;CACD;CAEH,QAAQ;CACR;AACD;AAED,yBAAiB;WACE,UACf,iBAAiB,8BACjB;EACA,MACI,SAAS,2BACT,SAAS,cACT,SAAS,iBACT,SAAS,iBACT,SAAS;EACb;EACA;EACA;CACD;WAEgB;OACH,2BACR,YACA,WACA,YACA,SACA,WACA,aACA,cACA,eACA,YACA,mBACA;YAEa,OACf,iBAAiB,8BACjB;GACA,mBAAmB;GACnB,MAAM;GACN,QAAQ,SAAS;EAClB;YAEgB,UAAU,iBAAiB,6BAA6B;GACvE,mBAAmB;GACnB,MAAM;GACN,WAAW,SAAS;EACrB;YAEgB,UACf,iBAAiB,8BACjB;GACA,mBAAmB;GACnB,MAAM;GACN,WAAW,SAAS;EACrB;YAEgB,OACf,UAAU,eAAe,SAAS,2BAClC;GACA,MAAM;GACN,QAAQ;EACT;;;AAIL,iBAAiB,0BAA0B,GAAG;CAC5C,YAAY;AACb;AAED,iBAAiB,iBACf,sBACA;CACA,MAAM;CACN;CACA,eAAe;CACf,uBACI,0BAA0B,gBAC1B;AACL","names":[],"sources":["../../../src/ontology/ActionDefinition.ts"],"version":3,"file":"ActionDefinition.d.ts"}

package/build/{browser → types}/ontology/InterfaceDefinition.d.ts

@@ -1,12 +1,12 @@
 import type { OsdkMetadata } from "../OsdkMetadata.js";
 import type { ObjectInterfaceBaseMetadata, ObjectInterfaceCompileDefinition } from "./ObjectTypeDefinition.js";
 export interface InterfaceMetadata extends ObjectInterfaceBaseMetadata {
-    type: "interface";
+	type: "interface";
+	implementedBy?: ReadonlyArray<string>;
 }
 export interface InterfaceDefinition {
-    type: "interface";
-    apiName: string;
-    osdkMetadata?: OsdkMetadata;
-    __DefinitionMetadata?: InterfaceMetadata & ObjectInterfaceCompileDefinition;
+	type: "interface";
+	apiName: string;
+	osdkMetadata?: OsdkMetadata;
+	__DefinitionMetadata?: InterfaceMetadata & ObjectInterfaceCompileDefinition;
 }
-//# sourceMappingURL=InterfaceDefinition.d.ts.map