node-opcua-client 2.64.1 → 2.65.0

package/dist/opcua_client.d.ts

@@ -1,132 +1,132 @@
-/**
- * @module node-opcua-client
- */
-import { ByteString } from "node-opcua-basic-types";
-import { Certificate, PrivateKeyPEM } from "node-opcua-crypto";
-import { ConnectionStrategyOptions, SecurityPolicy } from "node-opcua-secure-channel";
-import { ApplicationDescription, EndpointDescription, UserTokenType } from "node-opcua-service-endpoints";
-import { MessageSecurityMode } from "node-opcua-service-secure-channel";
-import { X509IdentityTokenOptions } from "node-opcua-types";
-import { ErrorCallback } from "node-opcua-status-code";
-import { FindServersRequestLike, GetEndpointsOptions, OPCUAClientBase, OPCUAClientBaseOptions } from "./client_base";
-import { ClientSession, ResponseCallback } from "./client_session";
-import { ClientSubscription, ClientSubscriptionOptions } from "./client_subscription";
-export interface UserIdentityInfoUserName {
-    type: UserTokenType.UserName;
-    userName: string;
-    password: string;
-}
-export interface UserIdentityInfoX509 extends X509IdentityTokenOptions {
-    type: UserTokenType.Certificate;
-    certificateData: ByteString;
-    privateKey: PrivateKeyPEM;
-}
-export interface AnonymousIdentity {
-    type: UserTokenType.Anonymous;
-}
-export declare type UserIdentityInfo = AnonymousIdentity | UserIdentityInfoX509 | UserIdentityInfoUserName;
-export interface OPCUAClientOptions extends OPCUAClientBaseOptions {
-    /**
-     * the requested session timeout in CreateSession (ms)
-     *
-     * Note:
-     *    - make sure that this value is large enough, especially larger than the
-     *      time between two transactions to the server.
-     *
-     *    - If your client establishes a subscription with the server, make sure that
-     *      (maxKeepAliveCount * publishingInterval) calculated with negotiated values
-     *      from the server  stay by large below the session time out, as you make
-     *      encountered unexpected behavior.
-     *
-     * @default 60000 - default value is 60 secondes
-     */
-    requestedSessionTimeout?: number;
-    /**
-     *  @deprecated(use endpointMustExist instead)
-     */
-    endpoint_must_exist?: boolean;
-    /**
-     * set to false if the client should accept server endpoint mismatch
-     * @default true
-     */
-    endpointMustExist?: boolean;
-    connectionStrategy?: ConnectionStrategyOptions;
-    /** the server certificate. */
-    serverCertificate?: Certificate;
-    /***
-     * default secure token lifetime in ms
-     */
-    defaultSecureTokenLifetime?: number;
-    /**
-     * the security mode
-     * @default MessageSecurityMode.None
-     */
-    securityMode?: MessageSecurityMode | string;
-    /**
-     * the security policy
-     * @default SecurityPolicy.None
-     */
-    securityPolicy?: SecurityPolicy | string;
-    /**
-     * @default false
-     */
-    keepSessionAlive?: boolean;
-    /**
-     * client certificate pem file.
-     * @default "certificates/client_self-signed_cert_2048.pem"
-     */
-    certificateFile?: string;
-    /**
-     * client private key pem file.
-     * @default "certificates/client_key_2048.pem"
-     */
-    privateKeyFile?: string;
-    /**
-     * a client name string that will be used to generate session names.
-     */
-    clientName?: string;
-}
-export interface OPCUAClient extends OPCUAClientBase {
-    connect(endpointUrl: string): Promise<void>;
-    connect(endpointUrl: string, callback: ErrorCallback): void;
-    disconnect(): Promise<void>;
-    disconnect(callback: ErrorCallback): void;
-    getEndpoints(options?: GetEndpointsOptions): Promise<EndpointDescription[]>;
-    getEndpoints(options: GetEndpointsOptions, callback: ResponseCallback<EndpointDescription[]>): void;
-    getEndpoints(callback: ResponseCallback<EndpointDescription[]>): void;
-    findServers(options?: FindServersRequestLike): Promise<ApplicationDescription[]>;
-    findServers(options: FindServersRequestLike, callback: ResponseCallback<ApplicationDescription[]>): void;
-    findServers(callback: ResponseCallback<ApplicationDescription[]>): void;
-    createSession(userIdentityInfo?: UserIdentityInfo): Promise<ClientSession>;
-    createSession(userIdentityInfo: UserIdentityInfo, callback: (err: Error | null, session?: ClientSession) => void): void;
-    createSession(callback: (err: Error | null, session?: ClientSession) => void): void;
-    createSession2(userIdentityInfo?: UserIdentityInfo): Promise<ClientSession>;
-    createSession2(userIdentityInfo: UserIdentityInfo, callback: (err: Error | null, session?: ClientSession) => void): void;
-    createSession2(callback: (err: Error | null, session?: ClientSession) => void): void;
-    changeSessionIdentity(session: ClientSession, userIdentityInfo: UserIdentityInfo): Promise<void>;
-    changeSessionIdentity(session: ClientSession, userIdentityInfo: UserIdentityInfo, callback: (err?: Error) => void): void;
-    closeSession(session: ClientSession, deleteSubscriptions: boolean): Promise<void>;
-    closeSession(session: ClientSession, deleteSubscriptions: boolean, callback: (err?: Error) => void): void;
-    reactivateSession(session: ClientSession): Promise<void>;
-    reactivateSession(session: ClientSession, callback: (err?: Error) => void): void;
-    createDefaultCertificate(): Promise<void>;
-}
-export interface EndpointWithUserIdentity {
-    endpointUrl: string;
-    userIdentity: UserIdentityInfo;
-}
-export declare type WithSessionFunc = (session: ClientSession) => Promise<void>;
-export declare type WithSessionFuncP<T> = (session: ClientSession) => Promise<T>;
-export declare type WithSubscriptionFunc = (session: ClientSession, subscription: ClientSubscription) => Promise<void>;
-export declare type WithSubscriptionFuncP<T> = (session: ClientSession, subscription: ClientSubscription) => Promise<T>;
-export interface OPCUAClient {
-    withSessionAsync<T>(endpointUrl: string | EndpointWithUserIdentity, inner_func: WithSessionFuncP<T>): Promise<T>;
-    withSession(endpointUrl: string | EndpointWithUserIdentity, inner_func: (session: ClientSession, done: (err?: Error) => void) => void, callback: (err?: Error) => void): void;
-    withSubscriptionAsync<T>(endpointUrl: string | EndpointWithUserIdentity, parameters: ClientSubscriptionOptions, inner_func: WithSubscriptionFuncP<T>): Promise<T>;
-}
-export declare class OPCUAClient {
-    static create(options: OPCUAClientOptions): OPCUAClient;
-    static createSession(endpointUrl: string, userIdentity?: UserIdentityInfo, clientOptions?: OPCUAClientOptions): Promise<ClientSession>;
-    static set minimumRevisedSessionTimeout(minimumRevisedSessionTimeout: number);
-    static get minimumRevisedSessionTimeout(): number;
-}
+/**
+ * @module node-opcua-client
+ */
+import { ByteString } from "node-opcua-basic-types";
+import { Certificate, PrivateKeyPEM } from "node-opcua-crypto";
+import { ConnectionStrategyOptions, SecurityPolicy } from "node-opcua-secure-channel";
+import { ApplicationDescription, EndpointDescription, UserTokenType } from "node-opcua-service-endpoints";
+import { MessageSecurityMode } from "node-opcua-service-secure-channel";
+import { X509IdentityTokenOptions } from "node-opcua-types";
+import { ErrorCallback } from "node-opcua-status-code";
+import { FindServersRequestLike, GetEndpointsOptions, OPCUAClientBase, OPCUAClientBaseOptions } from "./client_base";
+import { ClientSession, ResponseCallback } from "./client_session";
+import { ClientSubscription, ClientSubscriptionOptions } from "./client_subscription";
+export interface UserIdentityInfoUserName {
+    type: UserTokenType.UserName;
+    userName: string;
+    password: string;
+}
+export interface UserIdentityInfoX509 extends X509IdentityTokenOptions {
+    type: UserTokenType.Certificate;
+    certificateData: ByteString;
+    privateKey: PrivateKeyPEM;
+}
+export interface AnonymousIdentity {
+    type: UserTokenType.Anonymous;
+}
+export declare type UserIdentityInfo = AnonymousIdentity | UserIdentityInfoX509 | UserIdentityInfoUserName;
+export interface OPCUAClientOptions extends OPCUAClientBaseOptions {
+    /**
+     * the requested session timeout in CreateSession (ms)
+     *
+     * Note:
+     *    - make sure that this value is large enough, especially larger than the
+     *      time between two transactions to the server.
+     *
+     *    - If your client establishes a subscription with the server, make sure that
+     *      (maxKeepAliveCount * publishingInterval) calculated with negotiated values
+     *      from the server  stay by large below the session time out, as you make
+     *      encountered unexpected behavior.
+     *
+     * @default 60000 - default value is 60 secondes
+     */
+    requestedSessionTimeout?: number;
+    /**
+     *  @deprecated(use endpointMustExist instead)
+     */
+    endpoint_must_exist?: boolean;
+    /**
+     * set to false if the client should accept server endpoint mismatch
+     * @default true
+     */
+    endpointMustExist?: boolean;
+    connectionStrategy?: ConnectionStrategyOptions;
+    /** the server certificate. */
+    serverCertificate?: Certificate;
+    /***
+     * default secure token lifetime in ms
+     */
+    defaultSecureTokenLifetime?: number;
+    /**
+     * the security mode
+     * @default MessageSecurityMode.None
+     */
+    securityMode?: MessageSecurityMode | string;
+    /**
+     * the security policy
+     * @default SecurityPolicy.None
+     */
+    securityPolicy?: SecurityPolicy | string;
+    /**
+     * @default false
+     */
+    keepSessionAlive?: boolean;
+    /**
+     * client certificate pem file.
+     * @default "certificates/client_self-signed_cert_2048.pem"
+     */
+    certificateFile?: string;
+    /**
+     * client private key pem file.
+     * @default "certificates/client_key_2048.pem"
+     */
+    privateKeyFile?: string;
+    /**
+     * a client name string that will be used to generate session names.
+     */
+    clientName?: string;
+}
+export interface OPCUAClient extends OPCUAClientBase {
+    connect(endpointUrl: string): Promise<void>;
+    connect(endpointUrl: string, callback: ErrorCallback): void;
+    disconnect(): Promise<void>;
+    disconnect(callback: ErrorCallback): void;
+    getEndpoints(options?: GetEndpointsOptions): Promise<EndpointDescription[]>;
+    getEndpoints(options: GetEndpointsOptions, callback: ResponseCallback<EndpointDescription[]>): void;
+    getEndpoints(callback: ResponseCallback<EndpointDescription[]>): void;
+    findServers(options?: FindServersRequestLike): Promise<ApplicationDescription[]>;
+    findServers(options: FindServersRequestLike, callback: ResponseCallback<ApplicationDescription[]>): void;
+    findServers(callback: ResponseCallback<ApplicationDescription[]>): void;
+    createSession(userIdentityInfo?: UserIdentityInfo): Promise<ClientSession>;
+    createSession(userIdentityInfo: UserIdentityInfo, callback: (err: Error | null, session?: ClientSession) => void): void;
+    createSession(callback: (err: Error | null, session?: ClientSession) => void): void;
+    createSession2(userIdentityInfo?: UserIdentityInfo): Promise<ClientSession>;
+    createSession2(userIdentityInfo: UserIdentityInfo, callback: (err: Error | null, session?: ClientSession) => void): void;
+    createSession2(callback: (err: Error | null, session?: ClientSession) => void): void;
+    changeSessionIdentity(session: ClientSession, userIdentityInfo: UserIdentityInfo): Promise<void>;
+    changeSessionIdentity(session: ClientSession, userIdentityInfo: UserIdentityInfo, callback: (err?: Error) => void): void;
+    closeSession(session: ClientSession, deleteSubscriptions: boolean): Promise<void>;
+    closeSession(session: ClientSession, deleteSubscriptions: boolean, callback: (err?: Error) => void): void;
+    reactivateSession(session: ClientSession): Promise<void>;
+    reactivateSession(session: ClientSession, callback: (err?: Error) => void): void;
+    createDefaultCertificate(): Promise<void>;
+}
+export interface EndpointWithUserIdentity {
+    endpointUrl: string;
+    userIdentity: UserIdentityInfo;
+}
+export declare type WithSessionFunc = (session: ClientSession) => Promise<void>;
+export declare type WithSessionFuncP<T> = (session: ClientSession) => Promise<T>;
+export declare type WithSubscriptionFunc = (session: ClientSession, subscription: ClientSubscription) => Promise<void>;
+export declare type WithSubscriptionFuncP<T> = (session: ClientSession, subscription: ClientSubscription) => Promise<T>;
+export interface OPCUAClient {
+    withSessionAsync<T>(endpointUrl: string | EndpointWithUserIdentity, inner_func: WithSessionFuncP<T>): Promise<T>;
+    withSession(endpointUrl: string | EndpointWithUserIdentity, inner_func: (session: ClientSession, done: (err?: Error) => void) => void, callback: (err?: Error) => void): void;
+    withSubscriptionAsync<T>(endpointUrl: string | EndpointWithUserIdentity, parameters: ClientSubscriptionOptions, inner_func: WithSubscriptionFuncP<T>): Promise<T>;
+}
+export declare class OPCUAClient {
+    static create(options: OPCUAClientOptions): OPCUAClient;
+    static createSession(endpointUrl: string, userIdentity?: UserIdentityInfo, clientOptions?: OPCUAClientOptions): Promise<ClientSession>;
+    static set minimumRevisedSessionTimeout(minimumRevisedSessionTimeout: number);
+    static get minimumRevisedSessionTimeout(): number;
+}

