@qrvey/utils 1.18.17 → 1.18.18-0

package/README.md

@@ -1,4 +1,4 @@
-# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.18.17*
+# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.18.18-0*
 
 > Helper, Utils for all Qrvey Projects
 
@@ -55,7 +55,7 @@ const { formatDate } = require("@qrvey/utils/format/format");
 
 | Module | Description | Subpath import | API docs |
 | ------ | ----------- | -------------- | -------- |
-| `cache-managers` | Managers for caching chart, metric, model, theme, platform-config and permissions data. Provides a centralised in-memory caching layer used across Qrvey widgets. | `@qrvey/utils/cache-managers/index` | [docs](docs/cache-managers/index.md) |
+| `cache-managers` | Managers for caching chart, metric, model, theme, platform-config, application null-handling and permissions data. Provides a centralised in-memory caching layer used across Qrvey widgets. | `@qrvey/utils/cache-managers/index` | [docs](docs/cache-managers/index.md) |
 | `charts` | Constants, interfaces, adapters and helpers for chart types, aggregations, request adapters and chart configuration objects. | `@qrvey/utils/charts/index` | [docs](docs/charts/index.md) |
 | `column_format` | Helpers and constants for column display formatting: string formats, date groups, duration parts, chart groups, shelf types and table types. | `@qrvey/utils/column_format/index` | [docs](docs/column_format/index.md) |
 | `columns` | Interfaces, constants and helpers for dataset column definitions, compound columns and column property descriptors. | `@qrvey/utils/columns/index` | [docs](docs/columns/index.md) |

package/dist/cache-managers/cache-application-null-handling-manager.d.ts

@@ -0,0 +1,13 @@
+import { QrveyCacheManager } from "./cache-manager";
+import { ApplicationNullHandlingStore, IApplicationNullHandlingConfig, IApplicationNullHandlingStoreState } from "../interfaces/ApplicationNullHandling.Interface";
+export declare class ApplicationNullHandlingCacheManager extends QrveyCacheManager<IApplicationNullHandlingStoreState, IApplicationNullHandlingConfig> {
+    private readonly reads;
+    static getInstance(): ApplicationNullHandlingCacheManager;
+    getStore(config: IApplicationNullHandlingConfig): Promise<ApplicationNullHandlingStore>;
+    getStoreFromPromise(config: IApplicationNullHandlingConfig, id?: string): Promise<ApplicationNullHandlingStore>;
+    protected getConfigEntityId(): keyof IApplicationNullHandlingConfig;
+    protected buildStoreId(config: IApplicationNullHandlingConfig): string;
+    protected fetchDataAndUpdateStore(state: IApplicationNullHandlingStoreState, config: IApplicationNullHandlingConfig): Promise<void>;
+    private readStore;
+    private fallback;
+}

package/dist/cache-managers/cache-application-null-handling-manager.js

