@sera4/essentia 1.1.65 → 3.0.6

package/paginator/sql-pagination.js

@@ -1,178 +0,0 @@
-"use strict"
-
-class SequelizePaginator {
-
-  constructor() {
-    this.paginateIn = {
-      size: "page_size",
-      index: "page_index"
-    };
-    this.paginateOut = {
-      current_page: "current_page",
-      first_page: "first_page",
-      last_page: "last_page",
-      next_page: "next_page",
-      out_of_bounds: "out_of_bounds",
-      page_size: "page_size",
-      previous_page: "previous_page",
-      total_pages: "total_pages",
-      total_size: "total_size",
-      links: "",
-    };
-    this.zeroBasedOffset = true;
-    this.paginationHeader = "tws-pagination";
-    this.headersOnly = false;
-    this.paginationTag = "_pagination";
-    this.collectionTag = "_collection";
-  }
-
-  paginate(Model, resource="") {
-    const model = Model.instance || Model;
-    const DEFAULT_PAGINATION = {limit : 15, offset: 0}
-    var pagination = {limit : 15, offset: 0}
-    var response = null;
-    var resource = resource;
-
-    const using = (options, resp) => {
-      response = resp;
-      var limit = DEFAULT_PAGINATION.limit;
-      var offset = DEFAULT_PAGINATION.offset;
-
-      if (options && options[this.paginateIn.size]) {
-        limit = parseInt(options[this.paginateIn.size]);
-      }
-      if (options && options[this.paginateIn.index]) {
-        offset = parseInt(options[this.paginateIn.index]);
-      }
-      if (!Number.isInteger(limit) || limit < 1) {
-        limit = 1;
-      }
-      if (!Number.isInteger(offset) || offset < 0) {
-        offset = 0;
-      }
-      if (!this.zeroBasedOffset) {
-        offset = offset <= 1 ? 0 : offset - 1;
-      }
-
-      pagination.limit = limit;
-      pagination.offset = offset;
-      return model;
-    }
-
-    const paginate = (options) => {
-      if (!options) {
-        options = {};
-      }
-      options.limit = pagination.limit;
-      options.offset = pagination.limit * pagination.offset;
-
-      return new Promise((resolve, reject) => {
-        model.findAndCountAll(options)
-        .then(r => {
-          var paginationData = getPaginationData(r);
-          if (response) {
-            response.set(this.paginationHeader, JSON.stringify(paginationData));
-          }
-          var data = {};
-          if (this.headersOnly) {
-            data = r.rows
-          } else {
-            data[this.paginationTag] = addLinks(paginationData);
-            data[this.collectionTag] = r.rows;
-          }
-          resolve(data);
-        }).catch(e => reject(e));
-      });
-    }
-
-    const addLinks = (data) => {
-      var linksKey = null;
-      if (this.paginateOut.links === true) {
-        linksKey = "links"
-      } else if (this.paginateOut.links) {
-        linksKey = this.paginateOut.links;
-      }
-      if (data && linksKey && !data[this.paginateOut["out_of_bounds"]]) {
-        var links = {}
-        var firstPageIndex = this.zeroBasedOffset ? 0 : 1;
-        var lastPageIndex = this.zeroBasedOffset ? data[this.paginateOut["total_pages"]] - 1 : data[this.paginateOut["total_pages"]];
-        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"]] =
-          `${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"]] =
-          `${resource}?${this.paginateIn["index"]}=${data[this.paginateOut["next_page"]]}&${this.paginateIn["size"]}=${data[this.paginateOut["page_size"]]}`;
-        }
-        data[linksKey] = links;
-      }
-      return data;
-    }
-
-    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;
-      data[this.paginateOut["first_page"]] = outOfBounds ? false : pagination.offset === 0;
-      data[this.paginateOut["last_page"]] = outOfBounds ? false : (pagination.offset * pagination.limit) + pagination.limit >= result.count;
-      data[this.paginateOut["page_size"]] = pagination.limit;
-      data[this.paginateOut["total_pages"]] = totalPages;
-      data[this.paginateOut["total_size"]] = result.count;
-      data[this.paginateOut["out_of_bounds"]] = outOfBounds;
-      if (!outOfBounds) {
-        if ((this.zeroBasedOffset && currentPage > 0) || (!this.zeroBasedOffset && currentPage > 1)) {
-          data[this.paginateOut["previous_page"]] = currentPage - 1;
-        }
-        if ((this.zeroBasedOffset && currentPage + 1 < totalPages) || (!this.zeroBasedOffset && currentPage < totalPages)) {
-          data[this.paginateOut["next_page"]] = currentPage + 1;
-        }
-      }
-      return data;
-    }
-
-    model.using = using;
-    model.paginate = paginate;
-  }
-
-  configure(options) {
-    // Parse the object options
-    if (options.paginateIn) {
-      var x = options.paginateIn;
-      for (var key in this.paginateIn) {
-        if (this.paginateIn.hasOwnProperty(key) && x.hasOwnProperty(key)) {
-          this.paginateIn[key] = x[key];
-        }
-      }
-    }
-    if (options.paginateOut) {
-      var x = options.paginateOut;
-      for (var key in this.paginateOut) {
-        if (this.paginateOut.hasOwnProperty(key) && x.hasOwnProperty(key)) {
-          this.paginateOut[key] = x[key];
-        }
-      }
-    }
-    // Parse the simple options
-    for(var key in this) {
-      if (!["paginateIn", "paginateOut"].includes(key)) {
-        if (this.hasOwnProperty(key) && options.hasOwnProperty(key)) {
-          this[key] = options[key];
-        }
-      }
-    }
-  }
-}
-
-const sqlPaginator = new SequelizePaginator();
-export default sqlPaginator;

package/paper-trail/README.md

@@ -1,68 +0,0 @@
-# Sequelize Paper Trail
-
-A paper trail/sequelize hook plugin.  This plugin has been modified to use the node14 CLS API called AsyncLocalStorage as well as fix some of the postgres related bugs.  We have kept our own implemnetation and various changes were needed to support the express framework and pushing this to the public would hinder the general usability of this library for all.
-
-## Usage
-
-In your database setup, setup your models and then attach the paperTrail to them.  Many default options need to be changed to support underscore notation and the use of Account instead of User as the default table, thus suggestions options for TWS projects are shown below.
-
-```
-import { paperTrail } from "@sera4/essentia"
-import Sequelize from 'sequelize';
-
-...
-
-const sequelize = new Sequelize(...);
-
-PaperTrail.init(sequelize, Sequelize, { UUID: true,
-  underscored: true, enableMigration: true, underscoredAttributes: true,
-  debug: false, userModel: 'Account', enableCompression: true });
-};
-
-const db = {};
-// for any model you want enabled
-db["Tenant"]            = TenantModel(sequelize, Sequelize);
-
-db.PaperTrail = PaperTrail.init(sequelize, Sequelize, { UUID: true, underscored: true,
-  enableMigration: true, underscoredAttributes: true, continuationKey: "accountId",
-  debug: false, userModel: 'Account', userModelAttribute: 'account_id',
-  enableCompression: true });
-
-// sending in DB will allow you to access this using db['Revision'] later.
-db.PaperTrail.defineModels(db);
-
-.. and for any model that needs a papertrail, call hasPaperTrail() on it ..
-db["Tenant"].hasPaperTrail();
-db["TenantLicense"].hasPaperTrail();
-```
-
-and similarly, to use the automatic ALS (asyncLocalStorage) for automatic setting of the account/userID - add this into your middleware
-
-```
-import db from "../database/models/index.js";
-
-let alsEnabled = db.PaperTrail.alsEnabled();
-
-const localStorageMiddleware = async (req, res, next) => {
-  await asyncLocalStorage.run(new Map(), () => {
-    if (!alsEnabled) {
-      alsEnabled = true;
-      db.PaperTrail.setupALS(asyncLocalStorage);
-    }
-
-    next();
-  });
-};
-```
-as this will ensure that the ALS context is initialized AFTER the first `run()` invocation.
-
-`Please note`: For automatic accountId fetching, it is imperitive that you add
-
-```
-  asyncLocalStorage.getStore().set("accountId", accountId);
-```
-somewhere into your express middleware so the database hooks can pickup the accountId when changes are made.
-
-## History
-
-This is a private fork/implementation of https://github.com/nielsgl/sequelize-paper-trail which has been released under MIT license.  This was privitized due to the number of commented out items/untested in their project as well as the change from CLS (continuation-local-storage) which is experimental to the supported AsyncLocalStorage which was stabilized in Node 14 as the CLS API 101.

package/paper-trail/helpers.js

@@ -1,99 +0,0 @@
-import pkg from 'deep-diff';
-import _ from 'lodash';
-
-const { diff } = pkg;
-const capitalizeFirstLetter = string =>
-	string.charAt(0).toUpperCase() + string.slice(1);
-
-const toUnderscored = obj => {
-	_.forEach(obj, (k, v) => {
-		obj[k] = v
-			.replace(/(?:^|\.?)([A-Z])/g, (x, y) => `_${y.toLowerCase()}`)
-			.replace(/^_/, '');
-	});
-	return obj;
-};
-
-const calcDelta = (current, next, exclude, strict, DEBUG = false) => {
-	if (DEBUG) {
-		console.log('current', current);
-		console.log('next', next);
-		console.log('exclude', exclude);
-	}
-
-	const di = diff(current, next);
-
-	if (DEBUG) {
-		console.log('di', di);
-
-		let diffs2 = [];
-		if (di) {
-			diffs2 = di.map(i =>
-				JSON.parse(JSON.stringify(i).replace('"__data",', '')),
-			);
-		}
-
-		console.log('diffs2', diffs2);
-
-		console.log(
-			'filter1',
-			diffs2.filter(i => i.path.join(',').indexOf('_') === -1),
-		);
-
-		console.log(
-			'filter2',
-			diffs2.filter(i => exclude.every(x => i.path.indexOf(x) === -1)),
-		);
-	}
-
-	let diffs = [];
-	if (di) {
-		diffs = di
-			.map(i => JSON.parse(JSON.stringify(i).replace('"__data",', '')))
-			.filter(i => {
-				if (!strict && i.kind === 'E') {
-					// eslint-disable-next-line eqeqeq
-					if (i.lhs != i.rhs) return i;
-				} else return i;
-				return false;
-			})
-			.filter(i => exclude.every(x => i.path.indexOf(x) === -1));
-	}
-
-	if (diffs.length > 0) {
-		return diffs;
-	}
-	return null;
-};
-
-const diffToString = val => {
-	if (typeof val === 'undefined' || val === null)
-		return '';
-
-	if (val === true)
-		return '1';
-
-	if (val === false)
-		return '0';
-
-	if (typeof val === 'string')
-		return val;
-
-	if (!Number.isNaN(Number(val)))
-		return `${String(val)}`;
-
-	if ((typeof val === 'undefined' ? 'undefined' : typeof val) === 'object')
-		return `${JSON.stringify(val)}`;
-
-	if (Array.isArray(val))
-		return `${JSON.stringify(val)}`;
-
-	return '';
-};
-
-export default {
-	capitalizeFirstLetter,
-	toUnderscored,
-	calcDelta,
-	diffToString
-};