@aws-amplify/core 5.5.3-api-v6.2 → 5.5.3-api-v6.23

package/lib-esm/AwsClients/Pinpoint/putEvents.d.ts

@@ -4,10 +4,20 @@ export type { PutEventsInput, PutEventsOutput };
 /**
  * @internal
  */
-export declare const putEvents: (config: Omit<import("../../clients/middleware/userAgent").UserAgentOptions & import("../../clients/middleware/retry").RetryOptions<HttpResponse> & import("../../clients/middleware/signing").SigningOptions & import("../../clients/types").ServiceClientOptions, "retryDecider" | "computeDelay" | "userAgentValue" | "service" | "endpointResolver"> & {
-    retryDecider?: (response?: HttpResponse, error?: unknown) => Promise<boolean>;
+export declare const putEvents: (config: Omit<import("../../clients").UserAgentOptions & import("../../clients").RetryOptions<HttpResponse> & import("../../clients").SigningOptions & import("../../clients/types").ServiceClientOptions & {
+    service: string;
+    endpointResolver: ({ region }: import("../../clients/types").EndpointResolverOptions) => {
+        url: URL;
+    };
+    retryDecider: (response?: HttpResponse, error?: Error) => Promise<boolean>;
+    computeDelay: (attempt: number) => number;
+    userAgentValue: string;
+}, "retryDecider" | "computeDelay" | "userAgentValue" | "service" | "endpointResolver"> & {
+    retryDecider?: ((response?: HttpResponse, error?: unknown) => Promise<boolean>) & ((response?: HttpResponse, error?: Error) => Promise<boolean>);
     computeDelay?: (attempt: number) => number;
     userAgentValue?: string;
     service?: string;
-    endpointResolver?: (options: import("../../clients/types").EndpointResolverOptions) => Endpoint;
+    endpointResolver?: ((options: import("../../clients/types").EndpointResolverOptions, input?: any) => Endpoint) & (({ region }: import("../../clients/types").EndpointResolverOptions) => {
+        url: URL;
+    });
 }, input: PutEventsInput) => Promise<PutEventsOutput>;

package/lib-esm/AwsClients/Pinpoint/updateEndpoint.d.ts

@@ -4,10 +4,20 @@ export type { UpdateEndpointInput, UpdateEndpointOutput };
 /**
  * @internal
  */
-export declare const updateEndpoint: (config: Omit<import("../../clients/middleware/userAgent").UserAgentOptions & import("../../clients/middleware/retry").RetryOptions<HttpResponse> & import("../../clients/middleware/signing").SigningOptions & import("../../clients/types").ServiceClientOptions, "retryDecider" | "computeDelay" | "userAgentValue" | "service" | "endpointResolver"> & {
-    retryDecider?: (response?: HttpResponse, error?: unknown) => Promise<boolean>;
+export declare const updateEndpoint: (config: Omit<import("../../clients").UserAgentOptions & import("../../clients").RetryOptions<HttpResponse> & import("../../clients").SigningOptions & import("../../clients/types").ServiceClientOptions & {
+    service: string;
+    endpointResolver: ({ region }: import("../../clients/types").EndpointResolverOptions) => {
+        url: URL;
+    };
+    retryDecider: (response?: HttpResponse, error?: Error) => Promise<boolean>;
+    computeDelay: (attempt: number) => number;
+    userAgentValue: string;
+}, "retryDecider" | "computeDelay" | "userAgentValue" | "service" | "endpointResolver"> & {
+    retryDecider?: ((response?: HttpResponse, error?: unknown) => Promise<boolean>) & ((response?: HttpResponse, error?: Error) => Promise<boolean>);
     computeDelay?: (attempt: number) => number;
     userAgentValue?: string;
     service?: string;
-    endpointResolver?: (options: import("../../clients/types").EndpointResolverOptions) => Endpoint;
+    endpointResolver?: ((options: import("../../clients/types").EndpointResolverOptions, input?: any) => Endpoint) & (({ region }: import("../../clients/types").EndpointResolverOptions) => {
+        url: URL;
+    });
 }, input: UpdateEndpointInput) => Promise<UpdateEndpointOutput>;

package/lib-esm/Credentials.js

@@ -45,6 +45,8 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 import { ConsoleLogger as Logger } from './Logger';
 import { StorageHelper } from './StorageHelper';
 import { makeQuerablePromise } from './JS';

package/lib-esm/Platform/index.d.ts

@@ -1,5 +1,5 @@
 import { CustomUserAgentDetails, Framework } from './types';
-import { UserAgent as AWSUserAgent } from '@aws-sdk/types';
+import type { UserAgent as AWSUserAgent } from '@aws-sdk/types';
 declare class PlatformBuilder {
     userAgent: string;
     get framework(): Framework;
@@ -7,6 +7,6 @@ declare class PlatformBuilder {
     observeFrameworkChanges(fcn: () => void): void;
 }
 export declare const Platform: PlatformBuilder;
-export declare const getAmplifyUserAgentObject: ({ category, action, framework, }?: CustomUserAgentDetails) => AWSUserAgent;
+export declare const getAmplifyUserAgentObject: ({ category, action, framework, additionalInfo, }?: CustomUserAgentDetails) => AWSUserAgent;
 export declare const getAmplifyUserAgent: (customUserAgentDetails?: CustomUserAgentDetails) => string;
 export {};

package/lib-esm/Platform/index.js

@@ -46,12 +46,15 @@ var PlatformBuilder = /** @class */ (function () {
 }());
 export var Platform = new PlatformBuilder();
 export var getAmplifyUserAgentObject = function (_a) {
-    var _b = _a === void 0 ? {} : _a, category = _b.category, action = _b.action, framework = _b.framework;
+    var _b = _a === void 0 ? {} : _a, category = _b.category, action = _b.action, framework = _b.framework, additionalInfo = _b.additionalInfo;
     var userAgent = [[BASE_USER_AGENT, version]];
     if (category) {
         userAgent.push([category, action]);
     }
-    userAgent.push(['framework', detectFramework()]);
+    userAgent.push(['framework', framework || detectFramework()]);
+    if (additionalInfo) {
+        userAgent = userAgent.concat(additionalInfo);
+    }
     return userAgent;
 };
 export var getAmplifyUserAgent = function (customUserAgentDetails) {

package/lib-esm/Platform/types.d.ts

@@ -1,3 +1,4 @@
+import type { UserAgent as AWSUserAgent } from '@aws-sdk/types';
 export declare enum Framework {
     WebUnknown = "0",
     React = "1",
@@ -96,6 +97,9 @@ type UserAgentDetailsWithCategory<T extends Category> = CustomUserAgentDetailsBa
 };
 type CustomUserAgentDetailsBase = {
     framework?: Framework;
+    /** Accepts an array of arrays with exactly 1 or 2 values and translates
+    those arrays to "item" or "item1/item2" strings on the custom user agent */
+    additionalInfo?: AWSUserAgent;
 };
 export type CustomUserAgentDetails = (CustomUserAgentDetailsBase & {
     category?: never;

package/lib-esm/Platform/types.js

@@ -1,5 +1,3 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
 export var Framework;
 (function (Framework) {
     // < 100 - Web frameworks

package/lib-esm/Platform/version.d.ts

@@ -1 +1 @@
-export declare const version = "5.3.4-api-v6.2+366313460";
+export declare const version = "5.3.4-api-v6.23+6a0182db2";

package/lib-esm/Platform/version.js

@@ -1,2 +1,2 @@
 // generated by genversion
-export var version = '5.3.4-api-v6.2+366313460';
+export var version = '5.3.4-api-v6.23+6a0182db2';

package/lib-esm/Providers/index.js

@@ -1 +1,3 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 export { AWSCloudWatchProvider } from './AWSCloudWatchProvider';

package/lib-esm/ServiceWorker/ServiceWorker.js

@@ -1,3 +1,5 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 /**
  * Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
  *

package/lib-esm/ServiceWorker/index.js

@@ -1,3 +1,5 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 /**
  * Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
  *

package/lib-esm/UniversalStorage/index.js

@@ -9,6 +9,8 @@ var __assign = (this && this.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 import Cookies from 'universal-cookie';
 import { browserOrNode } from '../JS';
 var isBrowser = browserOrNode().isBrowser;

package/lib-esm/Util/BackgroundProcessManager.js

@@ -60,6 +60,8 @@ var __values = (this && this.__values) || function(o) {
     };
     throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
 };
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 /**
  * @private For internal Amplify use.
  *

package/lib-esm/Util/DateUtils.js

@@ -1,3 +1,5 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 /**
  * Date & time utility functions to abstract the `aws-sdk` away from users.
  * (v2 => v3 modularization is a breaking change)

package/lib-esm/Util/Mutex.js

@@ -1,3 +1,5 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 /*!
  * The MIT License (MIT)
  *

package/lib-esm/Util/Reachability.js

@@ -9,6 +9,8 @@ var __values = (this && this.__values) || function(o) {
     };
     throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
 };
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 import { browserOrNode, isWebWorker } from '@aws-amplify/core';
 import Observable from 'zen-observable-ts';
 var ReachabilityNavigator = /** @class */ (function () {

package/lib-esm/Util/Reachability.native.js

@@ -1,3 +1,5 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 import Observable from 'zen-observable-ts';
 import { ConsoleLogger as Logger } from '../Logger';
 var logger = new Logger('Reachability', 'DEBUG');

package/lib-esm/Util/StringUtils.js

@@ -1,3 +1,5 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 export function urlSafeEncode(str) {
     return str
         .split('')

package/lib-esm/Util/index.js

@@ -1,3 +1,5 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
 export { NonRetryableError, isNonRetryableError, jitteredBackoff, jitteredExponentialRetry, retry, } from './Retry';
 export { default as Mutex } from './Mutex';
 export { default as Reachability } from './Reachability';

package/lib-esm/clients/handlers/fetch.js

@@ -48,6 +48,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 import 'isomorphic-unfetch'; // TODO: remove this dependency in v6
+import { withMemoization } from '../utils/memoization';
 var shouldSendBody = function (method) {
     return !['HEAD', 'GET', 'DELETE'].includes(method.toUpperCase());
 };
@@ -99,21 +100,3 @@ export var fetchTransferHandler = function (_a, _b) {
         });
     });
 };
-/**
- * Cache the payload of a response body. It allows multiple calls to the body,
- * for example, when reading the body in both retry decider and error deserializer.
- * Caching body is allowed here because we call the body accessor(blob(), json(),
- * etc.) when body is small or streaming implementation is not available(RN).
- */
-var withMemoization = function (payloadAccessor) {
-    var cached;
-    return function () {
-        if (!cached) {
-            // Explicitly not awaiting. Intermediate await would add overhead and
-            // introduce a possible race in the event that this wrapper is called
-            // again before the first `payloadAccessor` call resolves.
-            cached = payloadAccessor();
-        }
-        return cached;
-    };
-};

package/lib-esm/clients/index.d.ts

@@ -2,7 +2,12 @@ export { getDnsSuffix } from './endpoints';
 export { fetchTransferHandler } from './handlers/fetch';
 export { unauthenticatedHandler } from './handlers/unauthenticated';
 export { authenticatedHandler } from './handlers/authenticated';
-export { composeServiceApi } from './internal/composeServiceApi';
-export { signRequest, presignUrl, } from './middleware/signing/signer/signatureV4';
+export { getHashedPayload, presignUrl, PresignUrlOptions, signRequest, SignRequestOptions, } from './middleware/signing/signer/signatureV4';
+export { EMPTY_HASH as EMPTY_SHA256_HASH } from './middleware/signing/signer/signatureV4/constants';
+export { extendedEncodeURIComponent } from './middleware/signing/utils/extendedEncodeURIComponent';
+export { signingMiddleware, SigningOptions } from './middleware/signing';
+export { getRetryDecider, jitteredBackoff, retryMiddleware, RetryOptions, } from './middleware/retry';
+export { userAgentMiddleware, UserAgentOptions } from './middleware/userAgent';
 export { parseJsonBody, parseJsonError, parseMetadata } from './serde';
+export { withMemoization } from './utils/memoization';
 export * from './types';

package/lib-esm/clients/index.js

@@ -4,7 +4,12 @@ export { getDnsSuffix } from './endpoints';
 export { fetchTransferHandler } from './handlers/fetch';
 export { unauthenticatedHandler } from './handlers/unauthenticated';
 export { authenticatedHandler } from './handlers/authenticated';
-export { composeServiceApi } from './internal/composeServiceApi';
-export { signRequest, presignUrl, } from './middleware/signing/signer/signatureV4';
+export { getHashedPayload, presignUrl, signRequest, } from './middleware/signing/signer/signatureV4';
+export { EMPTY_HASH as EMPTY_SHA256_HASH } from './middleware/signing/signer/signatureV4/constants';
+export { extendedEncodeURIComponent } from './middleware/signing/utils/extendedEncodeURIComponent';
+export { signingMiddleware } from './middleware/signing';
+export { getRetryDecider, jitteredBackoff, retryMiddleware, } from './middleware/retry';
+export { userAgentMiddleware } from './middleware/userAgent';
 export { parseJsonBody, parseJsonError, parseMetadata } from './serde';
+export { withMemoization } from './utils/memoization';
 export * from './types';

package/lib-esm/clients/internal/composeServiceApi.d.ts

@@ -1,7 +1,7 @@
 import { ServiceClientOptions } from '../types/aws';
 import { TransferHandler, Endpoint } from '../types/core';
 import { HttpRequest, HttpResponse } from '../types/http';
-export declare const composeServiceApi: <TransferHandlerOptions, Input, Output, DefaultConfig extends Partial<TransferHandlerOptions & ServiceClientOptions>>(transferHandler: TransferHandler<HttpRequest, HttpResponse, TransferHandlerOptions>, serializer: (input: Input, endpoint: Endpoint) => HttpRequest, deserializer: (output: HttpResponse) => Promise<Output>, defaultConfig: DefaultConfig) => (config: OptionalizeKey<TransferHandlerOptions & ServiceClientOptions, keyof DefaultConfig>, input: Input) => Promise<Output>;
+export declare const composeServiceApi: <TransferHandlerOptions, Input, Output, DefaultConfig extends Partial<TransferHandlerOptions & ServiceClientOptions>>(transferHandler: TransferHandler<HttpRequest, HttpResponse, TransferHandlerOptions>, serializer: (input: Input, endpoint: Endpoint) => Promise<HttpRequest> | HttpRequest, deserializer: (output: HttpResponse) => Promise<Output>, defaultConfig: DefaultConfig) => (config: OptionalizeKey<TransferHandlerOptions & ServiceClientOptions & DefaultConfig, keyof DefaultConfig>, input: Input) => Promise<Output>;
 type OptionalizeKey<T, K> = Omit<T, K & keyof T> & {
     [P in K & keyof T]?: T[P];
 };

package/lib-esm/clients/internal/composeServiceApi.js

@@ -54,17 +54,17 @@ export var composeServiceApi = function (transferHandler, serializer, deserializ
             switch (_a.label) {
                 case 0:
                     resolvedConfig = __assign(__assign({}, defaultConfig), config);
-                    return [4 /*yield*/, resolvedConfig.endpointResolver({
-                            region: resolvedConfig.region,
-                        })];
+                    return [4 /*yield*/, resolvedConfig.endpointResolver(resolvedConfig, input)];
                 case 1:
                     endpoint = _a.sent();
-                    request = serializer(input, endpoint);
-                    return [4 /*yield*/, transferHandler(request, __assign({}, resolvedConfig))];
+                    return [4 /*yield*/, serializer(input, endpoint)];
                 case 2:
+                    request = _a.sent();
+                    return [4 /*yield*/, transferHandler(request, __assign({}, resolvedConfig))];
+                case 3:
                     response = _a.sent();
                     return [4 /*yield*/, deserializer(response)];
-                case 3: return [2 /*return*/, _a.sent()];
+                case 4: return [2 /*return*/, _a.sent()];
             }
         });
     }); };

package/lib-esm/clients/internal/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This index should NOT be included in the ../index.ts because the composer functions
+ * here requires TypeScript >= 4. Given other scoped packages may use TypeScript < 4,
+ * they should not be exposed to upper level index.
+ */
+export { composeServiceApi } from './composeServiceApi';
+export { composeTransferHandler } from './composeTransferHandler';

package/lib-esm/clients/internal/index.js

@@ -0,0 +1,9 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+/**
+ * This index should NOT be included in the ../index.ts because the composer functions
+ * here requires TypeScript >= 4. Given other scoped packages may use TypeScript < 4,
+ * they should not be exposed to upper level index.
+ */
+export { composeServiceApi } from './composeServiceApi';
+export { composeTransferHandler } from './composeTransferHandler';

package/lib-esm/clients/middleware/retry/middleware.d.ts

@@ -1,4 +1,3 @@
-import { MetadataBearer } from '@aws-sdk/types';
 import { MiddlewareContext, MiddlewareHandler, Request, Response } from '../../types/core';
 /**
  * Configuration of the retry middleware
@@ -32,9 +31,3 @@ export interface RetryOptions<TResponse = Response> {
  * Retry middleware
  */
 export declare const retryMiddleware: <TInput = Request, TOutput = Response>({ maxAttempts, retryDecider, computeDelay, abortSignal, }: RetryOptions<TOutput>) => (next: MiddlewareHandler<TInput, TOutput>, context: MiddlewareContext) => (request: TInput) => Promise<TOutput>;
-/**
- * Check if the response is a contains `$metadata` property.
- *
- * @internal Amplify internal use only
- */
-export declare const isMetadataBearer: (response: unknown) => response is MetadataBearer;

package/lib-esm/clients/middleware/retry/middleware.js

@@ -1,5 +1,16 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -49,26 +60,36 @@ export var retryMiddleware = function (_a) {
         return function retryMiddleware(request) {
             var _a;
             return __awaiter(this, void 0, void 0, function () {
-                var error, attemptsCount, response, e_1, delay;
+                var error, attemptsCount, response, handleTerminalErrorOrResponse, e_1, delay;
                 return __generator(this, function (_b) {
                     switch (_b.label) {
                         case 0:
                             attemptsCount = (_a = context.attemptsCount) !== null && _a !== void 0 ? _a : 0;
+                            handleTerminalErrorOrResponse = function () {
+                                if (response) {
+                                    addOrIncrementMetadataAttempts(response, attemptsCount);
+                                    return response;
+                                }
+                                else {
+                                    addOrIncrementMetadataAttempts(error, attemptsCount);
+                                    throw error;
+                                }
+                            };
                             _b.label = 1;
                         case 1:
                             if (!(!(abortSignal === null || abortSignal === void 0 ? void 0 : abortSignal.aborted) && attemptsCount < maxAttempts)) return [3 /*break*/, 11];
-                            error = undefined;
-                            response = undefined;
                             _b.label = 2;
                         case 2:
                             _b.trys.push([2, 4, , 5]);
                             return [4 /*yield*/, next(request)];
                         case 3:
                             response = _b.sent();
+                            error = undefined;
                             return [3 /*break*/, 5];
                         case 4:
                             e_1 = _b.sent();
                             error = e_1;
+                            response = undefined;
                             return [3 /*break*/, 5];
                         case 5:
                             // context.attemptsCount may be updated after calling next handler which may retry the request by itself.
@@ -87,20 +108,16 @@ export var retryMiddleware = function (_a) {
                             _b.sent();
                             _b.label = 8;
                         case 8: return [3 /*break*/, 1];
-                        case 9:
-                            if (response) {
-                                updateMetadataAttempts(response, attemptsCount);
-                                return [2 /*return*/, response];
+                        case 9: return [2 /*return*/, handleTerminalErrorOrResponse()];
+                        case 10: return [3 /*break*/, 1];
+                        case 11:
+                            if (abortSignal === null || abortSignal === void 0 ? void 0 : abortSignal.aborted) {
+                                throw new Error('Request aborted.');
                             }
                             else {
-                                updateMetadataAttempts(error, attemptsCount);
-                                throw error;
+                                return [2 /*return*/, handleTerminalErrorOrResponse()];
                             }
-                            _b.label = 10;
-                        case 10: return [3 /*break*/, 1];
-                        case 11: throw (abortSignal === null || abortSignal === void 0 ? void 0 : abortSignal.aborted)
-                            ? new Error('Request aborted')
-                            : error !== null && error !== void 0 ? error : new Error('Retry attempts exhausted');
+                            return [2 /*return*/];
                     }
                 });
             });
@@ -124,15 +141,10 @@ var cancellableSleep = function (timeoutMs, abortSignal) {
     });
     return sleepPromise;
 };
-/**
- * Check if the response is a contains `$metadata` property.
- *
- * @internal Amplify internal use only
- */
-export var isMetadataBearer = function (response) { return typeof (response === null || response === void 0 ? void 0 : response['$metadata']) === 'object'; };
-var updateMetadataAttempts = function (nextHandlerOutput, attempts) {
-    if (isMetadataBearer(nextHandlerOutput)) {
-        nextHandlerOutput.$metadata.attempts = attempts;
+var addOrIncrementMetadataAttempts = function (nextHandlerOutput, attempts) {
+    var _a;
+    if (Object.prototype.toString.call(nextHandlerOutput) !== '[object Object]') {
+        return;
     }
-    nextHandlerOutput['$metadata'] = { attempts: attempts };
+    nextHandlerOutput['$metadata'] = __assign(__assign({}, ((_a = nextHandlerOutput['$metadata']) !== null && _a !== void 0 ? _a : {})), { attempts: attempts });
 };

package/lib-esm/clients/middleware/signing/middleware.d.ts

@@ -3,12 +3,19 @@ import { Credentials, HttpRequest, HttpResponse, MiddlewareHandler } from '../..
  * Configuration of the signing middleware
  */
 export interface SigningOptions {
-    credentials: Credentials;
+    credentials: Credentials | (() => Promise<Credentials>);
     region: string;
     service: string;
+    /**
+     * Whether to uri encode the path as part of canonical uri. It's used for S3 only where the pathname
+     * is already uri encoded, and the signing process is not expected to uri encode it again.
+     *
+     * @default true
+     */
+    uriEscapePath?: boolean;
 }
 /**
  * Middleware that SigV4 signs request with AWS credentials, and correct system clock offset.
  * This middleware is expected to be placed after retry middleware.
  */
-export declare const signingMiddleware: ({ credentials, region, service, }: SigningOptions) => (next: MiddlewareHandler<HttpRequest, HttpResponse>) => (request: HttpRequest) => Promise<HttpResponse>;
+export declare const signingMiddleware: ({ credentials, region, service, uriEscapePath, }: SigningOptions) => (next: MiddlewareHandler<HttpRequest, HttpResponse>) => (request: HttpRequest) => Promise<HttpResponse>;

package/lib-esm/clients/middleware/signing/middleware.js

@@ -44,28 +44,39 @@ import { getUpdatedSystemClockOffset } from './utils/getUpdatedSystemClockOffset
  * This middleware is expected to be placed after retry middleware.
  */
 export var signingMiddleware = function (_a) {
-    var credentials = _a.credentials, region = _a.region, service = _a.service;
+    var credentials = _a.credentials, region = _a.region, service = _a.service, _b = _a.uriEscapePath, uriEscapePath = _b === void 0 ? true : _b;
     var currentSystemClockOffset;
     return function (next) {
         return function signingMiddleware(request) {
             return __awaiter(this, void 0, void 0, function () {
-                var signRequestOptions, signedRequest, response, dateString;
-                return __generator(this, function (_a) {
-                    switch (_a.label) {
+                var signRequestOptions, _a, signedRequest, response, dateString;
+                var _b;
+                return __generator(this, function (_c) {
+                    switch (_c.label) {
                         case 0:
                             currentSystemClockOffset = currentSystemClockOffset !== null && currentSystemClockOffset !== void 0 ? currentSystemClockOffset : 0;
-                            signRequestOptions = {
-                                credentials: credentials,
-                                signingDate: getSkewCorrectedDate(currentSystemClockOffset),
-                                signingRegion: region,
-                                signingService: service,
-                            };
-                            return [4 /*yield*/, signRequest(request, signRequestOptions)];
+                            _b = {};
+                            if (!(typeof credentials === 'function')) return [3 /*break*/, 2];
+                            return [4 /*yield*/, credentials()];
                         case 1:
-                            signedRequest = _a.sent();
-                            return [4 /*yield*/, next(signedRequest)];
+                            _a = _c.sent();
+                            return [3 /*break*/, 3];
                         case 2:
-                            response = _a.sent();
+                            _a = credentials;
+                            _c.label = 3;
+                        case 3:
+                            signRequestOptions = (_b.credentials = _a,
+                                _b.signingDate = getSkewCorrectedDate(currentSystemClockOffset),
+                                _b.signingRegion = region,
+                                _b.signingService = service,
+                                _b.uriEscapePath = uriEscapePath,
+                                _b);
+                            return [4 /*yield*/, signRequest(request, signRequestOptions)];
+                        case 4:
+                            signedRequest = _c.sent();
+                            return [4 /*yield*/, next(signedRequest)];
+                        case 5:
+                            response = _c.sent();
                             dateString = getDateHeader(response);
                             if (dateString) {
                                 currentSystemClockOffset = getUpdatedSystemClockOffset(Date.parse(dateString), currentSystemClockOffset);

package/lib-esm/clients/middleware/signing/signer/signatureV4/index.d.ts

@@ -1,3 +1,5 @@
 export { signRequest } from './signRequest';
 export { presignUrl } from './presignUrl';
 export { TOKEN_QUERY_PARAM } from './constants';
+export { getHashedPayload } from './utils/getHashedPayload';
+export type { SignRequestOptions, PresignUrlOptions } from './types';

package/lib-esm/clients/middleware/signing/signer/signatureV4/index.js

@@ -4,3 +4,4 @@
 export { signRequest } from './signRequest';
 export { presignUrl } from './presignUrl';
 export { TOKEN_QUERY_PARAM } from './constants';
+export { getHashedPayload } from './utils/getHashedPayload';

package/lib-esm/clients/middleware/signing/signer/signatureV4/index.native.d.ts

@@ -2,3 +2,4 @@ import '@aws-amplify/core/polyfills/URL';
 export { signRequest } from './signRequest';
 export { presignUrl } from './presignUrl';
 export { TOKEN_QUERY_PARAM } from './constants';
+export { getHashedPayload } from './utils/getHashedPayload';

package/lib-esm/clients/middleware/signing/signer/signatureV4/index.native.js

@@ -5,3 +5,4 @@ import '@aws-amplify/core/polyfills/URL';
 export { signRequest } from './signRequest';
 export { presignUrl } from './presignUrl';
 export { TOKEN_QUERY_PARAM } from './constants';
+export { getHashedPayload } from './utils/getHashedPayload';

package/lib-esm/clients/middleware/signing/signer/signatureV4/types/signer.d.ts

@@ -4,6 +4,15 @@ export interface SignRequestOptions {
     signingDate?: Date;
     signingRegion: string;
     signingService: string;
+    /**
+     * Whether to uri encode the path as part of canonical uri. It's used for S3 only where the pathname
+     * is already uri encoded, and the signing process is not expected to uri encode it again.
+     *
+     * @default true
+     *
+     * @see https://github.com/aws/aws-sdk-js-v3/blob/9ba012dfa3a3429aa2db0f90b3b0b3a7a31f9bc3/packages/signature-v4/src/SignatureV4.ts#L76-L83
+     */
+    uriEscapePath?: boolean;
 }
 export interface PresignUrlOptions extends SignRequestOptions {
     expiration?: number;
@@ -15,6 +24,6 @@ export interface FormattedDates {
     longDate: string;
     shortDate: string;
 }
-export interface SigningValues extends Credentials, FormattedDates, Pick<SignRequestOptions, 'signingRegion' | 'signingService'> {
+export interface SigningValues extends Credentials, FormattedDates, Pick<SignRequestOptions, 'signingRegion' | 'signingService' | 'uriEscapePath'> {
     credentialScope: string;
 }

package/lib-esm/clients/middleware/signing/signer/signatureV4/utils/getCanonicalRequest.d.ts

@@ -3,6 +3,8 @@ import { HttpRequest } from '../../../../../types';
  * Returns a canonical request.
  *
  * @param request `HttpRequest` from which to create the canonical request from.
+ * @param uriEscapePath Whether to uri encode the path as part of canonical uri. It's used for S3 only where the
+ *   pathname is already uri encoded, and the signing process is not expected to uri encode it again. Defaults to true.
  * @returns String created by by concatenating the following strings, separated by newline characters:
  * - HTTPMethod
  * - CanonicalUri
@@ -13,4 +15,4 @@ import { HttpRequest } from '../../../../../types';
  *
  * @internal
  */
-export declare const getCanonicalRequest: ({ body, headers, method, url, }: HttpRequest) => string;
+export declare const getCanonicalRequest: ({ body, headers, method, url }: HttpRequest, uriEscapePath?: boolean) => string;

package/lib-esm/clients/middleware/signing/signer/signatureV4/utils/getCanonicalRequest.js

@@ -9,6 +9,8 @@ import { getSignedHeaders } from './getSignedHeaders';
  * Returns a canonical request.
  *
  * @param request `HttpRequest` from which to create the canonical request from.
+ * @param uriEscapePath Whether to uri encode the path as part of canonical uri. It's used for S3 only where the
+ *   pathname is already uri encoded, and the signing process is not expected to uri encode it again. Defaults to true.
  * @returns String created by by concatenating the following strings, separated by newline characters:
  * - HTTPMethod
  * - CanonicalUri
@@ -19,11 +21,12 @@ import { getSignedHeaders } from './getSignedHeaders';
  *
  * @internal
  */
-export var getCanonicalRequest = function (_a) {
+export var getCanonicalRequest = function (_a, uriEscapePath) {
     var body = _a.body, headers = _a.headers, method = _a.method, url = _a.url;
+    if (uriEscapePath === void 0) { uriEscapePath = true; }
     return [
         method,
-        getCanonicalUri(url.pathname),
+        getCanonicalUri(url.pathname, uriEscapePath),
         getCanonicalQueryString(url.searchParams),
         getCanonicalHeaders(headers),
         getSignedHeaders(headers),