@bisondesk/core-sdk 1.0.21 → 1.0.23-B

package/src/types/quotes.ts

@@ -0,0 +1,186 @@
+import { AttachmentValue } from '@bisondesk/commons-sdk/lib/types';
+import { OpportunityType } from '../constants';
+import {
+  CustomLeasingQuoteExtraInput,
+  LeasingDeliveryPackageInput,
+  LeasingQuoteExtraInput,
+} from './leasing-settings';
+import { PricePercentageMode } from './utils';
+
+export enum QuoteActions {
+  ACCEPT = 'accept',
+  VALIDATE = 'validate',
+  DONWLOAD_PDFS = 'download-pdfs',
+  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: string;
+  customerCountry: string;
+  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;
+    depositMode: PricePercentageMode;
+    depositPercentage: string;
+    residual: string;
+    residualMode: PricePercentageMode;
+    residualPercentage: string;
+    startupFee: string;
+    startupFeeMode: PricePercentageMode;
+    startupFeePercentage: string;
+    interestRate: string;
+    purchasePrice: string;
+    duration: number;
+  };
+  bank: {
+    interestRate: string;
+    deposit: string;
+    depositMode: PricePercentageMode;
+    depositPercentage: string;
+    residual: string;
+    residualMode: PricePercentageMode;
+    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?: LeasingDeliveryPackageInput;
+  extras: LeasingQuoteExtraInput[];
+  customRequests: CustomLeasingQuoteExtraInput[];
+};
+
+export type LeasingCalculatorOutput = {
+  vatApplicable: boolean;
+  installment: string;
+  installmentPrintable: string;
+  totalMonthlyAmount: string;
+  monthlyTaxesInsurance: string;
+  beforeDelivery: string;
+  financingAmount: string;
+  settingId: string;
+  totalRetailAmount: string;
+  finalSalesPrice: 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;
+    finalCostPrice: string;
+    monhtly: string;
+    trackAndTrace: string;
+  };
+};
+
+type BaseLeasingQuote = {
+  opportunityId: string;
+  calculatorInput: LeasingCalculatorInput;
+  calculatorOutput: LeasingCalculatorOutput;
+  type: OpportunityType;
+  preferredLanguage: string;
+};
+
+export type NewLeasingQuote = BaseLeasingQuote & {
+  id?: undefined;
+  createdAt?: undefined;
+  createdBy?: undefined;
+  modifiedAt?: undefined;
+  modifiedBy?: undefined;
+  active: true;
+};
+
+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;
+  active: boolean;
+  contactId: string;
+  vehicleId: string;
+  organizationId: string;
+};
+
+export type QuoteUpdate = {
+  status?: QuoteStatus;
+  active?: boolean;
+};

package/src/types/recently-viewed.ts

@@ -0,0 +1,45 @@
+import { AttachmentValue, Requester } from '@bisondesk/commons-sdk/lib/types';
+import { BusinessEntityIds } from '../constants';
+
+export type ViewedItemsRequest = {
+  businessEntity?: string;
+  id?: string;
+};
+
+export type NewViewedItem = {
+  businessEntity: BusinessEntityIds;
+  id: string;
+  viewedAt: string;
+};
+
+export type ViewedItemMeta = {
+  title: string;
+  subtitle: string;
+  thumbnail?: AttachmentValue | null; // null signals that it can have a thumbnail, it is just not available
+};
+
+export type ViewedItem = ViewedItemMeta & {
+  viewedAt: string;
+  id: string;
+  actions: string[];
+};
+
+export type RawViewedItem = {
+  id: string;
+  viewedAt: string;
+};
+
+export type ViewedItemHandler = (
+  requester: Requester,
+  req: ViewedItemsRequest,
+  itemsBusinessEntity: BusinessEntityIds,
+  items: RawViewedItem[]
+) => Promise<ViewedItem[]>;
+
+export type ViewedItemsContextHandlers = {
+  [entity in BusinessEntityIds]?: ViewedItemHandler;
+};
+
+export type ViewedItemsHandlersCollection = {
+  [entity in BusinessEntityIds]?: ViewedItemsContextHandlers;
+};

