unsafe_metadata required on UpdateUserMetadataParams

Author: brunol95

packages/clerk-js/src/core/resources/__tests__/User.test.ts

@@ -745,18 +745,20 @@ describe('User', () => {
     });
   });
 
-  it('.updateMetadata omits unsafe_metadata when not provided', async () => {
+  it('.updateMetadata sends an explicit null patch when a key is being removed', async () => {
     // @ts-ignore
     BaseResource._fetch = vi.fn().mockReturnValue(Promise.resolve({ response: {} }));
 
     const user = new User({} as unknown as UserJSON);
-    await user.updateMetadata({});
+    await user.updateMetadata({ unsafeMetadata: { theme: null as unknown as undefined } });
 
     // @ts-ignore
     expect(BaseResource._fetch).toHaveBeenCalledWith({
       method: 'PATCH',
       path: '/me/metadata',
-      body: {},
+      body: {
+        unsafeMetadata: JSON.stringify({ theme: null }),
+      },
     });
   });
 });

packages/shared/src/types/user.ts

@@ -190,12 +190,12 @@ export type UpdateUserParams = Partial<SnakeToCamel<UpdateUserJSON>>;
 
 /**
  * Parameters for {@link UserResource.updateMetadata}. Only `unsafeMetadata`
- * is end-user-writable on the Frontend API. The submitted value is deep-merged
- * with the existing `unsafeMetadata`; keys at any level whose value is `null`
- * are removed.
+ * is end-user-writable on the Frontend API and the field is required: the
+ * submitted value is deep-merged with the existing `unsafeMetadata`, and keys
+ * at any level whose value is `null` are removed.
  */
 export type UpdateUserMetadataParams = {
-  unsafeMetadata?: UserUnsafeMetadata;
+  unsafeMetadata: UserUnsafeMetadata;
 };
 
 export type UpdateUserPasswordParams = {