node-opcua-transport 2.170.0 → 2.173.0

package/dist/source/i_client_transport.d.ts

@@ -0,0 +1,90 @@
+/**
+ * @module node-opcua-transport
+ */
+import type { AcknowledgeMessage } from "./AcknowledgeMessage";
+/**
+ * Options used to construct a client transport. Passed through {@link IClientTransportFactory.create}
+ * and applied to the UACP HEL message during the handshake.
+ */
+export interface TransportSettingsOptions {
+    maxChunkCount?: number;
+    maxMessageSize?: number;
+    receiveBufferSize?: number;
+    sendBufferSize?: number;
+}
+/**
+ * The minimal surface that {@link ClientSecureChannelLayer} (and anything else acting as
+ * a secure-channel client) uses from a transport. {@link ClientTCP_transport} already
+ * satisfies this interface; browser transports (e.g. a WebSocket-based one) must also
+ * satisfy it to be pluggable via {@link IClientTransportFactory}.
+ *
+ * This interface is intentionally the smallest superset of what the existing
+ * `ClientTCP_transport` exposes and that the secure-channel layer actually consumes,
+ * so adding new transports does not require replicating Node-specific machinery.
+ */
+export interface IClientTransport {
+    /** diagnostic name, useful in debug logs */
+    readonly name: string;
+    /** OPC UA UACP protocol version advertised in HEL */
+    protocolVersion: number;
+    /** overall timeout applied to the underlying socket / connection lifecycle */
+    timeout: number;
+    /** number of times the owning channel has retried. Advisory; bumped by callers. */
+    numberOfRetry: number;
+    /** endpoint URL the transport was connected to (set by `connect`) */
+    endpointUrl: string;
+    /** URI reported by the local application to the peer */
+    serverUri: string;
+    readonly parameters?: AcknowledgeMessage;
+    readonly receiveBufferSize: number;
+    readonly sendBufferSize: number;
+    readonly maxChunkCount: number;
+    readonly maxMessageSize: number;
+    readonly bytesRead: number;
+    readonly bytesWritten: number;
+    readonly chunkReadCount: number;
+    readonly chunkWrittenCount: number;
+    /** connect to `endpointUrl` and perform the UACP HEL/ACK handshake */
+    connect(endpointUrl: string, callback: (err?: Error | null) => void): void;
+    /** gracefully disconnect; invokes `callback` when the underlying connection is closed */
+    disconnect(callback: (err?: Error | null) => void): void;
+    /** forcibly release resources (close the connection if still open) */
+    dispose(): void;
+    /** write a single UACP chunk to the transport */
+    write(chunk: Buffer, callback?: (err?: Error | null) => undefined): void;
+    /** emit an ERR back to the peer and destroy the underlying connection */
+    prematureTerminate(err: Error, statusCode: import("node-opcua-status-code").StatusCode): void;
+    /** simulate a connection break (used by reconnection logic in tests) */
+    forceConnectionBreak(): void;
+    /** `true` when the underlying connection is open and usable */
+    isValid(): boolean;
+    /** `true` when `disconnect()` has started or the connection is gone */
+    isDisconnecting(): boolean;
+    /** return the effective transport settings (`maxChunkCount` etc.) */
+    getTransportSettings(): TransportSettingsOptions;
+    on(eventName: "chunk", eventHandler: (messageChunk: Buffer) => void): this;
+    on(eventName: "close", eventHandler: (err: Error | null) => void): this;
+    on(eventName: "connection_break", eventHandler: (err: Error | null) => void): this;
+    on(eventName: "connect", eventHandler: () => void): this;
+    once(eventName: "chunk", eventHandler: (messageChunk: Buffer) => void): this;
+    once(eventName: "close", eventHandler: (err: Error | null) => void): this;
+    once(eventName: "connection_break", eventHandler: (err: Error | null) => void): this;
+    once(eventName: "connect", eventHandler: () => void): this;
+    removeListener(eventName: "chunk", eventHandler: (messageChunk: Buffer) => void): this;
+    removeListener(eventName: "close", eventHandler: (err: Error | null) => void): this;
+    removeListener(eventName: "connection_break", eventHandler: (err: Error | null) => void): this;
+    removeListener(eventName: "connect", eventHandler: () => void): this;
+}
+/**
+ * A factory that produces an {@link IClientTransport}. Injected into
+ * {@link ClientSecureChannelLayerOptions.transportFactory} to swap the default Node TCP
+ * transport for an alternative (for example, a browser WebSocket transport or a tracing
+ * proxy wrapped around the default).
+ */
+export interface IClientTransportFactory {
+    /**
+     * Create a new transport. Called once per secure-channel open; the factory must not
+     * return the same instance twice.
+     */
+    create(settings?: TransportSettingsOptions): IClientTransport;
+}

