axe-api 0.19.2 → 0.20.0-rc1

package/CHANGELOG.md

@@ -1,150 +0,0 @@
-# Release Notes
-
-## [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/babel.config.cjs

@@ -1,12 +0,0 @@
-module.exports = {
-  presets: [
-    [
-      "@babel/preset-env",
-      {
-        targets: {
-          node: "current",
-        },
-      },
-    ],
-  ],
-};

package/index.js

@@ -1,21 +0,0 @@
-import Server from "./src/Server.js";
-import Model from "./src/core/Model.js";
-import IoC from "./src/core/IoC.js";
-import {
-  LOG_LEVEL,
-  HOOK_FUNCTIONS,
-  HANDLERS,
-  DEFAULT_HANDLERS,
-} from "./src/constants.js";
-import HttpResponse from "./src/core/HttpResponse.js";
-
-export {
-  Server,
-  Model,
-  IoC,
-  HttpResponse,
-  LOG_LEVEL,
-  HOOK_FUNCTIONS,
-  HANDLERS,
-  DEFAULT_HANDLERS,
-};

package/jest.config.js

@@ -1,4 +0,0 @@
-export default {
-  verbose: true,
-  modulePathIgnorePatterns: ["tests/integrations"],
-};

package/src/Server.js

@@ -1,118 +0,0 @@
-import dotenv from "dotenv";
-import express from "express";
-import knex from "knex";
-import { attachPaginate } from "knex-paginate";
-import Config from "./core/Config.js";
-import IoC from "./core/IoC.js";
-import Docs from "./core/Docs.js";
-import Logger from "./core/Logger.js";
-import {
-  getModelInstanceArray,
-  getModelTree,
-  setModelRelations,
-  setModelHooks,
-  setExpressRoutes,
-  detectDbColumns,
-  checkModelColumns,
-} from "./resolvers/index.js";
-
-class Server {
-  constructor(appFolder) {
-    this.app = null;
-    this.appFolder = appFolder;
-    this.models = [];
-    this.modelTree = [];
-  }
-
-  async listen() {
-    await this._bindDependencies();
-    await this._loadConfigurations();
-    await this._loadExpress();
-    await this._analyzeModels();
-    await this._listen();
-  }
-
-  async _bindDependencies() {
-    IoC.singleton("Config", () => new Config());
-    IoC.singleton("Database", async () => {
-      const Config = await IoC.use("Config");
-      const database = knex(Config.Database);
-      attachPaginate();
-      return database;
-    });
-    IoC.singleton("App", async () => {
-      return express();
-    });
-    IoC.singleton("Logger", async () => {
-      const Config = await IoC.use("Config");
-      return new Logger(Config.Application.logLevel);
-    });
-    IoC.singleton("Docs", async () => new Docs());
-    IoC.bind("fs", async () => import("fs"));
-    IoC.bind("path", async () => import("path"));
-    IoC.bind("url", async () => import("url"));
-  }
-
-  async _loadConfigurations() {
-    dotenv.config();
-    const Config = await IoC.use("Config");
-    await Config.load(this.appFolder);
-  }
-
-  async _loadExpress() {
-    this.app = await IoC.use("App");
-    this.app.use(express.urlencoded({ extended: true }));
-    this.app.use(express.json());
-  }
-
-  async _analyzeModels() {
-    this.models = await getModelInstanceArray(this.appFolder);
-    await setModelRelations(this.models);
-    await detectDbColumns(this.models);
-    checkModelColumns(this.models);
-    await setModelHooks("Hooks", this.appFolder, this.models);
-    await setModelHooks("Events", this.appFolder, this.models);
-    this.modelTree = await getModelTree(this.models);
-    await setExpressRoutes(
-      this.app,
-      this.modelTree,
-      this.appFolder,
-      this.models
-    );
-  }
-
-  async _listen() {
-    const Config = await IoC.use("Config");
-
-    this.app.get("/", (req, res) => {
-      res.json({
-        name: "AXE API",
-        description: "The best API creation tool in the world.",
-        aim: "To kill them all!",
-      });
-    });
-
-    if (Config.Application.env === "development") {
-      this.app.get("/docs", async (req, res) => {
-        const docs = await IoC.use("Docs");
-        res.json({
-          routes: docs.get(),
-          modelTree: this.modelTree,
-        });
-      });
-
-      this.app.get("/docs/routes", async (req, res) => {
-        const docs = await IoC.use("Docs");
-        res.json(docs.get().map((route) => `${route.method} ${route.url}`));
-      });
-    }
-
-    this.app.listen(Config.Application.port, () => {
-      console.log(
-        `Example app listening at http://localhost:${Config.Application.port}`
-      );
-    });
-  }
-}
-
-export default Server;

package/src/constants.js

