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

package/esm/GoogleDriveOAuthModel/model.d.ts

@@ -5,197 +5,206 @@ import type { Instance } from '@jbrowse/mobx-state-tree';
 export interface RequestInitWithMetadata extends RequestInit {
     metadataOnly?: boolean;
 }
-export default function stateModelFactory(configSchema: GoogleDriveOAuthInternetAccountConfigModel): import("@jbrowse/mobx-state-tree").IModelType<{
+/**
+ * #stateModel GoogleDriveOAuthInternetAccount
+ */
+export default function stateModelFactory(configSchema: GoogleDriveOAuthInternetAccountConfigModel): 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<"GoogleDriveOAuthInternetAccount">;
-    configuration: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
-        authEndpoint: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        scopes: {
-            description: string;
-            type: string;
-            defaultValue: string;
-        };
-        domains: {
-            description: string;
-            type: string;
-            defaultValue: string[];
-        };
-        responseType: {
-            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<"GoogleDriveOAuthInternetAccount">;
+    /**
+     * #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://accounts.google.com/o/oauth2/v2/auth";
+        };
+        readonly scopes: {
+            readonly description: "optional scopes for the authorization call";
+            readonly type: "string";
+            readonly defaultValue: "https://www.googleapis.com/auth/drive.readonly";
+        };
+        readonly domains: {
+            readonly description: "array of valid domains the url can contain to use this account";
+            readonly type: "stringArray";
+            readonly defaultValue: readonly ["drive.google.com"];
+        };
+        readonly responseType: {
+            readonly description: "the type of response from the authorization endpoint";
+            readonly type: "string";
+            readonly defaultValue: "token";
         };
     }, 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;
@@ -204,22 +213,21 @@ export default function stateModelFactory(configSchema: GoogleDriveOAuthInternet
     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;
@@ -233,51 +241,71 @@ export default function stateModelFactory(configSchema: GoogleDriveOAuthInternet
         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 Google drive
+     */
+    readonly toggleContents: import("react").JSX.Element;
+    /**
+     * #getter
+     */
     readonly selectorLabel: string;
 } & {
+    /**
+     * #method
+     */
     getFetcher(location?: UriLocation): (input: RequestInfo, init?: RequestInitWithMetadata) => Promise<Response>;
-    openLocation(location: UriLocation): GoogleDriveFile;
+    /**
+     * #action
+     */
     validateToken(token: string, location: UriLocation): Promise<string>;
+} & {
+    /**
+     * #method
+     */
+    openLocation(location: UriLocation): GoogleDriveFile;
 }, import("@jbrowse/mobx-state-tree")._NotCustomized, import("@jbrowse/mobx-state-tree")._NotCustomized>;
 export type GoogleDriveOAuthStateModel = ReturnType<typeof stateModelFactory>;
 export type GoogleDriveOAuthModel = Instance<GoogleDriveOAuthStateModel>;

package/esm/GoogleDriveOAuthModel/model.js

@@ -1,35 +1,59 @@
 import { jsx as _jsx } from "react/jsx-runtime";
 import { ConfigurationReference } from '@jbrowse/core/configuration';
 import { types } from '@jbrowse/mobx-state-tree';
-import { GoogleDriveFile } from "./GoogleDriveFilehandle.js";
-import GoogleDriveIcon from "./GoogleDriveIcon.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 { GoogleDriveFile } from './GoogleDriveFilehandle.js';
+import GoogleDriveIcon from './GoogleDriveIcon.js';
+import { getDescriptiveErrorMessage } from './util.js';
 function getUri(str) {
-    const urlId = /[-\w]{25,}/.exec(str);
-    return `https://www.googleapis.com/drive/v3/files/${urlId}`;
+    const urlId = /\/d\/([-\w]{25,})/.exec(str);
+    if (!urlId) {
+        throw new Error(`Could not extract Google Drive file ID from URL: ${str}`);
+    }
+    return `https://www.googleapis.com/drive/v3/files/${urlId[1]}`;
 }
+/**
+ * #stateModel GoogleDriveOAuthInternetAccount
+ */
 export default function stateModelFactory(configSchema) {
     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 _jsx(GoogleDriveIcon, {});
         },
+        /**
+         * #getter
+         */
         get selectorLabel() {
             return 'Enter Google Drive share link';
         },
     }))
         .actions(self => ({
+        /**
+         * #method
+         */
         getFetcher(location) {
             return async (input, init) => {
                 const driveUrl = new URL(getUri(String(input)));
                 const searchParams = new URLSearchParams();
+                // metadataOnly: private flag used by GoogleDriveFile constructor to
+                // pre-fetch just the file size for stat() without downloading content
                 if (init?.metadataOnly) {
                     searchParams.append('fields', 'size');
                 }
@@ -37,30 +61,29 @@ export default function stateModelFactory(configSchema) {
                     searchParams.append('alt', 'media');
                 }
                 driveUrl.search = searchParams.toString();
-                const authToken = await self.getToken(location);
-                const response = await fetch(driveUrl, self.addAuthHeaderToInit({ ...init, method: 'GET', credentials: 'same-origin' }, authToken));
+                const response = await self.fetchWithToken(location, authToken => fetch(driveUrl, self.addAuthHeaderToInit({ ...init, method: 'GET', credentials: 'same-origin' }, authToken)));
                 if (!response.ok) {
                     throw new Error(await getDescriptiveErrorMessage(response));
                 }
                 return response;
             };
         },
+        /**
+         * #action
+         */
+        async validateToken(token, location) {
+            const uri = getUri(location.uri);
+            return self.validateTokenWithProbe(token, authToken => fetch(uri, { headers: { Authorization: `Bearer ${authToken}` } }), getDescriptiveErrorMessage);
+        },
+    }))
+        .actions(self => ({
+        /**
+         * #method
+         */
         openLocation(location) {
             return new GoogleDriveFile(location.uri, {
-                fetch: this.getFetcher(location),
-            });
-        },
-        async validateToken(token, location) {
-            const response = await fetch(getUri(location.uri), {
-                headers: {
-                    Authorization: `Bearer ${token}`,
-                    'Content-Type': 'application/x-www-form-urlencoded',
-                },
+                fetch: self.getFetcher(location),
             });
-            if (!response.ok) {
-                throw new Error(await getDescriptiveErrorMessage(response, 'Token could not be validated'));
-            }
-            return token;
         },
     }));
 }

package/esm/GoogleDriveOAuthModel/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/GoogleDriveOAuthModel/util.js

@@ -1,11 +1,2 @@
-import { getResponseError } from "../util.js";
-export async function getDescriptiveErrorMessage(response, reason) {
-    let errorMessage = '';
-    try {
-        const err = JSON.parse(await response.text());
-        errorMessage = err.error.message;
-    }
-    catch (error) {
-    }
-    return getResponseError({ response, reason, statusText: errorMessage });
-}
+import { descriptiveErrorMessage } from '../util.js';
+export const getDescriptiveErrorMessage = descriptiveErrorMessage(err => err.error.message);

package/esm/HTTPBasicModel/HTTPBasicLoginForm.d.ts

@@ -1,4 +1,4 @@
 export declare function HTTPBasicLoginForm({ internetAccountId, handleClose, }: {
     internetAccountId: string;
     handleClose: (arg?: string) => void;
-}): import("react/jsx-runtime").JSX.Element;
+}): import("react").JSX.Element;