@supabase/gotrue-js 1.23.0-next.18 → 1.23.0-next.20

package/dist/main/GoTrueAdminApi.d.ts

@@ -0,0 +1,105 @@
+import { Fetch } from './lib/fetch';
+import { AdminUserAttributes, Session, 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 address 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 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 options.password User password. For signup only.
+     * @param options.data Optional user metadata. For signup only.
+     * @param options.redirectTo The link type ("signup" or "magiclink" or "recovery" or "invite").
+     */
+    generateLink(type: 'signup' | 'magiclink' | 'recovery' | 'invite' | 'email_change_current' | 'email_change_new', email: string, options?: {
+        password?: string;
+        data?: object;
+        redirectTo?: string;
+    }): Promise<{
+        data: User;
+        error: null;
+    } | {
+        data: Session;
+        error: null;
+    } | {
+        data: null;
+        error: AuthError;
+    }>;
+    /**
+     * Creates a new user.
+     *
+     * @param attributes The data you want to create the user with.
+     *
+     * 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 uid The user uid you want to remove.
+     *
+     * This function should only be called on a server. Never expose your `service_role` key in the browser.
+     */
+    deleteUser(uid: 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,EAA2B,MAAM,aAAa,CAAA;AAE5D,OAAO,EAAE,mBAAmB,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC9E,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;IAgBhE;;;;;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;;;;;;;OAOG;IACG,YAAY,CAChB,IAAI,EACA,QAAQ,GACR,WAAW,GACX,UAAU,GACV,QAAQ,GACR,sBAAsB,GACtB,kBAAkB,EACtB,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,CACN;QACE,IAAI,EAAE,IAAI,CAAA;QACV,KAAK,EAAE,IAAI,CAAA;KACZ,GACD;QACE,IAAI,EAAE,OAAO,CAAA;QACb,KAAK,EAAE,IAAI,CAAA;KACZ,GACD;QAAE,IAAI,EAAE,IAAI,CAAC;QAAC,KAAK,EAAE,SAAS,CAAA;KAAE,CACnC;IAqBD;;;;;;OAMG;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,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;CAcrD"}

package/dist/main/GoTrueAdminApi.js

@@ -0,0 +1,216 @@
+"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());
+    });
+};
+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`, {
+                    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 address 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 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 options.password User password. For signup only.
+     * @param options.data Optional user metadata. For signup only.
+     * @param options.redirectTo The link type ("signup" or "magiclink" or "recovery" or "invite").
+     */
+    generateLink(type, email, options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                return yield (0, fetch_1._request)(this.fetch, 'POST', `${this.url}/admin/generate_link`, {
+                    body: {
+                        type,
+                        email,
+                        password: options.password,
+                        data: options.data,
+                        redirect_to: options.redirectTo,
+                    },
+                    headers: this.headers,
+                });
+            }
+            catch (error) {
+                if ((0, errors_1.isAuthError)(error)) {
+                    return { data: null, error };
+                }
+                throw error;
+            }
+        });
+    }
+    // User Admin API
+    /**
+     * Creates a new user.
+     *
+     * @param attributes The data you want to create the user with.
+     *
+     * 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 uid The user uid you want to remove.
+     *
+     * This function should only be called on a server. Never expose your `service_role` key in the browser.
+     */
+    deleteUser(uid) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                return yield (0, fetch_1._request)(this.fetch, 'DELETE', `${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;
+            }
+        });
+    }
+}
+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,uCAA4D;AAC5D,2CAA4C;AAE5C,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,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;;;;;;;OAOG;IACG,YAAY,CAChB,IAMsB,EACtB,KAAa,EACb,UAII,EAAE;;YAYN,IAAI;gBACF,OAAO,MAAM,IAAA,gBAAQ,EAAC,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,sBAAsB,EAAE;oBAC3E,IAAI,EAAE;wBACJ,IAAI;wBACJ,KAAK;wBACL,QAAQ,EAAE,OAAO,CAAC,QAAQ;wBAC1B,IAAI,EAAE,OAAO,CAAC,IAAI;wBAClB,WAAW,EAAE,OAAO,CAAC,UAAU;qBAChC;oBACD,OAAO,EAAE,IAAI,CAAC,OAAO;iBACtB,CAAC,CAAA;aACH;YAAC,OAAO,KAAK,EAAE;gBACd,IAAI,IAAA,oBAAW,EAAC,KAAK,CAAC,EAAE;oBACtB,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;iBAC7B;gBACD,MAAM,KAAK,CAAA;aACZ;QACH,CAAC;KAAA;IAED,iBAAiB;IACjB;;;;;;OAMG;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,GAAW;;YAC1B,IAAI;gBACF,OAAO,MAAM,IAAA,gBAAQ,EAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,GAAG,gBAAgB,GAAG,EAAE,EAAE;oBAC5E,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;AA5OD,iCA4OC"}

