node-opcua-factory 2.71.0 → 2.73.1

package/dist/structured_type_schema.js

@@ -0,0 +1,279 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildStructuredType = exports.check_options_correctness_against_schema = exports.extract_all_fields = exports.get_base_schema = exports.StructuredTypeSchema = void 0;
+/**
+ * @module node-opcua-factory
+ */
+const chalk = require("chalk");
+const node_opcua_assert_1 = require("node-opcua-assert");
+const node_opcua_nodeid_1 = require("node-opcua-nodeid");
+const node_opcua_utils_1 = require("node-opcua-utils");
+const builtin_types_1 = require("./builtin_types");
+const enumerations_1 = require("./enumerations");
+const parameters_1 = require("./parameters");
+const get_standard_data_type_factory_1 = require("./get_standard_data_type_factory");
+const get_structured_type_schema_1 = require("./get_structured_type_schema");
+const types_1 = require("./types");
+function figureOutFieldCategory(field) {
+    const fieldType = field.fieldType;
+    if (field.category) {
+        return field.category;
+    }
+    if ((0, enumerations_1.hasBuiltInEnumeration)(fieldType)) {
+        return types_1.FieldCategory.enumeration;
+    }
+    else if ((0, builtin_types_1.hasBuiltInType)(fieldType)) {
+        return types_1.FieldCategory.basic;
+    }
+    else if ((0, get_standard_data_type_factory_1.hasStructuredType)(fieldType)) {
+        (0, node_opcua_assert_1.assert)(fieldType !== "LocalizedText"); // LocalizedText should be treated as BasicType!!!
+        return types_1.FieldCategory.complex;
+    }
+    return types_1.FieldCategory.basic;
+}
+const regExp = /((ns[0-9]+:)?)(.*)/;
+function figureOutSchema(underConstructSchema, field, category) {
+    if (field.schema) {
+        return field.schema;
+    }
+    if (underConstructSchema.name === field.fieldType) {
+        return underConstructSchema;
+    }
+    let returnValue = null;
+    // may be the field.type  contains a ns<X>: prefix !! like the one found in Beckhoff PLC !
+    const m = field.fieldType.match(regExp);
+    /* istanbul ignore next */
+    if (!m) {
+        throw new Error("malformed fieldType ? : " + field.fieldType);
+    }
+    const fieldTypeWithoutNS = m[3];
+    switch (category) {
+        case types_1.FieldCategory.complex:
+            if ((0, get_standard_data_type_factory_1.hasStructuredType)(field.fieldType)) {
+                returnValue = (0, get_structured_type_schema_1.getStructuredTypeSchema)(fieldTypeWithoutNS);
+            }
+            else {
+                // LocalizedText etc ...
+                returnValue = (0, builtin_types_1.getBuiltInType)(fieldTypeWithoutNS);
+            }
+            break;
+        case types_1.FieldCategory.basic:
+            returnValue = (0, builtin_types_1.getBuiltInType)(fieldTypeWithoutNS);
+            if (!returnValue) {
+                returnValue = (0, get_structured_type_schema_1.getStructuredTypeSchema)(fieldTypeWithoutNS);
+                if (returnValue) {
+                    console.log("Why ?");
+                }
+            }
+            break;
+        case types_1.FieldCategory.enumeration:
+            returnValue = (0, enumerations_1.getBuiltInEnumeration)(fieldTypeWithoutNS);
+            break;
+    }
+    if (null === returnValue || undefined === returnValue) {
+        try {
+            returnValue = (0, enumerations_1.getBuiltInEnumeration)(fieldTypeWithoutNS);
+        }
+        catch (err) {
+            console.log(err);
+        }
+        throw new Error("Cannot find Schema for field with name " +
+            field.name +
+            " fieldTypeWithoutNS= " +
+            fieldTypeWithoutNS +
+            " with type " +
+            field.fieldType +
+            " category = " +
+            category +
+            JSON.stringify(field, null, "\t"));
+    }
+    return returnValue;
+}
+function buildField(underConstructSchema, fieldLight) {
+    const category = figureOutFieldCategory(fieldLight);
+    const schema = figureOutSchema(underConstructSchema, fieldLight, category);
+    /* istanbul ignore next */
+    if (!schema) {
+        throw new Error("expecting a valid schema for field with name " +
+            fieldLight.name +
+            " with type " +
+            fieldLight.fieldType +
+            " category" +
+            category);
+    }
+    const { defaultValue, isArray, documentation, fieldType, switchBit, switchValue, allowSubType, dataType, basicDataType } = fieldLight;
+    return {
+        name: (0, node_opcua_utils_1.lowerFirstLetter)(fieldLight.name),
+        originalName: fieldLight.name,
+        category,
+        defaultValue,
+        isArray,
+        documentation,
+        fieldType,
+        switchBit,
+        switchValue,
+        allowSubType,
+        dataType,
+        basicDataType,
+        schema
+    };
+}
+class StructuredTypeSchema extends builtin_types_1.TypeSchemaBase {
+    constructor(options) {
+        super(options);
+        this.bitFields = options.bitFields;
+        this.baseType = options.baseType;
+        this.category = types_1.FieldCategory.complex;
+        if ((0, builtin_types_1.hasBuiltInType)(options.name)) {
+            this.category = types_1.FieldCategory.basic;
+        }
+        this.fields = options.fields.map(buildField.bind(null, this));
+        this.id = new node_opcua_nodeid_1.NodeId();
+        this.dataTypeNodeId = new node_opcua_nodeid_1.NodeId();
+        this._possibleFields = this.fields.map((field) => field.name);
+        this._baseSchema = null;
+    }
+    toString() {
+        var _a, _b, _c;
+        const str = [];
+        str.push("name           = " + this.name);
+        str.push("baseType       = " + this.baseType);
+        str.push("id             = " + this.id.toString());
+        str.push("bitFields      = " + (this.bitFields ? this.bitFields.map((b) => b.name).join(" ") : undefined));
+        str.push("dataTypeNodeId = " + (this.dataTypeNodeId ? this.dataTypeNodeId.toString() : undefined));
+        str.push("documentation  = " + this.documentation);
+        str.push("encodingDefaultBinary  = " + ((_a = this.encodingDefaultBinary) === null || _a === void 0 ? void 0 : _a.toString()));
+        str.push("encodingDefaultXml     = " + ((_b = this.encodingDefaultXml) === null || _b === void 0 ? void 0 : _b.toString()));
+        str.push("encodingDefaultJson    = " + ((_c = this.encodingDefaultJson) === null || _c === void 0 ? void 0 : _c.toString()));
+        for (const f of this.fields) {
+            str.push("  field   =  " +
+                f.name.padEnd(30) +
+                " isArray= " +
+                (f.isArray ? true : false) +
+                " " +
+                f.fieldType.toString().padEnd(30) +
+                (f.switchBit !== undefined ? " switchBit " + f.switchBit : "") +
+                (f.switchValue !== undefined ? " switchValue    " + f.switchValue : ""));
+        }
+        return str.join("\n");
+    }
+}
+exports.StructuredTypeSchema = StructuredTypeSchema;
+/**
+ *
+ * @method get_base_schema
+ * @param schema
+ * @return {*}
+ *
+ */
+function get_base_schema(schema) {
+    let baseSchema = schema._baseSchema;
+    if (baseSchema) {
+        return baseSchema;
+    }
+    if (schema.baseType === "ExtensionObject" || schema.baseType === "DataTypeDefinition") {
+        return null;
+    }
+    if (schema.baseType === "Union") {
+        return null;
+    }
+    if (schema.baseType && schema.baseType !== "BaseUAObject" && schema.baseType !== "DataTypeDefinition") {
+        if (!(0, get_standard_data_type_factory_1.hasStructuredType)(schema.baseType)) {
+            return null;
+        }
+        const baseType = (0, get_standard_data_type_factory_1.getStructureTypeConstructor)(schema.baseType);
+        // istanbul ignore next
+        if (!baseType) {
+            throw new Error(" cannot find factory for " + schema.baseType);
+        }
+        if (baseType.prototype.schema) {
+            baseSchema = baseType.prototype.schema;
+        }
+    }
+    // put in  cache for speedup
+    schema._baseSchema = baseSchema;
+    return baseSchema;
+}
+exports.get_base_schema = get_base_schema;
+/**
+ * extract a list of all possible fields for a schema
+ * (by walking up the inheritance chain)
+ *
+ */
+function extract_all_fields(schema) {
+    // returns cached result if any
+    // istanbul ignore next
+    if (schema._possibleFields) {
+        return schema._possibleFields;
+    }
+    // extract the possible fields from the schema.
+    let possibleFields = schema.fields.map((field) => field.name);
+    const baseSchema = get_base_schema(schema);
+    // istanbul ignore next
+    if (baseSchema) {
+        const fields = extract_all_fields(baseSchema);
+        possibleFields = fields.concat(possibleFields);
+    }
+    // put in cache to speed up
+    schema._possibleFields = possibleFields;
+    return possibleFields;
+}
+exports.extract_all_fields = extract_all_fields;
+/**
+ * check correctness of option fields against scheme
+ *
+ * @method  check_options_correctness_against_schema
+ *
+ */
+function check_options_correctness_against_schema(obj, schema, options) {
+    if (!parameters_1.parameters.debugSchemaHelper) {
+        return true; // ignoring set
+    }
+    options = options || {};
+    // istanbul ignore next
+    if (!(options !== null && typeof options === "object") && !(typeof options === "object")) {
+        let message = chalk.red(" Invalid options specified while trying to construct a ") + " " + chalk.yellow(schema.name);
+        message += "\n";
+        message += chalk.red(" expecting a ") + chalk.yellow(" Object ");
+        message += "\n";
+        message += chalk.red(" and got a ") + chalk.yellow(typeof options) + chalk.red(" instead ");
+        throw new Error(message);
+    }
+    // istanbul ignore next
+    if (options instanceof obj.constructor) {
+        return true;
+    }
+    // extract the possible fields from the schema.
+    const possibleFields = obj.constructor.possibleFields || schema._possibleFields;
+    // extracts the fields exposed by the option object
+    const currentFields = Object.keys(options);
+    // get a list of field that are in the 'options' object but not in schema
+    // https://github.com/you-dont-need/You-Dont-Need-Lodash-Underscore
+    function difference(a1, a2) {
+        return [a1, a2].reduce((a, b) => a.filter((value) => !b.includes(value)));
+    }
+    const invalidOptionsFields = difference(currentFields, possibleFields);
+    /* istanbul ignore next */
+    if (invalidOptionsFields.length > 0) {
+        // tslint:disable:no-console
+        console.log("expected schema", schema.name);
+        console.log(chalk.yellow("possible fields= "), possibleFields.sort().join(" "));
+        console.log(chalk.red("current fields= "), currentFields.sort().join(" "));
+        console.log(chalk.cyan("invalid_options_fields= "), invalidOptionsFields.sort().join(" "));
+        console.log("options = ", options);
+    }
+    /* istanbul ignore next */
+    if (invalidOptionsFields.length !== 0) {
+        // tslint:disable:no-console
+        console.log(chalk.yellow("possible fields= "), possibleFields.sort().join(" "));
+        console.log(chalk.red("current fields= "), currentFields.sort().join(" "));
+        throw new Error(" invalid field found in option :" + JSON.stringify(invalidOptionsFields));
+    }
+    return true;
+}
+exports.check_options_correctness_against_schema = check_options_correctness_against_schema;
+function buildStructuredType(schemaLight) {
+    return new StructuredTypeSchema(schemaLight);
+}
+exports.buildStructuredType = buildStructuredType;
+//# sourceMappingURL=structured_type_schema.js.map

