@supabase/gotrue-js 1.23.1 → 2.0.0-rc.10

package/dist/main/GoTrueAdminApi.d.ts

@@ -0,0 +1,88 @@
+import { Fetch } from './lib/fetch';
+import { AdminUserAttributes, GenerateLinkParams, GenerateLinkResponse, User, UserResponse } from './lib/types';
+import { AuthError } from './lib/errors';
+export default class GoTrueAdminApi {
+    protected url: string;
+    protected headers: {
+        [key: string]: string;
+    };
+    protected fetch: Fetch;
+    constructor({ url, headers, fetch, }: {
+        url: string;
+        headers?: {
+            [key: string]: string;
+        };
+        fetch?: Fetch;
+    });
+    /**
+     * Removes a logged-in session.
+     * @param jwt A valid, logged-in JWT.
+     */
+    signOut(jwt: string): Promise<{
+        error: AuthError | null;
+    }>;
+    /**
+     * Sends an invite link to an email address.
+     * @param email The email address of the user.
+     * @param options.redirectTo A URL or mobile deeplink to send the user to after they are confirmed.
+     * @param options.data Optional user metadata
+     */
+    inviteUserByEmail(email: string, options?: {
+        redirectTo?: string;
+        data?: object;
+    }): Promise<UserResponse>;
+    /**
+     * Generates email links and OTPs to be sent via a custom email provider.
+     * @param email The user's email.
+     * @param options.password User password. For signup only.
+     * @param options.data Optional user metadata. For signup only.
+     * @param options.redirectTo The redirect url which should be appended to the generated link
+     */
+    generateLink(params: GenerateLinkParams): Promise<GenerateLinkResponse>;
+    /**
+     * Creates a new user.
+     * This function should only be called on a server. Never expose your `service_role` key in the browser.
+     */
+    createUser(attributes: AdminUserAttributes): Promise<UserResponse>;
+    /**
+     * Get a list of users.
+     *
+     * This function should only be called on a server. Never expose your `service_role` key in the browser.
+     */
+    listUsers(): Promise<{
+        data: {
+            users: User[];
+        };
+        error: null;
+    } | {
+        data: {
+            users: [];
+        };
+        error: AuthError;
+    }>;
+    /**
+     * 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.
+     */
+    getUserById(uid: string): Promise<UserResponse>;
+    /**
+     * 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.
+     */
+    updateUserById(uid: string, attributes: AdminUserAttributes): Promise<UserResponse>;
+    /**
+     * Delete a user. Requires a `service_role` key.
+     *
+     * @param id The user id you want to remove.
+     *
+     * This function should only be called on a server. Never expose your `service_role` key in the browser.
+     */
+    deleteUser(id: string): Promise<UserResponse>;
+}
+//# sourceMappingURL=GoTrueAdminApi.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"GoTrueAdminApi.d.ts","sourceRoot":"","sources":["../../src/GoTrueAdminApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAkD,MAAM,aAAa,CAAA;AAEnF,OAAO,EACL,mBAAmB,EACnB,kBAAkB,EAClB,oBAAoB,EACpB,IAAI,EACJ,YAAY,EACb,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,SAAS,EAAe,MAAM,cAAc,CAAA;AAErD,MAAM,CAAC,OAAO,OAAO,cAAc;IACjC,SAAS,CAAC,GAAG,EAAE,MAAM,CAAA;IACrB,SAAS,CAAC,OAAO,EAAE;QACjB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KACtB,CAAA;IACD,SAAS,CAAC,KAAK,EAAE,KAAK,CAAA;gBAEV,EACV,GAAQ,EACR,OAAY,EACZ,KAAK,GACN,EAAE;QACD,GAAG,EAAE,MAAM,CAAA;QACX,OAAO,CAAC,EAAE;YACR,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SACtB,CAAA;QACD,KAAK,CAAC,EAAE,KAAK,CAAA;KACd;IAMD;;;OAGG;IACG,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,SAAS,GAAG,IAAI,CAAA;KAAE,CAAC;IAiBhE;;;;;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,YAAY,CAAC;IAiBxB;;;;;;OAMG;IACG,YAAY,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IA8B7E;;;OAGG;IACG,UAAU,CAAC,UAAU,EAAE,mBAAmB,GAAG,OAAO,CAAC,YAAY,CAAC;IAgBxE;;;;OAIG;IACG,SAAS,IAAI,OAAO,CACxB;QAAE,IAAI,EAAE;YAAE,KAAK,EAAE,IAAI,EAAE,CAAA;SAAE,CAAC;QAAC,KAAK,EAAE,IAAI,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE;YAAE,KAAK,EAAE,EAAE,CAAA;SAAE,CAAC;QAAC,KAAK,EAAE,SAAS,CAAA;KAAE,CACrF;IAeD;;;;;;OAMG;IACG,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAerD;;;;;;OAMG;IACG,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,mBAAmB,GAAG,OAAO,CAAC,YAAY,CAAC;IAgBzF;;;;;;OAMG;IACG,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;CAcpD"}

