taxdrop-core 1.0.3 → 1.0.5

package/index.js

@@ -1 +1,2 @@
 export * from './src/invoices/document-types/index.js'
+export * from './src/counterparties/types/index.js'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "taxdrop-core",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "",
   "main": "index.js",
   "type": "module",
@@ -40,4 +40,4 @@
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-prettier": "^5.5.5"
   }
-}
+}

package/src/counterparties/types/entity-category-map-types.js

@@ -0,0 +1,56 @@
+/**
+ * Entity category map.
+ * Maps entity categories to their corresponding entity type and VAT status.
+ *
+ * @readonly
+ */
+
+/**
+ * Entity type enum values.
+ * These are the internal entity type identifiers used throughout the system.
+ *
+ * @readonly
+ * @enum {object}
+ */
+
+/**
+ * Entity category map constants.
+ * Maps entity categories to their corresponding entity type and VAT status.
+ *
+ * @module entity-category-map-types.constants
+ */
+
+export const ENTITY_CATEGORY_MAP = Object.freeze({
+  INDIVIDUAL: {
+    entityType: 'individual',
+    vatStatus: 'not_applicable',
+  },
+  SOLE_EXEMPT: {
+    entityType: 'sole_proprietor',
+    vatStatus: 'exempt',
+  },
+  SOLE_REGISTERED: {
+    entityType: 'sole_proprietor',
+    vatStatus: 'registered',
+  },
+  COMPANY: {
+    entityType: 'company',
+    vatStatus: 'registered',
+  },
+  NON_PROFIT_EXEMPT: {
+    entityType: 'non_profit',
+    vatStatus: 'exempt',
+  },
+  NON_PROFIT_REG: {
+    entityType: 'non_profit',
+    vatStatus: 'registered',
+  },
+  FOREIGN: {
+    entityType: 'foreign_entity',
+    vatStatus: 'foreign',
+  },
+  GOVERNMENT: {
+    entityType: 'government',
+    vatStatus: 'not_applicable',
+  },
+})

package/src/counterparties/types/entity-types.js

@@ -0,0 +1,24 @@
+/**
+ * Entity type constants.
+ * Defines all valid entity types in the system.
+ *
+ * @module entity-types.constants
+ */
+
+/**
+ * Entity type enum values.
+ * These are the internal entity type identifiers used throughout the system.
+ *
+ * @readonly
+ * @enum {string}
+ */
+export const ENTITY_TYPES = Object.freeze({
+  OTHER: 'other',
+  COMPANY: 'company',
+  INDIVIDUAL: 'individual',
+  NON_PROFIT: 'non_profit',
+  GOVERNMENT: 'government',
+  PARTNERSHIP: 'partnership',
+  SOLE_PROPRIETOR: 'sole_proprietor',
+  FOREIGN_ENTITY: 'foreign_entity',
+})

package/src/counterparties/types/index.js

@@ -0,0 +1,5 @@
+import { ENTITY_TYPES } from './entity-types.js'
+import { VAT_STATUSES } from './vat-statuses-types.js'
+import { ENTITY_CATEGORY_MAP } from './entity-category-map-types.js'
+
+export { ENTITY_TYPES, VAT_STATUSES, ENTITY_CATEGORY_MAP }

package/src/counterparties/types/vat-statuses-types.js

@@ -0,0 +1,13 @@
+/**
+ * VAT status types for counterparties.
+ * These represent VAT status only (סטטוס מע״מ בלבד).
+ *
+ * @readonly
+ * @enum {string}
+ */
+export const VAT_STATUSES = Object.freeze({
+  EXEMPT: 'exempt',
+  FOREIGN: 'foreign',
+  REGISTERED: 'registered',
+  NOT_APPLICABLE: 'not_applicable',
+})

package/src/invoices/document-types/document-types.js

@@ -17,9 +17,9 @@ export const LEGAL_DOCUMENT_TYPES = Object.freeze({
   RECEIPT: 'receipt',
   TAX_INVOICE: 'tax_invoice',
   CREDIT_INVOICE: 'credit_invoice',
-  PAYMENT_REQUEST: 'payment_request',
   TAX_INVOICE_RECEIPT: 'tax_invoice_receipt',
 })