package/dist/source/i_client_transport.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+ * @module node-opcua-transport
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=i_client_transport.js.map

package/dist/source/i_client_transport.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"i_client_transport.js","sourceRoot":"","sources":["../../source/i_client_transport.ts"],"names":[],"mappings":";AAAA;;GAEG"}

package/dist/source/index.browser.d.ts

@@ -0,0 +1,62 @@
+/*!
+ * The MIT License (MIT)
+ * Copyright (c) 2022-2025  Sterfive SAS - 833264583 RCS ORLEANS - France  (https://www.sterfive.com)
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ *   The above copyright notice and this permission notice shall be included in all
+ *   copies or substantial portions of the Software.
+ */
+/**
+ * @module node-opcua-transport/browser
+ *
+ * Browser-safe subset of `node-opcua-transport`. Selected automatically by
+ * bundlers (esbuild, webpack, vite, rollup) via the `"browser"` condition in
+ * this package's `exports` map.
+ *
+ * Excludes Node-only modules whose top-level `import "node:net" | "node:os"`
+ * statements would otherwise crash a `platform: "browser"` bundle even though
+ * the runtime never reaches them:
+ *   - `client_tcp_transport`        — opens a `net.Socket`
+ *   - `default_client_transport_factory` — instantiates `ClientTCP_transport`
+ *   - `server_tcp_transport`        — Node-side server endpoint
+ *
+ * Browser-side OPC UA transports (e.g. `ClientWS_transport` from
+ * `node-opcua-client-browser`) extend `ClientTransportBase` from this entry,
+ * implement their own `connect()`, and inherit the inherited HEL/ACK,
+ * packet-assembly, and lifecycle machinery.
+ *
+ * ## Bundler configuration required
+ *
+ * Several files still re-exported here import `node:events` (e.g.
+ * `tcp_transport.ts`, `message_builder_base.ts`). Browser bundlers do not
+ * auto-polyfill `node:`-prefixed built-ins; consumers must alias them to
+ * polyfill packages. Example (esbuild):
+ *
+ *   alias: {
+ *     "node:events": "events",
+ *     "node:util":   "util",
+ *     "node:buffer": "buffer"
+ *   }
+ *
+ * Transitively, `node-opcua-debug` and `node-opcua-utils` also need these
+ * aliases. We deliberately do not declare the polyfills as dependencies of
+ * the transport package — Node consumers would pay the install cost for no
+ * benefit, and Node would prefer the npm port over its own built-in.
+ */
+export * from "./AcknowledgeMessage";
+export * from "./client_transport_base";
+export * from "./HelloMessage";
+export * from "./i_client_transport";
+export * from "./i_hello_ack_limits";
+export * from "./message_builder_base";
+export * from "./status_codes";
+export * from "./TCPErrorMessage";
+export * from "./tcp_transport";
+export * from "./tools";
+export * from "./utils";

package/dist/source/index.browser.js

