@jbrowse/plugin-authentication 2.5.0 → 2.6.2

package/src/GoogleDriveOAuthModel/configSchema.ts

@@ -1,61 +0,0 @@
-import { ConfigurationSchema } from '@jbrowse/core/configuration'
-import { Instance } from 'mobx-state-tree'
-import OAuthConfigSchema from '../OAuthModel/configSchema'
-
-/**
- * #config GoogleDriveOAuthInternetAccount
- */
-function x() {} // eslint-disable-line @typescript-eslint/no-unused-vars
-
-const GoogleDriveOAuthConfigSchema = ConfigurationSchema(
-  'GoogleDriveOAuthInternetAccount',
-  {
-    /**
-     * #slot
-     */
-    authEndpoint: {
-      description: 'the authorization code endpoint of the internet account',
-      type: 'string',
-      defaultValue: 'https://accounts.google.com/o/oauth2/v2/auth',
-    },
-    /**
-     * #slot
-     */
-    scopes: {
-      description: 'optional scopes for the authorization call',
-      type: 'string',
-      defaultValue: 'https://www.googleapis.com/auth/drive.readonly',
-    },
-    /**
-     * #slot
-     */
-    domains: {
-      description:
-        'array of valid domains the url can contain to use this account',
-      type: 'stringArray',
-      defaultValue: ['drive.google.com"'],
-    },
-    /**
-     * #slot
-     */
-    responseType: {
-      description: 'the type of response from the authorization endpoint',
-      type: 'string',
-      defaultValue: 'token',
-    },
-  },
-  {
-    /**
-     * #baseConfiguration
-     */
-    baseConfiguration: OAuthConfigSchema,
-    explicitlyTyped: true,
-  },
-)
-
-export type GoogleDriveOAuthInternetAccountConfigModel =
-  typeof GoogleDriveOAuthConfigSchema
-
-export type GoogleDriveOAuthInternetAccountConfig =
-  Instance<GoogleDriveOAuthInternetAccountConfigModel>
-export default GoogleDriveOAuthConfigSchema

package/src/GoogleDriveOAuthModel/index.ts

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

package/src/GoogleDriveOAuthModel/model.tsx

