@bisondesk/core-sdk 1.0.21 → 1.0.23-B

package/src/ddb-entities.ts

@@ -0,0 +1 @@
+export const ITEM_VIEWS_KEY = 'views';

package/src/environment.d.ts

@@ -0,0 +1,6 @@
+declare namespace NodeJS {
+  interface ProcessEnv {
+    ADMIN_KEY: string;
+    CORE_API_ORIGIN: string;
+  }
+}

package/src/types/activities.ts

@@ -0,0 +1,41 @@
+export enum ActivityType {
+  CALL = 'call',
+  MEETING = 'meeting',
+  EMAIL = 'email',
+  CHAT = 'chat',
+}
+
+export enum ActivityActions {
+  DELETE = 'delete',
+  EDIT = 'edit',
+}
+
+type BaseActivity = {
+  type: ActivityType;
+  opportunityId: string;
+  description?: string;
+};
+
+export type NewActivity = BaseActivity & {
+  id?: undefined;
+  createdAt?: undefined;
+  createdBy?: undefined;
+  modifiedAt?: undefined;
+  modifiedBy?: undefined;
+  activityAt?: string;
+};
+
+export type Activity = BaseActivity & {
+  id: string;
+  createdAt: string;
+  createdBy: string;
+  modifiedAt: string;
+  modifiedBy: string;
+  activityAt: string;
+};
+
+export type ActivityUpdate = {
+  description?: string;
+  type?: ActivityType;
+  activityAt?: string;
+};

package/src/types/crm.ts

@@ -1,53 +1,141 @@
-import { PhoneNumberValue } from './fields';
-import { Interest } from './interests';
+import {
+  LocationValue,
+  PhoneNumberRawValue,
+  PhoneNumberValue,
+  SearchPermissions,
+} from '@bisondesk/commons-sdk/lib/types';
+import { PublicSearchDefinition } from './definitions';
+import { LeasingContract } from './leasing';
+import { ReferenceData } from './utils';
 
-export type Organization = {
+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;
   countryCode: string;
-  createdAt: string;
-  createdBy: string;
-  externalId: number;
-  id: string;
+  syncedAt: 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: Partial<Organization>;
+  org: Organization;
+  contract: LeasingContract[]; // important for the logic regarding leasing overdue reminders
+};
+
+export type PotentialDuplicatesReferenceData = ReferenceData & { blockIgnore?: boolean };
+
+export type InputSearchOrganization = SearchOrganization & {
+  permissions: SearchPermissions;
 };
 
 export type SearchContact = {
-  org: Partial<Organization>;
-  contact: Partial<Contact>;
+  contact: Contact;
+  org?: Organization;
 };
 