package/dist/main/GoTrueAdminApi.js

@@ -0,0 +1,233 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fetch_1 = require("./lib/fetch");
+const helpers_1 = require("./lib/helpers");
+const errors_1 = require("./lib/errors");
+class GoTrueAdminApi {
+    constructor({ url = '', headers = {}, fetch, }) {
+        this.url = url;
+        this.headers = headers;
+        this.fetch = (0, helpers_1.resolveFetch)(fetch);
+    }
+    /**
+     * Removes a logged-in session.
+     * @param jwt A valid, logged-in JWT.
+     */
+    signOut(jwt) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                yield (0, fetch_1._request)(this.fetch, 'POST', `${this.url}/logout`, {
+                    headers: this.headers,
+                    jwt,
+                    noResolveJson: true,
+                });
+                return { error: null };
+            }
+            catch (error) {
+                if ((0, errors_1.isAuthError)(error)) {
+                    return { error };
+                }
+                throw error;
+            }
+        });
+    }
+    /**
+     * Sends an invite link to an email address.
+     * @param email The email address of the user.
+     * @param options.redirectTo A URL or mobile deeplink to send the user to after they are confirmed.
+     * @param options.data Optional user metadata
+     */
+    inviteUserByEmail(email, options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                return yield (0, fetch_1._request)(this.fetch, 'POST', `${this.url}/invite`, {
+                    body: { email, data: options.data },
+                    headers: this.headers,
+                    redirectTo: options.redirectTo,
+                    xform: fetch_1._userResponse,
+                });
+            }
+            catch (error) {
+                if ((0, errors_1.isAuthError)(error)) {
+                    return { data: { user: null }, error };
+                }
+                throw error;
+            }
+        });
+    }
+    /**
+     * Generates email links and OTPs to be sent via a custom email provider.
+     * @param email The user's email.
+     * @param options.password User password. For signup only.
+     * @param options.data Optional user metadata. For signup only.
+     * @param options.redirectTo The redirect url which should be appended to the generated link
+     */
+    generateLink(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const { options } = params, rest = __rest(params, ["options"]);
+                const body = Object.assign(Object.assign({}, rest), options);
+                if ('newEmail' in rest) {
+                    // replace newEmail with new_email in request body
+                    body.new_email = rest === null || rest === void 0 ? void 0 : rest.newEmail;
+                    delete body['newEmail'];
+                }
+                return yield (0, fetch_1._request)(this.fetch, 'POST', `${this.url}/admin/generate_link`, {
+                    body: body,
+                    headers: this.headers,
+                    xform: fetch_1._generateLinkResponse,
+                    redirectTo: options === null || options === void 0 ? void 0 : options.redirectTo,
+                });
+            }
+            catch (error) {
+                if ((0, errors_1.isAuthError)(error)) {
+                    return {
+                        data: {
+                            properties: null,
+                            user: null,
+                        },
+                        error,
+                    };
+                }
+                throw error;
+            }
+        });
+    }
+    // User Admin API
+    /**
+     * Creates a new user.
+     * This function should only be called on a server. Never expose your `service_role` key in the browser.
+     */
+    createUser(attributes) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                return yield (0, fetch_1._request)(this.fetch, 'POST', `${this.url}/admin/users`, {
+                    body: attributes,
+                    headers: this.headers,
+                    xform: fetch_1._userResponse,
+                });
+            }
+            catch (error) {
+                if ((0, errors_1.isAuthError)(error)) {
+                    return { data: { user: null }, error };
+                }
+                throw error;
+            }
+        });
+    }
+    /**
+     * Get a list of users.
+     *
+     * This function should only be called on a server. Never expose your `service_role` key in the browser.
+     */
+    listUsers() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const { data, error } = yield (0, fetch_1._request)(this.fetch, 'GET', `${this.url}/admin/users`, {
+                    headers: this.headers,
+                });
+                if (error)
+                    throw error;
+                return { data: Object.assign({}, data), error: null };
+            }
+            catch (error) {
+                if ((0, errors_1.isAuthError)(error)) {
+                    return { data: { users: [] }, error };
+                }
+                throw error;
+            }
+        });
+    }
+    /**
+     * 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.
+     */
+    getUserById(uid) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                return yield (0, fetch_1._request)(this.fetch, 'GET', `${this.url}/admin/users/${uid}`, {
+                    headers: this.headers,
+                    xform: fetch_1._userResponse,
+                });
+            }
+            catch (error) {
+                if ((0, errors_1.isAuthError)(error)) {
+                    return { data: { user: null }, error };
+                }
+                throw error;
+            }
+        });
+    }
+    /**
+     * 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.
+     */
+    updateUserById(uid, attributes) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                return yield (0, fetch_1._request)(this.fetch, 'PUT', `${this.url}/admin/users/${uid}`, {
+                    body: attributes,
+                    headers: this.headers,
+                    xform: fetch_1._userResponse,
+                });
+            }
+            catch (error) {
+                if ((0, errors_1.isAuthError)(error)) {
+                    return { data: { user: null }, error };
+                }
+                throw error;
+            }
+        });
+    }
+    /**
+     * Delete a user. Requires a `service_role` key.
+     *
+     * @param id The user id you want to remove.
+     *
+     * This function should only be called on a server. Never expose your `service_role` key in the browser.
+     */
+    deleteUser(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                return yield (0, fetch_1._request)(this.fetch, 'DELETE', `${this.url}/admin/users/${id}`, {
+                    headers: this.headers,
+                    xform: fetch_1._userResponse,
+                });
+            }
+            catch (error) {
+                if ((0, errors_1.isAuthError)(error)) {
+                    return { data: { user: null }, error };
+                }
+                throw error;
+            }
+        });
+    }
+}
+exports.default = GoTrueAdminApi;
+//# sourceMappingURL=GoTrueAdminApi.js.map

