@graphty/graph-io 0.3.47 → 0.3.49

package/dist/src/sources/define.js

@@ -0,0 +1,173 @@
+/**
+ * `defineSource` and the registration checks (design section 2): the id form, exactly one read
+ * method, and the declared features against the methods present. Also the parameter checks every
+ * load runs against the descriptor before any request.
+ */
+import { failAlone, failOn } from "./fail.js";
+/** Lowercase letters, digits and single dashes between them. */
+const ID_FORM = /^[a-z0-9]+(-[a-z0-9]+)*$/;
+/** The optional methods and the feature each one is. */
+const FEATURE_METHODS = [
+    ["expand", "expand"],
+    ["probe", "probe"],
+    ["list", "list"],
+    ["validate", "validate"],
+];
+/**
+ * Refuse a malformed source.
+ * @param id - the source id
+ * @param reason - why
+ * @param message - for logs
+ */
+function invalid(id, reason, message) {
+    failAlone("E_SOURCE_INVALID", message, { id, reason });
+}
+/**
+ * Check a source id.
+ * @param id - the id
+ */
+function checkSourceId(id) {
+    if (typeof id !== "string" || !ID_FORM.test(id)) {
+        invalid(String(id), "id", `source id ${JSON.stringify(id)} must be lowercase letters, digits and dashes`);
+    }
+}
+/**
+ * The features a loaded source has, from its methods.
+ * @param source - the source
+ * @returns the features
+ */
+function featuresOf(source) {
+    return FEATURE_METHODS.filter(([, method]) => typeof source[method] === "function").map(([f]) => f);
+}
+/**
+ * Check a loaded source: its id, exactly one read method, and its declared features.
+ * @param source - the source
+ * @param declared - features a lazy registration declared, if any
+ */
+export function checkSource(source, declared) {
+    checkSourceId(source.id);
+    const reads = ["records", "file", "import"].filter((m) => typeof source[m] === "function");
+    if (reads.length !== 1) {
+        invalid(source.id, "read-methods", `source ${source.id} must have exactly one of records, file and import`);
+    }
+    const features = (declared ?? source.descriptor)?.features;
+    if (features !== undefined) {
+        const has = new Set(featuresOf(source));
+        for (const f of features) {
+            if (f !== "page" && !has.has(f)) {
+                invalid(source.id, "features", `source ${source.id} declares ${f} but has no ${f} method`);
+            }
+        }
+    }
+}
+/**
+ * Check a lazy registration before its code is loaded.
+ * @param source - the lazy source
+ */
+export function checkLazySource(source) {
+    checkSourceId(source.id);
+    if (typeof source.load !== "function" || typeof source.descriptor !== "object") {
+        invalid(source.id, "lazy", `lazy source ${source.id} needs a descriptor and a load function`);
+    }
+}
+/**
+ * Define a network source: returns it unchanged, with its parameter type inferred, after the
+ * registration checks (an id of lowercase letters, digits and dashes; exactly one of `records`,
+ * `file` and `import`; declared features backed by methods). A malformed source throws an
+ * ImportError whose `issue.code` is E_SOURCE_INVALID. Experimental.
+ * @param source - the source
+ * @returns the same source
+ * @example
+ * ```ts
+ * const people = defineSource({
+ *     id: "people",
+ *     async records(params: { team: string }, ctx) {
+ *         const rows = await ctx.fetchJson<{ id: string; name: string }[]>(`/api/people?team=${params.team}`);
+ *         return { nodes: rows };
+ *     },
+ * });
+ * ```
+ * @category Network sources
+ */
+export function defineSource(source) {
+    checkSource(source);
+    return source;
+}
+/**
+ * Why a number or integer param is wrong, if it is.
+ * @param p - the param's descriptor
+ * @param value - the value given
+ * @returns the reason, or null when it is fine
+ */
+function numberProblem(p, value) {
+    if (typeof value !== "number" || Number.isNaN(value) || (p.type === "integer" && !Number.isInteger(value))) {
+        return "type";
+    }
+    if ((p.min !== undefined && value < p.min) || (p.max !== undefined && value > p.max)) {
+        return "range";
+    }
+    return null;
+}
+/**
+ * Why a URL param is wrong, if it is.
+ * @param value - the value given
+ * @returns the reason, or null when it is fine
+ */
+function urlProblem(value) {
+    let url;
+    try {
+        url = new URL(typeof value === "string" ? value : "");
+    }
+    catch {
+        return "type";
+    }
+    return url.username !== "" || url.password !== "" ? "credentials-in-url" : null;
+}
+/**
+ * Why a present param value is wrong for its descriptor, if it is.
+ * @param p - the param's descriptor
+ * @param value - the value given (not undefined or null)
+ * @returns the reason, or null when it is fine
+ */
+function paramProblem(p, value) {
+    switch (p.type) {
+        case "integer":
+        case "number":
+            return numberProblem(p, value);
+        case "boolean":
+            return typeof value === "boolean" ? null : "type";
+        case "enum":
+            return p.values !== undefined && !p.values.some((v) => v.value === value) ? "enum" : null;
+        case "url":
+            return urlProblem(value);
+        default:
+            return null;
+    }
+}
+/**
+ * Check params against a descriptor before any request: required ones present, numbers and
+ * integers in range, booleans, enums, URLs (never with a user name or password in them).
+ * @param params - the caller's params
+ * @param descriptor - the source's descriptor
+ * @param report - the load's report
+ */
+export function checkParams(params, descriptor, report) {
+    if (typeof params !== "object" || params === null) {
+        failOn(report, "E_SOURCE_PARAM", "params must be an object", { name: "params", reason: "type" });
+    }
+    for (const p of descriptor?.params ?? []) {
+        const value = params[p.name];
+        const missing = value === undefined || value === null;
+        let reason = null;
+        if (!missing) {
+            reason = paramProblem(p, value);
+        }
+        else if (p.required === true && p.default === undefined) {
+            reason = "required";
+        }
+        if (reason !== null) {
+            failOn(report, "E_SOURCE_PARAM", `parameter ${p.name}: ${reason}`, { name: p.name, reason });
+        }
+    }
+}
+//# sourceMappingURL=define.js.map

