@itwin/saved-views-react 0.1.0

package/lib/api/utilities/translation/viewExtractorSavedViewToLegacySavedView.js

@@ -0,0 +1,298 @@
+import { SheetViewState } from "@itwin/core-frontend";
+import { extractClipVectors } from "./clipVectorsExtractor.js";
+import { extractDisplayStyle, extractDisplayStyle3d } from "./displayStyleExtractor.js";
+import { convertAllLegacyUrlsToUrls, urlToLegacyUrl } from "./urlConverter.js";
+const UNGROUPED_ID = "-1";
+/**
+ * Extracts id from href
+ * @param href
+ */
+export const extractIdFromHref = (href) => {
+    return href.split("/").pop();
+};
+/**
+ * Extract all the tags
+ * @param creator href for the creator
+ * @param tags the list of tags in the saved view
+ * @returns
+ */
+const extractTags = (creator, tags) => {
+    return tags?.map((tag) => {
+        const legacyTag = {
+            name: tag.displayName,
+            createdByUserId: extractIdFromHref(creator) ?? "",
+        };
+        return legacyTag;
+    });
+};
+/**
+ * Transform a ViewDataITwinDrawing into a legacy SavedView if possible
+ * @param savedViewRsp
+ * @param iModelViewData
+ * @returns SavedView2d
+ */
+export function savedViewItwinDrawingToLegacyDrawingView(savedViewRsp, seedDrawingViewState) {
+    convertAllLegacyUrlsToUrls(savedViewRsp.savedViewData, urlToLegacyUrl);
+    const iTwinDrawingView = savedViewRsp.savedViewData.itwinDrawingView;
+    seedDrawingViewState.displayStyle;
+    const legacyView = {
+        id: savedViewRsp.id,
+        is2d: true,
+        groupId: savedViewRsp._links.group
+            ? extractIdFromHref(savedViewRsp._links.group.href)
+            : UNGROUPED_ID ?? "",
+        tags: extractTags(savedViewRsp._links.creator?.href ?? "", savedViewRsp.tags),
+        name: savedViewRsp.displayName,
+        userId: extractIdFromHref(savedViewRsp._links.creator?.href ?? "") ?? "",
+        shared: savedViewRsp.shared,
+        thumbnailId: savedViewRsp.id ?? "",
+        categorySelectorProps: {
+            classFullName: seedDrawingViewState.categorySelector.classFullName,
+            categories: (iTwinDrawingView.categories?.enabled ?? []),
+            code: {
+                scope: seedDrawingViewState.categorySelector.code.scope,
+                spec: seedDrawingViewState.categorySelector.code.spec,
+                value: seedDrawingViewState.categorySelector.code.value,
+            },
+            model: seedDrawingViewState.categorySelector.model,
+            federationGuid: seedDrawingViewState.categorySelector.federationGuid ?? "",
+            id: seedDrawingViewState.categorySelector.id,
+        },
+        viewDefinitionProps: {
+            classFullName: seedDrawingViewState.classFullName,
+            id: seedDrawingViewState.id,
+            jsonProperties: {
+                viewDetails: {
+                    gridOrient: seedDrawingViewState.getGridOrientation() ?? undefined,
+                },
+            },
+            code: {
+                scope: seedDrawingViewState.code.scope,
+                spec: seedDrawingViewState.code.spec,
+                value: seedDrawingViewState.code.value,
+            },
+            model: seedDrawingViewState.model,
+            federationGuid: seedDrawingViewState.federationGuid ?? "",
+            categorySelectorId: seedDrawingViewState.categorySelector.id,
+            displayStyleId: seedDrawingViewState.displayStyle.id,
+            isPrivate: seedDrawingViewState.isPrivate ?? false,
+            description: seedDrawingViewState.description ?? "",
+            origin: iTwinDrawingView.origin,
+            delta: iTwinDrawingView.delta,
+            angle: iTwinDrawingView.angle,
+            baseModelId: iTwinDrawingView.baseModelId,
+        },
+        displayStyleProps: {
+            classFullName: seedDrawingViewState.displayStyle.classFullName,
+            id: seedDrawingViewState.displayStyle.id,
+            jsonProperties: {
+                styles: extractDisplayStyle(iTwinDrawingView, seedDrawingViewState),
+            },
+            code: {
+                spec: seedDrawingViewState.displayStyle.code.spec,
+                scope: seedDrawingViewState.displayStyle.code.scope,
+                value: seedDrawingViewState.displayStyle.code.value,
+            },
+            model: seedDrawingViewState.displayStyle.model,
+            federationGuid: seedDrawingViewState.displayStyle.federationGuid ?? "",
+        },
+    };
+    appendHiddenCategoriesToLegacyView(iTwinDrawingView, legacyView);
+    return legacyView;
+}
+/**
+ * Transform a ViewDataITwinSheet into a legacy SavedView if possible
+ * @param savedViewRsp
+ * @param seedSheetViewState
+ * @returns SavedView2d
+ */
+export function savedViewItwinSheetToLegacySheetSavedView(savedViewRsp, seedSheetViewState) {
+    convertAllLegacyUrlsToUrls(savedViewRsp.savedViewData, urlToLegacyUrl);
+    const itwinSheetView = savedViewRsp.savedViewData.itwinSheetView;
+    const legacyView = {
+        id: savedViewRsp.id,
+        is2d: true,
+        groupId: savedViewRsp._links.group
+            ? extractIdFromHref(savedViewRsp._links.group.href)
+            : UNGROUPED_ID,
+        tags: extractTags(savedViewRsp._links.creator?.href ?? "", savedViewRsp.tags),
+        name: savedViewRsp.displayName,
+        userId: extractIdFromHref(savedViewRsp._links.creator?.href ?? "") ?? "",
+        shared: savedViewRsp.shared,
+        thumbnailId: savedViewRsp.id ?? "",
+        categorySelectorProps: {
+            classFullName: seedSheetViewState.categorySelector.classFullName,
+            categories: (itwinSheetView.categories?.enabled ?? []),
+            code: {
+                scope: seedSheetViewState.categorySelector.code.scope,
+                spec: seedSheetViewState.categorySelector.code.spec,
+                value: seedSheetViewState.categorySelector.code.value,
+            },
+            model: seedSheetViewState.categorySelector.model,
+            federationGuid: seedSheetViewState.categorySelector.federationGuid,
+            id: seedSheetViewState.categorySelector.id,
+        },
+        viewDefinitionProps: {
+            classFullName: seedSheetViewState.classFullName,
+            id: seedSheetViewState.id,
+            jsonProperties: {
+                viewDetails: {
+                    gridOrient: seedSheetViewState.getGridOrientation() ?? undefined,
+                },
+            },
+            code: {
+                scope: seedSheetViewState.code.scope,
+                spec: seedSheetViewState.code.spec,
+                value: seedSheetViewState.code.value,
+            },
+            model: seedSheetViewState.model,
+            federationGuid: seedSheetViewState.federationGuid ?? "",
+            categorySelectorId: seedSheetViewState.categorySelector.id,
+            displayStyleId: seedSheetViewState.displayStyle.id,
+            isPrivate: seedSheetViewState.isPrivate ?? false,
+            description: seedSheetViewState.description ?? "",
+            origin: itwinSheetView.origin,
+            delta: itwinSheetView.delta,
+            angle: itwinSheetView.angle,
+            baseModelId: itwinSheetView.baseModelId,
+        },
+        displayStyleProps: {
+            classFullName: seedSheetViewState.displayStyle.classFullName,
+            id: seedSheetViewState.displayStyle.id,
+            jsonProperties: {
+                styles: extractDisplayStyle(itwinSheetView, seedSheetViewState),
+            },
+            code: {
+                spec: seedSheetViewState.displayStyle.code.spec,
+                scope: seedSheetViewState.displayStyle.code.scope,
+                value: seedSheetViewState.displayStyle.code.value,
+            },
+            model: seedSheetViewState.displayStyle.model,
+            federationGuid: seedSheetViewState.displayStyle.federationGuid ?? "",
+        },
+        sheetProps: {
+            width: itwinSheetView.width ?? -1,
+            height: itwinSheetView.height ?? -1,
+            model: seedSheetViewState.displayStyle.model,
+            classFullName: SheetViewState.classFullName,
+            code: {
+                spec: seedSheetViewState.displayStyle.code.spec,
+                scope: seedSheetViewState.displayStyle.code.scope,
+                value: "",
+            },
+        },
+        sheetAttachments: itwinSheetView.sheetAttachments ?? [],
+    };
+    appendHiddenCategoriesToLegacyView(itwinSheetView, legacyView);
+    return legacyView;
+}
+/**
+ * Transform a ViewDataItwin3d into a legacy SavedView if possible
+ * @param savedViewRsp
+ * @param seedSpatialViewState
+ * @returns SavedView
+ */
+export function savedViewITwin3dToLegacy3dSavedView(savedViewRsp, seedSpatialViewState) {
+    convertAllLegacyUrlsToUrls(savedViewRsp.savedViewData, urlToLegacyUrl);
+    const modelSelector = seedSpatialViewState.modelSelector;
+    const itwin3dView = savedViewRsp.savedViewData.itwin3dView;
+    const legacyView = {
+        id: savedViewRsp.id,
+        is2d: false,
+        groupId: savedViewRsp._links.group
+            ? extractIdFromHref(savedViewRsp._links.group.href)
+            : UNGROUPED_ID,
+        tags: extractTags(savedViewRsp._links.creator?.href ?? "", savedViewRsp.tags),
+        name: savedViewRsp.displayName,
+        userId: extractIdFromHref(savedViewRsp._links.creator?.href ?? "") ?? "",
+        shared: savedViewRsp.shared,
+        thumbnailId: savedViewRsp.id ?? "",
+        viewDefinitionProps: {
+            origin: itwin3dView.origin,
+            extents: itwin3dView.extents,
+            angles: itwin3dView.angles ?? {},
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            camera: itwin3dView.camera,
+            jsonProperties: {
+                viewDetails: extractClipVectors(itwin3dView) ?? {},
+            },
+            classFullName: seedSpatialViewState.classFullName,
+            code: seedSpatialViewState.code,
+            model: seedSpatialViewState.model,
+            categorySelectorId: seedSpatialViewState.categorySelector.id,
+            displayStyleId: seedSpatialViewState.displayStyle.id,
+            cameraOn: itwin3dView.camera !== undefined,
+            modelSelectorId: seedSpatialViewState.modelSelector.id,
+        },
+        modelSelectorProps: {
+            classFullName: modelSelector.classFullName,
+            code: {
+                spec: modelSelector.code.spec,
+                scope: modelSelector.code.scope,
+                value: modelSelector.code.value,
+            },
+            model: modelSelector.model,
+            models: (itwin3dView.models?.enabled ?? []),
+        },
+        categorySelectorProps: {
+            classFullName: seedSpatialViewState.categorySelector.classFullName,
+            categories: (itwin3dView.categories?.enabled ?? []),
+            code: {
+                scope: seedSpatialViewState.categorySelector.code.scope,
+                spec: seedSpatialViewState.categorySelector.code.spec,
+                value: seedSpatialViewState.categorySelector.code.value,
+            },
+            model: seedSpatialViewState.categorySelector.model,
+        },
+        displayStyleProps: {
+            id: seedSpatialViewState.displayStyle.id,
+            classFullName: seedSpatialViewState.displayStyle.classFullName,
+            code: seedSpatialViewState.displayStyle.code,
+            model: seedSpatialViewState.displayStyle.model,
+            jsonProperties: {
+                styles: extractDisplayStyle3d(savedViewRsp.savedViewData.itwin3dView),
+            },
+        },
+    };
+    appendHiddenCategoriesToLegacyView(itwin3dView, legacyView);
+    appendHiddenModelsTo3dLegacySavedView(itwin3dView, legacyView);
+    return legacyView;
+}
+/**
+ * append Hidden Categories Or Models To Legacy Saved View
+ * @param iTwinView new schema
+ * @param legacyView
+ * @returns iModelViewData
+ */
+function appendHiddenCategoriesToLegacyView(iTwinView, legacyView) {
+    if (iTwinView.categories && iTwinView.categories.disabled) {
+        legacyView.hiddenCategories = iTwinView.categories.disabled;
+    }
+}
+/**
+ * append Hidden Categories Or Models To Legacy Saved View
+ * @param view new schema
+ * @param legacyView
+ * @returns iModelViewData
+ */
+function appendHiddenModelsTo3dLegacySavedView(view, legacyView) {
+    if (view.models && view.models.disabled) {
+        legacyView.hiddenModels = view.models?.disabled;
+    }
+}
+/**
+ * removes null and undefined from legacy view model selectors props models
+ * @param savedView
+ * @returns SavedViewWithData
+ */
+export const cleanLegacyViewModelSelectorPropsModels = (savedView) => {
+    if (savedView.savedViewData.legacyView?.modelSelectorProps) {
+        const savedViewCopy = structuredClone(savedView);
+        const legacyView = savedViewCopy.savedViewData.legacyView;
+        legacyView.modelSelectorProps.models =
+            legacyView.modelSelectorProps.models.filter((model) => !!model);
+        savedViewCopy.savedViewData.legacyView = legacyView;
+        return savedViewCopy;
+    }
+    return savedView;
+};

