@fjell/express-router 4.4.4 → 4.4.6

package/src/ItemRouter.ts

@@ -1,352 +0,0 @@
-import {
-  ComKey,
-  cPK,
-  Item,
-  ItemEvent,
-  ItemProperties,
-  LocKey,
-  LocKeyArray,
-  PriKey,
-  validatePK
-} from "@fjell/core";
-import { NotFoundError, Operations } from "@fjell/lib";
-import deepmerge from "deepmerge";
-import { Request, Response, Router } from "express";
-import LibLogger from "./logger";
-
-export type ItemRouterOptions = Record<string, never>;
-
-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;
-
-  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 postAllAction = async (req: Request, res: Response) => {
-    this.logger.default('Posting All Action', { query: req?.query, params: req?.params, locals: res?.locals });
-    const allActionKey = req.path.substring(req.path.lastIndexOf('/') + 1);
-    if (!this.lib.allActions) {
-      this.logger.error('Item Actions are not configured');
-      res.status(500).json({ error: 'Item Actions are not configured' });
-      return;
-    }
-    const allAction = this.lib.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 this.lib.allAction(allActionKey, req.body));
-    } catch (err: any) {
-      this.logger.error('Error in All Action', { message: err?.message, stack: err?.stack });
-      res.status(500).json(err);
-    }
-  }
-
-  protected getAllFacet = async (req: Request, res: Response) => {
-    this.logger.default('Getting All Facet', { query: req?.query, params: req?.params, locals: res?.locals });
-    const facetKey = req.path.substring(req.path.lastIndexOf('/') + 1);
-    if (!this.lib.allFacets) {
-      this.logger.error('Item Facets are not configured');
-      res.status(500).json({ error: 'Item Facets are not configured' });
-      return;
-    }
-    const facet = this.lib.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 } as Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>>;
-      res.json(await this.lib.allFacet(facetKey, combinedQueryParams));
-    } catch (err: any) {
-      this.logger.error('Error in All Facet', { message: err?.message, stack: err?.stack });
-      res.status(500).json(err);
-    }
-  }
-
-  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.lib.actions) {
-      this.logger.error('Item Actions are not configured');
-      res.status(500).json({ error: 'Item Actions are not configured' });
-      return;
-    }
-    const action = this.lib.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 this.lib.action(ik, actionKey, req.body));
-    } catch (err: any) {
-      this.logger.error('Error in Item Action', { message: err?.message, stack: err?.stack });
-      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.lib.facets) {
-      this.logger.error('Item Facets are not configured');
-      res.status(500).json({ error: 'Item Facets are not configured' });
-      return;
-    }
-    const facet = this.lib.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 } as Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>>;
-      res.json(await this.lib.facet(ik, facetKey, combinedQueryParams));
-    } catch (err: any) {
-      this.logger.error('Error in Item Facet', { message: err?.message, stack: err?.stack });
-      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);
-
-    this.logger.debug('All Actions supplied to Router', { allActions: this.lib.allActions });
-    if (this.lib.allActions) {
-      Object.keys(this.lib.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}`, this.postAllAction);
-      });
-    }
-
-    this.logger.debug('All Facets supplied to Router', { allFacets: this.lib.allFacets });
-    if (this.lib.allFacets) {
-      Object.keys(this.lib.allFacets).forEach((facetKey) => {
-        this.logger.default('Configuring All Facet', { 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 = Router();
-    itemRouter.get('/', this.getItem);
-    itemRouter.put('/', this.updateItem);
-    itemRouter.delete('/', this.deleteItem);
-
-    this.logger.debug('Item Actions supplied to Router', { itemActions: this.lib.actions });
-    if (this.lib.actions) {
-      Object.keys(this.lib.actions).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.debug('Item Facets supplied to Router', { itemFacets: this.lib.facets });
-    if (this.lib.facets) {
-      Object.keys(this.lib.facets).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);
-
-    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 */
-  public getRouter(): Router {
-    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<void> => {
-    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<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());
-    res.json(item);
-  };
-
-  /* eslint-disable */
-  /* istanbul ignore next */
-  protected findItems = async (req: Request, res: Response): Promise<void> => {
-    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 {
-      // TODO: What error does validate PK throw, when can that fail?
-      const item = validatePK(await this.lib.get(ik), this.getPkType());
-      res.json(item);
-    } catch (err: any) {
-      if (err instanceof NotFoundError) {
-        this.logger.error('Item Not Found', { ik, message: err?.message, stack: err?.stack });
-        res.status(404).json({
-          ik,
-          message: "Item Not Found",
-        });
-      } else {
-        this.logger.error('General Error', { ik, message: err?.message, stack: err?.stack });
-        res.status(500).json({
-          ik,
-          message: "General Error",
-        });
-      }
-    }
-  }
-
-  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());
-    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

@@ -1,63 +0,0 @@
-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 as any, 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);
-    res.json(item);
-  };
-
-  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;
-    const one = query['one'] as string;
-
-    if (finder) {
-      // If finder is defined?  Call a finder.
-      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
-      const itemQuery: ItemQuery = paramsToQuery(req.query as QueryParams);
-      items = await this.lib.all(itemQuery);
-    }
-
-    res.json(items.map((item: Item<S>) => validatePK(item, this.getPkType())));
-  };
-
-}

package/src/index.ts

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

package/src/logger.ts

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