lightgallery 3.0.0-beta.2 → 3.0.0-beta.3

package/dist/types/headless/video-urls.d.ts

@@ -0,0 +1,64 @@
+/**
+ * Video URL detection and embed-URL builders, ported from 2.x
+ * `utils.isVideo` (`src/lg-utils.ts`) and `lg-video-utils.ts` as pure
+ * functions. The video plugin renders the returned URLs; nothing here
+ * touches the DOM.
+ */
+export interface VideoInfo {
+    /** RegExp match parts: `[match, videoId, urlParams?]`. */
+    youtube?: string[];
+    vimeo?: string[];
+    /** RegExp match parts; index 4 is the media id. */
+    wistia?: string[];
+    html5?: boolean;
+}
+export type PlayerParams = Record<string, string | number | boolean> | boolean;
+/** Detect the video provider for a src URL (2.x `utils.isVideo`). */
+export declare function getVideoInfo(src: string | undefined, hasHtml5Video: boolean): VideoInfo | undefined;
+/** Serialize params as a query string (2.x `param`). */
+export declare function param(obj: Record<string, string | number | boolean>): string;
+/** Parse `?a=b&c=d` into an object (2.x `paramsToObject`). */
+export declare function paramsToObject(url: string): Record<string, string>;
+export declare function isYouTubeNoCookie(url: string): boolean;
+/**
+ * YouTube embed URL. Precedence (2.x parity): defaults < settings < params
+ * already present on the slide URL. The privacy-enhanced
+ * `youtube-nocookie.com` host is the default; pass `preferNoCookie: false`
+ * (the `youTubeNoCookie` setting) to revert to `youtube.com`. A slide URL
+ * that already names the nocookie host always keeps it.
+ */
+export declare function getYouTubeEmbedUrl(videoInfo: VideoInfo, playerParamsSettings: PlayerParams, srcUrl: string, preferNoCookie?: boolean): string | undefined;
+/**
+ * YouTube's public thumbnail endpoint for a detected video — the one
+ * provider poster that needs no API call. (Vimeo/Wistia poster endpoints
+ * require a fetch/auth, so their facades rely on the item's own
+ * poster/thumb — see getFacadePoster.)
+ */
+export declare function getYouTubePosterUrl(videoInfo: VideoInfo | undefined): string | undefined;
+/**
+ * Poster for a provider-video facade (lite embed): the explicit item
+ * poster wins, then the YouTube thumbnail endpoint (when enabled), then
+ * the item's grid thumb — for Vimeo galleries the vimeoThumbnail plugin
+ * rewrites `thumb` to the oEmbed thumbnail, which feeds this chain.
+ * HTML5 slides never get a synthesized poster (unchanged 2.x behavior);
+ * a provider slide with no resolvable poster returns undefined and keeps
+ * the eager-iframe path.
+ */
+export declare function getFacadePoster(item: {
+    poster?: string;
+    thumb?: string;
+}, videoInfo: VideoInfo | undefined, loadYouTubePoster: boolean): string | undefined;
+/**
+ * Provider player-API script URLs, loaded on demand at first play (the
+ * vanilla runtime's control paths need them; the framework bindings drive
+ * players via postMessage and load nothing).
+ */
+export declare const VIMEO_PLAYER_SCRIPT_URL = "https://player.vimeo.com/api/player.js";
+export declare const WISTIA_PLAYER_SCRIPT_URL = "https://fast.wistia.com/assets/external/E-v1.js";
+/**
+ * Vimeo embed URL, including the private-video hash handling (2.x
+ * `getVimeoURLParams`).
+ */
+export declare function getVimeoEmbedUrl(videoInfo: VideoInfo, playerParamsSettings: PlayerParams): string | undefined;
+/** Wistia embed URL. */
+export declare function getWistiaEmbedUrl(videoInfo: VideoInfo, playerParamsSettings: PlayerParams): string | undefined;

package/dist/types/headless/zoom-math.d.ts

