@flux-control/effect-modbus-rs 0.8.0 → 0.9.0

package/dist/src/write-debouncer.d.ts

@@ -1,22 +1,6 @@
 /**
- * @fileoverview Coalesces register writes that arrive separately into one batch.
- *
- * `planWrites` packs the writes a caller holds at one moment. A caller that
- * derives each register independently — one fiber per output, each settling at
- * its own pace — never holds two values at the same moment, so a planner alone
- * never sees a run longer than one. Batching those would need a collection point
- * upstream that the caller does not have.
- *
- * This module is that collection point, and it collects on time rather than on
- * structure. A write is held for `window`, each new arrival restarts the window,
- * and `maxHold` caps the total hold so a register that updates without a pause
- * still reaches the wire.
- *
- * Callers still await their own write. Each caller gets its own `Deferred`,
- * completed with the exit of the flush that carried its value, so a write that
- * fails still fails for the caller that issued it. That keeps "the effect
- * succeeded" meaning "the value reached the device", which is the invariant a
- * caller uses to decide whether it may report an actuation.
+ * @fileoverview Coalesces register writes by address and flushes them after a debounce window.
+ * New arrivals restart the window; `maxHold` limits the total delay.
  *
  * @module
  */
@@ -67,8 +51,8 @@ export interface WriteDebouncer {
     /**
      * Holds a write for the window, then issues it with whatever else arrived.
      *
-     * Succeeds when the value reached the device, and fails with the error of the
-     * flush that carried it.
+     * Completes with the flush result for its address. A later write can supersede
+     * its value, and a downstream cache can suppress the physical write.
      */
     write(write: RegisterWrite, attributes?: ModbusSpanAttributes): Effect.Effect<void, ModbusError>;
     /**
@@ -85,8 +69,8 @@ export interface WriteDebouncer {
      *
      * A caller that already holds every value does not need a collection point,
      * but it still must not go around the batch: a write held for one of these
-     * addresses would otherwise reach the device after the newer value. The whole
-     * group succeeds or fails together.
+     * addresses would otherwise reach the device after the newer value. The result
+     * covers the flush, but separate bus transactions are not atomic.
      *
      * With a window of zero the group is issued at once, so a caller of this
      * method gets packed transactions with no debouncer at all.
@@ -104,33 +88,6 @@ export interface WriteDebouncer {
     /** Addresses currently held. Intended for tests. */
     readonly pending: number;
 }
-/**
- * Creates a write debouncer bound to the current scope.
- *
- * The flush runs in that scope, not in the caller's. A caller interrupted while
- * waiting — an output recomputed before its write landed — must not take the
- * pending batch down with it, and a caller must not have to carry a `Scope` to
- * issue a write.
- *
- * When the scope closes, callers still waiting are interrupted and the batch is
- * discarded. Their writes never reached the device, and reporting success for
- * them would break the invariant the `Deferred` exists to hold.
- *
- * @param options - The window, the ceiling, and the callback that issues a batch.
- * @returns The debouncer.
- *
- * @example
- * const debouncer = yield* createWriteDebouncer({
- *   window: '250 millis',
- *   maxHold: '1 second',
- *   flush: (batch) => issue(batch),
- * });
- * // Two callers that never meet, one transaction:
- * yield* Effect.all([
- *   debouncer.write({ address: 2000, value: 10 }),
- *   debouncer.write({ address: 2001, value: 20 }),
- * ], { concurrency: 'unbounded' });
- */
 /**
  * Resolves the window and the hold limit that a write debouncer applies.
  *
@@ -144,4 +101,13 @@ export declare const resolveWriteHold: (window: Duration.Input, maxHold: Duratio
     windowMs: number;
     maxHoldMs: number;
 };
+/**
+ * Creates a write debouncer bound to the current scope.
+ *
+ * Waiting callers do not control the flush fiber. Closing the scope discards
+ * pending writes and interrupts their waiters.
+ *
+ * @param options - The collection window, hold limit, and flush callback.
+ * @returns The debouncer, which requires the current scope.
+ */
 export declare const createWriteDebouncer: (options: WriteDebouncerOptions) => Effect.Effect<WriteDebouncer, never, Scope.Scope>;

package/dist/test/native-transport.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/serial-port-path.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flux-control/effect-modbus-rs",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "description": "Type-safe Modbus communication via Effect-TS, wrapping the modbus-rs npm bindings.",
   "license": "GPL-3.0",
   "repository": {
@@ -30,6 +30,7 @@
     "format:fix": "oxfmt",
     "lint": "oxlint",
     "lint:fix": "oxlint --fix",
+    "lint:staged": "lint-staged --config package.json",
     "lock": "bash tools/refresh-lockfile.sh",
     "prepare": "husky",
     "release": "changeset publish",
@@ -39,22 +40,30 @@
     "version": "changeset version"
   },
   "dependencies": {
-    "modbus-rs": "0.16.1"
+    "modbus-rs": "0.16.3"
   },
   "devDependencies": {
-    "@changesets/cli": "^2.31.1",
-    "@effect/language-service": "0.87.2",
-    "@effect/platform-bun": "^4.0.0-rc.118",
-    "@oxlint/plugins": "1.76.0",
+    "@changesets/cli": "^3.0.3",
+    "@effect/language-service": "0.87.4",
+    "@effect/platform-bun": "4.0.3",
+    "@oxlint/plugins": "1.87.0",
     "@types/bun": "latest",
-    "effect": "4.0.0-rc.118",
-    "fallow": "^2.104.0",
+    "effect": "4.0.3",
+    "fallow": "^3.33.1",
     "husky": "^9.1.7",
-    "oxfmt": "^0.71.0",
-    "oxlint": "1.76.0",
+    "lint-staged": "^17.6.0",
+    "oxfmt": "^0.72.0",
+    "oxlint": "1.87.0",
     "typescript": "^7.0.2"
   },
   "peerDependencies": {
-    "effect": "^4.0.0-rc.118"
+    "effect": "^4.0.3"
+  },
+  "lint-staged": {
+    "*.{js,jsx,mjs,cjs,ts,tsx,mts,cts}": [
+      "oxlint --fix",
+      "oxfmt"
+    ],
+    "*.{json,jsonc,md,mdx,css,scss,html,yaml,yml}": "oxfmt"
   }
 }