@sera4/essentia 1.1.65 → 3.0.6

package/dist/ts/paper-trail/index.js

@@ -0,0 +1,236 @@
+import _ from 'lodash';
+import helpers from './helpers.js';
+const censorText = "**********";
+let failHard = false;
+let Sequelize = null;
+const paperTrail = {
+    init: (sequelize, sequelizePackage, optionsArg) => {
+        Sequelize = sequelizePackage;
+        // In case that options is being parsed as a readonly attribute.
+        // Or it is not passed at all
+        const optsArg = _.cloneDeep(optionsArg || {});
+        const defaultOptions = {
+            debug: false,
+            log: null,
+            exclude: [
+                'id',
+                'createdAt',
+                'updatedAt',
+                'deletedAt',
+                'created_at',
+                'updated_at',
+                'deleted_at',
+                'audit_source',
+                'revision',
+            ],
+            // 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',
+            revisionChangeModel: 'RevisionChange',
+            enableRevisionChangeModel: false,
+            UUID: false,
+            // does this project use int's and UUIDs for some references (postgres)
+            mixedDocumentReference: false,
+            underscored: false,
+            underscoredAttributes: false,
+            // always store these keys in a reference value if seen
+            includeReferences: [],
+            defaultAttributes: {
+                documentId: 'documentId',
+                revisionId: 'revisionId',
+                autoGenerated: 'autoGenerated'
+            },
+            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);
+        }
+        // deals with not wanting to overwrite the initial ones, just add some
+        if (optsArg.excludeExtras) {
+            if (optsArg.exclude) {
+                optsArg.exclude = [...optsArg.exclude, ...optsArg.excludeExtras];
+            }
+            else {
+                optsArg.exclude = [...defaultOptions.exclude, ...optsArg.excludeExtras];
+            }
+        }
+        const options = _.defaults(optsArg, defaultOptions);
+        const log = options.log || console.log;
+        function createBeforeHook(operation) {
+            const beforeHook = function beforeHook(instance, opt) {
+                if (options.debug) {
+                    log('beforeHook called');
+                    log('instance:', instance);
+                    log('opt:', opt);
+                }
+                if (opt.noPaperTrail) {
+                    if (options.debug) {
+                        log('noPaperTrail set, skipping');
+                    }
+                    return;
+                }
+                // Store the original values for comparison
+                const originalValues = instance.get();
+                instance.set('_paperTrailOriginalValues', originalValues);
+            };
+            return beforeHook;
+        }
+        function createAfterHook(operation) {
+            const afterHook = function afterHook(instance, opt) {
+                if (options.debug) {
+                    log('afterHook called');
+                    log('instance:', instance);
+                    log('opt:', opt);
+                }
+                if (opt.noPaperTrail) {
+                    if (options.debug) {
+                        log('noPaperTrail set, skipping');
+                    }
+                    return;
+                }
+                // Get the original values and current values
+                const originalValues = instance.get('_paperTrailOriginalValues') || {};
+                const currentValues = instance.get();
+                // Remove the temporary field
+                delete currentValues._paperTrailOriginalValues;
+                // Calculate differences
+                const differences = helpers.calcDelta(originalValues, currentValues, options.exclude || [], options.enableStrictDiff || false, options.debug);
+                if (differences && differences.length > 0) {
+                    // Create revision record
+                    const revisionData = {
+                        documentId: instance.get(options.defaultAttributes.documentId),
+                        revision: instance.get(options.revisionAttribute),
+                        document: JSON.stringify(currentValues),
+                        operation: operation,
+                        changes: JSON.stringify(differences),
+                        createdAt: new Date()
+                    };
+                    // Add user information if available
+                    if (options.userModel && options.als) {
+                        const user = options.als.get(options.continuationKey);
+                        if (user) {
+                            revisionData[options.userModelAttribute] = user;
+                        }
+                    }
+                    // Add tenant information if available
+                    if (options.tenantModel && options.als) {
+                        const tenant = options.als.get(options.continuationTenantKey);
+                        if (tenant) {
+                            revisionData[options.tenantModelAttribute] = tenant;
+                        }
+                    }
+                    // Save revision
+                    const Revision = sequelize.models[options.revisionModel];
+                    if (Revision) {
+                        Revision.create(revisionData).catch((err) => {
+                            if (failHard) {
+                                throw err;
+                            }
+                            else {
+                                log('Error creating revision:', err);
+                            }
+                        });
+                    }
+                }
+            };
+            return afterHook;
+        }
+        // Add hooks to all models
+        Object.keys(sequelize.models).forEach(modelName => {
+            const model = sequelize.models[modelName];
+            // Add before hooks
+            model.addHook('beforeCreate', createBeforeHook('create'));
+            model.addHook('beforeUpdate', createBeforeHook('update'));
+            model.addHook('beforeDestroy', createBeforeHook('destroy'));
+            // Add after hooks
+            model.addHook('afterCreate', createAfterHook('create'));
+            model.addHook('afterUpdate', createAfterHook('update'));
+            model.addHook('afterDestroy', createAfterHook('destroy'));
+        });
+    },
+    hasPaperTrail: function hasPaperTrail() {
+        return Sequelize !== null;
+    },
+    defineModels: function defineModels(db) {
+        if (!Sequelize) {
+            throw new Error('PaperTrail not initialized. Call paperTrail.init() first.');
+        }
+        const Revision = db.define('Revision', {
+            id: {
+                type: Sequelize.INTEGER,
+                primaryKey: true,
+                autoIncrement: true
+            },
+            documentId: {
+                type: Sequelize.STRING,
+                allowNull: false
+            },
+            revision: {
+                type: Sequelize.INTEGER,
+                allowNull: false
+            },
+            document: {
+                type: Sequelize.TEXT,
+                allowNull: false
+            },
+            operation: {
+                type: Sequelize.STRING,
+                allowNull: false
+            },
+            changes: {
+                type: Sequelize.TEXT,
+                allowNull: true
+            },
+            userId: {
+                type: Sequelize.INTEGER,
+                allowNull: true
+            },
+            tenantId: {
+                type: Sequelize.INTEGER,
+                allowNull: true
+            },
+            createdAt: {
+                type: Sequelize.DATE,
+                allowNull: false
+            }
+        }, {
+            tableName: 'revisions',
+            timestamps: false
+        });
+        // Add associations if user and tenant models exist
+        if (db.models.User) {
+            Revision.belongsTo(db.models.User, { foreignKey: 'userId' });
+        }
+        if (db.models.Tenant) {
+            Revision.belongsTo(db.models.Tenant, { foreignKey: 'tenantId' });
+        }
+        Revision.associate = function associate(models) {
+            if (models.User) {
+                Revision.belongsTo(models.User, { foreignKey: 'userId' });
+            }
+            if (models.Tenant) {
+                Revision.belongsTo(models.Tenant, { foreignKey: 'tenantId' });
+            }
+        };
+    }
+};
+export default paperTrail;
+//# sourceMappingURL=index.js.map

