@middy/appconfig 4.6.5 → 5.0.0-alpha.1

package/index.d.ts

@@ -2,27 +2,43 @@ import middy from '@middy/core'
 import { Options as MiddyOptions } from '@middy/util'
 import { Context as LambdaContext } from 'aws-lambda'
 import {
-  AppConfigClient,
-  AppConfigClientConfig,
-  GetConfigurationRequest
-} from '@aws-sdk/client-appconfig'
+  AppConfigDataClient,
+  AppConfigDataClientConfig,
+  StartConfigurationSessionRequest
+} from '@aws-sdk/client-appconfigdata'
 
-export type Options<AwsAppConfigClient = AppConfigClient>
-  = Omit<MiddyOptions<AwsAppConfigClient, AppConfigClientConfig>, 'fetchData'>
-  & {
-    fetchData?: {
-      [configurationRequestKey: string]: GetConfigurationRequest
-    }
-  }
+export type ParamType<T> = StartConfigurationSessionRequest & { __returnType?: T }
+export declare function appConfigReq<T> (req: StartConfigurationSessionRequest): ParamType<T>
 
-export type Context<TOptions extends Options | undefined> = TOptions extends {
-  setToContext: true
+export interface AppConfigOptions<AwsAppConfigClient = AppConfigDataClient>
+  extends Omit<MiddyOptions<AwsAppConfigClient, AppConfigDataClientConfig>, 'fetchData'> {
+  fetchData?: { [key: string]: StartConfigurationSessionRequest | ParamType<unknown> }
 }
-  ? LambdaContext & Record<keyof TOptions['fetchData'], any>
+
+export type Context<TOptions extends AppConfigOptions | 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 appConfigMiddleware<TOptions extends Options | undefined> (
+export type Internal<TOptions extends AppConfigOptions | undefined> =
+TOptions extends AppConfigOptions
+  ? TOptions extends { fetchData: infer TFetchData }
+    ? {
+        [Key in keyof TFetchData]: TFetchData[Key] extends ParamType<infer T>
+          ? T
+          : unknown
+      }
+    : {}
+  : {}
+
+declare function appConfigMiddleware<TOptions extends AppConfigOptions> (
   options?: TOptions
-): middy.MiddlewareObj<unknown, any, Error, Context<TOptions>>
+): middy.MiddlewareObj<unknown, any, Error, Context<TOptions>, Internal<TOptions>>
 
 export default appConfigMiddleware

package/index.js

@@ -1,62 +1,126 @@
-import { canPrefetch, createPrefetchClient, createClient, getCache, getInternal, processCache, modifyCache, jsonSafeParse } from '@middy/util';
-import { AppConfigClient, GetConfigurationCommand } from '@aws-sdk/client-appconfig';
+import {
+  canPrefetch,
+  createPrefetchClient,
+  createClient,
+  getCache,
+  getInternal,
+  processCache,
+  modifyCache,
+  jsonSafeParse
+} from '@middy/util'
+import {
+  StartConfigurationSessionCommand,
+  GetLatestConfigurationCommand,
+  AppConfigDataClient
+} from '@aws-sdk/client-appconfigdata'
+
 const defaults = {
-    AwsClient: AppConfigClient,
-    awsClientOptions: {},
-    awsClientAssumeRole: undefined,
-    awsClientCapture: undefined,
-    fetchData: {},
-    disablePrefetch: false,
-    cacheKey: 'appconfig',
-    cacheKeyExpiry: {},
-    cacheExpiry: -1,
-    setToContext: false
-};
-const contentTypePattern = /^application\/(.+\+)?json($|;.+)/;
-const appConfigMiddleware = (opts = {})=>{
-    const options = {
-        ...defaults,
-        ...opts
-    };
-    const fetch = (request, cachedValues = {})=>{
-        const values = {};
-        for (const internalKey of Object.keys(options.fetchData)){
-            if (cachedValues[internalKey]) continue;
-            values[internalKey] = client.send(new GetConfigurationCommand(options.fetchData[internalKey])).then((resp)=>{
-                let value = String.fromCharCode.apply(null, resp.Content);
-                if (contentTypePattern.test(resp.ContentType)) {
-                    value = jsonSafeParse(value);
-                }
-                return value;
-            }).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);
-    }
-    const appConfigMiddlewareBefore = async (request)=>{
-        if (!client) {
-            client = await createClient(options, request);
+  AwsClient: AppConfigDataClient,
+  awsClientOptions: {},
+  awsClientAssumeRole: undefined,
+  awsClientCapture: undefined,
+  fetchData: {},
+  disablePrefetch: false,
+  cacheKey: 'appconfig',
+  cacheKeyExpiry: {},
+  cacheExpiry: -1,
+  setToContext: false
+}
+const contentTypePattern = /^application\/(.+\+)?json($|;.+)/
+const appConfigMiddleware = (opts = {}) => {
+  const options = {
+    ...defaults,
+    ...opts
+  }
+  const configurationTokenCache = {}
+  const configurationCache = {}
+
+  function fetchLatestConfiguration (configToken, internalKey) {
+    return client
+      .send(
+        new GetLatestConfigurationCommand({
+          ConfigurationToken: configToken
+        })
+      )
+      .then((configResp) => {
+        configurationTokenCache[internalKey] =
+          configResp.NextPollConfigurationToken
+
+        if (configResp.Configuration.length === 0) {
+          return configurationCache[internalKey]
         }
-        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);
+
+        let value = String.fromCharCode.apply(null, configResp.Configuration)
+        if (contentTypePattern.test(configResp.ContentType)) {
+          value = jsonSafeParse(value)
         }
-    };
-    return {
-        before: appConfigMiddlewareBefore
-    };
-};
-export default appConfigMiddleware // # sourceMappingURL=index.js.map
-;
+        configurationCache[internalKey] = value
+        return value
+      })
+      .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 of Object.keys(options.fetchData)) {
+      if (cachedValues[internalKey]) continue
+      if (configurationTokenCache[internalKey] == null) {
+        values[internalKey] = client
+          .send(
+            new StartConfigurationSessionCommand(options.fetchData[internalKey])
+          )
+          .then((configSessionResp) =>
+            fetchLatestConfiguration(
+              configSessionResp.InitialConfigurationToken,
+              internalKey
+            )
+          )
+          .catch((e) => {
+            const value = getCache(options.cacheKey).value ?? {}
+            value[internalKey] = undefined
+            modifyCache(options.cacheKey, value)
+            throw e
+          })
+
+        continue
+      }
+      values[internalKey] = fetchLatestConfiguration(
+        configurationTokenCache[internalKey],
+        internalKey
+      )
+    }
+    return values
+  }
+  let client
+  if (canPrefetch(options)) {
+    client = createPrefetchClient(options)
+    processCache(options, fetch)
+  }
+  const appConfigMiddlewareBefore = 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: appConfigMiddlewareBefore
+  }
+}
+export default appConfigMiddleware
+
+// used for TS type inference (see index.d.ts)
+export function appConfigReq (req) {
+  return req
+}
 
