@gen3/core 0.10.44

package/dist/dts/features/modals/modalsSlice.d.ts

@@ -0,0 +1,26 @@
+import { CoreState } from '../../reducers';
+/**
+ * Defines the modals slice of the Redux store.
+ * This slice is used to control the display of standard Gen3 modals.
+ * and can be extended to add custom modals by representing them as strings.
+ */
+export declare enum Modals {
+    'FirstTimeModal' = "FirstTimeModal",
+    'SessionExpireModal' = "SessionExpireModal",
+    'NoAccessModal' = "NoAccessModal",
+    'CreateCredentialsAPIKeyModal' = "CreateCredentialsAPIKeyModal",
+    'GeneralErrorModal' = "GeneralErrorModal"
+}
+type CurrentModal = Modals | string | null;
+export interface ModalState {
+    currentModal: CurrentModal;
+    message?: string;
+}
+export declare const modalReducer: import("redux").Reducer<ModalState>;
+export declare const showModal: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    modal: Modals;
+    message?: string;
+}, "modals/showModal">, hideModal: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"modals/hideModal">;
+export declare const selectCurrentModal: (state: CoreState) => CurrentModal;
+export declare const selectCurrentMessage: (state: CoreState) => string | undefined;
+export {};

package/dist/dts/features/submission/authMappingUtils.d.ts

@@ -0,0 +1,15 @@
+export declare const resourcePathFromProjectID: (projectID: string) => string;
+export declare const isRootUrl: (urlFragment: string) => boolean;
+export declare const isProgramUrl: (urlFragment: string) => boolean;
+export declare const userHasSheepdogProgramAdmin: (userAuthMapping?: Record<string, any>) => boolean;
+export declare const userHasSheepdogProjectAdmin: (userAuthMapping?: Record<string, any>) => boolean;
+export declare const projectCodeFromResourcePath: (resourcePath: string) => string;
+export declare const listifyMethodsFromMapping: (actions: {
+    service: string;
+    method: string;
+}[]) => string[];
+export declare const userHasDataUpload: (userAuthMapping?: Record<string, any>) => boolean;
+export declare const userHasMethodForServiceOnResource: (method: string, service: string, resourcePath: string, userAuthMapping?: Record<string, any>) => boolean;
+export declare const userHasMethodForServiceOnProject: (method: string, service: string, projectID: string, userAuthMapping?: Record<string, any>) => boolean;
+export declare const userHasMethodOnAnyProject: (method: string, userAuthMapping?: Record<string, any>) => boolean;
+export declare const userHasCreateOrUpdateOnAnyProject: (userAuthMapping?: Record<string, any>) => boolean;

package/dist/dts/features/submission/index.d.ts

@@ -0,0 +1,3 @@
+export * from './authMappingUtils';
+export * from './submissionApi';
+export * from './types';

package/dist/dts/features/submission/submissionApi.d.ts

