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.

Repository @emdashcms.com did:plc:ilznslhspsvk6naatedr66pi namespace authority
Details · record, key any
Kindrecord
Record keyany
Authoritypackage.experimental.emdashcms.com
Indexed

Record

record · key any

Properties

authors

requiredarray

At least one author. Vendors SHOULD specify at least one of url or email per author.

  • minLength: 1
  • maxLength: 32
itemsref
Reference

Short description of the package. SHOULD NOT exceed 140 characters per FAIR convention.

  • maxLength: 1024
  • maxGraphemes: 140

extensions

unknown

Opaque 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.

id

requiredstring · at-uri

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.

Search keywords. SHOULD NOT exceed 5 items per FAIR convention.

  • maxLength: 5
itemsstring
  • maxLength: 128
  • maxGraphemes: 64

lastUpdated

string · datetime

ISO 8601 datetime for the package's last update.

license

requiredstring

SPDX license expression, or the literal 'proprietary'. Clients SHOULD refuse to install packages without a valid license.

  • maxLength: 256

name

string

Human-readable name for the package, displayed in directory listings.

  • maxLength: 1024
  • maxGraphemes: 100

Map of human-readable text sections (description, installation, faq, changelog, security). CommonMark Markdown. Each value capped at 20000 bytes / 2000 graphemes.

Reference

security

requiredarray

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: 1
  • maxLength: 8
itemsref
Reference

slug

string

URL-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: 1
  • maxLength: 64

type

requiredstring

Package type from FAIR's type registry. EmDash plugins use 'emdash-plugin'. Custom types use the 'x-' prefix.

  • maxLength: 64
  • knownValues: emdash-plugin

#author

object

FAIR 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'.

Properties

email

string
  • maxLength: 256

name

requiredstring
  • maxLength: 256
  • maxGraphemes: 64

url

string · uri
  • maxLength: 1024

#contact

object

FAIR 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.

Properties

email

string
  • maxLength: 256

url

string · uri
  • maxLength: 1024

#sections

object

Free-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

string
  • maxLength: 20000
  • maxGraphemes: 2000
  • maxLength: 20000
  • maxGraphemes: 2000

faq

string
  • maxLength: 20000
  • maxGraphemes: 2000
  • maxLength: 20000
  • maxGraphemes: 2000

security

string
  • maxLength: 20000
  • maxGraphemes: 2000

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • A 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.

  • One 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.