Update AWS SDK to v3

.eslintignore

@@ -1 +1,3 @@
-dist
+dist
+coverage
+node_modules

.eslintrc

@@ -1,6 +1,6 @@
 {
   "root": true,
-  "extends": ["@jupiterone/eslint-config/node"],
+  "extends": ["@jupiterone/eslint-config/node18"],
   "ignorePatterns": [
     "node_modules/",
     "dist/",

.github/workflows/build.yml

@@ -13,12 +13,12 @@ jobs:
     steps:
       - id: setup-node
         name: Setup Node
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
 
       - name: Check out code repository source code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Install dependencies
         run: yarn
@@ -72,4 +72,4 @@ jobs:
           echo "//registry.npmjs.org/:_authToken=${NPM_AUTH_TOKEN}" > .npmrc
           yarn
           yarn build
-          npm publish ./dist
+          npm publish ./dist

.github/workflows/codeql-analysis.yml

@@ -9,15 +9,15 @@
 # the `language` matrix defined below to confirm you have the correct set of
 # supported CodeQL languages.
 #
-name: "CodeQL"
+name: 'CodeQL'
 
 on:
   push:
-    branches: [ "main" ]
+    branches: ['main']
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ "main" ]
-    
+    branches: ['main']
+
 jobs:
   analyze:
     name: Analyze
@@ -30,41 +30,40 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        language: [ 'javascript' ]
+        language: ['javascript']
         # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
         # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
 
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-
-        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
-        queries: security-extended,security-and-quality
+          # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+          queries: security-extended,security-and-quality
 
-
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v2
 
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
 
-    #   If the Autobuild fails above, remove it and uncomment the following three lines. 
-    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+      #   If the Autobuild fails above, remove it and uncomment the following three lines.
+      #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
 
-    # - run: |
-    #   echo "Run, Build Application using script"
-    #   ./location_of_script_within_repo/buildscript.sh
+      # - run: |
+      #   echo "Run, Build Application using script"
+      #   ./location_of_script_within_repo/buildscript.sh
 
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2

.github/workflows/peril.yml

@@ -1,9 +1,9 @@
-name: "Peril"
+name: 'Peril'
 
 on:
   pull_request:
 
-env: 
+env:
   TRANSPONDER_DOCKER_IMAGE: 081157560428.dkr.ecr.us-east-1.amazonaws.com/transponder:1
   SECURITY_SCAN_IMAGE: ghcr.io/jupiterone/security-scan:latest
 
@@ -17,74 +17,74 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - name: Checkout
-      uses: actions/checkout@v3
-
-    - name: Setup Node
-      uses: actions/setup-node@v1
-      with:
-        node-version: 14.x
-
-    - name: Run build
-      run: yarn install
-
-    - name: Get Variables
-      id: get-vars
-      run: |
-        if [[ "${GITHUB_REF}" == 'ref/head/main' && "${GITHUB_EVENT_NAME}" == 'push' ]];
-        then
-          echo ::set-output name=aws-oidc-role::arn:aws:iam::081157560428:role/github-main-role
-        else
-          echo ::set-output name=aws-oidc-role::arn:aws:iam::081157560428:role/github-pull-request-role
-        fi
-
-    - name: Configure aws credentials
-      uses: aws-actions/configure-aws-credentials@v1
-      with:
-        role-to-assume: ${{ steps.get-vars.outputs.aws-oidc-role }}
-        role-session-name: pr-role-session
-        aws-region: us-east-1
+      - name: Checkout
+        uses: actions/checkout@v3
 
-    - name: ECR login
-      uses: aws-actions/amazon-ecr-login@v1
-      id: amazon-ecr-login
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18.x
 
-    - name: Login to GHCR
-      uses: docker/login-action@v2
-      with:
-        registry: ghcr.io
-        username: ${{ github.actor }}
-        password: ${{ secrets.PACKAGE_TOKEN }}
+      - name: Run build
+        run: yarn install
 
-    - name: Pull security-scan
-      run: |
-        docker pull $SECURITY_SCAN_IMAGE
-
-    - name: Run security-scan
-      run: |
-        docker run \
-        --user root \
-        -v /var/run/docker.sock:/var/run/docker.sock \
-        -v `pwd`:`pwd` \
-        -e AWS_ACCESS_KEY_ID=${{ env.AWS_ACCESS_KEY_ID }} \
-        -e AWS_SECRET_ACCESS_KEY=${{ env.AWS_SECRET_ACCESS_KEY }} \
-        -e AWS_SESSION_TOKEN=${{ env.AWS_SESSION_TOKEN }} \
-        -e GITHUB_REPOSITORY=$GITHUB_REPOSITORY \
-        -e GITHUB_REF_NAME=$GITHUB_REF_NAME \
-        -e GITHUB_RUN_NUMBER=$GITHUB_RUN_NUMBER \
-        -e GITHUB_SERVER_URL=$GITHUB_SERVER_URL \
-        -e GITHUB_RUN_ID=$GITHUB_RUN_ID \
-        -e MODE=ci \
-        -w `pwd` $SECURITY_SCAN_IMAGE
+      - name: Get Variables
+        id: get-vars
+        run: |
+          if [[ "${GITHUB_REF}" == 'ref/head/main' && "${GITHUB_EVENT_NAME}" == 'push' ]];
+          then
+            echo ::set-output name=aws-oidc-role::arn:aws:iam::081157560428:role/github-main-role
+          else
+            echo ::set-output name=aws-oidc-role::arn:aws:iam::081157560428:role/github-pull-request-role
+          fi
 
-    - name: Pull transponder
-      run: |
-        docker pull $TRANSPONDER_DOCKER_IMAGE
+      - name: Configure aws credentials
+        uses: aws-actions/configure-aws-credentials@v1
+        with:
+          role-to-assume: ${{ steps.get-vars.outputs.aws-oidc-role }}
+          role-session-name: pr-role-session
+          aws-region: us-east-1
 
-    - name: Run transponder
-      run: |
-        docker run --rm -v `pwd`:`pwd` -w `pwd` \
-        -e J1_API_KEY=${{ secrets.J1_API_KEY_TRANSPONDER }} \
-        -e J1_API_DOMAIN=${{ secrets.J1_API_DOMAIN_TRANSPONDER }} \
-        -e J1_ACCOUNT_ID=${{ secrets.J1_ACCOUNT_ID_TRANSPONDER }} \
-        $TRANSPONDER_DOCKER_IMAGE
+      - name: ECR login
+        uses: aws-actions/amazon-ecr-login@v1
+        id: amazon-ecr-login
+
+      - name: Login to GHCR
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.PACKAGE_TOKEN }}
+
+      - name: Pull security-scan
+        run: |
+          docker pull $SECURITY_SCAN_IMAGE
+
+      - name: Run security-scan
+        run: |
+          docker run \
+          --user root \
+          -v /var/run/docker.sock:/var/run/docker.sock \
+          -v `pwd`:`pwd` \
+          -e AWS_ACCESS_KEY_ID=${{ env.AWS_ACCESS_KEY_ID }} \
+          -e AWS_SECRET_ACCESS_KEY=${{ env.AWS_SECRET_ACCESS_KEY }} \
+          -e AWS_SESSION_TOKEN=${{ env.AWS_SESSION_TOKEN }} \
+          -e GITHUB_REPOSITORY=$GITHUB_REPOSITORY \
+          -e GITHUB_REF_NAME=$GITHUB_REF_NAME \
+          -e GITHUB_RUN_NUMBER=$GITHUB_RUN_NUMBER \
+          -e GITHUB_SERVER_URL=$GITHUB_SERVER_URL \
+          -e GITHUB_RUN_ID=$GITHUB_RUN_ID \
+          -e MODE=ci \
+          -w `pwd` $SECURITY_SCAN_IMAGE
+
+      - name: Pull transponder
+        run: |
+          docker pull $TRANSPONDER_DOCKER_IMAGE
+
+      - name: Run transponder
+        run: |
+          docker run --rm -v `pwd`:`pwd` -w `pwd` \
+          -e J1_API_KEY=${{ secrets.J1_API_KEY_TRANSPONDER }} \
+          -e J1_API_DOMAIN=${{ secrets.J1_API_DOMAIN_TRANSPONDER }} \
+          -e J1_ACCOUNT_ID=${{ secrets.J1_ACCOUNT_ID_TRANSPONDER }} \
+          $TRANSPONDER_DOCKER_IMAGE

