@bisondesk/core-sdk 1.0.23-B → 1.0.23

package/src/types/vehicles.ts

@@ -1,260 +1,15 @@
-import {
-  AttachmentValue,
-  Document,
-  LocationValue,
-  MultiLangValue,
-  SearchPermissions,
-} from '@bisondesk/commons-sdk/lib/types';
-
-type BaseVehicleEvent = {
-  id: string;
-  actionAt: string;
-  userId: string;
-  tenantId: string;
-};
-
-type VehicleSuperstructure = {
-  carCapacity?: number;
-  compartmentCount?: number;
-  counter?: boolean;
-  crane?: {
-    make?: string;
-    model?: string;
-    position?: 'Behind the cabin' | 'Rear';
-    present?: boolean;
-    year?: number;
-  };
-  dimensions?: {
-    height?: number;
-    length?: number;
-    width?: number;
-    extended?: string; // L1, L2, ...
-    heightened?: string; // H1, H2, ...
-  };
-  baseVehicle?: SuperstructureBaseVehicle;
-  extendable?: boolean;
-  highPressurePump?: boolean;
-  loadingPlatformHeight?: number;
-  pump?: boolean;
-  slidingRoof?: boolean;
-  tailgate?: {
-    capacity?: number;
-    make?: string;
-    model?: string;
-    present?: boolean;
-    type?: 'slider_lift' | 'cantilever' | 'column_lift';
-  };
-  tank?: {
-    capacity: number;
-  };
-  temperatureControl?: {
-    engineType?: 'diesel' | 'electric' | 'diesel+electric' | 'engine';
-    make?: string;
-    runningHours?: {
-      diesel?: number;
-      electric?: number;
-    };
-  };
-  tipper?: {
-    tipsBack?: boolean;
-    tipsLeft?: boolean;
-    tipsRight?: boolean;
-  };
-};
-export type NewVehicleRequest = {
-  branch: string;
-  count: number;
-  specs: VehicleExternalInfo;
-  description: {
-    remarks?: string;
-    technicalRemarks?: string;
-  };
-  logistics: {
-    vehicleRole: VehicleInternalInfo['role'];
-    parking: string;
-    deliveryType: VehiclePurchaseDeliveryType;
-    availableDate: string;
-    pickupAddress?: LocationValue;
-  };
-  prices: {
-    minimum?: string;
-    premium?: string;
-    internet?: string;
-  };
-  media: {
-    pictures: AttachmentValue[];
-    videos: AttachmentValue[];
-    docs: Document[];
-    engineeringDocs: Document[];
-  };
-  vinList?: string;
-  deal: {
-    stockNumber?: string;
-    contactId: string;
-    orgId: string;
-    purchasedBy: string;
-    dealStatus:
-      | VehiclePurchaseDealStatus.PurchaseEvaluation
-      | VehiclePurchaseDealStatus.PurchaseAgreed;
-    costs: {
-      purchase: string;
-      purchaseVatPercentage: string;
-      commission?: string;
-      externalTransport?: string;
-      internalTransport?: string;
-      externalGarage?: string;
-      internalGarage?: string;
-      other?: string;
-    };
-  };
-};
-
-export type VehicleCreateEvent = BaseVehicleEvent & {
-  action: 'create';
-  vehicle: Vehicle;
-  previousVehicle?: undefined;
-};
-
-export type VehicleUpdateEvent = BaseVehicleEvent & {
-  action: 'update';
-  vehicle: Vehicle;
-  previousVehicle: Vehicle;
-};
-
-export type VehicleDeleteEvent = BaseVehicleEvent & {
-  action: 'delete';
-  vehicle?: undefined;
-  previousVehicle: Vehicle;
-};
-
-export type VehicleEvent = VehicleCreateEvent | VehicleUpdateEvent | VehicleDeleteEvent;
-
-export type VehicleMarketingEvent = {
-  actionAt: string;
-  data: VehicleMarketing;
-  tenantId: string;
-  userId: string;
-  vehicleId: string;
-};
-
-export type UpdateVehiclesPricesEvent = {
-  id: string;
-  actionAt: string;
-  userId: string;
-  tenantId: string;
-  priceList: AttachmentValue;
-};
-
-export type PublicVehicle = Pick<Vehicle, 'external' | 'id'>;
-
-export type PublicSearchVehicle = {
-  vehicle: PublicVehicle;
-};
+// mostly inspired by the Hexon data model
 
