@syncmatters/connector-sdk 1.0.27 → 1.0.29

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

@@ -83,7 +83,7 @@ await this.#core.init(args);
 | Field                                                                   | Meaning                                                                                                                                                                   |
 | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `categories`                                                            | discovery taxonomy, e.g. `["sales"]`, `["file"]`, `["marketing","sales"]`                                                                                                 |
-| `agent_mode`                                                            | `"never"` = runs in cloud · `"always"` = runs on the customer's on-premise agent · `"optional"` = per-connection (agent used when the connection selects one)             |
+| `agent_mode`                                                            | `"never"` = runs in cloud · `"always"` = runs on the customer's on-premise agent. Nothing else is accepted; for both editions publish two derived connectors |
 | `oauth2_mode`                                                           | `"connector"` = one shared OAuth app for every account · `"connection"` = each connection supplies its own client id/secret. Omit for non-OAuth connectors.               |
 | `oauth2_provider`                                                       | the OAuth provider definition (below)                                                                                                                                     |
 | `webhooks_provider`                                                     | `{"mode": "custom.perconnection"}` (each connection registers its own webhook) or `{"mode": "custom.perconnector", "url": ..., "webhook_uid": ...}` (one shared endpoint) |
@@ -116,7 +116,8 @@ Per-setting fields: `order` (two-digit string, display order), `name`, `type` (`
 `boolean`), `control` (`singlelinetext` | `textarea` | `select` | `timezone`), `secret: true` (masked + encrypted),
 `advanced: true` (collapsed by default), `hidden: true`, `readonly: true`, `placeholder`,
 `options` (for `select` only — not used for `timezone`), `default: { "type": "string", "expression": "<value>" }`, and
-`defines_version: true` on the setting whose value picks a version core.
+`defines_version: true` on the setting whose value picks a version core. For a `secret` setting
+the server never returns the default; pushing a sidecar without it keeps the stored value.
 
 A connection setting accepts the same descriptive fields an object setting does — they were
 always stored, they were simply never written down here:
@@ -129,6 +130,7 @@ always stored, they were simply never written down here:
 | `display_if` / `display_if_setting` / `display_if_values`   | conditional rendering (`displayIfHasValue` is the deprecated spelling, still accepted)                                                  |
 | `prerequisite: true`                                        | two-phase connectors only — see below                                                                                                   |
 | `affects_meta: true`                                         | `meta()` reads this setting (a scope, a checkpoint column, an API version), so changing its value marks the connection's cached metadata stale until the next full refresh. Independent of `discovery`; implied by `prerequisite`; no effect on a `metaRefreshDisabled` connector |
+| `connector_managed: true`                                   | the value belongs to the connector, not the connection: the setting's `default` is evaluated on every read and never stored on a connection, and it wins over a value a connection stored before the flag was set (a hidden setting with a `default` is per-connection instead: snapshotted once at creation). Implies `readonly` (the server sets it on save); `hidden` is independent; `mandatory` means a default must exist to publish. Cannot be combined with `defines_version`, `prerequisite` or `staticonly` |
 
 Use `control: "timezone"` for IANA time zone pickers (e.g. fleet `time_zone` setting). The stored
 value is a plain string (`"America/New_York"`, `"UTC"`, …); the UI renders a searchable list of

package/module.d.ts

@@ -3,7 +3,7 @@
  * SDK specific elements that would be of no interest to users of the 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 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, ObjectSemanticType, 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.27",
+  "version": "1.0.29",
   "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": "db63b6774eb68ee27ed9652e84a93d8fb20826235261aa11a047993d16192658",
+  "typesContentHash": "576827d7dfbc5a2f3ab03eb3d88826793cdf7f5165bb8269649390db04919211",
   "dependencies": {
     "@types/node": "*",
-    "@syncmatters/script-api": "^1.0.31"
+    "@syncmatters/script-api": "^1.0.33"
   }
 }