@supabase/gotrue-js 1.21.7 → 1.22.2

package/dist/module/GoTrueApi.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { get, post, put, remove } from './lib/fetch';
 import { COOKIE_OPTIONS } from './lib/constants';
-import { setCookie, deleteCookie } from './lib/cookies';
+import { setCookies, getCookieString } from './lib/cookies';
 import { expiresAt } from './lib/helpers';
 export default class GoTrueApi {
     constructor({ url = '', headers = {}, cookieOptions, fetch, }) {
@@ -19,43 +19,34 @@ export default class GoTrueApi {
         this.fetch = fetch;
     }
     /**
-     * Creates a new user.
-     *
-     * This function should only be called on a server. Never expose your `service_role` key in the browser.
-     *
-     * @param attributes The data you want to create the user with.
-     * @param jwt A valid JWT. Must be a full-access API key (e.g. service_role key).
+     * Create a temporary object with all configured headers and
+     * adds the Authorization token to be used on request methods
+     * @param jwt A valid, logged-in JWT.
      */
-    createUser(attributes) {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                const data = yield post(this.fetch, `${this.url}/admin/users`, attributes, {
-                    headers: this.headers,
-                });
-                return { data, error: null };
-            }
-            catch (e) {
-                return { data: null, error: e };
-            }
-        });
+    _createRequestHeaders(jwt) {
+        const headers = Object.assign({}, this.headers);
+        headers['Authorization'] = `Bearer ${jwt}`;
+        return headers;
+    }
+    cookieName() {
+        var _a;
+        return (_a = this.cookieOptions.name) !== null && _a !== void 0 ? _a : '';
     }
     /**
-     * Get a list of users.
-     *
-     * This function should only be called on a server. Never expose your `service_role` key in the browser.
+     * Generates the relevant login URL for a third-party provider.
+     * @param provider One of the providers supported by GoTrue.
+     * @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.
      */
