@bisondesk/core-sdk 1.0.23-B → 1.0.23

package/src/types/crm.ts

@@ -1,141 +1,53 @@
-import {
-  LocationValue,
-  PhoneNumberRawValue,
-  PhoneNumberValue,
-  SearchPermissions,
-} from '@bisondesk/commons-sdk/lib/types';
-import { PublicSearchDefinition } from './definitions';
-import { LeasingContract } from './leasing';
-import { ReferenceData } from './utils';
+import { PhoneNumberValue } from './fields';
+import { Interest } from './interests';
 
-export type CrmEvent = CrmOrganizationEvent | CrmContactEvent;
-
-export type CrmContactEvent = {
-  contactId: string;
-  organizationId?: string;
-  action: 'upsert' | 'delete';
-  actionAt: string;
-  userId: string;
-  tenantId: string;
-};
-
-export type CrmOrganizationEvent = {
-  organizationId: string;
-  action: 'upsert' | 'delete';
-  actionAt: string;
-  userId: string;
-  tenantId: string;
-};
-
-type BaseOrganization = {
-  inUse: boolean;
+export type Organization = {
   countryCode: string;
-  syncedAt: string;
+  createdAt: string;
+  createdBy: string;
+  externalId: number;
+  id: string;
   name: string;
   segment?: string;
   type?: 'COMPANY' | 'INDIVIDUAL';
   vatNumber?: string;
-  addresses?: {
-    legal?: LocationValue;
-    transport?: LocationValue;
-  };
-  accountManagers: string[];
-  billingEmails?: string[];
-  skipPaymentReminders?: boolean;
-  trustworthy?: boolean;
-};
-
-export type NewOrganization = BaseOrganization & {
-  id?: undefined;
-  externalId?: undefined;
-  createdAt?: undefined;
-  createdBy?: undefined;
-};
-
-export type Organization = BaseOrganization & {
-  createdAt: string;
-  externalId: number;
-  createdBy: string;
-  id: string;
-  debt?: OrganizationDebtInfo;
-  blocked?: boolean;
-  blockedAt?: string;
-  blockedBy?: string;
-  blockedReason?: string;
-};
-
-export type OrganizationDebtInfo = {
-  overdueSince?: string;
-  overdueInvoices: number;
-  overdueAmount: string;
-  unpaidInvoices: number;
-  unpaidAmount: string;
 };
 
 export type SearchOrganization = {
-  org: Organization;
-  contract: LeasingContract[]; // important for the logic regarding leasing overdue reminders
-};
-
-export type PotentialDuplicatesReferenceData = ReferenceData & { blockIgnore?: boolean };
-
-export type InputSearchOrganization = SearchOrganization & {
-  permissions: SearchPermissions;
+  org: Partial<Organization>;
 };
 
 export type SearchContact = {
-  contact: Contact;
-  org?: Organization;
-};
-
-export type InputSearchContact = SearchContact & {
-  permissions: SearchPermissions;
+  org: Partial<Organization>;
+  contact: Partial<Contact>;
 };
 
-export type CrmPublicSearchDefinitions = {
-  searchOrg: PublicSearchDefinition;
-  searchContact: PublicSearchDefinition;
-};
-
-type BaseContact = {
+export type Contact = {
+  id: string;
+  organizationId: string;
   accountManager?: string;
-  countryCode?: string;
   language?: string;
-  emails: string[];
-  job?: string;
-  /** either firstName or lastName should be filled in */
   firstName?: string;
-  lastName?: string;
-  organizationId?: string;
-  /** will not be filled if organizationId is present */
-  orgName?: string;
-};
-
-export type NewContact = BaseContact & {
-  id?: undefined;
-  createdAt?: undefined;
-  createdBy?: undefined;
-  phones: Array<PhoneNumberValue | PhoneNumberRawValue>;
-};
-
-export type Contact = BaseContact & {
-  id: string;
+  lastName: string;
   createdAt: string;
   createdBy: string;
   phones: PhoneNumberValue[];
+  emails: string[];
+  job?: string;
 };
 
-export enum SaveContactResolution {
-  IgnoreDuplicates = 'IGNORE_DUPLICATES',
-  BlockDuplicates = 'BLOCK_DUPLICATES',
-}
-
-export enum SaveOrgResolution {
-  IgnoreDuplicates = 'IGNORE_DUPLICATES',
-  BlockDuplicates = 'BLOCK_DUPLICATES',
-}
+export type LeadContact = {
+  accountManager: string;
+  companyName?: string;
+  country: string;
+  email?: string;
+  language?: string;
+  name: string;
+  phone?: PhoneNumberValue;
+  remarks?: string;
+};
 
-export enum CrmSearchScope {
-  Tenant = 'tenant',
-  Conglomerate = 'conglomerate',
-}
+export type Lead = {
+  contact: LeadContact;
+  interests: Interest[];
+};

package/src/types/definitions.ts

@@ -5,35 +5,28 @@ import { Aggregation } from './search';
 // These definitions are sent to the UI
 //
 export type PublicSearchDefinition = {
-  fields: { [fieldId: string]: SearchField };
-  aggs: Aggregation[];
+  name: string;
+  fields: { [fieldId: string]: PublicSearchField };
 };
 
+export type PublicSearchField = {
+  id: string;
+  titles: { [lang: string]: string };
+  agg?: Aggregation;
+} & FieldTypeInfo;
+
 //
 // These definitions are for internal consumption
 //
 export type SearchDefinition = {
+  name: string;
   fields: { [fieldId: string]: SearchField };
 };
 
 export type SearchField = {
   id: string;
+  esMapping: unknown;
   titles: { [lang: string]: string };
+  fullText?: boolean | ((lang: string) => string);
+  agg?: Aggregation;
 } & FieldTypeInfo;
-
-export type EsDefinitionField = {
-  esMapping: unknown;
-  sortKey?: string;
-};
-
-export type EsDefinition = {
-  name: string;
-  nestedEsPaths: string[];
-  fields: {
-    [fieldId: string]: EsDefinitionField;
-  };
-};
-
-export type EsFullTextSearchDefinition = ((lang: string) => string)[];
-
-export type EsAggregationsDefinition = Aggregation[];

package/src/types/fields.ts

@@ -1,12 +1,10 @@
+import { MultiLangValue } from '@bisondesk/commons-sdk/lib/types';
+
 export enum FieldTypes {
-  attachment = 'attachment',
   checkbox = 'checkbox',
-  collaborator = 'collaborator',
   date = 'date',
   email = 'email',
   image = 'image',
-  link = 'link',
-  location = 'location',
   multilang = 'multilang',
   multiline = 'multiline',
   number = 'number',
@@ -26,72 +24,41 @@ export enum DateGranularity {
   yearMonthDayTime = 'yearMonthDayTime',
 }
 
+export type PhoneNumberValue = {
+  country?: string;
+  e164: string;
+  international: string;
+  national: string;
+};
+
+export type PhoneNumberRawValue = {
+  defaultCountry?: string;
+  input: string;
+};
+
+export type AttachmentValue = {
+  contentType: string;
+  fileName: string;
+  id: string;
+  size: number;
+  uploadedAt: string;
+  uploadedBy: string;
+  url: string;
+  descriptions?: string | MultiLangValue;
+};
+
 //
 // Field metas
 //
 type BaseMeta = {};
 
-type NumberUnit =
-  | 'acre'
-  | 'bit'
-  | 'byte'
-  | 'celsius'
-  | 'centimeter'
-  | 'day'
-  | 'degree'
-  | 'fahrenheit'
-  | 'fluid-ounce'
-  | 'foot'
-  | 'gallon'
-  | 'gigabit'
-  | 'gigabyte'
-  | 'gram'
-  | 'hectare'
-  | 'hour'
-  | 'inch'
-  | 'kilobit'
-  | 'kilobyte'
-  | 'kilogram'
-  | 'kilometer'
-  | 'liter'
-  | 'megabit'
-  | 'megabyte'
-  | 'meter'
-  | 'mile'
-  | 'mile-scandinavian'
-  | 'milliliter'
-  | 'millimeter'
-  | 'millisecond'
-  | 'minute'
-  | 'month'
-  | 'ounce'
-  | 'percent'
-  | 'petabyte'
-  | 'pound'
-  | 'second'
-  | 'stone'
-  | 'terabit'
-  | 'terabyte'
-  | 'week'
-  | 'yard'
-  | 'year';
-
-type BaseNumberMeta = {
+export type NumberMeta = BaseMeta & {
+  style?: 'currency' | 'decimal' | 'unit' | 'percent';
   minimumFractionDigits?: number;
   maximumFractionDigits?: number;
+  unit?: string; // see full list https://github.com/unicode-org/cldr/blob/master/common/validity/unit.xml
   useGrouping?: boolean;
-} & (
-  | {
-      style: 'unit';
-      unit: NumberUnit;
-    }
-  | {
-      style?: 'currency' | 'decimal' | 'percent';
-      unit?: NumberUnit;
-    }
-);
-
-export type NumberMeta = BaseMeta & BaseNumberMeta;
+};
 
 export type DateMeta = BaseMeta & {
   granularity: DateGranularity;
@@ -101,23 +68,15 @@ export type RatingMeta = BaseMeta & {
   max: number;
 };
 
-export type PicklistMeta = BaseMeta & {
-  picklistId: string;
-};
-
 export type FieldTypeInfo =
-  | { type: FieldTypes.attachment }
   | { type: FieldTypes.checkbox }
   | { type: FieldTypes.date; meta: DateMeta }
   | { type: FieldTypes.email }
   | { type: FieldTypes.image }
-  | { type: FieldTypes.link }
-  | { type: FieldTypes.location }
   | { type: FieldTypes.multilang }
   | { type: FieldTypes.multiline }
   | { type: FieldTypes.number; meta: NumberMeta }
   | { type: FieldTypes.phoneNumber }
-  | { type: FieldTypes.picklist; meta: PicklistMeta }
+  | { type: FieldTypes.picklist }
   | { type: FieldTypes.rating; meta: RatingMeta }
-  | { type: FieldTypes.text }
-  | { type: FieldTypes.collaborator };
+  | { type: FieldTypes.text };

package/src/types/interests.ts

@@ -0,0 +1,24 @@
+export type Interest = {
+  id: string;
+
+  vehicleIds: string[];
+
+  adr?: boolean;
+  age?: number;
+  axleConfigurations?: string[];
+  bodywork?: string;
+  category: string;
+  crane?: boolean;
+  damaged?: boolean;
+  euronorms?: string[];
+  horsepower?: number;
+  isNew?: boolean;
+  kilometers?: number;
+  makes?: string[];
+  models?: { [make: string]: string[] };
+  price?: number;
+  retarderIntarder?: boolean;
+  suspensions?: string[];
+  tailgate?: boolean;
+  transmissions?: string[];
+};

package/src/types/picklists.ts

@@ -1,47 +1,36 @@
 import { MultiLangValue } from '@bisondesk/commons-sdk/lib/types';
+////////////////////////////////////////////////////////////////////
+// Picklist
+////////////////////////////////////////////////////////////////////
 
 export type PicklistValueUpdateRequest = {
   picklistId: string;
   value: PicklistValue | NewPicklistValue;
 };
-
-export type NewPicklistValue<T = Record<string, string>> = {
+export type NewPicklistValue = {
   color?: string;
   sortPriority?: number;
   titles: MultiLangValue;
   dependency?: PicklistValueDependency;
-  meta?: T;
 };
-
-export type PicklistValue<T = any> = NewPicklistValue<T> & {
+export type PicklistValue = NewPicklistValue & {
   id: string;
   system?: boolean;
 };
-
 export type PicklistValueListRequest = {
   picklistId: string;
   limit: number;
   offset: number;
-  dependencies?: PicklistValueDependency[];
 };
-
 export type PicklistValueRequest = {
   picklistId: string;
   valueId: string;
 };
-
-export type AdHocPicklistValues<T = any> = {
+export type AdHocPicklistValues = {
   [picklistId: string]: {
-    [valueId: string]: PicklistValue<T>;
+    [valueId: string]: PicklistValue;
   };
 };
-
-export type AdHocPicklistRequest = {
-  requests: PicklistValueRequest[];
-  preferredLang: string;
-  tenantLang: string;
-};
-
 export type AdHocPicklistValueDisplay = {
   [picklistId: string]: {
     [valueId: string]: {
@@ -50,32 +39,26 @@ export type AdHocPicklistValueDisplay = {
     };
   };
 };
-
 export type PicklistOptionsRequest = {
   picklistId: string;
   dependencies?: PicklistValueDependency[];
   lang: string;
 };
-
 export type QuickAddPicklistValue = {
   sortPriority?: number;
   titles: MultiLangValue;
 };
-
 export type NewPicklist = {
-  id?: undefined;
   titles: MultiLangValue;
   values: QuickAddPicklistValue[];
   customSort?: boolean;
 };
-
 export type BasePicklist = {
   customSort?: boolean;
   id: string;
   system?: boolean;
   titles: MultiLangValue;
 };
-
 export type PicklistInfo = BasePicklist & {
   count: number;
   modifiedAt: string;
@@ -84,5 +67,3 @@ export type PicklistValueDependency = {
   picklistId: string;
   values: string[];
 };
-
-export type PicklistCollection = (BasePicklist & { data: PicklistValue[] })[];

package/src/types/search.ts

@@ -2,9 +2,6 @@
 // Generic stuff
 ///////////////////////////////////////////////////////
 
-import { MultiLangValue } from '@bisondesk/commons-sdk/lib/types';
-import { FieldTypes, NumberMeta } from './fields';
-
 export enum ConditionType {
   and = 'AND',
   or = 'OR',
@@ -93,13 +90,6 @@ export type SearchRequest = {
   sortBy?: SortFilter[];
 };
 
-export type PublicSearchRequest = {
-  limit: number;
-  offset?: number;
-  query?: ComplexFilter;
-  sortBy?: SortFilter[];
-};
-
 ///////////////////////////////////////////////////////
 // Aggregations
 ///////////////////////////////////////////////////////
@@ -117,24 +107,11 @@ export enum AggregationType {
 }
 
 export type TermAggregation = {
-  titles: MultiLangValue;
-  fieldId: string;
+  priority: number;
+  fieldType: 'string' | 'number' | 'boolean';
   type: AggregationType.term;
-
   orderBy?: 'count' | 'field';
-} & (
-  | {
-      fieldType: FieldTypes.picklist;
-      picklistId: string;
-    }
-  | {
-      fieldType: FieldTypes.number;
-      meta?: NumberMeta;
-    }
-  | {
-      fieldType: Exclude<FieldTypes, FieldTypes.picklist | FieldTypes.number>;
-    }
-);
+};
 
 export type Range =
   | {
@@ -151,12 +128,10 @@ export type Range =
     };
 
 export type RangeAggregation = {
-  titles: MultiLangValue;
-  fieldId: string;
+  priority: number;
   type: AggregationType.range;
   step: number;
   ranges: Range[];
-  format?: NumberMeta;
 };
 
 export type Aggregation = TermAggregation | RangeAggregation;
@@ -176,8 +151,3 @@ export type AggregationResult = {
 export type AggregationResultSet = {
   [field: string]: AggregationResult[];
 };
-
-export type AggregationResponse<M = {}> = {
-  results: AggregationResultSet;
-  meta: M;
-};

package/src/types/storage.ts

@@ -1 +1,12 @@
-export * from '@bisondesk/commons-sdk/lib/storage';
+export type UploadInfo = {
+  id: string;
+  uploadUrl: string;
+  downloadUrl: string;
+};
+
+export type GetUploadUrlRequest = {
+  businessEntityId: string;
+  fieldId: string;
+  fileName: string;
+  contentType: string;
+};

package/src/types/tenants.ts

@@ -1,55 +1,29 @@
 import { Region } from '@bisondesk/commons-sdk/lib/types';
 
-export type PublicTenant = {
-  defaultCountry: string;
-  defaultCurrency: string;
-  defaultLanguage: string;
-  id: string; // the id is provided on creation bc we assume tenants will be created by someone on the team
-  name: string;
+export type NewTenant = {
+  country: string;
   region: Region;
+  name: string;
+  languages: string[];
   subdomain: string;
-
-  // Pay attention to what information is added here since
-  // the tenant can be obtained without authentication
-};
-
-export enum TenantModule {
-  CRM = 'crm',
-  Docs = 'docs',
-  Leads = 'leads',
-  Leasing = 'leasing',
-  Market = 'market',
-  Opportunities = 'opportunities',
-  VehiclesMasterData = 'vehicles_master_data',
-}
-
-export type Tenant = PublicTenant & {
-  languages: [string, ...string[]];
-  conglomerate?: string;
-  emailDomain: string;
-  hyperdmsIds?: string[];
-  hyperportalId?: string;
-  exactAccounting?: boolean;
-  branches: [Branch, ...Branch[]];
-  modules: TenantModule[];
+  currency: string;
 };
 
-export type Branch = {
+export type Tenant = NewTenant & {
   id: string;
-  name: string;
-  country: string;
-  exactAccounting?: boolean;
-  currency: string;
-  adminNumberPrefix: string;
-  stockNumberPrefix: string;
+  subdomain: string;
+  // 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 HdmsCrmSync = {
   active: boolean;
+  filterName: string;
 };
 
 export type TenantSyncSettings = {

package/src/types/users.ts

@@ -1,9 +1,4 @@
-import { AppRoles } from '@bisondesk/commons-sdk/lib/constants';
-import {
-  AttachmentValue,
-  PhoneNumberRawValue,
-  PhoneNumberValue,
-} from '@bisondesk/commons-sdk/lib/types';
+import { AttachmentValue, PhoneNumberRawValue, PhoneNumberValue } from './fields';
 
 export type NewUserRequest = {
   email: string;
@@ -11,16 +6,7 @@ export type NewUserRequest = {
   language: string;
   lastName: string;
   phone: PhoneNumberRawValue;
-  picture?: AttachmentValue;
-  roles: AppRoles[];
-};
-
-export type ValidNewUserRequest = Omit<NewUserRequest, 'phone'> & {
-  phone: PhoneNumberValue;
-};
-
-export type UpdateUserRequest = Omit<User, 'phone'> & {
-  phone: PhoneNumberRawValue | PhoneNumberValue;
+  roles: string[];
 };
 
 export type User = {
@@ -33,7 +19,7 @@ export type User = {
   lastName: string;
   phone: PhoneNumberValue;
   picture?: AttachmentValue;
-  roles: AppRoles[];
+  roles: string[];
   updatedAt: string;
 };
 

package/src/types/utils.ts

@@ -1,6 +1,3 @@
-import { MultiLangValue } from '@bisondesk/commons-sdk/lib/types';
-import { AdHocPicklistValueDisplay } from './picklists';
-
 export type CountryInfo = {
   code: string; // code is ISO 3166-1 alpha-2
   name: string;
@@ -28,25 +25,3 @@ export type Country = {
   name: string;
   dialCode: number;
 };
-
-export type ReferenceData = {
-  recordTitles: AdHocRecordTitles;
-  picklistTitles: AdHocPicklistValueDisplay;
-};
-
-export type AdHocRecordTitles = {
-  [businessEntityId: string]: {
-    [recordId: string]: string | MultiLangValue;
-  };
-};
-
-export type DataRecord<T, M = undefined> = {
-  record: T;
-  meta?: M; // typically ReferenceData
-  actions: string[];
-};
-
-export enum PricePercentageMode {
-  CURRENCY = 'currency',
-  PERCENTAGE = 'percentage',
-}