@micrio/client 6.1.5 → 6.1.7

package/micrio.min.d.ts

@@ -97,7 +97,7 @@ declare module '@micrio/client' {
 		 */
 		getView: () => Models.Camera.View;
 		/**
-		 * Gets the current image view rectangle [centerX, centerY, width, height] relative to the image (0-1).
+		 * Gets the current image view rectangle [x0, y0, width, height] relative to the image (0-1).
 		 * @returns A copy of the current screen viewport array, or undefined if not initialized.
 		 */
 		getViewRaw: () => Float64Array;
@@ -114,7 +114,7 @@ declare module '@micrio/client' {
 			/** If true, prevents triggering a render after setting the view. */
 			noRender?: boolean;
 			/** If provided, interprets `view` relative to this sub-area instead of the full image. */
-			area?: Models.Camera.ViewRect;
+			area?: Models.Camera.View;
 		}): void;
 		/**
 		 * Gets the relative image coordinates [x, y, scale, depth, yaw?, pitch?] corresponding to a screen coordinate.
@@ -196,7 +196,7 @@ declare module '@micrio/client' {
 		 * @param opts Optional animation settings.
 		 * @returns A Promise that resolves when the animation completes, or rejects if aborted.
 		 */
-		flyToView: (view: Models.Camera.ViewRect | Models.Camera.View, opts?: Models.Camera.AnimationOptions & {
+		flyToView: (view: Models.Camera.View, opts?: Models.Camera.AnimationOptions & {
 			/** Set the starting animation progress percentage (0-1). */
 			progress?: number;
 			/** Base the progress override on this starting view. */
@@ -206,7 +206,7 @@ declare module '@micrio/client' {
 			/** For Omni objects: the target image frame index to animate to. */
 			omniIndex?: number;
 			/** If provided, interprets `view` relative to this sub-area. */
-			area?: Models.Camera.ViewRect;
+			area?: Models.Camera.View;
 			/** If true, respects the image's maximum zoom limit during animation. */
 			limitZoom?: boolean;
 			/** If provided, adds a margin to the view. */
@@ -278,10 +278,10 @@ declare module '@micrio/client' {
 		/**
 		 * Sets the rendering area for this image within the main canvas.
 		 * Used for split-screen and potentially other layout effects. Animates by default.
-		 * @param v The target area rectangle [x0, y0, x1, y1] relative to the main canvas (0-1).
+		 * @param v The target area rectangle [x0, y0, width, height] relative to the main canvas (0-1).
 		 * @param opts Options for setting the area.
 		 */
-		setArea(v: Models.Camera.ViewRect, opts?: {
+		setArea(v: Models.Camera.View, opts?: {
 			/** If true, sets the area instantly without animation. */
 			direct?: boolean;
 			/** If true, prevents dispatching view updates during the animation. */
@@ -445,7 +445,7 @@ declare module '@micrio/client' {
 		/** Returns the organisation data from the bundle, or undefined. */
 		getOrganisation(): Models.ImageInfo.Organisation | undefined;
 		/** Returns the album info for an album ID from the bundle cache. */
-		getAlbum(id: string): Models.ImageInfo.GallerySettings | undefined;
+		getAlbum(id: string): Models.GalleryConfig | undefined;
 		/**
 		 * Returns the full bundle entry (info + data) for a single image ID,
 		 * fetching the bundle once if not cached.
@@ -508,7 +508,7 @@ declare module '@micrio/client' {
 		*/
 		class Image {
 			private image;
-			/** Writable Svelte store holding the current viewport [centerX, centerY, width, height] of this image. */
+			/** Writable Svelte store holding the current viewport [x0, y0, width, height] of this image. */
 			readonly view: Writable<Models.Camera.View | undefined>;
 			/** Getter for the current value of the {@link view} store. */
 			get $view(): Models.Camera.View | undefined;
@@ -537,8 +537,8 @@ declare module '@micrio/client' {
 		engine: Engine;
 		private attr;
 		opts: {
-			/** Optional sub area [x0, y0, x1, y1] defining placement within a parent canvas (for embeds/galleries). */
-			area?: Models.Camera.ViewRect;
+			/** Optional sub area [x, y, width, height] defining placement within a parent canvas (for embeds/galleries). */
+			area?: Models.Camera.View;
 			/** For split screen, the primary image this one is secondary to. */
 			secondaryTo?: MicrioImage;
 			/** If true, passively follows the view changes of the primary split-screen image. */
@@ -587,7 +587,7 @@ declare module '@micrio/client' {
 		/** Stores an error message if loading failed. */
 		error: string | undefined;
 		/** Svelte Writable store holding the calculated pixel viewport [left, top, width, height] of this image within the main canvas. */
-		readonly viewport: Writable<Models.Camera.ViewRect>;
+		readonly viewport: Writable<Models.Camera.View>;
 		/** Array of child {@link MicrioImage} instances embedded within this image. */
 		readonly embeds: MicrioImage[];
 		/** Grid controller instance, if this image is a grid container. */
@@ -597,11 +597,11 @@ declare module '@micrio/client' {
 		/**
 		 * Adds an embedded MicrioImage (representing another Micrio image or video) within this image.
 		 * @param info Partial info data for the embed.
-		 * @param area The placement area `[x0, y0, x1, y1]` within the parent image.
+		 * @param area The placement area `[x, y, width, height]` within the parent image.
 		 * @param opts Embedding options (opacity, fit, etc.).
 		 * @returns The newly created embedded {@link MicrioImage} instance.
 		 */
-		addEmbed(info: Partial<Models.ImageInfo.ImageInfo>, area: Models.Camera.ViewRect, opts?: Models.Embeds.EmbedOptions): MicrioImage;
+		addEmbed(info: Partial<Models.ImageInfo.ImageInfo>, area: Models.Camera.View, opts?: Models.Embeds.EmbedOptions): MicrioImage;
 		/** Gets the HTMLMediaElement associated with a video embed ID. */
 		getEmbedMediaElement(id: string): HTMLMediaElement | undefined;
 		/** Fades in the image smoothly or instantly. */
@@ -747,7 +747,7 @@ declare module '@micrio/client' {
 		/** Returns the grid image under the given screen coordinates (clientX, clientY).
 		 *  If the current image is a focused grid child, returns it directly. */
 		getImageAt(clientX: number, clientY: number): MicrioImage | undefined;
-		getRelativeView(image: MicrioImage, view: Models.Camera.ViewRect): Models.Camera.ViewRect;
+		getRelativeView(image: MicrioImage, view: Models.Camera.View): Models.Camera.View;
 	}
 	/**
 	 * Video tour controller. Manages playback and camera animation for video tours
@@ -950,22 +950,8 @@ declare module '@micrio/client' {
 				isSingle?: boolean;
 				/** A custom format (`dz` for DeepZoom, `iiif` for IIIF) */
 				format?: string;
-				/** Optional IIIF source for tiles */
-				iiifManifest?: string;
 				/** The album (V5+) ID */
 				albumId?: string;
-				/** Single-canvas sequence -- IIIF Presentation API 3 */
-				type?: ('Manifest' | 'Canvas' | 'AnnotationPage' | 'Annotation' | 'Image');
-				items?: Partial<ImageInfo.ImageInfo>[];
-				body?: Partial<ImageInfo.ImageInfo> & {
-					format: string;
-					width: number;
-					height: number;
-					service: {
-						id: string;
-						type: 'ImageService3';
-					}[];
-				};
 				/** The 360 tour space ID */
 				spacesId?: string;
 			};
@@ -1121,7 +1107,7 @@ declare module '@micrio/client' {
 				/** All markers are scaled with the image */
 				markersScale?: boolean;
 				/** Albums */
-				gallery?: GallerySettings;
+				gallery?: GalleryConfig;
 				/** FOR OMNI OBJECTS */
 				omni?: OmniSettings;
 				/** Optional marker settings */
@@ -1169,31 +1155,6 @@ declare module '@micrio/client' {
 				/** Watermark opacity, defaults to 0.075 */
 				watermarkOpacity?: number;
 			};
-			type GallerySettings = {
-				/** Album/image ID for the gallery */
-				id?: string;
-				/** Gallery name */
-				name?: string;
-				/** Gallery has an associated .bin archive with thumbnails */
-				archive?: string;
-				/** Archive layer offset */
-				archiveLayerOffset?: number;
-				/** Gallery sorting */
-				sort?: ('name' | '-name' | 'created' | '-created' | 'random');
-				/** Gallery type */
-				type?: ('swipe' | 'swipe-full' | 'switch' | 'omni' | 'grid');
-				/** The gallery opening image ID */
-				startId?: string;
-				/** Pages are combined to 2x1 spreads */
-				isSpreads?: boolean;
-				/** For spreads, number of cover pages to show as single page */
-				coverPages?: number;
-				/** Optional viewer settings that override/merge with defaults */
-				settings?: Partial<ImageInfo.Settings>;
-				revisions?: {
-					[key: string]: RevisionType;
-				};
-			};
 			type OmniSettings = {
 				/** Number of frames */
 				frames: number;
@@ -1777,7 +1738,7 @@ declare module '@micrio/client' {
 					id: string;
 					data: Models.Spaces.Space;
 				}[];
-				album?: ImageInfo.GallerySettings;
+				album?: GalleryConfig;
 			};
 		}
 		namespace Assets {
@@ -1927,7 +1888,7 @@ declare module '@micrio/client' {
 				baseTileIdx: number;
 				ptr: number;
 				opts: {
-					area: Camera.ViewRect;
+					area: Camera.View;
 				};
 			}
 		}
@@ -1938,8 +1899,8 @@ declare module '@micrio/client' {
 			/** Virtual ImageInfo extension to support grid logic */
 			interface GridImage extends Partial<ImageInfo.ImageInfo> {
 				size: [number, number?];
-				area?: Camera.ViewRect;
-				view?: Camera.ViewRect;
+				area?: Camera.View;
+				view?: Camera.View;
 			}
 			interface GridHistory {
 				layout: string;
@@ -1948,7 +1909,7 @@ declare module '@micrio/client' {
 			}
 			interface GridImageOptions {
 				view?: Camera.View;
-				area?: Camera.ViewRect;
+				area?: Camera.View;
 				size?: number[];
 			}
 			interface FocusOptions {
@@ -1976,7 +1937,7 @@ declare module '@micrio/client' {
 			/** The current page index */
 			currentIndex: number;
 			/** The album info */
-			info?: ImageInfo.GallerySettings;
+			info?: GalleryConfig;
 			/** Go to previous page */
 			prev: () => void;
 			/** Go to next page */
@@ -1990,12 +1951,39 @@ declare module '@micrio/client' {
 			 * controls to the image under focus instead of the virtual parent. */
 			currentImage?: Writable<import("ts/image").MicrioImage>;
 		}
+		/** Gallery item representing a single image within a gallery or grid */
+		type GalleryItem = {
+			id: string;
+			width: number;
+			height: number;
+			path?: string;
+			tileSize?: number;
+			isDeepZoom?: boolean;
+			isPng?: boolean;
+			isWebP?: boolean;
+		};
+		/** Gallery configuration */
+		type GalleryConfig = {
+			type: 'swipe' | 'switch' | 'grid';
+			startId?: string;
+			sort?: 'name' | '-name' | 'created' | '-created' | 'random';
+			isSpreads?: boolean;
+			coverPages?: number;
+			archive?: string;
+			archiveLayerOffset?: number;
+			revisions?: Record<string, Record<string, any>>;
+			settings?: Partial<ImageInfo.Settings>;
+			id?: string;
+			name?: string;
+			grid?: {
+				clickable?: 'focus' | 'zoom' | false;
+				panZoom?: 'cells' | 'grid';
+			};
+		};
 		namespace Camera {
 			/** A numeric array or Float64Array used for camera geometry. */
 			type CameraArray = number[] | Float64Array;
-			/** A viewport rectangle `[x0, y0, x1, y1]` (corners). */
-			type ViewRect = CameraArray;
-			/** An area definition `[x0, y0, width, height]` (origin + size). */
+			/** A viewport/area definition `[x, y, width, height]` (origin + size). */
 			type View = CameraArray;
 			/** Coordinate tuple, [x, y, scale] */
 			type Coords = [number, number, number?] | Float64Array;
@@ -2673,6 +2661,60 @@ declare module '@micrio/client' {
 		/** Unhooks pointer listeners for drag panning. */
 		unhookDrag(): void;
 	}
+	export class Gallery {
+		readonly config: Models.GalleryConfig;
+		readonly images: MicrioImage[];
+		readonly engine: Engine;
+		readonly micrio: HTMLMicrioElement;
+		parent: MicrioImage | null;
+		swiper: any;
+		grid: Grid | null;
+		readonly currentIndex: Writable<number>;
+		/** For grid-type galleries, the processed grid string for Grid controller. */
+		_gridString: string | undefined;
+		/** Max width for the virtual container canvas (switch/omni galleries). */
+		containerWidth: number;
+		/** Max height for the virtual container canvas (switch/omni galleries). */
+		containerHeight: number;
+		get type(): Models.GalleryConfig['type'];
+		constructor(items: Models.GalleryItem[], engine: Engine, micrio: HTMLMicrioElement, config: Models.GalleryConfig);
+		/** Create a gallery from a IIIF Presentation API 3 manifest. Returns null for single-image manifests and raw Image API responses. */
+		static fromIIIF(url: string, engine: Engine, micrio: HTMLMicrioElement): Promise<Gallery | null>;
+		/** Extract single-image gallery item from a IIIF response URL */
+		static singleIIIFInfo(url: string): Promise<Models.GalleryItem>;
+		static fromAssets(assets: Models.Assets.Image[], engine: Engine, micrio: HTMLMicrioElement, opts?: {
+			startId?: string;
+			basePath?: string;
+		}): Gallery;
+		static fromArchive(archiveId: string, path: string, engine: Engine, micrio: HTMLMicrioElement, config?: Partial<Models.GalleryConfig>): Promise<Gallery>;
+		static fromGrid(gridData: string, engine: Engine, micrio: HTMLMicrioElement, config?: Partial<Models.GalleryConfig & {
+			path?: string;
+		}>): Promise<Gallery | null>;
+		static fromAlbum(albumId: string, engine: Engine, micrio: HTMLMicrioElement, opts?: {
+			startId?: string;
+			path?: string;
+			onProgress?: (n: number) => void;
+		}): Promise<Gallery | null>;
+		private static getArchiveIndex;
+		private static sortArchiveImages;
+		/** Compute the page layout for Gallery.svelte. Returns pages (camera views) and
+		 *  the mapping from page index to image index(es). For strip-swipe galleries each
+		 *  image fills the full viewport; for switch/grid the per-image `opts.area` is used
+		 *  and spreads are merged into single pages. */
+		getPageLayout(): {
+			pages: Models.Camera.View[];
+			pageIdxes: number[][];
+		};
+		attach(parent: MicrioImage): void;
+		detach(): void;
+		destroy(): void;
+		/** Go to a specific page index. */
+		goto(index: number): void;
+		/** Go to the next page. */
+		next(): void;
+		/** Go to the previous page. */
+		prev(): void;
+	}
 	/**
 	 * Language-related constants and utilities.
 	 */
@@ -2802,6 +2844,8 @@ declare module '@micrio/client' {
 		defaultSettings?: Partial<Models.ImageInfo.Settings>;
 		/** Holds data for the current 360 space, if applicable (loaded via `data-space` attribute or API). */
 		spaceData: Models.Spaces.Space | undefined;
+		/** The current active gallery controller, if any. */
+		readonly gallery: Writable<Gallery | undefined>;
 		addEventListener<K extends keyof Models.MicrioEventMap>(type: K, listener: (this: HTMLMicrioElement, ev: Models.MicrioEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
 		addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLMicrioElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
 		addEventListener(type: string, listener: (this: HTMLMicrioElement, ev: Event) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2831,6 +2875,8 @@ declare module '@micrio/client' {
 			startView?: Models.Camera.View;
 			/** For 360 transitions, provides the direction vector from the previous image. */
 			vector?: Models.Camera.Vector;
+			/** Optional Gallery controller, used for gallery/grid views. */
+			gallery?: Gallery;
 		}): MicrioImage;
 		/**
 		 * Closes an opened MicrioImage.
@@ -2839,11 +2885,6 @@ declare module '@micrio/client' {
 		 * @param img The {@link MicrioImage} instance to close.
 		*/
 		close(img: MicrioImage): void;
-		/** Holds loaded grid info data if applicable. */
-		gridInfoData: {
-			images: Models.ImageInfo.ImageInfo[];
-		} | undefined;
-		private sortArchiveImages;
 		/** Getter for the current language code. */
 		get lang(): string;
 		/** Setter for the current language code. Triggers language change logic. */