v0.7.2 — runtime support for deprecated: true itemDefs (Plan 50 Phase 3)

- HDSItemDef.isDeprecated getter
- HDSModel.itemsDefs.getAllActive() filter (getAll/forKey/forEvent unchanged so readers still resolve old events)
- 4 new tests in [MDPX] block

Author: perki

CHANGELOG.md

@@ -2,6 +2,17 @@
 
 ## [Unreleased]
 
+## [0.7.2] - 2026-04-28
+
+### Added — runtime support for `deprecated: true` itemDefs (Plan 50)
+- `HDSItemDef.isDeprecated` getter — `true` when the underlying itemDef has `deprecated: true` in pack.json (set in `data-model` ≥ 1.5.0).
+- `HDSModel.itemsDefs.getAllActive()` — returns every itemDef except deprecated ones. Use this for any UI that lets a user create new data points (form builder item browsers, item picker sheets, the data-model browser default listing).
+- `getAll()`, `forKey()`, `forEvent()` are unchanged: they still return deprecated items so existing events remain readable / renderable.
+
+Tests: `[MDPX]` block in `tests/hdsModel.test.js` — covers the getter on the three currently-flagged items (`body-vulva-mucus-stretch`, `body-vulva-wetness-feeling`, `fertility-cycles-charted-count`), the contrast with non-deprecated items, and the `getAllActive` vs `getAll` invariant.
+
+Contract documented in `data-model/AGENTS.md § "deprecated: true on items"`.
+
 ## [0.7.1] - 2026-04-28
 
 ### Changed — `package.json.exports.import` now points at TS source (Plan 49)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "hds-lib",
-  "version": "0.7.1",
+  "version": "0.7.2",
   "description": "Health Data Safe - Library",
   "type": "module",
   "engines": {

tests/hdsModel.test.js

@@ -37,6 +37,41 @@ describe('[MODX] Model', () => {
     }
   });
 
+  // ---------- deprecated --------- //
+  describe('[MDPX] deprecated items', function () {
+    it('[MDPA] isDeprecated getter returns true for items flagged in pack.json', () => {
+      // Three items were marked deprecated under plan 48 / formalised in plan 50.
+      const stretch = model.itemsDefs.forKey('body-vulva-mucus-stretch');
+      const wetness = model.itemsDefs.forKey('body-vulva-wetness-feeling');
+      const charted = model.itemsDefs.forKey('fertility-cycles-charted-count');
+      assert.equal(stretch.isDeprecated, true);
+      assert.equal(wetness.isDeprecated, true);
+      assert.equal(charted.isDeprecated, true);
+    });
+
+    it('[MDPB] isDeprecated getter returns false for non-deprecated items', () => {
+      assert.equal(model.itemsDefs.forKey('body-weight').isDeprecated, false);
+    });
+
+    it('[MDPC] forKey still resolves deprecated items (readers must see them)', () => {
+      const itemDef = model.itemsDefs.forKey('body-vulva-mucus-stretch');
+      assert.ok(itemDef);
+      assert.equal(itemDef.key, 'body-vulva-mucus-stretch');
+    });
+
+    it('[MDPD] getAllActive() excludes deprecated, getAll() includes them', () => {
+      const all = model.itemsDefs.getAll();
+      const active = model.itemsDefs.getAllActive();
+      assert.ok(all.length > active.length, 'active list must be smaller than full list');
+      const activeKeys = new Set(active.map((d) => d.key));
+      assert.equal(activeKeys.has('body-vulva-mucus-stretch'), false);
+      assert.equal(activeKeys.has('body-vulva-wetness-feeling'), false);
+      assert.equal(activeKeys.has('fertility-cycles-charted-count'), false);
+      // sanity — non-deprecated items still in
+      assert.equal(activeKeys.has('body-weight'), true);
+    });
+  });
+
   // ---------- itemDef ------------ //
   describe('[MDVX] itemDef methods', function () {
     it('[MDVA] eventTemplate() returns event template with streamId and type', async () => {

ts/HDSModel/HDSItemDef.ts

@@ -34,6 +34,16 @@ export class HDSItemDef {
     return this.#data.repeatable || 'unlimited';
   }
 
+  /**
+   * Whether this item is deprecated. Deprecated items remain readable
+   * (existing events keep validating + rendering) but should not be
+   * surfaced in UIs that let users create new events. See
+   * `data-model/AGENTS.md § "deprecated: true on items"`.
+   */
+  get isDeprecated (): boolean {
+    return this.#data.deprecated === true;
+  }
+
   get reminder (): ReminderConfig | null {
     return this.#data.reminder || null;
   }

ts/HDSModel/HDSModel-ItemsDefs.ts

@@ -29,7 +29,9 @@ export class HDSModelItemsDefs {
   }
 
   /**
-   * get all itemDefs
+   * get all itemDefs (includes deprecated). Use this when reading existing
+   * events: every event must still resolve to an itemDef even if the item
+   * was deprecated.
    */
   getAll (): HDSItemDef[] {
     const res: HDSItemDef[] = [];
@@ -39,6 +41,16 @@ export class HDSModelItemsDefs {
     return res;
   }
 
+  /**
+   * get all non-deprecated itemDefs. Use this for any UI that lets a user
+   * pick an item to create new data points (form builders, item picker
+   * sheets, data-model browser default listing). Deprecated items remain
+   * resolvable via `forKey` / `forEvent` so existing events still render.
+   */
+  getAllActive (): HDSItemDef[] {
+    return this.getAll().filter((itemDef) => !itemDef.isDeprecated);
+  }
+
   /**
    * get item for a key
    */