axe-api 0.17.5 → 0.18.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Release Notes
 
+## [0.18.0 (2021-11-30)](https://github.com/axe-api/axe-api/compare/0.18.0...0.17.5)
+
+### Fixed
+
+- [#115](https://github.com/axe-api/axe-api/issues/115)
+- [#114](https://github.com/axe-api/axe-api/issues/114)
+
+### Enhancements
+
+- [#113](https://github.com/axe-api/axe-api/issues/113)
+- [#107](https://github.com/axe-api/axe-api/issues/107)
+- [#108](https://github.com/axe-api/axe-api/issues/108)
+
 ## [0.17.5 (2021-11-27)](https://github.com/axe-api/axe-api/compare/0.17.5...0.17.4)
 
 ### Fixed

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "axe-api",
-  "version": "0.17.5",
+  "version": "0.18.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

@@ -72,31 +72,31 @@ const HTTP_METHODS = {
 
 const API_ROUTE_TEMPLATES = {
   [HANDLERS.INSERT]: {
-    url: (parentUrl, resource) => `/api/${parentUrl}${resource}`,
+    url: (prefix, parentUrl, resource) => `/${prefix}/${parentUrl}${resource}`,
     method: HTTP_METHODS.POST,
   },
   [HANDLERS.PAGINATE]: {
-    url: (parentUrl, resource) => `/api/${parentUrl}${resource}`,
+    url: (prefix, parentUrl, resource) => `/${prefix}/${parentUrl}${resource}`,
     method: HTTP_METHODS.GET,
   },
   [HANDLERS.SHOW]: {
-    url: (parentUrl, resource, primaryKey) =>
-      `/api/${parentUrl}${resource}/:${primaryKey}`,
+    url: (prefix, parentUrl, resource, primaryKey) =>
+      `/${prefix}/${parentUrl}${resource}/:${primaryKey}`,
     method: HTTP_METHODS.GET,
   },
   [HANDLERS.UPDATE]: {
-    url: (parentUrl, resource, primaryKey) =>
-      `/api/${parentUrl}${resource}/:${primaryKey}`,
+    url: (prefix, parentUrl, resource, primaryKey) =>
+      `/${prefix}/${parentUrl}${resource}/:${primaryKey}`,
     method: HTTP_METHODS.PUT,
   },
   [HANDLERS.AUTOSAVE]: {
-    url: (parentUrl, resource, primaryKey) =>
-      `/api/${parentUrl}${resource}/:${primaryKey}/autosave`,
+    url: (prefix, parentUrl, resource, primaryKey) =>
+      `/${prefix}/${parentUrl}${resource}/:${primaryKey}/autosave`,
     method: HTTP_METHODS.PUT,
   },
   [HANDLERS.DELETE]: {
-    url: (parentUrl, resource, primaryKey) =>
-      `/api/${parentUrl}${resource}/:${primaryKey}`,
+    url: (prefix, parentUrl, resource, primaryKey) =>
+      `/${prefix}/${parentUrl}${resource}/:${primaryKey}`,
     method: HTTP_METHODS.DELETE,
   },
 };

package/src/core/QueryParser.js

@@ -1,31 +1,13 @@
 import HttpResponse from "./../core/HttpResponse.js";
 import { RELATIONSHIPS } from "../constants.js";
 
-const DEFAULT_OPTIONS = {
-  min_per_page: 1,
-  max_per_page: 1000,
-};
-
 class QueryParser {
-  constructor({ model, models, options = {} }) {
+  constructor({ model, models }) {
     this.model = model;
     this.models = models;
     this.createdJoins = [];
     this.relationColumns = [];
     this.usedConditionColumns = new Set();
-    this.options = { ...DEFAULT_OPTIONS, ...options };
-
-    if (isNaN(this.options.min_per_page) || this.options.min_per_page < 1) {
-      throw new Error(
-        `You set unacceptable query parse option (min_per_page): ${this.options.min_per_page}`
-      );
-    }
-
-    if (isNaN(this.options.max_per_page) || this.options.max_per_page > 10000) {
-      throw new Error(
-        `You set unacceptable query parse option (max_per_page): ${this.options.max_per_page}`
-      );
-    }
   }
 
   applyFields(query, fields) {
@@ -109,10 +91,9 @@ class QueryParser {
     });
 
     if (undefinedColumns.length > 0) {
-      throw new HttpResponse(
-        400,
-        `Undefined column names: ${undefinedColumns.join(",")}`
-      );
+      throw new HttpResponse(400, {
+        message: `Undefined column names: ${undefinedColumns.join(",")}`,
+      });
     }
 
     return conditions;
@@ -215,7 +196,9 @@ class QueryParser {
       try {
         sections.q = JSON.parse(queryContent);
       } catch (err) {
-        throw new Error(`Unacceptable query string: \n ${queryContent}`);
+        throw new HttpResponse(400, {
+          message: `Unacceptable query string: ${queryContent}`,
+        });
       }
     }
 
@@ -247,16 +230,8 @@ class QueryParser {
   _parsePerPage(content) {
     const value = parseInt(content);
 
-    if (isNaN(value)) {
-      return this.options.min_per_page;
-    }
-
-    if (value <= this.options.min_per_page) {
-      return this.options.min_per_page;
-    }
-
-    if (value > this.options.max_per_page) {
-      return this.options.max_per_page;
+    if (isNaN(value) || value <= 1 || value > 10000) {
+      return 10;
     }
 
     return value;
@@ -325,19 +300,24 @@ class QueryParser {
       return null;
     }
 
+    const wheres = [];
+    for (const key in content) {
+      wheres.push(this._parseConditionObject(content, key));
+    }
+
+    return wheres;
+  }
+
+  _parseConditionObject(content, key) {
     const where = {
       prefix: null,
       model: this.model,
       table: this.model.instance.table,
-      field: null,
+      field: key,
       condition: "=",
-      value: null,
+      value: content[key],
     };
 
-    const key = Object.keys(content)[0];
-    where.field = key;
-    where.value = content[key];
-
     // Sometimes we can have basic OR operations for queries
     if (where.field.indexOf("$or.") === 0) {
       where.prefix = "or";
@@ -349,19 +329,30 @@ class QueryParser {
       where.field = where.field.replace("$and.", "");
     }
 
-    this._applySpecialCondition(where, "$not", "<>");
-    this._applySpecialCondition(where, "$gt", ">");
-    this._applySpecialCondition(where, "$gte", ">=");
-    this._applySpecialCondition(where, "$lt", "<");
-    this._applySpecialCondition(where, "$lte", "<=");
-    this._applySpecialCondition(where, "$like", "LIKE");
-    this._applySpecialCondition(where, "$notLike", "NOT LIKE");
-    this._applySpecialCondition(where, "$in", "In");
-    this._applySpecialCondition(where, "$notIn", "NotIn");
-    this._applySpecialCondition(where, "$between", "Between");
-    this._applySpecialCondition(where, "$notBetween", "NotBetween");
-    this._applySpecialCondition(where, "$null", "Null");
-    this._applySpecialCondition(where, "$notNull", "NotNull");
+    // If there is not any value, it means that we should check nullable values
+    if (where.value === null) {
+      // If the client wants to see not nullable values
+      if (this._hasSpecialStructure(where.field, ".$not")) {
+        where.field = where.field.replace(".$not", "");
+        where.condition = "NotNull";
+      } else {
+        // So, it means that the clients wants to see null valus
+        where.condition = "Null";
+      }
+    } else {
+      // If there is value, we should check it
+      this._applySpecialCondition(where, "$not", "<>");
+      this._applySpecialCondition(where, "$gt", ">");
+      this._applySpecialCondition(where, "$gte", ">=");
+      this._applySpecialCondition(where, "$lt", "<");
+      this._applySpecialCondition(where, "$lte", "<=");
+      this._applySpecialCondition(where, "$like", "LIKE");
+      this._applySpecialCondition(where, "$notLike", "NOT LIKE");
+      this._applySpecialCondition(where, "$in", "In");
+      this._applySpecialCondition(where, "$notIn", "NotIn");
+      this._applySpecialCondition(where, "$between", "Between");
+      this._applySpecialCondition(where, "$notBetween", "NotBetween");
+    }
 
     if (where.condition === "In" || where.condition === "NotIn") {
       where.value = where.value.split(",");
@@ -371,10 +362,6 @@ class QueryParser {
       where.value = where.value.split(":");
     }
 
-    if (where.condition === "Null" || where.condition === "NotNull") {
-      where.value = null;
-    }
-
     if (where.condition === "LIKE" || where.condition === "NOT LIKE") {
       where.value = where.value.replace(/\*/g, "%");
     }
@@ -389,7 +376,9 @@ class QueryParser {
       );
 
       if (!relation) {
-        throw new Error(`Unacceptable query field: ${relationName}.${field}`);
+        throw new HttpResponse(400, {
+          message: `Unacceptable query field: ${relationName}.${field}`,
+        });
       }
 
       const relatedModel = this.models.find(
@@ -397,7 +386,9 @@ class QueryParser {
       );
 
       if (!relatedModel) {
-        throw new Error(`Undefined model name: ${relation.model}`);
+        throw new HttpResponse(400, {
+          message: `Undefined model name: ${relation.model}`,
+        });
       }
 
       where.model = relatedModel;
@@ -504,7 +495,9 @@ class QueryParser {
         (i) => i.name === item.relationship
       );
       if (!relation) {
-        throw new Error(`Undefined relation: ${item.relationship}`);
+        throw new HttpResponse(400, {
+          message: `Undefined relation: ${item.relationship}`,
+        });
       }
 
       this.relationColumns.push(
@@ -535,11 +528,15 @@ class QueryParser {
   _shouldBeAcceptableColumn(field) {
     const regex = /^[0-9,a-z,A-Z_.]+$/;
     if (!field.match(regex)) {
-      throw new Error(`Unacceptable field name: ${field}`);
+      throw new HttpResponse(400, {
+        message: `Unacceptable field name: ${field}`,
+      });
     }
 
     if (field.indexOf(".") === 0 || field.indexOf(".") === field.length - 1) {
-      throw new Error(`You have to define the column specefically: ${field}`);
+      throw new HttpResponse(400, {
+        message: `You have to define the column specefically: ${field}`,
+      });
     }
   }
 }

package/src/handlers/autosave.js

@@ -11,6 +11,7 @@ import {
 import Validator from "validatorjs";
 import { HOOK_FUNCTIONS, TIMESTAMP_COLUMNS } from "./../constants.js";
 import HttpResponse from "./../core/HttpResponse.js";
+import { HANDLERS } from "./../constants.js";
 
 export default async (context) => {
   const { request, response, model, trx, relation, parentModel } = context;
@@ -29,7 +30,9 @@ export default async (context) => {
     .where(model.instance.primaryKey, request.params[model.instance.primaryKey])
     .first();
   if (!item) {
-    throw new HttpResponse(404, `The item is not found on ${model.name}.`);
+    throw new HttpResponse(404, {
+      message: `The item is not found on ${model.name}.`,
+    });
   }
 
   await callHooks(model, HOOK_FUNCTIONS.onAfterUpdateQuery, {
@@ -78,7 +81,12 @@ export default async (context) => {
   });
 
   // Serializing the data by the model's serialize method
-  item = await serializeData(item, model.instance.serialize);
+  item = await serializeData(
+    item,
+    model.instance.serialize,
+    HANDLERS.AUTOSAVE,
+    request
+  );
 
   // Filtering hidden fields from the response data.
   filterHiddenFields([item], model.instance.hiddens);

package/src/handlers/destroy.js

@@ -22,7 +22,9 @@ export default async (context) => {
 
   let item = await query.first();
   if (!item) {
-    throw new HttpResponse(404, `The item is not found on ${model.name}.`);
+    throw new HttpResponse(404, {
+      message: `The item is not found on ${model.name}.`,
+    });
   }
 
   await callHooks(model, HOOK_FUNCTIONS.onAfterDeleteQuery, {

package/src/handlers/helpers.js

@@ -1,7 +1,7 @@
 import { RELATIONSHIPS } from "./../constants.js";
 import { camelCase } from "change-case";
 import HttpResponse from "./../core/HttpResponse.js";
-import IoC from '../core/IoC.js';
+import IoC from "../core/IoC.js";
 
 const getInputFromBody = (body, field) => {
   if (!body) {
@@ -83,7 +83,8 @@ export const getRelatedData = async (
   model,
   models,
   database,
-  handler
+  handler,
+  request
 ) => {
   if (withArray.length === 0) {
     return;
@@ -96,10 +97,9 @@ export const getRelatedData = async (
       (relation) => relation.name === clientQuery.relationship
     );
     if (!definedRelation) {
-      throw new HttpResponse(
-        400,
-        `Undefined relation: ${clientQuery.relationship}`
-      );
+      throw new HttpResponse(400, {
+        message: `Undefined relation: ${clientQuery.relationship}`,
+      });
     }
 
     // Find the foreign model by the relationship
@@ -164,10 +164,9 @@ export const getRelatedData = async (
         (column) => !foreignModel.instance.columnNames.includes(column)
       );
       if (undefinedColumns.length > 0) {
-        throw new HttpResponse(
-          400,
-          `Undefined columns: ${undefinedColumns.join(", ")}`
-        );
+        throw new HttpResponse(400, {
+          message: `Undefined columns: ${undefinedColumns.join(", ")}`,
+        });
       }
     }
 
@@ -189,7 +188,8 @@ export const getRelatedData = async (
     relatedRecords = await serializeData(
       relatedRecords,
       foreignModel.instance.serialize,
-      handler
+      handler,
+      request
     );
 
     // We should hide hidden fields if there is any
@@ -203,7 +203,8 @@ export const getRelatedData = async (
         foreignModel,
         models,
         database,
-        handler
+        handler,
+        request
       );
     }
 
@@ -243,19 +244,19 @@ export const bindTimestampValues = (formData, columnTypes = [], model) => {
   }
 };
 
-const serialize = async (data, callback) => {
+const serialize = async (data, callback, request) => {
   if (!callback) {
     return data;
   }
 
   if (Array.isArray(data)) {
-    return data.map(callback);
+    return data.map((item) => callback(item, request));
   }
 
-  return [data].map(callback)[0];
-}
+  return callback(data, request);
+};
 
-const globalSerializer = async (itemArray, handler) => {
+const globalSerializer = async (itemArray, handler, request) => {
   const { Application } = await IoC.use("Config");
 
   if (!Application.serializers) {
@@ -263,35 +264,43 @@ const globalSerializer = async (itemArray, handler) => {
   }
 
   let callbacks = [];
-  // Push all runable serializer into callbacks. 
-  Application.serializers.map(configSerializer => {
+  // Push all runable serializer into callbacks.
+  Application.serializers.map((configSerializer) => {
     // Serialize data for all requests types.
     if (typeof configSerializer === "function") {
       callbacks.push(configSerializer);
-      return
+      return;
     }
 
     // Serialize data with specific handler like "PAGINATE" or "SHOW".
-    if (typeof configSerializer === "object" && configSerializer.handler.includes(handler)) {
+    if (
+      typeof configSerializer === "object" &&
+      configSerializer.handler.includes(handler)
+    ) {
       // Handle multiple serializer.
       if (Array.isArray(configSerializer.serializer)) {
-        configSerializer.serializer.forEach(fn => callbacks.push(fn));
-        return
+        configSerializer.serializer.forEach((fn) => callbacks.push(fn));
+        return;
       }
-      callbacks.push(configSerializer.serializer)
-      return
+      callbacks.push(configSerializer.serializer);
+      return;
     }
-  })
+  });
 
   while (callbacks.length !== 0) {
-    itemArray = await serialize(itemArray, callbacks.shift());
+    itemArray = serialize(itemArray, callbacks.shift(), request);
   }
   return itemArray;
 };
 
-export const serializeData = async (itemArray, modelSerializer, handler) => {
-  itemArray = await serialize(itemArray, modelSerializer);
-  itemArray = await globalSerializer(itemArray, handler);
+export const serializeData = async (
+  itemArray,
+  modelSerializer,
+  handler,
+  request
+) => {
+  itemArray = serialize(itemArray, modelSerializer, request);
+  itemArray = await globalSerializer(itemArray, handler, request);
   return itemArray;
 };
 

package/src/handlers/paginate.js

@@ -45,7 +45,15 @@ export default async (context) => {
   });
 
   // We should try to get related data if there is any
-  await getRelatedData(result.data, conditions.with, model, models, trx, HANDLERS.PAGINATE);
+  await getRelatedData(
+    result.data,
+    conditions.with,
+    model,
+    models,
+    trx,
+    HANDLERS.PAGINATE,
+    request
+  );
 
   await callHooks(model, HOOK_FUNCTIONS.onAfterPaginate, {
     ...context,
@@ -55,7 +63,12 @@ export default async (context) => {
   });
 
   // Serializing the data by the model's serialize method
-  result.data = await serializeData(result.data, model.instance.serialize, HANDLERS.PAGINATE);
+  result.data = await serializeData(
+    result.data,
+    model.instance.serialize,
+    HANDLERS.PAGINATE,
+    request
+  );
 
   // Filtering hidden fields from the response data.
   filterHiddenFields(result.data, model.instance.hiddens);

package/src/handlers/show.js

@@ -43,11 +43,21 @@ export default async (context) => {
 
   let item = await query.first();
   if (!item) {
-    throw new HttpResponse(404, `The item is not found on ${model.name}.`);
+    throw new HttpResponse(404, {
+      message: `The item is not found on ${model.name}.`,
+    });
   }
 
   // We should try to get related data if there is any
-  await getRelatedData([item], conditions.with, model, models, trx, HANDLERS.SHOW);
+  await getRelatedData(
+    [item],
+    conditions.with,
+    model,
+    models,
+    trx,
+    HANDLERS.SHOW,
+    request
+  );
 
   await callHooks(model, HOOK_FUNCTIONS.onAfterShow, {
     ...context,
@@ -57,7 +67,12 @@ export default async (context) => {
   });
 
   // Serializing the data by the model's serialize method
-  item = await serializeData(item, model.instance.serialize, HANDLERS.SHOW);
+  item = await serializeData(
+    item,
+    model.instance.serialize,
+    HANDLERS.SHOW,
+    request
+  );
 
   // Filtering hidden fields from the response data.
   filterHiddenFields([item], model.instance.hiddens);

package/src/handlers/store.js

@@ -63,7 +63,12 @@ export default async (context) => {
   });
 
   // Serializing the data by the model's serialize method
-  item = await serializeData(item, model.instance.serialize, HANDLERS.INSERT);
+  item = await serializeData(
+    item,
+    model.instance.serialize,
+    HANDLERS.INSERT,
+    request
+  );
 
   // Filtering hidden fields from the response data.
   filterHiddenFields([item], model.instance.hiddens);

package/src/handlers/update.js

@@ -28,7 +28,9 @@ export default async (context) => {
     .where(model.instance.primaryKey, request.params[model.instance.primaryKey])
     .first();
   if (!item) {
-    throw new HttpResponse(404, `The item is not found on ${model.name}.`);
+    throw new HttpResponse(404, {
+      message: `The item is not found on ${model.name}.`,
+    });
   }
 
   await callHooks(model, HOOK_FUNCTIONS.onAfterUpdateQuery, {
@@ -76,7 +78,12 @@ export default async (context) => {
   });
 
   // Serializing the data by the model's serialize method
-  item = await serializeData(item, model.instance.serialize, HANDLERS.UPDATE);
+  item = await serializeData(
+    item,
+    model.instance.serialize,
+    HANDLERS.UPDATE,
+    request
+  );
 
   // Filtering hidden fields from the response data.
   filterHiddenFields([item], model.instance.hiddens);

package/src/resolvers/setExpressRoutes.js

@@ -54,6 +54,10 @@ const requestHandler = async (handler, req, res, next, context) => {
       await context.trx.rollback();
     }
 
+    if (error.type === "HttpResponse") {
+      return res.status(error.status).json(error.content);
+    }
+
     next(error);
   }
 };
@@ -160,6 +164,13 @@ const getModelMiddlewares = (model, handler) => {
   return middlewares;
 };
 
+const getRootPrefix = () => {
+  if (Config.Application.prefix) {
+    return Config.Application.prefix.replace(/^\/|\/$/g, "");
+  }
+  return "api";
+};
+
 const createRouteByModel = async (
   model,
   models,
@@ -197,6 +208,7 @@ const createRouteByModel = async (
 
     const routeTemplate = API_ROUTE_TEMPLATES[handler];
     const url = routeTemplate.url(
+      getRootPrefix(),
       urlPrefix,
       resource,
       model.instance.primaryKey