@micrio/client 6.1.1 → 6.1.3

package/micrio.min.d.ts

@@ -88,14 +88,9 @@ declare module '@micrio/client' {
 		 * @returns A copy of the current screen viewport array, or undefined if not initialized.
 		 */
 		getViewRaw: () => Float64Array;
-		/**
-		 * Gets the current image view rectangle [x0, y0, x1, y1] relative to the image (0-1).
-		 * @returns A copy of the current screen viewport array, or undefined if not initialized.
-		 */
-		getViewLegacy: () => Models.Camera.ViewRect | undefined;
 		/**
 		 * Sets the camera view instantly to the specified viewport.
-		 * @param view The target viewport as either a View [x0, y0, x1, y1] or View {centerX, centerY, width, height}.
+		 * @param view The target viewport as a View [x0, y0, width, height].
 		 * @param opts Options for setting the view.
 		 */
 		setView(view: Models.Camera.View, opts?: {
@@ -184,7 +179,7 @@ declare module '@micrio/client' {
 		aniIsKinetic(): boolean;
 		/**
 		 * Animates the camera smoothly to a target viewport.
-		 * @param view The target viewport as either a View [x0, y0, x1, y1] or View {centerX, centerY, width, height}.
+		 * @param view The target viewport as a View [x0, y0, width, height].
 		 * @param opts Optional animation settings.
 		 * @returns A Promise that resolves when the animation completes, or rejects if aborted.
 		 */
@@ -413,8 +408,6 @@ declare module '@micrio/client' {
 	 * @returns Formatted time string (e.g., "1:23", "1:05:09", "-0:15").
 	 */
 	export function parseTime(s: number): string;
-	/** Type for error codes */
-	export type ErrorCode = typeof ErrorCodes[keyof typeof ErrorCodes];
 	/**
 	 * Centralized data loading controller.
 	 * Uses the `bundle.json` endpoint which returns info + data for multiple
@@ -427,6 +420,7 @@ declare module '@micrio/client' {
 	 *
 	 * @author Marcel Duin <marcel@micr.io>
 	 */
+	type BundleImage = Models.ImageBundle.BundleImage;
 	export const DataLoader: {
 		/** Returns the info for an image ID, or undefined if not found in its bundle. */
 		getInfo(id: string): Promise<Models.ImageInfo.ImageInfo | undefined>;
@@ -444,29 +438,16 @@ declare module '@micrio/client' {
 		/** Returns the organisation data from the bundle, or undefined. */
 		getOrganisation(): Models.ImageInfo.Organisation | undefined;
 		/**
-		 * Returns both info + data for a single image ID, or undefined if the image
-		 * is not present in its bundle.
+		 * Returns the full bundle entry (info + data) for a single image ID,
+		 * fetching the bundle once if not cached.
 		 */
-		getBundleImage(id: string): Promise<{
-			data: Models.ImageData.ImageData;
-			info: Models.ImageInfo.ImageInfo;
-		} | undefined>;
-		/**
-		 * Bulk variant of {@link getBundleImage}.
-		 *
-		 * Fetches the bundle for the first non‑IIIF ID, then resolves every requested
-		 * image from the cached bundle results.
-		 */
-		getBundleImages(ids: string[]): Promise<Map<string, {
-			info: Models.ImageInfo.ImageInfo;
-			data: Models.ImageData.ImageData;
-		}>>;
+		getBundleImage(id: string): Promise<BundleImage | undefined>;
 	};
 	/**
 	 * # Micrio State management
 	 *
 	 * Manages the application state using Svelte stores, allowing reactive updates
-	 * throughout the UI and providing methods to get/set the overall state.
+	 * throughout the UI.
 	 * Replaces the imperative API of Micrio 3.x.
 	 *
 	 * Consists of two main state controllers:
@@ -477,46 +458,13 @@ declare module '@micrio/client' {
 	 * @author Marcel Duin <marcel@micr.io>
 	 */
 	export namespace State {
-		/** Represents the entire serializable state of a Micrio instance. */
-		type MicrioStateJSON = {
-			/** The ID of the currently active main image. */
-			id: string;
-			/** Array containing the state of each individual image canvas. */
-			c: ImageState[];
-			/** Optional information about the currently active tour [tourId, currentTime?, pausedState?]. */
-			t?: [string, number?, string?];
-			/** Reference to the currently active HTMLMediaElement (unused?). */
-			m?: HTMLMediaElement;
-		};
-		/** Represents the serializable state of a single MicrioImage instance. */
-		type ImageState = [
-			/** The image ID. */
-			string,
-			/** The current viewport x0. */
-			number,
-			/** The current viewport y0. */
-			number,
-			/** The current viewport x1. */
-			number,
-			/** The current viewport y1. */
-			number,
-			/** The ID of the currently opened marker within this image (optional). */
-			string?,
-			/** The UUID of the media element associated with the opened marker (optional). */
-			string?,
-			/** The currentTime of the marker's media element (optional). */
-			number?,
-			/** The paused state ('p') of the marker's media element (optional). */
-			string?
-		];
 		/**
 		* # HTMLMicrioElement state controller (`micrio.state`)
 		*
 		* Manages the global application state associated with the main `<micr-io>` element.
-		* Provides Svelte stores for reactive UI updates and methods for state serialization.
+		* Provides Svelte stores for reactive UI updates.
 		*/
 		class Main {
-			private micrio;
 			/** Writable Svelte store holding the currently active tour object (VideoTour or MarkerTour), or undefined if no tour is active. */
 			readonly tour: Writable<Models.ImageData.VideoTour | Models.ImageData.MarkerTour | undefined>;
 			/** Getter for the current value of the {@link tour} store. */
@@ -542,32 +490,6 @@ declare module '@micrio/client' {
 				/** Writable store: true when gallery controls are hovered or focused, keeping all UI visible. */
 				hover: Writable<boolean>;
 			};
-			/**
-			 * Gets the current state of the Micrio viewer as a serializable JSON object.
-			 * This object captures the active image(s), viewports, open markers, active tour,
-			 * and media playback states, allowing the exact state to be restored later or elsewhere.
-			 *
-			 * @example
-			 * ```javascript
-			 * const currentState = micrio.state.get();
-			 * // Store or transmit `currentState`
-			 * ```
-			 * @returns The current state as a {@link MicrioStateJSON} object, or undefined if no image is loaded.
-			 */
-			get(): MicrioStateJSON | undefined;
-			/**
-			 * Sets the Micrio viewer state from a previously saved {@link MicrioStateJSON} object.
-			 * This will attempt to restore the active image, viewports, open markers, active tour,
-			 * and media playback states.
-			 *
-			 * @example
-			 * ```javascript
-			 * const savedState = // ... load state object ...
-			 * micrio.state.set(savedState);
-			 * ```
-			 * @param s The state object to load.
-			 */
-			set(s: MicrioStateJSON): Promise<void>;
 		}
 		/**
 		* # MicrioImage state controller (`micrioImage.state`)
@@ -999,7 +921,7 @@ declare module '@micrio/client' {
 				version: string;
 				/** Created date */
 				created?: number;
-				/** Has new viewport model, optimized for 360 images */
+				/** Has new viewport model, optimized for 360 images. Server-side only, not read client-side. */
 				viewsWH?: boolean;
 				/** For V5+: published revisions per language */
 				revision?: RevisionType;
@@ -1082,7 +1004,7 @@ declare module '@micrio/client' {
 			type Settings = {
 				/** The starting viewport */
 				view?: Camera.View;
-				/** Restrict navigation to this viewport (`[x0,y0,x1,y1]`) */
+				/** Restrict navigation to this viewport (`[x0, y0, width, height]`) */
 				restrict?: Camera.View;
 				/** Load a cover-initing image focussed on this coordinate (`[x, y]`) */
 				focus?: [number, number];
@@ -1121,8 +1043,6 @@ declare module '@micrio/client' {
 				keepRendering?: boolean;
 				/** Don't load GTM module */
 				noGTag?: boolean;
-				/** With routing enabled, enable marker/tour deeplinks */
-				routerMarkerTours?: boolean;
 				/** Skip the deepest zoom levels */
 				skipBaseLevels?: number;
 				/** The camera animation speed (default: 1) */
@@ -1742,8 +1662,6 @@ declare module '@micrio/client' {
 				keepMarkers?: boolean;
 				/** Don't disable user navigation when running */
 				keepInteraction?: boolean;
-				/** The tour is a direct outside instance using legacy [x0,y0,x1,y1] viewports */
-				isLegacy?: boolean;
 				/** Current running tour instance */
 				instance?: VideoTourInstance;
 			};
@@ -2312,8 +2230,6 @@ declare module '@micrio/client' {
 				'data-skipmeta'?: boolean;
 				/** Simulate an <img/> element. No logo, loader bar, and no event listeners. Default: false */
 				'data-static'?: boolean;
-				/** Read and write deeplinks to opened tours and markers. Default: null */
-				'data-router'?: string;
 				/** Sending user input as GA Events to any available GTag instance (does nothing if none). Default: true */
 				'data-gtag'?: boolean;
 				/** Set the speed factor for camera animations. Default: 1 */
@@ -2967,8 +2883,6 @@ declare module '@micrio/client' {
 		readonly state: State.Main;
 		/** The Google Analytics integration controller. */
 		private readonly analytics;
-		/** The URL router, handling deep linking and history management. */
-		private readonly _router;
 		/** Writable Svelte store indicating if barebone texture downloading is enabled (lower quality, less bandwidth). */
 		readonly barebone: Writable<boolean>;
 		/** Custom settings object provided programmatically, overriding server-fetched settings. */
@@ -3208,7 +3122,7 @@ declare module '@micrio/client' {
 	/**
 	 * Parsed media source information.
 	 */
-	export interface ParsedMediaSource {
+	interface ParsedMediaSource {
 		/** The detected media type */
 		type: MediaType;
 		/** The frame type for iframe embeds (YouTube/Vimeo) */
@@ -3236,10 +3150,6 @@ declare module '@micrio/client' {
 	 * Parses a media source URL and determines its type and configuration.
 	 */
 	export function parseMediaSource(src: string | undefined, tour: Models.ImageData.VideoTour | null, useNativeFrames?: boolean, currentTime?: number): ParsedMediaSource;
-	/**
-	 * Checks if the browser natively supports HLS playback.
-	 */
-	export function hasNativeHLS(el?: HTMLMediaElement): boolean;
 	/**
 	 * Returns a shared Audio element instance for iOS.
 	 * This is a workaround for iOS audio playback restrictions where user
@@ -3309,7 +3219,6 @@ declare module '@micrio/client' {
 	export { HLSPlayerAdapter } from "ts/media/hls-adapter";
 	export { GLEmbedVideo } from "ts/media/embedvideo";
 	export { VideoTourInstance } from "ts/media/videotour";
-	export { Router } from "ts/nav/router";
 	export { Grid } from "ts/nav/grid";
 	export { GallerySwiper } from "ts/nav/swiper";
 	export { Engine } from "ts/render/engine";
@@ -3326,7 +3235,7 @@ declare module '@micrio/client' {
 	 */
 	type MarkerData = Models.ImageData.Marker;
 	export type MarkerCoords = [x: number, y: number, w?: number, h?: number];
-	export interface ClusterResult {
+	interface ClusterResult {
 		overlapped: number[];
 		clusterMarkers: MarkerData[];
 	}