@supabase/gotrue-js 1.17.0 → 1.20.0

package/README.md

@@ -25,9 +25,21 @@ 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
+
+### Custom `fetch` implementation
+
+`gotrue-js` uses the [`cross-fetch`](https://www.npmjs.com/package/cross-fetch) library to make HTTP requests, but an alternative `fetch` implementation can be provided as an option. This is most useful in environments where `cross-fetch` is not compatible, for instance Cloudflare Workers:
+
+```js
+import { GoTrueClient } from '@supabase/gotrue-js'
+
+const GOTRUE_URL = 'http://localhost:9999'
+
+const auth = new GoTrueClient({ url: GOTRUE_URL, fetch: fetch })
+```
 
 ## Sponsors
 
@@ -35,4 +47,4 @@ We are building the features of Firebase using enterprise-grade, open source pro
 
 [![New Sponsor](https://user-images.githubusercontent.com/10214025/90518111-e74bbb00-e198-11ea-8f88-c9e3c1aa4b5b.png)](https://github.com/sponsors/supabase)
 
-![Watch this repo](https://gitcdn.xyz/repo/supabase/monorepo/master/web/static/watch-repo.gif "Watch this repo")
+![Watch this repo](https://gitcdn.xyz/repo/supabase/monorepo/master/web/static/watch-repo.gif 'Watch this repo')

package/dist/main/GoTrueApi.d.ts

@@ -1,31 +1,40 @@
+import { Fetch } from './lib/fetch';
 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: {
         [key: string]: string;
     };
     protected cookieOptions: CookieOptions;
-    constructor({ url, headers, cookieOptions, }: {
+    protected fetch?: Fetch;
+    constructor({ url, headers, cookieOptions, fetch, }: {
         url: string;
         headers?: {
             [key: string]: string;
         };
         cookieOptions?: CookieOptions;
+        fetch?: Fetch;
     });
     /**
      * Creates a new user using their email address.
      * @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,25 +46,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 email address of the user.
+     * @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): Promise<{
+    signUpWithPhone(phone: string, password: string, options?: {
+        data?: object;
+    }): Promise<{
         data: Session | User | null;
-        error: Error | null;
+        error: ApiError | null;
     }>;
     /**
      * Logs in an existing user using their phone number and password.
-     * @param phone The email address of the user.
+     * @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: Error | null;
+        error: ApiError | null;
     }>;
     /**
      * Sends a magic login link to an email address.
@@ -66,7 +78,7 @@ 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
@@ -74,7 +86,7 @@ export default class GoTrueApi {
      */
     sendMobileOTP(phone: string): Promise<{
         data: {} | null;
-        error: Error | null;
+        error: ApiError | null;
     }>;
     /**
      * Send User supplied Mobile OTP to be verified
@@ -86,18 +98,20 @@ export default class GoTrueApi {
         redirectTo?: string;
     }): Promise<{
         data: Session | User | null;
-        error: Error | 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.
@@ -108,7 +122,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
@@ -121,7 +135,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.
@@ -140,7 +154,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.
@@ -150,17 +164,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.
@@ -168,7 +185,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.
@@ -182,7 +199,7 @@ 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.
@@ -194,11 +211,11 @@ export default class GoTrueApi {
      */
     generateLink(type: 'signup' | 'magiclink' | 'recovery' | 'invite', email: string, options?: {
         password?: string;
-        data?: any;
+        data?: object;
         redirectTo?: string;
     }): Promise<{
         data: Session | User | null;
-        error: Error | 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,eAAe,CACnB,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC;QAAE,IAAI,EAAE,OAAO,GAAG,IAAI,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;KAAE,CAAC;IAYhE;;;;OAIG;IACG,eAAe,CACnB,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC;QAAE,IAAI,EAAE,OAAO,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;KAAE,CAAC;IAazD;;;;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;;;OAGG;IACG,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,EAAE,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;KAAE,CAAC;IAUrF;;;;;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,KAAK,GAAG,IAAI,CAAA;KAAE,CAAC;IAchE;;;;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;IAgBzE;;;;;;;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,GAAG,CAAA;QACV,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;CAkBjE"}
+{"version":3,"file":"GoTrueApi.d.ts","sourceRoot":"","sources":["../../src/GoTrueApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAA0B,MAAM,aAAa,CAAA;AAC3D,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;IACtC,SAAS,CAAC,KAAK,CAAC,EAAE,KAAK,CAAA;gBAEX,EACV,GAAQ,EACR,OAAY,EACZ,aAAa,EACb,KAAK,GACN,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;QAC7B,KAAK,CAAC,EAAE,KAAK,CAAA;KACd;IAOD;;;;;;;;;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;IAqBnE;;;;;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;IAqB5D;;;;;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;IAiBnE;;;;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;IAkB5D;;;;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;IAmBvD;;;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;IAenE;;;;;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;IAmBzD;;;;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;IAmBvD;;;;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;IAc/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;IAW5E;;;;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;IAgB5E;;;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;IAgB5D;;;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;CAmBpE"}

package/dist/main/GoTrueApi.js

@@ -14,16 +14,18 @@ const constants_1 = require("./lib/constants");
 const cookies_1 = require("./lib/cookies");
 const helpers_1 = require("./lib/helpers");
 class GoTrueApi {
-    constructor({ url = '', headers = {}, cookieOptions, }) {
+    constructor({ url = '', headers = {}, cookieOptions, fetch, }) {
         this.url = url;
         this.headers = headers;
         this.cookieOptions = Object.assign(Object.assign({}, constants_1.COOKIE_OPTIONS), cookieOptions);
+        this.fetch = fetch;
     }
     /**
      * Creates a new user using their email address.
      * @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
@@ -31,19 +33,19 @@ class GoTrueApi {
     signUpWithEmail(email, password, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                let headers = Object.assign({}, this.headers);
+                const headers = Object.assign({}, this.headers);
                 let queryString = '';
                 if (options.redirectTo) {
                     queryString = '?redirect_to=' + encodeURIComponent(options.redirectTo);
                 }
-                const data = yield fetch_1.post(`${this.url}/signup${queryString}`, { email, password }, { headers });
-                let session = Object.assign({}, data);
+                const data = yield (0, fetch_1.post)(this.fetch, `${this.url}/signup${queryString}`, { email, password, data: options.data }, { headers });
+                const session = Object.assign({}, data);
                 if (session.expires_in)
-                    session.expires_at = helpers_1.expiresAt(data.expires_in);
+                    session.expires_at = (0, helpers_1.expiresAt)(data.expires_in);
                 return { data: session, error: null };
             }
-            catch (error) {
-                return { data: null, error };
+            catch (e) {
+                return { data: null, error: e };
             }
         });
     }
@@ -56,60 +58,61 @@ class GoTrueApi {
     signInWithEmail(email, password, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                let headers = Object.assign({}, this.headers);
+                const headers = Object.assign({}, this.headers);
                 let queryString = '?grant_type=password';
                 if (options.redirectTo) {
                     queryString += '&redirect_to=' + encodeURIComponent(options.redirectTo);
                 }
-                const data = yield fetch_1.post(`${this.url}/token${queryString}`, { email, password }, { headers });
-                let session = Object.assign({}, data);
+                const data = yield (0, fetch_1.post)(this.fetch, `${this.url}/token${queryString}`, { email, password }, { headers });
+                const session = Object.assign({}, data);
                 if (session.expires_in)
-                    session.expires_at = helpers_1.expiresAt(data.expires_in);
+                    session.expires_at = (0, helpers_1.expiresAt)(data.expires_in);
                 return { data: session, error: null };
             }
-            catch (error) {
-                return { data: null, error };
+            catch (e) {
+                return { data: null, error: e };
             }
         });
     }
     /**
      * Signs up a new user using their phone number and a password.
-     * @param phone The email address of the user.
+     * @param phone The phone number of the user.
      * @param password The password of the user.
+     * @param data Optional user metadata.
      */
-    signUpWithPhone(phone, password) {
+    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 }, { headers });
-                let session = Object.assign({}, data);
+                const headers = Object.assign({}, this.headers);
+                const data = yield (0, fetch_1.post)(this.fetch, `${this.url}/signup`, { phone, password, data: options.data }, { headers });
+                const session = Object.assign({}, data);
                 if (session.expires_in)
-                    session.expires_at = helpers_1.expiresAt(data.expires_in);
+                    session.expires_at = (0, helpers_1.expiresAt)(data.expires_in);
                 return { data: session, error: null };
             }
-            catch (error) {
-                return { data: null, error };
+            catch (e) {
+                return { data: null, error: e };
             }
         });
     }
     /**
      * Logs in an existing user using their phone number and password.
-     * @param phone The email address of the user.
+     * @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);
+                const headers = Object.assign({}, this.headers);
+                const queryString = '?grant_type=password';
+                const data = yield (0, fetch_1.post)(this.fetch, `${this.url}/token${queryString}`, { phone, password }, { headers });
+                const session = Object.assign({}, data);
                 if (session.expires_in)
-                    session.expires_at = helpers_1.expiresAt(data.expires_in);
+                    session.expires_at = (0, helpers_1.expiresAt)(data.expires_in);
                 return { data: session, error: null };
             }
-            catch (error) {
-                return { data: null, error };
+            catch (e) {
+                return { data: null, error: e };
             }
         });
     }
@@ -121,16 +124,16 @@ class GoTrueApi {
     sendMagicLinkEmail(email, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                let headers = Object.assign({}, this.headers);
+                const headers = Object.assign({}, this.headers);
                 let queryString = '';
                 if (options.redirectTo) {
                     queryString += '?redirect_to=' + encodeURIComponent(options.redirectTo);
                 }
-                const data = yield fetch_1.post(`${this.url}/magiclink${queryString}`, { email }, { headers });
+                const data = yield (0, fetch_1.post)(this.fetch, `${this.url}/magiclink${queryString}`, { email }, { headers });
                 return { data, error: null };
             }
-            catch (error) {
-                return { data: null, error };
+            catch (e) {
+                return { data: null, error: e };
             }
         });
     }
@@ -141,12 +144,12 @@ class GoTrueApi {
     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 });
+                const headers = Object.assign({}, this.headers);
+                const data = yield (0, fetch_1.post)(this.fetch, `${this.url}/otp`, { phone }, { headers });
                 return { data, error: null };
             }
-            catch (error) {
-                return { data: null, error };
+            catch (e) {
+                return { data: null, error: e };
             }
         });
     }
@@ -159,12 +162,12 @@ class GoTrueApi {
     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 });
+                const headers = Object.assign({}, this.headers);
+                const data = yield (0, fetch_1.post)(this.fetch, `${this.url}/verify`, { phone, token, type: 'sms', redirect_to: options.redirectTo }, { headers });
                 return { data, error: null };
             }
-            catch (error) {
-                return { data: null, error };
+            catch (e) {
+                return { data: null, error: e };
             }
         });
     }
@@ -172,20 +175,21 @@ class GoTrueApi {
      * 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* () {
             try {
-                let headers = Object.assign({}, this.headers);
+                const headers = Object.assign({}, this.headers);
                 let queryString = '';
                 if (options.redirectTo) {
                     queryString += '?redirect_to=' + encodeURIComponent(options.redirectTo);
                 }
-                const data = yield fetch_1.post(`${this.url}/invite${queryString}`, { email }, { headers });
+                const data = yield (0, fetch_1.post)(this.fetch, `${this.url}/invite${queryString}`, { email, data: options.data }, { headers });
                 return { data, error: null };
             }
-            catch (error) {
-                return { data: null, error };
+            catch (e) {
+                return { data: null, error: e };
             }
         });
     }
@@ -197,16 +201,16 @@ class GoTrueApi {
     resetPasswordForEmail(email, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                let headers = Object.assign({}, this.headers);
+                const headers = Object.assign({}, this.headers);
                 let queryString = '';
                 if (options.redirectTo) {
                     queryString += '?redirect_to=' + encodeURIComponent(options.redirectTo);
                 }
-                const data = yield fetch_1.post(`${this.url}/recover${queryString}`, { email }, { headers });
+                const data = yield (0, fetch_1.post)(this.fetch, `${this.url}/recover${queryString}`, { email }, { headers });
                 return { data, error: null };
             }
-            catch (error) {
-                return { data: null, error };
+            catch (e) {
+                return { data: null, error: e };
             }
         });
     }
@@ -227,11 +231,11 @@ class GoTrueApi {
     signOut(jwt) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                yield fetch_1.post(`${this.url}/logout`, {}, { headers: this._createRequestHeaders(jwt), noResolveJson: true });
+                yield (0, fetch_1.post)(this.fetch, `${this.url}/logout`, {}, { headers: this._createRequestHeaders(jwt), noResolveJson: true });
                 return { error: null };
             }
-            catch (error) {
-                return { error };
+            catch (e) {
+                return { error: e };
             }
         });
     }
@@ -242,7 +246,7 @@ class GoTrueApi {
      * @param scopes A space-separated list of scopes granted to the OAuth application.
      */
     getUrlForProvider(provider, options) {
-        let urlParams = [`provider=${encodeURIComponent(provider)}`];
+        const urlParams = [`provider=${encodeURIComponent(provider)}`];
         if (options === null || options === void 0 ? void 0 : options.redirectTo) {
             urlParams.push(`redirect_to=${encodeURIComponent(options.redirectTo)}`);
         }
@@ -258,11 +262,13 @@ class GoTrueApi {
     getUser(jwt) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const data = yield fetch_1.get(`${this.url}/user`, { headers: this._createRequestHeaders(jwt) });
+                const data = yield (0, fetch_1.get)(this.fetch, `${this.url}/user`, {
+                    headers: this._createRequestHeaders(jwt),
+                });
                 return { user: data, data, error: null };
             }
-            catch (error) {
-                return { user: null, data: null, error };
+            catch (e) {
+                return { user: null, data: null, error: e };
             }
         });
     }
@@ -274,31 +280,34 @@ class GoTrueApi {
     updateUser(jwt, attributes) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const data = yield fetch_1.put(`${this.url}/user`, attributes, {
+                const data = yield (0, fetch_1.put)(this.fetch, `${this.url}/user`, attributes, {
                     headers: this._createRequestHeaders(jwt),
                 });
                 return { user: data, data, error: null };
             }
-            catch (error) {
-                return { user: null, data: null, error };
+            catch (e) {
+                return { user: null, data: null, error: e };
             }
         });
     }
     /**
-     * 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, jwt) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const data = yield fetch_1.remove(`${this.url}/admin/users/${uid}`, {}, {
+                const data = yield (0, fetch_1.remove)(this.fetch, `${this.url}/admin/users/${uid}`, {}, {
                     headers: this._createRequestHeaders(jwt),
                 });
                 return { user: data, data, error: null };
             }
-            catch (error) {
-                return { user: null, data: null, error };
+            catch (e) {
+                return { user: null, data: null, error: e };
             }
         });
     }
@@ -309,14 +318,14 @@ class GoTrueApi {
     refreshAccessToken(refreshToken) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const data = yield fetch_1.post(`${this.url}/token?grant_type=refresh_token`, { refresh_token: refreshToken }, { headers: this.headers });
-                let session = Object.assign({}, data);
+                const data = yield (0, fetch_1.post)(this.fetch, `${this.url}/token?grant_type=refresh_token`, { refresh_token: refreshToken }, { headers: this.headers });
+                const session = Object.assign({}, data);
                 if (session.expires_in)
-                    session.expires_at = helpers_1.expiresAt(data.expires_in);
+                    session.expires_at = (0, helpers_1.expiresAt)(data.expires_in);
                 return { data: session, error: null };
             }
-            catch (error) {
-                return { data: null, error };
+            catch (e) {
+                return { data: null, error: e };
             }
         });
     }
@@ -335,7 +344,7 @@ class GoTrueApi {
         if (event === 'SIGNED_IN') {
             if (!session)
                 throw new Error('Auth session missing!');
-            cookies_1.setCookie(req, res, {
+            (0, cookies_1.setCookie)(req, res, {
                 name: this.cookieOptions.name,
                 value: session.access_token,
                 domain: this.cookieOptions.domain,
@@ -345,7 +354,7 @@ class GoTrueApi {
             });
         }
         if (event === 'SIGNED_OUT')
-            cookies_1.deleteCookie(req, res, this.cookieOptions.name);
+            (0, cookies_1.deleteCookie)(req, res, this.cookieOptions.name);
         res.status(200).json({});
     }
     /**
@@ -365,8 +374,8 @@ class GoTrueApi {
                     throw error;
                 return { user, data: user, error: null };
             }
-            catch (error) {
-                return { user: null, data: null, error };
+            catch (e) {
+                return { user: null, data: null, error: e };
             }
         });
     }
@@ -381,7 +390,7 @@ class GoTrueApi {
     generateLink(type, email, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const data = yield fetch_1.post(`${this.url}/admin/generate_link`, {
+                const data = yield (0, fetch_1.post)(this.fetch, `${this.url}/admin/generate_link`, {
                     type,
                     email,
                     password: options.password,
@@ -390,8 +399,8 @@ class GoTrueApi {
                 }, { headers: this.headers });
                 return { data, error: null };
             }
-            catch (error) {
-                return { data: null, error };
+            catch (e) {
+                return { data: null, error: e };
             }
         });
     }