.node-version

@@ -0,0 +1 @@
+18

.prettierignore

@@ -1 +1,2 @@
 dist
+coverage

CHANGELOG.md

@@ -8,6 +8,14 @@ and this project adheres to
 
 ## [Unreleased]
 
+## 2.0.0 - 2023-09-23
+
+### Changed
+
+- **_Breaking_** now uses the `v3` of the `aws-sdk`. Peer dependency on
+  `aws-sdk` dropped. Now requires `@aws-sdk/client-dynamodb` and
+  `@aws-sdk/lib-dynamodb`.
+
 ## 1.7.2- 2021-01-31
 
 ### Added

README.md

@@ -13,15 +13,17 @@ methods arguments and return values are strictly typed.
 **Constructor:**
 
 ```javascript
-import AWS from 'aws-sdk';
-import DynamoDbDao from '@jupiterone/dynamodb-dao';
+import { DynamoDBClient } from '@aws-sdk/client-dynamodb';
+import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb';
 
-const dynamodb = new AWS.DynamoDB({
+const ddb = new DynamoDBClient({
   apiVersion: '2012-08-10'
-});
+})
 
-const documentClient = new AWS.DynamoDB.DocumentClient({
-  service: dynamodb
+const documentClient = DynamoDBDocumentClient.from(ddb, {
+  marshallOptions: {
+    removeUndefinedValues: true
+  }
 });
 
 // The type declaration of for the documents that we are storing
@@ -120,7 +122,7 @@ const { total } = await myDocumentDao.incr(
   // The `number` property to increment
   'total',
   // The number to increment by. Defaults to 1.
-  5,
+  5
 );
 
 // `total` will have the value `-5`
@@ -133,7 +135,7 @@ const { total } = await myDocumentDao.decr(
   // The `number` property to increment
   'total',
   // The number to decrement by. Defaults to 1.
-  5,
+  5
 );
 ```
 
