@zapier/zapier-sdk-cli 0.16.9 → 0.17.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 +12 -0
  2. package/README.md +63 -63
  3. package/dist/cli.cjs +6 -3
  4. package/dist/cli.mjs +6 -3
  5. package/dist/index.cjs +5 -2
  6. package/dist/index.d.mts +1 -1
  7. package/dist/index.d.ts +1 -1
  8. package/dist/index.mjs +5 -2
  9. package/dist/package.json +1 -1
  10. package/dist/src/generators/ast-generator.d.ts +1 -1
  11. package/dist/src/generators/ast-generator.js +4 -1
  12. package/dist/src/plugins/generateAppTypes/schemas.d.ts +1 -1
  13. package/dist/tsconfig.tsbuildinfo +1 -1
  14. package/package.json +3 -3
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @zapier/zapier-sdk-cli
2
2
 
3
+ ## 0.17.0
4
+
5
+ ### Minor Changes
6
+
7
+ - c2eab85: Switch numeric IDs to strings.
8
+
9
+ ### Patch Changes
10
+
11
+ - Updated dependencies [c2eab85]
12
+ - @zapier/zapier-sdk@0.18.0
13
+ - @zapier/zapier-sdk-mcp@0.4.6
14
+
3
15
  ## 0.16.9
4
16
 
5
17
  ### Patch Changes
package/README.md CHANGED
@@ -136,13 +136,13 @@ Get the JSON Schema representation of input fields for an action. Returns a JSON
136
136
 
137
137
  **Options:**
138
138
 
139
- | Option | Type | Required | Default | Possible Values | Description |
140
- | --------------------- | -------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
141
- | `<app-key>` | `string` | ✅ | — | — | App key (e.g., 'SlackCLIAPI' or slug like 'github') to get the input schema for |
142
- | `<action-type>` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
143
- | `<action-key>` | `string` | ✅ | — | — | Action key to get the input schema for |
144
- | `--authentication-id` | `string` | ❌ | — | — | Authentication ID to use when fetching the schema. Required if the action needs authentication to determine available fields. |
145
- | `--inputs` | `object` | ❌ | — | — | Current input values that may affect the schema (e.g., when fields depend on other field values) |
139
+ | Option | Type | Required | Default | Possible Values | Description |
140
+ | --------------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
141
+ | `<app-key>` | `string` | ✅ | — | — | App key (e.g., 'SlackCLIAPI' or slug like 'github') to get the input schema for |
142
+ | `<action-type>` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
143
+ | `<action-key>` | `string` | ✅ | — | — | Action key to get the input schema for |
144
+ | `--authentication-id` | `string, number` | ❌ | — | — | Authentication ID to use when fetching the schema. Required if the action needs authentication to determine available fields. |
145
+ | `--inputs` | `object` | ❌ | — | — | Current input values that may affect the schema (e.g., when fields depend on other field values) |
146
146
 
147
147
  **Usage:**
148
148
 
@@ -176,18 +176,18 @@ Get the available choices for a dynamic dropdown input field
176
176
 
177
177
  **Options:**
178
178
 
179
- | Option | Type | Required | Default | Possible Values | Description |
180
- | --------------------- | -------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------ |
181
- | `<app-key>` | `string` | ✅ | — | — | App key (e.g., 'SlackCLIAPI' or slug like 'github') |
182
- | `<action-type>` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
183
- | `<action-key>` | `string` | ✅ | — | — | Action key to execute |
184
- | `<input-field-key>` | `string` | ✅ | — | — | Input field key to get choices for. |
185
- | `--authentication-id` | `string` | ❌ | — | — | Authentication ID to use for this action |
186
- | `--inputs` | `object` | ❌ | — | — | Current input values that may affect available choices |
187
- | `--page` | `number` | ❌ | — | — | Page number for paginated results |
188
- | `--page-size` | `number` | ❌ | — | — | Number of choices per page |
189
- | `--max-items` | `number` | ❌ | — | — | Maximum total items to return across all pages |
190
- | `--cursor` | `string` | ❌ | — | — | Cursor to start from |
179
+ | Option | Type | Required | Default | Possible Values | Description |
180
+ | --------------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------ |
181
+ | `<app-key>` | `string` | ✅ | — | — | App key (e.g., 'SlackCLIAPI' or slug like 'github') |
182
+ | `<action-type>` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
183
+ | `<action-key>` | `string` | ✅ | — | — | Action key to execute |
184
+ | `<input-field-key>` | `string` | ✅ | — | — | Input field key to get choices for. |
185
+ | `--authentication-id` | `string, number` | ❌ | — | — | Authentication ID to use for this action |
186
+ | `--inputs` | `object` | ❌ | — | — | Current input values that may affect available choices |
187
+ | `--page` | `number` | ❌ | — | — | Page number for paginated results |
188
+ | `--page-size` | `number` | ❌ | — | — | Number of choices per page |
189
+ | `--max-items` | `number` | ❌ | — | — | Maximum total items to return across all pages |
190
+ | `--cursor` | `string` | ❌ | — | — | Cursor to start from |
191
191
 
