@jbrowse/plugin-authentication 2.17.0 → 2.18.0

package/esm/OAuthModel/configSchema.js

@@ -1,78 +1,48 @@
 import { ConfigurationSchema } from '@jbrowse/core/configuration';
 import { BaseInternetAccountConfig } from '@jbrowse/core/pluggableElementTypes/models';
-/**
- * #config OAuthInternetAccount
- */
-function x() { } // eslint-disable-line @typescript-eslint/no-unused-vars
+function x() { }
 const OAuthConfigSchema = 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: BaseInternetAccountConfig,
     explicitlyTyped: true,
 });

package/esm/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/esm/OAuthModel/model.js

@@ -1,31 +1,19 @@
+import { Buffer } from 'buffer';
 import { ConfigurationReference, getConf } from '@jbrowse/core/configuration';
 import { InternetAccount } from '@jbrowse/core/pluggableElementTypes/models';
 import { isElectron } from '@jbrowse/core/util';
 import { types } from 'mobx-state-tree';
-import { Buffer } from 'buffer';
 import { fixup, generateChallenge, processError, processTokenResponse, } from './util';
 import { getResponseError } from '../util';
-/**
- * #stateModel OAuthInternetAccount
- */
 const stateModelFactory = (configSchema) => {
     return InternetAccount.named('OAuthInternetAccount')
         .props({
-        /**
-         * #property
-         */
         type: types.literal('OAuthInternetAccount'),
-        /**
-         * #property
-         */
         configuration: ConfigurationReference(configSchema),
     })
         .views(() => {
         let codeVerifier = undefined;
         return {
-            /**
-             * #getter
-             */
             get codeVerifierPKCE() {
                 if (codeVerifier) {
                     return codeVerifier;
@@ -38,81 +26,41 @@ const stateModelFactory = (configSchema) => {
         };
     })
         .views(self => ({
-        /**
-         * #getter
-         */
         get authEndpoint() {
             return getConf(self, 'authEndpoint');
         },
-        /**
-         * #getter
-         */
         get tokenEndpoint() {
             return getConf(self, 'tokenEndpoint');
         },
-        /**
-         * #getter
-         */
         get needsPKCE() {
             return getConf(self, 'needsPKCE');
         },
-        /**
-         * #getter
-         */
         get clientId() {
             return getConf(self, 'clientId');
         },
-        /**
-         * #getter
-         */
         get scopes() {
             return 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 getConf(self, 'state');
         },
-        /**
-         * #getter
-         */
         get responseType() {
             return 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,
@@ -137,9 +85,6 @@ const stateModelFactory = (configSchema) => {
                 this.storeRefreshToken(token);
             });
         },
-        /**
-         * #action
-         */
         async exchangeRefreshForAccessToken(refreshToken) {
             const response = await fetch(self.tokenEndpoint, {
                 method: 'POST',
@@ -170,27 +115,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();
@@ -243,11 +176,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 = isElectron
                     ? 'http://localhost/auth'
@@ -282,22 +210,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);
@@ -311,14 +232,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);
@@ -337,7 +253,6 @@ const stateModelFactory = (configSchema) => {
                         }
                         catch (err) {
                             console.error('Token could not be refreshed', err);
-                            // let original error be thrown
                         }
                     }
                     throw new Error(await getResponseError({
@@ -352,16 +267,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/esm/OAuthModel/util.js

@@ -6,7 +6,6 @@ export async function generateChallenge(val) {
     const Base64 = await import('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
 export function processError(text, invalidErrorCb) {
     var _a;
     try {
@@ -17,7 +16,6 @@ export 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/esm/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/esm/index.js

@@ -1,10 +1,10 @@
 import Plugin from '@jbrowse/core/Plugin';
 import InternetAccountType from '@jbrowse/core/pluggableElementTypes/InternetAccountType';
-import { configSchema as OAuthConfigSchema, modelFactory as OAuthInternetAccountModelFactory, } from './OAuthModel';
-import { configSchema as ExternalTokenConfigSchema, modelFactory as ExternalTokenInternetAccountModelFactory, } from './ExternalTokenModel';
-import { configSchema as HTTPBasicConfigSchema, modelFactory as HTTPBasicInternetAccountModelFactory, } from './HTTPBasicModel';
 import { configSchema as DropboxOAuthConfigSchema, modelFactory as DropboxOAuthInternetAccountModelFactory, } from './DropboxOAuthModel';
+import { configSchema as ExternalTokenConfigSchema, modelFactory as ExternalTokenInternetAccountModelFactory, } from './ExternalTokenModel';
 import { configSchema as GoogleDriveOAuthConfigSchema, modelFactory as GoogleDriveOAuthInternetAccountModelFactory, } from './GoogleDriveOAuthModel';
+import { configSchema as HTTPBasicConfigSchema, modelFactory as HTTPBasicInternetAccountModelFactory, } from './HTTPBasicModel';
+import { configSchema as OAuthConfigSchema, modelFactory as OAuthInternetAccountModelFactory, } from './OAuthModel';
 export default class AuthenticationPlugin extends Plugin {
     constructor() {
         super(...arguments);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jbrowse/plugin-authentication",
-  "version": "2.17.0",
+  "version": "2.18.0",
   "description": "JBrowse 2 Authentication",
   "keywords": [
     "jbrowse",
@@ -55,5 +55,5 @@
   "distModule": "esm/index.js",
   "srcModule": "src/index.ts",
   "module": "esm/index.js",
-  "gitHead": "eed30b5e671f8f7823652d7cecc51aa89226de46"
+  "gitHead": "c344ea60099cb7e460b77f15808946b24a7eee74"
 }