@syncmatters/script-api 1.0.2 → 1.0.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@syncmatters/script-api",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "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": "23e348562b4cc2c16071bcde6df9f30020b804b832fcd0fba00dc3071546a7b4",
+  "typesContentHash": "ed924bcb7bf03a6b4a1769beacbdf45f9887b21cb6a20f2a434b9fbe1813b4b8",
   "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;
@@ -393,7 +401,7 @@ export interface ListCleanupOptions {
 }
 /** Data returned when requesting data that will be used for an list test. */
 export interface ListData {
-    /** number of rows included in each page of data returned via a list query, user to test pagination */
+    /** number of rows included in each page of data returned via a list query, used to test pagination */
     pageSize: number;
     /** optionally specify the fields to include in the list query */
     fields?: Array<API.JsonValuePath>;