package/dist/src/sources/define.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"define.js","sourceRoot":"","sources":["../../../src/sources/define.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAS9C,gEAAgE;AAChE,MAAM,OAAO,GAAG,0BAA0B,CAAC;AAE3C,wDAAwD;AACxD,MAAM,eAAe,GAAoF;IACrG,CAAC,QAAQ,EAAE,QAAQ,CAAC;IACpB,CAAC,OAAO,EAAE,OAAO,CAAC;IAClB,CAAC,MAAM,EAAE,MAAM,CAAC;IAChB,CAAC,UAAU,EAAE,UAAU,CAAC;CAC3B,CAAC;AAEF;;;;;GAKG;AACH,SAAS,OAAO,CAAC,EAAU,EAAE,MAAc,EAAE,OAAe;IACxD,SAAS,CAAC,kBAAkB,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;AAC3D,CAAC;AAED;;;GAGG;AACH,SAAS,aAAa,CAAC,EAAW;IAC9B,IAAI,OAAO,EAAE,KAAK,QAAQ,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;QAC9C,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,aAAa,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,+CAA+C,CAAC,CAAC;IAC9G,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,SAAS,UAAU,CAAC,MAA0B;IAC1C,OAAO,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;AACxG,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,MAA0B,EAAE,QAA2B;IAC/E,aAAa,CAAE,MAA2B,CAAC,EAAE,CAAC,CAAC;IAC/C,MAAM,KAAK,GAAI,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,CAAW,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,MAAM,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,CAAC;IACtG,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACrB,OAAO,CAAC,MAAM,CAAC,EAAE,EAAE,cAAc,EAAE,UAAU,MAAM,CAAC,EAAE,oDAAoD,CAAC,CAAC;IAChH,CAAC;IACD,MAAM,QAAQ,GAAG,CAAC,QAAQ,IAAI,MAAM,CAAC,UAAU,CAAC,EAAE,QAAQ,CAAC;IAC3D,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QACzB,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;QACxC,KAAK,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC;YACvB,IAAI,CAAC,KAAK,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC9B,OAAO,CAAC,MAAM,CAAC,EAAE,EAAE,UAAU,EAAE,UAAU,MAAM,CAAC,EAAE,aAAa,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;YAC/F,CAAC;QACL,CAAC;IACL,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,eAAe,CAAC,MAAkB;IAC9C,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACzB,IAAI,OAAO,MAAM,CAAC,IAAI,KAAK,UAAU,IAAI,OAAO,MAAM,CAAC,UAAU,KAAK,QAAQ,EAAE,CAAC;QAC7E,OAAO,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,eAAe,MAAM,CAAC,EAAE,yCAAyC,CAAC,CAAC;IAClG,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,YAAY,CAAI,MAAsB;IAClD,WAAW,CAAC,MAAM,CAAC,CAAC;IACpB,OAAO,MAAM,CAAC;AAClB,CAAC;AAED;;;;;GAKG;AACH,SAAS,aAAa,CAAC,CAAwB,EAAE,KAAc;IAC3D,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;QACzG,OAAO,MAAM,CAAC;IAClB,CAAC;IACD,IAAI,CAAC,CAAC,CAAC,GAAG,KAAK,SAAS,IAAI,KAAK,GAAG,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,KAAK,SAAS,IAAI,KAAK,GAAG,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;QACnF,OAAO,OAAO,CAAC;IACnB,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,SAAS,UAAU,CAAC,KAAc;IAC9B,IAAI,GAAQ,CAAC;IACb,IAAI,CAAC;QACD,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC1D,CAAC;IAAC,MAAM,CAAC;QACL,OAAO,MAAM,CAAC;IAClB,CAAC;IACD,OAAO,GAAG,CAAC,QAAQ,KAAK,EAAE,IAAI,GAAG,CAAC,QAAQ,KAAK,EAAE,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,IAAI,CAAC;AACpF,CAAC;AAED;;;;;GAKG;AACH,SAAS,YAAY,CAAC,CAAwB,EAAE,KAAc;IAC1D,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;QACb,KAAK,SAAS,CAAC;QACf,KAAK,QAAQ;YACT,OAAO,aAAa,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;QACnC,KAAK,SAAS;YACV,OAAO,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC;QACtD,KAAK,MAAM;YACP,OAAO,CAAC,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;QAC9F,KAAK,KAAK;YACN,OAAO,UAAU,CAAC,KAAK,CAAC,CAAC;QAC7B;YACI,OAAO,IAAI,CAAC;IACpB,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CACvB,MAAyC,EACzC,UAAwC,EACxC,MAA2B;IAE3B,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAK,MAAkB,KAAK,IAAI,EAAE,CAAC;QAC7D,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,0BAA0B,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IACrG,CAAC;IACD,KAAK,MAAM,CAAC,IAAI,UAAU,EAAE,MAAM,IAAI,EAAE,EAAE,CAAC;QACvC,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC7B,MAAM,OAAO,GAAG,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,CAAC;QACtD,IAAI,MAAM,GAAkB,IAAI,CAAC;QACjC,IAAI,CAAC,OAAO,EAAE,CAAC;YACX,MAAM,GAAG,YAAY,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;QACpC,CAAC;aAAM,IAAI,CAAC,CAAC,QAAQ,KAAK,IAAI,IAAI,CAAC,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACxD,MAAM,GAAG,UAAU,CAAC;QACxB,CAAC;QACD,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YAClB,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,aAAa,CAAC,CAAC,IAAI,KAAK,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;QACjG,CAAC;IACL,CAAC;AACL,CAAC"}

