@qrvey/utils 1.3.0-11 → 1.3.0-12

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';

package/dist/cjs/filters/interfaces/builder/IFilterBuilderGeneralConfig.d.ts

@@ -1,13 +0,0 @@
-import { II18nConfig } from "../../../globalization/interfaces/II18nConfig";
-/**
- * Structure for the Fiter Builder General config
- */
-export interface IFilterBuilderGeneralConfig {
-    apiKey?: string;
-    appid: string;
-    domain: string;
-    qv_token?: string;
-    timezoneControl?: string;
-    i18n?: II18nConfig;
-    userid: string;
-}

package/dist/cjs/filters/interfaces/common/IFSMergeFiltersSettings.d.ts

@@ -1,7 +0,0 @@
-/**
- * Structure for MergeFilters property settings
- */
-export interface IFSMergeFiltersSettings {
-    overwriteValues?: boolean;
-    setGroupedColumnOperator?: boolean;
-}

package/dist/cjs/interfaces/general/IGeneralWidgetConfig.d.ts

@@ -1,12 +0,0 @@
-export interface IGeneralWidgetConfig {
-    domain?: string;
-    apiKey?: string;
-    qrveyid?: string;
-    qv_token?: string;
-    locale?: string;
-    timezoneControl?: string;
-    isFromAN?: boolean;
-    appid: string;
-    userid: string;
-    lang?: string;
-}

package/dist/filters/interfaces/builder/IFilterBuilderGeneralConfig.d.ts

@@ -1,13 +0,0 @@
-import { II18nConfig } from "../../../globalization/interfaces/II18nConfig";
-/**
- * Structure for the Fiter Builder General config
- */
-export interface IFilterBuilderGeneralConfig {
-    apiKey?: string;
-    appid: string;
-    domain: string;
-    qv_token?: string;
-    timezoneControl?: string;
-    i18n?: II18nConfig;
-    userid: string;
-}

package/dist/filters/interfaces/common/IFSMergeFiltersSettings.d.ts

@@ -1,7 +0,0 @@
-/**
- * Structure for MergeFilters property settings
- */
-export interface IFSMergeFiltersSettings {
-    overwriteValues?: boolean;
-    setGroupedColumnOperator?: boolean;
-}

package/dist/interfaces/general/IGeneralWidgetConfig.d.ts

@@ -1,12 +0,0 @@
-export interface IGeneralWidgetConfig {
-    domain?: string;
-    apiKey?: string;
-    qrveyid?: string;
-    qv_token?: string;
-    locale?: string;
-    timezoneControl?: string;
-    isFromAN?: boolean;
-    appid: string;
-    userid: string;
-    lang?: string;
-}

package/src/filters/interfaces/builder/IFilterBuilderGeneralConfig.ts

@@ -1,14 +0,0 @@
-import { II18nConfig } from "../../../globalization/interfaces/II18nConfig";
-
-/**
- * Structure for the Fiter Builder General config
- */
-export interface IFilterBuilderGeneralConfig {
-    apiKey?: string; // Api Key to get access from servers. Optional if qv_token is set
-    appid: string; // App ID
-    domain: string; // The domain of the environment
-    qv_token?: string; // Qrvey Token for RLS
-    timezoneControl?: string; // Offset number for Timezone
-    i18n?: II18nConfig; // The i18n configuration;
-    userid: string; // User ID
-}

package/src/filters/interfaces/common/IFSMergeFiltersSettings.ts

@@ -1,8 +0,0 @@
-
-/**
- * Structure for MergeFilters property settings
- */
-export interface IFSMergeFiltersSettings {
-    overwriteValues?: boolean;
-    setGroupedColumnOperator?: boolean;
-}

package/src/interfaces/general/IGeneralWidgetConfig.ts

@@ -1,12 +0,0 @@
-export interface IGeneralWidgetConfig {
-    domain?: string;
-    apiKey?: string;
-    qrveyid?: string;
-    qv_token?: string;
-    locale?: string;
-    timezoneControl?: string;
-    isFromAN?: boolean;
-    appid: string;
-    userid: string;
-    lang?: string;
-}