ketatlas 0.2.4 → 0.2.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.2.5
4
+
5
+ - Show separate Checks and Implemented percentage badges per workflow. Implemented includes Verified screens; project verification remains separate on the top bar. Display a dash for Checks when no checklist is recorded.
6
+
3
7
  ## 0.2.4
4
8
 
5
9
  - Anchor the progress detail header directly inside the modal top border and scroll only the form beneath it.
package/README.md CHANGED
@@ -17,15 +17,15 @@ https://github.com/user-attachments/assets/13f24fc8-7b8e-4bda-9e02-364c120ee163
17
17
  [KetAtlas is available on npm](https://www.npmjs.com/package/ketatlas). Use Node.js 22+ and run it from any directory:
18
18
 
19
19
  ```sh
20
- npx --yes ketatlas@0.2.4 scaffold my-atlas --template web
21
- npx --yes ketatlas@0.2.4 serve my-atlas/atlas.json
22
- npx --yes ketatlas@0.2.4 audit my-atlas/atlas.json --strict
20
+ npx --yes ketatlas@0.2.5 scaffold my-atlas --template web
21
+ npx --yes ketatlas@0.2.5 serve my-atlas/atlas.json
22
+ npx --yes ketatlas@0.2.5 audit my-atlas/atlas.json --strict
23
23
  ```
24
24
 
25
25
  Or install the CLI once for your user account:
26
26
 
27
27
  ```sh
28
- npm install --global ketatlas@0.2.4
28
+ npm install --global ketatlas@0.2.5
29
29
  ketatlas scaffold my-atlas
30
30
  ketatlas serve my-atlas/atlas.json
31
31
  ketatlas audit my-atlas/atlas.json --strict
package/docs/progress.md CHANGED
@@ -6,9 +6,9 @@ Screen and state preview footers show the shared screen status, blockers and lin
6
6
 
7
7
  ## Sidebar and project completion
8
8
 
9
- Project-wide verified/checklist percentages and blocker counts appear in the top bar beside **Screens**. The sidebar shows one compact numeric badge after each workflow’s step count (`2 steps [30%]`). **Verified %** is the number of Verified screens divided by the total unique screens in that scope. Repeated nodes and error variants count once; note/external nodes do not count. Screenless flows have no badge. Percentages round down so unfinished work cannot appear as 100%.
9
+ Project-wide verified/checklist percentages and blocker counts appear in the top bar beside **Screens**. The sidebar shows two badges after each workflow’s step count: **Checks %** (completed recorded acceptance checks / all recorded checks for unique screens) and **Implemented %** (screens with Implemented or Verified status / all unique screens). The compact labels are `30% checks` and `20% impl.`; tooltips spell out the definitions. In progress and In review screens do not count as implemented. Repeated nodes and error variants count once; note/external nodes do not count. Screenless flows have no badge. Flows with no recorded checks show **—**, not a measured 0%. Percentages round down so unfinished checks cannot appear as 100%.
10
10
 
11
- The badge tooltip and accessible label include status counts, blockers and **Checks %**, which counts completed recorded acceptance checks over all recorded checks, with an explicit unscoped-screen count when checklists are missing. This is not an estimate of effort, and 100% of a partial checklist does not make a screen Verified. Saving or refreshing progress updates the sidebar; changing or searching workflows preserves the current progress.
11
+ The badge tooltip and accessible label include completed/total checks, status counts, blockers, verified-screen completion, and unscoped-screen counts when checklists are missing. Checklist completion is not an estimate of effort or verified screen completion: 100% of a partial checklist does not make a screen Verified. Verified % on the top bar remains the number of Verified screens divided by all unique project screens. Saving or refreshing progress updates the sidebar; changing or searching workflows preserves the current progress.
12
12
 
13
13
  ## Status and scope
14
14
 
@@ -71,11 +71,11 @@ Evidence kinds are `pr`, `test`, `release`, `reference`. Required fields: `id`,
71
71
  ## Editing locally and from agents
72
72
 
73
73
  ```sh
74
- npx --yes ketatlas@0.2.4 serve atlas.json
75
- npx --yes ketatlas@0.2.4 serve atlas.json --read-only
76
- npx --yes ketatlas@0.2.4 progress atlas.json --init
77
- npx --yes ketatlas@0.2.4 progress atlas.json --json
78
- npx --yes ketatlas@0.2.4 progress atlas.json --set sign-in --record record.json --expect REVISION_FROM_READ
74
+ npx --yes ketatlas@0.2.5 serve atlas.json
75
+ npx --yes ketatlas@0.2.5 serve atlas.json --read-only
76
+ npx --yes ketatlas@0.2.5 progress atlas.json --init
77
+ npx --yes ketatlas@0.2.5 progress atlas.json --json
78
+ npx --yes ketatlas@0.2.5 progress atlas.json --set sign-in --record record.json --expect REVISION_FROM_READ
79
79
  ```
80
80
 
81
81
  `--init` explicitly creates Unassessed records and refuses an existing progress file. `--set` replaces one complete screen record; preserve existing checklist IDs, evidence and state references. Read the revision with `--json` first. Do not retry a stale revision by blindly substituting a new one: reload and reconcile changes. `updatedAt` is stamped on successful record writes.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ketatlas",
3
- "version": "0.2.4",
3
+ "version": "0.2.5",
4
4
  "description": "Interactive HTML maps for screens, workflows, and user journeys.",
5
5
  "type": "module",
6
6
  "license": "MIT",
@@ -142,4 +142,4 @@ When implementing or reviewing screens, track progress in the sibling `<atlas-na
142
142
 
143
143
  Map task scope to screen IDs before assigning progress. Start unknown coverage at `unassessed`; a mockup is not implementation evidence. Use `planned`, `in_progress`, `in_review`, `implemented`, `verified` with a separate blocker reason/next action. Link PRs and exact merge commits, pin/release evidence, and test evidence at the revision/environment actually checked. Do not infer deployment, full screen coverage or verification from a PR merge or green aggregate CI. Completed acceptance checks need evidence; `verified` requires passed test evidence with revision and environment for every recorded check and no blocker. Track error/recovery states using check `nodes` references. Leave unrelated or unreviewed product surfaces unassessed and say why. See `docs/progress.md` in the package for the complete contract.
144
144
 
145
- Sidebar percentages distinguish Verified screens from completed recorded checks. Do not assign arbitrary weights to intermediate statuses or remove unknown/unscoped screens to inflate completion. Workflow counts deduplicate screen IDs, including variants; process-only flows have no screen percentage.
145
+ Sidebar badges show Checks (completed recorded checks / all recorded checks) and Implemented (Implemented + Verified screens / all unique screens). No recorded checks shows — for Checks. Verified-screen completion stays separate on the project top bar. Do not assign arbitrary weights to intermediate statuses or remove unknown/unscoped screens to inflate completion. Workflow counts deduplicate screen IDs, including variants; process-only flows have no screen percentage.
package/src/index.js CHANGED
@@ -136,7 +136,7 @@ export function createAtlas(container, input, options = {}) {
136
136
  ).includes(q),
137
137
  );
