@fjell/express-router 4.3.1

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Fjell Project
+
+   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.

package/dist/src/CItemRouter.d.ts

@@ -0,0 +1,14 @@
+import { ComKey, Item, LocKeyArray } from "@fjell/core";
+import { Request, Response } from "express";
+import { ItemRouter, ItemRouterOptions } from "./ItemRouter";
+import { Contained } from "@fjell/lib";
+export declare class CItemRouter<T extends Item<S, L1, L2, L3, L4, L5>, S extends string, L1 extends string, L2 extends string = never, L3 extends string = never, L4 extends string = never, L5 extends string = never> extends ItemRouter<S, L1, L2, L3, L4, L5> {
+    private parentRoute;
+    constructor(lib: Contained.Operations<T, S, L1, L2, L3, L4, L5>, type: S, parentRoute: ItemRouter<L1, L2, L3, L4, L5, never>, options?: ItemRouterOptions);
+    hasParent(): boolean;
+    getIk(res: Response): ComKey<S, L1, L2, L3, L4, L5>;
+    getLKA(res: Response): LocKeyArray<S, L1, L2, L3, L4>;
+    getLocations(res: Response): LocKeyArray<L1, L2, L3, L4, L5>;
+    protected createItem: (req: Request, res: Response) => Promise<Response<any, Record<string, any>>>;
+    protected findItems: (req: Request, res: Response) => Promise<Response<any, Record<string, any>>>;
+}

package/dist/src/CItemRouter.js

@@ -0,0 +1,58 @@
+import { paramsToQuery, validatePK } from "@fjell/core";
+import { ItemRouter } from "./ItemRouter";
+import LibLogger from "./logger";
+const logger = LibLogger.get('CItemRouter');
+export class CItemRouter extends ItemRouter {
+    parentRoute;
+    constructor(lib, type, parentRoute, options = {}) {
+        super(lib, type, options);
+        this.parentRoute = parentRoute;
+    }
+    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);
+    }
+    createItem = async (req, res) => {
+        logger.trace('Creating Item 2', { body: req?.body, query: req?.query, params: req?.params, locals: res?.locals });
+        const itemToCreate = this.convertDates(req.body);
+        let item = validatePK(await this.lib.create(itemToCreate, { locations: this.getLocations(res) }), this.getPkType());
+        item = await this.postCreateItem(item);
+        return res.json(item);
+    };
+    /* eslint-disable */
+    findItems = async (req, res) => {
+        logger.trace('Finding Items', { query: req.query, params: req.params, locals: res.locals });
+        const query = req.query;
+        const finder = query['finder'];
+        const finderParams = query['finderParams'];
+        let items = [];
+        if (finder) {
+            // If finder is defined?  Call a finder.
+            items = await this.lib.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 = paramsToQuery(req.query);
+            items = await this.lib.all(itemQuery, this.getLocations(res));
+        }
+        return res.json(items.map((item) => validatePK(item, this.getPkType())));
+    };
+}
+//# sourceMappingURL=CItemRouter.js.map

package/dist/src/CItemRouter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CItemRouter.js","sourceRoot":"","sources":["../../src/CItemRouter.ts"],"names":[],"mappings":"AAAA,OAAO,EACyC,aAAa,EAAuB,UAAU,EAC7F,MAAM,aAAa,CAAC;AAErB,OAAO,EAAE,UAAU,EAAqB,MAAM,cAAc,CAAC;AAC7D,OAAO,SAAS,MAAM,UAAU,CAAC;AAGjC,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;AAK5C,MAAM,OAAO,WAQX,SAAQ,UAAiC;IAEjC,WAAW,CAAwC;IAE3D,YACE,GAAmD,EACnD,IAAO,EACP,WAAkD,EAClD,UAA6B,EAAE;QAE/B,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAC1B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,CAAC;IAEM,SAAS;QACd,OAAO,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC;IAC5B,CAAC;IAEM,KAAK,CAAC,GAAa;QACxB,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAc,CAAC;QACzC,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAoC,CAAC;QACtE,OAAO,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,GAAG,EAAE,CAAA;IACxC,CAAC;IAEM,MAAM,CAAC,GAAa;QACzB;;;;WAIG;QACH,IAAI,GAAG,GAAoC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;QAC7D,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,CAAoC,CAAC,CAAC;QAClF,OAAO,GAAqC,CAAC;IAC/C,CAAC;IAEM,YAAY,CAAC,GAAa;QAC/B,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,CAAoC,CAAC;IACzE,CAAC;IAES,UAAU,GAAG,KAAK,EAAE,GAAY,EAAE,GAAa,EAAE,EAAE;QAC3D,MAAM,CAAC,KAAK,CAAC,iBAAiB,EAC5B,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,CAAC;QACpF,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAmC,CAAC,CAAC;QAChF,IAAI,IAAI,GACN,UAAU,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,CAC9B,YAAY,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,SAAS,EAAE,CAAgC,CAAC;QAC3G,IAAI,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QACvC,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC,CAAC;IAEF,oBAAoB;IACV,SAAS,GAAG,KAAK,EAAE,GAAY,EAAE,GAAa,EAAE,EAAE;QAC1D,MAAM,CAAC,KAAK,CAAC,eAAe,EAAE,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;QAE5F,MAAM,KAAK,GAAgB,GAAG,CAAC,KAA+B,CAAC;QAC/D,MAAM,MAAM,GAAG,KAAK,CAAC,QAAQ,CAAW,CAAC;QACzC,MAAM,YAAY,GAAG,KAAK,CAAC,cAAc,CAAW,CAAC;QAErD,IAAI,KAAK,GAAkC,EAAE,CAAC;QAE9C,IAAI,MAAM,EAAG,CAAC;YACZ,wCAAwC;YACxC,KAAK,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC;QACxF,CAAC;aAAM,CAAC;YACN,2FAA2F;YAC3F,MAAM,SAAS,GAAc,aAAa,CAAC,GAAG,CAAC,KAAoB,CAAC,CAAC;YACrE,KAAK,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC;QAChE,CAAC;QAED,OAAO,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAiC,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC;IACxG,CAAC,CAAC;CAGH"}

package/dist/src/ItemRouter.d.ts

