@itwin/saved-views-react 0.4.1 → 0.6.0

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
+ *
+ * @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
+ *
+ * @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) {

package/lib/createViewState.d.ts

@@ -1,3 +1,32 @@
 import { type IModelConnection, type ViewState } from "@itwin/core-frontend";
-import { type SavedViewRepresentation } from "@itwin/saved-views-client";
-export declare function createViewState(iModel: IModelConnection, savedViewRsp: SavedViewRepresentation, useHiddenModelsAndCategories?: boolean): Promise<ViewState | undefined>;
+import { ViewData } from "@itwin/saved-views-client";
+export interface ViewStateCreateSettings {
+    /**
+     * 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, savedView.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.
+     * @default "hidden"
+     */
+    modelAndCategoryVisibilityFallback?: "visible" | "hidden" | undefined;
+}
+/**
+ * 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

@@ -8,22 +8,35 @@ import { isViewDataITwin3d, isViewDataITwinDrawing, isViewDataITwinSheet, } from
 import { getMissingCategories, getMissingModels } from "./captureSavedViewData.js";
 import { extractClipVectors } from "./translation/clipVectorsExtractor.js";
 import { extractDisplayStyle, extractDisplayStyle3d } from "./translation/displayStyleExtractor.js";
-export async function createViewState(iModel, savedViewRsp, useHiddenModelsAndCategories = true) {
-    const viewState = await createViewStateVariant(iModel, savedViewRsp);
-    if (useHiddenModelsAndCategories) {
-        await applyHiddenModelsAndCategories(iModel, viewState, savedViewRsp);
+/**
+ * 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, viewData);
+    }
+    if (!settings.skipViewStateLoad) {
+        await viewState.load();
     }
-    await viewState.load();
     return viewState;
 }
-async function createViewStateVariant(iModel, savedViewRsp) {
-    if (isViewDataITwinDrawing(savedViewRsp.savedViewData)) {
-        return createDrawingViewState(iModel, savedViewRsp.savedViewData.itwinDrawingView);
+async function createViewStateVariant(iModel, savedViewData) {
+    if (isViewDataITwinDrawing(savedViewData)) {
+        return createDrawingViewState(iModel, savedViewData.itwinDrawingView);
     }
-    if (isViewDataITwinSheet(savedViewRsp.savedViewData)) {
-        return createSheetViewState(iModel, savedViewRsp.savedViewData.itwinSheetView);
+    if (isViewDataITwinSheet(savedViewData)) {
+        return createSheetViewState(iModel, savedViewData.itwinSheetView);
     }
-    return createSpatialViewState(iModel, savedViewRsp.savedViewData.itwin3dView);
+    return createSpatialViewState(iModel, savedViewData.itwin3dView);
 }
 async function createSpatialViewState(iModel, viewData) {
     const seedViewState = await fetchIModelViewData(iModel, SpatialViewState.classFullName);
@@ -217,29 +230,29 @@ async function getDefaultViewIdFromClassName(iModel, viewClassName) {
 function cloneCode({ spec, scope, value }) {
     return { spec, scope, value };
 }
-async function applyHiddenModelsAndCategories(iModel, viewState, savedViewRsp) {
-    if (isViewDataITwin3d(savedViewRsp.savedViewData)) {
+async function unhideNewModelsAndCategories(iModel, viewState, savedViewData) {
+    if (isViewDataITwin3d(savedViewData)) {
         if (!viewState.isSpatialView()) {
             return;
         }
-        const savedViewData = savedViewRsp.savedViewData.itwin3dView;
-        if (!savedViewData.categories?.disabled || !savedViewData.models?.disabled) {
+        const viewData = savedViewData.itwin3dView;
+        if (!viewData.categories?.disabled || !viewData.models?.disabled) {
             return;
         }
         const [visibleCategories, visibleModels] = await Promise.all([
-            getMissingCategories(iModel, new Set(savedViewData.categories.disabled)),
-            getMissingModels(iModel, new Set(savedViewData.models.disabled)),
+            getMissingCategories(iModel, new Set(viewData.categories.disabled)),
+            getMissingModels(iModel, new Set(viewData.models.disabled)),
         ]);
         viewState.categorySelector.addCategories(visibleCategories);
         viewState.modelSelector.addModels(visibleModels);
         return;
     }
-    const savedViewData = isViewDataITwinDrawing(savedViewRsp.savedViewData)
-        ? savedViewRsp.savedViewData.itwinDrawingView
-        : savedViewRsp.savedViewData.itwinSheetView;
-    if (!savedViewData.categories?.disabled) {
+    const viewData = isViewDataITwinDrawing(savedViewData)
+        ? savedViewData.itwinDrawingView
+        : savedViewData.itwinSheetView;
+    if (!viewData.categories?.disabled) {
         return;
     }
-    const visibleCategories = await getMissingCategories(iModel, new Set(savedViewData.categories.disabled));
+    const visibleCategories = await getMissingCategories(iModel, new Set(viewData.categories.disabled));
     viewState.categorySelector.addCategories(visibleCategories);
 }

package/lib/experimental.d.ts

@@ -1,6 +1,3 @@
 export { createSavedViewOptions, type CreateSavedViewOptionsParams } from "./SavedViewTile/SavedViewOptions.js";
 export { SavedViewsExpandableBlockWidget } from "./SavedViewsWidget/SavedViewsExpandableBlockWidget.js";
 export { SavedViewsFolderWidget } from "./SavedViewsWidget/SavedViewsFolderWidget.js";
-export { applyExtensionsToViewport } from "./translation/SavedViewTranslation.js";
-export { createViewState } from "./createViewState.js";
-export { ModelCategoryOverrideProvider } from "./ModelCategoryOverrideProvider.js";

package/lib/experimental.js

@@ -5,6 +5,3 @@
 export { createSavedViewOptions } from "./SavedViewTile/SavedViewOptions.js";
 export { SavedViewsExpandableBlockWidget } from "./SavedViewsWidget/SavedViewsExpandableBlockWidget.js";
 export { SavedViewsFolderWidget } from "./SavedViewsWidget/SavedViewsFolderWidget.js";
-export { applyExtensionsToViewport } from "./translation/SavedViewTranslation.js";
-export { createViewState } from "./createViewState.js";
-export { ModelCategoryOverrideProvider } from "./ModelCategoryOverrideProvider.js";

package/lib/index.d.ts

@@ -4,11 +4,13 @@ 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 type { CreateGroupParams, CreateSavedViewParams, CreateTagParams, DeleteGroupParams, DeleteSavedViewParams, DeleteTagParams, GetAllGroupsParams, GetAllSavedViewsParams, GetAllTagsParams, GetSavedViewParams, GetThumbnailUrlParams, 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";

package/lib/index.js

@@ -10,7 +10,9 @@ export { ITwinSavedViewsClient } from "./SavedViewsClient/ITwinSavedViewsClient.
 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

@@ -1,7 +1,6 @@
 import type { Id64Array } from "@itwin/core-bentley";
 import type { CategorySelectorProps, DisplayStyle3dProps, DisplayStyleProps, EmphasizeElementsProps, ModelSelectorProps, SectionDrawingViewProps, SheetProps, SpatialViewDefinitionProps, ViewDefinition2dProps } from "@itwin/core-common";
 import type { Range3dProps } from "@itwin/core-geometry";
-import type { ModelCategoryOverrideProviderProps } from "../ModelCategoryOverrideProvider.js";
 export interface LegacySavedView3d extends LegacySavedViewBase {
     displayStyleProps: DisplayStyle3dProps;
     modelSelectorProps: ModelSelectorProps;
@@ -33,7 +32,6 @@ export interface LegacySavedViewBase {
     thumbnail?: string;
     categorySelectorProps: CategorySelectorProps;
     emphasizeElementsProps?: EmphasizeElementsProps;
-    visibilityOverrideProps?: ModelCategoryOverrideProviderProps;
     tags?: LegacyTag[];
     hiddenCategories?: Id64Array;
     extensions?: Map<string, string>;

package/lib/translation/SavedViewsExtensionHandlers.d.ts

@@ -1,13 +1,21 @@
 import { type Viewport } from "@itwin/core-frontend";
 export interface ExtensionHandler {
     extensionName: string;
-    onViewApply: (extensionData: string, vp: Viewport) => Promise<void>;
-}
-/**
- * Collection of default extension handlers
- */
-export declare class SavedViewsExtensionHandlers {
-    static EmphasizeElements: ExtensionHandler;
-    static PerModelCategoryVisibility: ExtensionHandler;
-    static VisibilityOverride: ExtensionHandler;
+    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

@@ -1,42 +1,53 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
 import { EmphasizeElements, PerModelCategoryVisibility } from "@itwin/core-frontend";
-import { ModelCategoryOverrideProvider } from "../ModelCategoryOverrideProvider.js";
-import { extractEmphasizeElements, extractPerModelCategoryVisibility, extractVisibilityOverride, } from "./extensionExtractor.js";
-/**
- * Collection of default extension handlers
- */
-export class SavedViewsExtensionHandlers {
-    static EmphasizeElements = {
+import { extractEmphasizeElements, extractPerModelCategoryVisibility } from "./extensionExtractor.js";
+export const extensionHandlers = {
+    emphasizeElements: {
         extensionName: "EmphasizeElements",
-        onViewApply: async (extensionData, vp) => {
+        apply: (extensionData, viewport) => {
             if (extensionData) {
                 const props = extractEmphasizeElements(extensionData);
                 if (props !== undefined) {
-                    EmphasizeElements.getOrCreate(vp).fromJSON(props, vp);
+                    EmphasizeElements.getOrCreate(viewport).fromJSON(props, viewport);
                 }
             }
         },
-    };
-    static PerModelCategoryVisibility = {
+        reset: (viewport) => {
+            if (EmphasizeElements.get(viewport)) {
+                EmphasizeElements.clear(viewport);
+                viewport.isFadeOutActive = false;
+            }
+        },
+        capture: (viewport) => {
+            const emphasizeElementsProps = EmphasizeElements.get(viewport)?.toJSON(viewport);
+            return emphasizeElementsProps ? JSON.stringify({ emphasizeElementsProps }) : undefined;
+        },
+    },
+    perModelCategoryVisibility: {
         extensionName: "PerModelCategoryVisibility",
-        onViewApply: async (extensionData, vp) => {
+        apply: (extensionData, viewport) => {
             const props = extractPerModelCategoryVisibility(extensionData) ?? [];
-            vp.perModelCategoryVisibility.clearOverrides();
             for (const override of props) {
-                vp.perModelCategoryVisibility.setOverride(override.modelId, override.categoryId, override.visible
+                viewport.perModelCategoryVisibility.setOverride(override.modelId, override.categoryId, override.visible
                     ? PerModelCategoryVisibility.Override.Show
                     : PerModelCategoryVisibility.Override.Hide);
             }
         },
-    };
-    static VisibilityOverride = {
-        extensionName: "VisibilityOverride",
-        onViewApply: async (extensionData, vp) => {
-            if (extensionData) {
-                const props = extractVisibilityOverride(extensionData);
-                if (props !== undefined) {
-                    ModelCategoryOverrideProvider.getOrCreate(vp).fromJSON(props);
-                }
+        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/displayStyleExtractor.js

@@ -14,9 +14,18 @@ const viewFlagMappings = [
     extractBoolean("hiddenEdges", "hidEdges"),
     extractBoolean("shadows"),
     extractBoolean("clipVolume", "clipVol"),
+    extractBoolean("hiddenLineMaterialColors", "hlMatColors"),
     extractBoolean("monochrome"),
     extractBoolean("backgroundMap"),
     extractBoolean("ambientOcclusion"),
+    extractBoolean("acs"),
+    extractBoolean("thematicDisplay"),
+    extractBoolean("wiremesh"),
+    extractBoolean("forceSurfaceDiscard"),
+    extractBoolean("noWhiteOnWhiteReversal"),
+    extractBoolean("noSolarLight"),
+    extractBoolean("noSourceLights"),
+    extractBoolean("noCameraLights"),
 ];
 const viewFlagLegacyMappings = [
     extractNumber("renderMode"),
@@ -33,9 +42,18 @@ const viewFlagLegacyMappings = [
     extractBoolean("hidEdges", "hiddenEdges"),
     extractBoolean("shadows"),
     extractBoolean("clipVol", "clipVolume"),
+    extractBoolean("hlMatColors", "hiddenLineMaterialColors"),
     extractBoolean("monochrome"),
     extractBoolean("backgroundMap"),
     extractBoolean("ambientOcclusion"),
+    extractBoolean("acs"),
+    extractBoolean("thematicDisplay"),
+    extractBoolean("wiremesh"),
+    extractBoolean("forceSurfaceDiscard"),
+    extractBoolean("noWhiteOnWhiteReversal"),
+    extractBoolean("noSolarLight"),
+    extractBoolean("noSourceLights"),
+    extractBoolean("noCameraLights"),
 ];
 const planarClipMaskMappings = [
     extractNumber("mode"),
@@ -284,6 +302,56 @@ const hiddenLineSettingsLegacyMappings = [
     extractObject(hiddenLineStyleLegacyMappings, "hidden"),
     extractNumber("transThreshold", "transparencyThreshold"),
 ];
+const keyColorPropsMappings = [
+    extractNumber("value"),
+    extractColor("color"),
+];
+const keyColorPropsLegacyMappings = [
+    extractNumber("value"),
+    extractColorLegacy("color"),
+];
+const thematicGradientSettingsPropsMappings = [
+    extractNumber("mode"),
+    extractNumber("stepCount"),
+    extractColor("marginColor"),
+    extractNumber("colorScheme"),
+    extractArray(keyColorPropsMappings, "customKeys"),
+    extractNumber("colorMix"),
+    extractNumber("transparencyMode"),
+];
+const thematicGradientSettingsPropsLegacyMappings = [
+    extractNumber("mode"),
+    extractNumber("stepCount"),
+    extractColorLegacy("marginColor"),
+    extractNumber("colorScheme"),
+    extractArray(keyColorPropsLegacyMappings, "customKeys"),
+    extractNumber("colorMix"),
+    extractNumber("transparencyMode"),
+];
+const thematicDisplaySensorPropsMappings = [
+    extractSimpleArray(simpleTypeOf("number"), "position"),
+    extractNumber("value"),
+];
+const thematicDisplaySensorSettingsPropsMappings = [
+    extractArray(thematicDisplaySensorPropsMappings, "sensors"),
+    extractNumber("distanceCutoff"),
+];
+const thematicDisplaySettingsMappings = [
+    extractNumber("displayMode"),
+    extractObject(thematicGradientSettingsPropsMappings, "gradientSettings"),
+    extractSimpleArray(simpleTypeOf("number"), "range"),
+    extractSimpleArray(simpleTypeOf("number"), "axis"),
+    extractSimpleArray(simpleTypeOf("number"), "sunDirection"),
+    extractObject(thematicDisplaySensorSettingsPropsMappings, "gradientSettings"),
+];
+const thematicDisplaySettingsLegacyMappings = [
+    extractNumber("displayMode"),
+    extractObject(thematicGradientSettingsPropsLegacyMappings, "gradientSettings"),
+    extractSimpleArray(simpleTypeOf("number"), "range"),
+    extractSimpleArray(simpleTypeOf("number"), "axis"),
+    extractSimpleArray(simpleTypeOf("number"), "sunDirection"),
+    extractObject(thematicDisplaySensorSettingsPropsMappings, "gradientSettings"),
+];
 const cutStyleMappings = [
     extractObject(viewFlagOverridesMapping, "viewflags"),
     extractObject(hiddenLineSettingsMappings, "hiddenLine"),
@@ -475,6 +543,8 @@ const displayStyle3dMapping = [
     extractObject(solarShadowMappings, "solarShadows"),
     extractObject(lightsMappings, "lights"),
     extractPlainTypedMap(planProjectionSettingsMappings, simpleTypeOf("string"), "planProjections"),
+    extractObject(thematicDisplaySettingsMappings, "thematic"),
+    extractObject(hiddenLineSettingsMappings, "hiddenLine", "hline"),
 ];
 const displayStyle3dLegacyMapping = [
     ...displayStylesLegacyMapping,
@@ -483,6 +553,8 @@ const displayStyle3dLegacyMapping = [
     extractObject(solarShadowLegacyMappings, "solarShadows"),
     extractObject(lightsLegacyMappings, "lights"),
     extractPlainTypedMap(planProjectionSettingsMappings, simpleTypeOf("string"), "planProjections"),
+    extractObject(thematicDisplaySettingsLegacyMappings, "thematic"),
+    extractObject(hiddenLineSettingsLegacyMappings, "hline", "hiddenLine"),
 ];
 /**
  * Extracts the display style from a legacy view displayStyle field

package/lib/translation/extensionExtractor.d.ts

@@ -1,5 +1,4 @@
 import { type EmphasizeElementsProps } from "@itwin/core-common";
-import { ModelCategoryOverrideProviderProps } from "../ModelCategoryOverrideProvider.js";
 import type { PerModelCategoryVisibilityProps } from "./SavedViewTypes.js";
 /**
  * Extracts the EmphasizeElementsProps from string data in an extension
@@ -11,8 +10,3 @@ export declare const extractEmphasizeElements: (extensionData: string) => Emphas
  * @param extensionData
  */
 export declare const extractPerModelCategoryVisibility: (extensionData: string) => PerModelCategoryVisibilityProps[];
-/**
- * Extracts the VisibilityOverrideProps (ie ModelCategoryOverrideProviderProps) from string data in an extension
- * @param extensionData
- */
-export declare const extractVisibilityOverride: (extensionData: string) => ModelCategoryOverrideProviderProps | undefined;

package/lib/translation/extensionExtractor.js

@@ -6,11 +6,6 @@ const appearanceOverrideEmphElemMappings = [
     extractColor("color"),
     extractSimpleArray(simpleTypeOf("string"), "ids"),
 ];
-/** Appearance Override type for VisibilityOverrides (ie ModelCategoryOverrideProviderProps) */
-const appearanceOverrideVisibOvrMappings = [
-    extractSimpleArray(simpleTypeOf("string"), "ids"),
-    extractObject(featureAppearanceMappings, "app"),
-];
 const emphasizeElementsMapping = [
     extractSimpleArray(simpleTypeOf("string"), "neverDrawn"),
     extractSimpleArray(simpleTypeOf("string"), "alwaysDrawn"),
@@ -26,12 +21,6 @@ const perModelCategoryVisibilityMapping = [
     extractString("categoryId"),
     extractBoolean("visible"),
 ];
-const visibilityOverrideMapping = [
-    extractArray(appearanceOverrideVisibOvrMappings, "subCategoryOverrides"),
-    extractArray(appearanceOverrideVisibOvrMappings, "modelOverrides"),
-    extractObject(appearanceOverrideVisibOvrMappings, "catEmphasizeOverride"),
-    extractObject(appearanceOverrideVisibOvrMappings, "modelEmphasizeOverride"),
-];
 /**
  * Extracts the EmphasizeElementsProps from string data in an extension
  * @param extensionData
@@ -64,16 +53,3 @@ export const extractPerModelCategoryVisibility = (extensionData) => {
     }
     return outputArray;
 };
-/**
- * Extracts the VisibilityOverrideProps (ie ModelCategoryOverrideProviderProps) from string data in an extension
- * @param extensionData
- */
-export const extractVisibilityOverride = (extensionData) => {
-    const dataObj = JSON.parse(extensionData);
-    if (dataObj === undefined || dataObj.visibilityOverrideProps === undefined) {
-        return undefined;
-    }
-    const output = {};
-    applyExtraction(dataObj.visibilityOverrideProps, output, visibilityOverrideMapping);
-    return output;
-};

package/lib/useSavedViews.d.ts

@@ -1,6 +1,6 @@
-import type { ViewData } from "@itwin/saved-views-client";
-import type { SavedView, SavedViewGroup, SavedViewTag } from "./SavedView.js";
+import type { SavedView, SavedViewGroup, SavedViewTag, WriteableSavedViewProperties } from "./SavedView.js";
 import type { SavedViewsClient } from "./SavedViewsClient/SavedViewsClient.js";
+import type { PartialExcept } from "./utils.js";
 interface UseSavedViewsParams {
     /** iTwin identifier. */
     iTwinId: string;
@@ -25,7 +25,7 @@ interface UseSavedViewsResult {
     actions: SavedViewActions;
 }
 export interface SavedViewActions {
-    submitSavedView: (savedView: string | Partial<SavedView> & Pick<SavedView, "displayName">, savedViewData: ViewData) => Promise<string>;
+    submitSavedView: (savedView: SavedViewCreationProps | SavedViewUpdateProps) => Promise<string>;
     renameSavedView: (savedViewId: string, newName: string | undefined) => void;
     shareSavedView: (savedViewId: string, share: boolean) => void;
     deleteSavedView: (savedViewId: string) => void;
@@ -40,11 +40,16 @@ export interface SavedViewActions {
     removeTag: (savedViewId: string, tagId: string) => void;
     uploadThumbnail: (savedViewId: string, imageDataUrl: string) => void;
 }
+type SavedViewCreationProps = PartialExcept<WriteableSavedViewProperties, "displayName" | "viewData">;
+type SavedViewUpdateProps = WriteableSavedViewProperties & {
+    id: string;
+};
 /**
  * Pulls Saved View data from a store and provides means to update and synchronize the data back to it. Interaction with
  * the store is performed via {@linkcode SavedViewsClient} interface which could communicate, for instance, with
  * [iTwin Saved Views API](https://developer.bentley.com/apis/savedviews/overview/) using `ITwinSavedViewsClient`.
  *
+ * @remarks
  * Note on the current implementation limitations. While the result of the first update action is reflected immediately,
  * subsequent actions are put in a queue and executed serially. This may cause the UI to feel sluggish when user makes
  * changes to Saved Views faster than the Saved Views store can be updated.

package/lib/useSavedViews.js

@@ -1,10 +1,15 @@
 import { jsx as _jsx } from "react/jsx-runtime";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
 import { useCallback, useEffect, useRef, useState, } from "react";
 /**
  * Pulls Saved View data from a store and provides means to update and synchronize the data back to it. Interaction with
  * the store is performed via {@linkcode SavedViewsClient} interface which could communicate, for instance, with
  * [iTwin Saved Views API](https://developer.bentley.com/apis/savedviews/overview/) using `ITwinSavedViewsClient`.
  *
+ * @remarks
  * Note on the current implementation limitations. While the result of the first update action is reflected immediately,
  * subsequent actions are put in a queue and executed serially. This may cause the UI to feel sluggish when user makes
  * changes to Saved Views faster than the Saved Views store can be updated.
@@ -66,11 +71,7 @@ export function useSavedViews(args) {
         providerRef.current.actionQueue = [];
         void (async () => {
             try {
-                const result = await args.client.getSavedViewInfo({
-                    iTwinId: args.iTwinId,
-                    iModelId: args.iModelId,
-                    signal: signal,
-                });
+                const result = await getSavedViewInfo(args.client, args.iTwinId, args.iModelId, signal);
                 if (signal.aborted) {
                     return;
                 }
@@ -118,28 +119,30 @@ function useEvent(handleEvent) {
     handleEventRef.current = handleEvent;
     return useCallback((...args) => handleEventRef.current(...args), []);
 }
+async function getSavedViewInfo(client, iTwinId, iModelId, signal) {
+    const args = { iTwinId, iModelId, signal };
+    const collectSavedViews = async () => {
+        let savedViews = [];
+        const iterable = client.getAllSavedViews(args);
+        for await (const page of iterable) {
+            savedViews = savedViews.concat(page);
+        }
+        return savedViews;
+    };
+    const [savedViews, groups, tags] = await Promise.all([
+        collectSavedViews(),
+        client.getAllGroups(args),
+        client.getAllTags(args),
+    ]);
+    return { savedViews, groups, tags };
+}
 function createSavedViewActions(iTwinId, iModelId, client, setState, ref, onUpdateInProgress, onUpdateComplete, onUpdateError) {
     const signal = ref.current.abortController.signal;
     return {
-        submitSavedView: actionWrapper(async (savedView, savedViewData) => {
-            let newSavedView;
-            if (typeof savedView !== "string" && savedView.id) {
-                newSavedView = await client.updateSavedView({
-                    // TypeScript cannot tell that `savedView` object contains `id` string without a little help
-                    savedView: { id: savedView.id, ...savedView },
-                    savedViewData,
-                    signal,
-                });
-            }
-            else {
-                newSavedView = await client.createSavedView({
-                    iTwinId: iTwinId,
-                    iModelId: iModelId,
-                    savedView: typeof savedView === "string" ? { displayName: savedView } : savedView,
-                    savedViewData,
-                    signal,
-                });
-            }
+        submitSavedView: actionWrapper(async (savedView) => {
+            const newSavedView = "id" in savedView
+                ? await client.updateSavedView({ savedView, signal })
+                : await client.createSavedView({ iTwinId, iModelId, savedView, signal });
             updateSavedViews((savedViews) => {
                 const entries = Array.from(savedViews.values());
                 entries.push(newSavedView);

package/lib/utils.d.ts

@@ -1 +1,2 @@
+export type PartialExcept<T, K extends keyof T> = Partial<Omit<T, K>> & Pick<Required<T>, K>;
 export declare function trimInputString(string: string): string;

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@itwin/saved-views-react",
-  "version": "0.4.1",
+  "version": "0.6.0",
   "license": "MIT",
   "repository": {
     "type": "git",
     "url": "https://github.com/iTwin/saved-views.git",
     "directory": "packages/saved-views-react"
   },
-  "homepage": "https://github.com/iTwin/saved-views",
+  "homepage": "https://github.com/iTwin/saved-views/tree/master/packages/saved-views-react",
   "author": {
     "name": "Bentley Systems, Inc.",
     "url": "https://www.bentley.com"
@@ -58,10 +58,10 @@
     "react-dom": "^17.0.0 || ^18.0.0"
   },
   "dependencies": {
-    "@itwin/itwinui-icons-react": "^2.4.0",
+    "@itwin/itwinui-icons-react": "^2.9.0",
     "@itwin/itwinui-react": "^3.8.1",
     "fuse.js": "^6.6.2",
-    "@itwin/saved-views-client": "^0.3.0"
+    "@itwin/saved-views-client": "^0.4.0"
   },
   "scripts": {
     "build": "run-p build:*",