piper-utils 1.1.70 → 1.1.71

package/package.json

@@ -1,62 +1,62 @@
-{
-    "name": "piper-utils",
-    "version": "1.1.70",
-    "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.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
+    }
+}

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);
+    });
+});