@micrio/client 6.0.14 → 6.1.0

package/micrio.min.d.ts

@@ -12,119 +12,10 @@ declare module '@micrio/client' {
 	 * @returns A Promise resolving to the loaded TextureBitmap.
 	 */
 	export const loadTexture: (src: string) => Promise<TextureBitmap>;
-	/** Type for error codes */
-	export type ErrorCode = typeof ErrorCodes[keyof typeof ErrorCodes];
 	/**
 	 * Calculates the positive modulo (floored division remainder).
 	 */
 	export const mod: (n: number, m?: number) => number;
-	/**
-	 * Converts seconds into a human-readable time string (hh?:mm:ss).
-	 * @param s Time in seconds. Can be negative for remaining time display.
-	 * @returns Formatted time string (e.g., "1:23", "1:05:09", "-0:15").
-	 */
-	export function parseTime(s: number): string;
-	export type PREDEFINED = [string, Models.ImageInfo.ImageInfo, Models.ImageData.ImageData | undefined];
-	/** Enum for identifying media type. */
-	export enum MediaType {
-		None = 0,
-		IFrame = 1,
-		Video = 2,
-		Audio = 3,
-		VideoTour = 4,
-		Micrio = 5
-	}
-	/** Enum for identifying iframe player type. */
-	export enum FrameType {
-		YouTube = 1,
-		Vimeo = 2
-	}
-	export { isLegacyViews };
-	/**
-	 * Marker clustering algorithm for calculating overlapping markers
-	 * and generating cluster marker objects.
-	 * @author Marcel Duin <marcel@micr.io>
-	 */
-	type MarkerData = Models.ImageData.Marker;
-	export type MarkerCoords = [x: number, y: number, w?: number, h?: number];
-	export interface ClusterResult {
-		overlapped: number[];
-		clusterMarkers: MarkerData[];
-	}
-	/**
-	 * Calculates which markers overlap and generates synthetic cluster markers.
-	 */
-	export function calcClusters(visibleMarkers: MarkerData[] | undefined, coords: Map<string, MarkerCoords>, r: number, isOmni: boolean): ClusterResult;
-	/**
-	 * Media utilities for source parsing, type detection, and player management.
-	 * @author Marcel Duin <marcel@micr.io>
-	 */
-	/** YouTube no-cookies host */
-	export const YOUTUBE_HOST = "https://www.youtube-nocookie.com";
-	/**
-	 * Parsed media source information.
-	 */
-	export interface ParsedMediaSource {
-		/** The detected media type */
-		type: MediaType;
-		/** The frame type for iframe embeds (YouTube/Vimeo) */
-		frameType?: FrameType;
-		/** The normalized/processed source URL */
-		src?: string;
-		/** YouTube video ID (if applicable) */
-		youtubeId?: string;
-		/** Vimeo video ID (if applicable) */
-		vimeoId?: string;
-		/** Vimeo hash token (if applicable) */
-		vimeoToken?: string;
-		/** Cloudflare video ID (if applicable) */
-		cloudflareId?: string;
-		/** Micrio embed data [id, width?, height?, lang?] */
-		micrioEmbed?: string[];
-		/** Start time extracted from URL (seconds) */
-		startTime?: number;
-		/** Whether the source is a Cloudflare stream */
-		isCloudflare: boolean;
-		/** M3U8 URL for HLS streams */
-		hlsSrc?: string;
-	}
-	/**
-	 * 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
-	 * interaction is required per audio element.
-	 */
-	export function getIOSAudioElement(): HTMLAudioElement;
-	/**
-	 * Global utility functions used throughout the Micrio application.
-	 * Re-exports all utility modules for convenient importing.
-	 * @author Marcel Duin <marcel@micr.io>
-	 */
-	export { MicrioError, ErrorCodes, UserErrorMessages } from "ts/utils/error";
-	export type { ErrorCode } from "ts/utils/error";
-	export { pyth, mod, limitView } from "ts/utils/math";
-	export { clone, deepCopy } from "ts/utils/object";
-	export { createGUID, slugify, parseTime } from "ts/utils/string";
-	export { Browser } from "ts/utils/browser";
-	export { sleep, notypecheck, loadScript } from "ts/utils/dom";
-	export { once, after } from "ts/utils/store";
-	export { View } from "ts/utils/view";
-	export { sanitizeAsset, isLegacyViews, sanitizeImageInfo, sanitizeImageData, sanitizeSpaceData, sanitizeMarker, sanitizeVideoTour } from "ts/utils/sanitize";
-	export { jsonCache, fetchJson, isFetching, getLocalData, fetchInfo, fetchAlbumInfo } from "ts/utils/fetch";
-	export { loadSerialTour } from "ts/utils/tour";
-	export { getIdVal, idIsV5 } from "ts/utils/id";
-	export { getSpaceVector } from "ts/utils/space";
-	export { calcClusters } from "ts/utils/clustering";
-	export type { MarkerCoords, ClusterResult } from "ts/utils/clustering";
-	export { hasNativeHLS, parseMediaSource, getIOSAudioElement, getAudioSrc, getMarkerCulture, getMenuCulture, YOUTUBE_HOST } from "ts/utils/media";
-	export type { ParsedMediaSource } from "ts/utils/media";
 	/**
 	 * Defines various enums used throughout the Micrio application,
 	 * primarily for standardizing action types and option values.
@@ -277,9 +168,9 @@ declare module '@micrio/client' {
 		isZoomedOut: (full?: boolean) => boolean;
 		/**
 		 * Sets a rectangular limit for camera navigation within the image.
-		 * @param v The viewport limit rectangle [x0, y0, x1, y1].
+		 * @param v The viewport limit [x, y, width, height] in image-relative coordinates.
 		*/
-		setLimit(v: Models.Camera.ViewRect): void;
+		setLimit(v: Models.Camera.View): void;
 		/**
 		 * Sets whether the camera view should be limited to always cover the viewport.
 		 * @param b If true, limits the view to cover the screen.
@@ -516,6 +407,61 @@ declare module '@micrio/client' {
 		 */
 		animateTo(idx: number): void;
 	}