-    listUsers() {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                const data = yield get(this.fetch, `${this.url}/admin/users`, {
-                    headers: this.headers,
-                });
-                return { data: data.users, error: null };
-            }
-            catch (e) {
-                return { data: null, error: e };
-            }
-        });
+    getUrlForProvider(provider, options) {
+        const urlParams = [`provider=${encodeURIComponent(provider)}`];
+        if (options === null || options === void 0 ? void 0 : options.redirectTo) {
+            urlParams.push(`redirect_to=${encodeURIComponent(options.redirectTo)}`);
+        }
+        if (options === null || options === void 0 ? void 0 : options.scopes) {
+            urlParams.push(`scopes=${encodeURIComponent(options.scopes)}`);
+        }
+        return `${this.url}/authorize?${urlParams.join('&')}`;
     }
     /**
      * Creates a new user using their email address.
@@ -75,7 +66,12 @@ export default class GoTrueApi {
                 if (options.redirectTo) {
                     queryString = '?redirect_to=' + encodeURIComponent(options.redirectTo);
                 }
-                const data = yield post(this.fetch, `${this.url}/signup${queryString}`, { email, password, data: options.data }, { headers });
+                const data = yield post(this.fetch, `${this.url}/signup${queryString}`, {
+                    email,
+                    password,
+                    data: options.data,
+                    gotrue_meta_security: { hcaptcha_token: options.captchaToken },
+                }, { headers });
                 const session = Object.assign({}, data);
                 if (session.expires_in)
                     session.expires_at = expiresAt(data.expires_in);
@@ -121,7 +117,12 @@ export default class GoTrueApi {
         return __awaiter(this, void 0, void 0, function* () {
             try {
                 const headers = Object.assign({}, this.headers);
-                const data = yield post(this.fetch, `${this.url}/signup`, { phone, password, data: options.data }, { headers });
+                const data = yield post(this.fetch, `${this.url}/signup`, {
+                    phone,
+                    password,
+                    data: options.data,
+                    gotrue_meta_security: { hcaptcha_token: options.captchaToken },
+                }, { headers });
                 const session = Object.assign({}, data);
                 if (session.expires_in)
                     session.expires_at = expiresAt(data.expires_in);
@@ -153,9 +154,34 @@ export default class GoTrueApi {
             }
         });
     }
+    /**
+     * Logs in an OpenID Connect user using their id_token.
+     * @param id_token The IDToken of the user.
+     * @param nonce The nonce of the user. The nonce is a random value generated by the developer (= yourself) before the initial grant is started. You should check the OpenID Connect specification for details. https://openid.net/developers/specs/
+     * @param provider The provider of the user.
+     * @param client_id The clientID of the user.
+     * @param issuer The issuer of the user.
+     */
+    signInWithOpenIDConnect({ id_token, nonce, client_id, issuer, provider, }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const headers = Object.assign({}, this.headers);
+                const queryString = '?grant_type=id_token';
+                const data = yield post(this.fetch, `${this.url}/token${queryString}`, { id_token, nonce, client_id, issuer, provider }, { headers });
+                const session = Object.assign({}, data);
+                if (session.expires_in)
+                    session.expires_at = expiresAt(data.expires_in);
+                return { data: session, error: null };
+            }
+            catch (e) {
+                return { data: null, error: e };
+            }
+        });
+    }
     /**
      * Sends a magic login link to an email address.
      * @param email The email address of the user.
+     * @param shouldCreateUser A boolean flag to indicate whether to automatically create a user on magiclink / otp sign-ins if the user doesn't exist. Defaults to true.
      * @param redirectTo A URL or mobile address to send the user to after they are confirmed.
      */
     sendMagicLinkEmail(email, options = {}) {
@@ -166,7 +192,12 @@ export default class GoTrueApi {
                 if (options.redirectTo) {
                     queryString += '?redirect_to=' + encodeURIComponent(options.redirectTo);
                 }
-                const data = yield post(this.fetch, `${this.url}/magiclink${queryString}`, { email }, { headers });
+                const shouldCreateUser = options.shouldCreateUser ? options.shouldCreateUser : true;
+                const data = yield post(this.fetch, `${this.url}/otp${queryString}`, {
+                    email,
+                    create_user: shouldCreateUser,
+                    gotrue_meta_security: { hcaptcha_token: options.captchaToken },
+                }, { headers });
                 return { data, error: null };
             }
             catch (e) {
@@ -177,12 +208,18 @@ export default 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
+     * @param shouldCreateUser A boolean flag to indicate whether to automatically create a user on magiclink / otp sign-ins if the user doesn't exist. Defaults to true.
      */
-    sendMobileOTP(phone) {
+    sendMobileOTP(phone, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
+                const shouldCreateUser = options.shouldCreateUser ? options.shouldCreateUser : true;
                 const headers = Object.assign({}, this.headers);
-                const data = yield post(this.fetch, `${this.url}/otp`, { phone }, { headers });
+                const data = yield post(this.fetch, `${this.url}/otp`, {
+                    phone,
+                    create_user: shouldCreateUser,
+                    gotrue_meta_security: { hcaptcha_token: options.captchaToken },
+                }, { headers });
                 return { data, error: null };
             }
             catch (e) {
@@ -190,6 +227,21 @@ export default class GoTrueApi {
             }
         });
     }
+    /**
+     * Removes a logged-in session.
+     * @param jwt A valid, logged-in JWT.
+     */
+    signOut(jwt) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                yield post(this.fetch, `${this.url}/logout`, {}, { headers: this._createRequestHeaders(jwt), noResolveJson: true });
+                return { error: null };
+            }
+            catch (e) {
+                return { error: e };
+            }
+        });
+    }
     /**
      * Send User supplied Mobile OTP to be verified
      * @param phone The user's phone number WITH international prefix
@@ -243,7 +295,7 @@ export default class GoTrueApi {
                 if (options.redirectTo) {
                     queryString += '?redirect_to=' + encodeURIComponent(options.redirectTo);
                 }
-                const data = yield post(this.fetch, `${this.url}/recover${queryString}`, { email }, { headers });
+                const data = yield post(this.fetch, `${this.url}/recover${queryString}`, { email, gotrue_meta_security: { hcaptcha_token: options.captchaToken } }, { headers });
                 return { data, error: null };
             }
             catch (e) {
@@ -252,73 +304,157 @@ export default class GoTrueApi {
         });
     }
     /**
-     * Create a temporary object with all configured headers and
-     * adds the Authorization token to be used on request methods
-     * @param jwt A valid, logged-in JWT.
-     */
-    _createRequestHeaders(jwt) {
-        const headers = Object.assign({}, this.headers);
-        headers['Authorization'] = `Bearer ${jwt}`;
-        return headers;
-    }
-    /**
-     * Removes a logged-in session.
-     * @param jwt A valid, logged-in JWT.
+     * Generates a new JWT.
+     * @param refreshToken A valid refresh token that was returned on login.
      */
