@qrvey/utils 1.16.1-9 → 1.17.0-0

package/README.md

@@ -2,6 +2,53 @@
 
 > Helper, Utils for all Qrvey Projects
 
+## Release pipelines
+
+- Guide to run manual releases in Bitbucket: [RELEASE_PIPELINES.md](./RELEASE_PIPELINES.md)
+
+## Recommended consumption guide
+
+This package exposes **ESM + CommonJS**:
+
+- `import` (ESM) for modern bundlers and better tree shaking.
+- `require` (CommonJS) for legacy implementations.
+
+### 1) Recommended (ESM with tree shaking)
+
+Use named imports from the entrypoint or specific subpaths.
+
+```ts
+// Good: allows bundlers to remove unused exports
+import { isEmpty, objectCopy } from "@qrvey/utils";
+
+// Better for critical bundles: import only the module you need
+import { formatDate } from "@qrvey/utils/format/format";
+```
+
+### 2) Avoid for optimized bundles
+
+```ts
+// Avoid in frontend apps: can pull more code into the bundle
+import * as QrveyUtils from "@qrvey/utils";
+```
+
+### 3) CommonJS compatibility
+
+For Node projects or integrations that require CommonJS:
+
+```js
+const { isEmpty } = require("@qrvey/utils");
+const { formatDate } = require("@qrvey/utils/format/format");
+```
+
+### 4) Recommendations for consumer apps
+
+- Prefer `import` over `require` in frontend code.
+- Use subpaths (`@qrvey/utils/<module>`) on performance-critical paths.
+- Keep tree shaking enabled in your bundler (Webpack/Rollup/Vite in production mode).
+
+---
+
 
 ### dist/format/format.js
 

package/dist/cache-managers/cache-chart-manager.js

@@ -1,12 +1,3 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 import { QrveyCacheManager } from "./cache-manager";
 import ChartsApi from "../services/api/Charts.api";
 export class ChartCacheManager extends QrveyCacheManager {
@@ -22,19 +13,17 @@ export class ChartCacheManager extends QrveyCacheManager {
     buildStoreId({ chart_id }) {
         return `${chart_id}`;
     }
-    fetchDataAndUpdateStore(state, config) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const chartConfig = Object.assign(Object.assign({}, config), { translated: true });
-            const api = new ChartsApi(chartConfig);
-            return api
-                .getChart(chartConfig)
-                .then((chart) => {
-                state.entity = chart;
-                state.error = null;
-            })
-                .catch((e) => {
-                state.error = e;
-            });
+    async fetchDataAndUpdateStore(state, config) {
+        const chartConfig = { ...config, translated: true };
+        const api = new ChartsApi(chartConfig);
+        return api
+            .getChart(chartConfig)
+            .then((chart) => {
+            state.entity = chart;
+            state.error = null;
+        })
+            .catch((e) => {
+            state.error = e;
         });
     }
 }

package/dist/cache-managers/cache-manager.js

@@ -1,114 +1,91 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 import { createStore } from "@stencil/store";
 export class QrveyCacheManager {
-    constructor() {
-        this.stores = new Map();
-        this.operationLocks = new Map();
+    stores = new Map();
+    operationLocks = new Map();
+    async createStore(_initialState) {
+        const initialState = {
+            entity: null,
+            error: null,
+            ..._initialState,
+        };
+        return createStore(initialState);
     }
-    createStore(_initialState) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const initialState = Object.assign({ entity: null, error: null }, _initialState);
-            return createStore(initialState);
-        });
-    }
-    getStoreFromPromise(config, id) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return new Promise((resolve, reject) => {
-                (() => __awaiter(this, void 0, void 0, function* () {
-                    try {
-                        const configEntityId = this.getConfigEntityId();
-                        const extendedConfig = Object.assign(Object.assign({}, config), { [configEntityId]: id });
-                        const store = yield this.getStore(extendedConfig);
-                        resolve(store);
-                    }
-                    catch (error) {
-                        reject(error);
-                    }
-                }))();
-            });
+    async getStoreFromPromise(config, id) {
+        return new Promise((resolve, reject) => {
+            (async () => {
+                try {
+                    const configEntityId = this.getConfigEntityId();
+                    const extendedConfig = { ...config, [configEntityId]: id };
+                    const store = await this.getStore(extendedConfig);
+                    resolve(store);
+                }
+                catch (error) {
+                    reject(error);
+                }
+            })();
         });
     }
