@faable/auth-js 1.2.0

package/README.md

@@ -0,0 +1,3 @@
+## Base
+
+- https://github.dev/supabase/auth-js

package/dist/Base.d.ts

@@ -0,0 +1,8 @@
+import { BaseLog, BaseLogOptions } from "./BaseLog";
+export declare abstract class Base extends BaseLog {
+    private static nextInstanceID;
+    private instanceID;
+    constructor(config?: BaseLogOptions);
+    extraPrint(): string;
+}
+//# sourceMappingURL=Base.d.ts.map

package/dist/Base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Base.d.ts","sourceRoot":"","sources":["../src/Base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAEpD,8BAAsB,IAAK,SAAQ,OAAO;IACxC,OAAO,CAAC,MAAM,CAAC,cAAc,CAAK;IAClC,OAAO,CAAC,UAAU,CAAS;gBAEf,MAAM,GAAE,cAAmB;IAMvC,UAAU;CAGX"}

package/dist/Base.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Base = void 0;
+const BaseLog_1 = require("./BaseLog");
+class Base extends BaseLog_1.BaseLog {
+    constructor(config = {}) {
+        super(config);
+        this.instanceID = Base.nextInstanceID;
+        Base.nextInstanceID += 1;
+    }
+    extraPrint() {
+        return this.instanceID.toString();
+    }
+}
+exports.Base = Base;
+Base.nextInstanceID = 0;

package/dist/BaseLog.d.ts

@@ -0,0 +1,11 @@
+export type BaseLogOptions = {
+    debug?: boolean | ((message: string, ...args: any[]) => void);
+};
+export declare abstract class BaseLog {
+    protected logDebugMessages: boolean;
+    protected logger: (message: string, ...args: any[]) => void;
+    constructor(config?: BaseLogOptions);
+    protected extraPrint?(): string;
+    protected _debug(...args: any[]): this;
+}
+//# sourceMappingURL=BaseLog.d.ts.map

package/dist/BaseLog.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseLog.d.ts","sourceRoot":"","sources":["../src/BaseLog.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,cAAc,GAAG;IAC3B,KAAK,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC,CAAC;CAC/D,CAAC;AAEF,8BAAsB,OAAO;IAC3B,SAAS,CAAC,gBAAgB,EAAE,OAAO,CAAC;IACpC,SAAS,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAe;gBAE9D,MAAM,GAAE,cAAmB;IAOvC,SAAS,CAAC,UAAU,CAAC,IAAI,MAAM;IAE/B,SAAS,CAAC,MAAM,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE;CAWhC"}

package/dist/BaseLog.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseLog = void 0;
+const version_1 = require("./lib/version");
+class BaseLog {
+    constructor(config = {}) {
+        this.logger = console.log;
+        this.logDebugMessages = !!config.debug;
+        if (typeof config.debug === "function") {
+            this.logger = config.debug;
+        }
+    }
+    _debug(...args) {
+        if (this.logDebugMessages) {
+            const extra = this.extraPrint ? this.extraPrint() : "";
+            this.logger(`FaableAuth@${extra} (${version_1.version}) ${new Date().toISOString()}`, ...args);
+        }
+        return this;
+    }
+}
+exports.BaseLog = BaseLog;

package/dist/FaableAuthApi.d.ts

@@ -0,0 +1,14 @@
+import { BaseLog, BaseLogOptions } from "./BaseLog";
+import { AuthError } from "./lib/errors";
+export default class FaableAuthApi extends BaseLog {
+    base_url: string;
+    constructor(base_url: string, config: BaseLogOptions);
+    protected extraPrint(): string;
+    signOut(params: {
+        client_id: string;
+    }): Promise<{
+        data: null;
+        error: AuthError | null;
+    }>;
+}
+//# sourceMappingURL=FaableAuthApi.d.ts.map

package/dist/FaableAuthApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FaableAuthApi.d.ts","sourceRoot":"","sources":["../src/FaableAuthApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAGzC,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,OAAO;IAC7B,QAAQ,EAAE,MAAM;gBAAhB,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,cAAc;IAG3D,SAAS,CAAC,UAAU,IAAI,MAAM;IAIxB,OAAO,CAAC,MAAM,EAAE;QACpB,SAAS,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,IAAI,CAAC;QAAC,KAAK,EAAE,SAAS,GAAG,IAAI,CAAA;KAAE,CAAC;CAWrD"}

package/dist/FaableAuthApi.js

