@athenna/http 3.0.11 → 3.1.0

package/src/Router/RouteResource.js

@@ -1,247 +0,0 @@
-/**
- * @athenna/http
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-import { Route } from '#src/Router/Route'
-import { Is, String } from '@athenna/common'
-
-export class RouteResource {
-  /**
-   * All routes registered in the resource.
-   *
-   * @type {Route[]}
-   */
-  routes
-
-  /**
-   * The resource name.
-   *
-   * @type {string}
-   */
-  #resource
-
-  /**
-   * The resource controller.
-   *
-   * @type {any}
-   */
-  #controller
-
-  /**
-   * The resource name.
-   *
-   * @type {string}
-   */
-  #resourceName
-
-  /**
-   * Creates a new instance of RouteResource.
-   *
-   * @param {string} resource
-   * @param {any} controller
-   * @return {RouteResource}
-   */
-  constructor(resource, controller) {
-    this.routes = []
-
-    this.#resource = resource
-    this.#controller = controller
-
-    this.#resourceName = this.#resource
-      .split('.')
-      .map(string => String.toSnakeCase(string))
-      .join('.')
-
-    this.#buildRoutes()
-  }
-
-  /**
-   * Set a middleware for the route group.
-   *
-   * @param {string|any} middleware
-   * @param {'handle'|'intercept'|'terminate'} type
-   * @return {RouteResource}
-   */
-  middleware(middleware, type = 'handle') {
-    this.routes.forEach(route => route.middleware(middleware, type))
-
-    return this
-  }
-
-  /**
-   * Register only the methods in the array.
-   *
-   * @param {string} names
-   * @return {RouteResource}
-   */
-  only(...names) {
-    this.#filter(names, true).forEach(route => (route.deleted = true))
-
-    return this
-  }
-
-  /**
-   * Register all methods except the methods in the array.
-   *
-   * @param {string} names
-   * @return {RouteResource}
-   */
-  except(...names) {
-    this.#filter(names, false).forEach(route => (route.deleted = true))
-
-    return this
-  }
-
-  /**
-   * Set up helmet options for route resource.
-   *
-   * @param {string|any} action
-   * @param {any} [options]
-   * @return {RouteResource}
-   */
-  helmet(action, options) {
-    if (!options) {
-      this.routes.forEach(route => route.helmet(action))
-
-      return this
-    }
-
-    const resourceName = `${this.#resourceName}.${action}`
-
-    this.routes.forEach(route => {
-      if (route.name !== resourceName) {
-        return
-      }
-
-      route.helmet(options)
-    })
-
-    return this
-  }
-
-  /**
-   * Set up swagger options for route resource method.
-   *
-   * @param {string|any} action
-   * @param {any} [options]
-   * @return {RouteResource}
-   */
-  swagger(action, options) {
-    if (!options) {
-      this.routes.forEach(route => route.swagger(action))
-
-      return this
-    }
-
-    const resourceName = `${this.#resourceName}.${action}`
-
-    this.routes.forEach(route => {
-      if (route.name !== resourceName) {
-        return
-      }
-
-      route.swagger(options)
-    })
-
-    return this
-  }
-
-  /**
-   * Set up rate limit options for route resource method.
-   *
-   * @param {string|any} action
-   * @param {any} [options]
-   * @return {RouteResource}
-   */
-  rateLimit(action, options) {
-    if (!options) {
-      this.routes.forEach(route => route.rateLimit(action))
-
-      return this
-    }
-
-    const resourceName = `${this.#resourceName}.${action}`
-
-    this.routes.forEach(route => {
-      if (route.name !== resourceName) {
-        return
-      }
-
-      route.rateLimit(options)
-    })
-
-    return this
-  }
-
-  /**
-   * Create the route.
-   *
-   * @param {string} url
-   * @param {string[]} methods
-   * @param {string} action
-   * @return {void}
-   */
-  #makeRoute(url, methods, action) {
-    let handler = ''
-
-    if (Is.String(this.#controller)) {
-      handler = `${this.#controller}.${action}`
-    } else {
-      handler = this.#controller[action]
-    }
-
-    const route = new Route(
-      url,
-      methods,
-      handler,
-      `${this.#resourceName}.${action}`,
-    )
-
-    this.routes.push(route)
-  }
-
-  /**
-   * Build all the routes of the resource.
-   *
-   * @return {void}
-   */
-  #buildRoutes() {
-    this.#resource = this.#resource.replace(/^\//, '').replace(/\/$/, '')
-
-    const resourceTokens = this.#resource.split('.')
-    const mainResource = resourceTokens.pop()
-
-    const fullUrl = `${resourceTokens
-      .map(
-        string =>
-          `${string}/:${String.toSnakeCase(String.singularize(string))}_id`,
-      )
-      .join('/')}/${mainResource}`
-
-    this.#makeRoute(fullUrl, ['HEAD', 'GET'], 'index')
-    this.#makeRoute(fullUrl, ['POST'], 'store')
-    this.#makeRoute(`${fullUrl}/:id`, ['HEAD', 'GET'], 'show')
-    this.#makeRoute(`${fullUrl}/:id`, ['PUT', 'PATCH'], 'update')
-    this.#makeRoute(`${fullUrl}/:id`, ['DELETE'], 'delete')
-  }
-
-  /**
-   * Filter the routes by name.
-   *
-   * @param {string[]} names
-   * @param {boolean} inverse
-   * @return {Route[]}
-   */
-  #filter(names, inverse) {
-    return this.routes.filter(route => {
-      const match = names.find(name => route.name.endsWith(name))
-
-      return inverse ? !match : match
-    })
-  }
-}

