@graphty/graph-io 0.0.0 → 0.2.0

package/dist/src/registry.js

@@ -0,0 +1,481 @@
+/**
+ * The importer / exporter registry (design sections 8.2 and 8.4): the eight built-in formats
+ * registered by name, `sniff()` over them, and the two conveniences for callers who do not own a
+ * sink: `importGraph()` sniffs the format, creates a builder seeded from the common options
+ * (`directed: true` as a placeholder; the importer sets the real value), imports and freezes;
+ * `exportGraph()` looks the exporter up by name. A caller who owns a builder uses the importer
+ * objects directly (the subpath exports) and this module never touches their sink.
+ */
+import { GraphBuilder, GraphFormatError, } from "@graphty/graph-format";
+import { throwIfAborted } from "./common/input.js";
+import { ImportReportBuilder } from "./common/report.js";
+import { csvExporter, csvImporter } from "./formats/csv/index.js";
+import { dotExporter, dotImporter } from "./formats/dot/index.js";
+import { gexfExporter, gexfImporter } from "./formats/gexf/index.js";
+import { gmlExporter, gmlImporter } from "./formats/gml/index.js";
+import { graphmlExporter, graphmlImporter } from "./formats/graphml/index.js";
+import { jsonExporter, jsonImporter } from "./formats/json/index.js";
+import { neo4jExporter, neo4jImporter } from "./formats/neo4j/index.js";
+import { pajekExporter, pajekImporter } from "./formats/pajek/index.js";
+import { rankFormats, SNIFF_HEAD_BYTES } from "./sniff.js";
+/** The issue code of an input whose format no registered importer recognises. */
+export const UNKNOWN_FORMAT_CODE = "E_UNKNOWN_FORMAT";
+/** The keys of ImportGraphOptions that belong to the registry, never to an importer. */
+const REGISTRY_KEYS = new Set(["format", "filename", "mimeType", "builder", "freeze"]);
+/**
+ * A registry of importers and exporters by format name. Registration order is the tie-break
+ * order of sniffing (design section 8.2); the default registry lists the built-in formats in the
+ * order of GRAPH_FORMATS.
+ */
+export class FormatRegistry {
+    constructor() {
+        this.importerMap = new Map();
+        this.exporterMap = new Map();
+    }
+    /**
+     * Register an importer under its format name, replacing one of the same name in place (the
+     * original registration order is kept).
+     * @param importer - the importer
+     * @returns this registry, for chaining
+     */
+    registerImporter(importer) {
+        this.importerMap.set(importer.format, importer);
+        return this;
+    }
+    /**
+     * Register an exporter under its format name, replacing one of the same name.
+     * @param exporter - the exporter
+     * @returns this registry, for chaining
+     */
+    registerExporter(exporter) {
+        this.exporterMap.set(exporter.format, exporter);
+        return this;
+    }
+    /**
+     * The importer of a format.
+     * @param format - the format name
+     * @returns the importer; E_UNSUPPORTED when none is registered
+     */
+    importer(format) {
+        const importer = this.importerMap.get(format);
+        if (importer === undefined) {
+            throw unknownFormat("importer", format, this.importerMap.keys());
+        }
+        return importer;
+    }
+    /**
+     * The exporter of a format.
+     * @param format - the format name
+     * @returns the exporter; E_UNSUPPORTED when none is registered
+     */
+    exporter(format) {
+        const exporter = this.exporterMap.get(format);
+        if (exporter === undefined) {
+            throw unknownFormat("exporter", format, this.exporterMap.keys());
+        }
+        return exporter;
+    }
+    /**
+     * Whether an importer is registered for a format.
+     * @param format - the format name
+     * @returns true when importer(format) would succeed
+     */
+    hasImporter(format) {
+        return this.importerMap.has(format);
+    }
+    /**
+     * Whether an exporter is registered for a format.
+     * @param format - the format name
+     * @returns true when exporter(format) would succeed
+     */
+    hasExporter(format) {
+        return this.exporterMap.has(format);
+    }
+    /**
+     * Every registered importer, in registration order.
+     * @returns the importers
+     */
+    importers() {
+        return [...this.importerMap.values()];
+    }
+    /**
+     * Every registered exporter, in registration order.
+     * @returns the exporters
+     */
+    exporters() {
+        return [...this.exporterMap.values()];
+    }
+    /**
+     * The names of every format with an importer or an exporter, importers' order first.
+     * @returns the format names, each once
+     */
+    formats() {
+        return [...new Set([...this.importerMap.keys(), ...this.exporterMap.keys()])];
+    }
+    /**
+     * Rank the registered importers for an input (design section 8.2; the successor of
+     * graphty-element's detectFormat()).
+     * @param hints - the filename, MIME type and / or head of the input
+     * @returns the candidates, best first; empty when nothing matches
+     */
+    sniffAll(hints) {
+        return rankFormats(hints, this.importerMap.values());
+    }
+    /**
+     * The best importer for an input, or null when no registered importer claims it.
+     * @param hints - the filename, MIME type and / or head of the input
+     * @returns the best candidate, or null
+     */
+    sniff(hints) {
+        const ranked = this.sniffAll(hints);
+        return ranked.length > 0 ? ranked[0] : null;
+    }
+    /**
+     * Read an input into a fresh builder and freeze it (design section 8.4: for callers who do not
+     * own a sink). The format is the one named in the options, else sniffed from the filename,
+     * the MIME type and the first bytes of the content; the builder is seeded from the common
+     * options with `directed: true` as a placeholder that the importer overrides from the file.
+     * @param input - the text, bytes, stream or chunks to read
+     * @param options - the format, hints, common and format-specific import options
+     * @returns the snapshot, the import report and the freeze report
+     */
+    async importGraph(input, options = {}) {
+        const requested = options.format ?? "auto";
+        let importer;
+        let sniff = null;
+        let source = input;
+        let peeked = null;
+        if (requested === "auto") {
+            peeked = await peekHead(input, SNIFF_HEAD_BYTES, options.signal ?? null);
+            source = peeked.input;
+            sniff = this.sniff({ filename: options.filename, mimeType: options.mimeType, head: peeked.head });
+            if (sniff === null) {
+                const report = new ImportReportBuilder("unknown", 0);
+                return report.fail(UNKNOWN_FORMAT_CODE, `no registered importer recognises the input${describeHints(options)}; pass the format explicitly`, undefined, { formats: this.formats() });
+            }
+            importer = this.importer(sniff.format);
+        }
+        else {
+            importer = this.importer(requested);
+        }
+        const builder = new GraphBuilder({
+            weightDtype: options.weightDtype ?? "f64",
+            ...options.builder,
+            directed: true,
+            addMissingNodes: options.addMissingNodes ?? true,
+            duplicateEdges: options.duplicateEdges ?? "keep",
+            selfLoops: options.selfLoops ?? "keep",
+        });
+        let report;
+        try {
+            report = await importer.import(source, builder, importerOptions(options));
+        }
+        catch (err) {
+            await peeked?.close();
+            throw err;
+        }
+        const frozen = builder.freezeWithReport(options.freeze);
+        return Object.freeze({
+            format: importer.format,
+            sniff,
+            snapshot: frozen.snapshot,
+            report,
+            freeze: frozen.report,
+        });
+    }
+    /**
+     * Write a snapshot in a format, as UTF-8 chunks (design section 8.5).
+     * @param snapshot - the snapshot
+     * @param format - the format name
+     * @param options - the exporter's common and format-specific options
+     * @returns the encoded chunks
+     */
+    exportGraph(snapshot, format, options) {
+        return this.exporter(format).export(snapshot, options);
+    }
+    /**
+     * Write a snapshot in a format, as one string.
+     * @param snapshot - the snapshot
+     * @param format - the format name
+     * @param options - the exporter's common and format-specific options
+     * @returns the whole document
+     */
+    async exportGraphToString(snapshot, format, options) {
+        return this.exporter(format).exportToString(snapshot, options);
+    }
+    /**
+     * What exporting a snapshot in a format would lose, without writing anything.
+     * @param snapshot - the snapshot
+     * @param format - the format name
+     * @param options - the exporter's common and format-specific options
+     * @returns the loss notes, empty when the export is exact
+     */
+    checkExport(snapshot, format, options) {
+        return this.exporter(format).check(snapshot, options);
+    }
+}
+/**
+ * A registry holding the eight built-in importers and exporters in the order of GRAPH_FORMATS.
+ * @returns a new registry
+ */
+export function createRegistry() {
+    return new FormatRegistry()
+        .registerImporter(jsonImporter)
+        .registerExporter(jsonExporter)
+        .registerImporter(graphmlImporter)
+        .registerExporter(graphmlExporter)
+        .registerImporter(gexfImporter)
+        .registerExporter(gexfExporter)
+        .registerImporter(csvImporter)
+        .registerExporter(csvExporter)
+        .registerImporter(gmlImporter)
+        .registerExporter(gmlExporter)
+        .registerImporter(dotImporter)
+        .registerExporter(dotExporter)
+        .registerImporter(pajekImporter)
+        .registerExporter(pajekExporter)
+        .registerImporter(neo4jImporter)
+        .registerExporter(neo4jExporter);
+}
+/** The default registry: every built-in format. */
+export const registry = createRegistry();
+/**
+ * Read an input into a fresh builder and freeze it, through the default registry (design section
+ * 8.4: `importGraph(input, { format?, ...options })`).
+ * @param input - the text, bytes, stream or chunks to read
+ * @param options - the format, hints, common and format-specific import options
+ * @returns the snapshot, the import report and the freeze report
+ */
+export function importGraph(input, options) {
+    return registry.importGraph(input, options);
+}
+/**
+ * Write a snapshot in a format through the default registry, as UTF-8 chunks.
+ * @param snapshot - the snapshot
+ * @param format - the format name
+ * @param options - the exporter's common and format-specific options
+ * @returns the encoded chunks
+ */
+export function exportGraph(snapshot, format, options) {
+    return registry.exportGraph(snapshot, format, options);
+}
+/**
+ * Write a snapshot in a format through the default registry, as one string.
+ * @param snapshot - the snapshot
+ * @param format - the format name
+ * @param options - the exporter's common and format-specific options
+ * @returns the whole document
+ */
+export async function exportGraphToString(snapshot, format, options) {
+    return registry.exportGraphToString(snapshot, format, options);
+}
+/**
+ * What exporting a snapshot in a format would lose, through the default registry.
+ * @param snapshot - the snapshot
+ * @param format - the format name
+ * @param options - the exporter's common and format-specific options
+ * @returns the loss notes, empty when the export is exact
+ */
+export function checkExport(snapshot, format, options) {
+    return registry.checkExport(snapshot, format, options);
+}
+/**
+ * Sniff an input's format through the default registry.
+ * @param hints - the filename, MIME type and / or head of the input
+ * @returns the best candidate, or null when no built-in importer claims it
+ */
+export function sniff(hints) {
+    return registry.sniff(hints);
+}
+/**
+ * The options handed to the importer: everything but the registry's own keys.
+ * @param options - the importGraph options
+ * @returns the importer's options
+ */
+function importerOptions(options) {
+    const out = {};
+    for (const [key, value] of Object.entries(options)) {
+        if (!REGISTRY_KEYS.has(key)) {
+            out[key] = value;
+        }
+    }
+    return out;
+}
+/**
+ * The E_UNSUPPORTED error of a format name nothing is registered under.
+ * @param kind - importer or exporter
+ * @param format - the requested name
+ * @param known - the registered names
+ * @returns the error
+ */
+function unknownFormat(kind, format, known) {
+    const supported = [...known];
+    return new GraphFormatError("E_UNSUPPORTED", `no ${kind} is registered for format ${JSON.stringify(format)}; known: ${supported.join(", ")}`, { option: "format", found: format, supported });
+}
+/**
+ * The hints of an import, for the unknown-format message.
+ * @param options - the importGraph options
+ * @returns " (filename ..., MIME type ...)" or an empty string
+ */
+function describeHints(options) {
+    const parts = [];
+    if (typeof options.filename === "string" && options.filename.length > 0) {
+        parts.push(`filename ${JSON.stringify(options.filename)}`);
+    }
+    if (typeof options.mimeType === "string" && options.mimeType.length > 0) {
+        parts.push(`MIME type ${JSON.stringify(options.mimeType)}`);
+    }
+    return parts.length === 0 ? "" : ` (${parts.join(", ")})`;
+}
+/**
+ * The first `bytes` of an input without consuming it: in-memory input is sliced; a stream or an
+ * async iterable is read until enough is buffered and then replayed (the buffered chunks first,
+ * the rest as it arrives) through a new async iterable that cancels the source when the importer
+ * stops early.
+ * @param input - the input
+ * @param bytes - how much to peek
+ * @param signal - the cancellation signal, or null
+ * @returns the head and the input to read
+ */
+async function peekHead(input, bytes, signal) {
+    if (typeof input === "string") {
+        return { head: input.slice(0, bytes), input, close: () => Promise.resolve() };
+    }
+    if (input instanceof Uint8Array) {
+        return { head: input.subarray(0, bytes), input, close: () => Promise.resolve() };
+    }
+    throwIfAborted(signal);
+    const source = typeof input.getReader === "function"
+        ? readerIterator(input)
+        : input[Symbol.asyncIterator]();
+    const buffered = [];
+    let size = 0;
+    let finished = false;
+    while (size < bytes) {
+        if (signal !== null && signal.aborted) {
+            await source.return?.();
+            throwIfAborted(signal);
+        }
+        const next = await source.next();
+        if (next.done === true) {
+            finished = true;
+            break;
+        }
+        buffered.push(next.value);
+        size += typeof next.value === "string" ? next.value.length : next.value.byteLength;
+    }
+    if (!finished && signal !== null && signal.aborted) {
+        // an abort that landed on the read completing the head: close the source before rethrowing
+        await source.return?.();
+        throwIfAborted(signal);
+    }
+    const replayed = replay(buffered, source, finished);
+    return { head: joinHead(buffered, bytes), input: replayed, close: () => replayed.close() };
+}
+/**
+ * The head text or bytes of the buffered chunks: bytes when every chunk is bytes, text otherwise
+ * (byte chunks decoded leniently; the importer decodes the real input strictly).
+ * @param chunks - the buffered chunks
+ * @param bytes - the head size
+ * @returns the head
+ */
+function joinHead(chunks, bytes) {
+    if (chunks.every((c) => c instanceof Uint8Array)) {
+        const total = Math.min(bytes, chunks.reduce((sum, c) => sum + c.byteLength, 0));
+        const head = new Uint8Array(total);
+        let offset = 0;
+        for (const chunk of chunks) {
+            if (offset >= total) {
+                break;
+            }
+            const part = chunk.subarray(0, Math.min(chunk.byteLength, total - offset));
+            head.set(part, offset);
+            offset += part.byteLength;
+        }
+        return head;
+    }
+    const decoder = new TextDecoder("utf-8", { fatal: false });
+    let text = "";
+    for (const chunk of chunks) {
+        text += typeof chunk === "string" ? chunk : decoder.decode(chunk, { stream: true });
+        if (text.length >= bytes) {
+            break;
+        }
+    }
+    return text.slice(0, bytes);
+}
+/**
+ * An async iterable that yields the buffered chunks, then the rest of the source; the source is
+ * closed when the consumer stops early.
+ * @param buffered - the chunks already read
+ * @param source - the iterator positioned after them
+ * @param finished - whether the source is already exhausted
+ * @returns the replaying iterable
+ */
+function replay(buffered, source, finished) {
+    let exhausted = finished;
+    const close = async () => {
+        if (!exhausted) {
+            exhausted = true;
+            await source.return?.();
+        }
+    };
+    return {
+        close,
+        [Symbol.asyncIterator]() {
+            let position = 0;
+            return {
+                async next() {
+                    if (position < buffered.length) {
+                        return { done: false, value: buffered[position++] };
+                    }
+                    if (exhausted) {
+                        return { done: true, value: undefined };
+                    }
+                    const next = await source.next();
+                    if (next.done === true) {
+                        exhausted = true;
+                        return { done: true, value: undefined };
+                    }
+                    return next;
+                },
+                async return() {
+                    await close();
+                    return { done: true, value: undefined };
+                },
+            };
+        },
+    };
+}
+/**
+ * An async iterator over a ReadableStream's chunks that cancels the stream when closed early.
+ * @param stream - the stream
+ * @returns the iterator
+ */
+function readerIterator(stream) {
+    const reader = stream.getReader();
+    let done = false;
+    return {
+        async next() {
+            if (done) {
+                return { done: true, value: undefined };
+            }
+            const result = await reader.read();
+            if (result.done) {
+                done = true;
+                reader.releaseLock();
+                return { done: true, value: undefined };
+            }
+            return { done: false, value: result.value };
+        },
+        async return() {
+            if (!done) {
+                done = true;
+                await reader.cancel().catch(() => undefined);
+                reader.releaseLock();
+            }
+            return { done: true, value: undefined };
+        },
+    };
+}
+//# sourceMappingURL=registry.js.map

