feat: switch to esm, pnpm, major deps upgrade

Author: vladholubiev

.circleci/config.yml

@@ -13,11 +13,11 @@ commands:
   install_deps:
     steps:
       - node/install-packages:
-          pkg-manager: yarn
+          pkg-manager: pnpm
           cache-version: v2-all
           cache-only-lockfile: true
           app-dir: ~/repo
-          override-ci-command: yarn install --pure-lockfile --no-progress
+          override-ci-command: pnpm install --no-frozen-lockfile --reporter=silent
 
 jobs:
   build:
@@ -31,6 +31,6 @@ jobs:
     steps:
       - checkout
       - install_deps
-      - run: yarn test
-      - run: yarn type-check
-      - run: yarn lint:ci
+      - run: pnpm test
+      - run: pnpm type-check
+      - run: pnpm lint:ci

.eslintignore

@@ -0,0 +1,9 @@
+import rules from '@shelf/eslint-config/typescript.js';
+
+export default [
+  ...rules,
+  {files: ['**/*.js', '**/*.jsx', '**/*.ts', '**/*.tsx', '**/*.json']},
+  {
+    ignores: ['**/node_modules/', '**/coverage/', '**/lib/', 'renovate.json', 'tsconfig.json'],
+  },
+];

eslint.config.js

@@ -0,0 +1,27 @@
+/* eslint-disable @typescript-eslint/no-require-imports */
+const fs = require('fs');
+const path = require('path');
+const {pathToFileURL} = require('url');
+
+module.exports = async () => {
+  const cwd = process.cwd();
+  const mjsPath = path.resolve(cwd, 'jest-dynamodb-config.mjs');
+
+  if (fs.existsSync(mjsPath)) {
+    const mod = await import(pathToFileURL(mjsPath).href);
+
+    return mod.default || mod;
+  }
+
+  // Fallback to built-in default if .mjs is absent
+  return {
+    tables: [
+      {
+        TableName: `files`,
+        KeySchema: [{AttributeName: 'id', KeyType: 'HASH'}],
+        AttributeDefinitions: [{AttributeName: 'id', AttributeType: 'S'}],
+        ProvisionedThroughput: {ReadCapacityUnits: 1, WriteCapacityUnits: 1},
+      },
+    ],
+  };
+};

jest-dynamodb-config.cjs

@@ -0,0 +1,15 @@
+/**
+ * @type {import('jest').Config}
+ */
+const config = {
+  preset: '@shelf/jest-dynamodb',
+  transform: {
+    '^.+\\.(t|j)sx?$': ['@swc/jest'],
+  },
+  moduleNameMapper: {
+    '^(\\.{1,2}/.*)\\.js$': '$1',
+  },
+  resetMocks: true,
+};
+
+export default config;

jest-dynamodb-config.js

@@ -14,63 +14,66 @@
     "email": "[email protected]",
     "url": "shelf.io"
   },
