miqro 1.6.9 → 1.7.4

package/src/utils/db/index.ts

@@ -1,128 +0,0 @@
-import { makemigrationsImpl, syncMakeMigrationsImpl } from "./automigrations";
-import { existsSync, mkdirSync, writeFileSync } from "fs";
-import { resolve } from "path";
-import { templates } from "../../utils/templates";
-import { ConfigFileNotFoundError, ConfigPathResolver, getLogger, Logger, parse } from "@miqro/core";
-
-const logger = console;
-
-export interface SequelizeRC {
-  // noinspection SpellCheckingInspection
-  config: string;
-  "migrations-path": string;
-  "seeders-path": string;
-  "models-path": string;
-}
-
-export const loadSequelizeRC = (sequelizercPath: string = ConfigPathResolver.getSequelizeRCFilePath(), logger?: Logger): SequelizeRC => {
-  // noinspection SpellCheckingInspection
-  if (!existsSync(sequelizercPath)) {
-    // noinspection SpellCheckingInspection
-    throw new ConfigFileNotFoundError(`missing ${sequelizercPath} file. maybe you didnt init your db config.`);
-  } else {
-    if (logger) {
-      logger.debug(`loading sequelize config from [${sequelizercPath}]`);
-    }
-    // noinspection SpellCheckingInspection
-    /* eslint-disable  @typescript-eslint/no-var-requires */
-    const sequelizerc: SequelizeRC = require(sequelizercPath);
-    return parse(sequelizercPath, sequelizerc, [
-      { name: "config", type: "string", required: true },
-      { name: "migrations-path", type: "string", required: true },
-      { name: "seeders-path", type: "string", required: true },
-      { name: "models-path", type: "string", required: true }
-    ], "no_extra") as SequelizeRC;
-  }
-};
-
-export const loadModels = (args?: { "models-path": string }): { path: string; modelsModule: any } => {
-  const sequelizerc = args ? args : loadSequelizeRC();
-  const modelsModule = require(sequelizerc["models-path"]);
-  return {
-    path: sequelizerc["models-path"],
-    modelsModule
-  };
-}
-
-export const loadSequelize = (args?: { "models-path": string }, l?: Logger): any => {
-  const logger = l ? l : getLogger("Database");
-  const { modelsModule, path } = loadModels();
-  if (!modelsModule.sequelize || typeof modelsModule.sequelize !== "object" || typeof modelsModule.sequelize.models !== "object") {
-    throw new Error(`${path} doesnt export sequelize`);
-  }
-  modelsModule.sequelize.log = (text: string): void => {
-    logger.info(text);
-  };
-  return modelsModule.sequelize;
-}
-
-
-// noinspection SpellCheckingInspection
-export const initDBConfig = (): boolean => {
-  try {
-    const initDir = (p: string): void => {
-      if (!existsSync(p)) {
-        logger.warn(`creating ${p}`);
-        mkdirSync(p);
-      } else {
-        logger.warn(`${p} already exists!. init will not create it.`);
-      }
-    };
-
-    const initFile = (p: string, template: string): void => {
-      if (!existsSync(p)) {
-        logger.warn(`creating ${p} file`);
-        writeFileSync(p, template);
-      } else {
-        logger.warn(`${p} already exists!. init will not create it.`);
-      }
-    };
-
-    // noinspection SpellCheckingInspection
-    const sequelizercPath = resolve(ConfigPathResolver.getBaseDirname(), ".sequelizerc");
-    if (existsSync(sequelizercPath)) {
-      logger.warn(`.sequelizerc already exists!. init will do nothing.`);
-      return false;
-    } else {
-      // disable experimental typescript support
-      const typescript = false; //existsSync(resolve(ConfigPathResolver.getBaseDirname(), "tsconfig.json")) ? true : false;
-      const dbFolder = resolve(ConfigPathResolver.getBaseDirname(), "db");
-      const migrationsFolder = resolve(dbFolder, "migrations");
-      const modelsFolder = typescript ? resolve("src", "models") : resolve(dbFolder, "models");
-      const seedersFolder = resolve(dbFolder, "seeders");
-      const modelLoaderPath = resolve(modelsFolder, typescript ? "index.ts" : "index.js");
-      const dbConfigFilePath = resolve(dbFolder, "connection.js");
-      // noinspection SpellCheckingInspection
-      initFile(sequelizercPath, templates.sequelizerc(typescript));
-      initDir(dbFolder);
-      initFile(dbConfigFilePath, templates.dbConfig);
-      initDir(migrationsFolder);
-      initDir(modelsFolder);
-      initFile(modelLoaderPath, templates.modelsIndex);
-      initDir(seedersFolder);
-    }
-    return true;
-  } catch (e: any) {
-    logger.error(e.message);
-    throw e;
-  }
-};
-
-// noinspection SpellCheckingInspection
-export const makemigrations = (): void => {
-  try {
-    makemigrationsImpl();
-  } catch (e: any) {
-    logger.error(e.message);
-    throw e;
-  }
-};
-
-export const syncMakeMigrations = (): void => {
-  try {
-    syncMakeMigrationsImpl();
-  } catch (e: any) {
-    logger.error(e.message);
-    throw e;
-  }
-};

