axe-api 0.18.0 → 0.19.2

package/.github/workflows/test-integration.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [14.x, 16.x]
+        node-version: [14.x, 16.x, 17.x]
         database: [mysql8, mysql57, "postgres"]
     steps:
       - uses: actions/checkout@v2

package/.github/workflows/test-unit.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [14.x, 16.x]
+        node-version: [14.x, 16.x, 17.x]
     steps:
       - uses: actions/checkout@v2
       - name: Use Node.js ${{ matrix.node-version }}

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # Release Notes
 
+## [0.19.2 (2022-01-22)](https://github.com/axe-api/axe-api/compare/0.19.2...0.19.1)
+
+### Fixed
+
+- Fixed the calling `onBeforePaginate` and `onBeforeShow` hooks bug.
+
+## [0.19.1 (2022-01-22)](https://github.com/axe-api/axe-api/compare/0.19.1...0.19.0)
+
+### Fixed
+
+- knex.js version update.
+
+## [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
+
+- [#117](https://github.com/axe-api/axe-api/issues/117)
+
 ## [0.18.0 (2021-11-30)](https://github.com/axe-api/axe-api/compare/0.18.0...0.17.5)
 
 ### Fixed

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "axe-api",
-  "version": "0.18.0",
+  "version": "0.19.2",
   "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",
@@ -20,37 +20,37 @@
   },
   "dependencies": {
     "change-case": "^4.1.2",
-    "dotenv": "^10.0.0",
-    "express": "^4.17.1",
-    "knex": "^0.95.12",
+    "dotenv": "^14.2.0",
+    "express": "^4.17.2",
+    "knex": "^1.0.1",
     "knex-paginate": "^3.0.0",
-    "knex-schema-inspector": "^1.6.4",
+    "knex-schema-inspector": "^1.7.1",
     "pluralize": "^8.0.0",
     "validatorjs": "^3.22.1"
   },
   "devDependencies": {
-    "@babel/cli": "^7.14.8",
-    "@babel/core": "^7.14.8",
-    "@babel/node": "^7.14.7",
-    "@babel/preset-env": "^7.14.8",
-    "@babel/runtime": "^7.14.8",
-    "babel-jest": "^27.0.6",
-    "babel-loader": "^8.2.2",
+    "@babel/cli": "^7.16.8",
+    "@babel/core": "^7.16.10",
+    "@babel/node": "^7.16.8",
+    "@babel/preset-env": "^7.16.11",
+    "@babel/runtime": "^7.16.7",
+    "babel-jest": "^27.4.6",
+    "babel-loader": "^8.2.3",
     "babel-plugin-module-resolver": "^4.1.0",
     "babel-preset-minify": "^0.5.1",
     "eslint": "^7.31.0",
     "eslint-config-standard": "^16.0.3",
-    "eslint-plugin-import": "^2.23.4",
+    "eslint-plugin-import": "^2.25.4",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^5.1.0",
     "eslint-plugin-standard": "^5.0.0",
     "eslint-plugin-unicorn": "^33.0.1",
     "eslint-watch": "^7.0.0",
-    "jest": "^27.0.6",
+    "jest": "^27.4.7",
     "mysql": "^2.18.1",
-    "nodemon": "^2.0.12",
-    "pg": "^8.6.0",
-    "set-value": ">=4.0.0",
+    "nodemon": "^2.0.15",
+    "pg": "^8.7.1",
+    "set-value": ">=4.1.0",
     "sqlite3": "^5.0.2"
   }
 }

package/readme.md

@@ -23,21 +23,98 @@
   </a>
 </h1>
 
-> This project is under development and not ready for production.
+The fastest way to create Rest API, by defining database models and relations.
 