-    getCreatedStore(storeId) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.stores.get(storeId);
-        });
+    async getCreatedStore(storeId) {
+        return this.stores.get(storeId);
     }
-    initializeStore(config, storeId) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const newStore = yield this.createStore();
-            yield this.fetchDataAndUpdateStore(newStore.state, config);
-            this.stores.set(storeId, newStore);
-            return newStore;
-        });
+    async initializeStore(config, storeId) {
+        const newStore = await this.createStore();
+        await this.fetchDataAndUpdateStore(newStore.state, config);
+        this.stores.set(storeId, newStore);
+        return newStore;
     }
-    getStore(config) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const storeId = this.buildStoreId(config);
-            while (this.operationLocks.has(storeId)) {
-                yield this.operationLocks.get(storeId);
+    async getStore(config) {
+        const storeId = this.buildStoreId(config);
+        while (this.operationLocks.has(storeId)) {
+            await this.operationLocks.get(storeId);
+        }
+        let store = this.stores.get(storeId);
+        if (!store) {
+            let resolveLock;
+            const lockPromise = new Promise((resolve) => (resolveLock = resolve));
+            this.operationLocks.set(storeId, lockPromise);
+            try {
+                store = await this.initializeStore(config, storeId);
+                this.stores.set(storeId, store);
             }
-            let store = this.stores.get(storeId);
-            if (!store) {
-                let resolveLock;
-                const lockPromise = new Promise((resolve) => (resolveLock = resolve));
-                this.operationLocks.set(storeId, lockPromise);
-                try {
-                    store = yield this.initializeStore(config, storeId);
-                    this.stores.set(storeId, store);
-                }
-                finally {
-                    resolveLock();
-                    this.operationLocks.delete(storeId);
-                }
+            finally {
+                resolveLock();
+                this.operationLocks.delete(storeId);
             }
-            return store;
-        });
+        }
+        return store;
     }
     getMultipleStores(config, ids) {
-        const promises = ids.map((id) => __awaiter(this, void 0, void 0, function* () { return yield this.getStoreFromPromise(config, id); }));
+        const promises = ids.map(async (id) => await this.getStoreFromPromise(config, id));
         return Promise.all(promises);
     }
-    setStoresFromData(stores) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return Promise.all(stores.map((store) => __awaiter(this, void 0, void 0, function* () {
-                let createdStore = yield this.getCreatedStore(store.storeId);
-                if (!createdStore) {
-                    createdStore = yield this.createStore();
-                    this.stores.set(store.storeId, createdStore);
-                }
-                Object.entries(store.state).forEach(([key, value]) => {
-                    createdStore.set(key, value);
-                });
-            })));
-        });
+    async setStoresFromData(stores) {
+        return Promise.all(stores.map(async (store) => {
+            let createdStore = await this.getCreatedStore(store.storeId);
+            if (!createdStore) {
+                createdStore = await this.createStore();
+                this.stores.set(store.storeId, createdStore);
+            }
+            Object.entries(store.state).forEach(([key, value]) => {
+                createdStore.set(key, value);
+            });
+        }));
     }
     deleteStoreRegister(storeId) {
         this.stores.delete(storeId);
     }
-    cleanStore(storeId) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const existingStore = yield this.getCreatedStore(storeId);
-            if (existingStore) {
-                const store = existingStore instanceof Promise ? yield existingStore : existingStore;
-                store.dispose();
-                this.deleteStoreRegister(storeId);
-            }
-        });
+    async cleanStore(storeId) {
+        const existingStore = await this.getCreatedStore(storeId);
+        if (existingStore) {
+            const store = existingStore instanceof Promise ? await existingStore : existingStore;
+            store.dispose();
+            this.deleteStoreRegister(storeId);
+        }
     }
-    cleanAllStores() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const storeIds = Array.from(this.stores.keys());
-            for (const storeId of storeIds) {
-                yield this.cleanStore(storeId);
-            }
-        });
+    async cleanAllStores() {
+        const storeIds = Array.from(this.stores.keys());
+        for (const storeId of storeIds) {
+            await this.cleanStore(storeId);
+        }
     }
 }

