@jbrowse/plugin-authentication 3.6.5 → 4.0.0

package/dist/OAuthModel/configSchema.d.ts

@@ -1,72 +0,0 @@
-import type { Instance } from 'mobx-state-tree';
-declare const OAuthConfigSchema: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
-    tokenType: {
-        description: string;
-        type: string;
-        defaultValue: string;
-    };
-    authEndpoint: {
-        description: string;
-        type: string;
-        defaultValue: string;
-    };
-    tokenEndpoint: {
-        description: string;
-        type: string;
-        defaultValue: string;
-    };
-    needsPKCE: {
-        description: string;
-        type: string;
-        defaultValue: boolean;
-    };
-    clientId: {
-        description: string;
-        type: string;
-        defaultValue: string;
-    };
-    scopes: {
-        description: string;
-        type: string;
-        defaultValue: string;
-    };
-    state: {
-        description: string;
-        type: string;
-        defaultValue: string;
-    };
-    responseType: {
-        description: string;
-        type: string;
-        defaultValue: string;
-    };
-}, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
-    name: {
-        description: string;
-        type: string;
-        defaultValue: string;
-    };
-    description: {
-        description: string;
-        type: string;
-        defaultValue: string;
-    };
-    authHeader: {
-        description: string;
-        type: string;
-        defaultValue: string;
-    };
-    tokenType: {
-        description: string;
-        type: string;
-        defaultValue: string;
-    };
-    domains: {
-        description: string;
-        type: string;
-        defaultValue: never[];
-    };
-}, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, "internetAccountId">>, undefined>>;
-export type OAuthInternetAccountConfigModel = typeof OAuthConfigSchema;
-export type OAuthInternetAccountConfig = Instance<OAuthInternetAccountConfigModel>;
-export default OAuthConfigSchema;

package/dist/OAuthModel/configSchema.js

@@ -1,51 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const configuration_1 = require("@jbrowse/core/configuration");
-const models_1 = require("@jbrowse/core/pluggableElementTypes/models");
-function x() { }
-const OAuthConfigSchema = (0, configuration_1.ConfigurationSchema)('OAuthInternetAccount', {
-    tokenType: {
-        description: 'a custom name for a token to include in the header',
-        type: 'string',
-        defaultValue: 'Bearer',
-    },
-    authEndpoint: {
-        description: 'the authorization code endpoint of the internet account',
-        type: 'string',
-        defaultValue: '',
-    },
-    tokenEndpoint: {
-        description: 'the token endpoint of the internet account',
-        type: 'string',
-        defaultValue: '',
-    },
-    needsPKCE: {
-        description: 'boolean to indicate if the endpoint needs a PKCE code',
-        type: 'boolean',
-        defaultValue: false,
-    },
-    clientId: {
-        description: 'id for the OAuth application',
-        type: 'string',
-        defaultValue: '',
-    },
-    scopes: {
-        description: 'optional scopes for the authorization call',
-        type: 'string',
-        defaultValue: '',
-    },
-    state: {
-        description: 'optional state for the authorization call',
-        type: 'string',
-        defaultValue: '',
-    },
-    responseType: {
-        description: "the type of response from the authorization endpoint. can be 'token' or 'code'",
-        type: 'string',
-        defaultValue: 'code',
-    },
-}, {
-    baseConfiguration: models_1.BaseInternetAccountConfig,
-    explicitlyTyped: true,
-});
-exports.default = OAuthConfigSchema;

package/dist/OAuthModel/index.d.ts

@@ -1,2 +0,0 @@
-export { default as configSchema } from './configSchema';
-export { default as modelFactory } from './model';

package/dist/OAuthModel/index.js

@@ -1,10 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.modelFactory = exports.configSchema = void 0;
-var configSchema_1 = require("./configSchema");
-Object.defineProperty(exports, "configSchema", { enumerable: true, get: function () { return __importDefault(configSchema_1).default; } });
-var model_1 = require("./model");
-Object.defineProperty(exports, "modelFactory", { enumerable: true, get: function () { return __importDefault(model_1).default; } });

package/dist/OAuthModel/model.d.ts