package/dist/src/sources/fail.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Raising a network source issue: one place that turns a code and its params into an ImportError
+ * whose `issue.params` and `details` both carry the params, so callers branch on
+ * `err.issue.code` and read `err.issue.params` as with every other graph-io failure.
+ */
+import { ImportReportBuilder } from "../common/report.js";
+import { type SourceIssueCode } from "./codes.js";
+/**
+ * Abort a load with a source error, carrying the load's report so far plus the error.
+ * @param report - the load's report
+ * @param code - the code
+ * @param message - a plain-ASCII message, for logs
+ * @param params - the issue's values
+ * @returns never; it throws the ImportError
+ */
+export declare function failOn(report: ImportReportBuilder, code: SourceIssueCode, message: string, params: Readonly<Record<string, unknown>>): never;
+/**
+ * Raise a source error outside a load (registration, a credential factory).
+ * @param code - the code
+ * @param message - a plain-ASCII message, for logs
+ * @param params - the issue's values
+ * @param format - the report's format name
+ */
+export declare function failAlone(code: SourceIssueCode, message: string, params: Readonly<Record<string, unknown>>, format?: string): never;
+/**
+ * Record a source warning on a report.
+ * @param report - the report
+ * @param code - the code
+ * @param message - a plain-ASCII message, for logs
+ * @param params - the issue's values
+ */
+export declare function warnOn(report: ImportReportBuilder, code: SourceIssueCode, message: string, params: Readonly<Record<string, unknown>>): void;
+//# sourceMappingURL=fail.d.ts.map

package/dist/src/sources/fail.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fail.d.ts","sourceRoot":"","sources":["../../../src/sources/fail.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAE1D,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,YAAY,CAAC;AAYlD;;;;;;;GAOG;AACH,wBAAgB,MAAM,CAClB,MAAM,EAAE,mBAAmB,EAC3B,IAAI,EAAE,eAAe,EACrB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GAC1C,KAAK,CAIP;AAED;;;;;;GAMG;AACH,wBAAgB,SAAS,CACrB,IAAI,EAAE,eAAe,EACrB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,EACzC,MAAM,SAAW,GAClB,KAAK,CAEP;AAED;;;;;;GAMG;AACH,wBAAgB,MAAM,CAClB,MAAM,EAAE,mBAAmB,EAC3B,IAAI,EAAE,eAAe,EACrB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GAC1C,IAAI,CAEN"}

package/dist/src/sources/fail.js

@@ -0,0 +1,49 @@
+/**
+ * Raising a network source issue: one place that turns a code and its params into an ImportError
+ * whose `issue.params` and `details` both carry the params, so callers branch on
+ * `err.issue.code` and read `err.issue.params` as with every other graph-io failure.
+ */
+import { ImportReportBuilder } from "../common/report.js";
+/** The category each code is filed under. */
+const CATEGORY = {
+    E_SOURCE_PARAM: "validation-error",
+    E_SOURCE_INVALID: "validation-error",
+    E_SOURCE_RESPONSE: "parse-error",
+    E_SOURCE_NOT_A_GRAPH: "parse-error",
+    E_SOURCE_NOT_FOUND: "missing-value",
+    E_SOURCE_UNKNOWN: "missing-value",
+};
+/**
+ * Abort a load with a source error, carrying the load's report so far plus the error.
+ * @param report - the load's report
+ * @param code - the code
+ * @param message - a plain-ASCII message, for logs
+ * @param params - the issue's values
+ * @returns never; it throws the ImportError
+ */
+export function failOn(report, code, message, params) {
+    // a fork, so a failure the runner turns into a warning (a later page's 401, a cap) leaves no
+    // error in the load's own report; the ImportError carries everything recorded so far
+    return report.fork().failWith(CATEGORY[code] ?? "unsupported", code, message, undefined, params, params);
+}
+/**
+ * Raise a source error outside a load (registration, a credential factory).
+ * @param code - the code
+ * @param message - a plain-ASCII message, for logs
+ * @param params - the issue's values
+ * @param format - the report's format name
+ */
+export function failAlone(code, message, params, format = "source") {
+    failOn(new ImportReportBuilder(format, 0), code, message, params);
+}
+/**
+ * Record a source warning on a report.
+ * @param report - the report
+ * @param code - the code
+ * @param message - a plain-ASCII message, for logs
+ * @param params - the issue's values
+ */
+export function warnOn(report, code, message, params) {
+    report.warning("unsupported", code, message, undefined, params);
+}
+//# sourceMappingURL=fail.js.map

