@itwin/saved-views-react 0.1.0

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

@@ -0,0 +1,499 @@
+import { applyExtraction, extractArray, extractArrayConditionally, extractBoolean, extractColor, extractColorLegacy, extractConditionally, extractNumber, extractNumberOrBool, extractObject, extractPlainTypedMap, extractRGB, extractSimpleArray, extractString, extractStringOrArray, extractStringOrNumber, extractStringOrNumberArray, isAnyColorFormat, simpleTypeOf, } from "./extractionUtilities.js";
+const viewFlagMappings = [
+    extractNumber("renderMode"),
+    extractBoolean("noConstructions", "noConstruct"),
+    extractBoolean("noDimensions", "noDim"),
+    extractBoolean("noPattern"),
+    extractBoolean("noWeight"),
+    extractBoolean("noStyle"),
+    extractBoolean("noTransparency", "noTransp"),
+    extractBoolean("noFill"),
+    extractBoolean("noTexture"),
+    extractBoolean("noMaterial"),
+    extractBoolean("visibleEdges", "visEdges"),
+    extractBoolean("hiddenEdges", "hidEdges"),
+    extractBoolean("shadows"),
+    extractBoolean("clipVolume", "clipVol"),
+    extractBoolean("monochrome"),
+    extractBoolean("backgroundMap"),
+    extractBoolean("ambientOcclusion"),
+];
+const viewFlagLegacyMappings = [
+    extractNumber("renderMode"),
+    extractBoolean("noConstruct", "noConstructions"),
+    extractBoolean("noDim", "noDimensions"),
+    extractBoolean("noPattern"),
+    extractBoolean("noWeight"),
+    extractBoolean("noStyle"),
+    extractBoolean("noTransp", "noTransparency"),
+    extractBoolean("noFill"),
+    extractBoolean("noTexture"),
+    extractBoolean("noMaterial"),
+    extractBoolean("visEdges", "visibleEdges"),
+    extractBoolean("hidEdges", "hiddenEdges"),
+    extractBoolean("shadows"),
+    extractBoolean("clipVol", "clipVolume"),
+    extractBoolean("monochrome"),
+    extractBoolean("backgroundMap"),
+    extractBoolean("ambientOcclusion"),
+];
+const planarClipMaskMappings = [
+    extractNumber("mode"),
+    extractString("modelIds"),
+    extractString("subCategoryOrElementIds"),
+    extractNumber("priority"),
+    extractNumber("transparency"),
+    extractBoolean("invert"),
+];
+const displayStylePlanarClipMaskMappings = [
+    ...planarClipMaskMappings,
+    extractString("modelId"),
+];
+const backgroundMapMappings = [
+    extractNumber("groundBias"),
+    extractNumberOrBool("transparency"),
+    extractBoolean("useDepthBuffer"),
+    extractBoolean("applyTerrain"),
+    extractObject([
+        extractString("providerName"),
+        extractNumber("exaggeration"),
+        extractBoolean("applyLighting"),
+        extractNumber("heightOrigin"),
+        extractNumber("heightOriginMode"),
+    ], "terrainSettings"),
+    extractNumber("globeMode"),
+    extractBoolean("nonLocatable"),
+    extractObject(planarClipMaskMappings, "planarClipMask"),
+];
+const displayStyleSubCategoryMappings = [
+    extractString("subCategory"),
+    extractColor("color"),
+    extractColor("fill"),
+    extractBoolean("invisible"),
+    extractNumber("weight"),
+    extractString("style"),
+    extractNumber("priority"),
+    extractString("material"),
+    extractNumber("transp", "transparency"),
+    extractNumber("transpFill", "transparencyFill"),
+];
+export const featureAppearanceMappings = [
+    extractRGB("rgb"),
+    extractNumber("weight"),
+    extractNumber("transparency"),
+    extractNumber("linePixels"),
+    extractBoolean("ignoresMaterial"),
+    extractBoolean("nonLocatable"),
+    extractBoolean("emphasized"),
+];
+export const featureAppearanceLegacyMappings = [
+    extractColorLegacy("rgb"),
+    extractNumber("weight"),
+    extractNumber("transparency"),
+    extractNumber("linePixels"),
+    extractBoolean("ignoresMaterial"),
+    extractBoolean("nonLocatable"),
+    extractBoolean("emphasized"),
+];
+const displayStyleModelAppearanceMappings = [
+    ...featureAppearanceMappings,
+    extractString("modelId"),
+];
+const displayStyleModelAppearanceLegacyMappings = [...featureAppearanceLegacyMappings, extractString("modelId")];
+const contextRealityModelsMappings = [
+    extractObject([
+        extractString("provider"),
+        extractString("format"),
+        extractString("id"),
+        extractString("iTwinId"),
+    ], "rdSourceKey", "realityDataSourceKey"),
+    extractString("tilesetUrl"),
+    extractString("realityDataId"),
+    extractString("name"),
+    extractString("description"),
+    extractArray([
+        extractString("modelId"),
+        extractNumber("expand"),
+        extractObject([
+            extractNumber("inside"),
+            extractNumber("outside"),
+            extractBoolean("isVolumeClassifier"),
+        ], "flags"),
+        extractString("name"),
+        extractBoolean("isActive"),
+    ], "classifiers"),
+    extractObject(planarClipMaskMappings, "planarClipMask"),
+    extractObject(featureAppearanceMappings, "appearanceOverrides"),
+];
+const contextRealityModelsLegacyMappings = [
+    extractObject([
+        extractString("provider"),
+        extractString("format"),
+        extractString("id"),
+        extractString("iTwinId"),
+    ], "rdSourceKey", "realityDataSourceKey"),
+    extractString("tilesetUrl"),
+    extractString("realityDataId"),
+    extractString("name"),
+    extractString("description"),
+    extractArray([
+        extractString("modelId"),
+        extractNumber("expand"),
+        extractObject([
+            extractNumber("inside"),
+            extractNumber("outside"),
+            extractBoolean("isVolumeClassifier"),
+        ], "flags"),
+        extractString("name"),
+        extractBoolean("isActive"),
+    ], "classifiers"),
+    extractObject(planarClipMaskMappings, "planarClipMask"),
+    extractObject(featureAppearanceLegacyMappings, "appearanceOverrides"),
+];
+const commonMapLayerPropsMapping = [
+    extractBoolean("visible"),
+    extractString("name"),
+    extractNumber("transparency"),
+    extractBoolean("transparentBackground"),
+];
+const mapSubLayerMappings = [
+    extractString("name"),
+    extractString("title"),
+    extractBoolean("visible"),
+    extractStringOrNumber("id"),
+    extractStringOrNumber("parent"),
+    extractStringOrNumberArray("children"),
+];
+const imageMapLayerPropsMapping = [
+    ...commonMapLayerPropsMapping,
+    extractString("url"),
+    extractString("formatId"),
+    extractArray(mapSubLayerMappings, "subLayers"),
+];
+const baseMapLayerPropsMapping = [
+    ...imageMapLayerPropsMapping,
+    extractObject([extractString("name"), extractNumber("type")], "provider"),
+];
+const modelMapLayerPropsMapping = [
+    ...commonMapLayerPropsMapping,
+    extractString("modelId"),
+];
+const mapImageryMapping = [
+    extractConditionally([
+        {
+            discriminator: isAnyColorFormat,
+            mappings: extractColor,
+        },
+        {
+            discriminator: "url",
+            mappings: baseMapLayerPropsMapping,
+        },
+    ], "backgroundBase"),
+    extractArrayConditionally([
+        {
+            discriminator: "modelId",
+            mappings: modelMapLayerPropsMapping,
+        },
+        {
+            discriminator: "url",
+            mappings: imageMapLayerPropsMapping,
+        },
+    ], "backgroundLayers"),
+    extractArrayConditionally([
+        {
+            discriminator: "modelId",
+            mappings: modelMapLayerPropsMapping,
+        },
+        {
+            discriminator: "url",
+            mappings: imageMapLayerPropsMapping,
+        },
+    ], "overlayLayers"),
+];
+const viewFlagOverridesMapping = [
+    extractNumber("renderMode"),
+    extractBoolean("dimensions"),
+    extractBoolean("patterns"),
+    extractBoolean("weights"),
+    extractBoolean("styles"),
+    extractBoolean("transparency"),
+    extractBoolean("fill"),
+    extractBoolean("textures"),
+    extractBoolean("materials"),
+    extractBoolean("acs"),
+    extractBoolean("grid"),
+    extractBoolean("visibleEdges"),
+    extractBoolean("hiddenEdges"),
+    extractBoolean("shadows"),
+    extractBoolean("clipVolume"),
+    extractBoolean("constructions"),
+    extractBoolean("constructions"),
+    extractBoolean("backgroundMap"),
+    extractBoolean("ambientOcclusion"),
+    extractBoolean("wiremesh"),
+    extractBoolean("lighting"),
+];
+const hiddenLineStyleMappings = [
+    extractBoolean("overrideColor", "ovrColor"),
+    extractColor("color"),
+    extractNumber("pattern"),
+    extractNumber("width"),
+];
+const hiddenLineStyleLegacyMappings = [
+    extractBoolean("ovrColor", "overrideColor"),
+    extractColorLegacy("color"),
+    extractNumber("pattern"),
+    extractNumber("width"),
+];
+const hiddenLineSettingsMappings = [
+    extractObject(hiddenLineStyleMappings, "visible"),
+    extractObject(hiddenLineStyleMappings, "hidden"),
+    extractNumber("transparencyThreshold", "transThreshold"),
+];
+const hiddenLineSettingsLegacyMappings = [
+    extractObject(hiddenLineStyleLegacyMappings, "visible"),
+    extractObject(hiddenLineStyleLegacyMappings, "hidden"),
+    extractNumber("transThreshold", "transparencyThreshold"),
+];
+const cutStyleMappings = [
+    extractObject(viewFlagOverridesMapping, "viewflags"),
+    extractObject(hiddenLineSettingsMappings, "hiddenLine"),
+    extractObject(featureAppearanceMappings, "appearance"),
+];
+const cutStyleLegacyMappings = [
+    extractObject(viewFlagOverridesMapping, "viewflags"),
+    extractObject(hiddenLineSettingsLegacyMappings, "hiddenLine"),
+    extractObject(featureAppearanceLegacyMappings, "appearance"),
+];
+const clipStyleIntersectionMappings = [
+    extractRGB("color"),
+    extractNumber("width"),
+];
+const clipStyleIntersectionLegacyMappings = [
+    extractColorLegacy("color"),
+    extractNumber("width"),
+];
+const clipStyleMappings = [
+    extractBoolean("produceCutGeometry"),
+    extractObject(cutStyleMappings, "cutStyle"),
+    extractRGB("insideColor"),
+    extractRGB("outsideColor"),
+    extractBoolean("colorizeIntersection"),
+    extractObject(clipStyleIntersectionMappings, "intersectionStyle"),
+];
+const clipStyleLegacyMappings = [
+    extractBoolean("produceCutGeometry"),
+    extractObject(cutStyleLegacyMappings, "cutStyle"),
+    extractColorLegacy("insideColor"),
+    extractColorLegacy("outsideColor"),
+    extractBoolean("colorizeIntersection"),
+    extractObject(clipStyleIntersectionLegacyMappings, "intersectionStyle"),
+];
+const displayStylesMapping = [
+    extractObject(viewFlagMappings, "viewflags"),
+    extractColor("backgroundColor"),
+    extractColor("monochromeColor"),
+    extractNumber("monochromeMode"),
+    extractString("renderTimeline"),
+    extractNumber("timePoint"),
+    extractArray(displayStyleSubCategoryMappings, "subCategoryOverrides", "subCategoryOvr"),
+    extractObject(backgroundMapMappings, "backgroundMap"),
+    extractArray(contextRealityModelsMappings, "contextRealityModels"),
+    extractStringOrArray("excludedElements"),
+    extractObject(mapImageryMapping, "mapImagery"),
+    extractArray(displayStyleModelAppearanceMappings, "modelOverrides", "modelOvr"),
+    extractObject(clipStyleMappings, "clipStyle"),
+    extractArray(displayStylePlanarClipMaskMappings, "planarClipOverrides", "planarClipOvr"),
+];
+const displayStylesLegacyMapping = [
+    extractObject(viewFlagLegacyMappings, "viewflags"),
+    extractColorLegacy("backgroundColor"),
+    extractColorLegacy("monochromeColor"),
+    extractNumber("monochromeMode"),
+    extractString("renderTimeline"),
+    extractNumber("timePoint"),
+    extractArray(displayStyleSubCategoryMappings, "subCategoryOvr", "subCategoryOverrides"),
+    extractObject(backgroundMapMappings, "backgroundMap"),
+    extractArray(contextRealityModelsLegacyMappings, "contextRealityModels"),
+    extractStringOrArray("excludedElements"),
+    extractObject(mapImageryMapping, "mapImagery"),
+    extractArray(displayStyleModelAppearanceLegacyMappings, "modelOvr", "modelOverrides"),
+    extractObject(clipStyleLegacyMappings, "clipStyle"),
+    extractArray(displayStylePlanarClipMaskMappings, "planarClipOvr", "planarClipOverrides"),
+];
+const environmentMappings = [
+    extractObject([
+        extractBoolean("display"),
+        extractNumber("elevation"),
+        extractColor("aboveColor"),
+        extractColor("belowColor"),
+    ], "ground"),
+    extractObject([
+        extractBoolean("display"),
+        extractBoolean("twoColor"),
+        extractColor("skyColor"),
+        extractColor("groundColor"),
+        extractColor("zenithColor"),
+        extractColor("nadirColor"),
+        extractNumber("skyExponent"),
+        extractNumber("groundExponent"),
+        extractObject([
+            extractNumber("type"),
+            extractString("texture"),
+            extractObject([
+                extractString("front"),
+                extractString("back"),
+                extractString("top"),
+                extractString("bottom"),
+                extractString("right"),
+                extractString("left"),
+            ], "textures"),
+        ], "image"),
+    ], "sky"),
+];
+const environmentLegacyMappings = [
+    extractObject([
+        extractBoolean("display"),
+        extractNumber("elevation"),
+        extractColorLegacy("aboveColor"),
+        extractColorLegacy("belowColor"),
+    ], "ground"),
+    extractObject([
+        extractBoolean("display"),
+        extractBoolean("twoColor"),
+        extractColorLegacy("skyColor"),
+        extractColorLegacy("groundColor"),
+        extractColorLegacy("zenithColor"),
+        extractColorLegacy("nadirColor"),
+        extractNumber("skyExponent"),
+        extractNumber("groundExponent"),
+        extractObject([
+            extractNumber("type"),
+            extractString("texture"),
+            extractObject([
+                extractString("front"),
+                extractString("back"),
+                extractString("top"),
+                extractString("bottom"),
+                extractString("right"),
+                extractString("left"),
+            ], "textures"),
+        ], "image"),
+    ], "sky"),
+];
+const ambientOcclusionMappings = [
+    extractNumber("bias"),
+    extractNumber("zLengthCap"),
+    extractNumber("maxDistance"),
+    extractNumber("intensity"),
+    extractNumber("texelStepSize"),
+    extractNumber("blurDelta"),
+    extractNumber("blurSigma"),
+    extractNumber("blurTexelStepSize"),
+];
+const solarShadowMappings = [
+    extractColor("color"),
+];
+const lightsMappings = [
+    extractObject([extractNumber("intensity")], "portrait"),
+    extractObject([
+        extractNumber("intensity"),
+        extractSimpleArray(simpleTypeOf("number"), "direction"),
+        extractBoolean("alwaysEnabled"),
+        extractNumber("timePoint"),
+    ], "solar"),
+    extractObject([
+        extractColor("upperColor"),
+        extractColor("lowerColor"),
+        extractNumber("intensity"),
+    ], "hemisphere"),
+    extractObject([extractColor("color"), extractNumber("intensity")], "ambient"),
+    extractNumber("specularIntensity"),
+    extractNumber("numCels"),
+    extractObject([extractNumber("intensity"), extractBoolean("invert")], "fresnel"),
+];
+const planProjectionSettingsMappings = [
+    extractNumber("elevation"),
+    extractNumber("transparency"),
+    extractBoolean("overlay"),
+    extractBoolean("enforceDisplayPriority"),
+];
+const displayStyle3dMapping = [
+    ...displayStylesMapping,
+    extractObject(environmentMappings, "environment"),
+    extractObject(ambientOcclusionMappings, "ambientOcclusion", "ao"),
+    extractObject(solarShadowMappings, "solarShadows"),
+    extractObject(lightsMappings, "lights"),
+    extractPlainTypedMap(planProjectionSettingsMappings, simpleTypeOf("string"), "planProjections"),
+];
+const displayStyle3dLegacyMapping = [
+    ...displayStylesLegacyMapping,
+    extractObject(environmentLegacyMappings, "environment"),
+    extractObject(ambientOcclusionMappings, "ambientOcclusion", "ao"),
+    extractObject(solarShadowMappings, "solarShadows"),
+    extractObject(lightsMappings, "lights"),
+    extractPlainTypedMap(planProjectionSettingsMappings, simpleTypeOf("string"), "planProjections"),
+];
+/**
+ * Extracts the display style from a legacy view displayStyle field
+ * And transforms it into our schema
+ * @param data
+ * @param viewState
+ */
+export const extractDisplayStyle = (data, viewState) => {
+    let styles;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const output = {};
+    if ("displayStyle" in data) {
+        styles = data.displayStyle;
+        applyExtraction(styles, output, displayStylesMapping);
+    }
+    if ("displayStyleProps" in data) {
+        styles = data.displayStyleProps.jsonProperties?.styles;
+        applyExtraction(styles, output, displayStylesLegacyMapping);
+    }
+    if (styles === undefined) {
+        return undefined;
+    }
+    if (viewState) {
+        appendAcsAndGridViewFlagsToOutput(viewState, output);
+    }
+    return output;
+};
+/**
+ * Extracts the display style 3d from a legacy view displayStyle field
+ * And transforms it into our schema
+ * @param data
+ */
+export const extractDisplayStyle3d = (data) => {
+    let styles;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const output = {};
+    if ("displayStyle" in data) {
+        styles = data.displayStyle;
+        applyExtraction(styles, output, displayStyle3dMapping);
+    }
+    if ("displayStyleProps" in data) {
+        styles = data.displayStyleProps.jsonProperties?.styles;
+        applyExtraction(styles, output, displayStyle3dLegacyMapping);
+    }
+    if (styles === undefined) {
+        return undefined;
+    }
+    return output;
+};
+function appendAcsAndGridViewFlagsToOutput(drawingViewState, 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+output) {
+    output.viewflags.acs = false;
+    output.viewflags.grid = true;
+    if (drawingViewState.auxiliaryCoordinateSystem) {
+        output.viewflags.acs = true;
+    }
+    const gridOrient = drawingViewState.getGridOrientation();
+    const gridSpacing = drawingViewState.getGridOrientation();
+    const gridPerRef = drawingViewState.getGridsPerRef();
+    if (!gridOrient || !gridSpacing || !gridPerRef) {
+        output.viewflags.grid = false;
+    }
+}

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

