@bisondesk/core-sdk 1.0.442 → 1.0.444

package/lib/types/vehicle-performance.d.ts

@@ -0,0 +1,78 @@
+import { OpportunityType } from '../constants.js';
+import { VehicleSaleDealStatus, VehicleSaleLogisticsStatus } from './opportunities.js';
+import { VehiclePurchaseDealStatus, VehiclePurchaseLogisticsStatus } from './vehicles.js';
+export type VehicleSaleOverview = {
+    opportunityId: string;
+    type: OpportunityType;
+    userId: string;
+    clientId: string;
+    clientCode: number;
+    clientCountryCode: string;
+    clientVat?: string;
+    conglomerate?: boolean;
+    clientEmail?: string;
+    clientPhone?: string;
+    dealStatus: VehicleSaleDealStatus;
+    logisticsStatus: VehicleSaleLogisticsStatus;
+    createdAt: string;
+    engagedAt?: string;
+    acceptedAt?: string;
+    validatedAt?: string;
+    reviewedAt?: string;
+    preparedAt?: string;
+    deliveredAt?: string;
+    wonAt?: string;
+    saleAt?: string;
+    firstInvoiceIssuedAt?: string;
+    lastInvoiceIssuedAt?: string;
+    firstPaymentAt?: string;
+    fullPaymentAt?: string;
+    expectedAmount: string;
+    actualAmount: string;
+    lifetimeActualAmount: string;
+    hasMainInvoice?: boolean;
+};
+export type VehiclePurchaseOverview = {
+    userId: string;
+    dealStatus: VehiclePurchaseDealStatus;
+    logisticsStatus: VehiclePurchaseLogisticsStatus;
+    supplierId: string;
+    supplierCode: string;
+    supplierCountryCode: string;
+    supplierVat?: string;
+    conglomerate?: boolean;
+    supplierEmail?: string;
+    supplierPhone?: string;
+    firstInvoiceIssuedAt?: string;
+    lastInvoiceIssuedAt?: string;
+    firstPaymentAt?: string;
+    fullPaymentAt?: string;
+    expectedAmount: string;
+    actualAmount: string;
+    purchaseAt?: string;
+    marketingAt?: string;
+    evaluationAt?: string;
+    purchaseAgreedAt?: string;
+    arrivedAt?: string;
+    checkedInAt?: string;
+    hasMainInvoice?: boolean;
+};
+export type VehicleProfitOverview = {
+    expectedProfit?: string;
+    expectedRoi?: string;
+    actualProfit?: string;
+    actualRoi?: string;
+};
+type VehicleSummary = {
+    branch: string;
+    stockNumber: string;
+    id: string;
+};
+export type VehicleBusinessOverview = {
+    vehicle: VehicleSummary;
+    purchase: VehiclePurchaseOverview;
+    sale?: VehicleSaleOverview;
+    profit?: VehicleProfitOverview;
+};
+export {};
+//# sourceMappingURL=vehicle-performance.d.ts.map

package/lib/types/vehicle-performance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vehicle-performance.d.ts","sourceRoot":"/","sources":["types/vehicle-performance.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,qBAAqB,EAAE,0BAA0B,EAAE,MAAM,oBAAoB,CAAC;AACvF,OAAO,EAAE,yBAAyB,EAAE,8BAA8B,EAAE,MAAM,eAAe,CAAC;AAE1F,MAAM,MAAM,mBAAmB,GAAG;IAChC,aAAa,EAAE,MAAM,CAAC;IACtB,IAAI,EAAE,eAAe,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IAGf,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IAGrB,UAAU,EAAE,qBAAqB,CAAC;IAClC,eAAe,EAAE,0BAA0B,CAAC;IAG5C,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAGhB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE,MAAM,CAAC;IACrB,oBAAoB,EAAE,MAAM,CAAC;IAI7B,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,MAAM,EAAE,MAAM,CAAC;IAEf,UAAU,EAAE,yBAAyB,CAAC;IACtC,eAAe,EAAE,8BAA8B,CAAC;IAEhD,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IAGvB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;IAGpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAK1B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,KAAK,cAAc,GAAG;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,OAAO,EAAE,cAAc,CAAC;IACxB,QAAQ,EAAE,uBAAuB,CAAC;IAClC,IAAI,CAAC,EAAE,mBAAmB,CAAC;IAC3B,MAAM,CAAC,EAAE,qBAAqB,CAAC;CAChC,CAAC"}

package/lib/types/vehicle-performance.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=vehicle-performance.js.map

