@syncmatters/script-api 1.0.8 → 1.0.9

package/lib/connection.d.ts

@@ -192,6 +192,8 @@ export interface QueryOptions {
     randomFilter?: boolean;
     /** filter for rows by row id (key) */
     idsFilter?: Array<string>;
+    /** path of the alternate key field that the idsFilter values refer to, if applicable */
+    idsFilterField?: Array<API.JsonValuePathPart>;
     /** filter for rows that relate to another object on this connection */
     relatedFilter?: QueryRelatedFilter;
     /** filter for rows that meet a specific matching rule */
@@ -239,6 +241,8 @@ export interface QueryOneOptions {
     relationshipFields?: Array<string>;
     /** filter for rows by row id (key) */
     idsFilter?: Array<string>;
+    /** path of the alternate key field that the idsFilter values refer to, if applicable */
+    idsFilterField?: Array<API.JsonValuePathPart>;
     /** filter for rows that relate to another object on this connection */
     relatedFilter?: QueryRelatedFilter;
     /** filter for rows that meet a specific matching rule */
@@ -264,7 +268,8 @@ export interface Row {
     data?: any;
     /** if filters requested files be included in the response, and the if row includes a file, the file will be here */
     file?: FileProvider | null | undefined;
-    /** if filters requested rows filter by 'related', or 'matched' to source rows the relationship details will be here */
+    /** if filters requested rows filter by 'related', or 'matched' to source rows the relationship details will be here;
+     * for idsFilter queries with an idsFilterField, srcRowId holds the requested (alternate key) value this row matched */
     relationship?: {
         relationshipId?: string;
         srcObjectId?: string;
@@ -439,6 +444,8 @@ export interface ObjectField {
     isKey?: boolean;
     /** field holds an object containing the user defined row unique identifier required for add an update operations, and an indication of the operation type */
     isUserKey?: boolean;
+    /** field holds a unique value and the connector honors it as an idsFilterField key in queries */
+    isAlternateKey?: boolean;
     /** field, and any fields below, are custom (account specific) */
     isCustom?: boolean;
     /** can this field be referenced in match rules? */

package/lib/sync.d.ts

@@ -1,4 +1,4 @@
-import { Row, QueryRelatedFilter, QueryMatchFilter, QueryCheckpointFilter, UpsertCleanOptions, UpsertCleanResponse, ObjectFieldConstraints, JsonValuePath, RowMatchRuleType, Logger, Connection } from "../index.js";
+import { Row, QueryRelatedFilter, QueryMatchFilter, QueryCheckpointFilter, UpsertCleanOptions, UpsertCleanResponse, ObjectFieldConstraints, JsonValuePath, JsonValuePathPart, RowMatchRuleType, Logger, Connection } from "../index.js";
 export type GroupRunMode = "Standard" | "SelectedIds" | "Errors";
 export type SyncOptimalBatchSizeOperation = "noFilter" | "idsFilter" | "relatedFilter" | "matchFilter" | "checkpointFilter" | "randomFilter" | "rowFilter" | "upsert" | "delete";
 export type SyncOptimalBatchSizeBatchType = "atomic" | "concurrent" | "splitInsertUpdateAtomic";
@@ -163,6 +163,9 @@ export interface SyncEndpointField {
     /** indicates this field holds an object containing the user defined unique row identifier required
      * for add and update operations, with an indication of the operation type */
     isUserDefinedId?: boolean;
+    /** indicates this field holds a unique value the connector can resolve rows by as an alternate to
+     * the row id (e.g. in lookups) */
+    isAlternateId?: boolean;
     /** indicates this field is custom */
     isCustom?: boolean;
 }
@@ -198,6 +201,8 @@ export interface SyncQueryOptions {
     randomFilter?: boolean;
     /** filter for rows by row id (key) */
     idsFilter?: Array<string>;
+    /** path of the alternate key field that the idsFilter values refer to, if applicable */
+    idsFilterField?: Array<JsonValuePathPart>;
     /** filter for rows that relate to another objects rows on this endpoint */
     relatedFilter?: QueryRelatedFilter;
     /** filter for rows that meet a specific matching rule */

package/package.json

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