package/dist/main/GoTrueClient.d.ts

@@ -1,14 +1,15 @@
-import GoTrueApi from './GoTrueApi';
+import GoTrueAdminApi from './GoTrueAdminApi';
 import { AuthError } from './lib/errors';
 import { Fetch } from './lib/fetch';
 import { Deferred } from './lib/helpers';
-import type { AuthChangeEvent, AuthResponse, CallRefreshTokenResult, OAuthResponse, Session, SignInWithOAuthCredentials, SignInWithPasswordCredentials, SignInWithPasswordlessCredentials, Subscription, SupportedStorage, User, UserAttributes, UserCredentials, VerifyOTPParams } from './lib/types';
+import type { AuthChangeEvent, AuthResponse, CallRefreshTokenResult, OAuthResponse, Session, SignInWithOAuthCredentials, SignInWithPasswordCredentials, SignInWithPasswordlessCredentials, Subscription, SupportedStorage, UserAttributes, UserCredentials, 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.
+     * These methods
      */
-    api: GoTrueApi;
+    admin: GoTrueAdminApi;
     /**
      * The storage key used to identity the values saved in localStorage
      */
@@ -25,6 +26,11 @@ export default class GoTrueClient {
     protected refreshTokenTimer?: ReturnType<typeof setTimeout>;
     protected networkRetries: number;
     protected refreshingDeferred: Deferred<CallRefreshTokenResult> | null;
+    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.
@@ -58,6 +64,10 @@ export default class GoTrueClient {
      * @param phone The user's phone number.
      * @param options.redirectTo The redirect URL attached to the signup confirmation link. Does not redirect the user if it's a mobile signup.
      * @param options.data Optional user metadata.
+     * @param options.captchaToken Verification token received when the user completes the captcha on the site.
+     *
+     * @returns A logged-in session if the server has "autoconfirm" ON
+     * @returns A user if the server has "autoconfirm" OFF
      */
     signUp({ email, password, phone }: UserCredentials, options?: {
         redirectTo?: string;
@@ -70,7 +80,7 @@ export default class GoTrueClient {
      * @param email The user's email address.
      * @param phone The user's phone number.
      * @param password The user's password.
-     * @param options Valid options for password sign-ins.
+     * @param options.captchaToken Verification token received when the user completes the captcha on the site.
      */
     signInWithPassword(credentials: SignInWithPasswordCredentials): Promise<AuthResponse>;
     /**
@@ -78,8 +88,9 @@ export default class GoTrueClient {
      * @type SignInWithOAuthCredentials
      * @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 scopes A space-separated list of scopes granted to the OAuth application.
-     * @param queryParams An object of query params
+     * @param options.scopes A space-separated list of scopes granted to the OAuth application.
+     * @param options.queryParams An object of query params
+     * @param options.captchaToken Verification token received when the user completes the captcha on the site.
      */
     signInWithOAuth(credentials: SignInWithOAuthCredentials): Promise<OAuthResponse>;
     /**
@@ -87,7 +98,9 @@ export default class GoTrueClient {
      * @type SignInWithPasswordlessCredentials
      * @param email The user's email address.
      * @param phone The user's phone number.
-     * @param options Valid options for passwordless sign-ins.
+     * @param options.captchaToken Verification token received when the user completes the captcha on the site.
+     * @param options.emailRedirectTo The redirect url sent in the magiclink. The url will be appended to the end of the magiclink url. Does not serve to redirect the user after this method is invoked.
+     * @param options.shouldCreateUser If set to false, signInWithOtp will not create a new user if the user does not exist. Defaults to true.
      */
     signInWithOtp(credentials: SignInWithPasswordlessCredentials): Promise<AuthResponse>;
     /**
@@ -96,10 +109,12 @@ export default class GoTrueClient {
      * @param phone The user's phone number.
      * @param token The user's password.
      * @param type The user's verification type.
-     * @param options.redirectTo A URL or mobile address to send the user to after they are confirmed.
+     * @param options.redirectTo A URL to send the user to after they are confirmed.
+     * @param options.captchaToken An optional captcha verification token.
      */
     verifyOTP(params: VerifyOTPParams, options?: {
         redirectTo?: string;
+        captchaToken?: string;
     }): Promise<AuthResponse>;
     /**
      * Returns the session data, refreshing it if necessary.
@@ -115,55 +130,24 @@ export default class GoTrueClient {
         error: null;
     }>;
     /**
-     * Returns the user data, refreshing the session if necessary.
+     * Gets the current user details if there is an existing session.
      */
-    getUser(): Promise<{
-        user: User;
-        error: null;
-    } | {
-        user: null;
-        error: AuthError;
-    } | {
-        user: null;
-        error: null;
-    }>;
+    getUser(): Promise<UserResponse>;
     /**
      * Updates user data, if there is a logged in user.
+     * @param attributes The data you want to update.
      */
-    update(attributes: UserAttributes): Promise<{
-        user: User;
-        error: null;
-    } | {
-        user: null;
-        error: AuthError;
-    }>;
+    updateUser(attributes: UserAttributes): Promise<UserResponse>;
     /**
      * Sets the session data from refresh_token and returns current Session and Error
      * @param refresh_token a JWT token
      */
-    setSession(refresh_token: string): Promise<{
-        session: Session;
-        error: null;
-    } | {
-        session: null;
-        error: null;
-    } | {
-        session: null;
-        error: AuthError;
-    }>;
+    setSession(refresh_token: string): Promise<AuthResponse>;
     /**
      * Gets the session data from a URL string
-     * @param options.storeSession Optionally store the session in the browser
+     * @param options.storeSession Optionally store the session in the browser or in-memory
      */
-    getSessionFromUrl(options?: {
-        storeSession?: boolean;
-    }): Promise<{
-        session: Session;
-        error: null;
-    } | {
-        session: null;
-        error: AuthError;
-    }>;
+    private _getSessionFromUrl;
     /**
      * 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.
@@ -184,11 +168,29 @@ export default class GoTrueClient {
         subscription: null;
         error: AuthError;
     };
+    /**
+     * Sends a reset request to an email address.
+     * @param email The email address of the user.
+     * @param options.redirectTo A URL to send the user to after they are confirmed.
+     * @param options.captchaToken Verification token received when the user completes the captcha on the site.
+     */
+    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 _doesSessionExist;
-    private _handleEmailSignIn;
-    private _handlePhoneSignIn;
     private _handleProviderSignIn;
-    private _handleOpenIDConnectSignIn;
     /**
      * Recovers the session from LocalStorage and refreshes
      * Note: this method is async to accommodate for AsyncStorage e.g. in React native.
@@ -209,5 +211,13 @@ export default class GoTrueClient {
      */
     private _startAutoRefreshToken;
     private _handleVisibilityChange;
+    /**
+     * Generates the relevant login URL for a third-party provider.
+     * @param provider One of the providers supported by GoTrue.
+     * @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 _getUrlForProvider;
 }
 //# sourceMappingURL=GoTrueClient.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"GoTrueClient.d.ts","sourceRoot":"","sources":["../../src/GoTrueClient.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,aAAa,CAAA;AAQnC,OAAO,EAEL,SAAS,EAMV,MAAM,cAAc,CAAA;AACrB,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AACnC,OAAO,EACL,QAAQ,EAOT,MAAM,eAAe,CAAA;AAEtB,OAAO,KAAK,EACV,eAAe,EACf,YAAY,EACZ,sBAAsB,EACtB,aAAa,EAGb,OAAO,EACP,0BAA0B,EAC1B,6BAA6B,EAC7B,iCAAiC,EACjC,YAAY,EACZ,gBAAgB,EAChB,IAAI,EACJ,cAAc,EACd,eAAe,EACf,eAAe,EAChB,MAAM,aAAa,CAAA;AAcpB,MAAM,CAAC,OAAO,OAAO,YAAY;IAC/B;;;OAGG;IACH,GAAG,EAAE,SAAS,CAAA;IACd;;OAEG;IACH,SAAS,CAAC,UAAU,EAAE,MAAM,CAAA;IAE5B;;;OAGG;IACH,SAAS,CAAC,eAAe,EAAE,OAAO,GAAG,IAAI,CAAA;IAEzC,SAAS,CAAC,gBAAgB,EAAE,OAAO,CAAA;IACnC,SAAS,CAAC,cAAc,EAAE,OAAO,CAAA;IACjC,SAAS,CAAC,OAAO,EAAE,gBAAgB,CAAA;IACnC,SAAS,CAAC,mBAAmB,EAAE,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAY;IACpE,SAAS,CAAC,iBAAiB,CAAC,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,CAAA;IAE3D,SAAS,CAAC,cAAc,EAAE,MAAM,CAAI;IACpC,SAAS,CAAC,kBAAkB,EAAE,QAAQ,CAAC,sBAAsB,CAAC,GAAG,IAAI,CAAO;IAE5E;;;;;;;;;;;OAWG;gBACS,OAAO,EAAE;QACnB,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,OAAO,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAA;QACnC,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,kBAAkB,CAAC,EAAE,OAAO,CAAA;QAC5B,gBAAgB,CAAC,EAAE,OAAO,CAAA;QAC1B,cAAc,CAAC,EAAE,OAAO,CAAA;QACxB,OAAO,CAAC,EAAE,gBAAgB,CAAA;QAC1B,QAAQ,CAAC,EAAE,OAAO,CAAA;QAClB,KAAK,CAAC,EAAE,KAAK,CAAA;KACd;IAyBD;;;;;;;;OAQG;IACG,MAAM,CACV,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,eAAe,EAC3C,OAAO,GAAE;QACP,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,YAAY,CAAC,EAAE,MAAM,CAAA;KACjB,GACL,OAAO,CAAC,YAAY,CAAC;IA8CxB;;;;;;;OAOG;IACG,kBAAkB,CAAC,WAAW,EAAE,6BAA6B,GAAG,OAAO,CAAC,YAAY,CAAC;IA6B3F;;;;;;;OAOG;IACG,eAAe,CAAC,WAAW,EAAE,0BAA0B,GAAG,OAAO,CAAC,aAAa,CAAC;IAStF;;;;;;OAMG;IACG,aAAa,CAAC,WAAW,EAAE,iCAAiC,GAAG,OAAO,CAAC,YAAY,CAAC;IA+B1F;;;;;;;OAOG;IACG,SAAS,CACb,MAAM,EAAE,eAAe,EACvB,OAAO,GAAE;QACP,UAAU,CAAC,EAAE,MAAM,CAAA;KACf,GACL,OAAO,CAAC,YAAY,CAAC;IAsCxB;;OAEG;IACG,UAAU,IAAI,OAAO,CACvB;QACE,OAAO,EAAE,OAAO,CAAA;QAChB,KAAK,EAAE,IAAI,CAAA;KACZ,GACD;QACE,OAAO,EAAE,IAAI,CAAA;QACb,KAAK,EAAE,SAAS,CAAA;KACjB,GACD;QACE,OAAO,EAAE,IAAI,CAAA;QACb,KAAK,EAAE,IAAI,CAAA;KACZ,CACJ;IAkCD;;OAEG;IACG,OAAO,IAAI,OAAO,CACpB;QACE,IAAI,EAAE,IAAI,CAAA;QACV,KAAK,EAAE,IAAI,CAAA;KACZ,GACD;QACE,IAAI,EAAE,IAAI,CAAA;QACV,KAAK,EAAE,SAAS,CAAA;KACjB,GACD;QACE,IAAI,EAAE,IAAI,CAAA;QACV,KAAK,EAAE,IAAI,CAAA;KACZ,CACJ;IAaD;;OAEG;IACG,MAAM,CAAC,UAAU,EAAE,cAAc,GAAG,OAAO,CAC7C;QACE,IAAI,EAAE,IAAI,CAAA;QACV,KAAK,EAAE,IAAI,CAAA;KACZ,GACD;QAAE,IAAI,EAAE,IAAI,CAAC;QAAC,KAAK,EAAE,SAAS,CAAA;KAAE,CACnC;IAyBD;;;OAGG;IACG,UAAU,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAC5C;QACE,OAAO,EAAE,OAAO,CAAA;QAChB,KAAK,EAAE,IAAI,CAAA;KACZ,GACD;QAAE,OAAO,EAAE,IAAI,CAAC;QAAC,KAAK,EAAE,IAAI,CAAA;KAAE,GAC9B;QAAE,OAAO,EAAE,IAAI,CAAC;QAAC,KAAK,EAAE,SAAS,CAAA;KAAE,CACtC;IAuBD;;;OAGG;IACG,iBAAiB,CAAC,OAAO,CAAC,EAAE;QAAE,YAAY,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAClE;QACE,OAAO,EAAE,OAAO,CAAA;QAChB,KAAK,EAAE,IAAI,CAAA;KACZ,GACD;QAAE,OAAO,EAAE,IAAI,CAAC;QAAC,KAAK,EAAE,SAAS,CAAA;KAAE,CACtC;IAqDD;;;;;OAKG;IACG,OAAO,IAAI,OAAO,CAAC;QAAE,KAAK,EAAE,SAAS,GAAG,IAAI,CAAA;KAAE,CAAC;IAerD;;;OAGG;IACH,iBAAiB,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,eAAe,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,GACjF;QACE,YAAY,EAAE,YAAY,CAAA;QAC1B,KAAK,EAAE,IAAI,CAAA;KACZ,GACD;QAAE,YAAY,EAAE,IAAI,CAAC;QAAC,KAAK,EAAE,SAAS,CAAA;KAAE;IAqB5C,OAAO,CAAC,iBAAiB;YAWX,kBAAkB;YA4BlB,kBAAkB;IA4BhC,OAAO,CAAC,qBAAqB;YAoBf,0BAA0B;IAwCxC;;;OAGG;YACW,kBAAkB;YA6ClB,iBAAiB;IAwC/B,OAAO,CAAC,qBAAqB;IAI7B;;;OAGG;IACH,OAAO,CAAC,YAAY;IAoBpB,OAAO,CAAC,eAAe;YAIT,cAAc;IAY5B;;;OAGG;IACH,OAAO,CAAC,sBAAsB;IAoB9B,OAAO,CAAC,uBAAuB;CAehC"}
+{"version":3,"file":"GoTrueClient.d.ts","sourceRoot":"","sources":["../../src/GoTrueClient.ts"],"names":[],"mappings":"AAAA,OAAO,cAAc,MAAM,kBAAkB,CAAA;AAQ7C,OAAO,EAEL,SAAS,EAMV,MAAM,cAAc,CAAA;AACrB,OAAO,EAAE,KAAK,EAA6C,MAAM,aAAa,CAAA;AAC9E,OAAO,EACL,QAAQ,EAQT,MAAM,eAAe,CAAA;AAEtB,OAAO,KAAK,EACV,eAAe,EACf,YAAY,EACZ,sBAAsB,EACtB,aAAa,EAEb,OAAO,EACP,0BAA0B,EAC1B,6BAA6B,EAC7B,iCAAiC,EACjC,YAAY,EACZ,gBAAgB,EAEhB,cAAc,EACd,eAAe,EACf,YAAY,EACZ,eAAe,EAChB,MAAM,aAAa,CAAA;AAcpB,MAAM,CAAC,OAAO,OAAO,YAAY;IAC/B;;;;OAIG;IACH,KAAK,EAAE,cAAc,CAAA;IACrB;;OAEG;IACH,SAAS,CAAC,UAAU,EAAE,MAAM,CAAA;IAE5B;;;OAGG;IACH,SAAS,CAAC,eAAe,EAAE,OAAO,GAAG,IAAI,CAAA;IAEzC,SAAS,CAAC,gBAAgB,EAAE,OAAO,CAAA;IACnC,SAAS,CAAC,cAAc,EAAE,OAAO,CAAA;IACjC,SAAS,CAAC,OAAO,EAAE,gBAAgB,CAAA;IACnC,SAAS,CAAC,mBAAmB,EAAE,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAY;IACpE,SAAS,CAAC,iBAAiB,CAAC,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,CAAA;IAE3D,SAAS,CAAC,cAAc,EAAE,MAAM,CAAI;IACpC,SAAS,CAAC,kBAAkB,EAAE,QAAQ,CAAC,sBAAsB,CAAC,GAAG,IAAI,CAAO;IAC5E,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;IAEtB;;;;;;;;;;;OAWG;gBACS,OAAO,EAAE;QACnB,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,OAAO,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAA;QACnC,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,kBAAkB,CAAC,EAAE,OAAO,CAAA;QAC5B,gBAAgB,CAAC,EAAE,OAAO,CAAA;QAC1B,cAAc,CAAC,EAAE,OAAO,CAAA;QACxB,OAAO,CAAC,EAAE,gBAAgB,CAAA;QAC1B,QAAQ,CAAC,EAAE,OAAO,CAAA;QAClB,KAAK,CAAC,EAAE,KAAK,CAAA;KACd;IA4BD;;;;;;;;;;;;OAYG;IACG,MAAM,CACV,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,eAAe,EAC3C,OAAO,GAAE;QACP,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,YAAY,CAAC,EAAE,MAAM,CAAA;KACjB,GACL,OAAO,CAAC,YAAY,CAAC;IAuDxB;;;;;;;OAOG;IACG,kBAAkB,CAAC,WAAW,EAAE,6BAA6B,GAAG,OAAO,CAAC,YAAY,CAAC;IAuC3F;;;;;;;;OAQG;IACG,eAAe,CAAC,WAAW,EAAE,0BAA0B,GAAG,OAAO,CAAC,aAAa,CAAC;IAStF;;;;;;;;OAQG;IACG,aAAa,CAAC,WAAW,EAAE,iCAAiC,GAAG,OAAO,CAAC,YAAY,CAAC;IAsC1F;;;;;;;;OAQG;IACG,SAAS,CACb,MAAM,EAAE,eAAe,EACvB,OAAO,GAAE;QACP,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,YAAY,CAAC,EAAE,MAAM,CAAA;KACjB,GACL,OAAO,CAAC,YAAY,CAAC;IAuCxB;;OAEG;IACG,UAAU,IAAI,OAAO,CACvB;QACE,OAAO,EAAE,OAAO,CAAA;QAChB,KAAK,EAAE,IAAI,CAAA;KACZ,GACD;QACE,OAAO,EAAE,IAAI,CAAA;QACb,KAAK,EAAE,SAAS,CAAA;KACjB,GACD;QACE,OAAO,EAAE,IAAI,CAAA;QACb,KAAK,EAAE,IAAI,CAAA;KACZ,CACJ;IAkCD;;OAEG;IACG,OAAO,IAAI,OAAO,CAAC,YAAY,CAAC;IA2BtC;;;OAGG;IACG,UAAU,CAAC,UAAU,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;IA6BnE;;;OAGG;IACG,UAAU,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAuB9D;;;OAGG;YACW,kBAAkB;IA4DhC;;;;;OAKG;IACG,OAAO,IAAI,OAAO,CAAC;QAAE,KAAK,EAAE,SAAS,GAAG,IAAI,CAAA;KAAE,CAAC;IAerD;;;OAGG;IACH,iBAAiB,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,eAAe,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,GACjF;QACE,YAAY,EAAE,YAAY,CAAA;QAC1B,KAAK,EAAE,IAAI,CAAA;KACZ,GACD;QAAE,YAAY,EAAE,IAAI,CAAC;QAAC,KAAK,EAAE,SAAS,CAAA;KAAE;IAqB5C;;;;;OAKG;IACG,qBAAqB,CACzB,KAAK,EAAE,MAAM,EACb,OAAO,GAAE;QACP,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,YAAY,CAAC,EAAE,MAAM,CAAA;KACjB,GACL,OAAO,CACN;QACE,IAAI,EAAE,EAAE,CAAA;QACR,KAAK,EAAE,IAAI,CAAA;KACZ,GACD;QAAE,IAAI,EAAE,IAAI,CAAC;QAAC,KAAK,EAAE,SAAS,CAAA;KAAE,CACnC;IAgBD;;;OAGG;YACW,mBAAmB;IAejC,OAAO,CAAC,iBAAiB;IAWzB,OAAO,CAAC,qBAAqB;IAoB7B;;;OAGG;YACW,kBAAkB;YA6ClB,iBAAiB;IAwC/B,OAAO,CAAC,qBAAqB;IAI7B;;;OAGG;IACH,OAAO,CAAC,YAAY;IAoBpB,OAAO,CAAC,eAAe;YAIT,cAAc;IAY5B;;;OAGG;IACH,OAAO,CAAC,sBAAsB;IAoB9B,OAAO,CAAC,uBAAuB;IAgB/B;;;;;;OAMG;IACH,OAAO,CAAC,kBAAkB;CAqB3B"}