@osdk/api 2.1.0-beta.3 → 2.1.0-beta.30

package/build/types/groupby/GroupByClause.d.ts

@@ -0,0 +1,57 @@
+import type { AggregatableKeys } from "../aggregate/AggregatableKeys.js";
+import type { ObjectOrInterfaceDefinition } from "../ontology/ObjectOrInterface.js";
+import type { CompileTimeMetadata } from "../ontology/ObjectTypeDefinition.js";
+import type { GroupByMapper } from "./GroupByMapper.js";
+export type GroupByClause<Q extends ObjectOrInterfaceDefinition> = { [P in AggregatableKeys<Q>]? : GroupByEntry<Q, P> };
+type BaseGroupByValue = "exact" | { $exactWithLimit: number };
+export type GroupByRange<T> = [T, T];
+export type StringGroupByValue = BaseGroupByValue;
+export type NumericGroupByValue = BaseGroupByValue | { $fixedWidth: number } | { $ranges: GroupByRange<number>[] };
+export type TimestampGroupByValue = BaseGroupByValue | { $ranges: GroupByRange<string>[] } | { $duration: TimestampDurationGroupBy };
+export type DateGroupByValue = BaseGroupByValue | { $ranges: GroupByRange<string>[] } | { $duration: DatetimeDurationGroupBy };
+export type BooleanGroupByValue = BaseGroupByValue;
+export type TimestampTimeUnits = DateTimeUnits | "SECONDS" | "MINUTES" | "HOURS";
+export type DateTimeUnits = "DAYS" | "WEEKS" | "MONTHS" | "YEARS" | "QUARTERS";
+export declare const DurationMapping: {
+	quarter: "QUARTERS";
+	quarters: "QUARTERS";
+	sec: "SECONDS";
+	seconds: "SECONDS";
+	min: "MINUTES";
+	minute: "MINUTES";
+	minutes: "MINUTES";
+	hr: "HOURS";
+	hrs: "HOURS";
+	hour: "HOURS";
+	hours: "HOURS";
+	day: "DAYS";
+	days: "DAYS";
+	wk: "WEEKS";
+	week: "WEEKS";
+	weeks: "WEEKS";
+	mos: "MONTHS";
+	month: "MONTHS";
+	months: "MONTHS";
+	yr: "YEARS";
+	year: "YEARS";
+	years: "YEARS";
+};
+interface TimeValueMapping {
+	SECONDS: number;
+	MINUTES: number;
+	HOURS: number;
+	DAYS: number;
+	WEEKS: 1;
+	MONTHS: 1;
+	YEARS: 1;
+	QUARTERS: 1;
+}
+type DurationGroupBy<A> = { [K in keyof typeof DurationMapping] : typeof DurationMapping[K] extends A ? [TimeValueMapping[typeof DurationMapping[K]], K] : never }[keyof typeof DurationMapping];
+type TimestampDurationGroupBy = DurationGroupBy<TimestampTimeUnits>;
+type DatetimeDurationGroupBy = DurationGroupBy<DateTimeUnits>;
+type GroupByEntry<
+	Q extends ObjectOrInterfaceDefinition,
+	P extends AggregatableKeys<Q>
+> = CompileTimeMetadata<Q>["properties"][P]["type"] extends keyof GroupByMapper ? GroupByMapper[CompileTimeMetadata<Q>["properties"][P]["type"]] : never;
+export type AllGroupByValues = GroupByMapper[keyof GroupByMapper];
+export {};

package/build/types/groupby/GroupByClause.test.d.ts

@@ -0,0 +1,17 @@
+import type { GroupByClause } from "./GroupByClause.js";
+export type F = GroupByClause<{
+	metadata: any;
+	objects: { Todo: {
+		type: "object";
+		apiName: "Todo";
+		primaryKeyApiName: "id";
+		primaryKeyType: "double";
+		links: {};
+		properties: {
+			text: { type: "string" };
+			id: { type: "double" };
+		};
+	} };
+	actions: {};
+	queries: {};
+}["objects"]["Todo"]>;

package/build/types/groupby/GroupByMapper.d.ts

