@bisondesk/core-sdk 1.0.7 → 1.0.9

package/src/types/search.ts

@@ -1,44 +1,12 @@
-import { SortFilter } from '@bisondesk/commons-sdk/lib/types';
-import { FieldTypes } from './fields';
+///////////////////////////////////////////////////////
+// Generic stuff
+///////////////////////////////////////////////////////
 
 export enum ConditionType {
   and = 'AND',
   or = 'OR',
 }
 
-export type Filter<OP extends string = string> = {
-  data: string;
-  fieldId: string;
-  fieldType: FieldTypes;
-  operator: OP;
-};
-
-export type ComplexFilter<OP extends string = string> = {
-  condition: ConditionType;
-  filters: Array<Filter<OP> | ComplexFilter<OP>>;
-};
-
-export type SearchRequest<OP extends string = string> = {
-  fullText?: string;
-  limit: number;
-  offset?: number;
-  query?: ComplexFilter<OP>;
-  sortBy?: SortFilter[];
-  lang: string;
-};
-
-export type RecordSearchRequest<OP extends string = string> = SearchRequest<OP> & {
-  businessEntityId: string;
-};
-
-export type TextSearchRequest = {
-  businessEntityIds?: string[]; // omit to search across all valid business entities
-  fullText: string;
-  limit: number;
-  offset?: number;
-  lang: string;
-};
-
 export enum ElasticsearchOperator {
   // all properties
   empty = 'EMPTY',
@@ -58,66 +26,16 @@ export enum ElasticsearchOperator {
   endsWith = 'ENDS_WITH',
 }
 
-export enum DateOperator {
-  after = 'GTE',
-  before = 'LTE',
-  empty = 'EMPTY',
-  is = 'IS',
-  lastMonth = 'LAST_MONTH',
-  lastWeek = 'LAST_WEEK',
-  notEmpty = 'NOT_EMPTY',
-  thisMonth = 'THIS_MONTH',
-  thisWeek = 'THIS_WEEK',
-  today = 'TODAY',
-  yesterday = 'YESTERDAY',
-}
-
-export enum NumberOperator {
-  between = 'BETWEEN',
-  empty = 'EMPTY',
-  greaterThan = 'GT',
-  greaterThanOrEqual = 'GTE',
-  is = 'IS',
-  isNot = 'IS_NOT',
-  lessThan = 'LT',
-  lessThanEqual = 'LTE',
-  notEmpty = 'NOT_EMPTY',
-}
-
-export enum CheckboxOperator {
-  empty = 'EMPTY',
-  is = 'IS',
-  notEmpty = 'NOT_EMPTY',
-}
-
-export enum PicklistOperator {
-  empty = 'EMPTY',
-  isMultiple = 'IS_MULTIPLE',
-  isNotMultiple = 'IS_NOT_MULTIPLE',
-  notEmpty = 'NOT_EMPTY',
-}
-
-export enum RatingOperator {
-  empty = 'EMPTY',
-  greaterThan = 'GT',
-  greaterThanOrEqual = 'GTE',
-  is = 'IS',
-  isNot = 'IS_NOT',
-  lessThan = 'LT',
-  lessThanEqual = 'LTE',
-  notEmpty = 'NOT_EMPTY',
-}
+export type Filter<OP = ElasticsearchOperator> = {
+  data: string;
+  fieldId: string;
+  operator: OP;
+};
 
-export enum TextOperator {
-  contains = 'CONTAINS',
-  empty = 'EMPTY',
-  endsWith = 'ENDS_WITH',
-  is = 'IS',
-  isNot = 'IS_NOT',
-  notContains = 'NOT_CONTAINS',
-  notEmpty = 'NOT_EMPTY',
-  startsWith = 'STARTS_WITH',
-}
+export type ComplexFilter<OP = ElasticsearchOperator> = {
+  condition: ConditionType;
+  filters: Array<Filter<OP> | ComplexFilter<OP>>;
+};
 
 export type SearchResponse<T = any> = {
   took: number;
@@ -145,9 +63,29 @@ export type SearchResponse<T = any> = {
       sort?: Array<string | number>;
     }>;
   };
-  aggregations?: unknown;
+  aggregations?: { [aggName: string]: object };
+};
+
+///////////////////////////////////////////////////////
+// Search
+///////////////////////////////////////////////////////
+
+export const FILTER_RANGE_SEPARATOR = '__';
+
+export enum SortOrder {
+  asc = 'asc',
+  desc = 'desc',
+}
+
+export type SortFilter = {
+  fieldId: string;
+  order: SortOrder;
 };
 
-export type FilterTransformer = (
-  filter: Filter<string>
-) => Filter<ElasticsearchOperator> | ComplexFilter<ElasticsearchOperator>;
+export type SearchRequest = {
+  fullText?: string;
+  limit: number;
+  offset?: number;
+  query?: ComplexFilter<ElasticsearchOperator>;
+  sortBy?: SortFilter[];
+};

