appwrite-cli 17.1.0 → 17.2.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.
Files changed (56) hide show
  1. package/.github/workflows/ci.yml +1 -1
  2. package/.github/workflows/publish.yml +1 -1
  3. package/CHANGELOG.md +14 -0
  4. package/README.md +2 -2
  5. package/bun.lock +783 -0
  6. package/cli.ts +14 -2
  7. package/dist/bundle-win-arm64.mjs +1137 -733
  8. package/dist/cli.cjs +1137 -733
  9. package/dist/index.cjs +193 -79
  10. package/dist/index.js +193 -79
  11. package/dist/lib/client.d.ts +9 -0
  12. package/dist/lib/client.d.ts.map +1 -1
  13. package/dist/lib/commands/init.d.ts.map +1 -1
  14. package/dist/lib/constants.d.ts +1 -1
  15. package/dist/lib/emulation/docker.d.ts.map +1 -1
  16. package/dist/lib/parser.d.ts.map +1 -1
  17. package/dist/lib/questions.d.ts.map +1 -1
  18. package/dist/lib/types.d.ts +2 -0
  19. package/dist/lib/types.d.ts.map +1 -1
  20. package/dist/lib/utils.d.ts +12 -0
  21. package/dist/lib/utils.d.ts.map +1 -1
  22. package/install.ps1 +2 -2
  23. package/install.sh +1 -1
  24. package/lib/client.ts +12 -0
  25. package/lib/commands/init.ts +109 -2
  26. package/lib/commands/services/account.ts +110 -55
  27. package/lib/commands/services/activities.ts +4 -2
  28. package/lib/commands/services/backups.ts +24 -12
  29. package/lib/commands/services/databases.ts +150 -75
  30. package/lib/commands/services/functions.ts +60 -30
  31. package/lib/commands/services/graphql.ts +4 -2
  32. package/lib/commands/services/health.ts +46 -23
  33. package/lib/commands/services/locale.ts +16 -8
  34. package/lib/commands/services/messaging.ts +96 -48
  35. package/lib/commands/services/migrations.ts +28 -14
  36. package/lib/commands/services/organizations.ts +76 -38
  37. package/lib/commands/services/project.ts +12 -6
  38. package/lib/commands/services/projects.ts +103 -51
  39. package/lib/commands/services/proxy.ts +16 -8
  40. package/lib/commands/services/sites.ts +58 -29
  41. package/lib/commands/services/storage.ts +30 -15
  42. package/lib/commands/services/tables-db.ts +148 -74
  43. package/lib/commands/services/teams.ts +28 -14
  44. package/lib/commands/services/tokens.ts +10 -5
  45. package/lib/commands/services/users.ts +88 -44
  46. package/lib/commands/services/vcs.ts +20 -10
  47. package/lib/commands/services/webhooks.ts +12 -6
  48. package/lib/constants.ts +1 -1
  49. package/lib/emulation/docker.ts +1 -0
  50. package/lib/parser.ts +279 -122
  51. package/lib/questions.ts +8 -3
  52. package/lib/sdks.ts +0 -1
  53. package/lib/types.ts +2 -0
  54. package/lib/utils.ts +234 -0
  55. package/package.json +1 -1
  56. package/scoop/appwrite.config.json +3 -3
@@ -26,7 +26,7 @@ export const organizations = new Command("organizations")
26
26
  helpWidth: process.stdout.columns || 80,
27
27
  });
28
28
 
29
- organizations
29
+ const organizationsListCommand = organizations
30
30
  .command(`list`)
31
31
  .description(`Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.`)
