@qrvey/utils 1.3.0-9 → 1.3.2

package/src/qrvey/interfaces/IDataset.ts

@@ -4,7 +4,7 @@ import { IBDataset } from "./IBDataset";
 /**
  * Structure for Dataset in the frontend side of Qrvey App
  */
-export interface IDataset extends Omit<IBDataset, "name" | "options">{
+export interface IDataset extends Omit<IBDataset, "name" | "options"> {
     label?: string;
     options?: IColumn[];
 }

package/src/qrvey/interfaces/IFunctionGetDataAnswersByColumn.ts

@@ -0,0 +1,12 @@
+import { IColumn } from "../../columns/interfaces/IColumn";
+import { IColumnPropertyType } from "../../columns/interfaces/IColumnPropertyType";
+import { IDataset } from "./IDataset";
+import { IModel } from "./IModel";
+
+export interface IFunctionGetDataAnswersByColumn {
+    column: IColumn;
+    dataset?: IDataset;
+    model?: IModel;
+    property?: IColumnPropertyType;
+    lookupDisplay?: number;
+}

package/src/qrvey/interfaces/{IGetValueWithSuffixesSettings.ts → IFunctionGetValueWithSuffixes.ts}

@@ -1,12 +1,12 @@
 import { II18nServiceTranslate } from "../../globalization/interfaces/II18nServiceTranslate";
 
-export interface IGetValueWithSuffixesSettings {
+export interface IFunctionGetValueWithSuffixes {
     translate?: II18nServiceTranslate; // Function for getting translations
     suffixTranslateLabel?: string; // Label of the i18n path for translations
-    suffixes?: IGetValueWithSuffixesSettingsSuffixes; // Manual suffixes to add if the translate and the suffixes translate label is not present
+    suffixes?: IFunctionGetValueWithSuffixesSuffixes; // Manual suffixes to add if the translate and the suffixes translate label is not present
 }
 
-interface IGetValueWithSuffixesSettingsSuffixes {
+interface IFunctionGetValueWithSuffixesSuffixes {
     singular: string;
     plural: string;
 }

package/src/qrvey/interfaces/IModel.ts

@@ -0,0 +1,11 @@
+import { IColumn } from "../../columns/interfaces/IColumn";
+import { IBModel } from "./IBModel";
+import { IModelBranchesMap } from "./IModelBranchesMap";
+
+export interface IModel extends Omit<IBModel, 'questions' | 'branchesMap' | 'name' | 'numResponses' | 'questionOrder'> {
+    columns: IColumn[]; // Alias for questions
+    columnOrder: string[];
+    branchesMap: IModelBranchesMap[];
+    label: string; // Alias for name
+    totalRecords: number;
+}

package/src/qrvey/interfaces/IModelAnswer.ts

@@ -0,0 +1,5 @@
+export interface IModelAnswer {
+    answer?: string;
+    answerid?: string;
+    answerUrl?: string;
+}

package/src/qrvey/interfaces/IModelBranchesMap.ts

@@ -0,0 +1,6 @@
+import { IBModelBranchesMap } from "./IBModelBranchesMap";
+import { IModelBranchesMapBranch } from "./IModelBranchesMapBranch";
+
+export interface IModelBranchesMap extends Omit<IBModelBranchesMap, 'branches'> {
+    branches: IModelBranchesMapBranch[];
+}

package/src/qrvey/interfaces/IModelBranchesMapBranch.ts

@@ -0,0 +1,5 @@
+import { IColumn } from "../../columns/interfaces/IColumn";
+
+export interface IModelBranchesMapBranch {
+    columns: IColumn[];
+}

package/src/qrvey/interfaces/IModelColumn.ts

@@ -0,0 +1,25 @@
+import { IColumnOutputFormatSettings } from "../../columns/interfaces/IColumnOutputFormatSettings";
+import { IColumnType } from "../../columns/interfaces/IColumnType";
+import { IModelDataset } from "./IModelDataset";
+
+export interface IModelColumn {
+    id: string;
+    qid: string;
+    text: string;
+    name: string;
+    typeLabel?: string;
+    type: IColumnType;
+    answers?: any[];
+    archived?: boolean;
+    linked?: string;
+    bucketType?: string;
+    formulaType?: string;
+    property?: string;
+    calculation?: any;
+    dataset?: IModelDataset;
+    label?: string;
+    outputFormat?: IColumnOutputFormatSettings;
+
+    activeCat?: boolean;
+    words?: any[];
+}

package/src/qrvey/interfaces/IModelDataset.ts

@@ -0,0 +1,7 @@
+export interface IModelDataset {
+    sourceid: string;
+    qrveyid: string;
+    name: string;
+    text: string;
+    linkid: string;
+}

package/src/qrvey/interfaces/index.ts

@@ -1,7 +1,25 @@
+export * from './IAppStatus';
+export * from './IAppType';
+
 export * from './IBDataset';
+
+export * from './IBModel';
+export * from './IBModelBranchesMapBranch';
+export * from './IBModelData';
+
 export * from './ICalculation';
 export * from './ICalculationInfo';
 export * from './ICalculationType';
+
 export * from './IDataset';
-export * from './IGetValueWithSuffixesSettings';
+
+export * from './IFunctionGetDataAnswersByColumn';
+export * from './IFunctionGetValueWithSuffixes';
+
+export * from './IModel';
+export * from './IModelAnswer';
+export * from './IBModelBranchesMap';
+export * from './IModelColumn';
+export * from './IModelDataset';
+
 export * from './ITransformValueSettings';

package/src/services/adapters/BBranchesMapToUIBranchesMap.adapter.ts

@@ -0,0 +1,20 @@
+import { isEmpty } from "../../general/mix/isEmpty";
+import { IBModelBranchesMap } from "../../qrvey/interfaces/IBModelBranchesMap";
+import { IModelBranchesMap } from "../../qrvey/interfaces/IModelBranchesMap";
+import { BColumnsToUIColumns } from "./BColumnsToUIColumns.adapter";
+
+/**
+ * Adapts the branches map from backend to the UI branches map
+ * @param branchesMap the backend branches map
+ * @returns The Branches map array
+ */
+export function BBranchesMapToUIBranchesMap(branchesMap: IBModelBranchesMap[]): IModelBranchesMap[] {
+    if (isEmpty(branchesMap)) return [];
+  
+    return branchesMap.map(branchMap => ({
+      questionid: branchMap.questionid,
+      branches: branchMap.branches.map(branch => ({
+        columns: BColumnsToUIColumns(branch.questions.data)
+      }))
+    }));
+}

package/src/services/adapters/BColumnsToUIColumns.adapter.ts

@@ -1,20 +1,29 @@
 import { IBColumn } from "../../columns/interfaces/IBColumn";
 import { IColumn } from "../../columns/interfaces/IColumn";
+import { getAttribute } from "../../general/object/getAttribute";
 import { IBDataset } from "../../qrvey/interfaces/IBDataset";
 
 export function BColumnsToUIColumns(columns: IBColumn[] = [], dataset?: IBDataset): IColumn[] {
-    return columns.map(column => ({
-      bucketid: column.bucketId,
-      formulaid: column.formulaId,
+    return columns.map<IColumn>(column => ({
+      answers: column.answers,
+      bucketid: getAttribute(column, 'bucket_id'),
+      expressionCategory: column.activeCat,
+      expressionNegative: column.negative,
+      expressionPositive: column.positive,
+      expressionWords: column.words,
+      formulaid: getAttribute(column, 'formula_id'),
       formulaType: column.formulaType,
       geogroup: column.geogroup,
       id: column.id,
+      imageUploadOption: column.imageUploadOption,
       label: column.text,
       linked: column.linked,
-      linkid: dataset?.linkid || column.linkid,
+      linkid: getAttribute(dataset, 'link_id') || getAttribute(column, 'link_id'),
       outputFormat: column.outputFormat,
       property: column.property,
-      qrveyid: dataset?.qrveyid || column.qrveyid,
+      qrveyid: getAttribute(dataset, 'qrvey_id') || getAttribute(column, 'qrvey_id'),
+      slidebarValue: column.sliderVal,
+      lookupValue: column.value,
       type: column.type,
     }));
 }

package/src/services/adapters/BDatasetsToUIDatasets.adapter.ts

@@ -1,12 +1,13 @@
+import { getAttribute } from "../../general/object/getAttribute";
 import { IBDataset } from "../../qrvey/interfaces/IBDataset";
 import { IDataset } from "../../qrvey/interfaces/IDataset";
 import { BColumnsToUIColumns } from "./BColumnsToUIColumns.adapter";
 
 export function BDatasetsToUIDatasets(datasets: IBDataset[] = []): IDataset[] {
     return datasets.map(dataset => ({
-      qrveyid: dataset.qrveyid,
-      label: dataset.name,
-      linkid: dataset.linkid,
-      options: BColumnsToUIColumns(dataset.options, dataset),
+        qrveyid: getAttribute(dataset, 'qrvey_id'),
+        label: dataset.name,
+        linkid: getAttribute(dataset, 'link_id'),
+        options: BColumnsToUIColumns(dataset.options, dataset),
     }));
 }

package/src/services/adapters/BModelToUIModel.adapter.ts

@@ -0,0 +1,25 @@
+import { isEmpty } from "../../general/mix/isEmpty";
+import { IBModel } from "../../qrvey/interfaces/IBModel";
+import { IModel } from "../../qrvey/interfaces/IModel";
+import { BBranchesMapToUIBranchesMap } from "./BBranchesMapToUIBranchesMap.adapter";
+import { BColumnsToUIColumns } from "./BColumnsToUIColumns.adapter";
+
+export function BModelToUIModel(model: IBModel): IModel {
+    if (isEmpty(model)) return;
+  
+    return {
+      appType: model.appType,
+      appid: model.appid,
+      branchesMap: BBranchesMapToUIBranchesMap(model.branchesMap),
+      columnOrder: model.questionOrder,
+      columns: BColumnsToUIColumns(model.questions.data, { qrveyid: model.qrveyid }),
+      createDate: model.createDate,
+      datalinkInfo: model.datalinkInfo,
+      modifyDate: model.modifyDate,
+      label: model.name,
+      totalRecords: model.numResponses,
+      qrveyid: model.qrveyid,
+      status: model.status,
+      userid: model.userid,
+    };
+}

package/src/services/adapters/index.ts

@@ -1,2 +1,3 @@
+export * from './BBranchesMapToUIBranchesMap.adapter';
 export * from './BDatasetsToUIDatasets.adapter';
 export * from './BColumnsToUIColumns.adapter';

package/src/services/api/Charts.api.ts

@@ -0,0 +1,44 @@
+import Request from "../helpers/Request";
+import { CHART_ENDPOINT } from "../constants/CHART_ENDPOINT";
+import { UCHART_ENDPOINT } from "../constants/UCHART_ENDPOINT";
+import { UCHART_PAGINATION_ENDPOINT } from "../constants/UCHART_PAGINATION_ENDPOINT";
+
+export interface IFieldsConfig {
+  type: string;
+  column?;
+  qrvey_id?: string;
+  showBuckets?: boolean;
+  showLinkedDatasets?: boolean;
+}
+
+export default class ChartsApi {
+  abortCtrl: AbortController;
+
+  constructor(public config) {
+    this.config = { ...config, endpoint: CHART_ENDPOINT };
+  }
+
+  createSignal() {
+    this.abortCtrl && this.abortCtrl.abort();
+    this.abortCtrl = new AbortController();
+    return this.abortCtrl.signal;
+  }
+
+  getResults(data, ignoreSignal = false, newEndpoint = false) {
+    const signal = ignoreSignal ? undefined : this.createSignal();
+    if (data.filters) {
+      data.logic = data.filters;
+      delete data.filters;
+    }
+    return Request.post({ ...this.config, endpoint: newEndpoint ? UCHART_ENDPOINT : CHART_ENDPOINT, signal }, '/results', data);
+  }
+
+  getResultsPagination(data, ignoreSignal = false) {
+    const signal = ignoreSignal ? undefined : this.createSignal();
+    if (data.filters) {
+      data.logic = data.filters;
+      delete data.filters;
+    }
+    return Request.post({ ...this.config, endpoint: UCHART_PAGINATION_ENDPOINT, signal }, '', data);
+  }
+}

package/src/services/api/getAllDatasets.api.ts

@@ -1,24 +1,30 @@
-import { flattenDeep, isEmpty } from "../../general";
-import { IGeneralWidgetConfig } from "../../interfaces/general/IGeneralWidgetConfig";
+import { getArrayByProperty } from "../../general/array/getArrayByProperty";
+import { isEmpty } from "../../general/mix/isEmpty";
+import { IWidgetConfig } from "../../interfaces/general/IWidgetConfig";
 import { IDataset } from "../../qrvey/interfaces/IDataset";
 import { getAllQrveys } from "./getAllQrveys.api";
-import { getDatasetColumns } from "./getDatasetColumns.api";
+import { getDatasetsByIds } from "./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.
  */
-export function getAllDatasets(config: IGeneralWidgetConfig, pickDatasets: string[] = []): Promise<IDataset[]> {
-    return getAllQrveys({ ...config }, { status: ['RUNNING', 'FINISHED', 'PAUSED'], loadAll: true })
-      .then((qrveys) => {
-          let datasets = qrveys.Items.filter(filterSupportedDatasets);
-          datasets = isEmpty(pickDatasets) ? [] : datasets.filter(item => pickDatasets.includes(item.qrveyid));
-          return Promise.all(datasets.map(dataset => getDatasetColumns(config, dataset.qrveyid))).then(response => flattenDeep(response));
-      }).catch(_e => Promise.all([]));
-}
-
-function filterSupportedDatasets (dataset) {
-  return !['NPS', 'CHECKLIST'].includes(dataset.appType.toUpperCase());
+export function getAllDatasets(config: IWidgetConfig, qrveyids?: string[]): Promise<IDataset[]> {
+    if (Array.isArray(qrveyids) && isEmpty(qrveyids)) {
+        return Promise.resolve([] as IDataset[]);
+    } else if (Array.isArray(qrveyids) && !isEmpty(qrveyids)) {
+        return getDatasetsByIds(config, qrveyids);
+    } else {
+        return getAllQrveys({ ...config }, { status: ['RUNNING', 'FINISHED', 'PAUSED'], loadAll: true })
+        .then((qrveys) => {
+            const datasets: any[] = qrveys.Items.filter(item => !['NPS', 'CHECKLIST'].includes(item.appType.toUpperCase()));
+            return getDatasetsByIds(config, getArrayByProperty(datasets, 'qrveyid'));
+        }).catch(_e => [] as IDataset[]);
+    }
 }

package/src/services/api/getAllQrveys.api.ts

@@ -3,7 +3,7 @@ import Request from "../helpers/Request";
 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/src/services/api/getDatasetColumns.api.ts

@@ -1,20 +1,21 @@
-import { IGeneralWidgetConfig } from "../../interfaces/general/IGeneralWidgetConfig";
-import { IDataset } from "../../qrvey/interfaces/IDataset";
-import { CHART_ENDPOINT } from "../constants/CHART_ENDPOINT";
-import Request from "../helpers/Request";
-import { BDatasetsToUIDatasets } from "../adapters/BDatasetsToUIDatasets.adapter";
-import { chooseLang } from "../..";
+import { IDataset } from '../../qrvey/interfaces/IDataset';
+import { CHART_ENDPOINT } from '../constants/CHART_ENDPOINT';
+import Request from '../helpers/Request';
+import { BDatasetsToUIDatasets } from '../adapters/BDatasetsToUIDatasets.adapter';
+import { getDefaultQuestionListOptionsAttributes } from '../helpers/getDefaultQuestionListOptionsAttributes';
+import { chooseLang } from '../../format/localization';
+import { IWidgetConfig } from '../../interfaces/general/IWidgetConfig';
 
 /**
    * Get a dataset by Qrvey ID
    * @param qrveyid The Qrvey ID
    * @returns a promise
    */
-export function getDatasetColumns(config: IGeneralWidgetConfig, qrveyid?: string): Promise<IDataset[]> {
+export function getDatasetColumns(config: IWidgetConfig, qrveyid?: string): Promise<IDataset[]> {
     const lang = chooseLang(config);
     return Request.post({ ...config, qrveyid, endpoint: CHART_ENDPOINT }, '/question/list', {
-      'optionsAttributes': ['id', 'text', 'type', 'property', 'linked', 'linkid', 'qrveyid', 'bucketId', 'formulaId', 'formulaType', 'geogroup', 'outputFormat'],
-      'extend': true
+      optionsAttributes: getDefaultQuestionListOptionsAttributes(),
+      extend: true,
     }, { lang })
     .then(BDatasetsToUIDatasets)
     .catch(_e => []);

package/src/services/api/getDatasetsByIds.api.ts

@@ -0,0 +1,26 @@
+import { IDataset } from '../../qrvey/interfaces/IDataset';
+import Request from '../helpers/Request';
+import { BDatasetsToUIDatasets } from '../adapters/BDatasetsToUIDatasets.adapter';
+import { isEmpty } from '../../general/mix/isEmpty';
+import { chooseLang } from '../../format/localization';
+import { getDefaultQuestionListOptionsAttributes } from '../helpers/getDefaultQuestionListOptionsAttributes';
+import { QUESTION_LIST_BULK_ENDPOINT } from '../constants/QUESTION_LIST_BULK_ENDPOINT';
+import { IWidgetConfig } from '../../interfaces/general/IWidgetConfig';
+
+/**
+   * Get a dataset by Qrvey ID
+   * @param qrveyid The Qrvey ID
+   * @returns a promise
+   */
+export function getDatasetsByIds(config: IWidgetConfig, qrveyids: string[] = []): Promise<IDataset[]> {
+    if (Array.isArray(qrveyids) && !isEmpty(qrveyids)) {
+        const lang = chooseLang(config);
+        return Request.post({ ...config, endpoint: QUESTION_LIST_BULK_ENDPOINT }, '', {
+          optionsAttributes: getDefaultQuestionListOptionsAttributes(),
+          qrveyids
+        }, { lang })
+        .then(response => BDatasetsToUIDatasets(response?.data || []))
+        .catch(_e => [] as IDataset[]);
+    }
+    return Promise.resolve([]);
+}

package/src/services/api/getModel.api.ts

@@ -0,0 +1,10 @@
+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({ ...config, endpoint: ANALYTIQ_ENDPOINT }, '', data, { ...params, lang }).then(BModelToUIModel);
+}

package/src/services/api/index.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/src/services/constants/MODEL_ENDPOINT.ts

@@ -0,0 +1,6 @@
+import { IEndpointConfig } from "../interfaces/IEndpointConfig";
+
+export const ANALYTIQ_ENDPOINT: IEndpointConfig = {
+    uri: '/app/:app_id/qrvey/:qrvey_id/analytiq/model',
+    version: 4
+};

package/src/services/constants/QUESTION_LIST_BULK_ENDPOINT.ts

@@ -0,0 +1,6 @@
+import { IEndpointConfig } from "../interfaces/IEndpointConfig";
+
+export const QUESTION_LIST_BULK_ENDPOINT: IEndpointConfig = {
+  uri: '/app/:app_id/analytiq/chart/question/list/bulk',
+  version: 4
+};

package/src/services/constants/UCHART_ENDPOINT.ts

@@ -0,0 +1,6 @@
+import { IEndpointConfig } from "../interfaces/IEndpointConfig";
+
+export const UCHART_ENDPOINT: IEndpointConfig = {
+    uri: '/app/:app_id/qrvey/:qrvey_id/analytiq/uchart',
+    version: 4
+};

package/src/services/constants/UCHART_PAGINATION_ENDPOINT.ts

@@ -0,0 +1,6 @@
+import { IEndpointConfig } from "../interfaces/IEndpointConfig";
+
+export const UCHART_PAGINATION_ENDPOINT: IEndpointConfig = {
+  uri: '/app/:app_id/qrvey/:qrvey_id/analytiq/uchart/results/pagination',
+  version: 4
+};

package/src/services/constants/index.ts

@@ -1,2 +1,8 @@
 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/src/services/helpers/getDefaultQuestionListOptionsAttributes.ts

@@ -0,0 +1,24 @@
+export function getDefaultQuestionListOptionsAttributes() {
+    return [
+      'id',
+      'text',
+      'type',
+      'property',
+      'linked',
+      'linkid',
+      'qrveyid',
+      'bucketId',
+      'formulaId',
+      'formulaType',
+      'geogroup',
+      'outputFormat',
+      'answers', // For multiples webform column types
+      'imageUploadOption', // For Image upload
+      'sliderVal', // For slidebar
+      'value', // For lookup
+      'activeCat', // For Expressions
+      'words', // For Expressions with disabled categories
+      'negative', // For Expressions with enabled categories
+      'positive' // For Expressions with enabled categories
+    ];
+}

package/src/services/helpers/index.ts

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