@storecraft/storage-s3-compatible 1.0.0 → 1.0.2

package/README.md

@@ -1,5 +1,10 @@
 # Storecraft S3 compatible storage
 
+<div style="text-align:center">
+  <img src='https://storecraft.app/storecraft-color.svg' 
+       width='90%' />
+</div><hr/><br/>
+
 `fetch` ready support for an `S3` like storage:
 - `Amazon S3`
 - `Cloudflare R2`
@@ -11,15 +16,21 @@ Features:
 - Supports streaming `Get` / `Put` / `Delete`
 - Supports `presigned` `Get` / `Put` requests to offload to client
 
+```bash
+npm i @storecraft/storage-s3-compatible
+```
+
 ## usage
 
 ```js
-import { R2 } from '@storecraft/storage-s3-compatible'
+import { R2, S3, DigitalOceanSpaces, S3CompatibleStorage } from '@storecraft/storage-s3-compatible'
 
-const storage = new R2(
-  process.env.R2_BUCKET, process.env.R2_ACCOUNT_ID, 
-  process.env.R2_ACCESS_KEY_ID, process.env.R2_SECRET_ACCESS_KEY
-  );
+const storage = new R2({
+  accessKeyId: process.env.R2_ACCESS_KEY_ID,
+  account_id: process.env.R2_ACCOUNT_ID,
+  bucket: process.env.R2_BUCKET,
+  secretAccessKey: process.env.R2_SECRET_ACCESS_KEY
+});
 
 // write
 await storage.putBlob(
@@ -34,6 +45,41 @@ console.log('presign GET url ', url);
 
 ```
 
+## In Storecraft App
+
+```js
+import { App } from '@storecraft/core';
+import { MongoDB, migrateToLatest } from '@storecraft/database-mongodb';
+import { NodePlatform } from '@storecraft/core/platform/node';
+import { R2 } from '@storecraft/storage-s3-compatible'
+
+const app = new App(
+  {
+    storage_rewrite_urls: undefined,
+    general_store_name: 'Wush Wush Games',
+    general_store_description: 'We sell cool retro video games',
+    general_store_website: 'https://wush.games',
+    auth_secret_access_token: process.env.auth_secret_access_token,
+    auth_secret_refresh_token: process.env.auth_secret_refresh_token
+    auth_admins_emails: ['jonny@begood.com']
+  }
+)
+.withPlatform(new NodePlatform())
+.withDatabase(new MongoDB())
+.withStorage(
+  new R2(
+    process.env.R2_BUCKET, 
+    process.env.R2_ACCOUNT_ID, 
+    process.env.R2_ACCESS_KEY_ID, 
+    process.env.R2_SECRET_ACCESS_KEY
+  )
+);
+
+await app.init();
+await migrateToLatest(app.db, false);
+
+```
+
 ```text
 Author: Tomer Shalev (tomer.shalev@gmail.com)
 ```

package/adapter.js

