Merge pull request #43 from palantir/ea/fix-up-aggregations

Fix intellisense for aggregations and fill in more number types
palantir · Feb 7, 2024 · 139cdaf · 139cdaf
2 parents 16efd1e + 9d6f89e
commit 139cdaf
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 5 deletions.
diff --git a/examples/basic/cli/src/typeChecks.ts b/examples/basic/cli/src/typeChecks.ts
@@ -50,6 +50,27 @@ export async function typeChecks(client: Client<Ontology>) {
     );
   }
 
+  // just a demo of aggregations
+  {
+    const q = await client.objects.ObjectTypeWithAllPropertyTypes
+      .aggregateOrThrow({
+        select: {
+          integer: "sum",
+          float: "sum",
+          decimal: "sum",
+          short: ["max"],
+          string: "approximateDistinct",
+        },
+        groupBy: {
+          string: "exact",
+          stringArray: "exact",
+        },
+        orderBy: {
+          group: "string",
+        },
+      });
+  }
+
   // object $link examples
   {
     const page = await client.objectSet("Employee").where({

diff --git a/packages/client/changelog/@unreleased/pr-43.v2.yml b/packages/client/changelog/@unreleased/pr-43.v2.yml
@@ -0,0 +1,5 @@
+type: fix
+fix:
+  description: Fix intellisense for aggregations and fill in more number types
+  links:
+  - https://github.com/palantir/osdk-ts/pull/43
diff --git a/packages/client/src/objectSet/ObjectSet.ts b/packages/client/src/objectSet/ObjectSet.ts
@@ -26,7 +26,11 @@ import type { FetchPageOrThrowArgs } from "../object/fetchPageOrThrow.js";
 import type { OsdkInterfaceFrom, OsdkObjectFrom } from "../OsdkObjectFrom.js";
 import type { PageResult } from "../PageResult.js";
 import type { AggregateOpts } from "../query/aggregations/AggregateOpts.js";
-import type { AggregationsResults, WhereClause } from "../query/index.js";
+import type {
+  AggregationClause,
+  AggregationsResults,
+  WhereClause,
+} from "../query/index.js";
 import type { LinkTypesFrom } from "./LinkTypesFrom.js";
 import type { ObjectSetListener } from "./ObjectSetListener.js";
 
@@ -69,7 +73,9 @@ export interface BaseObjectSet<
   //   OsdkObjectFrom<K, O, PropertyKeysFrom<O, K>>
   // >;
 
-  aggregateOrThrow: <const AO extends AggregateOpts<O, K, any>>(
+  aggregateOrThrow: <
+    AO extends AggregateOpts<O, K, AggregationClause<O, K>>,
+  >(
     req: AO,
   ) => Promise<AggregationsResults<O, K, AO>>;
 

diff --git a/packages/client/src/query/aggregations/AggregationsClause.ts b/packages/client/src/query/aggregations/AggregationsClause.ts
@@ -21,8 +21,9 @@ import type {
 } from "@osdk/api";
 import type { AggregatableKeys } from "./AggregatableKeys.js";
 
-type StringAggregateOption = "approximateDistinct";
+type StringAggregateOption = "approximateDistinct" | "count";
 type NumericAggregateOption =
+  | "count"
   | "min"
   | "max"
   | "sum"
@@ -38,7 +39,8 @@ export type AggregationClause<
     K
   >[P]["type"] extends "string"
     ? StringAggregateOption | StringAggregateOption[]
-    : ObjectTypePropertyDefinitionsFrom<O, K>[P]["type"] extends "double"
+    : ObjectTypePropertyDefinitionsFrom<O, K>[P]["type"] extends
+      "double" | "integer" | "float" | "decimal" | "byte" | "long" | "short"
       ? NumericAggregateOption | NumericAggregateOption[]
-    : ObjectTypePropertyDefinitionsFrom<O, K>[P]["type"];
+    : never;
 };