@embedpdf/plugin-scroll 1.0.11 → 1.0.13

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@embedpdf/plugin-scroll",
-  "version": "1.0.11",
+  "version": "1.0.13",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
@@ -20,23 +20,30 @@
       "types": "./dist/react/index.d.ts",
       "import": "./dist/react/index.js",
       "require": "./dist/react/index.cjs"
+    },
+    "./vue": {
+      "types": "./dist/vue/index.d.ts",
+      "import": "./dist/vue/index.js",
+      "require": "./dist/vue/index.cjs"
     }
   },
   "dependencies": {
-    "@embedpdf/models": "1.0.11"
+    "@embedpdf/models": "1.0.13"
   },
   "devDependencies": {
     "@types/react": "^18.2.0",
-    "tsup": "^8.0.0",
     "typescript": "^5.0.0",
-    "@embedpdf/plugin-viewport": "1.0.11"
+    "@embedpdf/build": "1.0.0",
+    "@embedpdf/plugin-viewport": "1.0.13",
+    "@embedpdf/core": "1.0.13"
   },
   "peerDependencies": {
+    "preact": "^10.26.4",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
-    "preact": "^10.26.4",
-    "@embedpdf/core": "1.0.11",
-    "@embedpdf/plugin-viewport": "1.0.11"
+    "vue": ">=3.2.0",
+    "@embedpdf/plugin-viewport": "1.0.13",
+    "@embedpdf/core": "1.0.13"
   },
   "files": [
     "dist",
@@ -55,11 +62,13 @@
     "access": "public"
   },
   "scripts": {
-    "build": "PROJECT_CWD=$(pwd) pnpm -w p:build",
-    "build:watch": "PROJECT_CWD=$(pwd) pnpm -w p:build:watch",
-    "clean": "PROJECT_CWD=$(pwd) pnpm -w p:clean",
-    "lint": "PROJECT_CWD=$(pwd) pnpm -w p:lint",
-    "lint:fix": "PROJECT_CWD=$(pwd) pnpm -w p:lint:fix",
-    "typecheck": "PROJECT_CWD=$(pwd) pnpm -w p:typecheck"
+    "build:base": "vite build --mode base",
+    "build:react": "vite build --mode react",
+    "build:preact": "vite build --mode preact",
+    "build:vue": "vite build --mode vue",
+    "build": "pnpm run clean && concurrently -c auto -n base,react,preact,vue \"vite build --mode base\" \"vite build --mode react\" \"vite build --mode preact\" \"vite build --mode vue\"",
+    "clean": "rimraf dist",
+    "lint": "eslint src --color",
+    "lint:fix": "eslint src --color --fix"
   }
 }

package/dist/index.d.cts

