@sera4/essentia 1.1.18 → 1.1.20

package/package.json

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

package/paper-trail/index.js

@@ -2,6 +2,7 @@ import * as jsdiff from 'diff';
 import _ from 'lodash';
 import helpers from './helpers.js';
 import paginator from "../paginator/sql-pagination.js";
+import { utils } from "../utils/index.js"
 
 let failHard = false;
 let als;
@@ -35,6 +36,8 @@ paperTrail.init = (sequelize, sequelizePackage, optionsArg) => {
 		revisionChangeModel: 'RevisionChange',
 		enableRevisionChangeModel: false,
 		UUID: false,
+		// does this project use int's and UUIDs for some references (postgres)
+		mixedDocumentReference: false,
 		underscored: false,
 		underscoredAttributes: false,
 		defaultAttributes: {
@@ -44,16 +47,22 @@ paperTrail.init = (sequelize, sequelizePackage, optionsArg) => {
 		als: null,
 		userModel: false,
 		userModelAttribute: 'userId',
+		tenantModel: false,
+		tenantModelAttribute: 'tenantId',
 		enableCompression: false,
 		enableMigration: false,
 		enableStrictDiff: true,
 		continuationNamespace: null,
 		continuationKey: 'userId',
+		continuationTenantKey: 'tenantId',
 		metaDataFields: null,
 		metaDataContinuationKey: 'metaData',
 		mysql: false,
 	};
 
+	if (optsArg.mixedDocumentReference)
+		defaultOptions.defaultAttributes.documentUuid = "documentUuid";
+
 	if (optsArg.underscoredAttributes) {
 		helpers.toUnderscored(defaultOptions.defaultAttributes);
 	}
@@ -316,7 +325,14 @@ paperTrail.init = (sequelize, sequelizePackage, optionsArg) => {
 				query[options.userModelAttribute] =
 					(store && store.get(options.continuationKey)) || opt.userId;
 
-				query[options.defaultAttributes.documentId] = instance.id;
+				query[options.tenantModelAttribute] =
+					(store && store.get(options.continuationTenantKey)) || opt.tenantId;
+
+				if (options.mixedDocumentReference && utils.isValidUuidV4(instance.id)) {
+					query[options.defaultAttributes.documentUuid] = instance.id;
+				} else {
+					query[options.defaultAttributes.documentId] = instance.id;
+				}
 
 				const revision = Revision.build(query);
 
@@ -472,13 +488,29 @@ paperTrail.init = (sequelize, sequelizePackage, optionsArg) => {
 			this.addHook('afterUpdate', createAfterHook('update'));
 
 			// create association
-			return this.hasMany(sequelize.models[options.revisionModel], {
-				foreignKey: options.defaultAttributes.documentId,
-				constraints: false,
-				scope: {
-					model: this.name,
-				},
-			});
+			if (options.mixedDocumentReference) {
+				this.hasMany(sequelize.models[options.revisionModel], {
+					constraints: false,
+					foreignKey: options.defaultAttributes.documentUuid,
+				});
+				this.hasMany(sequelize.models[options.revisionModel], {
+					foreignKey: options.defaultAttributes.documentId,
+					constraints: false,
+					scope: {
+						model: this.name,
+					},
+				});
+			} else {
+				return this.hasMany(sequelize.models[options.revisionModel], {
+					foreignKey: options.defaultAttributes.documentId,
+					constraints: false,
+					scope: {
+						model: this.name,
+					},
+				});
+			}
+
+
 		},
 	});
 
@@ -520,10 +552,20 @@ paperTrail.init = (sequelize, sequelizePackage, optionsArg) => {
 				allowNull: false,
 			};
 
-			attributes[options.userModelAttribute] = {
-				type: Sequelize.INTEGER,
-				allowNull: true
-			};
+			if (options.userModel) {
+				attributes[options.userModelAttribute] = {
+					type: options.UUID ? Sequelize.UUID : Sequelize.INTEGER,
+					allowNull: true
+				};
+			}
+
+			if (options.tenantModel) {
+				attributes[options.tenantModelAttribute] = {
+					type: options.UUID ? Sequelize.UUID : Sequelize.INTEGER,
+					allowNull: true
+				};
+			}
+
 
 			if (options.UUID) {
 				attributes.id = {
@@ -532,16 +574,42 @@ paperTrail.init = (sequelize, sequelizePackage, optionsArg) => {
 					defaultValue: Sequelize.UUIDV4,
 				};
 
-				attributes[options.defaultAttributes.documentId].type =
-					Sequelize.UUID;
+				if (!options.mixedDocumentReference)
+					attributes[options.defaultAttributes.documentId].type = Sequelize.UUID;
 
 				attributes[options.userModelAttribute].type = Sequelize.UUID;
 			}
 
+			if (options.mixedDocumentReference) {
+				attributes[options.defaultAttributes.documentId].allowNull = true;
+				attributes[options.defaultAttributes.documentUuid] = {
+					type: Sequelize.UUID,
+					allowNull: true
+				}
+			}
+
 			if (options.debug) {
 				log('attributes', attributes);
 			}
 
+			let indexes = [{
+				name: "document_reference_id",
+				fields: [options.defaultAttributes.documentId]
+			}];
+
+			if (options.userModel)
+				indexes.push({ fields: [options.userModelAttribute]});
+
+			if (options.tenantModel)
+				indexes.push({ fields: [options.tenantModelAttribute]});
+
+			if (options.mixedDocumentReference) {
+				indexes.push({
+					name: "document_reference_uuid",
+					fields: [options.defaultAttributes.documentUuid]
+				})
+			}
+
 			// Revision model
 			const Revision = sequelize.define(
 				options.revisionModel,
@@ -551,18 +619,43 @@ paperTrail.init = (sequelize, sequelizePackage, optionsArg) => {
 					tableName: options.tableName,
     			timestamps: true,
     			createdAt: options.underscored ? "created_at" : "createdAt",
-					updatedAt: options.underscored ? "updated_at" : "updatedAt"
+					updatedAt: options.underscored ? "updated_at" : "updatedAt",
+					indexes
 				},
 			);
+
+			// safely prune down values
+			Revision.prototype.toJSON = function() {
+				let values = this.get();
+				const excludedFields = ["updated_at"];
+
+				// ensure that we always reference the id as document_id
+				values.document_id = values.document_id || values.document_uuid;
+				delete values.document_uuid;
+
+				return _.omitBy(values, function(value, key) {
+					return (excludedFields.includes(key) || (value === null));
+				});
+			};
+
 			Revision.associate = function associate(models) {
 				if (options.debug) {
 					log('models', models);
 				}
 
-				Revision.belongsTo(
-					sequelize.model(options.userModel),
-					options.belongsToUserOptions,
-				);
+				if (options.userModel) {
+					Revision.belongsTo(
+						sequelize.model(options.userModel),
+						options.belongsToUserOptions,
+					);
+				}
+
+				if (options.tenantModel) {
+					Revision.belongsTo(
+						sequelize.model(options.tenantModel),
+						options.belongsToTenantOptions,
+					);
+				}
 			};
 
 			if (options.enableRevisionChangeModel) {
@@ -650,4 +743,4 @@ paperTrail.enableFailHard = () => {
 	failHard = true;
 };
 
-export default paperTrail;
+export default paperTrail;