synapse-react-client 3.3.7 → 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/assets/homepage/research-credit-feature.svg +10 -10
- package/dist/index.cjs +24 -24
- package/dist/index.d.ts +115 -78
- package/dist/index.js +17196 -16783
- package/dist/style/base/_core.scss +0 -43
- package/dist/style/components/_query-wrapper-plot-nav.scss +5 -4
- package/dist/style/components/query_filter/_facet-chip.scss +6 -0
- package/dist/umd/synapse-react-client.development.css +11 -40
- package/dist/umd/synapse-react-client.development.js +8061 -7521
- package/dist/umd/synapse-react-client.production.min.css +1 -1
- package/dist/umd/synapse-react-client.production.min.js +195 -195
- package/package.json +3 -3
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
|
|
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
|
-
|
|
1009
|
+
tableId: string;
|
|
1010
|
+
queryMetadata: Omit<QueryResultBundle, 'queryResult'> | undefined;
|
|
1004
1011
|
selectedRows: Row[] | undefined;
|
|
1005
1012
|
refresh: () => void;
|
|
1006
1013
|
request?: QueryBundleRequest;
|
|
@@ -1528,7 +1535,11 @@ declare const EXPERIMENTAL_MODE_COOKIE = "SynapseTestWebsite";
|
|
|
1528
1535
|
|
|
1529
1536
|
declare const EXPERIMENTAL_TOOL: string;
|
|
1530
1537
|
|
|
1531
|
-
export declare const ExperimentalMode: default_2.
|
|
1538
|
+
export declare const ExperimentalMode: default_2.FunctionComponent<ExperimentalModeProps>;
|
|
1539
|
+
|
|
1540
|
+
declare type ExperimentalModeProps = {
|
|
1541
|
+
onExperimentalModeToggle?: (newValue: boolean) => void;
|
|
1542
|
+
};
|
|
1532
1543
|
|
|
1533
1544
|
declare const EXPLORE: string;
|
|
1534
1545
|
|
|
@@ -2214,6 +2225,8 @@ declare const getGroupHeadersBatch: (ids: string[]) => Promise<UserGroupHeaderRe
|
|
|
2214
2225
|
|
|
2215
2226
|
declare const getIgnoredQueryFilterSearchParamKey: (key: string, namespace?: string) => string;
|
|
2216
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
|
+
|
|
2217
2230
|
declare const getInviteeVerificationSignedToken: (membershipInvitationId: string, accessToken: string) => Promise<InviteeVerificationSignedToken>;
|
|
2218
2231
|
|
|
2219
2232
|
/**
|
|
@@ -2275,14 +2288,6 @@ declare const getMyProjects: (accessToken: string, params?: GetProjectsParameter
|
|
|
2275
2288
|
*/
|
|
2276
2289
|
declare const getMyUserBundle: (mask: number, accessToken: string | undefined) => Promise<UserBundle>;
|
|
2277
2290
|
|
|
2278
|
-
/**
|
|
2279
|
-
* Grab the next page of data, pulling in 25 more rows.
|
|
2280
|
-
*
|
|
2281
|
-
* @param {*} queryRequest Query request as specified by
|
|
2282
|
-
* https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/table/Query.html
|
|
2283
|
-
*/
|
|
2284
|
-
declare const getNextPageOfData: (queryRequest: QueryBundleRequest, data: QueryResultBundle, token?: string) => Promise<PartialStateObject>;
|
|
2285
|
-
|
|
2286
2291
|
/**
|
|
2287
2292
|
* This service returns the email used for user notifications, i.e. when a Synapse message
|
|
2288
2293
|
* is sent and if the user has elected to receive messages by email, then this is the
|
|
@@ -2402,6 +2407,13 @@ declare const getResearchProject: (requirementId: string, accessToken: string) =
|
|
|
2402
2407
|
|
|
2403
2408
|
declare const getRestrictionInformation: (request: RestrictionInformationRequest, accessToken: string | undefined) => Promise<RestrictionInformationResponse>;
|
|
2404
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
|
+
|
|
2405
2417
|
declare function getRootURL(): string;
|
|
2406
2418
|
|
|
2407
2419
|
/**
|
|
@@ -2681,7 +2693,6 @@ export declare function HasAccess(props: HasAccessProps): default_2.JSX.Element;
|
|
|
2681
2693
|
export declare type HasAccessProps = {
|
|
2682
2694
|
onHide?: () => void;
|
|
2683
2695
|
entityId: string;
|
|
2684
|
-
entityVersionNumber?: string;
|
|
2685
2696
|
className?: string;
|
|
2686
2697
|
showButtonText?: boolean;
|
|
2687
2698
|
};
|
|
@@ -2798,21 +2809,6 @@ export declare const implementsExternalFileHandleInterface: (object: {
|
|
|
2798
2809
|
concreteType: string;
|
|
2799
2810
|
}) => object is ExternalFileHandleInterface;
|
|
2800
2811
|
|
|
2801
|
-
declare type InfiniteQueryContextType<TIncludedFields extends OptionalQueryBundleRequestFields = never, ExcludeOtherFields extends true | false = false> = QueryContextType<TIncludedFields, ExcludeOtherFields> & {
|
|
2802
|
-
/** Returns true when loading a new page of query results */
|
|
2803
|
-
isLoadingNewPage: boolean;
|
|
2804
|
-
/** Whether the query result bundle has a next page */
|
|
2805
|
-
hasNextPage?: boolean;
|
|
2806
|
-
/** Invoke this method to fetch and append the next page of rows to the data */
|
|
2807
|
-
appendNextPageToResults: () => Promise<void>;
|
|
2808
|
-
/** Invoke to fetch and update the data with the next page of query results */
|
|
2809
|
-
goToNextPage: () => Promise<void>;
|
|
2810
|
-
/** Whether the query result bundle has a previous page */
|
|
2811
|
-
hasPreviousPage: boolean;
|
|
2812
|
-
/** Invoke to fetch and update the data with the previous page of query results */
|
|
2813
|
-
goToPreviousPage: () => Promise<void>;
|
|
2814
|
-
};
|
|
2815
|
-
|
|
2816
2812
|
export declare const InputSizedButton: StyledComponent<ButtonProps>;
|
|
2817
2813
|
|
|
2818
2814
|
/**
|
|
@@ -2972,7 +2968,8 @@ declare class KeyFactory {
|
|
|
2972
2968
|
getAccessRequirementAclQueryKey(id: string): QueryKey;
|
|
2973
2969
|
searchAccessRequirementsQueryKey(params?: AccessRequirementSearchRequest): QueryKey;
|
|
2974
2970
|
getAccessRequirementWikiPageKey(id: string): QueryKey;
|
|
2975
|
-
|
|
2971
|
+
getRestrictionInformationQueryKey(request: RestrictionInformationRequest): QueryKey;
|
|
2972
|
+
getRestrictionInformationBatchQueryKey(request: RestrictionInformationBatchRequest): QueryKey;
|
|
2976
2973
|
getAllAccessRequirementStatusesQueryKey(): QueryKey;
|
|
2977
2974
|
getAccessRequirementStatusQueryKey(id: string): QueryKey;
|
|
2978
2975
|
getDataAccessRequestForUpdateQueryKey(accessRequirementId: string): QueryKey;
|
|
@@ -3401,8 +3398,6 @@ declare type Operator = {
|
|
|
3401
3398
|
*/
|
|
3402
3399
|
declare type Optional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
|
|
3403
3400
|
|
|
3404
|
-
declare type OptionalQueryBundleRequestFields = keyof Pick<QueryResultBundle, 'queryResult' | 'queryCount' | 'selectColumns' | 'maxRowsPerPage' | 'columnModels' | 'facets' | 'sumFileSizes' | 'combinedSql'>;
|
|
3405
|
-
|
|
3406
3401
|
declare const ORGANIZATION: string;
|
|
3407
3402
|
|
|
3408
3403
|
export declare const ORIENTATION_BANNER_KEYS: string[];
|
|
@@ -3422,17 +3417,6 @@ export declare interface OrientationBannerProps {
|
|
|
3422
3417
|
sx?: FullWidthAlertProps['sx'];
|
|
3423
3418
|
}
|
|
3424
3419
|
|
|
3425
|
-
declare type PaginatedQueryContextType<TIncludedFields extends OptionalQueryBundleRequestFields = never, ExcludeOtherFields extends true | false = false> = QueryContextType<TIncludedFields, ExcludeOtherFields> & {
|
|
3426
|
-
/** Navigates to a particular page, where the first page has value 1 */
|
|
3427
|
-
goToPage: (pageNum: number) => void;
|
|
3428
|
-
/** The current page number, where page 1 is the first page. */
|
|
3429
|
-
currentPage: number;
|
|
3430
|
-
/** Updates the page size */
|
|
3431
|
-
setPageSize: (pageSize: number) => void;
|
|
3432
|
-
/** The current page size. */
|
|
3433
|
-
pageSize: number;
|
|
3434
|
-
};
|
|
3435
|
-
|
|
3436
3420
|
export declare const Palettes: {
|
|
3437
3421
|
palette: PaletteOptions;
|
|
3438
3422
|
generatePalette: (mainColor: default_4.ColorInput, specificColors?: PaletteColorOptions) => PaletteColorOptions;
|
|
@@ -3452,6 +3436,11 @@ export declare const Palettes: {
|
|
|
3452
3436
|
geniePalette: PaletteOptions;
|
|
3453
3437
|
};
|
|
3454
3438
|
|
|
3439
|
+
declare const parseEntityIdAndVersionFromSqlStatement: (sql: string) => {
|
|
3440
|
+
entityId: string;
|
|
3441
|
+
versionNumber?: number;
|
|
3442
|
+
} | null;
|
|
3443
|
+
|
|
3455
3444
|
declare const parseEntityIdFromSqlStatement: (sql: string) => string;
|
|
3456
3445
|
|
|
3457
3446
|
/**
|
|
@@ -3462,11 +3451,6 @@ declare const parseEntityIdFromSqlStatement: (sql: string) => string;
|
|
|
3462
3451
|
*/
|
|
3463
3452
|
declare function parseSynId(synId: string): Reference | null;
|
|
3464
3453
|
|
|
3465
|
-
declare type PartialStateObject = {
|
|
3466
|
-
hasMoreData: boolean;
|
|
3467
|
-
data: QueryResultBundle;
|
|
3468
|
-
};
|
|
3469
|
-
|
|
3470
3454
|
export declare function PasswordField(props: TextFieldProps_2): default_2.JSX.Element;
|
|
3471
3455
|
|
|
3472
3456
|
declare type PermissionLevel = EntityPermissionsLevel | AccessRequirementPermissionsLevel;
|
|
@@ -3675,9 +3659,9 @@ declare type QueryChangeCommitOptions = {
|
|
|
3675
3659
|
/**
|
|
3676
3660
|
* This must be exported to use the context in class components.
|
|
3677
3661
|
*/
|
|
3678
|
-
export declare const QueryContext: default_2.Context<QueryContextType
|
|
3662
|
+
export declare const QueryContext: default_2.Context<QueryContextType | undefined>;
|
|
3679
3663
|
|
|
3680
|
-
export declare const QueryContextConsumer: default_2.Consumer<QueryContextType
|
|
3664
|
+
export declare const QueryContextConsumer: default_2.Consumer<QueryContextType | undefined>;
|
|
3681
3665
|
|
|
3682
3666
|
/**
|
|
3683
3667
|
* Provides data related to a Synapse table query, and functions for iterating through pages of the data.
|
|
@@ -3688,7 +3672,10 @@ export declare type QueryContextProviderProps = default_2.PropsWithChildren<{
|
|
|
3688
3672
|
queryContext: QueryContextType;
|
|
3689
3673
|
}>;
|
|
3690
3674
|
|
|
3691
|
-
export declare type QueryContextType
|
|
3675
|
+
export declare type QueryContextType = {
|
|
3676
|
+
isInfinite: boolean;
|
|
3677
|
+
entityId: string;
|
|
3678
|
+
versionNumber: number | undefined;
|
|
3692
3679
|
currentQueryRequest: ReadonlyDeep<QueryBundleRequest>;
|
|
3693
3680
|
nextQueryRequest: ReadonlyDeep<QueryBundleRequest>;
|
|
3694
3681
|
/** Returns a deep clone of the current query bundle request */
|
|
@@ -3708,18 +3695,45 @@ export declare type QueryContextType<TIncludedFields extends OptionalQueryBundle
|
|
|
3708
3695
|
removeQueryFilter: ImmutableTableQueryResult['removeQueryFilter'];
|
|
3709
3696
|
/** Removes a value from a QueryFilter. If no more values remain in the filter, the filter is also removed */
|
|
3710
3697
|
removeValueFromQueryFilter: ImmutableTableQueryResult['removeValueFromQueryFilter'];
|
|
3711
|
-
/** The error returned by the query request, if one is encountered */
|
|
3712
|
-
error: SynapseClientError | null;
|
|
3713
|
-
/** The status of the asynchronous job. */
|
|
3714
|
-
asyncJobStatus?: AsynchronousJobStatus<QueryBundleRequest, QueryResultBundle>;
|
|
3715
3698
|
/** Whether facets are available to be filtered upon based on the current data */
|
|
3716
|
-
|
|
3699
|
+
hasFacetedSelectColumn: boolean;
|
|
3717
3700
|
/** Returns true iff the current request has resettable filters applied via facet filters or additionalFilters. Excludes filters applied to a locked column */
|
|
3718
3701
|
hasResettableFilters: boolean;
|
|
3719
|
-
getColumnModel: (columnName: string) => ColumnModel | null;
|
|
3720
3702
|
onViewSharingSettingsClicked?: (benefactorId: string) => void;
|
|
3721
3703
|
/** Combines two faceted columns into a single inclusive range selector */
|
|
3722
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;
|
|
3723
3737
|
};
|
|
3724
3738
|
|
|
3725
3739
|
/**
|
|
@@ -3813,6 +3827,8 @@ declare type QueryWrapperPlotNavCustomPlotParams = {
|
|
|
3813
3827
|
};
|
|
3814
3828
|
|
|
3815
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;
|
|
3816
3832
|
sql: string;
|
|
3817
3833
|
limit?: number;
|
|
3818
3834
|
shouldDeepLink?: boolean;
|
|
@@ -3822,7 +3838,7 @@ declare type QueryWrapperPlotNavOwnProps = {
|
|
|
3822
3838
|
onQueryResultBundleChange?: (newQueryResultBundleJson: string) => void;
|
|
3823
3839
|
/** If initQueryJson is set, it will be the Query used in the initial QueryBundleRequest */
|
|
3824
3840
|
initQueryJson?: string;
|
|
3825
|
-
tableConfiguration?:
|
|
3841
|
+
tableConfiguration?: SynapseTableConfiguration;
|
|
3826
3842
|
cardConfiguration?: CardConfiguration;
|
|
3827
3843
|
searchConfiguration?: Omit<SearchV2Props, 'queryContext' | 'queryVisualizationContext'>;
|
|
3828
3844
|
facetsToPlot?: string[];
|
|
@@ -3832,6 +3848,7 @@ declare type QueryWrapperPlotNavOwnProps = {
|
|
|
3832
3848
|
defaultShowSearchBox?: boolean;
|
|
3833
3849
|
lockedColumn?: QueryWrapperProps['lockedColumn'];
|
|
3834
3850
|
onViewSharingSettingsClicked?: (benefactorId: string) => void;
|
|
3851
|
+
initialLimit?: number;
|
|
3835
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'>;
|
|
3836
3853
|
|
|
3837
3854
|
export declare type QueryWrapperPlotNavProps = SearchParams & PlotsContainerProps & Operator & QueryWrapperPlotNavOwnProps;
|
|
@@ -3841,6 +3858,7 @@ export declare type QueryWrapperProps = default_2.PropsWithChildren<{
|
|
|
3841
3858
|
componentIndex?: number;
|
|
3842
3859
|
shouldDeepLink?: boolean;
|
|
3843
3860
|
onQueryChange?: (newQueryJson: string) => void;
|
|
3861
|
+
/** Called when the query result rows change */
|
|
3844
3862
|
onQueryResultBundleChange?: (newQueryResultBundleJson: string) => void;
|
|
3845
3863
|
lockedColumn?: LockedColumn;
|
|
3846
3864
|
onViewSharingSettingsClicked?: (benefactorId: string) => void;
|
|
@@ -4203,13 +4221,12 @@ export declare type SkeletonParagraphProps = {
|
|
|
4203
4221
|
*
|
|
4204
4222
|
* Implemented using CSS grid.
|
|
4205
4223
|
*/
|
|
4206
|
-
export declare
|
|
4224
|
+
export declare function SkeletonTable(props: SkeletonTableProps): default_2.JSX.Element;
|
|
4207
4225
|
|
|
4208
|
-
export declare type SkeletonTableProps = {
|
|
4226
|
+
export declare type SkeletonTableProps = BoxProps & {
|
|
4209
4227
|
numRows?: number;
|
|
4210
4228
|
numCols?: number;
|
|
4211
4229
|
rowHeight?: string;
|
|
4212
|
-
className?: string;
|
|
4213
4230
|
fullWidthCells?: boolean;
|
|
4214
4231
|
};
|
|
4215
4232
|
|
|
@@ -4266,7 +4283,7 @@ declare type StandaloneQueryWrapperOwnProps = {
|
|
|
4266
4283
|
searchConfiguration?: Omit<SearchV2Props, 'queryContext' | 'queryVisualizationContext'>;
|
|
4267
4284
|
} & TopLevelControlsProps & Pick<QueryVisualizationWrapperProps, 'rgbIndex' | 'unitDescription' | 'columnAliases' | 'noContentPlaceholderType' | 'showLastUpdatedOn' | 'visibleColumnCount' | 'additionalFiltersSessionStorageKey'> & Pick<QueryWrapperProps, 'fileIdColumnName' | 'fileNameColumnName' | 'fileVersionColumnName'>;
|
|
4268
4285
|
|
|
4269
|
-
export declare type StandaloneQueryWrapperProps =
|
|
4286
|
+
export declare type StandaloneQueryWrapperProps = SynapseTableConfiguration & SearchParams & Operator & StandaloneQueryWrapperOwnProps;
|
|
4270
4287
|
|
|
4271
4288
|
/**
|
|
4272
4289
|
* https://rest-docs.synapse.org/rest/POST/2fa/enroll.html
|
|
@@ -4541,6 +4558,7 @@ declare namespace SynapseClient {
|
|
|
4541
4558
|
rejectFormData,
|
|
4542
4559
|
getProjectStatistics,
|
|
4543
4560
|
getRestrictionInformation,
|
|
4561
|
+
getRestrictionInformationBatch,
|
|
4544
4562
|
getAccessRequirement,
|
|
4545
4563
|
getAccessRequirementById,
|
|
4546
4564
|
createAccessRequirement,
|
|
@@ -4797,8 +4815,6 @@ declare namespace SynapseComponents {
|
|
|
4797
4815
|
QueryContextProvider,
|
|
4798
4816
|
QueryContextConsumer,
|
|
4799
4817
|
useQueryContext,
|
|
4800
|
-
useInfiniteQueryContext,
|
|
4801
|
-
usePaginatedQueryContext,
|
|
4802
4818
|
QueryContextProviderProps,
|
|
4803
4819
|
QueryContextType,
|
|
4804
4820
|
QueryCount,
|
|
@@ -4845,7 +4861,7 @@ declare namespace SynapseComponents {
|
|
|
4845
4861
|
SynapseFormSubmissionGrid,
|
|
4846
4862
|
SynapseFormSubmissionGridProps,
|
|
4847
4863
|
SynapseTable,
|
|
4848
|
-
|
|
4864
|
+
SynapseTableConfiguration,
|
|
4849
4865
|
NoContentPlaceholderType,
|
|
4850
4866
|
CustomControlCallbackData,
|
|
4851
4867
|
SystemUseNotification,
|
|
@@ -4902,6 +4918,7 @@ declare namespace SynapseConstants {
|
|
|
4902
4918
|
BUNDLE_MASK_LAST_UPDATED_ON,
|
|
4903
4919
|
BUNDLE_MASK_COMBINED_SQL,
|
|
4904
4920
|
BUNDLE_MASK_ACTIONS_REQUIRED,
|
|
4921
|
+
ALL_QUERY_BUNDLE_PARTS,
|
|
4905
4922
|
STUDY,
|
|
4906
4923
|
VALUE_NOT_SET,
|
|
4907
4924
|
FRIENDLY_VALUE_NOT_SET,
|
|
@@ -5279,7 +5296,6 @@ declare namespace SynapseQueries {
|
|
|
5279
5296
|
useCreateAccessRequirementACL,
|
|
5280
5297
|
useUpdateAccessRequirementACL,
|
|
5281
5298
|
useSearchAccessRequirementsInfinite,
|
|
5282
|
-
useGetRestrictionInformation,
|
|
5283
5299
|
useCreateLockAccessRequirement,
|
|
5284
5300
|
useGetAccessRequirementStatus,
|
|
5285
5301
|
useGetAccessRequirementStatuses,
|
|
@@ -5291,6 +5307,8 @@ declare namespace SynapseQueries {
|
|
|
5291
5307
|
useCreateAccessApproval,
|
|
5292
5308
|
useCancelDataAccessRequest,
|
|
5293
5309
|
useGetApprovedSubmissionInfoInfinite,
|
|
5310
|
+
useGetRestrictionInformation,
|
|
5311
|
+
useGetRestrictionInformationBatch,
|
|
5294
5312
|
useGetAvailableFilesToDownload,
|
|
5295
5313
|
useGetAvailableFilesToDownloadInfinite,
|
|
5296
5314
|
useGetAllDownloadListActionsRequired,
|
|
@@ -5332,9 +5350,12 @@ declare namespace SynapseQueries {
|
|
|
5332
5350
|
useGetEntityForum,
|
|
5333
5351
|
useGetEntityHeaders,
|
|
5334
5352
|
useGetEntityHeader,
|
|
5353
|
+
useGetQueryRows,
|
|
5354
|
+
useGetQueryStats,
|
|
5335
5355
|
useGetQueryResultBundleWithAsyncStatus,
|
|
5336
|
-
|
|
5356
|
+
getInfiniteQueryResultBundleOptions,
|
|
5337
5357
|
useGetFullTableQueryResults,
|
|
5358
|
+
tableQueryUseQueryDefaults,
|
|
5338
5359
|
useGetSchema,
|
|
5339
5360
|
useGetFeatureFlag,
|
|
5340
5361
|
useGetStablePresignedUrl,
|
|
@@ -5404,7 +5425,13 @@ export { SynapseQueries }
|
|
|
5404
5425
|
|
|
5405
5426
|
export declare function SynapseTable(props: SynapseTableProps): default_2.JSX.Element;
|
|
5406
5427
|
|
|
5407
|
-
export declare type
|
|
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;
|
|
5408
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 */
|
|
5409
5436
|
showAccessColumn?: boolean;
|
|
5410
5437
|
/** @deprecated use showDirectDownloadColumn */
|
|
@@ -5439,9 +5466,9 @@ export declare const SynapseToastContainer: default_2.FunctionComponent;
|
|
|
5439
5466
|
|
|
5440
5467
|
declare namespace SynapseUtilityFunctions {
|
|
5441
5468
|
export {
|
|
5442
|
-
getNextPageOfData,
|
|
5443
5469
|
getAdditionalFilters,
|
|
5444
5470
|
parseEntityIdFromSqlStatement,
|
|
5471
|
+
parseEntityIdAndVersionFromSqlStatement,
|
|
5445
5472
|
getIgnoredQueryFilterSearchParamKey,
|
|
5446
5473
|
resultToJson,
|
|
5447
5474
|
hex2ascii,
|
|
@@ -5465,6 +5492,16 @@ export declare type TableFeedCardsProps = {
|
|
|
5465
5492
|
tableEntityId: string;
|
|
5466
5493
|
};
|
|
5467
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
|
+
|
|
5468
5505
|
export declare const TableRowFallbackComponent: default_2.FunctionComponent<FallbackProps>;
|
|
5469
5506
|
|
|
5470
5507
|
export declare enum TargetEnum {
|
|
@@ -6059,10 +6096,16 @@ declare function useGetProjectsInfinite<TData = InfiniteData<ProjectHeaderList>>
|
|
|
6059
6096
|
|
|
6060
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>;
|
|
6061
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
|
+
|
|
6062
6103
|
declare function useGetResearchProject(accessRequirementId: string, options?: Partial<UseQueryOptions<ResearchProject, SynapseClientError>>): UseQueryResult<ResearchProject, SynapseClientError>;
|
|
6063
6104
|
|
|
6064
6105
|
declare function useGetRestrictionInformation(request: RestrictionInformationRequest, options?: Partial<UseQueryOptions<RestrictionInformationResponse, SynapseClientError>>): UseQueryResult<RestrictionInformationResponse, SynapseClientError>;
|
|
6065
6106
|
|
|
6107
|
+
declare function useGetRestrictionInformationBatch(request: RestrictionInformationBatchRequest, options?: Partial<UseQueryOptions<RestrictionInformationBatchResponse, SynapseClientError>>): UseQueryResult<RestrictionInformationBatchResponse, SynapseClientError>;
|
|
6108
|
+
|
|
6066
6109
|
declare const useGetRootWikiPageKey: (ownerObjectType: ObjectType, ownerObjectId: string, options?: Partial<UseQueryOptions<WikiPageKey | null, SynapseClientError>>) => UseQueryResult<WikiPageKey | null, SynapseClientError>;
|
|
6067
6110
|
|
|
6068
6111
|
declare function useGetSchema(schema$id: string, options?: Partial<UseQueryOptions<JSONSchema7, SynapseClientError>>): UseQueryResult<JSONSchema7, SynapseClientError>;
|
|
@@ -6125,10 +6168,6 @@ declare const useGetWikiPage: (wikiPageKey: WikiPageKey, options?: Partial<UseQu
|
|
|
6125
6168
|
|
|
6126
6169
|
declare const useGoogleAnalytics: (measurementId?: string) => boolean;
|
|
6127
6170
|
|
|
6128
|
-
export declare function useInfiniteQueryContext(): InfiniteQueryContextType;
|
|
6129
|
-
|
|
6130
|
-
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>;
|
|
6131
|
-
|
|
6132
6171
|
declare function useInviteUserToTeam(options?: Partial<UseMutationOptions<MembershipInvitation, SynapseClientError, CreateMembershipInvitationRequest>>): UseMutationResult<MembershipInvitation, SynapseClientError, CreateMembershipInvitationRequest, unknown>;
|
|
6133
6172
|
|
|
6134
6173
|
declare function useIsCurrentUserACTMember(): UseQueryResult<boolean, SynapseClientError>;
|
|
@@ -6246,8 +6285,6 @@ declare function useOverlay(children: JSX.Element, targetRef: RefObject<any>, de
|
|
|
6246
6285
|
toggle: (show?: boolean, withDelay?: boolean) => void;
|
|
6247
6286
|
};
|
|
6248
6287
|
|
|
6249
|
-
export declare function usePaginatedQueryContext(): PaginatedQueryContextType;
|
|
6250
|
-
|
|
6251
6288
|
/**
|
|
6252
6289
|
* Returns the QueryContext, including QueryResultBundle
|
|
6253
6290
|
*
|
|
@@ -6256,7 +6293,7 @@ export declare function usePaginatedQueryContext(): PaginatedQueryContextType;
|
|
|
6256
6293
|
* @template ExcludeOtherFields - If set to true, will remove optional fields besides those specified in TIncludedFields,
|
|
6257
6294
|
* default false
|
|
6258
6295
|
*/
|
|
6259
|
-
export declare function useQueryContext
|
|
6296
|
+
export declare function useQueryContext(): QueryContextType;
|
|
6260
6297
|
|
|
6261
6298
|
/**
|
|
6262
6299
|
* The set of properties returned by UseQuery where the results can be safely merged and memoized
|
|
@@ -6296,11 +6333,11 @@ export declare class UserCardList extends default_2.Component<UserCardListProps,
|
|
|
6296
6333
|
/**
|
|
6297
6334
|
* Given data this will find rows where there is no userId columnType and create faux user profiles
|
|
6298
6335
|
* using firstName, lastName, and institution (company in UserProfile object).
|
|
6299
|
-
* @param {
|
|
6336
|
+
* @param {RowSet} rowSet
|
|
6300
6337
|
* @returns list of UserProfiles with firstName, lastName, company, userName (first letter of firstName) filled out.
|
|
6301
6338
|
* @memberof UserCardList
|
|
6302
6339
|
*/
|
|
6303
|
-
manuallyExtractData(
|
|
6340
|
+
manuallyExtractData(rowSet: RowSet): Omit<UserProfile, "ownerId">[];
|
|
6304
6341
|
render(): default_2.JSX.Element;
|
|
6305
6342
|
}
|
|
6306
6343
|
|
|
@@ -6320,7 +6357,7 @@ export declare type UserCardListGroupsProps = {
|
|
|
6320
6357
|
export declare type UserCardListProps = {
|
|
6321
6358
|
list: (string | null)[];
|
|
6322
6359
|
size?: UserCardSize;
|
|
6323
|
-
|
|
6360
|
+
rowSet?: RowSet;
|
|
6324
6361
|
};
|
|
6325
6362
|
|
|
6326
6363
|
export declare const UserCardListRotate: default_2.FunctionComponent<UserCardListRotateProps>;
|