@@ -1,204 +0,0 @@
-import { BasePluginConfig, EventHook, Action, BasePlugin, PluginRegistry, StoreState, CoreState, PluginManifest, PluginPackage } from '@embedpdf/core';
-import { Rect, Rotation, PdfPageObject } from '@embedpdf/models';
-import { ViewportMetrics } from '@embedpdf/plugin-viewport';
-
-interface PageLayout {
-    pageNumber: number;
-    pageIndex: number;
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-    rotatedWidth: number;
-    rotatedHeight: number;
-}
-interface VirtualItem {
-    id: string;
-    x: number;
-    y: number;
-    offset: number;
-    width: number;
-    height: number;
-    pageLayouts: PageLayout[];
-    pageNumbers: number[];
-    index: number;
-}
-
-interface ScrollState extends ScrollMetrics {
-    virtualItems: VirtualItem[];
-    totalPages: number;
-    totalContentSize: {
-        width: number;
-        height: number;
-    };
-    desiredScrollPosition: {
-        x: number;
-        y: number;
-    };
-    strategy: ScrollStrategy;
-    pageGap: number;
-    scale: number;
-}
-interface ScrollerLayout {
-    startSpacing: number;
-    endSpacing: number;
-    totalWidth: number;
-    totalHeight: number;
-    pageGap: number;
-    strategy: ScrollState['strategy'];
-    items: VirtualItem[];
-}
-declare enum ScrollStrategy {
-    Vertical = "vertical",
-    Horizontal = "horizontal"
-}
-interface PageVisibilityMetrics {
-    pageNumber: number;
-    viewportX: number;
-    viewportY: number;
-    visiblePercentage: number;
-    original: {
-        pageX: number;
-        pageY: number;
-        visibleWidth: number;
-        visibleHeight: number;
-        scale: number;
-    };
-    scaled: {
-        pageX: number;
-        pageY: number;
-        visibleWidth: number;
-        visibleHeight: number;
-        scale: number;
-    };
-}
-interface ScrollMetrics {
-    currentPage: number;
-    visiblePages: number[];
-    pageVisibilityMetrics: PageVisibilityMetrics[];
-    renderedPageIndexes: number[];
-    scrollOffset: {
-        x: number;
-        y: number;
-    };
-    startSpacing: number;
-    endSpacing: number;
-}
-interface ScrollStrategyInterface {
-    initialize(container: HTMLElement, innerDiv: HTMLElement): void;
-    destroy(): void;
-    updateLayout(viewport: ViewportMetrics, pdfPageObject: PdfPageObject[][]): void;
-    handleScroll(viewport: ViewportMetrics): void;
-    getVirtualItems(): VirtualItem[];
-    scrollToPage(pageNumber: number, behavior?: ScrollBehavior): void;
-    calculateDimensions(pdfPageObject: PdfPageObject[][]): void;
-}
-interface ScrollPluginConfig extends BasePluginConfig {
-    strategy?: ScrollStrategy;
-    initialPage?: number;
-    bufferSize?: number;
-    pageGap?: number;
-}
-type LayoutChangePayload = Pick<ScrollState, 'virtualItems' | 'totalContentSize'>;
-interface ScrollToPageOptions {
-    pageNumber: number;
-    pageCoordinates?: {
-        x: number;
-        y: number;
-    };
-    behavior?: ScrollBehavior;
-    center?: boolean;
-}
-interface PageChangePayload {
-    pageNumber: number;
-    totalPages: number;
-}
-interface ScrollCapability {
-    onScrollerData: EventHook<ScrollerLayout>;
-    onStateChange: EventHook<ScrollState>;
-    onScroll: EventHook<ScrollMetrics>;
-    getCurrentPage(): number;
-    getTotalPages(): number;
-    onPageChange: EventHook<PageChangePayload>;
-    onLayoutChange: EventHook<LayoutChangePayload>;
-    onLayoutReady: EventHook<boolean>;
-    scrollToPage(options: ScrollToPageOptions): void;
-    scrollToNextPage(behavior?: ScrollBehavior): void;
-    scrollToPreviousPage(behavior?: ScrollBehavior): void;
-    getMetrics(viewport?: ViewportMetrics): ScrollMetrics;
-    getLayout(): LayoutChangePayload;
-    getScrollerLayout(): ScrollerLayout;
-    getRectPositionForPage(page: number, rect: Rect, scale?: number, rotation?: Rotation): Rect | null;
-    setScrollStrategy(strategy: ScrollStrategy): void;
-    getPageGap(): number;
-}
-
-declare const UPDATE_SCROLL_STATE = "UPDATE_SCROLL_STATE";
-declare const SET_DESIRED_SCROLL_POSITION = "SET_DESIRED_SCROLL_POSITION";
-declare const UPDATE_TOTAL_PAGES = "UPDATE_TOTAL_PAGES";
-interface UpdateScrollStateAction extends Action {
-    type: typeof UPDATE_SCROLL_STATE;
-    payload: Partial<ScrollState>;
-}
-interface SetDesiredScrollPositionAction extends Action {
-    type: typeof SET_DESIRED_SCROLL_POSITION;
-    payload: {
-        x: number;
-        y: number;
-    };
-}
-interface UpdateTotalPagesAction extends Action {
-    type: typeof UPDATE_TOTAL_PAGES;
-    payload: number;
-}
-type ScrollAction = UpdateScrollStateAction | SetDesiredScrollPositionAction | UpdateTotalPagesAction;
-
-declare class ScrollPlugin extends BasePlugin<ScrollPluginConfig, ScrollCapability, ScrollState, ScrollAction> {
-    readonly id: string;
-    private config?;
-    static readonly id: "scroll";
-    private viewport;
-    private strategy;
-    private strategyConfig;
-    private currentScale;
-    private currentRotation;
-    private initialPage?;
-    private currentPage;
-    private layoutReady;
-    private readonly layout$;
-    private readonly scroll$;
-    private readonly state$;
-    private readonly scrollerLayout$;
-    private readonly pageChange$;
-    private readonly layoutReady$;
-    constructor(id: string, registry: PluginRegistry, config?: ScrollPluginConfig | undefined);
-    private computeLayout;
-    private computeMetrics;
-    private commit;
-    private commitMetrics;
-    private refreshAll;
-    private getVirtualItemsFromState;
-    private getScrollerLayoutFromState;
-    private pushScrollLayout;
-    onStoreUpdated(_prevState: ScrollState, _newState: ScrollState): void;
-    onCoreStoreUpdated(prevState: StoreState<CoreState>, newState: StoreState<CoreState>): void;
-    /**
-     * Change the scroll strategy at runtime (e.g., vertical <-> horizontal)
-     * @param newStrategy ScrollStrategy.Horizontal or ScrollStrategy.Vertical
-     */
-    private setScrollStrategy;
-    setLayoutReady(): void;
-    protected buildCapability(): ScrollCapability;
-    private getMetrics;
-    private getLayout;
-    private getRectPositionForPage;
-    initialize(): Promise<void>;
-    destroy(): Promise<void>;
-}
-
-declare const SCROLL_PLUGIN_ID = "scroll";
-declare const manifest: PluginManifest<ScrollPluginConfig>;
-
-declare const ScrollPluginPackage: PluginPackage<ScrollPlugin, ScrollPluginConfig, ScrollState, ScrollAction>;
-
-export { type LayoutChangePayload, type PageChangePayload, type PageLayout, type PageVisibilityMetrics, SCROLL_PLUGIN_ID, type ScrollCapability, type ScrollMetrics, ScrollPlugin, type ScrollPluginConfig, ScrollPluginPackage, type ScrollState, ScrollStrategy, type ScrollStrategyInterface, type ScrollToPageOptions, type ScrollerLayout, type VirtualItem, manifest };

