@syncmatters/script-api 1.0.13 → 1.0.15

package/lib/connection.d.ts

@@ -205,7 +205,7 @@ export interface QueryOptions {
     /** @deprecated  (use standard fields filter) system specific property filters; allowed values are defined in meta.queryFilter.propertyFilter */
     propertyFilter?: any;
 }
-export type RowMatchRuleType = "id" /** match by source row id (key) */ | "name[ci]" /** match by destination row name (case senstive) */ | "email[ci]" /** match by destination row email (case insenstive) */ | "domain[ci]" /** match by destination domain (case insenstive) */ | "first_and_last_name[ci]" /** match by destination first and last name (case insenstive) */ | "field_value_equals[ci]"; /** match by value in user selected field (case insenstive) */
+export type RowMatchRuleType = "id" /** match by source row id (key) */ | "name[ci]" /** match by destination row name (case insensitive) */ | "email[ci]" /** match by destination row email (case insensitive) */ | "domain[ci]" /** match by destination domain (case insensitive) */ | "first_and_last_name[ci]" /** match by destination first and last name (case insensitive) */ | "field_value_equals[ci]" /** match by value in user selected field (case insensitive) */ | "field_values_equal[ci]"; /** match by 1-5 user selected source/destination field pairs, all must be equal (case insensitive) */
 export type RowMatchRuleOrder = "oldest" | "newest" | "alphabetical";
 /** source row data used by the destination connector when matching a source row to a destination row */
 export interface RowMatchData {
@@ -227,6 +227,11 @@ export interface RowMatchData {
         lastname?: string;
         /** custom value to match */
         custom?: string | number;
+        /**
+         * field_values_equal[ci]: values to match, index-aligned with QueryMatchFilter.destFieldPaths. A blank ("") value
+         * means the destination field must be empty/absent - filter for "empty", never drop the filter.
+         */
+        customs?: Array<string | number>;
     };
 }
 /** unique ids (property names) used in the row match data passed to the destination when a match is saught */
@@ -300,6 +305,11 @@ export interface QueryMatchFilter {
     selectOrder?: RowMatchRuleOrder;
     /** if the rule references a field in the destination row the path to the destination field will be specified here (e.g. match value in a specific field) */
     destFieldPath?: Array<API.JsonValuePathPart>;
+    /**
+     * field_values_equal[ci]: paths to the destination fields to compare, index-aligned with RowMatchData.match.customs;
+     * a destination row matches when every pair is equal
+     */
+    destFieldPaths?: Array<Array<API.JsonValuePathPart>>;
     /** data to match */
     srcData: Array<RowMatchData>;
     /**

package/lib/utilities/xml-utils/types.d.ts

@@ -22,6 +22,12 @@ export interface XmlParseOptions {
      * When set, xmlParse streams matching elements; omit for a full-document Promise.
      */
     emit?: string[];
+    /**
+     * XPath subset expressions (same syntax as `emit`) naming elements to prune: a matching
+     * element and its whole subtree are dropped before any `emit` matching or recording, so
+     * documents padded with unread markup cost neither parse time nor memory. Requires `emit`.
+     */
+    skip?: string[];
 }
 /**
  * One matched element from a streaming xmlParse({ source, emit }) call.

package/lib/utilities/xml-utils/xpath-subset.d.ts

@@ -17,9 +17,10 @@ export declare function localNameOf(qname: string): string;
 /**
  * Compile one XPath-subset expression.
  * Supported: `//Name`, `/A/B/C`, `A/B` (local names only; prefixes ignored).
+ * `label` names the option being compiled so errors point at `emit` or `skip`.
  */
-export declare function compileEmitExpression(raw: string): XmlEmitMatcher;
-export declare function compileEmitExpressions(emit: string[]): XmlEmitMatcher[];
+export declare function compileEmitExpression(raw: string, label?: string): XmlEmitMatcher;
+export declare function compileEmitExpressions(expressions: string[], label?: string): XmlEmitMatcher[];
 /** True if the current element stack (local names) matches the compiled expression. */
 export declare function matchesEmit(matcher: XmlEmitMatcher, pathLocalNames: string[]): boolean;
 /** Last path step local name for a matcher (the element that starts a potential match). */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@syncmatters/script-api",
-  "version": "1.0.13",
+  "version": "1.0.15",
   "description": "TypeScript type definitions for the SyncMatters script API (types only - scripts execute on the SyncMatters platform)",
   "types": "./index.d.ts",
   "exports": {
@@ -28,7 +28,7 @@
   "license": "MIT",
   "author": "SyncMatters",
   "homepage": "https://syncmatters.com",
-  "typesContentHash": "5cb475fa1240d9fa9964086b867786e024b3d3b555313717aafd586bbec05675",
+  "typesContentHash": "ad2f1f5cd5868f2362746920bfba5713dcf146857db7641a69ed90c72e101dff",
   "dependencies": {
     "@types/node": "*"
   }

package/sdk-test/sdk-test.d.ts

@@ -354,6 +354,8 @@ export interface MatchData {
     srcData: API.RowMatchData[];
     /** path to the field on the dest row that holds the field to match with, if applicable to the rule */
     destFieldPath?: API.JsonValuePath;
+    /** field_values_equal[ci]: paths to the dest row fields to match with, index-aligned with srcData[].match.customs */
+    destFieldPaths?: API.JsonValuePath[];
     /** ids of dest rows expected back in response to the match query */
     expectedMatchRowIds: string[];
     /** optionally specify the fields to include in the match query */