fix!: Convert project to output ESM

Signed-off-by: Gregers Gram Rygg <gregers.gram.rygg@nordicsemi.no>

Author: gregersrygg

package.json

@@ -13,7 +13,7 @@
     "url": "git+https://github.com/microcks/microcks-testcontainers-node.git"
   },
   "license": "Apache-2.0",
-  "main": "build/index.js",
+  "exports": "./build/index.js",
   "publishConfig": {
     "access": "public"
   },
@@ -46,6 +46,6 @@
     "build"
   ],
   "engines": {
-    "node": ">= 16"
+    "node": ">= 20"
   }
 }

src/index.ts

@@ -13,6 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export * from "./microcks-container";
-export * from "./microcks-containers-ensemble";
-export * from "./microcks-async-minion-container";
+export * from "./microcks-container.js";
+export * from "./microcks-containers-ensemble.js";
+export * from "./microcks-async-minion-container.js";

src/microcks-async-minion-container.ts

@@ -15,14 +15,14 @@
  */
 
 import { AbstractStartedContainer, GenericContainer, StartedNetwork, StartedTestContainer, Wait, getContainerRuntimeClient } from "testcontainers";
-import { MicrocksContainer } from "./microcks-container";
+import { MicrocksContainer } from "./microcks-container.js";
 
 export class MicrocksAsyncMinionContainer extends GenericContainer {
   static readonly MICROCKS_ASYNC_MINION_HTTP_PORT = 8081;
-  
+
   private network: StartedNetwork;
   private extraProtocols: string = "";
-  
+
   constructor(network: StartedNetwork, image = "quay.io/microcks/microcks-uber-async-minion:1.9.0") {
     super(image);
     this.network = network;

src/microcks-container.test.ts

@@ -38,7 +38,7 @@ describe("MicrocksContainer", () => {
       .withMainRemoteArtifacts(["https://raw.githubusercontent.com/microcks/microcks/master/samples/APIPastry-openapi.yaml"])
       .withSecondaryArtifacts([path.resolve(resourcesDir, "apipastries-postman-collection.json")])
       .start();
-    
+
     // Test mock endpoints relative methods.
     let baseWsUrl = container.getSoapMockEndpoint("Pastries Service", "1.0");
     expect(container.getHttpEndpoint() + "/soap/Pastries Service/1.0").toBe(baseWsUrl);
@@ -127,7 +127,7 @@ describe("MicrocksContainer", () => {
   });
   // }
 
-  async function testInvocationsCheckingFunctionality(container: StartedMicrocksContainer, 
+  async function testInvocationsCheckingFunctionality(container: StartedMicrocksContainer,
       serviceName: string, serviceVersion: string, expectedCount: number) {
     expect(await container.verify(serviceName, serviceVersion)).toBe(true);
     expect(await container.getServiceInvocationsCount(serviceName, serviceVersion)).toBe(expectedCount)
@@ -151,7 +151,7 @@ describe("MicrocksContainer", () => {
         .start();
 
     await container.importAsMainArtifact(path.resolve(resourcesDir, "apipastries-openapi.yaml"));
-    
+
     var testRequest: TestRequest = {
       serviceId: "API Pastries:0.0.1",
       runnerType: TestRunnerType.OPEN_API_SCHEMA,
@@ -250,4 +250,4 @@ describe("MicrocksContainer", () => {
     await network.stop();
   });
   // }
-});  
+});

src/microcks-container.ts

@@ -20,7 +20,7 @@ import { AbstractStartedContainer, GenericContainer, StartedTestContainer, Wait
 export class MicrocksContainer extends GenericContainer {
   static readonly MICROCKS_HTTP_PORT = 8080;
   static readonly MICROCKS_GRPC_PORT = 9090;
-  
+
   private snapshots: string[] = [];
   private mainArtifacts: string[] = [];
   private secondaryArtifacts: string[] = [];
@@ -120,7 +120,7 @@ export class MicrocksContainer extends GenericContainer {
     for (let i=0; i<this.secondaryRemoteArtifacts.length; i++) {
       await startedContainer.downloadAsSecondaryArtifact(this.secondaryRemoteArtifacts[i]);
     }
-    // Import artifacts declared in configuration. 
+    // Import artifacts declared in configuration.
     for (let i=0; i<this.mainArtifacts.length; i++) {
       await startedContainer.importAsMainArtifact(this.mainArtifacts[i]);
     }
@@ -386,7 +386,7 @@ export class StartedMicrocksContainer extends AbstractStartedContainer {
   public getValidatingRestMockEndpointPath(service: string, version: string): string {
     return `/rest-valid/${service}/${version}`;
   }
-  
+
   /**
    * Get the exposed mock endpoint for a GraphQL API.
    * @param {String} service The name of Service/API
@@ -426,7 +426,7 @@ export class StartedMicrocksContainer extends AbstractStartedContainer {
   }
 
   /**
-   * Import an artifact as a secondary one within the Microcks container. 
+   * Import an artifact as a secondary one within the Microcks container.
    * @param {String} artifactPath The file path to artifact (OpenAPI, Postman collection, Protobuf, GraphQL schema, ...)
    * @returns Success or error via Promise
    */
@@ -597,7 +597,7 @@ export class StartedMicrocksContainer extends AbstractStartedContainer {
     return invocationStats.dailyCount;
   }
 
-  
+
   private async importArtifact(artifactPath: string, mainArtifact: boolean): Promise<void> {
     const isFile = await this.isFile(artifactPath);
     if (!isFile) {
@@ -703,7 +703,7 @@ export class StartedMicrocksContainer extends AbstractStartedContainer {
 
     // Tto avoid race condition issue while Microcks server is processing metrics asynchronously.
     await this.wait(100);
-    
+
     // Request the daily statistics.
     const response = await fetch(endpointUrl, {
       method: 'GET',
@@ -719,7 +719,7 @@ export class StartedMicrocksContainer extends AbstractStartedContainer {
     throw new Error("Couldn't get service's invocations on Microcks. Please check Microcks container logs");
   }
 
-  private async isFile(path: string): Promise<boolean> {  
+  private async isFile(path: string): Promise<boolean> {
     const stats = await stat(path);
     return stats.isFile()
   }

src/microcks-containers-ensemble.test.ts

@@ -22,10 +22,10 @@ import { CreateQueueCommand, ListQueuesCommand, ReceiveMessageCommand, SQSClient
 import { GenericContainer, Network, Wait } from "testcontainers";
 import { LocalstackContainer } from "@testcontainers/localstack";
 import { RabbitMQContainer } from "@testcontainers/rabbitmq";
-import { MicrocksContainersEnsemble } from "./microcks-containers-ensemble";
-import { TestRequest, TestResult, TestRunnerType } from "./microcks-container";
+import { MicrocksContainersEnsemble } from "./microcks-containers-ensemble.js";
+import { TestRequest, TestResult, TestRunnerType } from "./microcks-container.js";
 import { WebSocket } from "ws";
-import mqtt from "mqtt"; 
+import mqtt from "mqtt";
 import amqp from "amqplib";
 
 describe("MicrocksContainersEnsemble", () => {
@@ -143,7 +143,7 @@ describe("MicrocksContainersEnsemble", () => {
     let wsEndpoint = ensemble.getAsyncMinionContainer()?.getWSMockEndpoint("Pastry orders API", "0.1.0", "SUBSCRIBE pastry/orders");
     let expectedMessage = "{\"id\":\"4dab240d-7847-4e25-8ef3-1530687650c8\",\"customerId\":\"fe1088b3-9f30-4dc1-a93d-7b74f0a072b9\",\"status\":\"VALIDATED\",\"productQuantities\":[{\"quantity\":2,\"pastryName\":\"Croissant\"},{\"quantity\":1,\"pastryName\":\"Millefeuille\"}]}";
 
-    const ws = new WebSocket(wsEndpoint as string);    
+    const ws = new WebSocket(wsEndpoint as string);
     ws.on('error', console.error);
     ws.on('message', function message(data) {
       messages.push(data.toString());
@@ -199,7 +199,7 @@ describe("MicrocksContainersEnsemble", () => {
     expect(testResult.testCaseResults[0].testStepResults[0].message).toContain("object has missing required properties");
 
     // Retrieve event messages for the failing test case.
-    const events = await ensemble.getMicrocksContainer().getEventMessagesForTestCase(testResult, 
+    const events = await ensemble.getMicrocksContainer().getEventMessagesForTestCase(testResult,
       "SUBSCRIBE pastry/orders");
 
     // We should have at least 1 event.
@@ -326,7 +326,7 @@ describe("MicrocksContainersEnsemble", () => {
     //await channel.checkExchange(amqpDestination as string);
     await channel.assertQueue('microcks-test', { durable: false });
     await channel.bindQueue('microcks-test', amqpDestination as string, '');
-    
+
     channel.consume('microcks-test', (msg: any) => {
       if (msg !== null) {
         messages.push(msg.content.toString());
@@ -391,7 +391,7 @@ describe("MicrocksContainersEnsemble", () => {
         endpointOverride: 'http://localstack:4566'
       })
       .start();
-          
+
     // Initialize messages list and connect to mock endpoint.
     let messages: string[] = [];
     let sqsEndpoint = ensemble.getAsyncMinionContainer()?.getAmazonSQSMockQueue("Pastry orders API", "0.1.0", "SUBSCRIBE pastry/orders");

src/microcks-containers-ensemble.ts

@@ -14,11 +14,11 @@
  * limitations under the License.
  */
 import { GenericContainer, StartedNetwork, StartedTestContainer, StopOptions, Wait } from "testcontainers";
-import { MicrocksContainer, Secret, StartedMicrocksContainer } from "./microcks-container";
-import { 
-  AmazonServiceConnection, GenericConnection, KafkaConnection, 
-  MicrocksAsyncMinionContainer, StartedMicrocksAsyncMinionContainer 
-} from "./microcks-async-minion-container";
+import { MicrocksContainer, Secret, StartedMicrocksContainer } from "./microcks-container.js";
+import {
+  AmazonServiceConnection, GenericConnection, KafkaConnection,
+  MicrocksAsyncMinionContainer, StartedMicrocksAsyncMinionContainer
+} from "./microcks-async-minion-container.js";
 
 export class MicrocksContainersEnsemble {
   static readonly MICROCKS_CONTAINER_ALIAS = "microcks";
@@ -38,9 +38,9 @@ export class MicrocksContainersEnsemble {
       .withNetworkAliases(MicrocksContainersEnsemble.MICROCKS_CONTAINER_ALIAS)
       .withEnvironment({
         POSTMAN_RUNNER_URL: "http://" + MicrocksContainersEnsemble.POSTMAN_CONTAINER_ALIAS + ":3000",
-        TEST_CALLBACK_URL: "http://" + MicrocksContainersEnsemble.MICROCKS_CONTAINER_ALIAS 
+        TEST_CALLBACK_URL: "http://" + MicrocksContainersEnsemble.MICROCKS_CONTAINER_ALIAS
             + ":" + MicrocksContainer.MICROCKS_HTTP_PORT,
-        ASYNC_MINION_URL: "http://" + MicrocksContainersEnsemble.MICROCKS_ASYNC_MINION_CONTAINER_ALIAS 
+        ASYNC_MINION_URL: "http://" + MicrocksContainersEnsemble.MICROCKS_ASYNC_MINION_CONTAINER_ALIAS
             + ":" + MicrocksAsyncMinionContainer.MICROCKS_ASYNC_MINION_HTTP_PORT,
       });
   }

tsconfig.json

@@ -2,11 +2,11 @@
   "compilerOptions": {
     "incremental": true,
     "target": "es2022",
-    "module": "commonjs",
+    "module": "nodenext",
     "declaration": true,
     "sourceMap": true,
     "strict": true,
-    "moduleResolution": "node",
+    "moduleResolution": "nodenext",
     "esModuleInterop": true,
     "skipLibCheck": true,
     "forceConsistentCasingInFileNames": true,