node-opcua-address-space 2.179.0 → 2.181.0

package/dist/api/interfaces/data_access/ua_two_state_discrete_ex.d.ts

@@ -0,0 +1,13 @@
+import type { UAVariableT } from "node-opcua-address-space-base";
+import type { LocalizedTextLike } from "node-opcua-data-model";
+import type { UATwoStateDiscrete_Base } from "node-opcua-nodeset-ua";
+import type { DataType } from "node-opcua-variant";
+import type { ISetStateOptions } from "../i_set_state_options.js";
+/**
+ * @see https://reference.opcfoundation.org/v104/Core/VariableTypes/TwoStateDiscreteType/
+ */
+export interface UATwoStateDiscreteEx extends UAVariableT<boolean, DataType.Boolean>, UATwoStateDiscrete_Base<boolean> {
+    getValue(): boolean;
+    getValueAsString(): string;
+    setValue(value: boolean | LocalizedTextLike, options?: ISetStateOptions): void;
+}

package/dist/api/interfaces/data_access/ua_two_state_discrete_ex.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ua_two_state_discrete_ex.js","sourceRoot":"","sources":["../../../../api/interfaces/data_access/ua_two_state_discrete_ex.ts"],"names":[],"mappings":""}

package/dist/api/interfaces/data_access/ua_y_array_item_ex.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ua_y_array_item_ex.js","sourceRoot":"","sources":["../../../../api/interfaces/data_access/ua_y_array_item_ex.ts"],"names":[],"mappings":""}

package/dist/api/interfaces/extension_object_constructor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extension_object_constructor.js","sourceRoot":"","sources":["../../../api/interfaces/extension_object_constructor.ts"],"names":[],"mappings":""}

package/dist/api/interfaces/i_condition_variable_type_setter_options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"i_condition_variable_type_setter_options.js","sourceRoot":"","sources":["../../../api/interfaces/i_condition_variable_type_setter_options.ts"],"names":[],"mappings":""}

package/dist/api/interfaces/i_set_state_options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"i_set_state_options.js","sourceRoot":"","sources":["../../../api/interfaces/i_set_state_options.ts"],"names":[],"mappings":""}

package/dist/api/interfaces/nodeset_loader_options.d.ts

@@ -0,0 +1,56 @@
+/**
+ * how a part of the access policy declared in a NodeSet2 file is handled at load time.
+ *
+ *  - `"apply"`  : the declaration is installed on the node, as mandated by OPC UA Part 6 F.3.
+ *  - `"ignore"` : the declaration is discarded. This is what node-opcua did before these options
+ *                 existed: a nodeset declaring a restrictive policy would load fail-open.
+ */
+import type { NodesetImageStore } from "../loader/nodeset_image_store.js";
+export type NodeSetPermissionsPolicy = "apply" | "ignore";
+export interface NodeSetLoaderOptions {
+    loadDraftNodes?: boolean;
+    loadDeprecatedNodes?: boolean;
+    /**
+     * the `<RolePermissions>` element and the `HasNoPermissions` attribute: *who* may do *what*.
+     *
+     * This is a property of the information model, so it applies by default. `HasNoPermissions`
+     * yields an empty permission list, which is distinct from an absent `<RolePermissions>`:
+     * the former grants nothing, the latter inherits the namespace default.
+     * @default "apply"
+     */
+    permissions?: NodeSetPermissionsPolicy;
+    /**
+     * the `AccessRestrictions` attribute: how the SecureChannel must be secured — signed,
+     * encrypted, session-bound — before the node may be reached at all.
+     *
+     * This one is **opt-in**, because it is a property of the deployment rather than of the
+     * model, and node-opcua cannot assume the deployment matches what the nodeset author had
+     * in mind. `Opc.Ua.NodeSet2.xml` carries 359 of these, and enforcing them denies 199
+     * variables under the Server Object alone — the RoleSet internals, `ServerConfiguration`,
+     * method arguments — to any Session on an unsecured channel. That is the correct reading
+     * of the attribute, and exactly what you want on a hardened server; it is also a large
+     * behaviour change for the many deployments that run with `MessageSecurityMode.None`.
+     *
+     * Turn it on once your endpoints require signing or encryption.
+     * @default "ignore"
+     */
+    accessRestrictions?: NodeSetPermissionsPolicy;
+    /**
+     * how much text the loader parses between two turns of the event loop, in characters, when
+     * a nodeset arrives as a stream: a server starting up keeps answering while a large model
+     * loads. A chunk is parsed whole, so a source delivered in one piece never yields. Zero
+     * disables the yield.
+     * @default 8388608 (8 MiB)
+     */
+    yieldEveryBytes?: number;
+    /**
+     * where precompiled images of the documents are kept between loads. With a store, a
+     * document given whole (a path, a string, bytes) is hashed and its image replayed when the
+     * store has it, parsed and written otherwise; a stream is parsed and written, and replayed
+     * only when its named source carries an `imageKey`. `true` selects the default store: the
+     * per-user file store of the Node.js `generateAddressSpace`, a memory store elsewhere. An
+     * image the store returns that fails to read is discarded and rebuilt.
+     * @default undefined (no store)
+     */
+    imageStore?: NodesetImageStore | boolean;
+}

package/dist/api/interfaces/nodeset_loader_options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nodeset_loader_options.js","sourceRoot":"","sources":["../../../api/interfaces/nodeset_loader_options.ts"],"names":[],"mappings":""}