@@ -0,0 +1,74 @@
+import { QrveyCacheManager } from "./cache-manager";
+import { getApplicationNullHandling } from "../services/api/applicationNullHandling.api";
+import { APPLICATION_NULL_HANDLING_FAILURE_TTL_SECONDS, APPLICATION_NULL_HANDLING_FALLBACK, APPLICATION_NULL_HANDLING_MANAGER_KEY, } from "../services/constants/APPLICATION_NULL_HANDLING";
+export class ApplicationNullHandlingCacheManager extends QrveyCacheManager {
+    reads = new Map();
+    static getInstance() {
+        const host = window;
+        const existing = host[APPLICATION_NULL_HANDLING_MANAGER_KEY];
+        if (existing)
+            return existing;
+        const created = new ApplicationNullHandlingCacheManager();
+        host[APPLICATION_NULL_HANDLING_MANAGER_KEY] = created;
+        return created;
+    }
+    getStore(config) {
+        if (!config.qv_token && !config.api_key) {
+            return this.createStore({
+                entity: this.fallback(),
+                error: false,
+                expiresAt: 0,
+            });
+        }
+        const storeId = this.buildStoreId(config);
+        const pending = this.reads.get(storeId);
+        if (pending)
+            return pending;
+        const read = this.readStore(storeId, config).finally(() => this.reads.delete(storeId));
+        this.reads.set(storeId, read);
+        return read;
+    }
+    getStoreFromPromise(config, id) {
+        return this.getStore(id === undefined ? config : { ...config, app_id: id });
+    }
+    getConfigEntityId() {
+        return "app_id";
+    }
+    buildStoreId(config) {
+        const { app_id, qv_token, user_id } = config;
+        const pair = `${user_id || "undefined"}:${app_id || "undefined"}`;
+        return qv_token && (!user_id || !app_id) ? `${pair}:${qv_token}` : pair;
+    }
+    async fetchDataAndUpdateStore(state, config) {
+        try {
+            const response = await getApplicationNullHandling(config);
+            state.entity = response.effective;
+            state.error = false;
+            state.expiresAt = Date.now() + response.maxAgeSeconds * 1000;
+        }
+        catch (error) {
+            console.warn(`Null-handling configuration unavailable for user_id ${config.user_id} and app_id ${config.app_id}; using Blank / Ignore for ${APPLICATION_NULL_HANDLING_FAILURE_TTL_SECONDS} s.`, error);
+            state.entity = this.fallback();
+            state.error = true;
+            state.expiresAt =
+                Date.now() + APPLICATION_NULL_HANDLING_FAILURE_TTL_SECONDS * 1000;
+        }
+    }
+    async readStore(storeId, config) {
+        const cached = await this.stores.get(storeId);
+        if (cached && Date.now() < cached.state.expiresAt)
+            return cached;
+        const store = cached ?? (await this.createStore({ expiresAt: 0 }));
+        await this.fetchDataAndUpdateStore(store.state, config);
+        this.stores.set(storeId, store);
+        return store;
+    }
+    fallback() {
+        return {
+            visualIndicator: {
+                ...APPLICATION_NULL_HANDLING_FALLBACK.visualIndicator,
+            },
+            nullHandling: { ...APPLICATION_NULL_HANDLING_FALLBACK.nullHandling },
+        };
+    }
+}

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

@@ -1,3 +1,4 @@
+import { ApplicationNullHandlingCacheManager } from "./cache-application-null-handling-manager";
 import { ChartCacheManager } from "./cache-chart-manager";
 import { MetricCacheManager } from "./cache-metric-manager";
 import { ModelCacheManager } from "./cache-model-manager";
@@ -17,4 +18,6 @@ export const cleanCacheManagers = async () => {
     await themeManager.cleanAllStores();
     const platformConfigManager = PlatformConfigCacheManager.getInstance();
     await platformConfigManager.cleanAllStores();
+    const applicationNullHandlingManager = ApplicationNullHandlingCacheManager.getInstance();
+    await applicationNullHandlingManager.cleanAllStores();
 };

package/dist/cache-managers/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./cache-application-null-handling-manager";
 export * from "./cache-chart-manager";
 export * from "./cache-manager";
 export * from "./cache-metric-manager";

package/dist/cache-managers/index.js

@@ -1,3 +1,4 @@
+export * from "./cache-application-null-handling-manager";
 export * from "./cache-chart-manager";
 export * from "./cache-manager";
 export * from "./cache-metric-manager";