package/dist/src/sources/fail.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fail.js","sourceRoot":"","sources":["../../../src/sources/fail.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAI1D,6CAA6C;AAC7C,MAAM,QAAQ,GAA8D;IACxE,cAAc,EAAE,kBAAkB;IAClC,gBAAgB,EAAE,kBAAkB;IACpC,iBAAiB,EAAE,aAAa;IAChC,oBAAoB,EAAE,aAAa;IACnC,kBAAkB,EAAE,eAAe;IACnC,gBAAgB,EAAE,eAAe;CACpC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,UAAU,MAAM,CAClB,MAA2B,EAC3B,IAAqB,EACrB,OAAe,EACf,MAAyC;IAEzC,6FAA6F;IAC7F,qFAAqF;IACrF,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,aAAa,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;AAC7G,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,SAAS,CACrB,IAAqB,EACrB,OAAe,EACf,MAAyC,EACzC,MAAM,GAAG,QAAQ;IAEjB,MAAM,CAAC,IAAI,mBAAmB,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AACtE,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,MAAM,CAClB,MAA2B,EAC3B,IAAqB,EACrB,OAAe,EACf,MAAyC;IAEzC,MAAM,CAAC,OAAO,CAAC,aAAa,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;AACpE,CAAC"}

package/dist/src/sources/ids.d.ts

@@ -0,0 +1,69 @@
+/**
+ * The public names of network sources: one constant per built-in source id, and the reserved
+ * `_source.` attribute names. Nothing else in graph-io spells them, so a rename is one edit here.
+ *
+ * Experimental: the ids and the `_source.` namespace await the owner's final word (design
+ * section 22, items 4 and 5).
+ */
+/**
+ * The NDEx source (www.ndexbio.org). Experimental.
+ * @category Network sources
+ */
+export declare const NDEX_SOURCE_ID = "ndex";
+/**
+ * The generic Cypher source, for any openCypher server. Experimental.
+ * @category Network sources
+ */
+export declare const CYPHER_SOURCE_ID = "cypher";
+/**
+ * The Neo4j preset of the Cypher source. Experimental.
+ * @category Network sources
+ */
+export declare const NEO4J_SOURCE_ID = "neo4j";
+/**
+ * The Amazon Neptune preset of the Cypher source. Experimental.
+ * @category Network sources
+ */
+export declare const NEPTUNE_SOURCE_ID = "neptune";
+/**
+ * The generic REST mapping source. Experimental.
+ * @category Network sources
+ */
+export declare const REST_SOURCE_ID = "rest";
+/**
+ * The OpenAlex preset of the REST mapping source. Experimental.
+ * @category Network sources
+ */
+export declare const OPENALEX_SOURCE_ID = "openalex";
+/**
+ * The SPARQL source, for any SPARQL 1.1 endpoint. Experimental.
+ * @category Network sources
+ */
+export declare const SPARQL_SOURCE_ID = "sparql";
+/**
+ * The prefix of the reserved attribute namespace sources and graphty-element write facts under.
+ * @category Network sources
+ */
+export declare const SOURCE_ATTR_PREFIX = "_source.";
+/**
+ * Node attribute: true on a stub, a node known only by its id until it is hydrated or expanded.
+ * @category Network sources
+ */
+export declare const SOURCE_STUB_ATTR = "_source.stub";
+/**
+ * Node attribute: the entity a stub node is (a REST mapping's entity name).
+ * @category Network sources
+ */
+export declare const SOURCE_ENTITY_ATTR = "_source.entity";
+/**
+ * Node attribute: the node's degree at the source, when the source returns it at no extra cost
+ * (the Cypher source's degree hint).
+ * @category Network sources
+ */
+export declare const SOURCE_DEGREE_ATTR = "_source.degree";
+/**
+ * The prefix of `ImportGraphResult.format` for a load from a source: `"source:<id>"`.
+ * @category Network sources
+ */
+export declare const SOURCE_FORMAT_PREFIX = "source:";
+//# sourceMappingURL=ids.d.ts.map

package/dist/src/sources/ids.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ids.d.ts","sourceRoot":"","sources":["../../../src/sources/ids.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH;;;GAGG;AACH,eAAO,MAAM,cAAc,SAAS,CAAC;AAErC;;;GAGG;AACH,eAAO,MAAM,gBAAgB,WAAW,CAAC;AAEzC;;;GAGG;AACH,eAAO,MAAM,eAAe,UAAU,CAAC;AAEvC;;;GAGG;AACH,eAAO,MAAM,iBAAiB,YAAY,CAAC;AAE3C;;;GAGG;AACH,eAAO,MAAM,cAAc,SAAS,CAAC;AAErC;;;GAGG;AACH,eAAO,MAAM,kBAAkB,aAAa,CAAC;AAE7C;;;GAGG;AACH,eAAO,MAAM,gBAAgB,WAAW,CAAC;AAEzC;;;GAGG;AACH,eAAO,MAAM,kBAAkB,aAAa,CAAC;AAE7C;;;GAGG;AACH,eAAO,MAAM,gBAAgB,iBAAiB,CAAC;AAE/C;;;GAGG;AACH,eAAO,MAAM,kBAAkB,mBAAmB,CAAC;AAEnD;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,mBAAmB,CAAC;AAEnD;;;GAGG;AACH,eAAO,MAAM,oBAAoB,YAAY,CAAC"}

