@middy/ssm 4.6.5 → 5.0.0-alpha.1

package/index.d.ts

@@ -2,27 +2,39 @@ import middy from '@middy/core'
 import { Options as MiddyOptions } from '@middy/util'
 import { Context as LambdaContext } from 'aws-lambda'
 import { SSMClient, SSMClientConfig } from '@aws-sdk/client-ssm'
-import { JsonValue } from 'type-fest'
 
-interface Options<AwsSSMClient = SSMClient>
-  extends MiddyOptions<AwsSSMClient, SSMClientConfig> {}
+export type ParamType<T> = string & { __returnType?: T }
+export declare function ssmParam<T> (path: string): ParamType<T>
 
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-type ExtractSingles<T> = T extends `/${infer _}` ? never : T
-
-export type Context<TOptions extends Options | undefined> = TOptions extends {
-  setToContext: true
+export interface SSMOptions<AwsSSMClient = SSMClient>
+  extends Omit<MiddyOptions<AwsSSMClient, SSMClientConfig>, 'fetchData'> {
+  fetchData?: { [key: string]: string | ParamType<unknown> }
 }
-  ? LambdaContext &
-  Record<ExtractSingles<keyof TOptions['fetchData']>, JsonValue> &
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  (keyof TOptions['fetchData'] extends `${infer _P}/${infer _S}`
-    ? Record<string, JsonValue>
-    : unknown)
+
+export type Context<TOptions extends SSMOptions | undefined> =
+TOptions extends { setToContext: true }
+  ? TOptions extends { fetchData: infer TFetchData }
+    ? LambdaContext & {
+      [Key in keyof TFetchData]: TFetchData[Key] extends ParamType<infer T>
+        ? T
+        : unknown
+    }
+    : never
   : LambdaContext
 
-declare function ssm<TOptions extends Options> (
+export type Internal<TOptions extends SSMOptions | undefined> =
+TOptions extends SSMOptions
+  ? TOptions extends { fetchData: infer TFetchData }
+    ? {
+        [Key in keyof TFetchData]: TFetchData[Key] extends ParamType<infer T>
+          ? T
+          : unknown
+      }
+    : {}
+  : {}
+
+declare function ssm<TOptions extends SSMOptions> (
   options?: TOptions
-): middy.MiddlewareObj<unknown, any, Error, Context<TOptions>>
+): middy.MiddlewareObj<unknown, any, Error, Context<TOptions>, Internal<TOptions>>
 
 export default ssm

package/index.js

@@ -1,143 +1,195 @@
-import { canPrefetch, createPrefetchClient, createClient, processCache, getCache, modifyCache, jsonSafeParse, getInternal, sanitizeKey } from '@middy/util';
-import { SSMClient, GetParametersCommand, GetParametersByPathCommand } from '@aws-sdk/client-ssm';
-const awsRequestLimit = 10;
+import {
+  canPrefetch,
+  createPrefetchClient,
+  createClient,
+  processCache,
+  getCache,
+  modifyCache,
+  jsonSafeParse,
+  getInternal,
+  sanitizeKey
+} from '@middy/util'
+import {
+  SSMClient,
+  GetParametersCommand,
+  GetParametersByPathCommand
+} from '@aws-sdk/client-ssm'
+
+const awsRequestLimit = 10
 const defaults = {
-    AwsClient: SSMClient,
-    awsClientOptions: {},
-    awsClientAssumeRole: undefined,
-    awsClientCapture: undefined,
-    fetchData: {},
-    disablePrefetch: false,
-    cacheKey: 'ssm',
-    cacheKeyExpiry: {},
-    cacheExpiry: -1,
-    setToContext: false
-};
-const ssmMiddleware = (opts = {})=>{
-    const options = {
-        ...defaults,
-        ...opts
-    };
-    const fetch = (request, cachedValues)=>{
-        return {
-            ...fetchSingle(request, cachedValues),
-            ...fetchByPath(request, cachedValues)
-        };
-    };
-    const fetchSingle = (request, cachedValues = {})=>{
-        const values = {};
-        let batchReq = null;
-        let batchInternalKeys = [];
-        let batchFetchKeys = [];
-        const namedKeys = [];
-        const internalKeys = Object.keys(options.fetchData);
-        const fetchKeys = Object.values(options.fetchData);
-        for (const internalKey of internalKeys){
-            if (cachedValues[internalKey]) continue;
-            if (options.fetchData[internalKey].substr(-1) === '/') continue; // Skip path passed in
-            namedKeys.push(internalKey);
-        }
-        for (const [idx, internalKey] of namedKeys.entries()){
-            const fetchKey = options.fetchData[internalKey];
-            batchInternalKeys.push(internalKey);
-            batchFetchKeys.push(fetchKey);
-            // from the first to the batch size skip, unless it's the last entry
-            if ((!idx || (idx + 1) % awsRequestLimit !== 0) && !(idx + 1 === namedKeys.length)) {
-                continue;
-            }
-            batchReq = client.send(new GetParametersCommand({
-                Names: batchFetchKeys,
-                WithDecryption: true
-            })).then((resp)=>{
-                // Don't sanitize key, mapped to set value in options
-                return Object.assign(...(resp.InvalidParameters ?? []).map((fetchKey)=>{
-                    return {
-                        [fetchKey]: new Promise(()=>{
-                            const internalKey = internalKeys[fetchKeys.indexOf(fetchKey)];
-                            const value = getCache(options.cacheKey).value ?? {};
-                            value[internalKey] = undefined;
-                            modifyCache(options.cacheKey, value);
-                            throw new Error('[ssm] InvalidParameter ' + fetchKey);
-                        })
-                    };
-                }), ...(resp.Parameters ?? []).map((param)=>{
-                    return {
-                        [param.Name]: parseValue(param)
-                    };
-                }));
-            }).catch((e)=>{
-                const value = getCache(options.cacheKey).value ?? {};
-                value[internalKey] = undefined;
-                modifyCache(options.cacheKey, value);
-                throw e;
-            });
-            for (const internalKey of batchInternalKeys){
-                values[internalKey] = batchReq.then((params)=>{
-                    return params[options.fetchData[internalKey]];
-                });
-            }
-            batchInternalKeys = [];
-            batchFetchKeys = [];
-            batchReq = null;
-        }
-        return values;
-    };
-    const fetchByPath = (request, cachedValues = {})=>{
-        const values = {};
-        for(const internalKey in options.fetchData){
-            if (cachedValues[internalKey]) continue;
-            const fetchKey = options.fetchData[internalKey];
-            if (fetchKey.substr(-1) !== '/') continue; // Skip not path passed in
-            values[internalKey] = fetchPath(fetchKey).catch((e)=>{
-                const value = getCache(options.cacheKey).value ?? {};
-                value[internalKey] = undefined;
-                modifyCache(options.cacheKey, value);
-                throw e;
-            });
-        }
-        return values;
-    };
-    const fetchPath = (path, nextToken, values = {})=>{
-        return client.send(new GetParametersByPathCommand({
-            Path: path,
-            NextToken: nextToken,
-            Recursive: true,
+  AwsClient: SSMClient, // Allow for XRay
+  awsClientOptions: {},
+  awsClientAssumeRole: undefined,
+  awsClientCapture: undefined,
+  fetchData: {}, // { contextKey: fetchKey, contextPrefix: fetchPath/ }
+  disablePrefetch: false,
+  cacheKey: 'ssm',
+  cacheKeyExpiry: {},
+  cacheExpiry: -1,
+  setToContext: false
+}
+
+const ssmMiddleware = (opts = {}) => {
+  const options = { ...defaults, ...opts }
+
+  const fetch = (request, cachedValues) => {
+    return {
+      ...fetchSingle(request, cachedValues),
+      ...fetchByPath(request, cachedValues)
+    }
+  }
+
+  const fetchSingle = (request, cachedValues = {}) => {
+    const values = {}
+    let batchReq = null
+    let batchInternalKeys = []
+    let batchFetchKeys = []
+    const namedKeys = []
+
+    const internalKeys = Object.keys(options.fetchData)
+    const fetchKeys = Object.values(options.fetchData)
+    for (const internalKey of internalKeys) {
+      if (cachedValues[internalKey]) continue
+      if (options.fetchData[internalKey].substr(-1) === '/') continue // Skip path passed in
+      namedKeys.push(internalKey)
+    }
+
+    for (const [idx, internalKey] of namedKeys.entries()) {
+      const fetchKey = options.fetchData[internalKey]
+      batchInternalKeys.push(internalKey)
+      batchFetchKeys.push(fetchKey)
+      // from the first to the batch size skip, unless it's the last entry
+      if (
+        (!idx || (idx + 1) % awsRequestLimit !== 0) &&
+        !(idx + 1 === namedKeys.length)
+      ) {
+        continue
+      }
+
+      batchReq = client
+        .send(
+          new GetParametersCommand({
+            Names: batchFetchKeys,
             WithDecryption: true
-        })).then((resp)=>{
-            Object.assign(values, ...resp.Parameters.map((param)=>{
-                return {
-                    [sanitizeKey(param.Name.replace(path, ''))]: parseValue(param)
-                };
-            }));
-            if (resp.NextToken) return fetchPath(path, resp.NextToken, values);
-            return values;
-        });
-    };
-    const parseValue = (param)=>{
-        if (param.Type === 'StringList') {
-            return param.Value.split(',');
-        }
-        return jsonSafeParse(param.Value);
-    };
-    let client;
-    if (canPrefetch(options)) {
-        client = createPrefetchClient(options);
-        processCache(options, fetch);
+          })
+        )
+        .then((resp) => {
+          // Don't sanitize key, mapped to set value in options
+          return Object.assign(
+            ...(resp.InvalidParameters ?? []).map((fetchKey) => {
+              return {
+                [fetchKey]: new Promise(() => {
+                  const internalKey = internalKeys[fetchKeys.indexOf(fetchKey)]
+                  const value = getCache(options.cacheKey).value ?? {}
+                  value[internalKey] = undefined
+                  modifyCache(options.cacheKey, value)
+                  throw new Error('InvalidParameter ' + fetchKey, {
+                    cause: { package: '@middy/ssm' }
+                  })
+                })
+              }
+            }),
+            ...(resp.Parameters ?? []).map((param) => {
+              return { [param.Name]: parseValue(param) }
+            })
+          )
+        })
+        .catch((e) => {
+          const value = getCache(options.cacheKey).value ?? {}
+          value[internalKey] = undefined
+          modifyCache(options.cacheKey, value)
+          throw e
+        })
+
+      for (const internalKey of batchInternalKeys) {
+        values[internalKey] = batchReq.then((params) => {
+          return params[options.fetchData[internalKey]]
+        })
+      }
+
+      batchInternalKeys = []
+      batchFetchKeys = []
+      batchReq = null
     }
-    const ssmMiddlewareBefore = 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: ssmMiddlewareBefore
-    };
-};
-export default ssmMiddleware;
+    return values
+  }
+
+  const fetchByPath = (request, cachedValues = {}) => {
+    const values = {}
+    for (const internalKey in options.fetchData) {
+      if (cachedValues[internalKey]) continue
+      const fetchKey = options.fetchData[internalKey]
+      if (fetchKey.substr(-1) !== '/') continue // Skip not path passed in
+      values[internalKey] = fetchPath(fetchKey).catch((e) => {
+        const value = getCache(options.cacheKey).value ?? {}
+        value[internalKey] = undefined
+        modifyCache(options.cacheKey, value)
+        throw e
+      })
+    }
+    return values
+  }
+
+  const fetchPath = (path, nextToken, values = {}) => {
+    return client
+      .send(
+        new GetParametersByPathCommand({
+          Path: path,
+          NextToken: nextToken,
+          Recursive: true,
+          WithDecryption: true
+        })
+      )
+      .then((resp) => {
+        Object.assign(
+          values,
+          ...resp.Parameters.map((param) => {
+            return {
+              [sanitizeKey(param.Name.replace(path, ''))]: parseValue(param)
+            }
+          })
+        )
+        if (resp.NextToken) return fetchPath(path, resp.NextToken, values)
+        return values
+      })
+  }
+
+  const parseValue = (param) => {
+    if (param.Type === 'StringList') {
+      return param.Value.split(',')
+    }
+    return jsonSafeParse(param.Value)
+  }
+
+  let client
+  if (canPrefetch(options)) {
+    client = createPrefetchClient(options)
+    processCache(options, fetch)
+  }
+
+  const ssmMiddlewareBefore = 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: ssmMiddlewareBefore
+  }
+}
+
+export default ssmMiddleware
 
