All files / src/lib router.ts

80.64% Statements 25/31
75% Branches 9/12
76.47% Functions 13/17
80.64% Lines 25/31

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212                                                      2x 2x 2x 2x                                 12x   12x 12x 10x   2x                                   10x   10x 10x 8x   2x                 22x 22x     22x   22x                                                                                                       22x 22x           22x                       10x                         8x                         2x                         2x                  
import { ErrorMiddleware, Middleware } from '../middlewares/index.js'
 
export type ChannelMiddlewareTuple = {
  channel: string
  fn: Middleware
}
 
export type ChannelErrorMiddlewareTuple = {
  channel: string
  fn: ErrorMiddleware
}
 
export type GenericMiddleware = Middleware | ErrorMiddleware
export type GenericChannelMiddlewareTuple =
  | ChannelMiddlewareTuple
  | ChannelErrorMiddlewareTuple
 
class GleeQuoreRouter {
  private middlewares: ChannelMiddlewareTuple[]
  private outboundMiddlewares: ChannelMiddlewareTuple[]
  private errorMiddlewares: ChannelErrorMiddlewareTuple[]
  private outboundErrorMiddlewares: ChannelErrorMiddlewareTuple[]
 
  /**
   * Instantiates a GleeRouter.
   */
  constructor() {
    this.middlewares = []
    this.outboundMiddlewares = []
    this.errorMiddlewares = []
    this.outboundErrorMiddlewares = []
  }
 
  /**
   * Use a middleware for inbound messages. Please, note that when passing a GleeRouter as a param,
   * this function will make use of inbound and outbound middlewares.
   *
   * @param {String} [channel] The channel you want to scope the middleware to.
   * @param {GenericMiddleware} middleware A middleware function.
   */
  use(...middlewares: GenericMiddleware[]): void
  use(channel: string, ...middlewares: GenericMiddleware[]): void
  use(
    channel: string | GenericMiddleware,
    ...middlewares: GenericMiddleware[]
  ): void {
    const mws: GenericChannelMiddlewareTuple[] =
      this.middlewaresToChannelMiddlewaresTuples(channel, ...middlewares)
 
    mws.forEach((mw) => {
      if (mw.fn.length <= 2) {
        this.addMiddlewares([mw as ChannelMiddlewareTuple])
      } else {
        this.addErrorMiddlewares([mw as ChannelErrorMiddlewareTuple])
      }
    })
  }
 
  /**
   * Use a middleware for outbound messages.
   *
   * @param {String} [channel] The channel you want to scope the middleware to.
   * @param {Function|GleeQuoreRouter} ...middlewares A function or GleeRouter to use as a middleware.
   */
  useOutbound(...middlewares: GenericMiddleware[]): void
  useOutbound(channel: string, ...middlewares: GenericMiddleware[]): void
  useOutbound(
    channel: string | GenericMiddleware,
    ...middlewares: GenericMiddleware[]
  ) {
    const mws: GenericChannelMiddlewareTuple[] =
      this.middlewaresToChannelMiddlewaresTuples(channel, ...middlewares)
 
    mws.forEach((mw) => {
      if (mw.fn.length <= 2) {
        this.addOutboundMiddlewares([mw as ChannelMiddlewareTuple])
      } else {
        this.addOutboundErrorMiddlewares([mw as ChannelErrorMiddlewareTuple])
      }
    })
  }
 
  private middlewaresToChannelMiddlewaresTuples(
    channel: string | GenericMiddleware,
    ...middlewares: GenericMiddleware[]
  ): GenericChannelMiddlewareTuple[] {
    const realChannel = typeof channel === 'string' ? channel : undefined
    const allMiddlewares: GenericMiddleware[] = realChannel
      ? middlewares
      : [channel as GenericMiddleware].concat(middlewares)
    return allMiddlewares.map(
      (fn) =>
        ({
          channel: realChannel,
          fn,
        } as GenericChannelMiddlewareTuple)
    )
  }
 
  /**
   * Returns all the inbound middlewares.
   * @return {Array<ChannelMiddlewareTuple>}
   */
  getMiddlewares(): ChannelMiddlewareTuple[] {
    return this.middlewares
  }
 
  /**
   * Returns all the outbound middlewares.
   * @return {Array<ChannelMiddlewareTuple>}
   */
  getOutboundMiddlewares(): ChannelMiddlewareTuple[] {
    return this.outboundMiddlewares
  }
 
  /**
   * Returns all the inbound error middlewares.
   * @return {Array<ChannelErrorMiddlewareTuple>}
   */
  getErrorMiddlewares(): ChannelErrorMiddlewareTuple[] {
    return this.errorMiddlewares
  }
 
  /**
   * Returns all the outbound error middlewares.
   * @return {Array<ChannelErrorMiddlewareTuple>}
   */
  getOutboundErrorMiddlewares(): ChannelErrorMiddlewareTuple[] {
    return this.outboundErrorMiddlewares
  }
 
  /**
   * Adds a normalized middleware to a target collection.
   *
   * @param {Array<GenericChannelMiddlewareTuple>} target The target collection.
   * @param {Array<GenericChannelMiddlewareTuple>} middlewares The middlewares to add to the collection.
   * @param {String} [channel] The scope channel.
   * @private
   */
  private _addMiddlewares(
    target: GenericChannelMiddlewareTuple[],
    middlewares: GenericChannelMiddlewareTuple[],
    channel: string
  ) {
    middlewares.forEach((mw) => {
      Iif (channel) {
        const compoundchannel = mw.channel
          ? `${channel}/${mw.channel}`
          : channel
        target.push({ ...mw, ...{ channel: compoundchannel } })
      } else {
        target.push(mw)
      }
    })
  }
 
  /**
   * Adds a normalized middleware to the inbound middlewares collection.
   *
   * @param {Array<ChannelMiddlewareTuple>} middlewares The middlewares to add to the collection.
   * @param {String} [channel] The scope channel.
   */
  addMiddlewares(middlewares: ChannelMiddlewareTuple[], channel?: string) {
    this._addMiddlewares(this.middlewares, middlewares, channel)
  }
 
  /**
   * Adds a normalized middleware to the outbound middlewares collection.
   *
   * @param {Array<ChannelMiddlewareTuple>} middlewares The middlewares to add to the collection.
   * @param {String} [channel] The scope channel.
   */
  addOutboundMiddlewares(
    middlewares: ChannelMiddlewareTuple[],
    channel?: string
  ) {
    this._addMiddlewares(this.outboundMiddlewares, middlewares, channel)
  }
 
  /**
   * Adds a normalized middleware to the inbound error middlewares collection.
   *
   * @param {Array<ChannelErrorMiddlewareTuple>} errorMiddlewares The middlewares to add to the collection.
   * @param {String} [channel] The scope channel.
   */
  addErrorMiddlewares(
    errorMiddlewares: ChannelErrorMiddlewareTuple[],
    channel?: string
  ) {
    this._addMiddlewares(this.errorMiddlewares, errorMiddlewares, channel)
  }
 
  /**
   * Adds a normalized middleware to the outbound error middlewares collection.
   *
   * @param {Array<ChannelErrorMiddlewareTuple>} errorMiddlewares The middlewares to add to the collection.
   * @param {String} [channel] The scope channel.
   */
  addOutboundErrorMiddlewares(
    errorMiddlewares: ChannelErrorMiddlewareTuple[],
    channel?: string
  ) {
    this._addMiddlewares(
      this.outboundErrorMiddlewares,
      errorMiddlewares,
      channel
    )
  }
}
 
export default GleeQuoreRouter