@acodeninja/persist 3.0.0-next.9 → 3.0.1-next.1

package/src/data/SearchIndex.js

@@ -0,0 +1,106 @@
+import lunr from 'lunr';
+
+/**
+ * Represents a single search result with the associated model instance and its relevance score.
+ *
+ * @class SearchResult
+ */
+export class SearchResult {
+    constructor(model, score) {
+        this.model = model;
+        this.score = score;
+    }
+}
+
+/**
+ * A full-text search index wrapper using Lunr.js for a given model.
+ * Supports indexing and querying model data.
+ *
+ * @class SearchIndex
+ */
+export default class SearchIndex {
+    #index;
+    #model;
+    #compiledIndex;
+
+    /**
+     * Initializes the search index for the provided model.
+     *
+     * @param {Model} model - The model definition to use for indexing.
+     * @param {Object.<string, Object>} index - A dictionary of model data, keyed by ID.
+     * @throws {NoIndexAvailableSearchIndexError} If the model has no searchable properties.
+     */
+    constructor(model, index) {
+        this.#index = index;
+        this.#model = model;
+        if (model.searchProperties().length === 0) {
+            throw new NoIndexAvailableSearchIndexError(this.#model);
+        }
+    }
+
+    /**
+     * Performs a search query on the compiled Lunr index.
+     *
+     * @param {string} query - The search string.
+     * @return {Array<SearchResult>} An array of search results with model instances and scores.
+     */
+    search(query) {
+        return this.searchIndex
+            .search(query)
+            .map(doc => new SearchResult(this.#model.fromData(this.#index[doc.ref]), doc.score));
+    }
+
+    /**
+     * Lazily compiles and returns the Lunr index instance.
+     *
+     * @return {lunr.Index} The compiled Lunr index.
+     */
+    get searchIndex() {
+        return this.#compiledIndex ?? this.#compileIndex();
+    }
+
+    /**
+     * Compiles the Lunr index using the model's search properties.
+     *
+     * @return {lunr.Index} 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);
+        });
+
+        return this.#compiledIndex;
+    }
+}
+
+/**
+ * Base error class for search index-related exceptions.
+ *
+ * @class SearchIndexError
+ * @extends {Error}
+ */
+export class SearchIndexError extends Error {
+}
+
+/**
+ * Thrown when a model does not have any properties defined for indexing.
+ *
+ * @class NoIndexAvailableSearchIndexError
+ * @extends {SearchIndexError}
+ */
+export class NoIndexAvailableSearchIndexError extends SearchIndexError {
+    constructor(model) {
+        super(`The model ${model.name} has no search properties`);
+    }
+}

package/src/{type/complex → data/properties}/ArrayType.js

@@ -1,4 +1,4 @@
-import Type from '../Type.js';
+import Type from './Type.js';
 
 /**
  * Represents an array type definition, allowing the specification of an array of a certain type.
@@ -51,12 +51,14 @@ class ArrayType {
              * const requiredArrayOfStrings = ArrayType.of(StringType).required;
              */
             static get required() {
+                const ThisType = this;
+
                 /**
                  * @class RequiredArrayOf
                  * @extends ArrayOf
                  * Represents a required array of a specific type.
                  */
-                class Required extends this {
+                class Required extends ThisType {
                     /** @type {boolean} Indicates that the array is required */
                     static _required = true;
 
@@ -70,7 +72,7 @@ class ArrayType {
                     }
                 }
 
-                Object.defineProperty(Required, 'name', {value: `Required${this.toString()}`});
+                Object.defineProperty(Required, 'name', {value: `Required${ThisType.name}`});
 
                 return Required;
             }

package/src/{type/simple → data/properties}/BooleanType.js

@@ -1,4 +1,4 @@
-import Type from '../Type.js';
+import Type from './Type.js';
 
 /**
  * Class representing a boolean type.
@@ -15,9 +15,9 @@ class BooleanType extends Type {
          * @static
          * @property {string} _type - The type identifier for BooleanType, set to `'boolean'`.
          */
-        this._type = 'boolean';
+        BooleanType._type = 'boolean';
 
-        Object.defineProperty(this, 'name', {value: 'Boolean'});
+        Object.defineProperty(BooleanType, 'name', {value: 'Boolean'});
     }
 }
 

package/src/{type/complex → data/properties}/CustomType.js

@@ -1,4 +1,4 @@
-import Type from '../Type.js';
+import Type from './Type.js';
 import ajv from 'ajv';
 
 /**
@@ -37,12 +37,12 @@ class CustomType {
         class Custom extends Type {
             static {
                 /** @type {string} The data type, which is 'object' */
-                this._type = 'object';
+                Custom._type = 'object';
 
                 /** @type {Object} The JSON schema that defines the structure and validation rules */
-                this._schema = schema;
+                Custom._schema = schema;
 
-                Object.defineProperty(this, 'name', {value: 'Custom'});
+                Object.defineProperty(Custom, 'name', {value: 'Custom'});
             }
         }
 
@@ -50,7 +50,7 @@ class CustomType {
     }
 
     static {
-        Object.defineProperty(this, 'name', {value: 'Custom'});
+        Object.defineProperty(CustomType, 'name', {value: 'Custom'});
     }
 }
 