@@ -0,0 +1,43 @@
+import { ProjectResponse, ProjectsListRequestParams, SubmissionInfo, SubmissionGraphqlParams, SubmissionGraphqlResponse } from './types';
+import { JSONObject } from '../../types';
+import type { FetchBaseQueryError } from '@reduxjs/toolkit/query';
+/**
+ * Project details from the project query
+ */
+interface ProjectInfoFromProjectDetails {
+    name: string;
+    id: string;
+    code: string;
+}
+/**
+ *  Project details results a list of project details
+ *  and the project information
+ */
+interface ProjectDetailsResults {
+    [key: string]: string | number | ProjectInfoFromProjectDetails;
+    project: ProjectInfoFromProjectDetails;
+}
+export interface ProjectDetailsQueryResponse {
+    details: ProjectDetailsResults[];
+    hits: number;
+}
+interface SubmissionQueryResponse {
+    transactionList: SubmissionInfo[];
+}
+/**
+ * Defines submissionApi service using a base URL and expected endpoints. Derived from gen3Api core API.
+ * @param endpoints - Defines endpoints used in submission page
+ * @param getProjects - Queries the list of projects
+ * @param getProjectsDetails - Queries the list of projects and their details
+ * @param getSubmissionGraphQL - Queries the submission graphql with a query and variables
+ * @returns: A submission API for fetching project details
+ */
+export declare const submissionApi: import("@reduxjs/toolkit/query").Api<import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, FetchBaseQueryError, {}, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, {
+    getProjects: import("@reduxjs/toolkit/query").QueryDefinition<JSONObject, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, FetchBaseQueryError, {}, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, ProjectResponse, "gen3Services">;
+    getSubmissions: import("@reduxjs/toolkit/query").QueryDefinition<void, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, FetchBaseQueryError, {}, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, SubmissionQueryResponse, "gen3Services">;
+    getProjectsDetails: import("@reduxjs/toolkit/query").QueryDefinition<ProjectsListRequestParams, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, FetchBaseQueryError, {}, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, ProjectDetailsQueryResponse, "gen3Services">;
+    getSubmissionGraphQL: import("@reduxjs/toolkit/query").QueryDefinition<SubmissionGraphqlParams, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, FetchBaseQueryError, {}, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, SubmissionGraphqlResponse, "gen3Services">;
+    getDictionary: import("@reduxjs/toolkit/query").QueryDefinition<void, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, FetchBaseQueryError, {}, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, SubmissionGraphqlResponse, "gen3Services">;
+}, "gen3Services", never, keyof import("@reduxjs/toolkit/query").ApiModules<any, any, any, any>>;
+export declare const useGetProjectsQuery: import("@reduxjs/toolkit/dist/query/react/buildHooks").UseQuery<import("@reduxjs/toolkit/query").QueryDefinition<JSONObject, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, FetchBaseQueryError, {}, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, ProjectResponse, "gen3Services">>, useGetSubmissionGraphQLQuery: import("@reduxjs/toolkit/dist/query/react/buildHooks").UseQuery<import("@reduxjs/toolkit/query").QueryDefinition<SubmissionGraphqlParams, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, FetchBaseQueryError, {}, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, SubmissionGraphqlResponse, "gen3Services">>, useGetProjectsDetailsQuery: import("@reduxjs/toolkit/dist/query/react/buildHooks").UseQuery<import("@reduxjs/toolkit/query").QueryDefinition<ProjectsListRequestParams, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, FetchBaseQueryError, {}, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, ProjectDetailsQueryResponse, "gen3Services">>, useLazyGetProjectsQuery: import("@reduxjs/toolkit/dist/query/react/buildHooks").UseLazyQuery<import("@reduxjs/toolkit/query").QueryDefinition<JSONObject, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, FetchBaseQueryError, {}, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, ProjectResponse, "gen3Services">>, useLazyGetSubmissionGraphQLQuery: import("@reduxjs/toolkit/dist/query/react/buildHooks").UseLazyQuery<import("@reduxjs/toolkit/query").QueryDefinition<SubmissionGraphqlParams, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, FetchBaseQueryError, {}, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, SubmissionGraphqlResponse, "gen3Services">>, useGetSubmissionsQuery: import("@reduxjs/toolkit/dist/query/react/buildHooks").UseQuery<import("@reduxjs/toolkit/query").QueryDefinition<void, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, FetchBaseQueryError, {}, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, SubmissionQueryResponse, "gen3Services">>, useGetDictionaryQuery: import("@reduxjs/toolkit/dist/query/react/buildHooks").UseQuery<import("@reduxjs/toolkit/query").QueryDefinition<void, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, FetchBaseQueryError, {}, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, SubmissionGraphqlResponse, "gen3Services">>;
+export {};

package/dist/dts/features/submission/types.d.ts

