synapse-react-client 3.3.3 → 3.3.4

package/dist/index.d.ts

@@ -147,6 +147,7 @@ import { Map as Map_3 } from 'immutable';
 import { MembershipInvitation } from '@sage-bionetworks/synapse-types';
 import { MembershipInvtnSignedToken } from '@sage-bionetworks/synapse-types';
 import { MembershipRequest } from '@sage-bionetworks/synapse-types';
+import { MessageToUser } from '@sage-bionetworks/synapse-types';
 import { MessageURL } from '@sage-bionetworks/synapse-types';
 import { MultipartUploadRequest } from '@sage-bionetworks/synapse-types';
 import { MultipartUploadStatus } from '@sage-bionetworks/synapse-types';
@@ -303,6 +304,10 @@ export declare type AccessRequirementAclEditorProps = {
     onSaveComplete: (saveSuccessful: boolean) => void;
 };
 
+declare const accessRequirementPermissionLevels: readonly ["CAN_REVIEW_SUBMISSIONS", "IS_EXEMPTION_ELIGIBLE", "CAN_REVIEW_SUBMISSIONS_AND_IS_EXEMPTION_ELIGIBLE"];
+
+declare type AccessRequirementPermissionsLevel = (typeof accessRequirementPermissionLevels)[number];
+
 export declare const AccessRequirementRelatedProjectsList: (props: AccessRequirementRelatedProjectsListProps) => default_2.JSX.Element;
 
 export declare type AccessRequirementRelatedProjectsListProps = {
@@ -1418,6 +1423,10 @@ declare interface EntityImage {
     isEntityImage: boolean;
 }
 
+declare const entityPermissionLevels: readonly ["CAN_VIEW", "CAN_DOWNLOAD", "CAN_EDIT", "CAN_EDIT_DELETE", "CAN_ADMINISTER"];
+
+declare type EntityPermissionsLevel = (typeof entityPermissionLevels)[number];
+
 /**
  * Indicates which container is selected when the tree is used to control another component. If 'root', then the top-level entities
  * should be shown in the other component. If a synID, then that entity's children should be shown in the other component. If null,
@@ -3428,12 +3437,12 @@ declare type PartialStateObject = {
 
 export declare function PasswordField(props: TextFieldProps_2): default_2.JSX.Element;
 
-declare type PermissionLevel = (typeof permissionLevels)[number];
-
-declare const permissionLevels: readonly ["CAN_REVIEW_SUBMISSIONS", "IS_EXEMPTION_ELIGIBLE", "CAN_REVIEW_SUBMISSIONS_AND_IS_EXEMPTION_ELIGIBLE"];
+declare type PermissionLevel = EntityPermissionsLevel | AccessRequirementPermissionsLevel;
 
 declare namespace PermissionLevelToAccessType {
     export {
+        EntityPermissionsLevel,
+        AccessRequirementPermissionsLevel,
         PermissionLevel,
         getPermissionLevelFromAccessType,
         getAccessTypeFromPermissionLevel,
@@ -3589,6 +3598,8 @@ export declare type ProvenanceProps = {
 /** The group representing all logged-in Synapse users AND anonymous */
 declare const PUBLIC_PRINCIPAL_ID = 273949;
 
+declare const PUBLIC_PRINCIPAL_IDS: number[];
+
 declare const PUBLICATION: string;
 
 declare function purgeFromTrashCan(entityId: string, accessToken: string | undefined): Promise<void>;
@@ -4057,6 +4068,14 @@ declare type SelectedFacetConfig = {
     sourceTableColumnName: string;
 };
 
+declare function sendMessage(recipients: string[], subject: string, body: string, accessToken: string): Promise<MessageToUser>;
+
+declare type SendMessageRequest = {
+    recipients: string[];
+    subject: string;
+    body: string;
+};
+
 declare const SEPERATOR = "SEPERATOR";
 
 /**
@@ -4358,6 +4377,7 @@ declare namespace SynapseClient {
         createColumnModels,
         getDefaultColumnModels,
         getAnnotationColumnModels,
+        sendMessage,
         SYNAPSE_STORAGE_LOCATION_ID,
         getVersion,
         getDownloadFromTableRequest,
@@ -4834,6 +4854,7 @@ declare namespace SynapseConstants {
         AUTHENTICATED_PRINCIPAL_ID,
         PUBLIC_PRINCIPAL_ID,
         ANONYMOUS_PRINCIPAL_ID,
+        PUBLIC_PRINCIPAL_IDS,
         ACT_TEAM_ID,
         TRUSTED_HTML_USERS_TEAM_ID,
         BUNDLE_MASK_QUERY_RESULTS,
@@ -5275,6 +5296,7 @@ declare namespace SynapseQueries {
         useInfiniteQueryResultBundle,
         useGetFullTableQueryResults,
         useGetSchema,
+        useGetFeatureFlag,
         useGetStablePresignedUrl,
         useGetPresignedUrlContent,
         useGetPresignedUrlContentFromFHA,
@@ -5283,8 +5305,29 @@ declare namespace SynapseQueries {
         StablePresignedUrl,
         useGetDefaultUploadDestination,
         useGetUploadDestinationForStorageLocation,
+        KeyFactory,
+        useSendMessage,
+        useGetOAuthClientInfinite,
+        useDeleteOAuthClient,
+        useUpdateOAuthClient,
+        useCreateOAuthClient,
+        invalidateAllQueriesForEntity,
+        getAllActionsRequiredQueryFilters,
         useSearch,
         useSearchInfinite,
+        useGetTeam,
+        useCreateTeam,
+        useGetTeamList,
+        useGetChallengeTeamList,
+        useGetTeamMembers,
+        useGetIsUserMemberOfTeam,
+        useGetMembershipStatus,
+        useGetAllOpenMembershipInvitations,
+        useInviteUserToTeam,
+        useAddMemberToTeam,
+        useRequestToJoinTeam,
+        useDeleteTeamMembership,
+        TeamMembershipParam,
         useIsFavorite,
         useAddFavorite,
         useRemoveFavorite,
@@ -5308,33 +5351,12 @@ declare namespace SynapseQueries {
         useGetUserGroupHeaders,
         useSearchUserGroupHeaders,
         useGetUserGroupHeaderWithAlias,
-        useGetOAuthClientInfinite,
-        useDeleteOAuthClient,
-        useUpdateOAuthClient,
-        useCreateOAuthClient,
-        useGetTeam,
-        useCreateTeam,
-        useGetTeamList,
-        useGetChallengeTeamList,
-        useGetTeamMembers,
-        useGetIsUserMemberOfTeam,
-        useGetMembershipStatus,
-        useGetAllOpenMembershipInvitations,
-        useInviteUserToTeam,
-        useAddMemberToTeam,
-        useRequestToJoinTeam,
-        useDeleteTeamMembership,
-        TeamMembershipParam,
-        KeyFactory,
-        invalidateAllQueriesForEntity,
-        getAllActionsRequiredQueryFilters,
         useGetRootWikiPageKey,
         useGetWikiPage,
         CreateWikiPageInput,
         useCreateWikiPage,
         UpdateWikiPageInput,
-        useUpdateWikiPage,
-        useGetFeatureFlag
+        useUpdateWikiPage
     }
 }
 export { SynapseQueries }
@@ -6351,6 +6373,8 @@ declare function useSearchInfinite<TData = InfiniteData<SearchResults>>(query: O
 
 declare function useSearchUserGroupHeaders(prefix: string, filter?: TYPE_FILTER, options?: Partial<UseQueryOptions<UserGroupHeader[], SynapseClientError>>): UseQueryResult<UserGroupHeader[], SynapseClientError>;
 
+declare function useSendMessage(options?: Partial<UseMutationOptions<MessageToUser, SynapseClientError, SendMessageRequest>>): UseMutationResult<MessageToUser, SynapseClientError, SendMessageRequest, unknown>;
+
 /**
  * Hook for storing an ES6 set in React state. Methods that mutate the set have been hidden via TypeScript,
  * so if you adhere to the type definitions, the set is essentially immutable.