@osdk/api 2.1.1 → 2.2.0-beta.10

package/build/cjs/{ObjectSet-DgxzOo6y.d.cts → FilteredPropertyKeys-Byq3on7Q.d.cts}

@@ -57,9 +57,9 @@ interface MediaMetadata {
 }
 
 type CollectWithPropAggregations = "collectSet" | "collectList";
-type BaseWithPropAggregations = "approximateDistinct" | "exactDistinct" | "approximatePercentile";
+type BaseWithPropAggregations = "approximateDistinct" | "exactDistinct";
 type StringWithPropAggregateOption = BaseWithPropAggregations | CollectWithPropAggregations;
-type NumericWithPropAggregateOption = "min" | "max" | "sum" | "avg" | BaseWithPropAggregations | CollectWithPropAggregations;
+type NumericWithPropAggregateOption = "min" | "max" | "sum" | "avg" | "approximatePercentile" | BaseWithPropAggregations | CollectWithPropAggregations;
 
 type TimeSeriesQuery = {
     $before: number;
@@ -322,7 +322,7 @@ interface PropertyDef<T extends WirePropertyTypes, N extends "nullable" | "non-n
     multiplicity: M extends "array" ? true : false;
     nullable: N extends "nullable" ? true : false;
 }
-type ReleaseStatus = "ACTIVE" | "EXPERIMENTAL" | "DEPRECATED";
+type ReleaseStatus = "ACTIVE" | "EXPERIMENTAL" | "DEPRECATED" | "ENDORSED";
 type ObjectTypeVisibility = "NORMAL" | "PROMINENT" | "HIDDEN";
 type BlueprintIcon = {
     type: "blueprint";
@@ -371,9 +371,9 @@ type PropertyKeys<O extends ObjectOrInterfaceDefinition, RDPs extends Record<str
 
 type StringAggregateOption = "approximateDistinct" | "exactDistinct";
 type NumericAggregateOption = "min" | "max" | "sum" | "avg" | "approximateDistinct" | "exactDistinct";
-type AGG_FOR_TYPE<T, U extends boolean> = number extends T ? U extends true ? NumericAggregateOption : NumericWithPropAggregateOption : string extends T ? U extends true ? StringAggregateOption : StringWithPropAggregateOption : never;
-type ValidAggregationKeys<Q extends ObjectOrInterfaceDefinition, R extends "aggregate" = "aggregate"> = keyof ({
-    [KK in AggregatableKeys<Q> as `${KK & string}:${AGG_FOR_TYPE<GetWirePropertyValueFromClient<CompileTimeMetadata<Q>["properties"][KK]["type"]>, true>}`]?: any;
+type AGG_FOR_TYPE<T, U extends boolean> = number extends T ? U extends true ? NumericAggregateOption : NumericWithPropAggregateOption : string extends T ? U extends true ? StringAggregateOption : StringWithPropAggregateOption : boolean extends T ? U extends true ? never : StringWithPropAggregateOption : never;
+type ValidAggregationKeys<Q extends ObjectOrInterfaceDefinition, R extends "aggregate" | "withPropertiesAggregate" = "aggregate"> = keyof ({
+    [KK in AggregatableKeys<Q> as `${KK & string}:${AGG_FOR_TYPE<GetWirePropertyValueFromClient<CompileTimeMetadata<Q>["properties"][KK]["type"]>, R extends "aggregate" ? true : false>}`]?: any;
 } & {
     $count?: any;
 });
@@ -399,6 +399,12 @@ type GroupByClause<Q extends ObjectOrInterfaceDefinition> = {
 };
 type BaseGroupByValue = "exact" | {
     $exactWithLimit: number;
+} | ExactGroupByWithOptions;
+type ExactGroupByWithOptions = {
+    $exact: {
+        $limit?: number;
+        $defaultValue?: string;
+    };
 };
 type GroupByRange<T> = [T, T];
 type StringGroupByValue = BaseGroupByValue;
@@ -531,12 +537,13 @@ interface OrderByArg<Q extends ObjectOrInterfaceDefinition, L extends PropertyKe
     };
 }
 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>;
-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> {
+interface FetchPageArgs<Q extends ObjectOrInterfaceDefinition, K extends PropertyKeys<Q> = PropertyKeys<Q>, R extends boolean = false, A extends Augments = never, S extends NullabilityAdherence = NullabilityAdherence.Default, T extends boolean = false> extends AsyncIterArgs<Q, K, R, A, S, T> {
     $nextPageToken?: string;
     $pageSize?: number;
 }
-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>> {
+interface AsyncIterArgs<Q extends ObjectOrInterfaceDefinition, K extends PropertyKeys<Q> = PropertyKeys<Q>, R extends boolean = false, A extends Augments = never, S extends NullabilityAdherence = NullabilityAdherence.Default, T extends boolean = false> extends SelectArg<Q, K, R, S>, OrderByArg<Q, PropertyKeys<Q>> {
     $__UNSTABLE_useOldInterfaceApis?: boolean;
+    $includeAllBaseObjectProperties?: PropertyKeys<Q> extends K ? T : never;
 }
 type Augment<X extends ObjectOrInterfaceDefinition, T extends string> = {
     [K in CompileTimeMetadata<X>["apiName"]]: T[];
@@ -585,14 +592,18 @@ type UnionIfTrue<S extends string, UNION_IF_TRUE extends boolean, E extends stri
 /**
  * Helper type for converting fetch options into an Osdk object
  */
-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>>;
+type FetchPageResult<Q extends ObjectOrInterfaceDefinition, 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>>;
 /**
  * Helper type for converting fetch options into an Osdk object
  */
-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, {
+type SingleOsdkResult<Q extends ObjectOrInterfaceDefinition, L extends PropertyKeys<Q> | (keyof RDPs & string), 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];
 }>;
 
+type ObjectSpecifier<Q extends ObjectOrInterfaceDefinition> = string & {
+    __apiName: Q["apiName"] | (Q extends InterfaceDefinition ? NonNullable<Q["__DefinitionMetadata"]> extends InterfaceMetadata ? NonNullable<NonNullable<Q["__DefinitionMetadata"]>["implementedBy"]>[number] : never : never);
+};
+
 type OsdkObjectPrimaryKeyType<Q extends ObjectTypeDefinition> = PropertyValueWireToClient[CompileTimeMetadata<Q>["primaryKeyType"]];
 
 type OsdkBase<Q extends ObjectOrInterfaceDefinition> = {
@@ -600,6 +611,7 @@ type OsdkBase<Q extends ObjectOrInterfaceDefinition> = {
     readonly $objectType: string;
     readonly $primaryKey: PrimaryKeyType<Q>;
     readonly $title: string | undefined;
+    readonly $objectSpecifier: ObjectSpecifier<Q>;
 };
 type PrimaryKeyType<Q extends ObjectOrInterfaceDefinition> = (Q extends ObjectTypeDefinition ? OsdkObjectPrimaryKeyType<Q> : unknown) & PropertyValueWireToClient[PrimaryKeyTypes];
 
@@ -608,7 +620,7 @@ type ValidOsdkPropParams<Q extends ObjectOrInterfaceDefinition> = SpecialOsdkPro
 type ApiNameAsString<T extends ObjectOrInterfaceDefinition> = CompileTimeMetadata<T>["apiName"];
 type JustProps<T extends ObjectOrInterfaceDefinition, P extends ValidOsdkPropParams<T>> = P extends "$all" ? PropertyKeys<T> : Exclude<P, SpecialOsdkPropParams>;
 type PropMapToObject<FROM extends ObjectOrInterfaceDefinition, TO extends ObjectTypeDefinition> = NonNullable<CompileTimeMetadata<TO>["interfaceMap"]>[ApiNameAsString<FROM>];
-type MapPropNamesToObjectType<FROM extends ObjectOrInterfaceDefinition, TO extends ObjectTypeDefinition, P extends ValidOsdkPropParams<FROM>> = PropMapToObject<FROM, TO>[JustProps<FROM, P> & keyof PropMapToObject<FROM, TO>];
+type MapPropNamesToObjectType<FROM extends ObjectOrInterfaceDefinition, TO extends ObjectTypeDefinition, 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 PropMapToInterface<FROM extends ObjectTypeDefinition, TO extends InterfaceDefinition> = NonNullable<CompileTimeMetadata<FROM>["inverseInterfaceMap"]>[ApiNameAsString<TO>];
 type MapPropNamesToInterface<FROM extends ObjectTypeDefinition, TO extends InterfaceDefinition, P extends ValidOsdkPropParams<FROM>> = PropMapToInterface<FROM, TO>[JustProps<FROM, P> & keyof PropMapToInterface<FROM, TO>];
 /**
@@ -616,7 +628,7 @@ type MapPropNamesToInterface<FROM extends ObjectTypeDefinition, TO extends Inter
  * @param TO - the interface or object type to convert to
  * @param P - the property(s) to convert
  */
-type ConvertProps<FROM extends ObjectOrInterfaceDefinition, TO extends ValidToFrom<FROM>, P extends ValidOsdkPropParams<FROM>> = TO extends FROM ? P : TO extends ObjectTypeDefinition ? (UnionIfTrue<MapPropNamesToObjectType<FROM, TO, P>, P extends "$rid" ? true : false, "$rid">) : TO extends InterfaceDefinition ? FROM extends ObjectTypeDefinition ? (UnionIfTrue<MapPropNamesToInterface<FROM, TO, P>, P extends "$rid" ? true : false, "$rid">) : never : never;
+type ConvertProps<FROM extends ObjectOrInterfaceDefinition, TO extends ValidToFrom<FROM>, P extends ValidOsdkPropParams<FROM>, OPTIONS extends never | "$rid" | "$allBaseProperties" = never> = TO extends FROM ? P : TO extends ObjectTypeDefinition ? (UnionIfTrue<MapPropNamesToObjectType<FROM, TO, P, OPTIONS>, P extends "$rid" ? true : false, "$rid">) : TO extends InterfaceDefinition ? FROM extends ObjectTypeDefinition ? (UnionIfTrue<MapPropNamesToInterface<FROM, TO, P>, P extends "$rid" ? true : false, "$rid">) : never : never;
 /** DO NOT EXPORT FROM PACKAGE */
 type ValidToFrom<FROM extends ObjectOrInterfaceDefinition> = FROM extends InterfaceDefinition ? ObjectOrInterfaceDefinition : InterfaceDefinition;
 type IsNever<T> = [T] extends [never] ? true : false;
@@ -628,13 +640,13 @@ type GetPropsKeys<Q extends ObjectOrInterfaceDefinition, P extends PropertyKeys<
  */
 type Osdk<Q extends ObjectOrInterfaceDefinition, 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>>;
 declare namespace Osdk {
-    type Instance<Q extends ObjectOrInterfaceDefinition, OPTIONS extends never | "$rid" = never, P extends PropertyKeys<Q> = PropertyKeys<Q>, R extends Record<string, SimplePropertyDef> = {}> = OsdkBase<Q> & Pick<CompileTimeMetadata<Q>["props"], GetPropsKeys<Q, P, [R] extends [{}] ? false : true>> & ([R] extends [never] ? {} : {
+    type Instance<Q extends ObjectOrInterfaceDefinition, OPTIONS extends never | "$rid" | "$allBaseProperties" = never, P extends PropertyKeys<Q> = PropertyKeys<Q>, R extends Record<string, SimplePropertyDef> = {}> = OsdkBase<Q> & Pick<CompileTimeMetadata<Q>["props"], GetPropsKeys<Q, P, [R] extends [{}] ? false : true>> & ([R] extends [never] ? {} : {
         [A in keyof R]: SimplePropertyDef.ToRuntimeProperty<R[A]>;
     }) & {
         readonly $link: Q extends {
             linksType?: any;
         } ? Q["linksType"] : Q extends ObjectTypeDefinition ? OsdkObjectLinksObject<Q> : never;
-        readonly $as: <NEW_Q extends ValidToFrom<Q>>(type: NEW_Q | string) => Osdk.Instance<NEW_Q, OPTIONS, ConvertProps<Q, NEW_Q, P>>;
+        readonly $as: <NEW_Q extends ValidToFrom<Q>>(type: NEW_Q | string) => Osdk.Instance<NEW_Q, OPTIONS, ConvertProps<Q, NEW_Q, P, OPTIONS>>;
         readonly $clone: <NEW_PROPS extends PropertyKeys<Q>>(updatedObject?: Osdk.Instance<Q, any, NEW_PROPS> | {
             [K in NEW_PROPS]?: CompileTimeMetadata<Q>["props"][K];
         }) => Osdk.Instance<Q, OPTIONS, P | NEW_PROPS>;
@@ -648,7 +660,8 @@ declare namespace Osdk {
  * Anything you throw at this that is not exactly `true` should always be `never`.
  */
 type ExtractRidOption<R extends boolean> = IsNever<R> extends true ? never : DefaultToFalse<R> extends false ? never : "$rid";
-type ExtractOptions<R extends boolean, S extends NullabilityAdherence = NullabilityAdherence.Default> = ExtractRidOption<R>;
+type ExtractAllPropertiesOption<T extends boolean> = IsNever<T> extends true ? never : DefaultToFalse<T> extends false ? never : "$allBaseProperties";
+type ExtractOptions<R extends boolean, S extends NullabilityAdherence = NullabilityAdherence.Default, T extends boolean = false> = ExtractRidOption<R> | ExtractAllPropertiesOption<T>;
 
 type Just<Z extends keyof V, V> = {
     [k in Z]: V[k];
@@ -897,6 +910,39 @@ type WhereClause<T extends ObjectOrInterfaceDefinition> = OrWhereClause<T> | And
 type LinkNames<Q extends ObjectOrInterfaceDefinition> = keyof CompileTimeMetadata<Q>["links"] & string;
 type LinkedType<Q extends ObjectOrInterfaceDefinition, L extends LinkNames<Q>> = NonNullable<CompileTimeMetadata<Q>["links"][L]["__OsdkLinkTargetType"]>;
 
+declare namespace DerivedProperty {
+    type SelectorResult<T extends SimplePropertyDef> = {
+        type: T;
+    };
+    type Clause<Q extends ObjectOrInterfaceDefinition> = {
+        [key: string]: Selector<Q, SimplePropertyDef>;
+    };
+    type Selector<Q extends ObjectOrInterfaceDefinition, T extends SimplePropertyDef> = (baseObjectSet: DerivedProperty.Builder<Q, false>) => SelectorResult<T>;
+    interface Builder<Q extends ObjectOrInterfaceDefinition, CONSTRAINED extends boolean> extends Filterable<Q, CONSTRAINED>, Pivotable<Q, CONSTRAINED> {
+    }
+    interface AggregateBuilder<Q extends ObjectOrInterfaceDefinition, CONSTRAINED extends boolean> extends Builder<Q, CONSTRAINED>, Aggregatable<Q> {
+    }
+    interface SelectPropertyBuilder<Q extends ObjectOrInterfaceDefinition, CONSTRAINED extends boolean> extends AggregateBuilder<Q, CONSTRAINED>, Selectable<Q> {
+    }
+}
+type BuilderTypeFromConstraint<Q extends ObjectOrInterfaceDefinition, CONSTRAINED extends boolean> = CONSTRAINED extends true ? DerivedProperty.AggregateBuilder<Q, true> : DerivedProperty.SelectPropertyBuilder<Q, false>;
+type Filterable<Q extends ObjectOrInterfaceDefinition, CONSTRAINED extends boolean> = {
+    readonly where: (clause: WhereClause<Q>) => BuilderTypeFromConstraint<Q, CONSTRAINED>;
+};
+type Pivotable<Q extends ObjectOrInterfaceDefinition, CONSTRAINED extends boolean> = {
+    readonly pivotTo: <L extends LinkNames<Q>>(type: L) => CONSTRAINED extends true ? DerivedProperty.AggregateBuilder<LinkedType<Q, L>, true> : NonNullable<CompileTimeMetadata<Q>["links"][L]["multiplicity"]> extends true ? DerivedProperty.AggregateBuilder<LinkedType<Q, L>, true> : DerivedProperty.SelectPropertyBuilder<LinkedType<Q, L>, false>;
+};
+type Aggregatable<Q extends ObjectOrInterfaceDefinition> = {
+    readonly aggregate: <V extends ValidAggregationKeys<Q, "withPropertiesAggregate">>(aggregationSpecifier: V, opts?: V extends `${any}:${infer P}` ? P extends CollectWithPropAggregations ? {
+        limit: number;
+    } : P extends "approximatePercentile" ? {
+        percentile: number;
+    } : never : never) => DerivedProperty.SelectorResult<V extends `${infer N}:${infer P}` ? P extends CollectWithPropAggregations ? Array<CompileTimeMetadata<Q>["properties"][N]["type"]> | undefined : P extends "approximateDistinct" | "exactDistinct" | "$count" ? "integer" : "double" | undefined : V extends "$count" ? "integer" : never>;
+};
+type Selectable<Q extends ObjectOrInterfaceDefinition> = {
+    readonly selectProperty: <R extends PropertyKeys<Q>>(propertyName: R) => DerivedProperty.SelectorResult<SimplePropertyDef.Make<CompileTimeMetadata<Q>["properties"][R]["type"], CompileTimeMetadata<Q>["properties"][R]["nullable"], CompileTimeMetadata<Q>["properties"][R]["multiplicity"]>>;
+};
+
 interface BaseObjectSet<Q extends ObjectOrInterfaceDefinition> {
     readonly $objectSetInternals: {
         def: Q;
@@ -958,7 +1004,7 @@ interface FetchPage<Q extends ObjectOrInterfaceDefinition, RDPs extends Record<s
   
      * @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, {
+    readonly fetchPage: <L extends PropertyKeys<Q, RDPs>, 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>, PropertyKeys<Q> extends L ? PropertyKeys<Q> : PropertyKeys<Q> & L, {
         [K in Extract<keyof RDPs, L>]: RDPs[K];
     }>>>;
     /**
@@ -975,7 +1021,7 @@ interface FetchPage<Q extends ObjectOrInterfaceDefinition, RDPs extends Record<s
       }
      * @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, {
+    readonly fetchPageWithErrors: <L extends PropertyKeys<Q, RDPs>, 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>, PropertyKeys<Q> extends L ? PropertyKeys<Q> : PropertyKeys<Q> & L, {
         [K in Extract<keyof RDPs, L>]: RDPs[K];
     }>>>>;
 }
@@ -1001,10 +1047,17 @@ interface AsyncIter<Q extends ObjectOrInterfaceDefinition, RDPs extends Record<s
      * }
      * @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, {
+    readonly asyncIter: <L extends PropertyKeys<Q, RDPs>, 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>, 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;
+    }>;
+}
 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> {
@@ -1098,7 +1151,11 @@ interface Subscribe<Q extends ObjectOrInterfaceDefinition> {
         unsubscribe: () => void;
     };
 }
-interface ObjectSetCleanedTypes<Q extends ObjectOrInterfaceDefinition, D extends Record<string, SimplePropertyDef>, MERGED extends ObjectOrInterfaceDefinition> extends MinimalObjectSet<Q, D>, Aggregate<MERGED>, SetArithmetic<MERGED>, PivotTo<MERGED>, FetchOne<Q, D>, Subscribe<MERGED> {
+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 { type VersionBound as $, type Attachment as A, type FetchPageResult as B, type SingleOsdkResult as C, DistanceUnitMapping as D, type Media as E, type FetchPageArgs as F, type GeoFilterOptions as G, type MediaMetadata as H, type InterfaceDefinition as I, isOk as J, type Result as K, type BaseObjectSet as L, type MediaReference as M, NullabilityAdherence as N, type ObjectTypeDefinition as O, type PropertyValueWireToClient as P, ObjectSetSubscription as Q, type ReleaseStatus as R, type SingleLinkAccessor as S, type InterfaceMetadata as T, type ObjectOrInterfaceDefinition as U, type ValidAggregationKeys as V, type WhereClause as W, type PropertyKeys as X, type CompileTimeMetadata as Y, ObjectMetadata as Z, type PropertyDef as _, type AttachmentUpload as a, type BaseWirePropertyTypes as a0, type WirePropertyTypes as a1, type PrimaryKeyType as a2, type ConvertProps as a3, Osdk as a4, type PageResult as a5, TimeseriesDurationMapping as a6, type GeotimeSeriesProperty as a7, type TimeSeriesPoint as a8, type TimeSeriesProperty as a9, type TimeSeriesQuery as aa, type LinkedType as ab, type LinkNames as ac, type ExtractOptions as ad, type MinimalObjectSet as ae, type OsdkBase as b, type OsdkObjectPrimaryKeyType as c, type ObjectSet as d, type OsdkMetadata as e, type PrimaryKeyTypes as f, type AggregateOpts as g, type AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy as h, type AggregationResultsWithGroups as i, type AggregationResultsWithoutGroups as j, type AggregationClause as k, type AggregationsResults as l, type GeoFilter_Intersects as m, type GeoFilter_Within as n, type PossibleWhereClauseFilters as o, type OsdkObjectPropertyType as p, type OsdkObjectLinksObject as q, DurationMapping as r, type AllGroupByValues as s, type GroupByClause as t, type GroupByRange as u, type AsyncIterArgs as v, type Augment as w, type Augments as x, type SelectArg as y, type SelectArgToKeys as z };
+type FilteredPropertyKeys<O extends ObjectOrInterfaceDefinition, T extends WirePropertyTypes> = {
+    [K in keyof NonNullable<O["__DefinitionMetadata"]>["properties"]]: NonNullable<O["__DefinitionMetadata"]>["properties"][K]["type"] extends T ? K : never;
+}[keyof NonNullable<O["__DefinitionMetadata"]>["properties"]];
+
+export { type CompileTimeMetadata as $, type Attachment as A, type SelectArgToKeys as B, type FetchPageResult as C, DistanceUnitMapping as D, type SingleOsdkResult as E, type FetchPageArgs as F, type GeoFilterOptions as G, type Media as H, type InterfaceDefinition as I, type MediaMetadata as J, isOk as K, type Result as L, type MediaReference as M, NullabilityAdherence as N, type ObjectTypeDefinition as O, type PropertyValueWireToClient as P, type BaseObjectSet as Q, type ReleaseStatus as R, type SingleLinkAccessor as S, ObjectSetSubscription as T, type FilteredPropertyKeys as U, type ValidAggregationKeys as V, type WhereClause as W, type InterfaceMetadata as X, type ObjectOrInterfaceDefinition as Y, type PropertyKeys as Z, type ObjectSpecifier as _, type AttachmentUpload as a, ObjectMetadata as a0, type PropertyDef as a1, type VersionBound as a2, type BaseWirePropertyTypes as a3, type WirePropertyTypes as a4, type PrimaryKeyType as a5, type ConvertProps as a6, Osdk as a7, type PageResult as a8, TimeseriesDurationMapping as a9, type GeotimeSeriesProperty as aa, type TimeSeriesPoint as ab, type TimeSeriesProperty as ac, type TimeSeriesQuery as ad, type LinkedType as ae, type LinkNames as af, type ExtractOptions as ag, type MinimalObjectSet as ah, type OsdkBase as b, type OsdkObjectPrimaryKeyType as c, type ObjectSet as d, type OsdkMetadata as e, type PrimaryKeyTypes as f, type AggregateOpts as g, type AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy as h, type AggregationResultsWithGroups as i, type AggregationResultsWithoutGroups as j, type AggregationClause as k, type AggregationsResults as l, type GeoFilter_Intersects as m, type GeoFilter_Within as n, type PossibleWhereClauseFilters as o, type OsdkObjectPropertyType as p, type OsdkObjectLinksObject as q, DerivedProperty as r, DurationMapping as s, type AllGroupByValues as t, type GroupByClause as u, type GroupByRange as v, type AsyncIterArgs as w, type Augment as x, type Augments as y, type SelectArg as z };

package/build/cjs/index.d.cts

@@ -1,5 +1,5 @@
-import { A as Attachment, M as MediaReference, a as AttachmentUpload, O as ObjectTypeDefinition, b as OsdkBase, c as OsdkObjectPrimaryKeyType, d as ObjectSet, I as InterfaceDefinition, R as ReleaseStatus, e as OsdkMetadata, P as PropertyValueWireToClient, f as PrimaryKeyTypes } from './ObjectSet-DgxzOo6y.cjs';
-export { g as AggregateOpts, h as AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy, k as AggregationClause, i as AggregationResultsWithGroups, j as AggregationResultsWithoutGroups, l as AggregationsResults, s as AllGroupByValues, v as AsyncIterArgs, w as Augment, x as Augments, L as BaseObjectSet, a0 as BaseWirePropertyTypes, Y as CompileTimeMetadata, a3 as ConvertProps, D as DistanceUnitMapping, r as DurationMapping, F as FetchPageArgs, B as FetchPageResult, G as GeoFilterOptions, m as GeoFilter_Intersects, n as GeoFilter_Within, a7 as GeotimeSeriesProperty, t as GroupByClause, u as GroupByRange, T as InterfaceMetadata, ac as LinkNames, ab as LinkedType, E as Media, H as MediaMetadata, N as NullabilityAdherence, Z as ObjectMetadata, U as ObjectOrInterfaceDefinition, Q as ObjectSetSubscription, a4 as Osdk, q as OsdkObjectLinksObject, p as OsdkObjectPropertyType, a5 as PageResult, o as PossibleWhereClauseFilters, a2 as PrimaryKeyType, _ as PropertyDef, X as PropertyKeys, K as Result, y as SelectArg, z as SelectArgToKeys, S as SingleLinkAccessor, C as SingleOsdkResult, a8 as TimeSeriesPoint, a9 as TimeSeriesProperty, aa as TimeSeriesQuery, a6 as TimeseriesDurationMapping, V as ValidAggregationKeys, $ as VersionBound, W as WhereClause, a1 as WirePropertyTypes, J as isOk } from './ObjectSet-DgxzOo6y.cjs';
+import { A as Attachment, M as MediaReference, a as AttachmentUpload, O as ObjectTypeDefinition, b as OsdkBase, c as OsdkObjectPrimaryKeyType, d as ObjectSet, I as InterfaceDefinition, R as ReleaseStatus, e as OsdkMetadata, P as PropertyValueWireToClient, f as PrimaryKeyTypes } from './FilteredPropertyKeys-Byq3on7Q.cjs';
+export { g as AggregateOpts, h as AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy, k as AggregationClause, i as AggregationResultsWithGroups, j as AggregationResultsWithoutGroups, l as AggregationsResults, t as AllGroupByValues, w as AsyncIterArgs, x as Augment, y as Augments, Q as BaseObjectSet, a3 as BaseWirePropertyTypes, $ as CompileTimeMetadata, a6 as ConvertProps, r as DerivedProperty, D as DistanceUnitMapping, s as DurationMapping, F as FetchPageArgs, C as FetchPageResult, U as FilteredPropertyKeys, G as GeoFilterOptions, m as GeoFilter_Intersects, n as GeoFilter_Within, aa as GeotimeSeriesProperty, u as GroupByClause, v as GroupByRange, X as InterfaceMetadata, af as LinkNames, ae as LinkedType, H as Media, J as MediaMetadata, N as NullabilityAdherence, a0 as ObjectMetadata, Y as ObjectOrInterfaceDefinition, T as ObjectSetSubscription, _ as ObjectSpecifier, a7 as Osdk, q as OsdkObjectLinksObject, p as OsdkObjectPropertyType, a8 as PageResult, o as PossibleWhereClauseFilters, a5 as PrimaryKeyType, a1 as PropertyDef, Z as PropertyKeys, L as Result, z as SelectArg, B as SelectArgToKeys, S as SingleLinkAccessor, E as SingleOsdkResult, ab as TimeSeriesPoint, ac as TimeSeriesProperty, ad as TimeSeriesQuery, a9 as TimeseriesDurationMapping, V as ValidAggregationKeys, a2 as VersionBound, W as WhereClause, a4 as WirePropertyTypes, K as isOk } from './FilteredPropertyKeys-Byq3on7Q.cjs';
 import 'type-fest';
 import 'geojson';
 
@@ -88,7 +88,9 @@ interface ObjectEdits {
     type: "edits";
     addedObjects: Array<ObjectReference>;
     modifiedObjects: Array<ObjectReference>;
+    deletedObjects?: Array<ObjectReference>;
     addedLinks: Array<LinkReference>;
+    deletedLinks?: Array<LinkReference>;
     deletedObjectsCount: number;
     deletedLinksCount: number;
 }
@@ -96,7 +98,9 @@ interface LargeScaleObjectEdits {
     type: "largeScaleEdits";
     addedObjects?: never;
     modifiedObjects?: never;
+    deletedObjects?: never;
     addedLinks?: never;
+    deletedLinks?: never;
     deletedObjectsCount?: never;
     deletedLinksCount?: never;
 }
@@ -193,7 +197,7 @@ declare namespace ActionParam {
     type InterfaceType<T extends InterfaceDefinition> = {
         $objectType: NonNullable<T["__DefinitionMetadata"]> extends {
             implementedBy: infer U;
-        } ? (U extends ReadonlyArray<string> ? U[number] : string) : string;
+        } ? (U extends ReadonlyArray<never> ? string : U extends ReadonlyArray<string> ? U[number] : string) : string;
         $primaryKey: string | number;
     };
     type StructType<T extends Record<string, keyof DataValueClientToWire>> = {
@@ -291,7 +295,7 @@ interface QueryDefinition<T = any> {
 type QueryParameterDefinition<T_Target extends ObjectTypeDefinition = any> = {
     description?: string;
 } & QueryDataTypeDefinition<T_Target>;
-type QueryDataTypeDefinition<T_Target extends ObjectTypeDefinition = any> = PrimitiveDataType | ObjectQueryDataType<T_Target> | ObjectSetQueryDataType<T_Target> | SetQueryDataType | UnionQueryDataType | StructQueryDataType | TwoDimensionalAggregationDataType | ThreeDimensionalAggregationDataType;
+type QueryDataTypeDefinition<T_Target extends ObjectTypeDefinition = any> = PrimitiveDataType | ObjectQueryDataType<T_Target> | ObjectSetQueryDataType<T_Target> | SetQueryDataType | UnionQueryDataType | StructQueryDataType | TwoDimensionalAggregationDataType | ThreeDimensionalAggregationDataType | MapDataType;
 type BaseQueryDataTypeDefinition<T extends string> = {
     multiplicity?: boolean;
     nullable?: boolean;
@@ -322,6 +326,10 @@ interface TwoDimensionalAggregationDataType extends BaseQueryDataTypeDefinition<
 interface ThreeDimensionalAggregationDataType extends BaseQueryDataTypeDefinition<"threeDimensionalAggregation"> {
     threeDimensionalAggregation: ThreeDimensionalQueryAggregationDefinition;
 }
+interface MapDataType extends BaseQueryDataTypeDefinition<"map"> {
+    keyType: QueryDataTypeDefinition;
+    valueType: QueryDataTypeDefinition;
+}
 type AggregationKeyDataType<V = any> = SimpleAggregationKeyDataType<V> | RangeAggregationKeyDataType<V>;
 interface SimpleAggregationKeyDataType<V = any> {
     keyType: Exclude<AggregationKeyTypes, "range">;
@@ -413,4 +421,4 @@ declare namespace QueryResult {
     type ThreeDimensionalAggregationType<OUT extends AggregationKeyTypes | RangeKey<any>, IN extends AggregationKeyTypes | RangeKey<any>, V extends AggregationValueTypes> = ThreeDimensionalAggregation<OUT extends AggregationKeyTypes ? AggKeyWireToClient<OUT> : OUT, IN extends AggregationKeyTypes ? AggKeyWireToClient<IN> : IN, AggValueWireToClient<V>>;
 }
 
-export { type ActionDefinition, type ActionEditResponse, ActionMetadata, ActionParam, type ActionReturnTypeForOptions, type ActionValidationResponse, type AllowedBucketKeyTypes$1 as AllowedBucketKeyTypes, type AllowedBucketTypes$1 as AllowedBucketTypes, type ApplyActionOptions, type ApplyBatchActionOptions, Attachment, AttachmentUpload, type DataValueClientToWire, type DataValueWireToClient, InterfaceDefinition, MediaReference, type ObjectQueryDataType, type ObjectSet, type ObjectSetQueryDataType, ObjectTypeDefinition, type OntologyMetadata, OsdkBase, type OsdkObject, PrimaryKeyTypes, PropertyValueWireToClient, type QueryDataTypeDefinition, type QueryDefinition, type QueryMetadata, QueryParam, type QueryParameterDefinition, QueryResult, type ThreeDimensionalQueryAggregationDefinition, type TwoDimensionalQueryAggregationDefinition };
+export { type ActionDefinition, type ActionEditResponse, ActionMetadata, ActionParam, type ActionReturnTypeForOptions, type ActionValidationResponse, type AllowedBucketKeyTypes$1 as AllowedBucketKeyTypes, type AllowedBucketTypes$1 as AllowedBucketTypes, type ApplyActionOptions, type ApplyBatchActionOptions, Attachment, AttachmentUpload, type DataValueClientToWire, type DataValueWireToClient, InterfaceDefinition, MediaReference, type ObjectQueryDataType, type ObjectSet, type ObjectSetQueryDataType, ObjectTypeDefinition, type OntologyMetadata, OsdkBase, type OsdkObject, PrimaryKeyTypes, PropertyValueWireToClient, type QueryDataTypeDefinition, type QueryDefinition, type QueryMetadata, QueryParam, type QueryParameterDefinition, QueryResult, type Range, type ThreeDimensionalAggregation, type ThreeDimensionalQueryAggregationDefinition, type TwoDimensionalAggregation, type TwoDimensionalQueryAggregationDefinition };

package/build/cjs/public/unstable.cjs

@@ -14,6 +14,13 @@ var __EXPERIMENTAL__NOT_SUPPORTED_YET__fetchOneByRid = {
   version: "2.1.0"
 };
 
+// src/experimental/fetchPageByRid.ts
+var __EXPERIMENTAL__NOT_SUPPORTED_YET__fetchPageByRid = {
+  name: "__EXPERIMENTAL__NOT_SUPPORTED_YET__fetchPageByRid",
+  type: "experiment",
+  version: "2.2.0"
+};
+
 // src/experimental/getBulkLinks.ts
 var __EXPERIMENTAL__NOT_SUPPORTED_YET__getBulkLinks = {
   name: "__EXPERIMENTAL__NOT_SUPPORTED_YET__getBulkLinks",
@@ -23,6 +30,7 @@ var __EXPERIMENTAL__NOT_SUPPORTED_YET__getBulkLinks = {
 
 exports.__EXPERIMENTAL__NOT_SUPPORTED_YET__createMediaReference = __EXPERIMENTAL__NOT_SUPPORTED_YET__createMediaReference;
 exports.__EXPERIMENTAL__NOT_SUPPORTED_YET__fetchOneByRid = __EXPERIMENTAL__NOT_SUPPORTED_YET__fetchOneByRid;
+exports.__EXPERIMENTAL__NOT_SUPPORTED_YET__fetchPageByRid = __EXPERIMENTAL__NOT_SUPPORTED_YET__fetchPageByRid;
 exports.__EXPERIMENTAL__NOT_SUPPORTED_YET__getBulkLinks = __EXPERIMENTAL__NOT_SUPPORTED_YET__getBulkLinks;
 //# sourceMappingURL=unstable.cjs.map
 //# sourceMappingURL=unstable.cjs.map

package/build/cjs/public/unstable.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/experimental/createMediaReference.ts","../../../src/experimental/fetchOneByRid.ts","../../../src/experimental/getBulkLinks.ts"],"names":[],"mappings":";;;AA6BO,IAAM,uDAA0D,GAAA;AAAA,EACrE,IAAM,EAAA,yDAAA;AAAA,EACN,IAAM,EAAA,YAAA;AAAA,EACN,OAAS,EAAA;AACX;;;ACjBO,IAAM,gDAAmD,GAAA;AAAA,EAC9D,IAAM,EAAA,kDAAA;AAAA,EACN,IAAM,EAAA,YAAA;AAAA,EACN,OAAS,EAAA;AACX;;;ACJO,IAAM,+CAAkD,GAAA;AAAA,EAC7D,IAAM,EAAA,iDAAA;AAAA,EACN,IAAM,EAAA,YAAA;AAAA,EACN,OAAS,EAAA;AACX","file":"unstable.cjs","sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/**\n * @experimental This feature is experimental and might change in the future.\n *\n * Uploads a media item to the media property of the specified object type.\n *\n * @param data - Data to upload as media item\n * @param fileName - Name that will be assigned as path to the uploaded media item.\n * @param objectTypeApi - Api name of the object type to which the media item will be uploaded.\n * @param propertyTypeApi - Api name of the media reference property of the corresponding object type to which the media item will be uploaded.\n *\n * @returns media reference of the uploaded media item.\n */\n\nexport const __EXPERIMENTAL__NOT_SUPPORTED_YET__createMediaReference = {\n  name: \"__EXPERIMENTAL__NOT_SUPPORTED_YET__createMediaReference\",\n  type: \"experiment\",\n  version: \"2.1.0\"\n};","/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nexport const __EXPERIMENTAL__NOT_SUPPORTED_YET__fetchOneByRid = {\n  name: \"__EXPERIMENTAL__NOT_SUPPORTED_YET__fetchOneByRid\",\n  type: \"experiment\",\n  version: \"2.1.0\"\n};","/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nexport const __EXPERIMENTAL__NOT_SUPPORTED_YET__getBulkLinks = {\n  name: \"__EXPERIMENTAL__NOT_SUPPORTED_YET__getBulkLinks\",\n  type: \"experiment\",\n  version: \"2.0.8\"\n};"]}
+{"version":3,"sources":["../../../src/experimental/createMediaReference.ts","../../../src/experimental/fetchOneByRid.ts","../../../src/experimental/fetchPageByRid.ts","../../../src/experimental/getBulkLinks.ts"],"names":[],"mappings":";;;AA6BO,IAAM,uDAA0D,GAAA;AAAA,EACrE,IAAM,EAAA,yDAAA;AAAA,EACN,IAAM,EAAA,YAAA;AAAA,EACN,OAAS,EAAA;AACX;;;ACjBO,IAAM,gDAAmD,GAAA;AAAA,EAC9D,IAAM,EAAA,kDAAA;AAAA,EACN,IAAM,EAAA,YAAA;AAAA,EACN,OAAS,EAAA;AACX;;;ACJO,IAAM,iDAAoD,GAAA;AAAA,EAC/D,IAAM,EAAA,mDAAA;AAAA,EACN,IAAM,EAAA,YAAA;AAAA,EACN,OAAS,EAAA;AACX;;;ACJO,IAAM,+CAAkD,GAAA;AAAA,EAC7D,IAAM,EAAA,iDAAA;AAAA,EACN,IAAM,EAAA,YAAA;AAAA,EACN,OAAS,EAAA;AACX","file":"unstable.cjs","sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/**\n * @experimental This feature is experimental and might change in the future.\n *\n * Uploads a media item to the media property of the specified object type.\n *\n * @param data - Data to upload as media item\n * @param fileName - Name that will be assigned as path to the uploaded media item.\n * @param objectType - Object type to which the media item will be uploaded.\n * @param propertyType - Media reference property of the corresponding object type to which the media item will be uploaded.\n *\n * @returns media reference of the uploaded media item.\n */\n\nexport const __EXPERIMENTAL__NOT_SUPPORTED_YET__createMediaReference = {\n  name: \"__EXPERIMENTAL__NOT_SUPPORTED_YET__createMediaReference\",\n  type: \"experiment\",\n  version: \"2.1.0\"\n};","/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nexport const __EXPERIMENTAL__NOT_SUPPORTED_YET__fetchOneByRid = {\n  name: \"__EXPERIMENTAL__NOT_SUPPORTED_YET__fetchOneByRid\",\n  type: \"experiment\",\n  version: \"2.1.0\"\n};","/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nexport const __EXPERIMENTAL__NOT_SUPPORTED_YET__fetchPageByRid = {\n  name: \"__EXPERIMENTAL__NOT_SUPPORTED_YET__fetchPageByRid\",\n  type: \"experiment\",\n  version: \"2.2.0\"\n};","/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nexport const __EXPERIMENTAL__NOT_SUPPORTED_YET__getBulkLinks = {\n  name: \"__EXPERIMENTAL__NOT_SUPPORTED_YET__getBulkLinks\",\n  type: \"experiment\",\n  version: \"2.0.8\"\n};"]}

package/build/cjs/public/unstable.d.cts

@@ -1,5 +1,5 @@
-import { M as MediaReference, O as ObjectTypeDefinition, X as PropertyKeys, N as NullabilityAdherence, y as SelectArg, a4 as Osdk, ad as ExtractOptions, b as OsdkBase, U as ObjectOrInterfaceDefinition } from '../ObjectSet-DgxzOo6y.cjs';
-export { ae as MinimalObjectSet } from '../ObjectSet-DgxzOo6y.cjs';
+import { Y as ObjectOrInterfaceDefinition, U as FilteredPropertyKeys, M as MediaReference, O as ObjectTypeDefinition, Z as PropertyKeys, N as NullabilityAdherence, z as SelectArg, a7 as Osdk, ag as ExtractOptions, F as FetchPageArgs, C as FetchPageResult, b as OsdkBase } from '../FilteredPropertyKeys-Byq3on7Q.cjs';
+export { ah as MinimalObjectSet } from '../FilteredPropertyKeys-Byq3on7Q.cjs';
 import 'type-fest';
 import 'geojson';
 
@@ -18,16 +18,16 @@ type ExperimentFns<B extends Experiment<string, string>> = NonNullable<B["brande
  *
  * @param data - Data to upload as media item
  * @param fileName - Name that will be assigned as path to the uploaded media item.
- * @param objectTypeApi - Api name of the object type to which the media item will be uploaded.
- * @param propertyTypeApi - Api name of the media reference property of the corresponding object type to which the media item will be uploaded.
+ * @param objectType - Object type to which the media item will be uploaded.
+ * @param propertyType - Media reference property of the corresponding object type to which the media item will be uploaded.
  *
  * @returns media reference of the uploaded media item.
  */
-type createMediaReference = (args: {
+type createMediaReference = <Q extends ObjectOrInterfaceDefinition, const L extends FilteredPropertyKeys<Q, "mediaReference">>(args: {
     data: Blob;
     fileName: string;
-    objectTypeApi: string;
-    propertyTypeApi: string;
+    objectType: Q;
+    propertyType: L;
 }) => Promise<MediaReference>;
 declare const __EXPERIMENTAL__NOT_SUPPORTED_YET__createMediaReference: Experiment<"2.1.0", "__EXPERIMENTAL__NOT_SUPPORTED_YET__createMediaReference", {
     createMediaReference: createMediaReference;
@@ -38,6 +38,11 @@ declare const __EXPERIMENTAL__NOT_SUPPORTED_YET__fetchOneByRid: Experiment<"2.1.
     fetchOneByRid: fetchOneByRidFn;
 }>;
 
+type fetchPageByRidFn = <Q extends ObjectOrInterfaceDefinition, const L extends PropertyKeys<Q>, const R extends boolean, const S extends NullabilityAdherence, const T extends boolean>(objectType: Q, rids: string[], options?: FetchPageArgs<Q, L, R, any, S>) => Promise<FetchPageResult<Q, L, R, S, T>>;
+declare const __EXPERIMENTAL__NOT_SUPPORTED_YET__fetchPageByRid: Experiment<"2.2.0", "__EXPERIMENTAL__NOT_SUPPORTED_YET__fetchPageByRid", {
+    fetchPageByRid: fetchPageByRidFn;
+}>;
+
 interface EXPERIMENTAL_BulkLinkResult {
     object: OsdkBase<any>;
     linkApiName: string;
@@ -50,4 +55,4 @@ declare const __EXPERIMENTAL__NOT_SUPPORTED_YET__getBulkLinks: Experiment<"2.0.8
     getBulkLinks: getBulkLinksFn;
 }>;
 
-export { type EXPERIMENTAL_BulkLinkResult, type Experiment, type ExperimentFns, __EXPERIMENTAL__NOT_SUPPORTED_YET__createMediaReference, __EXPERIMENTAL__NOT_SUPPORTED_YET__fetchOneByRid, __EXPERIMENTAL__NOT_SUPPORTED_YET__getBulkLinks };
+export { type EXPERIMENTAL_BulkLinkResult, type Experiment, type ExperimentFns, __EXPERIMENTAL__NOT_SUPPORTED_YET__createMediaReference, __EXPERIMENTAL__NOT_SUPPORTED_YET__fetchOneByRid, __EXPERIMENTAL__NOT_SUPPORTED_YET__fetchPageByRid, __EXPERIMENTAL__NOT_SUPPORTED_YET__getBulkLinks };

package/build/esm/OsdkBase.js.map

@@ -1 +1 @@
-{"version":3,"file":"OsdkBase.js","names":[],"sources":["OsdkBase.ts"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { PropertyValueWireToClient } from \"./mapping/PropertyValueMapping.js\";\nimport type { ObjectOrInterfaceDefinition } from \"./ontology/ObjectOrInterface.js\";\nimport type { ObjectTypeDefinition } from \"./ontology/ObjectTypeDefinition.js\";\nimport type { PrimaryKeyTypes } from \"./ontology/PrimaryKeyTypes.js\";\nimport type { OsdkObjectPrimaryKeyType } from \"./OsdkObjectPrimaryKeyType.js\";\n\nexport type OsdkBase<\n  Q extends ObjectOrInterfaceDefinition,\n> = {\n  readonly $apiName: Q[\"apiName\"];\n\n  readonly $objectType: string;\n\n  readonly $primaryKey: PrimaryKeyType<Q>;\n\n  readonly $title: string | undefined;\n};\n\nexport type PrimaryKeyType<Q extends ObjectOrInterfaceDefinition> =\n  & (Q extends ObjectTypeDefinition ? OsdkObjectPrimaryKeyType<Q>\n    : unknown)\n  // if the type is `unknown` then the next line will\n  // restrict it down to all valid primary key types\n  & PropertyValueWireToClient[PrimaryKeyTypes];\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"OsdkBase.js","names":[],"sources":["OsdkBase.ts"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { PropertyValueWireToClient } from \"./mapping/PropertyValueMapping.js\";\nimport type { ObjectOrInterfaceDefinition } from \"./ontology/ObjectOrInterface.js\";\nimport type { ObjectSpecifier } from \"./ontology/ObjectSpecifier.js\";\nimport type { ObjectTypeDefinition } from \"./ontology/ObjectTypeDefinition.js\";\nimport type { PrimaryKeyTypes } from \"./ontology/PrimaryKeyTypes.js\";\nimport type { OsdkObjectPrimaryKeyType } from \"./OsdkObjectPrimaryKeyType.js\";\n\nexport type OsdkBase<\n  Q extends ObjectOrInterfaceDefinition,\n> = {\n  readonly $apiName: Q[\"apiName\"];\n\n  readonly $objectType: string;\n\n  readonly $primaryKey: PrimaryKeyType<Q>;\n\n  readonly $title: string | undefined;\n\n  readonly $objectSpecifier: ObjectSpecifier<Q>;\n};\n\nexport type PrimaryKeyType<Q extends ObjectOrInterfaceDefinition> =\n  & (Q extends ObjectTypeDefinition ? OsdkObjectPrimaryKeyType<Q>\n    : unknown)\n  // if the type is `unknown` then the next line will\n  // restrict it down to all valid primary key types\n  & PropertyValueWireToClient[PrimaryKeyTypes];\n"],"mappings":"","ignoreList":[]}

package/build/esm/OsdkObjectFrom.js.map

@@ -1 +1 @@
-{"version":3,"file":"OsdkObjectFrom.js","names":["Osdk"],"sources":["OsdkObjectFrom.ts"],"sourcesContent":["/*\n * Copyright 2023 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n  DefaultToFalse,\n  OsdkObjectLinksObject,\n} from \"./definitions/LinkDefinitions.js\";\nimport type { NullabilityAdherence } from \"./object/FetchPageArgs.js\";\nimport type { UnionIfTrue } from \"./object/FetchPageResult.js\";\nimport type { InterfaceDefinition } from \"./ontology/InterfaceDefinition.js\";\nimport type {\n  ObjectOrInterfaceDefinition,\n  PropertyKeys,\n} from \"./ontology/ObjectOrInterface.js\";\nimport type {\n  CompileTimeMetadata,\n  ObjectTypeDefinition,\n} from \"./ontology/ObjectTypeDefinition.js\";\nimport type { SimplePropertyDef } from \"./ontology/SimplePropertyDef.js\";\nimport type { OsdkBase } from \"./OsdkBase.js\";\n\ntype DropDollarOptions<T extends string> = Exclude<\n  T,\n  \"$rid\" | \"$all\" | \"$notStrict\"\n>;\n\ntype DropDollarAll<T extends string> = Exclude<\n  T,\n  \"$all\"\n>;\n\ntype SpecialOsdkPropParams =\n  | \"$all\"\n  | \"$rid\"\n  | \"$strict\"\n  | \"$notStrict\";\n\ntype ValidOsdkPropParams<Q extends ObjectOrInterfaceDefinition> =\n  | SpecialOsdkPropParams\n  | PropertyKeys<Q>;\n\nexport type ApiNameAsString<\n  T extends ObjectOrInterfaceDefinition,\n> = CompileTimeMetadata<T>[\"apiName\"];\n\nexport type JustProps<\n  T extends ObjectOrInterfaceDefinition,\n  P extends ValidOsdkPropParams<T>,\n> = P extends \"$all\" ? PropertyKeys<T>\n  : Exclude<P, SpecialOsdkPropParams>;\n\nexport type PropMapToObject<\n  FROM extends ObjectOrInterfaceDefinition,\n  TO extends ObjectTypeDefinition,\n> = NonNullable<CompileTimeMetadata<TO>[\"interfaceMap\"]>[ApiNameAsString<FROM>];\n\nexport type MapPropNamesToObjectType<\n  FROM extends ObjectOrInterfaceDefinition,\n  TO extends ObjectTypeDefinition,\n  P extends ValidOsdkPropParams<FROM>,\n> = PropMapToObject<\n  FROM,\n  TO\n>[JustProps<FROM, P> & keyof PropMapToObject<FROM, TO>];\n\nexport type PropMapToInterface<\n  FROM extends ObjectTypeDefinition,\n  TO extends InterfaceDefinition,\n> = NonNullable<\n  CompileTimeMetadata<FROM>[\"inverseInterfaceMap\"]\n>[ApiNameAsString<TO>];\n\nexport type MapPropNamesToInterface<\n  FROM extends ObjectTypeDefinition,\n  TO extends InterfaceDefinition,\n  P extends ValidOsdkPropParams<FROM>,\n> = PropMapToInterface<\n  FROM,\n  TO\n>[JustProps<FROM, P> & keyof PropMapToInterface<FROM, TO>];\n/**\n * @param FROM - the interface or object type to convert from\n * @param TO - the interface or object type to convert to\n * @param P - the property(s) to convert\n */\nexport type ConvertProps<\n  FROM extends ObjectOrInterfaceDefinition,\n  TO extends ValidToFrom<FROM>,\n  P extends ValidOsdkPropParams<FROM>,\n> = TO extends FROM ? P\n  : TO extends ObjectTypeDefinition ? (\n      UnionIfTrue<\n        MapPropNamesToObjectType<FROM, TO, P>,\n        P extends \"$rid\" ? true : false,\n        \"$rid\"\n      >\n    )\n  : TO extends InterfaceDefinition ? FROM extends ObjectTypeDefinition ? (\n        UnionIfTrue<\n          MapPropNamesToInterface<FROM, TO, P>,\n          P extends \"$rid\" ? true : false,\n          \"$rid\"\n        >\n      )\n    : never\n  : never;\n\n/** DO NOT EXPORT FROM PACKAGE */\nexport type ValidToFrom<\n  FROM extends ObjectOrInterfaceDefinition,\n> = FROM extends InterfaceDefinition ? ObjectOrInterfaceDefinition\n  : InterfaceDefinition;\n\n/**\n * @param P The properties to add from Q\n * @param Z The existing underlying properties\n */\ntype UnderlyingProps<\n  Q extends ObjectOrInterfaceDefinition,\n  P extends string,\n  Z extends string,\n  NEW_Q extends ValidToFrom<Q>,\n> =\n  & Z\n  & Q extends InterfaceDefinition\n  ? NEW_Q extends ObjectTypeDefinition ? ConvertProps<Q, NEW_Q, P>\n  : Z\n  : Z;\n\nexport type IsNever<T> = [T] extends [never] ? true : false;\n\ntype ExtractPropsKeysFromOldPropsStyle<\n  Q extends ObjectOrInterfaceDefinition,\n  P extends ValidOsdkPropParams<Q>,\n> = P extends \"$all\" ? PropertyKeys<Q>\n  : Exclude<P, \"$strict\" | \"$notStrict\" | \"$rid\">;\n\nexport type IsAny<T> = unknown extends T\n  ? [keyof T] extends [never] ? false : true\n  : false;\n\nexport type GetPropsKeys<\n  Q extends ObjectOrInterfaceDefinition,\n  P extends PropertyKeys<Q>,\n  N extends boolean = false,\n> = IsNever<P> extends true ? N extends true ? never : PropertyKeys<Q>\n  : IsAny<P> extends true ? PropertyKeys<Q>\n  : P;\n\n/**\n * Use `Osdk.Instance` or `YourType.OsdkInstance`\n */\nexport type Osdk<\n  Q extends ObjectOrInterfaceDefinition,\n  OPTIONS extends string = never,\n  P extends PropertyKeys<Q> = PropertyKeys<Q>,\n> =\n  // no middle options is simplest\n  IsNever<OPTIONS> extends true ? Osdk.Instance<Q, never, P>\n    : IsAny<OPTIONS> extends true ? Osdk.Instance<Q, never, P>\n    // Options only includes the two allowed in the new style\n    : (IsNever<Exclude<OPTIONS, \"$rid\">>) extends true\n      ? Osdk.Instance<Q, OPTIONS & \"$rid\", P>\n    // else we are in the old style which was just Q and OPTIONS\n    // and OPTIONS was $things + prop names\n    : Osdk.Instance<\n      Q,\n      (\"$rid\" extends OPTIONS ? \"$rid\" : never),\n      ExtractPropsKeysFromOldPropsStyle<Q, OPTIONS>\n    >;\n\nexport namespace Osdk {\n  export type Instance<\n    Q extends ObjectOrInterfaceDefinition,\n    OPTIONS extends never | \"$rid\" = never,\n    P extends PropertyKeys<Q> = PropertyKeys<Q>,\n    R extends Record<string, SimplePropertyDef> = {},\n  > =\n    & OsdkBase<Q>\n    & Pick<\n      CompileTimeMetadata<Q>[\"props\"],\n      // If there aren't any additional properties, then we want GetPropsKeys to default to PropertyKeys<Q>\n      GetPropsKeys<Q, P, [R] extends [{}] ? false : true>\n    >\n    & ([R] extends [never] ? {}\n      : { [A in keyof R]: SimplePropertyDef.ToRuntimeProperty<R[A]> })\n    & {\n      readonly $link: Q extends { linksType?: any } ? Q[\"linksType\"]\n        : Q extends ObjectTypeDefinition ? OsdkObjectLinksObject<Q>\n        : never;\n\n      readonly $as: <NEW_Q extends ValidToFrom<Q>>(\n        type: NEW_Q | string,\n      ) => Osdk.Instance<\n        NEW_Q,\n        OPTIONS,\n        ConvertProps<Q, NEW_Q, P>\n      >;\n\n      readonly $clone: <NEW_PROPS extends PropertyKeys<Q>>(\n        updatedObject?:\n          | Osdk.Instance<Q, any, NEW_PROPS>\n          | {\n            [K in NEW_PROPS]?: CompileTimeMetadata<\n              Q\n            >[\"props\"][K];\n          },\n      ) => Osdk.Instance<Q, OPTIONS, P | NEW_PROPS>;\n    }\n    // We are hiding the $rid field if it wasn't requested as we want to discourage its use\n    & (IsNever<OPTIONS> extends true ? {}\n      : IsAny<OPTIONS> extends true ? {}\n      : \"$rid\" extends OPTIONS ? { readonly $rid: string }\n      : {});\n}\n\n/**\n * NOT EXPORTED FROM PACKAGE\n *\n * Anything you throw at this that is not `false` should always be `never`.\n *\n * This is structured in a way that it should always short circuit to never early.\n */\nexport type ExtractStrictOption<S extends NullabilityAdherence> =\n  IsNever<S> extends true ? never\n    : \"throw\" extends S ? never // catches any time \"throw\" still exists (including any)\n    : \"drop\" extends S ? never // catches any time \"drop\" still exists (including any)\n    : \"$notStrict\";\n\n/**\n * NOT EXPORTED FROM PACKAGE\n *\n * Anything you throw at this that is not exactly `true` should always be `never`.\n */\nexport type ExtractRidOption<R extends boolean> = // comment for readability\n  IsNever<R> extends true ? never\n    : DefaultToFalse<R> extends false ? never\n    : \"$rid\";\n\n// not exported from package\nexport type ExtractOptions<\n  R extends boolean,\n  S extends NullabilityAdherence = NullabilityAdherence.Default,\n> = ExtractRidOption<R>;\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AA+EA;AACA;AACA;AACA;AACA;AAuBA;AAMA;AACA;AACA;AACA;AAiCA;AACA;AACA;AAFA,WAsBiBA,IAAI;AA6CrB;AACA;AACA;AACA;AACA;AACA;AACA;AAOA;AACA;AACA;AACA;AACA;AAMA","ignoreList":[]}
+{"version":3,"file":"OsdkObjectFrom.js","names":["Osdk"],"sources":["OsdkObjectFrom.ts"],"sourcesContent":["/*\n * Copyright 2023 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n  DefaultToFalse,\n  OsdkObjectLinksObject,\n} from \"./definitions/LinkDefinitions.js\";\nimport type { NullabilityAdherence } from \"./object/FetchPageArgs.js\";\nimport type { UnionIfTrue } from \"./object/FetchPageResult.js\";\nimport type { InterfaceDefinition } from \"./ontology/InterfaceDefinition.js\";\nimport type {\n  ObjectOrInterfaceDefinition,\n  PropertyKeys,\n} from \"./ontology/ObjectOrInterface.js\";\nimport type {\n  CompileTimeMetadata,\n  ObjectTypeDefinition,\n} from \"./ontology/ObjectTypeDefinition.js\";\nimport type { SimplePropertyDef } from \"./ontology/SimplePropertyDef.js\";\nimport type { OsdkBase } from \"./OsdkBase.js\";\n\ntype DropDollarOptions<T extends string> = Exclude<\n  T,\n  \"$rid\" | \"$all\" | \"$notStrict\"\n>;\n\ntype DropDollarAll<T extends string> = Exclude<\n  T,\n  \"$all\"\n>;\n\ntype SpecialOsdkPropParams =\n  | \"$all\"\n  | \"$rid\"\n  | \"$strict\"\n  | \"$notStrict\";\n\ntype ValidOsdkPropParams<Q extends ObjectOrInterfaceDefinition> =\n  | SpecialOsdkPropParams\n  | PropertyKeys<Q>;\n\nexport type ApiNameAsString<\n  T extends ObjectOrInterfaceDefinition,\n> = CompileTimeMetadata<T>[\"apiName\"];\n\nexport type JustProps<\n  T extends ObjectOrInterfaceDefinition,\n  P extends ValidOsdkPropParams<T>,\n> = P extends \"$all\" ? PropertyKeys<T>\n  : Exclude<P, SpecialOsdkPropParams>;\n\nexport type PropMapToObject<\n  FROM extends ObjectOrInterfaceDefinition,\n  TO extends ObjectTypeDefinition,\n> = NonNullable<CompileTimeMetadata<TO>[\"interfaceMap\"]>[ApiNameAsString<FROM>];\n\nexport type MapPropNamesToObjectType<\n  FROM extends ObjectOrInterfaceDefinition,\n  TO extends ObjectTypeDefinition,\n  P extends ValidOsdkPropParams<FROM>,\n  OPTIONS extends never | \"$rid\" | \"$allBaseProperties\" = never,\n> = \"$allBaseProperties\" extends OPTIONS\n  ? PropertyKeys<FROM> extends P ? PropertyKeys<TO>\n  : PropMapToObject<\n    FROM,\n    TO\n  >[JustProps<FROM, P> & keyof PropMapToObject<FROM, TO>]\n  : PropMapToObject<\n    FROM,\n    TO\n  >[JustProps<FROM, P> & keyof PropMapToObject<FROM, TO>];\n\nexport type PropMapToInterface<\n  FROM extends ObjectTypeDefinition,\n  TO extends InterfaceDefinition,\n> = NonNullable<\n  CompileTimeMetadata<FROM>[\"inverseInterfaceMap\"]\n>[ApiNameAsString<TO>];\n\nexport type MapPropNamesToInterface<\n  FROM extends ObjectTypeDefinition,\n  TO extends InterfaceDefinition,\n  P extends ValidOsdkPropParams<FROM>,\n> = PropMapToInterface<\n  FROM,\n  TO\n>[JustProps<FROM, P> & keyof PropMapToInterface<FROM, TO>];\n/**\n * @param FROM - the interface or object type to convert from\n * @param TO - the interface or object type to convert to\n * @param P - the property(s) to convert\n */\nexport type ConvertProps<\n  FROM extends ObjectOrInterfaceDefinition,\n  TO extends ValidToFrom<FROM>,\n  P extends ValidOsdkPropParams<FROM>,\n  OPTIONS extends never | \"$rid\" | \"$allBaseProperties\" = never,\n> = TO extends FROM ? P\n  : TO extends ObjectTypeDefinition ? (\n      UnionIfTrue<\n        MapPropNamesToObjectType<FROM, TO, P, OPTIONS>,\n        P extends \"$rid\" ? true : false,\n        \"$rid\"\n      >\n    )\n  : TO extends InterfaceDefinition ? FROM extends ObjectTypeDefinition ? (\n        UnionIfTrue<\n          MapPropNamesToInterface<FROM, TO, P>,\n          P extends \"$rid\" ? true : false,\n          \"$rid\"\n        >\n      )\n    : never\n  : never;\n\n/** DO NOT EXPORT FROM PACKAGE */\nexport type ValidToFrom<\n  FROM extends ObjectOrInterfaceDefinition,\n> = FROM extends InterfaceDefinition ? ObjectOrInterfaceDefinition\n  : InterfaceDefinition;\n\n/**\n * @param P The properties to add from Q\n * @param Z The existing underlying properties\n */\ntype UnderlyingProps<\n  Q extends ObjectOrInterfaceDefinition,\n  P extends string,\n  Z extends string,\n  NEW_Q extends ValidToFrom<Q>,\n> =\n  & Z\n  & Q extends InterfaceDefinition\n  ? NEW_Q extends ObjectTypeDefinition ? ConvertProps<Q, NEW_Q, P>\n  : Z\n  : Z;\n\nexport type IsNever<T> = [T] extends [never] ? true : false;\n\ntype ExtractPropsKeysFromOldPropsStyle<\n  Q extends ObjectOrInterfaceDefinition,\n  P extends ValidOsdkPropParams<Q>,\n> = P extends \"$all\" ? PropertyKeys<Q>\n  : Exclude<P, \"$strict\" | \"$notStrict\" | \"$rid\">;\n\nexport type IsAny<T> = unknown extends T\n  ? [keyof T] extends [never] ? false : true\n  : false;\n\nexport type GetPropsKeys<\n  Q extends ObjectOrInterfaceDefinition,\n  P extends PropertyKeys<Q>,\n  N extends boolean = false,\n> = IsNever<P> extends true ? N extends true ? never : PropertyKeys<Q>\n  : IsAny<P> extends true ? PropertyKeys<Q>\n  : P;\n\n/**\n * Use `Osdk.Instance` or `YourType.OsdkInstance`\n */\nexport type Osdk<\n  Q extends ObjectOrInterfaceDefinition,\n  OPTIONS extends string = never,\n  P extends PropertyKeys<Q> = PropertyKeys<Q>,\n> =\n  // no middle options is simplest\n  IsNever<OPTIONS> extends true ? Osdk.Instance<Q, never, P>\n    : IsAny<OPTIONS> extends true ? Osdk.Instance<Q, never, P>\n    // Options only includes the two allowed in the new style\n    : (IsNever<Exclude<OPTIONS, \"$rid\">>) extends true\n      ? Osdk.Instance<Q, OPTIONS & \"$rid\", P>\n    // else we are in the old style which was just Q and OPTIONS\n    // and OPTIONS was $things + prop names\n    : Osdk.Instance<\n      Q,\n      (\"$rid\" extends OPTIONS ? \"$rid\" : never),\n      ExtractPropsKeysFromOldPropsStyle<Q, OPTIONS>\n    >;\n\nexport namespace Osdk {\n  export type Instance<\n    Q extends ObjectOrInterfaceDefinition,\n    OPTIONS extends never | \"$rid\" | \"$allBaseProperties\" = never,\n    P extends PropertyKeys<Q> = PropertyKeys<Q>,\n    R extends Record<string, SimplePropertyDef> = {},\n  > =\n    & OsdkBase<Q>\n    & Pick<\n      CompileTimeMetadata<Q>[\"props\"],\n      // If there aren't any additional properties, then we want GetPropsKeys to default to PropertyKeys<Q>\n      GetPropsKeys<Q, P, [R] extends [{}] ? false : true>\n    >\n    & ([R] extends [never] ? {}\n      : { [A in keyof R]: SimplePropertyDef.ToRuntimeProperty<R[A]> })\n    & {\n      readonly $link: Q extends { linksType?: any } ? Q[\"linksType\"]\n        : Q extends ObjectTypeDefinition ? OsdkObjectLinksObject<Q>\n        : never;\n\n      readonly $as: <NEW_Q extends ValidToFrom<Q>>(\n        type: NEW_Q | string,\n      ) => Osdk.Instance<\n        NEW_Q,\n        OPTIONS,\n        ConvertProps<Q, NEW_Q, P, OPTIONS>\n      >;\n\n      readonly $clone: <NEW_PROPS extends PropertyKeys<Q>>(\n        updatedObject?:\n          | Osdk.Instance<Q, any, NEW_PROPS>\n          | {\n            [K in NEW_PROPS]?: CompileTimeMetadata<\n              Q\n            >[\"props\"][K];\n          },\n      ) => Osdk.Instance<Q, OPTIONS, P | NEW_PROPS>;\n    }\n    // We are hiding the $rid field if it wasn't requested as we want to discourage its use\n    & (IsNever<OPTIONS> extends true ? {}\n      : IsAny<OPTIONS> extends true ? {}\n      : \"$rid\" extends OPTIONS ? { readonly $rid: string }\n      : {});\n}\n\n/**\n * NOT EXPORTED FROM PACKAGE\n *\n * Anything you throw at this that is not `false` should always be `never`.\n *\n * This is structured in a way that it should always short circuit to never early.\n */\nexport type ExtractStrictOption<S extends NullabilityAdherence> =\n  IsNever<S> extends true ? never\n    : \"throw\" extends S ? never // catches any time \"throw\" still exists (including any)\n    : \"drop\" extends S ? never // catches any time \"drop\" still exists (including any)\n    : \"$notStrict\";\n\n/**\n * NOT EXPORTED FROM PACKAGE\n *\n * Anything you throw at this that is not exactly `true` should always be `never`.\n */\nexport type ExtractRidOption<R extends boolean> = // comment for readability\n  IsNever<R> extends true ? never\n    : DefaultToFalse<R> extends false ? never\n    : \"$rid\";\n\nexport type ExtractAllPropertiesOption<T extends boolean> = // comment for readability\n  IsNever<T> extends true ? never\n    : DefaultToFalse<T> extends false ? never\n    : \"$allBaseProperties\";\n\n// not exported from package\nexport type ExtractOptions<\n  R extends boolean,\n  S extends NullabilityAdherence = NullabilityAdherence.Default,\n  T extends boolean = false,\n> = ExtractRidOption<R> | ExtractAllPropertiesOption<T>;\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAsFA;AACA;AACA;AACA;AACA;AAwBA;AAMA;AACA;AACA;AACA;AAiCA;AACA;AACA;AAFA,WAsBiBA,IAAI;AA6CrB;AACA;AACA;AACA;AACA;AACA;AACA;AAOA;AACA;AACA;AACA;AACA;AAWA","ignoreList":[]}

package/build/esm/actions/ActionResults.js.map

@@ -1 +1 @@
-{"version":3,"file":"ActionResults.js","names":[],"sources":["ActionResults.ts"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n// These are migrated from @osdk/foundry.internal to avoid coupling the apis\n\nexport type ActionResults =\n  & (\n    | ObjectEdits\n    | LargeScaleObjectEdits\n  )\n  & { editedObjectTypes: Array<String> };\n\ninterface ObjectEdits {\n  type: \"edits\";\n  addedObjects: Array<ObjectReference>;\n  modifiedObjects: Array<ObjectReference>;\n  addedLinks: Array<LinkReference>;\n  deletedObjectsCount: number;\n  deletedLinksCount: number;\n}\ninterface LargeScaleObjectEdits {\n  type: \"largeScaleEdits\";\n  addedObjects?: never;\n  modifiedObjects?: never;\n  addedLinks?: never;\n  deletedObjectsCount?: never;\n  deletedLinksCount?: never;\n}\n\ntype LinkReference = {\n  linkTypeApiNameAtoB: string;\n  linkTypeApiNameBtoA: string;\n  aSideObject: ObjectReference;\n  bSideObject: ObjectReference;\n};\ninterface ObjectReference {\n  primaryKey: string | number;\n  objectType: string;\n}\nexport interface ValidateActionResponseV2 {\n  result: \"VALID\" | \"INVALID\";\n  submissionCriteria: Array<{\n    configuredFailureMessage?: string;\n    result: \"VALID\" | \"INVALID\";\n  }>;\n  parameters: Record<string, {\n    result: \"VALID\" | \"INVALID\";\n    evaluatedConstraints: Array<ParameterEvaluatedConstraint>;\n    required: boolean;\n  }>;\n}\ntype ParameterEvaluatedConstraint =\n  | { type: \"arraySize\"; lt?: any; lte?: any; gt?: any; gte?: any }\n  | { type: \"groupMember\" }\n  | { type: \"objectPropertyValue\" }\n  | { type: \"objectQueryResult\" }\n  | {\n    type: \"oneOf\";\n    options: Array<{\n      displayName?: string;\n      value?: any;\n    }>;\n    otherValuesAllowed: boolean;\n  }\n  | { type: \"range\"; lt?: any; lte?: any; gt?: any; gte?: any }\n  | { type: \"stringLength\"; lt?: any; lte?: any; gt?: any; gte?: any }\n  | {\n    type: \"stringRegexMatch\";\n    regex: string;\n    configuredFailureMessage?: string;\n  }\n  | { type: \"unevaluable\" };\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"ActionResults.js","names":[],"sources":["ActionResults.ts"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n// These are migrated from @osdk/foundry.internal to avoid coupling the apis\n\nexport type ActionResults =\n  & (\n    | ObjectEdits\n    | LargeScaleObjectEdits\n  )\n  & { editedObjectTypes: Array<String> };\n\ninterface ObjectEdits {\n  type: \"edits\";\n  addedObjects: Array<ObjectReference>;\n  modifiedObjects: Array<ObjectReference>;\n  deletedObjects?: Array<ObjectReference>;\n  addedLinks: Array<LinkReference>;\n  deletedLinks?: Array<LinkReference>;\n  deletedObjectsCount: number;\n  deletedLinksCount: number;\n}\ninterface LargeScaleObjectEdits {\n  type: \"largeScaleEdits\";\n  addedObjects?: never;\n  modifiedObjects?: never;\n  deletedObjects?: never;\n  addedLinks?: never;\n  deletedLinks?: never;\n  deletedObjectsCount?: never;\n  deletedLinksCount?: never;\n}\n\ntype LinkReference = {\n  linkTypeApiNameAtoB: string;\n  linkTypeApiNameBtoA: string;\n  aSideObject: ObjectReference;\n  bSideObject: ObjectReference;\n};\ninterface ObjectReference {\n  primaryKey: string | number;\n  objectType: string;\n}\nexport interface ValidateActionResponseV2 {\n  result: \"VALID\" | \"INVALID\";\n  submissionCriteria: Array<{\n    configuredFailureMessage?: string;\n    result: \"VALID\" | \"INVALID\";\n  }>;\n  parameters: Record<string, {\n    result: \"VALID\" | \"INVALID\";\n    evaluatedConstraints: Array<ParameterEvaluatedConstraint>;\n    required: boolean;\n  }>;\n}\ntype ParameterEvaluatedConstraint =\n  | { type: \"arraySize\"; lt?: any; lte?: any; gt?: any; gte?: any }\n  | { type: \"groupMember\" }\n  | { type: \"objectPropertyValue\" }\n  | { type: \"objectQueryResult\" }\n  | {\n    type: \"oneOf\";\n    options: Array<{\n      displayName?: string;\n      value?: any;\n    }>;\n    otherValuesAllowed: boolean;\n  }\n  | { type: \"range\"; lt?: any; lte?: any; gt?: any; gte?: any }\n  | { type: \"stringLength\"; lt?: any; lte?: any; gt?: any; gte?: any }\n  | {\n    type: \"stringRegexMatch\";\n    regex: string;\n    configuredFailureMessage?: string;\n  }\n  | { type: \"unevaluable\" };\n"],"mappings":"","ignoreList":[]}

package/build/esm/actions/Actions.js.map

@@ -1 +1 @@
-{"version":3,"file":"Actions.js","names":["ActionParam"],"sources":["Actions.ts"],"sourcesContent":["/*\n * Copyright 2023 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { DataValueClientToWire } from \"../mapping/DataValueMapping.js\";\nimport type { ObjectSet } from \"../objectSet/ObjectSet.js\";\nimport type { InterfaceDefinition } from \"../ontology/InterfaceDefinition.js\";\nimport type { ObjectTypeDefinition } from \"../ontology/ObjectTypeDefinition.js\";\nimport type { OsdkBase } from \"../OsdkBase.js\";\nimport type { OsdkObjectPrimaryKeyType } from \"../OsdkObjectPrimaryKeyType.js\";\n\nimport type {\n  ActionResults,\n  ValidateActionResponseV2,\n} from \"./ActionResults.js\";\n\nexport type ApplyActionOptions =\n  | { $returnEdits?: true; $validateOnly?: false }\n  | {\n    $validateOnly?: true;\n    $returnEdits?: false;\n  };\n\nexport type ApplyBatchActionOptions = { $returnEdits?: boolean };\n\n/**\n * Helper types for converting action definition parameter types to typescript types\n */\nexport namespace ActionParam {\n  /**\n   * Helper type to convert action definition parameter primitives to typescript types\n   */\n  export type PrimitiveType<T extends keyof DataValueClientToWire> =\n    DataValueClientToWire[T];\n\n  /**\n   * Helper type to convert action definition parameter object types to typescript types\n   */\n  export type ObjectType<T extends ObjectTypeDefinition> =\n    | OsdkBase<T>\n    | OsdkObjectPrimaryKeyType<T>;\n\n  /**\n   * Helper type to convert action definition parameter object sets to typescript types\n   */\n  export type ObjectSetType<T extends ObjectTypeDefinition> = ObjectSet<T>;\n\n  /**\n   * Helper type to convert action definition parameter interface types to typescript types\n   */\n  export type InterfaceType<T extends InterfaceDefinition> = {\n    $objectType: NonNullable<T[\"__DefinitionMetadata\"]> extends\n      { implementedBy: infer U }\n      ? (U extends ReadonlyArray<string> ? U[number] : string)\n      : string;\n    $primaryKey: string | number;\n  };\n\n  export type StructType<\n    T extends Record<string, keyof DataValueClientToWire>,\n  > = { [K in keyof T]: DataValueClientToWire[T[K]] };\n}\n\nexport type ActionEditResponse = ActionResults;\nexport type ActionValidationResponse = ValidateActionResponseV2;\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAuBA;AACA;AACA;AAFA,WAGiBA,WAAW","ignoreList":[]}
+{"version":3,"file":"Actions.js","names":["ActionParam"],"sources":["Actions.ts"],"sourcesContent":["/*\n * Copyright 2023 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { DataValueClientToWire } from \"../mapping/DataValueMapping.js\";\nimport type { ObjectSet } from \"../objectSet/ObjectSet.js\";\nimport type { InterfaceDefinition } from \"../ontology/InterfaceDefinition.js\";\nimport type { ObjectTypeDefinition } from \"../ontology/ObjectTypeDefinition.js\";\nimport type { OsdkBase } from \"../OsdkBase.js\";\nimport type { OsdkObjectPrimaryKeyType } from \"../OsdkObjectPrimaryKeyType.js\";\n\nimport type {\n  ActionResults,\n  ValidateActionResponseV2,\n} from \"./ActionResults.js\";\n\nexport type ApplyActionOptions =\n  | { $returnEdits?: true; $validateOnly?: false }\n  | {\n    $validateOnly?: true;\n    $returnEdits?: false;\n  };\n\nexport type ApplyBatchActionOptions = { $returnEdits?: boolean };\n\n/**\n * Helper types for converting action definition parameter types to typescript types\n */\nexport namespace ActionParam {\n  /**\n   * Helper type to convert action definition parameter primitives to typescript types\n   */\n  export type PrimitiveType<T extends keyof DataValueClientToWire> =\n    DataValueClientToWire[T];\n\n  /**\n   * Helper type to convert action definition parameter object types to typescript types\n   */\n  export type ObjectType<T extends ObjectTypeDefinition> =\n    | OsdkBase<T>\n    | OsdkObjectPrimaryKeyType<T>;\n\n  /**\n   * Helper type to convert action definition parameter object sets to typescript types\n   */\n  export type ObjectSetType<T extends ObjectTypeDefinition> = ObjectSet<T>;\n\n  /**\n   * Helper type to convert action definition parameter interface types to typescript types\n   */\n  export type InterfaceType<T extends InterfaceDefinition> = {\n    $objectType: NonNullable<T[\"__DefinitionMetadata\"]> extends\n      { implementedBy: infer U } ? (U extends ReadonlyArray<never> ? string\n        : U extends ReadonlyArray<string> ? U[number]\n        : string)\n      : string;\n    $primaryKey: string | number;\n  };\n\n  export type StructType<\n    T extends Record<string, keyof DataValueClientToWire>,\n  > = { [K in keyof T]: DataValueClientToWire[T[K]] };\n}\n\nexport type ActionEditResponse = ActionResults;\nexport type ActionValidationResponse = ValidateActionResponseV2;\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAuBA;AACA;AACA;AAFA,WAGiBA,WAAW","ignoreList":[]}

package/build/esm/aggregate/AggregatableKeys.js.map

@@ -1 +1 @@
-{"version":3,"file":"AggregatableKeys.js","names":[],"sources":["AggregatableKeys.ts"],"sourcesContent":["/*\n * Copyright 2023 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n  NumericWithPropAggregateOption,\n  StringWithPropAggregateOption,\n} from \"../derivedProperties/WithPropertiesAggregationOptions.js\";\nimport type {\n  GetWirePropertyValueFromClient,\n} from \"../mapping/PropertyValueMapping.js\";\nimport type {\n  ObjectOrInterfaceDefinition,\n  PropertyKeys,\n} from \"../ontology/ObjectOrInterface.js\";\nimport type { CompileTimeMetadata } from \"../ontology/ObjectTypeDefinition.js\";\n\nexport type StringAggregateOption = \"approximateDistinct\" | \"exactDistinct\";\nexport type NumericAggregateOption =\n  | \"min\"\n  | \"max\"\n  | \"sum\"\n  | \"avg\"\n  | \"approximateDistinct\"\n  | \"exactDistinct\";\n\ntype AGG_FOR_TYPE<T, U extends boolean> = number extends T\n  ? U extends true ? NumericAggregateOption : NumericWithPropAggregateOption\n  : string extends T\n    ? U extends true ? StringAggregateOption : StringWithPropAggregateOption\n  : never;\n\nexport type ValidAggregationKeys<\n  Q extends ObjectOrInterfaceDefinition,\n  R extends \"aggregate\" = \"aggregate\",\n> = keyof (\n  & {\n    [\n      KK in AggregatableKeys<Q> as `${KK & string}:${AGG_FOR_TYPE<\n        GetWirePropertyValueFromClient<\n          CompileTimeMetadata<Q>[\"properties\"][KK][\"type\"]\n        >,\n        true\n      >}`\n    ]?: any;\n  }\n  & { $count?: any }\n);\n\nexport type AggregatableKeys<\n  Q extends ObjectOrInterfaceDefinition,\n> = keyof {\n  [P in PropertyKeys<Q>]: any;\n};\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"AggregatableKeys.js","names":[],"sources":["AggregatableKeys.ts"],"sourcesContent":["/*\n * Copyright 2023 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n  NumericWithPropAggregateOption,\n  StringWithPropAggregateOption,\n} from \"../derivedProperties/WithPropertiesAggregationOptions.js\";\nimport type {\n  GetWirePropertyValueFromClient,\n} from \"../mapping/PropertyValueMapping.js\";\nimport type {\n  ObjectOrInterfaceDefinition,\n  PropertyKeys,\n} from \"../ontology/ObjectOrInterface.js\";\nimport type { CompileTimeMetadata } from \"../ontology/ObjectTypeDefinition.js\";\n\nexport type StringAggregateOption = \"approximateDistinct\" | \"exactDistinct\";\nexport type NumericAggregateOption =\n  | \"min\"\n  | \"max\"\n  | \"sum\"\n  | \"avg\"\n  | \"approximateDistinct\"\n  | \"exactDistinct\";\n\ntype AGG_FOR_TYPE<T, U extends boolean> = number extends T\n  ? U extends true ? NumericAggregateOption : NumericWithPropAggregateOption\n  : string extends T\n    ? U extends true ? StringAggregateOption : StringWithPropAggregateOption\n  : boolean extends T ? U extends true ? never : StringWithPropAggregateOption\n  : never;\n\nexport type ValidAggregationKeys<\n  Q extends ObjectOrInterfaceDefinition,\n  R extends \"aggregate\" | \"withPropertiesAggregate\" = \"aggregate\",\n> = keyof (\n  & {\n    [\n      KK in AggregatableKeys<Q> as `${KK & string}:${AGG_FOR_TYPE<\n        GetWirePropertyValueFromClient<\n          CompileTimeMetadata<Q>[\"properties\"][KK][\"type\"]\n        >,\n        R extends \"aggregate\" ? true : false\n      >}`\n    ]?: any;\n  }\n  & { $count?: any }\n);\n\nexport type AggregatableKeys<\n  Q extends ObjectOrInterfaceDefinition,\n> = keyof {\n  [P in PropertyKeys<Q>]: any;\n};\n"],"mappings":"","ignoreList":[]}

package/build/esm/derivedProperties/DerivedProperty.js

@@ -0,0 +1,17 @@
+/*
+ * Copyright 2024 Palantir Technologies, Inc. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export let DerivedProperty;
+//# sourceMappingURL=DerivedProperty.js.map

package/build/esm/derivedProperties/DerivedProperty.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DerivedProperty.js","names":["DerivedProperty"],"sources":["DerivedProperty.ts"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { ValidAggregationKeys } from \"../aggregate/AggregatableKeys.js\";\nimport type { WhereClause } from \"../aggregate/WhereClause.js\";\nimport type {\n  ObjectOrInterfaceDefinition,\n  PropertyKeys,\n} from \"../ontology/ObjectOrInterface.js\";\nimport type { CompileTimeMetadata } from \"../ontology/ObjectTypeDefinition.js\";\nimport type { SimplePropertyDef } from \"../ontology/SimplePropertyDef.js\";\nimport type { LinkedType, LinkNames } from \"../util/LinkUtils.js\";\nimport type { CollectWithPropAggregations } from \"./WithPropertiesAggregationOptions.js\";\n\nexport namespace DerivedProperty {\n  export type SelectorResult<\n    T extends SimplePropertyDef,\n  > = {\n    type: T;\n  };\n\n  export type Clause<\n    Q extends ObjectOrInterfaceDefinition,\n  > = {\n    [key: string]: Selector<Q, SimplePropertyDef>;\n  };\n\n  export type Selector<\n    Q extends ObjectOrInterfaceDefinition,\n    T extends SimplePropertyDef,\n  > = (\n    baseObjectSet: DerivedProperty.Builder<Q, false>,\n  ) => SelectorResult<T>;\n\n  export interface Builder<\n    Q extends ObjectOrInterfaceDefinition,\n    CONSTRAINED extends boolean,\n  > extends Filterable<Q, CONSTRAINED>, Pivotable<Q, CONSTRAINED> {\n  }\n\n  export interface AggregateBuilder<\n    Q extends ObjectOrInterfaceDefinition,\n    CONSTRAINED extends boolean,\n  > extends Builder<Q, CONSTRAINED>, Aggregatable<Q> {\n  }\n\n  export interface SelectPropertyBuilder<\n    Q extends ObjectOrInterfaceDefinition,\n    CONSTRAINED extends boolean,\n  > extends AggregateBuilder<Q, CONSTRAINED>, Selectable<Q> {\n  }\n}\n\ntype BuilderTypeFromConstraint<\n  Q extends ObjectOrInterfaceDefinition,\n  CONSTRAINED extends boolean,\n> = CONSTRAINED extends true ? DerivedProperty.AggregateBuilder<Q, true>\n  : DerivedProperty.SelectPropertyBuilder<Q, false>;\n\ntype Filterable<\n  Q extends ObjectOrInterfaceDefinition,\n  CONSTRAINED extends boolean,\n> = {\n  readonly where: (\n    clause: WhereClause<Q>,\n  ) => BuilderTypeFromConstraint<Q, CONSTRAINED>;\n};\n\ntype Pivotable<\n  Q extends ObjectOrInterfaceDefinition,\n  CONSTRAINED extends boolean,\n> = {\n  readonly pivotTo: <L extends LinkNames<Q>>(\n    type: L,\n  ) => CONSTRAINED extends true\n    ? DerivedProperty.AggregateBuilder<LinkedType<Q, L>, true>\n    : NonNullable<CompileTimeMetadata<Q>[\"links\"][L][\"multiplicity\"]> extends\n      true ? DerivedProperty.AggregateBuilder<LinkedType<Q, L>, true>\n    : DerivedProperty.SelectPropertyBuilder<LinkedType<Q, L>, false>;\n};\n\ntype Aggregatable<\n  Q extends ObjectOrInterfaceDefinition,\n> = {\n  readonly aggregate: <\n    V extends ValidAggregationKeys<\n      Q,\n      \"withPropertiesAggregate\"\n    >,\n  >(\n    aggregationSpecifier: V,\n    opts?: V extends `${any}:${infer P}`\n      ? P extends CollectWithPropAggregations ? { limit: number }\n      : P extends \"approximatePercentile\" ? { percentile: number }\n      : never\n      : never,\n  ) => DerivedProperty.SelectorResult<\n    V extends `${infer N}:${infer P}`\n      ? P extends CollectWithPropAggregations\n        ? Array<CompileTimeMetadata<Q>[\"properties\"][N][\"type\"]> | undefined\n      : P extends \"approximateDistinct\" | \"exactDistinct\" | \"$count\" ? \"integer\"\n      : \"double\" | undefined\n      : V extends \"$count\" ? \"integer\"\n      : never\n  >;\n};\n\ntype Selectable<Q extends ObjectOrInterfaceDefinition> = {\n  readonly selectProperty: <R extends PropertyKeys<Q>>(\n    propertyName: R,\n  ) => DerivedProperty.SelectorResult<\n    SimplePropertyDef.Make<\n      CompileTimeMetadata<Q>[\"properties\"][R][\"type\"],\n      CompileTimeMetadata<Q>[\"properties\"][R][\"nullable\"],\n      CompileTimeMetadata<Q>[\"properties\"][R][\"multiplicity\"]\n    >\n  >;\n};\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAdA,WA2BiBA,eAAe","ignoreList":[]}

package/build/esm/derivedProperties/WithPropertiesAggregationOptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"WithPropertiesAggregationOptions.js","names":[],"sources":["WithPropertiesAggregationOptions.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nexport type CollectWithPropAggregations = \"collectSet\" | \"collectList\";\n\nexport type BaseWithPropAggregations =\n  | \"approximateDistinct\"\n  | \"exactDistinct\"\n  | \"approximatePercentile\";\n\nexport type StringWithPropAggregateOption =\n  | BaseWithPropAggregations\n  | CollectWithPropAggregations;\n\nexport type NumericWithPropAggregateOption =\n  | \"min\"\n  | \"max\"\n  | \"sum\"\n  | \"avg\"\n  | BaseWithPropAggregations\n  | CollectWithPropAggregations;\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"WithPropertiesAggregationOptions.js","names":[],"sources":["WithPropertiesAggregationOptions.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nexport type CollectWithPropAggregations = \"collectSet\" | \"collectList\";\n\nexport type BaseWithPropAggregations =\n  | \"approximateDistinct\"\n  | \"exactDistinct\";\n\nexport type StringWithPropAggregateOption =\n  | BaseWithPropAggregations\n  | CollectWithPropAggregations;\n\nexport type NumericWithPropAggregateOption =\n  | \"min\"\n  | \"max\"\n  | \"sum\"\n  | \"avg\"\n  | \"approximatePercentile\"\n  | BaseWithPropAggregations\n  | CollectWithPropAggregations;\n"],"mappings":"","ignoreList":[]}

package/build/esm/experimental/createMediaReference.js

@@ -21,8 +21,8 @@
  *
  * @param data - Data to upload as media item
  * @param fileName - Name that will be assigned as path to the uploaded media item.
- * @param objectTypeApi - Api name of the object type to which the media item will be uploaded.
- * @param propertyTypeApi - Api name of the media reference property of the corresponding object type to which the media item will be uploaded.
+ * @param objectType - Object type to which the media item will be uploaded.
+ * @param propertyType - Media reference property of the corresponding object type to which the media item will be uploaded.
  *
  * @returns media reference of the uploaded media item.
  */

package/build/esm/experimental/createMediaReference.js.map

@@ -1 +1 @@
-{"version":3,"file":"createMediaReference.js","names":["__EXPERIMENTAL__NOT_SUPPORTED_YET__createMediaReference","name","type","version"],"sources":["createMediaReference.ts"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { MediaReference } from \"../object/Media.js\";\nimport type { Experiment } from \"./Experiment.js\";\n\n/**\n * @experimental This feature is experimental and might change in the future.\n *\n * Uploads a media item to the media property of the specified object type.\n *\n * @param data - Data to upload as media item\n * @param fileName - Name that will be assigned as path to the uploaded media item.\n * @param objectTypeApi - Api name of the object type to which the media item will be uploaded.\n * @param propertyTypeApi - Api name of the media reference property of the corresponding object type to which the media item will be uploaded.\n *\n * @returns media reference of the uploaded media item.\n */\ntype createMediaReference = (\n  args: {\n    data: Blob;\n    fileName: string;\n    objectTypeApi: string;\n    propertyTypeApi: string;\n  },\n) => Promise<MediaReference>;\n\nexport const __EXPERIMENTAL__NOT_SUPPORTED_YET__createMediaReference:\n  Experiment<\n    \"2.1.0\",\n    \"__EXPERIMENTAL__NOT_SUPPORTED_YET__createMediaReference\",\n    { createMediaReference: createMediaReference }\n  > = {\n    name: \"__EXPERIMENTAL__NOT_SUPPORTED_YET__createMediaReference\",\n    type: \"experiment\",\n    version: \"2.1.0\",\n  };\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAKA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAUA,OAAO,MAAMA,uDAKV,GAAG;EACFC,IAAI,EAAE,yDAAyD;EAC/DC,IAAI,EAAE,YAAY;EAClBC,OAAO,EAAE;AACX,CAAC","ignoreList":[]}
+{"version":3,"file":"createMediaReference.js","names":["__EXPERIMENTAL__NOT_SUPPORTED_YET__createMediaReference","name","type","version"],"sources":["createMediaReference.ts"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { MediaReference } from \"../object/Media.js\";\nimport type { FilteredPropertyKeys } from \"../ontology/FilteredPropertyKeys.js\";\nimport type { ObjectOrInterfaceDefinition } from \"../ontology/ObjectOrInterface.js\";\nimport type { Experiment } from \"./Experiment.js\";\n\n/**\n * @experimental This feature is experimental and might change in the future.\n *\n * Uploads a media item to the media property of the specified object type.\n *\n * @param data - Data to upload as media item\n * @param fileName - Name that will be assigned as path to the uploaded media item.\n * @param objectType - Object type to which the media item will be uploaded.\n * @param propertyType - Media reference property of the corresponding object type to which the media item will be uploaded.\n *\n * @returns media reference of the uploaded media item.\n */\ntype createMediaReference = <\n  Q extends ObjectOrInterfaceDefinition,\n  const L extends FilteredPropertyKeys<Q, \"mediaReference\">,\n>(\n  args: {\n    data: Blob;\n    fileName: string;\n    objectType: Q;\n    propertyType: L;\n  },\n) => Promise<MediaReference>;\n\nexport const __EXPERIMENTAL__NOT_SUPPORTED_YET__createMediaReference:\n  Experiment<\n    \"2.1.0\",\n    \"__EXPERIMENTAL__NOT_SUPPORTED_YET__createMediaReference\",\n    { createMediaReference: createMediaReference }\n  > = {\n    name: \"__EXPERIMENTAL__NOT_SUPPORTED_YET__createMediaReference\",\n    type: \"experiment\",\n    version: \"2.1.0\",\n  };\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAOA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAaA,OAAO,MAAMA,uDAKV,GAAG;EACFC,IAAI,EAAE,yDAAyD;EAC/DC,IAAI,EAAE,YAAY;EAClBC,OAAO,EAAE;AACX,CAAC","ignoreList":[]}