@qrvey/utils 1.2.10-0 → 1.2.10-1

package/README.md

@@ -1,4 +1,4 @@
-# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.10-0*
+# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.10-1*
 
 > Helper, Utils for all Qrvey Projects
 
@@ -80,6 +80,85 @@ Get a text and evaluate if it matchs with a token box label.
 
 
 
+### dist/columns/helpers/getColumnsLabel.js
+
+
+#### getColumnLabels(column) 
+
+Get an string of the properties of the given column.
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| column |  | The column |   |
+
+
+
+
+##### Returns
+
+
+-  an string with the property, aggregate or calculation label.
+
+
+
+
+### dist/columns/helpers/getModelColumn.js
+
+
+#### getModelColumn(column, model) 
+
+Get a model question by column id.
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| column |  | The column with info |   |
+| model |  | The model object |   |
+
+
+
+
+##### Returns
+
+
+-  the model question
+
+
+
+#### getQuestionData(model) 
+
+[TODO: Change the question.data access path. IModel structure is different]
+Get the question data array from model object
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| model |  | The model object |   |
+
+
+
+
+##### Returns
+
+
+-  the question data array from model object
+
+
+
+
 ### dist/dates/adapters/mdyDateToDate.js
 
 
@@ -688,85 +767,6 @@ Output:
 
 
 
-### dist/columns/helpers/getColumnsLabel.js
-
-
-#### getColumnLabels(column) 
-
-Get an string of the properties of the given column.
-
-
-
-
-##### Parameters
-
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| column |  | The column |   |
-
-
-
-
-##### Returns
-
-
--  an string with the property, aggregate or calculation label.
-
-
-
-
-### dist/columns/helpers/getModelColumn.js
-
-
-#### getModelColumn(column, model) 
-
-Get a model question by column id.
-
-
-
-
-##### Parameters
-
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| column |  | The column with info |   |
-| model |  | The model object |   |
-
-
-
-
-##### Returns
-
-
--  the model question
-
-
-
-#### getQuestionData(model) 
-
-[TODO: Change the question.data access path. IModel structure is different]
-Get the question data array from model object
-
-
-
-
-##### Parameters
-
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| model |  | The model object |   |
-
-
-
-
-##### Returns
-
-
--  the question data array from model object
-
-
-
-
 ### dist/filters/adapters/FDToFlatUI.js
 
 
@@ -2674,12 +2674,12 @@ Flat deeply an array
 
 
 
-### dist/general/array/getArrayByProperty.js
+### dist/general/array/getFirstIndexFromArray.js
 
 
-#### getArrayByProperty(arr, property) 
+#### getFirstIndexFromArray(array, callback) 
 
-Gets a collection of object values by the given property
+Gets the first index from the array by a callback condition
 
 
 
@@ -2688,8 +2688,8 @@ Gets a collection of object values by the given property
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| arr |  | An array |   |
-| property |  | the property to get the value collection |   |
+| array |  |  |   |
+| callback |  | function callback |   |
 
 
 
@@ -2697,17 +2697,17 @@ Gets a collection of object values by the given property
 ##### Returns
 
 
--  a collection of values by property
+-  the first index of the array. -1 when the condition is not satisfied
 
 
 
 
-### dist/general/array/getFirstIndexFromArray.js
+### dist/general/array/getArrayByProperty.js
 
 
-#### getFirstIndexFromArray(array, callback) 
+#### getArrayByProperty(arr, property) 
 
-Gets the first index from the array by a callback condition
+Gets a collection of object values by the given property
 
 
 
@@ -2716,8 +2716,8 @@ Gets the first index from the array by a callback condition
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| array |  |  |   |
-| callback |  | function callback |   |
+| arr |  | An array |   |
+| property |  | the property to get the value collection |   |
 
 
 
@@ -2725,7 +2725,7 @@ Gets the first index from the array by a callback condition
 ##### Returns
 
 
--  the first index of the array. -1 when the condition is not satisfied
+-  a collection of values by property
 
 
 
@@ -3129,33 +3129,6 @@ Gets the length of the given array.
 
 
 
