synapse-react-client
Version:
[](https://badge.fury.io/js/synapse-react-client) [](https://github.com/prettier/prettie
55 lines • 2.08 kB
TypeScript
import { AccessRequirement, ManagedACTAccessRequirement, Renewal, Request, RestrictableObjectType } from '@sage-bionetworks/synapse-types';
import { ReactNode } from 'react';
export type AccessRequirementListProps = {
numberOfFilesAffected?: number;
requestObjectName?: string;
renderAsModal?: boolean;
dialogTitle?: string;
onHide: () => void;
accessRequirementFromProps?: Array<AccessRequirement>;
customDialogActions?: ReactNode;
onSubmissionCreated?: (submissionId: string) => void;
} & ({
/**
* Fetches the access requirements associated with an entity
* @deprecated Please use `subjectId` and `subjectType`
*/
entityId: string;
} | {
/**
* Fetches the access requirements associated with a team
* @deprecated Please use `subjectId` and `subjectType`
*/
teamId: string;
} | {
subjectId?: string;
subjectType?: RestrictableObjectType;
});
export declare const checkHasUnsupportedRequirement: (accessRequirements: Array<AccessRequirement>) => boolean;
/**
* Represents a distinct screen in the wizard used to apply to a ManagedACTAccessRequirement
*/
declare enum RequestDataStep {
SHOW_ALL_ARS = 0,
UPDATE_RESEARCH_PROJECT = 1,
UPDATE_ACCESSORS_AND_FILES = 2,
PROMPT_CANCEL = 3,
PROMPT_LOGIN = 4,
COMPLETE = 5
}
export type RequestDataStepCallbackArgs = {
step: RequestDataStep;
managedACTAccessRequirement?: ManagedACTAccessRequirement;
researchProjectId?: string;
dataAccessRequest?: Request | Renewal;
};
/**
* The AccessRequirementListV2 component renders a set of {@link AccessRequirement}s (either pre-defined, or those applied
* to an entity, based on provided props).
*
* The component shows the user the approval status of each AR and provides a workflow for accepting the terms of or
* creating a submission for any of the Access Requirements.
*/
export default function AccessRequirementList(props: AccessRequirementListProps): import("react/jsx-runtime").JSX.Element;
export {};
//# sourceMappingURL=AccessRequirementList.d.ts.map