node-red/packages/node_modules/@node-red/runtime/lib/api/library.js

/**
 * Copyright JS Foundation and other contributors, http://js.foundation
 *
 * 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.
 **/

/**
 * @mixin @node-red/runtime_library
 */

var runtime;

var api = module.exports = {
    init: function(_runtime) {
        runtime = _runtime;
    },

    // /* *
    // * Gets the configuration of a library source.
    // * @param {Object} opts
    // * @param {User} opts.user - the user calling the api
    // * @param {String} opts.library - the library
    // * @param {Object} opts.req - the request to log (optional)
    // * @return {Promise<String|Object>} - resolves when complete
    // * @memberof @node-red/runtime_library
    // */
    // getConfig: async function(opts) {
    //     runtime.log.audit({event: "library.getConfig",library:opts.library}, opts.req);
    //     try {
    //         return runtime.library.getConfig(opts.library)
    //     } catch(err) {
    //         var error = new Error();
    //         error.code = "not_found";
    //         error.status = 404;
    //         throw error;
    //     }
    // },

    /**
    * Gets an entry from the library.
    * @param {Object} opts
    * @param {User} opts.user - the user calling the api
    * @param {String} opts.library - the library
    * @param {String} opts.type - the type of entry
    * @param {String} opts.path - the path of the entry
    * @param {Object} opts.req - the request to log (optional)
    * @return {Promise<String|Object>} - resolves when complete
    * @memberof @node-red/runtime_library
    */
    getEntry: async function(opts) {
        return runtime.library.getEntry(opts.library,opts.type,opts.path).then(function(result) {
            runtime.log.audit({event: "library.get",library:opts.library,type:opts.type,path:opts.path}, opts.req);
            return result;
        }).catch(function(err) {
            if (err) {
                runtime.log.warn(runtime.log._("api.library.error-load-entry",{library:opts.library,type:opts.type,path:opts.path,message:err.toString()}));
                if (err.code === 'forbidden') {
                    err.status = 403;
                    throw err;
                } else if (err.code === "not_found") {
                    err.status = 404;
                } else {
                    err.status = 400;
                }
                runtime.log.audit({event: "library.get",library:opts.library,type:opts.type,path:opts.path,error:err.code}, opts.req);
                throw err;
            }
            runtime.log.audit({event: "library.get",library:opts.library,type:opts.type,error:"not_found"}, opts.req);
            var error = new Error();
            error.code = "not_found";
            error.status = 404;
            throw error;
        });
    },

    /**
    * Saves an entry to the library
    * @param {Object} opts
    * @param {User} opts.user - the user calling the api
    * @param {String} opts.library - the library
    * @param {String} opts.type - the type of entry
    * @param {String} opts.path - the path of the entry
    * @param {Object} opts.meta - any meta data associated with the entry
    * @param {String} opts.body - the body of the entry
    * @param {Object} opts.req - the request to log (optional)
    * @return {Promise} - resolves when complete
    * @memberof @node-red/runtime_library
    */
    saveEntry: async function(opts) {
        return runtime.library.saveEntry(opts.library,opts.type,opts.path,opts.meta,opts.body).then(function() {
            runtime.log.audit({event: "library.set",type:opts.type,path:opts.path}, opts.req);
        }).catch(function(err) {
            runtime.log.warn(runtime.log._("api.library.error-save-entry",{path:opts.path,message:err.toString()}));
            if (err.code === 'forbidden') {
                runtime.log.audit({event: "library.set",type:opts.type,path:opts.path,error:"forbidden"}, opts.req);
                err.status = 403;
                throw err;
            }
            runtime.log.audit({event: "library.set",type:opts.type,path:opts.path,error:"unexpected_error",message:err.toString()}, opts.req);
            var error = new Error();
            error.status = 400;
            throw error;
        });
    }
}