suanpan_node_sdk 2.2.4 → 2.2.5-beta

package/dist/core/script/script-context.js

@@ -1,296 +1,296 @@
-'use strict';
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const _ = require('lodash');
-const is = require('is-type-of');
-const fs = require('fs-extra');
-const csv = require('csvtojson');
-const util = require('util');
-const path = require('path');
-const storage = require('./script-storage');
-const log_1 = __importDefault(require("../common/log"));
-const ScriptFront = require('./script-front');
-const EventEmitter = require('events');
-const { isTrue, getConfig, pathEndWith, stringifyIfNecessary } = require('../utils');
-const { OUT_TYPE, MAX_LENGTH, OUT_SUB_TYPE, TRIMIMMEDIATELY } = require('./script-constant');
-const { validate, buildSendData, getNodeQueueName, buildDashBoardData } = require('./script-support');
-class CommonScriptContext extends EventEmitter {
-    constructor({ userId, appId, nodeId, portId, data, when, extra, portTypes, spmqClient, utils, builtInModules, manager }) {
-        super();
-        this.userId = userId;
-        this.appId = appId;
-        this.nodeId = nodeId;
-        this.portId = portId;
-        this.data = data || {};
-        this.when = when || '';
-        this.extra = extra || {};
-        this.debug = (this.extra && this.extra.global && isTrue(this.extra.global.debug));
-        this.portTypes = portTypes;
-        this.spmqClient = spmqClient;
-        this.utils = utils || {};
-        this.emitEventToDashboard = this.utils.emitEventToDashboard;
-        this.emitEventToSuanpanWeb = this.utils.emitEventToSuanpanWeb;
-        this.modules = builtInModules;
-        this.storage = storage;
-        this.page = new ScriptFront(manager, this.extra, this.emitEventToDashboard, this);
-    }
-    emitToSuanpanWeb() {
-        if (this.utils.emitEventToSuanpanWeb) {
-            this.utils.emitEventToSuanpanWeb(...arguments);
-        }
-    }
-    /**
-     * built-in modules
-     * @param {*} moduleName
-     */
-    require(moduleName) {
-        if (!_.includes(Object.keys(this.modules), moduleName)) {
-            throw new Error(`moduleName: ${moduleName} is not support now.`);
-        }
-        return this.modules[moduleName];
-    }
-    /**
-     * Convert a csv file with csvtojson
-     * @param {*} csvFilePath local csv file path or storage objectName
-     * @returns JSON Array
-     */
-    csvToJson(csvFilePath) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!csvFilePath) {
-                throw new Error('csvFilePath is required.');
-            }
-            if (!is.string(csvFilePath)) {
-                throw new Error('csvFilePath must be string.');
-            }
-            if (pathEndWith(csvFilePath, '.csv') && fs.pathExistsSync(csvFilePath)) {
-                return yield csv().fromFile(csvFilePath);
-            }
-            const objectExist = yield this.storage.fileExist(csvFilePath);
-            if (!objectExist) {
-                throw new Error(`csvFilePath: ${csvFilePath} is not exist.`);
-            }
-            const csvStream = yield this.storage.getStream(csvFilePath);
-            if (!is.readableStream(csvStream)) {
-                throw new Error(`${csvStream} is not readableStream.`);
-            }
-            return yield csv().fromStream(csvStream);
-        });
-    }
-    /**
-     * Convert buffer to json object
-     * @param {*} buffer
-     */
-    bufferToJsonObj(buffer) {
-        if (!_.isBuffer(buffer)) {
-            return buffer;
-        }
-        return JSON.parse(buffer.toString());
-    }
-    getCurrentUserDir() {
-        return path.join('studio', this.userId);
-    }
-    getCurrentAppDir() {
-        return path.join(this.getCurrentUserDir(), this.appId);
-    }
-    getDefaultStorageDir() {
-        return path.join(this.getCurrentAppDir(), 'script');
-    }
-    /**
-     * async delay
-     * @param {*} ms unit millisecond
-     */
-    sleep(ms) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return new Promise(resolve => setTimeout(resolve, ms));
-        });
-    }
-    getDataType(nodeId, portId, type, subType) {
-        const outType = `${portId}${OUT_TYPE}`;
-        const outSubType = `${portId}${OUT_SUB_TYPE}`;
-        return {
-            [outType]: type || this.portTypes[nodeId][portId].type,
-            [outSubType]: subType || this.portTypes[nodeId][portId].subType
-        };
-    }
-    buildSender() {
-        return (currentNodeId, targetNodeId, { data, queue, maxlen, trimImmediately }) => __awaiter(this, void 0, void 0, function* () {
-            try {
-                yield this.spmqClient.sendMessage({ queue, data, maxlen, trimImmediately });
-                const msg = `sent message to queue ${queue} from ${currentNodeId || 'initializer hook'} to ${targetNodeId}, data: ${JSON.stringify(data)}.`;
-                if (this.debug) {
-                    log_1.default.debug(msg);
-                }
-            }
-            catch (ex) {
-                log_1.default.error(ex);
-            }
-        });
-    }
-    /**
-     * Sends a message to the port(in) of the specified node
-     * All dashboard components do not receive array or objects and need to be converted to JSON string
-     * @param {*} targetNodeId
-     * @param {*} targetPortId
-     * @param {*} sendValue
-     * @param {*} type
-     * @param {*} subType
-     */
-    sendMessage(targetNodeId, targetPortId, sendValue, type, subType) {
-        return __awaiter(this, void 0, void 0, function* () {
-            validate(this.when, targetNodeId, targetPortId);
-            const queueName = getNodeQueueName(targetNodeId);
-            const dataType = this.getDataType(targetNodeId, targetPortId, type, subType);
-            try {
-                if (!_.isEmpty(this.utils) && this.utils.isDashboardNode(targetNodeId)) {
-                    log_1.default.info(`sendMessage to dashboard, nodeId: ${targetNodeId}, portId: ${targetPortId}, data: ${sendValue}`);
-                    if (_.isEmpty(this.extra.global)) {
-                        this.extra.global = {
-                            currentUserId: this.userId
-                        };
-                    }
-                    const data = buildDashBoardData(targetPortId, sendValue, dataType);
-                    this.utils.sendMessageToDashboard(targetNodeId, data, this.extra);
-                    return;
-                }
-                const sendData = buildSendData(this.data, targetPortId, sendValue, dataType, this.extra);
-                const sender = this.buildSender();
-                const maxlen = getConfig(MAX_LENGTH) || 2000;
-                const trimImmediately = getConfig(TRIMIMMEDIATELY) || true;
-                yield sender(this.nodeId, targetNodeId, {
-                    data: sendData,
-                    queue: queueName,
-                    maxlen,
-                    trimImmediately
-                });
-            }
-            catch (ex) {
-                throw new Error(`sent message to queue ${queueName} from ${this.nodeId || 'initializer hook'} to ${targetNodeId} failed. \nError: ${ex}`);
-            }
-        });
-    }
-    /**
-     * TODO: add coordinate options support
-     * @param {*} array2D
-     * @param {*} options
-     */
-    update2DArray(array2D, options) {
-        if (_.isEmpty(options)) {
-            return array2D;
-        }
-        const { icon = '*', columnsNames, columnsIndexs } = options;
-        const columnsHeads = _.head(array2D);
-        return array2D.reduce((acc, currentValue, currentIndex) => {
-            if (currentIndex === 0) {
-                return acc;
-            }
-            if (_.isEmpty(columnsIndexs) && _.isEmpty(columnsNames)) {
-                acc.push(currentValue.map(m => icon));
-                return acc;
-            }
-            if (_.isString(columnsIndexs) || _.isNumber(columnsIndexs)) {
-                currentValue[columnsIndexs] = icon;
-            }
-            else if (_.isArray(columnsIndexs)) {
-                _.forEach(columnsIndexs, columnsIndex => {
-                    if (currentValue[columnsIndex]) {
-                        currentValue[columnsIndex] = icon;
-                    }
-                });
-            }
-            if (_.isString(columnsNames)) {
-                const columnsHeadIndex = _.indexOf(columnsHeads, columnsNames);
-                if (columnsHeadIndex !== -1) {
-                    currentValue[columnsHeadIndex] = icon;
-                }
-            }
-            else if (_.isArray(columnsNames)) {
-                _.forEach(columnsNames, columnsName => {
-                    const columnsHeadIndex = _.indexOf(columnsHeads, columnsName);
-                    if (columnsHeadIndex !== -1) {
-                        currentValue[columnsHeadIndex] = icon;
-                    }
-                });
-            }
-            acc.push(currentValue);
-            return acc;
-        }, []);
-    }
-}
-class AppScriptContext extends CommonScriptContext {
-    constructor(userId, appId, portTypes, spmqClient, utils, builtInModules, manager) {
-        super({ userId, appId, portTypes, spmqClient, utils, builtInModules, manager });
-        this.g = {};
-    }
-    log(...args) {
-        this.emitToSuanpanWeb('globalLogging', {
-            userId: this.userId,
-            appId: this.appId,
-            content: util.format(...args)
-        });
-    }
-}
-class NodeScriptContext extends CommonScriptContext {
-    constructor(userId, appId, nodeId, portId, when, data, extra, spmqClient, portTypes, utils, manager, globalVariable, builtInModules) {
-        super({ userId, appId, nodeId, portId, data, when, extra, portTypes, spmqClient, utils, manager, builtInModules });
-        this.logPrefix = `(${userId},${appId},${nodeId},${portId},${when})`;
-        this.g = globalVariable;
-    }
-    /**
-     * output of log in custom script
-     * @param  {...any} args
-     */
-    log(...args) {
-        this.emitToSuanpanWeb('scriptLogging', {
-            node: this.nodeId,
-            port: this.portId,
-            when: this.when,
-            content: util.format(...args)
-        });
-    }
-    /**
-     * The data is converted to @param newValue and passed to the connected node
-     * @param {*} newValue
-     */
-    resetData(newValue) {
-        const oldValue = this.data[this.portId];
-        try {
-            this.data[this.portId] = _.isString(newValue) ? newValue : JSON.stringify(newValue);
-            if (this.debug) {
-                log_1.default.debug(`${this.logPrefix} script reseted data FROM ${oldValue} TO `, newValue);
-            }
-        }
-        catch (ex) {
-            log_1.default.error(`reset ${newValue} failed ${ex.stack} fallback to raw data`);
-            this.data[this.portId] = oldValue;
-        }
-    }
-    /**
-     * script stopped data to downstream
-     */
-    stop() {
-        log_1.default.info(`${this.logPrefix} script stopped data to downstream.`);
-        delete this.data[this.portId];
-    }
-    getCurrentNodeDir() {
-        return path.join(this.getCurrentAppDir(), this.nodeId);
-    }
-    getNodeDir(nodeId) {
-        return path.join(this.getCurrentAppDir(), nodeId);
-    }
-    display(data) {
-        this.log(stringifyIfNecessary(data));
-    }
-}
-module.exports = { NodeScriptContext, AppScriptContext };
+'use strict';
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const _ = require('lodash');
+const is = require('is-type-of');
+const fs = require('fs-extra');
+const csv = require('csvtojson');
+const util = require('util');
+const path = require('path');
+const storage = require('./script-storage');
+const log_1 = __importDefault(require("../common/log"));
+const ScriptFront = require('./script-front');
+const EventEmitter = require('events');
+const { isTrue, getConfig, pathEndWith, stringifyIfNecessary } = require('../utils');
+const { OUT_TYPE, MAX_LENGTH, OUT_SUB_TYPE, TRIMIMMEDIATELY } = require('./script-constant');
+const { validate, buildSendData, getNodeQueueName, buildDashBoardData } = require('./script-support');
+class CommonScriptContext extends EventEmitter {
+    constructor({ userId, appId, nodeId, portId, data, when, extra, portTypes, spmqClient, utils, builtInModules, manager }) {
+        super();
+        this.userId = userId;
+        this.appId = appId;
+        this.nodeId = nodeId;
+        this.portId = portId;
+        this.data = data || {};
+        this.when = when || '';
+        this.extra = extra || {};
+        this.debug = (this.extra && this.extra.global && isTrue(this.extra.global.debug));
+        this.portTypes = portTypes;
+        this.spmqClient = spmqClient;
+        this.utils = utils || {};
+        this.emitEventToDashboard = this.utils.emitEventToDashboard;
+        this.emitEventToSuanpanWeb = this.utils.emitEventToSuanpanWeb;
+        this.modules = builtInModules;
+        this.storage = storage;
+        this.page = new ScriptFront(manager, this.extra, this.emitEventToDashboard, this);
+    }
+    emitToSuanpanWeb() {
+        if (this.utils.emitEventToSuanpanWeb) {
+            this.utils.emitEventToSuanpanWeb(...arguments);
+        }
+    }
+    /**
+     * built-in modules
+     * @param {*} moduleName
+     */
+    require(moduleName) {
+        if (!_.includes(Object.keys(this.modules), moduleName)) {
+            throw new Error(`moduleName: ${moduleName} is not support now.`);
+        }
+        return this.modules[moduleName];
+    }
+    /**
+     * Convert a csv file with csvtojson
+     * @param {*} csvFilePath local csv file path or storage objectName
+     * @returns JSON Array
+     */
+    csvToJson(csvFilePath) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!csvFilePath) {
+                throw new Error('csvFilePath is required.');
+            }
+            if (!is.string(csvFilePath)) {
+                throw new Error('csvFilePath must be string.');
+            }
+            if (pathEndWith(csvFilePath, '.csv') && fs.pathExistsSync(csvFilePath)) {
+                return yield csv().fromFile(csvFilePath);
+            }
+            const objectExist = yield this.storage.fileExist(csvFilePath);
+            if (!objectExist) {
+                throw new Error(`csvFilePath: ${csvFilePath} is not exist.`);
+            }
+            const csvStream = yield this.storage.getStream(csvFilePath);
+            if (!is.readableStream(csvStream)) {
+                throw new Error(`${csvStream} is not readableStream.`);
+            }
+            return yield csv().fromStream(csvStream);
+        });
+    }
+    /**
+     * Convert buffer to json object
+     * @param {*} buffer
+     */
+    bufferToJsonObj(buffer) {
+        if (!_.isBuffer(buffer)) {
+            return buffer;
+        }
+        return JSON.parse(buffer.toString());
+    }
+    getCurrentUserDir() {
+        return path.join('studio', this.userId);
+    }
+    getCurrentAppDir() {
+        return path.join(this.getCurrentUserDir(), this.appId);
+    }
+    getDefaultStorageDir() {
+        return path.join(this.getCurrentAppDir(), 'script');
+    }
+    /**
+     * async delay
+     * @param {*} ms unit millisecond
+     */
+    sleep(ms) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new Promise(resolve => setTimeout(resolve, ms));
+        });
+    }
+    getDataType(nodeId, portId, type, subType) {
+        const outType = `${portId}${OUT_TYPE}`;
+        const outSubType = `${portId}${OUT_SUB_TYPE}`;
+        return {
+            [outType]: type || this.portTypes[nodeId][portId].type,
+            [outSubType]: subType || this.portTypes[nodeId][portId].subType
+        };
+    }
+    buildSender() {
+        return (currentNodeId, targetNodeId, { data, queue, maxlen, trimImmediately }) => __awaiter(this, void 0, void 0, function* () {
+            try {
+                yield this.spmqClient.sendMessage({ queue, data, maxlen, trimImmediately });
+                const msg = `sent message to queue ${queue} from ${currentNodeId || 'initializer hook'} to ${targetNodeId}, data: ${JSON.stringify(data)}.`;
+                if (this.debug) {
+                    log_1.default.debug(msg);
+                }
+            }
+            catch (ex) {
+                log_1.default.error(ex);
+            }
+        });
+    }
+    /**
+     * Sends a message to the port(in) of the specified node
+     * All dashboard components do not receive array or objects and need to be converted to JSON string
+     * @param {*} targetNodeId
+     * @param {*} targetPortId
+     * @param {*} sendValue
+     * @param {*} type
+     * @param {*} subType
+     */
+    sendMessage(targetNodeId, targetPortId, sendValue, type, subType) {
+        return __awaiter(this, void 0, void 0, function* () {
+            validate(this.when, targetNodeId, targetPortId);
+            const queueName = getNodeQueueName(targetNodeId);
+            const dataType = this.getDataType(targetNodeId, targetPortId, type, subType);
+            try {
+                if (!_.isEmpty(this.utils) && this.utils.isDashboardNode(targetNodeId)) {
+                    log_1.default.info(`sendMessage to dashboard, nodeId: ${targetNodeId}, portId: ${targetPortId}, data: ${sendValue}`);
+                    if (_.isEmpty(this.extra.global)) {
+                        this.extra.global = {
+                            currentUserId: this.userId
+                        };
+                    }
+                    const data = buildDashBoardData(targetPortId, sendValue, dataType);
+                    this.utils.sendMessageToDashboard(targetNodeId, data, this.extra);
+                    return;
+                }
+                const sendData = buildSendData(this.data, targetPortId, sendValue, dataType, this.extra);
+                const sender = this.buildSender();
+                const maxlen = getConfig(MAX_LENGTH) || 2000;
+                const trimImmediately = getConfig(TRIMIMMEDIATELY) || true;
+                yield sender(this.nodeId, targetNodeId, {
+                    data: sendData,
+                    queue: queueName,
+                    maxlen,
+                    trimImmediately
+                });
+            }
+            catch (ex) {
+                throw new Error(`sent message to queue ${queueName} from ${this.nodeId || 'initializer hook'} to ${targetNodeId} failed. \nError: ${ex}`);
+            }
+        });
+    }
+    /**
+     * TODO: add coordinate options support
+     * @param {*} array2D
+     * @param {*} options
+     */
+    update2DArray(array2D, options) {
+        if (_.isEmpty(options)) {
+            return array2D;
+        }
+        const { icon = '*', columnsNames, columnsIndexs } = options;
+        const columnsHeads = _.head(array2D);
+        return array2D.reduce((acc, currentValue, currentIndex) => {
+            if (currentIndex === 0) {
+                return acc;
+            }
+            if (_.isEmpty(columnsIndexs) && _.isEmpty(columnsNames)) {
+                acc.push(currentValue.map(m => icon));
+                return acc;
+            }
+            if (_.isString(columnsIndexs) || _.isNumber(columnsIndexs)) {
+                currentValue[columnsIndexs] = icon;
+            }
+            else if (_.isArray(columnsIndexs)) {
+                _.forEach(columnsIndexs, columnsIndex => {
+                    if (currentValue[columnsIndex]) {
+                        currentValue[columnsIndex] = icon;
+                    }
+                });
+            }
+            if (_.isString(columnsNames)) {
+                const columnsHeadIndex = _.indexOf(columnsHeads, columnsNames);
+                if (columnsHeadIndex !== -1) {
+                    currentValue[columnsHeadIndex] = icon;
+                }
+            }
+            else if (_.isArray(columnsNames)) {
+                _.forEach(columnsNames, columnsName => {
+                    const columnsHeadIndex = _.indexOf(columnsHeads, columnsName);
+                    if (columnsHeadIndex !== -1) {
+                        currentValue[columnsHeadIndex] = icon;
+                    }
+                });
+            }
+            acc.push(currentValue);
+            return acc;
+        }, []);
+    }
+}
+class AppScriptContext extends CommonScriptContext {
+    constructor(userId, appId, portTypes, spmqClient, utils, builtInModules, manager) {
+        super({ userId, appId, portTypes, spmqClient, utils, builtInModules, manager });
+        this.g = {};
+    }
+    log(...args) {
+        this.emitToSuanpanWeb('globalLogging', {
+            userId: this.userId,
+            appId: this.appId,
+            content: util.format(...args)
+        });
+    }
+}
+class NodeScriptContext extends CommonScriptContext {
+    constructor(userId, appId, nodeId, portId, when, data, extra, spmqClient, portTypes, utils, manager, globalVariable, builtInModules) {
+        super({ userId, appId, nodeId, portId, data, when, extra, portTypes, spmqClient, utils, manager, builtInModules });
+        this.logPrefix = `(${userId},${appId},${nodeId},${portId},${when})`;
+        this.g = globalVariable;
+    }
+    /**
+     * output of log in custom script
+     * @param  {...any} args
+     */
+    log(...args) {
+        this.emitToSuanpanWeb('scriptLogging', {
+            node: this.nodeId,
+            port: this.portId,
+            when: this.when,
+            content: util.format(...args)
+        });
+    }
+    /**
+     * The data is converted to @param newValue and passed to the connected node
+     * @param {*} newValue
+     */
+    resetData(newValue) {
+        const oldValue = this.data[this.portId];
+        try {
+            this.data[this.portId] = _.isString(newValue) ? newValue : JSON.stringify(newValue);
+            if (this.debug) {
+                log_1.default.debug(`${this.logPrefix} script reseted data FROM ${oldValue} TO `, newValue);
+            }
+        }
+        catch (ex) {
+            log_1.default.error(`reset ${newValue} failed ${ex.stack} fallback to raw data`);
+            this.data[this.portId] = oldValue;
+        }
+    }
+    /**
+     * script stopped data to downstream
+     */
+    stop() {
+        log_1.default.info(`${this.logPrefix} script stopped data to downstream.`);
+        delete this.data[this.portId];
+    }
+    getCurrentNodeDir() {
+        return path.join(this.getCurrentAppDir(), this.nodeId);
+    }
+    getNodeDir(nodeId) {
+        return path.join(this.getCurrentAppDir(), nodeId);
+    }
+    display(data) {
+        this.log(stringifyIfNecessary(data));
+    }
+}
+module.exports = { NodeScriptContext, AppScriptContext };
 //# sourceMappingURL=script-context.js.map

package/dist/core/script/script-front.d.ts

@@ -1 +1 @@
-export {};
+export {};