-    signOut(jwt) {
+    refreshAccessToken(refreshToken) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                yield post(this.fetch, `${this.url}/logout`, {}, { headers: this._createRequestHeaders(jwt), noResolveJson: true });
-                return { error: null };
+                const data = yield 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 = expiresAt(data.expires_in);
+                return { data: session, error: null };
             }
             catch (e) {
-                return { error: e };
+                return { data: null, error: e };
             }
         });
     }
     /**
-     * Generates the relevant login URL for a third-party provider.
-     * @param provider One of the providers supported by GoTrue.
-     * @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.
+     * Set/delete the auth cookie based on the AuthChangeEvent.
+     * Works for Next.js & Express (requires cookie-parser middleware).
+     * @param req The request object.
+     * @param res The response object.
      */
-    getUrlForProvider(provider, options) {
-        const urlParams = [`provider=${encodeURIComponent(provider)}`];
-        if (options === null || options === void 0 ? void 0 : options.redirectTo) {
-            urlParams.push(`redirect_to=${encodeURIComponent(options.redirectTo)}`);
+    setAuthCookie(req, res) {
+        if (req.method !== 'POST') {
+            res.setHeader('Allow', 'POST');
+            res.status(405).end('Method Not Allowed');
         }
-        if (options === null || options === void 0 ? void 0 : options.scopes) {
-            urlParams.push(`scopes=${encodeURIComponent(options.scopes)}`);
+        const { event, session } = req.body;
+        if (!event)
+            throw new Error('Auth event missing!');
+        if (event === 'SIGNED_IN') {
+            if (!session)
+                throw new Error('Auth session missing!');
+            setCookies(req, res, [
+                { key: 'access-token', value: session.access_token },
+                { key: 'refresh-token', value: session.refresh_token },
+            ].map((token) => {
+                var _a;
+                return ({
+                    name: `${this.cookieName()}-${token.key}`,
+                    value: token.value,
+                    domain: this.cookieOptions.domain,
+                    maxAge: (_a = this.cookieOptions.lifetime) !== null && _a !== void 0 ? _a : 0,
+                    path: this.cookieOptions.path,
+                    sameSite: this.cookieOptions.sameSite,
+                });
+            }));
         }
-        return `${this.url}/authorize?${urlParams.join('&')}`;
+        if (event === 'SIGNED_OUT') {
+            setCookies(req, res, ['access-token', 'refresh-token'].map((key) => ({
+                name: `${this.cookieName()}-${key}`,
+                value: '',
+                maxAge: -1,
+            })));
+        }
+        res.status(200).json({});
     }
     /**
-     * Gets the user details.
-     * @param jwt A valid, logged-in JWT.
+     * Deletes the Auth Cookies and redirects to the
+     * @param req The request object.
+     * @param res The response object.
+     * @param options Optionally specify a `redirectTo` URL in the options.
      */
-    getUser(jwt) {
+    deleteAuthCookie(req, res, { redirectTo = '/' }) {
+        setCookies(req, res, ['access-token', 'refresh-token'].map((key) => ({
+            name: `${this.cookieName()}-${key}`,
+            value: '',
+            maxAge: -1,
+        })));
+        return res.redirect(307, redirectTo);
+    }
+    /**
+     * Helper method to generate the Auth Cookie string for you in case you can't use `setAuthCookie`.
+     * @param req The request object.
+     * @param res The response object.
+     * @returns The Cookie string that needs to be set as the value for the `Set-Cookie` header.
+     */
+    getAuthCookieString(req, res) {
+        if (req.method !== 'POST') {
+            res.setHeader('Allow', 'POST');
+            res.status(405).end('Method Not Allowed');
+        }
+        const { event, session } = req.body;
+        if (!event)
+            throw new Error('Auth event missing!');
+        if (event === 'SIGNED_IN') {
+            if (!session)
+                throw new Error('Auth session missing!');
+            return getCookieString(req, res, [
+                { key: 'access-token', value: session.access_token },
+                { key: 'refresh-token', value: session.refresh_token },
+            ].map((token) => {
+                var _a;
+                return ({
+                    name: `${this.cookieName()}-${token.key}`,
+                    value: token.value,
+                    domain: this.cookieOptions.domain,
+                    maxAge: (_a = this.cookieOptions.lifetime) !== null && _a !== void 0 ? _a : 0,
+                    path: this.cookieOptions.path,
+                    sameSite: this.cookieOptions.sameSite,
+                });
+            }));
+        }
+        if (event === 'SIGNED_OUT') {
+            return getCookieString(req, res, ['access-token', 'refresh-token'].map((key) => ({
+                name: `${this.cookieName()}-${key}`,
+                value: '',
+                maxAge: -1,
+            })));
+        }
+        return res.getHeader('Set-Cookie');
+    }
+    /**
+     * 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 get(this.fetch, `${this.url}/user`, {
-                    headers: this._createRequestHeaders(jwt),
-                });
-                return { user: data, data, error: null };
+                const data = yield post(this.fetch, `${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 (e) {
-                return { user: null, data: null, error: e };
+                return { data: null, error: e };
             }
         });
     }
+    // User Admin API
     /**
-     * Updates the user data.
-     * @param jwt A valid, logged-in JWT.
-     * @param attributes The data you want to update.
+     * Creates a new user.
+     *
+     * This function should only be called on a server. Never expose your `service_role` key in the browser.
+     *
+     * @param attributes The data you want to create the user with.
      */
-    updateUser(jwt, attributes) {
+    createUser(attributes) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const data = yield put(this.fetch, `${this.url}/user`, attributes, {
-                    headers: this._createRequestHeaders(jwt),
+                const data = yield post(this.fetch, `${this.url}/admin/users`, attributes, {
+                    headers: this.headers,
                 });
                 return { user: data, data, error: null };
             }
@@ -328,90 +464,87 @@ export default class GoTrueApi {
         });
     }
     /**
-     * Delete a user. Requires a `service_role` key.
+     * Get a list of users.
      *
      * 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) {
+    listUsers() {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const data = yield remove(this.fetch, `${this.url}/admin/users/${uid}`, {}, {
-                    headers: this._createRequestHeaders(jwt),
+                const data = yield get(this.fetch, `${this.url}/admin/users`, {
+                    headers: this.headers,
                 });
-                return { user: data, data, error: null };
+                return { data: data.users, error: null };
             }
             catch (e) {
-                return { user: null, data: null, error: e };
+                return { data: null, error: e };
             }
         });
     }
     /**
-     * Generates a new JWT.
-     * @param refreshToken A valid refresh token that was returned on login.
+     * Get user by id.
+     *
+     * @param uid The user's unique identifier
+     *
+     * This function should only be called on a server. Never expose your `service_role` key in the browser.
      */
-    refreshAccessToken(refreshToken) {
+    getUserById(uid) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const data = yield 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 = expiresAt(data.expires_in);
-                return { data: session, error: null };
+                const data = yield get(this.fetch, `${this.url}/admin/users/${uid}`, {
+                    headers: this.headers,
+                });
+                return { data, error: null };
             }
             catch (e) {
                 return { data: null, error: e };
             }
         });
     }
-    /**
-     * Set/delete the auth cookie based on the AuthChangeEvent.
-     * Works for Next.js & Express (requires cookie-parser middleware).
-     */
-    setAuthCookie(req, res) {
-        if (req.method !== 'POST') {
-            res.setHeader('Allow', 'POST');
-            res.status(405).end('Method Not Allowed');
-        }
-        const { event, session } = req.body;
-        if (!event)
-            throw new Error('Auth event missing!');
-        if (event === 'SIGNED_IN') {
-            if (!session)
-                throw new Error('Auth session missing!');
-            setCookie(req, res, {
-                name: this.cookieOptions.name,
-                value: session.access_token,
-                domain: this.cookieOptions.domain,
-                maxAge: this.cookieOptions.lifetime,
-                path: this.cookieOptions.path,
-                sameSite: this.cookieOptions.sameSite,
-            });
-        }
-        if (event === 'SIGNED_OUT')
-            deleteCookie(req, res, this.cookieOptions.name);
-        res.status(200).json({});
-    }
     /**
      * Get user by reading the cookie from the request.
      * Works for Next.js & Express (requires cookie-parser middleware).
      */
-    getUserByCookie(req) {
+    getUserByCookie(req, res) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
                 if (!req.cookies) {
                     throw new Error('Not able to parse cookies! When using Express make sure the cookie-parser middleware is in use!');
                 }
-                if (!req.cookies[this.cookieOptions.name]) {
+                const access_token = req.cookies[`${this.cookieName()}-access-token`];
+                const refresh_token = req.cookies[`${this.cookieName()}-refresh-token`];
+                if (!access_token) {
                     throw new Error('No cookie found!');
                 }
-                const token = req.cookies[this.cookieOptions.name];
-                const { user, error } = yield this.getUser(token);
-                if (error)
-                    throw error;
-                return { token, user, data: user, error: null };
+                const { user, error: getUserError } = yield this.getUser(access_token);
+                if (getUserError) {
+                    if (!refresh_token)
+                        throw new Error('No refresh_token cookie found!');
+                    if (!res)
+                        throw new Error('You need to pass the res object to automatically refresh the session!');
+                    const { data, error } = yield this.refreshAccessToken(refresh_token);
+                    if (error) {
+                        throw error;
+                    }
+                    else if (data) {
+                        setCookies(req, res, [
+                            { key: 'access-token', value: data.access_token },
+                            { key: 'refresh-token', value: data.refresh_token },
+                        ].map((token) => {
+                            var _a;
+                            return ({
+                                name: `${this.cookieName()}-${token.key}`,
+                                value: token.value,
+                                domain: this.cookieOptions.domain,
+                                maxAge: (_a = this.cookieOptions.lifetime) !== null && _a !== void 0 ? _a : 0,
+                                path: this.cookieOptions.path,
+                                sameSite: this.cookieOptions.sameSite,
+                            });
+                        }));
+                        return { token: data.access_token, user: data.user, data: data.user, error: null };
+                    }
+                }
+                return { token: access_token, user: user, data: user, error: null };
             }
             catch (e) {
                 return { token: null, user: null, data: null, error: e };
@@ -419,27 +552,83 @@ export default 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").
+     * Updates the user data.
+     *
+     * @param attributes The data you want to update.
+     *
+     * This function should only be called on a server. Never expose your `service_role` key in the browser.
      */
-    generateLink(type, email, options = {}) {
+    updateUserById(uid, attributes) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const data = yield post(this.fetch, `${this.url}/admin/generate_link`, {
-                    type,
-                    email,
-                    password: options.password,
-                    data: options.data,
-                    redirect_to: options.redirectTo,
-                }, { headers: this.headers });
-                return { data, error: null };
+                this; //
+                const data = yield put(this.fetch, `${this.url}/admin/users/${uid}`, attributes, {
+                    headers: this.headers,
+                });
+                return { user: data, data, error: null };
             }
             catch (e) {
-                return { data: null, error: e };
+                return { user: null, data: null, error: e };
+            }
+        });
+    }
+    /**
+     * 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.
+     */
+    deleteUser(uid) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const data = yield remove(this.fetch, `${this.url}/admin/users/${uid}`, {}, {
+                    headers: this.headers,
+                });
+                return { user: data, data, error: null };
+            }
+            catch (e) {
+                return { user: null, data: null, error: e };
+            }
+        });
+    }
+    /**
+     * Gets the current user details.
+     *
+     * This method is called by the GoTrueClient `update` where
+     * the jwt is set to this.currentSession.access_token
+     * and therefore, acts like getting the currently authenticated used
+     *
+     * @param jwt A valid, logged-in JWT. Typically, the access_token for the currentSession
+     */
+    getUser(jwt) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const data = yield get(this.fetch, `${this.url}/user`, {
+                    headers: this._createRequestHeaders(jwt),
+                });
+                return { user: data, data, error: null };
+            }
+            catch (e) {
+                return { user: null, data: null, error: e };
+            }
+        });
+    }
+    /**
+     * Updates the user data.
+     * @param jwt A valid, logged-in JWT.
+     * @param attributes The data you want to update.
+     */
+    updateUser(jwt, attributes) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const data = yield put(this.fetch, `${this.url}/user`, attributes, {
+                    headers: this._createRequestHeaders(jwt),
+                });
+                return { user: data, data, error: null };
+            }
+            catch (e) {
+                return { user: null, data: null, error: e };
             }
         });
     }