@bisondesk/core-sdk 1.0.66 → 1.0.68

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bisondesk/core-sdk",
-  "version": "1.0.66",
+  "version": "1.0.68",
   "description": "",
   "scripts": {
     "clean": "rm -rf build dist lib *.tsbuildinfo",
@@ -11,7 +11,7 @@
   },
   "author": "Ivo Anastácio",
   "dependencies": {
-    "@bisondesk/commons-sdk": "1.0.66",
+    "@bisondesk/commons-sdk": "1.0.68",
     "joi": "17.4.0",
     "lru-cache": "6.0.0"
   },

package/src/apis/crm.ts

@@ -1,6 +1,6 @@
+import { TENANT_ID_ADMIN_HEADER } from '@bisondesk/commons-sdk/lib/constants';
 import { XError } from '@bisondesk/commons/lib/errors';
 import fetch, { Response } from 'node-fetch';
-import { TENANT_ID_ADMIN_HEADER } from '../constants';
 import { Contact, Organization } from '../types/crm';
 import { getAdminAuth } from './utils';
 
@@ -27,6 +27,29 @@ export const getCrmOrganization = async (
   throw new XError(response.statusText, { body });
 };
 
+export const getCrmOrganizationByExternalId = async (
+  tenantId: string,
+  externalId: string
+): Promise<Organization | undefined> => {
+  const auth = await getAdminAuth();
+  const response: Response = await fetch(
+    `${process.env.CORE_API_ORIGIN}/api/crm/organizations/external-id/${externalId}`,
+    {
+      headers: {
+        Authorization: auth,
+        [TENANT_ID_ADMIN_HEADER]: tenantId,
+      },
+    }
+  );
+
+  if (response.ok) {
+    return response.status === 200 ? response.json() : undefined;
+  }
+
+  const body = await response.text();
+  throw new XError(response.statusText, { body });
+};
+
 export const listCrmContacts = async (
   tenantId: string,
   organizationId: string

package/src/apis/leasing.ts

@@ -0,0 +1,97 @@
+import { TENANT_ID_ADMIN_HEADER } from '@bisondesk/commons-sdk/lib/constants';
+import { XError } from '@bisondesk/commons/lib/errors';
+import fetch, { Response } from 'node-fetch';
+import { LeasingConditions, LeasingContract, NewLeasingConditions } from '../types/leasing';
+import { getAdminAuth } from './utils';
+
+export const getLeasingConditions = async (
+  tenantId: string,
+  conditionsId: string
+): Promise<LeasingConditions | undefined> => {
+  const auth = await getAdminAuth();
+  const response: Response = await fetch(
+    `${process.env.CORE_API_ORIGIN}/api/leasing/conditions/${conditionsId}`,
+    {
+      headers: {
+        Authorization: auth,
+        [TENANT_ID_ADMIN_HEADER]: tenantId,
+      },
+    }
+  );
+
+  if (response.ok) {
+    return response.status === 200 ? response.json() : undefined;
+  }
+
+  const body = await response.text();
+  throw new XError(response.statusText, { body });
+};
+
+export const createLeasingConditions = async (
+  tenantId: string,
+  conditions: NewLeasingConditions
+): Promise<LeasingConditions> => {
+  const auth = await getAdminAuth();
+  const response: Response = await fetch(`${process.env.CORE_API_ORIGIN}/api/leasing/conditions`, {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json',
+      Authorization: auth,
+      [TENANT_ID_ADMIN_HEADER]: tenantId,
+    },
+    body: JSON.stringify(conditions),
+  });
+
+  if (response.status === 200) {
+    return response.json();
+  }
+
+  const body = await response.text();
+  throw new XError(response.statusText, { body });
+};
+
+export const getLeasingContract = async (
+  tenantId: string,
+  contractId: string
+): Promise<LeasingContract | undefined> => {
+  const auth = await getAdminAuth();
+  const response: Response = await fetch(
+    `${process.env.CORE_API_ORIGIN}/api/leasing/contracts/${contractId}`,
+    {
+      headers: {
+        Authorization: auth,
+        [TENANT_ID_ADMIN_HEADER]: tenantId,
+      },
+    }
+  );
+
+  if (response.ok) {
+    return response.status === 200 ? response.json() : undefined;
+  }
+
+  const body = await response.text();
+  throw new XError(response.statusText, { body });
+};
+
+export const upsertLeasingContract = async (
+  tenantId: string,
+  contract: LeasingContract
+): Promise<LeasingContract> => {
+  const auth = await getAdminAuth();
+  const response: Response = await fetch(`${process.env.CORE_API_ORIGIN}/api/leasing/contracts`, {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json',
+      Authorization: auth,
+      [TENANT_ID_ADMIN_HEADER]: tenantId,
+    },
+    body: JSON.stringify(contract),
+  });
+
+  if (response.status === 200) {
+    return response.json();
+  }
+
+  const body = await response.text();
+  throw new XError(response.statusText, { body });
+};

package/src/apis/settings.ts