package/dist/preact/index.d.cts

@@ -1,54 +0,0 @@
-import * as _embedpdf_models from '@embedpdf/models';
-import { Rotation, PdfDocumentObject } from '@embedpdf/models';
-import * as _embedpdf_plugin_viewport from '@embedpdf/plugin-viewport';
-import * as _embedpdf_core from '@embedpdf/core';
-import * as _embedpdf_plugin_scroll from '@embedpdf/plugin-scroll';
-import { ScrollPlugin, PageLayout } from '@embedpdf/plugin-scroll';
-import { JSX } from 'preact';
-
-declare const useScrollPlugin: () => {
-    plugin: ScrollPlugin | null;
-    isLoading: boolean;
-    ready: Promise<void>;
-};
-declare const useScrollCapability: () => {
-    provides: Readonly<_embedpdf_plugin_scroll.ScrollCapability> | null;
-    isLoading: boolean;
-    ready: Promise<void>;
-};
-declare const useScroll: () => {
-    currentPage: number;
-    totalPages: number;
-    onScrollerData?: _embedpdf_core.EventHook<_embedpdf_plugin_scroll.ScrollerLayout> | undefined;
-    onStateChange?: _embedpdf_core.EventHook<_embedpdf_plugin_scroll.ScrollState> | undefined;
-    onScroll?: _embedpdf_core.EventHook<_embedpdf_plugin_scroll.ScrollMetrics> | undefined;
-    getCurrentPage?: (() => number) | undefined;
-    getTotalPages?: (() => number) | undefined;
-    onPageChange?: _embedpdf_core.EventHook<_embedpdf_plugin_scroll.PageChangePayload> | undefined;
-    onLayoutChange?: _embedpdf_core.EventHook<_embedpdf_plugin_scroll.LayoutChangePayload> | undefined;
-    onLayoutReady?: _embedpdf_core.EventHook<boolean> | undefined;
-    scrollToPage?: ((options: _embedpdf_plugin_scroll.ScrollToPageOptions) => void) | undefined;
-    scrollToNextPage?: ((behavior?: ScrollBehavior) => void) | undefined;
-    scrollToPreviousPage?: ((behavior?: ScrollBehavior) => void) | undefined;
-    getMetrics?: ((viewport?: _embedpdf_plugin_viewport.ViewportMetrics) => _embedpdf_plugin_scroll.ScrollMetrics) | undefined;
-    getLayout?: (() => _embedpdf_plugin_scroll.LayoutChangePayload) | undefined;
-    getScrollerLayout?: (() => _embedpdf_plugin_scroll.ScrollerLayout) | undefined;
-    getRectPositionForPage?: ((page: number, rect: _embedpdf_models.Rect, scale?: number, rotation?: _embedpdf_models.Rotation) => _embedpdf_models.Rect | null) | undefined;
-    setScrollStrategy?: ((strategy: _embedpdf_plugin_scroll.ScrollStrategy) => void) | undefined;
-    getPageGap?: (() => number) | undefined;
-};
-
-/** @jsxImportSource preact */
-
-interface RenderPageProps extends PageLayout {
-    rotation: Rotation;
-    scale: number;
-    document: PdfDocumentObject | null;
-}
-type ScrollerProps = JSX.HTMLAttributes<HTMLDivElement> & {
-    renderPage: (props: RenderPageProps) => JSX.Element;
-    overlayElements?: JSX.Element[];
-};
-declare function Scroller({ renderPage, overlayElements, ...props }: ScrollerProps): JSX.Element | null;
-
-export { Scroller, useScroll, useScrollCapability, useScrollPlugin };

