@aws-sdk/client-s3-control 3.34.0 → 3.35.0

package/src/runtimeConfig.browser.ts

@@ -0,0 +1,45 @@
+import { Sha256 } from "@aws-crypto/sha256-browser";
+import { FetchHttpHandler, streamCollector } from "@aws-sdk/fetch-http-handler";
+import { blobHasher as streamHasher } from "@aws-sdk/hash-blob-browser";
+import { invalidProvider } from "@aws-sdk/invalid-dependency";
+import { Md5 } from "@aws-sdk/md5-js";
+import { DEFAULT_MAX_ATTEMPTS, DEFAULT_RETRY_MODE } from "@aws-sdk/middleware-retry";
+import { fromBase64, toBase64 } from "@aws-sdk/util-base64-browser";
+import { calculateBodyLength } from "@aws-sdk/util-body-length-browser";
+import { defaultUserAgent } from "@aws-sdk/util-user-agent-browser";
+import { fromUtf8, toUtf8 } from "@aws-sdk/util-utf8-browser";
+
+// @ts-ignore: package.json will be imported from dist folders
+import packageInfo from "../package.json";
+import { getRuntimeConfig as getSharedRuntimeConfig } from "./runtimeConfig.shared";
+import { S3ControlClientConfig } from "./S3ControlClient";
+
+/**
+ * @internal
+ */
+export const getRuntimeConfig = (config: S3ControlClientConfig) => {
+  const clientSharedValues = getSharedRuntimeConfig(config);
+  return {
+    ...clientSharedValues,
+    ...config,
+    runtime: "browser",
+    base64Decoder: config?.base64Decoder ?? fromBase64,
+    base64Encoder: config?.base64Encoder ?? toBase64,
+    bodyLengthChecker: config?.bodyLengthChecker ?? calculateBodyLength,
+    credentialDefaultProvider:
+      config?.credentialDefaultProvider ?? ((_: unknown) => () => Promise.reject(new Error("Credential is missing"))),
+    defaultUserAgentProvider:
+      config?.defaultUserAgentProvider ??
+      defaultUserAgent({ serviceId: clientSharedValues.serviceId, clientVersion: packageInfo.version }),
+    maxAttempts: config?.maxAttempts ?? DEFAULT_MAX_ATTEMPTS,
+    md5: config?.md5 ?? Md5,
+    region: config?.region ?? invalidProvider("Region is missing"),
+    requestHandler: config?.requestHandler ?? new FetchHttpHandler(),
+    retryMode: config?.retryMode ?? (() => Promise.resolve(DEFAULT_RETRY_MODE)),
+    sha256: config?.sha256 ?? Sha256,
+    streamCollector: config?.streamCollector ?? streamCollector,
+    streamHasher: config?.streamHasher ?? streamHasher,
+    utf8Decoder: config?.utf8Decoder ?? fromUtf8,
+    utf8Encoder: config?.utf8Encoder ?? toUtf8,
+  };
+};

package/src/runtimeConfig.native.ts

@@ -0,0 +1,17 @@
+import { Sha256 } from "@aws-crypto/sha256-js";
+
+import { getRuntimeConfig as getBrowserRuntimeConfig } from "./runtimeConfig.browser";
+import { S3ControlClientConfig } from "./S3ControlClient";
+
+/**
+ * @internal
+ */
+export const getRuntimeConfig = (config: S3ControlClientConfig) => {
+  const browserDefaults = getBrowserRuntimeConfig(config);
+  return {
+    ...browserDefaults,
+    ...config,
+    runtime: "react-native",
+    sha256: config?.sha256 ?? Sha256,
+  };
+};

package/src/runtimeConfig.shared.ts

