@acodeninja/persist 3.0.1 → 3.1.0-next.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@acodeninja/persist",
-  "version": "3.0.1",
+  "version": "3.1.0-next.2",
   "description": "A JSON based data modelling and persistence module with alternate storage mechanisms.",
   "type": "module",
   "scripts": {
@@ -25,8 +25,8 @@
     "ajv": "^8.17.1",
     "ajv-errors": "^3.0.0",
     "ajv-formats": "^3.0.1",
+    "fuse.js": "^7.1.0",
     "lodash": "^4.17.21",
-    "lunr": "^2.3.9",
     "slugify": "^1.6.6",
     "ulid": "^2.3.0"
   },

package/src/Connection.js

@@ -468,24 +468,28 @@ export default class Connection {
 
     /**
      * Search the given model's search properties for matching results.
-     *   Wildcards: character '*' can be placed at any location in a query
-     *   Fields: search for a specific field's value with 'field:value'
-     *   Boosting: if foo is important try 'foo^10 bar'
-     *   Fuzzy: 'foo~1' will match 'boo' but not 'bao', 'foo~2' would match 'bao'
-     *   Must include: '+foo bar' must include 'foo' and may include 'bar'
-     *   Must not include: '-foo bar' must not include 'foo' and may include 'bar'
-     *   Mixed include: '+foo -bar' must include 'foo' must not include 'bar'
+     *
      * @param {Model.constructor} modelConstructor
      * @param {string} query
      * @return {Promise<Array<SearchResult>>}
      */
     async search(modelConstructor, query) {
-        const searchIndex = await this.#storage.getSearchIndex(modelConstructor)
-            .then(index => new SearchIndex(modelConstructor, index));
+        const searchIndex = await this.getSearchIndex(modelConstructor);
 
         return searchIndex.search(query);
     }
 
+    /**
+     * Retrieve a search index to query at your leisure.
+     *
+     * @param {Model.constructor} modelConstructor
+     * @return {SearchIndex}
+     */
+    async getSearchIndex(modelConstructor) {
+        return await this.#storage.getSearchIndex(modelConstructor)
+            .then(index => new SearchIndex(modelConstructor, index));
+    }
+
     /**
      * Find using a structured query and indexed fields.
      *
@@ -494,12 +498,22 @@ export default class Connection {
      * @return {Promise<Array<SearchResult>>}
      */
     async find(modelConstructor, query) {
-        const findIndex = await this.#storage.getIndex(modelConstructor)
-            .then(index => new FindIndex(modelConstructor, index));
+        const findIndex = await this.getIndex(modelConstructor);
 
         return findIndex.query(query);
     }
 
+    /**
+     * Retrieve a index to query at your leisure.
+     *
+     * @param {Model.constructor} modelConstructor
+     * @return {FindIndex}
+     */
+    async getIndex(modelConstructor) {
+        return await this.#storage.getIndex(modelConstructor)
+            .then(index => new FindIndex(modelConstructor, index));
+    }
+
     /**
      * Start a transaction, allowing multiple queries to be queued up and committed in one go.
      * Should an error occur, any committed operations will be reverted.

package/src/data/SearchIndex.js

@@ -1,4 +1,4 @@
-import lunr from 'lunr';
+import Fuse from 'fuse.js';
 
 /**
  * Represents a single search result with the associated model instance and its relevance score.
@@ -47,13 +47,13 @@ export default class SearchIndex {
     search(query) {
         return this.searchIndex
             .search(query)
-            .map(doc => new SearchResult(this.#model.fromData(this.#index[doc.ref]), doc.score));
+            .map(doc => new SearchResult(this.#model.fromData(this.#index[doc.item.id]), doc.score));
     }
 
     /**
      * Lazily compiles and returns the Lunr index instance.
      *
-     * @return {lunr.Index} The compiled Lunr index.
+     * @return {Fuse} The compiled Lunr index.
      */
     get searchIndex() {
         return this.#compiledIndex ?? this.#compileIndex();
@@ -62,22 +62,15 @@ export default class SearchIndex {
     /**
      * Compiles the Lunr index using the model's search properties.
      *
-     * @return {lunr.Index} The compiled Lunr index.
+     * @return {Fuse} The compiled Lunr index.
      * @private
      */
     #compileIndex() {
-        const model = this.#model;
         const index = this.#index;
-        this.#compiledIndex = lunr(function () {
-            this.ref('id');
-
-            for (const field of model.searchProperties()) {
-                this.field(field);
-            }
-
-            Object.values(index).forEach(function (doc) {
-                this.add(doc);
-            }, this);
+        this.#compiledIndex = new Fuse(Object.values(index), {
+            includeScore: true,
+            ignoreDiacritics: true,
+            keys: this.#model.searchProperties().map(p => p.replace(/\[\*]\./g, '')),
         });
 
         return this.#compiledIndex;

package/src/engine/storage/HTTPStorageEngine.js

@@ -81,8 +81,12 @@ export default class HTTPStorageEngine extends StorageEngine {
         return this.#processFetch(
             this.#generateURL([modelConstructor.name]),
             this.#getReadOptions(),
-            {},
-        );
+        ).catch(error => {
+            if (error?.response?.status === 404) {
+                return {};
+            }
+            throw error;
+        });
     }
 
     /**
@@ -109,8 +113,12 @@ export default class HTTPStorageEngine extends StorageEngine {
         return this.#processFetch(
             this.#generateURL([modelConstructor.name, 'search']),
             this.#getReadOptions(),
-            {},
-        );
+        ).catch(error => {
+            if (error?.response?.status === 404) {
+                return {};
+            }
+            throw error;
+        });
     }
 
     /**
@@ -158,18 +166,13 @@ export default class HTTPStorageEngine extends StorageEngine {
      *
      * @param {string|URL} url - The URL to fetch.
      * @param {Object} options - The fetch options.
-     * @param {*} [defaultValue] - A default value to return if the fetch fails.
      * @returns {Promise<Object>} The parsed JSON response.
      * @throws {HTTPRequestFailedError} Thrown if the fetch request fails.
      */
-    #processFetch(url, options, defaultValue = undefined) {
+    #processFetch(url, options) {
         return this.configuration.fetch(url, options)
             .then(response => {
                 if (!response.ok) {
-                    if (defaultValue !== undefined) {
-                        return {json: () => Promise.resolve(defaultValue)};
-                    }
-
                     throw new HTTPRequestFailedError(url, options, response);
                 }
 

package/src/engine/storage/S3StorageEngine.js

@@ -98,8 +98,11 @@ class S3StorageEngine extends StorageEngine {
             }));
 
             return JSON.parse(await data.Body.transformToString());
-        } catch (_error) {
-            return {};
+        } catch (error) {
+            if (error instanceof NoSuchKey) {
+                return {};
+            }
+            throw error;
         }
     }
 
@@ -135,8 +138,11 @@ class S3StorageEngine extends StorageEngine {
             }));
 
             return JSON.parse(await data.Body.transformToString());
-        } catch (_error) {
-            return {};
+        } catch (error) {
+            if (error instanceof NoSuchKey) {
+                return {};
+            }
+            throw error;
         }
     }