@@ -0,0 +1,45 @@
+import { ComKey, Item, ItemProperties, LocKey, LocKeyArray, PriKey } from "@fjell/core";
+import { Operations } from "@fjell/lib";
+import { Request, RequestHandler, Response, Router } from "express";
+export type ItemRouterOptions = Record<string, never>;
+export type ActionMethod = <S extends string, L1 extends string = never, L2 extends string = never, L3 extends string = never, L4 extends string = never, L5 extends string = never>(req: Request, res: Response, item: Item<S, L1, L2, L3, L4, L5>, params: any, body: any) => Promise<Item<S, L1, L2, L3, L4, L5>>;
+export type AllActionMethods = Array<RequestHandler>;
+export declare class ItemRouter<S extends string, L1 extends string = never, L2 extends string = never, L3 extends string = never, L4 extends string = never, L5 extends string = never> {
+    protected lib: Operations<Item<S, L1, L2, L3, L4, L5>, S, L1, L2, L3, L4, L5>;
+    private keyType;
+    protected options: ItemRouterOptions;
+    private childRouters;
+    private logger;
+    private itemActions;
+    constructor(lib: Operations<Item<S, L1, L2, L3, L4, L5>, S, L1, L2, L3, L4, L5>, keyType: S, options?: ItemRouterOptions);
+    getPkType: () => S;
+    protected getPkParam: () => string;
+    protected getLk(res: Response): LocKey<S>;
+    getLKA(res: Response): LocKeyArray<S, L1, L2, L3, L4>;
+    getPk(res: Response): PriKey<S>;
+    protected getLocations(res: Response): LocKeyArray<L1, L2, L3, L4, L5> | [];
+    protected getIk(res: Response): PriKey<S> | ComKey<S, L1, L2, L3, L4, L5>;
+    protected postItemAction: (req: Request, res: Response) => Promise<Response<any, Record<string, any>>>;
+    private configure;
+    private validatePrimaryKeyValue;
+    private configureChildRouters;
+    addChildRouter: (path: string, router: Router) => void;
+    protected configureItemActions(): Record<string, ActionMethod>;
+    protected configureAllActions(): Record<string, AllActionMethods>;
+    getRouter(): import("express-serve-static-core").Router;
+    protected createItem: (req: Request, res: Response) => Promise<Response<any, Record<string, any>>>;
+    postCreateItem: (item: Item<S, L1, L2, L3, L4, L5>) => Promise<Item<S, L1, L2, L3, L4, L5>>;
+    protected deleteItem: (req: Request, res: Response) => Promise<Response<any, Record<string, any>>>;
+    protected findItems: (req: Request, res: Response) => Promise<Response<any, Record<string, any>>>;
+    protected getItem: (req: Request, res: Response) => Promise<Response<any, Record<string, any>>>;
+    protected updateItem: (req: Request, res: Response) => Promise<Response<any, Record<string, any>>>;
+    convertDates: (item: Item<S, L1, L2, L3, L4, L5> | ItemProperties<S, L1, L2, L3, L4, L5>) => Item<S, L1, L2, L3, L4, L5> | ItemProperties<S, L1, L2, L3, L4, L5>;
+    /**
+     * 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.
+     */
+    protected validatePKParam: (pkParamValue: string) => boolean;
+}

package/dist/src/ItemRouter.js

