react-native-appwrite 0.4.0 → 0.6.0

package/docs/examples/teams/get-prefs.md

@@ -2,7 +2,7 @@ import { Client, Teams } from "react-native-appwrite";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const teams = new Teams(client);
 
@@ -10,4 +10,4 @@ const result = await teams.getPrefs(
     '<TEAM_ID>' // teamId
 );
 
-console.log(response);
+console.log(result);

package/docs/examples/teams/get.md

@@ -2,7 +2,7 @@ import { Client, Teams } from "react-native-appwrite";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const teams = new Teams(client);
 
@@ -10,4 +10,4 @@ const result = await teams.get(
     '<TEAM_ID>' // teamId
 );
 
-console.log(response);
+console.log(result);

package/docs/examples/teams/list-memberships.md

@@ -2,7 +2,7 @@ import { Client, Teams } from "react-native-appwrite";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const teams = new Teams(client);
 
@@ -12,4 +12,4 @@ const result = await teams.listMemberships(
     '<SEARCH>' // search (optional)
 );
 
-console.log(response);
+console.log(result);

package/docs/examples/teams/list.md

@@ -2,7 +2,7 @@ import { Client, Teams } from "react-native-appwrite";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const teams = new Teams(client);
 
@@ -11,4 +11,4 @@ const result = await teams.list(
     '<SEARCH>' // search (optional)
 );
 
-console.log(response);
+console.log(result);

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

@@ -2,7 +2,7 @@ import { Client, Teams } from "react-native-appwrite";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const teams = new Teams(client);
 
@@ -13,4 +13,4 @@ const result = await teams.updateMembershipStatus(
     '<SECRET>' // secret
 );
 
-console.log(response);
+console.log(result);

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

@@ -2,7 +2,7 @@ import { Client, Teams } from "react-native-appwrite";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const teams = new Teams(client);
 
@@ -12,4 +12,4 @@ const result = await teams.updateMembership(
     [] // roles
 );
 
-console.log(response);
+console.log(result);

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

@@ -2,7 +2,7 @@ import { Client, Teams } from "react-native-appwrite";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const teams = new Teams(client);
 
@@ -11,4 +11,4 @@ const result = await teams.updateName(
     '<NAME>' // name
 );
 
-console.log(response);
+console.log(result);

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

@@ -2,7 +2,7 @@ import { Client, Teams } from "react-native-appwrite";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const teams = new Teams(client);
 
@@ -11,4 +11,4 @@ const result = await teams.updatePrefs(
     {} // prefs
 );
 
-console.log(response);
+console.log(result);

package/package.json

@@ -2,7 +2,7 @@
   "name": "react-native-appwrite",
   "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": "0.4.0",
