javascript icon indicating copy to clipboard operation
javascript copied to clipboard

Organization membership metadata

Open gkats opened this issue 3 years ago • 0 comments

Type of change

  • [ ] 🐛 Bug fix
  • [x] 🌟 New feature
  • [ ] 🔨 Breaking change
  • [ ] 📖 Refactoring / dependency upgrade / documentation
  • [ ] other:

Packages affected

  • [x] @clerk/clerk-js
  • [ ] @clerk/clerk-react
  • [ ] @clerk/nextjs
  • [ ] @clerk/remix
  • [x] @clerk/types
  • [ ] @clerk/themes
  • [ ] @clerk/clerk-expo
  • [x] @clerk/backend-core
  • [x] @clerk/clerk-sdk-node
  • [ ] @clerk/edge
  • [ ] build/tooling/chore

Description

  • [x] npm test runs as expected.
  • [x] npm run build runs as expected.

We've recently added public and private metadata fields for organization memberships. Both metadata fields can be accessed from the Backend API, but public metadata can only be read from the Frontend API.

This PR adds support for the organization metadata fields by:

  • Adding publicMetadata in the OrganizationMembershipResource type.
  • Adding publicMetadata in the OrganizationMembership resource in clerkJS.
  • Adding support for updating an organization membership's public and private metadata in backend-core and exposing it to our Node SDK.

The new backend-core method for the organizations API is organizations.updateOrganizationMembershipMetadata().

gkats avatar Aug 25 '22 07:08 gkats