@furystack/filesystem-store 4.0.0 → 4.0.2

package/{types → esm}/filesystem-store.d.ts

@@ -1,5 +1,5 @@
-/// <reference types="node" />
-/// <reference types="node" />
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
 import { promises } from 'fs';
 import type { Constructable } from '@furystack/inject';
 import type { PhysicalStore, FindOptions, FilterType } from '@furystack/core';

package/esm/filesystem-store.js

@@ -0,0 +1,108 @@
+import { promises, watch } from 'fs';
+import { Lock } from 'semaphore-async-await';
+import { InMemoryStore } from '@furystack/core';
+/**
+ * Store implementation that stores info in a simple JSON file
+ */
+export class FileSystemStore {
+    get cache() {
+        return this.inMemoryStore.cache;
+    }
+    async remove(...keys) {
+        await this.fileLock.execute(async () => {
+            await this.inMemoryStore.remove(...keys);
+        });
+        this.hasChanges = true;
+    }
+    async get(key, select) {
+        return await this.fileLock.execute(async () => {
+            return await this.inMemoryStore.get(key, select);
+        });
+    }
+    async add(...entries) {
+        const result = await this.fileLock.execute(async () => {
+            return await this.inMemoryStore.add(...entries);
+        });
+        this.hasChanges = true;
+        return result;
+    }
+    async find(filter) {
+        return await this.fileLock.execute(async () => {
+            return this.inMemoryStore.find(filter);
+        });
+    }
+    async count(filter) {
+        return await this.fileLock.execute(async () => {
+            return this.inMemoryStore.count(filter);
+        });
+    }
+    async saveChanges() {
+        if (!this.hasChanges) {
+            return;
+        }
+        try {
+            await this.fileLock.acquire();
+            const values = [];
+            for (const key of this.cache.keys()) {
+                values.push(this.cache.get(key));
+            }
+            await this.writeFile(this.options.fileName, JSON.stringify(values));
+            this.hasChanges = false;
+        }
+        finally {
+            this.fileLock.release();
+        }
+    }
+    async dispose() {
+        await this.saveChanges();
+        this.watcher && this.watcher.close();
+        clearInterval(this.tick);
+    }
+    async reloadData() {
+        try {
+            await this.fileLock.acquire();
+            const data = await this.readFile(this.options.fileName);
+            const json = (data ? JSON.parse(data.toString()) : []);
+            this.cache.clear();
+            for (const entity of json) {
+                this.cache.set(entity[this.primaryKey], entity);
+            }
+        }
+        catch (err) {
+            // ignore if file not exists yet
+            if (err instanceof Error && err.code !== 'ENOENT') {
+                throw err;
+            }
+        }
+        finally {
+            this.fileLock.release();
+        }
+    }
+    async update(id, data) {
+        await this.fileLock.execute(async () => {
+            return this.inMemoryStore.update(id, data);
+        });
+        this.hasChanges = true;
+    }
+    constructor(options) {
+        this.options = options;
+        this.tick = setInterval(() => this.saveChanges(), this.options.tickMs || 3000);
+        this.hasChanges = false;
+        this.fileLock = new Lock();
+        this.readFile = promises.readFile;
+        this.writeFile = promises.writeFile;
+        this.primaryKey = options.primaryKey;
+        this.model = options.model;
+        this.inMemoryStore = new InMemoryStore({ model: this.model, primaryKey: this.primaryKey });
+        try {
+            this.reloadData();
+            this.watcher = watch(this.options.fileName, { encoding: 'buffer' }, () => {
+                this.reloadData();
+            });
+        }
+        catch (error) {
+            // Error registering file watcher for store. External updates won't be updated.
+        }
+    }
+}
+//# sourceMappingURL=filesystem-store.js.map

