Skip to content

feat: deprecate extend methods #2299

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Jun 13, 2025
Merged

feat: deprecate extend methods #2299

merged 11 commits into from
Jun 13, 2025

Conversation

emmyoh
Copy link
Member

@emmyoh emmyoh commented May 20, 2025

Closes #2189.

Changes the public API in the jazz-tools package, deprecating Group.extend and Group.revokeExtend (replaced by Group.addMember and Group.removeMember respectively); the internal API in cojson is unchanged for now.

Documentation preview: https://jazz-homepage-git-emil-group-inheritance-evolution-gcmp.vercel.app/docs/react/groups/inheritance


todo:

  • add unextend tests in packages/jazz-tools/src/tests/groupsAndAccounts.test.ts
    • also add more addMember tests
      • member is not Group but role is undefined (type error)
      • member is not Group but role is inherit (type error)
      • member is Group but role is writeOnly (type error and should throw)
  • test affected example apps by hand
    • music player example app
      • adding tracks to playlists
      • removing tracks from playlists
  • rewrite group inheritance documentation in terms of adding & removing groups as members
  • changeset

todo:
- add unextend tests in `packages/jazz-tools/src/tests/groupsAndAccounts.test.ts`
  - also add more `addMember` tests
    - `member` is not `Group` but `role` is `undefined` (type error)
    - `member` is not `Group` but `role` is `inherit` (type error)
- changeset
@emmyoh emmyoh requested a review from gdorsi May 20, 2025 17:36
@emmyoh emmyoh self-assigned this May 20, 2025
@emmyoh emmyoh added this to 🚢 May 20, 2025
@emmyoh emmyoh moved this to In Progress in 🚢 May 20, 2025
Copy link

vercel bot commented May 20, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
clerk-demo ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 10, 2025 4:34pm
design-system ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 10, 2025 4:34pm
file-upload-demo ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 10, 2025 4:34pm
form-demo ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 10, 2025 4:34pm
gcmp-homepage ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 10, 2025 4:34pm
image-upload-demo ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 10, 2025 4:34pm
jazz-chat ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 10, 2025 4:34pm
jazz-chat-1 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 10, 2025 4:34pm
jazz-chat-2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 10, 2025 4:34pm
jazz-filestream ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 10, 2025 4:34pm
jazz-homepage ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 10, 2025 4:34pm
jazz-image-upload ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 10, 2025 4:34pm
jazz-inspector ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 10, 2025 4:34pm
jazz-multi-cursors ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 10, 2025 4:34pm
jazz-organization ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 10, 2025 4:34pm
jazz-paper-scissors ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 10, 2025 4:34pm
jazz-pets ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 10, 2025 4:34pm
jazz-richtext ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 10, 2025 4:34pm
jazz-richtext-prosekit ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 10, 2025 4:34pm
jazz-richtext-tiptap ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 10, 2025 4:34pm
jazz-todo ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 10, 2025 4:34pm
jazz-version-history ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 10, 2025 4:34pm
music-demo ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 10, 2025 4:34pm
passkey-demo ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 10, 2025 4:34pm
passphrase-auth-demo ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 10, 2025 4:34pm
passwords-demo ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 10, 2025 4:34pm
reactions-demo ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 10, 2025 4:34pm

@gdorsi gdorsi merged commit 201e2fd into main Jun 13, 2025
45 checks passed
@gdorsi gdorsi deleted the emil/group-inheritance-evolution branch June 13, 2025 11:18
@github-project-automation github-project-automation bot moved this from Waiting for feedback to Done in 🚢 Jun 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Groups as members: make Group.addMember support groups as inputs
3 participants