@kitmi/jacaranda/src/routers/rest.js

JavaScript application framework

import { naming, text, hasMethod, batchAsync_, get as _get, set as _set } from '@kitmi/utils';
import { loadControllers_ } from '../helpers/loadModuleFrom_';

/**
 * Simple RESTful router.
 * @module Router_REST
 */

/**
 * Create a RESTful router.
 * @param {Routable} app
 * @param {string} baseRoute
 * @param {object} options
 * @property {string} [options.$controllerPath]
 * @property {object} [options.$errorOptions]
 * @property {object|array} [options.$middlewares]
 * @example
 *  '<base path>': {
 *      REST: {
 *          $controllerPath:
 *          $errorOptions:
 *          $middlewares:
 *      }
 *  }
 *
 *  route                          http method    function of ctrl
 *  /:resource                     get            list
 *  /:resource                     post           create
 *  /:resource/:id                 get            detail
 *  /:resource/:id                 put            update
 *  /:resource/:id                 delete         remove
 */
const restRouter = async (app, baseRoute, options) => {
    let router = app.router.createRouter(baseRoute);

    let resourcesPath = options.$controllerPath ?? 'resources';
    const kebabify = options.$urlDasherize;

    app.useMiddleware(
        router,
        await (
            await app.getMiddlewareFactory_('jsonError')
        )(options.$errorOptions, app),
        'jsonError'
    );

    if (options.$middlewares) {
        await app.useMiddlewares_(router, options.$middlewares);
    }

    const controllers = await loadControllers_(app, options.$source, resourcesPath, options.$packageName);

    await batchAsync_(controllers, async (controller, relPath) => {
        let batchUrl = text.ensureStartsWith(
            relPath
                .split('/')
                .map((p) => (kebabify ? naming.kebabCase(p) : p))
                .join('/'),
            '/'
        );
        let singleUrl = batchUrl + '/:id';

        if (typeof controller === 'function') {
            controller = new controller(app);
        }

        if (hasMethod(controller, 'list')) {
            await app.addRoute_(router, 'get', batchUrl, (ctx) => controller.list(ctx));
        }

        if (hasMethod(controller, 'create')) {
            await app.addRoute_(router, 'post', batchUrl, (ctx) => controller.create(ctx));
        }

        if (hasMethod(controller, 'detail')) {
            await app.addRoute_(router, 'get', singleUrl, (ctx) => controller.detail(ctx, ctx.params.id));
        }

        if (hasMethod(controller, 'update')) {
            await app.addRoute_(router, 'put', singleUrl, (ctx) => controller.update(ctx, ctx.params.id));
        }

        if (hasMethod(controller, 'remove')) {
            await app.addRoute_(router, 'delete', singleUrl, (ctx) => controller.remove(ctx, ctx.params.id));
        }
    });

    app.addRouter(router);
};

export default restRouter;