package/dist/cache-managers/cache-metric-manager.js

@@ -1,12 +1,3 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 import { QrveyCacheManager } from "./cache-manager";
 import MetricPanelApi from "../services/api/metrics.api";
 export class MetricCacheManager extends QrveyCacheManager {
@@ -22,18 +13,16 @@ export class MetricCacheManager extends QrveyCacheManager {
     buildStoreId({ metric_id }) {
         return `${metric_id}`;
     }
-    fetchDataAndUpdateStore(state, config) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const api = new MetricPanelApi();
-            return api
-                .getMetricConfig(config)
-                .then((metric) => {
-                state.entity = metric;
-                state.error = null;
-            })
-                .catch((e) => {
-                state.error = e;
-            });
+    async fetchDataAndUpdateStore(state, config) {
+        const api = new MetricPanelApi();
+        return api
+            .getMetricConfig(config)
+            .then((metric) => {
+            state.entity = metric;
+            state.error = null;
+        })
+            .catch((e) => {
+            state.error = e;
         });
     }
 }

package/dist/cache-managers/cache-model-manager.js

@@ -1,12 +1,3 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 import { QrveyCacheManager } from "./cache-manager";
 import { getModel } from "../services/api/getModel.api";
 export class ModelCacheManager extends QrveyCacheManager {
@@ -22,22 +13,20 @@ export class ModelCacheManager extends QrveyCacheManager {
     buildStoreId({ qrvey_id }) {
         return `${qrvey_id}`;
     }
-    fetchDataAndUpdateStore(state, config) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const includeInfo = [
-                "bucketsInfo",
-                "formulaInfo",
-                "colorByValueInfo",
-                "formulaAggregate",
-            ];
-            return getModel(config, { includeInfo })
-                .then((model) => {
-                state.entity = model;
-                state.error = null;
-            })
-                .catch((e) => {
-                state.error = e;
-            });
+    async fetchDataAndUpdateStore(state, config) {
+        const includeInfo = [
+            "bucketsInfo",
+            "formulaInfo",
+            "colorByValueInfo",
+            "formulaAggregate",
+        ];
+        return getModel(config, { includeInfo })
+            .then((model) => {
+            state.entity = model;
+            state.error = null;
+        })
+            .catch((e) => {
+            state.error = e;
         });
     }
 }

package/dist/cache-managers/cache-permissions-manager.js

@@ -1,12 +1,3 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 import { QrveyCacheManager } from "./cache-manager";
 import { getAdminPermissions } from "../services/api/adminPermissions.api";
 export class PermissionsCacheManager extends QrveyCacheManager {
@@ -22,16 +13,14 @@ export class PermissionsCacheManager extends QrveyCacheManager {
     buildStoreId({ user_id }) {
         return `${user_id}`;
     }
-    fetchDataAndUpdateStore(state, config) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return getAdminPermissions(config)
-                .then((permissions) => {
-                state.entity = permissions;
-                state.error = null;
-            })
-                .catch((e) => {
-                state.error = e;
-            });
+    async fetchDataAndUpdateStore(state, config) {
+        return getAdminPermissions(config)
+            .then((permissions) => {
+            state.entity = permissions;
+            state.error = null;
+        })
+            .catch((e) => {
+            state.error = e;
         });
     }
 }

package/dist/cache-managers/cache-platform-config-manager.js

@@ -1,12 +1,3 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 import { QrveyCacheManager } from "./cache-manager";
 import { getPlatformConfig } from "../services/api/platformConfig.api";
 export class PlatformConfigCacheManager extends QrveyCacheManager {
@@ -22,16 +13,14 @@ export class PlatformConfigCacheManager extends QrveyCacheManager {
     buildStoreId({ app_id }) {
         return `${app_id}`;
     }
-    fetchDataAndUpdateStore(state, config) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return getPlatformConfig(config)
-                .then((platformConfig) => {
-                state.entity = platformConfig;
-                state.error = null;
-            })
-                .catch((e) => {
-                state.error = e;
-            });
+    async fetchDataAndUpdateStore(state, config) {
+        return getPlatformConfig(config)
+            .then((platformConfig) => {
+            state.entity = platformConfig;
+            state.error = null;
+        })
+            .catch((e) => {
+            state.error = e;
         });
     }
 }

package/dist/cache-managers/cache-theme-manager.js

@@ -1,12 +1,3 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 import { QrveyCacheManager } from "./cache-manager";
 import { getCurrentTheme, getThemeById } from "../services/api/Themes.api";
 export class ThemeCacheManager extends QrveyCacheManager {
@@ -20,18 +11,16 @@ export class ThemeCacheManager extends QrveyCacheManager {
         return "theme_id";
     }
     buildStoreId({ theme_id, app_id }) {
-        return `${app_id}-${theme_id !== null && theme_id !== void 0 ? theme_id : "current"}`;
+        return `${app_id}-${theme_id ?? "current"}`;
     }
-    fetchDataAndUpdateStore(state, config) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return (config.theme_id ? getThemeById(config) : getCurrentTheme(config))
-                .then((theme) => {
-                state.entity = theme;
-                state.error = null;
-            })
-                .catch((e) => {
-                state.error = e;
-            });
+    async fetchDataAndUpdateStore(state, config) {
+        return (config.theme_id ? getThemeById(config) : getCurrentTheme(config))
+            .then((theme) => {
+            state.entity = theme;
+            state.error = null;
+        })
+            .catch((e) => {
+            state.error = e;
         });
     }
 }

package/dist/cache-managers/clean-cache-managers.js

@@ -1,29 +1,20 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 import { ChartCacheManager } from "./cache-chart-manager";
 import { MetricCacheManager } from "./cache-metric-manager";
 import { ModelCacheManager } from "./cache-model-manager";
 import { PermissionsCacheManager } from "./cache-permissions-manager";
 import { PlatformConfigCacheManager } from "./cache-platform-config-manager";
 import { ThemeCacheManager } from "./cache-theme-manager";
-export const cleanCacheManagers = () => __awaiter(void 0, void 0, void 0, function* () {
+export const cleanCacheManagers = async () => {
     const chartManager = ChartCacheManager.getInstance();
-    yield chartManager.cleanAllStores();
+    await chartManager.cleanAllStores();
     const metricManager = MetricCacheManager.getInstance();
-    yield metricManager.cleanAllStores();
+    await metricManager.cleanAllStores();
     const modelManager = ModelCacheManager.getInstance();
-    yield modelManager.cleanAllStores();
+    await modelManager.cleanAllStores();
     const permissionsManager = PermissionsCacheManager.getInstance();
-    yield permissionsManager.cleanAllStores();
+    await permissionsManager.cleanAllStores();
     const themeManager = ThemeCacheManager.getInstance();
-    yield themeManager.cleanAllStores();
+    await themeManager.cleanAllStores();
     const platformConfigManager = PlatformConfigCacheManager.getInstance();
-    yield platformConfigManager.cleanAllStores();
-});
+    await platformConfigManager.cleanAllStores();
+};

package/dist/charts/adapters/RequestAdapterMetric.d.ts

@@ -1,21 +1,5 @@
 import { IBColumn } from "../../columns";
 import { CustomRangeConfig, MetricConfig, MetricConfigData, MetricCustomRange, MetricPeriod, MetricRequestPayload, MetricTimeInfo } from "../interfaces/IRequestAdapterMetric";
-/**
- * It takes a metric object and returns a metric request object
- * @param {MetricConfig} metricObj - MetricConfigData
- * @returns A function that takes in a metricObj and returns a partial metricRequest
- */
 export declare const makeBodyRequestMetrics: (metricObj: MetricConfig) => Partial<MetricRequestPayload>;
 export declare const isDateAsText: (data: Partial<MetricConfigData>) => boolean;
-/**
- * It takes a date column, time data, and a custom range config and returns a metric period or metric
- * custom range
- * @param dateColumn - The column that contains the date data.
- * @param timeData - {
- * @param {CustomRangeConfig} range - CustomRangeConfig
- * @returns An object with the following properties:
- *   - label
- *   - value
- *   - questionid
- */
 export declare const metricMakeTimeData: (dateColumn: IBColumn, timeData: MetricTimeInfo, range: CustomRangeConfig) => MetricPeriod | MetricCustomRange;