package/dist/src/sources/ids.js

@@ -0,0 +1,69 @@
+/**
+ * The public names of network sources: one constant per built-in source id, and the reserved
+ * `_source.` attribute names. Nothing else in graph-io spells them, so a rename is one edit here.
+ *
+ * Experimental: the ids and the `_source.` namespace await the owner's final word (design
+ * section 22, items 4 and 5).
+ */
+/**
+ * The NDEx source (www.ndexbio.org). Experimental.
+ * @category Network sources
+ */
+export const NDEX_SOURCE_ID = "ndex";
+/**
+ * The generic Cypher source, for any openCypher server. Experimental.
+ * @category Network sources
+ */
+export const CYPHER_SOURCE_ID = "cypher";
+/**
+ * The Neo4j preset of the Cypher source. Experimental.
+ * @category Network sources
+ */
+export const NEO4J_SOURCE_ID = "neo4j";
+/**
+ * The Amazon Neptune preset of the Cypher source. Experimental.
+ * @category Network sources
+ */
+export const NEPTUNE_SOURCE_ID = "neptune";
+/**
+ * The generic REST mapping source. Experimental.
+ * @category Network sources
+ */
+export const REST_SOURCE_ID = "rest";
+/**
+ * The OpenAlex preset of the REST mapping source. Experimental.
+ * @category Network sources
+ */
+export const OPENALEX_SOURCE_ID = "openalex";
+/**
+ * The SPARQL source, for any SPARQL 1.1 endpoint. Experimental.
+ * @category Network sources
+ */
+export const SPARQL_SOURCE_ID = "sparql";
+/**
+ * The prefix of the reserved attribute namespace sources and graphty-element write facts under.
+ * @category Network sources
+ */
+export const SOURCE_ATTR_PREFIX = "_source.";
+/**
+ * Node attribute: true on a stub, a node known only by its id until it is hydrated or expanded.
+ * @category Network sources
+ */
+export const SOURCE_STUB_ATTR = "_source.stub";
+/**
+ * Node attribute: the entity a stub node is (a REST mapping's entity name).
+ * @category Network sources
+ */
+export const SOURCE_ENTITY_ATTR = "_source.entity";
+/**
+ * Node attribute: the node's degree at the source, when the source returns it at no extra cost
+ * (the Cypher source's degree hint).
+ * @category Network sources
+ */
+export const SOURCE_DEGREE_ATTR = "_source.degree";
+/**
+ * The prefix of `ImportGraphResult.format` for a load from a source: `"source:<id>"`.
+ * @category Network sources
+ */
+export const SOURCE_FORMAT_PREFIX = "source:";
+//# sourceMappingURL=ids.js.map

package/dist/src/sources/ids.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ids.js","sourceRoot":"","sources":["../../../src/sources/ids.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,MAAM,CAAC;AAErC;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,QAAQ,CAAC;AAEzC;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,OAAO,CAAC;AAEvC;;;GAGG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,SAAS,CAAC;AAE3C;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,MAAM,CAAC;AAErC;;;GAGG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,UAAU,CAAC;AAE7C;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,QAAQ,CAAC;AAEzC;;;GAGG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,UAAU,CAAC;AAE7C;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,cAAc,CAAC;AAE/C;;;GAGG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,gBAAgB,CAAC;AAEnD;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,gBAAgB,CAAC;AAEnD;;;GAGG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,SAAS,CAAC"}

package/dist/src/sources/ndex/client.d.ts

@@ -0,0 +1,31 @@
+/**
+ * What every NDEx call shares: the checks on the endpoint and the network UUID, and a fetch that
+ * classifies NDEx's failures.
+ */
+import { type SourceContext } from "../types.js";
+/** The query parameter NDEx reads a link-share access key from. */
+export declare const ACCESS_KEY_QUERY = "accesskey";
+/**
+ * Refuse an access key in the endpoint: it belongs in a credential, which is never logged.
+ * @param ctx - the context
+ */
+export declare function checkEndpoint(ctx: SourceContext): void;
+/**
+ * Check a call's endpoint and network UUID.
+ * @param uuid - the network UUID
+ * @param ctx - the context
+ * @returns the UUID, lowercase and URL-safe
+ */
+export declare function checkedUuid(uuid: unknown, ctx: SourceContext): string;
+/**
+ * Fetch from NDEx, turning a 401, 403 or 404 into its coded error with NDEx's own errorCode.
+ * @param ctx - the context
+ * @param path - the path, relative to the endpoint
+ * @param uuid - the network the request is about, for E_SOURCE_NOT_FOUND
+ * @param init - the request init
+ * @returns the response, status 2xx
+ */
+export declare function ndexFetch(ctx: SourceContext, path: string, uuid: string | null, init?: RequestInit & {
+    readonly idempotent?: boolean;
+}): Promise<Response>;
+//# sourceMappingURL=client.d.ts.map

