taxdrop-core 1.0.0 → 1.0.2

package/.vscode/launch.json

@@ -0,0 +1,34 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Debug Vitest",
+      "autoAttachChildProcesses": true,
+      "program": "${workspaceFolder}/node_modules/vitest/vitest.mjs",
+      "args": ["run"],
+      "smartStep": true,
+      "skipFiles": ["<node_internals>/**"],
+      "console": "integratedTerminal"
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Debug Vitest Current File",
+      "autoAttachChildProcesses": true,
+      "program": "${workspaceFolder}/node_modules/vitest/vitest.mjs",
+      "args": [
+        "run",
+        "${relativeFile}" // ← no `--test`
+      ],
+      "smartStep": true,
+      "skipFiles": ["<node_internals>/**"],
+      "console": "integratedTerminal"
+    }
+  ]
+}

package/.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "explorer.sortOrder": "filesFirst",
+  "explorer.openEditors.visible": 0,
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.formatOnSave": true,
+  "[javascript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true
+  },
+  "launch": {
+    "configurations": [],
+    "compounds": []
+  },
+  "javascript.preferences.importModuleSpecifierEnding": "js",
+  "js/ts.implicitProjectConfig.checkJs": true,
+  "javascript.validate.enable": true,
+  "javascript.format.enable": false,
+  "typescript.format.enable": false,
+  "eslint.enable": true,
+  "eslint.validate": ["javascript"],
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit"
+  },
+  "prettier.requireConfig": true,
+  "eslint.format.enable": false
+}

package/README.md

@@ -1 +1 @@
-# taxdrop-core
+# taxdrop-core

package/eslint.config.js

@@ -0,0 +1,43 @@
+import js from '@eslint/js'
+import eslintPluginPrettier from 'eslint-plugin-prettier'
+import eslintConfigPrettier from 'eslint-config-prettier'
+
+/** @type {import("eslint").Linter.FlatConfig[]} */
+export default [
+  js.configs.recommended,
+  eslintConfigPrettier,
+  {
+    files: ['**/*.js'],
+    languageOptions: {
+      sourceType: 'module',
+      ecmaVersion: 'latest',
+      globals: {
+        console: 'readonly',
+        process: 'readonly',
+        Buffer: 'readonly',
+        __dirname: 'readonly',
+        __filename: 'readonly',
+      },
+    },
+    plugins: {
+      prettier: eslintPluginPrettier,
+    },
+    rules: {
+      'no-console': 'off',
+      'no-unused-vars': ['warn', { argsIgnorePattern: '^_' }],
+      curly: ['error', 'all'],
+      'prettier/prettier': [
+        'error',
+        {
+          semi: false,
+          singleQuote: true,
+          trailingComma: 'all',
+        },
+      ],
+      semi: ['error', 'never'],
+    },
+  },
+  {
+    ignores: ['node_modules/**', 'dist/**', 'build/**', 'coverage/**'],
+  },
+]

package/index.js

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

package/package.json

@@ -1,11 +1,18 @@
 {
   "name": "taxdrop-core",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "",
   "main": "index.js",
-  "type":"module",
+  "type": "module",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "format": "prettier --write .",
+    "test": "vitest run --coverage",
+    "check-format": "prettier --check .",
+    "bump": "node ./scripts/bump-version.js",
+    "check": "npm run lint && npm run check-format && npm run test",
+    "build:types": "tsc --project tsconfig.json && prettier --write ."
   },
   "repository": {
     "type": "git",
@@ -13,12 +20,24 @@
   },
   "keywords": [],
   "author": "",
-  "license": "ISC",  
+  "license": "ISC",
   "bugs": {
     "url": "https://github.com/fchange-ltd/taxdrop-core/issues"
   },
   "homepage": "https://github.com/fchange-ltd/taxdrop-core#readme",
-   "exports": {
+  "exports": {
     ".": "./src/index.js"
+  },
+  "dependencies": {
+    "eslint": "^9.39.2",
+    "prettier": "^3.8.1",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.17"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.39.2",
+    "@vitest/coverage-v8": "^4.0.17",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.5"
   }
 }

package/prettier.config.js

@@ -0,0 +1,5 @@
+export default {
+  semi: false,
+  singleQuote: true,
+  trailingComma: 'all',
+}

package/scripts/bump-version.js

