Merge pull request #30 from palantir/ea/add-geopoint-within

Adds geopoint $within where clauses
palantir · Feb 5, 2024 · 4402a5a · 4402a5a
2 parents 5030bba + 460d689
commit 4402a5a
Show file tree

Hide file tree

Showing 12 changed files with 544 additions and 78 deletions.
diff --git a/examples/basic/cli/src/index.ts b/examples/basic/cli/src/index.ts
@@ -73,6 +73,18 @@ async function runTests() {
       interfaceResults.data[0].body;
     }
 
+    // only works in default ontology
+    const result = await client.objects.WeatherStation.where({
+      geohash: {
+        $within: {
+          distance: [1_000, "miles"],
+          of: [0, 0],
+        },
+      },
+    }).fetchPageOrThrow();
+
+    console.log(result.data[0].geohash);
+
     await typeChecks(client);
   } catch (e) {
     console.error("Caught an error we did not expect", typeof e);

diff --git a/examples/basic/sdk/ontology.json b/examples/basic/sdk/ontology.json
@@ -1,7 +1,7 @@
 {
   "ontology": {
-    "apiName": "OntologyApiName",
-    "rid": "ridHere",
+    "apiName": "default",
+    "rid": "ri.ontology.main.ontology.a35bb7f9-2c57-4199-a1cd-af461d88bd6e",
     "displayName": "",
     "description": ""
   },
@@ -89,6 +89,31 @@
     }
   },
   "objectTypes": {
+    "WeatherStation": {
+      "objectType": {
+        "apiName": "WeatherStation",
+        "primaryKey": "stationId",
+        "displayName": "Weather Station",
+        "description": "Weather Station",
+        "properties": {
+          "stationId": {
+            "dataType": {
+              "type": "string"
+            }
+          },
+          "geohash": {
+            "dataType": {
+              "type": "geopoint"
+            },
+            "description": "geopoint",
+            "displayName": "Geohash"
+          }
+        },
+        "status": "ACTIVE",
+        "rid": "ridForWeatherStation"
+      },
+      "linkTypes": []
+    },
     "Todo": {
       "objectType": {
         "apiName": "Todo",

diff --git a/examples/basic/sdk/src/generatedNoCheck/Ontology.ts b/examples/basic/sdk/src/generatedNoCheck/Ontology.ts
@@ -7,6 +7,7 @@ import * as Objects from './ontology/objects.js';
 const _Ontology = {
   metadata: OntologyMetadata,
   objects: {
+    WeatherStation: Objects.WeatherStation,
     Todo: Objects.Todo,
     Person: Objects.Person,
     Employee: Objects.Employee,
@@ -22,7 +23,7 @@ const _Ontology = {
   interfaces: {
     SimpleInterface: Interfaces.SimpleInterface,
   },
-} satisfies OntologyDefinition<'Todo' | 'Person' | 'Employee' | 'ObjectTypeWithAllPropertyTypes'>;
+} satisfies OntologyDefinition<'WeatherStation' | 'Todo' | 'Person' | 'Employee' | 'ObjectTypeWithAllPropertyTypes'>;
 
 type _Ontology = typeof _Ontology;
 export interface Ontology extends _Ontology {}

diff --git a/examples/basic/sdk/src/generatedNoCheck/OntologyMetadata.ts b/examples/basic/sdk/src/generatedNoCheck/OntologyMetadata.ts
@@ -1,5 +1,5 @@
 export const OntologyMetadata = {
-  ontologyRid: 'ridHere',
-  ontologyApiName: 'OntologyApiName',
+  ontologyRid: 'ri.ontology.main.ontology.a35bb7f9-2c57-4199-a1cd-af461d88bd6e',
+  ontologyApiName: 'default',
   userAgent: 'typescript-sdk/dev osdk-cli/dev',
 };
diff --git a/examples/basic/sdk/src/generatedNoCheck/ontology/objects.ts b/examples/basic/sdk/src/generatedNoCheck/ontology/objects.ts
@@ -2,3 +2,4 @@ export * from './objects/Employee.js';
 export * from './objects/ObjectTypeWithAllPropertyTypes.js';
 export * from './objects/Person.js';
 export * from './objects/Todo.js';
+export * from './objects/WeatherStation.js';
diff --git a/examples/basic/sdk/src/generatedNoCheck/ontology/objects/WeatherStation.ts b/examples/basic/sdk/src/generatedNoCheck/ontology/objects/WeatherStation.ts
@@ -0,0 +1,21 @@
+import type { ObjectTypeDefinition } from '@osdk/api';
+
+export const WeatherStation = {
+  apiName: 'WeatherStation',
+  description: 'Weather Station',
+  primaryKeyType: 'string',
+  links: {},
+  properties: {
+    stationId: {
+      multiplicity: false,
+      type: 'string',
+      nullable: false,
+    },
+    geohash: {
+      multiplicity: false,
+      description: 'geopoint',
+      type: 'geopoint',
+      nullable: true,
+    },
+  },
+} satisfies ObjectTypeDefinition<'WeatherStation', never>;
diff --git a/packages/client/changelog/@unreleased/pr-30.v2.yml b/packages/client/changelog/@unreleased/pr-30.v2.yml
@@ -0,0 +1,5 @@
+type: fix
+fix:
+  description: Adds geopoint $within where clauses
+  links:
+    - https://github.com/palantir/osdk-ts/pull/30
diff --git a/packages/client/package.json b/packages/client/package.json
@@ -41,6 +41,7 @@
   "devDependencies": {
     "@osdk/generator": "workspace:*",
     "@osdk/shared.test": "workspace:*",
+    "@types/geojson": "^7946.0.14",
     "@types/ws": "^8.5.10",
     "ts-expect": "^1.3.0",
     "typescript": "^5.2.2"