package/esm/filesystem-store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"filesystem-store.js","sourceRoot":"","sources":["../src/filesystem-store.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,IAAI,CAAA;AAEpC,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAA;AAE5C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE/C;;GAEG;AACH,MAAM,OAAO,eAAe;IAS1B,IAAY,KAAK;QACf,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,CAAA;IACjC,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,GAAG,IAA2B;QAChD,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE;YACrC,MAAM,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAA;QAC1C,CAAC,CAAC,CAAA;QACF,IAAI,CAAC,UAAU,GAAG,IAAI,CAAA;IACxB,CAAC;IAIM,KAAK,CAAC,GAAG,CAAC,GAAmB,EAAE,MAAuB;QAC3D,OAAO,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE;YAC5C,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAA;QAClD,CAAC,CAAC,CAAA;IACJ,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,GAAG,OAAY;QAC9B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE;YACpD,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,CAAA;QACjD,CAAC,CAAC,CAAA;QACF,IAAI,CAAC,UAAU,GAAG,IAAI,CAAA;QACtB,OAAO,MAAM,CAAA;IACf,CAAC;IAEM,KAAK,CAAC,IAAI,CAAiC,MAA+B;QAC/E,OAAO,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE;YAC5C,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACxC,CAAC,CAAC,CAAA;IACJ,CAAC;IAEM,KAAK,CAAC,KAAK,CAAC,MAAsB;QACvC,OAAO,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE;YAC5C,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;QACzC,CAAC,CAAC,CAAA;IACJ,CAAC;IAGM,KAAK,CAAC,WAAW;QACtB,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YACpB,OAAM;SACP;QACD,IAAI;YACF,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAA;YAC7B,MAAM,MAAM,GAAQ,EAAE,CAAA;YACtB,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE;gBACnC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAM,CAAC,CAAA;aACtC;YACD,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAA;YACnE,IAAI,CAAC,UAAU,GAAG,KAAK,CAAA;SACxB;gBAAS;YACR,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAA;SACxB;IACH,CAAC;IAEM,KAAK,CAAC,OAAO;QAClB,MAAM,IAAI,CAAC,WAAW,EAAE,CAAA;QACxB,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAA;QACpC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAC1B,CAAC;IAEM,KAAK,CAAC,UAAU;QACrB,IAAI;YACF,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAA;YAC7B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;YACvD,MAAM,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAQ,CAAA;YAC7D,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAA;YAClB,KAAK,MAAM,MAAM,IAAI,IAAI,EAAE;gBACzB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,CAAA;aAChD;SACF;QAAC,OAAO,GAAG,EAAE;YACZ,gCAAgC;YAChC,IAAI,GAAG,YAAY,KAAK,IAAK,GAAW,CAAC,IAAI,KAAK,QAAQ,EAAE;gBAC1D,MAAM,GAAG,CAAA;aACV;SACF;gBAAS;YACR,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAA;SACxB;IACH,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,EAAkB,EAAE,IAAO;QAC7C,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE;YACrC,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,CAAA;QAC5C,CAAC,CAAC,CAAA;QACF,IAAI,CAAC,UAAU,GAAG,IAAI,CAAA;IACxB,CAAC;IAKD,YACmB,OAKhB;QALgB,YAAO,GAAP,OAAO,CAKvB;QAvFI,SAAI,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,IAAI,CAAC,CAAA;QACzE,eAAU,GAAG,KAAK,CAAA;QA2BjB,aAAQ,GAAG,IAAI,IAAI,EAAE,CAAA;QAkDtB,aAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAA;QAC5B,cAAS,GAAG,QAAQ,CAAC,SAAS,CAAA;QAUnC,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAA;QACpC,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAA;QAC1B,IAAI,CAAC,aAAa,GAAG,IAAI,aAAa,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAA;QAE1F,IAAI;YACF,IAAI,CAAC,UAAU,EAAE,CAAA;YACjB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,GAAG,EAAE;gBACvE,IAAI,CAAC,UAAU,EAAE,CAAA;YACnB,CAAC,CAAC,CAAA;SACH;QAAC,OAAO,KAAK,EAAE;YACd,+EAA+E;SAChF;IACH,CAAC;CACF"}