32
32
  .option(`--queries [queries...]`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, total, billingPlan, paymentMethodId, backupPaymentMethodId, platform`)
@@ -38,7 +38,8 @@ organizations
38
38
  ),
39
39
  );
40
40
 
41
- organizations
41
+
42
+ const organizationsCreateCommand = organizations
42
43
  .command(`create`)
43
44
  .description(`Create a new organization.
44
45
  `)
@@ -59,7 +60,8 @@ organizations
59
60
  ),
60
61
  );
61
62
 
62
- organizations
63
+
64
+ const organizationsEstimationCreateOrganizationCommand = organizations
63
65
  .command(`estimation-create-organization`)
64
66
  .description(`Get estimation for creating an organization.`)
65
67
  .requiredOption(`--billing-plan <billing-plan>`, `Organization billing plan chosen`)
@@ -74,7 +76,8 @@ organizations
74
76
  ),
75
77
  );
76
78
 
77
- organizations
79
+
80
+ const organizationsDeleteCommand = organizations
78
81
  .command(`delete`)
79
82
  .description(`Delete an organization.`)
80
83
  .requiredOption(`--organization-id <organization-id>`, `Team ID.`)
@@ -85,7 +88,8 @@ organizations
85
88
  ),
86
89
  );
87
90
 
88
- organizations
91
+
92
+ const organizationsListAggregationsCommand = organizations
89
93
  .command(`list-aggregations`)
90
94
  .description(`Get a list of all aggregations for an organization.`)
91
95
  .requiredOption(`--organization-id <organization-id>`, `Organization ID`)
@@ -97,7 +101,8 @@ organizations
97
101
  ),
98
102
  );
99
103
 
100
- organizations
104
+
105
+ const organizationsGetAggregationCommand = organizations
101
106
  .command(`get-aggregation`)
102
107
  .description(`Get a specific aggregation using it's aggregation ID.`)
103
108
  .requiredOption(`--organization-id <organization-id>`, `Organization ID`)
@@ -111,7 +116,8 @@ organizations
111
116
  ),
112
117
  );
113
118
 
114
- organizations
119
+
120
+ const organizationsSetBillingAddressCommand = organizations
115
121
  .command(`set-billing-address`)
116
122
  .description(`Set a billing address for an organization.`)
117
123
  .requiredOption(`--organization-id <organization-id>`, `Organization ID`)
@@ -123,7 +129,8 @@ organizations
123
129
  ),
124
130
  );
125
131
 
126
- organizations
132
+
133
+ const organizationsSetBillingEmailCommand = organizations
127
134
  .command(`set-billing-email`)
128
135
  .description(`Set the current billing email for the organization.`)
129
136
  .requiredOption(`--organization-id <organization-id>`, `Organization ID`)
@@ -135,7 +142,8 @@ organizations
135
142
  ),
136
143
  );
137
144
 
138
- organizations
145
+
146
+ const organizationsUpdateBudgetCommand = organizations
139
147
  .command(`update-budget`)
140
148
  .description(`Update the budget limit for an organization.`)
141
149
  .requiredOption(`--organization-id <organization-id>`, `Organization Unique ID`)
@@ -148,7 +156,8 @@ organizations
148
156
  ),
149
157
  );
150
158
 
151
- organizations
159
+
160
+ const organizationsListCreditsCommand = organizations
152
161
  .command(`list-credits`)
153
162
  .description(`List all credits for an organization.
154
163
  `)
@@ -161,7 +170,8 @@ organizations
161
170
  ),
162
171
  );
163
172
 
164
- organizations
173
+
174
+ const organizationsAddCreditCommand = organizations
165
175
  .command(`add-credit`)
166
176
  .description(`Add credit to an organization using a coupon.`)
167
177
  .requiredOption(`--organization-id <organization-id>`, `Organization ID`)
@@ -173,7 +183,8 @@ organizations
173
183
  ),
174
184
  );
175
185
 
176
- organizations
186
+
187
+ const organizationsGetAvailableCreditsCommand = organizations
177
188
  .command(`get-available-credits`)
178
189
  .description(`Get total available valid credits for an organization.`)
179
190
  .requiredOption(`--organization-id <organization-id>`, `Organization ID`)
@@ -184,7 +195,8 @@ organizations
184
195
  ),
185
196
  );
186
197
 
187
- organizations
198
+
199
+ const organizationsGetCreditCommand = organizations
188
200
  .command(`get-credit`)
189
201
  .description(`Get credit details.`)
190
202
  .requiredOption(`--organization-id <organization-id>`, `Organization ID`)
@@ -196,7 +208,8 @@ organizations
196
208
  ),
197
209
  );
198
210
 
199
- organizations
211
+
212
+ const organizationsEstimationDeleteOrganizationCommand = organizations
200
213
  .command(`estimation-delete-organization`)
