sahab-utils 1.9.4 → 1.10.0

package/dist/constants/types.d.ts

@@ -1,6 +1,7 @@
 import { DocumentReference, GeoPoint, Timestamp } from 'firebase/firestore';
 import type { PushTransport } from '../ts/push';
 import type { TapLicenseType } from '../ts/tap';
+import type { OrderSizeAdjustmentFields } from '../ts/orderAdjustment';
 export type GeoPointType = GeoPoint;
 export type TimestampType = Timestamp;
 export type DistenceDueration = {
@@ -163,6 +164,11 @@ export type Order = {
     payLinkDeadline?: TimestampType;
     payLinkSmsCount?: number;
     createdByStaff?: string;
+    sizeAdjustments?: Array<OrderSizeAdjustmentFields & {
+        createdAt?: TimestampType;
+        linkDeadline?: TimestampType;
+        paidAt?: TimestampType;
+    }>;
 };
 export type ReduxOrder = {
     orderId?: string;
@@ -237,7 +243,8 @@ export declare enum MovementType {
     SAHAB_PAYMENT_TO_PROVIDER = 5,
     SAHAB_RECEIVE_FROM_PROVIDER = 6,
     USING_BALANCE = 7,
-    CASHBACK = 8
+    CASHBACK = 8,
+    SIZE_ADJUSTMENT = 9
 }
 export declare enum ComplaintType {
     BUG = 0,

package/dist/constants/types.js

@@ -44,6 +44,7 @@ var MovementType;
     MovementType[MovementType["SAHAB_RECEIVE_FROM_PROVIDER"] = 6] = "SAHAB_RECEIVE_FROM_PROVIDER";
     MovementType[MovementType["USING_BALANCE"] = 7] = "USING_BALANCE";
     MovementType[MovementType["CASHBACK"] = 8] = "CASHBACK";
+    MovementType[MovementType["SIZE_ADJUSTMENT"] = 9] = "SIZE_ADJUSTMENT";
 })(MovementType || (exports.MovementType = MovementType = {}));
 var ComplaintType;
 (function (ComplaintType) {

package/dist/index.d.ts

@@ -11,6 +11,7 @@ export * from './ts/iban';
 export * from './ts/loyalty';
 export * from './ts/offerings';
 export * from './ts/orderActivity';
+export * from './ts/orderAdjustment';
 export * from './ts/payLink';
 export * from './ts/tap';
 export * from './ts/push';

package/dist/index.js

@@ -27,6 +27,7 @@ __exportStar(require("./ts/iban"), exports);
 __exportStar(require("./ts/loyalty"), exports);
 __exportStar(require("./ts/offerings"), exports);
 __exportStar(require("./ts/orderActivity"), exports);
+__exportStar(require("./ts/orderAdjustment"), exports);
 __exportStar(require("./ts/payLink"), exports);
 __exportStar(require("./ts/tap"), exports);
 __exportStar(require("./ts/push"), exports);

package/dist/ts/orderAdjustment.d.ts

@@ -0,0 +1,44 @@
+import { CarService, CarSize, Provider } from '../constants/types';
+export type OrderSizeAdjustmentStatus = 'unpaid' | 'paid' | 'cash';
+/** The parts of a size adjustment with no Firestore dependency; the server adds its timestamps. */
+export type OrderSizeAdjustmentFields = {
+    adjustmentId: string;
+    carId: string;
+    fromSize: CarSize;
+    toSize: CarSize;
+    oldTotal: number;
+    newTotal: number;
+    amountDue: number;
+    status: OrderSizeAdjustmentStatus;
+    providerDelta: number;
+    paymentLinkId?: string;
+    paymentLinkUrl?: string;
+    smsCount?: number;
+    paymentId?: string;
+    refundedPaymentIds?: string[];
+    createdBy: string;
+};
+export declare const ADJUSTMENT_REFERENCE_PREFIX = "adj_";
+export declare const ADJUSTMENT_LINK_HOURS = 24;
+export declare const MAX_ADJUSTMENT_SMS = 3;
+export declare const isLargerSize: (from?: CarSize, to?: CarSize) => boolean;
+/** Checkout's reference for a difference payment; under its 50-character limit for a Firestore id and a short adjustment id. */
+export declare const adjustmentReference: (orderId: string, adjustmentId: string) => string;
+export declare function parseAdjustmentReference(reference?: string): {
+    orderId: string;
+    adjustmentId: string;
+} | undefined;
+/** What the customer owes for a resize, to the halala; never negative. */
+export declare const sizeAdjustmentAmountDue: (oldTotal: number, newTotal: number) => number;
+export type ResizeRejection = 'not_larger' | 'car_not_found' | 'package' | 'line_unavailable' | 'line_not_priced';
+export type ResizedLines = {
+    ok: true;
+    services: CarService[];
+} | {
+    ok: false;
+    reason: ResizeRejection;
+    detail?: string;
+};
+/** The order's services with one car moved to `toSize`. Each of its lines keeps its stored price plus the catalogue
+ * difference between the two sizes, and keeps its stored discount; other cars are untouched. */
+export declare function resizeCarLines(services: CarService[] | undefined, carId: string, toSize: CarSize, provider: Pick<Provider, 'services' | 'addons'>): ResizedLines;

package/dist/ts/orderAdjustment.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sizeAdjustmentAmountDue = exports.adjustmentReference = exports.isLargerSize = exports.MAX_ADJUSTMENT_SMS = exports.ADJUSTMENT_LINK_HOURS = exports.ADJUSTMENT_REFERENCE_PREFIX = void 0;
+exports.parseAdjustmentReference = parseAdjustmentReference;
+exports.resizeCarLines = resizeCarLines;
+const types_1 = require("../constants/types");
+const offerings_1 = require("./offerings");
+exports.ADJUSTMENT_REFERENCE_PREFIX = 'adj_';
+exports.ADJUSTMENT_LINK_HOURS = 24;
+exports.MAX_ADJUSTMENT_SMS = 3;
+const isLargerSize = (from, to) => Number.isInteger(from) && Number.isInteger(to) && to > from && to <= types_1.CarSize.X_LARGE;
+exports.isLargerSize = isLargerSize;
+/** Checkout's reference for a difference payment; under its 50-character limit for a Firestore id and a short adjustment id. */
+const adjustmentReference = (orderId, adjustmentId) => `${exports.ADJUSTMENT_REFERENCE_PREFIX}${orderId}_${adjustmentId}`;
+exports.adjustmentReference = adjustmentReference;
+// Firestore auto ids and adjustment ids never contain '_', so the last one splits the two.
+function parseAdjustmentReference(reference) {
+    if (!reference || !reference.startsWith(exports.ADJUSTMENT_REFERENCE_PREFIX))
+        return undefined;
+    const rest = reference.slice(exports.ADJUSTMENT_REFERENCE_PREFIX.length);
+    const split = rest.lastIndexOf('_');
+    const orderId = rest.slice(0, split);
+    const adjustmentId = rest.slice(split + 1);
+    if (split <= 0 || !adjustmentId || /[/_]/.test(orderId) || /[/_]/.test(adjustmentId))
+        return undefined;
+    return { orderId, adjustmentId };
+}
+/** What the customer owes for a resize, to the halala; never negative. */
+const sizeAdjustmentAmountDue = (oldTotal, newTotal) => Math.max(0, Math.round((newTotal - oldTotal) * 100) / 100);
+exports.sizeAdjustmentAmountDue = sizeAdjustmentAmountDue;
+/** The order's services with one car moved to `toSize`. Each of its lines keeps its stored price plus the catalogue
+ * difference between the two sizes, and keeps its stored discount; other cars are untouched. */
+function resizeCarLines(services, carId, toSize, provider) {
+    var _a, _b, _c, _d, _e, _f;
+    const index = (services !== null && services !== void 0 ? services : []).findIndex((section) => { var _a; return ((_a = section === null || section === void 0 ? void 0 : section.car) === null || _a === void 0 ? void 0 : _a.carId) === carId; });
+    if (index < 0)
+        return { ok: false, reason: 'car_not_found' };
+    const section = services[index];
+    const car = section.car;
+    const fromSize = car.size;
+    if (!(0, exports.isLargerSize)(fromSize, toSize))
+        return { ok: false, reason: 'not_larger' };
+    const lines = [];
+    for (const line of (_a = section.services) !== null && _a !== void 0 ? _a : []) {
+        const { serviceId, addonId } = line;
+        if (line.numberOfVisits && line.numberOfVisits > 1)
+            return { ok: false, reason: 'package' };
+        const offering = serviceId ? (_b = provider.services) === null || _b === void 0 ? void 0 : _b.find((s) => s.serviceId === serviceId) : addonId ? (_c = provider.addons) === null || _c === void 0 ? void 0 : _c.find((a) => a.addonId === addonId) : undefined;
+        if (!offering)
+            return { ok: false, reason: 'line_unavailable', detail: serviceId !== null && serviceId !== void 0 ? serviceId : addonId };
+        const prices = (_d = offering.prices) !== null && _d !== void 0 ? _d : [];
+        const sold = (size) => prices.some((p) => (p === null || p === void 0 ? void 0 : p.size) === size && Number.isFinite(p === null || p === void 0 ? void 0 : p.price) && p.price > 0);
+        if (!sold(fromSize) || !sold(toSize))
+            return { ok: false, reason: 'line_not_priced', detail: `${serviceId !== null && serviceId !== void 0 ? serviceId : addonId} size ${toSize}` };
+        const difference = (0, offerings_1.setServicePrice)(prices, toSize) - (0, offerings_1.setServicePrice)(prices, fromSize);
+        const price = Math.round((((_f = (_e = line.price) === null || _e === void 0 ? void 0 : _e.price) !== null && _f !== void 0 ? _f : 0) + difference) * 100) / 100;
+        lines.push(Object.assign(Object.assign({}, line), { price: Object.assign(Object.assign({}, line.price), { size: toSize, price }) }));
+    }
+    const resized = [...services];
+    resized[index] = Object.assign(Object.assign({}, section), { car: Object.assign(Object.assign({}, car), { size: toSize }), services: lines });
+    return { ok: true, services: resized };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "sahab-utils",
-	"version": "1.9.4",
+	"version": "1.10.0",
 	"description": "This package contains types and utils functions",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
@@ -8,7 +8,7 @@
 		"build": "tsc",
 		"prepublishOnly": "npm run build",
 		"deploy": "npm run build && npm publish",
-		"test": "npm run build && node tests/loyalty.test.js && node tests/gifts.test.js && node tests/cashback.test.js && node tests/utils.test.js && node tests/wheel.test.js && node tests/calcs.test.js && node tests/orderActivity.test.js && node tests/push.test.js && node tests/broadcast.test.js && node tests/iban.test.js && node tests/cash.test.js && node tests/workingHours.test.js && node tests/payLink.test.js && node tests/offerings.test.js && node tests/capacity.test.js && node tests/tap.test.js && node tests/adminNotifications.test.js && node tests/staffAccess.test.js"
+		"test": "npm run build && node tests/loyalty.test.js && node tests/gifts.test.js && node tests/cashback.test.js && node tests/utils.test.js && node tests/wheel.test.js && node tests/calcs.test.js && node tests/orderActivity.test.js && node tests/push.test.js && node tests/broadcast.test.js && node tests/iban.test.js && node tests/cash.test.js && node tests/workingHours.test.js && node tests/payLink.test.js && node tests/offerings.test.js && node tests/capacity.test.js && node tests/tap.test.js && node tests/orderAdjustment.test.js && node tests/adminNotifications.test.js && node tests/staffAccess.test.js"
 	},
 	"repository": {
 		"type": "git",