node-opcua-address-space 2.180.0 → 2.181.0

package/src/data_access/adjust_datavalue_status_code.ts

@@ -1,36 +0,0 @@
-/**
- * @module node-opcua-address-space.DataAccess
- */
-
-import type { UAVariable } from "node-opcua-address-space-base";
-import { NodeClass } from "node-opcua-data-model";
-import type { DataValue } from "node-opcua-data-value";
-import { type StatusCode, StatusCodes } from "node-opcua-status-code";
-import type { Range } from "node-opcua-types";
-import type { Variant } from "node-opcua-variant";
-import type { UAVariableImpl } from "../ua_variable_impl";
-
-function validate_value_range(range: Range, variant: Variant) {
-    if (variant.value < range.low || variant.value > range.high) {
-        return false;
-    }
-    return true;
-}
-
-export function adjustDataValueStatusCode(
-    variable: UAVariableImpl,
-    dataValue: DataValue,
-    acceptValueOutOfRange: boolean
-): StatusCode {
-    const instrumentRange = variable.getChildByName("InstrumentRange") as UAVariable | null;
-    if (instrumentRange && instrumentRange.nodeClass === NodeClass.Variable) {
-        if (!validate_value_range(instrumentRange.readValue().value.value as Range, dataValue.value)) {
-            if (!acceptValueOutOfRange) {
-                return StatusCodes.BadOutOfRange;
-            } else {
-                dataValue.statusCode = StatusCodes.BadOutOfRange;
-            }
-        }
-    }
-    return StatusCodes.Good;
-}

package/src/data_access/ua_multistate_discrete_impl.ts