+  "version": "0.6.0",
   "license": "BSD-3-Clause",
   "main": "dist/cjs/sdk.js",
   "exports": {

package/src/client.ts

@@ -49,7 +49,17 @@ type RealtimeRequestAuthenticate = {
 
 type Realtime = {
     socket?: WebSocket;
+
+    /**
+     * Timeout for reconnect operations.
+     */
     timeout?: number;
+
+    /**
+     * Heartbeat interval for the realtime connection.
+    */
+    heartbeat?: number;
+
     url?: string;
     lastMessage?: RealtimeResponse;
     channels: Set<string>;
@@ -63,6 +73,7 @@ type Realtime = {
     getTimeout: () => number;
     connect: () => void;
     createSocket: () => void;
+    createHeartbeat: () => void;
     cleanUp: (channels: string[]) => void;
     onMessage: (event: MessageEvent) => void;
 }
@@ -103,8 +114,8 @@ class Client {
         'x-sdk-name': 'React Native',
         'x-sdk-platform': 'client',
         'x-sdk-language': 'reactnative',
-        'x-sdk-version': '0.4.0',
-        'X-Appwrite-Response-Format': '1.5.0',
+        'x-sdk-version': '0.6.0',
+        'X-Appwrite-Response-Format': '1.6.0',
     };
 
     /**
@@ -212,6 +223,7 @@ class Client {
     private realtime: Realtime = {
         socket: undefined,
         timeout: undefined,
+        heartbeat: undefined,
         url: '',
         channels: new Set(),
         subscriptions: new Map(),
@@ -237,6 +249,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;
@@ -275,6 +298,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 (
@@ -428,6 +452,11 @@ class Client {
             let data = null;
             const response = await fetch(url.toString(), options);
 
+            const warnings = response.headers.get('x-appwrite-warning');
+            if (warnings) {
+                warnings.split(';').forEach((warning: string) => console.warn('Warning: ' + warning));
+            }
+
             if (response.headers.get('content-type')?.includes('application/json')) {
                 data = await response.json();
             } else {

package/src/enums/image-format.ts

@@ -4,4 +4,5 @@ export enum ImageFormat {
     Gif = 'gif',
     Png = 'png',
     Webp = 'webp',
+    Avif = 'avif',
 }

package/src/models.ts

@@ -839,11 +839,11 @@ export namespace Models {
          */
         userId: string;
         /**
-         * User name.
+         * User name. Hide this attribute by toggling membership privacy in the Console.
          */
         userName: string;
         /**
-         * User email address.
+         * User email address. Hide this attribute by toggling membership privacy in the Console.
          */
         userEmail: string;
         /**
@@ -867,7 +867,7 @@ export namespace Models {
          */
         confirm: boolean;
         /**
-         * Multi factor authentication status, true if the user has MFA enabled or false otherwise.
+         * Multi factor authentication status, true if the user has MFA enabled or false otherwise. Hide this attribute by toggling membership privacy in the Console.
          */
         mfa: boolean;
         /**
@@ -943,6 +943,10 @@ export namespace Models {
          * Function execution duration in seconds.
          */
         duration: number;
+        /**
+         * The scheduled time for execution. If left empty, execution will be queued immediately.
+         */
+        scheduledAt?: string;
     }
     /**
      * Country
@@ -1191,5 +1195,9 @@ export namespace Models {
          * The target identifier.
          */
         identifier: string;
+        /**
+         * Is the target expired.
+         */
+        expired: boolean;
     }
 }

package/src/services/account.ts

