@bisondesk/documents-sdk 1.0.315 → 1.0.317

package/src/apis/documents.ts

@@ -0,0 +1,96 @@
+import { TENANT_ID_ADMIN_HEADER } from '@bisondesk/commons-sdk/constants';
+import { XError } from '@bisondesk/commons-sdk/errors';
+import { getAdminAuth } from '@bisondesk/commons-sdk/fetch';
+import fetch, { Response } from 'node-fetch';
+import { FinanceBooking } from '../types/booking.js';
+import { AdministrativeDocument, FinanceDocument } from '../types/documents.js';
+
+export const upsertFinanceDoc = async (
+  tenantId: string,
+  doc: FinanceDocument
+): Promise<FinanceDocument> => {
+  const auth = await getAdminAuth();
+  const response: Response = await fetch(`${process.env.CORE_API_ORIGIN}/api/documents/finance`, {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json',
+      Authorization: auth,
+      [TENANT_ID_ADMIN_HEADER]: tenantId,
+    },
+    body: JSON.stringify(doc),
+  });
+
+  if (response.status === 200) {
+    return response.json() as any;
+  }
+
+  const body = await response.text();
+  throw new XError('core-sdk.documents.upsert-finance-doc-fail', {
+    tenantId,
+    doc,
+    response: body,
+    status: response.status,
+  });
+};
+
+export const upsertAdminDoc = async (
+  tenantId: string,
+  doc: AdministrativeDocument
+): Promise<AdministrativeDocument> => {
+  const auth = await getAdminAuth();
+  const response: Response = await fetch(
+    `${process.env.CORE_API_ORIGIN}/api/documents/administrative`,
+    {
+      method: 'POST',
+      headers: {
+        'Content-Type': 'application/json',
+        Authorization: auth,
+        [TENANT_ID_ADMIN_HEADER]: tenantId,
+      },
+      body: JSON.stringify(doc),
+    }
+  );
+
+  if (response.status === 200) {
+    return response.json() as any;
+  }
+
+  const body = await response.text();
+  throw new XError('core-sdk.documents.upsert-admin-doc-fail', {
+    tenantId,
+    doc,
+    response: body,
+    status: response.status,
+  });
+};
+
+export const upsertFinanceBooking = async (
+  tenantId: string,
+  booking: FinanceBooking
+): Promise<FinanceBooking> => {
+  const auth = await getAdminAuth();
+  const response: Response = await fetch(
+    `${process.env.CORE_API_ORIGIN}/api/documents/finance/booking`,
+    {
+      method: 'POST',
+      headers: {
+        'Content-Type': 'application/json',
+        Authorization: auth,
+        [TENANT_ID_ADMIN_HEADER]: tenantId,
+      },
+      body: JSON.stringify(booking),
+    }
+  );
+
+  if (response.status === 200) {
+    return response.json() as any;
+  }
+
+  const body = await response.text();
+  throw new XError('core-sdk.documents.upsert-finance-booking-fail', {
+    tenantId,
+    booking,
+    response: body,
+    status: response.status,
+  });
+};

package/src/types/booking.ts

@@ -0,0 +1,29 @@
+import { FinanceDocument } from './documents.js';
+
+export type FinanceBookingEvent = {
+  id: string;
+  branchId: string;
+  actionAt: string;
+  userId: string;
+  tenantId: string;
+  type: 'Sale Finance' | 'Purchase Finance';
+  version: FinanceDocument['version'];
+};
+
+export type FinanceBooking = {
+  branchId: string; // same tenantId can have different companies
+  bookingNumber: string; // same booking number can and will exist across different "branches", unique => BranchId / Journal / Booking Number
+  documentId: string;
+
+  booked: true;
+  journal?: string;
+  amount?: string;
+  reportingPeriod?: number;
+  reportingYear?: number;
+  paid: boolean;
+
+  createdAt: string;
+  createdBy: string;
+  modifiedAt: string;
+  modifiedBy: string;
+};

package/src/types/documents.ts

@@ -1,6 +1,7 @@
+import type { Block } from '@aws-sdk/client-textract';
 import { BusinessEntityIds } from '@bisondesk/commons-sdk/constants';