@@ -1,189 +0,0 @@
-/**
- * @module node-opcua-address-space.DataAccess
- */
-
-import type {
-    BindVariableOptions,
-    CloneExtraInfo,
-    CloneFilter,
-    CloneOptions,
-    INamespace,
-    UAVariable
-} from "node-opcua-address-space-base";
-import { assert } from "node-opcua-assert";
-import { VariableTypeIds } from "node-opcua-constants";
-import { coerceLocalizedText, type LocalizedText } from "node-opcua-data-model";
-import type { UAMultiStateDiscrete_Base } from "node-opcua-nodeset-ua";
-import { type StatusCode, StatusCodes } from "node-opcua-status-code";
-import { DataType, Variant, VariantArrayType } from "node-opcua-variant";
-import type { AddMultiStateDiscreteOptions } from "../../source/address_space_ts";
-import type { ISetStateOptions } from "../../source/interfaces/i_set_state_options";
-import { registerNodePromoter } from "../../source/loader/register_node_promoter";
-import { UAVariableImpl } from "../ua_variable_impl";
-import { add_dataItem_stuff } from "./add_dataItem_stuff";
-
-export { UAMultiStateDiscrete } from "node-opcua-nodeset-ua";
-
-export interface UAMultiStateDiscreteEx<T, DT extends DataType> extends UAMultiStateDiscrete_Base<T, DT> {
-    //------------ helpers ------------------
-    getValue(): number;
-    getValueAsString(): string;
-    getIndex(value: string): number;
-    setValue(value: string | number, options?: ISetStateOptions): void;
-    checkVariantCompatibility(value: Variant): StatusCode;
-}
-
-/**
- * @class UAMultiStateDiscrete
- */
-export class UAMultiStateDiscreteImplBase<T, DT extends DataType> extends UAVariableImpl {
-    private get $7(): UAMultiStateDiscreteEx<T, DT> {
-        return this as unknown as UAMultiStateDiscreteEx<T, DT>;
-    }
-    public getValue(): number {
-        return this.readValue().value.value;
-    }
-
-    public getValueAsString(): string {
-        const index = this.getValue();
-        const arr = this.$7.enumStrings.readValue().value.value;
-        assert(Array.isArray(arr));
-        return arr[index].text ? arr[index].text?.toString() : "????";
-    }
-
-    public getIndex(value: string): number {
-        const arr = this.$7.enumStrings.readValue().value.value;
-        assert(Array.isArray(arr));
-        const index = arr.findIndex((a: LocalizedText) => a.text === value);
-        return index;
-    }
-
-    public setValue(value: string | number, options?: ISetStateOptions): void {
-        if (typeof value === "string") {
-            const index = this.getIndex(value);
-            if (index < 0) {
-                throw new Error(`UAMultiStateDiscrete#setValue invalid multi state value provided : ${value}`);
-            }
-            this.setValue(index, options);
-            return;
-        }
-        const arrayEnumStrings = this.$7.enumStrings.readValue().value.value;
-        if (value >= arrayEnumStrings.length) {
-            throw new Error(`UAMultiStateDiscrete#setValue BadOutOfRange ${value}`);
-        }
-        assert(Number.isFinite(value));
-        this.setValueFromSource(new Variant({ dataType: DataType.UInt32, value }));
-    }
-
-    public checkVariantCompatibility(value: Variant): StatusCode {
-        if (!this._validate_DataType(value.dataType)) {
-            return StatusCodes.BadTypeMismatch;
-        }
-        if (this.$7.enumStrings) {
-            const arrayEnumStrings = this.$7.enumStrings.readValue().value.value;
-            // MultiStateDiscreteType
-            assert(value.dataType === DataType.UInt32);
-            if (value.value >= arrayEnumStrings.length) {
-                return StatusCodes.BadOutOfRange;
-            }
-        }
-        return StatusCodes.Good;
-    }
-
-    public _post_initialize(): void {
-        /* empty */
-    }
-
-    public clone(
-        options1: CloneOptions,
-        optionalFilter?: CloneFilter,
-        extraInfo?: CloneExtraInfo
-    ): UAMultiStateDiscreteImpl<T, DT> {
-        const variable1 = UAVariableImpl.prototype.clone.call(this, options1, optionalFilter, extraInfo);
-        return promoteToMultiStateDiscrete(variable1);
-    }
-}
-export type UAMultiStateDiscreteImpl<T, DT extends DataType> = UAMultiStateDiscreteImplBase<T, DT> & UAMultiStateDiscreteEx<T, DT>;
-export const UAMultiStateDiscreteImpl = UAMultiStateDiscreteImplBase as unknown as new <
-    T,
-    DT extends DataType
->() => UAMultiStateDiscreteImpl<T, DT>;
-
-export function promoteToMultiStateDiscrete<T, DT extends DataType>(node: UAVariable): UAMultiStateDiscreteImpl<T, DT> {
-    if (node instanceof UAMultiStateDiscreteImpl) {
-        return node; // already promoted
-    }
-    Object.setPrototypeOf(node, UAMultiStateDiscreteImpl.prototype);
-    assert(node instanceof UAMultiStateDiscreteImpl, "should now  be a State Machine");
-    const _node = node as UAMultiStateDiscreteImpl<T, DT>;
-
-    _node._post_initialize();
-
-    assert(_node.enumStrings.browseName.toString() === "EnumStrings");
-    const handler = _node.handle_semantic_changed.bind(_node);
-    _node.enumStrings.on("value_changed", handler);
-    _node.install_extra_properties();
-    return node as UAMultiStateDiscreteImpl<T, DT>;
-}
-registerNodePromoter(VariableTypeIds.MultiStateDiscreteType, promoteToMultiStateDiscrete);
-
-export function _addMultiStateDiscrete<T, DT extends DataType>(
-    namespace: INamespace,
-    options: AddMultiStateDiscreteOptions
-): UAMultiStateDiscreteImpl<T, DT> {
-    const addressSpace = namespace.addressSpace;
-    assert(Object.hasOwn(options, "enumStrings"));
-    assert(!Object.hasOwn(options, "ValuePrecision"));
-
-    const multiStateDiscreteType = addressSpace.findVariableType("MultiStateDiscreteType");
-    if (!multiStateDiscreteType) {
-        throw new Error("Cannot find MultiStateDiscreteType");
-    }
-    // todo : if options.typeDefinition is specified, check that type is SubTypeOf MultiStateDiscreteType
-
-    options.value = options.value === undefined ? 0 : options.value;
-
-    let value: undefined | BindVariableOptions;
-    if (typeof options.value === "number") {
-        value = new Variant({
-            dataType: DataType.UInt32,
-            value: options.value
-        });
-    } else {
-        value = options.value;
-    }
-
-    const variable = namespace.addVariable({
-        ...options,
-
-        dataType: "Number",
-        typeDefinition: multiStateDiscreteType.nodeId,
-        value,
-
-        valueRank: -2
-    });
-
-    add_dataItem_stuff(variable, options);
-
-    const enumStrings = options.enumStrings.map((value: string) => {
-        return coerceLocalizedText(value);
-    });
-
-    const _enumStringsNode = namespace.addVariable({
-        accessLevel: "CurrentRead", // | CurrentWrite",
-        browseName: { name: "EnumStrings", namespaceIndex: 0 },
-        dataType: "LocalizedText",
-        minimumSamplingInterval: 0,
-        modellingRule: options.modellingRule ? "Mandatory" : undefined,
-        propertyOf: variable,
-        typeDefinition: "PropertyType",
-        userAccessLevel: "CurrentRead", // CurrentWrite",
-        value: new Variant({
-            arrayType: VariantArrayType.Array,
-            dataType: DataType.LocalizedText,
-            value: enumStrings
-        })
-    });
-
-    return promoteToMultiStateDiscrete(variable);
-}

