@osdk/api 2.1.0-beta.28 → 2.1.0-beta.29

package/build/cjs/{ObjectSet-BjJpOctW.d.cts → ObjectSet-0c-4-xgY.d.cts}

@@ -56,6 +56,11 @@ interface MediaMetadata {
     mediaType: string;
 }
 
+type CollectWithPropAggregations = "collectSet" | "collectList";
+type BaseWithPropAggregations = "approximateDistinct" | "exactDistinct" | "approximatePercentile";
+type StringWithPropAggregateOption = BaseWithPropAggregations | CollectWithPropAggregations;
+type NumericWithPropAggregateOption = "min" | "max" | "sum" | "avg" | BaseWithPropAggregations | CollectWithPropAggregations;
+
 type TimeSeriesQuery = {
     $before: number;
     $unit: keyof typeof TimeseriesDurationMapping;
@@ -337,14 +342,38 @@ interface InterfaceDefinition {
     __DefinitionMetadata?: InterfaceMetadata & ObjectInterfaceCompileDefinition;
 }
 
+type SimplePropertyDef = WirePropertyTypes | undefined | Array<WirePropertyTypes>;
+declare namespace SimplePropertyDef {
+    type Make<T extends WirePropertyTypes, N extends boolean | undefined, M extends boolean | undefined> = M extends true ? N extends true ? Array<T> | undefined : Array<T> : N extends true ? T | undefined : T;
+    type FromPropertyMetadata<P extends ObjectMetadata.Property> = Make<P["type"], P["nullable"], P["multiplicity"]>;
+    type ExtractMultiplicity<T extends WirePropertyTypes | undefined | Array<WirePropertyTypes>> = NonNullable<T> extends Array<any> ? "array" : "single";
+    type ExtractWirePropertyType<T extends SimplePropertyDef> = T extends Array<infer Z> ? NonNullable<Z> : NonNullable<T>;
+    type ExtractNullable<T extends SimplePropertyDef> = [undefined] extends [T] ? "nullable" : [[undefined]] extends [T] ? "nullable" : "non-nullable";
+    type ToPropertyDef<S extends SimplePropertyDef> = PropertyDef<SimplePropertyDef.ExtractWirePropertyType<S>, SimplePropertyDef.ExtractNullable<S>, SimplePropertyDef.ExtractMultiplicity<S>>;
+    type ExtractRuntimeBaseType<S extends SimplePropertyDef> = GetClientPropertyValueFromWire<SimplePropertyDef.ExtractWirePropertyType<S>>;
+    type ToRuntimeProperty<S extends SimplePropertyDef> = ExtractMultiplicity<S> extends "array" ? ExtractNullable<S> extends "nullable" ? Array<ExtractRuntimeBaseType<S>> | undefined : Array<ExtractRuntimeBaseType<S>> : ExtractNullable<S> extends "nullable" ? ExtractRuntimeBaseType<S> | undefined : ExtractRuntimeBaseType<S>;
+}
+
 type ObjectOrInterfaceDefinition = ObjectTypeDefinition | InterfaceDefinition;
-type PropertyKeys<O extends ObjectOrInterfaceDefinition> = keyof NonNullable<O["__DefinitionMetadata"]>["properties"] & string;
+declare namespace ObjectOrInterfaceDefinition {
+    type WithDerivedProperties<K extends ObjectOrInterfaceDefinition, D extends Record<string, SimplePropertyDef>> = {
+        __DefinitionMetadata: {
+            properties: {
+                [T in keyof D]: SimplePropertyDef.ToPropertyDef<D[T]>;
+            };
+            props: {
+                [T in keyof D]: SimplePropertyDef.ToRuntimeProperty<D[T]>;
+            };
+        };
+    } & K;
+}
+type PropertyKeys<O extends ObjectOrInterfaceDefinition, RDPs extends Record<string, SimplePropertyDef> = {}> = (keyof NonNullable<O["__DefinitionMetadata"]>["properties"] | keyof RDPs) & string;
 
 type StringAggregateOption = "approximateDistinct" | "exactDistinct";
 type NumericAggregateOption = "min" | "max" | "sum" | "avg" | "approximateDistinct" | "exactDistinct";
-type AGG_FOR_TYPE<T> = number extends T ? NumericAggregateOption : string extends T ? StringAggregateOption : never;
-type ValidAggregationKeys<Q extends ObjectOrInterfaceDefinition> = keyof ({
-    [KK in AggregatableKeys<Q> as `${KK & string}:${AGG_FOR_TYPE<GetWirePropertyValueFromClient<CompileTimeMetadata<Q>["properties"][KK]["type"]>>}`]?: 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 : 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;
 });
@@ -560,7 +589,9 @@ type FetchPageResult<Q extends ObjectOrInterfaceDefinition, L extends PropertyKe
 /**
  * Helper type for converting fetch options into an Osdk object
  */
-type SingleOsdkResult<Q extends ObjectOrInterfaceDefinition, L extends PropertyKeys<Q>, R extends boolean, S extends NullabilityAdherence> = Osdk.Instance<Q, ExtractOptions<R, S>, L>;
+type SingleOsdkResult<Q extends ObjectOrInterfaceDefinition, L extends PropertyKeys<Q> | (keyof RDPs & string), R extends boolean, S extends NullabilityAdherence, RDPs extends Record<string, SimplePropertyDef> = {}> = Osdk.Instance<Q, ExtractOptions<R, S>, PropertyKeys<Q> extends L ? PropertyKeys<Q> : PropertyKeys<Q> & L, {
+    [K in Extract<keyof RDPs, L>]: RDPs[K];
+}>;
 
 type OsdkObjectPrimaryKeyType<Q extends ObjectTypeDefinition> = PropertyValueWireToClient[CompileTimeMetadata<Q>["primaryKeyType"]];
 
@@ -591,13 +622,15 @@ type ValidToFrom<FROM extends ObjectOrInterfaceDefinition> = FROM extends Interf
 type IsNever<T> = [T] extends [never] ? true : false;
 type ExtractPropsKeysFromOldPropsStyle<Q extends ObjectOrInterfaceDefinition, P extends ValidOsdkPropParams<Q>> = P extends "$all" ? PropertyKeys<Q> : Exclude<P, "$strict" | "$notStrict" | "$rid">;
 type IsAny<T> = unknown extends T ? [keyof T] extends [never] ? false : true : false;
-type GetPropsKeys<Q extends ObjectOrInterfaceDefinition, P extends PropertyKeys<Q>> = IsNever<P> extends true ? PropertyKeys<Q> : IsAny<P> extends true ? PropertyKeys<Q> : P;
+type GetPropsKeys<Q extends ObjectOrInterfaceDefinition, P extends PropertyKeys<Q>, N extends boolean = false> = IsNever<P> extends true ? N extends true ? never : PropertyKeys<Q> : IsAny<P> extends true ? PropertyKeys<Q> : P;
 /**
  * Use `Osdk.Instance` or `YourType.OsdkInstance`
  */
 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>> = OsdkBase<Q> & Pick<CompileTimeMetadata<Q>["props"], GetPropsKeys<Q, P>> & {
+    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] ? {} : {
+        [A in keyof R]: SimplePropertyDef.ToRuntimeProperty<R[A]>;
+    }) & {
         readonly $link: Q extends {
             linksType?: any;
         } ? Q["linksType"] : Q extends ObjectTypeDefinition ? OsdkObjectLinksObject<Q> : never;
@@ -863,6 +896,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" | undefined : "double" | undefined : V extends "$count" ? "integer" | undefined : 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;
@@ -905,7 +971,11 @@ interface ObjectSetListenerOptions<O extends ObjectOrInterfaceDefinition, P exte
     properties?: Array<P>;
 }
 