@@ -1,148 +0,0 @@
-const LOG_LEVEL = {
-  NONE: 0,
-  ERROR: 1,
-  WARNING: 2,
-  INFO: 3,
-  ALL: 4,
-};
-
-const HOOK_FUNCTIONS = {
-  onBeforeInsert: "onBeforeInsert",
-  onBeforeUpdateQuery: "onBeforeUpdateQuery",
-  onBeforeUpdate: "onBeforeUpdate",
-  onBeforeDeleteQuery: "onBeforeDeleteQuery",
-  onBeforeDelete: "onBeforeDelete",
-  onBeforePaginate: "onBeforePaginate",
-  onBeforeAll: "onBeforeAll",
-  onBeforeShow: "onBeforeShow",
-  onAfterInsert: "onAfterInsert",
-  onAfterUpdateQuery: "onAfterUpdateQuery",
-  onAfterUpdate: "onAfterUpdate",
-  onAfterDeleteQuery: "onAfterDeleteQuery",
-  onAfterDelete: "onAfterDelete",
-  onAfterPaginate: "onAfterPaginate",
-  onAfterAll: "onAfterAll",
-  onAfterShow: "onAfterShow",
-};
-
-const RELATIONSHIPS = {
-  HAS_ONE: "HAS_ONE",
-  HAS_MANY: "HAS_MANY",
-};
-
-const DEFAULT_METHODS_OF_MODELS = [
-  "constructor",
-  "hasMany",
-  "hasOne",
-  "belongsTo",
-  "serialize",
-  "__defineGetter__",
-  "__defineSetter__",
-  "hasOwnProperty",
-  "__lookupGetter__",
-  "__lookupSetter__",
-  "isPrototypeOf",
-  "propertyIsEnumerable",
-  "toString",
-  "valueOf",
-  "toLocaleString",
-];
-
-const HANDLERS = {
-  INSERT: "store",
-  PAGINATE: "paginate",
-  SHOW: "show",
-  UPDATE: "update",
-  DELETE: "destroy",
-  PATCH: "patch",
-  ALL: "all",
-};
-
-const DEFAULT_HANDLERS = [
-  HANDLERS.INSERT,
-  HANDLERS.PAGINATE,
-  HANDLERS.SHOW,
-  HANDLERS.UPDATE,
-  HANDLERS.PATCH,
-  HANDLERS.DELETE,
-];
-
-const HTTP_METHODS = {
-  POST: "POST",
-  GET: "GET",
-  PUT: "PUT",
-  DELETE: "DELETE",
-  PATCH: "PATCH",
-};
-
-const API_ROUTE_TEMPLATES = {
-  [HANDLERS.INSERT]: {
-    url: (prefix, parentUrl, resource) => `/${prefix}/${parentUrl}${resource}`,
-    method: HTTP_METHODS.POST,
-  },
-  [HANDLERS.PAGINATE]: {
-    url: (prefix, parentUrl, resource) => `/${prefix}/${parentUrl}${resource}`,
-    method: HTTP_METHODS.GET,
-  },
-  [HANDLERS.ALL]: {
-    url: (prefix, parentUrl, resource) =>
-      `/${prefix}/${parentUrl}${resource}/all`,
-    method: HTTP_METHODS.GET,
-  },
-  [HANDLERS.SHOW]: {
-    url: (prefix, parentUrl, resource, primaryKey) =>
-      `/${prefix}/${parentUrl}${resource}/:${primaryKey}`,
-    method: HTTP_METHODS.GET,
-  },
-  [HANDLERS.UPDATE]: {
-    url: (prefix, parentUrl, resource, primaryKey) =>
-      `/${prefix}/${parentUrl}${resource}/:${primaryKey}`,
-    method: HTTP_METHODS.PUT,
-  },
-  [HANDLERS.PATCH]: {
-    url: (prefix, parentUrl, resource, primaryKey) =>
-      `/${prefix}/${parentUrl}${resource}/:${primaryKey}`,
-    method: HTTP_METHODS.PATCH,
-  },
-  [HANDLERS.DELETE]: {
-    url: (prefix, parentUrl, resource, primaryKey) =>
-      `/${prefix}/${parentUrl}${resource}/:${primaryKey}`,
-    method: HTTP_METHODS.DELETE,
-  },
-};
-
-const LOG_COLORS = {
-  fgBlack: "\x1b[30m",
-  fgRed: "\x1b[31m",
-  fgGreen: "\x1b[32m",
-  fgYellow: "\x1b[33m",
-  fgBlue: "\x1b[34m",
-  fgMagenta: "\x1b[35m",
-  fgCyan: "\x1b[36m",
-  fgWhite: "\x1b[37m",
-  fgReset: "\x1b[0m",
-};
-
-const DEPENDECY_TYPES = {
-  BIND: "BIND",
-  SINGLETON: "SINGLETON",
-};
-
-const TIMESTAMP_COLUMNS = {
-  CREATED_AT: "createdAtColumn",
-  UPDATED_AT: "updatedAtColumn",
-};
-
-export {
-  LOG_LEVEL,
-  HOOK_FUNCTIONS,
-  RELATIONSHIPS,
-  DEFAULT_METHODS_OF_MODELS,
-  HTTP_METHODS,
-  API_ROUTE_TEMPLATES,
-  LOG_COLORS,
-  DEPENDECY_TYPES,
-  HANDLERS,
-  DEFAULT_HANDLERS,
-  TIMESTAMP_COLUMNS,
-};

