@qrvey/utils 1.2.9-36 → 1.2.9-37

package/README.md

@@ -1,4 +1,4 @@
-# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-36*
+# [@qrvey/utils](https://bitbucket.org/qrvey/qrvey_utils/wiki/Home) *1.2.9-37*
 
 > Helper, Utils for all Qrvey Projects
 
@@ -2722,50 +2722,47 @@ Gets the format config
 
 
 
-### dist/services/api/getAllDatasets.api.js
-
+### dist/stencil/decorators/Config.js
 
-#### getAllDatasets(config, pickDatasets) 
 
-Get a dataset list from a collection of Qrvey IDs
+#### Config() 
 
+Stencil.js - Prop Decorator
+Get and Parse the Widget Configuration Object and also provide the ability to get properties in different case styles such as: lower, upper, camel and pascal
+But for this, is required ask for a property in `snake_case` style
 
 
 
-##### Parameters
 
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| config |  | the widget config. Includes the appid and others configuration properties |   |
-| pickDatasets |  | Collection of Qrvey IDs for filtering the request |   |
 
 
+##### Examples
 
+```javascript
+\ @Config() @Prop() settings;
 
-##### Returns
+someMethod() {
+ this.settings.snake_case //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
+}
+```
 
 
--  a promise
+##### Returns
 
 
+- `Void`
 
 
-### dist/services/api/getAllQrveys.api.js
 
 
-#### getAllQrveys(config, params) 
+### dist/stencil/util/createRef.js
 
-POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
 
+#### createRef() 
 
+lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
 
 
-##### Parameters
-
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| config |  | Configuration |   |
-| params |  | Object for getting precise data |   |
 
 
 
@@ -2773,17 +2770,21 @@ POST Request for getting Qrveys such as Web Forms and Datasets. Use params for g
 ##### Returns
 
 
-- `Void`
+-  function - Function to use in ref prop in html elements
 
 
 
 
-### dist/services/api/getDatasetColumns.api.js
+### dist/stencil/util/getConfig.js
 
 
-#### getDatasetColumns(qrveyid) 
+#### getConfig(cfg) 
 
-Get a dataset by Qrvey ID
+verify the Config object type and try to return a parsed Object
+- In case _cfg_ is a string, first try to make a JSON parse in other case
+try to find this string as a variable on Windows object
+- If _cfg_ is a fuction, tis is invoked and parsed
+- Finally, if is an object, _cfg_ is inmediatly returned
 
 
 
@@ -2792,7 +2793,7 @@ Get a dataset by Qrvey ID
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| qrveyid |  | The Qrvey ID |   |
+| cfg |  |  |   |
 
 
 
@@ -2800,74 +2801,73 @@ Get a dataset by Qrvey ID
 ##### Returns
 
 
--  a promise
-
+- `Void`
 
 
 
-### dist/stencil/decorators/Config.js
 
+### dist/services/api/getAllDatasets.api.js
 
-#### Config() 
 
-Stencil.js - Prop Decorator
-Get and Parse the Widget Configuration Object and also provide the ability to get properties in different case styles such as: lower, upper, camel and pascal
-But for this, is required ask for a property in `snake_case` style
+#### getAllDatasets(config, pickDatasets) 
 
+Get a dataset list from a collection of Qrvey IDs
 
 
 
 
+##### Parameters
 
-##### Examples
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| config |  | the widget config. Includes the appid and others configuration properties |   |
+| pickDatasets |  | Collection of Qrvey IDs for filtering the request |   |
 
-```javascript
-\ @Config() @Prop() settings;
 
-someMethod() {
- this.settings.snake_case //it search for: obj.snake_case || obj.snakeCase || obj.SnakeCase || obj.snakecase || obj.SNAKECASE
-}
-```
 
 
 ##### Returns
 
 
-- `Void`
+-  a promise
 
 
 
 
-### dist/stencil/util/createRef.js
+### dist/services/api/getAllQrveys.api.js
 
 
-#### createRef() 
+#### getAllQrveys(config, params) 
 
