@jbrowse/plugin-authentication 4.3.0 → 5.0.0-beta.1

package/esm/DropboxOAuthModel/model.d.ts

@@ -1,197 +1,206 @@
 import type { DropboxOAuthInternetAccountConfigModel } from './configSchema.ts';
 import type { UriLocation } from '@jbrowse/core/util/types';
 import type { Instance } from '@jbrowse/mobx-state-tree';
-declare const stateModelFactory: (configSchema: DropboxOAuthInternetAccountConfigModel) => import("@jbrowse/mobx-state-tree").IModelType<{
+/**
+ * #stateModel DropboxOAuthInternetAccount
+ */
+declare const stateModelFactory: (configSchema: DropboxOAuthInternetAccountConfigModel) => import("@jbrowse/mobx-state-tree").IModelType<Omit<Omit<{
     id: import("@jbrowse/mobx-state-tree").IOptionalIType<import("@jbrowse/mobx-state-tree").ISimpleType<string>, [undefined]>;
     type: import("@jbrowse/mobx-state-tree").ISimpleType<string>;
-    configuration: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
-        name: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        description: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        authHeader: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        tokenType: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        domains: {
-            description: string;
-            type: string;
-            defaultValue: never[];
-        };
-    }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, "internetAccountId">>;
-} & {
-    type: import("@jbrowse/mobx-state-tree").ISimpleType<"OAuthInternetAccount">;
-    configuration: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
-        tokenType: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        authEndpoint: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        tokenEndpoint: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        needsPKCE: {
-            description: string;
-            type: string;
-            defaultValue: boolean;
-        };
-        clientId: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        scopes: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        state: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        responseType: {
-            description: string;
-            type: string;
-            defaultValue: string;
+    configuration: import("@jbrowse/core/configuration/configurationSchema").IConfigurationReference<import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
+        readonly name: {
+            readonly description: "descriptive name of the internet account";
+            readonly type: "string";
+            readonly defaultValue: "";
+        };
+        readonly description: {
+            readonly description: "a description of the internet account";
+            readonly type: "string";
+            readonly defaultValue: "";
+        };
+        readonly authHeader: {
+            readonly description: "request header for credentials";
+            readonly type: "string";
+            readonly defaultValue: "Authorization";
+        };
+        readonly tokenType: {
+            readonly description: "a custom name for a token to include in the header";
+            readonly type: "string";
+            readonly defaultValue: "";
+        };
+        readonly domains: {
+            readonly description: "array of valid domains the url can contain to use this account";
+            readonly type: "stringArray";
+            readonly defaultValue: readonly [];
+        };
+    }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, "internetAccountId">>>;
+}, "configuration" | "type"> & {
+    type: import("@jbrowse/mobx-state-tree").ILiteralType<"OAuthInternetAccount">;
+    configuration: import("@jbrowse/core/configuration/configurationSchema").IConfigurationReference<import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
+        readonly tokenType: {
+            readonly description: "a custom name for a token to include in the header";
+            readonly type: "string";
+            readonly defaultValue: "Bearer";
+        };
+        readonly authEndpoint: {
+            readonly description: "the authorization code endpoint of the internet account";
+            readonly type: "string";
+            readonly defaultValue: "";
+        };
+        readonly tokenEndpoint: {
+            readonly description: "the token endpoint of the internet account";
+            readonly type: "string";
+            readonly defaultValue: "";
+        };
+        readonly needsPKCE: {
+            readonly description: "boolean to indicate if the endpoint needs a PKCE code";
+            readonly type: "boolean";
+            readonly defaultValue: false;
+        };
+        readonly clientId: {
+            readonly description: "id for the OAuth application";
+            readonly type: "string";
+            readonly defaultValue: "";
+        };
+        readonly scopes: {
+            readonly description: "optional scopes for the authorization call";
+            readonly type: "string";
+            readonly defaultValue: "";
+        };
+        readonly state: {
+            readonly description: "optional state for the authorization call";
+            readonly type: "string";
+            readonly defaultValue: "";
+        };
+        readonly responseType: {
+            readonly description: "the type of response from the authorization endpoint. can be 'token' or 'code'";
+            readonly type: "string";
+            readonly defaultValue: "code";
         };
     }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
