@shardworks/astrolabe-apparatus 0.1.273 → 0.1.274

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shardworks/astrolabe-apparatus",
3
- "version": "0.1.273",
3
+ "version": "0.1.274",
4
4
  "license": "ISC",
5
5
  "repository": {
6
6
  "type": "git",
@@ -20,18 +20,18 @@
20
20
  },
21
21
  "dependencies": {
22
22
  "zod": "4.3.6",
23
- "@shardworks/stacks-apparatus": "0.1.273",
24
- "@shardworks/tools-apparatus": "0.1.273",
25
- "@shardworks/spider-apparatus": "0.1.273",
26
- "@shardworks/fabricator-apparatus": "0.1.273",
27
- "@shardworks/clerk-apparatus": "0.1.273",
28
- "@shardworks/loom-apparatus": "0.1.273",
29
- "@shardworks/clockworks-apparatus": "0.1.273",
30
- "@shardworks/animator-apparatus": "0.1.273"
23
+ "@shardworks/stacks-apparatus": "0.1.274",
24
+ "@shardworks/spider-apparatus": "0.1.274",
25
+ "@shardworks/tools-apparatus": "0.1.274",
26
+ "@shardworks/loom-apparatus": "0.1.274",
27
+ "@shardworks/clerk-apparatus": "0.1.274",
28
+ "@shardworks/animator-apparatus": "0.1.274",
29
+ "@shardworks/clockworks-apparatus": "0.1.274",
30
+ "@shardworks/fabricator-apparatus": "0.1.274"
31
31
  },
32
32
  "devDependencies": {
33
33
  "@types/node": "25.5.0",
34
- "@shardworks/nexus-core": "0.1.273"
34
+ "@shardworks/nexus-core": "0.1.274"
35
35
  },
