piral-oauth2 1.6.0-beta.7240 → 1.6.0-beta.7244

package/esm/setup.js

@@ -1,103 +0,0 @@
-import { ClientOAuth2 } from './client-oauth2';
-import { createOAuth2MemoryPersistence } from './utils';
-const callbackName = 'oauth2Cb';
-/**
- * Sets up a new client wrapping the OAuth 2.0 API.
- * @param config The configuration for the client.
- */
-export function setupOAuth2Client(config) {
-    const { clientId, clientSecret, authorizationUri, accessTokenUri, redirectUri = `${location.origin}/auth`, scopes = [], flow, headers, query, state, restrict = false, returnPath = '/', persist = createOAuth2MemoryPersistence(), } = config;
-    const client = new ClientOAuth2({
-        clientId,
-        clientSecret,
-        redirectUri,
-        authorizationUri,
-        accessTokenUri,
-        scopes,
-        headers,
-        query,
-        state,
-    });
-    let currentToken;
-    let retrieveToken;
-    let getLoginUri;
-    const setCurrentToken = (token) => {
-        persist.save({
-            accessToken: token.accessToken,
-            data: token.data,
-            refreshToken: token.refreshToken,
-        });
-        currentToken = token;
-    };
-    const retrieve = (init, refresh) => {
-        return init.then(() => {
-            if (!currentToken) {
-                return Promise.reject('Not logged in. Please call `login()` to retrieve a token.');
-            }
-            if (!currentToken.expired()) {
-                return currentToken.accessToken;
-            }
-            return refresh().then((refreshedToken) => {
-                setCurrentToken(refreshedToken);
-                return currentToken.accessToken;
-            });
-        });
-    };
-    const initialize = (load) => {
-        const info = persist.load();
-        if (info) {
-            currentToken = client.createToken(info.accessToken, info.refreshToken, undefined, info.data);
-            return Promise.resolve();
-        }
-        else {
-            return load().then((token) => {
-                const opener = window.opener;
-                setCurrentToken(token);
-                if (opener && typeof opener[callbackName] === 'function') {
-                    opener[callbackName](token);
-                    window.close();
-                }
-            }, () => { });
-        }
-    };
-    if (flow === 'code') {
-        const init = initialize(() => {
-            const url = location.href;
-            history.replaceState(undefined, undefined, returnPath);
-            return client.code.getToken(url);
-        });
-        retrieveToken = () => {
-            return retrieve(init, () => currentToken.refresh());
-        };
-        getLoginUri = () => client.code.getUri();
-    }
-    else {
-        const init = initialize(() => client.token.getToken(location.href));
-        retrieveToken = () => {
-            return retrieve(init, () => new Promise((resolve) => {
-                window[callbackName] = resolve;
-                window.open(client.token.getUri());
-            }));
-        };
-        getLoginUri = () => client.token.getUri();
-    }
-    return {
-        _: client,
-        login() {
-            window.location.href = getLoginUri();
-        },
-        logout() {
-            currentToken = undefined;
-        },
-        extendHeaders(req) {
-            if (!restrict) {
-                req.setHeaders(retrieveToken().then((token) => token && { Authorization: `Bearer ${token}` }, () => undefined));
-            }
-        },
-        account() {
-            return !!currentToken;
-        },
-        token: retrieveToken,
-    };
-}
-//# sourceMappingURL=setup.js.map

