Adding getAll itemDefs

Author: perki

docs/hds-lib.js

@@ -20567,10 +20567,23 @@ class HDSModelItemsDefs {
     loadModelDataByStreamIdEventTypes(this.#model.modelData.items, this.#modelDataByStreamIdEventTypes);
   }
 
+  /**
+   * get all itemDefs
+   * @returns {Array<HDSItemDef>}
+   */
+  getAll () {
+    const res = [];
+    for (const key of Object.keys(this.#model.modelData.items)) {
+      res.push(this.forKey(key));
+    }
+    return res;
+  }
+
   /**
    * get item for a key
    * @param {string} key
    * @param {boolean} [throwErrorIfNotFound] default `true`
+   * @return {HDSItemDef | null}
    */
   forKey (key, throwErrorIfNotFound = true) {
     if (this.#itemsDefs[key]) return this.#itemsDefs[key];
@@ -23959,6 +23972,16 @@ describe('[MODX] Model', () => {
     assert.deepEqual(itemDef.eventTypes, ['ratio/generic']);
   });
 
+  it('[MODN] get All itemsDef', async () => {
+    const modelLoad = new HDSModel(modelURL);
+    await modelLoad.load();
+    const itemDefs = modelLoad.itemsDefs.getAll();
+    assert.ok(itemDefs.length > 0);
+    for (const itemDef of itemDefs) {
+      assert.ok(itemDef.key);
+    }
+  });
+
   // ---------- items ------------ //
   describe('[MOLX] items localization', function () {
     afterEach(() => {

docs/hds-lib.js.map

@@ -27,10 +27,23 @@ class HDSModelItemsDefs {
     loadModelDataByStreamIdEventTypes(this.#model.modelData.items, this.#modelDataByStreamIdEventTypes);
   }
 
+  /**
+   * get all itemDefs
+   * @returns {Array<HDSItemDef>}
+   */
+  getAll () {
+    const res = [];
+    for (const key of Object.keys(this.#model.modelData.items)) {
+      res.push(this.forKey(key));
+    }
+    return res;
+  }
+
   /**
    * get item for a key
    * @param {string} key
    * @param {boolean} [throwErrorIfNotFound] default `true`
+   * @return {HDSItemDef | null}
    */
   forKey (key, throwErrorIfNotFound = true) {
     if (this.#itemsDefs[key]) return this.#itemsDefs[key];

docs/tests-browser.js

@@ -29,6 +29,16 @@ describe('[MODX] Model', () => {
     assert.deepEqual(itemDef.eventTypes, ['ratio/generic']);
   });
 
+  it('[MODN] get All itemsDef', async () => {
+    const modelLoad = new HDSModel(modelURL);
+    await modelLoad.load();
+    const itemDefs = modelLoad.itemsDefs.getAll();
+    assert.ok(itemDefs.length > 0);
+    for (const itemDef of itemDefs) {
+      assert.ok(itemDef.key);
+    }
+  });
+
   // ---------- items ------------ //
   describe('[MOLX] items localization', function () {
     afterEach(() => {

docs/tests-browser.js.map

@@ -7,17 +7,24 @@ export = HDSModelItemsDefs;
  */
 declare class HDSModelItemsDefs {
   constructor(model: HDSModel);
+  /**
+   * get all itemDefs
+   * @returns {Array<HDSItemDef>}
+   */
+  getAll(): HDSItemDef[];
+
   /**
      * get item for a key
      * @param {string} key
      * @param {boolean} [throwErrorIfNotFound] default `true`
      */
-  forKey(key: string, throwErrorIfNotFound?: boolean): HDSItemDef;
+  forKey(key: string, throwErrorIfNotFound?: boolean): HDSItemDef | null;
+
   /**
      * get a definition for an event
      * @param {Event} event
      * @param {boolean} [throwErrorIfNotFound] default `true`
      */
-  forEvent(event: pryv.Event, throwErrorIfNotFound?: boolean): HDSItemDef;
+  forEvent(event: pryv.Event, throwErrorIfNotFound?: boolean): HDSItemDef | null;
   #private;
 }