axe-api 1.0.0-rc9 → 1.0.1

package/build/src/Model.d.ts

@@ -1,26 +1,272 @@
-import { IRelation, IMethodBaseConfig, IMethodBaseValidations, IHandlerBasedTransactionConfig, IQueryLimitConfig } from "./Interfaces";
+import { IRelation, IMethodBaseConfig, IQueryLimitConfig, IHandlerBasedTransactionConfig, ICacheConfiguration, IHandlerBasedCacheConfig, IElasticSearchParameters } from "./Interfaces";
 import { HandlerTypes, HttpMethods } from "./Enums";
-import { FieldList, ModelMiddlewareDefinition, StepTypes, ModelValidation } from "./Types";
+import { ModelMiddleware, AxeFunction, ModelValidation } from "./Types";
 declare class Model {
+    /**
+     * The primary key of the model. By default, it is `id`. But you can choose
+     * another name like `uuid`.
+     *
+     * @example
+     *  get primaryKey() {
+     *    return "id"
+     *  }
+     * @type {string}
+     * @tutorial https://axe-api.com/reference/model-primary-key.html
+     */
     get primaryKey(): string;
+    /**
+     * The database table name of the model. By default, Axe API uses the plural
+     * version of the model(`User.ts` => `users`) name. You can specify a custom
+     * name like `my_users`.
+     *
+     * @example
+     *  get table() {
+     *    return "my_users_table"
+     *  }
+     * @type {string}
+     * @tutorial https://axe-api.com/reference/model-table.html
+     */
     get table(): string;
-    get fillable(): FieldList | IMethodBaseConfig;
-    get validations(): IMethodBaseValidations | ModelValidation;
+    /**
+     * By this method, you can define which fields can be filled by the HTTP client.
+     * If you do not define, the HTTP client can not fill any field.
+     *
+     * @example
+     *  get fillable() {
+     *    return ["name", "email", "password"]
+     *  }
+     * @type {(string[] | IMethodBaseConfig)}
+     * @tutorial https://axe-api.com/reference/model-fillable.html
+     */
+    get fillable(): string[] | IMethodBaseConfig<string[]>;
+    /**
+     * You can define the validation rules of the model. Method-based validations
+     * are also acceptable.
+     *
+     * @example
+     *  get validations() {
+     *    return {
+     *      "name": "required|min:1|max:100",
+     *      "email": "required|email",
+     *    }
+     *  }
+     * @type {(ModelValidation | IMethodBaseConfig<ModelValidation>)}
+     * @tutorial https://axe-api.com/reference/model-validations.html
+     */
+    get validations(): ModelValidation | IMethodBaseConfig<ModelValidation>;
+    /**
+     * You can define acceptable handlers here.
+     *
+     * The default value is `DEFAULT_HANDLERS`
+     *
+     * @example
+     *  get handlers() {
+     *    return [HandlerTypes.PAGINATE]
+     *  }
+     * @type {HandlerTypes[]}
+     * @tutorial https://axe-api.com/reference/model-handlers.html
+     */
     get handlers(): HandlerTypes[];
-    get middlewares(): ModelMiddlewareDefinition;
-    get hiddens(): FieldList;
+    /**
+     * You can define a special handler for the model here. `MiddlewareFunction`,
+     * `HandlerFunction`, and `PhaseFunction` are acceptable middlewares.
+     *
+     * Also, you can define handler-based middlewares.
+     *
+     * @example
+     *  get middlewares() {
+     *    return [
+     *      {
+     *        handler: [HandlerTypes.DELETE],
+     *        middleware: isAdminMiddleware,
+     *      }
+     *    ]
+     *  }
+     * @type {ModelMiddleware}
+     * @tutorial https://axe-api.com/reference/model-middlewares.html
+     */
+    get middlewares(): ModelMiddleware;
+    /**
+     * You can define which fields will be hiding in HTTP responses. The selected
+     * fields will not be listed in any response.
+     *
+     * You should mark as hidden sensitive data fields such as `password`, `token`, etc.
+     *
+     * @example
+     *  get hiddens() {
+     *    return ["password_salt", "password_hash", "github_token"]
+     *  }
+     * @type {string[]}
+     * @tutorial https://axe-api.com/reference/model-hiddens.html
+     */
+    get hiddens(): string[];
+    /**
+     * The `created_at` column name is in the database table. The default value is
+     * `created_at`. You can specify with a custom field name.
+     *
+     * It should be null if the table doesn't have a `created_at` column.
+     *
+     * @example
+     *  get createdAtColumn() {
+     *    return "created_at"
+     *  }
+     * @type {(string | null)}
+     * @tutorial https://axe-api.com/reference/model-created-at-column.html
+     */
     get createdAtColumn(): string | null;
+    /**
+     * The `updated_at` column name is in the database table. The default value is
+     * `updated_at`. You can specify with a custom field name.
+     *
+     * It should be null if the table doesn't have a `updated_at` column.
+     *
+     * @example
+     *  get updatedAtColumn() {
+     *    return "updated_at"
+     *  }
+     * @type {(string | null)}
+     * @tutorial https://axe-api.com/reference/model-updated-at-column.html
+     */
     get updatedAtColumn(): string | null;
+    /**
+     * The `deleted_at` column name is in the database table. The default value is
+     * `null`. You can specify with a custom field name.
+     *
+     * If you provide a name, that means your model supports the soft delete feature.
+     *
+     * @example
+     *  get deletedAtColumn() {
+     *    return "deleted_at"
+     *  }
+     * @type {(string | null)}
+     * @tutorial https://axe-api.com/reference/model-deleted-at-column.html
+     */
     get deletedAtColumn(): string | null;
-    get transaction(): boolean | IHandlerBasedTransactionConfig | IHandlerBasedTransactionConfig[] | null;
+    /**
+     * The transaction configuration on the model. The database transaction can
+     * be started for all endpoints on the model as well as handler-based.
+     *
+     * Creating, rollbacking, and committing a transaction is managed by Axe API.
+     *
+     * @example
+     *  get transaction() {
+     *    return [
+     *      {
+     *        handlers: [HandlerTypes.INSERT],
+     *        transaction: true
+     *      }
+     *    ]
+     *  }
+     * @type {(boolean | IHandlerBasedTransactionConfig[])}
+     * @tutorial https://axe-api.com/learn/database-transactions.html#model-based-transactions
+     */
+    get transaction(): boolean | IHandlerBasedTransactionConfig[];
+    /**
+     * You can completely ignore the model. Axe API doesn't create the routes
+     * automatically.
+     *
+     * @example
+     *  get ignore() {
+     *    return true
+     *  }
+     * @type {boolean}
+     * @tutorial https://axe-api.com/reference/model-ignore.html
+     */
     get ignore(): boolean;
+    /**
+     * You can limit query features such as `select.*` or `LIKE`, etc.
+     *
+     * @example
+     *  get limits() {
+     *    return [
+     *      allow(QueryFeature.WhereLike),
+     *      deny(QueryFeature.FieldsAll)
+     *    ];
+     * }
+     * @type {Array<IQueryLimitConfig[]>}
+     * @tutorial https://axe-api.com/reference/model-limits.html
+     */
     get limits(): Array<IQueryLimitConfig[]>;
-    getFillableFields(methodType: HttpMethods): string[];
-    getValidationRules(methodType: HttpMethods): ModelValidation | null;
-    getMiddlewares(handlerType: HandlerTypes): StepTypes[];
+    /**
+     * You can set the caching configuration for a specific model or handler.
+     * `NULL` means that there is not a special configuration. In that case, the
+     * inherited configuration will be used.
+     *
+     * @example
+     *  get cache() {
+     *    return {
+     *      enable: false,
+     *      ttl: 300,
+     *      invalidation: CacheStrategies.TimeBased,
+     *    };
+     * }
+     * @type {ICacheConfiguration | IHandlerBasedCacheConfig[] | null>}
+     * @tutorial https://axe-api.com/reference/model-cache.html
+     */
+    get cache(): ICacheConfiguration | IHandlerBasedCacheConfig[] | null;
+    /**
+     * You can set which fields should be set to the ElasticSearch for the
+     * full-text search feature.
+     *
+     * @example
+     *  get saerch() {
+     *    return ["name", "surname", "email"]
+     * }
+     * @type {string[] | null>}
+     * @tutorial https://axe-api.com/reference/model-search.html
+     */
+    get search(): string[] | null;
+    /**
+     * Model relationship definition. Axe API creates `hasMany` routes automatically.
+     *
+     * @example
+     *  get relationName() {
+     *    return this.hasMany("Post", "id", "user_id")
+     * }
+     * @type {Array<IQueryLimitConfig[]>}
+     * @tutorial https://axe-api.com/learn/routing.html#model-relations
+     */
     hasMany(relatedModel: string, primaryKey?: string, foreignKey?: string): IRelation;
+    /**
+     * Model relationship definition.
+     *
+     * @example
+     *  get relationName() {
+     *    return this.hasOne("User", "id", "user_id")
+     * }
+     * @type {Array<IQueryLimitConfig[]>}
+     * @tutorial https://axe-api.com/learn/routing.html#model-relations
+     */
     hasOne(relatedModel: string, primaryKey?: string, foreignKey?: string): IRelation;
+    /**
+     * Model relationship definition.
+     *
+     * @example
+     *  get relationName() {
+     *    return this.belongsTo("User", "user_id", "id")
+     * }
+     * @type {Array<IQueryLimitConfig[]>}
+     * @tutorial https://axe-api.com/learn/routing.html#model-relations
+     */
     belongsTo(relatedModel: string, primaryKey: string, foreignKey: string): IRelation;
+    getFillableFields(methodType: HttpMethods): string[];
+    getValidationRules(methodType: HttpMethods): ModelValidation | null;
+    getMiddlewares(handlerType: HandlerTypes): AxeFunction[];
+    /**
+     * In this function, you can use your custom Elastic Search query for the
+     * full-text search feature.
+     *
+     * By default, Axe API uses a simple full-text search.
+     *
+     * @example
+     *  get getSearchQuery(params: IElasticSearchParameters) {
+     *    return {
+     *      // your query
+     *    }
+     * }
+     * @tutorial https://axe-api.com/reference/model-get-search-query.html
+     */
+    getSearchQuery(params: IElasticSearchParameters): any;
     private hasStringValue;
 }
 export default Model;

