synapse-react-client 3.3.5 → 3.3.7

package/dist/index.d.ts

@@ -276,6 +276,7 @@ import { UserGroupHeaderResponse } from '@sage-bionetworks/synapse-types';
 import { UserGroupHeaderResponsePage } from '@sage-bionetworks/synapse-types';
 import { UserProfile } from '@sage-bionetworks/synapse-types';
 import { UseStorageValueResult } from '@react-hookz/web/cjs/useStorageValue';
+import { UseSuspenseQueryResult } from '@tanstack/react-query';
 import { ValidateDefiningSqlResponse } from '@sage-bionetworks/synapse-types';
 import { ValidationResults } from '@sage-bionetworks/synapse-types';
 import { VerificationSubmission } from '@sage-bionetworks/synapse-types';
@@ -832,6 +833,20 @@ declare function createColumnModels(accessToken: string, columnModels: SetOption
  */
 declare const createEntity: <T extends Entity>(entity: T, accessToken: string | undefined) => Promise<T>;
 
+/**
+ * Create a new Access Control List (ACL), overriding inheritance.
+ *
+ * By default, Entities such as FileEntity and Folder inherit their permission from their containing Project. For such
+ * Entities the Project is the Entity's 'benefactor'. This permission inheritance can be overridden by creating an ACL
+ * for the Entity. When this occurs the Entity becomes its own benefactor and all permission are determined by its own ACL.
+ *
+ * If the ACL of an Entity is deleted, then its benefactor will automatically be set to its parent's benefactor.
+ *
+ * Note: The caller must be granted ACCESS_TYPE.CHANGE_PERMISSIONS on the Entity to call this method.
+ * https://rest-docs.synapse.org/rest/POST/entity/id/acl.html
+ */
+declare const createEntityACL: (acl: AccessControlList, accessToken?: string | undefined) => Promise<AccessControlList>;
+
 /**
  * Create an evaluation queue
  * https://rest-docs.synapse.org/rest/POST/evaluation.html
@@ -1076,6 +1091,21 @@ declare const deleteEmail: (accessToken: string | undefined, email: string) => P
 
 declare const deleteEntity: (accessToken: string | undefined, entityId: string | number) => Promise<void>;
 
+/**
+ * Delete the Access Control List (ACL) for a given Entity.
+ *
+ * By default, Entities such as FileEntity and Folder inherit their permission from their containing Project. For such
+ * Entities the Project is the Entity's 'benefactor'. This permission inheritance can be overridden by creating an ACL
+ * for the Entity. When this occurs the Entity becomes its own benefactor and all permission are determined by its own ACL.
+ *
+ * If the ACL of an Entity is deleted, then its benefactor will automatically be set to its parent's benefactor. The ACL
+ * for a Project cannot be deleted.
+ *
+ * Note: The caller must be granted ACCESS_TYPE.CHANGE_PERMISSIONS on the Entity to call this method.
+ * https://rest-docs.synapse.org/rest/PUT/entity/id/acl.html
+ */
+declare const deleteEntityACL: (id: string, accessToken?: string | undefined) => Promise<void>;
+
 /**
  * Delete an existing evaluation queue
  * https://rest-docs.synapse.org/rest/PUT/evaluation/evalId.html
@@ -2727,6 +2757,8 @@ declare type ImmutableTableQueryResult = {
     currentQueryRequest: ReadonlyDeep<QueryBundleRequest>;
     /** The next (uncommitted) query request. This will become the current query request when commitChanges is called, or the configured debounced timer elapses. */
     nextQueryRequest: ReadonlyDeep<QueryBundleRequest>;
+    /** Resets the debounce timer to delay committing changes in `nextQueryRequest` */
+    resetDebounceTimer: () => void;
     /** Update the currentQueryRequest to be the nextQueryRequest */
     commitChanges: () => void;
     getInitQueryRequest: () => QueryBundleRequest;
@@ -3573,6 +3605,17 @@ declare const PROJECT: string;
 
 export declare const ProjectIcon: () => default_2.JSX.Element;
 
+/**
+ * Display a carousel of projects using a Project View. Driven by the following annotations/column names:
+ * projectDisplayName, projectDescription, projectImageFileName. The projectImageFileName must
+ * be an attachment on the project's root wiki page.
+ */
+export declare const ProjectViewCarousel: default_2.FunctionComponent<ProjectViewCarouselProps>;
+
+export declare type ProjectViewCarouselProps = {
+    entityId: string;
+};
+
 export declare const ProvenanceGraph: (props: ProvenanceProps) => default_2.JSX.Element;
 
 export declare type ProvenanceProps = {
@@ -3656,6 +3699,7 @@ export declare type QueryContextType<TIncludedFields extends OptionalQueryBundle
     executeQueryRequest: ImmutableTableQueryResult['setQuery'];
     /** Resets the query to its initial state, clearing all filters added by the user */
     resetQuery: ImmutableTableQueryResult['resetQuery'];
+    resetDebounceTimer: ImmutableTableQueryResult['resetDebounceTimer'];
     addValueToSelectedFacet: ImmutableTableQueryResult['addValueToSelectedFacet'];
     setRangeFacetValue: ImmutableTableQueryResult['setRangeFacetValue'];
     removeSelectedFacet: ImmutableTableQueryResult['removeSelectedFacet'];
@@ -4402,7 +4446,9 @@ declare namespace SynapseClient {
         getEntityHeaders,
         getEntityAlias,
         getEntityHeader,
+        createEntityACL,
         updateEntityACL,
+        deleteEntityACL,
         updateEntity,
         deleteEntity,
         getEntityBundleV2,
@@ -4739,6 +4785,8 @@ declare namespace SynapseComponents {
         SynapsePlotProps,
         ClickCallbackParams,
         GraphItem,
+        ProjectViewCarousel,
+        ProjectViewCarouselProps,
         Programs,
         ProgramsProps,
         ProgrammaticTableDownload,
@@ -5267,11 +5315,16 @@ declare namespace SynapseQueries {
         useGetEntityAlias,
         useGetEntityEvaluations,
         useGetEntityPermissions,
+        useCreateEntityACL,
         useUpdateEntityACL,
+        useDeleteEntityACL,
+        useSuspenseGetEntityBenefactorACL,
         useUpdateTableColumns,
         useGetSchemaBinding,
         useGetValidationResults,
+        useGetEntityBundleQueryOptions,
         useGetEntityBundle,
+        useSuspenseGetEntityBundle,
         useGetEntityActionsRequired,
         useGetEntityChallenge,
         useGetEntityChildren,
@@ -5329,6 +5382,7 @@ declare namespace SynapseQueries {
         useGetProjectsInfinite,
         useGetNotificationEmail,
         useGetCurrentUserProfile,
+        useSuspenseGetCurrentUserProfile,
         useGetUserBundle,
         useGetCurrentUserBundle,
         useGetUserProfile,
@@ -5799,6 +5853,8 @@ declare function useCreateAccessRequirementACL(options?: UseMutationOptions<Acce
 
 declare function useCreateEntity(options?: UseMutationOptions<Entity, SynapseClientError, Pick<Entity, 'name' | 'description' | 'parentId' | 'concreteType'>>): UseMutationResult<Entity, SynapseClientError, Pick<Entity, "name" | "description" | "concreteType" | "parentId">, unknown>;
 
+declare function useCreateEntityACL(options?: Partial<UseMutationOptions<AccessControlList, SynapseClientError, AccessControlList>>): UseMutationResult<AccessControlList, SynapseClientError, AccessControlList, unknown>;
+
 declare function useCreateLockAccessRequirement(options?: Partial<UseMutationOptions<AccessRequirement, SynapseClientError, string>>): UseMutationResult<AccessRequirement, SynapseClientError, string, unknown>;
 
 declare function useCreateOAuthClient(options?: Partial<UseMutationOptions<OAuthClient, SynapseClientError, OAuthClient>>): UseMutationResult<OAuthClient, SynapseClientError, OAuthClient, unknown>;
@@ -5826,6 +5882,8 @@ declare function useDeleteAccessRequirementACL(options?: UseMutationOptions<void
 
 declare function useDeleteEntity(options?: Partial<UseMutationOptions<void, SynapseClientError, string>>): UseMutationResult<void, SynapseClientError, string, unknown>;
 
+declare function useDeleteEntityACL(options?: Partial<UseMutationOptions<void, SynapseClientError, string>>): UseMutationResult<void, SynapseClientError, string, unknown>;
+
 declare function useDeleteOAuthClient(options?: Partial<UseMutationOptions<void, SynapseClientError, string>>): UseMutationResult<void, SynapseClientError, string, unknown>;
 
 declare function useDeleteTeamMembership(options?: Partial<UseMutationOptions<void, SynapseClientError, TeamMembershipParam>>): UseMutationResult<void, SynapseClientError, TeamMembershipParam, unknown>;
@@ -5905,7 +5963,12 @@ declare function useGetEntityActionsRequired(entityId: string, options?: Partial
 
 declare function useGetEntityAlias(alias: string, options?: Partial<UseQueryOptions<EntityId | null, SynapseClientError>>): UseQueryResult<EntityId | null, SynapseClientError>;
 
-declare function useGetEntityBundle<T extends EntityBundleRequest = typeof ALL_ENTITY_BUNDLE_FIELDS>(entityId: string, version?: number, bundleRequest?: T, options?: Partial<UseQueryOptions<EntityBundle<T>, SynapseClientError>>): UseQueryResult<EntityBundle<T>, SynapseClientError>;
+declare function useGetEntityBundle<T extends EntityBundleRequest = typeof ALL_ENTITY_BUNDLE_FIELDS, TSelect = EntityBundle<T>>(entityId: string, version?: number, bundleRequest?: T, options?: Partial<UseQueryOptions<EntityBundle<T>, SynapseClientError, TSelect>>): UseQueryResult<TSelect, SynapseClientError>;
+
+declare function useGetEntityBundleQueryOptions<T extends EntityBundleRequest = typeof ALL_ENTITY_BUNDLE_FIELDS>(entityId: string, version?: number, bundleRequest?: T): {
+    queryKey: QueryKey;
+    queryFn: () => Promise<EntityBundle<T>>;
+};
 
 declare function useGetEntityChallenge(entityId: string, options?: Partial<UseQueryOptions<Challenge, SynapseClientError>>): UseQueryResult<Challenge, SynapseClientError>;
 
@@ -6036,7 +6099,7 @@ declare function useGetUserGroupHeader(principalId: string, options?: Partial<Us
 /**
  * Get an array of UserGroupHeaders, utilizing a react-query cache.  This is always an unauthenticated call
  * (the users current email addresses will never be returned in the result).
- * @param principalId
+ * @param principalIds
  * @param options
  * @returns
  */
@@ -6392,6 +6455,20 @@ request: CreateSubmissionRequest;
 accessRequirementId: string;
 }, unknown>;
 
+declare function useSuspenseGetCurrentUserProfile(options?: Partial<UseQueryOptions<UserProfile, SynapseClientError>>): UseSuspenseQueryResult<UserProfile, SynapseClientError>;
+
+/**
+ * Retrieve the ACL of an entity. This call will succeed even for entities where the caller
+ * does not have READ permission.
+ * @param entityId
+ * @param options
+ */
+declare function useSuspenseGetEntityBenefactorACL(entityId: string, options?: Partial<UseQueryOptions<EntityBundle<{
+    includeBenefactorACL: true;
+}>, SynapseClientError, AccessControlList>>): UseSuspenseQueryResult<AccessControlList, SynapseClientError>;
+
+declare function useSuspenseGetEntityBundle<T extends EntityBundleRequest = typeof ALL_ENTITY_BUNDLE_FIELDS>(entityId: string, version?: number, bundleRequest?: T, options?: Partial<UseQueryOptions<EntityBundle<T>, SynapseClientError>>): UseSuspenseQueryResult<EntityBundle<T>, SynapseClientError>;
+
 export declare function useSynapseContext(): SynapseContextType;
 
 declare function useUpdateAccessRequirement<T extends AccessRequirement>(options?: UseMutationOptions<T, SynapseClientError, T>): UseMutationResult<T, SynapseClientError, T, unknown>;