package/dist/react/index.d.cts

@@ -1,53 +0,0 @@
-import * as _embedpdf_models from '@embedpdf/models';
-import { Rotation, PdfDocumentObject } from '@embedpdf/models';
-import * as _embedpdf_plugin_viewport from '@embedpdf/plugin-viewport';
-import * as _embedpdf_core from '@embedpdf/core';
-import * as _embedpdf_plugin_scroll from '@embedpdf/plugin-scroll';
-import { ScrollPlugin, PageLayout } from '@embedpdf/plugin-scroll';
-import * as react_jsx_runtime from 'react/jsx-runtime';
-import React, { ReactNode } from 'react';
-
-declare const useScrollPlugin: () => {
-    plugin: ScrollPlugin | null;
-    isLoading: boolean;
-    ready: Promise<void>;
-};
-declare const useScrollCapability: () => {
-    provides: Readonly<_embedpdf_plugin_scroll.ScrollCapability> | null;
-    isLoading: boolean;
-    ready: Promise<void>;
-};
-declare const useScroll: () => {
-    currentPage: number;
-    totalPages: number;
-    onScrollerData?: _embedpdf_core.EventHook<_embedpdf_plugin_scroll.ScrollerLayout> | undefined;
-    onStateChange?: _embedpdf_core.EventHook<_embedpdf_plugin_scroll.ScrollState> | undefined;
-    onScroll?: _embedpdf_core.EventHook<_embedpdf_plugin_scroll.ScrollMetrics> | undefined;
-    getCurrentPage?: (() => number) | undefined;
-    getTotalPages?: (() => number) | undefined;
-    onPageChange?: _embedpdf_core.EventHook<_embedpdf_plugin_scroll.PageChangePayload> | undefined;
-    onLayoutChange?: _embedpdf_core.EventHook<_embedpdf_plugin_scroll.LayoutChangePayload> | undefined;
-    onLayoutReady?: _embedpdf_core.EventHook<boolean> | undefined;
-    scrollToPage?: ((options: _embedpdf_plugin_scroll.ScrollToPageOptions) => void) | undefined;
-    scrollToNextPage?: ((behavior?: ScrollBehavior) => void) | undefined;
-    scrollToPreviousPage?: ((behavior?: ScrollBehavior) => void) | undefined;
-    getMetrics?: ((viewport?: _embedpdf_plugin_viewport.ViewportMetrics) => _embedpdf_plugin_scroll.ScrollMetrics) | undefined;
-    getLayout?: (() => _embedpdf_plugin_scroll.LayoutChangePayload) | undefined;
-    getScrollerLayout?: (() => _embedpdf_plugin_scroll.ScrollerLayout) | undefined;
-    getRectPositionForPage?: ((page: number, rect: _embedpdf_models.Rect, scale?: number, rotation?: _embedpdf_models.Rotation) => _embedpdf_models.Rect | null) | undefined;
-    setScrollStrategy?: ((strategy: _embedpdf_plugin_scroll.ScrollStrategy) => void) | undefined;
-    getPageGap?: (() => number) | undefined;
-};
-
-interface RenderPageProps extends PageLayout {
-    rotation: Rotation;
-    scale: number;
-    document: PdfDocumentObject | null;
-}
-type ScrollerProps = React.HTMLAttributes<HTMLDivElement> & {
-    renderPage: (props: RenderPageProps) => ReactNode;
-    overlayElements?: ReactNode[];
-};
-declare function Scroller({ renderPage, overlayElements, ...props }: ScrollerProps): react_jsx_runtime.JSX.Element | null;
-
-export { Scroller, useScroll, useScrollCapability, useScrollPlugin };