@graphty/graph-io 0.3.47 → 0.3.49

package/dist/src/sources/rest/records.js

@@ -0,0 +1,240 @@
+/**
+ * Turning a REST API's records into nodes and edges (design section 13.2): each record of an
+ * entity is a node, each edge rule makes edges, a target with no record yet becomes a stub, and
+ * embedded records are nodes of their own entity. A stub never overwrites a full record.
+ */
+import { SOURCE_ENTITY_ATTR, SOURCE_STUB_ATTR } from "../ids.js";
+import { select, selectOne } from "./selectors.js";
+/**
+ * A fresh state.
+ * @param known - ids the caller holds already
+ * @returns the state
+ */
+export function newState(known = []) {
+    return { full: new Set(), stubs: new Set(), known: new Set(known), modified: null };
+}
+/**
+ * An id as text, with the entity's prefix stripped.
+ * @param value - what a selector reached
+ * @param entity - the entity whose prefix applies
+ * @returns the id, or null when the value is not one
+ */
+function idText(value, entity) {
+    if (typeof value !== "string" && typeof value !== "number") {
+        return null;
+    }
+    const text = String(value);
+    const prefix = entity?.stripPrefix;
+    return prefix !== undefined && prefix !== "" && text.startsWith(prefix) ? text.slice(prefix.length) : text;
+}
+/**
+ * The value of a field selector: every value for a selector with `[]`, else the first.
+ * @param record - the record
+ * @param selector - the selector
+ * @param index - the record's position, for `#`
+ * @returns the value
+ */
+function fieldValue(record, selector, index) {
+    if (selector === "#") {
+        return index;
+    }
+    return selector.includes("[]") ? select(record, selector) : selectOne(record, selector);
+}
+/** Converts the records of one page. */
+class PageWriter {
+    /**
+     * Create one.
+     * @param mapping - the mapping
+     * @param state - the load's state
+     */
+    constructor(mapping, state) {
+        this.mapping = mapping;
+        this.state = state;
+        this.out = { nodes: [], edges: [] };
+        /** Edge rules to run once every node of the page is known, so a target on this page is no stub. */
+        this.pending = [];
+    }
+    /**
+     * Add the records of an entity, and their embedded records.
+     * @param records - the records
+     * @param entityName - their entity
+     */
+    addRecords(records, entityName) {
+        const entity = this.mapping.entities[entityName];
+        records.forEach((record, index) => {
+            const id = entity.node === false ? null : idText(fieldValue(record, entity.id, index), entity);
+            if (entity.node !== false) {
+                if (id === null) {
+                    return;
+                }
+                this.addNode(record, index, id, entityName, entity);
+            }
+            const modified = this.mapping.modified === undefined ? undefined : selectOne(record, this.mapping.modified);
+            if (typeof modified === "string" && (this.state.modified === null || modified > this.state.modified)) {
+                this.state.modified = modified;
+            }
+            this.pending.push({ record, entity: entityName, id });
+            for (const em of entity.embedded ?? []) {
+                this.addRecords(select(record, em.at), em.entity);
+            }
+        });
+    }
+    /**
+     * Write a full record.
+     * @param record - the record
+     * @param index - its position
+     * @param id - its id
+     * @param entityName - its entity
+     * @param entity - the entity
+     */
+    addNode(record, index, id, entityName, entity) {
+        const attrs = { labels: [entity.label ?? entityName] };
+        if (entity.fields === undefined) {
+            // without fields every top-level scalar is kept
+            for (const [k, v] of Object.entries(record)) {
+                if (k !== "id" &&
+                    k !== "labels" &&
+                    (typeof v === "string" || typeof v === "number" || typeof v === "boolean")) {
+                    attrs[k] = v;
+                }
+            }
+        }
+        else {
+            for (const [name, selector] of Object.entries(entity.fields)) {
+                const v = fieldValue(record, selector, index);
+                if (v !== undefined) {
+                    attrs[name] = v;
+                }
+            }
+        }
+        if (this.state.stubs.has(id)) {
+            // the full record replaces a stub written earlier
+            attrs[SOURCE_STUB_ATTR] = false;
+        }
+        this.state.full.add(id);
+        this.out.nodes.push({ id, ...attrs });
+    }
+    /**
+     * Make sure an edge end exists: a stub when no record of it was written and the caller does not
+     * hold it.
+     * @param id - the id
+     * @param entity - its entity, when known
+     */
+    end(id, entity) {
+        const { full, stubs, known } = this.state;
+        if (full.has(id) || stubs.has(id) || known.has(id)) {
+            return;
+        }
+        stubs.add(id);
+        this.out.nodes.push({
+            id,
+            [SOURCE_STUB_ATTR]: true,
+            ...(entity === undefined ? {} : { [SOURCE_ENTITY_ATTR]: entity }),
+        });
+    }
+    /**
+     * Run one edge rule over a record.
+     * @param rule - the rule
+     * @param record - the record
+     * @param entityName - the record's entity
+     * @param recordId - the record's id (null for a container)
+     */
+    runRule(rule, record, entityName, recordId) {
+        const scopes = rule.each === undefined ? [record] : select(record, rule.each);
+        if ("pairs" in rule) {
+            this.runPairsRule(rule, scopes, entityName);
+        }
+        else {
+            this.runLinkRule(rule, scopes, entityName, recordId);
+        }
+    }
+    /**
+     * Run a pairs rule: an edge between every two distinct ids in each scope.
+     * @param rule - the rule
+     * @param scopes - the scopes it runs over
+     * @param entityName - the record's entity
+     */
+    runPairsRule(rule, scopes, entityName) {
+        const entityOf = rule.entity ?? entityName;
+        const entity = this.mapping.entities[entityOf];
+        for (const scope of scopes) {
+            const ids = [...new Set(select(scope, rule.pairs).map((v) => idText(v, entity)))].filter((v) => v !== null);
+            for (let i = 0; i < ids.length; i++) {
+                for (let j = i + 1; j < ids.length; j++) {
+                    this.end(ids[i], entityOf);
+                    this.end(ids[j], entityOf);
+                    this.out.edges.push({ source: ids[i], target: ids[j], type: rule.type });
+                }
+            }
+        }
+    }
+    /**
+     * Run a from/to rule: an edge from the record (or a selected id) to each selected id.
+     * @param rule - the rule
+     * @param scopes - the scopes it runs over
+     * @param entityName - the record's entity
+     * @param recordId - the record's id (null for a container)
+     */
+    runLinkRule(rule, scopes, entityName, recordId) {
+        const own = this.mapping.entities[entityName];
+        const targetEntity = rule.entity === undefined ? own : this.mapping.entities[rule.entity];
+        for (const scope of scopes) {
+            const from = rule.from === undefined ? recordId : idText(selectOne(scope, rule.from), own);
+            if (from === null) {
+                continue;
+            }
+            const tos = select(scope, rule.to)
+                .map((t) => idText(t, targetEntity))
+                .filter((v) => v !== null);
+            for (const to of tos) {
+                this.end(from, rule.from === undefined ? entityName : undefined);
+                this.end(to, rule.entity);
+                this.out.edges.push({ ...edgeFields(rule.fields, scope), source: from, target: to, type: rule.type });
+            }
+        }
+    }
+    /**
+     * Run the edge rules of every record added.
+     * @returns the page
+     */
+    finish() {
+        for (const { record, entity, id } of this.pending) {
+            for (const rule of this.mapping.entities[entity].edges ?? []) {
+                this.runRule(rule, record, entity, id);
+            }
+        }
+        this.pending.length = 0;
+        return this.out;
+    }
+}
+/**
+ * An edge's fields, read from its scope.
+ * @param fields - the rule's field selectors
+ * @param scope - the scope the edge came from
+ * @returns the fields that have a value
+ */
+function edgeFields(fields, scope) {
+    const out = {};
+    for (const [name, selector] of Object.entries(fields ?? {})) {
+        const v = fieldValue(scope, selector, 0);
+        if (v !== undefined) {
+            out[name] = v;
+        }
+    }
+    return out;
+}
+/**
+ * The nodes and edges of one page of records.
+ * @param mapping - the mapping
+ * @param groups - the page's records, by entity (a seed's records first)
+ * @param state - the load's state, updated
+ * @returns the nodes and edges
+ */
+export function toRecords(mapping, groups, state) {
+    const writer = new PageWriter(mapping, state);
+    for (const g of groups) {
+        writer.addRecords(g.records, g.entity);
+    }
+    return writer.finish();
+}
+//# sourceMappingURL=records.js.map

