@qrvey/utils 1.12.0 → 1.12.23

package/dist/cjs/filters/interfaces/ui/IFUValue.d.ts

@@ -1,10 +0,0 @@
-/**
- * Structure for Displaying Value
- */
-export interface IFUValue {
-    displayed?: boolean;
-    enabled?: boolean;
-    imageUrl?: string;
-    value?: string;
-    valueid?: string;
-}

package/dist/cjs/filters/interfaces/ui/IFUValue.js

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

package/dist/cjs/filters/interfaces/ui/index.d.ts

@@ -1,25 +0,0 @@
-/**
- * I: Interface
- * F: Filter Section
- * U: Visualization Structure
- * S: Common|Storing Structure
- * B: Backend Structure
- *
- * IFt-: Regular and General scenarios of types
- * IFU-: Structures to help to visualize the filters
- * IFS-: Structures with common uses
- * IFB-: Structures to recognize the backend side
- */
-export * from "./IFUChartSettings";
-export * from "./IFUColumn";
-export * from "./IFUData";
-export * from "./IFUDataset";
-export * from "./IFUDataStore";
-export * from "./IFUFilter";
-export * from "./IFUFilterExtras";
-export * from "./IFUFlattenedFilter";
-export * from "./IFUParamsToGetFilter";
-export * from "./IFUScope";
-export * from "./IFUTransformFilterValuesSettings";
-export * from "./IFUUIValueSettings";
-export * from "./IFUValue";

package/dist/cjs/filters/interfaces/ui/index.js

@@ -1,41 +0,0 @@
-"use strict";
-/**
- * I: Interface
- * F: Filter Section
- * U: Visualization Structure
- * S: Common|Storing Structure
- * B: Backend Structure
- *
- * IFt-: Regular and General scenarios of types
- * IFU-: Structures to help to visualize the filters
- * IFS-: Structures with common uses
- * IFB-: Structures to recognize the backend side
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./IFUChartSettings"), exports);
-__exportStar(require("./IFUColumn"), exports);
-__exportStar(require("./IFUData"), exports);
-__exportStar(require("./IFUDataset"), exports);
-__exportStar(require("./IFUDataStore"), exports);
-__exportStar(require("./IFUFilter"), exports);
-__exportStar(require("./IFUFilterExtras"), exports);
-__exportStar(require("./IFUFlattenedFilter"), exports);
-__exportStar(require("./IFUParamsToGetFilter"), exports);
-__exportStar(require("./IFUScope"), exports);
-__exportStar(require("./IFUTransformFilterValuesSettings"), exports);
-__exportStar(require("./IFUUIValueSettings"), exports);
-__exportStar(require("./IFUValue"), exports);

package/dist/cjs/filters/services/Filters.api.d.ts

@@ -1,52 +0,0 @@
-import { IFBData } from "../interfaces/backend/IFBData";
-import { IEndpointConfig } from "../../services/interfaces/IEndpointConfig";
-import { IDataset } from "../../qrvey/interfaces/IDataset";
-import { IFilterConfig } from "../interfaces/common/IFilterConfig";
-import { IModel } from "../../qrvey/interfaces/IModel";
-import { IFFiltersGetData } from "../interfaces/functions/IFFiltersGetData";
-interface IFilterApiConfig extends IFilterConfig {
-    endpoint?: IEndpointConfig;
-    qrveyid: string;
-}
-export declare class FiltersApi {
-    private config;
-    private chartApi;
-    private chartPaginationApi;
-    constructor(cfg: IFilterApiConfig);
-    /**
-     * Get the model by Qrvey ID
-     * @param qrveyid The Qrvey ID
-     * @returns a promise with the resulting model
-     */
-    getModel(qrveyid?: string): Promise<IModel>;
-    /**
-     * Get a dataset list from a collection of Qrvey IDs
-     * @param qrveyids Collection of Qrvey IDs
-     * @returns a promise
-     */
-    getDatasets(qrveyids: string[]): Promise<IDataset[]>;
-    getData(config: IFFiltersGetData, resetApi?: boolean): Promise<IFBData>;
-    /**
-     * Get a promise with a preview of resulting data. Depending on the validator, the endpoint will change.
-     * @param uFilter The Filter Builder Filter
-     * @param filterLogic Additional filter logic to apply in the preview
-     * @param chartSettings
-     * @param resetApi flag to determine when the api should be reseted.
-     * @returns a promise with a preview of resulting data.
-     */
-    private getDataValues;
-    private static getLogic;
-    private static getFilter;
-    private static getChartRequest;
-    /**
-     * Gets the available scopes and scope IDs
-     * @returns a collection of the pair Scopes and Scope IDs
-     */
-    private static getAvailableScopeIds;
-    /**
-     * Set the config into the Filter Builder Api class
-     * @param config the config.
-     */
-    setConfig(config: IFilterApiConfig): void;
-}
-export {};

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

