RDP's in TS OSDK

etc/api.report.api.md

@@ -948,13 +948,12 @@ export type TimeSeriesQuery = {
 // @public (undocumented)
 export type TwoDimensionalQueryAggregationDefinition = AggregationKeyDataType<"date" | "double" | "timestamp">;
 
-// Warning: (ae-forgotten-export) The symbol "StringAggregateOption" needs to be exported by the entry point index.d.ts
-// Warning: (ae-forgotten-export) The symbol "NumericAggregateOption" needs to be exported by the entry point index.d.ts
+// Warning: (ae-forgotten-export) The symbol "AGG_FOR_TYPE" needs to be exported by the entry point index.d.ts
 // Warning: (ae-forgotten-export) The symbol "PropertyValueClientToWire" needs to be exported by the entry point index.d.ts
 //
 // @public (undocumented)
-export type ValidAggregationKeys<Q extends ObjectOrInterfaceDefinition, StringOptions extends string = StringAggregateOption, NumericOptions extends string = NumericAggregateOption> = keyof ({
-    [KK in AggregatableKeys<Q> as `${KK & string}:${number extends PropertyValueClientToWire[CompileTimeMetadata<Q>["properties"][KK]["type"]] ? NumericOptions : string extends PropertyValueClientToWire[CompileTimeMetadata<Q>["properties"][KK]["type"]] ? StringOptions : never}`]?: any;
+export type ValidAggregationKeys<Q extends ObjectOrInterfaceDefinition, R extends "aggregate" | "withPropertiesAggregate" = "aggregate"> = keyof ({
+    [KK in AggregatableKeys<Q> as `${KK & string}:${AGG_FOR_TYPE<PropertyValueClientToWire[CompileTimeMetadata<Q>["properties"][KK]["type"]], R extends "aggregate" ? true : false>}`]?: any;
 } & {
     $count?: any;
 });
@@ -987,7 +986,7 @@ export type WithPropertiesClause<Q extends ObjectOrInterfaceDefinition> = {
 
 // @public (undocumented)
 export type WithPropertyDefinition<T extends ObjectMetadata.Property> = {
-    definitionId: unknown;
+    definitionId: string;
     type: T;
 };
 

packages/api/src/aggregate/AggregatableKeys.ts

@@ -14,6 +14,10 @@
  * limitations under the License.
  */
 
+import type {
+  NumericDeriveAggregateOption,
+  StringDeriveAggregateOption,
+} from "../derivedProperties/WithPropertyObjectSet.js";
 import type { PropertyValueClientToWire } from "../mapping/PropertyValueMapping.js";
 import type {
   ObjectOrInterfaceDefinition,
@@ -30,25 +34,24 @@ 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 : NumericDeriveAggregateOption
+  : string extends T
+    ? U extends true ? StringAggregateOption : StringDeriveAggregateOption
   : never;
 
 export type ValidAggregationKeys<
   Q extends ObjectOrInterfaceDefinition,
-  StringOptions extends string = StringAggregateOption,
-  NumericOptions extends string = NumericAggregateOption,
+  R extends "aggregate" | "withPropertiesAggregate" = "aggregate",
 > = keyof (
   & {
     [
-      KK in AggregatableKeys<Q> as `${KK & string}:${number extends
+      KK in AggregatableKeys<Q> as `${KK & string}:${AGG_FOR_TYPE<
         PropertyValueClientToWire[
           CompileTimeMetadata<Q>["properties"][KK]["type"]
-        ] ? NumericOptions
-        : string extends PropertyValueClientToWire[
-          CompileTimeMetadata<Q>["properties"][KK]["type"]
-        ] ? StringOptions
-        : never}`
+        ],
+        R extends "aggregate" ? true : false
+      >}`
     ]?: any;
   }
   & { $count?: any }

packages/api/src/derivedProperties/WithPropertiesClause.ts

@@ -19,14 +19,14 @@
 } from "../ontology/ObjectOrInterface.js";
 import type {
   ObjectMetadata,
   PropertyDef,
 } from "../ontology/ObjectTypeDefinition.js";
 import type { BaseWithPropertyObjectSet } from "./WithPropertyObjectSet.js";
 
 export type WithPropertyDefinition<
   T extends ObjectMetadata.Property,
 > = {
-  definitionId: unknown;
+  definitionId: string;
   type: T;
 };
 

packages/api/src/derivedProperties/WithPropertyObjectSet.ts

@@ -51,45 +51,43 @@ interface FilterableDeriveObjectSet<
     clause: WhereClause<Q>,
   ) => this;
 }
+export type CollectDeriveAggregations = "collectSet" | "collectList";
 
-type CollectAggregations = "collectSet" | "collectList";
-
-type BaseAggregations =
+export type BaseDeriveAggregations =
   | "approximateDistinct"
   | "exactDistinct"
   | "approximatePercentile";
 
-type StringDeriveAggregateOption =
-  | BaseAggregations
-  | CollectAggregations;
+export type StringDeriveAggregateOption =
+  | BaseDeriveAggregations
+  | CollectDeriveAggregations;
 
-type NumericDeriveAggregateOption =
+export type NumericDeriveAggregateOption =
   | "min"
   | "max"
   | "sum"
   | "avg"
-  | BaseAggregations
-  | CollectAggregations;
+  | BaseDeriveAggregations
+  | CollectDeriveAggregations;
 
 interface AggregatableWithPropertyObjectSet<
   Q extends ObjectOrInterfaceDefinition,
-> extends FilterableDeriveObjectSet<Q> {
+> {
   readonly aggregate: <
     V extends ValidAggregationKeys<
       Q,
-      StringDeriveAggregateOption,
-      NumericDeriveAggregateOption
+      "withPropertiesAggregate"
     >,
   >(
     aggregationSpecifier: V,
     opts?: V extends `${any}:${infer P}`
-      ? P extends CollectAggregations ? { limit: number }
+      ? P extends CollectDeriveAggregations ? { limit: number }
       : P extends "approximatePercentile" ? { percentile: number }
       : never
       : never,
   ) => WithPropertyDefinition<
     V extends `${infer N}:${infer P}`
-      ? P extends CollectAggregations ? PropertyDef<
+      ? P extends CollectDeriveAggregations ? PropertyDef<
           CompileTimeMetadata<Q>["properties"][N]["type"],
           "nullable",
           "array"
@@ -104,15 +102,19 @@ interface AggregatableWithPropertyObjectSet<
 
 interface SingleLinkWithPropertyObjectSet<
   Q extends ObjectOrInterfaceDefinition,
-> extends AggregatableWithPropertyObjectSet<Q>, BaseWithPropertyObjectSet<Q> {
+> extends
+  AggregatableWithPropertyObjectSet<Q>,
+  FilterableDeriveObjectSet<Q>,
+  BaseWithPropertyObjectSet<Q>
+{
   readonly selectProperty: <R extends PropertyKeys<Q>>(
     propertyName: R,
   ) => WithPropertyDefinition<CompileTimeMetadata<Q>["properties"][R]>;
 }
 
 interface ManyLinkWithPropertyObjectSet<
   Q extends ObjectOrInterfaceDefinition,
-> extends AggregatableWithPropertyObjectSet<Q> {
+> extends AggregatableWithPropertyObjectSet<Q>, FilterableDeriveObjectSet<Q> {
   readonly pivotTo: <L extends LinkNames<Q>>(
     type: L,
   ) => ManyLinkWithPropertyObjectSet<LinkedType<Q, L>>;

packages/api/src/objectSet/ObjectSet.ts

@@ -39,7 +39,7 @@
 } from "../ontology/ObjectOrInterface.js";
 import type {
   CompileTimeMetadata,
   ObjectMetadata,
   ObjectTypeDefinition,
   PropertyDef,
 } from "../ontology/ObjectTypeDefinition.js";
@@ -288,7 +288,7 @@
       [T in Extract<keyof D, string>]: D[T] extends
         (baseObjectSet: any) => WithPropertyDefinition<infer P>
         ? P extends PropertyDef<infer A, any, any>
-          ? PropertyValueWireToClient[A]
+          ? PropertyValueWireToClient[A] | undefined
         : never
         : never;
     };

packages/client/src/derivedProperties/createWithPropertiesObjectSet.ts

@@ -42,7 +42,7 @@ export function createWithPropertiesObjectSet<
         type: "searchAround",
         objectSet,
         link,
-      }, definitionMap) as any;
+      }, definitionMap);
     },
     where: (clause) => {
       return createWithPropertiesObjectSet(objectType, {
@@ -100,24 +100,30 @@ export function createWithPropertiesObjectSet<
             "Invalid aggregation operation " + aggregationOperation,
           );
       }
-      definitionMap.set(definitionId, {
+      definitionMap.set(definitionId.toString(), {
         type: "selection",
         objectSet: objectSet,
         operation: aggregationOperationDefinition,
       });
-      return { definitionId: definitionId, type: { type: "integer" } as any };
+      return {
+        definitionId: definitionId.toString(),
+        type: {} as any,
+      };
     },
     selectProperty: (name) => {
       const definitionId = idCounter++;
-      definitionMap.set(definitionId, {
+      definitionMap.set(definitionId.toString(), {
         type: "selection",
         objectSet: objectSet,
         operation: {
           type: "get",
           selectedPropertyApiName: name,
         },
       });
-      return { definitionId: definitionId, type: { type: "integer" } as any };
+      return {
+        definitionId: definitionId.toString(),
+        type: {} as any,
+      };
     },
   };
 

packages/client/src/objectSet/ObjectSet.test.ts

@@ -18,7 +18,7 @@
   CompileTimeMetadata,
   ConvertProps,
   InterfaceDefinition,
   ObjectMetadata,
   ObjectSet,
   Osdk,
   PropertyKeys,
@@ -466,6 +466,19 @@
       });
     });
 