@@ -147,9 +149,9 @@ const { extra, total } = await myDocumentDao.multiIncr(
     accountId: 'def',
   },
   {
-    'total': 5,
-    'extra': -1,
-  },
+    total: 5,
+    extra: -1,
+  }
 );
 ```
 

package.json

@@ -10,6 +10,9 @@
   "publishConfig": {
     "access": "public"
   },
+  "engines": {
+    "node": ">= 18.0.0"
+  },
   "scripts": {
     "start:containers": "docker-compose up dynamodb",
     "stop:containers": "docker-compose down",
@@ -24,23 +27,25 @@
     "autobuild": "yarn build && (cd ./dist && yarn install --production && (yarn unlink || true) && yarn link) && yarn nodemon --exec 'yarn compile' --watch src -e ts --delay 3"
   },
   "dependencies": {
-    "@lifeomic/attempt": "^3.0.0",
+    "@lifeomic/attempt": "^3.0.3",
     "lodash.chunk": "^4.2.0",
     "p-map": "4.0.0"
   },
   "peerDependencies": {
-    "aws-sdk": "^2"
+    "@aws-sdk/client-dynamodb": "^3",
+    "@aws-sdk/lib-dynamodb": "^3"
   },
   "devDependencies": {
-    "@jupiterone/eslint-config": "^1.0.2",
-    "@jupiterone/typescript-tools": "^13.2.2",
+    "@aws-sdk/client-dynamodb": "^3.418.0",
+    "@aws-sdk/lib-dynamodb": "^3.418.0",
+    "@jupiterone/eslint-config": "^2.1.0",
+    "@jupiterone/typescript-tools": "^18",
+    "@types/jest": "^29",
     "@types/lodash.chunk": "^4.2.6",
     "@types/lodash.partition": "^4.6.6",
-    "@types/node": "^13.11.1",
-    "@types/uuid": "^8.0.0",
-    "aws-sdk": "^2.419.0",
+    "@types/node": "^18",
+    "aws-sdk-client-mock": "^3.0.0",
     "lodash.partition": "^4.6.0",
-    "nodemon": "^2.0.7",
-    "uuid": "^8.1.0"
+    "nodemon": "^2.0.7"
   }
 }