@@ -0,0 +1,46 @@
+import { JSONObject, JSONValue } from '../../types';
+export interface Project {
+    availability_type: string;
+    code: string;
+    project_id: string;
+}
+export interface SubmissionGraphqlParams {
+    query: string;
+    variables: Record<string, JSONValue>;
+    mapping?: {
+        [key: string]: string;
+    };
+}
+export interface SubmissionGraphqlResponse {
+    data: JSONObject;
+}
+export interface ProjectDetailsParams {
+    ids: Array<string>;
+}
+export interface ProjectDetailsResponse {
+    data: JSONObject[];
+}
+export interface ProjectsListRequestParams {
+    size: number;
+    projectQuery: JSONObject;
+    projectDetailsQuery: JSONObject;
+    mapping?: {
+        [key: string]: string;
+    };
+}
+export interface ProjectResponse {
+    projects: Array<Project>;
+}
+export interface SubmissionDocument {
+    doc_size: number;
+    doc?: string;
+    id: string;
+}
+export interface SubmissionInfo {
+    id: string;
+    submitter: string;
+    project_id: string;
+    created_datetime: string;
+    documents: Array<SubmissionDocument>;
+    state: string;
+}

package/dist/dts/features/user/externalLoginsSlice.d.ts

@@ -0,0 +1,14 @@
+import { ExternalProvider } from './types';
+export interface ExternalProviderResponse {
+    providers: ExternalProvider[];
+}
+/**
+ *  @description Creates a externalLoginApi for listing the configured identity providers
+ *  in workspace token service. Includes user token expiration time.
+ *  @see https://github.com/uc-cdis/workspace-token-service/tree/master
+ */
+export declare const externalLoginApi: import("@reduxjs/toolkit/dist/query").Api<import("@reduxjs/toolkit/dist/query").BaseQueryFn<string | import("@reduxjs/toolkit/dist/query").FetchArgs, unknown, import("@reduxjs/toolkit/dist/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/dist/query").FetchBaseQueryMeta>, {
+    getExternalLogins: import("@reduxjs/toolkit/dist/query").QueryDefinition<void, import("@reduxjs/toolkit/dist/query").BaseQueryFn<string | import("@reduxjs/toolkit/dist/query").FetchArgs, unknown, import("@reduxjs/toolkit/dist/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/dist/query").FetchBaseQueryMeta>, never, ExternalProviderResponse, "gen3Services">;
+    isExternalConnected: import("@reduxjs/toolkit/dist/query").QueryDefinition<string, import("@reduxjs/toolkit/dist/query").BaseQueryFn<string | import("@reduxjs/toolkit/dist/query").FetchArgs, unknown, import("@reduxjs/toolkit/dist/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/dist/query").FetchBaseQueryMeta>, never, boolean, "gen3Services">;
+}, "gen3Services", never, keyof import("@reduxjs/toolkit/dist/query").ApiModules<any, any, any, any>>;
+export declare const useGetExternalLoginsQuery: import("@reduxjs/toolkit/dist/query/react/buildHooks").UseQuery<import("@reduxjs/toolkit/dist/query").QueryDefinition<void, import("@reduxjs/toolkit/dist/query").BaseQueryFn<string | import("@reduxjs/toolkit/dist/query").FetchArgs, unknown, import("@reduxjs/toolkit/dist/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/dist/query").FetchBaseQueryMeta>, never, ExternalProviderResponse, "gen3Services">>, useLazyGetExternalLoginsQuery: import("@reduxjs/toolkit/dist/query/react/buildHooks").UseLazyQuery<import("@reduxjs/toolkit/dist/query").QueryDefinition<void, import("@reduxjs/toolkit/dist/query").BaseQueryFn<string | import("@reduxjs/toolkit/dist/query").FetchArgs, unknown, import("@reduxjs/toolkit/dist/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/dist/query").FetchBaseQueryMeta>, never, ExternalProviderResponse, "gen3Services">>, useLazyIsExternalConnectedQuery: import("@reduxjs/toolkit/dist/query/react/buildHooks").UseLazyQuery<import("@reduxjs/toolkit/dist/query").QueryDefinition<string, import("@reduxjs/toolkit/dist/query").BaseQueryFn<string | import("@reduxjs/toolkit/dist/query").FetchArgs, unknown, import("@reduxjs/toolkit/dist/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/dist/query").FetchBaseQueryMeta>, never, boolean, "gen3Services">>, useIsExternalConnectedQuery: import("@reduxjs/toolkit/dist/query/react/buildHooks").UseQuery<import("@reduxjs/toolkit/dist/query").QueryDefinition<string, import("@reduxjs/toolkit/dist/query").BaseQueryFn<string | import("@reduxjs/toolkit/dist/query").FetchArgs, unknown, import("@reduxjs/toolkit/dist/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/dist/query").FetchBaseQueryMeta>, never, boolean, "gen3Services">>;

