Adds an example for subscriptions

etc/api.report.api.md

@@ -655,6 +655,7 @@ export namespace Osdk {
             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>>;
+        readonly $cloneAndUpdate: <O extends PropertyKeys<Q>, T extends Osdk.Instance<Q, any, O>>(newObject: T) => Osdk.Instance<Q, OPTIONS, P>;
     } & (IsNever<OPTIONS> extends true ? {} : IsAny<OPTIONS> extends true ? {} : "$rid" extends OPTIONS ? {
         readonly $rid: string;
     } : {});

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, upToDateObject: U): T;
+
 // @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/api/src/OsdkObjectFrom.ts

@@ -203,6 +203,16 @@ export namespace Osdk {
         OPTIONS,
         ConvertProps<Q, NEW_Q, P>
       >;
+      readonly $cloneAndUpdate: <
+        T extends Osdk.Instance<Q, any, L>,
+        L extends PropertyKeys<Q>,
+      >(
+        newObject: T,
+      ) => Osdk.Instance<
+        Q,
+        OPTIONS,
+        P
+      >;
     }
     // We are hiding the $rid field if it wasn't requested as we want to discourage its use
     & (IsNever<OPTIONS> extends true ? {}

packages/client/src/index.ts

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