@qrvey/utils 1.10.1 → 1.11.0-1

package/dist/cjs/filters/helpers/common/getVerboseFilterScopes.js

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getVerboseFilterScopes = void 0;
+const isEmpty_1 = require("../../../general/mix/isEmpty");
+const isObject_1 = require("../../../general/object/isObject");
+const I18N_FILTER_OPERATOR_1 = require("../../../globalization/labels/filters/I18N_FILTER_OPERATOR");
+const I18N_FILTER_SCOPE_1 = require("../../../globalization/labels/filters/I18N_FILTER_SCOPE");
+const FILTER_OPERATOR_1 = require("../../constants/common/FILTER_OPERATOR");
+const getVerboseFilterDatasets_1 = require("./getVerboseFilterDatasets");
+const getVerboseFilters_1 = require("./getVerboseFilters");
+/**
+ * Gets an string that describes the filter scopes content
+ * @param {IFUScope[]} filters The filters scopes to verbose
+ * @param {IFFGetVerboseFilters} settings the settings to the function
+ * @returns A string
+ */
+function getVerboseFilterScopes(scopes, settings) {
+    if ((0, isEmpty_1.isEmpty)(scopes) || !Array.isArray(scopes))
+        return "";
+    const defaultSettings = (0, getVerboseFilters_1.getVerboseFiltersSettings)(settings);
+    const filteredScopes = getScopes(scopes, defaultSettings);
+    return filteredScopes.reduce((verbose, scope, currentIndex, array) => {
+        let newVerbose = "";
+        const title = getTitle(scope, defaultSettings);
+        const titleSeparator = getTitleSeparator(defaultSettings);
+        const datasetsVerbose = (0, getVerboseFilterDatasets_1.getVerboseFilterDatasets)(scope.datasets, defaultSettings);
+        const newSeparator = getSeparator(defaultSettings, currentIndex >= array.length - 1);
+        newVerbose += `${(0, isEmpty_1.isEmpty)(title) ? "" : `${title}${titleSeparator}`}${datasetsVerbose}${newSeparator}`;
+        return `${verbose}${newVerbose}`;
+    }, "");
+}
+exports.getVerboseFilterScopes = getVerboseFilterScopes;
+/**
+ * Gets the scopes by some conditions
+ * @param {IFUScope[]} filters The filtered scopes to verbose
+ * @param {IFFGetVerboseFilters} settings the settings to the function
+ * @returns {IFUScope[]} the collection of the scopes
+ */
+function getScopes(scopes, settings) {
+    return scopes.filter((scope) => (0, isObject_1.isObject)(scope) &&
+        (settings.scopeDisplayDisplayed || scope.displayed) &&
+        (settings.scopeEnableDisplayed || scope.enabled));
+}
+/**
+ * Gets the title of the filter scope
+ * @param {IFUScope} scope the filter scope info
+ * @param {IFFGetVerboseFilters} settings the settings of the function
+ * @returns {string} the title of the filter scope
+ */
+function getTitle(scope, settings) {
+    if (settings.scopeTitleDisplayed) {
+        return (0, isEmpty_1.isEmpty)(settings.translate)
+            ? scope.label || I18N_FILTER_SCOPE_1.I18N_FILTER_SCOPE[scope.scope.toLowerCase()] || ""
+            : settings.translate(`filter.scope_title.${scope.scope.toLowerCase()}`);
+    }
+    return "";
+}
+/**
+ * Gets the separators for the title. It would be
+ * - New Line
+ * - An string from argument
+ * @param {IFFGetVerboseFilters} settings the settings of the module
+ * @returns {string} the string of the title separator
+ */
+function getTitleSeparator(settings) {
+    let newLine = "";
+    if (settings.scopeTitleNewLine) {
+        newLine = "\n";
+    }
+    else if (!(0, isEmpty_1.isEmpty)(settings.scopeTitleSeparator)) {
+        newLine = settings.scopeTitleSeparator;
+    }
+    return newLine;
+}
+/**
+ * Gets the separators of each filter. It would be
+ * - New Line
+ * - The operator
+ * - An string from argument
+ * @param {IFFGetVerboseFilters} settings the settings of the module
+ * @returns {string} the string of the separator
+ */
+function getSeparator(settings, lastValue = false) {
+    let newLine = "";
+    if (lastValue)
+        return newLine;
+    if (settings.scopeNewLine) {
+        newLine = "\n";
+    }
+    else if (settings.scopeOperatorDisplayed) {
+        newLine = (0, isEmpty_1.isEmpty)(settings.translate)
+            ? I18N_FILTER_OPERATOR_1.I18N_FILTER_OPERATOR.and
+            : settings.translate(`filter.operators.${FILTER_OPERATOR_1.FILTER_OPERATOR.AND.toLowerCase()}`);
+        newLine = ` ${newLine} `;
+    }
+    else {
+        newLine = settings.scopeSeparator;
+    }
+    return newLine;
+}