@@ -25,12 +25,12 @@ const infer_content_type = (name) => {
 
 
 /**
- * @typedef {import('./types.public.js').Config} Config
+ * @typedef {import('./types.public.d.ts').Config} Config
  */
 
 /**
  * The base S3 compatible class
- * @typedef {import('@storecraft/core/v-storage').storage_driver} storage
+ * @typedef {import('@storecraft/core/storage').storage_driver} storage
  * 
  * @implements {storage}
  */
@@ -74,7 +74,7 @@ export class S3CompatibleStorage {
   get config() { return this.#_config; }
 
   features() {
-    /** @type {import('@storecraft/core/v-storage').StorageFeatures} */
+    /** @type {import('@storecraft/core/storage').StorageFeatures} */
     const f = {
       supports_signed_urls: true
     }
@@ -137,7 +137,7 @@ export class S3CompatibleStorage {
   /**
    * 
    * @param {string} key 
-   * @returns {ReturnType<import('@storecraft/core/v-storage').storage_driver["putSigned"]>}
+   * @returns {ReturnType<import('@storecraft/core/storage').storage_driver["putSigned"]>}
    */
   async putSigned(key) {
     const url = new URL(this.get_file_url(key));
@@ -218,7 +218,7 @@ export class S3CompatibleStorage {
   /**
    * 
    * @param {string} key 
-   * @returns {ReturnType<import('@storecraft/core/v-storage').storage_driver["getSigned"]>}
+   * @returns {ReturnType<import('@storecraft/core/storage').storage_driver["getSigned"]>}
    */
   async getSigned(key) {
     const url = new URL(this.get_file_url(key));
@@ -259,18 +259,16 @@ export class S3CompatibleStorage {
 export class R2 extends S3CompatibleStorage {
 
   /**
-   * 
-   * @param {string} bucket 
-   * @param {string} account_id 
-   * @param {string} access_key_id 
-   * @param {string} secret_access_key 
+   * @param {import('./types.public.d.ts').R2Config} config
    */
-  constructor(bucket, account_id, access_key_id, secret_access_key) {
-    super({
-      endpoint: `https://${account_id}.r2.cloudflarestorage.com`,
-      accessKeyId: access_key_id, secretAccessKey: secret_access_key, 
-      bucket, forcePathStyle: true, region: 'auto'
-    })
+  constructor({bucket, account_id, accessKeyId, secretAccessKey}) {
+    super(
+      {
+        endpoint: `https://${account_id}.r2.cloudflarestorage.com`,
+        accessKeyId, secretAccessKey, bucket, 
+        forcePathStyle: true, region: 'auto'
+      }
+    )
   }
 
 }
@@ -281,19 +279,16 @@ export class R2 extends S3CompatibleStorage {
 export class S3 extends S3CompatibleStorage {
 
   /**
-   * 
-   * @param {string} bucket 
-   * @param {string} region 
-   * @param {string} access_key_id 
-   * @param {string} secret_access_key 
-   * @param {boolean} forcePathStyle 
+   * @param {import('./types.public.d.ts').AwsS3Config} config
    */
-  constructor(bucket, region, access_key_id, secret_access_key, forcePathStyle=false) {
-    super({
-      endpoint: `https://s3${region ? ('.'+region) : ''}.amazonaws.com`,
-      accessKeyId: access_key_id, secretAccessKey: secret_access_key, 
-      bucket, forcePathStyle, region
-    })
+  constructor({bucket, region, accessKeyId, secretAccessKey, forcePathStyle=false}) {
+    super(
+      {
+        endpoint: `https://s3${region ? ('.'+region) : ''}.amazonaws.com`,
+        accessKeyId, secretAccessKey, 
+        bucket, forcePathStyle, region
+      }
+    )
   }
 
 }
@@ -304,18 +299,16 @@ export class S3 extends S3CompatibleStorage {
 export class DigitalOceanSpaces extends S3CompatibleStorage {
 
   /**
-   * 
-   * @param {string} bucket 
-   * @param {string} region 'nyc3' for example
-   * @param {string} access_key_id 
-   * @param {string} secret_access_key 
+   * @param {Omit<import('./types.public.d.ts').Config, 'endpoint' | 'forcePathStyle'>} config
    */
-  constructor(bucket, region, access_key_id, secret_access_key) {
-    super({
-      endpoint: `https://${region}.digitaloceanspaces.com`,
-      accessKeyId: access_key_id, secretAccessKey: secret_access_key, 
-      bucket, forcePathStyle: false, region: 'auto'
-    })
+  constructor({bucket, region, accessKeyId, secretAccessKey}) {
+    super(
+      {
+        endpoint: `https://${region}.digitaloceanspaces.com`,
+        accessKeyId, secretAccessKey, 
+        bucket, forcePathStyle: false, region: 'auto'
+      }
+    )
   }
 
 }

package/jsconfig.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "checkJs": true,
+    "moduleResolution": "NodeNext",
+    "module": "NodeNext",
+    "composite": true,
+  },
+  "include": [
+    "*", 
+    "src/*",
+    "tests/*.js"
+  ]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storecraft/storage-s3-compatible",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Official S3-Compatible Storage adapter for storecraft",
   "license": "MIT",
   "author": "Tomer Shalev (https://github.com/store-craft)",
@@ -8,7 +8,7 @@
   "repository": {
     "type": "git",
     "url": "https://github.com/store-craft/storecraft.git",
-    "directory": "packages/storage-s3-compatible"
+    "directory": "packages/storage/storage-s3-compatible"
   },
   "keywords": [
     "commerce",
@@ -21,8 +21,8 @@
     "storage-s3-compatible:publish": "npm publish --access public"
   },
   "type": "module",
-  "main": "index.js",
-  "types": "./types.public.d.ts",
+  "main": "adapter.js",
+  "types": "types.public.d.ts",
   "dependencies": {
     "@storecraft/core": "^1.0.0"
   },

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

@@ -0,0 +1,84 @@
+import 'dotenv/config';
+import * as assert from 'uvu/assert';
+import { S3 } from '@storecraft/storage-s3-compatible'
+import { readFile } from 'node:fs/promises';
+import { storage as storage_test_runner } from '@storecraft/core/test-runner'
+
+const areBlobsEqual = async (blob1, blob2) => {
+  return !Buffer.from(await blob1.arrayBuffer()).compare(
+    Buffer.from(await blob2.arrayBuffer())
+  );
+};
+
+const FORCE_PATH_STYLE = true;
+
+const storage = new S3({
+  accessKeyId: process.env.S3_ACCESS_KEY_ID,
+  bucket: process.env.S3_BUCKET,
+  forcePathStyle: FORCE_PATH_STYLE,
+  region: process.env.S3_REGION,
+  secretAccessKey: process.env.S3_SECRET_KEY
+});
+
+const suite = storage_test_runner.create(storage);
+
+suite.before(async () => { await storage.init(undefined) });
+
+suite('blob put/get/delete', async () => {
+  const data = [
+    {
+      key: 'folder2/node2222.png',
+      blob: new Blob([await readFile('./node.png')])
+    }
+  ];
+
+  data.forEach(
+    async d => {
+      // write
+      await storage.putBlob(d.key, d.blob);
+      // read
+      const { value: blob_read } = await storage.getBlob(d.key);
+      const url = await storage.getSigned(d.key);
+      console.log('presign GET url ', url);
+
+      // compare
+      const equal = await areBlobsEqual(blob_read, d.blob);
+      assert.ok(equal, 'Blobs are not equal !!!');
+
+      // delete
+      // await storage.remove(d.key);
+    }
+  );
+  
+});
+
+suite('blob put (presign)', async () => {
+  const data = [
+    {
+      key: 'folder2/node_test2.png',
+      blob: new Blob([await readFile('./node.png')])
+    }
+  ];
+
+  data.forEach(
+    async d => {
+      // get put presigned url
+      const { url, method, headers } = await storage.putSigned(d.key);
+      // now let's use it to upload
+      const r = await fetch(
+        url, {
+          method,
+          headers,
+          body: d.blob
+        }
+      );
+
+      console.log(url)
+
+      assert.ok(r.ok, 'upload failed')
+    }
+  );
+  
+});
+
+suite.run();

package/tests/storage.r2.test.js

@@ -1,10 +1,9 @@
 import 'dotenv/config';
-import { test } from 'uvu';
 import * as assert from 'uvu/assert';
 import { R2 } from '../adapter.js'
 import { readFile } from 'node:fs/promises';
-import { homedir } from 'node:os'
-import * as path from 'node:path';
+import { storage as storage_test_runner } from '@storecraft/core/test-runner'
+
 
 const areBlobsEqual = async (blob1, blob2) => {
   return !Buffer.from(await blob1.arrayBuffer()).compare(
@@ -12,21 +11,21 @@ const areBlobsEqual = async (blob1, blob2) => {
   );
 };
 
-const storage = new R2(
-  process.env.R2_BUCKET, process.env.R2_ACCOUNT_ID, 
-  process.env.R2_ACCESS_KEY_ID, process.env.R2_SECRET_ACCESS_KEY
-  );
+const storage = new R2({
+  accessKeyId: process.env.R2_ACCESS_KEY_ID,
+  account_id: process.env.R2_ACCOUNT_ID,
+  bucket: process.env.R2_BUCKET,
+  secretAccessKey: process.env.R2_SECRET_ACCESS_KEY
+});
 
-test.before(async () => await storage.init())
+const suite = storage_test_runner.create(storage);
 
-test('blob put/get/delete', async () => {
+suite.before(async () => { await storage.init(undefined) });
+
+suite('blob put/get/delete', async () => {
   const data = [
-    // {
-    //   key: 'folder1/tomer.txt',
-    //   blob: new Blob(['this is some text from tomer :)']),
-    // },
     {
-      key: 'node2222.png',
+      key: 'folder2/node2222.png',
       blob: new Blob([await readFile('./node.png')])
     }
   ];
@@ -51,14 +50,10 @@ test('blob put/get/delete', async () => {
   
 });
 
-test('blob put (presign)', async () => {
+suite('blob put (presign)', async () => {
   const data = [
-    // {
-    //   key: 'folder1/tomer.txt',
-    //   blob: new Blob(['this is some text from tomer :)']),
-    // },
     {
-      key: 'node_test2.png',
+      key: 'folder2/node_test2.png',
       blob: new Blob([await readFile('./node.png')])
     }
   ];
@@ -76,10 +71,12 @@ test('blob put (presign)', async () => {
         }
       );
 
+      console.log(url)
+
       assert.ok(r.ok, 'upload failed')
     }
   );
   
 });
 
-test.run();
+suite.run();

package/types.public.d.ts

@@ -1,4 +1,4 @@
-export * from './index.js';
+export { DigitalOceanSpaces, R2, S3, S3CompatibleStorage } from './adapter.js';
 
 export type Config = {
   endpoint: string;
@@ -9,3 +9,13 @@ export type Config = {
   forcePathStyle: boolean;
 }
 
+export type R2Config = Omit<Config, 'region' | 'forcePathStyle' | 'endpoint'> & {
+  /**
+   * @description cloudflare account id
+   */
+  account_id: string;
+};
+
+
+export type AwsS3Config = Omit<Config, 'endpoint'>;
+

package/index.js

@@ -1 +0,0 @@
-export * from './adapter.js'

package/tsconfig.json

@@ -1,14 +0,0 @@
-{
-  "compileOnSave": false,
-  "compilerOptions": {
-    "noEmit": true,
-    "allowJs": true,
-    "checkJs": true,
-    "target": "ESNext",
-    "resolveJsonModule": true,
-    "moduleResolution": "NodeNext",
-    "module": "NodeNext",
-    "composite": true,
-  },
-  "include": ["*", "src/*"]
-}