@fxhash/open-form-graph 0.0.1 → 0.0.2

package/dist/index.d.ts

@@ -1,139 +1,117 @@
-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';
+import { OpenFormGraph$1 as OpenFormGraph } from "./OpenFormGraph-0EqYrhjv.js";
+import { ColorHandler, ColorTransform, DEFAULT_GRAPH_CONFIG$1 as DEFAULT_GRAPH_CONFIG, GraphConfig, GraphData, Link, NestedRawNode, Node, NodeState, OpenFormGraphApi, OpenFormGraphProvider$1 as OpenFormGraphProvider, RGB, RawGraphData, RawLink, RawNode, RootNodeImageSources, SimLink, SimNode, ThemeMode, VOID_ROOT_ID$1 as VOID_ROOT_ID, color$1 as color, dim$1 as dim, useOpenFormGraph$1 as useOpenFormGraph } from "./constants-DU_wYtaU.js";
+import * as d3_force2 from "d3-force";
 
-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[];
-    };
-}
+//#region src/util/canvas.d.ts
 
-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
+ * draws a circle on the canvas
+ * @param ctx - The canvas rendering context
+ * @param x - The x-coordinate of the circle's center
+ * @param y - The y-coordinate of the circle's center
+ * @param radius - The radius of the circle (default is 5)
+ * @param options - Optional parameters for styling the circle
+ * @param options.fill - Whether to fill the circle (default is true)
+ * @param options.fillStyle - The fill color of the circle
+ * @param options.stroke - Whether to stroke the circle (default is false)
+ * @param options.strokeStyle - The stroke color of the circle
+ * @param options.lineWidth - The width of the stroke (default is 0.2)
+ * @returns void
  */
-declare function dim(factor?: number, white?: boolean): ColorTransform;
-
+declare function circle(ctx: CanvasRenderingContext2D, x: number, y: number, radius?: number, options?: {
+  fill?: boolean;
+  fillStyle?: string;
+  stroke?: boolean;
+  strokeStyle?: string;
+  lineWidth?: number;
+}): void;
+/**
+ * draws a rectangle on the canvas
+ * @param ctx - The canvas rendering context
+ * @param x - The x-coordinate of the rectangle's top-left corner
+ * @param y - The y-coordinate of the rectangle's top-left corner
+ * @param width - The width of the rectangle
+ * @param height - The height of the rectangle
+ * @param options - Optional parameters for styling the rectangle
+ * @param options.fill - Whether to fill the rectangle (default is true)
+ * @param options.fillStyle - The fill color of the rectangle
+ * @param options.stroke - Whether to stroke the rectangle (default is false)
+ * @param options.strokeStyle - The stroke color of the rectangle
+ * @param options.lineWidth - The width of the stroke (default is 0.2)
+ * @param options.borderRadius - The radius of the corners (default is 0)
+ * @returns void
+ */
+declare function rect(ctx: CanvasRenderingContext2D, x: number, y: number, width: number, height: number, options?: {
+  fill?: boolean;
+  fillStyle?: string;
+  stroke?: boolean;
+  strokeStyle?: string;
+  lineWidth?: number;
+  borderRadius?: number;
+}): void;
+/**
+ * draws an image on the canvas with optional border radius and opacity
+ * @param ctx - The canvas rendering context
+ * @param image - The HTMLImageElement to draw
+ * @param x - The x-coordinate of the image's top-left corner
+ * @param y - The y-coordinate of the image's top-left corner
+ * @param width - The width of the image
+ * @param height - The height of the image
+ * @param borderRadius - The radius of the corners (default is 0)
+ * @param opacity - The opacity of the image (default is 1.0)
+ * @param bgColor - Optional background color to fill the clipped area
+ * @returns void
+ */
+declare function img(ctx: CanvasRenderingContext2D, image: HTMLImageElement, x: number, y: number, width: number, height: number, borderRadius?: number, opacity?: number, bgColor?: string): void;
+declare function hexagon(ctx: CanvasRenderingContext2D, x: number, y: number, radius: number, options?: {
+  fill?: boolean;
+  fillStyle?: string;
+  stroke?: boolean;
+  strokeStyle?: string;
+  lineWidth?: number;
+  rotation?: number;
+  borderRadius?: number;
+}): void;
+//#endregion
+//#region src/util/data.d.ts
 declare function generateTree(maxNodes: number, maxChildren: number): RawGraphData;
-declare function collectChildren(node: Node, threshold: number, visited?: Set<string>): {
-    nodes: Node[];
-    links: Link[];
+declare function getPrunedData(startId: string, nodes: SimNode[], links: SimLink[]): {
+  nodes: SimNode[];
+  links: d3_force2.SimulationLinkDatum<SimNode>[];
 };
-
-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 };
+/**
+ * Automatically identifies root nodes and builds a nested structure
+ * @param nodes Array of raw nodes
+ * @param links Array of links between nodes
+ * @returns Array of nested nodes starting from identified roots
+ */
+declare function buildTreeFromGraphData(nodes: RawNode[], links: RawLink[]): NestedRawNode<RawNode>[];
+/**
+ * Recursively retrieves all parents of a node from a graph data structure
+ * @param {string} nodeHash - The hash of the node to find parents for
+ * @param {RawNode[]} nodes - Array of nodes in the graph
+ * @param {RawLink[]} links - Array of links connecting the nodes
+ * @returns {RawNode[]} - Array of parent nodes
+ */
+declare function searchParents(nodeHash: string, nodes: RawNode[], links: RawLink[]): RawNode[];
+//#endregion
+//#region src/util/graph.d.ts
+declare function getNodeId(n: any): any;
+declare function getParents(id: string, links: SimLink[]): string[];
+declare function getChildren(id: string, links: SimLink[]): string[];
+declare function getClusterSize(id: string, links: RawLink[]): number;
+declare function hasOnlyLeafs(id: string, links: RawLink[]): boolean;
+declare function getNodeSubgraph(nodeId: string, nodes: SimNode[], links: SimLink[], rootId: string): {
+  nodes: SimNode[];
+  links: SimLink[];
+};
+//#endregion
+//#region src/util/img.d.ts
+declare function loadImage(src: string): Promise<HTMLImageElement>;
+//#endregion
+//#region src/util/types.d.ts
+declare function isSimNode(node: SimNode | string | number): node is SimNode;
+declare function isSimLink(link: SimLink): link is SimLink;
+//#endregion
+export { ColorHandler, ColorTransform, DEFAULT_GRAPH_CONFIG, GraphConfig, GraphData, Link, NestedRawNode, Node, NodeState, OpenFormGraph, OpenFormGraphApi, OpenFormGraphProvider, RGB, RawGraphData, RawLink, RawNode, RootNodeImageSources, SimLink, SimNode, ThemeMode, VOID_ROOT_ID, buildTreeFromGraphData, circle, color, dim, generateTree, getChildren, getClusterSize, getNodeId, getNodeSubgraph, getParents, getPrunedData, hasOnlyLeafs, hexagon, img, isSimLink, isSimNode, loadImage, rect, searchParents, useOpenFormGraph };
+//# sourceMappingURL=index.d.ts.map