synapse-react-client 3.3.8 → 3.3.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -200,9 +200,12 @@ import { Request as Request_2 } from '@sage-bionetworks/synapse-types';
200
200
  import { ResearchProject } from '@sage-bionetworks/synapse-types';
201
201
  import { ResponseMessage } from '@sage-bionetworks/synapse-types';
202
202
  import { RestrictableObjectDescriptor } from '@sage-bionetworks/synapse-types';
203
+ import { RestrictionInformationBatchRequest } from '@sage-bionetworks/synapse-types';
204
+ import { RestrictionInformationBatchResponse } from '@sage-bionetworks/synapse-types';
203
205
  import { RestrictionInformationRequest } from '@sage-bionetworks/synapse-types';
204
206
  import { RestrictionInformationResponse } from '@sage-bionetworks/synapse-types';
205
207
  import { Row } from '@sage-bionetworks/synapse-types';
208
+ import { RowSet } from '@sage-bionetworks/synapse-types';
206
209
  import { S3FileHandle } from '@sage-bionetworks/synapse-types';
207
210
  import { SearchQuery } from '@sage-bionetworks/synapse-types';
208
211
  import { SearchResults } from '@sage-bionetworks/synapse-types';
@@ -400,6 +403,8 @@ declare type AlertButtonConfig = {
400
403
  href?: string;
401
404
  });
402
405
 
406
+ declare const ALL_QUERY_BUNDLE_PARTS: number;
407
+
403
408
  declare const allowAll: CookiePreference;
404
409
 
405
410
  declare const allowNone: CookiePreference;
@@ -542,7 +547,6 @@ export declare type CardConfiguration = {
542
547
  type: string;
543
548
  hasInternalLink?: boolean;
544
549
  iconOptions?: IconOptions;
545
- initialLimit?: number;
546
550
  } & CommonCardProps;
547
551
 
548
552
  export declare function CardContainer(props: CardContainerProps): default_2.JSX.Element;
@@ -550,7 +554,7 @@ export declare function CardContainer(props: CardContainerProps): default_2.JSX.
550
554
  /**
551
555
  * Class wraps around CardContainer and serves as a standalone logic container for rendering cards.
552
556
  */
553
- export declare const CardContainerLogic: (props: CardContainerLogicProps) => default_2.JSX.Element;
557
+ export declare function CardContainerLogic(props: CardContainerLogicProps): default_2.JSX.Element;
554
558
 