package/dist/src/sources/ndex/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/sources/ndex/client.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,aAAa,CAAC;AAKjD,mEAAmE;AACnE,eAAO,MAAM,gBAAgB,cAAc,CAAC;AAK5C;;;GAGG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,aAAa,GAAG,IAAI,CAOtD;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,aAAa,GAAG,MAAM,CAarE;AAED;;;;;;;GAOG;AACH,wBAAsB,SAAS,CAC3B,GAAG,EAAE,aAAa,EAClB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,GAAG,IAAI,EACnB,IAAI,GAAE,WAAW,GAAG;IAAE,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAA;CAAO,GAC3D,OAAO,CAAC,QAAQ,CAAC,CAuBnB"}

package/dist/src/sources/ndex/client.js

@@ -0,0 +1,90 @@
+/**
+ * What every NDEx call shares: the checks on the endpoint and the network UUID, and a fetch that
+ * classifies NDEx's failures.
+ */
+import { failOn } from "../fail.js";
+/** An NDEx network UUID. */
+const UUID = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
+/** The query parameter NDEx reads a link-share access key from. */
+export const ACCESS_KEY_QUERY = "accesskey";
+/** The statuses whose JSON body (NDEx's errorCode) is read; every other failure is classified by status alone. */
+const READ_STATUSES = [401, 403, 404];
+/**
+ * Refuse an access key in the endpoint: it belongs in a credential, which is never logged.
+ * @param ctx - the context
+ */
+export function checkEndpoint(ctx) {
+    if (ctx.endpoint?.searchParams.has(ACCESS_KEY_QUERY) === true) {
+        failOn(ctx.report, "E_SOURCE_PARAM", "an access key goes in a credential, never in the endpoint", {
+            name: "endpoint",
+            reason: "credentials-in-url",
+        });
+    }
+}
+/**
+ * Check a call's endpoint and network UUID.
+ * @param uuid - the network UUID
+ * @param ctx - the context
+ * @returns the UUID, lowercase and URL-safe
+ */
+export function checkedUuid(uuid, ctx) {
+    checkEndpoint(ctx);
+    const value = String(uuid);
+    if (/accesskey/i.test(value)) {
+        failOn(ctx.report, "E_SOURCE_PARAM", "an access key goes in a credential, never in the uuid", {
+            name: "uuid",
+            reason: "credentials-in-url",
+        });
+    }
+    if (!UUID.test(value)) {
+        failOn(ctx.report, "E_SOURCE_PARAM", "the uuid is not a network UUID", { name: "uuid", reason: "format" });
+    }
+    return value.toLowerCase();
+}
+/**
+ * Fetch from NDEx, turning a 401, 403 or 404 into its coded error with NDEx's own errorCode.
+ * @param ctx - the context
+ * @param path - the path, relative to the endpoint
+ * @param uuid - the network the request is about, for E_SOURCE_NOT_FOUND
+ * @param init - the request init
+ * @returns the response, status 2xx
+ */
+export async function ndexFetch(ctx, path, uuid, init = {}) {
+    const response = await ctx.fetch(path, { ...init, allowStatus: READ_STATUSES });
+    if (response.ok) {
+        return response;
+    }
+    const url = new URL(path, ctx.endpoint ?? undefined);
+    const serverCode = await errorCode(response);
+    const { status } = response;
+    if (status === 401) {
+        failOn(ctx.report, "E_SOURCE_AUTH", `NDEx answered ${String(status)}`, {
+            origin: url.origin,
+            status,
+            scheme: response.headers.get("www-authenticate")?.split(/\s/)[0] ?? null,
+            serverCode,
+        });
+    }
+    if (status === 403) {
+        failOn(ctx.report, "E_SOURCE_FORBIDDEN", "NDEx answered 403", { status, serverCode });
+    }
+    return failOn(ctx.report, "E_SOURCE_NOT_FOUND", "NDEx has no such network", {
+        what: uuid === null ? "url" : "network",
+        value: uuid ?? `${url.origin}${url.pathname}`,
+    });
+}
+/**
+ * NDEx's own error code from a JSON error body, never its message or stack trace.
+ * @param response - the failed response
+ * @returns the code, or null
+ */
+async function errorCode(response) {
+    try {
+        const body = (await response.json());
+        return typeof body.errorCode === "string" ? body.errorCode.slice(0, 100) : null;
+    }
+    catch {
+        return null;
+    }
+}
+//# sourceMappingURL=client.js.map

