node-opcua-factory 2.72.1 → 2.74.0

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");
+exports.FieldCategory = void 0;
 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;
 //# 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"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-opcua-factory",
-    "version": "2.72.1",
+    "version": "2.74.0",
     "description": "pure nodejs OPCUA SDK - module -factory",
     "main": "./dist/index.js",
     "types": "./dist/index.d.ts",
@@ -9,19 +9,20 @@
         "lint": "eslint source",
         "format": "prettier --write source",
         "clean": "npx rimraf dist *.tsbuildinfo",
-        "test": "echo no test"
+        "test": "mocha"
     },
     "dependencies": {
         "chalk": "4.1.2",
-        "node-opcua-assert": "2.66.0",
-        "node-opcua-basic-types": "2.72.1",
-        "node-opcua-binary-stream": "2.71.0",
-        "node-opcua-debug": "2.71.0",
-        "node-opcua-enum": "2.71.0",
-        "node-opcua-guid": "2.66.0",
-        "node-opcua-nodeid": "2.71.0",
-        "node-opcua-status-code": "2.71.0",
-        "node-opcua-utils": "2.71.0"
+        "node-opcua-assert": "2.74.0",
+        "node-opcua-basic-types": "2.74.0",
+        "node-opcua-binary-stream": "2.74.0",
+        "node-opcua-constants": "2.74.0",
+        "node-opcua-debug": "2.74.0",
+        "node-opcua-enum": "2.74.0",
+        "node-opcua-guid": "2.74.0",
+        "node-opcua-nodeid": "2.74.0",
+        "node-opcua-status-code": "2.74.0",
+        "node-opcua-utils": "2.74.0"
     },
     "author": "Etienne Rossignon",
     "license": "MIT",
@@ -38,5 +39,5 @@
         "internet of things"
     ],
     "homepage": "http://node-opcua.github.io/",
-    "gitHead": "ba98dd91a9eada9815268c66c98ca5391bc884e7"
+    "gitHead": "003ee041795f3b737afaaef5721045ee31ea9f77"
 }

package/source/{factories_baseobject.ts → base_ua_object.ts}

@@ -8,16 +8,28 @@ import * as chalk from "chalk";
 import { assert } from "node-opcua-assert";
 import { AttributeIds } from "node-opcua-basic-types";
 import { BinaryStream, BinaryStreamSizeCalculator, OutputBinaryStream } from "node-opcua-binary-stream";
-import { hexDump } from "node-opcua-debug";
+import { hexDump, make_errorLog } from "node-opcua-debug";
 import { NodeId } from "node-opcua-nodeid";
 import * as utils from "node-opcua-utils";
 
