RDP's in TS OSDK

.changeset/forty-eggs-check.md

@@ -0,0 +1,7 @@
+---
+"@osdk/shared.test": minor
+"@osdk/client": minor
+"@osdk/api": minor
+---
+
+Adds support for runtime derived properties

etc/api.report.api.md

@@ -593,6 +593,10 @@ export interface ObjectSet<Q extends ObjectOrInterfaceDefinition = any, _UNUSED
     };
     readonly subtract: (...objectSets: ReadonlyArray<CompileTimeMetadata<Q>["objectSet"]>) => this;
     readonly union: (...objectSets: ReadonlyArray<CompileTimeMetadata<Q>["objectSet"]>) => this;
+    // (undocumented)
+    readonly withProperties: <D extends WithPropertiesClause<Q>>(clause: D) => ObjectSetWithProperties<Q, {
+        [K in keyof D]: D[K] extends (baseObjectSet: any) => WithPropertyDefinition<infer P> ? PropertyDef<P["type"], "nullable", P["multiplicity"] extends true ? "array" : "single"> : never;
+    }>;
 }
 
 // @public (undocumented)
@@ -621,6 +625,11 @@ export interface ObjectSetQueryDataType<T_Target extends ObjectTypeDefinition =
     objectSet: string;
 }
 
+// Warning: (ae-forgotten-export) The symbol "WithPropertiesObjectDefinition" needs to be exported by the entry point index.d.ts
+//
+// @public (undocumented)
+export type ObjectSetWithProperties<Q extends ObjectOrInterfaceDefinition, D extends Record<string, PropertyDef<any, any, any>>> = ObjectSet<WithPropertiesObjectDefinition<Q, D>>;
+
 // @public (undocumented)
 export interface ObjectTypeDefinition {
     // (undocumented)
@@ -956,8 +965,8 @@ export type TwoDimensionalQueryAggregationDefinition = AggregationKeyDataType<"d
 // Warning: (ae-forgotten-export) The symbol "GetWirePropertyValueFromClient" needs to be exported by the entry point index.d.ts
 //
 // @public (undocumented)
-export type ValidAggregationKeys<Q extends ObjectOrInterfaceDefinition> = keyof ({
-    [KK in AggregatableKeys<Q> as `${KK & string}:${AGG_FOR_TYPE<GetWirePropertyValueFromClient<CompileTimeMetadata<Q>["properties"][KK]["type"]>>}`]?: any;
+export 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;
 });
@@ -983,10 +992,29 @@ export type WhereClause<T extends ObjectOrInterfaceDefinition> = OrWhereClause<T
 // @public (undocumented)
 export type WirePropertyTypes = SimpleWirePropertyTypes | Record<string, SimpleWirePropertyTypes>;
 
+// @public (undocumented)
+export type WithPropertiesClause<Q extends ObjectOrInterfaceDefinition> = {
+    [key: string]: (baseObjectSet: BaseWithPropertyObjectSet<Q>) => WithPropertyDefinition<ObjectMetadata.Property>;
+};
+
+// @public (undocumented)
+export type WithPropertyDefinition<T extends ObjectMetadata.Property> = {
+    definitionId: string;
+    type: T;
+};
+
+// Warning: (ae-forgotten-export) The symbol "AggregatableWithPropertyObjectSet" needs to be exported by the entry point index.d.ts
+// Warning: (ae-forgotten-export) The symbol "SingleLinkWithPropertyObjectSet" needs to be exported by the entry point index.d.ts
+//
+// @public (undocumented)
+export interface WithPropertyObjectSet<Q extends ObjectOrInterfaceDefinition> extends BaseWithPropertyObjectSet<Q>, AggregatableWithPropertyObjectSet<Q>, SingleLinkWithPropertyObjectSet<Q> {
+}
+
 // Warnings were encountered during analysis:
 //
 // src/aggregate/AggregateOpts.ts:26:3 - (ae-forgotten-export) The symbol "UnorderedAggregationClause" needs to be exported by the entry point index.d.ts
 // src/aggregate/AggregateOpts.ts:26:3 - (ae-forgotten-export) The symbol "OrderedAggregationClause" needs to be exported by the entry point index.d.ts
+// src/derivedProperties/WithPropertiesClause.ts:33:3 - (ae-forgotten-export) The symbol "BaseWithPropertyObjectSet" needs to be exported by the entry point index.d.ts
 
 // (No @packageDocumentation comment for this package)
 

packages/api/src/aggregate/AggregatableKeys.ts

@@ -14,6 +14,10 @@
  * limitations under the License.
  */
 
+import type {
+  NumericWithPropAggregateOption,
+  StringWithPropAggregateOption,
+} from "../derivedProperties/WithPropertyObjectSet.js";
 import type {
   GetWirePropertyValueFromClient,
 } from "../mapping/PropertyValueMapping.js";
@@ -32,19 +36,23 @@ export type NumericAggregateOption =
   | "approximateDistinct"
   | "exactDistinct";
 
-type AGG_FOR_TYPE<T> = number extends T ? NumericAggregateOption
-  : string extends T ? StringAggregateOption
+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;
 
 export 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;
   }