+	/**
+	 * Converts seconds into a human-readable time string (hh?:mm:ss).
+	 * @param s Time in seconds. Can be negative for remaining time display.
+	 * @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
+	 * related images in a single request.
+	 *
+	 * If the bundle fails the image is simply unavailable — there are no
+	 * individual `info.json` / `data.json` fallbacks.
+	 *
+	 * This is the single source of truth for image info & data fetches.
+	 *
+	 * @author Marcel Duin <marcel@micr.io>
+	 */
+	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>;
+		/** Returns the data for an image ID, or undefined if not found in its bundle. */
+		getData(id: string): Promise<Models.ImageData.ImageData | undefined>;
+		/** Synchronous accessor for already-cached bundle data. */
+		getDataSync(id: string): Models.ImageData.ImageData | undefined;
+		/**
+		 * Resolves the marker for a tour step from the already-loaded bundle cache.
+		 * This replaces the earlier static `.marker` JSON that was inlined in stepInfo.
+		 */
+		getStepMarker(step: Models.ImageData.MarkerTourStepInfo): Models.ImageData.Marker | undefined;
+		/** Returns the space data for a space ID, or undefined if not found in its bundle. */
+		getSpaceData(id: string): Models.Spaces.Space | undefined;
+		/** 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.
+		 */
+		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;
+		}>>;
+	};
 	/**
 	 * # Micrio State management
 	 *
@@ -1083,10 +1029,10 @@ declare module '@micrio/client' {
 				 * NOTE: to modify this at runtime, use the MicrioImage.settings Writable store.
 				*/
 				settings?: Partial<ImageInfo.Settings>;
-				/** Optional organisation data */
-				organisation?: ImageInfo.Organisation;
 				/** The image title (default: autoloaded) */
 				title?: string;
+				/** @deprecated Moved to `bundle.json` top-level `organisation` */
+				organisation?: ImageInfo.Organisation;
 				/** The initial data language */
 				lang?: string;
 				/** The image is 360 degrees */
@@ -1147,8 +1093,6 @@ declare module '@micrio/client' {
 				};
 				/** Use a custom uri for the info json file */
 				infoUrl?: string;
-				/** Force refresh for published data JSON file */
-				forceDataRefresh?: boolean;
 				/** Render this image as a static image */
 				static?: boolean;
 				/** Use a custom thumbnail image uri */
