@storecraft/storage-google 1.0.0 → 1.0.2

package/README.md

@@ -1,5 +1,10 @@
 # Storecraft Google Cloud Storage
 
+<div style="text-align:center">
+  <img src='https://storecraft.app/storecraft-color.svg' 
+       width='90%' />
+</div><hr/><br/>
+
 `fetch` ready support for an `GCP` **Storage**
 
 Features:
@@ -7,6 +12,10 @@ Features:
 - Supports streaming `Get` / `Put` / `Delete`
 - Supports `presigned` `Get` / `Put` requests to offload to client
 
+```bash
+npm i @storecraft/storage-google
+```
+
 ## How-to
 1. Create a bucket at `GCP console` or even at `firebase`
 2. Download the `service json file`
@@ -35,11 +44,48 @@ await storage.putBlob(
 
 // read
 const { value } = await storage.getBlob('folder1/tomer.txt');
-const url = await storage.getSigned('folder1/tomer.txt');
+const { url } = await storage.getSigned('folder1/tomer.txt');
 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 { GoogleStorage } from '@storecraft/storage-google';
+
+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 GoogleStorage(
+    {
+      bucket: process.env.GS_BUCKET, 
+      client_email: process.env.GS_CLIENT_EMAIL, 
+      private_key: process.env.GS_PRIVATE_KEY, 
+      private_key_id: process.env.GS_PRIVATE_KEY_ID
+    }
+  )
+);
+  
+await app.init();
+await migrateToLatest(app.db, false);
+
+```
+
 
 ```text
 Author: Tomer Shalev (tomer.shalev@gmail.com)

package/adapter.js

@@ -24,13 +24,13 @@ const infer_content_type = (name) => {
 
 
 /**
- * @typedef {import('./types.public.js').ServiceFile} ServiceFile
- * @typedef {import('./types.public.js').Config} Config
+ * @typedef {import('./types.public.d.ts').ServiceFile} ServiceFile
+ * @typedef {import('./types.public.d.ts').Config} Config
  */
 
 /**
  * Google Storage
- * @typedef {import('@storecraft/core/v-storage').storage_driver} storage
+ * @typedef {import('@storecraft/core/storage').storage_driver} storage
  * 
  * @implements {storage}
  */
@@ -66,7 +66,7 @@ export class GoogleStorage {
   }
 
   features() {
-    /** @type {import('@storecraft/core/v-storage').StorageFeatures} */
+    /** @type {import('@storecraft/core/storage').StorageFeatures} */
     const f = {
       supports_signed_urls: true
     }
@@ -273,8 +273,9 @@ export class GoogleStorage {
       }
     );
 
+    // console.log(await r.text())
+
     return r.ok;
-    // console.log(r)
   }
 }
 

package/adapter.utils.js

@@ -1,13 +1,13 @@
-import { base64, jwt } from '@storecraft/core/v-crypto';
+import { base64, jwt } from '@storecraft/core/crypto';
 
 /**
  * 
- * @param {import('./types.public.js').ServiceFile} sf Google service account json
+ * @param {import('./types.public.d.ts').ServiceFile} sf Google service account json
  * @param {string} [aud]
  * @returns 
  */
 export async function getJWTFromServiceAccount(sf, aud=undefined) {
-  /** @type {Partial<import('@storecraft/core/v-crypto').jwt.JWTClaims> & Record<string, string>} */
+  /** @type {Partial<import('@storecraft/core/crypto').jwt.JWTClaims> & Record<string, string>} */
   const claims = {
     scope: [
       // 'https://www.googleapis.com/auth/cloud-platform',

package/{tsconfig.json → jsconfig.json}

@@ -1,11 +1,7 @@
 {
-  "compileOnSave": false,
   "compilerOptions": {
-    "noEmit": true,
-    "allowJs": true,
     "checkJs": true,
     "target": "ESNext",
-    "resolveJsonModule": true,
     "moduleResolution": "NodeNext",
     "module": "NodeNext",
     "composite": true,

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@storecraft/storage-google",
-  "version": "1.0.0",
-  "description": "Google Storage support",
+  "version": "1.0.2",
+  "description": "Official Google Storage adapter for storecraft",
   "license": "MIT",
   "author": "Tomer Shalev (https://github.com/store-craft)",
   "homepage": "https://github.com/store-craft/storecraft",
   "repository": {
     "type": "git",
     "url": "https://github.com/store-craft/storecraft.git",
-    "directory": "packages/storage-google"
+    "directory": "packages/storage/storage-google"
   },
   "keywords": [
     "commerce",
@@ -21,8 +21,8 @@
     "storage-google: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.test.js

@@ -1,8 +1,9 @@
 import 'dotenv/config';
 import { test } from 'uvu';
 import * as assert from 'uvu/assert';
-import { GoogleStorage } from '../adapter.js'
+import { GoogleStorage } from '@storecraft/storage-google'
 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(
@@ -15,16 +16,18 @@ const storage = new GoogleStorage({
   private_key: process.env.GS_PRIVATE_KEY, private_key_id: process.env.GS_PRIVATE_KEY_ID
 });
 
-test.before(async () => { await storage.init(undefined) });
+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')])
     }
   ];
@@ -49,14 +52,14 @@ 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')])
     }
   ];
@@ -82,4 +85,4 @@ test('blob put (presign)', async () => {
   
 });
 
-test.run();
+suite.run();

package/types.public.d.ts

@@ -1,4 +1,4 @@
-export * from './index.js';
+export { GoogleStorage } from './adapter.js';
 
 export type ServiceFile = {
   type?: string;

package/index.js

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