package/dist/cjs/cache-managers/cache-application-null-handling-manager.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApplicationNullHandlingCacheManager = void 0;
+const cache_manager_1 = require("./cache-manager");
+const applicationNullHandling_api_1 = require("../services/api/applicationNullHandling.api");
+const APPLICATION_NULL_HANDLING_1 = require("../services/constants/APPLICATION_NULL_HANDLING");
+class ApplicationNullHandlingCacheManager extends cache_manager_1.QrveyCacheManager {
+    reads = new Map();
+    static getInstance() {
+        const host = window;
+        const existing = host[APPLICATION_NULL_HANDLING_1.APPLICATION_NULL_HANDLING_MANAGER_KEY];
+        if (existing)
+            return existing;
+        const created = new ApplicationNullHandlingCacheManager();
+        host[APPLICATION_NULL_HANDLING_1.APPLICATION_NULL_HANDLING_MANAGER_KEY] = created;
+        return created;
+    }
+    getStore(config) {
+        if (!config.qv_token && !config.api_key) {
+            return this.createStore({
+                entity: this.fallback(),
+                error: false,
+                expiresAt: 0,
+            });
+        }
+        const storeId = this.buildStoreId(config);
+        const pending = this.reads.get(storeId);
+        if (pending)
+            return pending;
+        const read = this.readStore(storeId, config).finally(() => this.reads.delete(storeId));
+        this.reads.set(storeId, read);
+        return read;
+    }
+    getStoreFromPromise(config, id) {
+        return this.getStore(id === undefined ? config : { ...config, app_id: id });
+    }
+    getConfigEntityId() {
+        return "app_id";
+    }
+    buildStoreId(config) {
+        const { app_id, qv_token, user_id } = config;
+        const pair = `${user_id || "undefined"}:${app_id || "undefined"}`;
+        return qv_token && (!user_id || !app_id) ? `${pair}:${qv_token}` : pair;
+    }
+    async fetchDataAndUpdateStore(state, config) {
+        try {
+            const response = await (0, applicationNullHandling_api_1.getApplicationNullHandling)(config);
+            state.entity = response.effective;
+            state.error = false;
+            state.expiresAt = Date.now() + response.maxAgeSeconds * 1000;
+        }
+        catch (error) {
+            console.warn(`Null-handling configuration unavailable for user_id ${config.user_id} and app_id ${config.app_id}; using Blank / Ignore for ${APPLICATION_NULL_HANDLING_1.APPLICATION_NULL_HANDLING_FAILURE_TTL_SECONDS} s.`, error);
+            state.entity = this.fallback();
+            state.error = true;
+            state.expiresAt =
+                Date.now() + APPLICATION_NULL_HANDLING_1.APPLICATION_NULL_HANDLING_FAILURE_TTL_SECONDS * 1000;
+        }
+    }
+    async readStore(storeId, config) {
+        const cached = await this.stores.get(storeId);
+        if (cached && Date.now() < cached.state.expiresAt)
+            return cached;
+        const store = cached ?? (await this.createStore({ expiresAt: 0 }));
+        await this.fetchDataAndUpdateStore(store.state, config);
+        this.stores.set(storeId, store);
+        return store;
+    }
+    fallback() {
+        return {
+            visualIndicator: {
+                ...APPLICATION_NULL_HANDLING_1.APPLICATION_NULL_HANDLING_FALLBACK.visualIndicator,
+            },
+            nullHandling: { ...APPLICATION_NULL_HANDLING_1.APPLICATION_NULL_HANDLING_FALLBACK.nullHandling },
+        };
+    }
+}
+exports.ApplicationNullHandlingCacheManager = ApplicationNullHandlingCacheManager;

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

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.cleanCacheManagers = void 0;
+const cache_application_null_handling_manager_1 = require("./cache-application-null-handling-manager");
 const cache_chart_manager_1 = require("./cache-chart-manager");
 const cache_metric_manager_1 = require("./cache-metric-manager");
 const cache_model_manager_1 = require("./cache-model-manager");
@@ -20,5 +21,7 @@ const cleanCacheManagers = async () => {
     await themeManager.cleanAllStores();
     const platformConfigManager = cache_platform_config_manager_1.PlatformConfigCacheManager.getInstance();
     await platformConfigManager.cleanAllStores();
+    const applicationNullHandlingManager = cache_application_null_handling_manager_1.ApplicationNullHandlingCacheManager.getInstance();
+    await applicationNullHandlingManager.cleanAllStores();
 };
 exports.cleanCacheManagers = cleanCacheManagers;

package/dist/cjs/cache-managers/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./cache-application-null-handling-manager"), exports);
 tslib_1.__exportStar(require("./cache-chart-manager"), exports);
 tslib_1.__exportStar(require("./cache-manager"), exports);
 tslib_1.__exportStar(require("./cache-metric-manager"), exports);

package/dist/cjs/interfaces/ApplicationNullHandling.Interface.js

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

package/dist/cjs/interfaces/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./ApplicationNullHandling.Interface"), exports);
 tslib_1.__exportStar(require("./Chart.Interface"), exports);
 tslib_1.__exportStar(require("./IChartBuilder.Interface"), exports);
 tslib_1.__exportStar(require("./general"), exports);

