@aws-sdk/core 3.433.0 → 3.441.0

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.441.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.440.0...v3.441.0) (2023-11-01)
+
+**Note:** Version bump only for package @aws-sdk/core
+
+
+
+
+
+# [3.436.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.435.0...v3.436.0) (2023-10-25)
+
+**Note:** Version bump only for package @aws-sdk/core
+
+
+
+
+
 # [3.433.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.432.0...v3.433.0) (2023-10-20)
 
 

package/dist-cjs/client/emitWarningIfUnsupportedVersion.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.emitWarningIfUnsupportedVersion = void 0;
+let warningEmitted = false;
+const emitWarningIfUnsupportedVersion = (version) => {
+    if (version && !warningEmitted && parseInt(version.substring(1, version.indexOf("."))) < 16) {
+        warningEmitted = true;
+        process.emitWarning(`NodeDeprecationWarning: The AWS SDK for JavaScript (v3) will
+no longer support Node.js 14.x on May 1, 2024.
+
+To continue receiving updates to AWS services, bug fixes, and security
+updates please upgrade to an active Node.js LTS version.
+
+More information can be found at: https://a.co/dzr2AJd`);
+    }
+};
+exports.emitWarningIfUnsupportedVersion = emitWarningIfUnsupportedVersion;

package/dist-cjs/client/index.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./emitWarningIfUnsupportedVersion"), exports);

package/dist-cjs/index.js

@@ -1,4 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./client/index"), exports);
 tslib_1.__exportStar(require("./protocols/index"), exports);

package/dist-cjs/protocols/coercing-serializers.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._toNum = exports._toBool = exports._toStr = void 0;
+const _toStr = (val) => {
+    if (val == null) {
+        return val;
+    }
+    if (typeof val === "number" || typeof val === "bigint") {
+        const warning = new Error(`Received number ${val} where a string was expected.`);
+        warning.name = "Warning";
+        console.warn(warning);
+        return String(val);
+    }
+    if (typeof val === "boolean") {
+        const warning = new Error(`Received boolean ${val} where a string was expected.`);
+        warning.name = "Warning";
+        console.warn(warning);
+        return String(val);
+    }
+    return val;
+};
+exports._toStr = _toStr;
+const _toBool = (val) => {
+    if (val == null) {
+        return val;
+    }
+    if (typeof val === "number") {
+    }
+    if (typeof val === "string") {
+        const lowercase = val.toLowerCase();
+        if (val !== "" && lowercase !== "false" && lowercase !== "true") {
+            const warning = new Error(`Received string "${val}" where a boolean was expected.`);
+            warning.name = "Warning";
+            console.warn(warning);
+        }
+        return val !== "" && lowercase !== "false";
+    }
+    return val;
+};
+exports._toBool = _toBool;
+const _toNum = (val) => {
+    if (val == null) {
+        return val;
+    }
+    if (typeof val === "boolean") {
+    }
+    if (typeof val === "string") {
+        const num = Number(val);
+        if (num.toString() !== val) {
+            const warning = new Error(`Received string "${val}" where a number was expected.`);
+            warning.name = "Warning";
+            console.warn(warning);
+            return val;
+        }
+        return num;
+    }
+    return val;
+};
+exports._toNum = _toNum;

package/dist-cjs/protocols/index.js

@@ -1,4 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./coercing-serializers"), exports);
 tslib_1.__exportStar(require("./json/awsExpectUnion"), exports);

package/dist-es/client/emitWarningIfUnsupportedVersion.js

@@ -0,0 +1,13 @@
+let warningEmitted = false;
+export const emitWarningIfUnsupportedVersion = (version) => {
+    if (version && !warningEmitted && parseInt(version.substring(1, version.indexOf("."))) < 16) {
+        warningEmitted = true;
+        process.emitWarning(`NodeDeprecationWarning: The AWS SDK for JavaScript (v3) will
+no longer support Node.js 14.x on May 1, 2024.
+
+To continue receiving updates to AWS services, bug fixes, and security
+updates please upgrade to an active Node.js LTS version.
+
+More information can be found at: https://a.co/dzr2AJd`);
+    }
+};

package/dist-es/client/index.js

@@ -0,0 +1 @@
+export * from "./emitWarningIfUnsupportedVersion";

package/dist-es/index.js

@@ -1 +1,2 @@
+export * from "./client/index";
 export * from "./protocols/index";

package/dist-es/protocols/coercing-serializers.js

