@smithy/signature-v4 4.2.3 → 5.0.0

package/dist-cjs/index.js

@@ -121,7 +121,7 @@ var getCanonicalHeaders = /* @__PURE__ */ __name(({ headers }, unsignableHeaders
       continue;
     }
     const canonicalHeaderName = headerName.toLowerCase();
-    if (canonicalHeaderName in ALWAYS_UNSIGNABLE_HEADERS || (unsignableHeaders == null ? void 0 : unsignableHeaders.has(canonicalHeaderName)) || PROXY_HEADER_PATTERN.test(canonicalHeaderName) || SEC_HEADER_PATTERN.test(canonicalHeaderName)) {
+    if (canonicalHeaderName in ALWAYS_UNSIGNABLE_HEADERS || unsignableHeaders?.has(canonicalHeaderName) || PROXY_HEADER_PATTERN.test(canonicalHeaderName) || SEC_HEADER_PATTERN.test(canonicalHeaderName)) {
       if (!signableHeaders || signableHeaders && !signableHeaders.has(canonicalHeaderName)) {
         continue;
       }
@@ -175,7 +175,10 @@ var getPayloadHash = /* @__PURE__ */ __name(async ({ headers, body }, hashConstr
 // src/HeaderFormatter.ts
 
 var import_util_utf83 = require("@smithy/util-utf8");
-var _HeaderFormatter = class _HeaderFormatter {
+var HeaderFormatter = class {
+  static {
+    __name(this, "HeaderFormatter");
+  }
   format(headers) {
     const chunks = [];
     for (const headerName of Object.keys(headers)) {
@@ -242,16 +245,17 @@ var _HeaderFormatter = class _HeaderFormatter {
     }
   }
 };
-__name(_HeaderFormatter, "HeaderFormatter");
-var HeaderFormatter = _HeaderFormatter;
 var UUID_PATTERN = /^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/;
-var _Int64 = class _Int64 {
+var Int64 = class _Int64 {
   constructor(bytes) {
     this.bytes = bytes;
     if (bytes.byteLength !== 8) {
       throw new Error("Int64 buffers must be exactly 8 bytes");
     }
   }
+  static {
+    __name(this, "Int64");
+  }
   static fromNumber(number) {
     if (number > 9223372036854776e3 || number < -9223372036854776e3) {
       throw new Error(`${number} is too large (or, if negative, too small) to represent as an Int64`);
@@ -280,8 +284,6 @@ var _Int64 = class _Int64 {
     return String(this.valueOf());
   }
 };
-__name(_Int64, "Int64");
-var Int64 = _Int64;
 function negate(bytes) {
   for (let i = 0; i < 8; i++) {
     bytes[i] ^= 255;
@@ -308,11 +310,10 @@ var hasHeader = /* @__PURE__ */ __name((soughtHeader, headers) => {
 // src/moveHeadersToQuery.ts
 var import_protocol_http = require("@smithy/protocol-http");
 var moveHeadersToQuery = /* @__PURE__ */ __name((request, options = {}) => {
-  var _a, _b;
   const { headers, query = {} } = import_protocol_http.HttpRequest.clone(request);
   for (const name of Object.keys(headers)) {
     const lname = name.toLowerCase();
-    if (lname.slice(0, 6) === "x-amz-" && !((_a = options.unhoistableHeaders) == null ? void 0 : _a.has(lname)) || ((_b = options.hoistableHeaders) == null ? void 0 : _b.has(lname))) {
+    if (lname.slice(0, 6) === "x-amz-" && !options.unhoistableHeaders?.has(lname) || options.hoistableHeaders?.has(lname)) {
       query[name] = headers[name];
       delete headers[name];
     }
@@ -352,7 +353,7 @@ var toDate = /* @__PURE__ */ __name((time) => {
 }, "toDate");
 
 // src/SignatureV4.ts
-var _SignatureV4 = class _SignatureV4 {
+var SignatureV4 = class {
   constructor({
     applyChecksum,
     credentials,
@@ -369,6 +370,9 @@ var _SignatureV4 = class _SignatureV4 {
     this.regionProvider = (0, import_util_middleware.normalizeProvider)(region);
     this.credentialProvider = (0, import_util_middleware.normalizeProvider)(credentials);
   }
+  static {
+    __name(this, "SignatureV4");
+  }
   async presign(originalRequest, options = {}) {
     const {
       signingDate = /* @__PURE__ */ new Date(),
@@ -517,7 +521,7 @@ ${(0, import_util_hex_encoding.toHex)(hashedRequest)}`;
     if (this.uriEscapePath) {
       const normalizedPathSegments = [];
       for (const pathSegment of path.split("/")) {
-        if ((pathSegment == null ? void 0 : pathSegment.length) === 0)
+        if (pathSegment?.length === 0)
           continue;
         if (pathSegment === ".")
           continue;
@@ -527,7 +531,7 @@ ${(0, import_util_hex_encoding.toHex)(hashedRequest)}`;
           normalizedPathSegments.push(pathSegment);
         }
       }
-      const normalizedPath = `${(path == null ? void 0 : path.startsWith("/")) ? "/" : ""}${normalizedPathSegments.join("/")}${normalizedPathSegments.length > 0 && (path == null ? void 0 : path.endsWith("/")) ? "/" : ""}`;
+      const normalizedPath = `${path?.startsWith("/") ? "/" : ""}${normalizedPathSegments.join("/")}${normalizedPathSegments.length > 0 && path?.endsWith("/") ? "/" : ""}`;
       const doubleEncoded = (0, import_util_uri_escape.escapeUri)(normalizedPath);
       return doubleEncoded.replace(/%2F/g, "/");
     }
@@ -550,8 +554,6 @@ ${(0, import_util_hex_encoding.toHex)(hashedRequest)}`;
     }
   }
 };
-__name(_SignatureV4, "SignatureV4");
-var SignatureV4 = _SignatureV4;
 var formatDate = /* @__PURE__ */ __name((now) => {
   const longDate = iso8601(now).replace(/[\-:]/g, "");
   return {

package/dist-types/SignatureV4.d.ts

@@ -1,4 +1,7 @@
 import { AwsCredentialIdentity, ChecksumConstructor, EventSigner, EventSigningArguments, FormattedEvent, HashConstructor, HttpRequest, MessageSigner, Provider, RequestPresigner, RequestPresigningArguments, RequestSigner, RequestSigningArguments, SignableMessage, SignedMessage, SigningArguments, StringSigner } from "@smithy/types";
+/**
+ * @public
+ */
 export interface SignatureV4Init {
     /**
      * The service signing name.
@@ -37,9 +40,15 @@ export interface SignatureV4Init {
      */
     applyChecksum?: boolean;
 }
+/**
+ * @public
+ */
 export interface SignatureV4CryptoInit {
     sha256: ChecksumConstructor | HashConstructor;
 }
+/**
+ * @public
+ */
 export declare class SignatureV4 implements RequestPresigner, RequestSigner, StringSigner, EventSigner, MessageSigner {
     private readonly service;
     private readonly regionProvider;

package/dist-types/credentialDerivation.d.ts

@@ -2,21 +2,25 @@ import { AwsCredentialIdentity, ChecksumConstructor, HashConstructor } from "@sm
 /**
  * Create a string describing the scope of credentials used to sign a request.
  *
- * @param shortDate The current calendar date in the form YYYYMMDD.
- * @param region    The AWS region in which the service resides.
- * @param service   The service to which the signed request is being sent.
+ * @internal
+ *
+ * @param shortDate - the current calendar date in the form YYYYMMDD.
+ * @param region    - the AWS region in which the service resides.
+ * @param service   - the service to which the signed request is being sent.
  */
 export declare const createScope: (shortDate: string, region: string, service: string) => string;
 /**
- * Derive a signing key from its composite parts
+ * Derive a signing key from its composite parts.
+ *
+ * @internal
  *
- * @param sha256Constructor A constructor function that can instantiate SHA-256
+ * @param sha256Constructor - a constructor function that can instantiate SHA-256
  *                          hash objects.
- * @param credentials       The credentials with which the request will be
+ * @param credentials       - the credentials with which the request will be
  *                          signed.
- * @param shortDate         The current calendar date in the form YYYYMMDD.
- * @param region            The AWS region in which the service resides.
- * @param service           The service to which the signed request is being
+ * @param shortDate         - the current calendar date in the form YYYYMMDD.
+ * @param region            - the AWS region in which the service resides.
+ * @param service           - the service to which the signed request is being
  *                          sent.
  */
 export declare const getSigningKey: (sha256Constructor: ChecksumConstructor | HashConstructor, credentials: AwsCredentialIdentity, shortDate: string, region: string, service: string) => Promise<Uint8Array>;

package/dist-types/getCanonicalHeaders.d.ts

@@ -1,5 +1,5 @@
 import { HeaderBag, HttpRequest } from "@smithy/types";
 /**
- * @private
+ * @internal
  */
 export declare const getCanonicalHeaders: ({ headers }: HttpRequest, unsignableHeaders?: Set<string>, signableHeaders?: Set<string>) => HeaderBag;

package/dist-types/getCanonicalQuery.d.ts

@@ -1,5 +1,5 @@
 import { HttpRequest } from "@smithy/types";
 /**
- * @private
+ * @internal
  */
 export declare const getCanonicalQuery: ({ query }: HttpRequest) => string;

package/dist-types/getPayloadHash.d.ts

@@ -1,5 +1,5 @@
 import { ChecksumConstructor, HashConstructor, HttpRequest } from "@smithy/types";
 /**
- * @private
+ * @internal
  */
 export declare const getPayloadHash: ({ headers, body }: HttpRequest, hashConstructor: ChecksumConstructor | HashConstructor) => Promise<string>;

package/dist-types/moveHeadersToQuery.d.ts

@@ -1,6 +1,6 @@
 import type { HttpRequest as IHttpRequest, QueryParameterBag } from "@smithy/types";
 /**
- * @private
+ * @internal
  */
 export declare const moveHeadersToQuery: (request: IHttpRequest, options?: {
     unhoistableHeaders?: Set<string>;

package/dist-types/prepareRequest.d.ts

@@ -1,5 +1,5 @@
 import type { HttpRequest as IHttpRequest } from "@smithy/types";
 /**
- * @private
+ * @internal
  */
 export declare const prepareRequest: (request: IHttpRequest) => IHttpRequest;

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

@@ -1,4 +1,7 @@
 import { AwsCredentialIdentity, ChecksumConstructor, EventSigner, EventSigningArguments, FormattedEvent, HashConstructor, HttpRequest, MessageSigner, Provider, RequestPresigner, RequestPresigningArguments, RequestSigner, RequestSigningArguments, SignableMessage, SignedMessage, SigningArguments, StringSigner } from "@smithy/types";
+/**
+ * @public
+ */
 export interface SignatureV4Init {
     /**
      * The service signing name.
@@ -37,9 +40,15 @@ export interface SignatureV4Init {
      */
     applyChecksum?: boolean;
 }
+/**
+ * @public
+ */
 export interface SignatureV4CryptoInit {
     sha256: ChecksumConstructor | HashConstructor;
 }
+/**
+ * @public
+ */
 export declare class SignatureV4 implements RequestPresigner, RequestSigner, StringSigner, EventSigner, MessageSigner {
     private readonly service;
     private readonly regionProvider;

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

@@ -2,21 +2,25 @@ import { AwsCredentialIdentity, ChecksumConstructor, HashConstructor } from "@sm
 /**
  * Create a string describing the scope of credentials used to sign a request.
  *
- * @param shortDate The current calendar date in the form YYYYMMDD.
- * @param region    The AWS region in which the service resides.
- * @param service   The service to which the signed request is being sent.
+ * @internal
+ *
+ * @param shortDate - the current calendar date in the form YYYYMMDD.
+ * @param region    - the AWS region in which the service resides.
+ * @param service   - the service to which the signed request is being sent.
  */
 export declare const createScope: (shortDate: string, region: string, service: string) => string;
 /**
- * Derive a signing key from its composite parts
+ * Derive a signing key from its composite parts.
+ *
+ * @internal
  *
- * @param sha256Constructor A constructor function that can instantiate SHA-256
+ * @param sha256Constructor - a constructor function that can instantiate SHA-256
  *                          hash objects.
- * @param credentials       The credentials with which the request will be
+ * @param credentials       - the credentials with which the request will be
  *                          signed.
- * @param shortDate         The current calendar date in the form YYYYMMDD.
- * @param region            The AWS region in which the service resides.
- * @param service           The service to which the signed request is being
+ * @param shortDate         - the current calendar date in the form YYYYMMDD.
+ * @param region            - the AWS region in which the service resides.
+ * @param service           - the service to which the signed request is being
  *                          sent.
  */
 export declare const getSigningKey: (sha256Constructor: ChecksumConstructor | HashConstructor, credentials: AwsCredentialIdentity, shortDate: string, region: string, service: string) => Promise<Uint8Array>;

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

@@ -1,5 +1,5 @@
 import { HeaderBag, HttpRequest } from "@smithy/types";
 /**
- * @private
+ * @internal
  */
 export declare const getCanonicalHeaders: ({ headers }: HttpRequest, unsignableHeaders?: Set<string>, signableHeaders?: Set<string>) => HeaderBag;

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

@@ -1,5 +1,5 @@
 import { HttpRequest } from "@smithy/types";
 /**
- * @private
+ * @internal
  */
 export declare const getCanonicalQuery: ({ query }: HttpRequest) => string;

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

@@ -1,5 +1,5 @@
 import { ChecksumConstructor, HashConstructor, HttpRequest } from "@smithy/types";
 /**
- * @private
+ * @internal
  */
 export declare const getPayloadHash: ({ headers, body }: HttpRequest, hashConstructor: ChecksumConstructor | HashConstructor) => Promise<string>;

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

@@ -1,6 +1,6 @@
 import { HttpRequest as IHttpRequest, QueryParameterBag } from "@smithy/types";
 /**
- * @private
+ * @internal
  */
 export declare const moveHeadersToQuery: (request: IHttpRequest, options?: {
     unhoistableHeaders?: Set<string>;

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

@@ -1,5 +1,5 @@
 import { HttpRequest as IHttpRequest } from "@smithy/types";
 /**
- * @private
+ * @internal
  */
 export declare const prepareRequest: (request: IHttpRequest) => IHttpRequest;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smithy/signature-v4",
-  "version": "4.2.3",
+  "version": "5.0.0",
   "description": "A standalone implementation of the AWS Signature V4 request signing algorithm",
   "main": "./dist-cjs/index.js",
   "module": "./dist-es/index.js",
@@ -25,13 +25,13 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@smithy/is-array-buffer": "^3.0.0",
-    "@smithy/protocol-http": "^4.1.7",
-    "@smithy/types": "^3.7.1",
-    "@smithy/util-hex-encoding": "^3.0.0",
-    "@smithy/util-middleware": "^3.0.10",
-    "@smithy/util-uri-escape": "^3.0.0",
-    "@smithy/util-utf8": "^3.0.0",
+    "@smithy/is-array-buffer": "^4.0.0",
+    "@smithy/protocol-http": "^5.0.0",
+    "@smithy/types": "^4.0.0",
+    "@smithy/util-hex-encoding": "^4.0.0",
+    "@smithy/util-middleware": "^4.0.0",
+    "@smithy/util-uri-escape": "^4.0.0",
+    "@smithy/util-utf8": "^4.0.0",
     "tslib": "^2.6.2"
   },
   "devDependencies": {
@@ -42,7 +42,7 @@
     "typedoc": "0.23.23"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": ">=18.0.0"
   },
   "typesVersions": {
     "<4.0": {