@@ -0,0 +1,17 @@
+import { Logger as __Logger } from "@aws-sdk/types";
+import { parseUrl } from "@aws-sdk/url-parser";
+
+import { defaultRegionInfoProvider } from "./endpoints";
+import { S3ControlClientConfig } from "./S3ControlClient";
+
+/**
+ * @internal
+ */
+export const getRuntimeConfig = (config: S3ControlClientConfig) => ({
+  apiVersion: "2018-08-20",
+  disableHostPrefix: config?.disableHostPrefix ?? false,
+  logger: config?.logger ?? ({} as __Logger),
+  regionInfoProvider: config?.regionInfoProvider ?? defaultRegionInfoProvider,
+  serviceId: config?.serviceId ?? "S3 Control",
+  urlParser: config?.urlParser ?? parseUrl,
+});

package/src/runtimeConfig.ts

@@ -0,0 +1,50 @@
+import { decorateDefaultCredentialProvider } from "@aws-sdk/client-sts";
+import { NODE_REGION_CONFIG_FILE_OPTIONS, NODE_REGION_CONFIG_OPTIONS } from "@aws-sdk/config-resolver";
+import { defaultProvider as credentialDefaultProvider } from "@aws-sdk/credential-provider-node";
+import { Hash } from "@aws-sdk/hash-node";
+import { fileStreamHasher as streamHasher } from "@aws-sdk/hash-stream-node";
+import { NODE_MAX_ATTEMPT_CONFIG_OPTIONS, NODE_RETRY_MODE_CONFIG_OPTIONS } from "@aws-sdk/middleware-retry";
+import { loadConfig as loadNodeConfig } from "@aws-sdk/node-config-provider";
+import { NodeHttpHandler, streamCollector } from "@aws-sdk/node-http-handler";
+import { emitWarningIfUnsupportedVersion } from "@aws-sdk/smithy-client";
+import { HashConstructor as __HashConstructor } from "@aws-sdk/types";
+import { fromBase64, toBase64 } from "@aws-sdk/util-base64-node";
+import { calculateBodyLength } from "@aws-sdk/util-body-length-node";
+import { defaultUserAgent } from "@aws-sdk/util-user-agent-node";
+import { fromUtf8, toUtf8 } from "@aws-sdk/util-utf8-node";
+
+// @ts-ignore: package.json will be imported from dist folders
+import packageInfo from "../package.json";
+import { getRuntimeConfig as getSharedRuntimeConfig } from "./runtimeConfig.shared";
+import { S3ControlClientConfig } from "./S3ControlClient";
+
+/**
+ * @internal
+ */
+export const getRuntimeConfig = (config: S3ControlClientConfig) => {
+  emitWarningIfUnsupportedVersion(process.version);
+  const clientSharedValues = getSharedRuntimeConfig(config);
+  return {
+    ...clientSharedValues,
+    ...config,
+    runtime: "node",
+    base64Decoder: config?.base64Decoder ?? fromBase64,
+    base64Encoder: config?.base64Encoder ?? toBase64,
+    bodyLengthChecker: config?.bodyLengthChecker ?? calculateBodyLength,
+    credentialDefaultProvider:
+      config?.credentialDefaultProvider ?? decorateDefaultCredentialProvider(credentialDefaultProvider),
+    defaultUserAgentProvider:
+      config?.defaultUserAgentProvider ??
+      defaultUserAgent({ serviceId: clientSharedValues.serviceId, clientVersion: packageInfo.version }),
+    maxAttempts: config?.maxAttempts ?? loadNodeConfig(NODE_MAX_ATTEMPT_CONFIG_OPTIONS),
+    md5: config?.md5 ?? Hash.bind(null, "md5"),
+    region: config?.region ?? loadNodeConfig(NODE_REGION_CONFIG_OPTIONS, NODE_REGION_CONFIG_FILE_OPTIONS),
+    requestHandler: config?.requestHandler ?? new NodeHttpHandler(),
+    retryMode: config?.retryMode ?? loadNodeConfig(NODE_RETRY_MODE_CONFIG_OPTIONS),
+    sha256: config?.sha256 ?? Hash.bind(null, "sha256"),
+    streamCollector: config?.streamCollector ?? streamCollector,
+    streamHasher: config?.streamHasher ?? streamHasher,
+    utf8Decoder: config?.utf8Decoder ?? fromUtf8,
+    utf8Encoder: config?.utf8Encoder ?? toUtf8,
+  };
+};

