chore: update dependencies + streaming body + add example (#24)

Author: lucacasonato

README.md

@@ -1,12 +1,46 @@
 # deno_s3
 
+![ci](https://github.com/lucacasonato/deno_aws_sign_v4/workflows/ci/badge.svg)
+[![deno doc](https://doc.deno.land/badge.svg)](https://doc.deno.land/https/deno.land/x/[email protected]/mod.ts)
+
 Amazon S3 for Deno
 
 > ⚠️ This project is work in progress. Expect breaking changes.
 
-## Examples
+## Example
+
+```ts
+import { S3Bucket } from "https://deno.land/x/[email protected]/mod.ts";
+
+const bucket = new S3Bucket({
+  accessKeyID: Deno.env.get("AWS_ACCESS_KEY_ID")!,
+  secretKey: Deno.env.get("AWS_SECRET_ACCESS_KEY")!,
+  bucket: "test",
+  region: "us-east-1",
+  endpointURL: Deno.env.get("S3_ENDPOINT_URL"),
+});
+
+const encoder = new TextEncoder();
 
-Coming soon...
+// Put an object into a bucket.
+await bucket.putObject("test", encoder.encode("Test1"), {
+  contentType: "text/plain",
+});
+
+// Retrieve an object form a bucket.
+const { body } = await bucket.getObject("test");
+const data = await new Response(body).text();
+console.log("File 'test' contains:", data);
+
+// List objects in the bucket.
+const list = bucket.listAllObjects({});
+for await (const obj of list) {
+  console.log("Item in bucket:", obj.key);
+}
+
+// Delete an object from a bucket.
+await bucket.deleteObject("test");
+```
 
 ## Contributing
 

deps.ts

@@ -2,17 +2,17 @@ export {
   AWSSignerV4,
   toAmz,
   toDateStamp,
-} from "https://deno.land/x/aws_sign_v4@0.1.5/mod.ts";
+} from "https://deno.land/x/aws_sign_v4@1.0.0/mod.ts";
 export type {
   Credentials,
   Signer,
-} from "https://deno.land/x/aws_sign_v4@0.1.5/mod.ts";
-import { createHash } from "https://deno.land/std@0.83.0/hash/mod.ts";
+} from "https://deno.land/x/aws_sign_v4@1.0.0/mod.ts";
+import { createHash } from "https://deno.land/std@0.84.0/hash/mod.ts";
 export function sha256Hex(data: string | Uint8Array): string {
   const hasher = createHash("sha256");
   hasher.update(data);
   return hasher.toString("hex");
 }
 export { default as parseXML } from "https://raw.githubusercontent.com/nekobato/deno-xml-parser/0bc4c2bd2f5fad36d274279978ca57eec57c680c/index.ts";
 export { decode as decodeXMLEntities } from "https://deno.land/x/[email protected]/lib/xml-entities.js";
-export { pooledMap } from "https://deno.land/std@0.83.0/async/pool.ts";
+export { pooledMap } from "https://deno.land/std@0.84.0/async/pool.ts";

mod.ts

@@ -1,13 +1,21 @@
 export * from "./src/bucket.ts";
 export type {
+  CommonPrefix,
+  CopyDirective,
   CopyObjectOptions,
   CopyObjectResponse,
   DeleteObjectOptions,
   DeleteObjectResponse,
   GetObjectOptions,
   GetObjectResponse,
+  HeadObjectResponse,
+  ListAllObjectsOptions,
   ListObjectsOptions,
   ListObjectsResponse,
+  LockMode,
   PutObjectOptions,
   PutObjectResponse,
+  ReplicationStatus,
+  S3Object,
+  StorageClass,
 } from "./src/types.ts";

src/bucket.ts

@@ -154,7 +154,7 @@ export class S3Bucket {
       etag: JSON.parse(res.headers.get("etag")!),
       lastModified: new Date(res.headers.get("Last-Modified")!),
       missingMeta: parseInt(res.headers.get("x-amz-missing-meta") ?? "0"),
-      storageClass: res.headers.get("x-amz-storage-class") as StorageClass ??
+      storageClass: (res.headers.get("x-amz-storage-class") as StorageClass) ??
         "STANDARD",
       taggingCount: parseInt(res.headers.get("x-amz-tagging-count") ?? "0"),
 
@@ -164,13 +164,13 @@ export class S3Bucket {
       contentLanguage: res.headers.get("Content-Language") ?? undefined,
       contentType: res.headers.get("Content-Type") ?? undefined,
       expires: expires ? new Date(expires) : undefined,
-      legalHold: legalHold ? true : (legalHold === "OFF" ? false : undefined),
-      lockMode: res.headers.get("x-amz-object-lock-mode") as LockMode ??
+      legalHold: legalHold ? true : legalHold === "OFF" ? false : undefined,
+      lockMode: (res.headers.get("x-amz-object-lock-mode") as LockMode) ??
         undefined,
       lockRetainUntil: lockRetainUntil ? new Date(lockRetainUntil) : undefined,
       partsCount: partsCount ? parseInt(partsCount) : undefined,
       replicationStatus:
-        res.headers.get("x-amz-replication-status") as ReplicationStatus ??
+        (res.headers.get("x-amz-replication-status") as ReplicationStatus) ??
           undefined,
       versionId: res.headers.get("x-amz-version-id") ?? undefined,
       websiteRedirectLocation:
@@ -245,14 +245,18 @@ export class S3Bucket {
       }
     }
 
+    if (res.body == null) {
+      throw new S3Error("S3 did not return a body for a getObject call.", "");
+    }
+
     return {
-      body: new Uint8Array(await res.arrayBuffer()),
+      body: res.body,
       contentLength: parseInt(res.headers.get("Content-Length")!),
       deleteMarker: res.headers.get("x-amz-delete-marker") === "true",
       etag: JSON.parse(res.headers.get("etag")!),
       lastModified: new Date(res.headers.get("Last-Modified")!),
       missingMeta: parseInt(res.headers.get("x-amz-missing-meta") ?? "0"),
-      storageClass: res.headers.get("x-amz-storage-class") as StorageClass ??
+      storageClass: (res.headers.get("x-amz-storage-class") as StorageClass) ??
         "STANDARD",
       taggingCount: parseInt(res.headers.get("x-amz-tagging-count") ?? "0"),
 
@@ -262,13 +266,13 @@ export class S3Bucket {
       contentLanguage: res.headers.get("Content-Language") ?? undefined,
       contentType: res.headers.get("Content-Type") ?? undefined,
       expires: expires ? new Date(expires) : undefined,
-      legalHold: legalHold ? true : (legalHold === "OFF" ? false : undefined),
-      lockMode: res.headers.get("x-amz-object-lock-mode") as LockMode ??
+      legalHold: legalHold ? true : legalHold === "OFF" ? false : undefined,
+      lockMode: (res.headers.get("x-amz-object-lock-mode") as LockMode) ??
         undefined,
       lockRetainUntil: lockRetainUntil ? new Date(lockRetainUntil) : undefined,
       partsCount: partsCount ? parseInt(partsCount) : undefined,
       replicationStatus:
-        res.headers.get("x-amz-replication-status") as ReplicationStatus ??
+        (res.headers.get("x-amz-replication-status") as ReplicationStatus) ??
           undefined,
       versionId: res.headers.get("x-amz-version-id") ?? undefined,
       websiteRedirectLocation:
@@ -295,12 +299,7 @@ export class S3Bucket {
       params["continuation-token"] = options.continuationToken;
     }
 
-    const res = await this._doRequest(
-      `/`,
-      params,
-      "GET",
-      headers,
-    );
+    const res = await this._doRequest(`/`, params, "GET", headers);
     if (res.status === 404) {
       // clean up http body
       await res.arrayBuffer();
@@ -345,37 +344,38 @@ export class S3Bucket {
       isTruncated: extractContent(root, "IsTruncated") === "true"
         ? true
         : false,
-      contents: root.children.filter((node) => node.name === "Contents").map<
-        S3Object
-      >((s3obj) => {
-        let lastmod: Date | undefined;
-        let content = extractContent(s3obj, "LastModified");
-        if (content) {
-          lastmod = new Date(content);
-        }
+      contents: root.children
+        .filter((node) => node.name === "Contents")
+        .map<S3Object>((s3obj) => {
+          let lastmod: Date | undefined;
+          let content = extractContent(s3obj, "LastModified");
+          if (content) {
+            lastmod = new Date(content);
+          }
 
-        let size: number | undefined;
-        content = extractContent(s3obj, "Size");
-        if (content) {
-          size = parseInt(content);
-        }
+          let size: number | undefined;
+          content = extractContent(s3obj, "Size");
+          if (content) {
+            size = parseInt(content);
+          }
 
-        return {
-          key: extractContent(s3obj, "Key"),
-          lastModified: lastmod,
-          eTag: extractContent(s3obj, "ETag"),
-          size: size,
-          storageClass: extractContent(s3obj, "StorageClass"),
-          owner: extractContent(s3obj, "Owner"),
-        };
-      }),
+          return {
+            key: extractContent(s3obj, "Key"),
+            lastModified: lastmod,
+            eTag: extractContent(s3obj, "ETag"),
+            size: size,
+            storageClass: extractContent(s3obj, "StorageClass"),
+            owner: extractContent(s3obj, "Owner"),
+          };
+        }),
       name: extractContent(root, "Name"),
       prefix: extractContent(root, "Prefix"),
       delimiter: extractContent(root, "Delimiter"),
       maxKeys: maxkeys,
-      commonPrefixes: extractField(root, "CommonPrefixes")?.children.map<
-        CommonPrefix
-      >((prefix) => {
+      commonPrefixes: extractField(
+        root,
+        "CommonPrefixes",
+      )?.children.map<CommonPrefix>((prefix) => {
         return {
           prefix: extractContent(prefix, "Prefix"),
         };
@@ -449,8 +449,9 @@ export class S3Bucket {
     }
     if (options?.lockMode) headers["x-amz-object-lock-mode"] = options.lockMode;
     if (options?.lockRetainUntil) {
-      headers["x-amz-object-lock-retain-until-date"] = options.lockRetainUntil
-        .toString();
+      headers[
+        "x-amz-object-lock-retain-until-date"
+      ] = options.lockRetainUntil.toString();
     }
     if (options?.legalHold) {
       headers["x-amz-object-lock-legal-hold"] = options.legalHold
@@ -463,13 +464,7 @@ export class S3Bucket {
       }
     }
 
-    const resp = await this._doRequest(
-      key,
-      {},
-      "PUT",
-      headers,
-      body,
-    );
+    const resp = await this._doRequest(key, {}, "PUT", headers, body);
     if (resp.status !== 200) {
       throw new S3Error(
         `Failed to put object: ${resp.status} ${resp.statusText}`,
@@ -490,8 +485,10 @@ export class S3Bucket {
     options?: CopyObjectOptions,
   ): Promise<PutObjectResponse> {
     const headers: Params = {};
-    headers["x-amz-copy-source"] = new URL(encodeURIS3(source), this.#host)
-      .toString();
+    headers["x-amz-copy-source"] = new URL(
+      encodeURIS3(source),
+      this.#host,
+    ).toString();
     if (options?.acl) headers["x-amz-acl"] = options.acl;
     if (options?.cacheControl) headers["Cache-Control"] = options.cacheControl;
     if (options?.contentDisposition) {
@@ -511,14 +508,14 @@ export class S3Bucket {
       headers["x-amz-copy-source-if-none-match"] = options.copyOnlyIfNoneMatch;
     }
     if (options?.copyOnlyIfModifiedSince) {
-      headers["x-amz-copy-source-if-modified-since"] = options
-        .copyOnlyIfModifiedSince
-        .toISOString();
+      headers[
+        "x-amz-copy-source-if-modified-since"
+      ] = options.copyOnlyIfModifiedSince.toISOString();
     }
     if (options?.copyOnlyIfUnmodifiedSince) {
-      headers["x-amz-copy-source-if-unmodified-since"] = options
-        .copyOnlyIfUnmodifiedSince
-        .toISOString();
+      headers[
+        "x-amz-copy-source-if-unmodified-since"
+      ] = options.copyOnlyIfUnmodifiedSince.toISOString();
     }
     if (options?.grantFullControl) {
       headers["x-amz-grant-full-control"] = options.grantFullControl;
@@ -544,8 +541,9 @@ export class S3Bucket {
     }
     if (options?.lockMode) headers["x-amz-object-lock-mode"] = options.lockMode;
     if (options?.lockRetainUntil) {
-      headers["x-amz-object-lock-retain-until-date"] = options.lockRetainUntil
-        .toString();
+      headers[
+        "x-amz-object-lock-retain-until-date"
+      ] = options.lockRetainUntil.toString();
     }
     if (options?.legalHold) {
       headers["x-amz-object-lock-legal-hold"] = options.legalHold
@@ -559,12 +557,7 @@ export class S3Bucket {
       headers["x-amz-tagging-directive"] = options.taggingDirective;
     }
 
-    const resp = await this._doRequest(
-      destination,
-      {},
-      "PUT",
-      headers,
-    );
+    const resp = await this._doRequest(destination, {}, "PUT", headers);
     if (resp.status !== 200) {
       throw new S3Error(
         `Failed to copy object: ${resp.status} ${resp.statusText}`,
@@ -629,8 +622,12 @@ function encodeURIS3(input: string): string {
   let result = "";
   for (const ch of input) {
     if (
-      (ch >= "A" && ch <= "Z") || (ch >= "a" && ch <= "z") ||
-      (ch >= "0" && ch <= "9") || ch == "_" || ch == "-" || ch == "~" ||
+      (ch >= "A" && ch <= "Z") ||
+      (ch >= "a" && ch <= "z") ||
+      (ch >= "0" && ch <= "9") ||
+      ch == "_" ||
+      ch == "-" ||
+      ch == "~" ||
       ch == "."
     ) {
       result += ch;
@@ -646,7 +643,9 @@ function encodeURIS3(input: string): string {
 const encoder = new TextEncoder();
 
 function stringToHex(input: string) {
-  return [...encoder.encode(input)].map((s) => "%" + s.toString(16)).join("")
+  return [...encoder.encode(input)]
+    .map((s) => "%" + s.toString(16))
+    .join("")
     .toUpperCase();
 }
 
@@ -674,17 +673,11 @@ function extractRoot(doc: Document, name: string): Xml {
   return doc.root;
 }
 
-function extractField(
-  node: Xml,
-  name: string,
-): Xml | undefined {
+function extractField(node: Xml, name: string): Xml | undefined {
   return node.children.find((node) => node.name === name);
 }
 
-function extractContent(
-  node: Xml,
-  name: string,
-): string | undefined {
+function extractContent(node: Xml, name: string): string | undefined {
   const field = extractField(node, name);
   const content = field?.content;
   if (content === undefined) {