-import { AttachmentValue, PhoneNumberValue, SearchPermissions } from '@bisondesk/commons-sdk/types';
-import { FinanceBooking, FinanceDocument } from '@bisondesk/core-sdk/types/documents';
+import { AttachmentValue, PhoneNumberValue } from '@bisondesk/commons-sdk/types';
+import { FinanceDocumentV1 } from './legacy.js';
 
 export enum AdministrativeDocType {
   General = 'General Administrative',
@@ -9,6 +10,8 @@ export enum AdministrativeDocType {
   Sale = 'Sale Administrative',
 }
 
+export type FinanceDocument = FinanceDocumentV1 | FinanceDocumentV2;
+
 export type Association = {
   businessEntityId: BusinessEntityIds;
   id: string;
@@ -96,6 +99,7 @@ export type FinanceDocumentV2 = BaseDocument & {
   invoiceId?: string; // mandatory in credit notes but forbidden in invoices
   issueDate: string;
   lines: FinanceDocumentLine[];
+  paymentNotes?: string;
   notes?: string;
   salesperson: {
     name: string;
@@ -142,6 +146,7 @@ export enum DraftProcessStatus {
   // Prefill = 'Prefill',
   // Ready = 'Ready',
   Error = 'Error',
+  Validated = 'Validated',
   Unprocessed = 'Unprocessed',
   Unvalidated = 'Unvalidated',
 }
@@ -187,23 +192,18 @@ export type NewDocumentDraft<T = NewFinanceDocumentV2 | NewAdministrativeDocumen
     documentType?: DocumentType;
   };
 
-export type SearchFinanceDocument = {
-  doc: FinanceDocumentV2;
-  permissions: SearchPermissions;
-  booking?: FinanceBooking;
-};
-
-export type SearchAdministrativeDocument = {
-  doc: AdministrativeDocument;
-  permissions: SearchPermissions;
-};
-
 export const isFinanceDocumentV2 = (
-  arg: FinanceDocumentV2 | FinanceDocument
+  arg: FinanceDocumentV2 | FinanceDocumentV1
 ): arg is FinanceDocumentV2 => {
   return (arg as FinanceDocumentV2).version === 2;
 };
 
+export const isFinanceDocumentV1 = (
+  arg: FinanceDocumentV2 | FinanceDocumentV1
+): arg is FinanceDocumentV1 => {
+  return (arg as FinanceDocumentV2).version == null;
+};
+
 export const isAdministrativeDocument = (arg: any): arg is AdministrativeDocument => {
   return Object.values(AdministrativeDocType).includes(arg.type);
 };
@@ -249,3 +249,26 @@ export type FinanceDocumentBisondeskSettings = {
     templateId: string;
   };
 };
+
+export type FinanceDocumentPayment = { documentId: string } & (
+  | { paid: true; paidAt: string; comment?: string }
+  | { paid: false; paidAt?: undefined; comment?: undefined }
+);
+
+export enum FinanceDocumentSubtype {
+  Invoice = 'Invoice',
+  CreditNote = 'Credit Note',
+  Proforma = 'Proforma',
+  PurchaseOrder = 'Purchase Order',
+}
+
+export type OCRDocument = {
+  Blocks?: Block[];
+  orientation: number;
+  hasCurrency: boolean;
+};
+
+export enum FinanceDocumentActions {
+  PAY_FINANCE_DOCUMENT = 'pay_finance_document',
+  DELETE_FINANCE_DOCUMENT = 'delete_finance_document',
+}

package/src/types/embeddings.ts

@@ -0,0 +1,20 @@
+export enum EmbeddingType {
+  Document = 'document',
+  Line = 'line',
+}
+
+export type DocumentEmbedding = {
+  id: string;
+  documentId: string;
+  embedding: number[];
+  type: EmbeddingType;
+  active: boolean;
+
+  category?: string;
+  lineCategory?: string;
+};
+
+export type DocumentEmbeddingDB = {
+  data: Omit<DocumentEmbedding, 'embedding'>;
+  embedding: string;
+};

package/src/types/events.ts

@@ -0,0 +1,19 @@
+export type FinanceDocumentEvent = {
+  id: string;
+  actionAt: string;
+  action: 'upsert' | 'delete';
+  userId: string;
+  tenantId: string;
+  type: 'Sale Finance' | 'Purchase Finance';
+  subtype: string; // Invoice, Credit Note, etc.
+};
+
+export type AdminDocumentEvent = {
+  id: string;
+  actionAt: string;
+  action: 'upsert' | 'delete';
+  userId: string;
+  tenantId: string;
+  type: string;
+  subtype: string;
+};

package/src/types/legacy.ts

@@ -0,0 +1,56 @@
+import { AttachmentValue } from '@bisondesk/commons-sdk/types';
+
+export type FinanceLineV1 = {
+  associations: {
+    others: { vehicleId: string; label: string }[];
+    sales: { id: string; vehicleId: string; label: string }[];
+    purchases: { id: string; vehicleId: string; label: string }[];
+  };
+  description: string;
+  id: string;
+  lineCode: string;
+  quantity: string;
+  unitPriceExclusive: string;
+  vatCode: string;
+  vatCoefficient: string;
+};
+
+export type FinanceDocumentV1 = {
+  id: string;
+  branchId: string;
+  version?: 1.0;
+
+  type: 'Sale Finance' | 'Purchase Finance';
+  subtype: 'Invoice' | 'Credit Note' | 'Proforma' | 'Purchase Order';
+  reference: string;
+
+  attachment: AttachmentValue;
+  lines: FinanceLineV1[];
+  notes?: string;
+
+  createdAt: string;
+  createdBy: string;
+  issueDate: string;
+  paidAt?: string;
+  paymentNotes?: string;
+  amount?: string;
+  dueDate?: string;
+
+  organizationSummary?: {
+    id: string;
+    code: string;
+    name: string;
+    country: string;
+    vatNumber?: string;
+
+    addressLine1?: string;
+    addressLine2?: string;
+    addressLine3?: string;
+    postcode?: string;
+    city?: string;
+
+    email?: string;
+    phone?: string;
+    fax?: string;
+  };
+};

package/src/types/scans.ts

@@ -1,5 +1,11 @@
+import { DocumentType } from './documents.js';
+
 export type NewDocumentScanEvent = {
   tenantId: string;
   source: string;
-  files: string[];
+  fileUrl: string;
+
+  documentType?: DocumentType;
+  existingDraftId?: string;
+  skipSplit?: boolean;
 };

package/src/types/search.ts

@@ -0,0 +1,42 @@
+import { SearchPermissions } from '@bisondesk/commons-sdk/types';
+import { Organization } from '@bisondesk/core-sdk/types/crm';
+import { PublicSearchDefinition } from '@bisondesk/core-sdk/types/definitions';
+import { FinanceBooking } from './booking.js';
+import { AdministrativeDocument, FinanceDocument } from './documents.js';
+
+export type SearchDocumentVehicleRef = {
+  id: string;
+  stockNumber: string;
+  administrativeNumber?: string;
+};
+
+export type InputSearchFinanceDocument = SearchFinanceDocument & {
+  permissions: SearchPermissions;
+};
+
+export type InputSearchAdministrativeDocument = SearchAdministrativeDocument & {
+  permissions: SearchPermissions;
+};
+
+export type DocsSearchDefinitions = {
+  searchFinanceDoc: PublicSearchDefinition;
+};
+
+export type AdministrativeDocsSearchDefinitions = {
+  searchAdministrativeDoc: PublicSearchDefinition;
+};
+
+export type SearchFinanceDocument = {
+  permissions: SearchPermissions;
+  org?: Organization;
+  doc: FinanceDocument;
+  booking?: FinanceBooking;
+  vehicle?: SearchDocumentVehicleRef[];
+};
+
+export type SearchAdministrativeDocument = {
+  doc: AdministrativeDocument;
+  permissions: SearchPermissions;
+  org?: Organization;
+  vehicle?: SearchDocumentVehicleRef[];
+};

package/src/utils.ts

@@ -0,0 +1 @@
+export const getPdfPreviewSrc = (fileUrl: string) => fileUrl.replace('.pdf', '/1.jpg');

package/tsconfig.json

@@ -9,7 +9,6 @@
     "composite": true,
     "rootDir": "src",
     "outDir": "lib",
-    "declarationDir": "lib/types"
   },
   "include": ["src"],
   "references": [{ "path": "../commons-sdk" }, { "path": "../core-sdk" }]