@naturalcycles/cloud-storage-lib 1.13.1 → 1.13.3

package/dist/cloudStorage.d.ts

@@ -3,7 +3,7 @@ import { CommonLogger, LocalTimeInput } from '@naturalcycles/js-lib';
 import type { ReadableBinary, ReadableTyped, WritableBinary } from '@naturalcycles/nodejs-lib';
 import type { CommonStorage, CommonStorageGetOptions, FileEntry } from './commonStorage';
 import type { GCPServiceAccount } from './model';
-export { type Storage, type StorageOptions, };
+export type { Storage, StorageOptions, };
 /**
  * This object is intentionally made to NOT extend StorageOptions,
  * because StorageOptions is complicated and provides just too many ways

package/dist/commonStorageKeyValueDB.d.ts

@@ -1,4 +1,6 @@
-import { CommonDBCreateOptions, CommonKeyValueDB, KeyValueDBTuple } from '@naturalcycles/db-lib';
+import { CommonDBCreateOptions, CommonKeyValueDB } from '@naturalcycles/db-lib';
+import { IncrementTuple } from '@naturalcycles/db-lib/dist/kv/commonKeyValueDB';
+import { KeyValueTuple } from '@naturalcycles/js-lib';
 import { ReadableTyped } from '@naturalcycles/nodejs-lib';
 import { CommonStorage } from './commonStorage';
 export interface CommonStorageKeyValueDBCfg {
@@ -16,6 +18,10 @@ export interface CommonStorageKeyValueDBCfg {
 export declare class CommonStorageKeyValueDB implements CommonKeyValueDB {
     cfg: CommonStorageKeyValueDBCfg;
     constructor(cfg: CommonStorageKeyValueDBCfg);
+    support: {
+        increment: boolean;
+        count?: boolean;
+    };
     ping(): Promise<void>;
     createTable(_table: string, _opt?: CommonDBCreateOptions): Promise<void>;
     /**
@@ -23,11 +29,11 @@ export declare class CommonStorageKeyValueDB implements CommonKeyValueDB {
      */
     private getBucketAndPrefix;
     deleteByIds(table: string, ids: string[]): Promise<void>;
-    getByIds(table: string, ids: string[]): Promise<KeyValueDBTuple[]>;
-    saveBatch(table: string, entries: KeyValueDBTuple[]): Promise<void>;
+    getByIds<V>(table: string, ids: string[]): Promise<KeyValueTuple<string, V>[]>;
+    saveBatch<V>(table: string, entries: KeyValueTuple<string, V>[]): Promise<void>;
     streamIds(table: string, limit?: number): ReadableTyped<string>;
-    streamValues(table: string, limit?: number): ReadableTyped<Buffer>;
-    streamEntries(table: string, limit?: number): ReadableTyped<KeyValueDBTuple>;
+    streamValues<V>(table: string, limit?: number): ReadableTyped<V>;
+    streamEntries<V>(table: string, limit?: number): ReadableTyped<KeyValueTuple<string, V>>;
     count(table: string): Promise<number>;
-    increment(_table: string, _id: string, _by?: number): Promise<number>;
+    incrementBatch(_table: string, _entries: IncrementTuple[]): Promise<IncrementTuple[]>;
 }

