@storecraft/storage-s3-compatible 1.0.6 → 1.0.8

package/README.md

@@ -5,6 +5,8 @@
        width='90%' />
 </div><hr/><br/>
 
+[![S3 Compatible](https://github.com/store-craft/storecraft/actions/workflows/test.storage-s3-compatible.yml/badge.svg)](https://github.com/store-craft/storecraft/actions/workflows/test.storage-s3-compatible.yml)
+
 `fetch` ready support for an `S3` like storage:
 - `Amazon S3`
 - `Cloudflare R2`

package/adapter.js

@@ -95,23 +95,30 @@ export class S3CompatibleStorage {
    * 
    * @param {string} key 
    * @param {BodyInit} body 
+   * @param {object} [headers={}] 
    */
-  async #put_internal(key, body) {
+  async #put_internal(key, body, headers={}) {
     const r = await this.client.fetch(
       this.get_file_url(key),
       {
         method: 'PUT',
-        body
+        body,
+        headers
       }
     );
 
+    if(!r.ok) {
+      console.log(
+        await r.text()
+      );
+    }
+
     return r.ok;
   }
 
   /**
    * 
-   * @param {string} key 
-   * @param {Blob} blob 
+   * @type {storage["putBlob"]}
    */
   async putBlob(key, blob) {
     return this.#put_internal(key, blob);
@@ -119,8 +126,7 @@ export class S3CompatibleStorage {
 
   /**
    * 
-   * @param {string} key 
-   * @param {ArrayBuffer} buffer 
+   * @type {storage["putArraybuffer"]}
    */
   async putArraybuffer(key, buffer) {
     return this.#put_internal(key, buffer);
@@ -128,17 +134,23 @@ export class S3CompatibleStorage {
 
   /**
    * 
-   * @param {string} key 
-   * @param {ReadableStream} stream 
+   * @type {storage["putStream"]}
    */
-  async putStream(key, stream) {
-    return this.#put_internal(key, stream);
+  async putStream(key, stream, meta={}, bytesLength=0) {
+    const extra_headers = {};
+    if(Boolean(bytesLength)) {
+      extra_headers["Content-Length"] = bytesLength;
+    }
+
+    return this.#put_internal(
+      // @ts-ignore
+      key, stream, extra_headers
+    );
   }
 
   /**
    * 
-   * @param {string} key 
-   * @returns {ReturnType<import('@storecraft/core/storage').storage_driver["putSigned"]>}
+   * @type {storage["putSigned"]}
    */
   async putSigned(key) {
     const url = new URL(this.get_file_url(key));
@@ -171,14 +183,14 @@ export class S3CompatibleStorage {
   }
 
   /**
-   * 
-   * @param {string} key 
+   * @type {storage["getArraybuffer"]}
    */
   async getArraybuffer(key) {
     const r = await this.#get_request(key);
-    const b = await r.arrayBuffer();
     return {
-      value: b, 
+      value: r.ok ? (await r.arrayBuffer()) : undefined, 
+      error: !r.ok,
+      message: r.ok ? undefined : await r.text(),
       metadata: {
         contentType: infer_content_type(key)
       }
@@ -187,13 +199,14 @@ export class S3CompatibleStorage {
 
   /**
    * 
-   * @param {string} key 
+   * @type {storage["getBlob"]}
    */
   async getBlob(key) {
     const r = await this.#get_request(key);
-    const b = await r.blob();
     return {
-      value: b, 
+      value: r.ok ? (await r.blob()) : undefined, 
+      error: !r.ok,
+      message: r.ok ? undefined : await r.text(),
       metadata: {
         contentType: infer_content_type(key)
       }
@@ -201,15 +214,15 @@ export class S3CompatibleStorage {
   }
 
   /**
-   * 
-   * @param {string} key 
-   * @param {Response} key 
+   * @type {storage["getStream"]}
    */
   async getStream(key) {
-
-    const s = (await this.#get_request(key)).body
+    const r = await this.#get_request(key);
+    const b = r.body;
     return {
-      value: s, 
+      value: r.ok ? b : undefined, 
+      error: !r.ok,
+      message: r.ok ? undefined : await r.text(),
       metadata: {
         contentType: infer_content_type(key)
       }
@@ -218,8 +231,7 @@ export class S3CompatibleStorage {
 
   /**
    * 
-   * @param {string} key 
-   * @returns {ReturnType<import('@storecraft/core/storage').storage_driver["getSigned"]>}
+   * @type {storage["getSigned"]}
    */
   async getSigned(key) {
     const url = new URL(this.get_file_url(key));
@@ -244,7 +256,7 @@ export class S3CompatibleStorage {
 
   /**
    * 
-   * @param {string} key 
+   * @type {storage["remove"]}
    */
   async remove(key) {
     const r = await this.client.fetch(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storecraft/storage-s3-compatible",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "Official S3-Compatible Storage adapter for storecraft",
   "license": "MIT",
   "author": "Tomer Shalev (https://github.com/store-craft)",
@@ -17,9 +17,9 @@
     "storecraft"
   ],
   "scripts": {
-    "storage-s3-compatible:test": "uvu -c",
-    "test": "npm run storage-s3-compatible:test",
-    "prepublishOnly": "npm version patch --force"
+    "test": "node ./tests/storage.s3-compatible.test.js",
+    "prepublishOnly": "npm version patch --force",
+    "sc-publish": "npm publish"
   },
   "type": "module",
   "main": "adapter.js",

package/tests/storage.s3-compatible.test.js

@@ -0,0 +1,22 @@
+import 'dotenv/config';
+import { S3CompatibleStorage } from '@storecraft/storage-s3-compatible'
+import { storage as storage_test_runner } from '@storecraft/core/test-runner'
+
+const FORCE_PATH_STYLE = true;
+
+const storage = new S3CompatibleStorage(
+  {
+    accessKeyId: process.env.ACCESS_KEY_ID,
+    secretAccessKey: process.env.SECRET_ACCESS_KEY,
+    bucket: process.env.BUCKET,
+    endpoint: process.env.ENDPOINT,
+    forcePathStyle: FORCE_PATH_STYLE,
+    region: process.env.REGION
+  }
+);
+
+const suite = storage_test_runner.create(storage);
+
+suite.before(async () => { await storage.init(undefined) });
+
+suite.run();