@syncmatters/connector-sdk 1.0.23 → 1.0.25

package/docs/01-workspace-and-meta-json.md

@@ -174,11 +174,15 @@ Rules worth knowing before you mark anything:
   previous result is kept and the user is offered a re-collect. Nothing is queued automatically.
 - A setting with no `options`, in the sidecar or in the overrides, renders as free text. The
   overrides may also supply `default`, `mandatory`, `readonly`, `hidden` and `description`.
-- `prerequisite` is ignored when `discovery` is absent, and `sm validate` rejects
-  `"discovery": true` with no `prerequisite` setting. It warns when it finds no `discover()` on
-  the entry class (and vice versa): the flag is what the platform reads, so a flagged class
-  without the method fails loudly in the wizard with `NotImplimented` rather than being treated
-  as single-phase.
+- `prerequisite` is ignored when `discovery` is absent. `sm validate` rejects
+  `"discovery": true` with no `prerequisite` setting, unless `oauth2_mode` is `"connector"`,
+  `"connection"`, or `"connection_optional"`. Those reach the tenant through the OAuth grant,
+  which is obtained before `discover()` and is not a connection setting — a connector whose
+  only setting is Debug is valid. Do not mark Debug (or any other setting `discover()` does not
+  read) `"prerequisite": true` just to pass validation: changing it marks the catalogue stale.
+  `sm validate` warns when it finds no `discover()` on the entry class (and vice versa): the
+  flag is what the platform reads, so a flagged class without the method fails loudly in the
+  wizard with `NotImplimented` rather than being treated as single-phase.
 
 #### A version that cannot discover: `"discovery": false` on its option
 

package/docs/03-http-auth-ratelimit.md

@@ -18,6 +18,14 @@ this.#http = SDK.utilities.httpClient({
 `rateLimiter` types: `{ type: "rolling", count, ms }` (N requests per window) and
 `{ type: "concurrent", count }` (N in flight). Set them from the API's documented limits.
 
+Thrown error messages have the values of sensitive keys (`password`, `api_key`, `client_secret`,
+`token`, ...) replaced with `***` in the URL, the request body and the response text; keys match
+case-insensitively and ignore `_`/`-`. Pass `redactKeys: { url?: string[], body?: string[] }` to
+replace either default set (`SDK.defaultRedactKeys`), e.g.
+`redactKeys: { body: [...SDK.defaultRedactKeys.body, "ssn"] }`. `SDK.utilities.redact()` gives the
+same `redactUrl` / `redactJSON` / `redactText` helpers for anything the connector logs itself.
+`err.responseBodyString` is never redacted, so parse the raw response from there.
+
 When a window limiter alone is not enough (some APIs also punish burst concurrency), compose
 two limiters:
 

package/module.d.ts

@@ -2,8 +2,8 @@
  * Connector SDK (SDK) is a fusion of elements from the script API and
  * SDK specific elements that would be of no interest to users of the API.
  */
-export { EventScriptComplete } from "@syncmatters/script-api";
-export type { Cache, FileProvider, HttpRequest, HttpClientOptions, KvCollection, KvIterator, Logger, EventContext, TestResult, Row, ObjectMeta, ObjectField, ObjectFieldOption, RateLimiterOptions, ScriptType, JsonValuePath, JsonValuePathPart, QueryMatchFilter, QueryCheckpointFilter, EventTypeMeta, ObjectIndex, ObjectMetaUpsert, ObjectRowFilter, ObjectRelationship, ObjectFieldConstraints, ObjectSettingMeta, ObjectUnavailableReason, DiscoverResult, DiscoveredObject, MetaState, MetaStateObject, UpsertIssue, UpsertFieldOptionMeta, RowMatchRuleType, RowMatchData, RowMatchRuleOrder, SyncSession, SyncOptimalBatchSizeOperation, SyncOptimalBatchSizeBatchType, } from "@syncmatters/script-api";
+export { EventScriptComplete, defaultRedactKeys } from "@syncmatters/script-api";
+export type { Cache, FileProvider, HttpRequest, HttpClientOptions, Redactor, RedactorOptions, KvCollection, KvIterator, Logger, EventContext, TestResult, Row, ObjectMeta, ObjectField, ObjectFieldOption, RateLimiterOptions, ScriptType, JsonValuePath, JsonValuePathPart, QueryMatchFilter, QueryCheckpointFilter, EventTypeMeta, ObjectIndex, ObjectMetaUpsert, ObjectRowFilter, ObjectRelationship, ObjectFieldConstraints, ObjectSettingMeta, ObjectUnavailableReason, DiscoverResult, DiscoveredObject, MetaState, MetaStateObject, UpsertIssue, UpsertFieldOptionMeta, RowMatchRuleType, RowMatchData, RowMatchRuleOrder, SyncSession, SyncOptimalBatchSizeOperation, SyncOptimalBatchSizeBatchType, } from "@syncmatters/script-api";
 export * from "./lib/connector.js";
 export * from "./lib/connector-error.js";
 export { envSet } from "./lib/environment.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@syncmatters/connector-sdk",
-  "version": "1.0.23",
+  "version": "1.0.25",
   "description": "TypeScript type definitions for the SyncMatters connector SDK (types only - connectors execute on the SyncMatters platform)",
   "types": "./index.d.ts",
   "exports": {
@@ -12,9 +12,9 @@
   "license": "MIT",
   "author": "SyncMatters",
   "homepage": "https://syncmatters.com",
-  "typesContentHash": "e95f9d6b630e71d88bbe6141c111d148e0024e2e77b094d06f9874fc8de4a89f",
+  "typesContentHash": "5ea245d19c1ae9cf77813b006dc086f8af3da239b45a765793beec7b482770f3",
   "dependencies": {
     "@types/node": "*",
-    "@syncmatters/script-api": "^1.0.25"
+    "@syncmatters/script-api": "^1.0.28"
   }
 }