-export enum CustomSearchState {
-  Available = 'available',
-  Expected = 'expected',
-  Reserved = 'reserved',
-}
+import { AttachmentValue } from './fields';
 
 export type SearchVehicle = {
-  custom: {
-    features: string[];
-    state: CustomSearchState[];
-  };
-  purchase?: {
-    supplierStockNumber?: string;
-  };
-  vehicle: Vehicle;
+  vehicle: Partial<Vehicle>;
 };
 
-export type InputSearchVehicle = SearchVehicle & {
-  permissions: SearchPermissions;
-};
-
-export type VehicleInternalInfo = {
+export type Vehicle = {
+  id: string;
   createdAt: string;
-  description: {
-    title: string;
-    remarks?: string;
-    technicalRemarks?: string;
-  };
-  parkingName?: string;
-  identification: {
-    administrativeNumber?: string;
-    stockNumber: string;
-    branch: string;
-
-    /**
-     * This ID is used to link different vehicle objects that represent the same real world asset.
-     * Ideally the chassis number could be used, but in some cases it is not available yet.
-     */
-    metaId: string;
-  };
-  documents: Document[];
-  engineeringDocs: Document[];
-  pricing: {
-    premium?: string;
-    minimum?: string;
-    currency?: string;
-  };
-  role: 'SALE' | 'OWN_USE' | 'RENTAL' | 'BUILD' | 'UNKNOWN';
-  status: VehicleStatus;
   updatedAt: string;
-  /* use this property to store additional terms that you want the vehicle to be found with when doing a full text search */
-  keywords?: string[];
-};
-
-export type VehicleOriginalInfo = {
-  tenantId: string;
-  identification: {
-    id: string;
-    stockNumber: string;
-    hyperdmsTenantId?: string;
-    metaId?: string;
-  };
-  salesConditions: {
-    leasing?: boolean;
-    expected?: boolean;
-    reserved?: boolean;
-    price?: string;
-    currency?: string;
-  };
-};
-
-export type VehicleAxlesInfo = {
-  details: VehicleAxle[];
-  configuration?: string;
-  count?: number;
-  poweredAxlesCount?: number;
-  wheelbase?: number;
-  suspension?: 'Air' | 'Air/Steel' | 'Steel';
-};
-
-export type SuperstructureBaseVehicle = {
-  category: string;
-  make: string;
-  model?: string;
-  type?: string;
-  axlesConfiguration?: string;
-  emissionsClass?: string;
-  transmissionType?: 'Automatic' | 'Manual' | 'Semi-Automatic';
-  vin?: string;
-  currentRegistration?: {
-    country?: string;
-  };
-  suspension?: 'Air' | 'Air/Steel' | 'Steel';
-  constructionYear?: number;
-  firstRegistration?: string;
-  odometerKm?: number;
-  powerHp?: number;
-  bodystyle?: string;
-  accessories: VehicleExternalInfo['accessories'];
-  superstructure?: Pick<VehicleSuperstructure, 'crane' | 'tailgate'>;
-};
-
-// mostly inspired by the Hexon data model
-export type VehicleExternalInfo = {
   body?: {
     cabin?: {
       type: 'Day' | 'Sleep / Small' | 'Sleep / Medium' | 'Sleep / Large';
@@ -274,7 +29,6 @@ export type VehicleExternalInfo = {
   };
   mainPicture?: AttachmentValue;
   pictures?: AttachmentValue[];
-  videos?: AttachmentValue[];
   condition?: {
     damaged?: boolean;
     odometer?: {
@@ -282,14 +36,26 @@ export type VehicleExternalInfo = {
     };
     used?: boolean;
   };
+  description?: {
+    remarks?: {
+      [lang: string]: string;
+    };
+    internal_remarks?: {
+      [lang: string]: string;
+    };
+    internal_technical_remarks?: {
+      [lang: string]: string;
+    };
+    titles?: {
+      [lang: string]: string;
+    };
+  };
   general: {
-    bodystyle?: string;
+    bodystyle: string;
     category: string;
-    make?: string;
+    make: string;
     model?: string;
-    modelName?: string;
     type?: string;
-    typeName?: string;
   };
   history?: {
     advertisingYear?: number;
@@ -299,21 +65,29 @@ export type VehicleExternalInfo = {
       technicalInspectionEndDate?: string;
     };
     firstRegistration?: string;
-    cocPvg?: string;
   };
-  identification: {
+  identification?: {
+    administrativeNumber: string;
+    externalId?: string;
+    hdmsId: string;
+    hdmsOrg: string;
     licensePlate?: string;
-    stockNumber?: string;
+    stockNumber: string;
     vin?: string;
-    buildStockNumber?: string;
   };
   powertrain?: {
-    axles?: VehicleAxlesInfo;
+    axles?: {
+      details?: VehicleAxle[];
+      configuration?: string;
+      count?: number;
+      poweredAxlesCount?: number;
+      wheelbase?: number;
+      suspension?: 'Air' | 'Air/Steel' | 'Steel';
+    };
     emissions?: {
       class?: string;
     };
     engine?: {
-      cylinderCount?: number;
       energy?: string;
       power?: {
         hp?: number;
@@ -327,14 +101,65 @@ export type VehicleExternalInfo = {
       type?: 'Automatic' | 'Manual' | 'Semi-Automatic';
     };
   };
-  salesConditions: {
+  salesConditions?: {
     leasing?: boolean;
     expected?: boolean;
     reserved?: boolean;
-    price?: string | undefined;
-    currency?: string | undefined;
+    pricing?: {
+      internet?: string;
+      premium?: string;
+      minimum?: string;
+      currency?: string;
+    };
+  };
+  superstructure?: {
+    carCapacity?: number;
+    compartmentCount?: number;
+    counter?: boolean;
+    crane?: {
+      make?: string;
+      model?: string;
+      position?: 'Behind the cabin' | 'Rear';
+      present?: boolean;
+      year?: number;
+    };
+    dimensions?: {
+      height?: number;
+      length?: number;
+      width?: number;
+      extended?: 'L1' | 'L2' | 'L3' | 'L4' | 'L5';
+      heightened?: 'H1' | 'H2' | 'H3';
+    };
+    extendable?: boolean;
+    highPressurePump?: boolean;
+    hoses?: boolean;
+    loadingPlatformHeight?: number;
+    pump?: boolean;
+    slidingRoof?: boolean;
+    tailgate?: {
+      capacity?: number;
+      make?: string;
+      model?: string;
+      present?: boolean;
+      type?: 'slider_lift' | 'cantilever' | 'column_lift';
+    };
+    tank?: {
+      capacity: number;
+    };
+    temperatureControl?: {
+      engineType?: 'diesel' | 'electric' | 'diesel+electric' | 'engine';
+      make?: string;
+      runningHours?: {
+        diesel?: number;
+        electric?: number;
+      };
+    };
+    tipper?: {
+      tipsBack?: boolean;
+      tipsLeft?: boolean;
+      tipsRight?: boolean;
+    };
   };
-  superstructure?: VehicleSuperstructure;
   weights?: {
     gvw?: number;
     massEmpty?: number;
@@ -348,6 +173,7 @@ export type VehicleExternalInfo = {
     cdPlayer?: boolean;
     centralLocking?: boolean;
     centralLubrication?: boolean;
+    crane?: boolean;
     cruiseControl?: boolean;
     electricDoorMirrors?: boolean;
     electricWindows?: boolean;
@@ -381,34 +207,9 @@ export type VehicleExternalInfo = {
   };
 };
 
-type BaseVehicle<I = VehicleInternalInfo, E = VehicleExternalInfo> = {
-  internal: I;
-  external: E;
-  original?: VehicleOriginalInfo;
-};
-
-export type NewVehicle<I = VehicleInternalInfo, E = VehicleExternalInfo> = BaseVehicle<I, E> & {
-  id?: undefined;
-};
-
-export type Vehicle<I = VehicleInternalInfo, E = VehicleExternalInfo> = BaseVehicle<I, E> & {
-  id: string;
-};
-
-export type VehiclesByChassisNumberRequest = {
-  tenantIds: string[];
-  chassisNumber: string;
-};
-
-export type VehiclesByMetaIdRequest = {
-  tenantIds: string[];
-  metaId: string;
-};
-
 export type VehicleAxle = {
-  make?: string;
   alloyWheels?: boolean;
-  brakes?: 'Disc' | 'Drum';
+  brakes?: string;
   differentialLock?: boolean;
   liftAxle?: boolean;
   maxLoad?: number;
@@ -417,7 +218,7 @@ export type VehicleAxle = {
   powered?: boolean;
   reduction?: string;
   steering?: boolean;
-  suspension?: 'Steel' | 'Air' | 'Hydraulic';
+  suspension?: string;
   twinWheels?: boolean;
   tyreConditionPercLeftInside?: number;
   tyreConditionPercLeftOutside?: number;
@@ -425,172 +226,3 @@ export type VehicleAxle = {
   tyreConditionPercRightOutside?: number;
   tyreSize?: string;
 };
-
-export type VehicleMarketing = {
-  titles: MultiLangValue;
-  remarks?: MultiLangValue;
-  marketingPlatforms: string[];
-  pictures: AttachmentValue[];
-  videos: AttachmentValue[];
-  overrides?: {
-    marketingPlatforms?: boolean;
-    remarks?: boolean;
-    titles?: boolean;
-    pictures?: boolean;
-    videos?: boolean;
-  };
-};
-
-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',
-  FirstPaymentAllowed = 'FIRST_PAYMENT_ALLOWED',
-  FirstPaymentSent = 'FIRST_PAYMENT_SENT',
-  FullPaymentAllowed = 'FULL_PAYMENT_ALLOWED',
-  FullPaymentSent = 'FULL_PAYMENT_SENT',
-}
-
-export enum VehicleSaleLogisticsStatus {
-  AtOrigin = 'AT_ORIGIN',
-  Delivered = 'DELIVERED',
-}
-
-export enum VehiclePurchaseLogisticsStatus {
-  AtOrigin = 'AT_ORIGIN',
-  Arrived = 'ARRIVED',
-  CheckedIn = 'CHECKED_IN',
-}
-
-export enum VehiclePurchaseDeliveryType {
-  PickUp = 'PICK_UP',
-  DropOff = 'DROP_OFF',
-}
-
-export type VehicleStatus = {
-  deleted?: boolean;
-  option?: {
-    id: string;
-    expirationDate: number;
-  };
-  sale: {
-    id?: string;
-    dealStatus: VehicleSaleDealStatus;
-    logisticsStatus?: VehicleSaleLogisticsStatus;
-  };
-  purchase: {
-    purchasedBy?: string;
-    dealStatus: VehiclePurchaseDealStatus;
-    logisticsStatus: VehiclePurchaseLogisticsStatus;
-  };
-};
-
-export type VehiclePriceList = {
-  uploadedAt: string;
-  uploadedBy: string;
-  priceList: AttachmentValue;
-  id: string;
-};
-
-export type UpdateVehiclesPricesRequest = {
-  priceList: AttachmentValue;
-};
-
-export type VehiclePriceListLine = {
-  reference: string;
-  internet?: string;
-  premium?: string;
-  minimum?: string;
-};
-
-export type VehiclePriceUpdateError = {
-  data: VehiclePriceListLine;
-  line: number;
-  error: {
-    fieldId: keyof VehiclePriceListLine;
-    msg: string;
-  };
-};
-
-export type VehiclePriceUpdateResponse =
-  | {
-      success: true;
-    }
-  | {
-      success: false;
-      errors: VehiclePriceUpdateError[];
-    };
-
-export type VehiclePurchase = {
-  organizationId: string;
-  contactId: string;
-  supplierStockNumber?: string;
-  purchasedBy: string;
-
-  log: {
-    evaluationStartedAt?: string;
-    evaluationStartedBy?: string;
-
-    purchaseAgreedAt?: string;
-    purchaseAgreedBy?: string;
-
-    firstPaymentAllowedAt?: string;
-    firstPaymentAllowedBy?: string;
-    firstPaymentSentAt?: string;
-    firstPaymentSentBy?: string;
-
-    fullPaymentAllowedAt?: string;
-    fullPaymentAllowedBy?: string;
-    fullPaymentSentAt?: string;
-    fullPaymentSentBy?: string;
-
-    arrivedAt?: string;
-    arrivedBy?: string;
-    checkedInAt?: string;
-    checkedInBy?: string;
-  };
-
-  deal: {
-    status: VehiclePurchaseDealStatus;
-
-    askingPrice?: string;
-    purchaseVatRate?: string;
-    purchase?: string; // exclusive VAT
-
-    commission?: string;
-    externalTransport?: string;
-    internalTransport?: string;
-    externalGarage?: string;
-    internalGarage?: string;
-    other?: string;
-  };
-
-  logistics: {
-    parkingName?: string;
-    status: VehiclePurchaseLogisticsStatus;
-    deliveryType?: VehiclePurchaseDeliveryType;
-    pickupAddress?: LocationValue;
-    availableWeek?: string; // ISOWEEK, e.g. 2016-W02
-  };
-};
-
-export enum VehicleActions {
-  EditAdminDocs = 'edit_admin_docs',
-  EditEngineeringDocs = 'edit_engineering_docs',
-  EditMarketing = 'edit_marketing',
-  EditMedia = 'edit_media',
-  EditPictures = 'edit_pictures',
-  EditPrices = 'edit_prices',
-  EditPurchaseDeal = 'edit_purchase_deal',
-  EditPurchaseLogistics = 'edit_purchase_logistics',
-  EditSpecs = 'edit_specs',
-  EditVideos = 'edit_videos',
-  ViewLeads = 'view_leads',
-  ViewSimilarOnline = 'view_similar_online',
-}