@graffy/link 0.15.12-alpha.2 → 0.15.13

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,28 @@ 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) {
       const ref = makeRef(def);
       const [range] = common.splitRef(def);
-      const node = { key, path: common.encodePath(ref), version };
+      const node2 = { key, path: common.encodePath(ref), version };
       if (range)
-        node.prefix = true;
-      common.merge(graph, [node]);
+        node2.prefix = true;
+      common.merge(graph, [node2]);
       return;
     }
-    if (key[0] !== "$") {
-      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 = [];
-      }
-      if (!node.children) {
-        throw Error("linkGraph.unexpected_leaf " + 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);
-      }
+    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 = [];
+    }
+    if (!node.children) {
+      throw Error("linkGraph.unexpected_leaf " + key);
     }
+    linkGraphDef(node.children, rest, def, node.version);
   }
   function makeRef(def) {
     function replacePlaceholders(key) {

package/index.mjs

@@ -17,43 +17,33 @@ var __spreadValues = (a, b) => {
   return a;
 };
 var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
-import { splitRef, encodePath, merge, findFirst, isBranch, unwrap, add, decodeArgs, 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) {
       const ref = makeRef(def);
       const [range] = splitRef(def);
-      const node = { key, path: encodePath(ref), version };
+      const node2 = { key, path: encodePath(ref), version };
       if (range)
-        node.prefix = true;
-      merge(graph, [node]);
+        node2.prefix = true;
+      merge(graph, [node2]);
       return;
     }
-    if (key[0] !== "$") {
-      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 = [];
-      }
-      if (!node.children) {
-        throw Error("linkGraph.unexpected_leaf " + 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);
-      }
+    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 = [];
+    }
+    if (!node.children) {
+      throw Error("linkGraph.unexpected_leaf " + key);
     }
+    linkGraphDef(node.children, rest, def, node.version);
   }
   function makeRef(def) {
     function replacePlaceholders(key) {

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.12-alpha.2",
+  "version": "0.15.13",
   "main": "./index.cjs",
   "exports": {
     "import": "./index.mjs",
@@ -16,6 +16,6 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@graffy/common": "0.15.12-alpha.2"
+    "@graffy/common": "0.15.13"
   }
 }