package/lib/experimental.d.ts

@@ -0,0 +1,4 @@
+export { createSavedViewOptions, type CreateSavedViewOptionsParams } from "./SavedViewTile/SavedViewOptions.js";
+export { SavedViewsExpandableBlockWidget } from "./SavedViewsWidget/SavedViewsExpandableBlockWidget.js";
+export { SavedViewsFolderWidget } from "./SavedViewsWidget/SavedViewsFolderWidget.js";
+export { applyExtensionsToViewport, translateLegacySavedViewToITwinJsViewState, translateSavedViewResponseToLegacySavedViewResponse, } from "./api/utilities/translation/SavedViewTranslation.js";

package/lib/experimental.js

@@ -0,0 +1,8 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+export { createSavedViewOptions } from "./SavedViewTile/SavedViewOptions.js";
+export { SavedViewsExpandableBlockWidget } from "./SavedViewsWidget/SavedViewsExpandableBlockWidget.js";
+export { SavedViewsFolderWidget } from "./SavedViewsWidget/SavedViewsFolderWidget.js";
+export { applyExtensionsToViewport, translateLegacySavedViewToITwinJsViewState, translateSavedViewResponseToLegacySavedViewResponse, } from "./api/utilities/translation/SavedViewTranslation.js";

package/lib/index.d.ts

