@athenna/http 1.3.2 → 1.3.5

package/src/Router/Route.js

@@ -1,4 +1,3 @@
-"use strict";
 /**
  * @athenna/http
  *
@@ -7,108 +6,202 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Route = void 0;
-require("@athenna/ioc");
-const utils_1 = require("@secjs/utils");
-const removeSlash_1 = require("../Utils/removeSlash");
-const isMiddlewareContract_1 = require("../Utils/isMiddlewareContract");
-const MiddlewareNotFoundException_1 = require("../Exceptions/MiddlewareNotFoundException");
-const UndefinedControllerMethodException_1 = require("../Exceptions/UndefinedControllerMethodException");
-class Route {
-    constructor(url, methods, handler) {
-        this.url = url;
-        this.deleted = false;
-        this.methods = methods;
-        this.prefixes = [];
-        this.deleted = false;
-        this.routeMiddlewares = { handlers: [], terminators: [], interceptors: [] };
-        this.handler = handler;
+
+import { Is } from '@secjs/utils'
+import { removeSlashes } from '#src/Utils/removeSlashes'
+import { isMiddlewareContract } from '#src/Utils/isMiddlewareContract'
+import { UndefinedMethodException } from '#src/Exceptions/UndefinedMethodException'
+
+export class Route {
+  /**
+   * Route name for resources.
+   *
+   * @type {string}
+   */
+  name
+
+  /**
+   * Route url.
+   *
+   * @type {string}
+   */
+  #url
+
+  /**
+   * Sets if route should be registered or not.
+   *
+   * @type {boolean}
+   */
+  #deleted
+
+  /**
+   * The route handler closure.
+   *
+   * @type {string|any}
+   */
+  #handler
+
+  /**
+   * The methods of this route.
+   *
+   * @type {string[]}
+   */
+  #methods
+
+  /**
+   * The middlewares of this route.
+   *
+   * @type {{ handlers: any[], terminators: any[], interceptors: any[] }}
+   */
+  #routeMiddlewares
+
+  /**
+   * The prefixes of this route.
+   *
+   * @type {string[]}
+   */
+  #prefixes
+
+  /**
+   * Creates a new instance of Route.
+   *
+   * @param {string} url
+   * @param {string[]} methods
+   * @param {string|any} handler
+   * @param {string} [name]
+   * @return {Route}
+   */
+  constructor(url, methods, handler, name) {
+    this.#url = url
+    this.#deleted = false
+    this.#methods = methods
+    this.#prefixes = []
+    this.#handler = handler
+    this.#routeMiddlewares = { handlers: [], terminators: [], interceptors: [] }
+
+    if (name) {
+      this.name = name
     }
-    prefix(prefix) {
-        this.prefixes.push(prefix);
-        return this;
+  }
+
+  /**
+   * Set a prefix for the route.
+   *
+   * @param {string} prefix
+   * @return {Route}
+   */
+  prefix(prefix) {
+    this.#prefixes.push(prefix)
+
+    return this
+  }
+
+  /**
+   * Set a middleware for the route.
+   *
+   * @param {string|any} middleware
+   * @param {'handle'|'intercept'|'terminate'} [type]
+   * @param {boolean} [prepend]
+   * @return {Route}
+   */
+  middleware(middleware, type = 'handle', prepend = false) {
+    const dictionary = {
+      handle: 'handlers',
+      terminate: 'terminators',
+      intercept: 'interceptors',
     }
-    as(name, prepend = false) {
-        this.name = prepend ? `${name}.${this.name}` : name;
-        return this;
+
+    const insertionType = prepend ? 'unshift' : 'push'
+
+    if (Is.String(middleware)) {
+      const mid =
+        ioc.use(`App/Http/Middlewares/Names/${middleware}`) ||
+        ioc.safeUse(`App/Http/Middlewares/${middleware}`)
+
+      if (mid.handle) {
+        this.#routeMiddlewares.handlers[insertionType](mid.handle.bind(mid))
+      }
+
+      if (mid.intercept) {
+        this.#routeMiddlewares.interceptors[insertionType](
+          mid.intercept.bind(mid),
+        )
+      }
+
+      if (mid.terminate) {
+        this.#routeMiddlewares.terminators[insertionType](
+          mid.terminate.bind(mid),
+        )
+      }
+
+      return this
     }
-    namespace(namespace, overwrite = false) {
-        if (!this.routeNamespace || overwrite) {
-            this.routeNamespace = namespace;
-        }
-        return this;
+
+    if (isMiddlewareContract(middleware)) {
+      if (middleware.handle) {
+        this.#routeMiddlewares.handlers[insertionType](
+          middleware.handle.bind(middleware),
+        )
+      }
+
+      if (middleware.intercept) {
+        this.#routeMiddlewares.interceptors[insertionType](
+          middleware.intercept.bind(middleware),
+        )
+      }
+
+      if (middleware.terminate) {
+        this.#routeMiddlewares.terminators[insertionType](
+          middleware.terminate.bind(middleware),
+        )
+      }
+
+      return this
     }
