@jbrowse/plugin-authentication 2.4.2 → 2.6.1

package/dist/OAuthModel/configSchema.js

@@ -67,18 +67,10 @@ const OAuthConfigSchema = (0, configuration_1.ConfigurationSchema)('OAuthInterne
      * #slot
      */
     responseType: {
-        description: 'the type of response from the authorization endpoint',
+        description: "the type of response from the authorization endpoint. can be 'token' or 'code'",
         type: 'string',
         defaultValue: 'code',
     },
-    /**
-     * #slot
-     */
-    hasRefreshToken: {
-        description: 'true if the endpoint can supply a refresh token',
-        type: 'boolean',
-        defaultValue: false,
-    },
 }, {
     /**
      * #baseConfiguration

package/dist/OAuthModel/configSchema.js.map

@@ -1 +1 @@
-{"version":3,"file":"configSchema.js","sourceRoot":"","sources":["../../src/OAuthModel/configSchema.ts"],"names":[],"mappings":";;AAAA,+DAAiE;AAEjE,uEAAsF;AAEtF;;GAEG;AACH,SAAS,CAAC,KAAI,CAAC,CAAC,wDAAwD;AAExE,MAAM,iBAAiB,GAAG,IAAA,mCAAmB,EAC3C,sBAAsB,EACtB;IACE;;OAEG;IACH,SAAS,EAAE;QACT,WAAW,EAAE,oDAAoD;QACjE,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,QAAQ;KACvB;IACD;;OAEG;IACH,YAAY,EAAE;QACZ,WAAW,EAAE,yDAAyD;QACtE,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,EAAE;KACjB;IACD;;OAEG;IACH,aAAa,EAAE;QACb,WAAW,EAAE,4CAA4C;QACzD,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,EAAE;KACjB;IACD;;OAEG;IACH,SAAS,EAAE;QACT,WAAW,EAAE,uDAAuD;QACpE,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,KAAK;KACpB;IACD;;OAEG;IACH,QAAQ,EAAE;QACR,WAAW,EAAE,8BAA8B;QAC3C,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,EAAE;KACjB;IACD;;OAEG;IACH,MAAM,EAAE;QACN,WAAW,EAAE,4CAA4C;QACzD,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,EAAE;KACjB;IACD;;OAEG;IACH,KAAK,EAAE;QACL,WAAW,EAAE,2CAA2C;QACxD,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,EAAE;KACjB;IACD;;OAEG;IACH,YAAY,EAAE;QACZ,WAAW,EAAE,sDAAsD;QACnE,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,MAAM;KACrB;IACD;;OAEG;IACH,eAAe,EAAE;QACf,WAAW,EAAE,iDAAiD;QAC9D,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,KAAK;KACpB;CACF,EACD;IACE;;OAEG;IACH,iBAAiB,EAAE,kCAAyB;IAC5C,eAAe,EAAE,IAAI;CACtB,CACF,CAAA;AAKD,kBAAe,iBAAiB,CAAA"}
+{"version":3,"file":"configSchema.js","sourceRoot":"","sources":["../../src/OAuthModel/configSchema.ts"],"names":[],"mappings":";;AAAA,+DAAiE;AAEjE,uEAAsF;AAEtF;;GAEG;AACH,SAAS,CAAC,KAAI,CAAC,CAAC,wDAAwD;AAExE,MAAM,iBAAiB,GAAG,IAAA,mCAAmB,EAC3C,sBAAsB,EACtB;IACE;;OAEG;IACH,SAAS,EAAE;QACT,WAAW,EAAE,oDAAoD;QACjE,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,QAAQ;KACvB;IACD;;OAEG;IACH,YAAY,EAAE;QACZ,WAAW,EAAE,yDAAyD;QACtE,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,EAAE;KACjB;IACD;;OAEG;IACH,aAAa,EAAE;QACb,WAAW,EAAE,4CAA4C;QACzD,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,EAAE;KACjB;IACD;;OAEG;IACH,SAAS,EAAE;QACT,WAAW,EAAE,uDAAuD;QACpE,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,KAAK;KACpB;IACD;;OAEG;IACH,QAAQ,EAAE;QACR,WAAW,EAAE,8BAA8B;QAC3C,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,EAAE;KACjB;IACD;;OAEG;IACH,MAAM,EAAE;QACN,WAAW,EAAE,4CAA4C;QACzD,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,EAAE;KACjB;IACD;;OAEG;IACH,KAAK,EAAE;QACL,WAAW,EAAE,2CAA2C;QACxD,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,EAAE;KACjB;IACD;;OAEG;IACH,YAAY,EAAE;QACZ,WAAW,EACT,gFAAgF;QAClF,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,MAAM;KACrB;CACF,EACD;IACE;;OAEG;IACH,iBAAiB,EAAE,kCAAyB;IAC5C,eAAe,EAAE,IAAI;CACtB,CACF,CAAA;AAKD,kBAAe,iBAAiB,CAAA"}

package/dist/OAuthModel/model.d.ts

@@ -1,19 +1,198 @@
 /// <reference types="react" />
 import { UriLocation } from '@jbrowse/core/util';
 import { Instance } from 'mobx-state-tree';
-import { OAuthInternetAccountConfigModel } from './configSchema';
-declare const stateModelFactory: (configSchema: OAuthInternetAccountConfigModel) => import("mobx-state-tree").IModelType<{
+/**
+ * #stateModel OAuthInternetAccount
+ */
+declare const stateModelFactory: (configSchema: 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; /**
+         * #getter
+         */
+        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;
+    };
+}, 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>>) => import("mobx-state-tree").IModelType<{
     id: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").ISimpleType<string>, [undefined]>;
     type: import("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; /**
+             * #getter
+             */
+            type: string;
+            defaultValue: never[];
+        };
+    }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, "internetAccountId">>;
 } & {
+    /**
+     * #property
+     */
     type: import("mobx-state-tree").ISimpleType<"OAuthInternetAccount">;
-    configuration: import("mobx-state-tree").ITypeUnion<any, any, any>;
+    /**
+     * #property
+     */
+    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; /**
+             * #getter
+             */
+            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;
+        };
+    }, 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: string;
     readonly description: string;
