@naturalcycles/cloud-storage-lib 1.4.0 → 1.5.1

package/dist/cloudStorage.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import { Readable, Writable } from 'stream';
-import { Storage } from '@google-cloud/storage';
+import { Storage, StorageOptions } from '@google-cloud/storage';
 import { ReadableTyped } from '@naturalcycles/nodejs-lib';
 import { CommonStorage, CommonStorageGetOptions, FileEntry } from './commonStorage';
 import { GCPServiceAccount } from './model';
@@ -14,7 +15,10 @@ import { GCPServiceAccount } from './model';
  * (either personal one or non-personal).
  */
 export interface CloudStorageCfg {
-    credentials: GCPServiceAccount;
+    /**
+     * It's optional, to allow automatic credentials in AppEngine, or GOOGLE_APPLICATION_CREDENTIALS.
+     */
+    credentials?: GCPServiceAccount;
 }
 export declare class CloudStorage implements CommonStorage {
     storage: Storage;
@@ -24,6 +28,7 @@ export declare class CloudStorage implements CommonStorage {
      */
     constructor(storage: Storage);
     static createFromGCPServiceAccount(cfg: CloudStorageCfg): CloudStorage;
+    static createFromStorageOptions(storageOptions?: StorageOptions): CloudStorage;
     ping(bucketName?: string): Promise<void>;
     deletePath(bucketName: string, prefix: string): Promise<void>;
     fileExists(bucketName: string, filePath: string): Promise<boolean>;

package/dist/cloudStorage.js

@@ -20,10 +20,14 @@ class CloudStorage {
             // To learn more about authentication and Google APIs, visit:
             // https://cloud.google.com/docs/authentication/getting-started
             //     at /root/repo/node_modules/google-auth-library/build/src/auth/googleauth.js:95:31
-            projectId: cfg.credentials.project_id,
+            projectId: cfg.credentials?.project_id,
         });
         return new CloudStorage(storage);
     }
+    static createFromStorageOptions(storageOptions) {
+        const storage = new storage_1.Storage(storageOptions);
+        return new CloudStorage(storage);
+    }
     async ping(bucketName) {
         await this.storage.bucket(bucketName || 'non-existing-for-sure').exists();
     }
@@ -59,7 +63,7 @@ class CloudStorage {
             .pipe((0, nodejs_lib_1.transformMapSimple)(f => fullPaths ? f.name : (0, js_lib_1._substringAfterLast)(f.name, '/')));
     }
     getFilesStream(bucketName, opt = {}) {
-        const { prefix } = opt;
+        const { prefix, fullPaths = true } = opt;
         return this.storage
             .bucket(bucketName)
             .getFilesStream({
@@ -68,7 +72,7 @@ class CloudStorage {
         })
             .pipe((0, nodejs_lib_1.transformMap)(async (f) => {
             const [content] = await f.download();
-            return { filePath: f.name, content };
+            return { filePath: fullPaths ? f.name : (0, js_lib_1._substringAfterLast)(f.name, '/'), content };
         }));
     }
     async getFile(bucketName, filePath) {

package/dist/commonStorage.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import { Readable, Writable } from 'stream';
 import { ReadableTyped } from '@naturalcycles/nodejs-lib';
 export interface FileEntry {

package/dist/commonStorageBucket.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import { Readable, Writable } from 'stream';
 import { ReadableTyped } from '@naturalcycles/nodejs-lib';
 import { CommonStorage, CommonStorageGetOptions, FileEntry } from './commonStorage';

package/dist/inMemoryCommonStorage.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import { Readable, Writable } from 'stream';
 import { StringMap } from '@naturalcycles/js-lib';
 import { ReadableTyped } from '@naturalcycles/nodejs-lib';

package/package.json

@@ -4,16 +4,16 @@
     "prepare": "husky install"
   },
   "dependencies": {
-    "@google-cloud/storage": "^5.14.0",
+    "@google-cloud/storage": "^6.0.0",
     "@naturalcycles/db-lib": "^8.25.0",
     "@naturalcycles/js-lib": "^14.41.0",
     "@naturalcycles/nodejs-lib": "^12.31.0"
   },
   "devDependencies": {
     "@naturalcycles/dev-lib": "^12.1.3",
-    "@types/node": "^17.0.5",
+    "@types/node": "^17.0.8",
     "firebase-admin": "^10.0.1",
-    "jest": "^27.1.0"
+    "jest": "^28.1.0"
   },
   "files": [
     "dist",
@@ -35,7 +35,7 @@
   "engines": {
     "node": ">=14.16.0"
   },
-  "version": "1.4.0",
+  "version": "1.5.1",
   "description": "",
   "author": "Natural Cycles Team",
   "license": "MIT"

package/src/cloudStorage.ts

@@ -1,7 +1,6 @@
-import * as Buffer from 'buffer'
 import { Readable, Writable } from 'stream'
 import { _substringAfterLast } from '@naturalcycles/js-lib'
-import { File, Storage } from '@google-cloud/storage'
+import { File, Storage, StorageOptions } from '@google-cloud/storage'
 import { ReadableTyped, transformMap, transformMapSimple } from '@naturalcycles/nodejs-lib'
 import { CommonStorage, CommonStorageGetOptions, FileEntry } from './commonStorage'
 import { GCPServiceAccount } from './model'
@@ -16,7 +15,10 @@ import { GCPServiceAccount } from './model'
  * (either personal one or non-personal).
  */
 export interface CloudStorageCfg {
-  credentials: GCPServiceAccount
+  /**
+   * It's optional, to allow automatic credentials in AppEngine, or GOOGLE_APPLICATION_CREDENTIALS.
+   */
+  credentials?: GCPServiceAccount
 }
 
 export class CloudStorage implements CommonStorage {
@@ -34,12 +36,17 @@ export class CloudStorage implements CommonStorage {
       // To learn more about authentication and Google APIs, visit:
       // https://cloud.google.com/docs/authentication/getting-started
       //     at /root/repo/node_modules/google-auth-library/build/src/auth/googleauth.js:95:31
-      projectId: cfg.credentials.project_id,
+      projectId: cfg.credentials?.project_id,
     })
 
     return new CloudStorage(storage)
   }
 
+  static createFromStorageOptions(storageOptions?: StorageOptions): CloudStorage {
+    const storage = new Storage(storageOptions)
+    return new CloudStorage(storage)
+  }
+
   async ping(bucketName?: string): Promise<void> {
     await this.storage.bucket(bucketName || 'non-existing-for-sure').exists()
   }
@@ -87,7 +94,7 @@ export class CloudStorage implements CommonStorage {
   }
 
   getFilesStream(bucketName: string, opt: CommonStorageGetOptions = {}): ReadableTyped<FileEntry> {
-    const { prefix } = opt
+    const { prefix, fullPaths = true } = opt
 
     return this.storage
       .bucket(bucketName)
@@ -98,7 +105,7 @@ export class CloudStorage implements CommonStorage {
       .pipe(
         transformMap<File, FileEntry>(async f => {
           const [content] = await f.download()
-          return { filePath: f.name, content }
+          return { filePath: fullPaths ? f.name : _substringAfterLast(f.name, '/'), content }
         }),
       )
   }

package/src/commonStorageKeyValueDB.ts

@@ -1,4 +1,3 @@
-import * as Buffer from 'buffer'
 import { CommonDBCreateOptions, CommonKeyValueDB, KeyValueDBTuple } from '@naturalcycles/db-lib'
 import { pMap, StringMap } from '@naturalcycles/js-lib'
 import { ReadableTyped, transformMapSimple } from '@naturalcycles/nodejs-lib'