feat!: SocialPlatformsResponse becomes ordered { platforms: SocialPlatformConfig[] }#6
Merged
Merged
Conversation
… } with required slug/capabilities
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Mirrors the breaking REST contract change in data-machine-socials#131. The
/platformsendpoint now returns an ordered array under a{ platforms: [...] }envelope withslugand canonicalcapabilitiesalways present on every entry. This PR updates the typed wrapper to match.Changes
Before
After
SocialsResource.getPlatforms()signature is unchanged on disk (Promise<SocialPlatformsResponse>); only the underlying type shape changed.Why
platformsarray — server controls display order (authenticated-first then A-Z), clients render in iteration order. No more relying on JS object key insertion order.slugalways present — clients no longer reconstruct it from object keys.capabilitiesshape — kills thestring[]legacy fallback in client code (server-sidenormalize_capabilitieshandles legacy handler output before serialization).Coordinated rollout
This is PR B of a 3-PR cluster:
Studio + any other api-client consumer will break against the new server response until C lands. Order: A → B → C, deploy in same order.
Test plan
npx tsc --noEmitcleannpm run buildclean (CJS + ESM + DTS bundles)