@appwrite.io/console 0.6.0-rc.14 → 0.6.0-rc.16

package/dist/iife/sdk.js

@@ -115,7 +115,7 @@
                 'x-sdk-name': 'Console',
                 'x-sdk-platform': 'console',
                 'x-sdk-language': 'web',
-                'x-sdk-version': '0.6.0-rc.14',
+                'x-sdk-version': '0.6.0-rc.16',
                 'X-Appwrite-Response-Format': '1.5.0',
             };
             this.realtime = {
@@ -690,15 +690,103 @@
                 }, payload);
             });
         }
+        /**
+         * Add Authenticator
+         *
+         * Add an authenticator app to be used as an MFA factor. Verify the
+         * authenticator using the [verify
+         * authenticator](/docs/references/cloud/client-web/account#verifyAuthenticator)
+         * method.
+         *
+         * @param {AuthenticatorType} type
+         * @throws {AppwriteException}
+         * @returns {Promise}
+        */
+        createMfaAuthenticator(type) {
+            return __awaiter(this, void 0, void 0, function* () {
+                if (typeof type === 'undefined') {
+                    throw new AppwriteException('Missing required parameter: "type"');
+                }
+                const apiPath = '/account/mfa/authenticators/{type}'.replace('{type}', type);
+                const payload = {};
+                const uri = new URL(this.client.config.endpoint + apiPath);
+                return yield this.client.call('post', uri, {
+                    'content-type': 'application/json',
+                }, payload);
+            });
+        }
+        /**
+         * Verify Authenticator
+         *
+         * Verify an authenticator app after adding it using the [add
+         * authenticator](/docs/references/cloud/client-web/account#addAuthenticator)
+         * method.
+         *
+         * @param {AuthenticatorType} type
+         * @param {string} otp
+         * @throws {AppwriteException}
+         * @returns {Promise}
+        */
+        updateMfaAuthenticator(type, otp) {
+            return __awaiter(this, void 0, void 0, function* () {
+                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 = {};
+                if (typeof otp !== 'undefined') {
+                    payload['otp'] = otp;
+                }
+                const uri = new URL(this.client.config.endpoint + apiPath);
+                return yield this.client.call('put', uri, {
+                    'content-type': 'application/json',
+                }, payload);
+            });
+        }
+        /**
+         * Delete Authenticator
+         *
+         * Delete an authenticator for a user by ID.
+         *
+         * @param {AuthenticatorType} type
+         * @param {string} otp
+         * @throws {AppwriteException}
+         * @returns {Promise}
+        */
+        deleteMfaAuthenticator(type, otp) {
+            return __awaiter(this, void 0, void 0, function* () {
+                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 = {};
+                if (typeof otp !== 'undefined') {
+                    payload['otp'] = otp;
+                }
+                const uri = new URL(this.client.config.endpoint + apiPath);
+                return yield this.client.call('delete', uri, {
+                    'content-type': 'application/json',
+                }, payload);
+            });
+        }
         /**
          * Create 2FA Challenge
          *
+         * Begin the process of MFA verification after sign-in. Finish the flow with
+         * [updateMfaChallenge](/docs/references/cloud/client-web/account#updateMfaChallenge)
+         * method.
          *
          * @param {AuthenticationFactor} factor
          * @throws {AppwriteException}
          * @returns {Promise}
         */