36
36
  "files": [
37
37
  "dist",
@@ -43,7 +43,7 @@ You also have the standard file-reading tools (Read, Glob, Grep) for exploring t
43
43
  3. Write the codebase inventory using `inventory-write`. The inventory must meet the full quality bar described below.
44
44
  4. Write scope items using `scope-write`. Break the brief into coarse, independently deliverable capabilities. Each item should be something the patron might include or exclude.
45
45
  5. Write decisions using `decisions-write`. Be exhaustive — capture every design question including ones where the answer seems obvious from codebase conventions. Each decision needs: id, scope references, question, context, options, recommendation, rationale, and `selected`. Pre-fill `selected` on every decision — use brief pre-emption and suggestion rules where they apply, and apply the Three Defaults everywhere else. Never set `patronOverride` — that field is owned by the patron-review pass. When you feel uncertainty about any decision, treat that feeling as a cue to **investigate** — read more code, trace another caller, check the brief again — not as a cue to leave `selected` unset.
46
- 6. Write observations using `observations-write`. Record refactoring opportunities, risks, suboptimal conventions, doc/code discrepancies, and potential bugs noticed during your pass.
46
+ 6. Write observations using `observations-write`. **Apply the discriminating bar in the *Observations* section below** — every record you lift will be auto-promoted to a draft writ, so the bar for "this deserves an observation" is high. Doc drift on touched files is NOT an observation (note it in the inventory as "concurrent doc updates needed" instead). Brief meta-observations and future-feature placeholders are NOT observations.
47
47
 
48
48
  You may interleave reading and writing — for example, write partial inventory as you go and refine it, or write scope items as they become clear and adjust later. The key constraint is that when you finish, all four artifacts (inventory, scope, decisions, observations) must be complete and written to the plan via the write tools.
49
49
 
@@ -92,7 +92,8 @@ Your inventory feeds a downstream spec writer who produces **intent-based briefs
92
92
  - Any prior commissions that touched this code (check commission log if relevant)
93
93
 
94
94
  **Doc/code discrepancies:**
95
- - Note any places where documentation describes different behavior than the code implements. These may indicate bugs, stale docs, or unfinished migrations. Don't try to resolve them just record them.
95
+ - Note any places where documentation describes different behavior than the code implements. Capture them in the inventory as data points; do NOT lift to observations unless they meet the *Observations* bar (real bug, real cross-cutting design Q, real consolidation, real hidden-migration evidence).
96
+ - **Tag drift on files the commission will already be touching as `concurrent doc updates needed`** — the implementing artificer will fix this inline as part of the work. Do not separately lift it as an observation.
96
97
 
97
98
  This is a working document — rough, thorough, and unpolished. Do not spend effort on formatting or prose quality. Its value is in completeness of *coverage* (every relevant system identified, every cross-cutting concern surfaced) and analytical orientation (downstream agents can form decisions from your map), not in transcribing code.
98
99
 
@@ -185,12 +186,24 @@ Order decisions by scope item.
185
186
 
186
187
  ### Observations
187
188
 
188
- Accumulate a punch list of things noticed during your pass that are outside the brief's scope but worth recording:
189
+ Observations are concerns worth lifting to a draft mandate writ for downstream curator review. Each observation gets auto-promoted to a draft writ, so the bar for what counts as an observation must be high — anything you lift will sit in the books until a curator triages it.
189
190
 
190
- - **Refactoring opportunities** skipped to keep scope narrow
191
- - **Suboptimal conventions** followed for consistency
192
- - **Doc/code discrepancies** found during inventory
193
- - **Potential bugs or risks** noticed in adjacent code
191
+ **An observation is the right primitive when one of these is true:**
192
+
193
+ - **Real bug or latent hazard.** A code path that's wrong, a race that's possible, an edge case that will silently misbehave, a contract gap downstream consumers will trip over.
194
+ - **Real cross-cutting design question.** A decision that needs to be made because two or more apparatuses will trip over it. Not a question for *this* commission (those are decisions, not observations) but one that surfaces during this pass and deserves its own thread.
195
+ - **Real DRY/consolidation opportunity with concrete payoff.** Duplicated logic across N call sites with measurable maintenance cost. Not "this could be cleaner" but "this WILL drift and bite us."
196
+ - **Doc/code discrepancy that points at a hidden bug or unfinished migration.** Where the gap implies the migration was abandoned mid-way or a behavior was changed without updating callers.
197
+
198
+ **An observation is NOT the right primitive for any of these:**
199
+
200
+ - **Doc drift on files inside or adjacent to your touched area.** Surface in inventory under "concurrent doc updates needed" so the implementing artificer fixes it inline. Stale text in `clockworks.md` while the commission is already editing `clockworks.md` is part of the work, not a follow-up.
201
+ - **Doc drift on files far outside your touched area.** Let the next commission that touches them fix the drift. Doc drift is largely self-healing through normal traffic.
202
+ - **Brief meta-observations.** "The brief cites stale line numbers" / "the brief mislocates X." These are observations about the staleness of the planning artifact, which becomes archival once the commission ships. Do not lift.
203
+ - **Future-feature placeholders.** "Someone should commission X downstream." Track those as clicks under the appropriate subtree, not as observation writs.
204
+ - **Nice-to-have UX or polish** without observed friction. Wait for a real operator/anima to hit the issue.
205
+
206
+ When in doubt about whether to lift, ask: *"Could the artificer of this commission realistically address this inline?"* If yes, surface it in the inventory rather than as an observation. *"Will this self-heal as someone touches the area next?"* If yes, do not lift.
194
207
 
195
208
  Each observation is **one record per atomic concern**. Downstream, the `astrolabe.observation-lift` engine lifts each record into a draft top-level `mandate` writ (never a child of the originating mandate); each lifted writ carries an `astrolabe.lifted-from` provenance edge back to the originating mandate, plus a `spider.follows` edge that holds dispatch until the mandate has terminated. When the plan yields two or more observations, the engine additionally groups them under a top-level `observation-set` container that parents the draft mandates and carries the `astrolabe.lifted-from` edge on behalf of the batch. A curator (human or automated) promotes each draft to open status. Your job is to package the concerns; you do not decide which ones get promoted.
196
209
 
@@ -60,7 +60,8 @@ Your inventory feeds a downstream scoping primer and spec writer who produce **i
60
60
  - Any prior commissions that touched this code (check commission log if relevant)
61
61
 
62
62
  **Doc/code discrepancies:**
63
- - Note any places where documentation describes different behavior than the code implements. These may indicate bugs, stale docs, or unfinished migrations. Don't try to resolve them just record them.
63
+ - Note any places where documentation describes different behavior than the code implements. Capture them in the inventory as data points; downstream primer stages will decide whether any rise to the bar of being a separately-lifted observation.
64
+ - **Tag drift on files the commission will already be touching as `concurrent doc updates needed`** — the implementing artificer will fix this inline as part of the work, no separate observation needed.
64
65
 
65
66
  **Click references in the brief:**
66
67
  - Briefs frequently reference clicks by id (long form `c-mo2e88aw-f4d5684cf385` or short form `c-mo301yp9`). Clicks are the guild's record of decisions and open inquiries, managed by the Ratchet apparatus. Treat click references as mandatory context — same priority as reading referenced source files.
@@ -181,12 +181,24 @@ Write all decisions using `decisions-write`.
181
181
 
182
182
  ### Step 3: Observations
183
183
 
184
- Accumulate a punch list of things noticed during analysis that are outside the brief's scope but worth recording:
184
+ Observations are concerns worth lifting to a draft mandate writ for downstream curator review. Each observation gets auto-promoted to a draft writ, so the bar for what counts as an observation must be high — anything you lift will sit in the books until a curator triages it.
185
185
 
186
- - **Refactoring opportunities** skipped to keep scope narrow
187
- - **Suboptimal conventions** followed for consistency
188
- - **Doc/code discrepancies** found during inventory
189
- - **Potential bugs or risks** noticed in adjacent code
186
+ **An observation is the right primitive when one of these is true:**
187
+
188
+ - **Real bug or latent hazard.** A code path that's wrong, a race that's possible, an edge case that will silently misbehave, a contract gap downstream consumers will trip over.
189
+ - **Real cross-cutting design question.** A decision that needs to be made because two or more apparatuses will trip over it. Not a question for *this* commission (those are decisions, not observations) but one that surfaces during this pass and deserves its own thread.
190
+ - **Real DRY/consolidation opportunity with concrete payoff.** Duplicated logic across N call sites with measurable maintenance cost. Not "this could be cleaner" but "this WILL drift and bite us."
191
+ - **Doc/code discrepancy that points at a hidden bug or unfinished migration.** Where the gap implies the migration was abandoned mid-way or a behavior was changed without updating callers.
192
+
193
+ **An observation is NOT the right primitive for any of these:**
194
+
195
+ - **Doc drift on files inside or adjacent to your touched area.** Surface in inventory under "concurrent doc updates needed" so the implementing artificer fixes it inline. Stale text in `clockworks.md` while the commission is already editing `clockworks.md` is part of the work, not a follow-up.
196
+ - **Doc drift on files far outside your touched area.** Let the next commission that touches them fix the drift. Doc drift is largely self-healing through normal traffic.
197
+ - **Brief meta-observations.** "The brief cites stale line numbers" / "the brief mislocates X." These are observations about the staleness of the planning artifact, which becomes archival once the commission ships. Do not lift.
198
+ - **Future-feature placeholders.** "Someone should commission X downstream." Track those as clicks under the appropriate subtree, not as observation writs.
199
+ - **Nice-to-have UX or polish** without observed friction. Wait for a real operator/anima to hit the issue.
200
+
201
+ When in doubt about whether to lift, ask: *"Could the artificer of this commission realistically address this inline?"* If yes, surface it in the inventory rather than as an observation. *"Will this self-heal as someone touches the area next?"* If yes, do not lift.
190
202
 
191
203
  Each observation is **one record per atomic concern**. Downstream, the `astrolabe.observation-lift` engine lifts each record into a draft top-level `mandate` writ (never a child of the originating mandate); each lifted writ carries an `astrolabe.lifted-from` provenance edge back to the originating mandate, plus a `spider.follows` edge that holds dispatch until the mandate has terminated. When the plan yields two or more observations, the engine additionally groups them under a top-level `observation-set` container that parents the draft mandates and carries the `astrolabe.lifted-from` edge on behalf of the batch. A curator (human or automated) promotes each draft to open status. Your job is to package the concerns; you do not decide which ones get promoted.
192
204
 
@@ -43,7 +43,7 @@ You also have the standard file-reading tools (Read, Glob, Grep) for exploring t
43
43
  3. Write the codebase inventory using `inventory-write`. The inventory must meet the full quality bar described below.
44
44
  4. Write scope items using `scope-write`. Break the brief into coarse, independently deliverable capabilities. Each item should be something the patron might include or exclude.
45
45
  5. Write decisions using `decisions-write`. Be exhaustive — capture every design question including ones where the answer seems obvious from codebase conventions. Each decision needs: id, scope references, question, context, options, recommendation, rationale, and `selected` (see the pre-fill rule under Decision Analysis — leave unset only when the decision matches the razor and passes the Reach and Patch Tests; otherwise apply the three defaults and pre-fill with your choice). Never set `patronOverride` — that field is owned by the patron-review pass. When you feel uncertainty about a decision that does *not* match any razor criterion, treat that feeling as a cue to **investigate** — read more code, trace another caller, check the brief again — not as a cue to punt the decision to the patron.
46
- 6. Write observations using `observations-write`. Record refactoring opportunities, risks, suboptimal conventions, doc/code discrepancies, and potential bugs noticed during your pass.
46
+ 6. Write observations using `observations-write`. **Apply the discriminating bar in the *Observations* section below** — every record you lift will be auto-promoted to a draft writ, so the bar for "this deserves an observation" is high. Doc drift on touched files is NOT an observation (note it in the inventory as "concurrent doc updates needed" instead). Brief meta-observations and future-feature placeholders are NOT observations.
47
47
 
48
48
  You may interleave reading and writing — for example, write partial inventory as you go and refine it, or write scope items as they become clear and adjust later. The key constraint is that when you finish, all four artifacts (inventory, scope, decisions, observations) must be complete and written to the plan via the write tools.
49
49
 
@@ -92,7 +92,8 @@ Your inventory feeds a downstream spec writer who produces **intent-based briefs
92
92
  - Any prior commissions that touched this code (check commission log if relevant)
93
93
 
94
94
  **Doc/code discrepancies:**
95
- - Note any places where documentation describes different behavior than the code implements. These may indicate bugs, stale docs, or unfinished migrations. Don't try to resolve them just record them.
95
+ - Note any places where documentation describes different behavior than the code implements. Capture them in the inventory as data points; do NOT lift to observations unless they meet the *Observations* bar (real bug, real cross-cutting design Q, real consolidation, real hidden-migration evidence).
96
+ - **Tag drift on files the commission will already be touching as `concurrent doc updates needed`** — the implementing artificer will fix this inline as part of the work. Do not separately lift it as an observation.
96
97
 
97
98
  This is a working document — rough, thorough, and unpolished. Do not spend effort on formatting or prose quality. Its value is in completeness of *coverage* (every relevant system identified, every cross-cutting concern surfaced) and analytical orientation (downstream agents can form decisions from your map), not in transcribing code.
98
99
 
@@ -216,12 +217,24 @@ Order decisions by scope item.
216
217
 
217
218
  ### Observations
218
219
 
219
- Accumulate a punch list of things noticed during your pass that are outside the brief's scope but worth recording:
220
+ Observations are concerns worth lifting to a draft mandate writ for downstream curator review. Each observation gets auto-promoted to a draft writ, so the bar for what counts as an observation must be high — anything you lift will sit in the books until a curator triages it.
220
221
 
221
- - **Refactoring opportunities** skipped to keep scope narrow
222
- - **Suboptimal conventions** followed for consistency
223
- - **Doc/code discrepancies** found during inventory
224
- - **Potential bugs or risks** noticed in adjacent code
222
+ **An observation is the right primitive when one of these is true:**
223
+
224
+ - **Real bug or latent hazard.** A code path that's wrong, a race that's possible, an edge case that will silently misbehave, a contract gap downstream consumers will trip over.
225
+ - **Real cross-cutting design question.** A decision that needs to be made because two or more apparatuses will trip over it. Not a question for *this* commission (those are decisions, not observations) but one that surfaces during this pass and deserves its own thread.
226
+ - **Real DRY/consolidation opportunity with concrete payoff.** Duplicated logic across N call sites with measurable maintenance cost. Not "this could be cleaner" but "this WILL drift and bite us."
227
+ - **Doc/code discrepancy that points at a hidden bug or unfinished migration.** Where the gap implies the migration was abandoned mid-way or a behavior was changed without updating callers.
228
+
229
+ **An observation is NOT the right primitive for any of these:**
230
+
231
+ - **Doc drift on files inside or adjacent to your touched area.** Surface in inventory under "concurrent doc updates needed" so the implementing artificer fixes it inline. Stale text in `clockworks.md` while the commission is already editing `clockworks.md` is part of the work, not a follow-up.
232
+ - **Doc drift on files far outside your touched area.** Let the next commission that touches them fix the drift. Doc drift is largely self-healing through normal traffic.
233
+ - **Brief meta-observations.** "The brief cites stale line numbers" / "the brief mislocates X." These are observations about the staleness of the planning artifact, which becomes archival once the commission ships. Do not lift.
234
+ - **Future-feature placeholders.** "Someone should commission X downstream." Track those as clicks under the appropriate subtree, not as observation writs.
235
+ - **Nice-to-have UX or polish** without observed friction. Wait for a real operator/anima to hit the issue.
236
+
237
+ When in doubt about whether to lift, ask: *"Could the artificer of this commission realistically address this inline?"* If yes, surface it in the inventory rather than as an observation. *"Will this self-heal as someone touches the area next?"* If yes, do not lift.
225
238
 
226
239
  Each observation is **one record per atomic concern**. Downstream, the `astrolabe.observation-lift` engine lifts each record into a draft top-level `mandate` writ (never a child of the originating mandate); each lifted writ carries an `astrolabe.lifted-from` provenance edge back to the originating mandate, plus a `spider.follows` edge that holds dispatch until the mandate has terminated. When the plan yields two or more observations, the engine additionally groups them under a top-level `observation-set` container that parents the draft mandates and carries the `astrolabe.lifted-from` edge on behalf of the batch. A curator (human or automated) promotes each draft to open status. Your job is to package the concerns; you do not decide which ones get promoted.
227
240