@fjell/express-router 4.4.0 → 4.4.2

package/package.json

@@ -1,71 +1,48 @@
 {
   "name": "@fjell/express-router",
-  "version": "4.4.0",
+  "version": "4.4.2",
   "license": "Apache-2.0",
   "description": "Express Router for Fjell",
   "engines": {
     "node": ">=21"
   },
-  "main": "dist/index.js",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "require": "./dist/index.js",
-      "import": "./dist/index.js"
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
     }
   },
   "type": "module",
   "dependencies": {
-    "@fjell/core": "^4.4",
-    "@fjell/lib": "^4.4",
-    "@fjell/logging": "^4.4",
-    "@google-cloud/firestore": "^7.11.0",
-    "cors": "^2.8.5",
-    "dayjs": "^1.11.13",
+    "@fjell/core": "^4.4.3",
+    "@fjell/lib": "^4.4.2",
+    "@fjell/logging": "^4.4.3",
     "deepmerge": "^4.3.1",
-    "dotenv": "^16.4.7",
-    "express": "^4.21.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"
+    "express": "^5.1.0"
   },
   "devDependencies": {
-    "@babel/preset-env": "^7.26.9",
-    "@babel/preset-react": "^7.26.3",
-    "@babel/preset-typescript": "^7.26.0",
     "@eslint/eslintrc": "^3.3.1",
-    "@eslint/js": "^9.27.0",
-    "@jest/globals": "^29.7.0",
-    "@swc/core": "^1.11.24",
-    "@tsconfig/recommended": "^1.0.8",
-    "@types/cors": "^2.8.17",
-    "@types/express": "^4.17.21",
-    "@types/jest": "^29.5.14",
-    "@types/multer": "^1.4.12",
-    "@types/node": "^20.17.19",
-    "@types/nodemailer": "^6.4.17",
-    "@types/react": "^18.3.18",
-    "@types/response-time": "^2.3.8",
-    "@typescript-eslint/eslint-plugin": "^8.24.1",
-    "@typescript-eslint/parser": "^8.24.1",
-    "@vitest/coverage-v8": "^3.1.4",
-    "@vitest/ui": "^3.1.4",
-    "concurrently": "^9.1.2",
-    "eslint": "^9.21.0",
-    "jest": "^29.7.0",
-    "nodemon": "^3.1.9",
+    "@eslint/js": "^9.29.0",
+    "@swc/core": "^1.12.5",
+    "@tsconfig/recommended": "^1.0.10",
+    "@types/express": "^5.0.3",
+    "@types/node": "^24.0.3",
+    "@typescript-eslint/eslint-plugin": "^8.34.1",
+    "@typescript-eslint/parser": "^8.34.1",
+    "@vitest/coverage-v8": "^3.2.4",
+    "@vitest/ui": "^3.2.4",
+    "eslint": "^9.29.0",
+    "nodemon": "^3.1.10",
     "rimraf": "^6.0.1",
-    "ts-jest": "^29.2.5",
     "ts-node": "^10.9.2",
-    "tsc-alias": "^1.8.10",
-    "typescript": "^5.7.3",
+    "typescript": "^5.8.3",
     "vite": "^6.3.5",
     "vite-plugin-dts": "^4.5.4",
     "vite-plugin-node": "^5.0.1",
-    "vitest": "^3.1.4"
+    "vitest": "^3.2.4"
   },
   "repository": {
     "type": "git",
@@ -73,6 +50,7 @@
   },
   "scripts": {
     "build": "tsc --noEmit && vite build",
+    "dev": "nodemon --watch src --ext ts --exec 'pnpm build'",
     "lint": "eslint . --ext .ts --fix",
     "clean": "rimraf dist",
     "test": "pnpm run lint && vitest run --coverage"

package/src/CItemRouter.ts

@@ -66,30 +66,37 @@ export class CItemRouter<
       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);
+    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;
+    const one = query['one'] as string;
 
     let items: Item<S, L1, L2, L3, L4, L5>[] = [];
 
-    if( finder ) { 
+    if (finder) {
       // If finder is defined?  Call a finder.
-      items = await this.lib.find(finder, JSON.parse(finderParams), this.getLocations(res));
+      logger.trace('Finding Items with a finder', { finder, finderParams, one });
+
+      if (one === 'true') {
+        const item = await (this.lib as any).findOne(finder, JSON.parse(finderParams), this.getLocations(res));
+        items = item ? [item] : [];
+      } else {
+        items = await this.lib.find(finder, JSON.parse(finderParams), this.getLocations(res));
+      }
     } else {
+      logger.trace('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, this.getLocations(res));
     }
 
-    return res.json(items.map((item: Item<S, L1, L2, L3, L4, L5>) => validatePK(item, this.getPkType())));
+    res.json(items.map((item: Item<S, L1, L2, L3, L4, L5>) => validatePK(item, this.getPkType())));
   };
-  /* eslint-enable */
 
 }

package/src/ItemRouter.ts

@@ -30,6 +30,17 @@ export type ActionMethod = <
 // TODO: body is in the request, it's not needed in the parameters
 export type AllActionMethods = Array<RequestHandler>;
 
+// TODO: body is in the request, it's not needed in the parameters
+export type FacetMethod = <
+  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) =>
+  Promise<any>;
+
 export class ItemRouter<
   S extends string,
   L1 extends string = never,
@@ -45,6 +56,7 @@ export class ItemRouter<
   private childRouters: Record<string, Router> = {};
   private logger;
   private itemActions: Record<string, ActionMethod> | undefined;
