@naturalcycles/cloud-storage-lib 1.5.1 → 1.5.3

package/dist/cloudStorage.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 /// <reference types="node" />
-import { Readable, Writable } from 'stream';
+import { Readable, Writable } from 'node:stream';
 import { Storage, StorageOptions } from '@google-cloud/storage';
 import { ReadableTyped } from '@naturalcycles/nodejs-lib';
 import { CommonStorage, CommonStorageGetOptions, FileEntry } from './commonStorage';

package/dist/commonStorage.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 /// <reference types="node" />
-import { Readable, Writable } from 'stream';
+import { Readable, Writable } from 'node:stream';
 import { ReadableTyped } from '@naturalcycles/nodejs-lib';
 export interface FileEntry {
     filePath: string;
@@ -40,18 +40,18 @@ export interface CommonStorage {
      *
      * Pass `bucketName` in case you only have permissions to operate on that bucket.
      */
-    ping(bucketName?: string): Promise<void>;
+    ping: (bucketName?: string) => Promise<void>;
     /**
      * Creates a new bucket by given name.
      * todo: check what to do if it already exists
      */
-    fileExists(bucketName: string, filePath: string): Promise<boolean>;
-    getFile(bucketName: string, filePath: string): Promise<Buffer | null>;
-    saveFile(bucketName: string, filePath: string, content: Buffer): Promise<void>;
+    fileExists: (bucketName: string, filePath: string) => Promise<boolean>;
+    getFile: (bucketName: string, filePath: string) => Promise<Buffer | null>;
+    saveFile: (bucketName: string, filePath: string, content: Buffer) => Promise<void>;
     /**
      * Should recursively delete all files in a folder, if path is a folder.
      */
-    deletePath(bucketName: string, prefix: string): Promise<void>;
+    deletePath: (bucketName: string, prefix: string) => Promise<void>;
     /**
      * Returns an array of strings which are file paths.
      * Files that are not found by the path are not present in the map.
@@ -63,13 +63,13 @@ export interface CommonStorage {
      * Important difference between `prefix` and `path` is that `prefix` will
      * return all files from sub-directories too!
      */
-    getFileNames(bucketName: string, opt?: CommonStorageGetOptions): Promise<string[]>;
-    getFileNamesStream(bucketName: string, opt?: CommonStorageGetOptions): ReadableTyped<string>;
-    getFilesStream(bucketName: string, opt?: CommonStorageGetOptions): ReadableTyped<FileEntry>;
-    getFileReadStream(bucketName: string, filePath: string): Readable;
-    getFileWriteStream(bucketName: string, filePath: string): Writable;
-    setFileVisibility(bucketName: string, filePath: string, isPublic: boolean): Promise<void>;
-    getFileVisibility(bucketName: string, filePath: string): Promise<boolean>;
-    copyFile(fromBucket: string, fromPath: string, toPath: string, toBucket?: string): Promise<void>;
-    moveFile(fromBucket: string, fromPath: string, toPath: string, toBucket?: string): Promise<void>;
+    getFileNames: (bucketName: string, opt?: CommonStorageGetOptions) => Promise<string[]>;
+    getFileNamesStream: (bucketName: string, opt?: CommonStorageGetOptions) => ReadableTyped<string>;
+    getFilesStream: (bucketName: string, opt?: CommonStorageGetOptions) => ReadableTyped<FileEntry>;
+    getFileReadStream: (bucketName: string, filePath: string) => Readable;
+    getFileWriteStream: (bucketName: string, filePath: string) => Writable;
+    setFileVisibility: (bucketName: string, filePath: string, isPublic: boolean) => Promise<void>;
+    getFileVisibility: (bucketName: string, filePath: string) => Promise<boolean>;
+    copyFile: (fromBucket: string, fromPath: string, toPath: string, toBucket?: string) => Promise<void>;
+    moveFile: (fromBucket: string, fromPath: string, toPath: string, toBucket?: string) => Promise<void>;
 }

package/dist/commonStorageBucket.d.ts

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

package/dist/inMemoryCommonStorage.d.ts

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

package/dist/inMemoryCommonStorage.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InMemoryCommonStorage = void 0;
-const stream_1 = require("stream");
+const node_stream_1 = require("node:stream");
 const js_lib_1 = require("@naturalcycles/js-lib");
 class InMemoryCommonStorage {
     constructor() {
@@ -16,7 +16,7 @@ class InMemoryCommonStorage {
         return Object.keys(this.data);
     }
     getBucketNamesStream() {
-        return stream_1.Readable.from(Object.keys(this.data));
+        return node_stream_1.Readable.from(Object.keys(this.data));
     }
     async fileExists(bucketName, filePath) {
         return !!this.data[bucketName]?.[filePath];
@@ -25,8 +25,7 @@ class InMemoryCommonStorage {
         return this.data[bucketName]?.[filePath] || null;
     }
     async saveFile(bucketName, filePath, content) {
-        var _a;
-        (_a = this.data)[bucketName] || (_a[bucketName] = {});
+        this.data[bucketName] ||= {};
         this.data[bucketName][filePath] = content;
     }
     async deletePath(bucketName, prefix) {
@@ -44,14 +43,14 @@ class InMemoryCommonStorage {
     }
     getFileNamesStream(bucketName, opt = {}) {
         const { prefix = '', fullPaths = true } = opt;
-        return stream_1.Readable.from(Object.keys(this.data[bucketName] || {})
+        return node_stream_1.Readable.from(Object.keys(this.data[bucketName] || {})
             .filter(filePath => filePath.startsWith(prefix))
             .slice(0, opt.limit)
             .map(n => (fullPaths ? n : (0, js_lib_1._substringAfterLast)(n, '/'))));
     }
     getFilesStream(bucketName, opt = {}) {
         const { prefix = '', fullPaths = true } = opt;
-        return stream_1.Readable.from(Object.entries(this.data[bucketName] || {})
+        return node_stream_1.Readable.from(Object.entries(this.data[bucketName] || {})
             .map(([filePath, content]) => ({
             filePath,
             content,
@@ -61,31 +60,28 @@ class InMemoryCommonStorage {
             .map(f => (fullPaths ? f : { ...f, filePath: (0, js_lib_1._substringAfterLast)(f.filePath, '/') })));
     }
     getFileReadStream(bucketName, filePath) {
-        return stream_1.Readable.from(this.data[bucketName][filePath]);
+        return node_stream_1.Readable.from(this.data[bucketName][filePath]);
     }
     getFileWriteStream(_bucketName, _filePath) {
         throw new Error('Method not implemented.');
     }
     async setFileVisibility(bucketName, filePath, isPublic) {
-        var _a;
-        (_a = this.publicMap)[bucketName] || (_a[bucketName] = {});
+        this.publicMap[bucketName] ||= {};
         this.publicMap[bucketName][filePath] = isPublic;
     }
     async getFileVisibility(bucketName, filePath) {
         return !!this.publicMap[bucketName]?.[filePath];
     }
     async copyFile(fromBucket, fromPath, toPath, toBucket) {
-        var _a, _b;
         const tob = toBucket || fromBucket;
-        (_a = this.data)[fromBucket] || (_a[fromBucket] = {});
-        (_b = this.data)[tob] || (_b[tob] = {});
+        this.data[fromBucket] ||= {};
+        this.data[tob] ||= {};
         this.data[tob][toPath] = this.data[fromBucket][fromPath];
     }
     async moveFile(fromBucket, fromPath, toPath, toBucket) {
-        var _a, _b;
         const tob = toBucket || fromBucket;
-        (_a = this.data)[fromBucket] || (_a[fromBucket] = {});
-        (_b = this.data)[tob] || (_b[tob] = {});
+        this.data[fromBucket] ||= {};
+        this.data[tob] ||= {};
         this.data[tob][toPath] = this.data[fromBucket][fromPath];
         delete this.data[fromBucket][fromPath];
     }

package/package.json

@@ -10,10 +10,10 @@
     "@naturalcycles/nodejs-lib": "^12.31.0"
   },
   "devDependencies": {
-    "@naturalcycles/dev-lib": "^12.1.3",
-    "@types/node": "^17.0.8",
-    "firebase-admin": "^10.0.1",
-    "jest": "^28.1.0"
+    "@naturalcycles/dev-lib": "^13.0.1",
+    "@types/node": "^18.0.0",
+    "firebase-admin": "^11.0.0",
+    "jest": "^29.1.2"
   },
   "files": [
     "dist",
@@ -33,9 +33,9 @@
     "url": "https://github.com/NaturalCycles/cloud-storage-lib"
   },
   "engines": {
-    "node": ">=14.16.0"
+    "node": ">=18.12.0"
   },
-  "version": "1.5.1",
+  "version": "1.5.3",
   "description": "",
   "author": "Natural Cycles Team",
   "license": "MIT"

package/src/cloudStorage.ts

@@ -1,4 +1,4 @@
-import { Readable, Writable } from 'stream'
+import { Readable, Writable } from 'node:stream'
 import { _substringAfterLast } from '@naturalcycles/js-lib'
 import { File, Storage, StorageOptions } from '@google-cloud/storage'
 import { ReadableTyped, transformMap, transformMapSimple } from '@naturalcycles/nodejs-lib'

package/src/commonStorage.ts

@@ -1,4 +1,4 @@
-import { Readable, Writable } from 'stream'
+import { Readable, Writable } from 'node:stream'
 import { ReadableTyped } from '@naturalcycles/nodejs-lib'
 
 export interface FileEntry {
@@ -45,7 +45,7 @@ export interface CommonStorage {
    *
    * Pass `bucketName` in case you only have permissions to operate on that bucket.
    */
-  ping(bucketName?: string): Promise<void>
+  ping: (bucketName?: string) => Promise<void>
 
   /**
    * Creates a new bucket by given name.
@@ -53,16 +53,16 @@ export interface CommonStorage {
    */
   // createBucket(bucketName: string): Promise<void>
 
-  fileExists(bucketName: string, filePath: string): Promise<boolean>
+  fileExists: (bucketName: string, filePath: string) => Promise<boolean>
 
-  getFile(bucketName: string, filePath: string): Promise<Buffer | null>
+  getFile: (bucketName: string, filePath: string) => Promise<Buffer | null>
 
-  saveFile(bucketName: string, filePath: string, content: Buffer): Promise<void>
+  saveFile: (bucketName: string, filePath: string, content: Buffer) => Promise<void>
 
   /**
    * Should recursively delete all files in a folder, if path is a folder.
    */
-  deletePath(bucketName: string, prefix: string): Promise<void>
+  deletePath: (bucketName: string, prefix: string) => Promise<void>
 
   /**
    * Returns an array of strings which are file paths.
@@ -75,20 +75,30 @@ export interface CommonStorage {
    * Important difference between `prefix` and `path` is that `prefix` will
    * return all files from sub-directories too!
    */
-  getFileNames(bucketName: string, opt?: CommonStorageGetOptions): Promise<string[]>
+  getFileNames: (bucketName: string, opt?: CommonStorageGetOptions) => Promise<string[]>
 
-  getFileNamesStream(bucketName: string, opt?: CommonStorageGetOptions): ReadableTyped<string>
+  getFileNamesStream: (bucketName: string, opt?: CommonStorageGetOptions) => ReadableTyped<string>
 
-  getFilesStream(bucketName: string, opt?: CommonStorageGetOptions): ReadableTyped<FileEntry>
+  getFilesStream: (bucketName: string, opt?: CommonStorageGetOptions) => ReadableTyped<FileEntry>
 
-  getFileReadStream(bucketName: string, filePath: string): Readable
+  getFileReadStream: (bucketName: string, filePath: string) => Readable
 
-  getFileWriteStream(bucketName: string, filePath: string): Writable
+  getFileWriteStream: (bucketName: string, filePath: string) => Writable
 
-  setFileVisibility(bucketName: string, filePath: string, isPublic: boolean): Promise<void>
+  setFileVisibility: (bucketName: string, filePath: string, isPublic: boolean) => Promise<void>
 
-  getFileVisibility(bucketName: string, filePath: string): Promise<boolean>
+  getFileVisibility: (bucketName: string, filePath: string) => Promise<boolean>
 
-  copyFile(fromBucket: string, fromPath: string, toPath: string, toBucket?: string): Promise<void>
-  moveFile(fromBucket: string, fromPath: string, toPath: string, toBucket?: string): Promise<void>
+  copyFile: (
+    fromBucket: string,
+    fromPath: string,
+    toPath: string,
+    toBucket?: string,
+  ) => Promise<void>
+  moveFile: (
+    fromBucket: string,
+    fromPath: string,
+    toPath: string,
+    toBucket?: string,
+  ) => Promise<void>
 }

package/src/commonStorageBucket.ts

@@ -1,4 +1,4 @@
-import { Readable, Writable } from 'stream'
+import { Readable, Writable } from 'node:stream'
 import { AppError, pMap } from '@naturalcycles/js-lib'
 import { ReadableTyped } from '@naturalcycles/nodejs-lib'
 import { CommonStorage, CommonStorageGetOptions, FileEntry } from './commonStorage'

package/src/inMemoryCommonStorage.ts

@@ -1,4 +1,4 @@
-import { Readable, Writable } from 'stream'
+import { Readable, Writable } from 'node:stream'
 import { _substringAfterLast, StringMap } from '@naturalcycles/js-lib'
 import { ReadableTyped } from '@naturalcycles/nodejs-lib'
 import { CommonStorage, CommonStorageGetOptions, FileEntry } from './commonStorage'