Develop

backend/config/settings.js

@@ -1,17 +1,17 @@
-const constants = require("../src/utils/constants.helper");
+const constants = require('../src/utils/constants.helper');
 const userRole = constants.ROLE;
 
 module.exports = {
   user: {
     role: {
-      'admin': userRole.ADMIN,
-      'member': userRole.MEMBER
+      admin: userRole.ADMIN,
+      member: userRole.MEMBER,
     },
     roleEnum: [userRole.ADMIN, userRole.MEMBER],
     roleName: {
       [userRole.ADMIN]: 'admin',
-      [userRole.MEMBER]: 'member'
-    }
+      [userRole.MEMBER]: 'member',
+    },
   },
   team: {
     permissions: {
@@ -27,6 +27,36 @@ module.exports = {
       links: [userRole.ADMIN],
       tours: [userRole.ADMIN],
       helpers: [userRole.ADMIN],
-    }
-  }
+    },
+  },
+  tour: {
+    triggeringFrequency: [
+      'just once',
+      'once in every session',
+      'once every day',
+      'once every week',
+      'once every month',
+      'always',
+    ],
+    pageTargeting: ['equals to', 'is different from'],
+    themes: ['default theme'],
+  },
+  hint: {
+    action: ['no action', 'open url', 'open url in a new tab'],
+    repetition: ['show only once', 'show every visit'],
+    tooltipPlacement: ['top', 'right', 'bottom', 'left'],
+  },
+  popup: {
+    action: ['no action', 'open url', 'open url in a new tab'],
+    repetition: ['show only once', 'show every visit'],
+    size: ['small', 'medium', 'large'],
+  },
+  banner: {
+    repetition: ['show only once', 'show every visit'],
+    position: ['top', 'bottom'],
+    action: ['no action', 'open url', 'open url in a new tab'],
+  },
+  token: {
+    type: ['auth', 'reset'],
+  },
 };

backend/migrations/0000-1.0-users.js

