@qrvey/utils 1.10.0-0 → 1.10.0-timezone-0

package/dist/dates/adapters/numericOffsetToISO.js

@@ -0,0 +1,23 @@
+import { isNaNV2 } from "../../general/mix/isNaNV2";
+import { getSign } from "../../general/numeric/getSign";
+import { padLeadingZeros } from "../../general/string/padLeadingZeros";
+import { isValidISOOffset } from "../helpers/isValidISOOffset";
+/**
+ * Gets the ISO offset From the numeric offset (minutes)
+ * @param {number} offset the timezone offset
+ * @returns {string} the offset in minutes
+ */
+export function numericOffsetToISO(offset) {
+    let newOffset = offset;
+    if (typeof offset === "string" && isValidISOOffset(offset))
+        return String(newOffset);
+    if (typeof offset !== "number" && isNaNV2(offset))
+        return "+00:00";
+    if (typeof offset === "string" && !isNaNV2(offset))
+        newOffset = +offset;
+    const sign = getSign(newOffset);
+    newOffset = Math.abs(newOffset);
+    const hours = padLeadingZeros(Math.floor(newOffset / 60), 2);
+    const minutes = padLeadingZeros(newOffset % 60, 2);
+    return `${sign}${hours}:${minutes}`;
+}

package/dist/dates/constants/ISO_8601_REGEX.d.ts

@@ -0,0 +1 @@
+export declare const ISO_8601_REGEX: RegExp;

package/dist/dates/constants/ISO_8601_REGEX.js

@@ -0,0 +1 @@
+export const ISO_8601_REGEX = /^[+-]?\d{2}:\d{2}$/;

package/dist/dates/constants/index.d.ts

@@ -38,6 +38,7 @@ export * from "./DATE_YEAR_MONTHS_MMMM";
 export * from "./DATE_YEAR_QUARTERS";
 export * from "./DATE_YEAR_QUARTERS_RANGE";
 export * from "./DATETIME_COLUMN_FORMAT";
+export * from "./ISO_8601_REGEX";
 export * from "./TIME_GROUPING_PROPERTY_INFO_LIST";
 export * from "./TIME_GROUPING_PROPERTY_INFO";
 export * from "./TIME_GROUPING_PROPERTY_LABEL";

package/dist/dates/constants/index.js

@@ -38,6 +38,7 @@ export * from "./DATE_YEAR_MONTHS_MMMM";
 export * from "./DATE_YEAR_QUARTERS";
 export * from "./DATE_YEAR_QUARTERS_RANGE";
 export * from "./DATETIME_COLUMN_FORMAT";
+export * from "./ISO_8601_REGEX";
 export * from "./TIME_GROUPING_PROPERTY_INFO_LIST";
 export * from "./TIME_GROUPING_PROPERTY_INFO";
 export * from "./TIME_GROUPING_PROPERTY_LABEL";

package/dist/dates/helpers/getDateByTimezoneOffset.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Gets a Date with the given offset of the Timezone.
+ * No given an offset the default is going to be set by the browser
+ * @param date String, object or millisencond number of the date
+ * @returns updated Date object
+ */
+export declare function getDateByTimezoneOffset(date: string | Date | number, offset?: number | string): Date;

package/dist/dates/helpers/getDateByTimezoneOffset.js

@@ -0,0 +1,21 @@
+import { isEmpty } from "../../general/mix/isEmpty";
+import { ISOToNumericOffset } from "../adapters/ISOToNumericOffset";
+import { DATE_FORMAT } from "../constants/DATE_FORMAT";
+import { isValidPotentialDate } from "./isValidPotentialDate";
+import { validateDate } from "./validateDate";
+/**
+ * Gets a Date with the given offset of the Timezone.
+ * No given an offset the default is going to be set by the browser
+ * @param date String, object or millisencond number of the date
+ * @returns updated Date object
+ */
+export function getDateByTimezoneOffset(date, offset) {
+    if (!isValidPotentialDate(date) ||
+        (typeof date === "string" && !validateDate(date, DATE_FORMAT.DAY)))
+        return date;
+    const dt = new Date(date.valueOf());
+    const newOffset = isEmpty(offset) || offset === "browser"
+        ? dt.getTimezoneOffset()
+        : ISOToNumericOffset(offset);
+    return new Date(+dt + newOffset * 1000 * 60);
+}

