Replace getPlaylistByHandleAndSlug by rickyrombo · Pull Request #13795 · AudiusProject/apps

rickyrombo · 2026-03-02T21:12:16Z

Regenerates the SDK following AudiusProject/api#678 and AudiusProject/api#677

Removes getPlaylistByHandleAndSlug in favor of calling getBulkPlaylists with permalink arg
Updates return values of CommentsAPI to match other writes
Updates embed player and client to use getBulkPlaylists
Updates API and SDK docs

changeset-bot · 2026-03-02T21:12:27Z

🦋 Changeset detected

Latest commit: ffa92c9

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages

Name	Type
@audius/sdk	Major
@audius/sdk-legacy	Patch
@audius/sp-actions	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

raymondjacobson

confirming things work for private / hidden playlists

Copilot

Pull request overview

Regenerates the Audius SDK and docs to remove getPlaylistByHandleAndSlug in favor of using getBulkPlaylists with permalink, and aligns comment-write responses with other write endpoints.

Changes:

Removed getPlaylistByHandleAndSlug from the generated Playlists API and added permalink support to getBulkPlaylists.
Updated generated write response models (WriteResponse, Create*Response) to return chain receipt fields (transaction hash + block hash/number) instead of success.
Updated embed client and common collection-by-permalink query to call getBulkPlaylists({ permalink: [...] }), and updated API/SDK docs accordingly.

Reviewed changes

Copilot reviewed 9 out of 16 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
packages/sdk/src/sdk/api/generated/default/models/WriteResponse.ts	Removes `success` and adds chain receipt fields to write responses.
packages/sdk/src/sdk/api/generated/default/models/CreateUserResponse.ts	Updates create-user response shape to chain receipt fields.
packages/sdk/src/sdk/api/generated/default/models/CreateTrackResponse.ts	Updates create-track response shape to chain receipt fields.
packages/sdk/src/sdk/api/generated/default/models/CreatePlaylistResponse.ts	Updates create-playlist response shape to chain receipt fields.
packages/sdk/src/sdk/api/generated/default/models/CreateDeveloperAppResponse.ts	Adds block hash/number to developer app creation response.
packages/sdk/src/sdk/api/generated/default/models/CreateCommentResponse.ts	Updates create-comment response shape to chain receipt fields.
packages/sdk/src/sdk/api/generated/default/apis/PlaylistsApi.ts	Adds `permalink` query param to `getBulkPlaylists` and removes `getPlaylistByHandleAndSlug`.
packages/sdk/src/sdk/api/comments/CommentsAPI.ts	Adjusts several comment writes to return the entity-manager receipt instead of `{ success: true }`.
packages/embed/src/util/BedtimeClient.js	Uses `getBulkPlaylists` with `permalink` to fetch collections by permalink.
packages/embed/src/components/app.jsx	Updates request typing for album vs playlist permalinks when fetching collections.
packages/common/src/api/tan-query/collection/useCollectionByPermalink.ts	Switches to `getBulkPlaylists({ permalink: [...] })` for permalink lookup.
docs/docs/developers/sdk/playlists.mdx	Updates SDK docs for `getBulkPlaylists` to include `permalink`.
docs/docs/developers/openapi.yaml	Adds `permalink` param to bulk playlists, removes by-permalink endpoint, updates write schemas.
docs/docs/developers/api/sidebar.ts	Removes the removed endpoint from the API sidebar.
docs/docs/developers/api/sidebar.generated.js	Mirrors sidebar removal in generated sidebar output.
.changeset/four-peas-impress.md	Declares a major SDK change and documents migration.

Comments suppressed due to low confidence (1)

docs/docs/developers/api/sidebar.ts:520

