@qrvey/utils 1.3.0-4 → 1.3.0-7

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

@@ -1,24 +1,33 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getAllDatasets = void 0;
-const general_1 = require("../../general");
+const getArrayByProperty_1 = require("../../general/array/getArrayByProperty");
+const isEmpty_1 = require("../../general/mix/isEmpty");
 const getAllQrveys_api_1 = require("./getAllQrveys.api");
-const getDatasetColumns_api_1 = require("./getDatasetColumns.api");
+const getDatasetsByIds_api_1 = require("./getDatasetsByIds.api");
 /**
  * Get a dataset list from a collection of Qrvey IDs
- * @param config the widget config. Includes the appid and others configuration properties
- * @param pickDatasets Collection of Qrvey IDs for filtering the request
- * @returns a promise
+ * Considerations for qrveyids second argument:
+ * - If it is a undefined argument, the function will return all available datasets of the app
+ * - If it is a empty array argument, the function will return an empty dataset list. (A request will not be executed)
+ * - If it is a non-empty array argument, the function will return a set of available datasets
+ * @param config the widget config. Includes general configuration properties
+ * @param qrveyids Collection of Qrvey IDs for returning a set of available datasets
+ * @returns a promise that if it is resolved displays a collection of dataset info.
  */
-function getAllDatasets(config, pickDatasets = []) {
-    return (0, getAllQrveys_api_1.getAllQrveys)(Object.assign({}, config), { status: ['RUNNING', 'FINISHED', 'PAUSED'], loadAll: true })
-        .then((qrveys) => {
-        let datasets = qrveys.Items.filter(filterSupportedDatasets);
-        datasets = (0, general_1.isEmpty)(pickDatasets) ? [] : datasets.filter(item => pickDatasets.includes(item.qrveyid));
-        return Promise.all(datasets.map(dataset => (0, getDatasetColumns_api_1.getDatasetColumns)(config, dataset.qrveyid))).then(response => (0, general_1.flattenDeep)(response));
-    }).catch(_e => Promise.all([]));
+function getAllDatasets(config, qrveyids) {
+    if (Array.isArray(qrveyids) && (0, isEmpty_1.isEmpty)(qrveyids)) {
+        return Promise.resolve([]);
+    }
+    else if (Array.isArray(qrveyids) && !(0, isEmpty_1.isEmpty)(qrveyids)) {
+        return (0, getDatasetsByIds_api_1.getDatasetsByIds)(config, qrveyids);
+    }
+    else {
+        return (0, getAllQrveys_api_1.getAllQrveys)(Object.assign({}, config), { status: ['RUNNING', 'FINISHED', 'PAUSED'], loadAll: true })
+            .then((qrveys) => {
+            const datasets = qrveys.Items.filter(item => !['NPS', 'CHECKLIST'].includes(item.appType.toUpperCase()));
+            return (0, getDatasetsByIds_api_1.getDatasetsByIds)(config, (0, getArrayByProperty_1.getArrayByProperty)(datasets, 'qrveyid'));
+        }).catch(_e => []);
+    }
 }
 exports.getAllDatasets = getAllDatasets;
-function filterSupportedDatasets(dataset) {
-    return !['NPS', 'CHECKLIST'].includes(dataset.appType.toUpperCase());
-}

package/dist/cjs/services/api/getAllQrveys.api.d.ts

@@ -1,6 +1,6 @@
 import IPayloadQrveyAll from "../interfaces/IPayloadQrveyAll";
 /**
-  * POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
+  * Request function for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
   * @param config Configuration
   * @param params  Object for getting precise data
   */

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

@@ -7,7 +7,7 @@ exports.getAllQrveys = void 0;
 const QRVEY_ENDPOINT_1 = require("../constants/QRVEY_ENDPOINT");
 const Request_1 = __importDefault(require("../helpers/Request"));
 /**
-  * POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
+  * Request function for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
   * @param config Configuration
   * @param params  Object for getting precise data
   */

package/dist/cjs/services/api/getDatasetColumns.api.d.ts

@@ -1,8 +1,8 @@
-import { IGeneralWidgetConfig } from "../../interfaces/general/IGeneralWidgetConfig";
-import { IDataset } from "../../qrvey/interfaces/IDataset";
+import { IDataset } from '../../qrvey/interfaces/IDataset';
+import { IWidgetConfig } from '../../interfaces/general/IWidgetConfig';
 /**
    * Get a dataset by Qrvey ID
    * @param qrveyid The Qrvey ID
    * @returns a promise
    */
-export declare function getDatasetColumns(config: IGeneralWidgetConfig, qrveyid?: string): Promise<IDataset[]>;
+export declare function getDatasetColumns(config: IWidgetConfig, qrveyid?: string): Promise<IDataset[]>;

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

@@ -7,17 +7,18 @@ exports.getDatasetColumns = void 0;
 const CHART_ENDPOINT_1 = require("../constants/CHART_ENDPOINT");
 const Request_1 = __importDefault(require("../helpers/Request"));
 const BDatasetsToUIDatasets_adapter_1 = require("../adapters/BDatasetsToUIDatasets.adapter");
-const __1 = require("../..");
+const getDefaultQuestionListOptionsAttributes_1 = require("../helpers/getDefaultQuestionListOptionsAttributes");
+const localization_1 = require("../../format/localization");
 /**
    * Get a dataset by Qrvey ID
    * @param qrveyid The Qrvey ID
    * @returns a promise
    */
 function getDatasetColumns(config, qrveyid) {
-    const lang = (0, __1.chooseLang)(config);
+    const lang = (0, localization_1.chooseLang)(config);
     return Request_1.default.post(Object.assign(Object.assign({}, config), { qrveyid, endpoint: CHART_ENDPOINT_1.CHART_ENDPOINT }), '/question/list', {
-        'optionsAttributes': ['id', 'text', 'type', 'property', 'linked', 'linkid', 'qrveyid', 'bucketId', 'formulaId', 'formulaType', 'geogroup', 'outputFormat'],
-        'extend': true
+        optionsAttributes: (0, getDefaultQuestionListOptionsAttributes_1.getDefaultQuestionListOptionsAttributes)(),
+        extend: true,
     }, { lang })
         .then(BDatasetsToUIDatasets_adapter_1.BDatasetsToUIDatasets)
         .catch(_e => []);

package/dist/cjs/services/api/getDatasetsByIds.api.d.ts

@@ -0,0 +1,8 @@
+import { IDataset } from '../../qrvey/interfaces/IDataset';
+import { IWidgetConfig } from '../../interfaces/general/IWidgetConfig';
+/**
+   * Get a dataset by Qrvey ID
+   * @param qrveyid The Qrvey ID
+   * @returns a promise
+   */
+export declare function getDatasetsByIds(config: IWidgetConfig, qrveyids?: string[]): Promise<IDataset[]>;

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

@@ -0,0 +1,30 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDatasetsByIds = void 0;
+const Request_1 = __importDefault(require("../helpers/Request"));
+const BDatasetsToUIDatasets_adapter_1 = require("../adapters/BDatasetsToUIDatasets.adapter");
+const isEmpty_1 = require("../../general/mix/isEmpty");
+const localization_1 = require("../../format/localization");
+const getDefaultQuestionListOptionsAttributes_1 = require("../helpers/getDefaultQuestionListOptionsAttributes");
+const QUESTION_LIST_BULK_ENDPOINT_1 = require("../constants/QUESTION_LIST_BULK_ENDPOINT");
+/**
+   * Get a dataset by Qrvey ID
+   * @param qrveyid The Qrvey ID
+   * @returns a promise
+   */
+function getDatasetsByIds(config, qrveyids = []) {
+    if (Array.isArray(qrveyids) && !(0, isEmpty_1.isEmpty)(qrveyids)) {
+        const lang = (0, localization_1.chooseLang)(config);
+        return Request_1.default.post(Object.assign(Object.assign({}, config), { endpoint: QUESTION_LIST_BULK_ENDPOINT_1.QUESTION_LIST_BULK_ENDPOINT }), '', {
+            optionsAttributes: (0, getDefaultQuestionListOptionsAttributes_1.getDefaultQuestionListOptionsAttributes)(),
+            qrveyids
+        }, { lang })
+            .then(response => (0, BDatasetsToUIDatasets_adapter_1.BDatasetsToUIDatasets)((response === null || response === void 0 ? void 0 : response.data) || []))
+            .catch(_e => []);
+    }
+    return Promise.resolve([]);
+}
+exports.getDatasetsByIds = getDatasetsByIds;

package/dist/cjs/services/api/getModel.api.d.ts

@@ -0,0 +1 @@
+export declare function getModel(config: any, params?: any): Promise<import("../..").IModel>;

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

@@ -0,0 +1,16 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getModel = void 0;
+const Request_1 = __importDefault(require("../helpers/Request"));
+const localization_1 = require("../../format/localization");
+const MODEL_ENDPOINT_1 = require("../constants/MODEL_ENDPOINT");
+const BModelToUIModel_adapter_1 = require("../adapters/BModelToUIModel.adapter");
+function getModel(config, params) {
+    const lang = (0, localization_1.chooseLang)(config);
+    const data = { lang, logic: config.logic || [] };
+    return Request_1.default.post(Object.assign(Object.assign({}, config), { endpoint: MODEL_ENDPOINT_1.ANALYTIQ_ENDPOINT }), '', data, Object.assign(Object.assign({}, params), { lang })).then(BModelToUIModel_adapter_1.BModelToUIModel);
+}
+exports.getModel = getModel;

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

@@ -1,3 +1,5 @@
 export * from './getAllDatasets.api';
 export * from './getAllQrveys.api';
 export * from './getDatasetColumns.api';
+export * from './getDatasetsByIds.api';
+export * from './getModel.api';

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

@@ -17,3 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./getAllDatasets.api"), exports);
 __exportStar(require("./getAllQrveys.api"), exports);
 __exportStar(require("./getDatasetColumns.api"), exports);
+__exportStar(require("./getDatasetsByIds.api"), exports);
+__exportStar(require("./getModel.api"), exports);

package/dist/cjs/services/constants/MODEL_ENDPOINT.d.ts

@@ -0,0 +1,2 @@
+import { IEndpointConfig } from "../interfaces/IEndpointConfig";
+export declare const ANALYTIQ_ENDPOINT: IEndpointConfig;

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

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ANALYTIQ_ENDPOINT = void 0;
+exports.ANALYTIQ_ENDPOINT = {
+    uri: '/app/:app_id/qrvey/:qrvey_id/analytiq/model',
+    version: 4
+};

package/dist/cjs/services/constants/QUESTION_LIST_BULK_ENDPOINT.d.ts

@@ -0,0 +1,2 @@
+import { IEndpointConfig } from "../interfaces/IEndpointConfig";
+export declare const QUESTION_LIST_BULK_ENDPOINT: IEndpointConfig;

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

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QUESTION_LIST_BULK_ENDPOINT = void 0;
+exports.QUESTION_LIST_BULK_ENDPOINT = {
+    uri: '/app/:app_id/analytiq/chart/question/list/bulk',
+    version: 4
+};

package/dist/cjs/services/constants/UCHART_ENDPOINT.d.ts

@@ -0,0 +1,2 @@
+import { IEndpointConfig } from "../interfaces/IEndpointConfig";
+export declare const UCHART_ENDPOINT: IEndpointConfig;

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

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UCHART_ENDPOINT = void 0;
+exports.UCHART_ENDPOINT = {
+    uri: '/app/:app_id/qrvey/:qrvey_id/analytiq/uchart',
+    version: 4
+};

package/dist/cjs/services/constants/UCHART_PAGINATION_ENDPOINT.d.ts

@@ -0,0 +1,2 @@
+import { IEndpointConfig } from "../interfaces/IEndpointConfig";
+export declare const UCHART_PAGINATION_ENDPOINT: IEndpointConfig;

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

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UCHART_PAGINATION_ENDPOINT = void 0;
+exports.UCHART_PAGINATION_ENDPOINT = {
+    uri: '/app/:app_id/qrvey/:qrvey_id/analytiq/uchart/results/pagination',
+    version: 4
+};

package/dist/cjs/services/constants/index.d.ts

@@ -1,2 +1,6 @@
 export * from './CHART_ENDPOINT';
+export * from './MODEL_ENDPOINT';
 export * from './QRVEY_ENDPOINT';
+export * from './QUESTION_LIST_BULK_ENDPOINT';
+export * from './UCHART_ENDPOINT';
+export * from './UCHART_PAGINATION_ENDPOINT';

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

@@ -15,4 +15,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./CHART_ENDPOINT"), exports);
+__exportStar(require("./MODEL_ENDPOINT"), exports);
 __exportStar(require("./QRVEY_ENDPOINT"), exports);
+__exportStar(require("./QUESTION_LIST_BULK_ENDPOINT"), exports);
+__exportStar(require("./UCHART_ENDPOINT"), exports);
+__exportStar(require("./UCHART_PAGINATION_ENDPOINT"), exports);

package/dist/cjs/services/helpers/getDefaultQuestionListOptionsAttributes.d.ts

@@ -0,0 +1 @@
+export declare function getDefaultQuestionListOptionsAttributes(): string[];

package/dist/cjs/services/helpers/getDefaultQuestionListOptionsAttributes.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDefaultQuestionListOptionsAttributes = void 0;
+function getDefaultQuestionListOptionsAttributes() {
+    return [
+        'id',
+        'text',
+        'type',
+        'property',
+        'linked',
+        'linkid',
+        'qrveyid',
+        'bucketId',
+        'formulaId',
+        'formulaType',
+        'geogroup',
+        'outputFormat',
+        'answers',
+        'imageUploadOption',
+        'sliderVal',
+        'value',
+        'activeCat',
+        'words',
+        'negative',
+        'positive' // For Expressions with enabled categories
+    ];
+}
+exports.getDefaultQuestionListOptionsAttributes = getDefaultQuestionListOptionsAttributes;

package/dist/cjs/services/helpers/index.d.ts

@@ -1 +1,2 @@
+export * from './getDefaultQuestionListOptionsAttributes';
 export * from './Request';

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

@@ -14,4 +14,5 @@ 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("./getDefaultQuestionListOptionsAttributes"), exports);
 __exportStar(require("./Request"), exports);

package/dist/column_format/constants/CHART_GROUP.d.ts

@@ -0,0 +1,4 @@
+export declare enum CHART_GROUPS {
+    TABLES = "tables",
+    XY = "xy"
+}

package/dist/column_format/constants/CHART_GROUP.js

@@ -0,0 +1,5 @@
+export var CHART_GROUPS;
+(function (CHART_GROUPS) {
+    CHART_GROUPS["TABLES"] = "tables";
+    CHART_GROUPS["XY"] = "xy";
+})(CHART_GROUPS || (CHART_GROUPS = {}));

package/dist/column_format/constants/DATEGROUP_UNSUPPORT_FORMAT.d.ts

@@ -0,0 +1,2 @@
+import { DATEGROUP_WITHOUT_FORMAT } from "./DATEGROUP_WITHOUT_FORMAT";
+export declare const DATEGROUP_UNSUPPORT_FORMAT: DATEGROUP_WITHOUT_FORMAT[];

package/dist/column_format/constants/DATEGROUP_UNSUPPORT_FORMAT.js

@@ -0,0 +1,13 @@
+import { DATEGROUP_WITHOUT_FORMAT } from "./DATEGROUP_WITHOUT_FORMAT";
+export const DATEGROUP_UNSUPPORT_FORMAT = [
+    DATEGROUP_WITHOUT_FORMAT.YEAR,
+    DATEGROUP_WITHOUT_FORMAT.QUARTER,
+    DATEGROUP_WITHOUT_FORMAT.MONTH,
+    DATEGROUP_WITHOUT_FORMAT.WEEK,
+    DATEGROUP_WITHOUT_FORMAT.QUARTER_ONLY,
+    DATEGROUP_WITHOUT_FORMAT.MONTH_ONLY,
+    DATEGROUP_WITHOUT_FORMAT.DAY_ONLY,
+    DATEGROUP_WITHOUT_FORMAT.HOUR_ONLY,
+    DATEGROUP_WITHOUT_FORMAT.MINUTE_ONLY,
+    DATEGROUP_WITHOUT_FORMAT.SECOND_ONLY
+];

package/dist/column_format/constants/DATEGROUP_WITHOUT_FORMAT.d.ts

@@ -0,0 +1,12 @@
+export declare enum DATEGROUP_WITHOUT_FORMAT {
+    YEAR = "YEAR",
+    QUARTER = "QUARTER",
+    MONTH = "MONTH",
+    WEEK = "WEEK",
+    QUARTER_ONLY = "QUARTER_ONLY",
+    MONTH_ONLY = "MONTH_ONLY",
+    DAY_ONLY = "DAY_ONLY",
+    HOUR_ONLY = "HOUR_ONLY",
+    MINUTE_ONLY = "MINUTE_ONLY",
+    SECOND_ONLY = "SECOND_ONLY"
+}

package/dist/column_format/constants/DATEGROUP_WITHOUT_FORMAT.js

@@ -0,0 +1,13 @@
+export var DATEGROUP_WITHOUT_FORMAT;
+(function (DATEGROUP_WITHOUT_FORMAT) {
+    DATEGROUP_WITHOUT_FORMAT["YEAR"] = "YEAR";
+    DATEGROUP_WITHOUT_FORMAT["QUARTER"] = "QUARTER";
+    DATEGROUP_WITHOUT_FORMAT["MONTH"] = "MONTH";
+    DATEGROUP_WITHOUT_FORMAT["WEEK"] = "WEEK";
+    DATEGROUP_WITHOUT_FORMAT["QUARTER_ONLY"] = "QUARTER_ONLY";
+    DATEGROUP_WITHOUT_FORMAT["MONTH_ONLY"] = "MONTH_ONLY";
+    DATEGROUP_WITHOUT_FORMAT["DAY_ONLY"] = "DAY_ONLY";
+    DATEGROUP_WITHOUT_FORMAT["HOUR_ONLY"] = "HOUR_ONLY";
+    DATEGROUP_WITHOUT_FORMAT["MINUTE_ONLY"] = "MINUTE_ONLY";
+    DATEGROUP_WITHOUT_FORMAT["SECOND_ONLY"] = "SECOND_ONLY";
+})(DATEGROUP_WITHOUT_FORMAT || (DATEGROUP_WITHOUT_FORMAT = {}));

package/dist/column_format/constants/SHELF_TYPE.d.ts

@@ -0,0 +1,7 @@
+export declare enum SHELF_TYPE {
+    CATEGORY = "category",
+    VALUE = "value",
+    GROUPS = "groups",
+    COLUMNS = "columns",
+    SERIES = "series"
+}

package/dist/column_format/constants/SHELF_TYPE.js

@@ -0,0 +1,8 @@
+export var SHELF_TYPE;
+(function (SHELF_TYPE) {
+    SHELF_TYPE["CATEGORY"] = "category";
+    SHELF_TYPE["VALUE"] = "value";
+    SHELF_TYPE["GROUPS"] = "groups";
+    SHELF_TYPE["COLUMNS"] = "columns";
+    SHELF_TYPE["SERIES"] = "series";
+})(SHELF_TYPE || (SHELF_TYPE = {}));

package/dist/column_format/constants/STRING_FORMAT.d.ts

@@ -0,0 +1,3 @@
+export declare enum STRING_FORMAT {
+    NONE = "none"
+}

package/dist/column_format/constants/STRING_FORMAT.js

@@ -0,0 +1,4 @@
+export var STRING_FORMAT;
+(function (STRING_FORMAT) {
+    STRING_FORMAT["NONE"] = "none";
+})(STRING_FORMAT || (STRING_FORMAT = {}));

package/dist/column_format/constants/TABLE_TYPE.d.ts

@@ -0,0 +1,5 @@
+export declare enum TABLE_TYPE {
+    SIMPLE = "simple",
+    GROUPED = "grouped",
+    EXPANDABLE = "expandable"
+}

package/dist/column_format/constants/TABLE_TYPE.js

@@ -0,0 +1,6 @@
+export var TABLE_TYPE;
+(function (TABLE_TYPE) {
+    TABLE_TYPE["SIMPLE"] = "simple";
+    TABLE_TYPE["GROUPED"] = "grouped";
+    TABLE_TYPE["EXPANDABLE"] = "expandable";
+})(TABLE_TYPE || (TABLE_TYPE = {}));

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

@@ -0,0 +1,6 @@
+export * from './CHART_GROUP';
+export * from './DATEGROUP_UNSUPPORT_FORMAT';
+export * from './DATEGROUP_WITHOUT_FORMAT';
+export * from './SHELF_TYPE';
+export * from './STRING_FORMAT';
+export * from './TABLE_TYPE';

package/dist/column_format/constants/index.js

@@ -0,0 +1,6 @@
+export * from './CHART_GROUP';
+export * from './DATEGROUP_UNSUPPORT_FORMAT';
+export * from './DATEGROUP_WITHOUT_FORMAT';
+export * from './SHELF_TYPE';
+export * from './STRING_FORMAT';
+export * from './TABLE_TYPE';

package/dist/column_format/helpers/columnTypeByChart.d.ts

@@ -0,0 +1,16 @@
+import { NUMERICAL_COLUMN } from "../..";
+import { COLUMN } from "../../columns";
+import { IChartColumn } from "../interfaces/IChartColumn";
+import { IChartGroupType } from "../interfaces/IChartGroupType";
+import { IChartShelfType } from "../interfaces/IChartShelfType";
+/**
+ * It returns the column type for a given column, shelf type, chart group, and whether the table is
+ * grouped or not
+ * @param {IChartColumn} column - IChartColumn
+ * @param {IChartShelfType} shelfType - IChartShelfType
+ * @param {IChartGroupType} chartGroup - IChartGroupType
+ * @param {boolean} [isGroupedTable] - boolean - this is a boolean that is true if the table is
+ * grouped.
+ * @returns The column type of the column.
+ */
+export declare const columnTypeByChart: (column: IChartColumn, shelfType: IChartShelfType, chartGroup: IChartGroupType, isGroupedTable?: boolean) => import("../..").COMPLEX_COLUMN | import("../..").COMPOUND_COLUMN | NUMERICAL_COLUMN | COLUMN.SINGLE_CHOICE | COLUMN.MULTIPLE_CHOICE | COLUMN.YES_NO | COLUMN.RANKING | COLUMN.DATE | COLUMN.SIGNATURE | COLUMN.DROPDOWN | COLUMN.IMAGE | COLUMN.EMAIL_FORM | COLUMN.PHONE | COLUMN.PASSWORD | COLUMN.CHECKLIST | COLUMN.NPS_SCORE | COLUMN.NPS_FEEDBACK | COLUMN.TEXT_LABEL | COLUMN.TEXT_CATEGORY | COLUMN.LOOKUP | COLUMN.HEADLINE | COLUMN.SECTION | COLUMN.AGGREGATED_FORMULA | COLUMN.BUCKET | COLUMN.SLIDEBAR | COLUMN.NUMERIC | COLUMN.NUMERICC | COLUMN.NUMERICP | COLUMN.NUMERICG | COLUMN.RATING | COLUMN.TEXTFIELD | COLUMN.LONGTEXT | COLUMN.IMAGEUPLOAD | COLUMN.FILEUPLOAD | COLUMN.EXPRESSION | COLUMN.NAME | COLUMN.USADDRESS | COLUMN.ADDRESS | "DATE" | "NUMERIC" | "TEXT_LABEL";

package/dist/column_format/helpers/columnTypeByChart.js

@@ -0,0 +1,24 @@
+import { NUMERICAL_COLUMN, NUMERICAL_COLUMNS } from "../..";
+import { COLUMN } from "../../columns";
+import { CHART_GROUPS } from "../constants/CHART_GROUP";
+import { SHELF_TYPE } from "../constants/SHELF_TYPE";
+import { parseFormulaTypeByCharts } from "./parseFormulaTypeByCharts";
+/**
+ * It returns the column type for a given column, shelf type, chart group, and whether the table is
+ * grouped or not
+ * @param {IChartColumn} column - IChartColumn
+ * @param {IChartShelfType} shelfType - IChartShelfType
+ * @param {IChartGroupType} chartGroup - IChartGroupType
+ * @param {boolean} [isGroupedTable] - boolean - this is a boolean that is true if the table is
+ * grouped.
+ * @returns The column type of the column.
+ */
+export const columnTypeByChart = (column, shelfType, chartGroup, isGroupedTable) => {
+    if (!column)
+        return;
+    const currentType = column.type === COLUMN.FORMULA ? parseFormulaTypeByCharts(column.formulaType) : column.type;
+    const isNumericalColumn = NUMERICAL_COLUMNS.some(colType => colType === currentType)
+        || ((chartGroup === CHART_GROUPS.TABLES) && (isGroupedTable === true) && (shelfType === SHELF_TYPE.COLUMNS))
+        || ((chartGroup === CHART_GROUPS.XY) && (shelfType === SHELF_TYPE.VALUE || shelfType === SHELF_TYPE.SERIES));
+    return isNumericalColumn === true ? NUMERICAL_COLUMN.NUMERIC : currentType;
+};

package/dist/column_format/helpers/defineFormatV2.d.ts

@@ -0,0 +1,11 @@
+import { IChartColumn } from "../interfaces/IChartColumn";
+import { IColumnFormatReturnType } from "../interfaces/IColumnFormatReturnType";
+import { IColumnFormatSettings } from "../interfaces/IColumnFormatSettings";
+/**
+ * > If the chart is a table chart, then define the format for a table chart, otherwise define the
+ * format for an XY chart
+ * @param {IChartColumn} column - IChartColumn - this is the column object that is passed to the chart.
+ * @param {IColumnFormatSettings} settings - IColumnFormatSettings
+ * @returns IColumnFormatReturnType
+ */
+export declare const defineFormatV2: (column: IChartColumn, settings: IColumnFormatSettings) => IColumnFormatReturnType;

package/dist/column_format/helpers/defineFormatV2.js

@@ -0,0 +1,13 @@
+import { defineTableChartFormat } from "./defineTableChartFormat";
+import { defineXYChartFormat } from "./defineXYChartFormat";
+/**
+ * > If the chart is a table chart, then define the format for a table chart, otherwise define the
+ * format for an XY chart
+ * @param {IChartColumn} column - IChartColumn - this is the column object that is passed to the chart.
+ * @param {IColumnFormatSettings} settings - IColumnFormatSettings
+ * @returns IColumnFormatReturnType
+ */
+export const defineFormatV2 = (column, settings) => {
+    const { isTableChart, isXYChart } = settings;
+    return isTableChart && !isXYChart ? defineTableChartFormat(column, settings) : defineXYChartFormat(column, settings);
+};

package/dist/column_format/helpers/defineTableChartFormat.d.ts

@@ -0,0 +1,9 @@
+import { IChartColumn } from "../interfaces/IChartColumn";
+import { IColumnFormatReturnType } from "../interfaces/IColumnFormatReturnType";
+import { IColumnFormatSettings } from "../interfaces/IColumnFormatSettings";
+/**
+ * It returns the format of a column based on the column type, the chart type, and the chart settings
+ * @param {IChartColumn} column - IChartColumn
+ * @param {IColumnFormatSettings} settings - IColumnFormatSettings
+ */
+export declare const defineTableChartFormat: (column: IChartColumn, settings: IColumnFormatSettings) => IColumnFormatReturnType;

package/dist/column_format/helpers/defineTableChartFormat.js

@@ -0,0 +1,67 @@
+import { AGGREGATE, COLUMN, isEmpty } from "../..";
+import { CHART_GROUPS } from "../constants/CHART_GROUP";
+import { DATEGROUP_UNSUPPORT_FORMAT } from "../constants/DATEGROUP_UNSUPPORT_FORMAT";
+import { STRING_FORMAT } from "../constants/STRING_FORMAT";
+import { TABLE_TYPE } from "../constants/TABLE_TYPE";
+import { columnTypeByChart } from "./columnTypeByChart";
+/**
+ * It returns the format of a column based on the column type, the chart type, and the chart settings
+ * @param {IChartColumn} column - IChartColumn
+ * @param {IColumnFormatSettings} settings - IColumnFormatSettings
+ */
+export const defineTableChartFormat = (column, settings) => {
+    const { aggregate, type, defaultFormat, outputFormat, selectedFormat, dateGroup } = column;
+    const { tableType, shelfType } = settings;
+    //Defaults
+    const defaultText = 'Default';
+    const defaultNumeric = { type: 'NUMERIC', format: 'Numeric' };
+    const defaultAbb = { type: 'NUMERIC', format: 'Abbreviated' };
+    const isGroupedTable = tableType === TABLE_TYPE.GROUPED;
+    const columnType = columnTypeByChart(column, shelfType, CHART_GROUPS.TABLES, isGroupedTable);
+    const noFormatSupported = DATEGROUP_UNSUPPORT_FORMAT.some(gp => gp === (dateGroup === null || dateGroup === void 0 ? void 0 : dateGroup.label));
+    const hasDefaultFormat = isEmpty(selectedFormat) && (outputFormat === null || outputFormat === void 0 ? void 0 : outputFormat.format) === defaultText;
+    const isUsedAsNumericColumn = type !== columnType;
+    switch (columnType) {
+        case COLUMN.YES_NO:
+        case COLUMN.PHONE:
+        case COLUMN.SINGLE_CHOICE:
+        case COLUMN.LONGTEXT:
+        case COLUMN.DROPDOWN:
+        case COLUMN.EXPRESSION:
+        case COLUMN.NAME:
+        case COLUMN.EMAIL_FORM:
+        case COLUMN.IMAGE:
+        case COLUMN.TEXT_LABEL:
+            return STRING_FORMAT.NONE;
+        case COLUMN.DATE: {
+            if (noFormatSupported) {
+                return STRING_FORMAT.NONE;
+            }
+            else if (hasDefaultFormat) {
+                return Object.assign(Object.assign({}, defaultFormat), { format: defaultText, originalFormat: Object.assign({}, column.outputFormat) });
+            }
+            else {
+                return selectedFormat;
+            }
+        }
+        case COLUMN.NUMERIC:
+        case COLUMN.RATING:
+        case COLUMN.SLIDEBAR: {
+            if (isUsedAsNumericColumn) {
+                if ((aggregate === null || aggregate === void 0 ? void 0 : aggregate.label) === AGGREGATE.COUNT && hasDefaultFormat)
+                    return defaultNumeric;
+                else if (hasDefaultFormat)
+                    return defaultAbb;
+                else
+                    return outputFormat;
+            }
+            else {
+                if (hasDefaultFormat) {
+                    return Object.assign(Object.assign({}, defaultFormat), { format: defaultText, originalFormat: Object.assign({}, column.outputFormat) });
+                }
+                else
+                    return selectedFormat;
+            }
+        }
+    }
+};

package/dist/column_format/helpers/defineXYChartFormat.d.ts

@@ -0,0 +1,11 @@
+import { IChartColumn } from "../interfaces/IChartColumn";
+import { IColumnFormatReturnType } from "../interfaces/IColumnFormatReturnType";
+import { IColumnFormatSettings } from "../interfaces/IColumnFormatSettings";
+/**
+ * > It returns the format of a column based on the column's type, the chart's type, and the column's
+ * aggregate
+ * > Also, if the settings contains the prop withoutFormat as true, returns the default format
+ * @param {IChartColumn} column - IChartColumn
+ * @param {IColumnFormatSettings} settings - IColumnFormatSettings
+ */
+export declare const defineXYChartFormat: (column: IChartColumn, settings: IColumnFormatSettings) => IColumnFormatReturnType;