201
214
  .description(`Get estimation for deleting an organization.`)
202
215
  .requiredOption(`--organization-id <organization-id>`, `Team ID.`)
@@ -207,7 +220,8 @@ organizations
207
220
  ),
208
221
  );
209
222
 
210
- organizations
223
+
224
+ const organizationsEstimationUpdatePlanCommand = organizations
211
225
  .command(`estimation-update-plan`)
212
226
  .description(`Get estimation for updating the organization plan.`)
213
227
  .requiredOption(`--organization-id <organization-id>`, `Organization ID`)
@@ -221,7 +235,8 @@ organizations
221
235
  ),
222
236
  );
223
237
 
224
- organizations
238
+
239
+ const organizationsCreateDowngradeFeedbackCommand = organizations
225
240
  .command(`create-downgrade-feedback`)
226
241
  .description(`Submit feedback about downgrading from a paid plan to a lower tier. This helps the team understand user experience and improve the platform.
227
242
  `)
@@ -237,7 +252,8 @@ organizations
237
252
  ),
238
253
  );
239
254
 
240
- organizations
255
+
256
+ const organizationsGetInvoiceCommand = organizations
241
257
  .command(`get-invoice`)
242
258
  .description(`Get an invoice by its unique ID.`)
243
259
  .requiredOption(`--organization-id <organization-id>`, `Organization ID`)
@@ -249,7 +265,8 @@ organizations
249
265
  ),
250
266
  );
251
267
 
252
- organizations
268
+
269
+ const organizationsGetInvoiceDownloadCommand = organizations
253
270
  .command(`get-invoice-download`)
254
271
  .description(`Download invoice in PDF`)
255
272
  .requiredOption(`--organization-id <organization-id>`, `Organization ID`)
@@ -261,7 +278,8 @@ organizations
261
278
  ),
262
279
  );
263
280
 
264
- organizations
281
+
282
+ const organizationsCreateInvoicePaymentCommand = organizations
265
283
  .command(`create-invoice-payment`)
266
284
  .description(`Initiate payment for failed invoice to pay live from console`)
267
285
  .requiredOption(`--organization-id <organization-id>`, `Organization ID`)
@@ -274,7 +292,8 @@ organizations
274
292
  ),
275
293
  );
276
294
 
277
- organizations
295
+
296
+ const organizationsValidateInvoiceCommand = organizations
278
297
  .command(`validate-invoice`)
279
298
  .description(`Validates the payment linked with the invoice and updates the invoice status if the payment status is changed.`)
280
299
  .requiredOption(`--organization-id <organization-id>`, `Organization ID`)
@@ -286,7 +305,8 @@ organizations
286
305
  ),
287
306
  );
288
307
 
289
- organizations
308
+
309
+ const organizationsGetInvoiceViewCommand = organizations
290
310
  .command(`get-invoice-view`)
291
311
  .description(`View invoice in PDF`)
292
312
  .requiredOption(`--organization-id <organization-id>`, `Organization ID`)
@@ -298,7 +318,8 @@ organizations
298
318
  ),
299
319
  );
300
320
 
301
- organizations
321
+
322
+ const organizationsListKeysCommand = organizations
302
323
  .command(`list-keys`)
303
324
  .description(`Get a list of all API keys from the current organization. `)
304
325
  .requiredOption(`--organization-id <organization-id>`, `Organization Unique ID`)
@@ -315,7 +336,8 @@ organizations
315
336
  ),
316
337
  );
317
338
 
318
- organizations
339
+
340
+ const organizationsCreateKeyCommand = organizations
319
341
  .command(`create-key`)
320
342
  .description(`Create a new organization API key.`)
321
343
  .requiredOption(`--organization-id <organization-id>`, `Organization Unique ID`)
@@ -329,7 +351,8 @@ organizations
329
351
  ),
330
352
  );
331
353
 
332
- organizations
354
+
355
+ const organizationsGetKeyCommand = organizations
333
356
  .command(`get-key`)
334
357
  .description(`Get a key by its unique ID. This endpoint returns details about a specific API key in your organization including it's scopes.`)
