@gurezo/web-serial-rxjs 2.3.5 → 2.4.0

package/README.ja.md

@@ -27,7 +27,7 @@ Web Serial API は**デスクトップ**ブラウザでのみサポートされ
 
 ## 受信の replay（`receive$` と `receiveReplay$`）
 
-`receive$` は **non-replay** のままです。購読後に届くチャンクだけが見えます。接続ごとに直近 *N* 件のデコード済みテキスト**チャンク**（read pump の 1 回の `onChunk` あたり 1 件。文字数ではありません）を遅延購読者にも渡したい場合は、`createSerialSession` に `receiveReplay: { enabled: true, bufferSize: 512 }` を指定し、`receiveReplay$` を購読します。`bufferSize` を大きくするとメモリ負荷が増えます。receive replay が **無効**（既定）のとき、`receiveReplay$` は `receive$` と同じ hot ストリームです。`lines$` の行分割に replay は付きません。生チャンクの `receiveReplay$` のみが対象です。
+`receive$` は **non-replay** のままです。購読後に届くチャンクだけが見えます。接続ごとに直近 *N* 件のデコード済みテキスト**チャンク**（read pump の 1 回の `onChunk` あたり 1 件。文字数ではありません）を遅延購読者にも渡したい場合は、`createSerialSession` に `receiveReplay: { enabled: true, bufferSize: 512 }` を指定し、`receiveReplay$` を購読します。`bufferSize` は 1〜65536 の正の safe integer である必要があります。任意の `maxChars` で保持チャンク全体の文字数上限を指定でき、超過時は古いチャンクから破棄し non-fatal の `RECEIVE_REPLAY_BUFFER_OVERFLOW` を `errors$` に emit します。`bufferSize` やチャンクサイズを大きくするとメモリ負荷が増えます。receive replay が **無効**（既定）のとき、`receiveReplay$` は `receive$` と同じ hot ストリームです。`lines$` の行分割に replay は付きません。生チャンクの `receiveReplay$` のみが対象です。
 
 ## `receive$` と `lines$`
 

package/README.md

@@ -27,7 +27,7 @@ After a successful `connect$`, use `getPortInfo()` or subscribe to `portInfo$` f
 
 ## Receive replay (`receive$` vs `receiveReplay$`)
 
-`receive$` is **non-replay**: late subscribers only see chunks emitted after they subscribe. To retain the last *N* decoded text **chunks** per open connection (same bytes as `receive$`, e.g. for boot logs), pass `receiveReplay: { enabled: true, bufferSize: 512 }` to `createSerialSession` and subscribe to `receiveReplay$`. Larger `bufferSize` uses more memory. When receive replay is **off** (default), `receiveReplay$` is the same hot stream as `receive$`. This option does not add replay to `lines$`—only raw decoder chunks on `receiveReplay$`.
+`receive$` is **non-replay**: late subscribers only see chunks emitted after they subscribe. To retain the last *N* decoded text **chunks** per open connection (same bytes as `receive$`, e.g. for boot logs), pass `receiveReplay: { enabled: true, bufferSize: 512 }` to `createSerialSession` and subscribe to `receiveReplay$`. `bufferSize` must be a positive safe integer up to 65536. Optional `maxChars` bounds total buffered characters by discarding oldest chunks (non-fatal `RECEIVE_REPLAY_BUFFER_OVERFLOW` on `errors$`). Larger `bufferSize` or chunk sizes use more memory. When receive replay is **off** (default), `receiveReplay$` is the same hot stream as `receive$`. This option does not add replay to `lines$`—only raw decoder chunks on `receiveReplay$`.
 
 ## `receive$` vs `lines$`
 

package/dist/errors/serial-error-code.d.ts

@@ -126,6 +126,49 @@ export declare enum SerialErrorCode {
      * detection) and the timeout period elapses first.
      */
     OPERATION_TIMEOUT = "OPERATION_TIMEOUT",