package/dist/dates/helpers/index.d.ts

@@ -1,4 +1,3 @@
-export * from "./adjustTimezone";
 export * from "./areIncludedDateTokens";
 export * from "./getDateByDateFormat";
 export * from "./getDateFormatByProperty";
@@ -10,4 +9,5 @@ export * from "./getSeparatorByDateFormat";
 export * from "./getWeek";
 export * from "./isValidDateObject";
 export * from "./isValidPotentialDate";
+export * from "./getDateByTimezoneOffset";
 export * from "./validateDate";

package/dist/dates/helpers/index.js

@@ -1,4 +1,3 @@
-export * from "./adjustTimezone";
 export * from "./areIncludedDateTokens";
 export * from "./getDateByDateFormat";
 export * from "./getDateFormatByProperty";
@@ -10,4 +9,5 @@ export * from "./getSeparatorByDateFormat";
 export * from "./getWeek";
 export * from "./isValidDateObject";
 export * from "./isValidPotentialDate";
+export * from "./getDateByTimezoneOffset";
 export * from "./validateDate";

package/dist/dates/helpers/isValidISOOffset.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Validate if offset uses a valid ISO 8601 offset specification
+ * - If the given offset is a numeric, returns an invalid flag.
+ * @param {string} offset the timezone offset
+ * @returns {boolean} true if the given offset is valid
+ */
+export declare function isValidISOOffset(offset: number | string): boolean;

package/dist/dates/helpers/isValidISOOffset.js

@@ -0,0 +1,13 @@
+import { ISO_8601_REGEX } from "../constants/ISO_8601_REGEX";
+/**
+ * Validate if offset uses a valid ISO 8601 offset specification
+ * - If the given offset is a numeric, returns an invalid flag.
+ * @param {string} offset the timezone offset
+ * @returns {boolean} true if the given offset is valid
+ */
+export function isValidISOOffset(offset) {
+    if (typeof offset !== "string")
+        return false;
+    const newOffset = (offset || "").trim();
+    return ISO_8601_REGEX.test(newOffset);
+}

package/dist/dates/interfaces/IDTimezoneOffset.d.ts

@@ -0,0 +1 @@
+export type IDTimezoneOffset = number | string;

package/dist/dates/interfaces/IDTimezoneOffset.js

@@ -0,0 +1 @@
+export {};

package/dist/dates/interfaces/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./IDateFormat";
 export * from "./IDateGroupingProperty";
 export * from "./IDFDateToHmsSettings";
+export * from "./IDTimezoneOffset";

package/dist/dates/interfaces/index.js

@@ -1,3 +1,4 @@
 export * from "./IDateFormat";
 export * from "./IDateGroupingProperty";
 export * from "./IDFDateToHmsSettings";
+export * from "./IDTimezoneOffset";

package/dist/filters/helpers/builder/getFilterBuilderGeneralConfig.js

@@ -11,7 +11,7 @@ export function getFilterBuilderGeneralConfig(config = {}) {
         domain: config.domain,
         i18n: config.i18n,
         qv_token: config.qv_token,
-        timezoneControl: getAttribute(config, "timezone_control") || config.timezoneControl,
+        timezoneOffset: getAttribute(config, "timezone_offset") || config.timezoneOffset,
         userid: getAttribute(config, "user_id") || config.userid,
     };
 }

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

@@ -28,3 +28,4 @@ export * from "./mergeValues";
 export * from "./resolveDatasetConditions";
 export * from "./resolveFilterConditions";
 export * from "./resolveScopeConditions";
+export * from "./setTimezoneToFilters";

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

@@ -28,3 +28,4 @@ export * from "./mergeValues";
 export * from "./resolveDatasetConditions";
 export * from "./resolveFilterConditions";
 export * from "./resolveScopeConditions";
+export * from "./setTimezoneToFilters";

package/dist/filters/helpers/common/setTimezoneToFilters.d.ts

