node-opcua-factory 2.73.1 → 2.76.0

package/dist/basic_type.d.ts

@@ -1,40 +1,40 @@
-import { BinaryStream, OutputBinaryStream } from "node-opcua-binary-stream";
-export interface BasicTypeOptions {
-    name: string;
-    subType: string;
-    encode?: (value: any, stream: OutputBinaryStream) => void;
-    decode?: (stream: BinaryStream) => void;
-    validate?: (value: any) => boolean;
-    coerce?: (value: any) => any;
-    toJSON?: (value: any) => any;
-    random?: () => any;
-    defaultValue?: any;
-}
-/**
- * register a Basic Type ,
- * A basic type is new entity type that resolved to  a SubType
- * @example:
- *
- *
- *   registerBasicType({name:"Duration"   ,subType:"Double"});
- *
- * @method registerBasicType
- * @param schema
- * @param schema.name {String}
- * @param schema.subType {String} mandatory, the basic type from which the new type derives.
- *
- * @param [schema.encode] {Function} optional,a specific encoder function to encode an instance of this type.
- * @param schema.encode.value  {*}
- * @param schema.encode.stream {BinaryStream}
- *
- * @param [schema.decode] optional,a specific decoder function that returns  the decode value out of the stream.
- * @param [schema.decode.stream] {BinaryStream}
- *
- * @param [schema.coerce]  optional, a method to convert a value into the request type.
- * @param schema.coerce.value {*} the value to coerce.
- *
- * @param [schema.random] optional, a method to construct a random object of this type
- *
- * @param [schema.toJSON]optional, a method to convert a value into the request type.
- */
-export declare function registerBasicType(schema: BasicTypeOptions): void;
+import { BinaryStream, OutputBinaryStream } from "node-opcua-binary-stream";
+export interface BasicTypeOptions {
+    name: string;
+    subType: string;
+    encode?: (value: any, stream: OutputBinaryStream) => void;
+    decode?: (stream: BinaryStream) => void;
+    validate?: (value: any) => boolean;
+    coerce?: (value: any) => any;
+    toJSON?: (value: any) => any;
+    random?: () => any;
+    defaultValue?: any;
+}
+/**
+ * register a Basic Type ,
+ * A basic type is new entity type that resolved to  a SubType
+ * @example:
+ *
+ *
+ *   registerBasicType({name:"Duration"   ,subType:"Double"});
+ *
+ * @method registerBasicType
+ * @param schema
+ * @param schema.name {String}
+ * @param schema.subType {String} mandatory, the basic type from which the new type derives.
+ *
+ * @param [schema.encode] {Function} optional,a specific encoder function to encode an instance of this type.
+ * @param schema.encode.value  {*}
+ * @param schema.encode.stream {BinaryStream}
+ *
+ * @param [schema.decode] optional,a specific decoder function that returns  the decode value out of the stream.
+ * @param [schema.decode.stream] {BinaryStream}
+ *
+ * @param [schema.coerce]  optional, a method to convert a value into the request type.
+ * @param schema.coerce.value {*} the value to coerce.
+ *
+ * @param [schema.random] optional, a method to construct a random object of this type
+ *
+ * @param [schema.toJSON]optional, a method to convert a value into the request type.
+ */
+export declare function registerBasicType(schema: BasicTypeOptions): void;

package/dist/basic_type.js

