synapse-react-client
Version:
[](https://badge.fury.io/js/synapse-react-client) [](https://github.com/prettier/prettie
132 lines • 13.1 kB
TypeScript
/**
* SWC.index.ts represents the entry point for the Synapse React Client library as it is published to NPM and
* used by SynapseWebClient.
*
* If you wish to export a component or other object to be used by SynapseWebClient, you should add it to this file.
*/
import { SynapseToastContainer } from './components/ToastMessage/ToastMessage';
import SynapseClient, { HttpClient } from './synapse-client';
import * as SynapseQueries from './synapse-queries';
import Palettes from './theme/palette/Palettes';
import { SynapseConstants } from './utils';
import { sendAnalyticsEvent } from './utils/analytics/sendAnalyticsEvent';
import { sendSearchQuerySubmittedEvent, sendSearchResultClickedEvent, sendSearchResultReturnedEvent, sendSearchResultsReturnedEvent } from './utils/analytics/sendSearchEvent';
import { FullContextProvider } from './utils/context/FullContextProvider';
import { SynapseContextProvider, useSynapseContext } from './utils/context/SynapseContext';
import { BackendDestinationEnum } from './utils/functions';
import { xssOptions } from './utils/functions/SanitizeHtmlUtils';
import { SynapseSessionManager } from './utils/AppUtils';
import './style/main.scss';
declare const SynapseEnums: {
BackendDestinationEnum: typeof BackendDestinationEnum;
};
declare const SynapseContext: {
FullContextProvider: typeof FullContextProvider;
SynapseContextProvider: typeof SynapseContextProvider;
SynapseContextConsumer: import("react").Consumer<import("./utils").SynapseContextType>;
useSynapseContext: typeof useSynapseContext;
};
declare const SynapseComponents: {
AccessRequirementAclEditor: import("react").LazyExoticComponent<import("react").ForwardRefExoticComponent<import("./components").AccessRequirementAclEditorProps & import("react").RefAttributes<import("./components/AccessRequirementAclEditor/AccessRequirementAclEditor").AccessRequirementAclEditorHandle>>>;
AccessRequirementList: import("react").LazyExoticComponent<typeof import("./components/AccessRequirementList/AccessRequirementList").default>;
AccessRequirementRelatedProjectsList: import("react").LazyExoticComponent<(props: import("./components").AccessRequirementRelatedProjectsListProps) => React.ReactNode>;
AccountLevelBadges: import("react").LazyExoticComponent<typeof import("./components").AccountLevelBadges>;
AddToDownloadListConfirmationAlert: import("react").LazyExoticComponent<typeof import("./components/download_list/AddToDownloadListConfirmationAlert/AddToDownloadListConfirmationAlert").default>;
AvailableEvaluationQueueList: import("react").LazyExoticComponent<typeof import("./components").AvailableEvaluationQueueList>;
CertificationQuiz: import("react").LazyExoticComponent<typeof import("./components").CertificationQuiz>;
CookiesNotification: import("react").LazyExoticComponent<(props: import("./components/CookiesNotification/CookiesNotification").CookieNotificationProps) => React.ReactNode>;
CreateOrUpdateAccessRequirementWizard: import("react").LazyExoticComponent<typeof import("./components/CreateOrUpdateAccessRequirementWizard").CreateOrUpdateAccessRequirementWizard>;
CreateOrUpdateDoiModal: import("react").LazyExoticComponent<typeof import("./components/doi/CreateOrUpdateDoiModal").CreateOrUpdateDoiModal>;
CreateTableViewWizard: import("react").LazyExoticComponent<typeof import("./components/CreateTableViewWizard/CreateTableViewWizard").default>;
CreatedByModifiedBy: import("react").LazyExoticComponent<typeof import("./components/entity/page/CreatedByModifiedBy").CreatedByModifiedBy>;
DatasetItemsEditor: import("react").LazyExoticComponent<typeof import("./components/SynapseTable/datasets/DatasetItemsEditor").DatasetItemsEditor>;
DiscussionThread: import("react").LazyExoticComponent<typeof import("./components").DiscussionThread>;
DownloadCartPage: import("react").LazyExoticComponent<typeof import("./components").DownloadCartPage>;
EntityAclEditorModal: import("react").LazyExoticComponent<typeof import("./components/EntityAclEditor/EntityAclEditorModal").default>;
EntityActionMenu: import("react").LazyExoticComponent<typeof import("./components/entity/page/action_menu/EntityActionMenu").default>;
EntityBadgeIcons: import("react").LazyExoticComponent<(props: import("./components").EntityBadgeIconsProps) => React.ReactNode>;
EntityCitation: import("react").LazyExoticComponent<({ projectId, entityId, versionNumber, }: import("./components/EntityCitation").EntityCitationProps) => React.ReactNode>;
EntityFinder: import("react").LazyExoticComponent<typeof import("./components").EntityFinder>;
EntityForm: import("react").LazyExoticComponent<typeof import("./components").EntityForm>;
EntityHeaderTable: import("react").LazyExoticComponent<(props: import("./components").EntityHeaderTableProps) => React.ReactNode>;
EntityModal: import("react").LazyExoticComponent<typeof import("./components/entity/metadata/EntityModal").EntityModal>;
EntityPageBreadcrumbs: import("react").LazyExoticComponent<typeof import("./components/entity/page/breadcrumbs/EntityPageBreadcrumbs").default>;
EntityPageTitleBar: import("react").LazyExoticComponent<typeof import("./components/entity/page/title_bar/EntityPageTitleBar").default>;
EntityTreeTable: import("react").LazyExoticComponent<import("react").FC<{
rootId: string;
expandRootByDefault?: boolean;
showRootNode?: boolean;
enableSorting?: boolean;
onEntityIdClicked?: (entityId: string) => void;
}>>;
EntityTypeIcon: import("react").LazyExoticComponent<typeof import("./components/EntityIcon").EntityTypeIcon>;
EntityUploadModal: import("react").LazyExoticComponent<import("react").ForwardRefExoticComponent<{
entityId: string;
open: boolean;
onClose: () => void;
} & Pick<import("./components/EntityUpload/EntityUpload").EntityUploadProps, "onUploadReady"> & import("react").RefAttributes<import("./components/EntityUpload/EntityUpload").EntityUploadHandle>>>;
EntityViewScopeEditorModal: import("react").LazyExoticComponent<typeof import("./components/EntityViewScopeEditor/EntityViewScopeEditorModal").default>;
ErrorPage: import("react").LazyExoticComponent<typeof import("./components").ErrorPage>;
EvaluationCard: import("react").LazyExoticComponent<typeof import("./components").EvaluationCard>;
EvaluationEditorPage: import("react").LazyExoticComponent<typeof import("./components").EvaluationEditorPage>;
FavoritesPage: import("react").LazyExoticComponent<typeof import("./components/favorites/FavoritesPage").default>;
ForumSearch: import("react").LazyExoticComponent<(props: import("./components/ForumSearch").ForumSearchProps) => React.ReactNode>;
FullWidthAlert: import("react").LazyExoticComponent<typeof import("./components").FullWidthAlert>;
GoogleAnalytics: import("react").LazyExoticComponent<typeof import("./components").GoogleAnalytics>;
GovernanceMarkdownGithub: import("react").LazyExoticComponent<typeof import("./components/Markdown/GovernanceMarkdownGithub").GovernanceMarkdownGithub>;
GridPage: import("react").LazyExoticComponent<typeof import("./features/curator/GridPage/GridPage").default>;
HasAccess: import("react").LazyExoticComponent<typeof import("./components").HasAccess>;
HelpPopover: import("react").LazyExoticComponent<typeof import("./components").HelpPopover>;
HtmlPreview: import("react").LazyExoticComponent<typeof import("./components/FilePreview/HtmlPreview/HtmlPreview").default>;
IDUReport: import("react").LazyExoticComponent<typeof import("./components/IDUReport/IDUReport").IDUReport>;
IconSvg: import("react").LazyExoticComponent<typeof import("./components").IconSvg>;
MetadataTasksPage: import("react").LazyExoticComponent<typeof import("./features/entity/metadata-task/components/MetadataTasksPage").default>;
OAuthManagement: import("react").LazyExoticComponent<typeof import("./components").OAuthClientManagement>;
OrientationBanner: import("react").LazyExoticComponent<typeof import("./components").OrientationBanner>;
PageProgress: import("react").LazyExoticComponent<typeof import("./components/PageProgress").PageProgress>;
ProjectDataAvailability: import("react").LazyExoticComponent<typeof import("./components").ProjectDataAvailability>;
ProvenanceGraph: import("react").LazyExoticComponent<(props: import("./components").ProvenanceProps) => React.ReactNode>;
QueryWrapperPlotNav: import("react").LazyExoticComponent<typeof import("./components").QueryWrapperPlotNav>;
RejectProfileValidationRequestModal: import("react").LazyExoticComponent<typeof import("./components/dataaccess/RejectProfileValidationRequestModal").RejectProfileValidationRequestModal>;
ReviewerDashboard: import("react").LazyExoticComponent<typeof import("./components/dataaccess/ReviewerDashboard").ReviewerDashboard>;
ShareThisPage: import("react").LazyExoticComponent<({ shortIoPublicApiKey, domain, renderAs, open: externalOpen, onClose: externalOnClose, }: import("./components/ShareThisPage").ShareThisPageProps) => React.ReactNode>;
SkeletonButton: import("react").LazyExoticComponent<typeof import("./components").SkeletonButton>;
SqlDefinedTableEditorModal: import("react").LazyExoticComponent<typeof import("./components/SqlDefinedTableEditor/SqlDefinedTableEditorModal").SqlDefinedTableEditorModal>;
StandaloneQueryWrapper: import("react").LazyExoticComponent<typeof import("./components").StandaloneQueryWrapper>;
StatisticsPlot: import("react").LazyExoticComponent<typeof import("./components/StatisticsPlot").default>;
SubmissionViewScopeEditorModal: import("react").LazyExoticComponent<typeof import("./components/SubmissionViewScopeEditor/SubmissionViewScopeEditorModal").default>;
SubscriptionPage: import("react").LazyExoticComponent<typeof import("./components").SubscriptionPage>;
SynapseChat: import("react").LazyExoticComponent<typeof import("./components").SynapseChat>;
SynapseGrid: import("react").LazyExoticComponent<import("react").ForwardRefExoticComponent<import("./components/DataGrid").SynapseGridProps & import("react").RefAttributes<import("./components/DataGrid/SynapseGrid").SynapseGridHandle>>>;
SynapseFooter: import("react").LazyExoticComponent<typeof import("./components/SynapseFooter/SynapseFooter").SynapseFooter>;
SynapseHomepageV2: import("react").LazyExoticComponent<typeof import("./components/SynapseHomepageV2").SynapseHomepageV2>;
SynapseNavDrawer: import("react").LazyExoticComponent<typeof import("./components/SynapseNavDrawer/SynapseNavDrawer").SynapseNavDrawer>;
SynapsePlansPage: import("react").LazyExoticComponent<typeof import("./components/SynapseHomepageV2").SynapsePlansPage>;
SynapsePortalBanners: import("react").LazyExoticComponent<typeof import("./components/SynapsePortalBanners/SynapsePortalBanners").default>;
SynapseSearchPage: import("react").LazyExoticComponent<typeof import("./components/SynapseSearchPageResults/SynapseSearchPage").default>;
SynapseToastContainer: typeof SynapseToastContainer;
TableColumnSchemaEditor: import("react").LazyExoticComponent<typeof import("./components/TableColumnSchemaEditor/TableColumnSchemaEditor").default>;
TrashCanList: import("react").LazyExoticComponent<typeof import("./components/trash/TrashCanList").TrashCanList>;
UserAccessRequestHistoryPlace: import("react").LazyExoticComponent<typeof import("./components/dataaccess/UserAccessRequestHistory/UserAccessRequestHistoryPlace").UserAccessRequestHistoryPlace>;
UserCard: import("react").LazyExoticComponent<typeof import("./components").UserCard>;
UserProfileLinks: import("react").LazyExoticComponent<typeof import("./components").UserProfileLinks>;
displayToast: (message: import("react").ReactNode, variant?: "info" | "success" | "warning" | "danger", toastMessageOptions?: {
title?: string;
autoCloseInMs?: number;
primaryButtonConfig?: import("./components/FullWidthAlert/FullWidthAlert").AlertButtonConfig;
secondaryButtonConfig?: import("./components/FullWidthAlert/FullWidthAlert").AlertButtonConfig;
dismissOnPrimaryButtonClick?: boolean;
dismissOnSecondaryButtonClick?: boolean;
}) => (() => void);
getCurrentCookiePreferences: () => import("./utils/hooks").CookiePreference;
};
declare const Analytics: {
sendAnalyticsEvent: typeof sendAnalyticsEvent;
sendSearchQuerySubmittedEvent: typeof sendSearchQuerySubmittedEvent;
sendSearchResultsReturnedEvent: typeof sendSearchResultsReturnedEvent;
sendSearchResultReturnedEvent: typeof sendSearchResultReturnedEvent;
sendSearchResultClickedEvent: typeof sendSearchResultClickedEvent;
};
declare const SynapseReactClientVersion: string;
export { Analytics, HttpClient, SynapseReactClientVersion, SynapseComponents, SynapseConstants, SynapseClient, SynapseContext, SynapseEnums, SynapseQueries, Palettes, xssOptions, SynapseSessionManager, };
//# sourceMappingURL=SWC.index.d.ts.map