+
 /**
  * Document type enum values.
  * These are the internal document type identifiers used throughout the system.
@@ -34,6 +34,7 @@ export const OPERATIONAL_DOCUMENT_TYPES = Object.freeze({
   INVOICE: 'invoice',
   DELIVERY_NOTE: 'delivery_note',
   PURCHASE_ORDER: 'purchase_order',
+  PAYMENT_REQUEST: 'payment_request',
   PROFORMA_INVOICE: 'proforma_invoice',
 })
 

package/tests/counterparties/types.test.js

@@ -0,0 +1,133 @@
+import { describe, it, expect } from 'vitest'
+import {
+  ENTITY_TYPES,
+  VAT_STATUSES,
+  ENTITY_CATEGORY_MAP,
+} from '../../src/counterparties/types/index.js'
+
+describe('counterparties/types', () => {
+  describe('ENTITY_TYPES', () => {
+    it('should be a frozen object', () => {
+      expect(Object.isFrozen(ENTITY_TYPES)).toBe(true)
+    })
+
+    it('should contain all expected entity types', () => {
+      expect(ENTITY_TYPES).toEqual({
+        OTHER: 'other',
+        COMPANY: 'company',
+        INDIVIDUAL: 'individual',
+        NON_PROFIT: 'non_profit',
+        GOVERNMENT: 'government',
+        PARTNERSHIP: 'partnership',
+        SOLE_PROPRIETOR: 'sole_proprietor',
+        FOREIGN_ENTITY: 'foreign_entity',
+      })
+    })
+
+    it('should have all values as strings', () => {
+      Object.values(ENTITY_TYPES).forEach((value) => {
+        expect(typeof value).toBe('string')
+      })
+    })
+
+    it('should be immutable', () => {
+      expect(() => {
+        // @ts-expect-error - we want to test the immutability
+        ENTITY_TYPES.NEW_TYPE = 'new_type'
+      }).toThrow()
+    })
+  })
+
+  describe('VAT_STATUSES', () => {
+    it('should be a frozen object', () => {
+      expect(Object.isFrozen(VAT_STATUSES)).toBe(true)
+    })
+
+    it('should contain all expected VAT statuses', () => {
+      expect(VAT_STATUSES).toEqual({
+        EXEMPT: 'exempt',
+        FOREIGN: 'foreign',
+        REGISTERED: 'registered',
+        NOT_APPLICABLE: 'not_applicable',
+      })
+    })
+
+    it('should have all values as strings', () => {
+      Object.values(VAT_STATUSES).forEach((value) => {
+        expect(typeof value).toBe('string')
+      })
+    })
+
+    it('should be immutable', () => {
+      expect(() => {
+        // @ts-expect-error - we want to test the immutability
+        VAT_STATUSES.NEW_STATUS = 'new_status'
+      }).toThrow()
+    })
+  })
+
+  describe('ENTITY_CATEGORY_MAP', () => {
+    it('should be a frozen object', () => {
+      expect(Object.isFrozen(ENTITY_CATEGORY_MAP)).toBe(true)
+    })
+
+    it('should contain all expected entity categories', () => {
+      expect(ENTITY_CATEGORY_MAP).toEqual({
+        INDIVIDUAL: {
+          entityType: 'individual',
+          vatStatus: 'not_applicable',
+        },
+        SOLE_EXEMPT: {
+          entityType: 'sole_proprietor',
+          vatStatus: 'exempt',
+        },
+        SOLE_REGISTERED: {
+          entityType: 'sole_proprietor',
+          vatStatus: 'registered',
+        },
+        COMPANY: {
+          entityType: 'company',
+          vatStatus: 'registered',
+        },
+        NON_PROFIT_EXEMPT: {
+          entityType: 'non_profit',
+          vatStatus: 'exempt',
+        },
+        NON_PROFIT_REG: {
+          entityType: 'non_profit',
+          vatStatus: 'registered',
+        },
+        FOREIGN: {
+          entityType: 'foreign_entity',
+          vatStatus: 'foreign',
+        },
+        GOVERNMENT: {
+          entityType: 'government',
+          vatStatus: 'not_applicable',
+        },
+      })
+    })
+
+    it('should have all entityType values be valid ENTITY_TYPES', () => {
+      Object.values(ENTITY_CATEGORY_MAP).forEach((category) => {
+        expect(Object.values(ENTITY_TYPES)).toContain(category.entityType)
+      })
+    })
+
+    it('should have all vatStatus values be valid VAT_STATUSES', () => {
+      Object.values(ENTITY_CATEGORY_MAP).forEach((category) => {
+        expect(Object.values(VAT_STATUSES)).toContain(category.vatStatus)
+      })
+    })
+
+    it('should be immutable', () => {
+      expect(() => {
+        // @ts-expect-error - we want to test the immutability
+        ENTITY_CATEGORY_MAP.NEW_CATEGORY = {
+          entityType: 'other',
+          vatStatus: 'exempt',
+        }
+      }).toThrow()
+    })
+  })
+})

package/tests/invoices/{document-types.js/document-types.test.js → document-types.test.js}

@@ -1,9 +1,9 @@
 import { describe, it, expect } from 'vitest'
 import {
+  DOCUMENT_TYPES,
   LEGAL_DOCUMENT_TYPES,
   OPERATIONAL_DOCUMENT_TYPES,
-  DOCUMENT_TYPES,
-} from '../../../src/invoices/document-types/document-types.js'
+} from '../../src/invoices/document-types/document-types.js'
 
 describe('document-types', () => {
   describe('LEGAL_DOCUMENT_TYPES', () => {
@@ -16,7 +16,6 @@ describe('document-types', () => {
         RECEIPT: 'receipt',
         TAX_INVOICE: 'tax_invoice',
         CREDIT_INVOICE: 'credit_invoice',
-        PAYMENT_REQUEST: 'payment_request',
         TAX_INVOICE_RECEIPT: 'tax_invoice_receipt',
       })
     })
@@ -47,6 +46,7 @@ describe('document-types', () => {
         INVOICE: 'invoice',
         DELIVERY_NOTE: 'delivery_note',
         PURCHASE_ORDER: 'purchase_order',
+        PAYMENT_REQUEST: 'payment_request',
         PROFORMA_INVOICE: 'proforma_invoice',
       })
     })
@@ -76,9 +76,7 @@ describe('document-types', () => {
       expect(DOCUMENT_TYPES.CREDIT_INVOICE).toBe(
         LEGAL_DOCUMENT_TYPES.CREDIT_INVOICE,
       )
-      expect(DOCUMENT_TYPES.PAYMENT_REQUEST).toBe(
-        LEGAL_DOCUMENT_TYPES.PAYMENT_REQUEST,
-      )
+
       expect(DOCUMENT_TYPES.TAX_INVOICE_RECEIPT).toBe(
         LEGAL_DOCUMENT_TYPES.TAX_INVOICE_RECEIPT,
       )
@@ -97,6 +95,9 @@ describe('document-types', () => {
       expect(DOCUMENT_TYPES.PROFORMA_INVOICE).toBe(
         OPERATIONAL_DOCUMENT_TYPES.PROFORMA_INVOICE,
       )
+      expect(DOCUMENT_TYPES.PAYMENT_REQUEST).toBe(
+        OPERATIONAL_DOCUMENT_TYPES.PAYMENT_REQUEST,
+      )
     })
 
     it('should contain all document types from both legal and operational', () => {
@@ -110,11 +111,13 @@ describe('document-types', () => {
 
       allLegalKeys.forEach((key) => {
         expect(DOCUMENT_TYPES).toHaveProperty(key)
+        // @ts-ignore
         expect(DOCUMENT_TYPES[key]).toBe(LEGAL_DOCUMENT_TYPES[key])
       })
 
       allOperationalKeys.forEach((key) => {
         expect(DOCUMENT_TYPES).toHaveProperty(key)
+        // @ts-ignore
         expect(DOCUMENT_TYPES[key]).toBe(OPERATIONAL_DOCUMENT_TYPES[key])
       })
     })

package/tests/invoices/node_modules/.vite/vitest/da39a3ee5e6b4b0d3255bfef95601890afd80709/results.json

@@ -0,0 +1 @@
+{"version":"4.0.17","results":[[":document-types.test.js",{"duration":5.019667000000027,"failed":false}]]}

package/types/counterparties/types/entity-category-map-types.d.ts

@@ -0,0 +1,58 @@
+/**
+ * Entity type enum values.
+ * These are the internal entity type identifiers used throughout the system.
+ */
+export type ENTITY_CATEGORY_MAP = object
+/**
+ * Entity category map.
+ * Maps entity categories to their corresponding entity type and VAT status.
+ *
+ * @readonly
+ */
+/**
+ * Entity type enum values.
+ * These are the internal entity type identifiers used throughout the system.
+ *
+ * @readonly
+ * @enum {object}
+ */
+/**
+ * Entity category map constants.
+ * Maps entity categories to their corresponding entity type and VAT status.
+ *
+ * @module entity-category-map-types.constants
+ */
+export const ENTITY_CATEGORY_MAP: Readonly<{
+  INDIVIDUAL: {
+    entityType: string
+    vatStatus: string
+  }
+  SOLE_EXEMPT: {
+    entityType: string
+    vatStatus: string
+  }
+  SOLE_REGISTERED: {
+    entityType: string
+    vatStatus: string
+  }
+  COMPANY: {
+    entityType: string
+    vatStatus: string
+  }
+  NON_PROFIT_EXEMPT: {
+    entityType: string
+    vatStatus: string
+  }
+  NON_PROFIT_REG: {
+    entityType: string
+    vatStatus: string
+  }
+  FOREIGN: {
+    entityType: string
+    vatStatus: string
+  }
+  GOVERNMENT: {
+    entityType: string
+    vatStatus: string
+  }
+}>