+    it("enforces a return only of correct type", () => {
+      client(Employee).withProperties({
+        // @ts-expect-error
+        "derivedPropertyName": (base) => {
+          return base.pivotTo("peeps");
+        },
+        // @ts-expect-error
+        "derivedPropertyName2": (base) => {
+          return { incorrect: "type" };
+        },
+      });
+    });
+
     // Executed code fails since we're providing bad strings to the function
     it.fails("correctly narrows types of aggregate function", () => {
       client(Employee).withProperties({
@@ -479,6 +492,9 @@
           // @ts-expect-error
           base.pivotTo("lead").aggregate("employeeId:notAnOp");
 
+          // @ts-expect-error
+          base.pivotTo("lead").aggregate("");
+
           base.pivotTo("lead").aggregate("employeeId:collectList");
 
           return base.pivotTo("lead").aggregate("employeeId:sum");
@@ -590,8 +606,17 @@
           base.pivotTo("lead").selectProperty("employeeId"),
       }).fetchOne(50035);
 
-      expectTypeOf(objectWithRdp.derivedPropertyName).toEqualTypeOf<number>();
+      expectTypeOf(objectWithRdp.derivedPropertyName).toEqualTypeOf<
+        number | undefined
+      >();
       expect(objectWithRdp.derivedPropertyName).toBe(1);
+
+      const objectWithUndefinedRdp = await client(Employee).withProperties({
+        "derivedPropertyName": (base) =>
+          base.pivotTo("lead").selectProperty("employeeId"),
+      }).fetchOne(50036);
+
+      expect(objectWithUndefinedRdp.derivedPropertyName).toBeUndefined();
     });
 
     describe("withPropertiesObjectSet", () => {
@@ -607,7 +632,7 @@
         };
 
         const result = clause["derivedPropertyName"](deriveObjectSet);
-        const definition = map.get(result.definitionId as string);
+        const definition = map.get(result.definitionId);
         expect(definition).toMatchInlineSnapshot(`
           {
             "objectSet": {
@@ -645,12 +670,12 @@
         };
 
         const result = clause["derivedPropertyName"](deriveObjectSet);
-        const definition = map.get(result.definitionId as string);
+        const definition = map.get(result.definitionId);
 
         const secondResult = clause["secondaryDerivedPropertyName"](
           deriveObjectSet,
         );
-        const secondDefinition = map.get(secondResult.definitionId as string);
+        const secondDefinition = map.get(secondResult.definitionId);
 
         expect(definition).toMatchInlineSnapshot(`
           {

packages/shared.test/src/stubs/objectSetRequest.ts

@@ -24,6 +24,7 @@ import {
   employee2,
   employee3,
   employee4withDerived,
+  employee5withUndefinedDerived,
   employeeFailsStrict,
   nycOffice,
   objectWithAllPropertyTypes1,
@@ -108,6 +109,32 @@ const derivedPropertyBody: LoadObjectSetRequestV2 = {
   select: [],
 };
 
+const derivedPropertyBodyUndefinedValue: LoadObjectSetRequestV2 = {
+  objectSet: {
+    objectSet: {
+      derivedProperties: {
+        derivedPropertyName: {
+          objectSet: {
+            link: "lead",
+            objectSet: { type: "methodInput" },
+            type: "searchAround",
+          },
+          operation: {
+            selectedPropertyApiName: "employeeId",
+            type: "get",
+          },
+          type: "selection",
+        },
+      },
+      objectSet: { "objectType": "Employee", "type": "base" },
+      type: "withProperties",
+    },
+    type: "filter",
+    where: { "field": "employeeId", "type": "eq", "value": 50036 },
+  },
+  select: [],
+};
+
 const eqSearchBody: LoadObjectSetRequestV2 = {
   objectSet: {
     type: "filter",
@@ -473,6 +500,9 @@ export const loadObjectSetRequestHandlers: {
   [stableStringify(intersectedObjectSet)]: [employee3],
   [stableStringify(subtractedObjectSet)]: [employee2, employee3],
   [stableStringify(derivedPropertyBody)]: [employee4withDerived],
+  [stableStringify(derivedPropertyBodyUndefinedValue)]: [
+    employee5withUndefinedDerived,
+  ],
   [stableStringify(eqSearchBody)]: [employee1],
   [stableStringify(eqSearchBody2)]: [employee2],
   [stableStringify(eqSearchBodyBadObject)]: [employeeFailsStrict],

packages/shared.test/src/stubs/objects.ts

@@ -82,6 +82,23 @@ export const employee4withDerived = {
   employeeLocation: "GeotimeSeriesReferencePlaceholder",
 };
 
+export const employee5withUndefinedDerived = {
+  __rid:
+    "ri.phonograph2-objects.main.object.b9a0b2b0-0a2b-0b8b-9e4b-a9a9b9a0b9a0",
+  __primaryKey: 50036,
+  __apiName: "Employee",
+  __title: "Jack Smith",
+  employeeId: 50036,
+  fullName: "Jack Smith",
+  office: "LON",
+  class: "Red",
+  startDate: "2015-05-15",
+  derivedPropertyName: undefined,
+  employeeStatus: "TimeSeries<String>",
+  employeeSensor: "TimeSeries<>",
+  employeeLocation: "GeotimeSeriesReferencePlaceholder",
+};
+
 export const employeeFailsStrict = {
   __rid:
     "ri.phonograph2-objects.main.object.b9a0b2b0-0a2b-0b8b-9e4b-a9a9b9a0b9a0",