package/dist/src/registry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"registry.js","sourceRoot":"","sources":["../../src/registry.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAGH,YAAY,EAEZ,gBAAgB,GAEnB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAClE,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAC9E,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACxE,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACxE,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAqC,MAAM,YAAY,CAAC;AAW9F,iFAAiF;AACjF,MAAM,CAAC,MAAM,mBAAmB,GAAG,kBAAkB,CAAC;AAiDtD,wFAAwF;AACxF,MAAM,aAAa,GAAwB,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC;AAE5G;;;;GAIG;AACH,MAAM,OAAO,cAAc;IAA3B;QACqB,gBAAW,GAAG,IAAI,GAAG,EAAyB,CAAC;QAE/C,gBAAW,GAAG,IAAI,GAAG,EAAyB,CAAC;IAwMpE,CAAC;IAtMG;;;;;OAKG;IACH,gBAAgB,CAAC,QAAuB;QACpC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAChD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,gBAAgB,CAAC,QAAuB;QACpC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAChD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,MAAc;QACnB,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC9C,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YACzB,MAAM,aAAa,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC;QACrE,CAAC;QACD,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,MAAc;QACnB,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC9C,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YACzB,MAAM,aAAa,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC;QACrE,CAAC;QACD,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,WAAW,CAAC,MAAc;QACtB,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACH,WAAW,CAAC,MAAc;QACtB,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACxC,CAAC;IAED;;;OAGG;IACH,SAAS;QACL,OAAO,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED;;;OAGG;IACH,SAAS;QACL,OAAO,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED;;;OAGG;IACH,OAAO;QACH,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAClF,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAC,KAAiB;QACtB,OAAO,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,KAAiB;QACnB,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACpC,OAAO,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAChD,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,WAAW,CAAC,KAAkB,EAAE,UAA8B,EAAE;QAClE,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC;QAC3C,IAAI,QAAuB,CAAC;QAC5B,IAAI,KAAK,GAAuB,IAAI,CAAC;QACrC,IAAI,MAAM,GAAG,KAAK,CAAC;QACnB,IAAI,MAAM,GAAuB,IAAI,CAAC;QACtC,IAAI,SAAS,KAAK,MAAM,EAAE,CAAC;YACvB,MAAM,GAAG,MAAM,QAAQ,CAAC,KAAK,EAAE,gBAAgB,EAAE,OAAO,CAAC,MAAM,IAAI,IAAI,CAAC,CAAC;YACzE,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC;YACtB,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;YAClG,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;gBACjB,MAAM,MAAM,GAAG,IAAI,mBAAmB,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;gBACrD,OAAO,MAAM,CAAC,IAAI,CACd,mBAAmB,EACnB,8CAA8C,aAAa,CAAC,OAAO,CAAC,8BAA8B,EAClG,SAAS,EACT,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,EAAE,CAC9B,CAAC;YACN,CAAC;YACD,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC3C,CAAC;aAAM,CAAC;YACJ,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QACxC,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,YAAY,CAAC;YAC7B,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,KAAK;YACzC,GAAG,OAAO,CAAC,OAAO;YAClB,QAAQ,EAAE,IAAI;YACd,eAAe,EAAE,OAAO,CAAC,eAAe,IAAI,IAAI;YAChD,cAAc,EAAE,OAAO,CAAC,cAAc,IAAI,MAAM;YAChD,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,MAAM;SACzC,CAAC,CAAC;QACH,IAAI,MAAoB,CAAC;QACzB,IAAI,CAAC;YACD,MAAM,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC;QAC9E,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,MAAM,MAAM,EAAE,KAAK,EAAE,CAAC;YACtB,MAAM,GAAG,CAAC;QACd,CAAC;QACD,MAAM,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACxD,OAAO,MAAM,CAAC,MAAM,CAAC;YACjB,MAAM,EAAE,QAAQ,CAAC,MAAM;YACvB,KAAK;YACL,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,MAAM;YACN,MAAM,EAAE,MAAM,CAAC,MAAM;SACxB,CAAC,CAAC;IACP,CAAC;IAED;;;;;;OAMG;IACH,WAAW,CAAC,QAAuB,EAAE,MAAc,EAAE,OAA4B;QAC7E,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,mBAAmB,CAAC,QAAuB,EAAE,MAAc,EAAE,OAA4B;QAC3F,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,cAAc,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;OAMG;IACH,WAAW,CAAC,QAAuB,EAAE,MAAc,EAAE,OAA4B;QAC7E,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;CACJ;AAED;;;GAGG;AACH,MAAM,UAAU,cAAc;IAC1B,OAAO,IAAI,cAAc,EAAE;SACtB,gBAAgB,CAAC,YAAY,CAAC;SAC9B,gBAAgB,CAAC,YAAY,CAAC;SAC9B,gBAAgB,CAAC,eAAe,CAAC;SACjC,gBAAgB,CAAC,eAAe,CAAC;SACjC,gBAAgB,CAAC,YAAY,CAAC;SAC9B,gBAAgB,CAAC,YAAY,CAAC;SAC9B,gBAAgB,CAAC,WAAW,CAAC;SAC7B,gBAAgB,CAAC,WAAW,CAAC;SAC7B,gBAAgB,CAAC,WAAW,CAAC;SAC7B,gBAAgB,CAAC,WAAW,CAAC;SAC7B,gBAAgB,CAAC,WAAW,CAAC;SAC7B,gBAAgB,CAAC,WAAW,CAAC;SAC7B,gBAAgB,CAAC,aAAa,CAAC;SAC/B,gBAAgB,CAAC,aAAa,CAAC;SAC/B,gBAAgB,CAAC,aAAa,CAAC;SAC/B,gBAAgB,CAAC,aAAa,CAAC,CAAC;AACzC,CAAC;AAED,mDAAmD;AACnD,MAAM,CAAC,MAAM,QAAQ,GAAmB,cAAc,EAAE,CAAC;AAEzD;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CAAC,KAAkB,EAAE,OAA4B;IACxE,OAAO,QAAQ,CAAC,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;AAChD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CACvB,QAAuB,EACvB,MAAc,EACd,OAA4B;IAE5B,OAAO,QAAQ,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;AAC3D,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACrC,QAAuB,EACvB,MAAc,EACd,OAA4B;IAE5B,OAAO,QAAQ,CAAC,mBAAmB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;AACnE,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CACvB,QAAuB,EACvB,MAAc,EACd,OAA4B;IAE5B,OAAO,QAAQ,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;AAC3D,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,KAAK,CAAC,KAAiB;IACnC,OAAO,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AACjC,CAAC;AAED;;;;GAIG;AACH,SAAS,eAAe,CAAC,OAA2B;IAChD,MAAM,GAAG,GAA4B,EAAE,CAAC;IACxC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QACjD,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1B,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QACrB,CAAC;IACL,CAAC;IACD,OAAO,GAAG,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,SAAS,aAAa,CAAC,IAA6B,EAAE,MAAc,EAAE,KAAuB;IACzF,MAAM,SAAS,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC;IAC7B,OAAO,IAAI,gBAAgB,CACvB,eAAe,EACf,MAAM,IAAI,6BAA6B,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,YAAY,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAC/F,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,CACjD,CAAC;AACN,CAAC;AAED;;;;GAIG;AACH,SAAS,aAAa,CAAC,OAA2B;IAC9C,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtE,KAAK,CAAC,IAAI,CAAC,YAAY,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAC/D,CAAC;IACD,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtE,KAAK,CAAC,IAAI,CAAC,aAAa,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAChE,CAAC;IACD,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;AAC9D,CAAC;AAgBD;;;;;;;;;GASG;AACH,KAAK,UAAU,QAAQ,CAAC,KAAkB,EAAE,KAAa,EAAE,MAA0B;IACjF,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC5B,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,GAAkB,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;IACjG,CAAC;IACD,IAAI,KAAK,YAAY,UAAU,EAAE,CAAC;QAC9B,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,GAAkB,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;IACpG,CAAC;IACD,cAAc,CAAC,MAAM,CAAC,CAAC;IACvB,MAAM,MAAM,GACR,OAAQ,KAAiC,CAAC,SAAS,KAAK,UAAU;QAC9D,CAAC,CAAC,cAAc,CAAC,KAAmC,CAAC;QACrD,CAAC,CAAE,KAA4C,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC;IAChF,MAAM,QAAQ,GAA4B,EAAE,CAAC;IAC7C,IAAI,IAAI,GAAG,CAAC,CAAC;IACb,IAAI,QAAQ,GAAG,KAAK,CAAC;IACrB,OAAO,IAAI,GAAG,KAAK,EAAE,CAAC;QAClB,IAAI,MAAM,KAAK,IAAI,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACpC,MAAM,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC;YACxB,cAAc,CAAC,MAAM,CAAC,CAAC;QAC3B,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;QACjC,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;YACrB,QAAQ,GAAG,IAAI,CAAC;YAChB,MAAM;QACV,CAAC;QACD,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC1B,IAAI,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;IACvF,CAAC;IACD,IAAI,CAAC,QAAQ,IAAI,MAAM,KAAK,IAAI,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACjD,2FAA2F;QAC3F,MAAM,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC;QACxB,cAAc,CAAC,MAAM,CAAC,CAAC;IAC3B,CAAC;IACD,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IACpD,OAAO,EAAE,IAAI,EAAE,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAkB,EAAE,CAAC,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC;AAC9G,CAAC;AAED;;;;;;GAMG;AACH,SAAS,QAAQ,CAAC,MAAwC,EAAE,KAAa;IACrE,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,YAAY,UAAU,CAAC,EAAE,CAAC;QAC/C,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAClB,KAAK,EACL,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,CACnD,CAAC;QACF,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC;QACnC,IAAI,MAAM,GAAG,CAAC,CAAC;QACf,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YACzB,IAAI,MAAM,IAAI,KAAK,EAAE,CAAC;gBAClB,MAAM;YACV,CAAC;YACD,MAAM,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,UAAU,EAAE,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC;YAC3E,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YACvB,MAAM,IAAI,IAAI,CAAC,UAAU,CAAC;QAC9B,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,MAAM,OAAO,GAAG,IAAI,WAAW,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;IAC3D,IAAI,IAAI,GAAG,EAAE,CAAC;IACd,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QACzB,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QACpF,IAAI,IAAI,CAAC,MAAM,IAAI,KAAK,EAAE,CAAC;YACvB,MAAM;QACV,CAAC;IACL,CAAC;IACD,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;AAChC,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,MAAM,CACX,QAA0C,EAC1C,MAA0C,EAC1C,QAAiB;IAEjB,IAAI,SAAS,GAAG,QAAQ,CAAC;IACzB,MAAM,KAAK,GAAG,KAAK,IAAmB,EAAE;QACpC,IAAI,CAAC,SAAS,EAAE,CAAC;YACb,SAAS,GAAG,IAAI,CAAC;YACjB,MAAM,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC;QAC5B,CAAC;IACL,CAAC,CAAC;IACF,OAAO;QACH,KAAK;QACL,CAAC,MAAM,CAAC,aAAa,CAAC;YAClB,IAAI,QAAQ,GAAG,CAAC,CAAC;YACjB,OAAO;gBACH,KAAK,CAAC,IAAI;oBACN,IAAI,QAAQ,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC;wBAC7B,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC;oBACxD,CAAC;oBACD,IAAI,SAAS,EAAE,CAAC;wBACZ,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;oBAC5C,CAAC;oBACD,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;oBACjC,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;wBACrB,SAAS,GAAG,IAAI,CAAC;wBACjB,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;oBAC5C,CAAC;oBACD,OAAO,IAAI,CAAC;gBAChB,CAAC;gBACD,KAAK,CAAC,MAAM;oBACR,MAAM,KAAK,EAAE,CAAC;oBACd,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;gBAC5C,CAAC;aACJ,CAAC;QACN,CAAC;KACJ,CAAC;AACN,CAAC;AAED;;;;GAIG;AACH,SAAS,cAAc,CAAC,MAAkC;IACtD,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;IAClC,IAAI,IAAI,GAAG,KAAK,CAAC;IACjB,OAAO;QACH,KAAK,CAAC,IAAI;YACN,IAAI,IAAI,EAAE,CAAC;gBACP,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;YAC5C,CAAC;YACD,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;YACnC,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;gBACd,IAAI,GAAG,IAAI,CAAC;gBACZ,MAAM,CAAC,WAAW,EAAE,CAAC;gBACrB,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;YAC5C,CAAC;YACD,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC;QAChD,CAAC;QACD,KAAK,CAAC,MAAM;YACR,IAAI,CAAC,IAAI,EAAE,CAAC;gBACR,IAAI,GAAG,IAAI,CAAC;gBACZ,MAAM,MAAM,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;gBAC7C,MAAM,CAAC,WAAW,EAAE,CAAC;YACzB,CAAC;YACD,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;QAC5C,CAAC;KACJ,CAAC;AACN,CAAC"}

