RDP's in TS OSDK

etc/api.report.api.md

@@ -373,6 +373,38 @@ export interface DataValueWireToClient {
         	}[];
 }
 
+// @public (undocumented)
+export namespace DerivedProperty {
+    	// Warning: (ae-forgotten-export) The symbol "FilterableBuilder" needs to be exported by the entry point index.d.ts
+    //
+    // (undocumented)
+    export interface Builder<Q extends ObjectOrInterfaceDefinition> extends FilterableBuilder<Q> {
+        		// Warning: (ae-forgotten-export) The symbol "SelectPropertyBuilder" needs to be exported by the entry point index.d.ts
+        // Warning: (ae-forgotten-export) The symbol "DefaultBuilder" needs to be exported by the entry point index.d.ts
+        //
+        // (undocumented)
+        readonly pivotTo: <L extends LinkNames<Q>>(type: L) => NonNullable<CompileTimeMetadata<Q>["links"][L]["multiplicity"]> extends false ? SelectPropertyBuilder<LinkedType<Q, L>> : DefaultBuilder<LinkedType<Q, L>>;
+        	}
+    	// (undocumented)
+    export namespace Builder {
+        		// Warning: (ae-forgotten-export) The symbol "AggregatableBuilder" needs to be exported by the entry point index.d.ts
+        //
+        // (undocumented)
+        export interface Full<Q extends ObjectOrInterfaceDefinition> extends DerivedProperty.Builder<Q>, AggregatableBuilder<Q>, SelectPropertyBuilder<Q> {}
+        	}
+    	// (undocumented)
+    export type Clause<Q extends ObjectOrInterfaceDefinition> = { [key: string]: Selector<Q, SimplePropertyDef> };
+    	// (undocumented)
+    export type Selector<
+    		Q extends ObjectOrInterfaceDefinition,
+    		T extends SimplePropertyDef
+    	> = (baseObjectSet: DerivedProperty.Builder<Q>) => SelectorResult<T>;
+    	// Warning: (ae-forgotten-export) The symbol "SimplePropertyDef" needs to be exported by the entry point index.d.ts
+    //
+    // (undocumented)
+    export type SelectorResult<T extends SimplePropertyDef> = { type: T };
+}
+
 // @public (undocumented)
 export const DistanceUnitMapping: {
     	centimeter: "CENTIMETERS";
@@ -655,19 +687,14 @@ export type ObjectOrInterfaceDefinition = ObjectTypeDefinition | InterfaceDefini
 
 // @public (undocumented)
 export namespace ObjectOrInterfaceDefinition {
-    // Warning: (ae-forgotten-export) The symbol "SimplePropertyDef" needs to be exported by the entry point index.d.ts
-    //
-    // (undocumented)
-    export type WithRdp<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;
+    	// (undocumented)
+    export type WithRdp<
+    		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;
 }
 
 // Warning: (ae-forgotten-export) The symbol "BaseQueryDataTypeDefinition" needs to be exported by the entry point index.d.ts
@@ -682,27 +709,28 @@ export interface ObjectQueryDataType<T_Target extends ObjectTypeDefinition = nev
 
 // @public (undocumented)
 export namespace ObjectSet {
-    // (undocumented)
+    	// (undocumented)
     export namespace Fns {
-        // (undocumented)
-        export interface WithProperties<Q extends ObjectOrInterfaceDefinition = any, D extends Record<string, SimplePropertyDef> = {}> {
-            // (undocumented)
-            readonly withProperties: <R extends Record<string, SimplePropertyDef>>(clause: {
-                [K in keyof R]: Rdp.Selector<Q, R[K]>;
-            }) => ObjectSet<Q, {
-                [NN in keyof R | keyof D]: NN extends keyof R ? R[NN] : NN extends keyof D ? D[NN] : never;
-            }>;
-        }
-    }
+        		// (undocumented)
+        export interface WithProperties<
+        			Q extends ObjectOrInterfaceDefinition = any,
+        			D extends Record<string, SimplePropertyDef> = {}
+        		> {
+            			// (undocumented)
+            readonly withProperties: <R extends Record<string, SimplePropertyDef>>(clause: { [K in keyof R] : DerivedProperty.Selector<Q, R[K]> }) => ObjectSet<Q, { [NN in keyof R | keyof D] : NN extends keyof R ? R[NN] : NN extends keyof D ? D[NN] : never }>;
+            		}
+        	}
 }
 
 // Warning: (ae-forgotten-export) The symbol "ObjectSetPrime" needs to be exported by the entry point index.d.ts
 // Warning: (ae-forgotten-export) The symbol "MergeObjectSet" needs to be exported by the entry point index.d.ts
 // Warning: (ae-forgotten-export) The symbol "ExtractRdp" needs to be exported by the entry point index.d.ts
 //
 // @public (undocumented)
