@loaders.gl/graphs 5.0.0-alpha.9

package/README.md

@@ -0,0 +1,66 @@
+# @loaders.gl/graphs
+
+Framework-independent loaders for GraphML and Graphviz DOT documents.
+
+## GraphML loader
+
+`GraphMLLoader` reads the first graph in a GraphML 1.0 document.
+
+```typescript
+import {load} from '@loaders.gl/core';
+import {GraphMLLoader} from '@loaders.gl/graphs';
+
+const graph = await load('network.graphml', GraphMLLoader);
+```
+
+For synchronous parsing, import `GraphMLLoaderWithParser` from
+`@loaders.gl/graphs/graphml-loader` and pass it to `parseSync` from `@loaders.gl/core`.
+The package root exports metadata only; asynchronous core APIs preload the implementation.
+
+The result is `GraphData` with `shape: 'plain-graph-data'`, `nodes`, and `edges`.
+Nodes have `id`, optional `label`, and optional `attributes`. Edges additionally have
+`sourceId`, `targetId`, and `directed`. This shape is compatible with
+`createGraphFromData` in `@deck.gl-community/graph-layers`.
+
+Supported constructs include node and edge identifiers, generated IDs for unnamed edges,
+`edgedefault` and per-edge direction overrides, node/edge/all keys, typed data and defaults,
+unknown data keys, and namespace-prefixed elements. Numeric and boolean keys become JavaScript
+values; other values remain strings. Nested XML data becomes a JSON string.
+
+Only the first graph is returned. Nested graphs, hyperedges, ports, and graph-level data are
+ignored. Nodes without IDs and edges without endpoints are skipped. This is a permissive
+parser, not a GraphML schema validator. Long integers use JavaScript numbers and may lose
+precision outside the safe integer range.
+
+
+## DOT loader
+
+```typescript
+import {load} from '@loaders.gl/core';
+import {DOTLoader} from '@loaders.gl/graphs';
+
+const graph = await load('network.dot', DOTLoader);
+```
+
+Use `DOTLoaderWithParser` from `@loaders.gl/graphs/dot-loader` with `parseSync`
+for synchronous text or UTF-8 `ArrayBuffer` parsing. `DOTLoader` recognizes `.dot` and `.gv` files.
+
+The loader returns the same plain `GraphData` node/edge shape as GraphML, plus typed
+DOT metadata: graph ID, direction, strictness, graph attributes, and subgraph descriptors.
+Identifiers remain strings, including numeric-looking IDs. Unquoted numeric attributes
+become numbers; quoted attributes remain strings. Node and edge `label` attributes are
+also exposed as record labels.
+
+Supported syntax includes `graph` and `digraph`, strict graphs with parallel-edge
+coalescing, implicit nodes, chained edges, repeated attribute lists, scoped node/edge
+defaults, graph attribute assignments, nested named and anonymous subgraphs, comments,
+quoted identifiers, and balanced HTML-like labels. Node and edge attributes include
+subgraph membership descriptors. Reopening a named subgraph retains its attributes and
+node/edge defaults; anonymous subgraph identifiers remain distinct from explicit names. An edge `id`, `Id`, or `ID` attribute supplies its ID;
+otherwise the loader generates an ID from its endpoints and a counter. `dir=none`
+marks an edge as undirected; other `dir` strings mark it as directed.
+
+This is a parser for the supported DOT subset, not a Graphviz renderer. Node ports,
+subgraph endpoints in edge statements, and concatenated quoted strings are unsupported.
+Port syntax is rejected; identifiers containing colons must be quoted. Truncated input,
+trailing content, and edge operators inconsistent with the graph declaration are rejected.

package/dist/dot-loader-types.d.ts

