@fjell/express-router 4.4.14 → 4.4.19

package/dist/index.cjs

@@ -1,657 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-
-const core = require('@fjell/core');
-const lib = require('@fjell/lib');
-const deepmerge = require('deepmerge');
-const express = require('express');
-const Logging = require('@fjell/logging');
-const registry = require('@fjell/registry');
-
-const LibLogger = Logging.getLogger('@fjell/express-router');
-
-function _define_property$2(obj, key, value) {
-    if (key in obj) {
-        Object.defineProperty(obj, key, {
-            value: value,
-            enumerable: true,
-            configurable: true,
-            writable: true
-        });
-    } else {
-        obj[key] = value;
-    }
-    return obj;
-}
-class ItemRouter {
-    getLk(res) {
-        return {
-            kt: this.keyType,
-            lk: res.locals[this.getPkParam()]
-        };
-    }
-    // this is meant to be consumed by children routers
-    getLKA(res) {
-        return [
-            this.getLk(res)
-        ];
-    }
-    getPk(res) {
-        return core.cPK(res.locals[this.getPkParam()], this.getPkType());
-    }
-    // Unless this is a contained router, the locations will always be an empty array.
-    /* eslint-disable */ getLocations(res) {
-        throw new Error('Method not implemented in an abstract router');
-    }
-    /* eslint-enable */ // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    getIk(res) {
-        throw new Error('Method not implemented in an abstract router');
-    }
-    /* istanbul ignore next */ getRouter() {
-        const router = express.Router();
-        this.configure(router);
-        return router;
-    }
-    constructor(lib$1, keyType, options = {}){
-        _define_property$2(this, "lib", void 0);
-        _define_property$2(this, "keyType", void 0);
-        _define_property$2(this, "options", void 0);
-        _define_property$2(this, "childRouters", {});
-        _define_property$2(this, "logger", void 0);
-        _define_property$2(this, "getPkType", ()=>{
-            return this.keyType;
-        });
-        _define_property$2(this, "getPkParam", ()=>{
-            return `${this.getPkType()}Pk`;
-        });
-        _define_property$2(this, "postAllAction", async (req, res)=>{
-            const libOptions = this.lib.options;
-            const libOperations = this.lib.operations;
-            this.logger.debug('Posting All Action', {
-                query: req === null || req === void 0 ? void 0 : req.query,
-                params: req === null || req === void 0 ? void 0 : req.params,
-                locals: res === null || res === void 0 ? void 0 : res.locals
-            });
-            const allActionKey = req.path.substring(req.path.lastIndexOf('/') + 1);
-            if (!libOptions.allActions) {
-                this.logger.error('Item Actions are not configured');
-                res.status(500).json({
-                    error: 'Item Actions are not configured'
-                });
-                return;
-            }
-            const allAction = libOptions.allActions[allActionKey];
-            if (!allAction) {
-                this.logger.error('All Action is not configured', {
-                    allActionKey
-                });
-                res.status(500).json({
-                    error: 'Item Action is not configured'
-                });
-                return;
-            }
-            try {
-                res.json(await libOperations.allAction(allActionKey, req.body));
-            } catch (err) {
-                this.logger.error('Error in All Action', {
-                    message: err === null || err === void 0 ? void 0 : err.message,
-                    stack: err === null || err === void 0 ? void 0 : err.stack
-                });
-                res.status(500).json(err);
-            }
-        });
-        _define_property$2(this, "getAllFacet", async (req, res)=>{
-            const libOptions = this.lib.options;
-            const libOperations = this.lib.operations;
-            this.logger.debug('Getting All Facet', {
-                query: req === null || req === void 0 ? void 0 : req.query,
-                params: req === null || req === void 0 ? void 0 : req.params,
-                locals: res === null || res === void 0 ? void 0 : res.locals
-            });
-            const facetKey = req.path.substring(req.path.lastIndexOf('/') + 1);
-            if (!libOptions.allFacets) {
-                this.logger.error('Item Facets are not configured');
-                res.status(500).json({
-                    error: 'Item Facets are not configured'
-                });
-                return;
-            }
-            const facet = libOptions.allFacets[facetKey];
-            if (!facet) {
-                this.logger.error('Item Facet is not configured', {
-                    facetKey
-                });
-                res.status(500).json({
-                    error: 'Item Facet is not configured'
-                });
-                return;
-            }
-            try {
-                const combinedQueryParams = {
-                    ...req.query,
-                    ...req.params
-                };
-                res.json(await libOperations.allFacet(facetKey, combinedQueryParams));
-            } catch (err) {
-                this.logger.error('Error in All Facet', {
-                    message: err === null || err === void 0 ? void 0 : err.message,
-                    stack: err === null || err === void 0 ? void 0 : err.stack
-                });
-                res.status(500).json(err);
-            }
-        });
-        _define_property$2(this, "postItemAction", async (req, res)=>{
-            const libOptions = this.lib.options;
-            const libOperations = this.lib.operations;
-            this.logger.debug('Getting Item', {
-                query: req === null || req === void 0 ? void 0 : req.query,
-                params: req === null || req === void 0 ? void 0 : req.params,
-                locals: res === null || res === void 0 ? void 0 : res.locals
-            });
-            const ik = this.getIk(res);
-            const actionKey = req.path.substring(req.path.lastIndexOf('/') + 1);
-            if (!libOptions.actions) {
-                this.logger.error('Item Actions are not configured');
-                res.status(500).json({
-                    error: 'Item Actions are not configured'
-                });
-                return;
-            }
-            const action = libOptions.actions[actionKey];
-            if (!action) {
-                this.logger.error('Item Action is not configured', {
-                    actionKey
-                });
-                res.status(500).json({
-                    error: 'Item Action is not configured'
-                });
-                return;
-            }
-            try {
-                res.json(await libOperations.action(ik, actionKey, req.body));
-            } catch (err) {
-                this.logger.error('Error in Item Action', {
-                    message: err === null || err === void 0 ? void 0 : err.message,
-                    stack: err === null || err === void 0 ? void 0 : err.stack
-                });
-                res.status(500).json(err);
-            }
-        });
-        _define_property$2(this, "getItemFacet", async (req, res)=>{
-            const libOptions = this.lib.options;
-            const libOperations = this.lib.operations;
-            this.logger.debug('Getting Item', {
-                query: req === null || req === void 0 ? void 0 : req.query,
-                params: req === null || req === void 0 ? void 0 : req.params,
-                locals: res === null || res === void 0 ? void 0 : res.locals
-            });
-            const ik = this.getIk(res);
-            const facetKey = req.path.substring(req.path.lastIndexOf('/') + 1);
-            if (!libOptions.facets) {
-                this.logger.error('Item Facets are not configured');
-                res.status(500).json({
-                    error: 'Item Facets are not configured'
-                });
-                return;
-            }
-            const facet = libOptions.facets[facetKey];
-            if (!facet) {
-                this.logger.error('Item Facet is not configured', {
-                    facetKey
-                });
-                res.status(500).json({
-                    error: 'Item Facet is not configured'
-                });
-                return;
-            }
-            try {
-                const combinedQueryParams = {
-                    ...req.query,
-                    ...req.params
-                };
-                res.json(await libOperations.facet(ik, facetKey, combinedQueryParams));
-            } catch (err) {
-                this.logger.error('Error in Item Facet', {
-                    message: err === null || err === void 0 ? void 0 : err.message,
-                    stack: err === null || err === void 0 ? void 0 : err.stack
-                });
-                res.status(500).json(err);
-            }
-        });
-        _define_property$2(this, "configure", (router)=>{
-            const libOptions = this.lib.options;
-            this.logger.debug('Configuring Router', {
-                pkType: this.getPkType()
-            });
-            router.get('/', this.findItems);
-            router.post('/', this.createItem);
-            this.logger.default('All Actions supplied to Router', {
-                allActions: libOptions.allActions
-            });
-            if (libOptions.allActions) {
-                Object.keys(libOptions.allActions).forEach((actionKey)=>{
-                    this.logger.debug('Configuring All Action %s', actionKey);
-                    // TODO: Ok, this is a bit of a hack, but we need to customize the types of the request handlers
-                    router.post(`/${actionKey}`, this.postAllAction);
-                });
-            }
-            this.logger.default('All Facets supplied to Router', {
-                allFacets: libOptions.allFacets
-            });
-            if (libOptions.allFacets) {
-                Object.keys(libOptions.allFacets).forEach((facetKey)=>{
-                    this.logger.debug('Configuring All Facet %s', facetKey);
-                    // TODO: Ok, this is a bit of a hack, but we need to customize the types of the request handlers
-                    router.get(`/${facetKey}`, this.getAllFacet);
-                });
-            }
-            const itemRouter = express.Router();
-            itemRouter.get('/', this.getItem);
-            itemRouter.put('/', this.updateItem);
-            itemRouter.delete('/', this.deleteItem);
-            this.logger.default('Item Actions supplied to Router', {
-                itemActions: libOptions.actions
-            });
-            if (libOptions.actions) {
-                Object.keys(libOptions.actions).forEach((actionKey)=>{
-                    this.logger.debug('Configuring Item Action %s', actionKey);
-                    // TODO: Ok, this is a bit of a hack, but we need to customize the types of the request handlers
-                    itemRouter.post(`/${actionKey}`, this.postItemAction);
-                });
-            }
-            this.logger.default('Item Facets supplied to Router', {
-                itemFacets: libOptions.facets
-            });
-            if (libOptions.facets) {
-                Object.keys(libOptions.facets).forEach((facetKey)=>{
-                    this.logger.debug('Configuring Item Facet %s', facetKey);
-                    // TODO: Ok, this is a bit of a hack, but we need to customize the types of the request handlers
-                    itemRouter.get(`/${facetKey}`, this.getItemFacet);
-                });
-            }
-            this.logger.debug('Configuring Item Operations under PK Param %s', this.getPkParam());
-            router.use(`/:${this.getPkParam()}`, this.validatePrimaryKeyValue, itemRouter);
-            if (this.childRouters) {
-                this.configureChildRouters(itemRouter, this.childRouters);
-            }
-            return router;
-        });
-        _define_property$2(this, "validatePrimaryKeyValue", (req, res, next)=>{
-            const pkParamValue = req.params[this.getPkParam()];
-            if (this.validatePKParam(pkParamValue)) {
-                res.locals[this.getPkParam()] = pkParamValue;
-                next();
-            } else {
-                this.logger.error('Invalid Primary Key', {
-                    pkParamValue,
-                    path: req === null || req === void 0 ? void 0 : req.originalUrl
-                });
-                res.status(500).json({
-                    error: 'Invalid Primary Key',
-                    path: req === null || req === void 0 ? void 0 : req.originalUrl
-                });
-            }
-        });
-        _define_property$2(this, "configureChildRouters", (router, childRouters)=>{
-            for(const path in childRouters){
-                this.logger.debug('Configuring Child Router at Path %s', path);
-                router.use(`/${path}`, childRouters[path]);
-            }
-            return router;
-        });
-        _define_property$2(this, "addChildRouter", (path, router)=>{
-            this.childRouters[path] = router;
-        });
-        /* istanbul ignore next */ // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        _define_property$2(this, "createItem", async (req, res)=>{
-            throw new Error('Method not implemented in an abstract router');
-        });
-        // TODO: Probably a better way to do this, but this postCreate hook only needs the item.
-        /* istanbul ignore next */ _define_property$2(this, "postCreateItem", async (item)=>{
-            this.logger.debug('Post Create Item', {
-                item
-            });
-            return item;
-        });
-        _define_property$2(this, "deleteItem", async (req, res)=>{
-            const libOperations = this.lib.operations;
-            this.logger.debug('Deleting Item', {
-                query: req.query,
-                params: req.params,
-                locals: res.locals
-            });
-            const ik = this.getIk(res);
-            const removedItem = await libOperations.remove(ik);
-            const item = core.validatePK(removedItem, this.getPkType());
-            res.json(item);
-        });
-        /* eslint-disable */ /* istanbul ignore next */ _define_property$2(this, "findItems", async (req, res)=>{
-            throw new Error('Method not implemented in an abstract router');
-        });
-        /* eslint-enable */ _define_property$2(this, "getItem", async (req, res)=>{
-            const libOperations = this.lib.operations;
-            this.logger.debug('Getting Item', {
-                query: req.query,
-                params: req.params,
-                locals: res.locals
-            });
-            const ik = this.getIk(res);
-            try {
-                // TODO: What error does validate PK throw, when can that fail?
-                const item = core.validatePK(await libOperations.get(ik), this.getPkType());
-                res.json(item);
-            } catch (err) {
-                if (err instanceof lib.NotFoundError) {
-                    this.logger.error('Item Not Found', {
-                        ik,
-                        message: err === null || err === void 0 ? void 0 : err.message,
-                        stack: err === null || err === void 0 ? void 0 : err.stack
-                    });
-                    res.status(404).json({
-                        ik,
-                        message: "Item Not Found"
-                    });
-                } else {
-                    this.logger.error('General Error', {
-                        ik,
-                        message: err === null || err === void 0 ? void 0 : err.message,
-                        stack: err === null || err === void 0 ? void 0 : err.stack
-                    });
-                    res.status(500).json({
-                        ik,
-                        message: "General Error"
-                    });
-                }
-            }
-        });
-        _define_property$2(this, "updateItem", async (req, res)=>{
-            const libOperations = this.lib.operations;
-            this.logger.debug('Updating Item', {
-                body: req === null || req === void 0 ? void 0 : req.body,
-                query: req === null || req === void 0 ? void 0 : req.query,
-                params: req === null || req === void 0 ? void 0 : req.params,
-                locals: res === null || res === void 0 ? void 0 : res.locals
-            });
-            const ik = this.getIk(res);
-            const itemToUpdate = this.convertDates(req.body);
-            const retItem = core.validatePK(await libOperations.update(ik, itemToUpdate), this.getPkType());
-            res.json(retItem);
-        });
-        _define_property$2(this, "convertDates", (item)=>{
-            const events = item.events;
-            this.logger.debug('Converting Dates', {
-                item
-            });
-            if (events) {
-                Object.keys(events).forEach((key)=>{
-                    Object.assign(events, {
-                        [key]: deepmerge(events[key], {
-                            at: events[key].at ? new Date(events[key].at) : null
-                        })
-                    });
-                });
-            }
-            Object.assign(item, {
-                events
-            });
-            return item;
-        });
-        // TODO: Maybe just simplify this and require that everything is a UUID?
-        /**
-   * This method might be an annoyance, but we need to capture a few cases where someone passes
-   * a PK parameter that has an odd string in it.
-   *
-   * @param pkParamValue The value of the primary key parameter
-   * @returns if the value is valid.
-   */ _define_property$2(this, "validatePKParam", (pkParamValue)=>{
-            let validPkParam = true;
-            if (pkParamValue.length <= 0) {
-                this.logger.error('Primary Key is an Empty String', {
-                    pkParamValue
-                });
-                validPkParam = false;
-            } else if (pkParamValue === 'undefined') {
-                this.logger.error('Primary Key is the string \'undefined\'', {
-                    pkParamValue
-                });
-                validPkParam = false;
-            }
-            return validPkParam;
-        });
-        this.lib = lib$1;
-        this.keyType = keyType;
-        this.options = options;
-        this.logger = LibLogger.get("ItemRouter", keyType);
-    }
-}
-
-function _define_property$1(obj, key, value) {
-    if (key in obj) {
-        Object.defineProperty(obj, key, {
-            value: value,
-            enumerable: true,
-            configurable: true,
-            writable: true
-        });
-    } else {
-        obj[key] = value;
-    }
-    return obj;
-}
-class CItemRouter extends ItemRouter {
-    hasParent() {
-        return !!this.parentRoute;
-    }
-    getIk(res) {
-        const pri = this.getPk(res);
-        const loc = this.getLocations(res);
-        return {
-            kt: pri.kt,
-            pk: pri.pk,
-            loc
-        };
-    }
-    getLKA(res) {
-        /**
-     * A location key array is passed to a child router to provide contextfor the items it will
-     * be working with.  It is always a concatenation of "My LKA" + "Parent LKA" which will
-     * bubble all the way up to the root Primary.
-     */ let lka = [
-            this.getLk(res)
-        ];
-        lka = lka.concat(this.parentRoute.getLKA(res));
-        return lka;
-    }
-    getLocations(res) {
-        return this.parentRoute.getLKA(res);
-    }
-    constructor(lib, type, parentRoute, options = {}){
-        super(lib, type, options), _define_property$1(this, "parentRoute", void 0), _define_property$1(this, "createItem", async (req, res)=>{
-            const libOperations = this.lib.operations;
-            this.logger.default('Creating Item', {
-                body: req === null || req === void 0 ? void 0 : req.body,
-                query: req === null || req === void 0 ? void 0 : req.query,
-                params: req === null || req === void 0 ? void 0 : req.params,
-                locals: res === null || res === void 0 ? void 0 : res.locals
-            });
-            const itemToCreate = this.convertDates(req.body);
-            let item = core.validatePK(await libOperations.create(itemToCreate, {
-                locations: this.getLocations(res)
-            }), this.getPkType());
-            item = await this.postCreateItem(item);
-            this.logger.default('Created Item %j', item);
-            res.json(item);
-        }), _define_property$1(this, "findItems", async (req, res)=>{
-            const libOperations = this.lib.operations;
-            const query = req.query;
-            const finder = query['finder'];
-            const finderParams = query['finderParams'];
-            const one = query['one'];
-            let items = [];
-            if (finder) {
-                // If finder is defined?  Call a finder.
-                this.logger.default('Finding Items with Finder', {
-                    finder,
-                    finderParams,
-                    one
-                });
-                if (one === 'true') {
-                    const item = await this.lib.findOne(finder, JSON.parse(finderParams), this.getLocations(res));
-                    items = item ? [
-                        item
-                    ] : [];
-                } else {
-                    items = await libOperations.find(finder, JSON.parse(finderParams), this.getLocations(res));
-                }
-            } else {
-                // TODO: This is once of the more important places to perform some validaation and feedback
-                const itemQuery = core.paramsToQuery(req.query);
-                this.logger.default('Finding Items with Query: %j', itemQuery);
-                items = await libOperations.all(itemQuery, this.getLocations(res));
-                this.logger.default('Found %d Items with Query', items.length);
-            }
-            res.json(items.map((item)=>core.validatePK(item, this.getPkType())));
-        });
-        this.parentRoute = parentRoute;
-    }
-}
-
-function _define_property(obj, key, value) {
-    if (key in obj) {
-        Object.defineProperty(obj, key, {
-            value: value,
-            enumerable: true,
-            configurable: true,
-            writable: true
-        });
-    } else {
-        obj[key] = value;
-    }
-    return obj;
-}
-class PItemRouter extends ItemRouter {
-    getIk(res) {
-        const pri = this.getPk(res);
-        return pri;
-    }
-    constructor(lib, keyType, options = {}){
-        super(lib, keyType, options), _define_property(this, "createItem", async (req, res)=>{
-            const libOperations = this.lib.operations;
-            this.logger.default('Creating Item', {
-                body: req.body,
-                query: req.query,
-                params: req.params,
-                locals: res.locals
-            });
-            const itemToCreate = this.convertDates(req.body);
-            let item = core.validatePK(await libOperations.create(itemToCreate), this.getPkType());
-            item = await this.postCreateItem(item);
-            this.logger.default('Created Item %j', item);
-            res.json(item);
-        }), _define_property(this, "findItems", async (req, res)=>{
-            const libOperations = this.lib.operations;
-            this.logger.default('Finding Items', {
-                query: req.query,
-                params: req.params,
-                locals: res.locals
-            });
-            let items = [];
-            const query = req.query;
-            const finder = query['finder'];
-            const finderParams = query['finderParams'];
-            const one = query['one'];
-            if (finder) {
-                // If finder is defined?  Call a finder.
-                this.logger.default('Finding Items with Finder %s %j one:%s', finder, finderParams, one);
-                if (one === 'true') {
-                    const item = await this.lib.findOne(finder, JSON.parse(finderParams));
-                    items = item ? [
-                        item
-                    ] : [];
-                } else {
-                    items = await libOperations.find(finder, JSON.parse(finderParams));
-                }
-            } else {
-                // TODO: This is once of the more important places to perform some validaation and feedback
-                const itemQuery = core.paramsToQuery(req.query);
-                this.logger.default('Finding Items with a query %j', itemQuery);
-                items = await libOperations.all(itemQuery);
-            }
-            res.json(items.map((item)=>core.validatePK(item, this.getPkType())));
-        });
-    }
-}
-
-const logger$2 = LibLogger.get("Instance");
-const createInstance = (registry$1, coordinate, router, operations, options)=>{
-    logger$2.debug("createInstance", {
-        coordinate,
-        router,
-        registry: registry$1,
-        operations,
-        options
-    });
-    const baseInstance = registry.createInstance(registry$1, coordinate);
-    return {
-        ...baseInstance,
-        router,
-        operations,
-        options: options || {}
-    };
-};
-const isInstance = (instance)=>{
-    return instance != null && typeof instance === 'object' && instance.coordinate != null && instance.router != null && instance.registry != null && instance.operations != null && instance.options != null;
-};
-
-const logger$1 = LibLogger.get("InstanceFactory");
-/**
- * Factory function for creating express-router instances
- */ const createInstanceFactory = (router, operations, options)=>{
-    return (coordinate, context)=>{
-        logger$1.debug("Creating express-router instance", {
-            coordinate,
-            registry: context.registry,
-            router,
-            operations,
-            options
-        });
-        return createInstance(context.registry, coordinate, router, operations, options);
-    };
-};
-
-const logger = LibLogger.get("Registry");
-/**
- * Factory function for creating express-router registries
- */ const createRegistryFactory = ()=>{
-    return (type, registryHub)=>{
-        if (type !== 'express-router') {
-            throw new Error(`Express Router registry factory can only create 'express-router' type registries, got: ${type}`);
-        }
-        logger.debug("Creating express-router registry", {
-            type,
-            registryHub
-        });
-        const baseRegistry = registry.createRegistry(type, registryHub);
-        // Cast to Registry for type safety
-        return baseRegistry;
-    };
-};
-/**
- * Creates a new express-router registry instance
- */ const createRegistry = (registryHub)=>{
-    const baseRegistry = registry.createRegistry('express-router', registryHub);
-    return {
-        ...baseRegistry
-    };
-};
-
-exports.CItemRouter = CItemRouter;
-exports.ItemRouter = ItemRouter;
-exports.PItemRouter = PItemRouter;
-exports.createInstance = createInstance;
-exports.createInstanceFactory = createInstanceFactory;
-exports.createRegistry = createRegistry;
-exports.createRegistryFactory = createRegistryFactory;
-exports.isInstance = isInstance;
-//# sourceMappingURL=index.cjs.map