accounting-engine 0.1.0

package/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

package/.eslintignore

@@ -0,0 +1,2 @@
+node_modules
+bin

package/.eslintrc.json

@@ -0,0 +1,20 @@
+{
+  "env": {
+    "node": true,
+    "jest": true
+  },
+  "extends": ["airbnb-base", "plugin:jest/recommended", "plugin:security/recommended", "plugin:prettier/recommended"],
+  "plugins": ["jest", "security", "prettier"],
+  "parserOptions": {
+    "ecmaVersion": 2020
+  },
+  "rules": {
+    "no-console": "off",
+    "func-names": "off",
+    "no-underscore-dangle": "off",
+    "no-unused-private-class-members": "off",
+    "consistent-return": "off",
+    "jest/expect-expect": "off",
+    "security/detect-object-injection": "off"
+  }
+}

package/.gitattributes

@@ -0,0 +1,3 @@
+# Convert text file line endings to lf
+* text eol=lf
+*.js text

package/.lintstagedrc.json

@@ -0,0 +1,3 @@
+{
+  "*.js": "eslint"
+}

package/.prettierignore

@@ -0,0 +1,3 @@
+node_modules
+coverage
+

package/.prettierrc.json

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "printWidth": 125
+}

package/README.md

@@ -0,0 +1,171 @@
+# accounting-engine
+
+Bu paket, verilen faturanın, belirtilen kurallar çerçevesinde muhasebeleştirilmesini kolaylaştırmak adına oluşturulmuştur.
+
+## Kurulum
+
+Paketi projenize eklemek için aşağıdaki komutu kullanabilirsiniz:
+
+```bash
+npm install accounting-engine
+```
+
+## Kullanım
+
+```javascript
+const fs = require('fs');
+const engine = require('accounting-engine');
+
+// Fatura XML belgesinin içeriğini oku
+const xmlData = fs.readFileSync('path/to/your/xml/invoice.xml', 'utf-8');
+const config = fs.readFileSync('path/to/your/rules/rules.json', 'utf-8');
+
+// Fatura XML belgesini düzenlenmiş ve küçültülmüş JSON objesine çevirmek için
+const accountedInvoice = await engine.normalizeXML(config, data, 'out');
+
+console.log(accountedInvoice);
+```
+
+### Örnek Kural Dosyası
+
+```json
+{
+  "variables": {
+    "kdv_20_tax": "%20.tax",
+    "kdv_20_taxable": "%20.taxable",
+    "kdv_10_tax": "%10.tax",
+    "kdv_10_taxable": "%10.taxable"
+  },
+  "rules": [
+    {
+      "condition": "invoice.direction === 'out'",
+      "rules": [
+        {
+          "condition": "line.type === 'payable'",
+          "return": [
+            {
+              "borc": "line.amount",
+              "alacak": 0,
+              "hesap_kodu": "{{musteri}}"
+            }
+          ]
+        },
+        {
+          "condition": "line.code === '0015'",
+          "rules": [
+            {
+              "condition": "line.percent === 20",
+              "rules": [
+                {
+                  "condition": "line.type === 'tax'",
+                  "return": [
+                    {
+                      "alacak": "line.amount",
+                      "borc": 0,
+                      "hesap_kodu": "{{kdv_20_tax}}"
+                    }
+                  ]
+                },
+                {
+                  "condition": "line.type === 'taxable'",
+                  "return": [
+                    {
+                      "alacak": "line.amount",
+                      "borc": 0,
+                      "hesap_kodu": "{{kdv_20_taxable}}"
+                    }
+                  ]
+                }
+              ]
+            },
+            {
+              "condition": "line.percent === 10",
+              "rules": [
+                {
+                  "condition": "line.type === 'tax'",
+                  "return": [
+                    {
+                      "alacak": "line.amount",
+                      "borc": 0,
+                      "hesap_kodu": "{{kdv_10_tax}}"
+                    }
+                  ]
+                },
+                {
+                  "condition": "line.type === 'taxable'",
+                  "return": [
+                    {
+                      "alacak": "line.amount",
+                      "borc": 0,
+                      "hesap_kodu": "{{kdv_10_taxable}}"
+                    }
+                  ]
+                }
+              ]
+            },
+            {
+              "condition": "line.percent === 1",
+              "rules": [
+                {
+                  "condition": "line.type === 'tax'",
+                  "return": [
+                    {
+                      "alacak": "line.amount",
+                      "borc": 0,
+                      "hesap_kodu": "{{kdv_1_tax}}"
+                    }
+                  ]
+                },
+                {
+                  "condition": "line.type === 'taxable'",
+                  "return": [
+                    {
+                      "alacak": "line.amount",
+                      "borc": 0,
+                      "hesap_kodu": "{{kdv_1_taxable}}"
+                    }
+                  ]
+                }
+              ]
+            },
+            {
+              "condition": "line.percent === 0",
+              "return": [
+                {
+                  "alacak": "line.amount",
+                  "borc": 0,
+                  "hesap_kodu": "{{kdv_0_taxable}}"
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "condition": "line.code === '0003' && line.type === 'tax'",
+          "return": [
+            {
+              "borc": "line.amount",
+              "alacak": 0,
+              "hesap_kodu": "{{gelir_stopaj}}"
+            }
+          ]
+        },
+        {
+          "condition": "line.code === '0059' && line.type === 'tax'",
+          "return": [
+            {
+              "alacak": "line.amount",
+              "borc": 0,
+              "hesap_kodu": "{{konaklama}}"
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}
+```
+
+## Lisans
+
+Bu paket [MIT lisansı](LICENSE) ile lisanslanmıştır. Detaylı bilgi için lisans dosyasını kontrol edebilirsiniz.

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "accounting-engine",
+  "version": "0.1.0",
+  "description": "",
+  "main": "src/index.js",
+  "scripts": {
+    "test": "jest -i --colors --verbose --detectOpenHandles",
+    "test:watch": "jest -i --watchAll",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "prettier": "prettier --check **/*.js",
+    "prettier:fix": "prettier --write **/*.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Rahat-Fatura/accounting-engine.git"
+  },
+  "author": "Berkay Gökçe <berkaygkc7@gmail.com>",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/Rahat-Fatura/accounting-engine/issues"
+  },
+  "homepage": "https://github.com/Rahat-Fatura/accounting-engine#readme",
+  "devDependencies": {
+    "eslint": "^8.55.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-import": "^2.29.0",
+    "eslint-plugin-jest": "^27.6.0",
+    "eslint-plugin-prettier": "^5.0.1",
+    "eslint-plugin-security": "^1.7.1",
+    "faker": "^5.1.0",
+    "jest": "^29.7.0",
+    "lint-staged": "^15.2.0",
+    "prettier": "^3.1.0",
+    "supertest": "^6.3.3"
+  },
+  "dependencies": {
+    "date-and-time": "^3.1.1",
+    "lodash": "^4.17.21",
+    "moment": "^2.30.1",
+    "ubl2json": "^2.0.2"
+  }
+}