package/test/S3Control.spec.ts

@@ -0,0 +1,134 @@
+/// <reference types="mocha" />
+import { FinalizeRequestMiddleware } from "@aws-sdk/types";
+import { expect } from "chai";
+
+import { S3Control } from "../src/S3Control";
+
+describe("S3Control Client", () => {
+  // Middleware intercept request and return it before reaching the HTTP client. It records the request and context
+  // and return them in the Metadata.
+  const interceptionMiddleware: FinalizeRequestMiddleware<any, any> = (next, context) => (args) => {
+    return Promise.resolve({ output: { $metadata: { request: args.request } }, response: "" as any });
+  };
+  const region = "us-east-1";
+  const credentials = { accessKeyId: "AKID", secretAccessKey: "SECRET" };
+  const s3Control = new S3Control({ region, credentials });
+  s3Control.middlewareStack.add(interceptionMiddleware, { step: "finalizeRequest", name: "interceptionMiddleware" });
+  const HEADER_OUTPOST_ID = "x-amz-outpost-id";
+  const HEADER_ACCOUNT_ID = "x-amz-account-id";
+  const dateStr = new Date().toISOString().substr(0, 10).replace(/[\-:]/g, "");
+
+  describe("CreateBucket", () => {
+    it("should populate correct endpoint and signing region", async () => {
+      const {
+        // @ts-ignore request is set in $metadata by interception middleware.
+        $metadata: { request },
+      } = await s3Control.createBucket({ Bucket: "Bucket" });
+      expect(request.hostname).eql(`s3-control.${region}.amazonaws.com`);
+      expect(request.headers["authorization"]).contains(
+        `Credential=${credentials.accessKeyId}/${dateStr}/${region}/s3/aws4_request`
+      );
+    });
+
+    it("should populate correct endpoint and signing region if OutpostId is supplied", async () => {
+      const OutpostId = "123456789012";
+      const {
+        // @ts-ignore request is set in $metadata by interception middleware.
+        $metadata: { request },
+      } = await s3Control.createBucket({ Bucket: "Bucket", OutpostId });
+      expect(request.hostname).eql(`s3-outposts.${region}.amazonaws.com`);
+      expect(request.headers[HEADER_OUTPOST_ID]).eql(OutpostId);
+      expect(request.headers["authorization"]).contains(
+        `Credential=${credentials.accessKeyId}/${dateStr}/${region}/s3-outposts/aws4_request`
+      );
+    });
+  });
+
+  describe("ListRegionalBuckets", () => {
+    const AccountId = "123456789012";
+    it("should populate correct endpoint and signing region", async () => {
+      const {
+        // @ts-ignore request is set in $metadata by interception middleware.
+        $metadata: { request },
+      } = await s3Control.listRegionalBuckets({ AccountId });
+      expect(request.hostname).eql(`${AccountId}.s3-control.${region}.amazonaws.com`);
+      expect(request.headers["authorization"]).contains(
+        `Credential=${credentials.accessKeyId}/${dateStr}/${region}/s3/aws4_request`
+      );
+    });
+
+    it("should populate correct endpoint and signing region if OutpostId is supplied", async () => {
+      const OutpostId = "123456789012";
+      const {
+        // @ts-ignore request is set in $metadata by interception middleware.
+        $metadata: { request },
+      } = await s3Control.listRegionalBuckets({ AccountId, OutpostId });
+      expect(request.hostname).eql(`s3-outposts.${region}.amazonaws.com`);
+      expect(request.headers[HEADER_OUTPOST_ID]).eql(OutpostId);
+      expect(request.headers[HEADER_ACCOUNT_ID]).eql(AccountId);
+      expect(request.headers["authorization"]).contains(
+        `Credential=${credentials.accessKeyId}/${dateStr}/${region}/s3-outposts/aws4_request`
+      );
+    });
+  });
+
+  // Use GetAccessPointCommand to validate the customizations for Access Point ARN customizations
+  describe("Outposts Access Point ARN", () => {
+    const AccountId = "123456789012";
+    const OutpostId = "op-01234567890123456";
+    const accesspointArn = `arn:aws:s3-outposts:${region}:${AccountId}:outpost:${OutpostId}:accesspoint:myaccesspoint`;
+    it("should populate correct endpoint if Access Point name is non-ARN", async () => {
+      const {
+        // @ts-ignore request is set in $metadata by interception middleware.
+        $metadata: { request },
+      } = await s3Control.getAccessPoint({ Name: "FakeAccessPoint", AccountId });
+      expect(request.hostname).eql(`${AccountId}.s3-control.${region}.amazonaws.com`);
+      expect(request.headers["authorization"]).contains(
+        `Credential=${credentials.accessKeyId}/${dateStr}/${region}/s3/aws4_request`
+      );
+    });
+
+    it("should populate correct endpoint and signing region if Access Point name is ARN", async () => {
+      const {
+        // @ts-ignore request is set in $metadata by interception middleware.
+        $metadata: { request },
+      } = await s3Control.getAccessPoint({ Name: accesspointArn });
+      expect(request.hostname).eql(`s3-outposts.${region}.amazonaws.com`);
+      expect(request.headers[HEADER_OUTPOST_ID]).eql(OutpostId);
+      expect(request.headers[HEADER_ACCOUNT_ID]).eql(AccountId);
+      expect(request.headers["authorization"]).contains(
+        `Credential=${credentials.accessKeyId}/${dateStr}/${region}/s3-outposts/aws4_request`
+      );
+    });
+  });
+
+  // Use GetBucketCommand to validate the customizations for Bucket ARN customizations
+  describe("Outposts Bucket ARN", () => {
+    const AccountId = "123456789012";
+    const OutpostId = "op-01234567890123456";
+    const bucketArn = `arn:aws:s3-outposts:${region}:${AccountId}:outpost/${OutpostId}/bucket/bucket-id"`;
+    it("should populate correct endpoint if Bucket name is non-ARN", async () => {
+      const {
+        // @ts-ignore request is set in $metadata by interception middleware.
+        $metadata: { request },
+      } = await s3Control.getBucket({ Bucket: "BucketName", AccountId });
+      expect(request.hostname).eql(`${AccountId}.s3-control.${region}.amazonaws.com`);
+      expect(request.headers["authorization"]).contains(
+        `Credential=${credentials.accessKeyId}/${dateStr}/${region}/s3/aws4_request`
+      );
+    });
+
+    it("should populate correct endpoint and signing region if Bucket name is ARN", async () => {
+      const {
+        // @ts-ignore request is set in $metadata by interception middleware.
+        $metadata: { request },
+      } = await s3Control.getBucket({ Bucket: bucketArn });
+      expect(request.hostname).eql(`s3-outposts.${region}.amazonaws.com`);
+      expect(request.headers[HEADER_OUTPOST_ID]).eql(OutpostId);
+      expect(request.headers[HEADER_ACCOUNT_ID]).eql(AccountId);
+      expect(request.headers["authorization"]).contains(
+        `Credential=${credentials.accessKeyId}/${dateStr}/${region}/s3-outposts/aws4_request`
+      );
+    });
+  });
+});

