@zapier/zapier-sdk-cli 0.84.6 → 0.85.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (14) hide show
  1. package/CHANGELOG.md +27 -0
  2. package/README.md +17 -3
  3. package/bin/zapier-sdk-experimental.mjs +8 -0
  4. package/dist/cli.cjs +297 -150
  5. package/dist/cli.mjs +305 -158
  6. package/dist/experimental.cjs +37 -18
  7. package/dist/experimental.d.mts +9 -7
  8. package/dist/experimental.d.ts +9 -7
  9. package/dist/experimental.mjs +38 -19
  10. package/dist/index.cjs +106 -83
  11. package/dist/index.d.mts +2 -1
  12. package/dist/index.d.ts +2 -1
  13. package/dist/index.mjs +106 -83
  14. package/package.json +4 -4
package/CHANGELOG.md CHANGED
@@ -1,5 +1,32 @@
1
1
  # @zapier/zapier-sdk-cli
2
2
 
3
+ ## 0.85.0
4
+
5
+ ### Minor Changes
6
+
7
+ - 1c1a95d: Added `--stability <level>` to choose which stability tier of the CLI surface to use — `stable` (the default), `beta`, or `experimental`. `ZAPIER_STABILITY=<level>` sets the same thing from the environment, and the flag wins when both are given. An unrecognized level exits `1` and lists the valid ones rather than silently falling back to stable.
8
+
9
+ Deprecated the three spellings this replaces. All still work, and each now prints a deprecation notice on stderr naming its replacement:
10
+
11
+ | Deprecated | Use instead |
12
+ | ------------------------- | ------------------------------------- |
13
+ | `--experimental` | `--stability experimental` |
14
+ | `ZAPIER_EXPERIMENTAL=1` | `ZAPIER_STABILITY=experimental` |
15
+ | `zapier-sdk-experimental` | `zapier-sdk --stability experimental` |
16
+
17
+ `--help` now labels every non-stable command with its tier (`create-workflow (experimental)`), and running one prints a one-time notice on stderr quoting the tier's contract before the command's own output. Both follow the tier a command was declared at, not the tier you opted into, so a beta command reached through `--stability experimental` still reads `(beta)`.
18
+
19
+ The beta tier ships empty, so `--stability beta` currently lists exactly the stable commands.
20
+
21
+ ### Patch Changes
22
+
23
+ - Updated dependencies [1c1a95d]
24
+ - Updated dependencies [1c1a95d]
25
+ - Updated dependencies [1c1a95d]
26
+ - @zapier/zapier-sdk-mcp@0.26.0
27
+ - @zapier/zapier-sdk@0.113.0
28
+ - @zapier/kitcore@0.21.2
29
+
3
30
  ## 0.84.6
4
31
 
5
32
  ### Patch Changes
package/README.md CHANGED
@@ -2,6 +2,7 @@
2
2
 
3
3
  ## Table of Contents
4
4
 
