Helper, Utils for all Qrvey Projects

Apply to the given date format to a date value

• Void

Set convert Bytes into MB

• Void

It returns true if the given string is a valid time string, and false otherwise

• A boolean value.

It takes a time string and a format string and returns a formatted time string

• Void

The function getCleanCustomTokens takes an object customTokens and returns a new object cleanTokens with filtered values based on certain conditions.

• a cleaned version of the customTokens object.

The function getCustomTokenBoxParse takes in an object of custom tokens and returns a formatted list of tokens with aliases and labels.

• an object called tokensList.

The function getCustomtonTokens takes a configuration object and returns a parsed version of the custom tokens, with keys and values appropriately formatted.

• an object of type ICustomTokensComplex.

The function getCustomtonTokensWithKeys takes an array of CustomTokens objects and returns a new array with each object having a key property that is the camelized version of either the key or label property.

• an array of CustomTokens objects. Each object in the array has an additional key property, which is generated by camelizing the key or label property of the original CustomTokens object.

Get a text and evaluate if it matchs with a token box label.

• True is label matchs; otherwise false

If data is truthy, return data.logic, otherwise return an empty array.

• Void

It takes a data object and returns a MetricValue object

• A metric value object

If data is truthy and data.dateColumn is truthy, return true, otherwise return false.

• Void

Given a time label and a custom range, return a relative date config or a metric custom range.

• A relative date config or a metric custom range

It takes in a custom range config object and returns a custom range object

• A function that takes in a customRangeData object and returns a customRange object.

It takes in a metricData object and returns a CustomRangeConfig object

• An object with the following properties: startingDate: metricData?.timePeriodDate, endDate: metricData?.timePeriodEndDate, label: metricData?.timePeriodCustomRange?.label,

It takes in a metricData object and returns a CustomRangeConfig object

• An object with the following properties: startingDate: metricData?.comparisonDate, endDate: metricData?.comparisonEndDate, label: metricData?.comparisonCustomRange?.label,

• Void

[TODO: Finish the function] Get an string of the properties of the given column.

• an string with the property, aggregate or calculation label.

Gets the column from the dataset object Recieves a partial column object and returns a full column object from the Dataset

• the dataset column index or the dataset column object

Validates the arguments

• true: the arguments are valid.

Gets the column array

• the column array

Get a model column by a partial column info.

• the model column

Gets a column from a datasets collection. Recieves a partial column object and returns a full column object from the Dataset

• the Column object

Validates the arguments

• true: the arguments are valid.

Get the model by Qrvey ID

• a promise with the resulting model

Get a dataset list from a collection of Qrvey IDs

• a promise

Get a promise with a preview of resulting data. Depending on the validator, the endpoint will change.

• a promise with a preview of resulting data.

Gets the available scopes and scope IDs

• a collection of the pair Scopes and Scope IDs

Set the config into the Filter Builder Api class

• Void

Gets a promise with a resulting data

• a promise with a resulting data

Gets the Data from preview Response

• The resulting data

Gets summaries from preview response

• the sumaries

Gets the filter object structure for the searching text

• the filter object structure

Gets the filters from the chart settings

• the filters from the chart settings

Tranform response in array of object with value key Null or undefined values are avoided

• the sumaries

Gets request body structure

• the request body structure

Gets chart body structure

• the chart body structure

Gets dimension body structure

• the dimension body structure

Gets max data point number

• max data point number

Gets sort option structure

• sort option structure

Gets summaries body structure

• summaries body structure

Refines the body structure

• the body structure

Gets the validation type for the preview request

• the validator type for the preview request

Gets afterKey object

• the afterKey object

Gets a promise with a resulting data

• a promise with a resulting data

Gets the Data from preview Response

• The resulting data

Refines the afterKey object

• Void

Sets the afterKey object

• Void

Sets the Filter Builder Filter

• Void

Gets the filter object structure for the searching text

• the filter object structure

Gets the filters from the chart settings

• the filters from the chart settings

Tranform response in array of object with value key Null or undefined values are avoided