packages/api/src/derivedProperties/WithPropertiesClause.ts

@@ -0,0 +1,36 @@
+/*
+ * 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.
+ */
+
+import type {
+  ObjectOrInterfaceDefinition,
+} from "../ontology/ObjectOrInterface.js";
+import type { ObjectMetadata } from "../ontology/ObjectTypeDefinition.js";
+import type { BaseWithPropertyObjectSet } from "./WithPropertyObjectSet.js";
+
+export type WithPropertyDefinition<
+  T extends ObjectMetadata.Property,
+> = {
+  definitionId: string;
+  type: T;
+};
+
+export type WithPropertiesClause<
+  Q extends ObjectOrInterfaceDefinition,
+> = {
+  [key: string]: (
+    baseObjectSet: BaseWithPropertyObjectSet<Q>,
+  ) => WithPropertyDefinition<ObjectMetadata.Property>;
+};

packages/api/src/derivedProperties/WithPropertyObjectSet.ts

@@ -0,0 +1,130 @@
+/*
+ * 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.
+ */
+
+import type { ValidAggregationKeys } from "../aggregate/AggregatableKeys.js";
+import type { WhereClause } from "../aggregate/WhereClause.js";
+import type {
+  ObjectOrInterfaceDefinition,
+  PropertyKeys,
+} from "../ontology/ObjectOrInterface.js";
+import type {
+  CompileTimeMetadata,
+  PropertyDef,
+} from "../ontology/ObjectTypeDefinition.js";
+import type { LinkedType, LinkNames } from "../util/LinkUtils.js";
+import type { WithPropertyDefinition } from "./WithPropertiesClause.js";
+
+export interface WithPropertyObjectSet<Q extends ObjectOrInterfaceDefinition>
+  extends
+    BaseWithPropertyObjectSet<Q>,
+    AggregatableWithPropertyObjectSet<Q>,
+    SingleLinkWithPropertyObjectSet<Q>
+{}
+
+export interface BaseWithPropertyObjectSet<
+  Q extends ObjectOrInterfaceDefinition,
+> extends FilterableWithPropertyObjectSet<Q> {
+  readonly pivotTo: <L extends LinkNames<Q>>(
+    type: L,
+  ) => NonNullable<CompileTimeMetadata<Q>["links"][L]["multiplicity"]> extends
+    false ? SingleLinkWithPropertyObjectSet<LinkedType<Q, L>>
+    : ManyLinkWithPropertyObjectSet<LinkedType<Q, L>>;
+}
+
+interface FilterableWithPropertyObjectSet<
+  Q extends ObjectOrInterfaceDefinition,
+> {
+  readonly where: (
+    clause: WhereClause<Q>,
+  ) => this;
+}
+export type CollectWithPropAggregations = "collectSet" | "collectList";
+
+export type BaseWithPropAggregations =
+  | "approximateDistinct"
+  | "exactDistinct"
+  | "approximatePercentile";
+
+export type StringWithPropAggregateOption =
+  | BaseWithPropAggregations
+  | CollectWithPropAggregations;
+
+export type NumericWithPropAggregateOption =
+  | "min"
+  | "max"
+  | "sum"
+  | "avg"
+  | BaseWithPropAggregations
+  | CollectWithPropAggregations;
+
+interface AggregatableWithPropertyObjectSet<
+  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,
+  ) => WithPropertyDefinition<
+    V extends `${infer N}:${infer P}`
+      ? P extends CollectWithPropAggregations ? PropertyDef<
+          CompileTimeMetadata<Q>["properties"][N]["type"],
+          "nullable",
+          "array"
+        >
+      : P extends "approximateDistinct" | "exactDistinct" | "$count"
+        ? PropertyDef<"integer">
+      : PropertyDef<"double">
+      : V extends "$count" ? PropertyDef<"integer">
+      : never
+  >;
+}
+
+interface SingleLinkWithPropertyObjectSet<
+  Q extends ObjectOrInterfaceDefinition,
+> extends
+  AggregatableWithPropertyObjectSet<Q>,
+  FilterableWithPropertyObjectSet<Q>,
+  BaseWithPropertyObjectSet<Q>
+{
+  readonly selectProperty: <R extends PropertyKeys<Q>>(
+    propertyName: R,
+  ) => WithPropertyDefinition<CompileTimeMetadata<Q>["properties"][R]>;
+}
+
+/*
+ * The ManyLinkWithPropertyObjectSet overrides the pivotTo operation because once we traverse a single link,
+ * we cannot use the "selectProperty" operation again for the entire chain. The parent pivotTo class will create
+ * this object set once the user pivots to a many link/
+ */
+
+interface ManyLinkWithPropertyObjectSet<
+  Q extends ObjectOrInterfaceDefinition,
+> extends
+  AggregatableWithPropertyObjectSet<Q>,
+  FilterableWithPropertyObjectSet<Q>
+{
+  readonly pivotTo: <L extends LinkNames<Q>>(
+    type: L,
+  ) => ManyLinkWithPropertyObjectSet<LinkedType<Q, L>>;
+}