@@ -0,0 +1,89 @@
+/**
+ * Zoom math for the zoom plugin, ported from the 2.x zoom
+ * plugin's scale/position logic as pure functions: scale stepping and
+ * clamping, actual-size scale, point-anchored zooming, pinch scale and
+ * pan bounds. The React plugin writes the resulting transforms to the DOM.
+ */
+export interface ZoomPan {
+    x: number;
+    y: number;
+}
+export interface PanBounds {
+    maxX: number;
+    maxY: number;
+}
+/**
+ * How far a zoomed image may pan before its edge would detach from the
+ * container edge. At scale <= 1 the image cannot pan at all.
+ */
+export declare function getPanBounds(imageWidth: number, imageHeight: number, containerWidth: number, containerHeight: number, scale: number): PanBounds;
+export declare function clampPan(pan: ZoomPan, bounds: PanBounds): ZoomPan;
+/**
+ * Scale at which the image renders at its natural pixel size (2.x
+ * `getCurrentImageActualSizeScale`, with its `|| 2` fallback).
+ */
+export declare function getActualSizeScale(naturalWidth: number, renderedWidth: number): number;
+/** Clamp a target scale: never below 1; capped unless `infiniteZoom`. */
+export declare function clampScale(scale: number, maxScale: number, infiniteZoom: boolean): number;
+/**
+ * Pan that keeps the given point (relative to the container center)
+ * anchored while the scale changes — used for double-click/tap zoom and
+ * pinch focal points.
+ */
+export declare function getPointZoomPan(point: ZoomPan, prevPan: ZoomPan, prevScale: number, newScale: number): ZoomPan;
+/**
+ * Stage-aware pan clamp. X is symmetric. The pan-up floor on Y extends
+ * past the content box by `stageBottomExtra` — the components strip
+ * (thumbnails + caption) vacates when zoomed, so the visible stage
+ * reaches the SCREEN bottom and the image may ride up until its bottom
+ * edge meets it; a plain symmetric clamp would strand a strip-height
+ * gap of black. Inversion-guarded (min against +maxY) for images
+ * taller than the content box but shorter than the full stage.
+ */
+export declare function clampPanToStage(pan: ZoomPan, bounds: PanBounds, stageBottomExtra: number): ZoomPan;
+/**
+ * Pan during a pinch: the focal zoom projection translated by the
+ * midpoint's travel — the image point between the fingers stays
+ * between the fingers wherever they go (iOS fused
+ * zoom-and-pan; two fingers moving together pan without zooming).
+ */
+export declare function getPinchPan(currentMid: ZoomPan, startMid: ZoomPan, startPan: ZoomPan, startScale: number, scale: number): ZoomPan;
+/** Distance between two pointers (pinch measurement). */
+export declare function getPointerDistance(a: {
+    x: number;
+    y: number;
+}, b: {
+    x: number;
+    y: number;
+}): number;
+/**
+ * Continuous resistance below fit scale — replaces the 2.x hard 0.5
+ * floor: past the boundary the scale keeps moving at 15% per unit.
+ */
+export declare const PINCH_UNDER_FRICTION = 0.15;
+/**
+ * Very stiff resistance beyond actual size instead of a hard stop;
+ * the release spring lands back inside bounds. `infiniteZoom` disables
+ * this boundary entirely.
+ */
+export declare const PINCH_OVER_FRICTION = 0.05;
+/**
+ * Scale during a pinch: proportional to the distance ratio, with
+ * friction (not clamps) at both boundaries. When pinch-to-close is
+ * armed, the under-fit squeeze is free — the shrink IS the close
+ * affordance; the release verdict is {@link shouldCloseOnPinch}.
+ */
+export declare function getPinchScale(startDistance: number, currentDistance: number, startScale: number, maxScale: number, infiniteZoom: boolean, pinchToCloseArmed?: boolean): number;
+/**
+ * Pinch-to-close verdict (iOS Photos signature): a pinch released
+ * below fit closes ONLY when the whole gesture stayed at or under fit
+ * — an over-then-under pinch is a zoom correction, not a dismissal.
+ * `maxGestureScale` is the largest scale seen since the pinch started
+ * (seeded with the start scale).
+ */
+export declare function shouldCloseOnPinch(input: {
+    scale: number;
+    maxGestureScale: number;
+    pinchToClose: boolean;
+    closable: boolean;
+}): boolean;

package/dist/types/index.d.ts

@@ -2,7 +2,8 @@ import { LightGallerySettings } from './lg-settings';
 import { LightGallery } from './lightgallery';
 declare function lightGallery(el: HTMLElement, options?: LightGallerySettings): LightGallery;
 declare namespace lightGallery {
-    var setLicenseKey: typeof import("@lightgallery/headless").setLicenseKey;
+    var setLicenseKey: typeof import("./headless/index").setLicenseKey;
 }
 export default lightGallery;
+export type { LightGallery };
 export type { LgIconName, LgIcons } from './lg-icons';

package/dist/types/lg-icons.d.ts

@@ -14,7 +14,7 @@
  * pair, a half-provided pair keeps the defaults so no state ends up
  * iconless.
  */
-import type { LgIconName } from '@lightgallery/headless';
+import type { LgIconName } from './headless/index';
 export type { LgIconName };
 /** SVG markup per icon; omitted names keep the built-in glyph. */
 export type LgIcons = Partial<Record<LgIconName, string>>;

