@bisondesk/documents-sdk 1.0.315 → 1.0.316

package/lib/types/types/legacy.d.ts

@@ -0,0 +1,59 @@
+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;
+    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;
+    };
+};
+//# sourceMappingURL=legacy.d.ts.map

package/lib/types/types/legacy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"legacy.d.ts","sourceRoot":"/","sources":["types/legacy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAE/D,MAAM,MAAM,aAAa,GAAG;IAC1B,YAAY,EAAE;QACZ,MAAM,EAAE;YAAE,SAAS,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,MAAM,CAAA;SAAE,EAAE,CAAC;QAC/C,KAAK,EAAE;YAAE,EAAE,EAAE,MAAM,CAAC;YAAC,SAAS,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,MAAM,CAAA;SAAE,EAAE,CAAC;QAC1D,SAAS,EAAE;YAAE,EAAE,EAAE,MAAM,CAAC;YAAC,SAAS,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,MAAM,CAAA;SAAE,EAAE,CAAC;KAC/D,CAAC;IACF,WAAW,EAAE,MAAM,CAAC;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IAEjB,IAAI,EAAE,cAAc,GAAG,kBAAkB,CAAC;IAC1C,OAAO,EAAE,SAAS,GAAG,aAAa,GAAG,UAAU,GAAG,gBAAgB,CAAC;IACnE,SAAS,EAAE,MAAM,CAAC;IAElB,UAAU,EAAE,eAAe,CAAC;IAC5B,KAAK,EAAE,aAAa,EAAE,CAAC;IACvB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,mBAAmB,CAAC,EAAE;QACpB,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,GAAG,CAAC,EAAE,MAAM,CAAC;KACd,CAAC;CACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bisondesk/documents-sdk",
-  "version": "1.0.315",
+  "version": "1.0.316",
   "description": "",
   "scripts": {
     "build": "npx tsc --build tsconfig.cjs.json & npx tsc --build tsconfig.esm.json",
@@ -17,7 +17,6 @@
     "joi": "17.4.0"
   },
   "devDependencies": {
-    "@types/node": "16.11.7",
     "typescript": "4.7.4"
   },
   "main": "./lib/cjs/*",

package/src/types/booking.ts

@@ -0,0 +1,26 @@
+export type FinanceBookingEvent = {
+  id: string;
+  branchId: string;
+  actionAt: string;
+  userId: string;
+  tenantId: string;
+  type: 'Sale Finance' | 'Purchase Finance';
+};
+
+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 { 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 { FinanceBooking } from './booking';
+import { FinanceDocumentV1 } from './legacy';
 
 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;
@@ -199,7 +202,7 @@ export type SearchAdministrativeDocument = {
 };
 
 export const isFinanceDocumentV2 = (
-  arg: FinanceDocumentV2 | FinanceDocument
+  arg: FinanceDocumentV2 | FinanceDocumentV1
 ): arg is FinanceDocumentV2 => {
   return (arg as FinanceDocumentV2).version === 2;
 };
@@ -249,3 +252,15 @@ 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',
+}

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,55 @@
+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;
+
+  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;
+  };
+};