Merge branch 'master' of https://github.com/haystack/nb

JumanaFM · JumanaFM · commit d4c9e34aa608 · 2021-04-14T22:04:12.000-04:00
diff --git a/.gitignore b/.gitignore
@@ -9,6 +9,7 @@ node_modules
 /uploads
 config.js
 email-config.js
+config/config.json
 
 # local env files
 .env.local
diff --git a/app.js b/app.js
@@ -10,6 +10,7 @@ const usersRouter = require('./routes/users');
 const classesRouter = require('./routes/classes');
 const filesRouter = require('./routes/files');
 const annotationsRouter = require('./routes/annotations');
+const spotlightsRouter = require('./routes/spotlights');
 const gradesRouter = require('./routes/grades');
 
 require('./auth/auth');
@@ -54,6 +55,7 @@ app.use('/api/users', usersRouter);
 app.use('/api/classes',     passport.authenticate('jwt', { session: false }), classesRouter);
 app.use('/api/files',       passport.authenticate('jwt', { session: false }), filesRouter);
 app.use('/api/annotations', passport.authenticate('jwt', { session: false }), annotationsRouter);
+app.use('/api/spotlights',  passport.authenticate('jwt', { session: false }), spotlightsRouter);
 app.use('/api/grades',      passport.authenticate('jwt', { session: false }), gradesRouter);
 
 // Handle errors.
diff --git a/config/config.json b/config/config.json
diff --git a/migrations/20201214220840-user-email-unique.js b/migrations/20201214220840-user-email-unique.js
@@ -12,6 +12,8 @@ module.exports = {
   },
 
   down: async (queryInterface, Sequelize) => {
-
+    return Promise.all([
+      queryInterface.removeConstraint('users', 'custom_unique_constraint_name')
+    ])
   }
 };
diff --git a/migrations/20201216031909-add_delete_column.js b/migrations/20201216031909-add_delete_column.js
@@ -15,11 +15,8 @@ module.exports = {
   },
 
   down: async (queryInterface, Sequelize) => {
-    /**
-     * Add reverting commands here.
-     *
-     * Example:
-     * await queryInterface.dropTable('users');
-     */
+    return Promise.all([
+      queryInterface.removeColumn('file_system_objects', 'deleted')
+    ])
   }
 };
diff --git a/migrations/20201218201543-add-reset-password-field.js b/migrations/20201218201543-add-reset-password-field.js
@@ -16,5 +16,8 @@ module.exports = {
 
   },
   down: async (queryInterface, Sequelize) => {
+    return Promise.all([
+      queryInterface.removeColumn('users', 'reset_password_id')
+    ])
   }
 };
diff --git a/migrations/20210104010943-class-section-unique.js b/migrations/20210104010943-class-section-unique.js
@@ -9,5 +9,9 @@ module.exports = {
     });
   },
   
-  down: async (queryInterface, Sequelize) => {}
+  down: async (queryInterface, Sequelize) => {
+    return Promise.all([
+      queryInterface.removeConstraint('sections', 'section_name_classid_key')
+    ])
+  }
 };
