Repository navigation
Conversation
Runs `pnpm -F site check:api-stability --fix` across the packages: every public export that no reference page documents is now tagged @internal, and the DASH and Shaka media, whose pages are marked unstable, are tagged @experimental. The i18n and VJSC schema generators emit the tag in their output, so rebuilding keeps it. The website-tests astro-check job now runs the check after generating site content. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WLkDiofiR86hzNgRopBotH
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
@videojs/cdn
@videojs/cli
@videojs/core
@videojs/element
@videojs/html
@videojs/media
@videojs/react
@videojs/spf
@videojs/store
@videojs/utils
@videojs/cloudflare-video
@videojs/dash-video
@videojs/hlsjs-video
@videojs/mux-audio
@videojs/mux-video
@videojs/native-hls-video
@videojs/shaka-video
@videojs/spotify-audio
@videojs/tiktok-video
@videojs/twitch-video
@videojs/vimeo-video
@videojs/wistia-video
@videojs/youtube-video
@videojs/google-cast
@videojs/mux-data
commit: |
📦 Bundle Size Report🎨 @videojs/html — 1 small size change
Presets (7)
Media (18)
Players (5)
Skins (41)
UI Components (62)
⚛️ @videojs/react — 12 small size changes
Presets (7)
Media (22)
Extensions (2)
Players (5)
Skins (26)
UI Components (39)
🧩 @videojs/core — 1 small size change
Entries (76)
🏷️ @videojs/element — no changesEntries (2)
📦 @videojs/store — no changesEntries (3)
🔧 @videojs/utils — no changesEntries (13)
📦 @videojs/cdn — no changes📦 @videojs/cloudflare-video — no changes📦 @videojs/dash-video — no changes📦 @videojs/google-cast — no changes📦 @videojs/hlsjs-video — no changes📦 @videojs/media — no changesEntries (3)
📦 @videojs/mux — no changes📦 @videojs/mux-audio — no changesEntries (2)
📦 @videojs/mux-data — no changes📦 @videojs/mux-video — no changesEntries (2)
📦 @videojs/native-hls-video — no changes📦 @videojs/shaka-video — no changes📦 @videojs/spf — no changesEntries (7)
📦 @videojs/spotify-audio — no changes📦 @videojs/tiktok-video — no changes📦 @videojs/twitch-video — no changes📦 @videojs/other — 1 small size change
Entries (3)
📦 @videojs/vimeo-video — no changes📦 @videojs/wistia-video — no changesEntries (2)
📦 @videojs/youtube-video — no changesℹ️ How to interpretEach entry is independently bundled, minified, and brotli-compressed. Initial size includes its static import graph; lazy dynamic chunks are reported separately. Entries are not additive because their dependency graphs overlap. Preset rows represent realistic combined bundles. Changes of 300 B or less across initial, lazy, and total size are collapsed, not discarded. Run |
✅ Deploy Preview for vjs-registry ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for vjs10-site ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
…arthy-7ams8m-tags
…ccarthy-7ams8m-tags # Conflicts: # packages/core/src/dom/player.ts # packages/html/src/define/media/dash-video.ts # packages/html/src/define/media/shaka-video.ts # packages/html/src/store/types.ts # packages/html/src/ui/media-button-element.ts # packages/html/src/ui/media-ui-element.ts # packages/media/src/dom/html-media-adapter/html-media-adapter.ts # packages/react/src/ui/time-slider/chapters.tsx # packages/utils/src/dom/types.ts
Re-run `pnpm -F site check:api-stability --fix` on top of the exports branch. Types that stable exports reference lose their `@internal` tag, the Core classes that no longer appear in public signatures gain it, and types referenced only by the DASH and Shaka media become `@experimental`. The i18n types generator no longer marks `TranslationParams` internal, because stable translation APIs reference it. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WLkDiofiR86hzNgRopBotH
…ccarthy-7ams8m-tags # Conflicts: # packages/core/src/core/ui/status-indicator/status.ts
…ccarthy-7ams8m-tags
…ental rule Adapter classes, media track contracts, and other types reached through mixin bases and local helpers lose @internal (or move to @experimental behind the DASH and Shaka pages); the constants the literal-union types no longer name gain it. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WLkDiofiR86hzNgRopBotH
…ccarthy-7ams8m-tags
…ccarthy-7ams8m-tags
…ccarthy-7ams8m-tags
decepulis
left a comment
There was a problem hiding this comment.
Agent review (part of the stack review; see #3063 for method). I scripted every added tag in the diff (786: 765 @internal, 21 @experimental) to the declaration it lands on: all land on an export declaration (none on imports, directives or re-export statements), every overload set is fully tagged, the generated i18n/vjsc outputs match their generators, TranslationParams/LOCALES/ReactiveController/ReactiveControllerHost/MediaButtonElement/ContextPartElement/UIElement/ReactiveElement are stable as rahim decided, the create* controllers and use*Context hooks are internal (answer 6), status-indicator/status.ts equals main plus two tags, the api-docs builder doesn't filter on top-level @internal and no tsconfig sets stripInternal, so no page or consumer .d.ts loses content.
Inline: 🔴 PropertyValues, 🟡 PartContextValue, 🟡 DestroyMixin. All three are the same shape: subclassing surface of base classes B(a) made stable, which the checker can't see because it skips protected members or inline-code mentions.
Follow-ups from #3063's heuristic comments that will change this diff once fixed: React i18n Text/TextProps currently stay untagged only because media-text.mdx documents a subject named Text; core's *Options controller contracts need @internal once the companion match is narrowed.
🟣 Decision for rahim: useMediaInstance, useMediaExtension, useAttachMedia, composeRefs (@videojs/react) become @internal. That follows rule 1 and answer 6, but the 10.0.0-beta.11 changelog announced them as the exported "media component building blocks … so you can build custom media components without reaching into internal module paths". Worth a conscious yes rather than a mechanical one.
Housekeeping: GitHub reports this PR as un-mergeable ("dirty"), but git merge-tree of the base into the head is clean and the head already contains the base; the flag looks stale. The description's "branch protection needs astro-check" is right and currently unmet: the main ruleset has no required status checks, so the new CI step reports but doesn't block until a maintainer adds it. The counts in the description (1,829 / 1,072 / 738) are from before #3083 was stacked; the top of the stack now reports 1,894 / 1,113 / 762.
Generated by Claude Code
…ccarthy-7ams8m-tags # Conflicts: # packages/react/src/ui/audio-track-radio-group/component.tsx # packages/react/src/ui/captions-radio-group/component.tsx # packages/react/src/ui/playback-rate-radio-group/component.tsx # packages/react/src/ui/quality-radio-group/component.tsx
…ccarthy-7ams8m-tags
…ccarthy-7ams8m-tags
…ccarthy-7ams8m-tags # Conflicts: # packages/media/src/dom/html-media-adapter/html-media-adapter.ts # packages/media/src/dom/utils/media-extensions.ts # packages/react/src/utils/use-media-extension.ts
Main's #2880 tags `PlayerExtension`, `ExtensionPlayer`, and `MediaOverride*` internal, but the documented Cast and Mux Data classes implemented `PlayerExtension` and exposed its lifecycle, which made the contract stable by reference. Tag those lifecycle members internal and drop the `implements` clause; the element and hook that register an extension still check that it conforms. Also tags main's new `VERSION` exports, extension context, and `AnyHTMLMediaAdapter`. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WLkDiofiR86hzNgRopBotH
…ccarthy-7ams8m-tags
…ccarthy-7ams8m-tags # Conflicts: # packages/core/src/core/ui/seek-indicator/status.ts # packages/core/src/dom/ui/popover/positioning.ts
mihar-22
left a comment
There was a problem hiding this comment.
looks great, i think let's re-review what should be considered public from core/i18n
Per review, the text descriptors and the i18n helpers readers build custom UI
with are public API:
- `@videojs/{react,html}/i18n/text/*` re-export core's text descriptor modules;
the locale generator writes them alongside the locale re-exports.
- `getCanonicalLocaleKey` is renamed `getLocaleKey`.
- `getLocaleKey`, `findLocaleKeys`, `loadLocale`, `isText`, `translateText`,
and `resolveTranslation` drop `@internal`, are re-exported from both
`/i18n` entries, and get reference pages.
- Core's build cache tracks its generator scripts, so a generator change no
longer restores stale generated sources.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WLkDiofiR86hzNgRopBotH
…ccarthy-7ams8m-tags # Conflicts: # packages/react/src/media/dash-video/adapter.tsx
#3098 exported it from @videojs/react without a reference page; like useMediaInstance and useAttachMedia, it is a custom-media building block. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WLkDiofiR86hzNgRopBotH
…ccarthy-7ams8m-tags
…ccarthy-7ams8m-tags
Part 6 of the API stability stack: #3073 → #3063 → #3066 → #3067 → #3082 → this PR → #3083.
Summary
pnpm -F site check:api-stability --fixacross the packages, using the rules from feat(site): check that undocumented public exports are tagged internal #3063:stability: unstablepage documents it, or only experimental exports reference it →@experimental.@internal.@videojs/react,@videojs/html, an extension package or@videojs/store.HlsJsAdapter,MuxVideoAdapter, …) and the media contracts they implement are stable. The DASH and Shaka adapters, andEngineAdapter/WithMediaTracks, which only they reach, are@experimental, like their pages.deriveCustomStatustypes from feat(core): add deriveCustomStatus to display custom actions #3064 (StatusDetails,InputActionEvent,MediaSnapshot, …) are stable.resolveAdapterTypeandresolveMimeTypefrom feat(media): add resolveAdapterType and resolveMimeType #3024 are stable, through their reference pages. The embed source parsers that feat(media): add resolveAdapterType and resolveMimeType #3024 moved into@videojs/media(parseYouTubeSource,ParsedVimeoSource, …) keep their@internaltags in their new location.create*controller contracts (ButtonOptions,MenuOptions,PopoverOptions,TooltipOptions, …) and React's i18nText/TextPropsare@internal.useMediaInstance,useAttachMedia,composeRefsand feat(react): add mediaRef prop to media components #3098'suseMediaRef(@videojs/react) are@internal. This was decided for the first three, anduseMediaRefis the same kind of custom-media building block. The 10.0.0-beta.11 changelog announced the first three as building blocks for custom media components. (useMediaExtensionis gone: refactor(packages)!: attach extensions at the player #2880 removed it.) Making them public later means a reference page orapisentries; the check then removes the tags. feat(react): add mediaRef prop to media components #3098'sMediaRefPropsis stable, because the media components' props extend it.PropertyValues(UIElement's lifecycle hooks),PartContextValue(ContextPartElement's abstractconsumer), the interfaces typingMediaButtonElement's abstractcore, andDestroyMixin, which the UIElement page documents.playText,forwardText, …) can be imported from new@videojs/react/i18n/text/*and@videojs/html/i18n/text/*entry points, which re-export core's modules. Translation phrases documents them and lists the 17 modules inapis.getCanonicalLocaleKeyis renamedgetLocaleKey. This is a breaking rename for anyone importing it from@videojs/core/i18n.getLocaleKey,findLocaleKeys,loadLocale,isText,translateTextandresolveTranslationare re-exported from both/i18nentries, and each gets a reference page.TextandTextParamsare stable by reference.PlayerExtension,ExtensionPlayer,MediaOverrideandMediaOverrideSourcewere coming out stable becauseGoogleCastExtensionandMuxDataExtensionimplementedPlayerExtensionand exposed its lifecycle.connect,disconnect,attach,detach,mediaOverride) are now@internal, and theimplementsclause is gone.PlayerExtensionElementandusePlayerExtensionstill check at compile time that an extension conforms.destroyand the props stay public.main's new exports are tagged:VERSIONfrom feat(packages): export a per-package VERSION from core, html, and react #3078 (@videojs/core,/html,/react) is@internalbecause no page documents it yet.extensionContext,ExtensionContext, …) andAnyHTMLMediaAdapterare@internal.useMediaReffrom feat(react): add mediaRef prop to media components #3098 is@internal(see above).locales/allstays@internal, and the text descriptors andloadLocalecome out untagged (stable).TranslationParamsis stable, because stable translation APIs reference it. The locale generator also writes the platformi18n/text/*re-exports.@videojs/core/vjsc)scripts/**as an input. Without it, a cache hit after a generator change restored outdated generated sources.Check public API stability tagsstep to the website-testsastro-checkjob, afterpnpm build:packagesand site content generation. Themainruleset has no required status checks yet, so the step reports but doesn't block merging until a maintainer makesastro-checkrequired.Preview pages
Six new i18n reference pages:
reference/api/get-locale-keyreference/api/find-locale-keysreference/api/load-localereference/api/is-textreference/api/translate-textreference/api/resolve-translationTranslation phrases also gains a "Text descriptors" section. Apart from those, the tags don't change any rendered page.
Reviewer notes
packages/core/scripts/and core's build-cache inputspackages/vjsc/src/components/schema/generate.tsmain's feat(core): add deriveCustomStatus to display custom actions #3064 changes tostatus-indicator/status.ts, and feat(react): add mediaRef prop to media components #3098'smediaRefinto the taggedDashVideoPlayerExtensionElement(see above)i18n/text/*package entries, and the new pagesDashVideoandShakaVideo, which are@experimental.@videojs/mux-data'sMuxDataOptionsandMuxDataSdkresolve to no declaration, because that package's build doesn't emittypes.d.ts. That's a separate build bug.Testing
pnpm build:packages,pnpm typecheckpnpm -F site check:api-stability: all 1,901 checked exports are documented, referenced or tagged.markdown-negotiation, which fails only on local Node 22 becauseURLPatternis missingpnpm -F site api-docsproduces reference data for the six new pages.pnpm lint,pnpm check:workspace,astro check --minimumSeverity warning(0 errors, 0 warnings)🤖 Generated with Claude Code
https://claude.ai/code/session_01WLkDiofiR86hzNgRopBotH