piper-utils 1.1.70 → 1.1.72

package/nul

@@ -0,0 +1,82 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.watchBucket = exports.userDefaultBid = exports.successHtml = exports.success = exports.stampOwnBusinessId = exports.scopeToPartnerBook = exports.scopeToOwnBusiness = exports.scopeToBookUnionOwn = exports.runMigrations = exports.resolveAccess = exports.requireTicketAccess = exports.requireSuper = exports.requireCrmAccess = exports.publishEvents = exports.parseEvent = exports.parseBody = exports.isSystemUser = exports.isSuperUser = exports.isPartnerUser = exports.isContractChoice = exports.incrementWithAudit = exports.handleFile = exports.getRequestedBusinessIds = exports.getPagination = exports.getModuleInfo = exports.getEffectivePartnerId = exports.getDefaultBusinessIDInfo = exports.getCurrentUserNameFromCognitoEvent = exports.getCurrentUser = exports.getCompanySettings = exports.getBusinessesInfo = exports.getBelongsToPartnerId = exports.getAuditModel = exports.getAuditFilter = exports.getAccessRightsInfo = exports.findAll = exports.failure = exports.ensurePartnerScope = exports.enrichEventWithPartnerAccess = exports.defaultFilters = exports.decrementWithAudit = exports.createSort = exports.createIncludes = exports.createFilters = exports.createAccessHelpers = exports.contractStatuses = exports.contractChoices = exports.checkWriteAccess = exports.checkModule = exports.checkIsSuper = exports.bindAuditRequestForUser = exports.bindAuditRequest = exports.attachAudit = exports.assertCanWriteOwnBusiness = exports.assertCanWriteBookUnionOwn = exports.assertCanWriteBookBusiness = exports.accessRightsUtils = void 0;
+var _handleFile = require("./eventManager/handleFile.js");
+var _watchBucket = require("./eventManager/watchBucket.js");
+var _publishEvents = require("./eventManager/publishEvents.js");
+var _createIncludes = require("./database/dbUtils/queryStringUtils/createIncludes.js");
+var _createFilters = require("./database/dbUtils/queryStringUtils/createFilters.js");
+var _createSort = require("./database/dbUtils/queryStringUtils/createSort.js");
+var _findAll = require("./database/dbUtils/queryStringUtils/findAll.js");
+var _accessRightsUtils = require("./database/dbUtils/queryStringUtils/accessRightsUtils.js");
+var _requestResponse = require("./requestResponse/requestResponse.js");
+var _migrations = require("./database/dbSetup/migrations.js");
+var _defaultFilters = require("./database/dbUtils/queryStringUtils/defaultFilters.js");
+var _getPagination = require("./database/dbUtils/queryStringUtils/getPagination.js");
+var _accessContext = require("./database/dbUtils/partnerAccess/accessContext.js");
+var _accessGates = require("./database/dbUtils/partnerAccess/accessGates.js");
+var _accessScope = require("./database/dbUtils/partnerAccess/accessScope.js");
+var _accessWrites = require("./database/dbUtils/partnerAccess/accessWrites.js");
+var _createAccessHelpers = require("./database/dbUtils/partnerAccess/createAccessHelpers.js");
+var _contract = require("./contract/contract.js");
+var _audit = require("./audit/audit.js");
+const handleFile = exports.handleFile = _handleFile.handleFile;
+const watchBucket = exports.watchBucket = _watchBucket.watchBucket;
+const publishEvents = exports.publishEvents = _publishEvents.publishEvents;
+const createFilters = exports.createFilters = _createFilters.createFilters;
+const createIncludes = exports.createIncludes = _createIncludes.createIncludes;
+const createSort = exports.createSort = _createSort.createSort;
+const findAll = exports.findAll = _findAll.findAll;
+const getPagination = exports.getPagination = _getPagination.getPagination;
+const getRequestedBusinessIds = exports.getRequestedBusinessIds = _accessRightsUtils.getRequestedBusinessIds;
+const checkModule = exports.checkModule = _accessRightsUtils.checkModule;
+const checkIsSuper = exports.checkIsSuper = _accessRightsUtils.checkIsSuper;
+const getAccessRightsInfo = exports.getAccessRightsInfo = _accessRightsUtils.getAccessRightsInfo;
+const getDefaultBusinessIDInfo = exports.getDefaultBusinessIDInfo = _accessRightsUtils.getDefaultBusinessIDInfo;
+const getModuleInfo = exports.getModuleInfo = _accessRightsUtils.getModuleInfo;
+const failure = exports.failure = _requestResponse.failure;
+const success = exports.success = _requestResponse.success;
+const runMigrations = exports.runMigrations = _migrations.runMigrations;
+const getCurrentUser = exports.getCurrentUser = _requestResponse.getCurrentUser;
+const successHtml = exports.successHtml = _requestResponse.successHtml;
+const getCurrentUserNameFromCognitoEvent = exports.getCurrentUserNameFromCognitoEvent = _requestResponse.getCurrentUserNameFromCognitoEvent;
+const defaultFilters = exports.defaultFilters = _defaultFilters.defaultFilters;
+const accessRightsUtils = exports.accessRightsUtils = _accessRightsUtils.accessRightsUtils;
+const parseBody = exports.parseBody = _requestResponse.parseBody;
+const parseEvent = exports.parseEvent = _requestResponse.parseEvent;
+const getBusinessesInfo = exports.getBusinessesInfo = _accessRightsUtils.getBusinessesInfo;
+const userDefaultBid = exports.userDefaultBid = _accessRightsUtils.userDefaultBid;
+const checkWriteAccess = exports.checkWriteAccess = _accessRightsUtils.checkWriteAccess;
+const isSystemUser = exports.isSystemUser = _accessRightsUtils.isSystemUser;
+const isSuperUser = exports.isSuperUser = _accessRightsUtils.isSuperUser;
+const isPartnerUser = exports.isPartnerUser = _accessRightsUtils.isPartnerUser;
+const getBelongsToPartnerId = exports.getBelongsToPartnerId = _accessRightsUtils.getBelongsToPartnerId;
+const getEffectivePartnerId = exports.getEffectivePartnerId = _accessRightsUtils.getEffectivePartnerId;
+const enrichEventWithPartnerAccess = exports.enrichEventWithPartnerAccess = _accessRightsUtils.enrichEventWithPartnerAccess;
+const getCompanySettings = exports.getCompanySettings = _accessRightsUtils.getCompanySettings;
+const resolveAccess = exports.resolveAccess = _accessContext.resolveAccess;
+const ensurePartnerScope = exports.ensurePartnerScope = _accessContext.ensurePartnerScope;
+const requireCrmAccess = exports.requireCrmAccess = _accessGates.requireCrmAccess;
+const requireTicketAccess = exports.requireTicketAccess = _accessGates.requireTicketAccess;
+const requireSuper = exports.requireSuper = _accessGates.requireSuper;
+const scopeToOwnBusiness = exports.scopeToOwnBusiness = _accessScope.scopeToOwnBusiness;
+const scopeToPartnerBook = exports.scopeToPartnerBook = _accessScope.scopeToPartnerBook;
+const scopeToBookUnionOwn = exports.scopeToBookUnionOwn = _accessScope.scopeToBookUnionOwn;
+const assertCanWriteOwnBusiness = exports.assertCanWriteOwnBusiness = _accessWrites.assertCanWriteOwnBusiness;
+const assertCanWriteBookBusiness = exports.assertCanWriteBookBusiness = _accessWrites.assertCanWriteBookBusiness;
+const assertCanWriteBookUnionOwn = exports.assertCanWriteBookUnionOwn = _accessWrites.assertCanWriteBookUnionOwn;
+const stampOwnBusinessId = exports.stampOwnBusinessId = _accessWrites.stampOwnBusinessId;
+const createAccessHelpers = exports.createAccessHelpers = _createAccessHelpers.createAccessHelpers;
+const attachAudit = exports.attachAudit = _audit.attachAudit;
+const bindAuditRequest = exports.bindAuditRequest = _audit.bindAuditRequest;
+const bindAuditRequestForUser = exports.bindAuditRequestForUser = _audit.bindAuditRequestForUser;
+const decrementWithAudit = exports.decrementWithAudit = _audit.decrementWithAudit;
+const getAuditFilter = exports.getAuditFilter = _audit.getAuditFilter;
+const getAuditModel = exports.getAuditModel = _audit.getAuditModel;
+const incrementWithAudit = exports.incrementWithAudit = _audit.incrementWithAudit;
+const contractChoices = exports.contractChoices = _contract.contractChoices;
+const contractStatuses = exports.contractStatuses = _contract.contractStatuses;
+const isContractChoice = exports.isContractChoice = _contract.isContractChoice;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "piper-utils",
-    "version": "1.1.70",
+    "version": "1.1.72",
     "description": "Utility library for Piper",
     "main": "bin/main.js",
     "scripts": {

package/src/contract/contract.js

@@ -0,0 +1,42 @@
+/*
+ * Financing contract constants shared by the ERP (piper) and the payment
+ * gateway (piper-gateway). Both sides put these strings on the wire — the ERP
+ * writes them onto the order and the prepare payload, the gateway reads them
+ * back off the checkout page and echoes them home on the webhook — so they must
+ * agree exactly. Keeping them here is what stops a 'down' / 'Down' drift from
+ * becoming a silent mischarge.
+ */
+
+/*
+ * What the customer chose on the signing page.
+ *  - full: pay the whole order total now; no financing, so no contract to sign
+ *  - down: pay the down payment now and sign the financing contract for the rest
+ */
+export const contractChoices = {
+    full: 'full',
+    down: 'down'
+};
+
+/*
+ * Lifecycle of the contract attached to an order.
+ *  - draft:  order is still an estimate; nothing rendered yet
+ *  - sent:   contract body frozen and hashed, link is out with the customer
+ *  - signed: customer consented and signed; signature + audit trail persisted
+ */
+export const contractStatuses = {
+    draft: 'Draft',
+    sent: 'Sent',
+    signed: 'Signed'
+};
+
+/*
+ * True when value is a choice the signing page is allowed to send. The gateway
+ * gates on this before selecting which of the two server-side amounts to charge,
+ * so an unrecognized choice is a 400 rather than a wrong amount.
+ *
+ * @param {string} value
+ * @returns {boolean}
+ */
+export function isContractChoice(value) {
+    return Object.values(contractChoices).includes(value);
+}

package/src/contract/contract.test.js

@@ -0,0 +1,36 @@
+import { contractChoices, contractStatuses, isContractChoice } from './contract.js';
+
+describe('contract constants', () => {
+    it('should expose the two payment choices the signing page can send', () => {
+        expect(contractChoices.full).toBe('full');
+        expect(contractChoices.down).toBe('down');
+        expect(Object.keys(contractChoices).length).toBe(2);
+    });
+
+    it('should expose the contract lifecycle statuses', () => {
+        expect(contractStatuses.draft).toBe('Draft');
+        expect(contractStatuses.sent).toBe('Sent');
+        expect(contractStatuses.signed).toBe('Signed');
+        expect(Object.keys(contractStatuses).length).toBe(3);
+    });
+});
+
+describe('isContractChoice', () => {
+    it('should accept every known choice', () => {
+        expect(isContractChoice(contractChoices.full)).toBe(true);
+        expect(isContractChoice(contractChoices.down)).toBe(true);
+    });
+
+    it('should reject a case-mismatched choice so a drift becomes a 400 not a mischarge', () => {
+        expect(isContractChoice('Down')).toBe(false);
+        expect(isContractChoice('FULL')).toBe(false);
+    });
+
+    it('should reject unknown, empty and non-string values', () => {
+        expect(isContractChoice('partial')).toBe(false);
+        expect(isContractChoice('')).toBe(false);
+        expect(isContractChoice(null)).toBe(false);
+        expect(isContractChoice(undefined)).toBe(false);
+        expect(isContractChoice(0)).toBe(false);
+    });
+});