axe-api 1.7.1 → 2.0.0-alfa-1

package/build/index.d.ts

@@ -5,7 +5,10 @@ import RedisAdaptor from "./src/Middlewares/RateLimit/RedisAdaptor";
 import { DEFAULT_HANDLERS, DEFAULT_VERSION_CONFIG } from "./src/constants";
 import { IoCService, allow, deny, App, AxeRequest, AxeResponse } from "./src/Services";
 import { rateLimit, createRateLimitter } from "./src/Middlewares/RateLimit";
+import { generateTypes } from "./src/generator";
 export * from "./src/Enums";
 export * from "./src/Interfaces";
 export * from "./src/Types";
-export { App, AxeRequest, AxeResponse, Server, Model, ApiError, RedisAdaptor, DEFAULT_HANDLERS, DEFAULT_VERSION_CONFIG, IoCService, allow, deny, rateLimit, createRateLimitter, };
+export * from "./src/definers";
+export * from "./src/newTypes";
+export { App, AxeRequest, AxeResponse, Server, Model, ApiError, RedisAdaptor, DEFAULT_HANDLERS, DEFAULT_VERSION_CONFIG, IoCService, allow, deny, rateLimit, createRateLimitter, generateTypes, };

package/build/index.js

@@ -17,7 +17,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createRateLimitter = exports.rateLimit = exports.deny = exports.allow = exports.IoCService = exports.DEFAULT_VERSION_CONFIG = exports.DEFAULT_HANDLERS = exports.RedisAdaptor = exports.ApiError = exports.Model = exports.Server = exports.AxeResponse = exports.AxeRequest = exports.App = void 0;
+exports.generateTypes = exports.createRateLimitter = exports.rateLimit = exports.deny = exports.allow = exports.IoCService = exports.DEFAULT_VERSION_CONFIG = exports.DEFAULT_HANDLERS = exports.RedisAdaptor = exports.ApiError = exports.Model = exports.Server = exports.AxeResponse = exports.AxeRequest = exports.App = void 0;
 const Server_1 = __importDefault(require("./src/Server"));
 exports.Server = Server_1.default;
 const Model_1 = __importDefault(require("./src/Model"));