@@ -1,119 +1,119 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.registerBasicType = void 0;
-/**
- * @module node-opcua-factory
- */
-const node_opcua_assert_1 = require("node-opcua-assert");
-const node_opcua_basic_types_1 = require("node-opcua-basic-types");
-const node_opcua_debug_1 = require("node-opcua-debug");
-const builtin_types_1 = require("./builtin_types");
-const errorLog = (0, node_opcua_debug_1.make_errorLog)("Factory");
-/**
- * register a Basic Type ,
- * A basic type is new entity type that resolved to  a SubType
- * @example:
- *
- *
- *   registerBasicType({name:"Duration"   ,subType:"Double"});
- *
- * @method registerBasicType
- * @param schema
- * @param schema.name {String}
- * @param schema.subType {String} mandatory, the basic type from which the new type derives.
- *
- * @param [schema.encode] {Function} optional,a specific encoder function to encode an instance of this type.
- * @param schema.encode.value  {*}
- * @param schema.encode.stream {BinaryStream}
- *
- * @param [schema.decode] optional,a specific decoder function that returns  the decode value out of the stream.
- * @param [schema.decode.stream] {BinaryStream}
- *
- * @param [schema.coerce]  optional, a method to convert a value into the request type.
- * @param schema.coerce.value {*} the value to coerce.
- *
- * @param [schema.random] optional, a method to construct a random object of this type
- *
- * @param [schema.toJSON]optional, a method to convert a value into the request type.
- */
-function registerBasicType(schema) {
-    const exists = (0, builtin_types_1.hasBuiltInType)(schema.name);
-    /* istanbul ignore next */
-    if (exists) {
-        errorLog("registerBasicType:", schema);
-        throw new Error(`Basic Type ${schema.name} already registered`);
-    }
-    const name = schema.name;
-    const t = (0, builtin_types_1.getBuiltInType)(schema.subType);
-    /* istanbul ignore next */
-    if (!t) {
-        // tslint:disable-next-line:no-console
-        throw new Error(" cannot find subtype " + schema.subType);
-    }
-    (0, node_opcua_assert_1.assert)(typeof t.decode === "function");
-    const encodeFunc = schema.encode || t.encode;
-    (0, node_opcua_assert_1.assert)(typeof encodeFunc === "function");
-    const decodeFunc = schema.decode || t.decode;
-    (0, node_opcua_assert_1.assert)(typeof decodeFunc === "function");
-    const defaultValue = schema.defaultValue === undefined ? t.defaultValue : schema.defaultValue;
-    // assert(typeof defaultValue === "function");
-    const coerceFunc = schema.coerce || t.coerce;
-    const toJSONFunc = schema.toJSON || t.toJSON;
-    const random = schema.random || defaultValue;
-    const newSchema = {
-        name,
-        subType: schema.subType,
-        coerce: coerceFunc,
-        decode: decodeFunc,
-        encode: encodeFunc,
-        random,
-        defaultValue,
-        toJSON: toJSONFunc
-    };
-    (0, builtin_types_1.registerType)(newSchema);
-}
-exports.registerBasicType = registerBasicType;
-// =============================================================================================
-// Registering the Basic Type already defined int the OPC-UA Specification
-// =============================================================================================
-registerBasicType({ name: "Counter", subType: "UInt32" });
-// OPC Unified Architecture, part 3.0 $8.13 page 65
-registerBasicType({ name: "Duration", subType: "Double" });
-registerBasicType({ name: "UtcTime", subType: "DateTime" });
-registerBasicType({
-    name: "LocaleId",
-    subType: "String",
-    defaultValue: null,
-    decode: node_opcua_basic_types_1.decodeLocaleId,
-    encode: node_opcua_basic_types_1.encodeLocaleId,
-    validate: node_opcua_basic_types_1.validateLocaleId
-});
-registerBasicType({ name: "ContinuationPoint", subType: "ByteString" });
-registerBasicType({ name: "Image", subType: "ByteString" });
-registerBasicType({ name: "ImageBMP", subType: "Image" });
-registerBasicType({ name: "ImageGIF", subType: "Image" });
-registerBasicType({ name: "ImageJPG", subType: "Image" });
-registerBasicType({ name: "ImagePNG", subType: "Image" });
-registerBasicType({ name: "AudioDataType", subType: "ByteString" });
-registerBasicType({ name: "BitFieldMaskDataType", subType: "UInt64" });
-registerBasicType({ name: "DataSetFieldFlags", subType: "UInt16" });
-registerBasicType({ name: "DataSetFieldContentMask", subType: "UInt32" });
-registerBasicType({ name: "UadpNetworkMessageContentMask", subType: "UInt32" });
-registerBasicType({ name: "UadpDataSetMessageContentMask", subType: "UInt32" });
-registerBasicType({ name: "JsonNetworkMessageContentMask", subType: "UInt32" });
-registerBasicType({ name: "JsonDataSetMessageContentMask", subType: "UInt32" });
-registerBasicType({ name: "PermissionType", subType: "UInt32" });
-registerBasicType({ name: "AccessLevelType", subType: "Byte" });
-registerBasicType({ name: "AccessLevelExType", subType: "UInt32" });
-registerBasicType({ name: "EventNotifierType", subType: "Byte" });
-registerBasicType({ name: "AccessRestrictionType", subType: "UInt32" });
-registerBasicType({ name: "NormalizedString", subType: "String" });
-registerBasicType({ name: "DecimalString", subType: "String" });
-registerBasicType({ name: "DurationString", subType: "String" });
-registerBasicType({ name: "TimeString", subType: "String" });
-registerBasicType({ name: "DateString", subType: "String" });
-registerBasicType({ name: "Index", subType: "UInt32" });
-registerBasicType({ name: "VersionTime", subType: "UInt32" });
-registerBasicType({ name: "ApplicationInstanceCertificate", subType: "ByteString" });
-registerBasicType({ name: "AttributeWriteMask", subType: "UInt32" });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerBasicType = void 0;
+/**
+ * @module node-opcua-factory
+ */
+const node_opcua_assert_1 = require("node-opcua-assert");
+const node_opcua_basic_types_1 = require("node-opcua-basic-types");
+const node_opcua_debug_1 = require("node-opcua-debug");
+const builtin_types_1 = require("./builtin_types");
+const errorLog = (0, node_opcua_debug_1.make_errorLog)("Factory");
+/**
+ * register a Basic Type ,
+ * A basic type is new entity type that resolved to  a SubType
+ * @example:
+ *
+ *
+ *   registerBasicType({name:"Duration"   ,subType:"Double"});
+ *
+ * @method registerBasicType
+ * @param schema
+ * @param schema.name {String}
+ * @param schema.subType {String} mandatory, the basic type from which the new type derives.
+ *
+ * @param [schema.encode] {Function} optional,a specific encoder function to encode an instance of this type.
+ * @param schema.encode.value  {*}
+ * @param schema.encode.stream {BinaryStream}
+ *
+ * @param [schema.decode] optional,a specific decoder function that returns  the decode value out of the stream.
+ * @param [schema.decode.stream] {BinaryStream}
+ *
+ * @param [schema.coerce]  optional, a method to convert a value into the request type.
+ * @param schema.coerce.value {*} the value to coerce.
+ *
+ * @param [schema.random] optional, a method to construct a random object of this type
+ *
+ * @param [schema.toJSON]optional, a method to convert a value into the request type.
+ */
+function registerBasicType(schema) {
+    const exists = (0, builtin_types_1.hasBuiltInType)(schema.name);
+    /* istanbul ignore next */
+    if (exists) {
+        errorLog("registerBasicType:", schema);
+        throw new Error(`Basic Type ${schema.name} already registered`);
+    }
+    const name = schema.name;
+    const t = (0, builtin_types_1.getBuiltInType)(schema.subType);
+    /* istanbul ignore next */
+    if (!t) {
+        // tslint:disable-next-line:no-console
+        throw new Error(" cannot find subtype " + schema.subType);
+    }
+    (0, node_opcua_assert_1.assert)(typeof t.decode === "function");
+    const encodeFunc = schema.encode || t.encode;
+    (0, node_opcua_assert_1.assert)(typeof encodeFunc === "function");
+    const decodeFunc = schema.decode || t.decode;
+    (0, node_opcua_assert_1.assert)(typeof decodeFunc === "function");
+    const defaultValue = schema.defaultValue === undefined ? t.defaultValue : schema.defaultValue;
+    // assert(typeof defaultValue === "function");
+    const coerceFunc = schema.coerce || t.coerce;
+    const toJSONFunc = schema.toJSON || t.toJSON;
+    const random = schema.random || defaultValue;
+    const newSchema = {
+        name,
+        subType: schema.subType,
+        coerce: coerceFunc,
+        decode: decodeFunc,
+        encode: encodeFunc,
+        random,
+        defaultValue,
+        toJSON: toJSONFunc
+    };
+    (0, builtin_types_1.registerType)(newSchema);
+}
+exports.registerBasicType = registerBasicType;
+// =============================================================================================
+// Registering the Basic Type already defined int the OPC-UA Specification
+// =============================================================================================
+registerBasicType({ name: "Counter", subType: "UInt32" });
+// OPC Unified Architecture, part 3.0 $8.13 page 65
+registerBasicType({ name: "Duration", subType: "Double" });
+registerBasicType({ name: "UtcTime", subType: "DateTime" });
+registerBasicType({
+    name: "LocaleId",
+    subType: "String",
+    defaultValue: null,
+    decode: node_opcua_basic_types_1.decodeLocaleId,
+    encode: node_opcua_basic_types_1.encodeLocaleId,
+    validate: node_opcua_basic_types_1.validateLocaleId
+});
+registerBasicType({ name: "ContinuationPoint", subType: "ByteString" });
+registerBasicType({ name: "Image", subType: "ByteString" });
+registerBasicType({ name: "ImageBMP", subType: "Image" });
+registerBasicType({ name: "ImageGIF", subType: "Image" });
+registerBasicType({ name: "ImageJPG", subType: "Image" });
+registerBasicType({ name: "ImagePNG", subType: "Image" });
+registerBasicType({ name: "AudioDataType", subType: "ByteString" });
+registerBasicType({ name: "BitFieldMaskDataType", subType: "UInt64" });
+registerBasicType({ name: "DataSetFieldFlags", subType: "UInt16" });
+registerBasicType({ name: "DataSetFieldContentMask", subType: "UInt32" });
+registerBasicType({ name: "UadpNetworkMessageContentMask", subType: "UInt32" });
+registerBasicType({ name: "UadpDataSetMessageContentMask", subType: "UInt32" });
+registerBasicType({ name: "JsonNetworkMessageContentMask", subType: "UInt32" });
+registerBasicType({ name: "JsonDataSetMessageContentMask", subType: "UInt32" });
+registerBasicType({ name: "PermissionType", subType: "UInt32" });
+registerBasicType({ name: "AccessLevelType", subType: "Byte" });
+registerBasicType({ name: "AccessLevelExType", subType: "UInt32" });
+registerBasicType({ name: "EventNotifierType", subType: "Byte" });
+registerBasicType({ name: "AccessRestrictionType", subType: "UInt32" });
+registerBasicType({ name: "NormalizedString", subType: "String" });
+registerBasicType({ name: "DecimalString", subType: "String" });
+registerBasicType({ name: "DurationString", subType: "String" });
+registerBasicType({ name: "TimeString", subType: "String" });
+registerBasicType({ name: "DateString", subType: "String" });
+registerBasicType({ name: "Index", subType: "UInt32" });
+registerBasicType({ name: "VersionTime", subType: "UInt32" });
+registerBasicType({ name: "ApplicationInstanceCertificate", subType: "ByteString" });
+registerBasicType({ name: "AttributeWriteMask", subType: "UInt32" });
 //# sourceMappingURL=basic_type.js.map

