PA - VideoPress: expose the Leaderboard component through the SDK

[retrofox]

Fixes WOOA7S-2222

Proposed changes

Step 3 of the VideoPress consumer stack (WOOA7S-2221), after #52874 and #52965.

@automattic/jetpack-premium-analytics-sdk exports what the three Ads widgets import and nothing else.

The Top videos widget cannot leave the package until the SDK carries what it renders with. After #52965 that is one component, not a construction kit.

What the SDK gains

Leaderboard, with its types LeaderboardProps, LeaderboardRowInput, LeaderboardStatus and LeaderboardDrillDown: ranked rows and a request status in; the chart with its states, comparison and drill-down out.

describeError(), the dashboard's mapping from a failed request to the widget's error state: no Retry on an access-denied failure, Retry otherwise.

useStatsVideoPlays, provisional like the WordAds hooks: the Videos report reads it too and stays in the package until reports are registrable. It leaves the SDK when VideoPress owns its data (WOOA7S-2234).

The packages/sdk facade re-exports them, and src/index.d.ts of the js-package declares them, loosely typed like the rest of the contract for now.

getVideoKey() and getVideoLabel() stay out: nothing but the widget uses them, so they move with it in step 4.

WIDGET_ROW_LIMIT stays out too. Leaderboard caps the rows it shows, and a consumer sizes its own request.

The contract

WIDGET_API_VERSION moves to 1.2.0: a consumer can rely on something new; nothing built against 1.x breaks. The docs now list what each minor added.

The conformance check

packages/sdk/src/conformance.ts already failed the typecheck when the facade missed a declared value.

It now fails the other way too: when the facade exports a value the declaration file doesn't include, since a consumer can't import it.

Related product discussion/links

Linear: WOOA7S-2221 for the stack, WOOA7S-2222 for this step. Umbrella #52867.

Does this pull request change what data or activity we track or use?

No.

Testing instructions

jetpack build packages/premium-analytics

pnpm --filter @automattic/jetpack-premium-analytics run typecheck

pnpm --filter @automattic/jetpack-premium-analytics-sdk run typecheck

On a connected site with the dashboard built, GET /wp-json/wpcom/v2/widget-modules still lists the Ads widgets, and the Ads section renders as before: the facade only gained exports.

In the browser console on the dashboard page...

import( '@automattic/jetpack-premium-analytics-sdk' ).then( m => console.log( Object.keys( m ) ) )

...lists Leaderboard, describeError and useStatsVideoPlays next to the existing names.

To see the conformance check work, remove Leaderboard from src/index.d.ts of the js-package and run the package typecheck: it fails on isDeclared naming the missing export. Restore it.

[github-actions]

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

• To test on WoA, go to the Plugins menu on a WoA dev site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin (Jetpack), and enable the update/pa-extensibility-videopress-sdk-exports branch.
• To test on Simple, run the following command on your sandbox:

bin/jetpack-downloader test jetpack update/pa-extensibility-videopress-sdk-exports

Interested in more tips and information?

• In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
• Read more about our development workflow here: PCYsg-eg0-p2
• Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

[github-actions]

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

• ✅ Include a description of your PR changes.
  
• ✅ Add a "[Status]" label (In Progress, Needs Review, ...).
  
• ✅ Add testing instructions.
  
• ✅ Specify whether this PR includes any changes to data or privacy.
  
• ✅ Add changelog entries to affected projects
  

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

---

Follow this PR Review Process:

1. Ensure all required checks appearing at the bottom of this PR are passing.
2. Make sure to test your changes on all platforms that it applies to. You're responsible for the quality of the code you ship.
3. You can use GitHub's Reviewers functionality to request a review.
4. When it's reviewed and merged, you will be pinged in Slack to deploy the changes to WordPress.com simple once the build is done.

If you have questions about anything, reach out in #jetpack-developers for guidance!

[jp-launch-control]

Code Coverage Summary

Coverage changed in 1 file.

File	Coverage	Δ%	Δ Uncovered
projects/packages/premium-analytics/packages/sdk/src/conformance.ts	0/2 (0.00%)	0.00%	1 ❤️‍🩹

Full summary · PHP report · JS report

[Nikschavan]

Thank you, the changes look good.