feat(idempotency): add esmodule support (#1743)

* feat(idempotency): add esmodule support

Author: dreamorosi

packages/idempotency/jest.config.js renamed to packages/idempotency/jest.config.cjs

@@ -5,6 +5,9 @@ module.exports = {
   },
   runner: 'groups',
   preset: 'ts-jest',
+  moduleNameMapper: {
+    '^(\\.{1,2}/.*)\\.js$': '$1',
+  },
   transform: {
     '^.+\\.ts?$': 'ts-jest',
   },

packages/idempotency/package.json

@@ -16,57 +16,78 @@
     "test:e2e:nodejs18x": "RUNTIME=nodejs18x jest --group=e2e",
     "test:e2e": "jest --group=e2e",
     "watch": "jest --watch",
-    "build": "tsc --build --force",
+    "build:cjs": "tsc --build --force && echo '{ \"type\": \"commonjs\" }' > lib/cjs/package.json",
+    "build:esm": "tsc --project tsconfig.esm.json && echo '{ \"type\": \"module\" }' > lib/esm/package.json",
+    "build": "npm run build:esm & npm run build:cjs",
     "lint": "eslint --ext .ts,.js --no-error-on-unmatched-pattern .",
     "lint-fix": "eslint --fix --ext .ts,.js --no-error-on-unmatched-pattern .",
     "prebuild": "rimraf ./lib",
-    "prepack": "node ../../.github/scripts/release_patch_package_json.js ."
+    "prepack": "rimraf ./lib/*.tsbuildinfo && node ../../.github/scripts/release_patch_package_json.js ."
   },
   "lint-staged": {
     "*.{js,ts}": "npm run lint-fix"
   },
   "homepage": "https://github.com/aws-powertools/powertools-lambda-typescript/tree/main/packages/idempotency#readme",
   "license": "MIT-0",
+  "type": "module",
   "exports": {
     ".": {
-      "import": "./lib/index.js",
-      "require": "./lib/index.js"
+      "require": {
+        "types": "./lib/cjs/index.d.ts",
+        "default": "./lib/cjs/index.js"
+      },
+      "import": {
+        "types": "./lib/esm/index.d.ts",
+        "default": "./lib/esm/index.js"
+      }
     },
     "./persistence": {
-      "import": "./lib/persistence/index.js",
-      "require": "./lib/persistence/index.js"
+      "import": "./lib/esm/persistence/index.js",
+      "require": "./lib/cjs/persistence/index.js"
     },
     "./dynamodb": {
-      "import": "./lib/persistence/DynamoDBPersistenceLayer.js",
-      "require": "./lib/persistence/DynamoDBPersistenceLayer.js"
+      "import": "./lib/esm/persistence/DynamoDBPersistenceLayer.js",
+      "require": "./lib/cjs/persistence/DynamoDBPersistenceLayer.js"
+    },
+    "./dynamodb/types": {
+      "import": "./lib/esm/types/DynamoDBPersistence.js",
+      "require": "./lib/cjs/types/DynamoDBPersistence.js"
     },
     "./middleware": {
-      "import": "./lib/middleware/index.js",
-      "require": "./lib/middleware/index.js"
+      "import": "./lib/esm/middleware/makeHandlerIdempotent.js",
+      "require": "./lib/cjs/middleware/makeHandlerIdempotent.js"
     },
     "./types": {
-      "import": "./lib/types/index.d.ts",
-      "require": "./lib/types/index.d.ts"
+      "import": "./lib/esm/types/index.d.ts",
+      "require": "./lib/esm/types/index.d.ts"
     }
   },
   "typesVersions": {
     "*": {
       "persistence": [
-        "lib/persistence/index.d.ts"
+        "lib/esm/persistence/index.d.ts",
+        "lib/cjs/persistence/index.d.ts"
       ],
       "dynamodb": [
-        "lib/persistence/DynamoDBPersistenceLayer.d.ts"
+        "lib/esm/persistence/DynamoDBPersistenceLayer.d.ts",
+        "lib/cjs/persistence/DynamoDBPersistenceLayer.d.ts"
+      ],
+      "dynamodb/types": [
+        "lib/esm/types/DynamoDBPersistence.d.ts",
+        "lib/cjs/types/DynamoDBPersistence.d.ts"
       ],
       "middleware": [
-        "lib/middleware/index.d.ts"
+        "lib/esm/middleware/makeHandlerIdempotent.d.ts",
+        "lib/cjs/middleware/makeHandlerIdempotent.d.ts"
       ],
       "types": [
-        "lib/types/index.d.ts"
+        "lib/esm/types/index.d.ts",
+        "lib/cjs/types/index.d.ts"
       ]
     }
   },
