@syncmatters/connector-sdk 1.0.13 → 1.0.14

package/docs/05-query.md

@@ -242,6 +242,16 @@ candidates }])` — the platform reserves un-mapped matches and returns the sele
 - **field_value_equals[ci]** - inspect the `match.custom` value and search in the selected `destFieldPath` (path to the field on the target system) to find rows holding this value (case insensitive) in this field.
 - **field_values_equal[ci]** - `destFieldPaths[k]` pairs with `match.customs[k]` (1-5 pairs); find rows where **every** pair is equal (case insensitive), i.e. `destFieldPaths[0] = customs[0] AND destFieldPaths[1] = customs[1] ...`. A `""` entry in `customs` means that destination field must be empty/absent: filter for "empty" (e.g. HubSpot `NOT_HAS_PROPERTY`, SOQL `= null`), never drop the filter, because dropping it widens the search. The platform only sends a blank when the user enabled "match blank values" for that pair, and never sends a row whose values are all blank.
 
+`destFieldPath` is set only for `id` and `field_value_equals[ci]`; `destFieldPaths` only for
+`field_values_equal[ci]`. Nested fields use the same path shape as `fields` (e.g.
+`[{ path: "custom_fields" }, { path: "tax_id" }]`). `srcData` is a batch — search them
+together where the API allows it. `match.id` already includes the user's source-id prefix when
+they configured one.
+
+The in-app Help article *Calling a connection from a script* has copy-paste `matchFilter`
+objects for every rule (same `rule` / `srcData` / `destFieldPath(s)` the platform sends here,
+plus `canUse` on this path). Do not duplicate that catalog in this file.
+
 ### relatedFilter
 
 Receives rows from a source object (`otherObjectId`) that has a defined relationship to this object, and collect the related rows from this object.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@syncmatters/connector-sdk",
-  "version": "1.0.13",
+  "version": "1.0.14",
   "description": "TypeScript type definitions for the SyncMatters connector SDK (types only - connectors execute on the SyncMatters platform)",
   "types": "./index.d.ts",
   "exports": {
@@ -12,7 +12,7 @@
   "license": "MIT",
   "author": "SyncMatters",
   "homepage": "https://syncmatters.com",
-  "typesContentHash": "b08f55c29df514e6a627b6c4fe49634d4c563c235420642189e63de96fe7af5c",
+  "typesContentHash": "09f69999930df0f8199bfd417a03cfa1bb882d929614b96a26f8f52e7acab0f9",
   "dependencies": {
     "@types/node": "*",
     "@syncmatters/script-api": "^1.0.15"