package/esm/index.d.ts

@@ -0,0 +1,3 @@
+export * from './filesystem-store.js';
+export * from './store-manager-helpers.js';
+//# sourceMappingURL=index.d.ts.map

package/esm/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAA;AACrC,cAAc,4BAA4B,CAAA"}

package/esm/index.js

@@ -0,0 +1,3 @@
+export * from './filesystem-store.js';
+export * from './store-manager-helpers.js';
+//# sourceMappingURL=index.js.map

package/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAA;AACrC,cAAc,4BAA4B,CAAA"}

package/esm/store-manager-helpers.js

@@ -0,0 +1,16 @@
+import { addStore } from '@furystack/core';
+import { FileSystemStore } from './filesystem-store.js';
+/**
+ *
+ * @param options The Options for store creation
+ * @param options.injector The injector to use for creating the store
+ * @param options.model The model to use for the store
+ * @param options.primaryKey The primary key of the model
+ * @param options.fileName The name of the file to use for the store
+ * @param options.tickMs The time in ms to wait between each save
+ */
+export const useFileSystemStore = (options) => {
+    const store = new FileSystemStore({ ...options });
+    addStore(options.injector, store);
+};
+//# sourceMappingURL=store-manager-helpers.js.map

package/esm/store-manager-helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"store-manager-helpers.js","sourceRoot":"","sources":["../src/store-manager-helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AAE1C,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AAEvD;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAI,OAMrC,EAAE,EAAE;IACH,MAAM,KAAK,GAAG,IAAI,eAAe,CAAC,EAAE,GAAG,OAAO,EAAE,CAAC,CAAA;IACjD,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAA;AACnC,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@furystack/filesystem-store",
-  "version": "4.0.0",
+  "version": "4.0.2",
   "description": "Simple File System store implementation for FuryStack",
   "type": "module",
   "scripts": {
@@ -8,20 +8,11 @@
   },
   "exports": {
     ".": {
-      "import": "./esm/index.js",
-      "types": "./types/index.d.ts"
-    },
-    "./package.json": "./package.json"
-  },
-  "typesVersions": {
-    "*": {
-      "*": [
-        "types/*"
-      ]
+      "import": "./esm/index.js"
     }
   },
   "files": [
-    "dist",
+    "esm",
     "types",
     "src"
   ],
@@ -46,13 +37,13 @@
   },
   "homepage": "https://github.com/furystack/furystack",
   "dependencies": {
-    "@furystack/core": "^12.0.0",
-    "@furystack/inject": "^8.0.0",
-    "@furystack/utils": "^4.0.0",
+    "@furystack/core": "^12.0.2",
+    "@furystack/inject": "^8.0.2",
+    "@furystack/utils": "^4.0.2",
     "semaphore-async-await": "^1.5.1"
   },
   "devDependencies": {
-    "@types/node": "^18.15.11",
+    "@types/node": "^18.16.2",
     "typescript": "^5.0.4",
     "vitest": "^0.30.1"
   },

package/src/index.ts

@@ -1,2 +1,2 @@
-export * from './filesystem-store'
-export * from './store-manager-helpers'
+export * from './filesystem-store.js'
+export * from './store-manager-helpers.js'

package/src/store-manager-helpers.ts

@@ -1,6 +1,6 @@
 import { addStore } from '@furystack/core'
 import type { Constructable, Injector } from '@furystack/inject'
-import { FileSystemStore } from './filesystem-store'
+import { FileSystemStore } from './filesystem-store.js'
 
 /**
  *

package/types/index.d.ts

@@ -1,3 +0,0 @@
-export * from './filesystem-store';
-export * from './store-manager-helpers';
-//# sourceMappingURL=index.d.ts.map

package/types/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAA;AAClC,cAAc,yBAAyB,CAAA"}