axe-api 0.19.2 → 0.20.0-rc3

package/package.json

@@ -1,56 +1,62 @@
-{
-  "name": "axe-api",
-  "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",
-  "directories": {
-    "test": "tests"
-  },
-  "author": "Özgür Adem Işıklı <i.ozguradem@gmail.com>",
-  "license": "ISC",
-  "scripts": {
-    "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": {
-    "change-case": "^4.1.2",
-    "dotenv": "^14.2.0",
-    "express": "^4.17.2",
-    "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",
-    "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-rc3",
+  "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": {
+    "change-case": "^4.1.2",
+    "dotenv": "^14.2.0",
+    "express": "^4.17.2",
+    "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",
+    "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"
+  }
+}

package/readme.md

@@ -1,145 +1,152 @@
-<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)
+<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

package/.eslintrc.cjs

@@ -1,24 +0,0 @@
-module.exports = {
-  env: {
-    browser: true,
-    es2021: true,
-    jest: true,
-  },
-  extends: "eslint:recommended",
-  parserOptions: {
-    ecmaVersion: 12,
-    sourceType: "module",
-  },
-  plugins: ["unicorn"],
-  rules: {
-    "unicorn/filename-case": [
-      "error",
-      {
-        cases: {
-          camelCase: true,
-          pascalCase: true,
-        },
-      },
-    ],
-  },
-};

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,32 +0,0 @@
-## Description
-
-<!--- Describe your changes in detail -->
-
-## Motivation and Context
-
-<!--- Why is this change required? What problem does it solve? -->
-<!--- If it fixes an open issue, please link to the issue here. -->
-
-## How has this been tested?
-
-<!--- Please describe in detail how you tested your changes. -->
-<!--- Include details of your testing environment, tests ran to see how -->
-<!--- your change affects other areas of the code, etc. -->
-
-## Types of changes
-
-<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
-
-- [ ] Bug fix (non-breaking change which fixes an issue)
-- [ ] New feature (non-breaking change which adds functionality)
-- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
-
-## Checklist:
-
-<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
-<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
-
-- [ ] My changes requires documentation change.
-- [ ] The changes have been documented in the [axe-api/docs](https://github.com/axe-api/docs) repository. (<!--- Please insert the PR link -->)
-- [ ] I added integration tests properly.
-- [ ] The changes require [axe-api-template](https://github.com/axe-api/axe-api-template) changes. (<!--- Please insert the PR link -->)

package/.github/workflows/auto-tag.yml

@@ -1,15 +0,0 @@
-name: Create Tag
-
-on:
-  push:
-    branches:
-      - master
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: butlerlogic/action-autotag@stable
-        with:
-          GITHUB_TOKEN: "${{ secrets.AUTO_TAG_TOKEN }}"

package/.github/workflows/npm-publish.yml

@@ -1,18 +0,0 @@
-name: NPM Publish
-on:
-  push:
-    branches:
-      - master
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v1
-      - uses: actions/setup-node@v1
-        with:
-          node-version: 14
-      - run: npm install
-      - run: npm test
-      - uses: JS-DevTools/npm-publish@v1
-        with:
-          token: ${{ secrets.NPM_TOKEN }}

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

@@ -1,29 +0,0 @@
-name: Integration Tests
-
-on:
-  pull_request:
-    branches:
-      - master
-      - develop
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node-version: [14.x, 16.x, 17.x]
-        database: [mysql8, mysql57, "postgres"]
-    steps:
-      - uses: actions/checkout@v2
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
-        with:
-          node-version: ${{ matrix.node-version }}
-      - name: Start database containers
-        run: docker-compose -f "./tests/integrations/docker-compose.${{ matrix.database }}.yml" up -d --build
-      - name: Install integration test dependencies
-        run: cd tests/integrations && npm install
-      - run: npm ci
-      - run: npm run build --if-present
-      - name: Testing all scenarions
-        run: npm run test:integration:${{ matrix.database }}

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

@@ -1,23 +0,0 @@
-name: Unit Tests
-
-on:
-  pull_request:
-    branches:
-      - master
-      - develop
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node-version: [14.x, 16.x, 17.x]
-    steps:
-      - uses: actions/checkout@v2
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
-        with:
-          node-version: ${{ matrix.node-version }}
-      - run: npm ci
-      - run: npm run build --if-present
-      - run: npm run test