-    middleware(middleware, type = 'handle', prepend = false) {
-        const dictionary = {
-            handle: 'handlers',
-            terminate: 'terminators',
-            intercept: 'interceptors',
-        };
-        const insertionType = prepend ? 'unshift' : 'push';
-        if (utils_1.Is.String(middleware)) {
-            const mid = ioc.use(`App/Http/Middlewares/Names/${middleware}`) ||
-                ioc.safeUse(`App/Http/Middlewares/${middleware}`);
-            if (!mid) {
-                throw new MiddlewareNotFoundException_1.MiddlewareNotFoundException(middleware);
-            }
-            if (mid.handle) {
-                this.routeMiddlewares.handlers[insertionType](mid.handle.bind(mid));
-            }
-            if (mid.intercept) {
-                this.routeMiddlewares.interceptors[insertionType](mid.intercept.bind(mid));
-            }
-            if (mid.terminate) {
-                this.routeMiddlewares.terminators[insertionType](mid.terminate.bind(mid));
-            }
-            return this;
-        }
-        if (isMiddlewareContract_1.isMiddlewareContract(middleware)) {
-            if (middleware.handle) {
-                this.routeMiddlewares.handlers[insertionType](middleware.handle.bind(middleware));
-            }
-            if (middleware.intercept) {
-                this.routeMiddlewares.interceptors[insertionType](middleware.intercept.bind(middleware));
-            }
-            if (middleware.terminate) {
-                this.routeMiddlewares.terminators[insertionType](middleware.terminate.bind(middleware));
-            }
-            return this;
-        }
-        this.routeMiddlewares[dictionary[type]][insertionType](middleware);
-        return this;
+
+    this.#routeMiddlewares[dictionary[type]][insertionType](middleware)
+
+    return this
+  }
+
+  toJSON() {
+    const json = {
+      url: this.#getUrl(),
+      methods: this.#methods,
+      middlewares: this.#routeMiddlewares,
     }
-    toJSON() {
-        const json = {
-            name: this.name,
-            url: this.getUrl(),
-            methods: this.methods,
-            middlewares: this.routeMiddlewares,
-            meta: {
-                namespace: this.routeNamespace,
-            },
-        };
-        if (utils_1.Is.String(this.handler)) {
-            const [controller, method] = this.handler.split('.');
-            const dependency = ioc.safeUse(`App/Http/Controllers/${controller}`);
-            if (!dependency[method]) {
-                throw new UndefinedControllerMethodException_1.UndefinedControllerMethodException(method, controller);
-            }
-            json.handler = dependency[method].bind(dependency);
-        }
-        else {
-            json.handler = this.handler;
-        }
-        return json;
-    }
-    getUrl() {
-        const url = removeSlash_1.removeSlash(this.url);
-        const prefix = this.prefixes
-            .slice()
-            .reverse()
-            .map(p => removeSlash_1.removeSlash(p))
-            .join('');
-        return prefix ? `${prefix}${url === '/' ? '' : url}` : url;
+
+    if (Is.String(this.#handler)) {
+      const [controller, method] = this.#handler.split('.')
+
+      const dependency = ioc.safeUse(`App/Http/Controllers/${controller}`)
+
+      if (!dependency[method]) {
+        throw new UndefinedMethodException(method, controller)
+      }
+
+      json.handler = dependency[method].bind(dependency)
+    } else {
+      json.handler = this.#handler
     }
+
+    return json
+  }
+
+  /**
+   * Get the route url parsed with prefixes.
+   *
+   * @return {string}
+   */
+  #getUrl() {
+    const url = removeSlashes(this.#url)
+
+    const prefix = this.#prefixes
+      .slice()
+      .reverse()
+      .map(p => removeSlashes(p))
+      .join('')
+
+    return prefix ? `${prefix}${url === '/' ? '' : url}` : url
+  }
 }
-exports.Route = Route;

package/src/Router/RouteGroup.js

@@ -1,4 +1,3 @@
-"use strict";
 /**
  * @athenna/http
  *
@@ -7,45 +6,72 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RouteGroup = void 0;
-const RouteResource_1 = require("./RouteResource");
-const CannotDefineGroupException_1 = require("../Exceptions/CannotDefineGroupException");
-class RouteGroup {
-    constructor(routes) {
-        this.routes = routes;
+
+import { RouteResource } from '#src/Router/RouteResource'
+
+export class RouteGroup {
+  /**
+   * All routes registered in the group.
+   *
+   * @type {(import('./Route.js').Route | RouteResource | RouteGroup)[]}
+   */
+  routes
+
+  /**
+   * Creates a new instance of RouteGroup.
+   *
+   * @param {(import('./Route.js').Route | RouteResource | RouteGroup)[]} routes
+   */
+  constructor(routes) {
+    this.routes = routes
+  }
+
+  /**
+   * Set a prefix for the route group.
+   *
+   * @param {string} prefix
+   * @return {RouteGroup}
+   */
+  prefix(prefix) {
+    this.routes.forEach(route => this.#invoke(route, 'prefix', [prefix]))
+
+    return this
+  }
+
+  /**
+   * Set a middleware for the route group.
+   *
+   * @param {string|any} middleware
+   * @param {'handle'|'intercept'|'terminate'} type
+   * @param {boolean} prepend
+   * @return {RouteGroup}
+   */
+  middleware(middleware, type = 'handle', prepend = false) {
+    this.routes.forEach(route => {
+      this.#invoke(route, 'middleware', [middleware, type, prepend])
+    })
+
+    return this
+  }
+
+  /**
+   * Invoke a method from route.
+   *
+   * @param {import('./Route.js').Route|RouteResource|RouteGroup} route
+   * @param {string} method
+   * @param {any[]} params
+   */
+  #invoke(route, method, params) {
+    if (route instanceof RouteResource) {
+      route.routes.forEach(child => this.#invoke(child, method, params))
+      return
     }
-    prefix(prefix) {
-        this.routes.forEach(route => this.invoke(route, 'prefix', [prefix]));
-        return this;
-    }
-    as(name) {
-        this.routes.forEach(route => this.invoke(route, 'as', [name, true]));
-        return this;
-    }
-    namespace(namespace) {
-        this.routes.forEach(route => this.invoke(route, 'namespace', [namespace]));
-        return this;
-    }
-    middleware(middleware, type = 'handle', prepend = false) {
-        this.routes.forEach(route => {
-            this.invoke(route, 'middleware', [middleware, type, prepend]);
-        });
-        return this;
-    }
-    invoke(route, method, params) {
-        if (route instanceof RouteResource_1.RouteResource) {
-            route.routes.forEach(child => this.invoke(child, method, params));
-            return;
-        }
-        if (route instanceof RouteGroup) {
-            route.routes.forEach(child => this.invoke(child, method, params));
-            return;
-        }
-        if (method === 'as' && !route.name) {
-            throw new CannotDefineGroupException_1.CannotDefineGroupException();
-        }
-        route[method](...params);
+
+    if (route instanceof RouteGroup) {
+      route.routes.forEach(child => this.#invoke(child, method, params))
+      return
     }
+
+    route[method](...params)
+  }
 }
-exports.RouteGroup = RouteGroup;

package/src/Router/RouteResource.js

@@ -1,4 +1,3 @@
-"use strict";
 /**
  * @athenna/http
  *
@@ -7,78 +6,161 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RouteResource = void 0;
-const Route_1 = require("./Route");
-const utils_1 = require("@secjs/utils");
-class RouteResource {
-    constructor(resource, controller) {
-        this.routes = [];
-        this.resource = resource;
-        this.controller = controller;
-        this.resourceName = this.resource
-            .split('.')
-            .map(string => utils_1.String.toSnakeCase(string))
-            .join('.');
-        this.buildRoutes();
-    }
-    middleware(middleware, type = 'handle') {
-        this.routes.forEach(route => route.middleware(middleware, type));
-        return this;
-    }
-    only(names) {
-        this.filter(names, true).forEach(route => (route.deleted = true));
-        return this;
-    }
-    except(names) {
-        this.filter(names, false).forEach(route => (route.deleted = true));
-        return this;
-    }
-    namespace(namespace) {
-        this.routes.forEach(route => {
-            route.namespace(namespace);
-        });
-        return this;
-    }
-    as(name) {
-        name = utils_1.String.toSnakeCase(name);
-        this.routes.forEach(route => {
-            route.as(route.name.replace(this.resourceName, name), false);
-        });
-        this.resourceName = name;
-        return this;
-    }
-    makeRoute(url, methods, action) {
-        let handler = '';
-        if (utils_1.Is.String(this.controller)) {
-            handler = `${this.controller}.${action}`;
-        }
-        else {
-            handler = this.controller[action];
-        }
-        const route = new Route_1.Route(url, methods, handler);
-        route.as(`${this.resourceName}.${action}`);
-        this.routes.push(route);
-    }
-    buildRoutes() {
-        this.resource = this.resource.replace(/^\//, '').replace(/\/$/, '');
-        const resourceTokens = this.resource.split('.');
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        const mainResource = resourceTokens.pop();
-        const fullUrl = `${resourceTokens
-            .map(string => `${string}/:${utils_1.String.toSnakeCase(utils_1.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(names, inverse) {
-        return this.routes.filter(route => {
-            const match = names.find(name => route.name.endsWith(name));
-            return inverse ? !match : match;
-        });
+
+import { Route } from '#src/Router/Route'
+import { Is, String } from '@secjs/utils'
+
+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
+  }
+
+  /**
+   * 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
+    })
+  }
 }
-exports.RouteResource = RouteResource;