-  "main": "./lib/index.js",
-  "types": "./lib/index.d.ts",
+  "types": "./lib/cjs/index.d.ts",
+  "main": "./lib/cjs/index.js",
   "files": [
     "lib"
   ],

packages/idempotency/src/IdempotencyConfig.ts

@@ -1,6 +1,6 @@
-import { EnvironmentVariablesService } from './config';
+import { EnvironmentVariablesService } from './config/EnvironmentVariablesService.js';
 import type { Context } from 'aws-lambda';
-import type { IdempotencyConfigOptions } from './types';
+import type { IdempotencyConfigOptions } from './types/IdempotencyOptions.js';
 
 /**
  * Configuration for the idempotency feature.

packages/idempotency/src/IdempotencyHandler.ts

@@ -2,16 +2,20 @@ import type {
   JSONValue,
   MiddyLikeRequest,
 } from '@aws-lambda-powertools/commons/types';
-import type { AnyFunction, IdempotencyHandlerOptions } from './types';
+import type {
+  AnyFunction,
+  IdempotencyHandlerOptions,
+} from './types/IdempotencyOptions.js';
 import {
   IdempotencyAlreadyInProgressError,
   IdempotencyInconsistentStateError,
   IdempotencyItemAlreadyExistsError,
   IdempotencyPersistenceLayerError,
-} from './errors';
-import { BasePersistenceLayer, IdempotencyRecord } from './persistence';
-import { IdempotencyConfig } from './IdempotencyConfig';
-import { MAX_RETRIES, IdempotencyRecordStatus } from './constants';
+} from './errors.js';
+import { BasePersistenceLayer } from './persistence/BasePersistenceLayer.js';
+import { IdempotencyRecord } from './persistence/IdempotencyRecord.js';
+import { IdempotencyConfig } from './IdempotencyConfig.js';
+import { MAX_RETRIES, IdempotencyRecordStatus } from './constants.js';
 import { search } from 'jmespath';
 
 /**

packages/idempotency/src/config/EnvironmentVariablesService.ts

@@ -1,4 +1,4 @@
-import { ConfigServiceInterface } from './ConfigServiceInterface';
+import type { ConfigServiceInterface } from '../types/ConfigServiceInterface.js';
 import { EnvironmentVariablesService as CommonEnvironmentVariablesService } from '@aws-lambda-powertools/commons';
 
 /**

packages/idempotency/src/config/index.ts

@@ -1,5 +1,8 @@
-import { AnyFunction, ItempotentFunctionOptions } from './types';
-import { makeIdempotent } from './makeIdempotent';
+import {
+  AnyFunction,
+  ItempotentFunctionOptions,
+} from './types/IdempotencyOptions.js';
+import { makeIdempotent } from './makeIdempotent.js';
 
 /**
  * Use this decorator to make your lambda handler itempotent.

packages/idempotency/src/idempotencyDecorator.ts

@@ -1,5 +1,14 @@
-export * from './errors';
-export * from './IdempotencyConfig';
-export * from './makeIdempotent';
-export * from './idempotencyDecorator';
-export { IdempotencyRecordStatus } from './constants';
+export {
+  IdempotencyItemAlreadyExistsError,
+  IdempotencyItemNotFoundError,
+  IdempotencyAlreadyInProgressError,
+  IdempotencyInvalidStatusError,
+  IdempotencyValidationError,
+  IdempotencyInconsistentStateError,
+  IdempotencyPersistenceLayerError,
+  IdempotencyKeyError,
+} from './errors.js';
+export { IdempotencyConfig } from './IdempotencyConfig.js';
+export { makeIdempotent } from './makeIdempotent.js';
+export { idempotent } from './idempotencyDecorator.js';
+export { IdempotencyRecordStatus } from './constants.js';

packages/idempotency/src/index.ts

@@ -3,9 +3,9 @@ import type {
   AnyFunction,
   ItempotentFunctionOptions,
   IdempotencyLambdaHandlerOptions,
-} from './types';
-import { IdempotencyHandler } from './IdempotencyHandler';
-import { IdempotencyConfig } from './IdempotencyConfig';
+} from './types/IdempotencyOptions.js';
+import { IdempotencyHandler } from './IdempotencyHandler.js';
+import { IdempotencyConfig } from './IdempotencyConfig.js';
 
 const isContext = (arg: unknown): arg is Context => {
   return (