-### dist/general/string/capitalize.js
-
-
-#### capitalize(text) 
-
-Upper case the first letter of a given text
-
-
-
-
-##### Parameters
-
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| text | `String`  |  |   |
-
-
-
-
-##### Returns
-
-
-- `String`  a capitalized text
-
-
-
-
 ### dist/general/object/cloneDeep.js
 
 
@@ -3380,12 +3353,13 @@ and return a mapped object
 
 
 
-### dist/general/object/objectCopy.js
+### dist/general/object/mergeDeep.js
 
 
-#### objectCopy(entity, cache) 
+#### mergeDeep(obj1, obj2, settings) 
 
-Created a new reference of the given argument
+Merges two objects into a new one.
+The second given argument to the first given argument.
 
 
 
@@ -3394,8 +3368,9 @@ Created a new reference of the given argument
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| entity |  | The variable to be copied |   |
-| cache |  |  |   |
+| obj1 |  | The target object |   |
+| obj2 |  | The object to be merged |   |
+| settings |  | Object settings for this function |   |
 
 
 
@@ -3403,17 +3378,13 @@ Created a new reference of the given argument
 ##### Returns
 
 
--  A new reference of the given argument
-
-
+-  a new merged object
 
 
-### dist/general/object/omit.js
 
+#### isValid(obj1, obj2) 
 
-#### omit(obj, props) 
-
-return a new Object excluding attributes in _props_ list
+Validates if the two arguments are objects
 
 
 
@@ -3422,8 +3393,8 @@ return a new Object excluding attributes in _props_ list
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| obj | `Object`  | base object |   |
-| props | `Array.<String>`  | list of attribute to exclude | &nbsp; |
+| obj1 |  | The target object | &nbsp; |
+| obj2 |  | The object to be merged | &nbsp; |
 
 
 
@@ -3431,18 +3402,13 @@ return a new Object excluding attributes in _props_ list
 ##### Returns
 
 
-- `Object`  clean object
-
-
-
+-  true: they are valid; false: they are not
 
-### dist/general/object/mergeDeep.js
 
 
-#### mergeDeep(obj1, obj2, settings) 
+#### getParamsToMergeDeep(settings) 
 
-Merges two objects into a new one.
-The second given argument to the first given argument.
+Validates and gets the settings with all set parameters.
 
 
 
@@ -3451,9 +3417,7 @@ The second given argument to the first given argument.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| obj1 |  | The target object | &nbsp; |
-| obj2 |  | The object to be merged | &nbsp; |
-| settings |  | Object settings for this function | &nbsp; |
+| settings |  | the settings object | &nbsp; |
 
 
 
@@ -3461,13 +3425,17 @@ The second given argument to the first given argument.
 ##### Returns
 
 
--  a new merged object
+-  a new settings object with all set parameters.
 
 
 
-#### isValid(obj1, obj2) 
 
-Validates if the two arguments are objects
+### dist/general/object/objectCopy.js
+
+
+#### objectCopy(entity, cache) 
+
+Created a new reference of the given argument
 
 
 
@@ -3476,8 +3444,8 @@ Validates if the two arguments are objects
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| obj1 |  | The target object | &nbsp; |
-| obj2 |  | The object to be merged | &nbsp; |
+| entity |  | The variable to be copied | &nbsp; |
+| cache |  |  | &nbsp; |
 
 
 
@@ -3485,13 +3453,17 @@ Validates if the two arguments are objects
 ##### Returns
 
 
--  true: they are valid; false: they are not
+-  A new reference of the given argument
 
 
 
-#### getParamsToMergeDeep(settings) 
 
-Validates and gets the settings with all set parameters.
+### dist/general/object/omit.js
+
+
+#### omit(obj, props) 
+
+return a new Object excluding attributes in _props_ list
 
 
 
@@ -3500,7 +3472,8 @@ Validates and gets the settings with all set parameters.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| settings |  | the settings object | &nbsp; |
+| obj | `Object`  | base object | &nbsp; |
+| props | `Array.<String>`  | list of attribute to exclude | &nbsp; |
 
 
 
@@ -3508,7 +3481,7 @@ Validates and gets the settings with all set parameters.
 ##### Returns
 
 
--  a new settings object with all set parameters.
+- `Object`  clean object
 
 
 
