@storecraft/storage-google 1.0.9 → 1.0.11

package/README.md

@@ -71,14 +71,7 @@ const app = new App(
 .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
-    }
-  )
+  new GoogleStorage() // config inferred from env variables
 );
   
 await app.init();

package/adapter.js

@@ -1,3 +1,9 @@
+/**
+ * @import { Config, ServiceFile } from './types.public.js' 
+ * @import { ENV } from '@storecraft/core';
+ * @import { storage_driver, StorageFeatures } from '@storecraft/core/storage' 
+ */
+
 import { getJWTFromServiceAccount, presign } from './adapter.utils.js';
 
 const types = {
@@ -23,25 +29,27 @@ const infer_content_type = (name) => {
 }
 
 
-/**
- * @typedef {import('./types.public.d.ts').ServiceFile} ServiceFile
- * @typedef {import('./types.public.d.ts').Config} Config
- */
-
 /**
  * @description Google Storage adapter
- * @typedef {import('@storecraft/core/storage').storage_driver} storage
  * 
- * @implements {storage}
+ * @implements {storage_driver}
  */
 export class GoogleStorage {
   
+  /** @satisfies {ENV<Config>} */
+  static EnvConfig = /** @type{const} */ ({
+    bucket: 'GS_BUCKET',
+    client_email: 'GS_CLIENT_EMAIL',
+    private_key: 'GS_PRIVATE_KEY',
+    private_key_id: 'GS_PRIVATE_KEY_ID',
+  });
+
   /** @type {Config} */ #_config;
 
   /**
    * @param {Config} [config]
    */
-  constructor(config) {
+  constructor(config={}) {
     this.#_config = config;
   }
 
@@ -49,24 +57,22 @@ export class GoogleStorage {
   get config() { return this.#_config; }
 
   /**
-   * @type {storage["init"]}
+   * @type {storage_driver["init"]}
    */
   async init(app) {
     if(!app)
       return this;
 
-    this.#_config = this.#_config ?? {
-      bucket: app.platform.env.GS_BUCKET,
-      client_email: app.platform.env.GS_CLIENT_EMAIL,
-      private_key: app.platform.env.GS_PRIVATE_KEY,
-      private_key_id: app.platform.env.GS_PRIVATE_KEY_ID,
-    }
+    this.#_config.bucket ??= app.platform.env[GoogleStorage.EnvConfig.bucket];
+    this.#_config.client_email ??= app.platform.env[GoogleStorage.EnvConfig.client_email];
+    this.#_config.private_key ??= app.platform.env[GoogleStorage.EnvConfig.private_key];
+    this.#_config.private_key_id ??= app.platform.env[GoogleStorage.EnvConfig.private_key_id];
 
     return this; 
   }
 
   features() {
-    /** @type {import('@storecraft/core/storage').StorageFeatures} */
+    /** @type {StorageFeatures} */
     const f = {
       supports_signed_urls: true
     }
@@ -113,8 +119,7 @@ export class GoogleStorage {
 
   /**
    * 
-   * @param {string} key 
-   * @param {Blob} blob 
+   * @type {storage_driver["putBlob"]}
    */
   async putBlob(key, blob) {
     return this.#put_internal(key, blob);
@@ -122,8 +127,7 @@ export class GoogleStorage {
 
   /**
    * 
-   * @param {string} key 
-   * @param {ArrayBuffer} buffer 
+   * @type {storage_driver["putArraybuffer"]}
    */
   async putArraybuffer(key, buffer) {
     return this.#put_internal(key, buffer);
@@ -131,8 +135,7 @@ export class GoogleStorage {
 
   /**
    * 
-   * @param {string} key 
-   * @param {ReadableStream} stream 
+   * @type {storage_driver["putStream"]}
    */
   async putStream(key, stream) {
     return this.#put_internal(key, stream);
@@ -140,7 +143,7 @@ export class GoogleStorage {
 
   /**
    * 
-   * @param {string} key 
+   * @type {storage_driver["getSigned"]}
    */
   async putSigned(key) {
     const ct = infer_content_type(key);
@@ -190,7 +193,7 @@ export class GoogleStorage {
 
   /**
    * 
-   * @param {string} key 
+   * @type {storage_driver["getArraybuffer"]}
    */
   async getArraybuffer(key) {
     const r = await this.#get_request(key);
@@ -205,7 +208,7 @@ export class GoogleStorage {
 
   /**
    * 
-   * @param {string} key 
+   * @type {storage_driver["getBlob"]}
    */
   async getBlob(key) {
     const r = await this.#get_request(key);
@@ -222,8 +225,7 @@ export class GoogleStorage {
 
   /**
    * 
-   * @param {string} key 
-   * @param {Response} key 
+   * @type {storage_driver["getStream"]}
    */
   async getStream(key) {
 
@@ -238,7 +240,7 @@ export class GoogleStorage {
 
   /**
    * 
-   * @param {string} key 
+   * @type {storage_driver["getSigned"]}
    */
   async getSigned(key) {
     const sf = this.config;
@@ -260,7 +262,7 @@ export class GoogleStorage {
 
   /**
    * 
-   * @param {string} key 
+   * @type {storage_driver["remove"]}
    */
   async remove(key) {
     const Authorization = 'Bearer ' + await getJWTFromServiceAccount(this.config);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storecraft/storage-google",
-  "version": "1.0.9",
+  "version": "1.0.11",
   "description": "Official Google Storage adapter for storecraft",
   "license": "MIT",
   "author": "Tomer Shalev (https://github.com/store-craft)",

package/types.public.d.ts

@@ -15,12 +15,12 @@ export type ServiceFile = {
 }
 
 export type Config = {
-  /** bucket name */
-  bucket: string;
-  /** client email from the service file */
-  client_email: string;
-  /** private key */
-  private_key: string;
-  /** private key id */
-  private_key_id: string;
+  /** bucket name, if missing will be inferred by env variable `GS_BUCKET` */
+  bucket?: string;
+  /** client email from the service file, if missing will be inferred by env variable `GS_CLIENT_EMAIL` */
+  client_email?: string;
+  /** private key, if missing will be inferred by env variable `GS_PRIVATE_KEY` */
+  private_key?: string;
+  /** private key id, if missing will be inferred by env variable `GS_PRIVATE_KEY_ID` */
+  private_key_id?: string;
 }