@@ -0,0 +1,12 @@
+export { LayeredDropdownMenu, LayeredMenuItem } from "./LayeredDropdownMenu/LayeredDropdownMenu.js";
+export type { SavedView, SavedViewGroup, SavedViewTag } from "./SavedView.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 { SavedViewInfo, SavedViewsClient } from "./SavedViewsClient/SavedViewsClient.js";
+export { SavedViewsContextProvider, type SavedViewsContext } from "./SavedViewsContext.js";
+export { StickyExpandableBlock } from "./StickyExpandableBlock/StickyExpandableBlock.js";
+export { TileGrid } from "./TileGrid/TileGrid.js";
+export { defaultLocalization, type LocalizationStrings } from "./localization.js";
+export { useSavedViews, type SavedViewActions } from "./useSavedViews.js";

package/lib/index.js

@@ -0,0 +1,14 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+export { LayeredDropdownMenu, LayeredMenuItem } from "./LayeredDropdownMenu/LayeredDropdownMenu.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 { defaultLocalization } from "./localization.js";
+export { useSavedViews } from "./useSavedViews.js";

package/lib/localization.d.ts

@@ -0,0 +1,52 @@
+export type LocalizationStrings = Customizable<typeof defaultLocalization>;
+type Customizable<T> = {
+    -readonly [K in keyof T]?: T[K] extends string ? string | undefined : Customizable<T[K]> | undefined;
+};
+export declare const defaultLocalization: {
+    /** @default "Delete" */
+    readonly delete: "Delete";
+    /** @default "Rename" */
+    readonly rename: "Rename";
+    /** Strings used within `<SavedViewOptions.MoveToGroup />` component. */
+    readonly moveToGroupMenu: {
+        /** @default "Create group" */
+        readonly createGroup: "Create group:";
+        /** @default "(current)" */
+        readonly current: "(current)";
+        /** @default "Find a group" */
+        readonly findGroup: "Find a group";
+        /** @default "Find or create a new group" */
+        readonly findOrCreateGroup: "Find or create a new group";
+        /** @default "Move to group" */
+        readonly moveToGroup: "Move to group";
+    };
+    /** Strings used within `SavedViewOptions` components. */
+    readonly searchableMenu: {
+        /** @default "No search results" */
+        readonly noSearchResults: "No search results";
+    };
+    /** Strings used within `<SavedViewOptions.ManageTags />` component. */
+    readonly tagsMenu: {
+        /** @default "Create tag:" */
+        readonly createTag: "Create tag:";
+        /** @default "Find or create a new tag" */
+        readonly findOrCreateTag: "Find or create a new tag";
+        /** @default "Find a tag" */
+        readonly findTag: "Find a tag";
+        /** @default "Tags" */
+        readonly tags: "Tags";
+    };
+    /** Strings used within `<SavedViewTile />` component. */
+    readonly tile: {
+        /** @default "more" */
+        readonly moreTags: "more";
+    };
+    /** Strings used within `<TileGrid />` component. */
+    readonly tileGrid: {
+        /** @default "more available" */
+        readonly moreAvailable: "more available";
+        /** @default "Show more" */
+        readonly showMore: "Show more";
+    };
+};
+export {};

