node-opcua-server 2.53.0 → 2.56.1

package/dist/opcua_server.d.ts

@@ -9,15 +9,22 @@ import { Certificate, Nonce } from "node-opcua-crypto";
 import { NodeId } from "node-opcua-nodeid";
 import { ObjectRegistry } from "node-opcua-object-registry";
 import { Message, MessageSecurityMode, Request, Response, SecurityPolicy, ServerSecureChannelLayer, SignatureData } from "node-opcua-secure-channel";
+import { BrowseNextResponse, BrowseResponse } from "node-opcua-service-browse";
+import { CallResponse } from "node-opcua-service-call";
+import { HistoryReadResponse } from "node-opcua-service-history";
+import { ReadResponse } from "node-opcua-service-read";
+import { RegisterNodesResponse, UnregisterNodesResponse } from "node-opcua-service-register-node";
 import { UserNameIdentityToken, X509IdentityToken } from "node-opcua-service-session";
-import { DeleteSubscriptionsResponse, SetPublishingModeResponse, TransferSubscriptionsResponse } from "node-opcua-service-subscription";
+import { CreateMonitoredItemsResponse, CreateSubscriptionResponse, DeleteSubscriptionsResponse, ModifyMonitoredItemsResponse, ModifySubscriptionResponse, RepublishResponse, SetPublishingModeResponse, SetTriggeringResponse, TransferSubscriptionsResponse } from "node-opcua-service-subscription";
+import { TranslateBrowsePathsToNodeIdsResponse } from "node-opcua-service-translate-browse-path";
+import { WriteResponse } from "node-opcua-service-write";
 import { StatusCode } from "node-opcua-status-code";
-import { ApplicationDescriptionOptions, BuildInfo, EndpointDescription, UserIdentityToken } from "node-opcua-types";
+import { ApplicationDescriptionOptions, BuildInfo, EndpointDescription, UserIdentityToken, UserTokenPolicy } from "node-opcua-types";
 import { OPCUABaseServer, OPCUABaseServerOptions } from "./base_server";
 import { IRegisterServerManager } from "./i_register_server_manager";
 import { ServerCapabilitiesOptions } from "./server_capabilities";
 import { OPCUAServerEndPoint } from "./server_end_point";
-import { ServerEngine } from "./server_engine";
+import { CreateSessionOption, ServerEngine } from "./server_engine";
 import { ServerSession } from "./server_session";
 import { CreateMonitoredItemHook, DeleteMonitoredItemHook, Subscription } from "./server_subscription";
 import { ISocketData } from "./i_socket_data";
@@ -30,6 +37,7 @@ export interface UserManagerOptions extends IUserManager {
     /** asynchronous function to check if the credentials - overrules isValidUser */
     isValidUserAsync?: ValidUserAsyncFunc;
 }