5
+ - [Stability](#stability)
5
6
  - [Quick Start](#quick-start)
6
7
  - [Installation](#installation)
7
8
  - [Walkthrough](#walkthrough)
@@ -126,6 +127,18 @@
126
127
  - [`stat-vfs-path`](#stat-vfs-path--experimental)
127
128
  - [`write-vfs-file`](#write-vfs-file--experimental)
128
129
 
130
+ ## Stability
131
+
132
+ Every command belongs to one of three stability tiers. Stable commands are available by default; opt into wider tiers with `--stability beta` / `--stability experimental`, or `ZAPIER_STABILITY=<level>` in the environment.
133
+
134
+ | Tier | Contract |
135
+ | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
136
+ | **Stable** | The surface we intend to keep. While the SDK is in Open Beta (0.x), a breaking change can still land in a minor release; we deprecate first where we can, and every one is called out in the changelog with a migration note. |
137
+ | **Beta** | Functionally complete and ready to build against, but the shape may still change as it settles. Changes land in minor releases with a changelog migration note, without a deprecation period. |
138
+ | **Experimental** | Still being designed; may change shape or disappear in any release, without notice. |
139
+
140
+ Non-stable commands are labeled in `--help` and print a `⚠️ BETA COMMAND` / `⚠️ EXPERIMENTAL COMMAND` notice when they run.
141
+
129
142
  ## Quick Start
130
143
 
131
144
  _For new projects._
@@ -197,6 +210,7 @@ These options are available for all commands:
197
210
  | --------------------------------------------- | ----- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
198
211
  | `--version` | `-V` | Display version number |
199
212
  | `--help` | `-h` | Display help for command |
213
+ | `--stability <level>` | | Which stability tier of the SDK / CLI surface to use: stable, beta, experimental. Can also be set with the ZAPIER_STABILITY environment variable (default: stable). |
200
214
  | `--credentials <token>` | | Authentication token. |
201
215
  | `--credentials-client-id <id>` | | OAuth client ID for authentication. |
202
216
  | `--credentials-client-secret <secret>` | | OAuth client secret for authentication. |
@@ -550,7 +564,7 @@ npx zapier-sdk list-client-credentials [--page-size] [--max-items] [--cursor]
550
564
 
551
565
  ### Code Workflows (Experimental)
552
566
 
553
- > ℹ️ **Experimental.** Run commands via the `zapier-sdk-experimental` binary, pass `--experimental` to `zapier-sdk`, or set `ZAPIER_EXPERIMENTAL=true` in the environment. Flags and behavior may change between versions.
567
+ > ℹ️ **Experimental.** Still being designed; may change shape or disappear in any release, without notice. Pass `--stability experimental` to `zapier-sdk`, or set `ZAPIER_STABILITY=experimental` in the environment, to use these commands.
554
568
 
555
569
  #### `cancel-durable-run` 🧪 _experimental_
556
570
 
@@ -1362,7 +1376,7 @@ npx zapier-sdk curl <url> [--request] [--header] [--data] [--data-raw] [--data-a
1362
1376
 
1363
1377
  ### Human Inputs (Experimental)
1364
1378
 
1365
- > ℹ️ **Experimental.** Run commands via the `zapier-sdk-experimental` binary, pass `--experimental` to `zapier-sdk`, or set `ZAPIER_EXPERIMENTAL=true` in the environment. Flags and behavior may change between versions.
1379
+ > ℹ️ **Experimental.** Still being designed; may change shape or disappear in any release, without notice. Pass `--stability experimental` to `zapier-sdk`, or set `ZAPIER_STABILITY=experimental` in the environment, to use these commands.
1366
1380
 
1367
1381
  #### `create-form` 🧪 _experimental_
1368
1382
 
@@ -2097,7 +2111,7 @@ npx zapier-sdk setup
2097
2111
 
2098
2112
  ### Virtual File System (Experimental)
2099
2113
 
2100
- > ℹ️ **Experimental.** Run commands via the `zapier-sdk-experimental` binary, pass `--experimental` to `zapier-sdk`, or set `ZAPIER_EXPERIMENTAL=true` in the environment. Flags and behavior may change between versions.
2114
+ > ℹ️ **Experimental.** Still being designed; may change shape or disappear in any release, without notice. Pass `--stability experimental` to `zapier-sdk`, or set `ZAPIER_STABILITY=experimental` in the environment, to use these commands.
2101
2115
 
2102
2116
  #### `append-vfs-file` 🧪 _experimental_
2103
2117
 
package/bin/zapier-sdk-experimental.mjs CHANGED
@@ -7,8 +7,16 @@
7
7
  // of argv. Renaming this file later doesn't break detection — the
8
8
  // signal is what we push, not what we're called.
9
9
  //
10
+ // This entry point is deprecated in favour of
11
+ // `zapier-sdk --stability experimental`. Since argv is byte-equivalent,
12
+ // the marker below is the only thing that tells cli.ts to name the bin
13
+ // rather than the flag in its deprecation notice. Keep the string in
14
+ // sync with EXPERIMENTAL_BIN_ENV in src/cli-options.ts (a .mjs shim
15
+ // that runs before the build output cannot import it).
16
+ //
10
17
  // Dynamic import (rather than the static `import "..."` form) is
11
18
  // load-bearing: a static import is hoisted above the argv mutation,
12
19
  // so cli.mjs would see the unmodified argv.
20
+ process.env.ZAPIER_SDK_EXPERIMENTAL_BIN = "1";
13
21
  process.argv.push("--experimental");
14
22
  await import("../dist/cli.mjs");