package/dist/src/sources/rest/records.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"records.js","sourceRoot":"","sources":["../../../../src/sources/rest/records.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAGjE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAoBnD;;;;GAIG;AACH,MAAM,UAAU,QAAQ,CAAC,QAA0B,EAAE;IACjD,OAAO,EAAE,IAAI,EAAE,IAAI,GAAG,EAAE,EAAE,KAAK,EAAE,IAAI,GAAG,EAAE,EAAE,KAAK,EAAE,IAAI,GAAG,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;AACxF,CAAC;AAED;;;;;GAKG;AACH,SAAS,MAAM,CAAC,KAAc,EAAE,MAA8B;IAC1D,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACzD,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAC3B,MAAM,MAAM,GAAG,MAAM,EAAE,WAAW,CAAC;IACnC,OAAO,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,EAAE,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAC/G,CAAC;AAED;;;;;;GAMG;AACH,SAAS,UAAU,CAAC,MAAe,EAAE,QAAgB,EAAE,KAAa;IAChE,IAAI,QAAQ,KAAK,GAAG,EAAE,CAAC;QACnB,OAAO,KAAK,CAAC;IACjB,CAAC;IACD,OAAO,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AAC5F,CAAC;AAED,wCAAwC;AACxC,MAAM,UAAU;IAKZ;;;;OAIG;IACH,YACqB,OAAoB,EACpB,KAAkB;QADlB,YAAO,GAAP,OAAO,CAAa;QACpB,UAAK,GAAL,KAAK,CAAa;QAX9B,QAAG,GAAgB,EAAE,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;QACrD,mGAAmG;QAClF,YAAO,GAA6D,EAAE,CAAC;IAUrF,CAAC;IAEJ;;;;OAIG;IACH,UAAU,CAAC,OAA2B,EAAE,UAAkB;QACtD,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QACjD,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;YAC9B,MAAM,EAAE,GAAG,MAAM,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC;YAC/F,IAAI,MAAM,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;gBACxB,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC;oBACd,OAAO;gBACX,CAAC;gBACD,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;YACxD,CAAC;YACD,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAC5G,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,KAAK,IAAI,IAAI,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACnG,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC;YACnC,CAAC;YACD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC,CAAC;YACtD,KAAK,MAAM,EAAE,IAAI,MAAM,CAAC,QAAQ,IAAI,EAAE,EAAE,CAAC;gBACrC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC;YACtD,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;OAOG;IACK,OAAO,CAAC,MAAe,EAAE,KAAa,EAAE,EAAU,EAAE,UAAkB,EAAE,MAAkB;QAC9F,MAAM,KAAK,GAA4B,EAAE,MAAM,EAAE,CAAC,MAAM,CAAC,KAAK,IAAI,UAAU,CAAC,EAAE,CAAC;QAChF,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC9B,gDAAgD;YAChD,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAiC,CAAC,EAAE,CAAC;gBACrE,IACI,CAAC,KAAK,IAAI;oBACV,CAAC,KAAK,QAAQ;oBACd,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,SAAS,CAAC,EAC5E,CAAC;oBACC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;gBACjB,CAAC;YACL,CAAC;QACL,CAAC;aAAM,CAAC;YACJ,KAAK,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC3D,MAAM,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;gBAC9C,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;oBAClB,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACpB,CAAC;YACL,CAAC;QACL,CAAC;QACD,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;YAC3B,kDAAkD;YAClD,KAAK,CAAC,gBAAgB,CAAC,GAAG,KAAK,CAAC;QACpC,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACxB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,GAAG,KAAK,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;OAKG;IACK,GAAG,CAAC,EAAU,EAAE,MAA0B;QAC9C,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QAC1C,IAAI,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;YACjD,OAAO;QACX,CAAC;QACD,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACd,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC;YAChB,EAAE;YACF,CAAC,gBAAgB,CAAC,EAAE,IAAI;YACxB,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;SACpE,CAAC,CAAC;IACP,CAAC;IAED;;;;;;OAMG;IACK,OAAO,CAAC,IAAkB,EAAE,MAAe,EAAE,UAAkB,EAAE,QAAuB;QAC5F,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9E,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;YAClB,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;QAChD,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;QACzD,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACK,YAAY,CAChB,IAA8C,EAC9C,MAA0B,EAC1B,UAAkB;QAElB,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,IAAI,UAAU,CAAC;QAC3C,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC/C,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YACzB,MAAM,GAAG,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CACpF,CAAC,CAAC,EAAe,EAAE,CAAC,CAAC,KAAK,IAAI,CACjC,CAAC;YACF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAClC,KAAK,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;oBACtC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;oBAC3B,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;oBAC3B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;gBAC7E,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACK,WAAW,CACf,IAA8C,EAC9C,MAA0B,EAC1B,UAAkB,EAClB,QAAuB;QAEvB,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC9C,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC1F,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YACzB,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;YAC3F,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;gBAChB,SAAS;YACb,CAAC;YACD,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC;iBAC7B,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;iBACnC,MAAM,CAAC,CAAC,CAAC,EAAe,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;YAC5C,KAAK,MAAM,EAAE,IAAI,GAAG,EAAE,CAAC;gBACnB,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;gBACjE,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;gBAC1B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,GAAG,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;YAC1G,CAAC;QACL,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,MAAM;QACF,KAAK,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAChD,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,KAAK,IAAI,EAAE,EAAE,CAAC;gBAC3D,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;YAC3C,CAAC;QACL,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC,GAAG,CAAC;IACpB,CAAC;CACJ;AAED;;;;;GAKG;AACH,SAAS,UAAU,CAAC,MAAoD,EAAE,KAAc;IACpF,MAAM,GAAG,GAA4B,EAAE,CAAC;IACxC,KAAK,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC,EAAE,CAAC;QAC1D,MAAM,CAAC,GAAG,UAAU,CAAC,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;QACzC,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;YAClB,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAClB,CAAC;IACL,CAAC;IACD,OAAO,GAAG,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,SAAS,CACrB,OAAoB,EACpB,MAAoF,EACpF,KAAkB;IAElB,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC9C,KAAK,MAAM,CAAC,IAAI,MAAM,EAAE,CAAC;QACrB,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IACD,OAAO,MAAM,CAAC,MAAM,EAAE,CAAC;AAC3B,CAAC"}

