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

package/esm/OAuthModel/configSchema.js

@@ -1,48 +1,77 @@
 import { ConfigurationSchema } from '@jbrowse/core/configuration';
 import { BaseInternetAccountConfig } from '@jbrowse/core/pluggableElementTypes/models';
-function x() { }
+/**
+ * #config OAuthInternetAccount
+ */
 const OAuthConfigSchema = ConfigurationSchema('OAuthInternetAccount', {
+    /**
+     * #slot
+     */
     tokenType: {
         description: 'a custom name for a token to include in the header',
         type: 'string',
         defaultValue: 'Bearer',
     },
+    /**
+     * #slot
+     */
     authEndpoint: {
         description: 'the authorization code endpoint of the internet account',
         type: 'string',
         defaultValue: '',
     },
+    /**
+     * #slot
+     */
     tokenEndpoint: {
         description: 'the token endpoint of the internet account',
         type: 'string',
         defaultValue: '',
     },
+    /**
+     * #slot
+     */
     needsPKCE: {
         description: 'boolean to indicate if the endpoint needs a PKCE code',
         type: 'boolean',
         defaultValue: false,
     },
+    /**
+     * #slot
+     */
     clientId: {
         description: 'id for the OAuth application',
         type: 'string',
         defaultValue: '',
     },
+    /**
+     * #slot
+     */
     scopes: {
         description: 'optional scopes for the authorization call',
         type: 'string',
         defaultValue: '',
     },
+    /**
+     * #slot
+     */
     state: {
         description: 'optional state for the authorization call',
         type: 'string',
         defaultValue: '',
     },
+    /**
+     * #slot
+     */
     responseType: {
         description: "the type of response from the authorization endpoint. can be 'token' or 'code'",
         type: 'string',
         defaultValue: 'code',
     },
 }, {
+    /**
+     * #baseConfiguration
+     */
     baseConfiguration: BaseInternetAccountConfig,
     explicitlyTyped: true,
 });

package/esm/OAuthModel/index.js

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

package/esm/OAuthModel/model.d.ts

@@ -1,106 +1,115 @@
-import type { OAuthInternetAccountConfigModel } from './configSchema.ts';
+import type { OAuthInternetAccountConfig, OAuthInternetAccountConfigModel } from './configSchema.ts';
 import type { UriLocation } from '@jbrowse/core/util';
 import type { Instance } from '@jbrowse/mobx-state-tree';
