@xyo-network/react-node-renderer 2.81.10 → 2.83.0

package/dist/browser/index.d.ts

@@ -1,5 +1,168 @@
-export * from './components/index.js';
-export * from './contexts/index.js';
-export * from './Cytoscape/index.js';
-export * from './hooks/index.js';
-//# sourceMappingURL=index.d.ts.map
+import { Address } from '@xylabs/hex';
+import { FlexBoxProps } from '@xylabs/react-flexbox';
+import { NodeInstance } from '@xyo-network/node-model';
+import * as cytoscape from 'cytoscape';
+import { CytoscapeOptions, Core, ElementDefinition, LayoutOptions, Stylesheet } from 'cytoscape';
+import * as React from 'react';
+import React__default, { PropsWithChildren, ReactNode, Dispatch, SetStateAction, ReactElement } from 'react';
+import * as _xyo_network_module_model from '@xyo-network/module-model';
+import { ModuleInstance } from '@xyo-network/module-model';
+import * as _xyo_network_account_model from '@xyo-network/account-model';
+import { AccountInstance } from '@xyo-network/account-model';
+import * as _xyo_network_react_shared from '@xyo-network/react-shared';
+import { ContextExState } from '@xyo-network/react-shared';
+import { WithChildren } from '@xylabs/react-shared';
+import { SvgIconTypeMap } from '@mui/material';
+import { OverridableComponent } from '@mui/material/OverridableComponent.js';
+import * as _xyo_network_payload_model from '@xyo-network/payload-model';
+import * as _xylabs_object from '@xylabs/object';
+
+interface NodeRelationalGraphProps extends PropsWithChildren<FlexBoxProps> {
+    actions?: ReactNode;
+    detail?: ReactNode;
+    layout?: 'dagre' | 'euler' | 'cose-bilkent' | 'cola';
+    layoutOptions?: object;
+    node?: WeakRef<NodeInstance>;
+    onHover?: (address?: Address) => void;
+    options?: CytoscapeOptions;
+    showDetails?: boolean;
+}
+
+interface ModuleCardParserProps {
+    mod?: ModuleInstance;
+}
+declare const ModuleCardParser: React__default.FC<ModuleCardParserProps>;
+
+interface ModuleGraphFlexBoxProps extends FlexBoxProps {
+    disableModuleDetails?: boolean;
+    hideActions?: boolean;
+    layout?: 'dagre' | 'euler' | 'cose-bilkent' | 'cola';
+    layoutOptions?: object;
+    rootModule?: WeakRef<ModuleInstance> | null;
+}
+declare const ModuleGraphFlexBox: React__default.FC<ModuleGraphFlexBoxProps>;
+declare const ModuleGraphFlexBoxWithProvider: React__default.FC<ModuleGraphFlexBoxProps>;
+
+declare const NodeRelationalGraphFlexBox: React__default.ForwardRefExoticComponent<NodeRelationalGraphProps & React__default.RefAttributes<HTMLDivElement>>;
+declare const NodeRelationalGraph: React__default.ForwardRefExoticComponent<NodeRelationalGraphProps & React__default.RefAttributes<HTMLDivElement>>;
+
+interface ProvidedNodeRendererProps extends NodeRelationalGraphProps {
+    account?: AccountInstance;
+    layout?: 'dagre' | 'euler' | 'cose-bilkent' | 'cola';
+    layoutOptions?: object;
+    node?: WeakRef<NodeInstance>;
+}
+declare const ProvidedNodeRenderer: React__default.FC<ProvidedNodeRendererProps>;
+
+interface CytoscapeInstanceState extends ContextExState {
+    cy?: WeakRef<Core>;
+    setCy?: Dispatch<SetStateAction<WeakRef<Core> | undefined>>;
+}
+
+declare const CytoscapeInstanceContext: React.Context<CytoscapeInstanceState & _xyo_network_react_shared.ContextExState>;
+
+interface CytoscapeInstanceProviderProps extends WithChildren {
+    defaultInstance?: WeakRef<Core>;
+}
+declare const CytoscapeInstanceProvider: React__default.FC<CytoscapeInstanceProviderProps>;
+
+declare const useCytoscapeInstance: (required?: boolean) => Omit<CytoscapeInstanceState & _xyo_network_react_shared.ContextExState, "provided">;
+
+interface ModuleInfo {
+    children: ModuleInfo[];
+    depth: number;
+    mod: ModuleInstance;
+}
+declare const CytoscapeElements: {
+    MaxNameLength: number;
+    buildEdge(rootNode: ElementDefinition, newNode: ElementDefinition, properties?: {
+        [key: string]: unknown;
+    }): {
+        data: {
+            id: string;
+            source: string | undefined;
+            target: string | undefined;
+        };
+    };
+    buildElements(mod: ModuleInstance): Promise<ElementDefinition[]>;
+    buildElementsFromInfo(info: ModuleInfo, root?: ElementDefinition, classes?: string[]): Promise<ElementDefinition[]>;
+    buildNode(mod: ModuleInstance, properties?: {
+        [key: string]: unknown;
+    }, classes?: string[]): ElementDefinition;
+    buildRootNode: (mod: ModuleInstance) => ElementDefinition;
+    normalizeName(name?: string): string | undefined;
+    recurseNodes(root: ModuleInstance, maxDepth?: number, depth?: number): Promise<ModuleInfo>;
+};
+
+type CyNodeModuleTypes = 'archivist' | 'bridge' | 'diviner' | 'module' | 'node' | 'witness' | 'sentinel';
+
+declare const encodeSvg: (reactElement: ReactElement, color?: string) => string;
+
+declare const generateIconMap: () => Record<CyNodeModuleTypes, string>;
+
+declare const ColaLayout: {
+    centerGraph: boolean;
+    convergenceThreshold: number;
+    name: string;
+};
+
+declare const ConcentricLayout: LayoutOptions;
+
+declare const parseModuleType: (mod?: ModuleInstance) => CyNodeModuleTypes;
+
+declare const CyIconSet: Record<CyNodeModuleTypes, OverridableComponent<SvgIconTypeMap<{}, 'svg'>>>;
+
+declare const NodeWithName: (color?: string, outlineColor?: string) => Stylesheet;
+declare const Node: (icons: Record<CyNodeModuleTypes, string>, bgColor?: string, hideLabels?: boolean) => Stylesheet;
+declare const NodeAsRoot: (bgColor?: string) => {
+    selector: string;
+    style: {
+        'background-color': string | undefined;
+    };
+};
+declare const EdgeStyled: (lineColor?: string, targetArrowColor?: string) => {
+    selector: string;
+    style: {
+        'curve-style': string;
+        'line-color': string | undefined;
+        'line-opacity': number;
+        'target-arrow-color': string | undefined;
+        'target-arrow-shape': string;
+        width: number;
+    };
+};
+
+declare const useCytoscapeElements: (mod?: WeakRef<ModuleInstance> | null) => ElementDefinition[];
+
+declare const useElements: (hideLabels: boolean) => {
+    hoveredNode: cytoscape.NodeSingular | undefined;
+    setHoveredNode: React.Dispatch<React.SetStateAction<cytoscape.NodeSingular | undefined>>;
+    toggleSelectedElement: (address?: string) => void;
+};
+
+declare const useCytoscapeOptions: (elements: CytoscapeOptions["elements"], style?: CytoscapeOptions["style"], layout?: CytoscapeOptions["layout"]) => CytoscapeOptions | undefined;
+
+declare const useModuleDetails: (rootModule?: WeakRef<ModuleInstance> | null, onFoundModule?: () => void) => {
+    mod: ModuleInstance<_xylabs_object.BaseParamsFields & {
+        account?: _xyo_network_account_model.AccountInstance | "random";
+        addToResolvers?: boolean;
+        additionalSigners?: _xyo_network_account_model.AccountInstance[];
+        allowNameResolution?: boolean;
+        config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
+            schema: "network.xyo.module.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean;
+        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+    }, _xyo_network_module_model.ModuleEventData<object>> | null | undefined;
+    onModuleDetails: (address?: string | null) => void;
+};
+
+declare const useRelationalGraphOptions: (mod?: WeakRef<ModuleInstance>) => {
+    handleToggleLabels: () => void;
+    hideLabels: boolean;
+    options: cytoscape.CytoscapeOptions | undefined;
+};
+
+export { ColaLayout, ConcentricLayout, CyIconSet, type CyNodeModuleTypes, CytoscapeElements, CytoscapeInstanceContext, CytoscapeInstanceProvider, type CytoscapeInstanceProviderProps, type CytoscapeInstanceState, EdgeStyled, ModuleCardParser, type ModuleCardParserProps, ModuleGraphFlexBox, type ModuleGraphFlexBoxProps, ModuleGraphFlexBoxWithProvider, Node, NodeAsRoot, NodeRelationalGraph, NodeRelationalGraphFlexBox, type NodeRelationalGraphProps, NodeWithName, ProvidedNodeRenderer, type ProvidedNodeRendererProps, encodeSvg, generateIconMap, parseModuleType, useCytoscapeElements, useCytoscapeInstance, useCytoscapeOptions, useElements, useModuleDetails, useRelationalGraphOptions };