@qrvey/utils 1.3.0-2 → 1.3.0-20

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

@@ -0,0 +1,9 @@
+import Request from "../helpers/Request";
+import { chooseLang } from "../../format/localization";
+import { ANALYTIQ_ENDPOINT } from "../constants/MODEL_ENDPOINT";
+import { BModelToUIModel } from "../adapters/BModelToUIModel.adapter";
+export function getModel(config, params) {
+    const lang = chooseLang(config);
+    const data = { lang, logic: config.logic || [] };
+    return Request.post(Object.assign(Object.assign({}, config), { endpoint: ANALYTIQ_ENDPOINT }), '', data, Object.assign(Object.assign({}, params), { lang })).then(BModelToUIModel);
+}

package/dist/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/services/api/index.js

@@ -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/services/constants/MODEL_ENDPOINT.d.ts

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

package/dist/services/constants/MODEL_ENDPOINT.js

@@ -0,0 +1,4 @@
+export const ANALYTIQ_ENDPOINT = {
+    uri: '/app/:app_id/qrvey/:qrvey_id/analytiq/model',
+    version: 4
+};

package/dist/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/services/constants/QUESTION_LIST_BULK_ENDPOINT.js

@@ -0,0 +1,4 @@
+export const QUESTION_LIST_BULK_ENDPOINT = {
+    uri: '/app/:app_id/analytiq/chart/question/list/bulk',
+    version: 4
+};

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

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

package/dist/services/constants/UCHART_ENDPOINT.js

@@ -0,0 +1,4 @@
+export const UCHART_ENDPOINT = {
+    uri: '/app/:app_id/qrvey/:qrvey_id/analytiq/uchart',
+    version: 4
+};

package/dist/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/services/constants/UCHART_PAGINATION_ENDPOINT.js

@@ -0,0 +1,4 @@
+export const UCHART_PAGINATION_ENDPOINT = {
+    uri: '/app/:app_id/qrvey/:qrvey_id/analytiq/uchart/results/pagination',
+    version: 4
+};

package/dist/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/services/constants/index.js

@@ -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/services/helpers/getDefaultQuestionListOptionsAttributes.d.ts

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

package/dist/services/helpers/getDefaultQuestionListOptionsAttributes.js

@@ -0,0 +1,24 @@
+export 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
+    ];
+}

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

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

package/dist/services/helpers/index.js

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

package/jest.config.js

@@ -1,4 +1,5 @@
 module.exports = {
+  // preset: 'ts-jest',
   testEnvironment: 'node',
   verbose: true,
 };

package/jsdoc.config.json

