zapier-platform-cli 18.0.0 → 18.0.1

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.
@@ -2176,9 +2176,9 @@
2176
2176
  "unset.js"
2177
2177
  ]
2178
2178
  },
2179
- "team:add": {
2179
+ "users:add": {
2180
2180
  "aliases": [
2181
- "team:invite"
2181
+ "users:invite"
2182
2182
  ],
2183
2183
  "args": {
2184
2184
  "email": {
@@ -2186,28 +2186,24 @@
2186
2186
  "name": "email",
2187
2187
  "required": true
2188
2188
  },
2189
- "role": {
2190
- "description": "The level the invited team member should be at. Admins can edit everything and get email updates. Collaborators have read-access to the app and get email updates. Subscribers only get email updates.",
2191
- "name": "role",
2192
- "options": [
2193
- "admin",
2194
- "collaborator",
2195
- "subscriber"
2196
- ],
2197
- "required": true
2198
- },
2199
- "message": {
2200
- "description": "A message sent in the email to your team member, if you need to provide context. Wrap the message in quotes to ensure spaces get saved.",
2201
- "name": "message"
2189
+ "version": {
2190
+ "description": "A version string (like 1.2.3). Optional, used only if you want to invite a user to a specific version instead of all versions.",
2191
+ "name": "version"
2202
2192
  }
2203
2193
  },
2204
- "description": "Add a team member to your integration.\n\nThese users come in three levels:\n\n * `admin`, who can edit everything about the integration\n * `collaborator`, who has read-only access for the app, and will receive periodic email updates. These updates include quarterly health scores and more.\n * `subscriber`, who can't directly access the app, but will receive periodic email updates. These updates include quarterly health scores and more.\n\nTeam members can be freely added and removed.",
2194
+ "description": "Add a user to some or all versions of your integration.\n\nWhen this command is run, we'll send an email to the user inviting them to try your integration. You can track the status of that invite using the `zapier users:get` command.\n\nInvited users will be able to see your integration's name, logo, and description. They'll also be able to create Zaps using any available triggers and actions.",
2205
2195
  "examples": [
2206
- "zapier team:add bruce@wayne.com admin",
2207
- "zapier team:add robin@wayne.com collaborator \"Hey Robin, check out this app.\"",
2208
- "zapier team:add alfred@wayne.com subscriber \"Hey Alfred, check out this app.\""
2196
+ "zapier users:add bruce@wayne.com",
2197
+ "zapier users:add alfred@wayne.com 1.2.3"
2209
2198
  ],
2210
2199
  "flags": {
2200
+ "force": {
2201
+ "char": "f",
2202
+ "description": "Skip confirmation. Useful for running programatically.",
2203
+ "name": "force",
2204
+ "allowNo": false,
2205
+ "type": "boolean"
2206
+ },
2211
2207
  "debug": {
2212
2208
  "char": "d",
2213
2209
  "description": "Show extra debugging output.",
@@ -2224,7 +2220,7 @@
2224
2220
  },
2225
2221
  "hasDynamicHelp": false,
2226
2222
  "hiddenAliases": [],
2227
- "id": "team:add",
2223
+ "id": "users:add",
2228
2224
  "pluginAlias": "zapier-platform-cli",
2229
2225
  "pluginName": "zapier-platform-cli",
2230
2226
  "pluginType": "core",
@@ -2236,16 +2232,16 @@
2236
2232
  "src",
2237
2233
  "oclif",
2238
2234
  "commands",
2239
- "team",
2235
+ "users",
2240
2236
  "add.js"
2241
2237
  ]
2242
2238
  },
2243
- "team:get": {
2239
+ "users:get": {
2244
2240
  "aliases": [
2245
- "team:list"
2241
+ "users:list"
2246
2242
  ],
2247
2243
  "args": {},
2248
- "description": "Get team members involved with your integration.\n\nThese users come in three levels:\n\n * `admin`, who can edit everything about the integration\n * `collaborator`, who has read-only access for the app, and will receive periodic email updates. These updates include quarterly health scores and more.\n * `subscriber`, who can't directly access the app, but will receive periodic email updates. These updates include quarterly health scores and more.\n\nUse the `zapier team:add` and `zapier team:remove` commands to modify your team.\n",
2244
+ "description": "Get a list of users who have been invited to your integration.\n\nNote that this list of users is NOT a comprehensive list of everyone who is using your integration. It only includes users who were invited directly by email (using the `\u001b[36mzapier users:add\u001b[39m` command or the web UI). Users who joined by clicking links generated using the `\u001b[36mzapier user:links\u001b[39m` command won't show up here.",
2249
2245
  "flags": {
2250
2246
  "debug": {
2251
2247
  "char": "d",
@@ -2279,7 +2275,7 @@
2279
2275
  },
2280
2276
  "hasDynamicHelp": false,
2281
2277
  "hiddenAliases": [],
2282
- "id": "team:get",
2278
+ "id": "users:get",
2283
2279
  "pluginAlias": "zapier-platform-cli",
2284
2280
  "pluginName": "zapier-platform-cli",
2285
2281
  "pluginType": "core",
@@ -2291,16 +2287,14 @@
2291
2287
  "src",
2292
2288
  "oclif",
2293
2289
  "commands",
2294
- "team",
2290
+ "users",
2295
2291
  "get.js"
2296
2292
  ]
2297
2293
  },
2298
- "team:remove": {
2299
- "aliases": [
2300
- "team:delete"
2301
- ],
2294
+ "users:links": {
2295
+ "aliases": [],
2302
2296
  "args": {},
2303
- "description": "Remove a team member from all versions of your integration.\n\nAdmins will immediately lose write access to the integration.\nCollaborators will immediately lose read access to the integration.\nSubscribers won't receive future email updates.",
2297
+ "description": "Get a list of links that are used to invite users to your integration.",
2304
2298
  "flags": {
2305
2299
  "debug": {
2306
2300
  "char": "d",
@@ -2309,6 +2303,22 @@
2309
2303
  "allowNo": false,
2310
2304
  "type": "boolean"
2311
2305
  },
2306
+ "format": {
2307
+ "char": "f",
2308
+ "description": "Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq.",
2309
+ "name": "format",
2310
+ "default": "table",
2311
+ "hasDynamicHelp": false,
2312
+ "multiple": false,
2313
+ "options": [
2314
+ "plain",
2315
+ "json",
2316
+ "raw",
2317
+ "row",
2318
+ "table"
2319
+ ],
2320
+ "type": "option"
2321
+ },
2312
2322
  "invokedFromAnotherCommand": {
2313
2323
  "hidden": true,
2314
2324
  "name": "invokedFromAnotherCommand",
@@ -2318,7 +2328,7 @@
2318
2328
  },
2319
2329
  "hasDynamicHelp": false,
2320
2330
  "hiddenAliases": [],
2321
- "id": "team:remove",
2331
+ "id": "users:links",
2322
2332
  "pluginAlias": "zapier-platform-cli",
2323
2333
  "pluginName": "zapier-platform-cli",
2324
2334
  "pluginType": "core",
@@ -2330,34 +2340,26 @@
2330
2340
  "src",
2331
2341
  "oclif",
2332
2342
  "commands",
2333
- "team",
2334
- "remove.js"
2343
+ "users",
2344
+ "links.js"
2335
2345
  ]
2336
2346
  },
2337
- "users:add": {
2347
+ "users:remove": {
2338
2348
  "aliases": [
2339
- "users:invite"
2349
+ "users:delete"
2340
2350
  ],
2341
2351
  "args": {
2342
2352
  "email": {
2343
- "description": "The user to be invited. If they don't have a Zapier account, they'll be prompted to create one.",
2353
+ "description": "The user to be removed.",
2344
2354
  "name": "email",
2345
2355
  "required": true
2346
- },
2347
- "version": {
2348
- "description": "A version string (like 1.2.3). Optional, used only if you want to invite a user to a specific version instead of all versions.",
2349
- "name": "version"
2350
2356
  }
2351
2357
  },
2352
- "description": "Add a user to some or all versions of your integration.\n\nWhen this command is run, we'll send an email to the user inviting them to try your integration. You can track the status of that invite using the `zapier users:get` command.\n\nInvited users will be able to see your integration's name, logo, and description. They'll also be able to create Zaps using any available triggers and actions.",
2353
- "examples": [
2354
- "zapier users:add bruce@wayne.com",
2355
- "zapier users:add alfred@wayne.com 1.2.3"
2356
- ],
2358
+ "description": "Remove a user from all versions of your integration.\n\nWhen this command is run, their Zaps will immediately turn off. They won't be able to use your app again until they're re-invited or it has gone public. In practice, this command isn't run often as it's very disruptive to users.",
2357
2359
  "flags": {
2358
2360
  "force": {
2359
2361
  "char": "f",
2360
- "description": "Skip confirmation. Useful for running programatically.",
2362
+ "description": "Skips confirmation. Useful for running programatically.",
2361
2363
  "name": "force",
2362
2364
  "allowNo": false,
2363
2365
  "type": "boolean"
@@ -2378,7 +2380,7 @@
2378
2380
  },
2379
2381
  "hasDynamicHelp": false,
2380
2382
  "hiddenAliases": [],
2381
- "id": "users:add",
2383
+ "id": "users:remove",
2382
2384
  "pluginAlias": "zapier-platform-cli",
2383
2385
  "pluginName": "zapier-platform-cli",
2384
2386
  "pluginType": "core",
@@ -2391,15 +2393,40 @@
2391
2393
  "oclif",
2392
2394
  "commands",
2393
2395
  "users",
2394
- "add.js"
2396
+ "remove.js"
2395
2397
  ]
2396
2398
  },
2397
- "users:get": {
2399
+ "team:add": {
2398
2400
  "aliases": [
2399
- "users:list"
2401
+ "team:invite"
2402
+ ],
2403
+ "args": {
2404
+ "email": {
2405
+ "description": "The user to be invited. If they don't have a Zapier account, they'll be prompted to create one.",
2406
+ "name": "email",
2407
+ "required": true
2408
+ },
2409
+ "role": {
2410
+ "description": "The level the invited team member should be at. Admins can edit everything and get email updates. Collaborators have read-access to the app and get email updates. Subscribers only get email updates.",
2411
+ "name": "role",
2412
+ "options": [
2413
+ "admin",
2414
+ "collaborator",
2415
+ "subscriber"
2416
+ ],
2417
+ "required": true
2418
+ },
2419
+ "message": {
2420
+ "description": "A message sent in the email to your team member, if you need to provide context. Wrap the message in quotes to ensure spaces get saved.",
2421
+ "name": "message"
2422
+ }
2423
+ },
2424
+ "description": "Add a team member to your integration.\n\nThese users come in three levels:\n\n * `admin`, who can edit everything about the integration\n * `collaborator`, who has read-only access for the app, and will receive periodic email updates. These updates include quarterly health scores and more.\n * `subscriber`, who can't directly access the app, but will receive periodic email updates. These updates include quarterly health scores and more.\n\nTeam members can be freely added and removed.",
2425
+ "examples": [
2426
+ "zapier team:add bruce@wayne.com admin",
2427
+ "zapier team:add robin@wayne.com collaborator \"Hey Robin, check out this app.\"",
2428
+ "zapier team:add alfred@wayne.com subscriber \"Hey Alfred, check out this app.\""
2400
2429
  ],
2401
- "args": {},
2402
- "description": "Get a list of users who have been invited to your integration.\n\nNote that this list of users is NOT a comprehensive list of everyone who is using your integration. It only includes users who were invited directly by email (using the `\u001b[36mzapier users:add\u001b[39m` command or the web UI). Users who joined by clicking links generated using the `\u001b[36mzapier user:links\u001b[39m` command won't show up here.",
2403
2430
  "flags": {
2404
2431
  "debug": {
2405
2432
  "char": "d",
@@ -2408,22 +2435,6 @@
2408
2435
  "allowNo": false,
2409
2436
  "type": "boolean"
2410
2437
  },
2411
- "format": {
2412
- "char": "f",
2413
- "description": "Change the way structured data is presented. If \"json\" or \"raw\", you can pipe the output of the command into other tools, such as jq.",
2414
- "name": "format",
2415
- "default": "table",
2416
- "hasDynamicHelp": false,
2417
- "multiple": false,
2418
- "options": [
2419
- "plain",
2420
- "json",
2421
- "raw",
2422
- "row",
2423
- "table"
2424
- ],
2425
- "type": "option"
2426
- },
2427
2438
  "invokedFromAnotherCommand": {
2428
2439
  "hidden": true,
2429
2440
  "name": "invokedFromAnotherCommand",
@@ -2433,7 +2444,7 @@
2433
2444
  },
2434
2445
  "hasDynamicHelp": false,
2435
2446
  "hiddenAliases": [],
2436
- "id": "users:get",
2447
+ "id": "team:add",
2437
2448
  "pluginAlias": "zapier-platform-cli",
2438
2449
  "pluginName": "zapier-platform-cli",
2439
2450
  "pluginType": "core",
@@ -2445,14 +2456,16 @@
2445
2456
  "src",
2446
2457
  "oclif",
2447
2458
  "commands",
2448
- "users",
2449
- "get.js"
2459
+ "team",
2460
+ "add.js"
2450
2461
  ]
2451
2462
  },
2452
- "users:links": {
2453
- "aliases": [],
2463
+ "team:get": {
2464
+ "aliases": [
2465
+ "team:list"
2466
+ ],
2454
2467
  "args": {},
2455
- "description": "Get a list of links that are used to invite users to your integration.",
2468
+ "description": "Get team members involved with your integration.\n\nThese users come in three levels:\n\n * `admin`, who can edit everything about the integration\n * `collaborator`, who has read-only access for the app, and will receive periodic email updates. These updates include quarterly health scores and more.\n * `subscriber`, who can't directly access the app, but will receive periodic email updates. These updates include quarterly health scores and more.\n\nUse the `zapier team:add` and `zapier team:remove` commands to modify your team.\n",
2456
2469
  "flags": {
2457
2470
  "debug": {
2458
2471
  "char": "d",
@@ -2486,7 +2499,7 @@
2486
2499
  },
2487
2500
  "hasDynamicHelp": false,
2488
2501
  "hiddenAliases": [],
2489
- "id": "users:links",
2502
+ "id": "team:get",
2490
2503
  "pluginAlias": "zapier-platform-cli",
2491
2504
  "pluginName": "zapier-platform-cli",
2492
2505
  "pluginType": "core",
@@ -2498,30 +2511,17 @@
2498
2511
  "src",
2499
2512
  "oclif",
2500
2513
  "commands",
2501
- "users",
2502
- "links.js"
2514
+ "team",
2515
+ "get.js"
2503
2516
  ]
2504
2517
  },
2505
- "users:remove": {
2518
+ "team:remove": {
2506
2519
  "aliases": [
2507
- "users:delete"
2520
+ "team:delete"
2508
2521
  ],
2509
- "args": {
2510
- "email": {
2511
- "description": "The user to be removed.",
2512
- "name": "email",
2513
- "required": true
2514
- }
2515
- },
2516
- "description": "Remove a user from all versions of your integration.\n\nWhen this command is run, their Zaps will immediately turn off. They won't be able to use your app again until they're re-invited or it has gone public. In practice, this command isn't run often as it's very disruptive to users.",
2522
+ "args": {},
2523
+ "description": "Remove a team member from all versions of your integration.\n\nAdmins will immediately lose write access to the integration.\nCollaborators will immediately lose read access to the integration.\nSubscribers won't receive future email updates.",
2517
2524
  "flags": {
2518
- "force": {
2519
- "char": "f",
2520
- "description": "Skips confirmation. Useful for running programatically.",
2521
- "name": "force",
2522
- "allowNo": false,
2523
- "type": "boolean"
2524
- },
2525
2525
  "debug": {
2526
2526
  "char": "d",
2527
2527
  "description": "Show extra debugging output.",
@@ -2538,7 +2538,7 @@
2538
2538
  },
2539
2539
  "hasDynamicHelp": false,
2540
2540
  "hiddenAliases": [],
2541
- "id": "users:remove",
2541
+ "id": "team:remove",
2542
2542
  "pluginAlias": "zapier-platform-cli",
2543
2543
  "pluginName": "zapier-platform-cli",
2544
2544
  "pluginType": "core",
@@ -2550,10 +2550,10 @@
2550
2550
  "src",
2551
2551
  "oclif",
2552
2552
  "commands",
2553
- "users",
2553
+ "team",
2554
2554
  "remove.js"
2555
2555
  ]
2556
2556
  }
2557
2557
  },
2558
- "version": "18.0.0"
2558
+ "version": "18.0.1"
2559
2559
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "zapier-platform-cli",
3
- "version": "18.0.0",
3
+ "version": "18.0.1",
4
4
  "description": "The CLI for managing integrations in Zapier Developer Platform.",
5
5
  "repository": "zapier/zapier-platform",
6
6
  "homepage": "https://platform.zapier.com/",
@@ -13,7 +13,6 @@
13
13
  "/src/generators/",
14
14
  "/src/oclif/",
15
15
  "/src/bin/",
16
- "/src/bin/run.cmd",
17
16
  "/src/utils/",
18
17
  "/scaffold/",
19
18
  "/oclif.manifest.json"
@@ -91,7 +90,7 @@
91
90
  "yamljs": "0.3.0"
92
91
  },
93
92
  "bin": {
94
- "zapier": "./src/bin/run-deprecated",
93
+ "zapier": "./src/bin/run",
95
94
  "zapier-platform": "./src/bin/run"
96
95
  },
97
96
  "oclif": {
package/src/bin/run CHANGED
@@ -1,6 +1,30 @@
1
1
  #!/usr/bin/env node
2
2
 
3
+ const path = require('node:path');
4
+
3
5
  (async () => {
4
6
  const oclif = await import('@oclif/core');
5
7
  await oclif.execute({ development: false, dir: __dirname });
8
+
9
+ // Show deprecation warning for the old "zapier" binary name
10
+ // Users can suppress this warning by setting ZAPIER_SUPPRESS_DEPRECATION_WARNING
11
+ if (!process.env.ZAPIER_SUPPRESS_DEPRECATION_WARNING) {
12
+ const msg =
13
+ 'The "zapier" command is deprecated and will be removed in a future version. ' +
14
+ 'Please use "zapier-platform" instead.\n' +
15
+ 'To suppress this warning, set ZAPIER_SUPPRESS_DEPRECATION_WARNING in your environment.\n';
16
+
17
+ if (process.platform === 'win32') {
18
+ // On Windows, we cannot reliably detect which wrapper was invoked (zapier vs zapier-platform)
19
+ // because both wrappers point to the same script. Show a generic deprecation notice instead of a warning..
20
+ console.warn('\n[DEPRECATION NOTICE] ' + msg);
21
+ } else {
22
+ // On Unix, we can detect which symlink was used
23
+ const scriptPath = process.argv[1] || '';
24
+ const binName = path.basename(scriptPath, path.extname(scriptPath));
25
+ if (binName === 'zapier') {
26
+ console.warn('\n[DEPRECATION WARNING] ' + msg);
27
+ }
28
+ }
29
+ }
6
30
  })();
@@ -1,14 +0,0 @@
1
- #!/usr/bin/env node
2
-
3
- const path = require('node:path');
4
-
5
- (async () => {
6
- const oclif = await import('@oclif/core');
7
- await oclif.execute({ development: false, dir: __dirname });
8
-
9
- console.warn(
10
- '[DEPRECATION WARNING] ' +
11
- 'The executable name "zapier" is deprecated and will be removed in a future version. ' +
12
- 'Please use "zapier-platform" instead.',
13
- );
14
- })();