package/dist/structured_type_schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"structured_type_schema.js","sourceRoot":"","sources":["../source/structured_type_schema.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,+BAA+B;AAE/B,yDAA2C;AAE3C,yDAA2D;AAC3D,uDAAoD;AAEpD,mDAAiF;AACjF,iDAA8E;AAC9E,6CAA0C;AAC1C,qFAAkG;AAClG,6EAAuE;AACvE,mCAOiB;AAEjB,SAAS,sBAAsB,CAAC,KAA4B;IACxD,MAAM,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;IAElC,IAAI,KAAK,CAAC,QAAQ,EAAE;QAChB,OAAO,KAAK,CAAC,QAAQ,CAAC;KACzB;IAED,IAAI,IAAA,oCAAqB,EAAC,SAAS,CAAC,EAAE;QAClC,OAAO,qBAAa,CAAC,WAAW,CAAC;KACpC;SAAM,IAAI,IAAA,8BAAc,EAAC,SAAS,CAAC,EAAE;QAClC,OAAO,qBAAa,CAAC,KAAK,CAAC;KAC9B;SAAM,IAAI,IAAA,kDAAiB,EAAC,SAAS,CAAC,EAAE;QACrC,IAAA,0BAAM,EAAC,SAAS,KAAK,eAAe,CAAC,CAAC,CAAC,kDAAkD;QACzF,OAAO,qBAAa,CAAC,OAAO,CAAC;KAChC;IACD,OAAO,qBAAa,CAAC,KAAK,CAAC;AAC/B,CAAC;AAED,MAAM,MAAM,GAAG,oBAAoB,CAAC;AAEpC,SAAS,eAAe,CACpB,oBAA0C,EAC1C,KAA4B,EAC5B,QAAuB;IAEvB,IAAI,KAAK,CAAC,MAAM,EAAE;QACd,OAAO,KAAK,CAAC,MAAM,CAAC;KACvB;IAED,IAAI,oBAAoB,CAAC,IAAI,KAAK,KAAK,CAAC,SAAS,EAAE;QAC/C,OAAO,oBAAoB,CAAC;KAC/B;IAED,IAAI,WAAW,GAAQ,IAAI,CAAC;IAE5B,0FAA0F;IAC1F,MAAM,CAAC,GAAG,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACxC,0BAA0B;IAC1B,IAAI,CAAC,CAAC,EAAE;QACJ,MAAM,IAAI,KAAK,CAAC,0BAA0B,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;KACjE;IACD,MAAM,kBAAkB,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAEhC,QAAQ,QAAQ,EAAE;QACd,KAAK,qBAAa,CAAC,OAAO;YACtB,IAAI,IAAA,kDAAiB,EAAC,KAAK,CAAC,SAAS,CAAC,EAAE;gBACpC,WAAW,GAAG,IAAA,oDAAuB,EAAC,kBAAkB,CAAC,CAAC;aAC7D;iBAAM;gBACH,wBAAwB;gBACxB,WAAW,GAAG,IAAA,8BAAc,EAAC,kBAAkB,CAAC,CAAC;aACpD;YACD,MAAM;QACV,KAAK,qBAAa,CAAC,KAAK;YACpB,WAAW,GAAG,IAAA,8BAAc,EAAC,kBAAkB,CAAC,CAAC;YACjD,IAAI,CAAC,WAAW,EAAE;gBACd,WAAW,GAAG,IAAA,oDAAuB,EAAC,kBAAkB,CAAC,CAAC;gBAC1D,IAAI,WAAW,EAAE;oBACb,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;iBACxB;aACJ;YACD,MAAM;QACV,KAAK,qBAAa,CAAC,WAAW;YAC1B,WAAW,GAAG,IAAA,oCAAqB,EAAC,kBAAkB,CAAC,CAAC;YACxD,MAAM;KACb;IACD,IAAI,IAAI,KAAK,WAAW,IAAI,SAAS,KAAK,WAAW,EAAE;QACnD,IAAI;YACA,WAAW,GAAG,IAAA,oCAAqB,EAAC,kBAAkB,CAAC,CAAC;SAC3D;QAAC,OAAO,GAAG,EAAE;YACV,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;SACpB;QACD,MAAM,IAAI,KAAK,CACX,yCAAyC;YACrC,KAAK,CAAC,IAAI;YACV,uBAAuB;YACvB,kBAAkB;YAClB,aAAa;YACb,KAAK,CAAC,SAAS;YACf,cAAc;YACd,QAAQ;YACR,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CACxC,CAAC;KACL;IACD,OAAO,WAAW,CAAC;AACvB,CAAC;AAED,SAAS,UAAU,CAAC,oBAA0C,EAAE,UAAiC;IAC7F,MAAM,QAAQ,GAAG,sBAAsB,CAAC,UAAU,CAAC,CAAC;IACpD,MAAM,MAAM,GAAG,eAAe,CAAC,oBAAoB,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;IAE3E,0BAA0B;IAC1B,IAAI,CAAC,MAAM,EAAE;QACT,MAAM,IAAI,KAAK,CACX,+CAA+C;YAC3C,UAAU,CAAC,IAAI;YACf,aAAa;YACb,UAAU,CAAC,SAAS;YACpB,WAAW;YACX,QAAQ,CACf,CAAC;KACL;IAED,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,YAAY,EAAE,QAAQ,EAAE,aAAa,EAAE,GACpH,UAAU,CAAC;IACf,OAAO;QACH,IAAI,EAAE,IAAA,mCAAgB,EAAC,UAAU,CAAC,IAAI,CAAC;QACvC,YAAY,EAAE,UAAU,CAAC,IAAI;QAC7B,QAAQ;QACR,YAAY;QACZ,OAAO;QACP,aAAa;QACb,SAAS;QACT,SAAS;QACT,WAAW;QACX,YAAY;QACZ,QAAQ;QACR,aAAa;QACb,MAAM;KACT,CAAC;AACN,CAAC;AACD,MAAa,oBAAqB,SAAQ,8BAAc;IAsBpD,YAAY,OAA8B;QACtC,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QAEnC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACjC,IAAI,CAAC,QAAQ,GAAG,qBAAa,CAAC,OAAO,CAAC;QAEtC,IAAI,IAAA,8BAAc,EAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YAC9B,IAAI,CAAC,QAAQ,GAAG,qBAAa,CAAC,KAAK,CAAC;SACvC;QACD,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;QAC9D,IAAI,CAAC,EAAE,GAAG,IAAI,0BAAM,EAAE,CAAC;QACvB,IAAI,CAAC,cAAc,GAAG,IAAI,0BAAM,EAAE,CAAC;QAEnC,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC9D,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;IAC5B,CAAC;IACM,QAAQ;;QACX,MAAM,GAAG,GAAa,EAAE,CAAC;QACzB,GAAG,CAAC,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1C,GAAG,CAAC,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC9C,GAAG,CAAC,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;QACnD,GAAG,CAAC,IAAI,CAAC,mBAAmB,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;QAC3G,GAAG,CAAC,IAAI,CAAC,mBAAmB,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;QACnG,GAAG,CAAC,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC;QACnD,GAAG,CAAC,IAAI,CAAC,2BAA2B,IAAG,MAAA,IAAI,CAAC,qBAAqB,0CAAE,QAAQ,EAAE,CAAA,CAAC,CAAC;QAC/E,GAAG,CAAC,IAAI,CAAC,2BAA2B,IAAG,MAAA,IAAI,CAAC,kBAAkB,0CAAE,QAAQ,EAAE,CAAA,CAAC,CAAC;QAC5E,GAAG,CAAC,IAAI,CAAC,2BAA2B,IAAG,MAAA,IAAI,CAAC,mBAAmB,0CAAE,QAAQ,EAAE,CAAA,CAAC,CAAC;QAC7E,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE;YACzB,GAAG,CAAC,IAAI,CACJ,eAAe;gBACX,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;gBACjB,YAAY;gBACZ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;gBAC1B,GAAG;gBACH,CAAC,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;gBACjC,CAAC,CAAC,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,aAAa,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC9D,CAAC,CAAC,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,kBAAkB,GAAG,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC,CAC9E,CAAC;SACL;QACD,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;CACJ;AAjED,oDAiEC;AAED;;;;;;GAMG;AACH,SAAgB,eAAe,CAAC,MAA6B;IACzD,IAAI,UAAU,GAAG,MAAM,CAAC,WAAW,CAAC;IACpC,IAAI,UAAU,EAAE;QACZ,OAAO,UAAU,CAAC;KACrB;IAED,IAAI,MAAM,CAAC,QAAQ,KAAK,iBAAiB,IAAI,MAAM,CAAC,QAAQ,KAAK,oBAAoB,EAAE;QACnF,OAAO,IAAI,CAAC;KACf;IACD,IAAI,MAAM,CAAC,QAAQ,KAAK,OAAO,EAAE;QAC7B,OAAO,IAAI,CAAC;KACf;IAED,IAAI,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,QAAQ,KAAK,cAAc,IAAI,MAAM,CAAC,QAAQ,KAAK,oBAAoB,EAAE;QACnG,IAAI,CAAC,IAAA,kDAAiB,EAAC,MAAM,CAAC,QAAQ,CAAC,EAAE;YACrC,OAAO,IAAI,CAAC;SACf;QACD,MAAM,QAAQ,GAAG,IAAA,4DAA2B,EAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAE9D,uBAAuB;QACvB,IAAI,CAAC,QAAQ,EAAE;YACX,MAAM,IAAI,KAAK,CAAC,2BAA2B,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;SAClE;QACD,IAAI,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE;YAC3B,UAAU,GAAG,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC;SAC1C;KACJ;IACD,4BAA4B;IAC5B,MAAM,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,OAAO,UAAU,CAAC;AACtB,CAAC;AA9BD,0CA8BC;AAED;;;;GAIG;AACH,SAAgB,kBAAkB,CAAC,MAA6B;IAC5D,+BAA+B;IAC/B,uBAAuB;IACvB,IAAI,MAAM,CAAC,eAAe,EAAE;QACxB,OAAO,MAAM,CAAC,eAAe,CAAC;KACjC;IACD,+CAA+C;IAC/C,IAAI,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAE9D,MAAM,UAAU,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;IAE3C,uBAAuB;IACvB,IAAI,UAAU,EAAE;QACZ,MAAM,MAAM,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC9C,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;KAClD;IAED,2BAA2B;IAC3B,MAAM,CAAC,eAAe,GAAG,cAAc,CAAC;IACxC,OAAO,cAAc,CAAC;AAC1B,CAAC;AApBD,gDAoBC;AAED;;;;;GAKG;AACH,SAAgB,wCAAwC,CAAC,GAAQ,EAAE,MAA6B,EAAE,OAAY;IAC1G,IAAI,CAAC,uBAAU,CAAC,iBAAiB,EAAE;QAC/B,OAAO,IAAI,CAAC,CAAC,eAAe;KAC/B;IAED,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;IAExB,uBAAuB;IACvB,IAAI,CAAC,CAAC,OAAO,KAAK,IAAI,IAAI,OAAO,OAAO,KAAK,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,OAAO,KAAK,QAAQ,CAAC,EAAE;QACtF,IAAI,OAAO,GAAG,KAAK,CAAC,GAAG,CAAC,yDAAyD,CAAC,GAAG,GAAG,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACrH,OAAO,IAAI,IAAI,CAAC;QAChB,OAAO,IAAI,KAAK,CAAC,GAAG,CAAC,eAAe,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACjE,OAAO,IAAI,IAAI,CAAC;QAChB,OAAO,IAAI,KAAK,CAAC,GAAG,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,OAAO,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAC5F,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;KAC5B;IAED,uBAAuB;IACvB,IAAI,OAAO,YAAY,GAAG,CAAC,WAAW,EAAE;QACpC,OAAO,IAAI,CAAC;KACf;IAED,+CAA+C;IAC/C,MAAM,cAAc,GAAa,GAAG,CAAC,WAAW,CAAC,cAAc,IAAI,MAAM,CAAC,eAAe,CAAC;IAE1F,mDAAmD;IACnD,MAAM,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAE3C,yEAAyE;IACzE,mEAAmE;IACnE,SAAS,UAAU,CAAI,EAAO,EAAE,EAAO;QACnC,OAAO,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC9E,CAAC;IACD,MAAM,oBAAoB,GAAG,UAAU,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC;IAEvE,0BAA0B;IAC1B,IAAI,oBAAoB,CAAC,MAAM,GAAG,CAAC,EAAE;QACjC,4BAA4B;QAC5B,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;QAC5C,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,mBAAmB,CAAC,EAAE,cAAc,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QAChF,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,kBAAkB,CAAC,EAAE,aAAa,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QAC3E,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,0BAA0B,CAAC,EAAE,oBAAoB,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QAC3F,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;KACtC;IACD,0BAA0B;IAC1B,IAAI,oBAAoB,CAAC,MAAM,KAAK,CAAC,EAAE;QACnC,4BAA4B;QAC5B,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,mBAAmB,CAAC,EAAE,cAAc,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QAChF,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,kBAAkB,CAAC,EAAE,aAAa,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QAC3E,MAAM,IAAI,KAAK,CAAC,kCAAkC,GAAG,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC,CAAC;KAC9F;IACD,OAAO,IAAI,CAAC;AAChB,CAAC;AApDD,4FAoDC;AAED,SAAgB,mBAAmB,CAAC,WAAkC;IAClE,OAAO,IAAI,oBAAoB,CAAC,WAAW,CAAC,CAAC;AACjD,CAAC;AAFD,kDAEC"}

