@jbrowse/plugin-authentication 2.17.0 → 2.18.0

package/dist/HTTPBasicModel/model.js

@@ -5,33 +5,18 @@ const models_1 = require("@jbrowse/core/pluggableElementTypes/models");
 const mobx_state_tree_1 = require("mobx-state-tree");
 const HTTPBasicLoginForm_1 = require("./HTTPBasicLoginForm");
 const util_1 = require("../util");
-/**
- * #stateModel HTTPBasicInternetAccount
- */
 const stateModelFactory = (configSchema) => {
     return models_1.InternetAccount.named('HTTPBasicInternetAccount')
         .props({
-        /**
-         * #property
-         */
         type: mobx_state_tree_1.types.literal('HTTPBasicInternetAccount'),
-        /**
-         * #property
-         */
         configuration: (0, configuration_1.ConfigurationReference)(configSchema),
     })
         .views(self => ({
-        /**
-         * #getter
-         */
         get validateWithHEAD() {
             return (0, configuration_1.getConf)(self, 'validateWithHEAD');
         },
     }))
         .actions(self => ({
-        /**
-         * #action
-         */
         getTokenFromUser(resolve, reject) {
             const { session } = (0, mobx_state_tree_1.getRoot)(self);
             session.queueDialog((doneCallback) => [
@@ -50,9 +35,6 @@ const stateModelFactory = (configSchema) => {
                 },
             ]);
         },
-        /**
-         * #action
-         */
         async validateToken(token, location) {
             if (!self.validateWithHEAD) {
                 return token;

package/dist/OAuthModel/configSchema.d.ts

@@ -1,64 +1,40 @@
-import { Instance } from 'mobx-state-tree';
+import type { Instance } from 'mobx-state-tree';
 declare const OAuthConfigSchema: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
-    /**
-     * #slot
-     */
     tokenType: {
         description: string;
         type: string;
         defaultValue: string;
     };
-    /**
-     * #slot
-     */
     authEndpoint: {
         description: string;
         type: string;
         defaultValue: string;
     };
-    /**
-     * #slot
-     */
     tokenEndpoint: {
         description: string;
         type: string;
         defaultValue: string;
     };
-    /**
-     * #slot
-     */
     needsPKCE: {
         description: string;
         type: string;
         defaultValue: boolean;
     };
-    /**
-     * #slot
-     */
     clientId: {
         description: string;
         type: string;
         defaultValue: string;
     };
-    /**
-     * #slot
-     */
     scopes: {
         description: string;
         type: string;
         defaultValue: string;
     };
-    /**
-     * #slot
-     */
     state: {
         description: string;
         type: string;
         defaultValue: string;
     };
-    /**
-     * #slot
-     */
     responseType: {
         description: string;
         type: string;

package/dist/OAuthModel/configSchema.js

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

package/dist/OAuthModel/model.d.ts

@@ -1,9 +1,6 @@
-import { UriLocation } from '@jbrowse/core/util';
-import { Instance } from 'mobx-state-tree';
-import { OAuthInternetAccountConfigModel } from './configSchema';
-/**
- * #stateModel OAuthInternetAccount
- */
+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>;
@@ -35,13 +32,7 @@ declare const stateModelFactory: (configSchema: OAuthInternetAccountConfigModel)
         };
     }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, "internetAccountId">>;
 } & {
-    /**
-     * #property
-     */
     type: import("mobx-state-tree").ISimpleType<"OAuthInternetAccount">;
-    /**
-     * #property
-     */
     configuration: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
         tokenType: {
             description: string;
@@ -160,107 +151,30 @@ declare const stateModelFactory: (configSchema: OAuthInternetAccountConfigModel)
 } & {
     openLocation(location: UriLocation): import("@jbrowse/core/util/io").RemoteFileWithRangeCache;
 } & {
-    /**
-     * #getter
-     */
     readonly codeVerifierPKCE: string;
 } & {
-    /**
-     * #getter
-     */
     readonly authEndpoint: string;
-    /**
-     * #getter
-     */
     readonly tokenEndpoint: string;
-    /**
-     * #getter
-     */
     readonly needsPKCE: boolean;
-    /**
-     * #getter
-     */
     readonly clientId: string;
-    /**
-     * #getter
-     */
     readonly scopes: string;
-    /**
-     * #method
-     * OAuth state parameter:
-     * https://www.rfc-editor.org/rfc/rfc6749#section-4.1.1
-     *
-     * Can override or extend if dynamic state is needed.
-     */
     state(): string | undefined;
-    /**
-     * #getter
-     */
     readonly responseType: "code" | "token";
-    /**
-     * #getter
-     */
     readonly refreshTokenKey: string;
 } & {
-    /**
-     * #action
-     */
     storeRefreshToken(refreshToken: string): void;
-    /**
-     * #action
-     */
     removeRefreshToken(): void;
-    /**
-     * #method
-     */
     retrieveRefreshToken(): string | null;
-    /**
-     * #action
-     */
     exchangeAuthorizationForAccessToken(token: string, redirectUri: string): Promise<string>;
-    /**
-     * #action
-     */
     exchangeRefreshForAccessToken(refreshToken: string): Promise<string>;
 } & {
-    /**
-     * #action
-     * used to listen to child window for auth code/token
-     */
     addMessageChannel(resolve: (token: string) => void, reject: (error: Error) => void): void;
-    /**
-     * #action
-     */
     deleteMessageChannel(): void;
-    /**
-     * #action
-     */
     finishOAuthWindow(event: MessageEvent, resolve: (token: string) => void, reject: (error: Error) => void): Promise<void>;
-    /**
-     * #action
-     * opens external OAuth flow, popup for web and new browser window for
-     * desktop
-     */
     useEndpointForAuthorization(resolve: (token: string) => void, reject: (error: Error) => void): Promise<void>;
-    /**
-     * #action
-     */
     getTokenFromUser(resolve: (token: string) => void, reject: (error: Error) => void): Promise<void>;
-    /**
-     * #action
-     */
     validateToken(token: string, location: UriLocation): Promise<string>;
 } & {
-    /**
-     * #action
-     * Get a fetch method that will add any needed authentication headers
-     * to the request before sending it. If location is provided, it will
-     * be checked to see if it includes a token in it's pre-auth
-     * information.
-     *
-     * @param loc - UriLocation of the resource
-     * @returns A function that can be used to fetch
-     */
     getFetcher(loc?: UriLocation): (input: RequestInfo, init?: RequestInit) => Promise<Response>;
 }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>;
 export default stateModelFactory;

package/dist/OAuthModel/model.js

@@ -1,33 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const buffer_1 = require("buffer");
 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 buffer_1 = require("buffer");
 const util_2 = require("./util");
 const util_3 = require("../util");
-/**
- * #stateModel OAuthInternetAccount
- */
 const stateModelFactory = (configSchema) => {
     return models_1.InternetAccount.named('OAuthInternetAccount')
         .props({
-        /**
-         * #property
-         */
         type: mobx_state_tree_1.types.literal('OAuthInternetAccount'),
-        /**
-         * #property
-         */
         configuration: (0, configuration_1.ConfigurationReference)(configSchema),
     })
         .views(() => {
         let codeVerifier = undefined;
         return {
-            /**
-             * #getter
-             */
             get codeVerifierPKCE() {
                 if (codeVerifier) {
                     return codeVerifier;
@@ -40,81 +28,41 @@ const stateModelFactory = (configSchema) => {
         };
     })
         .views(self => ({
-        /**
-         * #getter
-         */
         get authEndpoint() {
             return (0, configuration_1.getConf)(self, 'authEndpoint');
         },
-        /**
-         * #getter
-         */
         get tokenEndpoint() {
             return (0, configuration_1.getConf)(self, 'tokenEndpoint');
         },
-        /**
-         * #getter
-         */
         get needsPKCE() {
             return (0, configuration_1.getConf)(self, 'needsPKCE');
         },
-        /**
-         * #getter
-         */
         get clientId() {
             return (0, configuration_1.getConf)(self, 'clientId');
         },
-        /**
-         * #getter
-         */
         get scopes() {
             return (0, configuration_1.getConf)(self, 'scopes');
         },
-        /**
-         * #method
-         * OAuth state parameter:
-         * https://www.rfc-editor.org/rfc/rfc6749#section-4.1.1
-         *
-         * Can override or extend if dynamic state is needed.
-         */
         state() {
             return (0, configuration_1.getConf)(self, 'state');
         },
-        /**
-         * #getter
-         */
         get responseType() {
             return (0, configuration_1.getConf)(self, 'responseType');
         },
-        /**
-         * #getter
-         */
         get refreshTokenKey() {
             return `${self.internetAccountId}-refreshToken`;
         },
     }))
         .actions(self => ({
-        /**
-         * #action
-         */
         storeRefreshToken(refreshToken) {
             localStorage.setItem(self.refreshTokenKey, refreshToken);
         },
-        /**
-         * #action
-         */
         removeRefreshToken() {
             localStorage.removeItem(self.refreshTokenKey);
         },
-        /**
-         * #method
-         */
         retrieveRefreshToken() {
             return localStorage.getItem(self.refreshTokenKey);
         },
-        /**
-         * #action
-         */
         async exchangeAuthorizationForAccessToken(token, redirectUri) {
             const params = new URLSearchParams(Object.entries({
                 code: token,
@@ -139,9 +87,6 @@ const stateModelFactory = (configSchema) => {
                 this.storeRefreshToken(token);
             });
         },
-        /**
-         * #action
-         */
         async exchangeRefreshForAccessToken(refreshToken) {
             const response = await fetch(self.tokenEndpoint, {
                 method: 'POST',
@@ -172,27 +117,15 @@ const stateModelFactory = (configSchema) => {
         let listener;
         let exchangedTokenPromise = undefined;
         return {
-            /**
-             * #action
-             * used to listen to child window for auth code/token
-             */
             addMessageChannel(resolve, reject) {
                 listener = event => {
-                    // this should probably get better handling, but ignored for now
-                    // eslint-disable-next-line @typescript-eslint/no-floating-promises
                     this.finishOAuthWindow(event, resolve, reject);
                 };
                 window.addEventListener('message', listener);
             },
-            /**
-             * #action
-             */
             deleteMessageChannel() {
                 window.removeEventListener('message', listener);
             },
-            /**
-             * #action
-             */
             async finishOAuthWindow(event, resolve, reject) {
                 if (event.data.name !== `JBrowseAuthWindow-${self.internetAccountId}`) {
                     this.deleteMessageChannel();
@@ -245,11 +178,6 @@ const stateModelFactory = (configSchema) => {
                 }
                 this.deleteMessageChannel();
             },
-            /**
-             * #action
-             * opens external OAuth flow, popup for web and new browser window for
-             * desktop
-             */
             async useEndpointForAuthorization(resolve, reject) {
                 const redirectUri = util_1.isElectron
                     ? 'http://localhost/auth'
@@ -284,22 +212,15 @@ const stateModelFactory = (configSchema) => {
                     const eventFromDesktop = new MessageEvent('message', {
                         data: { name: eventName, redirectUri: redirectUri },
                     });
-                    // may want to improve handling
-                    // eslint-disable-next-line @typescript-eslint/no-floating-promises
                     this.finishOAuthWindow(eventFromDesktop, resolve, reject);
                 }
                 else {
                     window.open(url, eventName, 'width=500,height=600,left=0,top=0');
                 }
             },
-            /**
-             * #action
-             */
             async getTokenFromUser(resolve, reject) {
                 const refreshToken = self.retrieveRefreshToken();
                 let doUserFlow = true;
-                // if there is a refresh token, then try it out, and only if that
-                // refresh token succeeds, set doUserFlow to false
                 if (refreshToken) {
                     try {
                         const token = await self.exchangeRefreshForAccessToken(refreshToken);
@@ -313,14 +234,9 @@ const stateModelFactory = (configSchema) => {
                 }
                 if (doUserFlow) {
                     this.addMessageChannel(resolve, reject);
-                    // may want to improve handling
-                    // eslint-disable-next-line @typescript-eslint/no-floating-promises
                     this.useEndpointForAuthorization(resolve, reject);
                 }
             },
-            /**
-             * #action
-             */
             async validateToken(token, location) {
                 const newInit = self.addAuthHeaderToInit({ method: 'HEAD' }, token);
                 const response = await fetch(location.uri, newInit);
@@ -339,7 +255,6 @@ const stateModelFactory = (configSchema) => {
                         }
                         catch (err) {
                             console.error('Token could not be refreshed', err);
-                            // let original error be thrown
                         }
                     }
                     throw new Error(await (0, util_3.getResponseError)({
@@ -354,16 +269,6 @@ const stateModelFactory = (configSchema) => {
         .actions(self => {
         const superGetFetcher = self.getFetcher;
         return {
-            /**
-             * #action
-             * Get a fetch method that will add any needed authentication headers
-             * to the request before sending it. If location is provided, it will
-             * be checked to see if it includes a token in it's pre-auth
-             * information.
-             *
-             * @param loc - UriLocation of the resource
-             * @returns A function that can be used to fetch
-             */
             getFetcher(loc) {
                 const fetcher = superGetFetcher(loc);
                 return async (input, init) => {

package/dist/OAuthModel/util.js

@@ -35,7 +35,6 @@ async function generateChallenge(val) {
     const Base64 = await Promise.resolve().then(() => __importStar(require('crypto-js/enc-base64')));
     return fixup(Base64.stringify(sha256(val)));
 }
-// if response is JSON, checks if it needs to remove tokens in error, or just plain throw
 function processError(text, invalidErrorCb) {
     var _a;
     try {
@@ -46,7 +45,6 @@ function processError(text, invalidErrorCb) {
         return (_a = obj === null || obj === void 0 ? void 0 : obj.error_description) !== null && _a !== void 0 ? _a : text;
     }
     catch (e) {
-        /* response text is not json, just use original text as error */
     }
     return text;
 }

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import Plugin from '@jbrowse/core/Plugin';
-import PluginManager from '@jbrowse/core/PluginManager';
 import { modelFactory as GoogleDriveOAuthInternetAccountModelFactory } from './GoogleDriveOAuthModel';
+import type PluginManager from '@jbrowse/core/PluginManager';
 export default class AuthenticationPlugin extends Plugin {
     name: string;
     exports: {

package/dist/index.js

@@ -6,11 +6,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.GoogleDriveOAuthInternetAccountModelFactory = exports.GoogleDriveOAuthConfigSchema = exports.DropboxOAuthInternetAccountModelFactory = exports.DropboxOAuthConfigSchema = exports.HTTPBasicInternetAccountModelFactory = exports.HTTPBasicConfigSchema = exports.ExternalTokenInternetAccountModelFactory = exports.ExternalTokenConfigSchema = exports.OAuthInternetAccountModelFactory = exports.OAuthConfigSchema = void 0;
 const Plugin_1 = __importDefault(require("@jbrowse/core/Plugin"));
 const InternetAccountType_1 = __importDefault(require("@jbrowse/core/pluggableElementTypes/InternetAccountType"));
-const OAuthModel_1 = require("./OAuthModel");
-const ExternalTokenModel_1 = require("./ExternalTokenModel");
-const HTTPBasicModel_1 = require("./HTTPBasicModel");
 const DropboxOAuthModel_1 = require("./DropboxOAuthModel");
+const ExternalTokenModel_1 = require("./ExternalTokenModel");
 const GoogleDriveOAuthModel_1 = require("./GoogleDriveOAuthModel");
+const HTTPBasicModel_1 = require("./HTTPBasicModel");
+const OAuthModel_1 = require("./OAuthModel");
 class AuthenticationPlugin extends Plugin_1.default {
     constructor() {
         super(...arguments);

package/esm/DropboxOAuthModel/DropboxIcon.d.ts

@@ -1,3 +1,3 @@
 import React from 'react';
-import { SvgIconProps } from '@mui/material';
+import type { SvgIconProps } from '@mui/material';
 export default function DropboxIcon(props: SvgIconProps): React.JSX.Element;

package/esm/DropboxOAuthModel/configSchema.d.ts

@@ -1,32 +1,20 @@
-import { Instance } from 'mobx-state-tree';
+import type { Instance } from 'mobx-state-tree';
 declare const DropboxOAuthConfigSchema: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
-    /**
-     * #slot
-     */
     authEndpoint: {
         description: string;
         type: string;
         defaultValue: string;
     };
-    /**
-     * #slot
-     */
     tokenEndpoint: {
         description: string;
         type: string;
         defaultValue: string;
     };
-    /**
-     * #slot
-     */
     needsPKCE: {
         description: string;
         type: string;
         defaultValue: boolean;
     };
-    /**
-     * #slot
-     */
     domains: {
         description: string;
         type: string;

package/esm/DropboxOAuthModel/configSchema.js

@@ -1,37 +1,22 @@
 import { ConfigurationSchema } from '@jbrowse/core/configuration';
 import OAuthConfigSchema from '../OAuthModel/configSchema';
-/**
- * #config DropboxOAuthInternetAccount
- */
-function x() { } // eslint-disable-line @typescript-eslint/no-unused-vars
+function x() { }
 const DropboxOAuthConfigSchema = ConfigurationSchema('DropboxOAuthInternetAccount', {
-    /**
-     * #slot
-     */
     authEndpoint: {
         description: 'the authorization code endpoint of the internet account',
         type: 'string',
         defaultValue: 'https://www.dropbox.com/oauth2/authorize',
     },
-    /**
-     * #slot
-     */
     tokenEndpoint: {
         description: 'the token endpoint of the internet account',
         type: 'string',
         defaultValue: 'https://api.dropbox.com/oauth2/token',
     },
-    /**
-     * #slot
-     */
     needsPKCE: {
         description: 'boolean to indicate if the endpoint needs a PKCE code',
         type: 'boolean',
         defaultValue: true,
     },
-    /**
-     * #slot
-     */
     domains: {
         description: 'array of valid domains the url can contain to use this account',
         type: 'stringArray',
@@ -46,9 +31,6 @@ const DropboxOAuthConfigSchema = ConfigurationSchema('DropboxOAuthInternetAccoun
         ],
     },
 }, {
-    /**
-     * #baseConfiguration
-     */
     baseConfiguration: OAuthConfigSchema,
     explicitlyTyped: true,
 });