@ferricstore/ferricstore 0.1.2 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (52) hide show
  1. package/README.md +13 -1
  2. package/dist/index.cjs +5348 -0
  3. package/dist/index.cjs.map +1 -0
  4. package/dist/index.d.cts +1322 -0
  5. package/dist/index.d.ts +34 -4
  6. package/dist/index.js +130 -3
  7. package/dist/index.js.map +1 -1
  8. package/docs/api/assets/hierarchy.js +1 -1
  9. package/docs/api/assets/highlight.css +10 -10
  10. package/docs/api/assets/navigation.js +1 -1
  11. package/docs/api/assets/search.js +1 -1
  12. package/docs/api/classes/FerricStoreClient.html +2 -2
  13. package/docs/api/classes/FerricStoreError.html +6 -6
  14. package/docs/api/classes/FlowAlreadyExistsError.html +6 -6
  15. package/docs/api/classes/FlowNotFoundError.html +6 -6
  16. package/docs/api/classes/FlowWrongStateError.html +6 -6
  17. package/docs/api/classes/InvalidCommandError.html +6 -6
  18. package/docs/api/classes/LockHeldError.html +6 -6
  19. package/docs/api/classes/LockNotOwnedError.html +6 -6
  20. package/docs/api/classes/NativeAdapter.html +2 -2
  21. package/docs/api/classes/OverloadedError.html +6 -6
  22. package/docs/api/classes/ReconnectingExecutor.html +5 -0
  23. package/docs/api/classes/StaleLeaseError.html +6 -6
  24. package/docs/api/functions/isReconnectableClosedConnectionError.html +1 -0
  25. package/docs/api/hierarchy.html +1 -1
  26. package/docs/api/index.html +18 -10
  27. package/docs/api/interfaces/AutoBatchOptions.html +2 -2
  28. package/docs/api/interfaces/CancelOptions.html +2 -2
  29. package/docs/api/interfaces/ClaimDueOptions.html +2 -2
  30. package/docs/api/interfaces/CommandExecutor.html +1 -1
  31. package/docs/api/interfaces/CompleteOptions.html +2 -2
  32. package/docs/api/interfaces/CompleteOutcome.html +1 -1
  33. package/docs/api/interfaces/CreateManyOptions.html +2 -2
  34. package/docs/api/interfaces/CreateOptions.html +2 -2
  35. package/docs/api/interfaces/FailOptions.html +2 -2
  36. package/docs/api/interfaces/FailOutcome.html +1 -1
  37. package/docs/api/interfaces/FerricStoreClientFromUrlOptions.html +6 -0
  38. package/docs/api/interfaces/FerricStoreClientOptions.html +2 -2
  39. package/docs/api/interfaces/MutateOptions.html +2 -2
  40. package/docs/api/interfaces/NamedValueMutation.html +1 -1
  41. package/docs/api/interfaces/NativeAdapterOptions.html +6 -2
  42. package/docs/api/interfaces/ReadOptions.html +2 -2
  43. package/docs/api/interfaces/ReclaimOptions.html +2 -2
  44. package/docs/api/interfaces/ReconnectOptions.html +2 -0
  45. package/docs/api/interfaces/RetryOptions.html +2 -2
  46. package/docs/api/interfaces/RetryOutcome.html +1 -1
  47. package/docs/api/interfaces/TDigestCreateOptions.html +1 -1
  48. package/docs/api/interfaces/TDigestMergeOptions.html +1 -1
  49. package/docs/api/interfaces/TransitionOptions.html +2 -2
  50. package/docs/api/interfaces/TransitionOutcome.html +1 -1
  51. package/docs/api/modules.html +1 -1
  52. package/package.json +17 -7
package/README.md CHANGED
@@ -14,7 +14,19 @@ FLOW.CREATE -> FLOW.CLAIM_DUE -> handler -> FLOW.TRANSITION / COMPLETE / FAIL /
14
14
  npm install @ferricstore/ferricstore
15
15
  ```
16
16
 
17
- Requires Node.js 24 or newer. The SDK is ESM-only and tested with Node 24 and 26.
17
+ Requires Node.js 22.22 or newer. The SDK ships ESM and CommonJS builds and is tested with Node 22, 24, and 26.
18
+
19
+ ESM:
20
+
21
+ ```ts
22
+ import { FerricStoreClient, JsonCodec } from "@ferricstore/ferricstore";
23
+ ```
24
+
25
+ CommonJS:
26
+
27
+ ```js
28
+ const { FerricStoreClient, JsonCodec } = require("@ferricstore/ferricstore");
29
+ ```
18
30
 
19
31
  ## Run FerricStore Locally
20
32