@middy/s3-object-response 4.6.5 → 5.0.0-alpha.1

package/index.d.ts

@@ -4,7 +4,7 @@ import { Context as LambdaContext } from 'aws-lambda'
 import { S3Client, S3ClientConfig } from '@aws-sdk/client-s3'
 import { ClientRequest } from 'http'
 
-interface Options<AwsS3Client = S3Client>
+export interface S3ObjectResponseOptions<AwsS3Client = S3Client>
   extends Pick<
   MiddyOptions<AwsS3Client, S3ClientConfig>,
   | 'AwsClient'
@@ -16,16 +16,25 @@ interface Options<AwsS3Client = S3Client>
   bodyType?: 'stream' | 'promise'
 }
 
-export type Context<TOptions extends Options | undefined> = LambdaContext & {
+export type Context<TOptions extends S3ObjectResponseOptions | undefined> = LambdaContext & {
   s3Object: TOptions extends { bodyType: 'stream' }
     ? ClientRequest
     : TOptions extends { bodyType: 'promise' }
       ? Promise<any>
       : never
+} & {
+  s3ObjectFetch: Promise<Response>
 }
 
-declare function s3ObjectResponse<TOptions extends Options | undefined> (
+export interface Internal extends Record<string, any> {
+  s3ObjectResponse: {
+    RequestRoute: string
+    RequestToken: string
+  }
+}
+
+declare function s3ObjectResponse<TOptions extends S3ObjectResponseOptions | undefined> (
   options?: TOptions
-): middy.MiddlewareObj<unknown, any, Error, Context<TOptions>>
+): middy.MiddlewareObj<unknown, any, Error, Context<TOptions>, Internal>
 
 export default s3ObjectResponse

package/index.js

@@ -1,90 +1,59 @@
-import __https from 'https';
-import { URL } from 'url';
-import { canPrefetch, createPrefetchClient, createClient } from '@middy/util';
-import { S3Client, WriteGetObjectResponseCommand } from '@aws-sdk/client-s3';
+import { canPrefetch, createPrefetchClient, createClient } from '@middy/util'
+
+import { S3Client, WriteGetObjectResponseCommand } from '@aws-sdk/client-s3'
+
 const defaults = {
-    AwsClient: S3Client,
-    awsClientOptions: {},
-    awsClientAssumeRole: undefined,
-    awsClientCapture: undefined,
-    httpsCapture: undefined,
-    disablePrefetch: false,
-    bodyType: undefined,
-    // For mocking out only, rewire doesn't support ES Modules :(
-    __https
-};
-let https = __https;
-const s3ObjectResponseMiddleware = (opts = {})=>{
-    const options = {
-        ...defaults,
-        ...opts
-    };
-    if (![
-        'stream',
-        'promise'
-    ].includes(options.bodyType)) {
-        throw new Error('[s3-object-response] bodyType is invalid');
-    }
-    if (options.httpsCapture) {
-        https = options.httpsCapture(options.__https);
+  AwsClient: S3Client,
+  awsClientOptions: {},
+  awsClientAssumeRole: undefined,
+  awsClientCapture: undefined,
+  disablePrefetch: false
+}
+
+const s3ObjectResponseMiddleware = (opts = {}) => {
+  const options = { ...defaults, ...opts }
+
+  let client
+  if (canPrefetch(options)) {
+    client = createPrefetchClient(options)
+  }
+
+  const s3ObjectResponseMiddlewareBefore = async (request) => {
+    const { inputS3Url, outputRoute, outputToken } =
+      request.event.getObjectContext
+
+    request.internal.s3ObjectResponse = {
+      RequestRoute: outputRoute,
+      RequestToken: outputToken
     }
-    let client;
-    if (canPrefetch(options)) {
-        client = createPrefetchClient(options);
+
+    request.context.s3ObjectFetch = fetch(inputS3Url)
+  }
+
+  const s3ObjectResponseMiddlewareAfter = async (request) => {
+    if (!client) {
+      client = await createClient(options, request)
     }
-    const s3ObjectResponseMiddlewareBefore = async (request)=>{
-        const { inputS3Url, outputRoute, outputToken } = request.event.getObjectContext;
-        request.internal.s3ObjectResponse = {
-            RequestRoute: outputRoute,
-            RequestToken: outputToken
-        };
-        const parsedInputS3Url = new URL(inputS3Url);
-        const fetchOptions = {
-            method: 'GET',
-            host: parsedInputS3Url.hostname,
-            path: parsedInputS3Url.pathname
-        };
-        request.context.s3Object = fetchType(options.bodyType, fetchOptions);
-    };
-    const s3ObjectResponseMiddlewareAfter = async (request)=>{
-        if (!client) {
-            client = await createClient(options, request);
-        }
-        request.response.Body ??= request.response.body;
-        delete request.response.body;
-        await client.send(new WriteGetObjectResponseCommand({
-            ...request.internal.s3ObjectResponse,
-            ...request.response
-        }));
-        return {
-            statusCode: 200
-        };
-    };
-    return {
-        before: s3ObjectResponseMiddlewareBefore,
-        after: s3ObjectResponseMiddlewareAfter
-    };
-};
-const fetchType = (type, fetchOptions)=>{
-    if (type === 'stream') {
-        return fetchStream(fetchOptions);
-    } else if (type === 'promise') {
-        return fetchPromise(fetchOptions);
+
+    if (request.response.body) {
+      request.response.Body = request.response.body
+      delete request.response.body
     }
-};
-const fetchStream = (fetchOptions)=>{
-    return https.request(fetchOptions);
-};
-const fetchPromise = (fetchOptions)=>{
-    return new Promise((resolve, reject)=>{
-        let data = '';
-        const stream = fetchStream(fetchOptions);
-        stream.on('data', (chunk)=>{
-            data += chunk;
-        });
-        stream.on('end', ()=>resolve(data));
-        stream.on('error', (error)=>reject(error));
-    });
-};
-export default s3ObjectResponseMiddleware;
 
+    await client.send(
+      new WriteGetObjectResponseCommand({
+        ...request.internal.s3ObjectResponse,
+        ...request.response
+      })
+    )
+
+    return { statusCode: 200 }
+  }
+
+  return {
+    before: s3ObjectResponseMiddlewareBefore,
+    after: s3ObjectResponseMiddlewareAfter
+  }
+}
+
+export default s3ObjectResponseMiddleware

package/package.json

@@ -1,33 +1,27 @@
 {
   "name": "@middy/s3-object-response",
-  "version": "4.6.5",
+  "version": "5.0.0-alpha.1",
   "description": "S3 object response handling 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,13 +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-s3": "^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"
   },
-  "gitHead": "573d7b0bb243d8c5a9bcb00cf29d031aa7a0c606"
+  "gitHead": "ebce8d5df8783077fa49ba62ee9be20e8486a7f1"
 }

package/index.cjs

@@ -1,105 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(module, "exports", {
-    enumerable: true,
-    get: function() {
-        return _default;
-    }
-});
-const _https = /*#__PURE__*/ _interop_require_default(require("https"));
-const _url = require("url");
-const _util = require("@middy/util");
-const _clients3 = require("@aws-sdk/client-s3");
-function _interop_require_default(obj) {
-    return obj && obj.__esModule ? obj : {
-        default: obj
-    };
-}
-const defaults = {
-    AwsClient: _clients3.S3Client,
-    awsClientOptions: {},
-    awsClientAssumeRole: undefined,
-    awsClientCapture: undefined,
-    httpsCapture: undefined,
-    disablePrefetch: false,
-    bodyType: undefined,
-    // For mocking out only, rewire doesn't support ES Modules :(
-    __https: _https.default
-};
-let https = _https.default;
-const s3ObjectResponseMiddleware = (opts = {})=>{
-    const options = {
-        ...defaults,
-        ...opts
-    };
-    if (![
-        'stream',
-        'promise'
-    ].includes(options.bodyType)) {
-        throw new Error('[s3-object-response] bodyType is invalid');
-    }
-    if (options.httpsCapture) {
-        https = options.httpsCapture(options.__https);
-    }
-    let client;
-    if ((0, _util.canPrefetch)(options)) {
-        client = (0, _util.createPrefetchClient)(options);
-    }
-    const s3ObjectResponseMiddlewareBefore = async (request)=>{
-        const { inputS3Url, outputRoute, outputToken } = request.event.getObjectContext;
-        request.internal.s3ObjectResponse = {
-            RequestRoute: outputRoute,
-            RequestToken: outputToken
-        };
-        const parsedInputS3Url = new _url.URL(inputS3Url);
-        const fetchOptions = {
-            method: 'GET',
-            host: parsedInputS3Url.hostname,
-            path: parsedInputS3Url.pathname
-        };
-        request.context.s3Object = fetchType(options.bodyType, fetchOptions);
-    };
-    const s3ObjectResponseMiddlewareAfter = async (request)=>{
-        if (!client) {
-            client = await (0, _util.createClient)(options, request);
-        }
-        request.response.Body ??= request.response.body;
-        delete request.response.body;
-        await client.send(new _clients3.WriteGetObjectResponseCommand({
-            ...request.internal.s3ObjectResponse,
-            ...request.response
-        }));
-        return {
-            statusCode: 200
-        };
-    };
-    return {
-        before: s3ObjectResponseMiddlewareBefore,
-        after: s3ObjectResponseMiddlewareAfter
-    };
-};
-const fetchType = (type, fetchOptions)=>{
-    if (type === 'stream') {
-        return fetchStream(fetchOptions);
-    } else if (type === 'promise') {
-        return fetchPromise(fetchOptions);
-    }
-};
-const fetchStream = (fetchOptions)=>{
-    return https.request(fetchOptions);
-};
-const fetchPromise = (fetchOptions)=>{
-    return new Promise((resolve, reject)=>{
-        let data = '';
-        const stream = fetchStream(fetchOptions);
-        stream.on('data', (chunk)=>{
-            data += chunk;
-        });
-        stream.on('end', ()=>resolve(data));
-        stream.on('error', (error)=>reject(error));
-    });
-};
-const _default = s3ObjectResponseMiddleware;
-