@appwrite.io/console 3.1.0 → 5.0.0

package/docs/examples/databases/list-documents.md

@@ -12,7 +12,8 @@ const result = await databases.listDocuments({
     collectionId: '<COLLECTION_ID>',
     queries: [], // optional
     transactionId: '<TRANSACTION_ID>', // optional
-    total: false // optional
+    total: false, // optional
+    ttl: 0 // optional
 });
 
 console.log(result);

package/docs/examples/domains/confirm-purchase.md

@@ -0,0 +1,16 @@
+```javascript
+import { Client, Domains } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const domains = new Domains(client);
+
+const result = await domains.confirmPurchase({
+    domainId: '<DOMAIN_ID>',
+    organizationId: '<ORGANIZATION_ID>'
+});
+
+console.log(result);
+```

package/docs/examples/domains/confirm-transfer-in.md

@@ -0,0 +1,16 @@
+```javascript
+import { Client, Domains } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const domains = new Domains(client);
+
+const result = await domains.confirmTransferIn({
+    domainId: '<DOMAIN_ID>',
+    organizationId: '<ORGANIZATION_ID>'
+});
+
+console.log(result);
+```

package/docs/examples/domains/create-purchase.md

@@ -9,7 +9,7 @@ const domains = new Domains(client);
 
 const result = await domains.createPurchase({
     domain: '',
-    teamId: '<TEAM_ID>',
+    organizationId: '<ORGANIZATION_ID>',
     firstName: '<FIRST_NAME>',
     lastName: '<LAST_NAME>',
     email: 'email@example.com',

package/docs/examples/domains/create-transfer-in.md

@@ -0,0 +1,18 @@
+```javascript
+import { Client, Domains } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const domains = new Domains(client);
+
+const result = await domains.createTransferIn({
+    domain: '',
+    organizationId: '<ORGANIZATION_ID>',
+    authCode: '<AUTH_CODE>',
+    paymentMethodId: '<PAYMENT_METHOD_ID>'
+});
+
+console.log(result);
+```

package/docs/examples/domains/create-transfer-out.md

@@ -0,0 +1,16 @@
+```javascript
+import { Client, Domains } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const domains = new Domains(client);
+
+const result = await domains.createTransferOut({
+    domainId: '<DOMAIN_ID>',
+    organizationId: '<ORGANIZATION_ID>'
+});
+
+console.log(result);
+```

package/docs/examples/domains/get-transfer-status.md

@@ -0,0 +1,15 @@
+```javascript
+import { Client, Domains } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const domains = new Domains(client);
+
+const result = await domains.getTransferStatus({
+    domainId: '<DOMAIN_ID>'
+});
+
+console.log(result);
+```

package/docs/examples/functions/create.md

@@ -25,7 +25,9 @@ const result = await functions.create({
     providerBranch: '<PROVIDER_BRANCH>', // optional
     providerSilentMode: false, // optional
     providerRootDirectory: '<PROVIDER_ROOT_DIRECTORY>', // optional
-    specification: '' // optional
+    buildSpecification: '', // optional
+    runtimeSpecification: '', // optional
+    deploymentRetention: 0 // optional
 });
 
 console.log(result);

package/docs/examples/functions/update.md

@@ -25,7 +25,9 @@ const result = await functions.update({
     providerBranch: '<PROVIDER_BRANCH>', // optional
     providerSilentMode: false, // optional
     providerRootDirectory: '<PROVIDER_ROOT_DIRECTORY>', // optional
-    specification: '' // optional
+    buildSpecification: '', // optional
+    runtimeSpecification: '', // optional
+    deploymentRetention: 0 // optional
 });
 
 console.log(result);

package/docs/examples/health/get-console-pausing.md

@@ -0,0 +1,16 @@
+```javascript
+import { Client, Health } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const health = new Health(client);
+
+const result = await health.getConsolePausing({
+    threshold: null, // optional
+    inactivityDays: null // optional
+});
+
+console.log(result);
+```

package/docs/examples/migrations/create-appwrite-migration.md

@@ -1,5 +1,5 @@
 ```javascript
-import { Client, Migrations, Resources } from "@appwrite.io/console";
+import { Client, Migrations, AppwriteMigrationResource } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -8,7 +8,7 @@ const client = new Client()
 const migrations = new Migrations(client);
 
 const result = await migrations.createAppwriteMigration({
-    resources: [Resources.User],
+    resources: [AppwriteMigrationResource.User],
     endpoint: 'https://example.com',
     projectId: '<PROJECT_ID>',
     apiKey: '<API_KEY>'

package/docs/examples/migrations/create-firebase-migration.md

@@ -1,5 +1,5 @@
 ```javascript
-import { Client, Migrations, Resources } from "@appwrite.io/console";
+import { Client, Migrations, FirebaseMigrationResource } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -8,7 +8,7 @@ const client = new Client()
 const migrations = new Migrations(client);
 
 const result = await migrations.createFirebaseMigration({
-    resources: [Resources.User],
+    resources: [FirebaseMigrationResource.User],
     serviceAccount: '<SERVICE_ACCOUNT>'
 });
 

package/docs/examples/migrations/create-n-host-migration.md

@@ -1,5 +1,5 @@
 ```javascript
-import { Client, Migrations, Resources } from "@appwrite.io/console";
+import { Client, Migrations, NHostMigrationResource } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -8,7 +8,7 @@ const client = new Client()
 const migrations = new Migrations(client);
 
 const result = await migrations.createNHostMigration({
-    resources: [Resources.User],
+    resources: [NHostMigrationResource.User],
     subdomain: '<SUBDOMAIN>',
     region: '<REGION>',
     adminSecret: '<ADMIN_SECRET>',

package/docs/examples/migrations/create-supabase-migration.md

@@ -1,5 +1,5 @@
 ```javascript
-import { Client, Migrations, Resources } from "@appwrite.io/console";
+import { Client, Migrations, SupabaseMigrationResource } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -8,7 +8,7 @@ const client = new Client()
 const migrations = new Migrations(client);
 
 const result = await migrations.createSupabaseMigration({
-    resources: [Resources.User],
+    resources: [SupabaseMigrationResource.User],
     endpoint: 'https://example.com',
     apiKey: '<API_KEY>',
     databaseHost: '<DATABASE_HOST>',

package/docs/examples/migrations/get-appwrite-report.md

@@ -1,5 +1,5 @@
 ```javascript
-import { Client, Migrations, Resources } from "@appwrite.io/console";
+import { Client, Migrations, AppwriteMigrationResource } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -8,7 +8,7 @@ const client = new Client()
 const migrations = new Migrations(client);
 
 const result = await migrations.getAppwriteReport({
-    resources: [Resources.User],
+    resources: [AppwriteMigrationResource.User],
     endpoint: 'https://example.com',
     projectID: '<PROJECT_ID>',
     key: '<KEY>'

package/docs/examples/migrations/get-firebase-report.md

@@ -1,5 +1,5 @@
 ```javascript
-import { Client, Migrations, Resources } from "@appwrite.io/console";
+import { Client, Migrations, FirebaseMigrationResource } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -8,7 +8,7 @@ const client = new Client()
 const migrations = new Migrations(client);
 
 const result = await migrations.getFirebaseReport({
-    resources: [Resources.User],
+    resources: [FirebaseMigrationResource.User],
     serviceAccount: '<SERVICE_ACCOUNT>'
 });
 

package/docs/examples/migrations/get-n-host-report.md

@@ -1,5 +1,5 @@
 ```javascript
-import { Client, Migrations, Resources } from "@appwrite.io/console";
+import { Client, Migrations, NHostMigrationResource } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -8,7 +8,7 @@ const client = new Client()
 const migrations = new Migrations(client);
 
 const result = await migrations.getNHostReport({
-    resources: [Resources.User],
+    resources: [NHostMigrationResource.User],
     subdomain: '<SUBDOMAIN>',
     region: '<REGION>',
     adminSecret: '<ADMIN_SECRET>',

package/docs/examples/migrations/get-supabase-report.md

@@ -1,5 +1,5 @@
 ```javascript
-import { Client, Migrations, Resources } from "@appwrite.io/console";
+import { Client, Migrations, SupabaseMigrationResource } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -8,7 +8,7 @@ const client = new Client()
 const migrations = new Migrations(client);
 
 const result = await migrations.getSupabaseReport({
-    resources: [Resources.User],
+    resources: [SupabaseMigrationResource.User],
     endpoint: 'https://example.com',
     apiKey: '<API_KEY>',
     databaseHost: '<DATABASE_HOST>',

package/docs/examples/projects/update-console-access.md

@@ -0,0 +1,15 @@
+```javascript
+import { Client, Projects } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const projects = new Projects(client);
+
+const result = await projects.updateConsoleAccess({
+    projectId: '<PROJECT_ID>'
+});
+
+console.log(result);
+```

package/docs/examples/projects/update-status.md

@@ -0,0 +1,16 @@
+```javascript
+import { Client, Projects, Status } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const projects = new Projects(client);
+
+const result = await projects.updateStatus({
+    projectId: '<PROJECT_ID>',
+    status: Status.Active
+});
+
+console.log(result);
+```

package/docs/examples/sites/create-deployment.md

@@ -10,10 +10,10 @@ const sites = new Sites(client);
 const result = await sites.createDeployment({
     siteId: '<SITE_ID>',
     code: document.getElementById('uploader').files[0],
-    activate: false,
     installCommand: '<INSTALL_COMMAND>', // optional
     buildCommand: '<BUILD_COMMAND>', // optional
-    outputDirectory: '<OUTPUT_DIRECTORY>' // optional
+    outputDirectory: '<OUTPUT_DIRECTORY>', // optional
+    activate: false // optional
 });
 
 console.log(result);

package/docs/examples/sites/create.md

@@ -17,6 +17,7 @@ const result = await sites.create({
     timeout: 1, // optional
     installCommand: '<INSTALL_COMMAND>', // optional
     buildCommand: '<BUILD_COMMAND>', // optional
+    startCommand: '<START_COMMAND>', // optional
     outputDirectory: '<OUTPUT_DIRECTORY>', // optional
     adapter: Adapter.Static, // optional
     installationId: '<INSTALLATION_ID>', // optional
@@ -25,7 +26,9 @@ const result = await sites.create({
     providerBranch: '<PROVIDER_BRANCH>', // optional
     providerSilentMode: false, // optional
     providerRootDirectory: '<PROVIDER_ROOT_DIRECTORY>', // optional
-    specification: '' // optional
+    buildSpecification: '', // optional
+    runtimeSpecification: '', // optional
+    deploymentRetention: 0 // optional
 });
 
 console.log(result);

package/docs/examples/sites/update.md

@@ -16,6 +16,7 @@ const result = await sites.update({
     timeout: 1, // optional
     installCommand: '<INSTALL_COMMAND>', // optional
     buildCommand: '<BUILD_COMMAND>', // optional
+    startCommand: '<START_COMMAND>', // optional
     outputDirectory: '<OUTPUT_DIRECTORY>', // optional
     buildRuntime: BuildRuntime.Node145, // optional
     adapter: Adapter.Static, // optional
@@ -25,7 +26,9 @@ const result = await sites.update({
     providerBranch: '<PROVIDER_BRANCH>', // optional
     providerSilentMode: false, // optional
     providerRootDirectory: '<PROVIDER_ROOT_DIRECTORY>', // optional
-    specification: '' // optional
+    buildSpecification: '', // optional
+    runtimeSpecification: '', // optional
+    deploymentRetention: 0 // optional
 });
 
 console.log(result);

package/docs/examples/tablesdb/list-rows.md

@@ -12,7 +12,8 @@ const result = await tablesDB.listRows({
     tableId: '<TABLE_ID>',
     queries: [], // optional
     transactionId: '<TRANSACTION_ID>', // optional
-    total: false // optional
+    total: false, // optional
+    ttl: 0 // optional
 });
 
 console.log(result);

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": "3.1.0",
+  "version": "5.0.0",
   "license": "BSD-3-Clause",
   "main": "dist/cjs/sdk.js",
   "exports": {

package/src/channel.ts

@@ -16,8 +16,14 @@ interface Resolved { _res: any }
 type Actionable = Document | Row | File | Team | Membership;
 
 function normalize(id: string): string {
-  const trimmed = id.trim();
-  return trimmed === "" ? "*" : trimmed;
+  if (id === undefined || id === null) {
+    throw new Error("Channel ID is required");
+  }
+  const trimmed = String(id).trim();
+  if (trimmed === "") {
+    throw new Error("Channel ID is required");
+  }
+  return trimmed;
 }
 
 export class Channel<T> {
@@ -44,9 +50,8 @@ export class Channel<T> {
 
   // --- DATABASE ROUTE ---
   // Only available on Channel<Database>
-  collection(this: Channel<Database>, id?: string): Channel<Collection> {
-    // Default: wildcard collection ID
-    return this.next<Collection>("collections", id ?? "*");
+  collection(this: Channel<Database>, id: string): Channel<Collection> {
+    return this.next<Collection>("collections", id);
   }
 
   // Only available on Channel<Collection>
@@ -56,9 +61,8 @@ export class Channel<T> {
   }
 
   // --- TABLESDB ROUTE ---
-  table(this: Channel<TablesDB>, id?: string): Channel<Table> {
-    // Default: wildcard table ID
-    return this.next<Table>("tables", id ?? "*");
+  table(this: Channel<TablesDB>, id: string): Channel<Table> {
+    return this.next<Table>("tables", id);
   }
 
   row(this: Channel<Table>, id?: string): Channel<Row> {
@@ -91,31 +95,31 @@ export class Channel<T> {
   }
 
   // --- ROOT FACTORIES ---
-  static database(id: string = "*") {
+  static database(id: string) {
     return new Channel<Database>(["databases", normalize(id)]);
   }
 
-  static execution(id: string = "*") {
+  static execution(id: string) {
     return new Channel<Execution>(["executions", normalize(id)]);
   }
 
-  static tablesdb(id: string = "*") {
+  static tablesdb(id: string) {
     return new Channel<TablesDB>(["tablesdb", normalize(id)]);
   }
 
-  static bucket(id: string = "*") {
+  static bucket(id: string) {
     return new Channel<Bucket>(["buckets", normalize(id)]);
   }
 
-  static function(id: string = "*") {
+  static function(id: string) {
     return new Channel<Func>(["functions", normalize(id)]);
   }
 
-  static team(id: string = "*") {
+  static team(id: string) {
     return new Channel<Team>(["teams", normalize(id)]);
   }
 
-  static membership(id: string = "*") {
+  static membership(id: string) {
     return new Channel<Membership>(["memberships", normalize(id)]);
   }
 

package/src/client.ts

@@ -400,7 +400,7 @@ class Client {
         'x-sdk-name': 'Console',
         'x-sdk-platform': 'console',
         'x-sdk-language': 'web',
-        'x-sdk-version': '3.1.0',
+        'x-sdk-version': '5.0.0',
         'X-Appwrite-Response-Format': '1.8.0',
     };
 
@@ -995,6 +995,10 @@ class Client {
             window.localStorage.setItem('cookieFallback', cookieFallback);
         }
 
+        if (data && typeof data === 'object') {
+            data.toString = () => JSONbig.stringify(data);
+        }
+
         return data;
     }
 

package/src/enums/appwrite-migration-resource.ts

@@ -0,0 +1,25 @@
+export enum AppwriteMigrationResource {
+    User = 'user',
+    Team = 'team',
+    Membership = 'membership',
+    Database = 'database',
+    Table = 'table',
+    Column = 'column',
+    Index = 'index',
+    Row = 'row',
+    Document = 'document',
+    Attribute = 'attribute',
+    Collection = 'collection',
+    Bucket = 'bucket',
+    File = 'file',
+    Function = 'function',
+    Deployment = 'deployment',
+    Environmentvariable = 'environment-variable',
+    Provider = 'provider',
+    Topic = 'topic',
+    Subscriber = 'subscriber',
+    Message = 'message',
+    Site = 'site',
+    Sitedeployment = 'site-deployment',
+    Sitevariable = 'site-variable',
+}

package/src/enums/build-runtime.ts

@@ -30,6 +30,9 @@ export enum BuildRuntime {
     Pythonml311 = 'python-ml-3.11',
     Pythonml312 = 'python-ml-3.12',
     Pythonml313 = 'python-ml-3.13',
+    Deno121 = 'deno-1.21',
+    Deno124 = 'deno-1.24',
+    Deno135 = 'deno-1.35',
     Deno140 = 'deno-1.40',
     Deno146 = 'deno-1.46',
     Deno20 = 'deno-2.0',

package/src/enums/domain-purchase-payment-status.ts

@@ -0,0 +1,10 @@
+export enum DomainPurchasePaymentStatus {
+    Pending = 'pending',
+    PendingConfirmation = 'pending_confirmation',
+    PendingPaymentProcessing = 'pending_payment_processing',
+    Authorized = 'authorized',
+    Captured = 'captured',
+    Failed = 'failed',
+    CaptureFailed = 'capture_failed',
+    RenewalCaptureFailed = 'renewal_capture_failed',
+}

package/src/enums/domain-transfer-status-status.ts

@@ -0,0 +1,10 @@
+export enum DomainTransferStatusStatus {
+    Transferrable = 'transferrable',
+    NotTransferrable = 'not_transferrable',
+    PendingOwner = 'pending_owner',
+    PendingAdmin = 'pending_admin',
+    PendingRegistry = 'pending_registry',
+    Completed = 'completed',
+    Cancelled = 'cancelled',
+    ServiceUnavailable = 'service_unavailable',
+}

package/src/enums/firebase-migration-resource.ts

@@ -0,0 +1,12 @@
+export enum FirebaseMigrationResource {
+    User = 'user',
+    Database = 'database',
+    Table = 'table',
+    Column = 'column',
+    Row = 'row',
+    Document = 'document',
+    Attribute = 'attribute',
+    Collection = 'collection',
+    Bucket = 'bucket',
+    File = 'file',
+}

package/src/enums/{resources.ts → n-host-migration-resource.ts}

@@ -1,4 +1,4 @@
-export enum Resources {
+export enum NHostMigrationResource {
     User = 'user',
     Database = 'database',
     Table = 'table',

package/src/enums/runtime.ts

@@ -30,6 +30,9 @@ export enum Runtime {
     Pythonml311 = 'python-ml-3.11',
     Pythonml312 = 'python-ml-3.12',
     Pythonml313 = 'python-ml-3.13',
+    Deno121 = 'deno-1.21',
+    Deno124 = 'deno-1.24',
+    Deno135 = 'deno-1.35',
     Deno140 = 'deno-1.40',
     Deno146 = 'deno-1.46',
     Deno20 = 'deno-2.0',

package/src/enums/runtimes.ts

@@ -30,6 +30,9 @@ export enum Runtimes {
     Pythonml311 = 'python-ml-3.11',
     Pythonml312 = 'python-ml-3.12',
     Pythonml313 = 'python-ml-3.13',
+    Deno121 = 'deno-1.21',
+    Deno124 = 'deno-1.24',
+    Deno135 = 'deno-1.35',
     Deno140 = 'deno-1.40',
     Deno146 = 'deno-1.46',
     Deno20 = 'deno-2.0',

package/src/enums/status.ts

@@ -0,0 +1,3 @@
+export enum Status {
+    Active = 'active',
+}

package/src/enums/supabase-migration-resource.ts

@@ -0,0 +1,13 @@
+export enum SupabaseMigrationResource {
+    User = 'user',
+    Database = 'database',
+    Table = 'table',
+    Column = 'column',
+    Index = 'index',
+    Row = 'row',
+    Document = 'document',
+    Attribute = 'attribute',
+    Collection = 'collection',
+    Bucket = 'bucket',
+    File = 'file',
+}

package/src/index.ts

@@ -71,7 +71,10 @@ export { ExecutionMethod } from './enums/execution-method';
 export { Name } from './enums/name';
 export { MessagePriority } from './enums/message-priority';
 export { SmtpEncryption } from './enums/smtp-encryption';
-export { Resources } from './enums/resources';
+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 { ProjectUsageRange } from './enums/project-usage-range';
 export { Region } from './enums/region';
 export { Api } from './enums/api';
@@ -80,6 +83,7 @@ export { PlatformType } from './enums/platform-type';
 export { ResourceType } from './enums/resource-type';
 export { ApiService } from './enums/api-service';
 export { SMTPSecure } from './enums/smtp-secure';
+export { Status } from './enums/status';
 export { EmailTemplateType } from './enums/email-template-type';
 export { EmailTemplateLocale } from './enums/email-template-locale';
 export { SmsTemplateType } from './enums/sms-template-type';
@@ -108,3 +112,5 @@ export { ProxyRuleDeploymentResourceType } from './enums/proxy-rule-deployment-r
 export { ProxyRuleStatus } from './enums/proxy-rule-status';
 export { MessageStatus } from './enums/message-status';
 export { BillingPlanGroup } from './enums/billing-plan-group';
+export { DomainPurchasePaymentStatus } from './enums/domain-purchase-payment-status';
+export { DomainTransferStatusStatus } from './enums/domain-transfer-status-status';