package/dist/src/sources/rest/samples/deps-dev.d.ts

@@ -0,0 +1,10 @@
+/**
+ * A sample mapping: the resolved dependency graph of one package version from deps.dev
+ * (https://deps.dev). The body already holds a node array and an edge array whose ends are node
+ * positions, so the body is a container and `#` gives each package its position as its id.
+ * Catalog data for the `rest` source's samples.
+ */
+import { type RestMapping } from "../params.js";
+/** The deps.dev dependencies mapping: `system` (npm, pypi, ...), `package` and `version`. */
+export declare const DEPS_DEV_MAPPING: RestMapping;
+//# sourceMappingURL=deps-dev.d.ts.map

package/dist/src/sources/rest/samples/deps-dev.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deps-dev.d.ts","sourceRoot":"","sources":["../../../../../src/sources/rest/samples/deps-dev.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,cAAc,CAAC;AAEhD,6FAA6F;AAC7F,eAAO,MAAM,gBAAgB,EAAE,WAsC7B,CAAC"}

package/dist/src/sources/rest/samples/deps-dev.js

@@ -0,0 +1,47 @@
+/**
+ * A sample mapping: the resolved dependency graph of one package version from deps.dev
+ * (https://deps.dev). The body already holds a node array and an edge array whose ends are node
+ * positions, so the body is a container and `#` gives each package its position as its id.
+ * Catalog data for the `rest` source's samples.
+ */
+/** The deps.dev dependencies mapping: `system` (npm, pypi, ...), `package` and `version`. */
+export const DEPS_DEV_MAPPING = Object.freeze({
+    version: 1,
+    endpoint: "https://api.deps.dev",
+    load: "dependencies",
+    directed: true,
+    requests: {
+        dependencies: {
+            path: "/v3/systems/{system}/packages/{package}/versions/{version}:dependencies",
+            records: ".",
+            entity: "graph",
+        },
+    },
+    entities: {
+        graph: {
+            id: "nodes",
+            node: false,
+            edges: [
+                {
+                    each: "edges[]",
+                    from: "fromNode",
+                    to: "toNode",
+                    type: "depends_on",
+                    entity: "package",
+                    fields: { requirement: "requirement" },
+                },
+            ],
+            embedded: [{ at: "nodes[]", entity: "package" }],
+        },
+        package: {
+            id: "#",
+            fields: {
+                name: "versionKey.name",
+                version: "versionKey.version",
+                system: "versionKey.system",
+                relation: "relation",
+            },
+        },
+    },
+});
+//# sourceMappingURL=deps-dev.js.map