192
192
  **Usage:**
193
193
 
@@ -201,16 +201,16 @@ Get the input fields required for a specific action
201
201
 
202
202
  **Options:**
203
203
 
204
- | Option | Type | Required | Default | Possible Values | Description |
205
- | --------------------- | -------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
206
- | `<app-key>` | `string` | ✅ | — | — | App key (e.g., 'SlackCLIAPI' or slug like 'github') |
207
- | `<action-type>` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
208
- | `<action-key>` | `string` | ✅ | — | — | Action key to execute |
209
- | `--authentication-id` | `string` | ❌ | — | — | Authentication ID to use for this action |
210
- | `--inputs` | `object` | ❌ | — | — | Current input values that may affect available fields |
211
- | `--page-size` | `number` | ❌ | — | — | Number of input fields per page |
212
- | `--max-items` | `number` | ❌ | — | — | Maximum total items to return across all pages |
213
- | `--cursor` | `string` | ❌ | — | — | Cursor to start from |
204
+ | Option | Type | Required | Default | Possible Values | Description |
205
+ | --------------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
206
+ | `<app-key>` | `string` | ✅ | — | — | App key (e.g., 'SlackCLIAPI' or slug like 'github') |
207
+ | `<action-type>` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
208
+ | `<action-key>` | `string` | ✅ | — | — | Action key to execute |
209
+ | `--authentication-id` | `string, number` | ❌ | — | — | Authentication ID to use for this action |
210
+ | `--inputs` | `object` | ❌ | — | — | Current input values that may affect available fields |
211
+ | `--page-size` | `number` | ❌ | — | — | Number of input fields per page |
212
+ | `--max-items` | `number` | ❌ | — | — | Maximum total items to return across all pages |
213
+ | `--cursor` | `string` | ❌ | — | — | Cursor to start from |
214
214
 
215
215
  **Usage:**
216
216
 
@@ -224,16 +224,16 @@ Execute an action with the given inputs
224
224
 
225
225
  **Options:**
226
226
 
227
- | Option | Type | Required | Default | Possible Values | Description |
228
- | --------------------- | -------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | --------------------------------------------------- |
229
- | `<app-key>` | `string` | ✅ | — | — | App key (e.g., 'SlackCLIAPI' or slug like 'github') |
230
- | `<action-type>` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
231
- | `<action-key>` | `string` | ✅ | — | — | Action key to execute |
232
- | `--authentication-id` | `string` | ❌ | — | — | Authentication ID to use for this action |
233
- | `--inputs` | `object` | ❌ | — | — | Input parameters for the action |
234
- | `--page-size` | `number` | ❌ | — | — | Number of results per page |
235
- | `--max-items` | `number` | ❌ | — | — | Maximum total items to return across all pages |
236
- | `--cursor` | `string` | ❌ | — | — | Cursor to start from |
227
+ | Option | Type | Required | Default | Possible Values | Description |
228
+ | --------------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | --------------------------------------------------- |
229
+ | `<app-key>` | `string` | ✅ | — | — | App key (e.g., 'SlackCLIAPI' or slug like 'github') |
230
+ | `<action-type>` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
231
+ | `<action-key>` | `string` | ✅ | — | — | Action key to execute |
232
+ | `--authentication-id` | `string, number` | ❌ | — | — | Authentication ID to use for this action |
233
+ | `--inputs` | `object` | ❌ | — | — | Input parameters for the action |
234
+ | `--page-size` | `number` | ❌ | — | — | Number of results per page |
235
+ | `--max-items` | `number` | ❌ | — | — | Maximum total items to return across all pages |
236
+ | `--cursor` | `string` | ❌ | — | — | Cursor to start from |
237
237
 
238
238
  **Usage:**
239
239
 
@@ -327,9 +327,9 @@ Get a specific authentication by ID
327
327
 
328
328
  **Options:**
329
329
 
