@rcsb/rcsb-saguaro-app 5.0.8 → 5.1.0

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.
@@ -1,6 +1,6 @@
1
1
  import { ChartMapType } from "./GroupChartLayout";
2
2
  export interface GroupChartAdditionalProperties {
3
- componentMountCallback(chartMap: ChartMapType, layout: string[]): void;
3
+ componentMountCallback(chartMap?: ChartMapType, layout?: string[]): void;
4
4
  layoutConfig: LayoutConfigInterface;
5
5
  }
6
6
  export interface LayoutConfigInterface {
@@ -2,5 +2,6 @@ import { GroupProvenanceId } from "@rcsb/rcsb-api-tools/build/RcsbDw/Types/DwEnu
2
2
  import { SearchQuery } from "@rcsb/rcsb-api-tools/build/RcsbSearch/Types/SearchQueryInterface";
3
3
  import { ChartMapType } from "./GroupChartLayout";
4
4
  export declare namespace GroupChartMap {
5
+ type ChartObjectIdType = "included" | "excluded";
5
6
  function getChartMap(groupProvenanceId: GroupProvenanceId, groupId: string, searchQuery?: SearchQuery): Promise<ChartMapType>;
6
7
  }
@@ -11,8 +11,8 @@ interface RcsbGroupChartInterface {
11
11
  additionalProperties?: GroupChartAdditionalProperties;
12
12
  }
13
13
  interface RcsbGroupChartState {
14
- layout: string[];
15
- chartMap: ChartMapType;
14
+ layout?: string[];
15
+ chartMap?: ChartMapType;
16
16
  }
17
17
  export declare class RcsbGroupChartComponent extends React.Component<RcsbGroupChartInterface, RcsbGroupChartState> {
18
18
  componentDidMount(): Promise<void>;
@@ -3,8 +3,8 @@ import { ChartMapType } from "../RcsbGroupChart/GroupChartLayout";
3
3
  import { SearchQuery } from "@rcsb/rcsb-api-tools/build/RcsbSearch/Types/SearchQueryInterface";
4
4
  import { GroupProvenanceId } from "@rcsb/rcsb-api-tools/build/RcsbDw/Types/DwEnums";
5
5
  import { ChartObjectInterface } from "@rcsb/rcsb-charts/lib/RcsbChartComponent/ChartConfigInterface";
6
- import { SearchQueryType } from "../../../RcsbSeacrh/SearchRequestProperty";
7
6
  import { ReturnType } from "@rcsb/rcsb-api-tools/build/RcsbSearch/Types/SearchEnums";
7
+ import { SearchQueryType } from "@rcsb/rcsb-search-tools/lib/SearchQueryTools/SearchQueryInterfaces";
8
8
  export interface SearchQueryContextManagerSubjectInterface {
9
9
  attributeName: string;
10
10
  chartMap: ChartMapType;
@@ -6,13 +6,13 @@ import { InterfaceInstanceTranslate } from "../RcsbUtils/Translators/InterfaceIn
6
6
  import { PolymerEntityChromosomeTranslate } from "../RcsbUtils/Translators/PolymerEntityChromosomeTranslate";
7
7
  import { QueryPolymer_Entity_GroupArgs } from "@rcsb/rcsb-api-tools/build/RcsbGraphQL/Types/Yosemite/GqlTypes";
8
8
  import { EntryPropertyIntreface } from "../RcsbCollectTools/DataCollectors/MultipleEntryPropertyCollector";
9
- import { SearchQueryType } from "../RcsbSeacrh/SearchRequestProperty";
10
9
  import { FacetType } from "../RcsbSeacrh/FacetStore/FacetMemberInterface";
11
10
  import { ReturnType } from "@rcsb/rcsb-api-tools/build/RcsbSearch/Types/SearchEnums";
12
11
  import { ResultsContentType, SearchQuery } from "@rcsb/rcsb-api-tools/build/RcsbSearch/Types/SearchQueryInterface";
13
12
  import { RequestConfig as GraphqlRequestInit } from "graphql-request/src/types";
14
13
  import { PolymerEntityInterface } from "../RcsbCollectTools/DataCollectors/MultiplePolymerEntityCollector";
15
14
  import { InstanceSequenceInterface } from "../RcsbCollectTools/DataCollectors/MultipleInstanceSequencesCollector";
15
+ import { SearchQueryType } from "@rcsb/rcsb-search-tools/lib/SearchQueryTools/SearchQueryInterfaces";
16
16
  declare class RcsbRequestContextManager {
17
17
  private readonly polymerEntityToInstanceMap;
18
18
  private readonly entryToAssemblyMap;
@@ -6,7 +6,7 @@ declare class DepositionGroupFacetStore implements FacetStoreInterface {
6
6
  private readonly instanceFacet;
7
7
  private readonly entityFacet;
8
8
  private readonly nonPolymerFacet;
9
- getServices(): Service[];
9
+ getServices(): (Service.Text | Service.TextChem)[];
10
10
  getFacetService(service: Service | "all"): FacetMemberInterface[];
11
11
  readonly facetLayoutGrid: string[];
12
12
  readonly returnType: ReturnType;
@@ -6,7 +6,7 @@ declare class EntityGranularitySearchFacetStore implements FacetStoreInterface {
6
6
  private readonly instanceFacet;
7
7
  private readonly entityFacet;
8
8
  private readonly nonPolymerFacet;
9
- getServices(): Service[];
9
+ getServices(): (Service.Text | Service.TextChem)[];
10
10
  getFacetService(service: Service | "all"): FacetMemberInterface[];
11
11
  readonly facetLayoutGrid: string[];
12
12
  readonly returnType: ReturnType;
@@ -1,15 +1,16 @@
1
- import { CardinalityFacet, DateHistogramFacet, DateRangeFacet, FilterFacet, HistogramFacet, RangeFacet, TermsFacet } from "@rcsb/rcsb-api-tools/build/RcsbSearch/Types/SearchQueryInterface";
2
- import { BucketFacet } from "@rcsb/rcsb-api-tools/build/RcsbSearch/Types/SearchResultInterface";
3
1
  import { ChartConfigInterface, ChartType } from "@rcsb/rcsb-charts/lib/RcsbChartComponent/ChartConfigInterface";
4
- export type FacetType = TermsFacet | HistogramFacet | DateHistogramFacet | RangeFacet | DateRangeFacet | CardinalityFacet | FilterFacet;
2
+ import { AttributeFacetType, FilterFacetType } from "@rcsb/rcsb-search-tools/lib/SearchParseTools/SearchFacetInterface";
3
+ import { RcsbSearchAttributeType } from "@rcsb/rcsb-api-tools/build/RcsbSearch/Types/SearchMetadata";
4
+ export type FacetType = AttributeFacetType | FilterFacetType;
5
5
  export interface FacetMemberInterface {
6
6
  id: string;
7
7
  title?: string;
8
8
  attributeName: string;
9
- attribute: string;
9
+ attribute: RcsbSearchAttributeType;
10
10
  chartType: ChartType;
11
- chartConfig?: ChartConfigInterface;
11
+ chartConfig?: ChartConfigInterface & {
12
+ mergeDomainMaxValue?: number;
13
+ };
12
14
  facet: FacetType;
13
15
  contentType: "date" | "number" | "string";
14
- transformSearchResultFacets?(facets: BucketFacet): BucketFacet;
15
16
  }
@@ -1,7 +1,7 @@
1
1
  import { FacetMemberInterface } from "./FacetMemberInterface";
2
2
  import { ReturnType, Service } from "@rcsb/rcsb-api-tools/build/RcsbSearch/Types/SearchEnums";
3
3
  export interface FacetStoreInterface {
4
- getServices(): Service[];
4
+ getServices(): (Service.Text | Service.TextChem)[];
5
5
  getFacetService(service: Service | "all"): FacetMemberInterface[];
6
6
  readonly facetLayoutGrid: string[];
7
7
  readonly returnType: ReturnType;
@@ -6,7 +6,7 @@ declare class SequenceGroupFacetStore implements FacetStoreInterface {
6
6
  private readonly instanceFacet;
7
7
  private readonly entityFacet;
8
8
  private readonly nonPolymerFacet;
9
- getServices(): Service[];
9
+ getServices(): (Service.Text | Service.TextChem)[];
10
10
  getFacetService(service: Service | "all"): FacetMemberInterface[];
11
11
  readonly facetLayoutGrid: string[];
12
12
  readonly returnType: ReturnType;
@@ -6,7 +6,7 @@ declare class UniprotGroupFacetStore implements FacetStoreInterface {
6
6
  private readonly instanceFacet;
7
7
  private readonly entityFacet;
8
8
  private readonly nonPolymerFacet;
9
- getServices(): Service[];
9
+ getServices(): (Service.Text | Service.TextChem)[];
10
10
  getFacetService(service: Service | "all"): FacetMemberInterface[];
11
11
  readonly facetLayoutGrid: string[];
12
12
  readonly returnType: ReturnType;
@@ -1,52 +1,58 @@
1
1
  import { BucketFacet } from "@rcsb/rcsb-api-tools/build/RcsbSearch/Types/SearchResultInterface";
2
2
  import { FacetMemberInterface } from "./FacetStore/FacetMemberInterface";
3
3
  import { AttributeTextQueryParameters } from "@rcsb/rcsb-api-tools/build/RcsbSearch/Types/SearchQueryInterface";
4
- import { Operator, Service } from "@rcsb/rcsb-api-tools/build/RcsbSearch/Types/SearchEnums";
5
- import { ChartConfigInterface, ChartDisplayConfigInterface, ChartObjectInterface, ChartType } from "@rcsb/rcsb-charts/lib/RcsbChartComponent/ChartConfigInterface";
4
+ import { Service } from "@rcsb/rcsb-api-tools/build/RcsbSearch/Types/SearchEnums";
5
+ import { ChartDisplayConfigInterface, ChartObjectInterface, ChartType } from "@rcsb/rcsb-charts/lib/RcsbChartComponent/ChartConfigInterface";
6
+ import { RcsbSearchAttributeType } from "@rcsb/rcsb-api-tools/build/RcsbSearch/Types/SearchMetadata";
6
7
  export type SearchFilter = {
7
- attribute: string;
8
+ attribute: RcsbSearchAttributeType;
8
9
  value: AttributeTextQueryParameters['value'];
9
- operator: Operator;
10
+ operator: AttributeTextQueryParameters["operator"];
10
11
  service: Service.Text | Service.TextChem;
11
12
  };
12
- export interface RcsbChartInterface {
13
+ export interface RcsbChartInterface<T = any> {
13
14
  chartType: ChartType;
14
15
  labelList?: string[];
15
- attribute: string;
16
+ attribute: RcsbSearchAttributeType;
16
17
  attributeName: string;
17
- chartConfig?: ChartConfigInterface;
18
+ chartConfig?: FacetMemberInterface["chartConfig"];
18
19
  title?: string;
19
- data: ChartObjectInterface[];
20
+ data: ChartObjectInterface<T>[];
20
21
  filters?: SearchFilter[];
21
22
  contentType: FacetMemberInterface['contentType'];
22
23
  }
23
24
  export declare class FacetTools {
24
- static getResultDrilldowns(facetMembers: FacetMemberInterface[], searchResultFacets: Array<BucketFacet>, labelList?: string[], recursiveOut?: Array<RcsbChartInterface>): Array<RcsbChartInterface>;
25
+ static getResultDrilldowns(facetMembers: FacetMemberInterface[], searchResultFacets: Array<BucketFacet>): Array<RcsbChartInterface>;
25
26
  static subtractDrilldowns(partial: Array<RcsbChartInterface>, full: Array<RcsbChartInterface>): Array<RcsbChartInterface>;
26
27
  static getFacetFromName(facetMembers: FacetMemberInterface[], name: string): FacetMemberInterface | undefined;
27
28
  static addChartDisplayConfig(chart: RcsbChartInterface, chartDisplayConfig: Partial<ChartDisplayConfigInterface>): {
28
29
  chartConfig: {
29
30
  chartDisplayConfig: Partial<ChartDisplayConfigInterface>;
30
- mergeDomainMaxValue?: number | undefined;
31
31
  mostPopulatedGroups?: number | undefined;
32
- mergeName?: string | undefined;
33
32
  domainMinValue?: number | undefined;
33
+ domainMaxValue?: number | undefined;
34
+ domainEmptyBins?: boolean | undefined;
34
35
  histogramBinIncrement?: number | undefined;
35
36
  tickIncrement?: {
36
37
  origin: number;
37
38
  increment: number;
38
39
  } | undefined;
40
+ tickFormat?: {
41
+ domAxis?: ((x: string | number) => string) | undefined;
42
+ imgAxis?: ((x: string | number) => string) | undefined;
43
+ } | undefined;
39
44
  axisLabel?: string | undefined;
40
45
  barClickCallback?: import("@rcsb/rcsb-charts/lib/RcsbChartComponent/ChartConfigInterface").BarClickCallbackType | undefined;
41
- sort?: ((b: import("@rcsb/rcsb-charts/lib/RcsbChartDataProvider/ChartDataProviderInterface").ChartDataInterface, a: import("@rcsb/rcsb-charts/lib/RcsbChartDataProvider/ChartDataProviderInterface").ChartDataInterface) => number) | undefined;
42
- tooltipText?: ((a: import("@rcsb/rcsb-charts/lib/RcsbChartDataProvider/ChartDataProviderInterface").ChartDataValuesInterface) => string | undefined) | undefined;
46
+ sort?: ((b: import("@rcsb/rcsb-charts/lib/RcsbChartDataProvider/ChartDataProviderInterface").ChartDataColumnInterface<any>, a: import("@rcsb/rcsb-charts/lib/RcsbChartDataProvider/ChartDataProviderInterface").ChartDataColumnInterface<any>) => number) | undefined;
47
+ tooltipText?: ((a: import("@rcsb/rcsb-charts/lib/RcsbChartDataProvider/ChartDataProviderInterface").ChartDataValueInterface<any>) => string | string[] | undefined) | undefined;
48
+ mergeDomainMaxValue?: number | undefined;
43
49
  };
44
50
  chartType: ChartType;
45
51
  labelList?: string[] | undefined;
46
- attribute: string;
52
+ attribute: RcsbSearchAttributeType;
47
53
  attributeName: string;
48
54
  title?: string | undefined;
49
- data: ChartObjectInterface[];
55
+ data: ChartObjectInterface<any>[];
50
56
  filters?: SearchFilter[] | undefined;
51
57
  contentType: "string" | "number" | "date";
52
58
  };
@@ -1,16 +1,16 @@
1
- import { SearchQueryType } from "./SearchRequestProperty";
2
- import { LogicalOperator, Operator, ReturnType, Service } from "@rcsb/rcsb-api-tools/build/RcsbSearch/Types/SearchEnums";
3
- import { SearchQuery, AttributeTextQueryParameters, ResultsContentType } from "@rcsb/rcsb-api-tools/build/RcsbSearch/Types/SearchQueryInterface";
1
+ import { LogicalOperator, ReturnType, Service } from "@rcsb/rcsb-api-tools/build/RcsbSearch/Types/SearchEnums";
2
+ import { RcsbSearchAttributeType } from "@rcsb/rcsb-api-tools/build/RcsbSearch/Types/SearchMetadata";
3
+ import { AttributeTextQueryParameters, ResultsContentType, SearchQuery } from "@rcsb/rcsb-api-tools/build/RcsbSearch/Types/SearchQueryInterface";
4
4
  import { FacetStoreInterface } from "./FacetStore/FacetStoreInterface";
5
5
  import { GroupProvenanceId } from "@rcsb/rcsb-api-tools/build/RcsbDw/Types/DwEnums";
6
+ import { SearchQueryType } from "@rcsb/rcsb-search-tools/lib/SearchQueryTools/SearchQueryInterfaces";
6
7
  export declare namespace SearchQueryTools {
7
- function searchGroupQuery(groupProvenance: GroupProvenanceId, groupId: string, service?: Service): SearchQueryType;
8
- function addGroupNodeToSearchQuery(groupProvenanceId: GroupProvenanceId, groupId: string, searchQuery: SearchQueryType, service?: Service): SearchQueryType;
9
- function buildAttributeSearchQuery(attribute: string, value: AttributeTextQueryParameters['value'], operator: Operator, searchQuery: SearchQueryType, returnType: ReturnType, service: Service.Text | Service.TextChem, negation?: boolean): SearchQuery;
8
+ function searchGroupQuery(groupProvenance: GroupProvenanceId, groupId: string, service?: Service.Text | Service.TextChem): SearchQueryType;
9
+ function addGroupNodeToSearchQuery(groupProvenanceId: GroupProvenanceId, groupId: string, searchQuery: SearchQueryType, service?: Service.Text | Service.TextChem): SearchQueryType;
10
10
  function buildNodeSearchQuery(node: SearchQueryType, searchQuery: SearchQueryType, returnType: ReturnType, resultsContentType: ResultsContentType, logicalOperator?: LogicalOperator): SearchQuery;
11
11
  function buildSearchQuery(searchQuery: SearchQueryType, returnType: ReturnType): SearchQuery;
12
- function addNewNodeToAttributeSearchQuery(attribute: string, value: AttributeTextQueryParameters['value'], operator: Operator, searchQuery: SearchQueryType, service: Service.Text | Service.TextChem, negation?: boolean): SearchQueryType;
13
- function searchAttributeQuery(attribute: string, value: AttributeTextQueryParameters['value'], operator: Operator, service: Service.Text | Service.TextChem, negation?: boolean): SearchQueryType;
12
+ function addNewNodeToAttributeSearchQuery(attribute: RcsbSearchAttributeType, value: AttributeTextQueryParameters['value'], operator: AttributeTextQueryParameters["operator"], searchQuery: SearchQueryType, service: Service.Text | Service.TextChem, negation?: boolean): SearchQueryType;
13
+ function searchAttributeQuery(attribute: RcsbSearchAttributeType, value: AttributeTextQueryParameters['value'], operator: AttributeTextQueryParameters["operator"], service: Service.Text | Service.TextChem, negation?: boolean): SearchQueryType;
14
14
  function addNodeToSearchQuery(node: SearchQueryType, searchQuery: SearchQueryType, logicalOperator?: LogicalOperator): SearchQueryType;
15
15
  function getFacetStoreFromGroupProvenance(groupProvenanceId: GroupProvenanceId): FacetStoreInterface;
16
16
  function searchContentType(searchQuery?: SearchQuery): ResultsContentType;
@@ -1,9 +1,9 @@
1
1
  import { SearchRequest } from "@rcsb/rcsb-api-tools/build/RcsbSearch/SearchRequest";
2
2
  import { QueryResult } from "@rcsb/rcsb-api-tools/build/RcsbSearch/Types/SearchResultInterface";
3
3
  import { ReturnType } from "@rcsb/rcsb-api-tools/build/RcsbSearch/Types/SearchEnums";
4
- import { GroupNode, ResultsContentType, SearchQuery, TerminalNode } from "@rcsb/rcsb-api-tools/build/RcsbSearch/Types/SearchQueryInterface";
4
+ import { ResultsContentType, SearchQuery } from "@rcsb/rcsb-api-tools/build/RcsbSearch/Types/SearchQueryInterface";
5
5
  import { FacetType } from "./FacetStore/FacetMemberInterface";
6
- export type SearchQueryType = GroupNode | TerminalNode;
6
+ import { SearchQueryType } from "@rcsb/rcsb-search-tools/lib/SearchQueryTools/SearchQueryInterfaces";
7
7
  declare class SearchRequestProperty {
8
8
  private readonly getClient;
9
9
  constructor(getClient: () => SearchRequest);