package/dist/cjs/filters/helpers/common/getVerboseFilterValues.d.ts

@@ -0,0 +1,9 @@
+import { IFFGetVerboseFilters } from "../../interfaces/functions/IFFGetVerboseFilters";
+import { IFUFilter } from "../../interfaces/ui/IFUFilter";
+/**
+ * Gets an string that describes the filter values content
+ * @param {IFValue[]} filters The filter values to verbose
+ * @param {IFFGetVerboseFilters} settings the settings to the function
+ * @returns the description of the filter values
+ */
+export declare function getVerboseFilterValues(filter: IFUFilter, settings?: IFFGetVerboseFilters): string;

package/dist/cjs/filters/helpers/common/getVerboseFilterValues.js

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getVerboseFilterValues = void 0;
+const COLUMN_1 = require("../../../columns/constants/COLUMN");
+const isEmpty_1 = require("../../../general/mix/isEmpty");
+const isObject_1 = require("../../../general/object/isObject");
+const I18N_FILTER_OPERATOR_1 = require("../../../globalization/labels/filters/I18N_FILTER_OPERATOR");
+const I18N_FILTER_PANEL_1 = require("../../../globalization/labels/filters/I18N_FILTER_PANEL");
+const FILTER_OPERATOR_1 = require("../../constants/common/FILTER_OPERATOR");
+const getUIValues_1 = require("../ui/getUIValues");
+const getVerboseFilters_1 = require("./getVerboseFilters");
+/**
+ * Gets an string that describes the filter values content
+ * @param {IFValue[]} filters The filter values to verbose
+ * @param {IFFGetVerboseFilters} settings the settings to the function
+ * @returns the description of the filter values
+ */
+function getVerboseFilterValues(filter, settings) {
+    if ((0, isEmpty_1.isEmpty)(filter) ||
+        !(0, isObject_1.isObject)(filter) ||
+        (!filter.selectAll && (0, isEmpty_1.isEmpty)(filter.values)))
+        return "";
+    const defaultSettings = (0, getVerboseFilters_1.getVerboseFiltersSettings)(settings);
+    const values = getValues(filter, defaultSettings);
+    const newSeparator = getSeparator(defaultSettings);
+    const stringValues = values.join(newSeparator);
+    if (filter.selectAll) {
+        if ((0, isEmpty_1.isEmpty)(values)) {
+            return (0, isEmpty_1.isEmpty)(defaultSettings.translate)
+                ? I18N_FILTER_PANEL_1.I18N_FILTER_PANEL.card_all_selected
+                : defaultSettings.translate("filter_panel.card_all_selected");
+        }
+        return `${(0, isEmpty_1.isEmpty)(defaultSettings.translate)
+            ? I18N_FILTER_PANEL_1.I18N_FILTER_PANEL.card_all_except
+            : defaultSettings.translate("filter_panel.card_all_except")} ${stringValues}`;
+    }
+    else if ((0, isEmpty_1.isEmpty)(values)) {
+        return (0, isEmpty_1.isEmpty)(defaultSettings.translate)
+            ? I18N_FILTER_PANEL_1.I18N_FILTER_PANEL.card_none_selected
+            : defaultSettings.translate("filter_panel.card_none_selected");
+    }
+    return stringValues;
+}
+exports.getVerboseFilterValues = getVerboseFilterValues;
+/**
+ * Gets the value collection of the filter by some conditions
+ * @param {IFValue} filter The filter to get the values
+ * @param {IFFGetVerboseFilters} settings the settings to the function
+ * @returns {string[]} the collection of the filter values
+ */
+function getValues(filter, settings) {
+    const uiValues = (0, getUIValues_1.getUIValues)(filter, Object.assign(Object.assign({}, settings), { addEnableds: true }));
+    return uiValues
+        .map((uiValue) => {
+        if ((settings.valueDisplayDisplayed || uiValue.displayed) &&
+            (settings.valueEnableDisplayed || uiValue.enabled))
+            return getValue(filter, uiValue);
+    })
+        .filter(Boolean);
+}
+/**
+ * Gets the separators of each values. It would be
+ * - New Line
+ * - The operator
+ * - An string from argument
+ * @param {number} currentIndex the iteration index of the value
+ * @param {IFUValue[]} values the collection of values
+ * @param {IFFGetVerboseFilters} settings the settings of the module
+ * @returns {string} the string of the separator
+ */
+function getSeparator(settings) {
+    let newLine = "";
+    if (settings.valueNewLine) {
+        newLine = "\n";
+    }
+    else if (settings.valueOperatorDisplayed) {
+        newLine = (0, isEmpty_1.isEmpty)(settings.translate)
+            ? I18N_FILTER_OPERATOR_1.I18N_FILTER_OPERATOR.or
+            : settings.translate(`filter.operators.${FILTER_OPERATOR_1.FILTER_OPERATOR.OR.toLowerCase()}`);
+        newLine = ` ${newLine} `;
+    }
+    else {
+        newLine = settings.valueSeparator;
+    }
+    return newLine;
+}
+/**
+ * Gets the value according to the filter info
+ * - When the filter column type is image the URL should be returned in case value is undefined.
+ * @param {IFUFilter} filter the filter object
+ * @param {IFUValue} value the value item
+ * @returns {string} the resulting value
+ */
+function getValue(filter, value) {
+    let newValue = value.value || "";
+    if (filter.column.type === COLUMN_1.COLUMN.IMAGE) {
+        newValue = value.value || value.imageUrl || "";
+    }
+    return newValue;
+}

