@jbrowse/plugin-authentication 2.4.2 → 2.6.1

package/esm/util.d.ts

@@ -0,0 +1,6 @@
+export declare function getResponseError({ response, reason, statusText, }: {
+    response: Response;
+    reason?: string;
+    statusText?: string;
+}): Promise<string>;
+export declare function getError(response: Response): Promise<string>;

package/esm/util.js

@@ -0,0 +1,18 @@
+export async function getResponseError({ response, reason, statusText, }) {
+    return [
+        `HTTP ${response.status}`,
+        reason,
+        statusText !== null && statusText !== void 0 ? statusText : (await getError(response)),
+    ]
+        .filter(f => !!f)
+        .join(' - ');
+}
+export async function getError(response) {
+    try {
+        return response.text();
+    }
+    catch (e) {
+        return response.statusText;
+    }
+}
+//# sourceMappingURL=util.js.map

package/esm/util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,EACrC,QAAQ,EACR,MAAM,EACN,UAAU,GAKX;IACC,OAAO;QACL,QAAQ,QAAQ,CAAC,MAAM,EAAE;QACzB,MAAM;QACN,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,CAAC,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAC;KACzC;SACE,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;SAChB,IAAI,CAAC,KAAK,CAAC,CAAA;AAChB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,QAAkB;IAC/C,IAAI;QACF,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAA;KACvB;IAAC,OAAO,CAAC,EAAE;QACV,OAAO,QAAQ,CAAC,UAAU,CAAA;KAC3B;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jbrowse/plugin-authentication",
-  "version": "2.4.2",
+  "version": "2.6.1",
   "description": "JBrowse 2 Authentication",
   "keywords": [
     "jbrowse",
@@ -38,8 +38,7 @@
   },
   "dependencies": {
     "crypto-js": "^3.0.0",
-    "generic-filehandle": "^3.0.0",
-    "jwt-decode": "^3.1.2"
+    "generic-filehandle": "^3.0.0"
   },
   "peerDependencies": {
     "@jbrowse/core": "^2.0.0",
@@ -57,5 +56,5 @@
   "distModule": "esm/index.js",
   "srcModule": "src/index.ts",
   "module": "esm/index.js",
-  "gitHead": "36e382a70e7d220343b873e7e6aba5c83e5342c8"
+  "gitHead": "1cbe7ba097fb2d2763c776e5e429e4670cdd583c"
 }

package/src/DropboxOAuthModel/configSchema.ts

@@ -51,14 +51,6 @@ const DropboxOAuthConfigSchema = ConfigurationSchema(
         'getdropbox.com',
       ],
     },
