@appwrite.io/console 2.1.2 → 2.2.0

package/docs/examples/organizations/list-regions.md

@@ -0,0 +1,13 @@
+import { Client, Organizations } 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 organizations = new Organizations(client);
+
+const result = await organizations.listRegions({
+    organizationId: '<ORGANIZATION_ID>'
+});
+
+console.log(result);

package/docs/examples/organizations/update-key.md

@@ -0,0 +1,17 @@
+import { Client, Organizations, Scopes } 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 organizations = new Organizations(client);
+
+const result = await organizations.updateKey({
+    organizationId: '<ORGANIZATION_ID>',
+    keyId: '<KEY_ID>',
+    name: '<NAME>',
+    scopes: [Scopes.PlatformsRead],
+    expire: '' // optional
+});
+
+console.log(result);

package/docs/examples/organizations/update-plan.md

@@ -1,4 +1,4 @@
-import { Client, Organizations, BillingPlan } from "@appwrite.io/console";
+import { Client, Organizations } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -8,7 +8,7 @@ const organizations = new Organizations(client);
 
 const result = await organizations.updatePlan({
     organizationId: '<ORGANIZATION_ID>',
-    billingPlan: BillingPlan.Tier0,
+    billingPlan: 'tier-0',
     paymentMethodId: '<PAYMENT_METHOD_ID>', // optional
     billingAddressId: '<BILLING_ADDRESS_ID>', // optional
     invites: [], // optional

package/docs/examples/projects/create-jwt.md

@@ -1,4 +1,4 @@
-import { Client, Projects } from "@appwrite.io/console";
+import { Client, Projects, Scopes } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -8,7 +8,7 @@ const projects = new Projects(client);
 
 const result = await projects.createJWT({
     projectId: '<PROJECT_ID>',
-    scopes: [],
+    scopes: [Scopes.SessionsWrite],
     duration: 0 // optional
 });
 

package/docs/examples/projects/create-key.md

@@ -1,4 +1,4 @@
-import { Client, Projects } from "@appwrite.io/console";
+import { Client, Projects, Scopes } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -9,7 +9,7 @@ const projects = new Projects(client);
 const result = await projects.createKey({
     projectId: '<PROJECT_ID>',
     name: '<NAME>',
-    scopes: [],
+    scopes: [Scopes.SessionsWrite],
     expire: '' // optional
 });
 

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

@@ -1,4 +1,4 @@
-import { Client, Projects } from "@appwrite.io/console";
+import { Client, Projects, Scopes } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -10,7 +10,7 @@ const result = await projects.updateKey({
     projectId: '<PROJECT_ID>',
     keyId: '<KEY_ID>',
     name: '<NAME>',
-    scopes: [],
+    scopes: [Scopes.SessionsWrite],
     expire: '' // optional
 });
 

package/docs/examples/sites/list-templates.md

@@ -1,4 +1,4 @@
-import { Client, Sites } from "@appwrite.io/console";
+import { Client, Sites, Frameworks, UseCases } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -7,8 +7,8 @@ const client = new Client()
 const sites = new Sites(client);
 
 const result = await sites.listTemplates({
-    frameworks: [], // optional
-    useCases: [], // optional
+    frameworks: [Frameworks.Analog], // optional
+    useCases: [UseCases.Portfolio], // optional
     limit: 1, // optional
     offset: 0 // optional
 });

package/docs/examples/tablesdb/create-index.md

@@ -1,4 +1,4 @@
-import { Client, TablesDB, IndexType } from "@appwrite.io/console";
+import { Client, TablesDB, IndexType, OrderBy } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -12,7 +12,7 @@ const result = await tablesDB.createIndex({
     key: '',
     type: IndexType.Key,
     columns: [],
-    orders: [], // optional
+    orders: [OrderBy.Asc], // optional
     lengths: [] // optional
 });
 

package/docs/examples/tablesdb/create-longtext-column.md

@@ -0,0 +1,18 @@
+import { Client, TablesDB } 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 tablesDB = new TablesDB(client);
+
+const result = await tablesDB.createLongtextColumn({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    key: '',
+    required: false,
+    default: '<DEFAULT>', // optional
+    array: false // optional
+});
+
+console.log(result);

package/docs/examples/tablesdb/create-mediumtext-column.md

@@ -0,0 +1,18 @@
+import { Client, TablesDB } 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 tablesDB = new TablesDB(client);
+
+const result = await tablesDB.createMediumtextColumn({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    key: '',
+    required: false,
+    default: '<DEFAULT>', // optional
+    array: false // optional
+});
+
+console.log(result);

package/docs/examples/tablesdb/create-text-column.md

@@ -0,0 +1,18 @@
+import { Client, TablesDB } 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 tablesDB = new TablesDB(client);
+
+const result = await tablesDB.createTextColumn({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    key: '',
+    required: false,
+    default: '<DEFAULT>', // optional
+    array: false // optional
+});
+
+console.log(result);

package/docs/examples/tablesdb/create-varchar-column.md

@@ -0,0 +1,19 @@
+import { Client, TablesDB } 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 tablesDB = new TablesDB(client);
+
+const result = await tablesDB.createVarcharColumn({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    key: '',
+    size: 1,
+    required: false,
+    default: '<DEFAULT>', // optional
+    array: false // optional
+});
+
+console.log(result);

package/docs/examples/tablesdb/update-longtext-column.md

@@ -0,0 +1,18 @@
+import { Client, TablesDB } 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 tablesDB = new TablesDB(client);
+
+const result = await tablesDB.updateLongtextColumn({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    key: '',
+    required: false,
+    default: '<DEFAULT>',
+    newKey: '' // optional
+});
+
+console.log(result);

package/docs/examples/tablesdb/update-mediumtext-column.md

@@ -0,0 +1,18 @@
+import { Client, TablesDB } 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 tablesDB = new TablesDB(client);
+
+const result = await tablesDB.updateMediumtextColumn({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    key: '',
+    required: false,
+    default: '<DEFAULT>',
+    newKey: '' // optional
+});
+
+console.log(result);

package/docs/examples/tablesdb/update-table.md

@@ -9,7 +9,7 @@ const tablesDB = new TablesDB(client);
 const result = await tablesDB.updateTable({
     databaseId: '<DATABASE_ID>',
     tableId: '<TABLE_ID>',
-    name: '<NAME>',
+    name: '<NAME>', // optional
     permissions: [Permission.read(Role.any())], // optional
     rowSecurity: false, // optional
     enabled: false // optional

package/docs/examples/tablesdb/update-text-column.md

@@ -0,0 +1,18 @@
+import { Client, TablesDB } 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 tablesDB = new TablesDB(client);
+
+const result = await tablesDB.updateTextColumn({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    key: '',
+    required: false,
+    default: '<DEFAULT>',
+    newKey: '' // optional
+});
+
+console.log(result);

package/docs/examples/tablesdb/update-varchar-column.md

@@ -0,0 +1,19 @@
+import { Client, TablesDB } 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 tablesDB = new TablesDB(client);
+
+const result = await tablesDB.updateVarcharColumn({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    key: '',
+    required: false,
+    default: '<DEFAULT>',
+    size: 1, // optional
+    newKey: '' // optional
+});
+
+console.log(result);

package/docs/examples/tablesdb/update.md

@@ -8,7 +8,7 @@ const tablesDB = new TablesDB(client);
 
 const result = await tablesDB.update({
     databaseId: '<DATABASE_ID>',
-    name: '<NAME>',
+    name: '<NAME>', // optional
     enabled: false // optional
 });
 

package/docs/examples/teams/create-membership.md

@@ -1,4 +1,4 @@
-import { Client, Teams } from "@appwrite.io/console";
+import { Client, Teams, Roles } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -8,7 +8,7 @@ const teams = new Teams(client);
 
 const result = await teams.createMembership({
     teamId: '<TEAM_ID>',
-    roles: [],
+    roles: [Roles.Developer],
     email: 'email@example.com', // optional
     userId: '<USER_ID>', // optional
     phone: '+12065550100', // optional

package/docs/examples/teams/update-membership.md

@@ -1,4 +1,4 @@
-import { Client, Teams } from "@appwrite.io/console";
+import { Client, Teams, Roles } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -9,7 +9,7 @@ const teams = new Teams(client);
 const result = await teams.updateMembership({
     teamId: '<TEAM_ID>',
     membershipId: '<MEMBERSHIP_ID>',
-    roles: []
+    roles: [Roles.Developer]
 });
 
 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": "2.1.2",
+  "version": "2.2.0",
   "license": "BSD-3-Clause",
   "main": "dist/cjs/sdk.js",
   "exports": {
@@ -25,7 +25,8 @@
     "build:libs": "rollup -c"
   },
   "dependencies": {
-    "json-bigint": "1.0.0"
+    "json-bigint": "1.0.0",
+    "bignumber.js": "9.0.0"
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "22.0.0",

package/src/channel.ts

@@ -0,0 +1,138 @@
+interface Root {}
+interface Database { _db: any }
+interface Collection { _coll: any }
+interface Document { _doc: any }
+interface TablesDB { _tdb: any }
+interface Table { _tbl: any }
+interface Row { _row: any }
+interface Bucket { _bkt: any }
+interface File { _file: any }
+interface Func { _fn: any }
+interface Execution { _exec: any }
+interface Team { _team: any }
+interface Membership { _mem: any }
+interface Resolved { _res: any }
+
+type Actionable = Document | Row | File | Execution | Team | Membership;
+
+function normalize(id: string): string {
+  const trimmed = id.trim();
+  return trimmed === "" ? "*" : trimmed;
+}
+
+export class Channel<T> {
+  declare _type: T;
+
+  private constructor(private readonly segments: string[]) {}
+
+  private next<N>(segment: string, id: string = "*"): Channel<N> {
+    return new Channel<N>([...this.segments, segment, normalize(id)]) as any;
+  }
+
+  private resolve(action: string): Channel<Resolved> {
+    return new Channel<Resolved>([...this.segments, action]) as any;
+  }
+
+  toString(): string {
+    return this.segments.join(".");
+  }
+
+  // --- DATABASE ROUTE ---
+  // Only available on Channel<Database>
+  collection(this: Channel<Database>, id: string = "*"): Channel<Collection> {
+    return this.next<Collection>("collections", id);
+  }
+
+  // Only available on Channel<Collection>
+  document(this: Channel<Collection>, id: string = "*"): Channel<Document> {
+    return this.next<Document>("documents", id);
+  }
+
+  // --- TABLESDB ROUTE ---
+  table(this: Channel<TablesDB>, id: string = "*"): Channel<Table> {
+    return this.next<Table>("tables", id);
+  }
+
+  row(this: Channel<Table>, id: string = "*"): Channel<Row> {
+    return this.next<Row>("rows", id);
+  }
+
+  // --- BUCKET ROUTE ---
+  file(this: Channel<Bucket>, id: string = "*"): Channel<File> {
+    return this.next<File>("files", id);
+  }
+
+  // --- FUNCTION ROUTE ---
+  execution(this: Channel<Func>, id: string = "*"): Channel<Execution> {
+    return this.next<Execution>("executions", id);
+  }
+
+  // --- TERMINAL ACTIONS ---
+  // Restricted to the Actionable union
+  create(this: Channel<Actionable>): Channel<Resolved> {
+    return this.resolve("create");
+  }
+
+  update(this: Channel<Actionable>): Channel<Resolved> {
+    return this.resolve("update");
+  }
+
+  delete(this: Channel<Actionable>): Channel<Resolved> {
+    return this.resolve("delete");
+  }
+
+  // --- ROOT FACTORIES ---
+  static database(id: string = "*") {
+    return new Channel<Database>(["databases", normalize(id)]);
+  }
+
+  static tablesdb(id: string = "*") {
+    return new Channel<TablesDB>(["tablesdb", normalize(id)]);
+  }
+
+  static bucket(id: string = "*") {
+    return new Channel<Bucket>(["buckets", normalize(id)]);
+  }
+
+  static function(id: string = "*") {
+    return new Channel<Func>(["functions", normalize(id)]);
+  }
+
+  static team(id: string = "*") {
+    return new Channel<Team>(["teams", normalize(id)]);
+  }
+
+  static membership(id: string = "*") {
+    return new Channel<Membership>(["memberships", normalize(id)]);
+  }
+
+  static account(userId: string = ""): string {
+    const id = normalize(userId);
+    return id === "*" ? "account" : `account.${id}`;
+  }
+
+  // Global events
+  static documents(): string {
+    return "documents";
+  }
+
+  static rows(): string {
+    return "rows";
+  }
+
+  static files(): string {
+    return "files";
+  }
+
+  static executions(): string {
+    return "executions";
+  }
+
+  static teams(): string {
+    return "teams";
+  }
+}
+
+// Export types for backward compatibility with realtime
+export type ActionableChannel = Channel<Document> | Channel<Row> | Channel<File> | Channel<Execution> | Channel<Team> | Channel<Membership>;
+export type ResolvedChannel = Channel<Resolved>;

package/src/client.ts

@@ -1,6 +1,32 @@
 import { Models } from './models';
+import { Channel, ActionableChannel, ResolvedChannel } from './channel';
 import JSONbigModule from 'json-bigint';
-const JSONbig = JSONbigModule({ useNativeBigInt: true });
+import BigNumber from 'bignumber.js';
+const JSONbigParser = JSONbigModule({ storeAsString: false });
+const JSONbigSerializer = JSONbigModule({ useNativeBigInt: true });
+
+const MAX_SAFE = BigInt(Number.MAX_SAFE_INTEGER);
+const MIN_SAFE = BigInt(Number.MIN_SAFE_INTEGER);
+
+function reviver(_key: string, value: any): any {
+    if (BigNumber.isBigNumber(value)) {
+        if (value.isInteger()) {
+            const str = value.toFixed();
+            const bi = BigInt(str);
+            if (bi >= MIN_SAFE && bi <= MAX_SAFE) {
+                return Number(str);
+            }
+            return bi;
+        }
+        return value.toNumber();
+    }
+    return value;
+}
+
+const JSONbig = {
+    parse: (text: string) => JSONbigParser.parse(text, reviver),
+    stringify: JSONbigSerializer.stringify
+};
 
 /**
  * Payload type representing a key-value pair with string keys and any values.
@@ -334,7 +360,7 @@ class Client {
         'x-sdk-name': 'Console',
         'x-sdk-platform': 'console',
         'x-sdk-language': 'web',
-        'x-sdk-version': '2.1.2',
+        'x-sdk-version': '2.2.0',
         'X-Appwrite-Response-Format': '1.8.0',
     };
 
@@ -654,8 +680,8 @@ class Client {
      * @deprecated Use the Realtime service instead.
      * @see Realtime
      *
-     * @param {string|string[]} channels
-     * Channel to subscribe - pass a single channel as a string or multiple with an array of strings.
+     * @param {string|string[]|Channel<any>|ActionableChannel|ResolvedChannel|(Channel<any>|ActionableChannel|ResolvedChannel)[]} channels
+     * Channel to subscribe - pass a single channel as a string or Channel builder instance, or multiple with an array.
      *
      * Possible channels are:
      * - account
@@ -673,16 +699,35 @@ class Client {
      * - teams.[ID]
      * - memberships
      * - memberships.[ID]
+     * 
+     * You can also use Channel builders:
+     * - Channel.database('db').collection('col').document('doc').create()
+     * - Channel.bucket('bucket').file('file').update()
+     * - Channel.function('func').execution('exec').delete()
+     * - Channel.team('team').create()
+     * - Channel.membership('membership').update()
      * @param {(payload: RealtimeMessage) => void} callback Is called on every realtime update.
      * @returns {() => void} Unsubscribes from events.
      */
-    subscribe<T extends unknown>(channels: string | string[], callback: (payload: RealtimeResponseEvent<T>) => void): () => void {
-        let channelArray = typeof channels === 'string' ? [channels] : channels;
-        channelArray.forEach(channel => this.realtime.channels.add(channel));
+    subscribe<T extends unknown>(channels: string | string[] | Channel<any> | ActionableChannel | ResolvedChannel | (Channel<any> | ActionableChannel | ResolvedChannel)[], callback: (payload: RealtimeResponseEvent<T>) => void): () => void {
+        const channelArray = Array.isArray(channels) ? channels : [channels];
+        // Convert Channel instances to strings
+        const channelStrings = channelArray.map(ch => {
+            if (typeof ch === 'string') {
+                return ch;
+            }
+            // All Channel instances have toString() method
+            if (ch && typeof (ch as Channel<any>).toString === 'function') {
+                return (ch as Channel<any>).toString();
+            }
+            // Fallback to generic string conversion
+            return String(ch);
+        });
+        channelStrings.forEach(channel => this.realtime.channels.add(channel));
 
         const counter = this.realtime.subscriptionsCounter++;
         this.realtime.subscriptions.set(counter, {
-            channels: channelArray,
+            channels: channelStrings,
             callback
         });
 
@@ -690,7 +735,7 @@ class Client {
 
         return () => {
             this.realtime.subscriptions.delete(counter);
-            this.realtime.cleanUp(channelArray);
+            this.realtime.cleanUp(channelStrings);
             this.realtime.connect();
         }
     }

package/src/enums/browser-permission.ts

@@ -0,0 +1,22 @@
+export enum BrowserPermission {
+    Geolocation = 'geolocation',
+    Camera = 'camera',
+    Microphone = 'microphone',
+    Notifications = 'notifications',
+    Midi = 'midi',
+    Push = 'push',
+    Clipboardread = 'clipboard-read',
+    Clipboardwrite = 'clipboard-write',
+    Paymenthandler = 'payment-handler',
+    Usb = 'usb',
+    Bluetooth = 'bluetooth',
+    Accelerometer = 'accelerometer',
+    Gyroscope = 'gyroscope',
+    Magnetometer = 'magnetometer',
+    Ambientlightsensor = 'ambient-light-sensor',
+    Backgroundsync = 'background-sync',
+    Persistentstorage = 'persistent-storage',
+    Screenwakelock = 'screen-wake-lock',
+    Webshare = 'web-share',
+    Xrspatialtracking = 'xr-spatial-tracking',
+}

package/src/enums/deployment-status.ts

@@ -3,5 +3,6 @@ export enum DeploymentStatus {
     Processing = 'processing',
     Building = 'building',
     Ready = 'ready',
+    Canceled = 'canceled',
     Failed = 'failed',
 }

package/src/enums/frameworks.ts

@@ -0,0 +1,17 @@
+export enum Frameworks {
+    Analog = 'analog',
+    Angular = 'angular',
+    Nextjs = 'nextjs',
+    React = 'react',
+    Nuxt = 'nuxt',
+    Vue = 'vue',
+    Sveltekit = 'sveltekit',
+    Astro = 'astro',
+    Tanstackstart = 'tanstack-start',
+    Remix = 'remix',
+    Lynx = 'lynx',
+    Flutter = 'flutter',
+    Reactnative = 'react-native',
+    Vite = 'vite',
+    Other = 'other',
+}

package/src/enums/order-by.ts

@@ -0,0 +1,4 @@
+export enum OrderBy {
+    Asc = 'asc',
+    Desc = 'desc',
+}

package/src/enums/resources.ts

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