-interface MinimalObjectSet<Q extends ObjectOrInterfaceDefinition> extends BaseObjectSet<Q> {
+type MergeObjectSet<Q extends ObjectOrInterfaceDefinition, D extends ObjectSet<Q> | Record<string, SimplePropertyDef> = {}> = D extends Record<string, SimplePropertyDef> ? ObjectOrInterfaceDefinition.WithDerivedProperties<Q, D> : Q;
+type ExtractRdp<D extends ObjectSet<any, any> | Record<string, SimplePropertyDef>> = D extends Record<string, SimplePropertyDef> ? D : {};
+interface MinimalObjectSet<Q extends ObjectOrInterfaceDefinition, RDPs extends Record<string, SimplePropertyDef> = {}> extends BaseObjectSet<Q>, FetchPage<Q, RDPs>, AsyncIter<Q, RDPs>, Where<Q, RDPs> {
+}
+interface FetchPage<Q extends ObjectOrInterfaceDefinition, RDPs extends Record<string, SimplePropertyDef> = {}> {
     /**
      * Gets a page of objects of this type, with a result wrapper
      * @param args - Args to specify next page token and page size, if applicable
@@ -918,7 +988,9 @@ interface MinimalObjectSet<Q extends ObjectOrInterfaceDefinition> extends BaseOb
   
      * @returns a page of objects
      */
-    readonly fetchPage: <L extends PropertyKeys<Q>, R extends boolean, const A extends Augments, S extends NullabilityAdherence = NullabilityAdherence.Default>(args?: FetchPageArgs<Q, L, R, A, S>) => Promise<PageResult<PropertyKeys<Q> extends L ? Osdk.Instance<Q, ExtractOptions<R, S>> : Osdk.Instance<Q, ExtractOptions<R, S>, L>>>;
+    readonly fetchPage: <L extends PropertyKeys<Q, RDPs>, R extends boolean, const A extends Augments, S extends NullabilityAdherence = NullabilityAdherence.Default>(args?: FetchPageArgs<Q, L, R, A, S>) => Promise<PageResult<Osdk.Instance<Q, ExtractOptions<R, S>, PropertyKeys<Q> extends L ? PropertyKeys<Q> : PropertyKeys<Q> & L, {
+        [K in Extract<keyof RDPs, L>]: RDPs[K];
+    }>>>;
     /**
      * Gets a page of objects of this type, with a result wrapper
      * @param args - Args to specify next page token and page size, if applicable
@@ -933,18 +1005,24 @@ interface MinimalObjectSet<Q extends ObjectOrInterfaceDefinition> extends BaseOb
       }
      * @returns a page of objects, wrapped in a result wrapper
      */
-    readonly fetchPageWithErrors: <L extends PropertyKeys<Q>, 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>, L>>>>;
+    readonly fetchPageWithErrors: <L extends PropertyKeys<Q, RDPs>, R extends boolean, const A extends Augments, S extends NullabilityAdherence = NullabilityAdherence.Default>(args?: FetchPageArgs<Q, L, R, A, S>) => Promise<Result<PageResult<Osdk.Instance<Q, ExtractOptions<R, S>, PropertyKeys<Q> extends L ? PropertyKeys<Q> : PropertyKeys<Q> & L, {
+        [K in Extract<keyof RDPs, L>]: RDPs[K];
+    }>>>>;
+}
+interface Where<Q extends ObjectOrInterfaceDefinition, RDPs extends Record<string, SimplePropertyDef> = {}> {
     /**
-     * Allows you to filter an object set with a given clause
-     * @param clause - Takes a filter clause
-     * @example
-     * await client(Office).where({
-        meetingRooms: { $contains: "Grand Central" },
-        meetingRoomCapacities: { $contains: 30 },
-    });
-     * @returns an objectSet
-     */
-    readonly where: (clause: WhereClause<Q>) => this;
+   * Allows you to filter an object set with a given clause
+   * @param clause - Takes a filter clause
+   * @example
+   * await client(Office).where({
+      meetingRooms: { $contains: "Grand Central" },
+      meetingRoomCapacities: { $contains: 30 },
+  });
+  * @returns an objectSet
+    */
+    readonly where: (clause: WhereClause<MergeObjectSet<Q, RDPs>>) => this;
+}
+interface AsyncIter<Q extends ObjectOrInterfaceDefinition, RDPs extends Record<string, SimplePropertyDef> = {}> {
     /**
      * Returns an async iterator to load all objects of this type
      * @example
@@ -953,9 +1031,20 @@ interface MinimalObjectSet<Q extends ObjectOrInterfaceDefinition> extends BaseOb
      * }
      * @returns an async iterator to load all objects
      */
-    readonly asyncIter: <L extends PropertyKeys<Q>, R extends boolean, const A extends Augments, S extends NullabilityAdherence = NullabilityAdherence.Default>(args?: AsyncIterArgs<Q, L, R, A, S>) => AsyncIterableIterator<SingleOsdkResult<Q, L, R, S>>;
+    readonly asyncIter: <L extends PropertyKeys<Q, RDPs>, R extends boolean, const A extends Augments, S extends NullabilityAdherence = NullabilityAdherence.Default>(args?: AsyncIterArgs<Q, L, R, A, S>) => AsyncIterableIterator<Osdk.Instance<Q, ExtractOptions<R, S>, PropertyKeys<Q> extends L ? PropertyKeys<Q> : PropertyKeys<Q> & L, {
+        [K in Extract<keyof RDPs, L>]: RDPs[K];
+    }>>;
+}
+interface WithProperties<Q extends ObjectOrInterfaceDefinition = any, RDPs extends Record<string, SimplePropertyDef> = {}> {
+    readonly withProperties: <NEW extends Record<string, SimplePropertyDef>>(clause: {
+        [K in keyof NEW]: DerivedProperty.Selector<Q, NEW[K]>;
+    }) => ObjectSet<Q, {
+        [NN in keyof NEW | keyof RDPs]: NN extends keyof NEW ? NEW[NN] : NN extends keyof RDPs ? RDPs[NN] : never;
+    }>;
+}
+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 ObjectSet<Q extends ObjectOrInterfaceDefinition = any, _UNUSED = any> extends MinimalObjectSet<Q> {
+interface Aggregate<Q extends ObjectOrInterfaceDefinition> {
     /**
      * Aggregate on a field in an object type
      * @param req - an aggregation request where you can select fields and choose how to aggregate, e.g., max, min, avg, and also choose
@@ -980,6 +1069,8 @@ interface ObjectSet<Q extends ObjectOrInterfaceDefinition = any, _UNUSED = any>
      * @returns aggregation results, sorted in the groups based on the groupBy clause (if applicable)
      */
     readonly aggregate: <AO extends AggregateOpts<Q>>(req: AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy<Q, AO>) => Promise<AggregationsResults<Q, AO>>;
+}
+interface SetArithmetic<Q extends ObjectOrInterfaceDefinition> {
     /**
      * Unions object sets together
      * @param objectSets - objectSets you want to union with
@@ -1010,20 +1101,30 @@ interface ObjectSet<Q extends ObjectOrInterfaceDefinition = any, _UNUSED = any>
      * @returns the subtract object set
      */
     readonly subtract: (...objectSets: ReadonlyArray<CompileTimeMetadata<Q>["objectSet"]>) => this;
+}
+interface PivotTo<Q extends ObjectOrInterfaceDefinition> {
     /**
      * Pivots the object set over to all its linked objects of the specified type
      * @param type - The linked object type you want to pivot to
      * @returns an object set of the specified linked type
      */
     readonly pivotTo: <L extends LinkNames<Q>>(type: L) => CompileTimeMetadata<LinkedType<Q, L>>["objectSet"];
+}
+interface FetchOne<Q extends ObjectOrInterfaceDefinition, RDPs extends Record<string, SimplePropertyDef>> {
     /**
      * Fetches one object with the specified primary key, without a result wrapper
      */
-    readonly fetchOne: Q extends ObjectTypeDefinition ? <const L extends PropertyKeys<Q>, const R extends boolean, const S extends false | "throw" = NullabilityAdherence.Default>(primaryKey: PrimaryKeyType<Q>, options?: SelectArg<Q, L, R, S>) => Promise<Osdk.Instance<Q, ExtractOptions<R, S>, L>> : never;
+    readonly fetchOne: Q extends ObjectTypeDefinition ? <const L extends PropertyKeys<Q, RDPs>, const R extends boolean, const S extends false | "throw" = NullabilityAdherence.Default>(primaryKey: PrimaryKeyType<Q>, options?: SelectArg<Q, L, R, S>) => Promise<Osdk.Instance<Q, ExtractOptions<R, S>, PropertyKeys<Q> extends L ? PropertyKeys<Q> : PropertyKeys<Q> & L, {
+        [K in Extract<keyof RDPs, L>]: RDPs[K];
+    }>> : never;
     /**
      * Fetches one object with the specified primary key, with a result wrapper
      */
-    readonly fetchOneWithErrors: Q extends ObjectTypeDefinition ? <L extends PropertyKeys<Q>, R extends boolean, S extends false | "throw" = NullabilityAdherence.Default>(primaryKey: PrimaryKeyType<Q>, options?: SelectArg<Q, L, R, S>) => Promise<Result<Osdk.Instance<Q, ExtractOptions<R, S>, L>>> : never;
+    readonly fetchOneWithErrors: Q extends ObjectTypeDefinition ? <L extends PropertyKeys<Q, RDPs>, R extends boolean, S extends false | "throw" = NullabilityAdherence.Default>(primaryKey: PrimaryKeyType<Q>, options?: SelectArg<Q, L, R, S>) => Promise<Result<Osdk.Instance<Q, ExtractOptions<R, S>, PropertyKeys<Q> extends L ? PropertyKeys<Q> : PropertyKeys<Q> & L, {
+        [K in Extract<keyof RDPs, L>]: RDPs[K];
+    }>>> : never;
+}
+interface Subscribe<Q extends ObjectOrInterfaceDefinition> {
     /**
      * Request updates when the objects in an object set are added, updated, or removed.
      * @param listener - The handlers to be executed during the lifecycle of the subscription.
@@ -1034,5 +1135,7 @@ interface ObjectSet<Q extends ObjectOrInterfaceDefinition = any, _UNUSED = any>
         unsubscribe: () => void;
     };
 }
+interface ObjectSetCleanedTypes<Q extends ObjectOrInterfaceDefinition, D extends Record<string, SimplePropertyDef>, MERGED extends ObjectOrInterfaceDefinition> extends MinimalObjectSet<Q, D>, WithProperties<Q, D>, Aggregate<MERGED>, SetArithmetic<MERGED>, PivotTo<MERGED>, FetchOne<Q, D>, Subscribe<MERGED> {
+}
 
-export { type PropertyDef 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, type ObjectSetListener as Q, type ReleaseStatus as R, type SingleLinkAccessor as S, type ObjectSetListenerOptions as T, type InterfaceMetadata as U, type ValidAggregationKeys as V, type WhereClause as W, type ObjectOrInterfaceDefinition as X, type PropertyKeys as Y, type CompileTimeMetadata as Z, ObjectMetadata as _, type AttachmentUpload as a, type VersionBound as a0, type SimpleWirePropertyTypes as a1, type WirePropertyTypes as a2, type PrimaryKeyType as a3, type ConvertProps as a4, Osdk as a5, type PageResult as a6, TimeseriesDurationMapping as a7, type GeotimeSeriesProperty as a8, type TimeSeriesPoint as a9, type TimeSeriesProperty as aa, type TimeSeriesQuery as ab, type LinkedType as ac, type LinkNames as ad, type ExtractOptions as ae, type MinimalObjectSet as af, 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 };
+export { ObjectMetadata 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, type ObjectSetListener as T, type ObjectSetListenerOptions as U, type ValidAggregationKeys as V, type WhereClause as W, type InterfaceMetadata as X, ObjectOrInterfaceDefinition as Y, type PropertyKeys as Z, type CompileTimeMetadata as _, type AttachmentUpload as a, type PropertyDef as a0, type VersionBound as a1, type SimpleWirePropertyTypes as a2, type WirePropertyTypes as a3, type PrimaryKeyType as a4, type ConvertProps as a5, Osdk as a6, type PageResult as a7, TimeseriesDurationMapping as a8, type GeotimeSeriesProperty as a9, type TimeSeriesPoint as aa, type TimeSeriesProperty as ab, type TimeSeriesQuery as ac, type LinkedType as ad, type LinkNames as ae, type ExtractOptions as af, type MinimalObjectSet as ag, 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.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/aggregate/WhereClause.ts","../../src/mapping/DurationMapping.ts","../../src/groupby/GroupByClause.ts","../../src/object/Result.ts","../../src/timeseries/timeseries.ts"],"names":[],"mappings":";;;AAkBO,IAAM,mBAAsB,GAAA;AAAA,EACjC,YAAc,EAAA,aAAA;AAAA,EACd,aAAe,EAAA,aAAA;AAAA,EACf,IAAM,EAAA,aAAA;AAAA,EACN,OAAS,EAAA,QAAA;AAAA,EACT,QAAU,EAAA,QAAA;AAAA,EACV,GAAK,EAAA,QAAA;AAAA,EACL,WAAa,EAAA,YAAA;AAAA,EACb,YAAc,EAAA,YAAA;AAAA,EACd,IAAM,EAAA,YAAA;AAAA,EACN,MAAQ,EAAA,QAAA;AAAA,EACR,QAAU,EAAA,QAAA;AAAA,EACV,MAAQ,EAAA,MAAA;AAAA,EACR,MAAQ,EAAA,MAAA;AAAA,EACR,MAAQ,EAAA,OAAA;AAAA,EACR,OAAS,EAAA,OAAA;AAAA,EACT,MAAQ,EAAA,OAAA;AAAA,EACR,OAAS,EAAA,OAAA;AAAA,EACT,eAAiB,EAAA,gBAAA;AAAA,EACjB,cAAgB,EAAA,gBAAA;AAAA,EAChB,gBAAkB,EAAA,gBAAA;AACpB,EAAA;;;ACvBO,IAAM,mBAAsB,GAAA;AAAA,EACjC,KAAO,EAAA,SAAA;AAAA,EACP,SAAW,EAAA,SAAA;AAAA,EACX,KAAO,EAAA,SAAA;AAAA,EACP,QAAU,EAAA,SAAA;AAAA,EACV,SAAW,EAAA,SAAA;AAAA,EACX,IAAM,EAAA,OAAA;AAAA,EACN,KAAO,EAAA,OAAA;AAAA,EACP,MAAQ,EAAA,OAAA;AAAA,EACR,OAAS,EAAA,OAAA;AAAA,EACT,KAAO,EAAA,MAAA;AAAA,EACP,MAAQ,EAAA,MAAA;AAAA,EACR,IAAM,EAAA,OAAA;AAAA,EACN,MAAQ,EAAA,OAAA;AAAA,EACR,OAAS,EAAA,OAAA;AAAA,EACT,KAAO,EAAA,QAAA;AAAA,EACP,OAAS,EAAA,QAAA;AAAA,EACT,QAAU,EAAA,QAAA;AAAA,EACV,IAAM,EAAA,OAAA;AAAA,EACN,MAAQ,EAAA,OAAA;AAAA,EACR,OAAS,EAAA,OAAA;AACX,CAAA,CAAA;;;ACpBO,IAAM,eAAkB,GAAA;AAAA,EAC7B,GAAG,mBAAA;AAAA,EACH,SAAW,EAAA,UAAA;AAAA,EACX,UAAY,EAAA,UAAA;AACd,EAAA;;;ACAO,SAAS,KAAK,CAAG,EAAA;AACtB,EAAA,OAAO,OAAW,IAAA,CAAA,CAAA;AACpB,CAAA;;;ACNO,IAAM,yBAA4B,GAAA;AAAA,EACvC,IAAM,EAAA,cAAA;AAAA,EACN,cAAgB,EAAA,cAAA;AAAA,EAChB,GAAG,mBAAA;AACL","file":"index.cjs","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\n// the value side of this needs to match DistanceUnit from @osdk/internal.foundry but we don't\n// want the dependency\nexport const DistanceUnitMapping = {\n  \"centimeter\": \"CENTIMETERS\",\n  \"centimeters\": \"CENTIMETERS\",\n  \"cm\": \"CENTIMETERS\",\n  \"meter\": \"METERS\",\n  \"meters\": \"METERS\",\n  \"m\": \"METERS\",\n  \"kilometer\": \"KILOMETERS\",\n  \"kilometers\": \"KILOMETERS\",\n  \"km\": \"KILOMETERS\",\n  \"inch\": \"INCHES\",\n  \"inches\": \"INCHES\",\n  \"foot\": \"FEET\",\n  \"feet\": \"FEET\",\n  \"yard\": \"YARDS\",\n  \"yards\": \"YARDS\",\n  \"mile\": \"MILES\",\n  \"miles\": \"MILES\",\n  \"nautical_mile\": \"NAUTICAL_MILES\",\n  \"nauticalMile\": \"NAUTICAL_MILES\",\n  \"nautical miles\": \"NAUTICAL_MILES\"\n};\n\n// FIXME we need to represent all types","/*\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 TimeDurationMapping = {\n  \"sec\": \"SECONDS\",\n  \"seconds\": \"SECONDS\",\n  \"min\": \"MINUTES\",\n  \"minute\": \"MINUTES\",\n  \"minutes\": \"MINUTES\",\n  \"hr\": \"HOURS\",\n  \"hrs\": \"HOURS\",\n  \"hour\": \"HOURS\",\n  \"hours\": \"HOURS\",\n  \"day\": \"DAYS\",\n  \"days\": \"DAYS\",\n  \"wk\": \"WEEKS\",\n  \"week\": \"WEEKS\",\n  \"weeks\": \"WEEKS\",\n  \"mos\": \"MONTHS\",\n  \"month\": \"MONTHS\",\n  \"months\": \"MONTHS\",\n  \"yr\": \"YEARS\",\n  \"year\": \"YEARS\",\n  \"years\": \"YEARS\"\n};","/*\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 { TimeDurationMapping } from \"../mapping/DurationMapping.js\";\nexport const DurationMapping = {\n  ...TimeDurationMapping,\n  \"quarter\": \"QUARTERS\",\n  \"quarters\": \"QUARTERS\"\n};","/*\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\n/**\n * Check if a result was successfully received\n * @param a - result wrapped value\n * @returns whether a result has a value in it\n */\nexport function isOk(a) {\n  return \"value\" in a;\n}\n\n/**\n * Check if a result contains an error value\n * @param a Result wrapped value\n * @returns whether a result has an error in it\n */\nexport function isError(a) {\n  return \"error\" in a;\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\nimport { TimeDurationMapping } from \"../mapping/DurationMapping.js\";\nexport const TimeseriesDurationMapping = {\n  \"ms\": \"MILLISECONDS\",\n  \"milliseconds\": \"MILLISECONDS\",\n  ...TimeDurationMapping\n};"]}
+{"version":3,"sources":["../../src/aggregate/WhereClause.ts","../../src/mapping/DurationMapping.ts","../../src/groupby/GroupByClause.ts","../../src/object/Result.ts","../../src/timeseries/timeseries.ts"],"names":[],"mappings":";;;AAkBO,IAAM,mBAAsB,GAAA;AAAA,EACjC,YAAc,EAAA,aAAA;AAAA,EACd,aAAe,EAAA,aAAA;AAAA,EACf,IAAM,EAAA,aAAA;AAAA,EACN,OAAS,EAAA,QAAA;AAAA,EACT,QAAU,EAAA,QAAA;AAAA,EACV,GAAK,EAAA,QAAA;AAAA,EACL,WAAa,EAAA,YAAA;AAAA,EACb,YAAc,EAAA,YAAA;AAAA,EACd,IAAM,EAAA,YAAA;AAAA,EACN,MAAQ,EAAA,QAAA;AAAA,EACR,QAAU,EAAA,QAAA;AAAA,EACV,MAAQ,EAAA,MAAA;AAAA,EACR,MAAQ,EAAA,MAAA;AAAA,EACR,MAAQ,EAAA,OAAA;AAAA,EACR,OAAS,EAAA,OAAA;AAAA,EACT,MAAQ,EAAA,OAAA;AAAA,EACR,OAAS,EAAA,OAAA;AAAA,EACT,eAAiB,EAAA,gBAAA;AAAA,EACjB,cAAgB,EAAA,gBAAA;AAAA,EAChB,gBAAkB,EAAA;AACpB;;;ACvBO,IAAM,mBAAsB,GAAA;AAAA,EACjC,KAAO,EAAA,SAAA;AAAA,EACP,SAAW,EAAA,SAAA;AAAA,EACX,KAAO,EAAA,SAAA;AAAA,EACP,QAAU,EAAA,SAAA;AAAA,EACV,SAAW,EAAA,SAAA;AAAA,EACX,IAAM,EAAA,OAAA;AAAA,EACN,KAAO,EAAA,OAAA;AAAA,EACP,MAAQ,EAAA,OAAA;AAAA,EACR,OAAS,EAAA,OAAA;AAAA,EACT,KAAO,EAAA,MAAA;AAAA,EACP,MAAQ,EAAA,MAAA;AAAA,EACR,IAAM,EAAA,OAAA;AAAA,EACN,MAAQ,EAAA,OAAA;AAAA,EACR,OAAS,EAAA,OAAA;AAAA,EACT,KAAO,EAAA,QAAA;AAAA,EACP,OAAS,EAAA,QAAA;AAAA,EACT,QAAU,EAAA,QAAA;AAAA,EACV,IAAM,EAAA,OAAA;AAAA,EACN,MAAQ,EAAA,OAAA;AAAA,EACR,OAAS,EAAA;AACX,CAAA;;;ACpBO,IAAM,eAAkB,GAAA;AAAA,EAC7B,GAAG,mBAAA;AAAA,EACH,SAAW,EAAA,UAAA;AAAA,EACX,UAAY,EAAA;AACd;;;ACAO,SAAS,KAAK,CAAG,EAAA;AACtB,EAAA,OAAO,OAAW,IAAA,CAAA;AACpB;;;ACNO,IAAM,yBAA4B,GAAA;AAAA,EACvC,IAAM,EAAA,cAAA;AAAA,EACN,cAAgB,EAAA,cAAA;AAAA,EAChB,GAAG;AACL","file":"index.cjs","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\n// the value side of this needs to match DistanceUnit from @osdk/internal.foundry but we don't\n// want the dependency\nexport const DistanceUnitMapping = {\n  \"centimeter\": \"CENTIMETERS\",\n  \"centimeters\": \"CENTIMETERS\",\n  \"cm\": \"CENTIMETERS\",\n  \"meter\": \"METERS\",\n  \"meters\": \"METERS\",\n  \"m\": \"METERS\",\n  \"kilometer\": \"KILOMETERS\",\n  \"kilometers\": \"KILOMETERS\",\n  \"km\": \"KILOMETERS\",\n  \"inch\": \"INCHES\",\n  \"inches\": \"INCHES\",\n  \"foot\": \"FEET\",\n  \"feet\": \"FEET\",\n  \"yard\": \"YARDS\",\n  \"yards\": \"YARDS\",\n  \"mile\": \"MILES\",\n  \"miles\": \"MILES\",\n  \"nautical_mile\": \"NAUTICAL_MILES\",\n  \"nauticalMile\": \"NAUTICAL_MILES\",\n  \"nautical miles\": \"NAUTICAL_MILES\"\n};\n\n// FIXME we need to represent all types","/*\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 TimeDurationMapping = {\n  \"sec\": \"SECONDS\",\n  \"seconds\": \"SECONDS\",\n  \"min\": \"MINUTES\",\n  \"minute\": \"MINUTES\",\n  \"minutes\": \"MINUTES\",\n  \"hr\": \"HOURS\",\n  \"hrs\": \"HOURS\",\n  \"hour\": \"HOURS\",\n  \"hours\": \"HOURS\",\n  \"day\": \"DAYS\",\n  \"days\": \"DAYS\",\n  \"wk\": \"WEEKS\",\n  \"week\": \"WEEKS\",\n  \"weeks\": \"WEEKS\",\n  \"mos\": \"MONTHS\",\n  \"month\": \"MONTHS\",\n  \"months\": \"MONTHS\",\n  \"yr\": \"YEARS\",\n  \"year\": \"YEARS\",\n  \"years\": \"YEARS\"\n};","/*\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 { TimeDurationMapping } from \"../mapping/DurationMapping.js\";\nexport const DurationMapping = {\n  ...TimeDurationMapping,\n  \"quarter\": \"QUARTERS\",\n  \"quarters\": \"QUARTERS\"\n};","/*\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\n/**\n * Check if a result was successfully received\n * @param a - result wrapped value\n * @returns whether a result has a value in it\n */\nexport function isOk(a) {\n  return \"value\" in a;\n}\n\n/**\n * Check if a result contains an error value\n * @param a Result wrapped value\n * @returns whether a result has an error in it\n */\nexport function isError(a) {\n  return \"error\" in a;\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\nimport { TimeDurationMapping } from \"../mapping/DurationMapping.js\";\nexport const TimeseriesDurationMapping = {\n  \"ms\": \"MILLISECONDS\",\n  \"milliseconds\": \"MILLISECONDS\",\n  ...TimeDurationMapping\n};"]}

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-BjJpOctW.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, Z as CompileTimeMetadata, a4 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, a8 as GeotimeSeriesProperty, t as GroupByClause, u as GroupByRange, U as InterfaceMetadata, ad as LinkNames, ac as LinkedType, E as Media, H as MediaMetadata, N as NullabilityAdherence, _ as ObjectMetadata, X as ObjectOrInterfaceDefinition, Q as ObjectSetListener, T as ObjectSetListenerOptions, a5 as Osdk, q as OsdkObjectLinksObject, p as OsdkObjectPropertyType, a6 as PageResult, o as PossibleWhereClauseFilters, a3 as PrimaryKeyType, $ as PropertyDef, Y as PropertyKeys, K as Result, y as SelectArg, z as SelectArgToKeys, a1 as SimpleWirePropertyTypes, S as SingleLinkAccessor, C as SingleOsdkResult, a9 as TimeSeriesPoint, aa as TimeSeriesProperty, ab as TimeSeriesQuery, a7 as TimeseriesDurationMapping, V as ValidAggregationKeys, a0 as VersionBound, W as WhereClause, a2 as WirePropertyTypes, J as isOk } from './ObjectSet-BjJpOctW.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 './ObjectSet-0c-4-xgY.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, _ as CompileTimeMetadata, a5 as ConvertProps, r as DerivedProperty, D as DistanceUnitMapping, s as DurationMapping, F as FetchPageArgs, C as FetchPageResult, G as GeoFilterOptions, m as GeoFilter_Intersects, n as GeoFilter_Within, a9 as GeotimeSeriesProperty, u as GroupByClause, v as GroupByRange, X as InterfaceMetadata, ae as LinkNames, ad as LinkedType, H as Media, J as MediaMetadata, N as NullabilityAdherence, $ as ObjectMetadata, Y as ObjectOrInterfaceDefinition, T as ObjectSetListener, U as ObjectSetListenerOptions, a6 as Osdk, q as OsdkObjectLinksObject, p as OsdkObjectPropertyType, a7 as PageResult, o as PossibleWhereClauseFilters, a4 as PrimaryKeyType, a0 as PropertyDef, Z as PropertyKeys, L as Result, z as SelectArg, B as SelectArgToKeys, a2 as SimpleWirePropertyTypes, S as SingleLinkAccessor, E as SingleOsdkResult, aa as TimeSeriesPoint, ab as TimeSeriesProperty, ac as TimeSeriesQuery, a8 as TimeseriesDurationMapping, V as ValidAggregationKeys, a1 as VersionBound, W as WhereClause, a3 as WirePropertyTypes, K as isOk } from './ObjectSet-0c-4-xgY.cjs';
 import 'type-fest';
 import 'geojson';
 

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

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/experimental/createMediaReference.ts","../../../src/experimental/fetchOneByRid.ts","../../../src/experimental/getBulkLinks.ts","../../../src/experimental/subscribe.ts"],"names":[],"mappings":";;;AA6BO,IAAM,uDAA0D,GAAA;AAAA,EACrE,IAAM,EAAA,yDAAA;AAAA,EACN,IAAM,EAAA,YAAA;AAAA,EACN,OAAS,EAAA,OAAA;AACX,EAAA;;;ACjBO,IAAM,gDAAmD,GAAA;AAAA,EAC9D,IAAM,EAAA,kDAAA;AAAA,EACN,IAAM,EAAA,YAAA;AAAA,EACN,OAAS,EAAA,OAAA;AACX,EAAA;;;ACJO,IAAM,+CAAkD,GAAA;AAAA,EAC7D,IAAM,EAAA,iDAAA;AAAA,EACN,IAAM,EAAA,YAAA;AAAA,EACN,OAAS,EAAA,OAAA;AACX,EAAA;;;ACJO,IAAM,2CAA8C,GAAA;AAAA,EACzD,IAAM,EAAA,6CAAA;AAAA,EACN,IAAM,EAAA,YAAA;AAAA,EACN,OAAS,EAAA,OAAA;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};","/*\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_subscribe = {\n  name: \"__EXPERIMENTAL__NOT_SUPPORTED_YET_subscribe\",\n  type: \"experiment\",\n  version: \"2.1.0\"\n};"]}
+{"version":3,"sources":["../../../src/experimental/createMediaReference.ts","../../../src/experimental/fetchOneByRid.ts","../../../src/experimental/getBulkLinks.ts","../../../src/experimental/subscribe.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;;;ACJO,IAAM,2CAA8C,GAAA;AAAA,EACzD,IAAM,EAAA,6CAAA;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};","/*\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_subscribe = {\n  name: \"__EXPERIMENTAL__NOT_SUPPORTED_YET_subscribe\",\n  type: \"experiment\",\n  version: \"2.1.0\"\n};"]}

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

@@ -1,5 +1,5 @@
-import { M as MediaReference, O as ObjectTypeDefinition, Y as PropertyKeys, N as NullabilityAdherence, y as SelectArg, a5 as Osdk, ae as ExtractOptions, b as OsdkBase, X as ObjectOrInterfaceDefinition, d as ObjectSet, Q as ObjectSetListener, T as ObjectSetListenerOptions } from '../ObjectSet-BjJpOctW.cjs';
-export { af as MinimalObjectSet } from '../ObjectSet-BjJpOctW.cjs';
+import { M as MediaReference, O as ObjectTypeDefinition, Z as PropertyKeys, N as NullabilityAdherence, z as SelectArg, a6 as Osdk, af as ExtractOptions, b as OsdkBase, Y as ObjectOrInterfaceDefinition, d as ObjectSet, T as ObjectSetListener, U as ObjectSetListenerOptions } from '../ObjectSet-0c-4-xgY.cjs';
+export { ag as MinimalObjectSet } from '../ObjectSet-0c-4-xgY.cjs';
 import 'type-fest';
 import 'geojson';
 

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 { 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> = IsNever<P> extends true ? 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  > =\n    & OsdkBase<Q>\n    & Pick<\n      CompileTimeMetadata<Q>[\"props\"],\n      GetPropsKeys<Q, P>\n    >\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;AA8EA;AACA;AACA;AACA;AACA;AAuBA;AAMA;AACA;AACA;AACA;AAgCA;AACA;AACA;AAFA,WAsBiBA,IAAI;AAyCrB;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> = 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":[]}

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  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> = number extends T ? NumericAggregateOption\n  : string extends T ? StringAggregateOption\n  : never;\n\nexport type ValidAggregationKeys<\n  Q extends ObjectOrInterfaceDefinition,\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      >}`\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  : 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\"\n        ? \"integer\" | undefined\n      : \"double\" | undefined\n      : V extends \"$count\" ? \"integer\" | undefined\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

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=WithPropertiesAggregationOptions.js.map

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

@@ -0,0 +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":[]}

package/build/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["DistanceUnitMapping","DurationMapping","isOk","TimeseriesDurationMapping"],"sources":["index.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\nexport type { ActionReturnTypeForOptions } from \"./actions/ActionReturnTypeForOptions.js\";\nexport type {\n  ActionEditResponse,\n  ActionParam,\n  ActionValidationResponse,\n  ApplyActionOptions,\n  ApplyBatchActionOptions,\n} from \"./actions/Actions.js\";\nexport type { ValidAggregationKeys } from \"./aggregate/AggregatableKeys.js\";\nexport type { AggregateOpts } from \"./aggregate/AggregateOpts.js\";\nexport type { AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy } from \"./aggregate/AggregateOptsThatErrors.js\";\nexport type { AggregationResultsWithGroups } from \"./aggregate/AggregationResultsWithGroups.js\";\nexport type { AggregationResultsWithoutGroups } from \"./aggregate/AggregationResultsWithoutGroups.js\";\nexport type { AggregationClause } from \"./aggregate/AggregationsClause.js\";\nexport type { AggregationsResults } from \"./aggregate/AggregationsResults.js\";\nexport type { GeoFilterOptions } from \"./aggregate/GeoFilter.js\";\nexport { DistanceUnitMapping } from \"./aggregate/WhereClause.js\";\nexport type {\n  GeoFilter_Intersects,\n  GeoFilter_Within,\n  PossibleWhereClauseFilters,\n  WhereClause,\n} from \"./aggregate/WhereClause.js\";\nexport type { OsdkObjectPropertyType } from \"./Definitions.js\";\nexport type {\n  OsdkObjectLinksObject,\n  SingleLinkAccessor,\n} from \"./definitions/LinkDefinitions.js\";\nexport { DurationMapping } from \"./groupby/GroupByClause.js\";\nexport type {\n  AllGroupByValues,\n  GroupByClause,\n  GroupByRange,\n} from \"./groupby/GroupByClause.js\";\nexport type {\n  AllowedBucketKeyTypes,\n  AllowedBucketTypes,\n  DataValueClientToWire,\n  DataValueWireToClient,\n} from \"./mapping/DataValueMapping.js\";\nexport type {\n  PropertyValueWireToClient,\n} from \"./mapping/PropertyValueMapping.js\";\nexport type { Attachment, AttachmentUpload } from \"./object/Attachment.js\";\nexport type {\n  AsyncIterArgs,\n  Augment,\n  Augments,\n  FetchPageArgs,\n  NullabilityAdherence,\n  SelectArg,\n  SelectArgToKeys,\n} from \"./object/FetchPageArgs.js\";\nexport type {\n  FetchPageResult,\n  SingleOsdkResult,\n} from \"./object/FetchPageResult.js\";\nexport type { Media, MediaMetadata, MediaReference } from \"./object/Media.js\";\nexport { isOk } from \"./object/Result.js\";\nexport type { Result } from \"./object/Result.js\";\nexport type { BaseObjectSet } from \"./objectSet/BaseObjectSet.js\";\nexport type { ObjectSet } from \"./objectSet/ObjectSet.js\";\nexport type { ObjectSetListener } from \"./objectSet/ObjectSetListener.js\";\nexport type { ObjectSetListenerOptions } from \"./objectSet/ObjectSetListener.js\";\nexport type {\n  ActionDefinition,\n  ActionMetadata,\n  ValidBaseActionParameterTypes,\n} from \"./ontology/ActionDefinition.js\";\nexport type {\n  InterfaceDefinition,\n  InterfaceMetadata,\n} from \"./ontology/InterfaceDefinition.js\";\nexport type {\n  ObjectOrInterfaceDefinition,\n  PropertyKeys,\n} from \"./ontology/ObjectOrInterface.js\";\nexport type {\n  CompileTimeMetadata,\n  ObjectMetadata,\n  ObjectTypeDefinition,\n  PropertyDef,\n  VersionBound,\n} from \"./ontology/ObjectTypeDefinition.js\";\nexport type { OntologyMetadata } from \"./ontology/OntologyMetadata.js\";\nexport type { PrimaryKeyTypes } from \"./ontology/PrimaryKeyTypes.js\";\nexport type {\n  ObjectQueryDataType,\n  ObjectSetQueryDataType,\n  QueryDataTypeDefinition,\n  QueryDefinition,\n  QueryMetadata,\n  QueryParameterDefinition,\n  ThreeDimensionalQueryAggregationDefinition,\n  TwoDimensionalQueryAggregationDefinition,\n} from \"./ontology/QueryDefinition.js\";\nexport type {\n  SimpleWirePropertyTypes,\n  WirePropertyTypes,\n} from \"./ontology/WirePropertyTypes.js\";\nexport type { OsdkBase, PrimaryKeyType } from \"./OsdkBase.js\";\nexport type { OsdkObject } from \"./OsdkObject.js\";\nexport type { ConvertProps, Osdk } from \"./OsdkObjectFrom.js\";\nexport type { PageResult } from \"./PageResult.js\";\nexport type { QueryParam, QueryResult } from \"./queries/Queries.js\";\nexport { TimeseriesDurationMapping } from \"./timeseries/timeseries.js\";\nexport type {\n  GeotimeSeriesProperty,\n  TimeSeriesPoint,\n  TimeSeriesProperty,\n  TimeSeriesQuery,\n} from \"./timeseries/timeseries.js\";\nexport type { LinkedType, LinkNames } from \"./util/LinkUtils.js\";\n\nexport {};\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAkBA,SAASA,mBAAmB,QAAQ,4BAA4B;AAYhE,SAASC,eAAe,QAAQ,4BAA4B;AA8B5D,SAASC,IAAI,QAAQ,oBAAoB;AA+CzC,SAASC,yBAAyB,QAAQ,4BAA4B;AAStE","ignoreList":[]}
+{"version":3,"file":"index.js","names":["DistanceUnitMapping","DurationMapping","isOk","TimeseriesDurationMapping"],"sources":["index.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\nexport type { ActionReturnTypeForOptions } from \"./actions/ActionReturnTypeForOptions.js\";\nexport type {\n  ActionEditResponse,\n  ActionParam,\n  ActionValidationResponse,\n  ApplyActionOptions,\n  ApplyBatchActionOptions,\n} from \"./actions/Actions.js\";\nexport type { ValidAggregationKeys } from \"./aggregate/AggregatableKeys.js\";\nexport type { AggregateOpts } from \"./aggregate/AggregateOpts.js\";\nexport type { AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy } from \"./aggregate/AggregateOptsThatErrors.js\";\nexport type { AggregationResultsWithGroups } from \"./aggregate/AggregationResultsWithGroups.js\";\nexport type { AggregationResultsWithoutGroups } from \"./aggregate/AggregationResultsWithoutGroups.js\";\nexport type { AggregationClause } from \"./aggregate/AggregationsClause.js\";\nexport type { AggregationsResults } from \"./aggregate/AggregationsResults.js\";\nexport type { GeoFilterOptions } from \"./aggregate/GeoFilter.js\";\nexport { DistanceUnitMapping } from \"./aggregate/WhereClause.js\";\nexport type {\n  GeoFilter_Intersects,\n  GeoFilter_Within,\n  PossibleWhereClauseFilters,\n  WhereClause,\n} from \"./aggregate/WhereClause.js\";\nexport type { OsdkObjectPropertyType } from \"./Definitions.js\";\nexport type {\n  OsdkObjectLinksObject,\n  SingleLinkAccessor,\n} from \"./definitions/LinkDefinitions.js\";\nexport type { DerivedProperty } from \"./derivedProperties/DerivedProperty.js\";\nexport { DurationMapping } from \"./groupby/GroupByClause.js\";\nexport type {\n  AllGroupByValues,\n  GroupByClause,\n  GroupByRange,\n} from \"./groupby/GroupByClause.js\";\nexport type {\n  AllowedBucketKeyTypes,\n  AllowedBucketTypes,\n  DataValueClientToWire,\n  DataValueWireToClient,\n} from \"./mapping/DataValueMapping.js\";\nexport type {\n  PropertyValueWireToClient,\n} from \"./mapping/PropertyValueMapping.js\";\nexport type { Attachment, AttachmentUpload } from \"./object/Attachment.js\";\nexport type {\n  AsyncIterArgs,\n  Augment,\n  Augments,\n  FetchPageArgs,\n  NullabilityAdherence,\n  SelectArg,\n  SelectArgToKeys,\n} from \"./object/FetchPageArgs.js\";\nexport type {\n  FetchPageResult,\n  SingleOsdkResult,\n} from \"./object/FetchPageResult.js\";\nexport type { Media, MediaMetadata, MediaReference } from \"./object/Media.js\";\nexport { isOk } from \"./object/Result.js\";\nexport type { Result } from \"./object/Result.js\";\nexport type { BaseObjectSet } from \"./objectSet/BaseObjectSet.js\";\nexport type { ObjectSet } from \"./objectSet/ObjectSet.js\";\nexport type { ObjectSetListener } from \"./objectSet/ObjectSetListener.js\";\nexport type { ObjectSetListenerOptions } from \"./objectSet/ObjectSetListener.js\";\nexport type {\n  ActionDefinition,\n  ActionMetadata,\n  ValidBaseActionParameterTypes,\n} from \"./ontology/ActionDefinition.js\";\nexport type {\n  InterfaceDefinition,\n  InterfaceMetadata,\n} from \"./ontology/InterfaceDefinition.js\";\nexport type {\n  ObjectOrInterfaceDefinition,\n  PropertyKeys,\n} from \"./ontology/ObjectOrInterface.js\";\nexport type {\n  CompileTimeMetadata,\n  ObjectMetadata,\n  ObjectTypeDefinition,\n  PropertyDef,\n  VersionBound,\n} from \"./ontology/ObjectTypeDefinition.js\";\nexport type { OntologyMetadata } from \"./ontology/OntologyMetadata.js\";\nexport type { PrimaryKeyTypes } from \"./ontology/PrimaryKeyTypes.js\";\nexport type {\n  ObjectQueryDataType,\n  ObjectSetQueryDataType,\n  QueryDataTypeDefinition,\n  QueryDefinition,\n  QueryMetadata,\n  QueryParameterDefinition,\n  ThreeDimensionalQueryAggregationDefinition,\n  TwoDimensionalQueryAggregationDefinition,\n} from \"./ontology/QueryDefinition.js\";\nexport type {\n  SimpleWirePropertyTypes,\n  WirePropertyTypes,\n} from \"./ontology/WirePropertyTypes.js\";\nexport type { OsdkBase, PrimaryKeyType } from \"./OsdkBase.js\";\nexport type { OsdkObject } from \"./OsdkObject.js\";\nexport type { ConvertProps, Osdk } from \"./OsdkObjectFrom.js\";\nexport type { PageResult } from \"./PageResult.js\";\nexport type { QueryParam, QueryResult } from \"./queries/Queries.js\";\nexport { TimeseriesDurationMapping } from \"./timeseries/timeseries.js\";\nexport type {\n  GeotimeSeriesProperty,\n  TimeSeriesPoint,\n  TimeSeriesProperty,\n  TimeSeriesQuery,\n} from \"./timeseries/timeseries.js\";\nexport type { LinkedType, LinkNames } from \"./util/LinkUtils.js\";\n\nexport {};\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAkBA,SAASA,mBAAmB,QAAQ,4BAA4B;AAahE,SAASC,eAAe,QAAQ,4BAA4B;AA8B5D,SAASC,IAAI,QAAQ,oBAAoB;AA+CzC,SAASC,yBAAyB,QAAQ,4BAA4B;AAStE","ignoreList":[]}

package/build/esm/object/FetchPageResult.js.map

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

package/build/esm/objectSet/ObjectSet.js.map

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