@gurezo/web-serial-rxjs 2.4.0 → 3.1.0

package/dist/index.d.ts

@@ -6,21 +6,30 @@
  * A TypeScript library that wraps the Web Serial API with a minimal,
  * RxJS-based session surface.
  *
- * ## Public API (v2)
+ * ## Public API
  *
- * 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$` + `terminalText$` + `lines$` + `errors$` without rebuilding any
- * state, read loops, or write queues themselves.
+ * The public API exposes a single, session-oriented surface so that apps
+ * (Angular, Vue, React, Svelte, vanilla JS/TS) can drive their UI from
+ * `state$` (canonical lifecycle discriminated union) + `errors$` (error event
+ * channel) + `receive$` + `terminalText$` + `lines$` without rebuilding state,
+ * read loops, or write queues. Derive convenience booleans from `state$`
+ * narrowing; `isConnected$` is deprecated in v3.x.
  *
  * - {@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)
+ * - {@link SerialSessionOptions} - factory options (connection + features)
+ * - {@link SerialPayload} - payload accepted by {@link SerialSession.send$}
+ * - {@link SerialConnectionOptions} - `port.open` connection parameters (excluding filters)
+ * - {@link SerialSessionFeatureOptions} - library-specific session feature options
+ * - {@link SerialSessionStatus} - lifecycle status literals for `state$.status`
+ * - {@link SerialSessionState} - discriminated union emitted by `state$`
+ * - {@link isConnectedSessionState} - type predicate for connected `state$` narrowing in RxJS pipelines
  * - {@link SerialError} / {@link SerialErrorCode} - unified error surface
+ * - {@link SerialErrorContextMap} - structured metadata per error code
+ * - {@link ValidationErrorContext} - machine-readable validation error metadata
  *
  * ## Browser Support
  *
@@ -41,25 +50,46 @@
  *
  * @example
  * ```typescript
- * import { createSerialSession } from '@gurezo/web-serial-rxjs';
+ * import { filter } from 'rxjs';
+ * import {
+ *   createSerialSession,
+ *   isConnectedSessionState,
+ *   SerialSessionStatus,
+ *   SerialErrorCode,
+ * } from '@gurezo/web-serial-rxjs';
  *
  * const session = createSerialSession({ baudRate: 115200 });
  *
  * if (!session.isBrowserSupported()) {
  *   console.error('Web Serial API is not supported in this browser');
  * } else {
- *   session.state$.subscribe((state) => console.log('state:', state));
+ *   session.state$.subscribe((state) => {
+ *     if (state.status === SerialSessionStatus.Connected) {
+ *       console.log('port:', state.portInfo);
+ *     }
+ *   });
+ *   session.state$
+ *     .pipe(filter(isConnectedSessionState))
+ *     .subscribe((state) => {
+ *       console.log('port:', state.portInfo);
+ *     });
  *   session.receive$.subscribe((chunk) => console.log('rx:', chunk));
- *   session.errors$.subscribe((error) => console.error('err:', error));
+ *   session.errors$.subscribe((error) => {
+ *     if (error.is(SerialErrorCode.READ_FAILED)) {
+ *       console.error(error.context.cause);
+ *     }
+ *   });
  *
  *   session.connect$().subscribe();
  *   session.send$('hello\r\n').subscribe();
  * }
  * ```
  */
-export { createSerialSession, SerialSessionState, DEFAULT_LINE_BUFFER_OPTIONS } from './session';
-export type { SerialSession, SerialSessionOptions, SerialSessionReceiveReplayOptions, LineBufferOptions, } from './session';
+export { assertNever } from './internal/assert-never';
+export { createSerialSession, SerialSessionStatus, isConnectedSessionState, DEFAULT_LINE_BUFFER_OPTIONS, resolveSerialSessionOptions, MAX_RECEIVE_REPLAY_BUFFER_SIZE, MAX_RECEIVE_REPLAY_MAX_CHARS } from './session';
+export type { SerialSession, SerialSessionState, IdleSessionState, ConnectingSessionState, ConnectedSessionState, DisconnectingSessionState, UnsupportedSessionState, ErrorSessionState, DisposedSessionState, SerialSessionOptions, SerialSessionFeatureOptions, SerialSessionReceiveReplayOptions, ResolvedSerialSessionOptions, SerialPayload, SerialConnectionOptions, LineBufferOptions, } from './session';
 export { SerialError } from './errors/serial-error';
+export type { SerialErrorCauseContext, SerialErrorContextMap, ValidationErrorConstraint, ValidationErrorContext, } from './errors/serial-error';
 export { SerialErrorCode } from './errors/serial-error-code';
 export { createTerminalBuffer, DEFAULT_TERMINAL_BUFFER_OPTIONS } from './terminal/create-terminal-buffer';
 export type { TerminalBuffer, TerminalBufferOptions } from './terminal/create-terminal-buffer';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"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"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsFG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAEtD,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,uBAAuB,EAAE,2BAA2B,EAAE,2BAA2B,EAAE,8BAA8B,EAAE,4BAA4B,EAAE,MAAM,WAAW,CAAC;AACtN,YAAY,EACV,aAAa,EACb,kBAAkB,EAClB,gBAAgB,EAChB,sBAAsB,EACtB,qBAAqB,EACrB,yBAAyB,EACzB,uBAAuB,EACvB,iBAAiB,EACjB,oBAAoB,EACpB,oBAAoB,EACpB,2BAA2B,EAC3B,iCAAiC,EACjC,4BAA4B,EAC5B,aAAa,EACb,uBAAuB,EACvB,iBAAiB,GAClB,MAAM,WAAW,CAAC;AAEnB,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,YAAY,EACV,uBAAuB,EACvB,qBAAqB,EACrB,yBAAyB,EACzB,sBAAsB,GACvB,MAAM,uBAAuB,CAAC;AAC/B,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"}