package/esm/setup.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"setup.js","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAqB,MAAM,iBAAiB,CAAC;AAClE,OAAO,EAAE,6BAA6B,EAAE,MAAM,SAAS,CAAC;AAGxD,MAAM,YAAY,GAAG,UAAU,CAAC;AAEhC;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAAC,MAAoB;IACpD,MAAM,EACJ,QAAQ,EACR,YAAY,EACZ,gBAAgB,EAChB,cAAc,EACd,WAAW,GAAG,GAAG,QAAQ,CAAC,MAAM,OAAO,EACvC,MAAM,GAAG,EAAE,EACX,IAAI,EACJ,OAAO,EACP,KAAK,EACL,KAAK,EACL,QAAQ,GAAG,KAAK,EAChB,UAAU,GAAG,GAAG,EAChB,OAAO,GAAG,6BAA6B,EAAE,GAC1C,GAAG,MAAM,CAAC;IAEX,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC;QAC9B,QAAQ;QACR,YAAY;QACZ,WAAW;QACX,gBAAgB;QAChB,cAAc;QACd,MAAM;QACN,OAAO;QACP,KAAK;QACL,KAAK;KACN,CAAC,CAAC;IAEH,IAAI,YAA+B,CAAC;IACpC,IAAI,aAAoC,CAAC;IACzC,IAAI,WAAyB,CAAC;IAE9B,MAAM,eAAe,GAAG,CAAC,KAAwB,EAAE,EAAE;QACnD,OAAO,CAAC,IAAI,CAAC;YACX,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,YAAY,EAAE,KAAK,CAAC,YAAY;SACjC,CAAC,CAAC;QAEH,YAAY,GAAG,KAAK,CAAC;IACvB,CAAC,CAAC;IAEF,MAAM,QAAQ,GAAG,CAAC,IAAmB,EAAE,OAAyC,EAAE,EAAE;QAClF,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;YACpB,IAAI,CAAC,YAAY,EAAE;gBACjB,OAAO,OAAO,CAAC,MAAM,CAAC,2DAA2D,CAAC,CAAC;aACpF;YAED,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,EAAE;gBAC3B,OAAO,YAAY,CAAC,WAAW,CAAC;aACjC;YAED,OAAO,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC,cAAc,EAAE,EAAE;gBACvC,eAAe,CAAC,cAAc,CAAC,CAAC;gBAChC,OAAO,YAAY,CAAC,WAAW,CAAC;YAClC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,UAAU,GAAG,CAAC,IAAsC,EAAE,EAAE;QAC5D,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;QAE5B,IAAI,IAAI,EAAE;YACR,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,YAAY,EAAE,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YAC7F,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;SAC1B;aAAM;YACL,OAAO,IAAI,EAAE,CAAC,IAAI,CAChB,CAAC,KAAK,EAAE,EAAE;gBACR,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;gBAE7B,eAAe,CAAC,KAAK,CAAC,CAAC;gBAEvB,IAAI,MAAM,IAAI,OAAO,MAAM,CAAC,YAAY,CAAC,KAAK,UAAU,EAAE;oBACxD,MAAM,CAAC,YAAY,CAAC,CAAC,KAAK,CAAC,CAAC;oBAC5B,MAAM,CAAC,KAAK,EAAE,CAAC;iBAChB;YACH,CAAC,EACD,GAAG,EAAE,GAAE,CAAC,CACT,CAAC;SACH;IACH,CAAC,CAAC;IAEF,IAAI,IAAI,KAAK,MAAM,EAAE;QACnB,MAAM,IAAI,GAAG,UAAU,CAAC,GAAG,EAAE;YAC3B,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC;YAC1B,OAAO,CAAC,YAAY,CAAC,SAAS,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;YACvD,OAAO,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;QAEH,aAAa,GAAG,GAAG,EAAE;YACnB,OAAO,QAAQ,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC,CAAC;QACtD,CAAC,CAAC;QACF,WAAW,GAAG,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;KAC1C;SAAM;QACL,MAAM,IAAI,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;QAEpE,aAAa,GAAG,GAAG,EAAE;YACnB,OAAO,QAAQ,CACb,IAAI,EACJ,GAAG,EAAE,CACH,IAAI,OAAO,CAAoB,CAAC,OAAO,EAAE,EAAE;gBACzC,MAAM,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC;gBAC/B,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;YACrC,CAAC,CAAC,CACL,CAAC;QACJ,CAAC,CAAC;QACF,WAAW,GAAG,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;KAC3C;IAED,OAAO;QACL,CAAC,EAAE,MAAM;QACT,KAAK;YACH,MAAM,CAAC,QAAQ,CAAC,IAAI,GAAG,WAAW,EAAE,CAAC;QACvC,CAAC;QACD,MAAM;YACJ,YAAY,GAAG,SAAS,CAAC;QAC3B,CAAC;QACD,aAAa,CAAC,GAAG;YACf,IAAI,CAAC,QAAQ,EAAE;gBACb,GAAG,CAAC,UAAU,CACZ,aAAa,EAAE,CAAC,IAAI,CAClB,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,IAAI,EAAE,aAAa,EAAE,UAAU,KAAK,EAAE,EAAE,EACxD,GAAG,EAAE,CAAC,SAAS,CAChB,CACF,CAAC;aACH;QACH,CAAC;QACD,OAAO;YACL,OAAO,CAAC,CAAC,YAAY,CAAC;QACxB,CAAC;QACD,KAAK,EAAE,aAAa;KACrB,CAAC;AACJ,CAAC"}

