Merge pull request #111 from palantir/ssanjay/addStartsWith

Add startsWith for string filter
palantir · Mar 5, 2024 · 31c6a85 · 31c6a85
2 parents c26c8b8 + 87e281f
commit 31c6a85
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 3 deletions.
diff --git a/examples/basic/cli/src/index.ts b/examples/basic/cli/src/index.ts
@@ -185,6 +185,15 @@ async function runTests() {
 
     await checkLinksAndActionsForVentures();
 
+    const testStringClause = await client(BoundariesUsState)
+      .where({
+        usState: {
+          $startsWith: "N",
+        },
+      }).fetchPage();
+
+    console.log(testStringClause.data.map(data => data.usState));
+
     const testAggregateCountNoGroup = await client.objects.BoundariesUsState
       .aggregateOrThrow({
         select: { $count: true, latitude: ["min", "max", "avg"] },

diff --git a/examples/docs_example/src/osdkExample.tsx b/examples/docs_example/src/osdkExample.tsx
@@ -33,7 +33,7 @@ export async function osdkObjectSetExample() {
     $or: [{ fullName: { $contains: "Clooney" }, employeeId: { $gt: 10 } }, {
       $and: [{ $not: { fullName: { $contains: "Pitt" } } }, {
         $or: [{ fullName: { $contains: "Downey" } }, {
-          fullName: { $contains: "Hemsworth" },
+          fullName: { $startsWith: "Hemsworth" },
           employeeId: { $gte: 20 },
         }],
       }],

diff --git a/packages/client/changelog/@unreleased/pr-111.v2.yml b/packages/client/changelog/@unreleased/pr-111.v2.yml
@@ -0,0 +1,5 @@
+type: feature
+feature:
+  description: Add startsWith for string filter
+  links:
+  - https://github.com/palantir/osdk-ts/pull/111
diff --git a/packages/client/src/query/WhereClause.ts b/packages/client/src/query/WhereClause.ts
@@ -32,7 +32,8 @@ export type PossibleWhereClauseFilters =
   | "$lt"
   | "$lte"
   | "$within"
-  | "$intersects";
+  | "$intersects"
+  | "$startsWith";
 
 // We need to conditional here to force the union to be distributed
 type MakeFilter<K extends PossibleWhereClauseFilters, V> = K extends string ? {
@@ -45,7 +46,7 @@ type BaseFilter<T> =
   | MakeFilter<"$eq" | "$ne" | "$contains", T>
   | MakeFilter<"$isNull", boolean>;
 
-type StringFilter = BaseFilter<string>;
+type StringFilter = BaseFilter<string> | MakeFilter<"$startsWith", string>;
 type NumberFilter =
   | BaseFilter<number>
   | MakeFilter<"$gt" | "$gte" | "$lt" | "$lte", number>;