@@ -1,174 +0,0 @@
-import React from 'react'
-import { ConfigurationReference } from '@jbrowse/core/configuration'
-import { Instance, types } from 'mobx-state-tree'
-import { RemoteFileWithRangeCache } from '@jbrowse/core/util/io'
-import { UriLocation } from '@jbrowse/core/util/types'
-import { SvgIconProps, SvgIcon } from '@mui/material'
-import {
-  FilehandleOptions,
-  Stats,
-  PolyfilledResponse,
-} from 'generic-filehandle'
-
-// locals
-import { GoogleDriveOAuthInternetAccountConfigModel } from './configSchema'
-import baseModel from '../OAuthModel/model'
-import { configSchema as OAuthConfigSchema } from '../OAuthModel'
-
-export interface RequestInitWithMetadata extends RequestInit {
-  metadataOnly?: boolean
-}
-
-interface GoogleDriveFilehandleOptions extends FilehandleOptions {
-  fetch(
-    input: RequestInfo,
-    opts?: RequestInitWithMetadata,
-  ): Promise<PolyfilledResponse>
-}
-
-interface GoogleDriveError {
-  error: {
-    errors: {
-      domain: string
-      reason: string
-      message: string
-      locationType?: string
-      location?: string
-    }[]
-    code: number
-    message: string
-  }
-}
-
-export class GoogleDriveFile extends RemoteFileWithRangeCache {
-  private statsPromise: Promise<{ size: number }>
-  constructor(source: string, opts: GoogleDriveFilehandleOptions) {
-    super(source, opts)
-    this.statsPromise = this.fetch(source, {
-      metadataOnly: true,
-    }).then((response: Response) => response.json())
-  }
-
-  async fetch(
-    input: RequestInfo,
-    opts?: RequestInitWithMetadata,
-  ): Promise<PolyfilledResponse> {
-    return super.fetch(input, opts)
-  }
-
-  async stat(): Promise<Stats> {
-    return this.statsPromise
-  }
-}
-
-function GoogleDriveIcon(props: SvgIconProps) {
-  return (
-    <SvgIcon {...props}>
-      <path d="M7.71,3.5L1.15,15L4.58,21L11.13,9.5M9.73,15L6.3,21H19.42L22.85,15M22.28,14L15.42,2H8.58L8.57,2L15.43,14H22.28Z" />
-    </SvgIcon>
-  )
-}
-
-async function getDescriptiveErrorMessage(response: Response) {
-  let errorMessage
-  try {
-    errorMessage = await response.text()
-  } catch (error) {
-    errorMessage = ''
-  }
-  if (errorMessage) {
-    let errorMessageParsed: GoogleDriveError | undefined
-    try {
-      errorMessageParsed = JSON.parse(errorMessage)
-    } catch (error) {
-      errorMessageParsed = undefined
-    }
-    if (errorMessageParsed) {
-      errorMessage = errorMessageParsed.error.message
-    }
-  }
-  return `Network response failure — ${response.status} (${
-    response.statusText
-  })${errorMessage ? ` (${errorMessage})` : ''}`
-}
-
-const stateModelFactory = (
-  configSchema: GoogleDriveOAuthInternetAccountConfigModel,
-) => {
-  return baseModel(OAuthConfigSchema)
-    .named('GoogleDriveOAuthInternetAccount')
-    .props({
-      type: types.literal('GoogleDriveOAuthInternetAccount'),
-      configuration: ConfigurationReference(configSchema),
-    })
-    .views(() => ({
-      get toggleContents() {
-        return <GoogleDriveIcon />
-      },
-      get selectorLabel() {
-        return 'Enter Google Drive share link'
-      },
-    }))
-    .actions(self => ({
-      getFetcher(
-        location?: UriLocation,
-      ): (input: RequestInfo, init?: RequestInit) => Promise<Response> {
-        return async (
-          input: RequestInfo,
-          init?: RequestInitWithMetadata,
-        ): Promise<Response> => {
-          const urlId = String(input).match(/[-\w]{25,}/)
-          const driveUrl = new URL(
-            `https://www.googleapis.com/drive/v3/files/${urlId}`,
-          )
-          const searchParams = new URLSearchParams()
-          if (init?.metadataOnly) {
-            searchParams.append('fields', 'size')
-          } else {
-            searchParams.append('alt', 'media')
-          }
-          driveUrl.search = searchParams.toString()
-          const authToken = await self.getToken(location)
-          const newInit = self.addAuthHeaderToInit(
-            { ...init, method: 'GET', credentials: 'same-origin' },
-            authToken,
-          )
-          const response = await fetch(driveUrl.toString(), newInit)
-          if (!response.ok) {
-            const message = await getDescriptiveErrorMessage(response)
-            throw new Error(message)
-          }
-          return response
-        }
-      },
-      openLocation(location: UriLocation) {
-        return new GoogleDriveFile(location.uri, {
-          fetch: this.getFetcher(location),
-        })
-      },
-      async validateToken(
-        token: string,
-        location: UriLocation,
-      ): Promise<string> {
-        const urlId = location.uri.match(/[-\w]{25,}/)
-        const response = await fetch(
-          `https://www.googleapis.com/drive/v3/files/${urlId}`,
-          {
-            headers: {
-              Authorization: `Bearer ${token}`,
-              'Content-Type': 'application/x-www-form-urlencoded',
-            },
-          },
-        )
-        if (!response.ok) {
-          const message = await getDescriptiveErrorMessage(response)
-          throw new Error(`Token could not be validated. ${message}`)
-        }
-        return token
-      },
-    }))
-}
-
-export default stateModelFactory
-export type GoogleDriveOAuthStateModel = ReturnType<typeof stateModelFactory>
-export type GoogleDriveOAuthModel = Instance<GoogleDriveOAuthStateModel>

package/src/HTTPBasicModel/HTTPBasicLoginForm.tsx

@@ -1,71 +0,0 @@
-import React, { useState } from 'react'
-import {
-  Button,
-  Dialog,
-  DialogContent,
-  DialogTitle,
-  DialogActions,
-  TextField,
-} from '@mui/material'
-
-export const HTTPBasicLoginForm = ({
-  internetAccountId,
-  handleClose,
-}: {
-  internetAccountId: string
-  handleClose: (arg?: string) => void
-}) => {
-  const [username, setUsername] = useState('')
-  const [password, setPassword] = useState('')
-
-  function onSubmit(event: React.FormEvent<HTMLFormElement>) {
-    if (username && password) {
-      handleClose(btoa(`${username}:${password}`))
-    } else {
-      handleClose()
-    }
-    event.preventDefault()
-  }
-
-  return (
-    <>
-      <Dialog open maxWidth="xl" data-testid="login-httpbasic">
-        <DialogTitle>Log In for {internetAccountId}</DialogTitle>
-        <form onSubmit={onSubmit}>
-          <DialogContent style={{ display: 'flex', flexDirection: 'column' }}>
-            <TextField
-              required
-              label="Username"
-              variant="outlined"
-              inputProps={{ 'data-testid': 'login-httpbasic-username' }}
-              onChange={event => setUsername(event.target.value)}
-              margin="dense"
-            />
-            <TextField
-              required
-              label="Password"
-              type="password"
-              autoComplete="current-password"
-              variant="outlined"
-              inputProps={{ 'data-testid': 'login-httpbasic-password' }}
-              onChange={event => setPassword(event.target.value)}
-              margin="dense"
-            />
-          </DialogContent>
-          <DialogActions>
-            <Button variant="contained" color="primary" type="submit">
-              Submit
-            </Button>
-            <Button
-              variant="contained"
-              type="submit"
-              onClick={() => handleClose()}
-            >
-              Cancel
-            </Button>
-          </DialogActions>
-        </form>
-      </Dialog>
-    </>
-  )
-}

package/src/HTTPBasicModel/configSchema.ts