package/dist/api/interfaces/state_machine/ua_exclusive_limit_state_machine_type_ex.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @module node-opcua-address-space
+ */
+import type { InstantiateObjectOptions, UAObject } from "node-opcua-address-space-base";
+import type { UAExclusiveLimitStateMachine_Base } from "node-opcua-nodeset-ua";
+import type { UAStateMachineEx, UAStateMachineHelper, UAStateMachineType } from "./ua_state_machine_type.js";
+export interface UAExclusiveLimitStateMachineEx extends UAObject, Omit<UAExclusiveLimitStateMachine_Base, "currentState" | "lastTransition">, UAStateMachineHelper, UAStateMachineEx {
+}
+export interface UAExclusiveLimitStateMachineType extends UAStateMachineType {
+    isAbstract: false;
+    instantiate(options: InstantiateObjectOptions): UAExclusiveLimitStateMachineEx;
+}

package/dist/api/interfaces/state_machine/ua_exclusive_limit_state_machine_type_ex.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ua_exclusive_limit_state_machine_type_ex.js","sourceRoot":"","sources":["../../../../api/interfaces/state_machine/ua_exclusive_limit_state_machine_type_ex.ts"],"names":[],"mappings":""}

package/dist/api/interfaces/state_machine/ua_finite_state_machine_type.d.ts

@@ -0,0 +1,49 @@
+/**
+ * @module node-opcua-address-space
+ */
+import type { InstantiateObjectOptions } from "node-opcua-address-space-base";
+import type { UAStateMachineEx, UAStateMachineType } from "./ua_state_machine_type.js";
+/**
+ * Finite State Machine
+ *
+ * The FiniteStateMachineType is the base ObjectType for StateMachines that explicitly define
+ * the possible States and Transitions. Once the States are defined subtypes shall not add new
+ * States (see B.4.18).
+ * The States of the machine are represented with instances of the StateType ObjectType.
+ *
+ * EachState shall have a BrowseName which is unique within the StateMachine and shall have a
+ * StateNumber which shall also be unique across all States defined in the StateMachine.
+ *
+ * Be aware that States in a SubStateMachine may have the same StateNumber or BrowseName as
+ * States in the parent machine. A concrete subtype of FiniteStateMachineType shall define at
+ * least one State.
+ *
+ * A StateMachine may define one State which is an instance of the InitialStateType. This State
+ * is the State that the machine goes into when it is activated.
+ *
+ * The Transitions that may occur are represented with instances of the TransitionType.
+ *
+ * Each Transition shall have a BrowseName which is unique within the StateMachine and may have a
+ * TransitionNumber which shall also be unique across all Transitions defined in the StateMachine.
+ *
+ * The initial State for a Transition is a StateType Object which is the target of a FromState
+ * Reference. The final State for a Transition is a StateType Object which is the target of a ToState
+ * Reference. The FromState and ToState References shall always be specified.
+ * A Transition may produce an Event. The Event is indicated by a HasEffect Reference to a
+ * subtype of BaseEventType. The StateMachineType shall have GeneratesEvent References to
+ * the targets of a HasEffect Reference for each of its Transitions.
+ * A FiniteStateMachineType may define Methods that cause a transition to occur. These Methods
+ * are targets of HasCause References for each of the Transitions that may be triggered by the
+ * Method. The Executable Attribute for a Method is used to indicate whether the current State of
+ * the machine allows the Method to be called.
+ *
+ * A FiniteStateMachineType may have sub-state-machines which are represented as instances
+ * of StateMachineType ObjectTypes. Each State shall have a HasSubStateMachine Reference
+ * to the StateMachineType Object which represents the child States. The SubStateMachine is
+ * not active if the parent State is not active. In this case the CurrentState and LastTransition
+ * Variables of the SubStateMachine shall have a status equal to BadStateNotActive (see Table
+ * B.17).
+ */
+export interface UAFiniteStateMachineType extends UAStateMachineType {
+    instantiate(options: InstantiateObjectOptions): UAStateMachineEx;
+}

package/dist/api/interfaces/state_machine/ua_finite_state_machine_type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ua_finite_state_machine_type.js","sourceRoot":"","sources":["../../../../api/interfaces/state_machine/ua_finite_state_machine_type.ts"],"names":[],"mappings":""}

package/dist/api/interfaces/state_machine/ua_program_state_machine_type.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @module node-opcua-address-space
+ */
+import type { InstantiateObjectOptions, UAObjectType } from "node-opcua-address-space-base";
+import type { UAProgramStateMachine_Base } from "node-opcua-nodeset-ua";
+import type { UAStateMachineEx } from "./ua_state_machine_type.js";
+export interface UAProgramStateMachineEx extends UAStateMachineEx {
+}
+export interface UAProgramStateMachineType extends UAProgramStateMachine_Base, UAObjectType {
+    instantiate(options: InstantiateObjectOptions): UAProgramStateMachineEx;
+}

package/dist/api/interfaces/state_machine/ua_program_state_machine_type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ua_program_state_machine_type.js","sourceRoot":"","sources":["../../../../api/interfaces/state_machine/ua_program_state_machine_type.ts"],"names":[],"mappings":""}

package/dist/api/interfaces/state_machine/ua_shelved_state_machine_ex.d.ts