@@ -0,0 +1,36 @@
+import type { DOTGraphData } from "./dot-types.js";
+/** Preloads the DOT parser implementation. */
+declare function preload(): Promise<{
+    parse: (data: ArrayBuffer) => Promise<DOTGraphData>;
+    parseSync: (data: ArrayBuffer) => DOTGraphData;
+    parseTextSync: typeof import("./lib/parse-dot").parseDOT;
+    name: "DOT";
+    id: "dot";
+    module: "graphs";
+    version: any;
+    extensions: ["dot", "gv"];
+    mimeTypes: ["text/vnd.graphviz", "text/x-graphviz", "application/vnd.graphviz"];
+    text: true;
+    worker: false;
+    dataType: DOTGraphData;
+    batchType: never;
+    options: {};
+    preload: typeof preload;
+}>;
+/** Metadata-only loader for Graphviz DOT documents. */
+export declare const DOTLoader: {
+    readonly name: "DOT";
+    readonly id: "dot";
+    readonly module: "graphs";
+    readonly version: any;
+    readonly extensions: ["dot", "gv"];
+    readonly mimeTypes: ["text/vnd.graphviz", "text/x-graphviz", "application/vnd.graphviz"];
+    readonly text: true;
+    readonly worker: false;
+    readonly dataType: DOTGraphData;
+    readonly batchType: never;
+    readonly options: {};
+    readonly preload: typeof preload;
+};
+export {};
+//# sourceMappingURL=dot-loader-types.d.ts.map

package/dist/dot-loader-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dot-loader-types.d.ts","sourceRoot":"","sources":["../src/dot-loader-types.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAC,YAAY,EAAC,uBAAoB;AAK9C,8CAA8C;AAC9C,iBAAe,OAAO;;;;;;;;;;;;cAeS,YAAY;eACtB,KAAK;;;GAbzB;AAED,uDAAuD;AACvD,eAAO,MAAM,SAAS;;;;;;;;;uBASS,YAAY;wBACtB,KAAK;;;CAGsB,CAAC"}

package/dist/dot-loader-types.js

@@ -0,0 +1,26 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+// @ts-ignore __VERSION__ is injected by the build.
+const VERSION = typeof "5.0.0-alpha.9" !== 'undefined' ? "5.0.0-alpha.9" : 'latest';
+/** Preloads the DOT parser implementation. */
+async function preload() {
+    const { DOTLoaderWithParser } = await import('@loaders.gl/graphs/dot-loader');
+    return DOTLoaderWithParser;
+}
+/** Metadata-only loader for Graphviz DOT documents. */
+export const DOTLoader = {
+    name: 'DOT',
+    id: 'dot',
+    module: 'graphs',
+    version: VERSION,
+    extensions: ['dot', 'gv'],
+    mimeTypes: ['text/vnd.graphviz', 'text/x-graphviz', 'application/vnd.graphviz'],
+    text: true,
+    worker: false,
+    dataType: null,
+    batchType: null,
+    options: {},
+    preload
+};
+//# sourceMappingURL=dot-loader-types.js.map

package/dist/dot-loader-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dot-loader-types.js","sourceRoot":"","sources":["../src/dot-loader-types.ts"],"names":[],"mappings":"AAAA,aAAa;AACb,+BAA+B;AAC/B,oCAAoC;AAKpC,mDAAmD;AACnD,MAAM,OAAO,GAAG,sBAAkB,KAAK,WAAW,CAAC,CAAC,iBAAa,CAAC,CAAC,QAAQ,CAAC;AAE5E,8CAA8C;AAC9C,KAAK,UAAU,OAAO;IACpB,MAAM,EAAC,mBAAmB,EAAC,GAAG,MAAM,MAAM,CAAC,+BAA+B,CAAC,CAAC;IAC5E,OAAO,mBAAmB,CAAC;AAC7B,CAAC;AAED,uDAAuD;AACvD,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,IAAI,EAAE,KAAK;IACX,EAAE,EAAE,KAAK;IACT,MAAM,EAAE,QAAQ;IAChB,OAAO,EAAE,OAAO;IAChB,UAAU,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC;IACzB,SAAS,EAAE,CAAC,mBAAmB,EAAE,iBAAiB,EAAE,0BAA0B,CAAC;IAC/E,IAAI,EAAE,IAAI;IACV,MAAM,EAAE,KAAK;IACb,QAAQ,EAAE,IAA+B;IACzC,SAAS,EAAE,IAAa;IACxB,OAAO,EAAE,EAAE;IACX,OAAO;CACuC,CAAC"}