@middy/dynamodb 4.6.5 → 5.0.0-alpha.1

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

@@ -1,60 +1,82 @@
-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';
+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',
-    cacheKeyExpiry: {},
-    cacheExpiry: -1,
-    setToContext: false
-};
-const dynamodbMiddleware = (opts = {})=>{
-    const options = {
-        ...defaults,
-        ...opts
-    };
-    // force marshall of Key during cold start
-    for(const internalKey in options.fetchData){
-        options.fetchData[internalKey].Key = marshall(options.fetchData[internalKey].Key);
+  AwsClient: DynamoDBClient,
+  awsClientOptions: {},
+  awsClientAssumeRole: undefined,
+  awsClientCapture: undefined,
+  fetchData: {},
+  disablePrefetch: false,
+  cacheKey: 'dynamodb',
+  cacheKeyExpiry: {},
+  cacheExpiry: -1,
+  setToContext: false
+}
+const dynamodbMiddleware = (opts = {}) => {
+  const options = {
+    ...defaults,
+    ...opts
+  }
+
+  // force marshall of Key during cold start
+  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
+        })
     }
-    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 client;
-    if (canPrefetch(options)) {
-        client = createPrefetchClient(options);
-        processCache(options, fetch);
+    return values
+  }
+
+  let client
+  if (canPrefetch(options)) {
+    client = createPrefetchClient(options)
+    processCache(options, fetch)
+  }
+  const dynamodbMiddlewareBefore = async (request) => {
+    if (!client) {
+      client = await createClient(options, 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)
     }
-    const dynamodbMiddlewareBefore = async (request)=>{
-        if (!client) {
-            client = await createClient(options, 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);
-        }
-    };
-    return {
-        before: dynamodbMiddlewareBefore
-    };
-};
-export default dynamodbMiddleware;
+  }
+  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,33 +1,27 @@
 {
   "name": "@middy/dynamodb",
-  "version": "4.6.5",
+  "version": "5.0.0-alpha.1",
   "description": "DynamoDB middleware for the middy framework",
   "type": "module",
   "engines": {
-    "node": ">=16"
+    "node": ">=18"
   },
   "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": {
@@ -64,14 +58,14 @@
     "url": "https://github.com/sponsors/willfarrell"
   },
   "dependencies": {
-    "@middy/util": "4.6.5"
+    "@middy/util": "5.0.0-alpha.1"
   },
   "devDependencies": {
     "@aws-sdk/client-dynamodb": "^3.245.0",
     "@aws-sdk/util-dynamodb": "^3.245.0",
-    "@middy/core": "4.6.5",
+    "@middy/core": "5.0.0-alpha.1",
     "@types/aws-lambda": "^8.10.101",
     "aws-xray-sdk": "^3.3.3"
   },
-  "gitHead": "573d7b0bb243d8c5a9bcb00cf29d031aa7a0c606"
+  "gitHead": "ebce8d5df8783077fa49ba62ee9be20e8486a7f1"
 }

package/index.cjs

@@ -1,70 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(module, "exports", {
-    enumerable: true,
-    get: function() {
-        return _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',
-    cacheKeyExpiry: {},
-    cacheExpiry: -1,
-    setToContext: false
-};
-const dynamodbMiddleware = (opts = {})=>{
-    const options = {
-        ...defaults,
-        ...opts
-    };
-    // force marshall of Key during cold start
-    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 client;
-    if ((0, _util.canPrefetch)(options)) {
-        client = (0, _util.createPrefetchClient)(options);
-        (0, _util.processCache)(options, fetch);
-    }
-    const dynamodbMiddlewareBefore = async (request)=>{
-        if (!client) {
-            client = await (0, _util.createClient)(options, request);
-        }
-        const { value } = (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);
-        }
-    };
-    return {
-        before: dynamodbMiddlewareBefore
-    };
-};
-const _default = dynamodbMiddleware;
-