package/dist/ts/paper-trail/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../ts/paper-trail/index.ts"],"names":[],"mappings":"AACA,OAAO,CAAC,MAAM,QAAQ,CAAC;AACvB,OAAO,OAAO,MAAM,cAAc,CAAC;AAInC,MAAM,UAAU,GAAG,YAAY,CAAC;AAEhC,IAAI,QAAQ,GAAG,KAAK,CAAC;AACrB,IAAI,SAAS,GAAQ,IAAI,CAAC;AAoD1B,MAAM,UAAU,GAAG;IACjB,IAAI,EAAE,CAAC,SAAc,EAAE,gBAAqB,EAAE,UAA8B,EAAQ,EAAE;QACpF,SAAS,GAAG,gBAAgB,CAAC;QAC7B,gEAAgE;QAChE,6BAA6B;QAC7B,MAAM,OAAO,GAAG,CAAC,CAAC,SAAS,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC;QAE9C,MAAM,cAAc,GAAsB;YACxC,KAAK,EAAE,KAAK;YACZ,GAAG,EAAE,IAAI;YACT,OAAO,EAAE;gBACP,IAAI;gBACJ,WAAW;gBACX,WAAW;gBACX,WAAW;gBACX,YAAY;gBACZ,YAAY;gBACZ,YAAY;gBACZ,cAAc;gBACd,UAAU;aACX;YACD,iDAAiD;YACjD,aAAa,EAAE,EAAE;YACjB,wBAAwB,EAAE,IAAI,EAAE,iCAAiC;YACjE,MAAM,EAAE,CAAC,UAAU,EAAE,eAAe,EAAE,aAAa,EAAE,iBAAiB,CAAC;YACvE,iBAAiB,EAAE,UAAU;YAC7B,aAAa,EAAE,UAAU;YACzB,mBAAmB,EAAE,gBAAgB;YACrC,yBAAyB,EAAE,KAAK;YAChC,IAAI,EAAE,KAAK;YACX,uEAAuE;YACvE,sBAAsB,EAAE,KAAK;YAC7B,WAAW,EAAE,KAAK;YAClB,qBAAqB,EAAE,KAAK;YAC5B,uDAAuD;YACvD,iBAAiB,EAAE,EAAE;YACrB,iBAAiB,EAAE;gBACjB,UAAU,EAAE,YAAY;gBACxB,UAAU,EAAE,YAAY;gBACxB,aAAa,EAAE,eAAe;aAC/B;YACD,GAAG,EAAE,IAAI;YACT,SAAS,EAAE,KAAK;YAChB,kBAAkB,EAAE,QAAQ;YAC5B,WAAW,EAAE,KAAK;YAClB,oBAAoB,EAAE,UAAU;YAChC,iBAAiB,EAAE,KAAK;YACxB,eAAe,EAAE,KAAK;YACtB,gBAAgB,EAAE,IAAI;YACtB,qBAAqB,EAAE,IAAI;YAC3B,eAAe,EAAE,QAAQ;YACzB,qBAAqB,EAAE,UAAU;YACjC,cAAc,EAAE,IAAI;YACpB,uBAAuB,EAAE,UAAU;YACnC,KAAK,EAAE,KAAK;SACb,CAAC;QAEF,IAAI,OAAO,CAAC,sBAAsB;YAChC,cAAc,CAAC,iBAAkB,CAAC,YAAY,GAAG,cAAc,CAAC;QAElE,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC;YAClC,OAAO,CAAC,aAAa,CAAC,cAAc,CAAC,iBAAkB,CAAC,CAAC;QAC3D,CAAC;QAED,sEAAsE;QACtE,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;YAC1B,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;gBACpB,OAAO,CAAC,OAAO,GAAG,CAAC,GAAG,OAAO,CAAC,OAAO,EAAE,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;YACnE,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,OAAO,GAAG,CAAC,GAAG,cAAc,CAAC,OAAQ,EAAE,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;YAC3E,CAAC;QACH,CAAC;QAED,MAAM,OAAO,GAAG,CAAC,CAAC,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;QAEpD,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC;QAEvC,SAAS,gBAAgB,CAAC,SAAiB;YACzC,MAAM,UAAU,GAAG,SAAS,UAAU,CAAC,QAAuB,EAAE,GAAiB;gBAC/E,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;oBAClB,GAAG,CAAC,mBAAmB,CAAC,CAAC;oBACzB,GAAG,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;oBAC3B,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;gBACnB,CAAC;gBAED,IAAI,GAAG,CAAC,YAAY,EAAE,CAAC;oBACrB,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;wBAClB,GAAG,CAAC,4BAA4B,CAAC,CAAC;oBACpC,CAAC;oBACD,OAAO;gBACT,CAAC;gBAED,2CAA2C;gBAC3C,MAAM,cAAc,GAAG,QAAQ,CAAC,GAAG,EAAE,CAAC;gBACtC,QAAQ,CAAC,GAAG,CAAC,2BAA2B,EAAE,cAAc,CAAC,CAAC;YAC5D,CAAC,CAAC;YAEF,OAAO,UAAU,CAAC;QACpB,CAAC;QAED,SAAS,eAAe,CAAC,SAAiB;YACxC,MAAM,SAAS,GAAG,SAAS,SAAS,CAAC,QAAuB,EAAE,GAAiB;gBAC7E,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;oBAClB,GAAG,CAAC,kBAAkB,CAAC,CAAC;oBACxB,GAAG,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;oBAC3B,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;gBACnB,CAAC;gBAED,IAAI,GAAG,CAAC,YAAY,EAAE,CAAC;oBACrB,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;wBAClB,GAAG,CAAC,4BAA4B,CAAC,CAAC;oBACpC,CAAC;oBACD,OAAO;gBACT,CAAC;gBAED,6CAA6C;gBAC7C,MAAM,cAAc,GAAG,QAAQ,CAAC,GAAG,CAAC,2BAA2B,CAAC,IAAI,EAAE,CAAC;gBACvE,MAAM,aAAa,GAAG,QAAQ,CAAC,GAAG,EAAE,CAAC;gBAErC,6BAA6B;gBAC7B,OAAO,aAAa,CAAC,yBAAyB,CAAC;gBAE/C,wBAAwB;gBACxB,MAAM,WAAW,GAAG,OAAO,CAAC,SAAS,CACnC,cAAc,EACd,aAAa,EACb,OAAO,CAAC,OAAO,IAAI,EAAE,EACrB,OAAO,CAAC,gBAAgB,IAAI,KAAK,EACjC,OAAO,CAAC,KAAK,CACd,CAAC;gBAEF,IAAI,WAAW,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC1C,yBAAyB;oBACzB,MAAM,YAAY,GAAG;wBACnB,UAAU,EAAE,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,iBAAkB,CAAC,UAAU,CAAC;wBAC/D,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,iBAAiB,CAAC;wBACjD,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC;wBACvC,SAAS,EAAE,SAAS;wBACpB,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC;wBACpC,SAAS,EAAE,IAAI,IAAI,EAAE;qBACtB,CAAC;oBAEF,oCAAoC;oBACpC,IAAI,OAAO,CAAC,SAAS,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;wBACrC,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;wBACtD,IAAI,IAAI,EAAE,CAAC;4BACR,YAAoB,CAAC,OAAO,CAAC,kBAAmB,CAAC,GAAG,IAAI,CAAC;wBAC5D,CAAC;oBACH,CAAC;oBAED,sCAAsC;oBACtC,IAAI,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;wBACvC,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC;wBAC9D,IAAI,MAAM,EAAE,CAAC;4BACV,YAAoB,CAAC,OAAO,CAAC,oBAAqB,CAAC,GAAG,MAAM,CAAC;wBAChE,CAAC;oBACH,CAAC;oBAED,gBAAgB;oBAChB,MAAM,QAAQ,GAAG,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,aAAc,CAAC,CAAC;oBAC1D,IAAI,QAAQ,EAAE,CAAC;wBACb,QAAQ,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,KAAK,CAAC,CAAC,GAAQ,EAAE,EAAE;4BAC/C,IAAI,QAAQ,EAAE,CAAC;gCACb,MAAM,GAAG,CAAC;4BACZ,CAAC;iCAAM,CAAC;gCACN,GAAG,CAAC,0BAA0B,EAAE,GAAG,CAAC,CAAC;4BACvC,CAAC;wBACH,CAAC,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC;YACH,CAAC,CAAC;YAEF,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,0BAA0B;QAC1B,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;YAChD,MAAM,KAAK,GAAG,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YAE1C,mBAAmB;YACnB,KAAK,CAAC,OAAO,CAAC,cAAc,EAAE,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC;YAC1D,KAAK,CAAC,OAAO,CAAC,cAAc,EAAE,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC;YAC1D,KAAK,CAAC,OAAO,CAAC,eAAe,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC;YAE5D,kBAAkB;YAClB,KAAK,CAAC,OAAO,CAAC,aAAa,EAAE,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC;YACxD,KAAK,CAAC,OAAO,CAAC,aAAa,EAAE,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC;YACxD,KAAK,CAAC,OAAO,CAAC,cAAc,EAAE,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC;QAC5D,CAAC,CAAC,CAAC;IACL,CAAC;IAED,aAAa,EAAE,SAAS,aAAa;QACnC,OAAO,SAAS,KAAK,IAAI,CAAC;IAC5B,CAAC;IAED,YAAY,EAAE,SAAS,YAAY,CAAC,EAAO;QACzC,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAC;QAC/E,CAAC;QAED,MAAM,QAAQ,GAAG,EAAE,CAAC,MAAM,CAAC,UAAU,EAAE;YACrC,EAAE,EAAE;gBACF,IAAI,EAAE,SAAS,CAAC,OAAO;gBACvB,UAAU,EAAE,IAAI;gBAChB,aAAa,EAAE,IAAI;aACpB;YACD,UAAU,EAAE;gBACV,IAAI,EAAE,SAAS,CAAC,MAAM;gBACtB,SAAS,EAAE,KAAK;aACjB;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,SAAS,CAAC,OAAO;gBACvB,SAAS,EAAE,KAAK;aACjB;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,SAAS,CAAC,IAAI;gBACpB,SAAS,EAAE,KAAK;aACjB;YACD,SAAS,EAAE;gBACT,IAAI,EAAE,SAAS,CAAC,MAAM;gBACtB,SAAS,EAAE,KAAK;aACjB;YACD,OAAO,EAAE;gBACP,IAAI,EAAE,SAAS,CAAC,IAAI;gBACpB,SAAS,EAAE,IAAI;aAChB;YACD,MAAM,EAAE;gBACN,IAAI,EAAE,SAAS,CAAC,OAAO;gBACvB,SAAS,EAAE,IAAI;aAChB;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,SAAS,CAAC,OAAO;gBACvB,SAAS,EAAE,IAAI;aAChB;YACD,SAAS,EAAE;gBACT,IAAI,EAAE,SAAS,CAAC,IAAI;gBACpB,SAAS,EAAE,KAAK;aACjB;SACF,EAAE;YACD,SAAS,EAAE,WAAW;YACtB,UAAU,EAAE,KAAK;SAClB,CAAC,CAAC;QAEH,mDAAmD;QACnD,IAAI,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;YACnB,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC/D,CAAC;QAED,IAAI,EAAE,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACrB,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC,CAAC;QACnE,CAAC;QAED,QAAQ,CAAC,SAAS,GAAG,SAAS,SAAS,CAAC,MAAW;YACjD,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;gBAChB,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,CAAC;YAC5D,CAAC;YACD,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;gBAClB,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC,CAAC;YAChE,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;CACF,CAAC;AAEF,eAAe,UAAU,CAAC"}