+  private itemFacets: Record<string, FacetMethod> | undefined;
 
   constructor(
     lib: Operations<Item<S, L1, L2, L3, L4, L5>, S, L1, L2, L3, L4, L5>,
@@ -96,15 +108,35 @@ export class ItemRouter<
     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' });
+      res.status(500).json({ error: 'Item Actions are not configured' });
+      return;
     }
     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));
+      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);
+      res.status(500).json(err);
+    }
+  }
+
+  protected getItemFacet = 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 facetKey = req.path.substring(req.path.lastIndexOf('/') + 1);
+    if (!this.itemFacets) {
+      this.logger.error('Item Facets are not configured');
+      res.status(500).json({ error: 'Item Facets are not configured' });
+      return;
+    }
+    try {
+      const item =
+        validatePK(await this.lib.get(ik), this.getPkType()) as Item<S, L1, L2, L3, L4, L5>;
+      await this.itemFacets[facetKey](req, res, item, req.params);
+    } catch (err: any) {
+      this.logger.error('Error in Item Facet', { message: err?.message, stack: err?.stack });
+      res.status(500).json(err);
     }
   }
 
@@ -138,6 +170,16 @@ export class ItemRouter<
       });
     }
 
+    this.itemFacets = this.configureItemFacets();
+    this.logger.debug('Item Facets supplied to Router', { itemFacets: this.itemFacets });
+    if (this.itemFacets) {
+      Object.keys(this.itemFacets).forEach((facetKey) => {
+        this.logger.default('Configuring Item Facet', { 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.default('Configuring Item Operations under PK Param', { pkParam: this.getPkParam() });
     router.use(`/:${this.getPkParam()}`, this.validatePrimaryKeyValue, itemRouter);
 
@@ -177,6 +219,12 @@ export class ItemRouter<
     return {};
   }
 
+  /* istanbul ignore next */
+  protected configureItemFacets(): Record<string, FacetMethod> {
+    this.logger.debug('ARouter - No Item Facets Configured');
+    return {};
+  }
+
   /* istanbul ignore next */
   protected configureAllActions(): Record<string, AllActionMethods> {
     this.logger.debug('ARouter - No All Actions Configured');
@@ -192,7 +240,7 @@ export class ItemRouter<
 
   /* 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>>> => {
+  protected createItem = async (req: Request, res: Response): Promise<void> => {
     throw new Error('Method not implemented in an abstract router');
   };
 
@@ -203,17 +251,17 @@ export class ItemRouter<
     return item;
   };
 
-  protected deleteItem = async (req: Request, res: Response): Promise<Response<any, Record<string, any>>> => {
+  protected deleteItem = async (req: Request, res: Response): Promise<void> => {
     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);
+    res.json(item);
   };
 
   /* eslint-disable */
   /* istanbul ignore next */
-  protected findItems = async (req: Request, res: Response): Promise<Response<any, Record<string, any>>> => {
+  protected findItems = async (req: Request, res: Response): Promise<void> => {
     throw new Error('Method not implemented in an abstract router');
   };
   /* eslint-enable */
@@ -224,17 +272,17 @@ export class ItemRouter<
     try {
       // TODO: What error does validate PK throw, when can that fail?
       const item = validatePK(await this.lib.get(ik), this.getPkType());
-      return res.json(item);
+      res.json(item);
     } catch (err: any) {
       if (err instanceof NotFoundError) {
         this.logger.error('Item Not Found', { ik, message: err?.message, stack: err?.stack });
-        return res.status(404).json({
+        res.status(404).json({
           ik,
           message: "Item Not Found",
         });
       } else {
         this.logger.error('General Error', { ik, message: err?.message, stack: err?.stack });
-        return res.status(500).json({
+        res.status(500).json({
           ik,
           message: "General Error",
         });
@@ -248,7 +296,7 @@ export class ItemRouter<
     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);
+    res.json(retItem);
   };
 
   public convertDates = (item: Item<S, L1, L2, L3, L4, L5> | ItemProperties<S, L1, L2, L3, L4, L5>):

package/src/PItemRouter.ts

@@ -27,10 +27,9 @@ export class PItemRouter<T extends Item<S>, S extends string> extends ItemRouter
     let item =
       validatePK(await this.lib.create(itemToCreate), this.getPkType()) as Item<S>;
     item = await this.postCreateItem(item);
-    return res.json(item);
+    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 });
 
@@ -39,11 +38,18 @@ export class PItemRouter<T extends Item<S>, S extends string> extends ItemRouter
     const query: ParsedQuery = req.query as unknown as ParsedQuery;
     const finder = query['finder'] as string;
     const finderParams = query['finderParams'] as string;
+    const one = query['one'] as string;
 
-    if( finder ) { 
+    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));
+      logger.default('Finding Items with a finder', { finder, finderParams, one });
+
+      if (one === 'true') {
+        const item = await (this.lib as any).findOne(finder, JSON.parse(finderParams));
+        items = item ? [item] : [];
+      } else {
+        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
@@ -51,7 +57,7 @@ export class PItemRouter<T extends Item<S>, S extends string> extends ItemRouter
       items = await this.lib.all(itemQuery);
     }
 
-    return res.json(items.map((item: Item<S>) => validatePK(item, this.getPkType())));
+    res.json(items.map((item: Item<S>) => validatePK(item, this.getPkType())));
   };
-  /* eslint-enable */
+
 }