package/dist/dts/features/user/hooks.d.ts

@@ -0,0 +1,18 @@
+import { FileMetadata } from './types';
+interface FederatedLoginStatusParams {
+    selectedFiles: ReadonlyArray<FileMetadata>;
+}
+declare const useGetFederatedLoginStatus: ({ selectedFiles, }: FederatedLoginStatusParams) => Promise<{
+    error: import("@reduxjs/toolkit").SerializedError | import("@reduxjs/toolkit/dist/query").FetchBaseQueryError | undefined;
+    data?: undefined;
+    isLoading?: undefined;
+    providersToAuthenticate?: undefined;
+    missingProviders?: undefined;
+} | {
+    data: import("./externalLoginsSlice").ExternalProviderResponse;
+    isLoading: false;
+    error: undefined;
+    providersToAuthenticate: import("./types").ExternalProvider[];
+    missingProviders: import("./types").ExternalProvider[];
+}>;
+export default useGetFederatedLoginStatus;

package/dist/dts/features/user/index.d.ts

@@ -0,0 +1,5 @@
+import { useUser, useUserAuth, resetUserState, fetchUserState, isAuthenticated, isPending, selectUser, selectUserData, selectUserLoginStatus, useIsUserLoggedIn } from './userSlice';
+import { useFetchUserDetailsQuery, useLazyFetchUserDetailsQuery, selectUserDetails, selectUserAuthStatus, useGetCSRFQuery, selectCSRFToken, selectCSRFTokenData, selectHeadersWithCSRFToken, type CSRFToken } from './userSliceRTK';
+import { useGetExternalLoginsQuery, useLazyGetExternalLoginsQuery, useLazyIsExternalConnectedQuery, useIsExternalConnectedQuery } from './externalLoginsSlice';
+import { type UserProfile, type LoginStatus, type Gen3User, type ExternalProvider, type NamedURL, type JWTSessionStatus } from './types';
+export { type Gen3User, type LoginStatus, type UserProfile, type JWTSessionStatus, type CSRFToken, type ExternalProvider, type NamedURL, useUser, useUserAuth, selectUser, selectUserData, selectUserLoginStatus, fetchUserState, isAuthenticated, isPending, useIsUserLoggedIn, resetUserState, useGetExternalLoginsQuery, useLazyGetExternalLoginsQuery, useLazyIsExternalConnectedQuery, useIsExternalConnectedQuery, useFetchUserDetailsQuery, useLazyFetchUserDetailsQuery, selectUserDetails, selectUserAuthStatus, useGetCSRFQuery, selectCSRFToken, selectCSRFTokenData, selectHeadersWithCSRFToken, };

package/dist/dts/features/user/test/useGetExternalLoginsQuery.unit.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/dts/features/user/types.d.ts

