@syncmatters/script-api 1.0.4 → 1.0.6

package/lib/connection.d.ts

@@ -482,7 +482,14 @@ export interface ObjectFieldOption {
 }
 /** ObjectFieldConstraints holds details of expected/allowed values for a field. */
 export interface ObjectFieldConstraints {
+    /**
+     * When the field is required on upsert.
+     * For fields inside `arrayObjectFields`, mandatory is only enforced when the parent array
+     * has at least one element — an empty or absent array does not trigger `ValueRequired`.
+     * When the array is non-empty, every element must provide a satisfying value.
+     */
     mandatory?: "always" | "add" | "update";
+    /** Values that satisfy a mandatory constraint without raising `ValueRequired`. */
     mandatoryAccepts?: Array<"null" | "blank_string">;
     max?: number;
     min?: number;

package/lib/utilities/http-client/fetch-http-error.d.ts

@@ -11,4 +11,6 @@ export declare class HttpError extends Error implements HttpErrorType {
     responseBodyBuffer?: Buffer;
     responseBodyJson?: unknown;
     constructor(err: Error | string, statusCode: number | undefined);
+    /** Include url in JSON serialization so user-visible error payloads retain the request URL. */
+    toJSON(): Pick<HttpErrorType, "name" | "message" | "stack" | "code" | "url" | "statusCode">;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@syncmatters/script-api",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "TypeScript type definitions for the SyncMatters script API (types only - scripts execute on the SyncMatters platform)",
   "types": "./index.d.ts",
   "exports": {
@@ -11,12 +11,16 @@
     "./sdk-test": {
       "types": "./sdk-test.d.ts",
       "default": "./index.js"
+    },
+    "./api": {
+      "types": "./api.d.ts",
+      "default": "./index.js"
     }
   },
   "license": "MIT",
   "author": "SyncMatters",
   "homepage": "https://syncmatters.com",
-  "typesContentHash": "ed924bcb7bf03a6b4a1769beacbdf45f9887b21cb6a20f2a434b9fbe1813b4b8",
+  "typesContentHash": "87164fc7d9ba4a7b759acaa21737560cfb815a277721adbff4ab10a0ade8f806",
   "dependencies": {
     "@types/node": "*"
   }

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

@@ -208,6 +208,10 @@ export interface ConnectorTestResult {
     testConnection?: "Passed" | "Not tested" | "Failed: Fatal error during testing" | "Failed: Test connection response did not report success";
     objectsStatus?: "Passed" | "Partial: Only selected objects tested" | "Partial: Only selected objects tested, not all features can be tested" | "Partial: Only selected object tests run" | "Partial: Only selected objects tested, only selected object tests run" | "Partial: Not all features/objects can be tested" | "Not tested" | "Failed: Fatal error during testing" | "Failed: One or more objects failed tests";
     objects: ObjectTestResult[];
+    /** Diagnostic details for connection-level stages, keyed by stage (testConnection, metaRefresh). */
+    details?: {
+        [stage: string]: TestDetail[];
+    };
 }
 export interface ObjectTestResult {
     objectId: string;
@@ -251,6 +255,10 @@ export interface ObjectTestResult {
     deleteFatalError?: CaughtError;
     fieldMetadata?: "Passed" | "Not tested" | "Failed: One or more fields have metadata issues";
     fieldMetadataIssues: FieldMetadataIssue[];
+    /** Diagnostic details keyed by feature (list, idsFilter, checkpointFilter, upsert, upsertClean, delete, fieldMetadata). */
+    details?: {
+        [feature: string]: TestDetail[];
+    };
 }
 export interface FieldMetadataIssue {
     operation: "query" | "upsert" | "delete";
@@ -264,6 +272,8 @@ export interface MatchRuleTestResult {
     notTestedReason?: string;
     errorRowId?: string;
     fatalError?: CaughtError;
+    /** Diagnostic details for this rule. */
+    details?: TestDetail[];
 }
 export interface RelatedFilterTestResult {
     relationshipId: string;
@@ -272,12 +282,28 @@ export interface RelatedFilterTestResult {
     notTestedReason?: string;
     errorRowId?: string;
     fatalError?: CaughtError;
+    /** Diagnostic details for this relationship. */
+    details?: TestDetail[];
 }
 /** Details from caught error that blocked test completion */
 export interface CaughtError {
     message?: string;
     stack?: string;
 }
+/**
+ * A diagnostic detail captured while testing; mirrors what the test harness logs (a message plus
+ * the inputs/outputs the message relates to). Details are saved with the test result so the
+ * harness i/o can be reviewed alongside statuses; the platform scrubs them after a short
+ * retention window, statuses remain.
+ */
+export interface TestDetail {
+    level: "info" | "error";
+    message: string;
+    /** Inputs/outputs relating to the message (e.g. filter ids used, rows returned). */
+    data?: unknown;
+    /** Set when the data payload was dropped to honour the capture size budget. */
+    truncated?: boolean;
+}
 /** Options passed when requesting data that will be used for an upsert test. */
 export interface UpsertOptions {
     meta: API.ObjectMeta;