@@ -0,0 +1,13 @@
+import type { BooleanGroupByValue, DateGroupByValue, NumericGroupByValue, StringGroupByValue, TimestampGroupByValue } from "./GroupByClause.js";
+export interface GroupByMapper {
+	string: StringGroupByValue;
+	short: NumericGroupByValue;
+	float: NumericGroupByValue;
+	decimal: NumericGroupByValue;
+	byte: NumericGroupByValue;
+	double: NumericGroupByValue;
+	integer: NumericGroupByValue;
+	timestamp: TimestampGroupByValue;
+	datetime: DateGroupByValue;
+	boolean: BooleanGroupByValue;
+}

package/build/types/index.d.ts

@@ -0,0 +1,45 @@
+export type  { ActionReturnTypeForOptions } from "./actions/ActionReturnTypeForOptions.js";
+export type  { ActionEditResponse, ActionParam, ActionValidationResponse, ApplyActionOptions, ApplyBatchActionOptions } from "./actions/Actions.js";
+export type  { ValidAggregationKeys } from "./aggregate/AggregatableKeys.js";
+export type  { AggregateOpts } from "./aggregate/AggregateOpts.js";
+export type  { AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy } from "./aggregate/AggregateOptsThatErrors.js";
+export type  { AggregationResultsWithGroups } from "./aggregate/AggregationResultsWithGroups.js";
+export type  { AggregationResultsWithoutGroups } from "./aggregate/AggregationResultsWithoutGroups.js";
+export type  { AggregationClause } from "./aggregate/AggregationsClause.js";
+export type  { AggregationsResults } from "./aggregate/AggregationsResults.js";
+export type  { GeoFilterOptions } from "./aggregate/GeoFilter.js";
+export { DistanceUnitMapping } from "./aggregate/WhereClause.js";
+export type  { GeoFilter_Intersects, GeoFilter_Within, PossibleWhereClauseFilters, WhereClause } from "./aggregate/WhereClause.js";
+export type  { OsdkObjectPropertyType } from "./Definitions.js";
+export type  { OsdkObjectLinksObject, SingleLinkAccessor } from "./definitions/LinkDefinitions.js";
+export type  { DerivedProperty } from "./derivedProperties/DerivedProperty.js";
+export { DurationMapping } from "./groupby/GroupByClause.js";
+export type  { AllGroupByValues, GroupByClause, GroupByRange } from "./groupby/GroupByClause.js";
+export type  { AllowedBucketKeyTypes, AllowedBucketTypes, DataValueClientToWire, DataValueWireToClient } from "./mapping/DataValueMapping.js";
+export type  { PropertyValueWireToClient } from "./mapping/PropertyValueMapping.js";
+export type  { Attachment, AttachmentUpload } from "./object/Attachment.js";
+export type  { AsyncIterArgs, Augment, Augments, FetchPageArgs, NullabilityAdherence, SelectArg, SelectArgToKeys } from "./object/FetchPageArgs.js";
+export type  { FetchPageResult, SingleOsdkResult } from "./object/FetchPageResult.js";
+export type  { Media, MediaMetadata, MediaReference } from "./object/Media.js";
+export { isOk } from "./object/Result.js";
+export type  { Result } from "./object/Result.js";
+export type  { BaseObjectSet } from "./objectSet/BaseObjectSet.js";
+export type  { ObjectSet } from "./objectSet/ObjectSet.js";
+export type  { ObjectSetSubscription } from "./objectSet/ObjectSetListener.js";
+export type  { ActionDefinition, ActionMetadata } from "./ontology/ActionDefinition.js";
+export type  { InterfaceDefinition, InterfaceMetadata } from "./ontology/InterfaceDefinition.js";
+export type  { ObjectOrInterfaceDefinition, PropertyKeys } from "./ontology/ObjectOrInterface.js";
+export type  { CompileTimeMetadata, ObjectMetadata, ObjectTypeDefinition, PropertyDef, VersionBound } from "./ontology/ObjectTypeDefinition.js";
+export type  { OntologyMetadata } from "./ontology/OntologyMetadata.js";
+export type  { PrimaryKeyTypes } from "./ontology/PrimaryKeyTypes.js";
+export type  { ObjectQueryDataType, ObjectSetQueryDataType, QueryDataTypeDefinition, QueryDefinition, QueryMetadata, QueryParameterDefinition, ThreeDimensionalQueryAggregationDefinition, TwoDimensionalQueryAggregationDefinition } from "./ontology/QueryDefinition.js";
+export type  { BaseWirePropertyTypes, WirePropertyTypes } from "./ontology/WirePropertyTypes.js";
+export type  { OsdkBase, PrimaryKeyType } from "./OsdkBase.js";
+export type  { OsdkObject } from "./OsdkObject.js";
+export type  { ConvertProps, Osdk } from "./OsdkObjectFrom.js";
+export type  { PageResult } from "./PageResult.js";
+export type  { QueryParam, QueryResult } from "./queries/Queries.js";
+export { TimeseriesDurationMapping } from "./timeseries/timeseries.js";
+export type  { GeotimeSeriesProperty, TimeSeriesPoint, TimeSeriesProperty, TimeSeriesQuery } from "./timeseries/timeseries.js";
+export type  { LinkedType, LinkNames } from "./util/LinkUtils.js";
+export {};

