refactor: 🎨 move to esm

change code structure and examples to an esmodules

BREAKING CHANGE: min node version -> 16, only works on es modules

example/db/models/index.ts

@@ -1,11 +1,14 @@
 import {existsSync, readdirSync} from 'fs';
 import {basename, join} from 'path';
 import {Sequelize} from 'sequelize';
+import {URL} from 'url';
 
+const __filename = new URL('', import.meta.url).pathname;
+const __dirname = new URL('.', import.meta.url).pathname;
 const associationsFile = 'associations';
 
-const importDefaultFunction = (path: string) => {
-  const imported = require(path);
+const importDefaultFunction = async (path: string) => {
+  const imported = await import(path);
   let init = imported;
   if (typeof imported !== 'function') {
     init = imported.default;
@@ -24,9 +27,7 @@ const initModels = async (sequelize: Sequelize) => {
       model !== basename(__filename) &&
       modelNoExtention !== associationsFile
     ) {
-      const init = await importDefaultFunction(
-        join(__dirname, modelNoExtention)
-      );
+      const init = await importDefaultFunction(join(__dirname, model));
       console.log('Init model', modelNoExtention);
       await init(sequelize);
     }
@@ -35,7 +36,9 @@ const initModels = async (sequelize: Sequelize) => {
     existsSync(join(__dirname, associationsFile + '.js')) ||
     existsSync(join(__dirname, associationsFile + '.ts'))
   ) {
-    const {default: init} = require(join(__dirname, associationsFile));
+    const {default: init} = await import(
+      join(__dirname, associationsFile + '.js')
+    );
     if (!init) {
       console.error(associationsFile, 'does not have a default export');
       return Promise.reject(

example/db/models/tasks.model.ts

@@ -1,5 +1,5 @@
 import {Sequelize, DataTypes} from 'sequelize';
-import {modelName as users} from './users.model';
+import {modelName as users} from './users.model.js';
 
 export const modelName = 'tasks';
 

example/db/models/users.model.ts

@@ -1,5 +1,5 @@
 import {Sequelize, DataTypes} from 'sequelize';
-import {modelName as tasks} from './tasks.model';
+import {modelName as tasks} from './tasks.model.js';
 
 export const modelName = 'users';
 

example/index.ts

@@ -1,10 +1,10 @@
 import express from 'express';
 
-import initDB from './db/models';
+import initDB from './db/models/index.js';
 import bodyParser from 'body-parser';
+import {modelName as users} from './db/models/users.model.js';
+import {modelName as tasks} from './db/models/tasks.model.js';
 import sequelizeCrud from 'express-sequelize-autocrud';
-import {modelName as users} from './db/models/users.model';
-import {modelName as tasks} from './db/models/tasks.model';
 
 const app = express();
 

example/package.json

@@ -4,6 +4,7 @@
   "description": "Example project for sequelize-mig-generator",
   "main": "index.js",
   "license": "MIT",
+  "type": "module",
   "dependencies": {
     "body-parser": "^1.20.2",
     "express": "^4.18.2",

package.json

@@ -2,6 +2,7 @@
   "name": "express-sequelize-autocrud",
   "version": "0.0.14",
   "main": "dist/src/index.js",
+  "type": "module",
   "files": [
     "dist"
   ],
@@ -51,7 +52,7 @@
     }
   },
   "engines": {
-    "node": ">=8.5.0"
+    "node": ">=16.0.0"
   },
   "keywords": [
     "express",

src/config.ts

@@ -1,4 +1,4 @@
-import {LoggerOptions, customFields} from './types';
+import {LoggerOptions, customFields} from './types.js';
 
 export const GET_LIST_DEFAULT_FILTERABLE_FIELDS: customFields = [];
 export const GET_LIST_DEFAULT_SORTABLE_FIELDS: customFields = [];

src/index.ts

@@ -1,9 +1,9 @@
 import {Sequelize} from 'sequelize';
 import {Router} from 'express';
-import {getPath} from './utils';
-import buildModelRoutes from './routes';
-import {sequelizeCrudConfig, sequelizeCrudOptions} from './types';
-import {defaultLogger} from './config';
+import {getPath} from './utils.js';
+import buildModelRoutes from './routes/index.js';
+import {sequelizeCrudConfig, sequelizeCrudOptions} from './types.js';
+import {defaultLogger} from './config.js';
 
 const sequelizeCrud = (
   sequelize: Sequelize,
@@ -24,4 +24,4 @@ const sequelizeCrud = (
 };
 
 export default sequelizeCrud;
-export * from './types';
+export * from './types.js';

src/middleware/body.ts

@@ -1,7 +1,7 @@
 import {NextFunction, Request, Response} from 'express';
-import {customFields} from '../types';
-import {isIncludeExcludeMatchCriteria} from './config';
-import {crudError} from '../utils';
+import {isIncludeExcludeMatchCriteria} from './config.js';
+import {crudError} from '../utils.js';
+import type {customFields} from '../types.js';
 
 export const checkBodyFields = (bodyFields: customFields) => {
   return async (req: Request, res: Response, next: NextFunction) => {

src/middleware/config.ts

@@ -1,11 +1,11 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import {NextFunction, Request, Response} from 'express';
-import {
+import type {
   customFields,
   expressCrudProps,
   expressFunc,
   sequelizePropOrFunc,
-} from '../types';
+} from '../types.js';
 
 export const getFieldValue = async <T = any>(
   field: sequelizePropOrFunc<T>,

src/middleware/query.ts

@@ -1,13 +1,13 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import {FindAndCountOptions} from 'sequelize';
-import {customFields} from '../types';
 import {NextFunction, Request, Response} from 'express';
-import {isIncludeExcludeMatchCriteria} from './config';
-import {crudError} from '../utils';
+import {isIncludeExcludeMatchCriteria} from './config.js';
+import {crudError} from '../utils.js';
 import {
   GET_LIST_DEFAULT_FILTERABLE_FIELDS,
   GET_LIST_DEFAULT_SORTABLE_FIELDS,
-} from '../config';
+} from '../config.js';
+import type {customFields} from '../types.js';
 
 export const buildOptionsFromQueryParams = (
   q: Record<string, any>,

src/routes/create.ts

@@ -1,14 +1,14 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 import {Router} from 'express';
-import {LoggerOptions, createOptions, pureModelType} from '../types';
 import {
   buildOptionsFromConfig,
   runCustomMiddleware,
-} from '../middleware/config';
-import {checkBodyFields} from '../middleware/body';
-import {getSequelizeErrorMessage} from '../utils';
+} from '../middleware/config.js';
+import {checkBodyFields} from '../middleware/body.js';
+import {getSequelizeErrorMessage} from '../utils.js';
 import {Sequelize} from 'sequelize';
-import {DEFAULT_CREATABLE_FIELDS} from '../config';
+import {DEFAULT_CREATABLE_FIELDS} from '../config.js';
+import type {LoggerOptions, createOptions, pureModelType} from '../types.js';
 
 const createRoute = (
   sequelize: Sequelize,

src/routes/delete.ts

@@ -1,12 +1,12 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 import {Router} from 'express';
-import {LoggerOptions, deleteOptions, pureModelType} from '../types';
 import {
   buildOptionsFromConfig,
   runCustomMiddleware,
-} from '../middleware/config';
-import {getSequelizeErrorMessage} from '../utils';
+} from '../middleware/config.js';
+import {getSequelizeErrorMessage} from '../utils.js';
 import {Sequelize} from 'sequelize';
+import type {LoggerOptions, deleteOptions, pureModelType} from '../types.js';
 
 const deleteRoute = (
   sequelize: Sequelize,

src/routes/getList.ts

@@ -1,17 +1,18 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 import {Router} from 'express';
-import {LoggerOptions, getListOptions, pureModelType} from '../types';
 import {
   buildOptionsFromConfig,
   runCustomMiddleware,
-} from '../middleware/config';
+} from '../middleware/config.js';
 import {
   buildOptionsFromQueryParams,
   checkFilterableFields,
   checkSortableFields,
   setContentRange,
-} from '../middleware/query';
-import {getSequelizeErrorMessage} from '../utils';
+} from '../middleware/query.js';
+import {getSequelizeErrorMessage} from '../utils.js';
+
+import type {LoggerOptions, getListOptions, pureModelType} from '../types.js';
 
 const getListRoute = (
   model: pureModelType,

src/routes/getOne.ts

@@ -1,10 +1,10 @@
 import {Router} from 'express';
-import {LoggerOptions, getOneOptions, pureModelType} from '../types';
 import {
   buildOptionsFromConfig,
   runCustomMiddleware,
-} from '../middleware/config';
-import {getSequelizeErrorMessage} from '../utils';
+} from '../middleware/config.js';
+import {getSequelizeErrorMessage} from '../utils.js';
+import type {LoggerOptions, getOneOptions, pureModelType} from '../types.js';
 
 const getOneRoute = (
   model: pureModelType,

src/routes/index.ts

@@ -1,13 +1,14 @@
 import {Router} from 'express';
-import {LoggerOptions, sequelizeCrudConfigModel} from '../types';
-import {getModel} from '../utils';
+import {getModel} from '../utils.js';
 import {Sequelize} from 'sequelize';
 
-import getListRoute from './getList';
-import getOneRoute from './getOne';
-import createRoute from './create';
-import updateRoute from './update';
-import deleteRoute from './delete';
+import getListRoute from './getList.js';
+import getOneRoute from './getOne.js';
+import createRoute from './create.js';
+import updateRoute from './update.js';
+import deleteRoute from './delete.js';
+
+import type {LoggerOptions, sequelizeCrudConfigModel} from '../types.js';
 
 const buildModelRoutes = (
   path: string,

src/routes/update.ts

@@ -1,14 +1,14 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 import {Router} from 'express';
-import {updateOptions, pureModelType, LoggerOptions} from '../types';
 import {
   buildOptionsFromConfig,
   runCustomMiddleware,
-} from '../middleware/config';
-import {checkBodyFields} from '../middleware/body';
-import {getSequelizeErrorMessage} from '../utils';
+} from '../middleware/config.js';
+import {checkBodyFields} from '../middleware/body.js';
+import {getSequelizeErrorMessage} from '../utils.js';
 import {Sequelize} from 'sequelize';
-import {DEFAULT_UPDATABLE_FIELDS} from '../config';
+import {DEFAULT_UPDATABLE_FIELDS} from '../config.js';
+import type {updateOptions, pureModelType, LoggerOptions} from '../types.js';
 
 const updateRoute = (
   sequelize: Sequelize,

src/utils.ts

@@ -1,5 +1,5 @@
 import {Sequelize} from 'sequelize';
-import {modelType} from './types';
+import type {modelType} from './types.js';
 
 export const getModel = (sequelize: Sequelize, model: modelType) =>
   typeof model === 'string' ? sequelize.model(model) : model;

tsconfig.json

@@ -1,6 +1,9 @@
 {
   "extends": "./node_modules/gts/tsconfig-google.json",
   "compilerOptions": {
+    "lib": ["es2021"],
+    "module": "node16",
+    "target": "es2021",
     "rootDir": ".",
     "outDir": "dist"
   },