@appwrite.io/console 8.1.1 → 8.3.0

package/package.json

@@ -2,7 +2,7 @@
   "name": "@appwrite.io/console",
   "homepage": "https://appwrite.io/support",
   "description": "Appwrite is an open-source self-hosted backend server that abstracts and simplifies complex and repetitive development tasks behind a very simple REST API",
-  "version": "8.1.1",
+  "version": "8.3.0",
   "license": "BSD-3-Clause",
   "main": "dist/cjs/sdk.js",
   "exports": {
@@ -28,17 +28,20 @@
     "build:types": "tsc --declaration --emitDeclarationOnly --outDir types",
     "build:libs": "rollup -c"
   },
+  "engines": {
+    "node": ">=18.0.0"
+  },
   "dependencies": {
     "json-bigint": "1.0.0"
   },
   "devDependencies": {
-    "@rollup/plugin-commonjs": "25.0.8",
-    "@rollup/plugin-node-resolve": "15.3.1",
-    "@rollup/plugin-typescript": "11.1.6",
+    "@rollup/plugin-commonjs": "29.0.2",
+    "@rollup/plugin-node-resolve": "16.0.3",
+    "@rollup/plugin-typescript": "12.3.0",
     "@types/json-bigint": "1.0.4",
     "playwright": "1.56.1",
-    "rollup": "3.29.5",
-    "serve-handler": "6.1.0",
+    "rollup": "4.60.1",
+    "serve-handler": "6.1.7",
     "tslib": "2.8.1",
     "typescript": "5.7.3"
   },

package/types/enums/addon.d.ts

@@ -0,0 +1,3 @@
+export declare enum Addon {
+    Baa = "baa"
+}

package/types/enums/build-runtime.d.ts