package/dist/builtin_types.d.ts

@@ -1,46 +1,46 @@
-import { BinaryStream, OutputBinaryStream } from "node-opcua-binary-stream";
-import { BasicTypeDefinition, BasicTypeDefinitionOptions, BasicTypeDefinitionOptionsBase, CommonInterface, FieldCategory, TypeSchemaConstructorOptions } from "./types";
-/**
- * @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;
-    subType: string;
-    isAbstract: boolean;
-    constructor(options: TypeSchemaConstructorOptions);
-    /**
-     * @method  computer_default_value
-     * @param defaultValue {*} the default value
-     * @return {*}
-     */
-    computer_default_value(defaultValue: unknown): any;
-    getBaseType(): CommonInterface | null;
-    isSubTypeOf(type: CommonInterface): boolean;
-}
-export declare class BasicTypeSchema extends TypeSchemaBase implements BasicTypeDefinition {
-    subType: string;
-    isAbstract: boolean;
-    encode: (value: any, stream: OutputBinaryStream) => void;
-    decode: (stream: BinaryStream) => any;
-    constructor(options: BasicTypeDefinitionOptions);
-}
-/**
- * @method registerType
- * @param schema {TypeSchemaBase}
- */
-export declare function registerType(schema: BasicTypeDefinitionOptionsBase): void;
-export declare const registerBuiltInType: typeof registerType;
-export declare function unregisterType(typeName: string): void;
-export declare function getBuiltInType(name: string): TypeSchemaBase;
-export declare function hasBuiltInType(name: string): boolean;
-/** */
-export declare function findBuiltInType(dataTypeName: string): BasicTypeDefinition;
+import { BinaryStream, OutputBinaryStream } from "node-opcua-binary-stream";
+import { BasicTypeDefinition, BasicTypeDefinitionOptions, BasicTypeDefinitionOptionsBase, CommonInterface, FieldCategory, TypeSchemaConstructorOptions } from "./types";
+/**
+ * @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;
+    subType: string;
+    isAbstract: boolean;
+    constructor(options: TypeSchemaConstructorOptions);
+    /**
+     * @method  computer_default_value
+     * @param defaultValue {*} the default value
+     * @return {*}
+     */
+    computer_default_value(defaultValue: unknown): any;
+    getBaseType(): CommonInterface | null;
+    isSubTypeOf(type: CommonInterface): boolean;
+}
+export declare class BasicTypeSchema extends TypeSchemaBase implements BasicTypeDefinition {
+    subType: string;
+    isAbstract: boolean;
+    encode: (value: any, stream: OutputBinaryStream) => void;
+    decode: (stream: BinaryStream) => any;
+    constructor(options: BasicTypeDefinitionOptions);
+}
+/**
+ * @method registerType
+ * @param schema {TypeSchemaBase}
+ */
+export declare function registerType(schema: BasicTypeDefinitionOptionsBase): void;
+export declare const registerBuiltInType: typeof registerType;
+export declare function unregisterType(typeName: string): void;
+export declare function getBuiltInType(name: string): TypeSchemaBase;
+export declare function hasBuiltInType(name: string): boolean;
+/** */
+export declare function findBuiltInType(dataTypeName: string): BasicTypeDefinition;