@qrvey/utils 1.10.0-3 → 1.10.0-5

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

@@ -3,8 +3,9 @@ import { IModel } from "../../qrvey/interfaces/IModel";
 import { IDTimezone } from "../interfaces/IDTimezone";
 /**
  * Gets the timezone object by the given argument or the model object
+ * - In any case, the offset is prioritized to override other properties.
  * @param {IDTimezone} timezone the timezone object
  * @param {IModel | IDataset} model the info of the dataset (model)
  * @returns a new timezone object
  */
-export declare function getTimezoneObject(timezone: IDTimezone, model: IModel | IDataset): IDTimezone;
+export declare function getTimezoneObject(timezone: IDTimezone, model?: IModel | IDataset): IDTimezone;

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

@@ -4,9 +4,11 @@ exports.getTimezoneObject = void 0;
 const isEmpty_1 = require("../../general/mix/isEmpty");
 const TIMEZONE_TYPE_1 = require("../constants/TIMEZONE_TYPE");
 const getTimezoneOffsetByType_1 = require("./getTimezoneOffsetByType");
+const getUTCFormatByOffset_1 = require("./getUTCFormatByOffset");
 const isValidISOOffset_1 = require("./isValidISOOffset");
 /**
  * Gets the timezone object by the given argument or the model object
+ * - In any case, the offset is prioritized to override other properties.
  * @param {IDTimezone} timezone the timezone object
  * @param {IModel | IDataset} model the info of the dataset (model)
  * @returns a new timezone object
@@ -14,12 +16,24 @@ const isValidISOOffset_1 = require("./isValidISOOffset");
 function getTimezoneObject(timezone, model) {
     const offset = getOffset(timezone, model);
     const type = getType(timezone, model, offset);
+    const resultingOffset = (0, getTimezoneOffsetByType_1.getTimezoneOffsetByType)({ offset, type });
+    const utc = getUTC({ offset: resultingOffset, type });
     return {
-        offset: (0, getTimezoneOffsetByType_1.getTimezoneOffsetByType)({ offset, type }),
+        offset: resultingOffset,
         type,
+        utc,
     };
 }
 exports.getTimezoneObject = getTimezoneObject;
+/**
+ * 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.
+ * @param {IDTimezone} timezone The timezone object
+ * @param {IModel | IDataset} model The model info
+ * @returns {IDTimezoneOffset} the offset of the objects
+ */
 function getOffset(timezone, model) {
     var _a;
     let offset;
@@ -34,12 +48,26 @@ function getOffset(timezone, model) {
     }
     return offset;
 }
+/**
+ * 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.
+ * @param {IDTimezone} timezone The timezone object
+ * @param {IModel | IDataset} model The model info
+ * @param {IDTimezoneOffset} offset a default offset if the validation are not satisfied
+ * @returns {IDTimezoneType} the rigth type of the timezone
+ */
 function getType(timezone, model, offset) {
     var _a;
     let type;
     if (!(0, isEmpty_1.isEmpty)(timezone === null || timezone === void 0 ? void 0 : timezone.type)) {
         type = timezone.type;
     }
+    else if (!(0, isEmpty_1.isEmpty)(timezone === null || timezone === void 0 ? void 0 : timezone.offset)) {
+        type = getTypeByOffset(timezone === null || timezone === void 0 ? void 0 : timezone.offset);
+    }
     else if (!(0, isEmpty_1.isEmpty)((_a = model === null || model === void 0 ? void 0 : model.timezone) === null || _a === void 0 ? void 0 : _a.type)) {
         type = model.timezone.type;
     }
@@ -48,6 +76,15 @@ function getType(timezone, model, offset) {
     }
     return type;
 }