diff --git a/migrations/20210316060205-create-spotlights.js b/migrations/20210316060205-create-spotlights.js
@@ -0,0 +1,30 @@
+'use strict';
+
+module.exports = {
+    up: async (queryInterface, Sequelize) => {
+        await queryInterface.createTable('spotlights', {
+            id: {
+                allowNull: false,
+                defaultValue: Sequelize.UUIDV1,
+                primaryKey: true,
+                type: Sequelize.UUID
+            },
+            type: {
+                type: Sequelize.ENUM,
+                values: ['NONE', 'IN', 'ABOVE', 'BELLOW', 'LEFT', 'RIGHT', 'EM', 'MARGIN']
+            },
+            created_at: {
+                allowNull: false,
+                type: Sequelize.DATE
+            },
+            updated_at: {
+                allowNull: false,
+                type: Sequelize.DATE
+            }
+        });
+    },
+    down: async (queryInterface, Sequelize) => {
+        await queryInterface.dropTable('spotlights');
+        await queryInterface.sequelize.query('DROP TYPE IF EXISTS "enum_spotlights_type";');
+    }
+};
diff --git a/migrations/20210316060756-add-anno-spot-association.js b/migrations/20210316060756-add-anno-spot-association.js
@@ -0,0 +1,18 @@
+'use strict';
+
+module.exports = {
+    up: async (queryInterface, Sequelize) => {
+        await queryInterface.addColumn('spotlights', 'annotation_id', {
+            type: Sequelize.UUID,
+            references: {
+                model: 'annotations',
+                key: 'id',
+            },
+            onDelete: 'CASCADE',
+        });
+    },
+    
+    down: async (queryInterface, Sequelize) => {
+        await queryInterface.removeColumn('spotlights', 'annotation_id');
+    }
+};
diff --git a/migrations/20210316072451-add-spotlights-anno-constraint.js b/migrations/20210316072451-add-spotlights-anno-constraint.js
@@ -0,0 +1,16 @@
+'use strict';
+
+module.exports = {
+    up: async (queryInterface, Sequelize) => {
+        await queryInterface.addConstraint('spotlights', { 
+            fields: ['annotation_id'],
+            type: 'unique',
+            name: 'annotation_id_key'
+        });
+        
+    },
+    
+    down: async (queryInterface, Sequelize) => {
+        queryInterface.removeConstraint('spotlights', 'annotation_id_key')
+    }
+};
diff --git a/migrations/20210404212051-create-spotlightlogs.js b/migrations/20210404212051-create-spotlightlogs.js
@@ -0,0 +1,41 @@
+'use strict';
+
+module.exports = {
+    up: async (queryInterface, Sequelize) => {
+        await queryInterface.createTable('spotlight_logs', {
+            id: {
+                allowNull: false,
+                defaultValue: Sequelize.UUIDV1,
+                primaryKey: true,
+                type: Sequelize.UUID
+            },
+            action: {
+                type: Sequelize.ENUM,
+                values: ['CLICK', 'HOVER', 'STAR', 'REPLY_REQUEST', 'BOOKMARK', 'REPLY', 'SESSION_START', 'SESSION_END']
+            },
+            type: {
+                type: Sequelize.ENUM,
+                values: ['NONE', 'IN', 'ABOVE', 'BELLOW', 'LEFT', 'RIGHT', 'EM', 'MARGIN', 'LIST', 'HIGHLIGHT']
+            },
+            role: {
+                type: Sequelize.ENUM,
+                values: ['INSTRUCTOR', 'STUDENT']
+            },
+            created_at: {
+                allowNull: false,
+                type: Sequelize.DATE
+            },
+            updated_at: {
+                allowNull: false,
+                type: Sequelize.DATE
+            }
+        });
+    },
+    
+    down: async (queryInterface, Sequelize) => {
+        await queryInterface.dropTable('spotlight_logs');
+        await queryInterface.sequelize.query('DROP TYPE IF EXISTS "enum_spotlight_logs_action";');
+        await queryInterface.sequelize.query('DROP TYPE IF EXISTS "enum_spotlight_logs_type";');
+        await queryInterface.sequelize.query('DROP TYPE IF EXISTS "enum_spotlight_logs_role";');
+    }
+};
diff --git a/migrations/20210404212704-add-spotlog-associations.js b/migrations/20210404212704-add-spotlog-associations.js
@@ -0,0 +1,53 @@
+'use strict';
+
+module.exports = {
+    up: async (queryInterface, Sequelize) => {
+        await queryInterface.addColumn('spotlight_logs', 'spotlight_id', {
+            type: Sequelize.UUID,
+            references: {
+                model: 'spotlights',
+                key: 'id',
+            },
+        });
+        await queryInterface.addColumn('spotlight_logs', 'annotation_id', {
+            type: Sequelize.UUID,
+            references: {
+                model: 'annotations',
+                key: 'id',
+            },
+            onDelete: 'CASCADE',
+        });
+        await queryInterface.addColumn('spotlight_logs', 'user_id', {
+            type: Sequelize.UUID,
+            references: {
+                model: 'users',
+                key: 'id',
+            },
+            onDelete: 'CASCADE',
+        });
+        await queryInterface.addColumn('spotlight_logs', 'class_id', {
+            type: Sequelize.UUID,
+            references: {
+                model: 'classes',
+                key: 'id',
+            },
+            onDelete: 'CASCADE',
+        });
+        await queryInterface.addColumn('spotlight_logs', 'source_id', {
+            type: Sequelize.UUID,
+            references: {
+                model: 'sources',
+                key: 'id',
+            },
+            onDelete: 'CASCADE',
+        });
+    },
+    
+    down: async (queryInterface, Sequelize) => {
+        await queryInterface.removeColumn('spotlight_logs', 'spotlight_id');
+        await queryInterface.removeColumn('spotlight_logs', 'annotation_id');
+        await queryInterface.removeColumn('spotlight_logs', 'user_id');
+        await queryInterface.removeColumn('spotlight_logs', 'class_id');
+        await queryInterface.removeColumn('spotlight_logs', 'source_id');
+    }
+};
diff --git a/migrations/20210412053504-create-nb-config.js b/migrations/20210412053504-create-nb-config.js
@@ -0,0 +1,27 @@
+'use strict';
+
+module.exports = {
+    up: async (queryInterface, Sequelize) => {
+        await queryInterface.createTable('nb_configs', {
+            name: {
+                type: Sequelize.STRING,
+                unique: true,
+                allowNull: false
+            },
+            value: {
+                type: Sequelize.STRING,
+                unique: false,
+                allowNull: false
+            },
+            description: {
+                type: Sequelize.STRING,
+                unique: false,
+                allowNull: true
+            },
+        });
+    },
+    
+    down: async (queryInterface, Sequelize) => {
+        await queryInterface.dropTable('nb_configs');
+    }
+};
diff --git a/migrations/20210412064427-insert-spotlight-configs.js b/migrations/20210412064427-insert-spotlight-configs.js
@@ -0,0 +1,23 @@
+'use strict';
+
+module.exports = {
+    up: async (queryInterface, Sequelize) => {
+        queryInterface.bulkInsert('nb_configs', [{
+            name: 'SPOTLIGHT_INNOTATION',
+            value: 'false',
+            description: 'Enable/Disable spotlight (INNOTATION)'
+        }, {
+            name: 'SPOTLIGHT_EM',
+            value: 'false',
+            description: 'Enable/Disable spotlight (EM)'
+        }, {
+            name: 'SPOTLIGHT_MARGIN',
+            value: 'false',
+            description: 'Enable/Disable spotlight (MARGIN)'
+        }, ]);
+    },
+    
+    down: async (queryInterface, Sequelize) => {
+
+    }
+};
diff --git a/models/Annotations/Annotations.js b/models/Annotations/Annotations.js
@@ -35,6 +35,7 @@ const annotation = (sequelize, DataTypes) => {
         Annotation.belongsToMany(models.User, {as:'TaggedUsers', through:'user_tags' , onDelete: 'CASCADE'});
         Annotation.belongsToMany(models.User, {as:'Bookmarkers', through:'bookmarks' , onDelete: 'CASCADE'});
         Annotation.belongsToMany(models.User, {as:'Starrers', through:'stars' , onDelete: 'CASCADE'});
+        Annotation.hasOne(models.Spotlight, {as: 'Spotlight', foreignKey:{name: 'annotation_id'}, onDelete: 'CASCADE'});
       }
     }
   });
