piper-utils 1.1.71 → 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,62 +1,62 @@
-{
-    "name": "piper-utils",
-    "version": "1.1.71",
-    "description": "Utility library for Piper",
-    "main": "bin/main.js",
-    "scripts": {
-        "test": "cross-env BUILD_ENV='test' nyc jasmine JASMINE_CONFIG_PATH=jasmine.json",
-        "itest": "cross-env BUILD_ENV='development' nyc jasmine JASMINE_CONFIG_PATH=jasmine.json",
-        "build": "webpack --config webpack.config.js",
-        "build-prod": "cross-env BUILD_ENV='production' webpack --config webpack.config.js"
-    },
-    "repository": {
-        "type": "git"
-    },
-    "author": "Kevin Batchelor",
-    "license": "PVT",
-    "devDependencies": {
-        "@babel/cli": "7.11.6",
-        "@babel/core": "7.23.2",
-        "@babel/preset-env": "^7.29.0",
-        "@babel/register": "^7.28.6",
-        "@babel/runtime": "8.0.0-alpha.17",
-        "aws-sdk-client-mock": "^3.0.1",
-        "babel-loader": "9.1.3",
-        "babel-preset-env": "1.7.0",
-        "cross-env": "7.0.3",
-        "jasmine": "5.1.0",
-        "nyc": "14.1.1",
-        "terser-webpack-plugin": "^5.3.10",
-        "webpack": "5.104.1",
-        "webpack-cli": "^5.1.4",
-        "webpack-node-externals": "3.0.0"
-    },
-    "dependencies": {
-        "@aws-sdk/client-dynamodb": "^3.507.0",
-        "@aws-sdk/client-s3": "^3.507.0",
-        "@aws-sdk/client-sns": "^3.507.0",
-        "@aws-sdk/lib-dynamodb": "^3.507.0",
-        "babel-runtime": "6.26.0"
-    },
-    "peerDependencies": {
-        "bluebird": ">=3.7.0",
-        "dayjs": "^1.11.13",
-        "lodash": ">=4.17.15",
-        "sequelize": ">=6.6.2",
-        "umzug": ">=3.2.1"
-    },
-    "nyc": {
-        "require": [
-            "@babel/register"
-        ],
-        "reporter": [
-            "lcov",
-            "text-summary"
-        ],
-        "check-coverage": true,
-        "branches": 70,
-        "lines": 80,
-        "functions": 70,
-        "statements": 85
-    }
-}
+{
+    "name": "piper-utils",
+    "version": "1.1.72",
+    "description": "Utility library for Piper",
+    "main": "bin/main.js",
+    "scripts": {
+        "test": "cross-env BUILD_ENV='test' nyc jasmine JASMINE_CONFIG_PATH=jasmine.json",
+        "itest": "cross-env BUILD_ENV='development' nyc jasmine JASMINE_CONFIG_PATH=jasmine.json",
+        "build": "webpack --config webpack.config.js",
+        "build-prod": "cross-env BUILD_ENV='production' webpack --config webpack.config.js"
+    },
+    "repository": {
+        "type": "git"
+    },
+    "author": "Kevin Batchelor",
+    "license": "PVT",
+    "devDependencies": {
+        "@babel/cli": "7.11.6",
+        "@babel/core": "7.23.2",
+        "@babel/preset-env": "^7.29.0",
+        "@babel/register": "^7.28.6",
+        "@babel/runtime": "8.0.0-alpha.17",
+        "aws-sdk-client-mock": "^3.0.1",
+        "babel-loader": "9.1.3",
+        "babel-preset-env": "1.7.0",
+        "cross-env": "7.0.3",
+        "jasmine": "5.1.0",
+        "nyc": "14.1.1",
+        "terser-webpack-plugin": "^5.3.10",
+        "webpack": "5.104.1",
+        "webpack-cli": "^5.1.4",
+        "webpack-node-externals": "3.0.0"
+    },
+    "dependencies": {
+        "@aws-sdk/client-dynamodb": "^3.507.0",
+        "@aws-sdk/client-s3": "^3.507.0",
+        "@aws-sdk/client-sns": "^3.507.0",
+        "@aws-sdk/lib-dynamodb": "^3.507.0",
+        "babel-runtime": "6.26.0"
+    },
+    "peerDependencies": {
+        "bluebird": ">=3.7.0",
+        "dayjs": "^1.11.13",
+        "lodash": ">=4.17.15",
+        "sequelize": ">=6.6.2",
+        "umzug": ">=3.2.1"
+    },
+    "nyc": {
+        "require": [
+            "@babel/register"
+        ],
+        "reporter": [
+            "lcov",
+            "text-summary"
+        ],
+        "check-coverage": true,
+        "branches": 70,
+        "lines": 80,
+        "functions": 70,
+        "statements": 85
+    }
+}

package/src/database/dbUtils/queryStringUtils/getPagination.js