@@ -0,0 +1,53 @@
+export const _toStr = (val) => {
+    if (val == null) {
+        return val;
+    }
+    if (typeof val === "number" || typeof val === "bigint") {
+        const warning = new Error(`Received number ${val} where a string was expected.`);
+        warning.name = "Warning";
+        console.warn(warning);
+        return String(val);
+    }
+    if (typeof val === "boolean") {
+        const warning = new Error(`Received boolean ${val} where a string was expected.`);
+        warning.name = "Warning";
+        console.warn(warning);
+        return String(val);
+    }
+    return val;
+};
+export const _toBool = (val) => {
+    if (val == null) {
+        return val;
+    }
+    if (typeof val === "number") {
+    }
+    if (typeof val === "string") {
+        const lowercase = val.toLowerCase();
+        if (val !== "" && lowercase !== "false" && lowercase !== "true") {
+            const warning = new Error(`Received string "${val}" where a boolean was expected.`);
+            warning.name = "Warning";
+            console.warn(warning);
+        }
+        return val !== "" && lowercase !== "false";
+    }
+    return val;
+};
+export const _toNum = (val) => {
+    if (val == null) {
+        return val;
+    }
+    if (typeof val === "boolean") {
+    }
+    if (typeof val === "string") {
+        const num = Number(val);
+        if (num.toString() !== val) {
+            const warning = new Error(`Received string "${val}" where a number was expected.`);
+            warning.name = "Warning";
+            console.warn(warning);
+            return val;
+        }
+        return num;
+    }
+    return val;
+};

package/dist-es/protocols/index.js

@@ -1 +1,2 @@
+export * from "./coercing-serializers";
 export * from "./json/awsExpectUnion";

package/dist-types/client/emitWarningIfUnsupportedVersion.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @internal
+ *
+ * Emits warning if the provided Node.js version string is
+ * pending deprecation by AWS SDK JSv3.
+ *
+ * @param version - The Node.js version string.
+ */
+export declare const emitWarningIfUnsupportedVersion: (version: string) => void;

package/dist-types/client/index.d.ts

@@ -0,0 +1 @@
+export * from "./emitWarningIfUnsupportedVersion";

package/dist-types/index.d.ts

@@ -1 +1,2 @@
+export * from "./client/index";
 export * from "./protocols/index";

package/dist-types/protocols/coercing-serializers.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @internal
+ *
+ * Used for awsQueryCompatibility trait.
+ */
+export declare const _toStr: (val: unknown) => string | undefined;
+/**
+ * @internal
+ *
+ * Used for awsQueryCompatibility trait.
+ */
+export declare const _toBool: (val: unknown) => boolean | undefined;
+/**
+ * @internal
+ *
+ * Used for awsQueryCompatibility trait.
+ */
+export declare const _toNum: (val: unknown) => number | undefined;

package/dist-types/protocols/index.d.ts

@@ -1 +1,2 @@
+export * from "./coercing-serializers";
 export * from "./json/awsExpectUnion";

package/dist-types/ts3.4/client/emitWarningIfUnsupportedVersion.d.ts

@@ -0,0 +1 @@
+export declare const emitWarningIfUnsupportedVersion: (version: string) => void;

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

@@ -0,0 +1 @@
+export * from "./emitWarningIfUnsupportedVersion";

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

@@ -1 +1,2 @@
+export * from "./client/index";
 export * from "./protocols/index";

package/dist-types/ts3.4/protocols/coercing-serializers.d.ts

@@ -0,0 +1,3 @@
+export declare const _toStr: (val: unknown) => string | undefined;
+export declare const _toBool: (val: unknown) => boolean | undefined;
+export declare const _toNum: (val: unknown) => number | undefined;

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

@@ -1 +1,2 @@
+export * from "./coercing-serializers";
 export * from "./json/awsExpectUnion";

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "@aws-sdk/core",
-  "version": "3.433.0",
+  "version": "3.441.0",
   "description": "Core functions & classes shared by multiple AWS SDK clients",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
-    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "build:cjs": "tsc -p tsconfig.cjs.json && yarn lint",
     "build:es": "tsc -p tsconfig.es.json",
     "build:include:deps": "lerna run --scope $npm_package_name --include-dependencies build",
     "build:types": "tsc -p tsconfig.types.json",
     "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4",
+    "lint": "node ./scripts/lint.js",
     "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo",
     "extract:docs": "api-extractor run --local",
     "test": "jest --passWithNoTests"
@@ -16,6 +17,7 @@
   "main": "./dist-cjs/index.js",
   "module": "./dist-es/index.js",
   "types": "./dist-types/index.d.ts",