@@ -0,0 +1,37 @@
+"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 BaseLog_1 = require("./BaseLog");
+const fetch_1 = require("./lib/fetch");
+class FaableAuthApi extends BaseLog_1.BaseLog {
+    constructor(base_url, config) {
+        super(config);
+        this.base_url = base_url;
+    }
+    extraPrint() {
+        return "api";
+    }
+    signOut(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const url = `${this.base_url}/logout?${new URLSearchParams(params)}`;
+            this._debug(`requesting ${url}`);
+            const res = yield (0, fetch_1._get)(url);
+            this._debug(res);
+            if (res.error) {
+                return { error: null, data: null };
+            }
+            else {
+                return res;
+            }
+        });
+    }
+}
+exports.default = FaableAuthApi;

package/dist/FaableAuthClient.d.ts

@@ -0,0 +1,227 @@
+import { AuthFlowType, SupportedStorage, SignInWithOAuthConnection, OAuthResponse, Subscription, InitializeResult, CallRefreshTokenResult } from "./lib/types";
+import { FaableAuthClientConfig, AuthResponse, AuthChangeEvent } from "./lib/types";
+import { Session, SignOut } from "./lib/types";
+import { Deferred } from "./lib/helpers";
+import { AuthError } from "./lib/errors";
+import FaableAuthApi from "./FaableAuthApi";
+import { Base } from "./Base";
+import { Lock } from "./lock/Lock";
+export declare class FaableAuthClient extends Base {
+    domainUrl: string;
+    tokenIssuer: string;
+    redirect_uri: string;
+    scope?: string;
+    sessionCheckExpiryDays: number;
+    protected initializePromise: Promise<InitializeResult> | null;
+    protected detectSessionInUrl: boolean;
+    protected storageKey: string;
+    protected clientId: string;
+    protected flowType: AuthFlowType;
+    protected storage: SupportedStorage;
+    protected api: FaableAuthApi;
+    protected autoRefreshToken: boolean;
+    protected autoRefreshTicker: ReturnType<typeof setInterval> | null;
+    protected visibilityChangedCallback: (() => Promise<any>) | null;
+    protected refreshingDeferred: Deferred<CallRefreshTokenResult> | null;
+    /**
+     * Used to broadcast state change events to other tabs listening.
+     */
+    protected broadcastChannel: BroadcastChannel | null;
+    protected stateChangeEmitters: Map<string, Subscription>;
+    protected lock: Lock;
+    constructor(config: FaableAuthClientConfig);
+    /**
+     * 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;
+    /**
+     * Gets the session data from a URL string
+     */
+    private _getSessionFromURL;
+    private _exchangeCodeForSession;
+    /**
+     * Registers callbacks on the browser / platform, which in-turn run
+     * algorithms when the browser window/tab are in foreground. On non-browser
+     * platforms it assumes always foreground.
+     */
+    private _handleVisibilityChange;
+    /**
+     * Callback registered with `window.addEventListener('visibilitychange')`.
+     */
+    private _onVisibilityChanged;
+    /**
+     * Recovers the session from LocalStorage and refreshes
+     * Note: this method is async to accommodate for AsyncStorage e.g. in React native.
+     */
+    private _recoverAndRefresh;
+    /**
+     * Removes any registered visibilitychange callback.
+     *
+     * {@see #startAutoRefresh}
+     * {@see #stopAutoRefresh}
+     */
+    private _removeVisibilityChangedCallback;
+    /**
+     * Starts an auto-refresh process in the background. The session is checked
+     * every few seconds. Close to the time of expiration a process is started to
+     * refresh the session. If refreshing fails it will be retried for as long as
+     * necessary.
+     *
+     * If you set the {@link GoTrueClientOptions#autoRefreshToken} you don't need
+     * to call this function, it will be called for you.
+     *
+     * On browsers the refresh process works only when the tab/window is in the
+     * foreground to conserve resources as well as prevent race conditions and
+     * flooding auth with requests. If you call this method any managed
+     * visibility change callback will be removed and you must manage visibility
+     * changes on your own.
+     *
+     * On non-browser platforms the refresh process works *continuously* in the
+     * background, which may not be desirable. You should hook into your
+     * platform's foreground indication mechanism and call these methods
+     * appropriately to conserve resources.
+     *
+     * {@see #stopAutoRefresh}
+     */
+    startAutoRefresh(): Promise<void>;
+    /**
+     * This is the private implementation of {@link #startAutoRefresh}. Use this
+     * within the library.
+     */
+    private _startAutoRefresh;
+    /**
+     * This is the private implementation of {@link #stopAutoRefresh}. Use this
+     * within the library.
+     */
+    private _stopAutoRefresh;
+    /**
+     * Runs the auto refresh token tick.
+     */
+    private _autoRefreshTokenTick;
+    /**
+     * Checks if the current URL and backing storage contain parameters given by a PKCE flow
+     */
+    private _isPKCEFlow;
+    /**
+     * 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;
+    private _scope;
+    private _getUrlForConnection;
+    signInWithOauthConnection(credentials: SignInWithOAuthConnection): Promise<OAuthResponse>;
+    private _handleConnectionSignIn;
+    /**
+     * 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 or access token in the current session is invalid, an error will be thrown.
+     * @param currentSession The current session that minimally contains an access token and refresh token.
+     */
+    setSession(currentSession: {
+        access_token: string;
+        refresh_token: string;
+    }): Promise<AuthResponse>;
+    /**
+     * 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.
+     *
+     * **IMPORTANT:** This method loads values directly from the storage attached
+     * to the client. If that storage is based on request cookies for example,
+     * the values in it may not be authentic and therefore it's strongly advised
+     * against using this method and its results in such circumstances. A warning
+     * will be emitted if this is detected. Use {@link #getUser()} instead.
+     */
+    getSession(): Promise<{
+        data: {
+            session: Session;
+        };
+        error: null;
+    } | {
+        data: {
+            session: null;
+        };
+        error: AuthError;
+    } | {
+        data: {
+            session: null;
+        };
+        error: null;
+    }>;
+    /**
+     * Use instead of {@link #getSession} inside the library. It is
+     * semantically usually what you want, as getting a session involves some
+     * processing afterwards that requires only one client operating on the
+     * session at once across multiple tabs or processes.
+     */
+    private _useSession;
+    /**
+     * NEVER USE DIRECTLY!
+     *
+     * Always use {@link #_useSession}.
+     */
+    private __loadSession;
+    private _removeSession;
+    private _isValidSession;
+    protected _setSession(currentSession: {
+        access_token: string;
+        refresh_token: string;
+    }): Promise<AuthResponse>;
+    /**
+     * set currentSession and currentUser
+     * process to _startAutoRefreshToken if possible
+     */
+    private _saveSession;
+    private _getUser;
+    private _callRefreshToken;
+    /**
+     * Generates a new JWT.
+     * @param refreshToken A valid refresh token that was returned on login.
+     */
+    private _refreshAccessToken;
+    private _notifyAllSubscribers;
+    /**
+     * Inside a browser context, `signOut()` will remove the logged in user from the browser session and log them out - removing all items from localstorage and then trigger a `"SIGNED_OUT"` event.
+     *
+     * For server-side management, you can 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.
+     *
+     * If using `others` scope, no `SIGNED_OUT` event is fired!
+     */
+    signOut(options?: SignOut): Promise<{
+        error: AuthError | null;
+    }>;
+    protected _signOut({ scope }?: SignOut): Promise<{
+        error: AuthError | null;
+    }>;
+    /**
+     * Receive a notification every time an auth event happens.
+     * @param callback A callback function to be invoked when an auth event happens.
+     */
+    onAuthStateChange(callback: (event: AuthChangeEvent, session: Session | null) => void | Promise<void>): {
+        data: {
+            subscription: Subscription;
+        };
+    };
+    private _emitInitialSession;
+    /**
+     * Returns a new session, regardless of expiry status.
+     * Takes in an optional current session. If not passed in, then refreshSession() will attempt to retrieve it from getSession().
+     * If the current session's refresh token is invalid, an error will be thrown.
+     * @param currentSession The current session. If passed in, it must contain a refresh token.
+     */
+    refreshSession(currentSession?: {
+        refresh_token: string;
+    }): Promise<AuthResponse>;
+    protected _refreshSession(currentSession?: {
+        refresh_token: string;
+    }): Promise<AuthResponse>;
+}
+//# sourceMappingURL=FaableAuthClient.d.ts.map

