@itwin/saved-views-react 1.2.1 → 1.2.3

package/lib/captureSavedViewData.js

@@ -2,6 +2,7 @@ import { QueryRowFormat } from "@itwin/core-common";
 import { extensionHandlers } from "./translation/SavedViewsExtensionHandlers.js";
 import { extractClipVectorsFromLegacy } from "./translation/clipVectorsLegacyExtractor.js";
 import { extractDisplayStyle2dFromLegacy, extractDisplayStyle3dFromLegacy, } from "./translation/displayStyleExtractor.js";
+import { extractViewDetails2dFromLegacy, extractViewDetails3dFromLegacy, } from "./translation/viewDetailsLegacyExtractor.js";
 /**
  * Captures current {@link Viewport} state into serializable format. The returned
  * data can later be used to restore viewport's view.
@@ -87,6 +88,7 @@ function createSpatialSavedViewObject(vp, hiddenCategories, hiddenModels) {
         },
         displayStyle: extractDisplayStyle3dFromLegacy(displayStyleProps),
         clipVectors: extractClipVectorsFromLegacy(viewDefinitionProps),
+        viewDetails: extractViewDetails3dFromLegacy(viewDefinitionProps),
     };
 }
 function toArrayVector3d(xyzProps) {
@@ -117,6 +119,7 @@ function createDrawingSavedViewObject(vp, hiddenCategories) {
             enabled: viewState.categorySelector.toJSON().categories,
             disabled: hiddenCategories,
         },
+        viewDetails: extractViewDetails2dFromLegacy(viewDefinitionProps),
     };
 }
 function createSheetSavedViewObject(vp, hiddenCategories) {
@@ -136,6 +139,7 @@ function createSheetSavedViewObject(vp, hiddenCategories) {
         width: viewState.sheetSize.x,
         height: viewState.sheetSize.y,
         sheetAttachments: viewState.attachmentIds,
+        viewDetails: extractViewDetails2dFromLegacy(viewDefinitionProps),
     };
 }
 function toArrayVector2d(xyzProps) {

package/lib/createViewState.js

@@ -7,6 +7,7 @@ import { DrawingViewState, SheetViewState, SpatialViewState, } from "@itwin/core
 import { queryMissingCategories, queryMissingModels, } from "./captureSavedViewData.js";
 import { extractClipVectors } from "./translation/clipVectorsExtractor.js";
 import { extractDisplayStyle, extractDisplayStyle3d, } from "./translation/displayStyleExtractor.js";
+import { extractViewDetails2d, extractViewDetails3d } from "./translation/viewDetailsExtractor.js";
 /**
  * Creates {@link ViewStateProps} object out of Saved View data. It provides a lower-level
  * access to view data for advanced use.
@@ -104,7 +105,17 @@ async function createSpatialViewStateProps(iModel, viewData) {
             angles: viewData.angles,
             camera: viewData.camera ?? new Camera(),
             jsonProperties: {
-                viewDetails: extractClipVectors(viewData),
+                viewDetails: {
+                    acs: seedViewState.getAuxiliaryCoordinateSystemId(),
+                    aspectSkew: seedViewState.getAspectRatioSkew(),
+                    gridOrient: seedViewState.getGridOrientation(),
+                    gridPerRef: seedViewState.getGridsPerRef(),
+                    gridSpaceX: seedViewState.getGridSpacing().x,
+                    gridSpaceY: seedViewState.getGridSpacing().y,
+                    disable3dManipulations: !seedViewState.allow3dManipulations,
+                    ...extractClipVectors(viewData),
+                    ...extractViewDetails3d(viewData),
+                },
             },
             classFullName: seedViewState.classFullName,
             code: seedViewState.code,
@@ -150,7 +161,14 @@ async function createDrawingViewStateProps(iModel, viewData) {
             id: seedViewState.id,
             jsonProperties: {
                 viewDetails: {
+                    acs: seedViewState.getAuxiliaryCoordinateSystemId(),
+                    aspectSkew: seedViewState.getAspectRatioSkew(),
                     gridOrient: seedViewState.getGridOrientation(),
+                    gridPerRef: seedViewState.getGridsPerRef(),
+                    gridSpaceX: seedViewState.getGridSpacing().x,
+                    gridSpaceY: seedViewState.getGridSpacing().y,
+                    ...extractClipVectors(viewData),
+                    ...extractViewDetails2d(viewData),
                 },
             },
             code: cloneCode(seedViewState.code),
@@ -198,7 +216,14 @@ async function createSheetViewStateProps(iModel, viewData) {
             id: seedViewState.id,
             jsonProperties: {
                 viewDetails: {
+                    acs: seedViewState.getAuxiliaryCoordinateSystemId(),
+                    aspectSkew: seedViewState.getAspectRatioSkew(),
                     gridOrient: seedViewState.getGridOrientation(),
+                    gridPerRef: seedViewState.getGridsPerRef(),
+                    gridSpaceX: seedViewState.getGridSpacing().x,
+                    gridSpaceY: seedViewState.getGridSpacing().y,
+                    ...extractClipVectors(viewData),
+                    ...extractViewDetails2d(viewData),
                 },
             },
             code: cloneCode(seedViewState.code),

package/lib/translation/SavedViewTypes.d.ts

@@ -1,5 +1,5 @@
 import type { Id64Array } from "@itwin/core-bentley";
-import type { CategorySelectorProps, DisplayStyle3dProps, DisplayStyleProps, EmphasizeElementsProps, ModelSelectorProps, SectionDrawingViewProps, SheetProps, SpatialViewDefinitionProps, ViewDefinition2dProps } from "@itwin/core-common";
+import type { CategorySelectorProps, DisplayStyle3dProps, DisplayStyleProps, EmphasizeElementsProps, ModelSelectorProps, SectionDrawingViewProps, SheetProps, SpatialViewDefinitionProps, ViewDefinition2dProps, ViewDetails3dProps, ViewDetailsProps } from "@itwin/core-common";
 import type { Range3dProps } from "@itwin/core-geometry";
 export interface LegacySavedView3d extends LegacySavedViewBase {
     displayStyleProps: DisplayStyle3dProps;
@@ -7,6 +7,7 @@ export interface LegacySavedView3d extends LegacySavedViewBase {
     viewDefinitionProps: SpatialViewDefinitionProps;
     perModelCategoryVisibility?: PerModelCategoryVisibilityProps[];
     hiddenModels?: Id64Array;
+    viewDetails?: ViewDetails3dProps;
 }
 export interface PerModelCategoryVisibilityProps {
     modelId: string;
@@ -20,6 +21,7 @@ export interface LegacySavedView2d extends LegacySavedViewBase {
     sheetProps?: SheetProps;
     sheetAttachments?: Id64Array;
     modelExtents?: Range3dProps;
+    viewDetails?: ViewDetailsProps;
 }
 export interface LegacySavedViewBase {
     id: string;

package/lib/translation/clipVectorsExtractor.d.ts

@@ -1,3 +1,5 @@
+import { type ExtractionFunc } from "./extractionUtilities.js";
+export declare const clipVectorMappings: ExtractionFunc<void, void>[];
 /**
  * Extracts the clip vectors from a legacy view
  * @param input

package/lib/translation/clipVectorsExtractor.js

@@ -28,7 +28,7 @@ const clipPlaneMappings = [
 const clipPrimitivePlaneMappings = [
     extractObject([extractArray2d(clipPlaneMappings, "clips"), extractBoolean("invisible")], "planes"),
 ];
-const clipVectorMappings = [
+export const clipVectorMappings = [
     extractArrayConditionally([
         {
             discriminator: "planes",

package/lib/translation/clipVectorsLegacyExtractor.d.ts

@@ -1,3 +1,5 @@
 import type { SpatialViewDefinitionProps } from "@itwin/core-common";
 import type { ClipPrimitivePlaneProps, ClipPrimitiveShapeProps } from "@itwin/saved-views-client";
+export declare function isValidClipPrimitive(value: ClipPrimitivePlaneProps | ClipPrimitiveShapeProps): boolean;
 export declare function extractClipVectorsFromLegacy(input: SpatialViewDefinitionProps): Array<ClipPrimitivePlaneProps | ClipPrimitiveShapeProps> | undefined;
+export declare const clipVectorLegacyMappings: ((input: any, output: any) => void)[];

package/lib/translation/clipVectorsLegacyExtractor.js

@@ -1,4 +1,8 @@
 import { applyExtraction, extractArray2d, extractArrayConditionally, extractBoolean, extractNumber, extractObject, extractSimpleArray, simpleTypeOf, } from "./extractionUtilities.js";
+export function isValidClipPrimitive(value) {
+    const hasPlanes = "planes" in value;
+    return (!hasPlanes || (value.planes && Object.keys(value.planes).length > 0));
+}
 export function extractClipVectorsFromLegacy(input) {
     const viewDetails = input.jsonProperties?.viewDetails;
     if (!viewDetails || !("clip" in viewDetails)) {
@@ -6,10 +10,7 @@ export function extractClipVectorsFromLegacy(input) {
     }
     const output = {};
     applyExtraction(viewDetails, output, clipVectorLegacyMappings);
-    output.clipVectors = output.clipVectors?.filter((value) => {
-        const hasPlanes = "planes" in value;
-        return (!hasPlanes || (value.planes && Object.keys(value.planes).length > 0));
-    });
+    output.clipVectors = output.clipVectors?.filter(isValidClipPrimitive);
     return output.clipVectors;
 }
 const clipPlaneLegacyMappings = [
@@ -31,7 +32,7 @@ const clipPrimitiveShapeLegacyMappings = [
         extractBoolean("invisible"),
     ], "shape"),
 ];
-const clipVectorLegacyMappings = [
+export const clipVectorLegacyMappings = [
     extractArrayConditionally([
         { discriminator: "planes", mappings: clipPrimitivePlaneLegacyMappings },
         { discriminator: "shape", mappings: clipPrimitiveShapeLegacyMappings },

package/lib/translation/viewDetailsExtractor.d.ts

@@ -0,0 +1,4 @@
+import type { ViewITwin2d, ViewITwin3d } from "@itwin/saved-views-client";
+export declare const extractViewDetails2d: (input: ViewITwin2d) => any;
+export declare const extractViewDetails3d: (input: ViewITwin3d) => any;
+export declare const viewDetailsMappings: import("./extractionUtilities.js").ExtractionFunc<void, void>[];

package/lib/translation/viewDetailsExtractor.js

@@ -0,0 +1,40 @@
+import { clipVectorMappings } from "./clipVectorsExtractor.js";
+import { applyExtraction, extractArray, extractBoolean, extractNumber, extractSimpleArray, extractString, simpleTypeOf, } from "./extractionUtilities.js";
+export const extractViewDetails2d = (input) => {
+    const viewDetails = input.viewDetails;
+    if (!viewDetails) {
+        return undefined;
+    }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const output = {};
+    applyExtraction(viewDetails, output, viewDetailsMappings);
+    return output;
+};
+export const extractViewDetails3d = (input) => {
+    const viewDetails = input.viewDetails;
+    if (!viewDetails) {
+        return undefined;
+    }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const output = {};
+    applyExtraction(viewDetails, output, viewDetails3dMappings);
+    return output;
+};
+export const viewDetailsMappings = [
+    extractString("acs"),
+    extractNumber("aspectSkew"),
+    extractNumber("gridOrient"), // enum GridOrientationType
+    extractNumber("gridPerRef"),
+    extractNumber("gridSpaceX"),
+    extractNumber("gridSpaceY"),
+    // clip is already extracted in clipVectors property of the view
+];
+const modelClipGroupMappings = [
+    ...clipVectorMappings,
+    extractSimpleArray(simpleTypeOf("string"), "models"),
+];
+const viewDetails3dMappings = [
+    ...viewDetailsMappings,
+    extractBoolean("disable3dManipulations"),
+    extractArray(modelClipGroupMappings, "modelClipGroups"),
+];

package/lib/translation/viewDetailsLegacyExtractor.d.ts

@@ -0,0 +1,4 @@
+import type { SpatialViewDefinitionProps, ViewDefinition2dProps } from "@itwin/core-common";
+import type { ViewDetails3dProps, ViewDetailsProps } from "@itwin/saved-views-client";
+export declare function extractViewDetails2dFromLegacy(input: ViewDefinition2dProps): ViewDetailsProps | undefined;
+export declare function extractViewDetails3dFromLegacy(input: SpatialViewDefinitionProps): ViewDetails3dProps | undefined;

package/lib/translation/viewDetailsLegacyExtractor.js

@@ -0,0 +1,34 @@
+import { clipVectorLegacyMappings, isValidClipPrimitive, } from "./clipVectorsLegacyExtractor.js";
+import { applyExtraction, extractArray, extractBoolean, extractSimpleArray, simpleTypeOf, } from "./extractionUtilities.js";
+import { viewDetailsMappings } from "./viewDetailsExtractor.js";
+export function extractViewDetails2dFromLegacy(input) {
+    const viewDetails = input.jsonProperties?.viewDetails;
+    if (!viewDetails) {
+        return undefined;
+    }
+    const output = {};
+    applyExtraction(viewDetails, output, viewDetailsMappings);
+    return output;
+}
+export function extractViewDetails3dFromLegacy(input) {
+    const viewDetails = input.jsonProperties?.viewDetails;
+    if (!viewDetails) {
+        return undefined;
+    }
+    const output = {};
+    applyExtraction(viewDetails, output, viewDetails3dLegacyMappings);
+    // Filter out any plane clipVectors that have no planes actually defined
+    for (const clipGroup of output?.modelClipGroups ?? []) {
+        clipGroup.clipVectors = clipGroup.clipVectors?.filter(isValidClipPrimitive);
+    }
+    return viewDetails;
+}
+const modelClipGroupLegacyMappings = [
+    ...clipVectorLegacyMappings,
+    extractSimpleArray(simpleTypeOf("string"), "models"),
+];
+const viewDetails3dLegacyMappings = [
+    ...viewDetailsMappings,
+    extractBoolean("disable3dManipulations"),
+    extractArray(modelClipGroupLegacyMappings, "modelClipGroups"),
+];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/saved-views-react",
-  "version": "1.2.1",
+  "version": "1.2.3",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -41,16 +41,16 @@
     "@types/react": "^18.0.0",
     "@types/recursive-readdir": "^2.2.2",
     "@vitejs/plugin-react-swc": "^3.5.0",
-    "@vitest/coverage-v8": "^3.2.4",
+    "@vitest/coverage-v8": "^4.0.16",
     "cpx2": "^5.0.0",
-    "happy-dom": "^15.11.4",
+    "happy-dom": "^20.0.0",
     "npm-run-all": "^4.1.5",
     "react": "^18.0.0",
     "react-dom": "^18.0.0",
     "recursive-readdir": "^2.2.3",
     "typescript": "^5.5.4",
     "vite": "^6.0.0",
-    "vitest": "^3.2.4"
+    "vitest": "^4.0.16"
   },
   "peerDependencies": {
     "@itwin/core-common": "^5.2.0",
@@ -66,7 +66,7 @@
     "@itwin/itwinui-icons-react": "^2.9.0",
     "@itwin/itwinui-react": "^3.15.0",
     "fuse.js": "^6.6.2",
-    "@itwin/saved-views-client": "^0.6.0"
+    "@itwin/saved-views-client": "^0.6.2"
   },
   "scripts": {
     "build": "run-p build:*",