package/esm/types.d.ts

@@ -1,126 +0,0 @@
-declare module 'piral-core/lib/types/custom' {
-    interface PiletCustomApi extends PiralOAuth2Api {
-    }
-}
-export interface PiralOAuth2Api {
-    /**
-     * Gets the currently valid access token, if any.
-     */
-    getAccessToken(): Promise<string | undefined>;
-}
-/**
- * The relevant OAuth 2 token information.
- */
-export interface OAuth2TokenInfo {
-    accessToken: string;
-    refreshToken: string;
-    data: Record<string, string>;
-}
-/**
- * Available configuration options for the OAuth 2 plugin.
- */
-export interface OAuth2Config {
-    /**
-     * The id of the client. Required for the setup of OAuth 2.
-     */
-    clientId: string;
-    /**
-     * The client secret. Only required for the `code` flow.
-     */
-    clientSecret?: string;
-    /**
-     * The Uri pointing to the authorization endpoint of the Identity Provider.
-     */
-    authorizationUri: string;
-    /**
-     * The Uri pointing to the access token endpoint of the Identity Provider.
-     */
-    accessTokenUri?: string;
-    /**
-     * The redirect Uri to use. By default the origin with /auth
-     * is used.
-     */
-    redirectUri?: string;
-    /**
-     * The return path to use in case of the "code" flow. By default the
-     * path will be set to "/".
-     */
-    returnPath?: string;
-    /**
-     * The scopes to be used.
-     */
-    scopes?: Array<string>;
-    /**
-     * The OAuth 2 authorization flow type to be used.
-     */
-    flow?: 'implicit' | 'code';
-    /**
-     * Restricts token sharing such that other integrations, e.g., with
-     * fetch would need to be done manually.
-     * Otherwise, the client is responsive to the `before-fetch` event.
-     */
-    restrict?: boolean;
-    /**
-     * Optional persistence layer for OAuth 2. By default nothing is stored.
-     */
-    persist?: OAuth2Persistence;
-    /**
-     * The optional headers to supply in OAuth 2 requests.
-     */
-    headers?: Record<string, string | Array<string>>;
-    /**
-     * The optional query parameters to supply in OAuth 2 requests.
-     */
-    query?: Record<string, string | Array<string>>;
-    /**
-     * The optional state parameter to supply in OAuth 2 requests.
-     */
-    state?: string;
-}
-export interface OAuth2Request {
-    /**
-     * Sets the headers of the request.
-     * @param headers Headers or a promise to headers.
-     */
-    setHeaders(headers: any): void;
-}
-export interface OAuth2Client {
-    /**
-     * The underlying OAuth2 client.
-     */
-    _: any;
-    /**
-     * Performs a login.
-     */
-    login(): void;
-    /**
-     * Performs a logout.
-     */
-    logout(): void;
-    /**
-     * Gets a token.
-     */
-    token(): Promise<string>;
-    /**
-     * Checks if the user is currently logged in.
-     */
-    account(): boolean;
-    /**
-     * Extends the headers of the provided request.
-     */
-    extendHeaders(req: OAuth2Request): void;
-}
-/**
- * Defines the interface for the OAuth 2 persistence layer.
- */
-export interface OAuth2Persistence {
-    /**
-     * Loads an OAuth 2 token structure.
-     */
-    load(): OAuth2TokenInfo;
-    /**
-     * Stores an OAuth 2 token structure.
-     * @param info The token infos to store.
-     */
-    save(info: OAuth2TokenInfo): void;
-}

