@middy/dynamodb 4.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017-2023 [Luciano Mammino](https://github.com/lmammino), [will Farrell](https://github.com/willfarrell) and the [Middy team](https://github.com/middyjs/middy/graphs/contributors)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,45 @@
+<div align="center">
+  <h1>Middy dynamodb middleware</h1>
+  <img alt="Middy logo" src="https://raw.githubusercontent.com/middyjs/middy/main/docs/img/middy-logo.svg"/>
+  <p><strong>Secrets Manager middleware for the middy framework, the stylish Node.js middleware engine for AWS Lambda</strong></p>
+<p>
+  <a href="https://www.npmjs.com/package/@middy/dynamodb?activeTab=versions">
+    <img src="https://badge.fury.io/js/%40middy%2Fdynamodb.svg" alt="npm version" style="max-width:100%;">
+  </a>
+  <a href="https://packagephobia.com/result?p=@middy/dynamodb">
+    <img src="https://packagephobia.com/badge?p=@middy/dynamodb" alt="npm install size" style="max-width:100%;">
+  </a>
+  <a href="https://github.com/middyjs/middy/actions/workflows/tests.yml">
+    <img src="https://github.com/middyjs/middy/actions/workflows/tests.yml/badge.svg?branch=main&event=push" alt="GitHub Actions CI status badge" style="max-width:100%;">
+  </a>
+  <br/>
+   <a href="https://standardjs.com/">
+    <img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="Standard Code Style"  style="max-width:100%;">
+  </a>
+  <a href="https://snyk.io/test/github/middyjs/middy">
+    <img src="https://snyk.io/test/github/middyjs/middy/badge.svg" alt="Known Vulnerabilities" data-canonical-src="https://snyk.io/test/github/middyjs/middy" style="max-width:100%;">
+  </a>
+  <a href="https://lgtm.com/projects/g/middyjs/middy/context:javascript">
+    <img src="https://img.shields.io/lgtm/grade/javascript/g/middyjs/middy.svg?logo=lgtm&logoWidth=18" alt="Language grade: JavaScript" style="max-width:100%;">
+  </a>
+  <a href="https://bestpractices.coreinfrastructure.org/projects/5280">
+    <img src="https://bestpractices.coreinfrastructure.org/projects/5280/badge" alt="Core Infrastructure Initiative (CII) Best Practices"  style="max-width:100%;">
+  </a>
+  <br/>
+  <a href="https://gitter.im/middyjs/Lobby">
+    <img src="https://badges.gitter.im/gitterHQ/gitter.svg" alt="Chat on Gitter" style="max-width:100%;">
+  </a>
+  <a href="https://stackoverflow.com/questions/tagged/middy?sort=Newest&uqlId=35052">
+    <img src="https://img.shields.io/badge/StackOverflow-[middy]-yellow" alt="Ask questions on StackOverflow" style="max-width:100%;">
+  </a>
+</p>
+<p>You can read the documentation at: <a href="https://middy.js.org/docs/middlewares/dynamodb">https://middy.js.org/docs/middlewares/dynamodb</a></p>
+</div>
+
+## License
+
+Licensed under [MIT License](LICENSE). Copyright (c) 2017-2023 [Luciano Mammino](https://github.com/lmammino), [will Farrell](https://github.com/willfarrell), and the [Middy team](https://github.com/middyjs/middy/graphs/contributors).
+
+<a href="https://app.fossa.io/projects/git%2Bgithub.com%2Fmiddyjs%2Fmiddy?ref=badge_large">
+  <img src="https://app.fossa.io/api/projects/git%2Bgithub.com%2Fmiddyjs%2Fmiddy.svg?type=large" alt="FOSSA Status"  style="max-width:100%;">
+</a>

package/index.cjs

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(module, "exports", {
+    enumerable: true,
+    get: ()=>_default
+});
+const _util = require("@middy/util");
+const _clientDynamodb = require("@aws-sdk/client-dynamodb");
+const _utilDynamodb = require("@aws-sdk/util-dynamodb");
+const defaults = {
+    AwsClient: _clientDynamodb.DynamoDBClient,
+    awsClientOptions: {},
+    awsClientAssumeRole: undefined,
+    awsClientCapture: undefined,
+    fetchData: {},
+    disablePrefetch: false,
+    cacheKey: 'dynamodb',
+    cacheExpiry: -1,
+    setToContext: false
+};
+const dynamodbMiddleware = (opts = {})=>{
+    const options = {
+        ...defaults,
+        ...opts
+    };
+    for(const internalKey in options.fetchData){
+        options.fetchData[internalKey].Key = (0, _utilDynamodb.marshall)(options.fetchData[internalKey].Key);
+    }
+    const fetch = (request, cachedValues = {})=>{
+        const values = {};
+        for(const internalKey in options.fetchData){
+            if (cachedValues[internalKey]) continue;
+            const inputParameters = options.fetchData[internalKey];
+            values[internalKey] = client.send(new _clientDynamodb.GetItemCommand(inputParameters)).then((resp)=>(0, _utilDynamodb.unmarshall)(resp.Item)).catch((e)=>{
+                const value = (0, _util.getCache)(options.cacheKey).value ?? {};
+                value[internalKey] = undefined;
+                (0, _util.modifyCache)(options.cacheKey, value);
+                throw e;
+            });
+        }
+        return values;
+    };
+    let prefetch, client;
+    if ((0, _util.canPrefetch)(options)) {
+        client = (0, _util.createPrefetchClient)(options);
+        prefetch = (0, _util.processCache)(options, fetch);
+    }
+    const dynamodbMiddlewareBefore = async (request)=>{
+        if (!client) {
+            client = await (0, _util.createClient)(options, request);
+        }
+        const { value  } = prefetch ?? (0, _util.processCache)(options, fetch, request);
+        Object.assign(request.internal, value);
+        if (options.setToContext) {
+            const data = await (0, _util.getInternal)(Object.keys(options.fetchData), request);
+            Object.assign(request.context, data);
+        }
+        prefetch = null;
+    };
+    return {
+        before: dynamodbMiddlewareBefore
+    };
+};
+const _default = dynamodbMiddleware;
+
+
+//# sourceMappingURL=index.cjs.map

package/index.d.ts

@@ -0,0 +1,26 @@
+import middy from '@middy/core'
+import { Options as MiddyOptions } from '@middy/util'
+import { Context as LambdaContext } from 'aws-lambda'
+import { DynamoDBClient, DynamoDBClientConfig } from '@aws-sdk/client-dynamodb'
+
+export type Options<AwsDynamoDBClient = DynamoDBClient> =
+  Omit<MiddyOptions<AwsDynamoDBClient, DynamoDBClientConfig>, 'fetchData'>
+  &
+  {
+    fetchData?: {
+      // TODO: add more precise type
+      [key: string]: Record<string, any>
+    }
+  }
+
+export type Context<TOptions extends Options | undefined> = TOptions extends {
+  setToContext: true
+}
+  ? LambdaContext & Record<keyof TOptions['fetchData'], any>
+  : LambdaContext
+
+declare function dynamodbMiddleware<TOptions extends Options | undefined> (
+  options?: TOptions
+): middy.MiddlewareObj<unknown, any, Error, Context<TOptions>>
+
+export default dynamodbMiddleware

package/index.js

@@ -0,0 +1,61 @@
+import { canPrefetch, createPrefetchClient, createClient, getCache, getInternal, processCache, modifyCache } from '@middy/util';
+import { DynamoDBClient, GetItemCommand } from '@aws-sdk/client-dynamodb';
+import { marshall, unmarshall } from '@aws-sdk/util-dynamodb';
+const defaults = {
+    AwsClient: DynamoDBClient,
+    awsClientOptions: {},
+    awsClientAssumeRole: undefined,
+    awsClientCapture: undefined,
+    fetchData: {},
+    disablePrefetch: false,
+    cacheKey: 'dynamodb',
+    cacheExpiry: -1,
+    setToContext: false
+};
+const dynamodbMiddleware = (opts = {})=>{
+    const options = {
+        ...defaults,
+        ...opts
+    };
+    for(const internalKey in options.fetchData){
+        options.fetchData[internalKey].Key = marshall(options.fetchData[internalKey].Key);
+    }
+    const fetch = (request, cachedValues = {})=>{
+        const values = {};
+        for(const internalKey in options.fetchData){
+            if (cachedValues[internalKey]) continue;
+            const inputParameters = options.fetchData[internalKey];
+            values[internalKey] = client.send(new GetItemCommand(inputParameters)).then((resp)=>unmarshall(resp.Item)).catch((e)=>{
+                const value = getCache(options.cacheKey).value ?? {};
+                value[internalKey] = undefined;
+                modifyCache(options.cacheKey, value);
+                throw e;
+            });
+        }
+        return values;
+    };
+    let prefetch, client;
+    if (canPrefetch(options)) {
+        client = createPrefetchClient(options);
+        prefetch = processCache(options, fetch);
+    }
+    const dynamodbMiddlewareBefore = async (request)=>{
+        if (!client) {
+            client = await createClient(options, request);
+        }
+        const { value  } = prefetch ?? processCache(options, fetch, request);
+        Object.assign(request.internal, value);
+        if (options.setToContext) {
+            const data = await getInternal(Object.keys(options.fetchData), request);
+            Object.assign(request.context, data);
+        }
+        prefetch = null;
+    };
+    return {
+        before: dynamodbMiddlewareBefore
+    };
+};
+export default dynamodbMiddleware;
+
+
+//# sourceMappingURL=index.js.map

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "@middy/dynamodb",
+  "version": "4.1.0",
+  "description": "DynamoDB middleware for the middy framework",
+  "type": "module",
+  "engines": {
+    "node": ">=16"
+  },
+  "engineStrict": true,
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "./index.cjs",
+  "module": "./index.js",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./index.d.ts",
+        "default": "./index.js"
+      },
+      "require": {
+        "types": "./index.d.ts",
+        "default": "./index.cjs"
+      }
+    }
+  },
+  "types": "index.d.ts",
+  "files": [
+    "index.js",
+    "index.cjs",
+    "index.d.ts"
+  ],
+  "scripts": {
+    "test": "npm run test:unit",
+    "test:unit": "ava",
+    "test:benchmark": "node __benchmarks__/index.js"
+  },
+  "license": "MIT",
+  "keywords": [
+    "Lambda",
+    "Middleware",
+    "Serverless",
+    "Framework",
+    "AWS",
+    "AWS Lambda",
+    "Middy",
+    "DynamoDB"
+  ],
+  "author": {
+    "name": "Middy contributors",
+    "url": "https://github.com/middyjs/middy/graphs/contributors"
+  },
+  "repository": {
+    "type": "git",
+    "url": "github:middyjs/middy",
+    "directory": "packages/dynamodb"
+  },
+  "bugs": {
+    "url": "https://github.com/middyjs/middy/issues"
+  },
+  "homepage": "https://middy.js.org",
+  "dependencies": {
+    "@middy/util": "4.1.0"
+  },
+  "devDependencies": {
+    "@aws-sdk/client-dynamodb": "^3.245.0",
+    "@aws-sdk/util-dynamodb": "^3.245.0",
+    "@middy/core": "4.1.0",
+    "@types/aws-lambda": "^8.10.101",
+    "aws-xray-sdk": "^3.3.3"
+  },
+  "gitHead": "c5abbac9280c3a2f30758188233a7b27367901d1"
+}