sahab-utils 1.9.1 → 1.9.3

package/dist/constants/types.d.ts

@@ -1,5 +1,6 @@
 import { DocumentReference, GeoPoint, Timestamp } from 'firebase/firestore';
 import type { PushTransport } from '../ts/push';
+import type { TapLicenseType } from '../ts/tap';
 export type GeoPointType = GeoPoint;
 export type TimestampType = Timestamp;
 export type DistenceDueration = {
@@ -493,7 +494,6 @@ export declare const INTEGRATION_KEYS: {
 export type IntegrationKey = (typeof INTEGRATION_KEYS)[keyof typeof INTEGRATION_KEYS];
 export type TapKycStatus = 'draft' | 'documents_uploaded' | 'lead_created' | 'account_created' | 'payout_enabled' | 'rejected';
 export type TapDocumentPurpose = 'commercial_registration' | 'national_id' | 'bank_statement' | 'iban_certificate';
-export type TapLicenseType = 'LLC' | 'SOLE_PROPRIETORSHIP' | 'JOINT_STOCK' | 'PARTNERSHIP' | 'OTHER';
 export type TapApplicationFile = {
     purpose: TapDocumentPurpose;
     fileId: string;

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export * from './constants/types';
 export * from './ts/broadcast';
+export * from './ts/capacity';
 export * from './ts/calcs';
 export * from './ts/cash';
 export * from './ts/cashback';
@@ -9,6 +10,7 @@ export * from './ts/loyalty';
 export * from './ts/offerings';
 export * from './ts/orderActivity';
 export * from './ts/payLink';
+export * from './ts/tap';
 export * from './ts/push';
 export * from './ts/utils';
 export * from './ts/wheel';

package/dist/index.js

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./constants/types"), exports);
 __exportStar(require("./ts/broadcast"), exports);
+__exportStar(require("./ts/capacity"), exports);
 __exportStar(require("./ts/calcs"), exports);
 __exportStar(require("./ts/cash"), exports);
 __exportStar(require("./ts/cashback"), exports);
@@ -25,6 +26,7 @@ __exportStar(require("./ts/loyalty"), exports);
 __exportStar(require("./ts/offerings"), exports);
 __exportStar(require("./ts/orderActivity"), exports);
 __exportStar(require("./ts/payLink"), exports);
+__exportStar(require("./ts/tap"), exports);
 __exportStar(require("./ts/push"), exports);
 __exportStar(require("./ts/utils"), exports);
 __exportStar(require("./ts/wheel"), exports);

package/dist/ts/capacity.d.ts

@@ -0,0 +1,12 @@
+import { Provider } from '../constants/types';
+/** Whether a carwash takes orders itself: on unless the owner switched it off, so a record with no flag counts as on. */
+export declare const providerReceivesOrders: (provider?: Pick<Provider, "receiveOrders"> | null) => boolean;
+/** How many orders a slot can hold: the explicit drivers on the booking, else the drivers near the customer, else every
+ * active driver, plus the owner when they take orders themselves. The server lists slots and validates bookings with this, and
+ * the provider app shows it, so they cannot disagree. */
+export declare function computeAllowedOrdersPerSlot(params: {
+    providerReceiveOrders?: boolean;
+    totalActiveDrivers: number;
+    driverIdsFromClient?: string[];
+    nearbyDriverCount?: number;
+}): number;

package/dist/ts/capacity.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.providerReceivesOrders = void 0;
+exports.computeAllowedOrdersPerSlot = computeAllowedOrdersPerSlot;
+/** Whether a carwash takes orders itself: on unless the owner switched it off, so a record with no flag counts as on. */
+const providerReceivesOrders = (provider) => (provider === null || provider === void 0 ? void 0 : provider.receiveOrders) !== false;
+exports.providerReceivesOrders = providerReceivesOrders;
+/** How many orders a slot can hold: the explicit drivers on the booking, else the drivers near the customer, else every
+ * active driver, plus the owner when they take orders themselves. The server lists slots and validates bookings with this, and
+ * the provider app shows it, so they cannot disagree. */
+function computeAllowedOrdersPerSlot(params) {
+    const { providerReceiveOrders, totalActiveDrivers, driverIdsFromClient, nearbyDriverCount } = params;
+    if (driverIdsFromClient && driverIdsFromClient.length > 0) {
+        return providerReceiveOrders ? driverIdsFromClient.length + 1 : driverIdsFromClient.length;
+    }
+    if (nearbyDriverCount != null && nearbyDriverCount > 0) {
+        return providerReceiveOrders ? nearbyDriverCount + 1 : nearbyDriverCount;
+    }
+    if (providerReceiveOrders) {
+        return totalActiveDrivers + 1;
+    }
+    return totalActiveDrivers === 0 ? 1 : totalActiveDrivers;
+}

package/dist/ts/cash.d.ts

@@ -11,3 +11,6 @@ export declare const isFreeOrder: (order?: Partial<Order>) => boolean;
 export declare function resolveCashFee(configs?: Pick<PaymentConfigs, 'cashFee'> | null): number;
 /** The fee this order would carry if paid in cash: none when there is nothing to collect. */
 export declare function cashFeeForOrder(order: Partial<Order> | undefined, configs?: Pick<PaymentConfigs, 'cashFee'> | null): number;
+/** What the washer takes from the customer for a cash order, and what the server records as collected when the order is finished:
+ *  nothing for a free order, else the order's total to pay. Undefined for an online order, which was paid up front. */
+export declare function cashAmountToCollect(order?: Partial<Order>): number | undefined;

package/dist/ts/cash.js

@@ -3,8 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.isFreeOrder = exports.getOrderTotalWithoutCashFee = exports.MAX_CASH_FEE = void 0;
 exports.resolveCashFee = resolveCashFee;
 exports.cashFeeForOrder = cashFeeForOrder;
+exports.cashAmountToCollect = cashAmountToCollect;
 const types_1 = require("../constants/types");
 const calcs_1 = require("./calcs");
+const utils_1 = require("./utils");
 /** Cash payment — the shared rules. The fee is set from `payment_methods/configs`; the app only shows it
  *  and cloudFun is what charges it, so both must reach the same number from the same config. */
 /** A fee above this is read as a typo (5000 for 5.00) and ignored rather than charged to customers. */
@@ -26,3 +28,12 @@ function resolveCashFee(configs) {
 function cashFeeForOrder(order, configs) {
     return (0, exports.isFreeOrder)(order) ? 0 : resolveCashFee(configs);
 }
+/** What the washer takes from the customer for a cash order, and what the server records as collected when the order is finished:
+ *  nothing for a free order, else the order's total to pay. Undefined for an online order, which was paid up front. */
+function cashAmountToCollect(order) {
+    if ((order === null || order === void 0 ? void 0 : order.paymentType) !== types_1.OrderPaymentType.CASH)
+        return undefined;
+    if ((0, exports.isFreeOrder)(order))
+        return 0;
+    return Math.max(0, (0, utils_1.preventNaN)((0, calcs_1.getCustomerTotalToPay)(order)));
+}

package/dist/ts/tap.d.ts

@@ -0,0 +1,6 @@
+/** The only `entity.license.type` values Tap's Create Lead API accepts, spelled exactly as Tap lists them. */
+export declare const TAP_LICENSE_TYPES: readonly ["Establishment", "Trust", "Partnership", "LLC", "JSC", "Foreign JSC Branch", "Mix LLC", "Foreign LLC", "GCC Partnership", "GCC LLC", "GCC JSC", "Foreign LLC Branch", "Profession LLC", "Freelancer"];
+export type TapLicenseType = (typeof TAP_LICENSE_TYPES)[number];
+export declare const isTapLicenseType: (value: unknown) => value is TapLicenseType;
+/** A stored or submitted license type as one Tap accepts, or undefined when it maps to none. */
+export declare function normalizeTapLicenseType(value: unknown): TapLicenseType | undefined;

package/dist/ts/tap.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isTapLicenseType = exports.TAP_LICENSE_TYPES = void 0;
+exports.normalizeTapLicenseType = normalizeTapLicenseType;
+/** The only `entity.license.type` values Tap's Create Lead API accepts, spelled exactly as Tap lists them. */
+exports.TAP_LICENSE_TYPES = [
+    'Establishment',
+    'Trust',
+    'Partnership',
+    'LLC',
+    'JSC',
+    'Foreign JSC Branch',
+    'Mix LLC',
+    'Foreign LLC',
+    'GCC Partnership',
+    'GCC LLC',
+    'GCC JSC',
+    'Foreign LLC Branch',
+    'Profession LLC',
+    'Freelancer',
+];
+const isTapLicenseType = (value) => exports.TAP_LICENSE_TYPES.includes(value);
+exports.isTapLicenseType = isTapLicenseType;
+// Applications saved before the list was corrected hold the dashboard's old names. There is no Tap value for
+// "other", so that one stays unresolved and the form must ask again.
+const LEGACY_LICENSE_TYPES = {
+    SOLE_PROPRIETORSHIP: 'Establishment',
+    JOINT_STOCK: 'JSC',
+    PARTNERSHIP: 'Partnership',
+};
+/** A stored or submitted license type as one Tap accepts, or undefined when it maps to none. */
+function normalizeTapLicenseType(value) {
+    if ((0, exports.isTapLicenseType)(value))
+        return value;
+    return typeof value === 'string' ? LEGACY_LICENSE_TYPES[value] : undefined;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "sahab-utils",
-	"version": "1.9.1",
+	"version": "1.9.3",
 	"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"
+		"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"
 	},
 	"repository": {
 		"type": "git",