@syncmatters/script-api 1.0.1 → 1.0.3

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.1",
+  "version": "1.0.3",
   "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": "29fdd96780e4fe73c142677135c027e19732844e98498afdb5d6627bee7f23de",
+  "typesContentHash": "5577c9441eba47e953c86451ad8491f6ab1d10a4c135b1f76564fe222a63e6f5",
   "dependencies": {
     "@types/node": "*"
   }

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

@@ -138,6 +138,14 @@ export interface ObjectFeatures {
         cannotTestReason?: string;
         /** Can rows be added/updated? */
         canUpsert?: boolean;
+        /**
+         * Rows are created but never updated (e.g. sent messages, execution records - the API
+         * has no update and the connector throws NotImplimented for rows arriving with a key).
+         * The upsert test runs its insert + query-back phases and SKIPS the update phase,
+         * reporting "Passed (insert only)"; upsertPrepare then only needs insert + verifyFields.
+         * Use cannotTestReason instead when even CREATING rows is off-limits.
+         */
+        insertOnly?: boolean;
         key?: {
             /** Path to the key in upsert fields */
             path?: API.JsonValuePath;
@@ -228,7 +236,7 @@ export interface ObjectTestResult {
     matchFilterNotTestedReason?: string;
     matchFieldCount?: number;
     matchFilterResults?: MatchRuleTestResult[];
-    upsert?: "Passed" | "Not tested" | "Not supported" | "Failed: 'Same as object' not tested" | "Failed: Feature has no test spec" | "Failed: Fatal error during testing" | "Failed: Test spec does not define key field" | "Failed: No test data for insert" | "Failed: No test data for update" | "Failed: No verifyField included with test data" | "Failed: query after insert did not return expected rows" | "Failed: No key path to test update" | "Failed: update returned unexpected row" | "Failed: verifyField value on the upsert row was blank" | "Failed: verifyField value on the queried row does not match the upsert value";
+    upsert?: "Passed" | "Passed (insert only)" | "Not tested" | "Not supported" | "Failed: 'Same as object' not tested" | "Failed: Feature has no test spec" | "Failed: Fatal error during testing" | "Failed: Test spec does not define key field" | "Failed: No test data for insert" | "Failed: No test data for update" | "Failed: No verifyField included with test data" | "Failed: query after insert did not return expected rows" | "Failed: No key path to test update" | "Failed: update returned unexpected row" | "Failed: verifyField value on the upsert row was blank" | "Failed: verifyField value on the queried row does not match the upsert value";
     upsertNotTestedSameAsObjectId?: string;
     upsertNotTestedReason?: string;
     upsertFatalError?: CaughtError;