package/types/counterparties/types/entity-types.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Entity type enum values.
+ * These are the internal entity type identifiers used throughout the system.
+ */
+export type ENTITY_TYPES = string
+/**
+ * Entity type constants.
+ * Defines all valid entity types in the system.
+ *
+ * @module entity-types.constants
+ */
+/**
+ * Entity type enum values.
+ * These are the internal entity type identifiers used throughout the system.
+ *
+ * @readonly
+ * @enum {string}
+ */
+export const ENTITY_TYPES: Readonly<{
+  OTHER: 'other'
+  COMPANY: 'company'
+  INDIVIDUAL: 'individual'
+  NON_PROFIT: 'non_profit'
+  GOVERNMENT: 'government'
+  PARTNERSHIP: 'partnership'
+  SOLE_PROPRIETOR: 'sole_proprietor'
+  FOREIGN_ENTITY: 'foreign_entity'
+}>

package/types/counterparties/types/index.d.ts

@@ -0,0 +1,4 @@
+import { ENTITY_TYPES } from './entity-types.js'
+import { VAT_STATUSES } from './vat-statuses-types.js'
+import { ENTITY_CATEGORY_MAP } from './entity-category-map-types.js'
+export { ENTITY_TYPES, VAT_STATUSES, ENTITY_CATEGORY_MAP }

