@zapier/zapier-sdk 0.82.1 → 0.83.0

package/AGENTS.md

@@ -34,7 +34,7 @@ The easiest approach for local development. Run `npx zapier-sdk login` once, and
 const zapier = createZapierSdk();
 ```
 
-The CLI stores tokens in `~/.zapier-sdk/config.json`. The SDK checks for this file when no credentials are provided.
+The CLI stores tokens in the OS keychain by default (with a config-file fallback). Non-secret login metadata lives in a config file managed by the `conf` library at a platform-specific path (run `npx zapier-sdk get-login-config-path` to see it). The SDK reads this login automatically when no credentials are provided.
 
 ### Production: Token String
 

package/CHANGELOG.md

@@ -1,5 +1,45 @@
 # @zapier/zapier-sdk
 
+## 0.83.0
+
+### Minor Changes
+
+- 5f5f028: `createZapierSdk(options)` is unchanged in usage; the SDK is now built
+  entirely on the module plugin system internally.
+  - Deprecated SDK methods now log a runtime warning when called (once per
+    process).
+  - New: `disposeSdk(sdk)` releases the SDK's resources (telemetry timers,
+    event listeners) — call it when you're done with an SDK in a long-lived
+    process.
+  - New for plugin authors: `zapierSdkPlugin` (the SDK's root plugin),
+    `PluginSurface<typeof plugin>` (derive a plugin's surface type instead of
+    hand-writing it), `resolvePlugin`, `declareOptionalProperty`,
+    `SDK_OPTIONS_ID` / `sdkOptionsPluginRef`, explicit `MethodPlugin` /
+    `PropertyPlugin` / `AggregatePlugin` descriptor types, the
+    `PluginSummary` / `LeafSummary` ledger types and `EventTransport` (so a
+    package exporting plugins can emit their inferred types in declarations),
+    and `createController` with its `Controller*` types.
+
+  Changed: `getConnection` now requires a connection locator — `connection`
+  (or a deprecated `connectionId` / `authenticationId` alias) must be
+  provided. It was previously optional in the type, with nothing sensible to
+  fetch when omitted.
+
+  Removed without a deprecation cycle (pre-1.0 break):
+  - `createZapierSdkStack`, `createOptionsPlugin`, `createZapierCoreStack` —
+    use `createZapierSdk(options)`, or compose module plugins with `createSdk`.
+  - `dangerousContextPlugin` — import the specific plugin ref you need
+    (`apiPluginRef`, `sdkOptionsPluginRef`, ...), or use `resolvePlugin` on a
+    built sdk.
+  - The `authenticationIdResolver` / `authenticationIdGenericResolver` aliases —
+    use `connectionIdResolver` / `connectionIdGenericResolver`.
+
+  Changed: the exported resolvers (`appKeyResolver`, `connectionIdResolver`,
+  `inputsResolver`, ...) are now model resolvers — bag-form callbacks whose
+  imports bind at build — instead of objects with `fetch(sdk, params)`
+  callbacks. Attach them through a `defineMethod`'s `resolvers` map; they no
+  longer work on a legacy function plugin's `meta.resolvers`.
+
 ## 0.82.1
 
 ### Patch Changes

package/README.md

@@ -1034,7 +1034,7 @@ Create new client credentials for the authenticated user
 **Example:**
 
 ```typescript
