@middy/dynamodb 5.0.0-alpha.0 → 5.0.0-alpha.2

package/README.md

@@ -19,8 +19,9 @@
   <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 href="https://github.com/middyjs/middy/actions/workflows/sast.yml">
+    <img src="https://github.com/middyjs/middy/actions/workflows/sast.yml/badge.svg
+?branch=main&event=push" alt="CodeQL" 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%;">

package/index.d.ts

@@ -1,26 +1,46 @@
 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'
+import { DynamoDBClient, DynamoDBClientConfig, GetItemCommandInput } from '@aws-sdk/client-dynamodb'
+import { NativeAttributeValue } from '@aws-sdk/util-dynamodb'
 
-export type Options<AwsDynamoDBClient = DynamoDBClient> =
+export type ParamType<T extends Record<string, NativeAttributeValue>> = GetItemCommandInput & { __returnType?: T }
+export declare function dynamoDbReq<T extends Record<string, NativeAttributeValue>> (req: GetItemCommandInput): ParamType<T>
+
+export type DynamoDbOptions<AwsDynamoDBClient = DynamoDBClient> =
   Omit<MiddyOptions<AwsDynamoDBClient, DynamoDBClientConfig>, 'fetchData'>
   &
   {
     fetchData?: {
-      // TODO: add more precise type
-      [key: string]: Record<string, any>
+      [key: string]: GetItemCommandInput | ParamType<Record<string, NativeAttributeValue>>
     }
   }
 
-export type Context<TOptions extends Options | undefined> = TOptions extends {
+export type Context<TOptions extends DynamoDbOptions | undefined> = TOptions extends {
   setToContext: true
 }
-  ? LambdaContext & Record<keyof TOptions['fetchData'], any>
+  ? TOptions extends { fetchData: infer TFetchData }
+    ? LambdaContext & {
+      [Key in keyof TFetchData]: TFetchData[Key] extends ParamType<infer T>
+        ? T
+        : NativeAttributeValue
+    }
+    : never
   : LambdaContext
 
-declare function dynamodbMiddleware<TOptions extends Options | undefined> (
+export type Internal<TOptions extends DynamoDbOptions | undefined> =
+TOptions extends DynamoDbOptions
+  ? TOptions extends { fetchData: infer TFetchData }
+    ? {
+        [Key in keyof TFetchData]: TFetchData[Key] extends ParamType<infer T>
+          ? T
+          : NativeAttributeValue
+      }
+    : {}
+  : {}
+
+declare function dynamodbMiddleware<TOptions extends DynamoDbOptions | undefined> (
   options?: TOptions
-): middy.MiddlewareObj<unknown, any, Error, Context<TOptions>>
+): middy.MiddlewareObj<unknown, any, Error, Context<TOptions>, Internal<TOptions>>
 
 export default dynamodbMiddleware

package/index.js

@@ -9,6 +9,7 @@ const defaults = {
     fetchData: {},
     disablePrefetch: false,
     cacheKey: 'dynamodb',
+    cacheKeyExpiry: {},
     cacheExpiry: -1,
     setToContext: false
 };
@@ -17,6 +18,7 @@ const dynamodbMiddleware = (opts = {})=>{
         ...defaults,
         ...opts
     };
+    // force marshall of Key during cold start
     for(const internalKey in options.fetchData){
         options.fetchData[internalKey].Key = marshall(options.fetchData[internalKey].Key);
     }
@@ -34,26 +36,29 @@ const dynamodbMiddleware = (opts = {})=>{
         }
         return values;
     };
-    let prefetch, client;
+    let client;
     if (canPrefetch(options)) {
         client = createPrefetchClient(options);
-        prefetch = processCache(options, fetch);
+        processCache(options, fetch);
     }
     const dynamodbMiddlewareBefore = async (request)=>{
         if (!client) {
             client = await createClient(options, request);
         }
-        const { value  } = prefetch ?? processCache(options, fetch, request);
+        const { value } = 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
     };
 };
+// used for TS type inference (see index.d.ts)
+export function dynamoDbReq(req) {
+    return req;
+}
 export default dynamodbMiddleware;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@middy/dynamodb",
-  "version": "5.0.0-alpha.0",
+  "version": "5.0.0-alpha.2",
   "description": "DynamoDB middleware for the middy framework",
   "type": "module",
   "engines": {
@@ -10,24 +10,18 @@
   "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": {
@@ -64,14 +58,14 @@
     "url": "https://github.com/sponsors/willfarrell"
   },
   "dependencies": {
-    "@middy/util": "5.0.0-alpha.0"
+    "@middy/util": "5.0.0-alpha.2"
   },
   "devDependencies": {
     "@aws-sdk/client-dynamodb": "^3.245.0",
     "@aws-sdk/util-dynamodb": "^3.245.0",
-    "@middy/core": "5.0.0-alpha.0",
+    "@middy/core": "5.0.0-alpha.2",
     "@types/aws-lambda": "^8.10.101",
     "aws-xray-sdk": "^3.3.3"
   },
-  "gitHead": "08c35e3dba9efdad0b86666ce206ce302cc65d07"
+  "gitHead": "ebce8d5df8783077fa49ba62ee9be20e8486a7f1"
 }

package/index.cjs

@@ -1,67 +0,0 @@
-"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;
-