package/dist/src/sources/rest/samples/deps-dev.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deps-dev.js","sourceRoot":"","sources":["../../../../../src/sources/rest/samples/deps-dev.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH,6FAA6F;AAC7F,MAAM,CAAC,MAAM,gBAAgB,GAAgB,MAAM,CAAC,MAAM,CAAc;IACpE,OAAO,EAAE,CAAC;IACV,QAAQ,EAAE,sBAAsB;IAChC,IAAI,EAAE,cAAc;IACpB,QAAQ,EAAE,IAAI;IACd,QAAQ,EAAE;QACN,YAAY,EAAE;YACV,IAAI,EAAE,yEAAyE;YAC/E,OAAO,EAAE,GAAG;YACZ,MAAM,EAAE,OAAO;SAClB;KACJ;IACD,QAAQ,EAAE;QACN,KAAK,EAAE;YACH,EAAE,EAAE,OAAO;YACX,IAAI,EAAE,KAAK;YACX,KAAK,EAAE;gBACH;oBACI,IAAI,EAAE,SAAS;oBACf,IAAI,EAAE,UAAU;oBAChB,EAAE,EAAE,QAAQ;oBACZ,IAAI,EAAE,YAAY;oBAClB,MAAM,EAAE,SAAS;oBACjB,MAAM,EAAE,EAAE,WAAW,EAAE,aAAa,EAAE;iBACzC;aACJ;YACD,QAAQ,EAAE,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;SACnD;QACD,OAAO,EAAE;YACL,EAAE,EAAE,GAAG;YACP,MAAM,EAAE;gBACJ,IAAI,EAAE,iBAAiB;gBACvB,OAAO,EAAE,oBAAoB;gBAC7B,MAAM,EAAE,mBAAmB;gBAC3B,QAAQ,EAAE,UAAU;aACvB;SACJ;KACJ;CACJ,CAAC,CAAC"}

