@itwin/saved-views-react 0.3.1 → 0.4.0

package/lib/SavedView.d.ts

@@ -7,6 +7,12 @@ export interface SavedView {
     tagIds?: string[] | undefined;
     shared?: boolean | undefined;
     thumbnail?: ReactNode | string | undefined;
+    /** `extensionName` and `data` pairs. */
+    extensions?: Map<string, string> | undefined;
+    /** Time the saved view was created as an ISO8601 string, `"YYYY-MM-DDTHH:mm:ss.sssZ"` */
+    creationTime?: string;
+    /** Time the saved view was last modified as an ISO8601 string, `"YYYY-MM-DDTHH:mm:ss.sssZ"` */
+    lastModified?: string;
 }
 export interface SavedViewTag {
     id: string;

package/lib/SavedViewsClient/ITwinSavedViewsClient.js

@@ -125,6 +125,8 @@ function savedViewResponseToSavedView(response) {
         creatorId: response._links.creator?.href.split("/").at(-1),
         shared: response.shared,
         thumbnail: undefined,
+        creationTime: response.creationTime,
+        lastModified: response.lastModified,
     };
 }
 function groupResponseToSavedViewGroup(response) {

package/lib/captureSavedViewData.js

@@ -1,6 +1,6 @@
 import { QueryRowFormat } from "@itwin/core-common";
-import { extractClipVectorsFromLegacy } from "./api/utilities/translation/clipVectorsLegacyExtractor.js";
-import { extractDisplayStyle2dFromLegacy, extractDisplayStyle3dFromLegacy, } from "./api/utilities/translation/displayStyleExtractor.js";
+import { extractClipVectorsFromLegacy } from "./translation/clipVectorsLegacyExtractor.js";
+import { extractDisplayStyle2dFromLegacy, extractDisplayStyle3dFromLegacy, } from "./translation/displayStyleExtractor.js";
 export async function captureSavedViewData(args) {
     const { captureHiddenModelsAndCategories = true } = args;
     const hiddenCategoriesPromise = captureHiddenModelsAndCategories

package/lib/createViewState.d.ts

@@ -0,0 +1,3 @@
+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>;

package/lib/createViewState.js

@@ -0,0 +1,245 @@
+/*---------------------------------------------------------------------------------------------
+* 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 { DrawingViewState, SheetViewState, SpatialViewState, } from "@itwin/core-frontend";
+import { isViewDataITwin3d, isViewDataITwinDrawing, isViewDataITwinSheet, } from "@itwin/saved-views-client";
+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);
+    }
+    await viewState.load();
+    return viewState;
+}
+async function createViewStateVariant(iModel, savedViewRsp) {
+    if (isViewDataITwinDrawing(savedViewRsp.savedViewData)) {
+        return createDrawingViewState(iModel, savedViewRsp.savedViewData.itwinDrawingView);
+    }
+    if (isViewDataITwinSheet(savedViewRsp.savedViewData)) {
+        return createSheetViewState(iModel, savedViewRsp.savedViewData.itwinSheetView);
+    }
+    return createSpatialViewState(iModel, savedViewRsp.savedViewData.itwin3dView);
+}
+async function createSpatialViewState(iModel, viewData) {
+    const seedViewState = await fetchIModelViewData(iModel, SpatialViewState.classFullName);
+    const props = {
+        viewDefinitionProps: {
+            origin: viewData.origin,
+            extents: viewData.extents,
+            angles: viewData.angles,
+            camera: viewData.camera ?? new Camera(),
+            jsonProperties: {
+                viewDetails: extractClipVectors(viewData),
+            },
+            classFullName: seedViewState.classFullName,
+            code: seedViewState.code,
+            model: seedViewState.model,
+            categorySelectorId: seedViewState.categorySelector.id,
+            displayStyleId: seedViewState.displayStyle.id,
+            cameraOn: viewData.camera !== undefined,
+            modelSelectorId: seedViewState.modelSelector.id,
+        },
+        categorySelectorProps: {
+            classFullName: seedViewState.categorySelector.classFullName,
+            categories: viewData.categories?.enabled ?? [],
+            code: cloneCode(seedViewState.categorySelector.code),
+            model: seedViewState.categorySelector.model,
+        },
+        modelSelectorProps: {
+            classFullName: seedViewState.modelSelector.classFullName,
+            code: cloneCode(seedViewState.modelSelector.code),
+            model: seedViewState.modelSelector.model,
+            models: viewData.models?.enabled ?? [],
+        },
+        displayStyleProps: {
+            id: seedViewState.displayStyle.id,
+            classFullName: seedViewState.displayStyle.classFullName,
+            code: seedViewState.displayStyle.code,
+            model: seedViewState.displayStyle.model,
+            jsonProperties: {
+                styles: extractDisplayStyle3d(viewData),
+            },
+        },
+    };
+    return SpatialViewState.createFromProps(props, iModel);
+}
+async function createDrawingViewState(iModel, viewData) {
+    const seedViewState = await fetchIModelViewData(iModel, DrawingViewState.classFullName);
+    const props = {
+        viewDefinitionProps: {
+            classFullName: seedViewState.classFullName,
+            id: seedViewState.id,
+            jsonProperties: {
+                viewDetails: {
+                    gridOrient: seedViewState.getGridOrientation(),
+                },
+            },
+            code: cloneCode(seedViewState.code),
+            model: seedViewState.model,
+            federationGuid: seedViewState.federationGuid,
+            categorySelectorId: seedViewState.categorySelector.id,
+            displayStyleId: seedViewState.displayStyle.id,
+            isPrivate: seedViewState.isPrivate,
+            description: seedViewState.description,
+            origin: viewData.origin,
+            delta: viewData.delta,
+            angle: viewData.angle,
+            baseModelId: viewData.baseModelId,
+        },
+        categorySelectorProps: {
+            classFullName: seedViewState.categorySelector.classFullName,
+            categories: viewData.categories?.enabled ?? [],
+            code: cloneCode(seedViewState.categorySelector.code),
+            model: seedViewState.categorySelector.model,
+            federationGuid: seedViewState.categorySelector.federationGuid,
+            id: seedViewState.categorySelector.id,
+        },
+        displayStyleProps: {
+            classFullName: seedViewState.displayStyle.classFullName,
+            id: seedViewState.displayStyle.id,
+            jsonProperties: {
+                styles: extractDisplayStyle(viewData, seedViewState),
+            },
+            code: cloneCode(seedViewState.displayStyle.code),
+            model: seedViewState.displayStyle.model,
+            federationGuid: seedViewState.displayStyle.federationGuid,
+        },
+    };
+    return DrawingViewState.createFromProps(props, iModel);
+}
+async function createSheetViewState(iModel, viewData) {
+    const seedViewState = await fetchIModelViewData(iModel, SheetViewState.classFullName);
+    const props = {
+        viewDefinitionProps: {
+            classFullName: seedViewState.classFullName,
+            id: seedViewState.id,
+            jsonProperties: {
+                viewDetails: {
+                    gridOrient: seedViewState.getGridOrientation(),
+                },
+            },
+            code: cloneCode(seedViewState.code),
+            model: seedViewState.model,
+            federationGuid: seedViewState.federationGuid,
+            categorySelectorId: seedViewState.categorySelector.id,
+            displayStyleId: seedViewState.displayStyle.id,
+            isPrivate: seedViewState.isPrivate,
+            description: seedViewState.description,
+            origin: viewData.origin,
+            delta: viewData.delta,
+            angle: viewData.angle,
+            baseModelId: viewData.baseModelId,
+        },
+        categorySelectorProps: {
+            classFullName: seedViewState.categorySelector.classFullName,
+            categories: viewData.categories?.enabled ?? [],
+            code: cloneCode(seedViewState.categorySelector.code),
+            model: seedViewState.categorySelector.model,
+            federationGuid: seedViewState.categorySelector.federationGuid,
+            id: seedViewState.categorySelector.id,
+        },
+        displayStyleProps: {
+            classFullName: seedViewState.displayStyle.classFullName,
+            id: seedViewState.displayStyle.id,
+            jsonProperties: {
+                styles: extractDisplayStyle(viewData, seedViewState),
+            },
+            code: cloneCode(seedViewState.displayStyle.code),
+            model: seedViewState.displayStyle.model,
+            federationGuid: seedViewState.displayStyle.federationGuid,
+        },
+        sheetProps: {
+            width: viewData.width,
+            height: viewData.height,
+            model: seedViewState.displayStyle.model,
+            classFullName: SheetViewState.classFullName,
+            code: {
+                spec: seedViewState.displayStyle.code.spec,
+                scope: seedViewState.displayStyle.code.scope,
+                value: "",
+            },
+        },
+        sheetAttachments: viewData.sheetAttachments,
+    };
+    return SheetViewState.createFromProps(props, iModel);
+}
+async function fetchIModelViewData(iModel, viewClassName) {
+    if (iModel.isBlankConnection()) {
+        return createEmptyViewState(iModel, viewClassName);
+    }
+    const viewId = await getDefaultViewIdFromClassName(iModel, viewClassName);
+    if (viewId === "") {
+        return createEmptyViewState(iModel, viewClassName);
+    }
+    return iModel.views.load(viewId);
+}
+function createEmptyViewState(iModel, viewClassName) {
+    const blankViewState = SpatialViewState.createBlank(iModel, { x: 0, y: 0, z: 0 }, { x: 0, y: 0, z: 0 });
+    if (viewClassName === SpatialViewState.classFullName) {
+        return blankViewState;
+    }
+    const blankViewStateProps = {
+        viewDefinitionProps: blankViewState.toJSON(),
+        categorySelectorProps: blankViewState.categorySelector.toJSON(),
+        displayStyleProps: blankViewState.displayStyle.toJSON(),
+    };
+    switch (viewClassName) {
+        case DrawingViewState.classFullName:
+            return DrawingViewState.createFromProps(blankViewStateProps, iModel);
+        case SheetViewState.classFullName:
+            return SheetViewState.createFromProps(blankViewStateProps, iModel);
+        default:
+            return blankViewState;
+    }
+}
+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);
+    if (viewProps.length > 0) {
+        return viewId;
+    }
+    // Return the first view we can find
+    const viewList = await iModel.views.getViewList({ from: viewClassName, wantPrivate: false });
+    if (viewList.length === 0) {
+        return "";
+    }
+    return viewList[0].id;
+}
+function cloneCode({ spec, scope, value }) {
+    return { spec, scope, value };
+}
+async function applyHiddenModelsAndCategories(iModel, viewState, savedViewRsp) {
+    if (isViewDataITwin3d(savedViewRsp.savedViewData)) {
+        if (!viewState.isSpatialView()) {
+            return;
+        }
+        const savedViewData = savedViewRsp.savedViewData.itwin3dView;
+        if (!savedViewData.categories?.disabled || !savedViewData.models?.disabled) {
+            return;
+        }
+        const [visibleCategories, visibleModels] = await Promise.all([
+            getMissingCategories(iModel, new Set(savedViewData.categories.disabled)),
+            getMissingModels(iModel, new Set(savedViewData.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) {
+        return;
+    }
+    const visibleCategories = await getMissingCategories(iModel, new Set(savedViewData.categories.disabled));
+    viewState.categorySelector.addCategories(visibleCategories);
+}

package/lib/experimental.d.ts

@@ -1,6 +1,6 @@
 export { createSavedViewOptions, type CreateSavedViewOptionsParams } from "./SavedViewTile/SavedViewOptions.js";
 export { SavedViewsExpandableBlockWidget } from "./SavedViewsWidget/SavedViewsExpandableBlockWidget.js";
 export { SavedViewsFolderWidget } from "./SavedViewsWidget/SavedViewsFolderWidget.js";
-export type { LegacySavedViewBase } from "./api/utilities/SavedViewTypes.js";
-export { applyExtensionsToViewport, augmentWithScheduleScript, translateLegacySavedViewToITwinJsViewState, translateSavedViewToLegacySavedView, } from "./api/utilities/translation/SavedViewTranslation.js";
-export { ModelCategoryOverrideProvider } from "./ui/viewlist/ModelCategoryOverrideProvider.js";
+export { applyExtensionsToViewport } from "./translation/SavedViewTranslation.js";
+export { createViewState } from "./createViewState.js";
+export { ModelCategoryOverrideProvider } from "./ModelCategoryOverrideProvider.js";

package/lib/experimental.js

@@ -5,5 +5,6 @@
 export { createSavedViewOptions } from "./SavedViewTile/SavedViewOptions.js";
 export { SavedViewsExpandableBlockWidget } from "./SavedViewsWidget/SavedViewsExpandableBlockWidget.js";
 export { SavedViewsFolderWidget } from "./SavedViewsWidget/SavedViewsFolderWidget.js";
-export { applyExtensionsToViewport, augmentWithScheduleScript, translateLegacySavedViewToITwinJsViewState, translateSavedViewToLegacySavedView, } from "./api/utilities/translation/SavedViewTranslation.js";
-export { ModelCategoryOverrideProvider } from "./ui/viewlist/ModelCategoryOverrideProvider.js";
+export { applyExtensionsToViewport } from "./translation/SavedViewTranslation.js";
+export { createViewState } from "./createViewState.js";
+export { ModelCategoryOverrideProvider } from "./ModelCategoryOverrideProvider.js";

package/lib/translation/SavedViewTranslation.d.ts

@@ -0,0 +1,4 @@
+import { type Viewport } from "@itwin/core-frontend";
+import type { SavedView } from "../SavedView.js";
+/** Apply extension data (overrides) onto the supplied viewport. Only works with legacy-formatted extension data. */
+export declare function applyExtensionsToViewport(viewport: Viewport, savedView: SavedView): Promise<void>;

package/lib/translation/SavedViewTranslation.js

@@ -0,0 +1,25 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+import { EmphasizeElements } from "@itwin/core-frontend";
+import { SavedViewsExtensionHandlers } from "./SavedViewsExtensionHandlers.js";
+/** Apply extension data (overrides) onto the supplied viewport. Only works with legacy-formatted extension data. */
+export async function applyExtensionsToViewport(viewport, savedView) {
+    // Clear the current if there's any (this should always happen, even if there are no extensions)
+    if (EmphasizeElements.get(viewport)) {
+        EmphasizeElements.clear(viewport);
+        viewport.isFadeOutActive = false;
+    }
+    const defaultHandlers = [
+        SavedViewsExtensionHandlers.EmphasizeElements,
+        SavedViewsExtensionHandlers.PerModelCategoryVisibility,
+        SavedViewsExtensionHandlers.VisibilityOverride,
+    ];
+    for (const extHandler of defaultHandlers) {
+        const extData = savedView.extensions?.get(extHandler.extensionName);
+        if (extData) {
+            await extHandler.onViewApply(extData, viewport);
+        }
+    }
+}

package/lib/{api/utilities → translation}/SavedViewTypes.d.ts

@@ -1,13 +1,27 @@
 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 "../../ui/viewlist/ModelCategoryOverrideProvider.js";
-/** Per Model Category Visibility Props */
+import type { ModelCategoryOverrideProviderProps } from "../ModelCategoryOverrideProvider.js";
+export interface LegacySavedView3d extends LegacySavedViewBase {
+    displayStyleProps: DisplayStyle3dProps;
+    modelSelectorProps: ModelSelectorProps;
+    modelExtents?: Range3dProps;
+    viewDefinitionProps: SpatialViewDefinitionProps;
+    perModelCategoryVisibility?: PerModelCategoryVisibilityProps[];
+    hiddenModels?: Id64Array;
+}
 export interface PerModelCategoryVisibilityProps {
     modelId: string;
     categoryId: string;
     visible: boolean;
 }
+export interface LegacySavedView2d extends LegacySavedViewBase {
+    viewDefinitionProps: ViewDefinition2dProps;
+    displayStyleProps: DisplayStyleProps;
+    sectionDrawing?: SectionDrawingViewProps;
+    sheetProps?: SheetProps;
+    sheetAttachments?: Id64Array;
+}
 export interface LegacySavedViewBase {
     id: string;
     name: string;
@@ -24,24 +38,6 @@ export interface LegacySavedViewBase {
     hiddenCategories?: Id64Array;
     extensions?: Map<string, string>;
 }
-export interface LegacySavedView2d extends LegacySavedViewBase {
-    viewDefinitionProps: ViewDefinition2dProps;
-    displayStyleProps: DisplayStyleProps;
-    sectionDrawing?: SectionDrawingViewProps;
-    sheetProps?: SheetProps;
-    sheetAttachments?: Id64Array;
-}
-/**
- * Format for a saved view setting instance in the service
- */
-export interface LegacySavedView3d extends LegacySavedViewBase {
-    displayStyleProps: DisplayStyle3dProps;
-    modelSelectorProps: ModelSelectorProps;
-    modelExtents?: Range3dProps;
-    viewDefinitionProps: SpatialViewDefinitionProps;
-    perModelCategoryVisibility?: PerModelCategoryVisibilityProps[];
-    hiddenModels?: Id64Array;
-}
 export interface LegacyTag {
     name: string;
     createdByUserId: string;

package/lib/{api/utilities/translation → translation}/SavedViewsExtensionHandlers.js

@@ -1,5 +1,5 @@
 import { EmphasizeElements, PerModelCategoryVisibility } from "@itwin/core-frontend";
-import { ModelCategoryOverrideProvider } from "../../../ui/viewlist/ModelCategoryOverrideProvider.js";
+import { ModelCategoryOverrideProvider } from "../ModelCategoryOverrideProvider.js";
 import { extractEmphasizeElements, extractPerModelCategoryVisibility, extractVisibilityOverride, } from "./extensionExtractor.js";
 /**
  * Collection of default extension handlers

package/lib/{api/utilities/translation → translation}/extensionExtractor.d.ts

@@ -1,6 +1,6 @@
 import { type EmphasizeElementsProps } from "@itwin/core-common";
-import { ModelCategoryOverrideProviderProps } from "../../../ui/viewlist/ModelCategoryOverrideProvider.js";
-import type { PerModelCategoryVisibilityProps } from "../SavedViewTypes.js";
+import { ModelCategoryOverrideProviderProps } from "../ModelCategoryOverrideProvider.js";
+import type { PerModelCategoryVisibilityProps } from "./SavedViewTypes.js";
 /**
  * Extracts the EmphasizeElementsProps from string data in an extension
  * @param extensionData

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/saved-views-react",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "license": "MIT",
   "repository": {
     "type": "git",

package/lib/api/clients/ISavedViewsClient.d.ts

@@ -1,9 +0,0 @@
-import type { LegacySavedView3d, LegacySavedView2d, LegacySavedViewBase } from "../utilities/SavedViewTypes.js";
-/** Is a 3d saved view */
-export declare function isSavedView3d(view: LegacySavedViewBase): view is LegacySavedView3d;
-/** Is a 3d spatial saved view */
-export declare function isSpatialSavedView(view: LegacySavedViewBase): view is LegacySavedView3d;
-/** Is a 2d drawing saved view */
-export declare function isDrawingSavedView(view: LegacySavedViewBase): view is LegacySavedView2d;
-/** Is a 2d sheet saved view */
-export declare function isSheetSavedView(view: LegacySavedViewBase): view is LegacySavedView2d;

package/lib/api/clients/ISavedViewsClient.js

@@ -1,16 +0,0 @@
-/** Is a 3d saved view */
-export function isSavedView3d(view) {
-    return !view.is2d;
-}
-/** Is a 3d spatial saved view */
-export function isSpatialSavedView(view) {
-    return ((view.is2d === undefined || !view.is2d) && "modelSelectorProps" in view);
-}
-/** Is a 2d drawing saved view */
-export function isDrawingSavedView(view) {
-    return view.is2d !== undefined && view.is2d && !("sheetProps" in view);
-}
-/** Is a 2d sheet saved view */
-export function isSheetSavedView(view) {
-    return view.is2d !== undefined && view.is2d && "sheetProps" in view;
-}

package/lib/api/utilities/translation/SavedViewTranslation.d.ts

@@ -1,26 +0,0 @@
-import { SpatialViewState, type IModelConnection, type ViewState, type Viewport } from "@itwin/core-frontend";
-import { type SavedViewRepresentation } from "@itwin/saved-views-client";
-import type { LegacySavedView3d, LegacySavedViewBase } from "../SavedViewTypes.js";
-/**
- * Converts a legacy saved view (response) to an iTwin.js ViewState.
- * @param legacySavedView a saved view response that includes a legacy view
- * @param iModel the {@linkcode IModelConnection} for the saved view; used to query for additional information
- * @param useHiddenModelsAndCategories when explicitly set to `false`, the returned {@linkcode ViewState} does not have
- *                                     populated category and model selectors
- * @returns a {@linkcode ViewState} with the saved view applied
- */
-export declare function translateLegacySavedViewToITwinJsViewState(legacySavedView: LegacySavedViewBase, iModel: IModelConnection, useHiddenModelsAndCategories?: boolean): Promise<ViewState | undefined>;
-export declare function augmentWithScheduleScript(iModel: IModelConnection, savedView: LegacySavedView3d, viewState: SpatialViewState): Promise<boolean>;
-/**
- * Apply extension data (overrides) onto the supplied viewport. Only works with legacy-formatted extension data.
- * @param viewport The {@link Viewport} used to display the saved view and iModel.
- * @param legacySavedView A saved view response that includes a legacy view.
- */
-export declare function applyExtensionsToViewport(viewport: Viewport, legacySavedView: LegacySavedViewBase): Promise<void>;
-/**
-* Creates legacy saved view data from a saved view response.
-* @param savedViewResponse A saved view response with or without a legacy view.
-* @param iModel The {@link IModelConnection} for the saved view; used to query for additional information.
-* @resolves The saved views formatted as a legacy SavedViewBase.
-*/
-export declare function translateSavedViewToLegacySavedView(iModel: IModelConnection, savedViewResponse: SavedViewRepresentation): Promise<LegacySavedViewBase>;

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

@@ -1,246 +0,0 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-import { IModelReadRpcInterface } from "@itwin/core-common";
-import { DisplayStyle3dState, DrawingViewState, EmphasizeElements, SheetViewState, SpatialViewState, } from "@itwin/core-frontend";
-import { isViewDataITwin3d, isViewDataITwinDrawing, isViewDataITwinSheet, } from "@itwin/saved-views-client";
-import { getMissingCategories, getMissingModels } from "../../../captureSavedViewData.js";
-import { isDrawingSavedView, isSavedView3d, isSheetSavedView, isSpatialSavedView, } from "../../clients/ISavedViewsClient.js";
-import { SavedViewsExtensionHandlers } from "./SavedViewsExtensionHandlers.js";
-import { savedViewITwin3dToLegacy3dSavedView, savedViewItwinDrawingToLegacyDrawingView, savedViewItwinSheetToLegacySheetSavedView, } from "./viewExtractorSavedViewToLegacySavedView.js";
-/**
- * Converts a legacy saved view (response) to an iTwin.js ViewState.
- * @param legacySavedView a saved view response that includes a legacy view
- * @param iModel the {@linkcode IModelConnection} for the saved view; used to query for additional information
- * @param useHiddenModelsAndCategories when explicitly set to `false`, the returned {@linkcode ViewState} does not have
- *                                     populated category and model selectors
- * @returns a {@linkcode ViewState} with the saved view applied
- */
-export async function translateLegacySavedViewToITwinJsViewState(legacySavedView, iModel, useHiddenModelsAndCategories = true) {
-    const viewState = await createViewState(iModel, legacySavedView);
-    if (viewState && useHiddenModelsAndCategories) {
-        await applyHiddenModelsAndCategories(iModel, viewState, legacySavedView);
-    }
-    return viewState;
-}
-async function createViewState(iModel, savedView) {
-    if (isSpatialSavedView(savedView)) {
-        return createSpatialViewState(iModel, savedView);
-    }
-    if (isDrawingSavedView(savedView)) {
-        return createDrawingViewState(iModel, savedView);
-    }
-    if (isSheetSavedView(savedView)) {
-        return createSheetViewState(iModel, savedView);
-    }
-    return undefined;
-}
-async function createSpatialViewState(iModel, savedView) {
-    const props = {
-        viewDefinitionProps: savedView.viewDefinitionProps,
-        categorySelectorProps: savedView.categorySelectorProps,
-        modelSelectorProps: savedView.modelSelectorProps,
-        displayStyleProps: savedView.displayStyleProps,
-    };
-    const viewState = SpatialViewState.createFromProps(props, iModel);
-    await viewState.load();
-    return viewState;
-}
-async function createDrawingViewState(iModelConnection, savedView) {
-    const props = {
-        viewDefinitionProps: savedView.viewDefinitionProps,
-        categorySelectorProps: savedView.categorySelectorProps,
-        displayStyleProps: savedView.displayStyleProps,
-    };
-    const viewState = DrawingViewState.createFromProps(props, iModelConnection);
-    await viewState.load();
-    return viewState;
-}
-async function createSheetViewState(iModelConnection, savedView) {
-    if (savedView.sheetProps === undefined || savedView.sheetAttachments === undefined) {
-        return undefined;
-    }
-    const props = {
-        viewDefinitionProps: savedView.viewDefinitionProps,
-        categorySelectorProps: savedView.categorySelectorProps,
-        displayStyleProps: savedView.displayStyleProps,
-        sheetProps: savedView.sheetProps,
-        sheetAttachments: savedView.sheetAttachments,
-    };
-    const viewState = SheetViewState.createFromProps(props, iModelConnection);
-    await viewState.load();
-    return viewState;
-}
-async function applyHiddenModelsAndCategories(iModel, viewState, savedView) {
-    if (!legacyViewHasValidHiddenModelsAndCategories(savedView)) {
-        return;
-    }
-    const visible = await getVisibleModelsAndCategories(savedView, iModel);
-    if (visible.categories) {
-        viewState.categorySelector.addCategories(visible.categories);
-    }
-    if (viewState.isSpatialView() && visible.models) {
-        viewState.modelSelector.addModels(visible.models);
-    }
-    await viewState.load();
-}
-function legacyViewHasValidHiddenModelsAndCategories(savedView) {
-    if (isSavedView3d(savedView)) {
-        return !!(savedView.hiddenCategories && savedView.hiddenModels);
-    }
-    return !!savedView.hiddenCategories;
-}
-async function getVisibleModelsAndCategories(savedView, iModel) {
-    return {
-        models: isSavedView3d(savedView) ? await getMissingModels(iModel, new Set(savedView.hiddenModels)) : undefined,
-        categories: await getMissingCategories(iModel, new Set(savedView.hiddenCategories)),
-    };
-}
-export async function augmentWithScheduleScript(iModel, savedView, viewState) {
-    if (!savedView.displayStyleProps.jsonProperties?.styles?.timePoint) {
-        return false;
-    }
-    try {
-        const viewList = await iModel.views.getViewList({ wantPrivate: false });
-        const viewStates = await Promise.all(viewList.map(({ id }) => iModel.views.load(id)));
-        const scheduleViewState = viewStates.find(({ scheduleScript }) => scheduleScript && !scheduleScript.duration.isNull);
-        if (scheduleViewState) {
-            savedView.displayStyleProps.id = scheduleViewState.id;
-            viewState.displayStyle = new DisplayStyle3dState(savedView.displayStyleProps, iModel, scheduleViewState.displayStyle);
-        }
-    }
-    catch {
-        return false;
-    }
-    return true;
-}
-/**
- * Apply extension data (overrides) onto the supplied viewport. Only works with legacy-formatted extension data.
- * @param viewport The {@link Viewport} used to display the saved view and iModel.
- * @param legacySavedView A saved view response that includes a legacy view.
- */
-export async function applyExtensionsToViewport(viewport, legacySavedView) {
-    // Clear the current if there's any (this should always happen, even if there are no extensions)
-    if (EmphasizeElements.get(viewport)) {
-        EmphasizeElements.clear(viewport);
-        viewport.isFadeOutActive = false;
-    }
-    const defaultHandlers = [
-        SavedViewsExtensionHandlers.EmphasizeElements,
-        SavedViewsExtensionHandlers.PerModelCategoryVisibility,
-        SavedViewsExtensionHandlers.VisibilityOverride,
-    ];
-    for (const extHandler of defaultHandlers) {
-        const extData = legacySavedView.extensions?.get(extHandler.extensionName);
-        if (extData) {
-            await extHandler.onViewApply(extData, viewport);
-        }
-    }
-}
-/**
-* Creates legacy saved view data from a saved view response.
-* @param savedViewResponse A saved view response with or without a legacy view.
-* @param iModel The {@link IModelConnection} for the saved view; used to query for additional information.
-* @resolves The saved views formatted as a legacy SavedViewBase.
-*/
-export async function translateSavedViewToLegacySavedView(iModel, savedViewResponse) {
-    const savedViewData = savedViewResponse.savedViewData;
-    // If the legacy view already exists, use that; otherwise, use extraction code to get the legacy view
-    let legacySavedView;
-    if (savedViewData.legacyView) {
-        legacySavedView = savedViewData.legacyView;
-        if (isSavedView3d(legacySavedView)) {
-            legacySavedView.modelSelectorProps.models = legacySavedView.modelSelectorProps.models.filter((model) => !!model);
-        }
-    }
-    else if (isViewDataITwin3d(savedViewData)) {
-        const viewState = await fetchIModelViewData(iModel, ViewTypes.ViewDefinition3d);
-        legacySavedView = savedViewITwin3dToLegacy3dSavedView(savedViewResponse, viewState);
-    }
-    else if (isViewDataITwinDrawing(savedViewData)) {
-        const viewState = await fetchIModelViewData(iModel, ViewTypes.DrawingViewDefinition);
-        legacySavedView = savedViewItwinDrawingToLegacyDrawingView(savedViewResponse, viewState);
-    }
-    else if (isViewDataITwinSheet(savedViewData)) {
-        const viewState = await fetchIModelViewData(iModel, ViewTypes.SheetViewDefinition);
-        legacySavedView = savedViewItwinSheetToLegacySheetSavedView(savedViewResponse, viewState);
-    }
-    else {
-        throw new Error("Could not translate itwin-saved-views API response to a SavedViewBaseSetting");
-    }
-    // Append all extensions to the saved view
-    legacySavedView.extensions = new Map();
-    for (const { extensionName, data } of savedViewResponse.extensions ?? []) {
-        if (extensionName && data) {
-            legacySavedView.extensions.set(extensionName, data);
-        }
-    }
-    return legacySavedView;
-}
-async function fetchIModelViewData(iModel, viewClassName) {
-    if (iModel.isBlankConnection()) {
-        return manufactureEmptyViewState(iModel, viewClassName);
-    }
-    const viewId = await getDefaultViewIdFromClassName(iModel, viewClassName);
-    if (viewId === "") {
-        return manufactureEmptyViewState(iModel, viewClassName);
-    }
-    return iModel.views.load(viewId);
-}
-function manufactureEmptyViewState(iModel, viewClassName) {
-    const blankViewState = SpatialViewState.createBlank(iModel, { x: 0, y: 0, z: 0 }, { x: 0, y: 0, z: 0 });
-    if (viewClassName === ViewTypes.ViewDefinition3d) {
-        return blankViewState;
-    }
-    const blankViewStateProps = {
-        viewDefinitionProps: blankViewState.toJSON(),
-        categorySelectorProps: blankViewState.categorySelector.toJSON(),
-        displayStyleProps: blankViewState.displayStyle.toJSON(),
-    };
-    switch (viewClassName) {
-        case ViewTypes.DrawingViewDefinition:
-            return DrawingViewState.createFromProps(blankViewStateProps, iModel);
-        case ViewTypes.SheetViewDefinition:
-            return SheetViewState.createFromProps(blankViewStateProps, iModel);
-        default:
-            return blankViewState;
-    }
-}
-async function getDefaultViewIdFromClassName(iModel, savedViewType) {
-    let viewFullName = undefined;
-    switch (savedViewType) {
-        case ViewTypes.ViewDefinition3d:
-            viewFullName = SpatialViewState.classFullName;
-            break;
-        case ViewTypes.DrawingViewDefinition:
-            viewFullName = DrawingViewState.classFullName;
-            break;
-        case ViewTypes.SheetViewDefinition:
-            viewFullName = SheetViewState.classFullName;
-            break;
-        default:
-            throw new Error("Unrecognized View Type");
-    }
-    // Check validity of default view
-    const viewId = await iModel.views.queryDefaultViewId();
-    const params = {};
-    params.from = viewFullName;
-    params.where = "ECInstanceId=" + viewId;
-    const viewProps = await IModelReadRpcInterface.getClient().queryElementProps(iModel.getRpcProps(), params);
-    if (viewProps.length > 0) {
-        return viewId;
-    }
-    // Return the first view we can find
-    const viewList = await iModel.views.getViewList({ from: viewFullName, wantPrivate: false });
-    if (viewList.length === 0) {
-        return "";
-    }
-    return viewList[0].id;
-}
-var ViewTypes;
-(function (ViewTypes) {
-    ViewTypes[ViewTypes["SheetViewDefinition"] = 0] = "SheetViewDefinition";
-    ViewTypes[ViewTypes["ViewDefinition3d"] = 1] = "ViewDefinition3d";
-    ViewTypes[ViewTypes["DrawingViewDefinition"] = 2] = "DrawingViewDefinition";
-})(ViewTypes || (ViewTypes = {}));

package/lib/api/utilities/translation/viewExtractorSavedViewToLegacySavedView.d.ts

@@ -1,18 +0,0 @@
-import { SheetViewState, type DrawingViewState, type SpatialViewState } from "@itwin/core-frontend";
-import type { SavedViewRepresentation } from "@itwin/saved-views-client";
-import type { LegacySavedView3d, LegacySavedView2d } from "../SavedViewTypes.js";
-export declare function savedViewITwin3dToLegacy3dSavedView(savedViewRsp: SavedViewRepresentation, seedSpatialViewState: SpatialViewState): LegacySavedView3d;
-/**
- * Transform a ViewDataITwinDrawing into a legacy SavedView if possible
- * @param savedViewRsp
- * @param iModelViewData
- * @returns SavedView2d
- */
-export declare function savedViewItwinDrawingToLegacyDrawingView(savedViewRsp: SavedViewRepresentation, seedDrawingViewState: DrawingViewState): LegacySavedView2d;
-/**
- * Transform a ViewDataITwinSheet into a legacy SavedView if possible
- * @param savedViewRsp
- * @param seedSheetViewState
- * @returns SavedView2d
- */
-export declare function savedViewItwinSheetToLegacySheetSavedView(savedViewRsp: SavedViewRepresentation, seedSheetViewState: SheetViewState): LegacySavedView2d;

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

@@ -1,242 +0,0 @@
-import { SheetViewState } from "@itwin/core-frontend";
-import { extractClipVectors } from "./clipVectorsExtractor.js";
-import { extractDisplayStyle, extractDisplayStyle3d } from "./displayStyleExtractor.js";
-export function savedViewITwin3dToLegacy3dSavedView(savedViewRsp, seedSpatialViewState) {
-    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) : undefined,
-        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 ?? {},
-            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;
-}
-function appendHiddenModelsTo3dLegacySavedView(view, legacyView) {
-    if (view.models?.disabled) {
-        legacyView.hiddenModels = view.models?.disabled;
-    }
-}
-/**
- * Transform a ViewDataITwinDrawing into a legacy SavedView if possible
- * @param savedViewRsp
- * @param iModelViewData
- * @returns SavedView2d
- */
-export function savedViewItwinDrawingToLegacyDrawingView(savedViewRsp, seedDrawingViewState) {
-    const iTwinDrawingView = savedViewRsp.savedViewData.itwinDrawingView;
-    seedDrawingViewState.displayStyle;
-    const legacyView = {
-        id: savedViewRsp.id,
-        is2d: true,
-        groupId: savedViewRsp._links.group ? extractIdFromHref(savedViewRsp._links.group.href) : undefined,
-        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(),
-                },
-            },
-            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) {
-    const itwinSheetView = savedViewRsp.savedViewData.itwinSheetView;
-    const legacyView = {
-        id: savedViewRsp.id,
-        is2d: true,
-        groupId: savedViewRsp._links.group ? extractIdFromHref(savedViewRsp._links.group.href) : undefined,
-        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;
-}
-/**
- * Extract all the tags.
- * @param creator href for the creator
- * @param tags the list of tags in the saved view
- */
-function extractTags(creator, tags) {
-    const createdByUserId = extractIdFromHref(creator) ?? "";
-    return tags?.map((tag) => ({ name: tag.displayName, createdByUserId }));
-}
-function extractIdFromHref(href) {
-    return href.split("/").pop();
-}
-function appendHiddenCategoriesToLegacyView(iTwinView, legacyView) {
-    if (iTwinView.categories?.disabled) {
-        legacyView.hiddenCategories = iTwinView.categories.disabled;
-    }
-}