@bisondesk/core-sdk 1.0.676 → 1.0.677

package/src/types/vehicles.ts

@@ -170,6 +170,7 @@ export type NewVehicleRequest = {
     dealStatus: VehiclePurchaseDealStatus;
     costs: {
       purchase: string;
+      foreign?: VehiclePurchaseDealForeign;
       purchaseVatPercentage: string;
       commission?: string;
       externalTransport?: string;
@@ -811,6 +812,18 @@ export type VehiclePriceUpdateResponse =
       errors: VehiclePriceUpdateError[];
     };
 
+/**
+ * The price the supplier asked, in the supplier's currency: one of the payment currencies of the
+ * vehicle's branch. The purchase's `deal.purchase` is then `purchase × exchangeRate`, and payments
+ * are authorized in `currencyCode`.
+ */
+export type VehiclePurchaseDealForeign = {
+  purchase: string; // exclusive VAT
+  currencyCode: string;
+  /** Branch currency units per 1 unit of `currencyCode`. */
+  exchangeRate: string;
+};
+
 export type VehiclePurchase = {
   organizationId: string;
   contactId: string;
@@ -851,7 +864,8 @@ export type VehiclePurchase = {
     readyToDeliver?: boolean;
 
     purchaseVatRate?: string;
-    purchase?: string; // exclusive VAT
+    purchase?: string; // exclusive VAT; derived from `foreign` when present
+    foreign?: VehiclePurchaseDealForeign;
 
     bonus?: string; // sometimes manufacturers pay us a bonus when we reach a target
 

package/src/utils/leasing.js

@@ -0,0 +1,6 @@
+import { UTCDate } from '@date-fns/utc';
+import { format } from 'date-fns';
+import { last, map, sortBy, uniqBy } from 'lodash-es';
+export const sortContractClients = (clients) => sortBy(map(uniqBy(clients, (c) => c.takeoverId), (c) => ({ ...c, since: format(new UTCDate(c.since), 'yyyy-MM-dd') })), (cli) => cli.since, (cli) => (cli.takeoverId ? parseInt(cli.takeoverId.replace(/[^0-9]/g, '')) : 0));
+export const getDealRef = ({ conditions, opportunities, }) => last(conditions) ?? last(opportunities);
+//# sourceMappingURL=leasing.js.map

package/src/utils/leasing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"leasing.js","sourceRoot":"","sources":["leasing.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AACxC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAStD,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,OAAgC,EAA2B,EAAE,CAC/F,MAAM,CACJ,GAAG,CACD,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,EACpC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,YAAY,CAAC,EAAE,CAAC,CACrE,EACD,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,EAClB,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAChF,CAAC;AAEJ,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,EACzB,UAAU,EACV,aAAa,GACyC,EAAkC,EAAE,CAC1F,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,aAAa,CAAE,CAAC"}

package/src/utils/opportunities.js

@@ -0,0 +1,48 @@
+import { OpportunityStatus, OpportunityStatusOrder } from '../types/opportunities.js';
+const compareOpportunityStatus = (input) => {
+    const { currentStatus, referenceStatus } = input;
+    const currentStatusIdx = OpportunityStatusOrder.indexOf(currentStatus);
+    const referenceStatusIdx = OpportunityStatusOrder.indexOf(referenceStatus);
+    return {
+        currentStatusIdx,
+        referenceStatusIdx,
+    };
+};
+export const getPreviousStatus = (currentStatus) => {
+    const currentIndex = OpportunityStatusOrder.indexOf(currentStatus);
+    if (currentIndex === 0) {
+        return;
+    }
+    return OpportunityStatusOrder[currentIndex - 1];
+};
+export const getNextStatus = (status) => {
+    const statusIndex = OpportunityStatusOrder.indexOf(status);
+    if (statusIndex >= OpportunityStatusOrder.length - 1) {
+        return;
+    }
+    return OpportunityStatusOrder[statusIndex + 1];
+};
+export const isSameOrAfterReferenceOpportunityStatus = (input) => {
+    const { currentStatusIdx, referenceStatusIdx } = compareOpportunityStatus(input);
+    return currentStatusIdx >= referenceStatusIdx;
+};
+export const isAfterReferenceOpportunityStatus = (input) => {
+    const { currentStatusIdx, referenceStatusIdx } = compareOpportunityStatus(input);
+    return currentStatusIdx > referenceStatusIdx;
+};
+export const isSameOrBeforeReferenceOpportunityStatus = (input) => {
+    const { currentStatusIdx, referenceStatusIdx } = compareOpportunityStatus(input);
+    return currentStatusIdx <= referenceStatusIdx;
+};
+export const isBeforeReferenceOpportunityStatus = (input) => {
+    const { currentStatusIdx, referenceStatusIdx } = compareOpportunityStatus(input);
+    return currentStatusIdx < referenceStatusIdx;
+};
+export const isOpportunityLost = (input) => input.lostAt != null;
+export const getOpportunityReservedStatus = () => [
+    OpportunityStatus.REVIEW,
+    OpportunityStatus.PREPARATION,
+    OpportunityStatus.DELIVERY,
+];
+export const isOpportunityReserved = (input) => getOpportunityReservedStatus().includes(input.status);
+//# sourceMappingURL=opportunities.js.map

package/src/utils/opportunities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"opportunities.js","sourceRoot":"","sources":["opportunities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,iBAAiB,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAC;AAOnG,MAAM,wBAAwB,GAAG,CAAC,KAAmB,EAAE,EAAE;IACvD,MAAM,EAAE,aAAa,EAAE,eAAe,EAAE,GAAG,KAAK,CAAC;IAEjD,MAAM,gBAAgB,GAAG,sBAAsB,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;IACvE,MAAM,kBAAkB,GAAG,sBAAsB,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;IAE3E,OAAO;QACL,gBAAgB;QAChB,kBAAkB;KACnB,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAC/B,aAAgC,EACD,EAAE;IACjC,MAAM,YAAY,GAAG,sBAAsB,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;IACnE,IAAI,YAAY,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO;IACT,CAAC;IACD,OAAO,sBAAsB,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;AAClD,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,MAAyB,EAAiC,EAAE;IACxF,MAAM,WAAW,GAAG,sBAAsB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC3D,IAAI,WAAW,IAAI,sBAAsB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACrD,OAAO;IACT,CAAC;IACD,OAAO,sBAAsB,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC;AACjD,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,uCAAuC,GAAG,CAAC,KAAmB,EAAW,EAAE;IACtF,MAAM,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,GAAG,wBAAwB,CAAC,KAAK,CAAC,CAAC;IAEjF,OAAO,gBAAgB,IAAI,kBAAkB,CAAC;AAChD,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,iCAAiC,GAAG,CAAC,KAAmB,EAAW,EAAE;IAChF,MAAM,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,GAAG,wBAAwB,CAAC,KAAK,CAAC,CAAC;IAEjF,OAAO,gBAAgB,GAAG,kBAAkB,CAAC;AAC/C,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,wCAAwC,GAAG,CAAC,KAAmB,EAAW,EAAE;IACvF,MAAM,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,GAAG,wBAAwB,CAAC,KAAK,CAAC,CAAC;IAEjF,OAAO,gBAAgB,IAAI,kBAAkB,CAAC;AAChD,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,kCAAkC,GAAG,CAAC,KAAmB,EAAW,EAAE;IACjF,MAAM,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,GAAG,wBAAwB,CAAC,KAAK,CAAC,CAAC;IAEjF,OAAO,gBAAgB,GAAG,kBAAkB,CAAC;AAC/C,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,KAAkB,EAAW,EAAE,CAAC,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC;AAEvF,MAAM,CAAC,MAAM,4BAA4B,GAAG,GAAwB,EAAE,CAAC;IACrE,iBAAiB,CAAC,MAAM;IACxB,iBAAiB,CAAC,WAAW;IAC7B,iBAAiB,CAAC,QAAQ;CAC3B,CAAC;AAEF,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,KAAkB,EAAW,EAAE,CACnE,4BAA4B,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC"}

package/src/utils/opportunity-payments.test.ts

@@ -0,0 +1,31 @@
+import { OpportunityPayment } from '../types/opportunity-payments.js';
+import { isPaidInAlternativeCurrency } from './opportunity-payments.js';
+
+const dollarPayment: Pick<OpportunityPayment, 'foreign' | 'deletedAt'> = {
+  foreign: { amount: '30000', currencyCode: 'USD', exchangeRate: '0.861804' },
+};
+const euroPayment: Pick<OpportunityPayment, 'foreign' | 'deletedAt'> = {};
+
+describe('isPaidInAlternativeCurrency', () => {
+  it('shows the alternative currency before any payment arrived', () => {
+    expect(isPaidInAlternativeCurrency('USD', [])).toBe(true);
+  });
+
+  it('shows the alternative currency while every payment arrived in it', () => {
+    expect(isPaidInAlternativeCurrency('USD', [dollarPayment, dollarPayment])).toBe(true);
+  });
+
+  it('switches to branch currency once one payment arrived in branch currency', () => {
+    expect(isPaidInAlternativeCurrency('USD', [dollarPayment, euroPayment])).toBe(false);
+  });
+
+  it('leaves deleted payments out', () => {
+    expect(
+      isPaidInAlternativeCurrency('USD', [dollarPayment, { deletedAt: '2026-09-30T10:00:00Z' }]),
+    ).toBe(true);
+  });
+
+  it('shows branch currency when the quote has no alternative currency', () => {
+    expect(isPaidInAlternativeCurrency(undefined, [dollarPayment])).toBe(false);
+  });
+});

package/src/utils/opportunity-payments.ts

@@ -0,0 +1,15 @@
+import { OpportunityPayment } from '../types/opportunity-payments.js';
+
+/**
+ * Whether a deal's payments are shown in the quote's alternative currency: every payment so far
+ * arrived in it. One payment in branch currency switches the deal to branch currency, because
+ * only the branch currency amounts then add up to the whole.
+ */
+export const isPaidInAlternativeCurrency = (
+  alternativeCurrency: string | undefined,
+  payments: Pick<OpportunityPayment, 'foreign' | 'deletedAt'>[],
+): boolean =>
+  alternativeCurrency != null &&
+  payments
+    .filter((payment) => payment.deletedAt == null)
+    .every((payment) => payment.foreign?.currencyCode === alternativeCurrency);

package/src/utils/tenants.test.ts

@@ -1,5 +1,11 @@
-import { Branch } from '../types/tenants.js';
-import { areBranchesQuoteCompatible } from './tenants.js';
+import { Branch, Tenant } from '../types/tenants.js';
+import {
+  areBranchesQuoteCompatible,
+  getBranchAskingVies,
+  getBranchPaymentCurrencies,
+  hasForeignPaymentCurrency,
+  isForeignPaymentCurrency,
+} from './tenants.js';
 
 const createBranch = (override?: Partial<Branch>): Branch => ({
   id: 'TTC',
@@ -45,3 +51,55 @@ describe('areBranchesQuoteCompatible', () => {
     expect(areBranchesQuoteCompatible(implicit, explicit)).toBe(true);
   });
 });
+
+describe('getBranchAskingVies', () => {
+  const bolivia = createBranch({ id: 'BO', country: 'bo', vatNumber: '387032026' });
+  const belgium = createBranch({ id: 'BE', country: 'be', vatNumber: 'BE0405567886' });
+  const france = createBranch({ id: 'FR', country: 'fr', vatNumber: 'FR10821739638' });
+  const tenantOf = (branches: Branch[]) => ({ branches }) as Tenant;
+
+  test.each([
+    ['the European branch the check is made for', 'FR', 'FR'],
+    ['the first European branch when no branch is given', undefined, 'BE'],
+    ['the first European branch when the given branch is outside the EU', 'BO', 'BE'],
+    ['the first European branch when the given branch is unknown', 'GONE', 'BE'],
+  ])('picks %s', (_label, branchId, expected) => {
+    expect(getBranchAskingVies(tenantOf([bolivia, belgium, france]), branchId)?.id).toBe(expected);
+  });
+
+  test('asks anonymously for a tenant without a European branch', () => {
+    expect(getBranchAskingVies(tenantOf([bolivia]), 'BO')).toBeUndefined();
+  });
+});
+
+describe('payment currencies of a branch', () => {
+  const southAmerica = createBranch({
+    id: 'HPA South America',
+    paymentCurrencies: ['EUR', 'USD'],
+  });
+
+  test('a branch without a list is paid in its own currency only', () => {
+    expect(getBranchPaymentCurrencies(createBranch())).toEqual(['EUR']);
+  });
+
+  test('a branch with a list is paid in the currencies it lists', () => {
+    expect(getBranchPaymentCurrencies(southAmerica)).toEqual(['EUR', 'USD']);
+  });
+
+  test.each([
+    ['a listed currency other than its own', 'USD', true],
+    ['its own currency', 'EUR', false],
+    ['a currency it does not list', 'BOB', false],
+  ])('%s is a foreign payment currency: %s', (_label, currencyCode, expected) => {
+    expect(isForeignPaymentCurrency(southAmerica, currencyCode)).toBe(expected);
+  });
+
+  test('a branch without a list has no foreign payment currency', () => {
+    expect(isForeignPaymentCurrency(createBranch(), 'USD')).toBe(false);
+    expect(hasForeignPaymentCurrency(createBranch())).toBe(false);
+  });
+
+  test('a branch listing another currency has a foreign payment currency', () => {
+    expect(hasForeignPaymentCurrency(southAmerica)).toBe(true);
+  });
+});

package/src/utils/tenants.ts

@@ -1,4 +1,5 @@
 import { XError } from '@bisondesk/commons-sdk/errors';
+import { isEUCountry } from '@bisondesk/commons-sdk/locations';
 import { first } from 'lodash-es';
 import { Branch, Tenant } from '../types/tenants.js';
 
@@ -13,6 +14,33 @@ export const getBranch = (tenant: Tenant, branchId: string): Branch => {
 
 export const getDefaultBranch = (tenant: Tenant): Branch => first(tenant.branches)!;
 
+/**
+ * The branch whose VAT number VIES records as the requester of a VAT check, which earns a
+ * consultation number: the branch the check is made for when it is European, else the tenant's
+ * first European branch. A tenant without a European branch asks VIES anonymously.
+ */
+export const getBranchAskingVies = (tenant: Tenant, branchId?: string): Branch | undefined => {
+  const europeanBranches = tenant.branches.filter((branch) => isEUCountry(branch.country));
+  return europeanBranches.find((branch) => branch.id === branchId) ?? europeanBranches.at(0);
+};
+
+/** The currencies money moves in at the branch, its own currency included. */
+export const getBranchPaymentCurrencies = (branch: Branch): string[] =>
+  branch.paymentCurrencies ?? [branch.currency];
+
+/**
+ * Whether the branch can be paid, price a purchase or receive a supplier invoice in a currency
+ * other than its own. Its own currency is never a foreign one.
+ */
+export const isForeignPaymentCurrency = (branch: Branch, currencyCode: string): boolean =>
+  currencyCode !== branch.currency && getBranchPaymentCurrencies(branch).includes(currencyCode);
+
+/** Whether the branch lists any payment currency other than its own. */
+export const hasForeignPaymentCurrency = (branch: Branch): boolean =>
+  getBranchPaymentCurrencies(branch).some((currencyCode) =>
+    isForeignPaymentCurrency(branch, currencyCode),
+  );
+
 /** The source invoices the end customer directly; this branch collects payment and earns
  * commission (see {@link Branch.dropshipping}). */
 export const isDropshippingBranch = (branch: Branch): boolean => branch.dropshipping === true;