@curiouslearning/gdl-player-core 1.1.0

package/README.md

@@ -0,0 +1,80 @@
+# @curiouslearning/gdl-player-core
+
+Shared core player package for GDL interactive books.
+
+## Purpose
+
+This package 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:
+
+```bash
+npm install
+```
+
+Build package output:
+
+```bash
+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:
+
+```bash
+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:
+
+```bash
+npm run ci:verify
+```
+
+## Consuming in other repos
+
+Install:
+
+```bash
+npm install @curiouslearning/gdl-player-core
+```
+
+Then replace local component imports with package imports.

package/dist/Image-BUpmrK8U.cjs

@@ -0,0 +1 @@
+const e=require("./utils-DTI6gl3r.cjs");var t=e.o(),n=({mediaItem:n})=>(0,t.jsx)(`img`,{src:e.n(e.a(),n),alt:``,loading:`lazy`,className:`max-w-full max-h-full w-full h-full -z-10`});exports.Image=n,exports.default=n;

package/dist/Image-Bwx-qXJQ.js

@@ -0,0 +1,10 @@
+import { a as e, n as t, o as n } from "./utils-Dm7P4Nnv.js";
+//#region src/components/Image.tsx
+var r = n(), i = ({ mediaItem: n }) => /* @__PURE__ */ (0, r.jsx)("img", {
+	src: t(e(), n),
+	alt: "",
+	loading: "lazy",
+	className: "max-w-full max-h-full w-full h-full -z-10"
+});
+//#endregion
+export { i as Image, i as default };

package/dist/components/Animate.d.ts

@@ -0,0 +1,11 @@
+import React from 'react';
+import { AnimationProps } from '../types/animation';
+export declare const Animation: {
+    ({ item, screenScale, onMediaClick, ref, }: AnimationProps): React.JSX.Element | null;
+    displayName: string;
+};
+declare const _default: React.MemoExoticComponent<{
+    ({ item, screenScale, onMediaClick, ref, }: AnimationProps): React.JSX.Element | null;
+    displayName: string;
+}>;
+export default _default;

package/dist/components/Background.d.ts

@@ -0,0 +1,6 @@
+import { PageBackground } from '../types/book';
+type BackgroundProps = {
+    background: PageBackground;
+};
+export declare const Background: (props: BackgroundProps) => import("react").JSX.Element;
+export {};

package/dist/components/Image.d.ts

@@ -0,0 +1,4 @@
+export declare const Image: ({ mediaItem }: {
+    mediaItem: any;
+}) => import("react").JSX.Element;
+export default Image;

package/dist/components/LazySvg.d.ts

@@ -0,0 +1,9 @@
+import { ComponentProps } from 'react';
+import React from 'react';
+interface LazySvgProps extends ComponentProps<'svg'> {
+    path: string;
+    mediaType?: string;
+}
+export declare const LazySvg: React.MemoExoticComponent<({ path, mediaType, ...props }: LazySvgProps) => React.JSX.Element | null>;
+declare const _default: React.MemoExoticComponent<React.MemoExoticComponent<({ path, mediaType, ...props }: LazySvgProps) => React.JSX.Element | null>>;
+export default _default;

package/dist/components/MediaItemWrapper.d.ts

@@ -0,0 +1,13 @@
+import { type ReactNode } from 'react';
+import React from 'react';
+import { MediaType } from '../types/media';
+export declare const MediaItemWrapper: {
+    ({ item, screenScale, children, onActivate, }: {
+        item: MediaType;
+        screenScale: number;
+        children?: ReactNode;
+        onActivate?: () => void;
+    }): React.JSX.Element;
+    displayName: string;
+};
+export default MediaItemWrapper;

package/dist/components/Page.d.ts

@@ -0,0 +1,7 @@
+import { Page } from '../types/book';
+export declare const BookPage: ({ page, screenScale, isActive, textDirection, }: {
+    page: Page;
+    screenScale: number;
+    isActive: boolean;
+    textDirection?: "LTR" | "RTL";
+}) => import("react").JSX.Element;

package/dist/components/PageTextSegments.d.ts

@@ -0,0 +1,19 @@
+import React from 'react';
+import { WordItemType } from '../types/book';
+import { AudioSegment, AudioSegments, PageAudio } from '../types/audio';
+type ChildProps = {
+    segments: AudioSegments | WordItemType[];
+    pageAudio?: PageAudio | null;
+    onWordSelect?: (wordItem: AudioSegment | WordItemType) => void;
+    highlightIds?: Array<number>;
+    setIsPlaying: React.Dispatch<React.SetStateAction<boolean | null>>;
+    ref: React.Ref<PlayerRef>;
+    textDirection?: 'LTR' | 'RTL';
+};
+export type PlayerRef = {
+    onPlay: () => void;
+    onAbortAudio: () => void;
+    isPlaying?: boolean;
+};
+export declare const TextSegments: React.MemoExoticComponent<({ segments, pageAudio, setIsPlaying, onWordSelect, highlightIds, ref, textDirection, }: ChildProps) => React.JSX.Element>;
+export default TextSegments;

