appwrite-cli 13.0.0-rc.2 → 13.0.0-rc.3
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.
- package/.github/workflows/{npm-publish.yml → publish.yml} +1 -1
- package/CHANGELOG.md +106 -101
- package/LICENSE.md +2 -2
- package/README.md +36 -59
- package/cli.ts +152 -0
- package/dist/bundle.cjs +4613 -3653
- package/dist/cli.d.ts +3 -0
- package/dist/cli.d.ts.map +1 -0
- package/dist/cli.js +145 -0
- package/dist/cli.js.map +1 -0
- package/dist/index.d.ts +10 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +7 -142
- package/dist/index.js.map +1 -1
- package/dist/lib/client.d.ts.map +1 -1
- package/dist/lib/client.js +7 -6
- package/dist/lib/client.js.map +1 -1
- package/dist/lib/commands/config.d.ts +562 -0
- package/dist/lib/commands/config.d.ts.map +1 -0
- package/dist/lib/commands/config.js +416 -0
- package/dist/lib/commands/config.js.map +1 -0
- package/dist/lib/commands/db.d.ts +34 -0
- package/dist/lib/commands/db.d.ts.map +1 -0
- package/dist/lib/commands/db.js +247 -0
- package/dist/lib/commands/db.js.map +1 -0
- package/dist/lib/commands/errors.d.ts +68 -0
- package/dist/lib/commands/errors.d.ts.map +1 -0
- package/dist/lib/commands/errors.js +72 -0
- package/dist/lib/commands/errors.js.map +1 -0
- package/dist/lib/commands/init.d.ts.map +1 -1
- package/dist/lib/commands/init.js +15 -14
- package/dist/lib/commands/init.js.map +1 -1
- package/dist/lib/commands/pull.d.ts +104 -2
- package/dist/lib/commands/pull.d.ts.map +1 -1
- package/dist/lib/commands/pull.js +470 -281
- package/dist/lib/commands/pull.js.map +1 -1
- package/dist/lib/commands/push.d.ts +106 -0
- package/dist/lib/commands/push.d.ts.map +1 -1
- package/dist/lib/commands/push.js +1257 -1628
- package/dist/lib/commands/push.js.map +1 -1
- package/dist/lib/commands/run.js +1 -1
- package/dist/lib/commands/run.js.map +1 -1
- package/dist/lib/commands/schema.d.ts +59 -0
- package/dist/lib/commands/schema.d.ts.map +1 -0
- package/dist/lib/commands/schema.js +86 -0
- package/dist/lib/commands/schema.js.map +1 -0
- package/dist/lib/commands/services/account.d.ts.map +1 -1
- package/dist/lib/commands/services/account.js +86 -64
- package/dist/lib/commands/services/account.js.map +1 -1
- package/dist/lib/commands/services/console.d.ts.map +1 -1
- package/dist/lib/commands/services/console.js +4 -17
- package/dist/lib/commands/services/console.js.map +1 -1
- package/dist/lib/commands/services/databases.d.ts.map +1 -1
- package/dist/lib/commands/services/databases.js +160 -152
- package/dist/lib/commands/services/databases.js.map +1 -1
- package/dist/lib/commands/services/functions.d.ts.map +1 -1
- package/dist/lib/commands/services/functions.js +41 -33
- package/dist/lib/commands/services/functions.js.map +1 -1
- package/dist/lib/commands/services/graphql.d.ts.map +1 -1
- package/dist/lib/commands/services/graphql.js +3 -3
- package/dist/lib/commands/services/graphql.js.map +1 -1
- package/dist/lib/commands/services/health.d.ts.map +1 -1
- package/dist/lib/commands/services/health.js +24 -24
- package/dist/lib/commands/services/health.js.map +1 -1
- package/dist/lib/commands/services/locale.d.ts.map +1 -1
- package/dist/lib/commands/services/locale.js +9 -9
- package/dist/lib/commands/services/locale.js.map +1 -1
- package/dist/lib/commands/services/messaging.d.ts.map +1 -1
- package/dist/lib/commands/services/messaging.js +59 -59
- package/dist/lib/commands/services/messaging.js.map +1 -1
- package/dist/lib/commands/services/migrations.d.ts.map +1 -1
- package/dist/lib/commands/services/migrations.js +19 -19
- package/dist/lib/commands/services/migrations.js.map +1 -1
- package/dist/lib/commands/services/project.d.ts.map +1 -1
- package/dist/lib/commands/services/project.js +8 -8
- package/dist/lib/commands/services/project.js.map +1 -1
- package/dist/lib/commands/services/projects.d.ts.map +1 -1
- package/dist/lib/commands/services/projects.js +64 -64
- package/dist/lib/commands/services/projects.js.map +1 -1
- package/dist/lib/commands/services/proxy.d.ts.map +1 -1
- package/dist/lib/commands/services/proxy.js +11 -11
- package/dist/lib/commands/services/proxy.js.map +1 -1
- package/dist/lib/commands/services/sites.d.ts.map +1 -1
- package/dist/lib/commands/services/sites.js +41 -33
- package/dist/lib/commands/services/sites.js.map +1 -1
- package/dist/lib/commands/services/storage.d.ts.map +1 -1
- package/dist/lib/commands/services/storage.js +38 -16
- package/dist/lib/commands/services/storage.js.map +1 -1
- package/dist/lib/commands/services/tables-db.d.ts +3 -0
- package/dist/lib/commands/services/tables-db.d.ts.map +1 -0
- package/dist/lib/commands/services/{tablesdb.js → tables-db.js} +171 -163
- package/dist/lib/commands/services/tables-db.js.map +1 -0
- package/dist/lib/commands/services/teams.d.ts.map +1 -1
- package/dist/lib/commands/services/teams.js +16 -16
- package/dist/lib/commands/services/teams.js.map +1 -1
- package/dist/lib/commands/services/tokens.d.ts.map +1 -1
- package/dist/lib/commands/services/tokens.js +6 -6
- package/dist/lib/commands/services/tokens.js.map +1 -1
- package/dist/lib/commands/services/users.d.ts.map +1 -1
- package/dist/lib/commands/services/users.js +54 -54
- package/dist/lib/commands/services/users.js.map +1 -1
- package/dist/lib/commands/services/vcs.d.ts.map +1 -1
- package/dist/lib/commands/services/vcs.js +13 -13
- package/dist/lib/commands/services/vcs.js.map +1 -1
- package/dist/lib/commands/types.d.ts.map +1 -1
- package/dist/lib/commands/types.js +1 -1
- package/dist/lib/commands/types.js.map +1 -1
- package/dist/lib/commands/update.d.ts.map +1 -1
- package/dist/lib/commands/update.js +9 -8
- package/dist/lib/commands/update.js.map +1 -1
- package/dist/lib/commands/utils/attributes.d.ts +47 -0
- package/dist/lib/commands/utils/attributes.d.ts.map +1 -0
- package/dist/lib/commands/utils/attributes.js +514 -0
- package/dist/lib/commands/utils/attributes.js.map +1 -0
- package/dist/lib/commands/utils/change-approval.d.ts +25 -0
- package/dist/lib/commands/utils/change-approval.d.ts.map +1 -0
- package/dist/lib/commands/utils/change-approval.js +129 -0
- package/dist/lib/commands/utils/change-approval.js.map +1 -0
- package/dist/lib/commands/utils/database-sync.d.ts +10 -0
- package/dist/lib/commands/utils/database-sync.d.ts.map +1 -0
- package/dist/lib/commands/utils/database-sync.js +136 -0
- package/dist/lib/commands/utils/database-sync.js.map +1 -0
- package/dist/lib/commands/utils/deployment.d.ts +34 -0
- package/dist/lib/commands/utils/deployment.d.ts.map +1 -0
- package/dist/lib/commands/utils/deployment.js +109 -0
- package/dist/lib/commands/utils/deployment.js.map +1 -0
- package/dist/lib/commands/utils/error-formatter.d.ts +19 -0
- package/dist/lib/commands/utils/error-formatter.d.ts.map +1 -0
- package/dist/lib/commands/utils/error-formatter.js +333 -0
- package/dist/lib/commands/utils/error-formatter.js.map +1 -0
- package/dist/lib/commands/utils/pools.d.ts +16 -0
- package/dist/lib/commands/utils/pools.d.ts.map +1 -0
- package/dist/lib/commands/utils/pools.js +198 -0
- package/dist/lib/commands/utils/pools.js.map +1 -0
- package/dist/lib/config.d.ts +27 -26
- package/dist/lib/config.d.ts.map +1 -1
- package/dist/lib/config.js +8 -45
- package/dist/lib/config.js.map +1 -1
- package/dist/lib/constants.d.ts +14 -0
- package/dist/lib/constants.d.ts.map +1 -0
- package/dist/lib/constants.js +19 -0
- package/dist/lib/constants.js.map +1 -0
- package/dist/lib/emulation/docker.d.ts +4 -4
- package/dist/lib/emulation/docker.d.ts.map +1 -1
- package/dist/lib/emulation/docker.js +80 -67
- package/dist/lib/emulation/docker.js.map +1 -1
- package/dist/lib/parser.d.ts.map +1 -1
- package/dist/lib/parser.js +11 -10
- package/dist/lib/parser.js.map +1 -1
- package/dist/lib/questions.d.ts.map +1 -1
- package/dist/lib/questions.js +20 -20
- package/dist/lib/questions.js.map +1 -1
- package/dist/lib/sdks.d.ts.map +1 -1
- package/dist/lib/sdks.js +10 -11
- package/dist/lib/sdks.js.map +1 -1
- package/dist/lib/types.d.ts +0 -214
- package/dist/lib/types.d.ts.map +1 -1
- package/dist/lib/utils.d.ts +3 -0
- package/dist/lib/utils.d.ts.map +1 -1
- package/dist/lib/utils.js +42 -2
- package/dist/lib/utils.js.map +1 -1
- package/dist/package.json +12 -11
- package/docs/examples/account/create-anonymous-session.md +1 -0
- package/docs/examples/account/create-email-password-session.md +3 -0
- package/docs/examples/account/create-email-token.md +3 -0
- package/docs/examples/account/create-email-verification.md +2 -0
- package/docs/examples/account/create-jwt.md +1 -0
- package/docs/examples/account/create-magic-url-token.md +3 -0
- package/docs/examples/account/create-mfa-authenticator.md +2 -0
- package/docs/examples/account/create-mfa-challenge.md +2 -0
- package/docs/examples/account/create-mfa-recovery-codes.md +1 -0
- package/docs/examples/account/create-o-auth-2-session.md +2 -0
- package/docs/examples/account/create-o-auth-2-token.md +2 -0
- package/docs/examples/account/create-phone-token.md +3 -0
- package/docs/examples/account/create-phone-verification.md +1 -0
- package/docs/examples/account/create-push-target.md +3 -0
- package/docs/examples/account/create-recovery.md +3 -0
- package/docs/examples/account/create-session.md +3 -0
- package/docs/examples/account/create-verification.md +2 -0
- package/docs/examples/account/create.md +4 -0
- package/docs/examples/account/delete-identity.md +2 -0
- package/docs/examples/account/delete-mfa-authenticator.md +2 -0
- package/docs/examples/account/delete-push-target.md +2 -0
- package/docs/examples/account/delete-session.md +2 -0
- package/docs/examples/account/delete-sessions.md +1 -0
- package/docs/examples/account/delete.md +1 -0
- package/docs/examples/account/get-mfa-recovery-codes.md +1 -0
- package/docs/examples/account/get-prefs.md +1 -0
- package/docs/examples/account/get-session.md +2 -0
- package/docs/examples/account/get.md +1 -0
- package/docs/examples/account/list-identities.md +1 -0
- package/docs/examples/account/list-logs.md +1 -0
- package/docs/examples/account/list-mfa-factors.md +1 -0
- package/docs/examples/account/list-sessions.md +1 -0
- package/docs/examples/account/update-email-verification.md +3 -0
- package/docs/examples/account/update-email.md +3 -0
- package/docs/examples/account/update-magic-url-session.md +3 -0
- package/docs/examples/account/update-mfa-authenticator.md +3 -0
- package/docs/examples/account/update-mfa-challenge.md +3 -0
- package/docs/examples/account/update-mfa-recovery-codes.md +1 -0
- package/docs/examples/account/update-mfa.md +2 -0
- package/docs/examples/account/update-name.md +2 -0
- package/docs/examples/account/update-password.md +2 -0
- package/docs/examples/account/update-phone-session.md +3 -0
- package/docs/examples/account/update-phone-verification.md +3 -0
- package/docs/examples/account/update-phone.md +3 -0
- package/docs/examples/account/update-prefs.md +2 -0
- package/docs/examples/account/update-push-target.md +3 -0
- package/docs/examples/account/update-recovery.md +4 -0
- package/docs/examples/account/update-session.md +2 -0
- package/docs/examples/account/update-status.md +1 -0
- package/docs/examples/account/update-verification.md +3 -0
- package/docs/examples/console/get-resource.md +3 -0
- package/docs/examples/console/variables.md +1 -0
- package/docs/examples/databases/create-boolean-attribute.md +5 -0
- package/docs/examples/databases/create-collection.md +4 -0
- package/docs/examples/databases/create-datetime-attribute.md +5 -0
- package/docs/examples/databases/create-document.md +5 -0
- package/docs/examples/databases/create-documents.md +4 -0
- package/docs/examples/databases/create-email-attribute.md +5 -0
- package/docs/examples/databases/create-enum-attribute.md +6 -0
- package/docs/examples/databases/create-float-attribute.md +5 -0
- package/docs/examples/databases/create-index.md +6 -0
- package/docs/examples/databases/create-integer-attribute.md +5 -0
- package/docs/examples/databases/create-ip-attribute.md +5 -0
- package/docs/examples/databases/create-line-attribute.md +5 -0
- package/docs/examples/databases/create-operations.md +2 -0
- package/docs/examples/databases/create-point-attribute.md +5 -0
- package/docs/examples/databases/create-polygon-attribute.md +5 -0
- package/docs/examples/databases/create-relationship-attribute.md +5 -0
- package/docs/examples/databases/create-string-attribute.md +6 -0
- package/docs/examples/databases/create-transaction.md +1 -0
- package/docs/examples/databases/create-url-attribute.md +5 -0
- package/docs/examples/databases/create.md +3 -0
- package/docs/examples/databases/decrement-document-attribute.md +5 -0
- package/docs/examples/databases/delete-attribute.md +4 -0
- package/docs/examples/databases/delete-collection.md +3 -0
- package/docs/examples/databases/delete-document.md +4 -0
- package/docs/examples/databases/delete-documents.md +3 -0
- package/docs/examples/databases/delete-index.md +4 -0
- package/docs/examples/databases/delete-transaction.md +2 -0
- package/docs/examples/databases/delete.md +2 -0
- package/docs/examples/databases/get-attribute.md +4 -0
- package/docs/examples/databases/get-collection-usage.md +3 -0
- package/docs/examples/databases/get-collection.md +3 -0
- package/docs/examples/databases/get-document.md +4 -0
- package/docs/examples/databases/get-index.md +4 -0
- package/docs/examples/databases/get-transaction.md +2 -0
- package/docs/examples/databases/get-usage.md +2 -0
- package/docs/examples/databases/get.md +2 -0
- package/docs/examples/databases/increment-document-attribute.md +5 -0
- package/docs/examples/databases/list-attributes.md +3 -0
- package/docs/examples/databases/list-collection-logs.md +3 -0
- package/docs/examples/databases/list-collections.md +2 -0
- package/docs/examples/databases/list-document-logs.md +4 -0
- package/docs/examples/databases/list-documents.md +3 -0
- package/docs/examples/databases/list-indexes.md +3 -0
- package/docs/examples/databases/list-logs.md +2 -0
- package/docs/examples/databases/list-transactions.md +1 -0
- package/docs/examples/databases/list-usage.md +1 -0
- package/docs/examples/databases/list.md +1 -0
- package/docs/examples/databases/update-boolean-attribute.md +6 -0
- package/docs/examples/databases/update-collection.md +4 -0
- package/docs/examples/databases/update-datetime-attribute.md +6 -0
- package/docs/examples/databases/update-document.md +4 -0
- package/docs/examples/databases/update-documents.md +3 -0
- package/docs/examples/databases/update-email-attribute.md +6 -0
- package/docs/examples/databases/update-enum-attribute.md +7 -0
- package/docs/examples/databases/update-float-attribute.md +6 -0
- package/docs/examples/databases/update-integer-attribute.md +6 -0
- package/docs/examples/databases/update-ip-attribute.md +6 -0
- package/docs/examples/databases/update-line-attribute.md +5 -0
- package/docs/examples/databases/update-point-attribute.md +5 -0
- package/docs/examples/databases/update-polygon-attribute.md +5 -0
- package/docs/examples/databases/update-relationship-attribute.md +4 -0
- package/docs/examples/databases/update-string-attribute.md +6 -0
- package/docs/examples/databases/update-transaction.md +2 -0
- package/docs/examples/databases/update-url-attribute.md +6 -0
- package/docs/examples/databases/update.md +3 -0
- package/docs/examples/databases/upsert-document.md +4 -0
- package/docs/examples/databases/upsert-documents.md +4 -0
- package/docs/examples/functions/create-deployment.md +4 -0
- package/docs/examples/functions/create-duplicate-deployment.md +3 -0
- package/docs/examples/functions/create-execution.md +2 -0
- package/docs/examples/functions/create-template-deployment.md +7 -0
- package/docs/examples/functions/create-variable.md +4 -0
- package/docs/examples/functions/create-vcs-deployment.md +4 -0
- package/docs/examples/functions/create.md +4 -0
- package/docs/examples/functions/delete-deployment.md +3 -0
- package/docs/examples/functions/delete-execution.md +3 -0
- package/docs/examples/functions/delete-variable.md +3 -0
- package/docs/examples/functions/delete.md +2 -0
- package/docs/examples/functions/get-deployment-download.md +3 -0
- package/docs/examples/functions/get-deployment.md +3 -0
- package/docs/examples/functions/get-execution.md +3 -0
- package/docs/examples/functions/get-template.md +2 -0
- package/docs/examples/functions/get-usage.md +2 -0
- package/docs/examples/functions/get-variable.md +3 -0
- package/docs/examples/functions/get.md +2 -0
- package/docs/examples/functions/list-deployments.md +2 -0
- package/docs/examples/functions/list-executions.md +2 -0
- package/docs/examples/functions/list-runtimes.md +1 -0
- package/docs/examples/functions/list-specifications.md +1 -0
- package/docs/examples/functions/list-templates.md +1 -0
- package/docs/examples/functions/list-usage.md +1 -0
- package/docs/examples/functions/list-variables.md +2 -0
- package/docs/examples/functions/list.md +1 -0
- package/docs/examples/functions/update-deployment-status.md +3 -0
- package/docs/examples/functions/update-function-deployment.md +3 -0
- package/docs/examples/functions/update-variable.md +4 -0
- package/docs/examples/functions/update.md +3 -0
- package/docs/examples/graphql/mutation.md +2 -0
- package/docs/examples/graphql/query.md +2 -0
- package/docs/examples/health/get-antivirus.md +1 -0
- package/docs/examples/health/get-cache.md +1 -0
- package/docs/examples/health/get-certificate.md +1 -0
- package/docs/examples/health/get-db.md +1 -0
- package/docs/examples/health/get-failed-jobs.md +2 -0
- package/docs/examples/health/get-pub-sub.md +1 -0
- package/docs/examples/health/get-queue-builds.md +1 -0
- package/docs/examples/health/get-queue-certificates.md +1 -0
- package/docs/examples/health/get-queue-databases.md +1 -0
- package/docs/examples/health/get-queue-deletes.md +1 -0
- package/docs/examples/health/get-queue-functions.md +1 -0
- package/docs/examples/health/get-queue-logs.md +1 -0
- package/docs/examples/health/get-queue-mails.md +1 -0
- package/docs/examples/health/get-queue-messaging.md +1 -0
- package/docs/examples/health/get-queue-migrations.md +1 -0
- package/docs/examples/health/get-queue-stats-resources.md +1 -0
- package/docs/examples/health/get-queue-usage.md +1 -0
- package/docs/examples/health/get-queue-webhooks.md +1 -0
- package/docs/examples/health/get-storage-local.md +1 -0
- package/docs/examples/health/get-storage.md +1 -0
- package/docs/examples/health/get-time.md +1 -0
- package/docs/examples/health/get.md +1 -0
- package/docs/examples/locale/get.md +1 -0
- package/docs/examples/locale/list-codes.md +1 -0
- package/docs/examples/locale/list-continents.md +1 -0
- package/docs/examples/locale/list-countries-eu.md +1 -0
- package/docs/examples/locale/list-countries-phones.md +1 -0
- package/docs/examples/locale/list-countries.md +1 -0
- package/docs/examples/locale/list-currencies.md +1 -0
- package/docs/examples/locale/list-languages.md +1 -0
- package/docs/examples/messaging/create-apns-provider.md +3 -0
- package/docs/examples/messaging/create-email.md +4 -0
- package/docs/examples/messaging/create-fcm-provider.md +3 -0
- package/docs/examples/messaging/create-mailgun-provider.md +3 -0
- package/docs/examples/messaging/create-msg-91-provider.md +3 -0
- package/docs/examples/messaging/create-push.md +2 -0
- package/docs/examples/messaging/create-resend-provider.md +3 -0
- package/docs/examples/messaging/create-sendgrid-provider.md +3 -0
- package/docs/examples/messaging/create-sms.md +3 -0
- package/docs/examples/messaging/create-smtp-provider.md +4 -0
- package/docs/examples/messaging/create-subscriber.md +4 -0
- package/docs/examples/messaging/create-telesign-provider.md +3 -0
- package/docs/examples/messaging/create-textmagic-provider.md +3 -0
- package/docs/examples/messaging/create-topic.md +3 -0
- package/docs/examples/messaging/create-twilio-provider.md +3 -0
- package/docs/examples/messaging/create-vonage-provider.md +3 -0
- package/docs/examples/messaging/delete-provider.md +2 -0
- package/docs/examples/messaging/delete-subscriber.md +3 -0
- package/docs/examples/messaging/delete-topic.md +2 -0
- package/docs/examples/messaging/delete.md +2 -0
- package/docs/examples/messaging/get-message.md +2 -0
- package/docs/examples/messaging/get-provider.md +2 -0
- package/docs/examples/messaging/get-subscriber.md +3 -0
- package/docs/examples/messaging/get-topic.md +2 -0
- package/docs/examples/messaging/list-message-logs.md +2 -0
- package/docs/examples/messaging/list-messages.md +1 -0
- package/docs/examples/messaging/list-provider-logs.md +2 -0
- package/docs/examples/messaging/list-providers.md +1 -0
- package/docs/examples/messaging/list-subscriber-logs.md +2 -0
- package/docs/examples/messaging/list-subscribers.md +2 -0
- package/docs/examples/messaging/list-targets.md +2 -0
- package/docs/examples/messaging/list-topic-logs.md +2 -0
- package/docs/examples/messaging/list-topics.md +1 -0
- package/docs/examples/messaging/update-apns-provider.md +2 -0
- package/docs/examples/messaging/update-email.md +2 -0
- package/docs/examples/messaging/update-fcm-provider.md +2 -0
- package/docs/examples/messaging/update-mailgun-provider.md +2 -0
- package/docs/examples/messaging/update-msg-91-provider.md +2 -0
- package/docs/examples/messaging/update-push.md +2 -0
- package/docs/examples/messaging/update-resend-provider.md +2 -0
- package/docs/examples/messaging/update-sendgrid-provider.md +2 -0
- package/docs/examples/messaging/update-sms.md +2 -0
- package/docs/examples/messaging/update-smtp-provider.md +2 -0
- package/docs/examples/messaging/update-telesign-provider.md +2 -0
- package/docs/examples/messaging/update-textmagic-provider.md +2 -0
- package/docs/examples/messaging/update-topic.md +2 -0
- package/docs/examples/messaging/update-twilio-provider.md +2 -0
- package/docs/examples/messaging/update-vonage-provider.md +2 -0
- package/docs/examples/migrations/create-appwrite-migration.md +5 -0
- package/docs/examples/migrations/create-csv-export.md +3 -0
- package/docs/examples/migrations/create-csv-import.md +4 -0
- package/docs/examples/migrations/create-firebase-migration.md +3 -0
- package/docs/examples/migrations/create-n-host-migration.md +8 -0
- package/docs/examples/migrations/create-supabase-migration.md +7 -0
- package/docs/examples/migrations/delete.md +2 -0
- package/docs/examples/migrations/get-appwrite-report.md +5 -0
- package/docs/examples/migrations/get-firebase-report.md +3 -0
- package/docs/examples/migrations/get-n-host-report.md +8 -0
- package/docs/examples/migrations/get-supabase-report.md +7 -0
- package/docs/examples/migrations/get.md +2 -0
- package/docs/examples/migrations/list.md +1 -0
- package/docs/examples/migrations/retry.md +2 -0
- package/docs/examples/project/create-variable.md +3 -0
- package/docs/examples/project/delete-variable.md +2 -0
- package/docs/examples/project/get-usage.md +3 -0
- package/docs/examples/project/get-variable.md +2 -0
- package/docs/examples/project/list-variables.md +1 -0
- package/docs/examples/project/update-variable.md +3 -0
- package/docs/examples/projects/create-dev-key.md +4 -0
- package/docs/examples/projects/create-jwt.md +3 -0
- package/docs/examples/projects/create-key.md +4 -0
- package/docs/examples/projects/create-platform.md +4 -0
- package/docs/examples/projects/create-smtp-test.md +6 -0
- package/docs/examples/projects/create-webhook.md +6 -0
- package/docs/examples/projects/create.md +4 -0
- package/docs/examples/projects/delete-dev-key.md +3 -0
- package/docs/examples/projects/delete-email-template.md +4 -0
- package/docs/examples/projects/delete-key.md +3 -0
- package/docs/examples/projects/delete-platform.md +3 -0
- package/docs/examples/projects/delete-sms-template.md +4 -0
- package/docs/examples/projects/delete-webhook.md +3 -0
- package/docs/examples/projects/delete.md +2 -0
- package/docs/examples/projects/get-dev-key.md +3 -0
- package/docs/examples/projects/get-email-template.md +4 -0
- package/docs/examples/projects/get-key.md +3 -0
- package/docs/examples/projects/get-platform.md +3 -0
- package/docs/examples/projects/get-sms-template.md +4 -0
- package/docs/examples/projects/get-webhook.md +3 -0
- package/docs/examples/projects/get.md +2 -0
- package/docs/examples/projects/list-dev-keys.md +2 -0
- package/docs/examples/projects/list-keys.md +2 -0
- package/docs/examples/projects/list-platforms.md +2 -0
- package/docs/examples/projects/list-webhooks.md +2 -0
- package/docs/examples/projects/list.md +1 -0
- package/docs/examples/projects/update-api-status-all.md +3 -0
- package/docs/examples/projects/update-api-status.md +4 -0
- package/docs/examples/projects/update-auth-duration.md +3 -0
- package/docs/examples/projects/update-auth-limit.md +3 -0
- package/docs/examples/projects/update-auth-password-dictionary.md +3 -0
- package/docs/examples/projects/update-auth-password-history.md +3 -0
- package/docs/examples/projects/update-auth-sessions-limit.md +3 -0
- package/docs/examples/projects/update-auth-status.md +4 -0
- package/docs/examples/projects/update-dev-key.md +5 -0
- package/docs/examples/projects/update-email-template.md +6 -0
- package/docs/examples/projects/update-key.md +5 -0
- package/docs/examples/projects/update-memberships-privacy.md +5 -0
- package/docs/examples/projects/update-mock-numbers.md +3 -0
- package/docs/examples/projects/update-o-auth-2.md +3 -0
- package/docs/examples/projects/update-personal-data-check.md +3 -0
- package/docs/examples/projects/update-platform.md +4 -0
- package/docs/examples/projects/update-service-status-all.md +3 -0
- package/docs/examples/projects/update-service-status.md +4 -0
- package/docs/examples/projects/update-session-alerts.md +3 -0
- package/docs/examples/projects/update-session-invalidation.md +3 -0
- package/docs/examples/projects/update-sms-template.md +5 -0
- package/docs/examples/projects/update-smtp.md +3 -0
- package/docs/examples/projects/update-team.md +3 -0
- package/docs/examples/projects/update-webhook-signature.md +3 -0
- package/docs/examples/projects/update-webhook.md +7 -0
- package/docs/examples/projects/update.md +3 -0
- package/docs/examples/proxy/create-api-rule.md +2 -0
- package/docs/examples/proxy/create-function-rule.md +3 -0
- package/docs/examples/proxy/create-redirect-rule.md +6 -0
- package/docs/examples/proxy/create-site-rule.md +3 -0
- package/docs/examples/proxy/delete-rule.md +2 -0
- package/docs/examples/proxy/get-rule.md +2 -0
- package/docs/examples/proxy/list-rules.md +1 -0
- package/docs/examples/proxy/update-rule-verification.md +2 -0
- package/docs/examples/sites/create-deployment.md +4 -0
- package/docs/examples/sites/create-duplicate-deployment.md +3 -0
- package/docs/examples/sites/create-template-deployment.md +7 -0
- package/docs/examples/sites/create-variable.md +4 -0
- package/docs/examples/sites/create-vcs-deployment.md +4 -0
- package/docs/examples/sites/create.md +5 -0
- package/docs/examples/sites/delete-deployment.md +3 -0
- package/docs/examples/sites/delete-log.md +3 -0
- package/docs/examples/sites/delete-variable.md +3 -0
- package/docs/examples/sites/delete.md +2 -0
- package/docs/examples/sites/get-deployment-download.md +3 -0
- package/docs/examples/sites/get-deployment.md +3 -0
- package/docs/examples/sites/get-log.md +3 -0
- package/docs/examples/sites/get-template.md +2 -0
- package/docs/examples/sites/get-usage.md +2 -0
- package/docs/examples/sites/get-variable.md +3 -0
- package/docs/examples/sites/get.md +2 -0
- package/docs/examples/sites/list-deployments.md +2 -0
- package/docs/examples/sites/list-frameworks.md +1 -0
- package/docs/examples/sites/list-logs.md +2 -0
- package/docs/examples/sites/list-specifications.md +1 -0
- package/docs/examples/sites/list-templates.md +1 -0
- package/docs/examples/sites/list-usage.md +1 -0
- package/docs/examples/sites/list-variables.md +2 -0
- package/docs/examples/sites/list.md +1 -0
- package/docs/examples/sites/update-deployment-status.md +3 -0
- package/docs/examples/sites/update-site-deployment.md +3 -0
- package/docs/examples/sites/update-variable.md +4 -0
- package/docs/examples/sites/update.md +4 -0
- package/docs/examples/storage/create-bucket.md +3 -0
- package/docs/examples/storage/create-file.md +4 -0
- package/docs/examples/storage/delete-bucket.md +2 -0
- package/docs/examples/storage/delete-file.md +3 -0
- package/docs/examples/storage/get-bucket-usage.md +2 -0
- package/docs/examples/storage/get-bucket.md +2 -0
- package/docs/examples/storage/get-file-download.md +3 -0
- package/docs/examples/storage/get-file-preview.md +3 -0
- package/docs/examples/storage/get-file-view.md +3 -0
- package/docs/examples/storage/get-file.md +3 -0
- package/docs/examples/storage/get-usage.md +1 -0
- package/docs/examples/storage/list-buckets.md +1 -0
- package/docs/examples/storage/list-files.md +2 -0
- package/docs/examples/storage/update-bucket.md +3 -0
- package/docs/examples/storage/update-file.md +3 -0
- package/docs/examples/tablesdb/create-boolean-column.md +5 -0
- package/docs/examples/tablesdb/create-datetime-column.md +5 -0
- package/docs/examples/tablesdb/create-email-column.md +5 -0
- package/docs/examples/tablesdb/create-enum-column.md +6 -0
- package/docs/examples/tablesdb/create-float-column.md +5 -0
- package/docs/examples/tablesdb/create-index.md +6 -0
- package/docs/examples/tablesdb/create-integer-column.md +5 -0
- package/docs/examples/tablesdb/create-ip-column.md +5 -0
- package/docs/examples/tablesdb/create-line-column.md +5 -0
- package/docs/examples/tablesdb/create-operations.md +2 -0
- package/docs/examples/tablesdb/create-point-column.md +5 -0
- package/docs/examples/tablesdb/create-polygon-column.md +5 -0
- package/docs/examples/tablesdb/create-relationship-column.md +5 -0
- package/docs/examples/tablesdb/create-row.md +5 -0
- package/docs/examples/tablesdb/create-rows.md +4 -0
- package/docs/examples/tablesdb/create-string-column.md +6 -0
- package/docs/examples/tablesdb/create-table.md +4 -0
- package/docs/examples/tablesdb/create-transaction.md +1 -0
- package/docs/examples/tablesdb/create-url-column.md +5 -0
- package/docs/examples/tablesdb/create.md +3 -0
- package/docs/examples/tablesdb/decrement-row-column.md +5 -0
- package/docs/examples/tablesdb/delete-column.md +4 -0
- package/docs/examples/tablesdb/delete-index.md +4 -0
- package/docs/examples/tablesdb/delete-row.md +4 -0
- package/docs/examples/tablesdb/delete-rows.md +3 -0
- package/docs/examples/tablesdb/delete-table.md +3 -0
- package/docs/examples/tablesdb/delete-transaction.md +2 -0
- package/docs/examples/tablesdb/delete.md +2 -0
- package/docs/examples/tablesdb/get-column.md +4 -0
- package/docs/examples/tablesdb/get-index.md +4 -0
- package/docs/examples/tablesdb/get-row.md +4 -0
- package/docs/examples/tablesdb/get-table-usage.md +3 -0
- package/docs/examples/tablesdb/get-table.md +3 -0
- package/docs/examples/tablesdb/get-transaction.md +2 -0
- package/docs/examples/tablesdb/get-usage.md +2 -0
- package/docs/examples/tablesdb/get.md +2 -0
- package/docs/examples/tablesdb/increment-row-column.md +5 -0
- package/docs/examples/tablesdb/list-columns.md +3 -0
- package/docs/examples/tablesdb/list-indexes.md +3 -0
- package/docs/examples/tablesdb/list-row-logs.md +4 -0
- package/docs/examples/tablesdb/list-rows.md +3 -0
- package/docs/examples/tablesdb/list-table-logs.md +3 -0
- package/docs/examples/tablesdb/list-tables.md +2 -0
- package/docs/examples/tablesdb/list-transactions.md +1 -0
- package/docs/examples/tablesdb/list-usage.md +1 -0
- package/docs/examples/tablesdb/list.md +1 -0
- package/docs/examples/tablesdb/update-boolean-column.md +6 -0
- package/docs/examples/tablesdb/update-datetime-column.md +6 -0
- package/docs/examples/tablesdb/update-email-column.md +6 -0
- package/docs/examples/tablesdb/update-enum-column.md +7 -0
- package/docs/examples/tablesdb/update-float-column.md +6 -0
- package/docs/examples/tablesdb/update-integer-column.md +6 -0
- package/docs/examples/tablesdb/update-ip-column.md +6 -0
- package/docs/examples/tablesdb/update-line-column.md +5 -0
- package/docs/examples/tablesdb/update-point-column.md +5 -0
- package/docs/examples/tablesdb/update-polygon-column.md +5 -0
- package/docs/examples/tablesdb/update-relationship-column.md +4 -0
- package/docs/examples/tablesdb/update-row.md +4 -0
- package/docs/examples/tablesdb/update-rows.md +3 -0
- package/docs/examples/tablesdb/update-string-column.md +6 -0
- package/docs/examples/tablesdb/update-table.md +4 -0
- package/docs/examples/tablesdb/update-transaction.md +2 -0
- package/docs/examples/tablesdb/update-url-column.md +6 -0
- package/docs/examples/tablesdb/update.md +3 -0
- package/docs/examples/tablesdb/upsert-row.md +4 -0
- package/docs/examples/tablesdb/upsert-rows.md +4 -0
- package/docs/examples/teams/create-membership.md +3 -0
- package/docs/examples/teams/create.md +3 -0
- package/docs/examples/teams/delete-membership.md +3 -0
- package/docs/examples/teams/delete.md +2 -0
- package/docs/examples/teams/get-membership.md +3 -0
- package/docs/examples/teams/get-prefs.md +2 -0
- package/docs/examples/teams/get.md +2 -0
- package/docs/examples/teams/list-logs.md +2 -0
- package/docs/examples/teams/list-memberships.md +2 -0
- package/docs/examples/teams/list.md +1 -0
- package/docs/examples/teams/update-membership-status.md +5 -0
- package/docs/examples/teams/update-membership.md +4 -0
- package/docs/examples/teams/update-name.md +3 -0
- package/docs/examples/teams/update-prefs.md +3 -0
- package/docs/examples/tokens/create-file-token.md +3 -0
- package/docs/examples/tokens/delete.md +2 -0
- package/docs/examples/tokens/get.md +2 -0
- package/docs/examples/tokens/list.md +3 -0
- package/docs/examples/tokens/update.md +2 -0
- package/docs/examples/users/create-argon-2-user.md +4 -0
- package/docs/examples/users/create-bcrypt-user.md +4 -0
- package/docs/examples/users/create-jwt.md +2 -0
- package/docs/examples/users/create-md-5-user.md +4 -0
- package/docs/examples/users/create-mfa-recovery-codes.md +2 -0
- package/docs/examples/users/create-ph-pass-user.md +4 -0
- package/docs/examples/users/create-scrypt-modified-user.md +7 -0
- package/docs/examples/users/create-scrypt-user.md +9 -0
- package/docs/examples/users/create-session.md +2 -0
- package/docs/examples/users/create-sha-user.md +4 -0
- package/docs/examples/users/create-target.md +5 -0
- package/docs/examples/users/create-token.md +2 -0
- package/docs/examples/users/create.md +2 -0
- package/docs/examples/users/delete-identity.md +2 -0
- package/docs/examples/users/delete-mfa-authenticator.md +3 -0
- package/docs/examples/users/delete-session.md +3 -0
- package/docs/examples/users/delete-sessions.md +2 -0
- package/docs/examples/users/delete-target.md +3 -0
- package/docs/examples/users/delete.md +2 -0
- package/docs/examples/users/get-mfa-recovery-codes.md +2 -0
- package/docs/examples/users/get-prefs.md +2 -0
- package/docs/examples/users/get-target.md +3 -0
- package/docs/examples/users/get-usage.md +1 -0
- package/docs/examples/users/get.md +2 -0
- package/docs/examples/users/list-identities.md +1 -0
- package/docs/examples/users/list-logs.md +2 -0
- package/docs/examples/users/list-memberships.md +2 -0
- package/docs/examples/users/list-mfa-factors.md +2 -0
- package/docs/examples/users/list-sessions.md +2 -0
- package/docs/examples/users/list-targets.md +2 -0
- package/docs/examples/users/list.md +1 -0
- package/docs/examples/users/update-email-verification.md +3 -0
- package/docs/examples/users/update-email.md +3 -0
- package/docs/examples/users/update-labels.md +3 -0
- package/docs/examples/users/update-mfa-recovery-codes.md +2 -0
- package/docs/examples/users/update-mfa.md +3 -0
- package/docs/examples/users/update-name.md +3 -0
- package/docs/examples/users/update-password.md +3 -0
- package/docs/examples/users/update-phone-verification.md +3 -0
- package/docs/examples/users/update-phone.md +3 -0
- package/docs/examples/users/update-prefs.md +3 -0
- package/docs/examples/users/update-status.md +3 -0
- package/docs/examples/users/update-target.md +3 -0
- package/docs/examples/vcs/create-repository-detection.md +4 -0
- package/docs/examples/vcs/create-repository.md +4 -0
- package/docs/examples/vcs/delete-installation.md +2 -0
- package/docs/examples/vcs/get-installation.md +2 -0
- package/docs/examples/vcs/get-repository-contents.md +3 -0
- package/docs/examples/vcs/get-repository.md +3 -0
- package/docs/examples/vcs/list-installations.md +1 -0
- package/docs/examples/vcs/list-repositories.md +3 -0
- package/docs/examples/vcs/list-repository-branches.md +3 -0
- package/docs/examples/vcs/update-external-deployments.md +4 -0
- package/index.ts +25 -165
- package/install.ps1 +2 -2
- package/install.sh +1 -1
- package/lib/client.ts +14 -6
- package/lib/commands/config.ts +494 -0
- package/lib/commands/db.ts +324 -0
- package/lib/commands/errors.ts +93 -0
- package/lib/commands/init.ts +25 -14
- package/lib/commands/pull.ts +683 -420
- package/lib/commands/push.ts +1677 -2404
- package/lib/commands/run.ts +1 -1
- package/lib/commands/schema.ts +122 -0
- package/lib/commands/services/account.ts +200 -385
- package/lib/commands/services/console.ts +13 -34
- package/lib/commands/services/databases.ts +298 -1215
- package/lib/commands/services/functions.ts +115 -434
- package/lib/commands/services/graphql.ts +5 -2
- package/lib/commands/services/health.ts +87 -149
- package/lib/commands/services/locale.ts +36 -33
- package/lib/commands/services/messaging.ts +180 -999
- package/lib/commands/services/migrations.ts +54 -226
- package/lib/commands/services/project.ts +19 -23
- package/lib/commands/services/projects.ts +182 -714
- package/lib/commands/services/proxy.ts +30 -58
- package/lib/commands/services/sites.ts +107 -379
- package/lib/commands/services/storage.ts +93 -302
- package/lib/commands/services/tables-db.ts +1150 -0
- package/lib/commands/services/teams.ts +48 -110
- package/lib/commands/services/tokens.ts +16 -28
- package/lib/commands/services/users.ts +133 -403
- package/lib/commands/services/vcs.ts +48 -151
- package/lib/commands/types.ts +1 -1
- package/lib/commands/update.ts +13 -22
- package/lib/commands/utils/attributes.ts +719 -0
- package/lib/commands/utils/change-approval.ts +186 -0
- package/lib/commands/utils/database-sync.ts +180 -0
- package/lib/commands/utils/deployment.ts +184 -0
- package/lib/commands/utils/error-formatter.ts +417 -0
- package/lib/commands/utils/pools.ts +355 -0
- package/lib/config.ts +46 -82
- package/lib/constants.ts +22 -0
- package/lib/emulation/docker.ts +101 -87
- package/lib/parser.ts +16 -11
- package/lib/questions.ts +20 -21
- package/lib/sdks.ts +15 -11
- package/lib/types.ts +0 -229
- package/lib/utils.ts +45 -4
- package/package.json +12 -11
- package/scoop/appwrite.config.json +29 -19
- package/.github/workflows/build-verify.yml +0 -71
- package/bun.lock +0 -625
- package/dist/lib/commands/services/avatars.d.ts +0 -3
- package/dist/lib/commands/services/avatars.d.ts.map +0 -1
- package/dist/lib/commands/services/avatars.js +0 -118
- package/dist/lib/commands/services/avatars.js.map +0 -1
- package/dist/lib/commands/services/tablesdb.d.ts +0 -3
- package/dist/lib/commands/services/tablesdb.d.ts.map +0 -1
- package/dist/lib/commands/services/tablesdb.js.map +0 -1
- package/dist/scripts/generate-commands.d.ts +0 -2
- package/dist/scripts/generate-commands.d.ts.map +0 -1
- package/dist/scripts/generate-commands.js +0 -398
- package/dist/scripts/generate-commands.js.map +0 -1
- package/lib/commands/services/avatars.ts +0 -400
- package/lib/commands/services/tablesdb.ts +0 -1928
- package/scripts/generate-commands.ts +0 -539
|
@@ -1,13 +1,17 @@
|
|
|
1
1
|
import { Command } from "commander";
|
|
2
|
+
import fs from "fs";
|
|
2
3
|
import { sdkForProject } from "../../sdks.js";
|
|
3
4
|
import {
|
|
4
5
|
actionRunner,
|
|
5
6
|
commandDescriptions,
|
|
7
|
+
success,
|
|
8
|
+
parse,
|
|
6
9
|
parseBool,
|
|
7
10
|
parseInteger,
|
|
8
11
|
} from "../../parser.js";
|
|
9
12
|
import {
|
|
10
13
|
Storage,
|
|
14
|
+
Compression,
|
|
11
15
|
ImageGravity,
|
|
12
16
|
ImageFormat,
|
|
13
17
|
UsageRange,
|
|
@@ -31,17 +35,9 @@ export const storage = new Command("storage")
|
|
|
31
35
|
|
|
32
36
|
storage
|
|
33
37
|
.command(`list-buckets`)
|
|
34
|
-
.description(
|
|
35
|
-
|
|
36
|
-
)
|
|
37
|
-
.option(
|
|
38
|
-
`--queries [queries...]`,
|
|
39
|
-
`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: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus, transformations`,
|
|
40
|
-
)
|
|
41
|
-
.option(
|
|
42
|
-
`--search <search>`,
|
|
43
|
-
`Search term to filter your list results. Max length: 256 chars.`,
|
|
44
|
-
)
|
|
38
|
+
.description(`Get a list of all the storage buckets. You can use the query params to filter your results.`)
|
|
39
|
+
.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: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus, transformations`)
|
|
40
|
+
.option(`--search <search>`, `Search term to filter your list results. Max length: 256 chars.`)
|
|
45
41
|
.option(
|
|
46
42
|
`--total [value]`,
|
|
47
43
|
`When set to false, the total count returned will be 0 and will not be calculated.`,
|
|
@@ -51,22 +47,16 @@ storage
|
|
|
51
47
|
.action(
|
|
52
48
|
actionRunner(
|
|
53
49
|
async ({ queries, search, total }) =>
|
|
54
|
-
await (await getStorageClient()).listBuckets(queries, search, total),
|
|
50
|
+
parse(await (await getStorageClient()).listBuckets(queries, search, total)),
|
|
55
51
|
),
|
|
56
52
|
);
|
|
57
53
|
|
|
58
54
|
storage
|
|
59
55
|
.command(`create-bucket`)
|
|
60
56
|
.description(`Create a new storage bucket.`)
|
|
61
|
-
.requiredOption(
|
|
62
|
-
`--bucket-id <bucket-id>`,
|
|
63
|
-
`Unique 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.`,
|
|
64
|
-
)
|
|
57
|
+
.requiredOption(`--bucket-id <bucket-id>`, `Unique 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.`)
|
|
65
58
|
.requiredOption(`--name <name>`, `Bucket name`)
|
|
66
|
-
.option(
|
|
67
|
-
`--permissions [permissions...]`,
|
|
68
|
-
`An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).`,
|
|
69
|
-
)
|
|
59
|
+
.option(`--permissions [permissions...]`, `An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).`)
|
|
70
60
|
.option(
|
|
71
61
|
`--file-security [value]`,
|
|
72
62
|
`Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https://appwrite.io/docs/permissions).`,
|
|
@@ -79,19 +69,9 @@ storage
|
|
|
79
69
|
(value: string | undefined) =>
|
|
80
70
|
value === undefined ? true : parseBool(value),
|
|
81
71
|
)
|
|
82
|
-
.option(
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
parseInteger,
|
|
86
|
-
)
|
|
87
|
-
.option(
|
|
88
|
-
`--allowed-file-extensions [allowed-file-extensions...]`,
|
|
89
|
-
`Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.`,
|
|
90
|
-
)
|
|
91
|
-
.option(
|
|
92
|
-
`--compression <compression>`,
|
|
93
|
-
`Compression algorithm choosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled`,
|
|
94
|
-
)
|
|
72
|
+
.option(`--maximum-file-size <maximum-file-size>`, `Maximum file size allowed in bytes. Maximum allowed value is 30MB.`, parseInteger)
|
|
73
|
+
.option(`--allowed-file-extensions [allowed-file-extensions...]`, `Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.`)
|
|
74
|
+
.option(`--compression <compression>`, `Compression algorithm choosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled`)
|
|
95
75
|
.option(
|
|
96
76
|
`--encryption [value]`,
|
|
97
77
|
`Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled`,
|
|
@@ -112,47 +92,19 @@ storage
|
|
|
112
92
|
)
|
|
113
93
|
.action(
|
|
114
94
|
actionRunner(
|
|
115
|
-
async ({
|
|
116
|
-
bucketId,
|
|
117
|
-
name,
|
|
118
|
-
permissions,
|
|
119
|
-
fileSecurity,
|
|
120
|
-
enabled,
|
|
121
|
-
maximumFileSize,
|
|
122
|
-
allowedFileExtensions,
|
|
123
|
-
compression,
|
|
124
|
-
encryption,
|
|
125
|
-
antivirus,
|
|
126
|
-
transformations,
|
|
127
|
-
}) =>
|
|
128
|
-
await (
|
|
129
|
-
await getStorageClient()
|
|
130
|
-
).createBucket(
|
|
131
|
-
bucketId,
|
|
132
|
-
name,
|
|
133
|
-
permissions,
|
|
134
|
-
fileSecurity,
|
|
135
|
-
enabled,
|
|
136
|
-
maximumFileSize,
|
|
137
|
-
allowedFileExtensions,
|
|
138
|
-
compression,
|
|
139
|
-
encryption,
|
|
140
|
-
antivirus,
|
|
141
|
-
transformations,
|
|
142
|
-
),
|
|
95
|
+
async ({ bucketId, name, permissions, fileSecurity, enabled, maximumFileSize, allowedFileExtensions, compression, encryption, antivirus, transformations }) =>
|
|
96
|
+
parse(await (await getStorageClient()).createBucket(bucketId, name, permissions, fileSecurity, enabled, maximumFileSize, allowedFileExtensions, compression as Compression, encryption, antivirus, transformations)),
|
|
143
97
|
),
|
|
144
98
|
);
|
|
145
99
|
|
|
146
100
|
storage
|
|
147
101
|
.command(`get-bucket`)
|
|
148
|
-
.description(
|
|
149
|
-
`Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.`,
|
|
150
|
-
)
|
|
102
|
+
.description(`Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.`)
|
|
151
103
|
.requiredOption(`--bucket-id <bucket-id>`, `Bucket unique ID.`)
|
|
152
104
|
.action(
|
|
153
105
|
actionRunner(
|
|
154
106
|
async ({ bucketId }) =>
|
|
155
|
-
await (await getStorageClient()).getBucket(bucketId),
|
|
107
|
+
parse(await (await getStorageClient()).getBucket(bucketId)),
|
|
156
108
|
),
|
|
157
109
|
);
|
|
158
110
|
|
|
@@ -161,10 +113,7 @@ storage
|
|
|
161
113
|
.description(`Update a storage bucket by its unique ID.`)
|
|
162
114
|
.requiredOption(`--bucket-id <bucket-id>`, `Bucket unique ID.`)
|
|
163
115
|
.requiredOption(`--name <name>`, `Bucket name`)
|
|
164
|
-
.option(
|
|
165
|
-
`--permissions [permissions...]`,
|
|
166
|
-
`An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).`,
|
|
167
|
-
)
|
|
116
|
+
.option(`--permissions [permissions...]`, `An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).`)
|
|
168
117
|
.option(
|
|
169
118
|
`--file-security [value]`,
|
|
170
119
|
`Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https://appwrite.io/docs/permissions).`,
|
|
@@ -177,19 +126,9 @@ storage
|
|
|
177
126
|
(value: string | undefined) =>
|
|
178
127
|
value === undefined ? true : parseBool(value),
|
|
179
128
|
)
|
|
180
|
-
.option(
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
parseInteger,
|
|
184
|
-
)
|
|
185
|
-
.option(
|
|
186
|
-
`--allowed-file-extensions [allowed-file-extensions...]`,
|
|
187
|
-
`Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.`,
|
|
188
|
-
)
|
|
189
|
-
.option(
|
|
190
|
-
`--compression <compression>`,
|
|
191
|
-
`Compression algorithm choosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled`,
|
|
192
|
-
)
|
|
129
|
+
.option(`--maximum-file-size <maximum-file-size>`, `Maximum file size allowed in bytes. Maximum allowed value is 30MB.`, parseInteger)
|
|
130
|
+
.option(`--allowed-file-extensions [allowed-file-extensions...]`, `Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.`)
|
|
131
|
+
.option(`--compression <compression>`, `Compression algorithm choosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled`)
|
|
193
132
|
.option(
|
|
194
133
|
`--encryption [value]`,
|
|
195
134
|
`Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled`,
|
|
@@ -210,34 +149,8 @@ storage
|
|
|
210
149
|
)
|
|
211
150
|
.action(
|
|
212
151
|
actionRunner(
|
|
213
|
-
async ({
|
|
214
|
-
bucketId,
|
|
215
|
-
name,
|
|
216
|
-
permissions,
|
|
217
|
-
fileSecurity,
|
|
218
|
-
enabled,
|
|
219
|
-
maximumFileSize,
|
|
220
|
-
allowedFileExtensions,
|
|
221
|
-
compression,
|
|
222
|
-
encryption,
|
|
223
|
-
antivirus,
|
|
224
|
-
transformations,
|
|
225
|
-
}) =>
|
|
226
|
-
await (
|
|
227
|
-
await getStorageClient()
|
|
228
|
-
).updateBucket(
|
|
229
|
-
bucketId,
|
|
230
|
-
name,
|
|
231
|
-
permissions,
|
|
232
|
-
fileSecurity,
|
|
233
|
-
enabled,
|
|
234
|
-
maximumFileSize,
|
|
235
|
-
allowedFileExtensions,
|
|
236
|
-
compression,
|
|
237
|
-
encryption,
|
|
238
|
-
antivirus,
|
|
239
|
-
transformations,
|
|
240
|
-
),
|
|
152
|
+
async ({ bucketId, name, permissions, fileSecurity, enabled, maximumFileSize, allowedFileExtensions, compression, encryption, antivirus, transformations }) =>
|
|
153
|
+
parse(await (await getStorageClient()).updateBucket(bucketId, name, permissions, fileSecurity, enabled, maximumFileSize, allowedFileExtensions, compression as Compression, encryption, antivirus, transformations)),
|
|
241
154
|
),
|
|
242
155
|
);
|
|
243
156
|
|
|
@@ -248,27 +161,16 @@ storage
|
|
|
248
161
|
.action(
|
|
249
162
|
actionRunner(
|
|
250
163
|
async ({ bucketId }) =>
|
|
251
|
-
await (await getStorageClient()).deleteBucket(bucketId),
|
|
164
|
+
parse(await (await getStorageClient()).deleteBucket(bucketId)),
|
|
252
165
|
),
|
|
253
166
|
);
|
|
254
167
|
|
|
255
168
|
storage
|
|
256
169
|
.command(`list-files`)
|
|
257
|
-
.description(
|
|
258
|
-
|
|
259
|
-
)
|
|
260
|
-
.
|
|
261
|
-
`--bucket-id <bucket-id>`,
|
|
262
|
-
`Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).`,
|
|
263
|
-
)
|
|
264
|
-
.option(
|
|
265
|
-
`--queries [queries...]`,
|
|
266
|
-
`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, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded`,
|
|
267
|
-
)
|
|
268
|
-
.option(
|
|
269
|
-
`--search <search>`,
|
|
270
|
-
`Search term to filter your list results. Max length: 256 chars.`,
|
|
271
|
-
)
|
|
170
|
+
.description(`Get a list of all the user files. You can use the query params to filter your results.`)
|
|
171
|
+
.requiredOption(`--bucket-id <bucket-id>`, `Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).`)
|
|
172
|
+
.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, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded`)
|
|
173
|
+
.option(`--search <search>`, `Search term to filter your list results. Max length: 256 chars.`)
|
|
272
174
|
.option(
|
|
273
175
|
`--total [value]`,
|
|
274
176
|
`When set to false, the total count returned will be 0 and will not be calculated.`,
|
|
@@ -278,270 +180,159 @@ storage
|
|
|
278
180
|
.action(
|
|
279
181
|
actionRunner(
|
|
280
182
|
async ({ bucketId, queries, search, total }) =>
|
|
281
|
-
await (
|
|
282
|
-
await getStorageClient()
|
|
283
|
-
).listFiles(bucketId, queries, search, total),
|
|
183
|
+
parse(await (await getStorageClient()).listFiles(bucketId, queries, search, total)),
|
|
284
184
|
),
|
|
285
185
|
);
|
|
286
186
|
|
|
287
187
|
storage
|
|
288
188
|
.command(`create-file`)
|
|
289
|
-
.description(
|
|
290
|
-
`Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https://appwrite.io/docs/server/storage#storageCreateBucket) API or directly from your Appwrite console.
|
|
189
|
+
.description(`Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https://appwrite.io/docs/server/storage#storageCreateBucket) API or directly from your Appwrite console.
|
|
291
190
|
|
|
292
191
|
Larger files should be uploaded using multiple requests with the [content-range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range) header to send a partial request with a maximum supported chunk of \`5MB\`. The \`content-range\` header values should always be in bytes.
|
|
293
192
|
|
|
294
193
|
When the first request is sent, the server will return the **File** object, and the subsequent part request must include the file's **id** in \`x-appwrite-id\` header to allow the server to know that the partial upload is for the existing file and not for a new one.
|
|
295
194
|
|
|
296
195
|
If you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.
|
|
297
|
-
|
|
298
|
-
)
|
|
299
|
-
.requiredOption(
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
)
|
|
303
|
-
.requiredOption(
|
|
304
|
-
`--file-id <file-id>`,
|
|
305
|
-
`File 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.`,
|
|
306
|
-
)
|
|
307
|
-
.requiredOption(
|
|
308
|
-
`--file <file>`,
|
|
309
|
-
`Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https://appwrite.io/docs/products/storage/upload-download#input-file).`,
|
|
310
|
-
)
|
|
311
|
-
.option(
|
|
312
|
-
`--permissions [permissions...]`,
|
|
313
|
-
`An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).`,
|
|
314
|
-
)
|
|
196
|
+
`)
|
|
197
|
+
.requiredOption(`--bucket-id <bucket-id>`, `Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).`)
|
|
198
|
+
.requiredOption(`--file-id <file-id>`, `File 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.`)
|
|
199
|
+
.requiredOption(`--file <file>`, `Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https://appwrite.io/docs/products/storage/upload-download#input-file).`)
|
|
200
|
+
.option(`--permissions [permissions...]`, `An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).`)
|
|
315
201
|
.action(
|
|
316
202
|
actionRunner(
|
|
317
203
|
async ({ bucketId, fileId, file, permissions }) =>
|
|
318
|
-
await (
|
|
319
|
-
await getStorageClient()
|
|
320
|
-
).createFile(bucketId, fileId, file, permissions),
|
|
204
|
+
parse(await (await getStorageClient()).createFile(bucketId, fileId, file, permissions)),
|
|
321
205
|
),
|
|
322
206
|
);
|
|
323
207
|
|
|
324
208
|
storage
|
|
325
209
|
.command(`get-file`)
|
|
326
|
-
.description(
|
|
327
|
-
|
|
328
|
-
)
|
|
329
|
-
.requiredOption(
|
|
330
|
-
`--bucket-id <bucket-id>`,
|
|
331
|
-
`Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).`,
|
|
332
|
-
)
|
|
210
|
+
.description(`Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.`)
|
|
211
|
+
.requiredOption(`--bucket-id <bucket-id>`, `Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).`)
|
|
333
212
|
.requiredOption(`--file-id <file-id>`, `File ID.`)
|
|
334
213
|
.action(
|
|
335
214
|
actionRunner(
|
|
336
215
|
async ({ bucketId, fileId }) =>
|
|
337
|
-
await (await getStorageClient()).getFile(bucketId, fileId),
|
|
216
|
+
parse(await (await getStorageClient()).getFile(bucketId, fileId)),
|
|
338
217
|
),
|
|
339
218
|
);
|
|
340
219
|
|
|
341
220
|
storage
|
|
342
221
|
.command(`update-file`)
|
|
343
|
-
.description(
|
|
344
|
-
`Update a file by its unique ID. Only users with write permissions have access to update this resource.`,
|
|
345
|
-
)
|
|
222
|
+
.description(`Update a file by its unique ID. Only users with write permissions have access to update this resource.`)
|
|
346
223
|
.requiredOption(`--bucket-id <bucket-id>`, `Bucket unique ID.`)
|
|
347
224
|
.requiredOption(`--file-id <file-id>`, `File ID.`)
|
|
348
225
|
.option(`--name <name>`, `File name.`)
|
|
349
|
-
.option(
|
|
350
|
-
`--permissions [permissions...]`,
|
|
351
|
-
`An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).`,
|
|
352
|
-
)
|
|
226
|
+
.option(`--permissions [permissions...]`, `An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).`)
|
|
353
227
|
.action(
|
|
354
228
|
actionRunner(
|
|
355
229
|
async ({ bucketId, fileId, name, permissions }) =>
|
|
356
|
-
await (
|
|
357
|
-
await getStorageClient()
|
|
358
|
-
).updateFile(bucketId, fileId, name, permissions),
|
|
230
|
+
parse(await (await getStorageClient()).updateFile(bucketId, fileId, name, permissions)),
|
|
359
231
|
),
|
|
360
232
|
);
|
|
361
233
|
|
|
362
234
|
storage
|
|
363
235
|
.command(`delete-file`)
|
|
364
|
-
.description(
|
|
365
|
-
|
|
366
|
-
)
|
|
367
|
-
.requiredOption(
|
|
368
|
-
`--bucket-id <bucket-id>`,
|
|
369
|
-
`Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).`,
|
|
370
|
-
)
|
|
236
|
+
.description(`Delete a file by its unique ID. Only users with write permissions have access to delete this resource.`)
|
|
237
|
+
.requiredOption(`--bucket-id <bucket-id>`, `Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).`)
|
|
371
238
|
.requiredOption(`--file-id <file-id>`, `File ID.`)
|
|
372
239
|
.action(
|
|
373
240
|
actionRunner(
|
|
374
241
|
async ({ bucketId, fileId }) =>
|
|
375
|
-
await (await getStorageClient()).deleteFile(bucketId, fileId),
|
|
242
|
+
parse(await (await getStorageClient()).deleteFile(bucketId, fileId)),
|
|
376
243
|
),
|
|
377
244
|
);
|
|
378
245
|
|
|
379
246
|
storage
|
|
380
247
|
.command(`get-file-download`)
|
|
381
|
-
.description(
|
|
382
|
-
|
|
383
|
-
)
|
|
384
|
-
.requiredOption(
|
|
385
|
-
`--bucket-id <bucket-id>`,
|
|
386
|
-
`Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).`,
|
|
387
|
-
)
|
|
248
|
+
.description(`Get a file content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.`)
|
|
249
|
+
.requiredOption(`--bucket-id <bucket-id>`, `Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).`)
|
|
388
250
|
.requiredOption(`--file-id <file-id>`, `File ID.`)
|
|
389
251
|
.option(`--token <token>`, `File token for accessing this file.`)
|
|
252
|
+
.requiredOption(`--destination <destination>`, `Path to save the file to.`)
|
|
390
253
|
.action(
|
|
391
254
|
actionRunner(
|
|
392
|
-
async ({ bucketId, fileId, token }) =>
|
|
393
|
-
await (
|
|
394
|
-
|
|
395
|
-
|
|
255
|
+
async ({ bucketId, fileId, token, destination }) => {
|
|
256
|
+
const url = await (await getStorageClient()).getFileDownload(bucketId, fileId, token);
|
|
257
|
+
const response = await fetch(url);
|
|
258
|
+
const buffer = Buffer.from(await response.arrayBuffer());
|
|
259
|
+
fs.writeFileSync(destination, buffer);
|
|
260
|
+
success(`File saved to ${destination}`);
|
|
261
|
+
},
|
|
396
262
|
),
|
|
397
263
|
);
|
|
398
264
|
|
|
399
265
|
storage
|
|
400
266
|
.command(`get-file-preview`)
|
|
401
|
-
.description(
|
|
402
|
-
|
|
403
|
-
)
|
|
404
|
-
.requiredOption(
|
|
405
|
-
`--bucket-id <bucket-id>`,
|
|
406
|
-
`Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).`,
|
|
407
|
-
)
|
|
267
|
+
.description(`Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.`)
|
|
268
|
+
.requiredOption(`--bucket-id <bucket-id>`, `Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).`)
|
|
408
269
|
.requiredOption(`--file-id <file-id>`, `File ID`)
|
|
409
|
-
.option(
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
)
|
|
414
|
-
.option(
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
)
|
|
419
|
-
.option(
|
|
420
|
-
`--gravity <gravity>`,
|
|
421
|
-
`Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right`,
|
|
422
|
-
)
|
|
423
|
-
.option(
|
|
424
|
-
`--quality <quality>`,
|
|
425
|
-
`Preview image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.`,
|
|
426
|
-
parseInteger,
|
|
427
|
-
)
|
|
428
|
-
.option(
|
|
429
|
-
`--border-width <border-width>`,
|
|
430
|
-
`Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.`,
|
|
431
|
-
parseInteger,
|
|
432
|
-
)
|
|
433
|
-
.option(
|
|
434
|
-
`--border-color <border-color>`,
|
|
435
|
-
`Preview image border color. Use a valid HEX color, no # is needed for prefix.`,
|
|
436
|
-
)
|
|
437
|
-
.option(
|
|
438
|
-
`--border-radius <border-radius>`,
|
|
439
|
-
`Preview image border radius in pixels. Pass an integer between 0 to 4000.`,
|
|
440
|
-
parseInteger,
|
|
441
|
-
)
|
|
442
|
-
.option(
|
|
443
|
-
`--opacity <opacity>`,
|
|
444
|
-
`Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.`,
|
|
445
|
-
parseInteger,
|
|
446
|
-
)
|
|
447
|
-
.option(
|
|
448
|
-
`--rotation <rotation>`,
|
|
449
|
-
`Preview image rotation in degrees. Pass an integer between -360 and 360.`,
|
|
450
|
-
parseInteger,
|
|
451
|
-
)
|
|
452
|
-
.option(
|
|
453
|
-
`--background <background>`,
|
|
454
|
-
`Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.`,
|
|
455
|
-
)
|
|
456
|
-
.option(
|
|
457
|
-
`--output <output>`,
|
|
458
|
-
`Output format type (jpeg, jpg, png, gif and webp).`,
|
|
459
|
-
)
|
|
270
|
+
.option(`--width <width>`, `Resize preview image width, Pass an integer between 0 to 4000.`, parseInteger)
|
|
271
|
+
.option(`--height <height>`, `Resize preview image height, Pass an integer between 0 to 4000.`, parseInteger)
|
|
272
|
+
.option(`--gravity <gravity>`, `Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right`)
|
|
273
|
+
.option(`--quality <quality>`, `Preview image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.`, parseInteger)
|
|
274
|
+
.option(`--border-width <border-width>`, `Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.`, parseInteger)
|
|
275
|
+
.option(`--border-color <border-color>`, `Preview image border color. Use a valid HEX color, no # is needed for prefix.`)
|
|
276
|
+
.option(`--border-radius <border-radius>`, `Preview image border radius in pixels. Pass an integer between 0 to 4000.`, parseInteger)
|
|
277
|
+
.option(`--opacity <opacity>`, `Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.`, parseInteger)
|
|
278
|
+
.option(`--rotation <rotation>`, `Preview image rotation in degrees. Pass an integer between -360 and 360.`, parseInteger)
|
|
279
|
+
.option(`--background <background>`, `Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.`)
|
|
280
|
+
.option(`--output <output>`, `Output format type (jpeg, jpg, png, gif and webp).`)
|
|
460
281
|
.option(`--token <token>`, `File token for accessing this file.`)
|
|
282
|
+
.requiredOption(`--destination <destination>`, `Path to save the file to.`)
|
|
461
283
|
.action(
|
|
462
284
|
actionRunner(
|
|
463
|
-
async ({
|
|
464
|
-
bucketId,
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
borderWidth,
|
|
471
|
-
borderColor,
|
|
472
|
-
borderRadius,
|
|
473
|
-
opacity,
|
|
474
|
-
rotation,
|
|
475
|
-
background,
|
|
476
|
-
output,
|
|
477
|
-
token,
|
|
478
|
-
}) =>
|
|
479
|
-
await (
|
|
480
|
-
await getStorageClient()
|
|
481
|
-
).getFilePreview(
|
|
482
|
-
bucketId,
|
|
483
|
-
fileId,
|
|
484
|
-
width,
|
|
485
|
-
height,
|
|
486
|
-
gravity as ImageGravity,
|
|
487
|
-
quality,
|
|
488
|
-
borderWidth,
|
|
489
|
-
borderColor,
|
|
490
|
-
borderRadius,
|
|
491
|
-
opacity,
|
|
492
|
-
rotation,
|
|
493
|
-
background,
|
|
494
|
-
output as ImageFormat,
|
|
495
|
-
token,
|
|
496
|
-
),
|
|
285
|
+
async ({ bucketId, fileId, width, height, gravity, quality, borderWidth, borderColor, borderRadius, opacity, rotation, background, output, token, destination }) => {
|
|
286
|
+
const url = await (await getStorageClient()).getFilePreview(bucketId, fileId, width, height, gravity as ImageGravity, quality, borderWidth, borderColor, borderRadius, opacity, rotation, background, output as ImageFormat, token);
|
|
287
|
+
const response = await fetch(url);
|
|
288
|
+
const buffer = Buffer.from(await response.arrayBuffer());
|
|
289
|
+
fs.writeFileSync(destination, buffer);
|
|
290
|
+
success(`File saved to ${destination}`);
|
|
291
|
+
},
|
|
497
292
|
),
|
|
498
293
|
);
|
|
499
294
|
|
|
500
295
|
storage
|
|
501
296
|
.command(`get-file-view`)
|
|
502
|
-
.description(
|
|
503
|
-
|
|
504
|
-
)
|
|
505
|
-
.requiredOption(
|
|
506
|
-
`--bucket-id <bucket-id>`,
|
|
507
|
-
`Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).`,
|
|
508
|
-
)
|
|
297
|
+
.description(`Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.`)
|
|
298
|
+
.requiredOption(`--bucket-id <bucket-id>`, `Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).`)
|
|
509
299
|
.requiredOption(`--file-id <file-id>`, `File ID.`)
|
|
510
300
|
.option(`--token <token>`, `File token for accessing this file.`)
|
|
301
|
+
.requiredOption(`--destination <destination>`, `Path to save the file to.`)
|
|
511
302
|
.action(
|
|
512
303
|
actionRunner(
|
|
513
|
-
async ({ bucketId, fileId, token }) =>
|
|
514
|
-
await (await getStorageClient()).getFileView(bucketId, fileId, token)
|
|
304
|
+
async ({ bucketId, fileId, token, destination }) => {
|
|
305
|
+
const url = await (await getStorageClient()).getFileView(bucketId, fileId, token);
|
|
306
|
+
const response = await fetch(url);
|
|
307
|
+
const buffer = Buffer.from(await response.arrayBuffer());
|
|
308
|
+
fs.writeFileSync(destination, buffer);
|
|
309
|
+
success(`File saved to ${destination}`);
|
|
310
|
+
},
|
|
515
311
|
),
|
|
516
312
|
);
|
|
517
313
|
|
|
518
314
|
storage
|
|
519
315
|
.command(`get-usage`)
|
|
520
|
-
.description(
|
|
521
|
-
|
|
522
|
-
`,
|
|
523
|
-
)
|
|
316
|
+
.description(`Get usage metrics and statistics for all buckets in the project. You can view the total number of buckets, files, storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.
|
|
317
|
+
`)
|
|
524
318
|
.option(`--range <range>`, `Date range.`)
|
|
525
319
|
.action(
|
|
526
320
|
actionRunner(
|
|
527
321
|
async ({ range }) =>
|
|
528
|
-
await (await getStorageClient()).getUsage(range as UsageRange),
|
|
322
|
+
parse(await (await getStorageClient()).getUsage(range as UsageRange)),
|
|
529
323
|
),
|
|
530
324
|
);
|
|
531
325
|
|
|
532
326
|
storage
|
|
533
327
|
.command(`get-bucket-usage`)
|
|
534
|
-
.description(
|
|
535
|
-
|
|
536
|
-
`,
|
|
537
|
-
)
|
|
328
|
+
.description(`Get usage metrics and statistics a specific bucket in the project. You can view the total number of files, storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.
|
|
329
|
+
`)
|
|
538
330
|
.requiredOption(`--bucket-id <bucket-id>`, `Bucket ID.`)
|
|
539
331
|
.option(`--range <range>`, `Date range.`)
|
|
540
332
|
.action(
|
|
541
333
|
actionRunner(
|
|
542
334
|
async ({ bucketId, range }) =>
|
|
543
|
-
await (
|
|
544
|
-
await getStorageClient()
|
|
545
|
-
).getBucketUsage(bucketId, range as UsageRange),
|
|
335
|
+
parse(await (await getStorageClient()).getBucketUsage(bucketId, range as UsageRange)),
|
|
546
336
|
),
|
|
547
337
|
);
|
|
338
|
+
|