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

package/esm/GoogleDriveOAuthModel/model.d.ts

@@ -5,197 +5,346 @@ 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;
+    configuration: import("@jbrowse/core/configuration/configurationSchema").IConfigurationReference<import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
+        readonly name: {
+            type: "string";
+        } & {
             defaultValue: string;
         };
-        description: {
-            description: string;
-            type: string;
+        readonly description: {
+            type: "string";
+        } & {
             defaultValue: string;
         };
-        authHeader: {
-            description: string;
-            type: string;
+        readonly authHeader: {
+            type: "string";
+        } & {
             defaultValue: string;
         };
-        tokenType: {
-            description: string;
-            type: string;
+        readonly tokenType: {
+            type: "string";
+        } & {
             defaultValue: string;
         };
-        domains: {
-            description: string;
-            type: string;
-            defaultValue: never[];
+        readonly domains: {
+            type: "stringArray";
+        } & {
+            defaultValue: unknown;
         };
-    }, 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;
+        type: {
+            type: "string";
+        } & {
             defaultValue: string;
         };
+        internetAccountId: {
+            type: "string";
+        } & {
+            defaultValue: string;
+        };
+    }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, "internetAccountId", true, import("@jbrowse/core/configuration").ConfigurationSchemaRequirement<Partial<Record<string, string[]>>, string>, any>>>;
+}, "configuration" | "type"> & {
+    type: import("@jbrowse/mobx-state-tree").ILiteralType<"OAuthInternetAccount">;
+    configuration: import("@jbrowse/core/configuration/configurationSchema").IConfigurationReference<import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
         authEndpoint: {
-            description: string;
-            type: string;
+            type: "string";
+        } & {
             defaultValue: string;
         };
-        tokenEndpoint: {
-            description: string;
-            type: string;
+        authHeader: {
+            type: "string";
+        } & {
+            defaultValue: string;
+        };
+        clientId: {
+            type: "string";
+        } & {
+            defaultValue: string;
+        };
+        description: {
+            type: "string";
+        } & {
+            defaultValue: string;
+        };
+        domains: {
+            type: "stringArray";
+        } & {
+            defaultValue: unknown;
+        };
+        internetAccountId: {
+            type: "string";
+        } & {
+            defaultValue: string;
+        };
+        name: {
+            type: "string";
+        } & {
             defaultValue: string;
         };
         needsPKCE: {
-            description: string;
-            type: string;
+            type: "boolean";
+        } & {
             defaultValue: boolean;
         };
-        clientId: {
-            description: string;
-            type: string;
+        responseType: {
+            type: "string";
+        } & {
             defaultValue: string;
         };
         scopes: {
-            description: string;
-            type: string;
+            type: "string";
+        } & {
             defaultValue: string;
         };
         state: {
-            description: string;
-            type: string;
+            type: "string";
+        } & {
             defaultValue: string;
         };
-        responseType: {
-            description: string;
-            type: string;
+        tokenEndpoint: {
+            type: "string";
+        } & {
+            defaultValue: string;
+        };
+        tokenType: {
+            type: "string";
+        } & {
+            defaultValue: string;
+        };
+        type: {
+            type: "string";
+        } & {
             defaultValue: string;
         };
     }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
-        name: {
-            description: string;
-            type: string;
+        readonly name: {
+            type: "string";
+        } & {
             defaultValue: string;
         };
-        description: {
-            description: string;
-            type: string;
+        readonly description: {
+            type: "string";
+        } & {
             defaultValue: string;
         };
-        authHeader: {
-            description: string;
-            type: string;
+        readonly authHeader: {
+            type: "string";
+        } & {
             defaultValue: string;
         };
-        tokenType: {
-            description: string;
-            type: string;
+        readonly tokenType: {
+            type: "string";
+        } & {
             defaultValue: string;
         };
-        domains: {
-            description: string;
-            type: string;
-            defaultValue: never[];
+        readonly domains: {
+            type: "stringArray";
+        } & {
+            defaultValue: unknown;
         };
-    }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, "internetAccountId">>, undefined>>;
-} & {
-    type: import("@jbrowse/mobx-state-tree").ISimpleType<"GoogleDriveOAuthInternetAccount">;
-    configuration: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
+        type: {
+            type: "string";
+        } & {
+            defaultValue: string;
+        };
+        internetAccountId: {
+            type: "string";
+        } & {
+            defaultValue: string;
+        };
+    }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, "internetAccountId", true, import("@jbrowse/core/configuration").ConfigurationSchemaRequirement<Partial<Record<string, string[]>>, string>, any>>, undefined, true, import("@jbrowse/core/configuration").ConfigurationSchemaRequirement<Partial<Record<string, string[]>>, string>, any>>>;
+}, "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<{
         authEndpoint: {
-            description: string;
-            type: string;
+            type: "string";
+        } & {
             defaultValue: string;
         };
-        scopes: {
-            description: string;
-            type: string;
+        authHeader: {
+            type: "string";
+        } & {
+            defaultValue: string;
+        };
+        clientId: {
+            type: "string";
+        } & {
+            defaultValue: string;
+        };
+        description: {
+            type: "string";
+        } & {
             defaultValue: string;
         };
         domains: {
-            description: string;
-            type: string;
-            defaultValue: string[];
+            type: "stringArray";
+        } & {
+            defaultValue: unknown;
+        };
+        internetAccountId: {
+            type: "string";
+        } & {
+            defaultValue: string;
+        };
+        name: {
+            type: "string";
+        } & {
+            defaultValue: string;
+        };
+        needsPKCE: {
+            type: "boolean";
+        } & {
+            defaultValue: boolean;
         };
         responseType: {
-            description: string;
-            type: string;
+            type: "string";
+        } & {
+            defaultValue: string;
+        };
+        scopes: {
+            type: "string";
+        } & {
+            defaultValue: string;
+        };
+        state: {
+            type: "string";
+        } & {
+            defaultValue: string;
+        };
+        tokenEndpoint: {
+            type: "string";
+        } & {
             defaultValue: string;
         };
-    }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
         tokenType: {
-            description: string;
-            type: string;
+            type: "string";
+        } & {
+            defaultValue: string;
+        };
+        type: {
+            type: "string";
+        } & {
             defaultValue: string;
         };
+    }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
         authEndpoint: {
-            description: string;
-            type: string;
+            type: "string";
+        } & {
             defaultValue: string;
         };
-        tokenEndpoint: {
-            description: string;
-            type: string;
+        authHeader: {
+            type: "string";
+        } & {
+            defaultValue: string;
+        };
+        clientId: {
+            type: "string";
+        } & {
+            defaultValue: string;
+        };
+        description: {
+            type: "string";
+        } & {
+            defaultValue: string;
+        };
+        domains: {
+            type: "stringArray";
+        } & {
+            defaultValue: unknown;
+        };
+        internetAccountId: {
+            type: "string";
+        } & {
+            defaultValue: string;
+        };
+        name: {
+            type: "string";
+        } & {
             defaultValue: string;
         };
         needsPKCE: {
-            description: string;
-            type: string;
+            type: "boolean";
+        } & {
             defaultValue: boolean;
         };
-        clientId: {
-            description: string;
-            type: string;
+        responseType: {
+            type: "string";
+        } & {
             defaultValue: string;
         };
         scopes: {
-            description: string;
-            type: string;
+            type: "string";
+        } & {
             defaultValue: string;
         };
         state: {
-            description: string;
-            type: string;
+            type: "string";
+        } & {
             defaultValue: string;
         };
-        responseType: {
-            description: string;
-            type: string;
+        tokenEndpoint: {
+            type: "string";
+        } & {
+            defaultValue: string;
+        };
+        tokenType: {
+            type: "string";
+        } & {
+            defaultValue: string;
+        };
+        type: {
+            type: "string";
+        } & {
             defaultValue: string;
         };
     }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
-        name: {
-            description: string;
-            type: string;
+        readonly name: {
+            type: "string";
+        } & {
             defaultValue: string;
         };
-        description: {
-            description: string;
-            type: string;
+        readonly description: {
+            type: "string";
+        } & {
             defaultValue: string;
         };
-        authHeader: {
-            description: string;
-            type: string;
+        readonly authHeader: {
+            type: "string";
+        } & {
             defaultValue: string;
         };
-        tokenType: {
-            description: string;
-            type: string;
+        readonly tokenType: {
+            type: "string";
+        } & {
             defaultValue: string;
         };
-        domains: {
-            description: string;
-            type: string;
-            defaultValue: never[];
+        readonly domains: {
+            type: "stringArray";
+        } & {
+            defaultValue: unknown;
+        };
+        type: {
+            type: "string";
+        } & {
+            defaultValue: string;
         };
-    }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, "internetAccountId">>, undefined>>, undefined>>;
+        internetAccountId: {
+            type: "string";
+        } & {
+            defaultValue: string;
+        };
+    }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, "internetAccountId", true, import("@jbrowse/core/configuration").ConfigurationSchemaRequirement<Partial<Record<string, string[]>>, string>, any>>, undefined, true, import("@jbrowse/core/configuration").ConfigurationSchemaRequirement<Partial<Record<string, string[]>>, string>, any>>, undefined, true, import("@jbrowse/core/configuration").ConfigurationSchemaRequirement<Partial<Record<string, string[]>>, string>, any>>>;
 }, {
     readonly name: string;
     readonly description: string;
@@ -204,22 +353,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 +381,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: string;
     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>;