The sidebar entry for get-playlist-by-handle-and-slug was removed, but the doc page docs/docs/developers/api/get-playlist-by-handle-and-slug.api.mdx still exists. If the endpoint is removed, consider deleting that doc page (or adding a redirect/deprecation notice) to avoid publishing stale docs at a direct URL.

    {
      type: "category",
      label: "playlists",
      items: [
        {
          type: "doc",
          id: "developers/api/get-bulk-playlists",
          label: "Get Bulk Playlists",
          className: "api-method get",
        },
        {
          type: "doc",
          id: "developers/api/create-playlist",
          label: "Create Playlist",
          className: "api-method post",
        },
        {
          type: "doc",
          id: "developers/api/search-playlists",
          label: "Search Playlists",

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

packages/embed/src/components/app.jsx

packages/sdk/src/sdk/api/comments/CommentsAPI.ts

.changeset/four-peas-impress.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 9 out of 16 changed files in this pull request and generated 4 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-02T21:35:07Z

packages/sdk/src/sdk/api/comments/CommentsAPI.ts

      const metadata: EntityManagerReactCommentRequest = {
        userId: params.userId,
        commentId: params.commentId,
        isLiked: true,
        trackId: params.commentId // trackId represents the entity being commented on
      }


In the entity-manager path for reacting to a comment, trackId is being set to params.commentId, but trackId should represent the entity (track) the comment is on (i.e. params.metadata.entityId). As written, the relay metadata will reference the comment id as the track id, which can cause the reaction write to be attributed to the wrong entity or rejected. Populate trackId from params.metadata.entityId (encoded as a hash id, consistent with other entity-manager helpers) instead of params.commentId.

Copilot · 2026-03-02T21:35:08Z

packages/sdk/src/sdk/api/comments/CommentsAPI.ts

      const metadata: EntityManagerReactCommentRequest = {
        userId: params.userId,
        commentId: params.commentId,
        isLiked: false,
        trackId: params.commentId
      }


In the entity-manager path for unreacting to a comment, trackId is set to params.commentId, but trackId should be the entity (track) id from params.metadata.entityId. Using the comment id here makes the on-chain/relay metadata inconsistent with the API request and can break unreact writes. Set trackId based on params.metadata.entityId (encoded as a hash id) instead.

Copilot · 2026-03-02T21:35:08Z

packages/sdk/src/sdk/api/comments/CommentsAPI.ts

      const metadata: EntityManagerPinCommentRequest = {
        userId: params.userId,
        entityId: params.commentId,
        trackId: params.commentId, // trackId represents the entity being commented on
        isPin: true
      }


In the entity-manager path for pinning a comment, trackId is set to params.commentId, but trackId should be derived from params.metadata.entityId (the entity/track the comment is on). With the current mapping, the pin write metadata will reference the wrong entity. Set trackId from params.metadata.entityId (encoded as a hash id) instead.

Copilot · 2026-03-02T21:35:08Z

packages/sdk/src/sdk/api/comments/CommentsAPI.ts

@@ -313,10 +293,7 @@
        trackId: params.commentId,


In the entity-manager path for unpinning a comment, trackId is set to params.commentId, but it should represent the entity (track) id from params.metadata.entityId. Using the comment id here makes the relay metadata incorrect and can break unpin writes. Populate trackId from params.metadata.entityId (encoded as a hash id) instead.

Suggested change

trackId: params.commentId,

trackId: encodeHashId(params.metadata.entityId),

rickyrombo added 8 commits March 2, 2026 12:56

regen

1170a86

update embed player collection fetching

54e8db5

Fix comment return types

333d047

fix collection fetching in client

67c9ae0

changeset

4647c68

remove unused

fa57b1b

update API docs

5f699fd

update sdk docs

3fa6ed8

rickyrombo requested review from Copilot, dylanjeffers and raymondjacobson March 2, 2026 21:12

pull-request-size bot added the size/L label Mar 2, 2026

Copilot started reviewing on behalf of rickyrombo March 2, 2026 21:13 View session

raymondjacobson approved these changes Mar 2, 2026

View reviewed changes

Copilot AI reviewed Mar 2, 2026

View reviewed changes

packages/embed/src/components/app.jsx Show resolved Hide resolved

packages/embed/src/components/app.jsx Show resolved Hide resolved

packages/sdk/src/sdk/api/comments/CommentsAPI.ts Show resolved Hide resolved

.changeset/four-peas-impress.md Outdated Show resolved Hide resolved

rickyrombo and others added 3 commits March 2, 2026 13:19

Update .changeset/four-peas-impress.md

5a7cbe6

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

update create comment

e3f487e

Fix embed player

ffa92c9

rickyrombo requested a review from Copilot March 2, 2026 21:27

Copilot started reviewing on behalf of rickyrombo March 2, 2026 21:28 View session

Copilot AI reviewed Mar 2, 2026

View reviewed changes

rickyrombo merged commit d864806 into main Mar 2, 2026
16 checks passed

rickyrombo deleted the mjp-sdk-comments-playlists branch March 2, 2026 22:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Replace getPlaylistByHandleAndSlug#13795

Replace getPlaylistByHandleAndSlug#13795
rickyrombo merged 11 commits intomainfrom
mjp-sdk-comments-playlists

rickyrombo commented Mar 2, 2026

Uh oh!

changeset-bot bot commented Mar 2, 2026 •

edited

Loading

Uh oh!

raymondjacobson left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Mar 2, 2026

Uh oh!

Copilot AI Mar 2, 2026

Uh oh!

Copilot AI Mar 2, 2026

Uh oh!

Copilot AI Mar 2, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	trackId: params.commentId,
	trackId: encodeHashId(params.metadata.entityId),

Conversation

rickyrombo commented Mar 2, 2026

Uh oh!

changeset-bot bot commented Mar 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

raymondjacobson left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

changeset-bot bot commented Mar 2, 2026 •

edited

Loading