@naturalcycles/nodejs-lib 15.129.0 → 15.130.0

package/dist/cache/lruMemoCache.d.ts

@@ -1,4 +1,5 @@
 import type { AsyncMemoCache, MemoCache } from '@naturalcycles/js-lib/decorators';
+import { MISS } from '@naturalcycles/js-lib/types';
 import { LRUCache } from 'lru-cache';
 export type LRUMemoCacheOptions<KEY, VALUE> = Partial<LRUCache.Options<KEY, VALUE, any>>;
 /**
@@ -23,7 +24,7 @@ export declare class LRUAsyncMemoCache<KEY = any, VALUE = any> implements AsyncM
     constructor(opt: LRUMemoCacheOptions<KEY, VALUE>);
     private lru;
     has(k: any): Promise<boolean>;
-    get(k: any): Promise<any>;
+    get(k: any): Promise<VALUE | typeof MISS>;
     set(k: any, v: any): Promise<void>;
     clear(): Promise<void>;
 }

package/dist/cache/lruMemoCache.js

@@ -1,3 +1,4 @@
+import { MISS } from '@naturalcycles/js-lib/types';
 import { LRUCache } from 'lru-cache';
 /**
  * @example
@@ -27,6 +28,8 @@ export class LRUMemoCache {
         this.lru.clear();
     }
 }
+// lru-cache never stores `undefined` (`set(k, undefined)` deletes `k`), so it's stored as this sentinel
+const UNDEFINED = Symbol('undefined');
 /**
  * Same as LRUMemoCache, but implements AsyncMemoCache interface, for when you need it.
  */
