@3plate/graph-core 0.1.6 → 0.1.9

package/dist/index.d.cts

@@ -11,11 +11,24 @@ type Dims = {
 
 type MarkerType = 'arrow' | 'circle' | 'diamond' | 'bar' | 'none';
 
+/**
+ * Ingestion source configuration.
+ * Used to connect to an external data source for graph updates.
+ */
+type IngestionConfig = {
+    type: 'websocket';
+    url: string;
+    reconnectMs?: number;
+} | {
+    type: 'file';
+    url: string;
+    intervalMs?: number;
+};
 /**
  * Arguments to the API constructor.
  *
- * The caller can specify nodes and edges, or history,
- * but not both.
+ * The caller can specify nodes and edges, history, or ingestion config,
+ * but not multiple.
  *
  * The root element ID is required.
  */
@@ -28,6 +41,8 @@ type APIArguments<N, E> = {
     edges?: E[];
     /** Initial history */
     history?: Update<N, E>[];
+    /** Ingestion source configuration */
+    ingestion?: IngestionConfig;
     /** Events */
     events?: EventsOptions<N, E>;
     /** Root element ID */
@@ -75,6 +90,8 @@ type GraphOptions = {
  * Events that can be handled by the user.
  */
 type EventsOptions<N, E> = {
+    /** Called when the API has finished initializing */
+    onInit?: () => void;
     /** Called when a node is clicked */
     nodeClick?: (node: N) => void;
     /** Called when an edge is clicked */
@@ -368,11 +385,19 @@ declare class API<N, E> {
     private nextNodeId;
     private nextEdgeId;
     private events;
-    private root;
+    private ingest?;
+    private ingestionSource?;
+    private ingestionConfig?;
+    private prevProps;
+    root: string;
     constructor(args: APIArguments<N, E>);
     reset(): void;
     /** Initialize the API */
     init(): Promise<void>;
+    /** Connect to the configured ingestion source */
+    private connectIngestion;
+    /** Disconnect from the ingestion source */
+    private disconnectIngestion;
     private applyHistory;
     /** Current history index (0-based) */
     getHistoryIndex(): number;
@@ -436,6 +461,30 @@ declare class API<N, E> {
     handleAddEdge(data: EditEdgeProps): Promise<void>;
     handleDeleteNode(id: NodeId): Promise<void>;
     handleDeleteEdge(id: EdgeId): Promise<void>;
+    /** Update theme and type styles dynamically */
+    updateStyles(options: {
+        theme?: ThemeVars;
+        nodeTypes?: Record<string, ThemeVars>;
+        edgeTypes?: Record<string, ThemeVars>;
+    }): void;
+    /** Update color mode without recreating the canvas */
+    setColorMode(colorMode: 'light' | 'dark' | 'system'): void;
+    /**
+     * Apply prop changes by diffing against previously applied props.
+     * This is a convenience method for framework wrappers that centralizes
+     * the logic for detecting and applying changes to nodes, edges, history, and options.
+     * The API stores the previous props internally, so you just pass the new props.
+     *
+     * @param props - The new props to apply
+     */
+    applyProps(props: {
+        nodes?: N[];
+        edges?: E[];
+        history?: Update<N, E>[];
+        options?: APIOptions<N, E>;
+    }): void;
+    /** Cleanup resources when the graph is destroyed */
+    destroy(): void;
 }
 
 type SnapshotMessage<N, E> = {
@@ -575,6 +624,7 @@ declare class Playground {
     private options;
     private rootElement;
     private currentExample;
+    private examples;
     private currentGraph;
     private ingest;
     private isEditable;
@@ -619,8 +669,20 @@ declare class Playground {
     private handleChangeConnection;
     private handleOpenFolder;
     private handleCloseFolder;
+    /**
+     * Add or update an example
+     */
+    addExample(key: string, example: Example): void;
+    /**
+     * Remove an example
+     */
+    removeExample(key: string): void;
+    /**
+     * Update the example list in the DOM
+     */
+    private updateExampleList;
 }
 
 declare function graph<N, E>(args?: APIArguments<N, E>): Promise<API<N, E>>;
 
-export { type Example, type ExampleEdge, type ExampleNode, type ExampleOptions, FileSource, FileSystemSource, type HistoryMessage, Ingest, type IngestMessage, Playground, type PlaygroundOptions, type SnapshotMessage, type UpdateMessage, WebSocketSource, graph as default, graph };
+export { API, type APIArguments, type APIOptions, type EventsOptions, type Example, type ExampleEdge, type ExampleNode, type ExampleOptions, FileSource, FileSystemSource, type HistoryMessage, Ingest, type IngestMessage, type IngestionConfig, Playground, type PlaygroundOptions, type SnapshotMessage, type Update, type UpdateMessage, Updater, WebSocketSource, graph as default, graph };

package/dist/index.d.ts

@@ -11,11 +11,24 @@ type Dims = {
 
 type MarkerType = 'arrow' | 'circle' | 'diamond' | 'bar' | 'none';
 
+/**
+ * Ingestion source configuration.
+ * Used to connect to an external data source for graph updates.
+ */
+type IngestionConfig = {
+    type: 'websocket';
+    url: string;
+    reconnectMs?: number;
+} | {
+    type: 'file';
+    url: string;
+    intervalMs?: number;
+};
 /**
  * Arguments to the API constructor.
  *
- * The caller can specify nodes and edges, or history,
- * but not both.
+ * The caller can specify nodes and edges, history, or ingestion config,
+ * but not multiple.
  *
  * The root element ID is required.
  */
@@ -28,6 +41,8 @@ type APIArguments<N, E> = {
     edges?: E[];
     /** Initial history */
     history?: Update<N, E>[];
+    /** Ingestion source configuration */
+    ingestion?: IngestionConfig;
     /** Events */
     events?: EventsOptions<N, E>;
     /** Root element ID */
@@ -75,6 +90,8 @@ type GraphOptions = {
  * Events that can be handled by the user.
  */
 type EventsOptions<N, E> = {
+    /** Called when the API has finished initializing */
+    onInit?: () => void;
     /** Called when a node is clicked */
     nodeClick?: (node: N) => void;
     /** Called when an edge is clicked */
@@ -368,11 +385,19 @@ declare class API<N, E> {
     private nextNodeId;
     private nextEdgeId;
     private events;
-    private root;
+    private ingest?;
+    private ingestionSource?;
+    private ingestionConfig?;
+    private prevProps;
+    root: string;
     constructor(args: APIArguments<N, E>);
     reset(): void;
     /** Initialize the API */
     init(): Promise<void>;
+    /** Connect to the configured ingestion source */
+    private connectIngestion;
+    /** Disconnect from the ingestion source */
+    private disconnectIngestion;
     private applyHistory;
     /** Current history index (0-based) */
     getHistoryIndex(): number;
@@ -436,6 +461,30 @@ declare class API<N, E> {
     handleAddEdge(data: EditEdgeProps): Promise<void>;
     handleDeleteNode(id: NodeId): Promise<void>;
     handleDeleteEdge(id: EdgeId): Promise<void>;
+    /** Update theme and type styles dynamically */
+    updateStyles(options: {
+        theme?: ThemeVars;
+        nodeTypes?: Record<string, ThemeVars>;
+        edgeTypes?: Record<string, ThemeVars>;
+    }): void;
+    /** Update color mode without recreating the canvas */
+    setColorMode(colorMode: 'light' | 'dark' | 'system'): void;
+    /**
+     * Apply prop changes by diffing against previously applied props.
+     * This is a convenience method for framework wrappers that centralizes
+     * the logic for detecting and applying changes to nodes, edges, history, and options.
+     * The API stores the previous props internally, so you just pass the new props.
+     *
+     * @param props - The new props to apply
+     */
+    applyProps(props: {
+        nodes?: N[];
+        edges?: E[];
+        history?: Update<N, E>[];
+        options?: APIOptions<N, E>;
+    }): void;
+    /** Cleanup resources when the graph is destroyed */
+    destroy(): void;
 }
 
 type SnapshotMessage<N, E> = {
@@ -575,6 +624,7 @@ declare class Playground {
     private options;
     private rootElement;
     private currentExample;
+    private examples;
     private currentGraph;
     private ingest;
     private isEditable;
@@ -619,8 +669,20 @@ declare class Playground {
     private handleChangeConnection;
     private handleOpenFolder;
     private handleCloseFolder;
+    /**
+     * Add or update an example
+     */
+    addExample(key: string, example: Example): void;
+    /**
+     * Remove an example
+     */
+    removeExample(key: string): void;
+    /**
+     * Update the example list in the DOM
+     */
+    private updateExampleList;
 }
 
 declare function graph<N, E>(args?: APIArguments<N, E>): Promise<API<N, E>>;
 
-export { type Example, type ExampleEdge, type ExampleNode, type ExampleOptions, FileSource, FileSystemSource, type HistoryMessage, Ingest, type IngestMessage, Playground, type PlaygroundOptions, type SnapshotMessage, type UpdateMessage, WebSocketSource, graph as default, graph };
+export { API, type APIArguments, type APIOptions, type EventsOptions, type Example, type ExampleEdge, type ExampleNode, type ExampleOptions, FileSource, FileSystemSource, type HistoryMessage, Ingest, type IngestMessage, type IngestionConfig, Playground, type PlaygroundOptions, type SnapshotMessage, type Update, type UpdateMessage, Updater, WebSocketSource, graph as default, graph };