package/tsconfig.es.json

@@ -5,6 +5,6 @@
     "module": "esnext",
     "moduleResolution": "node",
     "lib": ["dom", "es5", "es2015.promise", "es2015.collection", "es2015.iterable", "es2015.symbol.wellknown"],
-    "outDir": "dist/es"
+    "outDir": "dist-es"
   }
 }

package/tsconfig.json

@@ -11,7 +11,8 @@
     "incremental": true,
     "resolveJsonModule": true,
     "esModuleInterop": true,
-    "outDir": "dist/cjs",
+    "rootDir": "src",
+    "outDir": "dist-cjs",
     "removeComments": true,
     "types": ["mocha", "node"]
   },
@@ -28,5 +29,6 @@
     "out": "docs",
     "theme": "minimal",
     "plugin": ["@aws-sdk/client-documentation-generator"]
-  }
+  },
+  "exclude": ["test/**/*"]
 }

package/tsconfig.types.json

@@ -3,6 +3,7 @@
   "compilerOptions": {
     "removeComments": false,
     "declaration": true,
-    "declarationDir": "dist/types"
-  }
+    "declarationDir": "dist-types"
+  },
+  "exclude": ["test/**/*", "dist-types/**/*"]
 }

package/S3Control.spec.ts

@@ -1,133 +0,0 @@
-/// <reference types="mocha" />
-import { expect } from "chai";
-import { S3Control } from "./S3Control";
-import { FinalizeRequestMiddleware } from "@aws-sdk/types";
-
-describe("S3Control Client", () => {
-  // Middleware intercept request and return it before reaching the HTTP client. It records the request and context
-  // and return them in the Metadata.
-  const interceptionMiddleware: FinalizeRequestMiddleware<any, any> = (next, context) => (args) => {
-    return Promise.resolve({ output: { $metadata: { request: args.request } }, response: "" as any });
-  };
-  const region = "us-east-1";
-  const credentials = { accessKeyId: "AKID", secretAccessKey: "SECRET" };
-  const s3Control = new S3Control({ region, credentials });
-  s3Control.middlewareStack.add(interceptionMiddleware, { step: "finalizeRequest", name: "interceptionMiddleware" });
-  const HEADER_OUTPOST_ID = "x-amz-outpost-id";
-  const HEADER_ACCOUNT_ID = "x-amz-account-id";
-  const dateStr = new Date().toISOString().substr(0, 10).replace(/[\-:]/g, "");
-
-  describe("CreateBucket", () => {
-    it("should populate correct endpoint and signing region", async () => {
-      const {
-        // @ts-ignore request is set in $metadata by interception middleware.
-        $metadata: { request },
-      } = await s3Control.createBucket({ Bucket: "Bucket" });
-      expect(request.hostname).eql(`s3-control.${region}.amazonaws.com`);
-      expect(request.headers["authorization"]).contains(
-        `Credential=${credentials.accessKeyId}/${dateStr}/${region}/s3/aws4_request`
-      );
-    });
-
-    it("should populate correct endpoint and signing region if OutpostId is supplied", async () => {
-      const OutpostId = "123456789012";
-      const {
-        // @ts-ignore request is set in $metadata by interception middleware.
-        $metadata: { request },
-      } = await s3Control.createBucket({ Bucket: "Bucket", OutpostId });
-      expect(request.hostname).eql(`s3-outposts.${region}.amazonaws.com`);
-      expect(request.headers[HEADER_OUTPOST_ID]).eql(OutpostId);
-      expect(request.headers["authorization"]).contains(
-        `Credential=${credentials.accessKeyId}/${dateStr}/${region}/s3-outposts/aws4_request`
-      );
-    });
-  });
-
-  describe("ListRegionalBuckets", () => {
-    const AccountId = "123456789012";
-    it("should populate correct endpoint and signing region", async () => {
-      const {
-        // @ts-ignore request is set in $metadata by interception middleware.
-        $metadata: { request },
-      } = await s3Control.listRegionalBuckets({ AccountId });
-      expect(request.hostname).eql(`${AccountId}.s3-control.${region}.amazonaws.com`);
-      expect(request.headers["authorization"]).contains(
-        `Credential=${credentials.accessKeyId}/${dateStr}/${region}/s3/aws4_request`
-      );
-    });
-
-    it("should populate correct endpoint and signing region if OutpostId is supplied", async () => {
-      const OutpostId = "123456789012";
-      const {
-        // @ts-ignore request is set in $metadata by interception middleware.
-        $metadata: { request },
-      } = await s3Control.listRegionalBuckets({ AccountId, OutpostId });
-      expect(request.hostname).eql(`s3-outposts.${region}.amazonaws.com`);
-      expect(request.headers[HEADER_OUTPOST_ID]).eql(OutpostId);
-      expect(request.headers[HEADER_ACCOUNT_ID]).eql(AccountId);
-      expect(request.headers["authorization"]).contains(
-        `Credential=${credentials.accessKeyId}/${dateStr}/${region}/s3-outposts/aws4_request`
-      );
-    });
-  });
-
-  // Use GetAccessPointCommand to validate the customizations for Access Point ARN customizations
-  describe("Outposts Access Point ARN", () => {
-    const AccountId = "123456789012";
-    const OutpostId = "op-01234567890123456";
-    const accesspointArn = `arn:aws:s3-outposts:${region}:${AccountId}:outpost:${OutpostId}:accesspoint:myaccesspoint`;
-    it("should populate correct endpoint if Access Point name is non-ARN", async () => {
-      const {
-        // @ts-ignore request is set in $metadata by interception middleware.
-        $metadata: { request },
-      } = await s3Control.getAccessPoint({ Name: "FakeAccessPoint", AccountId });
-      expect(request.hostname).eql(`${AccountId}.s3-control.${region}.amazonaws.com`);
-      expect(request.headers["authorization"]).contains(
-        `Credential=${credentials.accessKeyId}/${dateStr}/${region}/s3/aws4_request`
-      );
-    });
-
-    it("should populate correct endpoint and signing region if Access Point name is ARN", async () => {
-      const {
-        // @ts-ignore request is set in $metadata by interception middleware.
-        $metadata: { request },
-      } = await s3Control.getAccessPoint({ Name: accesspointArn });
-      expect(request.hostname).eql(`s3-outposts.${region}.amazonaws.com`);
-      expect(request.headers[HEADER_OUTPOST_ID]).eql(OutpostId);
-      expect(request.headers[HEADER_ACCOUNT_ID]).eql(AccountId);
-      expect(request.headers["authorization"]).contains(
-        `Credential=${credentials.accessKeyId}/${dateStr}/${region}/s3-outposts/aws4_request`
-      );
-    });
-  });
-
-  // Use GetBucketCommand to validate the customizations for Bucket ARN customizations
-  describe("Outposts Bucket ARN", () => {
-    const AccountId = "123456789012";
-    const OutpostId = "op-01234567890123456";
-    const bucketArn = `arn:aws:s3-outposts:${region}:${AccountId}:outpost/${OutpostId}/bucket/bucket-id"`;
-    it("should populate correct endpoint if Bucket name is non-ARN", async () => {
-      const {
-        // @ts-ignore request is set in $metadata by interception middleware.
-        $metadata: { request },
-      } = await s3Control.getBucket({ Bucket: "BucketName", AccountId });
-      expect(request.hostname).eql(`${AccountId}.s3-control.${region}.amazonaws.com`);
-      expect(request.headers["authorization"]).contains(
-        `Credential=${credentials.accessKeyId}/${dateStr}/${region}/s3/aws4_request`
-      );
-    });
-
-    it("should populate correct endpoint and signing region if Bucket name is ARN", async () => {
-      const {
-        // @ts-ignore request is set in $metadata by interception middleware.
-        $metadata: { request },
-      } = await s3Control.getBucket({ Bucket: bucketArn });
-      expect(request.hostname).eql(`s3-outposts.${region}.amazonaws.com`);
-      expect(request.headers[HEADER_OUTPOST_ID]).eql(OutpostId);
-      expect(request.headers[HEADER_ACCOUNT_ID]).eql(AccountId);
-      expect(request.headers["authorization"]).contains(
-        `Credential=${credentials.accessKeyId}/${dateStr}/${region}/s3-outposts/aws4_request`
-      );
-    });
-  });
-});