@@ -1,182 +0,0 @@
-import type { OAuthInternetAccountConfigModel } from './configSchema';
-import type { UriLocation } from '@jbrowse/core/util';
-import type { Instance } from 'mobx-state-tree';
-declare const stateModelFactory: (configSchema: OAuthInternetAccountConfigModel) => import("mobx-state-tree").IModelType<{
-    id: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").ISimpleType<string>, [undefined]>;
-    type: import("mobx-state-tree").ISimpleType<string>;
-    configuration: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
-        name: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        description: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        authHeader: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        tokenType: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        domains: {
-            description: string;
-            type: string;
-            defaultValue: never[];
-        };
-    }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, "internetAccountId">>;
-} & {
-    type: import("mobx-state-tree").ISimpleType<"OAuthInternetAccount">;
-    configuration: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
-        tokenType: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        authEndpoint: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        tokenEndpoint: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        needsPKCE: {
-            description: string;
-            type: string;
-            defaultValue: boolean;
-        };
-        clientId: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        scopes: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        state: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        responseType: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-    }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
-        name: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        description: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        authHeader: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        tokenType: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        domains: {
-            description: string;
-            type: string;
-            defaultValue: never[];
-        };
-    }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, "internetAccountId">>, undefined>>;
-}, {
-    readonly name: string;
-    readonly description: string;
-    readonly internetAccountId: string;
-    readonly authHeader: string;
-    readonly tokenType: string;
-    readonly domains: string[];
-    readonly toggleContents: React.ReactNode;
-    readonly SelectorComponent: import("@jbrowse/core/util").AnyReactComponentType | undefined;
-    readonly selectorLabel: string | undefined;
-} & {
-    handlesLocation(location: UriLocation): boolean;
-    readonly tokenKey: string;
-} & {
-    getTokenFromUser(_resolve: (token: string) => void, _reject: (error: Error) => void): void;
-    storeToken(token: string): void;
-    removeToken(): void;
-    retrieveToken(): string | null;
-    validateToken(token: string, _loc: UriLocation): Promise<string>;
-} & {
-    getToken(location?: UriLocation): Promise<string>;
-} & {
-    addAuthHeaderToInit(init?: RequestInit, token?: string): {
-        headers: Headers;
-        body?: BodyInit | null;
-        cache?: RequestCache;
-        credentials?: RequestCredentials;
-        integrity?: string;
-        keepalive?: boolean;
-        method?: string;
-        mode?: RequestMode;
-        priority?: RequestPriority;
-        redirect?: RequestRedirect;
-        referrer?: string;
-        referrerPolicy?: ReferrerPolicy;
-        signal?: AbortSignal | null;
-        window?: null;
-    };
-    getPreAuthorizationInformation(location: UriLocation): Promise<{
-        internetAccountType: string;
-        authInfo: {
-            token: string;
-            configuration: any;
-        };
-    }>;
-} & {
-    getFetcher(loc?: UriLocation): (input: RequestInfo, init?: RequestInit) => Promise<Response>;
-} & {
-    openLocation(location: UriLocation): import("@jbrowse/core/util/io").RemoteFileWithRangeCache;
-} & {
-    readonly codeVerifierPKCE: string;
-} & {
-    readonly authEndpoint: string;
-    readonly tokenEndpoint: string;
-    readonly needsPKCE: boolean;
-    readonly clientId: string;
-    readonly scopes: string;
-    state(): string | undefined;
-    readonly responseType: "token" | "code";
-    readonly refreshTokenKey: string;
-} & {
-    storeRefreshToken(refreshToken: string): void;
-    removeRefreshToken(): void;
-    retrieveRefreshToken(): string | null;
-    exchangeAuthorizationForAccessToken(token: string, redirectUri: string): Promise<string>;
-    exchangeRefreshForAccessToken(refreshToken: string): Promise<string>;
-} & {
-    addMessageChannel(resolve: (token: string) => void, reject: (error: Error) => void): void;
-    deleteMessageChannel(): void;
-    finishOAuthWindow(event: MessageEvent, resolve: (token: string) => void, reject: (error: Error) => void): Promise<void>;
-    useEndpointForAuthorization(resolve: (token: string) => void, reject: (error: Error) => void): Promise<void>;
-    getTokenFromUser(resolve: (token: string) => void, reject: (error: Error) => void): Promise<void>;
-    validateToken(token: string, location: UriLocation): Promise<string>;
-} & {
-    getFetcher(loc?: UriLocation): (input: RequestInfo, init?: RequestInit) => Promise<Response>;
-}, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>;
-export default stateModelFactory;
-export type OAuthStateModel = ReturnType<typeof stateModelFactory>;
-export type OAuthModel = Instance<OAuthStateModel>;