+// # sourceMappingURL=index.js.map

package/package.json

@@ -1,33 +1,27 @@
 {
   "name": "@middy/appconfig",
-  "version": "4.6.5",
+  "version": "5.0.0-alpha.1",
   "description": "AppConfig 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,13 +58,13 @@
     "url": "https://github.com/sponsors/willfarrell"
   },
   "dependencies": {
-    "@middy/util": "4.6.5"
+    "@middy/util": "5.0.0-alpha.1"
   },
   "devDependencies": {
-    "@aws-sdk/client-appconfig": "^3.0.0",
-    "@middy/core": "4.6.5",
+    "@aws-sdk/client-appconfigdata": "^3.0.0",
+    "@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,72 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(module, "exports" // # sourceMappingURL=index.js.map
-, {
-    enumerable: true,
-    get: function() {
-        return _default;
-    }
-});
-const _util = require("@middy/util");
-const _clientappconfig = require("@aws-sdk/client-appconfig");
-const defaults = {
-    AwsClient: _clientappconfig.AppConfigClient,
-    awsClientOptions: {},
-    awsClientAssumeRole: undefined,
-    awsClientCapture: undefined,
-    fetchData: {},
-    disablePrefetch: false,
-    cacheKey: 'appconfig',
-    cacheKeyExpiry: {},
-    cacheExpiry: -1,
-    setToContext: false
-};
-const contentTypePattern = /^application\/(.+\+)?json($|;.+)/;
-const appConfigMiddleware = (opts = {})=>{
-    const options = {
-        ...defaults,
-        ...opts
-    };
-    const fetch = (request, cachedValues = {})=>{
-        const values = {};
-        for (const internalKey of Object.keys(options.fetchData)){
-            if (cachedValues[internalKey]) continue;
-            values[internalKey] = client.send(new _clientappconfig.GetConfigurationCommand(options.fetchData[internalKey])).then((resp)=>{
-                let value = String.fromCharCode.apply(null, resp.Content);
-                if (contentTypePattern.test(resp.ContentType)) {
-                    value = (0, _util.jsonSafeParse)(value);
-                }
-                return value;
-            }).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 appConfigMiddlewareBefore = 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: appConfigMiddlewareBefore
-    };
-};
-const _default = appConfigMiddleware;
-