@itwin/saved-views-react 1.1.0 → 1.1.2

package/lib/translation/displayStyleExtractor.js

@@ -1,4 +1,4 @@
-import { applyExtraction, extractArray, extractArrayConditionally, extractBoolean, extractColor, extractColorLegacy, extractConditionally, extractLinePixels, extractNumber, extractNumberOrBool, extractObject, extractPlainTypedMap, extractRGB, extractSimpleArray, extractString, extractStringOrArray, extractStringOrNumber, extractStringOrNumberArray, isAnyColorFormat, simpleTypeOf, } from "./extractionUtilities.js";
+import { applyExtraction, extractArray, extractArrayConditionally, extractArrayElementsConditionally, extractBoolean, extractColor, extractColorLegacy, extractConditionally, extractLinePixels, extractNumber, extractNumberOrBool, extractObject, extractPlainTypedMap, extractRGB, extractSimpleArray, extractString, extractStringOrArray, extractStringOrNumber, extractStringOrNumberArray, extractValidPlainTypedMap, isAnyColorFormat, simpleTypeOf, simpleTypeOrArrayOf, } from "./extractionUtilities.js";
 const viewFlagMappings = [
     extractNumber("renderMode"),
     extractBoolean("noConstructions", "noConstruct"),
@@ -202,6 +202,8 @@ const imageMapLayerPropsMapping = [
     extractString("url"),
     extractString("formatId"),
     extractArray(mapSubLayerMappings, "subLayers"),
+    extractValidPlainTypedMap(simpleTypeOf("string"), simpleTypeOf("string"), "queryParams"),
+    extractValidPlainTypedMap(simpleTypeOrArrayOf(["string", "number", "boolean"]), simpleTypeOf("string"), "properties"),
 ];
 const baseMapLayerPropsMapping = [
     ...imageMapLayerPropsMapping,
@@ -411,7 +413,7 @@ const displayStylesLegacyMapping = [
     extractNumber("timePoint"),
     extractArray(displayStyleSubCategoryLegacyMappings, "subCategoryOvr", "subCategoryOverrides"),
     extractObject(backgroundMapMappings, "backgroundMap"),
-    extractArray(contextRealityModelsLegacyMappings, "contextRealityModels"),
+    extractArrayElementsConditionally((value) => value && !value.invisible, contextRealityModelsLegacyMappings, "contextRealityModels"),
     extractStringOrArray("excludedElements"),
     extractObject(mapImageryLegacyMapping, "mapImagery"),
     extractArray(displayStyleModelAppearanceLegacyMappings, "modelOvr", "modelOverrides"),

package/lib/translation/extractionUtilities.d.ts

@@ -5,6 +5,12 @@ import type { Rgba, RgbatColorProps } from "./RgbColor.js";
  * @returns
  */
 export declare const simpleTypeOf: (typeOfString: string) => (value: unknown) => boolean;
+/**
+ * Returns a function that does determines if a value is of any of the provided types or arrays of those types
+ * @param typeOfString Array of strings to compare against type
+ * @returns
+ */
+export declare const simpleTypeOrArrayOf: (typeOfString: string[]) => (value: unknown) => boolean;
 /**
  * Returns true if the given value is in any of the color formats that we accept to transform
  * @param value
@@ -185,6 +191,16 @@ export declare const extractConditionally: (params: ConditionalExtractParams[],
  * @param extractionFunc
  */
 export declare const extractArray: (extractionFunc: ExtractionFunc<void, void>[], from: string, to?: string) => (input: any, output: any) => void;
+/**
+ * Creates an extraction function that will extract each value of an array if it meets the given condition
+ * by using a single extraction function on each of the array values
+ * @param condition Function that checks if the value should be extracted
+ * @param extractionFunc Array of extraction functions to apply to each value in the array that meets the condition
+ * @param from Accessor string where the array is in the input object
+ * @param to Accessor string to store it in the output object
+ * @returns Function that extracts an array of values conditionally
+ */
+export declare const extractArrayElementsConditionally: (condition: (value: any) => boolean, extractionFunc: ExtractionFunc<void, void>[], from: string, to?: string) => (input: any, output: any) => void;
 /**
  * Creates an extraction function that will extract the values inside a 2D array from the given accessor
  * @param extractionFunc Extraction functions to apply to each entry in the array
@@ -207,6 +223,15 @@ export declare const extractArrayConditionally: (params: ConditionalExtractParam
  * @returns
  */
 export declare const extractPlainTypedMap: (extractionFuncs: ExtractionFunc<void, void>[], isValidKey: (key: unknown) => boolean, from: string, to?: string) => (input: any, output: any) => void;
+/**
+ * Creates an extraction function that will extract a plain typed map
+ * @param isValidValue Checker for the validity of the values
+ * @param isValidKey Checker for the validity of the key
+ * @param from Accessor where the plain typed map exists
+ * @param to Accessor to store the plain typed map to
+ * @returns
+ */
+export declare const extractValidPlainTypedMap: (isValidValue: (value: unknown) => boolean, isValidKey: (key: unknown) => boolean, from: string, to?: string) => (input: any, output: any) => void;
 /**
  * Applies an array of extraction functions to extract the data from the input object
  * into the output object

package/lib/translation/extractionUtilities.js

@@ -12,6 +12,19 @@ import { LinePixels } from "@itwin/saved-views-client";
 export const simpleTypeOf = (typeOfString) => {
     return (value) => typeof value === typeOfString;
 };
+/**
+ * Returns a function that does determines if a value is of any of the provided types or arrays of those types
+ * @param typeOfString Array of strings to compare against type
+ * @returns
+ */
+export const simpleTypeOrArrayOf = (typeOfString) => {
+    return (value) => typeOfString.some((type) => {
+        if (Array.isArray(value)) {
+            return value.every((inner) => typeof inner === type);
+        }
+        return typeof value === type;
+    });
+};
 /**
  * Type check for colors in format {r: number, g: number, b:number}
  * @param value
@@ -439,6 +452,34 @@ export const extractArray = (extractionFunc, from, to) => {
         }
     };
 };
+/**
+ * Creates an extraction function that will extract each value of an array if it meets the given condition
+ * by using a single extraction function on each of the array values
+ * @param condition Function that checks if the value should be extracted
+ * @param extractionFunc Array of extraction functions to apply to each value in the array that meets the condition
+ * @param from Accessor string where the array is in the input object
+ * @param to Accessor string to store it in the output object
+ * @returns Function that extracts an array of values conditionally
+ */
+export const extractArrayElementsConditionally = (
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+condition, extractionFunc, from, to) => {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    return (input, output) => {
+        const adjustedTo = to ?? from;
+        if (input[from] !== undefined && Array.isArray(input[from])) {
+            output[adjustedTo] = [];
+            let outputIndex = 0;
+            input[from].forEach((_, index) => {
+                if (condition(input[from][index])) {
+                    output[adjustedTo].push({});
+                    extractionFunc.forEach((func) => func(input[from][index], output[adjustedTo][outputIndex]));
+                    outputIndex++;
+                }
+            });
+        }
+    };
+};
 /**
  * Creates an extraction function that will extract the values inside a 2D array from the given accessor
  * @param extractionFunc Extraction functions to apply to each entry in the array
@@ -515,6 +556,28 @@ export const extractPlainTypedMap = (extractionFuncs, isValidKey, from, to) => {
         }
     };
 };
+/**
+ * Creates an extraction function that will extract a plain typed map
+ * @param isValidValue Checker for the validity of the values
+ * @param isValidKey Checker for the validity of the key
+ * @param from Accessor where the plain typed map exists
+ * @param to Accessor to store the plain typed map to
+ * @returns
+ */
+export const extractValidPlainTypedMap = (isValidValue, isValidKey, from, to) => {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    return (input, output) => {
+        if (input[from] !== undefined) {
+            const adjustedTo = to ?? from;
+            output[adjustedTo] = {};
+            for (const prop in input[from]) {
+                if (isValidKey(prop) && isValidValue(input[from][prop])) {
+                    output[adjustedTo][prop] = input[from][prop];
+                }
+            }
+        }
+    };
+};
 /**
  * Applies an array of extraction functions to extract the data from the input object
  * into the output object

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/saved-views-react",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -68,7 +68,7 @@
     "@itwin/itwinui-icons-react": "^2.9.0",
     "@itwin/itwinui-react": "^3.15.0",
     "fuse.js": "^6.6.2",
-    "@itwin/saved-views-client": "^0.5.2"
+    "@itwin/saved-views-client": "^0.5.3"
   },
   "scripts": {
     "build": "run-p build:*",