package/dist/src/sources/rest/samples/string.d.ts

@@ -0,0 +1,9 @@
+/**
+ * A sample mapping: STRING's functional partners of a protein (https://string-db.org). Each
+ * interaction record names both proteins, so both are embedded nodes and the record itself is only
+ * the edge. Catalog data for the `rest` source's samples.
+ */
+import { type RestMapping } from "../params.js";
+/** The STRING network mapping: `identifiers`, `species` (NCBI taxon) and `add_nodes`. */
+export declare const STRING_MAPPING: RestMapping;
+//# sourceMappingURL=string.d.ts.map

package/dist/src/sources/rest/samples/string.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../../../../../src/sources/rest/samples/string.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,cAAc,CAAC;AAEhD,yFAAyF;AACzF,eAAO,MAAM,cAAc,EAAE,WAkC3B,CAAC"}

package/dist/src/sources/rest/samples/string.js

@@ -0,0 +1,42 @@
+/**
+ * A sample mapping: STRING's functional partners of a protein (https://string-db.org). Each
+ * interaction record names both proteins, so both are embedded nodes and the record itself is only
+ * the edge. Catalog data for the `rest` source's samples.
+ */
+/** The STRING network mapping: `identifiers`, `species` (NCBI taxon) and `add_nodes`. */
+export const STRING_MAPPING = Object.freeze({
+    version: 1,
+    endpoint: "https://string-db.org",
+    load: "network",
+    directed: false,
+    requests: {
+        network: {
+            path: "/api/json/network",
+            query: { identifiers: "{identifiers}", species: "{species}", add_nodes: "{add_nodes}" },
+            records: ".",
+            entity: "interaction",
+        },
+    },
+    entities: {
+        interaction: {
+            id: "stringId_A",
+            node: false,
+            edges: [
+                {
+                    from: "stringId_A",
+                    to: "stringId_B",
+                    type: "interacts_with",
+                    entity: "protein-b",
+                    fields: { score: "score" },
+                },
+            ],
+            embedded: [
+                { at: ".", entity: "protein-a" },
+                { at: ".", entity: "protein-b" },
+            ],
+        },
+        "protein-a": { id: "stringId_A", label: "protein", fields: { name: "preferredName_A" } },
+        "protein-b": { id: "stringId_B", label: "protein", fields: { name: "preferredName_B" } },
+    },
+});
+//# sourceMappingURL=string.js.map

