@bisondesk/core-sdk 1.0.370 → 1.0.372

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bisondesk/core-sdk",
-  "version": "1.0.370",
+  "version": "1.0.372",
   "description": "",
   "type": "module",
   "scripts": {
@@ -21,7 +21,7 @@
   "devDependencies": {
     "@types/lodash-es": "4.17.12",
     "@types/node": "20.11.24",
-    "typescript": "5.4.4"
+    "typescript": "5.5.2"
   },
   "peerDependencies": {
     "@bisondesk/commons-sdk": "*"

package/src/apis/vehicle-sales.ts

@@ -0,0 +1,48 @@
+import {
+  ExternalVehicleSale,
+  NewExternalVehicleSale,
+  VehicleSaleInfo,
+} from '../types/vehicle-sales.js';
+import { TENANT_ID_ADMIN_HEADER } from '@bisondesk/commons-sdk/constants';
+import { fetchJson, getAdminAuth } from '@bisondesk/commons-sdk/fetch';
+
+export const getVehicleSaleInfo = async (
+  tenantId: string,
+  vehicleId: string
+): Promise<VehicleSaleInfo | undefined> => {
+  const auth = await getAdminAuth();
+  return fetchJson(`${process.env.CORE_API_ORIGIN}/api/vehicle-sales/${vehicleId}`, {
+    headers: {
+      Authorization: auth,
+      [TENANT_ID_ADMIN_HEADER]: tenantId,
+    },
+  });
+};
+
+export const getExternalVehicleSale = async (
+  tenantId: string,
+  saleId: string
+): Promise<ExternalVehicleSale | undefined> => {
+  const auth = await getAdminAuth();
+  return fetchJson(`${process.env.CORE_API_ORIGIN}/api/external-sales/${saleId}`, {
+    headers: {
+      Authorization: auth,
+      [TENANT_ID_ADMIN_HEADER]: tenantId,
+    },
+  });
+};
+
+export const saveExternalVehicleSale = async (
+  tenantId: string,
+  data: NewExternalVehicleSale
+): Promise<ExternalVehicleSale | undefined> => {
+  const auth = await getAdminAuth();
+  return fetchJson(`${process.env.CORE_API_ORIGIN}/api/external-sales`, {
+    method: 'POST',
+    headers: {
+      Authorization: auth,
+      [TENANT_ID_ADMIN_HEADER]: tenantId,
+    },
+    body: JSON.stringify(data),
+  });
+};

package/src/constants.ts

@@ -11,15 +11,15 @@ export const TIMEZONES_PICKLIST_ID = 'timezones';
 export const COUNTRIES_PICKLIST_ID = 'countries';
 export const VEHICLE_MAIN_FEATURES_PICKLIST_ID = 'vehicleMainFeatures';
 export const VEHICLE_STATE_FILTERS_PICKLIST_ID = 'vehicleStateFilters';
+export const VEHICLE_SEARCH_SALE_DEAL_STATUS_PICKLIST_ID = 'vehicleSearchSaleDealStatus';
 export const VEHICLE_SALE_DEAL_STATUS_PICKLIST_ID = 'vehicleSaleDealStatus';
+export const VEHICLE_SALE_LOGISTICS_STATUS_PICKLIST_ID = 'vehicleSaleLogisticsStatus';
 export const VEHICLE_ROLES_PICKLIST_ID = 'vehicleRoles';
 export const MARKETING_PLATFORMS_PICKLIST_ID = 'marketingPlatforms';
 export const OFFER_STATUS_PICKLIST_ID = 'offerStatus';
 export const OFFER_SOURCE_PICKLIST_ID = 'offerSource';
 export const OPPORTUNITY_STATUS_PICKLIST_ID = 'opportunityStatus';
-export const OPPORTUNITY_DEAL_STATUS_PICKLIST_ID = 'opportunityDealStatus';
 export const OPPORTUNITY_PAYMENT_STATUS_PICKLIST_ID = 'opportunityPaymentStatus';
-export const OPPORTUNITY_LOGISTIC_STATUS_PICKLIST_ID = 'opportunityLogisticStatus';
 export const OPPORTUNITY_SOURCE_PICKLIST_ID = 'opportunity_source';
 export const ORGANIZATION_RISK_TAGS_PICKLIST_ID = 'organizationRiskTags';
 export const DEPARTMENT_PICKLIST_ID = 'department';

package/src/types/offers.ts

@@ -2,7 +2,6 @@ import { DistributiveOmit, Document, NextList } from '@bisondesk/commons-sdk/typ
 import { BusinessEntityIds, WarningHints } from '../constants.js';
 import { Contact, Organization } from './crm.js';
 import { Insights, InsightsComparableSpecs } from './insights.js';
-import { ContactMetdata } from './opportunities.js';
 import { BaseSearchRequest } from './search.js';
 import { DataRecord, ReferenceData } from './utils.js';
 import { VehicleExternalInfo } from './vehicles.js';

package/src/types/opportunities.ts

@@ -32,12 +32,6 @@ export enum OpportunityActions {
   ISSUE_INVOICE = 'issue_invoice',
 }
 
-export enum OpportunityDealStatus {
-  SALES_AGREED = 'sales_agreed',
-  FIRST_PAYMENT = 'first_payment',
-  FULL_PAYMENT = 'full_payment',
-}
-
 export enum OpportunityPaymentStatus {
   PARTIAL_PAYMENT = 'partial_payment',
   FULL_PAYMENT = 'full_payment',
@@ -62,11 +56,6 @@ export const OpportunityStatusOrder: OpportunityStatus[] = [
   OpportunityStatus.DELIVERY,
 ];
 
-export enum OpportunityLogisticStatus {
-  AT_ORIGIN = 'at_origin',
-  DELIVERED = 'delivered',
-}
-
 export enum OpportunityRequirementsCode {
   VEHICLE_AT_ORIGIN = 'vehicle_at_origin',
   LEASING_SL_ACTION = 'sl_action',
@@ -139,6 +128,17 @@ export type NewOpportunity = BaseOpportunity & {
   modifiedBy?: undefined;
 };
 
+export enum VehicleSaleDealStatus {
+  SaleAgreed = 'SALE_AGREED',
+  FirstPaymentReceived = 'FIRST_PAYMENT_RECEIVED',
+  FullPaymentReceived = 'FULL_PAYMENT_RECEIVED',
+}
+
+export enum VehicleSaleLogisticsStatus {
+  AtOrigin = 'AT_ORIGIN',
+  Delivered = 'DELIVERED',
+}
+
 export type Opportunity = BaseOpportunity & {
   id: string;
   createdAt: string;
@@ -164,8 +164,8 @@ export type Opportunity = BaseOpportunity & {
   deliveredAt?: string;
   deliveredBy?: string;
   status: OpportunityStatus;
-  dealStatus?: OpportunityDealStatus;
-  logisticStatus?: OpportunityLogisticStatus;
+  dealStatus?: VehicleSaleDealStatus;
+  logisticStatus?: VehicleSaleLogisticsStatus;
   activeQuoteId?: string;
   amount?: string;
   documents?: Document[];

package/src/types/vehicle-sales.ts

@@ -0,0 +1,80 @@
+import { LocationValue } from '@bisondesk/commons-sdk/locations';
+import { Organization } from './crm.js';
+import { Opportunity, VehicleSaleDealStatus, VehicleSaleLogisticsStatus } from './opportunities.js';
+import { DeliveryTypes, Quote } from './quotes.js';
+import { DataRecord } from './utils.js';
+
+export enum VehicleSaleInfoActions {
+  VIEW_COSTS = 'canSeeCosts',
+  VIEW_CUSTOMER = 'canSeeCustomer',
+}
+
+export type VehicleSaleInfo = {
+  externalSaleId?: string;
+  opportunityId?: string;
+  sold: boolean;
+  soldAt?: string;
+  soldBy?: string;
+  dealStatus: VehicleSaleDealStatus;
+  logisticStatus: VehicleSaleLogisticsStatus;
+};
+
+export type VehicleSaleInfoBff = {
+  info: DataRecord<VehicleSaleInfo>;
+  opportunitySale?: {
+    opportunity: Opportunity;
+    activeQuote: Quote;
+  };
+  externalSale?: ExternalVehicleSale;
+  client?: Organization;
+  delivery?: {
+    address?: LocationValue;
+    type: DeliveryTypes;
+  };
+};
+
+type BaseExternalVehicleSale = {
+  log?: {
+    deliveredDate?: string;
+    deliveredReporter?: string;
+    saleAgreedDate?: string;
+    saleAgreedReporter?: string;
+    firstPaymentReceivedDate?: string;
+    firstPaymentReceivedReporter?: string;
+    fullPaymentReceivedDate?: string;
+    fullPaymentReceivedReporter?: string;
+    deletedDate?: string;
+    deletedReporter?: string;
+  };
+  source: 'HDMS' | 'Hexon';
+  deleted?: boolean;
+  status: VehicleSaleDealStatus;
+  vehicleId: string;
+  saleAmount?: number;
+  totalRevenue?: number;
+  vatPercentage?: number;
+  logisticsStatus: VehicleSaleLogisticsStatus;
+  saleAmountTaxable?: number;
+  organizationSummary?: {
+    contactId: string;
+    organizationId: string;
+  };
+  deal?: {
+    internalTransportCost?: number;
+    externalTransportCost?: number;
+    internalGarageCost?: number;
+    externalGarageCost?: number;
+    carwashCost?: number;
+    spoilerMountingCost?: number;
+    loadStackCost?: number;
+    otherCosts?: number;
+  };
+};
+
+export type ExternalVehicleSale = BaseExternalVehicleSale & {
+  id: string;
+  createdAt: string;
+  createdBy: string;
+};
+
+export type NewExternalVehicleSale = BaseExternalVehicleSale;

package/src/types/vehicles.ts

@@ -183,9 +183,16 @@ export type PublicSearchVehicle = {
   vehicle: PublicVehicle;
 };
 
+export enum SearchVehicleSaleDealStatus {
+  NotSold = 'NOT_SOLD',
+  Reserved = 'RESERVED',
+  Sold = 'SOLD',
+}
+
 export type SearchVehicle = {
   custom: {
     features: string[];
+    sold: boolean;
     isReserved: boolean;
     hasPayments: boolean;
   };
@@ -194,6 +201,13 @@ export type SearchVehicle = {
   };
   reservation?: Pick<OpportunityReservation, 'expiresAt' | 'opportunityId' | 'createdBy'>;
   vehicle: Vehicle;
+  sale: {
+    opportunityId?: string;
+    externalSaleId?: string;
+    soldAt?: string;
+    soldBy?: string;
+    dealStatus: SearchVehicleSaleDealStatus;
+  };
 };
 
 export type InputSearchVehicle = SearchVehicle & {
@@ -486,13 +500,6 @@ export type VehicleMarketing = {
   };
 };
 
-export enum VehicleSaleDealStatus {
-  SaleAgreed = 'SALE_AGREED',
-  FirstPaymentReceived = 'FIRST_PAYMENT_RECEIVED',
-  FullPaymentReceived = 'FULL_PAYMENT_RECEIVED',
-  NotSold = 'NOT_SOLD',
-}
-
 export enum VehiclePurchaseDealStatus {
   PurchaseEvaluation = 'PURCHASE_EVALUATION', // used for vehicle consignation
   PurchaseAgreed = 'PURCHASE_AGREED',
@@ -502,11 +509,6 @@ export enum VehiclePurchaseDealStatus {
   FullPaymentSent = 'FULL_PAYMENT_SENT',
 }
 
-export enum VehicleSaleLogisticsStatus {
-  AtOrigin = 'AT_ORIGIN',
-  Delivered = 'DELIVERED',
-}
-
 export enum VehiclePurchaseLogisticsStatus {
   AtOrigin = 'AT_ORIGIN',
   Arrived = 'ARRIVED',
@@ -520,11 +522,6 @@ export enum VehiclePurchaseDeliveryType {
 
 export type VehicleStatus = {
   deleted?: boolean;
-  sale: {
-    id?: string;
-    dealStatus: VehicleSaleDealStatus;
-    logisticsStatus?: VehicleSaleLogisticsStatus;
-  };
   purchase: {
     purchasedBy?: string;
     dealStatus: VehiclePurchaseDealStatus;