@bisondesk/core-sdk 1.0.678 → 1.0.680

package/lib/utils/transports.test.js

@@ -0,0 +1,40 @@
+import { BusinessEntityIds } from '../constants.js';
+import { TransportStatus, TransportType } from '../types/transports.js';
+import { VehiclePurchaseLogisticsStatus } from '../types/vehicles.js';
+import { getTransportDocumentOwner, isTransportCompleted } from './transports.js';
+describe('getTransportDocumentOwner', () => {
+    test.each([
+        {
+            description: 'a sale transport files on its deal',
+            transport: { type: TransportType.Sale, vehicleId: 'V1', opportunityId: 'OPP1' },
+            expected: { businessEntityId: BusinessEntityIds.Opportunities, recordId: 'OPP1' },
+        },
+        {
+            description: 'a purchase transport files on its vehicle',
+            transport: { type: TransportType.Purchase, vehicleId: 'V1' },
+            expected: { businessEntityId: BusinessEntityIds.Vehicles, recordId: 'V1' },
+        },
+        {
+            description: 'a sale transport without a deal has no owner',
+            transport: { type: TransportType.Sale, vehicleId: 'V1' },
+            expected: undefined,
+        },
+    ])('$description', ({ transport, expected }) => {
+        expect(getTransportDocumentOwner(transport)).toEqual(expected);
+    });
+});
+describe('isTransportCompleted', () => {
+    test.each([
+        { status: TransportStatus.Done, expected: true },
+        { status: TransportStatus.OngoingInternal, expected: false },
+    ])('a sale transport at $status is completed: $expected', ({ status, expected }) => {
+        expect(isTransportCompleted({ type: TransportType.Sale, status }, {})).toBe(expected);
+    });
+    test.each([
+        { logistics: VehiclePurchaseLogisticsStatus.Arrived, expected: true },
+        { logistics: VehiclePurchaseLogisticsStatus.AtOrigin, expected: false },
+    ])('a purchase transport whose vehicle is $logistics is completed: $expected', ({ logistics, expected, }) => {
+        expect(isTransportCompleted({ type: TransportType.Purchase, status: TransportStatus.OngoingInternal }, { purchase: { logistics: { status: logistics } } })).toBe(expected);
+    });
+});
+//# sourceMappingURL=transports.test.js.map

