1
0
mirror of https://github.com/node-red/node-red.git synced 2023-10-10 13:36:53 +02:00
node-red/packages/node_modules/@node-red/editor-api/lib/index.js

156 lines
4.6 KiB
JavaScript
Raw Normal View History

2014-11-04 12:34:49 +01:00
/**
* Copyright JS Foundation and other contributors, http://js.foundation
2014-11-04 12:34:49 +01:00
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
**/
2019-01-28 15:40:24 +01:00
/**
* This module provides an Express application to serve the Node-RED editor.
*
* It implements the Node-RED HTTP Admin API the Editor uses to interact
* with the Node-RED runtime.
*
* @namespace @node-red/editor-api
*/
2014-11-04 12:34:49 +01:00
var express = require("express");
2015-07-15 23:43:24 +02:00
var bodyParser = require("body-parser");
2014-11-04 12:34:49 +01:00
var util = require('util');
2014-11-06 23:59:48 +01:00
var passport = require('passport');
var cors = require('cors');
2014-11-04 12:34:49 +01:00
2014-11-06 23:59:48 +01:00
var auth = require("./auth");
var apiUtil = require("./util");
2014-11-04 12:34:49 +01:00
var adminApp;
2015-11-24 23:38:42 +01:00
var server;
var editor;
2019-01-28 15:40:24 +01:00
/**
* Initialise the module.
* @param {Object} settings The runtime settings
2019-10-21 17:35:35 +02:00
* @param {HTTPServer} _server An instance of HTTP Server
2019-01-28 15:40:24 +01:00
* @param {Storage} storage An instance of Node-RED Storage
* @param {Runtime} runtimeAPI An instance of Node-RED Runtime
* @memberof @node-red/editor-api
*/
function init(settings,_server,storage,runtimeAPI) {
2015-11-24 23:38:42 +01:00
server = _server;
if (settings.httpAdminRoot !== false) {
adminApp = express();
2018-05-14 15:32:58 +02:00
var cors = require('cors');
var corsHandler = cors({
origin: "*",
methods: "GET,PUT,POST,DELETE"
});
adminApp.use(corsHandler);
if (settings.httpAdminMiddleware) {
if (typeof settings.httpAdminMiddleware === "function" || Array.isArray(settings.httpAdminMiddleware)) {
adminApp.use(settings.httpAdminMiddleware);
}
}
var defaultServerSettings = {
"x-powered-by": false
}
var serverSettings = Object.assign({},defaultServerSettings,settings.httpServerOptions||{});
for (var eOption in serverSettings) {
adminApp.set(eOption, serverSettings[eOption]);
}
2018-04-23 12:21:02 +02:00
auth.init(settings,storage);
var maxApiRequestSize = settings.apiMaxLength || '5mb';
adminApp.use(bodyParser.json({limit:maxApiRequestSize}));
adminApp.use(bodyParser.urlencoded({limit:maxApiRequestSize,extended:true}));
adminApp.get("/auth/login",auth.login,apiUtil.errorHandler);
if (settings.adminAuth) {
if (settings.adminAuth.type === "strategy") {
auth.genericStrategy(adminApp,settings.adminAuth.strategy);
} else if (settings.adminAuth.type === "credentials") {
adminApp.use(passport.initialize());
adminApp.post("/auth/token",
auth.ensureClientSecret,
auth.authenticateClient,
auth.getToken,
auth.errorHandler
);
}
adminApp.post("/auth/revoke",auth.needsPermission(""),auth.revoke,apiUtil.errorHandler);
}
2018-01-16 12:21:54 +01:00
// Editor
if (!settings.disableEditor) {
editor = require("./editor");
2018-04-23 12:21:02 +02:00
var editorApp = editor.init(server, settings, runtimeAPI);
adminApp.use(editorApp);
}
if (settings.httpAdminCors) {
var corsHandler = cors(settings.httpAdminCors);
adminApp.use(corsHandler);
}
2014-11-06 23:59:48 +01:00
var adminApiApp = require("./admin").init(settings, runtimeAPI);
adminApp.use(adminApiApp);
} else {
adminApp = null;
}
2014-11-04 12:34:49 +01:00
}
2019-01-28 15:40:24 +01:00
/**
* Start the module.
* @return {Promise} resolves when the application is ready to handle requests
* @memberof @node-red/editor-api
*/
2020-11-30 15:38:48 +01:00
async function start() {
if (editor) {
return editor.start();
}
}
2019-01-28 15:40:24 +01:00
/**
* Stop the module.
* @return {Promise} resolves when the application is stopped
* @memberof @node-red/editor-api
*/
2020-11-30 15:38:48 +01:00
async function stop() {
if (editor) {
editor.stop();
}
}
2014-11-04 12:34:49 +01:00
module.exports = {
init: init,
start: start,
stop: stop,
2019-01-28 15:40:24 +01:00
/**
* @memberof @node-red/editor-api
* @mixes @node-red/editor-api_auth
*/
auth: {
needsPermission: auth.needsPermission
},
2019-01-28 15:40:24 +01:00
/**
* The Express app used to serve the Node-RED Editor
* @type ExpressApplication
* @memberof @node-red/editor-api
*/
2018-12-04 16:59:43 +01:00
get httpAdmin() { return adminApp; }
};