diff --git a/models/NbConfig.js b/models/NbConfig.js
@@ -0,0 +1,27 @@
+const nbConfig = (sequelize, DataTypes) => {
+    const NbConfig = sequelize.define('nb_config', {
+        name: {
+            type: DataTypes.STRING,
+            unique: true,
+            allowNull: false
+        },
+        value: {
+            type: DataTypes.STRING,
+            unique: false,
+            allowNull: false
+        },
+        description: {
+            type: DataTypes.STRING,
+            unique: false,
+            allowNull: true
+        }
+    },
+    {
+        timestamps: false,
+        createdAt: false,
+        updatedAt: false,
+    });
+    return NbConfig;
+};
+
+module.exports = nbConfig;
diff --git a/models/Spotlights/Spotlights.js b/models/Spotlights/Spotlights.js
@@ -0,0 +1,23 @@
+const spotlight = (sequelize, DataTypes) => {
+    const Spotlight = sequelize.define('spotlight', {
+        id: {
+            type: DataTypes.UUID,
+            defaultValue: DataTypes.UUIDV1,
+            primaryKey: true
+        },
+        type: {
+            type: DataTypes.ENUM,
+            values: ['NONE', 'IN', 'ABOVE', 'BELLOW', 'LEFT', 'RIGHT', 'EM', 'MARGIN']
+        }
+    },
+    {
+        classMethods:{
+            associate: (models) => {
+                Spotlight.belongsTo(models.Annotation, {as: 'Annotation', foreignKey:{name: 'annotation_id'}, onDelete: 'CASCADE'});
+            }
+        }
+    });
+    return Spotlight;
+};
+
+module.exports = spotlight;
diff --git a/models/Spotlights/SpotlightsLog.js b/models/Spotlights/SpotlightsLog.js
diff --git a/models/index.js b/models/index.js
diff --git a/models/utils.js b/models/utils.js
diff --git a/public/nb_viewer.html b/public/nb_viewer.html
diff --git a/routes/annotations.js b/routes/annotations.js
diff --git a/routes/index.js b/routes/index.js
diff --git a/routes/spotlights.js b/routes/spotlights.js

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,8 @@ module.exports = {`
`12`	`12`	`},`
`13`	`13`
`14`	`14`	`down: async (queryInterface, Sequelize) => {`
`15`		`-`
	`15`	`+ return Promise.all([`
	`16`	`+ queryInterface.removeConstraint('users', 'custom_unique_constraint_name')`
	`17`	`+ ])`
`16`	`18`	`}`
`17`	`19`	`};`
Original file line number	Diff line number	Diff line change
`@@ -16,5 +16,8 @@ module.exports = {`
`16`	`16`
`17`	`17`	`},`
`18`	`18`	`down: async (queryInterface, Sequelize) => {`
	`19`	`+ return Promise.all([`
	`20`	`+ queryInterface.removeColumn('users', 'reset_password_id')`
	`21`	`+ ])`
`19`	`22`	`}`
`20`	`23`	`};`