package/dist/src/sources/rest/samples/string.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"string.js","sourceRoot":"","sources":["../../../../../src/sources/rest/samples/string.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,yFAAyF;AACzF,MAAM,CAAC,MAAM,cAAc,GAAgB,MAAM,CAAC,MAAM,CAAc;IAClE,OAAO,EAAE,CAAC;IACV,QAAQ,EAAE,uBAAuB;IACjC,IAAI,EAAE,SAAS;IACf,QAAQ,EAAE,KAAK;IACf,QAAQ,EAAE;QACN,OAAO,EAAE;YACL,IAAI,EAAE,mBAAmB;YACzB,KAAK,EAAE,EAAE,WAAW,EAAE,eAAe,EAAE,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,aAAa,EAAE;YACvF,OAAO,EAAE,GAAG;YACZ,MAAM,EAAE,aAAa;SACxB;KACJ;IACD,QAAQ,EAAE;QACN,WAAW,EAAE;YACT,EAAE,EAAE,YAAY;YAChB,IAAI,EAAE,KAAK;YACX,KAAK,EAAE;gBACH;oBACI,IAAI,EAAE,YAAY;oBAClB,EAAE,EAAE,YAAY;oBAChB,IAAI,EAAE,gBAAgB;oBACtB,MAAM,EAAE,WAAW;oBACnB,MAAM,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE;iBAC7B;aACJ;YACD,QAAQ,EAAE;gBACN,EAAE,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE;gBAChC,EAAE,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE;aACnC;SACJ;QACD,WAAW,EAAE,EAAE,EAAE,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,iBAAiB,EAAE,EAAE;QACxF,WAAW,EAAE,EAAE,EAAE,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,iBAAiB,EAAE,EAAE;KAC3F;CACJ,CAAC,CAAC"}

package/dist/src/sources/rest/selectors.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Selectors of the REST mapping (design section 13.2): graph-io's dotted paths plus `[]` to flatten
+ * an array. `results`, `meta.next_cursor`, `authorships[].author.id`; `.` is the value itself and
+ * `#` is a record's position in the array it came from. Not JMESPath, so graph-io keeps zero
+ * dependencies.
+ */
+/** One step of a selector: a key, and whether its value's array is flattened. */
+interface Step {
+    readonly key: string;
+    readonly flatten: boolean;
+}
+/**
+ * Parse a selector.
+ * @param selector - the text
+ * @returns its steps ([] for "."), or null when it is not a selector
+ */
+export declare function parseSelector(selector: string): readonly Step[] | null;
+/**
+ * Every value a selector reaches, in document order; missing keys reach nothing.
+ * @param value - where to start
+ * @param selector - the selector (a checked mapping holds only valid ones)
+ * @returns the values
+ */
+export declare function select(value: unknown, selector: string): unknown[];
+/**
+ * The first value a selector reaches.
+ * @param value - where to start
+ * @param selector - the selector
+ * @returns the value, or undefined
+ */
+export declare function selectOne(value: unknown, selector: string): unknown;
+/**
+ * The records a request's `records` selector names: an array it reaches is the records, any other
+ * value is one record.
+ * @param body - the response body
+ * @param selector - the selector
+ * @returns the records
+ */
+export declare function selectRecords(body: unknown, selector: string): unknown[];
+export {};
+//# sourceMappingURL=selectors.d.ts.map

package/dist/src/sources/rest/selectors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"selectors.d.ts","sourceRoot":"","sources":["../../../../src/sources/rest/selectors.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,iFAAiF;AACjF,UAAU,IAAI;IACV,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC7B;AAQD;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,IAAI,EAAE,GAAG,IAAI,CAkBtE;AAED;;;;;GAKG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,EAAE,CAkBlE;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAEnE;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,EAAE,CAGxE"}

package/dist/src/sources/rest/selectors.js