package/dist/main/GoTrueAdminApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GoTrueAdminApi.js","sourceRoot":"","sources":["../../src/GoTrueAdminApi.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,uCAAmF;AACnF,2CAA4C;AAQ5C,yCAAqD;AAErD,MAAqB,cAAc;IAOjC,YAAY,EACV,GAAG,GAAG,EAAE,EACR,OAAO,GAAG,EAAE,EACZ,KAAK,GAON;QACC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;QACd,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,KAAK,GAAG,IAAA,sBAAY,EAAC,KAAK,CAAC,CAAA;IAClC,CAAC;IAED;;;OAGG;IACG,OAAO,CAAC,GAAW;;YACvB,IAAI;gBACF,MAAM,IAAA,gBAAQ,EAAC,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,SAAS,EAAE;oBACvD,OAAO,EAAE,IAAI,CAAC,OAAO;oBACrB,GAAG;oBACH,aAAa,EAAE,IAAI;iBACpB,CAAC,CAAA;gBACF,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;aACvB;YAAC,OAAO,KAAK,EAAE;gBACd,IAAI,IAAA,oBAAW,EAAC,KAAK,CAAC,EAAE;oBACtB,OAAO,EAAE,KAAK,EAAE,CAAA;iBACjB;gBAED,MAAM,KAAK,CAAA;aACZ;QACH,CAAC;KAAA;IAED;;;;;OAKG;IACG,iBAAiB,CACrB,KAAa,EACb,UAGI,EAAE;;YAEN,IAAI;gBACF,OAAO,MAAM,IAAA,gBAAQ,EAAC,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,SAAS,EAAE;oBAC9D,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE;oBACnC,OAAO,EAAE,IAAI,CAAC,OAAO;oBACrB,UAAU,EAAE,OAAO,CAAC,UAAU;oBAC9B,KAAK,EAAE,qBAAa;iBACrB,CAAC,CAAA;aACH;YAAC,OAAO,KAAK,EAAE;gBACd,IAAI,IAAA,oBAAW,EAAC,KAAK,CAAC,EAAE;oBACtB,OAAO,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,CAAA;iBACvC;gBAED,MAAM,KAAK,CAAA;aACZ;QACH,CAAC;KAAA;IAED;;;;;;OAMG;IACG,YAAY,CAAC,MAA0B;;YAC3C,IAAI;gBACF,MAAM,EAAE,OAAO,KAAc,MAAM,EAAf,IAAI,UAAK,MAAM,EAA7B,WAAoB,CAAS,CAAA;gBACnC,MAAM,IAAI,mCAAa,IAAI,GAAK,OAAO,CAAE,CAAA;gBACzC,IAAI,UAAU,IAAI,IAAI,EAAE;oBACtB,kDAAkD;oBAClD,IAAI,CAAC,SAAS,GAAG,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,CAAA;oBAC/B,OAAO,IAAI,CAAC,UAAU,CAAC,CAAA;iBACxB;gBACD,OAAO,MAAM,IAAA,gBAAQ,EAAC,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,sBAAsB,EAAE;oBAC3E,IAAI,EAAE,IAAI;oBACV,OAAO,EAAE,IAAI,CAAC,OAAO;oBACrB,KAAK,EAAE,6BAAqB;oBAC5B,UAAU,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU;iBAChC,CAAC,CAAA;aACH;YAAC,OAAO,KAAK,EAAE;gBACd,IAAI,IAAA,oBAAW,EAAC,KAAK,CAAC,EAAE;oBACtB,OAAO;wBACL,IAAI,EAAE;4BACJ,UAAU,EAAE,IAAI;4BAChB,IAAI,EAAE,IAAI;yBACX;wBACD,KAAK;qBACN,CAAA;iBACF;gBACD,MAAM,KAAK,CAAA;aACZ;QACH,CAAC;KAAA;IAED,iBAAiB;IACjB;;;OAGG;IACG,UAAU,CAAC,UAA+B;;YAC9C,IAAI;gBACF,OAAO,MAAM,IAAA,gBAAQ,EAAC,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,cAAc,EAAE;oBACnE,IAAI,EAAE,UAAU;oBAChB,OAAO,EAAE,IAAI,CAAC,OAAO;oBACrB,KAAK,EAAE,qBAAa;iBACrB,CAAC,CAAA;aACH;YAAC,OAAO,KAAK,EAAE;gBACd,IAAI,IAAA,oBAAW,EAAC,KAAK,CAAC,EAAE;oBACtB,OAAO,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,CAAA;iBACvC;gBAED,MAAM,KAAK,CAAA;aACZ;QACH,CAAC;KAAA;IAED;;;;OAIG;IACG,SAAS;;YAGb,IAAI;gBACF,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,IAAA,gBAAQ,EAAC,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,cAAc,EAAE;oBACnF,OAAO,EAAE,IAAI,CAAC,OAAO;iBACtB,CAAC,CAAA;gBACF,IAAI,KAAK;oBAAE,MAAM,KAAK,CAAA;gBACtB,OAAO,EAAE,IAAI,oBAAO,IAAI,CAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;aAC1C;YAAC,OAAO,KAAK,EAAE;gBACd,IAAI,IAAA,oBAAW,EAAC,KAAK,CAAC,EAAE;oBACtB,OAAO,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,CAAA;iBACtC;gBACD,MAAM,KAAK,CAAA;aACZ;QACH,CAAC;KAAA;IAED;;;;;;OAMG;IACG,WAAW,CAAC,GAAW;;YAC3B,IAAI;gBACF,OAAO,MAAM,IAAA,gBAAQ,EAAC,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,gBAAgB,GAAG,EAAE,EAAE;oBACzE,OAAO,EAAE,IAAI,CAAC,OAAO;oBACrB,KAAK,EAAE,qBAAa;iBACrB,CAAC,CAAA;aACH;YAAC,OAAO,KAAK,EAAE;gBACd,IAAI,IAAA,oBAAW,EAAC,KAAK,CAAC,EAAE;oBACtB,OAAO,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,CAAA;iBACvC;gBAED,MAAM,KAAK,CAAA;aACZ;QACH,CAAC;KAAA;IAED;;;;;;OAMG;IACG,cAAc,CAAC,GAAW,EAAE,UAA+B;;YAC/D,IAAI;gBACF,OAAO,MAAM,IAAA,gBAAQ,EAAC,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,gBAAgB,GAAG,EAAE,EAAE;oBACzE,IAAI,EAAE,UAAU;oBAChB,OAAO,EAAE,IAAI,CAAC,OAAO;oBACrB,KAAK,EAAE,qBAAa;iBACrB,CAAC,CAAA;aACH;YAAC,OAAO,KAAK,EAAE;gBACd,IAAI,IAAA,oBAAW,EAAC,KAAK,CAAC,EAAE;oBACtB,OAAO,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,CAAA;iBACvC;gBAED,MAAM,KAAK,CAAA;aACZ;QACH,CAAC;KAAA;IAED;;;;;;OAMG;IACG,UAAU,CAAC,EAAU;;YACzB,IAAI;gBACF,OAAO,MAAM,IAAA,gBAAQ,EAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,GAAG,gBAAgB,EAAE,EAAE,EAAE;oBAC3E,OAAO,EAAE,IAAI,CAAC,OAAO;oBACrB,KAAK,EAAE,qBAAa;iBACrB,CAAC,CAAA;aACH;YAAC,OAAO,KAAK,EAAE;gBACd,IAAI,IAAA,oBAAW,EAAC,KAAK,CAAC,EAAE;oBACtB,OAAO,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,CAAA;iBACvC;gBAED,MAAM,KAAK,CAAA;aACZ;QACH,CAAC;KAAA;CACF;AA1ND,iCA0NC"}