package/dist/src/sources/ndex/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../src/sources/ndex/client.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAGpC,4BAA4B;AAC5B,MAAM,IAAI,GAAG,iEAAiE,CAAC;AAE/E,mEAAmE;AACnE,MAAM,CAAC,MAAM,gBAAgB,GAAG,WAAW,CAAC;AAE5C,kHAAkH;AAClH,MAAM,aAAa,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAU,CAAC;AAE/C;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,GAAkB;IAC5C,IAAI,GAAG,CAAC,QAAQ,EAAE,YAAY,CAAC,GAAG,CAAC,gBAAgB,CAAC,KAAK,IAAI,EAAE,CAAC;QAC5D,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,gBAAgB,EAAE,2DAA2D,EAAE;YAC9F,IAAI,EAAE,UAAU;YAChB,MAAM,EAAE,oBAAoB;SAC/B,CAAC,CAAC;IACP,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,IAAa,EAAE,GAAkB;IACzD,aAAa,CAAC,GAAG,CAAC,CAAC;IACnB,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;IAC3B,IAAI,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3B,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,gBAAgB,EAAE,uDAAuD,EAAE;YAC1F,IAAI,EAAE,MAAM;YACZ,MAAM,EAAE,oBAAoB;SAC/B,CAAC,CAAC;IACP,CAAC;IACD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACpB,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,gBAAgB,EAAE,gCAAgC,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC/G,CAAC;IACD,OAAO,KAAK,CAAC,WAAW,EAAE,CAAC;AAC/B,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC3B,GAAkB,EAClB,IAAY,EACZ,IAAmB,EACnB,OAAwD,EAAE;IAE1D,MAAM,QAAQ,GAAG,MAAM,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,GAAG,IAAI,EAAE,WAAW,EAAE,aAAa,EAAE,CAAC,CAAC;IAChF,IAAI,QAAQ,CAAC,EAAE,EAAE,CAAC;QACd,OAAO,QAAQ,CAAC;IACpB,CAAC;IACD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,QAAQ,IAAI,SAAS,CAAC,CAAC;IACrD,MAAM,UAAU,GAAG,MAAM,SAAS,CAAC,QAAQ,CAAC,CAAC;IAC7C,MAAM,EAAE,MAAM,EAAE,GAAG,QAAQ,CAAC;IAC5B,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;QACjB,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,eAAe,EAAE,iBAAiB,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE;YACnE,MAAM,EAAE,GAAG,CAAC,MAAM;YAClB,MAAM;YACN,MAAM,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI;YACxE,UAAU;SACb,CAAC,CAAC;IACP,CAAC;IACD,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;QACjB,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC;IAC1F,CAAC;IACD,OAAO,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,oBAAoB,EAAE,0BAA0B,EAAE;QACxE,IAAI,EAAE,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;QACvC,KAAK,EAAE,IAAI,IAAI,GAAG,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,QAAQ,EAAE;KAChD,CAAC,CAAC;AACP,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,SAAS,CAAC,QAAkB;IACvC,IAAI,CAAC;QACD,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAA4B,CAAC;QAChE,OAAO,OAAO,IAAI,CAAC,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACpF,CAAC;IAAC,MAAM,CAAC;QACL,OAAO,IAAI,CAAC;IAChB,CAAC;AACL,CAAC"}

package/dist/src/sources/ndex/descriptor.d.ts

@@ -0,0 +1,10 @@
+/**
+ * The NDEx source's descriptor: catalog data, available without loading the source's code.
+ */
+import { type SourceDescriptor } from "../types.js";
+/**
+ * The descriptor of the `ndex` source. Experimental.
+ * @category Network sources
+ */
+export declare const NDEX_DESCRIPTOR: SourceDescriptor;
+//# sourceMappingURL=descriptor.d.ts.map

package/dist/src/sources/ndex/descriptor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"descriptor.d.ts","sourceRoot":"","sources":["../../../../src/sources/ndex/descriptor.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,KAAK,gBAAgB,EAAqB,MAAM,aAAa,CAAC;AAevE;;;GAGG;AACH,eAAO,MAAM,eAAe,EAAE,gBAwC5B,CAAC"}

package/dist/src/sources/ndex/descriptor.js

@@ -0,0 +1,55 @@
+/**
+ * The NDEx source's descriptor: catalog data, available without loading the source's code.
+ */
+/**
+ * One public NDEx network offered as a sample.
+ * @param id - the sample id
+ * @param plainName - its name
+ * @param uuid - the network UUID
+ * @param nodes - its node count
+ * @param edges - its edge count
+ * @returns the sample
+ */
+function sample(id, plainName, uuid, nodes, edges) {
+    return { id, plainName, params: { uuid }, counts: { nodes, edges } };
+}
+/**
+ * The descriptor of the `ndex` source. Experimental.
+ * @category Network sources
+ */
+export const NDEX_DESCRIPTOR = Object.freeze({
+    plainName: "NDEx",
+    kind: "repository",
+    version: 1,
+    defaultEndpoint: "https://www.ndexbio.org/",
+    auth: ["basic", "bearer", "api-key"],
+    authRequired: "optional",
+    rateLimit: { requests: 50, perMs: 1000, concurrent: 4 },
+    params: [
+        { name: "uuid", plainName: "Network UUID", type: "string", required: true },
+        {
+            name: "format",
+            plainName: "Format",
+            type: "enum",
+            default: "cx2",
+            advanced: true,
+            values: [
+                { value: "cx2", label: "CX2" },
+                { value: "cx", label: "CX" },
+            ],
+        },
+        { name: "idAttribute", plainName: "Id attribute", type: "string", advanced: true },
+    ],
+    features: ["probe", "list", "expand", "validate"],
+    samples: [
+        sample("ndex-wp5483", "WikiPathways WP5483", "86719f5b-1439-11f0-9806-005056ae3c32", 57, 34),
+        sample("ndex-nci-pid", "NCI PID cancer signaling", "640e2cef-795d-11e8-a4bf-0ac135e8bacf", 2794, 25296),
+        sample("ndex-huri", "HuRI human interactome", "73bc2c06-5fb2-11e9-9f06-0ac135e8bacf", 8275, 52569),
+        sample("ndex-signor", "Signor", "523fff27-afe8-11e9-8bb4-0ac135e8bacf", 10339, 33381),
+        sample("ndex-dgidb", "DGIdb drugs and target genes", "7e5e64ff-f6cf-11ea-99da-0ac135e8bacf", 12100, 32814),
+        sample("ndex-wikipathways-landscape", "WikiPathways landscape", "2b3ed6af-5031-11eb-9e72-0ac135e8bacf", 32077, 74109),
+        // 3.3 million edges and a 690 MB download: offered for neighborhoods, and as a maxBytes test
+        { ...sample("ndex-pcnet", "PCNet 2.2", "8b4b54fa-e87d-11ee-9621-005056ae23aa", 18558, 3323928), whole: false },
+    ],
+});
+//# sourceMappingURL=descriptor.js.map

