@bisondesk/documents-sdk 1.0.396 → 1.0.398

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bisondesk/documents-sdk",
-  "version": "1.0.396",
+  "version": "1.0.398",
   "description": "",
   "type": "module",
   "scripts": {
@@ -15,7 +15,9 @@
     "@bisondesk/commons-sdk": "*",
     "@bisondesk/core-sdk": "*",
     "decimal.js": "10.4.3",
-    "joi": "17.4.0",
+    "joi": "17.4.0"
+  },
+  "peerDependencies": {
     "node-fetch": "3.3.2"
   },
   "devDependencies": {

package/src/apis/documents.ts

@@ -3,7 +3,7 @@ import { XError } from '@bisondesk/commons-sdk/errors';
 import { cleanHeaders, getAdminAuth } from '@bisondesk/commons-sdk/fetch';
 import { DataRecord, ReferenceData } from '@bisondesk/core-sdk/types/utils';
 import fetch, { Response } from 'node-fetch';
-import { FinanceBooking, FinanceBookingPaymentUpdate } from '../types/booking.js';
+import { FinanceBooking } from '../types/booking.js';
 import { AdministrativeDocument, FinanceDocument } from '../types/documents.js';
 
 export const getFinanceDocument = async (
@@ -206,38 +206,3 @@ export const upsertFinanceBooking = async (
     status: response.status,
   });
 };
-
-export const updateFinanceBookingPayment = async (
-  tenantId: string,
-  update: FinanceBookingPaymentUpdate
-): Promise<FinanceBooking | undefined> => {
-  const auth = await getAdminAuth();
-  const response: Response = await fetch(
-    `${process.env.CORE_API_ORIGIN}/api/documents/finance/booking/payment`,
-    {
-      method: 'PUT',
-      headers: {
-        'Content-Type': 'application/json',
-        Authorization: auth,
-        [TENANT_ID_ADMIN_HEADER]: tenantId,
-      },
-      body: JSON.stringify(update),
-    }
-  );
-
-  if (response.status === 204) {
-    return;
-  }
-
-  if (response.status === 200) {
-    return response.json() as any;
-  }
-
-  const body = await response.text();
-  throw new XError('documents-sdk.finance-booking-payment-fail', {
-    tenantId,
-    update,
-    response: body,
-    status: response.status,
-  });
-};

package/src/constants.ts

@@ -1,4 +1,6 @@
-import { AppRoles } from '@bisondesk/commons-sdk/constants';
+import { AppRoles, SYSTEM_USER_ID } from '@bisondesk/commons-sdk/constants';
+import { AttachmentValue } from '@bisondesk/commons-sdk/types';
+import { getPdfPreviewSrc } from './utils/previews.js';
 
 export const DOCUMENT_PROCESSING_SETTINGS_ID = 'document-processing';
 
@@ -38,3 +40,14 @@ export const ENV_CONTRIBUTION_TYRES_LINE_CATEGORY_ID = 'env_contribution_tyres';
 export const STANDARD_VAT_CODE_ID = 'standard';
 export const SALE_EU_INTRA_COMMUNITY_VAT_CODE_ID = 'eu_ics_sale';
 export const SALE_EU_EXTRA_COMMUNITY_VAT_CODE_ID = 'eu_ecs_sale';
+
+export const GENERATING_PLACEHOLDER_ATTACHMENT: AttachmentValue = {
+  id: 'generating',
+  contentType: 'application/pdf',
+  fileName: 'generating.pdf',
+  uploadedBy: SYSTEM_USER_ID,
+  uploadedAt: '2024-04-08T14:51:55.785Z',
+  size: 95749,
+  url: '/storage/public/generating.pdf',
+  previewSrc: getPdfPreviewSrc('/storage/public/generating.pdf'),
+};

package/src/schemas.ts

@@ -34,7 +34,7 @@ const associationsSchema = Joi.array().items(
     recordId: Joi.string().required(),
     title: Joi.string().required(),
     description: Joi.string().required(),
-    tags: Joi.array().items(Joi.string()),
+    tags: Joi.array().items(Joi.string().empty('')),
   })
 );
 
@@ -49,14 +49,14 @@ export const lineSchema = Joi.object({
     unitPriceExcl: Joi.number().cast('string').required(),
     vatAmount: Joi.number().cast('string').required(),
   }),
-  invoiceLineId: Joi.string().uuid(),
+  invoiceLineId: Joi.string().empty('').uuid(),
   quantity: Joi.number().min(0).cast('string').required(),
   associations: associationsSchema,
   unitPriceExcl: Joi.number().cast('string').required(),
   vatAmount: Joi.number().cast('string').required(),
   vatCode: Joi.string().required(),
   vatPercentage: Joi.number().min(0).cast('string').required(),