@@ -0,0 +1,14 @@
+{
+    "plugins": ["plugins/markdown"],
+    "source": {
+        "include": ["./dist"],
+        "exclude": ["./node_modules", "./src"],
+        "includePattern": "./dist/.+\\.js",
+        "excludePattern": "./dist/cjs/.+\\.js"
+    },
+    "opts": {
+        "package": "./package.json",
+        "readme": "./README.md",
+        "recurse": true
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qrvey/utils",
-  "version": "1.3.0-2",
+  "version": "1.3.0-20",
   "description": "Helper, Utils for all Qrvey Projects",
   "homepage": "https://bitbucket.org/qrvey/qrvey_utils/wiki/Home",
   "main": "dist/index.js",
@@ -11,6 +11,7 @@
     "compodoc:server": "./node_modules/.bin/compodoc -p ./tsconfig.doc.json -s --port=4400",
     "lint": "eslint src --quiet --exit-on-fatal-error --ext .ts,.js",
     "lint-dev": "eslint src --debug --ext .ts,.tsx",
+    "pipeline": "npm run build-clean && npm run lint && npm run test",
     "publishing-old": "node ./scripts/prepare-publish && np",
     "publishing-prerelease-old": "node ./scripts/prepare-publish && np --any-branch --tag=$npm_config_tag",
     "publishing-beta-1": "node ./scripts/publishing --np-new-version=$npm_config_np_new_version --np-any-branch=$npm_config_np_any_branch --np-tag=$npm_config_np_tag",
@@ -21,15 +22,16 @@
   "author": "Qrvey Inc",
   "license": "MIT",
   "devDependencies": {
+    "@compodoc/compodoc": "1.1.19",
+    "@types/jest": "27.5.1",
+    "@typescript-eslint/eslint-plugin": "5.22.0",
+    "@typescript-eslint/parser": "5.22.0",
     "eslint": "8.14.0",
-    "jest": "27.5.1",
+    "jest": "28.1.0",
     "np": "7.6.1",
+    "ts-jest": "28.0.2",
     "typedoc": "0.22.15",
-    "typescript": "4.6.4",
-    "@compodoc/compodoc": "1.1.19",
-    "@types/jest": "27.4.1",
-    "@typescript-eslint/eslint-plugin": "5.22.0",
-    "@typescript-eslint/parser": "5.22.0"
+    "typescript": "4.6.4"
   },
   "dependencies": {
     "d3": "6.3.1",

package/src/charts/constants/index.ts

@@ -1,4 +1,5 @@
 export * from './AGGREGATE_ABBREVIATION';
+export * from './AGGREGATE_GENERAL';
 export * from './AGGREGATE_INFO_LIST';
 export * from './AGGREGATE_INFO';
 export * from './AGGREGATE_LABEL';

package/src/column_format/constants/CHART_GROUP.ts

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

package/src/column_format/constants/DATEGROUP_UNSUPPORT_FORMAT.ts

@@ -0,0 +1,14 @@
+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/src/column_format/constants/DATEGROUP_WITHOUT_FORMAT.ts

@@ -0,0 +1,12 @@
+export 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/src/column_format/constants/SHELF_TYPE.ts

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

package/src/column_format/constants/STRING_FORMAT.ts

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

package/src/column_format/constants/TABLE_TYPE.ts

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

package/src/column_format/constants/index.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/src/column_format/helpers/columnTypeByChart.ts

@@ -0,0 +1,27 @@
+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 { IChartColumn } from "../interfaces/IChartColumn";
+import { IChartGroupType } from "../interfaces/IChartGroupType";
+import { IChartShelfType } from "../interfaces/IChartShelfType";
+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: IChartColumn, shelfType: IChartShelfType, chartGroup: IChartGroupType, isGroupedTable?: boolean) => {
+    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/src/column_format/helpers/defineFormatV2.ts

@@ -0,0 +1,17 @@
+import { IChartColumn } from "../interfaces/IChartColumn";
+import { IColumnFormatReturnType } from "../interfaces/IColumnFormatReturnType";
+import { IColumnFormatSettings } from "../interfaces/IColumnFormatSettings";
+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: IChartColumn, settings: IColumnFormatSettings) : IColumnFormatReturnType => {
+    const { isTableChart, isXYChart } = settings;
+    return isTableChart && !isXYChart ? defineTableChartFormat(column, settings) : defineXYChartFormat(column, settings);
+};

package/src/column_format/helpers/defineTableChartFormat.ts

@@ -0,0 +1,70 @@
+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 { IChartColumn } from "../interfaces/IChartColumn";
+import { IColumnFormatReturnType } from "../interfaces/IColumnFormatReturnType";
+import { IColumnFormatSettings } from "../interfaces/IColumnFormatSettings";
+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: IChartColumn, settings: IColumnFormatSettings) : IColumnFormatReturnType => {
+    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?.label);
+    const hasDefaultFormat = isEmpty(selectedFormat) && 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 { ...defaultFormat, format: defaultText, originalFormat: { ...column.outputFormat } };
+            }
+            else {
+                return selectedFormat;
+            }
+        }
+        case COLUMN.NUMERIC:
+        case COLUMN.RATING:
+        case COLUMN.SLIDEBAR: {
+            if(isUsedAsNumericColumn) {
+                if(aggregate?.label === AGGREGATE.COUNT && hasDefaultFormat) return defaultNumeric;
+                else if(hasDefaultFormat) return defaultAbb;
+                else return outputFormat;
+            } else {
+                if(hasDefaultFormat) {
+                    return { ...defaultFormat, format: defaultText, originalFormat: { ...column.outputFormat } };
+                }
+                else return selectedFormat;
+            }
+        }
+    }
+};

package/src/column_format/helpers/defineXYChartFormat.ts