@@ -1,156 +0,0 @@
-"use strict";
-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());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FiltersApi = void 0;
-const UChartPaginationApi_1 = __importDefault(require("./UChartPaginationApi"));
-const UChartApi_1 = __importDefault(require("./UChartApi"));
-const isRangeValidator_1 = require("../helpers/common/isRangeValidator");
-const getFiltersByVisibility_1 = require("../helpers/common/getFiltersByVisibility");
-const excludeFiltersByAggregateColumn_1 = require("../helpers/common/excludeFiltersByAggregateColumn");
-const FDToLogic_1 = require("../adapters/FDToLogic");
-const getLogicByScopesHierarchy_1 = require("../helpers/backend/getLogicByScopesHierarchy");
-const buildUserFilters_1 = require("../helpers/backend/buildUserFilters");
-const applyHierarchyForAggFilters_1 = require("../helpers/applyHierarchyForAggFilters");
-const getAvailableScopes_1 = require("../helpers/getAvailableScopes");
-const getAvailableScopesIDsByConfig_1 = require("../helpers/getAvailableScopesIDsByConfig");
-const FILTER_SCOPE_1 = require("../constants/common/FILTER_SCOPE");
-const getAllDatasets_api_1 = require("../../services/api/getAllDatasets.api");
-const isEmpty_1 = require("../../general/mix/isEmpty");
-const getModel_api_1 = require("../../services/api/getModel.api");
-const areStaticColumnValues_1 = require("../../qrvey/helpers/areStaticColumnValues");
-const getValuesFromDataset_1 = require("../helpers/common/getValuesFromDataset");
-const getDatasetByColumn_1 = require("../../qrvey/helpers/getDatasetByColumn");
-const getLogicByDatasets_1 = require("../helpers/backend/getLogicByDatasets");
-const getFiltersByParams_1 = require("../helpers/common/getFiltersByParams");
-class FiltersApi {
-    constructor(cfg) {
-        this.setConfig(cfg);
-        this.chartPaginationApi = new UChartPaginationApi_1.default();
-        this.chartApi = new UChartApi_1.default();
-    }
-    /**
-     * Get the model by Qrvey ID
-     * @param qrveyid The Qrvey ID
-     * @returns a promise with the resulting model
-     */
-    getModel(qrveyid) {
-        const config = (0, isEmpty_1.isEmpty)(qrveyid)
-            ? Object.assign({}, this.config) : Object.assign(Object.assign({}, this.config), { qrveyid });
-        return (0, getModel_api_1.getModel)(config, {
-            includeInfo: [
-                "datalinkInfo",
-                "bucketsInfo",
-                "formulaInfo",
-                "componentPreferences",
-            ],
-        });
-    }
-    /**
-     * Get a dataset list from a collection of Qrvey IDs
-     * @param qrveyids Collection of Qrvey IDs
-     * @returns a promise
-     */
-    getDatasets(qrveyids) {
-        return (0, getAllDatasets_api_1.getAllDatasets)(this.config, qrveyids);
-    }
-    // public getAllDataTokens(config): Promise<any> {
-    //   return DataTokensApi.getAll(config);
-    // }
-    getData(config, resetApi = false) {
-        var _a, _b, _c, _d, _e, _f;
-        let promise;
-        if ((0, areStaticColumnValues_1.areStaticColumnValues)((_a = config.filter) === null || _a === void 0 ? void 0 : _a.column) &&
-            (0, isEmpty_1.isEmpty)((_b = config.filter) === null || _b === void 0 ? void 0 : _b.column.aggregate)) {
-            promise = (0, getValuesFromDataset_1.getValuesFromDataset)({
-                column: (_c = config.filter) === null || _c === void 0 ? void 0 : _c.column,
-                property: (_d = config.filter) === null || _d === void 0 ? void 0 : _d.property,
-                lookupDisplay: (_e = config.filter) === null || _e === void 0 ? void 0 : _e.lookupDisplayIndex,
-                dataset: (0, getDatasetByColumn_1.getDatasetByColumn)((_f = config.filter) === null || _f === void 0 ? void 0 : _f.column, config.datasets),
-                value: config.valueText,
-            });
-        }
-        else {
-            promise = this.getDataValues(config, resetApi);
-        }
-        return promise;
-    }
-    /**
-     * Get a promise with a preview of resulting data. Depending on the validator, the endpoint will change.
-     * @param uFilter The Filter Builder Filter
-     * @param filterLogic Additional filter logic to apply in the preview
-     * @param chartSettings
-     * @param resetApi flag to determine when the api should be reseted.
-     * @returns a promise with a preview of resulting data.
-     */
-    getDataValues(config, resetApi = false) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let api;
-            if ((0, isRangeValidator_1.isRangeValidator)(config.filter.validator)) {
-                this.chartPaginationApi.afterKey = undefined;
-                api = this.chartApi;
-            }
-            else {
-                api = this.chartPaginationApi;
-            }
-            return api.getChartResult(Object.assign(Object.assign({}, this.config), { timezone: config.widgetConfig.timezone }), FiltersApi.getFilter(config), FiltersApi.getLogic(config), FiltersApi.getChartRequest(config), resetApi);
-        });
-    }
-    static getLogic(config) {
-        var _a;
-        const scopes = FiltersApi.getAvailableScopeIds(config);
-        let filterData = (0, getFiltersByVisibility_1.getFiltersByVisibility)(config.filterData, scopes);
-        const dataset = config.datasets.find((d) => { var _a; return d.qrveyid === ((_a = config.filter) === null || _a === void 0 ? void 0 : _a.column.qrveyid); });
-        filterData = (0, getFiltersByParams_1.getFiltersByParams)(filterData, { qrveyid: dataset === null || dataset === void 0 ? void 0 : dataset.qrveyid }, {
-            letPassUndefinedProperties: { filter: true },
-            filterEmptyArrays: { filter: false },
-        });
-        filterData = (0, excludeFiltersByAggregateColumn_1.excludeFiltersByAggregateColumn)(filterData);
-        const logics = (0, FDToLogic_1.FDToLogic)(filterData);
-        const hierarchyLogic = (0, getLogicByScopesHierarchy_1.getLogicByScopesHierarchy)(logics, scopes, (_a = config.filter) === null || _a === void 0 ? void 0 : _a.extras.scope);
-        return [
-            ...hierarchyLogic,
-            ...((0, getLogicByDatasets_1.getLogicByDatasets)((0, buildUserFilters_1.buildUserFilters)(config.userFilters), (0, isEmpty_1.isEmpty)(dataset) ? [] : [dataset.qrveyid]) || []),
-        ];
-    }
-    static getFilter(config) {
-        return Object.assign(Object.assign({}, config.filter), { values: !(0, isEmpty_1.isEmpty)(config.valueText)
-                ? [{ value: config.valueText, enabled: true }]
-                : undefined });
-    }
-    static getChartRequest(config) {
-        var _a;
-        const scopes = FiltersApi.getAvailableScopeIds(config);
-        return (0, applyHierarchyForAggFilters_1.applyHierarchyForAggFilters)(config.chartRequest, scopes, (_a = config.filter) === null || _a === void 0 ? void 0 : _a.extras.scope);
-    }
-    /**
-     * Gets the available scopes and scope IDs
-     * @returns a collection of the pair Scopes and Scope IDs
-     */
-    static getAvailableScopeIds(config) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-        return (0, getAvailableScopes_1.getAvailableScopes)(Object.assign(Object.assign({}, (0, getAvailableScopesIDsByConfig_1.getAvailableScopesIDsByConfig)(config)), { panelid: FILTER_SCOPE_1.FILTER_SCOPE.CHART === ((_a = config.filter) === null || _a === void 0 ? void 0 : _a.extras.scope)
-                ? (_b = config.filter) === null || _b === void 0 ? void 0 : _b.extras.scopeid
-                : undefined, scopeid: (_c = config.filter) === null || _c === void 0 ? void 0 : _c.extras.scopeid, qrveyid: (_e = (_d = config.filter) === null || _d === void 0 ? void 0 : _d.column) === null || _e === void 0 ? void 0 : _e.qrveyid, defaultid: (_g = (_f = config.filter) === null || _f === void 0 ? void 0 : _f.column) === null || _g === void 0 ? void 0 : _g.qrveyid, scope: undefined, predefinedScopes: [
-                { label: FILTER_SCOPE_1.FILTER_SCOPE.DATA, id: (_j = (_h = config.filter) === null || _h === void 0 ? void 0 : _h.column) === null || _j === void 0 ? void 0 : _j.qrveyid },
-            ] }));
-    }
-    /**
-     * Set the config into the Filter Builder Api class
-     * @param config the config.
-     */
-    setConfig(config) {
-        this.config = Object.assign({}, config);
-    }
-}
-exports.FiltersApi = FiltersApi;

