@syncmatters/script-api 1.0.11 → 1.0.13

package/docs/01-workspace-layout.md

@@ -24,9 +24,9 @@ AGENTS.md           # CLI-generated agent guide (managed block + your notes belo
 | `groups/**/group.config.json` | **No** | **No** |
 | `types/**`, `.sm/`, `package.json`, `jsconfig.json` | **No** | **No** |
 
-Sync and sync-group **configuration** (mappings, schedules, which module is attached) is changed
-in the **web UI** today. The CLI exports snapshots for **read-only context** so agents know what
-is deployed; a future `sm sync …` push workflow is not available yet.
+Sync and sync-group **configuration** is authored in `changes/*.sync-changes.json` and published
+with `sm sync push` after a human reviews `sm sync draft`. Snapshots under `syncs/` and `groups/`
+are **read-only context** — never hand-edit or `sm push` them. Schedules still start in the web UI.
 
 Generated sync/group files include a marker:
 

package/docs/05-reading-sync-snapshots.md

@@ -31,8 +31,8 @@ Each file starts with:
 - Do **not** hand-edit snapshots to change mappings, schedules, or wiring.
 - Do **not** `sm push` snapshot paths — there is no push route for them today.
 - Do **not** treat snapshots as the source of truth for writes. Author mapping changes in
-  `changes/*.sync-changes.json`, preview with `sm sync draft <file>`, then stop — there is no
-  `sm sync push` yet. The web UI still owns applying configuration.
+  `changes/*.sync-changes.json`, preview with `sm sync draft <file>`, then `sm sync push <file>`
+  only when the human has instructed it. Snapshots stay generated.
 
 ## Preview drafts (`sm sync draft`)
 

package/docs/06-cli-workflow-and-tokens.md

@@ -13,7 +13,8 @@ sm pull sync               # optional: refresh sync/group snapshots only
 
 - **Scripts only:** `sm push` uploads changed files under `files/` (and meta sidecars). It does
   **not** upload `syncs/` or `groups/`.
-- **Sync config changes:** web UI (future CLI sync push out of scope).
+- **Sync config changes:** `changes/*.sync-changes.json` → `sm sync draft` → human review →
+  `sm sync push` (needs `syncs:write`). Agents push only on human instruction.
 - **Reading snapshots:** use `syncs/` and `groups/` for context before editing the wired module
   in `files/`.
 
@@ -31,6 +32,7 @@ Prefer tokens **without execute scopes** for day-to-day edit/push work:
 | `scripts:read` | pull, diff incoming |
 | `scripts:write` | push script files |
 | `syncs:read` | `sm pull sync`, sync snapshots, `sm sync draft` |
+| `syncs:write` | `sm sync push` / `applysyncops` (human-approved publish) |
 | `connections:read` | `sm types`, connection resolution |
 | `scripts:execute` | **Only when running** `sm test` / connector features |
 | `syncs:execute` | Reserved; not needed for authoring |

package/lib/connection.d.ts

@@ -1,7 +1,7 @@
 import API from "../index.js";
 import { CodedError } from "./coded-error.js";
 import { FileProvider } from "./utilities/file-provider/file-provider.js";
-import { SyncEndpoint, SyncSession } from "./sync.js";
+import { SyncEndpoint } from "./sync.js";
 export interface Connection {
     /** org unique connection id */
     readonly id: string;
@@ -64,10 +64,10 @@ export interface Connection {
         objectIds?: string[];
     }): Promise<void>;
     /**
-     * Requests the connection prepares for a session that will interact with sync(s)
-     * @param options session specification.
+     * Constructs an endpoint through which sync(s) can interact with this connection.
+     * The endpoint has no active session until {@link SyncEndpoint.sessionBegin} is called.
      */
-    syncSession?(options: SyncSession): Promise<SyncEndpoint>;
+    syncEndpoint?(): Promise<SyncEndpoint>;
 }
 export interface Cache {
     count: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@syncmatters/script-api",
-  "version": "1.0.11",
+  "version": "1.0.13",
   "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": "6074e4b68cb636902e4d5a8962e71228571bd13fe17b0d186f35714addbd126e",
+  "typesContentHash": "5cb475fa1240d9fa9964086b867786e024b3d3b555313717aafd586bbec05675",
   "dependencies": {
     "@types/node": "*"
   }