@aws-sdk/middleware-sdk-s3 3.425.0 → 3.428.0

package/dist-cjs/index.js

@@ -2,6 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./check-content-length-header"), exports);
+tslib_1.__exportStar(require("./region-redirect-endpoint-middleware"), exports);
+tslib_1.__exportStar(require("./region-redirect-middleware"), exports);
 tslib_1.__exportStar(require("./s3Configuration"), exports);
 tslib_1.__exportStar(require("./throw-200-exceptions"), exports);
 tslib_1.__exportStar(require("./validate-bucket-name"), exports);

package/dist-cjs/region-redirect-endpoint-middleware.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.regionRedirectEndpointMiddlewareOptions = exports.regionRedirectEndpointMiddleware = void 0;
+const regionRedirectEndpointMiddleware = (config) => {
+    return (next, context) => async (args) => {
+        const originalRegion = await config.region();
+        const regionProviderRef = config.region;
+        if (context.__s3RegionRedirect) {
+            config.region = async () => {
+                config.region = regionProviderRef;
+                return context.__s3RegionRedirect;
+            };
+        }
+        const result = await next(args);
+        if (context.__s3RegionRedirect) {
+            const region = await config.region();
+            if (originalRegion !== region) {
+                throw new Error("Region was not restored following S3 region redirect.");
+            }
+        }
+        return result;
+    };
+};
+exports.regionRedirectEndpointMiddleware = regionRedirectEndpointMiddleware;
+exports.regionRedirectEndpointMiddlewareOptions = {
+    tags: ["REGION_REDIRECT", "S3"],
+    name: "regionRedirectEndpointMiddleware",
+    override: true,
+    relation: "before",
+    toMiddleware: "endpointV2Middleware",
+};

package/dist-cjs/region-redirect-middleware.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRegionRedirectMiddlewarePlugin = exports.regionRedirectMiddlewareOptions = exports.regionRedirectMiddleware = void 0;
+const region_redirect_endpoint_middleware_1 = require("./region-redirect-endpoint-middleware");
+function regionRedirectMiddleware(clientConfig) {
+    return (next, context) => async (args) => {
+        var _a;
+        try {
+            return await next(args);
+        }
+        catch (err) {
+            if (clientConfig.followRegionRedirects &&
+                err.name === "PermanentRedirect" &&
+                err.$metadata.httpStatusCode === 301) {
+                try {
+                    const actualRegion = err.$response.headers["x-amz-bucket-region"];
+                    (_a = context.logger) === null || _a === void 0 ? void 0 : _a.debug(`Redirecting from ${await clientConfig.region()} to ${actualRegion}`);
+                    context.__s3RegionRedirect = actualRegion;
+                }
+                catch (e) {
+                    throw new Error("Region redirect failed: " + e);
+                }
+                return next(args);
+            }
+            else {
+                throw err;
+            }
+        }
+    };
+}
+exports.regionRedirectMiddleware = regionRedirectMiddleware;
+exports.regionRedirectMiddlewareOptions = {
+    step: "initialize",
+    tags: ["REGION_REDIRECT", "S3"],
+    name: "regionRedirectMiddleware",
+    override: true,
+};
+const getRegionRedirectMiddlewarePlugin = (clientConfig) => ({
+    applyToStack: (clientStack) => {
+        clientStack.add(regionRedirectMiddleware(clientConfig), exports.regionRedirectMiddlewareOptions);
+        clientStack.addRelativeTo((0, region_redirect_endpoint_middleware_1.regionRedirectEndpointMiddleware)(clientConfig), region_redirect_endpoint_middleware_1.regionRedirectEndpointMiddlewareOptions);
+    },
+});
+exports.getRegionRedirectMiddlewarePlugin = getRegionRedirectMiddlewarePlugin;

package/dist-cjs/s3Configuration.js

@@ -2,12 +2,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.resolveS3Config = void 0;
 const resolveS3Config = (input) => {
-    var _a, _b, _c;
+    var _a, _b, _c, _d;
     return ({
         ...input,
         forcePathStyle: (_a = input.forcePathStyle) !== null && _a !== void 0 ? _a : false,
         useAccelerateEndpoint: (_b = input.useAccelerateEndpoint) !== null && _b !== void 0 ? _b : false,
         disableMultiregionAccessPoints: (_c = input.disableMultiregionAccessPoints) !== null && _c !== void 0 ? _c : false,
+        followRegionRedirects: (_d = input.followRegionRedirects) !== null && _d !== void 0 ? _d : false,
     });
 };
 exports.resolveS3Config = resolveS3Config;

package/dist-es/index.js