packages/api/src/index.ts

@@ -41,6 +41,13 @@ export type {
   OsdkObjectLinksObject,
   SingleLinkAccessor,
 } from "./definitions/LinkDefinitions.js";
+export type {
+  WithPropertiesClause,
+  WithPropertyDefinition,
+} from "./derivedProperties/WithPropertiesClause.js";
+export type {
+  WithPropertyObjectSet,
+} from "./derivedProperties/WithPropertyObjectSet.js";
 export { DurationMapping } from "./groupby/GroupByClause.js";
 export type {
   AllGroupByValues,
@@ -73,7 +80,10 @@ export type {
 export { isOk } from "./object/Result.js";
 export type { Result } from "./object/Result.js";
 export type { BaseObjectSet } from "./objectSet/BaseObjectSet.js";
-export type { ObjectSet } from "./objectSet/ObjectSet.js";
+export type {
+  ObjectSet,
+  ObjectSetWithProperties,
+} from "./objectSet/ObjectSet.js";
 export type { ObjectSetListener } from "./objectSet/ObjectSetListener.js";
 export type { ObjectSetListenerOptions } from "./objectSet/ObjectSetListener.js";
 export type {

packages/api/src/objectSet/ObjectSet.ts

@@ -18,6 +18,11 @@ import type { AggregateOpts } from "../aggregate/AggregateOpts.js";
 import type { AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy } from "../aggregate/AggregateOptsThatErrors.js";
 import type { AggregationsResults } from "../aggregate/AggregationsResults.js";
 import type { WhereClause } from "../aggregate/WhereClause.js";
+import type {
+  WithPropertiesClause,
+  WithPropertyDefinition,
+} from "../derivedProperties/WithPropertiesClause.js";
+import type { GetWirePropertyValueFromClient } from "../mapping/PropertyValueMapping.js";
 import type {
   AsyncIterArgs,
   Augments,
@@ -34,7 +39,9 @@ import type {
 } from "../ontology/ObjectOrInterface.js";
 import type {
   CompileTimeMetadata,
+  ObjectMetadata,
   ObjectTypeDefinition,
+  PropertyDef,
 } from "../ontology/ObjectTypeDefinition.js";
 import type { PrimaryKeyType } from "../OsdkBase.js";
 import type { ExtractOptions, Osdk } from "../OsdkObjectFrom.js";
@@ -254,4 +261,45 @@ export interface ObjectSet<
     listener: ObjectSetListener<Q, P>,
     opts?: ObjectSetListenerOptions<Q, P>,
   ) => { unsubscribe: () => void };
+
+  readonly withProperties: <
+    D extends WithPropertiesClause<Q>,
+  >(
+    clause: D,
+  ) => ObjectSetWithProperties<
+    Q,
+    {
+      [K in keyof D]: D[K] extends
+        (baseObjectSet: any) => WithPropertyDefinition<infer P> ? PropertyDef<
+          P["type"],
+          "nullable",
+          P["multiplicity"] extends true ? "array" : "single"
+        >
+        : never;
+    }
+  >;
 }
+
+export type ObjectSetWithProperties<
+  Q extends ObjectOrInterfaceDefinition,
+  D extends Record<string, PropertyDef<any, any, any>>,
+> = ObjectSet<WithPropertiesObjectDefinition<Q, D>>;
+
+type WithPropertiesObjectDefinition<
+  K extends ObjectOrInterfaceDefinition,
+  D extends Record<string, ObjectMetadata.Property>,
+> = {
+  __DefinitionMetadata: {
+    properties: {
+      [T in keyof D]: D[T];
+    };
+    props: {
+      [T in keyof D]: D[T] extends PropertyDef<infer A, any, any> ?
+          | GetWirePropertyValueFromClient<
+            A
+          >
+          | undefined
+        : never;
+    };
+  };
+} & K;