axe-api 0.30.0-rc11 → 0.30.0-rc12

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-rc11",
+  "version": "0.30.0-rc12",
   "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",