superdata/src/proxy/restCore.js

A lightweight data layer module motivated by extjs' data layer. It can be used with any client-side framework.

/*
 * Rest proxy core
 */

/*jslint node: true */
"use strict";

module.exports = function(dependencies) {

	if(!dependencies) {
		throw new Error("dependencies is mandatory!");
	}

	if(!dependencies.createAjaxProxy) {
		throw new Error("dependencies.createAjaxProxy is mandatory!");
	}

	var createAjaxProxy = dependencies.createAjaxProxy;

	return function createRestProxy(config) {

		if (!config) {
			throw new Error("config is mandatory");
		}

		if (!config.route) {
			throw new Error("config.route is mandatory");
		}

		if (typeof config.route !== "string" &&	config.route.constructor !== Array) {
			throw new Error("config.route must be either string or array");
		}

		var queries = config.queries || {};

		var readQuery = queries.read || {};
		var createOneQuery = queries.createOne || {};
		var readOneByIdQuery = queries.readOneById || {};
		var updateOneByIdQuery = queries.updateOneById || {};
		var patchOneByIdQuery = queries.patchOneById || {};
		var destroyOneByIdQuery = queries.destroyOneById || {};

		var route = config.route;

		function addId(route) {
			var newRoute;

			if (typeof route === "string") {
				newRoute = [route];
			} else {
				newRoute = route.slice(0);
			}

			for (var i = 0; i < newRoute.length; i += 1) {
				newRoute[i] += "/:id";
			}

			return newRoute;
		}

		var restProxy = createAjaxProxy({
			idProperty: config.idProperty,
			idType: config.idType,
			timeout: config.timeout,
			operations: {
				read: {
					route: route,
					method: "GET",
					reader: config.reader,
					queries: readQuery
				},
				createOne: {
					route: route,
					method: "POST",
					queries: createOneQuery
				},
				readOneById: {
					route: addId(route),
					method: "GET",
					queries: readOneByIdQuery
				},
				updateOneById: {
					route: addId(route),
					method: "PUT",
					queries: updateOneByIdQuery
				},
				patchOneById: {
					route: addId(route),
					method: "PATCH",
					queries: patchOneByIdQuery
				},
				destroyOneById: {
					route: addId(route),
					method: "DELETE",
					queries: destroyOneByIdQuery
				}
			}
		});

		return restProxy;
	};
};