@jbrowse/plugin-authentication 2.5.0 → 2.6.2

package/esm/DropboxOAuthModel/configSchema.d.ts

@@ -32,14 +32,6 @@ declare const DropboxOAuthConfigSchema: import("@jbrowse/core/configuration/conf
         type: string;
         defaultValue: string[];
     };
-    /**
-     * #slot
-     */
-    hasRefreshToken: {
-        description: string;
-        type: string;
-        defaultValue: boolean;
-    };
 }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
     tokenType: {
         description: string;
@@ -68,7 +60,9 @@ declare const DropboxOAuthConfigSchema: import("@jbrowse/core/configuration/conf
     };
     scopes: {
         description: string;
-        type: string;
+        type: string; /**
+         * #baseConfiguration
+         */
         defaultValue: string;
     };
     state: {
@@ -81,11 +75,6 @@ declare const DropboxOAuthConfigSchema: import("@jbrowse/core/configuration/conf
         type: string;
         defaultValue: string;
     };
-    hasRefreshToken: {
-        description: string;
-        type: string;
-        defaultValue: boolean;
-    };
 }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
     name: {
         description: string;

package/esm/DropboxOAuthModel/configSchema.js

@@ -45,14 +45,6 @@ const DropboxOAuthConfigSchema = ConfigurationSchema('DropboxOAuthInternetAccoun
             'getdropbox.com',
         ],
     },
-    /**
-     * #slot
-     */
-    hasRefreshToken: {
-        description: 'true if the endpoint can supply a refresh token',
-        type: 'boolean',
-        defaultValue: true,
-    },
 }, {
     /**
      * #baseConfiguration
@@ -61,4 +53,3 @@ const DropboxOAuthConfigSchema = ConfigurationSchema('DropboxOAuthInternetAccoun
     explicitlyTyped: true,
 });
 export default DropboxOAuthConfigSchema;
-//# sourceMappingURL=configSchema.js.map

package/esm/DropboxOAuthModel/index.js

@@ -1,3 +1,2 @@
 export { default as configSchema } from './configSchema';
 export { default as modelFactory } from './model';
-//# sourceMappingURL=index.js.map

package/esm/DropboxOAuthModel/model.d.ts

@@ -2,7 +2,10 @@ import React from 'react';
 import { UriLocation } from '@jbrowse/core/util/types';
 import { SvgIconProps } from '@mui/material';
 import { Instance } from 'mobx-state-tree';
-export declare function DropboxIcon(props: SvgIconProps): JSX.Element;
+export declare function DropboxIcon(props: SvgIconProps): React.JSX.Element;
+/**
+ * #stateModel DropboxOAuthInternetAccount
+ */
 declare const stateModelFactory: (configSchema: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
     authEndpoint: {
         description: string;
@@ -24,11 +27,6 @@ declare const stateModelFactory: (configSchema: import("@jbrowse/core/configurat
         type: string;
         defaultValue: string[];
     };
-    hasRefreshToken: {
-        description: string;
-        type: string;
-        defaultValue: boolean;
-    };
 }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
     tokenType: {
         description: string;
@@ -70,11 +68,6 @@ declare const stateModelFactory: (configSchema: import("@jbrowse/core/configurat
         type: string;
         defaultValue: string;
     };
-    hasRefreshToken: {
-        description: string;
-        type: string;
-        defaultValue: boolean;
-    };
 }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
     name: {
         description: string;
@@ -90,7 +83,7 @@ declare const stateModelFactory: (configSchema: import("@jbrowse/core/configurat
         description: string;
         type: string;
         defaultValue: string;
-    }; /** Error messages from https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_shared_link_file */
+    };
     tokenType: {
         description: string;
         type: string;
@@ -121,7 +114,9 @@ declare const stateModelFactory: (configSchema: import("@jbrowse/core/configurat
             defaultValue: string;
         };
         tokenType: {
-            description: string;
+            description: string; /**
+             * #property
+             */
             type: string;
             defaultValue: string;
         };
@@ -174,11 +169,6 @@ declare const stateModelFactory: (configSchema: import("@jbrowse/core/configurat
             type: string;
             defaultValue: string;
         };
-        hasRefreshToken: {
-            description: string;
-            type: string;
-            defaultValue: boolean;
-        };
     }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
         name: {
             description: string;
@@ -194,7 +184,7 @@ declare const stateModelFactory: (configSchema: import("@jbrowse/core/configurat
             description: string;
             type: string;
             defaultValue: string;
-        }; /** Error messages from https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_shared_link_file */
+        };
         tokenType: {
             description: string;
             type: string;
@@ -207,7 +197,13 @@ declare const stateModelFactory: (configSchema: import("@jbrowse/core/configurat
         };
     }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, "internetAccountId">>, undefined>>;
 } & {
+    /**
+     * #property
+     */
     type: import("mobx-state-tree").ISimpleType<"DropboxOAuthInternetAccount">;
+    /**
+     * #property
+     */
     configuration: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
         authEndpoint: {
             description: string;
@@ -229,11 +225,6 @@ declare const stateModelFactory: (configSchema: import("@jbrowse/core/configurat
             type: string;
             defaultValue: string[];
         };
-        hasRefreshToken: {
-            description: string;
-            type: string;
-            defaultValue: boolean;
-        };
     }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
         tokenType: {
             description: string;
@@ -275,11 +266,6 @@ declare const stateModelFactory: (configSchema: import("@jbrowse/core/configurat
             type: string;
             defaultValue: string;
         };
-        hasRefreshToken: {
-            description: string;
-            type: string;
-            defaultValue: boolean;
-        };
     }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
         name: {
             description: string;
@@ -295,7 +281,7 @@ declare const stateModelFactory: (configSchema: import("@jbrowse/core/configurat
             description: string;
             type: string;
             defaultValue: string;
-        }; /** Error messages from https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_shared_link_file */
+        };
         tokenType: {
             description: string;
             type: string;
@@ -308,7 +294,9 @@ declare const stateModelFactory: (configSchema: import("@jbrowse/core/configurat
         };
     }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, "internetAccountId">>, undefined>>, undefined>>;
 }, {
-    readonly name: string;
+    readonly name: string; /**
+     * #getter
+     */
     readonly description: string;
     readonly internetAccountId: string;
     readonly authHeader: string;
@@ -365,7 +353,6 @@ declare const stateModelFactory: (configSchema: import("@jbrowse/core/configurat
     readonly scopes: string;
     state(): string | undefined;
     readonly responseType: "code" | "token";
-    readonly hasRefreshToken: boolean;
     readonly refreshTokenKey: string;
 } & {
     storeRefreshToken(refreshToken: string): void;
@@ -381,10 +368,25 @@ declare const stateModelFactory: (configSchema: import("@jbrowse/core/configurat
     getTokenFromUser(resolve: (token: string) => void, reject: (error: Error) => void): Promise<void>;
     validateToken(token: string, location: UriLocation): Promise<string>;
 } & {
-    readonly toggleContents: JSX.Element;
+    getFetcher(loc?: UriLocation | undefined): (input: RequestInfo, init?: RequestInit | undefined) => Promise<Response>;
+} & {
+    /**
+     * #getter
+     * The FileSelector icon for Dropbox
+     */
+    readonly toggleContents: React.JSX.Element;
+    /**
+     * #getter
+     */
     readonly selectorLabel: string;
 } & {
+    /**
+     * #method
+     */
     getFetcher(location?: UriLocation): (input: RequestInfo, init?: RequestInit) => Promise<Response>;
+    /**
+     * #action
+     */
     validateToken(token: string, location: UriLocation): Promise<string>;
 }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>;
 export default stateModelFactory;

package/esm/DropboxOAuthModel/model.js

@@ -4,56 +4,46 @@ import { SvgIcon } from '@mui/material';
 import { types } from 'mobx-state-tree';
 import baseModel from '../OAuthModel/model';
 import { configSchema as OAuthConfigSchema } from '../OAuthModel';
-/** Error messages from https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_shared_link_file */
-const dropboxErrorMessages = {
-    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) {
     return (React.createElement(SvgIcon, { ...props },
         React.createElement("path", { d: "M3 6.2L8 9.39L13 6.2L8 3L3 6.2M13 6.2L18 9.39L23 6.2L18 3L13 6.2M3 12.55L8 15.74L13 12.55L8 9.35L3 12.55M18 9.35L13 12.55L18 15.74L23 12.55L18 9.35M8.03 16.8L13.04 20L18.04 16.8L13.04 13.61L8.03 16.8Z" })));
 }
-async function getDescriptiveErrorMessage(response) {
-    let errorMessage;
-    try {
-        errorMessage = await response.text();
-    }
-    catch (error) {
-        errorMessage = '';
-    }
-    if (errorMessage) {
-        let errorMessageParsed;
-        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) => {
     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 React.createElement(DropboxIcon, null);
         },
+        /**
+         * #getter
+         */
         get selectorLabel() {
             return 'Enter Dropbox share link';
         },
     }))
         .actions(self => ({
+        /**
+         * #method
+         */
         getFetcher(location) {
             return async (input, init) => {
                 const authToken = await self.getToken(location);
@@ -61,12 +51,14 @@ const stateModelFactory = (configSchema) => {
                 newInit.headers.append('Dropbox-API-Arg', JSON.stringify({ url: input }));
                 const response = await fetch('https://content.dropboxapi.com/2/sharing/get_shared_link_file', 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, location) {
             const response = await fetch('https://api.dropboxapi.com/2/sharing/get_shared_link_metadata', {
                 method: 'POST',
@@ -79,18 +71,16 @@ const stateModelFactory = (configSchema) => {
                 }),
             });
             if (!response.ok) {
-                const refreshToken = self.hasRefreshToken && self.retrieveRefreshToken();
+                const refreshToken = self.retrieveRefreshToken();
                 if (refreshToken) {
                     self.removeRefreshToken();
                     const newToken = await self.exchangeRefreshForAccessToken(refreshToken);
                     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;
         },
     }));
 };
 export default stateModelFactory;
-//# sourceMappingURL=model.js.map

package/esm/DropboxOAuthModel/util.d.ts

@@ -0,0 +1 @@
+export declare function getDescriptiveErrorMessage(response: Response, reason?: string): Promise<string>;

package/esm/DropboxOAuthModel/util.js

@@ -0,0 +1,23 @@
+import { getResponseError } from '../util';
+/**
+ * Error messages from
+ * https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_shared_link_file
+ * */
+const dropboxErrorMessages = {
+    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, reason) {
+    let errorMessage = '';
+    try {
+        const err = JSON.parse(await response.text());
+        const tag = err.error['.tag'];
+        errorMessage = dropboxErrorMessages[tag] || tag;
+    }
+    catch (error) {
+        /* do nothing */
+    }
+    return getResponseError({ response, reason, statusText: errorMessage });
+}

package/esm/ExternalTokenModel/ExternalTokenEntryForm.d.ts

@@ -1,4 +1,5 @@
+import React from 'react';
 export declare const ExternalTokenEntryForm: ({ internetAccountId, handleClose, }: {
     internetAccountId: string;
     handleClose: (token?: string) => void;
-}) => JSX.Element;
+}) => React.JSX.Element;

package/esm/ExternalTokenModel/ExternalTokenEntryForm.js

@@ -3,16 +3,14 @@ import { Button, DialogContent, DialogActions, TextField } from '@mui/material';
 import { Dialog } from '@jbrowse/core/ui';
 export const ExternalTokenEntryForm = ({ internetAccountId, handleClose, }) => {
     const [token, setToken] = useState('');
-    return (React.createElement(React.Fragment, null,
-        React.createElement(Dialog, { open: true, maxWidth: "xl", "data-testid": "externalToken-form", title: `Enter token for ${internetAccountId}` },
-            React.createElement(DialogContent, { style: { display: 'flex', flexDirection: 'column' } },
-                React.createElement(TextField, { required: true, label: "Enter Token", variant: "outlined", inputProps: { 'data-testid': 'entry-externalToken' }, onChange: event => setToken(event.target.value), margin: "dense" })),
-            React.createElement(DialogActions, null,
-                React.createElement(Button, { variant: "contained", color: "primary", type: "submit", disabled: !token, onClick: () => {
-                        if (token) {
-                            handleClose(token);
-                        }
-                    } }, "Add"),
-                React.createElement(Button, { variant: "contained", color: "primary", onClick: () => handleClose() }, "Cancel")))));
+    return (React.createElement(Dialog, { open: true, maxWidth: "xl", "data-testid": "externalToken-form", title: `Enter token for ${internetAccountId}` },
+        React.createElement(DialogContent, { style: { display: 'flex', flexDirection: 'column' } },
+            React.createElement(TextField, { required: true, label: "Enter Token", variant: "outlined", inputProps: { 'data-testid': 'entry-externalToken' }, onChange: event => setToken(event.target.value), margin: "dense" })),
+        React.createElement(DialogActions, null,
+            React.createElement(Button, { variant: "contained", color: "primary", type: "submit", disabled: !token, onClick: () => {
+                    if (token) {
+                        handleClose(token);
+                    }
+                } }, "Add"),
+            React.createElement(Button, { variant: "contained", color: "secondary", onClick: () => handleClose() }, "Cancel"))));
 };
-//# sourceMappingURL=ExternalTokenEntryForm.js.map

package/esm/ExternalTokenModel/configSchema.js

@@ -21,4 +21,3 @@ const ExternalTokenConfigSchema = ConfigurationSchema('ExternalTokenInternetAcco
     explicitlyTyped: true,
 });
 export default ExternalTokenConfigSchema;
-//# sourceMappingURL=configSchema.js.map

package/esm/ExternalTokenModel/index.js

@@ -1,3 +1,2 @@
 export { default as configSchema } from './configSchema';
 export { default as modelFactory } from './model';
-//# sourceMappingURL=index.js.map

package/esm/ExternalTokenModel/model.js

@@ -54,4 +54,3 @@ const stateModelFactory = (configSchema) => {
     }));
 };
 export default stateModelFactory;
-//# sourceMappingURL=model.js.map

package/esm/GoogleDriveOAuthModel/GoogleDriveFilehandle.d.ts

@@ -0,0 +1,15 @@
+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 declare class GoogleDriveFile extends RemoteFileWithRangeCache {
+    private statsPromise;
+    constructor(source: string, opts: GoogleDriveFilehandleOptions);
+    fetch(input: RequestInfo, opts?: RequestInitWithMetadata): Promise<PolyfilledResponse>;
+    stat(): Promise<Stats>;
+}
+export {};

package/esm/GoogleDriveOAuthModel/GoogleDriveFilehandle.js

@@ -0,0 +1,15 @@
+import { RemoteFileWithRangeCache } from '@jbrowse/core/util/io';
+export class GoogleDriveFile extends RemoteFileWithRangeCache {
+    constructor(source, opts) {
+        super(source, opts);
+        this.statsPromise = this.fetch(source, {
+            metadataOnly: true,
+        }).then((response) => response.json());
+    }
+    async fetch(input, opts) {
+        return super.fetch(input, opts);
+    }
+    async stat() {
+        return this.statsPromise;
+    }
+}

package/esm/GoogleDriveOAuthModel/configSchema.d.ts

@@ -75,11 +75,6 @@ declare const GoogleDriveOAuthConfigSchema: import("@jbrowse/core/configuration/
         type: string;
         defaultValue: string;
     };
-    hasRefreshToken: {
-        description: string;
-        type: string;
-        defaultValue: boolean;
-    };
 }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
     name: {
         description: string;

package/esm/GoogleDriveOAuthModel/configSchema.js

@@ -45,4 +45,3 @@ const GoogleDriveOAuthConfigSchema = ConfigurationSchema('GoogleDriveOAuthIntern
     explicitlyTyped: true,
 });
 export default GoogleDriveOAuthConfigSchema;
-//# sourceMappingURL=configSchema.js.map

package/esm/GoogleDriveOAuthModel/index.js

@@ -1,3 +1,2 @@
 export { default as configSchema } from './configSchema';
 export { default as modelFactory } from './model';
-//# sourceMappingURL=index.js.map