@node-red/editor-api - npm Package Compare versions

lib/auth/index.js

		@@ -17,2 +17,7 @@ /**


		/**
		* @mixin @node-red/editor-api_auth
		*/

		var passport = require("passport");
		@@ -48,3 +53,10 @@ var oauth2orize = require("oauth2orize");
		}

		/**
		* Returns an Express middleware function that ensures the user making a request
		* has the necessary permission.
		*
		* @param {String} permission - the permission required for the request, such as `flows.write`
		* @return {Function} - an Express middleware
		* @memberof @node-red/editor-api_auth
		*/
		function needsPermission(permission) {
		@@ -51,0 +63,0 @@ return function(req,res,next) {

lib/index.js

		@@ -17,2 +17,12 @@ /**


		/**
		* 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
		*/

		var express = require("express");
		@@ -32,2 +42,11 @@ var bodyParser = require("body-parser");


		/**
		* Initialise the module.
		* @param {Object} settings The runtime settings
		* @param {HTTPServer} server An instance of HTTP Server
		* @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) {
		@@ -85,2 +104,8 @@ server = _server;
		}

		/**
		* Start the module.
		* @return {Promise} resolves when the application is ready to handle requests
		* @memberof @node-red/editor-api
		*/
		function start() {
		@@ -93,2 +118,8 @@ if (editor) {
		}

		/**
		* Stop the module.
		* @return {Promise} resolves when the application is stopped
		* @memberof @node-red/editor-api
		*/
		function stop() {
		@@ -104,6 +135,16 @@ if (editor) {
		stop: stop,

		/**
		* @memberof @node-red/editor-api
		* @mixes @node-red/editor-api_auth
		*/
		auth: {
		needsPermission: auth.needsPermission
		},
		/**
		* The Express app used to serve the Node-RED Editor
		* @type ExpressApplication
		* @memberof @node-red/editor-api
		*/
		get httpAdmin() { return adminApp; }
		};

package.json

New alerts