@@ -0,0 +1,18 @@
+import { type EmphasizeElementsProps } from "@itwin/core-common";
+import { ModelCategoryOverrideProviderProps } from "../../../ui/viewlist/ModelCategoryOverrideProvider.js";
+import type { PerModelCategoryVisibilityProps } from "../SavedViewTypes.js";
+/**
+ * Extracts the EmphasizeElementsProps from string data in an extension
+ * @param extensionData
+ */
+export declare const extractEmphasizeElements: (extensionData: string) => EmphasizeElementsProps | undefined;
+/**
+ * Extracts array of PerModelCategoryVisibilityProps from string data in an extension
+ * @param extensionData
+ */
+export declare const extractPerModelCategoryVisibility: (extensionData: string) => PerModelCategoryVisibilityProps[];
+/**
+ * Extracts the VisibilityOverrideProps (ie ModelCategoryOverrideProviderProps) from string data in an extension
+ * @param extensionData
+ */
+export declare const extractVisibilityOverride: (extensionData: string) => ModelCategoryOverrideProviderProps | undefined;

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

@@ -0,0 +1,79 @@
+import { featureAppearanceMappings } from "./displayStyleExtractor.js";
+import { applyExtraction, extractArray, extractBoolean, extractColor, extractNumber, extractObject, extractSimpleArray, extractString, simpleTypeOf, } from "./extractionUtilities.js";
+/** Appearance Override type for EmphasizeElements */
+const appearanceOverrideEmphElemMappings = [
+    extractNumber("overrideType"), // an enum
+    extractColor("color"),
+    extractSimpleArray(simpleTypeOf("string"), "ids"),
+];
+/** Appearance Override type for VisibilityOverrides (ie ModelCategoryOverrideProviderProps) */
+const appearanceOverrideVisibOvrMappings = [
+    extractSimpleArray(simpleTypeOf("string"), "ids"),
+    extractObject(featureAppearanceMappings, "app"),
+];
+const emphasizeElementsMapping = [
+    extractSimpleArray(simpleTypeOf("string"), "neverDrawn"),
+    extractSimpleArray(simpleTypeOf("string"), "alwaysDrawn"),
+    extractBoolean("isAlwaysDrawnExclusive"),
+    extractSimpleArray(simpleTypeOf("string"), "alwaysDrawnExclusiveEmphasized"),
+    extractObject(featureAppearanceMappings, "defaultAppearance"),
+    extractArray(appearanceOverrideEmphElemMappings, "appearanceOverride"),
+    extractBoolean("wantEmphasis"),
+    extractObject(featureAppearanceMappings, "unanimatedAppearance"),
+];
+const perModelCategoryVisibilityMapping = [
+    extractString("modelId"),
+    extractString("categoryId"),
+    extractBoolean("visible"),
+];
+const visibilityOverrideMapping = [
+    extractArray(appearanceOverrideVisibOvrMappings, "subCategoryOverrides"),
+    extractArray(appearanceOverrideVisibOvrMappings, "modelOverrides"),
+    extractObject(appearanceOverrideVisibOvrMappings, "catEmphasizeOverride"),
+    extractObject(appearanceOverrideVisibOvrMappings, "modelEmphasizeOverride"),
+];
+/**
+ * Extracts the EmphasizeElementsProps from string data in an extension
+ * @param extensionData
+ */
+export const extractEmphasizeElements = (extensionData) => {
+    const dataObj = JSON.parse(extensionData);
+    if (dataObj === undefined || dataObj.emphasizeElementsProps === undefined) {
+        return undefined;
+    }
+    const output = {};
+    applyExtraction(dataObj.emphasizeElementsProps, output, emphasizeElementsMapping);
+    return output;
+};
+/**
+ * Extracts array of PerModelCategoryVisibilityProps from string data in an extension
+ * @param extensionData
+ */
+export const extractPerModelCategoryVisibility = (extensionData) => {
+    const dataObjArray = JSON.parse(extensionData);
+    if (dataObjArray === undefined ||
+        dataObjArray.perModelCategoryVisibilityProps === undefined) {
+        return [];
+    }
+    const outputArray = [];
+    for (const dataObj of dataObjArray.perModelCategoryVisibilityProps) {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const output = {};
+        applyExtraction(dataObj, output, perModelCategoryVisibilityMapping);
+        outputArray.push(output);
+    }
+    return outputArray;
+};
+/**
+ * Extracts the VisibilityOverrideProps (ie ModelCategoryOverrideProviderProps) from string data in an extension
+ * @param extensionData
+ */
+export const extractVisibilityOverride = (extensionData) => {
+    const dataObj = JSON.parse(extensionData);
+    if (dataObj === undefined || dataObj.visibilityOverrideProps === undefined) {
+        return undefined;
+    }
+    const output = {};
+    applyExtraction(dataObj.visibilityOverrideProps, output, visibilityOverrideMapping);
+    return output;
+};