-export interface ObjectSet<Q extends ObjectOrInterfaceDefinition = any, D extends ObjectSet<Q, any> | Record<string, SimplePropertyDef> = ObjectSet<Q, any>> extends ObjectSetPrime<MergeObjectSet<Q, D>>, ObjectSet.Fns.WithProperties<Q, ExtractRdp<D>> {
-}
+export interface ObjectSet<
+	Q extends ObjectOrInterfaceDefinition = any,
+	D extends ObjectSet<Q, any> | Record<string, SimplePropertyDef> = ObjectSet<Q, any>
+> extends ObjectSetPrime<MergeObjectSet<Q, D>, Q, D>, ObjectSet.Fns.WithProperties<Q, ExtractRdp<D>> {}
 
 // @public (undocumented)
 export interface ObjectSetListener<
@@ -779,8 +807,9 @@ export namespace Osdk {
     export 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>> & {
+    		P extends PropertyKeys<Q> = PropertyKeys<Q>,
+    		R extends Record<string, SimplePropertyDef> = never
+    	> = OsdkBase<Q> & Pick<CompileTimeMetadata<Q>["props"], GetPropsKeys<Q, P, [R] extends [never] ? false : true>> & ([R] extends [never] ? {} : { [A in keyof R] : SimplePropertyDef.ToRuntimeProperty<R[A]> }) & {
         		readonly $link: Q extends { linksType?: any } ? Q["linksType"] : Q extends ObjectTypeDefinition ? OsdkObjectLinksObject<Q> : never;
         		readonly $as: <NEW_Q extends ValidToFrom<Q>>(type: NEW_Q | string) => Osdk.Instance<NEW_Q, OPTIONS, ConvertProps<Q, NEW_Q, P>>;
         	} & (IsNever<OPTIONS> extends true ? {} : IsAny<OPTIONS> extends true ? {} : "$rid" extends OPTIONS ? { readonly $rid: string } : {});
@@ -971,33 +1000,6 @@ export namespace QueryResult {
     export type PrimitiveType<T extends keyof DataValueClientToWire> = DataValueWireToClient[T];
 }
 
-// @public (undocumented)
-export namespace Rdp {
-    // Warning: (ae-forgotten-export) The symbol "BaseWithPropertyObjectSet" needs to be exported by the entry point index.d.ts
-    //
-    // (undocumented)
-    export interface Builder<Q extends ObjectOrInterfaceDefinition> extends BaseWithPropertyObjectSet<Q> {
-    }
-    // (undocumented)
-    export namespace Builder {
-        // Warning: (ae-forgotten-export) The symbol "WithPropertyObjectSet" needs to be exported by the entry point index.d.ts
-        //
-        // (undocumented)
-        export interface Full<Q extends ObjectOrInterfaceDefinition> extends WithPropertyObjectSet<Q> {
-        }
-    }
-    // (undocumented)
-    export type Clause<Q extends ObjectOrInterfaceDefinition> = {
-        [key: string]: Selector<Q, SimplePropertyDef>;
-    };
-    // (undocumented)
-    export type Selector<Q extends ObjectOrInterfaceDefinition, T extends SimplePropertyDef> = (baseObjectSet: Rdp.Builder<Q>) => SelectorResult<T>;
-    // (undocumented)
-    export type SelectorResult<T extends SimplePropertyDef> = {
-        type: T;
-    };
-}
-
 // Warning: (ae-forgotten-export) The symbol "ErrorResult" needs to be exported by the entry point index.d.ts
 //
 // @public (undocumented)
@@ -1126,11 +1128,13 @@ 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, 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;
-});
+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 });
+
+// @public (undocumented)
+export type ValidBaseActionParameterTypes = "boolean" | "string" | "integer" | "long" | "double" | "datetime" | "timestamp" | "attachment" | "marking" | "objectType";
 
 // Warning: (ae-forgotten-export) The symbol "VersionString" needs to be exported by the entry point index.d.ts
 //