package/dist/cjs/services/api/applicationNullHandling.api.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getApplicationNullHandling = getApplicationNullHandling;
+const APPLICATION_NULL_HANDLING_1 = require("../constants/APPLICATION_NULL_HANDLING");
+const Request_1 = require("../helpers/Request");
+function getApplicationNullHandling(config) {
+    const controller = new AbortController();
+    const requestConfig = {
+        apiKey: config.api_key,
+        app_id: config.app_id || "undefined",
+        domain: config.domain,
+        endpoint: APPLICATION_NULL_HANDLING_1.APPLICATION_NULL_HANDLING_ENDPOINT,
+        qvToken: config.qv_token,
+        signal: controller.signal,
+        user_id: config.user_id || "undefined",
+    };
+    const request = fetch(Request_1.Request.makeUrl(requestConfig, ""), Request_1.Request.requestConfig({ config: requestConfig, type: "GET", url: "" }))
+        .then((response) => Request_1.Request.checkStatus(response))
+        .then((response) => response.json());
+    let timer;
+    const timeout = new Promise((_resolve, reject) => {
+        timer = setTimeout(() => {
+            controller.abort();
+            reject(new Error(`No answer within ${APPLICATION_NULL_HANDLING_1.APPLICATION_NULL_HANDLING_TIMEOUT_MS} ms`));
+        }, APPLICATION_NULL_HANDLING_1.APPLICATION_NULL_HANDLING_TIMEOUT_MS);
+    });
+    return Promise.race([request, timeout]).finally(() => clearTimeout(timer));
+}

package/dist/cjs/services/api/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./applicationNullHandling.api"), exports);
 tslib_1.__exportStar(require("./getAllDatasets.api"), exports);
 tslib_1.__exportStar(require("./getAllQrveys.api"), exports);
 tslib_1.__exportStar(require("./getDatasetColumns.api"), exports);

package/dist/cjs/services/constants/APPLICATION_NULL_HANDLING.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.APPLICATION_NULL_HANDLING_MANAGER_KEY = exports.APPLICATION_NULL_HANDLING_FALLBACK = exports.APPLICATION_NULL_HANDLING_FAILURE_TTL_SECONDS = exports.APPLICATION_NULL_HANDLING_TIMEOUT_MS = exports.APPLICATION_NULL_HANDLING_ENDPOINT = void 0;
+exports.APPLICATION_NULL_HANDLING_ENDPOINT = {
+    devApi: true,
+    noUser: true,
+    uri: "/user/:user_id/app/:app_id/config/null-handling",
+    version: 4,
+};
+exports.APPLICATION_NULL_HANDLING_TIMEOUT_MS = 2000;
+exports.APPLICATION_NULL_HANDLING_FAILURE_TTL_SECONDS = 30;
+exports.APPLICATION_NULL_HANDLING_FALLBACK = {
+    visualIndicator: { type: "BLANK", value: "" },
+    nullHandling: { analytics: "IGNORE" },
+};
+exports.APPLICATION_NULL_HANDLING_MANAGER_KEY = "qvApplicationNullHandlingCacheManager";

package/dist/interfaces/ApplicationNullHandling.Interface.d.ts

@@ -0,0 +1,39 @@
+import type { QrveyCacheManager } from "../cache-managers/cache-manager";
+export type NullVisualIndicatorType = "BLANK" | "NULLABLE" | "OTHER";
+export type NullAnalyticsHandling = "IGNORE" | "INCLUDE";
+export type NullHandlingSource = "ENFORCED" | "APPLICATION" | "GLOBAL" | "DEFAULT";
+export interface INullVisualIndicator {
+    type: NullVisualIndicatorType;
+    value?: string;
+}
+export interface INullHandlingBehavior {
+    analytics?: NullAnalyticsHandling;
+}
+export interface INullHandlingValues {
+    visualIndicator: INullVisualIndicator;
+    nullHandling: INullHandlingBehavior;
+}
+export interface IApplicationNullHandlingState extends Partial<INullHandlingValues> {
+    followGlobalSettings: boolean;
+}
+export interface IApplicationNullHandlingResponse {
+    effective: INullHandlingValues;
+    source: NullHandlingSource;
+    enforceForAllApplications: boolean;
+    application: IApplicationNullHandlingState;
+    global?: INullHandlingValues;
+    maxAgeSeconds: number;
+}
+export interface IApplicationNullHandlingConfig {
+    domain?: string;
+    api_key?: string;
+    qv_token?: string;
+    user_id?: string;
+    app_id?: string;
+}
+export interface IApplicationNullHandlingStoreState {
+    entity: INullHandlingValues | null;
+    error: boolean;
+    expiresAt: number;
+}
+export type ApplicationNullHandlingStore = Awaited<ReturnType<QrveyCacheManager<IApplicationNullHandlingStoreState, IApplicationNullHandlingConfig>["getStore"]>>;

package/dist/interfaces/ApplicationNullHandling.Interface.js

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