package/dist/ts/prompts/index.d.ts

@@ -0,0 +1,21 @@
+import { ArgumentParser } from 'argparse';
+interface CLIInitOptions {
+    asyncFcns?: (() => Promise<void>)[];
+    extraFcns?: (() => void)[];
+    sleepTime?: number;
+}
+interface PromptOptions {
+    [key: string]: {
+        type: string;
+        description?: string;
+        required?: boolean;
+        default?: any;
+    };
+}
+declare const setupCLIParser: (description: string) => ArgumentParser;
+declare const commonCLIInit: (options?: CLIInitOptions) => Promise<void>;
+declare const promptCLIAsync: (options: PromptOptions) => Promise<Record<string, any>>;
+declare const waitCLIPrompt: PromptOptions;
+declare const continueCLIPrompt: PromptOptions;
+declare const cliSleep: (ms: number) => Promise<void>;
+export { commonCLIInit, continueCLIPrompt, promptCLIAsync, setupCLIParser, cliSleep, waitCLIPrompt, type CLIInitOptions, type PromptOptions };

package/dist/ts/prompts/index.js

@@ -0,0 +1,68 @@
+/* Essentia Common Prompt Functions */
+// This file contains common prompt functions that are used in CLI scripts
+//  that are run in the each project.  These functions are used to
+//  prompt the user for input and to wait for the user to press enter
+//  before continuing.  This is useful for scripts that are run in the
+//  command line and need to wait for the user to do something before
+//  continuing.
+import { S4Logger } from "../logger/s4-logger.js";
+import { ArgumentParser } from 'argparse';
+import prompt from "prompt";
+const logger = new S4Logger();
+// New common argument parser which makes parsing and setting up commandline options easier
+const setupCLIParser = (description) => {
+    logger.info(description);
+    return new ArgumentParser({ description });
+};
+// a common init function which waits for the command prompt to be delivered
+// a common use is for the awaiting of the queues to initialize before running
+const commonCLIInit = async (options = {}) => {
+    //add in defaults to options if they have not been specified or object is {}
+    const defaultOptions = {
+        asyncFcns: [],
+        extraFcns: [],
+        sleepTime: 1000,
+        ...options
+    };
+    // Sleep for 1 second to allow the prompt to be displayed
+    // at the end of bootstrap logs
+    await cliSleep(defaultOptions.sleepTime);
+    defaultOptions.extraFcns.forEach(fcn => {
+        fcn();
+    });
+    for (const fcn of defaultOptions.asyncFcns) {
+        await fcn();
+    }
+};
+const promptCLIAsync = async (options) => {
+    return new Promise((resolve, reject) => {
+        prompt.start();
+        prompt.get(options, (err, res) => {
+            if (err) {
+                reject(err);
+            }
+            else {
+                resolve(res);
+            }
+        });
+    });
+};
+// A predefined waitPrompt for use at the end of the scripts that use
+//  message queues.  Message Queues often take a bit to fire
+const waitCLIPrompt = {
+    "Push <enter> when done": {
+        type: "boolean"
+    }
+};
+const continueCLIPrompt = {
+    "Push <enter> to continue": {
+        type: "boolean"
+    }
+};
+const cliSleep = async (ms) => {
+    return new Promise((resolve) => {
+        setTimeout(resolve, ms);
+    });
+};
+export { commonCLIInit, continueCLIPrompt, promptCLIAsync, setupCLIParser, cliSleep, waitCLIPrompt };
+//# sourceMappingURL=index.js.map