@@ -0,0 +1,29 @@
+import type { UAMethod, UAProperty } from "node-opcua-address-space-base";
+import type { DataType } from "node-opcua-basic-types";
+import type { UAShelvedStateMachine_Base, UAState } from "node-opcua-nodeset-ua";
+import type { UAStateMachineEx } from "./ua_state_machine_type.js";
+import type { UATransitionEx } from "./ua_transition_ex.js";
+export interface UAShelvedStateMachineHelper {
+    _timer: NodeJS.Timeout | null;
+    _shelvedTime: Date;
+    _unshelvedTime: Date;
+    _duration: number;
+}
+export interface UAShelvedStateMachineEx extends Omit<UAShelvedStateMachine_Base, "currentState" | "lastTransition">, UAStateMachineEx, UAShelvedStateMachineHelper {
+    unshelveTime: UAProperty<number, /*z*/ DataType.Double>;
+    unshelved: UAState;
+    timedShelved: UAState;
+    oneShotShelved: UAState;
+    unshelvedToTimedShelved: UATransitionEx;
+    unshelvedToOneShotShelved: UATransitionEx;
+    timedShelvedToUnshelved: UATransitionEx;
+    timedShelvedToOneShotShelved: UATransitionEx;
+    oneShotShelvedToUnshelved: UATransitionEx;
+    oneShotShelvedToTimedShelved: UATransitionEx;
+    timedShelve: UAMethod;
+    timedShelve2?: UAMethod;
+    unshelve: UAMethod;
+    unshelve2?: UAMethod;
+    oneShotShelve: UAMethod;
+    oneShotShelve2?: UAMethod;
+}

package/dist/api/interfaces/state_machine/ua_shelved_state_machine_ex.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ua_shelved_state_machine_ex.js","sourceRoot":"","sources":["../../../../api/interfaces/state_machine/ua_shelved_state_machine_ex.ts"],"names":[],"mappings":""}

package/dist/api/interfaces/state_machine/ua_state_machine_type.d.ts