package/src/utils/doc/index.ts

@@ -1,36 +0,0 @@
-import { SessionHandlerOptions, ConfigPathResolver, GroupPolicy, Logger, Method, ParseOptions } from "@miqro/core";
-import { traverseAPIRouteDir } from "@miqro/core/dist/handler/api-router-utils";
-import { basename, resolve } from "path";
-
-export const getDOCJSON = ({ dirname, subPath }: { dirname: string; subPath: string; }, logger: Logger): {
-  path?: string | string[];
-  method?: Method | Method[];
-  description?: string;
-  policy?: GroupPolicy;
-  headers?: ParseOptions | ParseOptions[];
-  session?: false | true | SessionHandlerOptions;
-  params?: false | ParseOptions | ParseOptions[];
-  query?: false | ParseOptions | ParseOptions[];
-  body?: false | ParseOptions | ParseOptions[];
-  result?: ParseOptions | ParseOptions[];
-  featureName: string;
-}[] => {
-  const apiTraverse = traverseAPIRouteDir(basename(dirname).toUpperCase(), resolve(ConfigPathResolver.getBaseDirname(), dirname), subPath, undefined, logger);
-  const docJSON = Object.keys(apiTraverse).map(featureName => {
-    const { path, method, options } = apiTraverse[featureName];
-    const { session, policy, description } = options ? options : { session: undefined, policy: undefined, description: undefined };
-    const { params, query, body, headers } = options && options.request ? options.request : { params: undefined, query: undefined, body: undefined, headers: undefined };
-    const result = options && options.response !== true ? options.response : undefined;
-    return {
-      path,
-      method,
-      headers,
-      session: session ? typeof session === "function" ? true : session : false,
-      policy,
-      params,
-      description, query, body, result,
-      featureName
-    };
-  });
-  return docJSON;
-}

package/src/utils/index.ts

@@ -1,9 +0,0 @@
-import cp from "child_process";
-
-export const execSync = (cmd: string, options?: cp.ExecSyncOptionsWithBufferEncoding): void => {
-  console.log(cmd);
-  cp.execSync(
-    cmd,
-    options ? { stdio: 'inherit', ...options } : { stdio: 'inherit' }
-  );
-}

package/src/utils/templates.ts