@@ -0,0 +1,81 @@
+/**
+ * Selectors of the REST mapping (design section 13.2): graph-io's dotted paths plus `[]` to flatten
+ * an array. `results`, `meta.next_cursor`, `authorships[].author.id`; `.` is the value itself and
+ * `#` is a record's position in the array it came from. Not JMESPath, so graph-io keeps zero
+ * dependencies.
+ */
+/** A key: anything but a dot or a bracket. */
+const STEP = /^([^.[\]]+)(\[\])?$/;
+/** Parsed selectors, by text. */
+const PARSED = new Map();
+/**
+ * Parse a selector.
+ * @param selector - the text
+ * @returns its steps ([] for "."), or null when it is not a selector
+ */
+export function parseSelector(selector) {
+    const cached = PARSED.get(selector);
+    if (cached !== undefined) {
+        return cached;
+    }
+    let steps = [];
+    if (selector !== ".") {
+        for (const part of selector.split(".")) {
+            const m = STEP.exec(part);
+            if (m === null) {
+                steps = null;
+                break;
+            }
+            steps.push({ key: m[1], flatten: m[2] !== undefined });
+        }
+    }
+    PARSED.set(selector, steps);
+    return steps;
+}
+/**
+ * Every value a selector reaches, in document order; missing keys reach nothing.
+ * @param value - where to start
+ * @param selector - the selector (a checked mapping holds only valid ones)
+ * @returns the values
+ */
+export function select(value, selector) {
+    let out = value === undefined ? [] : [value];
+    for (const step of parseSelector(selector) ?? []) {
+        const next = [];
+        for (const v of out) {
+            if (typeof v !== "object" || v === null || !Object.hasOwn(v, step.key)) {
+                continue;
+            }
+            const got = v[step.key];
+            if (step.flatten && Array.isArray(got)) {
+                next.push(...got);
+            }
+            else if (got !== undefined && got !== null) {
+                next.push(got);
+            }
+        }
+        out = next;
+    }
+    return out.filter((v) => v !== null && v !== undefined);
+}
+/**
+ * The first value a selector reaches.
+ * @param value - where to start
+ * @param selector - the selector
+ * @returns the value, or undefined
+ */
+export function selectOne(value, selector) {
+    return select(value, selector)[0];
+}
+/**
+ * The records a request's `records` selector names: an array it reaches is the records, any other
+ * value is one record.
+ * @param body - the response body
+ * @param selector - the selector
+ * @returns the records
+ */
+export function selectRecords(body, selector) {
+    const out = select(body, selector);
+    return out.length === 1 && Array.isArray(out[0]) ? out[0] : out;
+}
+//# sourceMappingURL=selectors.js.map

package/dist/src/sources/rest/selectors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"selectors.js","sourceRoot":"","sources":["../../../../src/sources/rest/selectors.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAQH,8CAA8C;AAC9C,MAAM,IAAI,GAAG,qBAAqB,CAAC;AAEnC,iCAAiC;AACjC,MAAM,MAAM,GAAG,IAAI,GAAG,EAAkC,CAAC;AAEzD;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,QAAgB;IAC1C,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACpC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACvB,OAAO,MAAM,CAAC;IAClB,CAAC;IACD,IAAI,KAAK,GAAkB,EAAE,CAAC;IAC9B,IAAI,QAAQ,KAAK,GAAG,EAAE,CAAC;QACnB,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;YACrC,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC1B,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;gBACb,KAAK,GAAG,IAAI,CAAC;gBACb,MAAM;YACV,CAAC;YACD,KAAK,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC,CAAC;QAC3D,CAAC;IACL,CAAC;IACD,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IAC5B,OAAO,KAAK,CAAC;AACjB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,MAAM,CAAC,KAAc,EAAE,QAAgB;IACnD,IAAI,GAAG,GAAc,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IACxD,KAAK,MAAM,IAAI,IAAI,aAAa,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC;QAC/C,MAAM,IAAI,GAAc,EAAE,CAAC;QAC3B,KAAK,MAAM,CAAC,IAAI,GAAG,EAAE,CAAC;YAClB,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBACrE,SAAS;YACb,CAAC;YACD,MAAM,GAAG,GAAI,CAA6B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACrD,IAAI,IAAI,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;gBACrC,IAAI,CAAC,IAAI,CAAC,GAAI,GAAiB,CAAC,CAAC;YACrC,CAAC;iBAAM,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;gBAC3C,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACnB,CAAC;QACL,CAAC;QACD,GAAG,GAAG,IAAI,CAAC;IACf,CAAC;IACD,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,SAAS,CAAC,CAAC;AAC5D,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,SAAS,CAAC,KAAc,EAAE,QAAgB;IACtD,OAAO,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;AACtC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAAC,IAAa,EAAE,QAAgB;IACzD,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACnC,OAAO,GAAG,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAE,GAAG,CAAC,CAAC,CAAe,CAAC,CAAC,CAAC,GAAG,CAAC;AACnF,CAAC"}

package/dist/src/sources/rest/source.d.ts