package/dist/FaableAuthClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FaableAuthClient.d.ts","sourceRoot":"","sources":["../src/FaableAuthClient.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,YAAY,EACZ,gBAAgB,EAChB,yBAAyB,EACzB,aAAa,EACb,YAAY,EACZ,gBAAgB,EAEhB,sBAAsB,EACvB,MAAM,aAAa,CAAC;AAGrB,OAAO,EACL,sBAAsB,EACtB,YAAY,EACZ,eAAe,EAChB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAyB,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AACtE,OAAO,EACL,QAAQ,EAQT,MAAM,eAAe,CAAC;AAGvB,OAAO,EACL,SAAS,EASV,MAAM,cAAc,CAAC;AAMtB,OAAO,aAAa,MAAM,iBAAiB,CAAC;AAG5C,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AASnC,qBAAa,gBAAiB,SAAQ,IAAI;IACxC,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,sBAAsB,EAAE,MAAM,CAAC;IAE/B,SAAS,CAAC,iBAAiB,EAAE,OAAO,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAQ;IACrE,SAAS,CAAC,kBAAkB,UAAQ;IAEpC,SAAS,CAAC,UAAU,EAAE,MAAM,CAAC;IAE7B,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC3B,SAAS,CAAC,QAAQ,EAAE,YAAY,CAAC;IACjC,SAAS,CAAC,OAAO,EAAE,gBAAgB,CAAC;IACpC,SAAS,CAAC,GAAG,EAAE,aAAa,CAAC;IAE7B,SAAS,CAAC,gBAAgB,EAAE,OAAO,CAAC;IACpC,SAAS,CAAC,iBAAiB,EAAE,UAAU,CAAC,OAAO,WAAW,CAAC,GAAG,IAAI,CAAQ;IAC1E,SAAS,CAAC,yBAAyB,EAAE,CAAC,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAQ;IAExE,SAAS,CAAC,kBAAkB,EAAE,QAAQ,CAAC,sBAAsB,CAAC,GAAG,IAAI,CAAQ;IAE7E;;OAEG;IACH,SAAS,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,IAAI,CAAQ;IAC3D,SAAS,CAAC,mBAAmB,EAAE,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAa;IAErE,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC;gBAET,MAAM,EAAE,sBAAsB;IA0D1C;;;;OAIG;IACG,UAAU,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAc7C;;;;;OAKG;YACW,WAAW;IA4EzB;;OAEG;YACW,kBAAkB;YA2HlB,uBAAuB;IA6DrC;;;;OAIG;YACW,uBAAuB;IA6BrC;;OAEG;YACW,oBAAoB;IAwClC;;;OAGG;YACW,kBAAkB;IA+DhC;;;;;OAKG;IACH,OAAO,CAAC,gCAAgC;IAexC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,gBAAgB;IAKtB;;;OAGG;YACW,iBAAiB;IA2C/B;;;OAGG;YACW,gBAAgB;IAW9B;;OAEG;YACW,qBAAqB;IAoDnC;;OAEG;YACW,WAAW;IAWzB;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAM5B,OAAO,CAAC,MAAM;YAIA,oBAAoB;IA4C5B,yBAAyB,CAC7B,WAAW,EAAE,yBAAyB,GACrC,OAAO,CAAC,aAAa,CAAC;YAUX,uBAAuB;IA4BrC;;;;OAIG;IACG,UAAU,CAAC,cAAc,EAAE;QAC/B,YAAY,EAAE,MAAM,CAAC;QACrB,aAAa,EAAE,MAAM,CAAC;KACvB,GAAG,OAAO,CAAC,YAAY,CAAC;IAQzB;;;;;;;;;;OAUG;IACG,UAAU;;;;;;;;;;;;;;;;IAYhB;;;;;OAKG;YACW,WAAW;IAmCzB;;;;OAIG;YACW,aAAa;YA6Fb,cAAc;IAM5B,OAAO,CAAC,eAAe;cAWP,WAAW,CAAC,cAAc,EAAE;QAC1C,YAAY,EAAE,MAAM,CAAC;QACrB,aAAa,EAAE,MAAM,CAAC;KACvB,GAAG,OAAO,CAAC,YAAY,CAAC;IAwDzB;;;OAGG;YACW,YAAY;YAMZ,QAAQ;YAUR,iBAAiB;IAqD/B;;;OAGG;YACW,mBAAmB;YA+EnB,qBAAqB;IAsCnC;;;;;;;OAOG;IACG,OAAO,CACX,OAAO,GAAE,OAA6B,GACrC,OAAO,CAAC;QAAE,KAAK,EAAE,SAAS,GAAG,IAAI,CAAA;KAAE,CAAC;cAQvB,QAAQ,CACtB,EAAE,KAAK,EAAE,GAAE,OAA6B,GACvC,OAAO,CAAC;QAAE,KAAK,EAAE,SAAS,GAAG,IAAI,CAAA;KAAE,CAAC;IA+BvC;;;OAGG;IACH,iBAAiB,CACf,QAAQ,EAAE,CACR,KAAK,EAAE,eAAe,EACtB,OAAO,EAAE,OAAO,GAAG,IAAI,KACpB,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,GACxB;QACD,IAAI,EAAE;YAAE,YAAY,EAAE,YAAY,CAAA;SAAE,CAAC;KACtC;YA8Ba,mBAAmB;IAuBjC;;;;;OAKG;IACG,cAAc,CAAC,cAAc,CAAC,EAAE;QACpC,aAAa,EAAE,MAAM,CAAC;KACvB,GAAG,OAAO,CAAC,YAAY,CAAC;cAQT,eAAe,CAAC,cAAc,CAAC,EAAE;QAC/C,aAAa,EAAE,MAAM,CAAC;KACvB,GAAG,OAAO,CAAC,YAAY,CAAC;CAqC1B"}