package/dist/ts/prompts/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../ts/prompts/index.ts"],"names":[],"mappings":"AAAA,sCAAsC;AACtC,0EAA0E;AAC1E,kEAAkE;AAClE,qEAAqE;AACrE,sEAAsE;AACtE,qEAAqE;AACrE,eAAe;AAEf,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAC1C,OAAO,MAAM,MAAM,QAAQ,CAAC;AAE5B,MAAM,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;AAiB9B,2FAA2F;AAC3F,MAAM,cAAc,GAAG,CAAC,WAAmB,EAAkB,EAAE;IAC7D,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACzB,OAAO,IAAI,cAAc,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC;AAC7C,CAAC,CAAC;AAEF,4EAA4E;AAC5E,8EAA8E;AAC9E,MAAM,aAAa,GAAG,KAAK,EAAE,UAA0B,EAAE,EAAiB,EAAE;IAC1E,4EAA4E;IAC5E,MAAM,cAAc,GAA6B;QAC/C,SAAS,EAAE,EAAE;QACb,SAAS,EAAE,EAAE;QACb,SAAS,EAAE,IAAI;QACf,GAAG,OAAO;KACX,CAAC;IAEF,yDAAyD;IACzD,+BAA+B;IAC/B,MAAM,QAAQ,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;IAEzC,cAAc,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QACrC,GAAG,EAAE,CAAC;IACR,CAAC,CAAC,CAAC;IAEH,KAAK,MAAM,GAAG,IAAI,cAAc,CAAC,SAAS,EAAE,CAAC;QAC3C,MAAM,GAAG,EAAE,CAAC;IACd,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,KAAK,EAAE,OAAsB,EAAgC,EAAE;IACpF,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,CAAC,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,GAAQ,EAAE,GAAQ,EAAE,EAAE;YACzC,IAAI,GAAG,EAAE,CAAC;gBACR,MAAM,CAAC,GAAG,CAAC,CAAC;YACd,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,GAAG,CAAC,CAAC;YACf,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,qEAAqE;AACrE,4DAA4D;AAC5D,MAAM,aAAa,GAAkB;IACnC,wBAAwB,EAAE;QACxB,IAAI,EAAE,SAAS;KAChB;CACF,CAAC;AAEF,MAAM,iBAAiB,GAAkB;IACvC,0BAA0B,EAAE;QAC1B,IAAI,EAAE,SAAS;KAChB;CACF,CAAC;AAEF,MAAM,QAAQ,GAAG,KAAK,EAAE,EAAU,EAAiB,EAAE;IACnD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IAC1B,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,OAAO,EACL,aAAa,EACb,iBAAiB,EACjB,cAAc,EACd,cAAc,EACd,QAAQ,EACR,aAAa,EAGd,CAAC"}