@@ -0,0 +1,67 @@
+/**
+ * Running a REST mapping (design section 13.2): `restSource(mapping, info)` turns one into a
+ * `records` source with `expand` (breadth-first, batched `{ids}`, depth 0 hydrates), `probe` and
+ * `validate`; the generic `rest` source takes the mapping as a parameter. Every request goes through
+ * `ctx.fetch`, so the credential, retries, caps and coded errors are the framework's.
+ */
+import { type GraphSource, type RecordBatch, type SourceContext, type SourceDescriptor } from "../types.js";
+import { type RestMapping, type RestParams } from "./params.js";
+import { type TemplateValues } from "./templates.js";
+/** What a call runs: the mapping and the values its templates use. */
+export interface RestPlan {
+    /** The mapping. */
+    readonly mapping: RestMapping;
+    /** The template values. */
+    readonly values: TemplateValues;
+}
+/** Why a plan is asked for: the values may differ (a validation selects only what it compares). */
+export type RestPurpose = "load" | "expand" | "probe" | "validate";
+/** Turns a call's params into the plan it runs. */
+type RestPlanner<P> = (params: P, ctx: SourceContext, purpose: RestPurpose) => RestPlan;
+/**
+ * The methods of a source that runs plans.
+ * @param plan - turns params into the plan
+ * @param paced - whether the run paces itself
+ * @returns records, expand, probe and validate
+ */
+export declare function restMethods<P>(plan: RestPlanner<P>, paced: boolean): Pick<Required<GraphSource<P>>, "expand" | "probe" | "validate"> & {
+    records: (params: P, ctx: SourceContext) => AsyncIterable<RecordBatch>;
+};
+/**
+ * What `restSource` needs beside the mapping: the source id and any descriptor fields to set.
+ * Experimental.
+ * @category Network sources
+ */
+export type RestSourceInfo = {
+    /** The source id: lowercase letters, digits and dashes. */
+    readonly id: string;
+} & Partial<SourceDescriptor>;
+/**
+ * Turn a REST mapping into a source: a `records` source that loads the mapping's `load` request
+ * page by page, with `expand` (breadth-first over the `expand` requests, `{ids}` batched; depth 0
+ * fetches the seeds' own records through `hydrate`), `probe` and `validate`. The descriptor is
+ * derived from the mapping (its endpoint, params, auth and rate limit), and `info` may set any of
+ * its fields. A mapping with a problem is refused: E_SOURCE_INVALID with `reason: "mapping"`.
+ * Experimental.
+ * @param mapping - the mapping
+ * @param info - the id and descriptor fields
+ * @returns the source
+ * @example
+ * ```ts
+ * const people = restSource(mapping, { id: "people", plainName: "People" });
+ * registerSource(people);
+ * const { snapshot } = await loadFromSource("people", { team: "core" });
+ * ```
+ * @category Network sources
+ */
+export declare function restSource(mapping: RestMapping, info: RestSourceInfo): GraphSource<Readonly<Record<string, unknown>>>;
+/**
+ * The generic REST mapping source: `params.mapping` says how to read the API, and the other params
+ * fill its templates. The mapping is checked before any request (E_SOURCE_PARAM, `name:
+ * "mapping"`, `reason` the problem's code, `at` where it is). With a credential, pass the mapping's
+ * endpoint as `endpoint`, so the credential is bound to it. Experimental.
+ * @category Network sources
+ */
+export declare const restMappingSource: GraphSource<RestParams>;
+export {};
+//# sourceMappingURL=source.d.ts.map

package/dist/src/sources/rest/source.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"source.d.ts","sourceRoot":"","sources":["../../../../src/sources/rest/source.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAWH,OAAO,EAEH,KAAK,WAAW,EAChB,KAAK,WAAW,EAChB,KAAK,aAAa,EAElB,KAAK,gBAAgB,EAKxB,MAAM,aAAa,CAAC;AAIrB,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,UAAU,EAAoB,MAAM,aAAa,CAAC;AAGlF,OAAO,EAAgB,KAAK,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAEnE,sEAAsE;AACtE,MAAM,WAAW,QAAQ;IACrB,mBAAmB;IACnB,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC;IAC9B,2BAA2B;IAC3B,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;CACnC;AAED,mGAAmG;AACnG,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,UAAU,CAAC;AAEnE,mDAAmD;AACnD,KAAK,WAAW,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,GAAG,EAAE,aAAa,EAAE,OAAO,EAAE,WAAW,KAAK,QAAQ,CAAC;AAglBxF;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,CAAC,EACzB,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,EACpB,KAAK,EAAE,OAAO,GACf,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,UAAU,CAAC,GAAG;IACjE,OAAO,EAAE,CAAC,MAAM,EAAE,CAAC,EAAE,GAAG,EAAE,aAAa,KAAK,aAAa,CAAC,WAAW,CAAC,CAAC;CAC1E,CAkBA;AAoBD;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG;IACzB,2DAA2D;IAC3D,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;CACvB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;AAiB9B;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,cAAc,GAAG,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CA2BrH;AAED;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,EAAE,WAAW,CAAC,UAAU,CAOpD,CAAC"}