axe-api 0.20.0-rc9 → 0.20.0

package/CHANGELOG.md

@@ -0,0 +1,182 @@
+# Release Notes
+
+## [0.20.0 (2022-12-24)](https://github.com/axe-api/axe-api/compare/0.20.0...0.19.2)
+
+In the whole application, TypeScript becomes the new language except for migration files and it's structure. You can read the documentation about how to migrate from `0.19.2` to `0.20.0`.
+
+### Breaking Changes
+
+#### Naming Changes
+
+- File extensions: `User.js` to `User.ts`
+- `LOG_LEVELS` constant variable has been changed with `LogLevels` enum.
+- `HANDLERS` constant variable has been changed with `HandlerTypes` enum.
+- `IoC` service has been renamed as `IoCService`.
+- Hooks and Event files' names should be singular;
+  - `UserHooks.js` => `UserHook.ts`
+  - `UserEvents.js` => `UserEvent.ts`
+
+#### Interface Changes
+
+- `validations()` getter should return `IMethodBaseValidations` interface.
+- In hook functions, `IHookParameter` interface should be used as the parameter type.
+- Init functions (`onBeforeInit`, `onAfterInit`) should be use the `Express` type;
+  - `const onBeforeInit = async ({ app }) => {` => `const onBeforeInit = async (app: Express) => {`
+  - `const onAfterInit = async ({ app }) => {` => `const onAfterInit = async (app: Express) => {`
+- Application config should be implemented `IApplicationConfig` interface.
+
+#### Implementation Changes
+
+- Starting server part has been changed;
+  - `const server = new Server(appFolder)` => `const server = new Server()`
+  - `server.listen()` => `server.start(__dirname);`
+- `knexfile.js` should not use the `app/Application/Config.js` anymore.
+
+## [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
+
+- [#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
+
+- [#111](https://github.com/axe-api/axe-api/issues/111)
+
+## [0.17.4 (2021-10-28)](https://github.com/axe-api/axe-api/compare/0.17.4...0.17.3)
+
+### Fixed
+
+- [#97](https://github.com/axe-api/axe-api/issues/97)
+- [#104](https://github.com/axe-api/axe-api/issues/104)
+
+## [0.17.3 (2021-10-28)](https://github.com/axe-api/axe-api/compare/0.17.3...0.17.2)
+
+### Fixed
+
+- [#98](https://github.com/axe-api/axe-api/issues/98)
+
+## [0.17.2 (2021-10-17)](https://github.com/axe-api/axe-api/compare/0.17.2...0.17.1)
+
+### Fixed
+
+- Fixed table join on the related table filter.
+
+## [0.17.1 (2021-10-17)](https://github.com/axe-api/axe-api/compare/0.17.1...0.17.0)
+
+### Fixed
+
+- Query bug on child models [#93](https://github.com/axe-api/axe-api/issues/93)
+
+## [0.17.0 (2021-10-17)](https://github.com/axe-api/axe-api/compare/0.17.0...0.16.0)
+
+### Fixed
+
+- Related query column name check bug has been fixed.
+
+### Features
+
+- Global serializer for HTTP results [#37](https://github.com/axe-api/axe-api/issues/37)
+
+## [0.16.0 (2021-10-06)](https://github.com/axe-api/axe-api/compare/0.16.0...0.15.0)
+
+### Features
+
+- Fixes [#89](https://github.com/axe-api/axe-api/issues/89)
+
+## [0.15.0 (2021-10-03)](https://github.com/axe-api/axe-api/compare/0.15.0...0.14.1)
+
+### Features
+
+- Fixes [#87](https://github.com/axe-api/axe-api/issues/87)
+
+## [0.14.1 (2021-09-20)](https://github.com/axe-api/axe-api/compare/0.14.1...0.14.0)
+
+### Fixed
+
+- Fixes [#83](https://github.com/axe-api/axe-api/issues/83)
+
+## [0.14.0 (2021-09-15)](https://github.com/axe-api/axe-api/compare/0.14.0...0.13.3)
+
+### Features
+
+- General hooks definition feature has been added. ([#81](https://github.com/axe-api/axe-api/issues/81))
+
+## [0.13.3 (2021-09-15)](https://github.com/axe-api/axe-api/compare/0.13.2...0.13.3)
+
+### Fixed
+
+- Fixed CORS bugs.
+
+## [0.13.2 (2021-08-20)](https://github.com/axe-api/axe-api/compare/0.13.1...0.13.2)
+
+### Fixed
+
+- Fixes [#27](https://github.com/axe-api/axe-api/issues/27)
+- Fixes [#29](https://github.com/axe-api/axe-api/issues/29)
+- Fixes [#75](https://github.com/axe-api/axe-api/issues/75)
+- Fixes [#78](https://github.com/axe-api/axe-api/issues/78)
+
+## [0.13.1 (2021-08-09)](https://github.com/axe-api/axe-api/compare/0.13.0...0.13.1)
+
+### Fixed
+
+- Fixes [#69](https://github.com/axe-api/axe-api/issues/69)
+- Fixes [#70](https://github.com/axe-api/axe-api/issues/70)
+- Fixes [#71](https://github.com/axe-api/axe-api/issues/71)
+- Fixes [#72](https://github.com/axe-api/axe-api/issues/72)
+
+## [0.13.0 (2021-07-25)](https://github.com/axe-api/axe-api/compare/0.12.2...0.13.0)
+
+### Features
+
+- PostgreSQL database analyzer and integration tests have been added.
+
+## [0.12.2 (2021-07-24)](https://github.com/axe-api/axe-api/compare/0.12.1...0.12.2)
+
+### Fixed
+
+- Throwing an error if the primary key column isn't in the database table bug has been fixed. (#61)[https://github.com/axe-api/axe-api/issues/61]
+- Using numeric column name bug has been fixed. (#24)[https://github.com/axe-api/axe-api/issues/24]
+
+## [0.12.1 (2021-07-24)](https://github.com/axe-api/axe-api/compare/0.12.0...0.12.1)
+
+### Fixed
+
+- Fixed security issues.

package/package.json

@@ -1,65 +1,66 @@
-{
-  "name": "axe-api",
-  "version": "0.20.0-rc9",
-  "description": "AXE API is a simple tool which has been created based on Express and Knex.js to create Rest APIs quickly.",
-  "main": "build/index.js",
-  "types": "build/index.d.ts",
-  "files": [
-    "/build"
-  ],
-  "directories": {
-    "test": "tests"
-  },
-  "author": "Özgür Adem Işıklı <i.ozguradem@gmail.com>",
-  "license": "ISC",
-  "scripts": {
-    "build": "tsc",
-    "build:watch": "tsc -w",
-    "dev": "ts-node-dev --respawn --clear index.ts",
-    "test": "jest --runInBand",
-    "test:dev": "jest --watch",
-    "lint": "eslint src/**",
-    "lint:watch": "esw --watch --color",
-    "test:integration:mysql8": "cd ./tests/integrations && node index.js mysql8",
-    "test:integration:mysql57": "cd ./tests/integrations && node index.js mysql57",
-    "test:integration:postgres": "cd ./tests/integrations && node index.js postgres"
-  },
-  "dependencies": {
-    "@types/express": "^4.17.13",
-    "change-case": "^4.1.2",
-    "dotenv": "^14.2.0",
-    "express": "^4.17.2",
-    "http-status-codes": "^2.2.0",
-    "knex": "^1.0.1",
-    "knex-paginate": "^3.0.0",
-    "knex-schema-inspector": "^1.7.1",
-    "pluralize": "^8.0.0",
-    "validatorjs": "^3.22.1"
-  },
-  "devDependencies": {
-    "@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",
-    "@types/pluralize": "^0.0.29",
-    "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.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.4.7",
-    "mysql": "^2.18.1",
-    "nodemon": "^2.0.15",
-    "pg": "^8.7.1",
-    "set-value": ">=4.1.0",
-    "sqlite3": "^5.0.2"
-  }
-}
+{
+  "name": "axe-api",
+  "version": "0.20.0",
+  "description": "AXE API is a simple tool which has been created based on Express and Knex.js to create Rest APIs quickly.",
+  "main": "build/index.js",
+  "types": "build/index.d.ts",
+  "files": [
+    "/build"
+  ],
+  "directories": {
+    "test": "tests"
+  },
+  "author": "Özgür Adem Işıklı <i.ozguradem@gmail.com>",
+  "license": "MIT",
+  "scripts": {
+    "build": "tsc",
+    "build:watch": "tsc -w",
+    "dev": "ts-node-dev --respawn --clear index.ts",
+    "test": "jest --runInBand",
+    "test:dev": "jest --watch",
+    "lint": "eslint src/**",
+    "lint:watch": "esw --watch --color",
+    "prepare:integration": "nodemon --ignore \"./tests/**\" ./scripts/run-integration-test.js",
+    "test:integration:mysql8": "cd ./tests/integrations && node index.js mysql8",
+    "test:integration:mysql57": "cd ./tests/integrations && node index.js mysql57",
+    "test:integration:postgres": "cd ./tests/integrations && node index.js postgres"
+  },
+  "dependencies": {
+    "@types/express": "^4.17.15",
+    "change-case": "^4.1.2",
+    "dotenv": "^14.2.0",
+    "express": "^4.18.2",
+    "http-status-codes": "^2.2.0",
+    "knex": "^2.3.0",
+    "knex-paginate": "^3.0.2",
+    "knex-schema-inspector": "^2.0.4",
+    "pluralize": "^8.0.0",
+    "validatorjs": "^3.22.1"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.19.1",
+    "@babel/preset-env": "^7.19.1",
+    "@babel/preset-typescript": "^7.18.6",
+    "@types/pluralize": "^0.0.29",
+    "@types/validatorjs": "^3.15.0",
+    "@typescript-eslint/eslint-plugin": "^5.37.0",
+    "@typescript-eslint/parser": "^5.37.0",
+    "babel-jest": "^29.0.3",
+    "eslint": "^7.32.0",
+    "eslint-config-standard": "^16.0.3",
+    "eslint-plugin-import": "^2.25.4",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-promise": "^5.1.0",
+    "eslint-plugin-unicorn": "^33.0.1",
+    "eslint-watch": "^7.0.0",
+    "glob": "^8.0.3",
+    "jest": "^29.0.3",
+    "mysql": "^2.18.1",
+    "nodemon": "^2.0.15",
+    "pg": "^8.7.1",
+    "set-value": ">=4.1.0",
+    "sqlite3": "^5.0.2",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.8.3"
+  }
+}

package/readme.md

@@ -1,152 +1,174 @@
-<h1 align="center">
-  <br>
-  <a href="https://axe-api.github.io/">
-    <img src="https://axe-api.github.io/logo.png" alt="Markdownify" width="200">
-  </a>
-  <br>
-  Axe API
-  <br>
-  <a href="https://badge.fury.io/js/axe-api">
-    <img src="https://badge.fury.io/js/axe-api.svg" alt="npm version" height="18">
-  </a>
-  <a href="https://github.com/axe-api/axe-api/actions/workflows/npm-publish.yml" target="_blank">
-    <img src="https://github.com/axe-api/axe-api/actions/workflows/npm-publish.yml/badge.svg?branch=master">
-  </a>
-  <a href="https://sonarcloud.io/dashboard?id=axe-api_axe-api" target="_blank">
-    <img src="https://sonarcloud.io/api/project_badges/measure?project=axe-api_axe-api&metric=alert_status">
-  </a>
-  <a href="https://github.com/axe-api/axe-api/issues" target="_blank">
-    <img src="https://img.shields.io/github/issues/axe-api/axe-api.svg">
-  </a>
-  <a href="https://opensource.org/licenses/MIT" target="_blank">
-    <img src="https://img.shields.io/badge/license-MIT-blue.svg">
-  </a>
-</h1>
-
-The fastest way to create Rest API, by defining database models and relations.
-
-> Axe API has great documentation. Please [check it out in here](https://axe-api.github.io/).
-
-## What Is Axe API?
-
-**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
-
-> You have to have **Docker** and **Docker Compose** on your local development environment to run integration tests.
-
-Execute the following commands to prepare the integration app
-
-```sh
-cd tests/integrations && npm install && npm ci && npm run build --if-present
-```
-
-Execute the following commands to prepare the database;
-
-```sh
-docker-compose -f "./tests/integrations/docker-compose.mysql8.yml" up -d --build
-```
-
-> To down the database, you can use the following command; `docker-compose -f "./tests/integrations/docker-compose.mysql8.yml" up -d --build`
-
-You can execute the following command to execute tests;
-
-```sh
-npm run test:integration:mysql8
-```
-
-## License
-
-[MIT License](LICENSE)
-
-## Prerelease
-
-- Update package.json, set version to a prerelease version, e.g. 2.0.0-rc1, 3.1.5-rc4, ...
-- Run npm pack to create package
-- Run npm publish <package>.tgz --tag next to publish the package under the next tag
-- Run npm install --save package@next to install prerelease package
+<h1 align="center">
+  <br>
+  <a href="https://axe-api.github.io/">
+    <img src="https://axe-api.github.io/axe.png" alt="Markdownify" width="200">
+  </a>
+  <br>
+  Axe API
+  <br>
+  <a href="https://badge.fury.io/js/axe-api">
+    <img src="https://badge.fury.io/js/axe-api.svg" alt="npm version" height="18">
+  </a>
+  <a href="https://github.com/axe-api/axe-api/actions/workflows/npm-publish.yml" target="_blank">
+    <img src="https://github.com/axe-api/axe-api/actions/workflows/npm-publish.yml/badge.svg?branch=master">
+  </a>
+  <a href="https://sonarcloud.io/dashboard?id=axe-api_axe-api" target="_blank">
+    <img src="https://sonarcloud.io/api/project_badges/measure?project=axe-api_axe-api&metric=alert_status">
+  </a>
+  <a href="https://github.com/axe-api/axe-api/issues" target="_blank">
+    <img src="https://img.shields.io/github/issues/axe-api/axe-api.svg">
+  </a>
+  <a href="https://opensource.org/licenses/MIT" target="_blank">
+    <img src="https://img.shields.io/badge/license-MIT-blue.svg">
+  </a>
+</h1>
+
+Next Generation Rest API Framework
+
+> Axe API has great documentation. Please [check it out in here](https://axe-api.github.io/).
+
+## What Is Axe API?
+
+Axe API is a [Node.js](https://nodejs.org/) framework that helps you create a **Rest API** in a declarative way quickly. :axe:
+
+It has been written with [TypeScript](https://www.typescriptlang.org/) and built on [Express](https://expressjs.com/) and [Knex.js](https://knexjs.org/).
+
+## Motivation
+
+You would understand easily what you are going to code when you look at a bunch of database tables and their relations with each other, more or less. Because, as a developer, you already know that _Rest API_ best practices.
+
+Therefore I asked a simple question more than two years ago;
+
+**_"Can we create a Rest API in a declarative way, and handle all endpoints automatically?"_**
+
+As a result of our work, we have a framework called Axe API that provides a solution to analyze your API definitions and handle all of the endpoints.
+
+Basically, you define your models which are your API definitions, and Axe API analyzes them and processes all of your endpoints instead of you.
+
+## Showcase
+
+Let's look at an example!
+
+You have two database tables; `users` and `posts`. These tables are related to each other and we aim that create a **Rest API** for basic **CRUD** endpoints.
+
+The only thing to do is creating models like the following example;
+
+```ts
+class User extends Model {
+  get fillable(): string[] {
+    return ["email", "name", "surname"];
+  }
+
+  posts(): IRelation {
+    return this.hasMany("Post", "id", "user_id");
+  }
+}
+```
+
+```ts
+class Post extends Model {
+  get fillable(): string[] {
+    return ["title", "description"];
+  }
+
+  user(): IRelation {
+    return this.belongsTo("User", "user_id", "id");
+  }
+}
+```
+
+Tada! :tada:
+
+Your API is ready to process all of the following endpoints after those model definitions are done.
+
+- [GET] `api/users`
+- [POST] `api/users`
+- [GET] `api/users/:id`
+- [PUT] `api/users/:id`
+- [DELETE] `api/users/:id`
+- [GET] `api/users/:userId/posts`
+- [POST] `api/users/:userId/posts`
+- [GET] `api/users/:userId/posts/:id`
+- [PUT] `api/users/:userId/posts/:id`
+- [DELETE] `api/users/:userId/posts/:id`
+
+This is the main power of Axe API. Nevertheless, it is not limited only to this power. There are many more features are waiting to discover. :bulb:
+
+## 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
+```
+
+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
+
+> You have to have **Docker** and **Docker Compose** on your local development environment to run integration tests.
+
+Execute the following commands to prepare the integration app
+
+```sh
+cd tests/integrations && npm install && npm ci && npm run build --if-present
+```
+
+Execute the following commands to prepare the database;
+
+```sh
+docker-compose -f "./tests/integrations/docker-compose.mysql8.yml" up -d --build
+```
+
+> To down the database, you can use the following command; `docker-compose -f "./tests/integrations/docker-compose.mysql8.yml" up -d --build`
+
+You can execute the following command to execute tests;
+
+```sh
+npm run test:integration:mysql8
+```
+
+## License
+
+[MIT License](LICENSE)