@itwin/saved-views-react 0.5.0 → 0.7.0

package/lib/captureSavedViewData.js

@@ -1,25 +1,59 @@
 import { QueryRowFormat } from "@itwin/core-common";
+import { extensionHandlers } from "./translation/SavedViewsExtensionHandlers.js";
 import { extractClipVectorsFromLegacy } from "./translation/clipVectorsLegacyExtractor.js";
 import { extractDisplayStyle2dFromLegacy, extractDisplayStyle3dFromLegacy, } from "./translation/displayStyleExtractor.js";
+/**
+ * Captures current {@link Viewport} state into serializable format. The returned
+ * data can later be used to restore viewport's view.
+ *
+ * @example
+ * import { captureSavedViewData, captureSavedViewThumbnail } from "@itwin/saved-views-react";
+ *
+ * async function saveViewport(viewport) {
+ *   const { viewData, extensions = [] } = await captureSavedViewData({ viewport });
+ *   const myExtensions = captureMyCustomViewportState(viewport);
+ *   const thumbnail = captureSavedViewThumbnail(viewport);
+ *   return { thumbnail, viewData, extensions: extensions.concat(myExtensions) };
+ * }
+ */
 export async function captureSavedViewData(args) {
-    const hiddenCategoriesPromise = getMissingCategories(args.viewport.iModel, new Set(args.viewport.view.categorySelector.toJSON().categories));
-    if (args.viewport.view.isSpatialView()) {
+    const extensions = [];
+    if (!args.omitEmphasis) {
+        extensions.push(extensionHandlers.emphasizeElements);
+    }
+    if (!args.omitPerModelCategoryVisibility) {
+        extensions.push(extensionHandlers.perModelCategoryVisibility);
+    }
+    return {
+        viewData: await createSavedViewVariant(args.viewport),
+        extensions: extensions
+            .map((extension) => ({
+            extensionName: extension.extensionName,
+            data: extension.capture(args.viewport),
+        }))
+            .filter(({ data }) => data !== undefined),
+    };
+}
+async function createSavedViewVariant(viewport) {
+    const hiddenCategoriesPromise = queryMissingCategories(viewport.iModel, new Set(viewport.view.categorySelector.toJSON().categories));
+    if (viewport.view.isSpatialView()) {
         const [hiddenCategories, hiddenModels] = await Promise.all([
             hiddenCategoriesPromise,
-            getMissingModels(args.viewport.iModel, new Set(args.viewport.view.modelSelector.toJSON().models)),
+            queryMissingModels(viewport.iModel, new Set(viewport.view.modelSelector.toJSON().models)),
         ]);
-        return createSpatialSavedViewObject(args.viewport, hiddenCategories, hiddenModels);
+        return createSpatialSavedViewObject(viewport, hiddenCategories, hiddenModels);
     }
-    if (args.viewport.view.isDrawingView()) {
-        return createDrawingSavedViewObject(args.viewport, await hiddenCategoriesPromise);
+    if (viewport.view.isDrawingView()) {
+        return createDrawingSavedViewObject(viewport, await hiddenCategoriesPromise);
     }
-    return createSheetSavedViewObject(args.viewport, await hiddenCategoriesPromise);
+    return createSheetSavedViewObject(viewport, await hiddenCategoriesPromise);
 }
 function createSpatialSavedViewObject(vp, hiddenCategories, hiddenModels) {
     const viewState = vp.view;
     const displayStyleProps = viewState.displayStyle.toJSON();
     // Clear the timePoint if no schedule script is available on the viewState
-    if (viewState.is3d() && displayStyleProps.jsonProperties?.styles?.timePoint && !viewState.displayStyle.scheduleScript) {
+    if (viewState.is3d() && displayStyleProps.jsonProperties?.styles?.timePoint &&
+        !viewState.displayStyle.scheduleScript) {
         displayStyleProps.jsonProperties.styles.timePoint = undefined;
     }
     // Omit the schedule script - may cause excessively large JSON.
@@ -28,26 +62,25 @@ function createSpatialSavedViewObject(vp, hiddenCategories, hiddenModels) {
     }
     const viewDefinitionProps = viewState.toJSON();
     return {
-        itwin3dView: {
-            origin: toArrayVector3d(viewDefinitionProps.origin),
-            extents: toArrayVector3d(viewDefinitionProps.extents),
-            angles: viewDefinitionProps.angles && toYawPitchRoll(viewDefinitionProps.angles),
-            camera: viewDefinitionProps.cameraOn ? {
-                lens: toDegrees(viewDefinitionProps.camera.lens) ?? 0,
-                focusDist: viewDefinitionProps.camera.focusDist,
-                eye: toArrayVector3d(viewDefinitionProps.camera.eye),
-            } : undefined,
-            categories: {
-                enabled: viewState.categorySelector.toJSON().categories,
-                disabled: hiddenCategories,
-            },
-            models: {
-                enabled: viewState.modelSelector.toJSON().models,
-                disabled: hiddenModels,
-            },
-            displayStyle: extractDisplayStyle3dFromLegacy(displayStyleProps),
-            clipVectors: extractClipVectorsFromLegacy(viewDefinitionProps),
+        type: "iTwin3d",
+        origin: toArrayVector3d(viewDefinitionProps.origin),
+        extents: toArrayVector3d(viewDefinitionProps.extents),
+        angles: viewDefinitionProps.angles && toYawPitchRoll(viewDefinitionProps.angles),
+        camera: viewDefinitionProps.cameraOn ? {
+            lens: toDegrees(viewDefinitionProps.camera.lens) ?? 0,
+            focusDist: viewDefinitionProps.camera.focusDist,
+            eye: toArrayVector3d(viewDefinitionProps.camera.eye),
+        } : undefined,
+        categories: {
+            enabled: viewState.categorySelector.toJSON().categories,
+            disabled: hiddenCategories,
+        },
+        models: {
+            enabled: viewState.modelSelector.toJSON().models,
+            disabled: hiddenModels,
         },
+        displayStyle: extractDisplayStyle3dFromLegacy(displayStyleProps),
+        clipVectors: extractClipVectorsFromLegacy(viewDefinitionProps),
     };
 }
 function toArrayVector3d(xyzProps) {
@@ -67,17 +100,16 @@ function createDrawingSavedViewObject(vp, hiddenCategories) {
     const viewState = vp.view;
     const viewDefinitionProps = viewState.toJSON();
     return {
-        itwinDrawingView: {
-            modelExtents: {},
-            baseModelId: viewDefinitionProps.baseModelId,
-            origin: toArrayVector2d(viewDefinitionProps.origin),
-            delta: toArrayVector2d(viewDefinitionProps.delta),
-            angle: toDegrees(viewDefinitionProps.angle) ?? 0,
-            displayStyle: extractDisplayStyle2dFromLegacy(viewState.displayStyle.toJSON()),
-            categories: {
-                enabled: viewState.categorySelector.toJSON().categories,
-                disabled: hiddenCategories,
-            },
+        type: "iTwinDrawing",
+        modelExtents: {},
+        baseModelId: viewDefinitionProps.baseModelId,
+        origin: toArrayVector2d(viewDefinitionProps.origin),
+        delta: toArrayVector2d(viewDefinitionProps.delta),
+        angle: toDegrees(viewDefinitionProps.angle) ?? 0,
+        displayStyle: extractDisplayStyle2dFromLegacy(viewState.displayStyle.toJSON()),
+        categories: {
+            enabled: viewState.categorySelector.toJSON().categories,
+            disabled: hiddenCategories,
         },
     };
 }
@@ -85,20 +117,19 @@ function createSheetSavedViewObject(vp, hiddenCategories) {
     const viewState = vp.view;
     const viewDefinitionProps = viewState.toJSON();
     return {
-        itwinSheetView: {
-            baseModelId: viewDefinitionProps.baseModelId,
-            origin: toArrayVector2d(viewDefinitionProps.origin),
-            delta: toArrayVector2d(viewDefinitionProps.delta),
-            angle: toDegrees(viewDefinitionProps.angle) ?? 0,
-            displayStyle: extractDisplayStyle2dFromLegacy(viewState.displayStyle.toJSON()),
-            categories: {
-                enabled: viewState.categorySelector.toJSON().categories,
-                disabled: hiddenCategories,
-            },
-            width: viewState.sheetSize.x,
-            height: viewState.sheetSize.y,
-            sheetAttachments: viewState.attachmentIds,
+        type: "iTwinSheet",
+        baseModelId: viewDefinitionProps.baseModelId,
+        origin: toArrayVector2d(viewDefinitionProps.origin),
+        delta: toArrayVector2d(viewDefinitionProps.delta),
+        angle: toDegrees(viewDefinitionProps.angle) ?? 0,
+        displayStyle: extractDisplayStyle2dFromLegacy(viewState.displayStyle.toJSON()),
+        categories: {
+            enabled: viewState.categorySelector.toJSON().categories,
+            disabled: hiddenCategories,
         },
+        width: viewState.sheetSize.x,
+        height: viewState.sheetSize.y,
+        sheetAttachments: viewState.attachmentIds,
     };
 }
 function toArrayVector2d(xyzProps) {
@@ -119,28 +150,37 @@ function toDegrees(angle) {
     }
     return undefined;
 }
-export async function getMissingModels(iModel, knownModels) {
-    const allModels = await getAllModels(iModel);
-    return allModels.map(({ id }) => id).filter((model) => !knownModels.has(model));
+export async function queryMissingModels(iModel, knownModels) {
+    if (iModel.isBlank) {
+        return [];
+    }
+    const allModels = await queryAllSpatiallyLocatedModels(iModel);
+    return allModels.filter((modelId) => !knownModels.has(modelId));
 }
-async function getAllModels(iModel) {
-    // Note: IsNotSpatiallyLocated was introduced in a later version of the BisCore ECSchema. If the iModel has an earlier
-    // version, the statement will throw because the property does not exist. If the iModel was created from an earlier
-    // version and later upgraded to a newer version, the property may be NULL for models created prior to the upgrade.
+export async function queryAllSpatiallyLocatedModels(iModel) {
+    // BisCore ECSchema gained IsNotSpatiallyLocated property in 2019, almost exactly
+    // one year after the initial iTwin.js release. The following query will fail to
+    // compile with iModels created in that time frame unless user has performed
+    // schema upgrade which assigned NULL value to the property.
     try {
         return await executeQuery(iModel, "SELECT ECInstanceId FROM Bis.GeometricModel3D WHERE IsPrivate = false AND IsTemplate = false AND (IsNotSpatiallyLocated IS NULL OR IsNotSpatiallyLocated = false)");
     }
     catch {
+        // Above query failed, assume we have an old iModel
         return executeQuery(iModel, "SELECT ECInstanceId FROM Bis.GeometricModel3D WHERE IsPrivate = false AND IsTemplate = false");
     }
 }
-export async function getMissingCategories(iModel, knownCategories) {
-    const allCategories = await getAllCategories(iModel);
-    return allCategories.map(({ id }) => id).filter((category) => !knownCategories.has(category));
+export async function queryMissingCategories(iModel, knownCategories) {
+    if (iModel.isBlank) {
+        return [];
+    }
+    const allCategories = await queryAllCategories(iModel);
+    return allCategories.filter((categoryId) => !knownCategories.has(categoryId));
 }
-async function getAllCategories(iModel) {
+export async function queryAllCategories(iModel) {
     return executeQuery(iModel, "SELECT DISTINCT Category.Id AS id FROM BisCore.GeometricElement3d WHERE Category.Id IN (SELECT ECInstanceId FROM BisCore.SpatialCategory)");
 }
 async function executeQuery(iModel, query) {
-    return iModel.createQueryReader(query, undefined, { rowFormat: QueryRowFormat.UseJsPropertyNames }).toArray();
+    const result = await iModel.createQueryReader(query, undefined, { rowFormat: QueryRowFormat.UseECSqlPropertyIndexes }).toArray();
+    return result.flat();
 }

package/lib/captureSavedViewThumbnail.d.ts

@@ -1,3 +1,10 @@
 import { type Viewport } from "@itwin/core-frontend";
-/** Generates Saved View thumbnail based on what is currently visible in the {@linkcode viewport}. */
+/**
+ * Generates Saved View thumbnail based on what is currently displayed on the {@linkcode viewport}.
+ * @returns base64-encoded URL string, or `undefined` if the thumbnail could not be generated
+ *
+ * @example
+ * const thumbnail = captureSavedViewThumbnail(viewport);
+ * console.log(thumbnail); // "data:image/png;base64,iVBORw0KGoAAAANSUhEUg..."
+ */
 export declare function captureSavedViewThumbnail(viewport: Viewport, width?: number, height?: number): string | undefined;

package/lib/captureSavedViewThumbnail.js

@@ -1,6 +1,13 @@
 import { getCenteredViewRect, imageBufferToCanvas } from "@itwin/core-frontend";
 import { Point2d } from "@itwin/core-geometry";
-/** Generates Saved View thumbnail based on what is currently visible in the {@linkcode viewport}. */
+/**
+ * Generates Saved View thumbnail based on what is currently displayed on the {@linkcode viewport}.
+ * @returns base64-encoded URL string, or `undefined` if the thumbnail could not be generated
+ *
+ * @example
+ * const thumbnail = captureSavedViewThumbnail(viewport);
+ * console.log(thumbnail); // "data:image/png;base64,iVBORw0KGoAAAANSUhEUg..."
+ */
 export function captureSavedViewThumbnail(viewport, width = 280, height = 200) {
     const thumbnail = getThumbnail(viewport, width, height);
     if (!thumbnail) {
@@ -11,15 +18,16 @@ export function captureSavedViewThumbnail(viewport, width = 280, height = 200) {
 }
 function getThumbnail(vp, width, height) {
     const size = new Point2d(width, height);
-    // Passing in vp.target.viewRect instead of vp.viewRect because currently vp.viewRect is not updated correctly in some
-    // cases when a new dialog is created. The bottom property would be 2px higher than the renderRect in readImageBuffer
-    // which caused the method to return undefined. vp.target.viewRect allows us to have the correct dimensions when
-    // creating the thumbnail.
+    // Passing in vp.target.viewRect instead of vp.viewRect because currently vp.viewRect
+    // is not updated correctly in some cases when a new dialog is created. The bottom
+    // property would be 2px higher than the renderRect in readImageBuffer which
+    // caused the method to return undefined. vp.target.viewRect allows us to have
+    // the correct dimensions when creating the thumbnail.
     const thumbnail = vp.readImageBuffer({ rect: getCenteredViewRect(vp.target.viewRect), size });
     if (thumbnail) {
         return thumbnail;
     }
-    // Since using vp.target.viewRect while creating thumbnail returns undefined for some, we switch back to using
-    // vp.viewRect
+    // Since using vp.target.viewRect while creating thumbnail returns undefined
+    // for some, we switch back to using vp.viewRect
     return vp.readImageBuffer({ rect: getCenteredViewRect(vp.viewRect), size });
 }

package/lib/createViewState.d.ts

@@ -1,16 +1,33 @@
 import { type IModelConnection, type ViewState } from "@itwin/core-frontend";
-import { ViewData } from "@itwin/saved-views-client";
+import type { ViewData } from "./SavedView.js";
 export interface ViewStateCreateSettings {
     /**
-     * Normally before {@link createViewState} function returns a {@link ViewState}, its {@linkcode ViewState.load} method
-     * is called and awaited. You may skip this step if you intend to perform it later.
+     * Normally {@link createViewState} function invokes and awaits {@linkcode ViewState.load}
+     * method before returning. You may skip this step if you intend to perform it later.
      * @default false
+     *
+     * @example
+     * const viewState = await createViewState(iModel, savedViewData.viewData, { skipViewStateLoad: true });
+     * viewState.categorySelector.addCategories("<additional_category_id>");
+     * await viewState.load();
      */
     skipViewStateLoad?: boolean | undefined;
     /**
-     * How to handle visibility of models and categories that exist in iModel but are not captured in Saved View data.
+     * How to handle visibility of models and categories that exist in iModel but
+     * not captured in Saved View data.
      * @default "hidden"
      */
     modelAndCategoryVisibilityFallback?: "visible" | "hidden" | undefined;
 }
-export declare function createViewState(iModel: IModelConnection, savedViewData: ViewData, settings?: ViewStateCreateSettings): Promise<ViewState>;
+/**
+ * Creates {@link ViewState} object out of Saved View data. It provides a lower-level
+ * access to view data for advanced use.
+ *
+ * @example
+ * const viewState = await createViewState(iModel, savedViewData.viewData);
+ * await applySavedView(iModel, viewport, savedViewData, { viewState });
+ *
+ * // The two lines above are equivalent to
+ * await applySavedView(iModel, viewport, savedViewData);
+ */
+export declare function createViewState(iModel: IModelConnection, viewData: ViewData, settings?: ViewStateCreateSettings): Promise<ViewState>;

package/lib/createViewState.js

@@ -2,30 +2,40 @@
 * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
 * See LICENSE.md in the project root for license terms and full copyright notice.
 *--------------------------------------------------------------------------------------------*/
-import { Camera, IModelReadRpcInterface, } from "@itwin/core-common";
+import { Camera, } from "@itwin/core-common";
 import { DrawingViewState, SheetViewState, SpatialViewState, } from "@itwin/core-frontend";
-import { isViewDataITwin3d, isViewDataITwinDrawing, isViewDataITwinSheet, } from "@itwin/saved-views-client";
-import { getMissingCategories, getMissingModels } from "./captureSavedViewData.js";
+import { queryMissingCategories, queryMissingModels } from "./captureSavedViewData.js";
 import { extractClipVectors } from "./translation/clipVectorsExtractor.js";
 import { extractDisplayStyle, extractDisplayStyle3d } from "./translation/displayStyleExtractor.js";
-export async function createViewState(iModel, savedViewData, settings = {}) {
-    const viewState = await createViewStateVariant(iModel, savedViewData);
+/**
+ * Creates {@link ViewState} object out of Saved View data. It provides a lower-level
+ * access to view data for advanced use.
+ *
+ * @example
+ * const viewState = await createViewState(iModel, savedViewData.viewData);
+ * await applySavedView(iModel, viewport, savedViewData, { viewState });
+ *
+ * // The two lines above are equivalent to
+ * await applySavedView(iModel, viewport, savedViewData);
+ */
+export async function createViewState(iModel, viewData, settings = {}) {
+    const viewState = await createViewStateVariant(iModel, viewData);
     if (settings.modelAndCategoryVisibilityFallback === "visible") {
-        await unhideNewModelsAndCategories(iModel, viewState, savedViewData);
+        await unhideNewModelsAndCategories(iModel, viewState, viewData);
     }
     if (!settings.skipViewStateLoad) {
         await viewState.load();
     }
     return viewState;
 }
-async function createViewStateVariant(iModel, savedViewData) {
-    if (isViewDataITwinDrawing(savedViewData)) {
-        return createDrawingViewState(iModel, savedViewData.itwinDrawingView);
+async function createViewStateVariant(iModel, viewData) {
+    if (viewData.type === "iTwinDrawing") {
+        return createDrawingViewState(iModel, viewData);
     }
-    if (isViewDataITwinSheet(savedViewData)) {
-        return createSheetViewState(iModel, savedViewData.itwinSheetView);
+    if (viewData.type === "iTwinSheet") {
+        return createSheetViewState(iModel, viewData);
     }
-    return createSpatialViewState(iModel, savedViewData.itwin3dView);
+    return createSpatialViewState(iModel, viewData);
 }
 async function createSpatialViewState(iModel, viewData) {
     const seedViewState = await fetchIModelViewData(iModel, SpatialViewState.classFullName);
@@ -202,10 +212,7 @@ function createEmptyViewState(iModel, viewClassName) {
 async function getDefaultViewIdFromClassName(iModel, viewClassName) {
     // Check validity of default view
     const viewId = await iModel.views.queryDefaultViewId();
-    const params = {};
-    params.from = viewClassName;
-    params.where = "ECInstanceId=" + viewId;
-    const viewProps = await IModelReadRpcInterface.getClient().queryElementProps(iModel.getRpcProps(), params);
+    const viewProps = await iModel.elements.queryProps({ from: viewClassName, where: "ECInstanceId=" + viewId });
     if (viewProps.length > 0) {
         return viewId;
     }
@@ -219,29 +226,25 @@ async function getDefaultViewIdFromClassName(iModel, viewClassName) {
 function cloneCode({ spec, scope, value }) {
     return { spec, scope, value };
 }
-async function unhideNewModelsAndCategories(iModel, viewState, savedViewData) {
-    if (isViewDataITwin3d(savedViewData)) {
+async function unhideNewModelsAndCategories(iModel, viewState, viewData) {
+    if (viewData.type === "iTwin3d") {
         if (!viewState.isSpatialView()) {
             return;
         }
-        const viewData = savedViewData.itwin3dView;
         if (!viewData.categories?.disabled || !viewData.models?.disabled) {
             return;
         }
         const [visibleCategories, visibleModels] = await Promise.all([
-            getMissingCategories(iModel, new Set(viewData.categories.disabled)),
-            getMissingModels(iModel, new Set(viewData.models.disabled)),
+            queryMissingCategories(iModel, new Set(viewData.categories.disabled)),
+            queryMissingModels(iModel, new Set(viewData.models.disabled)),
         ]);
         viewState.categorySelector.addCategories(visibleCategories);
         viewState.modelSelector.addModels(visibleModels);
         return;
     }
-    const viewData = isViewDataITwinDrawing(savedViewData)
-        ? savedViewData.itwinDrawingView
-        : savedViewData.itwinSheetView;
     if (!viewData.categories?.disabled) {
         return;
     }
-    const visibleCategories = await getMissingCategories(iModel, new Set(viewData.categories.disabled));
+    const visibleCategories = await queryMissingCategories(iModel, new Set(viewData.categories.disabled));
     viewState.categorySelector.addCategories(visibleCategories);
 }

package/lib/index.d.ts

@@ -1,16 +1,16 @@
+export { applySavedView, type ApplySavedViewSettings } from "./applySavedView.js";
+export { captureSavedViewData } from "./captureSavedViewData.js";
+export { captureSavedViewThumbnail } from "./captureSavedViewThumbnail.js";
+export { createViewState, type ViewStateCreateSettings } from "./createViewState.js";
 export { LayeredDropdownMenu, LayeredMenuItem } from "./LayeredDropdownMenu/LayeredDropdownMenu.js";
-export type { SavedView, SavedViewGroup, SavedViewTag } from "./SavedView.js";
+export { defaultLocalization, type LocalizationStrings } from "./localization.js";
+export type { ITwin3dViewData, ITwinDrawingdata, ITwinSheetData, SavedView, SavedViewData, SavedViewGroup, SavedViewTag, ViewData, } from "./SavedView.js";
+export { ITwinSavedViewsClient } from "./SavedViewsClient/ITwinSavedViewsClient.js";
+export type { CreateGroupArgs, CreateSavedViewArgs, CreateTagArgs, DeleteGroupArgs, DeleteSavedViewArgs, DeleteTagArgs, GetGroupsArgs, GetSavedViewByIdArgs, GetSavedViewsArgs, GetTagsArgs, GetThumbnailUrlArgs, SavedViewsClient, UpdateGroupArgs, UpdateSavedViewArgs, UpdateTagArgs, UploadThumbnailArgs, } from "./SavedViewsClient/SavedViewsClient.js";
+export { SavedViewsContextProvider, type SavedViewsContext } from "./SavedViewsContext.js";
 export { SavedViewOptions } from "./SavedViewTile/SavedViewOptions.js";
 export { SavedViewTile } from "./SavedViewTile/SavedViewTile.js";
 export { useSavedViewTileContext, type SavedViewTileContext } from "./SavedViewTile/SavedViewTileContext.js";
-export { ITwinSavedViewsClient } from "./SavedViewsClient/ITwinSavedViewsClient.js";
-export type { CreateGroupParams, CreateSavedViewParams, CreateTagParams, DeleteGroupParams, DeleteSavedViewParams, DeleteTagParams, GetSavedViewInfoParams, GetSingularSavedViewParams, GetThumbnailUrlParams, SavedViewInfo, SavedViewsClient, UpdateGroupParams, UpdateSavedViewParams, UpdateTagParams, UploadThumbnailParams, } from "./SavedViewsClient/SavedViewsClient.js";
-export { SavedViewsContextProvider, type SavedViewsContext } from "./SavedViewsContext.js";
 export { StickyExpandableBlock } from "./StickyExpandableBlock/StickyExpandableBlock.js";
 export { TileGrid } from "./TileGrid/TileGrid.js";
-export { applySavedView, type ApplySavedViewSettings } from "./applySavedView.js";
-export { captureSavedViewData } from "./captureSavedViewData.js";
-export { captureSavedViewThumbnail } from "./captureSavedViewThumbnail.js";
-export { createViewState, type ViewStateCreateSettings } from "./createViewState.js";
-export { defaultLocalization, type LocalizationStrings } from "./localization.js";
-export { useSavedViews, type SavedViewActions } from "./useSavedViews.js";
+export { useSavedViews, type SavedViewsActions } from "./useSavedViews.js";

package/lib/index.js

@@ -2,17 +2,17 @@
 * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
 * See LICENSE.md in the project root for license terms and full copyright notice.
 *--------------------------------------------------------------------------------------------*/
+export { applySavedView } from "./applySavedView.js";
+export { captureSavedViewData } from "./captureSavedViewData.js";
+export { captureSavedViewThumbnail } from "./captureSavedViewThumbnail.js";
+export { createViewState } from "./createViewState.js";
 export { LayeredDropdownMenu, LayeredMenuItem } from "./LayeredDropdownMenu/LayeredDropdownMenu.js";
+export { defaultLocalization } from "./localization.js";
+export { ITwinSavedViewsClient } from "./SavedViewsClient/ITwinSavedViewsClient.js";
+export { SavedViewsContextProvider } from "./SavedViewsContext.js";
 export { SavedViewOptions } from "./SavedViewTile/SavedViewOptions.js";
 export { SavedViewTile } from "./SavedViewTile/SavedViewTile.js";
 export { useSavedViewTileContext } from "./SavedViewTile/SavedViewTileContext.js";
-export { ITwinSavedViewsClient } from "./SavedViewsClient/ITwinSavedViewsClient.js";
-export { SavedViewsContextProvider } from "./SavedViewsContext.js";
 export { StickyExpandableBlock } from "./StickyExpandableBlock/StickyExpandableBlock.js";
 export { TileGrid } from "./TileGrid/TileGrid.js";
-export { applySavedView } from "./applySavedView.js";
-export { captureSavedViewData } from "./captureSavedViewData.js";
-export { captureSavedViewThumbnail } from "./captureSavedViewThumbnail.js";
-export { createViewState } from "./createViewState.js";
-export { defaultLocalization } from "./localization.js";
 export { useSavedViews } from "./useSavedViews.js";

package/lib/translation/SavedViewTypes.d.ts

@@ -4,7 +4,6 @@ import type { Range3dProps } from "@itwin/core-geometry";
 export interface LegacySavedView3d extends LegacySavedViewBase {
     displayStyleProps: DisplayStyle3dProps;
     modelSelectorProps: ModelSelectorProps;
-    modelExtents?: Range3dProps;
     viewDefinitionProps: SpatialViewDefinitionProps;
     perModelCategoryVisibility?: PerModelCategoryVisibilityProps[];
     hiddenModels?: Id64Array;
@@ -20,6 +19,7 @@ export interface LegacySavedView2d extends LegacySavedViewBase {
     sectionDrawing?: SectionDrawingViewProps;
     sheetProps?: SheetProps;
     sheetAttachments?: Id64Array;
+    modelExtents?: Range3dProps;
 }
 export interface LegacySavedViewBase {
     id: string;

package/lib/translation/SavedViewsExtensionHandlers.d.ts

@@ -3,16 +3,19 @@ export interface ExtensionHandler {
     extensionName: string;
     apply: (extensionData: string, viewport: Viewport) => void;
     reset: (viewport: Viewport) => void;
+    capture: (viewport: Viewport) => string | undefined;
 }
 export declare const extensionHandlers: {
     emphasizeElements: {
         extensionName: string;
         apply: (extensionData: string, viewport: Viewport) => void;
         reset: (viewport: Viewport) => void;
+        capture: (viewport: Viewport) => string | undefined;
     };
     perModelCategoryVisibility: {
         extensionName: string;
         apply: (extensionData: string, viewport: Viewport) => void;
         reset: (viewport: Viewport) => void;
+        capture: (viewport: Viewport) => string | undefined;
     };
 };

package/lib/translation/SavedViewsExtensionHandlers.js

@@ -21,6 +21,10 @@ export const extensionHandlers = {
                 viewport.isFadeOutActive = false;
             }
         },
+        capture: (viewport) => {
+            const emphasizeElementsProps = EmphasizeElements.get(viewport)?.toJSON(viewport);
+            return emphasizeElementsProps ? JSON.stringify({ emphasizeElementsProps }) : undefined;
+        },
     },
     perModelCategoryVisibility: {
         extensionName: "PerModelCategoryVisibility",
@@ -35,5 +39,15 @@ export const extensionHandlers = {
         reset: (viewport) => {
             viewport.perModelCategoryVisibility.clearOverrides();
         },
+        capture: (viewport) => {
+            if (!viewport.view.isSpatialView()) {
+                return undefined;
+            }
+            const props = [];
+            for (const { modelId, categoryId, visible } of viewport.perModelCategoryVisibility) {
+                props.push({ modelId, categoryId, visible });
+            }
+            return props.length > 0 ? JSON.stringify({ perModelCategoryVisibilityProps: props }) : undefined;
+        },
     },
 };

package/lib/translation/clipVectorsLegacyExtractor.js

@@ -6,6 +6,10 @@ export function extractClipVectorsFromLegacy(input) {
     }
     const output = {};
     applyExtraction(viewDetails, output, clipVectorLegacyMappings);
+    output.clipVectors = output.clipVectors?.filter((value) => {
+        const hasPlanes = "planes" in value;
+        return (!hasPlanes || (value.planes && Object.keys(value.planes).length > 0));
+    });
     return output.clipVectors;
 }
 const clipPlaneLegacyMappings = [