package/dist/components/Player.d.ts

@@ -0,0 +1,8 @@
+import type { PlayerAnalytics } from '../types/analytics';
+import type { FontDefinition } from '../types/font';
+export type PlayerProps = {
+    id?: string;
+    analytics?: PlayerAnalytics;
+    fonts?: FontDefinition[];
+};
+export declare const Player: ({ id, analytics, fonts }: PlayerProps) => import("react").JSX.Element;

package/dist/components/SwipeNav.d.ts

@@ -0,0 +1,7 @@
+export declare const SwipeNav: ({ isFirst, isLast, activeIndex, textDirection, }: {
+    isFirst: boolean;
+    isLast: boolean;
+    activeIndex: number;
+    textDirection?: "LTR" | "RTL";
+}) => import("react").JSX.Element;
+export default SwipeNav;

package/dist/components/dolottie.d.ts

@@ -0,0 +1,13 @@
+import React from 'react';
+import { MediaType } from '../types/media';
+export declare const LottieFile: React.MemoExoticComponent<({ item, play, setDotLottie, }: {
+    item: MediaType;
+    play?: boolean;
+    setDotLottie: any;
+}) => React.JSX.Element>;
+declare const _default: React.MemoExoticComponent<React.MemoExoticComponent<({ item, play, setDotLottie, }: {
+    item: MediaType;
+    play?: boolean;
+    setDotLottie: any;
+}) => React.JSX.Element>>;
+export default _default;

package/dist/components/effectlib/bounce.d.ts

@@ -0,0 +1,3 @@
+import { ChildProps } from '../../types/animation';
+export declare const AnimatedBounce: ({ item, children, effectCallback, onEffectStart, ref, }: ChildProps) => import("react").JSX.Element;
+export default AnimatedBounce;

package/dist/components/effectlib/highlight.d.ts

@@ -0,0 +1,3 @@
+import { ChildProps } from '../../types/animation';
+export declare const AnimatedHighlight: ({ item, children, effectCallback, onEffectEnd, onEffectStart, ref, }: ChildProps) => import("react").JSX.Element;
+export default AnimatedHighlight;

package/dist/components/effectlib/jump.d.ts

@@ -0,0 +1,3 @@
+import { ChildProps } from '../../types/animation';
+export declare const AnimatedJump: ({ item, children, effectCallback, onEffectEnd, onEffectStart, ref, }: ChildProps) => import("react").JSX.Element;
+export default AnimatedJump;

package/dist/components/effectlib/move.d.ts

@@ -0,0 +1,18 @@
+import React from 'react';
+import { ChildRef } from '../../types/animation';
+interface ChildProps {
+    children: React.ReactNode;
+    screenScale: number;
+    position: {
+        from: number;
+        to: number;
+    };
+    settings: {
+        duration?: number;
+    };
+    onEffectEnd?: () => void;
+    onEffectStart?: () => void;
+    ref: React.Ref<ChildRef>;
+}
+export declare const Movement: ({ children, position, screenScale, settings, onEffectEnd, onEffectStart, ref, }: ChildProps) => React.JSX.Element;
+export default Movement;

package/dist/components/effectlib/noeffect.d.ts

@@ -0,0 +1,3 @@
+import { ChildProps } from '../../types/animation';
+export declare const NoEffect: ({ item, children, effectCallback, onEffectEnd, onEffectStart, ref, }: ChildProps) => import("react").JSX.Element;
+export default NoEffect;

package/dist/components/effectlib/shake.d.ts

@@ -0,0 +1,3 @@
+import { ChildProps } from '../../types/animation';
+export declare const AnimatedShake: ({ item, screenScale, children, effectCallback, onEffectEnd, onEffectStart, ref, }: ChildProps) => import("react").JSX.Element;
+export default AnimatedShake;

package/dist/context/BookProvider.d.ts

@@ -0,0 +1,12 @@
+import React from 'react';
+import type { BookContextType } from '../types/context';
+import { AssetConfig } from '../lib/utils';
+import type { PlayerAnalytics } from '../types/analytics';
+export declare const BookProvider: ({ bookId, slug, assetConfig, analytics, children, }: {
+    bookId: string;
+    slug: string;
+    assetConfig: AssetConfig;
+    analytics?: PlayerAnalytics;
+    children: React.ReactNode;
+}) => React.JSX.Element;
+export declare const useBookContext: () => BookContextType;