Accept no ref

palantir · Jan 31, 2025 · b0dc2b8 · b0dc2b8
1 parent 7e84ede
commit b0dc2b8
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 6 deletions.
diff --git a/.changeset/forty-seahorses-matter.md b/.changeset/forty-seahorses-matter.md
@@ -3,4 +3,4 @@
 "@osdk/api": patch
 ---
 
-Exposes $cloneAndUpdate from OSDK Object instances
+Exposes $clone from OSDK Object instances
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -32,5 +32,6 @@
     "\\.\\./.*?/src",
     "\\.\\./.*?/build",
     "\\./index.js"
-  ]
+  ],
+  "typescript.preferGoToSourceDefinition": true
 }
diff --git a/etc/api.report.api.md b/etc/api.report.api.md
@@ -773,7 +773,7 @@ export namespace Osdk {
     	> = OsdkBase<Q> & Pick<CompileTimeMetadata<Q>["props"], GetPropsKeys<Q, P>> & {
         		readonly $link: Q extends { 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: (updatedObject: Osdk.Instance<Q, any, any> | { [K in PropertyKeys<Q>]? : CompileTimeMetadata<Q>["props"][K] }) => Osdk.Instance<Q, OPTIONS, P>;
+        		readonly $clone: (updatedObject?: Osdk.Instance<Q, any, any> | { [K in PropertyKeys<Q>]? : CompileTimeMetadata<Q>["props"][K] }) => Osdk.Instance<Q, OPTIONS, P>;
         	} & (IsNever<OPTIONS> extends true ? {} : IsAny<OPTIONS> extends true ? {} : "$rid" extends OPTIONS ? { readonly $rid: string } : {});
 }
 

diff --git a/packages/api/src/OsdkObjectFrom.ts b/packages/api/src/OsdkObjectFrom.ts
@@ -205,7 +205,7 @@ export namespace Osdk {
       >;
 
       readonly $clone: (
-        updatedObject:
+        updatedObject?:
           | Osdk.Instance<Q, any, any>
           | {
             [K in PropertyKeys<Q>]?: CompileTimeMetadata<

diff --git a/packages/client/src/object/convertWireToOsdkObjects/createOsdkObject.ts b/packages/client/src/object/convertWireToOsdkObjects/createOsdkObject.ts
@@ -64,11 +64,15 @@ const basePropDefs = {
   "$clone": {
     value: function(
       this: InternalOsdkInstance & ObjectHolder<any>,
-      update: Record<string, any>,
+      update: Record<string, any> | undefined,
     ) {
       const rawObj = this[UnderlyingOsdkObject];
       const def = this[ObjectDefRef];
 
+      if (!update) {
+        return createOsdkObject(this[ClientRef], def, rawObj);
+      }
+
       if (
         def.primaryKeyApiName in update
         && rawObj[def.primaryKeyApiName] !== update[def.primaryKeyApiName]

diff --git a/packages/client/src/object/object.test.ts b/packages/client/src/object/object.test.ts
@@ -336,6 +336,20 @@ describe("OsdkObject", () => {
       `);
     });
 
+    it("is able to clone with nothing passed in", async () => {
+      expect(employee.$clone()).toMatchObject({
+        "$apiName": "Employee",
+        "$objectType": "Employee",
+        "$primaryKey": 50031,
+        "$title": "Jane Doe",
+        "class": "Blue",
+        "employeeId": 50031,
+        "fullName": "Jane Doe",
+        "office": "SEA",
+        "startDate": "2012-02-12",
+      });
+    });
+
     it("throws when merging objects with different primary keys", async () => {
       expect(() =>
         employee.$clone({

diff --git a/packages/e2e.sandbox.todoapp/src/useTodos.tsx b/packages/e2e.sandbox.todoapp/src/useTodos.tsx
@@ -124,7 +124,7 @@ export function useTodos() {
 
 type OsdkPropsOnly<T extends ObjectTypeDefinition> = Omit<
   Osdk<T>,
-  "$as" | "$link" | "$cloneAndUpdate"
+  "$as" | "$link" | "$clone"
 >;
 
 export interface SimpleTodo extends OsdkPropsOnly<MyOsdk.Todo> {}