package/dist/opcua_client.js

@@ -1,34 +1,34 @@
-"use strict";
-/**
- * @module node-opcua-client
- */
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OPCUAClient = void 0;
-const opcua_client_impl_1 = require("./private/opcua_client_impl");
-class OPCUAClient {
-    static create(options) {
-        return new opcua_client_impl_1.OPCUAClientImpl(options);
-    }
-    static createSession(endpointUrl, userIdentity, clientOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return opcua_client_impl_1.OPCUAClientImpl.createSession(endpointUrl, userIdentity, clientOptions);
-        });
-    }
-    static set minimumRevisedSessionTimeout(minimumRevisedSessionTimeout) {
-        opcua_client_impl_1.OPCUAClientImpl.minimumRevisedSessionTimeout = minimumRevisedSessionTimeout;
-    }
-    static get minimumRevisedSessionTimeout() {
-        return opcua_client_impl_1.OPCUAClientImpl.minimumRevisedSessionTimeout;
-    }
-}
-exports.OPCUAClient = OPCUAClient;
+"use strict";
+/**
+ * @module node-opcua-client
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OPCUAClient = void 0;
+const opcua_client_impl_1 = require("./private/opcua_client_impl");
+class OPCUAClient {
+    static create(options) {
+        return new opcua_client_impl_1.OPCUAClientImpl(options);
+    }
+    static createSession(endpointUrl, userIdentity, clientOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return opcua_client_impl_1.OPCUAClientImpl.createSession(endpointUrl, userIdentity, clientOptions);
+        });
+    }
+    static set minimumRevisedSessionTimeout(minimumRevisedSessionTimeout) {
+        opcua_client_impl_1.OPCUAClientImpl.minimumRevisedSessionTimeout = minimumRevisedSessionTimeout;
+    }
+    static get minimumRevisedSessionTimeout() {
+        return opcua_client_impl_1.OPCUAClientImpl.minimumRevisedSessionTimeout;
+    }
+}
+exports.OPCUAClient = OPCUAClient;
 //# sourceMappingURL=opcua_client.js.map