package/src/data_access/ua_multistate_value_discrete_impl.ts

@@ -1,369 +0,0 @@
-import type {
-    BindVariableOptions,
-    CloneExtraInfo,
-    CloneFilter,
-    CloneOptions,
-    INamespace,
-    UAVariable
-} from "node-opcua-address-space-base";
-import { assert } from "node-opcua-assert";
-import {
-    coerceInt32,
-    coerceInt64toInt32,
-    coerceUInt64,
-    coerceUInt64toInt32,
-    type Int32,
-    type Int64,
-    isValidInt64,
-    isValidUInt64,
-    type UInt64
-} from "node-opcua-basic-types";
-import { VariableTypeIds } from "node-opcua-constants";
-import { coerceLocalizedText } from "node-opcua-data-model";
-import type { DataValue } from "node-opcua-data-value";
-import type { DTEnumValue } from "node-opcua-nodeset-ua";
-import { type StatusCode, StatusCodes } from "node-opcua-status-code";
-import { DataType, Variant, VariantArrayType } from "node-opcua-variant";
-import type { AddMultiStateValueDiscreteOptions } from "../../source/address_space_ts";
-import { coerceEnumValues } from "../../source/helpers/coerce_enum_value";
-import type { UAMultiStateValueDiscreteEx } from "../../source/interfaces/data_access/ua_multistate_value_discrete_ex";
-import type { ISetStateOptions } from "../../source/interfaces/i_set_state_options";
-import { registerNodePromoter } from "../../source/loader/register_node_promoter";
-import { _getBasicDataTypeFromDataTypeNodeId } from "../get_basic_datatype";
-import { UAVariableImpl } from "../ua_variable_impl";
-import { add_dataItem_stuff } from "./add_dataItem_stuff";
-
-function convertToArray<T>(array: ArrayLike<T> | T[]): T[] {
-    if (Array.isArray(array)) return array;
-    const result: T[] = [];
-    for (let i = 0; i < array.length; i++) {
-        result[i] = array[i];
-    }
-    return result;
-}
-const getCoerceToInt32 = (dataType: DataType) => {
-    switch (dataType) {
-        case DataType.UInt64:
-            return coerceUInt64toInt32;
-        case DataType.Int64:
-            return coerceInt64toInt32;
-        default:
-            return coerceInt32;
-    }
-};
-
-type Number = number | Int64 | UInt64;
-
-function install_synchronization<T extends Number, DT extends DataType>(
-    _variable: UAVariableImpl & UAMultiStateValueDiscreteEx<T, DT>
-) {
-    _variable.on("value_changed", (dataValue: DataValue) => {
-        const valueAsTextNode = _variable.valueAsText || (_variable.getComponentByName("ValueAsText") as UAVariable);
-        if (!valueAsTextNode) {
-            return;
-        }
-        if (dataValue.value.arrayType === VariantArrayType.Array || dataValue.value.arrayType === VariantArrayType.Matrix) {
-            //
-            const _coerce = getCoerceToInt32(_variable.getBasicDataType());
-
-            const values: number[] = convertToArray<Int32>(dataValue.value.value).map((a) => coerceInt32(a));
-            const variantArray: Variant[] = values.map((a) => _variable.findValueAsText(a));
-            const localizedText = variantArray.map((a) => a.value);
-
-            const valueAsText1 = new Variant({
-                arrayType: dataValue.value.arrayType,
-                dataType: DataType.LocalizedText,
-                value: localizedText,
-                dimensions: dataValue.value.dimensions
-            });
-            valueAsTextNode.setValueFromSource(valueAsText1);
-        } else {
-            const valueAsText1 = _variable.findValueAsText(dataValue.value.value);
-            valueAsTextNode.setValueFromSource(valueAsText1);
-        }
-    });
-    const dataValue = _variable.readValue();
-    // detect value changes to update valueAsText  (initial state)
-    _variable.emit("value_changed", dataValue);
-}
-
-export class UAMultiStateValueDiscreteImplBase<T extends Number, DT extends DataType> extends UAVariableImpl {
-    private get $6(): UAMultiStateValueDiscreteEx<T, DT> {
-        return this as unknown as UAMultiStateValueDiscreteEx<T, DT>;
-    }
-    public setValue(value: string | number | Int64, options?: ISetStateOptions): void {
-        if (typeof value === "string") {
-            const enumValues = this.$6.enumValues.readValue().value.value;
-            const selected = enumValues.filter((a) => a.displayName.text === value)[0];
-            if (selected) {
-                this._setValue(selected.value);
-            } else {
-                throw new Error(`cannot find enum string ${value} in ${enumValues.toString()}`);
-            }
-        } else {
-            this._setValue(coerceUInt64(value), options);
-        }
-    }
-
-    public getValueAsString(): string | string[] {
-        const v = this.$6.valueAsText.readValue().value.value;
-        if (Array.isArray(v)) {
-            return v.map((a) => a.text);
-        }
-        return v.text || "";
-    }
-
-    public getValueAsNumber(): number {
-        return this.readValue().value.value;
-    }
-
-    public checkVariantCompatibility(value: Variant): StatusCode {
-        if (this.$6.enumValues) {
-            if (!this._isValueInRange(coerceInt32(value.value))) {
-                return StatusCodes.BadOutOfRange;
-            }
-        }
-        return StatusCodes.Good;
-    }
-
-    public clone(
-        options1: CloneOptions,
-        optionalFilter?: CloneFilter,
-        extraInfo?: CloneExtraInfo
-    ): UAMultiStateValueDiscreteImpl<T, DT> {
-        const variable1 = UAVariableImpl.prototype.clone.call(this, options1, optionalFilter, extraInfo);
-        return promoteToMultiStateValueDiscrete(variable1);
-    }
-
-    /**
-     * @private
-     */
-    public _isValueInRange(value: number): boolean {
-        // MultiStateValueDiscreteType
-        const enumValues = this.$6.enumValues.readValue().value.value as DTEnumValue[];
-        const e = enumValues.findIndex((x: DTEnumValue) => coerceInt64toInt32(x.value) === value);
-        return !(e === -1);
-    }
-    /**
-     *
-     * @private
-     */
-    public _enumValueIndex(): Record<Int32, DTEnumValue> {
-        // construct an index to quickly find a EnumValue from a value
-        const enumValues: DTEnumValue[] = this.$6.enumValues.readValue().value.value;
-        const enumValueIndex: Record<Int32, DTEnumValue> = Object.create(null);
-        if (!enumValues?.forEach) {
-            return enumValueIndex;
-        }
-        enumValues.forEach((e: DTEnumValue) => {
-            const index = coerceInt64toInt32(e.value);
-            enumValueIndex[index] = e;
-        });
-        return enumValueIndex;
-    }
-
-    /**
-     *
-     * @private
-     */
-    public _setValue(value: Int64, _options?: ISetStateOptions): void {
-        const int32Value = coerceInt64toInt32(value);
-        // check that value is in bound
-        if (!this._isValueInRange(int32Value)) {
-            throw new Error(`UAMultiStateValueDiscrete#_setValue out of range ${value}`);
-        }
-
-        const dataType = this._getDataType();
-        if (dataType === DataType.Int64 || dataType === DataType.UInt64) {
-            this.setValueFromSource({ dataType, arrayType: VariantArrayType.Scalar, value });
-        } else {
-            this.setValueFromSource({ dataType, arrayType: VariantArrayType.Scalar, value: int32Value });
-        }
-    }
-
-    /**
-     *
-     * @private
-     */
-    public findValueAsText(value?: number | Int64): Variant {
-        const enumValueIndex = this._enumValueIndex();
-        if (value === undefined) {
-            throw new Error("Unexpected undefined value");
-        }
-        const valueAsInt32 = coerceInt64toInt32(value);
-
-        let valueAsText1 = "Invalid";
-        if (enumValueIndex[valueAsInt32] !== undefined) {
-            valueAsText1 = enumValueIndex[valueAsInt32].displayName.text || `Invalid:${value}`;
-        }
-        const result = new Variant({
-            dataType: DataType.LocalizedText,
-            value: coerceLocalizedText(valueAsText1)
-        });
-        return result;
-    }
-
-    public _getDataType(): DataType {
-        if (this.dataType.value === 26 /* Number */) {
-            return DataType.UInt32;
-        }
-        const dataTypeStr = DataType[this.dataType.value as number] as string;
-        return DataType[dataTypeStr as keyof typeof DataType];
-    }
-
-    /**
-     *
-     * @private
-     */
-    public _post_initialize(): void {
-        // MultiStateValueDiscrete Variables can have any numeric Data Type;
-        // this includes signed and unsigned integers from 8 to 64 Bit length.
-
-        // c8 ignore next
-        validateIsNumericDataType(this.dataType.value);
-
-        // find the enum value type
-        install_synchronization(this as unknown as UAVariableImpl & UAMultiStateValueDiscreteEx<T, DT>);
-    }
-}
-export type UAMultiStateValueDiscreteImpl<T extends Number, DT extends DataType> = UAMultiStateValueDiscreteImplBase<T, DT> &
-    UAMultiStateValueDiscreteEx<T, DT>;
-export const UAMultiStateValueDiscreteImpl = UAMultiStateValueDiscreteImplBase as unknown as new <
-    T extends Number,
-    DT extends DataType
->() => UAMultiStateValueDiscreteImpl<T, DT>;
-
-export function promoteToMultiStateValueDiscrete<T extends Number, DT extends DataType>(
-    node: UAVariable
-): UAMultiStateValueDiscreteImpl<T, DT> {
-    if (node instanceof UAMultiStateValueDiscreteImpl) {
-        return node; // already promoted
-    }
-    Object.setPrototypeOf(node, UAMultiStateValueDiscreteImpl.prototype);
-    assert(node instanceof UAMultiStateValueDiscreteImpl, "should now  be a State Machine");
-    (node as UAMultiStateValueDiscreteImpl<T, DT>)._post_initialize();
-    return node as UAMultiStateValueDiscreteImpl<T, DT>;
-}
-
-registerNodePromoter(VariableTypeIds.MultiStateValueDiscreteType, promoteToMultiStateValueDiscrete);
-
-export function _addMultiStateValueDiscrete<T, DT extends DataType>(
-    namespace: INamespace,
-    options: AddMultiStateValueDiscreteOptions
-): UAMultiStateValueDiscreteEx<T, DT> {
-    assert(Object.hasOwn(options, "enumValues"));
-    assert(!Object.hasOwn(options, "ValuePrecision"));
-
-    const addressSpace = namespace.addressSpace;
-
-    const multiStateValueDiscreteType = addressSpace.findVariableType("MultiStateValueDiscreteType");
-    if (!multiStateValueDiscreteType) {
-        throw new Error("expecting MultiStateValueDiscreteType to be defined , check nodeset xml file");
-    }
-
-    // todo : if options.typeDefinition is specified, check that type is SubTypeOf MultiStateDiscreteType
-
-    // EnumValueType
-    //   value: Int64, displayName: LocalizedText, Description: LocalizedText
-    const enumValues = coerceEnumValues(options.enumValues);
-
-    if (options.value === undefined && enumValues[0]) {
-        options.value = enumValues[0].value; // Int64
-    }
-    // Only DataTypes that can be represented with EnumValues are allowed for Variables of MultiStateValueDiscreteType.
-    // These are Integers up to 64 Bits (signed and unsigned).:
-
-    const dataType: DataType = _getBasicDataTypeFromDataTypeNodeId(addressSpace, options.dataType || DataType.UInt32);
-
-    let value: undefined | BindVariableOptions;
-    if (
-        typeof options.value === "number" ||
-        isValidUInt64(options.value as number | number[]) ||
-        isValidInt64(options.value as number | number[])
-    ) {
-        value = new Variant({
-            dataType,
-            value: options.value
-        });
-    } else {
-        value = options.value as BindVariableOptions;
-    }
-
-    const cloned_options = {
-        ...options,
-        dataType,
-        typeDefinition: multiStateValueDiscreteType.nodeId,
-        // valueRank:
-        // note : OPCUA Spec 1.03 specifies -1:Scalar (part 8 page 8) but nodeset file specifies -2:Any
-        value,
-        // limitation:  although the Specs specify -2:any, we only support -1(Scalar)
-        valueRank: -1 // -1 : Scalar
-    };
-
-    const variable = namespace.addVariable(cloned_options) as UAMultiStateValueDiscreteEx<T, DT>;
-
-    add_dataItem_stuff(variable, options);
-
-    namespace.addVariable({
-        accessLevel: "CurrentRead",
-        browseName: { name: "EnumValues", namespaceIndex: 0 },
-        dataType: "EnumValueType",
-        valueRank: 1,
-        minimumSamplingInterval: 0,
-        modellingRule: options.modellingRule ? "Mandatory" : undefined,
-        propertyOf: variable,
-        typeDefinition: "PropertyType",
-        userAccessLevel: "CurrentRead",
-        value: new Variant({
-            arrayType: VariantArrayType.Array,
-            dataType: DataType.ExtensionObject,
-            value: enumValues
-        })
-    });
-
-    namespace.addVariable({
-        accessLevel: "CurrentRead",
-        browseName: { name: "ValueAsText", namespaceIndex: 0 },
-        dataType: DataType.LocalizedText,
-        minimumSamplingInterval: 0,
-        modellingRule: options.modellingRule ? "Mandatory" : undefined,
-        propertyOf: variable,
-        arrayDimensions: options.arrayDimensions,
-        valueRank: options.valueRank,
-        typeDefinition: "PropertyType",
-        userAccessLevel: "CurrentRead"
-        // value: valueAsText
-    });
-
-    // install additional helpers methods
-    variable.install_extra_properties();
-
-    promoteToMultiStateValueDiscrete(variable);
-
-    assert(variable.enumValues.browseName.toString() === "EnumValues");
-    assert(variable.valueAsText.browseName.toString() === "ValueAsText");
-    return variable;
-}
-
-const validBasicNumericDataTypes = [
-    DataType.UInt64,
-    DataType.Int64,
-    DataType.UInt32,
-    DataType.Int32,
-    DataType.UInt16,
-    DataType.Int16,
-    DataType.Byte,
-    DataType.Byte,
-    DataType.SByte,
-    26 /* Number  (abstract)*/,
-    27 /* Integer  (abstract)*/,
-    28 /* UInteger (abstract)*/
-];
-export function validateIsNumericDataType(dataTypeValue: unknown): void {
-    if (typeof dataTypeValue !== "number" || validBasicNumericDataTypes.indexOf(dataTypeValue) < 0) {
-        throw new Error(`Invalid DataType in UAMultiStateValueDiscrete => ${dataTypeValue}`);
-    }
-}
-
-/** @deprecated: use validateIsNumericDataType instead */
-export const validateDataType = validateIsNumericDataType;