-export type Contact = {
-  id: string;
-  organizationId: string;
+export type InputSearchContact = SearchContact & {
+  permissions: SearchPermissions;
+};
+
+export type CrmPublicSearchDefinitions = {
+  searchOrg: PublicSearchDefinition;
+  searchContact: PublicSearchDefinition;
+};
+
+type BaseContact = {
   accountManager?: string;
+  countryCode?: string;
   language?: string;
-  firstName?: string;
-  lastName: string;
-  createdAt: string;
-  createdBy: string;
-  phones: PhoneNumberValue[];
   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 LeadContact = {
-  accountManager: string;
-  companyName?: string;
-  country: string;
-  email?: string;
-  language?: string;
-  name: string;
-  phone?: PhoneNumberValue;
-  remarks?: string;
+export type NewContact = BaseContact & {
+  id?: undefined;
+  createdAt?: undefined;
+  createdBy?: undefined;
+  phones: Array<PhoneNumberValue | PhoneNumberRawValue>;
 };
 
-export type Lead = {
-  contact: LeadContact;
-  interests: Interest[];
+export type Contact = BaseContact & {
+  id: string;
+  createdAt: string;
+  createdBy: string;
+  phones: PhoneNumberValue[];
 };
+
+export enum SaveContactResolution {
+  IgnoreDuplicates = 'IGNORE_DUPLICATES',
+  BlockDuplicates = 'BLOCK_DUPLICATES',
+}
+
+export enum SaveOrgResolution {
+  IgnoreDuplicates = 'IGNORE_DUPLICATES',
+  BlockDuplicates = 'BLOCK_DUPLICATES',
+}
+
+export enum CrmSearchScope {
+  Tenant = 'tenant',
+  Conglomerate = 'conglomerate',
+}

package/src/types/definitions.ts

@@ -5,28 +5,35 @@ import { Aggregation } from './search';
 // These definitions are sent to the UI
 //
 export type PublicSearchDefinition = {
-  name: string;
-  fields: { [fieldId: string]: PublicSearchField };
+  fields: { [fieldId: string]: SearchField };
+  aggs: Aggregation[];
 };
 
-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/documents.ts

@@ -0,0 +1,110 @@
+import { AttachmentValue, SearchPermissions } from '@bisondesk/commons-sdk/lib/types';
+import { Organization } from './crm';
+import { PublicSearchDefinition } from './definitions';
+
+export type FinanceLine = {
+  associations: {
+    others: { vehicleId: string; label: string }[];
+    sales: { id: string; vehicleId: string; label: string }[];
+    purchases: { id: string; vehicleId: string; label: string }[];
+  };
+  description: string;
+  id: string;
+  lineCode: string;
+  quantity: string;
+  unitPriceExclusive: string;
+  vatCode: string;
+  vatCoefficient: string;
+};
+
+export type FinanceDocument = {
+  id: string;
+  branchId: string;
+
+  type: 'Sale Finance' | 'Purchase Finance';
+  subtype: 'Invoice' | 'Credit Note' | 'Proforma' | 'Purchase Order';
+  reference: string;
+
+  attachment: AttachmentValue;
+  lines: FinanceLine[];
+  notes?: string;
+
+  createdAt: string;
+  createdBy: string;
+  issueDate: string;
+
+  organizationSummary?: {
+    id: string;
+    code: string;
+    name: string;
+    country: string;
+    vatNumber?: string;
+
+    addressLine1?: string;
+    addressLine2?: string;
+    addressLine3?: string;
+    postcode?: string;
+    city?: string;
+
+    email?: string;
+    phone?: string;
+    fax?: string;
+  };
+};
+
+export type FinanceDocumentEvent = {
+  id: string;
+  actionAt: string;
+  userId: string;
+  tenantId: string;
+  type: 'Sale Finance' | 'Purchase Finance';
+  subtype: string; // Invoice, Credit Note, etc.
+};
+
+export type FinanceBookingEvent = {
+  id: string;
+  branchId: string;
+  actionAt: string;
+  userId: string;
+  tenantId: string;
+  type: 'Sale Finance' | 'Purchase Finance';
+};
+
+export type FinanceBooking = {
+  branchId: string; // same tenantId can have different companies
+  bookingNumber: string; // same booking number can and will exist across different "branches"
+  documentId: string;
+
+  booked: true;
+  journal?: string;
+  amount?: string;
+  reportingPeriod?: number;
+  reportingYear?: number;
+  paid: boolean;
+
+  createdAt: string;
+  createdBy: string;
+  modifiedAt: string;
+  modifiedBy: string;
+};
+
+export type SearchDocumentVehicleRef = {
+  id: string;
+  stockNumber: string;
+  administrativeNumber?: string;
+};
+
+export type SearchFinanceDocument = {
+  org?: Organization;
+  doc: FinanceDocument;
+  booking?: FinanceBooking;
+  vehicle?: SearchDocumentVehicleRef[];
+};
+
+export type InputSearchFinanceDocument = SearchFinanceDocument & {
+  permissions: SearchPermissions;
+};
+
+export type DocsSearchDefinitions = {
+  searchFinanceDoc: PublicSearchDefinition;
+};

package/src/types/fields.ts

@@ -1,10 +1,12 @@
-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',
@@ -24,41 +26,72 @@ 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 = {};
 
-export type NumberMeta = BaseMeta & {
-  style?: 'currency' | 'decimal' | 'unit' | 'percent';
+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 = {
   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;
@@ -68,15 +101,23 @@ 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 }
+  | { type: FieldTypes.picklist; meta: PicklistMeta }
   | { type: FieldTypes.rating; meta: RatingMeta }
-  | { type: FieldTypes.text };
+  | { type: FieldTypes.text }
+  | { type: FieldTypes.collaborator };

package/src/types/internet-vehicles.ts

@@ -0,0 +1,67 @@
+import { LocationValue, PhoneNumberValue } from '@bisondesk/commons-sdk/lib/types';
+import { PublicSearchDefinition } from './definitions';
+import { AggregationRequest } from './search';
+import { Vehicle } from './vehicles';
+
+export type InternetVehicleInternalInfo = {
+  createdAt: string;
+  updatedAt: string;
+  description: {
+    title: string;
+    remarks?: string;
+  };
+};
+
+export type InternetVehiclePublicSearchDefinitions = {
+  searchInternetVehicle: PublicSearchDefinition;
+};
+
+export type InternetVehicleSellerType = 'Dealer' | 'Private';
+
+export type PriceChange = {
+  price: string | undefined;
+  priceAt: string;
+};
+
+export type InternetVehiclePortal = {
+  name: string;
+  originalUrl: string;
+  pingedAt: string;
+  available: boolean;
+};
+
+export type InternetVehicleSeller = {
+  id: string;
+  name?: string;
+  address: LocationValue;
+  type?: InternetVehicleSellerType;
+  gps?: {
+    lat: number;
+    lon: number;
+  };
+  phones: PhoneNumberValue[];
+};
+
+export type InternetVehicle = Vehicle<InternetVehicleInternalInfo>;
+
+export type SearchInternetVehicle = {
+  vehicle: InternetVehicle;
+  seller: InternetVehicleSeller;
+  alternativeIds: string[];
+  priceEvolution: PriceChange[];
+  portal: InternetVehiclePortal;
+  custom: {
+    features: string[];
+  };
+};
+
+export type AnalysisResponse = {
+  [sellerId: string]: { x: string; y: number }[];
+  all: { x: string; y: number }[];
+};
+
+export type AnalysisRequest = AggregationRequest & {
+  sellerIds: string[];
+  range: '1M' | '3M' | '6M' | '1y';
+  granularity: '1w' | '1M';
+};