at.inlay.component

inlay.at

Documentation

Component record - declares an implementation of a type

main record

Component record - declares an implementation of a type

Record Key tid Timestamp-based ID

Properties

accepts array of ref #acceptsEntry Optional

Data types this component can render. Used for data-driven discovery.

body union Optional

How this component is rendered. Omit for primitives rendered by the host.

Known types:
createdAt string datetime Optional

An RFC 3339 formatted timestamp.

description string Optional

No description available.

maxLength: 10000 bytesmaxGraphemes: 1000 graphemes
imports array of string at-uri Optional

Ordered list of pack URIs (import stack). First pack that exports an NSID wins.

type string nsid Required

NSID this component implements (also the XRPC procedure)

updatedAt string datetime Optional

Last update timestamp. Set by the publish flow to bust cached responses.

View raw schema 
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "type"
    ],
    "properties": {
      "via": {
        "refs": [
          "at.inlay.defs#viaValtown"
        ],
        "type": "union",
        "description": "Platform-managed deployment metadata"
      },
      "body": {
        "refs": [
          "#bodyExternal",
          "#bodyTemplate"
        ],
        "type": "union",
        "description": "How this component is rendered. Omit for primitives rendered by the host."
      },
      "type": {
        "type": "string",
        "format": "nsid",
        "description": "NSID this component implements (also the XRPC procedure)"
      },
      "view": {
        "type": "array",
        "items": {
          "refs": [
            "#viewRecord",
            "#viewCollection",
            "#viewIdentity"
          ],
          "type": "union"
        },
        "description": "What kinds of pages this component is a view for"
      },
      "accepts": {
        "type": "array",
        "items": {
          "ref": "#acceptsEntry",
          "type": "ref"
        },
        "description": "Data types this component can render. Used for data-driven discovery."
      },
      "imports": {
        "type": "array",
        "items": {
          "type": "string",
          "format": "at-uri"
        },
        "description": "Ordered list of pack URIs (import stack). First pack that exports an NSID wins."
      },
      "createdAt": {
        "type": "string",
        "format": "datetime"
      },
      "updatedAt": {
        "type": "string",
        "format": "datetime",
        "description": "Last update timestamp. Set by the publish flow to bust cached responses."
      },
      "description": {
        "type": "string",
        "maxLength": 10000,
        "maxGraphemes": 1000
      }
    }
  },
  "description": "Component record - declares an implementation of a type"
}
acceptsEntry object

Declares a data type this component can handle, routed to a specific prop.

Properties

collection string nsid Optional

For at-uri strings, restricts to this collection.

format string Optional

String format constraint. Only applies when type is 'string'.

maxLength: 64 bytes
Known values: at-uri, did, datetime, uri, handle, at-identifier, nsid, cid, language, record-key, tid
prop string Required

Prop to bind matched data to.

maxLength: 256 bytes
type string Required

Lexicon field type.

maxLength: 128 bytes
Known values: string, integer, boolean, blob, cid-link, bytes
View raw schema 
{
  "type": "object",
  "required": [
    "type",
    "prop"
  ],
  "properties": {
    "prop": {
      "type": "string",
      "maxLength": 256,
      "description": "Prop to bind matched data to."
    },
    "type": {
      "type": "string",
      "maxLength": 128,
      "description": "Lexicon field type.",
      "knownValues": [
        "string",
        "integer",
        "boolean",
        "blob",
        "cid-link",
        "bytes"
      ]
    },
    "format": {
      "type": "string",
      "maxLength": 64,
      "description": "String format constraint. Only applies when type is 'string'.",
      "knownValues": [
        "at-uri",
        "did",
        "datetime",
        "uri",
        "handle",
        "at-identifier",
        "nsid",
        "cid",
        "language",
        "record-key",
        "tid"
      ]
    },
    "collection": {
      "type": "string",
      "format": "nsid",
      "description": "For at-uri strings, restricts to this collection."
    }
  },
  "description": "Declares a data type this component can handle, routed to a specific prop."
}
bodyExternal object

Component rendered by calling a remote XRPC endpoint

Properties

did string did Required

DID of the service hosting this component

View raw schema 
{
  "type": "object",
  "required": [
    "did"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did",
      "description": "DID of the service hosting this component"
    }
  },
  "description": "Component rendered by calling a remote XRPC endpoint"
}
bodyTemplate object

Component rendered by the host from a serialized element tree

Properties

node unknown Required

Serialized element tree with bindings

View raw schema 
{
  "type": "object",
  "required": [
    "node"
  ],
  "properties": {
    "node": {
      "type": "unknown",
      "description": "Serialized element tree with bindings"
    }
  },
  "description": "Component rendered by the host from a serialized element tree"
}
viewCollection object

Component is a view for a collection listing. Omit collection for a generic collection view.

Properties

collection string nsid Optional

The collection this component lists. Omit for any-collection.

View raw schema 
{
  "type": "object",
  "properties": {
    "collection": {
      "type": "string",
      "format": "nsid",
      "description": "The collection this component lists. Omit for any-collection."
    }
  },
  "description": "Component is a view for a collection listing. Omit collection for a generic collection view."
}
viewIdentity object

Component is a view for an identity (person/DID).

This object has no properties defined.

View raw schema 
{
  "type": "object",
  "properties": {},
  "description": "Component is a view for an identity (person/DID)."
}
viewRecord object

Component is a view for individual records of a collection. Omit collection for a generic record view.

Properties

collection string nsid Optional

The collection this component views. Omit for any-collection.

View raw schema 
{
  "type": "object",
  "properties": {
    "collection": {
      "type": "string",
      "format": "nsid",
      "description": "The collection this component views. Omit for any-collection."
    }
  },
  "description": "Component is a view for individual records of a collection. Omit collection for a generic record view."
}

Lexicon Garden

@