@curiouslearning/gdl-player-core

Shared core player package for GDL interactive books.

Purpose

This library contains shared player code used by:

• interactive-book-builder
• GDLbook

Both apps should import from this package instead of duplicating local player components.

Tooling

• Package manager: npm
• Build: Vite library mode
• Type declarations: TypeScript tsc during the build step
• Registry: npmjs
• Versioning: semantic-release on main using Conventional Commits

Development

Install dependencies:

npm install

Build package output:

npm run build

Build artifacts are emitted to dist/:

• dist/index.js (ESM)
• dist/index.cjs (CommonJS)
• dist/index.d.ts (types)

Publishing (npmjs)

Publishing is automated in CircleCI when changes land on main and validation jobs pass.

Requirements:

1. NPM_TOKEN available in CI with publish permissions for @curiouslearning.
2. Conventional Commit messages so semantic-release can calculate versions.

Common commit examples:

git commit -m "fix: handle undefined page media"
git commit -m "feat: add swipe threshold option"
git commit -m "feat!: remove deprecated player prop"
git commit -m "feat: replace page media schema" -m "BREAKING CHANGE: page.media now requires mimeType"

Release impact:

• fix -> patch release
• feat -> minor release
• feat! or BREAKING CHANGE: footer -> major release

For local validation before merge:

npm run ci:verify

Consuming in other repos

Install:

npm install @curiouslearning/gdl-player-core

Then replace local component imports with package imports.