@@ -1,189 +0,0 @@
-// noinspection SpellCheckingInspection
-
-export const logEnvFile = `####################
-## logging
-LOG_LEVEL=info
-LOG_LEVEL_Database=error
-#LOG_FILE=./logs/dev.log
-`;
-
-export const featuresEnvFile = `####################
-## features
-#MY_CUSTOM_FEATURE=false
-`;
-
-export const dbEnvFile = `####################
-## db
-DB_URI=sqlite://user:password@localhost:3306/devdb
-DB_DIALECT_SSL=true
-DB_POOL_MAX=5
-DB_POOL_MIN=0
-DB_POOL_ACQUIRE=30000
-DB_POOL_IDDLE=10000
-DB_STORAGE=./dev.sqlite3
-`;
-
-export const authEnvFile = `####################
-## Auth
-TOKEN_LOCATION=header
-#TOKEN_LOCATION=query
-TOKEN_VERIFY_LOCATION=header
-#TOKEN_VERIFY_LOCATION=query
-TOKEN_HEADER=Authorization
-#TOKEN_QUERY=Authorization
-#TOKEN_VERIFY_ENDPOINT=
-TOKEN_VERIFY_ENDPOINT_METHOD=GET
-`;
-
-// noinspection SpellCheckingInspection
-const modelsIndex =
-  `'use strict';
-
-const fs = require('fs');
-const path = require('path');
-const Sequelize = require('sequelize');
-const basename = path.basename(__filename);
-
-const sequelizerc = require(path.resolve(__dirname, "..", "..", ".sequelizerc"));
-
-const config = require(sequelizerc.config);
-const modelsPath = sequelizerc['models-path'];
-const db = {};
-
-let sequelize;
-if (config.use_env_variable) {
-  sequelize = new Sequelize(process.env[config.use_env_variable], config);
-} else {
-  sequelize = new Sequelize(config.database, config.username, config.password, config);
-}
-
-fs
-  .readdirSync(modelsPath)
-  .filter(file => {
-    return (file.indexOf('.') !== 0) && (file !== basename) && (file.slice(-3) === '.js');
-  })
-  .forEach(file => {
-    const model = require(path.join(modelsPath, file))(sequelize, Sequelize.DataTypes);
-    db[model.name] = model;
-  });
-
-Object.keys(db).forEach(modelName => {
-  if (db[modelName].associate) {
-    db[modelName].associate(db);
-  }
-});
-
-module.exports = db;
-module.exports.sequelize = sequelize;
-module.exports.Sequelize = Sequelize;
-
-`;
-// noinspection SpellCheckingInspection
-const dbConfig =
-  `const { loadConfig, checkEnvVariables } = require("@miqro/core");
-
-loadConfig();
-
-const { URL } = require("url");
-
-const [DB_URI] = checkEnvVariables(["DB_URI"]);
-const [DB_POOL, DB_POOL_ACQUIRE, DB_POOL_IDDLE, DB_POOL_MAX, DB_POOL_MIN] = checkEnvVariables(["DB_POOL", "DB_POOL_ACQUIRE", "DB_POOL_IDDLE", "DB_POOL_MAX", "DB_POOL_MIN"], ["false", "30000", "10000", "5", "0"]);
-
-const pool = DB_POOL === "true" ? {
-  acquire: parseInt(DB_POOL_ACQUIRE, 10),
-  idle: parseInt(DB_POOL_IDDLE, 10),
-  max: parseInt(DB_POOL_MAX, 10),
-  min: parseInt(DB_POOL_MIN, 10)
-} : undefined;
-
-const parsed = new URL(process.env.DB_URI);
-
-module.exports = {
-  database: parsed.pathname.substr(1),
-  host: parsed.hostname,
-  port: parsed.port,
-  username: parsed.username,
-  password: parsed.password,
-  dialect: parsed.protocol.substring(0, parsed.protocol.length - 1),
-  dialectOptions: {
-    ssl: process.env.DB_DIALECT_SSL === "true" || process.env.DB_DIALECT_SSL === undefined ? true : false
-  },
-  pool,
-  storage: process.env.DB_STORAGE
-};
-`;
-// noinspection SpellCheckingInspection
-const sequelizerc = (typescript?: boolean): string =>
-  `const path = require("path");
-
-module.exports = {
-  "config": path.resolve(__dirname, "db", "connection.js"),
-  "migrations-path": path.resolve(__dirname, "db", "migrations"),
-  "seeders-path": path.resolve(__dirname, "db", "seeders"),
-  ${typescript ? `"models-path": path.resolve(__dirname, "dist", "models")` : `"models-path": path.resolve(__dirname, "db", "models")`},
-};
-`;
-
-const exampleModel = (modelName: string, typescript?: boolean): string => {
-  return typescript ? `import { Sequelize, DataTypes, ModelCtor, Model } from "sequelize";
-  
-export interface ${modelName.charAt(0).toUpperCase()}${modelName.substring(1)} { 
-  name: string; 
-  timestamp: number; 
-};
-export type ${modelName.charAt(0).toUpperCase()}${modelName.substring(1)}Model = Model<${modelName.charAt(0).toUpperCase()}${modelName.substring(1)}>;
-export type ${modelName.charAt(0).toUpperCase()}${modelName.substring(1)}ModelCtor = ModelCtor<${modelName.charAt(0).toUpperCase()}${modelName.substring(1)}Model>;
-
-module.exports = (sequelize: Sequelize): ${modelName.charAt(0).toUpperCase()}${modelName.substring(1)}ModelCtor => {
-  const ${modelName} = sequelize.define<${modelName.charAt(0).toUpperCase()}${modelName.substring(1)}Model>("${modelName}", {
-    name: {
-      type: DataTypes.STRING,
-      allowNull: false,
-      defaultValue: ""
-    },
-    timestamp: {
-      type: DataTypes.INTEGER,
-      allowNull: false,
-      defaultValue: 0
-    }
-  }, {});
-  /* eslint-disable  @typescript-eslint/ban-ts-comment */
-  // @ts-ignore
-  ${modelName}.associate = function (models) {
-    // associations can be defined here
-    // ${modelName}.belongsTo(models.....)
-  };
-  return ${modelName};
-  };
-
-
-  ` : `module.exports = (sequelize, DataTypes) => {
-  const ${modelName} = sequelize.define("${modelName}", {
-    name: {
-      type: DataTypes.STRING,
-      allowNull: false,
-      defaultValue: ""
-    },
-    surname: DataTypes.STRING,
-    email: DataTypes.STRING,
-    password: DataTypes.STRING
-  }, {});
-  ${modelName}.associate = function(models) {
-    // associations can be defined here
-    // ${modelName}.belongsTo(models.....)
-  };
-  return ${modelName};
-};`;
-};
-
-// noinspection SpellCheckingInspection
-export const templates = {
-  modelsIndex,
-  dbConfig,
-  sequelizerc,
-  exampleModel,
-  logEnvFile,
-  authEnvFile,
-  dbEnvFile,
-  featuresEnvFile
-};

package/tsconfig.json

@@ -1,32 +0,0 @@
-{
-  "typedocOptions": {
-    "entryPoints": ["src/index.ts"],
-    "out": "docs"
-  },
-  "compileOnSave": true,
-  "compilerOptions": {
-    "lib": ["es2021"],
-    "module": "commonjs",
-    "target": "es2021",
-
-    "strict": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true,
-    
-    "outDir": "./dist/",
-    "removeComments": false,
-    "noImplicitAny": true,
-    "preserveConstEnums": true,
-    "sourceMap": true,
-    "declaration": true,
-    "moduleResolution": "node"
-  },
-  "include": [
-    "src/**/*"
-  ],
-  "exclude": [
-    "node_modules",
-    "test/**/*"
-  ]
-}