@@ -1,4 +1,6 @@
 export * from "./check-content-length-header";
+export * from "./region-redirect-endpoint-middleware";
+export * from "./region-redirect-middleware";
 export * from "./s3Configuration";
 export * from "./throw-200-exceptions";
 export * from "./validate-bucket-name";

package/dist-es/region-redirect-endpoint-middleware.js

@@ -0,0 +1,27 @@
+export const regionRedirectEndpointMiddleware = (config) => {
+    return (next, context) => async (args) => {
+        const originalRegion = await config.region();
+        const regionProviderRef = config.region;
+        if (context.__s3RegionRedirect) {
+            config.region = async () => {
+                config.region = regionProviderRef;
+                return context.__s3RegionRedirect;
+            };
+        }
+        const result = await next(args);
+        if (context.__s3RegionRedirect) {
+            const region = await config.region();
+            if (originalRegion !== region) {
+                throw new Error("Region was not restored following S3 region redirect.");
+            }
+        }
+        return result;
+    };
+};
+export const regionRedirectEndpointMiddlewareOptions = {
+    tags: ["REGION_REDIRECT", "S3"],
+    name: "regionRedirectEndpointMiddleware",
+    override: true,
+    relation: "before",
+    toMiddleware: "endpointV2Middleware",
+};

package/dist-es/region-redirect-middleware.js

@@ -0,0 +1,38 @@
+import { regionRedirectEndpointMiddleware, regionRedirectEndpointMiddlewareOptions, } from "./region-redirect-endpoint-middleware";
+export function regionRedirectMiddleware(clientConfig) {
+    return (next, context) => async (args) => {
+        try {
+            return await next(args);
+        }
+        catch (err) {
+            if (clientConfig.followRegionRedirects &&
+                err.name === "PermanentRedirect" &&
+                err.$metadata.httpStatusCode === 301) {
+                try {
+                    const actualRegion = err.$response.headers["x-amz-bucket-region"];
+                    context.logger?.debug(`Redirecting from ${await clientConfig.region()} to ${actualRegion}`);
+                    context.__s3RegionRedirect = actualRegion;
+                }
+                catch (e) {
+                    throw new Error("Region redirect failed: " + e);
+                }
+                return next(args);
+            }
+            else {
+                throw err;
+            }
+        }
+    };
+}
+export const regionRedirectMiddlewareOptions = {
+    step: "initialize",
+    tags: ["REGION_REDIRECT", "S3"],
+    name: "regionRedirectMiddleware",
+    override: true,
+};
+export const getRegionRedirectMiddlewarePlugin = (clientConfig) => ({
+    applyToStack: (clientStack) => {
+        clientStack.add(regionRedirectMiddleware(clientConfig), regionRedirectMiddlewareOptions);
+        clientStack.addRelativeTo(regionRedirectEndpointMiddleware(clientConfig), regionRedirectEndpointMiddlewareOptions);
+    },
+});

package/dist-es/s3Configuration.js

@@ -3,4 +3,5 @@ export const resolveS3Config = (input) => ({
     forcePathStyle: input.forcePathStyle ?? false,
     useAccelerateEndpoint: input.useAccelerateEndpoint ?? false,
     disableMultiregionAccessPoints: input.disableMultiregionAccessPoints ?? false,
+    followRegionRedirects: input.followRegionRedirects ?? false,
 });

package/dist-types/index.d.ts

@@ -1,4 +1,6 @@
 export * from "./check-content-length-header";
+export * from "./region-redirect-endpoint-middleware";
+export * from "./region-redirect-middleware";
 export * from "./s3Configuration";
 export * from "./throw-200-exceptions";
 export * from "./validate-bucket-name";

package/dist-types/region-redirect-endpoint-middleware.d.ts

@@ -0,0 +1,10 @@
+import { RelativeMiddlewareOptions, SerializeMiddleware } from "@smithy/types";
+import { PreviouslyResolved } from "./region-redirect-middleware";
+/**
+ * @internal
+ */
+export declare const regionRedirectEndpointMiddleware: (config: PreviouslyResolved) => SerializeMiddleware<any, any>;
+/**
+ * @internal
+ */
+export declare const regionRedirectEndpointMiddlewareOptions: RelativeMiddlewareOptions;

package/dist-types/region-redirect-middleware.d.ts

