[ { "__docId__": 1, "kind": "external", "name": "Infinity", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Infinity", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Infinity", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 2, "kind": "external", "name": "NaN", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/NaN", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~NaN", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 3, "kind": "external", "name": "undefined", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~undefined", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 4, "kind": "external", "name": "null", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/null", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~null", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 5, "kind": "external", "name": "Object", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Object", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 6, "kind": "external", "name": "object", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~object", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 7, "kind": "external", "name": "Function", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Function", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 8, "kind": "external", "name": "function", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~function", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 9, "kind": "external", "name": "Boolean", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Boolean", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 10, "kind": "external", "name": "boolean", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~boolean", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 11, "kind": "external", "name": "Symbol", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Symbol", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 12, "kind": "external", "name": "Error", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Error", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 13, "kind": "external", "name": "EvalError", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/EvalError", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~EvalError", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 14, "kind": "external", "name": "InternalError", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/InternalError", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~InternalError", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 15, "kind": "external", "name": "RangeError", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RangeError", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~RangeError", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 16, "kind": "external", "name": "ReferenceError", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ReferenceError", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~ReferenceError", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 17, "kind": "external", "name": "SyntaxError", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SyntaxError", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~SyntaxError", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 18, "kind": "external", "name": "TypeError", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypeError", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~TypeError", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 19, "kind": "external", "name": "URIError", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/URIError", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~URIError", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 20, "kind": "external", "name": "Number", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Number", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 21, "kind": "external", "name": "number", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~number", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 22, "kind": "external", "name": "Date", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Date", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 23, "kind": "external", "name": "String", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~String", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 24, "kind": "external", "name": "string", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~string", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 25, "kind": "external", "name": "RegExp", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~RegExp", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 26, "kind": "external", "name": "Array", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Array", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 27, "kind": "external", "name": "Int8Array", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int8Array", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Int8Array", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 28, "kind": "external", "name": "Uint8Array", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Uint8Array", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 29, "kind": "external", "name": "Uint8ClampedArray", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8ClampedArray", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Uint8ClampedArray", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 30, "kind": "external", "name": "Int16Array", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int16Array", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Int16Array", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 31, "kind": "external", "name": "Uint16Array", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint16Array", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Uint16Array", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 32, "kind": "external", "name": "Int32Array", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int32Array", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Int32Array", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 33, "kind": "external", "name": "Uint32Array", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint32Array", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Uint32Array", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 34, "kind": "external", "name": "Float32Array", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float32Array", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Float32Array", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 35, "kind": "external", "name": "Float64Array", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float64Array", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Float64Array", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 36, "kind": "external", "name": "Map", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Map", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 37, "kind": "external", "name": "Set", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Set", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 38, "kind": "external", "name": "WeakMap", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakMap", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~WeakMap", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 39, "kind": "external", "name": "WeakSet", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakSet", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~WeakSet", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 40, "kind": "external", "name": "ArrayBuffer", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~ArrayBuffer", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 41, "kind": "external", "name": "DataView", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~DataView", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 42, "kind": "external", "name": "JSON", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~JSON", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 43, "kind": "external", "name": "Promise", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Promise", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 44, "kind": "external", "name": "Generator", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Generator", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Generator", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 45, "kind": "external", "name": "GeneratorFunction", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/GeneratorFunction", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~GeneratorFunction", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 46, "kind": "external", "name": "Reflect", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Reflect", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Reflect", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 47, "kind": "external", "name": "Proxy", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Proxy", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 48, "kind": "file", "name": "src/Gulpfile.js", "content": "import cleanup from 'node-cleanup';\nimport cleanupHandler from './util/cleanup';\n\n// Register tasks\nexport { default as pull } from './tasks/pull';\nexport { default as push } from './tasks/push';\nexport { default as watch } from './tasks/watch';\nexport { default as import } from './tasks/import';\n\n// Register cleanup\n/* istanbul ignore if */\nif (process.env.NODE_ENV !== 'test') {\n // Prevent node-opcua logging\n console.log = () => {}; // eslint-disable-line no-console\n\n cleanup((code, signal) => cleanupHandler(code, signal, cleanup.uninstall), {\n ctrl_C: '',\n unhandledRejection: '',\n });\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/Gulpfile.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 49, "kind": "file", "name": "src/api.js", "content": "import { NodeClass } from 'node-opcua/lib/datamodel/nodeclass';\nimport { DataType, VariantArrayType } from 'node-opcua/lib/datamodel/variant';\nimport { StatusCodes } from 'node-opcua/lib/datamodel/opcua_status_code';\nimport Session from './lib/server/Session';\nimport NodeId from './lib/model/opcua/NodeId';\n\n// Helpers\n/**\n * Creates a callback that calls `resolve` on success and `reject` on error.\n * @param {function(result: any): void} resolve The resolve callback.\n * @param {function(error: Error): void} reject The reject callback.\n * @example\n * // `aCallbackFn` is a function that accepts a node-style callback as the last argument\n * const promise = new Promise(\n * (resolve, reject) => aCallbackFn('other', 'args', promisifiedCallback(resolve, reject)\n * );\n */\nfunction promisifiedCallback(resolve, reject) {\n return (err, result) => {\n if (err) {\n return reject(err);\n }\n return resolve(result);\n };\n}\n\n/**\n * Promisifies a async function that would otherwise require a callback.\n * @param {function(cb: function(error: Error, result: any)):Promise} call A function that\n * accepts a callback and performs the async action to wrap.\n */\nfunction promisified(call) {\n return new Promise((resolve, reject) => call(promisifiedCallback(resolve, reject)));\n}\n\n/**\n * Creates a session, runs `action` and closes the session.\n * @param {function(session: Session): Promise} action The action to run a session.\n */\nasync function withSession(action) {\n const session = await Session.create();\n let result = null;\n let error = null;\n try {\n result = await action(session);\n } catch (e) {\n error = e;\n }\n\n await Session.close(session);\n\n if (error) {\n throw error;\n }\n\n return result;\n}\n\n// Reading/Writing\n\n/**\n * Reads a single node's value.\n * @param {NodeId} nodeId The node to read.\n * @return {Promise} The read value.\n */\nexport async function readNode(nodeId) {\n return withSession((session) => promisified((cb) => session.readVariableValue(nodeId, cb))).then(\n ({ value, statusCode }) => {\n if (statusCode !== StatusCodes.Good) {\n throw Object.assign(new Error(statusCode.description), { nodeId, statusCode });\n }\n\n return value;\n }\n );\n}\n\n/**\n * Writes a single node's value.\n * @param {NodeId} nodeId The node to write.\n * @param {Variant} value The value to write.\n * @return {Promise\n promisified((cb) => session.writeSingleNode(nodeId, value, cb))\n ).then((statusCode) => {\n if (statusCode !== StatusCodes.Good) {\n throw Object.assign(new Error(statusCode.description), { nodeId, statusCode });\n }\n\n return statusCode;\n });\n}\n\n// Methods / Scripts\n\n/**\n * Calls an OPC-UA method on the server.\n * @param {NodeId} methodId The method's id.\n * @param {Array} args The arguments to pass.\n */\nexport function callMethod(methodId, args = []) {\n return withSession((session) =>\n promisified((cb) =>\n session.call(\n [\n {\n objectId: methodId.parent,\n methodId,\n inputArguments: args,\n },\n ],\n cb\n )\n )\n ).then(([result] = []) => {\n if (result.statusCode.value) {\n throw Object.assign(new Error(result.statusCode.description), {\n methodId,\n inputArguments: args,\n });\n }\n\n return result;\n });\n}\n\n/**\n * Calls a server script on the server.\n * @param {NodeId} scriptId The script's id.\n * @param {Object} parameters The parameters to pass, given as a map of Variants, like\n * `{ name: { ... } }`.\n */\nexport function callScript(scriptId, parameters = {}) {\n return callMethod(new NodeId('AGENT.SCRIPT.METHODS.callScript'), [\n {\n dataType: DataType.NodeId,\n value: scriptId,\n },\n {\n dataType: DataType.NodeId,\n value: scriptId.parent,\n },\n {\n dataType: DataType.String,\n arrayType: VariantArrayType.Array,\n value: Object.keys(parameters),\n },\n {\n dataType: DataType.Variant,\n arrayType: VariantArrayType.Array,\n value: Object.values(parameters),\n },\n ]).then((result) => {\n const statusCode = result.outputArguments[0].value;\n\n if (statusCode.value) {\n throw Object.assign(\n new Error(`Script failed: ${statusCode.description}\n${result.outputArguments[1].value}`),\n {\n scriptId,\n parameters,\n }\n );\n }\n\n return result;\n });\n}\n\n/**\n * Creates a new Node on the server.\n * @param {NodeId} nodeId The new node's id.\n * @param {Object} options The options to use.\n * @param {string} options.name The node's name.\n * @param {NodeId} [options.parentNodeId] The node's parent, defaults to the calculated parent\n * (`Test` for `Test.Child`).\n * @param {node-opcua~NodeClass} [options.nodeClass] The node's class, defaults so\n * `node-opcua~NodeClass.Variable`.\n * @param {NodeId} [options.typeDefinition] The node's type definition, must be provided for\n * non-variable nodes.\n * @param {NodeId} [options.modellingRule] The node's modelling rule.\n * @param {string} [options.reference] Name of the type of the node's reference to it's parent.\n * @param {node-opcua~Variant} [options.value] The node's value, required for all variable nodes.\n */\nexport function createNode(\n nodeId,\n {\n name,\n parentNodeId = nodeId.parent,\n nodeClass = NodeClass.Variable,\n typeDefinition = new NodeId('ns=0;i=62'),\n modellingRule,\n reference,\n value,\n }\n) {\n const variableOptions =\n nodeClass.value === NodeClass.Variable.value\n ? {\n dataType: value.dataType.value,\n valueRank: value.arrayType ? value.arrayType.value : VariantArrayType.Scalar.value,\n value:\n value.arrayType && value.arrayType.value !== VariantArrayType.Scalar.value\n ? Array.from(value.value)\n : value.value,\n }\n : {};\n\n const is64Bit = value.dataType === DataType.Int64 || value.dataType === DataType.UInt64;\n if (is64Bit) {\n variableOptions.value = 0;\n }\n\n return callScript(new NodeId('SYSTEM.LIBRARY.ATVISE.SERVERSCRIPTS.atscm.CreateNode'), {\n paramObjString: {\n dataType: DataType.String,\n value: JSON.stringify(\n Object.assign(\n {\n nodeId,\n browseName: name,\n parentNodeId: parentNodeId || nodeId.parent,\n nodeClass: nodeClass.value,\n typeDefinition,\n modellingRule,\n reference,\n },\n variableOptions\n )\n ),\n },\n }).then(async (result) => {\n const [{ value: createdNode }] = result.outputArguments[3].value;\n\n if (createdNode && is64Bit) {\n await writeNode(nodeId, value);\n }\n\n return result;\n });\n}\n\n/**\n * Adds references to a node.\n * @param {NodeId} nodeId The node to add the references to.\n * @param {Object} references The references to add.\n * @return {Promise} Resolved once the references were added.\n * @example Add a simple reference\n * import { ReferenceTypeIds } from 'node-opcua/lib/opcua_node_ids';\n *\n * addReferences('AGENT.DISPLAYS.Main', {\n * [47]: ['VariableTypes.ATVISE.Display'],\n * // equals:\n * [ReferenceTypeIds.HasTypeDefinition]: ['VariableTypes.ATVISE.Display'],\n * })\n * .then(() => console.log('Done!'))\n * .catch(console.error);\n */\nexport function addReferences(nodeId, references) {\n return callScript(new NodeId('SYSTEM.LIBRARY.ATVISE.SERVERSCRIPTS.atscm.AddReferences'), {\n paramObjString: {\n dataType: DataType.String,\n value: JSON.stringify({\n nodeId,\n references: Object.entries(references).map(([type, items]) => ({\n referenceIdValue: parseInt(type, 10),\n items,\n })),\n }),\n },\n });\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/api.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 50, "kind": "function", "name": "promisifiedCallback", "memberof": "src/api.js", "generator": false, "async": false, "static": true, "longname": "src/api.js~promisifiedCallback", "access": "public", "export": false, "importPath": "atscm/src/api.js", "importStyle": null, "description": "Creates a callback that calls `resolve` on success and `reject` on error.", "examples": [ "// `aCallbackFn` is a function that accepts a node-style callback as the last argument\nconst promise = new Promise(\n (resolve, reject) => aCallbackFn('other', 'args', promisifiedCallback(resolve, reject)\n);" ], "lineNumber": 18, "params": [ { "nullable": null, "types": [ "function(result: any): void" ], "spread": false, "optional": false, "name": "resolve", "description": "The resolve callback." }, { "nullable": null, "types": [ "function(error: Error): void" ], "spread": false, "optional": false, "name": "reject", "description": "The reject callback." } ], "return": { "types": [ "*" ] }, "ignore": true }, { "__docId__": 51, "kind": "function", "name": "promisified", "memberof": "src/api.js", "generator": false, "async": false, "static": true, "longname": "src/api.js~promisified", "access": "public", "export": false, "importPath": "atscm/src/api.js", "importStyle": null, "description": "Promisifies a async function that would otherwise require a callback.", "lineNumber": 32, "params": [ { "nullable": null, "types": [ "function(cb: function(error: Error, result: any)):Promise" ], "spread": false, "optional": false, "name": "call", "description": "A function that\naccepts a callback and performs the async action to wrap." } ], "return": { "types": [ "*" ] }, "ignore": true }, { "__docId__": 52, "kind": "function", "name": "withSession", "memberof": "src/api.js", "generator": false, "async": true, "static": true, "longname": "src/api.js~withSession", "access": "public", "export": false, "importPath": "atscm/src/api.js", "importStyle": null, "description": "Creates a session, runs `action` and closes the session.", "lineNumber": 40, "params": [ { "nullable": null, "types": [ "function(session: Session): Promise" ], "spread": false, "optional": false, "name": "action", "description": "The action to run a session." } ], "return": { "types": [ "*" ] }, "ignore": true }, { "__docId__": 53, "kind": "function", "name": "readNode", "memberof": "src/api.js", "generator": false, "async": true, "static": true, "longname": "src/api.js~readNode", "access": "public", "export": true, "importPath": "atscm/src/api.js", "importStyle": "{readNode}", "description": "Reads a single node's value.", "lineNumber": 66, "params": [ { "nullable": null, "types": [ "NodeId" ], "spread": false, "optional": false, "name": "nodeId", "description": "The node to read." } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "The read value." } }, { "__docId__": 54, "kind": "function", "name": "writeNode", "memberof": "src/api.js", "generator": false, "async": false, "static": true, "longname": "src/api.js~writeNode", "access": "public", "export": true, "importPath": "atscm/src/api.js", "importStyle": "{writeNode}", "description": "Writes a single node's value.", "lineNumber": 84, "params": [ { "nullable": null, "types": [ "NodeId" ], "spread": false, "optional": false, "name": "nodeId", "description": "The node to write." }, { "nullable": null, "types": [ "Variant" ], "spread": false, "optional": false, "name": "value", "description": "The value to write." } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "optional": false, "name": "args", "description": "The arguments to pass." } ], "return": { "types": [ "*" ] } }, { "__docId__": 56, "kind": "function", "name": "callScript", "memberof": "src/api.js", "generator": false, "async": false, "static": true, "longname": "src/api.js~callScript", "access": "public", "export": true, "importPath": "atscm/src/api.js", "importStyle": "{callScript}", "description": "Calls a server script on the server.", "lineNumber": 135, "params": [ { "nullable": null, "types": [ "NodeId" ], "spread": false, "optional": false, "name": "scriptId", "description": "The script's id." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "parameters", "description": "The parameters to pass, given as a map of Variants, like\n`{ name: { ... } }`." } ], "return": { "types": [ "*" ] } }, { "__docId__": 57, "kind": "function", "name": "createNode", "memberof": "src/api.js", "generator": false, "async": false, "static": true, "longname": "src/api.js~createNode", "access": "public", "export": true, "importPath": "atscm/src/api.js", "importStyle": "{createNode}", "description": "Creates a new Node on the server.", "lineNumber": 188, "params": [ { "nullable": null, "types": [ "NodeId" ], "spread": false, "optional": false, "name": "nodeId", "description": "The new node's id." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options", "description": "The options to use." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "options.name", "description": "The node's name." }, { "nullable": null, "types": [ "NodeId" ], "spread": false, "optional": true, "name": "options.parentNodeId", "description": "The node's parent, defaults to the calculated parent\n(`Test` for `Test.Child`)." }, { "nullable": null, "types": [ "node-opcua~NodeClass" ], "spread": false, "optional": true, "name": "options.nodeClass", "description": "The node's class, defaults so\n`node-opcua~NodeClass.Variable`." }, { "nullable": null, "types": [ "NodeId" ], "spread": false, "optional": true, "name": "options.typeDefinition", "description": "The node's type definition, must be provided for\nnon-variable nodes." }, { "nullable": null, "types": [ "NodeId" ], "spread": false, "optional": true, "name": "options.modellingRule", "description": "The node's modelling rule." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": true, "name": "options.reference", "description": "Name of the type of the node's reference to it's parent." }, { "nullable": null, "types": [ "node-opcua~Variant" ], "spread": false, "optional": true, "name": "options.value", "description": "The node's value, required for all variable nodes." } ], "return": { "types": [ "*" ] } }, { "__docId__": 58, "kind": "function", "name": "addReferences", "memberof": "src/api.js", "generator": false, "async": false, "static": true, "longname": "src/api.js~addReferences", "access": "public", "export": true, "importPath": "atscm/src/api.js", "importStyle": "{addReferences}", "description": "Adds references to a node.", "examples": [ "Add a simple reference\nimport { ReferenceTypeIds } from 'node-opcua/lib/opcua_node_ids';\n\naddReferences('AGENT.DISPLAYS.Main', {\n [47]: ['VariableTypes.ATVISE.Display'],\n // equals:\n [ReferenceTypeIds.HasTypeDefinition]: ['VariableTypes.ATVISE.Display'],\n})\n .then(() => console.log('Done!'))\n .catch(console.error);" ], "lineNumber": 262, "params": [ { "nullable": null, "types": [ "NodeId" ], "spread": false, "optional": false, "name": "nodeId", "description": "The node to add the references to." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "references", "description": "The references to add." } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "Resolved once the references were added." } }, { "__docId__": 59, "kind": "file", "name": "src/config/ProjectConfig.js", "content": "/**\n * The path to the project's configuration file.\n * @type {string}\n */\nexport const path = process.env.ATSCM_CONFIG_PATH;\n\n/**\n * The current project's configuration.\n * @type {Atviseproject}\n */\nconst Config = require(path).default;\n\n/**\n * The current project's configuration, with overrides (through `ATSCM_PROJECT__` env vars) already\n * handled.\n */\nexport default class ProjectConfig extends Config {\n /**\n * Return the project configuration override for the given name if available.\n * @param {string} name The variable to return.\n * @type {string|undefined} The variables's value or `undefined`.\n */\n static _env(name) {\n return process.env[`ATSCM_PROJECT__${name}`];\n }\n\n /**\n * The atvise server's host. Can be overridden with the `ATSCM_PROJECT__HOST` env variable.\n * @type {string}\n */\n static get host() {\n return this._env('HOST') || super.host;\n }\n\n /**\n * The atvise server ports to use.\n * @type {Object}\n * @property {number} opc The OPC-UA port the atvise server runs on. Can be overridden with the\n * `ATSCM_PROJECT__PORT__OPC` env variable.\n * @property {number} http The HTTP port the atvise server can be reached at. Can be overridden\n * with the `ATSCM_PROJECT__PORT__HTTP` env variable.\n */\n static get port() {\n return {\n opc: parseInt(this._env('PORT__OPC'), 10) || super.port.opc,\n http: parseInt(this._env('PORT__HTTP'), 10) || super.port.http,\n };\n }\n\n /**\n * The login to use. Return false if no login is required (default).\n * @type {Object}\n * @property {string} username The username to log in with. Can be overridden with the\n * `ATSCM_PROJECT__LOGIN__USERNAME` env variable.\n * @property {string} password The password to log in with. Can be overridden with the\n * `ATSCM_PROJECT__LOGIN__PASSWORD` env variable.\n */\n static get login() {\n if (this._env('LOGIN__USERNAME') || this._env('LOGIN__PASSWORD')) {\n return {\n username: this._env('LOGIN__USERNAME') || super.login.username,\n password: this._env('LOGIN__PASSWORD') || super.login.password,\n };\n }\n\n return super.login;\n }\n\n /**\n * A regular expression matching all source nodes.\n * @type {RegExp};\n */\n static get sourceNodeRegExp() {\n if (!this._sourceNodeRegExp) {\n this._sourceNodesRegExp = new RegExp(\n `^(${this.nodes.map(({ value }) => `${value.replace(/\\./g, '\\\\.')}`).join('|')})`\n );\n }\n\n return this._sourceNodesRegExp;\n }\n\n /**\n * A regular expression matching all ignored nodes.\n * @type {RegExp};\n */\n static get ignoredNodesRegExp() {\n if (!this._ignoredNodesRegExp) {\n this._ignoredNodesRegExp = new RegExp(\n `^(${this.ignoreNodes.map(({ value }) => `${value.replace(/\\./g, '\\\\.')}`).join('|')})`\n );\n }\n\n return this._ignoredNodesRegExp;\n }\n\n /**\n * Returns `true` for all external (not in {@link Atviseproject.nodes} or ignored by\n * {@link Atviseproject.ignoreNodes}).\n * @param {string} id The node id to check.\n * @return {boolean} If the node is external.\n */\n static isExternal(id) {\n return !id.match(this.sourceNodeRegExp) || !!id.match(this.ignoredNodesRegExp);\n }\n\n /**\n * The connection timeout, in milliseconds. Can be overridden with the `ATSCM_PROJECT__TIMEOUT`\n * env variable.\n * @type {number}\n */\n static get timeout() {\n const env = this._env('TIMEOUT');\n return env ? parseInt(env, 10) : super.timeout;\n }\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/config/ProjectConfig.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 60, "kind": "variable", "name": "path", "memberof": "src/config/ProjectConfig.js", "static": true, "longname": "src/config/ProjectConfig.js~path", "access": "public", "export": true, "importPath": "atscm/src/config/ProjectConfig.js", "importStyle": "{path}", "description": "The path to the project's configuration file.", "lineNumber": 5, "type": { "nullable": null, "types": [ "string" ], "spread": false, "description": null } }, { "__docId__": 61, "kind": "variable", "name": "Config", "memberof": "src/config/ProjectConfig.js", "static": true, "longname": "src/config/ProjectConfig.js~Config", "access": "public", "export": false, "importPath": "atscm/src/config/ProjectConfig.js", "importStyle": null, "description": "The current project's configuration.", "lineNumber": 11, "type": { "nullable": null, "types": [ "Atviseproject" ], "spread": false, "description": null }, "ignore": true }, { "__docId__": 62, "kind": "class", "name": "ProjectConfig", "memberof": "src/config/ProjectConfig.js", "static": true, "longname": "src/config/ProjectConfig.js~ProjectConfig", "access": "public", "export": true, "importPath": "atscm/src/config/ProjectConfig.js", "importStyle": "ProjectConfig", "description": "The current project's configuration, with overrides (through `ATSCM_PROJECT__` env vars) already\nhandled.", "lineNumber": 17, "interface": false, "extends": [ "Config" ] }, { "__docId__": 63, "kind": "method", "name": "_env", "memberof": "src/config/ProjectConfig.js~ProjectConfig", "generator": false, "async": false, "static": true, "longname": "src/config/ProjectConfig.js~ProjectConfig._env", "access": "private", "description": "Return the project configuration override for the given name if available.", "lineNumber": 23, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "name", "description": "The variable to return." } ], "type": { "nullable": null, "types": [ "string", "undefined" ], "spread": false, "description": null }, "return": { "types": [ "*" ] } }, { "__docId__": 64, "kind": "get", "name": "host", "memberof": "src/config/ProjectConfig.js~ProjectConfig", "generator": false, "async": false, "static": true, "longname": "src/config/ProjectConfig.js~ProjectConfig.host", "access": "public", "description": "The atvise server's host. Can be overridden with the `ATSCM_PROJECT__HOST` env variable.", "lineNumber": 31, "type": { "nullable": null, "types": [ "string" ], "spread": false, "description": null } }, { "__docId__": 65, "kind": "get", "name": "port", "memberof": "src/config/ProjectConfig.js~ProjectConfig", "generator": false, "async": false, "static": true, "longname": "src/config/ProjectConfig.js~ProjectConfig.port", "access": "public", "description": "The atvise server ports to use.", "lineNumber": 43, "properties": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "opc", "description": "The OPC-UA port the atvise server runs on. Can be overridden with the\n`ATSCM_PROJECT__PORT__OPC` env variable." }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "http", "description": "The HTTP port the atvise server can be reached at. Can be overridden\nwith the `ATSCM_PROJECT__PORT__HTTP` env variable." } ], "type": { "nullable": null, "types": [ "Object" ], "spread": false, "description": null } }, { "__docId__": 66, "kind": "get", "name": "login", "memberof": "src/config/ProjectConfig.js~ProjectConfig", "generator": false, "async": false, "static": true, "longname": "src/config/ProjectConfig.js~ProjectConfig.login", "access": "public", "description": "The login to use. Return false if no login is required (default).", "lineNumber": 58, "properties": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "username", "description": "The username to log in with. Can be overridden with the\n`ATSCM_PROJECT__LOGIN__USERNAME` env variable." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "password", "description": "The password to log in with. Can be overridden with the\n`ATSCM_PROJECT__LOGIN__PASSWORD` env variable." } ], "type": { "nullable": null, "types": [ "Object" ], "spread": false, "description": null } }, { "__docId__": 67, "kind": "get", "name": "sourceNodeRegExp", "memberof": "src/config/ProjectConfig.js~ProjectConfig", "generator": false, "async": false, "static": true, "longname": "src/config/ProjectConfig.js~ProjectConfig.sourceNodeRegExp", "access": "public", "description": "A regular expression matching all source nodes.", "lineNumber": 73, "type": { "nullable": null, "types": [ "*" ], "spread": false, "description": null } }, { "__docId__": 68, "kind": "member", "name": "_sourceNodesRegExp", "memberof": "src/config/ProjectConfig.js~ProjectConfig", "static": true, "longname": "src/config/ProjectConfig.js~ProjectConfig._sourceNodesRegExp", "access": "private", "description": null, "lineNumber": 75, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 69, "kind": "get", "name": "ignoredNodesRegExp", "memberof": "src/config/ProjectConfig.js~ProjectConfig", "generator": false, "async": false, "static": true, "longname": "src/config/ProjectConfig.js~ProjectConfig.ignoredNodesRegExp", "access": "public", "description": "A regular expression matching all ignored nodes.", "lineNumber": 87, "type": { "nullable": null, "types": [ "*" ], "spread": false, "description": null } }, { "__docId__": 70, "kind": "member", "name": "_ignoredNodesRegExp", "memberof": "src/config/ProjectConfig.js~ProjectConfig", "static": true, "longname": "src/config/ProjectConfig.js~ProjectConfig._ignoredNodesRegExp", "access": "private", "description": null, "lineNumber": 89, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 71, "kind": "method", "name": "isExternal", "memberof": "src/config/ProjectConfig.js~ProjectConfig", "generator": false, "async": false, "static": true, "longname": "src/config/ProjectConfig.js~ProjectConfig.isExternal", "access": "public", "description": "Returns `true` for all external (not in {@link Atviseproject.nodes} or ignored by\n{@link Atviseproject.ignoreNodes}).", "lineNumber": 103, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "id", "description": "The node id to check." } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "If the node is external." } }, { "__docId__": 72, "kind": "get", "name": "timeout", "memberof": "src/config/ProjectConfig.js~ProjectConfig", "generator": false, "async": false, "static": true, "longname": "src/config/ProjectConfig.js~ProjectConfig.timeout", "access": "public", "description": "The connection timeout, in milliseconds. Can be overridden with the `ATSCM_PROJECT__TIMEOUT`\nenv variable.", "lineNumber": 112, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 73, "kind": "file", "name": "src/hooks/check-atserver.ts", "content": "import { VariableIds } from 'node-opcua/lib/opcua_node_ids';\nimport { readJson } from 'fs-extra';\nimport { coerce, satisfies, gtr, minVersion } from 'semver';\nimport Logger from 'gulplog';\nimport prompts from 'prompts';\nimport { red, yellow } from 'chalk';\nimport { readNode } from '../api';\nimport { engines } from '../../package.json';\nimport { updateJson } from '../lib/helpers/fs';\nimport NodeId from '../lib/model/opcua/NodeId';\nimport { HookContext } from './hooks';\n\nconst atserverVersionNodeId = new NodeId(\n `ns=0;i=${VariableIds.Server_ServerStatus_BuildInfo_SoftwareVersion}`\n);\n\nexport async function loadProjectRequirement(): Promise {\n const packageManifest = await readJson('./package.json');\n\n return packageManifest.engines && packageManifest.engines.atserver;\n}\n\nexport async function loadRemoteVersion(): Promise {\n const raw = (await readNode(atserverVersionNodeId)).value;\n\n return coerce(raw).version;\n}\n\nexport async function askForConfirmation({\n onAsk,\n ...options\n}: {\n message: string;\n onAsk?: () => void;\n}): Promise {\n if (!process.stdin.isTTY) return false;\n\n if (onAsk) onAsk();\n\n return (\n await prompts({\n type: 'confirm',\n name: 'confirmed',\n ...options,\n })\n ).confirmed;\n}\n\nexport async function approveToContinue(\n { log, continueOnError }: HookContext,\n error: Error\n): Promise {\n if (continueOnError) {\n log.warn(red(error.message));\n log.warn(`Using --continue, skipping...`);\n return;\n }\n\n const shouldContinue = await askForConfirmation({\n onAsk: () => Logger.error(red(error.message)),\n message: 'Do you want to continue anyway?',\n });\n\n if (!shouldContinue) {\n throw error;\n }\n}\n\nexport default async function checkAtserver(context: HookContext): Promise<{ version: string }> {\n const { log } = context;\n\n log.debug('Checking atserver version');\n\n const atscmRequirement = engines.atserver;\n\n const [projectRequirement, remoteVersion] = await Promise.all([\n loadProjectRequirement(),\n loadRemoteVersion(),\n ]);\n\n if (!satisfies(remoteVersion, atscmRequirement)) {\n log.debug(`Version ${remoteVersion} does not satisfy requirement ${atscmRequirement}`);\n log.warn(\n yellow(\n `Your atvise server version (${remoteVersion}) is not supported, it may or may not work.`\n )\n );\n\n if (gtr(remoteVersion, atscmRequirement)) {\n log.info(\n `You're running a newer version of atvise server. Please run 'atscm update' to check for updates.`\n );\n } else {\n log.info(`Please upgrade to atserver ${minVersion(atscmRequirement)} or above.`);\n }\n }\n\n let updatePackage = false;\n if (!projectRequirement) {\n log.info(`Your package.json file doesn't specify an atserver version, adding it...`);\n\n updatePackage = true;\n } else if (!satisfies(remoteVersion, projectRequirement)) {\n await approveToContinue(\n context,\n new Error(\n `Your project is setup with atserver ${projectRequirement} but you're using ${remoteVersion}`\n )\n );\n\n updatePackage = await askForConfirmation({\n message: `Use atvise server ${remoteVersion} as new default?`,\n });\n } else {\n log.debug(`Running against atserver ${remoteVersion}`);\n }\n\n if (updatePackage) {\n await updateJson<{ engines?: { atserver?: string } }>('./package.json', (current) => {\n /* eslint-disable no-param-reassign */\n if (!current.engines) current.engines = {};\n current.engines.atserver = remoteVersion;\n /* eslint-enable no-param-reassign */\n\n return current;\n });\n }\n\n return { version: remoteVersion };\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/hooks/check-atserver.ts", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 74, "kind": "variable", "name": "atserverVersionNodeId", "memberof": "src/hooks/check-atserver.ts", "static": true, "longname": "src/hooks/check-atserver.ts~atserverVersionNodeId", "access": "public", "export": false, "importPath": "atscm/src/hooks/check-atserver.ts", "importStyle": null, "description": null, "lineNumber": 11, "undocument": true, "type": { "types": [ "src/lib/model/opcua/NodeId.js~NodeId" ] }, "ignore": true }, { "__docId__": 75, "kind": "function", "name": "loadProjectRequirement", "memberof": "src/hooks/check-atserver.ts", "generator": false, "async": true, "static": true, "longname": "src/hooks/check-atserver.ts~loadProjectRequirement", "access": "public", "export": true, "importPath": "atscm/src/hooks/check-atserver.ts", "importStyle": "{loadProjectRequirement}", "description": "", "lineNumber": 17, "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 76, "kind": "function", "name": "loadRemoteVersion", "memberof": "src/hooks/check-atserver.ts", "generator": false, "async": true, "static": true, "longname": "src/hooks/check-atserver.ts~loadRemoteVersion", "access": "public", "export": true, "importPath": "atscm/src/hooks/check-atserver.ts", "importStyle": "{loadRemoteVersion}", "description": "", "lineNumber": 23, "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 77, "kind": "function", "name": "askForConfirmation", "memberof": "src/hooks/check-atserver.ts", "generator": false, "async": true, "static": true, "longname": "src/hooks/check-atserver.ts~askForConfirmation", "access": "public", "export": true, "importPath": "atscm/src/hooks/check-atserver.ts", "importStyle": "{askForConfirmation}", "description": "", "lineNumber": 29, "params": [ { "nullable": null, "types": [ "undefined" ], "spread": false, "optional": false, "name": "undefined", "description": "" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 78, "kind": "function", "name": "approveToContinue", "memberof": "src/hooks/check-atserver.ts", "generator": false, "async": true, "static": true, "longname": "src/hooks/check-atserver.ts~approveToContinue", "access": "public", "export": true, "importPath": "atscm/src/hooks/check-atserver.ts", "importStyle": "{approveToContinue}", "description": "", "lineNumber": 49, "params": [ { "nullable": null, "types": [ "HookContext" ], "spread": false, "optional": false, "name": "undefined", "description": "" }, { "nullable": null, "types": [ "Error" ], "spread": false, "optional": false, "name": "error", "description": "" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 79, "kind": "function", "name": "checkAtserver", "memberof": "src/hooks/check-atserver.ts", "generator": false, "async": true, "static": true, "longname": "src/hooks/check-atserver.ts~checkAtserver", "access": "public", "export": true, "importPath": "atscm/src/hooks/check-atserver.ts", "importStyle": "checkAtserver", "description": "", "lineNumber": 69, "params": [ { "nullable": null, "types": [ "HookContext" ], "spread": false, "optional": false, "name": "context", "description": "" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 80, "kind": "file", "name": "src/hooks/check-serverscripts.ts", "content": "import { satisfies as validVersion } from 'semver';\nimport { readNode } from '../api';\nimport { versionNode } from '../lib/server/scripts/version';\nimport { dependencies } from '../../package.json';\nimport { HookContext } from './hooks';\n\nexport default async function checkServerscripts({ log }: HookContext): Promise {\n log.debug('Checking installed serverscripts');\n\n const required = dependencies['@atscm/server-scripts'];\n let version;\n\n try {\n version = (await readNode(versionNode)).value;\n\n const [release] = version.split('-beta');\n const valid = validVersion(release, required);\n\n if (!valid) throw new Error('Invalid version');\n\n log.debug(`Serverscripts ${version} installed (${required} required)`);\n } catch (error) {\n throw Object.assign(\n new Error(`Invalid server script version: ${version || 'not installed'} (${required} required)\n- Please run 'atscm import' again to update`),\n { originalError: error }\n );\n }\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/hooks/check-serverscripts.ts", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 81, "kind": "function", "name": "checkServerscripts", "memberof": "src/hooks/check-serverscripts.ts", "generator": false, "async": true, "static": true, "longname": "src/hooks/check-serverscripts.ts~checkServerscripts", "access": "public", "export": true, "importPath": "atscm/src/hooks/check-serverscripts.ts", "importStyle": "checkServerscripts", "description": "", "lineNumber": 7, "params": [ { "nullable": null, "types": [ "HookContext" ], "spread": false, "optional": false, "name": "undefined", "description": "" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 82, "kind": "file", "name": "src/hooks/hooks.ts", "content": "/* eslint-disable import/prefer-default-export */\n\nimport Logger from 'gulplog';\n\nexport interface HookContext {\n continueOnError: boolean;\n log: typeof Logger;\n}\n\nexport function setupContext({ log, continueOnError }: Partial = {}): HookContext {\n return {\n log: log || Logger,\n continueOnError:\n continueOnError === undefined ? process.env.CONTINUE_ON_FAILURE === 'true' : continueOnError,\n };\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/hooks/hooks.ts", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 83, "kind": "function", "name": "setupContext", "memberof": "src/hooks/hooks.ts", "generator": false, "async": false, "static": true, "longname": "src/hooks/hooks.ts~setupContext", "access": "public", "export": true, "importPath": "atscm/src/hooks/hooks.ts", "importStyle": "{setupContext}", "description": "", "lineNumber": 10, "params": [ { "nullable": null, "types": [ "Partial" ], "spread": false, "optional": false, "name": "undefined", "description": "" } ], "return": { "nullable": null, "types": [ "HookContext" ], "spread": false, "description": "" } }, { "__docId__": 84, "kind": "file", "name": "src/index.js", "content": "export { default as Atviseproject } from './lib/config/Atviseproject';\nexport { default as ProjectConfig } from './config/ProjectConfig';\nexport { default as NodeId } from './lib/model/opcua/NodeId';\nexport { default as Transformer, TransformDirection } from './lib/transform/Transformer';\nexport { default as PartialTransformer } from './lib/transform/PartialTransformer';\nexport { default as SplittingTransformer } from './lib/transform/SplittingTransformer';\nexport { default as DisplayTransformer } from './transform/DisplayTransformer';\nexport * from './transform/ScriptTransformer';\nexport { default as NewlinesTransformer } from './transform/Newlines';\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/index.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 85, "kind": "file", "name": "src/init/InitTask.js", "content": "import { join } from 'path';\nimport { src, dest } from 'gulp';\nimport handlebars from 'gulp-compile-handlebars';\nimport replace from 'gulp-replace';\nimport helpers from 'handlebars-helpers';\nimport streamToPromise from 'stream-to-promise';\nimport through from 'through2';\nimport camelCase from 'camelcase';\nimport deps from '../../res/init/templates/dependencies.json';\n\n/**\n * Converts a string to pascal case.\n * @param {string} str The string to convert.\n */\nconst pascalCase = (str) => camelCase(str, { pascalCase: true });\n\n/**\n * Converts a value to a valid JavaScript literal.\n * @param {any} value The value to convert.\n */\nconst toLiteral = (value) =>\n ({\n string: `'${value}'`,\n }[typeof value] || JSON.stringify(value));\n\n/**\n * The action run when running \"atscm init\".\n */\nexport default class InitTask {\n /**\n * Returns the globs of the processed files for the given config lanugage.\n * @param {string} langId The configuration language used.\n * @return {string[]} Globs of the files to handle.\n */\n static filesToHandle(langId) {\n return [\n './general/**/*',\n './general/**/.*',\n `./lang/${langId}/**/*.*`,\n `./lang/${langId}/**/.*`,\n ].map((p) => join(__dirname, '../../res/init/templates', p));\n }\n\n /**\n * Runs the task with the given options.\n * @param {Object} options The options to use.\n * @return {Promise<{ install: string[] }, Error>} Resolved with information on further actions\n * to run or rejected if the task failed.\n */\n static async run(options) {\n const langId = options.configLang;\n\n const install = deps.lang[langId];\n\n const renameGitignore = through.obj((file, _, callback) => {\n if (file.basename === 'gitignore') {\n // eslint-disable-next-line no-param-reassign\n file.basename = '.gitignore';\n }\n\n callback(null, file);\n });\n\n const stream = src(this.filesToHandle(langId), { dot: true })\n .pipe(replace(/[\\s\\S]*\\/\\/\\* start output\\s*/, ''))\n .pipe(replace('__CONFIG_CLASS_NAME__', pascalCase(options.name)))\n .pipe(replace(/\\/\\/\\*\\s?/g, ''))\n .pipe(replace(/__INIT__.([a-z]+)/gi, (_, name) => toLiteral(options[name])))\n .pipe(renameGitignore)\n .pipe(\n handlebars(options, {\n helpers: helpers(),\n })\n )\n .pipe(dest('./'));\n\n await streamToPromise(stream);\n\n return { install };\n }\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/init/InitTask.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 86, "kind": "function", "name": "pascalCase", "memberof": "src/init/InitTask.js", "generator": false, "async": false, "static": true, "longname": "src/init/InitTask.js~pascalCase", "access": "public", "export": false, "importPath": "atscm/src/init/InitTask.js", "importStyle": null, "description": "Converts a string to pascal case.", "lineNumber": 15, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "str", "description": "The string to convert." } ], "return": null, "ignore": true }, { "__docId__": 87, "kind": "function", "name": "toLiteral", "memberof": "src/init/InitTask.js", "generator": false, "async": false, "static": true, "longname": "src/init/InitTask.js~toLiteral", "access": "public", "export": false, "importPath": "atscm/src/init/InitTask.js", "importStyle": null, "description": "Converts a value to a valid JavaScript literal.", "lineNumber": 21, "params": [ { "nullable": null, "types": [ "any" ], "spread": false, "optional": false, "name": "value", "description": "The value to convert." } ], "return": null, "ignore": true }, { "__docId__": 88, "kind": "class", "name": "InitTask", "memberof": "src/init/InitTask.js", "static": true, "longname": "src/init/InitTask.js~InitTask", "access": "public", "export": true, "importPath": "atscm/src/init/InitTask.js", "importStyle": "InitTask", "description": "The action run when running \"atscm init\".", "lineNumber": 29, "interface": false }, { "__docId__": 89, "kind": "method", "name": "filesToHandle", "memberof": "src/init/InitTask.js~InitTask", "generator": false, "async": false, "static": true, "longname": "src/init/InitTask.js~InitTask.filesToHandle", "access": "public", "description": "Returns the globs of the processed files for the given config lanugage.", "lineNumber": 35, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "langId", "description": "The configuration language used." } ], "return": { "nullable": null, "types": [ "string[]" ], "spread": false, "description": "Globs of the files to handle." } }, { "__docId__": 90, "kind": "method", "name": "run", "memberof": "src/init/InitTask.js~InitTask", "generator": false, "async": true, "static": true, "longname": "src/init/InitTask.js~InitTask.run", "access": "public", "description": "Runs the task with the given options.", "lineNumber": 50, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options", "description": "The options to use." } ], "return": { "nullable": null, "types": [ "Promise<{ install: string[] }, Error>" ], "spread": false, "description": "Resolved with information on further actions\nto run or rejected if the task failed." } }, { "__docId__": 91, "kind": "file", "name": "src/init/Options.js", "content": "import { basename } from 'path';\nimport InitOption from '../lib/init/Option';\nimport Atviseproject from '../lib/config/Atviseproject';\nimport Validator from './OptionsValidator';\n\n/**\n * A map providing dirnames for config langs\n * @type {Map}\n */\nexport const ConfigLangs = {\n 'ES2015 JavaScript': 'es2015',\n 'Regular JavaScript': 'es5',\n TypeScript: 'ts',\n};\n\n/**\n * Suggests a project name based on the name of the directory 'atscm init' was called in.\n * @param {string} dirname The current working directory's name.\n * @return {string} The suggested name.\n */\nfunction projectName(dirname) {\n if (dirname === 'atscm') {\n return 'atscm-project';\n }\n\n return dirname;\n}\n\n/**\n * Options available for the \"atscm init\" command.\n * @type {Object}\n * @property {InitOption} name The new project's name.\n * @property {InitOption} description The new project's description.\n * @property {InitOption} author The new project's author.\n * @property {InitOption} atviseHost The new project's atvise server host.\n * @property {InitOption} atvisePortOpc The new project's atvise server OPC port.\n * @property {InitOption} atvisePortHttp The new project's atvise server HTTP port.\n * @property {InitOption} useLogin If the new porject's atvise server requires login.\n * @property {InitOption} atviseUsername The new project's atvise server login name.\n * @property {InitOption} atvisePassword The new project's atvise server login password.\n * @property {InitOption} configLang The language to use for the new project's configuration.\n */\nexport const InitOptions = {\n name: new InitOption({\n message: 'Project name',\n default: projectName(basename(process.cwd())),\n validate: Validator.name,\n }),\n description: new InitOption('Project description'),\n author: new InitOption('Project author'),\n atviseHost: new InitOption('Atvise server host', Atviseproject.host),\n atvisePortOpc: new InitOption('Atvise OPC port', Atviseproject.port.opc),\n atvisePortHttp: new InitOption('Atvise HTTP port', Atviseproject.port.http),\n useLogin: new InitOption({\n message: 'Does your atvise server require login',\n type: 'confirm',\n default: false,\n }),\n atviseUser: new InitOption({\n message: ' - Username',\n when: (answers) => answers.useLogin,\n }),\n atvisePassword: new InitOption({\n message: ' - Password',\n when: (answers) => answers.useLogin,\n }),\n configLang: new InitOption({\n type: 'list',\n message: 'Configuration language to use',\n choices: Object.keys(ConfigLangs).map((name) => ({ name, value: ConfigLangs[name] })),\n }),\n};\n\n/**\n * {@link InitOptions}, exported as an array. Required to run {@link Inquirer}.\n * @type {InitOption[]}\n */\nconst InitOptionsAsArray = Object.keys(InitOptions).map((name) =>\n Object.assign({ name }, InitOptions[name])\n);\n\nexport default InitOptionsAsArray;\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/init/Options.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 92, "kind": "variable", "name": "ConfigLangs", "memberof": "src/init/Options.js", "static": true, "longname": "src/init/Options.js~ConfigLangs", "access": "public", "export": true, "importPath": "atscm/src/init/Options.js", "importStyle": "{ConfigLangs}", "description": "A map providing dirnames for config langs", "lineNumber": 10, "type": { "nullable": null, "types": [ "Map" ], "spread": false, "description": null } }, { "__docId__": 93, "kind": "function", "name": "projectName", "memberof": "src/init/Options.js", "generator": false, "async": false, "static": true, "longname": "src/init/Options.js~projectName", "access": "public", "export": false, "importPath": "atscm/src/init/Options.js", "importStyle": null, "description": "Suggests a project name based on the name of the directory 'atscm init' was called in.", "lineNumber": 21, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "dirname", "description": "The current working directory's name." } ], "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "The suggested name." }, "ignore": true }, { "__docId__": 94, "kind": "variable", "name": "InitOptions", "memberof": "src/init/Options.js", "static": true, "longname": "src/init/Options.js~InitOptions", "access": "public", "export": true, "importPath": "atscm/src/init/Options.js", "importStyle": "{InitOptions}", "description": "Options available for the \"atscm init\" command.", "lineNumber": 43, "properties": [ { "nullable": null, "types": [ "InitOption" ], "spread": false, "optional": false, "name": "name", "description": "The new project's name." }, { "nullable": null, "types": [ "InitOption" ], "spread": false, "optional": false, "name": "description", "description": "The new project's description." }, { "nullable": null, "types": [ "InitOption" ], "spread": false, "optional": false, "name": "author", "description": "The new project's author." }, { "nullable": null, "types": [ "InitOption" ], "spread": false, "optional": false, "name": "atviseHost", "description": "The new project's atvise server host." }, { "nullable": null, "types": [ "InitOption" ], "spread": false, "optional": false, "name": "atvisePortOpc", "description": "The new project's atvise server OPC port." }, { "nullable": null, "types": [ "InitOption" ], "spread": false, "optional": false, "name": "atvisePortHttp", "description": "The new project's atvise server HTTP port." }, { "nullable": null, "types": [ "InitOption" ], "spread": false, "optional": false, "name": "useLogin", "description": "If the new porject's atvise server requires login." }, { "nullable": null, "types": [ "InitOption" ], "spread": false, "optional": false, "name": "atviseUsername", "description": "The new project's atvise server login name." }, { "nullable": null, "types": [ "InitOption" ], "spread": false, "optional": false, "name": "atvisePassword", "description": "The new project's atvise server login password." }, { "nullable": null, "types": [ "InitOption" ], "spread": false, "optional": false, "name": "configLang", "description": "The language to use for the new project's configuration." } ], "type": { "nullable": null, "types": [ "Object" ], "spread": false, "description": null } }, { "__docId__": 95, "kind": "variable", "name": "InitOptionsAsArray", "memberof": "src/init/Options.js", "static": true, "longname": "src/init/Options.js~InitOptionsAsArray", "access": "public", "export": true, "importPath": "atscm/src/init/Options.js", "importStyle": "InitOptionsAsArray", "description": "{@link InitOptions}, exported as an array. Required to run {@link Inquirer}.", "lineNumber": 78, "type": { "nullable": null, "types": [ "InitOption[]" ], "spread": false, "description": null } }, { "__docId__": 96, "kind": "file", "name": "src/init/OptionsValidator.js", "content": "import validatePackageName from 'validate-npm-package-name';\n\n/**\n * A static class containing validators for the options used when running \"atscm init\".\n */\nexport default class InitOptionsValidator {\n /**\n * Validates a project name to be a valid npm package name.\n * @param {string} value The name to validate.\n * @return {boolean|string} Returns true if `value` is a valid npm package name, or an error\n * message otherwise.\n */\n static name(value) {\n const result = validatePackageName(value);\n\n if (result.errors) {\n return result.errors[0];\n }\n\n // First letter must be a letter\n if (value.match(/^@?[a-z]+/i) === null) {\n return 'name must start with a letter';\n }\n\n if (value === 'atscm') {\n return \"'atscm' is not allowed\";\n }\n\n return result.validForNewPackages ? true : result.warnings[0];\n }\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/init/OptionsValidator.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 97, "kind": "class", "name": "InitOptionsValidator", "memberof": "src/init/OptionsValidator.js", "static": true, "longname": "src/init/OptionsValidator.js~InitOptionsValidator", "access": "public", "export": true, "importPath": "atscm/src/init/OptionsValidator.js", "importStyle": "InitOptionsValidator", "description": "A static class containing validators for the options used when running \"atscm init\".", "lineNumber": 6, "interface": false }, { "__docId__": 98, "kind": "method", "name": "name", "memberof": "src/init/OptionsValidator.js~InitOptionsValidator", "generator": false, "async": false, "static": true, "longname": "src/init/OptionsValidator.js~InitOptionsValidator.name", "access": "public", "description": "Validates a project name to be a valid npm package name.", "lineNumber": 13, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "value", "description": "The name to validate." } ], "return": { "nullable": null, "types": [ "boolean", "string" ], "spread": false, "description": "Returns true if `value` is a valid npm package name, or an error\nmessage otherwise." } }, { "__docId__": 99, "kind": "file", "name": "src/init/init.js", "content": "import InitTask from './InitTask';\n\nexport default InitTask.run.bind(InitTask);\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/init/init.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 100, "kind": "file", "name": "src/lib/coding.js", "content": "import { DataType, VariantArrayType, Variant } from 'node-opcua/lib/datamodel/variant';\nimport { resolveNodeId } from 'node-opcua/lib/datamodel/nodeid';\nimport { LocalizedText } from 'node-opcua/lib/datamodel/localized_text';\nimport { StatusCodes } from 'node-opcua/lib/datamodel/opcua_status_code';\nimport { QualifiedName } from 'node-opcua/lib/datamodel/qualified_name';\nimport { DataValue } from 'node-opcua/lib/datamodel/datavalue';\nimport { ExpandedNodeId } from 'node-opcua/lib/datamodel/expanded_nodeid';\nimport { DiagnosticInfo } from 'node-opcua/lib/datamodel/diagnostic_info';\nimport { pick } from './helpers/Object';\n\n/**\n * Function that returns the passed argument as is.\n * @param {*} b The input argument.\n * @return {*} The value passed.\n */\nconst asIs = (b) => b;\n\n/**\n * Maps a single property of an object using the the mapper defined in *map* for the given\n * *dataType*.\n * @param {Map {\n if (obj[key]) {\n return Object.assign(obj, {\n [key]: map[dataType](obj[key]),\n });\n }\n\n return obj;\n};\n\n/**\n * A set of functions that return raw values from {@link node-opcua~Variant} for specific\n * {@link node-opcua~DataType}s.\n * @type {Map}\n */\nconst toRawValue = {\n [DataType.Null]: () => null,\n [DataType.StatusCode]: ({ name }) => name,\n [DataType.QualifiedName]: ({ namespaceIndex, name }) => ({ namespaceIndex, name }),\n [DataType.LocalizedText]: ({ text, locale }) => ({ text: text || null, locale }),\n [DataType.DataValue]: (value) => {\n const options = pick(value, [\n 'value',\n 'statusCode',\n 'sourceTimestamp',\n 'sourcePicoseconds',\n 'serverTimestamp',\n 'serverPicoseconds',\n ]);\n\n mapPropertyAs(toRawValue, options, 'value', DataType.Variant);\n mapPropertyAs(toRawValue, options, 'statusCode', DataType.StatusCode);\n // NOTE: server- and sourceTimstamps get mapped as dates\n\n return options;\n },\n [DataType.Variant]: ({ dataType, arrayType, value, dimensions }) => ({\n dataType,\n arrayType,\n // eslint-disable-next-line no-use-before-define\n value: getRawValue({ value, dataType, arrayType }),\n dimensions,\n }),\n [DataType.DiagnosticInfo]: (info) => {\n const options = pick(info, [\n 'namespaceUri',\n 'symbolicId',\n 'locale',\n 'localizedText',\n 'additionalInfo',\n 'innerStatusCode',\n 'innerDiagnosticInfo',\n ]);\n\n mapPropertyAs(toRawValue, options, 'innerStatusCode', DataType.StatusCode);\n mapPropertyAs(toRawValue, options, 'innerDiagnosticInfo', DataType.DiagnosticInfo);\n\n return options;\n },\n};\n\n/**\n * Returns the raw value for a {@link node-opcua~Variant}.\n * @param {node-opcua~Variant} variant The variant to convert.\n */\nfunction getRawValue({ value, dataType, arrayType }) {\n if (arrayType !== VariantArrayType.Scalar) {\n return (Array.isArray(value) ? value : Array.from(value)).map((val) =>\n getRawValue({\n value: val,\n dataType,\n arrayType: VariantArrayType[arrayType.value - 1],\n })\n );\n }\n\n return (toRawValue[dataType] || asIs)(value);\n}\n\n/**\n * Returns a buffer containing a {@link node-opcua~Variant}s encoded value.\n * @param {node-opcua~Variant} variant The variant to encode.\n * @return {Buffer} A buffer containing the encoded value.\n */\nexport function encodeVariant({ value, dataType, arrayType }) {\n if (value === null) {\n return Buffer.from([]);\n }\n\n const rawValue = getRawValue({ value, dataType, arrayType });\n\n if (rawValue instanceof Buffer) {\n return rawValue;\n }\n\n const stringify = (a) => (a.toJSON ? a.toJSON() : JSON.stringify(a, null, ' '));\n\n const stringified =\n typeof rawValue === 'object' ? stringify(rawValue) : rawValue.toString().trim();\n\n return Buffer.from(stringified);\n}\n\n/**\n * Decodes a buffer to a string.\n * @param {Buffer} b The buffer to decode from.\n * @return {string} The buffer's string representation.\n */\nconst decodeAsString = (b) => b.toString().trim();\n\n/**\n * Decodes a buffer to an integer value.\n * @param {Buffer} b The buffer to decode from.\n * @return {number} The decoded integer.\n */\nconst decodeAsInt = (b) => parseInt(decodeAsString(b), 10);\n\n/**\n * Decodes a buffer to a float value.\n * @param {Buffer} b The buffer to decode from.\n * @return {number} The decoded float.\n */\nconst decodeAsFloat = (b) => parseFloat(decodeAsString(b));\n\n/**\n * Decodes a buffer using JSON.\n * @param {Buffer} b The buffer to decode from.\n * @return {*} The decoded value, most likely an Object.\n */\nconst decodeAsJson = (b) => JSON.parse(b.toString());\n\n/**\n * Mapping functions that return raw values for a stored value of the given type.\n * @type {Map}\n */\nconst decodeRawValue = {\n [DataType.Null]: () => null,\n [DataType.Boolean]: (b) => decodeAsString(b) === 'true',\n [DataType.SByte]: decodeAsInt,\n [DataType.Byte]: decodeAsInt,\n [DataType.Int16]: decodeAsInt,\n [DataType.UInt16]: decodeAsInt,\n [DataType.Int32]: decodeAsInt,\n [DataType.UInt32]: decodeAsInt,\n [DataType.Int64]: decodeAsJson,\n [DataType.UInt64]: decodeAsJson,\n [DataType.Float]: decodeAsFloat,\n [DataType.Double]: decodeAsFloat,\n [DataType.String]: decodeAsString,\n [DataType.DateTime]: decodeAsString,\n [DataType.Guid]: decodeAsString,\n // ByteString maps to Buffer\n [DataType.XmlElement]: decodeAsString,\n [DataType.NodeId]: decodeAsString,\n [DataType.ExpandedNodeId]: decodeAsString,\n [DataType.StatusCode]: decodeAsString,\n [DataType.QualifiedName]: decodeAsJson,\n [DataType.LocalizedText]: decodeAsJson,\n // FIXME: Add ExtensionObject\n [DataType.DataValue]: decodeAsJson,\n [DataType.Variant]: decodeAsJson,\n [DataType.DiagnosticInfo]: decodeAsJson,\n};\n\n/**\n * Mapping functions that return OPC-UA node values for raw values.\n * @type {Map}\n */\nconst toNodeValue = {\n [DataType.DateTime]: (s) => new Date(s),\n [DataType.ByteString]: (b) => {\n if (b instanceof Buffer) {\n return b;\n }\n\n return Buffer.from(b.data, 'binary');\n },\n [DataType.NodeId]: (s) => resolveNodeId(s),\n\n // Jep, node-opcua does not provide a resolve function for expanded nodeids\n [DataType.ExpandedNodeId]: (s) => {\n const nodeId = resolveNodeId(s);\n const [value, ...defs] = nodeId.value.split(';');\n\n const { identifierType, namespace, namespaceUri, serverIndex } = defs.reduce((opts, def) => {\n const match = def.match(/^([^:]+):(.*)/);\n if (!match) {\n return opts;\n }\n\n let [key, val] = match.slice(1); // eslint-disable-line prefer-const\n\n if (key === 'serverIndex') {\n val = parseInt(val, 10);\n }\n\n return Object.assign(opts, { [key]: val });\n }, Object.assign({}, nodeId));\n\n return new ExpandedNodeId(identifierType, value, namespace, namespaceUri, serverIndex);\n },\n\n [DataType.StatusCode]: (name) => StatusCodes[name],\n [DataType.QualifiedName]: (options) => new QualifiedName(options),\n [DataType.LocalizedText]: (options) => new LocalizedText(options),\n [DataType.DataValue]: (options) => {\n const opts = options;\n\n mapPropertyAs(toNodeValue, opts, 'value', DataType.Variant);\n mapPropertyAs(toNodeValue, opts, 'statusCode', DataType.StatusCode);\n mapPropertyAs(toNodeValue, opts, 'sourceTimestamp', DataType.DateTime);\n mapPropertyAs(toNodeValue, opts, 'serverTimestamp', DataType.DateTime);\n\n return new DataValue(opts);\n },\n [DataType.Variant]: ({ dataType, arrayType, value, dimensions }) =>\n new Variant({\n dataType,\n arrayType: VariantArrayType[arrayType],\n value,\n dimensions,\n }),\n [DataType.DiagnosticInfo]: (options) => {\n const opts = options;\n\n mapPropertyAs(toNodeValue, opts, 'innerStatusCode', DataType.StatusCode);\n mapPropertyAs(toNodeValue, opts, 'innerDiagnosticInfo', DataType.DiagnosticInfo);\n\n return new DiagnosticInfo(opts);\n },\n};\n\n/**\n * Returns a node's OPC-UA value based on it's raw value and type.\n * @param {*} rawValue A node's raw value.\n * @param {node-opcua~DataType} dataType A node's data type.\n * @param {node-opcua~VariantArrayType} arrayType A node's array type.\n */\nconst getNodeValue = (rawValue, dataType, arrayType) => {\n if (arrayType.value !== VariantArrayType.Scalar.value) {\n if (!Array.isArray(rawValue)) {\n throw new Error('Value is not an array');\n }\n\n return rawValue.map((raw) =>\n getNodeValue(raw, dataType, VariantArrayType[arrayType.value - 1])\n );\n }\n\n return (toNodeValue[dataType] || asIs)(rawValue);\n};\n\n/**\n * Returns a {@link node-opcua~Variant} from a Buffer with the given *dataType* and *arrayType*.\n * @param {Buffer} buffer The buffer to decode from.\n * @param {Object} options The options to use.\n * @param {node-opcua~DataType} options.dataType The data type to decode to.\n * @param {node-opcua~VariantArrayType} options.arrayType The array type to decode to.\n */\nexport function decodeVariant(buffer, { dataType, arrayType }) {\n if (buffer === null || buffer.length === 0) {\n return null;\n }\n\n if (dataType === DataType.ByteString && arrayType === VariantArrayType.Scalar) {\n return buffer;\n }\n\n const rawValue =\n arrayType === VariantArrayType.Scalar\n ? (decodeRawValue[dataType] || asIs)(buffer)\n : JSON.parse(buffer.toString());\n\n return getNodeValue(rawValue, dataType, arrayType);\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/lib/coding.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 101, "kind": "function", "name": "asIs", "memberof": "src/lib/coding.js", "generator": false, "async": false, "static": true, "longname": "src/lib/coding.js~asIs", "access": "public", "export": false, "importPath": "atscm/src/lib/coding.js", "importStyle": null, "description": "Function that returns the passed argument as is.", "lineNumber": 16, "params": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "b", "description": "The input argument." } ], "return": { "nullable": null, "types": [ "*" ], "spread": false, "description": "The value passed." }, "ignore": true }, { "__docId__": 102, "kind": "function", "name": "mapPropertyAs", "memberof": "src/lib/coding.js", "generator": false, "async": false, "static": true, "longname": "src/lib/coding.js~mapPropertyAs", "access": "public", "export": false, "importPath": "atscm/src/lib/coding.js", "importStyle": null, "description": "Maps a single property of an object using the the mapper defined in *map* for the given\n*dataType*.", "lineNumber": 26, "params": [ { "nullable": null, "types": [ "Map" ], "spread": false, "description": null }, "ignore": true }, { "__docId__": 104, "kind": "function", "name": "getRawValue", "memberof": "src/lib/coding.js", "generator": false, "async": false, "static": true, "longname": "src/lib/coding.js~getRawValue", "access": "public", "export": false, "importPath": "atscm/src/lib/coding.js", "importStyle": null, "description": "Returns the raw value for a {@link node-opcua~Variant}.", "lineNumber": 91, "params": [ { "nullable": null, "types": [ "node-opcua~Variant" ], "spread": false, "optional": false, "name": "variant", "description": "The variant to convert." } ], "return": { "types": [ "*" ] }, "ignore": true }, { "__docId__": 105, "kind": "function", "name": "encodeVariant", "memberof": "src/lib/coding.js", "generator": false, "async": false, "static": true, "longname": "src/lib/coding.js~encodeVariant", "access": "public", "export": true, "importPath": "atscm/src/lib/coding.js", "importStyle": "{encodeVariant}", "description": "Returns a buffer containing a {@link node-opcua~Variant}s encoded value.", "lineNumber": 110, "params": [ { "nullable": null, "types": [ "node-opcua~Variant" ], "spread": false, "optional": false, "name": "variant", "description": "The variant to encode." } ], "return": { "nullable": null, "types": [ "Buffer" ], "spread": false, "description": "A buffer containing the encoded value." } }, { "__docId__": 106, "kind": "function", "name": "decodeAsString", "memberof": "src/lib/coding.js", "generator": false, "async": false, "static": true, "longname": "src/lib/coding.js~decodeAsString", "access": "public", "export": false, "importPath": "atscm/src/lib/coding.js", "importStyle": null, "description": "Decodes a buffer to a string.", "lineNumber": 134, "params": [ { "nullable": null, "types": [ "Buffer" ], "spread": false, "optional": false, "name": "b", "description": "The buffer to decode from." } ], "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "The buffer's string representation." }, "ignore": true }, { "__docId__": 107, "kind": "function", "name": "decodeAsInt", "memberof": "src/lib/coding.js", "generator": false, "async": false, "static": true, "longname": "src/lib/coding.js~decodeAsInt", "access": "public", "export": false, "importPath": "atscm/src/lib/coding.js", "importStyle": null, "description": "Decodes a buffer to an integer value.", "lineNumber": 141, "params": [ { "nullable": null, "types": [ "Buffer" ], "spread": false, "optional": false, "name": "b", "description": "The buffer to decode from." } ], "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "The decoded integer." }, "ignore": true }, { "__docId__": 108, "kind": "function", "name": "decodeAsFloat", "memberof": "src/lib/coding.js", "generator": false, "async": false, "static": true, "longname": "src/lib/coding.js~decodeAsFloat", "access": "public", "export": false, "importPath": "atscm/src/lib/coding.js", "importStyle": null, "description": "Decodes a buffer to a float value.", "lineNumber": 148, "params": [ { "nullable": null, "types": [ "Buffer" ], "spread": false, "optional": false, "name": "b", "description": "The buffer to decode from." } ], "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "The decoded float." }, "ignore": true }, { "__docId__": 109, "kind": "function", "name": "decodeAsJson", "memberof": "src/lib/coding.js", "generator": false, "async": false, "static": true, "longname": "src/lib/coding.js~decodeAsJson", "access": "public", "export": false, "importPath": "atscm/src/lib/coding.js", "importStyle": null, "description": "Decodes a buffer using JSON.", "lineNumber": 155, "params": [ { "nullable": null, "types": [ "Buffer" ], "spread": false, "optional": false, "name": "b", "description": "The buffer to decode from." } ], "return": { "nullable": null, "types": [ "*" ], "spread": false, "description": "The decoded value, most likely an Object." }, "ignore": true }, { "__docId__": 110, "kind": "variable", "name": "decodeRawValue", "memberof": "src/lib/coding.js", "static": true, "longname": "src/lib/coding.js~decodeRawValue", "access": "public", "export": false, "importPath": "atscm/src/lib/coding.js", "importStyle": null, "description": "Mapping functions that return raw values for a stored value of the given type.", "lineNumber": 161, "type": { "nullable": null, "types": [ "Map" ], "spread": false, "description": null }, "ignore": true }, { "__docId__": 111, "kind": "variable", "name": "toNodeValue", "memberof": "src/lib/coding.js", "static": true, "longname": "src/lib/coding.js~toNodeValue", "access": "public", "export": false, "importPath": "atscm/src/lib/coding.js", "importStyle": null, "description": "Mapping functions that return OPC-UA node values for raw values.", "lineNumber": 194, "type": { "nullable": null, "types": [ "Map" ], "spread": false, "description": null }, "ignore": true }, { "__docId__": 112, "kind": "function", "name": "getNodeValue", "memberof": "src/lib/coding.js", "generator": false, "async": false, "static": true, "longname": "src/lib/coding.js~getNodeValue", "access": "public", "export": false, "importPath": "atscm/src/lib/coding.js", "importStyle": null, "description": "Returns a node's OPC-UA value based on it's raw value and type.", "lineNumber": 264, "params": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "rawValue", "description": "A node's raw value." }, { "nullable": null, "types": [ "node-opcua~DataType" ], "spread": false, "optional": false, "name": "dataType", "description": "A node's data type." }, { "nullable": null, "types": [ "node-opcua~VariantArrayType" ], "spread": false, "optional": false, "name": "arrayType", "description": "A node's array type." } ], "return": { "types": [ "*" ] }, "ignore": true }, { "__docId__": 113, "kind": "function", "name": "decodeVariant", "memberof": "src/lib/coding.js", "generator": false, "async": false, "static": true, "longname": "src/lib/coding.js~decodeVariant", "access": "public", "export": true, "importPath": "atscm/src/lib/coding.js", "importStyle": "{decodeVariant}", "description": "Returns a {@link node-opcua~Variant} from a Buffer with the given *dataType* and *arrayType*.", "lineNumber": 285, "params": [ { "nullable": null, "types": [ "Buffer" ], "spread": false, "optional": false, "name": "buffer", "description": "The buffer to decode from." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options", "description": "The options to use." }, { "nullable": null, "types": [ "node-opcua~DataType" ], "spread": false, "optional": false, "name": "options.dataType", "description": "The data type to decode to." }, { "nullable": null, "types": [ "node-opcua~VariantArrayType" ], "spread": false, "optional": false, "name": "options.arrayType", "description": "The array type to decode to." } ], "return": { "types": [ "*" ] } }, { "__docId__": 114, "kind": "file", "name": "src/lib/config/Atviseproject.ts", "content": "/* eslint-disable no-useless-escape */\n\nimport NodeId from '../model/opcua/NodeId';\nimport DisplayTransformer from '../../transform/DisplayTransformer';\nimport {\n ServerscriptTransformer,\n QuickDynamicTransformer,\n DisplayScriptTransformer,\n} from '../../transform/ScriptTransformer';\nimport MappingTransformer from '../../transform/Mapping';\nimport AlarmConfigTransformer from '../../transform/AlarmConfigTransformer';\nimport { Transformer } from '../..';\n\ninterface AtserverPortConfiguration {\n /** The OPC-UA port the atvise-server runs on. */\n opc: number;\n /** The HTTP port the atvise-server can be reached at. */\n http: number;\n}\n\ninterface AtserverCredentials {\n /** The username to log in with. */\n username: string;\n /** The password to log in with. */\n password: string;\n}\n\ntype NodesConfiguration = Array;\n\n/**\n * An *atscm* project's configuration.\n * @abstract\n */\nexport default class Atviseproject {\n /**\n * The atvise-server's host. Defaults to *localhost*.\n */\n static get host(): string {\n return 'localhost';\n }\n\n /**\n * The atvise-server ports to use.\n */\n static get port(): AtserverPortConfiguration {\n return {\n opc: 4840,\n http: 80,\n };\n }\n\n /**\n * The login to use. Return `false` if no login is required (default).\n */\n static get login(): false | AtserverCredentials {\n return false;\n }\n\n private static get xmlTransformerOptions() {\n return {\n sortXMLAttributes: this.sortXMLAttributes,\n removeBuilderRefs: this.removeBuilderRefs,\n };\n }\n\n /**\n * The transformers to use in this project. Returns a {@link DisplayTransformer}, a\n * {@link ScriptTransformer} and a {@link NewlinesTransformer} by default.\n */\n static get useTransformers(): Transformer[] {\n return [\n new AlarmConfigTransformer(),\n new DisplayTransformer(this.xmlTransformerOptions),\n new ServerscriptTransformer(this.xmlTransformerOptions),\n new QuickDynamicTransformer(this.xmlTransformerOptions),\n new DisplayScriptTransformer(this.xmlTransformerOptions),\n new MappingTransformer() as any,\n ];\n }\n\n /**\n * The atvise-server nodes that atscm should sync. Defaults to the nodes *AGENT*, *SYSTEM*,\n * *ObjectTypes.PROJECT* and *VariableTypes.PROJECT*.\n */\n static get nodes(): NodesConfiguration {\n return [\n new NodeId('AGENT'),\n new NodeId('SYSTEM'),\n new NodeId('ObjectTypes.PROJECT'),\n new NodeId('VariableTypes.PROJECT'),\n ];\n }\n\n /**\n * The atvise-server nodes to watch in the corresponding tasks. Defaults to all nodes containing\n * displays.\n */\n static get nodesToWatch(): NodesConfiguration {\n return [new NodeId('AGENT.DISPLAYS'), new NodeId('SYSTEM.LIBRARY.PROJECT.OBJECTDISPLAYS')];\n }\n\n /**\n * An array of editor related node ids. They should be ignored in a atscm project.\n */\n static get EditorRelatedNodes(): NodesConfiguration {\n return [new NodeId('SYSTEM.JOURNALS.ProjectHistory')];\n }\n\n /**\n * An array of server related node ids. They should be ignored in a atscm project\n * as they are read-only.\n */\n static get ServerRelatedNodes(): NodesConfiguration {\n return [\n new NodeId('AGENT.OPCUA.server_url'),\n new NodeId('AGENT.WEBACCESS.https?[^.]+.(state)'),\n new NodeId('SYSTEM.INFORMATION.LOGS.'),\n new NodeId('AGENT.GENERATOR.METHODS'),\n new NodeId('AGENT.MIRROR.METHODS'),\n new NodeId('AGENT.HISTORY.METHODS'),\n new NodeId('AGENT.SCRIPT.METHODS'),\n new NodeId('AGENT.OPCUA.METHODS'),\n new NodeId('AGENT.ALARMING.METHODS'),\n ];\n }\n\n /**\n * Server nodes atscm manages itself. These include the serverscripts used during pull/push for\n * example.\n */\n static get AtscmRelatedNodes(): NodesConfiguration {\n return [new NodeId('SYSTEM.LIBRARY.ATVISE.SERVERSCRIPTS.atscm')];\n }\n\n /**\n * These nodes (and their subnodes, if any) will be ignored by atscm. Defaults to\n * {@link Atviseproject.EditorRelatedNodes} combined with\n * {@link Atviseproject.ServerRelatedNodes}.\n */\n static get ignoreNodes(): NodesConfiguration {\n return [...this.EditorRelatedNodes, ...this.ServerRelatedNodes, ...this.AtscmRelatedNodes];\n }\n\n /**\n * Returns an object containing the properties to inspect.\n * @see https://nodejs.org/api/util.html#util_util_inspect_object_options\n */\n static inspect() {\n return {\n host: this.host,\n port: this.port,\n login: this.login,\n useTransformers: this.useTransformers,\n nodes: this.nodes,\n nodesToWatch: this.nodesToWatch,\n ignoreNodes: this.ignoreNodes,\n };\n }\n\n /**\n * The *version control system* to optimize tasks for.\n * @since 1.0.0\n */\n static get vcs(): 'git' | 'svn' {\n return 'git';\n }\n\n /**\n * If atvise builder sort order nodes should be stored.\n * @since 1.0.0\n * @deprecated Mapping source order nodes leads to inconsistent results in many cases.\n */\n static get preserveSortOrderNodes(): boolean {\n return false;\n }\n\n /**\n * The connection timeout, in milliseconds.\n */\n static get timeout(): number {\n return 10000;\n }\n\n /**\n * Remove `atv:refpx` and `atv:refpy` attributes from XML to minimize diffs between pulls. This\n * will eventually default to *true* in a future atscm version.\n */\n static get removeBuilderRefs(): boolean {\n return false;\n }\n\n /**\n * Sort XML attributes to minimize diffs between pulls. This will eventually default to *true* in\n * a future atscm version.\n */\n static get sortXMLAttributes(): boolean {\n return false;\n }\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/lib/config/Atviseproject.ts", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 115, "kind": "class", "name": "Atviseproject", "memberof": "src/lib/config/Atviseproject.ts", "static": true, "longname": "src/lib/config/Atviseproject.ts~Atviseproject", "access": "public", "export": true, "importPath": "atscm/src/lib/config/Atviseproject.ts", "importStyle": "Atviseproject", "description": "An *atscm* project's configuration.", "lineNumber": 34, "interface": false }, { "__docId__": 116, "kind": "get", "name": "host", "memberof": "src/lib/config/Atviseproject.ts~Atviseproject", "generator": false, "async": false, "static": true, "longname": "src/lib/config/Atviseproject.ts~Atviseproject.host", "access": "public", "description": "The atvise-server's host. Defaults to *localhost*.", "lineNumber": 38, "type": { "nullable": null, "types": [ "string" ], "spread": false, "description": null } }, { "__docId__": 117, "kind": "get", "name": "port", "memberof": "src/lib/config/Atviseproject.ts~Atviseproject", "generator": false, "async": false, "static": true, "longname": "src/lib/config/Atviseproject.ts~Atviseproject.port", "access": "public", "description": "The atvise-server ports to use.", "lineNumber": 45, "type": { "nullable": null, "types": [ "AtserverPortConfiguration" ], "spread": false, "description": null } }, { "__docId__": 118, "kind": "get", "name": "login", "memberof": "src/lib/config/Atviseproject.ts~Atviseproject", "generator": false, "async": false, "static": true, "longname": "src/lib/config/Atviseproject.ts~Atviseproject.login", "access": "public", "description": "The login to use. Return `false` if no login is required (default).", "lineNumber": 55, "type": { "nullable": null, "types": [ "undefined" ], "spread": false, "description": null } }, { "__docId__": 119, "kind": "get", "name": "xmlTransformerOptions", "memberof": "src/lib/config/Atviseproject.ts~Atviseproject", "generator": false, "async": false, "static": true, "longname": "src/lib/config/Atviseproject.ts~Atviseproject.xmlTransformerOptions", "access": "public", "description": "", "lineNumber": 59, "type": { "types": [ "{\"sortXMLAttributes\": *, \"removeBuilderRefs\": *}" ] } }, { "__docId__": 120, "kind": "get", "name": "useTransformers", "memberof": "src/lib/config/Atviseproject.ts~Atviseproject", "generator": false, "async": false, "static": true, "longname": "src/lib/config/Atviseproject.ts~Atviseproject.useTransformers", "access": "public", "description": "The transformers to use in this project. Returns a {@link DisplayTransformer}, a\n{@link ScriptTransformer} and a {@link NewlinesTransformer} by default.", "lineNumber": 70, "type": { "nullable": null, "types": [ "undefined" ], "spread": false, "description": null } }, { "__docId__": 121, "kind": "get", "name": "nodes", "memberof": "src/lib/config/Atviseproject.ts~Atviseproject", "generator": false, "async": false, "static": true, "longname": "src/lib/config/Atviseproject.ts~Atviseproject.nodes", "access": "public", "description": "The atvise-server nodes that atscm should sync. Defaults to the nodes *AGENT*, *SYSTEM*,\nObjectTypes.PROJECT* and *VariableTypes.PROJECT*.", "lineNumber": 85, "type": { "nullable": null, "types": [ "NodesConfiguration" ], "spread": false, "description": null } }, { "__docId__": 122, "kind": "get", "name": "nodesToWatch", "memberof": "src/lib/config/Atviseproject.ts~Atviseproject", "generator": false, "async": false, "static": true, "longname": "src/lib/config/Atviseproject.ts~Atviseproject.nodesToWatch", "access": "public", "description": "The atvise-server nodes to watch in the corresponding tasks. Defaults to all nodes containing\ndisplays.", "lineNumber": 98, "type": { "nullable": null, "types": [ "NodesConfiguration" ], "spread": false, "description": null } }, { "__docId__": 123, "kind": "get", "name": "EditorRelatedNodes", "memberof": "src/lib/config/Atviseproject.ts~Atviseproject", "generator": false, "async": false, "static": true, "longname": "src/lib/config/Atviseproject.ts~Atviseproject.EditorRelatedNodes", "access": "public", "description": "An array of editor related node ids. They should be ignored in a atscm project.", "lineNumber": 105, "type": { "nullable": null, "types": [ "NodesConfiguration" ], "spread": false, "description": null } }, { "__docId__": 124, "kind": "get", "name": "ServerRelatedNodes", "memberof": "src/lib/config/Atviseproject.ts~Atviseproject", "generator": false, "async": false, "static": true, "longname": "src/lib/config/Atviseproject.ts~Atviseproject.ServerRelatedNodes", "access": "public", "description": "An array of server related node ids. They should be ignored in a atscm project\nas they are read-only.", "lineNumber": 113, "type": { "nullable": null, "types": [ "NodesConfiguration" ], "spread": false, "description": null } }, { "__docId__": 125, "kind": "get", "name": "AtscmRelatedNodes", "memberof": "src/lib/config/Atviseproject.ts~Atviseproject", "generator": false, "async": false, "static": true, "longname": "src/lib/config/Atviseproject.ts~Atviseproject.AtscmRelatedNodes", "access": "public", "description": "Server nodes atscm manages itself. These include the serverscripts used during pull/push for\nexample.", "lineNumber": 131, "type": { "nullable": null, "types": [ "NodesConfiguration" ], "spread": false, "description": null } }, { "__docId__": 126, "kind": "get", "name": "ignoreNodes", "memberof": "src/lib/config/Atviseproject.ts~Atviseproject", "generator": false, "async": false, "static": true, "longname": "src/lib/config/Atviseproject.ts~Atviseproject.ignoreNodes", "access": "public", "description": "These nodes (and their subnodes, if any) will be ignored by atscm. Defaults to\n{@link Atviseproject.EditorRelatedNodes} combined with\n{@link Atviseproject.ServerRelatedNodes}.", "lineNumber": 140, "type": { "nullable": null, "types": [ "NodesConfiguration" ], "spread": false, "description": null } }, { "__docId__": 127, "kind": "method", "name": "inspect", "memberof": "src/lib/config/Atviseproject.ts~Atviseproject", "generator": false, "async": false, "static": true, "longname": "src/lib/config/Atviseproject.ts~Atviseproject.inspect", "access": "public", "description": "Returns an object containing the properties to inspect.", "lineNumber": 148, "params": [], "return": { "types": [ "{\"host\": *, \"port\": *, \"login\": *, \"useTransformers\": *, \"nodes\": *, \"nodesToWatch\": *, \"ignoreNodes\": *}" ] } }, { "__docId__": 128, "kind": "get", "name": "vcs", "memberof": "src/lib/config/Atviseproject.ts~Atviseproject", "generator": false, "async": false, "static": true, "longname": "src/lib/config/Atviseproject.ts~Atviseproject.vcs", "access": "public", "description": "The *version control system* to optimize tasks for.", "lineNumber": 164, "type": { "nullable": null, "types": [ "undefined" ], "spread": false, "description": null } }, { "__docId__": 129, "kind": "get", "name": "preserveSortOrderNodes", "memberof": "src/lib/config/Atviseproject.ts~Atviseproject", "generator": false, "async": false, "static": true, "longname": "src/lib/config/Atviseproject.ts~Atviseproject.preserveSortOrderNodes", "access": "public", "description": "If atvise builder sort order nodes should be stored.", "lineNumber": 173, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 130, "kind": "get", "name": "timeout", "memberof": "src/lib/config/Atviseproject.ts~Atviseproject", "generator": false, "async": false, "static": true, "longname": "src/lib/config/Atviseproject.ts~Atviseproject.timeout", "access": "public", "description": "The connection timeout, in milliseconds.", "lineNumber": 180, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 131, "kind": "get", "name": "removeBuilderRefs", "memberof": "src/lib/config/Atviseproject.ts~Atviseproject", "generator": false, "async": false, "static": true, "longname": "src/lib/config/Atviseproject.ts~Atviseproject.removeBuilderRefs", "access": "public", "description": "Remove `atv:refpx` and `atv:refpy` attributes from XML to minimize diffs between pulls. This\nwill eventually default to *true* in a future atscm version.", "lineNumber": 188, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 132, "kind": "get", "name": "sortXMLAttributes", "memberof": "src/lib/config/Atviseproject.ts~Atviseproject", "generator": false, "async": false, "static": true, "longname": "src/lib/config/Atviseproject.ts~Atviseproject.sortXMLAttributes", "access": "public", "description": "Sort XML attributes to minimize diffs between pulls. This will eventually default to *true* in\na future atscm version.", "lineNumber": 196, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 133, "kind": "file", "name": "src/lib/gulp/ImportStream.js", "content": "import { DataType } from 'node-opcua/lib/datamodel/variant';\nimport Logger from 'gulplog';\nimport NodeId from '../model/opcua/NodeId';\nimport CallMethodStream from '../server/scripts/CallMethodStream';\n\n/**\n * The import operation's scope, which is set to be *absolute*.\n * @type {NodeId}\n */\nconst scopeId = new NodeId(NodeId.NodeIdType.NUMERIC, 0, 0);\n\n/**\n * A stream that imports xml files in parallel.\n */\nexport default class ImportStream extends CallMethodStream {\n /**\n * Id of the `importNodes` OPC-UA method.\n * @type {NodeId}\n */\n get methodId() {\n return new NodeId('ns=1;s=AGENT.OPCUA.METHODS.importNodes');\n }\n\n /**\n * Returns the arguments the `importNodes` needs to be called with for the given file.\n * @param {vinyl~File} file The file being processed.\n * @return {node-opcua~Variant[]} The arguments for the `importNodes` method:\n * - The import scope (which is set to be absolute)\n * - The XML code (read from *file*)\n * .\n */\n inputArguments(file) {\n return [\n {\n dataType: DataType.NodeId,\n value: scopeId,\n },\n {\n dataType: DataType.XmlElement,\n value: file.contents,\n },\n ];\n }\n\n /**\n * Returns an error message specifically for the given file.\n * @param {vinyl~File} file The file to generate the error message for.\n * @return {string} The specific error message.\n */\n processErrorMessage(file) {\n return `Error importing file: ${file.relative}`;\n }\n\n /**\n * Checks if the import succeeded and calls `callback` with an error otherwise.\n * @param {vinyl~File} file The file that was processed.\n * @param {?node-opcua~Variant[]} outputArguments The import status output arguments (Array with a\n * single entry).\n * @param {function(err: ?Error)} callback The callback called with an error if import failed.\n */\n handleOutputArguments(file, outputArguments, callback) {\n const [importStatus] = outputArguments || [{}];\n\n if (importStatus.value) {\n Logger.debug(`Successfully imported file: ${file.relative}`);\n\n callback(null);\n } else {\n callback(new Error('Import failed'));\n }\n }\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/lib/gulp/ImportStream.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 134, "kind": "variable", "name": "scopeId", "memberof": "src/lib/gulp/ImportStream.js", "static": true, "longname": "src/lib/gulp/ImportStream.js~scopeId", "access": "public", "export": false, "importPath": "atscm/src/lib/gulp/ImportStream.js", "importStyle": null, "description": "The import operation's scope, which is set to be *absolute*.", "lineNumber": 10, "type": { "nullable": null, "types": [ "NodeId" ], "spread": false, "description": null }, "ignore": true }, { "__docId__": 135, "kind": "class", "name": "ImportStream", "memberof": "src/lib/gulp/ImportStream.js", "static": true, "longname": "src/lib/gulp/ImportStream.js~ImportStream", "access": "public", "export": true, "importPath": "atscm/src/lib/gulp/ImportStream.js", "importStyle": "ImportStream", "description": "A stream that imports xml files in parallel.", "lineNumber": 15, "interface": false, "extends": [ "src/lib/server/scripts/CallMethodStream.js~CallMethodStream" ] }, { "__docId__": 136, "kind": "get", "name": "methodId", "memberof": "src/lib/gulp/ImportStream.js~ImportStream", "generator": false, "async": false, "static": false, "longname": "src/lib/gulp/ImportStream.js~ImportStream#methodId", "access": "public", "description": "Id of the `importNodes` OPC-UA method.", "lineNumber": 20, "type": { "nullable": null, "types": [ "NodeId" ], "spread": false, "description": null } }, { "__docId__": 137, "kind": "method", "name": "inputArguments", "memberof": "src/lib/gulp/ImportStream.js~ImportStream", "generator": false, "async": false, "static": false, "longname": "src/lib/gulp/ImportStream.js~ImportStream#inputArguments", "access": "public", "description": "Returns the arguments the `importNodes` needs to be called with for the given file.", "lineNumber": 32, "params": [ { "nullable": null, "types": [ "vinyl~File" ], "spread": false, "optional": false, "name": "file", "description": "The file being processed." } ], "return": { "nullable": null, "types": [ "node-opcua~Variant[]" ], "spread": false, "description": "The arguments for the `importNodes` method:\n - The import scope (which is set to be absolute)\n - The XML code (read from *file*)\n." } }, { "__docId__": 138, "kind": "method", "name": "processErrorMessage", "memberof": "src/lib/gulp/ImportStream.js~ImportStream", "generator": false, "async": false, "static": false, "longname": "src/lib/gulp/ImportStream.js~ImportStream#processErrorMessage", "access": "public", "description": "Returns an error message specifically for the given file.", "lineNumber": 50, "params": [ { "nullable": null, "types": [ "vinyl~File" ], "spread": false, "optional": false, "name": "file", "description": "The file to generate the error message for." } ], "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "The specific error message." } }, { "__docId__": 139, "kind": "method", "name": "handleOutputArguments", "memberof": "src/lib/gulp/ImportStream.js~ImportStream", "generator": false, "async": false, "static": false, "longname": "src/lib/gulp/ImportStream.js~ImportStream#handleOutputArguments", "access": "public", "description": "Checks if the import succeeded and calls `callback` with an error otherwise.", "lineNumber": 61, "params": [ { "nullable": null, "types": [ "vinyl~File" ], "spread": false, "optional": false, "name": "file", "description": "The file that was processed." }, { "nullable": true, "types": [ "node-opcua~Variant[]" ], "spread": false, "optional": false, "name": "outputArguments", "description": "The import status output arguments (Array with a\nsingle entry)." }, { "nullable": null, "types": [ "function(err: ?Error)" ], "spread": false, "optional": false, "name": "callback", "description": "The callback called with an error if import failed." } ], "return": null }, { "__docId__": 140, "kind": "file", "name": "src/lib/gulp/PullStream.js", "content": "import readline from 'readline';\nimport Logger from 'gulplog';\nimport ProjectConfig from '../../config/ProjectConfig';\nimport Transformer, { TransformDirection } from '../transform/Transformer';\nimport dest from './dest';\n\n/**\n * A stream that transforms read {@link ReadStream.ReadResult}s and stores the on the filesystem.\n */\nexport default class PullStream {\n /**\n * Creates a new PullStream based on a stream that writes {@link ReadStream.ReadResult} which may\n * be an instance of {@link ReadStream}.\n * @param {ReadStream} readStream The stream to read from.\n */\n constructor(readStream) {\n const printProgress = setInterval(() => {\n Logger.info(`Pulled: ${readStream.processed} (${readStream.opsPerSecond.toFixed(1)} ops/s)`);\n\n if (Logger.listenerCount('info') > 0) {\n readline.cursorTo(process.stdout, 0);\n readline.moveCursor(process.stdout, 0, -1);\n }\n }, 1000);\n\n return Transformer.applyTransformers(\n readStream,\n ProjectConfig.useTransformers,\n TransformDirection.FromDB\n )\n .pipe(dest('./src')) // FIXME: Get from config file\n .on('finish', () => {\n if (Logger.listenerCount('info') > 0) {\n readline.clearLine(process.stdout, 0);\n readline.cursorTo(process.stdout, 0);\n }\n\n clearInterval(printProgress);\n });\n }\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/lib/gulp/PullStream.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 141, "kind": "class", "name": "PullStream", "memberof": "src/lib/gulp/PullStream.js", "static": true, "longname": "src/lib/gulp/PullStream.js~PullStream", "access": "public", "export": true, "importPath": "atscm/src/lib/gulp/PullStream.js", "importStyle": "PullStream", "description": "A stream that transforms read {@link ReadStream.ReadResult}s and stores the on the filesystem.", "lineNumber": 10, "interface": false }, { "__docId__": 142, "kind": "constructor", "name": "constructor", "memberof": "src/lib/gulp/PullStream.js~PullStream", "generator": false, "async": false, "static": false, "longname": "src/lib/gulp/PullStream.js~PullStream#constructor", "access": "public", "description": "Creates a new PullStream based on a stream that writes {@link ReadStream.ReadResult} which may\nbe an instance of {@link ReadStream}.", "lineNumber": 16, "params": [ { "nullable": null, "types": [ "ReadStream" ], "spread": false, "optional": false, "name": "readStream", "description": "The stream to read from." } ] }, { "__docId__": 143, "kind": "file", "name": "src/lib/gulp/PushStream.js", "content": "import readline from 'readline';\nimport Logger from 'gulplog';\nimport ProjectConfig from '../../config/ProjectConfig';\nimport Transformer, { TransformDirection } from '../transform/Transformer';\nimport WriteStream from '../server/WriteStream';\nimport CreateNodeStream from '../server/CreateNodeStream';\nimport AddReferencesStream from '../server/AddReferencesStream';\n\n/**\n * A stream that transforms read {@link vinyl~File}s and pushes them to atvise server.\n */\nexport default class PushStream {\n /**\n * Creates a new PushSteam based on a source file stream.\n * @param {Stream} srcStream The file stream to read from.\n */\n constructor(srcStream) {\n const createStream = new CreateNodeStream();\n const addReferencesStream = new AddReferencesStream();\n const writeStream = new WriteStream(createStream, addReferencesStream);\n\n const printProgress = setInterval(() => {\n Logger.info(\n `Pushed: ${writeStream._processed} (${writeStream.opsPerSecond.toFixed(1)} ops/s)`\n );\n\n if (Logger.listenerCount('info') > 0) {\n readline.cursorTo(process.stdout, 0);\n readline.moveCursor(process.stdout, 0, -1);\n }\n }, 1000);\n\n return Transformer.applyTransformers(\n srcStream,\n ProjectConfig.useTransformers,\n TransformDirection.FromFilesystem\n )\n .pipe(writeStream)\n .pipe(createStream)\n .pipe(addReferencesStream)\n .on('finish', () => {\n if (Logger.listenerCount('info') > 0) {\n readline.cursorTo(process.stdout, 0);\n readline.clearLine(process.stdout);\n }\n\n clearInterval(printProgress);\n });\n }\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/lib/gulp/PushStream.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 144, "kind": "class", "name": "PushStream", "memberof": "src/lib/gulp/PushStream.js", "static": true, "longname": "src/lib/gulp/PushStream.js~PushStream", "access": "public", "export": true, "importPath": "atscm/src/lib/gulp/PushStream.js", "importStyle": "PushStream", "description": "A stream that transforms read {@link vinyl~File}s and pushes them to atvise server.", "lineNumber": 12, "interface": false }, { "__docId__": 145, "kind": "constructor", "name": "constructor", "memberof": "src/lib/gulp/PushStream.js~PushStream", "generator": false, "async": false, "static": false, "longname": "src/lib/gulp/PushStream.js~PushStream#constructor", "access": "public", "description": "Creates a new PushSteam based on a source file stream.", "lineNumber": 17, "params": [ { "nullable": null, "types": [ "Stream" ], "spread": false, "optional": false, "name": "srcStream", "description": "The file stream to read from." } ] }, { "__docId__": 146, "kind": "file", "name": "src/lib/gulp/dest.js", "content": "import { Writable } from 'stream';\nimport { join } from 'path';\nimport { EOL } from 'os';\nimport { NodeClass } from 'node-opcua/lib/datamodel/nodeclass';\nimport { outputFile, readJson } from 'fs-extra';\nimport hasha from 'hasha';\nimport Logger from 'gulplog';\nimport ProjectConfig from '../../config/ProjectConfig';\nimport { encodeVariant } from '../coding';\n\n/**\n * Relative path to the rename file.\n * @type {string}\n */\nexport const renameConfigPath = './atscm/rename.json';\n\n/**\n * The default name inserted into the rename file.\n * @type {string}\n */\nconst renameDefaultName = 'insert node name';\n\n/**\n * Options to pass to *hasha*.\n * @type {Object}\n */\nconst hashaOptions = { algorithm: 'md5' };\n\n/**\n * If checksums should be used to decide if writes are needed.\n * @type {boolean}\n */\nconst useChecksums = ProjectConfig.vcs === 'svn';\n\nconst escapePathComponent = (a) => a.replace(/\\//g, '%2F');\n\n/**\n * A stream that writes {@link Node}s to the file system.\n */\nexport class WriteStream extends Writable {\n /**\n * Creates a new WriteStream.\n * @param {Object} options The options to use.\n * @param {string} options.path The path to write to **(required)**.\n * @param {string} options.base The base path to write to (defaults to *path*).\n * @param {boolean} [options.cleanRenameConfig=false] If unused entries should be removed when\n * rename config is written.\n */\n constructor(options) {\n if (!options.path) {\n throw new Error('Missing `path` option');\n }\n\n super(Object.assign({}, options, { objectMode: true, highWaterMark: 10000 }));\n\n /**\n * If the stream is destroyed.\n * @type {boolean}\n */\n this._isDestroyed = false;\n\n /**\n * The number of processed nodes.\n * @type {number}\n */\n this._processed = 0;\n\n /**\n * The number of written nodes.\n * @type {number}\n */\n this._written = 0;\n\n /**\n * The base to output to.\n * @type {string}\n */\n this._base = options.base || options.path;\n\n /**\n * The object stored in the *rename file* (usually at './atscm/rename.json')\n */\n this._renameConfig = {};\n this._renamesUsed = {};\n this._cleanRenameConfig = options.cleanRenameConfig || false;\n\n /**\n * A promise that resolves once the *rename file* is loaded.\n * @type Promise\n */\n this._loadRenameConfig = readJson(renameConfigPath)\n .then((config) => (this._renameConfig = config))\n .catch(() => Logger.debug('No rename config file loaded'));\n\n /**\n * A map of ids used for renaming.\n */\n this._idMap = new Map();\n\n /**\n * If writes should actually be performed. Set to `false` once id conflicts were discovered.\n */\n this._performWrites = true;\n\n /**\n * The IDs that are affected by node id conflicts, lowercased.\n * @type {Set}\n */\n this._conflictingIds = new Set();\n\n /**\n * The number of id conflicts discovered.\n * @type {number}\n */\n this._discoveredIdConflicts = 0;\n\n if (useChecksums) {\n Logger.info('Optimizing for SVN diffs');\n }\n }\n\n /**\n * If the stream is destroyed.\n * @type {boolean}\n */\n get isDestroyed() {\n return this._isDestroyed;\n }\n\n /**\n * Transverses the node tree to see if any parent node has an id conflict.\n * @param {ServerNode} node The processed node.\n * @return {boolean} `true` if a parent node has an id conflict.\n */\n _parentHasIdConflict(node) {\n let current = node.parent;\n\n while (current) {\n if (this._conflictingIds.has(current.nodeId.toLowerCase())) {\n return true;\n }\n current = current.parent;\n }\n\n return false;\n }\n\n async _outputFile(path, content) {\n if (useChecksums) {\n const oldSum = await hasha.fromFile(path, hashaOptions).catch(() => null);\n\n if (oldSum) {\n if (oldSum === hasha(content, hashaOptions)) {\n Logger.debug(`Content did not change at ${path}`);\n return Promise.resolve();\n }\n\n Logger.debug(`Content changed at ${path}`);\n } else {\n Logger.debug(`No checksums for ${path}`);\n }\n }\n\n return outputFile(path, content);\n }\n\n /**\n * Writes a single node to disk.\n * @param {ServerNode} node The processed node.\n * @return {Promise} Resolves once the node has been written, `true` indicates the node\n * has actually been written.\n */\n async _writeNode(node) {\n // TODO: Throw if node.name ends with '.inner'\n const dirPath = node.filePath.map(escapePathComponent);\n\n const writeOps = [];\n\n // Rename nodes specified in the rename config\n const rename = this._renameConfig[node.id.value];\n if (rename && rename !== renameDefaultName) {\n this._renamesUsed[node.id.value] = true;\n node.renameTo(rename);\n Logger.debug(`'${node.nodeId}' was renamed to '${rename}'`);\n\n Object.assign(node, { _renamed: true });\n }\n\n // Resolve invalid ids\n if (!node._renamed && node.nodeId !== node.id.value) {\n Logger.debug(\n `Resolved ID conflict: '${node.id.value}' should be renamed to '${node.nodeId}'`\n );\n }\n\n Object.assign(node, { specialId: node.id.value });\n\n if (node.name.match(/:/)) {\n const before = node.name;\n node.renameTo(node.name.replace(/:/g, '_'));\n Logger.debug(`Resolved ID conflict: '${before}' was renamed to safe name '${node.name}'`);\n }\n\n // Detect \"duplicate\" ids (as file names are case insensitive)\n const pathKey = dirPath.concat(node.fileName).join('/').toLowerCase();\n if (this._idMap.has(pathKey)) {\n if (this._parentHasIdConflict(node)) {\n Logger.debug(`ID conflict: Skipping '${node.nodeId}'`);\n } else {\n Logger.error(`ID conflict: '${node.nodeId}' conflicts with '${this._idMap.get(pathKey)}'`);\n\n this._discoveredIdConflicts++;\n\n const existingRename = this._renameConfig[node.nodeId];\n if (existingRename) {\n if (existingRename === renameDefaultName) {\n // eslint-disable-next-line max-len\n Logger.error(\n ` - '${node.nodeId}' is present inside the rename file at './atscm/rename.json', but no name has been inserted yet.`\n );\n } else {\n // eslint-disable-next-line max-len\n Logger.error(\n ` - The name for '${node.nodeId}' inside './atscm/rename.json' is not unique.`\n );\n }\n\n Logger.info(\" - Edit the node's name and run 'atscm pull' again\");\n } else {\n this._renameConfig[node.nodeId] = renameDefaultName;\n Logger.info(` - '${node.nodeId}' was added to the rename file at './atscm/rename.json'`);\n Logger.info(\"Edit it's name and run 'atscm pull' again.\");\n }\n }\n\n this._conflictingIds.add(node.nodeId.toLowerCase());\n this._performWrites = false;\n } else {\n this._idMap.set(pathKey, node.nodeId);\n }\n\n // Write definition file (if needed)\n if (node.hasUnresolvedMetadata) {\n const name =\n node.nodeClass === NodeClass.Variable\n ? `./.${escapePathComponent(node.fileName)}.json`\n : `./${escapePathComponent(node.fileName)}/.${node.nodeClass.key}.json`;\n\n if (this._performWrites) {\n writeOps.push(\n this._outputFile(\n join(this._base, dirPath.join('/'), name),\n JSON.stringify(node.metadata, null, ' ')\n )\n );\n }\n }\n\n // Write value\n if (node.nodeClass === NodeClass.Variable) {\n if (node.value) {\n if (!node.value.noWrite) {\n if (this._performWrites) {\n writeOps.push(\n this._outputFile(\n join(this._base, dirPath.join('/'), escapePathComponent(node.fileName)),\n encodeVariant(node.value)\n )\n );\n }\n\n // Store child nodes as file.inner/...\n node.renameTo(`${node.name}.inner`);\n }\n } else {\n throw new Error('Missing value');\n }\n }\n\n return Promise.all(writeOps)\n .then(() => {\n this._processed++;\n this._written += writeOps.length;\n })\n .then(() => writeOps.length > 0);\n }\n\n /**\n * Writes a single node to the file system.\n * @param {Node} node The node to write.\n * @param {string} enc The encoding used.\n * @param {function(err: ?Error): void} callback Called once finished.\n */\n _write(node, enc, callback) {\n this._loadRenameConfig\n .then(() => this._writeNode(node))\n .then(() => callback())\n .catch((err) => callback(err));\n }\n\n writeAsync(node) {\n return new Promise((resolve, reject) => {\n this._write(node, null, (err) => (err ? reject(err) : resolve()));\n });\n }\n\n /**\n * Writes multiple nodes in parallel.\n * @param {Node[]} nodes The nodes to write.\n * @param {function(error: ?Error): void} callback Called once all nodes have been written.\n */\n _writev(nodes, callback) {\n if (this.isDestroyed) {\n return;\n }\n\n this._loadRenameConfig\n .then(() => Promise.all(nodes.map(({ chunk }) => this._writeNode(chunk))))\n .then(() => callback())\n .catch((err) => callback(err));\n }\n\n /**\n * Destroys the stream.\n * @param {?Error} err The error that caused the destroy.\n * @param {function(err: ?Error): void} callback Called once finished.\n */\n _destroy(err, callback) {\n this._isDestroyed = true;\n super._destroy(err, callback);\n }\n\n /**\n * Writes the updated rename config to disk.\n */\n writeRenamefile() {\n if (this._discoveredIdConflicts) {\n Logger.error(\n `Discovered ${this._discoveredIdConflicts} node id conflicts, results are incomplete.\n - Resolve all conflicts inside '${renameConfigPath}' and run 'atscm pull' again`\n );\n // FIXME: Insert link to node id conflict manual here once 1.0.0 is released.\n }\n\n let renameConfig = this._renameConfig;\n if (!this._discoveredIdConflicts && this._cleanRenameConfig) {\n renameConfig = Object.keys(this._renamesUsed)\n .sort()\n .reduce(\n (result, key) =>\n Object.assign(result, {\n [key]: this._renameConfig[key],\n }),\n {}\n );\n\n const renamesRemoved =\n Object.keys(this._renameConfig).length - Object.keys(renameConfig).length;\n\n if (renamesRemoved > 0) {\n Logger.info(`Removed ${renamesRemoved} unused renames from rename configuration.`);\n }\n }\n\n return outputFile(renameConfigPath, `${JSON.stringify(renameConfig, null, ' ')}${EOL}`);\n }\n}\n\n/**\n * Creates a new {@link WriteStream} to write to *path*.\n * @param {string} path The path to write to.\n * @param {Object} [options] The options to use. Passed to {@link WriteStream#constructor}.\n */\nexport default function dest(path, { cleanRenameConfig = false } = {}) {\n return new WriteStream({ path, cleanRenameConfig });\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/lib/gulp/dest.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 147, "kind": "variable", "name": "renameConfigPath", "memberof": "src/lib/gulp/dest.js", "static": true, "longname": "src/lib/gulp/dest.js~renameConfigPath", "access": "public", "export": true, "importPath": "atscm/src/lib/gulp/dest.js", "importStyle": "{renameConfigPath}", "description": "Relative path to the rename file.", "lineNumber": 15, "type": { "nullable": null, "types": [ "string" ], "spread": false, "description": null } }, { "__docId__": 148, "kind": "variable", "name": "renameDefaultName", "memberof": "src/lib/gulp/dest.js", "static": true, "longname": "src/lib/gulp/dest.js~renameDefaultName", "access": "public", "export": false, "importPath": "atscm/src/lib/gulp/dest.js", "importStyle": null, "description": "The default name inserted into the rename file.", "lineNumber": 21, "type": { "nullable": null, "types": [ "string" ], "spread": false, "description": null }, "ignore": true }, { "__docId__": 149, "kind": "variable", "name": "hashaOptions", "memberof": "src/lib/gulp/dest.js", "static": true, "longname": "src/lib/gulp/dest.js~hashaOptions", "access": "public", "export": false, "importPath": "atscm/src/lib/gulp/dest.js", "importStyle": null, "description": "Options to pass to *hasha*.", "lineNumber": 27, "type": { "nullable": null, "types": [ "Object" ], "spread": false, "description": null }, "ignore": true }, { "__docId__": 150, "kind": "variable", "name": "useChecksums", "memberof": "src/lib/gulp/dest.js", "static": true, "longname": "src/lib/gulp/dest.js~useChecksums", "access": "public", "export": false, "importPath": "atscm/src/lib/gulp/dest.js", "importStyle": null, "description": "If checksums should be used to decide if writes are needed.", "lineNumber": 33, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null }, "ignore": true }, { "__docId__": 151, "kind": "function", "name": "escapePathComponent", "memberof": "src/lib/gulp/dest.js", "generator": false, "async": false, "static": true, "longname": "src/lib/gulp/dest.js~escapePathComponent", "access": "public", "export": false, "importPath": "atscm/src/lib/gulp/dest.js", "importStyle": null, "description": null, "lineNumber": 35, "undocument": true, "params": [ { "name": "a", "types": [ "*" ] } ], "return": null, "ignore": true }, { "__docId__": 152, "kind": "class", "name": "WriteStream", "memberof": "src/lib/gulp/dest.js", "static": true, "longname": "src/lib/gulp/dest.js~WriteStream", "access": "public", "export": true, "importPath": "atscm/src/lib/gulp/dest.js", "importStyle": "{WriteStream}", "description": "A stream that writes {@link Node}s to the file system.", "lineNumber": 40, "interface": false, "extends": [ "stream~Writable" ] }, { "__docId__": 153, "kind": "constructor", "name": "constructor", "memberof": "src/lib/gulp/dest.js~WriteStream", "generator": false, "async": false, "static": false, "longname": "src/lib/gulp/dest.js~WriteStream#constructor", "access": "public", "description": "Creates a new WriteStream.", "lineNumber": 49, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options", "description": "The options to use." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "options.path", "description": "The path to write to **(required)**." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "options.base", "description": "The base path to write to (defaults to *path*)." }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.cleanRenameConfig", "description": "If unused entries should be removed when\nrename config is written." } ] }, { "__docId__": 154, "kind": "member", "name": "_isDestroyed", "memberof": "src/lib/gulp/dest.js~WriteStream", "static": false, "longname": "src/lib/gulp/dest.js~WriteStream#_isDestroyed", "access": "private", "description": "If the stream is destroyed.", "lineNumber": 60, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 155, "kind": "member", "name": "_processed", "memberof": "src/lib/gulp/dest.js~WriteStream", "static": false, "longname": "src/lib/gulp/dest.js~WriteStream#_processed", "access": "private", "description": "The number of processed nodes.", "lineNumber": 66, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 156, "kind": "member", "name": "_written", "memberof": "src/lib/gulp/dest.js~WriteStream", "static": false, "longname": "src/lib/gulp/dest.js~WriteStream#_written", "access": "private", "description": "The number of written nodes.", "lineNumber": 72, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 157, "kind": "member", "name": "_base", "memberof": "src/lib/gulp/dest.js~WriteStream", "static": false, "longname": "src/lib/gulp/dest.js~WriteStream#_base", "access": "private", "description": "The base to output to.", "lineNumber": 78, "type": { "nullable": null, "types": [ "string" ], "spread": false, "description": null } }, { "__docId__": 158, "kind": "member", "name": "_renameConfig", "memberof": "src/lib/gulp/dest.js~WriteStream", "static": false, "longname": "src/lib/gulp/dest.js~WriteStream#_renameConfig", "access": "private", "description": "The object stored in the *rename file* (usually at './atscm/rename.json')", "lineNumber": 83, "type": { "types": [ "{}" ] } }, { "__docId__": 159, "kind": "member", "name": "_renamesUsed", "memberof": "src/lib/gulp/dest.js~WriteStream", "static": false, "longname": "src/lib/gulp/dest.js~WriteStream#_renamesUsed", "access": "private", "description": null, "lineNumber": 84, "undocument": true, "type": { "types": [ "{}" ] } }, { "__docId__": 160, "kind": "member", "name": "_cleanRenameConfig", "memberof": "src/lib/gulp/dest.js~WriteStream", "static": false, "longname": "src/lib/gulp/dest.js~WriteStream#_cleanRenameConfig", "access": "private", "description": null, "lineNumber": 85, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 161, "kind": "member", "name": "_loadRenameConfig", "memberof": "src/lib/gulp/dest.js~WriteStream", "static": false, "longname": "src/lib/gulp/dest.js~WriteStream#_loadRenameConfig", "access": "private", "description": "A promise that resolves once the *rename file* is loaded.", "lineNumber": 91, "type": { "nullable": null, "types": [ "*" ], "spread": false, "description": null } }, { "__docId__": 162, "kind": "member", "name": "_idMap", "memberof": "src/lib/gulp/dest.js~WriteStream", "static": false, "longname": "src/lib/gulp/dest.js~WriteStream#_idMap", "access": "private", "description": "A map of ids used for renaming.", "lineNumber": 98, "type": { "types": [ "*" ] } }, { "__docId__": 163, "kind": "member", "name": "_performWrites", "memberof": "src/lib/gulp/dest.js~WriteStream", "static": false, "longname": "src/lib/gulp/dest.js~WriteStream#_performWrites", "access": "private", "description": "If writes should actually be performed. Set to `false` once id conflicts were discovered.", "lineNumber": 103, "type": { "types": [ "boolean" ] } }, { "__docId__": 164, "kind": "member", "name": "_conflictingIds", "memberof": "src/lib/gulp/dest.js~WriteStream", "static": false, "longname": "src/lib/gulp/dest.js~WriteStream#_conflictingIds", "access": "private", "description": "The IDs that are affected by node id conflicts, lowercased.", "lineNumber": 109, "type": { "nullable": null, "types": [ "Set" ], "spread": false, "description": null } }, { "__docId__": 165, "kind": "member", "name": "_discoveredIdConflicts", "memberof": "src/lib/gulp/dest.js~WriteStream", "static": false, "longname": "src/lib/gulp/dest.js~WriteStream#_discoveredIdConflicts", "access": "private", "description": "The number of id conflicts discovered.", "lineNumber": 115, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 166, "kind": "get", "name": "isDestroyed", "memberof": "src/lib/gulp/dest.js~WriteStream", "generator": false, "async": false, "static": false, "longname": "src/lib/gulp/dest.js~WriteStream#isDestroyed", "access": "public", "description": "If the stream is destroyed.", "lineNumber": 126, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 167, "kind": "method", "name": "_parentHasIdConflict", "memberof": "src/lib/gulp/dest.js~WriteStream", "generator": false, "async": false, "static": false, "longname": "src/lib/gulp/dest.js~WriteStream#_parentHasIdConflict", "access": "private", "description": "Transverses the node tree to see if any parent node has an id conflict.", "lineNumber": 135, "params": [ { "nullable": null, "types": [ "ServerNode" ], "spread": false, "optional": false, "name": "node", "description": "The processed node." } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "`true` if a parent node has an id conflict." } }, { "__docId__": 168, "kind": "method", "name": "_outputFile", "memberof": "src/lib/gulp/dest.js~WriteStream", "generator": false, "async": true, "static": false, "longname": "src/lib/gulp/dest.js~WriteStream#_outputFile", "access": "private", "description": null, "lineNumber": 148, "undocument": true, "params": [ { "name": "path", "types": [ "*" ] }, { "name": "content", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 169, "kind": "method", "name": "_writeNode", "memberof": "src/lib/gulp/dest.js~WriteStream", "generator": false, "async": true, "static": false, "longname": "src/lib/gulp/dest.js~WriteStream#_writeNode", "access": "private", "description": "Writes a single node to disk.", "lineNumber": 173, "params": [ { "nullable": null, "types": [ "ServerNode" ], "spread": false, "optional": false, "name": "node", "description": "The processed node." } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "Resolves once the node has been written, `true` indicates the node\nhas actually been written." } }, { "__docId__": 172, "kind": "method", "name": "_write", "memberof": "src/lib/gulp/dest.js~WriteStream", "generator": false, "async": false, "static": false, "longname": "src/lib/gulp/dest.js~WriteStream#_write", "access": "private", "description": "Writes a single node to the file system.", "lineNumber": 294, "params": [ { "nullable": null, "types": [ "Node" ], "spread": false, "optional": false, "name": "node", "description": "The node to write." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "enc", "description": "The encoding used." }, { "nullable": null, "types": [ "function(err: ?Error): void" ], "spread": false, "optional": false, "name": "callback", "description": "Called once finished." } ], "return": null }, { "__docId__": 173, "kind": "method", "name": "writeAsync", "memberof": "src/lib/gulp/dest.js~WriteStream", "generator": false, "async": false, "static": false, "longname": "src/lib/gulp/dest.js~WriteStream#writeAsync", "access": "public", "description": null, "lineNumber": 301, "undocument": true, "params": [ { "name": "node", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 174, "kind": "method", "name": "_writev", "memberof": "src/lib/gulp/dest.js~WriteStream", "generator": false, "async": false, "static": false, "longname": "src/lib/gulp/dest.js~WriteStream#_writev", "access": "private", "description": "Writes multiple nodes in parallel.", "lineNumber": 312, "params": [ { "nullable": null, "types": [ "Node[]" ], "spread": false, "optional": false, "name": "nodes", "description": "The nodes to write." }, { "nullable": null, "types": [ "function(error: ?Error): void" ], "spread": false, "optional": false, "name": "callback", "description": "Called once all nodes have been written." } ], "return": null }, { "__docId__": 175, "kind": "method", "name": "_destroy", "memberof": "src/lib/gulp/dest.js~WriteStream", "generator": false, "async": false, "static": false, "longname": "src/lib/gulp/dest.js~WriteStream#_destroy", "access": "private", "description": "Destroys the stream.", "lineNumber": 328, "params": [ { "nullable": true, "types": [ "Error" ], "spread": false, "optional": false, "name": "err", "description": "The error that caused the destroy." }, { "nullable": null, "types": [ "function(err: ?Error): void" ], "spread": false, "optional": false, "name": "callback", "description": "Called once finished." } ], "return": null }, { "__docId__": 177, "kind": "method", "name": "writeRenamefile", "memberof": "src/lib/gulp/dest.js~WriteStream", "generator": false, "async": false, "static": false, "longname": "src/lib/gulp/dest.js~WriteStream#writeRenamefile", "access": "public", "description": "Writes the updated rename config to disk.", "lineNumber": 336, "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 178, "kind": "function", "name": "dest", "memberof": "src/lib/gulp/dest.js", "generator": false, "async": false, "static": true, "longname": "src/lib/gulp/dest.js~dest", "access": "public", "export": true, "importPath": "atscm/src/lib/gulp/dest.js", "importStyle": "dest", "description": "Creates a new {@link WriteStream} to write to *path*.", "lineNumber": 374, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "path", "description": "The path to write to." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "The options to use. Passed to {@link WriteStream#constructor}." } ], "return": { "types": [ "*" ] } }, { "__docId__": 179, "kind": "file", "name": "src/lib/gulp/src.ts", "content": "import { join, basename, dirname } from 'path';\nimport { readdir, stat, readFile, readJSON } from 'fs-extra';\nimport { NodeClass } from 'node-opcua/lib/datamodel/nodeclass';\nimport { DataType, VariantArrayType, Variant } from 'node-opcua/lib/datamodel/variant';\nimport { KeyOf } from 'node-opcua/lib/misc/enum.js';\nimport Logger from 'gulplog';\nimport PromiseQueue from 'p-queue';\nimport { SourceNode, ReferenceTypeIds, NodeOptions, NodeDefinition } from '../model/Node';\nimport ProjectConfig from '../../config/ProjectConfig';\nimport { decodeVariant } from '../coding';\nimport { Omit } from '../helpers/types';\n\ntype FileNodeOptions = Omit & NodeDefinition;\n\n/**\n * A node returned by the {@link SourceStream}.\n */\nexport class FileNode extends SourceNode {\n /**\n * Creates a new node.\n * @param options The options to use.\n */\n public constructor({\n nodeClass,\n dataType,\n arrayType,\n references,\n nodeId,\n ...options\n }: FileNodeOptions) {\n super({\n ...options,\n nodeClass: NodeClass[nodeClass || 'Variable'],\n });\n\n if (nodeId) {\n /**\n * The id stored in the definition file\n * @type {NodeId}\n */\n this.specialId = nodeId;\n }\n\n if (references) {\n (Object.entries(references) as [\n keyof typeof ReferenceTypeIds,\n (string | number)[]\n ][]).forEach(([ref, ids]) => {\n const type = ReferenceTypeIds[ref] || parseInt(ref, 10);\n\n ids.forEach((id) => {\n this.references.addReference(type, id);\n this._resolvedReferences.addReference(type, id);\n });\n });\n }\n\n if (dataType) {\n this.valueSoFar.dataType = DataType[dataType];\n }\n\n if (arrayType) {\n this.valueSoFar.arrayType = VariantArrayType[arrayType];\n }\n }\n\n protected _rawValue?: Buffer;\n\n public setRawValue(value: Buffer): void {\n this._rawValue = value;\n }\n\n private hasRawValue(): this is { _rawValue: Buffer } {\n return !!this._rawValue;\n }\n\n /**\n * A node's raw value, decoded into a string.\n */\n public get stringValue(): string {\n if (!this.hasRawValue()) {\n throw new Error('No value read yet. Ensure to call #setRawValue');\n }\n\n return this._rawValue.toString();\n }\n\n /** The node's value (may be incomplete, use {@link FileNode#value} to ensure). */\n public valueSoFar: Partial = {};\n\n private valueIsComplete(): this is { valueSoFar: Variant } {\n return this.valueSoFar.value !== undefined;\n }\n\n /**\n * A node's {@link node-opcua~Variant} value.\n */\n public get variantValue(): Variant {\n const value = this.valueSoFar;\n\n if (!this.valueIsComplete()) {\n if (!value.dataType) {\n throw new Error(`${this.nodeId} has no data type`);\n }\n if (!value.arrayType) {\n throw new Error(`${this.nodeId} has no array type`);\n }\n if (this.hasRawValue()) {\n value.value = decodeVariant(this._rawValue, value);\n }\n }\n\n return this.valueSoFar as Variant;\n }\n\n public get value(): Variant {\n return this.variantValue;\n }\n}\n\n// Helpers\n/**\n * Returns `true` for definition file paths.\n * @param path The path to check.\n * @return If the file at path is a definition file.\n */\nexport function isDefinitionFile(path: string): boolean {\n return Boolean(basename(path).match(/^\\..*\\.json$/));\n}\n\n/**\n * Matches container files.\n */\nconst containerFileRegexp = /^\\.((Object|Variable)(Type)?|Method|View|(Reference|Data)Type)\\.json$/;\n\ntype NodeHandler = (node: FileNode) => R;\n\ninterface SourceBrowserOptions {\n handleNode: NodeHandler>;\n readNodeFile: NodeHandler;\n atserverVersion: string;\n}\n\n/**\n * Browses the local file system for nodes.\n */\nexport class SourceBrowser {\n /** The queue processing incoming paths / nodes. @type {p-queue~PQueue} */\n private _queue: PromiseQueue;\n\n /** A callback called with every discovered node. */\n private _nodeHandler: NodeHandler>;\n /** A callback deciding if a node file should be read. */\n private _readNodeFile: NodeHandler;\n\n /** The pushed node's ids */\n private _pushed = new Set();\n /** The pushed node's paths */\n private _pushedPath = new Set();\n /** Stores how queued nodes depend on each other */\n // eslint-disable-next-line no-spaced-func\n private _dependingOn = new Map })[]>();\n\n private _atserverVersion: string;\n\n /**\n * Sets up a new browser.\n * @param options The options to apply.\n * @param options.handleNode A callback called with every discovered node.\n * @param options.readNodeFile A callback deciding if a node file should be read.\n */\n public constructor({ handleNode, readNodeFile, atserverVersion }: SourceBrowserOptions) {\n this._queue = new PromiseQueue({\n concurrency: 250,\n });\n\n this._nodeHandler = handleNode;\n this._readNodeFile = readNodeFile;\n\n // Setup context\n this._atserverVersion = atserverVersion;\n }\n\n get atserverVersion(): string {\n return this._atserverVersion;\n }\n\n /**\n * A function to be called once an error occurres during parallel processing.\n * @param error The error to exit with.\n */\n private _reject!: (error: Error) => void;\n\n /**\n * Starts the browser at the given path.\n * @param path The path to start browsing at.\n * @param options Passed directly to {@link SourceBrowser#processPath}.\n * @return Fulfilled once browsing is complete.\n */\n public async browse(path: string, options = {}): Promise {\n let processError: Error;\n\n const done = new Promise((resolve, reject) => {\n this._reject = (err) => {\n if (processError) {\n // Multiple errors occured. In most cases this means, that the server connection was\n // closed after the first error.\n Logger.debug('Additional error', err);\n return;\n }\n\n processError = err;\n this._queue.pause();\n this._queue.clear();\n\n reject(err);\n };\n\n // write initial path\n this.processPath({ path, ...options });\n\n this._queue.onIdle().then(() => {\n if (processError) {\n return;\n }\n\n if (this._dependingOn.size) {\n reject(\n new Error(`Some nodes are still waiting for dependencies\n Missing nodes: ${Array.from(this._dependingOn.keys()).join(', ')}\n - Pull these nodes or add them to the ignored ones`)\n );\n }\n\n resolve();\n });\n });\n\n return done;\n }\n\n /**\n * Enqueues a {@link SourceBrowser#_processPath} call with the given options.\n * @param options Passed directly to {@link SourceBrowser#_processPath}.\n */\n public processPath(options: ProcessPathOptions): Promise {\n return this._queue.add(() => this._processPath(options).catch(this._reject));\n }\n\n /**\n * Can be called by transformers to read this path before finishing it's parent nodes.\n * @param {Object} options Passed directly to {@link SourceBrowser#_processPath}.\n * @param {string} options.path The path to read.\n */\n public readNode({ path }: { path: string }): Promise {\n return this._processPath({\n path,\n push: false,\n }) as Promise; // NOTE: If `push` is true, the browser always returns a node.\n }\n\n /**\n * Where the real browsing happens: Stats the given path, discovering new node definition files,\n * if any and finally pushes discovered nodes to {@link SourceBrowser#_processNode}.\n * @param {Object} options The options to use.\n */\n private async _processPath({\n path,\n parent,\n children,\n push = true,\n singleNode = false,\n }: ProcessPathOptions): Promise {\n const s = await stat(path);\n\n if (s.isDirectory()) {\n let container;\n const nextChildren = (await readdir(path)).reduce((nodes, p) => {\n const node = {\n name: p,\n path: join(path, p),\n push,\n };\n\n if (p.match(containerFileRegexp)) {\n container = node;\n\n return nodes;\n }\n\n let parts: string[];\n const noProcessingNeeded = nodes.find((current) => {\n const n = current.name;\n if (n === `.${p}.json`) {\n return true;\n } // Skip files with definitions already present\n\n const [raw, rest] = parts || (parts = p.split('.inner'));\n\n if (rest === '' && (n === raw || n === `.${raw}.json`)) {\n // Got an *.inner directory\n // eslint-disable-next-line no-param-reassign\n current.children = (current.children || []).concat(node);\n return true;\n }\n\n return false;\n });\n\n return noProcessingNeeded ? nodes : nodes.concat(node);\n }, [] as DiscoveredNodeFile[]);\n\n if (container) {\n return this._processPath(Object.assign(container, { children: nextChildren, parent }));\n } else if (singleNode) {\n Logger.debug(`Pushing parent at ${path}`);\n return this._processPath({ path: join(path, '../'), parent, children, push });\n }\n\n const inheritParent = path.endsWith('.inner');\n nextChildren.forEach((node) => {\n if (inheritParent) {\n // eslint-disable-next-line no-param-reassign\n node.parent = parent;\n }\n this.processPath(node);\n });\n } else if (s.isFile()) {\n if (!isDefinitionFile(path)) {\n // FIXME: Browse parent here for watch task / Variable source node\n // (e.g. AGENT/DISPLAYS/Default.display/Default.js changed)\n\n if (singleNode) {\n Logger.debug(`Pushing parent at ${path}`);\n return this._processPath({ path: join(path, '../'), parent, children, push, singleNode });\n }\n\n Logger.warn(`Not a definition file at ${path}`);\n return Promise.resolve();\n }\n\n let name = basename(path, '.json').slice(1);\n if (name.length >= 4 && NodeClass[name as KeyOf]) {\n name = basename(dirname(path));\n }\n\n if (this._pushedPath.has(path)) {\n // throw new Error('Double-handled node ' + path);\n return Promise.resolve();\n }\n\n const dir = dirname(path);\n const rel = join(dir, name);\n const node: BrowsedFileNode = Object.assign(\n new FileNode({\n name,\n parent,\n ...((await readJSON(path)) as NodeDefinition),\n }),\n {\n push, // FIXME: Remove?\n children,\n relative: rel,\n definitionPath: path,\n }\n );\n\n return this._processNode(node);\n }\n\n return Promise.resolve();\n }\n\n /**\n * Handles a node's dependencies and calls {@link SourceBrowser#_pushNode} once it's ready.\n * @param node A discovered node.\n */\n private _processNode(node: BrowsedFileNode): Promise {\n // Build dependency map\n if (!node.waitingFor) {\n const deps = Array.from(node.references).reduce(\n (result, [, ids]) =>\n result.concat(\n Array.from(ids).filter((id) => {\n if (typeof id === 'number') {\n // OPC-UA node\n return false;\n }\n\n return !this._pushed.has(id) && !ProjectConfig.isExternal(id);\n }) as string[]\n ),\n [] as string[]\n );\n // eslint-disable-next-line no-param-reassign\n node.waitingFor = new Set(deps);\n deps.forEach((d) => {\n this._dependingOn.set(\n d,\n (this._dependingOn.get(d) || []).concat(\n node as BrowsedFileNode & {\n waitingFor: Set;\n }\n )\n );\n });\n }\n\n if (!node.waitingFor.size) {\n return this._pushNode(node);\n }\n\n return Promise.resolve();\n }\n\n /**\n * Reads a node's value file (if it's a variable) and calls {@link SourceBrowser#_nodeHandler}\n * with it, finishing the node's processing and promoting it's dependents, if any.\n * @param node A discovered node.\n * @return The node, once it's fully processed.\n */\n private async _pushNode(node: BrowsedFileNode): Promise {\n // Read node value\n if (node.nodeClass === NodeClass.Variable && this._readNodeFile(node)) {\n // eslint-disable-next-line no-param-reassign\n await readFile(node.relative)\n .then((value) => node.setRawValue(value))\n .catch((err) => {\n if (err.code === 'EISDIR') {\n return;\n }\n throw new Error(`${err.code}: Error reading ${node.relative}`);\n });\n }\n\n return this._nodeHandler(node).then(() => {\n // Handle children\n if (node.children) {\n node.children.forEach((child) => {\n // eslint-disable-next-line no-param-reassign\n child.parent = node;\n this.processPath(child);\n });\n }\n\n // Handle dependencies\n const depending = this._dependingOn.get(node.nodeId);\n if (depending) {\n depending.forEach((dep) => {\n dep.waitingFor.delete(node.nodeId);\n\n if (!dep.waitingFor.size) {\n // All dependencies resolved\n return this._pushNode(dep);\n }\n\n // Still waiting\n return Logger.debug('Still waiting', dep.nodeId, Array.from(dep.waitingFor));\n });\n }\n\n // eslint-disable-next-line no-param-reassign\n delete node.waitingFor;\n this._dependingOn.delete(node.nodeId);\n this._pushed.add(node.nodeId);\n\n // Mark as pushed\n this._pushedPath.add(node.definitionPath);\n\n return node;\n });\n }\n}\n\n/**\n * Starts a new source browser at the given path.\n * @param path The path to start browsing with.\n * @param options Passed directly to {@link SourceBrowser#constructor}.\n * @return A promise resolved once browsing is finished, with an addional *browser* property holding\n * the SourceBrowser instance created.\n */\nexport default function src(\n path: string,\n options: SourceBrowserOptions\n): Promise & {\n browser: SourceBrowser;\n} {\n const browser = new SourceBrowser(options);\n\n return Object.assign(browser.browse(path, options), { browser });\n}\n\n// Option types\n\n/** A file node while being processed by a source browser */\ntype BrowsedFileNode = FileNode & {\n waitingFor?: Set;\n children?: DiscoveredNodeFile[];\n relative: string;\n definitionPath: string;\n};\n\ninterface DiscoveredNodeFile {\n path: string;\n name: string;\n push: boolean;\n parent?: FileNode;\n children?: DiscoveredNodeFile[];\n}\n\ntype ProcessPathOptions = Partial & {\n path: string;\n singleNode?: boolean;\n};\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/lib/gulp/src.ts", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 180, "kind": "class", "name": "FileNode", "memberof": "src/lib/gulp/src.ts", "static": true, "longname": "src/lib/gulp/src.ts~FileNode", "access": "public", "export": true, "importPath": "atscm/src/lib/gulp/src.ts", "importStyle": "{FileNode}", "description": "A node returned by the {@link SourceStream}.", "lineNumber": 18, "interface": false, "extends": [ "src/lib/model/Node.js~SourceNode" ] }, { "__docId__": 181, "kind": "constructor", "name": "constructor", "memberof": "src/lib/gulp/src.ts~FileNode", "generator": false, "async": false, "static": false, "longname": "src/lib/gulp/src.ts~FileNode#constructor", "access": "public", "description": "Creates a new node.", "lineNumber": 21, "params": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "options", "description": "The options to use." } ] }, { "__docId__": 182, "kind": "member", "name": "valueSoFar", "memberof": "src/lib/gulp/src.ts~FileNode", "static": false, "longname": "src/lib/gulp/src.ts~FileNode#valueSoFar", "access": "public", "description": "The node's value (may be incomplete, use {@link FileNode#value} to ensure).", "lineNumber": 89, "type": { "nullable": null, "types": [ "Partial" ], "spread": false, "description": null } }, { "__docId__": 183, "kind": "member", "name": "specialId", "memberof": "src/lib/gulp/src.ts~FileNode", "static": false, "longname": "src/lib/gulp/src.ts~FileNode#specialId", "access": "public", "description": "The id stored in the definition file", "lineNumber": 40, "type": { "nullable": null, "types": [ "NodeId" ], "spread": false, "description": null } }, { "__docId__": 184, "kind": "method", "name": "setRawValue", "memberof": "src/lib/gulp/src.ts~FileNode", "generator": false, "async": false, "static": false, "longname": "src/lib/gulp/src.ts~FileNode#setRawValue", "access": "public", "description": "", "lineNumber": 69, "params": [ { "nullable": null, "types": [ "Buffer" ], "spread": false, "optional": false, "name": "value", "description": "" } ], "return": { "nullable": null, "types": [ "undefined" ], "spread": false, "description": "" } }, { "__docId__": 185, "kind": "member", "name": "_rawValue", "memberof": "src/lib/gulp/src.ts~FileNode", "static": false, "longname": "src/lib/gulp/src.ts~FileNode#_rawValue", "access": "private", "description": null, "lineNumber": 69, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 186, "kind": "method", "name": "hasRawValue", "memberof": "src/lib/gulp/src.ts~FileNode", "generator": false, "async": false, "static": false, "longname": "src/lib/gulp/src.ts~FileNode#hasRawValue", "access": "public", "description": "", "lineNumber": 73, "return": { "nullable": null, "types": [ "undefined" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 187, "kind": "get", "name": "stringValue", "memberof": "src/lib/gulp/src.ts~FileNode", "generator": false, "async": false, "static": false, "longname": "src/lib/gulp/src.ts~FileNode#stringValue", "access": "public", "description": "A node's raw value, decoded into a string.", "lineNumber": 80, "type": { "nullable": null, "types": [ "string" ], "spread": false, "description": null } }, { "__docId__": 188, "kind": "method", "name": "valueIsComplete", "memberof": "src/lib/gulp/src.ts~FileNode", "generator": false, "async": false, "static": false, "longname": "src/lib/gulp/src.ts~FileNode#valueIsComplete", "access": "public", "description": "", "lineNumber": 91, "return": { "nullable": null, "types": [ "undefined" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 189, "kind": "get", "name": "variantValue", "memberof": "src/lib/gulp/src.ts~FileNode", "generator": false, "async": false, "static": false, "longname": "src/lib/gulp/src.ts~FileNode#variantValue", "access": "public", "description": "A node's {@link node-opcua~Variant} value.", "lineNumber": 98, "type": { "nullable": null, "types": [ "Variant" ], "spread": false, "description": null } }, { "__docId__": 190, "kind": "get", "name": "value", "memberof": "src/lib/gulp/src.ts~FileNode", "generator": false, "async": false, "static": false, "longname": "src/lib/gulp/src.ts~FileNode#value", "access": "public", "description": "", "lineNumber": 116, "type": { "nullable": null, "types": [ "Variant" ], "spread": false, "description": null } }, { "__docId__": 191, "kind": "function", "name": "isDefinitionFile", "memberof": "src/lib/gulp/src.ts", "generator": false, "async": false, "static": true, "longname": "src/lib/gulp/src.ts~isDefinitionFile", "access": "public", "export": true, "importPath": "atscm/src/lib/gulp/src.ts", "importStyle": "{isDefinitionFile}", "description": "Returns `true` for definition file paths.", "lineNumber": 127, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "path", "description": "" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" } }, { "__docId__": 192, "kind": "variable", "name": "containerFileRegexp", "memberof": "src/lib/gulp/src.ts", "static": true, "longname": "src/lib/gulp/src.ts~containerFileRegexp", "access": "public", "export": false, "importPath": "atscm/src/lib/gulp/src.ts", "importStyle": null, "description": "Matches container files.", "lineNumber": 159, "type": { "types": [ "undefined" ] }, "ignore": true }, { "__docId__": 193, "kind": "class", "name": "SourceBrowser", "memberof": "src/lib/gulp/src.ts", "static": true, "longname": "src/lib/gulp/src.ts~SourceBrowser", "access": "public", "export": true, "importPath": "atscm/src/lib/gulp/src.ts", "importStyle": "{SourceBrowser}", "description": "Browses the local file system for nodes.", "lineNumber": 147, "interface": false }, { "__docId__": 194, "kind": "constructor", "name": "constructor", "memberof": "src/lib/gulp/src.ts~SourceBrowser", "generator": false, "async": false, "static": false, "longname": "src/lib/gulp/src.ts~SourceBrowser#constructor", "access": "public", "description": "Sets up a new browser.", "lineNumber": 173, "params": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "options", "description": "The options to apply." }, { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "options.handleNode", "description": "A callback called with every discovered node." }, { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "options.readNodeFile", "description": "A callback deciding if a node file should be read." } ] }, { "__docId__": 195, "kind": "member", "name": "_pushed", "memberof": "src/lib/gulp/src.ts~SourceBrowser", "static": false, "longname": "src/lib/gulp/src.ts~SourceBrowser#_pushed", "access": "private", "description": "The pushed node's ids", "lineNumber": 157, "type": { "types": [ "*" ] } }, { "__docId__": 196, "kind": "member", "name": "_pushedPath", "memberof": "src/lib/gulp/src.ts~SourceBrowser", "static": false, "longname": "src/lib/gulp/src.ts~SourceBrowser#_pushedPath", "access": "private", "description": "The pushed node's paths", "lineNumber": 159, "type": { "types": [ "*" ] } }, { "__docId__": 197, "kind": "member", "name": "_dependingOn", "memberof": "src/lib/gulp/src.ts~SourceBrowser", "static": false, "longname": "src/lib/gulp/src.ts~SourceBrowser#_dependingOn", "access": "private", "description": "Stores how queued nodes depend on each other", "lineNumber": 162, "type": { "types": [ "*" ] } }, { "__docId__": 198, "kind": "member", "name": "_queue", "memberof": "src/lib/gulp/src.ts~SourceBrowser", "static": false, "longname": "src/lib/gulp/src.ts~SourceBrowser#_queue", "access": "private", "description": null, "lineNumber": 196, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 199, "kind": "member", "name": "_nodeHandler", "memberof": "src/lib/gulp/src.ts~SourceBrowser", "static": false, "longname": "src/lib/gulp/src.ts~SourceBrowser#_nodeHandler", "access": "private", "description": null, "lineNumber": 199, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 200, "kind": "member", "name": "_readNodeFile", "memberof": "src/lib/gulp/src.ts~SourceBrowser", "static": false, "longname": "src/lib/gulp/src.ts~SourceBrowser#_readNodeFile", "access": "private", "description": null, "lineNumber": 200, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 201, "kind": "member", "name": "_atserverVersion", "memberof": "src/lib/gulp/src.ts~SourceBrowser", "static": false, "longname": "src/lib/gulp/src.ts~SourceBrowser#_atserverVersion", "access": "private", "description": null, "lineNumber": 202, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 202, "kind": "get", "name": "atserverVersion", "memberof": "src/lib/gulp/src.ts~SourceBrowser", "generator": false, "async": false, "static": false, "longname": "src/lib/gulp/src.ts~SourceBrowser#atserverVersion", "access": "public", "description": "", "lineNumber": 184, "type": { "nullable": null, "types": [ "string" ], "spread": false, "description": null } }, { "__docId__": 203, "kind": "method", "name": "browse", "memberof": "src/lib/gulp/src.ts~SourceBrowser", "generator": false, "async": true, "static": false, "longname": "src/lib/gulp/src.ts~SourceBrowser#browse", "access": "public", "description": "Starts the browser at the given path.", "lineNumber": 200, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "path", "description": "" }, { "nullable": null, "types": [ "undefined" ], "spread": false, "optional": false, "name": "options", "description": "" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 204, "kind": "member", "name": "_reject", "memberof": "src/lib/gulp/src.ts~SourceBrowser", "static": false, "longname": "src/lib/gulp/src.ts~SourceBrowser#_reject", "access": "private", "description": null, "lineNumber": 230, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 205, "kind": "method", "name": "processPath", "memberof": "src/lib/gulp/src.ts~SourceBrowser", "generator": false, "async": false, "static": false, "longname": "src/lib/gulp/src.ts~SourceBrowser#processPath", "access": "public", "description": "Enqueues a {@link SourceBrowser#_processPath} call with the given options.", "lineNumber": 246, "params": [ { "nullable": null, "types": [ "ProcessPathOptions" ], "spread": false, "optional": false, "name": "options", "description": "" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 206, "kind": "method", "name": "readNode", "memberof": "src/lib/gulp/src.ts~SourceBrowser", "generator": false, "async": false, "static": false, "longname": "src/lib/gulp/src.ts~SourceBrowser#readNode", "access": "public", "description": "Can be called by transformers to read this path before finishing it's parent nodes.", "lineNumber": 255, "params": [ { "nullable": null, "types": [ "undefined" ], "spread": false, "optional": false, "name": "undefined", "description": "" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 207, "kind": "method", "name": "_processPath", "memberof": "src/lib/gulp/src.ts~SourceBrowser", "generator": false, "async": true, "static": false, "longname": "src/lib/gulp/src.ts~SourceBrowser#_processPath", "access": "private", "description": "Where the real browsing happens: Stats the given path, discovering new node definition files,\nif any and finally pushes discovered nodes to {@link SourceBrowser#_processNode}.", "lineNumber": 267, "params": [ { "nullable": null, "types": [ "ProcessPathOptions" ], "spread": false, "optional": false, "name": "undefined", "description": "" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 208, "kind": "method", "name": "_processNode", "memberof": "src/lib/gulp/src.ts~SourceBrowser", "generator": false, "async": false, "static": false, "longname": "src/lib/gulp/src.ts~SourceBrowser#_processNode", "access": "private", "description": "Handles a node's dependencies and calls {@link SourceBrowser#_pushNode} once it's ready.", "lineNumber": 378, "params": [ { "nullable": null, "types": [ "BrowsedFileNode" ], "spread": false, "optional": false, "name": "node", "description": "" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 209, "kind": "method", "name": "_pushNode", "memberof": "src/lib/gulp/src.ts~SourceBrowser", "generator": false, "async": true, "static": false, "longname": "src/lib/gulp/src.ts~SourceBrowser#_pushNode", "access": "private", "description": "Reads a node's value file (if it's a variable) and calls {@link SourceBrowser#_nodeHandler}\nwith it, finishing the node's processing and promoting it's dependents, if any.", "lineNumber": 422, "params": [ { "nullable": null, "types": [ "BrowsedFileNode" ], "spread": false, "optional": false, "name": "node", "description": "" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 210, "kind": "function", "name": "src", "memberof": "src/lib/gulp/src.ts", "generator": false, "async": false, "static": true, "longname": "src/lib/gulp/src.ts~src", "access": "public", "export": true, "importPath": "atscm/src/lib/gulp/src.ts", "importStyle": "src", "description": "Starts a new source browser at the given path.", "lineNumber": 482, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "path", "description": "" }, { "nullable": null, "types": [ "SourceBrowserOptions" ], "spread": false, "optional": false, "name": "options", "description": "" } ], "return": { "nullable": null, "types": [ "undefined" ], "spread": false, "description": "" } }, { "__docId__": 211, "kind": "file", "name": "src/lib/helpers/Object.js", "content": "/**\n * Switches keys and values in an object. E.G.: { \"a\": 1 } becomes { 1: \"a\" }.\n * @param {Object} obj The object to reverse.\n * @return {Object} The reversed object.\n */\nexport function reverse(obj) {\n return Object.keys(obj).reduce(\n (result, key) =>\n Object.assign(result, {\n [obj[key]]: key,\n }),\n {}\n );\n}\n\n/**\n * Picks some properties from an object and returns a new object containing these.\n * @param {Object} obj The object to pick from.\n * @param {Array} properties Names of the properties to pick.\n * @return {Object} The resulting object.\n */\nexport function pick(obj, properties) {\n return properties.reduce((props, key) => Object.assign(props, { [key]: obj[key] }), {});\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/lib/helpers/Object.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 212, "kind": "function", "name": "reverse", "memberof": "src/lib/helpers/Object.js", "generator": false, "async": false, "static": true, "longname": "src/lib/helpers/Object.js~reverse", "access": "public", "export": true, "importPath": "atscm/src/lib/helpers/Object.js", "importStyle": "{reverse}", "description": "Switches keys and values in an object. E.G.: { \"a\": 1 } becomes { 1: \"a\" }.", "lineNumber": 6, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "obj", "description": "The object to reverse." } ], "return": { "nullable": null, "types": [ "Object" ], "spread": false, "description": "The reversed object." } }, { "__docId__": 213, "kind": "function", "name": "pick", "memberof": "src/lib/helpers/Object.js", "generator": false, "async": false, "static": true, "longname": "src/lib/helpers/Object.js~pick", "access": "public", "export": true, "importPath": "atscm/src/lib/helpers/Object.js", "importStyle": "{pick}", "description": "Picks some properties from an object and returns a new object containing these.", "lineNumber": 22, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "obj", "description": "The object to pick from." }, { "nullable": null, "types": [ "Array" ], "spread": false, "optional": false, "name": "properties", "description": "Names of the properties to pick." } ], "return": { "nullable": null, "types": [ "Object" ], "spread": false, "description": "The resulting object." } }, { "__docId__": 214, "kind": "file", "name": "src/lib/helpers/async.ts", "content": "/**\n * Returns a promise that resolves after the given duration.\n * @param ms Milliseconds to delay.\n * @return A promise resolved after the specified delay.\n */\nexport const delay = (ms: number): Promise =>\n new Promise((resolve) => setTimeout(() => resolve(), ms));\n\ntype AsyncCallback = (error?: Error | null, result?: R) => void;\n\n/**\n * Wraps a function with an async callback in a promise.\n * @param fn The function to promisify.\n */\nexport const promisified = (fn: (cb: AsyncCallback) => R): Promise =>\n new Promise((resolve, reject) => {\n fn((err, data) => (err ? reject(err) : resolve(data)));\n });\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/lib/helpers/async.ts", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 215, "kind": "function", "name": "delay", "memberof": "src/lib/helpers/async.ts", "generator": false, "async": false, "static": true, "longname": "src/lib/helpers/async.ts~delay", "access": "public", "export": true, "importPath": "atscm/src/lib/helpers/async.ts", "importStyle": "{delay}", "description": "Returns a promise that resolves after the given duration.", "lineNumber": 6, "params": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "ms", "description": "Milliseconds to delay." } ], "return": { "nullable": null, "types": [ "*" ], "spread": false, "description": "A promise resolved after the specified delay." } }, { "__docId__": 216, "kind": "function", "name": "promisified", "memberof": "src/lib/helpers/async.ts", "generator": false, "async": false, "static": true, "longname": "src/lib/helpers/async.ts~promisified", "access": "public", "export": true, "importPath": "atscm/src/lib/helpers/async.ts", "importStyle": "{promisified}", "description": "Wraps a function with an async callback in a promise.", "lineNumber": 11, "params": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "fn", "description": "The function to promisify." } ], "return": null }, { "__docId__": 217, "kind": "file", "name": "src/lib/helpers/fs.ts", "content": "import { readFile, writeFile } from 'fs-extra';\nimport detectIndent from 'detect-indent';\n\ntype UpdateFn = (current: T) => T | Promise;\n\nexport async function updateFile(path: string, update: UpdateFn, encoding = 'utf8'): Promise {\n const contents = await readFile(path, encoding);\n const updated = await update(contents);\n\n return writeFile(path, updated);\n}\n\nexport async function updateJson(path: string, update: UpdateFn): Promise {\n return updateFile(path, async (contents) => {\n const indent = detectIndent(contents).indent || ' ';\n const current = JSON.parse(contents) as T;\n\n const updated = await update(current);\n\n return JSON.stringify(updated, null, indent);\n });\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/lib/helpers/fs.ts", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 218, "kind": "function", "name": "updateFile", "memberof": "src/lib/helpers/fs.ts", "generator": false, "async": true, "static": true, "longname": "src/lib/helpers/fs.ts~updateFile", "access": "public", "export": true, "importPath": "atscm/src/lib/helpers/fs.ts", "importStyle": "{updateFile}", "description": "", "lineNumber": 6, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "path", "description": "" }, { "nullable": null, "types": [ "UpdateFn" ], "spread": false, "optional": false, "name": "update", "description": "" }, { "nullable": null, "types": [ "undefined" ], "spread": false, "optional": false, "name": "encoding", "description": "" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 219, "kind": "function", "name": "updateJson", "memberof": "src/lib/helpers/fs.ts", "generator": false, "async": true, "static": true, "longname": "src/lib/helpers/fs.ts~updateJson", "access": "public", "export": true, "importPath": "atscm/src/lib/helpers/fs.ts", "importStyle": "{updateJson}", "description": "", "lineNumber": 13, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "path", "description": "" }, { "nullable": null, "types": [ "UpdateFn" ], "spread": false, "optional": false, "name": "update", "description": "" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 220, "kind": "file", "name": "src/lib/helpers/log.js", "content": "/* eslint-disable import/prefer-default-export */\n\nimport readline from 'readline';\nimport Logger from 'gulplog';\n\n/**\n * Prints the progress of a task.\n * @param {Promise} task The task to print the progress for.\n * @param {Object} options The options used.\n * @param {function(): number} options.getter A function returning the current progress.\n * @param {function(value: number): string} options.formatter A function returning a log message for\n * the progress passed.\n * @param {string} [options.level='info'] The log level to use.\n * @param {boolean} [options.logResult=true] If the final progress should be printed.\n * @example A basic implementation\n * const task = doSomething(); // Returns a Promise\n *\n * reportProgress(task, {\n * getter: () => getTaskProgress(), // returns a number, e.g. 13 if 13 files have been written\n * formatter: value => `${value} files written`,\n * })\n * .then(result => { // Results get passed directly from `task`\n * console.log(`The result is: ${result}`);\n * })\n * .catch(console.error) // which means you need error handling as well!\n */\nexport function reportProgress(task, { getter, formatter, level = 'info', logResult = true } = {}) {\n const start = Date.now();\n const ops = (value) => (value / ((Date.now() - start) / 1000)).toFixed(1);\n const message = () => {\n const value = getter();\n return `${formatter(value)} (${ops(value)}/s)`;\n };\n\n const interval = setInterval(() => {\n if (Logger.listenerCount(level) > 0) {\n Logger[level](message());\n\n readline.cursorTo(process.stdout, 0);\n readline.moveCursor(process.stdout, 0, -1);\n }\n }, 80);\n\n const done = (err) => {\n clearInterval(interval);\n\n if (logResult && !err) {\n Logger[level](message());\n } else if (Logger.listenerCount(level) > 0) {\n readline.cursorTo(process.stdout, 0);\n readline.clearLine(process.stdout);\n }\n\n if (err) {\n throw err;\n }\n };\n\n return task.then(\n () => done(),\n (err) => done(err)\n );\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/lib/helpers/log.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 221, "kind": "function", "name": "reportProgress", "memberof": "src/lib/helpers/log.js", "generator": false, "async": false, "static": true, "longname": "src/lib/helpers/log.js~reportProgress", "access": "public", "export": true, "importPath": "atscm/src/lib/helpers/log.js", "importStyle": "{reportProgress}", "description": "Prints the progress of a task.", "examples": [ "A basic implementation\nconst task = doSomething(); // Returns a Promise\n\nreportProgress(task, {\n getter: () => getTaskProgress(), // returns a number, e.g. 13 if 13 files have been written\n formatter: value => `${value} files written`,\n})\n .then(result => { // Results get passed directly from `task`\n console.log(`The result is: ${result}`);\n })\n .catch(console.error) // which means you need error handling as well!" ], "lineNumber": 27, "params": [ { "nullable": null, "types": [ "Promise" ], "spread": false, "optional": false, "name": "task", "description": "The task to print the progress for." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options", "description": "The options used." }, { "nullable": null, "types": [ "function(): number" ], "spread": false, "optional": false, "name": "options.getter", "description": "A function returning the current progress." }, { "nullable": null, "types": [ "function(value: number): string" ], "spread": false, "optional": false, "name": "options.formatter", "description": "A function returning a log message for\nthe progress passed." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": true, "defaultValue": "'info'", "defaultRaw": "'info'", "name": "options.level", "description": "The log level to use." }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": true, "defaultValue": "true", "defaultRaw": true, "name": "options.logResult", "description": "If the final progress should be printed." } ], "return": { "types": [ "*" ] } }, { "__docId__": 222, "kind": "file", "name": "src/lib/helpers/mapping.js", "content": "/* eslint-disable import/prefer-default-export */\n\n/**\n * Sorts the given references before they are persisted to disk.\n * @param {Object} references The references to be sorted.\n */\nexport function sortReferences(references) {\n return Object.keys(references)\n .sort()\n .reduce(\n (sorted, key) =>\n Object.assign(sorted, {\n [key]: Array.isArray(references[key]) ? references[key].sort() : references[key],\n }),\n {}\n );\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/lib/helpers/mapping.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 223, "kind": "function", "name": "sortReferences", "memberof": "src/lib/helpers/mapping.js", "generator": false, "async": false, "static": true, "longname": "src/lib/helpers/mapping.js~sortReferences", "access": "public", "export": true, "importPath": "atscm/src/lib/helpers/mapping.js", "importStyle": "{sortReferences}", "description": "Sorts the given references before they are persisted to disk.", "lineNumber": 7, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "references", "description": "The references to be sorted." } ], "return": { "types": [ "*" ] } }, { "__docId__": 224, "kind": "file", "name": "src/lib/helpers/tasks.js", "content": "import { codeFrameColumns } from '@babel/code-frame';\nimport Session from '../server/Session';\n\n/**\n * Adds additional infomation to the error's message and rethows it.\n * @param {Error} error The error that occured.\n * @throws {Error} The extended error.\n */\nexport function handleTaskError(error) {\n if (error.location && error.rawLines) {\n error.originalStack = error.stack; // eslint-disable-line no-param-reassign\n // eslint-disable-next-line no-param-reassign\n error.stack = `${error.message}\n${codeFrameColumns(error.rawLines, error.location, { message: error.message })}`;\n }\n\n const additionalMessage = error.node\n ? `\n - Node: ${error.node.nodeId}`\n : '';\n\n Object.assign(error, {\n message: `${error.message}${additionalMessage}`,\n stack: `${error.stack}${additionalMessage}`,\n });\n\n throw error;\n}\n\n/**\n * Closes open sessions once a task is complete.\n * @return {Promise} Resolved once cleanup is complete.\n */\nexport function finishTask() {\n return Session.closeOpen();\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/lib/helpers/tasks.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 225, "kind": "function", "name": "handleTaskError", "memberof": "src/lib/helpers/tasks.js", "generator": false, "async": false, "static": true, "longname": "src/lib/helpers/tasks.js~handleTaskError", "access": "public", "export": true, "importPath": "atscm/src/lib/helpers/tasks.js", "importStyle": "{handleTaskError}", "description": "Adds additional infomation to the error's message and rethows it.", "lineNumber": 9, "params": [ { "nullable": null, "types": [ "Error" ], "spread": false, "optional": false, "name": "error", "description": "The error that occured." } ], "throws": [ { "types": [ "Error" ], "description": "The extended error." } ], "return": null }, { "__docId__": 226, "kind": "function", "name": "finishTask", "memberof": "src/lib/helpers/tasks.js", "generator": false, "async": false, "static": true, "longname": "src/lib/helpers/tasks.js~finishTask", "access": "public", "export": true, "importPath": "atscm/src/lib/helpers/tasks.js", "importStyle": "{finishTask}", "description": "Closes open sessions once a task is complete.", "lineNumber": 34, "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "Resolved once cleanup is complete." }, "params": [] }, { "__docId__": 227, "kind": "file", "name": "src/lib/helpers/types.ts", "content": "export type Omit = Pick>;\nexport type ValueOf = T[keyof T];\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/lib/helpers/types.ts", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 228, "kind": "file", "name": "src/lib/init/Option.js", "content": "/**\n * An option the \"atscm init\" command handles.\n * TODO: Support function values for name, message, default, choices...\n */\nexport default class InitOption {\n /**\n * Creates a new option based either on a message and (optionally) a default value or some\n * options.\n * @param {string|Object} messageOrOptions The message or options to use.\n * @param {inquirer~PromptType} [messageOrOptions.type] The option's type.\n * @param {string} messageOrOptions.message The option's message. Required if `messageOrOptions`\n * is an object.\n * @param {string|number} [messageOrOptions.default] The options's default value.\n * @param {inquirer~Validator} [messageOrOptions.validate] A function that validates user input.\n * @param {string[]|number[]} [messageOrOptions.choices] The options's choices. Applies to to list\n * types only.\n * @param {boolean|function(answers: Object): boolean} [messageOrOptions.when] Weather or not to\n * prompt this option.\n * @param {string|number} [defaultOrUndefined] The default value to use.\n */\n constructor(messageOrOptions, defaultOrUndefined) {\n if (messageOrOptions === undefined) {\n throw new Error('message or options required');\n }\n\n if (typeof messageOrOptions === 'string') {\n if (messageOrOptions.length === 0) {\n throw new Error('message is required');\n }\n\n /**\n * The option's {@link inquirer~PromptType}. Defaults to 'input'.\n * @type {inquirer~PromptType}\n */\n this.type = InitOption.DefaultType;\n\n /**\n * The option's message. A '?' sign is added automatically.\n * @type {String}\n */\n this.message = `${messageOrOptions}?`;\n\n /**\n * The default value to use.\n * @type {String|Number|undefined}\n */\n this.default = defaultOrUndefined;\n } else {\n if (!messageOrOptions.message || messageOrOptions.length === 0) {\n throw new Error('message is required');\n }\n\n this.type = messageOrOptions.type || InitOption.DefaultType;\n this.message = `${messageOrOptions.message}?`;\n this.default = messageOrOptions.default;\n\n /**\n * The choices available. Applies to list types only.\n * @type {String[]|Number[]|undefined}\n */\n this.choices = messageOrOptions.choices;\n\n /**\n * Validates the user input for this option.\n * @type {inquirer~Validator}\n */\n this.validate = messageOrOptions.validate;\n\n /**\n * A function or boolean that indicates weather or not to prompt this option.\n * @type {Boolean|function(answers: Object): Boolean|undefined}\n */\n this.when = messageOrOptions.when;\n }\n }\n\n /**\n * The default {@link inquirer~PromptType} to use. Equals 'input'.\n * @return {inquirer~PromptType} The default {@link inquirer~PromptType} to use.\n */\n static get DefaultType() {\n return 'input';\n }\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/lib/init/Option.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 229, "kind": "class", "name": "InitOption", "memberof": "src/lib/init/Option.js", "static": true, "longname": "src/lib/init/Option.js~InitOption", "access": "public", "export": true, "importPath": "atscm/src/lib/init/Option.js", "importStyle": "InitOption", "description": "An option the \"atscm init\" command handles.\nTODO: Support function values for name, message, default, choices...", "lineNumber": 5, "interface": false }, { "__docId__": 230, "kind": "constructor", "name": "constructor", "memberof": "src/lib/init/Option.js~InitOption", "generator": false, "async": false, "static": false, "longname": "src/lib/init/Option.js~InitOption#constructor", "access": "public", "description": "Creates a new option based either on a message and (optionally) a default value or some\noptions.", "lineNumber": 21, "params": [ { "nullable": null, "types": [ "string", "Object" ], "spread": false, "optional": false, "name": "messageOrOptions", "description": "The message or options to use." }, { "nullable": null, "types": [ "inquirer~PromptType" ], "spread": false, "optional": true, "name": "messageOrOptions.type", "description": "The option's type." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "messageOrOptions.message", "description": "The option's message. Required if `messageOrOptions`\nis an object." }, { "nullable": null, "types": [ "string", "number" ], "spread": false, "optional": true, "name": "messageOrOptions.default", "description": "The options's default value." }, { "nullable": null, "types": [ "inquirer~Validator" ], "spread": false, "optional": true, "name": "messageOrOptions.validate", "description": "A function that validates user input." }, { "nullable": null, "types": [ "string[]", "number[]" ], "spread": false, "optional": true, "name": "messageOrOptions.choices", "description": "The options's choices. Applies to to list\ntypes only." }, { "nullable": null, "types": [ "boolean", "function(answers: Object): boolean" ], "spread": false, "optional": true, "name": "messageOrOptions.when", "description": "Weather or not to\nprompt this option." }, { "nullable": null, "types": [ "string", "number" ], "spread": false, "optional": true, "name": "defaultOrUndefined", "description": "The default value to use." } ] }, { "__docId__": 231, "kind": "member", "name": "type", "memberof": "src/lib/init/Option.js~InitOption", "static": false, "longname": "src/lib/init/Option.js~InitOption#type", "access": "public", "description": "The option's {@link inquirer~PromptType}. Defaults to 'input'.", "lineNumber": 35, "type": { "nullable": null, "types": [ "inquirer~PromptType" ], "spread": false, "description": null } }, { "__docId__": 232, "kind": "member", "name": "message", "memberof": "src/lib/init/Option.js~InitOption", "static": false, "longname": "src/lib/init/Option.js~InitOption#message", "access": "public", "description": "The option's message. A '?' sign is added automatically.", "lineNumber": 41, "type": { "nullable": null, "types": [ "String" ], "spread": false, "description": null } }, { "__docId__": 233, "kind": "member", "name": "default", "memberof": "src/lib/init/Option.js~InitOption", "static": false, "longname": "src/lib/init/Option.js~InitOption#default", "access": "public", "description": "The default value to use.", "lineNumber": 47, "type": { "nullable": null, "types": [ "String", "Number", "undefined" ], "spread": false, "description": null } }, { "__docId__": 237, "kind": "member", "name": "choices", "memberof": "src/lib/init/Option.js~InitOption", "static": false, "longname": "src/lib/init/Option.js~InitOption#choices", "access": "public", "description": "The choices available. Applies to list types only.", "lineNumber": 61, "type": { "nullable": null, "types": [ "String[]", "Number[]", "undefined" ], "spread": false, "description": null } }, { "__docId__": 238, "kind": "member", "name": "validate", "memberof": "src/lib/init/Option.js~InitOption", "static": false, "longname": "src/lib/init/Option.js~InitOption#validate", "access": "public", "description": "Validates the user input for this option.", "lineNumber": 67, "type": { "nullable": null, "types": [ "inquirer~Validator" ], "spread": false, "description": null } }, { "__docId__": 239, "kind": "member", "name": "when", "memberof": "src/lib/init/Option.js~InitOption", "static": false, "longname": "src/lib/init/Option.js~InitOption#when", "access": "public", "description": "A function or boolean that indicates weather or not to prompt this option.", "lineNumber": 73, "type": { "nullable": null, "types": [ "Boolean", "function(answers: Object): Boolean", "undefined" ], "spread": false, "description": null } }, { "__docId__": 240, "kind": "get", "name": "DefaultType", "memberof": "src/lib/init/Option.js~InitOption", "generator": false, "async": false, "static": true, "longname": "src/lib/init/Option.js~InitOption.DefaultType", "access": "public", "description": "The default {@link inquirer~PromptType} to use. Equals 'input'.", "lineNumber": 81, "return": { "nullable": null, "types": [ "inquirer~PromptType" ], "spread": false, "description": "The default {@link inquirer~PromptType} to use." }, "type": { "types": [ "string" ] } }, { "__docId__": 241, "kind": "file", "name": "src/lib/model/Node.ts", "content": "import { ReferenceTypeIds as OpcReferenceTypeIds } from 'node-opcua/lib/opcua_node_ids';\nimport { NodeClass } from 'node-opcua/lib/datamodel/nodeclass';\nimport { VariantArrayType, DataType, Variant } from 'node-opcua/lib/datamodel/variant';\nimport { ItemOf, KeyOf } from 'node-opcua/lib/misc/enum.js';\nimport { reverse } from '../helpers/Object';\nimport { sortReferences } from '../helpers/mapping';\nimport { ValueOf } from '../helpers/types';\n\n/**\n * References type ids.\n */\nexport const ReferenceTypeIds = {\n ...OpcReferenceTypeIds,\n toParent: -1,\n};\n\n/** A reference type name */\ntype ReferenceTypeName = keyof typeof ReferenceTypeIds;\n\n/** A raw (number) reference type */\ntype ReferenceType = ValueOf;\n\n/** Node references stored in definition files */\nexport type ReferenceDefinitions = {\n [type in ReferenceTypeName]?: (number | string)[];\n};\n\n/** Node definition stored in definition file */\nexport interface NodeDefinition {\n nodeId?: string;\n nodeClass?: KeyOf; // Defaults to 'Variable'\n dataType?: KeyOf;\n arrayType?: KeyOf;\n references?: ReferenceDefinitions;\n}\n\n/**\n * Names for references.\n */\nexport const ReferenceTypeNames = reverse(ReferenceTypeIds) as { [key: number]: string };\n\n/**\n * A map specialized for holding references.\n */\nclass ReferenceMap extends Map> {\n /**\n * Adds a new reference.\n * @param {number} type The reference id.\n * @param {string} nodeId The reference target node's id.\n */\n public addReference(type: ReferenceType, nodeId: number | string): void {\n const set = this.get(type);\n if (set) {\n set.add(nodeId);\n } else {\n this.set(type, new Set([nodeId]));\n }\n }\n\n /**\n * Removes the given reference.\n * @param {number} type The reference id.\n * @param {string} nodeId The reference target node's id.\n */\n public deleteReference(type: ReferenceType, nodeId: number | string): number | string {\n const set = this.get(type);\n if (set) {\n const ref = set.delete(nodeId);\n\n if (ref) {\n if (set.size === 0) {\n this.delete(type);\n }\n\n return nodeId;\n }\n }\n\n throw new Error(`No ${ReferenceTypeNames[type] || type} reference to ${nodeId}`);\n }\n\n /**\n * Returns the first entry of a specific type.\n * @param type The reference type id to look for.\n * @return The first reference found or undefined.\n */\n public getSingle(type: ReferenceType): number | string | undefined {\n const set = this.get(type);\n return set && Array.from(set)[0];\n }\n\n /**\n * Returns a plain object of refernces.\n * @return A string describing the reference map.\n */\n public toJSON(): ReferenceDefinitions {\n return [...this].reduce(\n (result, [key, value]) =>\n Object.assign(result, {\n [ReferenceTypeNames[key] || key]: [...value],\n }),\n {}\n );\n }\n}\n\ninterface WithValue {\n value: Variant;\n}\n\nexport interface NodeOptions {\n name: string;\n parent?: Node;\n nodeClass: ItemOf;\n}\n\ntype NodeResolveKey = 'nodeClass' | 'dataType' | 'arrayType';\n\n/**\n * The main model class.\n */\nexport default abstract class Node {\n /** The node's name when stored to a file. */\n protected fileName: string;\n /** The node's name when written to the server. */\n protected idName: string;\n /** The id stored in the definition file. */\n protected specialId?: string;\n\n /** The node's parent node. */\n public readonly parent?: Node;\n /** The node's class. */\n public readonly nodeClass: ItemOf;\n\n /** A set of resolved properties. */\n protected _resolved = new Set();\n /** A set of unresolved properties. */\n protected _unresolved: Set;\n /** The node's references. */\n public references = new ReferenceMap();\n /** The node's unresolved refernces. */\n protected _resolvedReferences = new ReferenceMap();\n /** The node's resolved refernces. */\n protected _unresolvedReferences = new ReferenceMap();\n /** If the parent node resolves metadata. */\n protected _parentResolvesMetadata = false;\n\n /**\n * Creates a new node.\n * @param {Object} options The options to use.\n * @param {string} options.name The node's name.\n * @param {Node} options.parent The node's parent node.\n * @param {node-opcua~NodeClass} options.nodeClass The node's class.\n */\n public constructor({ name, parent, nodeClass /* , referenceToParent */ }: NodeOptions) {\n this.fileName = name;\n this.idName = name;\n this.parent = parent;\n this.nodeClass = nodeClass;\n\n this._unresolved = new Set([\n 'nodeClass',\n // Only for variables\n 'dataType',\n 'arrayType',\n ]);\n }\n\n /**\n * If the parent resolves metadata (for example: split transformer source files).\n */\n public get parentResolvesMetadata(): boolean {\n return this._parentResolvesMetadata;\n }\n\n public markAsResolved(key: NodeResolveKey): void {\n const value = this._unresolved.delete(key);\n\n // FIXME: Only test if debug / test\n if (value === false) {\n throw new Error(`'${key}' is already resolved`);\n }\n\n this._resolved.add(key);\n }\n\n public isResolved(key: NodeResolveKey): boolean {\n return this._resolved.has(key);\n }\n\n /**\n * Adds a new reference.\n * @param {number} type The reference type's id.\n * @param {string} id The reference target node's id.\n */\n public addReference(type: ReferenceType, id: string): void {\n this.references.addReference(type, id);\n this._unresolvedReferences.addReference(type, id);\n }\n\n public setReferences(type: ReferenceType, ids: string[]): void {\n this.references.set(type, new Set(ids));\n this._unresolvedReferences.set(type, new Set(ids));\n }\n\n public markReferenceAsResolved(name: ReferenceTypeName, value: string): void {\n const type = ReferenceTypeIds[name];\n const ref = this._unresolvedReferences.deleteReference(type, value);\n this._resolvedReferences.addReference(type, ref);\n }\n\n public markAllReferencesAsResolved(name: ReferenceTypeName): void {\n const type = ReferenceTypeIds[name];\n this._unresolvedReferences.delete(type);\n }\n\n public hasUnresolvedReference(name: ReferenceTypeName): boolean {\n const type = ReferenceTypeIds[name];\n return this._unresolvedReferences.has(type);\n }\n\n /**\n * The node's file path, used to compute {@link Node#filePath}.\n */\n private get _filePath(): string[] {\n if (!this.parent) {\n return [this.fileName];\n }\n return this.parent._filePath.concat(this.fileName);\n }\n\n /**\n * The node's file path.\n */\n public get filePath(): string[] {\n if (!this.parent) {\n return [];\n }\n return this.parent._filePath;\n }\n\n /**\n * The node's id, used to compute {@link Node#nodeId}.\n */\n private get _nodeId(): { id: string; separator: '/' | '.' } {\n if (this.specialId) {\n return {\n id: this.specialId,\n separator: this.specialId.match(/\\.RESOURCES\\/?/) ? '/' : '.',\n };\n }\n\n if (!this.parent) {\n return {\n id: this.idName,\n separator: '.',\n };\n }\n\n const { separator, id } = this.parent._nodeId;\n\n if (this._parentResolvesMetadata) {\n return { separator, id };\n }\n\n return {\n separator: this.idName === 'RESOURCES' ? '/' : separator,\n id: `${id}${separator}${this.idName}`,\n };\n }\n\n /**\n * The node's id.\n */\n public get nodeId(): string {\n return this._nodeId.id;\n }\n\n /**\n * The node's type definition if given.\n */\n public get typeDefinition(): number | string | undefined {\n return this.references.getSingle(ReferenceTypeIds.HasTypeDefinition);\n }\n\n /**\n * The node's modellingRule if given.\n * @type {?number}\n */\n public get modellingRule(): number | string | undefined {\n return this.references.getSingle(ReferenceTypeIds.HasModellingRule);\n }\n\n /**\n * Returns `true` if the node has the given type definition.\n * @param typeDefName - The type definition to check.\n * @return If the node has the given type definition.\n */\n public hasTypeDefinition(typeDefName: number | string): boolean {\n const def = this.typeDefinition;\n\n return def ? def === typeDefName : false;\n }\n\n /**\n * `true` at the moment.\n */\n public get hasUnresolvedMetadata(): boolean {\n return true;\n /* FIXME: Once plugin mapping is implemented\n const value = !this._parentResolvesMetadata && (Boolean(this._unresolved.size) ||\n Boolean(this._unresolvedReferences.size) || this.specialId);\n\n // FIXME: If debug / test\n if (!value && Object.keys(this.metadata).length > 0) {\n throw new Error(`#hasUnresolvedMetadata did return invalid result ${\n value\n } for ${\n JSON.stringify(Object.assign(this, {parent: undefined, value: undefined }), null, ' ')\n }`);\n } else if (value && Object.keys(this.metadata).length === 0) {\n throw new Error('#metadata did return invalid result');\n }\n\n return value; */\n }\n\n /**\n * The metadata to store in the node's definition file.\n * @type {Object}\n */\n public get metadata(): NodeDefinition {\n if (this._parentResolvesMetadata) {\n return {};\n }\n\n const meta: Partial = {};\n\n if (this.specialId) {\n meta.nodeId = this.specialId;\n }\n\n if (this.isVariableNode()) {\n meta.dataType = this.value.dataType.key;\n meta.arrayType = this.value.arrayType.key;\n } else {\n meta.nodeClass = this.nodeClass.key;\n }\n\n meta.references = sortReferences(this.references.toJSON());\n\n /* FIXME: Once plugin mapping is implemented\n for (const unresolved of this._unresolved) {\n let value = this[unresolved];\n\n if (unresolved === 'dataType') {\n value = this.value.dataType ? this.value.dataType.key : 'UNKNOWN';\n } else if (unresolved === 'arrayType') {\n value = this.value.arrayType ? this.value.arrayType.key : 'UNKNOWN';\n }\n\n meta[unresolved] = value;\n }\n\n\n if (this._unresolvedReferences.size) {\n meta.references = sortReferences(this._unresolvedReferences.toJSON());\n }\n */\n\n return meta;\n }\n\n // Manipulation\n\n /**\n * Creates a new child node.\n * @param {Object} options The options to use.\n * @param {string} options.extension The extension to append to the node's name.\n */\n public createChild({ extension }: { extension: string }): Node {\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n const node: Node = new (this.constructor as any)({\n name: this.idName,\n parent: this,\n nodeClass: this.nodeClass,\n });\n\n node.fileName = `${this.fileName}${extension}`;\n\n node.references = this.references;\n node._parentResolvesMetadata = true;\n\n return node;\n }\n\n // Convenience getters\n\n /**\n * The node's data type.\n */\n public get dataType(): ItemOf {\n if (!this.isVariableNode()) {\n throw new TypeError('Not a variable node');\n }\n\n return this.value.dataType;\n }\n\n /**\n * The node's array type.\n */\n public get arrayType(): ItemOf {\n if (!this.isVariableNode()) {\n throw new TypeError('Not a variable node');\n }\n\n return this.value.arrayType;\n }\n\n /**\n * If the node is a variable.\n * @deprecated Use TypeScript compatible {@link Node#isVariableNode} instead.\n */\n public get isVariable(): boolean {\n return this.nodeClass === NodeClass.Variable;\n }\n\n public isVariableNode(): this is WithValue {\n return this.isVariable;\n }\n\n // FIXME: Move to display / script transformers\n\n /**\n * If the node is an object display.\n */\n public get isDisplay(): boolean {\n return this.hasTypeDefinition('VariableTypes.ATVISE.Display');\n }\n\n /**\n * If the node is a serverside script.\n */\n public get isScript(): boolean {\n return this.hasTypeDefinition('VariableTypes.ATVISE.ScriptCode');\n }\n\n /**\n * If the node is a quickdynamic.\n */\n public get isQuickDynamic(): boolean {\n return this.hasTypeDefinition('VariableTypes.ATVISE.QuickDynamic');\n }\n\n /**\n * If the node is a display script.\n */\n public get isDisplayScript(): boolean {\n return this.hasTypeDefinition('VariableTypes.ATVISE.DisplayScript');\n }\n}\n\n/**\n * A node during a *pull*.\n */\nexport abstract class ServerNode extends Node {\n /**\n * The node's name.\n */\n public get name(): string {\n return this.fileName;\n }\n\n /**\n * Renames a node.\n * @param name The name to set.\n */\n public renameTo(name: string): void {\n this.fileName = name;\n }\n}\n\n/**\n * A node during a *push*.\n */\nexport abstract class SourceNode extends Node {\n /**\n * The node's name.\n */\n public get name(): string {\n return this.idName;\n }\n\n /**\n * Renames a node.\n * @param name The name to set.\n */\n public renameTo(name: string): void {\n this.idName = name;\n }\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/lib/model/Node.ts", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 242, "kind": "variable", "name": "ReferenceTypeIds", "memberof": "src/lib/model/Node.ts", "static": true, "longname": "src/lib/model/Node.ts~ReferenceTypeIds", "access": "public", "export": true, "importPath": "atscm/src/lib/model/Node.ts", "importStyle": "{ReferenceTypeIds}", "description": "References type ids.", "lineNumber": 8, "type": { "types": [ "{...OpcReferenceTypeIds: Object, \"toParent\": *}" ] } }, { "__docId__": 243, "kind": "variable", "name": "ReferenceTypeNames", "memberof": "src/lib/model/Node.ts", "static": true, "longname": "src/lib/model/Node.ts~ReferenceTypeNames", "access": "public", "export": true, "importPath": "atscm/src/lib/model/Node.ts", "importStyle": "{ReferenceTypeNames}", "description": "Names for references.", "lineNumber": 15, "type": { "types": [ "*" ] } }, { "__docId__": 244, "kind": "class", "name": "ReferenceMap", "memberof": "src/lib/model/Node.ts", "static": true, "longname": "src/lib/model/Node.ts~ReferenceMap", "access": "public", "export": false, "importPath": "atscm/src/lib/model/Node.ts", "importStyle": null, "description": "A map specialized for holding references.", "lineNumber": 45, "interface": false, "extends": [ "Map" ], "ignore": true }, { "__docId__": 245, "kind": "method", "name": "addReference", "memberof": "src/lib/model/Node.ts~ReferenceMap", "generator": false, "async": false, "static": false, "longname": "src/lib/model/Node.ts~ReferenceMap#addReference", "access": "public", "description": "Adds a new reference.", "lineNumber": 51, "params": [ { "nullable": null, "types": [ "ReferenceType" ], "spread": false, "optional": false, "name": "type", "description": "" }, { "nullable": null, "types": [ "undefined" ], "spread": false, "optional": false, "name": "nodeId", "description": "" } ], "return": { "nullable": null, "types": [ "undefined" ], "spread": false, "description": "" } }, { "__docId__": 246, "kind": "method", "name": "deleteReference", "memberof": "src/lib/model/Node.ts~ReferenceMap", "generator": false, "async": false, "static": false, "longname": "src/lib/model/Node.ts~ReferenceMap#deleteReference", "access": "public", "description": "Removes the given reference.", "lineNumber": 65, "params": [ { "nullable": null, "types": [ "ReferenceType" ], "spread": false, "optional": false, "name": "type", "description": "" }, { "nullable": null, "types": [ "undefined" ], "spread": false, "optional": false, "name": "nodeId", "description": "" } ], "return": { "nullable": null, "types": [ "undefined" ], "spread": false, "description": "" } }, { "__docId__": 247, "kind": "method", "name": "getSingle", "memberof": "src/lib/model/Node.ts~ReferenceMap", "generator": false, "async": false, "static": false, "longname": "src/lib/model/Node.ts~ReferenceMap#getSingle", "access": "public", "description": "Returns the first entry of a specific type.", "lineNumber": 87, "params": [ { "nullable": null, "types": [ "ReferenceType" ], "spread": false, "optional": false, "name": "type", "description": "" } ], "return": { "nullable": null, "types": [ "undefined" ], "spread": false, "description": "" } }, { "__docId__": 248, "kind": "method", "name": "toJSON", "memberof": "src/lib/model/Node.ts~ReferenceMap", "generator": false, "async": false, "static": false, "longname": "src/lib/model/Node.ts~ReferenceMap#toJSON", "access": "public", "description": "Returns a plain object of refernces.", "lineNumber": 96, "return": { "nullable": null, "types": [ "ReferenceDefinitions" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 249, "kind": "class", "name": "Node", "memberof": "src/lib/model/Node.ts", "static": true, "longname": "src/lib/model/Node.ts~Node", "access": "public", "export": true, "importPath": "atscm/src/lib/model/Node.ts", "importStyle": "Node", "description": "The main model class.", "lineNumber": 122, "interface": false }, { "__docId__": 250, "kind": "constructor", "name": "constructor", "memberof": "src/lib/model/Node.ts~Node", "generator": false, "async": false, "static": false, "longname": "src/lib/model/Node.ts~Node#constructor", "access": "public", "description": "Creates a new node.", "lineNumber": 111, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options", "description": "The options to use." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "options.name", "description": "The node's name." }, { "nullable": null, "types": [ "Node" ], "spread": false, "optional": false, "name": "options.parent", "description": "The node's parent node." }, { "nullable": null, "types": [ "node-opcua~NodeClass" ], "spread": false, "optional": false, "name": "options.nodeClass", "description": "The node's class." } ] }, { "__docId__": 251, "kind": "member", "name": "_resolved", "memberof": "src/lib/model/Node.ts~Node", "static": false, "longname": "src/lib/model/Node.ts~Node#_resolved", "access": "private", "description": "A set of resolved properties.", "lineNumber": 136, "type": { "types": [ "*" ] } }, { "__docId__": 252, "kind": "member", "name": "references", "memberof": "src/lib/model/Node.ts~Node", "static": false, "longname": "src/lib/model/Node.ts~Node#references", "access": "public", "description": "The node's references.", "lineNumber": 140, "type": { "types": [ "*" ] } }, { "__docId__": 253, "kind": "member", "name": "_resolvedReferences", "memberof": "src/lib/model/Node.ts~Node", "static": false, "longname": "src/lib/model/Node.ts~Node#_resolvedReferences", "access": "private", "description": "The node's unresolved refernces.", "lineNumber": 142, "type": { "types": [ "*" ] } }, { "__docId__": 254, "kind": "member", "name": "_unresolvedReferences", "memberof": "src/lib/model/Node.ts~Node", "static": false, "longname": "src/lib/model/Node.ts~Node#_unresolvedReferences", "access": "private", "description": "The node's resolved refernces.", "lineNumber": 144, "type": { "types": [ "*" ] } }, { "__docId__": 255, "kind": "member", "name": "_parentResolvesMetadata", "memberof": "src/lib/model/Node.ts~Node", "static": false, "longname": "src/lib/model/Node.ts~Node#_parentResolvesMetadata", "access": "private", "description": "If the parent node resolves metadata.", "lineNumber": 146, "type": { "types": [ "boolean" ] } }, { "__docId__": 256, "kind": "member", "name": "fileName", "memberof": "src/lib/model/Node.ts~Node", "static": false, "longname": "src/lib/model/Node.ts~Node#fileName", "access": "public", "description": null, "lineNumber": 147, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 257, "kind": "member", "name": "idName", "memberof": "src/lib/model/Node.ts~Node", "static": false, "longname": "src/lib/model/Node.ts~Node#idName", "access": "public", "description": null, "lineNumber": 148, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 258, "kind": "member", "name": "parent", "memberof": "src/lib/model/Node.ts~Node", "static": false, "longname": "src/lib/model/Node.ts~Node#parent", "access": "public", "description": null, "lineNumber": 149, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 259, "kind": "member", "name": "nodeClass", "memberof": "src/lib/model/Node.ts~Node", "static": false, "longname": "src/lib/model/Node.ts~Node#nodeClass", "access": "public", "description": null, "lineNumber": 150, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 260, "kind": "member", "name": "_unresolved", "memberof": "src/lib/model/Node.ts~Node", "static": false, "longname": "src/lib/model/Node.ts~Node#_unresolved", "access": "private", "description": null, "lineNumber": 151, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 261, "kind": "get", "name": "parentResolvesMetadata", "memberof": "src/lib/model/Node.ts~Node", "generator": false, "async": false, "static": false, "longname": "src/lib/model/Node.ts~Node#parentResolvesMetadata", "access": "public", "description": "If the parent resolves metadata (for example: split transformer source files).", "lineNumber": 172, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 262, "kind": "method", "name": "markAsResolved", "memberof": "src/lib/model/Node.ts~Node", "generator": false, "async": false, "static": false, "longname": "src/lib/model/Node.ts~Node#markAsResolved", "access": "public", "description": "", "lineNumber": 176, "params": [ { "nullable": null, "types": [ "NodeResolveKey" ], "spread": false, "optional": false, "name": "key", "description": "" } ], "return": { "nullable": null, "types": [ "undefined" ], "spread": false, "description": "" } }, { "__docId__": 263, "kind": "method", "name": "isResolved", "memberof": "src/lib/model/Node.ts~Node", "generator": false, "async": false, "static": false, "longname": "src/lib/model/Node.ts~Node#isResolved", "access": "public", "description": "", "lineNumber": 187, "params": [ { "nullable": null, "types": [ "NodeResolveKey" ], "spread": false, "optional": false, "name": "key", "description": "" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" } }, { "__docId__": 264, "kind": "method", "name": "addReference", "memberof": "src/lib/model/Node.ts~Node", "generator": false, "async": false, "static": false, "longname": "src/lib/model/Node.ts~Node#addReference", "access": "public", "description": "Adds a new reference.", "lineNumber": 196, "params": [ { "nullable": null, "types": [ "ReferenceType" ], "spread": false, "optional": false, "name": "type", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "id", "description": "" } ], "return": { "nullable": null, "types": [ "undefined" ], "spread": false, "description": "" } }, { "__docId__": 265, "kind": "method", "name": "setReferences", "memberof": "src/lib/model/Node.ts~Node", "generator": false, "async": false, "static": false, "longname": "src/lib/model/Node.ts~Node#setReferences", "access": "public", "description": "", "lineNumber": 201, "params": [ { "nullable": null, "types": [ "ReferenceType" ], "spread": false, "optional": false, "name": "type", "description": "" }, { "nullable": null, "types": [ "undefined" ], "spread": false, "optional": false, "name": "ids", "description": "" } ], "return": { "nullable": null, "types": [ "undefined" ], "spread": false, "description": "" } }, { "__docId__": 266, "kind": "method", "name": "markReferenceAsResolved", "memberof": "src/lib/model/Node.ts~Node", "generator": false, "async": false, "static": false, "longname": "src/lib/model/Node.ts~Node#markReferenceAsResolved", "access": "public", "description": "", "lineNumber": 206, "params": [ { "nullable": null, "types": [ "ReferenceTypeName" ], "spread": false, "optional": false, "name": "name", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "value", "description": "" } ], "return": { "nullable": null, "types": [ "undefined" ], "spread": false, "description": "" } }, { "__docId__": 267, "kind": "method", "name": "markAllReferencesAsResolved", "memberof": "src/lib/model/Node.ts~Node", "generator": false, "async": false, "static": false, "longname": "src/lib/model/Node.ts~Node#markAllReferencesAsResolved", "access": "public", "description": "", "lineNumber": 212, "params": [ { "nullable": null, "types": [ "ReferenceTypeName" ], "spread": false, "optional": false, "name": "name", "description": "" } ], "return": { "nullable": null, "types": [ "undefined" ], "spread": false, "description": "" } }, { "__docId__": 268, "kind": "method", "name": "hasUnresolvedReference", "memberof": "src/lib/model/Node.ts~Node", "generator": false, "async": false, "static": false, "longname": "src/lib/model/Node.ts~Node#hasUnresolvedReference", "access": "public", "description": "", "lineNumber": 217, "params": [ { "nullable": null, "types": [ "ReferenceTypeName" ], "spread": false, "optional": false, "name": "name", "description": "" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" } }, { "__docId__": 269, "kind": "get", "name": "_filePath", "memberof": "src/lib/model/Node.ts~Node", "generator": false, "async": false, "static": false, "longname": "src/lib/model/Node.ts~Node#_filePath", "access": "private", "description": "The node's file path, used to compute {@link Node#filePath}.", "lineNumber": 225, "type": { "nullable": null, "types": [ "undefined" ], "spread": false, "description": null } }, { "__docId__": 270, "kind": "get", "name": "filePath", "memberof": "src/lib/model/Node.ts~Node", "generator": false, "async": false, "static": false, "longname": "src/lib/model/Node.ts~Node#filePath", "access": "public", "description": "The node's file path.", "lineNumber": 235, "type": { "nullable": null, "types": [ "undefined" ], "spread": false, "description": null } }, { "__docId__": 271, "kind": "get", "name": "_nodeId", "memberof": "src/lib/model/Node.ts~Node", "generator": false, "async": false, "static": false, "longname": "src/lib/model/Node.ts~Node#_nodeId", "access": "private", "description": "The node's id, used to compute {@link Node#nodeId}.", "lineNumber": 245, "type": { "nullable": null, "types": [ "undefined" ], "spread": false, "description": null } }, { "__docId__": 272, "kind": "get", "name": "nodeId", "memberof": "src/lib/model/Node.ts~Node", "generator": false, "async": false, "static": false, "longname": "src/lib/model/Node.ts~Node#nodeId", "access": "public", "description": "The node's id.", "lineNumber": 275, "type": { "nullable": null, "types": [ "string" ], "spread": false, "description": null } }, { "__docId__": 273, "kind": "get", "name": "typeDefinition", "memberof": "src/lib/model/Node.ts~Node", "generator": false, "async": false, "static": false, "longname": "src/lib/model/Node.ts~Node#typeDefinition", "access": "public", "description": "The node's type definition if given.", "lineNumber": 282, "type": { "nullable": null, "types": [ "undefined" ], "spread": false, "description": null } }, { "__docId__": 274, "kind": "get", "name": "modellingRule", "memberof": "src/lib/model/Node.ts~Node", "generator": false, "async": false, "static": false, "longname": "src/lib/model/Node.ts~Node#modellingRule", "access": "public", "description": "The node's modellingRule if given.", "lineNumber": 290, "type": { "nullable": null, "types": [ "undefined" ], "spread": false, "description": null } }, { "__docId__": 275, "kind": "method", "name": "hasTypeDefinition", "memberof": "src/lib/model/Node.ts~Node", "generator": false, "async": false, "static": false, "longname": "src/lib/model/Node.ts~Node#hasTypeDefinition", "access": "public", "description": "Returns `true` if the node has the given type definition.", "lineNumber": 299, "params": [ { "nullable": null, "types": [ "undefined" ], "spread": false, "optional": false, "name": "typeDefName", "description": "" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" } }, { "__docId__": 276, "kind": "get", "name": "hasUnresolvedMetadata", "memberof": "src/lib/model/Node.ts~Node", "generator": false, "async": false, "static": false, "longname": "src/lib/model/Node.ts~Node#hasUnresolvedMetadata", "access": "public", "description": "`true` at the moment.", "lineNumber": 308, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 277, "kind": "get", "name": "metadata", "memberof": "src/lib/model/Node.ts~Node", "generator": false, "async": false, "static": false, "longname": "src/lib/model/Node.ts~Node#metadata", "access": "public", "description": "The metadata to store in the node's definition file.", "lineNumber": 332, "type": { "nullable": null, "types": [ "NodeDefinition" ], "spread": false, "description": null } }, { "__docId__": 278, "kind": "method", "name": "createChild", "memberof": "src/lib/model/Node.ts~Node", "generator": false, "async": false, "static": false, "longname": "src/lib/model/Node.ts~Node#createChild", "access": "public", "description": "Creates a new child node.", "lineNumber": 381, "params": [ { "nullable": null, "types": [ "undefined" ], "spread": false, "optional": false, "name": "undefined", "description": "" } ], "return": { "nullable": null, "types": [ "Node" ], "spread": false, "description": "" } }, { "__docId__": 279, "kind": "get", "name": "dataType", "memberof": "src/lib/model/Node.ts~Node", "generator": false, "async": false, "static": false, "longname": "src/lib/model/Node.ts~Node#dataType", "access": "public", "description": "The node's data type.", "lineNumber": 402, "type": { "nullable": null, "types": [ "ItemOf" ], "spread": false, "description": null } }, { "__docId__": 280, "kind": "get", "name": "arrayType", "memberof": "src/lib/model/Node.ts~Node", "generator": false, "async": false, "static": false, "longname": "src/lib/model/Node.ts~Node#arrayType", "access": "public", "description": "The node's array type.", "lineNumber": 413, "type": { "nullable": null, "types": [ "ItemOf" ], "spread": false, "description": null } }, { "__docId__": 281, "kind": "get", "name": "isVariable", "memberof": "src/lib/model/Node.ts~Node", "generator": false, "async": false, "static": false, "longname": "src/lib/model/Node.ts~Node#isVariable", "access": "public", "description": "If the node is a variable.", "lineNumber": 425, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 282, "kind": "method", "name": "isVariableNode", "memberof": "src/lib/model/Node.ts~Node", "generator": false, "async": false, "static": false, "longname": "src/lib/model/Node.ts~Node#isVariableNode", "access": "public", "description": "", "lineNumber": 429, "return": { "nullable": null, "types": [ "undefined" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 283, "kind": "get", "name": "isDisplay", "memberof": "src/lib/model/Node.ts~Node", "generator": false, "async": false, "static": false, "longname": "src/lib/model/Node.ts~Node#isDisplay", "access": "public", "description": "If the node is an object display.", "lineNumber": 438, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 284, "kind": "get", "name": "isScript", "memberof": "src/lib/model/Node.ts~Node", "generator": false, "async": false, "static": false, "longname": "src/lib/model/Node.ts~Node#isScript", "access": "public", "description": "If the node is a serverside script.", "lineNumber": 445, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 285, "kind": "get", "name": "isQuickDynamic", "memberof": "src/lib/model/Node.ts~Node", "generator": false, "async": false, "static": false, "longname": "src/lib/model/Node.ts~Node#isQuickDynamic", "access": "public", "description": "If the node is a quickdynamic.", "lineNumber": 452, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 286, "kind": "get", "name": "isDisplayScript", "memberof": "src/lib/model/Node.ts~Node", "generator": false, "async": false, "static": false, "longname": "src/lib/model/Node.ts~Node#isDisplayScript", "access": "public", "description": "If the node is a display script.", "lineNumber": 459, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 287, "kind": "class", "name": "ServerNode", "memberof": "src/lib/model/Node.ts", "static": true, "longname": "src/lib/model/Node.ts~ServerNode", "access": "public", "export": true, "importPath": "atscm/src/lib/model/Node.ts", "importStyle": "{ServerNode}", "description": "A node during a *pull*.", "lineNumber": 467, "interface": false, "extends": [ "Node" ] }, { "__docId__": 288, "kind": "get", "name": "name", "memberof": "src/lib/model/Node.ts~ServerNode", "generator": false, "async": false, "static": false, "longname": "src/lib/model/Node.ts~ServerNode#name", "access": "public", "description": "The node's name.", "lineNumber": 471, "type": { "nullable": null, "types": [ "string" ], "spread": false, "description": null } }, { "__docId__": 289, "kind": "method", "name": "renameTo", "memberof": "src/lib/model/Node.ts~ServerNode", "generator": false, "async": false, "static": false, "longname": "src/lib/model/Node.ts~ServerNode#renameTo", "access": "public", "description": "Renames a node.", "lineNumber": 479, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "name", "description": "" } ], "return": { "nullable": null, "types": [ "undefined" ], "spread": false, "description": "" } }, { "__docId__": 290, "kind": "member", "name": "fileName", "memberof": "src/lib/model/Node.ts~ServerNode", "static": false, "longname": "src/lib/model/Node.ts~ServerNode#fileName", "access": "public", "description": null, "lineNumber": 602, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 291, "kind": "class", "name": "SourceNode", "memberof": "src/lib/model/Node.ts", "static": true, "longname": "src/lib/model/Node.ts~SourceNode", "access": "public", "export": true, "importPath": "atscm/src/lib/model/Node.ts", "importStyle": "{SourceNode}", "description": "A node during a *push*.", "lineNumber": 487, "interface": false, "extends": [ "Node" ] }, { "__docId__": 292, "kind": "get", "name": "name", "memberof": "src/lib/model/Node.ts~SourceNode", "generator": false, "async": false, "static": false, "longname": "src/lib/model/Node.ts~SourceNode#name", "access": "public", "description": "The node's name.", "lineNumber": 491, "type": { "nullable": null, "types": [ "string" ], "spread": false, "description": null } }, { "__docId__": 293, "kind": "method", "name": "renameTo", "memberof": "src/lib/model/Node.ts~SourceNode", "generator": false, "async": false, "static": false, "longname": "src/lib/model/Node.ts~SourceNode#renameTo", "access": "public", "description": "Renames a node.", "lineNumber": 499, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "name", "description": "" } ], "return": { "nullable": null, "types": [ "undefined" ], "spread": false, "description": "" } }, { "__docId__": 294, "kind": "member", "name": "idName", "memberof": "src/lib/model/Node.ts~SourceNode", "static": false, "longname": "src/lib/model/Node.ts~SourceNode#idName", "access": "public", "description": null, "lineNumber": 634, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 295, "kind": "file", "name": "src/lib/model/opcua/NodeId.js", "content": "import { sep } from 'path';\nimport { NodeId as OpcNodeId } from 'node-opcua/lib/datamodel/nodeid';\n\n/**\n * OPC-UA node id types.\n * @type {Map}\n */\nconst Type = OpcNodeId.NodeIdType;\n\n/**\n * OPC-UA node id types mapped against node-id identifiers (e.g. i, s ...).\n * @type {Map}\n */\nconst TypeForIdentifier = {\n i: Type.NUMERIC,\n s: Type.STRING,\n g: Type.GUID,\n b: Type.BYTESTRING,\n};\n\n/**\n * Resource nodes are only allowed to have these child nodes.\n * @type {Set}\n */\nconst possibleResourceChildNodes = new Set(['Translate', 'Compress']);\n\n/**\n * A wrapper around {@link node-opcua~NodeId}.\n */\nexport default class NodeId extends OpcNodeId {\n /**\n * Creates a new NodeId. Can be called in multiple ways:\n * - with a {@link node-opcua~NodeIdType}, a value and a namespace (defaults to 0),\n * - with a value only (type will be taken from it, namespace defaults to 1) or\n * - with a {@link NodeId}s string representation (for example `ns=1;s=AGENT.DISPLAYS`).\n * @param {node-opcua~NodeIdType|string|number} typeOrValue The type or value to use.\n * @param {(number|string)} [value] The value to use.\n * @param {number} [namespace=1] The namespace to use.\n */\n constructor(typeOrValue, value, namespace = 1) {\n if (!Type.get(typeOrValue)) {\n let m = null;\n\n if (typeof typeOrValue === 'string') {\n m = typeOrValue.match(/^ns=([0-9]+);(i|s|g|b)=(.*)$/);\n }\n\n if (m === null) {\n super(\n Number.isNaN(Number.parseInt(typeOrValue, 10)) ? Type.STRING : Type.NUMERIC,\n typeOrValue,\n 1\n );\n } else {\n const n = Number.parseInt(m[1], 10);\n const t = TypeForIdentifier[m[2]];\n const v = t === Type.NUMERIC ? Number.parseInt(m[3], 10) : m[3];\n\n super(t, v, n);\n }\n } else {\n super(typeOrValue, value, namespace);\n }\n }\n\n /**\n * Creates a new NodeId based on a file path.\n * @param {string} path The file path to use.\n * @return {NodeId} The resulting NodeId.\n */\n static fromFilePath(path) {\n let separator = '.';\n\n const value = path.split(sep).reduce((result, current, index, components) => {\n const next = `${result ? `${result}${separator}` : ''}${current.replace('%2F', '/')}`;\n\n if (current === 'RESOURCES') {\n separator = '/';\n } else if (separator === '/' && possibleResourceChildNodes.has(components[index + 1])) {\n separator = '.';\n }\n\n return next;\n }, '');\n\n return new NodeId(NodeId.NodeIdType.STRING, value, 1);\n }\n\n /**\n * The node id's value, encoded to a file path.\n * @type {string}\n */\n get filePath() {\n const parts = this.value.split('RESOURCES');\n parts[0] = parts[0].replace('/', '%2F').split('.').join('/');\n\n return parts.join('RESOURCES');\n }\n\n // eslint-disable-next-line jsdoc/require-description-complete-sentence\n /**\n * Returns the last separator in a string node id's path, e.g.:\n * - `'/'` for `ns=1;SYSTEM.LIBRARY.RESOURCES/index.htm`,\n * - `'.'` for `ns=1;AGENT.DISPLAYS.Main`.\n * @type {?string} `null` for non-string node ids, `'/'` for resource paths, `'.'` for regular\n * string node ids.\n */\n get _lastSeparator() {\n if (this.identifierType !== NodeId.NodeIdType.STRING) {\n return null;\n }\n\n return ~this.value.indexOf('/') ? '/' : '.';\n }\n\n /**\n * The parent node id, or `null`.\n * @type {?NodeId}\n * @deprecated Doesn't work properly in some edge cases. Use AtviseFile#parentNodeId instead\n * whenever possible.\n */\n get parent() {\n if (this.identifierType !== NodeId.NodeIdType.STRING) {\n return null;\n }\n\n /*\n Known aliases:\n - AGENT and SYSTEM are children of \"Objects\"\n - ObjectTypes.PROJECT and VariableTypes.PROJECT are children of their base Types\n */\n // FIXME: Should be in mapping transformer\n if (this.value === 'AGENT' || this.value === 'SYSTEM') {\n return new NodeId(NodeId.NodeIdType.NUMERIC, 85, 0); // \"Objects\"\n } else if (this.value === 'ObjectTypes.PROJECT') {\n return new NodeId(NodeId.NodeIdType.NUMERIC, 58, 0); // \"BaseObjectType\"\n } else if (this.value === 'VariableTypes.PROJECT') {\n return new NodeId(NodeId.NodeIdType.NUMERIC, 62, 0); // \"BaseVariableType\"\n }\n\n const parentValue = this.value.substr(0, this.value.lastIndexOf(this._lastSeparator));\n\n if (!parentValue) {\n // Root node -> 'Objects' is parent\n return new NodeId(NodeId.NodeIdType.NUMERIC, 85, 0);\n }\n\n return new NodeId(NodeId.NodeIdType.STRING, parentValue, this.namespace);\n }\n\n /**\n * Checks if the node is a child of another.\n * @param {NodeId} parent The possible parent to check.\n * @return {boolean} `true` if *this* is a child node of *parent*.\n */\n isChildOf(parent) {\n if (\n this.identifierType !== NodeId.NodeIdType.STRING ||\n parent.identifierType !== NodeId.NodeIdType.STRING\n ) {\n return false;\n }\n\n if (this.namespace !== parent.namespace || this.value === parent.value) {\n return false;\n }\n\n const [prefix, postfix] = this.value.split(parent.value);\n\n return (\n prefix === '' &&\n postfix &&\n (postfix[0] === this._lastSeparator ||\n (this._lastSeparator === '/' && postfix[0] === '.' && postfix.split('.').length === 2))\n );\n }\n\n /**\n * The node id's browsename as string.\n * @type {string}\n */\n get browseName() {\n if (this.identifierType !== NodeId.NodeIdType.STRING) {\n return null;\n }\n\n return this.value.substr(this.value.lastIndexOf(this._lastSeparator) + 1);\n }\n\n /**\n * Returns a string in the format \"namespace value\" that is printed when inspecting the NodeId\n * using {@link util~inspect}.\n * @see https://nodejs.org/api/util.html#util_util_inspect_object_options\n * @param {number} depth The depth to inspect.\n * @param {Object} options The options to use.\n * @return {string} A string in the format \"namespace value\".\n */\n inspect(depth, options) {\n return [\n options.stylize(this.namespace, 'number'),\n options.stylize(this.value, this.identifierType === Type.NUMERIC ? 'number' : 'string'),\n ].join(' ');\n }\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/lib/model/opcua/NodeId.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 296, "kind": "variable", "name": "Type", "memberof": "src/lib/model/opcua/NodeId.js", "static": true, "longname": "src/lib/model/opcua/NodeId.js~Type", "access": "public", "export": false, "importPath": "atscm/src/lib/model/opcua/NodeId.js", "importStyle": null, "description": "OPC-UA node id types.", "lineNumber": 8, "type": { "nullable": null, "types": [ "Map" ], "spread": false, "description": null }, "ignore": true }, { "__docId__": 297, "kind": "variable", "name": "TypeForIdentifier", "memberof": "src/lib/model/opcua/NodeId.js", "static": true, "longname": "src/lib/model/opcua/NodeId.js~TypeForIdentifier", "access": "public", "export": false, "importPath": "atscm/src/lib/model/opcua/NodeId.js", "importStyle": null, "description": "OPC-UA node id types mapped against node-id identifiers (e.g. i, s ...).", "lineNumber": 14, "type": { "nullable": null, "types": [ "Map" ], "spread": false, "description": null }, "ignore": true }, { "__docId__": 298, "kind": "variable", "name": "possibleResourceChildNodes", "memberof": "src/lib/model/opcua/NodeId.js", "static": true, "longname": "src/lib/model/opcua/NodeId.js~possibleResourceChildNodes", "access": "public", "export": false, "importPath": "atscm/src/lib/model/opcua/NodeId.js", "importStyle": null, "description": "Resource nodes are only allowed to have these child nodes.", "lineNumber": 25, "type": { "nullable": null, "types": [ "Set" ], "spread": false, "description": null }, "ignore": true }, { "__docId__": 299, "kind": "class", "name": "NodeId", "memberof": "src/lib/model/opcua/NodeId.js", "static": true, "longname": "src/lib/model/opcua/NodeId.js~NodeId", "access": "public", "export": true, "importPath": "atscm/src/lib/model/opcua/NodeId.js", "importStyle": "NodeId", "description": "A wrapper around {@link node-opcua~NodeId}.", "lineNumber": 30, "interface": false, "extends": [ "node-opcua/lib/datamodel/nodeid~OpcNodeId" ] }, { "__docId__": 300, "kind": "constructor", "name": "constructor", "memberof": "src/lib/model/opcua/NodeId.js~NodeId", "generator": false, "async": false, "static": false, "longname": "src/lib/model/opcua/NodeId.js~NodeId#constructor", "access": "public", "description": "Creates a new NodeId. Can be called in multiple ways:\n - with a {@link node-opcua~NodeIdType}, a value and a namespace (defaults to 0),\n - with a value only (type will be taken from it, namespace defaults to 1) or\n - with a {@link NodeId}s string representation (for example `ns=1;s=AGENT.DISPLAYS`).", "lineNumber": 40, "params": [ { "nullable": null, "types": [ "node-opcua~NodeIdType", "string", "number" ], "spread": false, "optional": false, "name": "typeOrValue", "description": "The type or value to use." }, { "nullable": null, "types": [ "number", "string" ], "spread": false, "optional": true, "name": "value", "description": "The value to use." }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": true, "defaultValue": "1", "defaultRaw": 1, "name": "namespace", "description": "The namespace to use." } ] }, { "__docId__": 301, "kind": "method", "name": "fromFilePath", "memberof": "src/lib/model/opcua/NodeId.js~NodeId", "generator": false, "async": false, "static": true, "longname": "src/lib/model/opcua/NodeId.js~NodeId.fromFilePath", "access": "public", "description": "Creates a new NodeId based on a file path.", "lineNumber": 71, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "path", "description": "The file path to use." } ], "return": { "nullable": null, "types": [ "NodeId" ], "spread": false, "description": "The resulting NodeId." } }, { "__docId__": 302, "kind": "get", "name": "filePath", "memberof": "src/lib/model/opcua/NodeId.js~NodeId", "generator": false, "async": false, "static": false, "longname": "src/lib/model/opcua/NodeId.js~NodeId#filePath", "access": "public", "description": "The node id's value, encoded to a file path.", "lineNumber": 93, "type": { "nullable": null, "types": [ "string" ], "spread": false, "description": null } }, { "__docId__": 303, "kind": "get", "name": "_lastSeparator", "memberof": "src/lib/model/opcua/NodeId.js~NodeId", "generator": false, "async": false, "static": false, "longname": "src/lib/model/opcua/NodeId.js~NodeId#_lastSeparator", "access": "private", "description": "Returns the last separator in a string node id's path, e.g.:\n- `'/'` for `ns=1;SYSTEM.LIBRARY.RESOURCES/index.htm`,\n- `'.'` for `ns=1;AGENT.DISPLAYS.Main`.", "lineNumber": 108, "type": { "nullable": true, "types": [ "string" ], "spread": false, "description": null } }, { "__docId__": 304, "kind": "get", "name": "parent", "memberof": "src/lib/model/opcua/NodeId.js~NodeId", "generator": false, "async": false, "static": false, "longname": "src/lib/model/opcua/NodeId.js~NodeId#parent", "access": "public", "description": "The parent node id, or `null`.", "lineNumber": 122, "deprecated": "Doesn't work properly in some edge cases. Use AtviseFile#parentNodeId instead\nwhenever possible.", "type": { "nullable": true, "types": [ "NodeId" ], "spread": false, "description": null } }, { "__docId__": 305, "kind": "method", "name": "isChildOf", "memberof": "src/lib/model/opcua/NodeId.js~NodeId", "generator": false, "async": false, "static": false, "longname": "src/lib/model/opcua/NodeId.js~NodeId#isChildOf", "access": "public", "description": "Checks if the node is a child of another.", "lineNumber": 156, "params": [ { "nullable": null, "types": [ "NodeId" ], "spread": false, "optional": false, "name": "parent", "description": "The possible parent to check." } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "`true` if *this* is a child node of *parent*." } }, { "__docId__": 306, "kind": "get", "name": "browseName", "memberof": "src/lib/model/opcua/NodeId.js~NodeId", "generator": false, "async": false, "static": false, "longname": "src/lib/model/opcua/NodeId.js~NodeId#browseName", "access": "public", "description": "The node id's browsename as string.", "lineNumber": 182, "type": { "nullable": null, "types": [ "string" ], "spread": false, "description": null } }, { "__docId__": 307, "kind": "method", "name": "inspect", "memberof": "src/lib/model/opcua/NodeId.js~NodeId", "generator": false, "async": false, "static": false, "longname": "src/lib/model/opcua/NodeId.js~NodeId#inspect", "access": "public", "description": "Returns a string in the format \"namespace value\" that is printed when inspecting the NodeId\nusing {@link util~inspect}.", "see": [ "https://nodejs.org/api/util.html#util_util_inspect_object_options" ], "lineNumber": 198, "params": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "depth", "description": "The depth to inspect." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options", "description": "The options to use." } ], "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "A string in the format \"namespace value\"." } }, { "__docId__": 308, "kind": "file", "name": "src/lib/model/opcua/ReverseReferenceTypeIds.js", "content": "import { ReferenceTypeIds } from 'node-opcua/lib/opcua_node_ids';\nimport { reverse } from '../../helpers/Object';\n\n/**\n * Reverse map of {@link node-opcua~ReferenceTypeId}s.\n * @type {Map `\\\\${c}`).join('|')})`,\n 'g'\n);\n\n/**\n * Returns a string with all special regular expression characters escaped.\n * @param source The string to escape.\n */\nexport function escapeForRegExp(source: string) {\n return source.replace(specialCharsRegExp, '\\\\$1');\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/lib/regexp.ts", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 311, "kind": "variable", "name": "specialChars", "memberof": "src/lib/regexp.ts", "static": true, "longname": "src/lib/regexp.ts~specialChars", "access": "public", "export": true, "importPath": "atscm/src/lib/regexp.ts", "importStyle": "{specialChars}", "description": "Special characters in regular expressions.", "lineNumber": 2, "type": { "types": [ "string[]" ] } }, { "__docId__": 312, "kind": "variable", "name": "specialCharsRegExp", "memberof": "src/lib/regexp.ts", "static": true, "longname": "src/lib/regexp.ts~specialCharsRegExp", "access": "public", "export": true, "importPath": "atscm/src/lib/regexp.ts", "importStyle": "{specialCharsRegExp}", "description": "A regular expression that matches all special characters in regular expressions.", "lineNumber": 4, "type": { "types": [ "*" ] } }, { "__docId__": 313, "kind": "function", "name": "escapeForRegExp", "memberof": "src/lib/regexp.ts", "generator": false, "async": false, "static": true, "longname": "src/lib/regexp.ts~escapeForRegExp", "access": "public", "export": true, "importPath": "atscm/src/lib/regexp.ts", "importStyle": "{escapeForRegExp}", "description": "Returns a string with all special regular expression characters escaped.", "lineNumber": 14, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "source", "description": "" } ], "return": { "types": [ "*" ] } }, { "__docId__": 314, "kind": "file", "name": "src/lib/server/AddReferencesStream.js", "content": "import { DataType } from 'node-opcua/lib/datamodel/variant';\nimport { StatusCodes } from 'node-opcua/lib/datamodel/opcua_status_code';\nimport NodeId from '../model/opcua/NodeId';\nimport { ReferenceTypeIds } from '../model/Node';\nimport Atviseproject from '../config/Atviseproject';\nimport CallScriptStream from './scripts/CallScriptStream';\nimport { waitForDependencies } from './WaitingStream';\n\nconst serverNodes = new Set(Atviseproject.ServerRelatedNodes.map((id) => id.value));\n\nconst ignoredReferences = new Set([\n ReferenceTypeIds.toParent,\n ReferenceTypeIds.HasTypeDefinition,\n ReferenceTypeIds.HasModellingRule,\n]);\n\n/**\n * A stream that adds non-standard references to nodes when pushed.\n */\nexport default class AddReferencesStream extends waitForDependencies(CallScriptStream) {\n /**\n * Creates a new stream for adding references to pushed nodes.\n * @param {Object} options The options to pass to the {@link CallScriptStream}.\n */\n constructor(options) {\n super(options);\n\n /**\n * A stack of {@link NodeId#value}s to be retried afterwards.\n * @type {Set}\n */\n this._retry = new Set();\n }\n\n /**\n * Returns the references that need to be set for a file.\n * @param {AtviseFile} file The file to check.\n * @return {Object} The files's references.\n */\n referencesToAdd(file) {\n const additionalReferences = Object.assign({}, file.references);\n delete additionalReferences.toParent;\n delete additionalReferences.HasTypeDefinition;\n delete additionalReferences.HasModellingRule;\n\n return additionalReferences;\n }\n\n /**\n * Returns the referenced nodes that should be processed before the given file.\n * @param {AtviseFile} file The file to check.\n * @return {NodeId[]} The files dependencies.\n */\n dependenciesFor(file) {\n const refs = this.referencesToAdd(file);\n\n return Object.values(refs)\n .reduce((deps, nodes) => deps.concat(nodes), [])\n .filter(({ value }) => !serverNodes.has(value));\n }\n\n /**\n * Id of the *CreateNode* script added with `atscm import`.\n * @type {NodeId}\n */\n get scriptId() {\n return new NodeId(\n NodeId.NodeIdType.STRING,\n 'SYSTEM.LIBRARY.ATVISE.SERVERSCRIPTS.atscm.AddReferences',\n 1\n );\n }\n\n /**\n * The options required to add references to the node for the given file.\n * @param {AtviseFile} file The processed file.\n * @return {Object} The options passed to the *AddReferences* script.\n */\n scriptParameters(file) {\n const references = [...file.references].reduce((result, [key, value]) => {\n if (ignoredReferences.has(key)) {\n return result;\n }\n\n return Object.assign(result, {\n [key]: [...value].map((s) => (typeof s === 'string' ? `ns=1;s=${s}` : s)),\n });\n }, {});\n\n const referenceKeys = Object.keys(references);\n\n if (referenceKeys.length > 0) {\n return {\n paramObjString: {\n dataType: DataType.String,\n value: JSON.stringify({\n nodeId: file.nodeId,\n references: referenceKeys.map((type) => ({\n referenceIdValue: parseInt(type, 10),\n items: references[type],\n })),\n }),\n },\n };\n }\n\n // No need to add references\n return null;\n }\n\n /**\n * Prints an error message telling that adding one or more references failed.\n * @param {AtviseFile} file The file who's node could not be created.\n * @return {string} The resulting error message.\n */\n processErrorMessage(file) {\n return `Error adding references to node ${file.nodeId}`;\n }\n\n /**\n * Handles the results of a script call.\n * @param {AtviseFile} file The file the script was called with.\n * @param {node-opcua~Variant[]} outArgs The raw method results.\n * @param {function(err: Error)} callback Called once finished.\n */\n handleOutputArguments(file, outArgs, callback) {\n if (outArgs[0].value !== StatusCodes.Good) {\n callback(new Error(outArgs[1].value));\n } else {\n const [{ value: failures }] = outArgs[3].value;\n\n if (failures && failures.length) {\n const retryKey = file.nodeId.value;\n\n if (this._retry.has(retryKey)) {\n this._retry.delete(retryKey);\n callback(new Error(`Failed to create references to ${failures.join(', ')}`));\n } else {\n this._retry.add(retryKey);\n callback(null);\n\n this.once('drained', () => {\n this.write(file);\n });\n }\n\n return;\n }\n\n callback(null);\n }\n }\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/lib/server/AddReferencesStream.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 315, "kind": "variable", "name": "serverNodes", "memberof": "src/lib/server/AddReferencesStream.js", "static": true, "longname": "src/lib/server/AddReferencesStream.js~serverNodes", "access": "public", "export": false, "importPath": "atscm/src/lib/server/AddReferencesStream.js", "importStyle": null, "description": null, "lineNumber": 9, "undocument": true, "type": { "types": [ "*" ] }, "ignore": true }, { "__docId__": 316, "kind": "variable", "name": "ignoredReferences", "memberof": "src/lib/server/AddReferencesStream.js", "static": true, "longname": "src/lib/server/AddReferencesStream.js~ignoredReferences", "access": "public", "export": false, "importPath": "atscm/src/lib/server/AddReferencesStream.js", "importStyle": null, "description": null, "lineNumber": 11, "undocument": true, "type": { "types": [ "*" ] }, "ignore": true }, { "__docId__": 317, "kind": "class", "name": "AddReferencesStream", "memberof": "src/lib/server/AddReferencesStream.js", "static": true, "longname": "src/lib/server/AddReferencesStream.js~AddReferencesStream", "access": "public", "export": true, "importPath": "atscm/src/lib/server/AddReferencesStream.js", "importStyle": "AddReferencesStream", "description": "A stream that adds non-standard references to nodes when pushed.", "lineNumber": 20, "interface": false, "expressionExtends": "waitForDependencies(CallScriptStream)" }, { "__docId__": 318, "kind": "constructor", "name": "constructor", "memberof": "src/lib/server/AddReferencesStream.js~AddReferencesStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/AddReferencesStream.js~AddReferencesStream#constructor", "access": "public", "description": "Creates a new stream for adding references to pushed nodes.", "lineNumber": 25, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options", "description": "The options to pass to the {@link CallScriptStream}." } ] }, { "__docId__": 319, "kind": "member", "name": "_retry", "memberof": "src/lib/server/AddReferencesStream.js~AddReferencesStream", "static": false, "longname": "src/lib/server/AddReferencesStream.js~AddReferencesStream#_retry", "access": "private", "description": "A stack of {@link NodeId#value}s to be retried afterwards.", "lineNumber": 32, "type": { "nullable": null, "types": [ "Set" ], "spread": false, "description": null } }, { "__docId__": 320, "kind": "method", "name": "referencesToAdd", "memberof": "src/lib/server/AddReferencesStream.js~AddReferencesStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/AddReferencesStream.js~AddReferencesStream#referencesToAdd", "access": "public", "description": "Returns the references that need to be set for a file.", "lineNumber": 40, "params": [ { "nullable": null, "types": [ "AtviseFile" ], "spread": false, "optional": false, "name": "file", "description": "The file to check." } ], "return": { "nullable": null, "types": [ "Object" ], "spread": false, "description": "The files's references." } }, { "__docId__": 321, "kind": "method", "name": "dependenciesFor", "memberof": "src/lib/server/AddReferencesStream.js~AddReferencesStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/AddReferencesStream.js~AddReferencesStream#dependenciesFor", "access": "public", "description": "Returns the referenced nodes that should be processed before the given file.", "lineNumber": 54, "params": [ { "nullable": null, "types": [ "AtviseFile" ], "spread": false, "optional": false, "name": "file", "description": "The file to check." } ], "return": { "nullable": null, "types": [ "NodeId[]" ], "spread": false, "description": "The files dependencies." } }, { "__docId__": 322, "kind": "get", "name": "scriptId", "memberof": "src/lib/server/AddReferencesStream.js~AddReferencesStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/AddReferencesStream.js~AddReferencesStream#scriptId", "access": "public", "description": "Id of the *CreateNode* script added with `atscm import`.", "lineNumber": 66, "type": { "nullable": null, "types": [ "NodeId" ], "spread": false, "description": null } }, { "__docId__": 323, "kind": "method", "name": "scriptParameters", "memberof": "src/lib/server/AddReferencesStream.js~AddReferencesStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/AddReferencesStream.js~AddReferencesStream#scriptParameters", "access": "public", "description": "The options required to add references to the node for the given file.", "lineNumber": 79, "params": [ { "nullable": null, "types": [ "AtviseFile" ], "spread": false, "optional": false, "name": "file", "description": "The processed file." } ], "return": { "nullable": null, "types": [ "Object" ], "spread": false, "description": "The options passed to the *AddReferences* script." } }, { "__docId__": 324, "kind": "method", "name": "processErrorMessage", "memberof": "src/lib/server/AddReferencesStream.js~AddReferencesStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/AddReferencesStream.js~AddReferencesStream#processErrorMessage", "access": "public", "description": "Prints an error message telling that adding one or more references failed.", "lineNumber": 116, "params": [ { "nullable": null, "types": [ "AtviseFile" ], "spread": false, "optional": false, "name": "file", "description": "The file who's node could not be created." } ], "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "The resulting error message." } }, { "__docId__": 325, "kind": "method", "name": "handleOutputArguments", "memberof": "src/lib/server/AddReferencesStream.js~AddReferencesStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/AddReferencesStream.js~AddReferencesStream#handleOutputArguments", "access": "public", "description": "Handles the results of a script call.", "lineNumber": 126, "params": [ { "nullable": null, "types": [ "AtviseFile" ], "spread": false, "optional": false, "name": "file", "description": "The file the script was called with." }, { "nullable": null, "types": [ "node-opcua~Variant[]" ], "spread": false, "optional": false, "name": "outArgs", "description": "The raw method results." }, { "nullable": null, "types": [ "function(err: Error)" ], "spread": false, "optional": false, "name": "callback", "description": "Called once finished." } ], "return": null }, { "__docId__": 326, "kind": "file", "name": "src/lib/server/AtviseFile.js", "content": "import { readFile } from 'fs';\nimport { dirname } from 'path';\nimport { NodeClass } from 'node-opcua/lib/datamodel/nodeclass';\nimport { DataType, VariantArrayType, Variant } from 'node-opcua/lib/datamodel/variant';\nimport { resolveNodeId } from 'node-opcua/lib/datamodel/nodeid';\nimport { LocalizedText } from 'node-opcua/lib/datamodel/localized_text';\nimport { StatusCodes } from 'node-opcua/lib/datamodel/opcua_status_code';\nimport { QualifiedName } from 'node-opcua/lib/datamodel/qualified_name';\nimport { DataValue } from 'node-opcua/lib/datamodel/datavalue';\nimport { ReferenceTypeIds } from 'node-opcua/lib/opcua_node_ids';\nimport { ExpandedNodeId } from 'node-opcua/lib/datamodel/expanded_nodeid';\nimport { DiagnosticInfo } from 'node-opcua/lib/datamodel/diagnostic_info';\nimport File from 'vinyl';\nimport NodeId from '../model/opcua/NodeId';\nimport { reverse, pick } from '../helpers/Object';\nimport { sortReferences } from '../helpers/mapping';\nimport AtviseTypes, { AtviseResourceType } from './Types';\n\n/**\n * A map of AtviseTypes against their definition id's value.\n * @type {Map}\n */\nconst AtviseTypesByValue = AtviseTypes.reduce(\n (result, type) =>\n Object.assign(result, {\n [type.typeDefinition.value]: type,\n }),\n {}\n);\n\n/**\n * A map of AtviseTypes against their identifiers.\n * @type {Map}\n */\nconst AtviseTypesByIdentifier = AtviseTypes.reduce(\n (result, type) =>\n Object.assign(result, {\n [type.identifier]: type,\n }),\n {}\n);\n\n/**\n * A map providing shorter extensions for data types\n * @type {Map}\n */\nexport const ExtensionForDataType = {\n [DataType.Boolean]: 'bool',\n [DataType.XmlElement]: 'xml',\n};\n\n/**\n * A map providing data types for shorter extensions (Reverse of {@link DataTypeForExtension}).\n * * @type {Map}\n */\nexport const DataTypeForExtension = reverse(ExtensionForDataType);\n\n// Cache DataType\n/**\n * OPC-UA data type names.\n * @type {String[]}\n */\nconst types = Object.keys(DataType);\n\n/**\n * OPC-UA data type extensions.\n * @type {String[]}\n */\nconst typeExtensions = types.map((t) => t.toLowerCase());\n\n// Cache TypeDefinitions\n/**\n * Variable data type definition node id.\n * @type {NodeId}\n */\nconst VariableTypeDefinition = new NodeId(NodeId.NodeIdType.NUMERIC, 62, 0);\n/**\n * Property data type definition node id.\n * @type {NodeId}\n */\nconst PropertyTypeDefinition = new NodeId(NodeId.NodeIdType.NUMERIC, 68, 0);\n\n// Cache Regular expressions\n/**\n * A regular expression picking file extensions from file names.\n * @type {RegExp}\n */\nconst ExtensionRegExp = /\\.([^/\\\\]*)$/;\n\n/**\n * Function that returns the passed argument as is.\n * @param {*} b The input argument.\n * @return {*} The value passed.\n */\nconst asIs = (b) => b;\n\n/**\n * Maps a single property of an object using the the mapper defined in *map* for the given\n * *dataType*.\n * @param {Map {\n if (obj[key]) {\n return Object.assign(obj, {\n [key]: map[dataType](obj[key]),\n });\n }\n\n return obj;\n};\n\n/**\n * Mapping functions that return serializable values for a node of the given\n * {@link node-opcua~DataType}.\n * @type {Map}\n */\nconst toRawValue = {\n [DataType.Null]: () => null,\n [DataType.StatusCode]: ({ name }) => name,\n [DataType.QualifiedName]: ({ namespaceIndex, name }) => ({ namespaceIndex, name }),\n [DataType.LocalizedText]: ({ text, locale }) => ({ text, locale }),\n [DataType.DataValue]: (value) => {\n const options = pick(value, [\n 'value',\n 'statusCode',\n 'sourceTimestamp',\n 'sourcePicoseconds',\n 'serverTimestamp',\n 'serverPicoseconds',\n ]);\n\n mapPropertyAs(toRawValue, options, 'value', DataType.Variant);\n mapPropertyAs(toRawValue, options, 'statusCode', DataType.StatusCode);\n // NOTE: server- and sourceTimstamps get mapped as dates\n\n return options;\n },\n [DataType.Variant]: ({ dataType, arrayType, value, dimensions }) => ({\n dataType,\n arrayType,\n // eslint-disable-next-line no-use-before-define\n value: getRawValue(value, dataType, arrayType),\n dimensions,\n }),\n [DataType.DiagnosticInfo]: (info) => {\n const options = pick(info, [\n 'namespaceUri',\n 'symbolicId',\n 'locale',\n 'localizedText',\n 'additionalInfo',\n 'innerStatusCode',\n 'innerDiagnosticInfo',\n ]);\n\n mapPropertyAs(toRawValue, options, 'innerStatusCode', DataType.StatusCode);\n mapPropertyAs(toRawValue, options, 'innerDiagnosticInfo', DataType.DiagnosticInfo);\n\n return options;\n },\n};\n\n/**\n * Decodes a buffer to a string.\n * @param {Buffer} b The buffer to decode from.\n * @return {string} The buffer's string representation.\n */\nconst decodeAsString = (b) => b.toString().trim();\n\n/**\n * Decodes a buffer to an integer value.\n * @param {Buffer} b The buffer to decode from.\n * @return {number} The decoded integer.\n */\nconst decodeAsInt = (b) => parseInt(decodeAsString(b), 10);\n\n/**\n * Decodes a buffer to a float value.\n * @param {Buffer} b The buffer to decode from.\n * @return {number} The decoded float.\n */\nconst decodeAsFloat = (b) => parseFloat(decodeAsString(b));\n\n/**\n * Decodes a buffer using JSON.\n * @param {Buffer} b The buffer to decode from.\n * @return {*} The decoded value, most likely an Object.\n */\nconst decodeAsJson = (b) => JSON.parse(b.toString());\n\n/**\n * Mapping functions that return raw values for a stored value of the given type.\n * @type {Map}\n */\nconst decodeRawValue = {\n [DataType.Null]: () => null,\n [DataType.Boolean]: (b) => decodeAsString(b) === 'true',\n [DataType.SByte]: decodeAsInt,\n [DataType.Byte]: decodeAsInt,\n [DataType.Int16]: decodeAsInt,\n [DataType.UInt16]: decodeAsInt,\n [DataType.Int32]: decodeAsInt,\n [DataType.UInt32]: decodeAsInt,\n [DataType.Int64]: decodeAsJson,\n [DataType.UInt64]: decodeAsJson,\n [DataType.Float]: decodeAsFloat,\n [DataType.Double]: decodeAsFloat,\n [DataType.String]: decodeAsString,\n [DataType.DateTime]: decodeAsString,\n [DataType.Guid]: decodeAsString,\n // ByteString maps to Buffer\n [DataType.XmlElement]: decodeAsString,\n [DataType.NodeId]: decodeAsString,\n [DataType.ExpandedNodeId]: decodeAsString,\n [DataType.StatusCode]: decodeAsString,\n [DataType.QualifiedName]: decodeAsJson,\n [DataType.LocalizedText]: decodeAsJson,\n // FIXME: Add ExtensionObject\n [DataType.DataValue]: decodeAsJson,\n [DataType.Variant]: decodeAsJson,\n [DataType.DiagnosticInfo]: decodeAsJson,\n};\n\n/**\n * Mapping functions that return OPC-UA node values for raw values.\n * @type {Map}\n */\nconst toNodeValue = {\n [DataType.DateTime]: (s) => new Date(s),\n [DataType.ByteString]: (b) => {\n if (b instanceof Buffer) {\n return b;\n }\n\n return Buffer.from(b.data, 'binary');\n },\n [DataType.NodeId]: (s) => resolveNodeId(s),\n\n // Jep, node-opcua does not provide a resolve function for expanded nodeids\n [DataType.ExpandedNodeId]: (s) => {\n const nodeId = resolveNodeId(s);\n const [value, ...defs] = nodeId.value.split(';');\n\n const { identifierType, namespace, namespaceUri, serverIndex } = defs.reduce((opts, def) => {\n const match = def.match(/^([^:]+):(.*)/);\n if (!match) {\n return opts;\n }\n\n let [key, val] = match.slice(1); // eslint-disable-line prefer-const\n\n if (key === 'serverIndex') {\n val = parseInt(val, 10);\n }\n\n return Object.assign(opts, { [key]: val });\n }, Object.assign({}, nodeId));\n\n return new ExpandedNodeId(identifierType, value, namespace, namespaceUri, serverIndex);\n },\n\n [DataType.StatusCode]: (name) => StatusCodes[name],\n [DataType.QualifiedName]: (options) => new QualifiedName(options),\n [DataType.LocalizedText]: (options) => new LocalizedText(options),\n [DataType.DataValue]: (options) => {\n const opts = options;\n\n mapPropertyAs(toNodeValue, opts, 'value', DataType.Variant);\n mapPropertyAs(toNodeValue, opts, 'statusCode', DataType.StatusCode);\n mapPropertyAs(toNodeValue, opts, 'sourceTimestamp', DataType.DateTime);\n mapPropertyAs(toNodeValue, opts, 'serverTimestamp', DataType.DateTime);\n\n return new DataValue(opts);\n },\n [DataType.Variant]: ({ dataType, arrayType, value, dimensions }) =>\n new Variant({\n dataType,\n arrayType: VariantArrayType[arrayType],\n value,\n dimensions,\n }),\n [DataType.DiagnosticInfo]: (options) => {\n const opts = options;\n\n mapPropertyAs(toNodeValue, opts, 'innerStatusCode', DataType.StatusCode);\n mapPropertyAs(toNodeValue, opts, 'innerDiagnosticInfo', DataType.DiagnosticInfo);\n\n return new DiagnosticInfo(opts);\n },\n};\n\n/**\n * Returns a node's raw value based on it's OPC-UA value and type.\n * @param {*} value A node's OPC-UA value.\n * @param {node-opcua~DataType} dataType The node's data type.\n * @param {node-opcua~VariantArrayType} arrayType The node's array type.\n * @return {*} The raw value of the given node.\n */\nconst getRawValue = (value, dataType, arrayType) => {\n if (arrayType.value !== VariantArrayType.Scalar.value) {\n const array = Array.isArray(value) ? value : Array.from(value);\n\n return array.map((val) => getRawValue(val, dataType, VariantArrayType[arrayType.value - 1]));\n }\n\n return (toRawValue[dataType] || asIs)(value);\n};\n\n/**\n * Returns a node's OPC-UA value based on it's raw value and type.\n * @param {*} rawValue A node's raw value.\n * @param {node-opcua~DataType} dataType A node's data type.\n * @param {node-opcua~VariantArrayType} arrayType A node's array type.\n */\nconst getNodeValue = (rawValue, dataType, arrayType) => {\n if (arrayType.value !== VariantArrayType.Scalar.value) {\n if (!Array.isArray(rawValue)) {\n throw new Error('Value is not an array');\n }\n\n return rawValue.map((raw) =>\n getNodeValue(raw, dataType, VariantArrayType[arrayType.value - 1])\n );\n }\n\n return (toNodeValue[dataType] || asIs)(rawValue);\n};\n\n/**\n * Returns the extension for a specific {@link node-opcua~DataType}.\n * Algorithm:\n * - if the type has a shortened extension defined in {@link ExtensionForDataType}, return it.\n * - else return the DataType's name, in lowercase letters.\n * @param {node-opcua~DataType} dataType The datatype to get the extension for.\n * @return {string} The resulting extension.\n */\nfunction extensionForDataType(dataType) {\n return ExtensionForDataType[dataType] || dataType.toString().toLowerCase();\n}\n\n/**\n * A regular expression that maches all reference definition files.\n * @type {RegExp}\n */\nconst ConfigFileRegexp = /^\\.((Object|Variable)(Type)?|Method|View|(Reference|Data)Type)\\.json$/;\n\n/**\n * An extension to {@link vinyl~File} providing some additional, atvise-related properties.\n * @property {node-opcua~DataType} AtviseFile#dataType The {@link node-opcua~DataType} the node is\n * stored against on atvise server.\n * @property {NodeId} typeDefinition The file's type definition on atvise server.\n * FIXME: Additional properties not showing in API docs.\n */\nexport default class AtviseFile extends File {\n /**\n * Returns a storage path for a {@link ReadStream.ReadResult}.\n * @param {ReadStream.ReadResult} readResult The read result to get a path for.\n */\n static pathForReadResult(readResult) {\n let path = readResult.nodeId.filePath;\n\n if (readResult.nodeClass.value !== NodeClass.Variable.value) {\n return `${path}/.${readResult.nodeClass.key}.json`;\n }\n\n const dataType = readResult.value.$dataType;\n const arrayType = readResult.value.$arrayType;\n const typeDefinition = readResult.references.HasTypeDefinition[0];\n\n if (typeDefinition.value === VariableTypeDefinition.value) {\n // Variable nodes are stored with their lowercase datatype as an extension\n path += `.${extensionForDataType(dataType)}`;\n } else if (typeDefinition.value === PropertyTypeDefinition.value) {\n // Property nodes are stored with \".prop\" and their lowercase datatype as an extension\n path += `.prop.${extensionForDataType(dataType)}`;\n } else {\n // Handle custom types\n let identifier = 'var';\n let fileExtension = false;\n let keepExtension = false;\n\n const atType = AtviseTypesByValue[typeDefinition.value];\n if (atType) {\n identifier = atType.identifier;\n fileExtension = atType.fileExtension;\n keepExtension = atType.keepExtension;\n }\n\n if (!keepExtension) {\n path += `.${identifier}.${fileExtension || extensionForDataType(dataType)}`;\n }\n }\n\n // Add \"array\" or \"matrix\" extensions for corresponding array types\n if (arrayType.value !== VariantArrayType.Scalar.value) {\n path += `.${arrayType === VariantArrayType.Array ? 'array' : 'matrix'}`;\n }\n\n return path;\n }\n\n /**\n * Encodes a node's value to file contents.\n * @param {*} value The value to encode.\n * @param {node-opcua~DataType} dataType The {@link node-opcua~DataType} to encode the value for.\n * @param {node-opcua~VariantArrayType} arrayType The files array type.\n * @return {?Buffer} The encoded file contents or null.\n */\n static encodeValue(value, dataType, arrayType) {\n if (value.value === null) {\n return Buffer.from('');\n }\n\n const rawValue = getRawValue(value.value, dataType, arrayType);\n\n if (rawValue instanceof Buffer) {\n return rawValue;\n }\n\n const stringify = (a) => (a.toJSON ? a.toJSON() : JSON.stringify(a, null, ' '));\n const stringified =\n typeof rawValue === 'object' ? stringify(rawValue) : rawValue.toString().trim();\n\n return Buffer.from(stringified);\n }\n\n /**\n * Decodes a file's contents to a node's value.\n * @param {Buffer} buffer The file contents to decode.\n * @param {node-opcua~DataType} dataType The {@link node-opcua~DataType} to decode the contents.\n * @param {node-opcua~VariantArrayType} arrayType The files array type.\n * @return {?*} The decoded node value or null.\n */\n static decodeValue(buffer, dataType, arrayType) {\n if (buffer === null || buffer.length === 0) {\n return null;\n }\n\n if (dataType === DataType.ByteString && arrayType === VariantArrayType.Scalar) {\n return buffer;\n }\n\n const rawValue =\n arrayType === VariantArrayType.Scalar\n ? (decodeRawValue[dataType] || asIs)(buffer)\n : JSON.parse(buffer.toString());\n\n return getNodeValue(rawValue, dataType, arrayType);\n }\n\n /**\n * As file mtimes do not support millisecond resolution these must be removed before storing\n * files.\n * @param {Date} date The original mtime.\n * @return {Date} The normalized mtime.\n */\n static normalizeMtime(date) {\n date.setMilliseconds(0);\n\n return date;\n }\n\n /**\n * Creates a new {@link AtviseFile} for the given {@link ReadStream.ReadResult}.\n * @param {ReadStream.ReadResult} readResult The read result to create the file for.\n * @return {AtviseFile} The resulting file.\n */\n static fromReadResult(readResult) {\n const { nodeClass, references, value, mtime } = readResult;\n\n if (nodeClass.value === NodeClass.Variable.value && !value) {\n throw new Error('no value');\n }\n\n return new AtviseFile({\n path: AtviseFile.pathForReadResult(readResult),\n contents: value\n ? AtviseFile.encodeValue(value, value.$dataType, value.$arrayType) // Variables\n : Buffer.from(\n JSON.stringify(\n {\n references: sortReferences(references),\n },\n null,\n ' '\n )\n ), // Objects, types, ...\n _nodeClass: nodeClass,\n _dataType: value && value.$dataType,\n _arrayType: value && value.$arrayType,\n _references: references,\n stat: { mtime: mtime ? this.normalizeMtime(mtime) : undefined },\n });\n }\n\n /**\n * Recalculates {@link AtviseFile#dataType}, {@link AtviseFile#arrayType} and\n * {@link AtviseFile#typeDefinition}. **Never call this method directly.**.\n */\n _getMetadata() {\n if (this.stem[0] === '.') {\n // Got non-variable node\n /**\n * The node's class.\n * @type {node-opcua~NodeClass}\n */\n this._nodeClass = NodeClass[this.stem.split('.')[1]];\n\n const { references = {} } = JSON.parse(this.contents.toString());\n\n /**\n * References the node holds: In most cases this will be a single entry for\n * `'HasTypeDefinition'`.\n * @type {Map}\n */\n this._references = Object.entries(references).reduce(\n (result, [type, refs]) =>\n Object.assign(result, {\n [type]: Array.isArray(refs) ? refs.map((v) => new NodeId(v)) : new NodeId(refs),\n }),\n {}\n );\n\n return;\n }\n\n this._nodeClass = NodeClass.Variable;\n\n // Set default metadata\n /**\n * The node's stored {@link node-opcua~VariantArrayType}.\n * @type {?node-opcua~VariantArrayType}\n */\n this._arrayType = VariantArrayType.Scalar;\n\n this._references = {};\n\n /**\n * A node's browse- and display name.\n * @type {?string}\n */\n this._name = this.stem.split('.')[0];\n\n let extensions = [];\n const m = this.relative.match(ExtensionRegExp);\n if (m) {\n extensions = m[1].split('.');\n }\n\n // For split files, add the directory name extension\n const dirnameExts = this.dirname.split('.');\n if (dirnameExts.length > 1) {\n extensions.unshift(dirnameExts[dirnameExts.length - 1]);\n }\n\n function ifLastExtensionMatches(matches, fn) {\n if (matches(extensions[extensions.length - 1])) {\n fn(extensions.pop());\n }\n }\n\n const complete = () =>\n this._dataType !== undefined && this._references.HasTypeDefinition !== undefined;\n\n // Handle array types\n ifLastExtensionMatches(\n (ext) => ext === 'array',\n () => {\n this._arrayType = VariantArrayType.Array;\n }\n );\n\n ifLastExtensionMatches(\n (ext) => ext === 'matrix',\n () => {\n this._arrayType = VariantArrayType.Matrix;\n }\n );\n\n ifLastExtensionMatches(\n (ext) => typeExtensions.includes(ext),\n (ext) => {\n /**\n * The node's stored {@link node-opcua~DataType}.\n * @type {?node-opcua~DataType}\n */\n this._dataType = DataType[types[typeExtensions.indexOf(ext)]];\n }\n );\n\n // Handle wrapped data types (e.g. \"bool\" for DataType.Boolean)\n ifLastExtensionMatches(\n (ext) => DataTypeForExtension[ext],\n (ext) => {\n this._dataType = DataType[DataTypeForExtension[ext]];\n }\n );\n\n if (extensions.length === 0) {\n // Got variable\n /**\n * The node's stored type definition.\n * @type {?node-opcua~NodeId}\n */\n this._references.HasTypeDefinition = [new NodeId(NodeId.NodeIdType.NUMERIC, 62, 0)];\n }\n\n ifLastExtensionMatches(\n (ext) => ext === 'prop',\n () => {\n this._references.HasTypeDefinition = [new NodeId(NodeId.NodeIdType.NUMERIC, 68, 0)];\n this._references.toParent = ReferenceTypeIds.HasProperty;\n }\n );\n\n ifLastExtensionMatches(\n (ext) => ext === 'var',\n () => {\n this._references.HasTypeDefinition = [new NodeId('Custom.VarResourceType')];\n }\n );\n\n if (!complete()) {\n // Handle atvise types\n let foundAtType = false;\n\n Object.entries(AtviseTypesByIdentifier).forEach(([identifier, type]) => {\n if (!foundAtType && extensions.includes(identifier)) {\n foundAtType = true;\n\n if (!(type instanceof AtviseResourceType)) {\n extensions = extensions.filter((e) => e !== identifier);\n }\n\n this._references.HasTypeDefinition = [type.typeDefinition];\n this._dataType = type.dataType;\n }\n });\n }\n\n if (!complete()) {\n this._references.HasTypeDefinition = [\n new NodeId('VariableTypes.ATVISE.Resource.OctetStream'),\n ];\n this._dataType = DataType.ByteString;\n }\n\n this._name = [this._name, ...extensions.filter((e) => !dirnameExts.includes(e))].join('.');\n }\n\n /**\n * Computes a file's metadata if needed.\n * @return {AtviseFile} The file.\n */\n getMetadata() {\n if (!this._nodeClass) {\n this._getMetadata();\n }\n\n return this;\n }\n\n /**\n * The node's class.\n * @type {node-opcua~NodeClass}\n */\n get nodeClass() {\n if (!this._nodeClass) {\n this._getMetadata();\n }\n\n return this._nodeClass;\n }\n\n /**\n * The file's {@link node-opcua~DataType}.\n * @type {node-opcua~DataType}\n */\n get dataType() {\n if (!this._dataType) {\n this._getMetadata();\n }\n\n return this._dataType;\n }\n\n /**\n * The file's {@link node-opcua~VariantArrayType}.\n * @type {node-opcua~VariantArrayType}\n */\n get arrayType() {\n if (!this._arrayType) {\n this._getMetadata();\n }\n\n return this._arrayType;\n }\n\n /**\n * The files's references.\n * @type {Map}\n */\n get references() {\n if (!this._references) {\n this._getMetadata();\n }\n\n return this._references;\n }\n\n /**\n * The file's type definition.\n * @type {node-opcua~NodeId}\n */\n get typeDefinition() {\n const refs = this.references;\n\n if (refs && refs.HasTypeDefinition) {\n return refs.HasTypeDefinition[0];\n }\n\n return new NodeId(NodeId.NodeIdType.NUMERIC, 0, 0);\n }\n\n // eslint-disable-next-line jsdoc/require-description-complete-sentence\n /**\n * `true` for reference config files (for example `.index.htm.json`).\n * @type {boolean}\n */\n get isReferenceConfig() {\n return this.stem[0] === '.' && !this.stem.match(ConfigFileRegexp);\n }\n\n /**\n * `true` for files containing atvise displays.\n * @type {boolean}\n */\n get isDisplay() {\n return this.typeDefinition.value === 'VariableTypes.ATVISE.Display';\n }\n\n /**\n * `true` for files containing atvise scripts.\n * @type {boolean}\n */\n get isScript() {\n return this.typeDefinition.value === 'VariableTypes.ATVISE.ScriptCode';\n }\n\n /**\n * `true` for files containing atvise quick dynamics.\n * @type {boolean}\n */\n get isQuickDynamic() {\n return this.typeDefinition.value === 'VariableTypes.ATVISE.QuickDynamic';\n }\n\n /**\n * Sets the node value for the file.\n * @param {?*} newValue The value to set.\n */\n set value(newValue) {\n /**\n * The file's contents.\n * @type {?Buffer}\n */\n this.contents = AtviseFile.encodeValue(newValue, this.dataType, this.arrayType);\n }\n\n /**\n * Returns the decoded node value for the file.\n * @type {?*} The file's decoded value.\n */\n get value() {\n return AtviseFile.decodeValue(this.contents, this.dataType, this.arrayType);\n }\n\n /**\n * Returns the decoded node value for create node serverscript.\n * @type {?*} The file's decoded value.\n */\n get createNodeValue() {\n const value = this.value;\n\n if (this.dataType === DataType.DateTime) {\n return value.valueOf();\n }\n\n if (value instanceof Buffer) {\n return value.toString();\n }\n\n return value;\n }\n\n /**\n * Returns the node id associated with the file.\n * @type {NodeId} The file's node id.\n */\n get nodeId() {\n if (this.nodeClass.value !== NodeClass.Variable.value) {\n return NodeId.fromFilePath(dirname(this.relative));\n }\n const atType = AtviseTypesByValue[this.typeDefinition.value];\n let idPath = this.relative;\n\n if (!atType || !atType.keepExtension) {\n const exts = idPath.match(ExtensionRegExp)[1];\n idPath = idPath.split(`.${exts}`)[0];\n }\n\n return NodeId.fromFilePath(idPath);\n }\n\n /**\n * A file's browse and display name.\n * @type {string}\n */\n get name() {\n if (!this._name) {\n this._getMetadata();\n }\n\n return this._name;\n }\n\n /**\n * A file's parent's node id.\n * @type {NodeId}\n */\n get parentNodeId() {\n const name = this.name;\n const id = this.nodeId;\n\n if (name) {\n const parts = this.nodeId.value.split(name);\n\n if (parts.length > 1) {\n return new NodeId(id.identifierType, parts[0].slice(0, -1), id.namespaceIndex);\n }\n }\n\n return this.nodeId.parent;\n }\n\n /**\n * Returns a new file with all attributes of the current file.\n * @param {Object} options See the {@link vinyl~File} docs for all options available.\n * @return {AtviseFile} The cloned file.\n * @see https://github.com/gulpjs/vinyl#filecloneoptions\n */\n clone(options) {\n const clonedFile = super.clone(options);\n\n clonedFile._nodeClass = this._nodeClass;\n clonedFile._dataType = this._dataType;\n clonedFile._arrayType = this._arrayType;\n clonedFile._references = this._references;\n\n return clonedFile;\n }\n\n /**\n * Creates a new AtviseFile and reads it's contents.\n * @param {Object} options See {@link vinyl~File} for available options.\n * @return {Promise} Resolved with the new file of rejected with the error that occured while\n * trying to read it's path.\n */\n static read(options = {}) {\n return new Promise((resolve, reject) => {\n if (!options.path) {\n reject(new Error('options.path is required'));\n } else {\n readFile(options.path, (err, contents) => {\n if (err) {\n reject(err);\n } else {\n resolve(new AtviseFile(Object.assign(options, { contents })));\n }\n });\n }\n });\n }\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/lib/server/AtviseFile.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 327, "kind": "variable", "name": "AtviseTypesByValue", "memberof": "src/lib/server/AtviseFile.js", "static": true, "longname": "src/lib/server/AtviseFile.js~AtviseTypesByValue", "access": "public", "export": false, "importPath": "atscm/src/lib/server/AtviseFile.js", "importStyle": null, "description": "A map of AtviseTypes against their definition id's value.", "lineNumber": 23, "type": { "nullable": null, "types": [ "Map" ], "spread": false, "description": null }, "ignore": true }, { "__docId__": 328, "kind": "variable", "name": "AtviseTypesByIdentifier", "memberof": "src/lib/server/AtviseFile.js", "static": true, "longname": "src/lib/server/AtviseFile.js~AtviseTypesByIdentifier", "access": "public", "export": false, "importPath": "atscm/src/lib/server/AtviseFile.js", "importStyle": null, "description": "A map of AtviseTypes against their identifiers.", "lineNumber": 35, "type": { "nullable": null, "types": [ "Map" ], "spread": false, "description": null }, "ignore": true }, { "__docId__": 329, "kind": "variable", "name": "ExtensionForDataType", "memberof": "src/lib/server/AtviseFile.js", "static": true, "longname": "src/lib/server/AtviseFile.js~ExtensionForDataType", "access": "public", "export": true, "importPath": "atscm/src/lib/server/AtviseFile.js", "importStyle": "{ExtensionForDataType}", "description": "A map providing shorter extensions for data types", "lineNumber": 47, "type": { "nullable": null, "types": [ "Map" ], "spread": false, "description": null } }, { "__docId__": 330, "kind": "variable", "name": "DataTypeForExtension", "memberof": "src/lib/server/AtviseFile.js", "static": true, "longname": "src/lib/server/AtviseFile.js~DataTypeForExtension", "access": "public", "export": true, "importPath": "atscm/src/lib/server/AtviseFile.js", "importStyle": "{DataTypeForExtension}", "description": "A map providing data types for shorter extensions (Reverse of {@link DataTypeForExtension}).\n* @type {Map}", "lineNumber": 56, "type": { "types": [ "*" ] } }, { "__docId__": 331, "kind": "variable", "name": "types", "memberof": "src/lib/server/AtviseFile.js", "static": true, "longname": "src/lib/server/AtviseFile.js~types", "access": "public", "export": false, "importPath": "atscm/src/lib/server/AtviseFile.js", "importStyle": null, "description": "OPC-UA data type names.", "lineNumber": 63, "type": { "nullable": null, "types": [ "String[]" ], "spread": false, "description": null }, "ignore": true }, { "__docId__": 332, "kind": "variable", "name": "typeExtensions", "memberof": "src/lib/server/AtviseFile.js", "static": true, "longname": "src/lib/server/AtviseFile.js~typeExtensions", "access": "public", "export": false, "importPath": "atscm/src/lib/server/AtviseFile.js", "importStyle": null, "description": "OPC-UA data type extensions.", "lineNumber": 69, "type": { "nullable": null, "types": [ "String[]" ], "spread": false, "description": null }, "ignore": true }, { "__docId__": 333, "kind": "variable", "name": "VariableTypeDefinition", "memberof": "src/lib/server/AtviseFile.js", "static": true, "longname": "src/lib/server/AtviseFile.js~VariableTypeDefinition", "access": "public", "export": false, "importPath": "atscm/src/lib/server/AtviseFile.js", "importStyle": null, "description": "Variable data type definition node id.", "lineNumber": 76, "type": { "nullable": null, "types": [ "NodeId" ], "spread": false, "description": null }, "ignore": true }, { "__docId__": 334, "kind": "variable", "name": "PropertyTypeDefinition", "memberof": "src/lib/server/AtviseFile.js", "static": true, "longname": "src/lib/server/AtviseFile.js~PropertyTypeDefinition", "access": "public", "export": false, "importPath": "atscm/src/lib/server/AtviseFile.js", "importStyle": null, "description": "Property data type definition node id.", "lineNumber": 81, "type": { "nullable": null, "types": [ "NodeId" ], "spread": false, "description": null }, "ignore": true }, { "__docId__": 335, "kind": "variable", "name": "ExtensionRegExp", "memberof": "src/lib/server/AtviseFile.js", "static": true, "longname": "src/lib/server/AtviseFile.js~ExtensionRegExp", "access": "public", "export": false, "importPath": "atscm/src/lib/server/AtviseFile.js", "importStyle": null, "description": "A regular expression picking file extensions from file names.", "lineNumber": 88, "type": { "nullable": null, "types": [ "RegExp" ], "spread": false, "description": null }, "ignore": true }, { "__docId__": 336, "kind": "function", "name": "asIs", "memberof": "src/lib/server/AtviseFile.js", "generator": false, "async": false, "static": true, "longname": "src/lib/server/AtviseFile.js~asIs", "access": "public", "export": false, "importPath": "atscm/src/lib/server/AtviseFile.js", "importStyle": null, "description": "Function that returns the passed argument as is.", "lineNumber": 95, "params": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "b", "description": "The input argument." } ], "return": { "nullable": null, "types": [ "*" ], "spread": false, "description": "The value passed." }, "ignore": true }, { "__docId__": 337, "kind": "function", "name": "mapPropertyAs", "memberof": "src/lib/server/AtviseFile.js", "generator": false, "async": false, "static": true, "longname": "src/lib/server/AtviseFile.js~mapPropertyAs", "access": "public", "export": false, "importPath": "atscm/src/lib/server/AtviseFile.js", "importStyle": null, "description": "Maps a single property of an object using the the mapper defined in *map* for the given\n*dataType*.", "lineNumber": 105, "params": [ { "nullable": null, "types": [ "Map" ], "spread": false, "description": null }, "ignore": true }, { "__docId__": 339, "kind": "function", "name": "decodeAsString", "memberof": "src/lib/server/AtviseFile.js", "generator": false, "async": false, "static": true, "longname": "src/lib/server/AtviseFile.js~decodeAsString", "access": "public", "export": false, "importPath": "atscm/src/lib/server/AtviseFile.js", "importStyle": null, "description": "Decodes a buffer to a string.", "lineNumber": 171, "params": [ { "nullable": null, "types": [ "Buffer" ], "spread": false, "optional": false, "name": "b", "description": "The buffer to decode from." } ], "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "The buffer's string representation." }, "ignore": true }, { "__docId__": 340, "kind": "function", "name": "decodeAsInt", "memberof": "src/lib/server/AtviseFile.js", "generator": false, "async": false, "static": true, "longname": "src/lib/server/AtviseFile.js~decodeAsInt", "access": "public", "export": false, "importPath": "atscm/src/lib/server/AtviseFile.js", "importStyle": null, "description": "Decodes a buffer to an integer value.", "lineNumber": 178, "params": [ { "nullable": null, "types": [ "Buffer" ], "spread": false, "optional": false, "name": "b", "description": "The buffer to decode from." } ], "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "The decoded integer." }, "ignore": true }, { "__docId__": 341, "kind": "function", "name": "decodeAsFloat", "memberof": "src/lib/server/AtviseFile.js", "generator": false, "async": false, "static": true, "longname": "src/lib/server/AtviseFile.js~decodeAsFloat", "access": "public", "export": false, "importPath": "atscm/src/lib/server/AtviseFile.js", "importStyle": null, "description": "Decodes a buffer to a float value.", "lineNumber": 185, "params": [ { "nullable": null, "types": [ "Buffer" ], "spread": false, "optional": false, "name": "b", "description": "The buffer to decode from." } ], "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "The decoded float." }, "ignore": true }, { "__docId__": 342, "kind": "function", "name": "decodeAsJson", "memberof": "src/lib/server/AtviseFile.js", "generator": false, "async": false, "static": true, "longname": "src/lib/server/AtviseFile.js~decodeAsJson", "access": "public", "export": false, "importPath": "atscm/src/lib/server/AtviseFile.js", "importStyle": null, "description": "Decodes a buffer using JSON.", "lineNumber": 192, "params": [ { "nullable": null, "types": [ "Buffer" ], "spread": false, "optional": false, "name": "b", "description": "The buffer to decode from." } ], "return": { "nullable": null, "types": [ "*" ], "spread": false, "description": "The decoded value, most likely an Object." }, "ignore": true }, { "__docId__": 343, "kind": "variable", "name": "decodeRawValue", "memberof": "src/lib/server/AtviseFile.js", "static": true, "longname": "src/lib/server/AtviseFile.js~decodeRawValue", "access": "public", "export": false, "importPath": "atscm/src/lib/server/AtviseFile.js", "importStyle": null, "description": "Mapping functions that return raw values for a stored value of the given type.", "lineNumber": 198, "type": { "nullable": null, "types": [ "Map" ], "spread": false, "description": null }, "ignore": true }, { "__docId__": 344, "kind": "variable", "name": "toNodeValue", "memberof": "src/lib/server/AtviseFile.js", "static": true, "longname": "src/lib/server/AtviseFile.js~toNodeValue", "access": "public", "export": false, "importPath": "atscm/src/lib/server/AtviseFile.js", "importStyle": null, "description": "Mapping functions that return OPC-UA node values for raw values.", "lineNumber": 231, "type": { "nullable": null, "types": [ "Map" ], "spread": false, "description": null }, "ignore": true }, { "__docId__": 345, "kind": "function", "name": "getRawValue", "memberof": "src/lib/server/AtviseFile.js", "generator": false, "async": false, "static": true, "longname": "src/lib/server/AtviseFile.js~getRawValue", "access": "public", "export": false, "importPath": "atscm/src/lib/server/AtviseFile.js", "importStyle": null, "description": "Returns a node's raw value based on it's OPC-UA value and type.", "lineNumber": 302, "params": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "value", "description": "A node's OPC-UA value." }, { "nullable": null, "types": [ "node-opcua~DataType" ], "spread": false, "optional": false, "name": "dataType", "description": "The node's data type." }, { "nullable": null, "types": [ "node-opcua~VariantArrayType" ], "spread": false, "optional": false, "name": "arrayType", "description": "The node's array type." } ], "return": { "nullable": null, "types": [ "*" ], "spread": false, "description": "The raw value of the given node." }, "ignore": true }, { "__docId__": 346, "kind": "function", "name": "getNodeValue", "memberof": "src/lib/server/AtviseFile.js", "generator": false, "async": false, "static": true, "longname": "src/lib/server/AtviseFile.js~getNodeValue", "access": "public", "export": false, "importPath": "atscm/src/lib/server/AtviseFile.js", "importStyle": null, "description": "Returns a node's OPC-UA value based on it's raw value and type.", "lineNumber": 318, "params": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "rawValue", "description": "A node's raw value." }, { "nullable": null, "types": [ "node-opcua~DataType" ], "spread": false, "optional": false, "name": "dataType", "description": "A node's data type." }, { "nullable": null, "types": [ "node-opcua~VariantArrayType" ], "spread": false, "optional": false, "name": "arrayType", "description": "A node's array type." } ], "return": { "types": [ "*" ] }, "ignore": true }, { "__docId__": 347, "kind": "function", "name": "extensionForDataType", "memberof": "src/lib/server/AtviseFile.js", "generator": false, "async": false, "static": true, "longname": "src/lib/server/AtviseFile.js~extensionForDataType", "access": "public", "export": false, "importPath": "atscm/src/lib/server/AtviseFile.js", "importStyle": null, "description": "Returns the extension for a specific {@link node-opcua~DataType}.\nAlgorithm:\n - if the type has a shortened extension defined in {@link ExtensionForDataType}, return it.\n - else return the DataType's name, in lowercase letters.", "lineNumber": 340, "params": [ { "nullable": null, "types": [ "node-opcua~DataType" ], "spread": false, "optional": false, "name": "dataType", "description": "The datatype to get the extension for." } ], "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "The resulting extension." }, "ignore": true }, { "__docId__": 348, "kind": "variable", "name": "ConfigFileRegexp", "memberof": "src/lib/server/AtviseFile.js", "static": true, "longname": "src/lib/server/AtviseFile.js~ConfigFileRegexp", "access": "public", "export": false, "importPath": "atscm/src/lib/server/AtviseFile.js", "importStyle": null, "description": "A regular expression that maches all reference definition files.", "lineNumber": 348, "type": { "nullable": null, "types": [ "RegExp" ], "spread": false, "description": null }, "ignore": true }, { "__docId__": 349, "kind": "class", "name": "AtviseFile", "memberof": "src/lib/server/AtviseFile.js", "static": true, "longname": "src/lib/server/AtviseFile.js~AtviseFile", "access": "public", "export": true, "importPath": "atscm/src/lib/server/AtviseFile.js", "importStyle": "AtviseFile", "description": "An extension to {@link vinyl~File} providing some additional, atvise-related properties.", "lineNumber": 357, "properties": [ { "nullable": null, "types": [ "node-opcua~DataType" ], "spread": false, "optional": false, "name": "AtviseFile#dataType", "description": "The {@link node-opcua~DataType} the node is\nstored against on atvise server." }, { "nullable": null, "types": [ "NodeId" ], "spread": false, "optional": false, "name": "typeDefinition", "description": "The file's type definition on atvise server.\nFIXME: Additional properties not showing in API docs." } ], "interface": false, "extends": [ "vinyl~File" ] }, { "__docId__": 350, "kind": "method", "name": "pathForReadResult", "memberof": "src/lib/server/AtviseFile.js~AtviseFile", "generator": false, "async": false, "static": true, "longname": "src/lib/server/AtviseFile.js~AtviseFile.pathForReadResult", "access": "public", "description": "Returns a storage path for a {@link ReadStream.ReadResult}.", "lineNumber": 362, "params": [ { "nullable": null, "types": [ "ReadStream.ReadResult" ], "spread": false, "optional": false, "name": "readResult", "description": "The read result to get a path for." } ], "return": { "types": [ "*" ] } }, { "__docId__": 351, "kind": "method", "name": "encodeValue", "memberof": "src/lib/server/AtviseFile.js~AtviseFile", "generator": false, "async": false, "static": true, "longname": "src/lib/server/AtviseFile.js~AtviseFile.encodeValue", "access": "public", "description": "Encodes a node's value to file contents.", "lineNumber": 412, "params": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "value", "description": "The value to encode." }, { "nullable": null, "types": [ "node-opcua~DataType" ], "spread": false, "optional": false, "name": "dataType", "description": "The {@link node-opcua~DataType} to encode the value for." }, { "nullable": null, "types": [ "node-opcua~VariantArrayType" ], "spread": false, "optional": false, "name": "arrayType", "description": "The files array type." } ], "return": { "nullable": true, "types": [ "Buffer" ], "spread": false, "description": "The encoded file contents or null." } }, { "__docId__": 352, "kind": "method", "name": "decodeValue", "memberof": "src/lib/server/AtviseFile.js~AtviseFile", "generator": false, "async": false, "static": true, "longname": "src/lib/server/AtviseFile.js~AtviseFile.decodeValue", "access": "public", "description": "Decodes a file's contents to a node's value.", "lineNumber": 437, "params": [ { "nullable": null, "types": [ "Buffer" ], "spread": false, "optional": false, "name": "buffer", "description": "The file contents to decode." }, { "nullable": null, "types": [ "node-opcua~DataType" ], "spread": false, "optional": false, "name": "dataType", "description": "The {@link node-opcua~DataType} to decode the contents." }, { "nullable": null, "types": [ "node-opcua~VariantArrayType" ], "spread": false, "optional": false, "name": "arrayType", "description": "The files array type." } ], "return": { "nullable": true, "types": [ "*" ], "spread": false, "description": "The decoded node value or null." } }, { "__docId__": 353, "kind": "method", "name": "normalizeMtime", "memberof": "src/lib/server/AtviseFile.js~AtviseFile", "generator": false, "async": false, "static": true, "longname": "src/lib/server/AtviseFile.js~AtviseFile.normalizeMtime", "access": "public", "description": "As file mtimes do not support millisecond resolution these must be removed before storing\nfiles.", "lineNumber": 460, "params": [ { "nullable": null, "types": [ "Date" ], "spread": false, "optional": false, "name": "date", "description": "The original mtime." } ], "return": { "nullable": null, "types": [ "Date" ], "spread": false, "description": "The normalized mtime." } }, { "__docId__": 354, "kind": "method", "name": "fromReadResult", "memberof": "src/lib/server/AtviseFile.js~AtviseFile", "generator": false, "async": false, "static": true, "longname": "src/lib/server/AtviseFile.js~AtviseFile.fromReadResult", "access": "public", "description": "Creates a new {@link AtviseFile} for the given {@link ReadStream.ReadResult}.", "lineNumber": 471, "params": [ { "nullable": null, "types": [ "ReadStream.ReadResult" ], "spread": false, "optional": false, "name": "readResult", "description": "The read result to create the file for." } ], "return": { "nullable": null, "types": [ "AtviseFile" ], "spread": false, "description": "The resulting file." } }, { "__docId__": 355, "kind": "method", "name": "_getMetadata", "memberof": "src/lib/server/AtviseFile.js~AtviseFile", "generator": false, "async": false, "static": false, "longname": "src/lib/server/AtviseFile.js~AtviseFile#_getMetadata", "access": "private", "description": "Recalculates {@link AtviseFile#dataType}, {@link AtviseFile#arrayType} and\n{@link AtviseFile#typeDefinition}. **Never call this method directly.**.", "lineNumber": 503, "params": [], "return": null }, { "__docId__": 356, "kind": "member", "name": "_nodeClass", "memberof": "src/lib/server/AtviseFile.js~AtviseFile", "static": false, "longname": "src/lib/server/AtviseFile.js~AtviseFile#_nodeClass", "access": "private", "description": "The node's class.", "lineNumber": 510, "type": { "nullable": null, "types": [ "node-opcua~NodeClass" ], "spread": false, "description": null } }, { "__docId__": 357, "kind": "member", "name": "_references", "memberof": "src/lib/server/AtviseFile.js~AtviseFile", "static": false, "longname": "src/lib/server/AtviseFile.js~AtviseFile#_references", "access": "private", "description": "References the node holds: In most cases this will be a single entry for\n`'HasTypeDefinition'`.", "lineNumber": 519, "type": { "nullable": null, "types": [ "Map" ], "spread": false, "description": null } }, { "__docId__": 359, "kind": "member", "name": "_arrayType", "memberof": "src/lib/server/AtviseFile.js~AtviseFile", "static": false, "longname": "src/lib/server/AtviseFile.js~AtviseFile#_arrayType", "access": "private", "description": "The node's stored {@link node-opcua~VariantArrayType}.", "lineNumber": 537, "type": { "nullable": true, "types": [ "node-opcua~VariantArrayType" ], "spread": false, "description": null } }, { "__docId__": 361, "kind": "member", "name": "_name", "memberof": "src/lib/server/AtviseFile.js~AtviseFile", "static": false, "longname": "src/lib/server/AtviseFile.js~AtviseFile#_name", "access": "private", "description": "A node's browse- and display name.", "lineNumber": 545, "type": { "nullable": true, "types": [ "string" ], "spread": false, "description": null } }, { "__docId__": 364, "kind": "member", "name": "_dataType", "memberof": "src/lib/server/AtviseFile.js~AtviseFile", "static": false, "longname": "src/lib/server/AtviseFile.js~AtviseFile#_dataType", "access": "private", "description": "The node's stored {@link node-opcua~DataType}.", "lineNumber": 590, "type": { "nullable": true, "types": [ "node-opcua~DataType" ], "spread": false, "description": null } }, { "__docId__": 369, "kind": "method", "name": "getMetadata", "memberof": "src/lib/server/AtviseFile.js~AtviseFile", "generator": false, "async": false, "static": false, "longname": "src/lib/server/AtviseFile.js~AtviseFile#getMetadata", "access": "public", "description": "Computes a file's metadata if needed.", "lineNumber": 658, "return": { "nullable": null, "types": [ "AtviseFile" ], "spread": false, "description": "The file." }, "params": [] }, { "__docId__": 370, "kind": "get", "name": "nodeClass", "memberof": "src/lib/server/AtviseFile.js~AtviseFile", "generator": false, "async": false, "static": false, "longname": "src/lib/server/AtviseFile.js~AtviseFile#nodeClass", "access": "public", "description": "The node's class.", "lineNumber": 670, "type": { "nullable": null, "types": [ "node-opcua~NodeClass" ], "spread": false, "description": null } }, { "__docId__": 371, "kind": "get", "name": "dataType", "memberof": "src/lib/server/AtviseFile.js~AtviseFile", "generator": false, "async": false, "static": false, "longname": "src/lib/server/AtviseFile.js~AtviseFile#dataType", "access": "public", "description": "The file's {@link node-opcua~DataType}.", "lineNumber": 682, "type": { "nullable": null, "types": [ "node-opcua~DataType" ], "spread": false, "description": null } }, { "__docId__": 372, "kind": "get", "name": "arrayType", "memberof": "src/lib/server/AtviseFile.js~AtviseFile", "generator": false, "async": false, "static": false, "longname": "src/lib/server/AtviseFile.js~AtviseFile#arrayType", "access": "public", "description": "The file's {@link node-opcua~VariantArrayType}.", "lineNumber": 694, "type": { "nullable": null, "types": [ "node-opcua~VariantArrayType" ], "spread": false, "description": null } }, { "__docId__": 373, "kind": "get", "name": "references", "memberof": "src/lib/server/AtviseFile.js~AtviseFile", "generator": false, "async": false, "static": false, "longname": "src/lib/server/AtviseFile.js~AtviseFile#references", "access": "public", "description": "The files's references.", "lineNumber": 706, "type": { "nullable": null, "types": [ "Map" ], "spread": false, "description": null } }, { "__docId__": 374, "kind": "get", "name": "typeDefinition", "memberof": "src/lib/server/AtviseFile.js~AtviseFile", "generator": false, "async": false, "static": false, "longname": "src/lib/server/AtviseFile.js~AtviseFile#typeDefinition", "access": "public", "description": "The file's type definition.", "lineNumber": 718, "type": { "nullable": null, "types": [ "node-opcua~NodeId" ], "spread": false, "description": null } }, { "__docId__": 375, "kind": "get", "name": "isReferenceConfig", "memberof": "src/lib/server/AtviseFile.js~AtviseFile", "generator": false, "async": false, "static": false, "longname": "src/lib/server/AtviseFile.js~AtviseFile#isReferenceConfig", "access": "public", "description": "`true` for reference config files (for example `.index.htm.json`).", "lineNumber": 733, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 376, "kind": "get", "name": "isDisplay", "memberof": "src/lib/server/AtviseFile.js~AtviseFile", "generator": false, "async": false, "static": false, "longname": "src/lib/server/AtviseFile.js~AtviseFile#isDisplay", "access": "public", "description": "`true` for files containing atvise displays.", "lineNumber": 741, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 377, "kind": "get", "name": "isScript", "memberof": "src/lib/server/AtviseFile.js~AtviseFile", "generator": false, "async": false, "static": false, "longname": "src/lib/server/AtviseFile.js~AtviseFile#isScript", "access": "public", "description": "`true` for files containing atvise scripts.", "lineNumber": 749, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 378, "kind": "get", "name": "isQuickDynamic", "memberof": "src/lib/server/AtviseFile.js~AtviseFile", "generator": false, "async": false, "static": false, "longname": "src/lib/server/AtviseFile.js~AtviseFile#isQuickDynamic", "access": "public", "description": "`true` for files containing atvise quick dynamics.", "lineNumber": 757, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 379, "kind": "set", "name": "value", "memberof": "src/lib/server/AtviseFile.js~AtviseFile", "generator": false, "async": false, "static": false, "longname": "src/lib/server/AtviseFile.js~AtviseFile#value", "access": "public", "description": "Sets the node value for the file.", "lineNumber": 765, "params": [ { "nullable": true, "types": [ "*" ], "spread": false, "optional": false, "name": "newValue", "description": "The value to set." } ] }, { "__docId__": 380, "kind": "member", "name": "contents", "memberof": "src/lib/server/AtviseFile.js~AtviseFile", "static": false, "longname": "src/lib/server/AtviseFile.js~AtviseFile#contents", "access": "public", "description": "The file's contents.", "lineNumber": 770, "type": { "nullable": true, "types": [ "Buffer" ], "spread": false, "description": null } }, { "__docId__": 381, "kind": "get", "name": "value", "memberof": "src/lib/server/AtviseFile.js~AtviseFile", "generator": false, "async": false, "static": false, "longname": "src/lib/server/AtviseFile.js~AtviseFile#value", "access": "public", "description": "Returns the decoded node value for the file.", "lineNumber": 777, "type": { "nullable": true, "types": [ "*" ], "spread": false, "description": null } }, { "__docId__": 382, "kind": "get", "name": "createNodeValue", "memberof": "src/lib/server/AtviseFile.js~AtviseFile", "generator": false, "async": false, "static": false, "longname": "src/lib/server/AtviseFile.js~AtviseFile#createNodeValue", "access": "public", "description": "Returns the decoded node value for create node serverscript.", "lineNumber": 785, "type": { "nullable": true, "types": [ "*" ], "spread": false, "description": null } }, { "__docId__": 383, "kind": "get", "name": "nodeId", "memberof": "src/lib/server/AtviseFile.js~AtviseFile", "generator": false, "async": false, "static": false, "longname": "src/lib/server/AtviseFile.js~AtviseFile#nodeId", "access": "public", "description": "Returns the node id associated with the file.", "lineNumber": 803, "type": { "nullable": null, "types": [ "NodeId" ], "spread": false, "description": null } }, { "__docId__": 384, "kind": "get", "name": "name", "memberof": "src/lib/server/AtviseFile.js~AtviseFile", "generator": false, "async": false, "static": false, "longname": "src/lib/server/AtviseFile.js~AtviseFile#name", "access": "public", "description": "A file's browse and display name.", "lineNumber": 822, "type": { "nullable": null, "types": [ "string" ], "spread": false, "description": null } }, { "__docId__": 385, "kind": "get", "name": "parentNodeId", "memberof": "src/lib/server/AtviseFile.js~AtviseFile", "generator": false, "async": false, "static": false, "longname": "src/lib/server/AtviseFile.js~AtviseFile#parentNodeId", "access": "public", "description": "A file's parent's node id.", "lineNumber": 834, "type": { "nullable": null, "types": [ "NodeId" ], "spread": false, "description": null } }, { "__docId__": 386, "kind": "method", "name": "clone", "memberof": "src/lib/server/AtviseFile.js~AtviseFile", "generator": false, "async": false, "static": false, "longname": "src/lib/server/AtviseFile.js~AtviseFile#clone", "access": "public", "description": "Returns a new file with all attributes of the current file.", "see": [ "https://github.com/gulpjs/vinyl#filecloneoptions" ], "lineNumber": 855, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options", "description": "See the {@link vinyl~File} docs for all options available." } ], "return": { "nullable": null, "types": [ "AtviseFile" ], "spread": false, "description": "The cloned file." } }, { "__docId__": 387, "kind": "method", "name": "read", "memberof": "src/lib/server/AtviseFile.js~AtviseFile", "generator": false, "async": false, "static": true, "longname": "src/lib/server/AtviseFile.js~AtviseFile.read", "access": "public", "description": "Creates a new AtviseFile and reads it's contents.", "lineNumber": 872, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options", "description": "See {@link vinyl~File} for available options." } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "Resolved with the new file of rejected with the error that occured while\ntrying to read it's path." } }, { "__docId__": 388, "kind": "file", "name": "src/lib/server/CreateNodeStream.js", "content": "import { StatusCodes } from 'node-opcua/lib/datamodel/opcua_status_code';\nimport { DataType } from 'node-opcua/lib/datamodel/variant';\nimport { NodeClass } from 'node-opcua/lib/datamodel/nodeclass';\nimport Logger from 'gulplog';\nimport NodeId from '../model/opcua/NodeId';\nimport { ReferenceTypeIds, ReferenceTypeNames } from '../model/Node';\nimport CallScriptStream from './scripts/CallScriptStream';\n\n/**\n * A stream that creates OPC-UA nodes for the passed {@link AtviseFiles}s.\n */\nexport default class CreateNodeStream extends CallScriptStream {\n /**\n * Id of the *CreateNode* script added with `atscm import`.\n * @type {NodeId}\n */\n get scriptId() {\n return new NodeId(\n NodeId.NodeIdType.STRING,\n 'SYSTEM.LIBRARY.ATVISE.SERVERSCRIPTS.atscm.CreateNode',\n 1\n );\n }\n\n /**\n * The options required to create a node for the given file.\n * @param {AtviseFile} file The processed file.\n * @return {Object} The options passed to the *CreateNode* script.\n */\n scriptParameters(file) {\n const options = {\n nodeId: file.nodeId,\n parentNodeId: file.parent ? file.parent.nodeId : 85,\n nodeClass: file.nodeClass.value,\n typeDefinition: file.typeDefinition,\n browseName: file.idName,\n };\n\n const toParentRefs = file.references.get(ReferenceTypeIds.toParent);\n if (toParentRefs) {\n options.reference = ReferenceTypeNames[[...toParentRefs][0]];\n }\n\n const rules = file.references.get(ReferenceTypeIds.HasModellingRule);\n if (rules) {\n options.modellingRule = [...rules][0];\n }\n\n if (file.nodeClass.value === NodeClass.Variable.value) {\n options.dataType = file.variantValue.dataType.value;\n options.valueRank = file.variantValue.arrayType.value;\n options.value = file.variantValue.value;\n }\n\n return {\n paramObjString: {\n dataType: DataType.String,\n value: JSON.stringify(options),\n },\n };\n }\n\n /**\n * Prints an error message telling that creating a node failed.\n * @param {AtviseFile} file The file who's node could not be created.\n * @return {string} The resulting error message.\n */\n processErrorMessage(file) {\n return `Error creating node ${file.nodeId}`;\n }\n\n /**\n * Handles the results of a script call.\n * @param {AtviseFile} file The file the script was called with.\n * @param {node-opcua~Variant[]} outArgs The raw method results.\n * @param {function(err: Error)} callback Called once finished.\n */\n handleOutputArguments(file, outArgs, callback) {\n if (outArgs[0].value !== StatusCodes.Good) {\n callback(new Error(outArgs[1].value));\n } else {\n const [{ value: createdNode }, { value: createFailed }] = outArgs[3].value;\n\n if (createFailed) {\n Logger.warn('Failed to create node', file.nodeId.toString());\n } else if (createdNode) {\n Logger.debug('Created node', file.nodeId.toString());\n this.push(file);\n } else {\n Logger.debug('Node', file.nodeId.toString(), 'already exists');\n this.push(file);\n }\n\n callback(null);\n }\n }\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/lib/server/CreateNodeStream.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 389, "kind": "class", "name": "CreateNodeStream", "memberof": "src/lib/server/CreateNodeStream.js", "static": true, "longname": "src/lib/server/CreateNodeStream.js~CreateNodeStream", "access": "public", "export": true, "importPath": "atscm/src/lib/server/CreateNodeStream.js", "importStyle": "CreateNodeStream", "description": "A stream that creates OPC-UA nodes for the passed {@link AtviseFiles}s.", "lineNumber": 12, "interface": false, "extends": [ "src/lib/server/scripts/CallScriptStream.js~CallScriptStream" ] }, { "__docId__": 390, "kind": "get", "name": "scriptId", "memberof": "src/lib/server/CreateNodeStream.js~CreateNodeStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/CreateNodeStream.js~CreateNodeStream#scriptId", "access": "public", "description": "Id of the *CreateNode* script added with `atscm import`.", "lineNumber": 17, "type": { "nullable": null, "types": [ "NodeId" ], "spread": false, "description": null } }, { "__docId__": 391, "kind": "method", "name": "scriptParameters", "memberof": "src/lib/server/CreateNodeStream.js~CreateNodeStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/CreateNodeStream.js~CreateNodeStream#scriptParameters", "access": "public", "description": "The options required to create a node for the given file.", "lineNumber": 30, "params": [ { "nullable": null, "types": [ "AtviseFile" ], "spread": false, "optional": false, "name": "file", "description": "The processed file." } ], "return": { "nullable": null, "types": [ "Object" ], "spread": false, "description": "The options passed to the *CreateNode* script." } }, { "__docId__": 392, "kind": "method", "name": "processErrorMessage", "memberof": "src/lib/server/CreateNodeStream.js~CreateNodeStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/CreateNodeStream.js~CreateNodeStream#processErrorMessage", "access": "public", "description": "Prints an error message telling that creating a node failed.", "lineNumber": 68, "params": [ { "nullable": null, "types": [ "AtviseFile" ], "spread": false, "optional": false, "name": "file", "description": "The file who's node could not be created." } ], "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "The resulting error message." } }, { "__docId__": 393, "kind": "method", "name": "handleOutputArguments", "memberof": "src/lib/server/CreateNodeStream.js~CreateNodeStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/CreateNodeStream.js~CreateNodeStream#handleOutputArguments", "access": "public", "description": "Handles the results of a script call.", "lineNumber": 78, "params": [ { "nullable": null, "types": [ "AtviseFile" ], "spread": false, "optional": false, "name": "file", "description": "The file the script was called with." }, { "nullable": null, "types": [ "node-opcua~Variant[]" ], "spread": false, "optional": false, "name": "outArgs", "description": "The raw method results." }, { "nullable": null, "types": [ "function(err: Error)" ], "spread": false, "optional": false, "name": "callback", "description": "Called once finished." } ], "return": null }, { "__docId__": 394, "kind": "file", "name": "src/lib/server/NodeBrowser.js", "content": "import { ObjectIds } from 'node-opcua/lib/opcua_node_ids.js';\nimport { BrowseDirection } from 'node-opcua/lib/services/browse_service.js';\nimport { AttributeIds } from 'node-opcua/lib/services/read_service';\nimport { VariantArrayType, DataType } from 'node-opcua/lib/datamodel/variant';\nimport Logger from 'gulplog';\nimport PromiseQueue from 'p-queue';\nimport ProjectConfig from '../../config/ProjectConfig';\nimport NodeId from '../model/opcua/NodeId';\nimport { ServerNode, ReferenceTypeIds, ReferenceTypeNames } from '../model/Node';\nimport Session from './Session';\n\n/**\n * A set of all hierarchical reference types.\n * @type {Set}\n */\nconst HierachicalReferencesTypeIds = new Set([\n ReferenceTypeIds.HasChild,\n ReferenceTypeIds.Aggregates,\n ReferenceTypeIds.HasComponent,\n ReferenceTypeIds.HasOrderedComponent,\n ReferenceTypeIds.HasHistoricalConfiguration,\n ReferenceTypeIds.HasProperty,\n ReferenceTypeIds.HasSubtype,\n ReferenceTypeIds.HasEventSource,\n ReferenceTypeIds.HasNotifier,\n ReferenceTypeIds.Organizes,\n]);\n\n/**\n * A node discovered while browsing the server's database.\n */\nexport class BrowsedNode extends ServerNode {\n /**\n * Creates a new node.\n * @param {Object} options The options to use.\n * @param {?BrowsedNode} options.parent The parent node.\n * @param {Object} options.reference The reference to pick metadata from.\n */\n constructor({ parent, reference, nodeClass, name }) {\n super({\n parent,\n nodeClass: reference ? reference.nodeClass : nodeClass,\n name: reference ? reference.browseName.name : name,\n });\n\n if (reference) {\n // NOTE: You should always provide reference, this only for #createChild\n this.addReference(ReferenceTypeIds.toParent, reference.referenceTypeId.value);\n\n /** The node's id. @type {NodeId} */\n this.id = reference.nodeId;\n }\n\n /** The node's value\n * @type {node-opcua~Variant} */\n this.value = {};\n }\n\n /**\n * Add multiple references at once.\n * @param {Object[]} references The references to add.\n */\n addReferences(references) {\n references.forEach((reference) => {\n this.addReference(reference.referenceTypeId.value, reference.nodeId.value);\n });\n }\n\n /**\n * Creates new child node.\n * @param {Object} options The options to use.\n * @see {Node#createChild}\n */\n createChild(options) {\n const node = super.createChild(options);\n\n node.id = this.id;\n\n return node;\n }\n}\n\n/**\n * Browses the server database.\n */\nexport default class NodeBrowser {\n /**\n * Creates a new node browser.\n * @param {Object} options The options to use.\n * @param {number} [options.concurrency=250] The maximum of nodes to process in parallel.\n * @param {function(node: BrowsedNode): Promise} options.handleNode A custom node handler.\n * @param {boolean} [options.recursive] If the whole node tree should be processed.\n */\n constructor({\n concurrency = 250,\n ignoreNodes = ProjectConfig.ignoreNodes,\n handleNode,\n recursive = true,\n } = {}) {\n /** The queue used to process nodes in parallel\n * @type {p-queue~PQueue} */\n this.queue = new PromiseQueue({\n // autoStart: false,\n concurrency,\n });\n\n /** A map of nodes already handled. Keys are ids, values are `true` if the node was already\n * pushed and `false` otherwise.\n * @type {Map}\n * */\n this._handled = new Map();\n\n this._waitingFor = {};\n\n /** A regular expression matching all ignored nodes. @type {RegExp} */\n this._ignoreNodesRegExp = new RegExp(`^(${ignoreNodes.map((n) => n.value).join('|')})`);\n\n /** If the browser should recurse. @type {boolean} */\n this._recursive = recursive;\n\n /** If a warning should be printed for attempting to pull sort order nodes\n * @type {boolean} */\n this._printSortOrderWarning = recursive;\n\n /** The custom node handler. @type {function(node: BrowsedNode): Promise} */\n this._handleNode = handleNode;\n\n /** The number of pushed (discovered and handled) nodes. @type {number} */\n this._pushed = 0;\n\n /** A map that maps node ids against their discovered hierarchical parent nodes. Used to detect\n * reference conflicts.\n * @type {Map} */\n this.parentNode = new Map();\n\n this.ensureHandled = new Set();\n }\n\n /**\n * Reads the given node's value.\n * @param {BrowsedNode} node The node to read.\n */\n _readValue(node) {\n if (!node.isVariable) {\n return null;\n }\n return new Promise((resolve, reject) => {\n this._session.readVariableValue(node.id, (err, result) => {\n if (err) {\n return reject(err);\n }\n return resolve(result && result.value);\n });\n }).then((value) => {\n if (node.nodeId.endsWith('.SortOrder')) {\n const removed = [];\n const siblings = node.parent.children.map((c) => c.idName).filter((n) => n !== 'SortOrder');\n const existing = value.value\n .map(({ name }) => name)\n .filter((name) => {\n const exists = siblings.find((c) => c === name);\n\n if (exists) {\n return true;\n }\n\n removed.push(name);\n return false;\n });\n\n // We could also add missing references here...\n\n if (removed.length) {\n // eslint-disable-next-line no-param-reassign\n value.value = existing.map((name) => ({ namespaceIndex: 1, name }));\n Logger.warn(`Removed ${removed.length} invalid references from '${node.nodeId}'`);\n }\n }\n\n if (value) {\n return value;\n }\n\n // Node is a variable but has no value -> Need to read dataType and arrayType directly.\n return new Promise((resolve, reject) => {\n const toRead = [AttributeIds.DataType, AttributeIds.ValueRank].map((attributeId) => ({\n nodeId: node.id,\n attributeId,\n }));\n this._session.read(\n toRead,\n (\n err,\n _,\n [\n {\n value: { value: dataType },\n },\n {\n value: { value: valueRank },\n },\n ] = []\n ) => {\n if (err) return reject(err);\n\n // FIXME: valueRank -2 (Any) and -3 (ScalarOrOneDimension) are not handled properly here\n const arrayType = valueRank < 0 ? VariantArrayType.Scalar : VariantArrayType.Array;\n\n return resolve({\n dataType: DataType[dataType.value],\n arrayType,\n value: null,\n });\n }\n );\n });\n });\n }\n\n // FIXME: Debounce á la https://runkit.com/5c347d277da2ad00125b6bc2/5c50161cbc21520012c42290\n // FIXME: Move to api\n /**\n * Browses the server address space at the given node id.\n * @param {Object} options The options to use.\n */\n _browse({ nodeId, browseDirection = BrowseDirection.Forward, resultMask = 63 }) {\n return new Promise((resolve, reject) => {\n this._session.browse({ nodeId, browseDirection, resultMask }, (err, data = []) =>\n err ? reject(err) : resolve(data[0].references)\n );\n });\n }\n\n /**\n * Browses a node.\n * @param {BrowsedNode} node The node to browse.\n */\n _browseNode(node) {\n return this._browse({ nodeId: node.id }).then((allReferences) => {\n const children = [];\n const references = [];\n\n const typeDefinitionReference = allReferences.find(\n (ref) => ref.referenceTypeId.value === ReferenceTypeIds.HasTypeDefinition\n );\n\n const isUserGroup =\n typeDefinitionReference &&\n typeDefinitionReference.nodeId.value === 'ObjectTypes.ATVISE.Group';\n\n allReferences.forEach((reference) => {\n // \"Cast\" ref.nodeId to NodeId\n Object.setPrototypeOf(reference.nodeId, NodeId.prototype);\n\n const ignored = this._ignoreNodesRegExp.test(reference.nodeId.value);\n const external = this._isExternalReference(reference.nodeId.value);\n\n if (\n HierachicalReferencesTypeIds.has(reference.referenceTypeId.value) &&\n !ignored &&\n !external\n ) {\n if (\n reference.referenceTypeId.value === ReferenceTypeIds.HasHistoricalConfiguration ||\n (isUserGroup && reference.nodeId.value.split(node.nodeId).length === 1)\n ) {\n references.push(reference);\n return;\n }\n\n if (\n !ProjectConfig.preserveSortOrderNodes &&\n reference.nodeId.value.endsWith('.SortOrder')\n ) {\n if (this._printSortOrderWarning) {\n Logger.warn(`Skipped pulling an atvise builder sort order node.\n - Reason: These nodes are not consistent across pulls.\n - You can force pulling them by setting Atviseproject.preserveSortOrderNodes.`);\n this._printSortOrderWarning = false;\n }\n return;\n }\n\n const [prefix, subPath] = reference.nodeId.value.split(node.id.value);\n if (!subPath || prefix !== '') {\n if (!ProjectConfig.isExternal(reference.nodeId.parent.value)) {\n references.push(reference);\n\n if (this._handled.get(reference.nodeId.value) === undefined) {\n this.ensureHandled.add(reference.nodeId.value);\n }\n return;\n }\n }\n\n const earlierParent = this.parentNode.get(reference.nodeId.value);\n if (earlierParent) {\n Logger.warn(`'${\n reference.nodeId.value\n }' was discovered as a child node of both '${earlierParent}' and '${node.id.value}'.\n - Reference type (to the latter): ${ReferenceTypeNames[reference.referenceTypeId.value]} (${\n reference.referenceTypeId.value\n })`);\n }\n\n if (this._handled.get(reference.nodeId.value) === undefined) {\n this.parentNode.set(reference.nodeId.value, node.id.value);\n children.push(\n new BrowsedNode({\n parent: node,\n reference,\n })\n );\n } // else node is already handled\n } else if (reference.referenceTypeId.value !== 50) {\n // Added by atvise builder\n // 'HasModelParent' reference set in atvise 3.3.2+\n // Always points to parent node, which atscm already handles\n if (\n reference.referenceTypeId.value === 334 &&\n reference.nodeId.value === (node.parent && node.parent.id.value)\n ) {\n return;\n }\n\n // Do not add ignored\n if (!ignored) {\n references.push(reference);\n } else {\n Logger.debug(\n `Ignored reference from ${node.id.value} (${\n ReferenceTypeNames[reference.referenceTypeId.value]\n }) to ${reference.nodeId.value}`\n );\n }\n }\n });\n\n // eslint-disable-next-line no-param-reassign\n node.children = children;\n node.addReferences(references);\n\n return { children, references };\n });\n }\n\n /**\n * Finishes processing a given node: After calling {@link NodeBrowser#_handleNode}, it resolves\n * is's dependencies.\n * @param {BrowsedNode} node The node handled.\n */\n async _push(node) {\n if (this._handled.get(node.id.value)) {\n Logger.error('Prevented duplicate handling of', node.id.value);\n return;\n }\n\n // Prevent duplicate pushes while reading value file\n this._handled.set(node.id.value, 'processing');\n\n // eslint-disable-next-line no-param-reassign\n node.value = (await this._readValue(node)) || node.value;\n\n // TODO: Remove additional properties (children, ...) for better memory-usage\n\n const originalId = node.id.value;\n\n await this._handleNode(node);\n\n this._pushed += 1;\n\n // Do not proceed if queue is stopped (because an error occured)\n if (!this._recursive || this.queue.isPaused) {\n // Queue is stopped, not adding...\n return;\n }\n\n this.queue.addAll(node.children.map((child) => () => this._process(child)));\n\n const idValue = node.id.value;\n this._handled.set(idValue, true);\n this.ensureHandled.delete(originalId);\n\n // Handle dependencies\n if (this._waitingFor[idValue]) {\n this._waitingFor[idValue].forEach((dep) => {\n // eslint-disable-next-line no-param-reassign\n if (--dep.dependencies === 0) {\n // Adding as dependencies are resolved\n this.queue.add(() => this._push(dep)).catch(this._reject);\n }\n });\n\n delete this._waitingFor[idValue];\n }\n }\n\n /**\n * Instructs the browser to handle a node that would otherwise be queued behind others (eg: its\n * parent node).\n * @param {BrowsedNode} node The node to add.\n * @return {Promise} The fully processed node.\n */\n addNode(node) {\n if (this.queue.isPaused) {\n Logger.debug('Queue is stopped, not adding...');\n return Promise.resolve();\n }\n\n return this.queue.add(() => this._handleNode(node, { transform: false })).catch(this._reject);\n }\n\n /**\n * Returns `true` for node ids that should be treated as external references.\n * @param {string|number} idValue Value of the id to check.\n * @return {boolean} If the id should be treated as external.\n */\n _isExternalReference(idValue) {\n // FIXME: Allow plugins\n return typeof idValue !== 'string' || !this._sourceNodesRegExp.test(idValue);\n }\n\n /**\n * Returns `true` if a node has dependencies it should be queued behind.\n * @param {BrowsedNode} node The node to check.\n */\n _hasDependencies(node) {\n let dependencyCount = 0;\n\n for (const references of node.references.values()) {\n for (const reference of references) {\n if (\n this._handled.get(reference) !== true &&\n !this._isExternalReference(reference) &&\n !this._ignoreNodesRegExp.test(reference)\n ) {\n dependencyCount++;\n this._waitingFor[reference] = (this._waitingFor[reference] || []).concat(node);\n }\n }\n }\n\n // eslint-disable-next-line no-param-reassign\n node.dependencies = dependencyCount;\n\n return dependencyCount > 0;\n }\n\n /**\n * Processes a single node: Requires special error handling.\n * @param {BrowsedNode} node The node to process.\n * @return {Promise} The fully processed node.\n */\n async _process(node) {\n try {\n if (this._handled.has(node.id.value)) {\n // Already queued\n return undefined;\n }\n this._handled.set(node.id.value, false);\n await this._browseNode(node);\n\n if (!this._hasDependencies(node)) {\n await this._push(node);\n }\n } catch (err) {\n this._reject(err);\n }\n\n return node;\n }\n\n /**\n * Discovers and browses the source nodes.\n * @param {Array} nodeIds The source ids.\n * @return {Promise} Resolved once finished.\n */\n _getSourceNodes(nodeIds) {\n const browseUp = ({ nodeId, path = [] }) =>\n this._browse({\n nodeId,\n browseDirection: BrowseDirection.Inverse,\n }).then((references) => {\n for (const reference of references) {\n if (HierachicalReferencesTypeIds.has(reference.referenceTypeId.value)) {\n path.unshift(reference.nodeId);\n return reference.nodeId.value === ObjectIds.RootFolder\n ? path\n : browseUp({ nodeId: reference.nodeId, path });\n }\n }\n throw new Error(`Unable to find parent node of ${nodeId}`);\n });\n\n const browseDown = (path, target) =>\n Promise.all(\n path.map((nodeId, i) =>\n this._browse({ nodeId }).then((references) =>\n references.find(\n (ref) => ref.nodeId.value === (path[i + 1] ? path[i + 1].value : target.value)\n )\n )\n )\n );\n\n return Promise.all(\n nodeIds.map((nodeId) =>\n browseUp({ nodeId })\n .then((path) => browseDown(path, nodeId))\n .then((pathDown) =>\n pathDown.reduce((parent, reference) => new BrowsedNode({ parent, reference }), null)\n )\n )\n );\n }\n\n /**\n * Starts the browser of the given nodes.\n * @param {NodeId[]} nodeIds The nodes to browse.\n * @return {Promise} Resolved once all nodes are finished.\n */\n async browse(nodeIds) {\n this._sourceNodesRegExp = new RegExp(\n `^(${nodeIds.map(({ value }) => `${value.replace(/\\./g, '\\\\.')}`).join('|')})`\n );\n\n this._session = await Session.create();\n\n // Add source nodes\n const nodes = await this._getSourceNodes(nodeIds);\n this.queue.addAll(nodes.map((node) => () => this._process(node)));\n\n // Queue error handling\n let processError = null;\n this._reject = (err) => {\n if (processError) {\n // Multiple errors occured. In most cases this means, that the server connection was closed\n // after the first error.\n Logger.debug('Additional error', err);\n return;\n }\n\n processError = err;\n this.queue.pause();\n this.queue.clear();\n };\n\n return new Promise((resolve, reject) => {\n this.queue.onIdle().then(async () => {\n await Session.close(this._session);\n\n if (processError) {\n reject(processError);\n return;\n }\n\n if (Object.keys(this._waitingFor).length) {\n const unresolved = Object.entries(this._waitingFor).reduce(\n (all, [to, children]) =>\n all.concat(\n children.map((c) => ({\n from: c.id.value,\n to,\n type:\n ReferenceTypeNames[\n Array.from(c.references).find(([, refs]) => refs.has(to))[0]\n ],\n }))\n ),\n []\n );\n\n reject(\n new Error(`Unable to resolve reference${unresolved.length > 1 ? 's' : ''}:\n\n ${unresolved.map(({ from, type, to }) => `${from} → (${type}) → ${to}`).join('\\n ')}\n`)\n );\n return;\n }\n\n if (this.ensureHandled.size) {\n reject(\n new Error(`Some referenced nodes were not handled,\n - ${Array.from(this.ensureHandled).join('\\n - ')}`)\n );\n return;\n }\n\n if (Array.from(this._handled).find(([, pushed]) => !pushed)) {\n throw new Error('A node was processed, but not pushed');\n }\n\n resolve();\n });\n });\n }\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/lib/server/NodeBrowser.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 395, "kind": "variable", "name": "HierachicalReferencesTypeIds", "memberof": "src/lib/server/NodeBrowser.js", "static": true, "longname": "src/lib/server/NodeBrowser.js~HierachicalReferencesTypeIds", "access": "public", "export": false, "importPath": "atscm/src/lib/server/NodeBrowser.js", "importStyle": null, "description": "A set of all hierarchical reference types.", "lineNumber": 16, "type": { "nullable": null, "types": [ "Set" ], "spread": false, "description": null }, "ignore": true }, { "__docId__": 396, "kind": "class", "name": "BrowsedNode", "memberof": "src/lib/server/NodeBrowser.js", "static": true, "longname": "src/lib/server/NodeBrowser.js~BrowsedNode", "access": "public", "export": true, "importPath": "atscm/src/lib/server/NodeBrowser.js", "importStyle": "{BrowsedNode}", "description": "A node discovered while browsing the server's database.", "lineNumber": 32, "interface": false, "extends": [ "src/lib/model/Node.js~ServerNode" ] }, { "__docId__": 397, "kind": "constructor", "name": "constructor", "memberof": "src/lib/server/NodeBrowser.js~BrowsedNode", "generator": false, "async": false, "static": false, "longname": "src/lib/server/NodeBrowser.js~BrowsedNode#constructor", "access": "public", "description": "Creates a new node.", "lineNumber": 39, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options", "description": "The options to use." }, { "nullable": true, "types": [ "BrowsedNode" ], "spread": false, "optional": false, "name": "options.parent", "description": "The parent node." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options.reference", "description": "The reference to pick metadata from." } ] }, { "__docId__": 398, "kind": "member", "name": "id", "memberof": "src/lib/server/NodeBrowser.js~BrowsedNode", "static": false, "longname": "src/lib/server/NodeBrowser.js~BrowsedNode#id", "access": "public", "description": "The node's id. @type {NodeId}", "lineNumber": 51, "type": { "types": [ "*" ] } }, { "__docId__": 399, "kind": "member", "name": "value", "memberof": "src/lib/server/NodeBrowser.js~BrowsedNode", "static": false, "longname": "src/lib/server/NodeBrowser.js~BrowsedNode#value", "access": "public", "description": "The node's value", "lineNumber": 56, "type": { "nullable": null, "types": [ "node-opcua~Variant" ], "spread": false, "description": null } }, { "__docId__": 400, "kind": "method", "name": "addReferences", "memberof": "src/lib/server/NodeBrowser.js~BrowsedNode", "generator": false, "async": false, "static": false, "longname": "src/lib/server/NodeBrowser.js~BrowsedNode#addReferences", "access": "public", "description": "Add multiple references at once.", "lineNumber": 63, "params": [ { "nullable": null, "types": [ "Object[]" ], "spread": false, "optional": false, "name": "references", "description": "The references to add." } ], "return": null }, { "__docId__": 401, "kind": "method", "name": "createChild", "memberof": "src/lib/server/NodeBrowser.js~BrowsedNode", "generator": false, "async": false, "static": false, "longname": "src/lib/server/NodeBrowser.js~BrowsedNode#createChild", "access": "public", "description": "Creates new child node.", "see": [ "{Node#createChild}" ], "lineNumber": 74, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options", "description": "The options to use." } ], "return": { "types": [ "*" ] } }, { "__docId__": 402, "kind": "class", "name": "NodeBrowser", "memberof": "src/lib/server/NodeBrowser.js", "static": true, "longname": "src/lib/server/NodeBrowser.js~NodeBrowser", "access": "public", "export": true, "importPath": "atscm/src/lib/server/NodeBrowser.js", "importStyle": "NodeBrowser", "description": "Browses the server database.", "lineNumber": 86, "interface": false }, { "__docId__": 403, "kind": "constructor", "name": "constructor", "memberof": "src/lib/server/NodeBrowser.js~NodeBrowser", "generator": false, "async": false, "static": false, "longname": "src/lib/server/NodeBrowser.js~NodeBrowser#constructor", "access": "public", "description": "Creates a new node browser.", "lineNumber": 94, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options", "description": "The options to use." }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": true, "defaultValue": "250", "defaultRaw": 250, "name": "options.concurrency", "description": "The maximum of nodes to process in parallel." }, { "nullable": null, "types": [ "function(node: BrowsedNode): Promise" ], "spread": false, "optional": false, "name": "options.handleNode", "description": "A custom node handler." }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": true, "name": "options.recursive", "description": "If the whole node tree should be processed." } ] }, { "__docId__": 404, "kind": "member", "name": "queue", "memberof": "src/lib/server/NodeBrowser.js~NodeBrowser", "static": false, "longname": "src/lib/server/NodeBrowser.js~NodeBrowser#queue", "access": "public", "description": "The queue used to process nodes in parallel", "lineNumber": 102, "type": { "nullable": null, "types": [ "p-queue~PQueue" ], "spread": false, "description": null } }, { "__docId__": 405, "kind": "member", "name": "_handled", "memberof": "src/lib/server/NodeBrowser.js~NodeBrowser", "static": false, "longname": "src/lib/server/NodeBrowser.js~NodeBrowser#_handled", "access": "private", "description": "A map of nodes already handled. Keys are ids, values are `true` if the node was already\npushed and `false` otherwise.", "lineNumber": 111, "type": { "nullable": null, "types": [ "Map" ], "spread": false, "description": null } }, { "__docId__": 406, "kind": "member", "name": "_waitingFor", "memberof": "src/lib/server/NodeBrowser.js~NodeBrowser", "static": false, "longname": "src/lib/server/NodeBrowser.js~NodeBrowser#_waitingFor", "access": "private", "description": null, "lineNumber": 113, "undocument": true, "type": { "types": [ "{}" ] } }, { "__docId__": 407, "kind": "member", "name": "_ignoreNodesRegExp", "memberof": "src/lib/server/NodeBrowser.js~NodeBrowser", "static": false, "longname": "src/lib/server/NodeBrowser.js~NodeBrowser#_ignoreNodesRegExp", "access": "private", "description": "A regular expression matching all ignored nodes. @type {RegExp}", "lineNumber": 116, "type": { "types": [ "*" ] } }, { "__docId__": 408, "kind": "member", "name": "_recursive", "memberof": "src/lib/server/NodeBrowser.js~NodeBrowser", "static": false, "longname": "src/lib/server/NodeBrowser.js~NodeBrowser#_recursive", "access": "private", "description": "If the browser should recurse. @type {boolean}", "lineNumber": 119, "type": { "types": [ "*" ] } }, { "__docId__": 409, "kind": "member", "name": "_printSortOrderWarning", "memberof": "src/lib/server/NodeBrowser.js~NodeBrowser", "static": false, "longname": "src/lib/server/NodeBrowser.js~NodeBrowser#_printSortOrderWarning", "access": "private", "description": "If a warning should be printed for attempting to pull sort order nodes", "lineNumber": 123, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 410, "kind": "member", "name": "_handleNode", "memberof": "src/lib/server/NodeBrowser.js~NodeBrowser", "static": false, "longname": "src/lib/server/NodeBrowser.js~NodeBrowser#_handleNode", "access": "private", "description": "The custom node handler. @type {function(node: BrowsedNode): Promise}", "lineNumber": 126, "type": { "types": [ "*" ] } }, { "__docId__": 411, "kind": "member", "name": "_pushed", "memberof": "src/lib/server/NodeBrowser.js~NodeBrowser", "static": false, "longname": "src/lib/server/NodeBrowser.js~NodeBrowser#_pushed", "access": "private", "description": "The number of pushed (discovered and handled) nodes. @type {number}", "lineNumber": 129, "type": { "types": [ "number" ] } }, { "__docId__": 412, "kind": "member", "name": "parentNode", "memberof": "src/lib/server/NodeBrowser.js~NodeBrowser", "static": false, "longname": "src/lib/server/NodeBrowser.js~NodeBrowser#parentNode", "access": "public", "description": "A map that maps node ids against their discovered hierarchical parent nodes. Used to detect\nreference conflicts.", "lineNumber": 134, "type": { "nullable": null, "types": [ "Map" ], "spread": false, "description": null } }, { "__docId__": 413, "kind": "member", "name": "ensureHandled", "memberof": "src/lib/server/NodeBrowser.js~NodeBrowser", "static": false, "longname": "src/lib/server/NodeBrowser.js~NodeBrowser#ensureHandled", "access": "public", "description": null, "lineNumber": 136, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 414, "kind": "method", "name": "_readValue", "memberof": "src/lib/server/NodeBrowser.js~NodeBrowser", "generator": false, "async": false, "static": false, "longname": "src/lib/server/NodeBrowser.js~NodeBrowser#_readValue", "access": "private", "description": "Reads the given node's value.", "lineNumber": 143, "params": [ { "nullable": null, "types": [ "BrowsedNode" ], "spread": false, "optional": false, "name": "node", "description": "The node to read." } ], "return": { "types": [ "*" ] } }, { "__docId__": 415, "kind": "method", "name": "_browse", "memberof": "src/lib/server/NodeBrowser.js~NodeBrowser", "generator": false, "async": false, "static": false, "longname": "src/lib/server/NodeBrowser.js~NodeBrowser#_browse", "access": "private", "description": "Browses the server address space at the given node id.", "lineNumber": 226, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options", "description": "The options to use." } ], "return": { "types": [ "*" ] } }, { "__docId__": 416, "kind": "method", "name": "_browseNode", "memberof": "src/lib/server/NodeBrowser.js~NodeBrowser", "generator": false, "async": false, "static": false, "longname": "src/lib/server/NodeBrowser.js~NodeBrowser#_browseNode", "access": "private", "description": "Browses a node.", "lineNumber": 238, "params": [ { "nullable": null, "types": [ "BrowsedNode" ], "spread": false, "optional": false, "name": "node", "description": "The node to browse." } ], "return": { "types": [ "*" ] } }, { "__docId__": 418, "kind": "method", "name": "_push", "memberof": "src/lib/server/NodeBrowser.js~NodeBrowser", "generator": false, "async": true, "static": false, "longname": "src/lib/server/NodeBrowser.js~NodeBrowser#_push", "access": "private", "description": "Finishes processing a given node: After calling {@link NodeBrowser#_handleNode}, it resolves\nis's dependencies.", "lineNumber": 352, "params": [ { "nullable": null, "types": [ "BrowsedNode" ], "spread": false, "optional": false, "name": "node", "description": "The node handled." } ], "return": null }, { "__docId__": 420, "kind": "method", "name": "addNode", "memberof": "src/lib/server/NodeBrowser.js~NodeBrowser", "generator": false, "async": false, "static": false, "longname": "src/lib/server/NodeBrowser.js~NodeBrowser#addNode", "access": "public", "description": "Instructs the browser to handle a node that would otherwise be queued behind others (eg: its\nparent node).", "lineNumber": 404, "params": [ { "nullable": null, "types": [ "BrowsedNode" ], "spread": false, "optional": false, "name": "node", "description": "The node to add." } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "The fully processed node." } }, { "__docId__": 421, "kind": "method", "name": "_isExternalReference", "memberof": "src/lib/server/NodeBrowser.js~NodeBrowser", "generator": false, "async": false, "static": false, "longname": "src/lib/server/NodeBrowser.js~NodeBrowser#_isExternalReference", "access": "private", "description": "Returns `true` for node ids that should be treated as external references.", "lineNumber": 418, "params": [ { "nullable": null, "types": [ "string", "number" ], "spread": false, "optional": false, "name": "idValue", "description": "Value of the id to check." } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "If the id should be treated as external." } }, { "__docId__": 422, "kind": "method", "name": "_hasDependencies", "memberof": "src/lib/server/NodeBrowser.js~NodeBrowser", "generator": false, "async": false, "static": false, "longname": "src/lib/server/NodeBrowser.js~NodeBrowser#_hasDependencies", "access": "private", "description": "Returns `true` if a node has dependencies it should be queued behind.", "lineNumber": 427, "params": [ { "nullable": null, "types": [ "BrowsedNode" ], "spread": false, "optional": false, "name": "node", "description": "The node to check." } ], "return": { "types": [ "*" ] } }, { "__docId__": 423, "kind": "method", "name": "_process", "memberof": "src/lib/server/NodeBrowser.js~NodeBrowser", "generator": false, "async": true, "static": false, "longname": "src/lib/server/NodeBrowser.js~NodeBrowser#_process", "access": "private", "description": "Processes a single node: Requires special error handling.", "lineNumber": 454, "params": [ { "nullable": null, "types": [ "BrowsedNode" ], "spread": false, "optional": false, "name": "node", "description": "The node to process." } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "The fully processed node." } }, { "__docId__": 424, "kind": "method", "name": "_getSourceNodes", "memberof": "src/lib/server/NodeBrowser.js~NodeBrowser", "generator": false, "async": false, "static": false, "longname": "src/lib/server/NodeBrowser.js~NodeBrowser#_getSourceNodes", "access": "private", "description": "Discovers and browses the source nodes.", "lineNumber": 478, "params": [ { "nullable": null, "types": [ "Array" ], "spread": false, "optional": false, "name": "nodeIds", "description": "The source ids." } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "Resolved once finished." } }, { "__docId__": 425, "kind": "method", "name": "browse", "memberof": "src/lib/server/NodeBrowser.js~NodeBrowser", "generator": false, "async": true, "static": false, "longname": "src/lib/server/NodeBrowser.js~NodeBrowser#browse", "access": "public", "description": "Starts the browser of the given nodes.", "lineNumber": 522, "params": [ { "nullable": null, "types": [ "NodeId[]" ], "spread": false, "optional": false, "name": "nodeIds", "description": "The nodes to browse." } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "Resolved once all nodes are finished." } }, { "__docId__": 426, "kind": "member", "name": "_sourceNodesRegExp", "memberof": "src/lib/server/NodeBrowser.js~NodeBrowser", "static": false, "longname": "src/lib/server/NodeBrowser.js~NodeBrowser#_sourceNodesRegExp", "access": "private", "description": null, "lineNumber": 523, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 427, "kind": "member", "name": "_session", "memberof": "src/lib/server/NodeBrowser.js~NodeBrowser", "static": false, "longname": "src/lib/server/NodeBrowser.js~NodeBrowser#_session", "access": "private", "description": null, "lineNumber": 527, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 428, "kind": "member", "name": "_reject", "memberof": "src/lib/server/NodeBrowser.js~NodeBrowser", "static": false, "longname": "src/lib/server/NodeBrowser.js~NodeBrowser#_reject", "access": "private", "description": null, "lineNumber": 535, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 429, "kind": "file", "name": "src/lib/server/NodeStream.js", "content": "import { Readable } from 'stream';\nimport Logger from 'gulplog';\nimport Project from '../../config/ProjectConfig';\nimport NodeBrowser from './NodeBrowser';\n\n/**\n * A stream of server nodes.\n */\nexport default class NodeStream extends Readable {\n /**\n * Creates new node stream.\n * @param {NodeId[]} nodesToBrowse The nodes to browse.\n * @param {Object} [options] The options to use.\n * @param {boolean} [options.recursive] If the stream should recurse child nodes.\n * @param {NodeId[]} [options.ignoreNodes] The nodes to ignore.\n */\n constructor(nodesToBrowse, options = {}) {\n if (!nodesToBrowse || !(nodesToBrowse instanceof Array) || nodesToBrowse.length === 0) {\n throw new Error('nodesToBrowse is required');\n }\n\n if (options && options.ignoreNodes && !(options.ignoreNodes instanceof Array)) {\n throw new Error('ignoreNodes must be an array of node ids');\n }\n\n super(Object.assign({}, options, { objectMode: true }));\n\n // Handle options\n /**\n * If the discovered nodes should be browsed as well.\n * @type {Boolean}\n */\n this.recursive = true;\n if (options.recursive !== undefined) {\n this.recursive = options.recursive;\n }\n\n let ignoreNodes = Project.ignoreNodes;\n if (options.ignoreNodes !== undefined) {\n ignoreNodes = options.ignoreNodes;\n }\n\n /**\n * The timestamp when the stream started.\n * @type {number}\n */\n this._start = Date.now();\n\n const nodes = nodesToBrowse.filter((nodeId) => {\n // FIXME: Move to node browser and implement\n const ignored = false && this.isIgnored({ nodeId });\n\n if (ignored) {\n Logger.warn(`${nodeId} is set to be browsed, but ignored.`);\n Logger.info(` - Remove ${nodeId} from Atviseproject#nodes if this is intentionally.`);\n }\n\n return !ignored;\n });\n\n if (!nodes.length) {\n throw new Error('Nothing to browse');\n }\n\n /**\n * If the stream is destroyed.\n * @type {boolean}\n */\n this._isDestroyed = false;\n\n // Write nodes to read\n\n /**\n * The stream's browser\n * @type {NodeBrowser}\n */\n this._browser = new NodeBrowser({\n nodes,\n ignoreNodes,\n recursive: options.recursive === undefined ? true : options.recursive,\n });\n\n this._browser.onNode = (node) => {\n if (node.nodeId.match(/\\s$/)) {\n Logger.warn(`Node '${node.nodeId}' has trailing spaces in it's name.`);\n Logger.info(' - Rename it to prevent errors on windows.');\n }\n if (!this.push(node)) {\n this._browser.stop();\n }\n };\n\n this._browser.onEnd = () => {\n this.push(null);\n this.destroy();\n };\n\n this._browser.onError = (err) => {\n if (this.isDestroyed) {\n return;\n }\n this.emit('error', err);\n this.destroy();\n };\n }\n\n /**\n * If the stream is destoyed.\n * @type {boolean}\n */\n get isDestroyed() {\n return this._isDestroyed;\n }\n\n /**\n * Starts the browser.\n */\n _read() {\n this._browser.start();\n }\n\n /**\n * Destroys the stream.\n * @param {?Error} err The error that caused the destroy.\n * @param {function(err: ?Error): void} callback Called once finished.\n */\n _destroy(err, callback) {\n this._isDestroyed = true;\n\n super.destroy(err, () => {\n this._browser\n .destroy()\n .then(() => callback(err))\n .catch((destroyErr) => callback(err || destroyErr));\n });\n }\n\n /**\n * The number of processed nodes.\n * @type {number}\n */\n get processed() {\n return this._browser._pushed.size;\n }\n\n /**\n * The number of processed chunks per second.\n * @type {number}\n */\n get opsPerSecond() {\n return this.processed / ((Date.now() - this._start) / 1000) || 0;\n }\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/lib/server/NodeStream.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 430, "kind": "class", "name": "NodeStream", "memberof": "src/lib/server/NodeStream.js", "static": true, "longname": "src/lib/server/NodeStream.js~NodeStream", "access": "public", "export": true, "importPath": "atscm/src/lib/server/NodeStream.js", "importStyle": "NodeStream", "description": "A stream of server nodes.", "lineNumber": 9, "interface": false, "extends": [ "stream~Readable" ] }, { "__docId__": 431, "kind": "constructor", "name": "constructor", "memberof": "src/lib/server/NodeStream.js~NodeStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/NodeStream.js~NodeStream#constructor", "access": "public", "description": "Creates new node stream.", "lineNumber": 17, "params": [ { "nullable": null, "types": [ "NodeId[]" ], "spread": false, "optional": false, "name": "nodesToBrowse", "description": "The nodes to browse." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "The options to use." }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": true, "name": "options.recursive", "description": "If the stream should recurse child nodes." }, { "nullable": null, "types": [ "NodeId[]" ], "spread": false, "optional": true, "name": "options.ignoreNodes", "description": "The nodes to ignore." } ] }, { "__docId__": 432, "kind": "member", "name": "recursive", "memberof": "src/lib/server/NodeStream.js~NodeStream", "static": false, "longname": "src/lib/server/NodeStream.js~NodeStream#recursive", "access": "public", "description": "If the discovered nodes should be browsed as well.", "lineNumber": 33, "type": { "nullable": null, "types": [ "Boolean" ], "spread": false, "description": null } }, { "__docId__": 434, "kind": "member", "name": "_start", "memberof": "src/lib/server/NodeStream.js~NodeStream", "static": false, "longname": "src/lib/server/NodeStream.js~NodeStream#_start", "access": "private", "description": "The timestamp when the stream started.", "lineNumber": 47, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 435, "kind": "member", "name": "_isDestroyed", "memberof": "src/lib/server/NodeStream.js~NodeStream", "static": false, "longname": "src/lib/server/NodeStream.js~NodeStream#_isDestroyed", "access": "private", "description": "If the stream is destroyed.", "lineNumber": 69, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 436, "kind": "member", "name": "_browser", "memberof": "src/lib/server/NodeStream.js~NodeStream", "static": false, "longname": "src/lib/server/NodeStream.js~NodeStream#_browser", "access": "private", "description": "The stream's browser", "lineNumber": 77, "type": { "nullable": null, "types": [ "NodeBrowser" ], "spread": false, "description": null } }, { "__docId__": 437, "kind": "get", "name": "isDestroyed", "memberof": "src/lib/server/NodeStream.js~NodeStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/NodeStream.js~NodeStream#isDestroyed", "access": "public", "description": "If the stream is destoyed.", "lineNumber": 111, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 438, "kind": "method", "name": "_read", "memberof": "src/lib/server/NodeStream.js~NodeStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/NodeStream.js~NodeStream#_read", "access": "private", "description": "Starts the browser.", "lineNumber": 118, "params": [], "return": null }, { "__docId__": 439, "kind": "method", "name": "_destroy", "memberof": "src/lib/server/NodeStream.js~NodeStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/NodeStream.js~NodeStream#_destroy", "access": "private", "description": "Destroys the stream.", "lineNumber": 127, "params": [ { "nullable": true, "types": [ "Error" ], "spread": false, "optional": false, "name": "err", "description": "The error that caused the destroy." }, { "nullable": null, "types": [ "function(err: ?Error): void" ], "spread": false, "optional": false, "name": "callback", "description": "Called once finished." } ], "return": null }, { "__docId__": 441, "kind": "get", "name": "processed", "memberof": "src/lib/server/NodeStream.js~NodeStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/NodeStream.js~NodeStream#processed", "access": "public", "description": "The number of processed nodes.", "lineNumber": 142, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 442, "kind": "get", "name": "opsPerSecond", "memberof": "src/lib/server/NodeStream.js~NodeStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/NodeStream.js~NodeStream#opsPerSecond", "access": "public", "description": "The number of processed chunks per second.", "lineNumber": 150, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 443, "kind": "file", "name": "src/lib/server/QueueStream.js", "content": "/* Needed as long as https://github.com/gajus/eslint-plugin-jsdoc/issues/56 is open */\n/* eslint-disable jsdoc/check-param-names */\n\nimport { StatusCodes } from 'node-opcua/lib/datamodel/opcua_status_code';\nimport Logger from 'gulplog';\nimport Stream from './Stream';\n\n/**\n * A stream that process atvise server requests in parallel.\n * @abstract\n */\nexport default class QueueStream extends Stream {\n /**\n * Creates a new QueueStream with the given options.\n * @param {Object} [options] The options to use.\n * @param {number} [options.maxParallel] The maximum of parallel tasks to execute.\n */\n constructor(options = {}) {\n const maxParallel = options.maxParallel || 250;\n super(Object.assign(options, { highWaterMark: maxParallel }));\n\n /**\n * The number of running operations.\n * @type {Number}\n */\n this._processing = 0;\n\n /**\n * The number of chunks processed so far.\n * @type {Number}\n */\n this._processed = 0;\n\n /**\n * The queued chunks.\n * @type {*[]}\n */\n this._queued = [];\n\n /**\n * The maximum of parallel tasks to execute\n * @type {number}\n */\n this._maxParallel = maxParallel;\n\n /**\n * The timestamp of the date when the stream was created.\n * @type {Number}\n */\n this._start = new Date().getTime();\n\n this.on('processed-chunk', () => {\n if (!this.queueEmpty) {\n this._processChunk(this._queued.shift());\n } else if (this._processing === 0) {\n this.emit('drained');\n }\n });\n }\n\n /**\n * `true` if there are queued operations or an operation is running right now.\n * @type {boolean}\n */\n get hasPending() {\n return this._processing > 0 || this._queued.length > 0;\n }\n\n /**\n * `true` if there are no queued operations.\n * @type {boolean}\n */\n get queueEmpty() {\n return this._queued.length === 0;\n }\n\n /**\n * The number of chunks already processed.\n * @type {number}\n */\n get processed() {\n return this._processed;\n }\n\n /**\n * The number of processed chunks per second.\n * @type {number}\n */\n get opsPerSecond() {\n return this._processed / ((new Date().getTime() - this._start) / 1000) || 0;\n }\n\n /**\n * The error message to use when processing a chunk fails. **Must be overridden by all\n * subclasses!**.\n * @param {*} chunk The chunk being processed.\n * @return {string} The error message to use.\n * @abstract\n */\n // eslint-disable-next-line no-unused-vars\n processErrorMessage(chunk) {\n throw new Error('QueueStream#processErrorMessage must be implemented by all subclasses');\n }\n\n /**\n * The function to call when a chunk is ready to be processed. **Must be overridden by all\n * subclasses.**.\n * @param {*} chunk The chunk to process.\n * @param {function(err: Error, statusCode: node-opcua~StatusCodes, onSuccess: function)}\n * handleErrors Call this function to handle errors and bad status codes. When no error occured\n * and the status code received is fine, `onSuccess` is called. Further processing of valid\n * chunks, for example Recursions should happen in `onSuccess`. **Note that `onSuccess` is an\n * asynchronous function with a callback as an argument.**.\n * @example Basic implementation\n * class MyQueueStream extends QueueStream {\n * ...\n * processChunk(chunk, handle) {\n * client.session.doSomething((err, result, statusCode) => handle(err, statusCode, done => {\n * // This is called if err is falsy and status code is node-opcua~StatusCodes.Good\n * doSomethingWith(result);\n * done();\n * }));\n * }\n * ...\n * }\n * @example Implement a recursion\n * class RecursiveQueueStream extends QueueStream {\n * ...\n * processChunk(chunk, handle) {\n * client.session.doSomething((err, result, statusCode) => handle(err, statusCode, done => {\n * // Write the result back to the stream.\n * // This means, that `result` will be queued and, as soon as possible, #processChunk will\n * // be called with `result` as the `chunk` argument.\n * this.write(result, null, done);\n * }));\n * }\n * ...\n * }\n * @example Allowing some invalid status codes\n * import { StatusCodes } from 'node-opcua';\n *\n * class FriendlyQueueStream extends QueueStream {\n * ...\n * processChunk(chunk, handle) {\n * client.session.doSomething((err, result, statusCode) => {\n * if (statusCode === StatusCodes.BadUserAccessDenied) {\n * Logger.warn(`Ignored invalid status: ${statusCode.description}`);\n * handle(err, StatusCodes.Good, done => done());\n * } else {\n * handle(err, statusCode, done => done());\n * }\n * });\n * }\n * ...\n * }\n * @abstract\n */\n processChunk(chunk, handleErrors) {\n // eslint-disable-line no-unused-vars\n handleErrors(new Error('QueueStream#processChunk must be implemented by all subclasses'));\n }\n\n /**\n * Calls {@link QueueStream#processChunk} and handles errors and invalid status codes.\n * @param {*} chunk The chunk to process.\n * @emits {*} Emits a `processed-chunk` event once a chunk was processed.\n */\n _processChunk(chunk) {\n this._processing++;\n\n this.processChunk(chunk, (err, statusCode, onSuccess) => {\n const finished = (error) => {\n this._processing--;\n this._processed++;\n this.emit('processed-chunk', chunk, error);\n };\n\n let error = err;\n\n if (err) {\n const message = `${this.processErrorMessage(chunk)}: ${err.message}`;\n\n if (process.env.CONTINUE_ON_FAILURE === 'true') {\n Logger.error(`FAILURE: ${message}`);\n } else {\n this.emit('error', Object.assign(err, { message }));\n }\n } else if (statusCode !== StatusCodes.Good) {\n const message = `${this.processErrorMessage(chunk)}: ${statusCode.description}`;\n error = new Error(message);\n\n if (process.env.CONTINUE_ON_FAILURE === 'true') {\n Logger.error(`FAILURE: ${message}`);\n } else {\n this.emit('error', new Error(message));\n }\n } else {\n onSuccess(finished);\n return;\n }\n\n finished(error);\n });\n }\n\n /**\n * Enqueues the given chunk for processing.\n * @param {*} chunk The chunk to enqueue.\n */\n _enqueueChunk(chunk) {\n if (this._processing < this._maxParallel) {\n this._processChunk(chunk);\n } else {\n this._queued.push(chunk);\n }\n }\n\n /**\n * Calls {@link QueueStream#_enqueueChunk} as soon as the stream's session is opened.\n * @param {*} chunk The chunk to transform.\n * @param {string} enc The encoding used.\n * @param {Function} callback Called once the chunk has been enqueued.\n */\n _transform(chunk, enc, callback) {\n if (this.session) {\n this._enqueueChunk(chunk);\n callback();\n } else {\n this.once('session-open', () => {\n this._enqueueChunk(chunk);\n callback();\n });\n }\n }\n\n /**\n * Waits for pending operations to complete.\n * @param {Function} callback Called once all queued chunks have been processed.\n */\n _flush(callback) {\n if (this.hasPending) {\n this.once('drained', () => {\n super._flush(callback);\n });\n } else {\n super._flush(callback);\n }\n }\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/lib/server/QueueStream.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 444, "kind": "class", "name": "QueueStream", "memberof": "src/lib/server/QueueStream.js", "static": true, "longname": "src/lib/server/QueueStream.js~QueueStream", "access": "public", "export": true, "importPath": "atscm/src/lib/server/QueueStream.js", "importStyle": "QueueStream", "description": "A stream that process atvise server requests in parallel.", "lineNumber": 12, "abstract": true, "interface": false, "extends": [ "src/lib/server/Stream.js~Stream" ] }, { "__docId__": 445, "kind": "constructor", "name": "constructor", "memberof": "src/lib/server/QueueStream.js~QueueStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/QueueStream.js~QueueStream#constructor", "access": "public", "description": "Creates a new QueueStream with the given options.", "lineNumber": 18, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "The options to use." }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": true, "name": "options.maxParallel", "description": "The maximum of parallel tasks to execute." } ] }, { "__docId__": 446, "kind": "member", "name": "_processing", "memberof": "src/lib/server/QueueStream.js~QueueStream", "static": false, "longname": "src/lib/server/QueueStream.js~QueueStream#_processing", "access": "private", "description": "The number of running operations.", "lineNumber": 26, "type": { "nullable": null, "types": [ "Number" ], "spread": false, "description": null } }, { "__docId__": 447, "kind": "member", "name": "_processed", "memberof": "src/lib/server/QueueStream.js~QueueStream", "static": false, "longname": "src/lib/server/QueueStream.js~QueueStream#_processed", "access": "private", "description": "The number of chunks processed so far.", "lineNumber": 32, "type": { "nullable": null, "types": [ "Number" ], "spread": false, "description": null } }, { "__docId__": 448, "kind": "member", "name": "_queued", "memberof": "src/lib/server/QueueStream.js~QueueStream", "static": false, "longname": "src/lib/server/QueueStream.js~QueueStream#_queued", "access": "private", "description": "The queued chunks.", "lineNumber": 38, "type": { "nullable": null, "types": [ "*[]" ], "spread": false, "description": null } }, { "__docId__": 449, "kind": "member", "name": "_maxParallel", "memberof": "src/lib/server/QueueStream.js~QueueStream", "static": false, "longname": "src/lib/server/QueueStream.js~QueueStream#_maxParallel", "access": "private", "description": "The maximum of parallel tasks to execute", "lineNumber": 44, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 450, "kind": "member", "name": "_start", "memberof": "src/lib/server/QueueStream.js~QueueStream", "static": false, "longname": "src/lib/server/QueueStream.js~QueueStream#_start", "access": "private", "description": "The timestamp of the date when the stream was created.", "lineNumber": 50, "type": { "nullable": null, "types": [ "Number" ], "spread": false, "description": null } }, { "__docId__": 451, "kind": "get", "name": "hasPending", "memberof": "src/lib/server/QueueStream.js~QueueStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/QueueStream.js~QueueStream#hasPending", "access": "public", "description": "`true` if there are queued operations or an operation is running right now.", "lineNumber": 65, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 452, "kind": "get", "name": "queueEmpty", "memberof": "src/lib/server/QueueStream.js~QueueStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/QueueStream.js~QueueStream#queueEmpty", "access": "public", "description": "`true` if there are no queued operations.", "lineNumber": 73, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 453, "kind": "get", "name": "processed", "memberof": "src/lib/server/QueueStream.js~QueueStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/QueueStream.js~QueueStream#processed", "access": "public", "description": "The number of chunks already processed.", "lineNumber": 81, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 454, "kind": "get", "name": "opsPerSecond", "memberof": "src/lib/server/QueueStream.js~QueueStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/QueueStream.js~QueueStream#opsPerSecond", "access": "public", "description": "The number of processed chunks per second.", "lineNumber": 89, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 455, "kind": "method", "name": "processErrorMessage", "memberof": "src/lib/server/QueueStream.js~QueueStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/QueueStream.js~QueueStream#processErrorMessage", "access": "public", "description": "The error message to use when processing a chunk fails. **Must be overridden by all\nsubclasses!**.", "lineNumber": 101, "params": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "chunk", "description": "The chunk being processed." } ], "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "The error message to use." }, "abstract": true }, { "__docId__": 456, "kind": "method", "name": "processChunk", "memberof": "src/lib/server/QueueStream.js~QueueStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/QueueStream.js~QueueStream#processChunk", "access": "public", "description": "The function to call when a chunk is ready to be processed. **Must be overridden by all\nsubclasses.**.", "examples": [ "Basic implementation\nclass MyQueueStream extends QueueStream {\n ...\n processChunk(chunk, handle) {\n client.session.doSomething((err, result, statusCode) => handle(err, statusCode, done => {\n // This is called if err is falsy and status code is node-opcua~StatusCodes.Good\n doSomethingWith(result);\n done();\n }));\n }\n ...\n}", "Implement a recursion\nclass RecursiveQueueStream extends QueueStream {\n ...\n processChunk(chunk, handle) {\n client.session.doSomething((err, result, statusCode) => handle(err, statusCode, done => {\n // Write the result back to the stream.\n // This means, that `result` will be queued and, as soon as possible, #processChunk will\n // be called with `result` as the `chunk` argument.\n this.write(result, null, done);\n }));\n }\n ...\n}", "Allowing some invalid status codes\nimport { StatusCodes } from 'node-opcua';\n\nclass FriendlyQueueStream extends QueueStream {\n ...\n processChunk(chunk, handle) {\n client.session.doSomething((err, result, statusCode) => {\n if (statusCode === StatusCodes.BadUserAccessDenied) {\n Logger.warn(`Ignored invalid status: ${statusCode.description}`);\n handle(err, StatusCodes.Good, done => done());\n } else {\n handle(err, statusCode, done => done());\n }\n });\n }\n ...\n}" ], "lineNumber": 158, "params": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "chunk", "description": "The chunk to process." }, { "nullable": null, "types": [ "function(err: Error, statusCode: node-opcua~StatusCodes, onSuccess: function)" ], "spread": false, "optional": false, "name": "handleErrors", "description": "Call this function to handle errors and bad status codes. When no error occured\nand the status code received is fine, `onSuccess` is called. Further processing of valid\nchunks, for example Recursions should happen in `onSuccess`. **Note that `onSuccess` is an\nasynchronous function with a callback as an argument.**." } ], "abstract": true, "return": null }, { "__docId__": 457, "kind": "method", "name": "_processChunk", "memberof": "src/lib/server/QueueStream.js~QueueStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/QueueStream.js~QueueStream#_processChunk", "access": "private", "description": "Calls {@link QueueStream#processChunk} and handles errors and invalid status codes.", "lineNumber": 168, "params": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "chunk", "description": "The chunk to process." } ], "emits": [ { "types": [ "*" ], "description": "Emits a `processed-chunk` event once a chunk was processed." } ], "return": null }, { "__docId__": 458, "kind": "method", "name": "_enqueueChunk", "memberof": "src/lib/server/QueueStream.js~QueueStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/QueueStream.js~QueueStream#_enqueueChunk", "access": "private", "description": "Enqueues the given chunk for processing.", "lineNumber": 210, "params": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "chunk", "description": "The chunk to enqueue." } ], "return": null }, { "__docId__": 459, "kind": "method", "name": "_transform", "memberof": "src/lib/server/QueueStream.js~QueueStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/QueueStream.js~QueueStream#_transform", "access": "private", "description": "Calls {@link QueueStream#_enqueueChunk} as soon as the stream's session is opened.", "lineNumber": 224, "params": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "chunk", "description": "The chunk to transform." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "enc", "description": "The encoding used." }, { "nullable": null, "types": [ "Function" ], "spread": false, "optional": false, "name": "callback", "description": "Called once the chunk has been enqueued." } ], "return": null }, { "__docId__": 460, "kind": "method", "name": "_flush", "memberof": "src/lib/server/QueueStream.js~QueueStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/QueueStream.js~QueueStream#_flush", "access": "private", "description": "Waits for pending operations to complete.", "lineNumber": 240, "params": [ { "nullable": null, "types": [ "Function" ], "spread": false, "optional": false, "name": "callback", "description": "Called once all queued chunks have been processed." } ], "return": null }, { "__docId__": 461, "kind": "file", "name": "src/lib/server/Session.js", "content": "import { join } from 'path';\nimport Emitter from 'events';\nimport { StatusCodes } from 'node-opcua/lib/datamodel/opcua_status_code';\nimport { OPCUAClient, ClientSession } from 'node-opcua/lib/client/opcua_client';\nimport Logger from 'gulplog';\nimport ProjectConfig from '../../config/ProjectConfig';\nimport { promisified } from '../helpers/async';\n\n/**\n * The currently open sessions.\n * @type {Set}\n */\nconst openSessions = new Set();\n\n/**\n * The sessions currentyl being opened.\n * @type {Set}\n */\nconst openingSessions = new Set();\n\n/**\n * A wrapper around {@link node-opcua~ClientSession} used to connect to atvise server.\n * The sessions currentyl being opened.\n * @type {Set}\n */\nexport default class Session {\n /**\n * Creates an {@link node-opcuaOPCUAClient} and opens a new {@link node-opcua~ClientSession}.\n * @return {Promise} Fulfilled with an already opened\n * {@link node-opcua~ClientSession}.\n */\n static async _create() {\n const client = new OPCUAClient({\n requestedSessionTimeout: 600000,\n keepSessionAlive: true,\n certificateFile: join(__dirname, '../../../res/certificates/certificate.pem'),\n privateKeyFile: join(__dirname, '../../../res/certificates/key.pem'),\n });\n\n const endpoint = `opc.tcp://${ProjectConfig.host}:${ProjectConfig.port.opc}`;\n\n const timer = setTimeout(() => {\n Logger.warn(`It takes unusually long to connect to the atvise server at ${endpoint}.\n - Are you sure it is running?`);\n }, ProjectConfig.timeout);\n\n await promisified((cb) => client.connect(endpoint, cb));\n Logger.debug(`Connected to ${endpoint}`);\n clearTimeout(timer);\n\n const session = await promisified((cb) =>\n client.createSession(\n {\n userName: ProjectConfig.login.username,\n password: ProjectConfig.login.password,\n },\n cb\n )\n ).catch((err) => {\n if (\n [\n 'userName === null || typeof userName === \"string\"',\n 'password === null || typeof password === \"string\"',\n ].includes(err.message) ||\n (err.response &&\n err.response.responseHeader.serviceResult === StatusCodes.BadUserAccessDenied)\n ) {\n throw new Error('Unable to create session: Invalid login');\n }\n\n throw err;\n });\n\n openSessions.add(session);\n return Object.assign(session, { _emitter: new Emitter() });\n }\n\n /**\n * Creates an {@link node-opcuaOPCUAClient} and opens a new {@link node-opcua~ClientSession}. If\n * pooling is active, the shared session will be reused.\n * @return {Promise} Fulfilled with an already opened\n * {@link node-opcua~ClientSession}.\n */\n static create() {\n const create = () => {\n const c = this._create();\n openingSessions.add(c);\n\n return c.then((s) => openingSessions.delete(c) && s);\n };\n\n if (!this._pool) {\n return create();\n }\n\n if (!this._createShared) {\n /**\n * A promise that resolves once the shared session is created.\n * @type {Promise} Fulfilled with the (now closed!) session or\n * rejected with the error that occured while closing.\n */\n static async _close(session) {\n openSessions.delete(session);\n\n await new Promise((resolve) => session.close(true, () => resolve()));\n await new Promise((resolve) => session._client && session._client.disconnect(() => resolve()));\n\n return session;\n }\n\n /**\n * Closes the given session. When session pooling is active the session won't actually be closed\n * and the returned Promise will resolve immediately.\n * @param {node-opcua~ClientSession} session The session to close.\n * @return {Promise} Fulfilled with the (maybe closed) session or\n * rejected with the error that occured while closing.\n */\n static close(session) {\n if (!session || !(session instanceof ClientSession)) {\n return Promise.reject(new Error('session is required'));\n }\n\n if (this._pool) {\n return Promise.resolve();\n }\n\n return this._close(session);\n }\n\n /**\n * The sessions currently open. Starting with version 1.0.0-beta.25 there will be one at most.\n * @type {Session[]}\n */\n static get open() {\n return Array.from(openSessions);\n }\n\n /**\n * Closes all open sessions.\n * @return {Promise} Rejected with the error that occurred while closing the\n * sessions or fulfilled with the (now closed) sessions affected.\n */\n static async closeOpen() {\n await Promise.all(openingSessions);\n\n return Promise.all(Array.from(openSessions).map((session) => this._close(session)));\n }\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/lib/server/Session.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 462, "kind": "variable", "name": "openSessions", "memberof": "src/lib/server/Session.js", "static": true, "longname": "src/lib/server/Session.js~openSessions", "access": "public", "export": false, "importPath": "atscm/src/lib/server/Session.js", "importStyle": null, "description": "The currently open sessions.", "lineNumber": 13, "type": { "nullable": null, "types": [ "Set" ], "spread": false, "description": null }, "ignore": true }, { "__docId__": 463, "kind": "variable", "name": "openingSessions", "memberof": "src/lib/server/Session.js", "static": true, "longname": "src/lib/server/Session.js~openingSessions", "access": "public", "export": false, "importPath": "atscm/src/lib/server/Session.js", "importStyle": null, "description": "The sessions currentyl being opened.", "lineNumber": 19, "type": { "nullable": null, "types": [ "Set" ], "spread": false, "description": null }, "ignore": true }, { "__docId__": 464, "kind": "class", "name": "Session", "memberof": "src/lib/server/Session.js", "static": true, "longname": "src/lib/server/Session.js~Session", "access": "public", "export": true, "importPath": "atscm/src/lib/server/Session.js", "importStyle": "Session", "description": "A wrapper around {@link node-opcua~ClientSession} used to connect to atvise server.\nThe sessions currentyl being opened.", "lineNumber": 26, "type": { "nullable": null, "types": [ "Set" ], "spread": false, "description": null }, "interface": false }, { "__docId__": 465, "kind": "method", "name": "_create", "memberof": "src/lib/server/Session.js~Session", "generator": false, "async": true, "static": true, "longname": "src/lib/server/Session.js~Session._create", "access": "private", "description": "Creates an {@link node-opcuaOPCUAClient} and opens a new {@link node-opcua~ClientSession}.", "lineNumber": 32, "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "Fulfilled with an already opened\n{@link node-opcua~ClientSession}." }, "params": [] }, { "__docId__": 466, "kind": "method", "name": "create", "memberof": "src/lib/server/Session.js~Session", "generator": false, "async": false, "static": true, "longname": "src/lib/server/Session.js~Session.create", "access": "public", "description": "Creates an {@link node-opcuaOPCUAClient} and opens a new {@link node-opcua~ClientSession}. If\npooling is active, the shared session will be reused.", "lineNumber": 84, "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "Fulfilled with an already opened\n{@link node-opcua~ClientSession}." }, "params": [] }, { "__docId__": 467, "kind": "member", "name": "_createShared", "memberof": "src/lib/server/Session.js~Session", "static": true, "longname": "src/lib/server/Session.js~Session._createShared", "access": "private", "description": "A promise that resolves once the shared session is created.", "lineNumber": 101, "type": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "Fulfilled with the (now closed!) session or\nrejected with the error that occured while closing." } }, { "__docId__": 471, "kind": "method", "name": "close", "memberof": "src/lib/server/Session.js~Session", "generator": false, "async": false, "static": true, "longname": "src/lib/server/Session.js~Session.close", "access": "public", "description": "Closes the given session. When session pooling is active the session won't actually be closed\nand the returned Promise will resolve immediately.", "lineNumber": 142, "params": [ { "nullable": null, "types": [ "node-opcua~ClientSession" ], "spread": false, "optional": false, "name": "session", "description": "The session to close." } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "Fulfilled with the (maybe closed) session or\nrejected with the error that occured while closing." } }, { "__docId__": 472, "kind": "get", "name": "open", "memberof": "src/lib/server/Session.js~Session", "generator": false, "async": false, "static": true, "longname": "src/lib/server/Session.js~Session.open", "access": "public", "description": "The sessions currently open. Starting with version 1.0.0-beta.25 there will be one at most.", "lineNumber": 158, "type": { "nullable": null, "types": [ "Session[]" ], "spread": false, "description": null } }, { "__docId__": 473, "kind": "method", "name": "closeOpen", "memberof": "src/lib/server/Session.js~Session", "generator": false, "async": true, "static": true, "longname": "src/lib/server/Session.js~Session.closeOpen", "access": "public", "description": "Closes all open sessions.", "lineNumber": 167, "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "Rejected with the error that occurred while closing the\nsessions or fulfilled with the (now closed) sessions affected." }, "params": [] }, { "__docId__": 474, "kind": "file", "name": "src/lib/server/Stream.js", "content": "import { ctor as throughStreamClass } from 'through2';\nimport Session from './Session';\n\n/**\n * An object transform stream connected to atvise server.\n */\nexport default class Stream extends throughStreamClass({ objectMode: true }) {\n /**\n * Creates a new Stream and starts opening a new session to atvise server.\n * @param {Object} [options] The options to use. See the through2 documentation for details.\n * @param {boolean} [options.keepSessionAlive=false] If the ativse server session should be closed\n * one the stream ends.\n * @emits {Session} Emits an `session-open` event once the session is open, passing the Session\n * instance.\n * @see https://github.Com/rvagg/through2#options\n */\n constructor(options = {}) {\n super(options);\n\n /**\n * `true` if the stream's atvise server session should be kept alive once the stream ends.\n * @type {Boolean}\n */\n this._keepSessionAlive = options.keepSessionAlive || false;\n\n Session.create()\n .then((session) => (this.session = session))\n .then((session) => this.emit('session-open', session))\n .catch((err) => this.emit('error', err));\n }\n\n /**\n * Called just before the stream is closed: Closes the open session.\n * @param {function(err: ?Error, data: Object)} callback Called once the session is closed.\n */\n _flush(callback) {\n if (this.session && !this._keepSessionAlive) {\n Session.close(this.session)\n .then(() => callback())\n .catch((err) => callback(err));\n } else {\n callback();\n }\n }\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/lib/server/Stream.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 475, "kind": "class", "name": "Stream", "memberof": "src/lib/server/Stream.js", "static": true, "longname": "src/lib/server/Stream.js~Stream", "access": "public", "export": true, "importPath": "atscm/src/lib/server/Stream.js", "importStyle": "Stream", "description": "An object transform stream connected to atvise server.", "lineNumber": 7, "interface": false, "expressionExtends": "throughStreamClass({ objectMode: true })" }, { "__docId__": 476, "kind": "constructor", "name": "constructor", "memberof": "src/lib/server/Stream.js~Stream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/Stream.js~Stream#constructor", "access": "public", "description": "Creates a new Stream and starts opening a new session to atvise server.", "see": [ "https://github.Com/rvagg/through2#options" ], "lineNumber": 17, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "The options to use. See the through2 documentation for details." }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.keepSessionAlive", "description": "If the ativse server session should be closed\none the stream ends." } ], "emits": [ { "types": [ "Session" ], "description": "Emits an `session-open` event once the session is open, passing the Session\ninstance." } ] }, { "__docId__": 477, "kind": "member", "name": "_keepSessionAlive", "memberof": "src/lib/server/Stream.js~Stream", "static": false, "longname": "src/lib/server/Stream.js~Stream#_keepSessionAlive", "access": "private", "description": "`true` if the stream's atvise server session should be kept alive once the stream ends.", "lineNumber": 24, "type": { "nullable": null, "types": [ "Boolean" ], "spread": false, "description": null } }, { "__docId__": 478, "kind": "method", "name": "_flush", "memberof": "src/lib/server/Stream.js~Stream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/Stream.js~Stream#_flush", "access": "private", "description": "Called just before the stream is closed: Closes the open session.", "lineNumber": 36, "params": [ { "nullable": null, "types": [ "function(err: ?Error, data: Object)" ], "spread": false, "optional": false, "name": "callback", "description": "Called once the session is closed." } ], "return": null }, { "__docId__": 479, "kind": "file", "name": "src/lib/server/Types.js", "content": "import { DataType } from 'node-opcua/lib/datamodel/variant';\nimport NodeId from '../model/opcua/NodeId';\n\n/**\n * Special, atvise releated OPC-UA type.\n */\nclass AtviseType {\n /**\n * Creates a new atvise type.\n * @param {string} nodeIdValue The type's OPC-UA node id value.\n * @param {string} identifier Atscm's identifier for the new type.\n * @param {node-opcua~DataType} dataType The type's parent OPC-UA type.\n * @param {string|boolean} [fileExtensionOrKeep] The file extension to use when storing or `true`\n * or `false` indicating if the extension should be kept.\n */\n constructor(nodeIdValue, identifier, dataType, fileExtensionOrKeep) {\n /**\n * Node id of the type's definition\n * @type {node-opcua~NodeId}\n */\n this.typeDefinition = new NodeId(`VariableTypes.ATVISE.${nodeIdValue}`);\n\n /**\n * Atscm's identifier for the type.\n * @type {String}\n */\n this.identifier = identifier;\n /**\n * The type's parent OPC-UA type.\n * @type {node-opcua~DataType}\n */\n this.dataType = dataType;\n if (fileExtensionOrKeep !== undefined) {\n if (typeof fileExtensionOrKeep === 'string') {\n /**\n * The file extension to use when storing.\n * @type {String}\n */\n this.fileExtension = fileExtensionOrKeep;\n } else {\n /**\n * If the extension should be kept when storing.\n * @type {Boolean}\n */\n this.keepExtension = fileExtensionOrKeep;\n }\n }\n }\n}\n\n/**\n * An atvise-related resource type.\n */\nexport class AtviseResourceType extends AtviseType {\n /**\n * Creates a new resource type.\n * @param {string} name The type's OPC-UA node id value.\n * @param {string} identifier Atscm's identifier for the new type.\n */\n constructor(name, identifier) {\n super(`Resource.${name}`, identifier, DataType.ByteString, true);\n }\n}\n\n/**\n * The atvise types to handle. **Ordering matters:** The {@link MappingTransformer} takes the first\n * match, therefore **plain types should always come before resource types!**\n * @type {AtviseType[]}\n */\nconst AtviseTypes = [\n new AtviseType('HtmlHelp', 'help', DataType.ByteString, 'html'),\n new AtviseType('QuickDynamic', 'qd', DataType.XmlElement),\n new AtviseType('ScriptCode', 'script', DataType.XmlElement),\n new AtviseType('Display', 'display', DataType.XmlElement),\n new AtviseType('TranslationTable', 'locs', DataType.XmlElement),\n new AtviseResourceType('Pdf', 'pdf'),\n new AtviseResourceType('Html', 'html'),\n new AtviseResourceType('Html', 'htm'),\n new AtviseResourceType('Javascript', 'js'),\n new AtviseResourceType('Wave', 'wav'),\n new AtviseResourceType('Gif', 'gif'),\n new AtviseResourceType('Png', 'png'),\n new AtviseResourceType('Aac', 'm4a'),\n new AtviseResourceType('Ogg', 'ogg'),\n new AtviseResourceType('Icon', 'ico'),\n new AtviseResourceType('Css', 'css'),\n new AtviseResourceType('Svg', 'svg'),\n new AtviseResourceType('Jpeg', 'jpg'),\n new AtviseResourceType('OctetStream', '*'),\n];\n\nexport default AtviseTypes;\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/lib/server/Types.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 480, "kind": "class", "name": "AtviseType", "memberof": "src/lib/server/Types.js", "static": true, "longname": "src/lib/server/Types.js~AtviseType", "access": "public", "export": false, "importPath": "atscm/src/lib/server/Types.js", "importStyle": null, "description": "Special, atvise releated OPC-UA type.", "lineNumber": 7, "interface": false, "ignore": true }, { "__docId__": 481, "kind": "constructor", "name": "constructor", "memberof": "src/lib/server/Types.js~AtviseType", "generator": false, "async": false, "static": false, "longname": "src/lib/server/Types.js~AtviseType#constructor", "access": "public", "description": "Creates a new atvise type.", "lineNumber": 16, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "nodeIdValue", "description": "The type's OPC-UA node id value." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "identifier", "description": "Atscm's identifier for the new type." }, { "nullable": null, "types": [ "node-opcua~DataType" ], "spread": false, "optional": false, "name": "dataType", "description": "The type's parent OPC-UA type." }, { "nullable": null, "types": [ "string", "boolean" ], "spread": false, "optional": true, "name": "fileExtensionOrKeep", "description": "The file extension to use when storing or `true`\nor `false` indicating if the extension should be kept." } ] }, { "__docId__": 482, "kind": "member", "name": "typeDefinition", "memberof": "src/lib/server/Types.js~AtviseType", "static": false, "longname": "src/lib/server/Types.js~AtviseType#typeDefinition", "access": "public", "description": "Node id of the type's definition", "lineNumber": 21, "type": { "nullable": null, "types": [ "node-opcua~NodeId" ], "spread": false, "description": null } }, { "__docId__": 483, "kind": "member", "name": "identifier", "memberof": "src/lib/server/Types.js~AtviseType", "static": false, "longname": "src/lib/server/Types.js~AtviseType#identifier", "access": "public", "description": "Atscm's identifier for the type.", "lineNumber": 27, "type": { "nullable": null, "types": [ "String" ], "spread": false, "description": null } }, { "__docId__": 484, "kind": "member", "name": "dataType", "memberof": "src/lib/server/Types.js~AtviseType", "static": false, "longname": "src/lib/server/Types.js~AtviseType#dataType", "access": "public", "description": "The type's parent OPC-UA type.", "lineNumber": 32, "type": { "nullable": null, "types": [ "node-opcua~DataType" ], "spread": false, "description": null } }, { "__docId__": 485, "kind": "member", "name": "fileExtension", "memberof": "src/lib/server/Types.js~AtviseType", "static": false, "longname": "src/lib/server/Types.js~AtviseType#fileExtension", "access": "public", "description": "The file extension to use when storing.", "lineNumber": 39, "type": { "nullable": null, "types": [ "String" ], "spread": false, "description": null } }, { "__docId__": 486, "kind": "member", "name": "keepExtension", "memberof": "src/lib/server/Types.js~AtviseType", "static": false, "longname": "src/lib/server/Types.js~AtviseType#keepExtension", "access": "public", "description": "If the extension should be kept when storing.", "lineNumber": 45, "type": { "nullable": null, "types": [ "Boolean" ], "spread": false, "description": null } }, { "__docId__": 487, "kind": "class", "name": "AtviseResourceType", "memberof": "src/lib/server/Types.js", "static": true, "longname": "src/lib/server/Types.js~AtviseResourceType", "access": "public", "export": true, "importPath": "atscm/src/lib/server/Types.js", "importStyle": "{AtviseResourceType}", "description": "An atvise-related resource type.", "lineNumber": 54, "interface": false, "extends": [ "AtviseType" ] }, { "__docId__": 488, "kind": "constructor", "name": "constructor", "memberof": "src/lib/server/Types.js~AtviseResourceType", "generator": false, "async": false, "static": false, "longname": "src/lib/server/Types.js~AtviseResourceType#constructor", "access": "public", "description": "Creates a new resource type.", "lineNumber": 60, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "name", "description": "The type's OPC-UA node id value." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "identifier", "description": "Atscm's identifier for the new type." } ] }, { "__docId__": 489, "kind": "variable", "name": "AtviseTypes", "memberof": "src/lib/server/Types.js", "static": true, "longname": "src/lib/server/Types.js~AtviseTypes", "access": "public", "export": true, "importPath": "atscm/src/lib/server/Types.js", "importStyle": "AtviseTypes", "description": "The atvise types to handle. **Ordering matters:** The {@link MappingTransformer} takes the first\nmatch, therefore **plain types should always come before resource types!**", "lineNumber": 70, "type": { "nullable": null, "types": [ "AtviseType[]" ], "spread": false, "description": null } }, { "__docId__": 490, "kind": "file", "name": "src/lib/server/WaitingStream.js", "content": "import Logger from 'gulplog';\nimport ProjectConfig from '../../config/ProjectConfig';\nimport QueueStream from './QueueStream';\n\n/**\n * A mixin that transforms a regular stream into a {@link WaitingStream}, which makes it wait for a\n * node's dependencies to be transformed.\n * @param {QueueStream} Stream The node stream to inherit from.\n * @return {Class} The resulting stream class.\n * @example Basic usage\n * import QueueStream from 'atscm/src/lib/server/QueueStream';\n * import { waitForDependencies } from 'atscm/src/lib/server/WaitingStream';\n *\n * class MyWaitingStream extends waitForDependencies(QueueStream) {\n *\n * dependenciesFor(file) {\n * return [\n * // An array of node ids\n * ];\n * }\n *\n * }\n */\nexport const waitForDependencies = (Stream) =>\n class Waiting extends Stream {\n /**\n * Creates a new WaitingStream.\n * @param {Object} options Options passed to the underlying {@link Stream} subclass.\n */\n constructor(options = {}) {\n super(options);\n\n this._dependencies = {};\n this._waitingFor = {};\n this._finishedProcessing = {};\n\n this.on('processed-chunk', (file) => {\n const key = file.nodeId.toString();\n const dependents = this._waitingFor[key];\n delete this._waitingFor[key];\n this._finishedProcessing[key] = true;\n\n if (dependents) {\n dependents.forEach((d) => {\n const k = d.nodeId.toString();\n this._dependencies[k] -= 1;\n\n if (this._dependencies[k] === 0) {\n super._enqueueChunk(d);\n delete this._dependencies[k];\n }\n });\n }\n\n this.emit('finished-chunk');\n });\n }\n\n /**\n * **Must be implemented by all subclasses:** Returns the dependencies for a given file.\n * @typedef {function(file: AtviseFile): NodeId[]} WWaiting#dependenciesFor\n * @param {AtviseFile} file The file to get the dependencies for.\n * @return {NodeId[]} The file's dependencies.\n * @abstract\n */\n // eslint-disable-next-line no-unused-vars\n dependenciesFor(file) {\n throw new Error('#dependenciesFor must be implemented by all subclasses');\n }\n\n /**\n * Enqueues a file after it's dependencies.\n * @param {AtviseFile} file The file to process.\n */\n _enqueueChunk(file) {\n const dependencies = this.dependenciesFor(file)\n .filter((id) => {\n if (id.namespace === 0 || !id.value || ProjectConfig.nodes.includes(id)) {\n return false;\n }\n\n return (\n !id.value.match(/^(Object|Variable)Types$/) &&\n !id.value.match(/^(Object|Variable)Types\\.ATVISE/) &&\n !id.value.match(/^SYSTEM\\.LIBRARY\\.ATVISE/)\n );\n })\n .map((id) => id.toString());\n\n if (dependencies && dependencies.length) {\n const needToWait = dependencies.reduce((wait, dependency) => {\n if (!this._finishedProcessing[dependency]) {\n const name = file.nodeId.toString();\n\n this._waitingFor[dependency] = (this._waitingFor[dependency] || []).concat(file);\n this._dependencies[name] = (this._dependencies[name] || 0) + 1;\n\n return true;\n }\n return wait;\n }, false);\n\n if (needToWait) {\n return;\n }\n }\n\n super._enqueueChunk(file);\n }\n\n /**\n * Delays the streams end until all chunks have been processed.\n * @param {function(err: Error)} callback Called once all chunks have been processed.\n */\n _flush(callback) {\n const checkProcessing = () => {\n if (this._processing || this.hasPending) {\n this.once('finished-chunk', () => checkProcessing());\n } else if (Object.keys(this._waitingFor).length > 0) {\n const first = Object.keys(this._waitingFor)[0];\n\n Logger.debug(`Missing dependency. Trying to process dependents of ${first}`);\n\n this.once('finished-chunk', () => checkProcessing());\n this.emit('processed-chunk', { nodeId: first });\n } else {\n super._flush(callback);\n }\n };\n\n checkProcessing();\n }\n };\n\n/**\n * A {@link QueueStream} that waits for a file's dependencies to be processed before the file is\n * processed itself.\n * @abstract\n */\nexport default class WaitingStream extends waitForDependencies(QueueStream) {}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/lib/server/WaitingStream.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 491, "kind": "function", "name": "waitForDependencies", "memberof": "src/lib/server/WaitingStream.js", "generator": false, "async": false, "static": true, "longname": "src/lib/server/WaitingStream.js~waitForDependencies", "access": "public", "export": true, "importPath": "atscm/src/lib/server/WaitingStream.js", "importStyle": "{waitForDependencies}", "description": "A mixin that transforms a regular stream into a {@link WaitingStream}, which makes it wait for a\nnode's dependencies to be transformed.", "examples": [ "Basic usage\nimport QueueStream from 'atscm/src/lib/server/QueueStream';\nimport { waitForDependencies } from 'atscm/src/lib/server/WaitingStream';\n\nclass MyWaitingStream extends waitForDependencies(QueueStream) {\n\n dependenciesFor(file) {\n return [\n // An array of node ids\n ];\n }\n\n}" ], "lineNumber": 24, "params": [ { "nullable": null, "types": [ "QueueStream" ], "spread": false, "optional": false, "name": "Stream", "description": "The node stream to inherit from." } ], "return": { "nullable": null, "types": [ "Class" ], "spread": false, "description": "The resulting stream class." } }, { "__docId__": 492, "kind": "typedef", "name": "WWaiting#dependenciesFor", "memberof": "src/lib/server/WaitingStream.js", "static": false, "longname": "src/lib/server/WaitingStream.js~WWaiting#dependenciesFor", "access": "public", "description": "**Must be implemented by all subclasses:** Returns the dependencies for a given file.", "lineNumber": 67, "params": [ { "nullable": null, "types": [ "AtviseFile" ], "spread": false, "optional": false, "name": "file", "description": "The file to get the dependencies for." } ], "return": { "nullable": null, "types": [ "NodeId[]" ], "spread": false, "description": "The file's dependencies." }, "abstract": true, "type": { "types": [ "function(file: AtviseFile): NodeId[]" ], "optional": false, "name": "WWaiting#dependenciesFor" } }, { "__docId__": 493, "kind": "class", "name": "WaitingStream", "memberof": "src/lib/server/WaitingStream.js", "static": true, "longname": "src/lib/server/WaitingStream.js~WaitingStream", "access": "public", "export": true, "importPath": "atscm/src/lib/server/WaitingStream.js", "importStyle": "WaitingStream", "description": "A {@link QueueStream} that waits for a file's dependencies to be processed before the file is\nprocessed itself.", "lineNumber": 140, "abstract": true, "interface": false, "expressionExtends": "waitForDependencies(QueueStream)" }, { "__docId__": 494, "kind": "file", "name": "src/lib/server/Watcher.js", "content": "/* eslint-plugin-jsdoc does not recognize the \"emits\" tag */\n/* eslint-disable jsdoc/check-tag-names */\n\n/* Needed as long as https://github.com/gajus/eslint-plugin-jsdoc/issues/56 is open */\n/* eslint-disable jsdoc/check-param-names */\n\nimport Emitter from 'events';\nimport { ClientSubscription } from 'node-opcua/lib/client/client_subscription';\nimport { AttributeIds } from 'node-opcua/lib/services/read_service';\nimport { NodeClass } from 'node-opcua/lib/datamodel/nodeclass';\nimport Logger from 'gulplog';\nimport ProjectConfig from '../../config/ProjectConfig';\nimport { reportProgress } from '../helpers/log';\nimport Session from './Session';\nimport NodeBrowser from './NodeBrowser';\n\n/**\n * Watches the given nodes for value changes.\n * @emit {ReadStream.ReadResult} Emits `change` events when a watched node changes.\n */\nexport default class Watcher extends Emitter {\n /**\n * Creates a new Watcher with the given nodes.\n * @param {NodeId[]} nodes The nodes to watch (recursively).\n */\n constructor(nodes = ProjectConfig.nodesToWatch) {\n super();\n\n /**\n * The browser used to subscribe to server nodes.\n * @type {NodeBrowser}\n */\n this._nodeBrowser = new NodeBrowser({\n handleNode: this._subscribe.bind(this),\n });\n\n reportProgress(this._nodeBrowser.browse(nodes), {\n getter: () => this._nodeBrowser._pushed,\n formatter: (count) => `Subscribed to ${count} nodes`,\n })\n .then(() => this.emit('ready'))\n .catch((err) => this.emit('error', err));\n\n /**\n * Resolved once the server subscription is set up.\n * @type {Promise}\n */\n this.subscriptionStarted = this._setupSubscription().catch((err) => this.emit('error', err));\n }\n\n /**\n * Initializes a server subscription.\n * @return {Promise} A setup subscription.\n */\n _setupSubscription() {\n return Session.create().then(\n (session) =>\n new Promise((resolve, reject) => {\n /** The current session, if connected @type {Session} */\n this._session = session;\n\n const subscription = new ClientSubscription(session, {\n requestedPublishingInterval: 100,\n requestedLifetimeCount: 1000,\n requestedMaxKeepAliveCount: 12,\n maxNotificationsPerPublish: 10,\n publishingEnabled: true,\n priority: 10,\n });\n\n subscription.on('started', () => resolve(subscription));\n subscription.on('failure', (err) => reject(err));\n })\n );\n }\n\n /**\n * Subscribes to value changes of a single node.\n * @param {BrowsedNode} node A browsed node.\n */\n async _subscribe(node) {\n if (node.nodeClass !== NodeClass.Variable) {\n return undefined;\n }\n const subscription = await this.subscriptionStarted;\n\n const nodeId = node.id;\n\n const item = subscription.monitor(\n {\n nodeId,\n attributeId: AttributeIds.Value,\n },\n {\n clientHandle: 13,\n samplingInterval: 250,\n queueSize: 123,\n discardOldest: true,\n }\n );\n\n return new Promise((resolve, reject) => {\n // Sometimes the changed event is not emitted...\n // Fixes #202\n const timeout = setTimeout(() => {\n Logger.debug(`Error monitoring '${nodeId.value}': Did not receive initial value. Retry...`);\n\n try {\n item.terminate();\n } catch (e) {\n Logger.warn('Failed to terminate subscription', e);\n }\n\n return this._subscribe(node).then(resolve, reject);\n }, 1000);\n\n item.once('changed', () => {\n clearTimeout(timeout);\n item.on(\n 'changed',\n this._handleChange.bind(this, {\n nodeId,\n })\n );\n\n resolve();\n });\n item.on('err', (err) => {\n clearTimeout(timeout);\n reject(err instanceof Error ? err : new Error(err));\n });\n }).catch((err) => {\n throw Object.assign(err, { node });\n });\n }\n\n /**\n * Called once a change has been detected and emits a 'change' or 'delete' event.\n * @param {Object} node The node that changed.\n * @param {?node-opcua~Variant} dataValue The current value.\n */\n _handleChange({ nodeId }, dataValue) {\n this.emit(dataValue.value ? 'change' : 'delete', {\n // nodeClass,\n nodeId,\n value: dataValue.value,\n mtime: dataValue.serverTimestamp,\n });\n }\n\n /**\n * Ends monitoring nodes.\n */\n close() {\n if (this._session) {\n Session.close(this._session).catch((err) => this.emit('error', err));\n }\n }\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/lib/server/Watcher.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 495, "kind": "class", "name": "Watcher", "memberof": "src/lib/server/Watcher.js", "static": true, "longname": "src/lib/server/Watcher.js~Watcher", "access": "public", "export": true, "importPath": "atscm/src/lib/server/Watcher.js", "importStyle": "Watcher", "description": "Watches the given nodes for value changes.", "lineNumber": 21, "unknown": [ { "tagName": "@emit", "tagValue": "{ReadStream.ReadResult} Emits `change` events when a watched node changes." } ], "interface": false, "extends": [ "events~Emitter" ] }, { "__docId__": 496, "kind": "constructor", "name": "constructor", "memberof": "src/lib/server/Watcher.js~Watcher", "generator": false, "async": false, "static": false, "longname": "src/lib/server/Watcher.js~Watcher#constructor", "access": "public", "description": "Creates a new Watcher with the given nodes.", "lineNumber": 26, "params": [ { "nullable": null, "types": [ "NodeId[]" ], "spread": false, "optional": false, "name": "nodes", "description": "The nodes to watch (recursively)." } ] }, { "__docId__": 497, "kind": "member", "name": "_nodeBrowser", "memberof": "src/lib/server/Watcher.js~Watcher", "static": false, "longname": "src/lib/server/Watcher.js~Watcher#_nodeBrowser", "access": "private", "description": "The browser used to subscribe to server nodes.", "lineNumber": 33, "type": { "nullable": null, "types": [ "NodeBrowser" ], "spread": false, "description": null } }, { "__docId__": 498, "kind": "member", "name": "subscriptionStarted", "memberof": "src/lib/server/Watcher.js~Watcher", "static": false, "longname": "src/lib/server/Watcher.js~Watcher#subscriptionStarted", "access": "public", "description": "Resolved once the server subscription is set up.", "lineNumber": 48, "type": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": null } }, { "__docId__": 499, "kind": "method", "name": "_setupSubscription", "memberof": "src/lib/server/Watcher.js~Watcher", "generator": false, "async": false, "static": false, "longname": "src/lib/server/Watcher.js~Watcher#_setupSubscription", "access": "private", "description": "Initializes a server subscription.", "lineNumber": 55, "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "A setup subscription." }, "params": [] }, { "__docId__": 500, "kind": "member", "name": "_session", "memberof": "src/lib/server/Watcher.js~Watcher", "static": false, "longname": "src/lib/server/Watcher.js~Watcher#_session", "access": "private", "description": "The current session, if connected @type {Session}", "lineNumber": 60, "type": { "types": [ "*" ] } }, { "__docId__": 501, "kind": "method", "name": "_subscribe", "memberof": "src/lib/server/Watcher.js~Watcher", "generator": false, "async": true, "static": false, "longname": "src/lib/server/Watcher.js~Watcher#_subscribe", "access": "private", "description": "Subscribes to value changes of a single node.", "lineNumber": 81, "params": [ { "nullable": null, "types": [ "BrowsedNode" ], "spread": false, "optional": false, "name": "node", "description": "A browsed node." } ], "return": { "types": [ "*" ] } }, { "__docId__": 502, "kind": "method", "name": "_handleChange", "memberof": "src/lib/server/Watcher.js~Watcher", "generator": false, "async": false, "static": false, "longname": "src/lib/server/Watcher.js~Watcher#_handleChange", "access": "private", "description": "Called once a change has been detected and emits a 'change' or 'delete' event.", "lineNumber": 142, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "node", "description": "The node that changed." }, { "nullable": true, "types": [ "node-opcua~Variant" ], "spread": false, "optional": false, "name": "dataValue", "description": "The current value." } ], "return": null }, { "__docId__": 503, "kind": "method", "name": "close", "memberof": "src/lib/server/Watcher.js~Watcher", "generator": false, "async": false, "static": false, "longname": "src/lib/server/Watcher.js~Watcher#close", "access": "public", "description": "Ends monitoring nodes.", "lineNumber": 154, "params": [], "return": null }, { "__docId__": 504, "kind": "file", "name": "src/lib/server/WriteStream.js", "content": "/* Needed as long as https://github.com/gajus/eslint-plugin-jsdoc/issues/56 is open */\n/* eslint-disable jsdoc/check-param-names */\n\nimport Logger from 'gulplog';\nimport { StatusCodes } from 'node-opcua/lib/datamodel/opcua_status_code';\nimport { NodeClass } from 'node-opcua/lib/datamodel/nodeclass';\nimport WaitingStream from './WaitingStream';\n\n// FIXME: Extend QueueStream directly\n\n/**\n * A stream that writes all read {@link AtviseFile}s to their corresponding nodes on atvise server.\n * The underlying {@link TreeStream} ensures the nodes are processed in an order that respects the\n * parent-child relations between nodes. Nodes are created (if needed) before their children are\n * processed.\n */\nexport default class WriteStream extends WaitingStream {\n /**\n * Creates a new write stream with the given {@link CreateNodeStream} and\n * {@link AddReferencesStream}. Implementer have to ensure this create stream is actually piped.\n * @param {CreateNodeStream} createStream The stream that handles node creations.\n * @param {AddReferencesStream} addReferencesStream The stream that adds missing node references.\n * @param {Object} options The options passed to the underlying {@link TreeStream}.\n */\n constructor(createStream, addReferencesStream, options) {\n super(options);\n\n /**\n * If a node has to be created first, it's callback is added to this map.\n * @type {Map {\n const key = nodeId.toString();\n\n if (this._createCallbacks[key]) {\n this._createCallbacks[key](null);\n }\n });\n\n /**\n * The stream responsible for adding additional references.\n * @type {AddReferencesStream}\n */\n this._addReferencesStream = addReferencesStream;\n }\n\n /**\n * The error message to use when writing a file fails.\n * @param {AtviseFile} file The file being processed.\n * @return {string} The error message to use.\n */\n processErrorMessage(file) {\n return `Error writing ${file.nodeId}`;\n }\n\n /**\n * Pushes a node to the piped create stream and waits for the node to be created.\n * @param {AtviseFile} file The file create the node for.\n * @param {function(err: Error, statusCode: node-opcua~StatusCodes, onSuccess: function)}\n * handleErrors The error handler to call. See {@link QueueStream#processChunk} for details.\n */\n _createNode(file, handleErrors) {\n this._createCallbacks[file.nodeId.toString()] = (err) => {\n handleErrors(err, StatusCodes.Good, (done) => done());\n };\n\n this.push(file);\n }\n\n /**\n * Returns a files parent node and type definition.\n * @param {AtviseFile} file The file to check.\n * @return {NodeId[]} The files dependencies.\n */\n dependenciesFor() {\n return [];\n }\n\n /**\n * Writes an {@link AtviseFile} to it's corresponding node on atvise server.\n * @param {AtviseFile} file The file to write.\n * @param {function(err: Error, statusCode: node-opcua~StatusCodes, onSuccess: function)}\n * handleErrors The error handler to call. See {@link QueueStream#processChunk} for details.\n */\n processChunk(file, handleErrors) {\n if (file.nodeClass.value !== NodeClass.Variable.value) {\n // Non-variable nodes are just pushed\n this._createNode(file, handleErrors);\n return;\n }\n\n try {\n this.session.writeSingleNode(\n `ns=1;s=${file.nodeId}`,\n file.variantValue,\n (err, statusCode) => {\n if (\n statusCode === StatusCodes.BadUserAccessDenied ||\n statusCode === StatusCodes.BadNotWritable\n ) {\n Logger.warn(`Error writing node ${file.nodeId}\n - Make sure it is not opened in atvise builder\n - Make sure the corresponding datasource is connected`);\n handleErrors(err, StatusCodes.Good, (done) => done());\n } else if (statusCode === StatusCodes.BadNodeIdUnknown) {\n Logger.debug(`Node ${file.nodeId} does not exist: Attempting to create it...`);\n\n this._createNode(file, handleErrors);\n } else {\n handleErrors(err, statusCode, (done) => {\n // Push to add references stream\n this._addReferencesStream.push(file);\n\n done();\n });\n }\n }\n );\n } catch (e) {\n handleErrors(e);\n }\n }\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/lib/server/WriteStream.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 505, "kind": "class", "name": "WriteStream", "memberof": "src/lib/server/WriteStream.js", "static": true, "longname": "src/lib/server/WriteStream.js~WriteStream", "access": "public", "export": true, "importPath": "atscm/src/lib/server/WriteStream.js", "importStyle": "WriteStream", "description": "A stream that writes all read {@link AtviseFile}s to their corresponding nodes on atvise server.\nThe underlying {@link TreeStream} ensures the nodes are processed in an order that respects the\nparent-child relations between nodes. Nodes are created (if needed) before their children are\nprocessed.", "lineNumber": 17, "interface": false, "extends": [ "src/lib/server/WaitingStream.js~WaitingStream" ] }, { "__docId__": 506, "kind": "constructor", "name": "constructor", "memberof": "src/lib/server/WriteStream.js~WriteStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/WriteStream.js~WriteStream#constructor", "access": "public", "description": "Creates a new write stream with the given {@link CreateNodeStream} and\n{@link AddReferencesStream}. Implementer have to ensure this create stream is actually piped.", "lineNumber": 25, "params": [ { "nullable": null, "types": [ "CreateNodeStream" ], "spread": false, "optional": false, "name": "createStream", "description": "The stream that handles node creations." }, { "nullable": null, "types": [ "AddReferencesStream" ], "spread": false, "optional": false, "name": "addReferencesStream", "description": "The stream that adds missing node references." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options", "description": "The options passed to the underlying {@link TreeStream}." } ] }, { "__docId__": 507, "kind": "member", "name": "_createCallbacks", "memberof": "src/lib/server/WriteStream.js~WriteStream", "static": false, "longname": "src/lib/server/WriteStream.js~WriteStream#_createCallbacks", "access": "private", "description": "If a node has to be created first, it's callback is added to this map.", "lineNumber": 32, "type": { "nullable": null, "types": [ "Map done());\n return;\n }\n\n this.session.call([request], (err, [result] = []) => {\n if (err) {\n handleErrors(err);\n } else if (result.statusCode.value !== StatusCodes.Good.value) {\n handleErrors(err, result.statusCode, (done) => done());\n } else {\n this.handleOutputArguments(file, result.outputArguments, (outputError) => {\n handleErrors(outputError, StatusCodes.Good, (done) => done());\n });\n }\n });\n } catch (e) {\n handleErrors(e);\n }\n }\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/lib/server/scripts/CallMethodStream.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 514, "kind": "class", "name": "CallMethodStream", "memberof": "src/lib/server/scripts/CallMethodStream.js", "static": true, "longname": "src/lib/server/scripts/CallMethodStream.js~CallMethodStream", "access": "public", "export": true, "importPath": "atscm/src/lib/server/scripts/CallMethodStream.js", "importStyle": "CallMethodStream", "description": "A stream that calls an OPC-UA method for all input files.", "lineNumber": 8, "abstract": true, "interface": false, "extends": [ "src/lib/server/QueueStream.js~QueueStream" ] }, { "__docId__": 515, "kind": "get", "name": "methodId", "memberof": "src/lib/server/scripts/CallMethodStream.js~CallMethodStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/scripts/CallMethodStream.js~CallMethodStream#methodId", "access": "public", "description": "**Must be implemented in all subclasses:** The {@link NodeId} of the method to call.", "lineNumber": 13, "type": { "nullable": null, "types": [ "NodeId" ], "spread": false, "description": null } }, { "__docId__": 516, "kind": "get", "name": "methodBaseId", "memberof": "src/lib/server/scripts/CallMethodStream.js~CallMethodStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/scripts/CallMethodStream.js~CallMethodStream#methodBaseId", "access": "public", "description": "The {@link NodeId} of the object from which the method should get called. Defaults to the value\nof {@link NodeId#parent} of {@link CallMethodStream#methodId}.", "lineNumber": 22, "type": { "nullable": null, "types": [ "NodeId" ], "spread": false, "description": null } }, { "__docId__": 517, "kind": "method", "name": "inputArguments", "memberof": "src/lib/server/scripts/CallMethodStream.js~CallMethodStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/scripts/CallMethodStream.js~CallMethodStream#inputArguments", "access": "public", "description": "The input arguments the method should be called with for a file. Needs to be overridden by\nsubclasses in most cases. Returning `null` indicates no method call is needed.", "lineNumber": 33, "params": [ { "nullable": null, "types": [ "vinyl~File" ], "spread": false, "optional": false, "name": "file", "description": "The file beeing processed." } ], "return": { "nullable": true, "types": [ "node-opcua~Variant[]" ], "spread": false, "description": "The resulting input arguments." } }, { "__docId__": 518, "kind": "method", "name": "callRequest", "memberof": "src/lib/server/scripts/CallMethodStream.js~CallMethodStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/scripts/CallMethodStream.js~CallMethodStream#callRequest", "access": "public", "description": "Creates a call method request object for a file.", "lineNumber": 42, "params": [ { "nullable": null, "types": [ "vinyl~File" ], "spread": false, "optional": false, "name": "file", "description": "The file beeing processed." } ], "return": { "nullable": true, "types": [ "node-opcua~CallMethodRequest" ], "spread": false, "description": "The resulting call request." } }, { "__docId__": 519, "kind": "method", "name": "handleOutputArguments", "memberof": "src/lib/server/scripts/CallMethodStream.js~CallMethodStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/scripts/CallMethodStream.js~CallMethodStream#handleOutputArguments", "access": "public", "description": "**Must be implemented by all subclasses:** If the method call returns a status code of\n*{@link node-opcua~StatusCodes}.Good*, this method decides if the output matches the expected\nresults.", "lineNumber": 66, "params": [ { "nullable": null, "types": [ "vinyl~File" ], "spread": false, "optional": false, "name": "file", "description": "The file beeing processed." }, { "nullable": null, "types": [ "node-opcua~Variant[]" ], "spread": false, "optional": false, "name": "outputArgs", "description": "The output arguments." }, { "nullable": null, "types": [ "function(err: Error)" ], "spread": false, "optional": false, "name": "callback", "description": "Call this method with an error to indicate the method\ncall didn't work as expected." } ], "return": null }, { "__docId__": 520, "kind": "method", "name": "processErrorMessage", "memberof": "src/lib/server/scripts/CallMethodStream.js~CallMethodStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/scripts/CallMethodStream.js~CallMethodStream#processErrorMessage", "access": "public", "description": "Returns an error message specifically for the given file.", "lineNumber": 75, "params": [ { "nullable": null, "types": [ "vinyl~File" ], "spread": false, "optional": false, "name": "file", "description": "The file to generate the error message for." } ], "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "The specific error message." } }, { "__docId__": 521, "kind": "method", "name": "processChunk", "memberof": "src/lib/server/scripts/CallMethodStream.js~CallMethodStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/scripts/CallMethodStream.js~CallMethodStream#processChunk", "access": "public", "description": "Performs an opcua method call for the given file.", "lineNumber": 85, "params": [ { "nullable": null, "types": [ "vinyl~File" ], "spread": false, "optional": false, "name": "file", "description": "The file being processed." }, { "nullable": null, "types": [ "function(err: Error, status: node-opcua~StatusCodes, success: function)" ], "spread": false, "optional": false, "name": "handleErrors", "description": "The error handler to call. See {@link QueueStream#processChunk} for details." } ], "return": null }, { "__docId__": 522, "kind": "file", "name": "src/lib/server/scripts/CallScriptStream.js", "content": "import { DataType, VariantArrayType } from 'node-opcua/lib/datamodel/variant';\nimport { StatusCodes } from 'node-opcua/lib/datamodel/opcua_status_code';\nimport NodeId from '../../model/opcua/NodeId';\nimport CallMethodStream from './CallMethodStream';\n\n/**\n * A stream that calls atvise server scripts for all passed nodes.\n * @abstract\n */\nexport default class CallScriptStream extends CallMethodStream {\n /**\n * The id of the *callScript* method.\n * @type {NodeId}\n */\n get methodId() {\n return new NodeId(NodeId.NodeIdType.STRING, 'AGENT.SCRIPT.METHODS.callScript', 1);\n }\n\n /**\n * **Must be implemented by all subclasses:** The id of the script to call.\n * @type {NodeId}\n * @abstract\n */\n get scriptId() {\n throw new Error('Must be implemented by all subclasses');\n }\n\n /**\n * Id of the script's base object.\n * @type {NodeId}\n */\n get scriptBaseId() {\n return this.scriptId.parent;\n }\n\n /**\n * Returns the parameters to call the script with for the given file.\n * @param {AtviseFile} file The processed file.\n * @return {Object} The parameters passed to the script.\n */\n // eslint-disable-next-line no-unused-vars\n scriptParameters(file) {\n return {};\n }\n\n /**\n * Creates the raw method input arguments for the given file.\n * @param {AtviseFile} file The processed file.\n * @return {?node-opcua~Variant[]} Input arguments for the *callScript* method.\n */\n inputArguments(file) {\n const params = this.scriptParameters(file);\n\n if (params === null) {\n return null;\n }\n\n const paramNames = Object.keys(params);\n\n return [\n {\n dataType: DataType.NodeId,\n value: this.scriptId,\n },\n {\n dataType: DataType.NodeId,\n value: this.scriptBaseId,\n },\n {\n dataType: DataType.String,\n arrayType: VariantArrayType.Array,\n value: paramNames,\n },\n {\n dataType: DataType.Variant,\n arrayType: VariantArrayType.Array,\n value: paramNames.map((key) => params[key]),\n },\n ];\n }\n\n /**\n * Returns the error message logged if running the script fails.\n * @param {AtviseFile} file The processed file.\n * @return {string} The resulting error message.\n */\n processErrorMessage(file) {\n return `Error running script ${this.scriptId} for ${file.relative}`;\n }\n\n /**\n * Calls the script specified in {@link CallScriptStream#scriptId}. If the script does not exist\n * but could be imported by running `atscm import` a special status description is returned.\n * @param {vinyl~File} file The file being processed.\n * @param {function(err: Error, status: node-opcua~StatusCodes, success: function)} handleErrors\n * The error handler to call. See {@link QueueStream#processChunk} for details.\n */\n processChunk(file, handleErrors) {\n super.processChunk(file, (err, status, success) => {\n const processedStatus = status;\n\n const atscmScript = this.scriptId.value.match(/SERVERSCRIPTS\\.atscm\\.(.*)/);\n if (status === StatusCodes.BadMethodInvalid && atscmScript) {\n processedStatus.description = `The '${atscmScript[1]}' script does not exist.\n- Did you forget to run 'atscm import'?`;\n }\n\n handleErrors(err, processedStatus, success);\n });\n }\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/lib/server/scripts/CallScriptStream.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 523, "kind": "class", "name": "CallScriptStream", "memberof": "src/lib/server/scripts/CallScriptStream.js", "static": true, "longname": "src/lib/server/scripts/CallScriptStream.js~CallScriptStream", "access": "public", "export": true, "importPath": "atscm/src/lib/server/scripts/CallScriptStream.js", "importStyle": "CallScriptStream", "description": "A stream that calls atvise server scripts for all passed nodes.", "lineNumber": 10, "abstract": true, "interface": false, "extends": [ "src/lib/server/scripts/CallMethodStream.js~CallMethodStream" ] }, { "__docId__": 524, "kind": "get", "name": "methodId", "memberof": "src/lib/server/scripts/CallScriptStream.js~CallScriptStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/scripts/CallScriptStream.js~CallScriptStream#methodId", "access": "public", "description": "The id of the *callScript* method.", "lineNumber": 15, "type": { "nullable": null, "types": [ "NodeId" ], "spread": false, "description": null } }, { "__docId__": 525, "kind": "get", "name": "scriptId", "memberof": "src/lib/server/scripts/CallScriptStream.js~CallScriptStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/scripts/CallScriptStream.js~CallScriptStream#scriptId", "access": "public", "description": "**Must be implemented by all subclasses:** The id of the script to call.", "lineNumber": 24, "type": { "nullable": null, "types": [ "NodeId" ], "spread": false, "description": null }, "abstract": true }, { "__docId__": 526, "kind": "get", "name": "scriptBaseId", "memberof": "src/lib/server/scripts/CallScriptStream.js~CallScriptStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/scripts/CallScriptStream.js~CallScriptStream#scriptBaseId", "access": "public", "description": "Id of the script's base object.", "lineNumber": 32, "type": { "nullable": null, "types": [ "NodeId" ], "spread": false, "description": null } }, { "__docId__": 527, "kind": "method", "name": "scriptParameters", "memberof": "src/lib/server/scripts/CallScriptStream.js~CallScriptStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/scripts/CallScriptStream.js~CallScriptStream#scriptParameters", "access": "public", "description": "Returns the parameters to call the script with for the given file.", "lineNumber": 42, "params": [ { "nullable": null, "types": [ "AtviseFile" ], "spread": false, "optional": false, "name": "file", "description": "The processed file." } ], "return": { "nullable": null, "types": [ "Object" ], "spread": false, "description": "The parameters passed to the script." } }, { "__docId__": 528, "kind": "method", "name": "inputArguments", "memberof": "src/lib/server/scripts/CallScriptStream.js~CallScriptStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/scripts/CallScriptStream.js~CallScriptStream#inputArguments", "access": "public", "description": "Creates the raw method input arguments for the given file.", "lineNumber": 51, "params": [ { "nullable": null, "types": [ "AtviseFile" ], "spread": false, "optional": false, "name": "file", "description": "The processed file." } ], "return": { "nullable": true, "types": [ "node-opcua~Variant[]" ], "spread": false, "description": "Input arguments for the *callScript* method." } }, { "__docId__": 529, "kind": "method", "name": "processErrorMessage", "memberof": "src/lib/server/scripts/CallScriptStream.js~CallScriptStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/scripts/CallScriptStream.js~CallScriptStream#processErrorMessage", "access": "public", "description": "Returns the error message logged if running the script fails.", "lineNumber": 87, "params": [ { "nullable": null, "types": [ "AtviseFile" ], "spread": false, "optional": false, "name": "file", "description": "The processed file." } ], "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "The resulting error message." } }, { "__docId__": 530, "kind": "method", "name": "processChunk", "memberof": "src/lib/server/scripts/CallScriptStream.js~CallScriptStream", "generator": false, "async": false, "static": false, "longname": "src/lib/server/scripts/CallScriptStream.js~CallScriptStream#processChunk", "access": "public", "description": "Calls the script specified in {@link CallScriptStream#scriptId}. If the script does not exist\nbut could be imported by running `atscm import` a special status description is returned.", "lineNumber": 98, "params": [ { "nullable": null, "types": [ "vinyl~File" ], "spread": false, "optional": false, "name": "file", "description": "The file being processed." }, { "nullable": null, "types": [ "function(err: Error, status: node-opcua~StatusCodes, success: function)" ], "spread": false, "optional": false, "name": "handleErrors", "description": "The error handler to call. See {@link QueueStream#processChunk} for details." } ], "return": null }, { "__docId__": 531, "kind": "file", "name": "src/lib/server/scripts/version.js", "content": "/* eslint-disable import/prefer-default-export */\n\nimport NodeId from '../../model/opcua/NodeId';\n\n/**\n * The node containing the currently installed server-scripts version.\n * @type {NodeId}\n */\nexport const versionNode = new NodeId('SYSTEM.LIBRARY.ATVISE.SERVERSCRIPTS.atscm.version');\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/lib/server/scripts/version.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 532, "kind": "variable", "name": "versionNode", "memberof": "src/lib/server/scripts/version.js", "static": true, "longname": "src/lib/server/scripts/version.js~versionNode", "access": "public", "export": true, "importPath": "atscm/src/lib/server/scripts/version.js", "importStyle": "{versionNode}", "description": "The node containing the currently installed server-scripts version.", "lineNumber": 9, "type": { "nullable": null, "types": [ "NodeId" ], "spread": false, "description": null } }, { "__docId__": 533, "kind": "file", "name": "src/lib/transform/ConfigTransformer.ts", "content": "import { DataType, VariantArrayType } from 'node-opcua/lib/datamodel/variant';\nimport XMLTransformer from './XMLTransformer';\n\nexport default class ConfigTransformer> extends XMLTransformer {\n /**\n * Returns an object containing all non-empty properties of the input object. Returns null if no\n * properties are non-empty.\n * @param input The config to process.\n */\n protected nonEmptyConfig(input: C) {\n let result: C | null = null;\n\n for (const [key, value] of Object.entries(input)) {\n if (Array.isArray(value) ? value.length > 0 : value !== undefined) {\n result = result || ({} as C);\n result[key] = value;\n }\n }\n\n return result;\n }\n\n /**\n * Writes the config file to disk if needed.\n * @param config The config to write.\n * @param node The original source node.\n * @param context The current transformer context.\n * @return `true` it the config was actually written.\n */\n protected writeConfigFile(config: C, node, context) {\n const processed = this.nonEmptyConfig(config);\n\n if (processed) {\n const configFile = (this.constructor as typeof XMLTransformer).splitFile(node, '.json');\n configFile.value = {\n dataType: DataType.String,\n arrayType: VariantArrayType.Scalar,\n value: JSON.stringify(config, null, ' '),\n };\n context.addNode(configFile);\n }\n\n return !!processed;\n }\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/lib/transform/ConfigTransformer.ts", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 534, "kind": "class", "name": "ConfigTransformer", "memberof": "src/lib/transform/ConfigTransformer.ts", "static": true, "longname": "src/lib/transform/ConfigTransformer.ts~ConfigTransformer", "access": "public", "export": true, "importPath": "atscm/src/lib/transform/ConfigTransformer.ts", "importStyle": "ConfigTransformer", "description": "", "lineNumber": 4, "interface": false, "extends": [ "src/lib/transform/XMLTransformer.js~XMLTransformer" ] }, { "__docId__": 535, "kind": "method", "name": "nonEmptyConfig", "memberof": "src/lib/transform/ConfigTransformer.ts~ConfigTransformer", "generator": false, "async": false, "static": false, "longname": "src/lib/transform/ConfigTransformer.ts~ConfigTransformer#nonEmptyConfig", "access": "public", "description": "Returns an object containing all non-empty properties of the input object. Returns null if no\nproperties are non-empty.", "lineNumber": 10, "params": [ { "nullable": null, "types": [ "C" ], "spread": false, "optional": false, "name": "input", "description": "" } ], "return": { "types": [ "*" ] } }, { "__docId__": 536, "kind": "method", "name": "writeConfigFile", "memberof": "src/lib/transform/ConfigTransformer.ts~ConfigTransformer", "generator": false, "async": false, "static": false, "longname": "src/lib/transform/ConfigTransformer.ts~ConfigTransformer#writeConfigFile", "access": "public", "description": "Writes the config file to disk if needed.", "lineNumber": 30, "params": [ { "nullable": null, "types": [ "C" ], "spread": false, "optional": false, "name": "config", "description": "" }, { "nullable": null, "types": [ "undefined" ], "spread": false, "optional": false, "name": "node", "description": "" }, { "nullable": null, "types": [ "undefined" ], "spread": false, "optional": false, "name": "context", "description": "" } ], "return": { "types": [ "*" ] } }, { "__docId__": 537, "kind": "file", "name": "src/lib/transform/PartialTransformer.js", "content": "import Transformer from './Transformer';\n\n/**\n * A transformer that transforms only some of the files read.\n * @abstract\n * @example Minimum implementation\n * class MyTransformer extends PartialTransformer {\n * shouldBeTransformed(node) {\n * return true; // or false\n * }\n * transformFromFilesystem(state, context) {\n * if (!this.shouldBeTransformed(state.node)) { return; }\n *\n * // Apply actual transformation\n * }\n * }\n */\nexport default class ModernPartialTransformer extends Transformer {\n /**\n * `true` if `file` should be transformed.\n * @param {AtviseFile} file The file to transform or not.\n * @return {boolean}\n * @abstract\n */\n // eslint-disable-next-line no-unused-vars\n shouldBeTransformed(file) {\n throw new Error('PartialTransformer#shouldBeTransformed must be implemented by all subclasses');\n }\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/lib/transform/PartialTransformer.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 538, "kind": "class", "name": "ModernPartialTransformer", "memberof": "src/lib/transform/PartialTransformer.js", "static": true, "longname": "src/lib/transform/PartialTransformer.js~ModernPartialTransformer", "access": "public", "export": true, "importPath": "atscm/src/lib/transform/PartialTransformer.js", "importStyle": "ModernPartialTransformer", "description": "A transformer that transforms only some of the files read.", "examples": [ "Minimum implementation\nclass MyTransformer extends PartialTransformer {\n shouldBeTransformed(node) {\n return true; // or false\n }\n transformFromFilesystem(state, context) {\n if (!this.shouldBeTransformed(state.node)) { return; }\n\n // Apply actual transformation\n }\n}" ], "lineNumber": 18, "abstract": true, "interface": false, "extends": [ "src/lib/transform/Transformer.js~Transformer" ] }, { "__docId__": 539, "kind": "method", "name": "shouldBeTransformed", "memberof": "src/lib/transform/PartialTransformer.js~ModernPartialTransformer", "generator": false, "async": false, "static": false, "longname": "src/lib/transform/PartialTransformer.js~ModernPartialTransformer#shouldBeTransformed", "access": "public", "description": "`true` if `file` should be transformed.", "lineNumber": 26, "params": [ { "nullable": null, "types": [ "AtviseFile" ], "spread": false, "optional": false, "name": "file", "description": "The file to transform or not." } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" }, "abstract": true }, { "__docId__": 540, "kind": "file", "name": "src/lib/transform/SplittingTransformer.js", "content": "import { extname, basename, join } from 'path';\nimport { readdir } from 'fs-extra';\nimport { escapeForRegExp } from '../regexp';\nimport PartialTransformer from './PartialTransformer.js';\n\n/**\n * A transformer that splits a node into multiple source nodes when pulling.\n */\nexport default class SplittingTransformer extends PartialTransformer {\n /**\n * The extension to add to container node names when they are pulled.\n * @abstract\n * @type {string}\n */\n static get extension() {\n throw new Error('Must be implemented by all subclasses');\n }\n\n /**\n * The source file extensions to allow.\n * @abstract\n * @type {string[]}\n */\n static get sourceExtensions() {\n throw new Error('Must be implemented by all subclasses');\n }\n\n /**\n * Splits a {@link Node}: The resulting is a clone of the input file, with a different path.\n * @param {Node} node The file to split.\n * @param {?string} newExtension The extension the resulting file gets.\n * @return {Node} The resulting node.\n */\n static splitFile(node, newExtension) {\n Object.assign(node, {\n fullyMapped: true,\n value: Object.assign(node.value, {\n noWrite: true,\n }),\n });\n\n return node.createChild({ extension: newExtension });\n }\n\n /**\n * Renames a container node, should be called by all subclasses.\n * @param {BrowsedNode} node A container node.\n * @param {any} context The tranform context.\n */\n // eslint-disable-next-line no-unused-vars\n async transformFromDB(node, context) {\n node.renameTo(`${node.name}${this.constructor.extension}`);\n }\n\n /**\n * Returns `false` for all container nodes, so they don't get read.\n * @param {BrowsedNode} node The node to check.\n * @return {?boolean} If the node should be read.\n */\n readNodeFile(node) {\n return this.shouldBeTransformed(node) ? false : undefined;\n }\n\n /**\n * Combines the container node and the source nodes to one single node.\n * @abstract\n * @param {BrowsedNode} node The container node.\n * @param {Map} sourceNodes The source nodes.\n * @param {any} context The current context.\n */\n // eslint-disable-next-line no-unused-vars\n combineNodes(node, sourceNodes, context) {\n throw new Error('Must be implemented by all subclasses');\n }\n\n /**\n * Combines the container node and the source nodes to one single node by calling\n * {@link SplittingTransformer#combineNodes}.\n * @param {BrowsedNode} node The container node.\n * @param {{ [extension: string]: BrowedNode }} sourceNodes The source nodes.\n * @param {any} context The current context.\n */\n _combineNodes(node, sourceNodes, context) {\n this.combineNodes(node, sourceNodes, context);\n node.renameTo(basename(node.name, this.constructor.extension));\n }\n\n /**\n * Reads a given container nodes source nodes and combines them.\n * @param {BrowsedNode} node The node to transform.\n * @param {Object} context The browser context.\n */\n async transformFromFilesystem(node, context) {\n if (!this.shouldBeTransformed(node)) {\n return;\n }\n\n const [name, hasExtension] = node.fileName.split(this.constructor.extension);\n\n if (hasExtension !== '') {\n // FIXME: Remove\n throw new Error(`${node.relative} shouldn't be transformed`);\n }\n\n const regExp = new RegExp(\n `^\\\\.${escapeForRegExp(name)}(${this.constructor.sourceExtensions.join('|')})\\\\.json$`\n );\n\n // Find source files an child definition files\n const sourceFiles = [];\n const childFiles = [];\n\n const children = (await readdir(node.relative)).reduce((current, f) => {\n if (f.match(regExp)) {\n sourceFiles.push(f);\n } else if (f.match(/^\\..*\\.json$/)) {\n // Other definition file -> child node\n current.push({ name: f, path: join(node.relative, f) });\n childFiles.push(f);\n } else if (!sourceFiles.includes(`.${f}.json`) && !childFiles.includes(`.${f}.json`)) {\n // This might be a child object's folder...\n current.push({ name: f, path: join(node.relative, f) });\n }\n\n return current;\n }, []);\n\n // Manually set node.children for the container as source browser only handles definition files\n Object.assign(node, { children });\n\n const sourceNodes = await Promise.all(\n sourceFiles.map((f) =>\n context.readNode({\n path: join(node.relative, f),\n tree: { parent: node },\n })\n )\n );\n\n this._combineNodes(\n node,\n sourceNodes.reduce(\n (result, n) =>\n Object.assign(result, {\n [extname(n.fileName)]: n,\n }),\n {}\n ),\n context\n );\n }\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/lib/transform/SplittingTransformer.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 541, "kind": "class", "name": "SplittingTransformer", "memberof": "src/lib/transform/SplittingTransformer.js", "static": true, "longname": "src/lib/transform/SplittingTransformer.js~SplittingTransformer", "access": "public", "export": true, "importPath": "atscm/src/lib/transform/SplittingTransformer.js", "importStyle": "SplittingTransformer", "description": "A transformer that splits a node into multiple source nodes when pulling.", "lineNumber": 9, "interface": false, "extends": [ "src/lib/transform/PartialTransformer.js~PartialTransformer" ] }, { "__docId__": 542, "kind": "get", "name": "extension", "memberof": "src/lib/transform/SplittingTransformer.js~SplittingTransformer", "generator": false, "async": false, "static": true, "longname": "src/lib/transform/SplittingTransformer.js~SplittingTransformer.extension", "access": "public", "description": "The extension to add to container node names when they are pulled.", "lineNumber": 15, "type": { "nullable": null, "types": [ "string" ], "spread": false, "description": null }, "abstract": true }, { "__docId__": 543, "kind": "get", "name": "sourceExtensions", "memberof": "src/lib/transform/SplittingTransformer.js~SplittingTransformer", "generator": false, "async": false, "static": true, "longname": "src/lib/transform/SplittingTransformer.js~SplittingTransformer.sourceExtensions", "access": "public", "description": "The source file extensions to allow.", "lineNumber": 24, "type": { "nullable": null, "types": [ "string[]" ], "spread": false, "description": null }, "abstract": true }, { "__docId__": 544, "kind": "method", "name": "splitFile", "memberof": "src/lib/transform/SplittingTransformer.js~SplittingTransformer", "generator": false, "async": false, "static": true, "longname": "src/lib/transform/SplittingTransformer.js~SplittingTransformer.splitFile", "access": "public", "description": "Splits a {@link Node}: The resulting is a clone of the input file, with a different path.", "lineNumber": 34, "params": [ { "nullable": null, "types": [ "Node" ], "spread": false, "optional": false, "name": "node", "description": "The file to split." }, { "nullable": true, "types": [ "string" ], "spread": false, "optional": false, "name": "newExtension", "description": "The extension the resulting file gets." } ], "return": { "nullable": null, "types": [ "Node" ], "spread": false, "description": "The resulting node." } }, { "__docId__": 545, "kind": "method", "name": "transformFromDB", "memberof": "src/lib/transform/SplittingTransformer.js~SplittingTransformer", "generator": false, "async": true, "static": false, "longname": "src/lib/transform/SplittingTransformer.js~SplittingTransformer#transformFromDB", "access": "public", "description": "Renames a container node, should be called by all subclasses.", "lineNumber": 51, "params": [ { "nullable": null, "types": [ "BrowsedNode" ], "spread": false, "optional": false, "name": "node", "description": "A container node." }, { "nullable": null, "types": [ "any" ], "spread": false, "optional": false, "name": "context", "description": "The tranform context." } ], "return": null }, { "__docId__": 546, "kind": "method", "name": "readNodeFile", "memberof": "src/lib/transform/SplittingTransformer.js~SplittingTransformer", "generator": false, "async": false, "static": false, "longname": "src/lib/transform/SplittingTransformer.js~SplittingTransformer#readNodeFile", "access": "public", "description": "Returns `false` for all container nodes, so they don't get read.", "lineNumber": 60, "params": [ { "nullable": null, "types": [ "BrowsedNode" ], "spread": false, "optional": false, "name": "node", "description": "The node to check." } ], "return": { "nullable": true, "types": [ "boolean" ], "spread": false, "description": "If the node should be read." } }, { "__docId__": 547, "kind": "method", "name": "combineNodes", "memberof": "src/lib/transform/SplittingTransformer.js~SplittingTransformer", "generator": false, "async": false, "static": false, "longname": "src/lib/transform/SplittingTransformer.js~SplittingTransformer#combineNodes", "access": "public", "description": "Combines the container node and the source nodes to one single node.", "lineNumber": 72, "params": [ { "nullable": null, "types": [ "BrowsedNode" ], "spread": false, "optional": false, "name": "node", "description": "The container node." }, { "nullable": null, "types": [ "Map" ], "spread": false, "optional": false, "name": "sourceNodes", "description": "The source nodes." }, { "nullable": null, "types": [ "any" ], "spread": false, "optional": false, "name": "context", "description": "The current context." } ], "abstract": true, "return": null }, { "__docId__": 548, "kind": "method", "name": "_combineNodes", "memberof": "src/lib/transform/SplittingTransformer.js~SplittingTransformer", "generator": false, "async": false, "static": false, "longname": "src/lib/transform/SplittingTransformer.js~SplittingTransformer#_combineNodes", "access": "private", "description": "Combines the container node and the source nodes to one single node by calling\n{@link SplittingTransformer#combineNodes}.", "lineNumber": 83, "params": [ { "nullable": null, "types": [ "BrowsedNode" ], "spread": false, "optional": false, "name": "node", "description": "The container node." }, { "nullable": null, "types": [ "{ [extension: string]: BrowedNode }" ], "spread": false, "optional": false, "name": "sourceNodes", "description": "The source nodes." }, { "nullable": null, "types": [ "any" ], "spread": false, "optional": false, "name": "context", "description": "The current context." } ], "return": null }, { "__docId__": 549, "kind": "method", "name": "transformFromFilesystem", "memberof": "src/lib/transform/SplittingTransformer.js~SplittingTransformer", "generator": false, "async": true, "static": false, "longname": "src/lib/transform/SplittingTransformer.js~SplittingTransformer#transformFromFilesystem", "access": "public", "description": "Reads a given container nodes source nodes and combines them.", "lineNumber": 93, "params": [ { "nullable": null, "types": [ "BrowsedNode" ], "spread": false, "optional": false, "name": "node", "description": "The node to transform." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "context", "description": "The browser context." } ], "return": null }, { "__docId__": 550, "kind": "file", "name": "src/lib/transform/Transformer.js", "content": "import Logger from 'gulplog';\n\n/**\n * The directions a transformer can be run in.\n * @type {{FromDB: string, FromFilesystem: string}}\n */\nexport const TransformDirection = {\n FromDB: 'FromDB',\n FromFilesystem: 'FromFilesystem',\n};\n\n/**\n * Checks if the given string is a valid {@link TransformDirection}.\n * @param {string} direction The direction string to check.\n * @return {boolean} `true` if the direction is valid.\n */\nfunction isValidDirection(direction) {\n return [TransformDirection.FromDB, TransformDirection.FromFilesystem].includes(direction);\n}\n\n/**\n * The base transformer class.\n * @abstract\n */\nexport default class Transformer {\n /**\n * Returns a function that combines multiple transformer actions.\n * @param {Transformer[]} transformers An array of transformers.\n * @param {TransformDirection} direction The direction to use.\n * @return {function(node: Node): Promise} The combined transform function.\n */\n static combinedTransformer(transformers, direction) {\n const directed = transformers.map((t) => t.withDirection(direction));\n\n if (direction === TransformDirection.FromFilesystem) {\n directed.reverse();\n }\n\n return async (node, context) => {\n for (const transformer of directed) {\n if ((await transformer.compatTransform(direction, node, context)) !== undefined) {\n // break;\n }\n }\n };\n }\n\n /**\n * Creates a new Transformer with the specified options.\n * @param {Object} [options] The options to use.\n * @param {TransformDirection} [options.direction] The direction to use.\n * @throws {Error} Throws an error if the given direction is invalid.\n */\n constructor({ direction } = {}) {\n if (direction) {\n if (!isValidDirection(direction)) {\n throw new Error('Invalid direction');\n }\n this.direction = direction;\n }\n }\n\n /**\n * Returns the Transformer with the given direction.\n * @param {TransformDirection} direction The direction to use.\n * @return {Transformer} Itself, to be chainable.\n * @throws {Error} Throws an error if the given direction is invalid.\n */\n withDirection(direction) {\n if (!isValidDirection(direction)) {\n throw new Error('Invalid direction');\n }\n\n /**\n * The transformer's direction\n * @type {TransformerDirection}\n */\n this.direction = direction;\n return this;\n }\n\n /**\n * Determines if a node's value node should be read, e.G. The *Variable.Bool* file for a node\n * defined in *.Variable.Bool.Json*.\n * @param {FileNode} node The node to read or not.\n * @return {boolean?} *true* if the node's value file should be read, undefined to let other\n * transformers decide.\n */\n // eslint-disable-next-line no-unused-vars\n readNodeFile(node) {\n return undefined;\n }\n\n /**\n * **Must be overridden by all subclasses:** Transforms the given node when using\n * {@link TransformDirection.FromDB}.\n * @param {BrowsedNode} node The node to split.\n * @param {Object} context The transform context.\n */\n // eslint-disable-next-line no-unused-vars\n async transformFromDB(node, context) {\n throw new Error('Transformer#transformFromDB must be overridden by all subclasses');\n }\n\n /**\n * **Must be overridden by all subclasses:** Transforms the given node when using\n * {@link TransformDirection.FromFilesystem}.\n * @param {BrowsedNode} node The node to transform.\n * @param {Object} context The browser context.\n */\n // eslint-disable-next-line no-unused-vars\n async transformFromFilesystem(node, context) {\n throw new Error('Transformer#transformFromFilesystem must be overridden by all subclasses');\n }\n\n /**\n * A transform wrapper that works with both async/await (atscm >= 1) and callback-based\n * (atscm < 1)transformers.\n * @param {TransformDirection} direction The direction to use.\n * @param {Node} node The node to transform.\n * @param {Object} context The browser context.\n */\n compatTransform(direction, node, context) {\n const transform = (direction === TransformDirection.FromDB\n ? this.transformFromDB\n : this.transformFromFilesystem\n ).bind(this);\n\n const fnName = `${this.constructor.name}#transform${\n direction === TransformDirection.FromDB ? 'FromDB' : 'FromFilesystem'\n }`;\n\n return new Promise((resolve, reject) => {\n const promise = transform(node, context, (err, result) => {\n if (!this.constructor._warnedStreamAPI) {\n this.constructor._warnedStreamAPI = true;\n Logger.debug(`Deprecated: ${fnName} uses the Stream API instead of async/await.`);\n }\n if (err) {\n return reject(Object.assign(err, { node }));\n }\n\n // Handle \"repush\"\n if (result === node) {\n return resolve();\n }\n\n return resolve(result);\n });\n\n if (promise instanceof Promise) {\n promise.then(resolve, (err) => reject(Object.assign(err, { node })));\n } else if (this.transformFromDB.length < 3) {\n reject(\n new Error(`${fnName} did not return a Promise.\n - Did you forget \\`async\\`?`)\n );\n }\n });\n }\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/lib/transform/Transformer.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 551, "kind": "variable", "name": "TransformDirection", "memberof": "src/lib/transform/Transformer.js", "static": true, "longname": "src/lib/transform/Transformer.js~TransformDirection", "access": "public", "export": true, "importPath": "atscm/src/lib/transform/Transformer.js", "importStyle": "{TransformDirection}", "description": "The directions a transformer can be run in.", "lineNumber": 7, "type": { "nullable": null, "types": [ "{FromDB: string, FromFilesystem: string}" ], "spread": false, "description": null } }, { "__docId__": 552, "kind": "function", "name": "isValidDirection", "memberof": "src/lib/transform/Transformer.js", "generator": false, "async": false, "static": true, "longname": "src/lib/transform/Transformer.js~isValidDirection", "access": "public", "export": false, "importPath": "atscm/src/lib/transform/Transformer.js", "importStyle": null, "description": "Checks if the given string is a valid {@link TransformDirection}.", "lineNumber": 17, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "direction", "description": "The direction string to check." } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "`true` if the direction is valid." }, "ignore": true }, { "__docId__": 553, "kind": "class", "name": "Transformer", "memberof": "src/lib/transform/Transformer.js", "static": true, "longname": "src/lib/transform/Transformer.js~Transformer", "access": "public", "export": true, "importPath": "atscm/src/lib/transform/Transformer.js", "importStyle": "Transformer", "description": "The base transformer class.", "lineNumber": 25, "abstract": true, "interface": false }, { "__docId__": 554, "kind": "method", "name": "combinedTransformer", "memberof": "src/lib/transform/Transformer.js~Transformer", "generator": false, "async": false, "static": true, "longname": "src/lib/transform/Transformer.js~Transformer.combinedTransformer", "access": "public", "description": "Returns a function that combines multiple transformer actions.", "lineNumber": 32, "params": [ { "nullable": null, "types": [ "Transformer[]" ], "spread": false, "optional": false, "name": "transformers", "description": "An array of transformers." }, { "nullable": null, "types": [ "TransformDirection" ], "spread": false, "optional": false, "name": "direction", "description": "The direction to use." } ], "return": { "nullable": null, "types": [ "function(node: Node): Promise" ], "spread": false, "description": "The combined transform function." } }, { "__docId__": 555, "kind": "constructor", "name": "constructor", "memberof": "src/lib/transform/Transformer.js~Transformer", "generator": false, "async": false, "static": false, "longname": "src/lib/transform/Transformer.js~Transformer#constructor", "access": "public", "description": "Creates a new Transformer with the specified options.", "lineNumber": 54, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "The options to use." }, { "nullable": null, "types": [ "TransformDirection" ], "spread": false, "optional": true, "name": "options.direction", "description": "The direction to use." } ], "throws": [ { "types": [ "Error" ], "description": "Throws an error if the given direction is invalid." } ] }, { "__docId__": 556, "kind": "member", "name": "direction", "memberof": "src/lib/transform/Transformer.js~Transformer", "static": false, "longname": "src/lib/transform/Transformer.js~Transformer#direction", "access": "public", "description": null, "lineNumber": 59, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 557, "kind": "method", "name": "withDirection", "memberof": "src/lib/transform/Transformer.js~Transformer", "generator": false, "async": false, "static": false, "longname": "src/lib/transform/Transformer.js~Transformer#withDirection", "access": "public", "description": "Returns the Transformer with the given direction.", "lineNumber": 69, "params": [ { "nullable": null, "types": [ "TransformDirection" ], "spread": false, "optional": false, "name": "direction", "description": "The direction to use." } ], "return": { "nullable": null, "types": [ "Transformer" ], "spread": false, "description": "Itself, to be chainable." }, "throws": [ { "types": [ "Error" ], "description": "Throws an error if the given direction is invalid." } ] }, { "__docId__": 559, "kind": "method", "name": "readNodeFile", "memberof": "src/lib/transform/Transformer.js~Transformer", "generator": false, "async": false, "static": false, "longname": "src/lib/transform/Transformer.js~Transformer#readNodeFile", "access": "public", "description": "Determines if a node's value node should be read, e.G. The *Variable.Bool* file for a node\ndefined in *.Variable.Bool.Json*.", "lineNumber": 90, "params": [ { "nullable": null, "types": [ "FileNode" ], "spread": false, "optional": false, "name": "node", "description": "The node to read or not." } ], "return": { "nullable": null, "types": [ "boolean?" ], "spread": false, "description": "*true* if the node's value file should be read, undefined to let other\ntransformers decide." } }, { "__docId__": 560, "kind": "method", "name": "transformFromDB", "memberof": "src/lib/transform/Transformer.js~Transformer", "generator": false, "async": true, "static": false, "longname": "src/lib/transform/Transformer.js~Transformer#transformFromDB", "access": "public", "description": "**Must be overridden by all subclasses:** Transforms the given node when using\n{@link TransformDirection.FromDB}.", "lineNumber": 101, "params": [ { "nullable": null, "types": [ "BrowsedNode" ], "spread": false, "optional": false, "name": "node", "description": "The node to split." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "context", "description": "The transform context." } ], "return": null }, { "__docId__": 561, "kind": "method", "name": "transformFromFilesystem", "memberof": "src/lib/transform/Transformer.js~Transformer", "generator": false, "async": true, "static": false, "longname": "src/lib/transform/Transformer.js~Transformer#transformFromFilesystem", "access": "public", "description": "**Must be overridden by all subclasses:** Transforms the given node when using\n{@link TransformDirection.FromFilesystem}.", "lineNumber": 112, "params": [ { "nullable": null, "types": [ "BrowsedNode" ], "spread": false, "optional": false, "name": "node", "description": "The node to transform." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "context", "description": "The browser context." } ], "return": null }, { "__docId__": 562, "kind": "method", "name": "compatTransform", "memberof": "src/lib/transform/Transformer.js~Transformer", "generator": false, "async": false, "static": false, "longname": "src/lib/transform/Transformer.js~Transformer#compatTransform", "access": "public", "description": "A transform wrapper that works with both async/await (atscm >= 1) and callback-based\n(atscm < 1)transformers.", "lineNumber": 123, "params": [ { "nullable": null, "types": [ "TransformDirection" ], "spread": false, "optional": false, "name": "direction", "description": "The direction to use." }, { "nullable": null, "types": [ "Node" ], "spread": false, "optional": false, "name": "node", "description": "The node to transform." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "context", "description": "The browser context." } ], "return": { "types": [ "*" ] } }, { "__docId__": 563, "kind": "file", "name": "src/lib/transform/XMLTransformer.js", "content": "import { EOL } from 'os';\nimport { parse, render, isElement, moveToTop, attributeValues } from 'modify-xml';\nimport { TransformDirection } from './Transformer';\nimport SplittingTransformer from './SplittingTransformer';\n\nfunction walk(element, action, filter = isElement) {\n action(element);\n\n if (element.childNodes) {\n for (const child of element.childNodes.filter((n) => filter(n))) {\n walk(child, action);\n }\n }\n}\n\n/**\n * A transformer used to transform XML documents.\n */\nexport default class XMLTransformer extends SplittingTransformer {\n /**\n * Creates a new XMLTransformer based on some options.\n * @param {Object} [options] The options to use.\n */\n constructor({ sortXMLAttributes = false, removeBuilderRefs = false, ...options } = {}) {\n super(options);\n\n /** @protected */\n this.sortXMLAttributes = sortXMLAttributes;\n\n /** @protected */\n this.removeBuilderRefs = removeBuilderRefs;\n\n function build(object, buildOptions) {\n const root = object.childNodes.find((n) => isElement(n));\n\n if (root) {\n moveToTop(root, 'metadata');\n moveToTop(root, 'defs');\n moveToTop(root, 'desc');\n moveToTop(root, 'title');\n }\n\n if (sortXMLAttributes || removeBuilderRefs)\n walk(root, (e) => {\n /* eslint-disable no-param-reassign */\n if (removeBuilderRefs)\n e.attributes = e.attributes.filter((a) => !['atv:refpx', 'atv:refpy'].includes(a.name));\n\n if (sortXMLAttributes)\n e.attributes = e.attributes.sort((a, b) => (b.name > a.name ? -1 : 1));\n\n delete e.openTag;\n /* eslint-enable no-param-reassign */\n });\n\n return render(object, { indent: ' '.repeat(buildOptions.spaces) });\n }\n\n // eslint-disable-next-line jsdoc/require-param\n /**\n * The builder to use with direction {@link TransformDirection.FromDB}.\n * @type {function(object: Object): string}\n */\n this._fromDBBuilder = (object) => {\n const xml = build(object, { compact: false, spaces: 2 });\n return xml.replace(/\\r?\\n/g, EOL);\n };\n\n // eslint-disable-next-line jsdoc/require-param\n /**\n * The builder to use with direction {@link TransformDirection.FromFilesystem}.\n * @type {function(object: Object): string}\n */\n this._fromFilesystemBuilder = (object) => {\n const xml = build(object, { compact: false, spaces: 1 });\n return xml.replace(/\\r?\\n/g, '\\n');\n };\n }\n\n /**\n * @protected\n * @param {import('modify-xml').Element} node The node to handle.\n */\n sortedAttributeValues(node) {\n if (!this.sortXMLAttributes) return attributeValues(node);\n\n return Object.fromEntries(\n Object.entries(attributeValues(node)).sort((a, b) => (b > a ? -1 : 1))\n );\n }\n\n /**\n * Returns the XML builder to use based on the current {@link Transformer#direction}.\n * @type {function(object: Object): string}\n */\n get builder() {\n return this.direction === TransformDirection.FromDB\n ? this._fromDBBuilder\n : this._fromFilesystemBuilder;\n }\n\n /**\n * Parses XML in a node's contents.\n * @param {Node} node The node to process.\n */\n decodeContents(node) {\n const rawLines =\n this.direction === TransformDirection.FromDB ? node.value.value.toString() : node.stringValue;\n\n try {\n return parse(rawLines);\n } catch (error) {\n if (error.line) {\n Object.assign(error, {\n rawLines,\n location: {\n start: {\n line: error.line + 1,\n column: error.column + 1,\n },\n },\n });\n }\n\n throw error;\n }\n }\n\n /**\n * Builds an XML string from an object.\n * @param {Object} object The object to encode.\n */\n encodeContents(object) {\n return this.builder(object);\n }\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/lib/transform/XMLTransformer.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 564, "kind": "function", "name": "walk", "memberof": "src/lib/transform/XMLTransformer.js", "generator": false, "async": false, "static": true, "longname": "src/lib/transform/XMLTransformer.js~walk", "access": "public", "export": false, "importPath": "atscm/src/lib/transform/XMLTransformer.js", "importStyle": null, "description": null, "lineNumber": 6, "undocument": true, "params": [ { "name": "element", "types": [ "*" ] }, { "name": "action", "types": [ "*" ] }, { "name": "filter", "optional": true, "types": [ "*" ], "defaultRaw": "isElement", "defaultValue": "isElement" } ], "return": null, "ignore": true }, { "__docId__": 565, "kind": "class", "name": "XMLTransformer", "memberof": "src/lib/transform/XMLTransformer.js", "static": true, "longname": "src/lib/transform/XMLTransformer.js~XMLTransformer", "access": "public", "export": true, "importPath": "atscm/src/lib/transform/XMLTransformer.js", "importStyle": "XMLTransformer", "description": "A transformer used to transform XML documents.", "lineNumber": 19, "interface": false, "extends": [ "src/lib/transform/SplittingTransformer.js~SplittingTransformer" ] }, { "__docId__": 566, "kind": "constructor", "name": "constructor", "memberof": "src/lib/transform/XMLTransformer.js~XMLTransformer", "generator": false, "async": false, "static": false, "longname": "src/lib/transform/XMLTransformer.js~XMLTransformer#constructor", "access": "public", "description": "Creates a new XMLTransformer based on some options.", "lineNumber": 24, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "The options to use." } ] }, { "__docId__": 567, "kind": "member", "name": "sortXMLAttributes", "memberof": "src/lib/transform/XMLTransformer.js~XMLTransformer", "static": false, "longname": "src/lib/transform/XMLTransformer.js~XMLTransformer#sortXMLAttributes", "access": "protected", "description": null, "lineNumber": 28, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 568, "kind": "member", "name": "removeBuilderRefs", "memberof": "src/lib/transform/XMLTransformer.js~XMLTransformer", "static": false, "longname": "src/lib/transform/XMLTransformer.js~XMLTransformer#removeBuilderRefs", "access": "protected", "description": null, "lineNumber": 31, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 569, "kind": "member", "name": "_fromDBBuilder", "memberof": "src/lib/transform/XMLTransformer.js~XMLTransformer", "static": false, "longname": "src/lib/transform/XMLTransformer.js~XMLTransformer#_fromDBBuilder", "access": "private", "description": "The builder to use with direction {@link TransformDirection.FromDB}.", "lineNumber": 64, "type": { "nullable": null, "types": [ "function(object: Object): string" ], "spread": false, "description": null } }, { "__docId__": 570, "kind": "member", "name": "_fromFilesystemBuilder", "memberof": "src/lib/transform/XMLTransformer.js~XMLTransformer", "static": false, "longname": "src/lib/transform/XMLTransformer.js~XMLTransformer#_fromFilesystemBuilder", "access": "private", "description": "The builder to use with direction {@link TransformDirection.FromFilesystem}.", "lineNumber": 74, "type": { "nullable": null, "types": [ "function(object: Object): string" ], "spread": false, "description": null } }, { "__docId__": 571, "kind": "method", "name": "sortedAttributeValues", "memberof": "src/lib/transform/XMLTransformer.js~XMLTransformer", "generator": false, "async": false, "static": false, "longname": "src/lib/transform/XMLTransformer.js~XMLTransformer#sortedAttributeValues", "access": "protected", "description": "", "lineNumber": 84, "params": [ { "nullable": null, "types": [ "import('modify-xml').Element" ], "spread": false, "optional": false, "name": "node", "description": "The node to handle." } ], "ignore": true, "return": { "types": [ "*" ] } }, { "__docId__": 572, "kind": "get", "name": "builder", "memberof": "src/lib/transform/XMLTransformer.js~XMLTransformer", "generator": false, "async": false, "static": false, "longname": "src/lib/transform/XMLTransformer.js~XMLTransformer#builder", "access": "public", "description": "Returns the XML builder to use based on the current {@link Transformer#direction}.", "lineNumber": 96, "type": { "nullable": null, "types": [ "function(object: Object): string" ], "spread": false, "description": null } }, { "__docId__": 573, "kind": "method", "name": "decodeContents", "memberof": "src/lib/transform/XMLTransformer.js~XMLTransformer", "generator": false, "async": false, "static": false, "longname": "src/lib/transform/XMLTransformer.js~XMLTransformer#decodeContents", "access": "public", "description": "Parses XML in a node's contents.", "lineNumber": 106, "params": [ { "nullable": null, "types": [ "Node" ], "spread": false, "optional": false, "name": "node", "description": "The node to process." } ], "return": { "types": [ "*" ] } }, { "__docId__": 574, "kind": "method", "name": "encodeContents", "memberof": "src/lib/transform/XMLTransformer.js~XMLTransformer", "generator": false, "async": false, "static": false, "longname": "src/lib/transform/XMLTransformer.js~XMLTransformer#encodeContents", "access": "public", "description": "Builds an XML string from an object.", "lineNumber": 133, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "object", "description": "The object to encode." } ], "return": { "types": [ "*" ] } }, { "__docId__": 575, "kind": "file", "name": "src/tasks/import.js", "content": "import { src } from 'gulp';\nimport scripts from '@atscm/server-scripts';\nimport { version } from '@atscm/server-scripts/package.json';\nimport toPromise from 'stream-to-promise';\nimport { DataType } from 'node-opcua/lib/datamodel/variant';\nimport { StatusCodes } from 'node-opcua/lib/datamodel/opcua_status_code';\nimport Logger from 'gulplog';\nimport ImportStream from '../lib/gulp/ImportStream';\nimport { writeNode, createNode } from '../api';\nimport { versionNode } from '../lib/server/scripts/version';\nimport { delay } from '../lib/helpers/async';\nimport { handleTaskError, finishTask } from '../lib/helpers/tasks';\nimport Session from '../lib/server/Session';\nimport { setupContext } from '../hooks/hooks';\nimport checkAtserver from '../hooks/check-atserver';\n\n/**\n * Imports all xml files needed for atscm usage.\n * @return {Promise} The running task.\n */\nexport default async function importTask() {\n const srcStream = src(scripts);\n const versionVariant = { dataType: DataType.String, value: version };\n\n Session.pool();\n\n const context = setupContext();\n await checkAtserver(context);\n\n return toPromise(srcStream.pipe(new ImportStream()))\n .then(() => writeNode(versionNode, versionVariant))\n .catch((err) => {\n if (err.statusCode === StatusCodes.BadNodeIdUnknown) {\n const maxTries = 20;\n const retryDelay = 100;\n\n let tryNo = 0;\n const tryToCreate = () => {\n tryNo++;\n\n return createNode(versionNode, {\n name: 'version',\n value: versionVariant,\n }).then(async ({ outputArguments }) => {\n if (outputArguments[3].value.length < 2) {\n if (tryNo < maxTries) {\n Logger.debug(`Create script is not ready yet. Retrying after ${retryDelay}ms`);\n\n await delay(retryDelay);\n return tryToCreate();\n }\n\n throw new Error('CreateNode script is not ready yet. Try again later');\n }\n\n return true;\n });\n };\n\n return tryToCreate().then(() => Logger.debug(`Import worked on attempt # ${tryNo}`));\n }\n\n throw err;\n })\n .then(finishTask, handleTaskError);\n}\n\nimportTask.description = 'Imports all xml resources needed for atscm usage';\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/tasks/import.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 576, "kind": "function", "name": "importTask", "memberof": "src/tasks/import.js", "generator": false, "async": true, "static": true, "longname": "src/tasks/import.js~importTask", "access": "public", "export": true, "importPath": "atscm/src/tasks/import.js", "importStyle": "importTask", "description": "Imports all xml files needed for atscm usage.", "lineNumber": 21, "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "The running task." }, "params": [] }, { "__docId__": 577, "kind": "file", "name": "src/tasks/pull.js", "content": "import parseOptions from 'mri';\nimport { emptyDir } from 'fs-extra';\nimport Logger from 'gulplog';\nimport NodeBrowser from '../lib/server/NodeBrowser';\nimport ProjectConfig from '../config/ProjectConfig';\nimport Transformer, { TransformDirection } from '../lib/transform/Transformer.js';\nimport dest from '../lib/gulp/dest';\nimport { reportProgress } from '../lib/helpers/log';\nimport { handleTaskError, finishTask } from '../lib/helpers/tasks';\nimport Session from '../lib/server/Session';\nimport checkAtserver from '../hooks/check-atserver';\nimport { setupContext } from '../hooks/hooks';\n\n/**\n * Pulls the given nodes from the server.\n * @param {NodeId[]} nodes The nodes to pull from the server.\n * @param {Object} options Options passed to {@link NodeBrowser}.\n */\nexport function performPull(nodes, options = {}) {\n const writeStream = dest('./src', { cleanRenameConfig: options.clean });\n const applyTransforms = Transformer.combinedTransformer(\n ProjectConfig.useTransformers,\n TransformDirection.FromDB\n );\n\n const browser = new NodeBrowser({\n ...options,\n async handleNode(node, { transform = true } = {}) {\n let removed = false;\n const context = {\n _added: [],\n addNode(n) {\n this._added.push(n);\n },\n remove: () => {\n removed = true;\n },\n };\n\n if (transform) {\n await applyTransforms(node, context);\n }\n\n if (removed) {\n return;\n }\n await writeStream.writeAsync(node);\n\n // Enqueue added nodes\n if (context._added.length) {\n context._added.forEach((n) => this.addNode(n));\n }\n },\n });\n\n return Object.assign(\n browser.browse(nodes).then(() => writeStream.writeRenamefile()),\n {\n browser,\n }\n );\n}\n\n/**\n * Pulls all nodes from atvise server.\n * @param {Object} [options] The options to use.\n * @param {boolean} [options.clean] If the source directory should be cleaned first.\n */\nexport default async function pull(options) {\n const { clean } = typeof options === 'object' ? options : parseOptions(process.argv.slice(2));\n\n Session.pool();\n\n // Run hooks\n const context = setupContext();\n await checkAtserver(context);\n\n if (clean) {\n Logger.info('Using --clean, removing pulled files first');\n await emptyDir('./src');\n }\n\n const promise = performPull(ProjectConfig.nodes, { clean });\n\n return reportProgress(promise, {\n getter: () => promise.browser._pushed,\n formatter: (count) => `Processed ${count} nodes`,\n }).then(finishTask, handleTaskError);\n}\n\npull.description = 'Pull all nodes from atvise server';\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/tasks/pull.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 578, "kind": "function", "name": "performPull", "memberof": "src/tasks/pull.js", "generator": false, "async": false, "static": true, "longname": "src/tasks/pull.js~performPull", "access": "public", "export": true, "importPath": "atscm/src/tasks/pull.js", "importStyle": "{performPull}", "description": "Pulls the given nodes from the server.", "lineNumber": 19, "params": [ { "nullable": null, "types": [ "NodeId[]" ], "spread": false, "optional": false, "name": "nodes", "description": "The nodes to pull from the server." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options", "description": "Options passed to {@link NodeBrowser}." } ], "return": { "types": [ "*" ] } }, { "__docId__": 579, "kind": "function", "name": "pull", "memberof": "src/tasks/pull.js", "generator": false, "async": true, "static": true, "longname": "src/tasks/pull.js~pull", "access": "public", "export": true, "importPath": "atscm/src/tasks/pull.js", "importStyle": "pull", "description": "Pulls all nodes from atvise server.", "lineNumber": 69, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "The options to use." }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": true, "name": "options.clean", "description": "If the source directory should be cleaned first." } ], "return": { "types": [ "*" ] } }, { "__docId__": 580, "kind": "file", "name": "src/tasks/push.js", "content": "import Logger from 'gulplog';\nimport { StatusCodes } from 'node-opcua/lib/datamodel/opcua_status_code';\nimport { NodeClass } from 'node-opcua/lib/datamodel/nodeclass';\nimport src from '../lib/gulp/src';\nimport { writeNode, createNode, addReferences } from '../api';\nimport Transformer, { TransformDirection } from '../lib/transform/Transformer.js';\nimport NodeId from '../lib/model/opcua/NodeId.js';\nimport { ReferenceTypeIds, ReferenceTypeNames } from '../lib/model/Node';\nimport { reportProgress } from '../lib/helpers/log.js';\nimport ProjectConfig from '../config/ProjectConfig.js';\nimport { finishTask, handleTaskError } from '../lib/helpers/tasks.js';\nimport Session from '../lib/server/Session.js';\nimport checkServerscripts from '../hooks/check-serverscripts';\nimport checkAtserver from '../hooks/check-atserver';\nimport { setupContext } from '../hooks/hooks';\n\n/**\n * Status codes indicating a node is opened in atvise builder and therefore not writable right now.\n * @type {Set}\n */\nconst openInBuilderStatus = new Set([StatusCodes.BadUserAccessDenied, StatusCodes.BadNotWritable]);\n\n/**\n * The reference types ignored when adding references. The corresponding references are created\n * alongside the node itself using the 'CreateNode' server script.\n * @type {Set}\n */\nconst ignoredReferences = new Set([\n ReferenceTypeIds.toParent,\n ReferenceTypeIds.HasTypeDefinition,\n // ReferenceTypeIds.HasModellingRule,\n]);\n\n/**\n * Pushes the given path to the server.\n * @param {string} path The local path to push.\n * @param {Object} options Options passed to {@link src}.\n */\nexport function performPush(path, options) {\n const applyTransforms = Transformer.combinedTransformer(\n ProjectConfig.useTransformers,\n TransformDirection.FromFilesystem\n );\n\n const ensureReferences = (node) => {\n const references = [...node.references].reduce((result, [key, value]) => {\n if (ignoredReferences.has(key)) {\n return result;\n }\n\n return Object.assign(result, {\n [key]: [...value].map((s) => (typeof s === 'string' ? `ns=1;s=${s}` : s)),\n });\n }, {});\n\n if (Object.keys(references).length > 0) {\n return addReferences(node.nodeId, references)\n .then(({ outputArguments }) => {\n const [{ value: failures }] = outputArguments[3].value;\n\n if (failures) {\n throw new Error(\n `Failed to create reference(s) from ${node.nodeId} to ${failures.join(', ')}`\n );\n } else {\n Logger.debug(`Added ${Object.keys(references).length} reference(s) to ${node.nodeId}`);\n }\n })\n .catch((err) => {\n throw Object.assign(err, { node });\n });\n }\n\n return Promise.resolve();\n };\n\n const create = (node) => {\n const nodeId = new NodeId(node.nodeId);\n let parentNodeId = node.parent && node.parent.nodeId;\n\n if (!node.parent) {\n parentNodeId = nodeId.parent;\n Logger.debug(`Assuming ${parentNodeId} as parent of ${node.nodeId}`);\n }\n\n return createNode(nodeId, {\n name: node.name,\n parentNodeId,\n nodeClass: node.nodeClass,\n typeDefinition: node.typeDefinition,\n modellingRule: node.modellingRule,\n reference: ReferenceTypeNames[node.references.getSingle(ReferenceTypeIds.toParent)],\n value:\n node.nodeClass && node.nodeClass.value === NodeClass.Variable.value && node.variantValue,\n })\n .then(({ outputArguments }) => {\n const [{ value: createdNode }, { value: createFailed }] = outputArguments[3].value;\n\n if (createFailed) {\n Logger.warn('Failed to create node', node.nodeId);\n return Promise.resolve();\n } else if (createdNode) {\n Logger.debug('Created node', node.nodeId);\n } else {\n // Node already existed\n }\n\n return ensureReferences(node);\n })\n .catch((err) => {\n throw Object.assign(err, { node });\n });\n };\n\n return src(path, {\n ...options,\n readNodeFile(node) {\n const r = ProjectConfig.useTransformers\n .reverse()\n .reduce((result, t) => (result === undefined ? t.readNodeFile(node) : result), undefined);\n return r === undefined ? true : r;\n },\n async handleNode(node) {\n // NOTE: context = this\n await applyTransforms(node, this);\n\n if (node.push === false) {\n // Skip write\n return false;\n }\n\n // Create / write node\n if (node.nodeClass.value !== NodeClass.Variable.value) {\n return create(node);\n }\n\n // console.error('write', node.nodeId, node.value);\n return writeNode(`ns=1;s=${node.nodeId}`, node.variantValue).then(\n () => ensureReferences(node),\n (err) => {\n if (openInBuilderStatus.has(err.statusCode)) {\n Logger.warn(`Error writing node ${node.nodeId}\n - Make sure it is not opened in atvise builder\n - Make sure the corresponding datasource is connected`);\n return StatusCodes.Good;\n }\n\n if (err.statusCode === StatusCodes.BadNodeIdUnknown) {\n Logger.debug(`Node ${node.nodeId} does not exist: Attempting to create it...`);\n\n return create(node);\n }\n\n throw Object.assign(err, { node });\n }\n );\n },\n });\n}\n\n/**\n * Pushes {@link AtviseFile}s to atvise server.\n */\nexport default async function push() {\n Session.pool();\n\n const context = setupContext();\n\n const { version: atserverVersion } = await checkAtserver(context);\n await checkServerscripts(context);\n\n const promise = performPush('./src', { atserverVersion });\n\n return reportProgress(promise, {\n getter: () => promise.browser._pushedPath.size,\n formatter: (count) => `Processed ${count} files`,\n }).then(finishTask, handleTaskError);\n}\n\npush.description = 'Push all stored nodes to atvise server';\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/tasks/push.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 581, "kind": "variable", "name": "openInBuilderStatus", "memberof": "src/tasks/push.js", "static": true, "longname": "src/tasks/push.js~openInBuilderStatus", "access": "public", "export": false, "importPath": "atscm/src/tasks/push.js", "importStyle": null, "description": "Status codes indicating a node is opened in atvise builder and therefore not writable right now.", "lineNumber": 21, "type": { "nullable": null, "types": [ "Set" ], "spread": false, "description": null }, "ignore": true }, { "__docId__": 582, "kind": "variable", "name": "ignoredReferences", "memberof": "src/tasks/push.js", "static": true, "longname": "src/tasks/push.js~ignoredReferences", "access": "public", "export": false, "importPath": "atscm/src/tasks/push.js", "importStyle": null, "description": "The reference types ignored when adding references. The corresponding references are created\nalongside the node itself using the 'CreateNode' server script.", "lineNumber": 28, "type": { "nullable": null, "types": [ "Set" ], "spread": false, "description": null }, "ignore": true }, { "__docId__": 583, "kind": "function", "name": "performPush", "memberof": "src/tasks/push.js", "generator": false, "async": false, "static": true, "longname": "src/tasks/push.js~performPush", "access": "public", "export": true, "importPath": "atscm/src/tasks/push.js", "importStyle": "{performPush}", "description": "Pushes the given path to the server.", "lineNumber": 39, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "path", "description": "The local path to push." }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options", "description": "Options passed to {@link src}." } ], "return": { "types": [ "*" ] } }, { "__docId__": 584, "kind": "function", "name": "push", "memberof": "src/tasks/push.js", "generator": false, "async": true, "static": true, "longname": "src/tasks/push.js~push", "access": "public", "export": true, "importPath": "atscm/src/tasks/push.js", "importStyle": "push", "description": "Pushes {@link AtviseFile}s to atvise server.", "lineNumber": 164, "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 585, "kind": "file", "name": "src/tasks/watch.js", "content": "import { join } from 'path';\nimport sane from 'sane';\nimport browserSync from 'browser-sync';\nimport Logger from 'gulplog';\nimport ServerWatcher from '../lib/server/Watcher';\nimport { delay } from '../lib/helpers/async';\nimport { handleTaskError } from '../lib/helpers/tasks';\nimport ProjectConfig from '../config/ProjectConfig';\nimport { validateDirectoryExists } from '../util/fs';\nimport { setupContext } from '../hooks/hooks';\nimport checkAtserver from '../hooks/check-atserver';\nimport checkServerscripts from '../hooks/check-serverscripts';\nimport { performPull } from './pull';\nimport { performPush } from './push';\n\n/**\n * The task executed when running `atscm watch`.\n */\nexport class WatchTask {\n /**\n * Creates a new watch task instance. Also creates a new Browsersync instance.\n */\n constructor() {\n /**\n * The Browsersync instance used.\n * @type {events~Emitter}\n */\n this.browserSyncInstance = browserSync.create();\n\n /**\n * If the task is currently pulling.\n * @type {boolean}\n */\n this._pulling = false;\n\n /**\n * If the task is currently pushing.\n * @type {boolean}\n */\n this._pushing = false;\n\n /**\n * Timestamp of the last pull\n * @type {number}\n */\n this._lastPull = 0;\n\n /**\n * The {@link NodeId} of the last push.\n * @type {?NodeId}\n */\n this._lastPushed = null;\n }\n\n /**\n * The directory to watch.\n * @type {string}\n */\n get directoryToWatch() {\n return './src';\n }\n\n /**\n * Waits for a watcher (which can actually be any kind of {@link events~Emitter}) to emit a\n * \"ready\" event.\n * @param {events~Emitter} watcher The watcher to wait for.\n * @return {Promise} Fulfilled with the set up watcher or rejected with the\n * watcher error that occurred while waiting for it to get ready.\n */\n _waitForWatcher(watcher) {\n return new Promise((resolve, reject) => {\n watcher.on('error', (err) => reject(err));\n watcher.on('ready', () => resolve(watcher));\n });\n }\n\n /**\n * Starts a file watcher for the directory {@link WatchTask#directoryToWatch}.\n * @return {Promise} Fulfilled with the file watcher once it is ready or\n * rejected with the error that occurred while starting the watcher.\n */\n startFileWatcher() {\n return validateDirectoryExists(this.directoryToWatch)\n .catch((err) => {\n if (err.code === 'ENOENT') {\n Logger.info(`Create a directory at ${this.directoryToWatch} or run \\`atscm pull\\` first`);\n\n Object.assign(err, {\n message: `Directory ${this.directoryToWatch} does not exist`,\n });\n }\n\n throw err;\n })\n .then(() =>\n this._waitForWatcher(\n sane(this.directoryToWatch, {\n glob: '**/*.*',\n watchman: process.platform === 'darwin',\n })\n )\n );\n }\n\n /**\n * Starts a watcher that watches the atvise server for changes.\n * @return {Promise} Fulfilled with the server watcher once it is ready or\n * rejected with the error that occurred while starting the watcher.\n */\n startServerWatcher() {\n return this._waitForWatcher(new ServerWatcher());\n }\n\n /**\n * Initializes {@link WatchTask#browserSyncInstance}.\n * @param {Object} options The options to pass to browsersync.\n * @see https://browsersync.io/docs/options\n */\n initBrowserSync(options) {\n this.browserSyncInstance.init(\n Object.assign(\n {\n proxy: `${ProjectConfig.host}:${ProjectConfig.port.http}`,\n ws: true,\n // logLevel: 'debug', FIXME: Use log level specified in cli options\n // logPrefix: '',\n },\n options\n )\n );\n\n /* bs.logger.logOne = function(args, msg, level, unprefixed) {\n args = args.slice(2);\n\n if (this.config.useLevelPrefixes && !unprefixed) {\n msg = this.config.prefixes[level] + msg;\n }\n\n msg = this.compiler.compile(msg, unprefixed);\n\n args.unshift(msg);\n\n Logger[level](format(...args));\n\n this.resetTemps();\n\n return this;\n }; */\n }\n\n /**\n * Prints an error that happened while handling a change.\n * @param {string} contextMessage Describes the currently run action.\n * @param {Error} err The error that occured.\n */\n printTaskError(contextMessage, err) {\n try {\n handleTaskError(err);\n } catch (refined) {\n Logger.error(contextMessage, refined.message, refined.stack);\n }\n }\n\n /**\n * Handles a file change.\n * @param {string} path The path of the file that changed.\n * @param {string} root The root of the file that changed.\n * @return {Promise} Resolved with `true` if the change triggered a push operation,\n * with `false` otherwise.\n */\n handleFileChange(path, root) {\n if (this._handlingChange) {\n Logger.debug('Ignoring', path, 'changed');\n return Promise.resolve(false);\n }\n\n this._handlingChange = true;\n Logger.info(path, 'changed');\n\n return performPush(join(root, path), { singleNode: true })\n .catch((err) => this.printTaskError('Push failed', err))\n .then(async () => {\n this.browserSyncInstance.reload();\n\n await delay(500);\n\n this._handlingChange = false;\n });\n }\n\n /**\n * Handles an atvise server change.\n * @param {ReadStream.ReadResult} readResult The read result of the modification.\n * @return {Promise} Resolved with `true` if the change triggered a pull operation,\n * with `false` otherwise.\n */\n handleServerChange(readResult) {\n if (this._handlingChange) {\n Logger.debug('Ignoring', readResult.nodeId.value, 'changed');\n return Promise.resolve(false);\n }\n\n this._handlingChange = true;\n Logger.info(readResult.nodeId.value, 'changed');\n\n return performPull([readResult.nodeId], { recursive: false })\n .catch((err) => this.printTaskError('Pull failed', err))\n .then(async () => {\n this.browserSyncInstance.reload();\n\n await delay(500);\n\n this._handlingChange = false;\n });\n }\n\n /**\n * Starts the file and server watchers, initializes Browsersync and registers change event\n * handlers.\n * @param {Object} [options] The options to pass to browsersync.\n * @param {boolean} [options.open=true] If the browser should be opened once browsersync is up.\n * @return {Promise<{ serverWatcher: Watcher, fileWatcher: sane~Watcher }, Error>} Fulfilled once\n * all watchers are set up and Browsersync was initialized.\n */\n run({ open = true } = {}) {\n return Promise.all([this.startFileWatcher(), this.startServerWatcher()]).then(\n ([fileWatcher, serverWatcher]) => {\n this.browserSyncInstance.emitter.on('service:running', () => {\n Logger.info('Watching for changes...');\n Logger.debug('Press Ctrl-C to exit');\n });\n\n fileWatcher.on('change', this.handleFileChange.bind(this));\n serverWatcher.on('change', this.handleServerChange.bind(this));\n\n this.initBrowserSync({ open });\n\n return { fileWatcher, serverWatcher };\n }\n );\n }\n}\n\n/**\n * The gulp task invoced when running `atscm watch`.\n * @param {Object} options The options to pass to the watch task, see {@link WatchTask#run} for\n * available options.\n * @return {Promise<{ serverWatcher: Watcher, fileWatcher: sane~Watcher }, Error>} Fulfilled once\n * all watchers are set up and Browsersync was initialized.\n */\nexport default async function watch(options) {\n const context = setupContext();\n await checkAtserver(context);\n await checkServerscripts(context);\n\n return new WatchTask().run(options);\n}\n\nwatch.description = 'Watch local files and atvise server nodes to trigger pull/push on change';\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/tasks/watch.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 586, "kind": "class", "name": "WatchTask", "memberof": "src/tasks/watch.js", "static": true, "longname": "src/tasks/watch.js~WatchTask", "access": "public", "export": true, "importPath": "atscm/src/tasks/watch.js", "importStyle": "{WatchTask}", "description": "The task executed when running `atscm watch`.", "lineNumber": 19, "interface": false }, { "__docId__": 587, "kind": "constructor", "name": "constructor", "memberof": "src/tasks/watch.js~WatchTask", "generator": false, "async": false, "static": false, "longname": "src/tasks/watch.js~WatchTask#constructor", "access": "public", "description": "Creates a new watch task instance. Also creates a new Browsersync instance.", "lineNumber": 23 }, { "__docId__": 588, "kind": "member", "name": "browserSyncInstance", "memberof": "src/tasks/watch.js~WatchTask", "static": false, "longname": "src/tasks/watch.js~WatchTask#browserSyncInstance", "access": "public", "description": "The Browsersync instance used.", "lineNumber": 28, "type": { "nullable": null, "types": [ "events~Emitter" ], "spread": false, "description": null } }, { "__docId__": 589, "kind": "member", "name": "_pulling", "memberof": "src/tasks/watch.js~WatchTask", "static": false, "longname": "src/tasks/watch.js~WatchTask#_pulling", "access": "private", "description": "If the task is currently pulling.", "lineNumber": 34, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 590, "kind": "member", "name": "_pushing", "memberof": "src/tasks/watch.js~WatchTask", "static": false, "longname": "src/tasks/watch.js~WatchTask#_pushing", "access": "private", "description": "If the task is currently pushing.", "lineNumber": 40, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 591, "kind": "member", "name": "_lastPull", "memberof": "src/tasks/watch.js~WatchTask", "static": false, "longname": "src/tasks/watch.js~WatchTask#_lastPull", "access": "private", "description": "Timestamp of the last pull", "lineNumber": 46, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 592, "kind": "member", "name": "_lastPushed", "memberof": "src/tasks/watch.js~WatchTask", "static": false, "longname": "src/tasks/watch.js~WatchTask#_lastPushed", "access": "private", "description": "The {@link NodeId} of the last push.", "lineNumber": 52, "type": { "nullable": true, "types": [ "NodeId" ], "spread": false, "description": null } }, { "__docId__": 593, "kind": "get", "name": "directoryToWatch", "memberof": "src/tasks/watch.js~WatchTask", "generator": false, "async": false, "static": false, "longname": "src/tasks/watch.js~WatchTask#directoryToWatch", "access": "public", "description": "The directory to watch.", "lineNumber": 59, "type": { "nullable": null, "types": [ "string" ], "spread": false, "description": null } }, { "__docId__": 594, "kind": "method", "name": "_waitForWatcher", "memberof": "src/tasks/watch.js~WatchTask", "generator": false, "async": false, "static": false, "longname": "src/tasks/watch.js~WatchTask#_waitForWatcher", "access": "private", "description": "Waits for a watcher (which can actually be any kind of {@link events~Emitter}) to emit a\n\"ready\" event.", "lineNumber": 70, "params": [ { "nullable": null, "types": [ "events~Emitter" ], "spread": false, "optional": false, "name": "watcher", "description": "The watcher to wait for." } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "Fulfilled with the set up watcher or rejected with the\nwatcher error that occurred while waiting for it to get ready." } }, { "__docId__": 595, "kind": "method", "name": "startFileWatcher", "memberof": "src/tasks/watch.js~WatchTask", "generator": false, "async": false, "static": false, "longname": "src/tasks/watch.js~WatchTask#startFileWatcher", "access": "public", "description": "Starts a file watcher for the directory {@link WatchTask#directoryToWatch}.", "lineNumber": 82, "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "Fulfilled with the file watcher once it is ready or\nrejected with the error that occurred while starting the watcher." }, "params": [] }, { "__docId__": 596, "kind": "method", "name": "startServerWatcher", "memberof": "src/tasks/watch.js~WatchTask", "generator": false, "async": false, "static": false, "longname": "src/tasks/watch.js~WatchTask#startServerWatcher", "access": "public", "description": "Starts a watcher that watches the atvise server for changes.", "lineNumber": 110, "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "Fulfilled with the server watcher once it is ready or\nrejected with the error that occurred while starting the watcher." }, "params": [] }, { "__docId__": 597, "kind": "method", "name": "initBrowserSync", "memberof": "src/tasks/watch.js~WatchTask", "generator": false, "async": false, "static": false, "longname": "src/tasks/watch.js~WatchTask#initBrowserSync", "access": "public", "description": "Initializes {@link WatchTask#browserSyncInstance}.", "see": [ "https://browsersync.io/docs/options" ], "lineNumber": 119, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options", "description": "The options to pass to browsersync." } ], "return": null }, { "__docId__": 598, "kind": "method", "name": "printTaskError", "memberof": "src/tasks/watch.js~WatchTask", "generator": false, "async": false, "static": false, "longname": "src/tasks/watch.js~WatchTask#printTaskError", "access": "public", "description": "Prints an error that happened while handling a change.", "lineNumber": 156, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "contextMessage", "description": "Describes the currently run action." }, { "nullable": null, "types": [ "Error" ], "spread": false, "optional": false, "name": "err", "description": "The error that occured." } ], "return": null }, { "__docId__": 599, "kind": "method", "name": "handleFileChange", "memberof": "src/tasks/watch.js~WatchTask", "generator": false, "async": false, "static": false, "longname": "src/tasks/watch.js~WatchTask#handleFileChange", "access": "public", "description": "Handles a file change.", "lineNumber": 171, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "path", "description": "The path of the file that changed." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "root", "description": "The root of the file that changed." } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "Resolved with `true` if the change triggered a push operation,\nwith `false` otherwise." } }, { "__docId__": 600, "kind": "member", "name": "_handlingChange", "memberof": "src/tasks/watch.js~WatchTask", "static": false, "longname": "src/tasks/watch.js~WatchTask#_handlingChange", "access": "private", "description": null, "lineNumber": 177, "undocument": true, "type": { "types": [ "boolean" ] } }, { "__docId__": 602, "kind": "method", "name": "handleServerChange", "memberof": "src/tasks/watch.js~WatchTask", "generator": false, "async": false, "static": false, "longname": "src/tasks/watch.js~WatchTask#handleServerChange", "access": "public", "description": "Handles an atvise server change.", "lineNumber": 197, "params": [ { "nullable": null, "types": [ "ReadStream.ReadResult" ], "spread": false, "optional": false, "name": "readResult", "description": "The read result of the modification." } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "Resolved with `true` if the change triggered a pull operation,\nwith `false` otherwise." } }, { "__docId__": 605, "kind": "method", "name": "run", "memberof": "src/tasks/watch.js~WatchTask", "generator": false, "async": false, "static": false, "longname": "src/tasks/watch.js~WatchTask#run", "access": "public", "description": "Starts the file and server watchers, initializes Browsersync and registers change event\nhandlers.", "lineNumber": 225, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "The options to pass to browsersync." }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": true, "defaultValue": "true", "defaultRaw": true, "name": "options.open", "description": "If the browser should be opened once browsersync is up." } ], "return": { "nullable": null, "types": [ "Promise<{ serverWatcher: Watcher, fileWatcher: sane~Watcher }, Error>" ], "spread": false, "description": "Fulfilled once\nall watchers are set up and Browsersync was initialized." } }, { "__docId__": 606, "kind": "function", "name": "watch", "memberof": "src/tasks/watch.js", "generator": false, "async": true, "static": true, "longname": "src/tasks/watch.js~watch", "access": "public", "export": true, "importPath": "atscm/src/tasks/watch.js", "importStyle": "watch", "description": "The gulp task invoced when running `atscm watch`.", "lineNumber": 251, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "options", "description": "The options to pass to the watch task, see {@link WatchTask#run} for\navailable options." } ], "return": { "nullable": null, "types": [ "Promise<{ serverWatcher: Watcher, fileWatcher: sane~Watcher }, Error>" ], "spread": false, "description": "Fulfilled once\nall watchers are set up and Browsersync was initialized." } }, { "__docId__": 607, "kind": "file", "name": "src/transform/AlarmConfigTransformer.ts", "content": "import { DataType } from 'node-opcua/lib/datamodel/variant';\nimport { ItemOf } from 'node-opcua/lib/misc/enum.js';\nimport PartialTransformer from '../lib/transform/PartialTransformer';\nimport Node from '../lib/model/Node';\n\nconst limitNodeNameRegExp = /\\.(upper|lower)_limit(_deadband)?$/;\n\n/**\n * Returns an alarm limit's trigger / source node's data type.\n * Assuming a regular project structure this is the third parent node:\n * **Source** > AlarmConfiguration > AlarmCondition > FilterNode.\n * @param node The limit node to check.\n */\nfunction getLimitTriggerType(node: Node): ItemOf | undefined {\n return (\n node &&\n node.parent &&\n node.parent.parent &&\n node.parent.parent.parent &&\n node.parent.parent.parent.dataType\n );\n}\n\n/**\n * A transformer ensuring no invalid alarm condition filter nodes are pulled.\n */\nexport default class LintTransformer extends PartialTransformer {\n /**\n * Returns `true` for all alarm condition filter nodes.\n * @param node The node to check.\n */\n public shouldBeTransformed(node: Node): boolean {\n return Boolean(\n node.parent &&\n node.parent.hasTypeDefinition('ObjectTypes.ATVISE.AlarmConditionControl.Limit') &&\n node.nodeId.match(limitNodeNameRegExp)\n );\n }\n\n /**\n * Removes filter alarm condition filter nodes that have an invalid dataType.\n * @param node The node to transform.\n * @param context The transform context.\n */\n public async transformFromDB(node: Node, { remove }: { remove: () => void }): Promise {\n if (!this.shouldBeTransformed(node)) return;\n\n const triggerDataType = getLimitTriggerType(node);\n\n // NOTE: When no trigger node was found, the node is ignored as well\n // This means that during incomplete pulls (e.g. in response to a watch event) these nodes are\n // not updated.\n if (node.dataType !== triggerDataType) {\n remove();\n }\n }\n\n /** Does nothing. */\n public async transformFromFilesystem(): Promise {\n return;\n }\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/transform/AlarmConfigTransformer.ts", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 608, "kind": "variable", "name": "limitNodeNameRegExp", "memberof": "src/transform/AlarmConfigTransformer.ts", "static": true, "longname": "src/transform/AlarmConfigTransformer.ts~limitNodeNameRegExp", "access": "public", "export": false, "importPath": "atscm/src/transform/AlarmConfigTransformer.ts", "importStyle": null, "description": null, "lineNumber": 2, "undocument": true, "type": { "types": [ "undefined" ] }, "ignore": true }, { "__docId__": 609, "kind": "function", "name": "getLimitTriggerType", "memberof": "src/transform/AlarmConfigTransformer.ts", "generator": false, "async": false, "static": true, "longname": "src/transform/AlarmConfigTransformer.ts~getLimitTriggerType", "access": "public", "export": false, "importPath": "atscm/src/transform/AlarmConfigTransformer.ts", "importStyle": null, "description": "Returns an alarm limit's trigger / source node's data type.\nAssuming a regular project structure this is the third parent node:\n*Source** > AlarmConfiguration > AlarmCondition > FilterNode.", "lineNumber": 14, "params": [ { "nullable": null, "types": [ "Node" ], "spread": false, "optional": false, "name": "node", "description": "" } ], "return": { "nullable": null, "types": [ "undefined" ], "spread": false, "description": "" }, "ignore": true }, { "__docId__": 610, "kind": "class", "name": "LintTransformer", "memberof": "src/transform/AlarmConfigTransformer.ts", "static": true, "longname": "src/transform/AlarmConfigTransformer.ts~LintTransformer", "access": "public", "export": true, "importPath": "atscm/src/transform/AlarmConfigTransformer.ts", "importStyle": "LintTransformer", "description": "A transformer ensuring no invalid alarm condition filter nodes are pulled.", "lineNumber": 27, "interface": false, "extends": [ "src/lib/transform/PartialTransformer.js~PartialTransformer" ] }, { "__docId__": 611, "kind": "method", "name": "shouldBeTransformed", "memberof": "src/transform/AlarmConfigTransformer.ts~LintTransformer", "generator": false, "async": false, "static": false, "longname": "src/transform/AlarmConfigTransformer.ts~LintTransformer#shouldBeTransformed", "access": "public", "description": "Returns `true` for all alarm condition filter nodes.", "lineNumber": 32, "params": [ { "nullable": null, "types": [ "Node" ], "spread": false, "optional": false, "name": "node", "description": "" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" } }, { "__docId__": 612, "kind": "method", "name": "transformFromDB", "memberof": "src/transform/AlarmConfigTransformer.ts~LintTransformer", "generator": false, "async": true, "static": false, "longname": "src/transform/AlarmConfigTransformer.ts~LintTransformer#transformFromDB", "access": "public", "description": "Removes filter alarm condition filter nodes that have an invalid dataType.", "lineNumber": 45, "params": [ { "nullable": null, "types": [ "Node" ], "spread": false, "optional": false, "name": "node", "description": "" }, { "nullable": null, "types": [ "undefined" ], "spread": false, "optional": false, "name": "undefined", "description": "" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 613, "kind": "method", "name": "transformFromFilesystem", "memberof": "src/transform/AlarmConfigTransformer.ts~LintTransformer", "generator": false, "async": true, "static": false, "longname": "src/transform/AlarmConfigTransformer.ts~LintTransformer#transformFromFilesystem", "access": "public", "description": "Does nothing.", "lineNumber": 59, "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 614, "kind": "file", "name": "src/transform/Mapping.js", "content": "import { basename } from 'path';\nimport assert from 'assert';\nimport { VariantArrayType, DataType } from 'node-opcua/lib/datamodel/variant';\nimport Transformer from '../lib/transform/Transformer';\n\n/**\n * Atvise specific types that need special extensions.\n * @type {Map}\n */\nconst standardTypes = {\n 'VariableTypes.ATVISE.HtmlHelp': {\n extension: '.help.html',\n dataType: DataType.ByteString,\n },\n 'VariableTypes.ATVISE.TranslationTable': {\n extension: '.locs.xml',\n dataType: DataType.XmlElement,\n },\n};\n\n/**\n * Extensions to use for {@link node-opcua~DataType}s.\n * @type {Map}\n */\nconst extensionForDataType = {\n [DataType.Boolean.key]: '.bool',\n [DataType.SByte.key]: '.sbyte',\n [DataType.Byte.key]: '.byte',\n [DataType.Int16.key]: '.int16',\n [DataType.UInt16.key]: '.uint16',\n [DataType.Int32.key]: '.int32',\n [DataType.UInt32.key]: '.uint32',\n [DataType.Int64.key]: '.int64',\n [DataType.UInt64.key]: '.uint64',\n [DataType.Float.key]: '.float',\n [DataType.Double.key]: '.double',\n [DataType.String.key]: '.string',\n [DataType.DateTime.key]: '.datetime',\n [DataType.Guid.key]: '.guid',\n // [DataType.ByteString.key]: '.bytestring',\n [DataType.XmlElement.key]: '.xml',\n [DataType.NodeId.key]: '.nodeid',\n [DataType.ExpandedNodeId.key]: '.enodeid',\n [DataType.StatusCode.key]: '.status',\n [DataType.QualifiedName.key]: '.name',\n [DataType.LocalizedText.key]: '.text',\n [DataType.ExtensionObject.key]: '.obj',\n [DataType.DataValue.key]: '.value',\n [DataType.Variant.key]: '.variant',\n [DataType.DiagnosticInfo.key]: '.info',\n};\n\n/**\n * Extensions to use for {@link node-opcua~VariantArrayType}s.\n * @type {Map}\n */\nconst extensionForArrayType = {\n [VariantArrayType.Array.key]: '.array',\n [VariantArrayType.Matrix.key]: '.matrix',\n};\n\n/**\n * A Transformer that maps {@link ReadStream.ReadResult}s to {@link AtviseFile}s.\n */\nexport default class MappingTransformer extends Transformer {\n /**\n * Creates a new mapping transformer.\n * @param {Object} [options] The arguments passed to the {@link Transformer} constructor.\n */\n constructor(options = {}) {\n super(options);\n\n /**\n * Contents of the reference files read but not used yet.\n * @type {Object}\n */\n this._readReferenceFiles = {};\n }\n\n /**\n * Writes an {@link AtviseFile} for each {@link ReadStream.ReadResult} read. If a read file has a\n * non-standard type (definition) an additional `rc` file is pushed holding this type.\n * @param {Node} node The read result to create the file for.\n * @param {string} encoding The encoding used.\n * @param {function(err: ?Error, data: ?AtviseFile)} callback Called with the error that occurred\n * while transforming the read result or the resulting file.\n */\n transformFromDB(node, encoding, callback) {\n if (!node.fullyMapped && !node.parentResolvesMetadata) {\n // Skip mapping for e.g. split files\n const typeDefinition = node.typeDefinition;\n let isStandardTypeNode = false;\n\n // Add extensions for standard types\n for (const [def, { extension }] of Object.entries(standardTypes)) {\n if (node.isVariable && typeDefinition === def) {\n node.renameTo(`${node.name}${extension}`);\n isStandardTypeNode = true;\n\n // FIXME: Set dataType and mark as resolved\n // FIXME: Set typeDefinition and mark as resolved\n } else if (node.fileName.endsWith(extension)) {\n callback(new Error(`Name conflict: ${node.nodeId} should not end with '${extension}'`));\n return;\n }\n }\n\n // Add extensions for data types\n for (const [type, ext] of Object.entries(extensionForDataType)) {\n if (node.isVariable && node.value && node.value.dataType.key === type) {\n if (!isStandardTypeNode) {\n node.renameTo(`${node.name}${ext}`);\n break;\n }\n\n // FIXME: Set dataType and mark as resolved\n }\n }\n\n // Add extensions for array types\n for (const [type, ext] of Object.entries(extensionForArrayType)) {\n if (node.isVariable && node.value.arrayType.key === type) {\n if (!isStandardTypeNode) {\n node.renameTo(`${node.name}${ext}`);\n }\n\n // FIXME: Set arrayType and mark as resolved\n } else if (node.fileName.endsWith(ext)) {\n callback(new Error(`Name conflict: ${node.nodeId} should not end with '${ext}'`));\n return;\n }\n }\n }\n\n // Compact mapping: Root source folders are AGENT, SYSTEM, ObjectTypes and VariableTypes\n // FIXME: Make optional\n const ignore = new Set([\n 58, // Objects -> Types -> BaseObjectType\n 62, // Objects -> Types -> BaseVariableType\n 85, // Objects\n 86, // Objects -> Types\n ]);\n\n for (let c = node; c && c.parent && !c._compactMappingApplied; c = c.parent) {\n if (ignore.has(c.parent.id.value)) {\n c.parent = c.parent.parent;\n c = node;\n }\n }\n\n Object.assign(node, {\n _compactMappingApplied: true,\n });\n\n callback(null, node);\n }\n\n /**\n * Writes an {@link AtviseFile} for each {@link Node} read.\n * @param {Node} node The raw file.\n * @param {string} encoding The encoding used.\n * @param {function(err: ?Error, data: ?AtviseFile)} callback Called with the error that occurred\n * while transforming the read result or the resulting file.\n */\n transformFromFilesystem(node, encoding, callback) {\n let isStandardTypeNode = false;\n\n // Resolve standard type from extension\n for (const [, { extension }] of Object.entries(standardTypes)) {\n if (node.name.endsWith(extension)) {\n isStandardTypeNode = true;\n\n // FIXME: Set dataType and mark as resolved\n // FIXME: Set typeDefinition and mark as resolved\n\n node.renameTo(basename(node.name, extension));\n }\n }\n\n // Resolve arrayType from extension\n for (const [type, extension] of Object.entries(extensionForArrayType)) {\n if (node.name.endsWith(extension) && !isStandardTypeNode) {\n assert.equal(node.arrayType.key, type);\n\n // FIXME: Set arrayType and mark as resolved\n\n node.renameTo(basename(node.name, extension));\n break;\n }\n }\n\n // Resolve dataType from extension\n for (const [type, extension] of Object.entries(extensionForDataType)) {\n if (node.name.endsWith(extension) && !isStandardTypeNode && node.dataType.key === type) {\n // FIXME: Set dataType and mark as resolved\n\n node.renameTo(basename(node.name, extension));\n break;\n }\n }\n\n return callback(null, node);\n }\n\n /**\n * `true` as the mapping transformer should infer references from config files.\n */\n get transformsReferenceConfigFiles() {\n return true;\n }\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/transform/Mapping.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 615, "kind": "variable", "name": "standardTypes", "memberof": "src/transform/Mapping.js", "static": true, "longname": "src/transform/Mapping.js~standardTypes", "access": "public", "export": false, "importPath": "atscm/src/transform/Mapping.js", "importStyle": null, "description": "Atvise specific types that need special extensions.", "lineNumber": 10, "type": { "nullable": null, "types": [ "Map" ], "spread": false, "description": null }, "ignore": true }, { "__docId__": 616, "kind": "variable", "name": "extensionForDataType", "memberof": "src/transform/Mapping.js", "static": true, "longname": "src/transform/Mapping.js~extensionForDataType", "access": "public", "export": false, "importPath": "atscm/src/transform/Mapping.js", "importStyle": null, "description": "Extensions to use for {@link node-opcua~DataType}s.", "lineNumber": 25, "type": { "nullable": null, "types": [ "Map" ], "spread": false, "description": null }, "ignore": true }, { "__docId__": 617, "kind": "variable", "name": "extensionForArrayType", "memberof": "src/transform/Mapping.js", "static": true, "longname": "src/transform/Mapping.js~extensionForArrayType", "access": "public", "export": false, "importPath": "atscm/src/transform/Mapping.js", "importStyle": null, "description": "Extensions to use for {@link node-opcua~VariantArrayType}s.", "lineNumber": 57, "type": { "nullable": null, "types": [ "Map" ], "spread": false, "description": null }, "ignore": true }, { "__docId__": 618, "kind": "class", "name": "MappingTransformer", "memberof": "src/transform/Mapping.js", "static": true, "longname": "src/transform/Mapping.js~MappingTransformer", "access": "public", "export": true, "importPath": "atscm/src/transform/Mapping.js", "importStyle": "MappingTransformer", "description": "A Transformer that maps {@link ReadStream.ReadResult}s to {@link AtviseFile}s.", "lineNumber": 65, "interface": false, "extends": [ "src/lib/transform/Transformer.js~Transformer" ] }, { "__docId__": 619, "kind": "constructor", "name": "constructor", "memberof": "src/transform/Mapping.js~MappingTransformer", "generator": false, "async": false, "static": false, "longname": "src/transform/Mapping.js~MappingTransformer#constructor", "access": "public", "description": "Creates a new mapping transformer.", "lineNumber": 70, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "options", "description": "The arguments passed to the {@link Transformer} constructor." } ] }, { "__docId__": 620, "kind": "member", "name": "_readReferenceFiles", "memberof": "src/transform/Mapping.js~MappingTransformer", "static": false, "longname": "src/transform/Mapping.js~MappingTransformer#_readReferenceFiles", "access": "private", "description": "Contents of the reference files read but not used yet.", "lineNumber": 77, "type": { "nullable": null, "types": [ "Object" ], "spread": false, "description": null } }, { "__docId__": 621, "kind": "method", "name": "transformFromDB", "memberof": "src/transform/Mapping.js~MappingTransformer", "generator": false, "async": false, "static": false, "longname": "src/transform/Mapping.js~MappingTransformer#transformFromDB", "access": "public", "description": "Writes an {@link AtviseFile} for each {@link ReadStream.ReadResult} read. If a read file has a\nnon-standard type (definition) an additional `rc` file is pushed holding this type.", "lineNumber": 88, "params": [ { "nullable": null, "types": [ "Node" ], "spread": false, "optional": false, "name": "node", "description": "The read result to create the file for." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "encoding", "description": "The encoding used." }, { "nullable": null, "types": [ "function(err: ?Error, data: ?AtviseFile)" ], "spread": false, "optional": false, "name": "callback", "description": "Called with the error that occurred\nwhile transforming the read result or the resulting file." } ], "return": null }, { "__docId__": 622, "kind": "method", "name": "transformFromFilesystem", "memberof": "src/transform/Mapping.js~MappingTransformer", "generator": false, "async": false, "static": false, "longname": "src/transform/Mapping.js~MappingTransformer#transformFromFilesystem", "access": "public", "description": "Writes an {@link AtviseFile} for each {@link Node} read.", "lineNumber": 165, "params": [ { "nullable": null, "types": [ "Node" ], "spread": false, "optional": false, "name": "node", "description": "The raw file." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "encoding", "description": "The encoding used." }, { "nullable": null, "types": [ "function(err: ?Error, data: ?AtviseFile)" ], "spread": false, "optional": false, "name": "callback", "description": "Called with the error that occurred\nwhile transforming the read result or the resulting file." } ], "return": { "types": [ "*" ] } }, { "__docId__": 623, "kind": "get", "name": "transformsReferenceConfigFiles", "memberof": "src/transform/Mapping.js~MappingTransformer", "generator": false, "async": false, "static": false, "longname": "src/transform/Mapping.js~MappingTransformer#transformsReferenceConfigFiles", "access": "public", "description": "`true` as the mapping transformer should infer references from config files.", "lineNumber": 208, "type": { "types": [ "boolean" ] } }, { "__docId__": 624, "kind": "file", "name": "src/transform/Newlines.js", "content": "import { EOL } from 'os';\nimport { DataType } from 'node-opcua/lib/datamodel/variant';\nimport PartialTransformer from '../lib/transform/PartialTransformer';\n\n/**\n * A regular expression matching trailing newlines.\n */\nconst trailingNewlineRegExp = /\\r?\\n$/;\n\n/**\n * A transformer that handles newline characters in files. During a pull, all breaks are converted\n * the OS-native EOL character and (optionally) a trailing newline is added (for better git diffs).\n * On push, CRLF characters are used and those trailing newlines are removed again.\n */\nexport default class NewlinesTransformer extends PartialTransformer {\n /**\n * Creates a new newline transformer.\n * @param {Object} [options={}] The options to use.\n * @param {boolean} [options.trailingNewlines] If trailing newlines should be added. Pass *true*\n * for better git diffs.\n */\n constructor(options = {}) {\n super(options);\n\n /**\n * If newlines should be added to pulled files.\n * @type {boolean}\n */\n this._addTrailingNewlines = options.trailingNewlines || false;\n }\n\n /**\n * Returns `true` for all files except binary ones.\n * @param {AtviseFile} file The file being transformed.\n * @return {boolean} Always `true`.\n */\n shouldBeTransformed(file) {\n return file.stem[0] === '.' || file.dataType !== DataType.ByteString;\n }\n\n /**\n * Adds converts line breaks to the current OS's native EOL characters and adds trailing newlines.\n * @param {AtviseFile} file The file being transformed.\n * @param {string} enc The encoding used.\n * @param {function(err: ?Error, data: ?AtviseFile)} callback Called with the corrected file.\n */\n transformFromDB(file, enc, callback) {\n let str = file.contents.toString().replace(/\\r?\\n/g, EOL);\n\n if (this._addTrailingNewlines && !str.match(trailingNewlineRegExp)) {\n str += EOL;\n }\n\n file.contents = Buffer.from(str); // eslint-disable-line no-param-reassign\n\n callback(null, file);\n }\n\n /**\n * Removes trailing newlines and converts all breaks to CRLF.\n * @param {AtviseFile} file The file being transformed.\n * @param {string} enc The encoding used.\n * @param {function(err: ?Error, data: ?AtviseFile)} callback Called with resulting file.\n */\n transformFromFilesystem(file, enc, callback) {\n let str = file.contents.toString().replace(/\\r?\\n/g, '\\r\\n');\n\n if (this._addTrailingNewlines) {\n str = str.replace(trailingNewlineRegExp, '');\n }\n\n file.contents = Buffer.from(str); // eslint-disable-line no-param-reassign\n\n callback(null, file);\n }\n\n /**\n * `true` because we want to transform all files.\n * @type {boolean}\n */\n get transformsReferenceConfigFiles() {\n return true;\n }\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/transform/Newlines.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 625, "kind": "variable", "name": "trailingNewlineRegExp", "memberof": "src/transform/Newlines.js", "static": true, "longname": "src/transform/Newlines.js~trailingNewlineRegExp", "access": "public", "export": false, "importPath": "atscm/src/transform/Newlines.js", "importStyle": null, "description": "A regular expression matching trailing newlines.", "lineNumber": 8, "type": { "types": [ "undefined" ] }, "ignore": true }, { "__docId__": 626, "kind": "class", "name": "NewlinesTransformer", "memberof": "src/transform/Newlines.js", "static": true, "longname": "src/transform/Newlines.js~NewlinesTransformer", "access": "public", "export": true, "importPath": "atscm/src/transform/Newlines.js", "importStyle": "NewlinesTransformer", "description": "A transformer that handles newline characters in files. During a pull, all breaks are converted\nthe OS-native EOL character and (optionally) a trailing newline is added (for better git diffs).\nOn push, CRLF characters are used and those trailing newlines are removed again.", "lineNumber": 15, "interface": false, "extends": [ "src/lib/transform/PartialTransformer.js~PartialTransformer" ] }, { "__docId__": 627, "kind": "constructor", "name": "constructor", "memberof": "src/transform/Newlines.js~NewlinesTransformer", "generator": false, "async": false, "static": false, "longname": "src/transform/Newlines.js~NewlinesTransformer#constructor", "access": "public", "description": "Creates a new newline transformer.", "lineNumber": 22, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "defaultValue": "{}", "defaultRaw": {}, "name": "options", "description": "The options to use." }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": true, "name": "options.trailingNewlines", "description": "If trailing newlines should be added. Pass *true*\nfor better git diffs." } ] }, { "__docId__": 628, "kind": "member", "name": "_addTrailingNewlines", "memberof": "src/transform/Newlines.js~NewlinesTransformer", "static": false, "longname": "src/transform/Newlines.js~NewlinesTransformer#_addTrailingNewlines", "access": "private", "description": "If newlines should be added to pulled files.", "lineNumber": 29, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 629, "kind": "method", "name": "shouldBeTransformed", "memberof": "src/transform/Newlines.js~NewlinesTransformer", "generator": false, "async": false, "static": false, "longname": "src/transform/Newlines.js~NewlinesTransformer#shouldBeTransformed", "access": "public", "description": "Returns `true` for all files except binary ones.", "lineNumber": 37, "params": [ { "nullable": null, "types": [ "AtviseFile" ], "spread": false, "optional": false, "name": "file", "description": "The file being transformed." } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "Always `true`." } }, { "__docId__": 630, "kind": "method", "name": "transformFromDB", "memberof": "src/transform/Newlines.js~NewlinesTransformer", "generator": false, "async": false, "static": false, "longname": "src/transform/Newlines.js~NewlinesTransformer#transformFromDB", "access": "public", "description": "Adds converts line breaks to the current OS's native EOL characters and adds trailing newlines.", "lineNumber": 47, "params": [ { "nullable": null, "types": [ "AtviseFile" ], "spread": false, "optional": false, "name": "file", "description": "The file being transformed." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "enc", "description": "The encoding used." }, { "nullable": null, "types": [ "function(err: ?Error, data: ?AtviseFile)" ], "spread": false, "optional": false, "name": "callback", "description": "Called with the corrected file." } ], "return": null }, { "__docId__": 631, "kind": "method", "name": "transformFromFilesystem", "memberof": "src/transform/Newlines.js~NewlinesTransformer", "generator": false, "async": false, "static": false, "longname": "src/transform/Newlines.js~NewlinesTransformer#transformFromFilesystem", "access": "public", "description": "Removes trailing newlines and converts all breaks to CRLF.", "lineNumber": 65, "params": [ { "nullable": null, "types": [ "AtviseFile" ], "spread": false, "optional": false, "name": "file", "description": "The file being transformed." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "enc", "description": "The encoding used." }, { "nullable": null, "types": [ "function(err: ?Error, data: ?AtviseFile)" ], "spread": false, "optional": false, "name": "callback", "description": "Called with resulting file." } ], "return": null }, { "__docId__": 632, "kind": "get", "name": "transformsReferenceConfigFiles", "memberof": "src/transform/Newlines.js~NewlinesTransformer", "generator": false, "async": false, "static": false, "longname": "src/transform/Newlines.js~NewlinesTransformer#transformsReferenceConfigFiles", "access": "public", "description": "`true` because we want to transform all files.", "lineNumber": 81, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 633, "kind": "file", "name": "src/typedef/atscm.js", "content": "/**\n * @typedef {Object} NodeStream.BrowseResult\n * @property {NodeId} nodeId The discovered node's id.\n * @property {node-opcua~NodeClass} nodeClass The discovered node's class.\n * @property {Map} references An object holding arrays of references from the\n * discovered node to others, mapped by {@link node-opcua~ReferenceTypeId} keys.\n */\n\n/**\n * @typedef {NodeStream.BrowseResult} ReadStream.ReadResult\n * @property {?node-opcua~DataValue} value For *Variable* nodes this property holds the read data\n * value.\n * @property {?Date} mtime For *Variable* nodes this property holds the timestamp the node's value\n * last changed.\n */\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/typedef/atscm.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 634, "kind": "typedef", "name": "NodeStream.BrowseResult", "memberof": "src/typedef/atscm.js", "static": true, "longname": "src/typedef/atscm.js~NodeStream.BrowseResult", "access": "public", "description": "", "properties": [ { "nullable": null, "types": [ "NodeId" ], "spread": false, "optional": false, "name": "nodeId", "description": "The discovered node's id." }, { "nullable": null, "types": [ "node-opcua~NodeClass" ], "spread": false, "optional": false, "name": "nodeClass", "description": "The discovered node's class." }, { "nullable": null, "types": [ "Map" ], "spread": false, "optional": false, "name": "references", "description": "An object holding arrays of references from the\ndiscovered node to others, mapped by {@link node-opcua~ReferenceTypeId} keys." } ], "type": { "types": [ "Object" ], "optional": false, "name": "NodeStream.BrowseResult" } }, { "__docId__": 635, "kind": "typedef", "name": "ReadStream.ReadResult", "memberof": "src/typedef/atscm.js", "static": true, "longname": "src/typedef/atscm.js~ReadStream.ReadResult", "access": "public", "description": "", "properties": [ { "nullable": true, "types": [ "node-opcua~DataValue" ], "spread": false, "optional": false, "name": "value", "description": "For *Variable* nodes this property holds the read data\nvalue." }, { "nullable": true, "types": [ "Date" ], "spread": false, "optional": false, "name": "mtime", "description": "For *Variable* nodes this property holds the timestamp the node's value\nlast changed." } ], "type": { "types": [ "NodeStream.BrowseResult" ], "optional": false, "name": "ReadStream.ReadResult" } }, { "__docId__": 636, "kind": "file", "name": "src/typedef/external/inquirer.js", "content": "/**\n * @external {Inquirer} https://github.com/sboudrias/Inquirer.js\n */\n\n/**\n * Must be one of: 'list', 'rawlist', 'expand', 'checkbox', 'confirm', 'input', 'password',\n * 'editor'.\n * @typedef {String} inquirer~PromptType\n * @see https://github.com/sboudrias/Inquirer.js#prompt-types\n */\n\n/**\n * A function that, when called with a value, validates this value and either retunrs `true` if\n * validation succeeded or an error message.\n * @typedef {function(value: String): Boolean|String} inquirer~Validator\n */\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/typedef/external/inquirer.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 637, "kind": "external", "name": "Inquirer", "externalLink": "https://github.com/sboudrias/Inquirer.js", "memberof": "src/typedef/external/inquirer.js", "static": true, "longname": "src/typedef/external/inquirer.js~Inquirer", "access": "public", "description": "" }, { "__docId__": 638, "kind": "typedef", "name": "inquirer~PromptType", "memberof": "src/typedef/external/inquirer.js", "static": true, "longname": "src/typedef/external/inquirer.js~inquirer~PromptType", "access": "public", "description": "Must be one of: 'list', 'rawlist', 'expand', 'checkbox', 'confirm', 'input', 'password',\n'editor'.", "see": [ "https://github.com/sboudrias/Inquirer.js#prompt-types" ], "type": { "types": [ "String" ], "optional": false, "name": "inquirer~PromptType" } }, { "__docId__": 639, "kind": "typedef", "name": "inquirer~Validator", "memberof": "src/typedef/external/inquirer.js", "static": true, "longname": "src/typedef/external/inquirer.js~inquirer~Validator", "access": "public", "description": "A function that, when called with a value, validates this value and either retunrs `true` if\nvalidation succeeded or an error message.", "type": { "types": [ "function(value: String): Boolean", "String" ], "optional": false, "name": "inquirer~Validator" } }, { "__docId__": 640, "kind": "file", "name": "src/typedef/external/node-opcua.js", "content": "/**\n * @external {node-opcua} http://node-opcua.github.io/api_doc/0.1.0/\n */\n\n/**\n * @external {node-opcua~NodeId} http://node-opcua.github.io/api_doc/0.1.0/classes/NodeId.html\n */\n\n/**\n * @external {node-opcua~NodeIdType} http://node-opcua.github.io/api_doc/0.1.0/classes/NodeIdType.html\n */\n\n/**\n * @external {node-opcua~OPCUAClient} http://node-opcua.github.io/api_doc/0.1.0/classes/OPCUAClient.html\n */\n\n/**\n * @external {node-opcua~ClientSession} http://node-opcua.github.io/api_doc/0.1.0/classes/ClientSession.html\n */\n\n/**\n * @external {node-opcua~ClientSubscription} http://node-opcua.github.io/api_doc/0.1.0/classes/ClientSubscription.html\n */\n\n/**\n * @external {node-opcua~DataValue} http://node-opcua.github.io/api_doc/0.1.0/classes/DataValue.html\n */\n\n/**\n * @external {node-opcua~ReferenceDescription} http://node-opcua.github.io/api_doc/0.1.0/classes/ReferenceDescription.html\n */\n\n/**\n * @external {node-opcua~Variant} http://node-opcua.github.io/api_doc/0.1.0/classes/Variant.html\n */\n\n/**\n * @external {node-opcua~DataType} https://github.com/node-opcua/node-opcua/blob/master/packages/node-opcua-variant/source/DataType_enum.ts\n */\n\n/**\n * @external {node-opcua~VariantArrayType} https://github.com/node-opcua/node-opcua/blob/master/packages/node-opcua-variant/source/VariantArrayType_enum.ts\n */\n\n/**\n * @external {node-opcua~StatusCodes} https://github.com/node-opcua/node-opcua/blob/v0.0.60/lib/raw_status_codes.js\n */\n\n/**\n * @external {node-opcua~CallMethodRequest} http://node-opcua.github.io/api_doc/0.1.0/classes/CallMethodRequest.html\n */\n\n/**\n * @external {node-opcua~ReferenceTypeId} https://github.com/node-opcua/node-opcua/blob/608771099fbfaa42195e150bdf36956affbb53e9/packages/node-opcua-constants/src/opcua_node_ids.js\n */\n\n/**\n * @external {node-opcua~NodeClass} https://github.com/node-opcua/node-opcua/blob/608771099fbfaa42195e150bdf36956affbb53e9/packages/node-opcua-data-model/schemas/NodeClass_enum.js\n */\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/typedef/external/node-opcua.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 641, "kind": "external", "name": "node-opcua", "externalLink": "http://node-opcua.github.io/api_doc/0.1.0/", "memberof": "src/typedef/external/node-opcua.js", "static": true, "longname": "src/typedef/external/node-opcua.js~node-opcua", "access": "public", "description": "" }, { "__docId__": 642, "kind": "external", "name": "node-opcua~NodeId", "externalLink": "http://node-opcua.github.io/api_doc/0.1.0/classes/NodeId.html", "memberof": "src/typedef/external/node-opcua.js", "static": true, "longname": "src/typedef/external/node-opcua.js~node-opcua~NodeId", "access": "public", "description": "" }, { "__docId__": 643, "kind": "external", "name": "node-opcua~NodeIdType", "externalLink": "http://node-opcua.github.io/api_doc/0.1.0/classes/NodeIdType.html", "memberof": "src/typedef/external/node-opcua.js", "static": true, "longname": "src/typedef/external/node-opcua.js~node-opcua~NodeIdType", "access": "public", "description": "" }, { "__docId__": 644, "kind": "external", "name": "node-opcua~OPCUAClient", "externalLink": "http://node-opcua.github.io/api_doc/0.1.0/classes/OPCUAClient.html", "memberof": "src/typedef/external/node-opcua.js", "static": true, "longname": "src/typedef/external/node-opcua.js~node-opcua~OPCUAClient", "access": "public", "description": "" }, { "__docId__": 645, "kind": "external", "name": "node-opcua~ClientSession", "externalLink": "http://node-opcua.github.io/api_doc/0.1.0/classes/ClientSession.html", "memberof": "src/typedef/external/node-opcua.js", "static": true, "longname": "src/typedef/external/node-opcua.js~node-opcua~ClientSession", "access": "public", "description": "" }, { "__docId__": 646, "kind": "external", "name": "node-opcua~ClientSubscription", "externalLink": "http://node-opcua.github.io/api_doc/0.1.0/classes/ClientSubscription.html", "memberof": "src/typedef/external/node-opcua.js", "static": true, "longname": "src/typedef/external/node-opcua.js~node-opcua~ClientSubscription", "access": "public", "description": "" }, { "__docId__": 647, "kind": "external", "name": "node-opcua~DataValue", "externalLink": "http://node-opcua.github.io/api_doc/0.1.0/classes/DataValue.html", "memberof": "src/typedef/external/node-opcua.js", "static": true, "longname": "src/typedef/external/node-opcua.js~node-opcua~DataValue", "access": "public", "description": "" }, { "__docId__": 648, "kind": "external", "name": "node-opcua~ReferenceDescription", "externalLink": "http://node-opcua.github.io/api_doc/0.1.0/classes/ReferenceDescription.html", "memberof": "src/typedef/external/node-opcua.js", "static": true, "longname": "src/typedef/external/node-opcua.js~node-opcua~ReferenceDescription", "access": "public", "description": "" }, { "__docId__": 649, "kind": "external", "name": "node-opcua~Variant", "externalLink": "http://node-opcua.github.io/api_doc/0.1.0/classes/Variant.html", "memberof": "src/typedef/external/node-opcua.js", "static": true, "longname": "src/typedef/external/node-opcua.js~node-opcua~Variant", "access": "public", "description": "" }, { "__docId__": 650, "kind": "external", "name": "node-opcua~DataType", "externalLink": "https://github.com/node-opcua/node-opcua/blob/master/packages/node-opcua-variant/source/DataType_enum.ts", "memberof": "src/typedef/external/node-opcua.js", "static": true, "longname": "src/typedef/external/node-opcua.js~node-opcua~DataType", "access": "public", "description": "" }, { "__docId__": 651, "kind": "external", "name": "node-opcua~VariantArrayType", "externalLink": "https://github.com/node-opcua/node-opcua/blob/master/packages/node-opcua-variant/source/VariantArrayType_enum.ts", "memberof": "src/typedef/external/node-opcua.js", "static": true, "longname": "src/typedef/external/node-opcua.js~node-opcua~VariantArrayType", "access": "public", "description": "" }, { "__docId__": 652, "kind": "external", "name": "node-opcua~StatusCodes", "externalLink": "https://github.com/node-opcua/node-opcua/blob/v0.0.60/lib/raw_status_codes.js", "memberof": "src/typedef/external/node-opcua.js", "static": true, "longname": "src/typedef/external/node-opcua.js~node-opcua~StatusCodes", "access": "public", "description": "" }, { "__docId__": 653, "kind": "external", "name": "node-opcua~CallMethodRequest", "externalLink": "http://node-opcua.github.io/api_doc/0.1.0/classes/CallMethodRequest.html", "memberof": "src/typedef/external/node-opcua.js", "static": true, "longname": "src/typedef/external/node-opcua.js~node-opcua~CallMethodRequest", "access": "public", "description": "" }, { "__docId__": 654, "kind": "external", "name": "node-opcua~ReferenceTypeId", "externalLink": "https://github.com/node-opcua/node-opcua/blob/608771099fbfaa42195e150bdf36956affbb53e9/packages/node-opcua-constants/src/opcua_node_ids.js", "memberof": "src/typedef/external/node-opcua.js", "static": true, "longname": "src/typedef/external/node-opcua.js~node-opcua~ReferenceTypeId", "access": "public", "description": "" }, { "__docId__": 655, "kind": "external", "name": "node-opcua~NodeClass", "externalLink": "https://github.com/node-opcua/node-opcua/blob/608771099fbfaa42195e150bdf36956affbb53e9/packages/node-opcua-data-model/schemas/NodeClass_enum.js", "memberof": "src/typedef/external/node-opcua.js", "static": true, "longname": "src/typedef/external/node-opcua.js~node-opcua~NodeClass", "access": "public", "description": "" }, { "__docId__": 656, "kind": "file", "name": "src/typedef/external/node.js", "content": "/**\n * @external {events~Emitter} https://nodejs.org/api/events.html#events_class_eventemitter\n */\n\n/**\n * @external {fs~Stats} https://nodejs.org/api/fs.html#fs_class_fs_stats\n */\n\n/**\n * @external {util~inspect} https://nodejs.org/api/util.html#util_util_inspect_object_options\n */\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/typedef/external/node.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 657, "kind": "external", "name": "events~Emitter", "externalLink": "https://nodejs.org/api/events.html#events_class_eventemitter", "memberof": "src/typedef/external/node.js", "static": true, "longname": "src/typedef/external/node.js~events~Emitter", "access": "public", "description": "" }, { "__docId__": 658, "kind": "external", "name": "fs~Stats", "externalLink": "https://nodejs.org/api/fs.html#fs_class_fs_stats", "memberof": "src/typedef/external/node.js", "static": true, "longname": "src/typedef/external/node.js~fs~Stats", "access": "public", "description": "" }, { "__docId__": 659, "kind": "external", "name": "util~inspect", "externalLink": "https://nodejs.org/api/util.html#util_util_inspect_object_options", "memberof": "src/typedef/external/node.js", "static": true, "longname": "src/typedef/external/node.js~util~inspect", "access": "public", "description": "" }, { "__docId__": 660, "kind": "file", "name": "src/typedef/external/p-queue.js", "content": "/**\n * @external {p-queue~PQueue} https://github.com/sindresorhus/p-queue#api\n */\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/typedef/external/p-queue.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 661, "kind": "external", "name": "p-queue~PQueue", "externalLink": "https://github.com/sindresorhus/p-queue#api", "memberof": "src/typedef/external/p-queue.js", "static": true, "longname": "src/typedef/external/p-queue.js~p-queue~PQueue", "access": "public", "description": "" }, { "__docId__": 662, "kind": "file", "name": "src/typedef/external/sane.js", "content": "/**\n * @external {sane~Watcher} https://github.com/amasad/sane\n */\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/typedef/external/sane.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 663, "kind": "external", "name": "sane~Watcher", "externalLink": "https://github.com/amasad/sane", "memberof": "src/typedef/external/sane.js", "static": true, "longname": "src/typedef/external/sane.js~sane~Watcher", "access": "public", "description": "" }, { "__docId__": 664, "kind": "file", "name": "src/typedef/external/vinyl.js", "content": "/**\n * @external {vinyl~File} https://github.com/gulpjs/vinyl#new-vinyloptions\n */\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/typedef/external/vinyl.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 665, "kind": "external", "name": "vinyl~File", "externalLink": "https://github.com/gulpjs/vinyl#new-vinyloptions", "memberof": "src/typedef/external/vinyl.js", "static": true, "longname": "src/typedef/external/vinyl.js~vinyl~File", "access": "public", "description": "" }, { "__docId__": 666, "kind": "file", "name": "src/typedef/external/xml2js.js", "content": "/**\n * @external {xml2js~Builder} https://github.com/Leonidas-from-XIV/node-xml2js#options-for-the-builder-class\n */\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/typedef/external/xml2js.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 667, "kind": "external", "name": "xml2js~Builder", "externalLink": "https://github.com/Leonidas-from-XIV/node-xml2js#options-for-the-builder-class", "memberof": "src/typedef/external/xml2js.js", "static": true, "longname": "src/typedef/external/xml2js.js~xml2js~Builder", "access": "public", "description": "" }, { "__docId__": 668, "kind": "file", "name": "src/util/cleanup.js", "content": "import readline from 'readline';\nimport Logger from 'gulplog';\nimport Session from '../lib/server/Session';\n\n/**\n * Cleans up after the app ended with the specified code or signal.\n * @param {?number} exitCode The exit code received.\n * @param {?string} signal The signal that triggered the exit.\n * @param {function()} uninstall The uninstall script to run.\n * @return {boolean} `true` if the process should continue exiting.\n */\nexport default function cleanup(exitCode, signal, uninstall) {\n uninstall();\n\n if (signal === 'SIGINT') {\n readline.clearLine(process.stdout);\n readline.cursorTo(process.stdout, 0);\n Logger.warn('Ctrl-C');\n }\n\n Logger.debug('Running cleanup...');\n\n if (Session.open.length > 0) {\n Logger.debug(' Closing', Session.open.length, 'open sessions...');\n\n // Ignore further gulp error messages\n Logger.removeAllListeners('error');\n Logger.on('error', () => {});\n\n Session.closeOpen()\n .then(() => process.kill(process.pid, signal))\n .catch((e) => {\n Logger.error('Error in cleanup', e.message);\n process.kill(process.pid, signal);\n });\n\n return false;\n }\n\n return true;\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/util/cleanup.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 669, "kind": "function", "name": "cleanup", "memberof": "src/util/cleanup.js", "generator": false, "async": false, "static": true, "longname": "src/util/cleanup.js~cleanup", "access": "public", "export": true, "importPath": "atscm/src/util/cleanup.js", "importStyle": "cleanup", "description": "Cleans up after the app ended with the specified code or signal.", "lineNumber": 12, "params": [ { "nullable": true, "types": [ "number" ], "spread": false, "optional": false, "name": "exitCode", "description": "The exit code received." }, { "nullable": true, "types": [ "string" ], "spread": false, "optional": false, "name": "signal", "description": "The signal that triggered the exit." }, { "nullable": null, "types": [ "function()" ], "spread": false, "optional": false, "name": "uninstall", "description": "The uninstall script to run." } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "`true` if the process should continue exiting." } }, { "__docId__": 670, "kind": "file", "name": "src/util/fs.js", "content": "import { resolve as resolvePath } from 'path';\nimport { stat } from 'fs';\n\n/**\n * Returns the {@link fs~Stats} for a path.\n * @param {string} path The path to look at.\n * @return {Promise} Fulfilled with the requested stats or rejected with the error\n * that occurred.\n */\nexport function getStat(path) {\n return new Promise((resolve, reject) => {\n stat(resolvePath(path), (err, stats) => {\n if (err) {\n reject(err);\n } else {\n resolve(stats);\n }\n });\n });\n}\n\n/**\n * Checks it a given path holds a directory and returns it's {@link fs~Stats} if found.\n * @param {string} directoryPath The path to look at.\n * @return {Promise} Fulfilled with the directory's stats or rejected with the\n * error that occurred.\n */\nexport function validateDirectoryExists(directoryPath) {\n return getStat(directoryPath).then((stats) => {\n if (!stats.isDirectory()) {\n throw new Error(`${resolvePath(directoryPath)} is not a directory`);\n }\n\n return stat;\n });\n}\n", "static": true, "longname": "/home/circleci/project/packages/atscm/src/util/fs.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 671, "kind": "function", "name": "getStat", "memberof": "src/util/fs.js", "generator": false, "async": false, "static": true, "longname": "src/util/fs.js~getStat", "access": "public", "export": true, "importPath": "atscm/src/util/fs.js", "importStyle": "{getStat}", "description": "Returns the {@link fs~Stats} for a path.", "lineNumber": 10, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "path", "description": "The path to look at." } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "Fulfilled with the requested stats or rejected with the error\nthat occurred." } }, { "__docId__": 672, "kind": "function", "name": "validateDirectoryExists", "memberof": "src/util/fs.js", "generator": false, "async": false, "static": true, "longname": "src/util/fs.js~validateDirectoryExists", "access": "public", "export": true, "importPath": "atscm/src/util/fs.js", "importStyle": "{validateDirectoryExists}", "description": "Checks it a given path holds a directory and returns it's {@link fs~Stats} if found.", "lineNumber": 28, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "directoryPath", "description": "The path to look at." } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "Fulfilled with the directory's stats or rejected with the\nerror that occurred." } }, { "kind": "index", "content": "# atscm\n\n> Source code management utilities for atvise\n\n[![CircleCI](https://circleci.com/gh/atSCM/atscm.svg?style=shield)](https://circleci.com/gh/atSCM/workflows/atscm)\n[![codecov](https://codecov.io/gh/atSCM/atscm/branch/master/graph/badge.svg)](https://codecov.io/gh/atSCM/atscm)\n[![ESDoc](https://atscm.github.io/atscm/badge.svg)](https://atscm.github.io/atscm)\n\n_atscm_ is a [node.js](https://nodejs.org) based utility that stores the contents of atvise projects on the file system. This has several benefits to advanced atvise developers:\n\n- atvise project can be put under source control (e.g. using _git_)\n- source code can be edited in external editors\n- easier unit testing\n- easier source code linting / static analysis\n- source files can be preprocessed by using custom transformers: \n - using alternate programming languages such as [ES2015 JavaScript](http://babeljs.io/learn-es2015/) or [TypeScript](https://www.typescriptlang.org)\n - using alternate markup languages such as [pug](https://pugjs.org)\n - using templating engines such as [handlebars](http://handlebarsjs.com)\n\n\n\n## Installation\n\nPrerequisite: Install node.js (version 10 or later)\n\n
How to check which version is installed\n\n- Make sure [node.js](https://nodejs.org) (version 10 or later) is installed by running `node --version`.\n- Make sure [npm](https://www.npmjs.com) is installed by running `npm --version`.\n\n
\n\n### With atscm-cli\n\n_atscm_ can be installed via [atscm-cli](https://github.com/atSCM/atscm-cli).\n\n> Run `npm install --global atscm-cli` to install _atscm-cli_ globally. _You may have to run this command as an administrator._\n\nWith [atscm-cli](https://github.com/atSCM/atscm-cli) installed run `atscm init` to create a new _atscm_ project.\n\n### With `npm init`\n\nSimply run `npm init atscm` to create a new atscm project.\n\n## Basic usage\n\n**Pulling nodes from atvise server**\n\nRunning `atscm pull` will download all nodes from atvise server into the `./src` folder inside your project.\n\nBy default only displays, serverside scripts and quickdynamics will be split into their JavaScript and SVG sources. You can specify additional transformers to use in your [Project configuration](#project-configuration) file.\n\n**Pushing source files to atvise server**\n\nRunning `atscm push` will update all nodes from the contents of your `./src` folder.\n\n**Automatically watching for changes**\n\nAfter running `atscm watch` files and atvise server nodes are watched for changes. If a file changes, the file is pushed, if a node changes this node is pulled.\n\n`atscm watch` is very useful if you want edit source files in an external editor but still have the ability to use _atvise builder_'s drag and drop functionality.\n\n\n\n## Project configuration\n\nAn atscm project's configuration is stored inside the _Atviseproject_ file inside your project root. See the [Atviseproject class reference](https://atscm.github.io/atscm/class/src/lib/config/Atviseproject.js~Atviseproject.html) for available options.\n", "longname": "/home/circleci/project/packages/atscm/README.md", "name": "./README.md", "static": true, "access": "public" }, { "kind": "packageJSON", "content": "{\n \"name\": \"atscm\",\n \"version\": \"1.5.2\",\n \"description\": \"Source code management utilities for atvise\",\n \"license\": \"MIT\",\n \"repository\": {\n \"type\": \"git\",\n \"url\": \"git+https://github.com/atSCM/atscm.git\",\n \"directory\": \"packages/atscm\"\n },\n \"author\": \"Lukas Hechenberger \",\n \"homepage\": \"https://github.com/atSCM/atscm/tree/master/packages/atscm#readme\",\n \"bugs\": {\n \"url\": \"https://github.com/atSCM/atscm/issues\"\n },\n \"main\": \"out/index.js\",\n \"engines\": {\n \"atscm-cli\": \">=0.7.0\",\n \"atserver\": \">=3.2.0 <=3.5.2\",\n \"node\": \">=10.0\"\n },\n \"scripts\": {\n \"build\": \"run-s compile types\",\n \"compile\": \"babel src --out-dir out --source-maps --extensions .js,.ts\",\n \"compile:watch\": \"npm run compile -- --watch --verbose\",\n \"dev\": \"npm run -s compile -- --watch\",\n \"docs\": \"esdoc -c esdoc.json\",\n \"docs:coverage\": \"esdoc-coverage -c esdoc.json -t 80\",\n \"prepublishOnly\": \"npm run compile && npm run docs\",\n \"schemas\": \"run-s schemas:build schemas:format\",\n \"schemas:build\": \"node ./scripts/build-schemas.js\",\n \"schemas:format\": \"prettier schemas types/schemas --write\",\n \"test\": \"npm run -s test:base -- \\\"test/**/*.spec.js\\\"\",\n \"test:base\": \"cross-env NODE_ENV=test mocha --recursive --require ./test/prepare --timeout 20000 --exit test/src/maintenance.spec.js\",\n \"test:coverage\": \"nyc --reporter=html npm run test:unit\",\n \"test:docs\": \"blcl docs/api --exclude https://circleci.com/gh/atSCM/workflows/atscm\",\n \"test:integration\": \"npm run -s test:base -- \\\"test/integration/**/*.spec.js\\\"\",\n \"test:unit\": \"npm run -s test:base -- \\\"test/src/**/*.spec.js\\\"\",\n \"test:watch\": \"npm test -- --watch --reporter min\",\n \"types\": \"tsc\"\n },\n \"dependencies\": {\n \"@atscm/server-scripts\": \"0.3.1\",\n \"@babel/code-frame\": \"^7.5.5\",\n \"browser-sync\": \"^2.26.7\",\n \"chalk\": \"^4.0.0\",\n \"detect-indent\": \"^6.0.0\",\n \"fs-extra\": \"^6.0.1\",\n \"gulp\": \"^4.0.2\",\n \"gulp-compile-handlebars\": \"^0.6.1\",\n \"gulp-replace\": \"1.0.0\",\n \"gulplog\": \"^1.0.0\",\n \"handlebars-helpers\": \"^0.10.0\",\n \"hasha\": \"^3.0.0\",\n \"modify-xml\": \"^1.0.0-beta.0\",\n \"mri\": \"^1.1.4\",\n \"node-cleanup\": \"^2.1.2\",\n \"node-opcua\": \"0.0.60\",\n \"p-queue\": \"^6.2.1\",\n \"prompts\": \"^2.3.2\",\n \"sane\": \"^2.5.2\",\n \"semver\": \"^5.7.1\",\n \"stream-to-promise\": \"^2.2.0\",\n \"through2\": \"^2.0.5\",\n \"validate-npm-package-name\": \"^3.0.0\",\n \"vinyl\": \"^2.2.0\"\n },\n \"devDependencies\": {\n \"@atscm/esdoc-typescript-plugin\": \"0.1.0\",\n \"@babel/cli\": \"7.10.5\",\n \"@babel/core\": \"7.11.4\",\n \"@babel/plugin-proposal-class-properties\": \"7.10.4\",\n \"@babel/plugin-proposal-object-rest-spread\": \"7.11.0\",\n \"@babel/preset-env\": \"7.11.0\",\n \"@babel/preset-typescript\": \"7.10.4\",\n \"@babel/register\": \"7.10.5\",\n \"@ls-age/esdoc-coverage\": \"0.1.6\",\n \"@types/fs-extra\": \"8.1.0\",\n \"@types/mri\": \"1.1.0\",\n \"@types/semver\": \"7.1.0\",\n \"babel-plugin-istanbul\": \"6.0.0\",\n \"broken-link-checker-local\": \"0.2.1\",\n \"buffer-replace\": \"1.0.0\",\n \"camelcase\": \"6.2.0\",\n \"codecov\": \"3.7.2\",\n \"cross-env\": \"7.0.2\",\n \"esdoc\": \"1.1.0\",\n \"esdoc-ecmascript-proposal-plugin\": \"1.0.0\",\n \"esdoc-standard-plugin\": \"1.0.0\",\n \"eval\": \"0.1.4\",\n \"istanbul-combine\": \"0.3.0\",\n \"json-schema-to-typescript\": \"10.1.3\",\n \"mocha\": \"8.1.2\",\n \"mocha-circleci-reporter\": \"0.0.3\",\n \"npm-run-all\": \"4.1.5\",\n \"nyc\": \"15.1.0\",\n \"proxyquire\": \"2.1.3\",\n \"sinon\": \"9.0.3\",\n \"typescript\": \"3.9.7\",\n \"unexpected\": \"11.14.0\",\n \"unexpected-sinon\": \"10.11.2\",\n \"unexpected-stream\": \"4.0.0\",\n \"yargs\": \"15.4.1\"\n },\n \"types\": \"out/types/src/index.d.ts\",\n \"nyc\": {\n \"all\": true,\n \"include\": [\n \"src/**/*.js\",\n \"src/**/*.ts\"\n ],\n \"exclude\": [\n \"res/**/*.*\"\n ],\n \"require\": [\n \"@babel/register\"\n ],\n \"sourceMap\": false,\n \"instrument\": false,\n \"check-coverage\": true\n }\n}\n", "longname": "/home/circleci/project/packages/atscm/package.json", "name": "package.json", "static": true, "access": "public" }, { "kind": "manualIndex", "globalIndex": false, "content": null, "longname": "", "static": true, "access": "public" }, { "kind": "manual", "longname": "/home/circleci/project/packages/atscm/docs/manual/get-started/updating.md", "name": "./docs/manual/get-started/updating.md", "content": "# Updating atscm\n\n> You can use atscm to update atscm 😀\n\n## Installing new versions\n\nSimply run `atscm update` to install the latest version available. Add the `--beta` flag to install prerelease versions. Ensure to **backup your project** before doing so.\n\n> Internally, we use [npm](https://www.npmjs.com) to install updates, which means that you can also run `npm install --save-dev atscm` instead.\n\n## Updating your atscm project\n\nWe'll do our best to follow [semantic versioning](https://semver.org), which means you shouldn't need to update your project sources between non-major releases, e.g. when updating from _1.0.0_ to _1.0.1_ or _1.1.0_.\n\nBetween major releases (e.g. from 0.7.0 to 1.0.0) we introduce changes that may break your existing project. **Follow these steps to migrate your project to a new major version of atscm:**\n\n- Backup your project _before_, e.g. with git: `git add . && git commit -m \"chore: Backup before atscm update\"`\n- Start a fresh atvise server instance and push your current project: `atscm push`\n- Update atscm: `atscm update`\n- Pull your project sources from atvise server: `atscm pull --clean`\n- Afterwards, you can commit commit the changes: `git add . && git commit -m \"chore: Update atscm\"`\n", "static": true, "access": "public" }, { "kind": "manual", "longname": "/home/circleci/project/packages/atscm/docs/manual/tutorial/custom-transformer.md", "name": "./docs/manual/tutorial/custom-transformer.md", "content": "# Tutorial: Custom Transformer\n\n> tl;dr: Jump to the [tutorial-custom-transformer repository](https://github.com/atSCM/tutorial-custom-transformer) to see the results.\n\nIn this document we'll guide you through the steps necessary to implement a custom Transformer.\nOur transformer will use [Babel](http://babeljs.io) to transpile ES2015/ES6 JavaScript to plain ES5 JavaScript that works in all Browsers.\n\n## Overview\n\nCustom transformers provide an easy way to extend the build functionality of _atscm_. Basically, a transformer implements two behaviours: How atvise server nodes are mapped to files (when running `atscm pull`) and vice versa (when running `atscm push`).\n\n**Where to store transformers**\n\nBasically, transformers can be stored anywhere inside your _atscm_ project. When using a non-ES5 configuration language (such as ES2015 or TypeScript, chosen when running `atscm init`) transformers should also be written in this language. _atscm_ will handle the transpilation of your transformer code automatically. If you plan to write multiple custom transformers for your project, it is recommended to create your transformers in an own directory, e.g `./atscm`.\n\n## Step 0: Project setup\n\nIn order to have the same starting point, create a new _atscm_ project to follow this tutorial. Run `atscm init` and **pick ES2015 as configuration language**.\n\nAs for now the atvise library is written in old ES5 JavaScript, we'll ignore it in our project. Adjust your project configuration accordingly:\n\n```javascript\n// Atviseproject.babel.js\n\n...\n\nexport default class MyProject extends Atviseproject {\n ...\n\n static get ignoreNodes() {\n return super.ignoreNodes\n .concat(['ns=1;s=SYSTEM.LIBRARY.ATVISE']);\n }\n\n}\n```\n\nNow we're ready to pull the project by running:\n\n```\natscm pull\n```\n\nWe'll use the default project files for testing later.\n\nAs suggested above, we'll store our custom transformer inside a new directory, `./atscm`. Create the directory and an empty file called _BabelTransformer.js_:\n\n```bash\nmkdir atscm\ntouch atscm/BabelTransformer.js\n```\n\nBy now you should have a project containing an `./Atviseproject.babel.js` and an empty `./atscm/BabelTransformer.js` file.\nMake sure the `./src` directory contains at least the _default Main display_ which should exist inside `./src/AGENT/DISPLAYS/Main.display`.\n\n## Step 1: Import _PartialTransformer_ class\n\nAs we don't want to implement things twice we'll subclass _atscm_'s [Transformer class](https://atscm.github.io/atscm/class/src/lib/transform/Transformer.js~Transformer.html). As our transformer shall only be used for JavaScript source files we can even use the [PartialTransformer class](https://atscm.github.io/atscm/class/src/lib/transform/PartialTransformer.js~PartialTransformer.html) which supports filtering source files out of the box. As both of these classes are exported from _atscm_'s main file, importing them is pretty straightforward. Inside the _BabelTransformer.js_ file add:\n\n```javascript\n// atscm/BabelTransformer.js\n\nimport { PartialTransformer } from 'atscm';\n```\n\n## Step 2: Create the _BabelTransformer_ class\n\nThe next step is to create and export our Transformer class:\n\n```javascript\n// atscm/BabelTransformer.js\n\nimport { PartialTransformer } from 'atscm';\n\nexport default class BabelTransformer extends PartialTransformer {}\n```\n\nWe just created a _PartialTransformer_ subclass that is exported as the file's default export. For more detailed information on ES2015's module system [take a look at the docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/export).\n\n## Step 3: Use _BabelTransformer_\n\nBy default, _atscm_ uses just some standard transformers. Any additional transformers must be configured to use inside the project's _Atviseproject_ file.\n\nFirst of all, we have to import our newly created _BabelTransformer_ class:\n\n```javascript\n// Atviseproject.babel.js\n\nimport { Atviseproject } from 'atscm'\nimport BabelTransformer from './atscm/BabelTransformer';\n\nexport default class MyProject extends Atviseproject { ... }\n```\n\nNow we override the _Atviseproject.useTransformers_ [getter](https://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Functions/get) to use our transformer:\n\n```javascript\n// Atviseproject.babel.js\n\n...\n\nexport default class MyProject extends Atviseproject {\n ...\n\n static get useTransformers() {\n return super.useTransformers\n .concat(new BabelTransformer());\n }\n\n}\n```\n\nThis statement tells _atscm_ to use a new _BabelTransformer_ instance **in addition to the default transformers** (`super.useTransformers`).\n\nTo verify everything worked so far run `atscm config`. Our new Transformer should show up in the _useTransformers_ section:\n\n```\n$ atscm config\n[08:38:16] Configuration at ~/custom-transformer/Atviseproject.babel.js\n{ host: '10.211.55.4',\n port:\n { opc: 4840,\n http: 80 },\n useTransformers:\n [ DisplayTransformer<>,\n ScriptTransformer<>,\n BabelTransformer<> ],\n ...\n```\n\n## Step 4: Implement _PartialTransformer#shouldBeTransformed_\n\n[PartialTransformer#shouldBeTransformed](https://atscm.github.io/atscm/class/src/lib/transform/PartialTransformer.js~PartialTransformer.html#instance-method-shouldBeTransformed) is responsible for filtering the files we want to transform. Returning `true` means the piped file will be transformed, `false` bypasses the file.\n\nIn out case we want to edit all JavaScript source files. Therefore we return true for all files with the extension `.js`. Edit _BabelTransformer.js_ accordingly:\n\n```javascript\n// atscm/BabelTransformer\n\n...\n\nexport default class BabelTransformer extends PartialTransformer {\n\n shouldBeTransformed(file) {\n return file.extname === '.js';\n }\n\n}\n```\n\n## Step 5: Implement _Transformer#transformFromFilesystem_\n\nImplementing [Transformer#transformFromFilesystem](https://atscm.github.io/atscm/class/src/lib/transform/Transformer.js~Transformer.html#instance-method-transformFromFilesystem) is probably the most important part of this tutorial. In here we define the logic that actually creates ES5 code from ES2015 sources.\n\nFirst of all, we need to **install additional dependencies** required. Running\n\n```bash\nnpm install --save-dev babel-core babel-preset-2015\n```\n\nwill install [Babel](http://babeljs.io) and it's ES2015 preset. This preset ensures all ES5 compatible browsers will be able to run the resulting code.\n\nWe will also need the [node.js buffer module](https://nodejs.org/api/buffer.html). We don't need to install it, as it comes with every node installation.\n\nNext, import these modules as usual:\n\n```javascript\n// atscm/BabelTransformer.js\n\nimport { Buffer } from 'buffer';\nimport { PartialTransformer } from 'atscm';\nimport { transform } from 'babel-core';\n\n...\n```\n\nThe import order follows a pretty usual convention:\n\n1. Core **node.js modules** (_buffer_ in our case)\n2. Other **external modules** (_babel-core_ and _atscm_ in our case)\n3. **Relative modules** (_./atscm/BabelTransformer.js_ inside _Atviseproject.babel.js_ in our case)\n\nNow we're ready to implement _Transformer#transformFromFilesystem_. What we're about to do is pretty simple:\n\n- We'll transpile the contents of the passed file with babels _transform_ method\n- We clone the passed file and set it's contents to a Buffer containing the resulting code\n- We pass the resulting file to other streams\n\n```javascript\nimport ...\n\nexport default class BabelTransformer extends PartialTransformer {\n\n static shouldBeTransformed(file) { ... }\n\n transformFromFilesystem(file, enc, callback) {\n // Create ES5 code\n const { code } = transform(file.contents, {\n presets: ['es2015']\n });\n\n // Create new file with ES5 content\n const result = file.clone();\n result.contents = Buffer.from(code);\n\n // We're done, pass the new file to other streams\n callback(null, result);\n }\n\n}\n```\n\n**Wow!** You just implemented your first custom transformer! Now we can write any scripts using the new ES2015 syntax.\n\n## Step 6: Test _BabelTransformer_\n\nIt's time to check if everything works as expected. Create a script file for the Main display containing ES2015 JavaScript:\n\n```javascript\n// src/AGENT/DISPLAYS/Main.display/Main.js\n\n// Class syntax\nclass Test {\n constructor(options = {}, ...otherArgs) {\n // Default values and rest params\n this.options = options;\n this.args = otherArgs.map((arg) => parseInt(arg, 10)); // Arrows and Lexical This\n }\n}\n\nconst a = 13; // Constants\nconst { options, args } = new Test({ a }, '23'); // Enhanced Object Literals\n\nalert(`Option a: ${options.a}, args: ${args.join(', ')}`); // Template Strings\n```\n\nRun `atscm push` to upload the new display script to atvise server. Open your atvise project in your favorite browser (you may have to delete the browser cache) and if everything worked you should see an alert box containing the text \"Option a: 13, args: 23\". When you inspect the page's source you'll see the display script code was transpiled to ES5.\n\n## Step 7: Implement _Transformer#transformFromDB_\n\nAs said at the beginning, atscm transformers allow transformation from and to the filesystem. A babel transpilation is a one-way process, meaning you cannot create ES2015 source code from the resulting ES5 code. Therefore the only thing we can do when transforming from atvise server to the filesystem is to prevent an override.\n\nWe do so by implementing [Transformer#transformFromDB](https://atscm.github.io/atscm/class/src/lib/transform/Transformer.js~Transformer.html#instance-method-transformFromDB):\n\n```javascript\n// atscm/BabelTransformer.js\n...\n\nexport default class BabelTransformer extends PartialTransfromer {\n ...\n\n transformFromDB(file, enc, callback) {\n // Optionally, we could print a warning here\n callback(null); // Ignore file, remove it from the stream\n }\n}\n```\n\nNow we can run `atscm push` without overriding our ES2015 source code.\n\n## Result\n\nThis is how your custom transformer should look now:\n\n```javascript\n// atscm/BabelTransformer.js\n\nimport { Buffer } from 'buffer';\nimport { PartialTransformer } from 'atscm';\nimport { transform } from 'babel-core';\n\nexport default class BabelTransformer extends PartialTransformer {\n shouldBeTransformed(file) {\n return file.extname === '.js';\n }\n\n transformFromFilesystem(file, enc, callback) {\n // Create ES5 code\n const { code } = transform(file.contents, {\n presets: ['es2015'],\n });\n\n // Create new file with ES5 content\n const result = file.clone();\n result.contents = Buffer.from(code);\n\n // We're done, pass the new file to other streams\n callback(null, result);\n }\n\n transformFromDB(file, enc, callback) {\n callback(null); // Ignore file, remove it from the stream\n }\n}\n```\n\n## Conclusion\n\nWe just created a custom Transformer in no time. It transpiles ES2015 code on push and prevents overriding this code on pull.\n\nOf course there are many ways to improve the transformer, for example:\n\n- Handle options to configure how babel transpiles the source code\n\n## Further reading\n\n- [babeljs.io](http://babeljs.io/learn-es2015/) provides a nice overview of ES2015 features. You can also use the [REPL](http://babeljs.io/repl/) to try out these features.\n", "static": true, "access": "public" }, { "kind": "manual", "longname": "/home/circleci/project/packages/atscm/docs/manual/advanced/id-conflicts.md", "name": "./docs/manual/advanced/id-conflicts.md", "content": "# Node ID conflicts\n\n> **Note that rename files are not available for atscm < v1.0.0.** Use `atscm update` to use the latest version\n\n## How atscm handles id conflicts\n\nLet's assume we have two atvise server nodes, _AGENT.OBJECT.conflictingnode_ and _AGENT.OBJECT.ConflictingNode_. These are valid node ids on the server, but when stored to the (case-insensitive) filesystem, the behaviour is undefined.\n\nWhen _atscm_ discovers such a name conflict it creates a _rename file_ at `./atscm/rename.json`. This file will contain a map where the conflicting ids stored against the name to use to resolve the conflict. by default _insert node name_ is used, e.g.:\n\n```json\n{\n \"AGENT.OBJECTS.ConflictingNode\": \"insert node name\"\n}\n```\n\n## How to resolve id conflicts\n\nOnce an id conflict is recognized and added to the rename file, it is your responsibility to provide non-conflicting node names, e.g.:\n\n```json\n{\n \"AGENT.OBJECTS.ConflictingNode\": \"ConflictingNode-renamed\"\n}\n```\n\nAfter that **run `atscm pull` again** to pull the conflicting nodes.\n", "static": true, "access": "public" }, { "kind": "manual", "longname": "/home/circleci/project/packages/atscm/docs/manual/advanced/gulp-plugins.md", "name": "./docs/manual/advanced/gulp-plugins.md", "content": "# Guide: gulp.js plugins\n\n> **Please note:** This guide assumes you have a basic knowledge on how gulp.js and custom _atscm_ transformers work. You may go through [gulp's getting started guide](https://github.com/gulpjs/gulp/blob/master/docs/getting-started.md) or the [custom transformer tutorial](https://atscm.github.io/atscm/manual/tutorial/custom-transformer.html) first otherwise.\n\n_atscm_ heavily relies on the [gulp.js](http://gulpjs.com) build tool. Therefore it's pretty easy to integrate existing [gulp plugins](http://gulpjs.com/plugins/) into _atscm_ transformers.\n\n## Using _Transformer_ class\n\nBasically, the only Transformer method you have to override is [Transformer#applyToStream](https://atscm.github.io/atscm/class/src/lib/transform/Transformer.js~Transformer.html#instance-method-applyToStream). In there, you can pipe your gulp plugin just as you would do in a regular gulp project. The only difference is, that you have to handle the current transform direction as well:\n\n**A basic example:**\n\n```javascript\nimport { Transformer, TransformDirection } from 'atscm';\nimport fromDBGulpPlugin from 'gulp-plugin-to-use-from-db';\nimport fromFSGulpPlugin from 'gulp-plugin-to-use-from-fs';\n\nclass MyTransformer extends Transformer {\n applyToStream(stream, direction) {\n if (direction === TransformDirection.FromDB) {\n return stream.pipe(fromDBGulpPlugin(/* plugin options */));\n }\n\n return stream.pipe(fromFSGulpPlugin(/* plugin options */));\n }\n}\n```\n\n## Using _PartialTransformer_ class\n\nIn most cases you'll have to transform only parts of the piped files. This can be done by inheriting from [PartialTransfomer class](https://atscm.github.io/atscm/class/src/lib/transform/PartialTransformer.js~PartialTransformer.html):\n\n**Transforming only JavaScript files:**\n\n```javascript\nimport { PartialTransformer, TransformDirection } from 'atscm';\nimport fromDBGulpPlugin from 'gulp-plugin-to-use-from-db';\nimport fromFSGulpPlugin from 'gulp-plugin-to-use-from-fs';\n\nclass MyPartialTransformer extends PartialTransformer {\n shouldBeTransformed(file) {\n return file.extname === '.js';\n }\n\n applyToFilteredStream(stream, direction) {\n if (direction === TransformDirection.FromDB) {\n return stream.pipe(fromDBGulpPlugin(/* plugin options */));\n }\n\n return stream.pipe(fromFSGulpPlugin(/* plugin options */));\n }\n}\n```\n\n## Conclusion\n\nUsing existing gulp plugins is probably the easiest way to use custom transformers inside an _atscm_ project. As there are **thousands of well-tested gulp-plugins** out there, you won't have to implemtent any transform logic in most cases.\n\nGive it a try!\n\n## Further reading\n\n- Take a look at [gulp's plugin page](http://gulpjs.com/plugins/) for a list of available plugins.\n", "static": true, "access": "public" }, { "kind": "manual", "longname": "/home/circleci/project/packages/atscm/docs/manual/advanced/debugging.md", "name": "./docs/manual/advanced/debugging.md", "content": "# Guide: Debugging atscm\n\n_atscm_ can be easily debugged using Google Chrome's developer tools. All you have to do to attach the debugger, is to start the command line interface with the `--inspect` or `--inspect-brk` flag. For this to work you must first find the path to _atscm-cli_'s executable:\n\n```bash\nwhich atscm\n```\n\n**Note: This only works on Linux and macOS only**\n\nYou can now use this executable directly and run it with the inspector flags, e.g.:\n\n```bash\nnode --inspect-brk \"$(which atscm)\" [arguments passed to atscm]\n```\n\n[For further details on how to use the debugger, visit the offical nodejs docs on debugging.](https://nodejs.org/en/docs/guides/debugging-getting-started/)\n", "static": true, "access": "public" }, { "kind": "manual", "longname": "/home/circleci/project/packages/atscm/docs/manual/advanced/error-handling.md", "name": "./docs/manual/advanced/error-handling.md", "content": "# Guide: Error handling\n\n## Adding source locations\n\nWhen a throwing an Error that was caused by client code, you should provide location info so it can be traced back to the source code.\n\nTo do so, simply add additional properties to the error object, containing the source code, the start location and (optionally) the end location.\n\n```javascript\nfunction myTransformCode() {\n const sourceCode = 'the code transformed';\n\n try {\n // Do something that may throw an error...\n } catch (error) {\n Object.assign(error, {\n rawLines: sourceCode, // A string containing the raw source code\n location: {\n start: {\n line: 1, // The line number\n column: 1, // The column number\n },\n // you could add a 'end' property here, with the same signature as 'start'\n },\n });\n\n // Finally re-throw the error\n throw error;\n }\n}\n```\n\n**Example output: XML Parse error**\n\n```\n[13:30:28] Using gulpfile ~/Downloads/delete/atscm-330/node_modules/atscm/out/Gulpfile.js\n[13:30:28] Starting 'pull'...\n[13:30:30] 'pull' errored after 1.09 s\n[13:30:30] closing tag mismatch\n 5 | \n 6 | \n> 7 | \n | ^ closing tag mismatch\n 8 | \n 9 |\n - Node: AGENT.DISPLAYS.Main\n```\n\n**Details**\n\n- [`@babel/code-frame`](https://babeljs.io/docs/en/babel-code-frame) is used to render the frame.\n", "static": true, "access": "public" }, { "kind": "manual", "longname": "/home/circleci/project/packages/atscm/docs/manual/advanced/api.md", "name": "./docs/manual/advanced/api.md", "content": "# Guide: Using the API\n\n> Learn how to use the atscm API to e.g. run server serverscripts in your node application.\n> **Available since atscm v1.0.0.** Use `atscm update` to use the latest version\n\n## Installation\n\nFirst of all, make sure your project has atscm installed: Take a look at your _package.json_ file and make sure, atscm is present in the _dependencies_ or (depending on your use case) _devDependencies_ section. Otherwise, **install atscm if necessary**:\n\n```bash\n# If you need atscm as a runtime-dependency\nnpm install --save atscm\n\n# If you need atscm as a development dependency (most likely)\nnpm install --save-dev atscm\n```\n\n## Configuration\n\nSimilar to regular atscm projects, you need an _Atviseproject_ file that contains atscm's configuration. A minimal example may look like this:\n\n```js\n// Atviseproject.js\nconst { Atviseproject } = require('atscm');\n\nmodule.exports = class ApiProject extends Atviseproject {\n // Add your configuration here, if needed.\n // By default, atvise server is assumed to run on opc.tcp://localhost:4840\n};\n```\n\nBefore you can finally require the atscm API in your project, you have to **set the `ATSCM_CONFIG_PATH` environment variable**, pointing to your _Atviseproject_ file. You can do this in multiple ways:\n\n- You can set it in your app at runtime (_recommended_)\n\n Adjust your app's entry file (assuming it's called _app.js_ in these examples) to set the variable **before you import atscm**:\n\n ```js\n // app.js\n const { join } = require('path');\n\n process.env.ATSCM_CONFIG_PATH = join(__dirname, '../Atviseproject.js');\n\n // Your app comes here...\n ```\n\n- You can set it every time you run your application:\n\n E.g. instead of running your app with `node ./app.js` you can use `ATSCM_CONFIG_PATH=\"/my-project/Atviseproject.js\" node ./app.js`.\n\n You can also use npm scripts so you simply have to run `npm run start`:\n\n ```json\n // package.json\n {\n \"scripts\": {\n \"start\": \"ATSCM_CONFIG_PATH='/my-project/Atviseproject.js' node ./app.js\"\n }\n }\n ```\n\n If your running on windows, use [`cross-env`](https://www.npmjs.com/package/cross-env) to set the environment variable (don't forget `npm install cross-env`):\n\n ```json\n // package.json\n {\n \"scripts\": {\n \"start\": \"cross-env ATSCM_CONFIG_PATH='/my-project/Atviseproject.js' node ./app.js\"\n }\n }\n ```\n\n## Usage\n\nRequire `atscm/api` and call the methods you need:\n\n```js\n// Set process.env.ATSCM_CONFIG_PATH here...\n\nconst atscm = require('atscm/api');\n\n// You can use atscm here...\n```\n\n## Examples\n\n**Create an export file for a node**\n\n```js\n// app.js\n\n// Import node core modules\nconst { promises: fsp } = require('fs');\nconst { join, dirname } = require('path');\n\n// Set atscm config env variable\nprocess.env.ATSCM_CONFIG_PATH = join(__dirname, './Atviseproject.js');\n\n// Require atscm and node-opcua APIs\nconst { NodeId } = require('atscm');\nconst { callMethod } = require('atscm/api');\nconst { Variant, DataType, VariantArrayType } = require('node-opcua');\n\n// Configuration: You could also use process.argv here...\nconst nodesToExport = ['AGENT.DISPLAYS.Main'];\nconst exportPath = './out/export.xml';\n\n// Our main function\nasync function createExportFile() {\n console.log(`Exporting nodes: ${nodesToExport.join(',')}`);\n\n // Use the 'exportNodes' method to create an xml export on the server\n const {\n outputArguments: [{ value }],\n } = await callMethod(new NodeId('AGENT.OPCUA.METHODS.exportNodes'), [\n new Variant({\n dataType: DataType.NodeId,\n arrayType: VariantArrayType.Array,\n value: nodesToExport.map((id) => new NodeId(id)),\n }),\n ]);\n\n // Create the output directory if needed\n await fsp.mkdir(dirname(exportPath), { recursive: true });\n\n // Write the export to the file\n await fsp.writeFile(exportPath, value);\n\n console.log(`Export written to ${exportPath}`);\n}\n\n// Run it and catch any errors\ncreateExportFile().catch((error) => {\n console.error(error);\n process.exitCode = 1;\n});\n```\n\n> Note: The example assumes the Atviseproject file is located in the same directory as the app's entry file. Otherwise you have to adjust you code accordingly.\n", "static": true, "access": "public" }, { "kind": "manual", "longname": "/home/circleci/project/packages/atscm/docs/manual/contribute/testing.md", "name": "./docs/manual/contribute/testing.md", "content": "# Contribute: Testing atscm\n\natscm uses both unit and integration tests. [Mocha](https://mochajs.org) is used as a test runner and [nyc](https://github.com/istanbuljs/nyc#readme) for test coverage reports.\n\n**Test scripts:**\n\n| Command | Description |\n| :------------------------- | :--------------------------------- |\n| `npm run test` | Run all tests |\n| `npm run test:unit` | Run all unit tests |\n| `npm run test:integration` | Run all integration tests |\n| `npm run test:watch` | Re-run all tests when files change |\n| `npm run test:coverage` | Check test coverage |\n\n## Unit tests\n\nThe unit tests are located inside `./test/src`. Test files are named after the module they test, e.g. unit tests for `./src/my/module.js` are inside `./test/src/my/module.spec.js`.\n\n## Integration tests\n\nIntegration tests are used to ensure cross-version and -platform compatibility. They are located inside `./test/integration`.\n\n### Test setups\n\nFor most integration tests, we use test setups to create the proper project structure to test against. These are XML files that can be imported to the running atserver before the tests are run. **The easiest way to create such files is with atbuilder:**\n\n- First _connect atvise builder_ to your running atserver\n- Create and _configure the node(s)_ you want to test against\n- Select theses nodes, right-click them and choose _\"Export hierarchy to XML\"_ from the context menu.\n- Save the export file to `./test/fixtures/setup`.\n\nAfter this, you can use the _importSetup_ method exported from [`./test/helpers/atscm.js`](./test/helpers/atscm.js) to import this setup. See the existing integration tests for examples.\n", "static": true, "access": "public" }, { "kind": "manual", "longname": "/home/circleci/project/.github/CONTRIBUTING.md", "name": "../../.github/CONTRIBUTING.md", "content": "# Contributing\n\nWe would love for you to contribute to atSCM. As a contributor, here are the guidelines we would like you to follow:\n\n## Found a bug?\n\nIf you find a bug in the source code, you can help us by submitting an issue to this repository. Even better, you can submit a Pull Request with a fix.\n\n## Missing a feature?\n\nYou can _request_ a new feature by submitting an issue to this repository. If you would like to _implement_ a new feature, please submit an issue with a proposal for your work first, to be sure that we can use it.\n\n## Submission Guidelines\n\n### Submitting an issue\n\nBefore you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.\n\nWe can only fix an issue if we can reproduce it. To help us provide the following information in your issue description:\n\n- **The original error message:** Any console output regarding the issue. Consider running _atscm_ with verbose logging (using the command line option `-LLLL`) to get more error details.\n- **_atscm_ and _atscm-cli_ versions used:** The results of `atscm --version`.\n- **atvise server version used**\n- **_node_ and _npm_ versions used:** The results of `node --version` and `npm version`.\n- **Special project setup:** Any default overrides to your `Atviseproject.js` file, such as custom Transformers.\n\n### Submitting a Pull Request (PR)\n\nBefore you submit your Pull Request (PR) consider the following guidelines:\n\n- Search GitHub for an open or closed PR that relates to your submission. You don't want to duplicate effort.\n- Make your changes in a new git branch: Run `git checkout -b my-fix-branch master`\n- Create your patch, **including appropriate test cases**.\n- Run the full test suite and ensure all tests pass.\n- Commit your changes using a descriptive commit message that follows our commit message conventions. Adherence to these conventions is necessary because release notes are automatically generated from these messages.\n- Push your branch to GitHub and create a pull request **to merge back to the beta branch**.\n- Once we reviewed your changes, we'll merge your pull request.\n\n> **Merge strategy (Maintainers only)**\n>\n> - Accepted changes from fix/feature branches **should always be squash-merged** to beta.\n> - Once beta is stable **create a regular merge commit** to merge back to master.\n> - After merging to master, changes should be synced back to the beta branch. To do so, run:\n> ```bash\n> git checkout beta\n> git fetch\n> git rebase origin/master\n> # Solve conflicts if any, accepting changes from master\n> git commit -m 'chore: Update from master'\n> git push\n> ```\n\n## Code quality control\n\n> All files inside this project are automatically built, linted and tested by [CircleCI](https://circleci.com/gh/atSCM/atscm).\n\nBuilds will only pass if they meet the following criteria:\n\n- **No ESLint errors:** We use [ESLint](http://eslint.org) to lint our entire JavaScript code. The config used is [eslint-config-lsage](https://www.npmjs.com/package/eslint-config-lsage). Any lint errors will cause the build to fail.\n- **Test coverage >= 90%:** We use [istanbul](https://gotwarlost.github.io/istanbul/) to validate test coverage is at least 90 percent. Any commits not covered by tests will cause the build to fail.\n- **Documentation coverage >= 90%:** Our source code is documented using [ESDoc](https://esdoc.org). We will only merge if your contribution is documented as well.\n\n## Setting up the development environment\n\n> In order to meet out coding guideline it's very useful to have your development environment set up right.\n\n### Linting files\n\nYou can lint all source files by running `npm run lint`. Although most IDEs support running it directly in the editor:\n\n**Jetbrains Webstorm**\n\n[Webstorm](https://www.jetbrains.com/webstorm/) has built-in support for ESLint. Check out [their documentation](https://www.jetbrains.com/help/webstorm/2016.3/eslint.html) to set it up.\n\n**Atom**\n\n[Atom](https://atom.io) has several packages that provide support for inline ESLint validation. We recommend you to use [linter-eslint](https://atom.io/packages/linter-eslint).\n\n### Running tests\n\nOur [mocha](https://mochajs.org) tests can be run by calling `npm test`. If you want the tests to be run right after you saved your changes, then run `npm run test:watch`.\n\n**Setup needed to run tests on atvise server**\n\nPlease note, that you have to **provide a valid atvise server connection** in order to get tests against atvise server running. You can achieve that by doing one of the following:\n\n- Set environment variables `ATVISE_USERNAME` and `ATVISE_PASSWORD` to valid credentials for the public atvise demo server at [demo.ativse.com](http://185.67.228.66:8888).\n- Adapt host, ports and login credentials inside `./test/fixtures/Atviseproject.babel.js`.\n\n**Check test coverage**\n\nTest coverage can be checked by running `npm run test:coverage`.\n\n### Creating API documentation\n\nRun `npm run docs` to create [ESDoc](https://esdoc.org) API documentation.\n\n\n\n\n## Commit Message Guideline\n\nWe have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history. But also, we use the git commit messages to **generate the changelog**.\n\n### Commit message format\n\n> tl;dr: We use an adaption of the [angular commit message convention](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines) with the only difference that capitalized subjects are allowed.\n\nEach commit message consists of a _header_, a _body_ and a footer. The header has a special format that includes a _type_, a _scope_ and a _subject_:\n\n```\n(): \n\n\n\n