feat: set_item action: optionally target an index or id

packages/data-models/flowTypes.ts

@@ -340,6 +340,7 @@ export namespace FlowTypes {
     _evalContext?: { itemContext: TemplateRowItemEvalContext }; // force specific context variables when calculating eval statements (such as loop items)
     __EMPTY?: any; // empty cells (can be removed after pr 679 merged)
   }
+
   export type IDynamicField = { [key: string]: IDynamicField | TemplateRowDynamicEvaluator[] };
 
   export interface TemplateRowItemEvalContext {
@@ -351,6 +352,7 @@ export namespace FlowTypes {
     // item data
     [key: string]: any;
   }
+  export const itemMetadataFieldNames = ["_id", "_index", "_first", "_last"];
 
   type IDynamicPrefix = IAppConfig["DYNAMIC_PREFIXES"][number];
 

src/app/shared/components/template/components/data-items/data-items.component.ts

@@ -110,7 +110,7 @@ export class TmplDataItemsComponent extends TemplateBaseComponent implements OnD
       if (r.action_list) {
         r.action_list = r.action_list.map((a) => {
           if (a.action_id === "set_item") {
-            a.args = [this.dataListName, r._evalContext.itemContext._id];
+            a.args = [this.dataListName, itemDataIDs, itemIndex];
           }
           if (a.action_id === "set_items") {
             // TODO - add a check for @item refs and replace parameter list with correct values

src/app/shared/components/template/services/template-variables.service.ts

@@ -120,12 +120,18 @@ export class TemplateVariablesService extends AsyncServiceBase {
   }
 
   /**
-   * Inore evaluation of meta, comment, and specifiedfields.
+   * Ignore evaluation of meta, comment, and specifiedfields.
    * Could provide single list of approved fields, but as dynamic fields also can be found in parameter lists
    * would likely prove too restrictive
    **/
-  private shouldEvaluateField(fieldName: keyof FlowTypes.TemplateRow, omitFields: string[] = []) {
+  private shouldEvaluateField(
+    fieldName: keyof FlowTypes.TemplateRow | (typeof FlowTypes.itemMetadataFieldNames)[number],
+    omitFields: string[] = []
+  ) {
     if (omitFields.includes(fieldName)) return false;
+    // Evaluate fields that are names of item metadata fields, e.g. "_index", "_id",
+    // E.g. for use in actions such as `click | set_item | _index: @item._index + 1, completed:false`
+    if (FlowTypes.itemMetadataFieldNames.includes(fieldName)) return true;
     if (fieldName.startsWith("_")) return false;
     return true;
   }
@@ -183,6 +189,11 @@ export class TemplateVariablesService extends AsyncServiceBase {
         return evaluator.fullExpression.replace(/`/gi, "");
       }
 
+      // Do not evaluate if the appropriate context is not available
+      if (type === "item" && !context.itemContext) {
+        return evaluator.fullExpression;
+      }
+
       // process the main lookup, e.g. @local.some_val, @campaign.some_val
       // NOTE - if parse fail an empty string will be returned
       let { parsedValue, parseSuccess } = await this.processDynamicEvaluator(evaluator, context);

src/app/shared/services/dynamic-data/dynamic-data.service.ts

@@ -6,7 +6,7 @@ import { FlowTypes } from "data-models";
 import { environment } from "src/environments/environment";
 import { AppDataService } from "../data/app-data.service";
 import { AsyncServiceBase } from "../asyncService.base";
-import { arrayToHashmap, deepMergeObjects } from "../../utils";
+import { arrayToHashmap, deepMergeObjects, evaluateJSExpression } from "../../utils";
 import { PersistedMemoryAdapter } from "./adapters/persistedMemory";
 import { ReactiveMemoryAdapater, REACTIVE_SCHEMA_BASE } from "./adapters/reactiveMemory";
 import { TemplateActionRegistry } from "../../components/template/services/instance/template-action.registry";
@@ -66,9 +66,39 @@ export class DynamicDataService extends AsyncServiceBase {
   }
   private registerTemplateActionHandlers() {
     this.templateActionRegistry.register({
+      /**
+       * Write properties on the current item (default), or on an explicitly targeted item,
+       * e.g.
+       * click | set_item | completed:true;
+       * click | set_item | _id: @item.id, completed:true;
+       * click | set_item | _index: @item._index + 1, completed:true;
+       */
       set_item: async ({ args, params }) => {
-        const [flow_name, row_id] = args;
-        await this.update("data_list", flow_name, row_id, params);
+        const [flow_name, itemDataIDs, itemIndex] = args;
+        const { _index, _id, ...writeableProps } = params;
+
+        // Target current row if another target is not explicitly provided
+        let targetRowId = itemDataIDs[itemIndex];
+        if (_index !== undefined) {
+          targetRowId = itemDataIDs[_index];
+        }
+        if (_id) {
+          targetRowId = _id;
+        }
+
+        if (itemDataIDs.includes(targetRowId)) {
+          console.log(
+            `[SET ITEM] - Setting properties on ${targetRowId}: ${JSON.stringify(writeableProps)}`
+          );
+          await this.update("data_list", flow_name, targetRowId, writeableProps);
+        } else {
+          if (_id) {
+            console.warn(`[SET ITEM] - No item with ID ${_id}`);
+          }
+          if (_index !== undefined) {
+            console.warn(`[SET ITEM] - No item at index ${_index}`);
+          }
+        }
       },
       set_items: async ({ args, params }) => {
         const [flow_name, row_ids] = args;

src/theme/themes/pfr.scss

@@ -48,7 +48,7 @@
       // radio-button-font-color: var(--ion-color-primary),
       ion-item-background: var(--ion-color-gray-light),
       // task-progress-bar-color: var(--ion-color-primary),
-      // checkbox-background-color: white,,,
+      // checkbox-background-color: white,,,,
     );
     @include utils.generateTheme($color-primary, $color-secondary, $page-background, $g: $green);
     @each $name, $value in $variable-overrides {