package/dist/src/sniff.d.ts

@@ -0,0 +1,104 @@
+/**
+ * Format detection (design sections 8.2 and 13.1: the registry's `sniff()`, the successor of
+ * graphty-element's `format-detection.ts`): which of the registered importers a file is for, from
+ * any combination of a filename (its extension), a MIME type and the first bytes of the content.
+ *
+ * Every importer declares `extensions`, `mimeTypes` and a `sniff(head)` content confidence in
+ * 0..1 (design section 8.4); this module combines them into one ranked answer so that content
+ * always beats a hint: a `.csv` whose first line is a neo4j-admin header is Neo4j, a `.xml` is
+ * GEXF or GraphML by its root element, a `.txt` holding `graph [` is GML. The confidence of a
+ * candidate is
+ *
+ * - `0.5 + 0.35 * content + 0.1 * [extension matches] + 0.05 * [MIME type matches]` when the
+ *   importer recognises the content (`content > 0`), so a content match always scores at least
+ *   0.5 and at most 1;
+ * - `0.3 * [extension matches] + 0.1 * [MIME type matches]` when the content is absent or the
+ *   importer rejects it, so a hint alone never reaches 0.5;
+ * - nothing (the format is not a candidate) otherwise.
+ *
+ * Ties are broken by the order the importers were registered in, which is why the default
+ * registry lists the common formats first. The JSON dialect is sniffed from the head as a hint
+ * (the importer's detection on the parsed document is authoritative, design section 8.2).
+ */
+import { type JsonDialect } from "./formats/json/dialect.js";
+import { type GraphImporter } from "./types.js";
+/** The format names of the eight built-in importers and exporters. */
+export type GraphFormatName = "gexf" | "graphml" | "gml" | "dot" | "pajek" | "csv" | "json" | "neo4j";
+/**
+ * The built-in format names in the default registry's order, which is also the tie-break order of
+ * sniffing: the more common format wins an extension two formats claim (`.xml` GraphML before GEXF,
+ * `.csv` CSV before Neo4j) when the content does not decide.
+ */
+export declare const GRAPH_FORMATS: readonly GraphFormatName[];
+/** How many bytes of the input the sniffers look at; the registry reads no more than this before deciding. */
+export declare const SNIFF_HEAD_BYTES = 8192;
+/** What is known about an input before it is read. */
+export interface SniffHints {
+    /** A file name or path; only its extension is used. */
+    readonly filename?: string | null | undefined;
+    /** A MIME type, with or without parameters (`text/csv; charset=utf-8`). */
+    readonly mimeType?: string | null | undefined;
+    /** The first bytes (or characters) of the content. */
+    readonly head?: Uint8Array | string | null | undefined;
+}
+/** One ranked candidate of a sniff. */
+export interface SniffResult {
+    /** The importer's format name. */
+    readonly format: string;
+    /** The combined confidence in 0..1 (at least 0.5 when the content was recognised). */
+    readonly confidence: number;
+    /** The importer's own content confidence, 0 when no head was given or it rejected the head. */
+    readonly content: number;
+    /** Whether the filename's extension is one the importer claims. */
+    readonly extension: boolean;
+    /** Whether the MIME type is one the importer claims. */
+    readonly mimeType: boolean;
+    /** For the JSON format: the dialect the head suggests, or null when unknown; always null for other formats. */
+    readonly dialect: JsonDialect | null;
+}
+/**
+ * The lower-cased extension of a file name or path, with its dot.
+ * @param filename - the name or path
+ * @returns the extension (`.gexf`), or null when the name has none
+ */
+export declare function extensionOf(filename: string): string | null;
+/**
+ * A MIME type without parameters, lower-cased, for comparison with an importer's list.
+ * @param mimeType - the type as received (`Text/CSV; charset=utf-8`)
+ * @returns the bare type (`text/csv`)
+ */
+export declare function normalizeMimeType(mimeType: string): string;
+/**
+ * The head as bytes for the importers' sniff functions: at most SNIFF_HEAD_BYTES, a string
+ * encoded as UTF-8.
+ * @param head - the head as given
+ * @returns the bytes
+ */
+export declare function headBytes(head: Uint8Array | string): Uint8Array;
+/**
+ * Rank the registered importers for an input by the rule of the module comment: every importer
+ * whose content confidence is positive or whose extension / MIME type matches is a candidate,
+ * ordered by confidence (ties in registration order).
+ * @param hints - what is known about the input
+ * @param importers - the registered importers, in registration order
+ * @returns the candidates, best first; empty when nothing matches
+ */
+export declare function rankFormats(hints: SniffHints, importers: Iterable<GraphImporter>): readonly SniffResult[];
+/**
+ * The best candidate of rankFormats(), or null when no importer matches.
+ * @param hints - what is known about the input
+ * @param importers - the registered importers, in registration order
+ * @returns the best candidate, or null
+ */
+export declare function sniffFormat(hints: SniffHints, importers: Iterable<GraphImporter>): SniffResult | null;
+/**
+ * The JSON dialect a head suggests. A head that parses as a whole document is classified exactly
+ * (sniffJsonDialect); a truncated head is scanned for its top-level keys, the keys of `graph` and
+ * `options`, and the keys of the first object under `nodes` / `edges` / `links`, and the same
+ * rule is applied to that skeleton. The result is a hint: the importer decides on the parsed
+ * document.
+ * @param head - the first bytes or characters of the document
+ * @returns the dialect, or null when the head is not a JSON graph document
+ */
+export declare function sniffJsonDialectHead(head: Uint8Array | string): JsonDialect | null;
+//# sourceMappingURL=sniff.d.ts.map

