@gurezo/web-serial-rxjs 0.1.21 → 2.0.0

package/README.ja.md

@@ -1,13 +1,12 @@
-# web-serial-rxjs
-
 <p align="center">
   <img src="https://raw.githubusercontent.com/gurezo/web-serial-rxjs/main/assets/icon/web-serial-rxjs-icon.png" alt="web-serial-rxjs プロジェクトアイコン" width="512" />
 </p>
 
-Web Serial API を RxJS ベースのリアクティブなラッパーで提供する TypeScript ライブラリです。Web アプリケーションでシリアルポート通信を簡単に実現できます。
+Web Serial API を最小限の Session 指向 RxJS API でラップする TypeScript ライブラリです。v2 では単一の `SerialSession` を公開し、アプリケーション側は `state$` / `isConnected$` / `receive$` / `lines$` / `errors$` を購読するだけで UI を駆動できます。BehaviorSubject による状態再構築・read loop・送信キューの自前実装は一切不要です。
 
 ## 目次
 
+- [SerialSession（v2）の全体像](#serialsessionv2の全体像)
 - [機能](#機能)
 - [対応フレームワーク](#対応フレームワーク)
 - [ブラウザサポート](#ブラウザサポート)
@@ -22,11 +21,13 @@ Web Serial API を RxJS ベースのリアクティブなラッパーで提供
 
 ## 機能
 
-- **RxJS ベースのリアクティブ API**: RxJS Observables を活用したリアクティブなシリアルポート通信
-- **TypeScript サポート**: 完全な TypeScript 型定義を含む
-- **ブラウザ検出**: ブラウザサポートの検出とエラーハンドリング機能を内蔵
-- **エラーハンドリング**: カスタムエラークラスとエラーコードによる包括的なエラーハンドリング
-- **フレームワーク非依存**: 任意の JavaScript/TypeScript フレームワークまたはバニラ JavaScript で使用可能
+- **Session 指向のリアクティブ API**: 1 つの `SerialSession` が `state$` / `isConnected$` / `receive$` / `lines$` / `errors$` と `connect$` / `disconnect$` / `send$` を公開
+- **UTF-8 テキストストリーム**: `receive$` は内部でストリーミング `TextDecoder` を用いてデコード済み。マルチバイト文字がチャンクにまたがっても正しく結合されます
+- **順序保証された送信キュー**: 並行する `send$` 呼び出しも内部キューで FIFO 処理され、呼び出し順に書き込まれます
+- **統一エラーチャネル**: すべての I/O エラーは `SerialError` に正規化され `errors$` に多重化されます
+- **明示的なライフサイクル**: `state$` は `idle` / `connecting` / `connected` / `disconnecting` / `unsupported` / `error` を emit するので UI から直接駆動できます
+- **TypeScript サポート**: 完全な TypeScript 型定義を同梱
+- **フレームワーク非依存**: 任意の JavaScript/TypeScript フレームワークまたはバニラ JavaScript で利用可能
 
 ## 対応フレームワーク
 
@@ -45,7 +46,7 @@ Web Serial API は現在、Chromium ベースのブラウザでのみサポー
 - **Edge** 89+
 - **Opera** 75+
 
-このライブラリには、使用前に Web Serial API のサポートを確認するためのブラウザ検出ユーティリティが含まれています。
+`connect$` を呼ぶ前の feature detection には `SerialSession.isBrowserSupported()` が使えます（同期的に `boolean` を返します）。
 
 ## インストール
 
@@ -69,23 +70,91 @@ pnpm add rxjs
 
 **最小要件バージョン**: RxJS ^7.8.0
 
+## SerialSession（v2）の全体像
+
+`createSerialSession` が返す **SerialSession** だけを使います。公開 API は意図的に小さく、**標準の改行区切り**は組み込み `lines$`、独自区切りが必要なときだけ `receive$` 上に RxJS で組み立てます（[高度な使用方法](https://github.com/gurezo/web-serial-rxjs/blob/main/packages/web-serial-rxjs/docs/ADVANCED_USAGE.ja.md)）。接続真偽は `isConnected$` も利用できます。
+
+| 公開面 | 役割 |
+| --- | --- |
+| `state$` | **接続ライフサイクル** — `idle` / `connecting` / `connected` / `disconnecting` / `error` / `unsupported`。購読時に現在値をリプレイ。分岐は文字列直書きではなく **`SerialSessionState`** との比較を推奨。 |
+| `SerialSessionState` | **状態定数** — エクスポートされる const object（例: `SerialSessionState.Connected`, `SerialSessionState.Idle`）。`state$` が emit する値と同じ。 |
+| `isConnected$` | **接続中かどうか** — `state$` が `SerialSessionState.Connected` のときだけ `true`、それ以外は `false`（`state$` から `distinctUntilChanged` 付きで派生）。 |
+| `receive$` | **受信 UTF-8 テキスト**（デコード済みの**チャンク**列。行区切りではない。マルチバイト安全）。 |
+| `lines$` | **行単位の受信** — 1 行完了ごとに emit。内部バッファで改行（`\n` / `\r\n` 等）を解釈。 |
+| `errors$` | **すべての `SerialError`**（接続・読み取り・書き込み・クローズ）の主チャネル。 |
+| `connect$()` | ポート選択 → オープン → 内部 read pump 開始。 |
+| `disconnect$()` | ポートを閉じ、pump を停止。 |
+| `send$(string \| Uint8Array)` | 送信を **FIFO** で直列化（並行 `send$` も呼び出し順）。 |
+| `isBrowserSupported()` | `connect$` の前に使う、Web Serial 利用可否の同期的な `boolean`。 |
+
+### SerialSessionState（早見表）
+
+`state$` が emit する文字列のユニオンです。コードでは **const オブジェクト**（例: `SerialSessionState.Connected` → `'connected'`）での比較を推奨します。有効な遷移・例外系の扱いの詳細は [API リファレンスの SerialSessionState](https://github.com/gurezo/web-serial-rxjs/blob/main/packages/web-serial-rxjs/docs/API_REFERENCE.ja.md#serialsessionstate) を参照してください。
+
+| 定数 | 値 | 意味 |
+| --- | --- | --- |
+| `SerialSessionState.Idle` | `'idle'` | ポート未接続。Web Serial 利用可能な場合の初期値。 |
+| `SerialSessionState.Connecting` | `'connecting'` | `connect$` 実行中。 |
+| `SerialSessionState.Connected` | `'connected'` | ポートが開き、内部 read pump が動作中。 |
+| `SerialSessionState.Disconnecting` | `'disconnecting'` | `disconnect$` 実行中。 |
+| `SerialSessionState.Unsupported` | `'unsupported'` | セッション生成時点で Web Serial が利用できない。 |
+| `SerialSessionState.Error` | `'error'` | 接続まわりの致命エラー。`disconnect$` か新しいセッションで復帰。 |
+
+**`receive$` と `lines$`:** 改行区切りの定番利用では **`lines$`** を優先。**`receive$`** はチャンクの到着タイミングをそのまま扱う場合や、独自区切り・自前バッファが必要なとき向け（[行単位のフレーミング](https://github.com/gurezo/web-serial-rxjs/blob/main/packages/web-serial-rxjs/docs/ADVANCED_USAGE.ja.md#行単位のフレーミング)）。
+
+**`isConnected$`（UI 用）** — 読み取り専用の `Observable<boolean>` です。`state$` を `SerialSessionState.Connected` と毎回比較しなくても接続有無の UI 分岐に使えます。独自ルールが必要な場合は、従来どおり `state$` から `map` で派生しても構いません。
+
+**`lines$`（行区切り）** — 組み込みです。独自区切りが欲しい場合のみ `receive$` でフレーミングします（[行単位のフレーミング](https://github.com/gurezo/web-serial-rxjs/blob/main/packages/web-serial-rxjs/docs/ADVANCED_USAGE.ja.md#行単位のフレーミング)）。
+
+### 最小サンプル
+
+```typescript
+import { createSerialSession, SerialSessionState } from '@gurezo/web-serial-rxjs';
+import { filter } from 'rxjs';
+
+const session = createSerialSession({ baudRate: 115200 });
+
+if (!session.isBrowserSupported()) {
+  throw new Error('このブラウザでは Web Serial を利用できません');
+}
+
+session.lines$.subscribe(console.log);
+session.errors$.subscribe(console.error);
+session.state$
+  .pipe(filter((s) => s === SerialSessionState.Connected))
+  .subscribe(() => {
+    /* 例: ポートが開いてから有効化する UI */
+  });
+session.connect$().subscribe();
+session.send$('hello\r\n').subscribe();
+```
+
+実アプリでは `connect$` / `send$` の `subscribe` で `error` も扱ってください（`errors$` にも流れます）。手順の全体は [クイックスタート](https://github.com/gurezo/web-serial-rxjs/blob/main/packages/web-serial-rxjs/docs/QUICK_START.ja.md) を参照してください。
+
 ## ドキュメント
 
-- **[クイックスタート](docs/QUICK_START.ja.md)** - 基本的な例と使用方法で始める
-- **[API リファレンス](docs/API_REFERENCE.ja.md)** - 詳細な説明を含む完全な API ドキュメント
-- **[高度な使用方法](docs/ADVANCED_USAGE.ja.md)** - 高度なパターン、ストリーム処理、エラー回復
+| ドキュメント | 用途 |
+| --- | --- |
+| **リポジトリ [README](https://github.com/gurezo/web-serial-rxjs/blob/main/README.ja.md)** | モノレポ全体の目次、サンプル索引、貢献の導線。 |
+| **[クイックスタート](https://github.com/gurezo/web-serial-rxjs/blob/main/packages/web-serial-rxjs/docs/QUICK_START.ja.md)** | 最短でポートを開いて購読するところまで。 |
+| **[高度な使用方法](https://github.com/gurezo/web-serial-rxjs/blob/main/packages/web-serial-rxjs/docs/ADVANCED_USAGE.ja.md)** | 行フレーミング、擬似リクエスト／レスポンス、リカバリ。 |
+| **[API リファレンス](https://github.com/gurezo/web-serial-rxjs/blob/main/packages/web-serial-rxjs/docs/API_REFERENCE.ja.md)** | オプション、`SerialSessionState`、`SerialError` の詳細。 |
+| **[v1 → v2 マイグレーション](https://github.com/gurezo/web-serial-rxjs/blob/main/packages/web-serial-rxjs/docs/MIGRATION_V2.ja.md)**（[English](https://github.com/gurezo/web-serial-rxjs/blob/main/packages/web-serial-rxjs/docs/MIGRATION_V2.md)） | 削除された v1 API からの対応表。 |
+| **[Phase 5（アーカイブ）](https://github.com/gurezo/web-serial-rxjs/blob/main/packages/web-serial-rxjs/docs/archive/MIGRATION_PHASE5.ja.md)** | 旧 v1 ドキュメントの参照用。 |
 
 ## サンプル
 
 以下の環境向けのサンプルを用意しています。
 
 - **[Angular](https://github.com/gurezo/web-serial-rxjs/tree/main/apps/example-angular)** - Service を使用した Angular の例
-- **[React](https://github.com/gurezo/web-serial-rxjs/tree/main/apps/example-react)** - カスタムフック（`useSerialClient`）を使用した React の例
+- **[React](https://github.com/gurezo/web-serial-rxjs/tree/main/apps/example-react)** - カスタムフック（`useSerialSession`）を使用した React の例
 - **[Svelte](https://github.com/gurezo/web-serial-rxjs/tree/main/apps/example-svelte)** - Svelte Store を使用した Svelte の例
 - **[Vanilla JavaScript](https://github.com/gurezo/web-serial-rxjs/tree/main/apps/example-vanilla-js)** - バニラ JavaScript での基本的な使用方法
 - **[Vanilla TypeScript](https://github.com/gurezo/web-serial-rxjs/tree/main/apps/example-vanilla-ts)** - RxJS を使用した TypeScript の例
 - **[Vue](https://github.com/gurezo/web-serial-rxjs/tree/main/apps/example-vue)** - Composition API を使用した Vue 3 の例
 
+各サンプルは **connect・受信（多くの例は `lines$` または `receive$` 派生の行区切り）・send・disconnect** の最小動作確認用です。応用は [高度な使用方法](https://github.com/gurezo/web-serial-rxjs/blob/main/packages/web-serial-rxjs/docs/ADVANCED_USAGE.ja.md) を参照してください。
+
 各例には、セットアップと使用方法の説明を含む README が含まれています。
 
 ## プロジェクトアイコンについて

package/README.md

@@ -1,13 +1,12 @@
-# web-serial-rxjs
-
 <p align="center">
   <img src="https://raw.githubusercontent.com/gurezo/web-serial-rxjs/main/assets/icon/web-serial-rxjs-icon.png" alt="web-serial-rxjs project icon" width="512" />
 </p>
 
-A TypeScript library that provides a reactive RxJS-based wrapper for the Web Serial API, enabling easy serial port communication in web applications.
+A TypeScript library that wraps the Web Serial API with a minimal, session-oriented RxJS surface. The v2 API exposes a single `SerialSession` so applications can drive their UI entirely from `state$` + `isConnected$` + `receive$` + `lines$` + `errors$`, without rebuilding state, read loops, or send queues themselves.
 
 ## Table of Contents
 
+- [SerialSession (v2) at a glance](#serialsession-v2-at-a-glance)
 - [Features](#features)
 - [Framework Support](#framework-support)
 - [Browser Support](#browser-support)
@@ -23,11 +22,13 @@ A TypeScript library that provides a reactive RxJS-based wrapper for the Web Ser
 
 ## Features
 
-- **RxJS-based reactive API**: Leverage the power of RxJS Observables for reactive serial port communication
-- **TypeScript support**: Full TypeScript type definitions included
-- **Browser detection**: Built-in browser support detection and error handling
-- **Error handling**: Comprehensive error handling with custom error classes and error codes
-- **Framework agnostic**: Works with any JavaScript/TypeScript framework or vanilla JavaScript
+- **Session-oriented reactive API**: a single `SerialSession` exposes `state$`, `isConnected$`, `receive$`, `lines$`, `errors$`, plus `connect$`, `disconnect$`, and `send$`
+- **UTF-8 text stream**: `receive$` is already decoded with a streaming `TextDecoder`, so multi-byte characters split across chunks are joined correctly
+- **Ordered send queue**: concurrent `send$` calls are serialized internally in call order, without the caller having to manage a writer
+- **Unified error channel**: every I/O error is normalised into `SerialError` and multiplexed on `errors$`
+- **Explicit lifecycle**: `state$` emits `idle` / `connecting` / `connected` / `disconnecting` / `unsupported` / `error` so UIs can drive directly from it
+- **TypeScript support**: full TypeScript type definitions included
+- **Framework agnostic**: works with any JavaScript/TypeScript framework or vanilla JavaScript
 
 ## Framework Support
 
@@ -46,7 +47,7 @@ The Web Serial API is currently only supported in Chromium-based browsers:
 - **Edge** 89+
 - **Opera** 75+
 
-The library includes built-in browser detection utilities to check for Web Serial API support before attempting to use it.
+`SerialSession.isBrowserSupported()` returns a synchronous boolean for feature detection before calling `connect$`.
 
 ## Installation
 
@@ -70,23 +71,91 @@ pnpm add rxjs
 
 **Minimum required version**: RxJS ^7.8.0
 
+## SerialSession (v2) at a glance
+
+`createSerialSession` returns a single **SerialSession**. All interaction goes through the fields below. The public API is intentionally small; when you need **custom** framing, compose plain RxJS on `receive$` (see [Advanced Usage](https://github.com/gurezo/web-serial-rxjs/blob/main/packages/web-serial-rxjs/docs/ADVANCED_USAGE.md)).
+
+| Surface | Role |
+| --- | --- |
+| `state$` | **Connection lifecycle** — `idle` / `connecting` / `connected` / `disconnecting` / `error` / `unsupported`. Replays the current state on subscribe. Compare with **`SerialSessionState`** instead of string literals. |
+| `SerialSessionState` | **State constants** — exported const object (e.g. `SerialSessionState.Connected`, `SerialSessionState.Idle`) with the same values `state$` emits. |
+| `isConnected$` | **Connected flag** — `true` only when `state$` is `SerialSessionState.Connected`; `false` in every other state (derived from `state$` with `distinctUntilChanged`). |
+| `receive$` | **Raw incoming UTF-8 text** as decoded string **chunks** (not line-delimited; multi-byte safe). |
+| `lines$` | **Line-delimited UTF-8 text** — one string per complete line, using the built-in newline buffer (`\n` / `\r\n`). |
+| `errors$` | **All `SerialError` instances** from connect / read / write / close (primary error channel). |
+| `connect$()` | **Open** a user-selected port and start the internal read pump. |
+| `disconnect$()` | **Close** the port and stop the pump. |
+| `send$(string \| Uint8Array)` | **Enqueue** outgoing data; writes are **FIFO-ordered** when multiple `send$` run concurrently. |
+| `isBrowserSupported()` | Synchronous `boolean` for Web Serial availability before `connect$`. |
+
+### SerialSessionState (quick reference)
+
+`state$` uses the string union below. Prefer the **const object** (e.g. `SerialSessionState.Connected` → `'connected'`) in code. Full lifecycle diagram, transitions, and edge cases: [API Reference – SerialSessionState](https://github.com/gurezo/web-serial-rxjs/blob/main/packages/web-serial-rxjs/docs/API_REFERENCE.md#serialsessionstate).
+
+| Constant | Value | Meaning |
+| --- | --- | --- |
+| `SerialSessionState.Idle` | `'idle'` | No open port; initial state when the browser supports Web Serial. |
+| `SerialSessionState.Connecting` | `'connecting'` | `connect$` in progress. |
+| `SerialSessionState.Connected` | `'connected'` | Port is open; internal read pump is running. |
+| `SerialSessionState.Disconnecting` | `'disconnecting'` | `disconnect$` in progress. |
+| `SerialSessionState.Unsupported` | `'unsupported'` | Web Serial was not available when the session was created. |
+| `SerialSessionState.Error` | `'error'` | Fatal I/O or lifecycle failure; call `disconnect$` or build a new session. |
+
+**`receive$` vs `lines$`:** prefer **`lines$`** for typical newline-framed text; use **`receive$`** when you need raw chunk timing, a custom delimiter, or a rolling buffer you control (recipes in [Advanced Usage](https://github.com/gurezo/web-serial-rxjs/blob/main/packages/web-serial-rxjs/docs/ADVANCED_USAGE.md#line-framing)).
+
+**`isConnected$` (for simple UIs)** — a read-only `Observable<boolean>`. Use it for “port open?” toggles without comparing `state$` to `SerialSessionState.Connected` yourself. You can still derive your own boolean from `state$` with `map` if you need different rules.
+
+**`lines$` (newline framing)** — built in; for non-standard delimiters, frame on `receive$` (recipes in [Advanced Usage](https://github.com/gurezo/web-serial-rxjs/blob/main/packages/web-serial-rxjs/docs/ADVANCED_USAGE.md#line-framing)).
+
+### Minimal example
+
+```typescript
+import { createSerialSession, SerialSessionState } from '@gurezo/web-serial-rxjs';
+import { filter } from 'rxjs';
+
+const session = createSerialSession({ baudRate: 115200 });
+
+if (!session.isBrowserSupported()) {
+  throw new Error('Web Serial is not available in this browser');
+}
+
+session.lines$.subscribe(console.log);
+session.errors$.subscribe(console.error);
+session.state$
+  .pipe(filter((s) => s === SerialSessionState.Connected))
+  .subscribe(() => {
+    /* e.g. enable UI that must wait until the port is open */
+  });
+session.connect$().subscribe();
+session.send$('hello\r\n').subscribe();
+```
+
+In real apps, handle `connect$().subscribe({ next, error })` and `send$().subscribe({ error })` (errors are also on `errors$`). A fuller walkthrough is in [Quick Start](https://github.com/gurezo/web-serial-rxjs/blob/main/packages/web-serial-rxjs/docs/QUICK_START.md).
+
 ## Documentation
 
-- **[Quick Start](docs/QUICK_START.md)** - Get started with basic examples and usage patterns
-- **[API Reference](docs/API_REFERENCE.md)** - Complete API documentation with detailed descriptions
-- **[Advanced Usage](docs/ADVANCED_USAGE.md)** - Advanced patterns, stream processing, and error recovery
+| Doc | Use it for |
+| --- | --- |
+| **Repository [README](https://github.com/gurezo/web-serial-rxjs/blob/main/README.md)** | Monorepo overview, examples index, and contribution links. |
+| **[Quick Start](https://github.com/gurezo/web-serial-rxjs/blob/main/packages/web-serial-rxjs/docs/QUICK_START.md)** | Shortest path to a working open port and subscriptions. |
+| **[Advanced Usage](https://github.com/gurezo/web-serial-rxjs/blob/main/packages/web-serial-rxjs/docs/ADVANCED_USAGE.md)** | Line framing, request/response-style flows, and recovery. |
+| **[API Reference](https://github.com/gurezo/web-serial-rxjs/blob/main/packages/web-serial-rxjs/docs/API_REFERENCE.md)** | Options, `SerialSessionState`, and `SerialError` details. |
+| **[v1 → v2 Migration Guide](https://github.com/gurezo/web-serial-rxjs/blob/main/packages/web-serial-rxjs/docs/MIGRATION_V2.md)** | Replacing the removed v1 `SerialClient` / `ShellClient` API. |
+| **[Phase 5 archive (legacy v1 doc)](https://github.com/gurezo/web-serial-rxjs/blob/main/packages/web-serial-rxjs/docs/archive/MIGRATION_PHASE5.md)** | Historical v1 context only. |
 
 ## Examples
 
 Examples are available for the following environments:
 
 - **[Angular](https://github.com/gurezo/web-serial-rxjs/tree/main/apps/example-angular)** - Angular example using a Service
-- **[React](https://github.com/gurezo/web-serial-rxjs/tree/main/apps/example-react)** - React example with custom hook (`useSerialClient`)
+- **[React](https://github.com/gurezo/web-serial-rxjs/tree/main/apps/example-react)** - React example with custom hook (`useSerialSession`)
 - **[Svelte](https://github.com/gurezo/web-serial-rxjs/tree/main/apps/example-svelte)** - Svelte example using Svelte Store
 - **[Vanilla JavaScript](https://github.com/gurezo/web-serial-rxjs/tree/main/apps/example-vanilla-js)** - Basic usage with vanilla JavaScript
 - **[Vanilla TypeScript](https://github.com/gurezo/web-serial-rxjs/tree/main/apps/example-vanilla-ts)** - TypeScript example with RxJS
 - **[Vue](https://github.com/gurezo/web-serial-rxjs/tree/main/apps/example-vue)** - Vue 3 example using Composition API
 
+Each sample is a **minimal smoke test** for **connect**, **receive** (typically newline-delimited lines via `lines$` or a stream derived from `receive$`), **send**, and **disconnect**. See [Advanced Usage](https://github.com/gurezo/web-serial-rxjs/blob/main/packages/web-serial-rxjs/docs/ADVANCED_USAGE.md) for richer patterns.
+
 Each example includes a README with setup and usage instructions.
 
 ## Project Icon

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

@@ -119,6 +119,13 @@ export declare enum SerialErrorCode {
      * to inform the user that the operation was cancelled.
      */
     OPERATION_CANCELLED = "OPERATION_CANCELLED",
+    /**
+     * Operation timed out before completion.
+     *
+     * This error occurs when an operation waits for a condition (for example, prompt
+     * detection) and the timeout period elapses first.
+     */
+    OPERATION_TIMEOUT = "OPERATION_TIMEOUT",
     /**
      * 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;;;;;;;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;;;;;;;OAOG;IACH,OAAO,YAAY;CACpB"}

package/dist/index.d.ts

@@ -3,52 +3,53 @@
  *
  * # web-serial-rxjs
  *
- * A TypeScript library that provides a reactive RxJS-based wrapper for the Web Serial API,
- * enabling easy serial port communication in web applications.
+ * A TypeScript library that wraps the Web Serial API with a minimal,
+ * RxJS-based session surface.
  *
- * ## Features
+ * ## Public API (v2)
  *
- * - **RxJS-based reactive API**: Leverage the power of RxJS Observables for reactive serial port communication
- * - **TypeScript support**: Full TypeScript type definitions included
- * - **Browser detection**: Built-in browser support detection and error handling
- * - **Error handling**: Comprehensive error handling with custom error classes and error codes
- * - **Framework agnostic**: Works with any JavaScript/TypeScript framework or vanilla JavaScript
+ * The v2 public API intentionally exposes a single, session-oriented surface
+ * so that apps (Angular, Vue, React, Svelte, vanilla JS/TS) can drive their
+ * UI entirely from `state$` + `isConnected$` + `receive$` + `lines$` + `errors$` without rebuilding any
+ * state, read loops, or write queues themselves.
+ *
+ * - {@link createSerialSession} - factory for a {@link SerialSession}
+ * - {@link SerialSession} - the runtime interface
+ * - {@link SerialSessionOptions} - connection options
+ * - {@link SerialSessionState} - `state$` payload values (const + type)
+ * - {@link SerialError} / {@link SerialErrorCode} - unified error surface
  *
  * ## Browser Support
  *
- * The Web Serial API is currently only supported in Chromium-based browsers:
+ * The Web Serial API is only available in Chromium-based browsers:
+ *
  * - Chrome 89+
  * - Edge 89+
  * - Opera 75+
  *
+ * Use {@link SerialSession.isBrowserSupported} for a synchronous feature
+ * check before calling {@link SerialSession.connect$}.
+ *
  * @example
  * ```typescript
- * import { createSerialClient, isBrowserSupported } from '@gurezo/web-serial-rxjs';
+ * import { createSerialSession } from '@gurezo/web-serial-rxjs';
  *
- * // Check browser support
- * if (!isBrowserSupported()) {
- *   console.error('Web Serial API is not supported in this browser');
- *   return;
- * }
+ * const session = createSerialSession({ baudRate: 115200 });
  *
- * // Create a serial client
- * const client = createSerialClient({ baudRate: 9600 });
+ * if (!session.isBrowserSupported()) {
+ *   console.error('Web Serial API is not supported in this browser');
+ * } else {
+ *   session.state$.subscribe((state) => console.log('state:', state));
+ *   session.receive$.subscribe((chunk) => console.log('rx:', chunk));
+ *   session.errors$.subscribe((error) => console.error('err:', error));
  *
- * // Connect to a serial port
- * client.connect().subscribe({
- *   next: () => console.log('Connected!'),
- *   error: (error) => console.error('Connection error:', error),
- * });
+ *   session.connect$().subscribe();
+ *   session.send$('hello\r\n').subscribe();
+ * }
  * ```
  */
-export { createSerialClient } from './client';
-export type { SerialClient } from './client';
+export { createSerialSession, SerialSessionState } from './session';
+export type { SerialSession, SerialSessionOptions } from './session';
 export { SerialError } from './errors/serial-error';
 export { SerialErrorCode } from './errors/serial-error-code';
-export type { SerialClientOptions } from './types/options';
-export { BrowserType, detectBrowserType, hasWebSerialSupport, isChromiumBased, } from './browser/browser-detection';
-export { checkBrowserSupport, isBrowserSupported, } from './browser/browser-support';
-export { observableToWritable, subscribeToWritable, } from './io/observable-to-writable';
-export { readableToObservable } from './io/readable-to-observable';
-export { buildRequestOptions } from './filters/build-request-options';
 //# 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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AAGH,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAG9C,YAAY,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAG7C,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAG7D,YAAY,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAG3D,OAAO,EACL,WAAW,EACX,iBAAiB,EACjB,mBAAmB,EACnB,eAAe,GAChB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,mBAAmB,EACnB,kBAAkB,GACnB,MAAM,2BAA2B,CAAC;AAGnC,OAAO,EACL,oBAAoB,EACpB,mBAAmB,GACpB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAGnE,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AAEH,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AACpE,YAAY,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AAErE,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC"}