@ericchen1990/pano-view 3.10.0 → 4.0.0

package/dist/data.d.mts

@@ -542,7 +542,23 @@ type PanoDragMotion = {
     bounce?: boolean;
 };
 
-type PanoMapCorner = "top-left" | "top-right" | "bottom-left" | "bottom-right";
+declare const PANO_OVERLAY_ALIGNS: readonly ["top", "bottom", "left", "right", "top-left", "top-right", "bottom-left", "bottom-right"];
+type PanoOverlayAlign = (typeof PANO_OVERLAY_ALIGNS)[number];
+type PanoOverlayAxis = "horizontal" | "vertical";
+type PanoOverlayInset = number | string | {
+    top?: number | string;
+    right?: number | string;
+    bottom?: number | string;
+    left?: number | string;
+};
+/** Shared screen-edge anchor for planar overlay chrome. */
+type PanoOverlayAnchor = {
+    align?: PanoOverlayAlign;
+    /** Used for corner anchors. Edges infer the axis and ignore this value. */
+    axis?: PanoOverlayAxis;
+    inset?: PanoOverlayInset;
+};
+
 type PanoMapGradientStop = {
     offset: number;
     color: string;
@@ -594,28 +610,24 @@ type PanoMapSpotDefinition = {
     icon?: string;
 };
 type PanoMapControlsDefinition = {
-    /** Show expand/collapse on a docked panel. */
+    /** Show the edge tab that slides a panel off-screen. */
     collapse?: boolean;
     /** Show zoom-in and zoom-out buttons. */
     zoom?: boolean;
 };
-type PanoMapDockedPresentation = {
-    mode: "docked";
-    corner?: PanoMapCorner;
+type PanoMapPanelPresentation = {
+    mode: "panel";
+    anchor?: PanoOverlayAnchor;
     width?: number;
     height?: number;
-    offsetX?: number;
-    offsetY?: number;
 };
 type PanoMapDialogPresentation = {
     mode: "dialog";
-    corner?: PanoMapCorner;
-    offsetX?: number;
-    offsetY?: number;
+    anchor?: PanoOverlayAnchor;
     width?: number;
     height?: number;
 };
-type PanoMapPresentation = PanoMapDockedPresentation | PanoMapDialogPresentation;
+type PanoMapPresentation = PanoMapPanelPresentation | PanoMapDialogPresentation;
 type PanoMapDefinition = {
     image: string;
     /**
@@ -696,4 +708,4 @@ declare function parsePanoProject(value: unknown, options?: {
 }): PanoProjectDefinition;
 declare function loadPanoProject(source: string | PanoProjectDefinition, options?: LoadPanoProjectOptions): Promise<LoadedPanoProject>;
 
-export { type AssetUrlContext, type AssetUrlResolver, type CubemapViewerConfig, type JsonObject, type JsonRequestOptions, type JsonValue, type LoadPanoProjectOptions, type LoadSceneFromJsonOptions, type LoadedPanoProject, type LoadedProjectScene, PanoDataError, type PanoDataErrorCode, type PanoDragMotion, type PanoMapControlsDefinition, type PanoMapCorner, type PanoMapDefinition, type PanoMapDialogPresentation, type PanoMapDockedPresentation, type PanoMapGradientStop, type PanoMapPresentation, type PanoMapSectorDefinition, type PanoMapSectorGradient, type PanoMapSpotDefinition, type PanoProjectDefinition, type PanoProjectSceneDefinition, type PanoViewLimits, type PopupAssetUrlContext, type PopupAssetUrlResolver, type ProjectCustomHotspotAction, type ProjectHotspotAction, type ProjectHotspotDefinition, type ProjectHotspotTrigger, type ProjectPopupBlock, type ProjectPopupDefinition, type SceneFromViewerConfigOptions, type SphereViewerConfig, type ViewerConfig, type ViewerDocument, hotspotAction, loadPanoProject, loadSceneFromJson, parsePanoMap, parsePanoProject, projectHotspotTriggers, resolvePanoMapAssets, resolveHotspotAssets as resolveProjectHotspotAssets, resolveProjectPopupAssets, sceneFromViewerConfig, setHotspotAction };
+export { type AssetUrlContext, type AssetUrlResolver, type CubemapViewerConfig, type JsonObject, type JsonRequestOptions, type JsonValue, type LoadPanoProjectOptions, type LoadSceneFromJsonOptions, type LoadedPanoProject, type LoadedProjectScene, PanoDataError, type PanoDataErrorCode, type PanoDragMotion, type PanoMapControlsDefinition, type PanoMapDefinition, type PanoMapDialogPresentation, type PanoMapGradientStop, type PanoMapPanelPresentation, type PanoMapPresentation, type PanoMapSectorDefinition, type PanoMapSectorGradient, type PanoMapSpotDefinition, type PanoProjectDefinition, type PanoProjectSceneDefinition, type PanoViewLimits, type PopupAssetUrlContext, type PopupAssetUrlResolver, type ProjectCustomHotspotAction, type ProjectHotspotAction, type ProjectHotspotDefinition, type ProjectHotspotTrigger, type ProjectPopupBlock, type ProjectPopupDefinition, type SceneFromViewerConfigOptions, type SphereViewerConfig, type ViewerConfig, type ViewerDocument, hotspotAction, loadPanoProject, loadSceneFromJson, parsePanoMap, parsePanoProject, projectHotspotTriggers, resolvePanoMapAssets, resolveHotspotAssets as resolveProjectHotspotAssets, resolveProjectPopupAssets, sceneFromViewerConfig, setHotspotAction };

package/dist/data.d.ts

@@ -542,7 +542,23 @@ type PanoDragMotion = {
     bounce?: boolean;
 };
 
-type PanoMapCorner = "top-left" | "top-right" | "bottom-left" | "bottom-right";
+declare const PANO_OVERLAY_ALIGNS: readonly ["top", "bottom", "left", "right", "top-left", "top-right", "bottom-left", "bottom-right"];
+type PanoOverlayAlign = (typeof PANO_OVERLAY_ALIGNS)[number];
+type PanoOverlayAxis = "horizontal" | "vertical";
+type PanoOverlayInset = number | string | {
+    top?: number | string;
+    right?: number | string;
+    bottom?: number | string;
+    left?: number | string;
+};
+/** Shared screen-edge anchor for planar overlay chrome. */
+type PanoOverlayAnchor = {
+    align?: PanoOverlayAlign;
+    /** Used for corner anchors. Edges infer the axis and ignore this value. */
+    axis?: PanoOverlayAxis;
+    inset?: PanoOverlayInset;
+};
+
 type PanoMapGradientStop = {
     offset: number;
     color: string;
@@ -594,28 +610,24 @@ type PanoMapSpotDefinition = {
     icon?: string;
 };
 type PanoMapControlsDefinition = {
-    /** Show expand/collapse on a docked panel. */
+    /** Show the edge tab that slides a panel off-screen. */
     collapse?: boolean;
     /** Show zoom-in and zoom-out buttons. */
     zoom?: boolean;
 };
-type PanoMapDockedPresentation = {
-    mode: "docked";
-    corner?: PanoMapCorner;
+type PanoMapPanelPresentation = {
+    mode: "panel";
+    anchor?: PanoOverlayAnchor;
     width?: number;
     height?: number;
-    offsetX?: number;
-    offsetY?: number;
 };
 type PanoMapDialogPresentation = {
     mode: "dialog";
-    corner?: PanoMapCorner;
-    offsetX?: number;
-    offsetY?: number;
+    anchor?: PanoOverlayAnchor;
     width?: number;
     height?: number;
 };
-type PanoMapPresentation = PanoMapDockedPresentation | PanoMapDialogPresentation;
+type PanoMapPresentation = PanoMapPanelPresentation | PanoMapDialogPresentation;
 type PanoMapDefinition = {
     image: string;
     /**
@@ -696,4 +708,4 @@ declare function parsePanoProject(value: unknown, options?: {
 }): PanoProjectDefinition;
 declare function loadPanoProject(source: string | PanoProjectDefinition, options?: LoadPanoProjectOptions): Promise<LoadedPanoProject>;
 
-export { type AssetUrlContext, type AssetUrlResolver, type CubemapViewerConfig, type JsonObject, type JsonRequestOptions, type JsonValue, type LoadPanoProjectOptions, type LoadSceneFromJsonOptions, type LoadedPanoProject, type LoadedProjectScene, PanoDataError, type PanoDataErrorCode, type PanoDragMotion, type PanoMapControlsDefinition, type PanoMapCorner, type PanoMapDefinition, type PanoMapDialogPresentation, type PanoMapDockedPresentation, type PanoMapGradientStop, type PanoMapPresentation, type PanoMapSectorDefinition, type PanoMapSectorGradient, type PanoMapSpotDefinition, type PanoProjectDefinition, type PanoProjectSceneDefinition, type PanoViewLimits, type PopupAssetUrlContext, type PopupAssetUrlResolver, type ProjectCustomHotspotAction, type ProjectHotspotAction, type ProjectHotspotDefinition, type ProjectHotspotTrigger, type ProjectPopupBlock, type ProjectPopupDefinition, type SceneFromViewerConfigOptions, type SphereViewerConfig, type ViewerConfig, type ViewerDocument, hotspotAction, loadPanoProject, loadSceneFromJson, parsePanoMap, parsePanoProject, projectHotspotTriggers, resolvePanoMapAssets, resolveHotspotAssets as resolveProjectHotspotAssets, resolveProjectPopupAssets, sceneFromViewerConfig, setHotspotAction };
+export { type AssetUrlContext, type AssetUrlResolver, type CubemapViewerConfig, type JsonObject, type JsonRequestOptions, type JsonValue, type LoadPanoProjectOptions, type LoadSceneFromJsonOptions, type LoadedPanoProject, type LoadedProjectScene, PanoDataError, type PanoDataErrorCode, type PanoDragMotion, type PanoMapControlsDefinition, type PanoMapDefinition, type PanoMapDialogPresentation, type PanoMapGradientStop, type PanoMapPanelPresentation, type PanoMapPresentation, type PanoMapSectorDefinition, type PanoMapSectorGradient, type PanoMapSpotDefinition, type PanoProjectDefinition, type PanoProjectSceneDefinition, type PanoViewLimits, type PopupAssetUrlContext, type PopupAssetUrlResolver, type ProjectCustomHotspotAction, type ProjectHotspotAction, type ProjectHotspotDefinition, type ProjectHotspotTrigger, type ProjectPopupBlock, type ProjectPopupDefinition, type SceneFromViewerConfigOptions, type SphereViewerConfig, type ViewerConfig, type ViewerDocument, hotspotAction, loadPanoProject, loadSceneFromJson, parsePanoMap, parsePanoProject, projectHotspotTriggers, resolvePanoMapAssets, resolveHotspotAssets as resolveProjectHotspotAssets, resolveProjectPopupAssets, sceneFromViewerConfig, setHotspotAction };

package/dist/data.mjs

@@ -809,13 +809,56 @@ function resolveHotspotAssets(hotspot, baseUrl, sceneId, resolver) {
   return result;
 }
 
-// src/data/map.ts
-var CORNERS = /* @__PURE__ */ new Set([
+// src/overlay/align.ts
+var PANO_OVERLAY_ALIGNS = [
+  "top",
+  "bottom",
+  "left",
+  "right",
   "top-left",
   "top-right",
   "bottom-left",
   "bottom-right"
-]);
+];
+var ALIGN_LIST = PANO_OVERLAY_ALIGNS.join(", ");
+function isRecord2(value) {
+  return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function parseInsetLength(value, field) {
+  if (typeof value === "number" && Number.isFinite(value)) return value;
+  if (typeof value === "string" && value.trim()) return value;
+  throw new Error(`${field}: expected a finite number or a nonempty string`);
+}
+function parseInset(value, field) {
+  if (typeof value === "number" || typeof value === "string") {
+    return parseInsetLength(value, field);
+  }
+  if (!isRecord2(value)) throw new Error(`${field}: expected a number, string, or object`);
+  const sides = ["top", "right", "bottom", "left"];
+  const inset = {};
+  for (const side of sides) {
+    if (value[side] === void 0) continue;
+    inset[side] = parseInsetLength(value[side], `${field}.${side}`);
+  }
+  return inset;
+}
+function parseOverlayAnchor(value, field) {
+  if (!isRecord2(value)) throw new Error(`${field}: expected an object`);
+  const align = value.align === void 0 ? void 0 : typeof value.align === "string" && PANO_OVERLAY_ALIGNS.includes(value.align) ? value.align : (() => {
+    throw new Error(`${field}.align: expected ${ALIGN_LIST}`);
+  })();
+  const axis = value.axis === void 0 ? void 0 : value.axis === "horizontal" || value.axis === "vertical" ? value.axis : (() => {
+    throw new Error(`${field}.axis: expected "horizontal" or "vertical"`);
+  })();
+  const inset = value.inset === void 0 ? void 0 : parseInset(value.inset, `${field}.inset`);
+  return {
+    ...align === void 0 ? {} : { align },
+    ...axis === void 0 ? {} : { axis },
+    ...inset === void 0 ? {} : { inset }
+  };
+}
+
+// src/data/map.ts
 function optionalNumber(record, key, options = {}) {
   const value = record[key];
   if (value === void 0) return void 0;
@@ -893,25 +936,29 @@ function parseSector(value, field) {
 function parsePresentation(value, field) {
   if (!isRecord(value)) throw new Error(`${field}: expected an object`);
   const mode = value.mode;
-  if (mode !== "docked" && mode !== "dialog")
-    throw new Error(`${field}.mode: expected "docked" or "dialog"`);
-  const cornerValue = value.corner;
-  const corner = cornerValue === void 0 ? void 0 : typeof cornerValue === "string" && CORNERS.has(cornerValue) ? cornerValue : (() => {
-    throw new Error(
-      `${field}.corner: expected top-left, top-right, bottom-left, or bottom-right`
-    );
-  })();
+  if (mode === "docked") {
+    throw new Error(`${field}.mode: "docked" was removed; expected "panel" or "dialog"`);
+  }
+  if (mode !== "panel" && mode !== "dialog") {
+    throw new Error(`${field}.mode: expected "panel" or "dialog"`);
+  }
+  if ("corner" in value) {
+    throw new Error(`${field}.corner: use anchor.align`);
+  }
+  if ("offsetX" in value) {
+    throw new Error(`${field}.offsetX: use anchor.inset`);
+  }
+  if ("offsetY" in value) {
+    throw new Error(`${field}.offsetY: use anchor.inset`);
+  }
+  const anchor = value.anchor === void 0 ? void 0 : parseOverlayAnchor(value.anchor, `${field}.anchor`);
   const width = optionalNumber(value, "width", { exclusiveMin: 0 });
   const height = optionalNumber(value, "height", { exclusiveMin: 0 });
-  const offsetX = optionalNumber(value, "offsetX", { min: 0 });
-  const offsetY = optionalNumber(value, "offsetY", { min: 0 });
   return {
     mode,
-    ...corner === void 0 ? {} : { corner },
+    ...anchor === void 0 ? {} : { anchor },
     ...width === void 0 ? {} : { width },
-    ...height === void 0 ? {} : { height },
-    ...offsetX === void 0 ? {} : { offsetX },
-    ...offsetY === void 0 ? {} : { offsetY }
+    ...height === void 0 ? {} : { height }
   };
 }
 function parseOptionalBoolean(value, field) {