package/dist/src/sniff.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sniff.d.ts","sourceRoot":"","sources":["../../src/sniff.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,OAAO,EAAE,KAAK,WAAW,EAAoB,MAAM,2BAA2B,CAAC;AAC/E,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,YAAY,CAAC;AAEhD,sEAAsE;AACtE,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,SAAS,GAAG,KAAK,GAAG,KAAK,GAAG,OAAO,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,CAAC;AAEtG;;;;GAIG;AACH,eAAO,MAAM,aAAa,EAAE,SAAS,eAAe,EASlD,CAAC;AAEH,8GAA8G;AAC9G,eAAO,MAAM,gBAAgB,OAAO,CAAC;AAErC,sDAAsD;AACtD,MAAM,WAAW,UAAU;IACvB,uDAAuD;IACvD,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAC9C,2EAA2E;IAC3E,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAC9C,sDAAsD;IACtD,QAAQ,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CAC1D;AAED,uCAAuC;AACvC,MAAM,WAAW,WAAW;IACxB,kCAAkC;IAClC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,sFAAsF;IACtF,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,+FAA+F;IAC/F,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,mEAAmE;IACnE,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,wDAAwD;IACxD,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,+GAA+G;IAC/G,QAAQ,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI,CAAC;CACxC;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAO3D;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAG1D;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,UAAU,CAK/D;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,CAAC,aAAa,CAAC,GAAG,SAAS,WAAW,EAAE,CAkCzG;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,CAAC,aAAa,CAAC,GAAG,WAAW,GAAG,IAAI,CAGrG;AAED;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,WAAW,GAAG,IAAI,CAclF"}