package/dist/cjs/filters/helpers/common/getVerboseFilters.d.ts

@@ -0,0 +1,10 @@
+import { IFFGetVerboseFilters } from "../../interfaces/functions/IFFGetVerboseFilters";
+import { IFUData } from "../../interfaces/ui/IFUData";
+/**
+ * Gets an string that describes the filter data content
+ * @param {IFUData} filters The filters object to verbose
+ * @param {IFFGetVerboseFilters} settings the settings for the function
+ * @returns A string
+ */
+export declare function getVerboseFilters(filterData: IFUData, settings?: IFFGetVerboseFilters): string;
+export declare function getVerboseFiltersSettings(settings?: IFFGetVerboseFilters): IFFGetVerboseFilters;

package/dist/cjs/filters/helpers/common/getVerboseFilters.js

@@ -0,0 +1,91 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getVerboseFiltersSettings = exports.getVerboseFilters = void 0;
+const isEmpty_1 = require("../../../general/mix/isEmpty");
+const getVerboseFilterScopes_1 = require("./getVerboseFilterScopes");
+/**
+ * Gets an string that describes the filter data content
+ * @param {IFUData} filters The filters object to verbose
+ * @param {IFFGetVerboseFilters} settings the settings for the function
+ * @returns A string
+ */
+function getVerboseFilters(filterData, settings) {
+    if ((0, isEmpty_1.isEmpty)(filterData) || (0, isEmpty_1.isEmpty)(filterData.scopes))
+        return "";
+    return (0, getVerboseFilterScopes_1.getVerboseFilterScopes)(filterData.scopes, settings);
+}
+exports.getVerboseFilters = getVerboseFilters;
+function getVerboseFiltersSettings(settings) {
+    var _a;
+    return Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, getVerboseFilterDatasetsSettings(settings)), getVerboseFilterFiltersSettings(settings)), getVerboseFilterScopesSettings(settings)), getVerboseFilterValuesSettings(settings)), { chartLabelDisplayed: (_a = settings === null || settings === void 0 ? void 0 : settings.chartLabelDisplayed) !== null && _a !== void 0 ? _a : true, translate: settings === null || settings === void 0 ? void 0 : settings.translate });
+}
+exports.getVerboseFiltersSettings = getVerboseFiltersSettings;
+/**
+ * Gets the dataset settings by the given settings
+ * @param {IFFGetVerboseFilters} settings the settings for the function
+ * @returns the dataset settings
+ */
+function getVerboseFilterDatasetsSettings(settings) {
+    var _a, _b, _c, _d, _e, _f;
+    return {
+        datasetDisplayDisplayed: (_a = settings === null || settings === void 0 ? void 0 : settings.datasetDisplayDisplayed) !== null && _a !== void 0 ? _a : true,
+        datasetEnableDisplayed: (_b = settings === null || settings === void 0 ? void 0 : settings.datasetEnableDisplayed) !== null && _b !== void 0 ? _b : true,
+        datasetTitleDisplayed: (_c = settings === null || settings === void 0 ? void 0 : settings.datasetTitleDisplayed) !== null && _c !== void 0 ? _c : true,
+        datasetTitleNewLine: (_d = settings === null || settings === void 0 ? void 0 : settings.datasetTitleNewLine) !== null && _d !== void 0 ? _d : false,
+        datasetTitleSeparator: (settings === null || settings === void 0 ? void 0 : settings.datasetTitleSeparator) || ": ",
+        datasetNewLine: (_e = settings === null || settings === void 0 ? void 0 : settings.datasetNewLine) !== null && _e !== void 0 ? _e : false,
+        datasetOperatorDisplayed: (_f = settings === null || settings === void 0 ? void 0 : settings.datasetOperatorDisplayed) !== null && _f !== void 0 ? _f : false,
+        datasetSeparator: (settings === null || settings === void 0 ? void 0 : settings.datasetSeparator) || ", ",
+    };
+}
+/**
+ * Gets the filter settings by the given settings
+ * @param {IFFGetVerboseFilters} settings the settings for the function
+ * @returns the filter settings
+ */
+function getVerboseFilterFiltersSettings(settings) {
+    var _a, _b, _c, _d, _e, _f;
+    return {
+        filterDisplayDisplayed: (_a = settings === null || settings === void 0 ? void 0 : settings.filterDisplayDisplayed) !== null && _a !== void 0 ? _a : true,
+        filterEnableDisplayed: (_b = settings === null || settings === void 0 ? void 0 : settings.filterEnableDisplayed) !== null && _b !== void 0 ? _b : true,
+        filterTitleDisplayed: (_c = settings === null || settings === void 0 ? void 0 : settings.filterTitleDisplayed) !== null && _c !== void 0 ? _c : true,
+        filterTitleNewLine: (_d = settings === null || settings === void 0 ? void 0 : settings.filterTitleNewLine) !== null && _d !== void 0 ? _d : false,
+        filterTitleSeparator: (settings === null || settings === void 0 ? void 0 : settings.filterTitleSeparator) || ": ",
+        filterNewLine: (_e = settings === null || settings === void 0 ? void 0 : settings.filterNewLine) !== null && _e !== void 0 ? _e : false,
+        filterOperatorDisplayed: (_f = settings === null || settings === void 0 ? void 0 : settings.filterOperatorDisplayed) !== null && _f !== void 0 ? _f : false,
+        filterSeparator: (settings === null || settings === void 0 ? void 0 : settings.filterSeparator) || ", ",
+    };
+}
+/**
+ * Gets the scope settings by the given settings
+ * @param {IFFGetVerboseFilters} settings the settings for the function
+ * @returns the scope settings
+ */
+function getVerboseFilterScopesSettings(settings) {
+    var _a, _b, _c, _d, _e, _f;
+    return {
+        scopeDisplayDisplayed: (_a = settings === null || settings === void 0 ? void 0 : settings.scopeDisplayDisplayed) !== null && _a !== void 0 ? _a : true,
+        scopeEnableDisplayed: (_b = settings === null || settings === void 0 ? void 0 : settings.scopeEnableDisplayed) !== null && _b !== void 0 ? _b : true,
+        scopeTitleDisplayed: (_c = settings === null || settings === void 0 ? void 0 : settings.scopeTitleDisplayed) !== null && _c !== void 0 ? _c : true,
+        scopeTitleNewLine: (_d = settings === null || settings === void 0 ? void 0 : settings.scopeTitleNewLine) !== null && _d !== void 0 ? _d : false,
+        scopeTitleSeparator: (settings === null || settings === void 0 ? void 0 : settings.scopeTitleSeparator) || ": ",
+        scopeNewLine: (_e = settings === null || settings === void 0 ? void 0 : settings.scopeNewLine) !== null && _e !== void 0 ? _e : false,
+        scopeOperatorDisplayed: (_f = settings === null || settings === void 0 ? void 0 : settings.scopeOperatorDisplayed) !== null && _f !== void 0 ? _f : false,
+        scopeSeparator: (settings === null || settings === void 0 ? void 0 : settings.scopeSeparator) || ", ",
+    };
+}
+/**
+ * Gets the value settings by the given settings
+ * @param {IFFGetVerboseFilters} settings the settings for the function
+ * @returns the value settings
+ */
+function getVerboseFilterValuesSettings(settings) {
+    var _a, _b, _c, _d;
+    return {
+        valueDisplayDisplayed: (_a = settings === null || settings === void 0 ? void 0 : settings.valueDisplayDisplayed) !== null && _a !== void 0 ? _a : true,
+        valueEnableDisplayed: (_b = settings === null || settings === void 0 ? void 0 : settings.valueEnableDisplayed) !== null && _b !== void 0 ? _b : true,
+        valueNewLine: (_c = settings === null || settings === void 0 ? void 0 : settings.valueNewLine) !== null && _c !== void 0 ? _c : false,
+        valueOperatorDisplayed: (_d = settings === null || settings === void 0 ? void 0 : settings.valueOperatorDisplayed) !== null && _d !== void 0 ? _d : false,
+        valueSeparator: (settings === null || settings === void 0 ? void 0 : settings.valueSeparator) || ", ",
+    };
+}

