feat: transform bauta into an ESM module

.gitignore

@@ -36,3 +36,5 @@ coverage/
 test-report.xml
 
 .turbo
+
+.vscode

lerna.json

@@ -14,5 +14,5 @@
     }
   },
   "useWorkspaces": true,
-  "version": "3.1.0"
+  "version": "4.0.0-alpha.0"
 }

package.json

@@ -12,6 +12,7 @@
     "proxy",
     "multipart"
   ],
+  "type": "module",
   "workspaces": [
     "packages/*"
   ],
@@ -31,6 +32,8 @@
     "lint": "eslint \"*/**/*.{ts,js}\"",
     "test": "turbo run test",
     "release": "lerna changed && lerna publish --no-changelog --yes --no-commit-hooks",
+    "release:beta:prepare": "lerna version --conventional-prerelease --no-changelog --no-git-tag-version --no-private --no-push",
+    "release:beta:publish": "lerna publish from-package --no-changelog --yes --no-commit-hooks",
     "checkDeps": "npx npm-check-updates -u && npm run lerna exec -- npx npm-check-updates -u",
     "build": "turbo run build",
     "prepare": "husky install"

packages/bautajs-core/package.json

@@ -1,17 +1,18 @@
 {
   "name": "@axa/bautajs-core",
-  "version": "3.1.0",
+  "version": "4.0.0-alpha.0",
   "description": "Bauta.js is an add-on for your Node.js applications such as Express.js or Fastify.",
-  "main": "dist",
+  "exports": "./dist/index.js",
   "types": "dist",
+  "type": "module",
   "files": [
     "dist"
   ],
   "scripts": {
     "tsc": "tsc",
     "build": "tsc --build",
     "clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist",
-    "test": "jest"
+    "test": "node --experimental-vm-modules ../../node_modules/jest/bin/jest.js"
   },
   "bugs": {
     "url": "https://github.com/axa-group/bauta.js/issues"
@@ -38,7 +39,7 @@
     "@apidevtools/swagger-parser": "^10.1.0",
     "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",
-    "fast-glob": "^3.2.12",
+    "fast-glob": "^3.3.0",
     "fast-safe-stringify": "^2.1.1",
     "hyperid": "^3.1.1",
     "openapi-types": "^12.1.0",
@@ -47,6 +48,6 @@
     "quick-lru-cjs": "^5.2.1"
   },
   "devDependencies": {
-    "@axa/bautajs-dev-config": "^3.0.1"
+    "@axa/bautajs-dev-config": "^4.0.0-alpha.0"
   }
 }

packages/bautajs-core/src/bauta.ts

@@ -1,21 +1,22 @@
 import fastGlob from 'fast-glob';
-import { resolve } from 'path';
+import { resolve } from 'node:path';
 import { OpenAPIV2 } from 'openapi-types';
