docs: Update CHANGELOG.md for version 0.1.0 release #16
Conversation
- Add MIT license declaration to the tsup build output banner.
- Refactor `src/index.ts` to improve code structure and readability:
- Move `InteractiveVideoProps` interface definition outside of `defineComponent`.
- Reformat component `props` definition for better clarity.
Updated CHANGELOG.md to reflect the release of version 0.1.0, including new features and chore updates.
WalkthroughThe changes update the changelog for version 0.1.0, refactor the Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~7 minutes Possibly related PRs
Poem
Note 🔌 MCP (Model Context Protocol) integration is now available in Early Access!Pro users can now connect to remote MCP servers under the Integrations page to get reviews and chat conversations that understand additional development context. ✨ Finishing Touches
🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (4)
tsup.config.ts (1)
16-21: Preserve license banner in minified buildsGood call adding the MIT license line. To ensure minifiers don’t strip it, switch the opening comment to /*! ... */ which many tools preserve by convention.
- banner: { - js: `/** + banner: { + js: `/*! * ${pkg.name} v${pkg.version} * Author: ${pkg.author} * @license MIT */ `, },src/index.ts (2)
83-84: Avoid deprecated String.prototype.substr for ID generationsubstr is deprecated. Prefer slice and use crypto.randomUUID when available for better uniqueness.
- const playerTargetId = props.targetElementId || `ivlabs-player-${Math.random().toString(36).substr(2, 9)}`; + const playerTargetId = + props.targetElementId || + `ivlabs-player-${ + (typeof crypto !== 'undefined' && 'randomUUID' in crypto + ? crypto.randomUUID() + : Math.random().toString(36).slice(2, 11)) + }`;
167-171: React to locale changes for translationsIf locale changes at runtime, translations won’t be re-applied. Consider watching locale and reloading translations when both are present.
watch(() => props.translations, (newTranslations) => { if (playerRef.value && newTranslations) { playerRef.value.loadTranslations(props.locale, newTranslations); } }, { deep: true }); + + watch(() => props.locale, (newLocale) => { + if (playerRef.value && props.translations) { + playerRef.value.loadTranslations(newLocale, props.translations); + } + });CHANGELOG.md (1)
11-25: Align sections with Keep a Changelog; call out breaking change explicitlyThe entry reads well. To better match Keep a Changelog, prefer “Added/Changed/Deprecated/Removed/Fixed/Security” over “Features/Chores”, and add a “Breaking Changes” note about the null render when targetElementId is set.
Example tweak:
- Rename “Features” -> “Added”
- Rename “Chores” -> “Changed”
- Add:
- “Breaking Changes”: When targetElementId is provided, the component renders no container div. Consumers must provide the element and cannot rely on fallthrough attributes.
I can draft the exact diff if you confirm the preferred section naming.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
CHANGELOG.md(1 hunks)src/index.ts(1 hunks)tsup.config.ts(1 hunks)
🔇 Additional comments (5)
src/index.ts (5)
7-26: Interface refactor aligns props with PlayerConfigThe exported InteractiveVideoProps correctly omits player-managed fields and types onAnalyticsEvent/cues/translations. Looks good.
122-127: Event wiring looks correctRegistering a fixed set of analytics events and forwarding payloads is straightforward and safe.
141-147: Mount timing is safeUsing nextTick inside onMounted ensures the container div exists before initializing the player. Good.
148-153: Cleanup handled properlyplayer.destroy on unmount with ref nulling is correct.
181-194: Document null render behavior with targetElementIdReturning null when targetElementId is provided is a breaking render change. The code is fine; ensure this is clearly documented so consumers don’t expect container attributes to apply in this mode.
Would you like me to add a short usage snippet to README and a migration note?
Summary by CodeRabbit
Documentation
Style
Refactor