package/dist/cjs/filters/services/UChartApi.d.ts

@@ -1,107 +0,0 @@
-import { IFBData } from "../interfaces/backend/IFBData";
-import { IFilterConfig } from "../interfaces/common/IFilterConfig";
-import { IFUFlattenedFilter } from "../interfaces/ui/IFUFlattenedFilter";
-import { IFBLogic } from "../interfaces/backend/IFBLogic";
-import { IFUChartSettings } from "../interfaces/ui/IFUChartSettings";
-export default class UChartApi {
-    /**
-     * Gets a promise with a resulting data
-     * @param config the config
-     * @param uFilter The filter Builder filter
-     * @param filterLogic Additional filter logic to apply in the preview
-     * @param chartSettings The settings of the chart. For Aggregate Columns.
-     * @returns a promise with a resulting data
-     */
-    getChartResult: (config: IFilterConfig, uFilter: IFUFlattenedFilter, filterLogic?: IFBLogic[], chartSettings?: IFUChartSettings, _resetApi?: boolean) => Promise<IFBData>;
-    /**
-     * Gets request body structure
-     * @param {IFUFlattenedFilter} uFilter The filter object
-     * @param {IFBLogic[]} filterLogic Additional filter logic to apply in the preview
-     * @param {IFUChartSettings} chartSettings The settings of the chart. For Aggregate Columns.
-     * @returns the request body structure
-     */
-    private static _getPreviewRequestBody;
-    /**
-     * Gets the filter object structure for the searching text
-     * @param {IFUFlattenedFilter} uFilter The filter object
-     * @returns the filter object structure
-     */
-    private static _getSearchLogic;
-    /**
-     * Gets the filters from the chart settings
-     * @param {IFUFlattenedFilter} uFilter The filter object
-     * @param {OLD_IFilterData} searchLogic Additional filter object for the searching text
-     * @param {IFUChartSettings} chartSettings The settings of the chart. For Aggregate Columns.
-     * @returns the filters from the chart settings
-     */
-    private static _getFilterCharts;
-    /**
-     * Gets chart body structure
-     * @param uFilter The filter Builder filter
-     * @param chartSettings The settings of the chart. For Aggregate Columns.
-     * @returns the chart body structure
-     */
-    private static _getChartBody;
-    /**
-     * Gets dimension body structure
-     * @param uFilter The filter Builder filter
-     * @param chartSettings The settings of the chart. For Aggregate Columns.
-     * @returns the dimension body structure
-     */
-    private static _getDimensionsBody;
-    /**
-     * Gets max data point number
-     * @param column The column to filter
-     * @param chartSettings The settings of the chart. For Aggregate Columns.
-     * @returns max data point number
-     */
-    private static _getMaxDataPoints;
-    /**
-     * Gets sort option structure
-     * @param column The column to filter
-     * @returns sort option structure
-     */
-    private static _getSortOption;
-    /**
-     * Gets summaries body structure
-     * @param uFilter The filter Builder filter
-     * @returns summaries body structure
-     */
-    private static _getSummariesBody;
-    /**
-     * Refines the body structure
-     * @param bodies The body structure
-     * @param uFilter The filter Builder filter
-     * @returns the body structure
-     */
-    private static _refineBodies;
-    /**
-     * Gets the validation type for the preview request
-     * @param column The column to filter
-     * @param vaildator Validator Type
-     * @returns the validator type for the preview request
-     */
-    private static _getValidationType;
-    /**
-     * Gets the Data from preview Response
-     * @param response The preview presponse
-     * @param uFilter The filter Builder filter
-     * @returns The resulting data
-     */
-    private _getDataFromResponse;
-    /**
-     * Tranform response in array of object with value key
-     * Null or undefined values are avoided
-     * @param records The data from preview response
-     * @returns the sumaries
-     */
-    private static _getResponse;
-    /**
-     * Gets summaries from preview response
-     * @param records The data from preview response
-     * @param values The values from the preview response
-     * @returns the sumaries
-     */
-    private _getResponseSummaries;
-    private static isResultEmpty;
-}