miolo-model 3.0.0-beta.224 → 3.0.0-beta.226

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "miolo-model",
-  "version": "3.0.0-beta.224",
+  "version": "3.0.0-beta.226",
   "description": "Data models for miolo world",
   "author": "Donato Lorenzo <donato@afialapis.com>",
   "contributors": [
@@ -27,6 +27,7 @@
     "reset": "rm -fr package-lock.json npm-lock.yaml node_modules && npm i",
     "lint": "biome check ./src --reporter=github",
     "lint:fix": "biome check --write ./src --reporter=github",
+    "lint:types": "tsc -p jsconfig.json --noEmit",
     "test": "node --test ./test/index.mjs",
     "prepublishOnly": "npm run lint && npm run test"
   },

package/src/MioloArray.mjs

@@ -1,28 +1,38 @@
-import CacheMixin from "./CacheMixin.mjs"
+/**
+ * @typedef {import("./MioloModel.mjs").default} MioloModel
+ */
 
-export default class MioloArray extends CacheMixin(Array) {
+/**
+ * Represents an array of MioloModel instances.
+ * Inherits all native JS Array methods.
+ *
+ * @template {MioloModel} T
+ * @extends {Array<T>}
+ */
+export default class MioloArray extends Array {
   /**
    * Create a new MioloArray.
-   * @param {Function} itemClass - The class of the items in the array.
-   * @param {Array<MioloModel> | Array<Object>} items - The items to initialize the array with.
+   * @param {new (...args: any[]) => T} itemClass - The class of the items in the array.
+   * @param {Array<T> | Array<Object>} items - The items to initialize the array with.
    * @param {...any} extra - Extra parameters to pass to the item class constructor.
    */
   constructor(itemClass, items = [], ...extra) {
-    // Arrays can be inited with a number
+    // Arrays can be inited with a number of elements or an array of items.
+    // TypeScript requires a single top-level super() call when the class has class fields.
+    super(typeof items === "number" ? items : 0)
+
+    this.reset_cache()
+
     if (typeof items === "number") {
-      super(items)
-      this.reset_cache()
       return
     }
-    //
-    super()
-    this.reset_cache()
 
     // Check properties
     if (!itemClass) {
       console.error(`[${this.constructor.name}] MioloArray received no itemClass`)
       return
     }
+    /** @type {new (...args: any[]) => T} */
     this.itemClass = itemClass
 
     items.forEach((r, index) => {
@@ -31,9 +41,110 @@ export default class MioloArray extends CacheMixin(Array) {
     })
   }
 
+  /**
+   * Reset the model's cache.
+   * @public
+   */
+  reset_cache() {
+    this.__cache__ = {}
+  }
+
+  /**
+   * Reset the model's cache.
+   * @public
+   */
+  resetCache = this.reset_cache
+
+  /**
+   * Get a value from the model's cache.
+   * @param {string} key - The key to get the value from.
+   * @returns {any} The value from the cache.
+   * @public
+   */
+  get_from_cache(key) {
+    if (this.__cache__ === undefined) {
+      return undefined
+    }
+    return this.__cache__[key]
+  }
+
+  /**
+   * Get a value from the model's cache.
+   * @param {string} key - The key to get the value from.
+   * @returns {any} The value from the cache.
+   * @public
+   */
+  getFromCache = this.get_from_cache
+
+  /**
+   * Set a value in the model's cache.
+   * @param {string} key - The key to set the value to.
+   * @param {any} value - The value to set.
+   * @public
+   */
+  set_to_cache(key, value) {
+    if (this.__cache__ === undefined) {
+      this.__cache__ = {}
+    }
+    this.__cache__[key] = value
+  }
+
+  /**
+   * Set a value in the model's cache.
+   * @param {string} key - The key to set the value to.
+   * @param {any} value - The value to set.
+   * @public
+   */
+  setToCache = this.set_to_cache
+
+  /**
+   * Get a value from the model's cache or make it if it doesn't exist.
+   * @param {string} cache_key - The key to get the value from.
+   * @param {Function} make_callback - The function to make the value if it doesn't exist.
+   * @returns {any} The value from the cache.
+   * @public
+   */
+  get_from_cache_or_make(cache_key, make_callback) {
+    if (this.__cache__ === undefined) {
+      this.__cache__ = {}
+    }
+    if (this.__cache__[cache_key] === undefined) {
+      const bound_callback = make_callback.bind(this)
+      this.__cache__[cache_key] = bound_callback()
+    }
+    return this.__cache__[cache_key]
+  }
+
+  /**
+   * Get a value from the model's cache or make it if it doesn't exist.
+   * @param {string} cache_key - The key to get the value from.
+   * @param {Function} make_callback - The function to make the value if it doesn't exist.
+   * @returns {any} The value from the cache.
+   * @public
+   */
+  getFromCacheOrMake = this.get_from_cache_or_make
+
+  /**
+   * Invalidate a value in the model's cache.
+   * @param {string} cache_key - The key to invalidate.
+   * @public
+   */
+  invalidate_cache(cache_key) {
+    if (this.__cache__ !== undefined) {
+      delete this.__cache__[cache_key]
+    }
+  }
+
+  /**
+   * Invalidate a value in the model's cache.
+   * @param {string} cache_key - The key to invalidate.
+   * @public
+   */
+  invalidateCache = this.invalidate_cache
+
   /**
    * Returns the last item in the array.
-   * @returns {MioloModel} The last item in the array.
+   * @returns {T} The last item in the array.
    * @public
    */
   last() {
@@ -67,14 +178,14 @@ export default class MioloArray extends CacheMixin(Array) {
   /**
    * Find the index of the first item in the array that has the given field and value.
    * @param {string} field - The field to search for.
-   * @param {any} value - The value to search for.
+   * @param {MioloModel} value - The value to search for.
    * @returns {number} The index of the first item that has the given field and value, or -1 if not found.
    * @public
    */
   find_index_by_field(field, value) {
     if (this.length >= 0) {
       const fidx = this.findIndex((elem) => {
-        const val = typeof elem._get === "function" ? elem._get(field) : elem[field]
+        const val = typeof elem.get_value === "function" ? elem.get_value(field) : elem[field]
         return val === value
       })
       if (fidx >= 0) {
@@ -99,13 +210,13 @@ export default class MioloArray extends CacheMixin(Array) {
    * Find the first item in the array that has the given field and value.
    * @param {string} field - The field to search for.
    * @param {any} value - The value to search for.
-   * @returns {MioloModel} The first item in the array that has the given field and value, or undefined if not found.
+   * @returns {T | undefined} The first item in the array that has the given field and value, or undefined if not found.
    * @public
    */
   find_by_field(field, value) {
     if (this.length >= 0) {
       const filt = this.filter((elem) => {
-        const val = typeof elem._get === "function" ? elem._get(field) : elem[field]
+        const val = typeof elem.get_value === "function" ? elem.get_value(field) : elem[field]
         return val === value
       })
       if (filt.length > 0) {
@@ -119,7 +230,7 @@ export default class MioloArray extends CacheMixin(Array) {
    * Find the first item in the array that has the given field and value.
    * @param {string} field - The field to search for.
    * @param {any} value - The value to search for.
-   * @returns {MioloModel} The first item in the array that has the given field and value, or undefined if not found.
+   * @returns {T | undefined} The first item in the array that has the given field and value, or undefined if not found.
    * @public
    */
   findByField(field, value) {
@@ -129,7 +240,7 @@ export default class MioloArray extends CacheMixin(Array) {
   /**
    * Find the first item in the array that has the given id.
    * @param {string} id - The id to search for.
-   * @returns {MioloModel} The first item in the array that has the given id, or undefined if not found.
+   * @returns {T | undefined} The first item in the array that has the given id, or undefined if not found.
    * @public
    */
   find_by_id(id) {
@@ -139,7 +250,7 @@ export default class MioloArray extends CacheMixin(Array) {
   /**
    * Find the first item in the array that has the given id.
    * @param {string} id - The id to search for.
-   * @returns {MioloModel} The first item in the array that has the given id, or undefined if not found.
+   * @returns {T | undefined} The first item in the array that has the given id, or undefined if not found.
    * @public
    */
   findById(id) {
@@ -171,10 +282,12 @@ export default class MioloArray extends CacheMixin(Array) {
 
   /**
    * Push a new item to the end of the array.
-   * @param {Object} data - The data to push to the array.
-   * @returns {MioloModel | Object} The new item.
+   * @param {T} data - The data to push to the array.
+   * @returns {T} The new item.
    * @public
    */
+  // biome-ignore lint/suspicious/noTsIgnore: ignore ts ignore
+  // @ts-ignore - Override Array.push to return the item instead of the new length
   push(data) {
     const item =
       data !== undefined && data instanceof this.itemClass ? data : new this.itemClass(data)
@@ -190,7 +303,11 @@ export default class MioloArray extends CacheMixin(Array) {
   clone() {
     const currentData = this.getData()
     const clonedData = JSON.parse(JSON.stringify(currentData))
-    const clone = new this.constructor(clonedData)
+
+    /** @type {new (data?: any) => any} */
+    const Ctor = /** @type {any} */ (this.constructor)
+
+    const clone = new Ctor(clonedData)
     // Object.assign(clone, this)
     return clone
   }

package/src/MioloModel.mjs

@@ -1,7 +1,6 @@
-import CacheMixin from "./CacheMixin.mjs"
 import MioloArray from "./MioloArray.mjs"
 
-export default class MioloModel extends CacheMixin() {
+export default class MioloModel extends class {} {
   /**
    * Initialize a new MioloModel.
    * Notice the attributes you set to your instance may be handled by MioloModel:
@@ -15,6 +14,107 @@ export default class MioloModel extends CacheMixin() {
     this.reset_cache()
   }
 
+  /**
+   * Reset the model's cache.
+   * @public
+   */
+  reset_cache() {
+    this.__cache__ = {}
+  }
+
+  /**
+   * Reset the model's cache.
+   * @public
+   */
+  resetCache = this.reset_cache
+
+  /**
+   * Get a value from the model's cache.
+   * @param {string} key - The key to get the value from.
+   * @returns {any} The value from the cache.
+   * @public
+   */
+  get_from_cache(key) {
+    if (this.__cache__ === undefined) {
+      return undefined
+    }
+    return this.__cache__[key]
+  }
+
+  /**
+   * Get a value from the model's cache.
+   * @param {string} key - The key to get the value from.
+   * @returns {any} The value from the cache.
+   * @public
+   */
+  getFromCache = this.get_from_cache
+
+  /**
+   * Set a value in the model's cache.
+   * @param {string} key - The key to set the value to.
+   * @param {any} value - The value to set.
+   * @public
+   */
+  set_to_cache(key, value) {
+    if (this.__cache__ === undefined) {
+      this.__cache__ = {}
+    }
+    this.__cache__[key] = value
+  }
+
+  /**
+   * Set a value in the model's cache.
+   * @param {string} key - The key to set the value to.
+   * @param {any} value - The value to set.
+   * @public
+   */
+  setToCache = this.set_to_cache
+
+  /**
+   * Get a value from the model's cache or make it if it doesn't exist.
+   * @param {string} cache_key - The key to get the value from.
+   * @param {Function} make_callback - The function to make the value if it doesn't exist.
+   * @returns {any} The value from the cache.
+   * @public
+   */
+  get_from_cache_or_make(cache_key, make_callback) {
+    if (this.__cache__ === undefined) {
+      this.__cache__ = {}
+    }
+    if (this.__cache__[cache_key] === undefined) {
+      const bound_callback = make_callback.bind(this)
+      this.__cache__[cache_key] = bound_callback()
+    }
+    return this.__cache__[cache_key]
+  }
+
+  /**
+   * Get a value from the model's cache or make it if it doesn't exist.
+   * @param {string} cache_key - The key to get the value from.
+   * @param {Function} make_callback - The function to make the value if it doesn't exist.
+   * @returns {any} The value from the cache.
+   * @public
+   */
+  getFromCacheOrMake = this.get_from_cache_or_make
+
+  /**
+   * Invalidate a value in the model's cache.
+   * @param {string} cache_key - The key to invalidate.
+   * @public
+   */
+  invalidate_cache(cache_key) {
+    if (this.__cache__ !== undefined) {
+      delete this.__cache__[cache_key]
+    }
+  }
+
+  /**
+   * Invalidate a value in the model's cache.
+   * @param {string} cache_key - The key to invalidate.
+   * @public
+   */
+  invalidateCache = this.invalidate_cache
+
   /**
    * Get a value from the model's data.
    * @param {string} field - The field to get the value from.
@@ -203,7 +303,9 @@ export default class MioloModel extends CacheMixin() {
     const currentData = this.getData()
     const clonedData = JSON.parse(JSON.stringify(currentData))
 
-    const clone = new this.constructor(clonedData)
+    /** @type {new (data?: any) => any} */
+    const Ctor = /** @type {any} */ (this.constructor)
+    const clone = new Ctor(clonedData)
 
     //Object.assign(clone, this)