com.emdashcms.experimental.package.release
A specific versioned release of a plugin package. The record key encodes both the parent package's slug and the version, separated by ':'. A release's AT URI looks like at://did:plc:abc123/com.emdashcms.experimental.package.release/gallery-plugin:1.2.0. A release at a given version cannot be modified or replaced once published.
Details · record, key any
| Kind | record |
|---|---|
| Record key | any |
| Authority | package.experimental.emdashcms.com |
| Indexed |
Record
record · key anyProperties
Map of artifact type to artifact object. MUST have at least one entry. The 'package' entry (installable bundle) is required.
auth
unionAuthentication requirements for gated artifacts. No authentication variants are currently defined.
extensions
unknownOpen-union container for extension data, keyed by NSID. Each value is an embedded record carrying its own $type discriminator. Releases of type emdash-plugin MUST include a com.emdashcms.experimental.package.releaseExtension entry here.
Slug of the parent package profile in the same repository. MUST match the rkey of an existing package profile record. Combined with the publisher DID, the parent profile's AT URI is at://<publisher-did>/com.emdashcms.experimental.package.profile/<package>. Aggregators MUST reject release records whose package field does not resolve to a profile in the same repository.
minLength: 1maxLength: 64
provides
unknownCapabilities the package provides. Map of capability type to string or list of strings.
repo
string · uriAT URI or HTTPS URL of the source repository for this release.
maxLength: 1024
requires
unknownDependencies. Map of 'env:*' keys (extension-defined environment requirements) or package DIDs to version constraint strings. EmDash uses 'env:emdash' and 'env:astro'.
suggests
unknownOptional packages that may be installed alongside. Same shape as requires.
Version, conforming to a subset of semver 2.0 (build metadata '+...' is disallowed because atproto record keys cannot represent it). MUST equal the post-':' portion of the rkey byte-for-byte. Composed only of characters allowed in atproto record keys: ASCII letters, digits, '.', and '-'. Note that while atproto rkeys also permit '_' and '~', semver disallows them in version strings, so they MUST NOT appear here.
minLength: 1maxLength: 64
#artifact
objectThe installable plugin bundle artifact.
Properties
blob
blobArtifact bytes stored as a blob in the publisher's PDS.
maxSize: 262144accept: application/gzip
Lowercase base32 multibase-encoded sha2-256 multihash of the artifact bytes (multihash code 0x12). EmDash clients reject unsupported hash functions rather than skipping verification.
maxLength: 256
contentType
stringMIME type of the artifact, per RFC6838.
maxLength: 256
height
integerPixel height, for image artifacts.
minimum: 1maximum: 8192
id
stringUnique ID within the artifact type.
maxLength: 128
lang
string · languageBCP 47 language tag for localised artifacts (icon, screenshot).
releaseAsset
booleanWhether the URL points to a platform release asset rather than a directly-served file. When true, clients MUST send 'Accept: application/octet-stream' when downloading.
requiresAuth
booleanWhether the artifact requires authentication to access.
signature
stringOptional cryptographic signature of the artifact. EmDash clients do not require it because integrity is proven through the atproto MST signature over the record's checksum.
maxLength: 1024
url
string · uriURL where the artifact can be downloaded.
maxLength: 2048
width
integerPixel width, for image artifacts (icon, screenshot, banner).
minimum: 1maximum: 8192
#artifacts
objectMap of artifact-type-name to artifact. Common artifact-type keys are 'package' (the installable bundle, REQUIRED), 'icon', 'screenshots' (a list), and 'banner'. Custom types use an 'x-' prefix and pass through as unrecognised fields.
Properties
banner
reficon
refscreenshots
arrayOrdered screenshot gallery for the plugin's detail page.
maxLength: 8
#imageArtifact
objectA raster image artifact for a plugin listing.
Properties
blob
blobImage bytes stored as a blob in the publisher's PDS.
maxSize: 1048576accept: image/png, image/jpeg, image/webp
Lowercase base32 multibase-encoded sha2-256 multihash of the artifact bytes (multihash code 0x12). EmDash clients reject unsupported hash functions rather than skipping verification.
maxLength: 256
contentType
stringMIME type of the artifact, per RFC6838.
maxLength: 256
height
integerPixel height.
minimum: 1maximum: 8192
id
stringUnique ID within the artifact type.
maxLength: 128
lang
string · languageBCP 47 language tag for a localised artifact.
releaseAsset
booleanWhether the URL points to a platform release asset rather than a directly-served file. When true, clients MUST send 'Accept: application/octet-stream' when downloading.
requiresAuth
booleanWhether the artifact requires authentication to access.
signature
stringOptional cryptographic signature of the artifact. EmDash clients do not require it because integrity is proven through the atproto MST signature over the record's checksum.
maxLength: 1024
url
string · uriURL where the artifact can be downloaded.
maxLength: 2048
width
integerPixel width.
minimum: 1maximum: 8192
#sbom
objectSoftware bill of materials reference. EmDash plugins SHOULD include sbom for CRA-readiness; clients MUST NOT refuse install solely because sbom is absent.
Similar lexicons
semantic matchLexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.
-
at.happyproto.plugin.release
recordOne version of a package. The record key is '<slug>:<version>'. A release at a given version is never modified: a registry that later sees a different CID at this key keeps the first and flags the conflict.
-
Plugin package profile record. EXPERIMENTAL: this NSID is part of the experimental phase of the EmDash plugin registry. The stable namespace target is com.emdashcms.package.profile.
-
Shared definitions for the EmDash plugin registry aggregator XRPC endpoints. EXPERIMENTAL: shape may change before stabilisation.
-
at.happyproto.plugin.v1
objectA HappyView plugin, as one entry in a software.release.manifest's `artifacts`. It carries the module and its manifest.json as blobs, so they are verified by their CIDs, and the manifest's facts in the signed record, so a consent screen renders without downloading the module. Those facts are not trusted: the loader checks them against the module itself and refuses a plugin that misstates what it does. The registry refuses a manifest whose artifact breaks a rule stated here, including the ones a l
-
io.agent.release
recordA record representing a software release.