-lit implementation of React createRef (https://reactjs.org/docs/refs-and-the-dom.html)
+POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
 
 
 
 
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| config |  | Configuration |   |
+| params |  | Object for getting precise data |   |
+
+
 
 
 ##### Returns
 
 
--  function - Function to use in ref prop in html elements
+- `Void`
 
 
 
 
-### dist/stencil/util/getConfig.js
+### dist/services/api/getDatasetColumns.api.js
 
 
-#### getConfig(cfg) 
+#### getDatasetColumns(qrveyid) 
 
-verify the Config object type and try to return a parsed Object
-- In case _cfg_ is a string, first try to make a JSON parse in other case
-try to find this string as a variable on Windows object
-- If _cfg_ is a fuction, tis is invoked and parsed
-- Finally, if is an object, _cfg_ is inmediatly returned
+Get a dataset by Qrvey ID
 
 
 
@@ -2876,7 +2876,7 @@ try to find this string as a variable on Windows object
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| cfg |  |  |   |
+| qrveyid |  | The Qrvey ID |   |
 
 
 
@@ -2884,7 +2884,7 @@ try to find this string as a variable on Windows object
 ##### Returns
 
 
-- `Void`
+-  a promise
 
 
 

package/dist/cjs/dates/constants/DATE_REGULAR_EXPRESSION.js

@@ -25,7 +25,7 @@ exports.DATE_REGULAR_EXPRESSION = {
     SECOND: `^${YEAR_MONTH_NUMBER}/${MONTH_DAY}/${YEAR} ${DAY_TIME}$`,
     MONTH_DAY: `^${MONTH_DAY}$`,
     YEAR_MONTH: `^${YEAR_MONTH}$`,
-    YEAR_MONTH_NUMBER: `${YEAR_MONTH_NUMBER}`,
+    YEAR_MONTH_NUMBER: `^${YEAR_MONTH_NUMBER}$`,
     YEAR_QUARTER: `^${YEAR_QUARTER}$`,
     YEAR_WEEK: `^${YEAR_WEEK}$`,
     DAY_HOUR: `^${DAY_HOUR}$`,

package/dist/cjs/dates/helpers/getSeparatorByDateFormat.js

@@ -8,7 +8,7 @@ const DATE_FORMAT_1 = require("../constants/DATE_FORMAT");
  * @returns a separator string
  */
 function getSeparatorByDateFormat(format = DATE_FORMAT_1.DATE_FORMAT.DAY) {
-    return format === DATE_FORMAT_1.DATE_FORMAT.YEAR || format === DATE_FORMAT_1.DATE_FORMAT.DAY_TIME || format === DATE_FORMAT_1.DATE_FORMAT.MONTH_DAY || format === DATE_FORMAT_1.DATE_FORMAT.YEAR_MONTH || format === DATE_FORMAT_1.DATE_FORMAT.YEAR_QUARTER || format === DATE_FORMAT_1.DATE_FORMAT.YEAR_WEEK || format === DATE_FORMAT_1.DATE_FORMAT.DAY_HOUR || format === DATE_FORMAT_1.DATE_FORMAT.HOUR_MINUTE || format === DATE_FORMAT_1.DATE_FORMAT.MINUTE_SECOND ? '' :
+    return format === DATE_FORMAT_1.DATE_FORMAT.YEAR || format === DATE_FORMAT_1.DATE_FORMAT.DAY_TIME || format === DATE_FORMAT_1.DATE_FORMAT.MONTH_DAY || format === DATE_FORMAT_1.DATE_FORMAT.YEAR_MONTH || format === DATE_FORMAT_1.DATE_FORMAT.YEAR_QUARTER || format === DATE_FORMAT_1.DATE_FORMAT.YEAR_WEEK || format === DATE_FORMAT_1.DATE_FORMAT.DAY_HOUR || format === DATE_FORMAT_1.DATE_FORMAT.HOUR_MINUTE || format === DATE_FORMAT_1.DATE_FORMAT.MINUTE_SECOND ? ' ' :
         format === DATE_FORMAT_1.DATE_FORMAT.MONTH || format === DATE_FORMAT_1.DATE_FORMAT.QUARTER || format === DATE_FORMAT_1.DATE_FORMAT.WEEK || format === DATE_FORMAT_1.DATE_FORMAT.HOUR || format === DATE_FORMAT_1.DATE_FORMAT.MINUTE || format === DATE_FORMAT_1.DATE_FORMAT.SECOND ? ' ' :
             '/';
 }

package/dist/dates/constants/DATE_REGULAR_EXPRESSION.js

@@ -22,7 +22,7 @@ export const DATE_REGULAR_EXPRESSION = {
     SECOND: `^${YEAR_MONTH_NUMBER}/${MONTH_DAY}/${YEAR} ${DAY_TIME}$`,
     MONTH_DAY: `^${MONTH_DAY}$`,
     YEAR_MONTH: `^${YEAR_MONTH}$`,
-    YEAR_MONTH_NUMBER: `${YEAR_MONTH_NUMBER}`,
+    YEAR_MONTH_NUMBER: `^${YEAR_MONTH_NUMBER}$`,
     YEAR_QUARTER: `^${YEAR_QUARTER}$`,
     YEAR_WEEK: `^${YEAR_WEEK}$`,
     DAY_HOUR: `^${DAY_HOUR}$`,

package/dist/dates/helpers/getSeparatorByDateFormat.js

@@ -5,7 +5,7 @@ import { DATE_FORMAT } from "../constants/DATE_FORMAT";
  * @returns a separator string
  */
 export function getSeparatorByDateFormat(format = DATE_FORMAT.DAY) {
-    return format === DATE_FORMAT.YEAR || format === DATE_FORMAT.DAY_TIME || format === DATE_FORMAT.MONTH_DAY || format === DATE_FORMAT.YEAR_MONTH || format === DATE_FORMAT.YEAR_QUARTER || format === DATE_FORMAT.YEAR_WEEK || format === DATE_FORMAT.DAY_HOUR || format === DATE_FORMAT.HOUR_MINUTE || format === DATE_FORMAT.MINUTE_SECOND ? '' :
+    return format === DATE_FORMAT.YEAR || format === DATE_FORMAT.DAY_TIME || format === DATE_FORMAT.MONTH_DAY || format === DATE_FORMAT.YEAR_MONTH || format === DATE_FORMAT.YEAR_QUARTER || format === DATE_FORMAT.YEAR_WEEK || format === DATE_FORMAT.DAY_HOUR || format === DATE_FORMAT.HOUR_MINUTE || format === DATE_FORMAT.MINUTE_SECOND ? ' ' :
         format === DATE_FORMAT.MONTH || format === DATE_FORMAT.QUARTER || format === DATE_FORMAT.WEEK || format === DATE_FORMAT.HOUR || format === DATE_FORMAT.MINUTE || format === DATE_FORMAT.SECOND ? ' ' :
             '/';
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qrvey/utils",
-  "version": "1.2.9-36",
+  "version": "1.2.9-37",
   "description": "Helper, Utils for all Qrvey Projects",
   "homepage": "https://bitbucket.org/qrvey/qrvey_utils/wiki/Home",
   "main": "dist/index.js",
@@ -11,9 +11,10 @@
     "doxs": "doxdox './dist/**/*.js' --ignore './dist/cjs/**/*.js' --output README.md --layout markdown --package ./package.json",
     "lint": "eslint src --quiet --exit-on-fatal-error --ext .ts,.js",
     "lint-dev": "eslint src --debug --ext .ts,.tsx",
-    "publishing": "node ./scripts/prepare-publish && np",
-    "publishing-prerelease": "node ./scripts/prepare-publish && np --any-branch --tag=$npm_config_tag",
-    "publishing-v2": "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",
+    "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",
+    "publishing-beta-2": "node ./scripts/clean-build && node ./scripts/generating-docs && np --any-branch",
     "test": "jest test",
     "test:watch": "jest --watch test"
   },

package/scripts/generating-docs/index.js

@@ -0,0 +1,133 @@
+/**
+ * Script for cleaning the project from temporary files and building a new bundle
+ * 1- Deleting some directories and files
+ * 2- Installing dependencies
+ * 3- Build a new bundle
+ */
+
+const fs = require('fs');
+const util = require('util');
+const childProcess = require('child_process');
+const exec = util.promisify(childProcess.exec);
+const proc = require('process');
+const readline = require("readline");
+const rl = readline.createInterface({
+    input: proc.stdin,
+    output: proc.stdout
+});
+const question = util.promisify(rl.question).bind(rl);
+const { exit } = require('process');
+  
+async function execute(command) {
+    console.log(command);
+    const response = await exec(command);
+    if (response.error != null) {
+        throw new Error(response.error);
+    }
+    if (response.stderr != null && response.stderr !== '') {
+        console.error(response.stderr);
+    }
+    if (response.stdout != null && response.stdout !== '') {
+        console.log(response.stdout);
+    }
+    return response;
+}
+
+async function getPackageJson(settings) {
+    console.log('==>>> Opening package.json file...');
+    const packageJson = await fs.readFileSync(settings.packagePath, 'utf8');
+    const packageObject = JSON.parse(packageJson);
+    if (packageObject != null) {
+        console.log(`**** The current version is ${packageObject.version}`);
+        return packageObject.version;
+    }
+    return '';
+}
+
+async function getNewVersion() {
+    console.log('==>>> Checking the new version provided...');
+    let newVersion;
+    const versionIndex = proc.argv.findIndex(function (argv) { return argv.includes('--np-new-version='); });
+    if (versionIndex > -1) {
+        const versionArg = proc.argv[versionIndex].split('--np-new-version=');
+        newVersion = versionArg[1] == null || versionArg[1] === '' ? undefined : versionArg[1];
+    }
+    if (newVersion == null) {
+        newVersion = await question('No version provided. Type the new version: ');
+    }
+    console.log('**** Version to publish: ' + newVersion);
+    return newVersion;
+}
+
+async function startGeneratingDocs(settings) {
+    console.log('==>>> Starting the Docs generation');
+
+    await generatingDocument(settings);
+    await changingVersion(settings);
+    await pushingChanges(settings);
+}
+
+async function generatingDocument(settings) {
+    console.log('==>>> Generating Document...');
+    await execute(`doxdox './dist/**/*.js' --output ${settings.docsFileName} --ignore './dist/cjs/**/*.js' --package ${settings.packagePath} --layout markdown`);
+}
+
+async function changingVersion(settings) {
+    console.log('==>>> Replacing the old version in the document');
+    const doc = await fs.readFileSync(settings.docsPath, 'utf8');
+    const replacedDoc = doc.replace(settings.currentVersion, settings.newVersion);
+    await fs.writeFileSync(settings.docsPath, replacedDoc, 'utf8');
+}
+
+async function pushingChanges(settings) {
+    console.log('==>>> Commiting and Pushing Docs changes...');
+
+    const gitStatus = await execute('git status -s');
+    console.log('gitStatus', gitStatus);
+    if (gitStatus.stdout !== '') {
+        const gitStdout = await execute('git rev-parse --abbrev-ref HEAD');
+        console.log('gitStdout', gitStdout);
+        await execute(`git add ${settings.docsPath}`);
+        await execute(`git commit -m "📝 docs: Updated docs${settings.newVersion != null || settings.newVersion !== '' ? ' for ' + settings.newVersion : ''}"`);
+        await execute(`git push -u origin ${gitStdout.stdout}`);
+    } else {
+        console.log('Nothing to Push');
+    }
+}
+ 
+ async function revertChanges(settings) {
+    console.log('>>> Checking for modifications...');
+    console.warn(`>>> Unstaging posible changes from ${settings.docsFileName} and ${settings.packageFileName} file`);
+    await execute(`git restore --staged ${settings.docsPath} ${settings.packagePath}`);
+    console.warn(`>>> Discarting posible changes of ${settings.docsFileName} and ${settings.packageFileName} file`);
+    await execute(`git checkout -- ${settings.docsPath} ${settings.packagePath}`);
+}
+
+ async function init() {
+    console.log('Generating Docs execution.');
+    let settings = {
+        currentVersion: '',
+        docsPath: './README.md',
+        docsFileName: 'README.md',
+        newVersion: undefined,
+        packageFileName: 'package.json',
+        packagePath: './package.json',
+     };
+ 
+    try {
+        settings["currentVersion"] = await getPackageJson(settings);
+        settings["newVersion"] = await getNewVersion();
+
+        await startGeneratingDocs(settings);
+        console.info('Docs were generated.');
+    } catch (err) {
+        console.error('Error: ', err);
+        await revertChanges(settings);
+    } finally {
+        console.log('Execution finished');
+        exit();
+    }
+ }
+  
+ init();
+ 

package/scripts/publishing/index.js

@@ -153,11 +153,17 @@ async function changingVersion(settings) {
 async function pushingChanges(settings) {
     console.log('==>>> Commiting and Pushing Docs changes...');
 
-    const gitStdout = await execute('git rev-parse --abbrev-ref HEAD');
-    console.log('gitStdout', gitStdout);
-    await execute(`git add ${settings.docsPath}`);
-    await execute(`git commit -m "📝 docs: Updated docs${settings.newVersion != null || settings.newVersion !== '' ? ' for ' + settings.newVersion : ''}"`);
-    await execute(`git push -u origin ${gitStdout.stdout}`);
+    const gitStatus = await execute('git status -s');
+    console.log('gitStatus', gitStatus);
+    if (gitStatus.stdout !== '') {
+        const gitStdout = await execute('git rev-parse --abbrev-ref HEAD');
+        console.log('gitStdout', gitStdout);
+        await execute(`git add ${settings.docsPath}`);
+        await execute(`git commit -m "📝 docs: Updated docs${settings.newVersion != null || settings.newVersion !== '' ? ' for ' + settings.newVersion : ''}"`);
+        await execute(`git push -u origin ${gitStdout.stdout}`);
+    } else {
+        console.log('Nothing to Push');
+    }
 }
 
 async function revertChanges(settings) {
@@ -179,7 +185,6 @@ async function init() {
         packageFileName: 'package.json',
         packageLockPath: './package-lock.json',
         packagePath: './package.json',
-        
     };
 
     console.log('Welcome. The publishing operationg will begin.');

package/src/dates/constants/DATE_REGULAR_EXPRESSION.ts

@@ -25,7 +25,7 @@ export const DATE_REGULAR_EXPRESSION = {
     SECOND: `^${YEAR_MONTH_NUMBER}/${MONTH_DAY}/${YEAR} ${DAY_TIME}$`,
     MONTH_DAY: `^${MONTH_DAY}$`,
     YEAR_MONTH: `^${YEAR_MONTH}$`,
-    YEAR_MONTH_NUMBER: `${YEAR_MONTH_NUMBER}`,
+    YEAR_MONTH_NUMBER: `^${YEAR_MONTH_NUMBER}$`,
     YEAR_QUARTER: `^${YEAR_QUARTER}$`,
     YEAR_WEEK: `^${YEAR_WEEK}$`,
     DAY_HOUR: `^${DAY_HOUR}$`,

package/src/dates/helpers/getSeparatorByDateFormat.ts

@@ -7,7 +7,7 @@ import { IDateFormat } from "../interfaces/IDateFormat";
  * @returns a separator string
  */
 export function getSeparatorByDateFormat(format: IDateFormat = DATE_FORMAT.DAY): string {
-    return format === DATE_FORMAT.YEAR || format === DATE_FORMAT.DAY_TIME || format === DATE_FORMAT.MONTH_DAY || format === DATE_FORMAT.YEAR_MONTH || format === DATE_FORMAT.YEAR_QUARTER || format === DATE_FORMAT.YEAR_WEEK || format === DATE_FORMAT.DAY_HOUR|| format === DATE_FORMAT.HOUR_MINUTE || format === DATE_FORMAT.MINUTE_SECOND ? '' :
+    return format === DATE_FORMAT.YEAR || format === DATE_FORMAT.DAY_TIME || format === DATE_FORMAT.MONTH_DAY || format === DATE_FORMAT.YEAR_MONTH || format === DATE_FORMAT.YEAR_QUARTER || format === DATE_FORMAT.YEAR_WEEK || format === DATE_FORMAT.DAY_HOUR|| format === DATE_FORMAT.HOUR_MINUTE || format === DATE_FORMAT.MINUTE_SECOND ? ' ' :
         format === DATE_FORMAT.MONTH || format === DATE_FORMAT.QUARTER || format === DATE_FORMAT.WEEK || format === DATE_FORMAT.HOUR || format === DATE_FORMAT.MINUTE || format === DATE_FORMAT.SECOND ? ' ' :
             '/';
 }

package/src/dates/helpers/validateDate.ts

@@ -14,7 +14,7 @@ import { validateDateByDateFormat } from "./validateDateByDateFormat";
  * @param format String of the format to validate
  * @returns True if it is valid or not. Undefined if date is undefined
  */
- export function validateDate(date: string, format: IDateFormat = DATE_FORMAT.DAY): boolean {
+export function validateDate(date: string, format: IDateFormat = DATE_FORMAT.DAY): boolean {
     if (isEmpty(date)) return false;
     if (isTokenLabel(date)) return true;
 

package/src/dates/helpers/validateDateByDateFormat.ts

@@ -15,7 +15,7 @@ export function validateDateByDateFormat(date: string, dateFormat: IDateFormat =
     const separator = getSeparatorByDateFormat(dateFormat);
     const separatedDate = date.split(separator);
     const regularExpression = getDateFormatRegularExpressionInArray(dateFormat);
-  
+
     if (regularExpression.length !== separatedDate.length) return false;
   
     for (let i = 0; i < separatedDate.length; i++) {