-        name: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        description: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        authHeader: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        tokenType: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        domains: {
-            description: string;
-            type: string;
-            defaultValue: never[];
-        };
-    }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, "internetAccountId">>, undefined>>;
-} & {
-    type: import("@jbrowse/mobx-state-tree").ISimpleType<"DropboxOAuthInternetAccount">;
-    configuration: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
-        authEndpoint: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        tokenEndpoint: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        needsPKCE: {
-            description: string;
-            type: string;
-            defaultValue: boolean;
-        };
-        domains: {
-            description: string;
-            type: string;
-            defaultValue: string[];
+        readonly name: {
+            readonly description: "descriptive name of the internet account";
+            readonly type: "string";
+            readonly defaultValue: "";
+        };
+        readonly description: {
+            readonly description: "a description of the internet account";
+            readonly type: "string";
+            readonly defaultValue: "";
+        };
+        readonly authHeader: {
+            readonly description: "request header for credentials";
+            readonly type: "string";
+            readonly defaultValue: "Authorization";
+        };
+        readonly tokenType: {
+            readonly description: "a custom name for a token to include in the header";
+            readonly type: "string";
+            readonly defaultValue: "";
+        };
+        readonly domains: {
+            readonly description: "array of valid domains the url can contain to use this account";
+            readonly type: "stringArray";
+            readonly defaultValue: readonly [];
+        };
+    }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, "internetAccountId">>, undefined>>>;
+}, "configuration" | "type"> & {
+    /**
+     * #property
+     */
+    type: import("@jbrowse/mobx-state-tree").ILiteralType<"DropboxOAuthInternetAccount">;
+    /**
+     * #property
+     */
+    configuration: import("@jbrowse/core/configuration/configurationSchema").IConfigurationReference<import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
+        readonly authEndpoint: {
+            readonly description: "the authorization code endpoint of the internet account";
+            readonly type: "string";
+            readonly defaultValue: "https://www.dropbox.com/oauth2/authorize";
+        };
+        readonly tokenEndpoint: {
+            readonly description: "the token endpoint of the internet account";
+            readonly type: "string";
+            readonly defaultValue: "https://api.dropbox.com/oauth2/token";
+        };
+        readonly needsPKCE: {
+            readonly description: "boolean to indicate if the endpoint needs a PKCE code";
+            readonly type: "boolean";
+            readonly defaultValue: true;
+        };
+        readonly domains: {
+            readonly description: "array of valid domains the url can contain to use this account";
+            readonly type: "stringArray";
+            readonly defaultValue: readonly ["addtodropbox.com", "db.tt", "dropbox.com", "dropboxapi.com", "dropboxbusiness.com", "dropbox.tech", "getdropbox.com"];
         };
     }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
-        tokenType: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        authEndpoint: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        tokenEndpoint: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        needsPKCE: {
-            description: string;
-            type: string;
-            defaultValue: boolean;
-        };
-        clientId: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        scopes: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        state: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        responseType: {
-            description: string;
-            type: string;
-            defaultValue: string;
+        readonly tokenType: {
+            readonly description: "a custom name for a token to include in the header";
+            readonly type: "string";
+            readonly defaultValue: "Bearer";
+        };
+        readonly authEndpoint: {
+            readonly description: "the authorization code endpoint of the internet account";
+            readonly type: "string";
+            readonly defaultValue: "";
+        };
+        readonly tokenEndpoint: {
+            readonly description: "the token endpoint of the internet account";
+            readonly type: "string";
+            readonly defaultValue: "";
+        };
+        readonly needsPKCE: {
+            readonly description: "boolean to indicate if the endpoint needs a PKCE code";
+            readonly type: "boolean";
+            readonly defaultValue: false;
+        };
+        readonly clientId: {
+            readonly description: "id for the OAuth application";
+            readonly type: "string";
+            readonly defaultValue: "";
+        };
+        readonly scopes: {
+            readonly description: "optional scopes for the authorization call";
+            readonly type: "string";
+            readonly defaultValue: "";
+        };
+        readonly state: {
+            readonly description: "optional state for the authorization call";
+            readonly type: "string";
+            readonly defaultValue: "";
+        };
+        readonly responseType: {
+            readonly description: "the type of response from the authorization endpoint. can be 'token' or 'code'";
+            readonly type: "string";
+            readonly defaultValue: "code";
         };
     }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
