feat: gen /lib & /types from /src & drop /dist (v6) (#14063)

.eslintrc.js

@@ -184,7 +184,8 @@ module.exports = {
     ecmaVersion: 2020,
     sourceType: 'script',
   },
-  ignorePatterns: ['dist/**/*', 'types/**/*', 'dev/**/*'],
+  // TODO: un-ignore test/types/**, and src/**/*.d.ts
+  ignorePatterns: ['lib/**/*', 'types/**/*', 'test/types/**/*', 'src/**/*.d.ts'],
   env: {
     node: true,
     mocha: true,

.gitignore

@@ -14,5 +14,6 @@ test/binary/tmp/*
 .vscode/
 esdoc
 node_modules
-dist
 *.log
+/lib
+/types

build.js

@@ -9,23 +9,23 @@ const path = require('path');
 const exec = promisify(require('child_process').exec);
 
 const stat = promisify(fs.stat);
-const copyFile = promisify(fs.copyFile);
 
 // if this script is moved, this will need to be adjusted
 const rootDir = __dirname;
-const outdir = path.join(rootDir, 'dist');
+const outdir = path.join(rootDir, 'lib');
+const typesDir = path.join(rootDir, 'types');
 
 const nodeMajorVersion = Number(process.version.match(/(?<=^v)\d+/));
 
-async function rmDistDir() {
+async function rmDir(dirName) {
   try {
-    await stat(outdir);
+    await stat(dirName);
     if (nodeMajorVersion >= 14) {
       const rm = promisify(fs.rm);
-      await rm(outdir, { recursive: true });
+      await rm(dirName, { recursive: true });
     } else {
       const rmdir = promisify(fs.rmdir);
-      await (nodeMajorVersion >= 12 ? rmdir(outdir, { recursive: true }) : rmdir(outdir));
+      await (nodeMajorVersion >= 12 ? rmdir(dirName, { recursive: true }) : rmdir(dirName));
     }
   } catch {
     /* no-op */
@@ -34,23 +34,46 @@ async function rmDistDir() {
 
 async function main() {
   console.info('Compiling sequelize...');
-  const [declarationFiles, filesToCompile] = await Promise.all([
-    // Find all .d.ts files from types/
-    glob('./types/**/*.d.ts', { onlyFiles: true, absolute: false }),
-    // Find all .js and .ts files from lib/
-    glob('./lib/**/*.[tj]s', { onlyFiles: true, absolute: false }),
-    // Delete dist/ for a full rebuild.
-    rmDistDir(),
+  const [sourceFiles] = await Promise.all([
+    // Find all .js and .ts files from /src
+    glob('./src/**/*.{mjs,cjs,js,mts,cts,ts}', { onlyFiles: true, absolute: false }),
+    // Delete /lib for a full rebuild.
+    rmDir(outdir),
+    // Delete /types for a full rebuild.
+    rmDir(typesDir),
   ]);
 
+  const filesToCompile = [];
+  const filesToCopyToLib = [];
+  const declarationFiles = [];
+
+  for (const file of sourceFiles) {
+    // mjs files cannot be built as they would be compiled to commonjs
+    if (file.endsWith('.mjs')) {
+      filesToCopyToLib.push(file);
+    } else if (file.endsWith('.d.ts')) {
+      declarationFiles.push(file);
+    } else {
+      filesToCompile.push(file);
+    }
+  }
+
   // copy .d.ts files prior to generating them from the .ts files
   // so the .ts files in lib/ will take priority..
   await copyFiles(
     // The last path in the list is the output directory
-    [...declarationFiles, outdir],
+    [...declarationFiles, typesDir],
     { up: 1 },
   );
 
+  if (filesToCopyToLib.length > 0) {
+    await copyFiles(
+      // The last path in the list is the output directory
+      filesToCopyToLib.concat(outdir),
+      { up: 1 },
+    );
+  }
+
   await Promise.all([
     build({
       // Adds source mapping
@@ -61,13 +84,10 @@ async function main() {
       format: 'cjs',
 
       outdir,
-      entryPoints: [...filesToCompile, './index.js']
+      entryPoints: filesToCompile
         .map(file => path.resolve(file)),
     }),
 
-    // not passed to "build" because we need this file to stay as ESM instead of CJS
-    copyFile('./index.mjs', path.resolve(outdir, './index.mjs')),
-
     exec('tsc', {
       env: {
         // binaries installed from modules have symlinks in

index.js

@@ -1,10 +1,12 @@
 'use strict';
 
+// TODO [>=7]: remove me. I've been moved to 'exports' in package.json
+
 /**
   * A Sequelize module that contains the sequelize entry point.
   *
   * @module sequelize
   */
 
 /** Exports the sequelize entry point. */
-module.exports = require('./lib/sequelize');
+module.exports = require('./lib');

package.json

@@ -16,28 +16,25 @@
     "url": "https://github.com/sequelize/sequelize/issues"
   },
   "homepage": "https://sequelize.org/",
-  "main": "./dist/index.js",
-  "types": "./dist",
+  "main": "./lib/index.js",
+  "types": "./types",
   "type": "commonjs",
   "exports": {
     ".": {
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.js"
+      "import": "./lib/index.mjs",
+      "require": "./lib/index.js"
     },
-    "./lib/*": "./dist/lib/*.js",
-    "./lib/errors": "./dist/lib/errors/index.js",
+    "./lib/*": "./lib/*.js",
+    "./lib/errors": "./lib/errors/index.js",
     "./*": "./*"
   },
   "engines": {
     "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
   },
   "files": [
-    "dist",
     "lib",
-    "index.js",
-    "types/index.d.ts",
-    "types/lib",
-    "types/type-helpers"
+    "types",
+    "index.js"
   ],
   "license": "MIT",
   "dependencies": {
@@ -210,7 +207,7 @@
     "lint": "eslint . --fix --report-unused-disable-directives",
     "lint-no-fix": "eslint . --quiet --report-unused-disable-directives",
     "lint-docs": "markdownlint docs",
-    "test-typings": "tsc -b types/tsconfig.json && tsc -b types/test/tsconfig.json && tsc --noEmit --emitDeclarationOnly false && tsc -b test/tsconfig.json",
+    "test-typings": "tsc --noEmit --emitDeclarationOnly false && tsc -b test/tsconfig.json",
     "----------------------------------------- documentation -------------------------------------------": "",
     "docs": "rimraf esdoc && esdoc -c docs/esdoc-config.js && cp docs/favicon.ico esdoc/favicon.ico && cp docs/ROUTER.txt esdoc/ROUTER && node docs/run-docs-transforms.js && node docs/redirects/create-redirects.js && rimraf esdoc/file esdoc/source.html",
     "----------------------------------------- tests ---------------------------------------------------": "",

types/lib/query-interface.d.ts → src/dialects/abstract/query-interface.d.ts

@@ -1,4 +1,4 @@
-import { DataType } from './data-types';
+import { DataType } from '../../data-types';
 import {
   Logging,
   Model,
@@ -8,17 +8,17 @@ import {
   WhereOptions,
   Filterable,
   Poolable,
-  ModelCtor,
   ModelStatic,
   ModelType,
   CreationAttributes,
   Attributes,
-} from './model';
-import { QueryTypes, Transaction } from '..';
-import { Sequelize, RetryOptions } from './sequelize';
-import { SetRequired } from './../type-helpers/set-required';
-import { Fn, Literal } from './utils';
-import { Deferrable } from './deferrable';
+} from '../../model';
+import { QueryTypes } from '../../query-types';
+import { Sequelize, RetryOptions } from '../../sequelize';
+import { Transaction } from '../../transaction';
+import { SetRequired } from '../../utils/set-required';
+import { Fn, Literal } from '../../utils';
+import { Deferrable } from '../../deferrable';
 
 type BindOrReplacements = { [key: string]: unknown } | unknown[];
 type FieldMap = { [key: string]: string };

types/lib/query.d.ts → src/dialects/abstract/query.d.ts

@@ -1,10 +1,7 @@
-import { IncludeOptions } from '..';
 import { Connection } from './connection-manager';
-import {
-  Model, ModelType
-} from './model';
-import { Sequelize } from './sequelize';
-import { QueryTypes } from '..';
+import { QueryTypes } from '../../query-types';
+import { Model, ModelType, IncludeOptions } from '../../model';
+import { Sequelize } from '../../sequelize';
 
 type BindOrReplacements = { [key: string]: unknown } | unknown[];
 type FieldMap = { [key: string]: string };
@@ -161,24 +158,28 @@ export class AbstractQuery {
 
   /**
    * Checks if the query type is RAW
+   *
    * @returns {boolean}
    */
   public isRawQuery(): boolean;
 
   /**
    * Checks if the query type is VERSION
+   *
    * @returns {boolean}
    */
   public isVersionQuery(): boolean;
 
   /**
    * Checks if the query type is UPSERT
+   *
    * @returns {boolean}
    */
   public isUpsertQuery(): boolean;
 
   /**
    * Checks if the query type is INSERT
+   *
    * @returns {boolean}
    */
   public isInsertQuery(results?: unknown[], metaData?: unknown): boolean;
@@ -194,6 +195,7 @@ export class AbstractQuery {
 
   /**
    * Checks if the query type is SHOWTABLES
+   *
    * @returns {boolean}
    */
   public isShowTablesQuery(): boolean;
@@ -208,48 +210,56 @@ export class AbstractQuery {
 
   /**
    * Checks if the query type is SHOWINDEXES
+   *
    * @returns {boolean}
    */
   public isShowIndexesQuery(): boolean;
 
   /**
    * Checks if the query type is SHOWCONSTRAINTS
+   *
    * @returns {boolean}
    */
   public isShowConstraintsQuery(): boolean;
 
   /**
    * Checks if the query type is DESCRIBE
+   *
    * @returns {boolean}
    */
   public isDescribeQuery(): boolean;
 
   /**
    * Checks if the query type is SELECT
+   *
    * @returns {boolean}
    */
   public isSelectQuery(): boolean;
 
   /**
    * Checks if the query type is BULKUPDATE
+   *
    * @returns {boolean}
    */
   public isBulkUpdateQuery(): boolean;
 
   /**
    * Checks if the query type is BULKDELETE
+   *
    * @returns {boolean}
    */
   public isBulkDeleteQuery(): boolean;
 
   /**
    * Checks if the query type is FOREIGNKEYS
+   *
    * @returns {boolean}
    */
   public isForeignKeysQuery(): boolean;
 
   /**
    * Checks if the query type is UPDATE
+   *
    * @returns {boolean}
    */
   public isUpdateQuery(): boolean;
@@ -264,12 +274,14 @@ export class AbstractQuery {
 
   /**
    * Checks if the query starts with 'show' or 'describe'
+   *
    * @returns {boolean}
    */
   public isShowOrDescribeQuery(): boolean;
 
   /**
    * Checks if the query starts with 'call'
+   *
    * @returns {boolean}
    */
   public isCallQuery(): boolean;

lib/errors/bulk-record-error.ts → src/errors/bulk-record-error.ts

@@ -1,4 +1,4 @@
-import type { Model } from '../..';
+import type { Model } from '..';
 import BaseError from './base-error';
 
 /**

lib/errors/validation-error.ts → src/errors/validation-error.ts

@@ -1,4 +1,4 @@
-import type { Model } from '../..';
+import type { Model } from '..';
 import type { ErrorOptions } from './base-error';
 import BaseError from './base-error';
 

types/lib/hooks.d.ts → src/hooks.d.ts

@@ -1,4 +1,3 @@
-import { Attributes, CreationAttributes, ModelType } from '../index';
 import { ValidationOptions } from './instance-validator';
 import Model, {
   BulkCreateOptions,
@@ -9,10 +8,11 @@ import Model, {
   InstanceRestoreOptions,
   InstanceUpdateOptions,
   ModelAttributes,
-  ModelOptions, RestoreOptions, UpdateOptions, UpsertOptions
+  ModelOptions, RestoreOptions, UpdateOptions, UpsertOptions,
+  Attributes, CreationAttributes, ModelType
 } from './model';
-import { AbstractQuery } from './query';
-import { QueryOptions } from './query-interface';
+import { AbstractQuery } from './dialects/abstract/query';
+import { QueryOptions } from './dialects/abstract/query-interface';
 import { Config, Options, Sequelize, SyncOptions } from './sequelize';
 import { DeepWriteable } from './utils';
 
@@ -34,7 +34,7 @@ export interface ModelHooks<M extends Model = Model, TAttributes = any> {
   beforeUpdate(instance: M, options: InstanceUpdateOptions<TAttributes>): HookReturn;
   afterUpdate(instance: M, options: InstanceUpdateOptions<TAttributes>): HookReturn;
   beforeUpsert(attributes: M, options: UpsertOptions<TAttributes>): HookReturn;
-  afterUpsert(attributes: [ M,  boolean | null ], options: UpsertOptions<TAttributes>): HookReturn;
+  afterUpsert(attributes: [ M, boolean | null ], options: UpsertOptions<TAttributes>): HookReturn;
   beforeSave(
     instance: M,
     options: InstanceUpdateOptions<TAttributes> | CreateOptions<TAttributes>