@bisondesk/core-sdk 1.0.494 → 1.0.496

package/src/types/leasing-debtors.ts

@@ -1,9 +1,4 @@
-import { EmailMessage } from '@bisondesk/commons-sdk/messages';
-import { NextList, PaginatedList } from '@bisondesk/commons-sdk/types';
 import { Contact, Organization } from './crm.js';
-import { LeasingContract } from './leasing.js';
-import { BaseSearchRequest, SortFilter } from './search.js';
-import { DataRecord, ReferenceData } from './utils.js';
 
 export type MonthData = {
   activeContractIds: string[];
@@ -38,307 +33,3 @@ export type SearchDebtorInfo = {
     hasActiveContracts: boolean;
   };
 };
-
-export enum DebtorsDossierStatus {
-  AUTO_REMINDER = 'auto_reminder',
-  OVERDUE = 'overdue',
-  CONTACT_ATTEMPTED = 'contact_attempted',
-  DIALOGUE = 'dialogue',
-  PROMISE_TO_PAY = 'promise_to_pay',
-  FAILURE = 'failure',
-  RESOLVED = 'resolved',
-}
-
-export const debtorsDossierStatusToDateFieldMap: Record<
-  DebtorsDossierStatus,
-  { date: keyof DossierStatusLogFields; author: keyof DossierStatusLogFields } | null
-> = {
-  [DebtorsDossierStatus.AUTO_REMINDER]: null,
-  [DebtorsDossierStatus.OVERDUE]: { date: 'overdueAt', author: 'overdueBy' },
-  [DebtorsDossierStatus.CONTACT_ATTEMPTED]: { date: 'contactedAt', author: 'contactedBy' },
-  [DebtorsDossierStatus.DIALOGUE]: { date: 'dialogueAt', author: 'dialogueBy' },
-  [DebtorsDossierStatus.PROMISE_TO_PAY]: { date: 'promiseToPayAt', author: 'promiseToPayBy' },
-  [DebtorsDossierStatus.FAILURE]: { date: 'failedAt', author: 'failedBy' },
-  [DebtorsDossierStatus.RESOLVED]: { date: 'resolvedAt', author: 'resolvedBy' },
-};
-
-/******
- * Auto Follow-Up Types
- ******/
-
-export type DebtorAutoFollowUp = {
-  id: string;
-  organizationId: string;
-  organizationName: string;
-  status: 'ONGOING' | 'ERROR' | 'SUCCESS' | 'EXPIRED' | 'DISCARDED';
-  emails: EmailMessage[];
-  createdAt: string;
-  modifiedAt: string;
-  completedAt?: string;
-  nextActionAt: string;
-  riskLevel: number;
-};
-
-export type ListOverdueRemindersResponse = PaginatedList<DebtorAutoFollowUp, ReferenceData>;
-export type ListOverdueRemindersRequest = {
-  offset: number;
-  limit: number;
-  sortBy: SortFilter;
-};
-
-/******
- * Debtor Dossier Types
- ******/
-
-export enum DebtorsDossierActions {
-  SET_METADATA = 'set_metadata',
-  ADD_ACTIVITY = 'add_activity',
-  FINISH = 'finish',
-  SET_DOCUMENTS = 'set_documents',
-  SET_PAYMENT_PLAN = 'set_payment_plan',
-  SET_LEGAL_DOSSIER = 'set_legal_dossier',
-}
-
-export type DossierStatusLogFields = {
-  failedAt?: string;
-  failedBy?: string;
-  resolvedAt?: string;
-  contactedAt?: string;
-  contactedBy?: string;
-  overdueAt?: string;
-  overdueBy?: string;
-  resolvedBy?: string;
-  dialogueAt?: string;
-  dialogueBy?: string;
-  promiseToPayAt?: string;
-  promiseToPayBy?: string;
-};
-
-export type BaseDebtorsDossier = {
-  organizationId: string;
-  contactId?: string;
-  tags: string[];
-  origin: 'manual' | 'auto';
-  autoFollowUpId?: string;
-  administrativeUserId?: string;
-  branchId: string;
-  tenantId: string;
-};
-export type DebtorsDossierStatusAudit = {
-  from: DebtorsDossierStatus;
-  to: DebtorsDossierStatus;
-  changedAt: string;
-  changedBy: string;
-};
-
-export type DebtorsDossier = BaseDebtorsDossier &
-  DossierStatusLogFields & {
-    id: string;
-    createdAt: string;
-    createdBy: string;
-    updatedAt: string;
-    updatedBy: string;
-    status: DebtorsDossierStatus;
-    statusAudit: DebtorsDossierStatusAudit[];
-  };
-
-export type NewDebtorsDossier = BaseDebtorsDossier & {
-  id?: undefined;
-  createdBy?: undefined;
-  createdAt?: undefined;
-  updatedBy?: undefined;
-  updatedAt?: undefined;
-};
-
-export type DebtorsDossierBff = {
-  dossier: DataRecord<DebtorsDossier>;
-  organization?: Organization;
-  contact?: Contact;
-  leasingContracts: LeasingContract[];
-  debt?: DebtorInfo;
-  paymentPlan?: DebtorsPaymentPlan;
-  legalDossier?: LegalDossier;
-  trackAndTraceDevices: {
-    /*     odometer: TrackAndTraceOdometerData;
-    device: TrackAndTraceDevice; */
-  }[];
-};
-
-export type UpdateDebtorsDossier = Partial<
-  Pick<
-    DebtorsDossier,
-    'status' | 'tags' | 'contactId' | 'administrativeUserId' | 'branchId' | 'organizationId'
-  >
-> & {
-  overdue?: boolean;
-  resolve?: boolean;
-  terminate?: boolean;
-};
-
-/******
- * Payment Plan Types
- ******/
-
-export type DebtorsPaymentPlan = {
-  id: string;
-  debtorDossierId: string;
-
-  notes?: string;
-
-  reminders?: {
-    frequency: {
-      every: number;
-      period: 'days' | 'weeks' | 'months';
-    };
-    endCondition:
-      | {
-          endDate: string; // ISO date string
-        }
-      | {
-          occurrences: number; // Number of reminders to send
-        };
-  };
-
-  createdAt: string;
-  createdBy: string;
-  updatedAt: string;
-  updatedBy: string;
-};
-
-export type NewPaymentPlan = Omit<
-  DebtorsPaymentPlan,
-  'id' | 'createdAt' | 'updatedAt' | 'createdBy' | 'updatedBy'
->;
-
-export type UpdatePaymentPlan = Partial<Pick<DebtorsPaymentPlan, 'notes' | 'reminders'>>;
-
-/******
- * Legal Dossier Types
- ******/
-
-export enum LegalDossierStatus {
-  ASSESSMENT = 'assessment',
-  PRE_LEGAL_NOTICE = 'pre_legal_notice',
-  SENT_TO_LAWYER = 'sent_to_lawyer',
-  FILED = 'filed',
-  IN_COURT = 'in_court',
-  JUDGMENT = 'judgment',
-  ENFORCEMENT = 'enforcement',
-  SETTLEMENT = 'settlement',
-  CLOSED_RECOVERED = 'closed_recovered',
-  CLOSED_UNRECOVERABLE = 'closed_unrecoverable',
-  ON_HOLD = 'on_hold',
-}
-
-export type LegalDossier = {
-  id: string;
-  debtorDossierId: string;
-  caseNumber?: string;
-  notes?: string;
-  createdAt: string;
-  createdBy: string;
-  updatedAt: string;
-  updatedBy: string;
-  status: LegalDossierStatus;
-};
-
-export type NewLegalDossier = Omit<
-  LegalDossier,
-  'id' | 'createdAt' | 'updatedAt' | 'createdBy' | 'updatedBy'
->;
-
-export type UpdateLegalDossier = Partial<Pick<LegalDossier, 'caseNumber' | 'status' | 'notes'>>;
-
-/******
- * Debtor Dossier Events
- ******/
-
-export type DebtorsDossierCreateEvent = {
-  action: 'created';
-  data: DebtorsDossier;
-  previousData?: undefined;
-  tenantId: string;
-  userId: string;
-};
-
-export type DebtorsDossierUpdateEvent = {
-  action: 'updated';
-  data: DebtorsDossier;
-  previousData: DebtorsDossier;
-  tenantId: string;
-  userId: string;
-};
-
-export type DebtorsDossierDeleteEvent = {
-  action: 'deleted';
-  data?: undefined;
-  previousData: DebtorsDossier;
-  tenantId: string;
-  userId: string;
-};
-
-export type DebtorsDossierEvent =
-  | DebtorsDossierCreateEvent
-  | DebtorsDossierUpdateEvent
-  | DebtorsDossierDeleteEvent;
-
-/************
- *
- * Search
- */
-
-export type SearchDebtorsDossier = {
-  contact?: Contact;
-  debtorsDossier: DebtorsDossier;
-  org?: Organization;
-  legalDossier?: LegalDossier;
-  paymentPlan?: DebtorsPaymentPlan;
-};
-
-/************
- *
- * Kanban
- */
-
-export type DebtorsDossierKanbanColumn = {
-  status: string;
-  results: SearchDebtorsDossier[];
-  totalCount: number;
-  totalValue: string;
-};
-
-export type MSearchDebtorsDossierKanbanColumn = {
-  column: DebtorsDossierKanbanColumn;
-  nextToken?: string;
-};
-
-export type KanbanDebtorsDossierSearchRequest = BaseSearchRequest & {
-  nextTokens?: Record<string, string | undefined>;
-};
-
-export type KanbanDebtorsDossierNextList = Omit<
-  NextList<DebtorsDossierKanbanColumn, ReferenceData>,
-  'nextToken'
-> & {
-  nextTokens?: Record<string, string | undefined>;
-};
-
-export const DebtorsDossierStatusOrder: DebtorsDossierStatus[] = [
-  DebtorsDossierStatus.AUTO_REMINDER,
-  DebtorsDossierStatus.OVERDUE,
-  DebtorsDossierStatus.CONTACT_ATTEMPTED,
-  DebtorsDossierStatus.DIALOGUE,
-  DebtorsDossierStatus.PROMISE_TO_PAY,
-];
-
-export const DebtorsDossierWonColumnId = DebtorsDossierStatus.RESOLVED;
-
-export const DebtorsDossierKanbanEndColumns: string[] = [
-  DebtorsDossierStatus.RESOLVED,
-  DebtorsDossierStatus.FAILURE,
-];
-
-export const DebtorsDossierKanbanColumns = [
-  ...DebtorsDossierStatusOrder,
-  ...DebtorsDossierKanbanEndColumns,
-];