@@ -0,0 +1,208 @@
+import { cPK, validatePK } from "@fjell/core";
+import deepmerge from "deepmerge";
+import { Router } from "express";
+import LibLogger from "./logger";
+export class ItemRouter {
+    lib;
+    keyType;
+    options;
+    childRouters = {};
+    logger;
+    itemActions;
+    constructor(lib, keyType, options = {}) {
+        this.lib = lib;
+        this.keyType = keyType;
+        this.options = options;
+        this.logger = LibLogger.get("ItemRouter", keyType);
+    }
+    getPkType = () => {
+        return this.keyType;
+    };
+    getPkParam = () => {
+        return `${this.getPkType()}Pk`;
+    };
+    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 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');
+    }
+    postItemAction = async (req, res) => {
+        this.logger.default('Getting Item', { query: req?.query, params: req?.params, locals: res?.locals });
+        const ik = this.getIk(res);
+        const actionKey = req.path.substring(req.path.lastIndexOf('/') + 1);
+        if (!this.itemActions) {
+            this.logger.error('Item Actions are not configured');
+            return res.status(500).json({ error: 'Item Actions are not configured' });
+        }
+        try {
+            const item = validatePK(await this.lib.get(ik), this.getPkType());
+            return res.json(await this.itemActions[actionKey](req, res, item, req.params, req.body));
+        }
+        catch (err) {
+            this.logger.error('Error in Item Action', { message: err?.message, stack: err?.stack });
+            return res.status(500).json(err);
+        }
+    };
+    configure = (router) => {
+        this.logger.default('Configuring Router', { pkType: this.getPkType() });
+        router.get('/', this.findItems);
+        router.post('/', this.createItem);
+        const allActions = this.configureAllActions();
+        this.logger.info('All Actions supplied to Router', { allActions });
+        if (allActions) {
+            Object.keys(allActions).forEach((actionKey) => {
+                this.logger.default('Configuring All Action', { actionKey });
+                // TODO: Ok, this is a bit of a hack, but we need to customize the types of the request handlers
+                router.post(`/${actionKey}`, ...allActions[actionKey]);
+            });
+        }
+        const itemRouter = Router();
+        itemRouter.get('/', this.getItem);
+        itemRouter.put('/', this.updateItem);
+        itemRouter.delete('/', this.deleteItem);
+        this.itemActions = this.configureItemActions();
+        this.logger.info('Item Actions supplied to Router', { itemActions: this.itemActions });
+        if (this.itemActions) {
+            Object.keys(this.itemActions).forEach((actionKey) => {
+                this.logger.default('Configuring Item Action', { 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('Configuring Item Operations under PK Param', { pkParam: this.getPkParam() });
+        router.use(`/:${this.getPkParam()}`, this.validatePrimaryKeyValue, itemRouter);
+        if (this.childRouters) {
+            this.configureChildRouters(itemRouter, this.childRouters);
+        }
+        return router;
+    };
+    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?.path });
+            res.status(500).json({ error: 'Invalid Primary Key', path: req?.path });
+        }
+    };
+    configureChildRouters = (router, childRouters) => {
+        for (const path in childRouters) {
+            this.logger.default('Configuring Child Router at Path', { path });
+            router.use(`/${path}`, childRouters[path]);
+        }
+        return router;
+    };
+    addChildRouter = (path, router) => {
+        this.childRouters[path] = router;
+    };
+    /* istanbul ignore next */
+    configureItemActions() {
+        this.logger.info('ARouter - No Item Actions Configured');
+        return {};
+    }
+    /* istanbul ignore next */
+    configureAllActions() {
+        this.logger.info('ARouter - No All Actions Configured');
+        return {};
+    }
+    /* istanbul ignore next */
+    getRouter() {
+        const router = Router();
+        this.configure(router);
+        return router;
+    }
+    /* istanbul ignore next */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    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 */
+    postCreateItem = async (item) => {
+        this.logger.default('Post Create Item', { item });
+        return item;
+    };
+    deleteItem = async (req, res) => {
+        this.logger.default('Deleting Item', { query: req.query, params: req.params, locals: res.locals });
+        const ik = this.getIk(res);
+        const removedItem = await this.lib.remove(ik);
+        const item = validatePK(removedItem, this.getPkType());
+        return res.json(item);
+    };
+    /* eslint-disable */
+    /* istanbul ignore next */
+    findItems = async (req, res) => {
+        throw new Error('Method not implemented in an abstract router');
+    };
+    /* eslint-enable */
+    getItem = async (req, res) => {
+        this.logger.default('Getting Item', { query: req.query, params: req.params, locals: res.locals });
+        const ik = this.getIk(res);
+        try {
+            const item = validatePK(await this.lib.get(ik), this.getPkType());
+            return res.json(item);
+        }
+        catch (err) {
+            this.logger.error('Error in Get Item Returning 404', { message: err?.message, stack: err?.stack });
+            return res.status(404).json(err);
+        }
+    };
+    updateItem = async (req, res) => {
+        this.logger.default('Updating Item', { body: req?.body, query: req?.query, params: req?.params, locals: res?.locals });
+        const ik = this.getIk(res);
+        const itemToUpdate = this.convertDates(req.body);
+        const retItem = validatePK(await this.lib.update(ik, itemToUpdate), this.getPkType());
+        return res.json(retItem);
+    };
+    convertDates = (item) => {
+        const events = item.events;
+        this.logger.default('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.
+     */
+    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;
+    };
+}
+//# sourceMappingURL=ItemRouter.js.map

package/dist/src/ItemRouter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ItemRouter.js","sourceRoot":"","sources":["../../src/ItemRouter.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,GAAG,EAOH,UAAU,EACX,MAAM,aAAa,CAAC;AAErB,OAAO,SAAS,MAAM,WAAW,CAAC;AAClC,OAAO,EAAqC,MAAM,EAAE,MAAM,SAAS,CAAC;AACpE,OAAO,SAAS,MAAM,UAAU,CAAC;AAkBjC,MAAM,OAAO,UAAU;IASX,GAAG,CAAiE;IACtE,OAAO,CAAI;IACT,OAAO,CAAoB;IAC7B,YAAY,GAA2B,EAAE,CAAC;IAC1C,MAAM,CAAC;IACP,WAAW,CAA2C;IAE9D,YACE,GAAmE,EACnE,OAAU,EACV,UAA6B,EAAE;QAE/B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC,GAAG,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAEM,SAAS,GAAG,GAAM,EAAE;QACzB,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC,CAAA;IAES,UAAU,GAAG,GAAW,EAAE;QAClC,OAAO,GAAG,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC;IACjC,CAAC,CAAA;IAES,KAAK,CAAC,GAAa;QAC3B,OAAO,EAAE,EAAE,EAAE,IAAI,CAAC,OAAO,EAAE,EAAE,EAAE,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,EAAE,CAAC;IACjE,CAAC;IAED,mDAAmD;IAC5C,MAAM,CAAC,GAAa;QACzB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAmC,CAAC;IAC7D,CAAC;IAEM,KAAK,CAAC,GAAa;QACxB,OAAO,GAAG,CAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;IACjE,CAAC;IAED,kFAAkF;IAClF,oBAAoB;IACV,YAAY,CAAC,GAAa;QAClC,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;IAClE,CAAC;IACD,mBAAmB;IAEnB,6DAA6D;IACnD,KAAK,CAAC,GAAa;QAC3B,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;IAClE,CAAC;IAES,cAAc,GAAG,KAAK,EAAE,GAAY,EAAE,GAAa,EAAE,EAAE;QAC/D,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,CAAC;QACrG,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC3B,MAAM,SAAS,GAAG,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;QACpE,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YACtB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,iCAAiC,CAAC,CAAC;YACrD,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,iCAAiC,EAAE,CAAC,CAAC;QAC5E,CAAC;QACD,IAAI,CAAC;YACH,MAAM,IAAI,GACN,UAAU,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,SAAS,EAAE,CAAgC,CAAC;YACxF,OAAO,GAAG,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;QAC3F,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,sBAAsB,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC;YACxF,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnC,CAAC;IACH,CAAC,CAAA;IAEO,SAAS,GAAG,CAAC,MAAc,EAAE,EAAE;QACrC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,oBAAoB,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QACxE,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAChC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAElC,MAAM,UAAU,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC9C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gCAAgC,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC;QACnE,IAAI,UAAU,EAAE,CAAC;YACf,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;gBAC5C,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,wBAAwB,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;gBAC7D,gGAAgG;gBAChG,MAAM,CAAC,IAAI,CAAC,IAAI,SAAS,EAAE,EAAE,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;YACzD,CAAC,CAAC,CAAC;QACL,CAAC;QAED,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC;QAC5B,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAClC,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACrC,UAAU,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAExC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC/C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,iCAAiC,EAAE,EAAE,WAAW,EAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;QACtF,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;gBAClD,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,yBAAyB,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;gBAC9D,gGAAgG;gBAChG,UAAU,CAAC,IAAI,CAAC,IAAI,SAAS,EAAE,EAAE,IAAI,CAAC,cAAc,CAAC,CAAA;YACvD,CAAC,CAAC,CAAC;QACL,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,4CAA4C,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;QAClG,MAAM,CAAC,GAAG,CAAC,KAAK,IAAI,CAAC,UAAU,EAAE,EAAE,EAAE,IAAI,CAAC,uBAAuB,EAAE,UAAU,CAAC,CAAC;QAE/E,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtB,IAAI,CAAC,qBAAqB,CAAC,UAAU,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QAC5D,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC,CAAA;IAEO,uBAAuB,GAAG,CAAC,GAAY,EAAE,GAAa,EAAE,IAAS,EAAE,EAAE;QAC3E,MAAM,YAAY,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;QACnD,IAAI,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,EAAE,CAAC;YACvC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,GAAG,YAAY,CAAC;YAC7C,IAAI,EAAE,CAAC;QACT,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;YAC5E,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,qBAAqB,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;QAC1E,CAAC;IACH,CAAC,CAAA;IAEO,qBAAqB,GAAG,CAAC,MAAc,EAAE,YAAoC,EAAE,EAAE;QACvF,KAAK,MAAM,IAAI,IAAI,YAAY,EAAE,CAAC;YAChC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,kCAAkC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;YAElE,MAAM,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC;QAC7C,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC,CAAA;IAEM,cAAc,GAAG,CAAC,IAAY,EAAE,MAAc,EAAE,EAAE;QACvD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC;IACnC,CAAC,CAAA;IAED,0BAA0B;IAChB,oBAAoB;QAC5B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,sCAAsC,CAAC,CAAC;QACzD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,0BAA0B;IAChB,mBAAmB;QAC3B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,qCAAqC,CAAC,CAAC;QACxD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,0BAA0B;IACnB,SAAS;QACd,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC;QACxB,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QACvB,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,0BAA0B;IAC1B,6DAA6D;IACnD,UAAU,GAAG,KAAK,EAAE,GAAY,EAAE,GAAa,EAA+C,EAAE;QACxG,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;IAClE,CAAC,CAAC;IAEF,wFAAwF;IACxF,0BAA0B;IACnB,cAAc,GAAG,KAAK,EAAE,IAAiC,EAAwC,EAAE;QACxG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;QAClD,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IAEQ,UAAU,GAAG,KAAK,EAAE,GAAY,EAAE,GAAa,EAA+C,EAAE;QACxG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;QACnG,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC3B,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAC9C,MAAM,IAAI,GAAG,UAAU,CAAC,WAAW,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;QACvD,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC,CAAC;IAEF,oBAAoB;IACpB,0BAA0B;IAChB,SAAS,GAAG,KAAK,EAAE,GAAY,EAAE,GAAa,EAA+C,EAAE;QACvG,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;IAClE,CAAC,CAAC;IACF,mBAAmB;IAET,OAAO,GAAG,KAAK,EAAE,GAAY,EAAE,GAAa,EAAE,EAAE;QACxD,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;QAClG,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC3B,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,UAAU,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;YAClE,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxB,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,iCAAiC,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC;YACnG,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnC,CAAC;IACH,CAAC,CAAA;IAES,UAAU,GAAG,KAAK,EAAE,GAAY,EAAE,GAAa,EAAE,EAAE;QAC3D,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,eAAe,EACjC,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,CAAC;QACpF,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC3B,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAA6C,CAAC,CAAC;QAC1F,MAAM,OAAO,GAAG,UAAU,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,YAAY,CAAC,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;QACtF,OAAO,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC3B,CAAC,CAAC;IAEK,YAAY,GAAG,CAAC,IAAyE,EAC1B,EAAE;QACtE,MAAM,MAAM,GAAG,IAAI,CAAC,MAAmC,CAAC;QACxD,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;QAClD,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,GAAW,EAAE,EAAE;gBAC1C,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE;oBACpB,CAAC,GAAG,CAAC,EAAE,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;iBACxF,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC;QACD,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IAEF,wEAAwE;IACxE;;;;;;OAMG;IACO,eAAe,GAAG,CAAC,YAAoB,EAAW,EAAE;QAC5D,IAAI,YAAY,GAAG,IAAI,CAAC;QACxB,IAAI,YAAY,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;YAC7B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,gCAAgC,EAAE,EAAE,YAAY,EAAE,CAAC,CAAC;YACtE,YAAY,GAAG,KAAK,CAAC;QACvB,CAAC;aAAM,IAAI,YAAY,KAAK,WAAW,EAAE,CAAC;YACxC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,yCAAyC,EAAE,EAAE,YAAY,EAAE,CAAC,CAAC;YAC/E,YAAY,GAAG,KAAK,CAAC;QACvB,CAAC;QACD,OAAO,YAAY,CAAC;IACtB,CAAC,CAAA;CAEF"}

package/dist/src/PItemRouter.d.ts

@@ -0,0 +1,10 @@
+import { Item, PriKey } from "@fjell/core";
+import { Primary } from "@fjell/lib";
+import { ItemRouter, ItemRouterOptions } from "./ItemRouter";
+import { Request, Response } from "express";
+export declare class PItemRouter<T extends Item<S>, S extends string> extends ItemRouter<S> {
+    constructor(lib: Primary.Operations<T, S>, keyType: S, options?: ItemRouterOptions);
+    getIk(res: Response): PriKey<S>;
+    createItem: (req: Request, res: Response) => Promise<Response<any, Record<string, any>>>;
+    protected findItems: (req: Request, res: Response) => Promise<Response<any, Record<string, any>>>;
+}

package/dist/src/PItemRouter.js

@@ -0,0 +1,41 @@
+import { paramsToQuery, validatePK } from "@fjell/core";
+import { ItemRouter } from "./ItemRouter";
+import LibLogger from "./logger";
+const logger = LibLogger.get('PItemRouter');
+export class PItemRouter extends ItemRouter {
+    constructor(lib, keyType, options = {}) {
+        super(lib, keyType, options);
+    }
+    getIk(res) {
+        const pri = this.getPk(res);
+        return pri;
+    }
+    createItem = async (req, res) => {
+        logger.default('Creating Item 2', { body: req.body, query: req.query, params: req.params, locals: res.locals });
+        const itemToCreate = this.convertDates(req.body);
+        let item = validatePK(await this.lib.create(itemToCreate), this.getPkType());
+        item = await this.postCreateItem(item);
+        return res.json(item);
+    };
+    /* eslint-disable */
+    findItems = async (req, res) => {
+        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'];
+        if (finder) {
+            // If finder is defined?  Call a finder.
+            logger.default('Finding Items with a finder', { finder, finderParams });
+            items = await this.lib.find(finder, JSON.parse(finderParams));
+        }
+        else {
+            logger.default('Finding Items with a query', { query: req.query });
+            // TODO: This is once of the more important places to perform some validaation and feedback
+            const itemQuery = paramsToQuery(req.query);
+            items = await this.lib.all(itemQuery);
+        }
+        return res.json(items.map((item) => validatePK(item, this.getPkType())));
+    };
+}
+//# sourceMappingURL=PItemRouter.js.map

package/dist/src/PItemRouter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PItemRouter.js","sourceRoot":"","sources":["../../src/PItemRouter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,aAAa,EAAuB,UAAU,EAAE,MAAM,aAAa,CAAC;AAE9F,OAAO,EAAE,UAAU,EAAqB,MAAM,cAAc,CAAC;AAE7D,OAAO,SAAS,MAAM,UAAU,CAAC;AAEjC,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;AAM5C,MAAM,OAAO,WAAiD,SAAQ,UAAa;IAEjF,YAAY,GAA6B,EAAE,OAAU,EAAE,UAA6B,EAAE;QACpF,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC/B,CAAC;IAEM,KAAK,CAAC,GAAa;QACxB,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAc,CAAC;QACzC,OAAO,GAAG,CAAA;IACZ,CAAC;IAEM,UAAU,GAAG,KAAK,EAAE,GAAY,EAAE,GAAa,EAAE,EAAE;QACxD,MAAM,CAAC,OAAO,CAAC,iBAAiB,EAAE,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;QAChH,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAe,CAAC,CAAC;QAC5D,IAAI,IAAI,GACN,UAAU,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC,SAAS,EAAE,CAAY,CAAC;QAC/E,IAAI,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QACvC,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC,CAAC;IAEF,oBAAoB;IACV,SAAS,GAAG,KAAK,EAAE,GAAY,EAAE,GAAa,EAAE,EAAE;QAC1D,MAAM,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;QAE9F,IAAI,KAAK,GAAc,EAAE,CAAC;QAE1B,MAAM,KAAK,GAAgB,GAAG,CAAC,KAA+B,CAAC;QAC/D,MAAM,MAAM,GAAG,KAAK,CAAC,QAAQ,CAAW,CAAC;QACzC,MAAM,YAAY,GAAG,KAAK,CAAC,cAAc,CAAW,CAAC;QAErD,IAAI,MAAM,EAAG,CAAC;YACZ,wCAAwC;YACxC,MAAM,CAAC,OAAO,CAAC,6BAA6B,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAAC;YACxE,KAAK,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;QAChE,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,OAAO,CAAC,4BAA4B,EAAE,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC;YACnE,2FAA2F;YAC3F,MAAM,SAAS,GAAc,aAAa,CAAC,GAAG,CAAC,KAAoB,CAAC,CAAC;YACrE,KAAK,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACxC,CAAC;QAED,OAAO,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAa,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC;IACpF,CAAC,CAAC;CAEH"}

package/dist/src/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./ItemRouter";
+export * from "./CItemRouter";
+export * from "./PItemRouter";

package/dist/src/index.js

@@ -0,0 +1,4 @@
+export * from "./ItemRouter";
+export * from "./CItemRouter";
+export * from "./PItemRouter";
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC"}

package/dist/src/logger.d.ts

@@ -0,0 +1,2 @@
+declare const LibLogger: import("@fjell/logging").Logger;
+export default LibLogger;

package/dist/src/logger.js

@@ -0,0 +1,4 @@
+import Logging from '@fjell/logging';
+const LibLogger = Logging.getLogger('@fjellproject/express-router');
+export default LibLogger;
+//# sourceMappingURL=logger.js.map

package/dist/src/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/logger.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,gBAAgB,CAAC;AAErC,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,8BAA8B,CAAC,CAAC;AAEpE,eAAe,SAAS,CAAC"}

package/eslint.config.mjs

@@ -0,0 +1,70 @@
+import typescriptEslint from "@typescript-eslint/eslint-plugin";
+import tsParser from "@typescript-eslint/parser";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import js from "@eslint/js";
+import { FlatCompat } from "@eslint/eslintrc";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+  recommendedConfig: js.configs.recommended,
+  allConfig: js.configs.all
+});
+
+export default [{
+  ignores: ["**/dist", "**/node_modules"],
+}, ...compat.extends("plugin:@typescript-eslint/recommended"), {
+  plugins: {
+    "@typescript-eslint": typescriptEslint,
+  },
+
+  languageOptions: {
+    parser: tsParser,
+  },
+
+  rules: {
+    "@typescript-eslint/no-unused-expressions": "off",
+    "no-console": 0,
+    "no-unused-vars": "off",
+
+    "max-len": ["error", {
+      code: 120,
+    }],
+
+    "max-depth": ["error", 4],
+    "max-params": ["error", 4],
+    "max-lines": ["error", 500],
+
+    "no-multiple-empty-lines": ["error", {
+      max: 1,
+      maxEOF: 1,
+    }],
+
+    "no-trailing-spaces": ["error", {
+      skipBlankLines: true,
+    }],
+
+    indent: ["error", 2, {
+      SwitchCase: 1,
+    }],
+
+    "sort-imports": ["error", {
+      ignoreCase: true,
+      ignoreDeclarationSort: true,
+      ignoreMemberSort: false,
+      memberSyntaxSortOrder: ["none", "all", "multiple", "single"],
+    }],
+
+    "no-var": "error",
+    "no-undefined": "error",
+    "@typescript-eslint/no-unused-vars": "error",
+    "@typescript-eslint/ban-ts-comment": "off",
+    "@typescript-eslint/no-explicit-any": "off",
+
+    "no-restricted-imports": ["error", {
+      patterns: ["..*", "src/*"],
+    }],
+  },
+}];

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@fjell/express-router",
+  "version": "4.3.1",
+  "license": "UNLICENSED",
+  "description": "Express Router for Fjell",
+  "engines": {
+    "node": ">=21"
+  },
+  "main": "dist/src/index.js",
+  "exports": {
+    ".": {
+      "require": "./dist/src/index.js",
+      "import": "./dist/src/index.js",
+      "types": "./dist/src/index.d.ts"
+    }
+  },
+  "type": "module",
+  "scripts": {
+    "build": "yarn run lint && tsc && tsc-alias -p tsconfig.json",
+    "dev": "concurrently \"tsc -w\" \"tsc-alias -w\"",
+    "lint": "eslint .",
+    "clean": "rimraf dist",
+    "test": "yarn run lint && NODE_OPTIONS='--experimental-require-module' yarn run jest --coverage"
+  },
+  "dependencies": {
+    "@fjell/lib": "^4.3.0",
+    "@fjell/logging": "^4.3.4",
+    "@google-cloud/firestore": "^7.5.0",
+    "cors": "^2.8.5",
+    "dayjs": "^1.11.13",
+    "deepmerge": "^4.3.1",
+    "dotenv": "^16.4.7",
+    "express": "^4.18.2",
+    "multer": "^1.4.5-lts.1",
+    "nodemailer": "^6.10.0",
+    "response-time": "^2.3.3",
+    "specifier-resolution-node": "^1.1.4",
+    "supertest": "^7.0.0",
+    "winston": "^3.17.0"
+  },
+  "devDependencies": {
+    "@babel/preset-env": "^7.26.9",
+    "@babel/preset-react": "^7.26.3",
+    "@babel/preset-typescript": "^7.26.0",
+    "@tsconfig/recommended": "^1.0.8",
+    "@types/cors": "^2.8.17",
+    "@types/express": "^4.17.21",
+    "@types/jest": "^29.5.14",
+    "@types/multer": "^1.4.11",
+    "@types/node": "^20.10.4",
+    "@types/nodemailer": "^6.4.14",
+    "@types/react": "^18.3.1",
+    "@types/response-time": "^2.3.8",
+    "@typescript-eslint/eslint-plugin": "^8.24.1",
+    "@typescript-eslint/parser": "^8.24.1",
+    "concurrently": "^9.1.2",
+    "eslint": "^9.21.0",
+    "jest": "^29.7.0",
+    "nodemon": "^3.1.9",
+    "rimraf": "^6.0.1",
+    "ts-jest": "^29.2.5",
+    "ts-node": "^10.9.2",
+    "tsc-alias": "^1.8.10",
+    "typescript": "^5.7.3"
+  },
+  "packageManager": "yarn@4.6.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/getfjell/express-router.git"
+  }
+}

