rig-review 2.11.0 → 2.13.0
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/docs/DESIGN.md +145 -74
- package/docs/PANELS.md +20 -12
- package/docs/PARTS_VIEW.md +31 -11
- package/docs/REVIEW_PACKAGE.md +215 -0
- package/docs/STABILITY.md +98 -2
- package/docs/WORKFLOWS.md +40 -12
- package/package.json +2 -1
- package/skills/rig-review/SKILL.md +29 -1
- package/src/build.ts +10 -2
- package/src/cli.ts +14 -12
- package/src/comment-crops.ts +6 -1
- package/src/compare-html.ts +22 -24
- package/src/compare-server.ts +1 -1
- package/src/compare-session.ts +41 -3
- package/src/create-pin-gate.ts +3 -0
- package/src/feedback-export.ts +67 -0
- package/src/front.ts +10 -16
- package/src/interview-routes.ts +1 -1
- package/src/job-act.ts +39 -21
- package/src/job-api.ts +291 -0
- package/src/job-cli.ts +20 -11
- package/src/job-contract.ts +91 -3
- package/src/job-front.ts +15 -7
- package/src/job-host.ts +15 -0
- package/src/job-hub.ts +4 -4
- package/src/job-image-set.ts +32 -9
- package/src/job-session.ts +19 -11
- package/src/job-source.ts +74 -30
- package/src/joined-project.ts +61 -4
- package/src/open-workspace.ts +12 -12
- package/src/open.ts +17 -9
- package/src/parts-comment.ts +31 -1
- package/src/parts-server.ts +19 -7
- package/src/parts-view.ts +103 -20
- package/src/server.ts +30 -21
- package/src/session.ts +58 -0
- package/src/stage-comment.ts +39 -0
- package/src/stage-parts.ts +18 -10
- package/web/animation-inspection.ts +1 -1
- package/web/bones-panel.ts +1 -3
- package/web/catalog-en.ts +76 -12
- package/web/catalog-ko.ts +76 -12
- package/web/cloth-panel.ts +1 -2
- package/web/compare.css +3 -9
- package/web/compare.html +3 -3
- package/web/compare.ts +69 -64
- package/web/cuts-panel.ts +1 -3
- package/web/density-strip-panel.ts +1 -2
- package/web/i18n.ts +13 -1
- package/web/idle-panel.ts +1 -2
- package/web/index.html +1 -5
- package/web/inspection-persistence.ts +2 -1
- package/web/inspector-blocks.ts +144 -39
- package/web/instance-access.ts +24 -5
- package/web/interview-panel.ts +224 -175
- package/web/job-hub.ts +50 -69
- package/web/job-rig-capture.ts +103 -10
- package/web/job-rig-screen.ts +317 -0
- package/web/job-session.ts +927 -1365
- package/web/main.ts +535 -129
- package/web/mesh-panel.ts +1 -2
- package/web/owner-workspace.ts +88 -109
- package/web/part-selection.ts +47 -6
- package/web/part-thumbnails.ts +20 -6
- package/web/parts-viewport-provider.ts +166 -9
- package/web/physics-panel.ts +1 -2
- package/web/readings-panel.ts +1 -2
- package/web/requirements-panel.ts +1 -3
- package/web/retained-frame-stage.ts +105 -0
- package/web/retarget-panel.ts +2 -3
- package/web/rig-fields-panel.ts +1 -2
- package/web/rig-host.ts +62 -0
- package/web/rig-viewport-provider.ts +63 -16
- package/web/stage-comments.ts +29 -26
- package/web/styles.css +127 -43
- package/web/view-controls.ts +201 -12
- package/web/viewport-controller.ts +97 -26
- package/web/viewport-pair.ts +2 -1
- package/web/workspace-preferences.ts +5 -4
- package/web/workspace-ui.ts +152 -19
- package/src/interview-server.ts +0 -54
- package/web/interview.css +0 -28
- package/web/interview.html +0 -17
- package/web/interview.ts +0 -40
- package/web/job-hub.css +0 -14
- package/web/job-hub.html +0 -5
- package/web/owner-workspace.css +0 -14
- package/web/owner-workspace.html +0 -5
- package/web/parts-flags.ts +0 -48
- package/web/parts-page.ts +0 -217
- package/web/parts.css +0 -116
- package/web/parts.html +0 -15
- package/web/parts.ts +0 -986
- package/web/stage-nav.ts +0 -136
package/docs/REVIEW_PACKAGE.md
CHANGED
|
@@ -848,6 +848,32 @@ parts verdict source digest and actual original PNG SHA-256, without a fabricate
|
|
|
848
848
|
manifest id, revision or compiled model. The rig's `rig-review-comment/1` schema stays closed.
|
|
849
849
|
See [the parts contract and validation instruments](PARTS_VIEW.md#pointed-parts-comments).
|
|
850
850
|
|
|
851
|
+
### Interview-stage project subject
|
|
852
|
+
|
|
853
|
+
`rig-review open <project-root> --project <project-root> --picks-dir <dir>`
|
|
854
|
+
opens an interview-stage Create project before a draft or recorded review
|
|
855
|
+
package exists. Both roots must resolve to the same directory. The picks output
|
|
856
|
+
is an existing dedicated project-relative directory disjoint from inputs.
|
|
857
|
+
No version/draft selector is inferred: demo/build version records and unrelated
|
|
858
|
+
derived evidence are allowed, while an actual draft or a non-null
|
|
859
|
+
`versions[].review_package` requires its existing explicit package designation.
|
|
860
|
+
This form takes exactly one target and no additional inspection options.
|
|
861
|
+
|
|
862
|
+
The existing joined resolver reads the project, retained option sets and input
|
|
863
|
+
hashes. The launcher retains an internal interview subject, not a `ReviewPackage`.
|
|
864
|
+
The shared server serves the same `web/index.html` and bounded interview routes;
|
|
865
|
+
its internal `/api/review` response contains `subject: "interview"`, project
|
|
866
|
+
path/hash, source hash, label and capability flags, with no manifest, model,
|
|
867
|
+
reviewed-package identity or package session. The existing modal mounts the
|
|
868
|
+
existing interview form. Model APIs refuse `MODEL_UNAVAILABLE`; source drift
|
|
869
|
+
refuses `INTERVIEW_OPTIONS_STALE`. Reads do not write sources. The joined dialog and standing record form use one shared list | image | survey
|
|
870
|
+
answer builder. There is no interview Note input. Existing saved or historical
|
|
871
|
+
notes remain readable as read-only text and are carried unchanged. Joined picks
|
|
872
|
+
omit `note` when none exists; the job act retains its required string field.
|
|
873
|
+
Historical records, picks/act/verdict schemas and explicit
|
|
874
|
+
version/draft joins retain their existing readers and checks.
|
|
875
|
+
This opening form does not replace the semantic standing review cycle.
|
|
876
|
+
|
|
851
877
|
## Stage-1 draft mesh inspection
|
|
852
878
|
|
|
853
879
|
`GET /api/stage-parts` in single inspections uses the live handoff's original
|
|
@@ -1416,3 +1442,192 @@ record-checkpoint flow following Create #395 integration. Create owns the actual
|
|
|
1416
1442
|
producer receipt. Review's plan-signoff rendering has synthetic UI coverage.
|
|
1417
1443
|
Normal CLI plan-signoff bootstrap and `plan-approved` act@4 ingestion are a
|
|
1418
1444
|
separate Create follow-up. (Naru, 2026-11-11)
|
|
1445
|
+
|
|
1446
|
+
## Comments decoder contract
|
|
1447
|
+
|
|
1448
|
+
The comments feature accepts multiple ordered entries, each general or pinned to
|
|
1449
|
+
an existing inspection target. Surveys remain separate answer inputs: interview
|
|
1450
|
+
selections, inline Other text and per-question notes keep their existing formats,
|
|
1451
|
+
strings and readers. There is no interview-picks arm or question/ask anchor in
|
|
1452
|
+
this extension. Technical configuration and search controls are outside it.
|
|
1453
|
+
|
|
1454
|
+
The decoders and consumer projections are read-only. Since [Review #713](https://github.com/rig-c/review/issues/713)
|
|
1455
|
+
(HQ contract ruling), the UI finalizers write fresh checkpoint, parts-verdict,
|
|
1456
|
+
rig and direction review-verdict and signoff acts as act@6. The UI submission
|
|
1457
|
+
keeps its existing `words` and `issues` fields. [Review #746](https://github.com/rig-c/review/issues/746)
|
|
1458
|
+
adds optional `feedback: Feedback[]` beside required `words` only for the
|
|
1459
|
+
`rig-review` verdict submission. When present, including an empty list, it is
|
|
1460
|
+
the complete comment list: `feedbackItemComments` maps each row's `summary` to
|
|
1461
|
+
`text` and retains its `id`, frames, target, category and `anchor.context`.
|
|
1462
|
+
The existing decoder validates every mapped comment, its evidence and the
|
|
1463
|
+
whole scalar bound; malformed or blank rows refuse rather than falling back to
|
|
1464
|
+
`words`. The act bar sends a detached feedback list when comments exist and
|
|
1465
|
+
keeps `words` as their projection. It omits `feedback` when there are no comments.
|
|
1466
|
+
Absent `feedback` retains the previous written bytes and words-only mapping.
|
|
1467
|
+
Direction and image verdict submissions do not accept `feedback`. The written
|
|
1468
|
+
act remains act@6; historical words-only acts retain their readers.
|
|
1469
|
+
|
|
1470
|
+
Pointed marks, inline crops, bookmarks and valid time-only null frames remain
|
|
1471
|
+
inside the existing `anchor.context`. This is distinct from act@7's top-level
|
|
1472
|
+
`comment.context`, which remains disabled by `EMIT_UNPINNED_CREATE_FIELDS`.
|
|
1473
|
+
No new field or decoder rule is added to the written act.
|
|
1474
|
+
|
|
1475
|
+
For the words-only mapping, the daemon maps a nonblank note
|
|
1476
|
+
to one comment: anchored to the checkpoint for a checkpoint, general otherwise.
|
|
1477
|
+
It maps each Parts issue to a Parts-anchored comment, before the note. A blank
|
|
1478
|
+
or whitespace-only note writes no comment (`comments: []`). Nothing is padded.
|
|
1479
|
+
A note whose projection exceeds the 10,000-unit scalar bound refuses
|
|
1480
|
+
`JOB_ACT_INVALID`. The bound counts the stored `words`, and the `[label]\n`
|
|
1481
|
+
prefix is part of them, so a general note longer than 9,990 units refuses even
|
|
1482
|
+
though act@5 accepted it. Feedback is many comments, not one long note.
|
|
1483
|
+
Each written act must decode through `parseCommentsAct`.
|
|
1484
|
+
Image-review verdicts and interview picks stay at act@2, because Create refuses
|
|
1485
|
+
both under act@6. Record acts stay at act@4, because Create maps only a record
|
|
1486
|
+
checkpoint under act@6. Standalone save paths keep their existing versions.
|
|
1487
|
+
|
|
1488
|
+
The existing `@rig-c/review/job-host` facade exports:
|
|
1489
|
+
|
|
1490
|
+
| Function | Input → output |
|
|
1491
|
+
| --- | --- |
|
|
1492
|
+
| `parseCommentsAct` | `unknown` → `JobCommentsAct` |
|
|
1493
|
+
| `projectComments` | `readonly JobComment[]` → `string` |
|
|
1494
|
+
| `parseCommentsSession` | `unknown` → `ReviewCommentsSession` |
|
|
1495
|
+
| `parseCommentsCompareSession` | `unknown` → `CompareCommentsSession` |
|
|
1496
|
+
| `parseCommentsPartsVerdict` | `unknown` → `PartsCommentsVerdict` |
|
|
1497
|
+
| `projectSelectedCommentsFeedback` | `ReviewCommentsSession, itemId: string` → `{anchor: JobCommentFeedbackAnchor; summary: string}` |
|
|
1498
|
+
|
|
1499
|
+
Use a decoder before projecting untrusted input. These functions perform no
|
|
1500
|
+
filesystem writes. Decode success validates declared identities and syntax; it
|
|
1501
|
+
does not grant producer/source-kind admission or prove retained asset freshness,
|
|
1502
|
+
source-native pixels, clock availability or owner authority. Those checks stay
|
|
1503
|
+
with the existing retained-source, package feedback and crop pipeline. The
|
|
1504
|
+
native-image region preparation adapter is still required before image-region
|
|
1505
|
+
writers activate.
|
|
1506
|
+
|
|
1507
|
+
`JOB_COMMENTS_ACT_SCHEMA` is `rig-review/act@6`. Its exact envelope keys are
|
|
1508
|
+
`schema, actId, jobId, askId, publicationId, kind, authority, at, source, value`.
|
|
1509
|
+
The existing top-level `still` is required only for a model `rig-review` verdict
|
|
1510
|
+
and forbidden otherwise. It retains fixed camera, content-addressed PNG path,
|
|
1511
|
+
SHA-256 and setup-or-numeric-animation-time validation. The raw export and CLI
|
|
1512
|
+
reuse their existing PNG byte checks and preserve original act stdout bytes.
|
|
1513
|
+
The authority remains daemon-owned human `review-ui` authority. Model/image
|
|
1514
|
+
bindings and record plan sources retain their existing definitions; record
|
|
1515
|
+
option-set sources are excluded. Source capabilities remain consumer-owned.
|
|
1516
|
+
|
|
1517
|
+
| Kind | Exact value keys |
|
|
1518
|
+
| --- | --- |
|
|
1519
|
+
| `checkpoint` | `checkpointId, planStepId, outcome, comments` (`pass` or `fail`) |
|
|
1520
|
+
| `parts-verdict` | `verdict, comments` (`approved` or `changes-requested`) |
|
|
1521
|
+
| `review-verdict` | `stage, verdict, comments` (existing rig/direction/image stages and verdicts) |
|
|
1522
|
+
| `signoff` | `stage, decision, comments` (`approved`) |
|
|
1523
|
+
| `reopen` | `stage, comments` (existing declared record plan subject) |
|
|
1524
|
+
|
|
1525
|
+
The declared plan/source/selector and ask eligibility checks remain applicable.
|
|
1526
|
+
The browser never supplies authoritative checkpoint-to-plan mapping. A Parts
|
|
1527
|
+
verdict is approved exactly when it has no pointed Parts issue anchors; general
|
|
1528
|
+
comments do not create issues. Verdict and signoff remain distinct immutable
|
|
1529
|
+
acts even when one user action will submit the same comments to both.
|
|
1530
|
+
|
|
1531
|
+
A `comments` array has at most 1,000 entries. Each entry has exactly `text` and
|
|
1532
|
+
optional `anchor`. Fresh text is a nonblank string of at most 10,000 UTF-16 units;
|
|
1533
|
+
trimming is a validation predicate and never changes the stored text. Reusing a
|
|
1534
|
+
Feedback or Parts codec preserves its stricter existing text limit. Existing
|
|
1535
|
+
evidence IDs stay unique. Intentional duplicate text and stored order remain.
|
|
1536
|
+
Unknown fields and mixed anchor arms refuse.
|
|
1537
|
+
|
|
1538
|
+
Anchors use existing source-bound fields without a new kind discriminator:
|
|
1539
|
+
|
|
1540
|
+
- Feedback without `summary`: `id, frameStart, frameEnd, target, category`, with
|
|
1541
|
+
optional `context` and compare-only `side`. StageComment remains inside
|
|
1542
|
+
`context.comment`; existing codecs and inline PNG validation are reused.
|
|
1543
|
+
- PartsIssue without `summary`: `schema, id, parts, sourceHash, rigRegion,
|
|
1544
|
+
imageRegion, view, crop, nativeCrop`. Finalized item anchors require prepared
|
|
1545
|
+
native crop metadata. Assembled anchors retain null native crop. Optional assembled-only
|
|
1546
|
+
`view.visibleLayers: {name, imageHash}[]` retains the complete visible set in
|
|
1547
|
+
source item order, bound to `sourceHash` and each loaded source image. Entries
|
|
1548
|
+
must be unique and source-bound before restoration replaces the hidden set.
|
|
1549
|
+
Absent fields retain the historical restore branch and recorded bytes. Readers
|
|
1550
|
+
accept both forms; fresh capture writes this field only when the shared
|
|
1551
|
+
`EMIT_UNPINNED_CREATE_FIELDS` gate is enabled after Create confirms its parser pin.
|
|
1552
|
+
- Named image: `name`, optionally the complete existing-field composition
|
|
1553
|
+
`imageRegion, crop, nativeCrop`. Names resolve in the sealed image set. Regions
|
|
1554
|
+
use nonnegative native-pixel integer origins, positive extents and at most
|
|
1555
|
+
16,777,216 pixels. Actual image bounds and crop-to-original equality remain
|
|
1556
|
+
native preparation checks.
|
|
1557
|
+
- Checkpoint: `checkpointId, planStepId`, resolved through the existing source
|
|
1558
|
+
plan and any declared evidence mapping.
|
|
1559
|
+
|
|
1560
|
+
`projectComments` traverses stored order. Each scalar block is
|
|
1561
|
+
`[label]\n` followed by exact `text`, with `\n\n` between blocks; the empty array
|
|
1562
|
+
projects to the empty string. The complete scalar is bounded to 10,000 UTF-16
|
|
1563
|
+
units. Lists retain individual entries. A general label is `general`; other
|
|
1564
|
+
labels are `JSON.stringify` of these logical target tuples:
|
|
1565
|
+
|
|
1566
|
+
| Anchor | Label tuple |
|
|
1567
|
+
| --- | --- |
|
|
1568
|
+
| Checkpoint | `["checkpoint", checkpointId]` |
|
|
1569
|
+
| Parts | `[schema, parts.map(part => part.name), view.mode]` |
|
|
1570
|
+
| Image | `[name]` |
|
|
1571
|
+
| StageComment-backed Feedback | `[mark.schema, mark.mode, mark.viewport, target.kind, target.name, frameStart, frameEnd]` |
|
|
1572
|
+
| Other Feedback | `[target.kind, target.name, frameStart, frameEnd, side ?? null]` |
|
|
1573
|
+
|
|
1574
|
+
Capture IDs, hashes and crop bytes stay in the raw anchor and do not enter the
|
|
1575
|
+
logical label. This keeps wording stable when a later Apply recaptures the same
|
|
1576
|
+
target. Consumer projection never serializes a synthetic historical act/session.
|
|
1577
|
+
|
|
1578
|
+
The standalone schema constants are `REVIEW_COMMENTS_SESSION_SCHEMA` =
|
|
1579
|
+
`rig-review-session/2`, `REVIEW_COMMENTS_COMPARE_SESSION_SCHEMA` =
|
|
1580
|
+
`rig-review-compare-session/2`, and `PARTS_COMMENTS_VERDICT_SCHEMA` =
|
|
1581
|
+
`rig-review-parts-verdict/5`. Session/2 replaces `feedback` with `comments` and
|
|
1582
|
+
checkpoint note entries with outcome-only entries. Compare/2 replaces `feedback`
|
|
1583
|
+
with `comments`, requires an explicit side on Feedback anchors and checks its
|
|
1584
|
+
existing binding hash. Parts/5 replaces `issues` with `comments`, deriving the
|
|
1585
|
+
issue relation from Parts anchors. Other existing envelope/provenance fields
|
|
1586
|
+
remain. `projectSelectedCommentsFeedback` selects exactly one Feedback
|
|
1587
|
+
`anchor.id` and returns that anchor plus the scalar projection of its entry for
|
|
1588
|
+
existing correction-writer arguments. The original new-session stdout remains
|
|
1589
|
+
the immutable evidence.
|
|
1590
|
+
|
|
1591
|
+
Historical @2–@5 acts, session/1, compare-session/1, Parts/4 and survey records
|
|
1592
|
+
stay on their original readers, raw bytes, hashes, stills and replay paths.
|
|
1593
|
+
Display adaptation of old user feedback creates one general comment per existing
|
|
1594
|
+
summary/note/words field, including empty strings; it never rewrites history or
|
|
1595
|
+
reclassifies survey answers. Legacy correction summaries remain literal. Create's
|
|
1596
|
+
old Parts names projection gives a present `issues[]` precedence even for /1-/2;
|
|
1597
|
+
only absent `issues[]` uses `part.note`. Literal-byte controls and all eighteen
|
|
1598
|
+
cross-repository oracle outcomes belong in the PR evidence. Parser-only native
|
|
1599
|
+
coverage does not substitute for Create's actual ingest/replay receipt or owner
|
|
1600
|
+
working-screen review.
|
|
1601
|
+
|
|
1602
|
+
### Comment context (act@7)
|
|
1603
|
+
|
|
1604
|
+
`JOB_COMMENT_CONTEXT_ACT_SCHEMA` is `rig-review/act@7` ([#714](https://github.com/rig-c/review/issues/714)).
|
|
1605
|
+
It is the @6 envelope, kinds, value keys and checks with one addition: each
|
|
1606
|
+
comment entry may carry an optional `context` object after `text` and `anchor`.
|
|
1607
|
+
`context` records where the comment was made so opening it can restore that
|
|
1608
|
+
view. It is not part of the signed projection: `projectComments` covers `text`
|
|
1609
|
+
and `anchor` only. `parseContextCommentsAct` decodes @7 only; `parseCommentsAct`
|
|
1610
|
+
still decodes @6 only and refuses `context`. @2–@6 bytes, hashes and readers do
|
|
1611
|
+
not change.
|
|
1612
|
+
|
|
1613
|
+
`context` is closed and nonempty. Every key is optional and copies a value an
|
|
1614
|
+
existing pin or restore path already carries:
|
|
1615
|
+
|
|
1616
|
+
| Key | Shape | Existing source |
|
|
1617
|
+
| --- | --- | --- |
|
|
1618
|
+
| `subject` | `{ask, sourceHash, selector?}` | the ask's `JobSubject`, the act source's `sourceHash` and `selector`. `ask.kind` must equal the act `kind`; `sourceHash` and `selector` must equal the act source (`JOB_ACT_INVALID`) |
|
|
1619
|
+
| `mode` | `setup`, `animate` or `compare` | StageComment `mode`, bookmark `selection.mode` |
|
|
1620
|
+
| `tab` | `view`, `rig`, `playback` or `feedback` | bookmark `selection.inspector` |
|
|
1621
|
+
| `part` | ControlPart `{side, slot, mode, identity?}` | bookmark `selection.part` (absent, never `null`) |
|
|
1622
|
+
| `region` | world-space `{x, y, width, height}` | StageComment `world`, PartsIssue `rigRegion` |
|
|
1623
|
+
| `viewMode` | `item` or `assembled` | PartsIssue `view.mode` |
|
|
1624
|
+
| `camera` | numeric camera `{space, center, zoom, viewport, visible}` | StageComment `camera` |
|
|
1625
|
+
| `frame` | `{index, basis}` (`producer` or `reference`) | StageComment `frame` (absent when time-only) |
|
|
1626
|
+
|
|
1627
|
+
Each key reuses the decoder of the shape it copies. A `reopen` act has no ask
|
|
1628
|
+
subject, so its comments cannot carry `context.subject`.
|
|
1629
|
+
|
|
1630
|
+
Create refuses unknown fields, so Review emits @7 only when
|
|
1631
|
+
`EMIT_UNPINNED_CREATE_FIELDS` (`src/create-pin-gate.ts`) is true. It is false
|
|
1632
|
+
until the create tower confirms Create has pinned the Review version that reads
|
|
1633
|
+
@7. While it is false, writers drop every `context` and emit @6.
|
package/docs/STABILITY.md
CHANGED
|
@@ -1,5 +1,39 @@
|
|
|
1
1
|
# Public API stability
|
|
2
2
|
|
|
3
|
+
## Interview-stage project opening
|
|
4
|
+
|
|
5
|
+
The additional CLI form is:
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
rig-review open /path/to/project --project /path/to/project --picks-dir scratch/review-picks
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Both root operands must resolve to the same Create project. The picks directory
|
|
12
|
+
must already exist, be project-relative and be disjoint from declared inputs.
|
|
13
|
+
Omitting both selectors is supported only at `stage: "interview"` without a
|
|
14
|
+
recorded draft or a non-null `versions[].review_package`. Demo/build versions
|
|
15
|
+
without a review package are allowed. Unrelated files under `derived/` do not
|
|
16
|
+
select or manufacture a review package. Explicit `--project-version` and
|
|
17
|
+
`--project-draft` retain their strict package joins and never fall back here.
|
|
18
|
+
This form is single-target and accepts no additional inspection options;
|
|
19
|
+
`feedback` and `control` keep their existing selector requirements.
|
|
20
|
+
|
|
21
|
+
The existing single-entry workspace opens the interview in its existing modal.
|
|
22
|
+
Its internal `/api/review` transport uses `subject: "interview"`, an actual
|
|
23
|
+
`project.json` path/hash, source hash, label and availability flags. It carries
|
|
24
|
+
no manifest, compiled model, reviewed-package identity or package session.
|
|
25
|
+
Model-dependent APIs refuse `MODEL_UNAVAILABLE`. Project, retained option sets
|
|
26
|
+
and declared inputs are hash-bound and rechecked; drift refuses
|
|
27
|
+
`INTERVIEW_OPTIONS_STALE`. Opening and reading change no source files.
|
|
28
|
+
The joined dialog and standing record form use one shared list | image | survey
|
|
29
|
+
answer builder. There is no interview Note input. Existing saved or historical
|
|
30
|
+
notes remain readable as read-only text and are carried unchanged. Joined picks
|
|
31
|
+
omit `note` when none exists; the job act retains its required string field.
|
|
32
|
+
Historical records, picks/act/verdict schemas and explicit
|
|
33
|
+
version/draft joins retain their existing readers and checks. This introduces
|
|
34
|
+
no job API, act schema, consumer contract or package-export change; it does not
|
|
35
|
+
replace the active standing review cycle with a picks-file handoff.
|
|
36
|
+
|
|
3
37
|
## Managed owner host
|
|
4
38
|
|
|
5
39
|
`@rig-c/review/job-host` is the installed Bun entry for the full standing owner
|
|
@@ -563,6 +597,43 @@ model binding nor a valid image-set binding uses `JOB_ASK_INVALID`.
|
|
|
563
597
|
|
|
564
598
|
The backend rig-still extension retains the original twelve runtime exports and `JOB_ACT_SCHEMA` at act@2. `JobAct` additionally includes `JobRigReviewAct` at act@3 with top-level `JobRigStill` and `JobPartsVerdictAct` at act@5 (`PartsVerdictValue` with pointed `issues` and `words`, while preserving `JobLegacyPartsVerdictValue` at act@2 for historical acts). The facade adds type-only `JobLegacyAct`, `JobRigReviewAct`, `JobPartsVerdictAct`, `JobLegacyPartsVerdictValue`, `PartsVerdictValue`, `JobPanelComposition`, `PanelComponent`, `JobRigStill` and `JobRigCapture` exports, [Review #563](https://github.com/rig-c/review/issues/563) adds five type-only exports (`JobHostListenerIncarnation`, `JobHostReuseBinding`, `JobHostReuseExpectation`, `JobHostAttachField` and `JobHostAttachFailure`), and [Review #555](https://github.com/rig-c/review/issues/555) adds four type-only interview diagnostic exports (`JobInterviewJson`, `JobInterviewRecord`, `JobInterviewDiagnostic` and `JobInterviewDiagnostics`). [Review #588](https://github.com/rig-c/review/issues/588) activates record mode when `readRecordPublished` and `recordReaderId` are supplied to a host or session (`publicationMode: 'record-and-package'`), serving `rig-review/job-api@3` (`JOB_API_V3_SCHEMA`), `rig-review/act@4` (`JOB_RECORD_ACT_SCHEMA`) and normal owner URL model-free record inspection while keeping default package-only hosts and exact `package-only` `job-ui/<jobId>.json` descriptor bytes at @2 and enforcing `publicationMode` / `recordReaderId` reuse compatibility across ordinary reuse and strict `reuseOnly` attachment. It exports six additional record-mode runtime symbols (`JOB_API_V3_SCHEMA`, `JOB_RECORD_ACT_SCHEMA`, `JOB_RECORD_READER_ID`, `parseRecordAct`, `prepareJobRecordAct` and `prepareJobRecordSource`, for eighteen runtime exports total) and the V3/record type surface listed below. The rig and parts-verdict act revision constants, transport limits and the internal `POST /jobs/<jobId>/host` helper remain internal to their modules. Consumer checks distinguish these act revisions as described in [Rig verdict still backend](REVIEW_PACKAGE.md#rig-verdict-still-backend) and [Model-free record mode and source seam](REVIEW_PACKAGE.md#model-free-record-mode-and-source-seam).
|
|
565
599
|
|
|
600
|
+
The comments decoder extension adds six functions and four schema constants,
|
|
601
|
+
for twenty-eight runtime exports total.
|
|
602
|
+
See [Comments decoder contract](REVIEW_PACKAGE.md#comments-decoder-contract).
|
|
603
|
+
|
|
604
|
+
[Review #714](https://github.com/rig-c/review/issues/714) adds the act@7 decoder
|
|
605
|
+
`parseContextCommentsAct` and its constant `JOB_COMMENT_CONTEXT_ACT_SCHEMA`
|
|
606
|
+
(`rig-review/act@7`), for thirty runtime exports total, plus the type-only
|
|
607
|
+
`JobCommentContext`, `JobContextComment` and `JobContextCommentsAct`. The change
|
|
608
|
+
is additive: `parseCommentsAct`, `JobComment` and `JobCommentsAct` keep their @6
|
|
609
|
+
shapes, and @2–@6 decode unchanged. Review does not emit @7 until Create pins a
|
|
610
|
+
Review version that reads it. See [Comment context (act@7)](REVIEW_PACKAGE.md#comment-context-act7).
|
|
611
|
+
|
|
612
|
+
[Review #713](https://github.com/rig-c/review/issues/713) turns on the act@6
|
|
613
|
+
writers. `JobAct` widens to `JobLegacyAct | JobRigReviewAct | JobPartsVerdictAct |
|
|
614
|
+
JobCommentsAct`, so `JobActV3`, `JobEvent`, `JobEventV3`, `JobNextValue`,
|
|
615
|
+
`JobNextValueV3` and `JobHostPorts.commitUIAct` admit fresh act@6 values. No
|
|
616
|
+
export is added or removed, and `JobComment` is unchanged. Fresh UI checkpoint,
|
|
617
|
+
parts-verdict, rig and direction review-verdict and signoff acts are
|
|
618
|
+
`rig-review/act@6`. Image-review verdicts and interview picks stay at act@2, and
|
|
619
|
+
record acts stay at act@4. Consumers narrow on `schema`. A consumer's
|
|
620
|
+
`Extract<JobAct, {kind: ...}>` alias now also contains the act@6 arm of that
|
|
621
|
+
kind. This changes the type on the consumer's next pin and does not break any
|
|
622
|
+
runtime reader. Historical act@2–@5 bytes keep their readers.
|
|
623
|
+
|
|
624
|
+
[Review #746](https://github.com/rig-c/review/issues/746) adds optional
|
|
625
|
+
`feedback: readonly Feedback[]` to `JobUIActValues['review-verdict']` only when
|
|
626
|
+
`stage` is `rig-review`; `stage`, `verdict` and required `words` remain.
|
|
627
|
+
A present list, including `[]`, supplies the complete comments through the
|
|
628
|
+
existing `feedbackItemComments` mapper and act@6 decoder. It preserves entry
|
|
629
|
+
order, text, IDs, frames, target, category and `anchor.context` (including point,
|
|
630
|
+
crop, bookmark and valid time-only null-frame evidence). `words` is not appended
|
|
631
|
+
as another comment. Without `feedback`, serialized output bytes stay unchanged.
|
|
632
|
+
Direction and image submissions retain their previous closed shapes. The
|
|
633
|
+
written act stays act@6, historical words-only acts still parse, and the
|
|
634
|
+
act@7 top-level `comment.context` emission gate remains off. There are no new
|
|
635
|
+
exports or schemas. See [Comments decoder contract](REVIEW_PACKAGE.md#comments-decoder-contract).
|
|
636
|
+
|
|
566
637
|
The exact runtime exports are listed below. Constants preserve their literal
|
|
567
638
|
values from the frozen semantic contract.
|
|
568
639
|
|
|
@@ -572,6 +643,18 @@ values from the frozen semantic contract.
|
|
|
572
643
|
- `parseRecordAct`
|
|
573
644
|
- `prepareJobRecordAct`
|
|
574
645
|
- `prepareJobRecordSource`
|
|
646
|
+
- `parseCommentsAct`
|
|
647
|
+
- `parseContextCommentsAct`
|
|
648
|
+
- `projectComments`
|
|
649
|
+
- `parseCommentsSession`
|
|
650
|
+
- `parseCommentsCompareSession`
|
|
651
|
+
- `parseCommentsPartsVerdict`
|
|
652
|
+
- `projectSelectedCommentsFeedback`
|
|
653
|
+
- `JOB_COMMENTS_ACT_SCHEMA`
|
|
654
|
+
- `JOB_COMMENT_CONTEXT_ACT_SCHEMA`
|
|
655
|
+
- `REVIEW_COMMENTS_SESSION_SCHEMA`
|
|
656
|
+
- `REVIEW_COMMENTS_COMPARE_SESSION_SCHEMA`
|
|
657
|
+
- `PARTS_COMMENTS_VERDICT_SCHEMA`
|
|
575
658
|
- `JOB_CAPABILITIES`
|
|
576
659
|
- `JOB_API_SCHEMA`
|
|
577
660
|
- `JOB_API_V3_SCHEMA`
|
|
@@ -734,6 +817,19 @@ without aliases or copied wire shapes.
|
|
|
734
817
|
- `JobRetainedSource`
|
|
735
818
|
- `JobRetainedSourceV3`
|
|
736
819
|
- `JobRootIdentity`
|
|
820
|
+
- `JobComment`
|
|
821
|
+
- `JobCommentAnchor`
|
|
822
|
+
- `JobCommentFeedbackAnchor`
|
|
823
|
+
- `JobCommentPartsAnchor`
|
|
824
|
+
- `JobCommentImageAnchor`
|
|
825
|
+
- `JobCommentsAct`
|
|
826
|
+
- `JobCommentsActValues`
|
|
827
|
+
- `JobCommentContext`
|
|
828
|
+
- `JobContextComment`
|
|
829
|
+
- `JobContextCommentsAct`
|
|
830
|
+
- `ReviewCommentsSession`
|
|
831
|
+
- `CompareCommentsSession`
|
|
832
|
+
- `PartsCommentsVerdict`
|
|
737
833
|
|
|
738
834
|
## Parts enumeration boundary
|
|
739
835
|
|
|
@@ -746,11 +842,11 @@ Rows are capped at 4096, roles at 128 UTF-16 code units and literal paths at 409
|
|
|
746
842
|
## Installed acceptance
|
|
747
843
|
|
|
748
844
|
`bun run smoke` packs the package and installs that tarball into an empty project.
|
|
749
|
-
A consumer
|
|
845
|
+
A consumer checks the thirty runtime exports and every listed type, including
|
|
750
846
|
`JobHostListenerIncarnation`, `JobHostReuseBinding`, `JobHostReuseExpectation`,
|
|
751
847
|
`JobHostAttachField`, `JobHostAttachFailure`, `JobInterviewJson`,
|
|
752
848
|
`JobInterviewRecord`, `JobInterviewDiagnostic`, `JobInterviewDiagnostics` and
|
|
753
|
-
the record-mode `JobRecordAct` / `JobActV3` / `JobPlanSource` /
|
|
849
|
+
the comments decoder types and the record-mode `JobRecordAct` / `JobActV3` / `JobPlanSource` /
|
|
754
850
|
`JobFetchActRequestV3` / `JobRecordHostHooks` surface, through `@rig-c/review/job-host`.
|
|
755
851
|
TypeScript checks the installed consumer and the runtime checks the full owner
|
|
756
852
|
resources, retained publication, semantic ports, declared hooks, enumerator
|
package/docs/WORKFLOWS.md
CHANGED
|
@@ -501,7 +501,7 @@ On the view you are inspecting, choose **Comment · C (n)**, drag over the detai
|
|
|
501
501
|
|
|
502
502
|
The four-stage navigator preserves this entry and its explicit save behavior. Compiled sessions reuse the atlas surface read-only; see [Four inspection stages](PANELS.md#four-inspection-stages).
|
|
503
503
|
|
|
504
|
-
The managed front forwards
|
|
504
|
+
The managed front forwards a query only to the landing page; every other route refuses one. Stage navigation never changes CLI arguments or package bindings.
|
|
505
505
|
|
|
506
506
|
## Embedded semantic jobs
|
|
507
507
|
|
|
@@ -715,6 +715,38 @@ to the joined command. The post must explicitly name the selected
|
|
|
715
715
|
printed feedback command, including the project, rig, post and picks arguments,
|
|
716
716
|
to export from that session.
|
|
717
717
|
|
|
718
|
+
### Open an interview before a draft or review package exists
|
|
719
|
+
|
|
720
|
+
Create the dedicated picks output directory first, then open the same project
|
|
721
|
+
root in both operand positions:
|
|
722
|
+
|
|
723
|
+
```sh
|
|
724
|
+
mkdir -p /path/to/project/scratch/review-picks
|
|
725
|
+
rig-review open /path/to/project \
|
|
726
|
+
--project /path/to/project --picks-dir scratch/review-picks
|
|
727
|
+
```
|
|
728
|
+
|
|
729
|
+
This form is limited to the interview stage with no recorded draft and no
|
|
730
|
+
non-null `versions[].review_package`. Versions containing only demo/build
|
|
731
|
+
records are permitted, as is unrelated derived evidence. A `derived/` directory
|
|
732
|
+
is not required. Explicit version/draft selectors never fall back to this form.
|
|
733
|
+
Both roots must resolve to the same project; the dedicated picks directory must
|
|
734
|
+
exist and not overlap an input. Other inspection flags and multiple targets
|
|
735
|
+
are refused for this form. `feedback` and `control` retain their existing syntax.
|
|
736
|
+
|
|
737
|
+
The interview opens and closes as a modal over the existing Review workspace.
|
|
738
|
+
The workspace reports model-dependent sections as `MODEL_UNAVAILABLE` and
|
|
739
|
+
creates no model, review package or package session. Reads preserve project and
|
|
740
|
+
input bytes. Changed project, option or source bytes require reopening, with
|
|
741
|
+
`INTERVIEW_OPTIONS_STALE`. Interview choices and inline Other text use the same list | image | survey
|
|
742
|
+
answer builder as the standing record dialog. There is no interview Note input;
|
|
743
|
+
existing saved or historical notes remain readable as read-only text and are
|
|
744
|
+
carried unchanged. Joined picks omit `note` when absent; job acts retain their
|
|
745
|
+
required string field. Historical records remain readable and the
|
|
746
|
+
picks-file schema is unchanged. The active standing live-job cycle above
|
|
747
|
+
still uses semantic acts and the trusted consumer; this inspection form does
|
|
748
|
+
not authorize an agent to manufacture or carry picks files.
|
|
749
|
+
|
|
718
750
|
### Open a recorded draft before rig review
|
|
719
751
|
|
|
720
752
|
In the active standing live-job cycle ([Standing live job workflow](#standing-live-job-workflow), [Create #182](https://github.com/rig-c/create/issues/182), [Create #184](https://github.com/rig-c/create/issues/184)), draft parts and mesh verdicts are submitted as `parts-verdict` acts over the semantic job API and fetched directly by the Create writer. The `--picks-dir`, `--parts-verdict-dir` and `--picks-file` commands below are preserved as legacy/history one-shot handoffs and are bypass findings if used in the active cycle.
|
|
@@ -741,15 +773,8 @@ package is unavailable. Reopen with a rig version once Create records one.
|
|
|
741
773
|
|
|
742
774
|
When the recorded draft entry includes `config`, `parts`, `rig` and `check` directories and the draft is editable (`parts` or `parts-review` stage without an effective `parts-review` sign-off, and not `--view-only`), **1 Parts + mesh** also offers the Chest regions, Mesh parameters and Edit Mesh instruments for mesh-bearing parts regardless of whether `--parts-verdict-dir` is supplied. Selecting an instrument opens the Setup inspector for that part while direct selection of **3 Rig + animation** remains refused with `RIG_VERSION_UNAVAILABLE`. Apply runs the installed producer and compiler in scratch under the existing discovery and operation-capability floors while keeping the recorded draft producer as provenance, and returning to **1 Parts + mesh** or running Undo or Reset updates the displayed mesh and report readings from the active build (verdict saving remains read-only on scratch builds and when `--parts-verdict-dir` is omitted).
|
|
743
775
|
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
```sh
|
|
748
|
-
mkdir -p scratch/review-picks
|
|
749
|
-
rig-review interview . --picks-dir scratch/review-picks
|
|
750
|
-
```
|
|
751
|
-
|
|
752
|
-
Open the printed loopback URL. Select a question and inspect its bound parts
|
|
776
|
+
The interview opens over the review screen of a joined workspace (the `open`
|
|
777
|
+
command above with `--picks-dir`): choose **2 Interview**. Select a question and inspect its bound parts
|
|
753
778
|
or source image. A direction set that binds only source inputs displays those
|
|
754
779
|
inputs with the no-bound-parts notice. Each recommendation shows the retained
|
|
755
780
|
reason and author/date. Choose an option for every prompt and save explicitly.
|
|
@@ -758,8 +783,11 @@ offered and picked. Auto stays pending until create has a covered agent
|
|
|
758
783
|
decision. Historical choice sets are read-only.
|
|
759
784
|
|
|
760
785
|
Each saved set has its own `<raw-set-sha256>.json` in the designated directory.
|
|
761
|
-
Reopening restores picks
|
|
762
|
-
|
|
786
|
+
Reopening restores picks for the same retained set. Existing records keep their
|
|
787
|
+
original note field byte-for-byte, displayed as read-only text. The survey has
|
|
788
|
+
no Note input. A saved note takes precedence over a historical note, including
|
|
789
|
+
an empty saved string; when neither exists, the picks record omits `note`.
|
|
790
|
+
A new set starts without selections. The directory must exist inside the project and be
|
|
763
791
|
separate from every bound input. A stale context, forged selection or
|
|
764
792
|
superseded set is refused. Review writes only `rig-review/interview-picks@1`
|
|
765
793
|
files. To ingest a file, run create separately from the project root:
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "rig-review",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.13.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "Local human rig inspection and structured feedback export",
|
|
6
6
|
"license": "MIT",
|
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
"check:demo": "bun run check -- examples/demo/review.json",
|
|
11
11
|
"demo": "bun src/entry.ts examples/demo/review.json --view-only",
|
|
12
12
|
"check:readme": "bun scripts/check-readme.ts",
|
|
13
|
+
"check:screen-copies": "bun scripts/screen-copies.ts",
|
|
13
14
|
"typecheck": "tsc --noEmit",
|
|
14
15
|
"test": "bun test",
|
|
15
16
|
"build": "bun src/build.ts",
|
|
@@ -10,6 +10,35 @@ compatibility: Requires Bun 1.3.0 or later on PATH. The canonical npm package is
|
|
|
10
10
|
Use this to hand separated parts, a rig or a post to a person for inspection,
|
|
11
11
|
or to read back their submitted review.
|
|
12
12
|
|
|
13
|
+
### Interview-stage project without a package
|
|
14
|
+
|
|
15
|
+
When the designated project is at the interview stage and has neither a
|
|
16
|
+
recorded draft nor a non-null `versions[].review_package`, the approved
|
|
17
|
+
single-target form is:
|
|
18
|
+
|
|
19
|
+
```sh
|
|
20
|
+
rig-review open /path/to/project --project /path/to/project --picks-dir scratch/review-picks
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
The picks directory must already exist and be disjoint from declared inputs.
|
|
24
|
+
Both root operands must resolve to the same project. Demo/build version records
|
|
25
|
+
and unrelated derived evidence are allowed; `derived/` may be absent. Explicit
|
|
26
|
+
version/draft selectors stay strict and never fall back. This form takes no
|
|
27
|
+
additional inspection flags and adds no `feedback` or `control` grammar.
|
|
28
|
+
|
|
29
|
+
The existing Review workspace hosts the interview in its existing modal.
|
|
30
|
+
Model-dependent capabilities are named unavailable (`MODEL_UNAVAILABLE`); no
|
|
31
|
+
manifest, model or package session is synthesized. Project, option-set and input
|
|
32
|
+
hashes bind the inspection, and changed bytes require reopening
|
|
33
|
+
(`INTERVIEW_OPTIONS_STALE`). The joined dialog and standing record form use one shared list | image | survey
|
|
34
|
+
answer builder. There is no interview Note input. Existing saved or historical
|
|
35
|
+
notes remain readable as read-only text and are carried unchanged. Joined picks
|
|
36
|
+
omit `note` when none exists; the job act retains its required string field.
|
|
37
|
+
Historical records, picks/act/verdict schemas and explicit
|
|
38
|
+
version/draft joins retain their existing readers and checks. Use the
|
|
39
|
+
semantic standing cycle for active consumer ingestion; do not construct or
|
|
40
|
+
carry picks files to bypass it. See [project opening stability](https://github.com/rig-c/review/blob/main/docs/STABILITY.md#interview-stage-project-opening).
|
|
41
|
+
|
|
13
42
|
## Open one owner workspace
|
|
14
43
|
|
|
15
44
|
For folder inspections, use **N rigs → one invocation, one owner link**.
|
|
@@ -174,7 +203,6 @@ The stage buttons navigate within that source binding.
|
|
|
174
203
|
standalone inspection and named limits on direct correction.
|
|
175
204
|
2. **Interview.** In the joined draft workspace choose **2 Interview**. For
|
|
176
205
|
choices bound to a recorded rig, open its package with the Stage 3 command.
|
|
177
|
-
The standalone entry is `rig-review interview <project> --picks-dir <picks-dir>`.
|
|
178
206
|
Beside the bound parts or source image, the person chooses among the saved
|
|
179
207
|
options with the agent's recommendation and rationale, then uses
|
|
180
208
|
**Save explicit picks**. Read the `rig-review/interview-picks@1` file for the
|
package/src/build.ts
CHANGED
|
@@ -6,9 +6,17 @@ export function playBuildConditions(root:string=appRoot):string[] {
|
|
|
6
6
|
try{return /[\\/]src[\\/]index\.ts$/.test(Bun.resolveSync('@rig-c/play',root))?[PLAY_SOURCE_CONDITION]:[];}
|
|
7
7
|
catch{return [];}
|
|
8
8
|
}
|
|
9
|
-
|
|
9
|
+
/** #706: the one entry (`web/index.html`) marked for a screen that opens in Setup with the parts mode only. The marker
|
|
10
|
+
* and asset names are trusted constants; no request or package data is interpolated. */
|
|
11
|
+
export async function setupEntryHtml(screen:'parts'|'stage-parts',assets:{script:string;styles:string}={script:'main.js',styles:'styles.css'},root:string=appRoot):Promise<string> {
|
|
12
|
+
const html=await Bun.file(join(root,'web/index.html')).text();
|
|
13
|
+
const marked=html.replace('<div id="app"></div>',`<div id="app" data-review-screen="${screen}"></div>`).replace('href="styles.css"',`href="${assets.styles}"`).replace('src="main.js"',`src="${assets.script}"`);
|
|
14
|
+
if(marked===html||!marked.includes(`data-review-screen="${screen}"`))throw new Error('SETUP_ENTRY_MARKER_MISSING');
|
|
15
|
+
return marked;
|
|
16
|
+
}
|
|
17
|
+
export async function buildWeb(mode:'single'|'compare'|'parts'|'workspace'|'job-hub'='single',root:string=appRoot):Promise<Blob> {
|
|
10
18
|
const conditions=playBuildConditions(root);
|
|
11
|
-
const entry=join(root,mode==='job-hub'?'web/job-hub.ts':mode==='workspace'?'web/owner-workspace.ts':mode==='compare'?'web/compare.ts':
|
|
19
|
+
const entry=join(root,mode==='job-hub'?'web/job-hub.ts':mode==='workspace'?'web/owner-workspace.ts':mode==='compare'?'web/compare.ts':'web/main.ts');
|
|
12
20
|
const result=await Bun.build({entrypoints:[entry],target:'browser',format:'esm',minify:false,...(conditions.length?{conditions}:{})});
|
|
13
21
|
if(!result.success)throw new Error(result.logs.map(v=>v.message).join('\n'));
|
|
14
22
|
const output=result.outputs.find(v=>v.path.endsWith('.js'));if(!output)throw new Error('frontend bundle: JavaScript output missing');return output;
|