@bisondesk/core-sdk 1.0.367 → 1.0.369

package/src/types/crm.ts

@@ -7,6 +7,14 @@ import {
 import { PublicSearchDefinition } from './definitions.js';
 import { ReferenceData } from './utils.js';
 
+export enum OrganizatioRiskTags {
+  BAD_FINANCIAL_INFO = 'BAD_FINANCIAL_INFO',
+  VAT_NUMBER_INVALID = 'VAT_NUMBER_INVALID',
+  INSTINCT = 'INSTINCT',
+  NEW_CUSTOMER = 'NEW_CUSTOMER',
+  BANK_ACCOUNT_BLOCKED = 'BANK_ACCOUNT_BLOCKED',
+}
+
 export type CrmEvent = CrmOrganizationEvent | CrmContactEvent;
 
 export type CrmContactEvent = {

package/src/types/insights.ts

@@ -8,6 +8,7 @@ export type SimilarVehiclesRequest = {
 
 export type InsightsSimilarRequest = {
   comparable: InsightsComparableSpecs;
+  excludeVehicleIds?: string[];
   limit: number;
   nextToken?: string;
 };
@@ -23,9 +24,7 @@ export type InsightsVehicleComparableResponse = {
 };
 
 // here we are considering only specs that we can use to filter Market vehicles
-export interface InsightsComparableSpecs extends ComparableSpecs {
-  vehicleId: string;
-}
+export interface InsightsComparableSpecs extends ComparableSpecs {}
 
 export type InsightsOptions = {
   months?: number;

package/src/types/offers.ts

@@ -0,0 +1,274 @@
+import { DistributiveOmit, Document, NextList } from '@bisondesk/commons-sdk/types';
+import { BusinessEntityIds, WarningHints } from '../constants.js';
+import { Contact, Organization } from './crm.js';
+import { Insights, InsightsComparableSpecs } from './insights.js';
+import { ContactMetdata } from './opportunities.js';
+import { BaseSearchRequest } from './search.js';
+import { DataRecord, ReferenceData } from './utils.js';
+import { VehicleExternalInfo } from './vehicles.js';
+
+export enum OfferActions {
+  CREATE_BID = 'create_bid',
+  SET_FINAL_VALUATION = 'set_final_valuation',
+  LOSE = 'lose',
+  REOPEN = 'reopen',
+  SET_DOCUMENTS = 'set_documents',
+  SET_METADATA = 'set_metadata',
+  SEE_SUPPLIER = 'see_supplier',
+  SEE_INSIGHTS = 'see_insights',
+  VIEW_BIDS = 'view_bids',
+  SEE_ASKING_PRICE = 'see_asking_price',
+  ACCEPT_NEGOTIATION = 'accept_negotiation',
+  UNDO_ACCEPT_NEGOTIATION = 'undo_accept_negotiation',
+  SET_SUPPLIER_VEHICLE = 'set_supplier_vehicle',
+}
+
+export enum OfferBidActions {
+  EDIT_BID = 'create_bid',
+  DELETE_BID = 'delete_bid',
+}
+
+export enum OfferStatus {
+  PROSPECTION = 'prospection', // initial status
+  VALUATION = 'valuation', // has at least one internal or external bid with bid amount > 0
+  NEGOTIATION = 'negotiation', // there is a final valuation, purchaser is talking to the supplier
+}
+
+export enum OfferLostReasonValues {
+  Expensive = 'expensive',
+  NoMarket = 'no_market',
+  BadExperience = 'bad_experience',
+  NoAnswer = 'supplier_mia',
+  Automatic = 'automatic',
+}
+
+export enum OfferBidType {
+  INTERNAL = 'internal',
+  EXTERNAL = 'external',
+}
+
+export enum OfferWarningsCode {
+  NO_SUPPLIER = 'no_supplier',
+}
+
+export const OfferStatusOrder: OfferStatus[] = [
+  OfferStatus.PROSPECTION,
+  OfferStatus.VALUATION,
+  OfferStatus.NEGOTIATION,
+];
+
+export const OfferWonColumnId = 'closed_won';
+
+export const OfferKanbanColumns = [...OfferStatusOrder, OfferWonColumnId];
+
+export const OfferKanbanEndColumns: string[] = [OfferWonColumnId];
+
+type BaseOffer = {
+  branchId: string;
+  availableWeek?: string; // ISOWEEK, e.g. 2016-W02
+  askingPrice?: string;
+  currency?: string;
+  quantity: number;
+  specs: VehicleExternalInfo;
+  documents: Document[];
+  source?: string; // e.g., website, email, visit
+  contactId: string;
+  organizationId?: string;
+
+  supplierNotes?: string; // Optional notes from the supplier
+};
+
+export type NewOffer = BaseOffer & {
+  id?: undefined;
+  createdAt?: undefined;
+  createdBy?: undefined;
+  modifiedAt?: undefined;
+  modifiedBy?: undefined;
+};
+
+export type Offer = BaseOffer & {
+  id: string;
+  accountManager?: string; // optional since some offers might come directly from the internet
+  createdAt: string;
+  createdBy: string;
+  modifiedAt: string;
+  modifiedBy: string;
+  firstBidAt?: string;
+
+  lostReason?: OfferLostReasonValues;
+  status: OfferStatus;
+  quantity: number;
+
+  appPrice?: string;
+  appAvailability: boolean;
+
+  wonAt?: string;
+  wonBy?: string;
+  lostAt?: string;
+  lostBy?: string;
+
+  valuation?: { amount: string; valuationAt: string; valuationBy: string };
+
+  agreedAt?: string;
+  agreedBy?: string;
+};
+
+export type OfferUpdate = {
+  accountManager?: string | null;
+  branchId?: string | null;
+  supplierNotes?: string | null;
+  contactId?: string | null;
+  organizationId?: string | null;
+  lost?: boolean;
+  lostReason?: OfferLostReasonValues;
+  source?: string;
+  askingPrice?: string;
+  currency?: string;
+  quantity?: number;
+  specs?: VehicleExternalInfo;
+  addNewBid?: boolean;
+  documents?: Document[];
+  appAvailability?: boolean;
+
+  finalValuation?: string;
+  agreed?: boolean;
+};
+
+type OfferWarningActionLink = {
+  businessEntityId: BusinessEntityIds;
+  recordId: string;
+};
+
+type OfferWarningActionData = { [key: string]: string | number };
+
+export type OfferWarning = {
+  code: OfferWarningsCode;
+  level: WarningHints;
+  link?: OfferWarningActionLink;
+  data?: OfferWarningActionData;
+  showAction?: boolean;
+};
+
+export type OfferMetadata = {
+  insights: {
+    online: Pick<Insights['online'], 'count' | 'percentilesDays' | 'percentilesPrices'>;
+    sold: Pick<Insights['sold'], 'count' | 'percentilesPrices' | 'percentilesDays'>;
+  };
+  stock: {
+    available: number;
+    leads: number;
+  };
+  comparable: InsightsComparableSpecs;
+  warnings: OfferWarning[];
+};
+
+export type OfferBff = {
+  offer: DataRecord<Offer, OfferMetadata>;
+  bids: DataRecord<OfferBid>[];
+  customer?: {
+    contact: DataRecord<Contact>;
+    org?: DataRecord<Organization>;
+  };
+};
+
+/************
+ *
+ * Bids
+ */
+
+type BaseOfferBid = {
+  id: string;
+  createdAt: string;
+  createdBy: string;
+  modifiedAt: string;
+  modifiedBy: string;
+  offerId: string;
+  amount: string;
+  currency: string;
+  description?: string;
+  deleted: boolean;
+};
+
+export type InternalOfferBid = BaseOfferBid & {
+  userId: string;
+  final?: boolean; // Optional flag to indicate if this is the final valuation
+  type: OfferBidType.INTERNAL;
+};
+
+export type ExternalOfferBid = BaseOfferBid & {
+  contactId: string;
+  organizationId: string;
+  notes?: string;
+  type: OfferBidType.EXTERNAL;
+};
+
+export type OfferBid = InternalOfferBid | ExternalOfferBid;
+
+export type NewOfferBid = DistributiveOmit<
+  OfferBid,
+  'id' | 'createdAt' | 'createdBy' | 'modifiedAt' | 'modifiedBy' | 'deleted'
+>;
+
+export type InternalOfferBidUpdate = {
+  amount?: string | null;
+  currency?: string | null;
+  description?: string | null;
+};
+
+/************
+ *
+ * Search
+ */
+
+export type SearchOffer = {
+  contact?: Contact;
+  offer: Offer;
+  org?: Organization;
+  custom: {
+    lost: boolean;
+    status: OfferStatus | 'won';
+    totalBids: number;
+  };
+};
+
+export type AppOffer = {
+  id: string;
+  branchId: string;
+  createdAt: string;
+  unavailableAt?: string;
+
+  availableWeek?: string;
+  appPrice?: string;
+  currency?: string;
+  quantity: number;
+
+  specs: VehicleExternalInfo;
+};
+
+/************
+ *
+ * Kanban
+ */
+
+export type OffersKanbanColumn = {
+  status: string;
+  results: SearchOffer[];
+  totalCount: number;
+  totalValue: string;
+};
+
+export type MSearchOffersKanbanColumn = {
+  column: OffersKanbanColumn;
+  nextToken?: string;
+};
+
+export type KanbanOffersSearchRequest = BaseSearchRequest & {
+  nextTokens?: Record<string, string | undefined>;
+};
+
+export type KanbanOffersNextList = Omit<
+  NextList<OffersKanbanColumn, ReferenceData>,
+  'nextToken'
+> & {
+  nextTokens?: Record<string, string | undefined>;
+};

package/src/types/tenants.ts

@@ -68,8 +68,13 @@ export type HdmsCrmSync = {
   active: boolean;
 };
 
+export type HdmsDocumentSync = {
+  active: boolean;
+};
+
 export type TenantSyncSettings = {
   tenantId: string;
   hdmsVehicles: HdmsVehiclesSync | undefined;
   hdmsCrm: HdmsCrmSync | undefined;
+  hdmsDocuments: HdmsDocumentSync | undefined;
 };

package/src/types/vehicles.ts

@@ -5,6 +5,7 @@ import {
   MultiLangValue,
   SearchPermissions,
   ShareEmailRequest,
+  ShareWhatsappRequest,
 } from '@bisondesk/commons-sdk/types';
 import { OpportunityReservation } from './reservations.js';
 
@@ -673,3 +674,8 @@ export type VehicleReservationEvent =
   | VehicleReservationCreateEvent
   | VehicleReservationUpdateEvent
   | VehicleReservationDeleteEvent;
+
+export type ShareVehicleViaWahtsappRequest = {
+  data: ShareWhatsappRequest;
+  vehicleId: string;
+};

package/src/utils/offers.ts

@@ -0,0 +1,42 @@
+import { OfferStatus, OfferStatusOrder } from '../types/offers.js';
+
+type CompareInput = {
+  currentStatus: OfferStatus;
+  referenceStatus: OfferStatus;
+};
+
+const compareOfferStatus = (input: CompareInput) => {
+  const { currentStatus, referenceStatus } = input;
+
+  const currentStatusIdx = OfferStatusOrder.indexOf(currentStatus);
+  const referenceStatusIdx = OfferStatusOrder.indexOf(referenceStatus);
+
+  return {
+    currentStatusIdx,
+    referenceStatusIdx,
+  };
+};
+
+export const isSameOrAfterReferenceOfferStatus = (input: CompareInput): boolean => {
+  const { currentStatusIdx, referenceStatusIdx } = compareOfferStatus(input);
+
+  return currentStatusIdx >= referenceStatusIdx;
+};
+
+export const isAfterReferenceOfferStatus = (input: CompareInput): boolean => {
+  const { currentStatusIdx, referenceStatusIdx } = compareOfferStatus(input);
+
+  return currentStatusIdx > referenceStatusIdx;
+};
+
+export const isSameOrBeforeReferenceOfferStatus = (input: CompareInput): boolean => {
+  const { currentStatusIdx, referenceStatusIdx } = compareOfferStatus(input);
+
+  return currentStatusIdx <= referenceStatusIdx;
+};
+
+export const isBeforeReferenceOfferStatus = (input: CompareInput): boolean => {
+  const { currentStatusIdx, referenceStatusIdx } = compareOfferStatus(input);
+
+  return currentStatusIdx < referenceStatusIdx;
+};