@@ -42,10 +45,13 @@ export class LRUAsyncMemoCache {
         return this.lru.has(k);
     }
     async get(k) {
-        return this.lru.get(k);
+        const v = this.lru.get(k);
+        if (v === undefined)
+            return MISS;
+        return v === UNDEFINED ? undefined : v;
     }
     async set(k, v) {
-        this.lru.set(k, v);
+        this.lru.set(k, v === undefined ? UNDEFINED : v);
     }
     async clear() {
         this.lru.clear();

package/dist/fs/fs2.d.ts

@@ -24,11 +24,15 @@ declare class FS2 {
     readJsonAsync<T = unknown>(filePath: string): Promise<T>;
     writeFile(filePath: string, data: string | Buffer, opt?: WriteFileOptions): void;
     writeFileAsync(filePath: string, data: string | Buffer, opt?: WriteFileOptions): Promise<void>;
+    writePrettyJson(filePath: string, data: any): void;
     writeJson(filePath: string, data: any, opt?: JsonOptions): void;
+    writePrettyJsonAsync(filePath: string, data: any): Promise<void>;
     writeJsonAsync(filePath: string, data: any, opt?: JsonOptions): Promise<void>;
     appendFile(filePath: string, data: string | Buffer): void;
     appendFileAsync(filePath: string, data: string | Buffer): Promise<void>;
+    outputPrettyJson(filePath: string, data: any): void;
     outputJson(filePath: string, data: any, opt?: JsonOptions): void;
+    outputPrettyAsync(filePath: string, data: any): Promise<void>;
     outputJsonAsync(filePath: string, data: any, opt?: JsonOptions): Promise<void>;
     outputFile(filePath: string, data: string | Buffer): void;
     outputFileAsync(filePath: string, data: string | Buffer): Promise<void>;

package/dist/fs/fs2.js

@@ -61,10 +61,16 @@ class FS2 {
     async writeFileAsync(filePath, data, opt) {
         await fsp.writeFile(filePath, data, opt);
     }
+    writePrettyJson(filePath, data) {
+        this.writeJson(filePath, data, prettyJsonOptions);
+    }
     writeJson(filePath, data, opt) {
         const str = stringify(data, opt);
         fs.writeFileSync(filePath, str);
     }
+    async writePrettyJsonAsync(filePath, data) {
+        await this.writeJsonAsync(filePath, data, prettyJsonOptions);
+    }
     async writeJsonAsync(filePath, data, opt) {
         const str = stringify(data, opt);
         await fsp.writeFile(filePath, str);
@@ -75,10 +81,16 @@ class FS2 {
     async appendFileAsync(filePath, data) {
         await fsp.appendFile(filePath, data);
     }
+    outputPrettyJson(filePath, data) {
+        this.outputJson(filePath, data, prettyJsonOptions);
+    }
     outputJson(filePath, data, opt) {
         const str = stringify(data, opt);
         this.outputFile(filePath, str);
     }
+    async outputPrettyAsync(filePath, data) {
+        await this.outputJsonAsync(filePath, data, prettyJsonOptions);
+    }
     async outputJsonAsync(filePath, data, opt) {
         const str = stringify(data, opt);
         await this.outputFileAsync(filePath, str);
@@ -266,6 +278,7 @@ class FS2 {
     createReadStream = fs.createReadStream;
 }
 export const fs2 = new FS2();
+const prettyJsonOptions = { spaces: 2 };
 function stringify(data, opt) {
     // If pretty-printing is enabled (spaces) - also add a newline at the end (to match our prettier config)
     return JSON.stringify(data, null, opt?.spaces) + (opt?.spaces ? '\n' : '');

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/nodejs-lib",
   "type": "module",
-  "version": "15.129.0",
+  "version": "15.130.0",
   "dependencies": {
     "@naturalcycles/js-lib": "^15",
     "@standard-schema/spec": "^1",

package/src/cache/lruMemoCache.ts

@@ -1,4 +1,5 @@
 import type { AsyncMemoCache, MemoCache } from '@naturalcycles/js-lib/decorators'
+import { MISS } from '@naturalcycles/js-lib/types'
 import { LRUCache } from 'lru-cache'
 
 // Partial, to be able to provide default `max`
@@ -38,6 +39,9 @@ export class LRUMemoCache<KEY = any, VALUE = any> implements MemoCache<KEY, VALU
   }
 }
 
+// lru-cache never stores `undefined` (`set(k, undefined)` deletes `k`), so it's stored as this sentinel
+const UNDEFINED = Symbol('undefined')
+
 /**
  * Same as LRUMemoCache, but implements AsyncMemoCache interface, for when you need it.
  */
@@ -55,12 +59,14 @@ export class LRUAsyncMemoCache<KEY = any, VALUE = any> implements AsyncMemoCache
     return this.lru.has(k)
   }
 
-  async get(k: any): Promise<any> {
-    return this.lru.get(k)
+  async get(k: any): Promise<VALUE | typeof MISS> {
+    const v = this.lru.get(k)
+    if (v === undefined) return MISS
+    return v === UNDEFINED ? (undefined as VALUE) : v
   }
 
   async set(k: any, v: any): Promise<void> {
-    this.lru.set(k, v)
+    this.lru.set(k, v === undefined ? UNDEFINED : v)
   }
 
   async clear(): Promise<void> {

package/src/fs/fs2.ts

@@ -77,11 +77,19 @@ class FS2 {
     await fsp.writeFile(filePath, data, opt)
   }
 
+  writePrettyJson(filePath: string, data: any): void {
+    this.writeJson(filePath, data, prettyJsonOptions)
+  }
+
   writeJson(filePath: string, data: any, opt?: JsonOptions): void {
     const str = stringify(data, opt)
     fs.writeFileSync(filePath, str)
   }
 
+  async writePrettyJsonAsync(filePath: string, data: any): Promise<void> {
+    await this.writeJsonAsync(filePath, data, prettyJsonOptions)
+  }
+
   async writeJsonAsync(filePath: string, data: any, opt?: JsonOptions): Promise<void> {
     const str = stringify(data, opt)
     await fsp.writeFile(filePath, str)
@@ -95,11 +103,19 @@ class FS2 {
     await fsp.appendFile(filePath, data)
   }
 
+  outputPrettyJson(filePath: string, data: any): void {
+    this.outputJson(filePath, data, prettyJsonOptions)
+  }
+
   outputJson(filePath: string, data: any, opt?: JsonOptions): void {
     const str = stringify(data, opt)
     this.outputFile(filePath, str)
   }
 
+  async outputPrettyAsync(filePath: string, data: any): Promise<void> {
+    await this.outputJsonAsync(filePath, data, prettyJsonOptions)
+  }
+
   async outputJsonAsync(filePath: string, data: any, opt?: JsonOptions): Promise<void> {
     const str = stringify(data, opt)
     await this.outputFileAsync(filePath, str)
@@ -311,6 +327,8 @@ class FS2 {
 
 export const fs2 = new FS2()
 
+const prettyJsonOptions: JsonOptions = { spaces: 2 }
+
 export interface JsonOptions {
   spaces?: number
 }