@@ -15,20 +15,20 @@ module.exports = {
           autoIncrement: true,
         },
         name: {
-          type: Sequelize.STRING(50),
+          type: Sequelize.STRING(63),
           allowNull: false,
         },
         surname: {
-          type: Sequelize.STRING(50),
+          type: Sequelize.STRING(63),
           allowNull: true,
         },
         email: {
-          type: Sequelize.STRING(100),
+          type: Sequelize.STRING(255),
           allowNull: false,
           unique: true,
         },
         password: {
-          type: Sequelize.STRING(100),
+          type: Sequelize.STRING(127),
           allowNull: false,
         },
         role: {

backend/migrations/0001-1.0-helperlink.js

@@ -18,17 +18,17 @@ module.exports = {
           allowNull: false,
         },
         headerBackgroundColor: {
-          type: Sequelize.STRING(7),
+          type: Sequelize.STRING(15),
           allowNull: false,
           defaultValue : '#F8F9F8'
         },
         linkFontColor: {
-          type: Sequelize.STRING(7),
+          type: Sequelize.STRING(15),
           allowNull: false,
           defaultValue : '#344054'
         },
         iconColor: {
-          type: Sequelize.STRING(7),
+          type: Sequelize.STRING(15),
           allowNull: false,
           defaultValue: '#7F56D9'
         },

backend/migrations/0004-1.0-tokens.js

@@ -6,40 +6,68 @@ module.exports = {
   up: async (queryInterface, Sequelize) => {
     const transaction = await queryInterface.sequelize.transaction();
     try {
-      await queryInterface.createTable(TABLE_NAME, {
-        id: {
-          type: Sequelize.INTEGER,
-          primaryKey: true,
-          autoIncrement: true,
-          allowNull: false,
-        },
-        token: {
-          type: Sequelize.STRING(500),
-          allowNull: false,
-        },
-        userId: {
-          type: Sequelize.INTEGER,
-          allowNull: false,
-          references: {
-            model: 'users',
-            key: 'id'
-          }
-        },
-        type: {
-          type: Sequelize.STRING(10),
-          allowNull: false,
-        },
-        expiresAt: {
-          type: Sequelize.DATE,
-          allowNull: true,
+      await queryInterface.createTable(
+        TABLE_NAME,
+        {
+          id: {
+            type: Sequelize.INTEGER,
+            primaryKey: true,
+            autoIncrement: true,
+            allowNull: false,
+          },
+          token: {
+            type: Sequelize.STRING(500),
+            allowNull: false,
+          },
+          userId: {
+            type: Sequelize.INTEGER,
+            allowNull: false,
+            references: {
+              model: 'users',
+              key: 'id',
+            },
+          },
+          type: {
+            type: Sequelize.STRING(10),
+            allowNull: false,
+          },
+          expiresAt: {
+            type: Sequelize.DATE,
+            allowNull: true,
+          },
+          createdAt: {
+            type: Sequelize.DATE,
+            allowNull: false,
+            defaultValue: Sequelize.literal('CURRENT_TIMESTAMP'),
+          },
         },
-        createdAt: {
-          type: Sequelize.DATE,
+        { transaction }
+      );
+
+      const [allTokens] = await queryInterface.sequelize.query(`SELECT * FROM ${TABLE_NAME}`, { transaction });
+      await queryInterface.removeColumn(TABLE_NAME, 'type', { transaction });
+
+      await queryInterface.addColumn(
+        TABLE_NAME,
+        'type',
+        {
+          type: Sequelize.ENUM('auth', 'reset'),
           allowNull: false,
-          defaultValue: Sequelize.literal("CURRENT_TIMESTAMP"),
+          defaultValue: 'auth',
         },
-
-      }, { transaction });
+        { transaction }
+      );
+
+      if (allTokens.length > 0) {
+        await Promise.all(
+          allTokens.map(async (val) => {
+            await queryInterface.sequelize.query('UPDATE :table SET type = :type WHERE id = :id', {
+              replacements: { table: TABLE_NAME, type: val.type, id: val.id },
+              transaction,
+            });
+          })
+        );
+      }
 
       // Commit the transaction
       await transaction.commit();
@@ -63,5 +91,5 @@ module.exports = {
       await transaction.rollback();
       throw error;
     }
-  }
+  },
 };

backend/migrations/0005-1.0-banner.js

@@ -6,58 +6,122 @@ module.exports = {
   up: async (queryInterface, Sequelize) => {
     const transaction = await queryInterface.sequelize.transaction();
     try {
-      await queryInterface.createTable(TABLE_NAME, {
-        id: {
-          allowNull: false,
-          autoIncrement: true,
-          primaryKey: true,
-          type: Sequelize.INTEGER
-        },
-        closeButtonAction: {
-          type: Sequelize.STRING(255),
-          allowNull: false
-        },
-        repetitionType: {
-          type: Sequelize.STRING(255),
-          allowNull: false,
-          defaultValue: 'show only once'
-        },
-        position: {
-          type: Sequelize.STRING(255),
-          allowNull: false
-        },
-        url: {
-          type: Sequelize.STRING(255),
-          allowNull: true
+      await queryInterface.createTable(
+        TABLE_NAME,
+        {
+          id: {
+            type: Sequelize.INTEGER,
+            primaryKey: true,
+            autoIncrement: true,
+            allowNull: false,
+          },
+
+          closeButtonAction: {
+            type: Sequelize.STRING(31),
+            allowNull: false,
+          },
+          repetitionType: {
+            type: Sequelize.STRING(31),
+            allowNull: false,
+            defaultValue: 'show only once',
+          },
+          position: {
+            type: Sequelize.STRING(31),
+            allowNull: false,
+          },
+          url: {
+            type: Sequelize.STRING(255),
+            allowNull: true,
+          },
+          fontColor: {
+            type: Sequelize.STRING(15),
+            allowNull: false,
+            defaultValue: '#FFFFFF',
+          },
+          backgroundColor: {
+            type: Sequelize.STRING(15),
+            allowNull: false,
+            defaultValue: '#FFFFFF',
+          },
+          bannerText: {
+            type: Sequelize.STRING(511),
+            allowNull: false,
+            defaultValue: '',
+          },
+          actionUrl: {
+            type: Sequelize.STRING(255),
+            allowNull: true,
+          },
+          createdBy: {
+            type: Sequelize.INTEGER,
+            allowNull: false,
+            references: {
+              model: 'users',
+              key: 'id',
+            },
+          },
         },
-        fontColor: {
-          type: Sequelize.STRING(255),
+        { transaction }
+      );
+
+      const [allBanners] = await queryInterface.sequelize.query(`SELECT * FROM ${TABLE_NAME}`, { transaction });
+      await queryInterface.removeColumn(TABLE_NAME, 'closeButtonAction', { transaction });
+
+      // Add the new column with ENUM type
+      await queryInterface.addColumn(
+        TABLE_NAME,
+        'closeButtonAction',
+        {
+          type: Sequelize.ENUM('no action', 'open url', 'open url in a new tab'),
           allowNull: false,
-          defaultValue: "#FFFFFF"
+          defaultValue: 'no action',
         },
-        backgroundColor: {
-          type: Sequelize.STRING(255),
+        { transaction }
+      );
+
+      await queryInterface.removeColumn(TABLE_NAME, 'repetitionType', { transaction });
+
+      // Add the new column with ENUM type
+      await queryInterface.addColumn(
+        TABLE_NAME,
+        'repetitionType',
+        {
+          type: Sequelize.ENUM('show only once', 'show every visit'),
           allowNull: false,
-          defaultValue: "#FFFFFF"
+          defaultValue: 'show only once',
         },
-        bannerText: {
-          type: Sequelize.STRING(255),
+        { transaction }
+      );
+
+      await queryInterface.removeColumn(TABLE_NAME, 'position', { transaction });
+
+      // Add the new column with ENUM type
+      await queryInterface.addColumn(
+        TABLE_NAME,
+        'position',
+        {
+          type: Sequelize.ENUM('top', 'bottom'),
           allowNull: false,
-          defaultValue: ""
-        },
-        actionUrl: {
-          type: Sequelize.STRING(255),
-          allowNull: true
+          defaultValue: 'top',
         },
-        createdBy: {
-          type: Sequelize.INTEGER,
-          allowNull: false,
-          references: {
-            model: 'users',
-            key: 'id'
-          }
-        }
-      }, { transaction });
+        { transaction }
+      );
+
+      if (allBanners.length > 0) {
+        const updates = allBanners.map(val => ({
+          id: val.id,
+          closeButtonAction: val.closeButtonAction,
+          repetitionType: val.repetitionType,
+          position: val.position
+        }));
+
+        await queryInterface.bulkUpdate(
+          TABLE_NAME,
+          updates,
+          null,
+          { transaction }
+        );
+      }
 
       // Commit the transaction
       await transaction.commit();
@@ -71,13 +135,15 @@ module.exports = {
   down: async (queryInterface, Sequelize) => {
     const transaction = await queryInterface.sequelize.transaction();
     try {
+      // Drop the guide_logs table
       await queryInterface.dropTable(TABLE_NAME, { transaction });
+
       // Commit the transaction
       await transaction.commit();
     } catch (error) {
       // Rollback the transaction in case of an error
       await transaction.rollback();
       throw error;
     }
-  }
+  },
 };