@@ -1855,7 +1799,6 @@ declare module '@micrio/client' {
 			/** Auto generated metadata for marker tours */
 			type MarkerTourStepInfo = {
 				markerId: string;
-				marker: Marker;
 				micrioId: string;
 				duration: number;
 				imageHasOtherMarkers?: boolean;
@@ -1915,6 +1858,25 @@ declare module '@micrio/client' {
 				buttons?: MenuPageButton[];
 			};
 		}
+		/**
+		 * A bundled image response from the `bundle.json` endpoint.
+		 * Contains both info and data for one or more related images in a single response.
+		 */
+		namespace ImageBundle {
+			type BundleImage = {
+				id: string;
+				info: Models.ImageInfo.ImageInfo;
+				data: Models.ImageData.ImageData;
+			};
+			type BundleResponse = {
+				images: BundleImage[];
+				organisation?: ImageInfo.Organisation;
+				spaces?: {
+					id: string;
+					data: Models.Spaces.Space;
+				}[];
+			};
+		}
 		namespace Assets {
 			type BaseAsset = {
 				/** The asset title (not filename) */
@@ -3222,6 +3184,68 @@ declare module '@micrio/client' {
 		setVolume(volume: number): void;
 		destroy(): void;
 	}
+	export type PREDEFINED = [string, Models.ImageInfo.ImageInfo, Models.ImageData.ImageData | undefined];
+	/** Enum for identifying media type. */
+	export enum MediaType {
+		None = 0,
+		IFrame = 1,
+		Video = 2,
+		Audio = 3,
+		VideoTour = 4,
+		Micrio = 5
+	}
+	/** Enum for identifying iframe player type. */
+	export enum FrameType {
+		YouTube = 1,
+		Vimeo = 2
+	}
+	/**
+	 * Media utilities for source parsing, type detection, and player management.
+	 * @author Marcel Duin <marcel@micr.io>
+	 */
+	/** YouTube no-cookies host */
+	export const YOUTUBE_HOST = "https://www.youtube-nocookie.com";
+	/**
+	 * Parsed media source information.
+	 */
+	export interface ParsedMediaSource {
+		/** The detected media type */
+		type: MediaType;
+		/** The frame type for iframe embeds (YouTube/Vimeo) */
+		frameType?: FrameType;
+		/** The normalized/processed source URL */
+		src?: string;
+		/** YouTube video ID (if applicable) */
+		youtubeId?: string;
+		/** Vimeo video ID (if applicable) */
+		vimeoId?: string;
+		/** Vimeo hash token (if applicable) */
+		vimeoToken?: string;
+		/** Cloudflare video ID (if applicable) */
+		cloudflareId?: string;
+		/** Micrio embed data [id, width?, height?, lang?] */
+		micrioEmbed?: string[];
+		/** Start time extracted from URL (seconds) */
+		startTime?: number;
+		/** Whether the source is a Cloudflare stream */
+		isCloudflare: boolean;
+		/** M3U8 URL for HLS streams */
+		hlsSrc?: string;
+	}
+	/**
+	 * 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
+	 * interaction is required per audio element.
+	 */
+	export function getIOSAudioElement(): HTMLAudioElement;
 	/**
 	 * Adapter for YouTube IFrame Player API.
 	 */
@@ -3295,6 +3319,21 @@ declare module '@micrio/client' {
 	export { archive } from "ts/render/archive";
 	export { loadTexture, runningThreads, numThreads, abortDownload } from "ts/render/textures";
 	export type { TextureBitmap } from "ts/render/textures";
+	/**
+	 * Marker clustering algorithm for calculating overlapping markers
+	 * and generating cluster marker objects.
+	 * @author Marcel Duin <marcel@micr.io>
+	 */
+	type MarkerData = Models.ImageData.Marker;
+	export type MarkerCoords = [x: number, y: number, w?: number, h?: number];
+	export interface ClusterResult {
+		overlapped: number[];
+		clusterMarkers: MarkerData[];
+	}
+	/**
+	 * Calculates which markers overlap and generates synthetic cluster markers.
+	 */
+	export function calcClusters(visibleMarkers: MarkerData[] | undefined, coords: Map<string, MarkerCoords>, r: number, isOmni: boolean): ClusterResult;
 }declare module "svelte/store" {
 	/** Callback to inform of a value updates.
 	*/