package/lib/localization.js

@@ -0,0 +1,51 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+export const defaultLocalization = {
+    /** @default "Delete" */
+    delete: "Delete",
+    /** @default "Rename" */
+    rename: "Rename",
+    /** Strings used within `<SavedViewOptions.MoveToGroup />` component. */
+    moveToGroupMenu: {
+        /** @default "Create group" */
+        createGroup: "Create group:",
+        /** @default "(current)" */
+        current: "(current)",
+        /** @default "Find a group" */
+        findGroup: "Find a group",
+        /** @default "Find or create a new group" */
+        findOrCreateGroup: "Find or create a new group",
+        /** @default "Move to group" */
+        moveToGroup: "Move to group",
+    },
+    /** Strings used within `SavedViewOptions` components. */
+    searchableMenu: {
+        /** @default "No search results" */
+        noSearchResults: "No search results",
+    },
+    /** Strings used within `<SavedViewOptions.ManageTags />` component. */
+    tagsMenu: {
+        /** @default "Create tag:" */
+        createTag: "Create tag:",
+        /** @default "Find or create a new tag" */
+        findOrCreateTag: "Find or create a new tag",
+        /** @default "Find a tag" */
+        findTag: "Find a tag",
+        /** @default "Tags" */
+        tags: "Tags",
+    },
+    /** Strings used within `<SavedViewTile />` component. */
+    tile: {
+        /** @default "more" */
+        moreTags: "more",
+    },
+    /** Strings used within `<TileGrid />` component. */
+    tileGrid: {
+        /** @default "more available" */
+        moreAvailable: "more available",
+        /** @default "Show more" */
+        showMore: "Show more",
+    },
+};