package/dist/types/lg-settings.d.ts

@@ -1,4 +1,4 @@
-import { VirtualizationSettings } from '@lightgallery/headless';
+import { VirtualizationSettings } from './headless/index';
 import { LgIcons } from './lg-icons';
 import { GalleryItem } from './lg-utils';
 import { LgQuery } from './lgQuery';
@@ -180,12 +180,6 @@ export interface LightGalleryCoreSettings {
      * </section>
      */
     slideDelay: number;
-    /**
-     * Support legacy browsers
-     * @description Currently this is used only for adding support to srcset attribute via picturefill library
-     * If true lightGallery will show warning message to include picturefill library
-     */
-    supportLegacyBrowser: boolean;
     /**
      * If true, toolbar, captions and thumbnails will not overlap with media element
      * This will not effect thumbnails if animateThumb is false

package/dist/types/lg-spring-runner.d.ts

@@ -1,4 +1,4 @@
-import { type SpringConfig } from '@lightgallery/headless';
+import { type SpringConfig } from './headless/index';
 /**
  * rAF driver for the shared spring math: advances one spring per track
  * each frame and hands the values to the caller's DOM writer. The math

package/dist/types/lightgallery.d.ts

@@ -171,7 +171,6 @@ export declare class LightGallery {
     getMediaContainerPosition(): MediaContainerPosition;
     private setMediaContainerPosition;
     hideBars(): void;
-    initPictureFill($img: lgQuery): void;
     /**
      *  @desc Create image counter
      *  Ex: 1/10

package/dist/types/plugins/hash/lg-hash-settings.d.ts

@@ -1,4 +1,4 @@
-import { HashDriverPreference } from '@lightgallery/headless';
+import { HashDriverPreference } from '../../headless/index';
 export interface HashSettings {
     /**
      * Enable/Disable hash option

package/dist/types/plugins/video/lg-video-settings.d.ts

@@ -1,4 +1,4 @@
-import { PlayerParams } from '@lightgallery/headless';
+import { PlayerParams } from '../../headless/index';
 export interface VideoSettings {
     /**
      * Enable/DIsable first video autoplay.

package/dist/types/plugins/zoom/lg-zoom.d.ts

@@ -1,4 +1,4 @@
-import { type Velocity } from '@lightgallery/headless';
+import { type Velocity } from '../../headless/index';
 import { LgQuery, lgQuery } from '../../lgQuery';
 import { LightGallery } from '../../lightgallery';
 interface Coords {

package/package.json

@@ -1,23 +1,6 @@
 {
   "name": "lightgallery",
-  "version": "3.0.0-beta.2",
-  "packageManager": "pnpm@9.15.0",
-  "pnpm": {
-    "overrides": {
-      "@types/babel__traverse": "7.11.1",
-      "@types/express": "4.17.11",
-      "@types/express-serve-static-core": "4.17.19",
-      "@types/react": "18.0.15",
-      "@types/serve-static": "1.13.10"
-    },
-    "packageExtensions": {
-      "@analogjs/vite-plugin-angular": {
-        "dependencies": {
-          "typescript": "~5.9.0"
-        }
-      }
-    }
-  },
+  "version": "3.0.0-beta.3",
   "description": "lightGallery is a feature-rich, modular JavaScript gallery plugin for building beautiful image and video galleries for the web and the mobile",
   "keywords": [
     "JavaScript",
@@ -138,56 +121,7 @@
     "url": "https://github.com/sachinchoolur"
   },
   "engines": {
-    "node": ">=6.0.0"
-  },
-  "scripts": {
-    "lint": "eslint 'src/**/*.ts' 'test/**/*.ts' --quiet",
-    "lint:fix": "eslint 'src/**/*.ts' 'test/**/*.ts' --quiet --fix",
-    "prebuild": "rimraf dist",
-    "build": "npm run build:all:vite",
-    "build:all:vite": "turbo run build:vite build:types --filter=@lightgallery/core && turbo run build:css build:css:min copy:assets copy:scss assemble:dist --filter=lightgallery",
-    "build:vite": "turbo run build:vite build:types --filter=@lightgallery/core",
-    "verify:parity": "tsx scripts/verify-build-parity.ts",
-    "typecheck": "tsc --noEmit -p tsconfig.json",
-    "build-scss": "sass src/scss/:dist/css/ --style=expanded",
-    "build:css": "sass src/scss/:dist/css/ --style=expanded",
-    "build:css:min": "cleancss -o dist/css/lightgallery-bundle.min.css dist/css/lightgallery-bundle.css",
-    "build-scss-dev": "sass src/scss/:site/static/css/ --style=expanded",
-    "watch-css": "nodemon --watch 'src/**/*' -e scss -x \"npm run build-scss-dev\"",
-    "watch-site-content": "nodemon --watch dist -x \"npm run copyAssetsToSite\"",
-    "minify-css": "cleancss -o dist/css/lightgallery-bundle.min.css dist/css/lightgallery-bundle.css",
-    "start": "concurrently \"vite build --config packages/core/vite.config.dev.ts --watch\" \"npm run watch-site-content \" \"npm run watch-css \" ",
-    "test": "jest",
-    "test:coverage": "jest --coverage",
-    "test:watch": "jest --watch",
-    "test:prod": "npm run lint && npm run test:coverage -- --no-cache --runInBand",
-    "deploy-docs": "ts-node tools/gh-pages-publish",
-    "docs": "typedoc --json site/data/doc.json --entryPointStrategy expand --skipErrorChecking --categorizeByGroup src",
-    "report-coverage": "cat ./coverage/lcov.info | coveralls",
-    "commit": "git-cz",
-    "semantic-release": "semantic-release",
-    "semantic-release-prepare": "ts-node tools/semantic-release-prepare",
-    "precommit": "lint-staged",
-    "travis-deploy-once": "travis-deploy-once",
-    "copyAssets": "copyfiles -u 1 src/images/** dist",
-    "copy:assets": "copyfiles -u 1 src/images/** dist",
-    "copy:scss": "copyfiles -f -u 1 src/scss/** dist/scss && copyfiles -u 2 src/scss/**/* dist/scss",
-    "assemble:dist": "tsx scripts/assemble-vite-dist.ts",
-    "sync:site": "copyfiles -f dist/*.js site/assets/js && copyfiles -u 1 dist/plugins/**/* site/assets/js && copyfiles -f dist/images/** site/static/images",
-    "copyPackages": "copyfiles README.md dist && copyfiles -u 1 packages/**/**/* dist && copyfiles -u 1 packages/**/* dist && copyfiles -u 1 packages/* dist",
-    "updatePackageFields": "ts-node tools/update-packages",
-    "copyReactBuild": "copyfiles -f -u 1 -e '**/*.d.ts' lightgallery-react/dist/* dist/react && copyfiles -f -u 1 lightgallery-react/dist/Lightgallery.d.ts dist/react",
-    "copyLitBuild": "copyfiles -f -u 1 lightgallery-lit/dist/* dist/lit",
-    "copyVueBuild": "copyfiles -f -u 1 -e '**/*.html' lightgallery-vue/dist/* dist/vue && copyfiles -f lightgallery-vue/dist/lightgallery-vue/src/components/LightGallery.vue.d.ts dist/vue ",
-    "copyAngularBuild": "ts-node tools/copy-angular-build",
-    "copyAssetsToSite": "copyfiles -f dist/images/** site/static/images",
-    "copyJsToSite": "copyfiles -f dist/*.js site/assets/js && copyfiles -u 1 dist/plugins/**/* site/assets/js",
-    "copyScss": "copyfiles -f -u 1 src/scss/** dist/scss && copyfiles -u 2 src/scss/**/* dist/scss",
-    "prepush": "npm run test:prod && npm run build",
-    "commitmsg": "commitlint -E HUSKY_GIT_PARAMS",
-    "buildLibraries": "ts-node tools/build-libraries",
-    "publishToNpm": "pnpm publish",
-    "prepack": "node scripts/assert-built.mjs dist/lightgallery.umd.js dist/lightgallery.es5.js dist/lightgallery.min.js dist/css/lightgallery.css dist/types/index.d.ts"
+    "node": ">=18"
   },
   "lint-staged": {
     "{src,test}/**/*.ts": [
@@ -208,7 +142,6 @@
   "devDependencies": {
     "@commitlint/cli": "^7.1.2",
     "@commitlint/config-conventional": "^7.1.2",
-    "@lightgallery/headless": "workspace:*",
     "@testing-library/dom": "^7.30.4",
     "@testing-library/jest-dom": "^5.12.0",
     "@types/jest": "^30.0.0",
@@ -254,9 +187,61 @@
     "turbo": "^2.3.3",
     "typedoc": "^0.26.11",
     "typescript": "5.0.4",
-    "vite": "^5.4.11"
+    "vite": "^5.4.11",
+    "@lightgallery/headless": "3.0.0-beta.3"
   },
   "publishConfig": {
     "tag": "next"
+  },
+  "scripts": {
+    "lint": "eslint 'src/**/*.ts' 'test/**/*.ts' --quiet",
+    "lint:fix": "eslint 'src/**/*.ts' 'test/**/*.ts' --quiet --fix",
+    "prebuild": "rimraf dist",
+    "build": "npm run build:all:vite",
+    "build:all:vite": "turbo run build:vite build:types --filter=@lightgallery/core && turbo run build:css build:css:min copy:assets copy:scss assemble:dist --filter=lightgallery",
+    "build:vite": "turbo run build:vite build:types --filter=@lightgallery/core",
+    "verify:parity": "tsx scripts/verify-build-parity.ts",
+    "typecheck": "tsc --noEmit -p tsconfig.json",
+    "build-scss": "sass src/scss/:dist/css/ --style=expanded",
+    "build:css": "sass src/scss/:dist/css/ --style=expanded",
+    "build:css:min": "cleancss -o dist/css/lightgallery-bundle.min.css dist/css/lightgallery-bundle.css",
+    "build-scss-dev": "sass src/scss/:site/static/css/ --style=expanded",
+    "watch-css": "nodemon --watch 'src/**/*' -e scss -x \"npm run build-scss-dev\"",
+    "watch-site-content": "nodemon --watch dist -x \"npm run copyAssetsToSite\"",
+    "minify-css": "cleancss -o dist/css/lightgallery-bundle.min.css dist/css/lightgallery-bundle.css",
+    "start": "concurrently \"vite build --config packages/core/vite.config.dev.ts --watch\" \"npm run watch-site-content \" \"npm run watch-css \" ",
+    "test": "jest",
+    "test:coverage": "jest --coverage",
+    "test:watch": "jest --watch",
+    "test:prod": "npm run lint && npm run test:coverage -- --no-cache --runInBand",
+    "deploy-docs": "ts-node tools/gh-pages-publish",
+    "docs": "typedoc --json site/data/doc.json --entryPointStrategy expand --skipErrorChecking --categorizeByGroup src",
+    "report-coverage": "cat ./coverage/lcov.info | coveralls",
+    "commit": "git-cz",
+    "semantic-release": "semantic-release",
+    "semantic-release-prepare": "ts-node tools/semantic-release-prepare",
+    "precommit": "lint-staged",
+    "travis-deploy-once": "travis-deploy-once",
+    "copyAssets": "copyfiles -u 1 src/images/** dist",
+    "copy:assets": "copyfiles -u 1 src/images/** dist",
+    "copy:scss": "copyfiles -f -u 1 src/scss/** dist/scss && copyfiles -u 2 src/scss/**/* dist/scss",
+    "assemble:dist": "tsx scripts/assemble-vite-dist.ts",
+    "sync:site": "copyfiles -f dist/*.js site/assets/js && copyfiles -u 1 dist/plugins/**/* site/assets/js && copyfiles -f dist/images/** site/static/images",
+    "copyPackages": "copyfiles README.md dist && copyfiles -u 1 packages/**/**/* dist && copyfiles -u 1 packages/**/* dist && copyfiles -u 1 packages/* dist",
+    "updatePackageFields": "ts-node tools/update-packages",
+    "copyReactBuild": "copyfiles -f -u 1 -e '**/*.d.ts' lightgallery-react/dist/* dist/react && copyfiles -f -u 1 lightgallery-react/dist/Lightgallery.d.ts dist/react",
+    "copyLitBuild": "copyfiles -f -u 1 lightgallery-lit/dist/* dist/lit",
+    "copyVueBuild": "copyfiles -f -u 1 -e '**/*.html' lightgallery-vue/dist/* dist/vue && copyfiles -f lightgallery-vue/dist/lightgallery-vue/src/components/LightGallery.vue.d.ts dist/vue ",
+    "copyAngularBuild": "ts-node tools/copy-angular-build",
+    "copyAssetsToSite": "copyfiles -f dist/images/** site/static/images",
+    "copyJsToSite": "copyfiles -f dist/*.js site/assets/js && copyfiles -u 1 dist/plugins/**/* site/assets/js",
+    "copyScss": "copyfiles -f -u 1 src/scss/** dist/scss && copyfiles -u 2 src/scss/**/* dist/scss",
+    "prepush": "npm run test:prod && npm run build",
+    "commitmsg": "commitlint -E HUSKY_GIT_PARAMS",
+    "buildLibraries": "ts-node tools/build-libraries",
+    "publishToNpm": "pnpm publish",
+    "release": "node scripts/release.mjs publish",
+    "release:check": "node scripts/release.mjs check",
+    "release:bump": "node scripts/release.mjs bump"
   }
-}
+}