package/build/types/junk.test.d.ts

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

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

@@ -0,0 +1,75 @@
+import type { Attachment, AttachmentUpload } from "../object/Attachment.js";
+import type { MediaReference } from "../object/Media.js";
+/**
+* Map from the DataValue type to the typescript type that we return
+*/
+export interface DataValueWireToClient {
+	attachment: Attachment;
+	boolean: boolean;
+	byte: number;
+	datetime: string;
+	decimal: string;
+	float: number;
+	double: number;
+	integer: number;
+	long: string;
+	marking: string;
+	null: null;
+	short: number;
+	string: string;
+	timestamp: string;
+	mediaReference: MediaReference;
+	twoDimensionalAggregation: {
+		key: AllowedBucketKeyTypes;
+		value: AllowedBucketTypes;
+	}[];
+	threeDimensionalAggregation: {
+		key: AllowedBucketKeyTypes;
+		groups: {
+			key: AllowedBucketKeyTypes;
+			value: AllowedBucketTypes;
+		}[];
+	}[];
+	struct: Record<string, any>;
+	set: Set<any>;
+	objectType: string;
+}
+/**
+* Map from the DataValue type to the typescript type that we accept
+*/
+export interface DataValueClientToWire {
+	attachment: string | AttachmentUpload | Blob & { readonly name: string };
+	boolean: boolean;
+	byte: number;
+	datetime: string;
+	decimal: string | number;
+	float: number;
+	double: number;
+	integer: number;
+	long: string | number;
+	marking: string;
+	null: null;
+	short: number;
+	string: string;
+	timestamp: string;
+	set: Set<any>;
+	mediaReference: MediaReference;
+	twoDimensionalAggregation: {
+		key: AllowedBucketKeyTypes;
+		value: AllowedBucketTypes;
+	}[];
+	threeDimensionalAggregation: {
+		key: AllowedBucketKeyTypes;
+		groups: {
+			key: AllowedBucketKeyTypes;
+			value: AllowedBucketTypes;
+		}[];
+	}[];
+	struct: Record<string, any>;
+	objectType: string;
+}
+export type AllowedBucketTypes = string | number | boolean;
+export type AllowedBucketKeyTypes = AllowedBucketTypes | {
+	startValue: AllowedBucketTypes;
+	endValue: AllowedBucketTypes;
+};

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

@@ -0,0 +1,22 @@
+export declare const TimeDurationMapping: {
+	sec: "SECONDS";
+	seconds: "SECONDS";
+	min: "MINUTES";
+	minute: "MINUTES";
+	minutes: "MINUTES";
+	hr: "HOURS";
+	hrs: "HOURS";
+	hour: "HOURS";
+	hours: "HOURS";
+	day: "DAYS";
+	days: "DAYS";
+	wk: "WEEKS";
+	week: "WEEKS";
+	weeks: "WEEKS";
+	mos: "MONTHS";
+	month: "MONTHS";
+	months: "MONTHS";
+	yr: "YEARS";
+	year: "YEARS";
+	years: "YEARS";
+};

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

@@ -0,0 +1,55 @@
+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/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/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/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/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/ObjectDefinitions.test.d.ts

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

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/{esm → types}/objectSet/BaseObjectSet.d.ts

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

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