@appwrite.io/console 0.1.0 → 0.2.0

package/src/services/health.ts

@@ -49,7 +49,7 @@ export class Health extends Service {
         /**
          * Get Cache
          *
-         * Check the Appwrite in-memory cache server is up and connection is
+         * Check the Appwrite in-memory cache servers are up and connection is
          * successful.
          *
          * @throws {AppwriteException}
@@ -68,7 +68,7 @@ export class Health extends Service {
         /**
          * Get DB
          *
-         * Check the Appwrite database server is up and connection is successful.
+         * Check the Appwrite database servers are up and connection is successful.
          *
          * @throws {AppwriteException}
          * @returns {Promise}
@@ -83,6 +83,43 @@ export class Health extends Service {
             }, payload);
         }
 
+        /**
+         * Get PubSub
+         *
+         * Check the Appwrite pub-sub servers are up and connection is successful.
+         *
+         * @throws {AppwriteException}
+         * @returns {Promise}
+         */
+        async getPubSub(): Promise<Models.HealthStatus> {
+            let path = '/health/pubsub';
+            let payload: Payload = {};
+
+            const uri = new URL(this.client.config.endpoint + path);
+            return await this.client.call('get', uri, {
+                'content-type': 'application/json',
+            }, payload);
+        }
+
+        /**
+         * Get Queue
+         *
+         * Check the Appwrite queue messaging servers are up and connection is
+         * successful.
+         *
+         * @throws {AppwriteException}
+         * @returns {Promise}
+         */
+        async getQueue(): Promise<Models.HealthStatus> {
+            let path = '/health/queue';
+            let payload: Payload = {};
+
+            const uri = new URL(this.client.config.endpoint + path);
+            return await this.client.call('get', uri, {
+                'content-type': 'application/json',
+            }, payload);
+        }
+
         /**
          * Get Certificates Queue
          *

package/src/services/project.ts

@@ -0,0 +1,34 @@
+import { Service } from '../service';
+import { AppwriteException, Client } from '../client';
+import type { Models } from '../models';
+import type { UploadProgress, Payload } from '../client';
+
+export class Project extends Service {
+
+     constructor(client: Client)
+     {
+        super(client);
+     }
+
+        /**
+         * Get usage stats for a project
+         *
+         *
+         * @param {string} range
+         * @throws {AppwriteException}
+         * @returns {Promise}
+         */
+        async getUsage(range?: string): Promise<Models.UsageProject> {
+            let path = '/project/usage';
+            let payload: Payload = {};
+
+            if (typeof range !== 'undefined') {
+                payload['range'] = range;
+            }
+
+            const uri = new URL(this.client.config.endpoint + path);
+            return await this.client.call('get', uri, {
+                'content-type': 'application/json',
+            }, payload);
+        }
+};

package/src/services/projects.ts

@@ -1024,33 +1024,6 @@ export class Projects extends Service {
             }, payload);
         }
 
-        /**
-         * Get usage stats for a project
-         *
-         *
-         * @param {string} projectId
-         * @param {string} range
-         * @throws {AppwriteException}
-         * @returns {Promise}
-         */
-        async getUsage(projectId: string, range?: string): Promise<Models.UsageProject> {
-            if (typeof projectId === 'undefined') {
-                throw new AppwriteException('Missing required parameter: "projectId"');
-            }
-
-            let path = '/projects/{projectId}/usage'.replace('{projectId}', projectId);
-            let payload: Payload = {};
-
-            if (typeof range !== 'undefined') {
-                payload['range'] = range;
-            }
-
-            const uri = new URL(this.client.config.endpoint + path);
-            return await this.client.call('get', uri, {
-                'content-type': 'application/json',
-            }, payload);
-        }
-
         /**
          * List Webhooks
          *

package/src/services/storage.ts

@@ -663,7 +663,7 @@ export class Storage extends Service {
         }
 
         /**
-         * Get usage stats for a storage bucket
+         * Get usage stats for storage bucket
          *
          *
          * @param {string} bucketId

package/src/services/users.ts

@@ -539,11 +539,10 @@ export class Users extends Service {
          *
          *
          * @param {string} range
-         * @param {string} provider
          * @throws {AppwriteException}
          * @returns {Promise}
          */