@@ -47,6 +47,7 @@ export declare enum BuildRuntime {
     Dart38 = "dart-3.8",
     Dart39 = "dart-3.9",
     Dart310 = "dart-3.10",
+    Dart311 = "dart-3.11",
     Dotnet60 = "dotnet-6.0",
     Dotnet70 = "dotnet-7.0",
     Dotnet80 = "dotnet-8.0",
@@ -84,5 +85,6 @@ export declare enum BuildRuntime {
     Flutter329 = "flutter-3.29",
     Flutter332 = "flutter-3.32",
     Flutter335 = "flutter-3.35",
-    Flutter338 = "flutter-3.38"
+    Flutter338 = "flutter-3.38",
+    Flutter341 = "flutter-3.41"
 }

package/types/enums/runtime.d.ts

@@ -47,6 +47,7 @@ export declare enum Runtime {
     Dart38 = "dart-3.8",
     Dart39 = "dart-3.9",
     Dart310 = "dart-3.10",
+    Dart311 = "dart-3.11",
     Dotnet60 = "dotnet-6.0",
     Dotnet70 = "dotnet-7.0",
     Dotnet80 = "dotnet-8.0",
@@ -84,5 +85,6 @@ export declare enum Runtime {
     Flutter329 = "flutter-3.29",
     Flutter332 = "flutter-3.32",
     Flutter335 = "flutter-3.35",
-    Flutter338 = "flutter-3.38"
+    Flutter338 = "flutter-3.38",
+    Flutter341 = "flutter-3.41"
 }

package/types/enums/runtimes.d.ts

@@ -47,6 +47,7 @@ export declare enum Runtimes {
     Dart38 = "dart-3.8",
     Dart39 = "dart-3.9",
     Dart310 = "dart-3.10",
+    Dart311 = "dart-3.11",
     Dotnet60 = "dotnet-6.0",
     Dotnet70 = "dotnet-7.0",
     Dotnet80 = "dotnet-8.0",
@@ -84,5 +85,6 @@ export declare enum Runtimes {
     Flutter329 = "flutter-3.29",
     Flutter332 = "flutter-3.32",
     Flutter335 = "flutter-3.35",
-    Flutter338 = "flutter-3.38"
+    Flutter338 = "flutter-3.38",
+    Flutter341 = "flutter-3.41"
 }

package/types/index.d.ts

@@ -76,6 +76,7 @@ export { AppwriteMigrationResource } from './enums/appwrite-migration-resource';
 export { FirebaseMigrationResource } from './enums/firebase-migration-resource';
 export { NHostMigrationResource } from './enums/n-host-migration-resource';
 export { SupabaseMigrationResource } from './enums/supabase-migration-resource';
+export { Addon } from './enums/addon';
 export { ProjectUsageRange } from './enums/project-usage-range';
 export { Region } from './enums/region';
 export { Api } from './enums/api';

package/types/models.d.ts

@@ -4475,6 +4475,18 @@ export declare namespace Models {
          * Whether or not to check the user password for similarity with their personal data.
          */
         authPersonalDataCheck: boolean;
+        /**
+         * Whether or not to disallow disposable email addresses during signup and email updates.
+         */
+        authDisposableEmails: boolean;
+        /**
+         * Whether or not to require canonical email addresses during signup and email updates.
+         */
+        authCanonicalEmails: boolean;
+        /**
+         * Whether or not to disallow free email addresses during signup and email updates.
+         */
+        authFreeEmails: boolean;
         /**
          * An array of mock numbers and their corresponding verification codes (OTPs).
          */
@@ -6473,6 +6485,10 @@ export declare namespace Models {
          * Whether the database adapter uses integer sequence IDs.
          */
         supportForIntegerIds: boolean;
+        /**
+         * Whether email verification for console users is required. Can be "true" or "false".
+         */
+        _APP_CONSOLE_EMAIL_VERIFICATION: string;
     };
     /**
      * MFA Challenge
@@ -7512,6 +7528,10 @@ export declare namespace Models {
          * Whether usage addons are calculated per project.
          */
         usagePerProject: boolean;
+        /**
+         * Supported addons for this plan
+         */
+        supportedAddons: BillingPlanSupportedAddons;
         /**
          * How many policies does plan support
          */
@@ -7604,6 +7624,15 @@ export declare namespace Models {
          */
         dailyCredits?: number;
     };
+    /**
+     * BillingPlanSupportedAddons
+     */
+    export type BillingPlanSupportedAddons = {
+        /**
+         * Whether the plan supports BAA (Business Associate Agreement) addon
+         */
+        baa: boolean;
+    };
     /**
      * BillingLimits
      */
@@ -7658,13 +7687,13 @@ export declare namespace Models {
          */
         resourceId: string;
         /**
-         * Reason for the block
+         * Reason for the block. Can be null if no reason was provided.
          */
-        reason: string;
+        reason?: string;
         /**
-         * Block expiration date in ISO 8601 format.
+         * Block expiration date in ISO 8601 format. Can be null if the block does not expire.
          */
-        expiredAt: string;
+        expiredAt?: string;
     };
     /**
      * Campaign
@@ -8175,6 +8204,10 @@ export declare namespace Models {
          * Invoice ID against which the payment needs to be validated.
          */
         invoiceId: string;
+        /**
+         * Addon ID to use when calling the addon validate endpoint. Empty when authentication is not for an addon.
+         */
+        addonId: string;
     };
     /**
      * paymentMethod
@@ -9027,6 +9060,88 @@ export declare namespace Models {
          */
         available: boolean;
     };
+    /**
+     * Addon
+     */
+    export type Addon = {
+        /**
+         * Addon ID.
+         */
+        $id: string;
+        /**
+         * Addon creation time in ISO 8601 format.
+         */
+        $createdAt: string;
+        /**
+         * Addon update date in ISO 8601 format.
+         */
+        $updatedAt: string;
+        /**
+         * Addon permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
+         */
+        $permissions: string[];
+        /**
+         * Addon key
+         */
+        key: string;
+        /**
+         * Resource type (organization or project)
+         */
+        resourceType: string;
+        /**
+         * Resource ID
+         */
+        resourceId: string;
+        /**
+         * Payment status. Possible values: pending (awaiting payment confirmation e.g. 3DS), active (payment confirmed and addon is running).
+         */
+        status: string;
+        /**
+         * Current value for this billing cycle. For toggle addons: 1 (on) or 0 (off). For numeric addons: the active quantity.
+         */
+        currentValue: number;
+        /**
+         * Value to apply at the start of the next billing cycle. Null means no change is scheduled. For toggle addons, 0 means the addon will be removed at the next cycle.
+         */
+        nextValue?: number;
+    };
+    /**
+     * AddonPrice
+     */
+    export type AddonPrice = {
+        /**
+         * Addon key.
+         */
+        addonKey: string;
+        /**
+         * Addon display name.
+         */
+        name: string;
+        /**
+         * Full monthly price of the addon.
+         */
+        monthlyPrice: number;
+        /**
+         * Calculated prorated amount for the current billing cycle.
+         */
+        proratedAmount: number;
+        /**
+         * Days remaining in the current billing cycle.
+         */
+        remainingDays: number;
+        /**
+         * Total days in the billing cycle.
+         */
+        totalCycleDays: number;
+        /**
+         * Currency code.
+         */
+        currency: string;
+        /**
+         * When the current billing cycle ends.
+         */
+        billingCycleEnd: string;
+    };
     /**
      * domainTransferOut
      */
@@ -9053,6 +9168,19 @@ export declare namespace Models {
          */
         timestamp: string;
     };
+    /**
+     * Addons list
+     */
+    export type AddonList = {
+        /**
+         * Total number of addons that matched your query.
+         */
+        total: number;
+        /**
+         * List of addons.
+         */
+        addons: Addon[];
+    };
     /**
      * Activity event list
      */

package/types/services/health.d.ts

@@ -85,6 +85,7 @@ export declare class Health {
     /**
      * Get the number of audit logs that are waiting to be processed in the Appwrite internal queue server.
      *
+     *
      * @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
      * @throws {AppwriteException}
      * @returns {Promise<Models.HealthQueue>}
@@ -95,6 +96,7 @@ export declare class Health {
     /**
      * Get the number of audit logs that are waiting to be processed in the Appwrite internal queue server.
      *
+     *
      * @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
      * @throws {AppwriteException}
      * @returns {Promise<Models.HealthQueue>}

package/types/services/migrations.d.ts

@@ -203,6 +203,69 @@ export declare class Migrations {
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     getFirebaseReport(resources: FirebaseMigrationResource[], serviceAccount: string): Promise<Models.MigrationReport>;
+    /**
+     * Export documents to a JSON file from your Appwrite database. This endpoint allows you to export documents to a JSON file stored in a secure internal bucket. You'll receive an email with a download link when the export is complete.
+     *
+     *
+     * @param {string} params.resourceId - Composite ID in the format {databaseId:collectionId}, identifying a collection within a database to export.
+     * @param {string} params.filename - The name of the file to be created for the export, excluding the .json extension.
+     * @param {string[]} params.columns - List of attributes to export. If empty, all attributes will be exported. You can use the `*` wildcard to export all attributes from the collection.
+     * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK to filter documents to export. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long.
+     * @param {boolean} params.notify - Set to true to receive an email when the export is complete. Default is true.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Migration>}
+     */
+    createJSONExport(params: {
+        resourceId: string;
+        filename: string;
+        columns?: string[];
+        queries?: string[];
+        notify?: boolean;
+    }): Promise<Models.Migration>;
+    /**
+     * Export documents to a JSON file from your Appwrite database. This endpoint allows you to export documents to a JSON file stored in a secure internal bucket. You'll receive an email with a download link when the export is complete.
+     *
+     *
+     * @param {string} resourceId - Composite ID in the format {databaseId:collectionId}, identifying a collection within a database to export.
+     * @param {string} filename - The name of the file to be created for the export, excluding the .json extension.
+     * @param {string[]} columns - List of attributes to export. If empty, all attributes will be exported. You can use the `*` wildcard to export all attributes from the collection.
+     * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK to filter documents to export. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long.
+     * @param {boolean} notify - Set to true to receive an email when the export is complete. Default is true.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Migration>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createJSONExport(resourceId: string, filename: string, columns?: string[], queries?: string[], notify?: boolean): Promise<Models.Migration>;
+    /**
+     * Import documents from a JSON file into your Appwrite database. This endpoint allows you to import documents from a JSON file uploaded to Appwrite Storage bucket.
+     *
+     *
+     * @param {string} params.bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
+     * @param {string} params.fileId - File ID.
+     * @param {string} params.resourceId - Composite ID in the format {databaseId:collectionId}, identifying a collection within a database.
+     * @param {boolean} params.internalFile - Is the file stored in an internal bucket?
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Migration>}
+     */
+    createJSONImport(params: {
+        bucketId: string;
+        fileId: string;
+        resourceId: string;
+        internalFile?: boolean;
+    }): Promise<Models.Migration>;
+    /**
+     * Import documents from a JSON file into your Appwrite database. This endpoint allows you to import documents from a JSON file uploaded to Appwrite Storage bucket.
+     *
+     *
+     * @param {string} bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
+     * @param {string} fileId - File ID.
+     * @param {string} resourceId - Composite ID in the format {databaseId:collectionId}, identifying a collection within a database.
+     * @param {boolean} internalFile - Is the file stored in an internal bucket?
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Migration>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createJSONImport(bucketId: string, fileId: string, resourceId: string, internalFile?: boolean): Promise<Models.Migration>;
     /**
      * Migrate data from an NHost project to your Appwrite project. This endpoint allows you to migrate resources like authentication, databases, and other supported services from an NHost project.
      *

package/types/services/organizations.d.ts

@@ -1,6 +1,7 @@
 import { Client } from '../client';
 import type { Models } from '../models';
 import { Platform } from '../enums/platform';
+import { Addon } from '../enums/addon';
 import { Scopes } from '../enums/scopes';
 export declare class Organizations {
     client: Client;
@@ -125,6 +126,144 @@ export declare class Organizations {
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     delete(organizationId: string): Promise<{}>;
+    /**
+     * List all billing addons for an organization.
+     *
+     *
+     * @param {string} params.organizationId - Organization ID
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.AddonList>}
+     */
+    listAddons(params: {
+        organizationId: string;
+    }): Promise<Models.AddonList>;
+    /**
+     * List all billing addons for an organization.
+     *
+     *
+     * @param {string} organizationId - Organization ID
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.AddonList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    listAddons(organizationId: string): Promise<Models.AddonList>;
+    /**
+     * Create the BAA billing addon for an organization.
+     *
+     *
+     * @param {string} params.organizationId - Organization ID
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Addon>}
+     */
+    createBaaAddon(params: {
+        organizationId: string;
+    }): Promise<Models.Addon>;
+    /**
+     * Create the BAA billing addon for an organization.
+     *
+     *
+     * @param {string} organizationId - Organization ID
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Addon>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createBaaAddon(organizationId: string): Promise<Models.Addon>;
+    /**
+     * Get the details of a billing addon for an organization.
+     *
+     *
+     * @param {string} params.organizationId - Organization ID
+     * @param {string} params.addonId - Addon ID
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Addon>}
+     */
+    getAddon(params: {
+        organizationId: string;
+        addonId: string;
+    }): Promise<Models.Addon>;
+    /**
+     * Get the details of a billing addon for an organization.
+     *
+     *
+     * @param {string} organizationId - Organization ID
+     * @param {string} addonId - Addon ID
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Addon>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    getAddon(organizationId: string, addonId: string): Promise<Models.Addon>;
+    /**
+     * Delete a billing addon for an organization.
+     *
+     *
+     * @param {string} params.organizationId - Organization ID
+     * @param {string} params.addonId - Addon ID
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    deleteAddon(params: {
+        organizationId: string;
+        addonId: string;
+    }): Promise<{}>;
+    /**
+     * Delete a billing addon for an organization.
+     *
+     *
+     * @param {string} organizationId - Organization ID
+     * @param {string} addonId - Addon ID
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    deleteAddon(organizationId: string, addonId: string): Promise<{}>;
+    /**
+     * Confirm payment for a billing addon for an organization.
+     *
+     *
+     * @param {string} params.organizationId - Organization ID
+     * @param {string} params.addonId - Addon ID
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Addon>}
+     */
+    confirmAddonPayment(params: {
+        organizationId: string;
+        addonId: string;
+    }): Promise<Models.Addon>;
+    /**
+     * Confirm payment for a billing addon for an organization.
+     *
+     *
+     * @param {string} organizationId - Organization ID
+     * @param {string} addonId - Addon ID
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Addon>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    confirmAddonPayment(organizationId: string, addonId: string): Promise<Models.Addon>;
+    /**
+     * Get the price details for a billing addon for an organization.
+     *
+     *
+     * @param {string} params.organizationId - Organization ID
+     * @param {Addon} params.addon - Addon key identifier (e.g. baa).
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.AddonPrice>}
+     */
+    getAddonPrice(params: {
+        organizationId: string;
+        addon: Addon;
+    }): Promise<Models.AddonPrice>;
+    /**
+     * Get the price details for a billing addon for an organization.
+     *
+     *
+     * @param {string} organizationId - Organization ID
+     * @param {Addon} addon - Addon key identifier (e.g. baa).
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.AddonPrice>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    getAddonPrice(organizationId: string, addon: Addon): Promise<Models.AddonPrice>;
     /**
      * Get a list of all aggregations for an organization.
      *