-import { getBuildInType } from "./factories_builtin_types";
-import { getEnumeration, hasEnumeration } from "./factories_enumerations";
-import { DataTypeFactory } from "./datatype_factory";
-import { getStructureTypeConstructor } from "./factories_factories";
-import { get_base_schema, StructuredTypeSchema } from "./factories_structuredTypeSchema";
-import { EnumerationDefinition, FieldCategory, StructuredTypeField, BuiltInTypeDefinition, FieldType } from "./types";
+import { getBuiltInEnumeration, hasBuiltInEnumeration } from "./enumerations";
+import { DataTypeFactory, _findFieldSchema } from "./datatype_factory";
+import { getStructureTypeConstructor } from "./get_standard_data_type_factory";
+import { get_base_schema } from "./structured_type_schema";
+import {
+    EnumerationDefinition,
+    FieldCategory,
+    StructuredTypeField,
+    BuiltInTypeDefinition,
+    FieldType,
+    CommonInterface,
+    Func1,
+    IStructuredTypeSchema,
+    IBaseUAObject,
+    DecodeDebugOptions
+} from "./types";
+
+const errorLog = make_errorLog(__filename);
 
 function r(str: string, length = 30) {
     return (str + "                                ").substring(0, length);
@@ -60,12 +72,10 @@ function _decode_member_(value: any, field: StructuredTypeField, stream: BinaryS
     return value;
 }
 
-type Func1 = (a: any, field: StructuredTypeField, data: ExploreParams, args: any) => void;
-
-function applyOnAllSchemaFields(self: BaseUAObject, schema: StructuredTypeSchema, data: ExploreParams, functor: Func1, args: any) {
+function _applyOnAllSchemaFields<T>(self: BaseUAObject, schema: IStructuredTypeSchema, data: T, functor: Func1<T>, args?: any) {
     const baseSchema = get_base_schema(schema);
     if (baseSchema) {
-        applyOnAllSchemaFields(self, baseSchema, data, functor, args);
+        _applyOnAllSchemaFields(self, baseSchema, data, functor, args);
     }
 
     for (const field of schema.fields) {
@@ -131,7 +141,6 @@ function _exploreObject(self: BaseUAObject, field: StructuredTypeField, data: Ex
     if (!self) {
         return;
     }
-    assert(self);
 
     const fieldType = field.fieldType;
 
@@ -153,9 +162,10 @@ function _exploreObject(self: BaseUAObject, field: StructuredTypeField, data: Ex
     if (field.switchValue !== undefined) {
         opt = " !" + field.switchValue + " ";
     }
-
+    const allowSubTypeSymbol = field.allowSubType ? "~" : " ";
+    const arraySymbol = field.isArray ? "[]" : "  ";
     const fieldNameF = chalk.yellow(r(padding + fieldName, 30));
-    const fieldTypeF = chalk.cyan("/* " + r(fieldType + opt, 17) + (field.isArray ? "[]" : "  ") + " */");
+    const fieldTypeF = chalk.cyan(`/* ${allowSubTypeSymbol}${r(fieldType + opt, 38)}${arraySymbol}  */`);
 
     // detected when optional field is not specified in value
     if (field.switchBit !== undefined && value === undefined) {
@@ -297,19 +307,12 @@ function _exploreObject(self: BaseUAObject, field: StructuredTypeField, data: Ex
             _dump_simple_value(self, field, data, value, fieldType);
         } else {
             const typeDictionary = (self.schema as any).$$factory as DataTypeFactory;
+
             // istanbul ignore next
             if (!typeDictionary) {
-                // tslint:disable-next-line: no-console
-                console.log(" No typeDictionary for ", self.schema);
+                errorLog("Internal Error: No typeDictionary for ", self.schema);
                 return;
             }
-            field.fieldTypeConstructor = field.fieldTypeConstructor || typeDictionary.getStructureTypeConstructor(fieldType);
-            const fieldTypeConstructor = field.fieldTypeConstructor;
-
-            const _newFieldSchema =
-                (field.schema as StructuredTypeSchema) ||
-                fieldTypeConstructor.prototype.schema ||
-                (fieldTypeConstructor as any).schema;
 
             if (field.isArray) {
                 if (value === null) {
@@ -322,13 +325,16 @@ function _exploreObject(self: BaseUAObject, field: StructuredTypeField, data: Ex
 
                     for (let i = 0; i < m; i++) {
                         const element = value[i];
-                        data.lines.push(padding + chalk.cyan("  { " + ("/*" + i + "*/")));
+
+                        const _newFieldSchema = _findFieldSchema(typeDictionary, field, element);
+
+                        data.lines.push(padding + `  { ` + chalk.cyan(`/* ${i} - ${_newFieldSchema?.name}*/`));
 
                         const data1 = {
                             lines: [] as string[],
                             padding: padding + "    "
                         };
-                        applyOnAllSchemaFields(element, _newFieldSchema, data1, _exploreObject, args);
+                        _applyOnAllSchemaFields(element, _newFieldSchema, data1, _exploreObject, args);
 
                         data.lines = data.lines.concat(data1.lines);
 
@@ -340,9 +346,10 @@ function _exploreObject(self: BaseUAObject, field: StructuredTypeField, data: Ex
                     data.lines.push(padding + "]");
                 }
             } else {
+                const _newFieldSchema = _findFieldSchema(typeDictionary, field, value);
                 data.lines.push(fieldNameF + " " + fieldTypeF + ": {");
                 const data1 = { padding: padding + "  ", lines: [] as string[] };
-                applyOnAllSchemaFields(value, _newFieldSchema, data1, _exploreObject, args);
+                _applyOnAllSchemaFields(value, _newFieldSchema, data1, _exploreObject, args);
                 data.lines = data.lines.concat(data1.lines);
 
                 data.lines.push(padding + "}");
@@ -383,7 +390,7 @@ function json_ify(t: BuiltInTypeDefinition, value: any, fieldType: FieldType) {
     }
 }
 
-function _JSONify(self: BaseUAObject, schema: StructuredTypeSchema, pojo: any) {
+function _JSONify(self: BaseUAObject, schema: IStructuredTypeSchema, pojo: any) {
     /* jshint validthis: true */
     for (const field of schema.fields) {
         const fieldValue = (self as any)[field.name];
@@ -391,8 +398,8 @@ function _JSONify(self: BaseUAObject, schema: StructuredTypeSchema, pojo: any) {
             continue;
         }
 
-        if (hasEnumeration(field.fieldType)) {
-            const enumeration = getEnumeration(field.fieldType);
+        if (hasBuiltInEnumeration(field.fieldType)) {
+            const enumeration = getBuiltInEnumeration(field.fieldType);
             assert(enumeration !== null);
             if (field.isArray) {
                 pojo[field.name] = fieldValue.map((value: any) => enumeration.enumValues[value.toString()]);
@@ -401,7 +408,7 @@ function _JSONify(self: BaseUAObject, schema: StructuredTypeSchema, pojo: any) {
             }
             continue;
         }
-        const t = getBuildInType(field.fieldType);
+        const t = field.schema as BuiltInTypeDefinition; // getBuiltInType(field.fieldType);
 
         if (field.isArray) {
             pojo[field.name] = fieldValue.map((value: any) => json_ify(t, value, field));
@@ -411,15 +418,8 @@ function _JSONify(self: BaseUAObject, schema: StructuredTypeSchema, pojo: any) {
     }
 }
 
-export interface DecodeDebugOptions {
-    tracer: any;
-    name: string;
-}
-
-/* tslint:disable:no-empty*/
-
-export interface BaseUAObject {
-    schema: StructuredTypeSchema;
+export interface BaseUAObject extends IBaseUAObject {
+    schema: IStructuredTypeSchema;
 }
 
 /**
@@ -458,7 +458,7 @@ export class BaseUAObject {
      */
     public binaryStoreSize(): number {
         const stream = new BinaryStreamSizeCalculator();
-        this.encode(stream as OutputBinaryStream);
+        this.encode(stream);
         return stream.length;
     }
 
@@ -548,12 +548,16 @@ export class BaseUAObject {
 
         data.lines.push("{" + chalk.cyan(" /*" + (this.schema ? this.schema.name : "") + "*/"));
         if (this.schema) {
-            applyOnAllSchemaFields(this, this.schema, data, _exploreObject, arguments);
+            this.applyOnAllFields(_exploreObject, data);
         }
         data.lines.push("};");
         return data.lines.join("\n");
     }
 
+    public applyOnAllFields<T>(func: Func1<T>, data: T): void {
+        _applyOnAllSchemaFields(this, this.schema, data, func, null);
+    }
+
     public toJSON(): any {
         assert(this.schema);
         if (this.schema.toJSON) {
@@ -579,7 +583,7 @@ export class BaseUAObject {
                     continue;
                 }
                 if (field.isArray) {
-                    options[field.name] = self[field.name];
+                    options[field.name] = [...self[field.name]];
                 } else {
                     options[field.name] = self[field.name];
                 }
@@ -594,9 +598,9 @@ export class BaseUAObject {
 
 function _visitSchemaChain(
     self: BaseUAObject,
-    schema: StructuredTypeSchema,
+    schema: IStructuredTypeSchema,
     pojo: any,
-    func: (self: BaseUAObject, schema: StructuredTypeSchema, pojo: any) => void,
+    func: (self: BaseUAObject, schema: IStructuredTypeSchema, pojo: any) => void,
     extraData: any
 ) {
     assert(typeof func === "function");

package/source/{factories_basic_type.ts → basic_type.ts}

@@ -4,10 +4,10 @@
 import { assert } from "node-opcua-assert";
 import { decodeLocaleId, encodeLocaleId, validateLocaleId } from "node-opcua-basic-types";
 import { BinaryStream, OutputBinaryStream } from "node-opcua-binary-stream";
+import { make_errorLog } from "node-opcua-debug";
+import { getBuiltInType, hasBuiltInType, registerType } from "./builtin_types";
 
-import { findSimpleType, hasBuiltInType, registerType } from "./factories_builtin_types";
-import { BasicTypeDefinition, BasicTypeDefinitionOptions } from "./types";
-
+const errorLog = make_errorLog("Factory");
 export interface BasicTypeOptions {
     name: string;
     subType: string;
@@ -51,14 +51,13 @@ export function registerBasicType(schema: BasicTypeOptions): void {
 
     /* istanbul ignore next */
     if (exists) {
-        // tslint:disable-next-line: no-console
-        console.log("registerBasicType:", schema);
+        errorLog("registerBasicType:", schema);
         throw new Error(`Basic Type ${schema.name} already registered`);
     }
 
     const name = schema.name;
 
-    const t: BasicTypeDefinition = findSimpleType(schema.subType);
+    const t = getBuiltInType(schema.subType);
 
     /* istanbul ignore next */
     if (!t) {
@@ -86,8 +85,8 @@ export function registerBasicType(schema: BasicTypeOptions): void {
         subType: schema.subType,
 
         coerce: coerceFunc,
-        decode: decodeFunc,
-        encode: encodeFunc,
+        decode: decodeFunc!,
+        encode: encodeFunc!,
 
         random,
 
@@ -105,15 +104,7 @@ export function registerBasicType(schema: BasicTypeOptions): void {
 registerBasicType({ name: "Counter", subType: "UInt32" });
 // OPC Unified Architecture, part 3.0 $8.13 page 65
 registerBasicType({ name: "Duration", subType: "Double" });
-registerBasicType({ name: "UAString", subType: "String" });
-registerBasicType({ name: "UABoolean", subType: "Boolean" });
 registerBasicType({ name: "UtcTime", subType: "DateTime" });
-// already ? registerBasicType({name: "Int8",     subType: "SByte"});
-// already ? registerBasicType({name: "UInt8",    subType: "Byte"});
-registerBasicType({ name: "Char", subType: "Byte" });
-// xx registerBasicType({name:"XmlElement" ,subType:"String"  });
-// xx registerBasicType({ name: "Time", subType: "String" });
-// string in the form "en-US" or "de-DE" or "fr" etc...
 
 registerBasicType({
     name: "LocaleId",
@@ -128,8 +119,6 @@ registerBasicType({
 
 registerBasicType({ name: "ContinuationPoint", subType: "ByteString" });
 registerBasicType({ name: "Image", subType: "ByteString" });
-registerBasicType({ name: "NodeIdType", subType: "NodeId" });
-
 registerBasicType({ name: "ImageBMP", subType: "Image" });
 registerBasicType({ name: "ImageGIF", subType: "Image" });
 registerBasicType({ name: "ImageJPG", subType: "Image" });
@@ -156,13 +145,3 @@ registerBasicType({ name: "Index", subType: "UInt32" });
 registerBasicType({ name: "VersionTime", subType: "UInt32" });
 registerBasicType({ name: "ApplicationInstanceCertificate", subType: "ByteString" });
 registerBasicType({ name: "AttributeWriteMask", subType: "UInt32" });
-registerBasicType({ name: "Date", subType: "DateTime" });
-
-// registerBasicType({ name: "Counter", subType: "UInt32" });
-// registerBasicType({ name: "IntegerId", subType: "UInt32" });
-// registerBasicType({ name: "UtcTime", subType: "DateTime" });
-// registerBasicType({ name: "Duration", subType: "Double" });
-// registerBasicType({ name: "LocaleId", subType: "String" });
-// registerBasicType({ name: "NumericRange", subType: "String" });
-// registerBasicType({ name: "Time", subType: "String" });
-// registerBasicType({ name: "SessionAuthenticationToken", subType: "NodeId" });