-        async getUsage(range?: string, provider?: string): Promise<Models.UsageUsers> {
+        async getUsage(range?: string): Promise<Models.UsageUsers> {
             let path = '/users/usage';
             let payload: Payload = {};
 
@@ -551,10 +550,6 @@ export class Users extends Service {
                 payload['range'] = range;
             }
 
-            if (typeof provider !== 'undefined') {
-                payload['provider'] = provider;
-            }
-
             const uri = new URL(this.client.config.endpoint + path);
             return await this.client.call('get', uri, {
                 'content-type': 'application/json',

package/types/index.d.ts

@@ -1,11 +1,13 @@
 export { Client, Query, AppwriteException } from './client';
 export { Account } from './services/account';
 export { Avatars } from './services/avatars';
+export { Console } from './services/console';
 export { Databases } from './services/databases';
 export { Functions } from './services/functions';
 export { Graphql } from './services/graphql';
 export { Health } from './services/health';
 export { Locale } from './services/locale';
+export { Project } from './services/project';
 export { Projects } from './services/projects';
 export { Storage } from './services/storage';
 export { Teams } from './services/teams';

package/types/models.d.ts

@@ -1082,6 +1082,59 @@ export declare namespace Models {
          */
         threads: number;
     };
+    /**
+     * Account
+     */
+    type Account<Preferences extends Models.Preferences> = {
+        /**
+         * User ID.
+         */
+        $id: string;
+        /**
+         * User creation date in ISO 8601 format.
+         */
+        $createdAt: string;
+        /**
+         * User update date in ISO 8601 format.
+         */
+        $updatedAt: string;
+        /**
+         * User name.
+         */
+        name: string;
+        /**
+         * User registration date in ISO 8601 format.
+         */
+        registration: string;
+        /**
+         * User status. Pass `true` for enabled and `false` for disabled.
+         */
+        status: boolean;
+        /**
+         * Password update time in ISO 8601 format.
+         */
+        passwordUpdate: string;
+        /**
+         * User email address.
+         */
+        email: string;
+        /**
+         * User phone number in E.164 format.
+         */
+        phone: string;
+        /**
+         * Email verification status.
+         */
+        emailVerification: boolean;
+        /**
+         * Phone verification status.
+         */
+        phoneVerification: boolean;
+        /**
+         * User preferences as a key-value object
+         */
+        prefs: Preferences;
+    };
     /**
      * Preferences
      */
@@ -1492,14 +1545,6 @@ export declare namespace Models {
          * Function execution schedult in CRON format.
          */
         schedule: string;
-        /**
-         * Function&#039;s next scheduled execution time in ISO 8601 format.
-         */
-        scheduleNext: string;
-        /**
-         * Function&#039;s previous scheduled execution time in ISO 8601 format.
-         */
-        schedulePrevious: string;
         /**
          * Function execution timeout in seconds.
          */
@@ -2150,6 +2195,10 @@ export declare namespace Models {
      * Health Status
      */
     type HealthStatus = {
+        /**
+         * Name of the service.
+         */
+        name: string;
         /**
          * Duration in milliseconds how long the health check took.
          */
@@ -2200,63 +2249,15 @@ export declare namespace Models {
         /**
          * Aggregated stats for total number of documents.
          */
-        databasesCount: Metric[];
-        /**
-         * Aggregated stats for total number of documents.
-         */
-        documentsCount: Metric[];
-        /**
-         * Aggregated stats for total number of collections.
-         */
-        collectionsCount: Metric[];
-        /**
-         * Aggregated stats for documents created.
-         */
-        databasesCreate: Metric[];
-        /**
-         * Aggregated stats for documents read.
-         */
-        databasesRead: Metric[];
-        /**
-         * Aggregated stats for documents updated.
-         */
-        databasesUpdate: Metric[];
+        databasesTotal: Metric[];
         /**
          * Aggregated stats for total number of collections.
          */
-        databasesDelete: Metric[];
-        /**
-         * Aggregated stats for documents created.
-         */
-        documentsCreate: Metric[];
-        /**
-         * Aggregated stats for documents read.
-         */
-        documentsRead: Metric[];
-        /**
-         * Aggregated stats for documents updated.
-         */
-        documentsUpdate: Metric[];
-        /**
-         * Aggregated stats for documents deleted.
-         */
-        documentsDelete: Metric[];
+        collectionsTotal: Metric[];
         /**
-         * Aggregated stats for collections created.
-         */
-        collectionsCreate: Metric[];
-        /**
-         * Aggregated stats for collections read.
-         */
-        collectionsRead: Metric[];
-        /**
-         * Aggregated stats for collections updated.
-         */
-        collectionsUpdate: Metric[];
-        /**
-         * Aggregated stats for collections delete.
+         * Aggregated stats for total number of documents.
          */
-        collectionsDelete: Metric[];
+        documentsTotal: Metric[];
     };
     /**
      * UsageDatabase
@@ -2266,46 +2267,14 @@ export declare namespace Models {
          * The time range of the usage stats.
          */
         range: string;
-        /**
-         * Aggregated stats for total number of documents.
-         */
-        documentsCount: Metric[];
         /**
          * Aggregated stats for total number of collections.
          */
-        collectionsCount: Metric[];
+        collectionsTotal: Metric[];
         /**
-         * Aggregated stats for documents created.
-         */
-        documentsCreate: Metric[];
-        /**
-         * Aggregated stats for documents read.
-         */
-        documentsRead: Metric[];
-        /**
-         * Aggregated stats for documents updated.
-         */
-        documentsUpdate: Metric[];
-        /**
-         * Aggregated stats for documents deleted.
-         */
-        documentsDelete: Metric[];
-        /**
-         * Aggregated stats for collections created.
-         */
-        collectionsCreate: Metric[];
-        /**
-         * Aggregated stats for collections read.
-         */
-        collectionsRead: Metric[];
-        /**
-         * Aggregated stats for collections updated.
-         */
-        collectionsUpdate: Metric[];
-        /**
-         * Aggregated stats for collections delete.
+         * Aggregated stats for total number of documents.
          */
-        collectionsDelete: Metric[];
+        documentsTotal: Metric[];
     };
     /**
      * UsageCollection
@@ -2318,23 +2287,7 @@ export declare namespace Models {
         /**
          * Aggregated stats for total number of documents.
          */
-        documentsCount: Metric[];
-        /**
-         * Aggregated stats for documents created.
-         */
-        documentsCreate: Metric[];
-        /**
-         * Aggregated stats for documents read.
-         */
-        documentsRead: Metric[];
-        /**
-         * Aggregated stats for documents updated.
-         */
-        documentsUpdate: Metric[];
-        /**
-         * Aggregated stats for documents deleted.
-         */
-        documentsDelete: Metric[];
+        documentsTotal: Metric[];
     };
     /**
      * UsageUsers
@@ -2347,35 +2300,11 @@ export declare namespace Models {
         /**
          * Aggregated stats for total number of users.
          */
-        usersCount: Metric[];
-        /**
-         * Aggregated stats for users created.
-         */
-        usersCreate: Metric[];
-        /**
-         * Aggregated stats for users read.
-         */
-        usersRead: Metric[];
-        /**
-         * Aggregated stats for users updated.
-         */
-        usersUpdate: Metric[];
-        /**
-         * Aggregated stats for users deleted.
-         */
-        usersDelete: Metric[];
+        usersTotal: Metric[];
         /**
          * Aggregated stats for sessions created.
          */
-        sessionsCreate: Metric[];
-        /**
-         * Aggregated stats for sessions created for a provider ( email, anonymous or oauth2 ).
-         */
-        sessionsProviderCreate: Metric[];
-        /**
-         * Aggregated stats for sessions deleted.
-         */
-        sessionsDelete: Metric[];
+        sessionsTotal: Metric[];
     };
     /**
      * StorageUsage
@@ -2385,50 +2314,18 @@ export declare namespace Models {
          * The time range of the usage stats.
          */
         range: string;
-        /**
-         * Aggregated stats for the occupied storage size (in bytes).
-         */
-        storage: Metric[];
-        /**
-         * Aggregated stats for total number of files.
-         */
-        filesCount: Metric[];
         /**
          * Aggregated stats for total number of buckets.
          */
-        bucketsCount: Metric[];
-        /**
-         * Aggregated stats for buckets created.
-         */
-        bucketsCreate: Metric[];
-        /**
-         * Aggregated stats for buckets read.
-         */
-        bucketsRead: Metric[];
+        bucketsTotal: Metric[];
         /**
-         * Aggregated stats for buckets updated.
-         */
-        bucketsUpdate: Metric[];
-        /**
-         * Aggregated stats for buckets deleted.
-         */
-        bucketsDelete: Metric[];
-        /**
-         * Aggregated stats for files created.
-         */
-        filesCreate: Metric[];
-        /**
-         * Aggregated stats for files read.
-         */
-        filesRead: Metric[];
-        /**
-         * Aggregated stats for files updated.
+         * Aggregated stats for total number of files.
          */
-        filesUpdate: Metric[];
+        filesTotal: Metric[];
         /**
-         * Aggregated stats for files deleted.
+         * Aggregated stats for the occupied storage size (in bytes).
          */
-        filesDelete: Metric[];
+        filesStorage: Metric[];
     };
     /**
      * UsageBuckets
@@ -2441,27 +2338,11 @@ export declare namespace Models {
         /**
          * Aggregated stats for total number of files in this bucket.
          */
-        filesCount: Metric[];
+        filesTotal: Metric[];
         /**
          * Aggregated stats for total storage of files in this bucket.
          */
         filesStorage: Metric[];
-        /**
-         * Aggregated stats for files created.
-         */
-        filesCreate: Metric[];
-        /**
-         * Aggregated stats for files read.
-         */
-        filesRead: Metric[];
-        /**
-         * Aggregated stats for files updated.
-         */
-        filesUpdate: Metric[];
-        /**
-         * Aggregated stats for files deleted.
-         */
-        filesDelete: Metric[];
     };
     /**
      * UsageFunctions
@@ -2472,37 +2353,37 @@ export declare namespace Models {
          */
         range: string;
         /**
-         * Aggregated stats for number of function executions.
-         */
-        executionsTotal: Metric[];
-        /**
-         * Aggregated stats for function execution failures.
+         * Aggregated stats for number of functions.
          */
-        executionsFailure: Metric[];
+        functionsTotal: Metric[];
         /**
-         * Aggregated stats for function execution successes.
+         * Aggregated stats for number of function deployments.
          */
-        executionsSuccess: Metric[];
+        deploymentsTotal: Metric[];
         /**
-         * Aggregated stats for function execution duration.
+         * Aggregated stats for function deployments storage.
          */
-        executionsTime: Metric[];
+        deploymentsStorage: Metric[];
         /**
          * Aggregated stats for number of function builds.
          */
         buildsTotal: Metric[];
         /**
-         * Aggregated stats for function build failures.
+         * Aggregated stats for builds  storage.
          */
-        buildsFailure: Metric[];
+        buildsStorage: Metric[];
         /**
-         * Aggregated stats for function build successes.
+         * Aggregated stats for function build compute.
          */
-        buildsSuccess: Metric[];
+        buildsTime: Metric[];
         /**
-         * Aggregated stats for function build duration.
+         * Aggregated stats for number of function executions.
          */
-        buildsTime: Metric[];
+        executionsTotal: Metric[];
+        /**
+         * Aggregated stats for function execution compute.
+         */
+        executionsTime: Metric[];
     };
     /**
      * UsageProject
@@ -2515,7 +2396,7 @@ export declare namespace Models {
         /**
          * Aggregated stats for number of requests.
          */
-        requests: Metric[];
+        requestsTotal: Metric[];
         /**
          * Aggregated stats for consumed bandwidth.
          */
@@ -2523,26 +2404,47 @@ export declare namespace Models {
         /**
          * Aggregated stats for function executions.
          */
-        executions: Metric[];
+        executionsTotal: Metric[];
         /**
          * Aggregated stats for number of documents.
          */
-        documents: Metric[];
+        documentsTotal: Metric[];
         /**
          * Aggregated stats for number of databases.
          */
-        databases: Metric[];
+        databasesTotal: Metric[];
         /**
          * Aggregated stats for number of users.
          */
-        users: Metric[];
+        usersTotal: Metric[];
         /**
          * Aggregated stats for the occupied storage size (in bytes).
          */
-        storage: Metric[];
+        filesStorage: Metric[];
         /**
          * Aggregated stats for number of buckets.
          */
-        buckets: Metric[];
+        bucketsTotal: Metric[];
+    };
+    /**
+     * Console Variables
+     */
+    type ConsoleVariables = {
+        /**
+         * CNAME target for your Appwrite custom domains.
+         */
+        _APP_DOMAIN_TARGET: string;
+        /**
+         * Maximum file size allowed for file upload in bytes.
+         */
+        _APP_STORAGE_LIMIT: number;
+        /**
+         * Maximum file size allowed for deployment in bytes.
+         */
+        _APP_FUNCTIONS_SIZE_LIMIT: number;
+        /**
+         * Defines if usage stats are enabled. This value is set to &#039;enabled&#039; by default, to disable the usage stats set the value to &#039;disabled&#039;.
+         */
+        _APP_USAGE_STATS: string;
     };
 }