package/src/core/Config.js

@@ -1,38 +0,0 @@
-import path from "path";
-import fs from "fs";
-import url from "url";
-
-class Config {
-  constructor() {
-    this._isLoaded = false;
-  }
-
-  async load(directory) {
-    if (this._isLoaded) {
-      return;
-    }
-
-    directory = path.join(directory, "Config");
-    const files = fs.readdirSync(directory);
-    for (const file of files) {
-      const configFile = url.pathToFileURL(path.join(directory, file)).href;
-      let { default: configuration } = await import(configFile);
-
-      if (typeof configuration === "function") {
-        configuration = await configuration();
-      }
-
-      const key = file.replace(".js", "");
-      if (key === "load") {
-        throw new Error(
-          `This is a reserved name. You can not use this name as a configuration file name: "load"`
-        );
-      }
-
-      this[key] = configuration;
-    }
-    this._isLoaded = true;
-  }
-}
-
-export default Config;

package/src/core/Docs.js

@@ -1,43 +0,0 @@
-import { HTTP_METHODS } from "./../constants.js";
-import { getFormValidation } from "./../handlers/helpers.js";
-
-class Docs {
-  constructor() {
-    this.routes = [];
-  }
-
-  push(method, url, model) {
-    let fillable = undefined;
-    let validations = undefined;
-
-    if ([HTTP_METHODS.POST, HTTP_METHODS.PUT].includes(method)) {
-      // Deteching fillable fields
-      if (Array.isArray(model.instance.fillable)) {
-        fillable = model.instance.fillable;
-      } else {
-        fillable = model.instance.fillable[method];
-      }
-
-      // Detecting validations
-      if (model.instance.validations) {
-        validations = getFormValidation(method, model.instance.validations);
-      }
-    }
-
-    this.routes.push({
-      model: model.name,
-      table: model.instance.table,
-      columns: model.instance.columns,
-      method,
-      url,
-      fillable,
-      validations,
-    });
-  }
-
-  get() {
-    return this.routes;
-  }
-}
-
-export default Docs;

package/src/core/HttpResponse.js

@@ -1,10 +0,0 @@
-class HttpResponse extends Error {
-  constructor(status, content) {
-    super(content);
-    this.type = "HttpResponse";
-    this.status = status;
-    this.content = content;
-  }
-}
-
-export default HttpResponse;

package/src/core/IoC.js

@@ -1,41 +0,0 @@
-import { DEPENDECY_TYPES } from "./../constants.js";
-
-const items = {};
-
-const IoC = {
-  bind(name, callback) {
-    this._add(DEPENDECY_TYPES.BIND, name, callback);
-  },
-
-  singleton(name, callback) {
-    this._add(DEPENDECY_TYPES.SINGLETON, name, callback);
-  },
-
-  async use(name) {
-    const item = items[name];
-    if (!item) {
-      throw new Error(`Dependency is not found ${name}`);
-    }
-
-    if (item.type === DEPENDECY_TYPES.BIND) {
-      return await item.callback();
-    }
-
-    if (item.instance) {
-      return item.instance;
-    }
-
-    item.instance = await item.callback();
-    return item.instance;
-  },
-
-  _add(type, name, callback) {
-    items[name] = {
-      type,
-      callback,
-      instance: null,
-    };
-  },
-};
-
-export default IoC;

package/src/core/Logger.js

@@ -1,46 +0,0 @@
-import { LOG_LEVEL, LOG_COLORS } from "./../constants.js";
-const { fgRed, fgGreen, fgYellow, fgCyan, fgReset } = LOG_COLORS;
-
-class Logger {
-  constructor(level) {
-    this.level = level;
-  }
-
-  error(message) {
-    if (this.level <= LOG_LEVEL.ERROR) {
-      console.error(fgRed, "[axe]", message, fgReset);
-    }
-  }
-
-  warn(message) {
-    if (this.level <= LOG_LEVEL.WARNING) {
-      console.warn(fgYellow, "[axe]", message, fgReset);
-    }
-  }
-
-  info(message) {
-    if (this.level <= LOG_LEVEL.INFO) {
-      console.info(fgCyan, "[axe]", message, fgReset);
-    }
-  }
-
-  success(message) {
-    if (this.level <= LOG_LEVEL.INFO) {
-      console.info(fgGreen, "[axe]", message, fgReset);
-    }
-  }
-
-  log(message) {
-    if (this.level === LOG_LEVEL.ALL) {
-      console.log(message);
-    }
-  }
-
-  debug(message) {
-    if (this.level === LOG_LEVEL.ALL) {
-      console.log(message);
-    }
-  }
-}
-
-export default Logger;