package/dist/ts/queue/index.d.ts

@@ -0,0 +1,196 @@
+interface ConnectionOptions {
+    connectionUrl: string;
+    logEnabled?: boolean;
+    retryInterval?: number;
+}
+interface Exchange {
+    name: string;
+    type: string;
+    options?: any;
+}
+interface PublisherOptions {
+    exchange: Exchange;
+}
+interface SubscriberOptions {
+    exchange: Exchange;
+    queue: {
+        name: string;
+        options?: any;
+    };
+    key: string;
+}
+interface UnregisterSubscriberOptions {
+    exchange: Exchange;
+    queue: {
+        name: string;
+    };
+    key: string;
+}
+type MessageListener = (payload: any, error?: any) => void;
+/**
+ * An interface to AMQP service
+ */
+declare class S4Queue {
+    private connection;
+    private connectionTestChannel;
+    private retry;
+    private pubs;
+    private subs;
+    constructor();
+    /**
+     * Tests the connection to the service.
+     * Internally, the same connection is used for test
+     * and production code, but a separate channel is opened.
+     * Once the channel is obtained, there is an assert on the
+     * existence of a topic exchange called '--health-check--'.
+     * The following must be satisfied for the test to pass
+     * 1. must be connected
+     * 2. must have a test channel
+     * 3. must assert the exchange
+     */
+    testConnection(): Promise<void>;
+    /**
+     * Opens a connection to AMQP server.
+     * @param options Connection parameters. At the very least options.connectionUrl must be present.
+     */
+    openConnection(options: ConnectionOptions): Promise<void>;
+    /**
+     * Closes the connection to AMQP server
+     * and clears the registered publishers
+     * and subscribers
+     */
+    closeConnection(): Promise<void>;
+    /**
+     * Returns whether we have an active connection
+     * or not.
+     */
+    isConnected(): boolean;
+    /**
+     * @deprecated Use registerPublisher
+     * Registers a new direct publisher on the given exchange.
+     * If exchange doesn't exist, one will be created.
+     * @param exchange the name of the exchange on AMQP service.
+     */
+    registerDirectPublisher(exchange: string): Promise<void>;
+    /**
+     * @deprecated Use registerPublisher
+     * Registers a new topic publisher on the given exchange.
+     * If exchange doesn't exist, one will be created.
+     * @param exchange the name of the exchange on AMQP service.
+     */
+    registerTopicPublisher(exchange: string): Promise<void>;
+    /**
+     * @deprecated Use registerPublisher
+     * Registers a new fanout publisher on the given exchange.
+     * If exchange doesn't exist, one will be created.
+     * @param exchange the name of the exchange on AMQP service.
+     */
+    registerFanoutPublisher(exchange: string): Promise<void>;
+    /**
+     * Registers a new publisher
+     * @param options connection options.
+     */
+    registerPublisher(options: PublisherOptions): Promise<void>;
+    /**
+     * Checks whether or not a publisher with given parameters
+     * has been registered already
+     * @param exchange the name of the exchange.
+     * @returns true if registered already, false otherwise
+     */
+    hasPublisher(exchange: string): boolean;
+    /**
+     * Removes a previously registered publisher
+     * @param options
+     */
+    unregisterPublisher(options: PublisherOptions): Promise<void>;
+    /**
+     * @deprecated Use registerSubscriber
+     * Registers a new direct subscriber on a given exchange and queue.
+     * If exchange and queue don't exists, they'll be created
+     * and bound through the provided routing key.
+     * @param exchange the name of the exchange.
+     * @param queue the name of the queue.
+     * @param key the name of the routing key.
+     */
+    registerDirectSubscriber(exchange: string, queue: string, key: string): Promise<void>;
+    /**
+     * @deprecated Use registerSubscriber
+     * Registers a new topic subscriber on a given exchange and queue.
+     * If exchange and queue don't exists, they'll be created
+     * and bound through the provided routing key.
+     * @param exchange the name of the exchange.
+     * @param queue the name of the queue.
+     * @param key the name of the routing key.
+     */
+    registerTopicSubscriber(exchange: string, queue: string, key: string): Promise<void>;
+    /**
+     * An overloaded version of registering a subscriber
+     * allowing for more fine tuned parameters
+     * @param options subscribing options
+     */
+    registerSubscriber(options: SubscriberOptions): Promise<void>;
+    /**
+     * Checks whether or not a subscriber with given parameters
+     * has been registered already
+     * @param exchange the name of the exchange.
+     * @param queue the name of the queue.
+     * @param key the name of the routing key.
+     * @returns true if registered already, false otherwise
+     */
+    hasSubscriber(exchange: string, queue: string, key: string): boolean;
+    /**
+     * Removes a previously registered subscriber
+     * @param options
+     */
+    unregisterSubscriber(options: UnregisterSubscriberOptions): Promise<void>;
+    /**
+     * Publishes a message on a given exchange with routing key.
+     * @param exchange the name of the exchange.
+     * @param key the name of the routing key.
+     * @param msg a JSON object as the message.
+     */
+    publishDirectMessage(exchange: string, key: string, msg: any): Promise<string>;
+    /**
+     * Publishes a message on a given exchange with a topic.
+     * @param exchange the name of the exchange.
+     * @param topic the name of the topic.
+     * @param msg a JSON object as the message.
+     */
+    publishTopicMessage(exchange: string, topic: string, msg: any): Promise<string>;
+    /**
+     * Publish a message to the exchange
+     * @param exchange name of exchange
+     * @param key name of the key or topic
+     * @param msg payload to be published
+     */
+    publishMessage(exchange: string, key: string, msg: any): Promise<string>;
+    /**
+     * Binds an exchange to a queue
+     * @param exchange the name of the exchange.
+     * @param queue the name of the queue.
+     * @param pattern (optional) pattern for routing key
+     */
+    bindQueueToExchange(exchange: string, queue: string, pattern?: string): Promise<void>;
+    /**
+     * Adds a listener for a specific key.
+     * If a subscriber that was registered was found
+     * with that key, the listener is added, otherwise
+     * it's ignored
+     * @param key AMQP routing key
+     * @param listener callback
+     */
+    addMessageListener(key: string, listener: MessageListener): void;
+    /**
+     * Updates the connection reference to all the previously
+     * registered publishers and subscribers.
+     * After we successfully establish a connection and register pubs/subs,
+     * it's possible for the connection to break. This object will try
+     * to re-establish a new connection every 3 seconds (or whatever configuration is set)
+     * and if a new connection is established, we need to pass that connection to
+     * all our pubs/subs, otherwise they'll be operating with old/stale references
+     * @param connRef a new connection reference to the AMQP service
+     */
+    updatePubsAndSubsConnectionRef(connRef: any): void;
+}
+declare const queue: S4Queue;
+export default queue;