@@ -0,0 +1,50 @@
+import { AuthzMapping } from '../authz';
+export interface NamedURL {
+    name: string;
+    url: string;
+}
+export interface ExternalProvider {
+    base_url: string;
+    idp: string;
+    name: string;
+    refresh_token_expiration: string;
+    urls: NamedURL[];
+}
+export interface FileMetadata {
+    object_id: string;
+}
+/**
+ * Data model for a Gen3 User obtained from the /user/user endpoint
+ */
+export interface UserProfile {
+    authz: AuthzMapping;
+    id: number;
+    user_id: number;
+    username: string;
+    email: string;
+    role: string;
+    is_admin: boolean;
+    project_access: {
+        [key: string]: string[];
+    };
+    phone_number: string;
+    display_name: string;
+    preferred_username: string;
+    ga4gh_passport_v1: Record<string, string>[];
+    certificates_uploaded: Record<string, string>[];
+    primary_google_service_account: null;
+    resources_granted: Record<string, string>[];
+    groups: string[];
+    message: string;
+    sub: string;
+    idp: string;
+    azp: string[] | null;
+}
+export type Gen3User = Partial<UserProfile>;
+export type LoginStatus = 'authenticated' | 'unauthenticated' | 'pending' | 'not present';
+export type JWTSessionStatus = 'not present' | 'issued' | 'expired' | 'invalid' | 'error';
+export interface ExistingSession {
+    expires: number;
+    issued: number;
+    status: JWTSessionStatus;
+}

package/dist/dts/features/user/userSlice.d.ts

@@ -0,0 +1,53 @@
+import { Gen3FenceResponse } from '../fence';
+import { CoreDispatch } from '../../store';
+import { CoreState } from '../../reducers';
+import { CoreDataSelectorResponse, DataStatus } from '../../dataAccess';
+import { Gen3User, LoginStatus } from './types';
+export interface Gen3UserLoginResponse<T> {
+    readonly data?: T;
+    readonly error?: string;
+    readonly loginStatus: LoginStatus;
+    readonly isUninitialized: boolean;
+    readonly isFetching: boolean;
+    readonly isSuccess: boolean;
+    readonly isError: boolean;
+}
+/**
+ * Creates an async thunk for fetching user permissions details from fence
+ * @see https://redux-toolkit.js.org/api/createAsyncThunk
+ * @returns: A fence response dict containing user details
+ */
+export declare const fetchUserState: import("@reduxjs/toolkit").AsyncThunk<Gen3FenceResponse<Partial<import("./types").UserProfile>>, void, {
+    dispatch: CoreDispatch;
+    state: CoreState;
+    extra?: unknown;
+    rejectValue?: unknown;
+    serializedErrorType?: unknown;
+    pendingMeta?: unknown;
+    fulfilledMeta?: unknown;
+    rejectedMeta?: unknown;
+}>;
+export declare const isAuthenticated: (loginStatus: LoginStatus) => boolean;
+export declare const isPending: (loginStatus: LoginStatus) => boolean;
+export interface Gen3UserState {
+    readonly data?: Gen3User;
+    readonly status: DataStatus;
+    readonly loginStatus: LoginStatus;
+    readonly error?: string;
+}
+export declare const userReducer: import("redux").Reducer<Gen3UserState>;
+export declare const resetUserState: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"fence/user/resetUserState">;
+export interface Gen3UserSelectorResponse<T> extends CoreDataSelectorResponse<T> {
+    readonly loginStatus: LoginStatus;
+}
+export declare const selectUserData: (state: CoreState) => Gen3UserSelectorResponse<Gen3User>;
+export declare const selectUser: (state: CoreState) => Gen3UserState;
+export declare const selectUserLoginStatus: (state: CoreState) => LoginStatus;
+export declare const useUser: import("../../dataAccess").UseCoreDataHook<never, Partial<import("./types").UserProfile>>;
+export declare const useIsUserLoggedIn: () => boolean;
+/**
+ * Hook to return get the authenticated state of the user and if logged in,
+ * the user's profile and access api.
+ * Note that if fetchUserState gets called, the user's session is renewed.
+ */
+export declare const useUserAuth: (renew?: boolean) => Gen3UserLoginResponse<Gen3User>;