@@ -0,0 +1,20 @@
+import { InitializeHandlerOptions, InitializeMiddleware, Pluggable, Provider } from "@smithy/types";
+/**
+ * @internal
+ */
+export interface PreviouslyResolved {
+    region: Provider<string>;
+    followRegionRedirects: boolean;
+}
+/**
+ * @internal
+ */
+export declare function regionRedirectMiddleware(clientConfig: PreviouslyResolved): InitializeMiddleware<any, any>;
+/**
+ * @internal
+ */
+export declare const regionRedirectMiddlewareOptions: InitializeHandlerOptions;
+/**
+ * @internal
+ */
+export declare const getRegionRedirectMiddlewarePlugin: (clientConfig: PreviouslyResolved) => Pluggable<any, any>;

package/dist-types/s3Configuration.d.ts

@@ -17,10 +17,18 @@ export interface S3InputConfig {
      * Whether multi-region access points (MRAP) should be disabled.
      */
     disableMultiregionAccessPoints?: boolean;
+    /**
+     * This feature was previously called the S3 Global Client.
+     * This can result in additional latency as failed requests are retried
+     * with a corrected region when receiving a permanent redirect error with status 301.
+     * This feature should only be used as a last resort if you do not know the region of your bucket(s) ahead of time.
+     */
+    followRegionRedirects?: boolean;
 }
 export interface S3ResolvedConfig {
     forcePathStyle: boolean;
     useAccelerateEndpoint: boolean;
     disableMultiregionAccessPoints: boolean;
+    followRegionRedirects: boolean;
 }
 export declare const resolveS3Config: <T>(input: T & S3InputConfig) => T & S3ResolvedConfig;

package/dist-types/ts3.4/index.d.ts

@@ -1,4 +1,6 @@
 export * from "./check-content-length-header";
+export * from "./region-redirect-endpoint-middleware";
+export * from "./region-redirect-middleware";
 export * from "./s3Configuration";
 export * from "./throw-200-exceptions";
 export * from "./validate-bucket-name";

package/dist-types/ts3.4/region-redirect-endpoint-middleware.d.ts

@@ -0,0 +1,6 @@
+import { RelativeMiddlewareOptions, SerializeMiddleware } from "@smithy/types";
+import { PreviouslyResolved } from "./region-redirect-middleware";
+export declare const regionRedirectEndpointMiddleware: (
+  config: PreviouslyResolved
+) => SerializeMiddleware<any, any>;
+export declare const regionRedirectEndpointMiddlewareOptions: RelativeMiddlewareOptions;

package/dist-types/ts3.4/region-redirect-middleware.d.ts

@@ -0,0 +1,17 @@
+import {
+  InitializeHandlerOptions,
+  InitializeMiddleware,
+  Pluggable,
+  Provider,
+} from "@smithy/types";
+export interface PreviouslyResolved {
+  region: Provider<string>;
+  followRegionRedirects: boolean;
+}
+export declare function regionRedirectMiddleware(
+  clientConfig: PreviouslyResolved
+): InitializeMiddleware<any, any>;
+export declare const regionRedirectMiddlewareOptions: InitializeHandlerOptions;
+export declare const getRegionRedirectMiddlewarePlugin: (
+  clientConfig: PreviouslyResolved
+) => Pluggable<any, any>;

package/dist-types/ts3.4/s3Configuration.d.ts

@@ -2,11 +2,13 @@ export interface S3InputConfig {
   forcePathStyle?: boolean;
   useAccelerateEndpoint?: boolean;
   disableMultiregionAccessPoints?: boolean;
+  followRegionRedirects?: boolean;
 }
 export interface S3ResolvedConfig {
   forcePathStyle: boolean;
   useAccelerateEndpoint: boolean;
   disableMultiregionAccessPoints: boolean;
+  followRegionRedirects: boolean;
 }
 export declare const resolveS3Config: <T>(
   input: T & S3InputConfig

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-sdk/middleware-sdk-s3",
-  "version": "3.425.0",
+  "version": "3.428.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -11,6 +11,7 @@
     "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo",
     "test": "jest",
     "test:integration": "jest -c jest.config.integ.js",
+    "test:e2e": "jest -c jest.config.e2e.js",
     "extract:docs": "api-extractor run --local"
   },
   "main": "./dist-cjs/index.js",
@@ -22,11 +23,11 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@aws-sdk/types": "3.425.0",
+    "@aws-sdk/types": "3.428.0",
     "@aws-sdk/util-arn-parser": "3.310.0",
-    "@smithy/protocol-http": "^3.0.6",
-    "@smithy/smithy-client": "^2.1.9",
-    "@smithy/types": "^2.3.4",
+    "@smithy/protocol-http": "^3.0.7",
+    "@smithy/smithy-client": "^2.1.11",
+    "@smithy/types": "^2.3.5",
     "tslib": "^2.5.0"
   },
   "devDependencies": {