555
559
  export declare type CardContainerLogicProps = {
556
560
  limit?: number;
@@ -561,9 +565,11 @@ export declare type CardContainerLogicProps = {
561
565
  isAlignToLeftNav?: boolean;
562
566
  sql: string;
563
567
  sortConfig?: SortConfiguration;
568
+ initialLimit?: number;
564
569
  } & CardConfiguration & Pick<QueryVisualizationWrapperProps, 'rgbIndex' | 'unitDescription' | 'columnAliases' | 'noContentPlaceholderType' | 'additionalFiltersSessionStorageKey'>;
565
570
 
566
571
  export declare type CardContainerProps = {
572
+ rowSet: RowSet;
567
573
  isHeader?: boolean;
568
574
  isAlignToLeftNav?: boolean;
569
575
  title?: string;
@@ -1000,7 +1006,8 @@ declare type CustomControl = {
1000
1006
  };
1001
1007
 
1002
1008
  export declare type CustomControlCallbackData = {
1003
- data: QueryResultBundle | undefined;
1009
+ tableId: string;
1010
+ queryMetadata: Omit<QueryResultBundle, 'queryResult'> | undefined;
1004
1011
  selectedRows: Row[] | undefined;
1005
1012
  refresh: () => void;
1006
1013
  request?: QueryBundleRequest;
@@ -2218,6 +2225,8 @@ declare const getGroupHeadersBatch: (ids: string[]) => Promise<UserGroupHeaderRe
2218
2225
 
2219
2226
  declare const getIgnoredQueryFilterSearchParamKey: (key: string, namespace?: string) => string;
2220
2227
 
2228
+ declare function getInfiniteQueryResultBundleOptions(queryBundleRequest: QueryBundleRequest, keyFactory: KeyFactory, accessToken: string | undefined, setCurrentAsyncStatus?: (status: AsynchronousJobStatus<QueryBundleRequest, QueryResultBundle>) => void): UseInfiniteQueryOptions<AsynchronousJobStatus<QueryBundleRequest, QueryResultBundle>, SynapseClientError, InfiniteData<AsynchronousJobStatus<QueryBundleRequest, QueryResultBundle>>, AsynchronousJobStatus<QueryBundleRequest, QueryResultBundle>, QueryKey, string | number | undefined>;
2229
+
2221
2230
  declare const getInviteeVerificationSignedToken: (membershipInvitationId: string, accessToken: string) => Promise<InviteeVerificationSignedToken>;
2222
2231
 
2223
2232
  /**
@@ -2279,14 +2288,6 @@ declare const getMyProjects: (accessToken: string, params?: GetProjectsParameter
2279
2288
  */
2280
2289
  declare const getMyUserBundle: (mask: number, accessToken: string | undefined) => Promise<UserBundle>;
2281
2290
 
2282
- /**
2283
- * Grab the next page of data, pulling in 25 more rows.
2284
- *
2285
- * @param {*} queryRequest Query request as specified by
2286
- * https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/table/Query.html
2287
- */
2288
- declare const getNextPageOfData: (queryRequest: QueryBundleRequest, data: QueryResultBundle, token?: string) => Promise<PartialStateObject>;
2289
-
2290
2291
  /**
2291
2292
  * This service returns the email used for user notifications, i.e. when a Synapse message
2292
2293
  * is sent and if the user has elected to receive messages by email, then this is the
@@ -2406,6 +2407,13 @@ declare const getResearchProject: (requirementId: string, accessToken: string) =
2406
2407
 
2407
2408
  declare const getRestrictionInformation: (request: RestrictionInformationRequest, accessToken: string | undefined) => Promise<RestrictionInformationResponse>;
2408
2409
 
2410
+ /**
2411
+ * Retrieve restriction information on a batch of restrictable object, limited to a maximum of 50 object ids
2412
+ *
2413
+ * https://repo-prod.prod.sagebase.org/repo/v1/restrictionInformation/batch
2414
+ */
2415
+ declare const getRestrictionInformationBatch: (request: RestrictionInformationBatchRequest, accessToken: string | undefined) => Promise<RestrictionInformationBatchResponse>;
2416
+
2409
2417
  declare function getRootURL(): string;
2410
2418
 
2411
2419
  /**
@@ -2685,7 +2693,6 @@ export declare function HasAccess(props: HasAccessProps): default_2.JSX.Element;
2685
2693
  export declare type HasAccessProps = {
2686
2694
  onHide?: () => void;
2687
2695
  entityId: string;
2688
- entityVersionNumber?: string;
2689
2696
  className?: string;
2690
2697
  showButtonText?: boolean;
2691
2698
  };
@@ -2802,21 +2809,6 @@ export declare const implementsExternalFileHandleInterface: (object: {
2802
2809
  concreteType: string;
2803
2810
  }) => object is ExternalFileHandleInterface;
2804
2811
 
2805
- declare type InfiniteQueryContextType<TIncludedFields extends OptionalQueryBundleRequestFields = never, ExcludeOtherFields extends true | false = false> = QueryContextType<TIncludedFields, ExcludeOtherFields> & {
2806
- /** Returns true when loading a new page of query results */
2807
- isLoadingNewPage: boolean;
2808
- /** Whether the query result bundle has a next page */
2809
- hasNextPage?: boolean;
2810
- /** Invoke this method to fetch and append the next page of rows to the data */
2811
- appendNextPageToResults: () => Promise<void>;
2812
- /** Invoke to fetch and update the data with the next page of query results */
2813
- goToNextPage: () => Promise<void>;
2814
- /** Whether the query result bundle has a previous page */
2815
- hasPreviousPage: boolean;
2816
- /** Invoke to fetch and update the data with the previous page of query results */
2817
- goToPreviousPage: () => Promise<void>;
2818
- };
2819
-
2820
2812
  export declare const InputSizedButton: StyledComponent<ButtonProps>;
2821
2813
 
2822
2814
  /**
@@ -2976,7 +2968,8 @@ declare class KeyFactory {
2976
2968
  getAccessRequirementAclQueryKey(id: string): QueryKey;
2977
2969
  searchAccessRequirementsQueryKey(params?: AccessRequirementSearchRequest): QueryKey;
2978
2970
  getAccessRequirementWikiPageKey(id: string): QueryKey;
2979
- getAccessRequirementRestrictionInformationQueryKey(request?: RestrictionInformationRequest): QueryKey;
2971
+ getRestrictionInformationQueryKey(request: RestrictionInformationRequest): QueryKey;
2972
+ getRestrictionInformationBatchQueryKey(request: RestrictionInformationBatchRequest): QueryKey;
2980
2973
  getAllAccessRequirementStatusesQueryKey(): QueryKey;
2981
2974
  getAccessRequirementStatusQueryKey(id: string): QueryKey;
2982
2975
  getDataAccessRequestForUpdateQueryKey(accessRequirementId: string): QueryKey;
@@ -3405,8 +3398,6 @@ declare type Operator = {
3405
3398
  */
3406
3399
  declare type Optional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
3407
3400
 
3408
- declare type OptionalQueryBundleRequestFields = keyof Pick<QueryResultBundle, 'queryResult' | 'queryCount' | 'selectColumns' | 'maxRowsPerPage' | 'columnModels' | 'facets' | 'sumFileSizes' | 'combinedSql'>;
3409
-
3410
3401
  declare const ORGANIZATION: string;
3411
3402
 
3412
3403
  export declare const ORIENTATION_BANNER_KEYS: string[];
@@ -3426,17 +3417,6 @@ export declare interface OrientationBannerProps {
3426
3417
  sx?: FullWidthAlertProps['sx'];
3427
3418
  }
3428
3419
 
3429
- declare type PaginatedQueryContextType<TIncludedFields extends OptionalQueryBundleRequestFields = never, ExcludeOtherFields extends true | false = false> = QueryContextType<TIncludedFields, ExcludeOtherFields> & {
3430
- /** Navigates to a particular page, where the first page has value 1 */
3431
- goToPage: (pageNum: number) => void;
3432
- /** The current page number, where page 1 is the first page. */
3433
- currentPage: number;
3434
- /** Updates the page size */
3435
- setPageSize: (pageSize: number) => void;
3436
- /** The current page size. */
3437
- pageSize: number;
3438
- };
3439
-
3440
3420
  export declare const Palettes: {
3441
3421
  palette: PaletteOptions;
3442
3422
  generatePalette: (mainColor: default_4.ColorInput, specificColors?: PaletteColorOptions) => PaletteColorOptions;
@@ -3456,6 +3436,11 @@ export declare const Palettes: {
3456
3436
  geniePalette: PaletteOptions;
3457
3437
  };
3458
3438
 
3439
+ declare const parseEntityIdAndVersionFromSqlStatement: (sql: string) => {
3440
+ entityId: string;
3441
+ versionNumber?: number;
3442
+ } | null;
3443
+
3459
3444
  declare const parseEntityIdFromSqlStatement: (sql: string) => string;
3460
3445
 
3461
3446
  /**
@@ -3466,11 +3451,6 @@ declare const parseEntityIdFromSqlStatement: (sql: string) => string;
3466
3451
  */
3467
3452
  declare function parseSynId(synId: string): Reference | null;
3468
3453
 
3469
- declare type PartialStateObject = {
3470
- hasMoreData: boolean;
3471
- data: QueryResultBundle;
3472
- };
3473
-
3474
3454
  export declare function PasswordField(props: TextFieldProps_2): default_2.JSX.Element;
3475
3455
 
3476
3456
  declare type PermissionLevel = EntityPermissionsLevel | AccessRequirementPermissionsLevel;
@@ -3679,9 +3659,9 @@ declare type QueryChangeCommitOptions = {
3679
3659
  /**
3680
3660
  * This must be exported to use the context in class components.
3681
3661
  */
3682
- export declare const QueryContext: default_2.Context<QueryContextType<never, false> | undefined>;
3662
+ export declare const QueryContext: default_2.Context<QueryContextType | undefined>;
3683
3663
 
3684
- export declare const QueryContextConsumer: default_2.Consumer<QueryContextType<never, false> | undefined>;
3664
+ export declare const QueryContextConsumer: default_2.Consumer<QueryContextType | undefined>;
3685
3665
 
3686
3666
  /**
3687
3667
  * Provides data related to a Synapse table query, and functions for iterating through pages of the data.
@@ -3692,7 +3672,10 @@ export declare type QueryContextProviderProps = default_2.PropsWithChildren<{
3692
3672
  queryContext: QueryContextType;
3693
3673
  }>;
3694
3674
 
3695
- export declare type QueryContextType<TIncludedFields extends OptionalQueryBundleRequestFields = never, ExcludeOtherFields extends true | false = false> = {
3675
+ export declare type QueryContextType = {
3676
+ isInfinite: boolean;
3677
+ entityId: string;
3678
+ versionNumber: number | undefined;
3696
3679
  currentQueryRequest: ReadonlyDeep<QueryBundleRequest>;
3697
3680
  nextQueryRequest: ReadonlyDeep<QueryBundleRequest>;
3698
3681
  /** Returns a deep clone of the current query bundle request */
@@ -3712,18 +3695,45 @@ export declare type QueryContextType<TIncludedFields extends OptionalQueryBundle
3712
3695
  removeQueryFilter: ImmutableTableQueryResult['removeQueryFilter'];
3713
3696
  /** Removes a value from a QueryFilter. If no more values remain in the filter, the filter is also removed */
3714
3697
  removeValueFromQueryFilter: ImmutableTableQueryResult['removeValueFromQueryFilter'];
3715
- /** The error returned by the query request, if one is encountered */
3716
- error: SynapseClientError | null;
3717
- /** The status of the asynchronous job. */
3718
- asyncJobStatus?: AsynchronousJobStatus<QueryBundleRequest, QueryResultBundle>;
3719
3698
  /** Whether facets are available to be filtered upon based on the current data */
3720
- isFacetsAvailable: boolean;
3699
+ hasFacetedSelectColumn: boolean;
3721
3700
  /** Returns true iff the current request has resettable filters applied via facet filters or additionalFilters. Excludes filters applied to a locked column */
3722
3701
  hasResettableFilters: boolean;
3723
- getColumnModel: (columnName: string) => ColumnModel | null;
3724
3702
  onViewSharingSettingsClicked?: (benefactorId: string) => void;
3725
3703
  /** Combines two faceted columns into a single inclusive range selector */
3726
3704
  combineRangeFacetConfig?: ReadonlyDeep<CombineRangeFacetConfig>;
3705
+ /** react-query UseQueryOptions to fetch the current page of table data */
3706
+ rowDataQueryOptions: TableQueryUseQueryOptions['rowDataQueryOptions'];
3707
+ /** react-query UseInfiniteQueryOptions to fetch infinite rows of table data */
3708
+ rowDataInfiniteQueryOptions: TableQueryUseQueryOptions['rowDataInfiniteQueryOptions'];
3709
+ /** react-query UseQueryOptions to fetch the current query metadata (e.g. column models, facet statistics, total number of rows) */
3710
+ queryMetadataQueryOptions: TableQueryUseQueryOptions['queryMetadataQueryOptions'];
3711
+ /** Navigates to a particular page. The first page has value 1. Note that this has no effect if `isInfinite` is true */
3712
+ goToPage: (pageNum: number) => void;
3713
+ /** The current page number, where page 1 is the first page. Note that this has no effect if `isInfinite` is true. */
3714
+ currentPage: number;
3715
+ /** Updates the page size */
3716
+ setPageSize: (pageSize: number) => void;
3717
+ /** The current page size. */
3718
+ pageSize: number;
3719
+ /**
3720
+ * A column name may be "locked" so that it is both (1) not shown to the user that the filter is active, and (2) not modifiable by the user.
3721
+ * For example, we may show only the data matching a particular facet value on a Details Page without implying that the shown data is part of a larger table.
3722
+ * The presence of a locked filter will result in a client-side modification of the active query and result bundle data.
3723
+ */
3724
+ lockedColumn: LockedColumn | undefined;
3725
+ /**
3726
+ * PORTALS-3071: For Tables that are not entityviews or a datasets, keep track of the column that should be used for the row entity ID
3727
+ */
3728
+ fileIdColumnName: string | undefined;
3729
+ /**
3730
+ * PORTALS-3071: For Tables that are not entityviews or a datasets, keep track of the column that should be used for the row (entity) version
3731
+ */
3732
+ fileVersionColumnName: string | undefined;
3733
+ /**
3734
+ * PORTALS-3071: For Tables that are not entityviews or a datasets, keep track of the column that should be used for the row (entity) name
3735
+ */
3736
+ fileNameColumnName: string | undefined;
3727
3737
  };
3728
3738
 
3729
3739
  /**
@@ -3817,6 +3827,8 @@ declare type QueryWrapperPlotNavCustomPlotParams = {
3817
3827
  };
3818
3828
 
3819
3829
  declare type QueryWrapperPlotNavOwnProps = {
3830
+ /** Whether the displayed results should be paginated or infinite. Default for cards is true, default for table is false */
3831
+ isInfinite?: boolean;
3820
3832
  sql: string;
3821
3833
  limit?: number;
3822
3834
  shouldDeepLink?: boolean;
@@ -3826,7 +3838,7 @@ declare type QueryWrapperPlotNavOwnProps = {
3826
3838
  onQueryResultBundleChange?: (newQueryResultBundleJson: string) => void;
3827
3839
  /** If initQueryJson is set, it will be the Query used in the initial QueryBundleRequest */
3828
3840
  initQueryJson?: string;
3829
- tableConfiguration?: SynapseTableProps;
3841
+ tableConfiguration?: SynapseTableConfiguration;
3830
3842
  cardConfiguration?: CardConfiguration;
3831
3843
  searchConfiguration?: Omit<SearchV2Props, 'queryContext' | 'queryVisualizationContext'>;
3832
3844
  facetsToPlot?: string[];
@@ -3836,6 +3848,7 @@ declare type QueryWrapperPlotNavOwnProps = {
3836
3848
  defaultShowSearchBox?: boolean;
3837
3849
  lockedColumn?: QueryWrapperProps['lockedColumn'];
3838
3850
  onViewSharingSettingsClicked?: (benefactorId: string) => void;
3851
+ initialLimit?: number;
3839
3852
  } & Omit<TopLevelControlsProps, 'entityId'> & Pick<QueryWrapperPlotNavCustomPlotParams, 'onCustomPlotClick'> & Pick<QueryWrapperProps, 'isRowSelectionVisible' | 'rowSelectionPrimaryKey' | 'isRowSelectionUIFloating' | 'fileIdColumnName' | 'fileNameColumnName' | 'fileVersionColumnName'> & Pick<QueryVisualizationWrapperProps, 'defaultShowPlots' | 'visibleColumnCount' | 'columnAliases' | 'rgbIndex' | 'showLastUpdatedOn' | 'noContentPlaceholderType' | 'unitDescription' | 'additionalFiltersSessionStorageKey' | 'helpConfiguration'> & Pick<QueryContextType, 'combineRangeFacetConfig'>;
3840
3853
 
3841
3854
  export declare type QueryWrapperPlotNavProps = SearchParams & PlotsContainerProps & Operator & QueryWrapperPlotNavOwnProps;
@@ -3845,6 +3858,7 @@ export declare type QueryWrapperProps = default_2.PropsWithChildren<{
3845
3858
  componentIndex?: number;
3846
3859
  shouldDeepLink?: boolean;
3847
3860
  onQueryChange?: (newQueryJson: string) => void;
3861
+ /** Called when the query result rows change */
3848
3862
  onQueryResultBundleChange?: (newQueryResultBundleJson: string) => void;
3849
3863
  lockedColumn?: LockedColumn;
3850
3864
  onViewSharingSettingsClicked?: (benefactorId: string) => void;
@@ -4207,13 +4221,12 @@ export declare type SkeletonParagraphProps = {
4207
4221
  *
4208
4222
  * Implemented using CSS grid.
4209
4223
  */
4210
- export declare const SkeletonTable: default_2.FC<SkeletonTableProps>;
4224
+ export declare function SkeletonTable(props: SkeletonTableProps): default_2.JSX.Element;
4211
4225
 
4212
- export declare type SkeletonTableProps = {
4226
+ export declare type SkeletonTableProps = BoxProps & {
4213
4227
  numRows?: number;
4214
4228
  numCols?: number;
4215
4229
  rowHeight?: string;
4216
- className?: string;
4217
4230
  fullWidthCells?: boolean;
4218
4231
  };
4219
4232
 
@@ -4270,7 +4283,7 @@ declare type StandaloneQueryWrapperOwnProps = {
4270
4283
  searchConfiguration?: Omit<SearchV2Props, 'queryContext' | 'queryVisualizationContext'>;
4271
4284
  } & TopLevelControlsProps & Pick<QueryVisualizationWrapperProps, 'rgbIndex' | 'unitDescription' | 'columnAliases' | 'noContentPlaceholderType' | 'showLastUpdatedOn' | 'visibleColumnCount' | 'additionalFiltersSessionStorageKey'> & Pick<QueryWrapperProps, 'fileIdColumnName' | 'fileNameColumnName' | 'fileVersionColumnName'>;
4272
4285
 
4273
- export declare type StandaloneQueryWrapperProps = SynapseTableProps & SearchParams & Operator & StandaloneQueryWrapperOwnProps;
4286
+ export declare type StandaloneQueryWrapperProps = SynapseTableConfiguration & SearchParams & Operator & StandaloneQueryWrapperOwnProps;
4274
4287
 
4275
4288
  /**
4276
4289
  * https://rest-docs.synapse.org/rest/POST/2fa/enroll.html
@@ -4545,6 +4558,7 @@ declare namespace SynapseClient {
4545
4558
  rejectFormData,
4546
4559
  getProjectStatistics,
4547
4560
  getRestrictionInformation,
4561
+ getRestrictionInformationBatch,
4548
4562
  getAccessRequirement,
4549
4563
  getAccessRequirementById,
4550
4564
  createAccessRequirement,
@@ -4801,8 +4815,6 @@ declare namespace SynapseComponents {
4801
4815
  QueryContextProvider,
4802
4816
  QueryContextConsumer,
4803
4817
  useQueryContext,
4804
- useInfiniteQueryContext,
4805
- usePaginatedQueryContext,
4806
4818
  QueryContextProviderProps,
4807
4819
  QueryContextType,
4808
4820
  QueryCount,
@@ -4849,7 +4861,7 @@ declare namespace SynapseComponents {
4849
4861
  SynapseFormSubmissionGrid,
4850
4862
  SynapseFormSubmissionGridProps,
4851
4863
  SynapseTable,
4852
- SynapseTableProps,
4864
+ SynapseTableConfiguration,
4853
4865
  NoContentPlaceholderType,
4854
4866
  CustomControlCallbackData,
4855
4867
  SystemUseNotification,
@@ -4906,6 +4918,7 @@ declare namespace SynapseConstants {
4906
4918
  BUNDLE_MASK_LAST_UPDATED_ON,
4907
4919
  BUNDLE_MASK_COMBINED_SQL,
4908
4920
  BUNDLE_MASK_ACTIONS_REQUIRED,
4921
+ ALL_QUERY_BUNDLE_PARTS,
4909
4922
  STUDY,
4910
4923
  VALUE_NOT_SET,
4911
4924
  FRIENDLY_VALUE_NOT_SET,
@@ -5283,7 +5296,6 @@ declare namespace SynapseQueries {
5283
5296
  useCreateAccessRequirementACL,
5284
5297
  useUpdateAccessRequirementACL,
5285
5298
  useSearchAccessRequirementsInfinite,
5286
- useGetRestrictionInformation,
5287
5299
  useCreateLockAccessRequirement,
5288
5300
  useGetAccessRequirementStatus,
5289
5301
  useGetAccessRequirementStatuses,
@@ -5295,6 +5307,8 @@ declare namespace SynapseQueries {
5295
5307
  useCreateAccessApproval,
5296
5308
  useCancelDataAccessRequest,
5297
5309
  useGetApprovedSubmissionInfoInfinite,
5310
+ useGetRestrictionInformation,
5311
+ useGetRestrictionInformationBatch,
5298
5312
  useGetAvailableFilesToDownload,
5299
5313
  useGetAvailableFilesToDownloadInfinite,
5300
5314
  useGetAllDownloadListActionsRequired,
@@ -5336,9 +5350,12 @@ declare namespace SynapseQueries {
5336
5350
  useGetEntityForum,
5337
5351
  useGetEntityHeaders,
5338
5352
  useGetEntityHeader,
5353
+ useGetQueryRows,
5354
+ useGetQueryStats,
5339
5355
  useGetQueryResultBundleWithAsyncStatus,
5340
- useInfiniteQueryResultBundle,
5356
+ getInfiniteQueryResultBundleOptions,
5341
5357
  useGetFullTableQueryResults,
5358
+ tableQueryUseQueryDefaults,
5342
5359
  useGetSchema,
5343
5360
  useGetFeatureFlag,
5344
5361
  useGetStablePresignedUrl,
@@ -5408,7 +5425,13 @@ export { SynapseQueries }
5408
5425
 
5409
5426
  export declare function SynapseTable(props: SynapseTableProps): default_2.JSX.Element;
5410
5427
 
5411
- export declare type SynapseTableProps = {
5428
+ export declare type SynapseTableConfiguration = Pick<SynapseTableProps, 'showAccessColumn' | 'showDownloadColumn' | 'hideDownload' | 'showDirectDownloadColumn' | 'hideAddToDownloadListColumn' | 'columnLinks'>;
5429
+
5430
+ declare type SynapseTableProps = {
5431
+ /** The row data shown in the table. */
5432
+ rowSet: RowSet;
5433
+ /** Whether a new page of data is being loaded */
5434
+ isLoadingNewPage: boolean;
5412
5435
  /** If true and entity is a view or dataset, renders a column that represents if the caller has permission to download the entity represented by the row */
5413
5436
  showAccessColumn?: boolean;
5414
5437
  /** @deprecated use showDirectDownloadColumn */
@@ -5443,9 +5466,9 @@ export declare const SynapseToastContainer: default_2.FunctionComponent;
5443
5466
 
5444
5467
  declare namespace SynapseUtilityFunctions {
5445
5468
  export {
5446
- getNextPageOfData,
5447
5469
  getAdditionalFilters,
5448
5470
  parseEntityIdFromSqlStatement,
5471
+ parseEntityIdAndVersionFromSqlStatement,
5449
5472
  getIgnoredQueryFilterSearchParamKey,
5450
5473
  resultToJson,
5451
5474
  hex2ascii,
@@ -5469,6 +5492,16 @@ export declare type TableFeedCardsProps = {
5469
5492
  tableEntityId: string;
5470
5493
  };
5471
5494
 
5495
+ declare const tableQueryUseQueryDefaults: {
5496
+ staleTime: number;
5497
+ };
5498
+
5499
+ declare type TableQueryUseQueryOptions = {
5500
+ rowDataQueryOptions: UseQueryOptions<AsynchronousJobStatus<QueryBundleRequest, QueryResultBundle>, SynapseClientError, RowSet | undefined>;
5501
+ rowDataInfiniteQueryOptions: UseInfiniteQueryOptions<AsynchronousJobStatus<QueryBundleRequest, QueryResultBundle>, SynapseClientError, InfiniteData<AsynchronousJobStatus<QueryBundleRequest, QueryResultBundle>>, AsynchronousJobStatus<QueryBundleRequest, QueryResultBundle>, QueryKey, string | number | undefined>;
5502
+ queryMetadataQueryOptions: UseQueryOptions<AsynchronousJobStatus<QueryBundleRequest, QueryResultBundle>, SynapseClientError, Omit<QueryResultBundle, 'queryResult'>>;
5503
+ };
5504
+
5472
5505
  export declare const TableRowFallbackComponent: default_2.FunctionComponent<FallbackProps>;
5473
5506
 
5474
5507
  export declare enum TargetEnum {
@@ -6063,10 +6096,16 @@ declare function useGetProjectsInfinite<TData = InfiniteData<ProjectHeaderList>>
6063
6096
 
6064
6097
  declare function useGetQueryResultBundleWithAsyncStatus<TData = AsynchronousJobStatus<QueryBundleRequest, QueryResultBundle>>(queryBundleRequest: QueryBundleRequest, options?: Partial<UseQueryOptions<AsynchronousJobStatus<QueryBundleRequest, QueryResultBundle>, SynapseClientError, TData>>, setCurrentAsyncStatus?: (status: AsynchronousJobStatus<QueryBundleRequest, QueryResultBundle>) => void): UseQueryResultMergeableProperties<TData, SynapseClientError>;
6065
6098
 
6099
+ declare function useGetQueryRows<TData = AsynchronousJobStatus<QueryBundleRequest, QueryResultBundle>>(queryBundleRequest: QueryBundleRequest, options?: Partial<UseQueryOptions<AsynchronousJobStatus<QueryBundleRequest, QueryResultBundle>, SynapseClientError, TData>>, setCurrentAsyncStatus?: (status: AsynchronousJobStatus<QueryBundleRequest, QueryResultBundle>) => void): UseQueryResult<TData, SynapseClientError>;
6100
+
6101
+ declare function useGetQueryStats<TData = AsynchronousJobStatus<QueryBundleRequest, QueryResultBundle>>(queryBundleRequest: QueryBundleRequest, options?: Partial<UseQueryOptions<AsynchronousJobStatus<QueryBundleRequest, QueryResultBundle>, SynapseClientError, TData>>, setCurrentAsyncStatus?: (status: AsynchronousJobStatus<QueryBundleRequest, QueryResultBundle>) => void): UseQueryResult<TData, SynapseClientError>;
6102
+
6066
6103
  declare function useGetResearchProject(accessRequirementId: string, options?: Partial<UseQueryOptions<ResearchProject, SynapseClientError>>): UseQueryResult<ResearchProject, SynapseClientError>;
6067
6104
 
6068
6105
  declare function useGetRestrictionInformation(request: RestrictionInformationRequest, options?: Partial<UseQueryOptions<RestrictionInformationResponse, SynapseClientError>>): UseQueryResult<RestrictionInformationResponse, SynapseClientError>;
6069
6106
 
6107
+ declare function useGetRestrictionInformationBatch(request: RestrictionInformationBatchRequest, options?: Partial<UseQueryOptions<RestrictionInformationBatchResponse, SynapseClientError>>): UseQueryResult<RestrictionInformationBatchResponse, SynapseClientError>;
6108
+
6070
6109
  declare const useGetRootWikiPageKey: (ownerObjectType: ObjectType, ownerObjectId: string, options?: Partial<UseQueryOptions<WikiPageKey | null, SynapseClientError>>) => UseQueryResult<WikiPageKey | null, SynapseClientError>;
6071
6110
 
6072
6111
  declare function useGetSchema(schema$id: string, options?: Partial<UseQueryOptions<JSONSchema7, SynapseClientError>>): UseQueryResult<JSONSchema7, SynapseClientError>;
@@ -6129,10 +6168,6 @@ declare const useGetWikiPage: (wikiPageKey: WikiPageKey, options?: Partial<UseQu
6129
6168
 
6130
6169
  declare const useGoogleAnalytics: (measurementId?: string) => boolean;
6131
6170
 
6132
- export declare function useInfiniteQueryContext(): InfiniteQueryContextType;
6133
-
6134
- declare function useInfiniteQueryResultBundle<TData = InfiniteData<AsynchronousJobStatus<QueryBundleRequest, QueryResultBundle>>>(queryBundleRequest: QueryBundleRequest, options?: Omit<Partial<UseInfiniteQueryOptions<AsynchronousJobStatus<QueryBundleRequest, QueryResultBundle>, SynapseClientError, TData, AsynchronousJobStatus<QueryBundleRequest, QueryResultBundle>, QueryKey, string | number | undefined>>, 'select'>, setCurrentAsyncStatus?: (status: AsynchronousJobStatus<QueryBundleRequest, QueryResultBundle>) => void): UseInfiniteQueryResult<TData, SynapseClientError>;
6135
-
6136
6171
  declare function useInviteUserToTeam(options?: Partial<UseMutationOptions<MembershipInvitation, SynapseClientError, CreateMembershipInvitationRequest>>): UseMutationResult<MembershipInvitation, SynapseClientError, CreateMembershipInvitationRequest, unknown>;
6137
6172
 
6138
6173
  declare function useIsCurrentUserACTMember(): UseQueryResult<boolean, SynapseClientError>;
@@ -6250,8 +6285,6 @@ declare function useOverlay(children: JSX.Element, targetRef: RefObject<any>, de
6250
6285
  toggle: (show?: boolean, withDelay?: boolean) => void;
6251
6286
  };
6252
6287
 
6253
- export declare function usePaginatedQueryContext(): PaginatedQueryContextType;
6254
-
6255
6288
  /**
6256
6289
  * Returns the QueryContext, including QueryResultBundle
6257
6290
  *
@@ -6260,7 +6293,7 @@ export declare function usePaginatedQueryContext(): PaginatedQueryContextType;
6260
6293
  * @template ExcludeOtherFields - If set to true, will remove optional fields besides those specified in TIncludedFields,
6261
6294
  * default false
6262
6295
  */
6263
- export declare function useQueryContext<TIncludedFields extends OptionalQueryBundleRequestFields = never, ExcludeOtherFields extends true | false = false>(): QueryContextType<TIncludedFields, ExcludeOtherFields>;
6296
+ export declare function useQueryContext(): QueryContextType;
6264
6297
 
6265
6298
  /**
6266
6299
  * The set of properties returned by UseQuery where the results can be safely merged and memoized
@@ -6300,11 +6333,11 @@ export declare class UserCardList extends default_2.Component<UserCardListProps,
6300
6333
  /**
6301
6334
  * Given data this will find rows where there is no userId columnType and create faux user profiles
6302
6335
  * using firstName, lastName, and institution (company in UserProfile object).
6303
- * @param {QueryResultBundle} data
6336
+ * @param {RowSet} rowSet
6304
6337
  * @returns list of UserProfiles with firstName, lastName, company, userName (first letter of firstName) filled out.
6305
6338
  * @memberof UserCardList
6306
6339
  */
6307
- manuallyExtractData(data: QueryResultBundle): Omit<UserProfile, "ownerId">[];
6340
+ manuallyExtractData(rowSet: RowSet): Omit<UserProfile, "ownerId">[];
6308
6341
  render(): default_2.JSX.Element;
6309
6342
  }
6310
6343
 
@@ -6324,7 +6357,7 @@ export declare type UserCardListGroupsProps = {
6324
6357
  export declare type UserCardListProps = {
6325
6358
  list: (string | null)[];
6326
6359
  size?: UserCardSize;
6327
- data?: QueryResultBundle;
6360
+ rowSet?: RowSet;
6328
6361
  };
6329
6362
 
6330
6363
  export declare const UserCardListRotate: default_2.FunctionComponent<UserCardListRotateProps>;