@@ -0,0 +1,236 @@
+/**
+ * @module node-opcua-address-space
+ */
+import type { InstantiateObjectOptions, UAObject, UAObjectType, UAProperty, UAReferenceType, UAVariableTypeT } from "node-opcua-address-space-base";
+import type { DateTime, UInt32 } from "node-opcua-basic-types";
+import type { LocalizedText } from "node-opcua-data-model";
+import type { UAInitialState, UAInitialState_Base, UAState, UAState_Base, UAStateMachine_Base, UATransition_Base, UATransitionEvent_Base } from "node-opcua-nodeset-ua";
+import type { DataType } from "node-opcua-variant";
+import type { UATransitionEx } from "./ua_transition_ex.js";
+export type UtcTime = DateTime;
+export interface NonHierarchicalReferences extends UAReferenceType {
+}
+export interface UAStateVariableType extends UAVariableTypeT<LocalizedText, DataType.LocalizedText> {
+    isAbstract: false;
+}
+export interface StateB {
+    stateNumber: UAProperty<UInt32, DataType.UInt32>;
+}
+export interface UAStateType extends UAState_Base, UAObjectType {
+}
+/** empty interface */
+export interface UATransitionType extends UATransition_Base, UAObjectType {
+}
+/**
+ * Initial State Type
+ *
+ * The InitialStateType is a subtype of the StateType and is formally defined in Table B.8.
+ * An Object of the InitialStateType represents the State that a FiniteStateMachine enters
+ * when it is activated.
+ *
+ * Each FiniteStateMachine can have at most one State of type InitialStateType, but
+ * a FiniteStateMachine does not have to have a State of this type.
+ *
+ * A SubStateMachine goes into its initial state whenever the parent state is entered. However, a
+ * state machine may define a transition that goes directly to a state of the SubStateMachine. In
+ * this case the SubStateMachine goes into that State instead of the initial State. The two
+ * scenarios are illustrated in Figure B.4. The transition from State5 to State6 causes the
+ * SubStateMachine to go into the initial State (State7), however, the transition from State4 to
+ * State8 causes the parent machine to go to State6 and the SubStateMachine will go to State8.
+ *
+ * If no initial state for a SubStateMachine exists and the State having the SubStateMachine is
+ * entered directly, then the State of the SubStateMachine is server-specific.
+ */
+export interface UAInitialStateType extends UAInitialState_Base, UAStateType {
+}
+/**
+ * ToState Reference Type
+ *
+ * The ToState ReferenceType is a concrete ReferenceType and can be used directly. It is a
+ * subtype of NonHierarchicalReferences.
+ *
+ * The semantic of this ReferenceType is to point form a Transition to the ending State the
+ * Transition connects.
+ *
+ * The SourceNode of this ReferenceType shall be an Object of the ObjectType TransitionType or
+ * one of its subtypes. The TargetNode of this ReferenceType shall be an Object of the ObjectType
+ * StateType or one of its subtypes.
+ *
+ * References of this ReferenceType may be only exposed uni-directional. Sometimes this is
+ * required, for example, if a Transition points to a State of a sub-machine.
+ */
+export interface ToStateReferenceType extends NonHierarchicalReferences {
+}
+/**
+ *
+ * FromState Reference Type
+ *
+ * The FromState ReferenceType is a concrete ReferenceType and can be used directly. It is a
+ * subtype of NonHierarchicalReferences.
+ *
+ * The semantic of this ReferenceType is to point form a Transition to the starting State the
+ * Transition connects.
+ *
+ * The SourceNode of this ReferenceType shall be an Object of the ObjectType TransitionType or
+ * one of its subtypes. The TargetNode of this ReferenceType shall be an Object of the ObjectType
+ * StateType or one of its subtypes.
+ */
+export interface FromStateReferenceType extends NonHierarchicalReferences {
+}
+/**
+ * HasCause
+ * The HasCause ReferenceType is a concrete ReferenceType and can be used directly. It is a
+ * subtype of NonHierarchicalReferences.
+ *
+ * The semantic of this ReferenceType is to point form a Transition to something that causes the
+ * Transition. In this annex we only define Methods as Causes. However, the ReferenceType is
+ * not restricted to point to Methods. The referenced Methods can, but do not have to point to a
+ * Method of the StateMachineType. For example, it is allowed to point to a server-wide restart
+ * Method leading the state machine to go into its initial state.
+ *
+ * The SourceNode of this ReferenceType shall be an Object of the ObjectType TransitionType or
+ * one of its subtypes. The TargetNode can be of any NodeClass
+ */
+export interface HasCauseReferenceType extends NonHierarchicalReferences {
+}
+/**
+ * HasEffect ReferenceType
+ *
+ * The HasEffect ReferenceType is a concrete ReferenceType and can be used directly. It is a
+ * subtype of NonHierarchicalReferences.
+ * The semantic of this ReferenceType is to point form a Transition to something that will be
+ * effected when the Transition is triggered. In this annex we only define EventTypes as Effects.
+ *
+ * However, the ReferenceType is not restricted to point to EventTypes.
+ *
+ * The SourceNode of this ReferenceType shall be an Object of the ObjectType TransitionType or
+ * one of its subtypes. The TargetNode can be of any NodeClass.
+ */
+export interface HasEffectReferenceType extends NonHierarchicalReferences {
+}
+/**
+ * The HasSubStateMachine ReferenceType is a concrete ReferenceType and can be used
+ * directly. It is a subtype of NonHierarchicalReferences.
+ *
+ * The semantic of this ReferenceType is to point from a State to an instance of
+ * StateMachineType which represents the sub-states for the State.
+ *
+ * The SourceNode of this ReferenceType shall be an Object of the ObjectType StateType.
+ *
+ * The TargetNode shall be an Object of the ObjectType StateMachineType or one of its subtypes.
+ *
+ * Each Object can be the TargetNode of at most one HasSubStateMachine Reference.
+ *
+ * The SourceNode (the state) and the TargetNode (the SubStateMachine) shall belong to the
+ * same StateMachine, that is, both shall be referenced from the same Object of type
+ * StateMachineType using a HasComponent Reference or a subtype of HasComponent.
+ */
+export interface HasSubStateMachine extends NonHierarchicalReferences {
+}
+/**
+ * The TransitionEventType is a subtype of the BaseEventType. It can be used to generate an
+ * Event identifying that a Transition of a StateMachine was triggered.
+ *
+ * The TransitionEventType inherits the Properties of the BaseEventType.
+ *
+ * The inherited Property SourceNode shall be filled with the NodeId of the StateMachine instance
+ * where the Transition occurs. If the Transition occurs in a SubStateMachine, then the NodeId of
+ * the SubStateMachine has to be used. If the Transition occurs between a StateMachine and a
+ * SubStateMachine, then the NodeId of the StateMachine has to be used, independent of the
+ * direction of the Transition.
+ */
+export interface UATransitionEventType extends UATransitionEvent_Base, UAObjectType {
+}
+export type TransitionSelector = (transitions: UATransitionEx[], fromState: UAState, toState: UAState) => UATransitionEx | null;
+/**
+ * State Machine type
+ *
+ * StateMachines produce Events which may include the current state of a StateMachine. In that
+ * case Servers shall provide all the optional Properties of the StateVariableType in the Event,
+ * even if they are not provided on the instances in the address space.
+ */
+/**
+ * StateMachineType
+ *
+ * The StateMachineType is the base ObjectType for all StateMachineTypes. It defines a single
+ * Variable which represents the current state of the machine.
+ * An instance of this ObjectType shall generate an Event whenever a significant state change occurs.
+ * The Server decides which state changes are significant. Servers shall use the GeneratesEvent
+ * ReferenceType to indicate which Event(s) could be produced by the StateMachine.
+ *
+ * Subtypes may add Methods which affect the state of the machine. The Executable Attribute is
+ * used to indicate whether the Method is valid given the current state of the machine. The
+ * generation of AuditEvents for Methods is defined in Part 4. A StateMachine may not be active.
+ *
+ * In this case, the CurrentState and LastTransition Variables shall have a status equal to
+ * BadStateNotActive (see Table B.17).
+ *
+ * Subtypes may add components which are instances of StateMachineTypes. These components
+ * are considered to be sub-states of the StateMachine. SubStateMachines are only active when
+ * the parent machine is in an appropriate state.
+ * Events produced by SubStateMachines may be suppressed by the parent machine. In some
+ * cases, the parent machine will produce a single Event that reflects changes in multiple
+ * SubStateMachines
+ */
+export interface UAStateMachineHelper {
+    readonly initialState: UAInitialState | null;
+    readonly states: UAState[];
+    readonly transitions: UATransitionEx[];
+    currentStateNode: UAState | null;
+    /**
+     * return all state nodes associated with this state machine
+     */
+    getStates(): UAState[];
+    /**
+     * return all state to state transition node associated with this state machine
+     */
+    getTransitions(): UATransitionEx[];
+    /**
+     * return the state Node by Name
+     * @param name
+     */
+    getStateByName(name: string): UAState | null;
+    /**
+     * returns true if there is a valid transition from currentStateNode to toStateNode
+     * @param toStateNode
+     */
+    isValidTransition(toStateNode: UAState | string, predicate?: TransitionSelector): boolean;
+    /**
+     * try to find the valid transition between fromState Node to toState Node
+     * @param fromStateNode
+     * @param toStateNode
+     */
+    findTransitionNode(fromStateNode: UAState, toStateNode: UAState, predicate?: TransitionSelector): UATransitionEx | null;
+    /**
+     * return the current state as string
+     */
+    getCurrentState(): string | null;
+    /**
+     * change the current state
+     *
+     * note:
+     *  - a transition from currentState to toState node must exists
+     * - a TransitionEventType event will be raised
+     * @param toStateNode
+     */
+    setState(toStateNode: UAState | string | null, predicate?: TransitionSelector): void;
+}
+export interface UAStateMachineEx extends UAObject, UAStateMachineHelper, UAStateMachine_Base {
+    _currentStateNode: UAState | null;
+}
+export interface UAStateMachineTypeHelper extends UAObjectType {
+    /**
+     * return all state nodes associated with this state machine
+     */
+    getStates(): UAState[];
+    /**
+     * return all state to state transition node associated with this state machine
+     */
+    getTransitions(): UATransitionEx[];
+    getStateByName(name: string): UAState | null;
+}
+export interface UAStateMachineType extends UAObjectType, UAStateMachineTypeHelper, UAStateMachine_Base {
+    instantiate(options: InstantiateObjectOptions): UAStateMachineEx;
+}
+export declare function promoteToStateMachineType(node: UAObjectType): UAStateMachineType;
+export declare function promoteToStateMachine(node: UAObject): UAStateMachineEx;