package/src/Router/Router.js

@@ -1,313 +0,0 @@
-/**
- * @athenna/http
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-import { Is } from '@athenna/common'
-
-import { Route } from '#src/Router/Route'
-import { Server } from '#src/Facades/Server'
-import { RouteGroup } from '#src/Router/RouteGroup'
-import { RouteResource } from '#src/Router/RouteResource'
-
-export class Router {
-  /**
-   * All routes registered.
-   *
-   * @type {(Route | RouteResource | RouteGroup)[]}
-   */
-  routes
-
-  /**
-   * Route groups opened.
-   *
-   * @type {RouteGroup[]}
-   */
-  #openedGroups
-
-  /**
-   * The controller instance.
-   *
-   * @type {any}
-   */
-  #controllerInstance
-
-  constructor() {
-    this.routes = []
-    this.#openedGroups = []
-  }
-
-  /**
-   * List the routes registered.
-   *
-   * @return {any}
-   */
-  listRoutes() {
-    return this.toRoutesJSON(this.routes)
-  }
-
-  /**
-   * Set the controller instance.
-   *
-   * @param {any} controller
-   * @return {Router}
-   */
-  controller(controller) {
-    this.#controllerInstance = controller
-
-    return this
-  }
-
-  /**
-   * Register a new route.
-   *
-   * @param {string} url
-   * @param {string[]} methods
-   * @param {string|any} handler
-   * @return {Route}
-   */
-  route(url, methods, handler) {
-    if (
-      this.#controllerInstance &&
-      Is.String(handler) &&
-      !handler.includes('.')
-    ) {
-      handler = this.#controllerInstance[handler]
-    }
-
-    const route = new Route(url, methods, handler)
-    const openedGroup = this.#getRecentGroup()
-
-    if (openedGroup) {
-      openedGroup.routes.push(route)
-    } else {
-      this.routes.push(route)
-    }
-
-    return route
-  }
-
-  /**
-   * Register a new vanila route using fastify options
-   * directly.
-   *
-   * @param {import('fastify').RouteOptions} options
-   * @return {void}
-   */
-  vanilaRoute(options) {
-    Server.getFastify().route(options)
-  }
-
-  /**
-   * Creates a new route group.
-   *
-   * @param {() => void} callback
-   * @return {RouteGroup}
-   */
-  group(callback) {
-    const group = new RouteGroup([])
-
-    const openedGroup = this.#getRecentGroup()
-
-    if (openedGroup) {
-      openedGroup.routes.push(group)
-    } else {
-      this.routes.push(group)
-    }
-
-    this.#openedGroups.push(group)
-    callback()
-
-    this.#openedGroups.pop()
-
-    return group
-  }
-
-  /**
-   * Creates a new route resource.
-   *
-   * @param {string} resource
-   * @param {any} controller
-   * @return {RouteResource}
-   */
-  resource(resource, controller) {
-    const resourceInstance = new RouteResource(resource, controller)
-    const openedGroup = this.#getRecentGroup()
-
-    if (openedGroup) {
-      openedGroup.routes.push(resourceInstance)
-    } else {
-      this.routes.push(resourceInstance)
-    }
-
-    return resourceInstance
-  }
-
-  /**
-   * Creates a new redirect route.
-   *
-   * @param {string} url
-   * @param {string} redirectTo
-   * @param {number} [status]
-   * @return {Route}
-   */
-  redirect(url, redirectTo, status = 302) {
-    return this.any(url, ({ response }) =>
-      response.redirectTo(redirectTo, status),
-    )
-  }
-
-  /**
-   * Register a new get method route.
-   *
-   * @param {string} url
-   * @param {string|any} handler
-   * @return {Route}
-   */
-  get(url, handler) {
-    return this.route(url, ['GET', 'HEAD'], handler)
-  }
-
-  /**
-   * Register a new head method route.
-   *
-   * @param {string} url
-   * @param {string|any} handler
-   * @return {Route}
-   */
-  head(url, handler) {
-    return this.route(url, ['HEAD'], handler)
-  }
-
-  /**
-   * Register a new post method route.
-   *
-   * @param {string} url
-   * @param {string|any} handler
-   * @return {Route}
-   */
-  post(url, handler) {
-    return this.route(url, ['POST'], handler)
-  }
-
-  /**
-   * Register a new put method route.
-   *
-   * @param {string} url
-   * @param {string|any} handler
-   * @return {Route}
-   */
-  put(url, handler) {
-    return this.route(url, ['PUT'], handler)
-  }
-
-  /**
-   * Register a new patch method route.
-   *
-   * @param {string} url
-   * @param {string|any} handler
-   * @return {Route}
-   */
-  patch(url, handler) {
-    return this.route(url, ['PATCH'], handler)
-  }
-
-  /**
-   * Register a new delete method route.
-   *
-   * @param {string} url
-   * @param {string|any} handler
-   * @return {Route}
-   */
-  delete(url, handler) {
-    return this.route(url, ['HEAD'], handler)
-  }
-
-  /**
-   * Register a new options method route.
-   *
-   * @param {string} url
-   * @param {string|any} handler
-   * @return {Route}
-   */
-  options(url, handler) {
-    return this.route(url, ['OPTIONS'], handler)
-  }
-
-  /**
-   * Register a new route with all methods.
-   *
-   * @param {string} url
-   * @param {string|any} handler
-   * @return {Route}
-   */
-  any(url, handler) {
-    return this.route(
-      url,
-      ['GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'HEAD', 'OPTIONS'],
-      handler,
-    )
-  }
-
-  /**
-   * Register all the routes inside the Server.
-   *
-   * @param {string} url
-   * @param {string|any} handler
-   * @return {Route}
-   */
-  register() {
-    this.toRoutesJSON(this.routes).forEach(route => {
-      route.methods.forEach(method => {
-        Server[method.toLowerCase()](
-          route.url,
-          route.handler,
-          route.middlewares,
-          {
-            helmet: route.helmetOptions,
-            schema: route.swaggerOptions,
-            config: { rateLimit: route.rateLimitOptions },
-          },
-        )
-      })
-    })
-  }
-
-  /**
-   * Transform the routes to JSON Object.
-   *
-   * @param {any[]} [routes]
-   */
-  toRoutesJSON(routes) {
-    return routes.reduce((list, route) => {
-      if (route instanceof RouteGroup) {
-        list = list.concat(this.toRoutesJSON(route.routes))
-        return list
-      }
-
-      if (route instanceof RouteResource) {
-        list = list.concat(this.toRoutesJSON(route.routes))
-        return list
-      }
-
-      if (!route.deleted) {
-        list.push(route.toJSON())
-      }
-
-      return list
-    }, [])
-  }
-
-  /**
-   * Returns the recent group.
-   *
-   * @return {RouteGroup}
-   */
-  #getRecentGroup() {
-    return this.#openedGroups[this.#openedGroups.length - 1]
-  }
-}

package/src/Utils/isMiddlewareContract.js

@@ -1,17 +0,0 @@
-/**
- * @athenna/http
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-/**
- * Verify if the middleware implements the middleware contract.
- *
- * @param {any} object
- */
-export function isMiddlewareContract(object) {
-  return 'handle' in object || 'intercept' in object || 'terminate' in object
-}

package/src/Utils/removeSlashes.js

@@ -1,30 +0,0 @@
-/**
- * @athenna/http
- *
- * (c) João Lenon <lenon@athenna.io>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-import { Is } from '@athenna/common'
-
-/**
- * Remove additional slashes from url.
- *
- * @param {string|string[]} url
- * @return {string|string[]}
- */
-export function removeSlashes(url) {
-  if (url === '/') {
-    return url
-  }
-
-  const matcher = url => `/${url.replace(/^\//, '').replace(/\/$/, '')}`
-
-  if (Is.Array(url)) {
-    return url.map(u => matcher(u))
-  }
-
-  return matcher(url)
-}