@supabase/gotrue-js 1.16.7 → 1.19.0

package/README.md

@@ -25,9 +25,9 @@ const GOTRUE_URL = 'http://localhost:9999'
 const auth = new GoTrueClient({ url: GOTRUE_URL })
 ```
 
-- `signUp()`: https://supabase.io/docs/gotrue/client/signup
-- `signIn()`: https://supabase.io/docs/gotrue/client/signin
-- `signOut()`: https://supabase.io/docs/gotrue/client/signout
+- `signUp()`: https://supabase.io/docs/reference/javascript/auth-signup
+- `signIn()`: https://supabase.io/docs/reference/javascript/auth-signin
+- `signOut()`: https://supabase.io/docs/reference/javascript/auth-signout
 
 ## Sponsors
 

package/dist/main/GoTrueApi.d.ts

@@ -1,4 +1,8 @@
 import { Session, Provider, UserAttributes, CookieOptions, User } from './lib/types';
+export interface ApiError {
+    message: string;
+    status: number;
+}
 export default class GoTrueApi {
     protected url: string;
     protected headers: {
@@ -17,15 +21,17 @@ export default class GoTrueApi {
      * @param email The email address of the user.
      * @param password The password of the user.
      * @param redirectTo A URL or mobile address to send the user to after they are confirmed.
+     * @param data Optional user metadata.
      *
      * @returns A logged-in session if the server has "autoconfirm" ON
      * @returns A user if the server has "autoconfirm" OFF
      */
     signUpWithEmail(email: string, password: string, options?: {
         redirectTo?: string;
+        data?: object;
     }): Promise<{
         data: Session | User | null;
-        error: Error | null;
+        error: ApiError | null;
     }>;
     /**
      * Logs in an existing user using their email address.
@@ -37,7 +43,28 @@ export default class GoTrueApi {
         redirectTo?: string;
     }): Promise<{
         data: Session | null;
-        error: Error | null;
+        error: ApiError | null;
+    }>;
+    /**
+     * Signs up a new user using their phone number and a password.
+     * @param phone The phone number of the user.
+     * @param password The password of the user.
+     * @param data Optional user metadata.
+     */
+    signUpWithPhone(phone: string, password: string, options?: {
+        data?: object;
+    }): Promise<{
+        data: Session | User | null;
+        error: ApiError | null;
+    }>;
+    /**
+     * Logs in an existing user using their phone number and password.
+     * @param phone The phone number of the user.
+     * @param password The password of the user.
+     */
+    signInWithPhone(phone: string, password: string): Promise<{
+        data: Session | null;
+        error: ApiError | null;
     }>;
     /**
      * Sends a magic login link to an email address.
@@ -48,18 +75,40 @@ export default class GoTrueApi {
         redirectTo?: string;
     }): Promise<{
         data: {} | null;
-        error: Error | null;
+        error: ApiError | null;
+    }>;
+    /**
+     * Sends a mobile OTP via SMS. Will register the account if it doesn't already exist
+     * @param phone The user's phone number WITH international prefix
+     */
+    sendMobileOTP(phone: string): Promise<{
+        data: {} | null;
+        error: ApiError | null;
+    }>;
+    /**
+     * Send User supplied Mobile OTP to be verified
+     * @param phone The user's phone number WITH international prefix
+     * @param token token that user was sent to their mobile phone
+     * @param redirectTo A URL or mobile address to send the user to after they are confirmed.
+     */
+    verifyMobileOTP(phone: string, token: string, options?: {
+        redirectTo?: string;
+    }): Promise<{
+        data: Session | User | null;
+        error: ApiError | null;
     }>;
     /**
      * Sends an invite link to an email address.
      * @param email The email address of the user.
      * @param redirectTo A URL or mobile address to send the user to after they are confirmed.
+     * @param data Optional user metadata
      */
     inviteUserByEmail(email: string, options?: {
         redirectTo?: string;
+        data?: object;
     }): Promise<{
         data: User | null;
-        error: Error | null;
+        error: ApiError | null;
     }>;
     /**
      * Sends a reset request to an email address.
@@ -70,7 +119,7 @@ export default class GoTrueApi {
         redirectTo?: string;
     }): Promise<{
         data: {} | null;
-        error: Error | null;
+        error: ApiError | null;
     }>;
     /**
      * Create a temporary object with all configured headers and
@@ -83,7 +132,7 @@ export default class GoTrueApi {
      * @param jwt A valid, logged-in JWT.
      */
     signOut(jwt: string): Promise<{
-        error: Error | null;
+        error: ApiError | null;
     }>;
     /**
      * Generates the relevant login URL for a third-party provider.
@@ -102,7 +151,7 @@ export default class GoTrueApi {
     getUser(jwt: string): Promise<{
         user: User | null;
         data: User | null;
-        error: Error | null;
+        error: ApiError | null;
     }>;
     /**
      * Updates the user data.
@@ -112,17 +161,20 @@ export default class GoTrueApi {
     updateUser(jwt: string, attributes: UserAttributes): Promise<{
         user: User | null;
         data: User | null;
-        error: Error | null;
+        error: ApiError | null;
     }>;
     /**
-     * Delete an user.
+     * Delete a user. Requires a `service_role` key.
+     *
+     * This function should only be called on a server. Never expose your `service_role` key in the browser.
+     *
      * @param uid The user uid you want to remove.
      * @param jwt A valid JWT. Must be a full-access API key (e.g. service_role key).
      */
     deleteUser(uid: string, jwt: string): Promise<{
         user: User | null;
         data: User | null;
-        error: Error | null;
+        error: ApiError | null;
     }>;
     /**
      * Generates a new JWT.
@@ -130,7 +182,7 @@ export default class GoTrueApi {
      */
     refreshAccessToken(refreshToken: string): Promise<{
         data: Session | null;
-        error: Error | null;
+        error: ApiError | null;
     }>;
     /**
      * Set/delete the auth cookie based on the AuthChangeEvent.
@@ -144,7 +196,23 @@ export default class GoTrueApi {
     getUserByCookie(req: any): Promise<{
         user: User | null;
         data: User | null;
-        error: Error | null;
+        error: ApiError | null;
+    }>;
+    /**
+     * Generates links to be sent via email or other.
+     * @param type The link type ("signup" or "magiclink" or "recovery" or "invite").
+     * @param email The user's email.
+     * @param password User password. For signup only.
+     * @param data Optional user metadata. For signup only.
+     * @param redirectTo The link type ("signup" or "magiclink" or "recovery" or "invite").
+     */
+    generateLink(type: 'signup' | 'magiclink' | 'recovery' | 'invite', email: string, options?: {
+        password?: string;
+        data?: object;
+        redirectTo?: string;
+    }): Promise<{
+        data: Session | User | null;
+        error: ApiError | null;
     }>;
 }
 //# sourceMappingURL=GoTrueApi.d.ts.map

package/dist/main/GoTrueApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"GoTrueApi.d.ts","sourceRoot":"","sources":["../../src/GoTrueApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAKpF,MAAM,CAAC,OAAO,OAAO,SAAS;IAC5B,SAAS,CAAC,GAAG,EAAE,MAAM,CAAA;IACrB,SAAS,CAAC,OAAO,EAAE;QACjB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KACtB,CAAA;IACD,SAAS,CAAC,aAAa,EAAE,aAAa,CAAA;gBAE1B,EACV,GAAQ,EACR,OAAY,EACZ,aAAa,GACd,EAAE;QACD,GAAG,EAAE,MAAM,CAAA;QACX,OAAO,CAAC,EAAE;YACR,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SACtB,CAAA;QACD,aAAa,CAAC,EAAE,aAAa,CAAA;KAC9B;IAMD;;;;;;;;OAQG;IACG,eAAe,CACnB,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE;QACP,UAAU,CAAC,EAAE,MAAM,CAAA;KACf,GACL,OAAO,CAAC;QAAE,IAAI,EAAE,OAAO,GAAG,IAAI,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;KAAE,CAAC;IAgBhE;;;;;OAKG;IACG,eAAe,CACnB,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE;QACP,UAAU,CAAC,EAAE,MAAM,CAAA;KACf,GACL,OAAO,CAAC;QAAE,IAAI,EAAE,OAAO,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;KAAE,CAAC;IAgBzD;;;;OAIG;IACG,kBAAkB,CACtB,KAAK,EAAE,MAAM,EACb,OAAO,GAAE;QACP,UAAU,CAAC,EAAE,MAAM,CAAA;KACf,GACL,OAAO,CAAC;QAAE,IAAI,EAAE,EAAE,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;KAAE,CAAC;IAcpD;;;;OAIG;IACG,iBAAiB,CACrB,KAAK,EAAE,MAAM,EACb,OAAO,GAAE;QACP,UAAU,CAAC,EAAE,MAAM,CAAA;KACf,GACL,OAAO,CAAC;QAAE,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;KAAE,CAAC;IActD;;;;OAIG;IACG,qBAAqB,CACzB,KAAK,EAAE,MAAM,EACb,OAAO,GAAE;QACP,UAAU,CAAC,EAAE,MAAM,CAAA;KACf,GACL,OAAO,CAAC;QAAE,IAAI,EAAE,EAAE,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;KAAE,CAAC;IAcpD;;;;OAIG;IACH,OAAO,CAAC,qBAAqB;IAM7B;;;OAGG;IACG,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;KAAE,CAAC;IAa5D;;;;;OAKG;IACH,iBAAiB,CACf,QAAQ,EAAE,QAAQ,EAClB,OAAO,EAAE;QACP,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB;IAYH;;;OAGG;IACG,OAAO,CACX,GAAG,EAAE,MAAM,GACV,OAAO,CAAC;QAAE,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;QAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;KAAE,CAAC;IASzE;;;;OAIG;IACG,UAAU,CACd,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,cAAc,GACzB,OAAO,CAAC;QAAE,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;QAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;KAAE,CAAC;IAWzE;;;;OAIG;IACG,UAAU,CACd,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,GACV,OAAO,CAAC;QAAE,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;QAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;KAAE,CAAC;IAezE;;;OAGG;IACG,kBAAkB,CACtB,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC;QAAE,IAAI,EAAE,OAAO,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;KAAE,CAAC;IAezD;;;OAGG;IACH,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG;IAsBhC;;;OAGG;IACG,eAAe,CACnB,GAAG,EAAE,GAAG,GACP,OAAO,CAAC;QAAE,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;QAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;KAAE,CAAC;CAe1E"}
+{"version":3,"file":"GoTrueApi.d.ts","sourceRoot":"","sources":["../../src/GoTrueApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAKpF,MAAM,WAAW,QAAQ;IACvB,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,CAAC,OAAO,OAAO,SAAS;IAC5B,SAAS,CAAC,GAAG,EAAE,MAAM,CAAA;IACrB,SAAS,CAAC,OAAO,EAAE;QACjB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KACtB,CAAA;IACD,SAAS,CAAC,aAAa,EAAE,aAAa,CAAA;gBAE1B,EACV,GAAQ,EACR,OAAY,EACZ,aAAa,GACd,EAAE;QACD,GAAG,EAAE,MAAM,CAAA;QACX,OAAO,CAAC,EAAE;YACR,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SACtB,CAAA;QACD,aAAa,CAAC,EAAE,aAAa,CAAA;KAC9B;IAMD;;;;;;;;;OASG;IACG,eAAe,CACnB,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE;QACP,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,IAAI,CAAC,EAAE,MAAM,CAAA;KACT,GACL,OAAO,CAAC;QAAE,IAAI,EAAE,OAAO,GAAG,IAAI,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAA;KAAE,CAAC;IAoBnE;;;;;OAKG;IACG,eAAe,CACnB,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE;QACP,UAAU,CAAC,EAAE,MAAM,CAAA;KACf,GACL,OAAO,CAAC;QAAE,IAAI,EAAE,OAAO,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAA;KAAE,CAAC;IAgB5D;;;;;OAKG;IACG,eAAe,CACnB,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE;QACP,IAAI,CAAC,EAAE,MAAM,CAAA;KACT,GACL,OAAO,CAAC;QAAE,IAAI,EAAE,OAAO,GAAG,IAAI,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAA;KAAE,CAAC;IAgBnE;;;;OAIG;IACG,eAAe,CACnB,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC;QAAE,IAAI,EAAE,OAAO,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAA;KAAE,CAAC;IAa5D;;;;OAIG;IACG,kBAAkB,CACtB,KAAK,EAAE,MAAM,EACb,OAAO,GAAE;QACP,UAAU,CAAC,EAAE,MAAM,CAAA;KACf,GACL,OAAO,CAAC;QAAE,IAAI,EAAE,EAAE,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAA;KAAE,CAAC;IAcvD;;;OAGG;IACG,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,EAAE,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAA;KAAE,CAAC;IAUxF;;;;;OAKG;IACG,eAAe,CACnB,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EACb,OAAO,GAAE;QACP,UAAU,CAAC,EAAE,MAAM,CAAA;KACf,GACL,OAAO,CAAC;QAAE,IAAI,EAAE,OAAO,GAAG,IAAI,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAA;KAAE,CAAC;IAcnE;;;;;OAKG;IACG,iBAAiB,CACrB,KAAK,EAAE,MAAM,EACb,OAAO,GAAE;QACP,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,IAAI,CAAC,EAAE,MAAM,CAAA;KACT,GACL,OAAO,CAAC;QAAE,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAA;KAAE,CAAC;IAkBzD;;;;OAIG;IACG,qBAAqB,CACzB,KAAK,EAAE,MAAM,EACb,OAAO,GAAE;QACP,UAAU,CAAC,EAAE,MAAM,CAAA;KACf,GACL,OAAO,CAAC;QAAE,IAAI,EAAE,EAAE,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAA;KAAE,CAAC;IAcvD;;;;OAIG;IACH,OAAO,CAAC,qBAAqB;IAM7B;;;OAGG;IACG,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAA;KAAE,CAAC;IAa/D;;;;;OAKG;IACH,iBAAiB,CACf,QAAQ,EAAE,QAAQ,EAClB,OAAO,EAAE;QACP,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB;IAYH;;;OAGG;IACG,OAAO,CACX,GAAG,EAAE,MAAM,GACV,OAAO,CAAC;QAAE,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;QAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAA;KAAE,CAAC;IAS5E;;;;OAIG;IACG,UAAU,CACd,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,cAAc,GACzB,OAAO,CAAC;QAAE,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;QAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAA;KAAE,CAAC;IAW5E;;;;;;;OAOG;IACG,UAAU,CACd,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,GACV,OAAO,CAAC;QAAE,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;QAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAA;KAAE,CAAC;IAe5E;;;OAGG;IACG,kBAAkB,CACtB,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC;QAAE,IAAI,EAAE,OAAO,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAA;KAAE,CAAC;IAe5D;;;OAGG;IACH,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG;IAsBhC;;;OAGG;IACG,eAAe,CACnB,GAAG,EAAE,GAAG,GACP,OAAO,CAAC;QAAE,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;QAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAA;KAAE,CAAC;IAgB5E;;;;;;;OAOG;IACG,YAAY,CAChB,IAAI,EAAE,QAAQ,GAAG,WAAW,GAAG,UAAU,GAAG,QAAQ,EACpD,KAAK,EAAE,MAAM,EACb,OAAO,GAAE;QACP,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,UAAU,CAAC,EAAE,MAAM,CAAA;KACf,GACL,OAAO,CAAC;QAAE,IAAI,EAAE,OAAO,GAAG,IAAI,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAA;KAAE,CAAC;CAkBpE"}

package/dist/main/GoTrueApi.js

@@ -24,6 +24,7 @@ class GoTrueApi {
      * @param email The email address of the user.
      * @param password The password of the user.
      * @param redirectTo A URL or mobile address to send the user to after they are confirmed.
+     * @param data Optional user metadata.
      *
      * @returns A logged-in session if the server has "autoconfirm" ON
      * @returns A user if the server has "autoconfirm" OFF
@@ -36,7 +37,7 @@ class GoTrueApi {
                 if (options.redirectTo) {
                     queryString = '?redirect_to=' + encodeURIComponent(options.redirectTo);
                 }
-                const data = yield fetch_1.post(`${this.url}/signup${queryString}`, { email, password }, { headers });
+                const data = yield fetch_1.post(`${this.url}/signup${queryString}`, { email, password, data: options.data }, { headers });
                 let session = Object.assign({}, data);
                 if (session.expires_in)
                     session.expires_at = helpers_1.expiresAt(data.expires_in);
@@ -72,6 +73,48 @@ class GoTrueApi {
             }
         });
     }
+    /**
+     * Signs up a new user using their phone number and a password.
+     * @param phone The phone number of the user.
+     * @param password The password of the user.
+     * @param data Optional user metadata.
+     */
+    signUpWithPhone(phone, password, options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                let headers = Object.assign({}, this.headers);
+                const data = yield fetch_1.post(`${this.url}/signup`, { phone, password, data: options.data }, { headers });
+                let session = Object.assign({}, data);
+                if (session.expires_in)
+                    session.expires_at = helpers_1.expiresAt(data.expires_in);
+                return { data: session, error: null };
+            }
+            catch (error) {
+                return { data: null, error };
+            }
+        });
+    }
+    /**
+     * Logs in an existing user using their phone number and password.
+     * @param phone The phone number of the user.
+     * @param password The password of the user.
+     */
+    signInWithPhone(phone, password) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                let headers = Object.assign({}, this.headers);
+                let queryString = '?grant_type=password';
+                const data = yield fetch_1.post(`${this.url}/token${queryString}`, { phone, password }, { headers });
+                let session = Object.assign({}, data);
+                if (session.expires_in)
+                    session.expires_at = helpers_1.expiresAt(data.expires_in);
+                return { data: session, error: null };
+            }
+            catch (error) {
+                return { data: null, error };
+            }
+        });
+    }
     /**
      * Sends a magic login link to an email address.
      * @param email The email address of the user.
@@ -93,10 +136,45 @@ class GoTrueApi {
             }
         });
     }
+    /**
+     * Sends a mobile OTP via SMS. Will register the account if it doesn't already exist
+     * @param phone The user's phone number WITH international prefix
+     */
+    sendMobileOTP(phone) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                let headers = Object.assign({}, this.headers);
+                const data = yield fetch_1.post(`${this.url}/otp`, { phone }, { headers });
+                return { data, error: null };
+            }
+            catch (error) {
+                return { data: null, error };
+            }
+        });
+    }
+    /**
+     * Send User supplied Mobile OTP to be verified
+     * @param phone The user's phone number WITH international prefix
+     * @param token token that user was sent to their mobile phone
+     * @param redirectTo A URL or mobile address to send the user to after they are confirmed.
+     */
+    verifyMobileOTP(phone, token, options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                let headers = Object.assign({}, this.headers);
+                const data = yield fetch_1.post(`${this.url}/verify`, { phone, token, type: 'sms', redirect_to: options.redirectTo }, { headers });
+                return { data, error: null };
+            }
+            catch (error) {
+                return { data: null, error };
+            }
+        });
+    }
     /**
      * Sends an invite link to an email address.
      * @param email The email address of the user.
      * @param redirectTo A URL or mobile address to send the user to after they are confirmed.
+     * @param data Optional user metadata
      */
     inviteUserByEmail(email, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -106,7 +184,7 @@ class GoTrueApi {
                 if (options.redirectTo) {
                     queryString += '?redirect_to=' + encodeURIComponent(options.redirectTo);
                 }
-                const data = yield fetch_1.post(`${this.url}/invite${queryString}`, { email }, { headers });
+                const data = yield fetch_1.post(`${this.url}/invite${queryString}`, { email, data: options.data }, { headers });
                 return { data, error: null };
             }
             catch (error) {
@@ -210,7 +288,10 @@ class GoTrueApi {
         });
     }
     /**
-     * Delete an user.
+     * Delete a user. Requires a `service_role` key.
+     *
+     * This function should only be called on a server. Never expose your `service_role` key in the browser.
+     *
      * @param uid The user uid you want to remove.
      * @param jwt A valid JWT. Must be a full-access API key (e.g. service_role key).
      */
@@ -295,6 +376,31 @@ class GoTrueApi {
             }
         });
     }
+    /**
+     * Generates links to be sent via email or other.
+     * @param type The link type ("signup" or "magiclink" or "recovery" or "invite").
+     * @param email The user's email.
+     * @param password User password. For signup only.
+     * @param data Optional user metadata. For signup only.
+     * @param redirectTo The link type ("signup" or "magiclink" or "recovery" or "invite").
+     */
+    generateLink(type, email, options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const data = yield fetch_1.post(`${this.url}/admin/generate_link`, {
+                    type,
+                    email,
+                    password: options.password,
+                    data: options.data,
+                    redirect_to: options.redirectTo,
+                }, { headers: this.headers });
+                return { data, error: null };
+            }
+            catch (error) {
+                return { data: null, error };
+            }
+        });
+    }
 }
 exports.default = GoTrueApi;
 //# sourceMappingURL=GoTrueApi.js.map

package/dist/main/GoTrueApi.js.map

@@ -1 +1 @@
-{"version":3,"file":"GoTrueApi.js","sourceRoot":"","sources":["../../src/GoTrueApi.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,uCAAoD;AAEpD,+CAAgD;AAChD,2CAAuD;AACvD,2CAAyC;AAEzC,MAAqB,SAAS;IAO5B,YAAY,EACV,GAAG,GAAG,EAAE,EACR,OAAO,GAAG,EAAE,EACZ,aAAa,GAOd;QACC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;QACd,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,aAAa,mCAAQ,0BAAc,GAAK,aAAa,CAAE,CAAA;IAC9D,CAAC;IAED;;;;;;;;OAQG;IACG,eAAe,CACnB,KAAa,EACb,QAAgB,EAChB,UAEI,EAAE;;YAEN,IAAI;gBACF,IAAI,OAAO,qBAAQ,IAAI,CAAC,OAAO,CAAE,CAAA;gBACjC,IAAI,WAAW,GAAG,EAAE,CAAA;gBACpB,IAAI,OAAO,CAAC,UAAU,EAAE;oBACtB,WAAW,GAAG,eAAe,GAAG,kBAAkB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;iBACvE;gBACD,MAAM,IAAI,GAAG,MAAM,YAAI,CAAC,GAAG,IAAI,CAAC,GAAG,UAAU,WAAW,EAAE,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,CAAA;gBAC7F,IAAI,OAAO,qBAAQ,IAAI,CAAE,CAAA;gBACzB,IAAI,OAAO,CAAC,UAAU;oBAAE,OAAO,CAAC,UAAU,GAAG,mBAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;gBACvE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;aACtC;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;aAC7B;QACH,CAAC;KAAA;IAED;;;;;OAKG;IACG,eAAe,CACnB,KAAa,EACb,QAAgB,EAChB,UAEI,EAAE;;YAEN,IAAI;gBACF,IAAI,OAAO,qBAAQ,IAAI,CAAC,OAAO,CAAE,CAAA;gBACjC,IAAI,WAAW,GAAG,sBAAsB,CAAA;gBACxC,IAAI,OAAO,CAAC,UAAU,EAAE;oBACtB,WAAW,IAAI,eAAe,GAAG,kBAAkB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;iBACxE;gBACD,MAAM,IAAI,GAAG,MAAM,YAAI,CAAC,GAAG,IAAI,CAAC,GAAG,SAAS,WAAW,EAAE,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,CAAA;gBAC5F,IAAI,OAAO,qBAAQ,IAAI,CAAE,CAAA;gBACzB,IAAI,OAAO,CAAC,UAAU;oBAAE,OAAO,CAAC,UAAU,GAAG,mBAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;gBACvE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;aACtC;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;aAC7B;QACH,CAAC;KAAA;IAED;;;;OAIG;IACG,kBAAkB,CACtB,KAAa,EACb,UAEI,EAAE;;YAEN,IAAI;gBACF,IAAI,OAAO,qBAAQ,IAAI,CAAC,OAAO,CAAE,CAAA;gBACjC,IAAI,WAAW,GAAG,EAAE,CAAA;gBACpB,IAAI,OAAO,CAAC,UAAU,EAAE;oBACtB,WAAW,IAAI,eAAe,GAAG,kBAAkB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;iBACxE;gBACD,MAAM,IAAI,GAAG,MAAM,YAAI,CAAC,GAAG,IAAI,CAAC,GAAG,aAAa,WAAW,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,CAAA;gBACtF,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;aAC7B;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;aAC7B;QACH,CAAC;KAAA;IAED;;;;OAIG;IACG,iBAAiB,CACrB,KAAa,EACb,UAEI,EAAE;;YAEN,IAAI;gBACF,IAAI,OAAO,qBAAQ,IAAI,CAAC,OAAO,CAAE,CAAA;gBACjC,IAAI,WAAW,GAAG,EAAE,CAAA;gBACpB,IAAI,OAAO,CAAC,UAAU,EAAE;oBACtB,WAAW,IAAI,eAAe,GAAG,kBAAkB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;iBACxE;gBACD,MAAM,IAAI,GAAG,MAAM,YAAI,CAAC,GAAG,IAAI,CAAC,GAAG,UAAU,WAAW,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,CAAA;gBACnF,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;aAC7B;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;aAC7B;QACH,CAAC;KAAA;IAED;;;;OAIG;IACG,qBAAqB,CACzB,KAAa,EACb,UAEI,EAAE;;YAEN,IAAI;gBACF,IAAI,OAAO,qBAAQ,IAAI,CAAC,OAAO,CAAE,CAAA;gBACjC,IAAI,WAAW,GAAG,EAAE,CAAA;gBACpB,IAAI,OAAO,CAAC,UAAU,EAAE;oBACtB,WAAW,IAAI,eAAe,GAAG,kBAAkB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;iBACxE;gBACD,MAAM,IAAI,GAAG,MAAM,YAAI,CAAC,GAAG,IAAI,CAAC,GAAG,WAAW,WAAW,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,CAAA;gBACpF,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;aAC7B;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;aAC7B;QACH,CAAC;KAAA;IAED;;;;OAIG;IACK,qBAAqB,CAAC,GAAW;QACvC,MAAM,OAAO,qBAAQ,IAAI,CAAC,OAAO,CAAE,CAAA;QACnC,OAAO,CAAC,eAAe,CAAC,GAAG,UAAU,GAAG,EAAE,CAAA;QAC1C,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;OAGG;IACG,OAAO,CAAC,GAAW;;YACvB,IAAI;gBACF,MAAM,YAAI,CACR,GAAG,IAAI,CAAC,GAAG,SAAS,EACpB,EAAE,EACF,EAAE,OAAO,EAAE,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,CAClE,CAAA;gBACD,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;aACvB;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,EAAE,KAAK,EAAE,CAAA;aACjB;QACH,CAAC;KAAA;IAED;;;;;OAKG;IACH,iBAAiB,CACf,QAAkB,EAClB,OAGC;QAED,IAAI,SAAS,GAAa,CAAC,YAAY,kBAAkB,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;QACtE,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU,EAAE;YACvB,SAAS,CAAC,IAAI,CAAC,eAAe,kBAAkB,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC,CAAA;SACxE;QACD,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,EAAE;YACnB,SAAS,CAAC,IAAI,CAAC,UAAU,kBAAkB,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;SAC/D;QACD,OAAO,GAAG,IAAI,CAAC,GAAG,cAAc,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAA;IACvD,CAAC;IAED;;;OAGG;IACG,OAAO,CACX,GAAW;;YAEX,IAAI;gBACF,MAAM,IAAI,GAAQ,MAAM,WAAG,CAAC,GAAG,IAAI,CAAC,GAAG,OAAO,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;gBAC7F,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;aACzC;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;aACzC;QACH,CAAC;KAAA;IAED;;;;OAIG;IACG,UAAU,CACd,GAAW,EACX,UAA0B;;YAE1B,IAAI;gBACF,MAAM,IAAI,GAAQ,MAAM,WAAG,CAAC,GAAG,IAAI,CAAC,GAAG,OAAO,EAAE,UAAU,EAAE;oBAC1D,OAAO,EAAE,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC;iBACzC,CAAC,CAAA;gBACF,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;aACzC;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;aACzC;QACH,CAAC;KAAA;IAED;;;;OAIG;IACG,UAAU,CACd,GAAW,EACX,GAAW;;YAEX,IAAI;gBACF,MAAM,IAAI,GAAQ,MAAM,cAAM,CAC5B,GAAG,IAAI,CAAC,GAAG,gBAAgB,GAAG,EAAE,EAChC,EAAE,EACF;oBACE,OAAO,EAAE,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC;iBACzC,CACF,CAAA;gBACD,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;aACzC;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;aACzC;QACH,CAAC;KAAA;IAED;;;OAGG;IACG,kBAAkB,CACtB,YAAoB;;YAEpB,IAAI;gBACF,MAAM,IAAI,GAAQ,MAAM,YAAI,CAC1B,GAAG,IAAI,CAAC,GAAG,iCAAiC,EAC5C,EAAE,aAAa,EAAE,YAAY,EAAE,EAC/B,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAC1B,CAAA;gBACD,IAAI,OAAO,qBAAQ,IAAI,CAAE,CAAA;gBACzB,IAAI,OAAO,CAAC,UAAU;oBAAE,OAAO,CAAC,UAAU,GAAG,mBAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;gBACvE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;aACtC;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;aAC7B;QACH,CAAC;KAAA;IAED;;;OAGG;IACH,aAAa,CAAC,GAAQ,EAAE,GAAQ;QAC9B,IAAI,GAAG,CAAC,MAAM,KAAK,MAAM,EAAE;YACzB,GAAG,CAAC,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;YAC9B,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAA;SAC1C;QACD,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,GAAG,CAAC,IAAI,CAAA;QACnC,IAAI,CAAC,KAAK;YAAE,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAA;QAClD,IAAI,KAAK,KAAK,WAAW,EAAE;YACzB,IAAI,CAAC,OAAO;gBAAE,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAA;YACtD,mBAAS,CAAC,GAAG,EAAE,GAAG,EAAE;gBAClB,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,IAAK;gBAC9B,KAAK,EAAE,OAAO,CAAC,YAAY;gBAC3B,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,MAAM;gBACjC,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,QAAS;gBACpC,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI;gBAC7B,QAAQ,EAAE,IAAI,CAAC,aAAa,CAAC,QAAQ;aACtC,CAAC,CAAA;SACH;QACD,IAAI,KAAK,KAAK,YAAY;YAAE,sBAAY,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,aAAa,CAAC,IAAK,CAAC,CAAA;QAC5E,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IAC1B,CAAC;IAED;;;OAGG;IACG,eAAe,CACnB,GAAQ;;YAER,IAAI;gBACF,IAAI,CAAC,GAAG,CAAC,OAAO;oBACd,MAAM,IAAI,KAAK,CACb,iGAAiG,CAClG,CAAA;gBACH,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,IAAK,CAAC;oBAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAA;gBAC/E,MAAM,KAAK,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,IAAK,CAAC,CAAA;gBACnD,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;gBACjD,IAAI,KAAK;oBAAE,MAAM,KAAK,CAAA;gBACtB,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;aACzC;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;aACzC;QACH,CAAC;KAAA;CACF;AA1UD,4BA0UC"}
+{"version":3,"file":"GoTrueApi.js","sourceRoot":"","sources":["../../src/GoTrueApi.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,uCAAoD;AAEpD,+CAAgD;AAChD,2CAAuD;AACvD,2CAAyC;AAOzC,MAAqB,SAAS;IAO5B,YAAY,EACV,GAAG,GAAG,EAAE,EACR,OAAO,GAAG,EAAE,EACZ,aAAa,GAOd;QACC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;QACd,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,aAAa,mCAAQ,0BAAc,GAAK,aAAa,CAAE,CAAA;IAC9D,CAAC;IAED;;;;;;;;;OASG;IACG,eAAe,CACnB,KAAa,EACb,QAAgB,EAChB,UAGI,EAAE;;YAEN,IAAI;gBACF,IAAI,OAAO,qBAAQ,IAAI,CAAC,OAAO,CAAE,CAAA;gBACjC,IAAI,WAAW,GAAG,EAAE,CAAA;gBACpB,IAAI,OAAO,CAAC,UAAU,EAAE;oBACtB,WAAW,GAAG,eAAe,GAAG,kBAAkB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;iBACvE;gBACD,MAAM,IAAI,GAAG,MAAM,YAAI,CACrB,GAAG,IAAI,CAAC,GAAG,UAAU,WAAW,EAAE,EAClC,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,EACvC,EAAE,OAAO,EAAE,CACZ,CAAA;gBACD,IAAI,OAAO,qBAAQ,IAAI,CAAE,CAAA;gBACzB,IAAI,OAAO,CAAC,UAAU;oBAAE,OAAO,CAAC,UAAU,GAAG,mBAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;gBACvE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;aACtC;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;aAC7B;QACH,CAAC;KAAA;IAED;;;;;OAKG;IACG,eAAe,CACnB,KAAa,EACb,QAAgB,EAChB,UAEI,EAAE;;YAEN,IAAI;gBACF,IAAI,OAAO,qBAAQ,IAAI,CAAC,OAAO,CAAE,CAAA;gBACjC,IAAI,WAAW,GAAG,sBAAsB,CAAA;gBACxC,IAAI,OAAO,CAAC,UAAU,EAAE;oBACtB,WAAW,IAAI,eAAe,GAAG,kBAAkB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;iBACxE;gBACD,MAAM,IAAI,GAAG,MAAM,YAAI,CAAC,GAAG,IAAI,CAAC,GAAG,SAAS,WAAW,EAAE,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,CAAA;gBAC5F,IAAI,OAAO,qBAAQ,IAAI,CAAE,CAAA;gBACzB,IAAI,OAAO,CAAC,UAAU;oBAAE,OAAO,CAAC,UAAU,GAAG,mBAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;gBACvE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;aACtC;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;aAC7B;QACH,CAAC;KAAA;IAED;;;;;OAKG;IACG,eAAe,CACnB,KAAa,EACb,QAAgB,EAChB,UAEI,EAAE;;YAEN,IAAI;gBACF,IAAI,OAAO,qBAAQ,IAAI,CAAC,OAAO,CAAE,CAAA;gBACjC,MAAM,IAAI,GAAG,MAAM,YAAI,CACrB,GAAG,IAAI,CAAC,GAAG,SAAS,EACpB,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,EACvC,EAAE,OAAO,EAAE,CACZ,CAAA;gBACD,IAAI,OAAO,qBAAQ,IAAI,CAAE,CAAA;gBACzB,IAAI,OAAO,CAAC,UAAU;oBAAE,OAAO,CAAC,UAAU,GAAG,mBAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;gBACvE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;aACtC;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;aAC7B;QACH,CAAC;KAAA;IAED;;;;OAIG;IACG,eAAe,CACnB,KAAa,EACb,QAAgB;;YAEhB,IAAI;gBACF,IAAI,OAAO,qBAAQ,IAAI,CAAC,OAAO,CAAE,CAAA;gBACjC,IAAI,WAAW,GAAG,sBAAsB,CAAA;gBACxC,MAAM,IAAI,GAAG,MAAM,YAAI,CAAC,GAAG,IAAI,CAAC,GAAG,SAAS,WAAW,EAAE,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,CAAA;gBAC5F,IAAI,OAAO,qBAAQ,IAAI,CAAE,CAAA;gBACzB,IAAI,OAAO,CAAC,UAAU;oBAAE,OAAO,CAAC,UAAU,GAAG,mBAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;gBACvE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;aACtC;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;aAC7B;QACH,CAAC;KAAA;IAED;;;;OAIG;IACG,kBAAkB,CACtB,KAAa,EACb,UAEI,EAAE;;YAEN,IAAI;gBACF,IAAI,OAAO,qBAAQ,IAAI,CAAC,OAAO,CAAE,CAAA;gBACjC,IAAI,WAAW,GAAG,EAAE,CAAA;gBACpB,IAAI,OAAO,CAAC,UAAU,EAAE;oBACtB,WAAW,IAAI,eAAe,GAAG,kBAAkB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;iBACxE;gBACD,MAAM,IAAI,GAAG,MAAM,YAAI,CAAC,GAAG,IAAI,CAAC,GAAG,aAAa,WAAW,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,CAAA;gBACtF,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;aAC7B;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;aAC7B;QACH,CAAC;KAAA;IAED;;;OAGG;IACG,aAAa,CAAC,KAAa;;YAC/B,IAAI;gBACF,IAAI,OAAO,qBAAQ,IAAI,CAAC,OAAO,CAAE,CAAA;gBACjC,MAAM,IAAI,GAAG,MAAM,YAAI,CAAC,GAAG,IAAI,CAAC,GAAG,MAAM,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,CAAA;gBAClE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;aAC7B;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;aAC7B;QACH,CAAC;KAAA;IAED;;;;;OAKG;IACG,eAAe,CACnB,KAAa,EACb,KAAa,EACb,UAEI,EAAE;;YAEN,IAAI;gBACF,IAAI,OAAO,qBAAQ,IAAI,CAAC,OAAO,CAAE,CAAA;gBACjC,MAAM,IAAI,GAAG,MAAM,YAAI,CACrB,GAAG,IAAI,CAAC,GAAG,SAAS,EACpB,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,CAAC,UAAU,EAAE,EAC9D,EAAE,OAAO,EAAE,CACZ,CAAA;gBACD,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;aAC7B;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;aAC7B;QACH,CAAC;KAAA;IAED;;;;;OAKG;IACG,iBAAiB,CACrB,KAAa,EACb,UAGI,EAAE;;YAEN,IAAI;gBACF,IAAI,OAAO,qBAAQ,IAAI,CAAC,OAAO,CAAE,CAAA;gBACjC,IAAI,WAAW,GAAG,EAAE,CAAA;gBACpB,IAAI,OAAO,CAAC,UAAU,EAAE;oBACtB,WAAW,IAAI,eAAe,GAAG,kBAAkB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;iBACxE;gBACD,MAAM,IAAI,GAAG,MAAM,YAAI,CACrB,GAAG,IAAI,CAAC,GAAG,UAAU,WAAW,EAAE,EAClC,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,EAC7B,EAAE,OAAO,EAAE,CACZ,CAAA;gBACD,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;aAC7B;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;aAC7B;QACH,CAAC;KAAA;IAED;;;;OAIG;IACG,qBAAqB,CACzB,KAAa,EACb,UAEI,EAAE;;YAEN,IAAI;gBACF,IAAI,OAAO,qBAAQ,IAAI,CAAC,OAAO,CAAE,CAAA;gBACjC,IAAI,WAAW,GAAG,EAAE,CAAA;gBACpB,IAAI,OAAO,CAAC,UAAU,EAAE;oBACtB,WAAW,IAAI,eAAe,GAAG,kBAAkB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;iBACxE;gBACD,MAAM,IAAI,GAAG,MAAM,YAAI,CAAC,GAAG,IAAI,CAAC,GAAG,WAAW,WAAW,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,CAAA;gBACpF,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;aAC7B;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;aAC7B;QACH,CAAC;KAAA;IAED;;;;OAIG;IACK,qBAAqB,CAAC,GAAW;QACvC,MAAM,OAAO,qBAAQ,IAAI,CAAC,OAAO,CAAE,CAAA;QACnC,OAAO,CAAC,eAAe,CAAC,GAAG,UAAU,GAAG,EAAE,CAAA;QAC1C,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;OAGG;IACG,OAAO,CAAC,GAAW;;YACvB,IAAI;gBACF,MAAM,YAAI,CACR,GAAG,IAAI,CAAC,GAAG,SAAS,EACpB,EAAE,EACF,EAAE,OAAO,EAAE,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,CAClE,CAAA;gBACD,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;aACvB;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,EAAE,KAAK,EAAE,CAAA;aACjB;QACH,CAAC;KAAA;IAED;;;;;OAKG;IACH,iBAAiB,CACf,QAAkB,EAClB,OAGC;QAED,IAAI,SAAS,GAAa,CAAC,YAAY,kBAAkB,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;QACtE,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU,EAAE;YACvB,SAAS,CAAC,IAAI,CAAC,eAAe,kBAAkB,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC,CAAA;SACxE;QACD,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,EAAE;YACnB,SAAS,CAAC,IAAI,CAAC,UAAU,kBAAkB,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;SAC/D;QACD,OAAO,GAAG,IAAI,CAAC,GAAG,cAAc,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAA;IACvD,CAAC;IAED;;;OAGG;IACG,OAAO,CACX,GAAW;;YAEX,IAAI;gBACF,MAAM,IAAI,GAAQ,MAAM,WAAG,CAAC,GAAG,IAAI,CAAC,GAAG,OAAO,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;gBAC7F,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;aACzC;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;aACzC;QACH,CAAC;KAAA;IAED;;;;OAIG;IACG,UAAU,CACd,GAAW,EACX,UAA0B;;YAE1B,IAAI;gBACF,MAAM,IAAI,GAAQ,MAAM,WAAG,CAAC,GAAG,IAAI,CAAC,GAAG,OAAO,EAAE,UAAU,EAAE;oBAC1D,OAAO,EAAE,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC;iBACzC,CAAC,CAAA;gBACF,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;aACzC;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;aACzC;QACH,CAAC;KAAA;IAED;;;;;;;OAOG;IACG,UAAU,CACd,GAAW,EACX,GAAW;;YAEX,IAAI;gBACF,MAAM,IAAI,GAAQ,MAAM,cAAM,CAC5B,GAAG,IAAI,CAAC,GAAG,gBAAgB,GAAG,EAAE,EAChC,EAAE,EACF;oBACE,OAAO,EAAE,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC;iBACzC,CACF,CAAA;gBACD,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;aACzC;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;aACzC;QACH,CAAC;KAAA;IAED;;;OAGG;IACG,kBAAkB,CACtB,YAAoB;;YAEpB,IAAI;gBACF,MAAM,IAAI,GAAQ,MAAM,YAAI,CAC1B,GAAG,IAAI,CAAC,GAAG,iCAAiC,EAC5C,EAAE,aAAa,EAAE,YAAY,EAAE,EAC/B,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAC1B,CAAA;gBACD,IAAI,OAAO,qBAAQ,IAAI,CAAE,CAAA;gBACzB,IAAI,OAAO,CAAC,UAAU;oBAAE,OAAO,CAAC,UAAU,GAAG,mBAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;gBACvE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;aACtC;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;aAC7B;QACH,CAAC;KAAA;IAED;;;OAGG;IACH,aAAa,CAAC,GAAQ,EAAE,GAAQ;QAC9B,IAAI,GAAG,CAAC,MAAM,KAAK,MAAM,EAAE;YACzB,GAAG,CAAC,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;YAC9B,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAA;SAC1C;QACD,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,GAAG,CAAC,IAAI,CAAA;QACnC,IAAI,CAAC,KAAK;YAAE,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAA;QAClD,IAAI,KAAK,KAAK,WAAW,EAAE;YACzB,IAAI,CAAC,OAAO;gBAAE,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAA;YACtD,mBAAS,CAAC,GAAG,EAAE,GAAG,EAAE;gBAClB,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,IAAK;gBAC9B,KAAK,EAAE,OAAO,CAAC,YAAY;gBAC3B,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,MAAM;gBACjC,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,QAAS;gBACpC,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI;gBAC7B,QAAQ,EAAE,IAAI,CAAC,aAAa,CAAC,QAAQ;aACtC,CAAC,CAAA;SACH;QACD,IAAI,KAAK,KAAK,YAAY;YAAE,sBAAY,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,aAAa,CAAC,IAAK,CAAC,CAAA;QAC5E,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IAC1B,CAAC;IAED;;;OAGG;IACG,eAAe,CACnB,GAAQ;;YAER,IAAI;gBACF,IAAI,CAAC,GAAG,CAAC,OAAO;oBACd,MAAM,IAAI,KAAK,CACb,iGAAiG,CAClG,CAAA;gBACH,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,IAAK,CAAC;oBAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAA;gBAC/E,MAAM,KAAK,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,IAAK,CAAC,CAAA;gBACnD,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;gBACjD,IAAI,KAAK;oBAAE,MAAM,KAAK,CAAA;gBACtB,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;aACzC;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;aACzC;QACH,CAAC;KAAA;IAED;;;;;;;OAOG;IACG,YAAY,CAChB,IAAoD,EACpD,KAAa,EACb,UAII,EAAE;;YAEN,IAAI;gBACF,MAAM,IAAI,GAAQ,MAAM,YAAI,CAC1B,GAAG,IAAI,CAAC,GAAG,sBAAsB,EACjC;oBACE,IAAI;oBACJ,KAAK;oBACL,QAAQ,EAAE,OAAO,CAAC,QAAQ;oBAC1B,IAAI,EAAE,OAAO,CAAC,IAAI;oBAClB,WAAW,EAAE,OAAO,CAAC,UAAU;iBAChC,EACD,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAC1B,CAAA;gBACD,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;aAC7B;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;aAC7B;QACH,CAAC;KAAA;CACF;AArdD,4BAqdC"}

package/dist/main/GoTrueClient.d.ts

@@ -1,5 +1,11 @@
-import GoTrueApi from './GoTrueApi';
-import { Session, User, UserAttributes, Provider, Subscription, AuthChangeEvent, CookieOptions, UserCredentials } from './lib/types';
+import GoTrueApi, { ApiError } from './GoTrueApi';
+import { Session, User, UserAttributes, Provider, Subscription, AuthChangeEvent, CookieOptions, UserCredentials, VerifyOTPParams } from './lib/types';
+declare type AnyFunction = (...args: any[]) => any;
+declare type MaybePromisify<T> = T | Promise<T>;
+declare type PromisifyMethods<T> = {
+    [K in keyof T]: T[K] extends AnyFunction ? (...args: Parameters<T[K]>) => MaybePromisify<ReturnType<T[K]>> : T[K];
+};
+declare type SupportedStorage = PromisifyMethods<Pick<Storage, 'getItem' | 'setItem' | 'removeItem'>>;
 export default class GoTrueClient {
     /**
      * Namespace for the GoTrue API methods.
@@ -16,7 +22,7 @@ export default class GoTrueClient {
     protected currentSession: Session | null;
     protected autoRefreshToken: boolean;
     protected persistSession: boolean;
-    protected localStorage: Storage;
+    protected localStorage: SupportedStorage;
     protected stateChangeEmitters: Map<string, Subscription>;
     protected refreshTokenTimer?: ReturnType<typeof setTimeout>;
     /**
@@ -27,6 +33,7 @@ export default class GoTrueClient {
      * @param options.autoRefreshToken Set to "true" if you want to automatically refresh the token before expiring.
      * @param options.persistSession Set to "true" if you want to automatically save the user session into local storage.
      * @param options.localStorage
+     * @param options.cookieOptions
      */
     constructor(options: {
         url?: string;
@@ -36,7 +43,7 @@ export default class GoTrueClient {
         detectSessionInUrl?: boolean;
         autoRefreshToken?: boolean;
         persistSession?: boolean;
-        localStorage?: Storage;
+        localStorage?: SupportedStorage;
         cookieOptions?: CookieOptions;
     });
     /**
@@ -44,14 +51,17 @@ export default class GoTrueClient {
      * @type UserCredentials
      * @param email The user's email address.
      * @param password The user's password.
+     * @param phone The user's phone number.
      * @param redirectTo A URL or mobile address to send the user to after they are confirmed.
+     * @param data Optional user metadata.
      */
-    signUp({ email, password }: UserCredentials, options?: {
+    signUp({ email, password, phone }: UserCredentials, options?: {
         redirectTo?: string;
+        data?: object;
     }): Promise<{
         user: User | null;
         session: Session | null;
-        error: Error | null;
+        error: ApiError | null;
         data: Session | User | null;
     }>;
     /**
@@ -64,7 +74,7 @@ export default class GoTrueClient {
      * @param redirectTo A URL or mobile address to send the user to after they are confirmed.
      * @param scopes A space-separated list of scopes granted to the OAuth application.
      */
-    signIn({ email, password, refreshToken, provider }: UserCredentials, options?: {
+    signIn({ email, phone, password, refreshToken, provider }: UserCredentials, options?: {
         redirectTo?: string;
         scopes?: string;
     }): Promise<{
@@ -72,9 +82,23 @@ export default class GoTrueClient {
         user: User | null;
         provider?: Provider;
         url?: string | null;
-        error: Error | null;
+        error: ApiError | null;
         data: Session | null;
     }>;
+    /**
+     * Log in a user given a User supplied OTP received via mobile.
+     * @param phone The user's phone number.
+     * @param token The user's password.
+     * @param redirectTo A URL or mobile address to send the user to after they are confirmed.
+     */
+    verifyOTP({ phone, token }: VerifyOTPParams, options?: {
+        redirectTo?: string;
+    }): Promise<{
+        user: User | null;
+        session: Session | null;
+        error: ApiError | null;
+        data: Session | User | null;
+    }>;
     /**
      * Inside a browser context, `user()` will return the user data, if there is a logged in user.
      *
@@ -91,7 +115,7 @@ export default class GoTrueClient {
     refreshSession(): Promise<{
         data: Session | null;
         user: User | null;
-        error: Error | null;
+        error: ApiError | null;
     }>;
     /**
      * Updates user data, if there is a logged in user.
@@ -99,7 +123,7 @@ export default class GoTrueClient {
     update(attributes: UserAttributes): Promise<{
         data: User | null;
         user: User | null;
-        error: Error | null;
+        error: ApiError | null;
     }>;
     /**
      * Sets the session data from refresh_token and returns current Session and Error
@@ -107,7 +131,7 @@ export default class GoTrueClient {
      */
     setSession(refresh_token: string): Promise<{
         session: Session | null;
-        error: Error | null;
+        error: ApiError | null;
     }>;
     /**
      * Overrides the JWT on the current client. The JWT will then be sent in all subsequent network requests.
@@ -122,16 +146,16 @@ export default class GoTrueClient {
         storeSession?: boolean;
     }): Promise<{
         data: Session | null;
-        error: Error | null;
+        error: ApiError | null;
     }>;
     /**
-     * Inside a browser context, `signOut()` will remove extract the logged in user from the browser session
+     * Inside a browser context, `signOut()` will remove the logged in user from the browser session
      * and log them out - removing all items from localstorage and then trigger a "SIGNED_OUT" event.
      *
      * For server-side management, you can disable sessions by passing a JWT through to `auth.api.signOut(JWT: string)`
      */
     signOut(): Promise<{
-        error: Error | null;
+        error: ApiError | null;
     }>;
     /**
      * Receive a notification every time an auth event happens.
@@ -139,9 +163,10 @@ export default class GoTrueClient {
      */
     onAuthStateChange(callback: (event: AuthChangeEvent, session: Session | null) => void): {
         data: Subscription | null;
-        error: Error | null;
+        error: ApiError | null;
     };
     private _handleEmailSignIn;
+    private _handlePhoneSignIn;
     private _handleProviderSignIn;
     /**
      * Attempts to get the session from LocalStorage
@@ -168,4 +193,5 @@ export default class GoTrueClient {
      */
     private _startAutoRefreshToken;
 }
+export {};
 //# sourceMappingURL=GoTrueClient.d.ts.map

package/dist/main/GoTrueClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"GoTrueClient.d.ts","sourceRoot":"","sources":["../../src/GoTrueClient.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,aAAa,CAAA;AAGnC,OAAO,EACL,OAAO,EACP,IAAI,EACJ,cAAc,EACd,QAAQ,EACR,YAAY,EACZ,eAAe,EACf,aAAa,EACb,eAAe,EAChB,MAAM,aAAa,CAAA;AAapB,MAAM,CAAC,OAAO,OAAO,YAAY;IAC/B;;;OAGG;IACH,GAAG,EAAE,SAAS,CAAA;IACd;;OAEG;IACH,SAAS,CAAC,WAAW,EAAE,IAAI,GAAG,IAAI,CAAA;IAClC;;OAEG;IACH,SAAS,CAAC,cAAc,EAAE,OAAO,GAAG,IAAI,CAAA;IAExC,SAAS,CAAC,gBAAgB,EAAE,OAAO,CAAA;IACnC,SAAS,CAAC,cAAc,EAAE,OAAO,CAAA;IACjC,SAAS,CAAC,YAAY,EAAE,OAAO,CAAA;IAC/B,SAAS,CAAC,mBAAmB,EAAE,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAY;IACpE,SAAS,CAAC,iBAAiB,CAAC,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,CAAA;IAE3D;;;;;;;;OAQG;gBACS,OAAO,EAAE;QACnB,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,OAAO,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAA;QACnC,kBAAkB,CAAC,EAAE,OAAO,CAAA;QAC5B,gBAAgB,CAAC,EAAE,OAAO,CAAA;QAC1B,cAAc,CAAC,EAAE,OAAO,CAAA;QACxB,YAAY,CAAC,EAAE,OAAO,CAAA;QACtB,aAAa,CAAC,EAAE,aAAa,CAAA;KAC9B;IAyBD;;;;;;OAMG;IACG,MAAM,CACV,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,eAAe,EACpC,OAAO,GAAE;QACP,UAAU,CAAC,EAAE,MAAM,CAAA;KACf,GACL,OAAO,CAAC;QACT,IAAI,EAAE,IAAI,GAAG,IAAI,CAAA;QACjB,OAAO,EAAE,OAAO,GAAG,IAAI,CAAA;QACvB,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;QACnB,IAAI,EAAE,OAAO,GAAG,IAAI,GAAG,IAAI,CAAA;KAC5B,CAAC;IAoCF;;;;;;;;;OASG;IACG,MAAM,CACV,EAAE,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,QAAQ,EAAE,EAAE,eAAe,EAC5D,OAAO,GAAE;QACP,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,MAAM,CAAC,EAAE,MAAM,CAAA;KACX,GACL,OAAO,CAAC;QACT,OAAO,EAAE,OAAO,GAAG,IAAI,CAAA;QACvB,IAAI,EAAE,IAAI,GAAG,IAAI,CAAA;QACjB,QAAQ,CAAC,EAAE,QAAQ,CAAA;QACnB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QACnB,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;QACnB,IAAI,EAAE,OAAO,GAAG,IAAI,CAAA;KACrB,CAAC;IAuCF;;;;OAIG;IACH,IAAI,IAAI,IAAI,GAAG,IAAI;IAInB;;OAEG;IACH,OAAO,IAAI,OAAO,GAAG,IAAI;IAIzB;;OAEG;IACG,cAAc,IAAI,OAAO,CAAC;QAC9B,IAAI,EAAE,OAAO,GAAG,IAAI,CAAA;QACpB,IAAI,EAAE,IAAI,GAAG,IAAI,CAAA;QACjB,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;KACpB,CAAC;IAcF;;OAEG;IACG,MAAM,CACV,UAAU,EAAE,cAAc,GACzB,OAAO,CAAC;QAAE,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;QAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;KAAE,CAAC;IAqBzE;;;OAGG;IACG,UAAU,CACd,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;KAAE,CAAC;IAwB5D;;;OAGG;IACH,OAAO,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO;IAWtC;;;OAGG;IACG,iBAAiB,CAAC,OAAO,CAAC,EAAE;QAChC,YAAY,CAAC,EAAE,OAAO,CAAA;KACvB,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,OAAO,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;KAAE,CAAC;IAgD1D;;;;;OAKG;IACG,OAAO,IAAI,OAAO,CAAC;QAAE,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;KAAE,CAAC;IAWjD;;;OAGG;IACH,iBAAiB,CACf,QAAQ,EAAE,CAAC,KAAK,EAAE,eAAe,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,GAClE;QAAE,IAAI,EAAE,YAAY,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;KAAE;YAkBvC,kBAAkB;IAwBhC,OAAO,CAAC,qBAAqB;IAyB7B;;;OAGG;IACH,OAAO,CAAC,eAAe;IAoBvB;;;OAGG;YACW,kBAAkB;YAoClB,iBAAiB;IAkB/B,OAAO,CAAC,qBAAqB;IAI7B;;;OAGG;IACH,OAAO,CAAC,YAAY;IAmBpB,OAAO,CAAC,eAAe;YAKT,cAAc;IAO5B;;;OAGG;IACH,OAAO,CAAC,sBAAsB;CAO/B"}
+{"version":3,"file":"GoTrueClient.d.ts","sourceRoot":"","sources":["../../src/GoTrueClient.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,EAAE,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAGjD,OAAO,EACL,OAAO,EACP,IAAI,EACJ,cAAc,EACd,QAAQ,EACR,YAAY,EACZ,eAAe,EACf,aAAa,EACb,eAAe,EACf,eAAe,EAChB,MAAM,aAAa,CAAA;AAapB,aAAK,WAAW,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;AAC1C,aAAK,cAAc,CAAC,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;AAEvC,aAAK,gBAAgB,CAAC,CAAC,IAAI;KACxB,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,WAAW,GACpC,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAC/D,CAAC,CAAC,CAAC,CAAC;CACT,CAAA;AAED,aAAK,gBAAgB,GAAG,gBAAgB,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,GAAG,SAAS,GAAG,YAAY,CAAC,CAAC,CAAA;AAE7F,MAAM,CAAC,OAAO,OAAO,YAAY;IAC/B;;;OAGG;IACH,GAAG,EAAE,SAAS,CAAA;IACd;;OAEG;IACH,SAAS,CAAC,WAAW,EAAE,IAAI,GAAG,IAAI,CAAA;IAClC;;OAEG;IACH,SAAS,CAAC,cAAc,EAAE,OAAO,GAAG,IAAI,CAAA;IAExC,SAAS,CAAC,gBAAgB,EAAE,OAAO,CAAA;IACnC,SAAS,CAAC,cAAc,EAAE,OAAO,CAAA;IACjC,SAAS,CAAC,YAAY,EAAE,gBAAgB,CAAA;IACxC,SAAS,CAAC,mBAAmB,EAAE,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAY;IACpE,SAAS,CAAC,iBAAiB,CAAC,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,CAAA;IAE3D;;;;;;;;;OASG;gBACS,OAAO,EAAE;QACnB,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,OAAO,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAA;QACnC,kBAAkB,CAAC,EAAE,OAAO,CAAA;QAC5B,gBAAgB,CAAC,EAAE,OAAO,CAAA;QAC1B,cAAc,CAAC,EAAE,OAAO,CAAA;QACxB,YAAY,CAAC,EAAE,gBAAgB,CAAA;QAC/B,aAAa,CAAC,EAAE,aAAa,CAAA;KAC9B;IAyBD;;;;;;;;OAQG;IACG,MAAM,CACV,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,eAAe,EAC3C,OAAO,GAAE;QACP,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,IAAI,CAAC,EAAE,MAAM,CAAA;KACT,GACL,OAAO,CAAC;QACT,IAAI,EAAE,IAAI,GAAG,IAAI,CAAA;QACjB,OAAO,EAAE,OAAO,GAAG,IAAI,CAAA;QACvB,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAA;QACtB,IAAI,EAAE,OAAO,GAAG,IAAI,GAAG,IAAI,CAAA;KAC5B,CAAC;IA0CF;;;;;;;;;OASG;IACG,MAAM,CACV,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,QAAQ,EAAE,EAAE,eAAe,EACnE,OAAO,GAAE;QACP,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,MAAM,CAAC,EAAE,MAAM,CAAA;KACX,GACL,OAAO,CAAC;QACT,OAAO,EAAE,OAAO,GAAG,IAAI,CAAA;QACvB,IAAI,EAAE,IAAI,GAAG,IAAI,CAAA;QACjB,QAAQ,CAAC,EAAE,QAAQ,CAAA;QACnB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QACnB,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAA;QACtB,IAAI,EAAE,OAAO,GAAG,IAAI,CAAA;KACrB,CAAC;IA8CF;;;;;OAKG;IACG,SAAS,CACb,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,eAAe,EACjC,OAAO,GAAE;QACP,UAAU,CAAC,EAAE,MAAM,CAAA;KACf,GACL,OAAO,CAAC;QACT,IAAI,EAAE,IAAI,GAAG,IAAI,CAAA;QACjB,OAAO,EAAE,OAAO,GAAG,IAAI,CAAA;QACvB,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAA;QACtB,IAAI,EAAE,OAAO,GAAG,IAAI,GAAG,IAAI,CAAA;KAC5B,CAAC;IAkCF;;;;OAIG;IACH,IAAI,IAAI,IAAI,GAAG,IAAI;IAInB;;OAEG;IACH,OAAO,IAAI,OAAO,GAAG,IAAI;IAIzB;;OAEG;IACG,cAAc,IAAI,OAAO,CAAC;QAC9B,IAAI,EAAE,OAAO,GAAG,IAAI,CAAA;QACpB,IAAI,EAAE,IAAI,GAAG,IAAI,CAAA;QACjB,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAA;KACvB,CAAC;IAcF;;OAEG;IACG,MAAM,CACV,UAAU,EAAE,cAAc,GACzB,OAAO,CAAC;QAAE,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;QAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAA;KAAE,CAAC;IAqB5E;;;OAGG;IACG,UAAU,CACd,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAA;KAAE,CAAC;IAkB/D;;;OAGG;IACH,OAAO,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO;IAWtC;;;OAGG;IACG,iBAAiB,CAAC,OAAO,CAAC,EAAE;QAChC,YAAY,CAAC,EAAE,OAAO,CAAA;KACvB,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,OAAO,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAA;KAAE,CAAC;IAgD7D;;;;;OAKG;IACG,OAAO,IAAI,OAAO,CAAC;QAAE,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAA;KAAE,CAAC;IAWpD;;;OAGG;IACH,iBAAiB,CACf,QAAQ,EAAE,CAAC,KAAK,EAAE,eAAe,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,GAClE;QAAE,IAAI,EAAE,YAAY,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAA;KAAE;YAkB1C,kBAAkB;YAwBlB,kBAAkB;IAgBhC,OAAO,CAAC,qBAAqB;IAyB7B;;;OAGG;IACH,OAAO,CAAC,eAAe;IAoBvB;;;OAGG;YACW,kBAAkB;YAoClB,iBAAiB;IAkB/B,OAAO,CAAC,qBAAqB;IAI7B;;;OAGG;IACH,OAAO,CAAC,YAAY;IAmBpB,OAAO,CAAC,eAAe;YAKT,cAAc;IAO5B;;;OAGG;IACH,OAAO,CAAC,sBAAsB;CAO/B"}