axe-api 0.30.0-rc9 → 0.30.0

package/CHANGELOG.md

@@ -0,0 +1,221 @@
+# Release Notes
+
+## [0.30.0 (2023-04-05)](https://github.com/axe-api/axe-api/compare/0.30.0...0.22.0)
+
+### Breaking Changes
+
+- Added new Serizaliation folder [#125](https://github.com/axe-api/axe-api/issues/125)
+- New hook/event folder structure [#146](https://github.com/axe-api/axe-api/issues/146)
+- Limiting query features by configurations [#38](https://github.com/axe-api/axe-api/issues/38)
+- Removing external dependencies from axe-core [#151](https://github.com/axe-api/axe-api/issues/151)
+
+## [0.22.0 (2023-01-29)](https://github.com/axe-api/axe-api/compare/0.22.0...0.21.0)
+
+### Features
+
+- Added Soft-Deleting feature [#41](https://github.com/axe-api/axe-api/issues/41)
+
+### Fixed
+
+- Fixed model relation route URLs [#141](https://github.com/axe-api/axe-api/issues/141)
+
+## [0.21.0 (2022-12-28)](https://github.com/axe-api/axe-api/compare/0.21.0...0.20.4)
+
+### Features
+
+- Added `i18n` support. [#44](https://github.com/axe-api/axe-api/issues/44)
+
+## [0.20.4 (2022-12-24)](https://github.com/axe-api/axe-api/compare/0.20.4...0.20.3)
+
+### Fixed
+
+- Fixed [#124](https://github.com/axe-api/axe-api/issues/124)
+- Throwing errors in the `development` environment has been fixed.
+- Unbuilt integration test issue has been fixed.
+
+## [0.20.3 (2022-12-24)](https://github.com/axe-api/axe-api/compare/0.20.3...0.20.0)
+
+### Fixed
+
+- NPM publish bugs
+
+## [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/build/src/Services/SchemaValidatorService.d.ts

@@ -3,6 +3,7 @@ declare class SchemaValidatorService {
     private version;
     constructor(version: IVersion);
     validate(): Promise<void>;
+    private checkModelReservedKeywordsOrFail;
     private checkModelColumnsOrFail;
     private checkRelationNamesOrFail;
     private getQueryLimitRelations;

package/build/src/Services/SchemaValidatorService.js

@@ -15,6 +15,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const AxeError_1 = __importDefault(require("../Exceptions/AxeError"));
 const Enums_1 = require("../Enums");
 const Services_1 = require("../Services");
+const constants_1 = require("../constants");
 const COLUMN_BASED_QUERY_LIMITS = [
     Enums_1.QueryFeature.Sorting,
     Enums_1.QueryFeature.WhereEqual,
@@ -52,7 +53,7 @@ class SchemaValidatorService {
                 if (!key) {
                     return "";
                 }
-                const [, field] = key === null || key === void 0 ? void 0 : key.split(".");
+                const [, field] = key.split(".");
                 return field;
             });
             return items;
@@ -120,6 +121,7 @@ class SchemaValidatorService {
         return __awaiter(this, void 0, void 0, function* () {
             const logger = Services_1.LogService.getInstance();
             this.version.modelList.get().forEach((model) => {
+                this.checkModelReservedKeywordsOrFail(model);
                 this.checkModelColumnsOrFail(model, this.getModelFillableColumns(model));
                 this.checkModelColumnsOrFail(model, this.getModelFormValidationColumns(model));
                 this.checkModelColumnsOrFail(model, this.getModelHiddenColumns(model));
@@ -132,6 +134,22 @@ class SchemaValidatorService {
             logger.info(`[${this.version.name}] Database schema has been validated.`);
         });
     }
+    checkModelReservedKeywordsOrFail(model) {
+        const reservedKeywords = [];
+        constants_1.RESERVED_KEYWORDS.forEach((keyword) => {
+            if (model.columnNames.includes(keyword) ||
+                model.name.toLowerCase().includes(keyword)) {
+                reservedKeywords.push(keyword);
+            }
+            for (const relation of model.relations) {
+                if (relation.name === keyword)
+                    reservedKeywords.push(relation.name);
+            }
+        });
+        if (reservedKeywords.length > 0) {
+            throw new Error(`The following keywords are reserved for the framework; "${reservedKeywords.join(",")}"`);
+        }
+    }
     checkModelColumnsOrFail(model, modelColumns) {
         const undefinedColumns = modelColumns.filter((modelColumn) => !model.columnNames.includes(modelColumn));
         if (undefinedColumns.length > 0) {

package/build/src/constants.d.ts

@@ -11,6 +11,7 @@ export declare const LOG_COLORS: {
     fgWhite: string;
     fgReset: string;
 };
+export declare const RESERVED_KEYWORDS: string[];
 export declare const DEFAULT_HANDLERS: HandlerTypes[];
 export declare const DEFAULT_METHODS_OF_MODELS: string[];
 export declare const API_ROUTE_TEMPLATES: {

package/build/src/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_VERSION_CONFIG = exports.RelationQueryFeatureMap = exports.ConditionQueryFeatureMap = exports.API_ROUTE_TEMPLATES = exports.DEFAULT_METHODS_OF_MODELS = exports.DEFAULT_HANDLERS = exports.LOG_COLORS = void 0;
+exports.DEFAULT_VERSION_CONFIG = exports.RelationQueryFeatureMap = exports.ConditionQueryFeatureMap = exports.API_ROUTE_TEMPLATES = exports.DEFAULT_METHODS_OF_MODELS = exports.DEFAULT_HANDLERS = exports.RESERVED_KEYWORDS = exports.LOG_COLORS = void 0;
 const Enums_1 = require("./Enums");
 const LimitService_1 = require("./Services/LimitService");
 exports.LOG_COLORS = {
@@ -14,6 +14,17 @@ exports.LOG_COLORS = {
     fgWhite: "\x1b[37m",
     fgReset: "\x1b[0m",
 };
+exports.RESERVED_KEYWORDS = [
+    "force",
+    "model",
+    "api",
+    "routes",
+    "docs",
+    "hook",
+    "hooks",
+    "event",
+    "events",
+];
 exports.DEFAULT_HANDLERS = [
     Enums_1.HandlerTypes.INSERT,
     Enums_1.HandlerTypes.PAGINATE,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "axe-api",
-  "version": "0.30.0-rc9",
+  "version": "0.30.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",
@@ -10,7 +10,21 @@
   "directories": {
     "test": "tests"
   },
-  "author": "Özgür Adem Işıklı <i.ozguradem@gmail.com>",
+  "contributors": [
+    {
+      "name": "Alihan Saraç",
+      "url": "https://www.linkedin.com/in/alihan-sara%C3%A7-ba75a319a/"
+    },
+    {
+      "name": "Arif Karakılıç",
+      "url": "https://www.linkedin.com/in/arif-karak%C4%B1l%C4%B1%C3%A7-992a58150/"
+    },
+    {
+      "name": "Özgür Adem Işıklı",
+      "email": "i.ozguradem@gmail.com",
+      "url": "https://www.linkedin.com/in/ozguradem"
+    }
+  ],
   "license": "MIT",
   "scripts": {
     "build": "rm -rf build && tsc && rm -rf build/dev-kit",
@@ -39,13 +53,11 @@
     "validatorjs": "^3.22.1"
   },
   "devDependencies": {
-    "multer": "^1.4.5-lts.1",
-    "@types/express": "^4.17.17",
-    "express": "^4.18.2",
     "@babel/core": "^7.21.3",
     "@babel/preset-env": "^7.20.2",
     "@babel/preset-typescript": "^7.21.0",
     "@types/accept-language-parser": "^1.5.3",
+    "@types/express": "^4.17.17",
     "@types/multer": "^1.4.7",
     "@types/pluralize": "^0.0.29",
     "@types/validatorjs": "^3.15.0",
@@ -59,12 +71,15 @@
     "eslint-plugin-promise": "^5.1.0",
     "eslint-plugin-unicorn": "^33.0.1",
     "eslint-watch": "^7.0.0",
+    "express": "^4.18.2",
     "glob": "^9.3.2",
     "jest": "^29.5.0",
+    "multer": "^1.4.5-lts.1",
     "mysql": "^2.18.1",
     "node-color-log": "^10.0.2",
     "nodemon": "^2.0.22",
     "pg": "^8.10.0",
+    "prettier": "^2.8.6",
     "set-value": ">=4.1.0",
     "sqlite3": "^5.1.6",
     "ts-node": "^10.9.1",

package/build/dev-kit.d.ts

@@ -1 +0,0 @@
-export {};

package/build/dev-kit.js

@@ -1,16 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const node_color_log_1 = __importDefault(require("node-color-log"));
-const dotenv_1 = __importDefault(require("dotenv"));
-const path_1 = __importDefault(require("path"));
-const index_1 = require("./index");
-node_color_log_1.default.bgColor("yellow").color("black").log("Axe API dev-kit (1.0.0)");
-node_color_log_1.default
-    .color("blue")
-    .log("Docs: https://axe-api.com/contribution/fundamentals.html \n");
-dotenv_1.default.config();
-const server = new index_1.Server();
-server.start(path_1.default.join(__dirname, "dev-kit"));