@@ -39,6 +39,10 @@ Object.defineProperty(exports, "AxeResponse", { enumerable: true, get: function
 const RateLimit_1 = require("./src/Middlewares/RateLimit");
 Object.defineProperty(exports, "rateLimit", { enumerable: true, get: function () { return RateLimit_1.rateLimit; } });
 Object.defineProperty(exports, "createRateLimitter", { enumerable: true, get: function () { return RateLimit_1.createRateLimitter; } });
+const generator_1 = require("./src/generator");
+Object.defineProperty(exports, "generateTypes", { enumerable: true, get: function () { return generator_1.generateTypes; } });
 __exportStar(require("./src/Enums"), exports);
 __exportStar(require("./src/Interfaces"), exports);
 __exportStar(require("./src/Types"), exports);
+__exportStar(require("./src/definers"), exports);
+__exportStar(require("./src/newTypes"), exports);

package/build/src/Handlers/RequestHandler.js

@@ -74,7 +74,7 @@ exports.default = (request, response, next) => __awaiter(void 0, void 0, void 0,
             // Rollback transaction
             if (match.hasTransaction && trx) {
                 Services_1.LogService.info("\t🛢 DBTransaction:rollback()");
-                trx.rollback();
+                yield trx.rollback();
             }
             if (error.type === "ApiError") {
                 const apiError = error;
@@ -94,7 +94,7 @@ exports.default = (request, response, next) => __awaiter(void 0, void 0, void 0,
         if (context.res.statusCode() >= 400 && context.res.statusCode() < 599) {
             if (match.hasTransaction && trx) {
                 Services_1.LogService.info("\t🛢 DBTransaction:rollback()");
-                trx.rollback();
+                yield trx.rollback();
             }
             Services_1.LogService.debug(`\tResponse ${context.res.statusCode()}`);
             break;
@@ -102,7 +102,7 @@ exports.default = (request, response, next) => __awaiter(void 0, void 0, void 0,
         // We should commit the transaction if there is any
         if (match.hasTransaction && trx) {
             Services_1.LogService.info("\t🛢 DBTransaction:commit()");
-            trx.commit();
+            yield trx.commit();
         }
         Services_1.LogService.debug(`\t🟢 Response ${context.res.statusCode()}`);
         // We should brake the for-loop

package/build/src/Middlewares/RateLimit/RedisAdaptor.js

@@ -24,6 +24,9 @@ class RedisAdaptor {
         return __awaiter(this, void 0, void 0, function* () {
             try {
                 yield this.client.connect();
+                this.client.on("error", (err) => {
+                    Services_1.LogService.error(`Redis Client Error: ${err.message}`);
+                });
                 Services_1.LogService.info("Redis connection done!");
                 this.isConnected = true;
             }

package/build/src/Model.d.ts

@@ -267,6 +267,7 @@ declare class Model {
      * @tutorial https://axe-api.com/reference/model-get-search-query.html
      */
     getSearchQuery(params: IElasticSearchParameters): any;
+    query(): void;
     private hasStringValue;
 }
 export default Model;

package/build/src/Model.js

@@ -429,6 +429,7 @@ class Model {
             ],
         };
     }
+    query() { }
     hasStringValue() {
         const tester = this.validations;
         let status = false;

package/build/src/constants.js

@@ -79,6 +79,7 @@ exports.DEFAULT_METHODS_OF_MODELS = [
     "cache",
     "search",
     "getSearchQuery",
+    "query",
 ];
 exports.API_ROUTE_TEMPLATES = {
     [Enums_1.HandlerTypes.INSERT]: (prefix, parentUrl, resource) => `/${prefix}/${parentUrl}${resource}`,

package/build/src/definers/index.d.ts

@@ -0,0 +1,3 @@
+import { useResource } from "./useResource";
+import { useInsertHandler } from "./useInsertHandler";
+export { useResource, useInsertHandler };

package/build/src/definers/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useInsertHandler = exports.useResource = void 0;
+const useResource_1 = require("./useResource");
+Object.defineProperty(exports, "useResource", { enumerable: true, get: function () { return useResource_1.useResource; } });
+const useInsertHandler_1 = require("./useInsertHandler");
+Object.defineProperty(exports, "useInsertHandler", { enumerable: true, get: function () { return useInsertHandler_1.useInsertHandler; } });

package/build/src/definers/useInsertHandler.d.ts

@@ -0,0 +1,6 @@
+import { Resource } from "./useResource";
+export declare const useInsertHandler: <Model>(resource: Resource<Model>) => InserHandler<Model>;
+type InserHandler<T> = {
+    fillable: (columns: Array<keyof T>) => InserHandler<T>;
+};
+export {};

package/build/src/definers/useInsertHandler.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useInsertHandler = void 0;
+const useInsertHandler = (resource) => {
+    return {
+        fillable(columns) {
+            resource.config.fillables = columns;
+            return this;
+        },
+    };
+};
+exports.useInsertHandler = useInsertHandler;

package/build/src/definers/useResource.d.ts

@@ -0,0 +1,20 @@
+export declare const useResource: <TSchema extends {
+    table: string;
+    primaryKey: string;
+    model: any;
+    columns: readonly string[];
+}>(schema: TSchema) => Resource<ExtractModel<TSchema>>;
+export type ExtractModel<T> = T extends {
+    model: infer M;
+} ? M : never;
+export type ResourceConfig<T> = {
+    tableName: string;
+    columns: string[];
+    primaryKey: keyof T;
+    fillables: Array<keyof T>;
+};
+export type Resource<T> = {
+    config: ResourceConfig<T>;
+    primaryKey: (column: keyof T) => void;
+    bind: () => void;
+};

package/build/src/definers/useResource.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useResource = void 0;
+const useResource = (schema) => {
+    const config = {
+        tableName: schema.table,
+        primaryKey: schema.primaryKey,
+        columns: schema.columns,
+        fillables: [],
+    };
+    return {
+        config,
+        primaryKey(column) {
+            config.primaryKey = column;
+        },
+        bind: () => { },
+    };
+};
+exports.useResource = useResource;

package/build/src/generator/generateTable.d.ts

@@ -0,0 +1,2 @@
+import { IModelService } from "../Interfaces";
+export declare const generateTable: (model: IModelService) => Promise<string>;

package/build/src/generator/generateTable.js

@@ -0,0 +1,24 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateTable = void 0;
+const shared_1 = require("./shared");
+const toColumnTypes = (columnNames) => {
+    return columnNames.map((name) => `'${name}'`).join(" | ");
+};
+const generateTable = (model) => __awaiter(void 0, void 0, void 0, function* () {
+    const tableName = (0, shared_1.toTableName)(model.instance.table);
+    const columnTypes = toColumnTypes(model.columnNames);
+    return `export namespace ${(0, shared_1.toTableName)(tableName)} {
+  export type Columns = ${columnTypes};
+}`;
+});
+exports.generateTable = generateTable;

package/build/src/generator/index.d.ts

@@ -0,0 +1 @@
+export declare const generateTypes: () => Promise<void>;

package/build/src/generator/index.js

@@ -0,0 +1,32 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateTypes = void 0;
+const Services_1 = require("../Services");
+const generateTable_1 = require("./generateTable");
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+const generateTypes = () => __awaiter(void 0, void 0, void 0, function* () {
+    const api = Services_1.APIService.getInstance();
+    const tables = [];
+    for (const version of api.versions) {
+        for (const model of version.modelList.get()) {
+            tables.push(yield (0, generateTable_1.generateTable)(model));
+        }
+    }
+    const content = tables.join("\\");
+    const filepath = path_1.default.join(process.cwd(), "app", "generated-types.ts");
+    fs_1.default.writeFileSync(filepath, content);
+});
+exports.generateTypes = generateTypes;

package/build/src/generator/shared.d.ts

@@ -0,0 +1 @@
+export declare const toTableName: (tableName: string) => string;

package/build/src/generator/shared.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toTableName = void 0;
+const toTableName = (tableName) => {
+    return tableName;
+};
+exports.toTableName = toTableName;

package/build/src/newTypes.d.ts

@@ -0,0 +1,6 @@
+export type NewHandlerTypes = "store" | "paginate" | "show" | "update" | "destroy" | "force_delete" | "patch" | "all" | "search";
+export type Resource<T> = {
+    table: string;
+    primaryKey: keyof T;
+    columns: Array<keyof T>;
+};

package/build/src/newTypes.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "axe-api",
-  "version": "1.7.1",
+  "version": "2.0.0-alfa-1",
   "description": "AXE API is a simple tool to create Rest APIs quickly.",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -46,31 +46,18 @@
   "scripts": {
     "build": "rm -rf build && tsc && rm -rf build/dev-kit",
     "build:watch": "tsc -w",
-    "dev-kit": "tsx watch dev-kit.ts",
-    "dev-kit:install": "node ./scripts/dev-kit-install.js",
-    "dev-kit:remove": "node ./scripts/dev-kit-remove.js",
-    "test": "jest --runInBand",
+    "test": "vitest run",
     "test:all": "npm run lint && npm run prettier:check && npm run test && npm run test:sqlite",
-    "test:dev": "jest --watch",
+    "test:dev": "vitest",
     "lint": "eslint --max-warnings=0 .",
     "lint:watch": "esw --watch --color",
-    "test:postgres11": "sh ./scripts/test-postgres11.sh",
-    "test:postgres12": "sh ./scripts/test-postgres12.sh",
-    "test:postgres13": "sh ./scripts/test-postgres13.sh",
-    "test:postgres14": "sh ./scripts/test-postgres14.sh",
-    "test:postgres15": "sh ./scripts/test-postgres15.sh",
-    "test:cockroach": "sh ./scripts/test-cockroach.sh",
-    "test:mysql57": "sh ./scripts/test-mysql57.sh",
-    "test:mysql8": "sh ./scripts/test-mysql8.sh",
-    "test:mariadb": "sh ./scripts/test-mariadb.sh",
-    "test:sqlite": "sh ./scripts/test-sqlite.sh",
     "prettier:check": "prettier --check .",
     "prettier:write": "prettier --write .",
     "prepare": "husky",
     "benchmark": "k6 run benchmark/run.js"
   },
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=20.0.0"
   },
   "dependencies": {
     "body-parser": "^2.2.0",
@@ -105,7 +92,6 @@
     "@types/validatorjs": "^3.15.5",
     "@typescript-eslint/eslint-plugin": "^7.18.0",
     "@typescript-eslint/parser": "^7.18.0",
-    "babel-jest": "^30.0.0",
     "cors": "^2.8.5",
     "eslint": "^8.57.1",
     "eslint-config-standard": "^17.1.0",
@@ -116,7 +102,6 @@
     "eslint-watch": "^8.0.0",
     "glob": "^11.0.3",
     "husky": "^9.1.7",
-    "jest": "^30.0.0",
     "lint-staged": "^16.1.0",
     "multer": "^2.0.1",
     "mysql": "^2.18.1",
@@ -131,7 +116,8 @@
     "sqlite3": "^5.1.7",
     "ts-node": "^10.9.2",
     "tsx": "^4.20.3",
-    "typescript": "^5.8.3"
+    "typescript": "^5.8.3",
+    "vitest": "^3.2.3"
   },
   "lint-staged": {
     "**/*": "prettier --write --ignore-unknown"

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2021 Özgür Adem Işıklı <i.ozguradem@gmail.com>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/readme.md

@@ -1,54 +0,0 @@
-<h1 align="center">
-  <br>
-  <a href="https://axe-api.com/">
-    <img src="https://axe-api.com/viking.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-release-publish.yml" target="_blank">
-    <img src="https://github.com/axe-api/axe-api/actions/workflows/npm-release-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>
-
-**Axe API** is a **TypeScript-based** **Node.js** framework designed to eliminate the need for repetitive tasks associated with common elements while allowing developers to focus on custom logic.
-
-It offers a comprehensive structure for your API, including numerous features and best practices that will save you time.
-
-## 🎥 Video Introduction
-
-<div style="display: flex; justify-content: center;">
-
-<a href="https://www.youtube.com/watch?v=3p4jggsNrJA" target="_blank">
-  <img src="https://raw.githubusercontent.com/axe-api/axe-api/master/youtube.png" />
-</a>
-
-</div>
-
-## 📚 Documentation
-
-Axe API has great documentation. Please [check it out in here](https://axe-api.com/).
-
-## 👥 Contributors
-
-<a href="https://github.com/axe-api/axe-api/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=axe-api/axe-api" />
-</a>
-
-Made with [contrib.rocks](https://contrib.rocks).
-
-## 📜 License
-
-[MIT License](LICENSE)