@qrvey/utils 1.2.9-35 → 1.2.9-36

package/scripts/publishing/index.js

@@ -0,0 +1,204 @@
+/**
+ * New version for publishing a new version of Qrvey Utils
+ * 1- Publish the version with np
+ * 2- Update the README.md doc with doxdox
+ */
+
+const fs = require('fs');
+const util = require('util');
+const childProcess = require('child_process');
+const exec = util.promisify(childProcess.exec);
+const spawn = childProcess.spawn;
+const proc = require('process');
+const readline = require("readline");
+const { exit } = require('process');
+const rl = readline.createInterface({
+    input: proc.stdin,
+    output: proc.stdout
+});
+const question = util.promisify(rl.question).bind(rl);
+
+
+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 spawning(command, sArguments) {
+    let newProcess;
+    await new Promise(function (resolve, reject) {
+        newProcess = spawn(command, sArguments, { shell: true });
+        newProcess.stdout.on("data", data => {
+            console.log(`stdout: ${data}`);
+        });
+        
+        newProcess.stderr.on("data", data => {
+            console.log(`stderr: ${data}`);
+        });
+        
+        newProcess.on('error', (_error) => {
+            newProcess.stdin.pause();
+            newProcess.stdin.destroy();
+            newProcess.stdout.pause();
+            newProcess.stdout.destroy();
+            newProcess.kill();
+            reject();
+        });
+        
+        newProcess.on("close", code => {
+            newProcess.stdin.pause();
+            newProcess.stdin.destroy();
+            newProcess.stdout.pause();
+            newProcess.stdout.destroy();
+            newProcess.kill();
+            if (code == '1') {
+                reject();
+            }
+            resolve();
+        });
+    });
+}
+
+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 = question('No version provided. Type the new version: ');
+    }
+    console.log('**** Version to publish: ' + newVersion);
+    return newVersion;
+}
+
+async function cleaningProject(settings) {
+    console.log('==>>> Cleaning project...');
+    await execute(`rm -f ${settings.packageLockPath}`);
+    await execute(`rm -f -R ${settings.nodeModulesPath}`);
+    await execute(`rm -f -R ${settings.distPath}`);
+}
+
+async function buildingBundle(_settings) {
+    console.log('==>>> Installing Dependencies...');
+    await execute('npm install');
+
+    console.log('==>>> Generating Build...');
+    await execute('npm run build');
+}
+
+async function startPublishingVersion(settings) {
+    await callingPublisher(settings);
+}
+
+async function callingPublisher(settings) {
+    console.log('==>>> Calling Publisher');
+    let anyBranch = '', tag = '';
+    const anyBranchIndex = proc.argv.findIndex(function (argv) { return argv.includes('--np-any-branch='); });
+    const tagIndex = proc.argv.findIndex(function (argv) { return argv.includes('--np-tag='); });
+    if (anyBranchIndex > -1) {
+        const anyBranchArg = proc.argv[anyBranchIndex].split('--np-any-branch=');
+        anyBranch = anyBranchArg[1] == null || anyBranchArg[1] === '' ? '' : '--any-branch';
+    }
+    if (tagIndex > -1) {
+        const tagArg = proc.argv[tagIndex].split('--np-tag=');
+        tag = tagArg[1] == null || tagArg[1] === '' ? '' : proc.argv[tagIndex].replace('--np-tag=', '--tag=');
+    }
+    await spawning(`np ${settings.newVersion}`, [anyBranch, tag]);
+}
+
+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 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}`);
+}
+
+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() {
+    let settings = {
+        currentVersion: '',
+        distPath: './dist',
+        docsPath: './README.md',
+        docsFileName: 'README.md',
+        newVersion: undefined,
+        nodeModulesPath: './node_modules',
+        packageFileName: 'package.json',
+        packageLockPath: './package-lock.json',
+        packagePath: './package.json',
+        
+    };
+
+    console.log('Welcome. The publishing operationg will begin.');
+    try {
+        settings["currentVersion"] = await getPackageJson(settings);
+        settings["newVersion"] = await getNewVersion();
+
+        await cleaningProject(settings);
+        await buildingBundle(settings);
+        await startGeneratingDocs(settings);
+        await startPublishingVersion(settings);
+        console.info('Finished Publishing');
+    } catch (err) {
+        console.error('Error: ', err);
+        await revertChanges(settings);
+    } finally {
+        console.log('Execution finished');
+        exit();
+    }
+}
+
+init();

package/src/columns/constants/COLUMN_LABEL.ts

@@ -17,6 +17,7 @@ export const COLUMN_LABEL = {
 	CHECKLIST: 'Check List',
 	NPS_SCORE: 'NPS Score',
 	NPS_FEEDBACK: 'NPS Feedback',
+	TEXT: 'Text',
 	TEXT_LABEL: 'Text Label',
 	TEXT_CATEGORY: 'Text Category',
 	LOOKUP: 'Lookup',

package/src/columns/constants/COLUMN_PROPERTY_INFO.ts

@@ -12,7 +12,7 @@ import { DATE_DISTINCT_TIME_PROPERTY_INFO_LIST } from "../../dates/constants/DAT
 export const COLUMN_PROPERTY_INFO: { [key in IColumnType]?: IColumnPropertyInfo[] } = {
   [COLUMN.LOOKUP]: [
     { value: COLUMN_PROPERTY.LOOKUP_DISPLAY, label: 'Display', shortLabel: 'Display', abbrLabel: 'DSY', displayed: true, i18nLabelPath: 'common.properties.lookup_display_label' },
-    { value: COLUMN_PROPERTY.LOOKUP_VALUE, label: 'Value', shortLabel: 'Value', abbrLabel: 'Val', displayed: true, i18nLabelPath: 'common.properties.lookup_display_value' }
+    { value: COLUMN_PROPERTY.LOOKUP_VALUE, label: 'Value', shortLabel: 'Value', abbrLabel: 'Val', displayed: true, i18nLabelPath: 'common.properties.lookup_value_label' }
   ],
   [COLUMN.DATE]: [
     ...DATE_GROUPING_PROPERTY_INFO_LIST,

package/src/format/format.ts

@@ -6,8 +6,9 @@ import { isEmpty } from '../general/mix/isEmpty';
 import { _get } from '../general/object/get';
 import { COLUMN } from '../columns/constants/COLUMN';
 import { FORMULA } from '../formulas/constants/FORMULA';
-import { IFormatConfig } from '..';
 import { formatWithLocale } from './localization';
+import { isObject } from '../general/object/isObject';
+import { IFormatConfig } from '../interfaces/format/IFormatConfig.Interface';
 
 dayjs.extend(advancedFormat); // Add support to advanced formats https://day.js.org/docs/en/plugin/advanced-format
 
@@ -21,6 +22,7 @@ function isValidDateString(dateString = '') {
 }
 
 export function formatDate(dateString, format) {
+    if(isObject(format)) format = format.format || "";
     if (isEmpty(dateString) || !isNaN(dateString) || format === 'Default') return dateString;
     if (!isValidDateString(dateString)) return dateString;
     const dateValue = dateString?.replace(/Z$/i, '');

package/src/globalization/interfaces/chart_builder/II18nChartBuilderTableStyleOptions.ts

@@ -1,4 +1,10 @@
 export interface II18nChartBuilderTableStyleOptions {
+    align: string,
+    align_all_columns: string,
+    align_default: string,
+    align_left: string,
+    align_right: string,
+    align_center: string,
     typeface: string;
     weight: string;
     weight_bold: string;

package/src/globalization/interfaces/common/II18nColumnTypes.ts

@@ -20,6 +20,7 @@ export interface II18nColumnTypes {
     checklist_label: string;
     nps_score_label: string;
     nps_feedback_label: string;
+    text_label: string;
     text_label_label: string;
     text_category_label: string;
     lookup_label: string;

package/src/globalization/interfaces/dashboard/II18nDashboardToast.ts

@@ -3,4 +3,5 @@ export interface II18nDashboardToast {
     delete_record_message: string;
     add_record_message: string;
     data_views_updated_message: string;
+    failed_download: string;
 }

package/src/globalization/interfaces/formula_builder/II18nFormulaBuilderDeleteDialog.ts

@@ -1,7 +1,7 @@
 export interface II18nFormulaBuilderDeleteDialog {
-    title: string;
+    apply_button: string;
+    cancel_button: string;
     description: string;
+    title: string;
     toast_description: string;
-    cancel_button: string;
-    apply_button: string;
 }

package/src/globalization/interfaces/formula_builder/II18nFormulaBuilderListTable.ts

@@ -1,9 +1,9 @@
 export interface II18nFormulaBuilderListTable{
-    name: string;
-    formula: string;
-    menu_edit: string;
-    menu_duplicate: string;
-    menu_delete: string;
     duplicate_copy: string;
     duplicate_toast: string
+    formula: string;
+    menu_delete: string;
+    menu_duplicate: string;
+    menu_edit: string;
+    name: string;
 }

package/src/globalization/interfaces/style_themes/II18nStyleThemesTheme.ts

@@ -13,10 +13,12 @@ export interface II18nStyleThemesTheme {
     legends: string;
     main_color: string;
     name_placeholder: string;
+    panel_background: string;
     panel_styles: string;
     qrvey_theme: string;
     restore_to_default: string;
     save_theme: string;
+    show_title: string;
     table_header_styles: string;
     text_styles: string;
     tooltips: string;

package/src/globalization/labels/chart_builder/I18N_CHART_BUILDER_STYLE_OPTIONS.ts

@@ -188,6 +188,12 @@ export const I18N_CHART_BUILDER_STYLE_OPTIONS: Pick<II18nChartBuilder, StyleOpti
         target_value: 'Target Value'
     },
     table_style_options: {
+        align: 'Align',
+        align_all_columns: 'All Columns',
+        align_default: 'Default',
+        align_left: 'Align Left',
+        align_right: 'Align Right',
+        align_center: 'Align Center',
         typeface: 'Typeface', 
         weight: 'Weight',
         weight_bold: 'Bold',

package/src/globalization/labels/common/I18N_COLUMN_LABEL.ts

@@ -21,6 +21,7 @@ export const I18N_COLUMN_LABEL = {
     checklist_label: COLUMN_LABEL.CHECKLIST,
     nps_score_label: COLUMN_LABEL.NPS_SCORE,
     nps_feedback_label: COLUMN_LABEL.NPS_FEEDBACK,
+    text_label: COLUMN_LABEL.TEXT,
     text_label_label: COLUMN_LABEL.TEXT_LABEL,
     text_category_label: COLUMN_LABEL.TEXT_CATEGORY,
     lookup_label: COLUMN_LABEL.LOOKUP,

package/src/globalization/labels/dashboard/I18N_DASHBOARD.ts

@@ -25,6 +25,7 @@ export const I18N_DASHBOARD: II18nDashboard = {
         data_views_updated_message: 'Data views updated successfully.',
         delete_record_message: 'Record Successfully Deleted.',
         refresh_table_message: 'Record Successfully Edited.',
+        failed_download: 'The file(s) could not be exported at this time.',
     },
     tooltips: {
         buckets: "Buckets",

package/src/globalization/labels/formula_builder/I18N_FORMULA_BUILDER.ts

@@ -9,20 +9,20 @@ export const I18N_FORMULA_BUILDER: II18nFormulaBuilder = {
         information_text_text: 'create and work with formulas',
     },
     list_table: {
-        name: 'Formula Name',
+        duplicate_copy: 'Copy',
+        duplicate_toast: 'Formula Duplicated Successfully',
         formula: 'Formula',
-        menu_edit: 'Edit',
-        menu_duplicate: 'Duplicate',
         menu_delete: 'Delete',
-        duplicate_copy: 'Copy',
-        duplicate_toast: 'Formula Successfully Duplicated'
+        menu_duplicate: 'Duplicate',
+        menu_edit: 'Edit',
+        name: 'Formula Name'
     },
     delete_dialog: {
-        title: 'Delete Formula',
-        description: 'Deleting this formula will remove all instances of this calculation in your analytics.',
-        toast_description: 'Formula Successfully Deleted',
+        apply_button: 'Delete',
         cancel_button: 'Cancel',
-        apply_button: 'Delete'
+        description: 'Deleting this formula will remove all instances of this calculation in your analytics.',
+        title: 'Delete Formula',
+        toast_description: 'Formula Deleted Successfully'
     },
     create_modal: {
         title_header_create: 'Create Formula',

package/src/globalization/labels/style_themes/I18N_STYLE_THEMES.ts

@@ -37,10 +37,12 @@ export const I18N_STYLE_THEMES: II18nStyleThemes = {
       legends: 'Legends',
       main_color: 'Main Color',
       name_placeholder: 'Type name',
+      panel_background: 'Panel Background',
       panel_styles: 'Panel Styles',
       qrvey_theme: 'Qrvey Theme',
       restore_to_default: 'Restore to Default',
       save_theme: 'Save Theme',
+      show_title: 'Show Title',
       table_header_styles: 'Table Header Styles',
       text_styles: 'Text Styles',
       tooltips: 'Tooltips',