+/**
+ * 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.
+ * @param {IDTimezoneOffset} offset a given offset
+ * @returns {IDTimezoneType} the right timezone type for the offset
+ */
 function getTypeByOffset(offset) {
     if (offset === "+00:00") {
         return TIMEZONE_TYPE_1.TIMEZONE_TYPE.DEFAULT;
@@ -60,3 +97,11 @@ function getTypeByOffset(offset) {
     }
     return TIMEZONE_TYPE_1.TIMEZONE_TYPE.DEFAULT;
 }
+/**
+ * Gets the UTC string by the timezone object
+ * @param {IDTimezone} timezone the timezone object
+ * @returns {string} the label of the UTC value
+ */
+function getUTC(timezone) {
+    return (0, getUTCFormatByOffset_1.getUTCFormatByOffset)(timezone);
+}

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

@@ -2,15 +2,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getUTCFormatByOffset = void 0;
 const numericOffsetToISO_1 = require("../adapters/numericOffsetToISO");
-const getTimezoneObject_1 = require("./getTimezoneObject");
 /**
  * Gets the UTC format dependeing on the given offset
  * @param {IDTimezone} timezone the timezone object
  * @returns {string} an string with the UTC format
  */
 function getUTCFormatByOffset(timezone) {
-    const newTimezone = (0, getTimezoneObject_1.getTimezoneObject)(timezone, undefined);
-    let newOffset = (0, numericOffsetToISO_1.numericOffsetToISO)(newTimezone === null || newTimezone === void 0 ? void 0 : newTimezone.offset, false);
+    let newOffset = (0, numericOffsetToISO_1.numericOffsetToISO)(timezone === null || timezone === void 0 ? void 0 : timezone.offset, false);
     if (newOffset.search(":0") > -1) {
         newOffset = newOffset.slice(0, newOffset.indexOf(":"));
     }

package/dist/cjs/dates/interfaces/IDTimezone.d.ts

@@ -3,4 +3,5 @@ import { IDTimezoneType } from "./IDTimezoneType";
 export interface IDTimezone {
     offset: IDTimezoneOffset;
     type?: IDTimezoneType;
+    utc?: string;
 }

package/dist/cjs/globalization/labels/filters/I18N_RELATIVE_CONTAINER.js

@@ -13,5 +13,5 @@ exports.I18N_RELATIVE_CONTAINER = {
     starting_date_tooltip: "The relative date will include the specific starting date and a period of time to show from that date onwards (Inclusive range). <br/> Unchecking this option will exclude the chosen starting date (exclusive range) from the date range.",
     starting_from: "Starting From",
     set_current_date: "Set to current date",
-    utc_tooltip: "The times displayed are in UTC-0",
+    utc_tooltip: "The times displayed are in {{utc}}",
 };

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

@@ -3,8 +3,9 @@ import { IModel } from "../../qrvey/interfaces/IModel";
 import { IDTimezone } from "../interfaces/IDTimezone";
 /**
  * Gets the timezone object by the given argument or the model object
+ * - In any case, the offset is prioritized to override other properties.
  * @param {IDTimezone} timezone the timezone object
  * @param {IModel | IDataset} model the info of the dataset (model)
  * @returns a new timezone object
  */
-export declare function getTimezoneObject(timezone: IDTimezone, model: IModel | IDataset): IDTimezone;
+export declare function getTimezoneObject(timezone: IDTimezone, model?: IModel | IDataset): IDTimezone;

package/dist/dates/helpers/getTimezoneObject.js

@@ -1,9 +1,11 @@
 import { isEmpty } from "../../general/mix/isEmpty";
 import { TIMEZONE_TYPE } from "../constants/TIMEZONE_TYPE";
 import { getTimezoneOffsetByType } from "./getTimezoneOffsetByType";
+import { getUTCFormatByOffset } from "./getUTCFormatByOffset";
 import { isValidISOOffset } from "./isValidISOOffset";
 /**
  * Gets the timezone object by the given argument or the model object
+ * - In any case, the offset is prioritized to override other properties.
  * @param {IDTimezone} timezone the timezone object
  * @param {IModel | IDataset} model the info of the dataset (model)
  * @returns a new timezone object
@@ -11,11 +13,23 @@ import { isValidISOOffset } from "./isValidISOOffset";
 export function getTimezoneObject(timezone, model) {
     const offset = getOffset(timezone, model);
     const type = getType(timezone, model, offset);
+    const resultingOffset = getTimezoneOffsetByType({ offset, type });
+    const utc = getUTC({ offset: resultingOffset, type });
     return {
-        offset: getTimezoneOffsetByType({ offset, type }),
+        offset: resultingOffset,
         type,
+        utc,
     };
 }
+/**
+ * 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.
+ * @param {IDTimezone} timezone The timezone object
+ * @param {IModel | IDataset} model The model info
+ * @returns {IDTimezoneOffset} the offset of the objects
+ */
 function getOffset(timezone, model) {
     var _a;
     let offset;
@@ -30,12 +44,26 @@ function getOffset(timezone, model) {
     }
     return offset;
 }
+/**
+ * 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.
+ * @param {IDTimezone} timezone The timezone object
+ * @param {IModel | IDataset} model The model info
+ * @param {IDTimezoneOffset} offset a default offset if the validation are not satisfied
+ * @returns {IDTimezoneType} the rigth type of the timezone
+ */
 function getType(timezone, model, offset) {
     var _a;
     let type;
     if (!isEmpty(timezone === null || timezone === void 0 ? void 0 : timezone.type)) {
         type = timezone.type;
     }
+    else if (!isEmpty(timezone === null || timezone === void 0 ? void 0 : timezone.offset)) {
+        type = getTypeByOffset(timezone === null || timezone === void 0 ? void 0 : timezone.offset);
+    }
     else if (!isEmpty((_a = model === null || model === void 0 ? void 0 : model.timezone) === null || _a === void 0 ? void 0 : _a.type)) {
         type = model.timezone.type;
     }
@@ -44,6 +72,15 @@ function getType(timezone, model, offset) {
     }
     return type;
 }
+/**
+ * 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.
+ * @param {IDTimezoneOffset} offset a given offset
+ * @returns {IDTimezoneType} the right timezone type for the offset
+ */
 function getTypeByOffset(offset) {
     if (offset === "+00:00") {
         return TIMEZONE_TYPE.DEFAULT;
@@ -56,3 +93,11 @@ function getTypeByOffset(offset) {
     }
     return TIMEZONE_TYPE.DEFAULT;
 }
+/**
+ * Gets the UTC string by the timezone object
+ * @param {IDTimezone} timezone the timezone object
+ * @returns {string} the label of the UTC value
+ */
+function getUTC(timezone) {
+    return getUTCFormatByOffset(timezone);
+}

package/dist/dates/helpers/getUTCFormatByOffset.js

@@ -1,13 +1,11 @@
 import { numericOffsetToISO } from "../adapters/numericOffsetToISO";
-import { getTimezoneObject } from "./getTimezoneObject";
 /**
  * Gets the UTC format dependeing on the given offset
  * @param {IDTimezone} timezone the timezone object
  * @returns {string} an string with the UTC format
  */
 export function getUTCFormatByOffset(timezone) {
-    const newTimezone = getTimezoneObject(timezone, undefined);
-    let newOffset = numericOffsetToISO(newTimezone === null || newTimezone === void 0 ? void 0 : newTimezone.offset, false);
+    let newOffset = numericOffsetToISO(timezone === null || timezone === void 0 ? void 0 : timezone.offset, false);
     if (newOffset.search(":0") > -1) {
         newOffset = newOffset.slice(0, newOffset.indexOf(":"));
     }

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

@@ -3,4 +3,5 @@ import { IDTimezoneType } from "./IDTimezoneType";
 export interface IDTimezone {
     offset: IDTimezoneOffset;
     type?: IDTimezoneType;
+    utc?: string;
 }

package/dist/globalization/labels/filters/I18N_RELATIVE_CONTAINER.js

@@ -10,5 +10,5 @@ export const I18N_RELATIVE_CONTAINER = {
     starting_date_tooltip: "The relative date will include the specific starting date and a period of time to show from that date onwards (Inclusive range). <br/> Unchecking this option will exclude the chosen starting date (exclusive range) from the date range.",
     starting_from: "Starting From",
     set_current_date: "Set to current date",
-    utc_tooltip: "The times displayed are in UTC-0",
+    utc_tooltip: "The times displayed are in {{utc}}",
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qrvey/utils",
-  "version": "1.10.0-3",
+  "version": "1.10.0-5",
   "description": "Helper, Utils for all Qrvey Projects",
   "homepage": "https://bitbucket.org/qrvey/qrvey_utils/wiki/Home",
   "main": "dist/index.js",