@yuneta/gobj-ui 6.1.1 → 6.2.0

package/README.md

@@ -201,6 +201,23 @@ seen*:
   `projection.path`) while the rest of the tree keeps its tabs. Note the
   asymmetry that makes it a third mode and not a layout: `index` and `chrome`
   project a node's CHILDREN; `path` projects the way in.
+- **`remember_position` — an item points at where you LEFT that child.**
+  Without it a nav item points at the canonical route of its child, so a strip
+  of children behaves like a row of tabs that forgets: open a topic inside one,
+  move to a sibling, come back, and the tab is at its landing — browser Back
+  the only way to what was open. With it, the item carries the tail that was
+  last active under that child.
+
+  It stays a **real position**, which is the reason it is done here and not by
+  the viewer restoring itself: clicking is a navigation like any other, nothing
+  redirects and nothing argues with the url. A bare navigation to a child
+  records "its home", so choosing the landing sticks too.
+
+  Off by default: a tree whose children are pages wants the item to BE the
+  destination. On for a tree whose children are workspaces with a position
+  inside them — the agent console's strip of treedbs, each with its open topic.
+  Since 6.2.0.
+
 - **`nav_mode` — the three shapes as one runtime knob.** The two bullets above
   describe what a tree *declares*; `nav_mode` is how a user *chooses* between
   the shapes without the app rewriting anything:
