axe-api 0.19.0 → 0.19.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Release Notes
 
+## [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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "axe-api",
-  "version": "0.19.0",
+  "version": "0.19.1",
   "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/handlers/store.js

@@ -43,10 +43,15 @@ export default async (context) => {
     formData,
   });
 
-  let [insertedPrimaryKeyValue] = await trx(model.instance.table)
+  const [returningResult] = await trx(model.instance.table)
     .insert(formData)
     .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) {
     insertedPrimaryKeyValue = formData[model.instance.primaryKey];

package/src/resolvers/setExpressRoutes.js

@@ -164,12 +164,19 @@ const getModelMiddlewares = (model, handler) => {
   return middlewares;
 };
 
-const getRootPrefix = () => {
-  if (Config.Application.prefix) {
-    // NOSONAR
-    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 (
@@ -209,7 +216,7 @@ const createRouteByModel = async (
 
     const routeTemplate = API_ROUTE_TEMPLATES[handler];
     const url = routeTemplate.url(
-      getRootPrefix(),
+      await getRootPrefix(),
       urlPrefix,
       resource,
       model.instance.primaryKey