Release candidate for 1.5.x

abnegate · abnegate · commit a11f02b97bdc · 2024-02-19T16:59:47.000+13:00
diff --git a/README.md b/README.md
@@ -33,7 +33,7 @@ import { Client, Account } from "appwrite";
 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@14.0.0-rc.2"></script>
+<script src="https://cdn.jsdelivr.net/npm/appwrite@14.0.0-rc.3"></script>
 ```
 
 
diff --git a/docs/examples/account/add-authenticator.md b/docs/examples/account/add-authenticator.md
@@ -1,4 +1,4 @@
-import { Client, , Account } from "appwrite";
+import { Client, AuthenticatorType, Account } from "appwrite";
 
 const client = new Client();
 
@@ -9,7 +9,7 @@ client
     .setProject('5df5acd0d48c2') // Your project ID
 ;
 
-const promise = account.addAuthenticator(.Totp);
+const promise = account.addAuthenticator(AuthenticatorType.Totp);
 
 promise.then(function (response) {
     console.log(response); // Success
diff --git a/docs/examples/account/create2f-a-challenge.md b/docs/examples/account/create2f-a-challenge.md
@@ -1,4 +1,4 @@
-import { Client, , Account } from "appwrite";
+import { Client, AuthenticationFactor, Account } from "appwrite";
 
 const client = new Client();
 
@@ -9,7 +9,7 @@ client
     .setProject('5df5acd0d48c2') // Your project ID
 ;
 
-const promise = account.create2FAChallenge(.Totp);
+const promise = account.create2FAChallenge(AuthenticationFactor.Totp);
 
 promise.then(function (response) {
     console.log(response); // Success
diff --git a/docs/examples/account/delete-authenticator.md b/docs/examples/account/delete-authenticator.md
@@ -1,4 +1,4 @@
-import { Client, , Account } from "appwrite";
+import { Client, AuthenticatorType, Account } from "appwrite";
 
 const client = new Client();
 
@@ -9,7 +9,7 @@ client
     .setProject('5df5acd0d48c2') // Your project ID
 ;
 
-const promise = account.deleteAuthenticator(.Totp, '[OTP]');
+const promise = account.deleteAuthenticator(AuthenticatorType.Totp, '[OTP]');
 
 promise.then(function (response) {
     console.log(response); // Success
diff --git a/docs/examples/account/verify-authenticator.md b/docs/examples/account/verify-authenticator.md
@@ -1,4 +1,4 @@
-import { Client, , Account } from "appwrite";
+import { Client, AuthenticatorType, Account } from "appwrite";
 
 const client = new Client();
 
@@ -9,7 +9,7 @@ client
     .setProject('5df5acd0d48c2') // Your project ID
 ;
 
-const promise = account.verifyAuthenticator(.Totp, '[OTP]');
+const promise = account.verifyAuthenticator(AuthenticatorType.Totp, '[OTP]');
 
 promise.then(function (response) {
     console.log(response); // Success
diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
   "name": "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": "14.0.0-rc.2",
+  "version": "14.0.0-rc.3",
   "license": "BSD-3-Clause",
   "main": "dist/cjs/sdk.js",
   "exports": {
diff --git a/src/client.ts b/src/client.ts
@@ -103,8 +103,8 @@ class Client {
         'x-sdk-name': 'Web',
         'x-sdk-platform': 'client',
         'x-sdk-language': 'web',
-        'x-sdk-version': '14.0.0-rc.2',
-        'X-Appwrite-Response-Format': '1.4.0',
+        'x-sdk-version': '14.0.0-rc.3',
+        'X-Appwrite-Response-Format': '1.5.0',
     };
 
     /**
diff --git a/src/enums/authentication-factor.ts b/src/enums/authentication-factor.ts
@@ -1,4 +1,4 @@
-export enum Factor {
+export enum AuthenticationFactor {
     Totp = 'totp',
     Phone = 'phone',
     Email = 'email',
diff --git a/src/enums/authenticator-type.ts b/src/enums/authenticator-type.ts
@@ -0,0 +1,3 @@
+export enum AuthenticatorType {
+    Totp = 'totp',
+}
diff --git a/src/enums/type.ts b/src/enums/type.ts
diff --git a/src/index.ts b/src/index.ts
@@ -13,8 +13,8 @@ export type { QueryTypes, QueryTypesList } from './query';
 export { Permission } from './permission';
 export { Role } from './role';
 export { ID } from './id';
-export { Factor } from './enums/factor';
-export { Type } from './enums/type';
+export { AuthenticationFactor } from './enums/authentication-factor';
+export { AuthenticatorType } from './enums/authenticator-type';
 export { OAuthProvider } from './enums/o-auth-provider';
 export { Browser } from './enums/browser';
 export { CreditCard } from './enums/credit-card';
diff --git a/src/services/account.ts b/src/services/account.ts
@@ -3,8 +3,8 @@ import { AppwriteException, Client } from '../client';
 import type { Models } from '../models';
 import type { UploadProgress, Payload } from '../client';
 import { Query } from '../query';
-import { Factor } from '../enums/factor';
-import { Type } from '../enums/type';
+import { AuthenticationFactor } from '../enums/authentication-factor';
+import { AuthenticatorType } from '../enums/authenticator-type';
 import { OAuthProvider } from '../enums/o-auth-provider';
 
 export class Account extends Service {
@@ -253,11 +253,11 @@ export class Account extends Service {
      * Create 2FA Challenge
      *
      *
-     * @param {Factor} factor
+     * @param {AuthenticationFactor} factor
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async create2FAChallenge(factor: Factor): Promise<Models.MfaChallenge> {
+    async create2FAChallenge(factor: AuthenticationFactor): Promise<Models.MfaChallenge> {
         if (typeof factor === 'undefined') {
             throw new AppwriteException('Missing required parameter: "factor"');
         }
@@ -331,11 +331,11 @@ export class Account extends Service {
      * Add Authenticator
      *
      *
-     * @param {Type} type
+     * @param {AuthenticatorType} type
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async addAuthenticator(type: Type): Promise<Models.MfaType> {
+    async addAuthenticator(type: AuthenticatorType): Promise<Models.MfaType> {
         if (typeof type === 'undefined') {
             throw new AppwriteException('Missing required parameter: "type"');
         }
@@ -353,12 +353,12 @@ export class Account extends Service {
      * Verify Authenticator
      *
      *
-     * @param {Type} type
+     * @param {AuthenticatorType} type
      * @param {string} otp
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async verifyAuthenticator<Preferences extends Models.Preferences>(type: Type, otp: string): Promise<Models.User<Preferences>> {
+    async verifyAuthenticator<Preferences extends Models.Preferences>(type: AuthenticatorType, otp: string): Promise<Models.User<Preferences>> {
         if (typeof type === 'undefined') {
             throw new AppwriteException('Missing required parameter: "type"');
         }
@@ -384,12 +384,12 @@ export class Account extends Service {
      * Delete Authenticator
      *
      *
-     * @param {Type} type
+     * @param {AuthenticatorType} type
      * @param {string} otp
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async deleteAuthenticator<Preferences extends Models.Preferences>(type: Type, otp: string): Promise<Models.User<Preferences>> {
+    async deleteAuthenticator<Preferences extends Models.Preferences>(type: AuthenticatorType, otp: string): Promise<Models.User<Preferences>> {
         if (typeof type === 'undefined') {
             throw new AppwriteException('Missing required parameter: "type"');
         }

-Original file line number
+Diff line change
 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/[email protected].2"></script>
 +<script src="https://cdn.jsdelivr.net/npm/[email protected].3"></script>
 ```
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-export enum Factor {`
	`1`	`+export enum AuthenticationFactor {`
`2`	`2`	`Totp = 'totp',`
`3`	`3`	`Phone = 'phone',`
`4`	`4`	`Email = 'email',`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+export enum AuthenticatorType {`
	`2`	`+ Totp = 'totp',`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -3,8 +3,8 @@ import { AppwriteException, Client } from '../client';`
`3`	`3`	`import type { Models } from '../models';`
`4`	`4`	`import type { UploadProgress, Payload } from '../client';`
`5`	`5`	`import { Query } from '../query';`
`6`		`-import { Factor } from '../enums/factor';`
`7`		`-import { Type } from '../enums/type';`
	`6`	`+import { AuthenticationFactor } from '../enums/authentication-factor';`
	`7`	`+import { AuthenticatorType } from '../enums/authenticator-type';`
`8`	`8`	`import { OAuthProvider } from '../enums/o-auth-provider';`
`9`	`9`
`10`	`10`	`export class Account extends Service {`
`@@ -253,11 +253,11 @@ export class Account extends Service {`
`253`	`253`	`* Create 2FA Challenge`
`254`	`254`	`*`
`255`	`255`	`*`
`256`		`- * @param {Factor} factor`
	`256`	`+ * @param {AuthenticationFactor} factor`
`257`	`257`	`* @throws {AppwriteException}`
`258`	`258`	`* @returns {Promise}`
`259`	`259`	`*/`
`260`		`- async create2FAChallenge(factor: Factor): Promise<Models.MfaChallenge> {`
	`260`	`+ async create2FAChallenge(factor: AuthenticationFactor): Promise<Models.MfaChallenge> {`
`261`	`261`	`if (typeof factor === 'undefined') {`
`262`	`262`	`throw new AppwriteException('Missing required parameter: "factor"');`
`263`	`263`	`}`
`@@ -331,11 +331,11 @@ export class Account extends Service {`
`331`	`331`	`* Add Authenticator`
`332`	`332`	`*`
`333`	`333`	`*`
`334`		`- * @param {Type} type`
	`334`	`+ * @param {AuthenticatorType} type`
`335`	`335`	`* @throws {AppwriteException}`
`336`	`336`	`* @returns {Promise}`
`337`	`337`	`*/`
`338`		`- async addAuthenticator(type: Type): Promise<Models.MfaType> {`
	`338`	`+ async addAuthenticator(type: AuthenticatorType): Promise<Models.MfaType> {`
`339`	`339`	`if (typeof type === 'undefined') {`
`340`	`340`	`throw new AppwriteException('Missing required parameter: "type"');`
`341`	`341`	`}`
`@@ -353,12 +353,12 @@ export class Account extends Service {`
`353`	`353`	`* Verify Authenticator`
`354`	`354`	`*`
`355`	`355`	`*`
`356`		`- * @param {Type} type`
	`356`	`+ * @param {AuthenticatorType} type`
`357`	`357`	`* @param {string} otp`
`358`	`358`	`* @throws {AppwriteException}`
`359`	`359`	`* @returns {Promise}`
`360`	`360`	`*/`
`361`		`- async verifyAuthenticator<Preferences extends Models.Preferences>(type: Type, otp: string): Promise<Models.User<Preferences>> {`
	`361`	`+ async verifyAuthenticator<Preferences extends Models.Preferences>(type: AuthenticatorType, otp: string): Promise<Models.User<Preferences>> {`
`362`	`362`	`if (typeof type === 'undefined') {`
`363`	`363`	`throw new AppwriteException('Missing required parameter: "type"');`
`364`	`364`	`}`
`@@ -384,12 +384,12 @@ export class Account extends Service {`
`384`	`384`	`* Delete Authenticator`
`385`	`385`	`*`
`386`	`386`	`*`
`387`		`- * @param {Type} type`
	`387`	`+ * @param {AuthenticatorType} type`
`388`	`388`	`* @param {string} otp`
`389`	`389`	`* @throws {AppwriteException}`
`390`	`390`	`* @returns {Promise}`
`391`	`391`	`*/`
`392`		`- async deleteAuthenticator<Preferences extends Models.Preferences>(type: Type, otp: string): Promise<Models.User<Preferences>> {`
	`392`	`+ async deleteAuthenticator<Preferences extends Models.Preferences>(type: AuthenticatorType, otp: string): Promise<Models.User<Preferences>> {`
`393`	`393`	`if (typeof type === 'undefined') {`
`394`	`394`	`throw new AppwriteException('Missing required parameter: "type"');`
`395`	`395`	`}`