@@ -0,0 +1,80 @@
+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 { IChartColumn } from "../interfaces/IChartColumn";
+import { IColumnFormatReturnType } from "../interfaces/IColumnFormatReturnType";
+import { IColumnFormatSettings } from "../interfaces/IColumnFormatSettings";
+import { columnTypeByChart } from "./columnTypeByChart";
+
+/**
+ * > 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 const defineXYChartFormat = (column: IChartColumn, settings: IColumnFormatSettings) : IColumnFormatReturnType => {
+    const { aggregate, type, defaultFormat, outputFormat, selectedFormat, dateGroup } = column;
+    const { shelfType, withoutFormat } = settings;
+    const columnDefaultFormat = defaultFormat || outputFormat;
+
+    //Defaults
+    const defaultText = 'Default';
+    //const defaultNumeric = { type: 'NUMERIC', format: 'Numeric' };
+    const defaultAbb = { type: 'NUMERIC', format: 'Abbreviated' };
+
+    const columnType = columnTypeByChart(column, shelfType, CHART_GROUPS.XY);
+
+    const noFormatSupported = DATEGROUP_UNSUPPORT_FORMAT.some(gp => gp === dateGroup?.label);
+    const isUsedAsNumericColumn = type !== columnType;
+    const hasDefaultFormat = isEmpty(selectedFormat) || (outputFormat?.format === defaultText) || (selectedFormat?.format === defaultText);
+
+
+    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 { ...columnDefaultFormat, format: defaultText, originalFormat: { ...outputFormat } };
+            }
+            else {
+                return selectedFormat;
+            }
+        }
+        case COLUMN.NUMERIC:
+        case COLUMN.RATING:
+        case COLUMN.SLIDEBAR: {
+            if(isUsedAsNumericColumn) {
+                if(
+                    (aggregate?.label === AGGREGATE.COUNT && hasDefaultFormat)
+                     || 
+                    (isUsedAsNumericColumn && outputFormat?.type !== COLUMN.NUMERIC)
+                     ||
+                    withoutFormat
+                    ) return defaultAbb;
+                else return outputFormat;
+            } else {
+                if(withoutFormat === true) {
+                    return columnDefaultFormat;
+                }
+                else if(hasDefaultFormat) {
+                    return { ...outputFormat };
+                }
+                else return selectedFormat;
+            }
+        }
+    }
+};

package/src/column_format/helpers/index.ts

@@ -0,0 +1,5 @@
+export * from './columnTypeByChart';
+export * from './defineFormatV2';
+export * from './defineTableChartFormat';
+export * from './defineXYChartFormat';
+export * from './parseFormulaTypeByCharts';

package/src/column_format/helpers/parseFormulaTypeByCharts.ts

@@ -0,0 +1,17 @@
+import { FORMULA, IFormulaType } from "../..";
+
+/**
+ * It takes a string and returns a string
+ * @param {IFormulaType} type - IFormulaType - this is the type of the formula.
+ * @returns The type of the formula.
+ */
+export const parseFormulaTypeByCharts = (type: IFormulaType) => {
+    switch (type) {
+        case FORMULA.NUMBER:
+            return 'NUMERIC';
+        case FORMULA.DATE:
+            return 'DATE';
+        default:
+            return 'TEXT_LABEL';
+    }
+};

package/src/column_format/index.ts

@@ -0,0 +1,3 @@
+export * from './constants/index';
+export * from './helpers/index';
+export * from './interfaces/index';

package/src/column_format/interfaces/IChartColumn.ts

@@ -0,0 +1,24 @@
+import { IColumnSortingSettings, IColumnType, IFormatOutputFormat, IFormulaType } from "../..";
+import { IColumnAggregate } from "../../columns/interfaces/IColumnAggregate";
+import { IColumnDateGroupSettings } from "../../columns/interfaces/IColumnDateGroupSettings";
+import { IColumnScale } from "../../columns/interfaces/IColumnScale";
+import { IFormatDefaultFormat } from "../../interfaces/format/IFormatDefaultFormat";
+
+export interface IChartColumn {
+    aggregate: IColumnAggregate;
+    colIndex: number;
+    dateGroup?: IColumnDateGroupSettings;
+    defaultFormat: IFormatDefaultFormat;
+    format?: string;
+    formulaType?: IFormulaType;
+    groupAgg: string;
+    id: string;
+    isGroup: string;
+    outputFormat: IFormatOutputFormat;
+    property: string;
+    scaleType?: IColumnScale;
+    selectedFormat?: IFormatDefaultFormat;
+    sorting?: IColumnSortingSettings;
+    text: string;
+    type: IColumnType;
+}

package/src/column_format/interfaces/IChartGroupType.ts

@@ -0,0 +1,3 @@
+import { CHART_GROUPS } from "../constants/CHART_GROUP";
+
+export type IChartGroupType = CHART_GROUPS;

package/src/column_format/interfaces/IChartShelfType.ts

@@ -0,0 +1,3 @@
+import { SHELF_TYPE } from "../constants/SHELF_TYPE";
+
+export type IChartShelfType = SHELF_TYPE;

package/src/column_format/interfaces/IChartTableType.ts

@@ -0,0 +1,3 @@
+import { TABLE_TYPE } from "../constants/TABLE_TYPE";
+
+export type IChartTableType = TABLE_TYPE;

package/src/column_format/interfaces/IColumnFormatReturnType.ts

@@ -0,0 +1,4 @@
+import { IFormatOutputFormat } from "../..";
+import { IFormatStringType } from "./IFormatStringType";
+
+export type  IColumnFormatReturnType = IFormatStringType | IFormatOutputFormat;

package/src/column_format/interfaces/IColumnFormatSettings.ts