-    /**
-     * #slot
-     */
-    hasRefreshToken: {
-      description: 'true if the endpoint can supply a refresh token',
-      type: 'boolean',
-      defaultValue: true,
-    },
   },
   {
     /**

package/src/DropboxOAuthModel/model.tsx

@@ -3,26 +3,12 @@ import { ConfigurationReference } from '@jbrowse/core/configuration'
 import { UriLocation } from '@jbrowse/core/util/types'
 import { SvgIconProps, SvgIcon } from '@mui/material'
 import { Instance, types } from 'mobx-state-tree'
+
+// locals
 import { DropboxOAuthInternetAccountConfigModel } from './configSchema'
 import baseModel from '../OAuthModel/model'
 import { configSchema as OAuthConfigSchema } from '../OAuthModel'
-
-interface DropboxError {
-  error_summary: string
-  error: {
-    '.tag': string
-  }
-}
-
-/** Error messages from https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_shared_link_file */
-const dropboxErrorMessages: Record<string, string | undefined> = {
-  shared_link_not_found: "The shared link wasn't found.",
-  shared_link_access_denied:
-    'The caller is not allowed to access this shared link.',
-  unsupported_link_type:
-    'This type of link is not supported; use files/export instead.',
-  shared_link_is_directory: 'Directories cannot be retrieved by this endpoint.',
-}
+import { getDescriptiveErrorMessage } from './util'
 
 export function DropboxIcon(props: SvgIconProps) {
   return (
@@ -32,55 +18,45 @@ export function DropboxIcon(props: SvgIconProps) {
   )
 }
 
-async function getDescriptiveErrorMessage(response: Response) {
-  let errorMessage
-  try {
-    errorMessage = await response.text()
-  } catch (error) {
-    errorMessage = ''
-  }
-  if (errorMessage) {
-    let errorMessageParsed: DropboxError | undefined
-    try {
-      errorMessageParsed = JSON.parse(errorMessage)
-    } catch (error) {
-      errorMessageParsed = undefined
-    }
-    if (errorMessageParsed) {
-      const messageTag = errorMessageParsed.error['.tag']
-      errorMessage = dropboxErrorMessages[messageTag] || messageTag
-    }
-  }
-  return `Network response failure — ${response.status} (${
-    response.statusText
-  })${errorMessage ? ` (${errorMessage})` : ''}`
-}
-
+/**
+ * #stateModel DropboxOAuthInternetAccount
+ */
 const stateModelFactory = (
   configSchema: DropboxOAuthInternetAccountConfigModel,
 ) => {
   return baseModel(OAuthConfigSchema)
     .named('DropboxOAuthInternetAccount')
     .props({
+      /**
+       * #property
+       */
       type: types.literal('DropboxOAuthInternetAccount'),
+      /**
+       * #property
+       */
       configuration: ConfigurationReference(configSchema),
     })
     .views(() => ({
+      /**
+       * #getter
+       * The FileSelector icon for Dropbox
+       */
       get toggleContents() {
         return <DropboxIcon />
       },
+      /**
+       * #getter
+       */
       get selectorLabel() {
         return 'Enter Dropbox share link'
       },
     }))
     .actions(self => ({
-      getFetcher(
-        location?: UriLocation,
-      ): (input: RequestInfo, init?: RequestInit) => Promise<Response> {
-        return async (
-          input: RequestInfo,
-          init?: RequestInit,
-        ): Promise<Response> => {
+      /**
+       * #method
+       */
+      getFetcher(location?: UriLocation) {
+        return async (input: RequestInfo, init?: RequestInit) => {
           const authToken = await self.getToken(location)
           const newInit = self.addAuthHeaderToInit(
             { ...init, method: 'POST' },
@@ -95,12 +71,14 @@ const stateModelFactory = (
             newInit,
           )
           if (!response.ok) {
-            const message = await getDescriptiveErrorMessage(response)
-            throw new Error(message)
+            throw new Error(await getDescriptiveErrorMessage(response))
           }
           return response
         }
       },
+      /**
+       * #action
+       */
       async validateToken(
         token: string,
         location: UriLocation,
@@ -119,8 +97,7 @@ const stateModelFactory = (
           },
         )
         if (!response.ok) {
-          const refreshToken =
-            self.hasRefreshToken && self.retrieveRefreshToken()
+          const refreshToken = self.retrieveRefreshToken()
           if (refreshToken) {
             self.removeRefreshToken()
             const newToken = await self.exchangeRefreshForAccessToken(
@@ -128,8 +105,12 @@ const stateModelFactory = (
             )
             return this.validateToken(newToken, location)
           }
-          const message = await getDescriptiveErrorMessage(response)
-          throw new Error(`Token could not be validated. ${message}`)
+          throw new Error(
+            await getDescriptiveErrorMessage(
+              response,
+              'Token could not be validated',
+            ),
+          )
         }
         return token
       },

package/src/DropboxOAuthModel/util.ts

@@ -0,0 +1,36 @@
+import { getResponseError } from '../util'
+
+interface DropboxError {
+  error_summary: string
+  error: {
+    '.tag': string
+  }
+}
+
+/**
+ * Error messages from
+ * https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_shared_link_file
+ * */
+const dropboxErrorMessages: Record<string, string | undefined> = {
+  shared_link_not_found: "The shared link wasn't found.",
+  shared_link_access_denied:
+    'The caller is not allowed to access this shared link.',
+  unsupported_link_type:
+    'This type of link is not supported; use files/export instead.',
+  shared_link_is_directory: 'Directories cannot be retrieved by this endpoint.',
+}
+
+export async function getDescriptiveErrorMessage(
+  response: Response,
+  reason?: string,
+) {
+  let errorMessage = ''
+  try {
+    const err = JSON.parse(await response.text()) as DropboxError
+    const tag = err.error['.tag']
+    errorMessage = dropboxErrorMessages[tag] || tag
+  } catch (error) {
+    /* do nothing */
+  }
+  return getResponseError({ response, reason, statusText: errorMessage })
+}

package/src/ExternalTokenModel/ExternalTokenEntryForm.tsx

@@ -12,46 +12,44 @@ export const ExternalTokenEntryForm = ({
   const [token, setToken] = useState('')
 
   return (
-    <>
-      <Dialog
-        open
-        maxWidth="xl"
-        data-testid="externalToken-form"
-        title={`Enter token for ${internetAccountId}`}
-      >
-        <DialogContent style={{ display: 'flex', flexDirection: 'column' }}>
-          <TextField
-            required
-            label="Enter Token"
-            variant="outlined"
-            inputProps={{ 'data-testid': 'entry-externalToken' }}
-            onChange={event => setToken(event.target.value)}
-            margin="dense"
-          />
-        </DialogContent>
-        <DialogActions>
-          <Button
-            variant="contained"
-            color="primary"
-            type="submit"
-            disabled={!token}
-            onClick={() => {
-              if (token) {
-                handleClose(token)
-              }
-            }}
-          >
-            Add
-          </Button>
-          <Button
-            variant="contained"
-            color="primary"
-            onClick={() => handleClose()}
-          >
-            Cancel
-          </Button>
-        </DialogActions>
-      </Dialog>
-    </>
+    <Dialog
+      open
+      maxWidth="xl"
+      data-testid="externalToken-form"
+      title={`Enter token for ${internetAccountId}`}
+    >
+      <DialogContent style={{ display: 'flex', flexDirection: 'column' }}>
+        <TextField
+          required
+          label="Enter Token"
+          variant="outlined"
+          inputProps={{ 'data-testid': 'entry-externalToken' }}
+          onChange={event => setToken(event.target.value)}
+          margin="dense"
+        />
+      </DialogContent>
+      <DialogActions>
+        <Button
+          variant="contained"
+          color="primary"
+          type="submit"
+          disabled={!token}
+          onClick={() => {
+            if (token) {
+              handleClose(token)
+            }
+          }}
+        >
+          Add
+        </Button>
+        <Button
+          variant="contained"
+          color="secondary"
+          onClick={() => handleClose()}
+        >
+          Cancel
+        </Button>
+      </DialogActions>
+    </Dialog>
   )
 }

package/src/GoogleDriveOAuthModel/GoogleDriveFilehandle.ts

@@ -0,0 +1,38 @@
+import { RemoteFileWithRangeCache } from '@jbrowse/core/util/io'
+import {
+  FilehandleOptions,
+  Stats,
+  PolyfilledResponse,
+} from 'generic-filehandle'
+
+export interface RequestInitWithMetadata extends RequestInit {
+  metadataOnly?: boolean
+}
+
+interface GoogleDriveFilehandleOptions extends FilehandleOptions {
+  fetch(
+    input: RequestInfo,
+    opts?: RequestInitWithMetadata,
+  ): Promise<PolyfilledResponse>
+}
+
+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
+  }
+}

package/src/GoogleDriveOAuthModel/model.tsx

@@ -1,66 +1,20 @@
 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'
+import { getDescriptiveErrorMessage } from './util'
+import { GoogleDriveFile } from './GoogleDriveFilehandle'
 
 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}>
@@ -69,58 +23,51 @@ function GoogleDriveIcon(props: SvgIconProps) {
   )
 }
 
-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})` : ''}`
+function getUri(str: string) {
+  const urlId = str.match(/[-\w]{25,}/)
+  return `https://www.googleapis.com/drive/v3/files/${urlId}`
 }
 
-const stateModelFactory = (
+/**
+ * #stateModel GoogleDriveOAuthInternetAccount
+ */
+export default function stateModelFactory(
   configSchema: GoogleDriveOAuthInternetAccountConfigModel,
-) => {
+) {
   return baseModel(OAuthConfigSchema)
     .named('GoogleDriveOAuthInternetAccount')
     .props({
+      /**
+       * #property
+       */
       type: types.literal('GoogleDriveOAuthInternetAccount'),
+      /**
+       * #property
+       */
       configuration: ConfigurationReference(configSchema),
     })
     .views(() => ({
+      /**
+       * #getter
+       * The FileSelector icon for Google drive
+       */
       get toggleContents() {
         return <GoogleDriveIcon />
       },
+      /**
+       * #getter
+       */
       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}`,
-          )
+      /**
+       * #method
+       */
+      getFetcher(location?: UriLocation) {
+        return async (input: RequestInfo, init?: RequestInitWithMetadata) => {
+          const driveUrl = new URL(getUri(String(input)))
           const searchParams = new URLSearchParams()
           if (init?.metadataOnly) {
             searchParams.append('fields', 'size')
@@ -129,46 +76,49 @@ const stateModelFactory = (
           }
           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,
+            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)
+            throw new Error(await getDescriptiveErrorMessage(response))
           }
           return response
         }
       },
+      /**
+       * #method
+       */
       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',
-            },
+      /**
+       * #action
+       */
+      async validateToken(token: string, location: UriLocation) {
+        const response = await fetch(getUri(location.uri), {
+          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}`)
+          throw new Error(
+            await getDescriptiveErrorMessage(
+              response,
+              'Token could not be validated',
+            ),
+          )
         }
         return token
       },
     }))
 }
 
-export default stateModelFactory
 export type GoogleDriveOAuthStateModel = ReturnType<typeof stateModelFactory>
 export type GoogleDriveOAuthModel = Instance<GoogleDriveOAuthStateModel>

package/src/GoogleDriveOAuthModel/util.ts

@@ -0,0 +1,29 @@
+import { getResponseError } from '../util'
+
+interface GoogleDriveError {
+  error: {
+    errors: {
+      domain: string
+      reason: string
+      message: string
+      locationType?: string
+      location?: string
+    }[]
+    code: number
+    message: string
+  }
+}
+
+export async function getDescriptiveErrorMessage(
+  response: Response,
+  reason?: string,
+) {
+  let errorMessage = ''
+  try {
+    const err = JSON.parse(await response.text()) as GoogleDriveError
+    errorMessage = err.error.message
+  } catch (error) {
+    /* do nothing */
+  }
+  return getResponseError({ response, reason, statusText: errorMessage })
+}