package/dist/types.d.ts

@@ -1,110 +1,151 @@
-import { BinaryStream, OutputBinaryStream } from "node-opcua-binary-stream";
-import { Enum } from "node-opcua-enum";
-import { NodeId } from "node-opcua-nodeid";
-import { ConstructorFunc } from "./constructor_type";
-export interface CommonInterface {
-    name: string;
-    encode?: (value: any, stream: OutputBinaryStream) => void;
-    decode?: (stream: BinaryStream) => any;
-    coerce?: (value: any) => any;
-    toJSON?: (value: any) => any;
-    random?: () => any;
-    validate?: (value: any) => void;
-    defaultValue?: any;
-    computer_default_value(defaultValue: any): any;
-}
-export declare enum FieldCategory {
-    enumeration = "enumeration",
-    complex = "complex",
-    basic = "basic"
-}
-export interface StructuredTypeField {
-    name: string;
-    fieldType: string;
-    isArray?: boolean;
-    documentation?: string;
-    category: FieldCategory;
-    schema: CommonInterface;
-    fieldTypeConstructor?: ConstructorFunc;
-    subType?: string;
-    defaultValue?: any;
-    validate?: (value: any) => boolean;
-    decode?: (stream: BinaryStream) => any;
-    switchBit?: number;
-    switchValue?: number;
-}
-export interface FieldEnumeration extends StructuredTypeField {
-}
-export interface FieldComplex extends StructuredTypeField {
-}
-export interface FieldBasic extends StructuredTypeField {
-}
-export declare type FieldType = FieldEnumeration | FieldComplex | FieldBasic;
-export declare type DefaultValueFunc = () => any;
-export interface FieldInterfaceOptions {
-    name: string;
-    fieldType: string;
-    isArray?: boolean;
-    documentation?: string;
-    category?: FieldCategory;
-    defaultValue?: any | DefaultValueFunc;
-    schema?: any;
-    switchBit?: number;
-    switchValue?: number;
-}
-export interface StructuredTypeOptions {
-    name: string;
-    id?: number | NodeId;
-    fields: FieldInterfaceOptions[];
-    documentation?: string;
-    baseType: string;
-    _resolved?: boolean;
-    bitFields?: any[];
-    base?: StructuredTypeOptions;
-}
-export interface TypeSchemaConstructorOptions {
-    name: string;
-    category?: FieldCategory;
-    defaultValue?: any;
-    encode?: (value: any, stream: OutputBinaryStream) => void;
-    decode?: (stream: BinaryStream) => any;
-    coerce?: (value: any) => any;
-}
-export interface BasicTypeDefinitionOptions extends TypeSchemaConstructorOptions {
-    subType: string;
-    toJSON?: (value: any) => any;
-    random?: () => any;
-    validate?: (value: any) => void;
-}
-export interface BasicTypeDefinition extends CommonInterface {
-    subType: string;
-}
-export interface BuiltInTypeDefinition extends BasicTypeDefinition {
-}
-export interface EnumerationDefinition extends CommonInterface {
-    typedEnum: Enum;
-    documentation?: string;
-}
-export declare type TypeDefinition = BuiltInTypeDefinition | EnumerationDefinition | BasicTypeDefinition | TypeSchemaBase;
-/**
- * @class TypeSchemaBase
- * @param options {Object}
- * @constructor
- * create a new type Schema
- */
-export declare class TypeSchemaBase implements CommonInterface {
-    name: string;
-    defaultValue: any;
-    encode?: (value: any, stream: OutputBinaryStream) => void;
-    decode?: (stream: BinaryStream) => any;
-    coerce?: (value: any) => any;
-    toJSON?: () => string;
-    category: FieldCategory;
-    constructor(options: TypeSchemaConstructorOptions);
-    /**
-     * @method  computer_default_value
-     * @param defaultValue {*} the default value
-     * @return {*}
-     */
-    computer_default_value(defaultValue: unknown): any;
-}
+/**
+ * @module node-opcua-factory
+ */
+import { BinaryStream, OutputBinaryStream } from "node-opcua-binary-stream";
+import { Enum } from "node-opcua-enum";
+import { ExpandedNodeId, NodeId } from "node-opcua-nodeid";
+export declare enum FieldCategory {
+    enumeration = "enumeration",
+    complex = "complex",
+    basic = "basic"
+}
+export interface CommonInterface {
+    name: string;
+    defaultValue?: any;
+    encode?: (value: any, stream: OutputBinaryStream) => void;
+    decode?: (stream: BinaryStream) => any;
+    coerce?: (value: any) => any;
+    toJSON?: (value: any) => any;
+    category: FieldCategory;
+    random?: () => any;
+    validate?: (value: any) => void;
+    computer_default_value(defaultValue: any): any;
+    subType: string;
+    isAbstract: boolean;
+    isSubTypeOf(type: CommonInterface): boolean;
+}
+export interface FieldInterfaceOptions {
+    name: string;
+    defaultValue?: any | DefaultValueFunc;
+    fieldType: string;
+    isArray?: boolean;
+    documentation?: string;
+    category?: FieldCategory;
+    schema?: CommonInterface;
+    switchBit?: number;
+    switchValue?: number;
+    allowSubType?: boolean;
+    dataType?: NodeId;
+    basicDataType?: number;
+}
+export declare type Func1<T> = (value: any, field: StructuredTypeField, data: T, args?: any) => void;
+export interface DecodeDebugOptions {
+    tracer: any;
+    name: string;
+}
+export interface IBaseUAObject {
+    schema: IStructuredTypeSchema;
+    encode(stream: OutputBinaryStream): void;
+    decode(stream: BinaryStream): void;
+    binaryStoreSize(): number;
+    toString(...args: any[]): string;
+    isValid(): boolean;
+    explore(): string;
+    applyOnAllFields<T>(func: Func1<T>, data: T): void;
+    toJSON(): any;
+    decodeDebug(stream: BinaryStream, options: DecodeDebugOptions): void;
+    clone(): IBaseUAObject;
+}
+declare type BaseUAObjectConstructable = new (options?: any) => IBaseUAObject;
+export declare type ConstructorFunc = BaseUAObjectConstructable;
+export interface ConstructorFuncWithSchema extends ConstructorFunc {
+    schema: IStructuredTypeSchema;
+    possibleFields: string[];
+    encodingDefaultBinary: ExpandedNodeId;
+    encodingDefaultXml: ExpandedNodeId;
+    encodingDefaultJson?: ExpandedNodeId;
+}
+export interface StructuredTypeField {
+    name: string;
+    originalName: string;
+    fieldType: string;
+    isArray?: boolean;
+    documentation?: string;
+    category: FieldCategory;
+    defaultValue?: any | DefaultValueFunc;
+    schema: CommonInterface;
+    switchBit?: number;
+    switchValue?: number;
+    allowSubType?: boolean;
+    dataType?: NodeId;
+    basicDataType?: number;
+    fieldTypeConstructor?: ConstructorFunc;
+    subType?: string;
+    validate?: (value: any) => boolean;
+    decode?: (stream: BinaryStream) => any;
+}
+export interface FieldEnumeration extends StructuredTypeField {
+}
+export interface FieldComplex extends StructuredTypeField {
+}
+export interface FieldBasic extends StructuredTypeField {
+}
+export declare type FieldType = FieldEnumeration | FieldComplex | FieldBasic;
+export declare type DefaultValueFunc = () => any;
+export interface StructuredTypeOptions {
+    name: string;
+    id?: number | NodeId;
+    fields: FieldInterfaceOptions[];
+    documentation?: string;
+    baseType: string;
+    _resolved?: boolean;
+    bitFields?: any[];
+    base?: StructuredTypeOptions;
+}
+export interface TypeSchemaConstructorOptions {
+    name: string;
+    subType?: string;
+    isAbstract?: boolean;
+    category?: FieldCategory;
+    defaultValue?: any;
+    encode?: (value: any, stream: OutputBinaryStream) => void;
+    decode?: (stream: BinaryStream) => any;
+    coerce?: (value: any) => any;
+}
+export interface BasicTypeDefinitionOptionsB extends TypeSchemaConstructorOptions {
+    toJSON?: (value: any) => any;
+    random?: () => any;
+    validate?: (value: any) => void;
+}
+export interface BasicTypeDefinitionOptionsBase extends BasicTypeDefinitionOptionsB {
+}
+export interface BasicTypeDefinitionOptions extends BasicTypeDefinitionOptionsB {
+    subType: string;
+}
+export interface BasicTypeDefinition extends CommonInterface {
+    subType: string;
+}
+export interface BuiltInTypeDefinition extends BasicTypeDefinition {
+}
+export interface EnumerationDefinition extends CommonInterface {
+    typedEnum: Enum;
+    documentation?: string;
+}
+export declare type TypeDefinition = BuiltInTypeDefinition | EnumerationDefinition | BasicTypeDefinition | CommonInterface;
+export interface IStructuredTypeSchema extends CommonInterface {
+    fields: FieldType[];
+    id: NodeId;
+    dataTypeNodeId: NodeId;
+    baseType: string;
+    _possibleFields: string[];
+    _baseSchema: IStructuredTypeSchema | null;
+    documentation?: string;
+    isValid?: (options: any) => boolean;
+    decodeDebug?: (stream: BinaryStream, options: any) => any;
+    constructHook?: (options: any) => any;
+    encodingDefaultBinary?: ExpandedNodeId;
+    encodingDefaultXml?: ExpandedNodeId;
+    encodingDefaultJson?: ExpandedNodeId;
+    bitFields?: any[];
+}
+export {};