package/lib/utils/transports.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transports.test.js","sourceRoot":"/","sources":["utils/transports.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACxE,OAAO,EAAE,8BAA8B,EAAE,MAAM,sBAAsB,CAAC;AACtE,OAAO,EAAE,yBAAyB,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAElF,QAAQ,CAAC,2BAA2B,EAAE,GAAG,EAAE;IACzC,IAAI,CAAC,IAAI,CAAC;QACR;YACE,WAAW,EAAE,oCAAoC;YACjD,SAAS,EAAE,EAAE,IAAI,EAAE,aAAa,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE;YAC/E,QAAQ,EAAE,EAAE,gBAAgB,EAAE,iBAAiB,CAAC,aAAa,EAAE,QAAQ,EAAE,MAAM,EAAE;SAClF;QACD;YACE,WAAW,EAAE,2CAA2C;YACxD,SAAS,EAAE,EAAE,IAAI,EAAE,aAAa,CAAC,QAAQ,EAAE,SAAS,EAAE,IAAI,EAAE;YAC5D,QAAQ,EAAE,EAAE,gBAAgB,EAAE,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;SAC3E;QACD;YACE,WAAW,EAAE,8CAA8C;YAC3D,SAAS,EAAE,EAAE,IAAI,EAAE,aAAa,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;YACxD,QAAQ,EAAE,SAAS;SACpB;KACF,CAAC,CAAC,cAAc,EAAE,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE,EAAE;QAC7C,MAAM,CAAC,yBAAyB,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;IACpC,IAAI,CAAC,IAAI,CAAC;QACR,EAAE,MAAM,EAAE,eAAe,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE;QAChD,EAAE,MAAM,EAAE,eAAe,CAAC,eAAe,EAAE,QAAQ,EAAE,KAAK,EAAE;KAC7D,CAAC,CAAC,qDAAqD,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE;QACjF,MAAM,CAAC,oBAAoB,CAAC,EAAE,IAAI,EAAE,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACxF,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,IAAI,CAAC;QACR,EAAE,SAAS,EAAE,8BAA8B,CAAC,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE;QACrE,EAAE,SAAS,EAAE,8BAA8B,CAAC,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE;KACxE,CAAC,CAAC,0EAA0E,EAAE,CAAC,EAC9E,SAAS,EACT,QAAQ,GACT,EAAE,EAAE;QACH,MAAM,CACJ,oBAAoB,CAClB,EAAE,IAAI,EAAE,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,eAAe,CAAC,eAAe,EAAE,EACzE,EAAE,QAAQ,EAAE,EAAE,SAAS,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,EAAE,CACnD,CACF,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACnB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { BusinessEntityIds } from '../constants.js';\nimport { TransportStatus, TransportType } from '../types/transports.js';\nimport { VehiclePurchaseLogisticsStatus } from '../types/vehicles.js';\nimport { getTransportDocumentOwner, isTransportCompleted } from './transports.js';\n\ndescribe('getTransportDocumentOwner', () => {\n  test.each([\n    {\n      description: 'a sale transport files on its deal',\n      transport: { type: TransportType.Sale, vehicleId: 'V1', opportunityId: 'OPP1' },\n      expected: { businessEntityId: BusinessEntityIds.Opportunities, recordId: 'OPP1' },\n    },\n    {\n      description: 'a purchase transport files on its vehicle',\n      transport: { type: TransportType.Purchase, vehicleId: 'V1' },\n      expected: { businessEntityId: BusinessEntityIds.Vehicles, recordId: 'V1' },\n    },\n    {\n      description: 'a sale transport without a deal has no owner',\n      transport: { type: TransportType.Sale, vehicleId: 'V1' },\n      expected: undefined,\n    },\n  ])('$description', ({ transport, expected }) => {\n    expect(getTransportDocumentOwner(transport)).toEqual(expected);\n  });\n});\n\ndescribe('isTransportCompleted', () => {\n  test.each([\n    { status: TransportStatus.Done, expected: true },\n    { status: TransportStatus.OngoingInternal, expected: false },\n  ])('a sale transport at $status is completed: $expected', ({ status, expected }) => {\n    expect(isTransportCompleted({ type: TransportType.Sale, status }, {})).toBe(expected);\n  });\n\n  test.each([\n    { logistics: VehiclePurchaseLogisticsStatus.Arrived, expected: true },\n    { logistics: VehiclePurchaseLogisticsStatus.AtOrigin, expected: false },\n  ])('a purchase transport whose vehicle is $logistics is completed: $expected', ({\n    logistics,\n    expected,\n  }) => {\n    expect(\n      isTransportCompleted(\n        { type: TransportType.Purchase, status: TransportStatus.OngoingInternal },\n        { purchase: { logistics: { status: logistics } } },\n      ),\n    ).toBe(expected);\n  });\n});\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bisondesk/core-sdk",
-  "version": "1.0.678",
+  "version": "1.0.680",
   "description": "",
   "type": "module",
   "author": "TheTruckCompany",

package/src/types/opportunities.ts