package/dist/cjs/filters/helpers/common/index.d.ts

@@ -16,6 +16,11 @@ export * from "./getMergeFiltersSettings";
 export * from "./getParamsToGetFilterSettings";
 export * from "./getValuesFromModel";
 export * from "./getValuesFromDataset";
+export * from "./getVerboseFilterDatasets";
+export * from "./getVerboseFilterFilters";
+export * from "./getVerboseFilters";
+export * from "./getVerboseFilterScopes";
+export * from "./getVerboseFilterValues";
 export * from "./haveFiltersByDataset";
 export * from "./isBetweenValidator";
 export * from "./isDateDistinctProperty";

package/dist/cjs/filters/helpers/common/index.js

@@ -32,6 +32,11 @@ __exportStar(require("./getMergeFiltersSettings"), exports);
 __exportStar(require("./getParamsToGetFilterSettings"), exports);
 __exportStar(require("./getValuesFromModel"), exports);
 __exportStar(require("./getValuesFromDataset"), exports);
+__exportStar(require("./getVerboseFilterDatasets"), exports);
+__exportStar(require("./getVerboseFilterFilters"), exports);
+__exportStar(require("./getVerboseFilters"), exports);
+__exportStar(require("./getVerboseFilterScopes"), exports);
+__exportStar(require("./getVerboseFilterValues"), exports);
 __exportStar(require("./haveFiltersByDataset"), exports);
 __exportStar(require("./isBetweenValidator"), exports);
 __exportStar(require("./isDateDistinctProperty"), exports);