-const result = await zapier.createClientCredentials({
+const { data: clientCredentials } = await zapier.createClientCredentials({
   name: "example-name",
 });
 ```
@@ -1129,7 +1129,7 @@ Cancel a run-once durable run in initialized or started status. Returns 409 if t
 **Example:**
 
 ```typescript
-const result = await zapier.cancelDurableRun({
+const { data: durableRun } = await zapier.cancelDurableRun({
   run: "example-run",
 });
 ```
@@ -1164,7 +1164,7 @@ Create a durable workflow container. Starts disabled with no version; publish a
 **Example:**
 
 ```typescript
-const result = await zapier.createWorkflow({
+const { data: workflow } = await zapier.createWorkflow({
   name: "example-name",
 });
 ```
@@ -1217,7 +1217,7 @@ Disable a durable workflow so it stops accepting triggers
 **Example:**
 
 ```typescript
-const result = await zapier.disableWorkflow({
+const { data: workflow } = await zapier.disableWorkflow({
   workflow: "example-workflow",
 });
 ```
@@ -1244,7 +1244,7 @@ Enable a durable workflow so it accepts triggers
 **Example:**
 
 ```typescript
-const result = await zapier.enableWorkflow({
+const { data: workflow } = await zapier.enableWorkflow({
   workflow: "example-workflow",
 });
 ```
@@ -1696,7 +1696,7 @@ Publish a new version of a durable workflow. Enables the workflow by default.
 **Example:**
 
 ```typescript
-const result = await zapier.publishWorkflowVersion({
+const { data: workflowVersion } = await zapier.publishWorkflowVersion({
   workflow: "example-workflow",
   sourceFiles: {},
 });
@@ -1737,7 +1737,7 @@ Run a workflow source file as a run-once durable run on sdkdurableapi (no deploy
 **Example:**
 
 ```typescript
-const result = await zapier.runDurable({
+const { data: durableRun } = await zapier.runDurable({
   sourceFiles: {},
 });
 ```
@@ -1766,7 +1766,7 @@ Look up a workflow's trigger URL and fire it manually, as the authenticated acco
 **Example:**
 
 ```typescript
-const result = await zapier.triggerWorkflow({
+const { data: workflowRun } = await zapier.triggerWorkflow({
   workflow: "example-workflow",
 });
 ```
@@ -1802,7 +1802,7 @@ Update a durable workflow's name and/or description
 **Example:**
 
 ```typescript
-const result = await zapier.updateWorkflow({
+const { data: workflow } = await zapier.updateWorkflow({
   workflow: "example-workflow",
 });
 ```
@@ -1837,7 +1837,7 @@ This is the right command for most callers. Reach for the lower-level building b
 **Example:**
 
 ```typescript
-const result = await zapier.createConnection({
+const { data: connection } = await zapier.createConnection({
   app: "example-app",
 });
 ```
@@ -1956,14 +1956,14 @@ const { data: connection } = await zapier.findUniqueConnection();
 
 #### `getConnection`
 
-Execute getConnection
+Get details for a specific connection
 
 **Parameters:**
 
 | Name             | Type             | Required | Default | Possible Values | Description                                                                                                                                                                                     |
 | ---------------- | ---------------- | -------- | ------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `options`        | `object`         | ✅       | —       | —               |                                                                                                                                                                                                 |
-| ​ ↳ `connection` | `string, number` | ❌       | —       | —               | Connection alias or connection ID (UUID or positive integer). Strings that match a key in the connections map are resolved against it; otherwise the value is used as a connection ID directly. |
+| ​ ↳ `connection` | `string, number` | ✅       | —       | —               | Connection alias or connection ID (UUID or positive integer). Strings that match a key in the connections map are resolved against it; otherwise the value is used as a connection ID directly. |
 
 **Returns:** `Promise<ConnectionItem>`
 
@@ -2001,7 +2001,9 @@ Execute getConnection
 **Example:**
 
 ```typescript
-const { data: connection } = await zapier.getConnection();
+const { data: connection } = await zapier.getConnection({
+  connection: "example-connection",
+});
 ```
 
 #### `getConnectionStartUrl`
@@ -2040,7 +2042,7 @@ const { data: conn } = await zapier.waitForNewConnection({ app, startedAt });
 **Example:**
 
 ```typescript
-const result = await zapier.getConnectionStartUrl({
+const { data: connectionStartUrl } = await zapier.getConnectionStartUrl({
   app: "example-app",
 });
 ```
@@ -2216,7 +2218,7 @@ Create a new table
 **Example:**
 
 ```typescript
-const result = await zapier.createTable({
+const { data: table } = await zapier.createTable({
   name: "example-name",
 });
 ```
@@ -2254,7 +2256,7 @@ Create one or more fields in a table
 **Example:**
 
 ```typescript
-const result = await zapier.createTableFields({
+const { data: fields } = await zapier.createTableFields({
   table: "example-table",
   fields: [
     {
@@ -2293,7 +2295,7 @@ Create one or more records in a table
 **Example:**
 
 ```typescript
-const result = await zapier.createTableRecords({
+const { data: records } = await zapier.createTableRecords({
   table: "example-table",
   records: [
     {
@@ -2630,7 +2632,7 @@ Update one or more records in a table
 **Example:**
 
 ```typescript
-const result = await zapier.updateTableRecords({
+const { data: records } = await zapier.updateTableRecords({
   table: "example-table",
   records: [
     {
@@ -2674,7 +2676,7 @@ Acknowledge messages from a lease. Acked messages are removed from the inbox; un
 **Example:**
 
 ```typescript
-const result = await zapier.ackTriggerInboxMessages({
+const { data: triggerInboxAck } = await zapier.ackTriggerInboxMessages({
   inbox: "example-inbox",
   lease: "example-lease",
 });
@@ -2717,7 +2719,7 @@ Create a new trigger inbox subscription. Always creates a new inbox; use ensureT
 **Example:**
 
 ```typescript
-const result = await zapier.createTriggerInbox({
+const { data: triggerInbox } = await zapier.createTriggerInbox({
   app: "example-app",
   action: "example-action",
 });
@@ -2785,7 +2787,7 @@ Drain an existing trigger inbox: lease currently-available messages, process eac
 **Example:**
 
 ```typescript
-const result = await zapier.drainTriggerInbox({
+await zapier.drainTriggerInbox({
   inbox: "example-inbox",
   onMessage: async (message) => {
     /* process message */
@@ -2830,7 +2832,7 @@ Get-or-create a trigger inbox by key. Idempotent on (user, account, key): return
 **Example:**
 
 ```typescript
-const result = await zapier.ensureTriggerInbox({
+const { data: triggerInbox } = await zapier.ensureTriggerInbox({
   key: "example-key",
   app: "example-app",
   action: "example-action",
@@ -2936,7 +2938,7 @@ Lease up to N messages from a trigger inbox. Returns messages plus a lease ID; a
 **Example:**
 
 ```typescript
-const result = await zapier.leaseTriggerInboxMessages({
+const { data: triggerInboxLease } = await zapier.leaseTriggerInboxMessages({
   inbox: "example-inbox",
 });
 ```
@@ -3284,7 +3286,7 @@ Pause a trigger inbox; events stop being collected
 **Example:**
 
 ```typescript
-const result = await zapier.pauseTriggerInbox({
+const { data: triggerInbox } = await zapier.pauseTriggerInbox({
   inbox: "example-inbox",
 });
 ```
@@ -3320,7 +3322,7 @@ Release messages from a lease back to the inbox without acknowledging them. Rele
 **Example:**
 
 ```typescript
-const result = await zapier.releaseTriggerInboxMessages({
+const { data: triggerInboxRelease } = await zapier.releaseTriggerInboxMessages({
   inbox: "example-inbox",
   lease: "example-lease",
 });
@@ -3358,7 +3360,7 @@ Resume a paused trigger inbox; events resume being collected
 **Example:**
 
 ```typescript
-const result = await zapier.resumeTriggerInbox({
+const { data: triggerInbox } = await zapier.resumeTriggerInbox({
   inbox: "example-inbox",
 });
 ```
@@ -3396,7 +3398,7 @@ Update settings on an existing trigger inbox
 **Example:**
 
 ```typescript
-const result = await zapier.updateTriggerInbox({
+const { data: triggerInbox } = await zapier.updateTriggerInbox({
   inbox: "example-inbox",
 });
 ```
@@ -3426,7 +3428,7 @@ Continuously consume a trigger inbox: drain currently-available messages via onM
 **Example:**
 
 ```typescript
-const result = await zapier.watchTriggerInbox({
+await zapier.watchTriggerInbox({
   inbox: "example-inbox",
   onMessage: async (message) => {
     /* process message */