package/lib/types/vehicle-performance.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vehicle-performance.js","sourceRoot":"/","sources":["types/vehicle-performance.ts"],"names":[],"mappings":"","sourcesContent":["import { OpportunityType } from '../constants.js';\nimport { VehicleSaleDealStatus, VehicleSaleLogisticsStatus } from './opportunities.js';\nimport { VehiclePurchaseDealStatus, VehiclePurchaseLogisticsStatus } from './vehicles.js';\n\nexport type VehicleSaleOverview = {\n  opportunityId: string;\n  type: OpportunityType;\n  userId: string; // account manager of the latest opportunity (if opportunity is >= review)\n\n  // client details\n  clientId: string;\n  clientCode: number;\n  clientCountryCode: string;\n  clientVat?: string;\n  conglomerate?: boolean;\n  clientEmail?: string;\n  clientPhone?: string;\n\n  // vehicle details\n  dealStatus: VehicleSaleDealStatus;\n  logisticsStatus: VehicleSaleLogisticsStatus;\n\n  // opportunity dates\n  createdAt: string;\n  engagedAt?: string;\n  acceptedAt?: string;\n  validatedAt?: string;\n  reviewedAt?: string;\n  preparedAt?: string;\n  deliveredAt?: string;\n  wonAt?: string;\n\n  saleAt?: string; // this is the date that should be considered for the sale according to TJ (often the same as fullPaymentAt)\n\n  // money-related details\n  firstInvoiceIssuedAt?: string;\n  lastInvoiceIssuedAt?: string;\n  firstPaymentAt?: string;\n  fullPaymentAt?: string;\n  expectedAmount: string; // from quote(s)\n  actualAmount: string; // from all invoices\n  lifetimeActualAmount: string; // sum of all invoices from all opportunities for this vehicle\n\n  // is there an invoice with category related to the purchase of commercial vehicle\n  // (we probably need a way to flag those categories since it is also important for the stocklist)\n  hasMainInvoice?: boolean;\n};\n\nexport type VehiclePurchaseOverview = {\n  userId: string; // purchaser\n\n  dealStatus: VehiclePurchaseDealStatus;\n  logisticsStatus: VehiclePurchaseLogisticsStatus;\n\n  supplierId: string;\n  supplierCode: string;\n  supplierCountryCode: string;\n  supplierVat?: string;\n  conglomerate?: boolean;\n  supplierEmail?: string;\n  supplierPhone?: string;\n\n  // money-related details\n  firstInvoiceIssuedAt?: string;\n  lastInvoiceIssuedAt?: string;\n  firstPaymentAt?: string;\n  fullPaymentAt?: string;\n  expectedAmount: string;\n  actualAmount: string;\n\n  purchaseAt?: string; // this is the date that should be considered for the purchase according to TJ (often the same as fullPaymentAt)\n\n  // log\n  marketingAt?: string; // no vehicle in our parking, just digital marketing\n  evaluationAt?: string; // in consignation\n  purchaseAgreedAt?: string;\n  // firstPaymentAllowedAt?: string;\n  // firstPaymentSentAt?: string;\n  // fullPaymentAllowedAt?: string;\n  // fullPaymentSentAt?: string;\n  arrivedAt?: string;\n  checkedInAt?: string;\n\n  hasMainInvoice?: boolean;\n};\n\nexport type VehicleProfitOverview = {\n  expectedProfit?: string;\n  expectedRoi?: string;\n\n  actualProfit?: string;\n  actualRoi?: string;\n};\n\ntype VehicleSummary = {\n  branch: string;\n  stockNumber: string;\n  id: string;\n};\n\nexport type VehicleBusinessOverview = {\n  vehicle: VehicleSummary;\n  purchase: VehiclePurchaseOverview;\n  sale?: VehicleSaleOverview;\n  profit?: VehicleProfitOverview;\n};\n"]}

package/lib/utils/vehicles.js

@@ -30,7 +30,7 @@ export const extractCustomFeatures = (vehicle) => {
 };
 export const getInternalTitle = ({ make, category, modelName, bodywork, modelTypeName, }) => {
     if (category === Categories.Trailer || category === Categories.SemiTrailer) {
-        return [make, modelName, bodywork]
+        return [make, modelName, modelTypeName, bodywork]
             .filter((v) => !!v)
             .map((v) => v.trim())
             .join(' ')

package/lib/utils/vehicles.js.map

@@ -1 +1 @@
-{"version":3,"file":"vehicles.js","sourceRoot":"/","sources":["utils/vehicles.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAG7C,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,OAA4B,EAAY,EAAE;IAC9E,MAAM,QAAQ,GAGR;QACJ;YACE,QAAQ,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,cAAc,EAAE,KAAK,EAAE,OAAO;YAC7D,eAAe,EAAE,OAAO;SACzB;QACD;YACE,QAAQ,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,cAAc,EAAE,QAAQ,EAAE,OAAO;YAChE,eAAe,EAAE,UAAU;SAC5B;QACD,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,eAAe,EAAE,KAAK,EAAE;QAC1E;YACE,QAAQ,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,gBAAgB;YAC3D,eAAe,EAAE,kBAAkB;SACpC;QACD;YACE,QAAQ,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,kBAAkB;YAC7D,eAAe,EAAE,oBAAoB;SACtC;QACD;YACE,QAAQ,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,OAAO;YAClD,eAAe,EAAE,SAAS;SAC3B;KACF,CAAC;IAEF,OAAO,QAAQ;SACZ,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;SAChD,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;AAC/C,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,EAC/B,IAAI,EACJ,QAAQ,EACR,SAAS,EACT,QAAQ,EACR,aAAa,GAOd,EAAU,EAAE;IACX,IAAI,QAAQ,KAAK,UAAU,CAAC,OAAO,IAAI,QAAQ,KAAK,UAAU,CAAC,WAAW,EAAE,CAAC;QAC3E,OAAO,CAAC,IAAI,EAAE,SAAS,EAAE,QAAQ,CAAC;aAC/B,MAAM,CAAC,CAAC,CAAC,EAAe,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;aAC/B,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;aACpB,IAAI,CAAC,GAAG,CAAC;aACT,IAAI,EAAE,CAAC;IACZ,CAAC;IAED,OAAO,CAAC,IAAI,EAAE,SAAS,EAAE,aAAa,CAAC;SACpC,MAAM,CAAC,CAAC,CAAC,EAAe,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;SAC/B,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;SACpB,IAAI,CAAC,GAAG,CAAC;SACT,IAAI,EAAE,CAAC;AACZ,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,4BAA4B,CAAC;AAG9C,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,GAAW,EAAU,EAAE;IAC5D,MAAM,aAAa,GAAG,QAAQ,CAAC,MAAM,CAAC;IAEtC,IAAI,GAAG,GAAG,CAAC,EAAE,CAAC;QACZ,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,IAAI,SAAS,GAAG,GAAG,GAAG,aAAa,CAAC;IACpC,IAAI,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,aAAa,CAAC,CAAC;IAG/C,IAAI,SAAS,KAAK,CAAC,EAAE,CAAC;QACpB,SAAS,GAAG,aAAa,CAAC;QAC1B,QAAQ,IAAI,CAAC,CAAC;IAChB,CAAC;IAED,OAAO,sBAAsB,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC;AAC3E,CAAC,CAAC;AAGF,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,OAAe,EAAU,EAAE;IAChE,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,CAAC;IAE7B,IAAI,MAAM,GAAG,CAAC,CAAC;IAEf,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACxC,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QACnD,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACrC,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,WAAmB,EAAU,EAAE;IACvE,MAAM,cAAc,GAAG,6BAA6B,CAAC;IACrD,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;IAChD,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAClB,MAAM,IAAI,MAAM,CAAC,oCAAoC,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED,MAAM,eAAe,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IACjC,MAAM,cAAc,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAChC,MAAM,aAAa,GAAG,sBAAsB,CAAC,cAAc,CAAC,CAAC;IAC7D,MAAM,iBAAiB,GAAG,aAAa,GAAG,CAAC,CAAC;IAC5C,MAAM,kBAAkB,GAAG,sBAAsB,CAAC,iBAAiB,CAAC,CAAC;IACrE,OAAO,GAAG,eAAe,GAAG,kBAAkB,EAAE,CAAC;AACnD,CAAC,CAAC","sourcesContent":["import { XError } from '@bisondesk/commons-sdk/errors';\nimport { Categories } from '../constants.js';\nimport { VehicleExternalInfo } from '../types/vehicles.js';\n\nexport const extractCustomFeatures = (vehicle: VehicleExternalInfo): string[] => {\n  const features: {\n    getValue: (vehicle: VehicleExternalInfo) => any;\n    picklistValueId: string;\n  }[] = [\n    {\n      getValue: (vehicle) => vehicle.superstructure?.crane?.present,\n      picklistValueId: 'crane',\n    },\n    {\n      getValue: (vehicle) => vehicle.superstructure?.tailgate?.present,\n      picklistValueId: 'tailgate',\n    },\n    { getValue: (vehicle) => vehicle.accessories.adr, picklistValueId: 'adr' },\n    {\n      getValue: (vehicle) => vehicle.accessories.retarderIntarder,\n      picklistValueId: 'retarderIntarder',\n    },\n    {\n      getValue: (vehicle) => vehicle.accessories.hydraulicTipperKit,\n      picklistValueId: 'hydraulicTipperKit',\n    },\n    {\n      getValue: (vehicle) => vehicle.accessories.lowDeck,\n      picklistValueId: 'lowDeck',\n    },\n  ];\n\n  return features\n    .filter((feature) => !!feature.getValue(vehicle))\n    .map((feature) => feature.picklistValueId);\n};\n\nexport const getInternalTitle = ({\n  make,\n  category,\n  modelName,\n  bodywork,\n  modelTypeName,\n}: {\n  category: string;\n  make?: string;\n  modelName?: string;\n  modelTypeName?: string;\n  bodywork?: string;\n}): string => {\n  if (category === Categories.Trailer || category === Categories.SemiTrailer) {\n    return [make, modelName, bodywork]\n      .filter((v): v is string => !!v)\n      .map((v) => v.trim())\n      .join(' ')\n      .trim();\n  }\n\n  return [make, modelName, modelTypeName]\n    .filter((v): v is string => !!v)\n    .map((v) => v.trim())\n    .join(' ')\n    .trim();\n};\n\nconst ALPHABET = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';\n\n// example: 1 -> A, 2 -> B, 26 -> Z, 27 -> AA, 28 -> AB, 52 -> AZ, 53 -> BA, 54 -> BB, 702 -> ZZ\nexport const convertNumberToLetters = (num: number): string => {\n  const lettersLength = ALPHABET.length;\n\n  if (num < 1) {\n    return '';\n  }\n\n  let remainder = num % lettersLength;\n  let quotient = Math.floor(num / lettersLength);\n\n  // If remainder is 0, it means we should map it to 'Z' and reduce the quotient by 1\n  if (remainder === 0) {\n    remainder = lettersLength;\n    quotient -= 1;\n  }\n\n  return convertNumberToLetters(quotient) + ALPHABET.charAt(remainder - 1);\n};\n\n// example: A -> 1, B -> 2, Z -> 26, AA -> 27, AB -> 28, AZ -> 52, BA -> 53, BB -> 54, ZZ -> 702\nexport const convertLettersToNumber = (letters: string): number => {\n  const base = ALPHABET.length;\n\n  let result = 0;\n\n  for (let i = 0; i < letters.length; i++) {\n    const charValue = ALPHABET.indexOf(letters[i]) + 1;\n    result = result * base + charValue;\n  }\n\n  return result;\n};\n\nexport const getNextRelatedStockNumber = (stockNumber: string): string => {\n  const counterPattern = /^([A-Z]+\\d{5})([A-Z]{0,2})$/;\n  const match = stockNumber.match(counterPattern);\n  if (match == null) {\n    throw new XError('core-sdk.vehicles.bad-stock-number', { stockNumber });\n  }\n\n  const baseStockNumber = match[1];\n  const counterLetters = match[2];\n  const counterNumber = convertLettersToNumber(counterLetters);\n  const nextCounterNumber = counterNumber + 1;\n  const nextCounterLetters = convertNumberToLetters(nextCounterNumber);\n  return `${baseStockNumber}${nextCounterLetters}`;\n};\n"]}
+{"version":3,"file":"vehicles.js","sourceRoot":"/","sources":["utils/vehicles.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAG7C,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,OAA4B,EAAY,EAAE;IAC9E,MAAM,QAAQ,GAGR;QACJ;YACE,QAAQ,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,cAAc,EAAE,KAAK,EAAE,OAAO;YAC7D,eAAe,EAAE,OAAO;SACzB;QACD;YACE,QAAQ,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,cAAc,EAAE,QAAQ,EAAE,OAAO;YAChE,eAAe,EAAE,UAAU;SAC5B;QACD,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,eAAe,EAAE,KAAK,EAAE;QAC1E;YACE,QAAQ,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,gBAAgB;YAC3D,eAAe,EAAE,kBAAkB;SACpC;QACD;YACE,QAAQ,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,kBAAkB;YAC7D,eAAe,EAAE,oBAAoB;SACtC;QACD;YACE,QAAQ,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,OAAO;YAClD,eAAe,EAAE,SAAS;SAC3B;KACF,CAAC;IAEF,OAAO,QAAQ;SACZ,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;SAChD,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;AAC/C,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,EAC/B,IAAI,EACJ,QAAQ,EACR,SAAS,EACT,QAAQ,EACR,aAAa,GAOd,EAAU,EAAE;IACX,IAAI,QAAQ,KAAK,UAAU,CAAC,OAAO,IAAI,QAAQ,KAAK,UAAU,CAAC,WAAW,EAAE,CAAC;QAC3E,OAAO,CAAC,IAAI,EAAE,SAAS,EAAE,aAAa,EAAE,QAAQ,CAAC;aAC9C,MAAM,CAAC,CAAC,CAAC,EAAe,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;aAC/B,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;aACpB,IAAI,CAAC,GAAG,CAAC;aACT,IAAI,EAAE,CAAC;IACZ,CAAC;IAED,OAAO,CAAC,IAAI,EAAE,SAAS,EAAE,aAAa,CAAC;SACpC,MAAM,CAAC,CAAC,CAAC,EAAe,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;SAC/B,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;SACpB,IAAI,CAAC,GAAG,CAAC;SACT,IAAI,EAAE,CAAC;AACZ,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,4BAA4B,CAAC;AAG9C,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,GAAW,EAAU,EAAE;IAC5D,MAAM,aAAa,GAAG,QAAQ,CAAC,MAAM,CAAC;IAEtC,IAAI,GAAG,GAAG,CAAC,EAAE,CAAC;QACZ,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,IAAI,SAAS,GAAG,GAAG,GAAG,aAAa,CAAC;IACpC,IAAI,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,aAAa,CAAC,CAAC;IAG/C,IAAI,SAAS,KAAK,CAAC,EAAE,CAAC;QACpB,SAAS,GAAG,aAAa,CAAC;QAC1B,QAAQ,IAAI,CAAC,CAAC;IAChB,CAAC;IAED,OAAO,sBAAsB,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC;AAC3E,CAAC,CAAC;AAGF,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,OAAe,EAAU,EAAE;IAChE,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,CAAC;IAE7B,IAAI,MAAM,GAAG,CAAC,CAAC;IAEf,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACxC,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QACnD,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACrC,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,WAAmB,EAAU,EAAE;IACvE,MAAM,cAAc,GAAG,6BAA6B,CAAC;IACrD,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;IAChD,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAClB,MAAM,IAAI,MAAM,CAAC,oCAAoC,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED,MAAM,eAAe,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IACjC,MAAM,cAAc,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAChC,MAAM,aAAa,GAAG,sBAAsB,CAAC,cAAc,CAAC,CAAC;IAC7D,MAAM,iBAAiB,GAAG,aAAa,GAAG,CAAC,CAAC;IAC5C,MAAM,kBAAkB,GAAG,sBAAsB,CAAC,iBAAiB,CAAC,CAAC;IACrE,OAAO,GAAG,eAAe,GAAG,kBAAkB,EAAE,CAAC;AACnD,CAAC,CAAC","sourcesContent":["import { XError } from '@bisondesk/commons-sdk/errors';\nimport { Categories } from '../constants.js';\nimport { VehicleExternalInfo } from '../types/vehicles.js';\n\nexport const extractCustomFeatures = (vehicle: VehicleExternalInfo): string[] => {\n  const features: {\n    getValue: (vehicle: VehicleExternalInfo) => any;\n    picklistValueId: string;\n  }[] = [\n    {\n      getValue: (vehicle) => vehicle.superstructure?.crane?.present,\n      picklistValueId: 'crane',\n    },\n    {\n      getValue: (vehicle) => vehicle.superstructure?.tailgate?.present,\n      picklistValueId: 'tailgate',\n    },\n    { getValue: (vehicle) => vehicle.accessories.adr, picklistValueId: 'adr' },\n    {\n      getValue: (vehicle) => vehicle.accessories.retarderIntarder,\n      picklistValueId: 'retarderIntarder',\n    },\n    {\n      getValue: (vehicle) => vehicle.accessories.hydraulicTipperKit,\n      picklistValueId: 'hydraulicTipperKit',\n    },\n    {\n      getValue: (vehicle) => vehicle.accessories.lowDeck,\n      picklistValueId: 'lowDeck',\n    },\n  ];\n\n  return features\n    .filter((feature) => !!feature.getValue(vehicle))\n    .map((feature) => feature.picklistValueId);\n};\n\nexport const getInternalTitle = ({\n  make,\n  category,\n  modelName,\n  bodywork,\n  modelTypeName,\n}: {\n  category: string;\n  make?: string;\n  modelName?: string;\n  modelTypeName?: string;\n  bodywork?: string;\n}): string => {\n  if (category === Categories.Trailer || category === Categories.SemiTrailer) {\n    return [make, modelName, modelTypeName, bodywork]\n      .filter((v): v is string => !!v)\n      .map((v) => v.trim())\n      .join(' ')\n      .trim();\n  }\n\n  return [make, modelName, modelTypeName]\n    .filter((v): v is string => !!v)\n    .map((v) => v.trim())\n    .join(' ')\n    .trim();\n};\n\nconst ALPHABET = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';\n\n// example: 1 -> A, 2 -> B, 26 -> Z, 27 -> AA, 28 -> AB, 52 -> AZ, 53 -> BA, 54 -> BB, 702 -> ZZ\nexport const convertNumberToLetters = (num: number): string => {\n  const lettersLength = ALPHABET.length;\n\n  if (num < 1) {\n    return '';\n  }\n\n  let remainder = num % lettersLength;\n  let quotient = Math.floor(num / lettersLength);\n\n  // If remainder is 0, it means we should map it to 'Z' and reduce the quotient by 1\n  if (remainder === 0) {\n    remainder = lettersLength;\n    quotient -= 1;\n  }\n\n  return convertNumberToLetters(quotient) + ALPHABET.charAt(remainder - 1);\n};\n\n// example: A -> 1, B -> 2, Z -> 26, AA -> 27, AB -> 28, AZ -> 52, BA -> 53, BB -> 54, ZZ -> 702\nexport const convertLettersToNumber = (letters: string): number => {\n  const base = ALPHABET.length;\n\n  let result = 0;\n\n  for (let i = 0; i < letters.length; i++) {\n    const charValue = ALPHABET.indexOf(letters[i]) + 1;\n    result = result * base + charValue;\n  }\n\n  return result;\n};\n\nexport const getNextRelatedStockNumber = (stockNumber: string): string => {\n  const counterPattern = /^([A-Z]+\\d{5})([A-Z]{0,2})$/;\n  const match = stockNumber.match(counterPattern);\n  if (match == null) {\n    throw new XError('core-sdk.vehicles.bad-stock-number', { stockNumber });\n  }\n\n  const baseStockNumber = match[1];\n  const counterLetters = match[2];\n  const counterNumber = convertLettersToNumber(counterLetters);\n  const nextCounterNumber = counterNumber + 1;\n  const nextCounterLetters = convertNumberToLetters(nextCounterNumber);\n  return `${baseStockNumber}${nextCounterLetters}`;\n};\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bisondesk/core-sdk",
-  "version": "1.0.442",
+  "version": "1.0.444",
   "description": "",
   "type": "module",
   "scripts": {

package/src/apis/opportunities.ts

@@ -10,6 +10,26 @@ import { LeasingQuoteParams } from '../types/quote-settings.js';
 import { Quote } from '../types/quotes.js';
 import { OpportunityReservation } from '../types/reservations.js';
 
+export const listOpportunities = async (
+  tenantId: string,
+  filterOptions?: {}
+): Promise<Opportunity[]> => {
+  const auth = await getAdminAuth();
+  const result = await fetchJson<Opportunity[]>(
+    `${process.env.CORE_API_ORIGIN}/api/opportunities/list`,
+    {
+      method: 'POST',
+      headers: cleanHeaders({
+        Authorization: auth,
+        [TENANT_ID_ADMIN_HEADER]: tenantId,
+      }),
+      body: JSON.stringify(filterOptions),
+    }
+  );
+
+  return result ?? [];
+};
+
 export const getOpportunityById = async (
   tenantId: string,
   opportunityId: string

package/src/apis/vehicles.ts

@@ -120,7 +120,7 @@ export const listVehiclesMarketing = async (
   });
 
   if (response.ok) {
-    return response.status === 200 ? (response.json() as any) : undefined;
+    return response.status === 200 ? (response.json() as any) : [];
   }
 
   const body = await response.text();

package/src/types/opportunities.ts

@@ -10,6 +10,19 @@ import { BaseSearchRequest } from './search.js';
 import { DataRecord, ReferenceData } from './utils.js';
 import { Vehicle } from './vehicles.js';
 
+export type ListOpportunitiesFilters = {
+  offset?: number;
+  limit?: number;
+  organizationId?: string;
+  contactId?: string;
+  vehicleId?: string;
+  excludeOpportunityId?: string;
+  excludeLost?: boolean;
+  statuses?: OpportunityStatus[];
+  since?: string;
+  until?: string;
+};
+
 export enum OpportunityActions {
   ADD_COMMISSION = 'add_commission',
   CREATE_QUOTE = 'create_quote',
@@ -362,7 +375,6 @@ export type LeasingQuoteTemplateData = {
   leasing: {
     deposit: string;
     totalMonthlyAmount: string;
-    totalMonthlyAmountExclVat: string;
     depositExclVat: string;
     startupFee: string;
     startupFeeExclVat: string;
@@ -433,7 +445,7 @@ export type LeasingProformaTemplateData = {
   };
 };
 
-export type SalesProformaTemplateData = {
+export type SalesTemplateData = {
   opportunity: {
     id: string;
     offerNumber: string;
@@ -456,6 +468,7 @@ export type SalesProformaTemplateData = {
     type?: string;
     km: string | number;
     vin: string;
+    year: string;
   };
   c: {
     organizationId?: string;
@@ -468,41 +481,7 @@ export type SalesProformaTemplateData = {
     address?: string;
     country: string;
   };
-  i: LineItemPdfTemplate[];
-  t: {
-    totalExclVat: string;
-    vatAmount: string;
-    total: string;
-  };
-};
-
-export type SalesAgreementTemplateData = {
-  opportunity: {
-    id: string;
-    offerNumber: string;
-  };
-  currentDate: string;
-  accountManager: {
-    fullName: string;
-    email: string;
-    phone: string;
-  };
-  vehicle: {
-    line1: string;
-    line2: string;
-    stockNumber: string;
-  };
-  c: {
-    organizationId?: string;
-    clientId: string;
-    company: string;
-    fullName: string;
-    vatNumber?: string;
-    email?: string;
-    phone?: string;
-    address?: string;
-    country: string;
-  };
+  iExtended: LineItemPdfTemplate[];
   i: LineItemPdfTemplate[];
   t: {
     totalExclVat: string;

package/src/types/user-performance.ts

@@ -0,0 +1,103 @@
+// The commission can be expressed either as a percentage (for profit-based metrics)
+// or as an amount per unit (for unit-based metrics).
+export type CommissionType = 'percentage' | 'unit';
+
+// Comprehensive metric configuration
+export type MetricConfig = {
+  id: string;
+  commissionType: CommissionType;
+  format?: Intl.NumberFormatOptions;
+};
+
+// A tier defines a range of performance (using lower and optional upper bounds)
+// along with the associated commission rate. For example, 0–100 units, then 100–400 units, etc.
+export type CommissionTier = {
+  lowerBound: number; // inclusive
+  upperBound?: number; // inclusive (omit for the last tier)
+  commissionRate: number;
+  default?: boolean; // if true, this tier's upper bound is used as reference for dashboards visualizations
+};
+
+// Each target (metric) has one or more tiers.
+// For example, for UnitsSold you might have three tiers corresponding to bare minimum, normal, and above average.
+export type TargetCommission = {
+  metricId: string;
+  tiers: CommissionTier[];
+};
+
+export type UserCommissionPlan = {
+  userId: string;
+  year: number;
+  targets: TargetCommission[];
+};
+
+export enum CommissionGrade {
+  TooLow = 'tooLow',
+  Low = 'low',
+  OnTarget = 'onTarget',
+}
+
+export type UserCommissionStatus = {
+  userId: string;
+  createdAt: string; // iso date string
+  year: number;
+  performance: {
+    [metricId: string]: {
+      value: string; // actual metric achieved
+      estimated?: string; // estimated commission for the metric, based on the current trend
+      grade?: CommissionGrade; // grade for the metric
+      target?: string; // the upper bound of the default tier
+    };
+  };
+  commission: {
+    total: string;
+    potential?: string;
+    estimated?: string; // estimated commission for the year, based on the current trend
+    grade?: CommissionGrade;
+    detailed?: {
+      [metricId: string]: {
+        earned: string; // commission amount for each target
+        potential?: string; // potential commission for the metric, based on the actual metric achieved and the commission tiers
+      };
+    };
+  };
+  payments: {
+    total: string;
+    yearly?: {
+      // details for each year for which the outstanding commission is > 0
+      [year: number]: {
+        paid: string;
+      };
+    };
+  };
+  outstanding: {
+    total: string;
+    // details for each year for which the outstanding commission is > 0
+    yearly?: {
+      [year: number]: {
+        outstanding: string;
+      };
+    };
+  };
+};
+
+export type NewUserCommissionPayment = {
+  userId: string; // who was the payment made to
+  paidBy: string;
+  paidAt: string;
+  amount: string;
+};
+
+export type UserCommissionPayment = {
+  id: string;
+} & NewUserCommissionPayment;
+
+export type UserCommissionsPaymentRequest = {
+  limit?: number;
+  nextToken?: string;
+};
+
+export type UserCommissionInfo = {
+  manager?: boolean;
+  performance: boolean;
+};

package/src/types/vehicle-performance.ts

@@ -0,0 +1,106 @@
+import { OpportunityType } from '../constants.js';
+import { VehicleSaleDealStatus, VehicleSaleLogisticsStatus } from './opportunities.js';
+import { VehiclePurchaseDealStatus, VehiclePurchaseLogisticsStatus } from './vehicles.js';
+
+export type VehicleSaleOverview = {
+  opportunityId: string;
+  type: OpportunityType;
+  userId: string; // account manager of the latest opportunity (if opportunity is >= review)
+
+  // client details
+  clientId: string;
+  clientCode: number;
+  clientCountryCode: string;
+  clientVat?: string;
+  conglomerate?: boolean;
+  clientEmail?: string;
+  clientPhone?: string;
+
+  // vehicle details
+  dealStatus: VehicleSaleDealStatus;
+  logisticsStatus: VehicleSaleLogisticsStatus;
+
+  // opportunity dates
+  createdAt: string;
+  engagedAt?: string;
+  acceptedAt?: string;
+  validatedAt?: string;
+  reviewedAt?: string;
+  preparedAt?: string;
+  deliveredAt?: string;
+  wonAt?: string;
+
+  saleAt?: string; // this is the date that should be considered for the sale according to TJ (often the same as fullPaymentAt)
+
+  // money-related details
+  firstInvoiceIssuedAt?: string;
+  lastInvoiceIssuedAt?: string;
+  firstPaymentAt?: string;
+  fullPaymentAt?: string;
+  expectedAmount: string; // from quote(s)
+  actualAmount: string; // from all invoices
+  lifetimeActualAmount: string; // sum of all invoices from all opportunities for this vehicle
+
+  // is there an invoice with category related to the purchase of commercial vehicle
+  // (we probably need a way to flag those categories since it is also important for the stocklist)
+  hasMainInvoice?: boolean;
+};
+
+export type VehiclePurchaseOverview = {
+  userId: string; // purchaser
+
+  dealStatus: VehiclePurchaseDealStatus;
+  logisticsStatus: VehiclePurchaseLogisticsStatus;
+
+  supplierId: string;
+  supplierCode: string;
+  supplierCountryCode: string;
+  supplierVat?: string;
+  conglomerate?: boolean;
+  supplierEmail?: string;
+  supplierPhone?: string;
+
+  // money-related details
+  firstInvoiceIssuedAt?: string;
+  lastInvoiceIssuedAt?: string;
+  firstPaymentAt?: string;
+  fullPaymentAt?: string;
+  expectedAmount: string;
+  actualAmount: string;
+
+  purchaseAt?: string; // this is the date that should be considered for the purchase according to TJ (often the same as fullPaymentAt)
+
+  // log
+  marketingAt?: string; // no vehicle in our parking, just digital marketing
+  evaluationAt?: string; // in consignation
+  purchaseAgreedAt?: string;
+  // firstPaymentAllowedAt?: string;
+  // firstPaymentSentAt?: string;
+  // fullPaymentAllowedAt?: string;
+  // fullPaymentSentAt?: string;
+  arrivedAt?: string;
+  checkedInAt?: string;
+
+  hasMainInvoice?: boolean;
+};
+
+export type VehicleProfitOverview = {
+  expectedProfit?: string;
+  expectedRoi?: string;
+
+  actualProfit?: string;
+  actualRoi?: string;
+};
+
+type VehicleSummary = {
+  branch: string;
+  stockNumber: string;
+  id: string;
+};
+
+export type VehicleBusinessOverview = {
+  vehicle: VehicleSummary;
+  purchase: VehiclePurchaseOverview;
+  sale?: VehicleSaleOverview;
+  profit?: VehicleProfitOverview;
+};

package/src/utils/vehicles.ts

@@ -49,7 +49,7 @@ export const getInternalTitle = ({
   bodywork?: string;
 }): string => {
   if (category === Categories.Trailer || category === Categories.SemiTrailer) {
-    return [make, modelName, bodywork]
+    return [make, modelName, modelTypeName, bodywork]
       .filter((v): v is string => !!v)
       .map((v) => v.trim())
       .join(' ')