@octaviaflow/flow-rules 0.15.0 → 0.16.0

package/dist/catalog/general/transform/config.d.ts

@@ -26,6 +26,19 @@ export interface FieldMapping {
     depth?: number;
     /** With `groupBy`: this field goes into each line of the record's list, not the record (DEV-478). Root level only. */
     lineField?: boolean;
+    /**
+     * "Find by" (DEV-480): the mapped value names a record in the target app —
+     * the write uses the id of the `object` record whose `matchField` equals it.
+     * Root level only; on a line field it applies to each line. Odoo today.
+     */
+    lookup?: TransformLookup;
+}
+/** A record in the target app, found by one of its fields (DEV-480). */
+export interface TransformLookup {
+    /** The target app's object (Odoo model): res.partner, product.product. */
+    object: string;
+    /** The field the mapped value is matched against: email, default_code. Must be unique. */
+    matchField: string;
 }
 /**
  * One record per key (DEV-478): rows whose `key` resolves to the same value

package/dist/index.cjs

@@ -3774,7 +3774,7 @@ var TransformConfig = {
     mappings: {
       type: "array",
       required: false,
-      description: "Field mappings: [{ id, sourceField, targetField, targetType, transform? }]. sourceField is a token like {{orders[].email}}; " + "an index picks one list element ({{products[].variants[0].price}}). With groupBy, set lineField: true on the mappings that make each line."
+      description: "Field mappings: [{ id, sourceField, targetField, targetType, transform? }]. sourceField is a token like {{orders[].email}}; " + "an index picks one list element ({{products[].variants[0].price}}). With groupBy, set lineField: true on the mappings that make each line. " + 'When the target field holds a record id but you have a reference (an email, SHOP-123), add lookup: { "object": "product.product", "matchField": "default_code" } — ' + "the write uses the id of the one record whose matchField equals the value; no match, or more than one, fails that row. Odoo only for now."
     },
     groupBy: {
       type: "json",
@@ -3818,6 +3818,10 @@ var TransformConfig = {
           if (!mapping.targetField) {
             errors.push(`Mapping ${index + 1}: Target field is required`);
           }
+          const lookup = mapping.lookup;
+          if (lookup && (!lookup.object || !lookup.matchField)) {
+            errors.push(`Mapping ${index + 1}: Find by needs both the object and the field to match (lookup.object, lookup.matchField)`);
+          }
         });
       }
     }

package/dist/index.d.ts

@@ -36,7 +36,7 @@ export { EmailConfig, } from "./catalog/communication/email-send/config";
 export { queryDefinition, } from "./catalog/general/query/index";
 export { isQueryableConnector, } from "./catalog/general/query/config";
 export { AggregateFunction, type BuildQueryConfig, type ColumnSchema, type ConnectorSchema, JoinType, LogicalOperator, type QueryExecutionResult, type QueryField, type QueryFilter, type QueryFilterGroup, type QueryJoin, type QuerySort, SortDirection, type VisualQueryConfig, } from "./catalog/general/query/types";
-export { DATABASE_CONNECTOR_IDS, type FieldMapping, TRANSFORM_MODES, TRANSFORM_OPERATIONS, TransformConfig, type TransformConfigType, type TransformGroupBy, type TransformOperation, } from "./catalog/general/transform/config";
+export { DATABASE_CONNECTOR_IDS, type FieldMapping, TRANSFORM_MODES, TRANSFORM_OPERATIONS, TransformConfig, type TransformConfigType, type TransformGroupBy, type TransformLookup, type TransformOperation, } from "./catalog/general/transform/config";
 export { AGGREGATE_FUNCTIONS, AGGREGATE_FUNCTION_DESCRIPTIONS, AggregateConfig, type AggregateConfigType, type AggregateFn, type AggregateMetric, type AggregateSchemaNode, groupKeyName, } from "./catalog/general/aggregate/config";
 export { detectRecordFields, resolveRecordSchema, type RecordSchemaLike, } from "./catalog/logic/for-each/recordSchema";
 export { STORAGE_CONNECTOR_IDS, type StorageExtraField, type StoragePathField, getStorageProvider, storageConfigKeys, } from "./catalog/storage/storageCapabilities";

package/dist/index.js

@@ -3616,7 +3616,7 @@ var TransformConfig = {
     mappings: {
       type: "array",
       required: false,
-      description: "Field mappings: [{ id, sourceField, targetField, targetType, transform? }]. sourceField is a token like {{orders[].email}}; " + "an index picks one list element ({{products[].variants[0].price}}). With groupBy, set lineField: true on the mappings that make each line."
+      description: "Field mappings: [{ id, sourceField, targetField, targetType, transform? }]. sourceField is a token like {{orders[].email}}; " + "an index picks one list element ({{products[].variants[0].price}}). With groupBy, set lineField: true on the mappings that make each line. " + 'When the target field holds a record id but you have a reference (an email, SHOP-123), add lookup: { "object": "product.product", "matchField": "default_code" } — ' + "the write uses the id of the one record whose matchField equals the value; no match, or more than one, fails that row. Odoo only for now."
     },
     groupBy: {
       type: "json",
@@ -3660,6 +3660,10 @@ var TransformConfig = {
           if (!mapping.targetField) {
             errors.push(`Mapping ${index + 1}: Target field is required`);
           }
+          const lookup = mapping.lookup;
+          if (lookup && (!lookup.object || !lookup.matchField)) {
+            errors.push(`Mapping ${index + 1}: Find by needs both the object and the field to match (lookup.object, lookup.matchField)`);
+          }
         });
       }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@octaviaflow/flow-rules",
-  "version": "0.15.0",
+  "version": "0.16.0",
   "description": "The flow action catalog and the rules engine behind Flow Doctor — one definition of what a step accepts and what makes a flow valid, shared by the editor and the server",
   "type": "module",
   "main": "./dist/index.cjs",