packages/api/src/OsdkObjectFrom.ts

@@ -29,6 +29,7 @@ import type {
   CompileTimeMetadata,
   ObjectTypeDefinition,
 } from "./ontology/ObjectTypeDefinition.js";
+import type { SimplePropertyDef } from "./ontology/SimplePropertyDef.js";
 import type { OsdkBase } from "./OsdkBase.js";
 
 type DropDollarOptions<T extends string> = Exclude<
@@ -154,7 +155,8 @@ export type IsAny<T> = unknown extends T
 export type GetPropsKeys<
   Q extends ObjectOrInterfaceDefinition,
   P extends PropertyKeys<Q>,
-> = IsNever<P> extends true ? PropertyKeys<Q>
+  N extends boolean = false,
+> = IsNever<P> extends true ? N extends true ? never : PropertyKeys<Q>
   : IsAny<P> extends true ? PropertyKeys<Q>
   : P;
 
@@ -185,12 +187,16 @@ export namespace Osdk {
     Q extends ObjectOrInterfaceDefinition,
     OPTIONS extends never | "$rid" = never,
     P extends PropertyKeys<Q> = PropertyKeys<Q>,
+    R extends Record<string, SimplePropertyDef> = never,
   > =
     & OsdkBase<Q>
     & Pick<
       CompileTimeMetadata<Q>["props"],
-      GetPropsKeys<Q, P>
+      // If there aren't any additional properties, then we want GetPropsKeys to default to PropertyKeys<Q>
+      GetPropsKeys<Q, P, [R] extends [never] ? 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>

packages/api/src/aggregate/AggregatableKeys.ts

@@ -17,7 +17,7 @@
 import type {
   NumericWithPropAggregateOption,
   StringWithPropAggregateOption,
-} from "../derivedProperties/WithPropertyObjectSet.js";
+} from "../derivedProperties/WithPropertiesAggregationOptions.js";
 import type {
   GetWirePropertyValueFromClient,
 } from "../mapping/PropertyValueMapping.js";

packages/api/src/derivedProperties/WithPropertyObjectSet.ts → packages/api/src/derivedProperties/DerivedProperty.ts