@@ -0,0 +1,11 @@
+import { IChartShelfType } from "./IChartShelfType";
+import { IChartTableType } from "./IChartTableType";
+
+/* Defining an interface for the column format settings. */
+export interface IColumnFormatSettings {
+    tableType?: IChartTableType;
+    isTableChart?: boolean;
+    isXYChart?: boolean;
+    shelfType: IChartShelfType;
+    withoutFormat: boolean;
+}

package/src/column_format/interfaces/IFormatStringType.ts

@@ -0,0 +1,3 @@
+import { STRING_FORMAT } from "../constants/STRING_FORMAT";
+
+export type IFormatStringType = STRING_FORMAT;

package/src/column_format/interfaces/index.ts

@@ -0,0 +1,7 @@
+export * from './IChartColumn';
+export * from './IChartGroupType';
+export * from './IChartShelfType';
+export * from './IChartTableType';
+export * from './IColumnFormatReturnType';
+export * from './IColumnFormatSettings';
+export * from './IFormatStringType';

package/src/columns/constants/COLUMN_IMAGE_UPLOAD_OPTION.ts

@@ -0,0 +1,5 @@
+export enum COLUMN_IMAGE_UPLOAD_OPTION {
+    NONE = 'None',
+    OBJECT = 'Object',
+    TEXT = 'Text',
+}

package/src/columns/constants/COLUMN_IMAGE_UPLOAD_OPTION_LIST.ts

@@ -0,0 +1,7 @@
+import { COLUMN_IMAGE_UPLOAD_OPTION } from "./COLUMN_IMAGE_UPLOAD_OPTION";
+
+export const COLUMN_IMAGE_UPLOAD_OPTION_LIST = [
+    COLUMN_IMAGE_UPLOAD_OPTION.NONE,
+    COLUMN_IMAGE_UPLOAD_OPTION.OBJECT,
+    COLUMN_IMAGE_UPLOAD_OPTION.TEXT,
+];

package/src/columns/constants/index.ts

@@ -1,7 +1,12 @@
+export * from './COLUMN_IMAGE_UPLOAD_OPTION_LIST';
+export * from './COLUMN_IMAGE_UPLOAD_OPTION';
+
 export * from './COLUMN_INFO_LIST';
 export * from './COLUMN_INFO';
+export * from './COLUMN_LABEL';
 export * from './COLUMN_PROPERTIES';
 export * from './COLUMN_PROPERTY_INFO';
+export * from './COLUMN_PROPERTY_LABEL';
 export * from './COLUMN_PROPERTY';
 export * from './COLUMN';
 export * from './COLUMNS';

package/src/{qrvey → columns}/helpers/getColumnsLabel.ts

@@ -1,6 +1,7 @@
 // import { isEmpty, _get } from "../..";
 // import { isComplexColumn } from "./isComplexColumn";
-import { IColumn } from "../../columns/interfaces/IColumn";
+
+import { IColumn } from "../interfaces/IColumn";
 
 /**
  * Get an string of the properties of the given column.

package/src/columns/helpers/getDatasetColumn.ts

@@ -0,0 +1,15 @@
+import { isEmpty } from "../../general/mix/isEmpty";
+import { IDataset } from "../../qrvey/interfaces/IDataset";
+import { IColumn } from "../interfaces/IColumn";
+
+export function getDatasetColumn(column: Partial<IColumn>, dataset: IDataset): IColumn {
+    if (isEmpty(column) || isEmpty(dataset)) return;
+
+    const columns = getDatasetColumns(dataset);
+    if (isEmpty(column)) return;
+    return columns.find(c => c.id === column.id);
+}
+
+function getDatasetColumns(dataset: IDataset): IColumn[] {
+    return dataset?.options || [];
+}

package/src/columns/helpers/getDatasetColumnByDatasets.ts

@@ -0,0 +1,19 @@
+import { isEmpty } from "../../general/mix/isEmpty";
+import { IDataset } from "../../qrvey/interfaces/IDataset";
+import { IColumn } from "../interfaces/IColumn";
+import { getDatasetColumn } from "./getDatasetColumn";
+
+
+/**
+ * Gets a column from a dataset.
+ * Recieves a partial column object and received a full column object from the Dataset
+ * @param column a partial column object
+ * @param datasets the datasets to look for the colun
+ * @returns the Column object
+ */
+export function getDatasetColumnByDatasets(column: Partial<IColumn>, datasets: IDataset[]): IColumn {
+    if (isEmpty(column) || isEmpty(datasets)) return;
+
+    const dataset = datasets.find(_dataset => _dataset.qrveyid === column.qrveyid);
+    return getDatasetColumn(column, dataset);
+}