package/dist/api/interfaces/state_machine/ua_state_machine_type.js.map

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

package/dist/api/interfaces/state_machine/ua_transition_ex.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ua_transition_ex.js","sourceRoot":"","sources":["../../../../api/interfaces/state_machine/ua_transition_ex.ts"],"names":[],"mappings":""}

package/dist/api/interfaces/ua_subscription_diagnostics_variable_ex.js.map

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

package/dist/api/loader/decode_xml_extension_object.d.ts

@@ -0,0 +1,6 @@
+import type { IAddressSpace } from "node-opcua-address-space-base";
+import type { ExtensionObject } from "node-opcua-extension-object";
+import type { NodeId } from "node-opcua-nodeid";
+import { type DefinitionMap2 } from "./make_xml_extension_object_parser.js";
+export declare function makeDefinitionMap(addressSpace: IAddressSpace): DefinitionMap2;
+export declare function decodeXmlExtensionObject(addressSpace: IAddressSpace, encodingNodeId: NodeId, xmlBody: string, translateNodeId: (nodeId: string) => NodeId): ExtensionObject | null;

package/dist/api/loader/decode_xml_extension_object.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeDefinitionMap = makeDefinitionMap;
+exports.decodeXmlExtensionObject = decodeXmlExtensionObject;
+const node_opcua_debug_1 = require("node-opcua-debug");
+const node_opcua_types_1 = require("node-opcua-types");
+const node_opcua_xml2json_1 = require("node-opcua-xml2json");
+const make_xml_extension_object_parser_js_1 = require("./make_xml_extension_object_parser.js");
+const doDebug = (0, node_opcua_debug_1.checkDebugFlag)("decode_xml_extension_object");
+const debugLog = (0, node_opcua_debug_1.make_debugLog)("decode_xml_extension_object");
+const _errorLog = (0, node_opcua_debug_1.make_errorLog)("decode_xml_extension_object");
+function encodingNodeIdToDataTypeNode(addressSpace, encodingNodeId) {
+    const encodingNode = addressSpace.findNode(encodingNodeId);
+    // c8 ignore next
+    if (!encodingNode) {
+        throw new Error(`findDataTypeNode:  Cannot find encoding NodeId${encodingNodeId.toString()}`);
+    }
+    const refs = encodingNode.findReferences("HasEncoding", false);
+    const dataTypes = refs.map((ref) => addressSpace.findNode(ref.nodeId)).filter((obj) => obj !== null);
+    // c8 ignore next
+    if (dataTypes.length !== 1) {
+        throw new Error("Internal Error");
+    }
+    const dataTypeNode = dataTypes[0];
+    return dataTypeNode;
+}
+function makeDefinitionMap(addressSpace) {
+    return {
+        findDefinition(dataTypeNodeId) {
+            const dataTypeNode = addressSpace.findDataType(dataTypeNodeId);
+            if (!dataTypeNode) {
+                throw new Error(`findDefinition: cannot find dataType ${dataTypeNodeId.toString()}`);
+            }
+            if (dataTypeNode.nodeClass !== node_opcua_types_1.NodeClass.DataType) {
+                throw new Error("Expecting a DataType node here");
+            }
+            const name = dataTypeNode.browseName.name || "";
+            if (dataTypeNode.isStructure()) {
+                const definition = dataTypeNode.getStructureDefinition();
+                return { name, definition };
+            }
+            else if (dataTypeNode.isEnumeration()) {
+                const definition = dataTypeNode.getEnumDefinition();
+                return { name, definition };
+            }
+            else {
+                const dataType = dataTypeNode.getBasicDataType();
+                return { name, definition: { dataType } };
+            }
+        }
+    };
+}
+function decodeXmlExtensionObject(addressSpace, encodingNodeId, xmlBody, translateNodeId) {
+    const definitionMap = makeDefinitionMap(addressSpace);
+    const dataType = encodingNodeIdToDataTypeNode(addressSpace, encodingNodeId);
+    //  const { name, definition } = definitionMap.findDefinition(dataType.nodeId);
+    // const hasOptionalFields = definition.fields!.some((field) => field.isOptional);
+    const reader = (0, make_xml_extension_object_parser_js_1.makeXmlExtensionObjectReader)(dataType.nodeId, definitionMap, new Map(), translateNodeId);
+    const parser2 = new node_opcua_xml2json_1.Xml2Json(reader);
+    const pojo = parser2.parseString(xmlBody);
+    const userDefinedExtensionObject = addressSpace.constructExtensionObject(dataType, pojo);
+    // c8 ignore next
+    if (doDebug) {
+        debugLog("userDefinedExtensionObject", userDefinedExtensionObject.toString());
+    }
+    //
+    return userDefinedExtensionObject;
+}
+//# sourceMappingURL=decode_xml_extension_object.js.map