@@ -0,0 +1,68 @@
+import fs from 'fs'
+import path from 'path'
+import { execSync } from 'child_process'
+
+const type = process.argv[2] // "major" | "minor" | "patch" | "-major" | "-minor" | "-patch"
+
+if (!['major', 'minor', 'patch', '-major', '-minor', '-patch'].includes(type)) {
+  console.error(`Usage: npm run bump <major|minor|patch|-major|-minor|-patch>`)
+  process.exit(1)
+}
+
+const pkgPath = path.resolve(process.cwd(), 'package.json')
+const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'))
+
+let [major, minor, patch] = pkg.version.split('.').map(Number)
+
+const bump = () => {
+  switch (type) {
+    case 'major':
+      return [major + 1, 0, 0]
+    case 'minor':
+      return [major, minor + 1, 0]
+    case 'patch':
+      return [major, minor, patch + 1]
+    case '-major':
+      if (major === 0) {
+        throw new Error('Cannot decrement major below 0')
+      }
+      return [major - 1, 0, 0]
+    case '-minor':
+      if (minor === 0) {
+        if (major === 0) {
+          throw new Error('Cannot decrement minor below 0.0')
+        }
+        return [major - 1, 0, 0]
+      }
+      return [major, minor - 1, 0]
+    case '-patch':
+      if (patch === 0) {
+        if (minor === 0) {
+          if (major === 0) {
+            throw new Error('Cannot decrement below 0.0.0')
+          }
+          return [major - 1, 0, 0]
+        }
+        return [major, minor - 1, 0]
+      }
+      return [major, minor, patch - 1]
+  }
+}
+
+const [newMajor, newMinor, newPatch] = bump()
+const newVersion = `${newMajor}.${newMinor}.${newPatch}`
+
+pkg.version = newVersion
+fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + '\n')
+
+console.log(`✔ Updated version to ${newVersion}`)
+
+// update package-lock.json if exists
+if (fs.existsSync('./package-lock.json')) {
+  try {
+    execSync('npm install --package-lock-only', { stdio: 'inherit' })
+    console.log('✔ package-lock.json updated')
+  } catch (err) {
+    console.error('Failed to update package-lock.json', err)
+  }
+}

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

@@ -0,0 +1,51 @@
+/**
+ * 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 = 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.
+ *
+ * @readonly
+ * @enum {string}
+ */
+
+export const OPERATIONAL_DOCUMENT_TYPES = Object.freeze({
+  ORDER: 'order',
+  QUOTE: 'quote',
+  INVOICE: 'invoice',
+  DELIVERY_NOTE: 'delivery_note',
+  PURCHASE_ORDER: 'purchase_order',
+  PROFORMA_INVOICE: 'proforma_invoice',
+})
+
+/**
+ * Document type enum values.
+ * These are the internal document type identifiers used throughout the system.
+ *
+ * @readonly
+ * @enum {string}
+ */
+
+export const DOCUMENT_TYPES = Object.freeze({
+  ...LEGAL_DOCUMENT_TYPES,
+  ...OPERATIONAL_DOCUMENT_TYPES,
+})

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

@@ -0,0 +1,11 @@
+import {
+  DOCUMENT_TYPES,
+  LEGAL_DOCUMENT_TYPES,
+  OPERATIONAL_DOCUMENT_TYPES,
+} from './document-types.js'
+
+export const DocumentTypes = {
+  ALL: DOCUMENT_TYPES,
+  LEGAL: LEGAL_DOCUMENT_TYPES,
+  OPERATIONAL: OPERATIONAL_DOCUMENT_TYPES,
+}

package/tests/invoices/document-types.js/document-types.test.js

