lean-s3 0.3.1 → 0.3.2

package/dist/index.d.ts

@@ -22,6 +22,7 @@ declare class S3BucketEntry {
 
 declare const write: unique symbol;
 declare const stream: unique symbol;
+declare const signedRequest: unique symbol;
 interface S3ClientOptions {
     bucket: string;
     region: string;
@@ -209,7 +210,7 @@ declare class S3Client {
      * TODO: Maybe move this into a separate free function?
      * @internal
      */
-    _signedRequest(method: HttpMethod, pathWithoutBucket: string, query: string | undefined, body: UndiciBodyInit | undefined, additionalSignedHeaders: Record<string, string> | undefined, additionalUnsignedHeaders: Record<string, string> | undefined, contentHash: Buffer | undefined, bucket: string | undefined, signal?: AbortSignal | undefined): Promise<Dispatcher.ResponseData<null>>;
+    [signedRequest](method: HttpMethod, pathWithoutBucket: string, query: string | undefined, body: UndiciBodyInit | undefined, additionalSignedHeaders: Record<string, string> | undefined, additionalUnsignedHeaders: Record<string, string> | undefined, contentHash: Buffer | undefined, bucket: string | undefined, signal?: AbortSignal | undefined): Promise<Dispatcher.ResponseData<null>>;
     /**
      * @internal
      * @param {import("./index.d.ts").UndiciBodyInit} data TODO
@@ -275,13 +276,10 @@ declare class S3File {
      */
     delete({ signal }?: Partial<S3FileDeleteOptions>): Promise<void>;
     toString(): string;
-    /** @returns {Promise<unknown>} */
     json(): Promise<unknown>;
-    /** @returns {Promise<ArrayBuffer>} */
+    bytes(): Promise<Uint8Array>;
     arrayBuffer(): Promise<ArrayBuffer>;
-    /** @returns {Promise<string>} */
     text(): Promise<string>;
-    /** @returns {Promise<Blob>} */
     blob(): Promise<Blob>;
     /** @returns {ReadableStream<Uint8Array>} */
     stream(): ReadableStream<Uint8Array>;

package/dist/index.js

@@ -292,9 +292,36 @@ function parseAndGetXmlError(body, path) {
   });
 }
 
+// src/request.ts
+function getAuthorizationHeader(keyCache, method, path, query, date, sortedSignedHeaders, region, contentHashStr, accessKeyId, secretAccessKey) {
+  const dataDigest = createCanonicalDataDigest(
+    method,
+    path,
+    query,
+    sortedSignedHeaders,
+    contentHashStr
+  );
+  const signingKey = keyCache.computeIfAbsent(
+    date,
+    region,
+    accessKeyId,
+    secretAccessKey
+  );
+  const signature = signCanonicalDataHash(
+    signingKey,
+    dataDigest,
+    date,
+    region
+  );
+  const signedHeadersSpec = Object.keys(sortedSignedHeaders).join(";");
+  const credentialSpec = `${accessKeyId}/${date.date}/${region}/s3/aws4_request`;
+  return `AWS4-HMAC-SHA256 Credential=${credentialSpec}, SignedHeaders=${signedHeadersSpec}, Signature=${signature}`;
+}
+
 // src/S3Client.ts
 var write = Symbol("write");
 var stream = Symbol("stream");
+var signedRequest = Symbol("signedRequest");
 var xmlParser2 = new XMLParser2();
 var xmlBuilder = new XMLBuilder({
   attributeNamePrefix: "$",
@@ -456,7 +483,7 @@ var S3Client = class {
         }))
       }
     });
-    const response = await this._signedRequest(
+    const response = await this[signedRequest](
       "POST",
       "",
       "delete=",
@@ -538,7 +565,7 @@ var S3Client = class {
       }) : void 0;
     }
     const additionalSignedHeaders = body ? { "content-md5": md5Base64(body) } : void 0;