package/dist/api/loader/decode_xml_extension_object.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"decode_xml_extension_object.js","sourceRoot":"","sources":["../../../api/loader/decode_xml_extension_object.ts"],"names":[],"mappings":";;AA8BA,8CAuBC;AACD,4DAyBC;AA9ED,uDAAgF;AAGhF,uDAA6C;AAC7C,6DAA+C;AAE/C,+FAAyH;AAEzH,MAAM,OAAO,GAAG,IAAA,iCAAc,EAAC,6BAA6B,CAAC,CAAC;AAC9D,MAAM,QAAQ,GAAG,IAAA,gCAAa,EAAC,6BAA6B,CAAC,CAAC;AAC9D,MAAM,SAAS,GAAG,IAAA,gCAAa,EAAC,6BAA6B,CAAC,CAAC;AAE/D,SAAS,4BAA4B,CAAC,YAA2B,EAAE,cAAsB;IACrF,MAAM,YAAY,GAAG,YAAY,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;IAE3D,iBAAiB;IACjB,IAAI,CAAC,YAAY,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,iDAAiD,cAAc,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IAClG,CAAC;IACD,MAAM,IAAI,GAAG,YAAY,CAAC,cAAc,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;IAC/D,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC;IACrG,iBAAiB;IACjB,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACtC,CAAC;IACD,MAAM,YAAY,GAAG,SAAS,CAAC,CAAC,CAAe,CAAC;IAChD,OAAO,YAAY,CAAC;AACxB,CAAC;AAED,SAAgB,iBAAiB,CAAC,YAA2B;IACzD,OAAO;QACH,cAAc,CAAC,cAAsB;YACjC,MAAM,YAAY,GAAG,YAAY,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC;YAC/D,IAAI,CAAC,YAAY,EAAE,CAAC;gBAChB,MAAM,IAAI,KAAK,CAAC,wCAAwC,cAAc,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YACzF,CAAC;YACD,IAAI,YAAY,CAAC,SAAS,KAAK,4BAAS,CAAC,QAAQ,EAAE,CAAC;gBAChD,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;YACtD,CAAC;YACD,MAAM,IAAI,GAAG,YAAY,CAAC,UAAU,CAAC,IAAI,IAAI,EAAE,CAAC;YAChD,IAAI,YAAY,CAAC,WAAW,EAAE,EAAE,CAAC;gBAC7B,MAAM,UAAU,GAAG,YAAY,CAAC,sBAAsB,EAAE,CAAC;gBACzD,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;YAChC,CAAC;iBAAM,IAAI,YAAY,CAAC,aAAa,EAAE,EAAE,CAAC;gBACtC,MAAM,UAAU,GAAG,YAAY,CAAC,iBAAiB,EAAE,CAAC;gBACpD,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;YAChC,CAAC;iBAAM,CAAC;gBACJ,MAAM,QAAQ,GAAG,YAAY,CAAC,gBAAgB,EAAE,CAAC;gBACjD,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,QAAQ,EAAE,EAAE,CAAC;YAC9C,CAAC;QACL,CAAC;KACJ,CAAC;AACN,CAAC;AACD,SAAgB,wBAAwB,CACpC,YAA2B,EAC3B,cAAsB,EACtB,OAAe,EACf,eAA2C;IAE3C,MAAM,aAAa,GAAG,iBAAiB,CAAC,YAAY,CAAC,CAAC;IAEtD,MAAM,QAAQ,GAAG,4BAA4B,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;IAE5E,+EAA+E;IAC/E,kFAAkF;IAElF,MAAM,MAAM,GAAG,IAAA,kEAA4B,EAAC,QAAQ,CAAC,MAAM,EAAE,aAAa,EAAE,IAAI,GAAG,EAAE,EAAE,eAAe,CAAC,CAAC;IACxG,MAAM,OAAO,GAAG,IAAI,8BAAQ,CAAC,MAAM,CAAC,CAAC;IACrC,MAAM,IAAI,GAAG,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAE1C,MAAM,0BAA0B,GAAG,YAAY,CAAC,wBAAwB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAEzF,iBAAiB;IACjB,IAAI,OAAO,EAAE,CAAC;QACV,QAAQ,CAAC,4BAA4B,EAAE,0BAA0B,CAAC,QAAQ,EAAE,CAAC,CAAC;IAClF,CAAC;IACD,EAAE;IACF,OAAO,0BAA0B,CAAC;AACtC,CAAC"}

