@rcsb/rcsb-saguaro-app 4.0.0-interfaces.3 → 4.0.0-interfaces.7

package/CHANGELOG.md

@@ -2,13 +2,16 @@
 
 [Semantic Versioning](https://semver.org/)
 
-## [4.0.0-interfaces] - 2021-12-15
+## [4.0.0-interfaces] - 2022-01-24
 ###  Annotation collector improvements 
-- CollectAnnotationsInterface added method for generating new annotations internally (not exposed)
+-  Added interface `CollectAnnotationsInterface` for generating new annotations internally (not exposed)
     - `annotationGenerator?(annotations: Array<AnnotationFeatures>)` generates new annotations from the collected ones
     - `annotationFilter?(annotations: Array<AnnotationFeatures>)` filter the collected annotations
-    - Both method are called before annotations processing and thus, they should be configured in `RcsbAnnotationConfig.ac.json` or equivalent config
+    - Both methods are called before annotations processing and thus, they should be configured in `RcsbAnnotationConfig.ac.json` or equivalent config file
     - Checking content before adding generated features
+    - New callback attribute `InstanceSequenceConfig` > `beforeChangeCallback`. This function is called when instance 
+    dropdown menu changes and before rendering the new 1D RcsbFv. 
+    The callback may return a `RcsbContextType` object that will be included in the `additionalConfig`
 
 ## [4.0.0-master] - 2021-12-07
 ### Breaking change

package/build/dist/RcsbFvWeb/RcsbFvBuilder/RcsbFvInstanceBuilder.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-import { RcsbFvAdditionalConfig } from "../RcsbFvModule/RcsbFvModuleInterface";
+import { RcsbContextType, RcsbFvAdditionalConfig } from "../RcsbFvModule/RcsbFvModuleInterface";
 import { PolymerEntityInstanceInterface } from "../../RcsbCollectTools/Translators/PolymerEntityInstancesCollector";
 import { OptionPropsInterface } from "../WebTools/SelectButton";
 import { RcsbFvModulePublicInterface } from "../RcsbFvModule/RcsbFvModuleInterface";
@@ -13,7 +13,7 @@ declare type instanceModule = "interface" | "instance";
 export interface InstanceSequenceConfig {
     dropdownTitle?: string;
     defaultValue?: string | undefined | null;
-    beforeRenderCallback?: (x: InstanceSequenceOnchangeInterface) => void;
+    beforeChangeCallback?: (x: InstanceSequenceOnchangeInterface) => undefined | RcsbContextType;
     onChangeCallback?: (x: InstanceSequenceOnchangeInterface) => void;
     filterInstances?: Set<string>;
     displayAuthId?: boolean;
@@ -24,6 +24,6 @@ export declare class RcsbFvInstanceBuilder {
     static buildMultipleInstanceSequenceFv(elementFvId: string, elementEntrySelectId: string, elementInstanceSelectId: string, entryIdList: Array<string>, config: InstanceSequenceConfig, additionalConfig?: RcsbFvAdditionalConfig): Promise<RcsbFvModulePublicInterface>;
     static buildInstanceSequenceFv(elementFvId: string, elementSelectId: string, entryId: string, config: InstanceSequenceConfig, additionalConfig?: RcsbFvAdditionalConfig): Promise<RcsbFvModulePublicInterface>;
     static buildSelectorInstanceFv(instanceList: Array<PolymerEntityInstanceInterface>, elementFvId: string, elementSelectId: string, entryId: string, config: InstanceSequenceConfig, additionalConfig?: RcsbFvAdditionalConfig): Promise<RcsbFvModulePublicInterface>;
-    static buildInstanceFv(elementId: string, instanceId: string, additionalConfig?: RcsbFvAdditionalConfig, rcsbContext?: PolymerEntityInstanceInterface, module?: instanceModule): Promise<RcsbFvModulePublicInterface>;
+    static buildInstanceFv(elementId: string, instanceId: string, additionalConfig?: RcsbFvAdditionalConfig, module?: instanceModule): Promise<RcsbFvModulePublicInterface>;
 }
 export {};

package/build/dist/RcsbFvWeb/RcsbFvModule/RcsbFvModuleInterface.d.ts

@@ -5,6 +5,17 @@ import { PairwiseAlignmentInterface } from "../PairwiseAlignmentTools/PairwiseAl
 import { AnnotationProcessingInterface } from "../../RcsbCollectTools/AnnotationCollector/AnnotationCollectorInterface";
 import { SequenceCollectorInterface } from "../../RcsbCollectTools/SequenceCollector/SequenceCollectorInterface";
 import { ExternalTrackBuilderInterface } from "../../RcsbCollectTools/FeatureTools/ExternalTrackBuilderInterface";
+export declare type RcsbContextType = Partial<{
+    entryId: string;
+    entityId: string;
+    asymId: string;
+    authId: string;
+    upAcc: string;
+    chrId: string;
+    targetId: string;
+    queryId: string;
+    operatorIds: Array<string>;
+}>;
 export interface RcsbFvAdditionalConfig {
     sources?: Array<Source>;
     filters?: Array<FilterInput>;
@@ -16,16 +27,7 @@ export interface RcsbFvAdditionalConfig {
     annotationProcessing?: AnnotationProcessingInterface;
     sequenceCollector?: SequenceCollectorInterface;
     externalTrackBuilder?: ExternalTrackBuilderInterface;
-    rcsbContext?: Partial<{
-        entryId: string;
-        entityId: string;
-        asymId: string;
-        authId: string;
-        upAcc: string;
-        chrId: string;
-        targetId: string;
-        queryId: string;
-    }>;
+    rcsbContext?: RcsbContextType;
 }
 export interface RcsbFvModuleBuildInterface {
     queryId?: string;

package/build/dist/RcsbUtils/TagDelimiter.d.ts

@@ -3,4 +3,5 @@ export declare class TagDelimiter {
     static readonly instance: string;
     static readonly sequenceTitle: string;
     static readonly alignmentTitle: string;
+    static readonly operatorComposition: string;
 }