-declare const stateModelFactory: (configSchema: OAuthInternetAccountConfigModel) => import("@jbrowse/mobx-state-tree").IModelType<{
+/**
+ * #stateModel OAuthInternetAccount
+ */
+declare const stateModelFactory: (configSchema: OAuthInternetAccountConfigModel) => import("@jbrowse/mobx-state-tree").IModelType<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"> & {
+    /**
+     * #property
+     */
+    type: import("@jbrowse/mobx-state-tree").ILiteralType<"OAuthInternetAccount">;
+    /**
+     * #property
+     */
+    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>>;
+        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>>>;
 }, {
     readonly name: string;
     readonly description: string;
@@ -109,22 +118,21 @@ declare const stateModelFactory: (configSchema: OAuthInternetAccountConfigModel)
     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;
@@ -138,44 +146,140 @@ declare const stateModelFactory: (configSchema: OAuthInternetAccountConfigModel)
         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;
+    /**
+     * #getter
+     * The config typed off the concrete schema. `ConfigurationReference`
+     * erases `self.configuration` to `any` (the reference's MST instance brand
+     * doesn't carry the schema's slot definitions), so reads go through this
+     * getter to recover per-slot types and slot-name validation.
+     */
+    readonly conf: OAuthInternetAccountConfig;
 } & {
+    /**
+     * #getter
+     */
     readonly authEndpoint: string;
+    /**
+     * #getter
+     */
     readonly tokenEndpoint: string;
+    /**
+     * #getter
+     */
     readonly needsPKCE: boolean;
+    /**
+     * #getter
+     */
     readonly clientId: string;
+    /**
+     * #getter
+     */
     readonly scopes: string;
-    state(): string | undefined;
-    readonly responseType: "token" | "code";
+    /**
+     * #getter
+     * OAuth state parameter:
+     * https://www.rfc-editor.org/rfc/rfc6749#section-4.1.1
+     *
+     * Can override or extend if dynamic state is needed.
+     */
+    readonly state: string;
+    /**
+     * #getter
+     */
+    readonly responseType: 'token' | 'code';
+    /**
+     * #getter
+     */
     readonly refreshTokenKey: string;
+    /**
+     * #getter
+     * Extra parameters to add to the authorization request. Empty here;
+     * a provider that needs one of its own overrides this.
+     */
+    readonly authFlowParams: Record<string, string>;
 } & {
+    /**
+     * #action
+     */
     storeRefreshToken(refreshToken: string): void;
+    /**
+     * #action
+     */
     removeRefreshToken(): void;
-    retrieveRefreshToken(): string | null;
-    exchangeAuthorizationForAccessToken(token: string, redirectUri: string): Promise<string>;
+    /**
+     * #method
+     */
+    retrieveRefreshToken(): string | undefined;
+} & {
+    /**
+     * #action
+     * POST a grant to the token endpoint and read the access token out of the
+     * answer. Both grants this account makes — trading the authorization code
+     * on the way in, trading the refresh token when the access token expires
+     * — are the same form-encoded request to the same endpoint answered by
+     * the same body, and OAuth 2 says so (RFC 6749 §4.1.3, §6). They differ
+     * in the grant's own parameters and in what a failure means, which is
+     * what stays at the call sites.
+     *
+     * @param grant - the grant-specific parameters; `client_id` is added
+     * @param describeError - turns a failed exchange into a message, and is
+     * where a grant does whatever invalidating its failure implies
+     */
+    postTokenGrant(grant: Record<string, string>, describeError: (response: Response) => Promise<string>): Promise<string>;
+} & {
+    /**
+     * #action
+     */
+    exchangeAuthorizationForAccessToken(code: string, redirectUri: string, codeVerifier: string | undefined): Promise<string>;
+    /**
+     * #action
+     */
     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>;
+    /**
+     * #action
+     * Prove a token against the resource and, if that fails, refresh it once
+     * and prove the new one. Returns whichever token worked; throws if
+     * neither does. Every OAuth account validates this way and they differ
+     * only in what a probe is — a HEAD of the resource here, a metadata call
+     * for Dropbox and Google Drive.
+     *
+     * @param token - the token to prove
+     * @param probe - issues a request that succeeds iff the token is good
+     * @param describeError - turns a failed probe into a message
+     */
+    validateTokenWithProbe(token: string, probe: (token: string) => Promise<Response>, describeError: (response: Response, reason?: string) => Promise<string>): Promise<string>;
+    /**
+     * #action
+     * Opens the provider's auth page and returns a promise for the resulting
+     * token. For Electron, drives the flow directly via IPC; for web, opens a
+     * popup and waits for the redirect message.
+     */
+    getTokenViaAuthFlow(): Promise<string>;
+} & {
+    /**
+     * #action
+     */
     getTokenFromUser(resolve: (token: string) => void, reject: (error: Error) => void): Promise<void>;
+    /**
+     * #action
+     */
     validateToken(token: string, location: UriLocation): Promise<string>;
-} & {
-    getFetcher(loc?: UriLocation): (input: RequestInfo, init?: RequestInit) => Promise<Response>;
 }, import("@jbrowse/mobx-state-tree")._NotCustomized, import("@jbrowse/mobx-state-tree")._NotCustomized>;
 export default stateModelFactory;
 export type OAuthStateModel = ReturnType<typeof stateModelFactory>;