package/dist/commonStorageKeyValueDB.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CommonStorageKeyValueDB = void 0;
+const db_lib_1 = require("@naturalcycles/db-lib");
 const js_lib_1 = require("@naturalcycles/js-lib");
 /**
  * CommonKeyValueDB, backed up by a CommonStorage implementation.
@@ -13,6 +14,10 @@ const js_lib_1 = require("@naturalcycles/js-lib");
 class CommonStorageKeyValueDB {
     constructor(cfg) {
         this.cfg = cfg;
+        this.support = {
+            ...db_lib_1.commonKeyValueDBFullSupport,
+            increment: false,
+        };
     }
     async ping() {
         await this.cfg.storage.ping(this.cfg.bucketName);
@@ -77,8 +82,8 @@ class CommonStorageKeyValueDB {
         const { bucketName, prefix } = this.getBucketAndPrefix(table);
         return (await this.cfg.storage.getFileNames(bucketName, { prefix })).length;
     }
-    async increment(_table, _id, _by) {
-        throw new js_lib_1.AppError('CommonStorageKeyValueDB.increment() is not implemented');
+    async incrementBatch(_table, _entries) {
+        throw new js_lib_1.AppError('CommonStorageKeyValueDB.incrementBatch() is not implemented');
     }
 }
 exports.CommonStorageKeyValueDB = CommonStorageKeyValueDB;

package/package.json

@@ -1,7 +1,12 @@
 {
   "name": "@naturalcycles/cloud-storage-lib",
   "scripts": {
-    "prepare": "husky"
+    "prepare": "husky",
+    "build": "dev-lib build",
+    "test": "dev-lib test",
+    "lint": "dev-lib lint",
+    "bt": "dev-lib bt",
+    "lbt": "dev-lib lbt"
   },
   "dependencies": {
     "@google-cloud/storage": "^7.0.0",
@@ -11,7 +16,7 @@
   },
   "devDependencies": {
     "@naturalcycles/dev-lib": "^15.18.0",
-    "@types/node": "^20.4.6",
+    "@types/node": "^22.7.4",
     "firebase-admin": "^12.0.0",
     "jest": "^29.1.2"
   },
@@ -33,9 +38,9 @@
     "url": "https://github.com/NaturalCycles/cloud-storage-lib"
   },
   "engines": {
-    "node": ">=18.12.0"
+    "node": ">=20.13.0"
   },
-  "version": "1.13.1",
+  "version": "1.13.3",
   "description": "CommonStorage implementation based on Google Cloud Storage",
   "author": "Natural Cycles Team",
   "license": "MIT"

package/src/cloudStorage.ts

@@ -1,6 +1,6 @@
-// eslint-disable-next-line import/no-duplicates
+// eslint-disable-next-line import-x/no-duplicates
 import type { File, Storage, StorageOptions } from '@google-cloud/storage'
-// eslint-disable-next-line import/no-duplicates
+// eslint-disable-next-line import-x/no-duplicates
 import type * as StorageLib from '@google-cloud/storage'
 import {
   _assert,
@@ -17,10 +17,10 @@ import type { ReadableBinary, ReadableTyped, WritableBinary } from '@naturalcycl
 import type { CommonStorage, CommonStorageGetOptions, FileEntry } from './commonStorage'
 import type { GCPServiceAccount } from './model'
 
-export {
+export type {
   // This is the latest version, to be imported by consumers
-  type Storage,
-  type StorageOptions,
+  Storage,
+  StorageOptions,
 }
 
 const MAX_RECURSION_DEPTH = 10

package/src/commonStorageKeyValueDB.ts

@@ -1,5 +1,10 @@
-import { CommonDBCreateOptions, CommonKeyValueDB, KeyValueDBTuple } from '@naturalcycles/db-lib'
-import { AppError, pMap, StringMap } from '@naturalcycles/js-lib'
+import {
+  CommonDBCreateOptions,
+  CommonKeyValueDB,
+  commonKeyValueDBFullSupport,
+} from '@naturalcycles/db-lib'
+import { IncrementTuple } from '@naturalcycles/db-lib/dist/kv/commonKeyValueDB'
+import { AppError, KeyValueTuple, pMap, StringMap } from '@naturalcycles/js-lib'
 import { ReadableTyped } from '@naturalcycles/nodejs-lib'
 import { CommonStorage } from './commonStorage'
 
@@ -19,6 +24,11 @@ export interface CommonStorageKeyValueDBCfg {
 export class CommonStorageKeyValueDB implements CommonKeyValueDB {
   constructor(public cfg: CommonStorageKeyValueDBCfg) {}
 
+  support = {
+    ...commonKeyValueDBFullSupport,
+    increment: false,
+  }
+
   async ping(): Promise<void> {
     await this.cfg.storage.ping(this.cfg.bucketName)
   }
@@ -54,7 +64,7 @@ export class CommonStorageKeyValueDB implements CommonKeyValueDB {
     })
   }
 
-  async getByIds(table: string, ids: string[]): Promise<KeyValueDBTuple[]> {
+  async getByIds<V>(table: string, ids: string[]): Promise<KeyValueTuple<string, V>[]> {
     const { bucketName, prefix } = this.getBucketAndPrefix(table)
 
     const map: StringMap<Buffer> = {}
@@ -64,14 +74,14 @@ export class CommonStorageKeyValueDB implements CommonKeyValueDB {
       if (buf) map[id] = buf
     })
 
-    return ids.map(id => [id, map[id]] as KeyValueDBTuple).filter(t => t[1])
+    return ids.map(id => [id, map[id]] as KeyValueTuple<string, V>).filter(t => t[1])
   }
 
-  async saveBatch(table: string, entries: KeyValueDBTuple[]): Promise<void> {
+  async saveBatch<V>(table: string, entries: KeyValueTuple<string, V>[]): Promise<void> {
     const { bucketName, prefix } = this.getBucketAndPrefix(table)
 
     await pMap(entries, async ([id, content]) => {
-      await this.cfg.storage.saveFile(bucketName, [prefix, id].join('/'), content)
+      await this.cfg.storage.saveFile(bucketName, [prefix, id].join('/'), content as Buffer)
     })
   }
 
@@ -81,18 +91,18 @@ export class CommonStorageKeyValueDB implements CommonKeyValueDB {
     return this.cfg.storage.getFileNamesStream(bucketName, { prefix, limit, fullPaths: false })
   }
 
-  streamValues(table: string, limit?: number): ReadableTyped<Buffer> {
+  streamValues<V>(table: string, limit?: number): ReadableTyped<V> {
     const { bucketName, prefix } = this.getBucketAndPrefix(table)
 
-    return this.cfg.storage.getFilesStream(bucketName, { prefix, limit }).map(f => f.content)
+    return this.cfg.storage.getFilesStream(bucketName, { prefix, limit }).map(f => f.content as V)
   }
 
-  streamEntries(table: string, limit?: number): ReadableTyped<KeyValueDBTuple> {
+  streamEntries<V>(table: string, limit?: number): ReadableTyped<KeyValueTuple<string, V>> {
     const { bucketName, prefix } = this.getBucketAndPrefix(table)
 
     return this.cfg.storage
       .getFilesStream(bucketName, { prefix, limit, fullPaths: false })
-      .map(f => [f.filePath, f.content] satisfies KeyValueDBTuple)
+      .map(f => [f.filePath, f.content as V])
   }
 
   async count(table: string): Promise<number> {
@@ -101,7 +111,7 @@ export class CommonStorageKeyValueDB implements CommonKeyValueDB {
     return (await this.cfg.storage.getFileNames(bucketName, { prefix })).length
   }
 
-  async increment(_table: string, _id: string, _by?: number): Promise<number> {
-    throw new AppError('CommonStorageKeyValueDB.increment() is not implemented')
+  async incrementBatch(_table: string, _entries: IncrementTuple[]): Promise<IncrementTuple[]> {
+    throw new AppError('CommonStorageKeyValueDB.incrementBatch() is not implemented')
   }
 }