Adds an example for subscriptions

etc/client.report.api.md

@@ -23,6 +23,7 @@ import type { InterfaceMetadata } from '@osdk/api';
 import { isOk } from '@osdk/api';
 import type { MinimalObjectSet } from '@osdk/api/unstable';
 import { ObjectMetadata } from '@osdk/api';
+import type { ObjectOrInterfaceDefinition } from '@osdk/api';
 import type { ObjectQueryDataType } from '@osdk/api';
 import { ObjectSet } from '@osdk/api';
 import type { ObjectSetQueryDataType } from '@osdk/api';
@@ -94,6 +95,9 @@ export interface Client extends SharedClient, SharedClient_2 {
     fetchMetadata<Q extends (ObjectTypeDefinition | InterfaceDefinition | ActionDefinition<any> | QueryDefinition<any>)>(o: Q): Promise<Q extends ObjectTypeDefinition ? ObjectMetadata : Q extends InterfaceDefinition ? InterfaceMetadata : Q extends ActionDefinition<any> ? ActionMetadata : Q extends QueryDefinition<any> ? QueryMetadata : never>;
 }
 
+// @public (undocumented)
+export function consolidateOsdkObject<T extends Osdk.Instance<V, any, any>, U extends Osdk.Instance<V, any, any>, V extends ObjectOrInterfaceDefinition>(oldObject: T | undefined, upToDateObject: U): U;
+
 // @public (undocumented)
 export function createAttachmentUpload(data: Blob, name: string): AttachmentUpload;
 

examples-extra/docs_example/src/osdkExample.tsx

@@ -1,4 +1,4 @@
-import { createClient } from "@osdk/client";
+import { consolidateOsdkObject, createClient, Osdk } from "@osdk/client";
 import {
   $ontologyRid,
   Employee,
@@ -182,4 +182,53 @@ export async function osdkObjectSetExample() {
     unionObjectSet,
     subtractObjectSet,
   );
+
+  /**
+   * SUBSCRIPTIONS
+   */
+
+  const objects: Record<string, Osdk.Instance<Employee, never, "employeeId">> =
+    {};
+
+  const subscription = client(Employee).subscribe({
+    onChange: (update) => {
+      if (update.state === "ADDED_OR_UPDATED") {
+        console.log(
+          `Employee with primary key ${update.object.$primaryKey} was added or updated`,
+        );
+
+        objects[update.object.$primaryKey] = consolidateOsdkObject(
+          objects[update.object.$primaryKey],
+          update.object,
+        );
+      } else if (update.state === "REMOVED") {
+        console.log(
+          `Employee with primary key ${update.object.$primaryKey} was deleted`,
+        );
+
+        delete objects[update.object.$primaryKey];
+      }
+    },
+    onOutOfDate: async () => {
+      console.log("Object Set Out of Date. Reloading Object Set");
+
+      for await (const obj of client(Employee).asyncIter()) {
+        objects[obj.$primaryKey] = obj;
+      }
+    },
+    onSuccessfulSubscription() {
+      console.log("Subscription successful");
+      setTimeout(() => {
+        subscription.unsubscribe();
+      }, 10000);
+    },
+    onError(err) {
+      console.error("Error in subscription and subscription closed", err);
+    },
+    // The properties that will be returned in updates can optionally be specified below. Updates may still be sent for properties not specified here,
+    // and not all properties may be returned.
+  }, { properties: ["employeeId"] });
+
+  // An empty subscription will request all properties
+  client(Employee).subscribe({ onChange: () => {} });
 }

packages/client/src/index.ts

@@ -58,3 +58,5 @@ export {
   extractDateInLocalTime,
   extractDateInUTC,
 } from "./util/datetimeConverters.js";
+
+export { consolidateOsdkObject } from "./util/consolidateOsdkObject.js";

packages/client/src/util/consolidateOsdkObject.ts

@@ -0,0 +1,39 @@
+/*
+ * Copyright 2024 Palantir Technologies, Inc. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { ObjectOrInterfaceDefinition, Osdk } from "@osdk/api";
+
+export function consolidateOsdkObject<
+  T extends Osdk.Instance<V, any, any>,
+  U extends Osdk.Instance<V, any, any>,
+  V extends ObjectOrInterfaceDefinition,
+>(
+  oldObject: T | undefined,
+  upToDateObject: U,
+): U {
+  if (!oldObject) {
+    return upToDateObject;
+  }
+  const combinedObject = oldObject as any;
+
+  for (const key in upToDateObject) {
+    if (upToDateObject.hasOwnProperty(key)) {
+      combinedObject[key] = upToDateObject[key];
+    }
+  }
+
+  return combinedObject;
+}

packages/client/src/util/util.test.ts

@@ -0,0 +1,56 @@
+/*
+ * Copyright 2024 Palantir Technologies, Inc. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { Osdk } from "@osdk/api";
+import type { Employee, Todo } from "@osdk/client.test.ontology";
+import { describe, expect, expectTypeOf, it } from "vitest";
+import { consolidateOsdkObject } from "./consolidateOsdkObject.js";
+
+describe(consolidateOsdkObject, () => {
+  it("combines two objects", () => {
+    const oldObject: Osdk.Instance<Todo, never, "text"> = {
+      $apiName: "Todo",
+      $objectType: "type",
+      $primaryKey: 1,
+      $title: "Employee",
+      text: "text",
+    } as any;
+
+    const upToDateObject: Osdk.Instance<Todo> = {
+      $apiName: "Todo",
+      $objectType: "type",
+      $primaryKey: 1,
+      $title: "Employee",
+      id: 1,
+      text: "hi",
+    } as any;
+
+    const result = consolidateOsdkObject(oldObject, upToDateObject);
+
+    expectTypeOf(result).toEqualTypeOf<Osdk.Instance<Todo>>();
+
+    expect(result).toMatchInlineSnapshot(`
+      {
+        "$apiName": "Todo",
+        "$objectType": "type",
+        "$primaryKey": 1,
+        "$title": "Employee",
+        "id": 1,
+        "text": "hi",
+      }
+    `);
+  });
+});