@@ -521,6 +521,7 @@ export type HpLeasingDealRunDataCi = HpLeasingDealRunDataBase & {
   dueeDuLeasingEnMois: number;
   travauxHorsNormesNecessaire: boolean;
   descriptionDesTravauxHorsNormes: string;
+  prixTravaexSupplementaire: string;
 };
 
 export type HpLeasingDealRequest = {

package/src/types/transports.ts

@@ -340,7 +340,7 @@ export const KANBAN_TRANSPORT_ITEM_FIELDS = [
   'org.name',
   'org.countryCode',
   'org.externalId',
-  'opportunity.deliveredAt',
+  'opportunity.branch',
   'purchase.logistics.status',
   'purchase.logistics.availableWeek',
   'purchase.logistics.pickupAddress',

package/src/types/vehicle-purchase-payments.ts

@@ -89,11 +89,23 @@ export type VehiclePurchasePaymentBff = {
   exportChecks?: PaymentExportChecks;
 };
 
+/**
+ * The group an unpaid purchase is listed under, in the order the Unpaid list shows them: sold to a
+ * client (whether or not it has arrived), arrived on our park and not sold, or still expected —
+ * neither sold nor arrived.
+ */
+export enum UnpaidPurchaseGroup {
+  Sold = 'sold',
+  Arrived = 'arrived',
+  Expected = 'expected',
+}
+
 /**
  * A row on the Unpaid tab: an agreed purchase that still has an amount to authorise for payment.
  * Derived from the purchase deal and the payments already authorised, not a payment record.
  */
 export type UnpaidPurchase = {
+  group: UnpaidPurchaseGroup;
   vehicle: SearchVehicle;
   /** The agreed purchase price including VAT (`deal.purchase` grossed up by `deal.purchaseVatRate`),
    * so it matches the VAT-inclusive cost the vehicle purchase tab authorises against. */
@@ -110,6 +122,14 @@ export type UnpaidPurchase = {
   supplierName?: string;
 };
 
+/** What a page of one Unpaid group carries besides its rows. */
+export type UnpaidPurchasesMeta = {
+  /** Whether the requester may authorise a payment, as on the vehicle purchase tab. */
+  canAllowPayment: boolean;
+  /** How many purchases each group holds, for the group headers. */
+  counts: Record<UnpaidPurchaseGroup, number>;
+};
+
 /** Body of the export request: the Processing payments to put in one file, the paying account, and the execution date. */
 export type ExportPaymentsRequest = {
   paymentIds: string[];

package/src/utils/transports.test.ts

@@ -0,0 +1,50 @@
+import { BusinessEntityIds } from '../constants.js';
+import { TransportStatus, TransportType } from '../types/transports.js';
+import { VehiclePurchaseLogisticsStatus } from '../types/vehicles.js';
+import { getTransportDocumentOwner, isTransportCompleted } from './transports.js';
+
+describe('getTransportDocumentOwner', () => {
+  test.each([
+    {
+      description: 'a sale transport files on its deal',
+      transport: { type: TransportType.Sale, vehicleId: 'V1', opportunityId: 'OPP1' },
+      expected: { businessEntityId: BusinessEntityIds.Opportunities, recordId: 'OPP1' },
+    },
+    {
+      description: 'a purchase transport files on its vehicle',
+      transport: { type: TransportType.Purchase, vehicleId: 'V1' },
+      expected: { businessEntityId: BusinessEntityIds.Vehicles, recordId: 'V1' },
+    },
+    {
+      description: 'a sale transport without a deal has no owner',
+      transport: { type: TransportType.Sale, vehicleId: 'V1' },
+      expected: undefined,
+    },
+  ])('$description', ({ transport, expected }) => {
+    expect(getTransportDocumentOwner(transport)).toEqual(expected);
+  });
+});
+
+describe('isTransportCompleted', () => {
+  test.each([
+    { status: TransportStatus.Done, expected: true },
+    { status: TransportStatus.OngoingInternal, expected: false },
+  ])('a sale transport at $status is completed: $expected', ({ status, expected }) => {
+    expect(isTransportCompleted({ type: TransportType.Sale, status }, {})).toBe(expected);
+  });
+
+  test.each([
+    { logistics: VehiclePurchaseLogisticsStatus.Arrived, expected: true },
+    { logistics: VehiclePurchaseLogisticsStatus.AtOrigin, expected: false },
+  ])('a purchase transport whose vehicle is $logistics is completed: $expected', ({
+    logistics,
+    expected,
+  }) => {
+    expect(
+      isTransportCompleted(
+        { type: TransportType.Purchase, status: TransportStatus.OngoingInternal },
+        { purchase: { logistics: { status: logistics } } },
+      ),
+    ).toBe(expected);
+  });
+});

package/src/utils/transports.ts

@@ -1,7 +1,7 @@
+import { BusinessEntityIds } from '../constants.js';
 import { PurchaseDeliveryTypes } from '../types/deliveries.js';
-import { Opportunity } from '../types/opportunities.js';
 import { PickFieldIds } from '../types/search.js';
-import { SearchTransport, Transport, TransportType } from '../types/transports.js';
+import { SearchTransport, Transport, TransportStatus, TransportType } from '../types/transports.js';
 import { VehiclePurchase } from '../types/vehicles.js';
 import { hasPurchaseArrived } from './vehicles.js';
 
@@ -14,39 +14,56 @@ export const isPurchaseDropOffTransport = (
   isPurchaseTransport(transport) && transport.delivery.type === PurchaseDeliveryTypes.DROP_OFF;
 
 /**
- * A transport is finished when the journey it describes has demonstrably happened: the customer has
- * the vehicle for a sale delivery, the vehicle is on our park for a purchase. From then on
- * the record is history and the server refuses edits to it.
+ * A transport is finished when the journey it describes is over. From then on the record is
+ * history and the server refuses edits to it.
  *
- * Not the same thing as the transport's own `doneAt`. Delivery can be declared on the opportunity
- * (a CMR, a delivery confirmation) and arrival on the purchase, without the transport ever being
- * moved — and reversing either of those is what unlocks the transport again, which a status stamped
- * on the transport itself could not express.
+ * A sale delivery is over when the transport itself is at Done: the transport drives the deal's
+ * delivery, not the other way around, so a deal delivered some other way (a CMR or the Deliver
+ * action, before that rule) does not lock a transport that never got there. Moving it out of Done
+ * unlocks it again.
+ *
+ * A purchase is over when the vehicle is on our park. The park declares the arrival on the purchase,
+ * without the transport ever being moved, and putting the purchase back to At origin is what
+ * unlocks the transport again.
  *
  * Shared so the board, the drawer and the server all answer the question the same way.
  */
 export const isTransportCompleted = (
-  transport: Pick<Transport, 'type'>,
-  context: {
-    opportunity?: Pick<Opportunity, 'deliveredAt'>;
-    purchase?: { logistics: Pick<VehiclePurchase['logistics'], 'status'> };
-  },
+  transport: Pick<Transport, 'type' | 'status'>,
+  context: { purchase?: { logistics: Pick<VehiclePurchase['logistics'], 'status'> } } = {},
 ): boolean => {
   if (transport.type === TransportType.Sale) {
-    return context.opportunity?.deliveredAt != null;
+    return transport.status === TransportStatus.Done;
   }
 
   return context.purchase != null && hasPurchaseArrived(context.purchase);
 };
 
-/** The same question asked of a search document, which already carries both sides. */
+/** The same question asked of a search document, which already carries the purchase. */
 export const isSearchTransportCompleted = (
   record: PickFieldIds<
     SearchTransport,
-    'transport.type' | 'opportunity.deliveredAt' | 'purchase.logistics.status'
+    'transport.type' | 'transport.status' | 'purchase.logistics.status'
   >,
-): boolean =>
-  isTransportCompleted(record.transport, {
-    opportunity: record.opportunity,
-    purchase: record.purchase,
-  });
+): boolean => isTransportCompleted(record.transport, { purchase: record.purchase });
+
+export type TransportDocumentOwner = {
+  businessEntityId: BusinessEntityIds.Opportunities | BusinessEntityIds.Vehicles;
+  recordId: string;
+};
+
+/**
+ * Where a transport's documents are filed. A transport owns none: a sale's belong to the deal and a
+ * purchase's to the vehicle, whose purchase tab lists them. Undefined for a sale without a deal.
+ */
+export const getTransportDocumentOwner = (
+  transport: Pick<Transport, 'type' | 'vehicleId' | 'opportunityId'>,
+): TransportDocumentOwner | undefined => {
+  if (isPurchaseTransport(transport)) {
+    return { businessEntityId: BusinessEntityIds.Vehicles, recordId: transport.vehicleId };
+  }
+
+  return transport.opportunityId == null
+    ? undefined
+    : { businessEntityId: BusinessEntityIds.Opportunities, recordId: transport.opportunityId };
+};