335
358
  .requiredOption(`--organization-id <organization-id>`, `Organization Unique ID`)
@@ -341,7 +364,8 @@ organizations
341
364
  ),
342
365
  );
343
366
 
344
- organizations
367
+
368
+ const organizationsUpdateKeyCommand = organizations
345
369
  .command(`update-key`)
346
370
  .description(`Update a key by its unique ID. Use this endpoint to update the name, scopes, or expiration time of an API key.`)
347
371
  .requiredOption(`--organization-id <organization-id>`, `Organization Unique ID`)
@@ -356,7 +380,8 @@ organizations
356
380
  ),
357
381
  );
358
382
 
359
- organizations
383
+
384
+ const organizationsDeleteKeyCommand = organizations
360
385
  .command(`delete-key`)
361
386
  .description(`Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls.`)
362
387
  .requiredOption(`--organization-id <organization-id>`, `Organization Unique ID`)
@@ -368,7 +393,8 @@ organizations
368
393
  ),
369
394
  );
370
395
 
371
- organizations
396
+
397
+ const organizationsSetDefaultPaymentMethodCommand = organizations
372
398
  .command(`set-default-payment-method`)
373
399
  .description(`Set a organization's default payment method.`)
374
400
  .requiredOption(`--organization-id <organization-id>`, `Organization ID`)
@@ -380,7 +406,8 @@ organizations
380
406
  ),
381
407
  );
382
408
 
383
- organizations
409
+
410
+ const organizationsDeleteDefaultPaymentMethodCommand = organizations
384
411
  .command(`delete-default-payment-method`)
385
412
  .description(`Delete the default payment method for an organization.`)
386
413
  .requiredOption(`--organization-id <organization-id>`, `Organization ID`)
@@ -391,7 +418,8 @@ organizations
391
418
  ),
392
419
  );
393
420
 
394
- organizations
421
+
422
+ const organizationsSetBackupPaymentMethodCommand = organizations
395
423
  .command(`set-backup-payment-method`)
396
424
  .description(`Set an organization's backup payment method.
397
425
  `)
@@ -404,7 +432,8 @@ organizations
404
432
  ),
405
433
  );
406
434
 
407
- organizations
435
+
436
+ const organizationsDeleteBackupPaymentMethodCommand = organizations
408
437
  .command(`delete-backup-payment-method`)
409
438
  .description(`Delete a backup payment method for an organization.`)
410
439
  .requiredOption(`--organization-id <organization-id>`, `Organization ID`)
@@ -415,7 +444,8 @@ organizations
415
444
  ),
416
445
  );
417
446
 
418
- organizations
447
+
448
+ const organizationsGetPlanCommand = organizations
419
449
  .command(`get-plan`)
420
450
  .description(`Get the details of the current billing plan for an organization.`)
421
451
  .requiredOption(`--organization-id <organization-id>`, `Organization Unique ID`)
@@ -426,7 +456,8 @@ organizations
426
456
  ),
427
457
  );
428
458
 
429
- organizations
459
+
460
+ const organizationsUpdatePlanCommand = organizations
430
461
  .command(`update-plan`)
431
462
  .description(`Update the billing plan for an organization.`)
432
463
  .requiredOption(`--organization-id <organization-id>`, `Organization Unique ID`)
@@ -444,7 +475,8 @@ organizations
444
475
  ),
445
476
  );
446
477
 
447
- organizations
478
+
479
+ const organizationsCancelDowngradeCommand = organizations
448
480
  .command(`cancel-downgrade`)
449
481
  .description(`Cancel the downgrade initiated for an organization.`)
450
482
  .requiredOption(`--organization-id <organization-id>`, `Organization Unique ID`)
@@ -455,7 +487,8 @@ organizations
455
487
  ),
456
488
  );
457
489
 
458
- organizations
490
+
491
+ const organizationsListRegionsCommand = organizations
459
492
  .command(`list-regions`)
460
493
  .description(`Get all available regions for an organization.`)
461
494
  .requiredOption(`--organization-id <organization-id>`, `Team ID.`)
@@ -466,7 +499,8 @@ organizations
466
499
  ),
467
500
  );
468
501
 