+  "sideEffects": false,
   "author": {
     "name": "AWS SDK for JavaScript Team",
     "url": "https://aws.amazon.com/javascript/"

package/scripts/lint.js

@@ -0,0 +1,24 @@
+const fs = require("fs");
+const path = require("path");
+const assert = require("assert");
+
+const root = path.join(__dirname, "..");
+
+const pkgJson = require(path.join(root, "package.json"));
+const srcFolders = fs.readdirSync(path.join(root, "src"));
+
+assert(pkgJson.exports === undefined, "We cannot support package.json exports yet.");
+
+/**
+ * We probably can't enable package.json exports until
+ * dropping support for Node.js 14.x and TypeScript 4.6.
+ */
+process.exit(0);
+
+for (const srcFolder of srcFolders) {
+  if (fs.lstatSync(path.join(root, "src", srcFolder)).isDirectory()) {
+    if (!pkgJson.exports["./" + srcFolder]) {
+      throw new Error(`${srcFolder} is missing exports statement in package.json`);
+    }
+  }
+}

package/src/client/emitWarningIfUnsupportedVersion.spec.ts

@@ -0,0 +1,70 @@
+describe("emitWarningIfUnsupportedVersion", () => {
+  let emitWarningIfUnsupportedVersion;
+  const emitWarning = process.emitWarning;
+  const supportedVersion = "16.0.0";
+
+  beforeEach(() => {
+    const module = require("./emitWarningIfUnsupportedVersion");
+    emitWarningIfUnsupportedVersion = module.emitWarningIfUnsupportedVersion;
+  });
+
+  afterEach(() => {
+    jest.clearAllMocks();
+    jest.resetModules();
+    process.emitWarning = emitWarning;
+  });
+
+  describe(`emits warning for Node.js <${supportedVersion}`, () => {
+    const getPreviousMajorVersion = (major: number) => (major === 0 ? 0 : major - 1);
+
+    const getPreviousMinorVersion = ([major, minor]: [number, number]) =>
+      minor === 0 ? [getPreviousMajorVersion(major), 9] : [major, minor - 1];
+
+    const getPreviousPatchVersion = ([major, minor, patch]: [number, number, number]) =>
+      patch === 0 ? [...getPreviousMinorVersion([major, minor]), 9] : [major, minor, patch - 1];
+
+    const [major, minor, patch] = supportedVersion.split(".").map(Number);
+    it.each(
+      [
+        getPreviousPatchVersion([major, minor, patch]),
+        [...getPreviousMinorVersion([major, minor]), 0],
+        [getPreviousMajorVersion(major), 0, 0],
+      ].map((arr) => `v${arr.join(".")}`)
+    )(`%s`, async (unsupportedVersion) => {
+      process.emitWarning = jest.fn();
+      emitWarningIfUnsupportedVersion(unsupportedVersion);
+
+      // Verify that the warning was emitted.
+      expect(process.emitWarning).toHaveBeenCalledTimes(1);
+      expect(process.emitWarning).toHaveBeenCalledWith(
+        `NodeDeprecationWarning: The AWS SDK for JavaScript (v3) will
+no longer support Node.js 14.x on May 1, 2024.
+
+To continue receiving updates to AWS services, bug fixes, and security
+updates please upgrade to an active Node.js LTS version.
+
+More information can be found at: https://a.co/dzr2AJd`
+      );
+
+      // Verify that the warning emits only once.
+      emitWarningIfUnsupportedVersion(unsupportedVersion);
+      expect(process.emitWarning).toHaveBeenCalledTimes(1);
+    });
+  });
+
+  describe(`emits no warning for Node.js >=${supportedVersion}`, () => {
+    const [major, minor, patch] = supportedVersion.split(".").map(Number);
+    it.each(
+      [
+        [major, minor, patch],
+        [major, minor, patch + 1],
+        [major, minor + 1, 0],
+        [major + 1, 0, 0],
+      ].map((arr) => `v${arr.join(".")}`)
+    )(`%s`, async (unsupportedVersion) => {
+      process.emitWarning = jest.fn();
+      emitWarningIfUnsupportedVersion(unsupportedVersion);
+      expect(process.emitWarning).not.toHaveBeenCalled();
+    });
+  });
+});

package/src/client/emitWarningIfUnsupportedVersion.ts

@@ -0,0 +1,25 @@
+// Stores whether the warning was already emitted.
+let warningEmitted = false;
+
+/**
+ * @internal
+ *
+ * Emits warning if the provided Node.js version string is
+ * pending deprecation by AWS SDK JSv3.
+ *
+ * @param version - The Node.js version string.
+ */
+export const emitWarningIfUnsupportedVersion = (version: string) => {
+  if (version && !warningEmitted && parseInt(version.substring(1, version.indexOf("."))) < 16) {
+    warningEmitted = true;
+    process.emitWarning(
+      `NodeDeprecationWarning: The AWS SDK for JavaScript (v3) will
+no longer support Node.js 14.x on May 1, 2024.
+
+To continue receiving updates to AWS services, bug fixes, and security
+updates please upgrade to an active Node.js LTS version.
+
+More information can be found at: https://a.co/dzr2AJd`
+    );
+  }
+};

package/src/client/index.ts

@@ -0,0 +1 @@
+export * from "./emitWarningIfUnsupportedVersion";

package/src/index.ts

@@ -1 +1,2 @@
+export * from "./client/index";
 export * from "./protocols/index";

package/src/protocols/coercing-serializers.spec.ts

@@ -0,0 +1,76 @@
+import { _toBool, _toNum, _toStr } from "./coercing-serializers";
+
+const consoleWarn = console.warn;
+
+beforeAll(() => {
+  console.warn = () => {};
+});
+
+afterAll(() => {
+  console.warn = consoleWarn;
+});
+
+describe(_toBool.name, () => {
+  it("ignores nullish", () => {
+    expect(_toBool(null)).toBe(null);
+    expect(_toBool(undefined)).toBe(undefined);
+  });
+
+  it("converts strings", () => {
+    expect(_toBool("false")).toEqual(false);
+    expect(_toBool("true")).toEqual(true);
+
+    expect(_toBool("False")).toEqual(false);
+    expect(_toBool("True")).toEqual(true);
+
+    expect(_toBool("")).toEqual(false);
+    expect(_toBool("a")).toEqual(true); // warns
+  });
+
+  it("does not convert numbers", () => {
+    expect(_toBool(0)).toEqual(0);
+    expect(_toBool(1)).toEqual(1);
+  });
+});
+
+describe(_toStr.name, () => {
+  it("ignores nullish", () => {
+    expect(_toStr(null)).toBe(null);
+    expect(_toStr(undefined)).toBe(undefined);
+  });
+
+  it("converts numbers", () => {
+    expect(_toStr(0)).toEqual("0");
+    expect(_toStr(1)).toEqual("1");
+  });
+
+  it("converts booleans", () => {
+    expect(_toStr(false)).toEqual("false");
+    expect(_toStr(true)).toEqual("true");
+  });
+});
+
+describe(_toNum.name, () => {
+  it("ignores nullish", () => {
+    expect(_toNum(null)).toBe(null);
+    expect(_toNum(undefined)).toBe(undefined);
+  });
+
+  it("converts numeric strings", () => {
+    expect(_toNum("1234")).toEqual(1234);
+    expect(_toNum("1234.56")).toEqual(1234.56);
+  });
+
+  it("does not convert prefix-numeric strings", () => {
+    expect(_toNum("1234abc")).toEqual("1234abc");
+    expect(_toNum("1234.56abc")).toEqual("1234.56abc");
+  });
+
+  it("does not convert non-numeric strings", () => {
+    expect(_toNum("abcdef")).toEqual("abcdef");
+  });
+  it("does not convert bools", () => {
+    expect(_toNum(false)).toEqual(false);
+    expect(_toNum(true)).toEqual(true);
+  });
+});

package/src/protocols/coercing-serializers.ts

@@ -0,0 +1,72 @@
+/**
+ * @internal
+ *
+ * Used for awsQueryCompatibility trait.
+ */
+export const _toStr = (val: unknown): string | undefined => {
+  if (val == null) {
+    return val as undefined;
+  }
+  if (typeof val === "number" || typeof val === "bigint") {
+    const warning = new Error(`Received number ${val} where a string was expected.`);
+    warning.name = "Warning";
+    console.warn(warning);
+    return String(val);
+  }
+  if (typeof val === "boolean") {
+    const warning = new Error(`Received boolean ${val} where a string was expected.`);
+    warning.name = "Warning";
+    console.warn(warning);
+    return String(val);
+  }
+  return val as string;
+};
+
+/**
+ * @internal
+ *
+ * Used for awsQueryCompatibility trait.
+ */
+export const _toBool = (val: unknown): boolean | undefined => {
+  if (val == null) {
+    return val as undefined;
+  }
+  if (typeof val === "number") {
+    // transmit to service to be rejected.
+  }
+  if (typeof val === "string") {
+    const lowercase = val.toLowerCase();
+    if (val !== "" && lowercase !== "false" && lowercase !== "true") {
+      const warning = new Error(`Received string "${val}" where a boolean was expected.`);
+      warning.name = "Warning";
+      console.warn(warning);
+    }
+    return val !== "" && lowercase !== "false";
+  }
+  return val as boolean;
+};
+
+/**
+ * @internal
+ *
+ * Used for awsQueryCompatibility trait.
+ */
+export const _toNum = (val: unknown): number | undefined => {
+  if (val == null) {
+    return val as undefined;
+  }
+  if (typeof val === "boolean") {
+    // transmit to service to be rejected.
+  }
+  if (typeof val === "string") {
+    const num = Number(val);
+    if (num.toString() !== val) {
+      const warning = new Error(`Received string "${val}" where a number was expected.`);
+      warning.name = "Warning";
+      console.warn(warning);
+      return val as unknown as undefined;
+    }
+    return num;
+  }
+  return val as number;
+};

package/src/protocols/index.ts

@@ -1 +1,2 @@
+export * from "./coercing-serializers";
 export * from "./json/awsExpectUnion";