-    readonly internetAccountId: string;
+    readonly internetAccountId: string; /**
+     * #getter
+     */
     readonly authHeader: string;
-    readonly tokenType: string;
+    readonly tokenType: string; /**
+     * #getter
+     */
     readonly domains: string[];
     readonly toggleContents: import("react").ReactNode;
     readonly SelectorComponent: import("@jbrowse/core/util").AnyReactComponentType | undefined;
@@ -48,7 +227,10 @@ declare const stateModelFactory: (configSchema: OAuthInternetAccountConfigModel)
     getPreAuthorizationInformation(location: UriLocation): Promise<{
         internetAccountType: string;
         authInfo: {
-            token: string;
+            token: string; /**
+             * #action
+             * used to listen to child window for auth code/token
+             */
             configuration: any;
         };
     }>;
@@ -57,34 +239,107 @@ declare const stateModelFactory: (configSchema: OAuthInternetAccountConfigModel)
 } & {
     openLocation(location: UriLocation): import("@jbrowse/core/util/io").RemoteFileWithRangeCache;
 } & {
+    /**
+     * #getter
+     */
     readonly codeVerifierPKCE: string;
 } & {
+    /**
+     * #getter
+     */
     readonly authEndpoint: string;
+    /**
+     * #getter
+     */
     readonly tokenEndpoint: string;
+    /**
+     * #getter
+     */
     readonly needsPKCE: boolean;
+    /**
+     * #getter
+     */
     readonly clientId: string;
+    /**
+     * #getter
+     */
     readonly scopes: string;
     /**
-     * OAuth state parameter: https://www.rfc-editor.org/rfc/rfc6749#section-4.1.1
+     * #method
+     * OAuth state parameter:
+     * https://www.rfc-editor.org/rfc/rfc6749#section-4.1.1
+     *
      * Can override or extend if dynamic state is needed.
      */
     state(): string | undefined;
+    /**
+     * #getter
+     */
     readonly responseType: "code" | "token";
-    readonly hasRefreshToken: boolean;
+    /**
+     * #getter
+     */
     readonly refreshTokenKey: string;
 } & {
+    /**
+     * #action
+     */
     storeRefreshToken(refreshToken: string): void;
+    /**
+     * #action
+     */
     removeRefreshToken(): void;
+    /**
+     * #method
+     */
     retrieveRefreshToken(): string | null;
+    /**
+     * #action
+     */
     exchangeAuthorizationForAccessToken(token: string, redirectUri: string): Promise<string>;
+    /**
+     * #action
+     */
     exchangeRefreshForAccessToken(refreshToken: string): Promise<string>;
 } & {
+    /**
+     * #action
+     * used to listen to child window for auth code/token
+     */
     addMessageChannel(resolve: (token: string) => void, reject: (error: Error) => void): void;
+    /**
+     * #action
+     */
     deleteMessageChannel(): void;
+    /**
+     * #action
+     */
     finishOAuthWindow(event: MessageEvent, resolve: (token: string) => void, reject: (error: Error) => void): Promise<void>;
+    /**
+     * #action
+     * opens external OAuth flow, popup for web and new browser window for
+     * desktop
+     */
     useEndpointForAuthorization(resolve: (token: string) => void, reject: (error: Error) => void): Promise<void>;
+    /**
+     * #action
+     */
     getTokenFromUser(resolve: (token: string) => void, reject: (error: Error) => void): Promise<void>;
+    /**
+     * #action
+     */
     validateToken(token: string, location: UriLocation): Promise<string>;
+} & {
+    /**
+     * #action
+     * Get a fetch method that will add any needed authentication headers to
+     * the request before sending it. If location is provided, it will be
+     * checked to see if it includes a token in it's pre-auth information.
+     *
+     * @param loc - UriLocation of the resource
+     * @returns A function that can be used to fetch
+     */
+    getFetcher(loc?: UriLocation): (input: RequestInfo, init?: RequestInit) => Promise<Response>;
 }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>;
 export default stateModelFactory;
 export type OAuthStateModel = ReturnType<typeof stateModelFactory>;