@@ -134,7 +134,7 @@ export class Account extends Service {
     }
 
     /**
-     * List Identities
+     * List identities
      *
      * Get the list of identities for the currently logged in user.
      *
@@ -192,7 +192,7 @@ export class Account extends Service {
      * @returns {Promise}
     */
     async createJWT(): Promise<Models.Jwt> {
-        const apiPath = '/account/jwt';
+        const apiPath = '/account/jwts';
         const payload: Payload = {};
 
         const uri = new URL(this.client.config.endpoint + apiPath);
@@ -253,7 +253,7 @@ export class Account extends Service {
     }
 
     /**
-     * Add Authenticator
+     * Create authenticator
      *
      * Add an authenticator app to be used as an MFA factor. Verify the
      * authenticator using the [verify
@@ -279,11 +279,11 @@ export class Account extends Service {
     }
 
     /**
-     * Verify Authenticator
+     * Verify authenticator
      *
      * Verify an authenticator app after adding it using the [add
      * authenticator](/docs/references/cloud/client-web/account#createMfaAuthenticator)
-     * method. add 
+     * method.
      *
      * @param {AuthenticatorType} type
      * @param {string} otp
@@ -313,31 +313,22 @@ export class Account extends Service {
     }
 
     /**
-     * Delete Authenticator
+     * Delete authenticator
      *
      * Delete an authenticator for a user by ID.
      *
      * @param {AuthenticatorType} type
-     * @param {string} otp
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async deleteMfaAuthenticator(type: AuthenticatorType, otp: string): Promise<{}> {
+    async deleteMfaAuthenticator(type: AuthenticatorType): Promise<{}> {
         if (typeof type === 'undefined') {
             throw new AppwriteException('Missing required parameter: "type"');
         }
 
-        if (typeof otp === 'undefined') {
-            throw new AppwriteException('Missing required parameter: "otp"');
-        }
-
         const apiPath = '/account/mfa/authenticators/{type}'.replace('{type}', type);
         const payload: Payload = {};
 
-        if (typeof otp !== 'undefined') {
-            payload['otp'] = otp;
-        }
-
         const uri = new URL(this.client.config.endpoint + apiPath);
         return await this.client.call('delete', uri, {
             'content-type': 'application/json',
@@ -345,7 +336,7 @@ export class Account extends Service {
     }
 
     /**
-     * Create 2FA Challenge
+     * Create MFA challenge
      *
      * Begin the process of MFA verification after sign-in. Finish the flow with
      * [updateMfaChallenge](/docs/references/cloud/client-web/account#updateMfaChallenge)
@@ -374,7 +365,7 @@ export class Account extends Service {
     }
 
     /**
-     * Create MFA Challenge (confirmation)
+     * Create MFA challenge (confirmation)
      *
      * Complete the MFA challenge by providing the one-time password. Finish the
      * process of MFA verification by providing the one-time password. To begin
@@ -414,7 +405,7 @@ export class Account extends Service {
     }
 
     /**
-     * List Factors
+     * List factors
      *
      * List the factors available on the account to be used as a MFA challange.
      *
@@ -432,7 +423,7 @@ export class Account extends Service {
     }
 
     /**
-     * Get MFA Recovery Codes
+     * Get MFA recovery codes
      *
      * Get recovery codes that can be used as backup for MFA flow. Before getting
      * codes, they must be generated using
@@ -453,7 +444,7 @@ export class Account extends Service {
     }
 
     /**
-     * Create MFA Recovery Codes
+     * Create MFA recovery codes
      *
      * Generate recovery codes as backup for MFA flow. It's recommended to
      * generate and show then immediately after user successfully adds their
@@ -475,7 +466,7 @@ export class Account extends Service {
     }
 
     /**
-     * Regenerate MFA Recovery Codes
+     * Regenerate MFA recovery codes
      *
      * Regenerate recovery codes that can be used as backup for MFA flow. Before
      * regenerating codes, they must be first generated using
@@ -1520,7 +1511,7 @@ export class Account extends Service {
     }
 
     /**
-     * Create phone verification (confirmation)
+     * Update phone verification (confirmation)
      *
      * Use this endpoint to complete the user phone verification process. Use the
      * **userId** and **secret** that were sent to your user's phone number to

package/src/services/avatars.ts

@@ -123,6 +123,7 @@ export class Avatars extends Service {
      * Use this endpoint to fetch the favorite icon (AKA favicon) of any remote
      * website URL.
      * 
+     * This endpoint does not follow HTTP redirects.
      *
      * @param {string} url
      * @throws {AppwriteException}
@@ -214,6 +215,7 @@ export class Avatars extends Service {
      * image at source quality. If dimensions are not specified, the default size
      * of image returned is 400x400px.
      * 
+     * This endpoint does not follow HTTP redirects.
      *
      * @param {string} url
      * @param {number} width

package/src/services/functions.ts

@@ -62,10 +62,11 @@ export class Functions extends Service {
      * @param {string} xpath
      * @param {ExecutionMethod} method
      * @param {object} headers
+     * @param {string} scheduledAt
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async createExecution(functionId: string, body?: string, async?: boolean, xpath?: string, method?: ExecutionMethod, headers?: object): Promise<Models.Execution> {
+    async createExecution(functionId: string, body?: string, async?: boolean, xpath?: string, method?: ExecutionMethod, headers?: object, scheduledAt?: string): Promise<Models.Execution> {
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
         }
@@ -93,6 +94,10 @@ export class Functions extends Service {
             payload['headers'] = headers;
         }
 
+        if (typeof scheduledAt !== 'undefined') {
+            payload['scheduledAt'] = scheduledAt;
+        }
+
         const uri = new URL(this.client.config.endpoint + apiPath);
         return await this.client.call('post', uri, {
             'content-type': 'application/json',

package/src/services/locale.ts

@@ -37,7 +37,7 @@ export class Locale extends Service {
     }
 
     /**
-     * List Locale Codes
+     * List locale codes
      *
      * List of all locale codes in [ISO
      * 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).

package/src/services/storage.ts

@@ -237,7 +237,7 @@ export class Storage extends Service {
     }
 
     /**
-     * Delete File
+     * Delete file
      *
      * Delete a file by its unique ID. Only users with write permissions have
      * access to delete this resource.

package/src/services/teams.ts

@@ -168,7 +168,8 @@ export class Teams extends Service {
      * List team memberships
      *
      * Use this endpoint to list a team's members using the team's ID. All team
-     * members have read access to this endpoint.
+     * members have read access to this endpoint. Hide sensitive attributes from
+     * the response by toggling membership privacy in the Console.
      *
      * @param {string} teamId
      * @param {string[]} queries
@@ -279,7 +280,8 @@ export class Teams extends Service {
      * Get team membership
      *
      * Get a team member by the membership unique id. All team members have read
-     * access for this resource.
+     * access for this resource. Hide sensitive attributes from the response by
+     * toggling membership privacy in the Console.
      *
      * @param {string} teamId
      * @param {string} membershipId

package/types/enums/image-format.d.ts

@@ -3,5 +3,6 @@ export declare enum ImageFormat {
     Jpeg = "jpeg",
     Gif = "gif",
     Png = "png",
-    Webp = "webp"
+    Webp = "webp",
+    Avif = "avif"
 }

package/types/models.d.ts

@@ -839,11 +839,11 @@ export declare namespace Models {
          */
         userId: string;
         /**
-         * User name.
+         * User name. Hide this attribute by toggling membership privacy in the Console.
          */
         userName: string;
         /**
-         * User email address.
+         * User email address. Hide this attribute by toggling membership privacy in the Console.
          */
         userEmail: string;
         /**
@@ -867,7 +867,7 @@ export declare namespace Models {
          */
         confirm: boolean;
         /**
-         * Multi factor authentication status, true if the user has MFA enabled or false otherwise.
+         * Multi factor authentication status, true if the user has MFA enabled or false otherwise. Hide this attribute by toggling membership privacy in the Console.
          */
         mfa: boolean;
         /**
@@ -943,6 +943,10 @@ export declare namespace Models {
          * Function execution duration in seconds.
          */
         duration: number;
+        /**
+         * The scheduled time for execution. If left empty, execution will be queued immediately.
+         */
+        scheduledAt?: string;
     };
     /**
      * Country
@@ -1191,5 +1195,9 @@ export declare namespace Models {
          * The target identifier.
          */
         identifier: string;