package/esm/types.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=types.js.map

package/esm/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/esm/utils.d.ts

@@ -1,13 +0,0 @@
-import { OAuth2Persistence } from './types';
-/**
- * Creates an OAuth 2 persistence layer using memory.
- */
-export declare function createOAuth2MemoryPersistence(): OAuth2Persistence;
-/**
- * Creates an OAuth 2 persistence layer using sessionStorage.
- */
-export declare function createOAuth2SessionPersistence(sessionKey?: string): OAuth2Persistence;
-/**
- * Creates an OAuth 2 persistence layer using localStorage.
- */
-export declare function createOAuth2BrowserPersistence(localKey?: string): OAuth2Persistence;

package/esm/utils.js

@@ -1,56 +0,0 @@
-/**
- * Creates an OAuth 2 persistence layer using memory.
- */
-export function createOAuth2MemoryPersistence() {
-    return {
-        load() {
-            return undefined;
-        },
-        save() { },
-    };
-}
-/**
- * Creates an OAuth 2 persistence layer using sessionStorage.
- */
-export function createOAuth2SessionPersistence(sessionKey = '$piral_oauth2_info') {
-    return {
-        load() {
-            const content = sessionStorage.getItem(sessionKey);
-            if (typeof content === 'string') {
-                try {
-                    return JSON.parse(content);
-                }
-                catch {
-                    console.error('Found invalid data in the OAuth 2 session storage key. Skipped.');
-                }
-            }
-            return undefined;
-        },
-        save(info) {
-            sessionStorage.setItem(sessionKey, JSON.stringify(info));
-        },
-    };
-}
-/**
- * Creates an OAuth 2 persistence layer using localStorage.
- */
-export function createOAuth2BrowserPersistence(localKey = '$piral_oauth2_info') {
-    return {
-        load() {
-            const content = localStorage.getItem(localKey);
-            if (typeof content === 'string') {
-                try {
-                    return JSON.parse(content);
-                }
-                catch {
-                    console.error('Found invalid data in the OAuth 2 local storage key. Skipped.');
-                }
-            }
-            return undefined;
-        },
-        save(info) {
-            localStorage.setItem(localKey, JSON.stringify(info));
-        },
-    };
-}
-//# sourceMappingURL=utils.js.map

package/esm/utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,UAAU,6BAA6B;IAC3C,OAAO;QACL,IAAI;YACF,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,IAAI,KAAI,CAAC;KACV,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,8BAA8B,CAAC,UAAU,GAAG,oBAAoB;IAC9E,OAAO;QACL,IAAI;YACF,MAAM,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAEnD,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;gBAC/B,IAAI;oBACF,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;iBAC5B;gBAAC,MAAM;oBACN,OAAO,CAAC,KAAK,CAAC,iEAAiE,CAAC,CAAC;iBAClF;aACF;YAED,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,IAAI,CAAC,IAAI;YACP,cAAc,CAAC,OAAO,CAAC,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;QAC3D,CAAC;KACF,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,8BAA8B,CAAC,QAAQ,GAAG,oBAAoB;IAC5E,OAAO;QACL,IAAI;YACF,MAAM,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAE/C,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;gBAC/B,IAAI;oBACF,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;iBAC5B;gBAAC,MAAM;oBACN,OAAO,CAAC,KAAK,CAAC,+DAA+D,CAAC,CAAC;iBAChF;aACF;YAED,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,IAAI,CAAC,IAAI;YACP,YAAY,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;QACvD,CAAC;KACF,CAAC;AACJ,CAAC"}