@rcsb/rcsb-saguaro-app 4.4.16 → 4.5.0

package/README.md

@@ -38,7 +38,7 @@ RcsbFvWebApp.buildInstanceFv("pfv", "4Z35.A", {
 The full collection of examples can be edit and modified at [CODEPEN](https://codepen.io/collection/XjrBRP?grid_type=list)
 
 ### Library Documentation
-TypeScript classes documentation can be found [here](https://rcsb.github.io/rcsb-saguaro-app/globals.html).
+TypeScript classes documentation can be found [here](https://rcsb.github.io/rcsb-saguaro-app/modules.html).
 
 ### Main Class and Methods
 **RcsbFvWebApp** calss provides a collection of methods to display preconfigured features over PDB and UniProt sequences 
@@ -51,7 +51,7 @@ click events.
 - **RcsbFvWebApp.buildUniprotEntityFv**(elementId: string, upAcc: string, entityId: string)
 - **RcsbFvWebApp.buildUniprotEntityInstanceFv**(elementId: string, upAcc: string, entityId: string, instanceId: string)
 
-- **RcsbFvWebApp.setBoardConfig**(boardConfigData: [RcsbFvBoardConfigInterface](https://rcsb.github.io/rcsb-saguaro/interfaces/rcsbfvboardconfiginterface.html))
+- **RcsbFvWebApp.setBoardConfig**(boardConfigData: [RcsbFvBoardConfigInterface](https://rcsb.github.io/rcsb-saguaro/interfaces/RcsbFvBoardConfigInterface.html))
 - **RcsbFvWebApp.getRcsbFv**(elementId: string)
 
 ### GraphQL configuration
@@ -78,6 +78,18 @@ click events.
 - A new method in the `RcsbRequestContextManager` defined in `src/RcsbFvWeb/RcsbFvBuilder`
     - This method must avoid duplicate requests
 
+### Testing
+Different testing example are available in the `src/RcsbFvExamples` folder
+- `npm install`
+- `npm run devServer`
+
+Go to:
+
+- `http://localhost:9000/EntitySummaryFv.html`
+- `http://localhost:9000/InstanceSequenceFv.html`
+- `http://localhost:9000/UniprotGroupFv.html`
+  ...
+
 Contributing
 ---
 All contributions are welcome. Please, make a pull request or open an issue.

package/build/dist/RcsbFvUI/AbstractMenuItemComponent.d.ts

@@ -1,4 +1,7 @@
 import React from "react";
+export declare type MenuItemComponentType<P extends {
+    stateChange(state: S, prevState: S): void;
+}, S extends {}, SS extends S = S> = typeof AbstractMenuItemComponent<P, S, SS>;
 export declare abstract class AbstractMenuItemComponent<P extends {
     stateChange(state: S, prevState: S): void;
 }, S extends {}, SS extends S = S> extends React.Component<P, S & SS> {

package/build/dist/RcsbFvUI/Components/PaginationItemComponent.d.ts

@@ -1,10 +1,10 @@
 /// <reference types="react" />
 import { AbstractMenuItemComponent } from "../AbstractMenuItemComponent";
-interface PaginationItemState {
+export interface PaginationItemState {
     after: number;
     first: number;
 }
-interface PaginationItemProps {
+export interface PaginationItemProps {
     count: number;
     after: string;
     first: number;
@@ -21,4 +21,3 @@ export declare class PaginationItemComponent extends AbstractMenuItemComponent<P
     private textColor;
     private switchAction;
 }
-export {};

package/build/dist/RcsbFvUI/GroupPfvUI.d.ts

@@ -0,0 +1,10 @@
+import React from "react";
+export declare type UiComponentType<T extends {}> = {
+    component: typeof React.Component<T, any>;
+    props: T;
+};
+export declare class GroupPfvUI {
+    static fvUI(element: string | HTMLElement, uiComponent: UiComponentType<any>[]): void;
+    static addBootstrapElement(elementId: string): HTMLElement;
+    private static htmlElementUI;
+}

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

@@ -6,6 +6,7 @@ import { ExternalTrackBuilderInterface } from "../../RcsbCollectTools/FeatureToo
 import { PairwiseAlignmentInterface } from "../../RcsbUtils/PairwiseAlignmentTools/PairwiseAlignmentBuilder";
 import { AlignmentRequestContextType } from "../RcsbFvFactories/RcsbFvTrackFactory/TrackFactoryImpl/AlignmentTrackFactory";
 import { TrackManagerInterface } from "../RcsbFvFactories/RcsbFvBlockFactory/BlockManager/TrackManagerInterface";
+import { UiComponentType } from "../../RcsbFvUI/GroupPfvUI";
 export declare type RcsbContextType = Partial<{
     entryId: string;
     entityId: string;
@@ -36,6 +37,7 @@ export interface RcsbFvAdditionalConfig {
         alignment?: (alignmentContext: AlignmentRequestContextType, targetAlignment: TargetAlignment) => Promise<Partial<RcsbFvRowConfigInterface>>;
         annotations?: (trackManager: TrackManagerInterface) => Promise<Partial<RcsbFvRowConfigInterface>>;
     };
+    externalUiComponents?: UiComponentType<any>[];
 }
 export interface RcsbFvModuleBuildInterface {
     group?: GroupReference;

package/build/dist/RcsbUtils/Helpers/DataContainer.d.ts

@@ -0,0 +1,9 @@
+export declare class DataContainer<T> {
+    private data;
+    constructor(data?: T);
+    get(): T | undefined;
+    set(data: T | undefined): void;
+}
+export interface DataContainerReader<T> {
+    get(): T | undefined;
+}