package/src/types/saved-filters.ts

@@ -0,0 +1,21 @@
+import { BusinessEntityIds } from '../constants';
+import { ComplexFilter } from './search';
+
+type SavedFilterQuery = {
+  conditions: {
+    [fieldId: string]: ComplexFilter;
+  };
+  fullText?: string;
+};
+
+export type SavedFilter = SavedFilterQuery & {
+  id: string;
+  businessEntityId: BusinessEntityIds;
+  name: string;
+  userId: string;
+};
+
+export type NewSavedFilterRequest = SavedFilterQuery & {
+  businessEntityId: BusinessEntityIds;
+  name: string;
+};

package/src/types/search.ts

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

package/src/types/settings.ts

@@ -0,0 +1,51 @@
+export type WebsiteSettings = {
+  contacts: {
+    destinations: string[];
+  };
+  leasing?: {
+    interestRate: number;
+    initialValues: {
+      residual: number;
+      deposit: number;
+      periods: number;
+    };
+    maxPeriods: number;
+  };
+  gatsbyCloud?: {
+    webhook: string;
+  };
+};
+
+export type HyperportalSettings = {
+  hcTenantId: string;
+  crm: {
+    active: boolean;
+  };
+  vehicles: {
+    active: boolean;
+    ignoreBeforeDate?: string; // do not modify vehicles created before this date;
+  };
+  leasing: {
+    active: boolean;
+    contractTransferDefinitionId: string;
+    contractDealDefinitionId: string;
+    contractOwner: { [countryCode: string]: string };
+  };
+};
+
+export type HyperportalMachinesSettings = {
+  hcTenantId: string;
+  active: boolean;
+};
+
+export type LeasingCreditorBranch = {
+  bciNumber: string;
+  vatNumber: string;
+  licenceDate: string;
+  becrisFirstReportDate: string;
+  becrisStartDate: string;
+};
+
+export type LeasingCreditorSettings = {
+  [branchId: string]: LeasingCreditorBranch;
+};

package/src/types/storage.ts

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

package/src/types/templates.ts

@@ -0,0 +1,40 @@
+export enum TemplateType {
+  Email = 'email',
+  Sms = 'sms',
+}
+
+export type TemplateContent =
+  | {
+      type: TemplateType.Email;
+      subject: string;
+      content: {
+        html: string;
+        design: any;
+      };
+    }
+  | {
+      type: TemplateType.Sms;
+      content: string;
+    };
+
+export type NewTemplateRequest = {
+  id?: string;
+  country: string;
+  name: string;
+} & TemplateContent;
+
+export type Template = {
+  id: string;
+  modifiedAt: string;
+  modifiedBy: string;
+  country: string;
+  name: string;
+} & TemplateContent;
+
+export type TemplateInfo = {
+  id: string;
+  countries: string[];
+  modifiedAt: string;
+  name: string;
+  type: TemplateType;
+};

package/src/types/tenants.ts

@@ -1,29 +1,55 @@
 import { Region } from '@bisondesk/commons-sdk/lib/types';
 
-export type NewTenant = {
-  country: string;
-  region: Region;
+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;
-  languages: string[];
+  region: Region;
   subdomain: string;
-  currency: string;
-};
 
-export type Tenant = NewTenant & {
-  id: 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[];
+};
+
+export type Branch = {
+  id: string;
+  name: string;
+  country: string;
+  exactAccounting?: boolean;
+  currency: string;
+  adminNumberPrefix: string;
+  stockNumberPrefix: string;
+};
+
 export type HdmsVehiclesSync = {
   active: boolean;
-  filterName: string;
 };
 
 export type HdmsCrmSync = {
   active: boolean;
-  filterName: string;
 };
 
 export type TenantSyncSettings = {

package/src/types/users.ts

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

package/src/types/utils.ts

@@ -1,3 +1,6 @@
+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;
@@ -25,3 +28,25 @@ 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',
+}