@@ -23,52 +23,58 @@ import type {
 import type { CompileTimeMetadata } from "../ontology/ObjectTypeDefinition.js";
 import type { SimplePropertyDef } from "../ontology/SimplePropertyDef.js";
 import type { LinkedType, LinkNames } from "../util/LinkUtils.js";
-import type { Rdp } from "./Rdp.js";
+import type { CollectWithPropAggregations } from "./WithPropertiesAggregationOptions.js";
 
-export interface WithPropertyObjectSet<Q extends ObjectOrInterfaceDefinition>
-  extends
-    BaseWithPropertyObjectSet<Q>,
-    AggregatableWithPropertyObjectSet<Q>,
-    SingleLinkWithPropertyObjectSet<Q>
-{}
+export namespace DerivedProperty {
+  export type SelectorResult<
+    T extends SimplePropertyDef,
+  > = {
+    type: T;
+  };
 
-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>>;
+  export type Clause<
+    Q extends ObjectOrInterfaceDefinition,
+  > = {
+    [key: string]: Selector<Q, SimplePropertyDef>;
+  };
+
+  export type Selector<
+    Q extends ObjectOrInterfaceDefinition,
+    T extends SimplePropertyDef,
+  > = (
+    baseObjectSet: DerivedProperty.Builder<Q>,
+  ) => SelectorResult<T>;
+
+  export interface Builder<Q extends ObjectOrInterfaceDefinition>
+    extends FilterableBuilder<Q>
+  {
+    readonly pivotTo: <L extends LinkNames<Q>>(
+      type: L,
+    ) => NonNullable<CompileTimeMetadata<Q>["links"][L]["multiplicity"]> extends
+      false ? SelectPropertyBuilder<LinkedType<Q, L>>
+      : DefaultBuilder<LinkedType<Q, L>>;
+  }
+
+  export namespace Builder {
+    export interface Full<Q extends ObjectOrInterfaceDefinition>
+      extends
+        DerivedProperty.Builder<Q>,
+        AggregatableBuilder<Q>,
+        SelectPropertyBuilder<Q>
+    {
+    }
+  }
 }
 
-interface FilterableWithPropertyObjectSet<
+interface FilterableBuilder<
   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<
+interface AggregatableBuilder<
   Q extends ObjectOrInterfaceDefinition,
 > {
   readonly aggregate: <
@@ -83,7 +89,7 @@ interface AggregatableWithPropertyObjectSet<
       : P extends "approximatePercentile" ? { percentile: number }
       : never
       : never,
-  ) => Rdp.SelectorResult<
+  ) => DerivedProperty.SelectorResult<
     V extends `${infer N}:${infer P}`
       ? P extends CollectWithPropAggregations
         ? Array<CompileTimeMetadata<Q>["properties"][N]["type"]> | undefined
@@ -95,16 +101,21 @@ interface AggregatableWithPropertyObjectSet<
   >;
 }
 
-interface SingleLinkWithPropertyObjectSet<
+/**
+ * This is the builder that is used until we encounter a many link traversal.
+ * Once a many link traversal happens, we switch to the DefaultBuilder and the
+ * selectProperty option is no longer available.
+ */
+interface SelectPropertyBuilder<
   Q extends ObjectOrInterfaceDefinition,
 > extends
-  AggregatableWithPropertyObjectSet<Q>,
-  FilterableWithPropertyObjectSet<Q>,
-  BaseWithPropertyObjectSet<Q>
+  AggregatableBuilder<Q>,
+  FilterableBuilder<Q>,
+  DerivedProperty.Builder<Q>
 {
   readonly selectProperty: <R extends PropertyKeys<Q>>(
     propertyName: R,
-  ) => Rdp.SelectorResult<
+  ) => DerivedProperty.SelectorResult<
     SimplePropertyDef.Make<
       CompileTimeMetadata<Q>["properties"][R]["type"],
       CompileTimeMetadata<Q>["properties"][R]["nullable"],
@@ -114,18 +125,15 @@ interface SingleLinkWithPropertyObjectSet<
 }
 
 /*
- * The ManyLinkWithPropertyObjectSet overrides the pivotTo operation because once we traverse a single link,
+ * The DefaultBuilder 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<
+interface DefaultBuilder<
   Q extends ObjectOrInterfaceDefinition,
-> extends
-  AggregatableWithPropertyObjectSet<Q>,
-  FilterableWithPropertyObjectSet<Q>
-{
+> extends AggregatableBuilder<Q>, FilterableBuilder<Q> {
   readonly pivotTo: <L extends LinkNames<Q>>(
     type: L,
-  ) => ManyLinkWithPropertyObjectSet<LinkedType<Q, L>>;
+  ) => DefaultBuilder<LinkedType<Q, L>>;
 }