@gurezo/web-serial-rxjs 0.1.0 → 0.1.1

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

@@ -0,0 +1,72 @@
+import { SerialErrorCode } from './serial-error-code';
+export { SerialErrorCode };
+/**
+ * Custom error class for serial port operations.
+ *
+ * This error class extends the standard Error class and includes additional information
+ * about the type of error that occurred. It provides an error code for programmatic
+ * error handling and may include the original error that caused the failure.
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   await client.connect().toPromise();
+ * } catch (error) {
+ *   if (error instanceof SerialError) {
+ *     console.error(`Error code: ${error.code}`);
+ *     console.error(`Message: ${error.message}`);
+ *     if (error.originalError) {
+ *       console.error(`Original error:`, error.originalError);
+ *     }
+ *
+ *     // Check specific error code
+ *     if (error.is(SerialErrorCode.BROWSER_NOT_SUPPORTED)) {
+ *       // Handle browser not supported
+ *     }
+ *   }
+ * }
+ * ```
+ */
+export declare class SerialError extends Error {
+    /**
+     * The error code identifying the type of error that occurred.
+     *
+     * Use this code to programmatically handle specific error conditions.
+     *
+     * @see {@link SerialErrorCode} for all available error codes
+     */
+    readonly code: SerialErrorCode;
+    /**
+     * The original error that caused this SerialError, if available.
+     *
+     * This property contains the underlying error (e.g., DOMException, TypeError)
+     * that was wrapped in this SerialError. It may be undefined if no original error exists.
+     */
+    readonly originalError?: Error;
+    /**
+     * Creates a new SerialError instance.
+     *
+     * @param code - The error code identifying the type of error
+     * @param message - A human-readable error message
+     * @param originalError - The original error that caused this SerialError, if any
+     */
+    constructor(code: SerialErrorCode, message: string, originalError?: Error);
+    /**
+     * Check if the error matches a specific error code.
+     *
+     * This is a convenience method for checking the error code without directly
+     * comparing the code property.
+     *
+     * @param code - The error code to check against
+     * @returns `true` if this error's code matches the provided code, `false` otherwise
+     *
+     * @example
+     * ```typescript
+     * if (error.is(SerialErrorCode.PORT_NOT_OPEN)) {
+     *   // Handle port not open error
+     * }
+     * ```
+     */
+    is(code: SerialErrorCode): boolean;
+}
+//# sourceMappingURL=serial-error.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"serial-error.d.ts","sourceRoot":"","sources":["../../src/errors/serial-error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAGtD,OAAO,EAAE,eAAe,EAAE,CAAC;AAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBAAa,WAAY,SAAQ,KAAK;IACpC;;;;;;OAMG;IACH,SAAgB,IAAI,EAAE,eAAe,CAAC;IAEtC;;;;;OAKG;IACH,SAAgB,aAAa,CAAC,EAAE,KAAK,CAAC;IAEtC;;;;;;OAMG;gBACS,IAAI,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,KAAK;IAczE;;;;;;;;;;;;;;;OAeG;IACI,EAAE,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO;CAG1C"}

package/dist/filters/build-request-options.d.ts

@@ -0,0 +1,42 @@
+import { SerialClientOptions } from '../types/options';
+/**
+ * Build SerialPortRequestOptions from SerialClientOptions.
+ *
+ * This utility function converts filter options from {@link SerialClientOptions} into
+ * the format expected by the Web Serial API's `navigator.serial.requestPort()` method.
+ * It validates the filter options to ensure they are valid before returning them.
+ *
+ * If no filters are provided in the options, this function returns `undefined`, which
+ * allows the port selection dialog to show all available ports.
+ *
+ * @param options - Optional SerialClientOptions containing filter configuration
+ * @returns SerialPortRequestOptions object with validated filters, or `undefined` if no filters are provided
+ * @throws {@link SerialError} with code {@link SerialErrorCode.INVALID_FILTER_OPTIONS} if filter validation fails
+ *
+ * @example
+ * ```typescript
+ * // With filters
+ * const options = {
+ *   baudRate: 9600,
+ *   filters: [
+ *     { usbVendorId: 0x1234 },
+ *     { usbVendorId: 0x5678, usbProductId: 0x9abc },
+ *   ],
+ * };
+ * const requestOptions = buildRequestOptions(options);
+ * // Returns: { filters: [...] }
+ *
+ * // Without filters
+ * const requestOptions = buildRequestOptions({ baudRate: 9600 });
+ * // Returns: undefined
+ *
+ * // Invalid filter (will throw)
+ * try {
+ *   buildRequestOptions({ filters: [{ usbVendorId: -1 }] });
+ * } catch (error) {
+ *   // SerialError with code INVALID_FILTER_OPTIONS
+ * }
+ * ```
+ */
+export declare function buildRequestOptions(options?: SerialClientOptions): SerialPortRequestOptions | undefined;
+//# sourceMappingURL=build-request-options.d.ts.map

package/dist/filters/build-request-options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"build-request-options.d.ts","sourceRoot":"","sources":["../../src/filters/build-request-options.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAEvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,wBAAgB,mBAAmB,CACjC,OAAO,CAAC,EAAE,mBAAmB,GAC5B,wBAAwB,GAAG,SAAS,CA4CtC"}

package/dist/index.d.ts

@@ -0,0 +1,54 @@
+/**
+ * @packageDocumentation
+ *
+ * # 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.
+ *
+ * ## 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
+ *
+ * ## Browser Support
+ *
+ * The Web Serial API is currently only supported in Chromium-based browsers:
+ * - Chrome 89+
+ * - Edge 89+
+ * - Opera 75+
+ *
+ * @example
+ * ```typescript
+ * import { createSerialClient, isBrowserSupported } from '@gurezo/web-serial-rxjs';
+ *
+ * // Check browser support
+ * if (!isBrowserSupported()) {
+ *   console.error('Web Serial API is not supported in this browser');
+ *   return;
+ * }
+ *
+ * // Create a serial client
+ * const client = createSerialClient({ baudRate: 9600 });
+ *
+ * // Connect to a serial port
+ * client.connect().subscribe({
+ *   next: () => console.log('Connected!'),
+ *   error: (error) => console.error('Connection error:', error),
+ * });
+ * ```
+ */
+export { createSerialClient } from './client';
+export type { SerialClient } from './client';
+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

@@ -0,0 +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"}