@@ -3568,6 +3541,33 @@ serialize object to url param
 
 
 
+### dist/general/string/capitalize.js
+
+
+#### capitalize(text) 
+
+Upper case the first letter of a given text
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| text | `String`  |  | &nbsp; |
+
+
+
+
+##### Returns
+
+
+- `String`  a capitalized text
+
+
+
+
 ### dist/qrvey/helpers/areStaticColumnValues.js
 
 
@@ -3658,12 +3658,13 @@ For the others columns, answers is located in the property of the same name.
 
 
 
-### dist/qrvey/helpers/getExpressionAnswers.js
+### dist/qrvey/helpers/getDropdownAnswers.js
 
 
-#### getExpressionAnswers(column, property) 
+#### getDropdownAnswers(question) 
 
-Get the answers of expression columns. Depends of the property attribute and if the column is categorizable.
+Get the answers of dropdown columns.
+Answers is a direct array of strings so it is necessary to format them.
 
 
 
@@ -3672,8 +3673,7 @@ Get the answers of expression columns. Depends of the property attribute and if
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| column |  | The column located inside the model object. | &nbsp; |
-| property |  | Optional Attribute, especially for expression columns. | &nbsp; |
+| question |  | The column located inside the model object. | &nbsp; |
 
 
 
@@ -3686,13 +3686,12 @@ Get the answers of expression columns. Depends of the property attribute and if
 
 
 
-### dist/qrvey/helpers/getDropdownAnswers.js
+### dist/qrvey/helpers/getExpressionAnswers.js
 
 
-#### getDropdownAnswers(question) 
+#### getExpressionAnswers(column, property) 
 
-Get the answers of dropdown columns.
-Answers is a direct array of strings so it is necessary to format them.
+Get the answers of expression columns. Depends of the property attribute and if the column is categorizable.
 
 
 
@@ -3701,7 +3700,8 @@ Answers is a direct array of strings so it is necessary to format them.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| question |  | The column located inside the model object. | &nbsp; |
+| column |  | The column located inside the model object. | &nbsp; |
+| property |  | Optional Attribute, especially for expression columns. | &nbsp; |
 
 
 
@@ -4207,12 +4207,12 @@ try to find this string as a variable on Windows object
 
 
 
-### dist/typescript/decorators/Throttled.js
+### dist/typescript/decorators/Debounce.js
 
 
-#### Throttled(time) 
+#### Debounce(time) 
 
-(Method Decorator) Throttled Class Method
+(Method Decorator) Debounce Class Method
 
 
 
@@ -4234,12 +4234,12 @@ try to find this string as a variable on Windows object
 
 
 
-### dist/typescript/decorators/Debounce.js
+### dist/typescript/decorators/Throttled.js
 
 
-#### Debounce(time) 
+#### Throttled(time) 
 
-(Method Decorator) Debounce Class Method
+(Method Decorator) Throttled Class Method
 
 
 

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

@@ -1,3 +1,2 @@
 export * from './IGeneralInfo';
-export * from './IGeneralWidgetConfig';
 export * from './IWidgetConfig';

package/dist/cjs/interfaces/general/index.js

@@ -11,5 +11,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./IGeneralInfo"), exports);
-__exportStar(require("./IGeneralWidgetConfig"), exports);
 __exportStar(require("./IWidgetConfig"), exports);

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