138
138
  return matches.length
139
- ? `<section><h2 class="flow-group-title">${e(group)}</h2>${matches.map((f) => `<button class="flow-link ${f === current ? "active" : ""}" data-flow="${f.id}" ${f === current ? 'aria-current="true"' : ""}><span class="flow-number">${String(f.index + 1).padStart(2, "0")}</span><span class="flow-link-copy"><strong>${e(f.title)}</strong><small>${f.nodes.length} steps <span class="flow-progress" data-progress-flow="${f.id}"></span></small></span></button>`).join("")}</section>`
139
+ ? `<section><h2 class="flow-group-title">${e(group)}</h2>${matches.map((f) => `<button class="flow-link ${f === current ? "active" : ""}" data-flow="${f.id}" ${f === current ? 'aria-current="true"' : ""}><span class="flow-number">${String(f.index + 1).padStart(2, "0")}</span><span class="flow-link-copy"><strong>${e(f.title)}</strong><small>${f.nodes.length} steps <span class="flow-progress-group" data-progress-flow="${f.id}"></span></small></span></button>`).join("")}</section>`
140
140
  : "";
141
141
  })
142
142
  .join("") || '<p class="mock-filter-empty">No matching workflows.</p>';
@@ -58,15 +58,35 @@ export function mountProgress(root, config, initial, options, selectScreen) {
58
58
  .map(([key, label]) => `${summary.counts[key]} ${label.toLowerCase()}`)
59
59
  .join(" · ");
60
60
  const checks = summary.checks;
61
- const details = `${summary.verifiedPercent}% verified · ${summary.counts.verified}/${summary.total} screens. ${statuses}${summary.blocked ? ` · ${summary.blocked} blocked` : ""}. ${checks.total ? `Checks ${checks.percent}% · ${checks.done}/${checks.total}` : "No checks recorded"}${checks.unscoped ? ` · ${checks.unscoped} unscoped` : ""}.`;
61
+ const implemented = summary.counts.implemented + summary.counts.verified;
62
+ const implementedPercent = Math.floor((implemented / summary.total) * 100);
63
+ const details = `${checks.total ? `Checks ${checks.percent}% · ${checks.done}/${checks.total}. ` : "No checks recorded. "}${summary.verifiedPercent}% verified · ${summary.counts.verified}/${summary.total} screens. ${statuses}${summary.blocked ? ` · ${summary.blocked} blocked` : ""}${checks.unscoped ? ` · ${checks.unscoped} unscoped` : ""}.`;
62
64
  if (project) {
63
65
  el.innerHTML = `<span><b>${summary.verifiedPercent}%</b> verified</span><span><b>${checks.percent ?? "—"}${checks.percent === null ? "" : "%"}</b> checks</span>${summary.blocked ? `<span class="project-blocked"><b>${summary.blocked}</b> blocked</span>` : ""}`;
64
- } else el.textContent = `${summary.verifiedPercent}%`;
66
+ } else {
67
+ const metric = (name, label, percent, description) =>
68
+ `<span class="flow-progress" data-metric="${name}" data-tone="${summary.blocked ? "blocked" : percent === 100 ? "complete" : "pending"}" title="${e(description)}" aria-label="${e(description)}">${percent === null ? "—" : `${percent}%`} ${label}</span>`;
69
+ el.innerHTML =
70
+ metric(
71
+ "checks",
72
+ "checks",
73
+ checks.percent,
74
+ checks.total
75
+ ? `Checks ${checks.percent}%: ${checks.done}/${checks.total} recorded checks completed`
76
+ : "Checks: no recorded checklist",
77
+ ) +
78
+ metric(
79
+ "implemented",
80
+ "impl.",
81
+ implementedPercent,
82
+ `Implemented ${implementedPercent}%: ${implemented}/${summary.total} screens have Implemented or Verified status`,
83
+ );
84
+ }
65
85
  el.title = details;