+    /**
+     * Internal line buffer exceeded its configured size limit.
+     *
+     * This error occurs when the incomplete line tail held by the {@link SerialSession.lines$}
+     * framing buffer grows beyond {@link SerialSessionOptions.lineBuffer} `maxChars`.
+     * Leading characters are discarded to bound memory; the session remains connected.
+     *
+     * **Suggested action**: Increase `lineBuffer.maxChars`, handle framing on `receive$`,
+     * or ensure the device sends line terminators.
+     */
+    LINE_BUFFER_OVERFLOW = "LINE_BUFFER_OVERFLOW",
+    /**
+     * Invalid receive replay options provided.
+     *
+     * This error occurs when {@link SerialSessionOptions.receiveReplay} values are
+     * out of range, such as a non-integer `bufferSize` or `maxChars`.
+     *
+     * **Suggested action**: Verify `receiveReplay` options match the documented
+     * ranges and value types.
+     */
+    INVALID_RECEIVE_REPLAY_OPTIONS = "INVALID_RECEIVE_REPLAY_OPTIONS",
+    /**
+     * Receive replay buffer exceeded its configured character limit.
+     *
+     * This error occurs when buffered chunks on {@link SerialSession.receiveReplay$}
+     * exceed {@link SerialSessionOptions.receiveReplay} `maxChars`. Oldest chunks
+     * are discarded to bound memory; the session remains connected.
+     *
+     * **Suggested action**: Increase `receiveReplay.maxChars`, reduce chunk size at
+     * the source, or subscribe earlier to avoid relying on a large replay buffer.
+     */
+    RECEIVE_REPLAY_BUFFER_OVERFLOW = "RECEIVE_REPLAY_BUFFER_OVERFLOW",
+    /**
+     * Session has been disposed and can no longer be used.
+     *
+     * This error occurs when calling {@link SerialSession.connect$} or
+     * {@link SerialSession.send$} after {@link SerialSession.dispose$} has
+     * completed. Create a new session instead of reusing a disposed instance.
+     *
+     * **Suggested action**: Call {@link SerialSession.dispose$} only when
+     * permanently tearing down a session, then create a new one if needed.
+     */
+    SESSION_DISPOSED = "SESSION_DISPOSED",
     /**
      * Unknown error occurred.
      *

package/dist/errors/serial-error-code.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"serial-error-code.d.ts","sourceRoot":"","sources":["../../src/errors/serial-error-code.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,oBAAY,eAAe;IACzB;;;;;;;;OAQG;IACH,qBAAqB,0BAA0B;IAE/C;;;;;;;;OAQG;IACH,kBAAkB,uBAAuB;IAEzC;;;;;;;OAOG;IACH,gBAAgB,qBAAqB;IAErC;;;;;;;OAOG;IACH,iBAAiB,sBAAsB;IAEvC;;;;;;;OAOG;IACH,aAAa,kBAAkB;IAE/B;;;;;;;OAOG;IACH,WAAW,gBAAgB;IAE3B;;;;;;;OAOG;IACH,YAAY,iBAAiB;IAE7B;;;;;;;;OAQG;IACH,eAAe,oBAAoB;IAEnC;;;;;;;OAOG;IACH,sBAAsB,2BAA2B;IAEjD;;;;;;;;OAQG;IACH,mBAAmB,wBAAwB;IAE3C;;;;;OAKG;IACH,iBAAiB,sBAAsB;IAEvC;;;;;;;OAOG;IACH,OAAO,YAAY;CACpB"}
+{"version":3,"file":"serial-error-code.d.ts","sourceRoot":"","sources":["../../src/errors/serial-error-code.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,oBAAY,eAAe;IACzB;;;;;;;;OAQG;IACH,qBAAqB,0BAA0B;IAE/C;;;;;;;;OAQG;IACH,kBAAkB,uBAAuB;IAEzC;;;;;;;OAOG;IACH,gBAAgB,qBAAqB;IAErC;;;;;;;OAOG;IACH,iBAAiB,sBAAsB;IAEvC;;;;;;;OAOG;IACH,aAAa,kBAAkB;IAE/B;;;;;;;OAOG;IACH,WAAW,gBAAgB;IAE3B;;;;;;;OAOG;IACH,YAAY,iBAAiB;IAE7B;;;;;;;;OAQG;IACH,eAAe,oBAAoB;IAEnC;;;;;;;OAOG;IACH,sBAAsB,2BAA2B;IAEjD;;;;;;;;OAQG;IACH,mBAAmB,wBAAwB;IAE3C;;;;;OAKG;IACH,iBAAiB,sBAAsB;IAEvC;;;;;;;;;OASG;IACH,oBAAoB,yBAAyB;IAE7C;;;;;;;;OAQG;IACH,8BAA8B,mCAAmC;IAEjE;;;;;;;;;OASG;IACH,8BAA8B,mCAAmC;IAEjE;;;;;;;;;OASG;IACH,gBAAgB,qBAAqB;IAErC;;;;;;;OAOG;IACH,OAAO,YAAY;CACpB"}

package/dist/index.d.ts

@@ -15,6 +15,8 @@
  *
  * - {@link createSerialSession} - factory for a {@link SerialSession}
  * - {@link createTerminalBuffer} - terminal-style display text from {@link SerialSession.receive$}
+ * - {@link TerminalBufferOptions} - memory limits for terminal display text
+ * - {@link LineBufferOptions} - memory limits for lines$ incomplete line tail
  * - {@link SerialSession} - the runtime interface
  * - {@link SerialSessionOptions} - connection options
  * - {@link SerialSessionState} - `state$` payload values (const + type)
@@ -55,10 +57,10 @@
  * }
  * ```
  */
-export { createSerialSession, SerialSessionState } from './session';
-export type { SerialSession, SerialSessionOptions, SerialSessionReceiveReplayOptions, } from './session';
+export { createSerialSession, SerialSessionState, DEFAULT_LINE_BUFFER_OPTIONS } from './session';
+export type { SerialSession, SerialSessionOptions, SerialSessionReceiveReplayOptions, LineBufferOptions, } from './session';
 export { SerialError } from './errors/serial-error';
 export { SerialErrorCode } from './errors/serial-error-code';
-export { createTerminalBuffer } from './terminal/create-terminal-buffer';
-export type { TerminalBuffer } from './terminal/create-terminal-buffer';
+export { createTerminalBuffer, DEFAULT_TERMINAL_BUFFER_OPTIONS } from './terminal/create-terminal-buffer';
+export type { TerminalBuffer, TerminalBufferOptions } from './terminal/create-terminal-buffer';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AAEH,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AACpE,YAAY,EACV,aAAa,EACb,oBAAoB,EACpB,iCAAiC,GAClC,MAAM,WAAW,CAAC;AAEnB,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAE7D,OAAO,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AACzE,YAAY,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0DG;AAEH,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,2BAA2B,EAAE,MAAM,WAAW,CAAC;AACjG,YAAY,EACV,aAAa,EACb,oBAAoB,EACpB,iCAAiC,EACjC,iBAAiB,GAClB,MAAM,WAAW,CAAC;AAEnB,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAE7D,OAAO,EAAE,oBAAoB,EAAE,+BAA+B,EAAE,MAAM,mCAAmC,CAAC;AAC1G,YAAY,EAAE,cAAc,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC"}