Merge pull request #32 from appwrite/dev

feat: add authPhone to organisation and project uage
appwrite · Jan 10, 2025 · 9876f42 · 9876f42
2 parents 2ee8ea8 + d31574a
commit 9876f42
Show file tree

Hide file tree

Showing 16 changed files with 174 additions and 210 deletions.
diff --git a/LICENSE b/LICENSE
@@ -1,4 +1,4 @@
-Copyright (c) 2024 Appwrite (https://appwrite.io) and individual contributors.
+Copyright (c) 2025 Appwrite (https://appwrite.io) and individual contributors.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # Appwrite Console SDK
 
 ![License](https://img.shields.io/github/license/appwrite/sdk-for-console.svg?style=flat-square)
-![Version](https://img.shields.io/badge/api%20version-1.6.0-blue.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-1.6.1-blue.svg?style=flat-square)
 [![Build Status](https://img.shields.io/travis/com/appwrite/sdk-generator?style=flat-square)](https://travis-ci.com/appwrite/sdk-generator)
 [![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite)
 [![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord)
@@ -33,7 +33,7 @@ import { Client, Account } from "@appwrite.io/console";
 To install with a CDN (content delivery network) add the following scripts to the bottom of your <body> tag, but before you use any Appwrite services:
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/@appwrite.io/console@1.4.4"></script>
+<script src="https://cdn.jsdelivr.net/npm/@appwrite.io/console@1.4.6"></script>
 ```
 
 

diff --git a/...amples/migrations/delete-firebase-auth.md → docs/examples/account/get-coupon.md b/...amples/migrations/delete-firebase-auth.md → docs/examples/account/get-coupon.md
@@ -1,11 +1,13 @@
-import { Client, Migrations } from "@appwrite.io/console";
+import { Client, Account } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
     .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
-const migrations = new Migrations(client);
+const account = new Account(client);
 
-const result = await migrations.deleteFirebaseAuth();
+const result = await account.getCoupon(
+    '<COUPON_ID>' // couponId
+);
 
 console.log(result);
diff --git a/docs/examples/account/update-payment-method.md b/docs/examples/account/update-payment-method.md
@@ -9,7 +9,7 @@ const account = new Account(client);
 const result = await account.updatePaymentMethod(
     '<PAYMENT_METHOD_ID>', // paymentMethodId
     1, // expiryMonth
-    2024 // expiryYear
+    2025 // expiryYear
 );
 
 console.log(result);
diff --git a/docs/examples/console/create-program-membership.md b/docs/examples/console/create-program-membership.md
@@ -0,0 +1,13 @@
+import { Client, Console } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const console = new Console(client);
+
+const result = await console.createProgramMembership(
+    '<PROGRAM_ID>' // programId
+);
+
+console.log(result);
diff --git a/docs/examples/migrations/create-firebase-o-auth-migration.md b/docs/examples/migrations/create-firebase-o-auth-migration.md
diff --git a/docs/examples/migrations/get-firebase-report-o-auth.md b/docs/examples/migrations/get-firebase-report-o-auth.md
diff --git a/docs/examples/migrations/list-firebase-projects.md b/docs/examples/migrations/list-firebase-projects.md
diff --git a/package.json b/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 abstract and simplify complex and repetitive development tasks behind a very simple REST API",
-  "version": "1.4.4",
+  "version": "1.4.6",
   "license": "BSD-3-Clause",
   "main": "dist/cjs/sdk.js",
   "exports": {

diff --git a/src/client.ts b/src/client.ts
@@ -19,9 +19,9 @@ type Headers = {
  */
 type RealtimeResponse = {
     /**
-     * Type of the response: 'error', 'event', 'connected', or 'response'.
+     * Type of the response: 'error', 'event', 'connected', 'pong', or 'response'.
      */
-    type: 'error' | 'event' | 'connected' | 'response';
+    type: 'error' | 'event' | 'connected' | 'response' | 'pong';
 
     /**
      * Data associated with the response based on the response type.
@@ -129,6 +129,8 @@ type RealtimeRequestAuthenticate = {
     session: string;
 }
 
+type TimeoutHandle = ReturnType<typeof setTimeout> | number;
+
 /**
  * Realtime interface representing the structure of a realtime communication object.
  */
@@ -139,9 +141,14 @@ type Realtime = {
     socket?: WebSocket;
 
     /**
-     * Timeout duration for communication operations.
+     * Timeout for reconnect operations.
      */
-    timeout?: number;
+    timeout?: TimeoutHandle;
+
+    /**
+     * Heartbeat interval for the realtime connection.
+    */
+    heartbeat?: TimeoutHandle;
 
     /**
      * URL for establishing the WebSocket connection.
@@ -196,6 +203,11 @@ type Realtime = {
      */
     createSocket: () => void;
 
+    /**
+     * Function to create a new heartbeat interval.
+     */
+    createHeartbeat: () => void;
+
     /**
      * Function to clean up resources associated with specified channels.
      *
@@ -304,7 +316,7 @@ class Client {
         'x-sdk-name': 'Console',
         'x-sdk-platform': 'console',
         'x-sdk-language': 'web',
-        'x-sdk-version': '1.4.4',
+        'x-sdk-version': '1.4.6',
         'X-Appwrite-Response-Format': '1.6.0',
     };
 
@@ -407,6 +419,7 @@ class Client {
     private realtime: Realtime = {
         socket: undefined,
         timeout: undefined,
+        heartbeat: undefined,
         url: '',
         channels: new Set(),
         subscriptions: new Map(),
@@ -432,6 +445,17 @@ class Client {
                     return 60_000;
             }
         },
+        createHeartbeat: () => {
+            if (this.realtime.heartbeat) {
+                clearTimeout(this.realtime.heartbeat);
+            }
+
+            this.realtime.heartbeat = window?.setInterval(() => {
+                this.realtime.socket?.send(JSON.stringify({
+                    type: 'ping'
+                }));
+            }, 20_000);
+        },
         createSocket: () => {
             if (this.realtime.channels.size < 1) {
                 this.realtime.reconnect = false;
@@ -465,6 +489,7 @@ class Client {
                 this.realtime.socket.addEventListener('message', this.realtime.onMessage);
                 this.realtime.socket.addEventListener('open', _event => {
                     this.realtime.reconnectAttempts = 0;
+                    this.realtime.createHeartbeat();
                 });
                 this.realtime.socket.addEventListener('close', event => {
                     if (

diff --git a/src/enums/runtime.ts b/src/enums/runtime.ts
@@ -54,4 +54,5 @@ export enum Runtime {
     Bun11 = 'bun-1.1',
     Go123 = 'go-1.23',
     Static1 = 'static-1',
+    Flutter324 = 'flutter-3.24',
 }
diff --git a/src/models.ts b/src/models.ts
@@ -496,19 +496,6 @@ export namespace Models {
          */
         migrations: Migration[];
     }
-    /**
-     * Migrations Firebase Projects List
-     */
-    export type FirebaseProjectList = {
-        /**
-         * Total number of projects documents that matched your query.
-         */
-        total: number;
-        /**
-         * List of projects.
-         */
-        projects: FirebaseProject[];
-    }
     /**
      * Specifications List
      */
@@ -1941,7 +1928,7 @@ export namespace Models {
          */
         events: string[];
         /**
-         * Function execution schedult in CRON format.
+         * Function execution schedule in CRON format.
          */
         schedule: string;
         /**
@@ -3110,7 +3097,7 @@ export namespace Models {
         /**
          * Resource ID.
          */
-        resourceId: string;
+        resourceId?: string;
         /**
          * Resource name.
          */
@@ -3119,6 +3106,10 @@ export namespace Models {
          * The value of this metric at the timestamp.
          */
         value: number;
+        /**
+         * The estimated value of this metric at the end of the period.
+         */
+        estimate?: number;
     }
     /**
      * UsageDatabases
@@ -3556,6 +3547,18 @@ export namespace Models {
          * Aggregated breakdown in totals of functions storage size (in bytes).
          */
         functionsStorageBreakdown: MetricBreakdown[];
+        /**
+         * Total aggregated number of phone auth.
+         */
+        authPhoneTotal: number;
+        /**
+         * Estimated total aggregated cost of phone auth.
+         */
+        authPhoneEstimate: number;
+        /**
+         * Aggregated breakdown in totals of phone auth by country.
+         */
+        authPhoneCountryBreakdown: MetricBreakdown[];
     }
     /**
      * Headers
@@ -4086,19 +4089,6 @@ export namespace Models {
          */
         version: string;
     }
-    /**
-     * MigrationFirebaseProject
-     */
-    export type FirebaseProject = {
-        /**
-         * Project ID.
-         */
-        projectId: string;
-        /**
-         * Project display name.
-         */
-        displayName: string;
-    }
     /**
      * AdditionalResource
      */
@@ -4319,6 +4309,10 @@ export namespace Models {
          * Plan name
          */
         name: string;
+        /**
+         * Plan order
+         */
+        order: number;
         /**
          * Price
          */
@@ -4411,6 +4405,26 @@ export namespace Models {
          * Can user change the plan themselves
          */
         selfService: boolean;
+        /**
+         * Does plan enable premium support
+         */
+        premiumSupport: boolean;
+        /**
+         * Does plan support budget cap
+         */
+        budgeting: boolean;
+        /**
+         * Does plan support mock numbers
+         */
+        supportsMockNumbers: boolean;
+        /**
+         * Does plan support backup policies.
+         */
+        backupsEnabled: boolean;
+        /**
+         * How many policies does plan support
+         */
+        backupPolicies: number;
     }
     /**
      * Campaign
@@ -4692,7 +4706,7 @@ export namespace Models {
         /**
          * Project budget limit
          */
-        budgetAlerts: string[];
+        budgetAlerts: number[];
         /**
          * Billing plan selected. Can be one of `tier-0`, `tier-1` or `tier-2`.
          */
@@ -5068,6 +5082,14 @@ export namespace Models {
          * Aggregated stats for total storage.
          */
         storageTotal: number;
+        /**
+         * Aggregated stats for total phone authentication SMS.
+         */
+        authPhoneTotal: number;
+        /**
+         * Aggregated stats for estimated phone authentication SMS cost.
+         */
+        authPhoneEstimate: number;
         /**
          * Aggregated stats for each projects.
          */
@@ -5105,6 +5127,14 @@ export namespace Models {
          * Aggregated stats for number of documents.
          */
         storage: number;
+        /**
+         * Aggregated stats for phone authentication.
+         */
+        authPhoneTotal: number;
+        /**
+         * Aggregated stats for phone authentication estimated cost.
+         */
+        authPhoneEstimate: number;
     }
     /**
      * Aggregation team list