com.emdashcms.experimental.package.profile
A plugin package profile, identifying the package and carrying metadata that does not change between releases. Each release belongs to exactly one profile in the same publisher's repo. The record key is the package slug.
Details · record, key any
| Kind | record |
|---|---|
| Record key | any |
| Authority | package.experimental.emdashcms.com |
| Indexed |
Record
record · key anyProperties
At least one author. Vendors SHOULD specify at least one of url or email per author.
minLength: 1maxLength: 32
description
stringShort description of the package. SHOULD NOT exceed 140 characters per FAIR convention.
maxLength: 1024maxGraphemes: 140
extensions
unknownOpaque extension container keyed by NSID. The base profile Lexicon does not validate entries; consumers dispatch known entries to their embedded extension schemas. EmDash delegated-release policy uses com.emdashcms.experimental.package.profileExtension here.
Canonical AT URI of this profile record. Derived from the record's location at publish time; not authored by the publisher. Aggregators MUST reject records whose id does not match the AT URI they were fetched from. Mirrors FAIR's id-must-match-the-resolved-identifier rule.
keywords
arraySearch keywords. SHOULD NOT exceed 5 items per FAIR convention.
maxLength: 5
maxLength: 128maxGraphemes: 64
lastUpdated
string · datetimeISO 8601 datetime for the package's last update.
SPDX license expression, or the literal 'proprietary'. Clients SHOULD refuse to install packages without a valid license.
maxLength: 256
name
stringHuman-readable name for the package, displayed in directory listings.
maxLength: 1024maxGraphemes: 100
sections
refMap of human-readable text sections (description, installation, faq, changelog, security). CommonMark Markdown. Each value capped at 20000 bytes / 2000 graphemes.
At least one security contact. Vendors SHOULD specify at least one of url or email per contact. Clients SHOULD refuse to install packages without at least one valid security contact.
minLength: 1maxLength: 8
slug
stringURL-safe slug. ASCII letter followed by ASCII letters, digits, '-', or '_'. If present, MUST equal the record key. If absent, clients use the rkey as the display slug. Aggregators MUST reject records where slug is present and disagrees with the rkey.
minLength: 1maxLength: 64
Package type from FAIR's type registry. EmDash plugins use 'emdash-plugin'. Custom types use the 'x-' prefix.
maxLength: 64knownValues: emdash-plugin
#author
objectFAIR Metadata Document authors[] item. Authors SHOULD include at least one of url or email so users can identify the publisher behind the package; clients render absent contact information as 'unknown'.
#contact
objectFAIR Metadata Document security[] item. At least one of url or email MUST be present; Lexicon cannot express required-one-of, so aggregators MUST validate this and reject records carrying a contact with neither field.
#sections
objectFree-form map keyed by section name (FAIR-recognised: description, installation, faq, changelog, security). Each value is CommonMark Markdown capped at 20000 bytes / 2000 graphemes. Clients sanitise rendered output. Lexicon cannot type arbitrary keys; unrecognised sections pass through verbatim and renderers display them with the section key as heading.
Properties
changelog
stringmaxLength: 20000maxGraphemes: 2000
description
stringmaxLength: 20000maxGraphemes: 2000
faq
stringmaxLength: 20000maxGraphemes: 2000
installation
stringmaxLength: 20000maxGraphemes: 2000
security
stringmaxLength: 20000maxGraphemes: 2000
Similar lexicons
semantic matchLexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.
-
at.happyproto.plugin.profile
recordA HappyView plugin package, in its publisher's repo. The record key is the package slug, so the slug is immutable: changing it means a different package.
-
Identity-level metadata for a plugin publisher. One record per publisher DID, located at rkey `self`. Optional: a DID may publish packages without ever publishing a publisher.profile, in which case clients fall back to the publisher's handle and per-package metadata for display. EXPERIMENTAL: this NSID is part of the experimental phase of the EmDash plugin registry. The stable namespace target is com.emdashcms.publisher.profile.
-
Plugin package release record. EXPERIMENTAL: this NSID is part of the experimental phase of the EmDash plugin registry. The stable namespace target is com.emdashcms.package.release.
-
The HappyView facts about a software.release.project that make it a plugin. The record key is the project's name, and the record lives in the same repo as the project. The registry indexes a project's releases only while this record exists and is valid.
-
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.