worldorbit 2.6.0 → 3.0.0

package/packages/markdown/dist/html.js

@@ -1,11 +1,17 @@
-import { loadWorldOrbitSource, renderDocumentToScene, } from "@worldorbit/core";
+import { loadWorldOrbitSource, renderDocumentToScene, renderDocumentToSpatialScene, } from "@worldorbit/core";
 import { createEmbedPayload, createWorldOrbitEmbedMarkup, renderSceneToSvg, } from "@worldorbit/viewer";
 export function renderWorldOrbitBlock(source, options = {}) {
     try {
         const loaded = loadWorldOrbitSource(source);
         const scene = renderDocumentToScene(loaded.document, resolveSourceRenderOptions(loaded, options));
-        if ((options.mode ?? "static") === "interactive") {
-            return createWorldOrbitEmbedMarkup(createEmbedPayload(scene, "interactive", {
+        const mode = options.mode ?? "static";
+        if (mode === "interactive" || mode === "interactive-2d" || mode === "interactive-3d") {
+            const normalizedMode = mode === "interactive" ? "interactive-2d" : mode;
+            return createWorldOrbitEmbedMarkup(createEmbedPayload(scene, normalizedMode, {
+                spatialScene: normalizedMode === "interactive-3d"
+                    ? renderDocumentToSpatialScene(loaded.document, resolveSourceRenderOptions(loaded, options))
+                    : undefined,
+                viewMode: normalizedMode === "interactive-3d" ? "3d" : "2d",
                 initialViewpointId: options.initialViewpointId,
                 initialSelectionObjectId: options.initialSelectionObjectId,
                 initialFilter: options.initialFilter ?? null,
@@ -17,6 +23,7 @@ export function renderWorldOrbitBlock(source, options = {}) {
                 layers: options.layers,
                 subtitle: options.subtitle,
                 preset: options.preset,
+                viewMode: normalizedMode === "interactive-3d" ? "3d" : "2d",
                 initialViewpointId: options.initialViewpointId,
                 initialSelectionObjectId: options.initialSelectionObjectId,
                 initialFilter: options.initialFilter ?? null,

package/packages/viewer/dist/atlas-state.js

@@ -73,6 +73,7 @@ export function createAtlasStateSnapshot(viewerState, renderOptions, filter, vie
             layers: renderOptions.layers ? { ...renderOptions.layers } : undefined,
             scaleModel: renderOptions.scaleModel ? { ...renderOptions.scaleModel } : undefined,
             activeEventId: renderOptions.activeEventId ?? null,
+            viewMode: renderOptions.viewMode ?? "2d",
         },
         filter: normalizeViewerFilter(filter),
     };
@@ -102,6 +103,7 @@ export function deserializeViewerAtlasState(serialized) {
                 ? { ...raw.renderOptions.scaleModel }
                 : undefined,
             activeEventId: raw.activeEventId ?? raw.renderOptions?.activeEventId ?? null,
+            viewMode: raw.renderOptions?.viewMode ?? "2d",
         },
         filter: normalizeViewerFilter(raw.filter ?? null),
     };
@@ -125,6 +127,7 @@ export function createViewerBookmark(name, label, atlasState) {
                     ? { ...atlasState.renderOptions.scaleModel }
                     : undefined,
                 activeEventId: atlasState.renderOptions.activeEventId ?? null,
+                viewMode: atlasState.renderOptions.viewMode ?? "2d",
             },
             filter: atlasState.filter ? { ...atlasState.filter } : null,
         },

package/packages/viewer/dist/atlas-viewer.js

@@ -480,6 +480,7 @@ function cloneBookmark(bookmark) {
                 scaleModel: bookmark.atlasState.renderOptions.scaleModel
                     ? { ...bookmark.atlasState.renderOptions.scaleModel }
                     : undefined,
+                viewMode: bookmark.atlasState.renderOptions.viewMode ?? "2d",
             },
             filter: bookmark.atlasState.filter ? { ...bookmark.atlasState.filter } : null,
         },

package/packages/viewer/dist/custom-element.js

@@ -1,4 +1,6 @@
 import { loadWorldOrbitSource, renderDocumentToScene, } from "@worldorbit/core";
+import { WorldOrbit3DUnavailableError } from "./errors.js";
+import { render3DUnavailableMarkup } from "./embed.js";
 import { renderSceneToSvg } from "./render.js";
 import { createAtlasViewer } from "./atlas-viewer.js";
 import { createInteractiveViewer } from "./viewer.js";
@@ -51,10 +53,22 @@ export function defineWorldOrbitViewerElement(tagName = "worldorbit-viewer") {
                 });
                 return;
             }
-            this.viewer = createInteractiveViewer(this, {
-                scene,
-                theme,
-            });
+            try {
+                this.viewer = createInteractiveViewer(this, {
+                    source,
+                    theme,
+                    viewMode: mode === "interactive-3d"
+                        ? "3d"
+                        : "2d",
+                });
+            }
+            catch (error) {
+                if (error instanceof WorldOrbit3DUnavailableError && mode === "interactive-3d") {
+                    this.innerHTML = render3DUnavailableMarkup(error.message);
+                    return;
+                }
+                throw error;
+            }
         }
     }
     customElements.define(tagName, WorldOrbitViewerElement);

package/packages/viewer/dist/embed.d.ts

@@ -1,8 +1,10 @@
-import type { RenderScene } from "@worldorbit/core";
+import type { RenderScene, SpatialScene } from "@worldorbit/core";
 import type { MountedWorldOrbitEmbeds, MountWorldOrbitEmbedsOptions, ViewerAtlasState, ViewerFilter, WorldOrbitEmbedPayload } from "./types.js";
 export declare function serializeWorldOrbitEmbedPayload(payload: WorldOrbitEmbedPayload): string;
 export declare function deserializeWorldOrbitEmbedPayload(serialized: string): WorldOrbitEmbedPayload;
 export declare function createEmbedPayload(scene: RenderScene, mode: WorldOrbitEmbedPayload["mode"], options?: {
+    spatialScene?: SpatialScene;
+    viewMode?: "2d" | "3d";
     initialViewpointId?: string;
     initialSelectionObjectId?: string;
     initialFilter?: ViewerFilter | null;
@@ -11,6 +13,7 @@ export declare function createEmbedPayload(scene: RenderScene, mode: WorldOrbitE
 }): WorldOrbitEmbedPayload;
 export declare function createWorldOrbitEmbedMarkup(payload: WorldOrbitEmbedPayload, options?: Pick<MountWorldOrbitEmbedsOptions, "theme" | "layers" | "subtitle" | "preset"> & {
     className?: string;
+    viewMode?: "2d" | "3d";
     initialViewpointId?: string;
     initialSelectionObjectId?: string;
     initialFilter?: ViewerFilter | null;
@@ -18,3 +21,4 @@ export declare function createWorldOrbitEmbedMarkup(payload: WorldOrbitEmbedPayl
     minimap?: boolean;
 }): string;
 export declare function mountWorldOrbitEmbeds(root?: ParentNode, options?: MountWorldOrbitEmbedsOptions): MountedWorldOrbitEmbeds;
+export declare function render3DUnavailableMarkup(message: string): string;

package/packages/viewer/dist/embed.js

@@ -1,3 +1,4 @@
+import { WorldOrbit3DUnavailableError } from "./errors.js";
 import { renderSceneToSvg } from "./render.js";
 import { createInteractiveViewer } from "./viewer.js";
 const EMBED_SELECTOR = "[data-worldorbit-embed]";
@@ -8,11 +9,13 @@ export function deserializeWorldOrbitEmbedPayload(serialized) {
     const raw = JSON.parse(decodeURIComponent(serialized));
     return {
         version: "2.0",
-        mode: raw.mode ?? "interactive",
+        mode: normalizeEmbedMode(raw.mode),
         scene: raw.scene,
+        spatialScene: raw.spatialScene ?? undefined,
         options: raw.options
             ? {
                 ...raw.options,
+                viewMode: raw.options.viewMode ?? embedModeToViewMode(normalizeEmbedMode(raw.mode)),
                 initialFilter: raw.options.initialFilter ?? null,
                 atlasState: raw.options.atlasState ?? null,
             }
@@ -22,9 +25,11 @@ export function deserializeWorldOrbitEmbedPayload(serialized) {
 export function createEmbedPayload(scene, mode, options = {}) {
     return {
         version: "2.0",
-        mode,
+        mode: normalizeEmbedMode(mode),
         scene,
+        spatialScene: options.spatialScene,
         options: {
+            viewMode: options.viewMode ?? embedModeToViewMode(normalizeEmbedMode(mode)),
             initialViewpointId: options.initialViewpointId,
             initialSelectionObjectId: options.initialSelectionObjectId,
             initialFilter: options.initialFilter ?? null,
@@ -42,6 +47,7 @@ export function createWorldOrbitEmbedMarkup(payload, options = {}) {
             layers: options.layers ?? payload.options?.layers,
             subtitle: options.subtitle ?? payload.options?.subtitle,
             preset: options.preset ?? payload.options?.preset,
+            viewMode: options.viewMode ?? payload.options?.viewMode ?? embedModeToViewMode(normalizeEmbedMode(payload.mode)),
             initialViewpointId: options.initialViewpointId ?? payload.options?.initialViewpointId,
             initialSelectionObjectId: options.initialSelectionObjectId ?? payload.options?.initialSelectionObjectId,
             initialFilter: options.initialFilter ?? payload.options?.initialFilter ?? null,
@@ -57,14 +63,14 @@ export function createWorldOrbitEmbedMarkup(payload, options = {}) {
         subtitle: mergedPayload.options?.subtitle,
         preset: mergedPayload.options?.preset,
     });
-    return `<div class="${escapeAttribute(options.className ?? "worldorbit-embed")}" data-worldorbit-embed="true" data-worldorbit-mode="${payload.mode}" data-worldorbit-preset="${escapeAttribute(mergedPayload.options?.preset ?? payload.scene.renderPreset ?? "custom")}" data-worldorbit-viewpoint="${escapeAttribute(mergedPayload.options?.initialViewpointId ?? "")}" data-worldorbit-payload="${escapeAttribute(serializeWorldOrbitEmbedPayload(mergedPayload))}">${html}</div>`;
+    return `<div class="${escapeAttribute(options.className ?? "worldorbit-embed")}" data-worldorbit-embed="true" data-worldorbit-mode="${mergedPayload.mode}" data-worldorbit-preset="${escapeAttribute(mergedPayload.options?.preset ?? payload.scene.renderPreset ?? "custom")}" data-worldorbit-viewpoint="${escapeAttribute(mergedPayload.options?.initialViewpointId ?? "")}" data-worldorbit-payload="${escapeAttribute(serializeWorldOrbitEmbedPayload(mergedPayload))}">${html}</div>`;
 }
 export function mountWorldOrbitEmbeds(root = document, options = {}) {
     const viewers = new Map();
     const elements = [...root.querySelectorAll(EMBED_SELECTOR)];
     for (const element of elements) {
         const payload = deserializePayloadFromElement(element);
-        const mode = options.mode ?? payload.mode;
+        const mode = normalizeEmbedMode(options.mode ?? payload.mode);
         const theme = options.theme ?? payload.options?.theme;
         const layers = options.layers ?? payload.options?.layers;
         const subtitle = options.subtitle ?? payload.options?.subtitle;
@@ -73,27 +79,43 @@ export function mountWorldOrbitEmbeds(root = document, options = {}) {
         const initialViewpointId = options.viewer?.initialViewpointId ?? payload.options?.initialViewpointId;
         const initialSelectionObjectId = options.viewer?.initialSelectionObjectId ?? payload.options?.initialSelectionObjectId;
         const minimap = options.viewer?.minimap ?? payload.options?.minimap;
-        if (mode === "interactive") {
-            const viewer = createInteractiveViewer(element, {
-                ...options.viewer,
-                scene: payload.scene,
-                width: options.width ?? payload.scene.width,
-                height: options.height ?? payload.scene.height,
-                padding: options.padding ?? payload.scene.padding,
-                preset,
-                theme,
-                layers,
-                subtitle,
-                initialFilter,
-                initialViewpointId,
-                initialSelectionObjectId,
-                minimap,
-            });
-            if (payload.options?.atlasState) {
-                viewer.setAtlasState(payload.options.atlasState);
+        const viewMode = options.viewer?.viewMode ??
+            payload.options?.viewMode ??
+            embedModeToViewMode(mode);
+        if (mode === "interactive-2d" || mode === "interactive-3d") {
+            try {
+                const viewer = createInteractiveViewer(element, {
+                    ...options.viewer,
+                    scene: payload.scene,
+                    spatialScene: payload.spatialScene,
+                    width: options.width ?? payload.scene.width,
+                    height: options.height ?? payload.scene.height,
+                    padding: options.padding ?? payload.scene.padding,
+                    preset,
+                    theme,
+                    layers,
+                    subtitle,
+                    viewMode,
+                    initialFilter,
+                    initialViewpointId,
+                    initialSelectionObjectId,
+                    minimap,
+                });
+                if (payload.options?.atlasState) {
+                    viewer.setAtlasState(payload.options.atlasState);
+                }
+                viewers.set(element, viewer);
+                options.onMount?.(viewer, element);
+            }
+            catch (error) {
+                if (error instanceof WorldOrbit3DUnavailableError && mode === "interactive-3d") {
+                    element.innerHTML = render3DUnavailableMarkup(error.message);
+                    options.onMount?.(null, element);
+                }
+                else {
+                    throw error;
+                }
             }
-            viewers.set(element, viewer);
-            options.onMount?.(viewer, element);
         }
         else {
             element.innerHTML = renderSceneToSvg(payload.scene, {
@@ -136,3 +158,15 @@ function escapeAttribute(value) {
         .replaceAll(">", "&gt;")
         .replaceAll("\"", "&quot;");
 }
+function normalizeEmbedMode(mode) {
+    if (!mode || mode === "interactive") {
+        return "interactive-2d";
+    }
+    return mode;
+}
+function embedModeToViewMode(mode) {
+    return mode === "interactive-3d" ? "3d" : "2d";
+}
+export function render3DUnavailableMarkup(message) {
+    return `<div class="worldorbit-embed-unavailable" data-worldorbit-3d-unavailable="true"><strong>3D unavailable</strong><span>${escapeAttribute(message)}</span></div>`;
+}

package/packages/viewer/dist/errors.d.ts

@@ -0,0 +1,6 @@
+export declare class WorldOrbitViewerError extends Error {
+    constructor(message: string);
+}
+export declare class WorldOrbit3DUnavailableError extends WorldOrbitViewerError {
+    constructor(message?: string);
+}

package/packages/viewer/dist/errors.js

@@ -0,0 +1,12 @@
+export class WorldOrbitViewerError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = "WorldOrbitViewerError";
+    }
+}
+export class WorldOrbit3DUnavailableError extends WorldOrbitViewerError {
+    constructor(message = "WorldOrbit 3D is unavailable in this environment.") {
+        super(message);
+        this.name = "WorldOrbit3DUnavailableError";
+    }
+}

package/packages/viewer/dist/index.d.ts

@@ -1,4 +1,5 @@
 export type * from "./types.js";
+export { WorldOrbit3DUnavailableError, WorldOrbitViewerError } from "./errors.js";
 export { getThemePreset, resolveLayers, resolveTheme } from "./theme.js";
 export { deserializeViewerAtlasState, normalizeViewerFilter, sceneViewpointToLayerOptions, searchSceneObjects, serializeViewerAtlasState, viewpointToViewerFilter, } from "./atlas-state.js";
 export { DEFAULT_VIEWER_STATE, clampScale, composeViewerTransform, fitViewerState, focusViewerState, getViewerVisibleBounds, invertViewerPoint, getSceneCenter, normalizeRotation, panViewerState, rotateViewerState, zoomViewerStateAt, } from "./viewer-state.js";

package/packages/viewer/dist/index.js

@@ -1,3 +1,4 @@
+export { WorldOrbit3DUnavailableError, WorldOrbitViewerError } from "./errors.js";
 export { getThemePreset, resolveLayers, resolveTheme } from "./theme.js";
 export { deserializeViewerAtlasState, normalizeViewerFilter, sceneViewpointToLayerOptions, searchSceneObjects, serializeViewerAtlasState, viewpointToViewerFilter, } from "./atlas-state.js";
 export { DEFAULT_VIEWER_STATE, clampScale, composeViewerTransform, fitViewerState, focusViewerState, getViewerVisibleBounds, invertViewerPoint, getSceneCenter, normalizeRotation, panViewerState, rotateViewerState, zoomViewerStateAt, } from "./viewer-state.js";

package/packages/viewer/dist/runtime-3d.d.ts

@@ -0,0 +1,19 @@
+import { type CoordinatePoint, type SpatialScene } from "@worldorbit/core";
+import type { ViewerRenderOptions, ViewerState } from "./types.js";
+interface Viewer3DRuntimeUpdate {
+    spatialScene: SpatialScene;
+    renderOptions: ViewerRenderOptions;
+    visibleObjectIds: Set<string>;
+    selectedObjectId: string | null;
+    hoveredObjectId: string | null;
+    state: ViewerState;
+    timeSeconds: number;
+}
+export interface Viewer3DRuntime {
+    update(next: Viewer3DRuntimeUpdate): void;
+    hitTest(clientX: number, clientY: number): string | null;
+    projectObjectToContainer(objectId: string): CoordinatePoint | null;
+    destroy(): void;
+}
+export declare function createViewer3DRuntime(container: HTMLElement): Viewer3DRuntime;
+export {};