@itwin/saved-views-react 0.1.0

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

@@ -0,0 +1,209 @@
+import type { Rgba, RgbatColorProps } from "./RgbColor.js";
+/**
+ * Returns a function that does a simple typeof check on a value
+ * @param typeOfString String to compare against
+ * @returns
+ */
+export declare const simpleTypeOf: (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
+ * @returns
+ */
+export declare const isAnyColorFormat: (value: unknown) => boolean;
+/**
+ * Transforms any of the three types of colors into our schema color format {red: number, green: number, blue: number}
+ * Legacy to new schema
+ * @param value
+ * @returns
+ */
+export declare const transformColorLegacy: (value: unknown) => RgbatColorProps | undefined;
+/**
+ * Transforms any of the two types of colors into our schema color format 0xttbbggrr
+ * @param value
+ * @returns
+ */
+export declare const transformColor: (value: unknown) => unknown;
+/**
+ * Transforms any of the three types of colors into our schema color format {r: number, g: number, b: number}
+ * @param value
+ * @returns
+ */
+export declare const transformRGB: (value: unknown) => Rgba | undefined;
+/**
+ * Creates a function that extracts a value from input to output
+ * @param from Accessor from where to retrieve the value
+ * @param to Accessor to add to the output object to store the value
+ * @param typeCheck Type checker for validation of the value
+ * @param transform Transform function of the value to be put in the output
+ * @returns Function that does the extraction
+ */
+export declare const createExtractionFunc: (from: string, to: string, typeCheck?: ((value: unknown) => boolean) | undefined, transform?: ((value: unknown) => unknown) | undefined) => (input: any, output: any) => void;
+/** Type for a extraction function generator */
+export type ExtractionFunc<InputType, OutputType> = (input: InputType, output: OutputType) => OutputType;
+/** Type for a function that creates a extraction function */
+export type ExtractionFuncCreator = (from: string, to: string) => ExtractionFunc<void, void>;
+/**
+ * Creates a extraction function that will extract a number from the given accessor and put it
+ * in the given accessor if provided
+ * @param from Accessor that will be used on input to access value
+ * @param to Accessor that will be used to stored the value in the output object
+ * @returns Function that extracts a number value and type checks it
+ */
+export declare const extractNumber: (from: string, to?: string) => ExtractionFunc<void, void>;
+/**
+ * Creates a extraction function that will extract a boolean from the given accessor and put it
+ * in the given accessor if provided
+ * @param from Accessor that will be used on input to access value
+ * @param to Accessor that will be used to stored the value in the output object
+ * @returns Function that extracts a boolean value and type checks it
+ */
+export declare const extractBoolean: (from: string, to?: string) => ExtractionFunc<void, void>;
+/**
+ * Creates a extraction function that will extract a boolean or a number with the same accessor name
+ * @param from Accessor that will be used on input to access value
+ * @param to Accessor that will be used to stored the value in the output object
+ * @returns Function that extracts a boolean or number value and type checks it
+ */
+export declare const extractNumberOrBool: (from: string, to?: string) => ExtractionFunc<void, void>;
+/**
+ * Creates a extraction function that will extract a string from the given accessor and put it
+ * in the given accessor if provided
+ * @param from Accessor that will be used on input to access value
+ * @param to Accessor that will be used to stored the value in the output object
+ * @returns Function that extracts a string value and type checks it
+ */
+export declare const extractString: (from: string, to?: string) => ExtractionFunc<void, void>;
+/**
+ * Creates a extraction function that will extract a string or number from them given accessor
+ * @param from Accessor that will be used on input to access value
+ * @param to Accessor that will be used to stored the value in the output object
+ * @returns Function that extracts a string or number value and type checks it
+ */
+export declare const extractStringOrNumber: (from: string, to?: string) => ExtractionFunc<void, void>;
+/**
+ * Creates a extraction function that will extract a string or an array of strings into the given
+ * accessor
+ * @param from Accessor that will be used on input to access value
+ * @param to Accessor that will be used to stored the value in the output object
+ * @returns Function that extracts a string or string array value and type checks it
+ */
+export declare const extractStringOrArray: (from: string, to?: string) => ExtractionFunc<void, void>;
+/**
+ * Creates a extraction function that will extract an array of type: (string | number)[]
+ * @param from Accessor that will be used on input to access value
+ * @param to Accessor that will be used to stored the value in the output object
+ * @returns Function that extracts a string | number array value and type checks it
+ */
+export declare const extractStringOrNumberArray: (from: string, to?: string) => ExtractionFunc<void, void>;
+/**
+ * Creates a extraction function that will extract an array in which all the elements are type checked with the
+ * given function
+ * @param typeCheck Function to check each value of the array
+ * @param from Accessor string where the array is in the input object
+ * @param to Accessor string to store it in the output object
+ * @returns
+ */
+export declare const extractSimpleArray: (typeCheck: (value: unknown) => boolean, from: string, to?: string) => ExtractionFunc<void, void>;
+/**
+ * Creates a extraction function that will extract a color from the given accessor and put it
+ * in the given accessor if provided. Colors will be transformed from either of the following representations:
+ * 1. Number in format: 0xTTBBGGRR
+ * 2. JSON Object in format: {r: number, g: number, b: number}
+ * 3. JSON Object in format: {red: number, green: number, blue: number}
+ *
+ * The resulting transformed color will be in format: {red: number, green: number, blue: number}
+ *
+ * @param from Accessor that will be used on input to access value
+ * @param to Accessor that will be used to store the value in the output object
+ * @returns Function that extracts a color value and type checks it
+ */
+export declare const extractColor: (from: string, to?: string) => ExtractionFunc<void, void>;
+/**
+ * Creates a extraction function that will extract a color from the given accessor and put it
+ * in the given accessor if provided. Colors will be transformed from either of the following representations:
+ * 1. Number in format: 0xTTBBGGRR
+ * 2. JSON Object in format: {r: number, g: number, b: number}
+ * 3. JSON Object in format: {red: number, green: number, blue: number}
+ *
+ * The resulting transformed color will be in format: {red: number, green: number, blue: number}
+ *
+ * @param from Accessor that will be used on input to access value
+ * @param to Accessor that will be used to store the value in the output object
+ * @returns Function that extracts a color value and type checks it
+ */
+export declare const extractColorLegacy: (from: string, to?: string) => ExtractionFunc<void, void>;
+/**
+ * Creates a extraction function that will extract a color from RBG format
+ *
+ * @param from Accessor that will be used on input to access value
+ * @param to Accessor that will be used to store the value in the output object
+ * @returns Function that extracts a color value and type checks it
+ */
+export declare const extractRGB: (from: string, to?: string) => ExtractionFunc<void, void>;
+/**
+ * Creates a extraction function that will extract an array of mappings from an object with the given accessor
+ * @param extractionFuncs Array of extraction functions
+ * @param from Accessor that will be used on input to access value
+ * @param to Accessor that will be used to store the value in the output object
+ * @returns Function that extracts an object
+ */
+export declare const extractObject: (extractionFuncs: ExtractionFunc<void, void>[], from: string, to?: string) => ExtractionFunc<void, void>;
+/**
+ * Interface to pass a discriminator and an array of extraction functions
+ * To the extractConditionally function
+ */
+export interface ConditionalExtractParams {
+    /** Accessor name that if found on the object matches these mappings to it */
+    discriminator: string | ((value: unknown) => boolean);
+    /**
+     * If an array is passed, the extraction functions are applied to the child to extract
+     * If the single creator function is passed, then that function is applied to the parent object
+     */
+    mappings: ExtractionFunc<void, void>[] | ExtractionFuncCreator;
+}
+/**
+ * Creates an extraction function that will extract different values based on a discriminator string
+ * This is to allow extracting types like 'ClassA | ClassB'
+ * @param params
+ * @param from
+ * @param to
+ * @returns
+ */
+export declare const extractConditionally: (params: ConditionalExtractParams[], from: string, to?: string) => ExtractionFunc<void, void>;
+/**
+ * Creates a extraction function that will extract values of an array by using a single extraction function
+ * on each of the array values
+ * @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 the values inside a 2D array from the given accessor
+ * @param extractionFunc Extraction functions to apply to each entry in the array
+ * @param from Accessor string for the 2D array in the input object
+ * @param to Accessor string for the 2D array in the output object
+ */
+export declare const extractArray2d: (extractionFunc: ExtractionFunc<void, void>[], from: string, to?: string) => (input: any, output: any) => void;
+/**
+ * Creates a extraction function that will extract values of an array by using different extraction functions
+ * based on a discriminator for each array value. This is to extract arrays of types like (ClassA | ClassB)[]
+ * @param extractionFunc
+ */
+export declare const extractArrayConditionally: (params: ConditionalExtractParams[], from: string, to?: string) => (input: any, output: any) => void;
+/**
+ * Creates an extraction function that will extract a plain typed map
+ * @param extractionFuncs Extraction functions for 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 extractPlainTypedMap: (extractionFuncs: ExtractionFunc<void, void>[], 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
+ * @param input Object to extract data from
+ * @param output Object to map the data to
+ * @param extractionFuncs Array of extraction functions
+ */
+export declare const applyExtraction: (input: any, output: any, extractionFuncs: ExtractionFunc<void, void>[]) => void;