469
- organizations
502
+
503
+ const organizationsGetScopesCommand = organizations
470
504
  .command(`get-scopes`)
471
505
  .description(`Get Scopes`)
472
506
  .requiredOption(`--organization-id <organization-id>`, `Organization id`)
@@ -478,7 +512,8 @@ organizations
478
512
  ),
479
513
  );
480
514
 
481
- organizations
515
+
516
+ const organizationsSetBillingTaxIdCommand = organizations
482
517
  .command(`set-billing-tax-id`)
483
518
  .description(`Set an organization's billing tax ID.`)
484
519
  .requiredOption(`--organization-id <organization-id>`, `Organization ID`)
@@ -490,7 +525,8 @@ organizations
490
525
  ),
491
526
  );
492
527
 
493
- organizations
528
+
529
+ const organizationsGetUsageCommand = organizations
494
530
  .command(`get-usage`)
495
531
  .description(`Get the usage data for an organization.`)
496
532
  .requiredOption(`--organization-id <organization-id>`, `Organization ID`)
@@ -503,7 +539,8 @@ organizations
503
539
  ),
504
540
  );
505
541
 
506
- organizations
542
+
543
+ const organizationsValidatePaymentCommand = organizations
507
544
  .command(`validate-payment`)
508
545
  .description(`Validate payment for team after creation or upgrade.`)
509
546
  .requiredOption(`--organization-id <organization-id>`, `Organization ID`)
@@ -515,3 +552,4 @@ organizations
515
552
  ),
516
553
  );
517
554
 
555
+
@@ -26,7 +26,7 @@ export const project = new Command("project")
26
26
  helpWidth: process.stdout.columns || 80,
27
27
  });
28
28
 
29
- project
29
+ const projectGetUsageCommand = project
30
30
  .command(`get-usage`)
31
31
  .description(`Get comprehensive usage statistics for your project. View metrics including network requests, bandwidth, storage, function executions, database usage, and user activity. Specify a time range with startDate and endDate, and optionally set the data granularity with period (1h or 1d). The response includes both total counts and detailed breakdowns by resource, along with historical data over the specified period.`)
32
32
  .requiredOption(`--start-date <start-date>`, `Starting date for the usage`)
@@ -39,7 +39,8 @@ project
39
39
  ),
40
40
  );
41
41
 
42
- project
42
+
43
+ const projectListVariablesCommand = project
43
44
  .command(`list-variables`)
44
45
  .description(`Get a list of all project environment variables.`)
45
46
  .option(`--queries [queries...]`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: key, resourceType, resourceId, secret`)
@@ -56,7 +57,8 @@ project
56
57
  ),
57
58
  );
58
59
 
59
- project
60
+
61
+ const projectCreateVariableCommand = project
60
62
  .command(`create-variable`)
61
63
  .description(`Create a new project environment variable. These variables can be accessed by all functions and sites in the project.`)
62
64
  .requiredOption(`--variable-id <variable-id>`, `Variable ID. Choose a custom ID or generate a random ID with \`ID.unique()\`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.`)
@@ -75,7 +77,8 @@ project
75
77
  ),
76
78
  );
77
79
 
78
- project
80
+
81
+ const projectGetVariableCommand = project
79
82
  .command(`get-variable`)
80
83
  .description(`Get a variable by its unique ID. `)
81
84
  .requiredOption(`--variable-id <variable-id>`, `Variable ID.`)
@@ -86,7 +89,8 @@ project
86
89
  ),
87
90
  );
88
91
 
89
- project
92
+
93
+ const projectUpdateVariableCommand = project
90
94
  .command(`update-variable`)
91
95
  .description(`Update variable by its unique ID.`)
92
96
  .requiredOption(`--variable-id <variable-id>`, `Variable ID.`)
@@ -105,7 +109,8 @@ project
105
109
  ),
106
110
  );
107
111
 
108
- project
112
+
113
+ const projectDeleteVariableCommand = project
109
114
  .command(`delete-variable`)
110
115
  .description(`Delete a variable by its unique ID. `)
111
116
  .requiredOption(`--variable-id <variable-id>`, `Variable ID.`)
@@ -116,3 +121,4 @@ project
116
121
  ),
117
122
  );
118
123
 
124
+