node-opcua-address-space-base 2.167.0 → 2.169.0

package/dist/namespace.d.ts

@@ -1,22 +1,22 @@
-import { QualifiedNameLike, AccessRestrictionsFlag, LocalizedTextLike, NodeClass } from "node-opcua-data-model";
-import { NodeId, NodeIdLike } from "node-opcua-nodeid";
-import { ArgumentOptions, AxisInformationOptions, AxisScaleEnumeration, EnumFieldOptions, EUInformationOptions, RangeOptions, RolePermissionType, RolePermissionTypeOptions, StructureFieldOptions } from "node-opcua-types";
-import { VariantLike } from "node-opcua-variant";
-import { UInt32 } from "node-opcua-basic-types";
-import { DataValueOptions } from "node-opcua-data-value";
-import { IAddressSpace } from "./address_space";
-import { AddReferenceOpts, BaseNode, ConstructNodeIdOptions } from "./base_node";
-import { ModellingRuleType } from "./modelling_rule_type";
-import { UADataType } from "./ua_data_type";
-import { UAObject } from "./ua_object";
-import { UAObjectType } from "./ua_object_type";
-import { UAReferenceType } from "./ua_reference_type";
-import { UAVariable } from "./ua_variable";
-import { UAVariableType } from "./ua_variable_type";
-import { BindVariableOptions } from "./bind_variable";
-import { UAView } from "./ua_view";
-import { UAEventType } from "./ua_event_type";
-import { UAMethod } from "./ua_method";
+import type { UInt32 } from "node-opcua-basic-types";
+import type { AccessRestrictionsFlag, LocalizedTextLike, NodeClass, QualifiedNameLike } from "node-opcua-data-model";
+import type { DataValueOptions } from "node-opcua-data-value";
+import type { NodeId, NodeIdLike } from "node-opcua-nodeid";
+import type { ArgumentOptions, AxisInformationOptions, AxisScaleEnumeration, EnumFieldOptions, EUInformationOptions, RangeOptions, RolePermissionType, RolePermissionTypeOptions, StructureFieldOptions } from "node-opcua-types";
+import type { VariantLike } from "node-opcua-variant";
+import type { IAddressSpace } from "./address_space";
+import type { AddReferenceOpts, BaseNode, ConstructNodeIdOptions } from "./base_node";
+import type { BindVariableOptions } from "./bind_variable";
+import type { ModellingRuleType } from "./modelling_rule_type";
+import type { UADataType } from "./ua_data_type";
+import type { UAEventType } from "./ua_event_type";
+import type { UAMethod } from "./ua_method";
+import type { UAObject } from "./ua_object";
+import type { UAObjectType } from "./ua_object_type";
+import type { UAReferenceType } from "./ua_reference_type";
+import type { UAVariable } from "./ua_variable";
+import type { UAVariableType } from "./ua_variable_type";
+import type { UAView } from "./ua_view";
 export interface CreateNodeOptions {
     addressSpace?: IAddressSpace;
     browseName: QualifiedNameLike;
@@ -258,7 +258,7 @@ export declare interface INamespace {
     addVariable(options: AddVariableOptions): UAVariable;
     addObject(options: AddObjectOptions): UAObject;
     addView(options: AddViewOptions): UAView;
-    addFolder(parentFolder: NodeIdLike | UAObject, options: any): UAObject;
+    addFolder(parentFolder: NodeIdLike | UAObject, options: AddBaseNodeOptions | string): UAObject;
     createNode(options: CreateNodeOptions): BaseNode;
     /** @private */
     internalCreateNode(options: CreateNodeOptions): BaseNode;

package/dist/session_context.d.ts

@@ -1,13 +1,13 @@
-import { Certificate } from "node-opcua-crypto/web";
-import { DataValue } from "node-opcua-data-value";
-import { PreciseClock } from "node-opcua-date-time";
-import { NodeId, NodeIdLike } from "node-opcua-nodeid";
-import { MessageSecurityMode, PermissionType, ReferenceDescription, UserIdentityToken } from "node-opcua-types";
-import { StatusCode } from "node-opcua-status-code";
-import { ContinuationPoint } from "./continuation_point";
-import { BaseNode } from "./base_node";
-import { UAObject } from "./ua_object";
-import { UAObjectType } from "./ua_object_type";
+import type { Certificate } from "node-opcua-crypto/web";
+import type { DataValue } from "node-opcua-data-value";
+import type { PreciseClock } from "node-opcua-date-time";
+import type { NodeId, NodeIdLike } from "node-opcua-nodeid";
+import type { StatusCode } from "node-opcua-status-code";
+import type { MessageSecurityMode, PermissionType, ReferenceDescription, UserIdentityToken } from "node-opcua-types";
+import type { BaseNode } from "./base_node";
+import type { ContinuationPoint } from "./continuation_point";
+import type { UAObject } from "./ua_object";
+import type { UAObjectType } from "./ua_object_type";
 export declare function getContextMaxMessageSize(context: ISessionContext): number;
 export interface ITransportSettings {
     maxMessageSize: number;
@@ -46,6 +46,8 @@ export interface ContinuationPointData {
 export interface ISessionContext {
     /** The underlying OPC UA session, if available. */
     readonly session?: ISessionBase;
+    /** Returns the user name of the current user. */
+    getUserName(): string;
     /** Returns the NodeIds of all roles assigned to the current user. */
     getCurrentUserRoles(): NodeId[];
     /** Check whether the current user has the given permission on a node. */
@@ -60,8 +62,6 @@ export interface ISessionContext {
     object?: UAObject | UAObjectType;
     /** Server timestamp at the time the request was received. */
     currentTime?: PreciseClock;
-    /** Display name of the authenticated user (e.g. "anonymous"). */
-    readonly userIdentity?: string;
     /**
      * The client's application-instance certificate,
      * or `null` if no secure channel is available.
@@ -73,4 +73,12 @@ export interface ISessionContext {
      * unavailable.
      */
     readonly clientApplicationUri: string | null;
+    /**
+     * Returns a JSON representation of the context
+     */
+    toJSON(): Record<string, string | null>;
+    /**
+     * Returns a string representation of the context
+     */
+    toString(): string;
 }

package/dist/session_context.js.map

@@ -1 +1 @@
-{"version":3,"file":"session_context.js","sourceRoot":"","sources":["../source/session_context.ts"],"names":[],"mappings":";;AAYA,4DAIC;AAJD,SAAgB,wBAAwB,CAAC,OAAwB;IAC7D,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,oBAAoB;QAAE,OAAO,CAAC,CAAC;IAC9D,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,oBAAoB,EAAE,CAAC;IAC3D,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;AACpC,CAAC"}
+{"version":3,"file":"session_context.js","sourceRoot":"","sources":["../source/session_context.ts"],"names":[],"mappings":";;AAWA,4DAIC;AAJD,SAAgB,wBAAwB,CAAC,OAAwB;IAC7D,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,oBAAoB;QAAE,OAAO,CAAC,CAAC;IAC9D,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,oBAAoB,EAAE,CAAC;IAC3D,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;AACpC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-opcua-address-space-base",
-    "version": "2.167.0",
+    "version": "2.169.0",
     "description": "pure nodejs OPCUA SDK - module address-space-base",
     "main": "./dist/index.js",
     "types": "./dist/index.d.ts",
@@ -18,20 +18,20 @@
     },
     "dependencies": {
         "node-opcua-assert": "2.164.0",
-        "node-opcua-basic-types": "2.167.0",
+        "node-opcua-basic-types": "2.169.0",
         "node-opcua-constants": "2.157.0",
-        "node-opcua-crypto": "5.3.3",
-        "node-opcua-data-model": "2.167.0",
-        "node-opcua-data-value": "2.167.0",
-        "node-opcua-date-time": "2.167.0",
-        "node-opcua-debug": "2.165.0",
-        "node-opcua-extension-object": "2.167.0",
-        "node-opcua-nodeid": "2.167.0",
-        "node-opcua-numeric-range": "2.167.0",
-        "node-opcua-schemas": "2.167.0",
-        "node-opcua-status-code": "2.167.0",
-        "node-opcua-types": "2.167.0",
-        "node-opcua-variant": "2.167.0"
+        "node-opcua-crypto": "5.3.5",
+        "node-opcua-data-model": "2.169.0",
+        "node-opcua-data-value": "2.169.0",
+        "node-opcua-date-time": "2.169.0",
+        "node-opcua-debug": "2.168.0",
+        "node-opcua-extension-object": "2.169.0",
+        "node-opcua-nodeid": "2.169.0",
+        "node-opcua-numeric-range": "2.169.0",
+        "node-opcua-schemas": "2.169.0",
+        "node-opcua-status-code": "2.169.0",
+        "node-opcua-types": "2.169.0",
+        "node-opcua-variant": "2.169.0"
     },
     "author": "Etienne Rossignon",
     "license": "MIT",
@@ -48,7 +48,7 @@
         "internet of things"
     ],
     "homepage": "http://node-opcua.github.io/",
-    "gitHead": "5decfa86ee53a36ecd3bb454e7bf6e3dd27c7a4e",
+    "gitHead": "82d570d3e95bea689cbbe30096279885c5282245",
     "files": [
         "dist",
         "source"

package/source/namespace.ts

@@ -1,45 +1,42 @@
-import { QualifiedNameLike, AccessRestrictionsFlag, LocalizedTextLike, NodeClass, QualifiedNameOptions } from "node-opcua-data-model";
-import { NodeId, NodeIdLike } from "node-opcua-nodeid";
-import {
+import type { UInt32 } from "node-opcua-basic-types";
+import type { AccessRestrictionsFlag, LocalizedTextLike, NodeClass, QualifiedNameLike } from "node-opcua-data-model";
+import type { DataValueOptions } from "node-opcua-data-value";
+import type { NodeId, NodeIdLike } from "node-opcua-nodeid";
+import type {
     ArgumentOptions,
     AxisInformationOptions,
     AxisScaleEnumeration,
     EnumFieldOptions,
-    EUInformation,
     EUInformationOptions,
     RangeOptions,
     RolePermissionType,
     RolePermissionTypeOptions,
     StructureFieldOptions
 } from "node-opcua-types";
-import { DataType, VariantArrayType, VariantLike } from "node-opcua-variant";
-import { StatusCode, StatusCodeCallback, UInt32 } from "node-opcua-basic-types";
-import { DataValue, DataValueOptions } from "node-opcua-data-value";
-
-import { IAddressSpace } from "./address_space";
-import { AddReferenceOpts, BaseNode, ConstructNodeIdOptions } from "./base_node";
-import { ModellingRuleType } from "./modelling_rule_type";
-import { UADataType } from "./ua_data_type";
-import { UAObject } from "./ua_object";
-import { UAObjectType } from "./ua_object_type";
-import { UAReferenceType } from "./ua_reference_type";
-import { UAVariable } from "./ua_variable";
-import { UAVariableType } from "./ua_variable_type";
-import { BindVariableOptions, BindVariableOptionsVariation1, HistoryReadFunc } from "./bind_variable";
-import { UAView } from "./ua_view";
-import { UAEventType } from "./ua_event_type";
-import { UAMethod } from "./ua_method";
-
+import type { VariantLike } from "node-opcua-variant";
+
+import type { IAddressSpace } from "./address_space";
+import type { AddReferenceOpts, BaseNode, ConstructNodeIdOptions } from "./base_node";
+import type { BindVariableOptions } from "./bind_variable";
+import type { ModellingRuleType } from "./modelling_rule_type";
+import type { UADataType } from "./ua_data_type";
+import type { UAEventType } from "./ua_event_type";
+import type { UAMethod } from "./ua_method";
+import type { UAObject } from "./ua_object";
+import type { UAObjectType } from "./ua_object_type";
+import type { UAReferenceType } from "./ua_reference_type";
+import type { UAVariable } from "./ua_variable";
+import type { UAVariableType } from "./ua_variable_type";
+import type { UAView } from "./ua_view";
 
 export interface CreateNodeOptions {
-
     addressSpace?: IAddressSpace;
-    browseName:  QualifiedNameLike;
-    nodeId? : NodeIdLike | BaseNode | null ;
+    browseName: QualifiedNameLike;
+    nodeId?: NodeIdLike | BaseNode | null;
     nodeClass?: NodeClass;
 
     displayName?: LocalizedTextLike | LocalizedTextLike[] | null;
-    description?: LocalizedTextLike |  null;
+    description?: LocalizedTextLike | null;
 
     rolePermissions?: RolePermissionTypeOptions[];
 
@@ -51,8 +48,8 @@ export interface CreateNodeOptions {
     notifierOf?: NodeIdLike | BaseNode | null;
     organizedBy?: NodeIdLike | BaseNode | null;
     propertyOf?: NodeIdLike | BaseNode | null;
-    
-    subtypeOf?: NodeIdLike | string | BaseNode |null;
+
+    subtypeOf?: NodeIdLike | string | BaseNode | null;
 
     isAbstract?: boolean;
 
@@ -61,8 +58,8 @@ export interface CreateNodeOptions {
     modellingRule?: ModellingRuleType;
     eventNotifier?: number;
 
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     postInstantiateFunc?: (instance: BaseNode, tpyeNode: BaseNode, opts?: any) => void;
-   
 }
 export interface AddBaseNodeOptions {
     browseName: QualifiedNameLike;
@@ -232,7 +229,7 @@ export interface VariableStuff {
     dataValue?: DataValueOptions;
 }
 
-export interface AddVariableOptionsWithoutValue extends AddBaseNodeOptions, VariableStuff {}
+export interface AddVariableOptionsWithoutValue extends AddBaseNodeOptions, VariableStuff { }
 export interface AddVariableOptions extends AddVariableOptionsWithoutValue {
     // default value is "BaseVariableType";
     typeDefinition?: string | NodeId | UAVariableType;
@@ -283,8 +280,6 @@ export interface AddYArrayItemOptions extends AddVariableOptions {
     xAxisDefinition?: AxisInformationOptions;
 }
 
-
-
 export interface RequiredModel {
     modelUri: string;
     version: string;
@@ -339,7 +334,7 @@ export declare interface INamespace {
 
     addView(options: AddViewOptions): UAView;
 
-    addFolder(parentFolder: NodeIdLike | UAObject, options: any): UAObject;
+    addFolder(parentFolder: NodeIdLike | UAObject, options: AddBaseNodeOptions | string): UAObject;
 
     createNode(options: CreateNodeOptions): BaseNode;
 

package/source/session_context.ts

@@ -1,14 +1,13 @@
-import { Certificate } from "node-opcua-crypto/web";
-import { DataValue } from "node-opcua-data-value";
-import { PreciseClock } from "node-opcua-date-time";
-import { NodeId, NodeIdLike } from "node-opcua-nodeid";
-import { MessageSecurityMode, PermissionType, ReferenceDescription, UserIdentityToken } from "node-opcua-types";
-import { StatusCode } from "node-opcua-status-code";
-
-import { ContinuationPoint } from "./continuation_point";
-import { BaseNode } from "./base_node";
-import { UAObject } from "./ua_object";
-import { UAObjectType } from "./ua_object_type";
+import type { Certificate } from "node-opcua-crypto/web";
+import type { DataValue } from "node-opcua-data-value";
+import type { PreciseClock } from "node-opcua-date-time";
+import type { NodeId, NodeIdLike } from "node-opcua-nodeid";
+import type { StatusCode } from "node-opcua-status-code";
+import type { MessageSecurityMode, PermissionType, ReferenceDescription, UserIdentityToken } from "node-opcua-types";
+import type { BaseNode } from "./base_node";
+import type { ContinuationPoint } from "./continuation_point";
+import type { UAObject } from "./ua_object";
+import type { UAObjectType } from "./ua_object_type";
 
 export function getContextMaxMessageSize(context: ISessionContext): number {
     if (!context.session?.channel?.getTransportSettings) return 0;
@@ -67,6 +66,9 @@ export interface ISessionContext {
     /** The underlying OPC UA session, if available. */
     readonly session?: ISessionBase;
 
+    /** Returns the user name of the current user. */
+    getUserName(): string;
+
     /** Returns the NodeIds of all roles assigned to the current user. */
     getCurrentUserRoles(): NodeId[];
 
@@ -88,9 +90,6 @@ export interface ISessionContext {
     /** Server timestamp at the time the request was received. */
     currentTime?: PreciseClock;
 
-    /** Display name of the authenticated user (e.g. "anonymous"). */
-    readonly userIdentity?: string;
-
     /**
      * The client's application-instance certificate,
      * or `null` if no secure channel is available.
@@ -103,4 +102,14 @@ export interface ISessionContext {
      * unavailable.
      */
     readonly clientApplicationUri: string | null;
+
+    /**
+     * Returns a JSON representation of the context
+     */
+    toJSON(): Record<string, string | null>;
+
+    /**
+     * Returns a string representation of the context
+     */
+    toString(): string;
 }