+// used for TS type inference (see index.d.ts)
+export function ssmParam (name) {
+  return name
+}

package/package.json

@@ -1,33 +1,27 @@
 {
   "name": "@middy/ssm",
-  "version": "4.6.5",
+  "version": "5.0.0-alpha.1",
   "description": "SSM (EC2 Systems Manager) parameters 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": {
@@ -66,14 +60,13 @@
     "url": "https://github.com/sponsors/willfarrell"
   },
   "dependencies": {
-    "@middy/util": "4.6.5"
+    "@middy/util": "5.0.0-alpha.1"
   },
   "devDependencies": {
     "@aws-sdk/client-ssm": "^3.0.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",
-    "type-fest": "^4.0.0"
+    "aws-xray-sdk": "^3.3.3"
   },
-  "gitHead": "573d7b0bb243d8c5a9bcb00cf29d031aa7a0c606"
+  "gitHead": "ebce8d5df8783077fa49ba62ee9be20e8486a7f1"
 }

package/index.cjs

@@ -1,153 +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 _clientssm = require("@aws-sdk/client-ssm");
-const awsRequestLimit = 10;
-const defaults = {
-    AwsClient: _clientssm.SSMClient,
-    awsClientOptions: {},
-    awsClientAssumeRole: undefined,
-    awsClientCapture: undefined,
-    fetchData: {},
-    disablePrefetch: false,
-    cacheKey: 'ssm',
-    cacheKeyExpiry: {},
-    cacheExpiry: -1,
-    setToContext: false
-};
-const ssmMiddleware = (opts = {})=>{
-    const options = {
-        ...defaults,
-        ...opts
-    };
-    const fetch = (request, cachedValues)=>{
-        return {
-            ...fetchSingle(request, cachedValues),
-            ...fetchByPath(request, cachedValues)
-        };
-    };
-    const fetchSingle = (request, cachedValues = {})=>{
-        const values = {};
-        let batchReq = null;
-        let batchInternalKeys = [];
-        let batchFetchKeys = [];
-        const namedKeys = [];
-        const internalKeys = Object.keys(options.fetchData);
-        const fetchKeys = Object.values(options.fetchData);
-        for (const internalKey of internalKeys){
-            if (cachedValues[internalKey]) continue;
-            if (options.fetchData[internalKey].substr(-1) === '/') continue; // Skip path passed in
-            namedKeys.push(internalKey);
-        }
-        for (const [idx, internalKey] of namedKeys.entries()){
-            const fetchKey = options.fetchData[internalKey];
-            batchInternalKeys.push(internalKey);
-            batchFetchKeys.push(fetchKey);
-            // from the first to the batch size skip, unless it's the last entry
-            if ((!idx || (idx + 1) % awsRequestLimit !== 0) && !(idx + 1 === namedKeys.length)) {
-                continue;
-            }
-            batchReq = client.send(new _clientssm.GetParametersCommand({
-                Names: batchFetchKeys,
-                WithDecryption: true
-            })).then((resp)=>{
-                // Don't sanitize key, mapped to set value in options
-                return Object.assign(...(resp.InvalidParameters ?? []).map((fetchKey)=>{
-                    return {
-                        [fetchKey]: new Promise(()=>{
-                            const internalKey = internalKeys[fetchKeys.indexOf(fetchKey)];
-                            const value = (0, _util.getCache)(options.cacheKey).value ?? {};
-                            value[internalKey] = undefined;
-                            (0, _util.modifyCache)(options.cacheKey, value);
-                            throw new Error('[ssm] InvalidParameter ' + fetchKey);
-                        })
-                    };
-                }), ...(resp.Parameters ?? []).map((param)=>{
-                    return {
-                        [param.Name]: parseValue(param)
-                    };
-                }));
-            }).catch((e)=>{
-                const value = (0, _util.getCache)(options.cacheKey).value ?? {};
-                value[internalKey] = undefined;
-                (0, _util.modifyCache)(options.cacheKey, value);
-                throw e;
-            });
-            for (const internalKey of batchInternalKeys){
-                values[internalKey] = batchReq.then((params)=>{
-                    return params[options.fetchData[internalKey]];
-                });
-            }
-            batchInternalKeys = [];
-            batchFetchKeys = [];
-            batchReq = null;
-        }
-        return values;
-    };
-    const fetchByPath = (request, cachedValues = {})=>{
-        const values = {};
-        for(const internalKey in options.fetchData){
-            if (cachedValues[internalKey]) continue;
-            const fetchKey = options.fetchData[internalKey];
-            if (fetchKey.substr(-1) !== '/') continue; // Skip not path passed in
-            values[internalKey] = fetchPath(fetchKey).catch((e)=>{
-                const value = (0, _util.getCache)(options.cacheKey).value ?? {};
-                value[internalKey] = undefined;
-                (0, _util.modifyCache)(options.cacheKey, value);
-                throw e;
-            });
-        }
-        return values;
-    };
-    const fetchPath = (path, nextToken, values = {})=>{
-        return client.send(new _clientssm.GetParametersByPathCommand({
-            Path: path,
-            NextToken: nextToken,
-            Recursive: true,
-            WithDecryption: true
-        })).then((resp)=>{
-            Object.assign(values, ...resp.Parameters.map((param)=>{
-                return {
-                    [(0, _util.sanitizeKey)(param.Name.replace(path, ''))]: parseValue(param)
-                };
-            }));
-            if (resp.NextToken) return fetchPath(path, resp.NextToken, values);
-            return values;
-        });
-    };
-    const parseValue = (param)=>{
-        if (param.Type === 'StringList') {
-            return param.Value.split(',');
-        }
-        return (0, _util.jsonSafeParse)(param.Value);
-    };
-    let client;
-    if ((0, _util.canPrefetch)(options)) {
-        client = (0, _util.createPrefetchClient)(options);
-        (0, _util.processCache)(options, fetch);
-    }
-    const ssmMiddlewareBefore = 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: ssmMiddlewareBefore
-    };
-};
-const _default = ssmMiddleware;
-