@@ -1,6 +1,6 @@
+import { TENANT_ID_ADMIN_HEADER } from '@bisondesk/commons-sdk/lib/constants';
 import { XError } from '@bisondesk/commons/lib/errors';
 import fetch, { Response } from 'node-fetch';
-import { TENANT_ID_ADMIN_HEADER } from '../constants';
 import { getAdminAuth } from './utils';
 
 export const getSettings = async <T>(

package/src/apis/utils.ts

@@ -1,7 +1,7 @@
+import { TENANT_ID_ADMIN_HEADER } from '@bisondesk/commons-sdk/lib/constants';
 import { InvalidArgumentsError } from '@bisondesk/commons/lib/errors';
 import { getStringSecret } from '@bisondesk/commons/lib/secrets';
 import LRU from 'lru-cache';
-import { TENANT_ID_ADMIN_HEADER } from '../constants';
 
 const authCache = new LRU<string, string>({
   maxAge: 1000 * 60 * 5,

package/src/apis/vehicles.ts

@@ -0,0 +1,51 @@
+import { TENANT_ID_ADMIN_HEADER } from '@bisondesk/commons-sdk/lib/constants';
+import { XError } from '@bisondesk/commons/lib/errors';
+import fetch, { Response } from 'node-fetch';
+import { Vehicle } from '../types/vehicles';
+import { getAdminAuth } from './utils';
+
+export const getVehicle = async (
+  tenantId: string,
+  vehicleId: string
+): Promise<Vehicle | undefined> => {
+  const auth = await getAdminAuth();
+  const response: Response = await fetch(
+    `${process.env.CORE_API_ORIGIN}/api/vehicles/${vehicleId}`,
+    {
+      headers: {
+        Authorization: auth,
+        [TENANT_ID_ADMIN_HEADER]: tenantId,
+      },
+    }
+  );
+
+  if (response.ok) {
+    return response.status === 200 ? response.json() : undefined;
+  }
+
+  const body = await response.text();
+  throw new XError(response.statusText, { body });
+};
+
+export const getVehicleByStockNumber = async (
+  tenantId: string,
+  stockNumber: string
+): Promise<Vehicle | undefined> => {
+  const auth = await getAdminAuth();
+  const response: Response = await fetch(
+    `${process.env.CORE_API_ORIGIN}/api/vehicles/stock-number/${stockNumber}`,
+    {
+      headers: {
+        Authorization: auth,
+        [TENANT_ID_ADMIN_HEADER]: tenantId,
+      },
+    }
+  );
+
+  if (response.ok) {
+    return response.status === 200 ? response.json() : undefined;
+  }
+
+  const body = await response.text();
+  throw new XError(response.statusText, { body });
+};

package/src/constants.ts

@@ -61,8 +61,3 @@ export const MAX_KM = 1_000_000;
 export const MAX_PRICE = 100_000;
 export const PRICE_ROUNDING = 1000;
 export const KM_ROUNDING = 100_000;
-
-//
-// Headers
-//
-export const TENANT_ID_ADMIN_HEADER = 'tenant-id';

package/src/types/definitions.ts

@@ -27,6 +27,7 @@ export type EsDefinition = {
   fields: {
     [fieldId: string]: {
       esMapping: unknown;
+      sortKey?: string;
     };
   };
 };

package/src/types/leads.ts

@@ -27,7 +27,7 @@ export type LeadEvent = {
 };
 
 export type LeadContact = {
-  accountManager: string;
+  accountManager?: string;
   companyName?: string;
   country: string;
   email?: string;
@@ -65,7 +65,7 @@ export type VehicleLeadsResponse = VehicleLeads & {
 };
 
 export type LeadVehiclesResponse = LeadVehicles & {
-  vehiclesById: { [leadId: string]: SearchVehicle };
+  vehiclesById: { [vehicleId: string]: SearchVehicle };
 };
 
 export type LeadStats = {
@@ -83,7 +83,6 @@ export type LeadVehicle = {
 export type Lead = {
   id: string;
   createdAt: string;
-
   contact: LeadContact;
   interests: Interest[];
   vehicles: LeadVehicle[];

package/src/types/leasing.ts

@@ -0,0 +1,153 @@
+import { Organization } from './crm';
+import { PublicSearchDefinition } from './definitions';
+
+export type LeasingPublicSearchDefinitions = {
+  searchLeasingContract: PublicSearchDefinition;
+};
+
+export type LeasingContractEvent = {
+  id: string;
+  action: 'upsert' | 'delete';
+  actionAt: string;
+  userId: string;
+  tenantId: string;
+};
+
+export type LeasingContractImportEvent = {
+  tenantId: string;
+};
+
+export type LeasingConditionEvent = {
+  id: string;
+  action: 'create';
+  actionAt: string;
+  userId: string;
+  tenantId: string;
+};
+
+export type SearchLeasingContract = {
+  contract: LeasingContract;
+  conditions: Omit<LeasingConditions, 'cashIn' | 'cashOut'>;
+  org: Organization;
+};
+
+export type LeasingContract = {
+  id: string;
+  createdAt: string;
+  updatedAt: string;
+
+  contractNumber: string;
+  startDate: string;
+
+  accountManager?: string;
+  branch?: string; // 'MrLease', 'MrLease NL', ...
+
+  client: {
+    organizationId: string;
+    contactIds: string[];
+  };
+
+  vehicle: {
+    id: string;
+    stockNumber: string;
+    administrativeNumber?: string;
+  };
+
+  conditions: ConditionsRef[];
+};
+
+export type ConditionsRef = {
+  id: string;
+  validSince: string;
+};
+
+export type NewLeasingConditions = {
+  parameters: {
+    yearlyRoadTax: string;
+    civilLiability: string;
+    oneTimeRoadTax: string;
+    specialInsurance: string;
+    allRisksPercentage: string;
+    allRisksTaxPercentage: string;
+  };
+
+  inputs: {
+    deposit: string;
+    salesPrice: string;
+    bankDeposit: string;
+    purchasePrice: string;
+    residualValue: string;
+    insuranceAmount: string;
+    durationInMonths: string;
+    includesAllRisks: boolean;
+    marginPercentage: string;
+    bankResidualValue: string;
+    bankDurationInMonths: string;
+    startupFeePercentage: string;
+    includesYearlyRoadTax: boolean;
+    includesCivilLiability: boolean;
+    includesOneTimeRoadTax: boolean;
+    interestRatePercentage: string;
+    includesSpecialInsurance: boolean;
+    monthlyAdministrationFee: string;
+    bankInterestRatePercentage: string;
+  };
+
+  outputs: {
+    ROI: string;
+    ROITarget: string;
+    ROIPerYear: string;
+    cashDeficit: string;
+    totalProfit: string;
+    ROIDifference: string;
+    leasingAmount: string;
+    leasingProfit: string;
+    vehicleProfit: string;
+    yearlyTaxCost: string;
+    monthlyTaxCost: string;
+    oneTimeTaxCost: string;
+    financingAmount: string;
+    bankContractValue: string;
+    bankLeasingAmount: string;
+    totalMonthlyPayment: string;
+    yearlyInsuranceCost: string;
+    leasingContractValue: string;
+    monthlyInsuranceCost: string;
+    yearlyTaxRetailPrice: string;
+    monthlyTaxRetailPrice: string;
+    allRisksInsuranceAmount: string;
+    yearlyInsuranceRetailPrice: string;
+    monthlyInsuranceRetailPrice: string;
+    monthlyInsuranceAndTaxesRetailPrice: string;
+  };
+
+  cashIn: Array<{
+    time: string;
+    cashIn: string;
+    deposit: string;
+    startupFee: string;
+    taxPayment: string;
+    residualValue: string;
+    cumulativeCash: string;
+    insurancePayment: string;
+    monthlyAdministrationFee: string;
+    leasingAmountWithoutAdminFee: string;
+  }>;
+
+  cashOut: Array<{
+    time: string;
+    cashOut: string;
+    deposit: string;
+    taxPayment: string;
+    leasingAmount: string;
+    residualValue: string;
+    cumulativeCash: string;
+    insurancePayment: string;
+  }>;
+};
+
+export type LeasingConditions = NewLeasingConditions & {
+  id: string;
+  createdAt: string;
+  createdBy: string;
+};

package/src/types/settings.ts

@@ -17,7 +17,12 @@ export type WebsiteSettings = {
 };
 
 export type HyperportalSettings = {
+  hcTenantId: string;
   crm: {
     active: boolean;
   };
+  vehicles: {
+    active: boolean;
+    ignoreBeforeDate?: string; // do not modify vehicles created before this date;
+  };
 };

package/src/types/users.ts

@@ -11,6 +11,10 @@ export type NewUserRequest = {
   roles: AppRoles[];
 };
 
+export type UpdateUserRequest = Omit<User, 'phone'> & {
+  phone: PhoneNumberRawValue | PhoneNumberValue;
+};
+
 export type User = {
   active: boolean;
   createdAt: string;

package/src/types/vehicles.ts

@@ -24,8 +24,8 @@ export type VehicleInternalInfo = {
   createdAt: string;
   description: {
     title: string;
-    remarks?: MultiLangValue;
-    technicalRemarks?: MultiLangValue;
+    remarks?: string;
+    technicalRemarks?: string;
   };
   marketingPlatforms: string[];
   identification: {
@@ -97,12 +97,8 @@ export type VehicleExtarnalInfo = {
     used?: boolean;
   };
   description: {
-    remarks?: {
-      [lang: string]: string;
-    };
-    titles: {
-      [lang: string]: string;
-    };
+    remarks?: MultiLangValue;
+    titles: MultiLangValue;
   };
   general: {
     bodystyle?: string;
@@ -120,7 +116,7 @@ export type VehicleExtarnalInfo = {
     };
     firstRegistration?: string;
   };
-  identification?: {
+  identification: {
     licensePlate?: string;
     stockNumber: string;
     vin?: string;