-    const response = await this._signedRequest(
+    const response = await this[signedRequest](
       "PUT",
       "",
       void 0,
@@ -567,7 +594,7 @@ var S3Client = class {
    */
   async deleteBucket(name, options) {
     ensureValidBucketName(name);
-    const response = await this._signedRequest(
+    const response = await this[signedRequest](
       "DELETE",
       "",
       void 0,
@@ -595,7 +622,7 @@ var S3Client = class {
    */
   async bucketExists(name, options) {
     ensureValidBucketName(name);
-    const response = await this._signedRequest(
+    const response = await this[signedRequest](
       "HEAD",
       "",
       void 0,
@@ -669,7 +696,7 @@ var S3Client = class {
       }
       query += `&start-after=${encodeURIComponent(options.startAfter)}`;
     }
-    const response = await this._signedRequest(
+    const response = await this[signedRequest](
       "GET",
       "",
       query,
@@ -720,7 +747,7 @@ var S3Client = class {
    * TODO: Maybe move this into a separate free function?
    * @internal
    */
-  async _signedRequest(method, pathWithoutBucket, query, body, additionalSignedHeaders, additionalUnsignedHeaders, contentHash, bucket, signal = void 0) {
+  async [signedRequest](method, pathWithoutBucket, query, body, additionalSignedHeaders, additionalUnsignedHeaders, contentHash, bucket, signal = void 0) {
     const endpoint = this.#options.endpoint;
     const region = this.#options.region;
     const effectiveBucket = bucket ?? this.#options.bucket;
@@ -748,7 +775,8 @@ var S3Client = class {
         dispatcher: this.#dispatcher,
         headers: {
           ...headersToBeSigned,
-          authorization: this.#getAuthorizationHeader(
+          authorization: getAuthorizationHeader(
+            this.#keyCache,
             method,
             url.pathname,
             query ?? "",
@@ -799,7 +827,8 @@ var S3Client = class {
         dispatcher: this.#dispatcher,
         headers: {
           ...headersToBeSigned,
-          authorization: this.#getAuthorizationHeader(
+          authorization: getAuthorizationHeader(
+            this.#keyCache,
             "PUT",
             url.pathname,
             url.search,
@@ -866,7 +895,8 @@ var S3Client = class {
           dispatcher: this.#dispatcher,
           headers: {
             ...headersToBeSigned,
-            authorization: this.#getAuthorizationHeader(
+            authorization: getAuthorizationHeader(
+              this.#keyCache,
               "GET",
               url.pathname,
               url.search,
@@ -953,30 +983,6 @@ var S3Client = class {
       }
     });
   }
-  #getAuthorizationHeader(method, path, query, date, sortedSignedHeaders, region, contentHashStr, accessKeyId, secretAccessKey) {
-    const dataDigest = createCanonicalDataDigest(
-      method,
-      path,
-      query,
-      sortedSignedHeaders,
-      contentHashStr
-    );
-    const signingKey = this.#keyCache.computeIfAbsent(
-      date,
-      region,
-      accessKeyId,
-      secretAccessKey
-    );
-    const signature = signCanonicalDataHash(
-      signingKey,
-      dataDigest,
-      date,
-      region
-    );
-    const signedHeadersSpec = Object.keys(sortedSignedHeaders).join(";");
-    const credentialSpec = `${accessKeyId}/${date.date}/${region}/s3/aws4_request`;
-    return `AWS4-HMAC-SHA256 Credential=${credentialSpec}, SignedHeaders=${signedHeadersSpec}, Signature=${signature}`;
-  }
 };
 function buildSearchParams(amzCredential, date, expiresIn, headerList, contentHashStr, storageClass, sessionToken, acl) {
   let res = "";
@@ -1016,6 +1022,11 @@ function ensureValidBucketName(name) {
   }
 }
 
+// src/assertNever.ts
+function assertNever(v) {
+  throw new TypeError(`Expected value not to have type ${typeof v}`);
+}
+
 // src/S3File.ts
 var S3File = class _S3File {
   #client;
@@ -1057,7 +1068,7 @@ var S3File = class _S3File {
    * @throws {Error} If the server returns an invalid response.
    */
   async stat({ signal } = {}) {
-    const response = await this.#client._signedRequest(
+    const response = await this.#client[signedRequest](
       "HEAD",
       this.#path,
       void 0,
@@ -1090,7 +1101,7 @@ var S3File = class _S3File {
   async exists({
     signal
   } = {}) {
-    const response = await this.#client._signedRequest(
+    const response = await this.#client[signedRequest](
       "HEAD",
       this.#path,
       void 0,
@@ -1135,7 +1146,7 @@ var S3File = class _S3File {
    * ```
    */
   async delete({ signal } = {}) {
-    const response = await this.#client._signedRequest(
+    const response = await this.#client[signedRequest](
       "DELETE",
       this.#path,
       void 0,
@@ -1155,24 +1166,18 @@ var S3File = class _S3File {
   toString() {
     return `S3File { path: "${this.#path}" }`;
   }
-  /** @returns {Promise<unknown>} */
   json() {
     return new Response(this.stream()).json();
   }
-  // TODO
-  // /** @returns {Promise<Uint8Array>} */
-  // bytes() {
-  // 	return new Response(this.stream()).bytes(); // TODO: Does this exist?
-  // }
-  /** @returns {Promise<ArrayBuffer>} */
+  bytes() {
+    return new Response(this.stream()).arrayBuffer().then((ab) => new Uint8Array(ab));
+  }
   arrayBuffer() {
     return new Response(this.stream()).arrayBuffer();
   }
-  /** @returns {Promise<string>} */
   text() {
     return new Response(this.stream()).text();
   }
-  /** @returns {Promise<Blob>} */
   blob() {
     return new Response(this.stream()).blob();
   }
@@ -1245,9 +1250,6 @@ var S3File = class _S3File {
   }
   */
 };
-function assertNever(v) {
-  throw new TypeError(`Expected value not to have type ${typeof v}`);
-}
 export {
   S3BucketEntry,
   S3Client,

package/package.json

@@ -2,11 +2,25 @@
   "name": "lean-s3",
   "author": "Niklas Mollenhauer",
   "license": "MIT",
-  "version": "0.3.1",
+  "version": "0.3.2",
   "description": "A server-side S3 API for the regular user.",
   "keywords": [
     "s3",
-    "client"
+    "client",
+    "s3 client",
+    "s3 sdk",
+    "b2",
+    "b2 client",
+    "r2",
+    "r2 client",
+    "cloudflare",
+    "cloudflare r2",
+    "AWS S3",
+    "Azure Blob Storage",
+    "Google Cloud Storage",
+    "Ceph",
+    "mibion",
+    "backblaze"
   ],
   "repository": {
     "type": "git",
@@ -20,14 +34,18 @@
   "type": "module",
   "scripts": {
     "build": "tsup",
-    "test": "tsgo && node --test dist/*.test.js",
-    "test:integration": "tsgo && node --test dist/test.integration.js",
+    "test": "tsgo && node --test src/*.test.ts",
+    "test:integration": "tsgo && node --test src/test.integration.ts",
     "ci": "biome ci ./src",
     "docs": "typedoc",
     "lint": "biome lint ./src",
     "format": "biome format --write ./src && biome lint --write ./src && biome check --write ./src",
     "prepublishOnly": "npm run build"
   },
+  "dependencies": {
+    "fast-xml-parser": "^5.2.5",
+    "undici": "^7.10.0"
+  },
   "devDependencies": {
     "@biomejs/biome": "^1.9.4",
     "@testcontainers/localstack": "^11.0.3",
@@ -41,9 +59,5 @@
   },
   "engines": {
     "node": "^20.19.0 || ^22.14.0 || ^24.0.0"
-  },
-  "dependencies": {
-    "fast-xml-parser": "^5.2.5",
-    "undici": "^7.10.0"
   }
 }