package/dist/api/loader/ensure_datatype_extracted.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ensureDatatypeExtracted = ensureDatatypeExtracted;
+exports.ensureDatatypeExtractedWithCallback = ensureDatatypeExtractedWithCallback;
+const node_opcua_client_dynamic_extension_object_1 = require("node-opcua-client-dynamic-extension-object");
+const node_opcua_debug_1 = require("node-opcua-debug");
+const node_opcua_factory_1 = require("node-opcua-factory");
+const construct_namespace_dependency_js_1 = require("../../impl/nodeset_tools/construct_namespace_dependency.js");
+const pseudo_session_js_1 = require("../pseudo_session.js");
+const debugLog = (0, node_opcua_debug_1.make_debugLog)("ensure_datatype_extracted");
+const doDebug = (0, node_opcua_debug_1.checkDebugFlag)("ensure_datatype_extracted");
+function fixDefinition103(addressSpace, namespaceArray, dataTypeManager) {
+    // fix datatype _getDefinition();
+    for (let namespaceIndex = 1; namespaceIndex < namespaceArray.length; namespaceIndex++) {
+        const df = dataTypeManager.getDataTypeFactory(namespaceIndex);
+        for (const s of df.getStructureIterator()) {
+            const dataType = addressSpace.findDataType(s.schema.dataTypeNodeId);
+            if (!s.constructor) {
+                continue;
+            }
+            if (!dataType) {
+                continue;
+            }
+            if (dataType.$partialDefinition?.length) {
+                continue;
+            }
+            // debugLog(" Exploration", dataType.browseName.toString());
+            if (!dataType.$partialDefinition || (dataType.$partialDefinition.length === 0 && s.schema.fields?.length > 0)) {
+                const sd = (0, node_opcua_client_dynamic_extension_object_1.convertStructureTypeSchemaToStructureDefinition)(s.schema);
+                dataType.$partialDefinition = sd.fields || undefined;
+            }
+        }
+    }
+}
+async function ensureDatatypeExtracted(addressSpace) {
+    const addressSpacePriv = addressSpace;
+    if (!addressSpacePriv.$$extraDataTypeManager) {
+        const dataTypeManager = new node_opcua_client_dynamic_extension_object_1.ExtraDataTypeManager();
+        const namespaceArray = addressSpace.getNamespaceArray().map((n) => n.namespaceUri);
+        doDebug && debugLog("INamespace Array = ", namespaceArray.join("\n                   "));
+        dataTypeManager.setNamespaceArray(namespaceArray);
+        addressSpacePriv.$$extraDataTypeManager = dataTypeManager;
+        const factories = [(0, node_opcua_factory_1.getStandardDataTypeFactory)()];
+        const priorityTable = (0, construct_namespace_dependency_js_1.constructNamespacePriorityTable)(addressSpace).priorityTable;
+        for (let namespaceIndex = 1; namespaceIndex < namespaceArray.length; namespaceIndex++) {
+            const namespace = addressSpace.getNamespace(namespaceIndex);
+            if (doDebug) {
+                debugLog("namespaceIndex = ", namespaceIndex);
+                debugLog("namespace = ", namespace.namespaceUri);
+                debugLog("factories = ", factories.map((f) => f.targetNamespace).join(" "));
+                // find dependent namespaces
+                let dependency = (0, construct_namespace_dependency_js_1.constructNamespaceDependency)(namespace);
+                // remove last element that is my namespace
+                dependency = dependency.filter((ns) => ns.index !== namespaceIndex);
+                const dependFactories = dependency.map((ns) => {
+                    const df = factories[ns.index];
+                    if (!df) {
+                        debugLog("namespaceIndex = ", namespaceIndex);
+                        debugLog("namespace = ", namespace.namespaceUri);
+                        debugLog("priorityTable", priorityTable);
+                        debugLog(dependency.map((ns) => `${ns.index} ${ns.namespaceUri}`).join("\n"));
+                        throw new Error(`Cannot find factory for namespace ${ns.namespaceUri}`);
+                    }
+                    return df;
+                });
+                //            getStandardDataTypeFactory()
+                const _dataTypeFactory1 = new node_opcua_factory_1.DataTypeFactory(dependFactories);
+            }
+            const dataTypeFactory1 = new node_opcua_factory_1.DataTypeFactory([...factories]);
+            dataTypeFactory1.targetNamespace = namespace.namespaceUri;
+            factories.push(dataTypeFactory1);
+            dataTypeManager.registerDataTypeFactory(namespaceIndex, dataTypeFactory1);
+        }
+        // inject simple types
+        // now extract structure and enumeration from old form
+        const session = new pseudo_session_js_1.PseudoSession(addressSpace);
+        await (0, node_opcua_client_dynamic_extension_object_1.populateDataTypeManager)(session, dataTypeManager, node_opcua_client_dynamic_extension_object_1.DataTypeExtractStrategy.Auto);
+        // turn old <=103 structure to have valid DataTypeDefinition
+        fixDefinition103(addressSpace, namespaceArray, dataTypeManager);
+    }
+    return addressSpacePriv.$$extraDataTypeManager;
+}
+function ensureDatatypeExtractedWithCallback(addressSpace, callback) {
+    ensureDatatypeExtracted(addressSpace)
+        .then((result) => callback(null, result))
+        .catch((err) => callback(err));
+}
+//# sourceMappingURL=ensure_datatype_extracted.js.map