-import { OperationBuilder } from './core/operation';
-import { defaultLogger } from './default-logger';
+import { OperationBuilder } from './core/operation.js';
+import { defaultLogger } from './default-logger.js';
 import {
   BautaJSInstance,
   BautaJSOptions,
   Document,
   Logger,
   Operations,
   BasicOperation,
-  Validator
-} from './types';
-import { isLoggerValid } from './utils/logger-validator';
-import Parser from './open-api/parser';
-import { decorate } from './utils/decorate';
-import { AjvValidator } from './open-api/ajv-validator';
+  Validator,
+  Resolver
+} from './types.js';
+import { isLoggerValid } from './utils/logger-validator.js';
+import Parser from './open-api/parser.js';
+import { decorate } from './utils/decorate.js';
+import { AjvValidator } from './open-api/ajv-validator.js';
 
 interface API {
   version: string;
@@ -87,6 +88,13 @@ export class BautaJS implements BautaJSInstance {
 
   private bootstrapped = false;
 
+  // to not load the resolvers twice (only relevant for versioning operations)
+  private resolversAlreadyLoaded = false;
+
+  private readonly resolversPath: string | string[] | undefined;
+
+  private resolvers: Resolver[] | undefined;
+
   constructor({
     apiDefinition,
     staticConfig,
@@ -106,6 +114,7 @@ export class BautaJS implements BautaJSInstance {
     this.staticConfig = staticConfig;
 
     this.logger = logger || defaultLogger('@axa/bautajs-core');
+
     if (!isLoggerValid(this.logger)) {
       throw new Error(
         'Logger is not valid. Must be compliant with basic logging levels(trace, debug, info, warn, error, fatal)'
@@ -123,24 +132,37 @@ export class BautaJS implements BautaJSInstance {
     this.validator = new AjvValidator(customValidationFormats, validatorOptions);
     this.operations = this.registerOperations(requestValidation, responseValidation, api);
 
-    // Load custom resolvers and operations modifiers
-    if (resolvers) {
-      resolvers.forEach(resolver => {
-        resolver(this.operations);
-      });
-    } else {
-      BautaJS.requireAll<[Operations]>(
-        resolversPath || './server/resolvers/**/*resolver.js',
-        true,
-        [this.operations]
-      );
+    // This is required for loadResolvers, done this way to not modify the bauta.js construction interface which would be a big clusterluck
+    this.resolvers = resolvers;
+    this.resolversPath = resolversPath;
+  }
+
+  public async loadResolvers(): Promise<void> {
+    if (this.resolversAlreadyLoaded === false) {
+      // Load custom resolvers and operations modifiers
+      if (this.resolvers) {
+        this.resolvers.forEach(resolver => {
+          resolver(this.operations);
+        });
+      } else {
+        await BautaJS.requireAll<[Operations]>(
+          this.resolversPath || './server/resolvers/**/*resolver.js',
+          true,
+          [this.operations]
+        );
+      }
+
+      this.resolversAlreadyLoaded = true;
     }
   }
 
   public async bootstrap(): Promise<void> {
     if (this.bootstrapped === true) {
       throw new Error('The instance has already being bootstrapped.');
     }
+
+    await this.loadResolvers();
+
     if (this.apiDefinition) {
       const parser = new Parser(this.logger);
       const parsedApiDefinition = await parser.asyncParse(this.apiDefinition);
@@ -233,12 +255,16 @@ export class BautaJS implements BautaJSInstance {
    *
    * const files = requireAll('./my/path/to/datasources/*.js', true, {someVar:123});
    */
-  static requireAll<T>(folder: string | string[], execute = true, vars?: T) {
-    const execFiles = (folderPath: string) => {
+  static async requireAll<T>(folder: string | string[], execute = true, vars?: T) {
+    const execFiles = async (folderPath: string) => {
       const result: any = [];
-      fastGlob.sync(folderPath.replace(/\\/g, '/')).forEach((file: string) => {
-        // eslint-disable-next-line global-require, import/no-dynamic-require, @typescript-eslint/no-var-requires
-        let data = require(resolve(file));
+      const files = await fastGlob.async(folderPath.replace(/\\/g, '/'));
+
+      for (let i = 0; i < files.length; i++) {
+        const file = files[i];
+
+        let data = await import(resolve(file));
+
         if (data.default) {
           data = data.default;
         }
@@ -247,28 +273,37 @@ export class BautaJS implements BautaJSInstance {
         }
 
         result.push(data);
-      });
+      }
 
       return result;
     };
 
     let files = [];
     if (Array.isArray(folder)) {
-      files = folder.map(folderPath => execFiles(folderPath));
+      for (let i = 0; i < folder.length; i++) {
+        const folderPath = folder[i];
+        files.push(await execFiles(folderPath));
+      }
     } else {
-      files = execFiles(folder);
+      files = await execFiles(folder);
     }
 
     return files;
   }
 
-  public inheritOperationsFrom(bautajsInstance: BautaJSInstance) {
+  public async inheritOperationsFrom(bautajsInstance: BautaJSInstance) {
     if (!(bautajsInstance instanceof BautaJS)) {
       throw new Error('A bautaJS instance must be provided.');
     }
+
     if (this.bootstrapped === true) {
       throw new Error('Operation inherit should be done before bootstrap the BautaJS instance.');
     }
+
+    // We need to do this before the overriding of the operations
+    // When we do not version, this is done in bootstrap, but when we version, we need to do it here
+    await bautajsInstance.loadResolvers();
+
     if (bautajsInstance.bootstrapped === false) {
       this.logger.warn(
         'The given instance is not bootstrapped, thus operation schema will be no inherited.'

packages/bautajs-core/src/core/cancelable-token.ts

@@ -1,4 +1,4 @@
-import { CancelableToken, OnCancel } from '../types';
+import { CancelableToken, OnCancel } from '../types.js';
 
 export class CancelableTokenBuilder implements CancelableToken {
   private cancelStack: OnCancel[] = [];

packages/bautajs-core/src/core/not-found-error.ts

@@ -13,7 +13,7 @@ export class NotFoundError extends Error {
   }
 
   private formatStack() {
-    return `${this.name}: ${this.message} \n ${fastSafeStringify(this, undefined, 2)}`;
+    return `${this.name}: ${this.message} \n ${fastSafeStringify.default(this, undefined, 2)}`;
   }
 
   public toJSON() {

packages/bautajs-core/src/core/operation.ts

@@ -9,11 +9,11 @@ import {
   Pipeline,
   Request,
   RawData
-} from '../types';
-import { buildDefaultStep } from '../utils/default-step';
-import { createContext } from '../utils/create-context';
-import { isPromise } from '../utils/is-promise';
-import { ValidationError } from './validation-error';
+} from '../types.js';
+import { buildDefaultStep } from '../utils/default-step.js';
+import { createContext } from '../utils/create-context.js';
+import { isPromise } from '../utils/is-promise.js';
+import { ValidationError } from './validation-error.js';
 
 export class OperationBuilder implements Operation {
   public static create(id: string, bautajs: BautaJSInstance): Operation {

packages/bautajs-core/src/core/validation-error.ts

@@ -1,5 +1,5 @@
 import fastSafeStringify from 'fast-safe-stringify';
-import { IValidationError, LocationError } from '../types';
+import { IValidationError, LocationError } from '../types.js';
 
 export class ValidationError extends Error implements IValidationError {
   public errors: LocationError[];
@@ -20,7 +20,7 @@ export class ValidationError extends Error implements IValidationError {
   }
 
   private formatStack() {
-    return `${this.name}: ${this.message} \n ${fastSafeStringify(this, undefined, 2)}`;
+    return `${this.name}: ${this.message} \n ${fastSafeStringify.default(this, undefined, 2)}`;
   }
 
   public toJSON() {

packages/bautajs-core/src/decorators/as-promise.ts

@@ -1,5 +1,5 @@
-import { promisify } from 'util';
-import { BautaJSInstance, Context, GenericError, Pipeline } from '../types';
+import { promisify } from 'node:util';
+import { BautaJSInstance, Context, GenericError, Pipeline } from '../types.js';
 
 export type StepFunctionCallback<TIn, TOut> = (
   prev: TIn,

packages/bautajs-core/src/decorators/as-value.ts

@@ -1,4 +1,4 @@
-import { Pipeline } from '../types';
+import { Pipeline } from '../types.js';
 
 /**
  *

packages/bautajs-core/src/decorators/cache.ts

@@ -1,6 +1,6 @@
 import nodeObjectHash from 'node-object-hash';
 import QuickLRU, { Options } from 'quick-lru-cjs';
-import { BautaJSInstance, Context, Pipeline } from '../types';
+import { BautaJSInstance, Context, Pipeline } from '../types.js';
 
 export interface Normalizer<TIn, CacheKey> {
   (prev: TIn, ctx: Context, bautajs: BautaJSInstance): CacheKey;

packages/bautajs-core/src/decorators/iif.ts

@@ -1,4 +1,4 @@
-import { BautaJSInstance, Context, Pipeline } from '../types';
+import { BautaJSInstance, Context, Pipeline } from '../types.js';
 /**
  * @deprecated This function is deprecated and will be removed in future releases
  *

packages/bautajs-core/src/decorators/map.ts

@@ -1,4 +1,4 @@
-import { BautaJSInstance, Context } from '../types';
+import { BautaJSInstance, Context } from '../types.js';
 /**
  * Decorator that allows to loop over the given selected array and map each item.
  *

packages/bautajs-core/src/decorators/match.ts

@@ -1,4 +1,4 @@
-import { BautaJSInstance, Context, Pipeline } from '../types';
+import { BautaJSInstance, Context, Pipeline } from '../types.js';
 
 /**
  * Resolve the given predicate an execute the pipeline for that condition

packages/bautajs-core/src/decorators/pairwise.ts

@@ -1,5 +1,5 @@
-import { Pipeline } from '../types';
-import { isPromise } from '../utils/is-promise';
+import { Pipeline } from '../types.js';
+import { isPromise } from '../utils/is-promise.js';
 /**
  * Decorator that returns the previous and current value as array
  *

packages/bautajs-core/src/decorators/parallel-all-settled.ts

@@ -1,4 +1,4 @@
-import { Pipeline } from '../types';
+import { Pipeline } from '../types.js';
 
 export function parallelAllSettled<TIn, TOut1, TOut2>(
   fn1: Pipeline.StepFunction<TIn, TOut1>,

packages/bautajs-core/src/decorators/parallel-map.ts

@@ -1,5 +1,5 @@
-import { BautaJSInstance, Context, Pipeline } from '../types';
-import { map } from './map';
+import { BautaJSInstance, Context, Pipeline } from '../types.js';
+import { map } from './map.js';
 
 /**
  * Loop over the selected array and create a promise for each array item with the given mapFn, then it will resolve everything in parallel.

packages/bautajs-core/src/decorators/parallel.ts

@@ -1,4 +1,4 @@
-import { Pipeline } from '../types';
+import { Pipeline } from '../types.js';
 
 export function parallel<TIn, TOut1, TOut2>(
   fn1: Pipeline.StepFunction<TIn, TOut1>,

packages/bautajs-core/src/decorators/pipeline.ts

@@ -1,5 +1,5 @@
-import { BautaJSInstance, Context, GenericError, Pipeline } from '../types';
-import { isPromise } from '../utils/is-promise';
+import { BautaJSInstance, Context, GenericError, Pipeline } from '../types.js';
+import { isPromise } from '../utils/is-promise.js';
 
 export function compose<T, R>(
   f1: Pipeline.StepFunction<T, R>,

packages/bautajs-core/src/decorators/resolver.ts

@@ -1,4 +1,4 @@
-import { Resolver } from '../types';
+import { Resolver } from '../types.js';
 
 export function resolver(fn: Resolver) {
   return fn;

packages/bautajs-core/src/decorators/retry-when.ts

@@ -1,4 +1,4 @@
-import { Pipeline } from '../types';
+import { Pipeline } from '../types.js';
 
 const sleep = async (ms: number) => new Promise(resolve => setTimeout(resolve, ms).unref());
 

packages/bautajs-core/src/decorators/step.ts

@@ -1,4 +1,4 @@
-import { Pipeline } from '../types';
+import { Pipeline } from '../types.js';
 
 export function step<TIn, TOut>(fn: Pipeline.StepFunction<TIn, TOut>) {
   return fn;

packages/bautajs-core/src/decorators/tap.ts

@@ -1,6 +1,6 @@
-import { GenericError, Pipeline, Context, BautaJSInstance } from '../types';
-import { isPromise } from '../utils/is-promise';
-import { compose } from './pipeline';
+import { GenericError, Pipeline, Context, BautaJSInstance } from '../types.js';
+import { isPromise } from '../utils/is-promise.js';
+import { compose } from './pipeline.js';
 
 const defaultErrorHandler: Pipeline.CatchError<GenericError> = e => {
   throw e;

packages/bautajs-core/src/decorators/test/as-promise.test.ts

@@ -1,5 +1,5 @@
-import { BautaJSInstance, createContext, pipe } from '../../index';
-import { asPromise } from '../as-promise';
+import { BautaJSInstance, createContext, pipe } from '../../index.js';
+import { asPromise } from '../as-promise.js';
 
 describe('callback decorator', () => {
   test('should execute as a callback', async () => {