@gurezo/web-serial-rxjs 0.2.0 → 2.0.1

package/README.ja.md

@@ -1,58 +1,15 @@
-# web-serial-rxjs
+# @gurezo/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 アプリケーションでシリアルポート通信を簡単に実現できます。
-
-## 目次
-
-- [機能](#機能)
-- [対応フレームワーク](#対応フレームワーク)
-- [ブラウザサポート](#ブラウザサポート)
-- [インストール](#インストール)
-- [ドキュメント](#ドキュメント)
-- [サンプル](#サンプル)
-- [プロジェクトアイコンについて](#プロジェクトアイコンについて)
-- [開発とリリース戦略](#開発とリリース戦略)
-- [貢献](#貢献)
-- [ライセンス](#ライセンス)
-- [リンク](#リンク)
-
-## 機能
-
-- **RxJS ベースのリアクティブ API**: RxJS Observables を活用したリアクティブなシリアルポート通信
-- **テキスト向け API**: `getReadStreamAsText()` と `writeText()` で手動のエンコード/デコードを不要化
-- **シェルユーティリティ層**: `createShellClient()` でコマンド実行とプロンプト待ちのワークフローを簡潔化
-- **TypeScript サポート**: 完全な TypeScript 型定義を含む
-- **ブラウザ検出**: ブラウザサポートの検出とエラーハンドリング機能を内蔵
-- **エラーハンドリング**: カスタムエラークラスとエラーコードによる包括的なエラーハンドリング
-- **フレームワーク非依存**: 任意の JavaScript/TypeScript フレームワークまたはバニラ JavaScript で使用可能
-
-## 対応フレームワーク
-
-このライブラリはフレームワーク非依存で、以下の環境で利用できます。
-
-- Angular
-- React
-- Svelte
-- Vanilla JavaScript / TypeScript
+Web Serial API を最小限の Session 指向 RxJS 表面でラップする TypeScript ライブラリです。v2 では単一の `SerialSession` を公開し、`state$` / `isConnected$` / `receive$` / `lines$` / `errors$` を購読するだけで UI を駆動できます。read loop や送信キューの自前実装は不要です。
 
 ## ブラウザサポート
 
-Web Serial API は現在、Chromium ベースのブラウザでのみサポートされています：
+Web Serial API は **Chromium 系**のブラウザ（**Chrome** 89+、**Edge** 89+、**Opera** 75+）でのみ利用できます。
 
-- **Chrome** 89+
-- **Edge** 89+
-- **Opera** 75+
-
-このライブラリには、使用前に Web Serial API のサポートを確認するためのブラウザ検出ユーティリティが含まれています。
+`connect$` の前の feature detection には `SerialSession.isBrowserSupported()`（同期的に `boolean`）を使います。
 
 ## インストール
 
-npm または pnpm を使用してパッケージをインストールします：
-
 ```bash
 npm install @gurezo/web-serial-rxjs
 # または
@@ -61,7 +18,7 @@ pnpm add @gurezo/web-serial-rxjs
 
 ### ピア依存関係
 
-このライブラリは RxJS をピア依存関係として必要とします：
+**RxJS** `^7.8.0` をピア依存関係として必要とします。
 
 ```bash
 npm install rxjs
@@ -69,71 +26,28 @@ npm install rxjs
 pnpm add rxjs
 ```
 
-**最小要件バージョン**: RxJS ^7.8.0
-
-## ドキュメント
-
-- **[クイックスタート](docs/QUICK_START.ja.md)** - 基本的な例と使用方法で始める
-- **[API リファレンス](docs/API_REFERENCE.ja.md)** - 詳細な説明を含む完全な API ドキュメント
-- **[高度な使用方法](docs/ADVANCED_USAGE.ja.md)** - 高度なパターン、ストリーム処理、エラー回復
-
-## サンプル
-
-以下の環境向けのサンプルを用意しています。
+## 次に読むもの
 
-- **[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 の例
-- **[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 の例
+- **v2 の全体像**（機能一覧、`SerialSession` 早見表、`SerialSessionState`、最小サンプル）: [SerialSession（v2）の概要](https://github.com/gurezo/web-serial-rxjs/blob/main/packages/web-serial-rxjs/docs/OVERVIEW.ja.md)（[English](https://github.com/gurezo/web-serial-rxjs/blob/main/packages/web-serial-rxjs/docs/OVERVIEW.md)）
+- 最短でポートを開く手順: [クイックスタート](https://github.com/gurezo/web-serial-rxjs/blob/main/packages/web-serial-rxjs/docs/QUICK_START.ja.md)
 
-各例には、セットアップと使用方法の説明を含む README が含まれています。
-
-## プロジェクトアイコンについて
-
-このプロジェクトのアイコンには、[RxJS](https://rxjs.dev/) のロゴから着想を得たデザインに、
-Web Serial を表すシリアルコネクタのモチーフを組み合わせたものを使用しています。
-
-このアイコンは、本ライブラリが Web Serial API を RxJS ベースで扱うための
-ライブラリであることを示す目的でのみ使用しています。
-
-本プロジェクトは **[ReactiveX](http://reactivex.io/) / [RxJS](https://rxjs.dev/) 公式とは関係のない独立したオープンソースプロジェクト** であり、
-公式な提携・承認・スポンサー関係はありません。
-
-## 開発とリリース戦略
-
-このプロジェクトは**trunk-based開発**アプローチに従います：
-
-- **`main`ブランチ**: 常にリリース可能な状態
-- **短命ブランチ**: `feature/*`, `fix/*`, `docs/*` はプルリクエスト用
-- **リリース**: ブランチではなくGitタグ（例: `v1.0.0`）で管理
-- **バージョン保守**: 複数のメジャーバージョンを保守する必要がある場合のみ `release/v*` ブランチを追加
-
-詳細な貢献ガイドラインについては、[CONTRIBUTING.ja.md](https://github.com/gurezo/web-serial-rxjs/blob/main/CONTRIBUTING.ja.md) を参照してください。
-
-詳細なリリース手順については、[RELEASING.ja.md](https://github.com/gurezo/web-serial-rxjs/blob/main/RELEASING.ja.md) を参照してください。
-
-## 貢献
-
-貢献を歓迎します！詳細については、[貢献ガイド](https://github.com/gurezo/web-serial-rxjs/blob/main/CONTRIBUTING.ja.md)を参照してください：
-
-- 開発環境のセットアップ
-- コードスタイルガイドライン
-- コミットメッセージの規約
-- プルリクエストのプロセス
-- リリースプロセス
-
-英語版の貢献ガイドは [CONTRIBUTING.md](https://github.com/gurezo/web-serial-rxjs/blob/main/CONTRIBUTING.md) を参照してください。
+## ドキュメント
 
-リリース手順については、[RELEASING.ja.md](https://github.com/gurezo/web-serial-rxjs/blob/main/RELEASING.ja.md)（または英語版は [RELEASING.md](https://github.com/gurezo/web-serial-rxjs/blob/main/RELEASING.md)）を参照してください。
+| ドキュメント | 用途 |
+| --- | --- |
+| [全体像](https://github.com/gurezo/web-serial-rxjs/blob/main/packages/web-serial-rxjs/docs/OVERVIEW.ja.md) | 機能と v2 `SerialSession` / `SerialSessionState` の対応表 |
+| [クイックスタート](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) | オプション、`SerialError`、型の詳細 |
+| [v1 → v2 マイグレーション](https://github.com/gurezo/web-serial-rxjs/blob/main/packages/web-serial-rxjs/docs/MIGRATION_V2.ja.md) | 廃止された v1 API の置き換え |
+| **リポジトリ [README](https://github.com/gurezo/web-serial-rxjs/blob/main/README.ja.md)** | モノレポ構成、**`apps/` のサンプル**、貢献、MCP、プロジェクトアイコン |
 
 ## ライセンス
 
-このプロジェクトは MIT ライセンスの下で公開されています。詳細は [LICENSE](https://github.com/gurezo/web-serial-rxjs/blob/main/LICENSE) ファイルを参照してください。
+MIT。詳細はリポジトリの [LICENSE](https://github.com/gurezo/web-serial-rxjs/blob/main/LICENSE) を参照してください。
 
 ## リンク
 
-- **GitHub リポジトリ**: [https://github.com/gurezo/web-serial-rxjs](https://github.com/gurezo/web-serial-rxjs)
-- **イシュー**: [https://github.com/gurezo/web-serial-rxjs/issues](https://github.com/gurezo/web-serial-rxjs/issues)
-- **Web Serial API 仕様**: [https://wicg.github.io/serial/](https://wicg.github.io/serial/)
+- **リポジトリ**: [github.com/gurezo/web-serial-rxjs](https://github.com/gurezo/web-serial-rxjs)
+- **イシュー**: [github.com/gurezo/web-serial-rxjs/issues](https://github.com/gurezo/web-serial-rxjs/issues)
+- **Web Serial API 仕様**: [wicg.github.io/serial](https://wicg.github.io/serial/)

package/README.md

@@ -1,68 +1,24 @@
-# web-serial-rxjs
+# @gurezo/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 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 from `state$` + `isConnected$` + `receive$` + `lines$` + `errors$`, without rebuilding read loops or send queues themselves.
 
-A TypeScript library that provides a reactive RxJS-based wrapper for the Web Serial API, enabling easy serial port communication in web applications.
+## Browser support
 
-## Table of Contents
+The Web Serial API is only available in **Chromium-based** browsers: **Chrome** 89+, **Edge** 89+, **Opera** 75+.
 
-- [Features](#features)
-- [Framework Support](#framework-support)
-- [Browser Support](#browser-support)
-- [Installation](#installation)
-- [Documentation](#documentation)
-- [Examples](#examples)
-- [Project Icon](#project-icon)
-- [AI Assistant (MCP)](#ai-assistant-mcp)
-- [Development and Release Strategy](#development-and-release-strategy)
-- [Contributing](#contributing)
-- [License](#license)
-- [Links](#links)
-
-## Features
-
-- **RxJS-based reactive API**: Leverage the power of RxJS Observables for reactive serial port communication
-- **Text-friendly API**: Use `getReadStreamAsText()` and `writeText()` without manual encoding/decoding
-- **Shell utility layer**: Execute command/prompt workflows with `createShellClient()`
-- **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
-
-## Framework Support
-
-This library is framework-agnostic and can be used with:
-
-- Angular
-- React
-- Svelte
-- Vanilla JavaScript / TypeScript
-
-## Browser Support
-
-The Web Serial API is currently only supported in Chromium-based browsers:
-
-- **Chrome** 89+
-- **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 `connect$`.
 
 ## Installation
 
-Install the package using npm or pnpm:
-
 ```bash
 npm install @gurezo/web-serial-rxjs
 # or
 pnpm add @gurezo/web-serial-rxjs
 ```
 
-### Peer Dependencies
+### Peer dependency
 
-This library requires RxJS as a peer dependency:
+This library requires **RxJS** `^7.8.0` as a peer dependency:
 
 ```bash
 npm install rxjs
@@ -70,88 +26,28 @@ npm install rxjs
 pnpm add rxjs
 ```
 
-**Minimum required version**: RxJS ^7.8.0
-
-## 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
-
-## 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`)
-- **[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 example includes a README with setup and usage instructions.
-
-## Project Icon
+## Where to go next
 
-The project icon includes a modified design inspired by the [RxJS](https://rxjs.dev/) logo,
-combined with a serial connector motif to represent Web Serial communication.
+- Full **v2 API map** (features, `SerialSession` table, `SerialSessionState`, minimal example): [SerialSession (v2) overview](https://github.com/gurezo/web-serial-rxjs/blob/main/packages/web-serial-rxjs/docs/OVERVIEW.md) ([日本語](https://github.com/gurezo/web-serial-rxjs/blob/main/packages/web-serial-rxjs/docs/OVERVIEW.ja.md))
+- Shortest path to an open port: [Quick Start](https://github.com/gurezo/web-serial-rxjs/blob/main/packages/web-serial-rxjs/docs/QUICK_START.md)
 
-The icon is used only to indicate that this library provides
-RxJS-based abstractions for the Web Serial API.
-
-This project is an independent open source project and is **not affiliated with,
-endorsed by, or sponsored by the [ReactiveX](http://reactivex.io/) or [RxJS](https://rxjs.dev/) project**.
-
-## AI Assistant (MCP)
-
-This project includes [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server configuration for AI-assisted development. The following MCP servers are available:
-
-| Server          | Purpose                                                                                |
-| --------------- | -------------------------------------------------------------------------------------- |
-| **nx-mcp**      | Nx workspace analysis, project graph, CI monitoring, and documentation                 |
-| **angular-cli** | Angular CLI tools for example-angular (code generation, documentation, best practices) |
-| **svelte**      | Svelte/SvelteKit documentation and code analysis for example-svelte                    |
-
-**Configuration files:**
-
-- `.mcp.json` - Standard MCP configuration (Cursor, VS Code, Claude, etc.)
-- `.cursor/mcp.json` - Cursor-specific configuration
-
-To use MCP servers in Cursor, the configuration is automatically loaded from `.cursor/mcp.json`. For VS Code, add the MCP extension and configure it to use `.mcp.json`, or add the server definitions to your MCP settings.
-
-## Development and Release Strategy
-
-This project follows a **trunk-based development** approach:
-
-- **`main` branch**: Always in a release-ready state
-- **Short-lived branches**: `feature/*`, `fix/*`, `docs/*` for pull requests
-- **Releases**: Managed via Git tags (e.g., `v1.0.0`), not branches
-- **Version maintenance**: `release/v*` branches are added only when needed for maintaining multiple major versions
-
-For detailed contribution guidelines, see [CONTRIBUTING.md](https://github.com/gurezo/web-serial-rxjs/blob/main/CONTRIBUTING.md).
-
-For detailed release instructions, see [RELEASING.md](https://github.com/gurezo/web-serial-rxjs/blob/main/RELEASING.md).
-
-## Contributing
-
-We welcome contributions! Please see our [Contributing Guide](https://github.com/gurezo/web-serial-rxjs/blob/main/CONTRIBUTING.md) for details on:
-
-- Development setup
-- Code style guidelines
-- Commit message conventions
-- Pull request process
-- Release process
-
-For Japanese contributors, please see [CONTRIBUTING.ja.md](https://github.com/gurezo/web-serial-rxjs/blob/main/CONTRIBUTING.ja.md).
+## Documentation
 
-For release instructions, see [RELEASING.md](https://github.com/gurezo/web-serial-rxjs/blob/main/RELEASING.md) (or [RELEASING.ja.md](https://github.com/gurezo/web-serial-rxjs/blob/main/RELEASING.ja.md) for Japanese).
+| Doc | Use it for |
+| --- | --- |
+| [Overview](https://github.com/gurezo/web-serial-rxjs/blob/main/packages/web-serial-rxjs/docs/OVERVIEW.md) | Features and the v2 `SerialSession` / `SerialSessionState` map |
+| [Quick Start](https://github.com/gurezo/web-serial-rxjs/blob/main/packages/web-serial-rxjs/docs/QUICK_START.md) | Open a port and wire subscriptions end-to-end |
+| [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, recovery |
+| [API Reference](https://github.com/gurezo/web-serial-rxjs/blob/main/packages/web-serial-rxjs/docs/API_REFERENCE.md) | `SerialSessionOptions`, `SerialError`, and formal details |
+| [v1 → v2 migration](https://github.com/gurezo/web-serial-rxjs/blob/main/packages/web-serial-rxjs/docs/MIGRATION_V2.md) | Replacing the removed v1 `SerialClient` / `ShellClient` API |
+| [Repository README](https://github.com/gurezo/web-serial-rxjs/blob/main/README.md) | Monorepo layout, **examples** under `apps/`, contributing, MCP, and project icon |
 
 ## License
 
-This project is licensed under the MIT License - see the [LICENSE](https://github.com/gurezo/web-serial-rxjs/blob/main/LICENSE) file for details.
+MIT — see the [LICENSE](https://github.com/gurezo/web-serial-rxjs/blob/main/LICENSE) file in the repository.
 
 ## Links
 
-- **GitHub Repository**: [https://github.com/gurezo/web-serial-rxjs](https://github.com/gurezo/web-serial-rxjs)
-- **Issues**: [https://github.com/gurezo/web-serial-rxjs/issues](https://github.com/gurezo/web-serial-rxjs/issues)
-- **Web Serial API Specification**: [https://wicg.github.io/serial/](https://wicg.github.io/serial/)
+- **Repository**: [github.com/gurezo/web-serial-rxjs](https://github.com/gurezo/web-serial-rxjs)
+- **Issues**: [github.com/gurezo/web-serial-rxjs/issues](https://github.com/gurezo/web-serial-rxjs/issues)
+- **Web Serial API (spec)**: [wicg.github.io/serial](https://wicg.github.io/serial/)

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,54 +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 { createShellClient } from './shell';
-export type { SerialClient } from './client';
-export type { ShellClient, ShellClientOptions, ShellExecResult } from './shell';
+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;AAC9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAG5C,YAAY,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAC7C,YAAY,EAAE,WAAW,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAGhF,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"}