@syncmatters/script-api 1.0.23 → 1.0.24

package/api.d.ts

@@ -10,7 +10,7 @@ export * from "./lib/sync.js";
 export * from "./lib/sync-group.js";
 export * from "./lib/utilities/kv-store/types.js";
 export * from "./lib/utilities/rate-limiter/rate-limiter.js";
-export type { HttpClient, HttpClientOptions, HttpRequest, } from "./lib/utilities/http-client/types.js";
+export type { HttpClient, HttpClientOptions, HttpFullResponse, HttpRequest, } from "./lib/utilities/http-client/types.js";
 export type JsonValuesReader = InstanceType<typeof JVR>;
 export type JsonValuesWriter = InstanceType<typeof JVW.JsonValuesWriter>;
 export type WriteBehaviour = JVW.WriteBehaviour;

package/lib/connection.d.ts

@@ -141,7 +141,7 @@ export interface CacheQueryOneOptions {
             name: string;
             values: string[];
         };
-        key?: string;
+        keys?: string[];
     };
     propertyFilter?: {
         metaOnly?: boolean;
@@ -292,8 +292,6 @@ export interface Row {
         srcObjectId?: string;
         srcRowId: string;
     };
-    /** if filters requested rows be returned from a 'checkpoint', the final row in the stream will return the next checkpoint here */
-    checkpoint?: string | undefined;
 }
 /** Iterator is returned in response to Query() operations  */
 export interface QueryIterator<T> extends AsyncIterableIterator<T> {
@@ -438,11 +436,11 @@ export interface ObjectSettingMeta {
     advanced?: boolean;
     readonly?: boolean;
     mandatory?: boolean;
-    displayIf?: string;
+    displayIf?: "none" | "other_setting_has_value" | "other_setting_is_not_empty";
     displayIfSetting?: string;
     displayIfValues?: string[];
-    type?: string;
-    control?: string;
+    type?: "string" | "boolean" | "number" | "string_array" | "connection_uid_template" | "google_picker";
+    control?: "singlelinetext" | "textarea" | "checkbox" | "switch" | "integer" | "url" | "datepicker" | "datetimepicker" | "filepicker" | "drivefolder" | "drivefile" | "select" | "multiselect" | "button" | "timezone";
     options?: ObjectSettingMetaOption[];
     default?: unknown;
     constraints?: ObjectFieldConstraints;
@@ -452,11 +450,6 @@ export interface ObjectSettingMetaOption {
     id: string;
     name?: string;
     order?: string;
-    /**
-     * on an option of a prerequisite (or defines_version) connection setting: `false` makes a connection
-     * with this option selected single-phase - discover() is never called and its metadata is collected on
-     * first use, as for a connector without discovery. Absent inherits the connector's `discovery` flag.
-     */
     discovery?: boolean;
 }
 export interface ObjectRowFilter {
@@ -676,7 +669,7 @@ export interface ObjectRelationship {
     data?: any;
 }
 /** IndexType holds a data index definition */
-export type IndexType = "unknown" | "jsonpath expression";
+export type IndexType = "jsonpath expression";
 /** ObjectIndex specifies an index to be added to cached connector data. */
 export interface ObjectIndex {
     name: string;

package/lib/context.d.ts

@@ -20,6 +20,18 @@ export interface Context {
     parameters: {
         [name: string]: any;
     };
+    /** set only when the run was triggered by an event */
+    event?: {
+        failedAttempts: number;
+        connectionId: string;
+        typeId: string;
+        timestamp: number;
+        object?: {
+            id: string;
+            key?: string;
+        };
+        data?: any;
+    };
     connections: ContextMapFactories<ConnectionMap, Connection>;
     syncGroups: ContextMapFactories<SyncGroupMap, SyncGroup>;
     state: {

package/lib/utilities/csv-reader/csv-reader-csv-parse.d.ts

@@ -9,7 +9,7 @@ export declare class CsvReaderCsvParse implements CsvReader {
     header(): Promise<string[]>;
     jsDoc(): Promise<string>;
     verifyHeader(required: string[]): Promise<void>;
-    rows(): AsyncIterableIterator<any>;
+    rows(): AsyncIterableIterator<string[]>;
     rowsWithProps(): AsyncIterableIterator<{
         [name: string]: string;
     }>;

package/lib/utilities/csv-reader/types.d.ts

@@ -26,14 +26,21 @@ export interface CsvReaderOptions {
     escapeChar?: string;
     /** number of lines to skip at the beginning of the file */
     skipLines?: number;
-    /** parse engine to use (default: 'fast-csv') */
+    /**
+     * parse engine to use (default: 'csv-parse'). 'fast-csv' was the default until csv-parse (not strict) was made to
+     * read as it does; it remains as a fallback while the switch beds in
+     */
     parseEngine?: "fast-csv" | "csv-parse";
+    /**
+     * csv-parse engine only: true rejects ragged rows, stray or misplaced quotes and whitespace-only lines, reporting
+     * the line number; false (default) tolerates them as the fast-csv engine does
+     */
+    strict?: boolean;
 }
 /**
  * CsvReader parses a csv and emits an async iterator for accessing the next row. The row is an array
- * allowing access to the fields by index or, if the csv has a header, by header name:
+ * allowing access to the fields by index, rowsWithProps allows access by header name:
  * for await (const row of reader.rows()) {
- *   var field1ByName = row["my col name"];
  *   var field1ByIndex = row[0];
  *  }
  */
@@ -41,7 +48,7 @@ export interface CsvReader {
     header(): Promise<string[]>;
     jsDoc(): Promise<string>;
     verifyHeader(required: string[]): Promise<void>;
-    rows(): AsyncIterableIterator<any>;
+    rows(): AsyncIterableIterator<string[]>;
     rowsWithProps(): AsyncIterableIterator<{
         [name: string]: string;
     }>;

package/lib/utilities/http-client/types.d.ts

@@ -36,6 +36,14 @@ export interface HttpRequest {
     fullResponse?: boolean;
     fileResponse?: boolean;
 }
+/** HttpFullResponse is the execute() response when HttpRequest option fullResponse is true */
+export interface HttpFullResponse {
+    body?: any;
+    headers: {
+        [name: string]: string;
+    };
+    statusCode: number;
+}
 /** HttpCanRetry is an optional interface allowing a connector to assess whether a retry is allowed */
 export interface HttpCanRetry {
     (err: HttpError, method: HttpMethod, url: string, httpCode: number, responseHeaders: {
@@ -55,7 +63,6 @@ export interface HttpClientOptions {
     errMessageFormat?: "default" | "concise";
     canRetry?: HttpCanRetry;
     onError?: (err: HttpError, method: HttpMethod, url: string, httpCode: number, reqJson?: unknown) => void;
-    onSuccess?: (method: string, url: string, httpCode: number, reqJson?: unknown) => void;
 }
 export interface HttpClient {
     execute: (request: HttpRequest) => Promise<any>;

package/package.json

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