-        createChallenge(factor) {
+        createMfaChallenge(factor) {
             return __awaiter(this, void 0, void 0, function* () {
                 if (typeof factor === 'undefined') {
                     throw new AppwriteException('Missing required parameter: "factor"');
@@ -717,14 +805,18 @@
         /**
          * Create MFA Challenge (confirmation)
          *
-         * Complete the MFA challenge by providing the one-time password.
+         * Complete the MFA challenge by providing the one-time password. Finish the
+         * process of MFA verification by providing the one-time password. To begin
+         * the flow, use
+         * [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge)
+         * method.
          *
          * @param {string} challengeId
          * @param {string} otp
          * @throws {AppwriteException}
          * @returns {Promise}
         */
-        updateChallenge(challengeId, otp) {
+        updateMfaChallenge(challengeId, otp) {
             return __awaiter(this, void 0, void 0, function* () {
                 if (typeof challengeId === 'undefined') {
                     throw new AppwriteException('Missing required parameter: "challengeId"');
@@ -754,7 +846,7 @@
          * @throws {AppwriteException}
          * @returns {Promise}
         */
-        listFactors() {
+        listMfaFactors() {
             return __awaiter(this, void 0, void 0, function* () {
                 const apiPath = '/account/mfa/factors';
                 const payload = {};
@@ -765,86 +857,65 @@
             });
         }
         /**
-         * Add Authenticator
+         * Get MFA Recovery Codes
          *
-         * Add an authenticator app to be used as an MFA factor. Verify the
-         * authenticator using the [verify
-         * authenticator](/docs/references/cloud/client-web/account#verifyAuthenticator)
-         * method.
+         * Get recovery codes that can be used as backup for MFA flow. Before getting
+         * codes, they must be generated using
+         * [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes)
+         * method. An OTP challenge is required to read recovery codes.
          *
-         * @param {AuthenticatorType} type
          * @throws {AppwriteException}
          * @returns {Promise}
         */
-        addAuthenticator(type) {
+        getMfaRecoveryCodes() {
             return __awaiter(this, void 0, void 0, function* () {
-                if (typeof type === 'undefined') {
-                    throw new AppwriteException('Missing required parameter: "type"');
-                }
-                const apiPath = '/account/mfa/{type}'.replace('{type}', type);
+                const apiPath = '/account/mfa/recovery-codes';
                 const payload = {};
                 const uri = new URL(this.client.config.endpoint + apiPath);
-                return yield this.client.call('post', uri, {
+                return yield this.client.call('get', uri, {
                     'content-type': 'application/json',
                 }, payload);
             });
         }
         /**
-         * Verify Authenticator
+         * Create MFA Recovery Codes
          *
-         * Verify an authenticator app after adding it using the [add
-         * authenticator](/docs/references/cloud/client-web/account#addAuthenticator)
+         * Generate recovery codes as backup for MFA flow. It's recommended to
+         * generate and show then immediately after user successfully adds their
+         * authehticator. Recovery codes can be used as a MFA verification type in
+         * [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge)
          * method.
          *
-         * @param {AuthenticatorType} type
-         * @param {string} otp
          * @throws {AppwriteException}
          * @returns {Promise}
         */
-        verifyAuthenticator(type, otp) {
+        createMfaRecoveryCodes() {
             return __awaiter(this, void 0, void 0, function* () {
-                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/{type}'.replace('{type}', type);
+                const apiPath = '/account/mfa/recovery-codes';
                 const payload = {};
-                if (typeof otp !== 'undefined') {
-                    payload['otp'] = otp;
-                }
                 const uri = new URL(this.client.config.endpoint + apiPath);
-                return yield this.client.call('put', uri, {
+                return yield this.client.call('post', uri, {
                     'content-type': 'application/json',
                 }, payload);
             });
         }
         /**
-         * Delete Authenticator
+         * Regenerate MFA Recovery Codes
          *
-         * Delete an authenticator for a user by ID.
+         * Regenerate recovery codes that can be used as backup for MFA flow. Before
+         * regenerating codes, they must be first generated using
+         * [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes)
+         * method. An OTP challenge is required to regenreate recovery codes.
          *
-         * @param {AuthenticatorType} type
-         * @param {string} otp
          * @throws {AppwriteException}
          * @returns {Promise}
         */
-        deleteAuthenticator(type, otp) {
+        updateMfaRecoveryCodes() {
             return __awaiter(this, void 0, void 0, function* () {
-                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/{type}'.replace('{type}', type);
+                const apiPath = '/account/mfa/recovery-codes';
                 const payload = {};
-                if (typeof otp !== 'undefined') {
-                    payload['otp'] = otp;
-                }
                 const uri = new URL(this.client.config.endpoint + apiPath);
-                return yield this.client.call('delete', uri, {
+                return yield this.client.call('patch', uri, {
                     'content-type': 'application/json',
                 }, payload);
             });
@@ -1352,10 +1423,11 @@
             });
         }
         /**
-         * Update (or renew) session
+         * Update session
          *
-         * Extend session's expiry to increase it's lifespan. Extending a session is
-         * useful when session length is short such as 5 minutes.
+         * Use this endpoint to extend a session's length. Extending a session is
+         * useful when session expiry is short. If the session was created using an
+         * OAuth provider, this endpoint refreshes the access token from the provider.
          *
          * @param {string} sessionId
          * @throws {AppwriteException}
@@ -11675,6 +11747,32 @@
                 }, payload);
             });
         }
+        /**
+         * Delete Authenticator
+         *
+         * Delete an authenticator app.
+         *
+         * @param {string} userId
+         * @param {Type} type
+         * @throws {AppwriteException}
+         * @returns {Promise}
+        */
+        deleteMfaAuthenticator(userId, type) {
+            return __awaiter(this, void 0, void 0, function* () {
+                if (typeof userId === 'undefined') {
+                    throw new AppwriteException('Missing required parameter: "userId"');
+                }
+                if (typeof type === 'undefined') {
+                    throw new AppwriteException('Missing required parameter: "type"');
+                }
+                const apiPath = '/users/{userId}/mfa/authenticators/{type}'.replace('{userId}', userId).replace('{type}', type);
+                const payload = {};
+                const uri = new URL(this.client.config.endpoint + apiPath);
+                return yield this.client.call('delete', uri, {
+                    'content-type': 'application/json',
+                }, payload);
+            });
+        }
         /**
          * List Factors
          *
@@ -11684,7 +11782,7 @@
          * @throws {AppwriteException}
          * @returns {Promise}
         */
-        listFactors(userId) {
+        listMfaFactors(userId) {
             return __awaiter(this, void 0, void 0, function* () {
                 if (typeof userId === 'undefined') {
                     throw new AppwriteException('Missing required parameter: "userId"');
@@ -11698,27 +11796,76 @@
             });
         }
         /**
-         * Delete Authenticator
+         * Get MFA Recovery Codes
          *
-         * Delete an authenticator app.
+         * Get recovery codes that can be used as backup for MFA flow by User ID.
+         * Before getting codes, they must be generated using
+         * [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes)
+         * method.
          *
          * @param {string} userId
-         * @param {AuthenticatorType} type
          * @throws {AppwriteException}
          * @returns {Promise}
         */
-        deleteAuthenticator(userId, type) {
+        getMfaRecoveryCodes(userId) {
             return __awaiter(this, void 0, void 0, function* () {
                 if (typeof userId === 'undefined') {
                     throw new AppwriteException('Missing required parameter: "userId"');
                 }
-                if (typeof type === 'undefined') {
-                    throw new AppwriteException('Missing required parameter: "type"');
+                const apiPath = '/users/{userId}/mfa/recovery-codes'.replace('{userId}', userId);
+                const payload = {};
+                const uri = new URL(this.client.config.endpoint + apiPath);
+                return yield this.client.call('get', uri, {
+                    'content-type': 'application/json',
+                }, payload);
+            });
+        }
+        /**
+         * Regenerate MFA Recovery Codes
+         *
+         * Regenerate recovery codes that can be used as backup for MFA flow by User
+         * ID. Before regenerating codes, they must be first generated using
+         * [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes)
+         * method.
+         *
+         * @param {string} userId
+         * @throws {AppwriteException}
+         * @returns {Promise}
+        */
+        updateMfaRecoveryCodes(userId) {
+            return __awaiter(this, void 0, void 0, function* () {
+                if (typeof userId === 'undefined') {
+                    throw new AppwriteException('Missing required parameter: "userId"');
                 }
-                const apiPath = '/users/{userId}/mfa/{type}'.replace('{userId}', userId).replace('{type}', type);
+                const apiPath = '/users/{userId}/mfa/recovery-codes'.replace('{userId}', userId);
                 const payload = {};
                 const uri = new URL(this.client.config.endpoint + apiPath);
-                return yield this.client.call('delete', uri, {
+                return yield this.client.call('put', uri, {
+                    'content-type': 'application/json',
+                }, payload);
+            });
+        }
+        /**
+         * Create MFA Recovery Codes
+         *
+         * Generate recovery codes used as backup for MFA flow for User ID. Recovery
+         * codes can be used as a MFA verification type in
+         * [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge)
+         * method by client SDK.
+         *
+         * @param {string} userId
+         * @throws {AppwriteException}
+         * @returns {Promise}
+        */
+        createMfaRecoveryCodes(userId) {
+            return __awaiter(this, void 0, void 0, function* () {
+                if (typeof userId === 'undefined') {
+                    throw new AppwriteException('Missing required parameter: "userId"');
+                }
+                const apiPath = '/users/{userId}/mfa/recovery-codes'.replace('{userId}', userId);
+                const payload = {};
+                const uri = new URL(this.client.config.endpoint + apiPath);
+                return yield this.client.call('patch', uri, {
                     'content-type': 'application/json',
                 }, payload);
             });
@@ -12616,18 +12763,19 @@
         }
     }
 
-    exports.AuthenticationFactor = void 0;
-    (function (AuthenticationFactor) {
-        AuthenticationFactor["Totp"] = "totp";
-        AuthenticationFactor["Phone"] = "phone";
-        AuthenticationFactor["Email"] = "email";
-    })(exports.AuthenticationFactor || (exports.AuthenticationFactor = {}));
-
     exports.AuthenticatorType = void 0;
     (function (AuthenticatorType) {
         AuthenticatorType["Totp"] = "totp";
     })(exports.AuthenticatorType || (exports.AuthenticatorType = {}));
 
+    exports.AuthenticationFactor = void 0;
+    (function (AuthenticationFactor) {
+        AuthenticationFactor["Email"] = "email";
+        AuthenticationFactor["Phone"] = "phone";
+        AuthenticationFactor["Totp"] = "totp";
+        AuthenticationFactor["Recoverycode"] = "recoverycode";
+    })(exports.AuthenticationFactor || (exports.AuthenticationFactor = {}));
+
     exports.OAuthProvider = void 0;
     (function (OAuthProvider) {
         OAuthProvider["Amazon"] = "amazon";
@@ -13427,6 +13575,11 @@
         UserUsageRange["NinetyDays"] = "90d";
     })(exports.UserUsageRange || (exports.UserUsageRange = {}));
 
+    exports.Type = void 0;
+    (function (Type) {
+        Type["Totp"] = "totp";
+    })(exports.Type || (exports.Type = {}));
+
     exports.MessagingProviderType = void 0;
     (function (MessagingProviderType) {
         MessagingProviderType["Email"] = "email";

package/docs/examples/account/{add-authenticator.md → create-mfa-authenticator.md}

@@ -6,7 +6,7 @@ const client = new Client()
 
 const account = new Account(client);
 
-const result = await account.addAuthenticator(
+const result = await account.createMfaAuthenticator(
     AuthenticatorType.Totp // type
 );
 

package/docs/examples/account/{create-challenge.md → create-mfa-challenge.md}

@@ -6,8 +6,8 @@ const client = new Client()
 
 const account = new Account(client);
 
-const result = await account.createChallenge(
-    AuthenticationFactor.Totp // factor
+const result = await account.createMfaChallenge(
+    AuthenticationFactor.Email // factor
 );
 
 console.log(response);

package/docs/examples/account/create-mfa-recovery-codes.md

@@ -0,0 +1,11 @@
+import { Client, Account } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
+
+const account = new Account(client);
+
+const result = await account.createMfaRecoveryCodes();
+
+console.log(response);

package/docs/examples/account/{verify-authenticator.md → delete-mfa-authenticator.md}

@@ -6,7 +6,7 @@ const client = new Client()
 
 const account = new Account(client);
 
-const result = await account.verifyAuthenticator(
+const result = await account.deleteMfaAuthenticator(
     AuthenticatorType.Totp, // type
     '<OTP>' // otp
 );

package/docs/examples/account/get-mfa-recovery-codes.md

@@ -0,0 +1,11 @@
+import { Client, Account } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
+
+const account = new Account(client);
+
+const result = await account.getMfaRecoveryCodes();
+
+console.log(response);

package/docs/examples/account/{list-factors.md → list-mfa-factors.md}

@@ -6,6 +6,6 @@ const client = new Client()
 
 const account = new Account(client);
 
-const result = await account.listFactors();
+const result = await account.listMfaFactors();
 
 console.log(response);

package/docs/examples/account/{delete-authenticator.md → update-mfa-authenticator.md}

@@ -6,7 +6,7 @@ const client = new Client()
 
 const account = new Account(client);
 
-const result = await account.deleteAuthenticator(
+const result = await account.updateMfaAuthenticator(
     AuthenticatorType.Totp, // type
     '<OTP>' // otp
 );

package/docs/examples/account/{update-challenge.md → update-mfa-challenge.md}

@@ -6,7 +6,7 @@ const client = new Client()
 
 const account = new Account(client);
 
-const result = await account.updateChallenge(
+const result = await account.updateMfaChallenge(
     '<CHALLENGE_ID>', // challengeId
     '<OTP>' // otp
 );

package/docs/examples/account/update-mfa-recovery-codes.md

@@ -0,0 +1,11 @@
+import { Client, Account } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
+
+const account = new Account(client);
+
+const result = await account.updateMfaRecoveryCodes();
+
+console.log(response);

package/docs/examples/users/create-mfa-recovery-codes.md

@@ -0,0 +1,13 @@
+import { Client, Users } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
+
+const users = new Users(client);
+
+const result = await users.createMfaRecoveryCodes(
+    '<USER_ID>' // userId
+);
+
+console.log(response);

package/docs/examples/users/{delete-authenticator.md → delete-mfa-authenticator.md}

@@ -1,4 +1,4 @@
-import { Client, Users, AuthenticatorType } from "@appwrite.io/console";
+import { Client, Users,  } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
@@ -6,9 +6,9 @@ const client = new Client()
 
 const users = new Users(client);
 
-const result = await users.deleteAuthenticator(
+const result = await users.deleteMfaAuthenticator(
     '<USER_ID>', // userId
-    AuthenticatorType.Totp // type
+    .Totp // type
 );
 
 console.log(response);

package/docs/examples/users/get-mfa-recovery-codes.md

@@ -0,0 +1,13 @@
+import { Client, Users } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
+
+const users = new Users(client);
+
+const result = await users.getMfaRecoveryCodes(
+    '<USER_ID>' // userId
+);
+
+console.log(response);

package/docs/examples/users/{list-factors.md → list-mfa-factors.md}

@@ -6,7 +6,7 @@ const client = new Client()
 
 const users = new Users(client);
 
-const result = await users.listFactors(
+const result = await users.listMfaFactors(
     '<USER_ID>' // userId
 );
 

package/docs/examples/users/update-mfa-recovery-codes.md

@@ -0,0 +1,13 @@
+import { Client, Users } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
+
+const users = new Users(client);
+
+const result = await users.updateMfaRecoveryCodes(
+    '<USER_ID>' // userId
+);
+
+console.log(response);

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 abstract and simplify complex and repetitive development tasks behind a very simple REST API",
-  "version": "0.6.0-rc.14",
+  "version": "0.6.0-rc.16",
   "license": "BSD-3-Clause",
   "main": "dist/cjs/sdk.js",
   "exports": {

package/src/client.ts

@@ -104,7 +104,7 @@ class Client {
         'x-sdk-name': 'Console',
         'x-sdk-platform': 'console',
         'x-sdk-language': 'web',
-        'x-sdk-version': '0.6.0-rc.14',
+        'x-sdk-version': '0.6.0-rc.16',
         'X-Appwrite-Response-Format': '1.5.0',
     };
 

package/src/enums/authentication-factor.ts

@@ -1,5 +1,6 @@
 export enum AuthenticationFactor {
-    Totp = 'totp',
-    Phone = 'phone',
     Email = 'email',
+    Phone = 'phone',
+    Totp = 'totp',
+    Recoverycode = 'recoverycode',
 }

package/src/enums/type.ts

@@ -0,0 +1,3 @@
+export enum Type {
+    Totp = 'totp',
+}

package/src/index.ts

@@ -22,8 +22,8 @@ export type { QueryTypes, QueryTypesList } from './query';
 export { Permission } from './permission';
 export { Role } from './role';
 export { ID } from './id';
-export { AuthenticationFactor } from './enums/authentication-factor';
 export { AuthenticatorType } from './enums/authenticator-type';
+export { AuthenticationFactor } from './enums/authentication-factor';
 export { OAuthProvider } from './enums/o-auth-provider';
 export { Browser } from './enums/browser';
 export { CreditCard } from './enums/credit-card';
@@ -54,4 +54,5 @@ export { ImageFormat } from './enums/image-format';
 export { StorageUsageRange } from './enums/storage-usage-range';
 export { PasswordHash } from './enums/password-hash';
 export { UserUsageRange } from './enums/user-usage-range';
+export { Type } from './enums/type';
 export { MessagingProviderType } from './enums/messaging-provider-type';