package/dist/OAuthModel/model.js

@@ -1,289 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const configuration_1 = require("@jbrowse/core/configuration");
-const models_1 = require("@jbrowse/core/pluggableElementTypes/models");
-const util_1 = require("@jbrowse/core/util");
-const mobx_state_tree_1 = require("mobx-state-tree");
-const util_2 = require("./util");
-const util_3 = require("../util");
-function encode(uint8array) {
-    const output = [];
-    for (let i = 0, length = uint8array.length; i < length; i++) {
-        output.push(String.fromCharCode(uint8array[i]));
-    }
-    return btoa(output.join(''));
-}
-const stateModelFactory = (configSchema) => {
-    return models_1.InternetAccount.named('OAuthInternetAccount')
-        .props({
-        type: mobx_state_tree_1.types.literal('OAuthInternetAccount'),
-        configuration: (0, configuration_1.ConfigurationReference)(configSchema),
-    })
-        .views(() => {
-        let codeVerifier = undefined;
-        return {
-            get codeVerifierPKCE() {
-                if (!codeVerifier) {
-                    const array = new Uint8Array(32);
-                    globalThis.crypto.getRandomValues(array);
-                    codeVerifier = (0, util_2.fixup)(encode(array));
-                }
-                return codeVerifier;
-            },
-        };
-    })
-        .views(self => ({
-        get authEndpoint() {
-            return (0, configuration_1.getConf)(self, 'authEndpoint');
-        },
-        get tokenEndpoint() {
-            return (0, configuration_1.getConf)(self, 'tokenEndpoint');
-        },
-        get needsPKCE() {
-            return (0, configuration_1.getConf)(self, 'needsPKCE');
-        },
-        get clientId() {
-            return (0, configuration_1.getConf)(self, 'clientId');
-        },
-        get scopes() {
-            return (0, configuration_1.getConf)(self, 'scopes');
-        },
-        state() {
-            return (0, configuration_1.getConf)(self, 'state');
-        },
-        get responseType() {
-            return (0, configuration_1.getConf)(self, 'responseType');
-        },
-        get refreshTokenKey() {
-            return `${self.internetAccountId}-refreshToken`;
-        },
-    }))
-        .actions(self => ({
-        storeRefreshToken(refreshToken) {
-            localStorage.setItem(self.refreshTokenKey, refreshToken);
-        },
-        removeRefreshToken() {
-            localStorage.removeItem(self.refreshTokenKey);
-        },
-        retrieveRefreshToken() {
-            return localStorage.getItem(self.refreshTokenKey);
-        },
-        async exchangeAuthorizationForAccessToken(token, redirectUri) {
-            const params = new URLSearchParams(Object.entries({
-                code: token,
-                grant_type: 'authorization_code',
-                client_id: self.clientId,
-                redirect_uri: redirectUri,
-                ...(self.needsPKCE ? { code_verifier: self.codeVerifierPKCE } : {}),
-            }));
-            const response = await fetch(self.tokenEndpoint, {
-                method: 'POST',
-                headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
-                body: params.toString(),
-            });
-            if (!response.ok) {
-                throw new Error(await (0, util_3.getResponseError)({
-                    response,
-                    reason: 'Failed to obtain token',
-                }));
-            }
-            const data = await response.json();
-            return (0, util_2.processTokenResponse)(data, token => {
-                this.storeRefreshToken(token);
-            });
-        },
-        async exchangeRefreshForAccessToken(refreshToken) {
-            const response = await fetch(self.tokenEndpoint, {
-                method: 'POST',
-                headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
-                body: new URLSearchParams(Object.entries({
-                    grant_type: 'refresh_token',
-                    refresh_token: refreshToken,
-                    client_id: self.clientId,
-                })).toString(),
-            });
-            if (!response.ok) {
-                self.removeToken();
-                const text = await response.text();
-                throw new Error(await (0, util_3.getResponseError)({
-                    response,
-                    statusText: (0, util_2.processError)(text, () => {
-                        this.removeRefreshToken();
-                    }),
-                }));
-            }
-            const data = await response.json();
-            return (0, util_2.processTokenResponse)(data, token => {
-                this.storeRefreshToken(token);
-            });
-        },
-    }))
-        .actions(self => {
-        let listener;
-        let exchangedTokenPromise = undefined;
-        return {
-            addMessageChannel(resolve, reject) {
-                listener = event => {
-                    this.finishOAuthWindow(event, resolve, reject);
-                };
-                window.addEventListener('message', listener);
-            },
-            deleteMessageChannel() {
-                window.removeEventListener('message', listener);
-            },
-            async finishOAuthWindow(event, resolve, reject) {
-                if (event.data.name !== `JBrowseAuthWindow-${self.internetAccountId}`) {
-                    this.deleteMessageChannel();
-                    return;
-                }
-                const redirectUriWithInfo = event.data.redirectUri;
-                const fixedQueryString = redirectUriWithInfo.replace('#', '?');
-                const redirectUrl = new URL(fixedQueryString);
-                const queryStringSearch = redirectUrl.search;
-                const urlParams = new URLSearchParams(queryStringSearch);
-                if (urlParams.has('access_token')) {
-                    const token = urlParams.get('access_token');
-                    if (!token) {
-                        reject(new Error('Error with token endpoint'));
-                        return;
-                    }
-                    self.storeToken(token);
-                    resolve(token);
-                    return;
-                }
-                if (urlParams.has('code')) {
-                    const code = urlParams.get('code');
-                    if (!code) {
-                        reject(new Error('Error with authorization endpoint'));
-                        return;
-                    }
-                    try {
-                        const token = await self.exchangeAuthorizationForAccessToken(code, redirectUrl.origin + redirectUrl.pathname);
-                        self.storeToken(token);
-                        resolve(token);
-                        return;
-                    }
-                    catch (e) {
-                        if (e instanceof Error) {
-                            reject(e);
-                        }
-                        else {
-                            reject(new Error(String(e)));
-                        }
-                        return;
-                    }
-                }
-                if (redirectUriWithInfo.includes('access_denied')) {
-                    reject(new Error('OAuth flow was cancelled'));
-                    return;
-                }
-                if (redirectUriWithInfo.includes('error')) {
-                    reject(new Error(`OAuth flow error: ${queryStringSearch}`));
-                    return;
-                }
-                this.deleteMessageChannel();
-            },
-            async useEndpointForAuthorization(resolve, reject) {
-                const redirectUri = util_1.isElectron
-                    ? 'http://localhost/auth'
-                    : window.location.origin + window.location.pathname;
-                const data = {
-                    client_id: self.clientId,
-                    redirect_uri: redirectUri,
-                    response_type: self.responseType,
-                    token_access_type: 'offline',
-                };
-                if (self.state()) {
-                    data.state = self.state();
-                }
-                if (self.scopes) {
-                    data.scope = self.scopes;
-                }
-                if (self.needsPKCE) {
-                    data.code_challenge = await (0, util_2.generateChallenge)(self.codeVerifierPKCE);
-                    data.code_challenge_method = 'S256';
-                }
-                const params = new URLSearchParams(Object.entries(data));
-                const url = new URL(self.authEndpoint);
-                url.search = params.toString();
-                const eventName = `JBrowseAuthWindow-${self.internetAccountId}`;
-                if (util_1.isElectron) {
-                    const { ipcRenderer } = window.require('electron');
-                    const redirectUri = await ipcRenderer.invoke('openAuthWindow', {
-                        internetAccountId: self.internetAccountId,
-                        data,
-                        url: url.toString(),
-                    });
-                    const eventFromDesktop = new MessageEvent('message', {
-                        data: { name: eventName, redirectUri: redirectUri },
-                    });
-                    this.finishOAuthWindow(eventFromDesktop, resolve, reject);
-                }
-                else {
-                    window.open(url, eventName, 'width=500,height=600,left=0,top=0');
-                }
-            },
-            async getTokenFromUser(resolve, reject) {
-                const refreshToken = self.retrieveRefreshToken();
-                let doUserFlow = true;
-                if (refreshToken) {
-                    try {
-                        const token = await self.exchangeRefreshForAccessToken(refreshToken);
-                        resolve(token);
-                        doUserFlow = false;
-                    }
-                    catch (e) {
-                        console.error(e);
-                        self.removeRefreshToken();
-                    }
-                }
-                if (doUserFlow) {
-                    this.addMessageChannel(resolve, reject);
-                    this.useEndpointForAuthorization(resolve, reject);
-                }
-            },
-            async validateToken(token, location) {
-                const newInit = self.addAuthHeaderToInit({ method: 'HEAD' }, token);
-                const response = await fetch(location.uri, newInit);
-                if (!response.ok) {
-                    self.removeToken();
-                    const refreshToken = self.retrieveRefreshToken();
-                    if (refreshToken) {
-                        try {
-                            if (!exchangedTokenPromise) {
-                                exchangedTokenPromise =
-                                    self.exchangeRefreshForAccessToken(refreshToken);
-                            }
-                            const newToken = await exchangedTokenPromise;
-                            exchangedTokenPromise = undefined;
-                            return newToken;
-                        }
-                        catch (err) {
-                            console.error('Token could not be refreshed', err);
-                        }
-                    }
-                    throw new Error(await (0, util_3.getResponseError)({
-                        response,
-                        reason: 'Error validating token',
-                    }));
-                }
-                return token;
-            },
-        };
-    })
-        .actions(self => {
-        const superGetFetcher = self.getFetcher;
-        return {
-            getFetcher(loc) {
-                const fetcher = superGetFetcher(loc);
-                return async (input, init) => {
-                    if (loc) {
-                        await self.validateToken(await self.getToken(loc), loc);
-                    }
-                    return fetcher(input, init);
-                };
-            },
-        };
-    });
-};
-exports.default = stateModelFactory;

