npm - @appwrite.io/console - Versions diffs - 0.6.0-rc.14 → 0.6.0-rc.16 - Mend

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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (34) hide show

package/README.md +1 -1
package/dist/cjs/sdk.js +222 -69
package/dist/cjs/sdk.js.map +1 -1
package/dist/esm/sdk.js +223 -70
package/dist/esm/sdk.js.map +1 -1
package/dist/iife/sdk.js +222 -69
package/docs/examples/account/{add-authenticator.md → create-mfa-authenticator.md} +1 -1
package/docs/examples/account/{create-challenge.md → create-mfa-challenge.md} +2 -2
package/docs/examples/account/create-mfa-recovery-codes.md +11 -0
package/docs/examples/account/{verify-authenticator.md → delete-mfa-authenticator.md} +1 -1
package/docs/examples/account/get-mfa-recovery-codes.md +11 -0
package/docs/examples/account/{list-factors.md → list-mfa-factors.md} +1 -1
package/docs/examples/account/{delete-authenticator.md → update-mfa-authenticator.md} +1 -1
package/docs/examples/account/{update-challenge.md → update-mfa-challenge.md} +1 -1
package/docs/examples/account/update-mfa-recovery-codes.md +11 -0
package/docs/examples/users/create-mfa-recovery-codes.md +13 -0
package/docs/examples/users/{delete-authenticator.md → delete-mfa-authenticator.md} +3 -3
package/docs/examples/users/get-mfa-recovery-codes.md +13 -0
package/docs/examples/users/{list-factors.md → list-mfa-factors.md} +1 -1
package/docs/examples/users/update-mfa-recovery-codes.md +13 -0
package/package.json +1 -1
package/src/client.ts +1 -1
package/src/enums/authentication-factor.ts +3 -2
package/src/enums/type.ts +3 -0
package/src/index.ts +2 -1
package/src/models.ts +13 -8
package/src/services/account.ts +132 -60
package/src/services/users.ts +88 -10
package/types/enums/authentication-factor.d.ts +3 -2
package/types/enums/type.d.ts +3 -0
package/types/index.d.ts +2 -1
package/types/models.d.ts +13 -8
package/types/services/account.d.ts +71 -26
package/types/services/users.d.ts +45 -6

package/README.md CHANGED Viewed

@@ -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@0.6.0-rc.14"></script>
+<script src="https://cdn.jsdelivr.net/npm/@appwrite.io/console@0.6.0-rc.16"></script>
 ```

package/dist/cjs/sdk.js CHANGED Viewed

@@ -117,7 +117,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',
         };
         this.realtime = {
@@ -692,15 +692,103 @@ class Account extends Service {
             }, 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"');
@@ -719,14 +807,18 @@ class Account extends Service {
     /**
      * 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"');
@@ -756,7 +848,7 @@ class Account extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    listFactors() {
+    listMfaFactors() {
         return __awaiter(this, void 0, void 0, function* () {
             const apiPath = '/account/mfa/factors';
             const payload = {};
@@ -767,86 +859,65 @@ class Account extends Service {
         });
     }
     /**
-     * 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);
         });
@@ -1354,10 +1425,11 @@ class Account extends Service {
         });
     }
     /**
-     * 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}
@@ -11677,6 +11749,32 @@ class Users extends Service {
             }, 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
      *
@@ -11686,7 +11784,7 @@ class Users extends Service {
      * @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"');
@@ -11700,27 +11798,76 @@ class Users extends Service {
         });
     }
     /**
-     * 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);
         });
@@ -12618,18 +12765,19 @@ class ID {
     }
 }
-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";
@@ -13429,6 +13577,11 @@ exports.UserUsageRange = void 0;
     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";