@@ -1,4 +1,4 @@
-import { IGeneralWidgetConfig } from "../../interfaces/general/IGeneralWidgetConfig";
+import { IWidgetConfig } from "../../interfaces/general/IWidgetConfig";
 import { IDataset } from "../../qrvey/interfaces/IDataset";
 /**
  * Get a dataset list from a collection of Qrvey IDs
@@ -10,4 +10,4 @@ import { IDataset } from "../../qrvey/interfaces/IDataset";
  * @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 declare function getAllDatasets(config: IGeneralWidgetConfig, qrveyids?: string[]): Promise<IDataset[]>;
+export declare function getAllDatasets(config: IWidgetConfig, qrveyids?: string[]): Promise<IDataset[]>;

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 { 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/getDatasetsByIds.api.d.ts

@@ -1,8 +1,8 @@
-import { IGeneralWidgetConfig } from '../../interfaces/general/IGeneralWidgetConfig';
 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: IGeneralWidgetConfig, qrveyids?: string[]): Promise<IDataset[]>;
+export declare function getDatasetsByIds(config: IWidgetConfig, qrveyids?: string[]): Promise<IDataset[]>;

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

@@ -1,3 +1,2 @@
 export * from './IGeneralInfo';
-export * from './IGeneralWidgetConfig';
 export * from './IWidgetConfig';

package/dist/interfaces/general/index.js

@@ -1,3 +1,2 @@
 export * from './IGeneralInfo';
-export * from './IGeneralWidgetConfig';
 export * from './IWidgetConfig';

package/dist/services/api/getAllDatasets.api.d.ts

@@ -1,4 +1,4 @@
-import { IGeneralWidgetConfig } from "../../interfaces/general/IGeneralWidgetConfig";
+import { IWidgetConfig } from "../../interfaces/general/IWidgetConfig";
 import { IDataset } from "../../qrvey/interfaces/IDataset";
 /**
  * Get a dataset list from a collection of Qrvey IDs
@@ -10,4 +10,4 @@ import { IDataset } from "../../qrvey/interfaces/IDataset";
  * @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 declare function getAllDatasets(config: IGeneralWidgetConfig, qrveyids?: string[]): Promise<IDataset[]>;
+export declare function getAllDatasets(config: IWidgetConfig, qrveyids?: string[]): Promise<IDataset[]>;

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

@@ -1,8 +1,8 @@
-import { IGeneralWidgetConfig } from '../../interfaces/general/IGeneralWidgetConfig';
 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/services/api/getDatasetsByIds.api.d.ts

@@ -1,8 +1,8 @@
-import { IGeneralWidgetConfig } from '../../interfaces/general/IGeneralWidgetConfig';
 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: IGeneralWidgetConfig, qrveyids?: string[]): Promise<IDataset[]>;
+export declare function getDatasetsByIds(config: IWidgetConfig, qrveyids?: string[]): Promise<IDataset[]>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qrvey/utils",
-  "version": "1.2.10-0",
+  "version": "1.2.10-1",
   "description": "Helper, Utils for all Qrvey Projects",
   "homepage": "https://bitbucket.org/qrvey/qrvey_utils/wiki/Home",
   "main": "dist/index.js",

package/src/interfaces/general/index.ts

@@ -1,3 +1,2 @@
 export * from './IGeneralInfo';
-export * from './IGeneralWidgetConfig';
 export * from './IWidgetConfig';

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

@@ -1,6 +1,6 @@
 import { getArrayByProperty } from "../../general/array/getArrayByProperty";
 import { isEmpty } from "../../general/mix/isEmpty";
-import { IGeneralWidgetConfig } from "../../interfaces/general/IGeneralWidgetConfig";
+import { IWidgetConfig } from "../../interfaces/general/IWidgetConfig";
 import { IDataset } from "../../qrvey/interfaces/IDataset";
 import { getAllQrveys } from "./getAllQrveys.api";
 import { getDatasetsByIds } from "./getDatasetsByIds.api";
@@ -15,7 +15,7 @@ import { getDatasetsByIds } from "./getDatasetsByIds.api";
  * @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, qrveyids?: string[]): Promise<IDataset[]> {
+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)) {

package/src/services/api/getDatasetColumns.api.ts

@@ -1,17 +1,17 @@
-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 { 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: getDefaultQuestionListOptionsAttributes(),

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

@@ -1,4 +1,3 @@
-import { IGeneralWidgetConfig } from '../../interfaces/general/IGeneralWidgetConfig';
 import { IDataset } from '../../qrvey/interfaces/IDataset';
 import Request from '../helpers/Request';
 import { BDatasetsToUIDatasets } from '../adapters/BDatasetsToUIDatasets.adapter';
@@ -6,13 +5,14 @@ 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: IGeneralWidgetConfig, qrveyids: string[] = []): Promise<IDataset[]> {
+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 }, '', {

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/cjs/interfaces/general/IGeneralWidgetConfig.js

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

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/dist/interfaces/general/IGeneralWidgetConfig.js

@@ -1 +0,0 @@
-export {};

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