package/dist/api/loader/ensure_datatype_extracted.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ensure_datatype_extracted.js","sourceRoot":"","sources":["../../../api/loader/ensure_datatype_extracted.ts"],"names":[],"mappings":";;AAqDA,0DA8DC;AAED,kFAIC;AAxHD,2GAKoD;AACpD,uDAAiE;AACjE,2DAAiF;AAIjF,kHAGoE;AACpE,4DAAqD;AAErD,MAAM,QAAQ,GAAG,IAAA,gCAAa,EAAC,2BAA2B,CAAC,CAAC;AAC5D,MAAM,OAAO,GAAG,IAAA,iCAAc,EAAC,2BAA2B,CAAC,CAAC;AAU5D,SAAS,gBAAgB,CAAC,YAA2B,EAAE,cAAwB,EAAE,eAAqC;IAClH,iCAAiC;IACjC,KAAK,IAAI,cAAc,GAAG,CAAC,EAAE,cAAc,GAAG,cAAc,CAAC,MAAM,EAAE,cAAc,EAAE,EAAE,CAAC;QACpF,MAAM,EAAE,GAAG,eAAe,CAAC,kBAAkB,CAAC,cAAc,CAAC,CAAC;QAC9D,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC,oBAAoB,EAAE,EAAE,CAAC;YACxC,MAAM,QAAQ,GAAG,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,cAAc,CAAmB,CAAC;YACtF,IAAI,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;gBACjB,SAAS;YACb,CAAC;YACD,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACZ,SAAS;YACb,CAAC;YACD,IAAI,QAAQ,CAAC,kBAAkB,EAAE,MAAM,EAAE,CAAC;gBACtC,SAAS;YACb,CAAC;YACD,4DAA4D;YAC5D,IAAI,CAAC,QAAQ,CAAC,kBAAkB,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,CAAC,CAAC,EAAE,CAAC;gBAC5G,MAAM,EAAE,GAAG,IAAA,4FAA+C,EAAC,CAAC,CAAC,MAAM,CAAC,CAAC;gBACrE,QAAQ,CAAC,kBAAkB,GAAG,EAAE,CAAC,MAAM,IAAI,SAAS,CAAC;YACzD,CAAC;QACL,CAAC;IACL,CAAC;AACL,CAAC;AAEM,KAAK,UAAU,uBAAuB,CAAC,YAA2B;IACrE,MAAM,gBAAgB,GAAG,YAAsD,CAAC;IAEhF,IAAI,CAAC,gBAAgB,CAAC,sBAAsB,EAAE,CAAC;QAC3C,MAAM,eAAe,GAAG,IAAI,iEAAoB,EAAE,CAAC;QAEnD,MAAM,cAAc,GAAG,YAAY,CAAC,iBAAiB,EAAE,CAAC,GAAG,CAAC,CAAC,CAAa,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;QAE/F,OAAO,IAAI,QAAQ,CAAC,qBAAqB,EAAE,cAAc,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC,CAAC;QAEzF,eAAe,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC;QAElD,gBAAgB,CAAC,sBAAsB,GAAG,eAAe,CAAC;QAE1D,MAAM,SAAS,GAAsB,CAAC,IAAA,+CAA0B,GAAE,CAAC,CAAC;QAEpE,MAAM,aAAa,GAAG,IAAA,mEAA+B,EAAC,YAAY,CAAC,CAAC,aAAa,CAAC;QAElF,KAAK,IAAI,cAAc,GAAG,CAAC,EAAE,cAAc,GAAG,cAAc,CAAC,MAAM,EAAE,cAAc,EAAE,EAAE,CAAC;YACpF,MAAM,SAAS,GAAG,YAAY,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC;YAE5D,IAAI,OAAO,EAAE,CAAC;gBACV,QAAQ,CAAC,mBAAmB,EAAE,cAAc,CAAC,CAAC;gBAC9C,QAAQ,CAAC,cAAc,EAAE,SAAS,CAAC,YAAY,CAAC,CAAC;gBACjD,QAAQ,CAAC,cAAc,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;gBAC5E,4BAA4B;gBAC5B,IAAI,UAAU,GAAG,IAAA,gEAA4B,EAAC,SAAS,CAAC,CAAC;gBACzD,2CAA2C;gBAC3C,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,KAAK,KAAK,cAAc,CAAC,CAAC;gBACpE,MAAM,eAAe,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE;oBAC1C,MAAM,EAAE,GAAG,SAAS,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;oBAC/B,IAAI,CAAC,EAAE,EAAE,CAAC;wBACN,QAAQ,CAAC,mBAAmB,EAAE,cAAc,CAAC,CAAC;wBAC9C,QAAQ,CAAC,cAAc,EAAE,SAAS,CAAC,YAAY,CAAC,CAAC;wBACjD,QAAQ,CAAC,eAAe,EAAE,aAAa,CAAC,CAAC;wBACzC,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,YAAY,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;wBAC9E,MAAM,IAAI,KAAK,CAAC,qCAAqC,EAAE,CAAC,YAAY,EAAE,CAAC,CAAC;oBAC5E,CAAC;oBACD,OAAO,EAAE,CAAC;gBACd,CAAC,CAAC,CAAC;gBACH,0CAA0C;gBAE1C,MAAM,iBAAiB,GAAG,IAAI,oCAAe,CAAC,eAAe,CAAC,CAAC;YACnE,CAAC;YACD,MAAM,gBAAgB,GAAG,IAAI,oCAAe,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC;YAC7D,gBAAgB,CAAC,eAAe,GAAG,SAAS,CAAC,YAAY,CAAC;YAE1D,SAAS,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;YAEjC,eAAe,CAAC,uBAAuB,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC;QAC9E,CAAC;QACD,sBAAsB;QAEtB,sDAAsD;QACtD,MAAM,OAAO,GAAG,IAAI,iCAAa,CAAC,YAAY,CAAC,CAAC;QAEhD,MAAM,IAAA,oEAAuB,EAAC,OAAO,EAAE,eAAe,EAAE,oEAAuB,CAAC,IAAI,CAAC,CAAC;QAEtF,4DAA4D;QAC5D,gBAAgB,CAAC,YAAY,EAAE,cAAc,EAAE,eAAe,CAAC,CAAC;IACpE,CAAC;IACD,OAAO,gBAAgB,CAAC,sBAA8C,CAAC;AAC3E,CAAC;AAED,SAAgB,mCAAmC,CAAC,YAA2B,EAAE,QAAyC;IACtH,uBAAuB,CAAC,YAAY,CAAC;SAChC,IAAI,CAAC,CAAC,MAA4B,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;SAC9D,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;AACvC,CAAC"}