-Fastest way to create simple Rest API by defining database models and relations.
+> Axe API has great documentation. Please [check it out in here](https://axe-api.github.io/).
 
-## Key Features
+## What Is Axe API?
 
-- Automatic route creating
-- Automatic route handling
-- Form validation support
-- Middlewares
-- Strong query features
-- Recursive resources
-- The extendable business logic structure
-- Multiple database support (Postgres, MSSQL, MySQL, MariaDB, SQLite3, Oracle, and Amazon Redshift)
-- Well documented
+**Axe API** is the _fastest_ way to create **Rest API** by defining only database models and relationships between them. It is built on [Knex.js](http://knexjs.org), and its awesome active records pattern. On the other hand, you have another familiar thing, [Express](https://expressjs.com/).
+
+You are going to be able to develop an API **10 times faster** with **Axe API**!
+
+## How It Works?
+
+[Express](https://expressjs.com/) and [Knex.js](http://knexjs.org) are great tools to create [Node.js](https://nodejs.org) based applications. But usually, we code too much the same things to design an API. We aim to reduce code duplication and give you speed by using Axe API.
+
+Axe API provides you the ability to separate your common tasks to build an API from your business logic. **Axe API** expects model definitions to analyze your routing structure. After you created your models and their relations between them, Axe API can handle all _well-known_ API requests. Creating an API with 5 tables takes almost 15 minutes.
+
+Shortly, **Axe API** performs three basic functions;
+
+- **Analyzes** your models and their relationships to create routes.
+- **Handles** all HTTP requests.
+- **Separate** your business logic from API best practices.
+
+Let's assume that you have a model like this;
+
+```js
+import { Model } from "axe-api";
+
+class User extends Model {}
+```
+
+With this model, you will have all of the basic API routes for **User** resources. **Axe API** will create **CRUD** routes for you in the _booting_ process and these routes would be completely ready to be handled and processed by Axe API. The following routes will be handled automatically;
+
+- `POST api/users`
+- `GET api/users`
+- `GET api/users/:id`
+- `PUT api/users/:id`
+- `DELETE api/users/:id`
+
+This is the magic of **Axe API**!
+
+## Installation
+
+Using **Axe API** in an application is very easy. We've created a CLI tool for you; [axe-magic](https://github.com/axe-api/axe-magic).
+
+You can create a new Axe API project by using [axe-magic](https://github.com/axe-api/axe-magic). But first, you can install it in your development environment. When you installed it, you can be able to access **axe-magic** command via CLI. You can use the following command to install **axe-magic** to your machine;
+
+```bash
+$ npm i -g axe-magic
+$ axe-magic --version
+1.0.0
+```
+
+After that, creating a new project is very easy. Just you can execute the following command;
+
+```bash
+$ axe-magic new my-api
+```
+
+This command will pull [axe-api-template](https://github.com/axe-api/axe-api-template) project to your current directory with a new name, **my-api**.
+
+To install your project's depencies, you can execute the following commands in the root directory;
+
+```bash
+$ cd my-api
+$ npm install
+```
+
+To serve this application, you can execute the following command;
+
+```bash
+$ npm run start:dev
+```
+
+> `start:dev` command use [nodemon](https://www.npmjs.com/package/nodemon). If you haven't installed it yet, we suggest you install it first.
+
+After that, your first **Axe API** application will be running in `localhost:3000`.
+
+You will see the following API response if you visit [localhost:3000](http://localhost:3000).
+
+```json
+{
+  "name": "AXE API",
+  "description": "The best API creation tool in the world.",
+  "aim": "To kill them all!"
+}
+```
+
+If you can see that response, it means that your project is running properly.
+
+## Documentation
+
+Axe API has great documentation. Please [check it out in here](https://axe-api.github.io/).
 
 ## How To Run Integration Tests
 

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/paginate.js

@@ -26,15 +26,15 @@ export default async (context) => {
   // 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.onBeforePaginate, {
     ...context,
     conditions,
     query,
   });
 
+  // Users should be able to filter records
+  queryParser.applyWheres(query, conditions.q);
+
   // User should be able to select sorting fields and types
   queryParser.applySorting(query, conditions.sort);
 

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/handlers/show.js

@@ -26,9 +26,6 @@ export default async (context) => {
   // If there is a relation, we should bind it
   addForeignKeyQuery(request, query, relation, parentModel);
 
-  // Users should be able to filter records
-  queryParser.applyWheres(query, conditions.q);
-
   // We should add this condition in here because of performance.
   query.where(
     model.instance.primaryKey,
@@ -41,6 +38,9 @@ export default async (context) => {
     conditions,
   });
 
+  // Users should be able to filter records
+  queryParser.applyWheres(query, conditions.q);
+
   let item = await query.first();
   if (!item) {
     throw new HttpResponse(404, {

package/src/handlers/store.js

@@ -43,9 +43,14 @@ export default async (context) => {
     formData,
   });
 
-  let [insertedPrimaryKeyValue] = await trx(model.instance.table)
+  const [returningResult] = await trx(model.instance.table)
     .insert(formData)
-    .returning("id");
+    .returning(model.instance.primaryKey);
+
+  let insertedPrimaryKeyValue =
+    typeof returningResult === "number"
+      ? returningResult
+      : returningResult[model.instance.primaryKey];
 
   // If the user use a special primary key value, we should use that value
   if (insertedPrimaryKeyValue === 0) {

package/src/resolvers/setExpressRoutes.js

@@ -1,6 +1,6 @@
 import IoC from "./../core/IoC.js";
 import pluralize from "pluralize";
-import { paramCase } from "change-case";
+import { paramCase, camelCase } from "change-case";
 import { RELATIONSHIPS, API_ROUTE_TEMPLATES } from "./../constants.js";
 import Handlers from "./../handlers/index.js";
 
@@ -122,7 +122,7 @@ const createNestedRoutes = async (
   await createRouteByModel(
     model,
     models,
-    `${urlPrefix}${resource}/:${getPrimaryKeyName(model)}/`,
+    `${urlPrefix}${resource}/:${camelCase(relation.foreignKey)}/`,
     model,
     relation,
     false
@@ -164,11 +164,19 @@ const getModelMiddlewares = (model, handler) => {
   return middlewares;
 };
 
-const getRootPrefix = () => {
-  if (Config.Application.prefix) {
-    return Config.Application.prefix.replace(/^\/|\/$/g, "");
+export const getRootPrefix = async () => {
+  const config = await IoC.use("Config");
+  let prefix = config?.Application?.prefix || "api";
+
+  if (prefix.substr(0, 1) === "/") {
+    prefix = prefix.substr(1);
+  }
+
+  if (prefix.substr(prefix.length - 1) === "/") {
+    prefix = prefix.substr(0, prefix.length - 1);
   }
-  return "api";
+
+  return prefix;
 };
 
 const createRouteByModel = async (
@@ -208,7 +216,7 @@ const createRouteByModel = async (
 
     const routeTemplate = API_ROUTE_TEMPLATES[handler];
     const url = routeTemplate.url(
-      getRootPrefix(),
+      await getRootPrefix(),
       urlPrefix,
       resource,
       model.instance.primaryKey