@ti-engine/web-framework 1.24.2 → 1.25.0

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 This document will contain the list of changes made to the framework. The format is based on the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
 
+## Version 1.25.0
+
+* feat(config-management): surface a `driftTracked` flag on the `getDrift` / `listDrift` payloads, defaulting to
+  `true` and set to `false` by a document registering `metadata.driftTracked: false`. Drift compares a stored value
+  against the file default shipped in the image, which is meaningful for vendor-shipped product content and
+  meaningless for a document holding customer data — that always differs, forever, and would drown a signal that
+  otherwise means "a release changed something this deployment is not serving". Consumers now filter on data rather
+  than on a hardcoded key list (CA-107)
+
 ## Version 1.24.2
 
 Dependency maintenance only — no framework code changed.

package/components/config-service.js

@@ -326,7 +326,7 @@ class ConfigService {
      *
      * @method
      * @param {string} configKey
-     * @returns {Promise<{configKey: string, status: string, counts: Object, entries: Array, storedVersion: number, editable: boolean, label: string}>}
+     * @returns {Promise<{configKey: string, status: string, counts: Object, entries: Array, storedVersion: number, editable: boolean, driftTracked: boolean, label: string}>}
      * @throws {TiException.E_WEB_INVALID_REQUEST_PARAMETERS} If the document is not registered.
      * @public
      */
@@ -344,6 +344,7 @@ class ConfigService {
                 entries: diff.entries,
                 storedVersion: current ? current.version : 0,
                 editable: metadata.editable !== false,
+                driftTracked: metadata.driftTracked !== false,
                 label: metadata.label || configKey
             };
         } );
@@ -367,6 +368,7 @@ class ConfigService {
                 counts: drift.counts,
                 storedVersion: drift.storedVersion,
                 editable: drift.editable,
+                driftTracked: drift.driftTracked,
                 label: drift.label
             } ) );
         } ) );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ti-engine/web-framework",
-  "version": "1.24.2",
+  "version": "1.25.0",
   "description": "A web-framework based on the ti-engine. It provides a customizable ready-to-use web-server microservice and a set of tools for creating web applications. NOTICE: This is still a work in progress and the full architecture, design, and functionality are not available!",
   "keywords": [
     "ti-engine",

package/types/components/config-service.d.ts

@@ -198,7 +198,7 @@ declare class ConfigService {
      *
      * @method
      * @param {string} configKey
-     * @returns {Promise<{configKey: string, status: string, counts: Object, entries: Array, storedVersion: number, editable: boolean, label: string}>}
+     * @returns {Promise<{configKey: string, status: string, counts: Object, entries: Array, storedVersion: number, editable: boolean, driftTracked: boolean, label: string}>}
      * @throws {TiException.E_WEB_INVALID_REQUEST_PARAMETERS} If the document is not registered.
      * @public
      */
@@ -209,6 +209,7 @@ declare class ConfigService {
         entries: any[];
         storedVersion: number;
         editable: boolean;
+        driftTracked: boolean;
         label: string;
     }>;
     /**