@itwin/saved-views-react 0.7.0 → 0.9.0

package/lib/SavedViewsClient/ITwinSavedViewsClient.js

@@ -123,10 +123,6 @@ export class ITwinSavedViewsClient {
         return groupResponseToSavedViewGroup(group);
     }
     async deleteGroup(args) {
-        const savedViewPages = this.#client.getAllSavedViewsMinimal({ groupId: args.groupId, signal: args.signal });
-        for await (const { savedViews } of savedViewPages) {
-            await Promise.all(savedViews.map(({ id }) => this.#client.deleteSavedView({ savedViewId: id, signal: args.signal })));
-        }
         await this.#client.deleteGroup({ groupId: args.groupId, signal: args.signal });
     }
     async createTag(args) {

package/lib/applySavedView.d.ts

@@ -1,5 +1,6 @@
 import { ViewChangeOptions, ViewPose, ViewState, type IModelConnection, type Viewport } from "@itwin/core-frontend";
 import type { SavedViewData } from "./SavedView.js";
+import { type DefaultExtensionHandlersApplyOverrides } from "./translation/SavedViewsExtensionHandlers.js";
 export interface ApplySavedViewSettings {
     /**
      * How to make use of captured {@link ViewState} data. The default behavior is
@@ -65,5 +66,5 @@ type ApplyStrategy = "apply" | "keep";
  *   applySavedView(iModel, viewport2, savedView, { viewState }),
  * ]);
  */
-export declare function applySavedView(iModel: IModelConnection, viewport: Viewport, savedViewData: SavedViewData, settings?: ApplySavedViewSettings | undefined): Promise<void>;
+export declare function applySavedView(iModel: IModelConnection, viewport: Viewport, savedViewData: SavedViewData, settings?: ApplySavedViewSettings | undefined, overrides?: DefaultExtensionHandlersApplyOverrides): Promise<void>;
 export {};

package/lib/applySavedView.js

@@ -1,10 +1,10 @@
 /*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-import { ViewPose, ViewState } from "@itwin/core-frontend";
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+import { ViewPose, ViewState, } from "@itwin/core-frontend";
 import { createViewState } from "./createViewState.js";
-import { extensionHandlers } from "./translation/SavedViewsExtensionHandlers.js";
+import { extensionHandlers, } from "./translation/SavedViewsExtensionHandlers.js";
 /**
  * Updates {@linkcode viewport} state to match captured Saved View.
  *
@@ -17,7 +17,7 @@ import { extensionHandlers } from "./translation/SavedViewsExtensionHandlers.js"
  *   applySavedView(iModel, viewport2, savedView, { viewState }),
  * ]);
  */
-export async function applySavedView(iModel, viewport, savedViewData, settings = {}) {
+export async function applySavedView(iModel, viewport, savedViewData, settings = {}, overrides) {
     if (settings.viewState !== "keep") {
         // We use "hidden" as the default value for modelAndCategoryVisibilityFallback
         // because users expect modelSelector.enabled and categorySelector.enabled to
@@ -26,7 +26,9 @@ export async function applySavedView(iModel, viewport, savedViewData, settings =
         const { modelAndCategoryVisibilityFallback = "hidden" } = settings;
         const viewState = settings.viewState instanceof ViewState
             ? settings.viewState
-            : await createViewState(iModel, savedViewData.viewData, { modelAndCategoryVisibilityFallback });
+            : await createViewState(iModel, savedViewData.viewData, {
+                modelAndCategoryVisibilityFallback,
+            });
         if (settings.camera instanceof ViewPose) {
             viewState.applyPose(settings.camera);
         }
@@ -37,19 +39,29 @@ export async function applySavedView(iModel, viewport, savedViewData, settings =
     }
     const extensions = findKnownExtensions(savedViewData.extensions ?? []);
     if (extensions.emphasis) {
+        const override = overrides?.emphasizeElements;
         if (settings.emphasis !== "keep") {
-            extensionHandlers.emphasizeElements.reset(viewport);
+            override?.reset
+                ? override.reset(viewport)
+                : extensionHandlers.emphasizeElements.reset(viewport);
         }
         if (settings.emphasis === "apply") {
-            extensionHandlers.emphasizeElements.apply(extensions.emphasis, viewport);
+            override?.apply
+                ? override.apply(extensions.emphasis, viewport)
+                : extensionHandlers.emphasizeElements.apply(extensions.emphasis, viewport);
         }
     }
     if (extensions.perModelCategoryVisibility) {
+        const override = overrides?.perModelCategoryVisibility;
         if (settings.perModelCategoryVisibility !== "keep") {
-            extensionHandlers.perModelCategoryVisibility.reset(viewport);
+            override?.reset
+                ? override.reset(viewport)
+                : extensionHandlers.perModelCategoryVisibility.reset(viewport);
         }
         if (settings.perModelCategoryVisibility === "apply") {
-            extensionHandlers.perModelCategoryVisibility.apply(extensions.perModelCategoryVisibility, viewport);
+            override?.apply
+                ? override.apply(extensions.perModelCategoryVisibility, viewport)
+                : extensionHandlers.perModelCategoryVisibility.apply(extensions.perModelCategoryVisibility, viewport);
         }
     }
 }
@@ -61,14 +73,16 @@ function findKnownExtensions(extensions) {
     };
     for (const extension of extensions) {
         if (result.emphasis === undefined &&
-            extension.extensionName === extensionHandlers.emphasizeElements.extensionName) {
+            extension.extensionName ===
+                extensionHandlers.emphasizeElements.extensionName) {
             result.emphasis = extension.data;
             if (result.perModelCategoryVisibility) {
                 break;
             }
         }
         if (result.perModelCategoryVisibility === undefined &&
-            extension.extensionName === extensionHandlers.perModelCategoryVisibility.extensionName) {
+            extension.extensionName ===
+                extensionHandlers.perModelCategoryVisibility.extensionName) {
             result.perModelCategoryVisibility = extension.data;
             if (result.emphasis) {
                 break;

package/lib/captureSavedViewData.d.ts

@@ -1,6 +1,7 @@
 import { Id64Array } from "@itwin/core-bentley";
 import type { IModelConnection, Viewport } from "@itwin/core-frontend";
 import type { SavedViewData } from "./SavedView.js";
+import { type DefaultExtensionHandlersCaptureOverrides } from "./translation/SavedViewsExtensionHandlers.js";
 interface CaptureSavedViewDataArgs {
     /** Viewport to capture. */
     viewport: Viewport;
@@ -14,6 +15,10 @@ interface CaptureSavedViewDataArgs {
      * @default false
      */
     omitPerModelCategoryVisibility?: boolean | undefined;
+    /**
+     * Overrides for the capture function of default extension handlers .
+     */
+    overrides?: DefaultExtensionHandlersCaptureOverrides;
 }
 /**
  * Captures current {@link Viewport} state into serializable format. The returned

package/lib/captureSavedViewData.js

@@ -19,10 +19,16 @@ import { extractDisplayStyle2dFromLegacy, extractDisplayStyle3dFromLegacy, } fro
 export async function captureSavedViewData(args) {
     const extensions = [];
     if (!args.omitEmphasis) {
-        extensions.push(extensionHandlers.emphasizeElements);
+        extensions.push({
+            ...extensionHandlers.emphasizeElements,
+            capture: args.overrides?.emphasizeElements?.capture ?? extensionHandlers.emphasizeElements.capture,
+        });
     }
     if (!args.omitPerModelCategoryVisibility) {
-        extensions.push(extensionHandlers.perModelCategoryVisibility);
+        extensions.push({
+            ...extensionHandlers.perModelCategoryVisibility,
+            capture: args.overrides?.perModelCategoryVisibility?.capture ?? extensionHandlers.perModelCategoryVisibility.capture,
+        });
     }
     return {
         viewData: await createSavedViewVariant(args.viewport),

package/lib/translation/SavedViewsExtensionHandlers.d.ts

@@ -5,6 +5,14 @@ export interface ExtensionHandler {
     reset: (viewport: Viewport) => void;
     capture: (viewport: Viewport) => string | undefined;
 }
+export interface DefaultExtensionHandlersApplyOverrides {
+    emphasizeElements?: Partial<Pick<ExtensionHandler, "apply" | "reset">>;
+    perModelCategoryVisibility?: Partial<Pick<ExtensionHandler, "apply" | "reset">>;
+}
+export interface DefaultExtensionHandlersCaptureOverrides {
+    emphasizeElements?: Partial<Pick<ExtensionHandler, "capture">>;
+    perModelCategoryVisibility?: Partial<Pick<ExtensionHandler, "capture">>;
+}
 export declare const extensionHandlers: {
     emphasizeElements: {
         extensionName: string;

package/lib/translation/SavedViewsExtensionHandlers.js

@@ -1,9 +1,9 @@
 /*---------------------------------------------------------------------------------------------
-* 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 { extractEmphasizeElements, extractPerModelCategoryVisibility } from "./extensionExtractor.js";
+ * 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 { extractEmphasizeElements, extractPerModelCategoryVisibility, } from "./extensionExtractor.js";
 export const extensionHandlers = {
     emphasizeElements: {
         extensionName: "EmphasizeElements",

package/lib/useSavedViews.d.ts

@@ -184,7 +184,7 @@ export interface SavedViewsActions {
  *
  * return <MySavedViewsWidget savedViews={savedViews} onOpenSavedView={handleOpenSavedView} />;
  */
-export declare const useSavedViews: ((args: UseSavedViewsArgs) => UseSavedViewsResult) & ((args: UseSavedViewsArgs) => UseSavedViewsResult) & {
+export declare const useSavedViews: ((args: UseSavedViewsArgs) => UseSavedViewsResult) & {
     /** Suggested initial state of custom Saved View stores. Immutable. */
     emptyState: SavedViewsState;
 };

package/lib/useSavedViews.js

@@ -132,94 +132,6 @@ export const useSavedViews = Object.assign((args) => {
         },
     });
     return useMemo(() => ({ ...events, store: state }), [events, state]);
-}, (args) => {
-    const { iTwinId, iModelId, client } = args;
-    const [state, setState] = useControlledState(args.state ?? emptyState, args.state, args.setState);
-    const stateRef = useRef({ iTwinId, iModelId, client, state, setState });
-    stateRef.current = { iTwinId, iModelId, client, state, setState };
-    const [events] = useState({
-        ...createActions(stateRef),
-        startLoadingData: (callback) => {
-            const { iTwinId, iModelId, client, setState } = stateRef.current;
-            const abortController = new AbortController();
-            const signal = abortController.signal;
-            const observer = new CustomObserver((savedViewId) => {
-                void (async () => {
-                    const loadSavedViewData = async () => {
-                        let savedViewData;
-                        try {
-                            savedViewData = await client.getSavedViewDataById({ savedViewId, signal });
-                        }
-                        catch {
-                            savedViewData = undefined;
-                        }
-                        if (savedViewData && !signal.aborted) {
-                            setState((prev) => {
-                                const newState = { ...prev };
-                                newState.savedViewData = new Map(prev.savedViewData);
-                                newState.savedViewData.set(savedViewId, savedViewData);
-                                return newState;
-                            });
-                        }
-                    };
-                    const loadThumbnail = async () => {
-                        let thumbnailUrl;
-                        try {
-                            thumbnailUrl = await client.getThumbnailUrl({ savedViewId, signal });
-                        }
-                        catch {
-                            thumbnailUrl = undefined;
-                        }
-                        if (!signal.aborted) {
-                            setState((prev) => {
-                                const newState = { ...prev };
-                                newState.thumbnails = new Map(prev.thumbnails);
-                                newState.thumbnails.set(savedViewId, thumbnailUrl && _jsx("img", { src: thumbnailUrl }));
-                                return newState;
-                            });
-                        }
-                    };
-                    await Promise.all([loadSavedViewData(), loadThumbnail()]);
-                })();
-            });
-            void (async () => {
-                try {
-                    const result = await getSavedViewInfo(client, iTwinId, iModelId, signal);
-                    signal.throwIfAborted();
-                    setState((prev) => {
-                        const newState = { ...prev };
-                        newState.savedViews = new Map(prev.savedViews);
-                        result.savedViews.forEach((savedView) => newState.savedViews.set(savedView.savedViewId, savedView));
-                        newState.groups = new Map(prev.groups);
-                        result.groups.forEach((group) => newState.groups.set(group.groupId, group));
-                        newState.tags = new Map(prev.tags);
-                        result.tags.forEach((tag) => newState.tags.set(tag.tagId, tag));
-                        newState.thumbnails = new Map(prev.thumbnails);
-                        result.savedViews
-                            .filter(({ savedViewId }) => !prev.thumbnails.has(savedViewId))
-                            .forEach(({ savedViewId }) => {
-                            newState.thumbnails.set(savedViewId, _jsx(ThumbnailPlaceholder, { savedViewId: savedViewId, observer: observer }));
-                        });
-                        return newState;
-                    });
-                    callback?.();
-                }
-                catch (error) {
-                    if (callback) {
-                        callback(error);
-                    }
-                    else {
-                        throw error;
-                    }
-                }
-            })();
-            return () => {
-                abortController.abort();
-                observer.disconnect();
-            };
-        },
-    });
-    return useMemo(() => ({ ...events, store: state }), [events, state]);
 }, {
     /** Suggested initial state of custom Saved View stores. Immutable. */
     emptyState,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/saved-views-react",
-  "version": "0.7.0",
+  "version": "0.9.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -29,12 +29,16 @@
     "./public"
   ],
   "devDependencies": {
-    "@itwin/core-bentley": "^4.0.6",
-    "@itwin/core-common": "^4.0.6",
-    "@itwin/core-frontend": "^4.0.6",
-    "@itwin/core-geometry": "^4.0.6",
-    "@testing-library/react": "^12.1.5",
-    "@types/react": "^17.0.39",
+    "@itwin/core-bentley": "^4.10.6",
+    "@itwin/core-common": "^4.10.6",
+    "@itwin/core-frontend": "^4.10.6",
+    "@itwin/core-geometry": "^4.10.6",
+    "@testing-library/react": "^16.2.0",
+    "@itwin/appui-abstract": "^4.10.6",
+    "@itwin/core-orbitgt": "^4.10.6",
+    "@itwin/core-quantity": "^4.10.6",
+    "@testing-library/dom": "^10.0.0",
+    "@types/react": "^18.0.0",
     "@types/recursive-readdir": "^2.2.2",
     "@vitejs/plugin-react-swc": "^3.5.0",
     "@vitest/coverage-v8": "^2.1.4",
@@ -43,25 +47,28 @@
     "npm-run-all": "^4.1.5",
     "postcss-cli": "^10.1.0",
     "postcss-modules": "^6.0.0",
-    "react": "^17.0.0",
-    "react-dom": "^17.0.0",
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0",
     "recursive-readdir": "^2.2.3",
     "typescript": "^5.5.4",
     "vite": "^5.4.11",
     "vitest": "^2.1.4"
   },
   "peerDependencies": {
-    "@itwin/core-common": "^4.0.6",
-    "@itwin/core-frontend": "^4.0.6",
-    "@itwin/core-geometry": "^4.0.6",
-    "react": "^17.0.0 || ^18.0.0",
-    "react-dom": "^17.0.0 || ^18.0.0"
+    "@itwin/core-common": "^4.10.6",
+    "@itwin/core-frontend": "^4.10.6",
+    "@itwin/core-geometry": "^4.10.6",
+    "@itwin/appui-abstract": "^4.10.6",
+    "@itwin/core-orbitgt": "^4.10.6",
+    "@itwin/core-quantity": "^4.10.6",
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0"
   },
   "dependencies": {
     "@itwin/itwinui-icons-react": "^2.9.0",
-    "@itwin/itwinui-react": "^3.8.1",
+    "@itwin/itwinui-react": "^3.15.0",
     "fuse.js": "^6.6.2",
-    "@itwin/saved-views-client": "^0.4.0"
+    "@itwin/saved-views-client": "^0.5.0"
   },
   "scripts": {
     "build": "run-p build:*",