• the sumaries

Gets request body structure

• the request body structure

Gets dimension body structure

• the dimension body structure

Get a dimension body structure foor pagination endpoint

• the dimension body structure

Gets max data point number

• max data point number

Gets sort option structure

• sort option structure

Gets summaries body structure

• summaries body structure

Refines the body structure

• the body structure

Gets the validation type for the preview request

• the validator type for the preview request

Gets summaries from preview response

• the sumaries

Checks if two filter columns are the same.

• True: Columns are equal; False: Columns are not equal

Gets the numeric offset (minutes) from the ISO offset (string)

• number the offset in minutes

• Transform a Date to [HH:mm:ss] date format.

• string string of [HH:mm:ss] date format

Gets the settings for this function.

• IDFDateToHmsSettings a new object for the settings

Gets the Hours

• string the hour string

Gets the Minutes

• string the minute string

Gets the Seconds

• string the seconds string

Transform a Date to [mm/dd/yyyy] date format.

• string string of [mm/dd/yyyy] date format

Transform a Date to [Month Year] date format.

• string string of [Month Year] date format

Transform a valid Date to [Quarter Year] date format.

• string string of [Quarter Year] date format

Transform a Date to [W# Year] date format.

• string string of [W# Year] date format

Transform a Date to [Year] date format.

• string string of [Year] date format

Transforms String time from a [H:m:s] format to Date object.

• IDate The date object or the date in milliseconds. If the argument is an unexpected time, the function will return the same value

Transforms String Date from a [mm/dd/yyyy] format to Date object.

• IDate The date object or the date in milliseconds. If the argument is an unexpected date, the function will return the same value

Transforms String Date from a [Month Year] format to Date object.

• IDate The date object or the date in milliseconds. If the argument is an unexpected date, the function will return the same value

Gets the ISO offset From the numeric offset (minutes)

• string the offset in minutes

Transforms String Date from a [Quarter Year] format to Date object.

• IDate The date object or the date in milliseconds. If the argument is an unexpected date, the function will return the same value.

Transforms String Date from a [Week Year] format to Date object.

• IDate The date object or the date in milliseconds. If the argument is an unexpected date, the function will return the same value.

Transforms String Date from a [Year] format to Date object.

• IDate The date object or the date in milliseconds. If the argument is an unexpected date, the function will return the same value.

Determines if the given date has tokens. The date is splitted depending on date format. Undefined date is returning false.

• boolean true: include tokens; false: otherwise

Gets a Date Object instance by a Date format

• IDate a Date object, milisecond time or the same value if date format does not match.

Gets a date value in the given timezone

• IDate A transformed value

Gets a Date with the given offset of the Timezone. No given an offset the default is going to be set by the browser

• IDate the updated Date object

Gets the date format by the given property

• IDateFormat The date format

Gets an array of regular expressions by the given date format. Day format is the default date format

• Array.<string> an array of regular expressions

Gets the pick level number related to the Date picker element

• number A number of the pick level setting

Get date range object from a string date value

// 1) Year:
getDateRange('2020', 'YEAR');
// Will return:
{
   from: '01/01/2020 00:00:00',
   to: '12/31/2020 23:59:59'
}

// 2) Quarter:
getDateRange('Q3 2020', 'QUARTER');
// Will return:
{
   from: '07/01/2020 00:00:00',
   to: '09/30/2020 23:59:59'
}

// 3) Month:
getDateRange('Oct 2020', 'MONTH');
// Will return:
{
   from: '10/01/2020 00:00:00',
   to: '10/31/2020 23:59:59'
}

• Object an object with the date range with two string date properties: from and to

It takes a Date object as an argument and returns a string in the format of MM/DD/YYYY

• A string in the format of MM/DD/YYYY

Gets the default properties for Date Settings object

• IDateSettings a new object with the date settings.

A Date object, string or millisecond number are gotten in order to convert it in an formatted string date

• Some strings are valid

• IDate a formmatted date or the same value if format does not match

Gets the separator of the date format

• string a separator string

Gets the timezone object by the given argument or the model object

• In any case, the offset is prioritized. It means, offset overrides other properties.
• If the offset is undefined, the type is used to calculate the offset

• IDTimezone a new timezone object

Gets the offset of the timezone by the given objects

• Searchs the first argument
• If the timezone is empty, in the model timezone is searched
• If it does not exist in any, a default one is set.

• IDTimezoneOffset the offset of the objects

Gets the type of the timezone

• Searchs the first argument
• If it does not exist, asking for the timezone offset in order to prioritized the offset above all.
• If the timezone is empty, in the model timezone is searched.
• If it does not exist in any, a default one is set.

• IDTimezoneType the rigth type of the timezone

Gets the type by a offset

• For a offset=0 the type is default
• For a offset="browser" the type is browser
• For a valid offset different to previous ones, the type is fixed;
• Anything else, it is considered default.

• IDTimezoneType the right timezone type for the offset

Gets the UTC string by the timezone object

• string the label of the UTC value

Gets the timezone offset by the timezone type. For browser types, it is calculated by a Date instance Default types is UTC-0 Undefined or Fixed types is gotten by the offset property

• IDTimezoneOffset the offset of the timezone

Gets the week number of the year Additionally, the month and the year

• IDateWeek an object with the week, month and year or undefined if the date is not valid.

Gets the UTC format dependeing on the given offset

• string an string with the UTC format

If the date is a valid Date object, return true, otherwise return false.

• boolean True: The Date object is valid

Validate if offset uses a valid ISO 8601 offset specification

• If the given offset is a numeric, returns an invalid flag.

• boolean true if the given offset is valid

Checks if the given date is allowed to continue the process for adapting dates

• If the string is a token or a combination of tokens is not valid

• true: the date is valid.

Validates if the given date has tokens

• boolean true: the date has tokens

Validates if the given date is a date instance

• boolean true: the date is a date instance

Validates if the given date is a string date

• boolean true: the date is a string date

Validates if the given param is a valid timezone offset

• boolean true: is valid timezone offset.

Validates if the given offset is in the timezone range

• boolean true: the offset is in the timezone range

Validate a string date depending on giving format

• If the string is a token label, the function lets it pass.
• Otherwise depends of the format
• Some escenarios the string is a mix of token labels and dates

• boolean True if it is valid or not. Undefined if date is undefined

Generates a Flattened UI filter structure from Filter Data structure.

• a flattened UI filters array

Generates a Filter Builder Structure from the Filter Data structure v2.1

• a flattened UI filters array

Generates a Filter Logic structure from Filter Data structure.

• a filter logic array

Gets the logic body

• a filter logic array

Generates a UI filter structure from Filter Data structure.

• a UI Filters structure

Generates a UI filter Structure from the Filter Data structure v2.1

• a UI filter Structure

Generates a Filter Data Structure structure from UI Filter Data structure.

• a Filter Data structure

Builds the Fitler Data structure from UI filter data

• a Filter Data structure

Generates a Flattened UI filter structure from UI Filter Data structure.

• a flattened UI filters array

Generates a Flattened UI Filter Structure from the UI Filter Data structure v2.1

• a flattened UI filters array

[TODO: For 2022, eliminate this adapter] Get the new property base on the old date grouping properties

• a adapted property

Checks and adapts the v2.0 Filter Data Structure to the v2.1

• A new filter data structure v2.1

[TODO: For 2022, eliminate this adapter] Gets an adapted filter value array. Validates the enabled property and sets

• A new value array with the filled properties.

Generates a filter data structure from the flatttened UI filters.

• a Filter Data.

Gets an array of scopes structure for the filter data. The scopes is organized by scope types and scope IDs Also, adds and organizes filters by datasets

• an array of scopes structure.

Gets an scope structure for the filter data

• an scope structure

Gets an dataset structure for the filter data

• an dataset structure

Gets an filter structure for the filter data

• an filter structure

Generates a Logic structure from flattened UI filters

• The logic structure

Generates a Logic structure from flattened UI filters

• The logic structure

Generates a UI filter data structure from the flatttened UI filters.

• a UI Filter Data.

Gets an array of scopes structure for the UI filter data. The scopes is organized by scope types and scope IDs Also, adds and organizes filters by datasets

• an array of scopes structure.

Gets an scope structure for the UI filter data

• an scope structure

Gets an dataset structure for the UI filter data

• an dataset structure

Gets an filter structure for the UI filter data

• an filter structure

Generates a filter data structure from the old logic structure (v2.0).

• a Filter Data.

Adapts the Old logic structure (v2.0) to the flattened UI filter Structure.

• The Flattened UI Filters array

Get the filter or the index of the given array, validating an old filter structure.

• the index or the UI filter object

Refines the values of the Ranking column type.

• the array of Ranking values

Generates a UI filter structure from the old logic structure (v2.0).

• a UI Filter Data.

Adapter for model answer to convert to recognizable values for Filter Builder

• Array of values

Resolves statement and returns statement value

• AbsoluteRange string

Resolves statement as an anchor

• string

Convert verbal statement to range value

• AbsoluteRange

Apply 'this' cursor logic to statement

• AbsoluteStatement

Apply 'the last' cursor logic to statement

• AbsoluteStatement

Apply 'the next' cursor logic to statement

• AbsoluteStatement

Replace '@now' token inside a string

• string

Returns a range object (date) from a group of statement params

pivot = '2021-03-03T12:30:40'
unit = month
steps = 2
setTo = END
resolverAsCalendar: true
=> Returns  '2021-05-31T23:59:59'

pivot = '2021-03-03T12:30:40'
unit = month
steps = -2
setTo = START
resolverAsCalendar: false
=> Returns '2021-01-03T00:00:00'

• string

Resolve a list of relative statements according to operator

Input:
{
 "cursor": "the_next",
 "unit": "year",
 "number": 1,
 "includeCurrent": false,
 "isCalendarDate": false,
 "anchor": "03/05/2021"
}

Output:
{ gte: "03/06/2021 00:00:00", lte: "03/05/2022 23:59:59" }

• the filter aggregate structure

Filters and gets the filters used for aggregate values.

• the aggregate filters in the IFilterFilters way or as logic structure.

[TODO: Make a proper description for this function]

• the chart settings

It takes an array of tokens and returns a string

• A string

• the aggFilters structure

Gets the Scopes IDS for the Available Scope function by any config

• a Available Scope IDS config

[TODO: Make a description for this]

• A new array of Scopes/Scope IDs

It takes a filter object and returns an array of tokens that represent the filter

• Array.<IFFilterTokens> An array of tokens that represents the filters object

It takes a set of filters and returns a string that describes the filters

• A string

Gets Scopes/Scope IDs by given IDs

• a Scopes/Scope IDs array

[TODO: The decimals dots are not working correctly, we need to reviewing (fractionDigits)] "Convert a number of seconds to a human readable string."

addDurationFormat is a function that takes a number, a format, an optional locale, and an optional number of fraction digits, and returns a string

• A string

It sets the locale formatter for the number.

• Void

It returns a new instance of the Intl.NumberFormat class, which is a built-in JavaScript class that formats numbers

• A new instance of the Intl.NumberFormat class.

It takes a template string and sets the parts property to the result of calling the parseFormatTemplate function with the template string as an argument

• Void

It replaces the H and D characters in the template with h and d respectively

• The template string with all instances of H replaced with h and all instances of D replaced with d.

It sets the numberFactor to the value of the duration part that matches the unit.

• Void

It takes a string, splits it into an array of strings, then maps each string to a config object, then filters out any falsy values, then reverses the array

• An array of objects that have the order and the name of the part of the duration.

It takes a number, multiplies it by a factor, then uses the parts array to calculate the number of each part in the number, then uses the template to format the number

• The template string with the values replaced.

It takes a dictionary of values and a list of keys, and returns a formatted string

• The value of the part of the date that is being formatted.

This class allows to use the translation service of the i18next library

• Void

Determines if the given column is belonging to static values questions. Static values questions are questions that do not need request an info from backend, instead the info is got from Model, Question/List object.

• true if the column belongs to a static values question; otherwise, false

Special function for Expression Columns. This function allows validating if expression columns have active category option. This is esential in order to display the asigned property for expression.

• true if expression column is categorizable; otherwise not. If does not exist, undefined is sent.

Get answers located in model object. If column exists in the model, answers will be gotten depending on column type. For Rating columns, needs a number sequence (From 1 to 5). For Expression columns, needs a property type attribute for categorizable ones; for non-categorizable expressions is not required this attribute. For the others columns, answers is located in the property of the same name.

• Formatted answers inside of answer property.

Gets a dataset by a given partial column

• the found dataset or undefined

Get the answers of expression columns. Depends of the property attribute and if the column is categorizable.

• Formatted answers inside of an answer property.

Get the answers of dropdown columns. Answers is a direct array of strings so it is necessary to format them.

• Formatted answers inside of an answer property.

Get the answers of image columns.

• Formatted answers inside of an answer property.

Special function for Image Upload This function returns if the current column has object or text analysis as property.

• true if this column has analysis. Otherwise false.

Get the answers of rating columns.

• Formatted answers inside of an answer property

Get the answers of slidebar columns. The quantity of answers depend on the steps chosen in maker.

• Formatted answers inside of an answer property

Gets a string of the translate structure by the given column

• a string of the translation structure where the label is located.

Get a string value with suffixes if available. Add suffix into the value string. Prioritized for numeric values.

• a string value with suffix

Get the answers of Yes/No columns. Yes/No answers from model object are capitalized but the filters need values in lowercase.

• Formatted answers inside of an answer property

Transforms a value depending of localization/globalization and extras settings.

• A transformed value

Gets the default settings properties

• ITransformValueSettings the settings with default properties

Gets the outputformat settings

• the outputformat settings

Gets the format config if the locale exists in i18n settings

• the format config

If the property is a day, return the date format without the time, otherwise return the original format.

• The outputFormat of the column.

Get the format related to the columnn property. If the property is hour, minute, second, or undefined, return true.

• boolean A boolean value.

Compares two objects to know if they are equals. Go across nested objects. Includes arrays in the comparison.

• True: objects are equal. False: Objects are not equal. Undefined: invalid

Gets the toStringTag of value.

• string Returns the toStringTag.

Import a set of external Scripts given the URL in both serie and cascade way

// 1) Simple script (paralell loading)
importScripts(['http://myscript.js', 'http://another.js']);

// 2) Loading `.js` and `.esm.js` script (parallel loading)
importScripts([
  { url: 'http://myscript.esm.js', type: 'module' },
  { url: 'http://myscript.js', noModule: true }
]);

// 3) import dependent scripts (cascade)
importScripts([
  { url: 'http://myscript.js', dependencies: ['http://myscript.plugin.js'] }
]);

// 4) mix
importScripts([
  { url: 'http://myscript.js', dependencies: ['http://myscript.plugin.js'] },
  { url: 'http://another.esm.js', type: 'module' },
  { url: 'http://another.js', noModule: true },
  'http://simplescript.js'
]);

• Promise Promise when all script have been loaded

Creates the script element and appends to document.head return a Promise that is resolved when the script is loaded

• Void

Validates if the given argument is empty

• true: the given argument is empty; false: is not.

Validates if the recieved number is NaN type.

Conditions:

• This function recieves any variable but will return true if it is different to number.
• Empty variables as undefined, null, empty string will return true.

Special case for isNaN

• The isNaN('') is considered as false statement. The empty string is converted to 0 which is not NaN.
• Boolean variables is considered as false statement.
• Date objects is considered as true.

• True: variable is a NaN; False: The variable is a number

return if a given variable is either null or undefined useful to avoid falsify validating Number Zero (0)

• Boolean

Creates a random string

• If the first given argument is different than a length number, the variable is replaced by a default number
• If the optional second given argument is passed the random string is permutated.

• String Random string

Gets the length of the given array.

• Useful for Object, Array and string type.
• For null or undefined or else argument the returned value will be 0.

• Number the size of the given variable

Gets the numeric sign of a given number

• string an string with the sign

Upper case the first letter of a given text

• String a capitalized text

Sets an amount of zeros as prefix of the given number by its length

num = 100
size = 2
padding = true
=> Returns  "100"

num = 100
size = 5
padding = true
=> Returns  "00100"

num = 100
size = 2
padding = false
=> Returns  "00100"

num = 100
size = 5
padding = false
=> Returns  "00000100"

• the string of the number with the prefixed zeros

Gets the absolute number of the giving parameters

• string the absolute number

Gets the number sign

• string the number sign

It takes an array of objects, adds a property to each object, and returns the new array.

<caption>Example usage of addPropertyToArrayOfObjects.</caption> addPropertyToArrayOfObjects({
	array: [{ name: "John", lastName: "Doe" }, { name: "Chris", lastName: "Musk" }],
	property: "lastName",
	value: 'Peck'
});

• the new array created.

Inmutable Array Item deletion

• a new Array or the given parameter when is empty or not an array

Filters a nested tree array by a custom condition on the last child node

• If the given arguments are not valid, the function returns the first argument.
• If the childArrKey is not matched in the object, the condition tries to resolve the filter anyway and returns an empty array.
• If the condition is not fulfilled, the function returns a filtered array, probably a empty array inside of the child array

• array filtered

Flat deeply an array

• flatten array

Gets a collection of object values by the given property

• a collection of values by property

Gets the first index from the array by a callback condition

• the first index of the array. -1 when the condition is not satisfied

Gets the last index from the array by a callback condition

• the last index of the array. -1 when the condition is not satisfied

Remove duplicated items from a given array by property name // 1. Store the keys of the unique objects // 2. Eliminate the dead keys & store unique objects

• Array without duplicated items.

Transforms the date+times propertiesof the given object by the Timezone object

• IFSData IFUData the new filter data with the transformed datetime values

A simple Deep Cloning function. Valid only for primivite values and object with primitive values. Not to use this function with inner objects and functions

• The new reference object or the given object if the parsing is incorrect or empty

Like lodash _.get. Gets the value at path of object. If the resolved value is undefined, the defaultValue is returned in its place.

Empty arrays and empty objects are returned but the defaultValue is not Undefined and null values will return the defaultValue.

// returns 'Hello'
_get({ item1: 'Hello', item2: 'World' }, 'item1')

// returns 'A simple Hello'
_get({ item1: 'Hello', item2: 'World' }, 'item3', 'A simple Hello')

// returns 'Hello Again'
_get({ item1: { item11: 'Hello Again' }, item2: {} }, 'item1.item11')

// returns 'Hello 2'
_get({ item1: ['Hello 1', 'Hello 2' }, item2: [] }, 'item1[1]')

// returns 'Hello Again'
_get({ item1: { item11: 'Hello Again' }, item2: {} }, ['item1', 'item11'])

• the resolved value.

Searchs for properties in different case styles such as: lower, upper, camel and pascal

• To optimize the searching, it is required a key in a snake_case style
• List of cases that do not match -- From lower to snake case -- From upper to snake case -- From lower to camel case -- From upper to camel case -- From lower to pascal case -- From upper to pascal case

getAttribute(obj, 'snake_case') //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE

• Void

Use the hasOwnProperty in order to verify if the given property exists in the object.

const prop = 'prop2'
const obj1 = { prop1: 'hello', prop2: 'world'}
_hasProperty(ob1, prop1) // true

const obj2 = { prop1: 'hello world' }
_hasProperty(ob1, prop2) // false

• True if the object has the given property; otherwise, false.

Checks if the given argument is an object type

• True: It is an object; False: It is not.

Invoke iteratee (function) for each object key-value pair and return a mapped object

• Object New mapped object.

Merges two objects into a new one. The second given argument to the first given argument.

• a new merged object

Validates if the two arguments are objects