@brianbuie/node-kit 0.7.0 → 0.8.0

package/README.md

@@ -32,7 +32,6 @@ Links: [API](#api), [Classes](#classes), [Functions](#functions), [Types](#types
 | [FileTypeCsv](#class-filetypecsv) |
 | [FileTypeJson](#class-filetypejson) |
 | [FileTypeNdjson](#class-filetypendjson) |
-| [Jwt](#class-jwt) |
 | [Log](#class-log) |
 | [TempDir](#class-tempdir) |
 | [TypeWriter](#class-typewriter) |
@@ -43,16 +42,20 @@ Links: [API](#api), [Classes](#classes), [Functions](#functions), [Types](#types
 
 ## Class: Cache
 
-Save results of a function in a temporary file.
+Save data to a local file with an expiration.
+Fresh/stale data is returned with a flag for if it's fresh or not,
+so stale data can still be used if needed.
 
 ```ts
 export class Cache<T> {
     file;
     ttl;
-    getValue;
-    constructor(key: string, ttl: number, getValue: () => T | Promise<T>) 
-    async read() 
-    async write() 
+    constructor(key: string, ttl: number | Duration, initialData?: T) 
+    write(data: T) 
+    read(): [
+        T | undefined,
+        boolean
+    ] 
 }
 ```
 
@@ -244,10 +247,10 @@ export class File {
     path;
     constructor(filepath: string) 
     get exists() 
-    createWriteStream(options: Parameters<typeof fs.createWriteStream>[1] = {}) 
     delete() 
     read() 
     write(contents: string) 
+    async streamFrom(...options: Parameters<(typeof Readable)["from"]>) 
     append(lines: string | string[]) 
     lines() 
     static get FileType() 
@@ -349,25 +352,6 @@ See also: [FileType](#class-filetype)
 
 Links: [API](#api), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
 
----
-## Class: Jwt
-
-```ts
-export class Jwt {
-    config;
-    #saved?: {
-        exp: number;
-        token: string;
-    };
-    constructor(config: JwtConfig) 
-    get now() 
-    #createToken() 
-    get token() 
-}
-```
-
-Links: [API](#api), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
-
 ---
 ## Class: Log
 

package/dist/Cache.d.ts

@@ -1,17 +1,16 @@
+import { type Duration } from 'date-fns';
 /**
- * Save results of a function in a temporary file.
- * @param key A unique name for the file
- * @param ttl cache duration in ms
- * @param getValue the function to populate the cache (eg. fetch results, generate key, etc)
+ * Save data to a local file with an expiration.
+ * Fresh/stale data is returned with a flag for if it's fresh or not,
+ * so stale data can still be used if needed.
  */
 export declare class Cache<T> {
     file: import("./File.js").FileTypeJson<{
-        createdAt: number;
-        value: T;
+        savedAt: string;
+        data: T;
     }>;
-    ttl: number;
-    getValue: () => T | Promise<T>;
-    constructor(key: string, ttl: number, getValue: () => T | Promise<T>);
-    read(): Promise<T>;
-    write(): Promise<T>;
+    ttl: Duration;
+    constructor(key: string, ttl: number | Duration, initialData?: T);
+    write(data: T): void;
+    read(): [T | undefined, boolean];
 }

package/dist/Cache.js

@@ -1,29 +1,26 @@
+import { isAfter, add } from 'date-fns';
 import { temp } from './Dir.js';
 const cacheDir = temp.dir('cache');
 /**
- * Save results of a function in a temporary file.
- * @param key A unique name for the file
- * @param ttl cache duration in ms
- * @param getValue the function to populate the cache (eg. fetch results, generate key, etc)
+ * Save data to a local file with an expiration.
+ * Fresh/stale data is returned with a flag for if it's fresh or not,
+ * so stale data can still be used if needed.
  */
 export class Cache {
     file;
     ttl;
-    getValue;
-    constructor(key, ttl, getValue) {
+    constructor(key, ttl, initialData) {
         this.file = cacheDir.file(key).json();
-        this.ttl = ttl;
-        this.getValue = getValue;
+        this.ttl = typeof ttl === 'number' ? { minutes: ttl } : ttl;
+        if (initialData)
+            this.write(initialData);
     }
-    async read() {
-        const { createdAt, value } = this.file.read() || {};
-        if (value && createdAt && createdAt + this.ttl > Date.now())
-            return value;
-        return this.write();
+    write(data) {
+        this.file.write({ savedAt: new Date().toUTCString(), data });
     }
-    async write() {
-        const value = await this.getValue();
-        this.file.write({ createdAt: Date.now(), value });
-        return value;
+    read() {
+        const { savedAt, data } = this.file.read() || {};
+        const isFresh = Boolean(savedAt && isAfter(add(savedAt, this.ttl), new Date()));
+        return [data, isFresh];
     }
 }

package/dist/Dir.js

@@ -30,7 +30,7 @@ export class Dir {
         return new Dir(path.resolve(this.path, subPath));
     }
     sanitize(name) {
-        return sanitizeFilename(name.replace('https://', '').replace('www.', ''), { replacement: '_' });
+        return sanitizeFilename(name.replace('https://', '').replace('www.', ''), { replacement: '_' }).slice(-200);
     }
     /**
      * @param base - The file name with extension

package/dist/File.d.ts

@@ -1,4 +1,4 @@
-import * as fs from 'node:fs';
+import { Readable } from 'node:stream';
 /**
  * WARNING: API will change!
  */
@@ -6,10 +6,10 @@ export declare class File {
     path: string;
     constructor(filepath: string);
     get exists(): boolean;
-    createWriteStream(options?: Parameters<typeof fs.createWriteStream>[1]): fs.WriteStream;
     delete(): void;
     read(): string | undefined;
     write(contents: string): void;
+    streamFrom(...options: Parameters<(typeof Readable)['from']>): Promise<void>;
     /**
      * creates file if it doesn't exist, appends string or array of strings as new lines.
      * File always ends with '\n', so contents don't need to be read before appending

package/dist/File.js

@@ -1,5 +1,7 @@
 import * as fs from 'node:fs';
 import * as path from 'node:path';
+import { Readable } from 'node:stream';
+import { finished } from 'node:stream/promises';
 import { writeToString, parseString } from 'fast-csv';
 import { snapshot } from './snapshot.js';
 /**
@@ -13,9 +15,6 @@ export class File {
     get exists() {
         return fs.existsSync(this.path);
     }
-    createWriteStream(options = {}) {
-        return fs.createWriteStream(this.path, options);
-    }
     delete() {
         fs.rmSync(this.path, { force: true });
     }
@@ -26,6 +25,9 @@ export class File {
         fs.mkdirSync(path.parse(this.path).dir, { recursive: true });
         fs.writeFileSync(this.path, contents);
     }
+    async streamFrom(...options) {
+        return finished(Readable.from(...options).pipe(fs.createWriteStream(this.path)));
+    }
     /**
      * creates file if it doesn't exist, appends string or array of strings as new lines.
      * File always ends with '\n', so contents don't need to be read before appending

package/dist/index.d.ts

@@ -2,7 +2,6 @@ export { Dir, TempDir, temp } from './Dir.js';
 export { Cache } from './Cache.js';
 export { Fetcher, type Route, type Query, type FetchOptions } from './Fetcher.js';
 export { File, FileType, FileTypeJson, FileTypeNdjson, FileTypeCsv } from './File.js';
-export { Jwt } from './Jwt.js';
 export { Log } from './Log.js';
 export { snapshot } from './snapshot.js';
 export { timeout } from './timeout.js';

package/dist/index.js

@@ -2,7 +2,6 @@ export { Dir, TempDir, temp } from './Dir.js';
 export { Cache } from './Cache.js';
 export { Fetcher } from './Fetcher.js';
 export { File, FileType, FileTypeJson, FileTypeNdjson, FileTypeCsv } from './File.js';
-export { Jwt } from './Jwt.js';
 export { Log } from './Log.js';
 export { snapshot } from './snapshot.js';
 export { timeout } from './timeout.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brianbuie/node-kit",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "license": "ISC",
   "repository": {
     "type": "git",
@@ -30,15 +30,14 @@
   },
   "dependencies": {
     "chalk": "^5.6.2",
+    "date-fns": "^4.1.0",
     "extract-domain": "^5.0.2",
     "fast-csv": "^5.0.5",
-    "jsonwebtoken": "^9.0.2",
     "lodash-es": "^4.17.21",
     "quicktype-core": "^23.2.6",
     "sanitize-filename": "^1.6.3"
   },
   "devDependencies": {
-    "@types/jsonwebtoken": "^9.0.10",
     "@types/lodash-es": "^4.17.12",
     "@types/node": "^24.9.1",
     "ts2md": "^0.2.8",

package/src/Cache.ts

@@ -1,33 +1,30 @@
+import { type Duration, isAfter, add } from 'date-fns';
 import { temp } from './Dir.js';
 
 const cacheDir = temp.dir('cache');
 
 /**
- * Save results of a function in a temporary file.
- * @param key A unique name for the file
- * @param ttl cache duration in ms
- * @param getValue the function to populate the cache (eg. fetch results, generate key, etc)
+ * Save data to a local file with an expiration.
+ * Fresh/stale data is returned with a flag for if it's fresh or not,
+ * so stale data can still be used if needed.
  */
 export class Cache<T> {
   file;
   ttl;
-  getValue;
 
-  constructor(key: string, ttl: number, getValue: () => T | Promise<T>) {
-    this.file = cacheDir.file(key).json<{ createdAt: number; value: T }>();
-    this.ttl = ttl;
-    this.getValue = getValue;
+  constructor(key: string, ttl: number | Duration, initialData?: T) {
+    this.file = cacheDir.file(key).json<{ savedAt: string; data: T }>();
+    this.ttl = typeof ttl === 'number' ? { minutes: ttl } : ttl;
+    if (initialData) this.write(initialData);
   }
 
-  async read() {
-    const { createdAt, value } = this.file.read() || {};
-    if (value && createdAt && createdAt + this.ttl > Date.now()) return value;
-    return this.write();
+  write(data: T) {
+    this.file.write({ savedAt: new Date().toUTCString(), data });
   }
 
-  async write() {
-    const value = await this.getValue();
-    this.file.write({ createdAt: Date.now(), value });
-    return value;
+  read(): [T | undefined, boolean] {
+    const { savedAt, data } = this.file.read() || {};
+    const isFresh = Boolean(savedAt && isAfter(add(savedAt, this.ttl), new Date()));
+    return [data, isFresh];
   }
 }

package/src/Dir.ts

@@ -35,7 +35,7 @@ export class Dir {
   }
 
   sanitize(name: string) {
-    return sanitizeFilename(name.replace('https://', '').replace('www.', ''), { replacement: '_' });
+    return sanitizeFilename(name.replace('https://', '').replace('www.', ''), { replacement: '_' }).slice(-200);
   }
 
   /**

package/src/File.test.ts

@@ -35,6 +35,19 @@ describe('FileType', () => {
   });
 });
 
+describe('File', () => {
+  it('Handles request body as stream input', async () => {
+    const res = await fetch('https://testingbot.com/free-online-tools/random-avatar/300');
+    const img = testDir.file('image.jpg');
+    if (res.body) {
+      await img.streamFrom(res.body);
+      assert(img.exists);
+    } else {
+      assert(false, 'No response body');
+    }
+  });
+});
+
 describe('File.ndjson', () => {
   it('Appends new lines correctly', () => {
     const file = testDir.file('appends-lines').ndjson();

package/src/File.ts

@@ -1,5 +1,7 @@
 import * as fs from 'node:fs';
 import * as path from 'node:path';
+import { Readable } from 'node:stream';
+import { finished } from 'node:stream/promises';
 import { writeToString, parseString } from 'fast-csv';
 import { snapshot } from './snapshot.js';
 
@@ -17,10 +19,6 @@ export class File {
     return fs.existsSync(this.path);
   }
 
-  createWriteStream(options: Parameters<typeof fs.createWriteStream>[1] = {}) {
-    return fs.createWriteStream(this.path, options);
-  }
-
   delete() {
     fs.rmSync(this.path, { force: true });
   }
@@ -34,6 +32,10 @@ export class File {
     fs.writeFileSync(this.path, contents);
   }
 
+  async streamFrom(...options: Parameters<(typeof Readable)['from']>) {
+    return finished(Readable.from(...options).pipe(fs.createWriteStream(this.path)));
+  }
+
   /**
    * creates file if it doesn't exist, appends string or array of strings as new lines.
    * File always ends with '\n', so contents don't need to be read before appending
@@ -133,7 +135,7 @@ export class FileTypeNdjson<T extends object> extends FileType {
 
   append(lines: T | T[]) {
     this.file.append(
-      Array.isArray(lines) ? lines.map((l) => JSON.stringify(snapshot(l))) : JSON.stringify(snapshot(lines))
+      Array.isArray(lines) ? lines.map((l) => JSON.stringify(snapshot(l))) : JSON.stringify(snapshot(lines)),
     );
   }
 
@@ -186,8 +188,8 @@ export class FileTypeCsv<Row extends object> extends FileType {
                 ...all,
                 [key]: parseVal(val as string),
               }),
-              {} as Row
-            )
+              {} as Row,
+            ),
           );
         });
     });

package/src/index.ts

@@ -2,7 +2,6 @@ export { Dir, TempDir, temp } from './Dir.js';
 export { Cache } from './Cache.js';
 export { Fetcher, type Route, type Query, type FetchOptions } from './Fetcher.js';
 export { File, FileType, FileTypeJson, FileTypeNdjson, FileTypeCsv } from './File.js';
-export { Jwt } from './Jwt.js';
 export { Log } from './Log.js';
 export { snapshot } from './snapshot.js';
 export { timeout } from './timeout.js';

package/dist/Jwt.d.ts

@@ -1,15 +0,0 @@
-import { type JwtPayload, type SignOptions } from 'jsonwebtoken';
-type JwtConfig = {
-    payload: JwtPayload;
-    options: SignOptions;
-    seconds: number;
-    key: string;
-};
-export declare class Jwt {
-    #private;
-    config: JwtConfig;
-    constructor(config: JwtConfig);
-    get now(): number;
-    get token(): string;
-}
-export {};

package/dist/Jwt.js

@@ -1,29 +0,0 @@
-import { default as jsonwebtoken } from 'jsonwebtoken';
-import { merge } from 'lodash-es';
-export class Jwt {
-    config;
-    #saved;
-    constructor(config) {
-        this.config = config;
-        this.#createToken();
-    }
-    get now() {
-        return Math.floor(Date.now() / 1000);
-    }
-    #createToken() {
-        const exp = this.now + this.config.seconds;
-        const payload = merge({
-            iat: this.now,
-            exp,
-        }, this.config.payload);
-        const token = jsonwebtoken.sign(payload, this.config.key, this.config.options);
-        this.#saved = { token, exp };
-        return token;
-    }
-    get token() {
-        if (this.#saved && this.#saved.exp > this.now) {
-            return this.#saved.token;
-        }
-        return this.#createToken();
-    }
-}

package/src/Jwt.test.ts

@@ -1,22 +0,0 @@
-import { describe, it } from 'node:test';
-import assert from 'node:assert';
-import jsonwebtoken from 'jsonwebtoken';
-import { Jwt } from './Jwt.js';
-
-describe('Jwt', () => {
-  it('Creates a valid JWT', () => {
-    const key = 'test';
-    const jwt = new Jwt({
-      payload: {
-        example: 'value',
-      },
-      options: {
-        algorithm: 'HS256',
-      },
-      seconds: 60,
-      key,
-    });
-    const result = jsonwebtoken.verify(jwt.token, key);
-    assert(typeof result !== 'string' && result.example === 'value');
-  });
-});

package/src/Jwt.ts

@@ -1,47 +0,0 @@
-import { default as jsonwebtoken, type JwtPayload, type SignOptions } from 'jsonwebtoken';
-import { merge } from 'lodash-es';
-
-type JwtConfig = {
-  payload: JwtPayload;
-  options: SignOptions;
-  seconds: number;
-  key: string;
-};
-
-export class Jwt {
-  config;
-  #saved?: {
-    exp: number;
-    token: string;
-  };
-
-  constructor(config: JwtConfig) {
-    this.config = config;
-    this.#createToken();
-  }
-
-  get now() {
-    return Math.floor(Date.now() / 1000);
-  }
-
-  #createToken() {
-    const exp = this.now + this.config.seconds;
-    const payload: JwtPayload = merge(
-      {
-        iat: this.now,
-        exp,
-      },
-      this.config.payload
-    );
-    const token = jsonwebtoken.sign(payload, this.config.key, this.config.options);
-    this.#saved = { token, exp };
-    return token;
-  }
-
-  get token() {
-    if (this.#saved && this.#saved.exp > this.now) {
-      return this.#saved.token;
-    }
-    return this.#createToken();
-  }
-}