@storecraft/storage-s3-compatible 1.0.1 → 1.0.3

package/README.md

@@ -2,7 +2,7 @@
 
 <div style="text-align:center">
   <img src='https://storecraft.app/storecraft-color.svg' 
-       width='90%'' />
+       width='90%' />
 </div><hr/><br/>
 
 `fetch` ready support for an `S3` like storage:
@@ -45,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

@@ -29,8 +29,9 @@ const infer_content_type = (name) => {
  */
 
 /**
- * The base S3 compatible class
- * @typedef {import('@storecraft/core/v-storage').storage_driver} storage
+ * @description The base S3 compatible class
+ * 
+ * @typedef {import('@storecraft/core/storage').storage_driver} storage
  * 
  * @implements {storage}
  */
@@ -74,7 +75,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 +138,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 +219,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));

package/jsconfig.json

@@ -4,6 +4,7 @@
     "moduleResolution": "NodeNext",
     "module": "NodeNext",
     "composite": true,
+    "maxNodeModuleJsDepth": 10
   },
   "include": [
     "*", 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storecraft/storage-s3-compatible",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "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",
@@ -18,7 +18,8 @@
   ],
   "scripts": {
     "storage-s3-compatible:test": "uvu -c",
-    "storage-s3-compatible:publish": "npm publish --access public"
+    "test": "npm run storage-s3-compatible:test",
+    "prepublishOnly": "npm version patch --force"
   },
   "type": "module",
   "main": "adapter.js",

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

@@ -1,10 +1,8 @@
 import 'dotenv/config';
-import { test } from 'uvu';
 import * as assert from 'uvu/assert';
 import { S3 } from '@storecraft/storage-s3-compatible'
 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(
@@ -22,16 +20,14 @@ const storage = new S3({
   secretAccessKey: process.env.S3_SECRET_KEY
 });
 
-test.before(async () => { await storage.init(null) })
+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')])
     }
   ];
@@ -56,14 +52,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')])
     }
   ];
@@ -81,10 +73,12 @@ test('blob put (presign)', async () => {
         }
       );
 
+      console.log(url)
+
       assert.ok(r.ok, 'upload failed')
     }
   );
   
 });
 
-test.run();
+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(
@@ -19,16 +18,14 @@ const storage = new R2({
   secretAccessKey: process.env.R2_SECRET_ACCESS_KEY
 });
 
-test.before(async () => { await storage.init(null) })
+const suite = storage_test_runner.create(storage);
+
+suite.before(async () => { await storage.init(undefined) });
 
-test('blob put/get/delete', async () => {
+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')])
     }
   ];
@@ -53,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')])
     }
   ];
@@ -78,10 +71,12 @@ test('blob put (presign)', async () => {
         }
       );
 
+      console.log(url)
+
       assert.ok(r.ok, 'upload failed')
     }
   );
   
 });
 
-test.run();
+suite.run();