@fxhash/open-form-graph 0.0.1

package/README.md

@@ -0,0 +1,3 @@
+# `@fxhash/open-form-graph`
+
+A react-force-graph visualizer for open form collections.

package/dist/index.d.ts

@@ -0,0 +1,139 @@
+import { ForceGraphMethods } from 'react-force-graph-2d';
+import { ForceGraphMethods as ForceGraphMethods$1 } from 'react-force-graph-3d';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+
+type RawNode = {
+    id: string;
+    label?: string;
+    imgSrc?: string;
+};
+type RawLink = {
+    source: string;
+    target: string;
+};
+type Link = {
+    source: Node;
+    target: Node;
+};
+type Node = {
+    id: string;
+    collapsed: boolean;
+    hide: boolean;
+    clusterSize: number;
+    level?: number;
+    childLinks: Link[];
+    image?: HTMLImageElement;
+} & RawNode;
+type RawGraphData = {
+    nodes: RawNode[];
+    links: RawLink[];
+};
+type GraphData = {
+    nodes: Node[];
+    links: Link[];
+};
+type RGB = [number, number, number];
+type ColorTransform = (rgb: RGB) => RGB;
+
+interface GraphConfig {
+    debug: false;
+    nodeSize: number;
+    minClusterSize: number;
+    maxClusterSize: number;
+    minZoom: number;
+    maxZoom: number;
+    focusPadding: number;
+    minDagLevelDistance: number;
+    maxDagLevelDistance: number;
+    theme: {
+        dark: [number, number, number];
+        light: [number, number, number];
+    };
+}
+interface LayoutConfig {
+    velocityDecay: number;
+    alphaDecay: number;
+    alphaMin: number;
+    dagLevelDistance: number;
+}
+type _ForceGraphMethods = ForceGraphMethods<Node, Link> | ForceGraphMethods$1<Node, Link>;
+interface OpenFormGraphApi {
+    ref: React.MutableRefObject<_ForceGraphMethods | undefined>;
+    rootId: string;
+    data: GraphData;
+    onClickNode: (nodeId: string) => void;
+    hasNodeChildren: (nodeId: string) => boolean;
+    clusterSizeRange: [number, number];
+    graphLevelRange: [number, number];
+    setLayoutConfig: React.Dispatch<React.SetStateAction<LayoutConfig>>;
+    layoutConfig: LayoutConfig;
+    selectedNode: Node | null;
+    selectedNodeId: string | null;
+    setSelectedNodeId: (node: string | null) => void;
+    highlights: GraphData;
+    theme: "dark" | "light";
+    setTheme: (theme: "dark" | "light") => void;
+    config: GraphConfig;
+    setConfig: React.Dispatch<React.SetStateAction<GraphConfig>>;
+    getNodeSize: (nodeId: string) => number;
+    getNodeForce: (nodeId: string) => number;
+    search: (startNodeId: string, rootId: string) => {
+        nodes: Node[];
+        links: Link[];
+    };
+}
+
+interface ProjectGraphProps$1 {
+    width: number;
+    height: number;
+}
+declare function OpenFormGraph(props: ProjectGraphProps$1): react_jsx_runtime.JSX.Element;
+
+interface ProjectGraphProps {
+    width: number;
+    height: number;
+}
+declare function OpenFormGraph3D(props: ProjectGraphProps): react_jsx_runtime.JSX.Element;
+
+interface OpenFormGraphProviderProps {
+    config?: Partial<GraphConfig>;
+    theme: "dark" | "light";
+    children: ReactNode;
+    data: {
+        nodes: RawNode[];
+        links: RawLink[];
+    };
+    rootId: string;
+}
+declare function OpenFormGraphProvider({ config, theme, data, rootId: _rootId, children, }: OpenFormGraphProviderProps): react_jsx_runtime.JSX.Element;
+declare function useOpenFormGraph(): OpenFormGraphApi;
+
+declare const VOID_ROOT_ID = "void-root";
+declare const DEFAULT_GRAPH_CONFIG: GraphConfig;
+
+declare function normalize(val: number, min: number, max: number, minOut: number, maxOut: number): number;
+
+interface ColorHandler {
+    (arg?: number): string;
+    (arg: ColorTransform): ColorHandler;
+    rgb: RGB;
+}
+declare function color(rgb: RGB): ColorHandler;
+/**
+ * Dims a color to white or black
+ * @param color An array of 3 numbers representing RGB values (0-255)
+ * @param dimFactor A value between 0 and 1 where 0 is completely black and 1 is the original color
+ * @returns A new array with the dimmed RGB values
+ */
+declare function dim(factor?: number, white?: boolean): ColorTransform;
+
+declare function generateTree(maxNodes: number, maxChildren: number): RawGraphData;
+declare function collectChildren(node: Node, threshold: number, visited?: Set<string>): {
+    nodes: Node[];
+    links: Link[];
+};
+
+declare function preloadImage(url: string, ref: React.MutableRefObject<ForceGraphMethods<Node, Link> | undefined>): HTMLImageElement;
+
+export { type ColorHandler, type ColorTransform, DEFAULT_GRAPH_CONFIG, type GraphConfig, type GraphData, type LayoutConfig, type Link, type Node, OpenFormGraph, OpenFormGraph3D, type OpenFormGraphApi, OpenFormGraphProvider, type RGB, type RawGraphData, type RawLink, type RawNode, VOID_ROOT_ID, collectChildren, color, dim, generateTree, normalize, preloadImage, useOpenFormGraph };