@sera4/essentia 1.1.63 → 1.1.64

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sera4/essentia",
-  "version": "1.1.63",
+  "version": "1.1.64",
   "description": "A library of utilities for Teleporte Web Services",
   "main": "index.js",
   "type": "module",

package/paginator/sql-pagination.js

@@ -4,7 +4,7 @@ class SequelizePaginator {
 
   constructor() {
     this.paginateIn = {
-      size: "page_size", 
+      size: "page_size",
       index: "page_index"
     };
     this.paginateOut = {
@@ -99,11 +99,11 @@ class SequelizePaginator {
         links[this.paginateOut["first_page"]] = `${resource}?${this.paginateIn["index"]}=${firstPageIndex}&${this.paginateIn["size"]}=${data[this.paginateOut["page_size"]]}`;
         links[this.paginateOut["last_page"]] = `${resource}?${this.paginateIn["index"]}=${lastPageIndex}&${this.paginateIn["size"]}=${data[this.paginateOut["page_size"]]}`;
         if (!data[this.paginateOut["first_page"]]) {
-          links[this.paginateOut["previous_page"]] = 
+          links[this.paginateOut["previous_page"]] =
           `${resource}?${this.paginateIn["index"]}=${data[this.paginateOut["previous_page"]]}&${this.paginateIn["size"]}=${data[this.paginateOut["page_size"]]}`;
-        } 
+        }
         if (!data[this.paginateOut["last_page"]]) {
-          links[this.paginateOut["next_page"]] = 
+          links[this.paginateOut["next_page"]] =
           `${resource}?${this.paginateIn["index"]}=${data[this.paginateOut["next_page"]]}&${this.paginateIn["size"]}=${data[this.paginateOut["page_size"]]}`;
         }
         data[linksKey] = links;
@@ -114,13 +114,13 @@ class SequelizePaginator {
     const getPaginationData = (result) => {
       var currentPage = this.zeroBasedOffset ? pagination.offset : pagination.offset + 1;
       var outOfBounds = result.rows.length === 0;
-      
+
       // For queries with aggregation (Group By, Count), sequelize findAndCountAll returns an array of objects instead of just an integer
       // To avoid implementing a custom findAndCountAll, we just use the array's Length
       if (Array.isArray(result.count)) {
         result.count = result.count.length;
       }
-      
+
       var totalPages = Math.ceil(result.count / pagination.limit);
       var data = {};
       data[this.paginateOut["current_page"]] = currentPage;
@@ -175,4 +175,4 @@ class SequelizePaginator {
 }
 
 const sqlPaginator = new SequelizePaginator();
-export default sqlPaginator;
+export default sqlPaginator;

package/paper-trail/index.js

@@ -33,6 +33,7 @@ paperTrail.init = (sequelize, sequelizePackage, optionsArg) => {
 		],
 		// additional fields to exclude on a global basis
 		excludeExtras: [],
+		excludeVirtualAttributes: true, // by default do not record these
 		censor: ["password", "password_salt", "temp_secret", "mfa_totp_secret"],
 		revisionAttribute: 'revision',
 		revisionModel: 'Revision',
@@ -107,6 +108,7 @@ paperTrail.init = (sequelize, sequelizePackage, optionsArg) => {
 
 			let previousVersion = _.cloneDeep(instance._previousDataValues);
 			let currentVersion = _.cloneDeep(instance.dataValues);
+
 			if (!destroyOperation && options.enableCompression) {
 				_.forEach(opt.fields, a => {
 					previousVersion[a] = instance._previousDataValues[a];
@@ -116,18 +118,23 @@ paperTrail.init = (sequelize, sequelizePackage, optionsArg) => {
 				previousVersion = instance._previousDataValues;
 				currentVersion = instance.dataValues;
 			}
-			// Supported nested models.
+
+			const excludes = options.exclude.concat([...this.extraRevisionAttributesExclude]);
+
+			// Supported nested models, allowing JSONB objects.
 			previousVersion = _.omitBy(
 				previousVersion,
-				i => i != null && typeof i === 'object' && !(i instanceof Date),
+				i => i != null && typeof i === 'object' && !(i instanceof Date || _.isPlainObject(i)),
 			);
-			previousVersion = _.omit(previousVersion, options.exclude);
+
+			previousVersion = _.omit(previousVersion, excludes);
 
 			currentVersion = _.omitBy(
 				currentVersion,
-				i => i != null && typeof i === 'object' && !(i instanceof Date),
+				i => i != null && typeof i === 'object' && !(i instanceof Date || _.isPlainObject(i)),
 			);
-			currentVersion = _.omit(currentVersion, options.exclude);
+
+			currentVersion = _.omit(currentVersion, excludes);
 
 			// Disallow change of revision
 			instance.set(
@@ -260,23 +267,26 @@ paperTrail.init = (sequelize, sequelizePackage, optionsArg) => {
 					currentVersion = instance.dataValues;
 				}
 
+				// we need to support nested Objects in a different way
+				// if the type of change is a nested object, we need to lookat the deltas and join the path with periods
+				// to get and show the differences.
+
 				// Supported nested models.
-				previousVersion = _.omitBy(
-					previousVersion,
-					i =>
-						i != null &&
-						typeof i === 'object' &&
-						!(i instanceof Date),
-				);
+				previousVersion = _.omitBy(previousVersion, value => {
+					if (value == null) return false; // keep null/undefined
+					if (value instanceof Date) return false; // keep Dates
+					if (_.isPlainObject(value)) return false; // keep plain objects (including nested objects)
+					return typeof value === 'object'; // omit if it's an object that's not plain or a Date
+				});
 				previousVersion = _.omit(previousVersion, options.exclude);
 
-				currentVersion = _.omitBy(
-					currentVersion,
-					i =>
-						i != null &&
-						typeof i === 'object' &&
-						!(i instanceof Date),
-				);
+				currentVersion = _.omitBy(currentVersion, value => {
+					if (value == null) return false;
+					if (value instanceof Date) return false;
+					if (_.isPlainObject(value)) return false;
+					return typeof value === 'object';
+				});
+
 				currentVersion = _.omit(currentVersion, options.exclude);
 
         const store = options.als && options.als.getStore()
@@ -287,6 +297,37 @@ paperTrail.init = (sequelize, sequelizePackage, optionsArg) => {
 						);
 				}
 
+				let objectsChanged = new Set();
+				// if the previous version or new version contain objects; push them onto this list
+				_.forEach(previousVersion, (value, key) => {
+					if (typeof(value) === 'object' ) {
+						objectsChanged.add(key);
+						// blank it so we can set it equal to ONLY the values changed in the next segment
+						previousVersion[key] = {};
+					}
+				});
+				_.forEach(currentVersion, (value, key) => {
+					if (typeof(value) === 'object' ) {
+						objectsChanged.add(key);
+						currentVersion[key] = {};
+					}
+				});
+
+
+				// we don't want to see a full object; we want to see only
+				// x.y.z -> value
+				if (delta && objectsChanged.size > 0 ) {
+					// the format of these are A,E,D,N (added, edited, deleted, new) for the kind
+					// the array is either the key or key + subkeys ['options','subkey','subkey2'] etc.
+					// {kind: 'E', path: Array(2), lhs: false, rhs: true}
+					for (const difference of delta) {
+						// blank the currentVersion[difference.path[0]]
+						// and previousVersion[difference.path[0]]
+						_.set(currentVersion, difference.path, difference.rhs);
+						_.set(previousVersion, difference.path, difference.lhs);
+					};
+				}
+
 				let document;
 				if (destroyOperation) {
 				 	document = { oldValues: currentVersion };
@@ -480,6 +521,15 @@ paperTrail.init = (sequelize, sequelizePackage, optionsArg) => {
 			// not sure if we need this
 			this.refreshAttributes();
 
+			this.extraRevisionAttributesExclude = new Set();
+			if (options.excludeVirtualAttributes) {
+				for (const attribute in this.rawAttributes) {
+					if (this.rawAttributes[attribute].type == "VIRTUAL") {
+						this.extraRevisionAttributesExclude.add(attribute);
+					}
+				}
+			}
+
 			if (options.enableMigration) {
 				const tableName = this.getTableName();
 
@@ -782,4 +832,4 @@ paperTrail.enableFailHard = () => {
 	failHard = true;
 };
 
-export default paperTrail;
+export default paperTrail;