@syncmatters/script-api 1.0.0 → 1.0.2

package/README.md

@@ -26,11 +26,6 @@ import SDKTest from "@syncmatters/script-api/sdk-test";
 Add `"checkJs": true` to your `jsconfig.json` to activate the JSDoc type annotations used in
 script `.mjs` files.
 
-## Legacy package name
-
-`@ihq/script-api` is the legacy name of this package (IntegrateHQ is now SyncMatters).
-Existing scripts importing the legacy name continue to work on-platform.
-
 ## Support
 
 - <https://syncmatters.com>

package/lib/connection.d.ts

@@ -198,8 +198,9 @@ export interface QueryOptions {
     matchFilter?: QueryMatchFilter;
     /** collect records changed since a particular checkpoint */
     checkpointFilter?: QueryCheckpointFilter;
-    /** row filter & property filter are system-specific and may support non-standard filters  */
+    /** system specific row filters; allowed values are defined in meta.queryFilter.rowFilter */
     rowFilter?: any;
+    /** @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) */
@@ -334,7 +335,9 @@ export interface ObjectMeta {
     isCustom?: boolean;
     queryFields?: ObjectField[];
     queryFilter?: {
+        /** system specific row filters; 'extends' marks where each may augment standard filters */
         rowFilter?: ObjectRowFilter[];
+        /** @deprecated superseded by the standard fields filter (queryOptions.fields) */
         propertyFilter?: ObjectField[];
     };
     queryFile?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@syncmatters/script-api",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "TypeScript type definitions for the SyncMatters script API (types only - scripts execute on the SyncMatters platform)",
   "types": "./index.d.ts",
   "exports": {
@@ -16,7 +16,7 @@
   "license": "MIT",
   "author": "SyncMatters",
   "homepage": "https://syncmatters.com",
-  "typesContentHash": "143c303baa596be30ce78a3af1e88dbcd485a63237e15a553bd0fe74ce495dc7",
+  "typesContentHash": "23e348562b4cc2c16071bcde6df9f30020b804b832fcd0fba00dc3071546a7b4",
   "dependencies": {
     "@types/node": "*"
   }