@@ -0,0 +1,79 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/*!
+ * The MIT License (MIT)
+ * Copyright (c) 2022-2025  Sterfive SAS - 833264583 RCS ORLEANS - France  (https://www.sterfive.com)
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ *   The above copyright notice and this permission notice shall be included in all
+ *   copies or substantial portions of the Software.
+ */
+/**
+ * @module node-opcua-transport/browser
+ *
+ * Browser-safe subset of `node-opcua-transport`. Selected automatically by
+ * bundlers (esbuild, webpack, vite, rollup) via the `"browser"` condition in
+ * this package's `exports` map.
+ *
+ * Excludes Node-only modules whose top-level `import "node:net" | "node:os"`
+ * statements would otherwise crash a `platform: "browser"` bundle even though
+ * the runtime never reaches them:
+ *   - `client_tcp_transport`        — opens a `net.Socket`
+ *   - `default_client_transport_factory` — instantiates `ClientTCP_transport`
+ *   - `server_tcp_transport`        — Node-side server endpoint
+ *
+ * Browser-side OPC UA transports (e.g. `ClientWS_transport` from
+ * `node-opcua-client-browser`) extend `ClientTransportBase` from this entry,
+ * implement their own `connect()`, and inherit the inherited HEL/ACK,
+ * packet-assembly, and lifecycle machinery.
+ *
+ * ## Bundler configuration required
+ *
+ * Several files still re-exported here import `node:events` (e.g.
+ * `tcp_transport.ts`, `message_builder_base.ts`). Browser bundlers do not
+ * auto-polyfill `node:`-prefixed built-ins; consumers must alias them to
+ * polyfill packages. Example (esbuild):
+ *
+ *   alias: {
+ *     "node:events": "events",
+ *     "node:util":   "util",
+ *     "node:buffer": "buffer"
+ *   }
+ *
+ * Transitively, `node-opcua-debug` and `node-opcua-utils` also need these
+ * aliases. We deliberately do not declare the polyfills as dependencies of
+ * the transport package — Node consumers would pay the install cost for no
+ * benefit, and Node would prefer the npm port over its own built-in.
+ */
+__exportStar(require("./AcknowledgeMessage"), exports);
+__exportStar(require("./client_transport_base"), exports);
+__exportStar(require("./HelloMessage"), exports);
+__exportStar(require("./i_client_transport"), exports);
+__exportStar(require("./i_hello_ack_limits"), exports);
+__exportStar(require("./message_builder_base"), exports);
+__exportStar(require("./status_codes"), exports);
+__exportStar(require("./TCPErrorMessage"), exports);
+__exportStar(require("./tcp_transport"), exports);
+__exportStar(require("./tools"), exports);
+__exportStar(require("./utils"), exports);
+//# sourceMappingURL=index.browser.js.map

package/dist/source/index.browser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.browser.js","sourceRoot":"","sources":["../../source/index.browser.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA;;;;;;;;;;;;;GAaG;AACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,uDAAqC;AACrC,0DAAwC;AACxC,iDAA+B;AAC/B,uDAAqC;AACrC,uDAAqC;AACrC,yDAAuC;AACvC,iDAA+B;AAC/B,oDAAkC;AAClC,kDAAgC;AAChC,0CAAwB;AACxB,0CAAwB"}

package/dist/source/index.d.ts

@@ -25,7 +25,10 @@
  */
 export * from "./AcknowledgeMessage";
 export * from "./client_tcp_transport";
+export * from "./client_transport_base";
+export * from "./default_client_transport_factory";
 export * from "./HelloMessage";
+export * from "./i_client_transport";
 export * from "./i_hello_ack_limits";
 export * from "./message_builder_base";
 export * from "./server_tcp_transport";

package/dist/source/index.js

@@ -41,7 +41,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
  */
 __exportStar(require("./AcknowledgeMessage"), exports);
 __exportStar(require("./client_tcp_transport"), exports);
+__exportStar(require("./client_transport_base"), exports);
+__exportStar(require("./default_client_transport_factory"), exports);
 __exportStar(require("./HelloMessage"), exports);
+__exportStar(require("./i_client_transport"), exports);
 __exportStar(require("./i_hello_ack_limits"), exports);
 __exportStar(require("./message_builder_base"), exports);
 __exportStar(require("./server_tcp_transport"), exports);

package/dist/source/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../source/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH;;GAEG;AACH,uDAAqC;AACrC,yDAAuC;AACvC,iDAA+B;AAC/B,uDAAqC;AACrC,yDAAuC;AACvC,yDAAuC;AACvC,iDAA+B;AAC/B,oDAAkC;AAClC,kDAAgC;AAChC,0CAAwB;AACxB,0CAAwB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../source/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH;;GAEG;AACH,uDAAqC;AACrC,yDAAuC;AACvC,0DAAwC;AACxC,qEAAmD;AACnD,iDAA+B;AAC/B,uDAAqC;AACrC,uDAAqC;AACrC,yDAAuC;AACvC,yDAAuC;AACvC,iDAA+B;AAC/B,oDAAkC;AAClC,kDAAgC;AAChC,0CAAwB;AACxB,0CAAwB"}