package/src/{type/simple → data/properties}/DateType.js

@@ -1,4 +1,4 @@
-import Type from '../Type.js';
+import Type from './Type.js';
 
 /**
  * Class representing a date type with ISO date-time format.
@@ -15,15 +15,15 @@ class DateType extends Type {
          * @static
          * @property {string} _type - The type identifier for DateType, set to `'string'`.
          */
-        this._type = 'string';
+        DateType._type = 'string';
 
         /**
          * @static
          * @property {string} _format - The format for DateType, set to `'iso-date-time'`.
          */
-        this._format = 'iso-date-time';
+        DateType._format = 'iso-date-time';
 
-        Object.defineProperty(this, 'name', {value: 'Date'});
+        Object.defineProperty(DateType, 'name', {value: 'Date'});
     }
 
     /**

package/src/{type/simple → data/properties}/NumberType.js

@@ -1,4 +1,4 @@
-import Type from '../Type.js';
+import Type from './Type.js';
 
 /**
  * Class representing a number type.
@@ -15,9 +15,9 @@ class NumberType extends Type {
          * @static
          * @property {string} _type - The type identifier for NumberType, set to `'number'`.
          */
-        this._type = 'number';
+        NumberType._type = 'number';
 
-        Object.defineProperty(this, 'name', {value: 'Number'});
+        Object.defineProperty(NumberType, 'name', {value: 'Number'});
     }
 }
 

package/src/{type/resolved → data/properties}/ResolvedType.js

@@ -1,4 +1,4 @@
-import Type from '../Type.js';
+import Type from './Type.js';
 
 /**
  * Class representing a resolved type.
@@ -39,6 +39,7 @@ class ResolvedType extends Type {
      * @returns {ResolvedType} A subclass of `ResolvedType` customized for the provided property.
      */
     static of(property) {
+        const that = this;
         class ResolvedTypeOf extends ResolvedType {
             /**
              * Converts the resolved type to a string, displaying the resolved property.
@@ -46,7 +47,7 @@ class ResolvedType extends Type {
              * @returns {string} A string representing the resolved type, including the property.
              */
             static toString() {
-                return `ResolvedTypeOf(${property})`;
+                return `${that.toString()}Of(${property})`;
             }
         }
 

package/src/{type/resolved → data/properties}/SlugType.js

@@ -65,7 +65,7 @@ class SlugType extends ResolvedType {
     }
 
     static {
-        Object.defineProperty(this, 'name', {value: 'Slug'});
+        Object.defineProperty(SlugType, 'name', {value: 'Slug'});
     }
 }
 

package/src/{type/simple → data/properties}/StringType.js

@@ -1,4 +1,4 @@
-import Type from '../Type.js';
+import Type from './Type.js';
 
 /**
  * Class representing a string type.
@@ -15,9 +15,9 @@ class StringType extends Type {
          * @static
          * @property {string} _type - The type identifier for the string type.
          */
-        this._type = 'string';
+        StringType._type = 'string';
 
-        Object.defineProperty(this, 'name', {value: 'String'});
+        Object.defineProperty(StringType, 'name', {value: 'String'});
     }
 }
 

package/src/{type → data/properties}/Type.js

@@ -53,18 +53,28 @@ class Type {
      * @returns {Type} A subclass of the current type with `_required` set to `true`.
      */
     static get required() {
-        class Required extends this {
+        const ThisType = this;
+
+        /**
+         * A subclass of the current type with the `_required` flag set to `true`.
+         * Used to indicate that the property is required during validation or schema generation.
+         *
+         * @class
+         * @extends {Type}
+         * @private
+         */
+        class Required extends ThisType {
             static _required = true;
         }
 
         // Define the class name as "Required<OriginalTypeName>"
-        Object.defineProperty(Required, 'name', {value: `Required${this.toString()}`});
+        Object.defineProperty(Required, 'name', {value: `Required${ThisType.name}`});
 
         return Required;
     }
 
     static {
-        Object.defineProperty(this, 'name', {value: 'Type'});
+        Object.defineProperty(Type, 'name', {value: 'Type'});
     }
 }