package/types/counterparties/types/vat-statuses-types.d.ts

@@ -0,0 +1,18 @@
+/**
+ * VAT status types for counterparties.
+ * These represent VAT status only (סטטוס מע״מ בלבד).
+ */
+export type VAT_STATUSES = string
+/**
+ * VAT status types for counterparties.
+ * These represent VAT status only (סטטוס מע״מ בלבד).
+ *
+ * @readonly
+ * @enum {string}
+ */
+export const VAT_STATUSES: Readonly<{
+  EXEMPT: 'exempt'
+  FOREIGN: 'foreign'
+  REGISTERED: 'registered'
+  NOT_APPLICABLE: 'not_applicable'
+}>

package/types/invoices/document-types/document-types.d.ts

@@ -0,0 +1,70 @@
+/**
+ * Document type enum values.
+ * These are the internal document type identifiers used throughout the system.
+ */
+export type LEGAL_DOCUMENT_TYPES = string
+/**
+ * Document type constants.
+ * Defines all valid document types in the system.
+ *
+ * @module document-types.constants
+ */
+/**
+ * Document type enum values.
+ * These are the internal document type identifiers used throughout the system.
+ *
+ * @readonly
+ * @enum {string}
+ */
+export const LEGAL_DOCUMENT_TYPES: Readonly<{
+  RECEIPT: 'receipt'
+  TAX_INVOICE: 'tax_invoice'
+  CREDIT_INVOICE: 'credit_invoice'
+  TAX_INVOICE_RECEIPT: 'tax_invoice_receipt'
+}>
+/**
+ * Document type enum values.
+ * These are the internal document type identifiers used throughout the system.
+ */
+export type OPERATIONAL_DOCUMENT_TYPES = string
+/**
+ * Document type enum values.
+ * These are the internal document type identifiers used throughout the system.
+ *
+ * @readonly
+ * @enum {string}
+ */
+export const OPERATIONAL_DOCUMENT_TYPES: Readonly<{
+  ORDER: 'order'
+  QUOTE: 'quote'
+  INVOICE: 'invoice'
+  DELIVERY_NOTE: 'delivery_note'
+  PURCHASE_ORDER: 'purchase_order'
+  PAYMENT_REQUEST: 'payment_request'
+  PROFORMA_INVOICE: 'proforma_invoice'
+}>
+/**
+ * Document type enum values.
+ * These are the internal document type identifiers used throughout the system.
+ */
+export type DOCUMENT_TYPES = string
+/**
+ * Document type enum values.
+ * These are the internal document type identifiers used throughout the system.
+ *
+ * @readonly
+ * @enum {string}
+ */
+export const DOCUMENT_TYPES: Readonly<{
+  ORDER: 'order'
+  QUOTE: 'quote'
+  INVOICE: 'invoice'
+  DELIVERY_NOTE: 'delivery_note'
+  PURCHASE_ORDER: 'purchase_order'
+  PAYMENT_REQUEST: 'payment_request'
+  PROFORMA_INVOICE: 'proforma_invoice'
+  RECEIPT: 'receipt'
+  TAX_INVOICE: 'tax_invoice'
+  CREDIT_INVOICE: 'credit_invoice'
+  TAX_INVOICE_RECEIPT: 'tax_invoice_receipt'
+}>

package/types/invoices/document-types/index.d.ts

@@ -0,0 +1,8 @@
+export namespace DocumentTypes {
+  export { DOCUMENT_TYPES as ALL }
+  export { LEGAL_DOCUMENT_TYPES as LEGAL }
+  export { OPERATIONAL_DOCUMENT_TYPES as OPERATIONAL }
+}
+import { DOCUMENT_TYPES } from './document-types.js'
+import { LEGAL_DOCUMENT_TYPES } from './document-types.js'
+import { OPERATIONAL_DOCUMENT_TYPES } from './document-types.js'