-        name: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        description: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        authHeader: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        tokenType: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        domains: {
-            description: string;
-            type: string;
-            defaultValue: never[];
-        };
-    }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, "internetAccountId">>, undefined>>, undefined>>;
+        readonly name: {
+            readonly description: "descriptive name of the internet account";
+            readonly type: "string";
+            readonly defaultValue: "";
+        };
+        readonly description: {
+            readonly description: "a description of the internet account";
+            readonly type: "string";
+            readonly defaultValue: "";
+        };
+        readonly authHeader: {
+            readonly description: "request header for credentials";
+            readonly type: "string";
+            readonly defaultValue: "Authorization";
+        };
+        readonly tokenType: {
+            readonly description: "a custom name for a token to include in the header";
+            readonly type: "string";
+            readonly defaultValue: "";
+        };
+        readonly domains: {
+            readonly description: "array of valid domains the url can contain to use this account";
+            readonly type: "stringArray";
+            readonly defaultValue: readonly [];
+        };
+    }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, "internetAccountId">>, undefined>>, undefined>>>;
 }, {
     readonly name: string;
     readonly description: string;
@@ -200,22 +209,21 @@ declare const stateModelFactory: (configSchema: DropboxOAuthInternetAccountConfi
     readonly tokenType: string;
     readonly domains: string[];
     readonly toggleContents: React.ReactNode;
-    readonly SelectorComponent: import("@jbrowse/core/util").AnyReactComponentType | undefined;
     readonly selectorLabel: string | undefined;
+    readonly showInFileSelector: boolean;
 } & {
     handlesLocation(location: UriLocation): boolean;
     readonly tokenKey: string;
 } & {
     getTokenFromUser(_resolve: (token: string) => void, _reject: (error: Error) => void): void;
     storeToken(token: string): void;
-    removeToken(): void;
-    retrieveToken(): string | null;
+    retrieveToken(): string | undefined;
     validateToken(token: string, _loc: UriLocation): Promise<string>;
 } & {
+    removeToken(): void;
     getToken(location?: UriLocation): Promise<string>;
 } & {
     addAuthHeaderToInit(init?: RequestInit, token?: string): {
-        headers: Headers;
         body?: BodyInit | null;
         cache?: RequestCache;
         credentials?: RequestCredentials;
@@ -229,49 +237,75 @@ declare const stateModelFactory: (configSchema: DropboxOAuthInternetAccountConfi
         referrerPolicy?: ReferrerPolicy;
         signal?: AbortSignal | null;
         window?: null;
+        headers: Headers;
     };
+    fetchWithToken(loc: UriLocation | undefined, run: (token: string) => Promise<Response>): Promise<Response>;
     getPreAuthorizationInformation(location: UriLocation): Promise<{
         internetAccountType: string;
         authInfo: {
             token: string;
-            configuration: any;
+            configuration: import("@jbrowse/mobx-state-tree").ModelSnapshotType<Record<string, any>>;
         };
     }>;
 } & {
     getFetcher(loc?: UriLocation): (input: RequestInfo, init?: RequestInit) => Promise<Response>;
 } & {
-    openLocation(location: UriLocation): import("@jbrowse/core/util/io").RemoteFileWithRangeCache;
+    openLocation(location: UriLocation): import("@gmod/range-cache-filehandle").RemoteFileWithRangeCache;
 } & {
-    readonly codeVerifierPKCE: string;
+    readonly conf: import("../OAuthModel/configSchema.ts").OAuthInternetAccountConfig;
 } & {
     readonly authEndpoint: string;
     readonly tokenEndpoint: string;
     readonly needsPKCE: boolean;
     readonly clientId: string;
     readonly scopes: string;
-    state(): string | undefined;
-    readonly responseType: "token" | "code";
+    readonly state: string;
+    readonly responseType: 'token' | 'code';
     readonly refreshTokenKey: string;
+    readonly authFlowParams: Record<string, string>;
 } & {
     storeRefreshToken(refreshToken: string): void;
     removeRefreshToken(): void;
-    retrieveRefreshToken(): string | null;
-    exchangeAuthorizationForAccessToken(token: string, redirectUri: string): Promise<string>;
+    retrieveRefreshToken(): string | undefined;
+} & {
+    postTokenGrant(grant: Record<string, string>, describeError: (response: Response) => Promise<string>): Promise<string>;
+} & {
+    exchangeAuthorizationForAccessToken(code: string, redirectUri: string, codeVerifier: string | undefined): Promise<string>;
     exchangeRefreshForAccessToken(refreshToken: string): Promise<string>;
 } & {
-    addMessageChannel(resolve: (token: string) => void, reject: (error: Error) => void): void;
-    deleteMessageChannel(): void;
-    finishOAuthWindow(event: MessageEvent, resolve: (token: string) => void, reject: (error: Error) => void): Promise<void>;
-    useEndpointForAuthorization(resolve: (token: string) => void, reject: (error: Error) => void): Promise<void>;
+    validateTokenWithProbe(token: string, probe: (token: string) => Promise<Response>, describeError: (response: Response, reason?: string) => Promise<string>): Promise<string>;
+    getTokenViaAuthFlow(): Promise<string>;
+} & {
     getTokenFromUser(resolve: (token: string) => void, reject: (error: Error) => void): Promise<void>;
     validateToken(token: string, location: UriLocation): Promise<string>;
 } & {
-    getFetcher(loc?: UriLocation): (input: RequestInfo, init?: RequestInit) => Promise<Response>;
-} & {
-    readonly toggleContents: import("react/jsx-runtime").JSX.Element;
+    /**
+     * #getter
+     * The FileSelector icon for Dropbox
+     */
+    readonly toggleContents: import("react").JSX.Element;
+    /**
+     * #getter
+     */
     readonly selectorLabel: string;
+    /**
+     * #getter
+     * Dropbox issues a refresh token only when the authorization request
+     * asks for offline access, and spells that `token_access_type` where
+     * other providers use `access_type` — so it belongs here rather than on
+     * every OAuth account.
+     */
+    readonly authFlowParams: {
+        token_access_type: string;
+    };
 } & {
+    /**
+     * #method
+     */
     getFetcher(location?: UriLocation): (input: RequestInfo, init?: RequestInit) => Promise<Response>;
+    /**
+     * #action
+     */
     validateToken(token: string, location: UriLocation): Promise<string>;
 }, import("@jbrowse/mobx-state-tree")._NotCustomized, import("@jbrowse/mobx-state-tree")._NotCustomized>;
 export default stateModelFactory;

package/esm/DropboxOAuthModel/model.js

@@ -1,59 +1,84 @@
 import { jsx as _jsx } from "react/jsx-runtime";
 import { ConfigurationReference } from '@jbrowse/core/configuration';
 import { types } from '@jbrowse/mobx-state-tree';
-import DropboxIcon from "./DropboxIcon.js";
-import { getDescriptiveErrorMessage } from "./util.js";
-import { configSchema as OAuthConfigSchema } from "../OAuthModel/index.js";
-import baseModel from "../OAuthModel/model.js";
+import { configSchema as OAuthConfigSchema } from '../OAuthModel/index.js';
+import baseModel from '../OAuthModel/model.js';
+import DropboxIcon from './DropboxIcon.js';
+import { getDescriptiveErrorMessage } from './util.js';
+/**
+ * #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 _jsx(DropboxIcon, {});
         },
+        /**
+         * #getter
+         */
         get selectorLabel() {
             return 'Enter Dropbox share link';
         },
+        /**
+         * #getter
+         * Dropbox issues a refresh token only when the authorization request
+         * asks for offline access, and spells that `token_access_type` where
+         * other providers use `access_type` — so it belongs here rather than on
+         * every OAuth account.
+         */
+        get authFlowParams() {
+            return { token_access_type: 'offline' };
+        },
     }))
         .actions(self => ({
+        /**
+         * #method
+         */
         getFetcher(location) {
             return async (input, init) => {
-                const authToken = await self.getToken(location);
-                const newInit = self.addAuthHeaderToInit({ ...init, method: 'POST' }, authToken);
-                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);
+                const response = await self.fetchWithToken(location, authToken => {
+                    // built per attempt: the Headers are appended to below, so a retry
+                    // reusing them would send two Dropbox-API-Arg values
+                    const newInit = self.addAuthHeaderToInit({ ...init, method: 'POST' }, authToken);
+                    newInit.headers.append('Dropbox-API-Arg', JSON.stringify({ url: input }));
+                    return fetch('https://content.dropboxapi.com/2/sharing/get_shared_link_file', newInit);
+                });
                 if (!response.ok) {
                     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', {
+            return self.validateTokenWithProbe(token, authToken => fetch('https://api.dropboxapi.com/2/sharing/get_shared_link_metadata', {
                 method: 'POST',
                 headers: {
-                    Authorization: `Bearer ${token}`,
+                    Authorization: `Bearer ${authToken}`,
                     'Content-Type': 'application/json',
                 },
                 body: JSON.stringify({
                     url: location.uri,
                 }),
-            });
-            if (!response.ok) {
-                const refreshToken = self.retrieveRefreshToken();
-                if (refreshToken) {
-                    self.removeRefreshToken();
-                    const newToken = await self.exchangeRefreshForAccessToken(refreshToken);
-                    return this.validateToken(newToken, location);
-                }
-                throw new Error(await getDescriptiveErrorMessage(response, 'Token could not be validated'));
-            }
-            return token;
+            }), getDescriptiveErrorMessage);
         },
     }));
 };

package/esm/DropboxOAuthModel/util.d.ts

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

package/esm/DropboxOAuthModel/util.js

@@ -1,18 +1,15 @@
-import { getResponseError } from "../util.js";
+import { descriptiveErrorMessage } from '../util.js';
+/**
+ * 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) {
-    }
-    return getResponseError({ response, reason, statusText: errorMessage });
-}
+export const getDescriptiveErrorMessage = descriptiveErrorMessage(err => {
+    const tag = err.error['.tag'];
+    return dropboxErrorMessages[tag] ?? tag;
+});