package/dist/types.js

@@ -1,52 +1,10 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TypeSchemaBase = exports.FieldCategory = void 0;
-/**
- * @module node-opcua-factory
- */
-const node_opcua_assert_1 = require("node-opcua-assert");
-var FieldCategory;
-(function (FieldCategory) {
-    FieldCategory["enumeration"] = "enumeration";
-    FieldCategory["complex"] = "complex";
-    FieldCategory["basic"] = "basic";
-})(FieldCategory = exports.FieldCategory || (exports.FieldCategory = {}));
-/**
- * @class TypeSchemaBase
- * @param options {Object}
- * @constructor
- * create a new type Schema
- */
-class TypeSchemaBase {
-    constructor(options) {
-        (0, node_opcua_assert_1.assert)(options.category !== null);
-        this.encode = options.encode || undefined;
-        this.decode = options.decode || undefined;
-        this.coerce = options.coerce;
-        this.category = options.category || FieldCategory.basic;
-        this.name = options.name;
-        for (const prop in options) {
-            if (Object.prototype.hasOwnProperty.call(options, prop)) {
-                this[prop] = options[prop];
-            }
-        }
-    }
-    /**
-     * @method  computer_default_value
-     * @param defaultValue {*} the default value
-     * @return {*}
-     */
-    computer_default_value(defaultValue) {
-        if (defaultValue === undefined) {
-            defaultValue = this.defaultValue;
-        }
-        if (typeof defaultValue === "function") {
-            // be careful not to cache this value , it must be call each time to make sure
-            // we do not end up with the same value/instance twice.
-            defaultValue = defaultValue();
-        }
-        return defaultValue;
-    }
-}
-exports.TypeSchemaBase = TypeSchemaBase;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FieldCategory = void 0;
+var FieldCategory;
+(function (FieldCategory) {
+    FieldCategory["enumeration"] = "enumeration";
+    FieldCategory["complex"] = "complex";
+    FieldCategory["basic"] = "basic";
+})(FieldCategory = exports.FieldCategory || (exports.FieldCategory = {}));
 //# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../source/types.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,yDAA2C;AA4B3C,IAAY,aAIX;AAJD,WAAY,aAAa;IACrB,4CAA2B,CAAA;IAC3B,oCAAmB,CAAA;IACnB,gCAAe,CAAA;AACnB,CAAC,EAJW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAIxB;AA4FD;;;;;GAKG;AACH,MAAa,cAAc;IASvB,YAAY,OAAqC;QAC7C,IAAA,0BAAM,EAAC,OAAO,CAAC,QAAQ,KAAK,IAAI,CAAC,CAAC;QAClC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,SAAS,CAAC;QAC1C,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,SAAS,CAAC;QAC1C,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,aAAa,CAAC,KAAK,CAAC;QACxD,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QAEzB,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE;YACxB,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE;gBACpD,IAAY,CAAC,IAAI,CAAC,GAAI,OAAe,CAAC,IAAI,CAAC,CAAC;aAChD;SACJ;IACL,CAAC;IAED;;;;OAIG;IACI,sBAAsB,CAAC,YAAqB;QAC/C,IAAI,YAAY,KAAK,SAAS,EAAE;YAC5B,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;SACpC;QACD,IAAI,OAAO,YAAY,KAAK,UAAU,EAAE;YACpC,8EAA8E;YAC9E,uDAAuD;YACvD,YAAY,GAAG,YAAY,EAAE,CAAC;SACjC;QACD,OAAO,YAAY,CAAC;IACxB,CAAC;CACJ;AAxCD,wCAwCC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../source/types.ts"],"names":[],"mappings":";;;AAOA,IAAY,aAIX;AAJD,WAAY,aAAa;IACrB,4CAA2B,CAAA;IAC3B,oCAAmB,CAAA;IACnB,gCAAe,CAAA;AACnB,CAAC,EAJW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAIxB"}