Normative plugin contracts, schemas, test vectors, and conformance material for CordisX interoperability. Contracts specify portable behavior independently of the current Host implementation and Codex DOM adapter.
| Start here | Purpose |
|---|---|
| Specification topics | Normative behavior, compatibility, and topic version navigation |
| TypeScript entrypoints | Exact public imports and their declarations, including reused wire versions |
| Schemas | Machine-readable document formats |
| Conformance and test vectors | Protocol validation and examples |
These links also work for readers of the installed package README. They open
repository main; select the tag or commit matching a pinned dependency when
checking its exact contract. Package publication and Host support are separate
from a contract's presence in this repository.
Manager Settings navigation groups v1 defines the Host-owned resources,
development, collaboration, and fallback other sections for structured
top-level Manager destinations. Surface contribution v9 lets an item reference
one group without supplying labels, layout, or DOM; Host extension-point catalog
v9 publishes the authoritative labels and order. See
.agents/docs/manager-settings-navigation/groups-v1.md.
The v2 public entrypoint adds exact surface-v9 versus legacy-unversioned
provenance for ctx.slots.register and Host diagnostics.
Host-owned Plugins and Plugin Store destinations remain Host information
architecture rather than Protocol identities. Explicit plugin business
navigation contributions remain independent lifecycle-owned entries, and a
bundle never creates one implicitly.
Read AGENTS.md and the maintenance rules for document ownership and synchronized protocol changes. Repository publishing steps live in the release runbook; dated adoption notes retain historical integration guidance separately from the specifications.
Run npm ci && npm run check to validate types, schemas, and conformance vectors.
The release runbook
links the separate distribution and registry checks.
Visuals v1 defines owner-local provider ids and a framework-neutral projection
of detached, deeply immutable JSON data plus the effective light/dark theme.
It participates in the existing plugin generation transaction and defines no
second lifecycle or renderer wire format. See the
Visuals specification.
The raster-image specification
defines bounded PNG snapshots after product-specific composition, without
passing product semantics or renderer authority to the receiving surface.
The brand-icon specification
keeps host:* icons intact while allowing those snapshots in a structured,
runtime-validated page icon value.
The plugin generation artifact specification defines a path-confined browser ESM graph with per-file integrity, relative chunks, styles and static assets, closed shared Host imports, demand-loading, and generation-owned cleanup while retaining the legacy single-module form.
The Marketplace specification indexes the versioned discovery contracts, compatible feed formats, trust extensions, and conformance material.
This repository is licensed under the GNU Affero General Public License,
version 3 or any later version (AGPL-3.0-or-later), with the
CordisX Independent Plugin Exception
as an additional permission under AGPLv3 section 7.
The versioned plugin-facing schemas and declarations in this repository are Public Stable Plugin Interfaces and Interface Material under that Exception. An independent plugin that uses only those interfaces may be commercial, charged for, distributed through a marketplace, and licensed under terms chosen by its author. The Exception does not permit copying CordisX host code, building a substitute host from CordisX code, or using private interfaces outside the AGPL.
The CordisX-specific Exception is not a standard SPDX exception and has not been reviewed or approved by the Open Source Initiative or the Free Software Foundation. Legal review is recommended before the first stable release.
See CONTRIBUTING.md before submitting protocol material.