package/lib/ui/viewlist/ModelCategoryOverrideProvider.d.ts

@@ -0,0 +1,31 @@
+import { type FeatureAppearanceProps } from "@itwin/core-common";
+import type { FeatureOverrideProvider, FeatureSymbology, Viewport } from "@itwin/core-frontend";
+interface AppearanceOverrideProps {
+    ids: string[];
+    app: FeatureAppearanceProps;
+}
+/** Overrides given categories to provide emphasize functionality
+ *  @public
+ */
+export interface ModelCategoryOverrideProviderProps {
+    subCategoryOverrides?: AppearanceOverrideProps[];
+    modelOverrides?: AppearanceOverrideProps[];
+    catEmphasizeOverride?: AppearanceOverrideProps;
+    modelEmphasizeOverride?: AppearanceOverrideProps;
+}
+/** Model & Category override provider (override plus emphasize)
+ *  @public
+ */
+export declare class ModelCategoryOverrideProvider implements FeatureOverrideProvider {
+    private readonly _subCategoryOverrides;
+    private readonly _modelOverrides;
+    private readonly _emphasizedSubcats;
+    private readonly _emphasizedModels;
+    private _catDefaultAppearance?;
+    private _modelDefaultAppearance?;
+    static get(vp: Viewport): ModelCategoryOverrideProvider | undefined;
+    static getOrCreate(vp: Viewport): ModelCategoryOverrideProvider;
+    addFeatureOverrides(overrides: FeatureSymbology.Overrides, _vp: Viewport): void;
+    fromJSON(props: ModelCategoryOverrideProviderProps): boolean;
+}
+export {};

