@graphty/graphty-element 2.6.1 → 3.0.0

package/dist/src/data/csv-variant-detection.d.ts

@@ -1,29 +0,0 @@
-export type CSVVariant = "neo4j" | "gephi" | "cytoscape" | "adjacency-list" | "edge-list" | "node-list" | "generic";
-export interface CSVVariantInfo {
-    variant: CSVVariant;
-    hasHeaders: boolean;
-    delimiter: string;
-    sourceColumn?: string;
-    targetColumn?: string;
-    idColumn?: string;
-    labelColumn?: string;
-    typeColumn?: string;
-    interactionColumn?: string;
-}
-/**
- * Work out a delimited file's column separator from its first line.
- *
- * Papaparse's own guess is not used because it guesses from the rows it previews, and the one-row
- * preview that reads the header row sees too little to tell a tab from a comma: it answers "," and
- * the header `source<TAB>target` comes back as one column.
- * @param content - The file, or at least its first line.
- * @returns Whichever of comma, tab, semicolon and pipe appears most often outside quotes on the
- * first line, or a comma when none does.
- */
-export declare function sniffDelimiter(content: string): string;
-/**
- * Detect CSV variant from headers and sample data
- * @param headers - Array of column header names
- * @returns Information about the detected CSV variant including column mappings
- */
-export declare function detectCSVVariant(headers: string[]): CSVVariantInfo;

package/dist/src/data/ingest.d.ts

@@ -1,104 +0,0 @@
-import type { GraphStore } from "./GraphStore";
-/**
- * Whether a value may be used as a graph-format node id.
- *
- * graph-format accepts a string or a FINITE number and throws `E_INVALID_ID` for anything else
- * (`graph-format/src/ids/node-id-map.ts`). The element is looser: a node id is whatever the
- * configured JMESPath expression returns, which is `null` for a record that does not carry the
- * key at all, and the element has always let such a record through and rendered it. So the id is
- * CHECKED here rather than thrown on -- an unusable id leaves the render object exactly as it is
- * today and keeps it out of the store, which is the one place the id has to be real.
- * @param id - the extracted id
- * @returns true when graph-format will accept it
- */
-export declare function isStorableId(id: unknown): id is string | number;
-/**
- * Push one node record into the element's builder and seed its import position.
- *
- * The seed column keeps FILE units: `config.data.knownFields.positionScale` is applied by
- * `GraphStore` on every freeze, so a scale changed after a record arrived still reaches the scene
- * correctly from the same column.
- * @param store - the element's store
- * @param id - the node id, already extracted with JMESPath
- * @param record - the raw record
- * @returns the assigned node index -- `INVALID_INDEX` when the id is not one graph-format accepts
- *     -- and whether the builder already knew this id
- */
-export declare function ingestNode(store: GraphStore, id: unknown, record: Record<string | number, unknown>): {
-    index: number;
-    merged: boolean;
-};
-/**
- * Resolve an edge weight: the configured path, then the legacy "value" key, then 1.
- *
- * The second probe exists because the conversion this replaced hard-coded a `value` weight key, so
- * every weighted dataset, fixture and story in this repository carries `value` and nothing carries
- * `weight`. Reading only the configured path would silently re-read all of them as unweighted.
- * The probe is removed once nothing ships a `value` key.
- * @param record - the raw edge record
- * @param path - `config.data.knownFields.edgeWeightPath`; null means "do not look"
- * @returns the weight and which probe produced it
- */
-export declare function resolveEdgeWeight(record: Record<string | number, unknown>, path: string | null): {
-    weight: number;
-    source: "path" | "legacy" | "default";
-};
-/**
- * Push one edge into the element's builder and stamp its element-assigned counter column.
- *
- * The builder is constructed with `addMissingNodes: true`, so an endpoint that has not arrived yet
- * is MATERIALISED here and the snapshot is complete while the render side is still catching up.
- * That is deliberate: the snapshot is the authoritative copy, and it must not be missing an edge
- * merely because a mesh has not been built for one of its endpoints.
- *
- * Note the argument order of `setEdgeValue`: `(column, edge, value)`. Swapping the first two is
- * `E_UNKNOWN_COLUMN` at run time in plain JavaScript; the branded `ColumnHandle` type is what makes
- * it a compile error here.
- * @param store - the element's store
- * @param srcId - source node id, already extracted with JMESPath
- * @param dstId - destination node id
- * @param weight - the resolved weight
- * @param fileId - the edge's id read at the configured `edgeIdPath`, when there is one: its stable
- *     identity (design/sets/sets-design.md 12.3)
- * @returns the logical edge index and the counter stamped into the edge's id column, or
- *     `INVALID_INDEX` for both when either id is not one graph-format accepts
- */
-export declare function ingestEdge(store: GraphStore, srcId: unknown, dstId: unknown, weight: number, fileId?: string | number): {
-    index: number;
-    edgeId: number;
-};
-/**
- * What became of a file's declared direction when it reached the builder.
- *
- * - `applied`: the builder now holds the direction the file declared.
- * - `unchanged`: the builder already held it, so there was nothing to do.
- * - `config-wins`: `data.directed` was set explicitly, which locked the builder. The consumer
- *   settled the question and a file header does not overrule them.
- * - `edges-present`: the builder already holds edges, which is a direction graph-format will not
- *   reinterpret in place. This is a second file loaded into a graph that the first file, or
- *   pushed records, already filled.
- */
-export type DirectionOutcome = "applied" | "unchanged" | "config-wins" | "edges-present";
-/**
- * Give the builder the direction a file declared, without ever overruling the consumer.
- *
- * THE PRECEDENCE, highest first: an explicit `config.data.directed`, then the file's own header,
- * then the builder's constructor value. `GraphStore` implements the first rung by calling
- * `lockDirected()` for an explicit boolean and NOT calling it under `"auto"`, so
- * `builder.directedLocked` is exactly "the consumer has settled this" and is the flag this reads.
- * Locked is checked rather than caught, because `setDirected` on a locked builder whose value
- * differs throws `E_DIRECTED` -- turning a consumer's perfectly legitimate `directed: false` plus
- * a directed file into a failed import.
- *
- * A builder that already holds edges is refused for the same reason and not as a policy choice:
- * graph-format accepts directed -> undirected only while the builder is empty, and accepts
- * undirected -> directed with live edges only by MIRRORING every edge it holds, which would
- * silently double the first file's edge count when a second file disagreed with it. So the first
- * thing that settles the direction of a non-empty graph keeps it, and the caller is told.
- * @param store - the element's store
- * @param directed - the direction the file declared
- * @param statedBy - the text in the file that declared it, recorded on the store so a consumer can
- *     be told not only what the graph is but what said so
- * @returns what happened, for the caller to log
- */
-export declare function ingestDeclaredDirection(store: GraphStore, directed: boolean, statedBy: string): DirectionOutcome;