package/src/CItemRouter.ts

@@ -0,0 +1,95 @@
+import {
+  ComKey, Item, ItemQuery, LocKey, LocKeyArray, paramsToQuery, PriKey, QueryParams, validatePK
+} from "@fjell/core";
+import { Request, Response } from "express";
+import { ItemRouter, ItemRouterOptions } from "@/ItemRouter";
+import LibLogger from "@/logger";
+import { Contained } from "@fjell/lib";
+
+const logger = LibLogger.get('CItemRouter');
+interface ParsedQuery {
+  [key: string]: undefined | string | string[] | ParsedQuery | ParsedQuery[];
+}
+
+export class CItemRouter<
+  T extends Item<S, L1, L2, L3, L4, L5>,
+  S extends string,
+  L1 extends string,
+  L2 extends string = never,
+  L3 extends string = never,
+  L4 extends string = never,
+  L5 extends string = never
+> extends ItemRouter<S, L1, L2, L3, L4, L5> {
+
+  private parentRoute: ItemRouter<L1, L2, L3, L4, L5, never>;
+
+  constructor(
+    lib: Contained.Operations<T, S, L1, L2, L3, L4, L5>,
+    type: S,
+    parentRoute: ItemRouter<L1, L2, L3, L4, L5, never>,
+    options: ItemRouterOptions = {},
+  ) {
+    super(lib, type, options);
+    this.parentRoute = parentRoute;
+  }
+
+  public hasParent(): boolean {
+    return !!this.parentRoute;
+  }
+
+  public getIk(res: Response): ComKey<S, L1, L2, L3, L4, L5> {
+    const pri = this.getPk(res) as PriKey<S>;
+    const loc = this.getLocations(res) as LocKeyArray<L1, L2, L3, L4, L5>;
+    return { kt: pri.kt, pk: pri.pk, loc }
+  }
+
+  public getLKA(res: Response): LocKeyArray<S, L1, L2, L3, L4> {
+    /**
+     * 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: LocKey<S | L1 | L2 | L3 | L4>[] = [this.getLk(res)];
+    lka = lka.concat(this.parentRoute.getLKA(res) as LocKey<S | L1 | L2 | L3 | L4>[]);
+    return lka as LocKeyArray<S, L1, L2, L3, L4>;
+  }
+
+  public getLocations(res: Response): LocKeyArray<L1, L2, L3, L4, L5> {
+    return this.parentRoute.getLKA(res) as LocKeyArray<L1, L2, L3, L4, L5>;
+  }
+
+  protected createItem = async (req: Request, res: Response) => {
+    logger.trace('Creating Item 2',
+      { body: req?.body, query: req?.query, params: req?.params, locals: res?.locals });
+    const itemToCreate = this.convertDates(req.body as Item<S, L1, L2, L3, L4, L5>);
+    let item =
+      validatePK(await this.lib.create(
+        itemToCreate, { locations: this.getLocations(res) }), this.getPkType()) as Item<S, L1, L2, L3, L4, L5>;
+    item = await this.postCreateItem(item);
+    return res.json(item);
+  };
+
+  /* eslint-disable */
+  protected findItems = async (req: Request, res: Response) => {
+    logger.trace('Finding Items', { query: req.query, params: req.params, locals: res.locals });
+
+    const query: ParsedQuery = req.query as unknown as ParsedQuery;
+    const finder = query['finder'] as string;
+    const finderParams = query['finderParams'] as string;
+
+    let items: Item<S, L1, L2, L3, L4, L5>[] = [];
+
+    if( finder ) { 
+      // If finder is defined?  Call a finder.
+      items = await this.lib.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: ItemQuery = paramsToQuery(req.query as QueryParams);
+      items = await this.lib.all(itemQuery, this.getLocations(res));
+    }
+
+    return res.json(items.map((item: Item<S, L1, L2, L3, L4, L5>) => validatePK(item, this.getPkType())));
+  };
+  /* eslint-enable */
+
+}

package/src/ItemRouter.ts

@@ -0,0 +1,277 @@
+import {
+  ComKey,
+  cPK,
+  Item,
+  ItemEvent,
+  ItemProperties,
+  LocKey,
+  LocKeyArray,
+  PriKey,
+  validatePK
+} from "@fjell/core";
+import { Operations } from "@fjell/lib";
+import deepmerge from "deepmerge";
+import { Request, RequestHandler, Response, Router } from "express";
+import LibLogger from "./logger";
+
+export type ItemRouterOptions = Record<string, never>;
+
+// TODO: body is in the request, it's not needed in the parameters
+export type ActionMethod = <
+  S extends string,
+  L1 extends string = never,
+  L2 extends string = never,
+  L3 extends string = never,
+  L4 extends string = never,
+  L5 extends string = never
+>(req: Request, res: Response, item: Item<S, L1, L2, L3, L4, L5>, params: any, body: any) =>
+  Promise<Item<S, L1, L2, L3, L4, L5>>;
+
+// TODO: body is in the request, it's not needed in the parameters
+export type AllActionMethods = Array<RequestHandler>;
+
+export class ItemRouter<
+  S extends string,
+  L1 extends string = never,
+  L2 extends string = never,
+  L3 extends string = never,
+  L4 extends string = never,
+  L5 extends string = never
+> {
+
+  protected lib: Operations<Item<S, L1, L2, L3, L4, L5>, S, L1, L2, L3, L4, L5>;
+  private keyType: S;
+  protected options: ItemRouterOptions;
+  private childRouters: Record<string, Router> = {};
+  private logger;
+  private itemActions: Record<string, ActionMethod> | undefined;
+
+  constructor(
+    lib: Operations<Item<S, L1, L2, L3, L4, L5>, S, L1, L2, L3, L4, L5>,
+    keyType: S,
+    options: ItemRouterOptions = {}
+  ) {
+    this.lib = lib;
+    this.keyType = keyType;
+    this.options = options;
+    this.logger = LibLogger.get("ItemRouter", keyType);
+  }
+
+  public getPkType = (): S => {
+    return this.keyType;
+  }
+
+  protected getPkParam = (): string => {
+    return `${this.getPkType()}Pk`;
+  }
+
+  protected getLk(res: Response): LocKey<S> {
+    return { kt: this.keyType, lk: res.locals[this.getPkParam()] };
+  }
+
+  // this is meant to be consumed by children routers
+  public getLKA(res: Response): LocKeyArray<S, L1, L2, L3, L4> {
+    return [this.getLk(res)] as LocKeyArray<S, L1, L2, L3, L4>;
+  }
+
+  public getPk(res: Response): PriKey<S> {
+    return cPK<S>(res.locals[this.getPkParam()], this.getPkType());
+  }
+
+  // Unless this is a contained router, the locations will always be an empty array.
+  /* eslint-disable */
+  protected getLocations(res: Response): LocKeyArray<L1, L2, L3, L4, L5> | [] {
+    throw new Error('Method not implemented in an abstract router');
+  }
+  /* eslint-enable */
+
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  protected getIk(res: Response): PriKey<S> | ComKey<S, L1, L2, L3, L4, L5> {
+    throw new Error('Method not implemented in an abstract router');
+  }
+
+  protected postItemAction = async (req: Request, res: Response) => {
+    this.logger.default('Getting Item', { query: req?.query, params: req?.params, locals: res?.locals });
+    const ik = this.getIk(res);
+    const actionKey = req.path.substring(req.path.lastIndexOf('/') + 1);
+    if (!this.itemActions) {
+      this.logger.error('Item Actions are not configured');
+      return res.status(500).json({ error: 'Item Actions are not configured' });
+    }
+    try {
+      const item =
+          validatePK(await this.lib.get(ik), this.getPkType()) as Item<S, L1, L2, L3, L4, L5>;
+      return res.json(await this.itemActions[actionKey](req, res, item, req.params, req.body));
+    } catch (err: any) {
+      this.logger.error('Error in Item Action', { message: err?.message, stack: err?.stack });
+      return res.status(500).json(err);
+    }
+  }
+
+  private configure = (router: Router) => {
+    this.logger.default('Configuring Router', { pkType: this.getPkType() });
+    router.get('/', this.findItems);
+    router.post('/', this.createItem);
+
+    const allActions = this.configureAllActions();
+    this.logger.info('All Actions supplied to Router', { allActions });
+    if (allActions) {
+      Object.keys(allActions).forEach((actionKey) => {
+        this.logger.default('Configuring All Action', { actionKey });
+        // TODO: Ok, this is a bit of a hack, but we need to customize the types of the request handlers
+        router.post(`/${actionKey}`, ...allActions[actionKey]);
+      });
+    }
+
+    const itemRouter = Router();
+    itemRouter.get('/', this.getItem);
+    itemRouter.put('/', this.updateItem);
+    itemRouter.delete('/', this.deleteItem);
+
+    this.itemActions = this.configureItemActions();
+    this.logger.info('Item Actions supplied to Router', { itemActions:this.itemActions });
+    if (this.itemActions) {
+      Object.keys(this.itemActions).forEach((actionKey) => {
+        this.logger.default('Configuring Item Action', { 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('Configuring Item Operations under PK Param', { pkParam: this.getPkParam() });
+    router.use(`/:${this.getPkParam()}`, this.validatePrimaryKeyValue, itemRouter);
+
+    if (this.childRouters) {
+      this.configureChildRouters(itemRouter, this.childRouters);
+    }
+    return router;
+  }
+
+  private validatePrimaryKeyValue = (req: Request, res: Response, next: any) => {
+    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?.path });
+      res.status(500).json({ error: 'Invalid Primary Key', path: req?.path });
+    }
+  }
+
+  private configureChildRouters = (router: Router, childRouters: Record<string, Router>) => {
+    for (const path in childRouters) {
+      this.logger.default('Configuring Child Router at Path', { path });
+
+      router.use(`/${path}`, childRouters[path]);
+    }
+    return router;
+  }
+
+  public addChildRouter = (path: string, router: Router) => {
+    this.childRouters[path] = router;
+  }
+
+  /* istanbul ignore next */
+  protected configureItemActions(): Record<string, ActionMethod> {
+    this.logger.info('ARouter - No Item Actions Configured');
+    return {};
+  }
+
+  /* istanbul ignore next */
+  protected configureAllActions(): Record<string, AllActionMethods> {
+    this.logger.info('ARouter - No All Actions Configured');
+    return {};
+  }
+
+  /* istanbul ignore next */
+  public getRouter() {
+    const router = Router();
+    this.configure(router);
+    return router;
+  }
+
+  /* istanbul ignore next */
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  protected createItem = async (req: Request, res: Response): Promise<Response<any, Record<string, any>>> => {
+    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 */
+  public postCreateItem = async (item: Item<S, L1, L2, L3, L4, L5>): Promise<Item<S, L1, L2, L3, L4, L5>> => {
+    this.logger.default('Post Create Item', { item });
+    return item;
+  };
+
+  protected deleteItem = async (req: Request, res: Response): Promise<Response<any, Record<string, any>>> => {
+    this.logger.default('Deleting Item', { query: req.query, params: req.params, locals: res.locals });
+    const ik = this.getIk(res);
+    const removedItem = await this.lib.remove(ik);
+    const item = validatePK(removedItem, this.getPkType());
+    return res.json(item);
+  };
+
+  /* eslint-disable */
+  /* istanbul ignore next */
+  protected findItems = async (req: Request, res: Response): Promise<Response<any, Record<string, any>>> => {
+    throw new Error('Method not implemented in an abstract router');
+  };
+  /* eslint-enable */
+
+  protected getItem = async (req: Request, res: Response) => {
+    this.logger.default('Getting Item', { query: req.query, params: req.params, locals: res.locals });
+    const ik = this.getIk(res);
+    try {
+      const item = validatePK(await this.lib.get(ik), this.getPkType());
+      return res.json(item);
+    } catch (err: any) {
+      this.logger.error('Error in Get Item Returning 404', { message: err?.message, stack: err?.stack });
+      return res.status(404).json(err);
+    }
+  }
+
+  protected updateItem = async (req: Request, res: Response) => {
+    this.logger.default('Updating Item',
+      { body: req?.body, query: req?.query, params: req?.params, locals: res?.locals });
+    const ik = this.getIk(res);
+    const itemToUpdate = this.convertDates(req.body as ItemProperties<S, L1, L2, L3, L4, L5>);
+    const retItem = validatePK(await this.lib.update(ik, itemToUpdate), this.getPkType());
+    return res.json(retItem);
+  };
+
+  public convertDates = (item: Item<S, L1, L2, L3, L4, L5> | ItemProperties<S, L1, L2, L3, L4, L5>):
+    Item<S, L1, L2, L3, L4, L5> | ItemProperties<S, L1, L2, L3, L4, L5> => {
+    const events = item.events as Record<string, ItemEvent>;
+    this.logger.default('Converting Dates', { item });
+    if (events) {
+      Object.keys(events).forEach((key: string) => {
+        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.
+   */
+  protected validatePKParam = (pkParamValue: string): boolean => {
+    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;
+  }
+
+}

package/src/PItemRouter.ts

@@ -0,0 +1,57 @@
+import { Item, ItemQuery, paramsToQuery, PriKey, QueryParams, validatePK } from "@fjell/core";
+import { Primary } from "@fjell/lib";
+import { ItemRouter, ItemRouterOptions } from "@/ItemRouter";
+import { Request, Response } from "express";
+import LibLogger from "@/logger";
+
+const logger = LibLogger.get('PItemRouter');
+
+interface ParsedQuery {
+  [key: string]: undefined | string | string[] | ParsedQuery | ParsedQuery[];
+}
+
+export class PItemRouter<T extends Item<S>, S extends string> extends ItemRouter<S> {
+
+  constructor(lib: Primary.Operations<T, S>, keyType: S, options: ItemRouterOptions = {}) {
+    super(lib, keyType, options);
+  }
+
+  public getIk(res: Response): PriKey<S> {
+    const pri = this.getPk(res) as PriKey<S>;
+    return pri
+  }
+
+  public createItem = async (req: Request, res: Response) => {
+    logger.default('Creating Item 2', { body: req.body, query: req.query, params: req.params, locals: res.locals });
+    const itemToCreate = this.convertDates(req.body as Item<S>);
+    let item =
+      validatePK(await this.lib.create(itemToCreate), this.getPkType()) as Item<S>;
+    item = await this.postCreateItem(item);
+    return res.json(item);
+  };
+
+  /* eslint-disable */
+  protected findItems = async (req: Request, res: Response) => {
+    logger.default('Finding Items', { query: req.query, params: req.params, locals: res.locals });
+
+    let items: Item<S>[] = [];
+
+    const query: ParsedQuery = req.query as unknown as ParsedQuery;
+    const finder = query['finder'] as string;
+    const finderParams = query['finderParams'] as string;
+
+    if( finder ) { 
+      // If finder is defined?  Call a finder.
+      logger.default('Finding Items with a finder', { finder, finderParams });
+      items = await this.lib.find(finder, JSON.parse(finderParams));
+    } else {
+      logger.default('Finding Items with a query', { query: req.query });
+      // TODO: This is once of the more important places to perform some validaation and feedback
+      const itemQuery: ItemQuery = paramsToQuery(req.query as QueryParams);
+      items = await this.lib.all(itemQuery);
+    }
+
+    return res.json(items.map((item: Item<S>) => validatePK(item, this.getPkType())));
+  };
+  /* eslint-enable */
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from "./ItemRouter";
+export * from "./CItemRouter";
+export * from "./PItemRouter";

package/src/logger.ts

@@ -0,0 +1,5 @@
+import Logging from '@fjell/logging';
+
+const LibLogger = Logging.getLogger('@fjellproject/express-router');
+
+export default LibLogger;