@truedat/qx 8.0.0 → 8.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@truedat/qx",
-  "version": "8.0.0",
+  "version": "8.0.1",
   "description": "Truedat Web Quality Experience package",
   "sideEffects": false,
   "module": "src/index.js",
@@ -53,7 +53,7 @@
     "@testing-library/jest-dom": "^6.6.3",
     "@testing-library/react": "^16.3.0",
     "@testing-library/user-event": "^14.6.1",
-    "@truedat/test": "8.0.0",
+    "@truedat/test": "8.0.1",
     "identity-obj-proxy": "^3.0.0",
     "jest": "^29.7.0",
     "redux-saga-test-plan": "^4.0.6"
@@ -86,5 +86,5 @@
     "semantic-ui-react": "^3.0.0-beta.2",
     "swr": "^2.3.3"
   },
-  "gitHead": "5a3af0f7a7833b2e02a876a08e228a5d678927ea"
+  "gitHead": "1d2fb016733a74a116362b4906f7141ca7b20ff0"
 }

package/src/components/qualityControls/QualityControlEvents.js

@@ -1,3 +1,4 @@
+import _ from "lodash/fp";
 import { Segment, Feed } from "semantic-ui-react";
 import { useEvents } from "@truedat/audit/hooks/useEvents";
 import PropTypes from "prop-types";
@@ -10,20 +11,48 @@ import Moment from "react-moment";
 const MESSAGE_ID = 0;
 const MESSAGE_PARAMS = 1;
 