package/types/query.d.ts

@@ -8,6 +8,12 @@ export declare class Query {
     static lessThanEqual: (attribute: string, value: QueryTypes) => string;
     static greaterThan: (attribute: string, value: QueryTypes) => string;
     static greaterThanEqual: (attribute: string, value: QueryTypes) => string;
+    static isNull: (attribute: string) => string;
+    static isNotNull: (attribute: string) => string;
+    static between: (attribute: string, start: string | number, end: string | number) => string;
+    static startsWith: (attribute: string, value: string) => string;
+    static endsWith: (attribute: string, value: string) => string;
+    static select: (attributes: string[]) => string;
     static search: (attribute: string, value: string) => string;
     static orderDesc: (attribute: string) => string;
     static orderAsc: (attribute: string) => string;

package/types/services/account.d.ts

@@ -48,6 +48,25 @@ export declare class Account extends Service {
      * @returns {Promise}
      */
     updateEmail<Preferences extends Models.Preferences>(email: string, password: string): Promise<Models.User<Preferences>>;
+    /**
+     * Create account using an invite code
+     *
+     * Use this endpoint to allow a new user to register a new account in your
+     * project. After the user registration completes successfully, you can use
+     * the [/account/verfication](/docs/client/account#accountCreateVerification)
+     * route to start verifying the user email address. To allow the new user to
+     * login to their new account, you need to create a new [account
+     * session](/docs/client/account#accountCreateSession).
+     *
+     * @param {string} userId
+     * @param {string} email
+     * @param {string} password
+     * @param {string} name
+     * @param {string} code
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    createWithInviteCode<Preferences extends Models.Preferences>(userId: string, email: string, password: string, name?: string, code?: string): Promise<Models.Account<Preferences>>;
     /**
      * Create JWT
      *