66
86
  el.setAttribute("aria-label", details);
67
87
  el.dataset.tone = summary.blocked
68
88
  ? "blocked"
69
- : summary.verifiedPercent === 100
89
+ : (project ? summary.verifiedPercent : checks.percent) === 100
70
90
  ? "complete"
71
91
  : "pending";
72
92
  }
@@ -1440,3 +1440,13 @@ a svg {
1440
1440
  --progress-dialog-padding: var(--kv-space-3);
1441
1441
  }
1442
1442
  }
1443
+
1444
+ .flow-progress-group {
1445
+ display: inline-flex;
1446
+ align-items: center;
1447
+ gap: var(--kv-space-1);
1448
+ vertical-align: middle;
1449
+ }
1450
+ .flow-progress-group[hidden] {
1451
+ display: none;
1452
+ }
@@ -7,7 +7,7 @@ npx ketatlas serve atlas.json
7
7
  npx ketatlas audit atlas.json --strict
8
8
  ```
9
9
 
10
- Edit `atlas.json` to change nodes, edges, and screen URLs. Screen URLs are relative to that file. Refresh the browser after editing. No wrapper HTML, package manifest, lockfile, node_modules, or build step is needed. Alternatively, install the CLI once with npm install --global ketatlas@0.2.4 and use ketatlas serve atlas.json.
10
+ Edit `atlas.json` to change nodes, edges, and screen URLs. Screen URLs are relative to that file. Refresh the browser after editing. No wrapper HTML, package manifest, lockfile, node_modules, or build step is needed. Alternatively, install the CLI once with npm install --global ketatlas@0.2.5 and use ketatlas serve atlas.json.
11
11
 
12
12
  Edit the HTML files in screens/ to replace the sample product. styles/design-system.css is generated from the pinned KetJS design system; do not manually fork its tokens.
13
13
 
@@ -7,7 +7,7 @@ npx ketatlas serve atlas.json
7
7
  npx ketatlas audit atlas.json --strict
8
8
  ```
9
9
 
10
- Edit `atlas.json` to change nodes, edges, and screen URLs. Screen URLs are relative to that file. Refresh the browser after editing. No wrapper HTML, package manifest, lockfile, node_modules, or build step is needed. Alternatively, install the CLI once with npm install --global ketatlas@0.2.4 and use ketatlas serve atlas.json.
10
+ Edit `atlas.json` to change nodes, edges, and screen URLs. Screen URLs are relative to that file. Refresh the browser after editing. No wrapper HTML, package manifest, lockfile, node_modules, or build step is needed. Alternatively, install the CLI once with npm install --global ketatlas@0.2.5 and use ketatlas serve atlas.json.
11
11
 
12
12
  This template models a process without HTML screens. Add a screen registry and screen nodes when needed.
13
13
 
@@ -7,7 +7,7 @@ npx ketatlas serve atlas.json
7
7
  npx ketatlas audit atlas.json --strict
8
8
  ```
9
9
 
10
- Edit `atlas.json` to change nodes, edges, and screen URLs. Screen URLs are relative to that file. Refresh the browser after editing. No wrapper HTML, package manifest, lockfile, node_modules, or build step is needed. Alternatively, install the CLI once with npm install --global ketatlas@0.2.4 and use ketatlas serve atlas.json.
10
+ Edit `atlas.json` to change nodes, edges, and screen URLs. Screen URLs are relative to that file. Refresh the browser after editing. No wrapper HTML, package manifest, lockfile, node_modules, or build step is needed. Alternatively, install the CLI once with npm install --global ketatlas@0.2.5 and use ketatlas serve atlas.json.
11
11
 
12
12
  Edit the HTML files in screens/ to replace the sample product. styles/design-system.css is generated from the pinned KetJS design system; do not manually fork its tokens.
13
13