-  vatReason: Joi.string(),
+  vatReason: Joi.string().empty(''),
 });
 
 export const newFinanceDocV2Schema = Joi.object({
@@ -71,15 +71,15 @@ export const newFinanceDocV2Schema = Joi.object({
   branchId: Joi.string().required(),
   category: Joi.string().required(),
   organizationSummary: orgSummarySchema.required(),
-  transferDescription: Joi.string(),
+  transferDescription: Joi.string().empty(''),
   invoiceId: Joi.string().uuid().empty(''),
   notes: Joi.string().empty(''),
   salesperson: Joi.object({
     name: Joi.string().required(),
     username: Joi.string().required(),
   }),
-  paidAt: Joi.string(),
-  tags: Joi.array().items(Joi.string()),
+  paidAt: Joi.string().empty(''),
+  tags: Joi.array().items(Joi.string().empty('')),
   total: Joi.object({
     amountExcl: Joi.number().min(0).cast('string').required(),
     amount: Joi.number().min(0).cast('string').required(),
@@ -103,11 +103,11 @@ export const newFinanceDocV2Schema = Joi.object({
 
 export const newAdministrativedDocumentSchema = Joi.object({
   id: Joi.string(),
-  displayName: Joi.string(),
+  displayName: Joi.string().empty(''),
   branchId: Joi.string().required(),
   attachment: attachmentValueSchema.required(),
   category: Joi.string().empty(''),
-  tags: Joi.array().items(Joi.string()),
+  tags: Joi.array().items(Joi.string().empty('')),
   associations: associationsSchema,
   organizationSummary: orgSummarySchema,
 });

package/src/types/documents.ts

@@ -242,7 +242,7 @@ export type NewDocumentDraft<T = NewFinanceDocumentV2 | NewAdministrativeDocumen
 export const isFinanceDocumentV2 = (
   arg: FinanceDocumentV2 | FinanceDocumentV1
 ): arg is FinanceDocumentV2 => {
-  return (arg as FinanceDocumentV2).version === 2;
+  return (arg as FinanceDocumentV2).version == 2;
 };
 
 export const isFinanceDocumentV1 = (
@@ -298,6 +298,12 @@ export type DocumentGenerateRequestEvent = {
   request: FinanceDocumentGenerateRequest;
 };
 
+export type FinanceDocumentGeneratePDFEvent = {
+  tenantId: string;
+  doc: FinanceDocumentV2;
+  request: FinanceDocumentGenerateRequest;
+};
+
 export type FinanceDocumentSettings<M = {}> = {
   provider: string;
   meta: {

package/src/types/events.ts

@@ -1,16 +1,38 @@
-import { Association, FinanceDocumentSubtype } from './documents.js';
+import { Association, FinanceDocument, FinanceDocumentSubtype } from './documents.js';
 
-export type FinanceDocumentEvent = {
+type BaseFinanceDocumentEvent = {
   id: string;
   actionAt: string;
-  action: 'create' | 'update' | 'delete';
   userId: string;
   tenantId: string;
   type: 'Sale Finance' | 'Purchase Finance';
   subtype: 'Invoice' | 'Credit Note' | 'Proforma' | 'Purchase Order' | FinanceDocumentSubtype;
-  version?: string;
+  version?: FinanceDocument['version'];
 };
 
+export type FinanceDocumentCreateEvent = BaseFinanceDocumentEvent & {
+  action: 'create';
+  document: FinanceDocument;
+  previousDocument?: undefined;
+};
+
+export type FinanceDocumentUpdateEvent = BaseFinanceDocumentEvent & {
+  action: 'update';
+  document: FinanceDocument;
+  previousDocument: FinanceDocument;
+};
+
+export type FinanceDocumentDeleteEvent = BaseFinanceDocumentEvent & {
+  action: 'delete';
+  document?: undefined;
+  previousDocument: FinanceDocument;
+};
+
+export type FinanceDocumentEvent =
+  | FinanceDocumentCreateEvent
+  | FinanceDocumentUpdateEvent
+  | FinanceDocumentDeleteEvent;
+
 export type AdminDocumentEvent = {
   id: string;
   actionAt: string;

package/src/types/legacy.ts

@@ -40,6 +40,12 @@ export type FinanceDocumentV1 = {
     username: string;
   };
 
+  total: {
+    amountExcl: string;
+    amount: string;
+    vatAmount: string;
+  };
+
   organizationSummary?: {
     id: string;
     code: string;

package/src/utils/finance.ts

@@ -2,6 +2,7 @@ import { BusinessEntityIds } from '@bisondesk/commons-sdk/constants';
 import { roundMoney } from '@bisondesk/commons-sdk/money';
 import { Decimal } from 'decimal.js';
 import { uniqBy } from 'lodash-es';
+import { GENERATING_PLACEHOLDER_ATTACHMENT } from '../constants.js';
 import {
   Association,
   DocumentDraft,
@@ -33,7 +34,15 @@ export const getAccountingDescription = (doc: FinanceDocumentV2): string => {
     ?.flatMap((line) => line.associations ?? [])
     .filter(Boolean) as Association[];
 
-  const uniqueAssociations = uniqBy(associations, (a) => `${a.businessEntityId}_${a.recordId}`);
+  // In the UI the user can only select one vehicle associations
+  const equivalentEntityIds = {
+    [BusinessEntityIds.ExternalVehicleSale]: BusinessEntityIds.Vehicles,
+  };
+
+  const uniqueAssociations = uniqBy(
+    associations,
+    (a) => `${equivalentEntityIds[a.businessEntityId] ?? a.businessEntityId}_${a.recordId}`
+  );
 
   if (uniqueAssociations.length !== 1) {
     return doc.reference;
@@ -45,7 +54,8 @@ export const getAccountingDescription = (doc: FinanceDocumentV2): string => {
       BusinessEntityIds.Vehicles,
       BusinessEntityIds.Opportunities,
       BusinessEntityIds.ExternalVehicleSale,
-    ].includes(firstAssociation.businessEntityId)
+    ].includes(firstAssociation.businessEntityId) &&
+    firstAssociation.tags != null
   ) {
     return `${firstAssociation.tags?.slice(0, 3).join(' ')} ${doc.reference}`.trim();
   }
@@ -160,3 +170,6 @@ export const getLineAmounts = (unitPriceExcl: string, quantity: string, vatRate:
     vatAmount: vatAmount.toString(),
   };
 };
+
+export const isGeneratingAttachment = (doc: FinanceDocument) =>
+  doc.attachment.id === GENERATING_PLACEHOLDER_ATTACHMENT.id;