package/dist/interfaces/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./ApplicationNullHandling.Interface";
 export * from "./Chart.Interface";
 export * from "./IChartBuilder.Interface";
 export * from "./general";

package/dist/interfaces/index.js

@@ -1,3 +1,4 @@
+export * from "./ApplicationNullHandling.Interface";
 export * from "./Chart.Interface";
 export * from "./IChartBuilder.Interface";
 export * from "./general";

package/dist/services/api/applicationNullHandling.api.d.ts

@@ -0,0 +1,2 @@
+import { IApplicationNullHandlingConfig, IApplicationNullHandlingResponse } from "../../interfaces/ApplicationNullHandling.Interface";
+export declare function getApplicationNullHandling(config: IApplicationNullHandlingConfig): Promise<IApplicationNullHandlingResponse>;

package/dist/services/api/applicationNullHandling.api.js

@@ -0,0 +1,25 @@
+import { APPLICATION_NULL_HANDLING_ENDPOINT, APPLICATION_NULL_HANDLING_TIMEOUT_MS, } from "../constants/APPLICATION_NULL_HANDLING";
+import { Request } from "../helpers/Request";
+export function getApplicationNullHandling(config) {
+    const controller = new AbortController();
+    const requestConfig = {
+        apiKey: config.api_key,
+        app_id: config.app_id || "undefined",
+        domain: config.domain,
+        endpoint: APPLICATION_NULL_HANDLING_ENDPOINT,
+        qvToken: config.qv_token,
+        signal: controller.signal,
+        user_id: config.user_id || "undefined",
+    };
+    const request = fetch(Request.makeUrl(requestConfig, ""), Request.requestConfig({ config: requestConfig, type: "GET", url: "" }))
+        .then((response) => Request.checkStatus(response))
+        .then((response) => response.json());
+    let timer;
+    const timeout = new Promise((_resolve, reject) => {
+        timer = setTimeout(() => {
+            controller.abort();
+            reject(new Error(`No answer within ${APPLICATION_NULL_HANDLING_TIMEOUT_MS} ms`));
+        }, APPLICATION_NULL_HANDLING_TIMEOUT_MS);
+    });
+    return Promise.race([request, timeout]).finally(() => clearTimeout(timer));
+}

package/dist/services/api/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./applicationNullHandling.api";
 export * from "./getAllDatasets.api";
 export * from "./getAllQrveys.api";
 export * from "./getDatasetColumns.api";

package/dist/services/api/index.js

@@ -1,3 +1,4 @@
+export * from "./applicationNullHandling.api";
 export * from "./getAllDatasets.api";
 export * from "./getAllQrveys.api";
 export * from "./getDatasetColumns.api";

package/dist/services/constants/APPLICATION_NULL_HANDLING.d.ts

@@ -0,0 +1,7 @@
+import { INullHandlingValues } from "../../interfaces/ApplicationNullHandling.Interface";
+import { IEndpointConfig } from "../interfaces/IEndpointConfig";
+export declare const APPLICATION_NULL_HANDLING_ENDPOINT: IEndpointConfig;
+export declare const APPLICATION_NULL_HANDLING_TIMEOUT_MS = 2000;
+export declare const APPLICATION_NULL_HANDLING_FAILURE_TTL_SECONDS = 30;
+export declare const APPLICATION_NULL_HANDLING_FALLBACK: INullHandlingValues;
+export declare const APPLICATION_NULL_HANDLING_MANAGER_KEY = "qvApplicationNullHandlingCacheManager";

package/dist/services/constants/APPLICATION_NULL_HANDLING.js

@@ -0,0 +1,13 @@
+export const APPLICATION_NULL_HANDLING_ENDPOINT = {
+    devApi: true,
+    noUser: true,
+    uri: "/user/:user_id/app/:app_id/config/null-handling",
+    version: 4,
+};
+export const APPLICATION_NULL_HANDLING_TIMEOUT_MS = 2000;
+export const APPLICATION_NULL_HANDLING_FAILURE_TTL_SECONDS = 30;
+export const APPLICATION_NULL_HANDLING_FALLBACK = {
+    visualIndicator: { type: "BLANK", value: "" },
+    nullHandling: { analytics: "IGNORE" },
+};
+export const APPLICATION_NULL_HANDLING_MANAGER_KEY = "qvApplicationNullHandlingCacheManager";

package/package.json

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