npm - @middy/core - Versions diffs - 4.2.8 → 4.3.1 - Mend

@middy/core 4.2.8 → 4.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (4) hide show

package/index.cjs CHANGED Viewed

@@ -6,13 +6,16 @@ Object.defineProperty(module, "exports", {
     enumerable: true,
     get: ()=>_default
 });
-const _promises = require("node:timers/promises");
+const _nodeStream = require("node:stream");
+const _promises = require("node:stream/promises");
+const _promises1 = require("node:timers/promises");
 const defaultLambdaHandler = ()=>{};
 const defaultPlugin = {
     timeoutEarlyInMillis: 5,
     timeoutEarlyResponse: ()=>{
         throw new Error('Timeout');
-    }
+    },
+    streamifyResponse: false
 };
 const middy = (lambdaHandler = defaultLambdaHandler, plugin = {})=>{
     if (typeof lambdaHandler !== 'function') {
@@ -28,7 +31,7 @@ const middy = (lambdaHandler = defaultLambdaHandler, plugin = {})=>{
     const beforeMiddlewares = [];
     const afterMiddlewares = [];
     const onErrorMiddlewares = [];
-    const middy = (event = {}, context = {})=>{
+    const middyHandler = (event = {}, context = {})=>{
         plugin.requestStart?.();
         const request = {
             event,
@@ -45,6 +48,25 @@ const middy = (lambdaHandler = defaultLambdaHandler, plugin = {})=>{
             ...onErrorMiddlewares
         ], plugin);
     };
+    const middy = plugin.streamifyResponse ? awslambda.streamifyResponse(async (event, responseStream, context)=>{
+        const response = await middyHandler(event, context);
+        response.body ??= '';
+        let { body  } = response;
+        if (typeof body === 'string') {
+            function* iterator(input) {
+                const size = 16 * 1024;
+                let position = 0;
+                const length = input.length;
+                while(position < length){
+                    yield input.substring(position, position + size);
+                    position += size;
+                }
+            }
+            body = _nodeStream.Readable.from(iterator(response.body));
+        }
+        responseStream = awslambda.HttpResponseStream.from(responseStream, response);
+        await (0, _promises.pipeline)(body, responseStream);
+    }) : middyHandler;
     middy.use = (middlewares)=>{
         if (!Array.isArray(middlewares)) {
             middlewares = [
@@ -93,7 +115,7 @@ const runRequest = async (request, beforeMiddlewares, lambdaHandler, afterMiddle
                 lambdaHandler(request.event, request.context, {
                     signal: handlerAbort.signal
                 }),
-                timeoutEarly ? (0, _promises.setTimeout)(request.context.getRemainingTimeInMillis() - plugin.timeoutEarlyInMillis, undefined, {
+                timeoutEarly ? (0, _promises1.setTimeout)(request.context.getRemainingTimeInMillis() - plugin.timeoutEarlyInMillis, undefined, {
                     signal: timeoutAbort.signal
                 }).then(()=>{
                     handlerAbort.abort();

package/index.d.ts CHANGED Viewed

@@ -6,7 +6,9 @@ import {
 declare type PluginHook = () => void
 declare type PluginHookWithMiddlewareName = (middlewareName: string) => void
-declare type PluginHookPromise = (request: Request) => Promise<unknown> | unknown
+declare type PluginHookPromise = (
+  request: Request
+) => Promise<unknown> | unknown
 interface PluginObject {
   internal?: any
@@ -19,9 +21,15 @@ interface PluginObject {
   timeoutEarlyResponse?: PluginHook
   afterHandler?: PluginHook
   requestEnd?: PluginHookPromise
+  streamifyResponse?: Boolean
 }
-export interface Request<TEvent = any, TResult = any, TErr = Error, TContext extends LambdaContext = LambdaContext> {
+export interface Request<
+  TEvent = any,
+  TResult = any,
+  TErr = Error,
+  TContext extends LambdaContext = LambdaContext
+> {
   event: TEvent
   context: TContext
   response: TResult | null
@@ -31,9 +39,19 @@ export interface Request<TEvent = any, TResult = any, TErr = Error, TContext ext
   }
 }
-declare type MiddlewareFn<TEvent = any, TResult = any, TErr = Error, TContext extends LambdaContext = LambdaContext> = (request: Request<TEvent, TResult, TErr, TContext>) => any
+declare type MiddlewareFn<
+  TEvent = any,
+  TResult = any,
+  TErr = Error,
+  TContext extends LambdaContext = LambdaContext
+> = (request: Request<TEvent, TResult, TErr, TContext>) => any
-export interface MiddlewareObj<TEvent = unknown, TResult = any, TErr = Error, TContext extends LambdaContext = LambdaContext> {
+export interface MiddlewareObj<
+  TEvent = unknown,
+  TResult = any,
+  TErr = Error,
+  TContext extends LambdaContext = LambdaContext
+> {
   before?: MiddlewareFn<TEvent, TResult, TErr, TContext>
   after?: MiddlewareFn<TEvent, TResult, TErr, TContext>
   onError?: MiddlewareFn<TEvent, TResult, TErr, TContext>
@@ -41,40 +59,101 @@ export interface MiddlewareObj<TEvent = unknown, TResult = any, TErr = Error, TC
 // The AWS provided Handler type uses void | Promise<TResult> so we have no choice but to follow and suppress the linter warning
 // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
-type MiddyInputHandler<TEvent, TResult, TContext extends LambdaContext = LambdaContext> = (event: TEvent, context: TContext, callback: LambdaCallback<TResult>) => void | Promise<TResult>
-type MiddyInputPromiseHandler<TEvent, TResult, TContext extends LambdaContext = LambdaContext> = (event: TEvent, context: TContext,) => Promise<TResult>
+type MiddyInputHandler<
+  TEvent,
+  TResult,
+  TContext extends LambdaContext = LambdaContext
+> = (
+  event: TEvent,
+  context: TContext,
+  callback: LambdaCallback<TResult>
+) => // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
+void | Promise<TResult>
+type MiddyInputPromiseHandler<
+  TEvent,
+  TResult,
+  TContext extends LambdaContext = LambdaContext
+> = (event: TEvent, context: TContext) => Promise<TResult>
-export interface MiddyfiedHandler<TEvent = any, TResult = any, TErr = Error, TContext extends LambdaContext = LambdaContext> extends MiddyInputHandler<TEvent, TResult, TContext>,
+export interface MiddyfiedHandler<
+  TEvent = any,
+  TResult = any,
+  TErr = Error,
+  TContext extends LambdaContext = LambdaContext
+> extends MiddyInputHandler<TEvent, TResult, TContext>,
   MiddyInputPromiseHandler<TEvent, TResult, TContext> {
   use: UseFn<TEvent, TResult, TErr, TContext>
   before: AttachMiddlewareFn<TEvent, TResult, TErr, TContext>
   after: AttachMiddlewareFn<TEvent, TResult, TErr, TContext>
   onError: AttachMiddlewareFn<TEvent, TResult, TErr, TContext>
-  handler: <TAdditional>(handler: MiddlewareHandler<LambdaHandler<TEvent & TAdditional, TResult>, TContext>) => MiddyfiedHandler<TEvent, TResult, TErr, TContext>
+  handler: <TAdditional>(
+    handler: MiddlewareHandler<
+    LambdaHandler<TEvent & TAdditional, TResult>,
+    TContext
+    >
+  ) => MiddyfiedHandler<TEvent, TResult, TErr, TContext>
 }
-declare type AttachMiddlewareFn<TEvent = any, TResult = any, TErr = Error, TContext extends LambdaContext = LambdaContext> =
-  (middleware: MiddlewareFn<TEvent, TResult, TErr, TContext>) => MiddyfiedHandler<TEvent, TResult, TErr, TContext>
+declare type AttachMiddlewareFn<
+  TEvent = any,
+  TResult = any,
+  TErr = Error,
+  TContext extends LambdaContext = LambdaContext
+> = (
+  middleware: MiddlewareFn<TEvent, TResult, TErr, TContext>
+) => MiddyfiedHandler<TEvent, TResult, TErr, TContext>
-declare type AttachMiddlewareObj<TEvent = any, TResult = any, TErr = Error, TContext extends LambdaContext = LambdaContext> =
-  (middleware: MiddlewareObj<TEvent, TResult, TErr, TContext>) => MiddyfiedHandler<TEvent, TResult, TErr, TContext>
+declare type AttachMiddlewareObj<
+  TEvent = any,
+  TResult = any,
+  TErr = Error,
+  TContext extends LambdaContext = LambdaContext
+> = (
+  middleware: MiddlewareObj<TEvent, TResult, TErr, TContext>
+) => MiddyfiedHandler<TEvent, TResult, TErr, TContext>
-declare type UseFn<TEvent = any, TResult = any, TErr = Error, TContext extends LambdaContext = LambdaContext> =
-  <TMiddleware extends MiddlewareObj<any, any, Error, any>>(middlewares: TMiddleware | TMiddleware[]) => TMiddleware extends MiddlewareObj<infer TMiddlewareEvent, any, Error, infer TMiddlewareContext>
-    ? MiddyfiedHandler<TMiddlewareEvent & TEvent, TResult, TErr, TMiddlewareContext & TContext> // always true
-    : never
+declare type UseFn<
+  TEvent = any,
+  TResult = any,
+  TErr = Error,
+  TContext extends LambdaContext = LambdaContext
+> = <TMiddleware extends MiddlewareObj<any, any, Error, any>>(
+  middlewares: TMiddleware | TMiddleware[]
+) => TMiddleware extends MiddlewareObj<
+infer TMiddlewareEvent,
+any,
+Error,
+infer TMiddlewareContext
+>
+  ? MiddyfiedHandler<
+  TMiddlewareEvent & TEvent,
+  TResult,
+  TErr,
+  TMiddlewareContext & TContext
+  > // always true
+  : never
-declare type MiddlewareHandler<THandler extends LambdaHandler<any, any>, TContext extends LambdaContext = LambdaContext> =
-  THandler extends LambdaHandler<infer TEvent, infer TResult> // always true
-    ? MiddyInputHandler<TEvent, TResult, TContext>
-    : never
+declare type MiddlewareHandler<
+  THandler extends LambdaHandler<any, any>,
+  TContext extends LambdaContext = LambdaContext
+> = THandler extends LambdaHandler<infer TEvent, infer TResult> // always true
+  ? MiddyInputHandler<TEvent, TResult, TContext>
+  : never
 /**
  * Middy factory function. Use it to wrap your existing handler to enable middlewares on it.
  * @param handler your original AWS Lambda function
  * @param plugin wraps around each middleware and handler to add custom lifecycle behaviours (e.g. to profile performance)
  */
-declare function middy<TEvent = unknown, TResult = any, TErr = Error, TContext extends LambdaContext = LambdaContext> (handler?: MiddlewareHandler<LambdaHandler<TEvent, TResult>, TContext>, plugin?: PluginObject): MiddyfiedHandler<TEvent, TResult, TErr, TContext>
+declare function middy<
+  TEvent = unknown,
+  TResult = any,
+  TErr = Error,
+  TContext extends LambdaContext = LambdaContext
+> (
+  handler?: MiddlewareHandler<LambdaHandler<TEvent, TResult>, TContext>,
+  plugin?: PluginObject
+): MiddyfiedHandler<TEvent, TResult, TErr, TContext>
 declare namespace middy {
   export {

package/index.js CHANGED Viewed

@@ -1,10 +1,13 @@
+import { Readable } from 'node:stream';
+import { pipeline } from 'node:stream/promises';
 import { setTimeout } from 'node:timers/promises';
 const defaultLambdaHandler = ()=>{};
 const defaultPlugin = {
     timeoutEarlyInMillis: 5,
     timeoutEarlyResponse: ()=>{
         throw new Error('Timeout');
-    }
+    },
+    streamifyResponse: false
 };
 const middy = (lambdaHandler = defaultLambdaHandler, plugin = {})=>{
     if (typeof lambdaHandler !== 'function') {
@@ -20,7 +23,7 @@ const middy = (lambdaHandler = defaultLambdaHandler, plugin = {})=>{
     const beforeMiddlewares = [];
     const afterMiddlewares = [];
     const onErrorMiddlewares = [];
-    const middy = (event = {}, context = {})=>{
+    const middyHandler = (event = {}, context = {})=>{
         plugin.requestStart?.();
         const request = {
             event,
@@ -37,6 +40,25 @@ const middy = (lambdaHandler = defaultLambdaHandler, plugin = {})=>{
             ...onErrorMiddlewares
         ], plugin);
     };
+    const middy = plugin.streamifyResponse ? awslambda.streamifyResponse(async (event, responseStream, context)=>{
+        const response = await middyHandler(event, context);
+        response.body ??= '';
+        let { body  } = response;
+        if (typeof body === 'string') {
+            function* iterator(input) {
+                const size = 16 * 1024;
+                let position = 0;
+                const length = input.length;
+                while(position < length){
+                    yield input.substring(position, position + size);
+                    position += size;
+                }
+            }
+            body = Readable.from(iterator(response.body));
+        }
+        responseStream = awslambda.HttpResponseStream.from(responseStream, response);
+        await pipeline(body, responseStream);
+    }) : middyHandler;
     middy.use = (middlewares)=>{
         if (!Array.isArray(middlewares)) {
             middlewares = [

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@middy/core",
-  "version": "4.2.8",
+  "version": "4.3.1",
   "description": "🛵 The stylish Node.js middleware engine for AWS Lambda (core package)",
   "type": "module",
   "engines": {
@@ -62,8 +62,9 @@
     "url": "https://github.com/sponsors/willfarrell"
   },
   "devDependencies": {
+    "@datastream/core": "0.0.29",
     "@types/aws-lambda": "^8.10.76",
     "@types/node": "^18.0.0"
   },
-  "gitHead": "9e7eec0f50fd1edef232edb7a99c035f9bc1f159"
+  "gitHead": "e7576b56f165591acc427fd567b6cba8d4874340"
 }