@varasto/express-crud
Version:
Express.js CRUD generator that uses Varasto storage
172 lines (171 loc) • 6.82 kB
JavaScript
;
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __asyncValues = (this && this.__asyncValues) || function (o) {
if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
var m = o[Symbol.asyncIterator], i;
return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.createRouter = void 0;
const storage_1 = require("@varasto/storage");
const express_1 = __importDefault(require("express"));
const uuid_1 = require("uuid");
/**
* Using `instanceof` doesn't work in the CI for some reason, which is why I
* added separate function for testing whether an object is instance of
* `InvalidSlugError`.
*/
const isInvalidSlugError = (object) => object instanceof storage_1.InvalidSlugError ||
(object != null && Reflect.get(object, 'name') === storage_1.InvalidSlugError.name);
/**
* Constructs an router that provides CRUD operations for an namespace in given
* storage. All data passed through `POST` or `PATCH` operations must pass
* validation provided by given schema.
*
* @param storage Varasto storage to used for storing the data.
* @param namespace Namespace where the data will be stored into.
* @param options Various options that can be given to the router.
* @returns An Express.js router that provides CRUD operations which work on
* data stored in specified namespace in the Varasto storage.
*/
const createRouter = (storage, namespace, options = {}) => {
var _a;
const router = (0, express_1.default)();
const schema = options.schema;
const keyGenerator = (_a = options.keyGenerator) !== null && _a !== void 0 ? _a : uuid_1.v4;
const validate = (res, data, onSuccess) => {
if (schema) {
schema
.parseAsync(data)
.then(onSuccess)
.catch((err) => {
res.status(400).json({
error: 'Data did not pass validation.',
errors: err.issues,
});
});
}
else {
onSuccess(data);
}
};
const handleError = (res, error, message) => {
if (isInvalidSlugError(error)) {
res.status(400).json({ error: error.message });
}
else {
res.status(500).json({ error: message });
}
};
const get = (res, key, onSuccess) => {
storage
.get(namespace, key)
.then((value) => {
if (value === undefined) {
res.status(404).json({ error: 'Item does not exist.' });
}
else {
onSuccess(value);
}
})
.catch((err) => {
handleError(res, err, 'Unable to retrieve item.');
});
};
const store = (res, key, data) => {
validate(res, data, (validData) => {
storage
.set(namespace, key, validData)
.then(() => {
res.status(201).json(validData);
})
.catch((err) => {
handleError(res, err, 'Unable to store item.');
});
});
};
router.use(express_1.default.json());
router.get('/', (req, res) => __awaiter(void 0, void 0, void 0, function* () {
var _a, e_1, _b, _c;
try {
const result = {};
try {
for (var _d = true, _e = __asyncValues(storage.entries(namespace)), _f; _f = yield _e.next(), _a = _f.done, !_a; _d = true) {
_c = _f.value;
_d = false;
const [key, value] = _c;
result[key] = value;
}
}
catch (e_1_1) { e_1 = { error: e_1_1 }; }
finally {
try {
if (!_d && !_a && (_b = _e.return)) yield _b.call(_e);
}
finally { if (e_1) throw e_1.error; }
}
res.status(200).json(result);
}
catch (err) {
handleError(res, err, 'Unable to retrieve items.');
}
}));
router.get('/:key', (req, res) => {
get(res, req.params.key, (value) => {
res.status(200).json(value);
});
});
router.post('/', (req, res) => {
validate(res, req.body, (validData) => {
const key = keyGenerator(validData);
storage
.set(namespace, key, validData)
.then(() => {
res.status(201).json({ key });
})
.catch((err) => {
handleError(res, err, 'Unable to store item.');
});
});
});
router.post('/:key', (req, res) => {
const { key } = req.params;
get(res, key, () => {
store(res, key, req.body);
});
});
router.patch('/:key', (req, res) => {
const { key } = req.params;
get(res, key, (oldData) => {
store(res, key, Object.assign(Object.assign({}, oldData), req.body));
});
});
router.delete('/:key', (req, res) => {
const { key } = req.params;
get(res, key, (value) => {
storage
.delete(namespace, req.params.key)
.then(() => {
res.status(201).json(value);
})
.catch((err) => {
handleError(res, err, 'Unable to remove item.');
});
});
});
return router;
};
exports.createRouter = createRouter;