package/lib/ui/viewlist/ModelCategoryOverrideProvider.js

@@ -0,0 +1,88 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+import { FeatureAppearance } from "@itwin/core-common";
+/** Model & Category override provider (override plus emphasize)
+ *  @public
+ */
+export class ModelCategoryOverrideProvider {
+    _subCategoryOverrides = new Map();
+    _modelOverrides = new Map();
+    _emphasizedSubcats = [];
+    _emphasizedModels = [];
+    _catDefaultAppearance;
+    _modelDefaultAppearance;
+    static get(vp) {
+        return vp.findFeatureOverrideProviderOfType(ModelCategoryOverrideProvider);
+    }
+    static getOrCreate(vp) {
+        let provider = this.get(vp);
+        if (!provider) {
+            provider = new ModelCategoryOverrideProvider();
+            vp.addFeatureOverrideProvider(provider);
+        }
+        return provider;
+    }
+    addFeatureOverrides(overrides, _vp) {
+        this._subCategoryOverrides.forEach((appearance, ids, _map) => {
+            ids.forEach((id) => {
+                overrides.override({ subCategoryId: id, appearance });
+            });
+        });
+        this._modelOverrides.forEach((appearance, ids, _map) => {
+            ids.forEach((id) => {
+                overrides.override({ modelId: id, appearance });
+            });
+        });
+        if (0 !== this._emphasizedSubcats.length) {
+            if (this._catDefaultAppearance) {
+                overrides.setDefaultOverrides(this._catDefaultAppearance, true);
+            }
+            // Override with nothing so that we keep the category looking normal and override the default appearance of everything else
+            const override = FeatureAppearance.fromJSON({});
+            this._emphasizedSubcats.forEach((id) => {
+                overrides.override({
+                    subCategoryId: id,
+                    appearance: override,
+                    onConflict: "replace",
+                });
+            });
+        }
+        if (0 !== this._emphasizedModels.length) {
+            if (this._modelDefaultAppearance) {
+                overrides.setDefaultOverrides(this._modelDefaultAppearance, true);
+            }
+            // Override with nothing so that we keep the category looking normal and override the default appearance of everything else
+            const override = FeatureAppearance.fromJSON({});
+            this._emphasizedModels.forEach((id) => {
+                overrides.override({
+                    modelId: id,
+                    appearance: override,
+                    onConflict: "replace",
+                });
+            });
+        }
+    }
+    fromJSON(props) {
+        if (props.subCategoryOverrides) {
+            props.subCategoryOverrides.forEach((appProps) => {
+                this._subCategoryOverrides.set(appProps.ids, FeatureAppearance.fromJSON(appProps.app));
+            });
+        }
+        if (props.modelOverrides) {
+            props.modelOverrides.forEach((appProps) => {
+                this._modelOverrides.set(appProps.ids, FeatureAppearance.fromJSON(appProps.app));
+            });
+        }
+        if (props.catEmphasizeOverride) {
+            this._emphasizedSubcats.push(...props.catEmphasizeOverride.ids);
+            this._catDefaultAppearance = FeatureAppearance.fromJSON(props.catEmphasizeOverride.app);
+        }
+        if (props.modelEmphasizeOverride) {
+            this._emphasizedModels.push(...props.modelEmphasizeOverride.ids);
+            this._modelDefaultAppearance = FeatureAppearance.fromJSON(props.modelEmphasizeOverride.app);
+        }
+        return true;
+    }
+}