@@ -0,0 +1,4 @@
+import { IDTimezoneOffset } from "../../../dates/interfaces/IDTimezoneOffset";
+import { IFSData } from "../../interfaces/common/IFSData";
+import { IFUData } from "../../interfaces/ui/IFUData";
+export declare function setTimezoneToFilters(filterData: IFSData, timezoneOffset: IDTimezoneOffset): IFUData | IFSData;

package/dist/filters/helpers/common/setTimezoneToFilters.js

@@ -0,0 +1,13 @@
+import { isEmpty } from "../../../general/mix/isEmpty";
+import { transformFilterValues } from "../ui/transformFilterValues";
+export function setTimezoneToFilters(filterData, timezoneOffset) {
+    if (isEmpty(filterData) ||
+        isEmpty(filterData.scopes) ||
+        !Array.isArray(filterData.scopes))
+        return filterData;
+    return Object.assign(Object.assign({}, filterData), { scopes: filterData.scopes.map((scope) => (Object.assign(Object.assign({}, scope), { datasets: scope.datasets.map((dataset) => (Object.assign(Object.assign({}, dataset), { filters: dataset.filters.map((filter) => (Object.assign(Object.assign({}, filter), { values: transformFilterValues(filter, {
+                        timezoneOffset,
+                        translate: undefined,
+                        i18n: undefined,
+                    }) }))) }))) }))) });
+}

package/dist/filters/interfaces/ui/IFUTransformFilterValuesSettings.d.ts

