status

Read-only authorized deployment status

Install

docsloth component add @docsloth/status@1.0.0

Live package: sha256:595525426f7f977b02bf449134768f228d474d11b24e99f41e0c408d0f8ad34d with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

Props

The prop schema is normative in packages/contracts/component-props/status.schema.json.

Example props generated from this schema:

{
  "title": "example-title",
  "resource": {
    "resource_id": "00000000-0000-4000-8000-000000000000",
    "operation": "example-operation",
    "environment": "test"
  },
  "service_ids": [
    "example-service_ids"
  ],
  "refresh_seconds": 30
}

Required props: resource, service_ids, refresh_seconds.

Example

Example document IR (the block the renderer consumes):

{
  "type": "status",
  "props": {
    "title": "example-title",
    "resource": {
      "resource_id": "00000000-0000-4000-8000-000000000000",
      "operation": "example-operation",
      "environment": "test"
    },
    "service_ids": [
      "example-service_ids"
    ],
    "refresh_seconds": 30
  }
}

Renderer HTML (entities decoded and wrapped for display):

<section class="ds-block ds-status" data-component="status" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<dl class="ds-facts">
<div>
<dt>Services</dt>
<dd>
<code>example-service_ids</code>
</dd>
</div>
<div>
<dt>Refresh interval</dt>
<dd>30 s</dd>
</div>
<div>
<dt>Runs</dt>
<dd>
<code>example-operation</code> in the test environment</dd>
</div>
</dl>
<p class="ds-live-note" role="note">Current status is not part of this page; check the live documentation site.</p>
</section>

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

Specification

Generated from packages/contracts/component-specs/status.md.

Contract

Production props are normative in ../contracts/component-props/status.schema.json. The corresponding component-fixtures manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated component-package.json manifest plus props.schema.json (the production props schema, copied byte-for-byte) and spec.md (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

Intended behavior

Read status timestamp and coverage; no claim software healthy merely docs host up.

Failure and fallback

Last known value marked stale after two refresh intervals.

The React host supplies ComponentContentProvider.statusQueries keyed by statusQueryKey(resource, service_ids, refresh_seconds). Keys sort the selected service IDs; display order follows the production props. The binding and result match release, actor session, resource operation/environment, selected services, refresh interval and query version. Up to 100 unique bounded service IDs are accepted. Snapshots carry explicit coverage, capture time and bounded individual service observations (operational, degraded, outage, unknown) with their own check timestamps. Missing services remain uncovered/unknown; complete coverage cannot omit services. Extra or duplicate services refuse. Text is escaped, bounded to 65,536 aggregate code units, and arbitrary fields discarded.

No-JavaScript output labels values as last reported and freshness unchecked. After hydration a local clock marks each observation stale at exactly twice refresh_seconds, measured from that observation's check time. A timestamp ahead of the client clock is unverified. The clock does not poll the network. Refresh is an explicit manual action; scheduled refresh, if desired, belongs to an authorized host with its own per-call budget and cancellation policy.

Only a typed matching snapshot can confirm a refresh. A successful HTTP response, executor stdout or a reachable documentation host cannot establish software health. Failed, unsupported, rate-limited and cancelled refreshes preserve last-known values as unverified until a valid result, including during retries. Denial clears them. Scope or supplied snapshot changes reset the view; late replies after cancellation or replacement are ignored. The host must authorize before delivery and independently observe service health. The component does not implement production transport, health probes, model calls or persistence.

Required acceptance cases

Network failure never renders green success. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

Package manifest

Protocol fixture: packages/contracts/component-fixtures/status.json.

Sources