package/build/src/Model.js

@@ -7,46 +7,310 @@ const pluralize_1 = __importDefault(require("pluralize"));
 const snake_case_1 = require("snake-case");
 const Enums_1 = require("./Enums");
 const constants_1 = require("./constants");
+const Helpers_1 = require("./Handlers/Helpers");
 class Model {
+    /**
+     * The primary key of the model. By default, it is `id`. But you can choose
+     * another name like `uuid`.
+     *
+     * @example
+     *  get primaryKey() {
+     *    return "id"
+     *  }
+     * @type {string}
+     * @tutorial https://axe-api.com/reference/model-primary-key.html
+     */
     get primaryKey() {
         return "id";
     }
+    /**
+     * The database table name of the model. By default, Axe API uses the plural
+     * version of the model(`User.ts` => `users`) name. You can specify a custom
+     * name like `my_users`.
+     *
+     * @example
+     *  get table() {
+     *    return "my_users_table"
+     *  }
+     * @type {string}
+     * @tutorial https://axe-api.com/reference/model-table.html
+     */
     get table() {
         return (0, pluralize_1.default)((0, snake_case_1.snakeCase)(this.constructor.name));
     }
+    /**
+     * By this method, you can define which fields can be filled by the HTTP client.
+     * If you do not define, the HTTP client can not fill any field.
+     *
+     * @example
+     *  get fillable() {
+     *    return ["name", "email", "password"]
+     *  }
+     * @type {(string[] | IMethodBaseConfig)}
+     * @tutorial https://axe-api.com/reference/model-fillable.html
+     */
     get fillable() {
         return [];
     }
+    /**
+     * You can define the validation rules of the model. Method-based validations
+     * are also acceptable.
+     *
+     * @example
+     *  get validations() {
+     *    return {
+     *      "name": "required|min:1|max:100",
+     *      "email": "required|email",
+     *    }
+     *  }
+     * @type {(ModelValidation | IMethodBaseConfig<ModelValidation>)}
+     * @tutorial https://axe-api.com/reference/model-validations.html
+     */
     get validations() {
         return {};
     }
+    /**
+     * You can define acceptable handlers here.
+     *
+     * The default value is `DEFAULT_HANDLERS`
+     *
+     * @example
+     *  get handlers() {
+     *    return [HandlerTypes.PAGINATE]
+     *  }
+     * @type {HandlerTypes[]}
+     * @tutorial https://axe-api.com/reference/model-handlers.html
+     */
     get handlers() {
         return [...constants_1.DEFAULT_HANDLERS];
     }
+    /**
+     * You can define a special handler for the model here. `MiddlewareFunction`,
+     * `HandlerFunction`, and `PhaseFunction` are acceptable middlewares.
+     *
+     * Also, you can define handler-based middlewares.
+     *
+     * @example
+     *  get middlewares() {
+     *    return [
+     *      {
+     *        handler: [HandlerTypes.DELETE],
+     *        middleware: isAdminMiddleware,
+     *      }
+     *    ]
+     *  }
+     * @type {ModelMiddleware}
+     * @tutorial https://axe-api.com/reference/model-middlewares.html
+     */
     get middlewares() {
         return [];
     }
+    /**
+     * You can define which fields will be hiding in HTTP responses. The selected
+     * fields will not be listed in any response.
+     *
+     * You should mark as hidden sensitive data fields such as `password`, `token`, etc.
+     *
+     * @example
+     *  get hiddens() {
+     *    return ["password_salt", "password_hash", "github_token"]
+     *  }
+     * @type {string[]}
+     * @tutorial https://axe-api.com/reference/model-hiddens.html
+     */
     get hiddens() {
         return [];
     }
+    /**
+     * The `created_at` column name is in the database table. The default value is
+     * `created_at`. You can specify with a custom field name.
+     *
+     * It should be null if the table doesn't have a `created_at` column.
+     *
+     * @example
+     *  get createdAtColumn() {
+     *    return "created_at"
+     *  }
+     * @type {(string | null)}
+     * @tutorial https://axe-api.com/reference/model-created-at-column.html
+     */
     get createdAtColumn() {
         return "created_at";
     }
+    /**
+     * The `updated_at` column name is in the database table. The default value is
+     * `updated_at`. You can specify with a custom field name.
+     *
+     * It should be null if the table doesn't have a `updated_at` column.
+     *
+     * @example
+     *  get updatedAtColumn() {
+     *    return "updated_at"
+     *  }
+     * @type {(string | null)}
+     * @tutorial https://axe-api.com/reference/model-updated-at-column.html
+     */
     get updatedAtColumn() {
         return "updated_at";
     }
+    /**
+     * The `deleted_at` column name is in the database table. The default value is
+     * `null`. You can specify with a custom field name.
+     *
+     * If you provide a name, that means your model supports the soft delete feature.
+     *
+     * @example
+     *  get deletedAtColumn() {
+     *    return "deleted_at"
+     *  }
+     * @type {(string | null)}
+     * @tutorial https://axe-api.com/reference/model-deleted-at-column.html
+     */
     get deletedAtColumn() {
         return null;
     }
+    /**
+     * The transaction configuration on the model. The database transaction can
+     * be started for all endpoints on the model as well as handler-based.
+     *
+     * Creating, rollbacking, and committing a transaction is managed by Axe API.
+     *
+     * @example
+     *  get transaction() {
+     *    return [
+     *      {
+     *        handlers: [HandlerTypes.INSERT],
+     *        transaction: true
+     *      }
+     *    ]
+     *  }
+     * @type {(boolean | IHandlerBasedTransactionConfig[])}
+     * @tutorial https://axe-api.com/learn/database-transactions.html#model-based-transactions
+     */
     get transaction() {
-        return null;
+        return false;
     }
+    /**
+     * You can completely ignore the model. Axe API doesn't create the routes
+     * automatically.
+     *
+     * @example
+     *  get ignore() {
+     *    return true
+     *  }
+     * @type {boolean}
+     * @tutorial https://axe-api.com/reference/model-ignore.html
+     */
     get ignore() {
         return false;
     }
+    /**
+     * You can limit query features such as `select.*` or `LIKE`, etc.
+     *
+     * @example
+     *  get limits() {
+     *    return [
+     *      allow(QueryFeature.WhereLike),
+     *      deny(QueryFeature.FieldsAll)
+     *    ];
+     * }
+     * @type {Array<IQueryLimitConfig[]>}
+     * @tutorial https://axe-api.com/reference/model-limits.html
+     */
     get limits() {
         return [];
     }
+    /**
+     * You can set the caching configuration for a specific model or handler.
+     * `NULL` means that there is not a special configuration. In that case, the
+     * inherited configuration will be used.
+     *
+     * @example
+     *  get cache() {
+     *    return {
+     *      enable: false,
+     *      ttl: 300,
+     *      invalidation: CacheStrategies.TimeBased,
+     *    };
+     * }
+     * @type {ICacheConfiguration | IHandlerBasedCacheConfig[] | null>}
+     * @tutorial https://axe-api.com/reference/model-cache.html
+     */
+    get cache() {
+        return null;
+    }
+    /**
+     * You can set which fields should be set to the ElasticSearch for the
+     * full-text search feature.
+     *
+     * @example
+     *  get saerch() {
+     *    return ["name", "surname", "email"]
+     * }
+     * @type {string[] | null>}
+     * @tutorial https://axe-api.com/reference/model-search.html
+     */
+    get search() {
+        return null;
+    }
+    /**
+     * Model relationship definition. Axe API creates `hasMany` routes automatically.
+     *
+     * @example
+     *  get relationName() {
+     *    return this.hasMany("Post", "id", "user_id")
+     * }
+     * @type {Array<IQueryLimitConfig[]>}
+     * @tutorial https://axe-api.com/learn/routing.html#model-relations
+     */
+    hasMany(relatedModel, primaryKey = "id", foreignKey = "") {
+        if (!foreignKey) {
+            const currentModelName = pluralize_1.default.singular(this.constructor.name.toLowerCase());
+            foreignKey = `${currentModelName}_id`;
+        }
+        return {
+            name: relatedModel,
+            type: Enums_1.Relationships.HAS_MANY,
+            model: relatedModel,
+            primaryKey,
+            foreignKey,
+        };
+    }
+    /**
+     * Model relationship definition.
+     *
+     * @example
+     *  get relationName() {
+     *    return this.hasOne("User", "id", "user_id")
+     * }
+     * @type {Array<IQueryLimitConfig[]>}
+     * @tutorial https://axe-api.com/learn/routing.html#model-relations
+     */
+    hasOne(relatedModel, primaryKey = "id", foreignKey = "") {
+        if (foreignKey === "") {
+            foreignKey = `${pluralize_1.default.singular(relatedModel.toLowerCase())}_id`;
+        }
+        return {
+            name: relatedModel,
+            type: Enums_1.Relationships.HAS_ONE,
+            model: relatedModel,
+            primaryKey,
+            foreignKey,
+        };
+    }
+    /**
+     * Model relationship definition.
+     *
+     * @example
+     *  get relationName() {
+     *    return this.belongsTo("User", "user_id", "id")
+     * }
+     * @type {Array<IQueryLimitConfig[]>}
+     * @tutorial https://axe-api.com/learn/routing.html#model-relations
+     */
+    belongsTo(relatedModel, primaryKey, foreignKey) {
+        return this.hasOne(relatedModel, foreignKey, primaryKey);
+    }
     getFillableFields(methodType) {
         var _a, _b, _c;
         if (this.fillable === null) {
@@ -89,9 +353,9 @@ class Model {
         if (Array.isArray(middlewares)) {
             middlewares.forEach((item) => {
                 if (item === null || item === void 0 ? void 0 : item.handler) {
-                    const methodBasedMiddlewares = item;
-                    if (methodBasedMiddlewares.handler.includes(handlerType)) {
-                        results.push(methodBasedMiddlewares.middleware);
+                    const handlerBasedMiddlewares = item;
+                    if (handlerBasedMiddlewares.handler.includes(handlerType)) {
+                        results.push(handlerBasedMiddlewares.middleware);
                     }
                 }
                 else {
@@ -100,41 +364,69 @@ class Model {
             });
         }
         else {
-            const methodBasedMiddlewares = middlewares;
-            if (methodBasedMiddlewares.handler.includes(handlerType)) {
-                results.push(methodBasedMiddlewares.middleware);
+            const handlerBasedMiddlewares = middlewares;
+            if (handlerBasedMiddlewares.handler.includes(handlerType)) {
+                results.push(handlerBasedMiddlewares.middleware);
             }
         }
         return results;
     }
-    hasMany(relatedModel, primaryKey = "id", foreignKey = "") {
-        if (!foreignKey) {
-            const currentModelName = pluralize_1.default.singular(this.constructor.name.toLowerCase());
-            foreignKey = `${currentModelName}_id`;
-        }
-        return {
-            name: relatedModel,
-            type: Enums_1.Relationships.HAS_MANY,
-            model: relatedModel,
-            primaryKey,
-            foreignKey,
+    /**
+     * In this function, you can use your custom Elastic Search query for the
+     * full-text search feature.
+     *
+     * By default, Axe API uses a simple full-text search.
+     *
+     * @example
+     *  get getSearchQuery(params: IElasticSearchParameters) {
+     *    return {
+     *      // your query
+     *    }
+     * }
+     * @tutorial https://axe-api.com/reference/model-get-search-query.html
+     */
+    getSearchQuery(params) {
+        const { req, model, relation, parentModel, text } = params;
+        // Creating the basic search query
+        const query = {
+            bool: {
+                must: [
+                    {
+                        query_string: {
+                            query: `*${text}*`,
+                            analyze_wildcard: true,
+                        },
+                    },
+                ],
+            },
         };
-    }
-    hasOne(relatedModel, primaryKey = "id", foreignKey = "") {
-        if (foreignKey === "") {
-            foreignKey = `${pluralize_1.default.singular(relatedModel.toLowerCase())}_id`;
+        // If there is any parent query, we should be able to that parent conditions
+        // to the ElasticSearch query.
+        const parentIndexQuery = (0, Helpers_1.getParentIndexQuery)(req, relation, parentModel);
+        if (Object.keys(parentIndexQuery).length > 0) {
+            query.bool.must.push({
+                term: parentIndexQuery,
+            });
+        }
+        // If there is a deletedAtColumn, it means that this table support soft-delete
+        if (model.instance.deletedAtColumn) {
+            query.bool.must_not = {
+                exists: {
+                    field: model.instance.deletedAtColumn,
+                },
+            };
         }
         return {
-            name: relatedModel,
-            type: Enums_1.Relationships.HAS_ONE,
-            model: relatedModel,
-            primaryKey,
-            foreignKey,
+            query,
+            sort: [
+                {
+                    _score: {
+                        order: "desc",
+                    },
+                },
+            ],
         };
     }
-    belongsTo(relatedModel, primaryKey, foreignKey) {
-        return this.hasOne(relatedModel, foreignKey, primaryKey);
-    }
     hasStringValue() {
         const tester = this.validations;
         let status = false;