-const EventRow = ({ user, ts, payload }) => {
+const EventRow = ({ user, ts, header, payload }) => {
   const { formatMessage, locale } = useIntl();
   const translateParams = (params) => {
-    if (!params || typeof params !== "object") return params;
-    if (params.value && typeof params.value === "object" && params.value.id) {
-      return { ...params, value: formatMessage(params.value) };
+    if (!_.isObject(params)) return params;
+
+    if (_.has("value.id")(params)) {
+      const transformValue = params.lowercase
+        ? _.flow(formatMessage, _.toLower)
+        : formatMessage;
+      return {
+        ...params,
+        value: transformValue(params.value),
+      };
+    }
+
+    if (_.has("type.id")(params)) {
+      const formatParam = ([label, value]) =>
+        _.has("id")(label) && _.isString(label.id)
+          ? `${formatMessage(label)}: ${value}`
+          : `${label}: ${value}`;
+
+      return {
+        ...params,
+        type: formatMessage(params.type),
+        params: _.isArray(params.params)
+          ? _.flow(_.map(formatParam), _.join(", "))(params.params)
+          : params.params,
+      };
     }
+
     return params;
   };
+
   return (
     <Feed.Event>
       <Feed.Content>
         <Feed.Summary>
           <Feed.User>{user?.user_name}</Feed.User>{" "}
+          {formatMessage(
+            header[MESSAGE_ID],
+            translateParams(header[MESSAGE_PARAMS])
+          )}{" "}
           <Feed.Date>
             <Moment locale={locale} date={ts} format="YYYY-MM-DD HH:mm" />
           </Feed.Date>
@@ -57,7 +86,6 @@ export default function QualityControlEvents() {
   );
   const events = data?.data || [];
   const parsedEvents = useMemo(() => getParsedEvents(events), [events]);
-
   return (
     <Segment
       attached="bottom"

package/src/components/qualityControls/__tests__/QualityControlEvents.spec.js

@@ -13,7 +13,8 @@ const messages = {
   ...baseMessages,
   en: {
     ...baseMessages.en,
-    "quality_controls.events.action_created": "<b>{field}</b> created",
+    "quality_controls.events.action_created":
+      "Name: <b>{name}</b>, Version: <b>{field}</b>",
     "quality_controls.events.action_field_changed":
       "<b>{field}</b> changed to {value}",
     "quality_controls.events.action_dynamic_field_changed":
@@ -22,6 +23,8 @@ const messages = {
     "quality_controls.events.action_disabled": "Quality control disabled",
     "quality_controls.events.action_draft_version_created":
       "Draft version <b>{value}</b> created",
+    "quality_controls.events.quality_control_created":
+      "created a new draft quality control",
   },
 };
 
@@ -38,7 +41,7 @@ describe("<QualityControlEvents />", () => {
         data: [
           {
             event: "quality_control_created",
-            payload: { name: "Sample control" },
+            payload: { name: "Sample control", version: "1.0" },
             ts: "2024-01-01T00:00:00Z",
             user: { user_name: "Jane Doe" },
           },

package/src/components/qualityControls/__tests__/__snapshots__/QualityControlEvents.spec.js.snap

@@ -23,6 +23,8 @@ exports[`<QualityControlEvents /> renders parsed events with highlighted fields
               Jane Doe
             </a>
              
+            created a new draft quality control
+             
             <div
               class="date"
             >
@@ -36,10 +38,14 @@ exports[`<QualityControlEvents /> renders parsed events with highlighted fields
           <div
             class="text extra"
           >
+            Name: 
             <b>
               Sample control
             </b>
-             created
+            , Version: 
+            <b>
+              1.0
+            </b>
           </div>
         </div>
       </div>

package/src/components/qualityControls/events/__tests__/getParsedEvents.spec.js

@@ -17,10 +17,11 @@ describe("getParsedEvents", () => {
       {
         ts: timestamp,
         user,
+        header: [{ id: "quality_controls.events.quality_control_created" }, {}],
         payload: [
           [
             { id: "quality_controls.events.action_created" },
-            { field: "Control A", b: bold },
+            { name: "Control A", field: undefined, b: bold },
           ],
         ],
       },
@@ -48,16 +49,21 @@ describe("getParsedEvents", () => {
       {
         ts: timestamp,
         user,
+        header: [
+          { id: "quality_controls.events.action_disabled" },
+          { b: bold },
+          { id: "quality_controls.events.quality_control_updated" },
+          {},
+        ],
         payload: [
-          [{ id: "quality_controls.events.action_disabled" }, { b: bold }],
-          [
-            { id: "quality_controls.events.action_field_changed" },
-            { field: "name", value: "New name", b: bold },
-          ],
           [
             { id: "quality_controls.events.action_dynamic_field_changed" },
             { field: "threshold", value: 10, b: bold },
           ],
+          [
+            { id: "quality_controls.events.action_field_changed" },
+            { field: "name", value: "New name", b: bold },
+          ],
         ],
       },
     ]);
@@ -77,14 +83,100 @@ describe("getParsedEvents", () => {
       {
         ts: timestamp,
         user,
+        header: [
+          { id: "quality_controls.events.action_approved" },
+          {
+            field: "v2",
+            lowercase: true,
+            value: { id: "quality_control.status.published" },
+            b: bold,
+          },
+        ],
+        payload: [],
+      },
+    ]);
+  });
+
+  it("returns payload for quality_control_updated with empty changes", () => {
+    const events = [
+      {
+        event: "quality_control_updated",
+        ts: timestamp,
+        user,
+        payload: {
+          version: "v1",
+          changes: {},
+        },
+      },
+    ];
+
+    expect(getParsedEvents(events)).toEqual([
+      {
+        ts: timestamp,
+        user,
+        header: [{ id: "quality_controls.events.quality_control_updated" }, {}],
         payload: [
           [
-            { id: "quality_controls.events.action_approved" },
-            {
-              field: "v2",
-              value: { id: "quality_control.status.published" },
-              b: bold,
-            },
+            { id: "quality_controls.events.action_updated" },
+            { field: "v1", b: bold },
+          ],
+        ],
+      },
+    ]);
+  });
+
+  it("returns payload for quality_control_version_draft_updated with empty changes", () => {
+    const events = [
+      {
+        event: "quality_control_version_draft_updated",
+        ts: timestamp,
+        user,
+        payload: {
+          version: "v2",
+          changes: {},
+        },
+      },
+    ];
+
+    expect(getParsedEvents(events)).toEqual([
+      {
+        ts: timestamp,
+        user,
+        header: [{ id: "quality_controls.events.quality_control_updated" }, {}],
+        payload: [
+          [
+            { id: "quality_controls.events.action_updated" },
+            { field: "v2", b: bold },
+          ],
+        ],
+      },
+    ]);
+  });
+
+  it("returns empty array for quality_control_updated with non-empty changes", () => {
+    const events = [
+      {
+        event: "quality_control_updated",
+        ts: timestamp,
+        user,
+        payload: {
+          version: "v1",
+          changes: {
+            name: "Updated name",
+          },
+        },
+      },
+    ];
+
+    expect(getParsedEvents(events)).toEqual([
+      {
+        ts: timestamp,
+        user,
+        header: [{ id: "quality_controls.events.quality_control_updated" }, {}],
+        payload: [
+          [
+            { id: "quality_controls.events.action_field_changed" },
+            { field: "name", value: "Updated name", b: bold },
           ],
         ],
       },

package/src/components/qualityControls/events/getParsedEvents.js

@@ -8,11 +8,18 @@ const normalizeValue = (value) => {
   return value;
 };
 
-const getPayloadFromActiveChange = (event) => {
+const getHeaderFromActiveChange = (event) => {
   if (_.has("payload.changes.active")(event)) {
     return _.prop("payload.changes.active")(event)
-      ? [[{ id: "quality_controls.events.action_enabled" }, { b: bold }]]
-      : [[{ id: "quality_controls.events.action_disabled" }, { b: bold }]];
+      ? [{ id: "quality_controls.events.action_enabled" }, { b: bold }]
+      : [{ id: "quality_controls.events.action_disabled" }, { b: bold }];
+  }
+  return [];
+};
+
+const getHeaderFromRegularFields = (event) => {
+  if (_.has("payload.changes")(event)) {
+    return [{ id: "quality_controls.events.quality_control_updated" }, {}];
   }
   return [];
 };
@@ -22,7 +29,7 @@ const getDomainNames = (path) => (event) =>
 
 const getPayloadFromDomainChange = (event) => {
   if (_.has("payload.changes.domains")(event)) {
-    const domainNames = _.join(", ")(
+    const changedDomainNames = _.join(", ")(
       getDomainNames("payload.changes.domains")(event)
     );
     const currentDomainNames = _.join(", ")(
@@ -31,7 +38,74 @@ const getPayloadFromDomainChange = (event) => {
     return [
       [
         { id: "quality_controls.events.action_domain_changed" },
-        { domainNames, currentDomainNames, b: bold },
+        { currentDomainNames, changedDomainNames, b: bold },
+      ],
+    ];
+  }
+  return [];
+};
+
+const formatScoreCriteriaParams = (type, value) => {
+  if (!_.isObject(value) || !type) return [];
+
+  const paramPairs =
+    type === "percentage"
+      ? [
+          value.goal !== undefined && [
+            { id: `quality_control.score_criteria.${type}.goal` },
+            value.goal,
+          ],
+          value.minimum !== undefined && [
+            { id: `quality_control.score_criteria.${type}.minimum` },
+            value.minimum,
+          ],
+        ]
+      : [
+          value.goal !== undefined && [
+            { id: `quality_control.score_criteria.${type}.goal` },
+            value.goal,
+          ],
+          value.maximum !== undefined && [
+            { id: `quality_control.score_criteria.${type}.maximum` },
+            value.maximum,
+          ],
+        ];
+
+  return _.compact(paramPairs);
+};
+
+const getPayloadFromScoreCriteriaChange = (event) => {
+  if (_.has("payload.changes.score_criteria")(event)) {
+    return _.flow(
+      _.toPairs,
+      _.map(([type, value]) => {
+        const params = formatScoreCriteriaParams(type, value);
+        return [
+          { id: "quality_controls.events.action_score_criteria_changed" },
+          {
+            type: { id: `quality_control.control_mode.${type}` },
+            params,
+            b: bold,
+          },
+        ];
+      })
+    )(event?.payload?.changes?.score_criteria);
+  }
+  return [];
+};
+
+const getPayloadFromControlModeChange = (event) => {
+  if (_.has("payload.changes.control_mode")(event)) {
+    return [
+      [
+        { id: "quality_controls.events.action_control_mode_changed" },
+        {
+          type: {
+            id: `quality_control.control_mode.${event?.payload?.changes?.control_mode}`,
+          },
+          params: [],
+          b: bold,
+        },
       ],
     ];
   }
@@ -52,12 +126,26 @@ const getPayloadFromDynamicContentChange = (event) => {
   return [];
 };
 
+const getPayloadFromQualityControlVersionUpdate = (event) => {
+  if (_.isEmpty(event?.payload?.changes)) {
+    return [
+      [
+        { id: "quality_controls.events.action_updated" },
+        { field: event?.payload?.version, b: bold },
+      ],
+    ];
+  }
+  return [];
+};
+
 const getPayloadFromRegularFields = (event) => {
   if (_.has("payload.changes")(event)) {
     return _.flow(
       _.omit(["dynamic_content"]),
       _.omit(["domains"]),
       _.omit(["active"]),
+      _.omit(["score_criteria"]),
+      _.omit(["control_mode"]),
       _.toPairs,
       _.map(([field, value]) => [
         { id: "quality_controls.events.action_field_changed" },
@@ -68,18 +156,31 @@ const getPayloadFromRegularFields = (event) => {
   return [];
 };
 
+const getHeaderFromUpdateEvent = (event) => {
+  const headerFromActiveChange = getHeaderFromActiveChange(event);
+  const headerFromRegularFields = getHeaderFromRegularFields(event);
+
+  return [...headerFromActiveChange, ...headerFromRegularFields];
+};
+
 const getPayloadFromUpdateEvent = (event) => {
-  const payloadFromActiveChange = getPayloadFromActiveChange(event);
   const payloadFromRegularFields = getPayloadFromRegularFields(event);
   const payloadFromDomainChange = getPayloadFromDomainChange(event);
+  const payloadFromScoreCriteriaChange =
+    getPayloadFromScoreCriteriaChange(event);
+  const payloadFromControlModeChange = getPayloadFromControlModeChange(event);
   const payloadFromDynamicContentChange =
     getPayloadFromDynamicContentChange(event);
+  const playloadFromQualityControlVersionUpdate =
+    getPayloadFromQualityControlVersionUpdate(event);
 
   return [
-    ...payloadFromActiveChange,
-    ...payloadFromRegularFields,
+    ...payloadFromControlModeChange,
+    ...payloadFromScoreCriteriaChange,
     ...payloadFromDomainChange,
     ...payloadFromDynamicContentChange,
+    ...payloadFromRegularFields,
+    ...playloadFromQualityControlVersionUpdate,
   ];
 };
 
@@ -90,30 +191,41 @@ const payloadFromEvent = (event) => {
     case "quality_control_created":
       return {
         ...eventBase,
+        header: [{ id: "quality_controls.events.quality_control_created" }, {}],
         payload: [
           [
             { id: "quality_controls.events.action_created" },
-            { field: event?.payload?.name, b: bold },
+            {
+              name: event?.payload?.name,
+              field: event?.payload?.version,
+              b: bold,
+            },
           ],
         ],
       };
     case "quality_control_version_status_updated":
       return {
         ...eventBase,
-        payload: [
-          [
-            { id: `quality_controls.events.action_${event?.payload?.action}` },
-            {
-              field: event?.payload?.version,
-              value: { id: `quality_control.status.${event?.payload?.status}` },
-              b: bold,
-            },
-          ],
+        header: [
+          { id: `quality_controls.events.action_${event?.payload?.action}` },
+          {
+            field: event?.payload?.version,
+            value: { id: `quality_control.status.${event?.payload?.status}` },
+            lowercase: true,
+            b: bold,
+          },
         ],
+        payload: [],
       };
     case "quality_control_version_draft_created":
       return {
         ...eventBase,
+        header: [
+          {
+            id: "quality_controls.events.quality_control_version_draft_created",
+          },
+          {},
+        ],
         payload: [
           [
             { id: "quality_controls.events.action_draft_version_created" },
@@ -122,9 +234,17 @@ const payloadFromEvent = (event) => {
         ],
       };
     case "quality_control_updated":
-      return { ...eventBase, payload: getPayloadFromUpdateEvent(event) };
+      return {
+        ...eventBase,
+        header: getHeaderFromUpdateEvent(event),
+        payload: getPayloadFromUpdateEvent(event),
+      };
     case "quality_control_version_draft_updated":
-      return { ...eventBase, payload: getPayloadFromUpdateEvent(event) };
+      return {
+        ...eventBase,
+        header: getHeaderFromUpdateEvent(event),
+        payload: getPayloadFromUpdateEvent(event),
+      };
     default:
       return null;
   }