package/src/types/leasing.ts

@@ -42,6 +42,19 @@ export type LeasingConditionEvent = {
   tenantId: string;
 };
 
+export type OverdueDossier = {
+  id: string;
+  organizationId: string;
+  organizationName: string;
+  status: 'ONGOING' | 'ERROR' | 'SUCCESS' | 'EXPIRED' | 'DISCARDED';
+  emails: EmailMessage[];
+  createdAt: string;
+  modifiedAt: string;
+  completedAt?: string;
+  nextActionAt: string;
+  riskLevel: number;
+};
+
 export type LeasingContractClient = {
   organizationId: string;
   contactIds: string[];
@@ -180,6 +193,13 @@ export type OpportunityRef = BaseRef & {
   //Since VAT is client specific and contracts can be transferred between clients, we always handle values without VAT
 };
 
+export type ListOverdueRemindersResponse = PaginatedList<OverdueDossier, ReferenceData>;
+export type ListOverdueRemindersRequest = {
+  offset: number;
+  limit: number;
+  sortBy: SortFilter;
+};
+
 export type NewLeasingConditions = {
   parameters: {
     yearlyRoadTax: string;

package/src/types/marketing-emails.ts

@@ -0,0 +1,67 @@
+import { EmailDestination } from '@bisondesk/commons-sdk/messages';
+import { AttachmentValue, NextRequest } from '@bisondesk/commons-sdk/types';
+import { SearchRequest } from './search.js';
+
+export type CampaignSearchRequest = {
+  fullText?: string;
+  query: NonNullable<SearchRequest['query']>;
+};
+
+export type MarketingEmailCampaign = {
+  id: string;
+  createdAt: string;
+  createdBy: string;
+  name: string;
+
+  vehicleIds: string[];
+  subject: string;
+  message: string;
+  pictures?: AttachmentValue[];
+
+  targets: {
+    emails?: EmailDestination[];
+    queries?: CampaignSearchRequest[];
+    leads?: boolean;
+  };
+
+  runAt?: string;
+  // determined on the moment of sending by merging all the targets
+  fullEmailList?: string[];
+};
+
+export type MarketingCampaignSentEmail = {
+  campaignId: string;
+  contactId?: string;
+  email: string;
+  runAt: string;
+
+  sentAt?: string;
+  deliveredAt?: string;
+  bouncedAt?: string;
+  complaintAt?: string;
+  openedAt?: string;
+  clickedAt?: string;
+};
+
+export type MarketingCampaignEmailEvent = {
+  tenantId: string;
+  campaignId: string;
+  email: string;
+  runAt: string;
+  contactId?: string;
+  name?: string;
+};
+
+export type MarketingCampaignStatistics = {
+  totalEmails: number;
+  successfulDeliveries: number;
+  bouncedEmails: number;
+  sentEmails: number;
+  complaints: number;
+  openedEmails: number;
+  clickedEmails: number;
+};
+
+export type SentEmailsSearchRequest = NextRequest & {
+  fullText?: string;
+};

package/src/types/tenants.ts

@@ -21,6 +21,7 @@ export enum TenantModule {
   Docs = 'docs',
   Leads = 'leads',
   Leasing = 'leasing',
+  Marketing = 'marketing',
   Insights = 'insights',
   Opportunities = 'opportunities',
   Offers = 'offers',

package/src/utils/interests.ts

@@ -0,0 +1,150 @@
+import { isoString } from '@bisondesk/commons-sdk/date-utils';
+import { generateId } from '@bisondesk/commons-sdk/ids';
+import { UTCDate } from '@date-fns/utc';
+import { first, range, uniq } from 'lodash-es';
+import { KM_ROUNDING, MAX_AGE, MAX_KM, MAX_PRICE, PRICE_ROUNDING } from '../constants.js';
+import { Interest } from '../types/interests.js';
+import { VehicleExternalInfo } from '../types/vehicles.js';
+
+export const mapVehicleToInterest = (
+  userId: string,
+  vehicleExternalInfo: VehicleExternalInfo,
+  referenceDate: Date = new UTCDate()
+): Interest => {
+  return {
+    id: generateId(),
+    createdAt: isoString(),
+    createdBy: userId,
+    modifiedAt: isoString(),
+    modifiedBy: userId,
+    bodystyle: vehicleExternalInfo.general.bodystyle,
+    cabins: toCabins(toArray(vehicleExternalInfo.body?.cabin?.type)),
+    category: vehicleExternalInfo.general.category,
+    retarderIntarder: vehicleExternalInfo.accessories.retarderIntarder ? true : undefined,
+    adr: vehicleExternalInfo.accessories.adr,
+    damaged: vehicleExternalInfo.condition?.damaged ?? false,
+    extended: toArray(vehicleExternalInfo.superstructure?.dimensions?.extended),
+    heightened: toArray(vehicleExternalInfo.superstructure?.dimensions?.heightened),
+    used: vehicleExternalInfo.condition?.used,
+    crane: vehicleExternalInfo.superstructure?.crane?.present,
+    tailgate: vehicleExternalInfo.superstructure?.tailgate?.present,
+    axleConfigurations: toArray(vehicleExternalInfo.powertrain?.axles?.configuration),
+    suspensions: toSuspensions(toArray(vehicleExternalInfo.powertrain?.axles?.suspension)),
+    transmissions: toTransmissions(toArray(vehicleExternalInfo.powertrain?.transmission?.type)),
+    euronorms: toEuronorms(vehicleExternalInfo),
+    kilometers: vehicleExternalInfo.condition?.used
+      ? toRound(KM_ROUNDING, vehicleExternalInfo.condition?.odometer?.km, MAX_KM)
+      : undefined,
+    horsepower: toMinHorsepower(vehicleExternalInfo, -0.1),
+    versions:
+      vehicleExternalInfo.general.make != null
+        ? [
+            {
+              make: vehicleExternalInfo.general.make,
+              models: toArray(vehicleExternalInfo.general.model),
+            },
+          ]
+        : undefined,
+    price: toMaxPrice(vehicleExternalInfo.salesConditions.price),
+    age: vehicleExternalInfo.condition?.used
+      ? toAge(referenceDate, vehicleExternalInfo.history?.advertisingYear)
+      : undefined,
+    autoGenerated: true,
+  };
+};
+
+const isHeavyVehicle = (vehicleExternalInfo: VehicleExternalInfo) =>
+  ['Tractor Head', 'Truck'].includes(vehicleExternalInfo.general.category);
+
+const toCabins = (values: string[] | undefined): string[] | undefined => {
+  if (values == null || values.length === 0) {
+    return;
+  }
+
+  if (values.some((v) => v.startsWith('Sleep'))) {
+    // If it allows sleep, then add the two largest sleep options as well
+    return uniq([...values, 'Sleep / Medium', 'Sleep / Large']);
+  }
+
+  return values;
+};
+
+const toSuspensions = (values: string[] | undefined): string[] | undefined => {
+  if (values == null || values.length === 0) {
+    return;
+  }
+
+  if (values.includes('Air/Steel')) {
+    // If it allows some axles with air suspension, then allow all
+    return uniq([...values, 'Air']);
+  }
+
+  return values;
+};
+
+const toTransmissions = (values: string[] | undefined): string[] | undefined => {
+  if (values == null || values.length === 0) {
+    return;
+  }
+
+  if (values.includes('Manual')) {
+    // ignore transmission restriction
+    return;
+  }
+
+  if (values.includes('Semi-Automatic')) {
+    // also consider values that are better
+    return uniq([...values, 'Automatic']);
+  }
+
+  return values;
+};
+
+const toEuronorms = (vehicleExternalInfo: VehicleExternalInfo): string[] | undefined => {
+  const values = toArray(vehicleExternalInfo.powertrain?.emissions?.class);
+  if (values == null || values.length === 0 || !isHeavyVehicle(vehicleExternalInfo)) {
+    return;
+  }
+
+  const minEuronorm = 5;
+  const maxEuronorm = 6;
+
+  const lowestEuronorm = first(values.map((v) => Number(v.charAt(v.length - 1))).sort())!;
+  if (lowestEuronorm < minEuronorm) {
+    return; // ignore Euronorm restriction
+  }
+
+  return range(lowestEuronorm, maxEuronorm + 1).map((r) => `Euro ${r}`);
+};
+
+const toAge = (referenceDate: Date, year?: number) => {
+  if (year == null) {
+    return;
+  }
+
+  if (year > referenceDate.getUTCFullYear()) {
+    return;
+  }
+
+  return toRound(1, referenceDate.getUTCFullYear() - year, MAX_AGE);
+};
+
+const toMaxPrice = (value?: number | string) =>
+  value != null ? toRound(PRICE_ROUNDING, Number(value) * 1.15, MAX_PRICE) : undefined;
+
+const toMinHorsepower = (
+  vehicleExternalInfo: VehicleExternalInfo,
+  shiftRatio: number
+): number | undefined => {
+  const hasHorsepower = vehicleExternalInfo.powertrain?.engine?.power?.hp != null;
+  const isHorsepowerImportant = isHeavyVehicle(vehicleExternalInfo);
+
+  if (hasHorsepower && isHorsepowerImportant) {
+    return toRound(5, vehicleExternalInfo.powertrain!.engine!.power!.hp! * (1 + shiftRatio));
+  }
+};
+
+const toRound = (r: number, value?: number | string, max: number = Infinity) =>
+  value != null ? Math.min(Math.ceil(Number(value) / r) * r, max) : undefined;
+
+const toArray = (value?: string): string[] => (value ? [value] : []);

package/src/utils/search.ts

@@ -1,24 +1,17 @@
 import { joinWithSeparator } from '@bisondesk/commons-sdk/formatting';
 import { BusinessEntityIds } from '../constants.js';
 import { Contact, Organization, SearchOrganization } from '../types/crm.js';
-import { DebtorsDossier, SearchDebtorsDossier } from '../types/leasing-debtors.js';
 import { SearchLeasingContract } from '../types/leasing-search.js';
 import { LeasingContract } from '../types/leasing.js';
 import { Opportunity, SearchOpportunity } from '../types/opportunities.js';
 import { SearchVehicle, Vehicle } from '../types/vehicles.js';
 
-export type GlobalBusinessEntity =
-  | Opportunity
-  | Vehicle
-  | Organization
-  | LeasingContract
-  | DebtorsDossier;
+export type GlobalBusinessEntity = Opportunity | Vehicle | Organization | LeasingContract;
 export type GlobalSearchEntity =
   | SearchOpportunity
   | SearchVehicle
   | SearchOrganization
-  | SearchLeasingContract
-  | SearchDebtorsDossier;
+  | SearchLeasingContract;
 
 export const getCustomerInformation = (org?: Organization, contact?: Contact) => {
   if (org != null) {