package/src/types/tenants.ts

@@ -14,3 +14,14 @@ export type Tenant = NewTenant & {
   // Pay attention to what information is added here since
   // the tenant can be obtained without authentication
 };
+
+export type HdmsVehiclesSync = {
+  active: boolean;
+  filterName: string;
+};
+
+export type TenantSyncSettings = {
+  tenantId: string;
+  hdmsVehicles: HdmsVehiclesSync | undefined;
+  hdmsCrm: unknown | undefined;
+};

package/src/types/vehicles.ts

@@ -0,0 +1,222 @@
+// mostly inspired by the Hexon data model
+
+import { AttachmentValue } from './fields';
+
+export type Vehicle = {
+  id: string;
+  body?: {
+    cabin?: {
+      type: 'Day' | 'Sleep / Small' | 'Sleep / Medium' | 'Sleep / Large';
+      model?: string;
+    };
+    colour?: string;
+    dimensions?: {
+      height?: number;
+      length?: number;
+      width?: number;
+    };
+    doorCount?: number;
+    interior?: {
+      bedCount?: number;
+      seatCount?: number;
+    };
+  };
+  mainPicture?: AttachmentValue;
+  pictures?: AttachmentValue[];
+  condition?: {
+    damaged?: boolean;
+    odometer?: {
+      km?: number;
+    };
+    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;
+    category: string;
+    make: string;
+    model?: string;
+    type?: string;
+  };
+  history?: {
+    advertisingYear?: number;
+    constructionYear?: number;
+    currentRegistration?: {
+      country?: string;
+      technicalInspectionEndDate?: string;
+    };
+    firstRegistration?: string;
+  };
+  identification?: {
+    administrativeNumber: string;
+    externalId?: string;
+    hdmsId: string;
+    hdmsOrg: string;
+    licensePlate?: string;
+    stockNumber: string;
+    vin?: string;
+  };
+  powertrain?: {
+    axles?: {
+      details?: VehicleAxle[];
+      configuration?: string;
+      count?: number;
+      poweredAxlesCount?: number;
+      wheelbase?: number;
+      suspension?: 'Air' | 'Air/Steel' | 'Steel';
+    };
+    emissions?: {
+      class?: string;
+    };
+    engine?: {
+      energy?: string;
+      power?: {
+        hp?: number;
+      };
+      displacement?: number;
+    };
+    transmission?: {
+      gearCount?: number;
+      make?: string;
+      model?: string;
+      type?: 'Automatic' | 'Manual' | 'Semi-Automatic';
+    };
+  };
+  salesConditions?: {
+    leasing?: boolean;
+    expected?: boolean;
+    reserved?: boolean;
+    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;
+    };
+  };
+  weights?: {
+    gvw?: number;
+    massEmpty?: number;
+  };
+  accessories: {
+    abs?: boolean;
+    adr?: boolean;
+    airco?: boolean;
+    alloyWheels?: boolean;
+    aluminiumFuelTank?: boolean;
+    cdPlayer?: boolean;
+    centralLocking?: boolean;
+    centralLubrication?: boolean;
+    crane?: boolean;
+    cruiseControl?: boolean;
+    electricDoorMirrors?: boolean;
+    electricWindows?: boolean;
+    engineBrake?: boolean;
+    forklift?: boolean;
+    navigationSystem?: boolean;
+    hydraulicTipperKit?: boolean;
+    lowDeck?: boolean;
+    lowNoise?: boolean;
+    parkingHeater?: boolean;
+    particleFilter?: boolean;
+    powerTakeOff?: boolean;
+    refrigerator?: boolean;
+    retarderIntarder?: boolean;
+    reversingCamera?: boolean;
+    roofSpoiler?: boolean;
+    sideSkirts?: boolean;
+    spareKey?: boolean;
+    spareWheel?: boolean;
+    speedLimiter?: boolean;
+    spoilers?: boolean;
+    spotlights?: boolean;
+    stabilityControl?: boolean;
+    standardAirco?: boolean;
+    television?: boolean;
+    toolbox?: boolean;
+    trailerCoupling?: boolean;
+    twinFuelTank?: boolean;
+    visor?: boolean;
+    xenonLights?: boolean;
+  };
+};
+
+export type VehicleAxle = {
+  alloyWheels?: boolean;
+  brakes?: string;
+  differentialLock?: boolean;
+  liftAxle?: boolean;
+  maxLoad?: number;
+  nr: number;
+  position?: string;
+  powered?: boolean;
+  reduction?: string;
+  steering?: boolean;
+  suspension?: string;
+  twinWheels?: boolean;
+  tyreConditionPercLeftInside?: number;
+  tyreConditionPercLeftOutside?: number;
+  tyreConditionPercRightInside?: number;
+  tyreConditionPercRightOutside?: number;
+  tyreSize?: string;
+};