package/src/index.js

@@ -0,0 +1,2 @@
+module.exports.normalizeXML = require('./services/engine.service').normalizeXML;
+module.exports.normalizeJSON = require('./services/engine.service').normalizeJSON;

package/src/services/engine.service.js

@@ -0,0 +1,214 @@
+/* eslint-disable security/detect-non-literal-regexp */
+/* eslint-disable no-eval */
+/* eslint-disable security/detect-eval-with-expression */
+/* eslint-disable no-restricted-syntax */
+const _ = require('lodash');
+const moment = require('moment');
+const ubl2json = require('ubl2json');
+
+const updateDataWithVariables = async (variables, data) => {
+  let updatedData = JSON.stringify(data);
+  const keys = Object.keys(variables);
+  for await (const key of keys) {
+    const value = variables[key];
+    updatedData = updatedData.replaceAll(new RegExp(`{{${key}}}`, 'g'), value);
+  }
+  return JSON.parse(updatedData);
+};
+
+const applyRules = async (rules, data, upperCondition = null) => {
+  const resultLines = [];
+  let conditions;
+  if (upperCondition) {
+    if (Array.isArray(upperCondition)) {
+      conditions = [rules.condition, ...upperCondition];
+    } else {
+      conditions = [rules.condition, upperCondition];
+    }
+  } else {
+    conditions = [rules.condition];
+  }
+  if (Object.keys(rules).includes('rules')) {
+    for await (const rule of rules.rules) {
+      const result = await applyRules(rule, data, conditions);
+      // eslint-disable-next-line no-param-reassign
+      data = result.data;
+      if (result.resultLines.length > 0) {
+        resultLines.push(...result.resultLines);
+      }
+    }
+    return { resultLines, data };
+  }
+  if (Object.keys(rules).includes('return')) {
+    const returnData = rules.return;
+    const evalCondition = conditions.join(' && ');
+    const invoice = data;
+    const willPull = [];
+    for await (const line of invoice.accounting_lines) {
+      if (eval(evalCondition)) {
+        willPull.push(_.findIndex(invoice.accounting_lines, line));
+        returnData.forEach((item) => {
+          resultLines.push({
+            borc: eval(item.borc),
+            alacak: eval(item.alacak),
+            hesap_kodu: item.hesap_kodu,
+          });
+        });
+      }
+    }
+    if (willPull.length > 0) {
+      _.pullAt(invoice.accounting_lines, willPull);
+    }
+    return { resultLines, data: invoice };
+  }
+};
+
+const normalizeInvoiceForAccounting = async (invoice, direction) => {
+  if (['in', 'out'].indexOf(direction) === -1) {
+    throw new Error('Direction must be in or out');
+  }
+  const taxes = [];
+  const taxables = [];
+  const payable = {
+    type: 'payable',
+    amount: invoice.payable_amount,
+  };
+  if (!_.find(invoice.lines, (line) => !line.tax_subtotals || !(line.tax_subtotals.length > 0))) {
+    for await (const line of invoice.lines) {
+      for await (const item of line.tax_subtotals) {
+        if (_.find(taxes, { id: line.id, type: 'tax', code: item.code, percent: item.percent })) {
+          const index = _.findIndex(taxes, { id: line.id, type: 'tax', code: item.code, percent: item.percent });
+          taxes[index].amount += item.amount;
+        } else {
+          taxes.push({
+            id: line.id,
+            name: line.name,
+            quantity: line.quantity,
+            unit: line.quantity_unit,
+            price: line.price,
+            extension_amount: line.extension_amount,
+            additional: line.additional,
+            type: 'tax',
+            code: item.code,
+            percent: item.percent,
+            amount: item.amount,
+          });
+        }
+
+        if (_.find(taxables, { id: line.id, type: 'taxable', code: item.code, percent: item.percent })) {
+          const index = _.findIndex(taxables, { id: line.id, type: 'taxable', code: item.code, percent: item.percent });
+          taxables[index].amount += item.taxable;
+        } else {
+          taxables.push({
+            id: line.id,
+            name: line.name,
+            quantity: line.quantity,
+            unit: line.quantity_unit,
+            price: line.price,
+            extension_amount: line.extension_amount,
+            additional: line.additional,
+            type: 'taxable',
+            code: item.code,
+            percent: item.percent,
+            amount: item.taxable,
+          });
+        }
+      }
+    }
+  } else {
+    for await (const item of invoice.tax_subtotals) {
+      if (_.find(taxes, { type: 'tax', code: item.code, percent: item.percent })) {
+        const index = _.findIndex(taxes, { type: 'tax', code: item.code, percent: item.percent });
+        taxes[index].amount += item.amount;
+      } else {
+        taxes.push({
+          type: 'tax',
+          code: item.code,
+          percent: item.percent,
+          amount: item.amount,
+        });
+      }
+
+      if (_.find(taxables, { type: 'taxable', code: item.code, percent: item.percent })) {
+        const index = _.findIndex(taxables, { type: 'taxable', code: item.code, percent: item.percent });
+        taxables[index].amount += item.taxable;
+      } else {
+        taxables.push({
+          type: 'taxable',
+          code: item.code,
+          percent: item.percent,
+          amount: item.taxable,
+        });
+      }
+    }
+  }
+  const payableCounterLines = [...taxes, ...taxables];
+  const payableLines = [payable];
+  // const payableCounterTotalAmount = payableCounterLines.reduce((acc, item) => acc + item.amount, 0);
+  // if (payableCounterTotalAmount > payable.amount) {
+  //   payableLines.push({
+  //     type: 'payable_extra',
+  //     amount: payableCounterTotalAmount - payable.amount,
+  //   });
+  // } else if (payableCounterTotalAmount < payable.amount) {
+  //   payableCounterLines.push({
+  //     type: 'taxable_extra',
+  //     amount: payable.amount - payableCounterTotalAmount,
+  //   });
+  // }
+  const accountingLines = [...payableLines, ...payableCounterLines];
+  const data = {
+    uuid: invoice.uuid,
+    number: invoice.number,
+    direction,
+    profile_id: invoice.profile_id,
+    type_code: invoice.type_code,
+    date: moment(invoice.issue_datetime).format('YYYY-MM-DD'),
+    notes: invoice.notes,
+    currency_code: invoice.currency_code,
+    sender_object: invoice.sender_object,
+    receiver_object: invoice.receiver_object,
+    accounting_lines: accountingLines,
+  };
+  return data;
+};
+
+const normalizeJSON = async (opts, data, dir) => {
+  const variables = opts.variables || {};
+  const { rules } = opts;
+  const invoice = await normalizeInvoiceForAccounting(data, dir);
+  const results = [];
+  for await (const rule of rules) {
+    const result = await applyRules(rule, invoice);
+    if (result.resultLines.length > 0) {
+      results.push(...result.resultLines);
+    }
+  }
+  const setVariables = await updateDataWithVariables(variables, results);
+  const accountedInvoice = _.reduce(
+    setVariables,
+    (acc, item) => {
+      const index = _.findIndex(acc, (line) => line.hesap_kodu === item.hesap_kodu);
+      if (index !== -1) {
+        acc[index].borc += item.borc;
+        acc[index].alacak += item.alacak;
+      } else {
+        acc.push(item);
+      }
+      return acc;
+    },
+    [],
+  );
+  return accountedInvoice;
+};
+
+const normalizeXML = async (opts, data, dir) => {
+  const json = await ubl2json.invoice.convertedJson(data);
+  const normalized = await normalizeJSON(opts, json, dir);
+  return normalized;
+};
+
+module.exports = {
+  normalizeJSON,
+  normalizeXML,
+};

package/src/services/index.js

@@ -0,0 +1 @@
+module.exports.engineService = require('./engine.service');