@bisondesk/core-sdk 1.0.667 → 1.0.668

package/src/types/vehicles.ts

@@ -338,6 +338,15 @@ export type RelatedVehicle = {
   stockNumber: string;
 };
 
+export type VehicleBranchHistoryEntry = {
+  branch: string;
+  stockNumber: string;
+  administrativeNumber?: string;
+  changedAt: string;
+  changedBy: string;
+  reason?: string;
+};
+
 export type VehicleInternalInfo = {
   createdAt: string;
   description: {
@@ -355,6 +364,11 @@ export type VehicleInternalInfo = {
       licensePlate: string;
       changedAt: string;
     }[];
+    /**
+     * One entry per branch the vehicle has left, oldest first. Records the identity it carried
+     * there (stock and administrative numbers are redrawn on a move) and who moved it.
+     */
+    branchHistory?: VehicleBranchHistoryEntry[];
 
     /**
      * This ID is used to link different vehicle objects that represent the same real world asset.
@@ -890,8 +904,99 @@ export enum VehicleActions {
   ViewPurchase = 'view_purchase',
   ViewPriceHistory = 'view_price_history',
   DeleteVehicle = 'delete_vehicle',
+  ChangeBranch = 'change_branch',
+}
+
+export type VehicleBranchChangeRequest = {
+  branch: string;
+  reason?: string;
+  /** Required when the preview carries a warning that needs acknowledgement. */
+  acknowledged?: boolean;
+};
+
+export enum VehicleBranchChangeBlockerCode {
+  SameBranch = 'same_branch',
+  VehicleDeleted = 'vehicle_deleted',
+  CurrencyMismatch = 'currency_mismatch',
+  FinanceDocumentsExist = 'finance_documents_exist',
+  PurchasePaymentsExist = 'purchase_payments_exist',
+  DealCommitted = 'deal_committed',
+  VehicleSold = 'vehicle_sold',
+  LeasingContractExists = 'leasing_contract_exists',
+  RelatedVehicles = 'related_vehicles',
+  InternalDealQuote = 'internal_deal_quote',
+  IntercompanyLinkLive = 'intercompany_link_live',
+  HyperdmsOrganisationChange = 'hyperdms_organisation_change',
+  StockNumberTaken = 'stock_number_taken',
+}
+
+export enum VehicleBranchChangeWarningCode {
+  DealsLoseQuotes = 'deals_lose_quotes',
+  DealPaymentsExist = 'deal_payments_exist',
+  OpenTransports = 'open_transports',
+  CopiesWithdrawn = 'copies_withdrawn',
+  CopiesCreated = 'copies_created',
+  TargetWithoutAccounting = 'target_without_accounting',
+  TargetWithoutStorecove = 'target_without_storecove',
 }
 
+export type VehicleBranchChangeBlocker = {
+  code: VehicleBranchChangeBlockerCode;
+  data?: Record<string, unknown>;
+};
+
+export type VehicleBranchChangeWarning = {
+  code: VehicleBranchChangeWarningCode;
+  /** The write refuses unless the request says `acknowledged: true`. */
+  requiresAcknowledgement: boolean;
+  data?: Record<string, unknown>;
+};
+
+export enum VehicleBranchChangeDealOutcome {
+  /** Branches are quote-compatible: the deal and its quotes move together. */
+  FollowsWithQuotes = 'follows_with_quotes',
+  /** The deal moves; its quotes stay archived on the old branch and it needs a new one. */
+  FollowsNeedsRequote = 'follows_needs_requote',
+  AlreadyOnTarget = 'already_on_target',
+  StaysClosed = 'stays_closed',
+  /** In Preparation or later: contracts and paperwork exist, so this deal blocks the move. */
+  Committed = 'committed',
+}
+
+export type VehicleBranchChangeDealImpact = {
+  opportunityId: string;
+  status: string;
+  branch: string;
+  outcome: VehicleBranchChangeDealOutcome;
+  hasActiveQuote: boolean;
+  paymentsCount: number;
+};
+
+export type VehicleBranchChangeIdentity = {
+  branch: string;
+  stockNumber: string;
+  administrativeNumber?: string;
+};
+
+export type VehicleBranchChangePreview = {
+  from: VehicleBranchChangeIdentity;
+  /** The administrative number is only known once drawn, so the preview leaves it out. */
+  to: Omit<VehicleBranchChangeIdentity, 'administrativeNumber'>;
+  blockers: VehicleBranchChangeBlocker[];
+  warnings: VehicleBranchChangeWarning[];
+  /** Counts of the records that follow are not reported: the warnings above already name them. */
+  impact: { deals: VehicleBranchChangeDealImpact[] };
+};
+
+export type VehicleBranchChangeResult = {
+  vehicle: Vehicle;
+  from: VehicleBranchChangeIdentity;
+  to: VehicleBranchChangeIdentity;
+  deals: VehicleBranchChangeDealImpact[];
+  /** Repair steps that failed after the vehicle moved; running the move again retries them. */
+  failedSteps: string[];
+};
+
 export enum PurchaseActions {
   ViewDeal = 'view_deal',
   ViewSupplierOrganization = 'view_supplier_organization',

package/src/utils/tenants.test.ts

@@ -0,0 +1,47 @@
+import { Branch } from '../types/tenants.js';
+import { areBranchesQuoteCompatible } from './tenants.js';
+
+const createBranch = (override?: Partial<Branch>): Branch => ({
+  id: 'TTC',
+  name: 'TTC Belgium',
+  country: 'be',
+  language: 'nl',
+  currency: 'EUR',
+  adminNumberPrefix: 'AT',
+  stockNumberPrefix: 'TC',
+  vatNumber: 'BE0123456789',
+  vatRates: { standard: '21' },
+  location: { country: 'be' },
+  ...override,
+});
+
+describe('areBranchesQuoteCompatible', () => {
+  it('accepts two branches that agree on country, currency, vat rate and quote mode', () => {
+    const a = createBranch();
+    const b = createBranch({ id: 'TTC2', name: 'TTC Antwerp', stockNumberPrefix: 'TA' });
+
+    expect(areBranchesQuoteCompatible(a, b)).toBe(true);
+  });
+
+  it('is true for a branch compared with itself', () => {
+    const branch = createBranch();
+
+    expect(areBranchesQuoteCompatible(branch, branch)).toBe(true);
+  });
+
+  it.each([
+    ['country', { country: 'fr' }],
+    ['currency', { currency: 'USD' }],
+    ['vat rate', { vatRates: { standard: '20' } }],
+    ['external quote mode', { externalQuote: true }],
+  ])('rejects branches that differ in %s', (_label, override) => {
+    expect(areBranchesQuoteCompatible(createBranch(), createBranch(override))).toBe(false);
+  });
+
+  it('treats a missing externalQuote as false rather than as a difference', () => {
+    const implicit = createBranch();
+    const explicit = createBranch({ externalQuote: false });
+
+    expect(areBranchesQuoteCompatible(implicit, explicit)).toBe(true);
+  });
+});

package/src/utils/tenants.ts

@@ -21,3 +21,14 @@ export const getBranchStandardVatRate = (tenant: Tenant, branchId: string): stri
   const branch: Branch = getBranch(tenant, branchId);
   return branch.vatRates.standard;
 };
+
+/**
+ * Whether a quote computed for one branch is still right for the other. A quote's VAT regime,
+ * currency, calculator strategy and conditions all come from these four fields, so when they
+ * agree the quote can move with its deal; otherwise the deal needs a new one.
+ */
+export const areBranchesQuoteCompatible = (a: Branch, b: Branch): boolean =>
+  a.country === b.country &&
+  a.currency === b.currency &&
+  a.vatRates.standard === b.vatRates.standard &&
+  (a.externalQuote ?? false) === (b.externalQuote ?? false);