@bisondesk/core-sdk 1.0.169 → 1.0.171

package/src/types/fields.ts

@@ -1,5 +1,3 @@
-import { MultiLangValue } from '@bisondesk/commons-sdk/lib/types';
-
 export enum FieldTypes {
   attachment = 'attachment',
   checkbox = 'checkbox',
@@ -28,18 +26,6 @@ export enum DateGranularity {
   yearMonthDayTime = 'yearMonthDayTime',
 }
 
-export type AttachmentValue = {
-  contentType: string;
-  fileName: string;
-  id: string;
-  previewSrc?: string;
-  size: number;
-  uploadedAt: string;
-  uploadedBy: string;
-  url: string;
-  descriptions?: string | MultiLangValue;
-};
-
 //
 // Field metas
 //

package/src/types/leads.ts

@@ -120,6 +120,7 @@ export type Interest = {
   suspensions?: string[];
   tailgate?: boolean;
   transmissions?: string[];
+  autoGenerated?: boolean;
 
   remarks?: string;
 };

package/src/types/leasing-administration.ts

@@ -1,5 +1,5 @@
+import { AttachmentValue } from '@bisondesk/commons-sdk/lib/types';
 import { LeasingAdminUploadHandlers } from '../constants';
-import { AttachmentValue } from './fields';
 
 export type LeasingAdminUploadStatus = 'success' | 'processing' | 'error';
 
@@ -61,7 +61,7 @@ export type DhondtInvoiceLine = {
   NettoPremie: number;
   Plaatnummer: string;
   Taksen: number;
-  VoertuigVlootNummer: string;
+  VoertuigVlootNummer: string | undefined;
 };
 
 export type INGMetadata = {

package/src/types/leasing-settings.ts

@@ -1,16 +1,48 @@
 import { Categories } from '../constants';
 
-export type LeasingQuoteParams = { id: string; name: string } & {
-  allRisks: string;
-  allRisksTax: string;
-  oneTimeRoadTax: string;
-  specialTechnicalInsurance: string;
-  yearlyRoadTax: string;
-  civilLiabilities: string;
+export type LeasingQuoteParams = { id: string; name: string; modifiedAt: string } & {
   countryCode: 'be';
+  insurance: {
+    allRisksCost: string;
+    allRisksTax: string;
+    allRisksFees: string;
+    allRisksMinimumCost: string;
+    specialTechnicalInsuranceCost: string;
+    specialTechnicalInsuranceTax: string;
+    specialTechnicalInsuranceFees: string;
+    civilLiabilitiesCost: string;
+    civilLiabilitiesTax: string;
+    civilLiabilitiesFees: string;
+    roadAssistanceMonthlySalesPrice: string; // monthly Price
+    roadAssistanceMonthlyCostPrice: string; // monthly Price
+    margin: string;
+  };
+  leasing: {
+    leasingInterestRate: string;
+    leasingDuration: number;
+    leasingStartupFeePercentage: string;
+    leasingDepositPercentage: string;
+    leasingResidualValuePercentage: string;
+  };
+  taxes: {
+    oneTimeRoadTax: string;
+    yearlyRoadTax: string;
+    margin: string;
+  };
+  costs: {
+    bankDepositPercentage: string;
+    bankInterestRate: string;
+    bankResidualValuePercentage: string;
+    bankDuration: number;
+    trackAndTrace24Cost: string;
+    trackAndTrace36Cost: string;
+    trackAndTrace48Cost: string;
+    trackAndTraceMaxCost: string;
+  };
 };
 
-type BaseLeasingQuoteExtra = {
+type BaseLeasingQuoteExtraSettings = {
+  referenceCode: string;
   active: boolean;
   costPrice: string;
   countryCode: string;
@@ -19,13 +51,48 @@ type BaseLeasingQuoteExtra = {
   hint?: string;
   name: string;
   salesPrice: string;
-  vehicleCategory: Categories;
+  vehicleCategoryRestrictions?: Categories[];
 };
 
-export type NewLeasingQuoteExtra = BaseLeasingQuoteExtra & {
+type BaseLeasingQuoteExtraInput = {
+  agreedPrice: string;
+  clientPercentage: LeasingItemsPaymentSplit;
+  costPrice: string;
+  hint?: string;
+  leasingPercentage: string;
+  name: string;
+  referenceCode: string;
+  quantity: number;
+  id: string;
+};
+
+export type NewLeasingQuoteExtraSettings = BaseLeasingQuoteExtraSettings & {
   id: undefined;
 };
 
-export type LeasingQuoteExtra = BaseLeasingQuoteExtra & {
+export type LeasingQuoteExtraSettings = BaseLeasingQuoteExtraSettings & {
   id: string;
 };
+
+export enum LeasingItemsPaymentSplit {
+  Customer = 'customer',
+  Split = 'split',
+  Company = 'company',
+}
+
+export type CustomLeasingQuoteExtraInput = BaseLeasingQuoteExtraInput & {};
+
+export type LeasingQuoteExtraInput = BaseLeasingQuoteExtraInput & {
+  salesPrice: string;
+};
+
+export type LeasingQuoteExtrasRequest = {
+  deliveryPackage?: boolean;
+  displayByDefault?: boolean;
+  vehicleCategory?: Categories;
+  country: string;
+  name?: string;
+  active?: boolean;
+  offset?: number;
+  limit?: number;
+};

package/src/types/leasing.ts

@@ -1,5 +1,4 @@
-import { LinkValue, PaginatedList } from '@bisondesk/commons-sdk/lib/types';
-import { AttachmentValue } from './fields';
+import { AttachmentValue, LinkValue, PaginatedList } from '@bisondesk/commons-sdk/lib/types';
 import { EmailMessage } from './messages';
 import { SortFilter } from './search';
 import { ReferenceData } from './utils';
@@ -200,8 +199,8 @@ export type AmortizationRow = {
 };
 
 export type AmortizationTable = {
-  annualInterestRate: string;
-  monthlyInterestRate: string;
+  annualInterestRate?: string;
+  monthlyInterestRate?: string;
   rows: AmortizationRow[];
 };
 

package/src/types/machines.ts

@@ -0,0 +1,39 @@
+export type Machine = {
+  axlesConfiguration?: string;
+  bodywork?: string;
+  category: string;
+  vin?: string;
+  cocPvg?: string;
+  emptyWeightKg?: number;
+  euronorm?: string;
+  firstRegistration?: string;
+  gearbox?: string;
+  kilometers?: number;
+  make?: string;
+  makeModel?: string;
+  makeModelType?: string;
+  powerHp?: number;
+  productionYear?: number;
+  suspension?: string;
+  totalWeightKg?: number;
+  wheelbaseCm?: number;
+
+  references: MachineReference[];
+  id: string;
+};
+
+export type MachineReference = {
+  administrativeNumber?: string;
+  metaId: string;
+  stockNumber: string;
+  tenantId: string;
+  vehicleId: string;
+};
+
+export type MachineEvent = {
+  machine: Machine;
+  action: 'upsert' | 'delete';
+  actionAt: string;
+  tenantId: string;
+  namespace: string;
+};

package/src/types/messages.ts

@@ -1,4 +1,4 @@
-import { AttachmentValue } from './fields';
+import { AttachmentValue } from '@bisondesk/commons-sdk/lib/types';
 
 export type EmailAddress = {
   name?: string;

package/src/types/opportunities.ts

@@ -1,65 +1,69 @@
+import { AttachmentValue } from '@bisondesk/commons-sdk/lib/types';
+import { OpportunityType } from '../constants';
+import { Contact, Organization } from './crm';
 import { Interest } from './leads';
+import { LeasingQuote, QuoteStatus } from './quotes';
+import { DataRecord } from './utils';
 import { Vehicle } from './vehicles';
 
-enum OpportunityDealStatus {
+export enum OpportunityActions {
+  CLOSED_LOST = 'closed_lost',
+  CLOSES_WON = 'closed_won',
+  OPEN = 'open',
+}
+
+export enum OpportunityDealStatus {
   SALES_AGREED = 'sales_agreed',
   FIRST_PAYMENT = 'first_payment',
   FULL_PAYMENT = 'full_payment',
 }
 
-enum OpportunityStatus {
-  PROSPECTING = 'prospecting',
-  DISCOVERY = 'discovery',
-  CUSTOMER_EVALUATING = 'customer_evaluating',
-  NEGOTIATION_REVIEW = 'negotiation_review',
-  WON = 'won',
-  LOST = 'lost',
+export enum OpportunityStatus {
+  PROSPECTION = 'prospection',
+  VEHICLE_DISCOVERY = 'vehicle_discovery',
+  QUOTE_EVALUATION = 'quote_evaluation',
+  VEHICLE_LOCKED = 'vehicle_locked',
+  QUOTE_ACCEPTED = 'quote_accepted',
+  CLOSED_WON = 'closed_won',
+  CLOSED_LOST = 'closed_lost',
 }
 
-enum OpportunityLogisticStatus {
+export enum OpportunityLogisticStatus {
   AT_ORIGIN = 'at_origin',
   DELIVERED = 'delivered',
 }
 
-enum OpportunityType {
-  LEASING = 'leasing',
-  SALES = 'sales',
+export enum OpportunityLostReasonValues {
+  NOT_INTERESTED = 'not_interested',
+  NOT_ENOUGH_INFO = 'not_enough_info',
+  NO_RESPONSE = 'no_response',
+  QUOTE_REJECTED = 'quote_rejected',
 }
 
-export type Bid = {
-  id: string;
+type BaseBid = {
   vehicleId: string;
-  opportunityId: string;
+  opportunityId?: string;
   contactId: string;
   amount: string;
-  createdAt: string;
-  createdBy: string;
 };
 
-export type Quote = {
+export type NewBid = BaseBid & {};
+
+export type Bid = BaseBid & {
   id: string;
+  createdAt: string;
+  createdBy: string;
 };
 
 type BaseOpportunity = {
-  accountManager?: string;
-  countryCode: string;
+  accountManager: string;
+  type: OpportunityType;
   organizationId?: string;
-  /** will not be filled if organizationId is present */
-  orgName?: string;
   contactId?: string;
-  /** will not be filled if contactId is present */
-  contactName?: string;
   vehicleId?: string;
-  vechicle?: Vehicle;
-  bids?: Bid[];
-  dealStatus: OpportunityDealStatus;
-  logisticStatus: OpportunityLogisticStatus;
-  type: OpportunityType;
-  contractId?: string;
-  quotes?: Quote[];
-  amount: string;
-  status: OpportunityStatus;
-  interest: Interest;
+  source: string; // e.g. manual, website, autoscout, mobile...
+  branch: string;
+  branchCountry: 'be'; //eventually this variable should read the country of the branch
 };
 
 export type NewOpportunity = BaseOpportunity & {
@@ -70,10 +74,97 @@ export type NewOpportunity = BaseOpportunity & {
   modifiedBy?: undefined;
 };
 
+export type OpportunityDocument = {
+  type: string; // passport, driving_license, ...
+  displayName: string;
+  file: AttachmentValue;
+};
+
 export type Opportunity = BaseOpportunity & {
   id: string;
   createdAt: string;
   createdBy: string;
   modifiedAt: string;
   modifiedBy: string;
+  lostAt?: string;
+  lostBy?: string;
+  lostReason?: OpportunityLostReasonValues;
+  deliveredAt?: string;
+  deliveredBy?: string;
+  status: OpportunityStatus;
+  dealStatus?: OpportunityDealStatus;
+  logisticStatus?: OpportunityLogisticStatus;
+  activeQuoteId?: string;
+  contractId?: string;
+  amount?: string;
+  interest?: Interest;
+  documents?: OpportunityDocument[];
+};
+
+export type OpportunityUpdate = {
+  vehicleId?: string | null;
+  accountManager?: string;
+  contactId?: string | null;
+  activeQuoteId?: string;
+  interest?: Interest | null;
+  lost?: boolean;
+  lostReason?: OpportunityLostReasonValues;
+  delivered?: boolean;
+  documents?: OpportunityDocument[];
+  branch?: string;
+  branchCountry?: 'be'; //eventually this variable should read the country of the branch
+  type?: OpportunityType;
+  open?: boolean;
+};
+
+export type OpportunityBFF = {
+  opportunity: DataRecord<Opportunity>;
+  vehicle?: DataRecord<Vehicle>;
+  bids: DataRecord<Bid>[];
+  quotes: DataRecord<LeasingQuote>[];
+  customer?: {
+    contact: DataRecord<Contact>;
+    org?: DataRecord<Organization>;
+  };
+};
+
+export type OpportunityEvent = {
+  opportunity: Opportunity;
+  action: 'create' | 'update' | 'delete';
+  actionAt: string;
+  userId: string;
+  tenantId: string;
+};
+
+export type QuoteEvent = {
+  quote: LeasingQuote;
+  opportunity: Opportunity;
+  action: 'create' | 'update' | 'delete';
+  actionAt: string;
+  userId: string;
+  tenantId: string;
+};
+
+/* Quote summary with information that should be common to different types of quotes */
+export type QuoteInfo = {
+  status: QuoteStatus;
+  roi: string;
+  dealValue: string;
+};
+
+export type SearchOpportunity = {
+  contact?: Contact;
+  opportunity: Opportunity;
+  org?: Organization;
+  vehicle?: Vehicle;
+  quote?: QuoteInfo;
+};
+
+export const QUOTE_CREATED_NOTIFICATION_ORIGIN = 'quote-created';
+export const QUOTE_VALIDATOR_FEEDBACK_NOTIFICATION_ORIGIN = 'quote-validator-feedback';
+export const QUOTE_CUSTOMER_FEEDBACK_NOTIFICATION_ORIGIN = 'quote-customer-feedback';
+export const OPPORTUNITY_CLOSED_NOTIFICATION_ORIGIN = 'opportunity-closed';
+
+export type OpportunityNotificationData = {
+  quoteVersion?: number;
 };

package/src/types/quotes.ts

@@ -0,0 +1,166 @@
+import { AttachmentValue } from '@bisondesk/commons-sdk/lib/types';
+import { OpportunityType } from '../constants';
+import { CustomLeasingQuoteExtraInput, LeasingQuoteExtraInput } from './leasing-settings';
+
+export enum QuoteActions {
+  ACCEPTANCE = 'acceptance',
+  VALIDATE = 'validation',
+  DONWLOAD_PDF = 'download-pdf',
+  CANCEL = 'cancel',
+}
+
+export enum QuoteStatus {
+  CREATED = 'created',
+  VALIDATED = 'validated',
+  INVALIDATED = 'invalidated',
+  ACCEPTED = 'accepted',
+  REJECTED = 'rejected',
+  CANCELLED = 'cancelled',
+}
+
+export enum LeasingQuoteMetricsScore {
+  DANGER = 'danger',
+  NEUTRAL = 'neutral',
+  GOOD = 'good',
+}
+
+type BaseLeasingCalculatorInput = {
+  branch: string;
+  branchCountry: 'be'; //eventually this variable should read the country of the branch
+  vehicleCategory: string;
+};
+
+export type LeasingCalculatorDefaultInput = BaseLeasingCalculatorInput & {
+  salesPrice: string;
+  purchasePrice: string;
+  deliveryPackage?: LeasingQuoteExtraInput;
+  extras?: LeasingQuoteExtraInput[];
+  customRequests?: CustomLeasingQuoteExtraInput[];
+};
+
+export type LeasingCalculatorInput = BaseLeasingCalculatorInput & {
+  localLicensePlate: boolean;
+  vanCourier: boolean;
+  leasing: {
+    salesPrice: string;
+    deposit: string;
+    depositPercentage: string;
+    residual: string;
+    residualPercentage: string;
+    startupFee: string;
+    startupFeePercentage: string;
+    interestRate: string;
+    purchasePrice: string;
+    duration: number;
+  };
+  bank: {
+    interestRate: string;
+    deposit: string;
+    depositPercentage: string;
+    residual: string;
+    residualPercentage: string;
+    duration: number;
+    salesPrice: string;
+  };
+  taxes: {
+    yearlyRoadTax: boolean;
+    oneTimeRoadTax: boolean;
+    margin: string; //Non Editable, copies the value insurance > margin
+  };
+  insurance: {
+    margin: string;
+    civilLiabilities: boolean;
+    allRisks: boolean;
+    specialTechnicalInsurance: boolean;
+    roadAssistance: boolean;
+  };
+  deliveryPackage?: LeasingQuoteExtraInput;
+  extras: LeasingQuoteExtraInput[];
+  customRequests: CustomLeasingQuoteExtraInput[];
+};
+
+export type LeasingCalculatorOutput = {
+  installment: string;
+  totalMonthlyAmount: string;
+  beforeDelivery: string;
+  financingAmount: string;
+  settingId: string;
+  totalRetailAmount: string;
+  roi: {
+    value: string;
+    target: string;
+    perYear: string;
+    difference: string;
+    score: LeasingQuoteMetricsScore;
+  };
+  cashflow: {
+    deficit: string;
+    balanced: boolean;
+    score: LeasingQuoteMetricsScore;
+  };
+  profitability: {
+    leasing: string;
+    vehicle: string;
+    total: string;
+    score: LeasingQuoteMetricsScore;
+  };
+  taxes: {
+    yearlyRetailPrice: string;
+    monthlyRetailPrice: string;
+    yearlyRoadTax: string;
+    oneTimeRoadTax: string;
+  };
+  insurance: {
+    yearlyRetailPrice: string;
+    monthlyRetailPrice: string;
+    civilLiabilities: string;
+    allRisks: string;
+    specialTechnicalInsurance: string;
+    roadAssistance: string;
+  };
+  costs: {
+    financingAmount: string;
+    monhtly: string;
+    trackAndTrace: string;
+  };
+};
+
+type BaseLeasingQuote = {
+  opportunityId: string;
+  vehicleId: string;
+  organizationId: string;
+  calculatorInput: LeasingCalculatorInput;
+  calculatorOutput: LeasingCalculatorOutput;
+  type: OpportunityType;
+  preferredLanguage: string;
+};
+
+export type NewLeasingQuote = BaseLeasingQuote & {
+  id?: undefined;
+  createdAt?: undefined;
+  createdBy?: undefined;
+  modifiedAt?: undefined;
+  modifiedBy?: undefined;
+};
+
+export type LeasingQuote = BaseLeasingQuote & {
+  id: string;
+  createdAt: string;
+  createdBy: string;
+  modifiedAt: string;
+  modifiedBy: string;
+  validationBy?: string;
+  validationAt?: string;
+  cancelledBy?: string;
+  cancelledAt?: string;
+  customerFeedbackAt?: string;
+  customerFeedbackBy?: string;
+  version: number;
+  status: QuoteStatus;
+  proformaPdf?: AttachmentValue;
+  quotePdf?: AttachmentValue;
+};
+
+export type QuoteStatusUpdate = {
+  status: QuoteStatus;
+};

package/src/types/recently-viewed.ts

@@ -1,6 +1,5 @@
-import { Requester } from '@bisondesk/commons-sdk/lib/types';
+import { AttachmentValue, Requester } from '@bisondesk/commons-sdk/lib/types';
 import { BusinessEntityIds } from '../constants';
-import { AttachmentValue } from './fields';
 
 export type ViewedItemsRequest = {
   businessEntity?: string;

package/src/types/settings.ts

@@ -31,6 +31,11 @@ export type HyperportalSettings = {
   };
 };
 
+export type HyperportalMachinesSettings = {
+  hcTenantId: string;
+  active: boolean;
+};
+
 export type LeasingCreditorBranch = {
   bciNumber: string;
   vatNumber: string;

package/src/types/tenants.ts

@@ -19,6 +19,15 @@ export type Tenant = PublicTenant & {
   hyperdmsIds?: string[];
   hyperportalId?: string;
   exactAccounting?: boolean;
+  branches: Branch[];
+};
+
+export type Branch = {
+  id: string;
+  name: string;
+  country: string;
+  exactAccounting?: boolean;
+  currency: string;
 };
 
 export type HdmsVehiclesSync = {

package/src/types/users.ts

@@ -1,6 +1,9 @@
 import { AppRoles } from '@bisondesk/commons-sdk/lib/constants';
-import { PhoneNumberRawValue, PhoneNumberValue } from '@bisondesk/commons-sdk/lib/types';
-import { AttachmentValue } from './fields';
+import {
+  AttachmentValue,
+  PhoneNumberRawValue,
+  PhoneNumberValue,
+} from '@bisondesk/commons-sdk/lib/types';
 
 export type NewUserRequest = {
   email: string;

package/src/types/utils.ts

@@ -40,7 +40,8 @@ export type AdHocRecordTitles = {
   };
 };
 
-export type MetaRecord<T> = {
+export type DataRecord<T, M = undefined> = {
   record: T;
-  meta: ReferenceData;
+  meta?: M; // typically ReferenceData
+  actions: string[];
 };