@@ -0,0 +1,135 @@
+import { describe, it, expect } from 'vitest'
+import {
+  LEGAL_DOCUMENT_TYPES,
+  OPERATIONAL_DOCUMENT_TYPES,
+  DOCUMENT_TYPES,
+} from '../../../src/invoices/document-types/document-types.js'
+
+describe('document-types', () => {
+  describe('LEGAL_DOCUMENT_TYPES', () => {
+    it('should be a frozen object', () => {
+      expect(Object.isFrozen(LEGAL_DOCUMENT_TYPES)).toBe(true)
+    })
+
+    it('should contain all expected legal document types', () => {
+      expect(LEGAL_DOCUMENT_TYPES).toEqual({
+        RECEIPT: 'receipt',
+        TAX_INVOICE: 'tax_invoice',
+        CREDIT_INVOICE: 'credit_invoice',
+        PAYMENT_REQUEST: 'payment_request',
+        TAX_INVOICE_RECEIPT: 'tax_invoice_receipt',
+      })
+    })
+
+    it('should have all values as strings', () => {
+      Object.values(LEGAL_DOCUMENT_TYPES).forEach((value) => {
+        expect(typeof value).toBe('string')
+      })
+    })
+
+    it('should be immutable', () => {
+      expect(() => {
+        // @ts-expect-error - we want to test the immutability
+        LEGAL_DOCUMENT_TYPES.NEW_TYPE = 'new_type'
+      }).toThrow()
+    })
+  })
+
+  describe('OPERATIONAL_DOCUMENT_TYPES', () => {
+    it('should be a frozen object', () => {
+      expect(Object.isFrozen(OPERATIONAL_DOCUMENT_TYPES)).toBe(true)
+    })
+
+    it('should contain all expected operational document types', () => {
+      expect(OPERATIONAL_DOCUMENT_TYPES).toEqual({
+        ORDER: 'order',
+        QUOTE: 'quote',
+        INVOICE: 'invoice',
+        DELIVERY_NOTE: 'delivery_note',
+        PURCHASE_ORDER: 'purchase_order',
+        PROFORMA_INVOICE: 'proforma_invoice',
+      })
+    })
+
+    it('should have all values as strings', () => {
+      Object.values(OPERATIONAL_DOCUMENT_TYPES).forEach((value) => {
+        expect(typeof value).toBe('string')
+      })
+    })
+
+    it('should be immutable', () => {
+      expect(() => {
+        // @ts-expect-error - we want to test the immutability
+        OPERATIONAL_DOCUMENT_TYPES.NEW_TYPE = 'new_type'
+      }).toThrow()
+    })
+  })
+
+  describe('DOCUMENT_TYPES', () => {
+    it('should be a frozen object', () => {
+      expect(Object.isFrozen(DOCUMENT_TYPES)).toBe(true)
+    })
+
+    it('should contain all legal document types', () => {
+      expect(DOCUMENT_TYPES.RECEIPT).toBe(LEGAL_DOCUMENT_TYPES.RECEIPT)
+      expect(DOCUMENT_TYPES.TAX_INVOICE).toBe(LEGAL_DOCUMENT_TYPES.TAX_INVOICE)
+      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,
+      )
+    })
+
+    it('should contain all operational document types', () => {
+      expect(DOCUMENT_TYPES.ORDER).toBe(OPERATIONAL_DOCUMENT_TYPES.ORDER)
+      expect(DOCUMENT_TYPES.QUOTE).toBe(OPERATIONAL_DOCUMENT_TYPES.QUOTE)
+      expect(DOCUMENT_TYPES.INVOICE).toBe(OPERATIONAL_DOCUMENT_TYPES.INVOICE)
+      expect(DOCUMENT_TYPES.DELIVERY_NOTE).toBe(
+        OPERATIONAL_DOCUMENT_TYPES.DELIVERY_NOTE,
+      )
+      expect(DOCUMENT_TYPES.PURCHASE_ORDER).toBe(
+        OPERATIONAL_DOCUMENT_TYPES.PURCHASE_ORDER,
+      )
+      expect(DOCUMENT_TYPES.PROFORMA_INVOICE).toBe(
+        OPERATIONAL_DOCUMENT_TYPES.PROFORMA_INVOICE,
+      )
+    })
+
+    it('should contain all document types from both legal and operational', () => {
+      const allLegalKeys = Object.keys(LEGAL_DOCUMENT_TYPES)
+      const allOperationalKeys = Object.keys(OPERATIONAL_DOCUMENT_TYPES)
+      const allDocumentKeys = Object.keys(DOCUMENT_TYPES)
+
+      expect(allDocumentKeys.length).toBe(
+        allLegalKeys.length + allOperationalKeys.length,
+      )
+
+      allLegalKeys.forEach((key) => {
+        expect(DOCUMENT_TYPES).toHaveProperty(key)
+        expect(DOCUMENT_TYPES[key]).toBe(LEGAL_DOCUMENT_TYPES[key])
+      })
+
+      allOperationalKeys.forEach((key) => {
+        expect(DOCUMENT_TYPES).toHaveProperty(key)
+        expect(DOCUMENT_TYPES[key]).toBe(OPERATIONAL_DOCUMENT_TYPES[key])
+      })
+    })
+
+    it('should have all values as strings', () => {
+      Object.values(DOCUMENT_TYPES).forEach((value) => {
+        expect(typeof value).toBe('string')
+      })
+    })
+
+    it('should be immutable', () => {
+      expect(() => {
+        // @ts-expect-error - we want to test the immutability
+        DOCUMENT_TYPES.NEW_TYPE = 'new_type'
+      }).toThrow()
+    })
+  })
+})

package/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "declaration": true,
+    "allowJs": true,
+    "emitDeclarationOnly": true,
+    "outDir": "types",
+    "esModuleInterop": true,
+    "skipLibCheck": true
+  },
+  "include": ["src"]
+}

package/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'
+  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.
+ */
+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'
+  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'
+  PROFORMA_INVOICE: 'proforma_invoice'
+  RECEIPT: 'receipt'
+  TAX_INVOICE: 'tax_invoice'
+  CREDIT_INVOICE: 'credit_invoice'
+  PAYMENT_REQUEST: 'payment_request'
+  TAX_INVOICE_RECEIPT: 'tax_invoice_receipt'
+}>

package/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'