package/dist/cjs/filters/helpers/settings/getFilterSettings.js

@@ -265,12 +265,7 @@ function getFilterSettingsByDefaultWithOneAdditionalScope(settings) {
  * @returns a new filter settings object
  */
 function getFilterSettingsByOnlyPanelScope(settings) {
-    const newSettings = {
-        chartBuilder: {
-            addFilterDisplayed: false,
-            filterSectionDisplayed: false,
-        },
-    };
+    const newSettings = getFilterSettingsByNoDefaultScope(settings);
     return (0, mergeDeep_1.mergeDeep)(settings, newSettings);
 }
 /**

package/dist/cjs/filters/helpers/ui/getUIValues.js

@@ -17,8 +17,10 @@ const isRankingFilter_1 = require("../common/isRankingFilter");
  * @returns an array of values
  */
 function getUIValues(filter, settings) {
-    const defaultSettings = getUiValuesSettings(settings);
     const values = filter.values || [];
+    if ((0, isEmpty_1.isEmpty)(values) || !Array.isArray(values))
+        return [];
+    const defaultSettings = getUiValuesSettings(settings);
     switch (filter.validator) {
         case FILTER_VALIDATOR_1.FILTER_VALIDATOR.AFTER:
         case FILTER_VALIDATOR_1.FILTER_VALIDATOR.GREATER_THAN:

package/dist/cjs/filters/interfaces/functions/IFFGetVerboseFilters.d.ts

@@ -0,0 +1,34 @@
+import { II18nServiceTranslate } from "../../../globalization/interfaces/II18nServiceTranslate";
+export interface IFFGetVerboseFilters {
+    chartLabelDisplayed?: boolean;
+    datasetDisplayDisplayed?: boolean;
+    datasetEnableDisplayed?: boolean;
+    datasetNewLine?: boolean;
+    datasetOperatorDisplayed?: boolean;
+    datasetSeparator?: string;
+    datasetTitleDisplayed?: boolean;
+    datasetTitleNewLine?: boolean;
+    datasetTitleSeparator?: string;
+    filterDisplayDisplayed?: boolean;
+    filterEnableDisplayed?: boolean;
+    filterNewLine?: boolean;
+    filterOperatorDisplayed?: boolean;
+    filterTitleDisplayed?: boolean;
+    filterTitleNewLine?: boolean;
+    filterTitleSeparator?: string;
+    filterSeparator?: string;
+    scopeDisplayDisplayed?: boolean;
+    scopeEnableDisplayed?: boolean;
+    scopeNewLine?: boolean;
+    scopeOperatorDisplayed?: boolean;
+    scopeTitleDisplayed?: boolean;
+    scopeTitleNewLine?: boolean;
+    scopeTitleSeparator?: string;
+    scopeSeparator?: string;
+    translate?: II18nServiceTranslate;
+    valueDisplayDisplayed?: boolean;
+    valueEnableDisplayed?: boolean;
+    valueNewLine?: boolean;
+    valueOperatorDisplayed?: boolean;
+    valueSeparator?: string;
+}

package/dist/cjs/filters/interfaces/functions/IFFGetVerboseFilters.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/globalization/labels/bucket_builder/I18N_BUCKET_BUILDER.js

@@ -77,7 +77,7 @@ exports.I18N_BUCKET_BUILDER = {
         title: "Available Buckets",
         counter_one: "Bucket",
         counter_other: "Buckets",
-        no_columns: "No bucketed columns created",
+        no_columns: "No bucketed columns have been created.",
         copy: "Copy",
     },
     menu_bucket: {

package/dist/cjs/globalization/labels/index.d.ts

@@ -1,7 +1,6 @@
 export * from "./bucket_builder";
 export * from "./calendar";
 export * from "./chart_builder";
-export * from "./columns";
 export * from "./common";
 export * from "./cross_tabs";
 export * from "./dashboard";

package/dist/cjs/globalization/labels/index.js

@@ -17,7 +17,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./bucket_builder"), exports);
 __exportStar(require("./calendar"), exports);
 __exportStar(require("./chart_builder"), exports);
-__exportStar(require("./columns"), exports);
 __exportStar(require("./common"), exports);
 __exportStar(require("./cross_tabs"), exports);
 __exportStar(require("./dashboard"), exports);

package/dist/dates/adapters/ISOToNumericOffset.d.ts

@@ -1,6 +1,6 @@
 /**
  * Gets the numeric offset (minutes) from the ISO offset (string)
- * @param {string} offset the timezone offset
+ * @param {number | string} offset the timezone offset
  * @returns {number} the offset in minutes
  */
 export declare function ISOToNumericOffset(offset: number | string): number;

package/dist/dates/adapters/ISOToNumericOffset.js

@@ -3,7 +3,7 @@ import { getSign } from "../../general/numeric/getSign";
 import { isValidISOOffset } from "../helpers/isValidISOOffset";
 /**
  * Gets the numeric offset (minutes) from the ISO offset (string)
- * @param {string} offset the timezone offset
+ * @param {number | string} offset the timezone offset
  * @returns {number} the offset in minutes
  */
 export function ISOToNumericOffset(offset) {

package/dist/dates/adapters/dateToHms.d.ts

@@ -1,8 +1,9 @@
 import { IDFDateToHmsSettings } from "../interfaces/IDFDateToHmsSettings";
+import { IDate } from "../interfaces/IDate";
 /**
  * * Transform a Date to [HH:mm:ss] date format.
- * @param date String, object or millisencond number of the date
- * @param settings the settings of the dateToHms function
- * @returns string of [HH:mm:ss] date format
+ * @param {IDate} date String, object or millisencond number of the date
+ * @param {IDFDateToHmsSettings} settings the settings of the dateToHms function
+ * @returns {string} string of [HH:mm:ss] date format
  */
-export declare function dateToHms(date: string | Date | number, settings?: IDFDateToHmsSettings): string;
+export declare function dateToHms(date: IDate, settings?: IDFDateToHmsSettings): string;

package/dist/dates/adapters/dateToHms.js

@@ -4,9 +4,9 @@ import { isValidDateObject } from "../helpers/isValidDateObject";
 import { isValidPotentialDate } from "../helpers/isValidPotentialDate";
 /**
  * * Transform a Date to [HH:mm:ss] date format.
- * @param date String, object or millisencond number of the date
- * @param settings the settings of the dateToHms function
- * @returns string of [HH:mm:ss] date format
+ * @param {IDate} date String, object or millisencond number of the date
+ * @param {IDFDateToHmsSettings} settings the settings of the dateToHms function
+ * @returns {string} string of [HH:mm:ss] date format
  */
 export function dateToHms(date, settings) {
     if (!isValidPotentialDate(date))
@@ -23,8 +23,8 @@ export function dateToHms(date, settings) {
 }
 /**
  * Gets the settings for this function.
- * @param settings the settings of the dateToHms function
- * @returns a new object for the settings
+ * @param {IDFDateToHmsSettings} settings the settings of the dateToHms function
+ * @returns {IDFDateToHmsSettings} a new object for the settings
  */
 function getDefaultSettings(settings) {
     var _a, _b, _c;
@@ -32,27 +32,27 @@ function getDefaultSettings(settings) {
 }
 /**
  * Gets the Hours
- * @param date the date object
- * @param settings the settings of the dateToHms function
- * @returns the hour string
+ * @param {Date} date the date object
+ * @param {IDFDateToHmsSettings} settings the settings of the dateToHms function
+ * @returns {string} the hour string
  */
 function getHours(date, settings) {
     return padLeadingZeros(settings.omitHour ? "0" : date.getHours(), 2).slice(-2);
 }
 /**
  * Gets the Minutes
- * @param date the date object
- * @param settings the settings of the dateToHms function
- * @returns the minute string
+ * @param {Date} date the date object
+ * @param {IDFDateToHmsSettings} settings the settings of the dateToHms function
+ * @returns {string} the minute string
  */
 function getMinutes(date, settings) {
     return padLeadingZeros(settings.omitMinute ? "0" : date.getMinutes(), 2).slice(-2);
 }
 /**
  * Gets the Seconds
- * @param date the date object
- * @param settings the settings of the dateToHms function
- * @returns the seconds string
+ * @param {Date} date the date object
+ * @param {IDFDateToHmsSettings} settings the settings of the dateToHms function
+ * @returns {string} the seconds string
  */
 function getSeconds(date, settings) {
     return padLeadingZeros(settings.omitSecond ? "0" : date.getSeconds(), 2).slice(-2);

package/dist/dates/adapters/dateToMdyDate.d.ts

@@ -1,7 +1,9 @@
+import { IDate } from "../interfaces/IDate";
 import { IDateSettings } from "../interfaces/IDateSettings";
 /**
  * Transform a Date to [mm/dd/yyyy] date format.
- * @param date String, object or millisencond number of the date
- * @returns string of [mm/dd/yyyy] date format
+ * @param {IDate} date String, object or millisencond number of the date
+ * @param {IDateSettings} settings the configuration of dates
+ * @returns {string} string of [mm/dd/yyyy] date format
  */
-export declare function dateToMdyDate(date: string | Date | number, settings?: IDateSettings): string;
+export declare function dateToMdyDate(date: IDate, settings?: IDateSettings): string;

package/dist/dates/adapters/dateToMdyDate.js

@@ -6,8 +6,9 @@ import { isValidPotentialDate } from "../helpers/isValidPotentialDate";
 import { dateToHms } from "./dateToHms";
 /**
  * Transform a Date to [mm/dd/yyyy] date format.
- * @param date String, object or millisencond number of the date
- * @returns string of [mm/dd/yyyy] date format
+ * @param {IDate} date String, object or millisencond number of the date
+ * @param {IDateSettings} settings the configuration of dates
+ * @returns {string} string of [mm/dd/yyyy] date format
  */
 export function dateToMdyDate(date, settings) {
     if (!isValidPotentialDate(date))

package/dist/dates/adapters/dateToMonthYear.d.ts

@@ -1,7 +1,9 @@
+import { IDate } from "../interfaces/IDate";
 import { IDateSettings } from "../interfaces/IDateSettings";
 /**
  * Transform a Date to [Month Year] date format.
- * @param date String, object or millisencond number of the date
- * @returns string of [Month Year] date format
+ * @param {IDate} date String, object or millisencond number of the date
+ * @param {IDateSettings} settings the configuration of dates
+ * @returns {string} string of [Month Year] date format
  */
-export declare function dateToMonthYear(date: string | Date | number, settings?: IDateSettings): string;
+export declare function dateToMonthYear(date: IDate, settings?: IDateSettings): string;

package/dist/dates/adapters/dateToMonthYear.js

@@ -5,8 +5,9 @@ import { isValidDateObject } from "../helpers/isValidDateObject";
 import { isValidPotentialDate } from "../helpers/isValidPotentialDate";
 /**
  * Transform a Date to [Month Year] date format.
- * @param date String, object or millisencond number of the date
- * @returns string of [Month Year] date format
+ * @param {IDate} date String, object or millisencond number of the date
+ * @param {IDateSettings} settings the configuration of dates
+ * @returns {string} string of [Month Year] date format
  */
 export function dateToMonthYear(date, settings) {
     if (!isValidPotentialDate(date))

package/dist/dates/adapters/dateToQuarterYear.d.ts

@@ -1,7 +1,9 @@
+import { IDate } from "../interfaces/IDate";
 import { IDateSettings } from "../interfaces/IDateSettings";
 /**
  * Transform a valid Date to [Quarter Year] date format.
- * @param date String of a valid date, date object or millisencond number of the date
- * @returns string of [Quarter Year] date format
+ * @param {IDate} date String of a valid date, date object or millisencond number of the date
+ * @param {IDateSettings} settings the configuration of dates
+ * @returns {string} string of [Quarter Year] date format
  */
-export declare function dateToQuarterYear(date: string | Date | number, settings?: IDateSettings): string;
+export declare function dateToQuarterYear(date: IDate, settings?: IDateSettings): string;

package/dist/dates/adapters/dateToQuarterYear.js

@@ -5,8 +5,9 @@ import { isValidDateObject } from "../helpers/isValidDateObject";
 import { isValidPotentialDate } from "../helpers/isValidPotentialDate";
 /**
  * Transform a valid Date to [Quarter Year] date format.
- * @param date String of a valid date, date object or millisencond number of the date
- * @returns string of [Quarter Year] date format
+ * @param {IDate} date String of a valid date, date object or millisencond number of the date
+ * @param {IDateSettings} settings the configuration of dates
+ * @returns {string} string of [Quarter Year] date format
  */
 export function dateToQuarterYear(date, settings) {
     if (!isValidPotentialDate(date))

package/dist/dates/adapters/dateToWeekYear.d.ts

@@ -1,7 +1,9 @@
+import { IDate } from "../interfaces/IDate";
 import { IDateSettings } from "../interfaces/IDateSettings";
 /**
  * Transform a Date to [W# Year] date format.
- * @param date String, object or millisencond number of the date
- * @returns string of [W# Year] date format
+ * @param {IDate} date String, object or millisencond number of the date
+ * @param {IDateSettings} settings the configuration of dates
+ * @returns {string} string of [W# Year] date format
  */
-export declare function dateToWeekYear(date: string | Date | number, settings?: IDateSettings): string;
+export declare function dateToWeekYear(date: IDate, settings?: IDateSettings): string;

package/dist/dates/adapters/dateToWeekYear.js

@@ -5,8 +5,9 @@ import { isValidDateObject } from "../helpers/isValidDateObject";
 import { isValidPotentialDate } from "../helpers/isValidPotentialDate";
 /**
  * Transform a Date to [W# Year] date format.
- * @param date String, object or millisencond number of the date
- * @returns string of [W# Year] date format
+ * @param {IDate} date String, object or millisencond number of the date
+ * @param {IDateSettings} settings the configuration of dates
+ * @returns {string} string of [W# Year] date format
  */
 export function dateToWeekYear(date, settings) {
     if (!isValidPotentialDate(date))