axe-api 0.18.1 → 0.19.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Release Notes
 
+## [0.19.0 (2021-12-05)](https://github.com/axe-api/axe-api/compare/0.19.0...0.18.1)
+
+### Fixed
+
+- [#110](https://github.com/axe-api/axe-api/issues/110)
+
+### Enhancements
+
+- [#106](https://github.com/axe-api/axe-api/issues/106)
+
 ## [0.18.1 (2021-12-02)](https://github.com/axe-api/axe-api/compare/0.18.1...0.18.0)
 
 ### Fixed

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "axe-api",
-  "version": "0.18.1",
+  "version": "0.19.0",
   "description": "AXE API is a simple tool which has been created based on Express and Knex.js to create Rest APIs quickly.",
   "main": "index.js",
   "type": "module",

package/src/constants.js

@@ -13,6 +13,7 @@ const HOOK_FUNCTIONS = {
   onBeforeDeleteQuery: "onBeforeDeleteQuery",
   onBeforeDelete: "onBeforeDelete",
   onBeforePaginate: "onBeforePaginate",
+  onBeforeAll: "onBeforeAll",
   onBeforeShow: "onBeforeShow",
   onAfterInsert: "onAfterInsert",
   onAfterUpdateQuery: "onAfterUpdateQuery",
@@ -20,6 +21,7 @@ const HOOK_FUNCTIONS = {
   onAfterDeleteQuery: "onAfterDeleteQuery",
   onAfterDelete: "onAfterDelete",
   onAfterPaginate: "onAfterPaginate",
+  onAfterAll: "onAfterAll",
   onAfterShow: "onAfterShow",
 };
 
@@ -52,7 +54,8 @@ const HANDLERS = {
   SHOW: "show",
   UPDATE: "update",
   DELETE: "destroy",
-  AUTOSAVE: "autosave",
+  PATCH: "patch",
+  ALL: "all",
 };
 
 const DEFAULT_HANDLERS = [
@@ -60,6 +63,7 @@ const DEFAULT_HANDLERS = [
   HANDLERS.PAGINATE,
   HANDLERS.SHOW,
   HANDLERS.UPDATE,
+  HANDLERS.PATCH,
   HANDLERS.DELETE,
 ];
 
@@ -68,6 +72,7 @@ const HTTP_METHODS = {
   GET: "GET",
   PUT: "PUT",
   DELETE: "DELETE",
+  PATCH: "PATCH",
 };
 
 const API_ROUTE_TEMPLATES = {
@@ -79,6 +84,11 @@ const API_ROUTE_TEMPLATES = {
     url: (prefix, parentUrl, resource) => `/${prefix}/${parentUrl}${resource}`,
     method: HTTP_METHODS.GET,
   },
+  [HANDLERS.ALL]: {
+    url: (prefix, parentUrl, resource) =>
+      `/${prefix}/${parentUrl}${resource}/all`,
+    method: HTTP_METHODS.GET,
+  },
   [HANDLERS.SHOW]: {
     url: (prefix, parentUrl, resource, primaryKey) =>
       `/${prefix}/${parentUrl}${resource}/:${primaryKey}`,
@@ -89,10 +99,10 @@ const API_ROUTE_TEMPLATES = {
       `/${prefix}/${parentUrl}${resource}/:${primaryKey}`,
     method: HTTP_METHODS.PUT,
   },
-  [HANDLERS.AUTOSAVE]: {
+  [HANDLERS.PATCH]: {
     url: (prefix, parentUrl, resource, primaryKey) =>
-      `/${prefix}/${parentUrl}${resource}/:${primaryKey}/autosave`,
-    method: HTTP_METHODS.PUT,
+      `/${prefix}/${parentUrl}${resource}/:${primaryKey}`,
+    method: HTTP_METHODS.PATCH,
   },
   [HANDLERS.DELETE]: {
     url: (prefix, parentUrl, resource, primaryKey) =>

package/src/core/Model.js

@@ -1,7 +1,6 @@
 import pluralize from "pluralize";
 import { snakeCase } from "snake-case";
-import { RELATIONSHIPS, HANDLERS } from "./../constants.js";
-const { INSERT, SHOW, UPDATE, PAGINATE, DELETE } = HANDLERS;
+import { RELATIONSHIPS, DEFAULT_HANDLERS } from "./../constants.js";
 
 class Model {
   constructor() {
@@ -25,7 +24,7 @@ class Model {
   }
 
   get handlers() {
-    return [INSERT, SHOW, PAGINATE, UPDATE, DELETE];
+    return [...DEFAULT_HANDLERS];
   }
 
   get middlewares() {

package/src/handlers/all.js

@@ -0,0 +1,73 @@
+import {
+  callHooks,
+  getRelatedData,
+  filterHiddenFields,
+  serializeData,
+  addForeignKeyQuery,
+} from "./helpers.js";
+import { HOOK_FUNCTIONS, HANDLERS } from "./../constants.js";
+import QueryParser from "./../core/QueryParser.js";
+
+export default async (context) => {
+  const { request, response, model, models, trx, relation, parentModel } =
+    context;
+
+  const queryParser = new QueryParser({ model, models });
+
+  // We should parse URL query string to use as condition in Lucid query
+  const conditions = queryParser.get(request.query);
+
+  // Creating a new database query
+  const query = trx.from(model.instance.table);
+
+  // Users should be able to select some fields to show.
+  queryParser.applyFields(query, conditions.fields);
+
+  // Binding parent id if there is.
+  addForeignKeyQuery(request, query, relation, parentModel);
+
+  // Users should be able to filter records
+  queryParser.applyWheres(query, conditions.q);
+
+  await callHooks(model, HOOK_FUNCTIONS.onBeforeAll, {
+    ...context,
+    conditions,
+    query,
+  });
+
+  // User should be able to select sorting fields and types
+  queryParser.applySorting(query, conditions.sort);
+
+  const result = await query;
+
+  // We should try to get related data if there is any
+  await getRelatedData(
+    result.data,
+    conditions.with,
+    model,
+    models,
+    trx,
+    HANDLERS.ALL,
+    request
+  );
+
+  await callHooks(model, HOOK_FUNCTIONS.onAfterAll, {
+    ...context,
+    result,
+    conditions,
+    query,
+  });
+
+  // Serializing the data by the model's serialize method
+  result.data = await serializeData(
+    result.data,
+    model.instance.serialize,
+    HANDLERS.ALL,
+    request
+  );
+
+  // Filtering hidden fields from the response data.
+  filterHiddenFields(result.data, model.instance.hiddens);
+
+  return response.json(result);
+};

package/src/handlers/index.js

@@ -1,8 +1,9 @@
-import autosave from "./autosave.js";
+import all from "./all.js";
+import patch from "./patch.js";
 import store from "./store.js";
 import show from "./show.js";
 import paginate from "./paginate.js";
 import update from "./update.js";
 import destroy from "./destroy.js";
 
-export default { autosave, store, show, paginate, update, destroy };
+export default { all, patch, store, show, paginate, update, destroy };

package/src/handlers/{autosave.js → patch.js}

@@ -84,7 +84,7 @@ export default async (context) => {
   item = await serializeData(
     item,
     model.instance.serialize,
-    HANDLERS.AUTOSAVE,
+    HANDLERS.PATCH,
     request
   );
 

package/src/resolvers/setExpressRoutes.js

@@ -166,6 +166,7 @@ const getModelMiddlewares = (model, handler) => {
 
 const getRootPrefix = () => {
   if (Config.Application.prefix) {
+    // NOSONAR
     return Config.Application.prefix.replace(/^\/|\/$/g, "");
   }
   return "api";