package/lib/useSavedViews.d.ts

@@ -0,0 +1,52 @@
+import type { ViewData } from "@itwin/saved-views-client";
+import type { SavedView, SavedViewGroup, SavedViewTag } from "./SavedView.js";
+import type { SavedViewsClient } from "./SavedViewsClient/SavedViewsClient.js";
+interface UseSavedViewsParams {
+    /** iTwin identifier. */
+    iTwinId: string;
+    /** iModel identifier. */
+    iModelId: string;
+    /** Implements communication with Saved Views store. */
+    client: SavedViewsClient;
+    /**
+     * Invoked when any of {@linkcode SavedViewActions} is triggered. Does not get called again until either
+     * {@linkcode onUpdateComplete} or {@linkcode onUpdateError} is invoked.
+     */
+    onUpdateInProgress?: (() => void) | undefined;
+    /** Invoked once after {@linkcode onUpdateInProgress} when the data is successfully synchronised with the store. */
+    onUpdateComplete?: (() => void) | undefined;
+    /** Invoked once after {@linkcode onUpdateInProgress} when data synchronisation with the store fails. */
+    onUpdateError?: ((error: unknown) => void) | undefined;
+}
+interface UseSavedViewsResult {
+    savedViews: Map<string, SavedView>;
+    groups: Map<string, SavedViewGroup>;
+    tags: Map<string, SavedViewTag>;
+    actions: SavedViewActions;
+}
+export interface SavedViewActions {
+    createSavedView: (savedViewName: string, savedViewData: ViewData) => void;
+    renameSavedView: (savedViewId: string, newName: string) => void;
+    shareSavedView: (savedViewId: string, share: boolean) => void;
+    deleteSavedView: (savedViewId: string) => void;
+    createGroup: (groupName: string) => void;
+    renameGroup: (groupId: string, newName: string) => void;
+    shareGroup: (groupId: string, share: boolean) => void;
+    moveToGroup: (savedViewId: string, groupId: string) => void;
+    moveToNewGroup: (savedViewId: string, groupName: string) => void;
+    deleteGroup: (groupId: string) => void;
+    addTag: (savedViewId: string, tagId: string) => void;
+    addNewTag: (savedViewId: string, tagName: string) => void;
+    removeTag: (savedViewId: string, tagId: string) => void;
+}
+/**
+ * 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`.
+ *
+ * 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.
+ */
+export declare function useSavedViews(args: UseSavedViewsParams): UseSavedViewsResult | undefined;
+export {};