package/dist/main/GoTrueClient.d.ts

@@ -1,187 +1,171 @@
-import GoTrueApi from './GoTrueApi';
+import GoTrueAdminApi from './GoTrueAdminApi';
+import { AuthError } from './lib/errors';
 import { Fetch } from './lib/fetch';
-import type { ApiError, Session, User, UserAttributes, Provider, Subscription, AuthChangeEvent, CookieOptions, UserCredentials, VerifyOTPParams, SupportedStorage } from './lib/types';
+import { Deferred } from './lib/helpers';
+import type { AuthChangeEvent, AuthResponse, CallRefreshTokenResult, GoTrueClientOptions, InitializeResult, OAuthResponse, Session, SignInWithOAuthCredentials, SignInWithPasswordCredentials, SignInWithPasswordlessCredentials, SignUpWithPasswordCredentials, Subscription, SupportedStorage, UserAttributes, UserResponse, VerifyOtpParams } from './lib/types';
 export default class GoTrueClient {
     /**
-     * Namespace for the GoTrue API methods.
-     * These can be used for example to get a user from a JWT in a server environment or reset a user's password.
+     * Namespace for the GoTrue admin methods.
+     * These methods should only be used in a trusted server-side environment.
      */
-    api: GoTrueApi;
+    admin: GoTrueAdminApi;
     /**
-     * The currently logged in user or null.
+     * The storage key used to identify the values saved in localStorage
      */
-    protected currentUser: User | null;
+    protected storageKey: string;
     /**
-     * The session object for the currently logged in user or null.
+     * The session object for the currently logged in user. If null, it means there isn't a logged-in user.
+     * Only used if persistSession is false.
      */
-    protected currentSession: Session | null;
+    protected inMemorySession: Session | null;
     protected autoRefreshToken: boolean;
     protected persistSession: boolean;
-    protected localStorage: SupportedStorage;
-    protected multiTab: boolean;
+    protected storage: SupportedStorage;
     protected stateChangeEmitters: Map<string, Subscription>;
     protected refreshTokenTimer?: ReturnType<typeof setTimeout>;
     protected networkRetries: number;
+    protected refreshingDeferred: Deferred<CallRefreshTokenResult> | null;
+    /**
+     * Keeps track of the async client initialization.
+     * When null or not yet resolved the auth state is `unknown`
+     * Once resolved the the auth state is known and it's save to call any further client methods.
+     * Keep extra care to never reject or throw uncaught errors
+     */
+    protected initializePromise: Promise<InitializeResult> | null;
+    protected detectSessionInUrl: boolean;
+    protected url: string;
+    protected headers: {
+        [key: string]: string;
+    };
+    protected fetch: Fetch;
     /**
      * Create a new client for use in the browser.
-     * @param options.url The URL of the GoTrue server.
-     * @param options.headers Any additional headers to send to the GoTrue server.
-     * @param options.detectSessionInUrl Set to "true" if you want to automatically detects OAuth grants in the URL and signs in the user.
-     * @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 Provide your own local storage implementation to use instead of the browser's local storage.
-     * @param options.multiTab Set to "false" if you want to disable multi-tab/window events.
-     * @param options.cookieOptions
-     * @param options.fetch A custom fetch implementation.
-     */
-    constructor(options: {
-        url?: string;
-        headers?: {
-            [key: string]: string;
-        };
-        detectSessionInUrl?: boolean;
-        autoRefreshToken?: boolean;
-        persistSession?: boolean;
-        localStorage?: SupportedStorage;
-        multiTab?: boolean;
-        cookieOptions?: CookieOptions;
-        fetch?: Fetch;
-    });
+     */
+    constructor(options: GoTrueClientOptions);
+    /**
+     * Initializes the client session either from the url or from storage.
+     * This method is automatically called when instantiating the client, but should also be called
+     * manually when checking for an error from an auth redirect (oauth, magiclink, password recovery, etc).
+     */
+    initialize(): Promise<InitializeResult>;
+    /**
+     * IMPORTANT:
+     * 1. Never throw in this method, as it is called from the constructor
+     * 2. Never return a session from this method as it would be cached over
+     *    the whole lifetime of the client
+     */
+    private _initialize;
     /**
      * Creates a new user.
-     * @type UserCredentials
-     * @param email The user's email address.
-     * @param password The user's password.
-     * @param phone The user's phone number.
-     * @param redirectTo The redirect URL attached to the signup confirmation link. Does not redirect the user if it's a mobile signup.
-     * @param data Optional user metadata.
-     */
-    signUp({ email, password, phone }: UserCredentials, options?: {
-        redirectTo?: string;
-        data?: object;
-        captchaToken?: string;
-    }): Promise<{
-        user: User | null;
-        session: Session | null;
-        error: ApiError | null;
-    }>;
+     * @returns A logged-in session if the server has "autoconfirm" ON
+     * @returns A user if the server has "autoconfirm" OFF
+     */
+    signUp(credentials: SignUpWithPasswordCredentials): Promise<AuthResponse>;
     /**
-     * Log in an existing user, or login via a third-party provider.
-     * @type UserCredentials
-     * @param email The user's email address.
-     * @param phone The user's phone number.
-     * @param password The user's password.
-     * @param refreshToken A valid refresh token that was returned on login.
-     * @param provider One of the providers supported by GoTrue.
-     * @param redirectTo A URL to send the user to after they are confirmed (OAuth logins only).
-     * @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 scopes A space-separated list of scopes granted to the OAuth application.
+     * Log in an existing user with an email and password or phone and password.
      */
-    signIn({ email, phone, password, refreshToken, provider, oidc }: UserCredentials, options?: {
-        redirectTo?: string;
-        shouldCreateUser?: boolean;
-        scopes?: string;
-        captchaToken?: string;
-        queryParams?: {
-            [key: string]: string;
-        };
-    }): Promise<{
-        session: Session | null;
-        user: User | null;
-        provider?: Provider;
-        url?: string | null;
-        error: ApiError | null;
-    }>;
+    signInWithPassword(credentials: SignInWithPasswordCredentials): Promise<AuthResponse>;
     /**
-     * Log in a user given a User supplied OTP received via mobile.
-     * @param email The user's email address.
-     * @param phone The user's phone number.
-     * @param token The user's password.
-     * @param type The user's verification type.
-     * @param redirectTo A URL or mobile address to send the user to after they are confirmed.
+     * Log in an existing user via a third-party provider.
      */
-    verifyOTP(params: VerifyOTPParams, options?: {
-        redirectTo?: string;
-    }): Promise<{
-        user: User | null;
-        session: Session | null;
-        error: ApiError | null;
-    }>;
+    signInWithOAuth(credentials: SignInWithOAuthCredentials): Promise<OAuthResponse>;
     /**
-     * Inside a browser context, `user()` will return the user data, if there is a logged in user.
-     *
-     * For server-side management, you can get a user through `auth.api.getUserByCookie()`
+     * Log in a user using magiclink or a one-time password (OTP).
+     * If the `{{ .ConfirmationURL }}` variable is specified in the email template, a magiclink will be sent.
+     * If the `{{ .Token }}` variable is specified in the email template, an OTP will be sent.
+     * If you're using phone sign-ins, only an OTP will be sent. You won't be able to send a magiclink for phone sign-ins.
      */
-    user(): User | null;
+    signInWithOtp(credentials: SignInWithPasswordlessCredentials): Promise<AuthResponse>;
     /**
-     * Returns the session data, if there is an active session.
+     * Log in a user given a User supplied OTP received via mobile.
      */
-    session(): Session | null;
+    verifyOtp(params: VerifyOtpParams): Promise<AuthResponse>;
     /**
-     * Force refreshes the session including the user data in case it was updated in a different session.
+     * Returns the session, refreshing it if necessary.
+     * The session returned can be null if the session is not detected which can happen in the event a user is not signed-in or has logged out.
      */
-    refreshSession(): Promise<{
-        data: Session | null;
-        user: User | null;
-        error: ApiError | null;
+    getSession(): Promise<{
+        data: {
+            session: Session;
+        };
+        error: null;
+    } | {
+        data: {
+            session: null;
+        };
+        error: AuthError;
+    } | {
+        data: {
+            session: null;
+        };
+        error: null;
     }>;
     /**
-     * Updates user data, if there is a logged in user.
+     * Gets the current user details if there is an existing session.
+     * @param jwt Takes in an optional access token jwt. If no jwt is provided, getUser() will attempt to get the jwt from the current session.
      */
-    update(attributes: UserAttributes): Promise<{
-        data: User | null;
-        user: User | null;
-        error: ApiError | null;
-    }>;
+    getUser(jwt?: string): Promise<UserResponse>;
     /**
-     * Sets the session data from refresh_token and returns current Session and Error
-     * @param refresh_token a JWT token
+     * Updates user data, if there is a logged in user.
      */
-    setSession(refresh_token: string): Promise<{
-        session: Session | null;
-        error: ApiError | null;
-    }>;
+    updateUser(attributes: UserAttributes): Promise<UserResponse>;
     /**
-     * Overrides the JWT on the current client. The JWT will then be sent in all subsequent network requests.
-     * @param access_token a jwt access token
+     * Sets the session data from the current session. If the current session is expired, setSession will take care of refreshing it to obtain a new session.
+     * If the refresh token in the current session is invalid and the current session has expired, an error will be thrown.
+     * If the current session does not contain at expires_at field, setSession will use the exp claim defined in the access token.
+     * @param currentSession The current session that minimally contains an access token, refresh token and a user.
      */
-    setAuth(access_token: string): Session;
+    setSession(currentSession: Pick<Session, 'access_token' | 'refresh_token'>): Promise<AuthResponse>;
     /**
      * Gets the session data from a URL string
-     * @param options.storeSession Optionally store the session in the browser
      */
-    getSessionFromUrl(options?: {
-        storeSession?: boolean;
-    }): Promise<{
-        data: Session | null;
-        error: ApiError | null;
-    }>;
+    private _getSessionFromUrl;
+    /**
+     * Checks if the current URL contains parameters given by an implicit oauth grant flow (https://www.rfc-editor.org/rfc/rfc6749.html#section-4.2)
+     */
+    private _isImplicitGrantFlow;
     /**
      * 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.
+     * and log them out - removing all items from localstorage and then trigger a `"SIGNED_OUT"` event.
      *
-     * For server-side management, you can revoke all refresh tokens for a user by passing a user's JWT through to `auth.api.signOut(JWT: string)`. There is no way to revoke a user's session JWT before it automatically expires
+     * For server-side management, you can revoke all refresh tokens for a user by passing a user's JWT through to `auth.api.signOut(JWT: string)`.
+     * There is no way to revoke a user's access token jwt until it expires. It is recommended to set a shorter expiry on the jwt for this reason.
      */
     signOut(): Promise<{
-        error: ApiError | null;
+        error: AuthError | null;
     }>;
     /**
      * Receive a notification every time an auth event happens.
-     * @returns {Subscription} A subscription object which can be used to unsubscribe itself.
+     * @param callback A callback function to be invoked when an auth event happens.
      */
     onAuthStateChange(callback: (event: AuthChangeEvent, session: Session | null) => void): {
-        data: Subscription | null;
-        error: ApiError | null;
+        data: {
+            subscription: Subscription;
+        };
     };
-    private _handleEmailSignIn;
-    private _handlePhoneSignIn;
-    private _handleProviderSignIn;
-    private _handleOpenIDConnectSignIn;
     /**
-     * Attempts to get the session from LocalStorage
-     * Note: this should never be async (even for React Native), as we need it to return immediately in the constructor.
+     * Sends a password reset request to an email address.
+     * @param email The email address of the user.
+     * @param options.redirectTo The URL to send the user to after they click the password reset link.
+     * @param options.captchaToken Verification token received when the user completes the captcha on the site.
      */
-    private _recoverSession;
+    resetPasswordForEmail(email: string, options?: {
+        redirectTo?: string;
+        captchaToken?: string;
+    }): Promise<{
+        data: {};
+        error: null;
+    } | {
+        data: null;
+        error: AuthError;
+    }>;
+    /**
+     * Generates a new JWT.
+     * @param refreshToken A valid refresh token that was returned on login.
+     */
+    private _refreshAccessToken;
+    private _isValidSession;
+    private _handleProviderSignIn;
     /**
      * Recovers the session from LocalStorage and refreshes
      * Note: this method is async to accommodate for AsyncStorage e.g. in React native.
@@ -198,13 +182,17 @@ export default class GoTrueClient {
     private _removeSession;
     /**
      * Clear and re-create refresh token timer
-     * @param value time intervals in milliseconds
+     * @param value time intervals in milliseconds.
+     * @param session The current session.
      */
     private _startAutoRefreshToken;
+    private _handleVisibilityChange;
     /**
-     * Listens for changes to LocalStorage and updates the current session.
+     * Generates the relevant login URL for a third-party provider.
+     * @param options.redirectTo A URL or mobile address to send the user to after they are confirmed.
+     * @param options.scopes A space-separated list of scopes granted to the OAuth application.
+     * @param options.queryParams An object of key-value pairs containing query parameters granted to the OAuth application.
      */
-    private _listenForMultiTabEvents;
-    private _handleVisibilityChange;
+    private _getUrlForProvider;
 }
 //# sourceMappingURL=GoTrueClient.d.ts.map