330
- | Option | Type | Required | Default | Possible Values | Description |
331
- | --------------------- | -------- | -------- | ------- | --------------- | ----------------------------- |
332
- | `<authentication-id>` | `number` | ✅ | — | — | Authentication ID to retrieve |
330
+ | Option | Type | Required | Default | Possible Values | Description |
331
+ | --------------------- | ---------------- | -------- | ------- | --------------- | ----------------------------- |
332
+ | `<authentication-id>` | `string, number` | ✅ | — | — | Authentication ID to retrieve |
333
333
 
334
334
  **Usage:**
335
335
 
@@ -343,17 +343,17 @@ List available authentications with optional filtering
343
343
 
344
344
  **Options:**
345
345
 
346
- | Option | Type | Required | Default | Possible Values | Description |
347
- | ---------------------- | -------- | -------- | ------- | --------------- | ------------------------------------------------------------------------------ |
348
- | `--app-key` | `string` | ❌ | — | — | App key of authentications to list (e.g., 'SlackCLIAPI' or slug like 'github') |
349
- | `--authentication-ids` | `array` | ❌ | — | — | List of authentication IDs to filter by |
350
- | `--search` | `string` | ❌ | — | — | Search term to filter authentications by title |
351
- | `--title` | `string` | ❌ | — | — | Filter authentications by exact title match |
352
- | `--account-id` | `string` | ❌ | — | — | Filter by account ID |
353
- | `--owner` | `string` | ❌ | — | — | Filter by owner, 'me' for your own authentications or a specific user ID |
354
- | `--page-size` | `number` | ❌ | — | — | Number of authentications per page |
355
- | `--max-items` | `number` | ❌ | — | — | Maximum total items to return across all pages |
356
- | `--cursor` | `string` | ❌ | — | — | Cursor to start from |
346
+ | Option | Type | Required | Default | Possible Values | Description |
347
+ | ---------------------- | ----------------- | -------- | ------- | --------------- | ------------------------------------------------------------------------------ |
348
+ | `--app-key` | `string` | ❌ | — | — | App key of authentications to list (e.g., 'SlackCLIAPI' or slug like 'github') |
349
+ | `--authentication-ids` | `array` | ❌ | — | — | List of authentication IDs to filter by |
350
+ | `--search` | `string` | ❌ | — | — | Search term to filter authentications by title |
351
+ | `--title` | `string` | ❌ | — | — | Filter authentications by exact title match |
352
+ | `--account-id` | `string` | ❌ | — | — | Filter by account ID |
353
+ | `--owner` | `string, literal` | ❌ | — | — | Filter by owner, 'me' for your own authentications or a specific user ID |
354
+ | `--page-size` | `number` | ❌ | — | — | Number of authentications per page |
355
+ | `--max-items` | `number` | ❌ | — | — | Maximum total items to return across all pages |
356
+ | `--cursor` | `string` | ❌ | — | — | Cursor to start from |
357
357
 
358
358
  **Usage:**
359
359
 
@@ -369,16 +369,16 @@ Make authenticated HTTP requests through Zapier's Relay service
369
369
 
370
370
  **Options:**
371
371
 
372
- | Option | Type | Required | Default | Possible Values | Description |
373
- | --------------------------- | -------- | -------- | ------- | ---------------------------------------------------------- | -------------------------------------------------------------------- |
374
- | `<url>` | `string` | ✅ | — | — | The URL to request (will be proxied through Relay) |
375
- | `--method` | `string` | ❌ | — | `GET`, `POST`, `PUT`, `DELETE`, `PATCH`, `HEAD`, `OPTIONS` | HTTP method |
376
- | `--body` | `string` | ❌ | — | — | Request body as a string |
377
- | `--authentication-id` | `number` | ❌ | — | — | Zapier authentication ID to use for the request |
378
- | `--callback-url` | `string` | ❌ | — | — | URL to send async response to (makes request async) |
379
- | `--authentication-template` | `string` | ❌ | — | — | Optional JSON string authentication template to bypass Notary lookup |
380
- | `--headers` | `string` | ❌ | — | — | Request headers |
381
- | `--relay-base-url` | `string` | ❌ | — | — | Base URL for Relay service |
372
+ | Option | Type | Required | Default | Possible Values | Description |
373
+ | --------------------------- | ----------------------- | -------- | ------- | ---------------------------------------------------------- | -------------------------------------------------------------------- |
374
+ | `<url>` | `string` | ✅ | — | — | The URL to request (will be proxied through Relay) |
375
+ | `--method` | `string` | ❌ | — | `GET`, `POST`, `PUT`, `DELETE`, `PATCH`, `HEAD`, `OPTIONS` | HTTP method |
376
+ | `--body` | `string` | ❌ | — | — | Request body as a string |
377
+ | `--authentication-id` | `string, number` | ❌ | — | — | Authentication ID to use for this action |
378
+ | `--callback-url` | `string` | ❌ | — | — | URL to send async response to (makes request async) |
379
+ | `--authentication-template` | `string` | ❌ | — | — | Optional JSON string authentication template to bypass Notary lookup |
380
+ | `--headers` | `record, custom, array` | ❌ | — | — | Request headers |
381
+ | `--relay-base-url` | `string` | ❌ | — | — | Base URL for Relay service |
382
382
 