+        /**
+         * Is the target expired.
+         */
+        expired: boolean;
     };
 }

package/types/services/account.d.ts

@@ -53,7 +53,7 @@ export declare class Account extends Service {
     */
     updateEmail<Preferences extends Models.Preferences>(email: string, password: string): Promise<Models.User<Preferences>>;
     /**
-     * List Identities
+     * List identities
      *
      * Get the list of identities for the currently logged in user.
      *
@@ -107,7 +107,7 @@ export declare class Account extends Service {
     */
     updateMFA<Preferences extends Models.Preferences>(mfa: boolean): Promise<Models.User<Preferences>>;
     /**
-     * Add Authenticator
+     * Create authenticator
      *
      * Add an authenticator app to be used as an MFA factor. Verify the
      * authenticator using the [verify
@@ -120,11 +120,11 @@ export declare class Account extends Service {
     */
     createMfaAuthenticator(type: AuthenticatorType): Promise<Models.MfaType>;
     /**
-     * Verify Authenticator
+     * Verify authenticator
      *
      * Verify an authenticator app after adding it using the [add
      * authenticator](/docs/references/cloud/client-web/account#createMfaAuthenticator)
-     * method. add
+     * method.
      *
      * @param {AuthenticatorType} type
      * @param {string} otp
@@ -133,18 +133,17 @@ export declare class Account extends Service {
     */
     updateMfaAuthenticator<Preferences extends Models.Preferences>(type: AuthenticatorType, otp: string): Promise<Models.User<Preferences>>;
     /**
-     * Delete Authenticator
+     * Delete authenticator
      *
      * Delete an authenticator for a user by ID.
      *
      * @param {AuthenticatorType} type
-     * @param {string} otp
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    deleteMfaAuthenticator(type: AuthenticatorType, otp: string): Promise<{}>;
+    deleteMfaAuthenticator(type: AuthenticatorType): Promise<{}>;
     /**
-     * Create 2FA Challenge
+     * Create MFA challenge
      *
      * Begin the process of MFA verification after sign-in. Finish the flow with
      * [updateMfaChallenge](/docs/references/cloud/client-web/account#updateMfaChallenge)
@@ -156,7 +155,7 @@ export declare class Account extends Service {
     */
     createMfaChallenge(factor: AuthenticationFactor): Promise<Models.MfaChallenge>;
     /**
-     * Create MFA Challenge (confirmation)
+     * Create MFA challenge (confirmation)
      *
      * Complete the MFA challenge by providing the one-time password. Finish the
      * process of MFA verification by providing the one-time password. To begin
@@ -171,7 +170,7 @@ export declare class Account extends Service {
     */
     updateMfaChallenge(challengeId: string, otp: string): Promise<{}>;
     /**
-     * List Factors
+     * List factors
      *
      * List the factors available on the account to be used as a MFA challange.
      *
@@ -180,7 +179,7 @@ export declare class Account extends Service {
     */
     listMfaFactors(): Promise<Models.MfaFactors>;
     /**
-     * Get MFA Recovery Codes
+     * Get MFA recovery codes
      *
      * Get recovery codes that can be used as backup for MFA flow. Before getting
      * codes, they must be generated using
@@ -192,7 +191,7 @@ export declare class Account extends Service {
     */
     getMfaRecoveryCodes(): Promise<Models.MfaRecoveryCodes>;
     /**
-     * Create MFA Recovery Codes
+     * Create MFA recovery codes
      *
      * Generate recovery codes as backup for MFA flow. It's recommended to
      * generate and show then immediately after user successfully adds their
@@ -205,7 +204,7 @@ export declare class Account extends Service {
     */
     createMfaRecoveryCodes(): Promise<Models.MfaRecoveryCodes>;
     /**
-     * Regenerate MFA Recovery Codes
+     * Regenerate MFA recovery codes
      *
      * Regenerate recovery codes that can be used as backup for MFA flow. Before
      * regenerating codes, they must be first generated using
@@ -660,7 +659,7 @@ export declare class Account extends Service {
     */
     createPhoneVerification(): Promise<Models.Token>;
     /**
-     * Create phone verification (confirmation)
+     * Update phone verification (confirmation)
      *
      * Use this endpoint to complete the user phone verification process. Use the
      * **userId** and **secret** that were sent to your user's phone number to

package/types/services/avatars.d.ts

@@ -54,6 +54,7 @@ export declare class Avatars extends Service {
      * Use this endpoint to fetch the favorite icon (AKA favicon) of any remote
      * website URL.
      *
+     * This endpoint does not follow HTTP redirects.
      *
      * @param {string} url
      * @throws {AppwriteException}
@@ -95,6 +96,7 @@ export declare class Avatars extends Service {
      * image at source quality. If dimensions are not specified, the default size
      * of image returned is 400x400px.
      *
+     * This endpoint does not follow HTTP redirects.
      *
      * @param {string} url
      * @param {number} width

package/types/services/functions.d.ts

@@ -31,10 +31,11 @@ export declare class Functions extends Service {
      * @param {string} xpath
      * @param {ExecutionMethod} method
      * @param {object} headers
+     * @param {string} scheduledAt
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createExecution(functionId: string, body?: string, async?: boolean, xpath?: string, method?: ExecutionMethod, headers?: object): Promise<Models.Execution>;
+    createExecution(functionId: string, body?: string, async?: boolean, xpath?: string, method?: ExecutionMethod, headers?: object, scheduledAt?: string): Promise<Models.Execution>;
     /**
      * Get execution
      *