@tomei/finance 0.17.0 → 0.18.1-dev.1

package/.commitlintrc.json

@@ -1,23 +1,23 @@
-{
-  "extends": [
-    "@commitlint/config-conventional"
-  ],
-  "rules": {
-    "header-max-length": [ 2, "always", 120 ],
-    "type-enum": [
-      2,
-      "always",
-      [
-        "breaking",
-        "feat",
-        "fix",
-        "refactor",
-        "config",
-        "test",
-        "docs",
-        "chore",
-        "release"
-      ]
-    ]
-  }
-}
+{
+  "extends": [
+    "@commitlint/config-conventional"
+  ],
+  "rules": {
+    "header-max-length": [ 2, "always", 120 ],
+    "type-enum": [
+      2,
+      "always",
+      [
+        "breaking",
+        "feat",
+        "fix",
+        "refactor",
+        "config",
+        "test",
+        "docs",
+        "chore",
+        "release"
+      ]
+    ]
+  }
+}

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+## [0.16.0] - 2026-02-XX
+
+### Added
+- Optional asynchronous invoice posting mode (`ASYNC_OUTBOX`)
+- Invoice lifecycle states to track accounting system synchronization
+- Support for deferred posting to external accounting systems
+
+### Changed
+- `issueInvoice()` now supports an opt-in asynchronous posting mode
+- Accounting system integration can be executed outside database transactions
+
+### Backward Compatibility
+- Default behavior remains synchronous (`SYNC_LEGACY`)
+- Existing consumers are not affected unless explicitly opted in
+
+### Notes
+- Synchronous posting mode will be deprecated in a future `1.0.0` release

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2019 John Biundo
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2019 John Biundo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/MIGRATION.md

@@ -0,0 +1,43 @@
+# Migration Guide
+
+This document describes breaking or opt-in changes introduced in each version
+and how to migrate existing consumers.
+
+---
+
+## Migration to 0.16.0 — Async Invoice Posting
+
+### Summary
+Invoices can now be issued without synchronously posting to external accounting
+systems.
+
+## Who should migrate
+Projects that integrate with external accounting systems and require improved
+transaction safety and retry capability.
+
+## How to opt in
+
+```ts
+await financeCompany.issueInvoice(
+  tx,
+  invoice,
+  loginUser,
+  customer,
+  undefined,
+  tags,
+  discount,
+  {
+    postingMode: 'ASYNC_OUTBOX',
+  }
+);
+
+## Required Setup
+- Background worker to process outbox events
+- Accounting integration worker enabled
+
+## Invoice Status Flow
+ISSUED -> POSTING -> POSTED/POST_FAILED
+
+## Rollback Behaviour
+- Local database failures rollback safely
+- Accounting system failures do not corrupt local state