383
383
  **Usage:**
384
384
 
package/dist/cli.cjs CHANGED
@@ -1649,7 +1649,7 @@ var LoginSchema = zod.z.object({
1649
1649
 
1650
1650
  // package.json
1651
1651
  var package_default = {
1652
- version: "0.16.9"};
1652
+ version: "0.17.0"};
1653
1653
 
1654
1654
  // src/telemetry/builders.ts
1655
1655
  function createCliBaseEvent(context = {}) {
@@ -2520,7 +2520,10 @@ Usage:
2520
2520
  void 0,
2521
2521
  "authenticationId",
2522
2522
  void 0,
2523
- this.factory.createKeywordTypeNode(ts__namespace.SyntaxKind.NumberKeyword)
2523
+ this.factory.createUnionTypeNode([
2524
+ this.factory.createKeywordTypeNode(ts__namespace.SyntaxKind.StringKeyword),
2525
+ this.factory.createKeywordTypeNode(ts__namespace.SyntaxKind.NumberKeyword)
2526
+ ])
2524
2527
  )
2525
2528
  ])
2526
2529
  )
@@ -2928,7 +2931,7 @@ function createZapierCliSdk(options = {}) {
2928
2931
  // package.json with { type: 'json' }
2929
2932
  var package_default2 = {
2930
2933
  name: "@zapier/zapier-sdk-cli",
2931
- version: "0.16.9"};
2934
+ version: "0.17.0"};
2932
2935
  function detectPackageManager(cwd = process.cwd()) {
2933
2936
  const ua = process.env.npm_config_user_agent;
2934
2937
  if (ua) {
package/dist/cli.mjs CHANGED
@@ -1613,7 +1613,7 @@ var LoginSchema = z.object({
1613
1613
 
1614
1614
  // package.json
1615
1615
  var package_default = {
1616
- version: "0.16.9"};
1616
+ version: "0.17.0"};
1617
1617
 
1618
1618
  // src/telemetry/builders.ts
1619
1619
  function createCliBaseEvent(context = {}) {
@@ -2484,7 +2484,10 @@ Usage:
2484
2484
  void 0,
2485
2485
  "authenticationId",
2486
2486
  void 0,
2487
- this.factory.createKeywordTypeNode(ts.SyntaxKind.NumberKeyword)
2487
+ this.factory.createUnionTypeNode([
2488
+ this.factory.createKeywordTypeNode(ts.SyntaxKind.StringKeyword),
2489
+ this.factory.createKeywordTypeNode(ts.SyntaxKind.NumberKeyword)
2490
+ ])
2488
2491
  )
2489
2492
  ])
2490
2493
  )
@@ -2892,7 +2895,7 @@ function createZapierCliSdk(options = {}) {
2892
2895
  // package.json with { type: 'json' }
2893
2896
  var package_default2 = {
2894
2897
  name: "@zapier/zapier-sdk-cli",
2895
- version: "0.16.9"};
2898
+ version: "0.17.0"};
2896
2899
  function detectPackageManager(cwd = process.cwd()) {
2897
2900
  const ua = process.env.npm_config_user_agent;
2898
2901
  if (ua) {
package/dist/index.cjs CHANGED
@@ -295,7 +295,7 @@ var LoginSchema = zod.z.object({
295
295
 
296
296
  // package.json
297
297
  var package_default = {
298
- version: "0.16.9"};
298
+ version: "0.17.0"};
299
299
 
300
300
  // src/telemetry/builders.ts
301
301
  function createCliBaseEvent(context = {}) {
@@ -1166,7 +1166,10 @@ Usage:
1166
1166
  void 0,
1167
1167
  "authenticationId",
1168
1168
  void 0,
1169
- this.factory.createKeywordTypeNode(ts__namespace.SyntaxKind.NumberKeyword)
1169
+ this.factory.createUnionTypeNode([
1170
+ this.factory.createKeywordTypeNode(ts__namespace.SyntaxKind.StringKeyword),
1171
+ this.factory.createKeywordTypeNode(ts__namespace.SyntaxKind.NumberKeyword)
1172
+ ])
1170
1173
  )
1171
1174
  ])
1172
1175
  )
