@aws-sdk/middleware-flexible-checksums 3.972.10 → 3.973.0

package/dist-cjs/index.js

@@ -67,21 +67,6 @@ const NODE_RESPONSE_CHECKSUM_VALIDATION_CONFIG_OPTIONS = {
     default: DEFAULT_RESPONSE_CHECKSUM_VALIDATION,
 };
 
-const CLIENT_SUPPORTED_ALGORITHMS = [
-    exports.ChecksumAlgorithm.CRC32,
-    exports.ChecksumAlgorithm.CRC32C,
-    exports.ChecksumAlgorithm.CRC64NVME,
-    exports.ChecksumAlgorithm.SHA1,
-    exports.ChecksumAlgorithm.SHA256,
-];
-const PRIORITY_ORDER_ALGORITHMS = [
-    exports.ChecksumAlgorithm.SHA256,
-    exports.ChecksumAlgorithm.SHA1,
-    exports.ChecksumAlgorithm.CRC32,
-    exports.ChecksumAlgorithm.CRC32C,
-    exports.ChecksumAlgorithm.CRC64NVME,
-];
-
 const getChecksumAlgorithmForRequest = (input, { requestChecksumRequired, requestAlgorithmMember, requestChecksumCalculation }) => {
     if (!requestAlgorithmMember) {
         return requestChecksumCalculation === RequestChecksumCalculation.WHEN_SUPPORTED || requestChecksumRequired
@@ -92,10 +77,6 @@ const getChecksumAlgorithmForRequest = (input, { requestChecksumRequired, reques
         return undefined;
     }
     const checksumAlgorithm = input[requestAlgorithmMember];
-    if (!CLIENT_SUPPORTED_ALGORITHMS.includes(checksumAlgorithm)) {
-        throw new Error(`The checksum algorithm "${checksumAlgorithm}" is not supported by the client.` +
-            ` Select one of ${CLIENT_SUPPORTED_ALGORITHMS}.`);
-    }
     return checksumAlgorithm;
 };
 
@@ -123,25 +104,46 @@ const hasHeaderWithPrefix = (headerPrefix, headers) => {
 
 const isStreaming = (body) => body !== undefined && typeof body !== "string" && !ArrayBuffer.isView(body) && !isArrayBuffer.isArrayBuffer(body);
 
+const CLIENT_SUPPORTED_ALGORITHMS = [
+    exports.ChecksumAlgorithm.CRC32,
+    exports.ChecksumAlgorithm.CRC32C,
+    exports.ChecksumAlgorithm.CRC64NVME,
+    exports.ChecksumAlgorithm.SHA1,
+    exports.ChecksumAlgorithm.SHA256,
+];
+const PRIORITY_ORDER_ALGORITHMS = [
+    exports.ChecksumAlgorithm.SHA256,
+    exports.ChecksumAlgorithm.SHA1,
+    exports.ChecksumAlgorithm.CRC32,
+    exports.ChecksumAlgorithm.CRC32C,
+    exports.ChecksumAlgorithm.CRC64NVME,
+];
+
 const selectChecksumAlgorithmFunction = (checksumAlgorithm, config) => {
+    const { checksumAlgorithms = {} } = config;
     switch (checksumAlgorithm) {
         case exports.ChecksumAlgorithm.MD5:
-            return config.md5;
+            return checksumAlgorithms?.MD5 ?? config.md5;
         case exports.ChecksumAlgorithm.CRC32:
-            return getCrc32ChecksumAlgorithmFunction.getCrc32ChecksumAlgorithmFunction();
+            return checksumAlgorithms?.CRC32 ?? getCrc32ChecksumAlgorithmFunction.getCrc32ChecksumAlgorithmFunction();
         case exports.ChecksumAlgorithm.CRC32C:
-            return crc32c.AwsCrc32c;
+            return checksumAlgorithms?.CRC32C ?? crc32c.AwsCrc32c;
         case exports.ChecksumAlgorithm.CRC64NVME:
             if (typeof crc64Nvme.crc64NvmeCrtContainer.CrtCrc64Nvme !== "function") {
-                return crc64Nvme.Crc64Nvme;
+                return checksumAlgorithms?.CRC64NVME ?? crc64Nvme.Crc64Nvme;
             }
-            return crc64Nvme.crc64NvmeCrtContainer.CrtCrc64Nvme;
+            return checksumAlgorithms?.CRC64NVME ?? crc64Nvme.crc64NvmeCrtContainer.CrtCrc64Nvme;
         case exports.ChecksumAlgorithm.SHA1:
-            return config.sha1;
+            return checksumAlgorithms?.SHA1 ?? config.sha1;
         case exports.ChecksumAlgorithm.SHA256:
-            return config.sha256;
+            return checksumAlgorithms?.SHA256 ?? config.sha256;
         default:
-            throw new Error(`Unsupported checksum algorithm: ${checksumAlgorithm}`);
+            if (checksumAlgorithms?.[checksumAlgorithm]) {
+                return checksumAlgorithms[checksumAlgorithm];
+            }
+            throw new Error(`The checksum algorithm "${checksumAlgorithm}" is not supported by the client.` +
+                ` Select one of ${CLIENT_SUPPORTED_ALGORITHMS}, or provide an implementation to ` +
+                ` the client constructor checksums field.`);
     }
 };
 
@@ -416,6 +418,7 @@ const resolveFlexibleChecksumsConfig = (input) => {
         requestChecksumCalculation: utilMiddleware.normalizeProvider(requestChecksumCalculation ?? DEFAULT_REQUEST_CHECKSUM_CALCULATION),
         responseChecksumValidation: utilMiddleware.normalizeProvider(responseChecksumValidation ?? DEFAULT_RESPONSE_CHECKSUM_VALIDATION),
         requestStreamBufferSize: Number(requestStreamBufferSize ?? 0),
+        checksumAlgorithms: input.checksumAlgorithms ?? {},
     });
 };
 

package/dist-es/getChecksumAlgorithmForRequest.js

@@ -1,5 +1,4 @@
 import { DEFAULT_CHECKSUM_ALGORITHM, RequestChecksumCalculation } from "./constants";
-import { CLIENT_SUPPORTED_ALGORITHMS } from "./types";
 export const getChecksumAlgorithmForRequest = (input, { requestChecksumRequired, requestAlgorithmMember, requestChecksumCalculation }) => {
     if (!requestAlgorithmMember) {
         return requestChecksumCalculation === RequestChecksumCalculation.WHEN_SUPPORTED || requestChecksumRequired
@@ -10,9 +9,5 @@ export const getChecksumAlgorithmForRequest = (input, { requestChecksumRequired,
         return undefined;
     }
     const checksumAlgorithm = input[requestAlgorithmMember];
-    if (!CLIENT_SUPPORTED_ALGORITHMS.includes(checksumAlgorithm)) {
-        throw new Error(`The checksum algorithm "${checksumAlgorithm}" is not supported by the client.` +
-            ` Select one of ${CLIENT_SUPPORTED_ALGORITHMS}.`);
-    }
     return checksumAlgorithm;
 };

package/dist-es/resolveFlexibleChecksumsConfig.js

@@ -1,10 +1,11 @@
 import { normalizeProvider } from "@smithy/util-middleware";
-import { DEFAULT_REQUEST_CHECKSUM_CALCULATION, DEFAULT_RESPONSE_CHECKSUM_VALIDATION, } from "./constants";
+import { DEFAULT_REQUEST_CHECKSUM_CALCULATION, DEFAULT_RESPONSE_CHECKSUM_VALIDATION } from "./constants";
 export const resolveFlexibleChecksumsConfig = (input) => {
     const { requestChecksumCalculation, responseChecksumValidation, requestStreamBufferSize } = input;
     return Object.assign(input, {
         requestChecksumCalculation: normalizeProvider(requestChecksumCalculation ?? DEFAULT_REQUEST_CHECKSUM_CALCULATION),
         responseChecksumValidation: normalizeProvider(responseChecksumValidation ?? DEFAULT_RESPONSE_CHECKSUM_VALIDATION),
         requestStreamBufferSize: Number(requestStreamBufferSize ?? 0),
+        checksumAlgorithms: input.checksumAlgorithms ?? {},
     });
 };

package/dist-es/selectChecksumAlgorithmFunction.js

@@ -2,24 +2,31 @@ import { AwsCrc32c } from "@aws-crypto/crc32c";
 import { Crc64Nvme, crc64NvmeCrtContainer } from "@aws-sdk/crc64-nvme";
 import { ChecksumAlgorithm } from "./constants";
 import { getCrc32ChecksumAlgorithmFunction } from "./getCrc32ChecksumAlgorithmFunction";
+import { CLIENT_SUPPORTED_ALGORITHMS } from "./types";
 export const selectChecksumAlgorithmFunction = (checksumAlgorithm, config) => {
+    const { checksumAlgorithms = {} } = config;
     switch (checksumAlgorithm) {
         case ChecksumAlgorithm.MD5:
-            return config.md5;
+            return checksumAlgorithms?.MD5 ?? config.md5;
         case ChecksumAlgorithm.CRC32:
-            return getCrc32ChecksumAlgorithmFunction();
+            return checksumAlgorithms?.CRC32 ?? getCrc32ChecksumAlgorithmFunction();
         case ChecksumAlgorithm.CRC32C:
-            return AwsCrc32c;
+            return checksumAlgorithms?.CRC32C ?? AwsCrc32c;
         case ChecksumAlgorithm.CRC64NVME:
             if (typeof crc64NvmeCrtContainer.CrtCrc64Nvme !== "function") {
-                return Crc64Nvme;
+                return checksumAlgorithms?.CRC64NVME ?? Crc64Nvme;
             }
-            return crc64NvmeCrtContainer.CrtCrc64Nvme;
+            return checksumAlgorithms?.CRC64NVME ?? crc64NvmeCrtContainer.CrtCrc64Nvme;
         case ChecksumAlgorithm.SHA1:
-            return config.sha1;
+            return checksumAlgorithms?.SHA1 ?? config.sha1;
         case ChecksumAlgorithm.SHA256:
-            return config.sha256;
+            return checksumAlgorithms?.SHA256 ?? config.sha256;
         default:
-            throw new Error(`Unsupported checksum algorithm: ${checksumAlgorithm}`);
+            if (checksumAlgorithms?.[checksumAlgorithm]) {
+                return checksumAlgorithms[checksumAlgorithm];
+            }
+            throw new Error(`The checksum algorithm "${checksumAlgorithm}" is not supported by the client.` +
+                ` Select one of ${CLIENT_SUPPORTED_ALGORITHMS}, or provide an implementation to ` +
+                ` the client constructor checksums field.`);
     }
 };

package/dist-types/configuration.d.ts

@@ -1,5 +1,6 @@
-import { BodyLengthCalculator, ChecksumConstructor, Encoder, GetAwsChunkedEncodingStream, HashConstructor, Provider, StreamCollector, StreamHasher } from "@smithy/types";
-import { RequestChecksumCalculation, ResponseChecksumValidation } from "./constants";
+import type { BodyLengthCalculator, ChecksumConstructor, Encoder, GetAwsChunkedEncodingStream, HashConstructor, Provider, StreamCollector, StreamHasher } from "@smithy/types";
+import type { RequestChecksumCalculation, ResponseChecksumValidation } from "./constants";
+import type { FlexibleChecksumsInputConfig } from "./resolveFlexibleChecksumsConfig";
 /**
  * @internal
  */
@@ -53,4 +54,5 @@ export interface PreviouslyResolved {
      * Minimum bytes from a stream to buffer into a chunk before passing to chunked encoding.
      */
     requestStreamBufferSize: number;
+    checksumAlgorithms?: FlexibleChecksumsInputConfig["checksumAlgorithms"];
 }

package/dist-types/getChecksumAlgorithmForRequest.d.ts

@@ -1,4 +1,5 @@
-import { ChecksumAlgorithm, RequestChecksumCalculation } from "./constants";
+import type { ChecksumAlgorithm } from "./constants";
+import { RequestChecksumCalculation } from "./constants";
 export interface GetChecksumAlgorithmForRequestOptions {
     /**
      * Indicates an operation requires a checksum in its HTTP request.
@@ -18,4 +19,4 @@ export interface GetChecksumAlgorithmForRequestOptions {
  * the priority array of location to use to populate checksum and names
  * to be used as a key at the location.
  */
-export declare const getChecksumAlgorithmForRequest: (input: any, { requestChecksumRequired, requestAlgorithmMember, requestChecksumCalculation }: GetChecksumAlgorithmForRequestOptions) => ChecksumAlgorithm | undefined;
+export declare const getChecksumAlgorithmForRequest: (input: any, { requestChecksumRequired, requestAlgorithmMember, requestChecksumCalculation }: GetChecksumAlgorithmForRequestOptions) => ChecksumAlgorithm | string | undefined;

package/dist-types/getChecksumLocationName.d.ts

@@ -2,4 +2,4 @@ import { ChecksumAlgorithm } from "./constants";
 /**
  * Returns location (header/trailer) name to use to populate checksum in.
  */
-export declare const getChecksumLocationName: (algorithm: ChecksumAlgorithm) => string;
+export declare const getChecksumLocationName: (algorithm: ChecksumAlgorithm | string) => string;

package/dist-types/resolveFlexibleChecksumsConfig.d.ts

@@ -1,5 +1,5 @@
-import { Provider } from "@smithy/types";
-import { RequestChecksumCalculation, ResponseChecksumValidation } from "./constants";
+import type { ChecksumConstructor, Provider } from "@smithy/types";
+import type { RequestChecksumCalculation, ResponseChecksumValidation } from "./constants";
 /**
  * @public
  */
@@ -28,6 +28,19 @@ export interface FlexibleChecksumsInputConfig {
      * of 8kb or greater.
      */
     requestStreamBufferSize?: number | false;
+    /**
+     * Optional implementations of checksum algorithms adhering to the
+     * Checksum interface.
+     */
+    checksumAlgorithms?: {
+        CRC32?: ChecksumConstructor;
+        CRC32C?: ChecksumConstructor;
+        CRC64NVME?: ChecksumConstructor;
+        SHA1?: ChecksumConstructor;
+        SHA256?: ChecksumConstructor;
+    } & {
+        [algorithmId: string]: ChecksumConstructor;
+    };
 }
 /**
  * @internal
@@ -36,6 +49,7 @@ export interface FlexibleChecksumsResolvedConfig {
     requestChecksumCalculation: Provider<RequestChecksumCalculation>;
     responseChecksumValidation: Provider<ResponseChecksumValidation>;
     requestStreamBufferSize: number;
+    checksumAlgorithms?: FlexibleChecksumsInputConfig["checksumAlgorithms"];
 }
 /**
  * @internal

package/dist-types/selectChecksumAlgorithmFunction.d.ts

@@ -1,7 +1,7 @@
-import { ChecksumConstructor, HashConstructor } from "@smithy/types";
-import { PreviouslyResolved } from "./configuration";
+import type { ChecksumConstructor, HashConstructor } from "@smithy/types";
+import type { PreviouslyResolved } from "./configuration";
 import { ChecksumAlgorithm } from "./constants";
 /**
  * Returns the function that will compute the checksum for the given {@link ChecksumAlgorithm}.
  */
-export declare const selectChecksumAlgorithmFunction: (checksumAlgorithm: ChecksumAlgorithm, config: PreviouslyResolved) => ChecksumConstructor | HashConstructor;
+export declare const selectChecksumAlgorithmFunction: (checksumAlgorithm: ChecksumAlgorithm | string, config: PreviouslyResolved) => ChecksumConstructor | HashConstructor;

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

@@ -12,6 +12,7 @@ import {
   RequestChecksumCalculation,
   ResponseChecksumValidation,
 } from "./constants";
+import { FlexibleChecksumsInputConfig } from "./resolveFlexibleChecksumsConfig";
 export interface PreviouslyResolved {
   base64Encoder: Encoder;
   bodyLengthChecker: BodyLengthCalculator;
@@ -24,4 +25,5 @@ export interface PreviouslyResolved {
   streamHasher: StreamHasher<any>;
   streamCollector: StreamCollector;
   requestStreamBufferSize: number;
+  checksumAlgorithms?: FlexibleChecksumsInputConfig["checksumAlgorithms"];
 }

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

@@ -1,4 +1,5 @@
-import { ChecksumAlgorithm, RequestChecksumCalculation } from "./constants";
+import { ChecksumAlgorithm } from "./constants";
+import { RequestChecksumCalculation } from "./constants";
 export interface GetChecksumAlgorithmForRequestOptions {
   requestChecksumRequired: boolean;
   requestAlgorithmMember?: string;
@@ -11,4 +12,4 @@ export declare const getChecksumAlgorithmForRequest: (
     requestAlgorithmMember,
     requestChecksumCalculation,
   }: GetChecksumAlgorithmForRequestOptions
-) => ChecksumAlgorithm | undefined;
+) => ChecksumAlgorithm | string | undefined;

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

@@ -1,4 +1,4 @@
 import { ChecksumAlgorithm } from "./constants";
 export declare const getChecksumLocationName: (
-  algorithm: ChecksumAlgorithm
+  algorithm: ChecksumAlgorithm | string
 ) => string;

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

@@ -1,4 +1,4 @@
-import { Provider } from "@smithy/types";
+import { ChecksumConstructor, Provider } from "@smithy/types";
 import {
   RequestChecksumCalculation,
   ResponseChecksumValidation,
@@ -11,11 +11,21 @@ export interface FlexibleChecksumsInputConfig {
     | ResponseChecksumValidation
     | Provider<ResponseChecksumValidation>;
   requestStreamBufferSize?: number | false;
+  checksumAlgorithms?: {
+    CRC32?: ChecksumConstructor;
+    CRC32C?: ChecksumConstructor;
+    CRC64NVME?: ChecksumConstructor;
+    SHA1?: ChecksumConstructor;
+    SHA256?: ChecksumConstructor;
+  } & {
+    [algorithmId: string]: ChecksumConstructor;
+  };
 }
 export interface FlexibleChecksumsResolvedConfig {
   requestChecksumCalculation: Provider<RequestChecksumCalculation>;
   responseChecksumValidation: Provider<ResponseChecksumValidation>;
   requestStreamBufferSize: number;
+  checksumAlgorithms?: FlexibleChecksumsInputConfig["checksumAlgorithms"];
 }
 export declare const resolveFlexibleChecksumsConfig: <T>(
   input: T & FlexibleChecksumsInputConfig

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

@@ -2,6 +2,6 @@ import { ChecksumConstructor, HashConstructor } from "@smithy/types";
 import { PreviouslyResolved } from "./configuration";
 import { ChecksumAlgorithm } from "./constants";
 export declare const selectChecksumAlgorithmFunction: (
-  checksumAlgorithm: ChecksumAlgorithm,
+  checksumAlgorithm: ChecksumAlgorithm | string,
   config: PreviouslyResolved
 ) => ChecksumConstructor | HashConstructor;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-sdk/middleware-flexible-checksums",
-  "version": "3.972.10",
+  "version": "3.973.0",
   "scripts": {
     "build": "concurrently 'yarn:build:types' 'yarn:build:es' && yarn build:cjs",
     "build:cjs": "node ../../scripts/compilation/inline middleware-flexible-checksums",
@@ -37,20 +37,20 @@
     "@aws-crypto/crc32": "5.2.0",
     "@aws-crypto/crc32c": "5.2.0",
     "@aws-crypto/util": "5.2.0",
-    "@aws-sdk/core": "^3.973.12",
-    "@aws-sdk/crc64-nvme": "3.972.0",
-    "@aws-sdk/types": "^3.973.1",
-    "@smithy/is-array-buffer": "^4.2.0",
-    "@smithy/node-config-provider": "^4.3.8",
-    "@smithy/protocol-http": "^5.3.8",
-    "@smithy/types": "^4.12.0",
-    "@smithy/util-middleware": "^4.2.8",
-    "@smithy/util-stream": "^4.5.12",
-    "@smithy/util-utf8": "^4.2.0",
+    "@aws-sdk/core": "^3.973.14",
+    "@aws-sdk/crc64-nvme": "^3.972.2",
+    "@aws-sdk/types": "^3.973.3",
+    "@smithy/is-array-buffer": "^4.2.1",
+    "@smithy/node-config-provider": "^4.3.10",
+    "@smithy/protocol-http": "^5.3.10",
+    "@smithy/types": "^4.13.0",
+    "@smithy/util-middleware": "^4.2.10",
+    "@smithy/util-stream": "^4.5.15",
+    "@smithy/util-utf8": "^4.2.1",
     "tslib": "^2.6.2"
   },
   "devDependencies": {
-    "@smithy/node-http-handler": "^4.4.10",
+    "@smithy/node-http-handler": "^4.4.12",
     "concurrently": "7.0.0",
     "downlevel-dts": "0.10.1",
     "premove": "4.0.0",