package/dist/OAuthModel/util.d.ts

@@ -1,7 +0,0 @@
-export declare function fixup(buf: string): string;
-export declare function generateChallenge(val: string): Promise<string>;
-export declare function processError(text: string, invalidErrorCb: () => void): any;
-export declare function processTokenResponse(data: {
-    refresh_token?: string;
-    access_token: string;
-}, storeRefreshTokenCb: (str: string) => void): string;

package/dist/OAuthModel/util.js

@@ -1,66 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fixup = fixup;
-exports.generateChallenge = generateChallenge;
-exports.processError = processError;
-exports.processTokenResponse = processTokenResponse;
-function fixup(buf) {
-    return buf.replaceAll('+', '-').replaceAll('/', '_').replaceAll('=', '');
-}
-async function generateChallenge(val) {
-    const sha256 = await Promise.resolve().then(() => __importStar(require('crypto-js/sha256'))).then(f => f.default);
-    const Base64 = await Promise.resolve().then(() => __importStar(require('crypto-js/enc-base64')));
-    return fixup(Base64.stringify(sha256(val)));
-}
-function processError(text, invalidErrorCb) {
-    var _a;
-    try {
-        const obj = JSON.parse(text);
-        if (obj.error === 'invalid_grant') {
-            invalidErrorCb();
-        }
-        return (_a = obj === null || obj === void 0 ? void 0 : obj.error_description) !== null && _a !== void 0 ? _a : text;
-    }
-    catch (e) {
-    }
-    return text;
-}
-function processTokenResponse(data, storeRefreshTokenCb) {
-    if (data.refresh_token) {
-        storeRefreshTokenCb(data.refresh_token);
-    }
-    return data.access_token;
-}