@graffy/link 0.15.11 → 0.15.13-alpha.1

package/Readme.md

@@ -2,4 +2,42 @@
 
 Graffy module for constructing links using an intuitive, declarative notation.
 
+## Example
+
+Consider a blog data model, with posts and users. Every post has an `authorId`
+property, and we would like a property `author` on posts (which link to the
+author), and a property `posts` on users, which link to an array of posts
+authored by that user.
+
+This is accomplished using:
+
+```js
+import Graffy from '@graffy/core';
+import link from '@graffy/link';
+
+const store = new Graffy();
+store.use(link({
+    'posts.$key.author': ['users', '$$posts.$key.authorId'],
+    'users.$key.posts': ['posts', { $all: true, authorId: '$$users.$key.id' }]
+}));
+
+// Add downstream providers to the store
+```
+
+## Link definitions
+
+The link module must be initialized with an object containing a set of link
+definitions.
+
+- Each link definition consists of two paths, the _source_ and the _target_.
+  The source path must be a dot-separated string. The target path must be an
+  array of strings or argument objects.
+- The source may contain _wildcard_ segments starting with `$` and followed by
+  an arbitrary name. Wildcards that were _defined_ in a source path may be
+  included in the target path, where they are replaced with matched keys from
+  the query.
+- The target may include _lookup_ strings starting with `$$` and followed by
+  dot-separated string paths (possibly including wildcards). These are replaced
+  with values returned by downstream providers.
+
 See [Graffy documentation](https://aravindet.github.io/graffy/) for more.

package/index.cjs

@@ -23,38 +23,33 @@ function linkGraph(rootGraph, defs) {
   for (const { path, def } of defs)
     linkGraphDef(rootGraph, path, def);
   return rootGraph;
-  function linkGraphDef(graph, path, def, vars = {}, version = 0) {
+  function linkGraphDef(graph, path, def, version = 0) {
     const [key, ...rest] = path;
     if (rest.length === 0) {
-      common.merge(graph, [{ key, path: common.encodePath(makeRef(def, vars)), version }]);
+      const ref = makeRef(def);
+      const [range] = common.splitRef(def);
+      const node2 = { key, path: common.encodePath(ref), version };
+      if (range)
+        node2.prefix = true;
+      common.merge(graph, [node2]);
       return;
     }
-    if (key[0] !== "$") {
-      const node = graph[common.findFirst(graph, key)];
-      if (!node || node.key !== key || !node.children) {
-        throw Error("linkGraph.no_path " + key);
-      }
-      linkGraphDef(node.children, rest, def, vars, node.version);
-    } else {
-      for (const node of graph) {
-        if (!common.isBranch(node))
-          continue;
-        linkGraphDef(node.children, rest, def, __spreadProps(__spreadValues({}, vars), {
-          [key.slice(1)]: node.key
-        }), node.version);
-      }
-    }
-  }
-  function makeRef(def, vars) {
-    function getValue(key) {
-      return key[0] === "$" ? vars[key.slice(1)] : key;
+    let node = graph[common.findFirst(graph, key)];
+    if (!node || node.key !== key || node.end) {
+      node = { key, version, value: 1 };
+      common.merge(graph, [node]);
+      delete node.value;
+      node.children = [];
     }
-    function getPath(template) {
-      return template.split(".").map(getValue);
+    if (!node.children) {
+      throw Error("linkGraph.unexpected_leaf " + key);
     }
+    linkGraphDef(node.children, rest, def, node.version);
+  }
+  function makeRef(def) {
     function replacePlaceholders(key) {
       if (typeof key === "string" && key[0] === "$" && key[1] === "$") {
-        return common.unwrap(rootGraph, getPath(key.slice(2)));
+        return common.unwrap(rootGraph, key.slice(2).split("."));
       }
       if (Array.isArray(key)) {
         return key.map(replacePlaceholders);
@@ -65,42 +60,60 @@ function linkGraph(rootGraph, defs) {
           result[prop] = replacePlaceholders(key[prop]);
         return result;
       }
-      return getValue(key);
+      return key;
     }
     const ref = def.map(replacePlaceholders);
     return ref;
   }
 }
 function prepQueryLinks(rootQuery, defs) {
-  return defs.filter(({ path, def }) => prepQueryDef(rootQuery, path, def));
+  return defs.flatMap(({ path, def }) => prepQueryDef(rootQuery, path, def));
   function prepQueryDef(query, path, def, vars = {}, version = 0) {
     var _a;
     const [key, ...rest] = path;
     if (rest.length === 0) {
       const ix = common.findFirst(query, key);
       if (((_a = query[ix]) == null ? void 0 : _a.key) !== key)
-        return false;
-      query.splice(ix, 1);
+        return [];
+      const [{ children: subQuery }] = query.splice(ix, 1);
       common.add(rootQuery, getDefQuery(def, vars, version));
-      return true;
+      const [range, filter] = common.splitRef(def);
+      if (range && subQuery.length) {
+        return subQuery.map((node) => {
+          return {
+            path: path.concat(node.key),
+            def: prepareDef(def.slice(0, -1).concat(__spreadValues(__spreadValues(__spreadValues({}, filter), common.decodeArgs(node)), range)), vars)
+          };
+        });
+      } else {
+        return [{ path, def: prepareDef(def, vars) }];
+      }
+    }
+    function prefixKey(defs2, key2) {
+      return defs2.map(({ path: path2, def: def2 }) => ({
+        path: [key2, ...path2],
+        def: def2
+      }));
     }
+    let used = [];
     if (key[0] !== "$") {
       const node = query[common.findFirst(query, key)];
       if (!node || node.key !== key || !node.children)
-        return;
-      return prepQueryDef(node.children, rest, def, vars, node.version);
+        return [];
+      used = prepQueryDef(node.children, rest, def, vars, node.version);
+      used = prefixKey(used, node.key);
     } else {
-      let used = false;
       for (const node of query) {
         if (!common.isBranch(node))
           continue;
         let usedHere = prepQueryDef(node.children, rest, def, __spreadProps(__spreadValues({}, vars), {
           [key.slice(1)]: node.key
         }), node.version);
-        used = used || usedHere;
+        usedHere = prefixKey(usedHere, node.key);
+        used = used.concat(usedHere);
       }
-      return used;
     }
+    return used;
   }
 }
 function getDefQuery(def, vars, version) {
@@ -119,14 +132,34 @@ function getDefQuery(def, vars, version) {
       key.map(addDefQueries);
     }
     if (typeof key === "object" && key) {
-      const result = {};
       for (const prop in key)
-        result[prop] = addDefQueries(key[prop]);
+        addDefQueries(key[prop]);
     }
   }
   def.map(addDefQueries);
   return defQuery;
 }
+function prepareDef(def, vars) {
+  function getValue(key) {
+    return key[0] === "$" ? vars[key.slice(1)] : key;
+  }
+  function replacePlaceholders(key) {
+    if (typeof key === "string" && key[0] === "$" && key[1] === "$") {
+      return "$$" + key.slice(2).split(".").map(getValue).join(".");
+    }
+    if (Array.isArray(key)) {
+      return key.map(replacePlaceholders);
+    }
+    if (typeof key === "object" && key) {
+      const result = {};
+      for (const prop in key)
+        result[prop] = replacePlaceholders(key[prop]);
+      return result;
+    }
+    return getValue(key);
+  }
+  return def.map(replacePlaceholders);
+}
 var index = (defs) => (store) => {
   const prefix = store.path;
   const defEntries = Object.entries(defs).map(([prop, def]) => ({

package/index.mjs

@@ -17,43 +17,38 @@ var __spreadValues = (a, b) => {
   return a;
 };
 var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
-import { merge, encodePath, findFirst, isBranch, unwrap, add, wrapValue, wrap } from "@graffy/common";
+import { splitRef, encodePath, merge, findFirst, unwrap, add, decodeArgs, isBranch, wrapValue, wrap } from "@graffy/common";
 function linkGraph(rootGraph, defs) {
   for (const { path, def } of defs)
     linkGraphDef(rootGraph, path, def);
   return rootGraph;
-  function linkGraphDef(graph, path, def, vars = {}, version = 0) {
+  function linkGraphDef(graph, path, def, version = 0) {
     const [key, ...rest] = path;
     if (rest.length === 0) {
-      merge(graph, [{ key, path: encodePath(makeRef(def, vars)), version }]);
+      const ref = makeRef(def);
+      const [range] = splitRef(def);
+      const node2 = { key, path: encodePath(ref), version };
+      if (range)
+        node2.prefix = true;
+      merge(graph, [node2]);
       return;
     }
-    if (key[0] !== "$") {
-      const node = graph[findFirst(graph, key)];
-      if (!node || node.key !== key || !node.children) {
-        throw Error("linkGraph.no_path " + key);
-      }
-      linkGraphDef(node.children, rest, def, vars, node.version);
-    } else {
-      for (const node of graph) {
-        if (!isBranch(node))
-          continue;
-        linkGraphDef(node.children, rest, def, __spreadProps(__spreadValues({}, vars), {
-          [key.slice(1)]: node.key
-        }), node.version);
-      }
-    }
-  }
-  function makeRef(def, vars) {
-    function getValue(key) {
-      return key[0] === "$" ? vars[key.slice(1)] : key;
+    let node = graph[findFirst(graph, key)];
+    if (!node || node.key !== key || node.end) {
+      node = { key, version, value: 1 };
+      merge(graph, [node]);
+      delete node.value;
+      node.children = [];
     }
-    function getPath(template) {
-      return template.split(".").map(getValue);
+    if (!node.children) {
+      throw Error("linkGraph.unexpected_leaf " + key);
     }
+    linkGraphDef(node.children, rest, def, node.version);
+  }
+  function makeRef(def) {
     function replacePlaceholders(key) {
       if (typeof key === "string" && key[0] === "$" && key[1] === "$") {
-        return unwrap(rootGraph, getPath(key.slice(2)));
+        return unwrap(rootGraph, key.slice(2).split("."));
       }
       if (Array.isArray(key)) {
         return key.map(replacePlaceholders);
@@ -64,42 +59,60 @@ function linkGraph(rootGraph, defs) {
           result[prop] = replacePlaceholders(key[prop]);
         return result;
       }
-      return getValue(key);
+      return key;
     }
     const ref = def.map(replacePlaceholders);
     return ref;
   }
 }
 function prepQueryLinks(rootQuery, defs) {
-  return defs.filter(({ path, def }) => prepQueryDef(rootQuery, path, def));
+  return defs.flatMap(({ path, def }) => prepQueryDef(rootQuery, path, def));
   function prepQueryDef(query, path, def, vars = {}, version = 0) {
     var _a;
     const [key, ...rest] = path;
     if (rest.length === 0) {
       const ix = findFirst(query, key);
       if (((_a = query[ix]) == null ? void 0 : _a.key) !== key)
-        return false;
-      query.splice(ix, 1);
+        return [];
+      const [{ children: subQuery }] = query.splice(ix, 1);
       add(rootQuery, getDefQuery(def, vars, version));
-      return true;
+      const [range, filter] = splitRef(def);
+      if (range && subQuery.length) {
+        return subQuery.map((node) => {
+          return {
+            path: path.concat(node.key),
+            def: prepareDef(def.slice(0, -1).concat(__spreadValues(__spreadValues(__spreadValues({}, filter), decodeArgs(node)), range)), vars)
+          };
+        });
+      } else {
+        return [{ path, def: prepareDef(def, vars) }];
+      }
+    }
+    function prefixKey(defs2, key2) {
+      return defs2.map(({ path: path2, def: def2 }) => ({
+        path: [key2, ...path2],
+        def: def2
+      }));
     }
+    let used = [];
     if (key[0] !== "$") {
       const node = query[findFirst(query, key)];
       if (!node || node.key !== key || !node.children)
-        return;
-      return prepQueryDef(node.children, rest, def, vars, node.version);
+        return [];
+      used = prepQueryDef(node.children, rest, def, vars, node.version);
+      used = prefixKey(used, node.key);
     } else {
-      let used = false;
       for (const node of query) {
         if (!isBranch(node))
           continue;
         let usedHere = prepQueryDef(node.children, rest, def, __spreadProps(__spreadValues({}, vars), {
           [key.slice(1)]: node.key
         }), node.version);
-        used = used || usedHere;
+        usedHere = prefixKey(usedHere, node.key);
+        used = used.concat(usedHere);
       }
-      return used;
     }
+    return used;
   }
 }
 function getDefQuery(def, vars, version) {
@@ -118,14 +131,34 @@ function getDefQuery(def, vars, version) {
       key.map(addDefQueries);
     }
     if (typeof key === "object" && key) {
-      const result = {};
       for (const prop in key)
-        result[prop] = addDefQueries(key[prop]);
+        addDefQueries(key[prop]);
     }
   }
   def.map(addDefQueries);
   return defQuery;
 }
+function prepareDef(def, vars) {
+  function getValue(key) {
+    return key[0] === "$" ? vars[key.slice(1)] : key;
+  }
+  function replacePlaceholders(key) {
+    if (typeof key === "string" && key[0] === "$" && key[1] === "$") {
+      return "$$" + key.slice(2).split(".").map(getValue).join(".");
+    }
+    if (Array.isArray(key)) {
+      return key.map(replacePlaceholders);
+    }
+    if (typeof key === "object" && key) {
+      const result = {};
+      for (const prop in key)
+        result[prop] = replacePlaceholders(key[prop]);
+      return result;
+    }
+    return getValue(key);
+  }
+  return def.map(replacePlaceholders);
+}
 var index = (defs) => (store) => {
   const prefix = store.path;
   const defEntries = Object.entries(defs).map(([prop, def]) => ({

package/package.json

@@ -2,7 +2,7 @@
   "name": "@graffy/link",
   "description": "Graffy module for constructing links using an intuitive, declarative notation.",
   "author": "aravind (https://github.com/aravindet)",
-  "version": "0.15.11",
+  "version": "0.15.13-alpha.1",
   "main": "./index.cjs",
   "exports": {
     "import": "./index.mjs",
@@ -16,6 +16,6 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@graffy/common": "0.15.11"
+    "@graffy/common": "0.15.13-alpha.1"
   }
 }