+  "type": "module",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "import": "./lib/index.js"
+    }
+  },
   "files": [
     "lib"
   ],
   "scripts": {
-    "build": "rm -rf lib/ && yarn build:types && babel src --out-dir lib --ignore '**/*.test.ts' --extensions '.ts'",
+    "build": "rm -rf lib/ && tsc -p tsconfig.json",
     "build:types": "tsc --emitDeclarationOnly --declaration --isolatedModules false --declarationDir lib",
-    "coverage": "jest --coverage",
-    "lint": "eslint . --ext .js,.ts,.json --fix --quiet",
-    "lint:ci": "eslint . --ext .js,.ts,.json --quiet",
-    "prepack": "yarn build",
-    "test": "export ENVIRONMENT=local && jest src --runInBand --forceExit",
+    "coverage": "export JEST_DYNAMODB_CONFIG=$(pwd)/jest-dynamodb-config.cjs && jest --coverage",
+    "lint": "pnpm lint:ci --fix",
+    "lint:ci": "eslint .",
+    "prepack": "pnpm build",
+    "test": "export ENVIRONMENT=local JEST_DYNAMODB_CONFIG=$(pwd)/jest-dynamodb-config.cjs && jest src --runInBand --forceExit",
     "type-check": "tsc --noEmit",
-    "type-check:watch": "npm run type-check -- --watch"
+    "type-check:watch": "pnpm run type-check -- --watch"
   },
   "lint-staged": {
-    "*.{html,json,md,yml}": [
-      "prettier --write --ignore-path=./.eslintignore"
+    "*.{html,md,yml}": [
+      "prettier --write"
     ],
-    "*.{ts,js}": [
+    "*.{js,ts,json}": [
       "eslint --fix"
     ]
   },
-  "babel": {
-    "extends": "@shelf/babel-config/backend"
-  },
   "prettier": "@shelf/prettier-config",
   "dependencies": {
-    "debug": "4.3.4",
+    "debug": "4.4.1",
     "lodash.chunk": "4.2.0",
-    "lodash.clonedeep": "4.5.0",
-    "lodash.times": "4.3.2",
-    "p-map": "4.0.0"
+    
+    
+    "p-map": "7.0.3"
   },
   "devDependencies": {
-    "@aws-sdk/client-dynamodb": "3.538.0",
-    "@aws-sdk/lib-dynamodb": "3.535.0",
-    "@babel/cli": "7.27.2",
-    "@babel/core": "7.27.4",
-    "@shelf/babel-config": "2.0.1",
-    "@shelf/eslint-config": "2.29.3",
-    "@shelf/jest-dynamodb": "3.4.1",
+    "@aws-sdk/client-dynamodb": "3.879.0",
+    "@aws-sdk/lib-dynamodb": "3.879.0",
+    "@swc/core": "1.13.5",
+    "@swc/jest": "0.2.39",
+    "@shelf/eslint-config": "5.2.3",
+    "@shelf/jest-dynamodb": "3.5.0",
     "@shelf/prettier-config": "1.0.0",
-    "@shelf/tsconfig": "0.0.9",
+    "@shelf/tsconfig": "0.1.0",
     "@types/debug": "4.1.12",
-    "@types/jest": "29.5.14",
+    "@types/jest": "30.0.0",
     "@types/lodash.chunk": "4.2.9",
-    "@types/lodash.clonedeep": "4.5.9",
-    "@types/lodash.times": "4.3.9",
-    "@types/node": "22",
-    "eslint": "8.57.1",
-    "husky": "8.0.3",
-    "jest": "29.7.0",
-    "lint-staged": "13.3.0",
-    "prettier": "2.8.8",
-    "typescript": "5.8.3"
+    
+    
+    "@types/node": "24.3.0",
+    "eslint": "9.34.0",
+    "husky": "9.1.7",
+    "jest": "30.1.2",
+    "lint-staged": "16.1.6",
+    "prettier": "3.6.2",
+    "typescript": "5.9.2"
   },
   "peerDependencies": {
     "@aws-sdk/client-dynamodb": "3.x.x",

jest.config.js

@@ -7,15 +7,16 @@
 ## Install
 
 ```
-$ yarn add @shelf/dynamodb-parallel-scan
+$ pnpm add @shelf/dynamodb-parallel-scan
 ```
 
-This library has 2 peer dependencies:
+This library targets ESM and AWS SDK v3. Install alongside peer deps:
 
-- `@aws-sdk/client-dynamodb`
-- `@aws-sdk/lib-dynamodb`
+```
+pnpm add @shelf/dynamodb-parallel-scan @aws-sdk/client-dynamodb @aws-sdk/lib-dynamodb
+```
 
-Make sure to install them alongside this library.
+Requires Node.js 22+.
 
 ## Why this is better than a regular scan
 
@@ -31,50 +32,54 @@ It allows receiving chunks of scanned items, wait until you process them, and th
 
 ### Fetch everything at once
 
-```js
-const {parallelScan} = require('@shelf/dynamodb-parallel-scan');
-
-(async () => {
-  const items = await parallelScan(
-    {
-      TableName: 'files',
-      FilterExpression: 'attribute_exists(#fileSize)',
-      ExpressionAttributeNames: {
-        '#fileSize': 'fileSize',
-      },
-      ProjectionExpression: 'fileSize',
+```ts
+import {parallelScan} from '@shelf/dynamodb-parallel-scan';
+
+const items = await parallelScan(
+  {
+    TableName: 'files',
+    FilterExpression: 'attribute_exists(#fileSize)',
+    ExpressionAttributeNames: {
+      '#fileSize': 'fileSize',
     },
-    {concurrency: 1000}
-  );
+    ProjectionExpression: 'fileSize',
+  },
+  {concurrency: 1000}
+);
 
-  console.log(items);
-})();
+console.log(items);
 ```
 
 ### Use as async generator (or streams)
 
 Note: `highWaterMark` determines items count threshold, so Parallel Scan can fetch `concurrency` \* 1MB more data even after highWaterMark was reached.
 
-```js
-const {parallelScanAsStream} = require('@shelf/dynamodb-parallel-scan');
-
-(async () => {
-  const stream = await parallelScanAsStream(
-    {
-      TableName: 'files',
-      FilterExpression: 'attribute_exists(#fileSize)',
-      ExpressionAttributeNames: {
-        '#fileSize': 'fileSize',
-      },
-      ProjectionExpression: 'fileSize',
+```ts
+import {parallelScanAsStream} from '@shelf/dynamodb-parallel-scan';
+
+const stream = await parallelScanAsStream(
+  {
+    TableName: 'files',
+    FilterExpression: 'attribute_exists(#fileSize)',
+    ExpressionAttributeNames: {
+      '#fileSize': 'fileSize',
     },
-    {concurrency: 1000, chunkSize: 10000, highWaterMark: 10000}
-  );
+    ProjectionExpression: 'fileSize',
+  },
+  {concurrency: 1000, chunkSize: 10000, highWaterMark: 10000}
+);
+
+for await (const items of stream) {
+  console.log(items); // 10k items here
+}
+```
+
+### CommonJS Consumers
 
-  for await (const items of stream) {
-    console.log(items); // 10k items here
-  }
-})();
+This package is ESM-only. In CommonJS, use dynamic import:
+
+```js
+const {parallelScan, parallelScanAsStream} = await import('@shelf/dynamodb-parallel-scan');
 ```
 
 ## Read
@@ -88,8 +93,8 @@ const {parallelScanAsStream} = require('@shelf/dynamodb-parallel-scan');
 
 ```sh
 $ git checkout master
-$ yarn version
-$ yarn publish
+$ pnpm version
+$ pnpm publish
 $ git push origin master --tags
 ```
 

jest.config.mjs

@@ -5,7 +5,7 @@ export class Blocker {
 
   constructor() {
     this._promise = Promise.resolve();
-    this._promiseResolver = () => {}; // eslint-disable-line @typescript-eslint/no-empty-function
+    this._promiseResolver = () => {};
     this._isBlocked = false;
   }