@@ -1,43 +0,0 @@
-import { ConfigurationSchema } from '@jbrowse/core/configuration'
-import { Instance } from 'mobx-state-tree'
-import { BaseInternetAccountConfig } from '@jbrowse/core/pluggableElementTypes/models'
-
-/**
- * #config HTTPBasicInternetAccount
- */
-function x() {} // eslint-disable-line @typescript-eslint/no-unused-vars
-
-const HTTPBasicConfigSchema = ConfigurationSchema(
-  'HTTPBasicInternetAccount',
-  {
-    /**
-     * #slot
-     */
-    tokenType: {
-      description: 'a custom name for a token to include in the header',
-      type: 'string',
-      defaultValue: 'Basic',
-    },
-    /**
-     * #slot
-     */
-    validateWithHEAD: {
-      description: 'validate the token with a HEAD request before using it',
-      type: 'boolean',
-      defaultValue: true,
-    },
-  },
-  {
-    /**
-     * #baseConfiguration
-     */
-    baseConfiguration: BaseInternetAccountConfig,
-    explicitlyTyped: true,
-  },
-)
-
-export type HTTPBasicInternetAccountConfigModel = typeof HTTPBasicConfigSchema
-
-export type HTTPBasicInternetAccountConfig =
-  Instance<HTTPBasicInternetAccountConfigModel>
-export default HTTPBasicConfigSchema

package/src/HTTPBasicModel/index.ts

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

package/src/HTTPBasicModel/model.tsx

@@ -1,70 +0,0 @@
-import { ConfigurationReference, getConf } from '@jbrowse/core/configuration'
-import { InternetAccount } from '@jbrowse/core/pluggableElementTypes/models'
-import { UriLocation } from '@jbrowse/core/util/types'
-import { HTTPBasicInternetAccountConfigModel } from './configSchema'
-import { Instance, types, getRoot } from 'mobx-state-tree'
-
-import { HTTPBasicLoginForm } from './HTTPBasicLoginForm'
-
-const stateModelFactory = (
-  configSchema: HTTPBasicInternetAccountConfigModel,
-) => {
-  return InternetAccount.named('HTTPBasicInternetAccount')
-    .props({
-      type: types.literal('HTTPBasicInternetAccount'),
-      configuration: ConfigurationReference(configSchema),
-    })
-    .views(self => ({
-      get validateWithHEAD(): boolean {
-        return getConf(self, 'validateWithHEAD')
-      },
-    }))
-    .actions(self => ({
-      getTokenFromUser(
-        resolve: (token: string) => void,
-        reject: (error: Error) => void,
-      ) {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        const { session } = getRoot<any>(self)
-        session.queueDialog((doneCallback: () => void) => [
-          HTTPBasicLoginForm,
-          {
-            internetAccountId: self.internetAccountId,
-            handleClose: (token: string) => {
-              if (token) {
-                resolve(token)
-              } else {
-                reject(new Error('user cancelled entry'))
-              }
-              doneCallback()
-            },
-          },
-        ])
-      },
-      async validateToken(token: string, location: UriLocation) {
-        if (!self.validateWithHEAD) {
-          return token
-        }
-        const newInit = self.addAuthHeaderToInit({ method: 'HEAD' }, token)
-        const response = await fetch(location.uri, newInit)
-        if (!response.ok) {
-          let errorMessage
-          try {
-            errorMessage = await response.text()
-          } catch (error) {
-            errorMessage = ''
-          }
-          throw new Error(
-            `Error validating token — ${response.status} (${
-              response.statusText
-            })${errorMessage ? ` (${errorMessage})` : ''}`,
-          )
-        }
-        return token
-      },
-    }))
-}
-
-export default stateModelFactory
-export type HTTPBasicStateModel = ReturnType<typeof stateModelFactory>
-export type HTTPBasicModel = Instance<HTTPBasicStateModel>

package/src/OAuthModel/configSchema.ts

@@ -1,98 +0,0 @@
-import { ConfigurationSchema } from '@jbrowse/core/configuration'
-import { Instance } from 'mobx-state-tree'
-import { BaseInternetAccountConfig } from '@jbrowse/core/pluggableElementTypes/models'
-
-/**
- * #config OAuthInternetAccount
- */
-function x() {} // eslint-disable-line @typescript-eslint/no-unused-vars
-
-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',
-      type: 'string',
-      defaultValue: 'code',
-    },
-    /**
-     * #slot
-     */
-    hasRefreshToken: {
-      description: 'true if the endpoint can supply a refresh token',
-      type: 'boolean',
-      defaultValue: false,
-    },
-  },
-  {
-    /**
-     * #baseConfiguration
-     */
-    baseConfiguration: BaseInternetAccountConfig,
-    explicitlyTyped: true,
-  },
-)
-
-export type OAuthInternetAccountConfigModel = typeof OAuthConfigSchema
-export type OAuthInternetAccountConfig =
-  Instance<OAuthInternetAccountConfigModel>
-export default OAuthConfigSchema

package/src/OAuthModel/index.ts

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