@@ -1,6 +1,8 @@
+import { IDTimezoneOffset } from "../../../dates/interfaces/IDTimezoneOffset";
 import { II18nConfig } from "../../../globalization/interfaces/II18nConfig";
 import { II18nServiceTranslate } from "../../../globalization/interfaces/II18nServiceTranslate";
 export interface IFUTransformFilterValuesSettings {
+    timezoneOffset: IDTimezoneOffset;
     translate: II18nServiceTranslate;
     i18n: II18nConfig;
     suffixTranslateLabel?: string;

package/dist/filters/services/Filters.api.js

@@ -97,7 +97,7 @@ export class FiltersApi {
             else {
                 api = this.chartPaginationApi;
             }
-            return api.getChartResult(this.config, FiltersApi.getFilter(config), FiltersApi.getLogic(config), FiltersApi.getChartRequest(config), resetApi);
+            return api.getChartResult(Object.assign(Object.assign({}, this.config), { timezoneOffset: 0 }), FiltersApi.getFilter(config), FiltersApi.getLogic(config), FiltersApi.getChartRequest(config), resetApi);
         });
     }
     static getLogic(config) {

package/dist/general/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./array/index";
 export * from "./function/index";
 export * from "./mix/index";
+export * from "./numeric/index";
 export * from "./object/index";
 export * from "./string/index";

package/dist/general/index.js

@@ -1,5 +1,6 @@
 export * from "./array/index";
 export * from "./function/index";
 export * from "./mix/index";
+export * from "./numeric/index";
 export * from "./object/index";
 export * from "./string/index";

package/dist/general/numeric/getSign.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Gets the numeric sign of a given number
+ * @param {number} num the number
+ * @returns {string} an string with the sign
+ */
+export declare function getSign(num: number): string;

package/dist/general/numeric/getSign.js

@@ -0,0 +1,8 @@
+/**
+ * Gets the numeric sign of a given number
+ * @param {number} num the number
+ * @returns {string} an string with the sign
+ */
+export function getSign(num) {
+    return Math.sign(num) > -1 ? "+" : "-";
+}

package/dist/general/numeric/index.d.ts

@@ -0,0 +1 @@
+export * from "./getSign";

package/dist/general/numeric/index.js

@@ -0,0 +1 @@
+export * from "./getSign";

package/dist/interfaces/general/IWidgetConfig.d.ts

@@ -1,3 +1,4 @@
+import { IDTimezoneOffset } from "../../dates/interfaces/IDTimezoneOffset";
 import { II18nConfig } from "../../globalization/interfaces/II18nConfig";
 export interface IWidgetConfig {
     appid?: string;
@@ -5,6 +6,6 @@ export interface IWidgetConfig {
     domain: string;
     i18n?: II18nConfig;
     qv_token?: string;
-    timezoneControl?: string;
+    timezoneOffset?: IDTimezoneOffset;
     userid?: string;
 }

package/dist/qrvey/helpers/transformValue.js

@@ -3,6 +3,10 @@ import { isDateColumn } from "../../columns/helpers/isDateColumn";
 import { isNumericalColumn } from "../../columns/helpers/isNumericalColumn";
 import { DATE_GROUPING_PROPERTY } from "../../dates/constants/DATE_GROUPING_PROPERTY";
 import { DATE_GROUPING_TIME_PROPERTY } from "../../dates/constants/DATE_GROUPING_TIME_PROPERTY";
+import { getDateByDateFormat } from "../../dates/helpers/getDateByDateFormat";
+import { getDateFormatByProperty } from "../../dates/helpers/getDateFormatByProperty";
+import { getFormattedDateByFormat } from "../../dates/helpers/getFormattedDateByFormat";
+import { getDateByTimezoneOffset } from "../../dates/helpers/getDateByTimezoneOffset";
 import { addFormat } from "../../format/format";
 import { isEmpty } from "../../general/mix/isEmpty";
 import { getI18nDateGroupLabel } from "../../globalization/helpers/getI18nDateGroupLabel";
@@ -16,13 +20,32 @@ import { getValueWithSuffixes } from "./getValueWithSuffixes";
 export function transformValue(value, settings) {
     if (isEmpty(value))
         return value;
-    const valueWithI18n = getI18nDateGroupLabel(value, settings.property, settings.translate);
+    const timezonedValue = getTimezoneValue(value, settings);
+    const valueWithI18n = getI18nDateGroupLabel(timezonedValue, settings.property, settings.translate);
     const valueWithLocalization = addFormat(valueWithI18n, getOutputFormat(settings), getFormatConfig(settings));
     return getValueWithSuffixes(valueWithLocalization, {
         suffixTranslateLabel: settings.suffixTranslateLabel,
         translate: settings.translate,
     });
 }
+/**
+ * Gets a date value in the given timezone
+ * @param {string} value the date
+ * @param {ITransformValueSettings} settings The settings of the transformValue function
+ * @returns {string} A transformed value
+ */
+function getTimezoneValue(value, settings) {
+    const isDateTime = [
+        DATE_GROUPING_TIME_PROPERTY.HOUR,
+        DATE_GROUPING_TIME_PROPERTY.MINUTE,
+        DATE_GROUPING_TIME_PROPERTY.SECOND,
+    ].includes(settings.property);
+    if (isDateTime) {
+        const dateFormat = getDateFormatByProperty(settings.property);
+        return getFormattedDateByFormat(getDateByTimezoneOffset(getDateByDateFormat(value, dateFormat), settings === null || settings === void 0 ? void 0 : settings.timezoneOffset), dateFormat);
+    }
+    return value;
+}
 /**
  * Gets the outputformat settings
  * @param settings The settings of the transformValue function

package/dist/qrvey/interfaces/IBDataset.d.ts

@@ -1,4 +1,5 @@
 import { IBColumn } from "../../columns/interfaces/IBColumn";
+import { IBTimezone } from "./IBTimezone";
 /**
  * Structure for Dataset in the frontend side of Qrvey App
  */
@@ -7,4 +8,5 @@ export interface IBDataset {
     name?: string;
     options?: IBColumn[];
     qrveyid: string;
+    timezone?: IBTimezone;
 }

package/dist/qrvey/interfaces/IBTimezone.d.ts

@@ -0,0 +1,4 @@
+export interface IBTimezone {
+    numericOffset: number;
+    offset: string;
+}

package/dist/qrvey/interfaces/IBTimezone.js

@@ -0,0 +1 @@
+export {};

package/dist/qrvey/interfaces/IDataset.d.ts

@@ -1,9 +1,11 @@
 import { IColumn } from "../../columns/interfaces/IColumn";
+import { IDTimezoneOffset } from "../../dates/interfaces/IDTimezoneOffset";
 import { IBDataset } from "./IBDataset";
 /**
  * Structure for Dataset in the frontend side of Qrvey App
  */
-export interface IDataset extends Omit<IBDataset, "name" | "options"> {
+export interface IDataset extends Omit<IBDataset, "name" | "options" | "timezone"> {
     label?: string;
     options?: IColumn[];
+    timezone?: IDTimezoneOffset;
 }

package/dist/qrvey/interfaces/ITransformValueSettings.d.ts

@@ -1,10 +1,12 @@
 import { IColumn } from "../../columns/interfaces/IColumn";
 import { IColumnPropertyType } from "../../columns/interfaces/IColumnPropertyType";
+import { IDTimezoneOffset } from "../../dates/interfaces/IDTimezoneOffset";
 import { II18nConfig } from "../../globalization/interfaces/II18nConfig";
 import { II18nServiceTranslate } from "../../globalization/interfaces/II18nServiceTranslate";
 export interface ITransformValueSettings {
     column: IColumn;
     property: IColumnPropertyType;
+    timezoneOffset: IDTimezoneOffset;
     translate: II18nServiceTranslate;
     i18n: II18nConfig;
     suffixTranslateLabel?: string;

package/dist/qrvey/interfaces/index.d.ts

@@ -4,6 +4,7 @@ export * from "./IBDataset";
 export * from "./IBModel";
 export * from "./IBModelBranchesMapBranch";
 export * from "./IBModelData";
+export * from "./IBTimezone";
 export * from "./ICalculation";
 export * from "./ICalculationInfo";
 export * from "./ICalculationType";

package/dist/qrvey/interfaces/index.js

@@ -4,6 +4,7 @@ export * from "./IBDataset";
 export * from "./IBModel";
 export * from "./IBModelBranchesMapBranch";
 export * from "./IBModelData";
+export * from "./IBTimezone";
 export * from "./ICalculation";
 export * from "./ICalculationInfo";
 export * from "./ICalculationType";

package/dist/services/adapters/BDatasetsToUIDatasets.adapter.js

@@ -1,9 +1,13 @@
 import { getAttribute } from "../../general/object/getAttribute";
 import { BColumnsToUIColumns } from "./BColumnsToUIColumns.adapter";
 export function BDatasetsToUIDatasets(datasets = []) {
-    return datasets.map((dataset) => ({
-        qrveyid: getAttribute(dataset, "qrvey_id"),
-        label: dataset.name,
-        options: BColumnsToUIColumns(dataset.options, dataset),
-    }));
+    return datasets.map((dataset) => {
+        var _a, _b;
+        return ({
+            qrveyid: getAttribute(dataset, "qrvey_id"),
+            label: dataset.name,
+            options: BColumnsToUIColumns(dataset.options, dataset),
+            timezone: ((_a = dataset.timezone) === null || _a === void 0 ? void 0 : _a.offset) || ((_b = dataset.timezone) === null || _b === void 0 ? void 0 : _b.numericOffset),
+        });
+    });
 }

package/dist/services/helpers/Request.d.ts

@@ -2,7 +2,7 @@ export default class Request {
     static checkStatus(response: any): Promise<any>;
     static hasQvToken(config: any): boolean;
     static getQvToken(config: any): any;
-    static getTimezoneControl(config: any): any;
+    static getTimezoneOffset(config: any): string;
     static hasApiKey(config: any): boolean;
     static getApiKey(config: any): any;
     static makeUrl(config: any, url: any, params?: any): string;

package/dist/services/helpers/Request.js

@@ -7,6 +7,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+import { numericOffsetToISO } from "../../dates/adapters/numericOffsetToISO";
 import { getAttribute } from "../../general/object/getAttribute";
 import { serialize } from "../../general/object/serialize";
 import { parseUrl } from "../../general/string/parseUrl";
@@ -24,8 +25,8 @@ export default class Request {
     static getQvToken(config) {
         return getAttribute(config, "qv_token");
     }
-    static getTimezoneControl(config) {
-        return getAttribute(config, "timezone_control");
+    static getTimezoneOffset(config) {
+        return numericOffsetToISO(getAttribute(config, "timezone_offset"));
     }
     static hasApiKey(config) {
         return !!this.getApiKey(config);
@@ -68,9 +69,9 @@ export default class Request {
                 cfg.credentials = "include";
             }
         }
-        const timezoneControl = this.getTimezoneControl(reqData.config);
-        if (timezoneControl) {
-            cfg.headers["q-timezone-control"] = `offset=${timezoneControl};use-client-offset-only`;
+        const timezoneOffset = this.getTimezoneOffset(reqData.config);
+        if (timezoneOffset) {
+            cfg.headers["q-timezone-control"] = `offset=${timezoneOffset}`;
         }
         // AbortSignal (https://developers.google.com/web/updates/2017/09/abortable-fetch)
         if (reqData.config && reqData.config.signal) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qrvey/utils",
-  "version": "1.10.0-0",
+  "version": "1.10.0-timezone-0",
   "description": "Helper, Utils for all Qrvey Projects",
   "homepage": "https://bitbucket.org/qrvey/qrvey_utils/wiki/Home",
   "main": "dist/index.js",
@@ -24,10 +24,10 @@
   "devDependencies": {
     "@types/jest": "29.4.0",
     "@types/responselike": "1.0.0",
-    "@typescript-eslint/eslint-plugin": "5.49.0",
-    "@typescript-eslint/parser": "5.49.0",
+    "@typescript-eslint/eslint-plugin": "5.50.0",
+    "@typescript-eslint/parser": "5.50.0",
     "auto-changelog": "2.4.0",
-    "eslint": "8.32.0",
+    "eslint": "8.33.0",
     "eslint-config-prettier": "8.6.0",
     "eslint-plugin-prettier": "4.2.1",
     "husky": "8.0.3",
@@ -36,7 +36,7 @@
     "np": "7.6.3",
     "prettier": "2.8.3",
     "ts-jest": "29.0.5",
-    "typescript": "4.9.4"
+    "typescript": "4.9.5"
   },
   "dependencies": {
     "d3-format": "2.0.0",

package/dist/cjs/dates/helpers/adjustTimezone.d.ts

@@ -1,6 +0,0 @@
-/**
- * Adjusts a Date with the UTC-0 Timezone.
- * @param date String, object or millisencond number of the date
- * @returns updated Date object
- */
-export declare function adjustTimezone(date: string | Date | number): Date;

package/dist/cjs/dates/helpers/adjustTimezone.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.adjustTimezone = void 0;
-const constants_1 = require("../constants");
-const isValidPotentialDate_1 = require("./isValidPotentialDate");
-const validateDate_1 = require("./validateDate");
-/**
- * Adjusts a Date with the UTC-0 Timezone.
- * @param date String, object or millisencond number of the date
- * @returns updated Date object
- */
-function adjustTimezone(date) {
-    if (!(0, isValidPotentialDate_1.isValidPotentialDate)(date) ||
-        (typeof date === "string" && !(0, validateDate_1.validateDate)(date, constants_1.DATE_FORMAT.DAY)))
-        return date;
-    const dt = new Date(date.valueOf());
-    return new Date(+dt + dt.getTimezoneOffset() * 1000 * 60);
-}
-exports.adjustTimezone = adjustTimezone;

package/dist/dates/helpers/adjustTimezone.d.ts

@@ -1,6 +0,0 @@
-/**
- * Adjusts a Date with the UTC-0 Timezone.
- * @param date String, object or millisencond number of the date
- * @returns updated Date object
- */
-export declare function adjustTimezone(date: string | Date | number): Date;

package/dist/dates/helpers/adjustTimezone.js

@@ -1,15 +0,0 @@
-import { DATE_FORMAT } from "../constants";
-import { isValidPotentialDate } from "./isValidPotentialDate";
-import { validateDate } from "./validateDate";
-/**
- * Adjusts a Date with the UTC-0 Timezone.
- * @param date String, object or millisencond number of the date
- * @returns updated Date object
- */
-export function adjustTimezone(date) {
-    if (!isValidPotentialDate(date) ||
-        (typeof date === "string" && !validateDate(date, DATE_FORMAT.DAY)))
-        return date;
-    const dt = new Date(date.valueOf());
-    return new Date(+dt + dt.getTimezoneOffset() * 1000 * 60);
-}