Skip to content

chore: resolve runtime-v1 lockfile conflict and refresh AGENTS.md spec#28

Merged
joshunrau merged 1 commit into
mainfrom
chore/update-runtime-v1-and-agents-doc
Jun 1, 2026
Merged

chore: resolve runtime-v1 lockfile conflict and refresh AGENTS.md spec#28
joshunrau merged 1 commit into
mainfrom
chore/update-runtime-v1-and-agents-doc

Conversation

@gdevenyi

@gdevenyi gdevenyi commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Fix broken lockfile: pnpm-lock.yaml had unresolved git merge-conflict markers (committed in 1fe3d72), leaving @opendatacapture/runtime-v1 / serve-instrument unresolvable and pnpm install unable to run cleanly. Regenerated the lockfile, pinning the latest published versions (runtime-v1 1.8.11, serve-instrument 0.0.12). package.json already specified these; no manifest change was needed.
  • Refresh AGENTS.md spec to match the actual runtime-v1 @ 1.8.11 type surface (sourced from runtime-core's index.d.ts). Note: @opendatacapture/runtime-core and @opendatacapture/schemas are not standalone npm packages — they are bundled and served by runtime-v1, which is the only version lever.

AGENTS.md changes

  • New FILE instrument kind (new §1.3.3 with fileGroups / FileType / FILE_TYPES); InstrumentKind updated to 4 kinds.
  • __runtimeVersion (auto-set) and optional id on BaseInstrument.
  • String password variant (calculateStrength) + placeholder; NumberField input min/max marked deprecated (use validationSchema).
  • record-array disableAutoSuffix, number-record disableAutoPrefix; initialValues is PartialDeep<TData>.
  • Interactive content: defaultFullscreen, enableLanguageSelect/Toggle/Lock, __injectHead.
  • Series content may be { items, params: { skipProgress } }.
  • Measures: hidden deprecated → visibility; computed value returns InstrumentMeasureValue.
  • details.estimatedDuration/instructions deprecated → clientDetails; license typed as SPDX LicenseIdentifier.
  • Documented Zod v3/v4 support and runtime helpers (addNotification, Translators, asSnakeCase).

Test plan

  • pnpm install → clean lockfile, 0 conflict markers, resolves runtime-v1 1.8.11 / serve-instrument 0.0.12.
  • pnpm lint (tsc && eslint --fix lib) → passes; all instruments type-check against the pinned 1.8.11 types.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added FILE instrument type to the instrument system.
    • Enhanced form field specifications with placeholder text and password variant options.
    • Interactive instruments now support fullscreen mode and language UI controls.
    • New runtime helpers available for notifications, translations, and utility functions.
    • Deprecated legacy hidden property in favor of visibility for measures.

pnpm-lock.yaml contained unresolved git merge-conflict markers (committed in
1fe3d72), leaving runtime-v1/serve-instrument unresolvable. Regenerated the
lockfile cleanly, pinning the latest published versions (runtime-v1 1.8.11,
serve-instrument 0.0.12).

Refreshed the AGENTS.md instrument specification to match the runtime-v1
@ 1.8.11 type surface (sourced from runtime-core's index.d.ts):
- new FILE instrument kind; __runtimeVersion / id on BaseInstrument
- string `password` variant + `placeholder`; deprecated number input min/max
- record-array `disableAutoSuffix`, number-record `disableAutoPrefix`
- PartialDeep initialValues
- interactive content: defaultFullscreen, enableLanguage*, __injectHead
- series content { items, params: { skipProgress } }
- measures: `hidden` deprecated -> `visibility`; InstrumentMeasureValue
- deprecated details.estimatedDuration/instructions; SPDX LicenseIdentifier
- zod v3/v4 support; runtime helpers (addNotification, Translators, asSnakeCase)

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings June 1, 2026 17:59
@joshunrau joshunrau merged commit b74a6fc into main Jun 1, 2026
1 of 3 checks passed
@coderabbitai

coderabbitai Bot commented Jun 1, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 6621876c-4442-4cde-9ad2-f5a3a0012957

📥 Commits

Reviewing files that changed from the base of the PR and between 9ad8de5 and 165e44a.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (1)
  • AGENTS.md

Walkthrough

This PR updates the AGENTS.md specification document to expand the instrument type system, refine type contracts across measures and form fields, enhance interactive instrument capabilities with UI options, and document new runtime helper APIs.

Changes

Instruments Specification Expansion

Layer / File(s) Summary
Core type system expansion
AGENTS.md
InstrumentKind expanded to include FILE; InstrumentDetails.license narrowed to LicenseIdentifier; base instruments now declare injected __runtimeVersion and optional id for scalars.
Measure typing and visibility model
AGENTS.md
InstrumentMeasureValue union type introduced; ComputedInstrumentMeasure.value changes from unknown to typed union; hidden property deprecated in favor of visibility for both computed and constant measures.
Series instrument content generalization
AGENTS.md
SeriesInstrument.content now supports either direct identity array or wrapped form with optional series-level params such as skipProgress.
Form field specifications and authoring options
AGENTS.md
String fields gain placeholder and password variant with optional strength calculation; number fields' min/max deprecated in favor of validationSchema; composite fields gain disableAutoSuffix and disableAutoPrefix controls; FormInstrument.initialValues change to deep partial for nested property seeding.
Interactive instrument content enhancements
AGENTS.md
Interactive content schema expanded with defaultFullscreen flag and language UI controls; __injectHead strengthened to explicit shape with scripts and style properties; defineInstrument usage clarified for all scalar kinds including FILE.
Runtime helpers documentation
AGENTS.md
New Runtime Helpers section documents available APIs within interactive render: addNotification, Translator for multilingual workflows, and asSnakeCase utility.

🎯 2 (Simple) | ⏱️ ~10 minutes


📋 A spec grows richer still,
With types more tight and fields with skill,
FILE joins the fold, helpers dance,
Measures type, and forms advance!
Runtime whispers, interactive plays— ✨

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/update-runtime-v1-and-agents-doc

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@joshunrau joshunrau deleted the chore/update-runtime-v1-and-agents-doc branch June 4, 2026 18:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants