synapse-react-client/dist/synapse-queries/KeyFactory.d.ts

[](https://badge.fury.io/js/synapse-react-client) [](https://github.com/prettier/prettie

import { AddToDownloadListStatsRequest, DiscussionSearchRequest, EntityLookupRequest, GetRepoV1DoiAssociationRequest, GetRepoV1DoiRequest, ListGridSessionsRequest, SuggestionQuery, UploadToTablePreviewRequest, type UserSubmissionSearchRequest, ViewEntityType } from '@sage-bionetworks/synapse-client';
import { OIDCAuthorizationRequest } from '@sage-bionetworks/synapse-client/generated/models/OIDCAuthorizationRequest';
import { PrincipalAliasRequest } from '@sage-bionetworks/synapse-client/generated/models/PrincipalAliasRequest';
import { AccessApprovalSearchRequest, AccessRequirementSearchRequest, AvailableFilesRequest, BatchFileRequest, DiscussionFilter, DiscussionReplyOrder, DiscussionThreadOrder, EntityBundleRequest, EntityChildrenRequest, FavoriteSortBy, FavoriteSortDirection, FileHandle, FileHandleAssociation, GetEvaluationParameters, GetProjectsParameters, ObjectType, QueryBundleRequest, ReferenceList, RestrictionInformationBatchRequest, RestrictionInformationRequest, SearchQuery, SessionHistoryRequest, SubmissionInfoPageRequest, SubmissionSearchRequest, SubscriptionObjectType, SubscriptionQuery, TraceEventsRequest, TYPE_FILTER, ViewColumnModelRequest, WikiPageKey } from '@sage-bionetworks/synapse-types';
/**
 * Returns a react-query Query Key.
 *
 * Co-location of react-query keys for queries related to Synapse data. Two objectives of this strategy are
 * - minimize the risk of inappropriate cache key collisions
 * - simplify clearing the appropriate query caches when the entity data is updated
 *
 * For more information, see https://tkdodo.eu/blog/leveraging-the-query-function-context
 */
export declare class KeyFactory {
    accessToken: string | undefined;
    constructor(accessToken: string | undefined);
    /**
     * Returns a react-query Query Key. Prepends the key with the access token, so that the key is unique per-session.
     * Also removes trailing undefined elements from the passed args, so a key can be generated for query invalidation.
     * @param args
     * @private
     */
    private getKey;
    private getKeyAnonymous;
    getFeatureFlagQueryKey(): readonly unknown[];
    getAllEntityDataQueryKey(): readonly unknown[];
    getEntityQueryKey(id: string): readonly unknown[];
    getEntityActivityQueryKey(id: string, versionNumber?: number): readonly unknown[];
    getAllEntityActionsRequiredQueryKey(): readonly unknown[];
    getEntityActionsRequiredQueryKey(id: string): readonly unknown[];
    getEntityChallengeQueryKey(id: string): readonly unknown[];
    getForumQueryKey(id: string): readonly unknown[];
    getEntityVersionQueryKey(id?: string, versionNumber?: string | number): readonly unknown[];
    getEntityLookupQueryKey(entityLookupRequest: EntityLookupRequest): readonly unknown[];
    getPaginatedEntityVersionsQueryKey(id: string, limit: number, offset: number): readonly unknown[];
    getEntityVersionsQueryKey(id: string): readonly unknown[];
    getEntityChildrenQueryKey(request: EntityChildrenRequest, infinite: boolean): readonly unknown[];
    getEntityJsonQueryKey(id: string, versionNumber: number | undefined, includeDerivedAnnotations: boolean): readonly unknown[];
    getEntityBundleQueryKey(id: string | undefined, version: number | undefined, bundleRequest: EntityBundleRequest): readonly unknown[];
    getEntityPathQueryKey(id: string): readonly unknown[];
    getEntityACLQueryKey(id: string): readonly unknown[];
    getEntityAliasQueryKey(alias: string): readonly unknown[];
    getEntityEvaluationsQueryKey(id: string): readonly unknown[];
    getEntityPermissionsQueryKey(id: string): readonly unknown[];
    getEntityBoundJsonSchemaQueryKey(id: string): readonly unknown[];
    getEntitySchemaValidationResultsQueryKey(id: string): readonly unknown[];
    getEntityHeaderQueryKey(id: string, versionNumber?: number): readonly unknown[];
    getEntityAccessRequirementsQueryKey(id: string): readonly unknown[];
    getEntityHeadersQueryKey(references: ReferenceList): readonly unknown[];
    getAllTableQueryResultsKey(): readonly unknown[];
    getEntityTableQueryResultQueryKey(queryBundleRequest: QueryBundleRequest, infinite: boolean): readonly unknown[];
    getEntityTableQueryResultWithAsyncStatusQueryKey(queryBundleRequest: QueryBundleRequest, infinite: boolean): readonly unknown[];
    getRootWikiPageKeyQueryKey(ownerObjectType: ObjectType, ownerObjectId: string): readonly unknown[];
    getWikiPageQueryKey(wikiPageKey: WikiPageKey): readonly unknown[];
    getWikiPageKey(ownerId: string, wikiPageId: string): readonly unknown[];
    getWikiAttachmentsQueryKey(wikiPageKey: WikiPageKey): readonly unknown[];
    getFullTableQueryResultQueryKey(queryBundleRequest: QueryBundleRequest, forceAnonymous: boolean): readonly unknown[];
    getDownloadListBaseQueryKey(): readonly unknown[];
    getDownloadListAvailableFilesQueryKey(request: AvailableFilesRequest): readonly unknown[];
    getDownloadListAvailableFilesInfiniteQueryKey(request: AvailableFilesRequest): readonly unknown[];
    getDownloadListActionsRequiredQueryKey(): readonly unknown[];
    getDownloadListActionsRequiredInfiniteQueryKey(): readonly unknown[];
    getDownloadListStatisticsQueryKey(): readonly unknown[];
    searchAccessApprovalsQueryKey(params?: AccessApprovalSearchRequest): readonly unknown[];
    getUserAccessApprovalQueryKey(submissionId: string): readonly unknown[];
    getAccessRequirementQueryKey(id?: string): readonly unknown[];
    getAccessRequirementAclQueryKey(id: string): readonly unknown[];
    searchAccessRequirementsQueryKey(params?: AccessRequirementSearchRequest): readonly unknown[];
    getAccessRequirementWikiPageKey(id: string): readonly unknown[];
    getRestrictionInformationQueryKey(request: RestrictionInformationRequest): readonly unknown[];
    getRestrictionInformationBatchQueryKey(request: RestrictionInformationBatchRequest): readonly unknown[];
    getAllAccessRequirementStatusesQueryKey(): readonly unknown[];
    getAccessRequirementStatusQueryKey(id: string): readonly unknown[];
    getDataAccessRequestForUpdateQueryKey(accessRequirementId: string): readonly unknown[];
    getAccessRequirementResearchProjectQueryKey(accessRequirementId: string): readonly unknown[];
    getSortedAccessRequirementsAndStatusQueryKey(accessRequirementIds?: string[]): readonly unknown[];
    getDataAccessSubmissionQueryKey(): readonly unknown[];
    getDataAccessSubmissionByIdQueryKey(id: string): readonly unknown[];
    searchDataAccessSubmissionQueryKey(params?: SubmissionSearchRequest): readonly unknown[];
    searchDataAccessSubmissionUserRequestsQueryKey(params?: UserSubmissionSearchRequest): readonly unknown[];
    getApprovedSubmissionInfoQueryKey(request?: SubmissionInfoPageRequest): readonly unknown[];
    getValidationSchemaQueryKey(schema$id: string): readonly unknown[];
    getPresignedUrlContentQueryKey(fileHandle: FileHandle, request: BatchFileRequest, maxSizeBytes?: number): readonly unknown[];
    getPresignedUrlFromFHAContentQueryKey(fileHandleAssociation: FileHandleAssociation, forceAnonymous: boolean): readonly unknown[];
    getStablePresignedUrlFromFHAQueryKey(fileHandleAssociation: FileHandleAssociation, forceAnonymous: boolean): readonly unknown[];
    getProfileImageQueryKey(userId: string): readonly unknown[];
    getDefaultUploadDestinationQueryKey(containerEntityId: string): readonly unknown[];
    getUploadDestinationForStorageLocationQueryKey(parentId: string, storageLocationId: number): readonly unknown[];
    getForumModeratorsQueryKey(forumId: string): readonly unknown[];
    getForumMetadataQueryKey(forumId: string): readonly unknown[];
    getAllForumThreadsQueryKey(forumId: string): readonly unknown[];
    getForumThreadsQueryKey(forumId: string, limit: number, sort: DiscussionThreadOrder, ascending: boolean, filter?: DiscussionFilter): readonly unknown[];
    getForumSearchQueryKey(forumId: string, discussionSearchRequest: DiscussionSearchRequest): readonly unknown[];
    getAllRepliesQueryKey(threadId: string): readonly unknown[];
    getRepliesQueryKey(threadId: string, ascending?: boolean, limit?: number, sort?: DiscussionReplyOrder, filter?: DiscussionFilter): readonly unknown[];
    getReplyQueryKey(threadId: string, replyId: string, messageKey: string): readonly unknown[];
    getThreadQueryKey(threadId: string): readonly unknown[];
    getThreadBodyQueryKey(threadId: string, messageKey: string): readonly unknown[];
    getMyOAuthClientsQueryKey(): readonly unknown[];
    getOAuthClientQueryKey(clientId: string): readonly unknown[];
    getOAuthClientAclQueryKey(clientId: string): readonly unknown[];
    getHasCurrentUserAuthorizedOAuthClientQueryKey(request: OIDCAuthorizationRequest): readonly unknown[];
    getDOIAssociationQueryKey(request: GetRepoV1DoiAssociationRequest): readonly unknown[];
    getDOIQueryKey(request: GetRepoV1DoiRequest): readonly unknown[];
    getAllSubscribersQueryKey(): readonly unknown[];
    getSubscribersQueryKey(objectId: string, objectType: SubscriptionObjectType): readonly unknown[];
    getBaseSubscriptionQueryKey(): readonly unknown[];
    getAllSubscriptionsQueryKey(query?: SubscriptionQuery): readonly unknown[];
    getSubscriptionQueryKey(objectId: string, objectType: SubscriptionObjectType): readonly unknown[];
    getSearchEntitiesQueryKey(query: SearchQuery): readonly unknown[];
    getSuggestionQueryKey(query: SuggestionQuery): readonly unknown[];
    getTeamQueryKey(teamId: string): readonly unknown[];
    getTeamListQueryKey(teamIds: string): readonly unknown[];
    getChallengeTeamListQueryKey(challengeId: string): readonly unknown[];
    getTeamMembersQueryKey(teamId: string): readonly unknown[];
    getTeamMemberCountQueryKey(teamId: string): readonly unknown[];
    getIsUserMemberOfTeamQueryKey(teamId: string, userId: string): readonly unknown[];
    getMembershipStatusQueryKey(teamId: string, userId?: string): readonly unknown[];
    getAllOpenMembershipInvitationsForUserQueryKey(userId: string): readonly unknown[];
    getTeamAccessRequirementsQueryKey(teamId: string): readonly unknown[];
    getFavoritesQueryKey(): readonly unknown[];
    getUserFavoritesQueryKey(sort: FavoriteSortBy, sortDirection: FavoriteSortDirection): readonly unknown[];
    getUserFavoritesInfiniteQueryKey(sort: FavoriteSortBy, sortDirection: FavoriteSortDirection): readonly unknown[];
    getTrashCanItemsQueryKey(): readonly unknown[];
    getUserChallengesQueryKey(userId: string): readonly unknown[];
    getPassingRecordQueryKey(userId: string): readonly unknown[];
    getAllSubmissionTeamsQueryKeys(): readonly unknown[];
    getSubmissionTeamsQueryKey(challengeId: string, limit?: number, offset?: number): readonly unknown[];
    getUserProjectsQueryKey(userId: string, projectParams: GetProjectsParameters): readonly unknown[];
    getAllUserTeamsQueryKey(): readonly unknown[];
    getUserTeamsQueryKey(userId: string): readonly unknown[];
    getPersonalAccessTokensQueryKey(): readonly unknown[];
    getMyProjectsQueryKey(params?: GetProjectsParameters): readonly unknown[];
    getNotificationEmailQueryKey(): readonly unknown[];
    getCurrentUserProfileQueryKey(): readonly unknown[];
    getUserBundleQueryKey(userId: string, mask: number): readonly unknown[];
    getUserProfileQueryKey(userId: string): readonly unknown[];
    getPrincipalAliasQueryKey(request: PrincipalAliasRequest): readonly unknown[];
    getUserGroupHeaderQueryKey(id: string): readonly unknown[];
    getUserGroupHeaderBatchQueryKey(id: string[]): readonly unknown[];
    getUserGroupHeaderWithAliasQueryKey(aliases: string[]): readonly unknown[];
    getUserGroupHeaderSearchQueryKey(prefix: string, filter?: TYPE_FILTER): readonly unknown[];
    getTwoFactorAuthStatusQueryKey(): readonly unknown[];
    getBatchOfFiles(request: BatchFileRequest): readonly unknown[];
    getChatAgentTraceKey(request: TraceEventsRequest): readonly unknown[];
    getTermsOfServiceInfoKey(): readonly unknown[];
    getTermsOfServiceStatus(): readonly unknown[];
    getRealmPrincipalsQueryKey(): readonly unknown[];
    getCurrentRealmQueryKey(): readonly unknown[];
    getRealmByIdQueryKey(realmId: string): readonly unknown[];
    getProjectStorageUsageKey(projectId: string): readonly unknown[];
    getPaginatedDockerTagQueryKey(id: string, offset: string, limit: string, sort: string, sortDirection: string): readonly unknown[];
    getDefaultColumnModelsQueryKey(viewEntityType?: ViewEntityType, viewTypeMask?: number): readonly unknown[];
    getAnnotationColumnModelsQueryKey(request: Omit<ViewColumnModelRequest, 'nextPageToken'>): readonly unknown[];
    getEvaluationByIdQueryKey(evalId: string): readonly unknown[];
    getEvaluationsQueryKey(request: GetEvaluationParameters): readonly unknown[];
    getEvaluationRoundsQueryKey(evaluationId: string): readonly unknown[];
    chatAgentSessionHistoryQueryKey(params?: SessionHistoryRequest): readonly unknown[];
    getWebhooksQueryKey(): readonly unknown[];
    getGithubLatestTagKey(repoOwner: string, repoName: string): readonly unknown[];
    getFileContentKey(fileURL?: string): readonly unknown[];
    getPortalKey(portalId: string): readonly unknown[];
    getPortalPermissionsKey(portalId: string): readonly unknown[];
    getPortalAclQueryKey(portalId: string): readonly unknown[];
    getListPortalsQueryKey(): readonly unknown[];
    getGridSessionKey(sessionId: string): readonly unknown[];
    getGridSessionListKey(request?: ListGridSessionsRequest): readonly unknown[];
    getCurationTaskKey(taskId: number): readonly unknown[];
    getCurationTaskListKey(projectId: string): readonly unknown[];
    getCsvPreviewQueryKey(request: UploadToTablePreviewRequest): readonly unknown[];
    getAddToDownloadListStatsQueryKey(addToDownloadListStatsRequest: AddToDownloadListStatsRequest): readonly unknown[];
    getAsyncJobStatusQueryKey(jobId: string): readonly unknown[];
}
//# sourceMappingURL=KeyFactory.d.ts.map