package/dist/src/sources/ndex/descriptor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"descriptor.js","sourceRoot":"","sources":["../../../../src/sources/ndex/descriptor.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH;;;;;;;;GAQG;AACH,SAAS,MAAM,CAAC,EAAU,EAAE,SAAiB,EAAE,IAAY,EAAE,KAAa,EAAE,KAAa;IACrF,OAAO,EAAE,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC;AACzE,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAqB,MAAM,CAAC,MAAM,CAAC;IAC3D,SAAS,EAAE,MAAM;IACjB,IAAI,EAAE,YAAY;IAClB,OAAO,EAAE,CAAC;IACV,eAAe,EAAE,0BAA0B;IAC3C,IAAI,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,SAAS,CAAC;IACpC,YAAY,EAAE,UAAU;IACxB,SAAS,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,EAAE;IACvD,MAAM,EAAE;QACJ,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,cAAc,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QAC3E;YACI,IAAI,EAAE,QAAQ;YACd,SAAS,EAAE,QAAQ;YACnB,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,KAAK;YACd,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE;gBACJ,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE;gBAC9B,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE;aAC/B;SACJ;QACD,EAAE,IAAI,EAAE,aAAa,EAAE,SAAS,EAAE,cAAc,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;KACrF;IACD,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,CAAC;IACjD,OAAO,EAAE;QACL,MAAM,CAAC,aAAa,EAAE,qBAAqB,EAAE,sCAAsC,EAAE,EAAE,EAAE,EAAE,CAAC;QAC5F,MAAM,CAAC,cAAc,EAAE,0BAA0B,EAAE,sCAAsC,EAAE,IAAI,EAAE,KAAK,CAAC;QACvG,MAAM,CAAC,WAAW,EAAE,wBAAwB,EAAE,sCAAsC,EAAE,IAAI,EAAE,KAAK,CAAC;QAClG,MAAM,CAAC,aAAa,EAAE,QAAQ,EAAE,sCAAsC,EAAE,KAAK,EAAE,KAAK,CAAC;QACrF,MAAM,CAAC,YAAY,EAAE,8BAA8B,EAAE,sCAAsC,EAAE,KAAK,EAAE,KAAK,CAAC;QAC1G,MAAM,CACF,6BAA6B,EAC7B,wBAAwB,EACxB,sCAAsC,EACtC,KAAK,EACL,KAAK,CACR;QACD,6FAA6F;QAC7F,EAAE,GAAG,MAAM,CAAC,YAAY,EAAE,WAAW,EAAE,sCAAsC,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE;KACjH;CACJ,CAAC,CAAC"}

package/dist/src/sources/ndex/expand.d.ts

@@ -0,0 +1,20 @@
+/**
+ * The NDEx source's expand: NDEx's neighborhood query (`POST /v2/search/network/{uuid}/query`),
+ * which answers CX1, read by the CX importer. Seeds are node ids, sent as `nodeIds`; NDEx's CX1
+ * answer keeps the ids of the CX2 download (checked on 2026-10-17), so an expansion merges into a
+ * loaded network by id. With `idAttribute`, seeds are values of that node attribute instead,
+ * matched by NDEx's node search.
+ */
+import { type GraphSink } from "@graphty/graph-format";
+import { type ImportReport } from "../../types.js";
+import { type ExpandRequest, type SourceContext } from "../types.js";
+import { type NdexParams } from "./params.js";
+/**
+ * Fetch the neighborhood of some nodes of an NDEx network into a sink.
+ * @param request - the seeds, depth and limit; `limit` caps the edges NDEx returns
+ * @param sink - where to write
+ * @param ctx - the context
+ * @returns the report
+ */
+export declare function expandNdex(request: ExpandRequest<NdexParams>, sink: GraphSink, ctx: SourceContext): Promise<ImportReport>;
+//# sourceMappingURL=expand.d.ts.map

package/dist/src/sources/ndex/expand.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"expand.d.ts","sourceRoot":"","sources":["../../../../src/sources/ndex/expand.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAGvD,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,OAAO,EAAE,KAAK,aAAa,EAAE,KAAK,aAAa,EAAE,MAAM,aAAa,CAAC;AAErE,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,aAAa,CAAC;AAoD9C;;;;;;GAMG;AACH,wBAAsB,UAAU,CAC5B,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,EAClC,IAAI,EAAE,SAAS,EACf,GAAG,EAAE,aAAa,GACnB,OAAO,CAAC,YAAY,CAAC,CAqBvB"}