+declare type ResponseClassType = typeof BrowseResponse | typeof BrowseNextResponse | typeof CallResponse | typeof CreateMonitoredItemsResponse | typeof CreateSubscriptionResponse | typeof DeleteSubscriptionsResponse | typeof HistoryReadResponse | typeof ModifyMonitoredItemsResponse | typeof ModifySubscriptionResponse | typeof ReadResponse | typeof RegisterNodesResponse | typeof RepublishResponse | typeof SetPublishingModeResponse | typeof SetTriggeringResponse | typeof TransferSubscriptionsResponse | typeof TranslateBrowsePathsToNodeIdsResponse | typeof UnregisterNodesResponse | typeof WriteResponse;
 export declare enum RegisterServerMethod {
     HIDDEN = 1,
     MDNS = 2,
@@ -376,7 +384,7 @@ export declare class OPCUAServer extends OPCUABaseServer {
      * create and register a new session
      * @internal
      */
-    protected createSession(options: any): ServerSession;
+    protected createSession(options: CreateSessionOption): ServerSession;
     /**
      * retrieve a session by authentication token
      * @internal
@@ -398,16 +406,16 @@ export declare class OPCUAServer extends OPCUABaseServer {
      * @internal
      */
     protected verifyClientSignature(session: ServerSession, channel: ServerSecureChannelLayer, clientSignature: SignatureData): boolean;
-    protected isValidUserNameIdentityToken(channel: ServerSecureChannelLayer, session: ServerSession, userTokenPolicy: any, userIdentityToken: UserNameIdentityToken, userTokenSignature: any, callback: (err: Error | null, statusCode?: StatusCode) => void): void;
-    protected isValidX509IdentityToken(channel: ServerSecureChannelLayer, session: ServerSession, userTokenPolicy: any, userIdentityToken: X509IdentityToken, userTokenSignature: any, callback: (err: Error | null, statusCode?: StatusCode) => void): void;
+    protected isValidUserNameIdentityToken(channel: ServerSecureChannelLayer, session: ServerSession, userTokenPolicy: UserTokenPolicy, userIdentityToken: UserNameIdentityToken, userTokenSignature: SignatureData, callback: (err: Error | null, statusCode?: StatusCode) => void): void;
+    protected isValidX509IdentityToken(channel: ServerSecureChannelLayer, session: ServerSession, userTokenPolicy: UserTokenPolicy, userIdentityToken: X509IdentityToken, userTokenSignature: SignatureData, callback: (err: Error | null, statusCode?: StatusCode) => void): void;
     /**
      * @internal
      */
-    protected userNameIdentityTokenAuthenticateUser(channel: ServerSecureChannelLayer, session: ServerSession, userTokenPolicy: any, userIdentityToken: UserNameIdentityToken, callback: (err: Error | null, isAuthorized?: boolean) => void): void;
+    protected userNameIdentityTokenAuthenticateUser(channel: ServerSecureChannelLayer, session: ServerSession, userTokenPolicy: UserTokenPolicy, userIdentityToken: UserNameIdentityToken, callback: (err: Error | null, isAuthorized?: boolean) => void): void;
     /**
      * @internal
      */
-    protected isValidUserIdentityToken(channel: ServerSecureChannelLayer, session: ServerSession, userIdentityToken: UserIdentityToken, userTokenSignature: any, endpointDescription: EndpointDescription, callback: (err: Error | null, statusCode?: StatusCode) => void): void;
+    protected isValidUserIdentityToken(channel: ServerSecureChannelLayer, session: ServerSession, userIdentityToken: UserIdentityToken, userTokenSignature: SignatureData, endpointDescription: EndpointDescription, callback: (err: Error | null, statusCode?: StatusCode) => void): void;
     /**
      *
      * @internal
@@ -435,44 +443,20 @@ export declare class OPCUAServer extends OPCUABaseServer {
      * @param ResponseClass the constructor of the response Class
      * @param message
      * @param channel
-     * @param action_to_perform
-     * @param action_to_perform.session {ServerSession}
-     * @param action_to_perform.sendResponse
-     * @param action_to_perform.sendResponse.response
-     * @param action_to_perform.sendError
-     * @param action_to_perform.sendError.statusCode
-     * @param action_to_perform.sendError.diagnostics
+     * @param actionToPerform
+     * @param actionToPerform.session {ServerSession}
+     * @param actionToPerform.sendResponse
+     * @param actionToPerform.sendResponse.response
+     * @param actionToPerform.sendError
+     * @param actionToPerform.sendError.statusCode
+     * @param actionToPerform.sendError.diagnostics
      *
      * @private
      */
-    protected _apply_on_SessionObject(ResponseClass: any, message: Message, channel: ServerSecureChannelLayer, action_to_perform: (session: ServerSession, sendResponse: (response: Response) => void, sendError: (statusCode: StatusCode) => void) => void | Promise<void>): Promise<void>;
-    /**
-     * @method _apply_on_Subscription
-     * @param ResponseClass
-     * @param message
-     * @param channel
-     * @param action_to_perform
-     * @private
-     */
-    protected _apply_on_Subscription(ResponseClass: any, message: Message, channel: ServerSecureChannelLayer, action_to_perform: (session: ServerSession, subscription: Subscription, sendResponse: (response: Response) => void, sendError: (statusCode: StatusCode) => void) => Promise<void>): Promise<void>;
-    /**
-     * @method _apply_on_SubscriptionIds
-     * @param ResponseClass
-     * @param message
-     * @param channel
-     * @param action_to_perform
-     * @private
-     */
-    protected _apply_on_SubscriptionIds<T>(ResponseClass: typeof SetPublishingModeResponse | typeof TransferSubscriptionsResponse | typeof DeleteSubscriptionsResponse, message: Message, channel: ServerSecureChannelLayer, action_to_perform: (session: ServerSession, subscriptionId: number) => Promise<T>): void;
-    /**
-     * @method _apply_on_Subscriptions
-     * @param ResponseClass
-     * @param message
-     * @param channel
-     * @param action_to_perform
-     * @private
-     */
-    protected _apply_on_Subscriptions(ResponseClass: typeof SetPublishingModeResponse, message: Message, channel: ServerSecureChannelLayer, action_to_perform: (session: ServerSession, subscription: Subscription) => Promise<StatusCode>): void;
+    protected _apply_on_SessionObject(ResponseClass: ResponseClassType, message: Message, channel: ServerSecureChannelLayer, actionToPerform: (session: ServerSession, sendResponse: (response: Response) => void, sendError: (statusCode: StatusCode) => void) => void | Promise<void>): Promise<void>;
+    protected _apply_on_Subscription(ResponseClass: ResponseClassType, message: Message, channel: ServerSecureChannelLayer, actionToPerform: (session: ServerSession, subscription: Subscription, sendResponse: (response: Response) => void, sendError: (statusCode: StatusCode) => void) => Promise<void>): Promise<void>;
+    protected _apply_on_SubscriptionIds<T>(ResponseClass: typeof SetPublishingModeResponse | typeof TransferSubscriptionsResponse | typeof DeleteSubscriptionsResponse, message: Message, channel: ServerSecureChannelLayer, actionToPerform: (session: ServerSession, subscriptionId: number) => Promise<T>): void;
+    protected _apply_on_Subscriptions(ResponseClass: typeof SetPublishingModeResponse | typeof TransferSubscriptionsResponse | typeof DeleteSubscriptionsResponse, message: Message, channel: ServerSecureChannelLayer, actionToPerform: (session: ServerSession, subscription: Subscription) => Promise<StatusCode>): void;
     private _closeSession;
     /**
      * @method _on_CloseSessionRequest
@@ -567,7 +551,7 @@ export interface RaiseEventAuditCreateSessionEventData extends RaiseEventAuditSe
     secureChannelId: PseudoVariantString;
     revisedSessionTimeout: PseudoVariantDuration;
     clientCertificate: PseudoVariantByteString;
-    clientCertificateThumbprint: PseudoVariantByteString;
+    clientCertificateThumbprint: PseudoVariantString;
 }
 export interface RaiseEventAuditActivateSessionEventData extends RaiseEventAuditSessionEventData {
     /**
@@ -666,3 +650,4 @@ export interface OPCUAServer extends EventEmitter {
     on(event: "openSecureChannelFailure", eventHandler: (socketData: ISocketData, channelData: IChannelData, endpoint: OPCUAServerEndPoint) => void): this;
     on(event: string, eventHandler: (...args: [any?, ...any[]]) => void): this;
 }
+export {};