garden.lexicon.exultant-zebra.tile

ngerakines.me

Documentation

A tile with a name and associated resource or bundle.

main record

A tile with a name and associated resource or bundle.

Record Key tid Timestamp-based ID

Properties

aspectRatio string Optional

Declared aspect ratio for tile rendering.

Known values: 1:1, 2:1, 3:1, 1:2, 1:3
description string Optional

Optional rich text description of the tile.

maxLength: 3000 bytes
facets array of ref app.bsky.richtext.facet Optional

Rich text facets for the description (links, mentions, hashtags).

icon blob Optional

Optional icon image for the tile.

maxSize: 1.0 MB
interactions ref #interactions Optional

Declaration of the XRPC methods, collections, and services this tile interacts with.

loadingImage blob Optional

Optional loading screen image for the tile.

maxSize: 1.0 MB
name string Required

The name of the tile.

params array of ref #param Optional

Input parameters this tile accepts. When present, the tile runtime shows a configuration form for required parameters without defaults before loading the tile.

View raw schema 
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "name",
      "content"
    ],
    "properties": {
      "icon": {
        "type": "blob",
        "accept": [
          "image/png",
          "image/jpeg"
        ],
        "maxSize": 1048576,
        "description": "Optional icon image for the tile."
      },
      "name": {
        "type": "string",
        "description": "The name of the tile."
      },
      "facets": {
        "type": "array",
        "items": {
          "ref": "app.bsky.richtext.facet",
          "type": "ref"
        },
        "description": "Rich text facets for the description (links, mentions, hashtags)."
      },
      "params": {
        "type": "array",
        "items": {
          "ref": "#param",
          "type": "ref"
        },
        "description": "Input parameters this tile accepts. When present, the tile runtime shows a configuration form for required parameters without defaults before loading the tile."
      },
      "content": {
        "refs": [
          "garden.lexicon.exultant-zebra.masl#resource",
          "garden.lexicon.exultant-zebra.masl#main"
        ],
        "type": "union",
        "description": "The tile content, either a single resource or a bundle."
      },
      "aspectRatio": {
        "type": "string",
        "description": "Declared aspect ratio for tile rendering.",
        "knownValues": [
          "1:1",
          "2:1",
          "3:1",
          "1:2",
          "1:3"
        ]
      },
      "description": {
        "type": "string",
        "maxLength": 3000,
        "description": "Optional rich text description of the tile."
      },
      "interactions": {
        "ref": "#interactions",
        "type": "ref",
        "description": "Declaration of the XRPC methods, collections, and services this tile interacts with."
      },
      "loadingImage": {
        "type": "blob",
        "accept": [
          "image/png",
          "image/jpeg"
        ],
        "maxSize": 1048576,
        "description": "Optional loading screen image for the tile."
      }
    }
  },
  "description": "A tile with a name and associated resource or bundle."
}
interactions object

Declares the AT Protocol interactions a tile performs. Methods listed here gate which XRPC calls the tile is allowed to attempt (the user must still grant per-method consent). Collections and services are informational metadata for display and auditing.

Properties

collections array of stringnsid Optional

Repository collection NSIDs this tile reads from or writes to.

methods array of string Optional

XRPC method NSIDs this tile may call. When present, the tile runtime restricts XRPC calls to only these methods. When absent, all server-allowed methods may be called (with user consent).

services array of string Optional

AT Protocol service proxy targets this tile interacts with, identified by DID and service endpoint fragment.

View raw schema 
{
  "type": "object",
  "properties": {
    "methods": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "XRPC method NSIDs this tile may call. When present, the tile runtime restricts XRPC calls to only these methods. When absent, all server-allowed methods may be called (with user consent)."
    },
    "services": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "AT Protocol service proxy targets this tile interacts with, identified by DID and service endpoint fragment."
    },
    "collections": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "nsid"
      },
      "description": "Repository collection NSIDs this tile reads from or writes to."
    }
  },
  "description": "Declares the AT Protocol interactions a tile performs. Methods listed here gate which XRPC calls the tile is allowed to attempt (the user must still grant per-method consent). Collections and services are informational metadata for display and auditing."
}
param object

Declares an input parameter for a tile, similar to XRPC query parameters.

Properties

default string Optional

Default value for this parameter, encoded as a string.

description string Optional

Human-readable description of this parameter.

maxLength: 1000 bytes
name string Required

Parameter name, used as a URL search param key. Must not start with an underscore.

maxLength: 64 bytes
required boolean Optional

Whether this parameter must be provided before loading the tile.

type string Required

Parameter value type.

Known values: string, integer, boolean
View raw schema 
{
  "type": "object",
  "required": [
    "name",
    "type"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 64,
      "description": "Parameter name, used as a URL search param key. Must not start with an underscore."
    },
    "type": {
      "type": "string",
      "description": "Parameter value type.",
      "knownValues": [
        "string",
        "integer",
        "boolean"
      ]
    },
    "default": {
      "type": "string",
      "description": "Default value for this parameter, encoded as a string."
    },
    "required": {
      "type": "boolean",
      "description": "Whether this parameter must be provided before loading the tile."
    },
    "description": {
      "type": "string",
      "maxLength": 1000,
      "description": "Human-readable description of this parameter."
    }
  },
  "description": "Declares an input parameter for a tile, similar to XRPC query parameters."
}

Lexicon Garden

@