@@ -0,0 +1,29 @@
+export const DEFAULT_LIMIT = 10;
+export const MAX_LIMIT = 500;
+
+/**
+ * Read a sanitized limit/offset out of a request's query string.
+ *
+ * Every consuming repo was hand-rolling `parseInt(qsp.limit ?? '10')`, which has
+ * a sharp edge: parseInt('abc') and parseInt('') are NaN, and findAll() below
+ * does `options.limit || 0` -> Sequelize `limit: 1`. So `?limit=abc` silently
+ * returned exactly one row instead of a page. This clamps instead, and bounds
+ * the upper end so `?limit=100000` can't be used to pull a whole table.
+ *
+ * The cap is deliberately loose — it exists to stop abuse, not to be a tight
+ * page size. Pass maxLimit when a route needs a different ceiling.
+ *
+ * @param {object} event - The lambda event passed in by a validated api request.
+ * @param {object} [options] - Overrides.
+ * @param {number} [options.defaultLimit] - Limit when none is supplied (default 10).
+ * @param {number} [options.maxLimit] - Upper bound for limit (default 500).
+ * @returns {{limit: number, offset: number}} Sanitized pagination.
+ */
+export function getPagination(event, { defaultLimit = DEFAULT_LIMIT, maxLimit = MAX_LIMIT } = {}) {
+    const query = event?.queryStringParameters || {};
+
+    const limit = Math.max(1, Math.min(parseInt(query.limit, 10) || defaultLimit, maxLimit));
+    const offset = Math.max(0, parseInt(query.offset, 10) || 0);
+
+    return { limit, offset };
+}

package/src/database/dbUtils/queryStringUtils/getPagination.test.js

@@ -0,0 +1,83 @@
+import { getPagination } from './getPagination.js';
+
+describe('getPagination', function () {
+    it('should default to limit 10 offset 0 when nothing is supplied', function () {
+        // Act
+        const result = getPagination({});
+
+        // Assert
+        expect(result).toEqual({ limit: 10, offset: 0 });
+    });
+
+    it('should tolerate a missing event', function () {
+        // Act
+        const result = getPagination(undefined);
+
+        // Assert
+        expect(result).toEqual({ limit: 10, offset: 0 });
+    });
+
+    it('should use the supplied limit and offset', function () {
+        // Arrange
+        const event = { queryStringParameters: { limit: '25', offset: '50' } };
+
+        // Act
+        const result = getPagination(event);
+
+        // Assert
+        expect(result).toEqual({ limit: 25, offset: 50 });
+    });
+
+    it('should fall back to the default when limit is not a number', function () {
+        // Arrange - parseInt('abc') is NaN, and findAll turns a falsy limit into
+        // Sequelize `limit: 1`, so this used to return exactly one row.
+        const event = { queryStringParameters: { limit: 'abc' } };
+
+        // Act
+        const result = getPagination(event);
+
+        // Assert
+        expect(result.limit).toBe(10);
+    });
+
+    it('should fall back to the default when limit is empty or zero', function () {
+        // Act + Assert
+        expect(getPagination({ queryStringParameters: { limit: '' } }).limit).toBe(10);
+        expect(getPagination({ queryStringParameters: { limit: '0' } }).limit).toBe(10);
+    });
+
+    it('should clamp an oversized limit rather than running it', function () {
+        // Arrange
+        const event = { queryStringParameters: { limit: '100000' } };
+
+        // Act
+        const result = getPagination(event);
+
+        // Assert
+        expect(result.limit).toBe(500);
+    });
+
+    it('should never return a negative offset', function () {
+        // Arrange
+        const event = { queryStringParameters: { offset: '-20' } };
+
+        // Act
+        const result = getPagination(event);
+
+        // Assert
+        expect(result.offset).toBe(0);
+    });
+
+    it('should honor caller supplied defaultLimit and maxLimit', function () {
+        // Arrange
+        const event = { queryStringParameters: { limit: '999' } };
+
+        // Act
+        const clamped = getPagination(event, { maxLimit: 50 });
+        const defaulted = getPagination({}, { defaultLimit: 20 });
+
+        // Assert
+        expect(clamped.limit).toBe(50);
+        expect(defaulted.limit).toBe(20);
+    });
+});

package/src/index.js

@@ -29,6 +29,8 @@ import { getBelongsToPartnerId as getBelongsToPartnerIdImport } from './database
 import { getEffectivePartnerId as getEffectivePartnerIdImport } from './database/dbUtils/queryStringUtils/accessRightsUtils.js';
 import { enrichEventWithPartnerAccess as enrichEventWithPartnerAccessImport } from './database/dbUtils/queryStringUtils/accessRightsUtils.js';
 import { getCompanySettings as getCompanySettingsImport } from './database/dbUtils/queryStringUtils/accessRightsUtils.js';
+import { getRequestedBusinessIds as getRequestedBusinessIdsImport } from './database/dbUtils/queryStringUtils/accessRightsUtils.js';
+import { getPagination as getPaginationImport } from './database/dbUtils/queryStringUtils/getPagination.js';
 import { resolveAccess as resolveAccessImport, ensurePartnerScope as ensurePartnerScopeImport } from './database/dbUtils/partnerAccess/accessContext.js';
 import { requireCrmAccess as requireCrmAccessImport, requireTicketAccess as requireTicketAccessImport, requireSuper as requireSuperImport } from './database/dbUtils/partnerAccess/accessGates.js';
 import { scopeToOwnBusiness as scopeToOwnBusinessImport, scopeToPartnerBook as scopeToPartnerBookImport, scopeToBookUnionOwn as scopeToBookUnionOwnImport } from './database/dbUtils/partnerAccess/accessScope.js';
@@ -52,6 +54,8 @@ export const createFilters = createFiltersImport;
 export const createIncludes = createIncludesImport;
 export const createSort = createSortImport;
 export const findAll = findAllImport;
+export const getPagination = getPaginationImport;
+export const getRequestedBusinessIds = getRequestedBusinessIdsImport;
 export const checkModule = checkModuleImport;
 export const checkIsSuper = checkIsSuperImport;
 export const getAccessRightsInfo = getAccessRightsInfoImport;