@@ -539,12 +556,15 @@ schema, so the drawing can be held against the ASCII one in its `.c`.
 - Events: `EV_SHOW`, `EV_REBUILD`, `EV_THEME` (restyle — it repaints the G6
   graph in place, preserving the user's zoom/pan), plus `EV_NODE_CLICK`, which
   a node click sends into the FSM. **With a `node_route` the click IS a
-  navigation** and this view makes it; **without one the click is published**
-  (`{topic}`) for whoever mounted the view — a host that draws the same picture
-  inside its own screens opens the topic in place, with no hash involved. A
-  host that subscribes must declare `EV_NODE_CLICK` in its own FSM, as with
-  every event a child publishes. Since 6.1.0; before that a click with no route
-  was dropped.
+  navigation** and this view makes it. **Without one the click is dropped,
+  unless the host asked for it with `with_node_click`** — then it is published
+  as `{topic}`, for a host that draws the same picture inside its own screens
+  and opens the topic in place, with no hash involved. That host must declare
+  `EV_NODE_CLICK` in its own FSM, as with every event a child publishes, which
+  is exactly why it is opt-in: the CHILD subscription model subscribes a host
+  to ALL of this view's events, so publishing one unasked turns a click into
+  "Event NOT DEFINED in state" underneath a host that never wanted it. Since
+  6.1.2 (6.1.0 and 6.1.1 published it unconditionally).
 
 Barrel-exported and public from 4.0.0. Renders with `@antv/g6`; the cards are
 HTML nodes carrying their own inline colours, so a theme switch repaints them in

package/dist/gobj-ui.cjs.js

@@ -19831,6 +19831,7 @@ var attrs_table$3 = [
 	(0, _yuneta_gobj_js.SDATA)(_yuneta_gobj_js.data_type_t.DTP_POINTER, "subscriber", 0, null, "Subscriber of output events"),
 	(0, _yuneta_gobj_js.SDATA)(_yuneta_gobj_js.data_type_t.DTP_JSON, "descs", 0, null, "Treedb schema: {topic_name: desc}"),
 	(0, _yuneta_gobj_js.SDATA)(_yuneta_gobj_js.data_type_t.DTP_STRING, "node_route", 0, "", "Hash-route template with a {topic} placeholder: a node click opens that topic (e.g. '#/topics/db/<sel>/{topic}')"),
+	(0, _yuneta_gobj_js.SDATA)(_yuneta_gobj_js.data_type_t.DTP_BOOLEAN, "with_node_click", 0, false, "With no `node_route`, PUBLISH a node click as EV_NODE_CLICK instead of dropping it. Opt-in, because a subscriber has to DECLARE the event: the hosts that route by hash, and the ones that want nothing, must not have it appear underneath them"),
 	(0, _yuneta_gobj_js.SDATA)(_yuneta_gobj_js.data_type_t.DTP_BOOLEAN, "system", 0, false, "Include system topics (__*__) too"),
 	(0, _yuneta_gobj_js.SDATA)(_yuneta_gobj_js.data_type_t.DTP_POINTER, "$container", 0, null, "Root HTML element"),
 	(0, _yuneta_gobj_js.SDATA_END)()
@@ -20235,19 +20236,26 @@ function destroy_graph(gobj) {
 *   With a `node_route` the click IS a navigation and this view
 *   makes it: that is what the route was handed down for.
 *
-*   Without one it is still an action, and it belongs to whoever
-*   mounted this view — the schema editor draws the same picture
-*   inside its own screens, where a topic opens in place and no
-*   hash is involved. So the click is published rather than
-*   dropped. A host that subscribes must DECLARE EV_NODE_CLICK in
-*   its own FSM, as with every event a child publishes.
+*   Without one it is still an action, and it can belong to
+*   whoever mounted this view — the schema editor draws the same
+*   picture inside its own screens, where a topic opens in place
+*   and no hash is involved. That host asks for it with
+*   `with_node_click` and DECLARES EV_NODE_CLICK in its own FSM,
+*   as with every event a child publishes.
+*
+*   It is opt-in and not the default for exactly that reason: the
+*   CHILD subscription model subscribes the host to ALL of this
+*   view's events, so publishing one unasked turns a click into
+*   "Event NOT DEFINED in state" in every host that never wanted
+*   it — the topics view that mounts this as its schema landing,
+*   and the offline demo that mounts it against a json file.
 ************************************************************/
 function ac_node_click$2(gobj, event, kw, src) {
 	let topic = kw && kw.node_id;
 	let route = (0, _yuneta_gobj_js.gobj_read_str_attr)(gobj, "node_route");
 	if (!topic) return 0;
 	if (!route) {
-		(0, _yuneta_gobj_js.gobj_publish_event)(gobj, "EV_NODE_CLICK", { topic });
+		if ((0, _yuneta_gobj_js.gobj_read_bool_attr)(gobj, "with_node_click")) (0, _yuneta_gobj_js.gobj_publish_event)(gobj, "EV_NODE_CLICK", { topic });
 		return 0;
 	}
 	let href = route.replace("{topic}", topic);
@@ -23415,6 +23423,7 @@ function render_diagram(gobj) {
 		subscriber: gobj,
 		descs,
 		node_route: "",
+		with_node_click: true,
 		system: true
 	}, gobj);
 	if (!diagram) {

package/dist/gobj-ui.es.js

@@ -19818,6 +19818,7 @@ var attrs_table$3 = [
 	SDATA(data_type_t.DTP_POINTER, "subscriber", 0, null, "Subscriber of output events"),
 	SDATA(data_type_t.DTP_JSON, "descs", 0, null, "Treedb schema: {topic_name: desc}"),
 	SDATA(data_type_t.DTP_STRING, "node_route", 0, "", "Hash-route template with a {topic} placeholder: a node click opens that topic (e.g. '#/topics/db/<sel>/{topic}')"),
+	SDATA(data_type_t.DTP_BOOLEAN, "with_node_click", 0, false, "With no `node_route`, PUBLISH a node click as EV_NODE_CLICK instead of dropping it. Opt-in, because a subscriber has to DECLARE the event: the hosts that route by hash, and the ones that want nothing, must not have it appear underneath them"),
 	SDATA(data_type_t.DTP_BOOLEAN, "system", 0, false, "Include system topics (__*__) too"),
 	SDATA(data_type_t.DTP_POINTER, "$container", 0, null, "Root HTML element"),
 	SDATA_END()
@@ -20222,19 +20223,26 @@ function destroy_graph(gobj) {
 *   With a `node_route` the click IS a navigation and this view
 *   makes it: that is what the route was handed down for.
 *
-*   Without one it is still an action, and it belongs to whoever
-*   mounted this view — the schema editor draws the same picture
-*   inside its own screens, where a topic opens in place and no
-*   hash is involved. So the click is published rather than
-*   dropped. A host that subscribes must DECLARE EV_NODE_CLICK in
-*   its own FSM, as with every event a child publishes.
+*   Without one it is still an action, and it can belong to
+*   whoever mounted this view — the schema editor draws the same
+*   picture inside its own screens, where a topic opens in place
+*   and no hash is involved. That host asks for it with
+*   `with_node_click` and DECLARES EV_NODE_CLICK in its own FSM,
+*   as with every event a child publishes.
+*
+*   It is opt-in and not the default for exactly that reason: the
+*   CHILD subscription model subscribes the host to ALL of this
+*   view's events, so publishing one unasked turns a click into
+*   "Event NOT DEFINED in state" in every host that never wanted
+*   it — the topics view that mounts this as its schema landing,
+*   and the offline demo that mounts it against a json file.
 ************************************************************/
 function ac_node_click$2(gobj, event, kw, src) {
 	let topic = kw && kw.node_id;
 	let route = gobj_read_str_attr(gobj, "node_route");
 	if (!topic) return 0;
 	if (!route) {
-		gobj_publish_event(gobj, "EV_NODE_CLICK", { topic });
+		if (gobj_read_bool_attr(gobj, "with_node_click")) gobj_publish_event(gobj, "EV_NODE_CLICK", { topic });
 		return 0;
 	}
 	let href = route.replace("{topic}", topic);
@@ -23402,6 +23410,7 @@ function render_diagram(gobj) {
 		subscriber: gobj,
 		descs,
 		node_route: "",
+		with_node_click: true,
 		system: true
 	}, gobj);
 	if (!diagram) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yuneta/gobj-ui",
-  "version": "6.1.1",
+  "version": "6.2.0",
   "type": "module",
   "main": "dist/gobj-ui.cjs.js",
   "module": "dist/gobj-ui.es.js",

package/src/c_yui_node.js

@@ -106,6 +106,7 @@ import {
     gobj_parent,
     gobj_gclass_name,
     gobj_read_attr,
+    gobj_read_bool_attr,
     gobj_read_pointer_attr,
     gobj_write_attr,
     gobj_subscribe_event,
@@ -124,6 +125,7 @@ import {
     join_route,
     projection_renders,
     child_nav_items,
+    nav_route_with_tail,
     chrome_visible,
     normalize_spec,
     is_nav_mode,
@@ -175,6 +177,7 @@ SDATA(data_type_t.DTP_JSON,     "children",     0,  null,   "Declared child spec
 SDATA(data_type_t.DTP_STRING,   "base_route",   0,  "",     "ROOT only: the declared route the whole tree hangs from"),
 SDATA(data_type_t.DTP_STRING,   "tree_version", 0,  "",     "ROOT only: version of the tree CONTRACT (its paths are public urls)"),
 SDATA(data_type_t.DTP_STRING,   "nav_mode",     0,  "stack","ROOT only: how the way in is shown — stack|back|path"),
+SDATA(data_type_t.DTP_BOOLEAN,  "remember_position", 0, false, "A nav item points at WHERE THE OPERATOR LEFT that child, not at its bare route: the tail last active under each child is remembered and appended. For a tree whose children are workspaces with a position inside them (a treedb and its open topic); off for one whose children are pages, where the item IS the destination"),
 
 SDATA(data_type_t.DTP_POINTER,  "$container",   0,  null,   "Root HTMLElement (shell view contract)"),
 SDATA_END()
@@ -187,6 +190,7 @@ let PRIVATE_DATA = {
     zone_sig:       null,   /*  their last item signature                 */
     content_gobj:   null,
     active_child:   null,   /*  child NODE gobj currently on the path    */
+    remembered:     null,   /*  child id -> tail last active under it     */
     chrome_depth:   null,   /*  effective for the active path (null = all) */
     distance:       0,      /*  segments from me down to the tip           */
     chain:          null,   /*  nodes from my child down to the tip        */
@@ -224,6 +228,7 @@ function mt_create(gobj)
     gobj_subscribe_event(gobj, null, {}, subscriber);
 
     priv.children = [];
+    priv.remembered = {};
     priv.navs = [];
     priv.zone_navs = {};
     priv.zone_sig = {};
@@ -652,7 +657,16 @@ function render_projection(gobj, mode, $where, active_route, active_id, zones_on
             disabled: gobj_read_attr(child, "disabled")
         });
     }
-    let items = child_nav_items(specs, (id) => `${base}/${id}`);
+    /*  A nav item points at the child's canonical route, or — when this
+     *  tree remembers — at where the operator left that child. Same
+     *  contract either way: what the item carries is a real position,
+     *  so clicking it is a navigation and not a restore that would then
+     *  have to argue with the url.  */
+    let remember = gobj_read_bool_attr(gobj, "remember_position");
+    let items = child_nav_items(specs, (id) => {
+        let route = `${base}/${id}`;
+        return remember ? nav_route_with_tail(route, priv.remembered[id]) : route;
+    });
 
     let i = 0;
     for(let render of renders) {
@@ -714,7 +728,11 @@ function project_into_zone(gobj, render, items, active_route, active_id)
 {
     let priv = gobj.priv;
     let key = `${render.zone}|${render.layout}|${render.show_on || ""}`;
-    let sig = items.map((it) => it.id).join(",");
+    /*  The route is part of it: with `remember_position` an item's id
+     *  never changes while its destination does, so a signature of ids
+     *  alone would leave a persisted zone nav pointing at where the
+     *  operator was three navigations ago.  */
+    let sig = items.map((it) => `${it.id}=${it.route}`).join(",");
     let nav = priv.zone_navs[key];
 
     if(!nav) {
@@ -989,6 +1007,18 @@ function activate(gobj, subpath, inherited_depth)
     priv.chrome_depth = info.chrome_depth;
     priv.chain = info.chain;
 
+    /*  WHERE THE OPERATOR IS INSIDE THIS CHILD, recorded before anything
+     *  is drawn, because the strip drawn on this very activation is the
+     *  one that has to point back here.
+     *
+     *  An empty tail is recorded too, and that is not the same as not
+     *  recording: navigating to a child's bare route IS the operator
+     *  choosing its home, and the item must stop pointing at the topic
+     *  they left three navigations ago.  */
+    if(head) {
+        priv.remembered[head] = tail || "";
+    }
+
     /*  Structure ends here: whatever is left of the url is data, and it
      *  belongs to the viewer.  Re-render only the first time — paging
      *  through data must not rebuild the DOM under the viewer. */

package/src/c_yui_schema_editor.js

@@ -1389,9 +1389,11 @@ function render_diagram(gobj)
             subscriber: gobj,
             descs:      descs,
             /*  No `node_route`: this diagram lives inside the editor and
-             *  a node click is answered here, not by a hash the shell
-             *  would have to own.  */
-            node_route: "",
+             *  a node click is answered HERE, not by a hash the shell
+             *  would have to own — which is what `with_node_click` asks
+             *  for, and why EV_NODE_CLICK is declared in this FSM.  */
+            node_route:      "",
+            with_node_click: true,
             system:     true
         },
         gobj

package/src/c_yui_treedb_schema.js

@@ -94,6 +94,7 @@ const attrs_table = [
 SDATA(data_type_t.DTP_POINTER,  "subscriber",   0,  null,   "Subscriber of output events"),
 SDATA(data_type_t.DTP_JSON,     "descs",        0,  null,   "Treedb schema: {topic_name: desc}"),
 SDATA(data_type_t.DTP_STRING,   "node_route",   0,  "",     "Hash-route template with a {topic} placeholder: a node click opens that topic (e.g. '#/topics/db/<sel>/{topic}')"),
+SDATA(data_type_t.DTP_BOOLEAN,  "with_node_click", 0, false, "With no `node_route`, PUBLISH a node click as EV_NODE_CLICK instead of dropping it. Opt-in, because a subscriber has to DECLARE the event: the hosts that route by hash, and the ones that want nothing, must not have it appear underneath them"),
 SDATA(data_type_t.DTP_BOOLEAN,  "system",       0,  false,  "Include system topics (__*__) too"),
 SDATA(data_type_t.DTP_POINTER,  "$container",   0,  null,   "Root HTML element"),
 SDATA_END()
@@ -622,12 +623,19 @@ function destroy_graph(gobj)
  *   With a `node_route` the click IS a navigation and this view
  *   makes it: that is what the route was handed down for.
  *
- *   Without one it is still an action, and it belongs to whoever
- *   mounted this view — the schema editor draws the same picture
- *   inside its own screens, where a topic opens in place and no
- *   hash is involved. So the click is published rather than
- *   dropped. A host that subscribes must DECLARE EV_NODE_CLICK in
- *   its own FSM, as with every event a child publishes.
+ *   Without one it is still an action, and it can belong to
+ *   whoever mounted this view — the schema editor draws the same
+ *   picture inside its own screens, where a topic opens in place
+ *   and no hash is involved. That host asks for it with
+ *   `with_node_click` and DECLARES EV_NODE_CLICK in its own FSM,
+ *   as with every event a child publishes.
+ *
+ *   It is opt-in and not the default for exactly that reason: the
+ *   CHILD subscription model subscribes the host to ALL of this
+ *   view's events, so publishing one unasked turns a click into
+ *   "Event NOT DEFINED in state" in every host that never wanted
+ *   it — the topics view that mounts this as its schema landing,
+ *   and the offline demo that mounts it against a json file.
  ************************************************************/
 function ac_node_click(gobj, event, kw, src)
 {
@@ -638,7 +646,9 @@ function ac_node_click(gobj, event, kw, src)
         return 0;
     }
     if(!route) {
-        gobj_publish_event(gobj, "EV_NODE_CLICK", {topic: topic});
+        if(gobj_read_bool_attr(gobj, "with_node_click")) {
+            gobj_publish_event(gobj, "EV_NODE_CLICK", {topic: topic});
+        }
         return 0;
     }
     let href = route.replace("{topic}", topic);

package/src/node_tree_model.js

@@ -169,6 +169,32 @@ export function projection_renders(projection, mode)
  *  `route_of(id)` returns the canonical route of a child — the
  *  node supplies it, so this file stays route-agnostic.
  ************************************************************/
+/***************************************************************
+ *  nav_route_with_tail(route, tail) -> where that item goes
+ *
+ *      A nav item normally points at the canonical route of a
+ *      child. When the tree remembers positions it points at
+ *      WHERE THE OPERATOR LEFT that child instead: the child's
+ *      route plus the tail last active under it.
+ *
+ *      It is the difference between a strip of treedbs that
+ *      behaves like a row of tabs and one that drops what each
+ *      tab had open every time you come back to it.
+ *
+ *      An empty tail is not a position: it means the operator was
+ *      at the child's own home, which is the canonical route.
+ ***************************************************************/
+export function nav_route_with_tail(route, tail)
+{
+    let base = String(route || "");
+    let rest = String(tail || "").replace(/^\/+/, "").replace(/\/+$/, "");
+
+    if(!rest) {
+        return base;
+    }
+    return base.replace(/\/+$/, "") + "/" + rest;
+}
+
 export function child_nav_items(children, route_of)
 {
     let items = [];

package/src/node_tree_model.test.js

@@ -3,7 +3,7 @@
  *
  *      Unit tests for the pure node-tree helpers.
  ***********************************************************************/
-import { test, expect } from "vitest";
+import { describe, test, expect } from "vitest";
 import {
     chrome_visible,
     split_subpath,
@@ -11,6 +11,7 @@ import {
     join_route,
     projection_renders,
     child_nav_items,
+    nav_route_with_tail,
     normalize_spec,
     is_nav_mode,
     nav_mode_renders,
@@ -350,3 +351,32 @@ test("back is depth 1 and path is depth 0, whatever the tree declared", () => {
     expect(nav_mode_depth(null, "stack")).toBe(null);
     expect(nav_mode_depth(2, "stack")).toBe(2);
 });
+
+describe("nav_route_with_tail — a nav item that points where you left", () => {
+    test("no tail is the canonical route: the child's own home", () => {
+        expect(nav_route_with_tail("/schemas/db", "")).toBe("/schemas/db");
+        expect(nav_route_with_tail("/schemas/db", null)).toBe("/schemas/db");
+        expect(nav_route_with_tail("/schemas/db", undefined)).toBe("/schemas/db");
+    });
+
+    test("a tail is appended, which is the whole point", () => {
+        expect(nav_route_with_tail("/schemas/db", "users")).toBe("/schemas/db/users");
+        expect(nav_route_with_tail("/schemas/db", "users/info"))
+            .toBe("/schemas/db/users/info");
+    });
+
+    test("it never doubles a slash, whichever side carries one", () => {
+        expect(nav_route_with_tail("/schemas/db/", "users")).toBe("/schemas/db/users");
+        expect(nav_route_with_tail("/schemas/db", "/users")).toBe("/schemas/db/users");
+        expect(nav_route_with_tail("/schemas/db/", "/users/")).toBe("/schemas/db/users");
+    });
+
+    test("a tail of only slashes is no tail", () => {
+        expect(nav_route_with_tail("/schemas/db", "/")).toBe("/schemas/db");
+    });
+
+    test("no route at all is not a crash", () => {
+        expect(nav_route_with_tail("", "users")).toBe("/users");
+        expect(nav_route_with_tail(null, null)).toBe("");
+    });
+});