package/dist/index.d.mts CHANGED
@@ -86,7 +86,7 @@ type AppTypesProgressEvent = {
86
86
  } | {
87
87
  type: "authentication_matched";
88
88
  appKey: string;
89
- authenticationId: number;
89
+ authenticationId: string;
90
90
  authenticationTitle: string;
91
91
  } | {
92
92
  type: "authentication_not_matched";
package/dist/index.d.ts CHANGED
@@ -86,7 +86,7 @@ type AppTypesProgressEvent = {
86
86
  } | {
87
87
  type: "authentication_matched";
88
88
  appKey: string;
89
- authenticationId: number;
89
+ authenticationId: string;
90
90
  authenticationTitle: string;
91
91
  } | {
92
92
  type: "authentication_not_matched";
package/dist/index.mjs CHANGED
@@ -264,7 +264,7 @@ var LoginSchema = z.object({
264
264
 
265
265
  // package.json
266
266
  var package_default = {
267
- version: "0.16.9"};
267
+ version: "0.17.0"};
268
268
 
269
269
  // src/telemetry/builders.ts
270
270
  function createCliBaseEvent(context = {}) {
@@ -1135,7 +1135,10 @@ Usage:
1135
1135
  void 0,
1136
1136
  "authenticationId",
1137
1137
  void 0,
1138
- this.factory.createKeywordTypeNode(ts.SyntaxKind.NumberKeyword)
1138
+ this.factory.createUnionTypeNode([
1139
+ this.factory.createKeywordTypeNode(ts.SyntaxKind.StringKeyword),
1140
+ this.factory.createKeywordTypeNode(ts.SyntaxKind.NumberKeyword)
1141
+ ])
1139
1142
  )
1140
1143
  ])
1141
1144
  )
package/dist/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zapier/zapier-sdk-cli",
3
- "version": "0.16.9",
3
+ "version": "0.17.0",
4
4
  "description": "Command line interface for Zapier SDK",
5
5
  "main": "dist/index.cjs",
6
6
  "module": "dist/index.mjs",
package/dist/src/generators/ast-generator.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  import type { GetSdkType, ListActionsPluginProvides, ListInputFieldsPluginProvides, ManifestPluginProvides, AppItem } from "@zapier/zapier-sdk";
2
2
  interface GenerateTypesOptions {
3
3
  app: AppItem;
4
- authenticationId?: number;
4
+ authenticationId?: string | number;
5
5
  }
6
6
  /**
7
7
  * AST-based TypeScript type generator using the TypeScript Compiler API
package/dist/src/generators/ast-generator.js CHANGED
@@ -263,7 +263,10 @@ Usage:
263
263
  createAppFactoryInterface(appName) {
264
264
  const callSignature = this.factory.createCallSignature(undefined, [
265
265
  this.factory.createParameterDeclaration(undefined, undefined, "options", undefined, this.factory.createTypeLiteralNode([
266
- this.factory.createPropertySignature(undefined, "authenticationId", undefined, this.factory.createKeywordTypeNode(ts.SyntaxKind.NumberKeyword)),
266
+ this.factory.createPropertySignature(undefined, "authenticationId", undefined, this.factory.createUnionTypeNode([
267
+ this.factory.createKeywordTypeNode(ts.SyntaxKind.StringKeyword),
268
+ this.factory.createKeywordTypeNode(ts.SyntaxKind.NumberKeyword),
269
+ ])),
267
270
  ])),
268
271
  ], this.factory.createTypeReferenceNode(`${appName}AppProxy`));
269
272
  return this.factory.createInterfaceDeclaration(undefined, `${appName}AppFactory`, undefined, undefined, [callSignature]);
package/dist/src/plugins/generateAppTypes/schemas.d.ts CHANGED
@@ -31,7 +31,7 @@ export type AppTypesProgressEvent = {
31
31
  } | {
32
32
  type: "authentication_matched";
33
33
  appKey: string;
34
- authenticationId: number;
34
+ authenticationId: string;
35
35
  authenticationTitle: string;
36
36
  } | {
37
37
  type: "authentication_not_matched";