chadtmiller.com/hud
A remote MCP server that shows atproto records as interactive UI inside MCP Apps hosts
place.hud.hudkit 0.3.1 Latest 5 packages
0
0
{
"lexicon": 1,
"id": "place.hud.ui",
"description": "A view resolved on the server: its layout drawn against its data, as a tree a client draws with nothing left to interpret, sent as a tool result's _meta.ui. Nodes are told apart by their component (c), not by $type: a node's props (p) are as the def named for its component describes (#textProps for Text, #errorProps for Error), and its items as the def its component's items name. A number with a fraction (a picture's ratio, a Stat's value, a track's duration) is a JSON number, which no lexicon type holds: such fields are described, not declared. hud_core::ui::check holds a tree to this.",
"defs": {
"main": {
"type": "object",
"description": "The tree, version 1: an object, not a method, so it needs no auth; it is read in a tool's answer, whatever that answer needed.",
"required": ["v", "trusted", "root"],
"properties": {
"v": { "type": "integer", "minimum": 1, "description": "The tree's format: 1, as this describes." },
"trusted": { "type": "boolean", "description": "Whether the view is a bundled one. An untrusted view's actions ask the person before they write." },
"title": { "type": "string", "description": "The view's description." },
"people": { "type": "string", "maxLength": 253, "description": "The domain of the app the tree is of, where it has a page: an account a mention names opens as describe_app { domain, actor }, its page there; absent: as describe_repo." },
"root": { "type": "ref", "ref": "#node" },
"next": { "type": "ref", "ref": "#call", "description": "The call for the page after: its tree's page list's items go after these (a node with page and items, whatever its component)." },
"latest": { "type": "ref", "ref": "#latest" },
"report": { "type": "ref", "ref": "#report" },
"head": { "type": "ref", "ref": "#head" },
"hero": { "type": "string", "maxLength": 8192, "description": "The first picture the tree draws large, in the order it draws them (an Image not drawn small, the first picture of a Gallery, Slides or Covers, a Profile's banner else its avatar): its src, which a page loads first (eagerly, at high priority, and preloaded from its head), the rest as they near the screen." },
"heroSrcset": { "type": "string", "maxLength": 8192, "description": "The hero's sizes, where it is a gallery's photo that has them: its srcset, which a page preloads with it (imagesrcset), with the sizes it draws it at." },
"measure": { "type": "string", "maxLength": 16, "knownValues": ["wide", "full"], "description": "How wide the view would be drawn, where its host can give it the room: wide, wider than its reading width; full, all the room it has for a view. Absent: its reading width. A host may draw it so, or as any other; it never asks for more room by itself." }
}
},
"head": {
"type": "object",
"description": "What a page drawing the tree says of itself in its HTML head, to search engines and link previews: a trusted view's mode's head read against its data, each field left out where it read nothing. Its text is on one line and cut short; the page escapes all of it as it writes HTML, and its structured data's < too.",
"properties": {
"title": { "type": "string", "maxLength": 500, "maxGraphemes": 121, "description": "The page's title." },
"description": { "type": "string", "maxLength": 1250, "maxGraphemes": 301, "description": "What the page shows, for a search result or a preview." },
"image": { "type": "string", "format": "uri", "maxLength": 2048, "description": "The picture a preview shows: an absolute https URL." },
"imageAlt": { "type": "string", "maxLength": 1700, "maxGraphemes": 421, "description": "The picture's alt text." },
"type": { "type": "string", "maxLength": 16, "knownValues": ["website", "article", "profile"], "description": "What the page is, as Open Graph's og:type." },
"canonical": { "type": "string", "maxLength": 512, "description": "The page's own path on the app's site, with its query (/profile/alice.test/gallery/3k…), percent-encoded: the page's canonical URL is the site's origin and it." },
"noindex": { "type": "boolean", "description": "True where search engines should not index the page (its account or record is labelled); absent otherwise." },
"jsonLd": { "type": "unknown", "description": "schema.org structured data, an object, at most 32 KiB as JSON." }
}
},
"node": {
"type": "object",
"description": "A component drawn: its name, its props, its children and, for a component of items, its items. Error stands where a component could not draw.",
"required": ["c"],
"properties": {
"c": {
"type": "string",
"maxLength": 64,
"knownValues": ["Stack", "Row", "Split", "Header", "Text", "RichText", "Time", "Image", "Stat", "Link", "Tabs", "Search", "Menu", "Bar", "Panes", "Pane", "Accounts", "Toggle", "Choice", "Icon", "Badge", "State", "Label", "Diff", "List", "Messages", "Tree", "Chain", "Gallery", "Slides", "Covers", "Faces", "Player", "Map", "Profile", "Fields", "Json", "ContentWarning", "Document", "Embed", "FeedContext", "Action", "Compose", "Error"],
"description": "The component."
},
"p": { "type": "unknown", "description": "The component's props, as #<component>Props describes (its name's first letter lower case: #richTextProps for RichText). Absent where it has none." },
"k": { "type": "array", "items": { "type": "ref", "ref": "#node" }, "description": "Its children, in order. Absent where it has none." },
"items": { "type": "array", "items": { "type": "unknown" }, "description": "A List's, Messages', Tree's, Chain's, Gallery's, Slides', Covers', Player's or Map's items, each as #listItem, #messageItem, #treeItem (a Tree's and a Chain's), #galleryItem, #slideItem, #coverItem, #playerItem or #mapPin describes." },
"fallback": { "type": "ref", "ref": "#node", "description": "What a client that doesn't know the component draws in its place where it has no children: the node its view gave, drawn over the same scope. Absent where the view gave none." }
}
},
"open": {
"type": "object",
"description": "What something opens: a tool call (call), an http(s) page (url), or what the host app does itself (host).",
"properties": {
"call": { "type": "ref", "ref": "#call" },
"url": { "type": "string", "description": "An http or https page, opened in the host's browser." },
"host": { "type": "string", "maxLength": 64, "knownValues": ["signOut"], "description": "What the host app does itself, from a bundled view alone: signOut signs the account out of the app, as an app's own Settings' Sign out. A host that does not do it draws nothing that opens it." },
"sheet": { "type": "boolean", "description": "The call's screen opens as a sheet over what is open, rather than in place of it (a story's comments over the story). Present only when true." }
}
},
"call": {
"type": "object",
"description": "A tool call: the client makes it as it is.",
"required": ["name", "args"],
"properties": {
"name": { "type": "string", "maxLength": 64, "description": "The tool, as get_record, describe_repo or query." },
"args": { "type": "unknown", "description": "Its arguments." }
}
},
"latest": {
"type": "object",
"description": "How to tell something newer came than the items a query's tree drew: make call, and something did when its tree's latest has an item whose key none of these items has.",
"required": ["call", "items"],
"properties": {
"call": { "type": "ref", "ref": "#call", "description": "The tree's own call with no cursor, asking for its newest items alone (2, where its method takes a limit)." },
"items": { "type": "array", "maxLength": 100, "items": { "type": "ref", "ref": "#latestItem" }, "description": "The items drawn, in order." },
"noun": { "type": "string", "maxLength": 32, "description": "What the items are, plural (posts), as its view's summary names them." }
}
},
"latestItem": {
"type": "object",
"description": "An item drawn, as a tree's latest knows it.",
"required": ["key"],
"properties": {
"key": { "type": "string", "maxLength": 8192, "description": "The item's key, as its view names it (a post's at-uri)." }
}
},
"run": {
"type": "object",
"description": "A run of text: plain, or a link, an account or a tag; each formatting flag present only when true.",
"required": ["text"],
"properties": {
"text": { "type": "string" },
"link": { "type": "string", "description": "The http or https page it opens; in an app's own page's text, a mailto: address too." },
"actor": { "type": "string", "description": "The account it opens: its DID, or the handle a text written with no facets names it by (a profile's description)." },
"tag": { "type": "string", "description": "The tag it names." },
"open": { "type": "ref", "ref": "#open", "description": "With tag: a search for it in the app the tree is in, where that app has one." },
"bold": { "type": "boolean" },
"italic": { "type": "boolean" },
"code": { "type": "boolean" },
"strike": { "type": "boolean" },
"underline": { "type": "boolean" },
"highlight": { "type": "boolean" },
"alt": { "type": "boolean", "description": "A picture's alt text, in its place." }
}
},
"picture": {
"type": "object",
"description": "A picture to load. Where one is nullable, null is a value that is no usable source: a placeholder is drawn.",
"required": ["src", "fallback"],
"nullable": ["fallback"],
"properties": {
"src": { "type": "string", "description": "Its URL, small or large as it is drawn." },
"fallback": { "type": "string", "description": "Loaded once where src does not load: a blob's own, through the server's blob proxy." }
}
},
"report": {
"type": "object",
"description": "A feed told what is done with its items.",
"required": ["feed", "seen"],
"properties": {
"feed": { "type": "string", "description": "The feed's at-uri." },
"seen": { "type": "boolean", "description": "Whether items seen are told: a signed-in call's alone." }
}
},
"itemReport": {
"type": "object",
"description": "An item as its feed is told of it, on its being seen and its opening.",
"required": ["item"],
"properties": {
"item": { "type": "string", "description": "The item's at-uri." },
"feedContext": { "type": "string", "description": "The feed's context for it, as the feed gave it." },
"reqId": { "type": "string", "description": "The feed's request id, as the feed gave it." }
}
},
"stackProps": {
"type": "object",
"description": "Its children, one above another.",
"properties": {
"gap": { "type": "string", "knownValues": ["none", "xs", "sm", "md", "lg"], "description": "md where the view says none; none sets its children against one another." },
"align": { "type": "string", "knownValues": ["start", "center"] },
"wrap": { "type": "string", "knownValues": ["wrap", "cut"] },
"measure": { "type": "string", "maxLength": 16, "knownValues": ["content"], "description": "content: held to the host's reading width, centred, in a view drawn wider (a wide profile's header over its grid). Absent: as wide as its box." }
}
},
"rowProps": {
"type": "object",
"description": "Its children side by side.",
"properties": {
"gap": { "type": "string", "knownValues": ["xs", "sm", "md", "lg"], "description": "sm where the view says none." },
"align": { "type": "string", "knownValues": ["start", "center"] },
"wrap": { "type": "string", "knownValues": ["wrap", "cut", "inline"], "description": "cut keeps them on one line, cutting short what does not fit; inline runs its texts and times on as the words of one paragraph, a space between each." }
}
},
"headerProps": {
"type": "object",
"description": "A page's or a set's header. Every prop is optional, so it always draws.",
"nullable": ["image"],
"properties": {
"title": { "type": "string" },
"subtitle": { "type": "string" },
"kicker": { "type": "string" },
"image": { "type": "ref", "ref": "#picture", "description": "Drawn small; present only where the view's value is (null for a placeholder), so a header with none has no picture's box." },
"meta": { "type": "array", "items": { "type": "string" }, "description": "A line of words, none empty." }
}
},
"textProps": {
"type": "object",
"description": "Plain text, its http(s) URLs links.",
"required": ["runs", "style"],
"properties": {
"runs": { "type": "array", "items": { "type": "ref", "ref": "#run" } },
"style": { "type": "string", "knownValues": ["body", "strong", "heading", "muted", "mono", "quote"], "description": "quote: smaller and quieter, on one line, behind a rule at its left, as what a reply replies to." },
"clamp": { "type": "integer", "minimum": 1, "description": "About the most lines shown before more." },
"shownRuns": { "type": "array", "items": { "type": "ref", "ref": "#run" }, "description": "With clamp, where runs take more lines than it: what is shown until more is opened, runs cut at a word, an ellipsis after them. Absent where they fit." }
}
},
"richTextProps": {
"type": "object",
"description": "Text with its facets, or with its links, mentions and tags found (runs); or markdown or GFM read into blocks (blocks).",
"properties": {
"runs": { "type": "array", "items": { "type": "ref", "ref": "#run" } },
"blocks": { "type": "array", "items": { "type": "ref", "ref": "#block" } },
"clamp": { "type": "integer", "minimum": 1, "description": "About the most lines shown before more." },
"shownRuns": { "type": "array", "items": { "type": "ref", "ref": "#run" }, "description": "With clamp and runs, where they take more lines than it: what is shown until more is opened, runs cut at a word, an ellipsis after them. Absent where they fit." },
"shownBlocks": { "type": "array", "items": { "type": "ref", "ref": "#block" }, "description": "With clamp and blocks, where they take more lines than it: what is shown until more is opened, whole blocks and then the next cut. Absent where they fit." },
"style": { "type": "string", "maxLength": 16, "knownValues": ["muted"], "description": "muted: runs smaller and quieter, as Text's; absent: body text." }
}
},
"timeProps": {
"type": "object",
"description": "A date and time, drawn in the reader's own zone.",
"required": ["value"],
"properties": {
"value": { "type": "string", "description": "The timestamp, as the data gave it." }
}
},
"imageProps": {
"type": "object",
"description": "One picture. Its ratio, width over height (1 for a size, else the data's, else 4/3), is a number with a fraction, so not declared here.",
"required": ["src", "alt"],
"nullable": ["src"],
"properties": {
"src": { "type": "ref", "ref": "#picture" },
"alt": { "type": "string" },
"size": { "type": "string", "knownValues": ["avatar", "face", "large", "icon", "thumb"], "description": "Drawn small and round, larger, or largest as a profile's own; icon: small, a rounded square holding the picture whole, as an app's icon; thumb: a little larger, a rounded square the picture fills, cropped, as a notification's gallery; absent for a picture drawn at its ratio." },
"fit": { "type": "string", "knownValues": ["contain"], "description": "Present only for contain." },
"bleed": { "type": "boolean", "description": "Drawn to the edges of what holds it, past its padding, square-cornered, as a photo app's feed draws a photo. Present only when true." },
"showAlt": { "type": "boolean", "description": "Marked ALT, its alt text shown over it when tapped. Present only when true, and only where alt is not empty." },
"ring": { "type": "boolean", "description": "Ringed in the accent, as a photo app marks stories not yet seen. Present only when true." },
"plus": { "type": "boolean", "description": "A small + in the accent at its corner, as a photo app marks one's own face first in its stories. Present only when true." },
"open": { "type": "ref", "ref": "#open", "description": "What tapping it opens (an author's picture, their profile), rather than what holds it; read aloud as its alt." }
}
},
"statProps": {
"type": "object",
"description": "A small icon and a number: a count, or an array's length where the view bound one. Its value is a JSON number, which may have a fraction, so not declared here.",
"properties": {
"icon": { "type": "string", "knownValues": ["heart", "repost", "reply", "star", "play", "comment", "fork"] },
"label": { "type": "string", "description": "What the number counts, read aloud." },
"more": { "type": "boolean", "description": "There are more than the number counts (a page with a cursor after it): drawn as N+. Present only when true." }
}
},
"linkProps": {
"type": "object",
"description": "A link: its words, and what it opens, or current where it is the query drawn now.",
"required": ["label"],
"properties": {
"label": { "type": "string" },
"open": { "type": "ref", "ref": "#open" },
"current": { "type": "boolean", "description": "It names the query drawn now: drawn as where the reader is, opening nothing." },
"style": { "type": "string", "maxLength": 16, "knownValues": ["button", "name", "muted"], "description": "button: drawn as a button, as a profile's Message; name: as an account's name beside its picture, in the text's own colour, bold; muted: in the muted text's colour and size, on one line, cut with an ellipsis, as a gallery's location under its author; absent: as words." },
"icon": { "type": "string", "maxLength": 32, "knownValues": ["settings", "plus", "search", "notification", "people", "comment"], "description": "Drawn before its words; in a Bar or over a Slides' picture, alone, its label read aloud." },
"share": { "type": "string", "format": "uri", "description": "An https address to share (the host's share sheet, else copied to the clipboard) rather than anything to open: a profile's page on its app's site." },
"copy": { "type": "string", "maxLength": 3000, "description": "Text to copy to the clipboard rather than anything to open: a profile's handle." }
}
},
"toggleProps": {
"type": "object",
"description": "A settings switch: flipped, it sends call as the signed-in account, each {\"$on\": true} in its input the new state.",
"required": ["label", "on", "key", "call"],
"properties": {
"label": { "type": "string", "maxLength": 400 },
"about": { "type": "string", "maxLength": 3000, "description": "A line under the label, what it does." },
"on": { "type": "boolean", "description": "Whether it is on now." },
"key": { "type": "string", "maxLength": 16, "description": "What it is, for state kept as it is drawn again." },
"call": { "type": "ref", "ref": "#procedureCall" }
}
},
"choiceProps": {
"type": "object",
"description": "A setting of one of a few values: chosen, it sends call as the signed-in account, each {\"$on\": true} in its input the value chosen.",
"required": ["label", "options", "key", "call"],
"properties": {
"label": { "type": "string", "maxLength": 400 },
"about": { "type": "string", "maxLength": 3000, "description": "A line under the label, what it does." },
"options": { "type": "array", "minLength": 2, "maxLength": 6, "items": { "type": "ref", "ref": "#choiceOption" }, "description": "What may be chosen, in order." },
"on": { "type": "string", "maxLength": 512, "description": "The value chosen now; absent where none is." },
"key": { "type": "string", "maxLength": 16, "description": "What it is, for state kept as it is drawn again." },
"call": { "type": "ref", "ref": "#procedureCall" }
}
},
"choiceOption": {
"type": "object",
"description": "One option of a Choice: its words, and the value choosing it sends.",
"required": ["label", "value"],
"properties": {
"label": { "type": "string", "maxLength": 400 },
"value": { "type": "string", "maxLength": 512 }
}
},
"menuProps": {
"type": "object",
"description": "A ⋯ button opening its children (#node: Actions, Links, Composes) as a menu's rows.",
"required": ["label"],
"properties": {
"label": { "type": "string", "maxLength": 400, "description": "The button's words, read aloud." }
}
},
"barProps": {
"type": "object",
"description": "The screen's top bar: its title, and buttons beside it, its children (#node: Links, Actions, Composes, Menus), each drawn as its icon alone, its label read aloud. Where the app has no bar, drawn where it stands: its title a heading at the start of its row, its buttons at the end.",
"properties": {
"title": { "type": "string", "description": "The screen's title, which the app draws in its bar. Absent where the view gives none." }
}
},
"splitProps": {
"type": "object",
"description": "Its two children (#node) side by side where its box holds both at their narrowest, else one under the other in their order. The aside, at its narrowest, is the second, or with side start the first; the main takes the rest.",
"properties": {
"side": { "type": "string", "maxLength": 8, "knownValues": ["start"], "description": "start: the first child is the aside. Absent: the second." },
"main": { "type": "ref", "ref": "#size", "description": "The narrowest the main goes beside the aside; md where absent." },
"aside": { "type": "ref", "ref": "#size", "description": "The aside's width beside the main; sm where absent." }
}
},
"size": {
"type": "string",
"maxLength": 8,
"knownValues": ["sm", "md", "lg"],
"description": "A width its host sets (the web 6rem, 10rem and 15rem; the native kits 96, 160 and 240 points)."
},
"panesProps": {
"type": "object",
"description": "Panes one shown at a time, chosen by a row of icons over them: its children (#node), each a Pane. With one, no row.",
"properties": {}
},
"accountsProps": {
"type": "object",
"description": "The accounts the host app is signed in to, drawn by the host from what it keeps (each its picture, name and handle, the one in use ticked, a tap on another switching to it, then Add account): its children (#node) drawn in its place where the host keeps none.",
"properties": {}
},
"paneProps": {
"type": "object",
"description": "One of a Panes: its children (#node), shown when chosen.",
"required": ["label"],
"properties": {
"label": { "type": "string", "maxLength": 400, "description": "Its name, read aloud, and drawn where it has no icon." },
"icon": { "type": "string", "maxLength": 32, "knownValues": ["grid", "heart", "clock", "feed", "people"] }
}
},
"tabsProps": {
"type": "object",
"description": "Tabs over what is drawn: choosing one replaces the call drawn with its own, in place (the same tile, the same screen), never opening another.",
"required": ["items"],
"properties": {
"items": { "type": "array", "minLength": 2, "maxLength": 20, "items": { "type": "ref", "ref": "#tab" } },
"style": { "type": "string", "maxLength": 16, "knownValues": ["strip"], "description": "strip: a line of words that scrolls sideways, the one drawn now underlined, as a feed app's feeds; absent: a segmented control." }
}
},
"searchProps": {
"type": "object",
"description": "A search field: the words typed fill param of open's query, and searching opens it, or, where current, draws it in place of what is drawn, as a tab does.",
"required": ["open", "param"],
"properties": {
"open": { "type": "ref", "ref": "#open", "description": "The query searched, its other params read already." },
"param": { "type": "string", "maxLength": 64, "description": "The param of open's query the words fill." },
"placeholder": { "type": "string", "maxLength": 400, "description": "What the field says while empty." },
"value": { "type": "string", "maxLength": 3000, "description": "The words searched already, shown in the field." },
"current": { "type": "boolean", "description": "open's query is the one drawn now: searching again draws its answer in place. Present only when true." }
}
},
"tab": {
"type": "object",
"description": "A tab: its words, the call it draws, and whether that call is the one drawn now.",
"required": ["label", "open", "selected"],
"properties": {
"label": { "type": "string", "maxLength": 400, "maxGraphemes": 40 },
"open": { "type": "ref", "ref": "#open" },
"selected": { "type": "boolean", "description": "Its call is the one drawn now; at most one tab is." }
}
},
"iconProps": {
"type": "object",
"description": "A small rounded square of a tint with a white glyph, as a menu row's icon; or, of style glyph, the glyph alone in its tint's colour, as a notification's reason.",
"required": ["name", "tint"],
"properties": {
"name": { "type": "string", "knownValues": ["issue", "pull", "review", "notification", "repo", "star", "check", "release", "activity", "search", "people", "feed", "heart", "follow", "comment", "reply", "mention"] },
"tint": { "type": "string", "knownValues": ["green", "blue", "purple", "gray", "yellow", "red", "orange"], "description": "A role each platform maps to a colour of its theme that a white glyph reads on; of style glyph, a colour of text (red the heart's, blue the accent)." },
"style": { "type": "string", "maxLength": 16, "knownValues": ["glyph"], "description": "glyph: the glyph alone, in its tint's colour, as tall as an avatar beside it; absent: on its square. Present only for glyph." }
}
},
"badgeProps": {
"type": "object",
"description": "A small tag.",
"required": ["value"],
"properties": {
"value": { "type": "string" }
}
},
"stateProps": {
"type": "object",
"description": "What something is in, by its role's colour and icon.",
"required": ["role", "word", "style"],
"properties": {
"role": { "type": "string", "knownValues": ["open-pull", "draft-pull", "merged", "closed-pull", "open-issue", "closed-issue", "success", "failure", "running", "queued", "skipped", "neutral"] },
"word": { "type": "string", "description": "The view's word for the value, else the value capitalised." },
"style": { "type": "string", "knownValues": ["mark", "text", "pill"] }
}
},
"labelProps": {
"type": "object",
"description": "A pull's or an issue's label.",
"required": ["name"],
"properties": {
"name": { "type": "string" },
"color": { "type": "string", "maxLength": 7, "description": "A #rrggbb colour; absent for any other." },
"description": { "type": "string" }
}
},
"diffProps": {
"type": "object",
"description": "One file's diff: its header and, with rows, its rows.",
"required": ["path"],
"properties": {
"path": { "type": "string" },
"from": { "type": "string", "description": "Where it was renamed from; present only where that is not path." },
"status": { "type": "string" },
"added": { "type": "integer", "description": "Lines added." },
"removed": { "type": "integer", "description": "Lines removed." },
"note": { "type": "string", "description": "Why rows are not shown." },
"rows": { "type": "array", "items": { "type": "ref", "ref": "#diffRow" }, "description": "Absent for the header alone." },
"digits": { "type": "integer", "minimum": 1, "description": "The widest line number's digits, for the gutters; present with rows." }
}
},
"diffRow": {
"type": "object",
"description": "A row of a diff, its line numbers as text.",
"required": ["kind", "text"],
"properties": {
"kind": { "type": "string", "knownValues": ["added", "removed", "hunk", "note", "context"] },
"old": { "type": "string", "description": "The old line's number." },
"new": { "type": "string", "description": "The new line's number." },
"text": { "type": "string" }
}
},
"listProps": {
"type": "object",
"description": "Its items (#listItem), each drawn as its children.",
"required": ["style"],
"properties": {
"style": { "type": "string", "knownValues": ["rows", "cards", "grid", "inline", "chips", "strip", "shelf", "spread"], "description": "chips: side by side and wrapping, each item a filled pill that opens it, under a small capital title; strip: one row that scrolls sideways, its items one width, evenly apart; shelf: one row of cards that scrolls sideways, each one width, its parts centred and wrapping (suggested accounts); spread: one row its items share evenly, each centred." },
"title": { "type": "string", "description": "A heading over it, drawn only when it has items." },
"empty": { "type": "string", "description": "What it says where its items would be, with none." },
"page": { "type": "boolean", "description": "Its items are a page's, which a page more (the tree's next) grows." },
"pages": { "type": "boolean", "description": "Opening an item opens a pager of them all, full screen: a swipe goes to the one beside it, and an item's Slides running off its end goes on to the next." },
"shown": { "type": "ref", "ref": "#procedureCall", "description": "Called once as the signed-in person when it is first shown (notifications marked seen)." },
"min": { "type": "ref", "ref": "#size", "description": "A grid's narrowest tile: as many across as fit, each at least this wide. Absent: the grid's own." },
"columns": { "type": "integer", "minimum": 1, "maximum": 6, "description": "The most tiles across a grid draws, however wide its box is." },
"chevrons": { "type": "boolean", "description": "Rows' alone: each that opens something ends with a chevron, as a settings page's rows that open pages of their own." },
"more": { "type": "ref", "ref": "#more", "description": "Chips' alone: one chip more after the items, in the accent colour, where the view's limit left items out (See all)." }
}
},
"more": {
"type": "object",
"description": "A chip after a List's items: its words and what it opens.",
"required": ["label", "open"],
"properties": {
"label": { "type": "string", "maxLength": 400, "maxGraphemes": 40 },
"open": { "type": "ref", "ref": "#open" }
}
},
"listItem": {
"type": "object",
"description": "A List's item: what it opens, its report to its feed, and its children drawn with it.",
"required": ["k"],
"properties": {
"open": { "type": "ref", "ref": "#open" },
"report": { "type": "ref", "ref": "#itemReport" },
"k": { "type": "array", "items": { "type": "ref", "ref": "#node" } }
}
},
"messagesProps": {
"type": "object",
"description": "A conversation, a tree's top node: its items (#messageItem) each a bubble, drawn the oldest at the top. A page more's items are earlier ones, asked for at its top.",
"required": ["group"],
"properties": {
"order": { "type": "string", "maxLength": 32, "knownValues": ["newest-first", "oldest-first"], "description": "Which way its items are listed; oldest-first where absent." },
"empty": { "type": "string", "maxLength": 200, "description": "What it says where its items would be, with none." },
"group": { "type": "boolean", "description": "Whether more than two people are in it: others' names are drawn over their runs." },
"page": { "type": "boolean", "description": "Its items are a page's, which a page more (the tree's next) grows with earlier ones." },
"send": { "type": "ref", "ref": "#procedureCall", "description": "A box to write in, sent as this call with what is written where its input holds {\"$text\": true}; a trusted view's, signed in." }
}
},
"messageItem": {
"type": "object",
"description": "A message: its bubble's children, who sent it and when. One with no sender is a note of the conversation's own, drawn centred.",
"required": ["k"],
"properties": {
"from": { "type": "string", "format": "did", "description": "Its sender." },
"mine": { "type": "boolean", "description": "Whether the signed-in person sent it: drawn on the right." },
"at": { "type": "string", "maxLength": 64, "description": "When it was sent, as the data says (RFC 3339)." },
"who": { "type": "ref", "ref": "#messageSender" },
"k": { "type": "array", "items": { "type": "ref", "ref": "#node" } }
}
},
"messageSender": {
"type": "object",
"description": "A message's sender, as the conversation's people name them.",
"properties": {
"name": { "type": "string", "maxLength": 640 },
"avatar": { "type": "ref", "ref": "#picture" }
}
},
"treeProps": {
"type": "object",
"description": "A tree, as a thread's replies: its items (#treeItem) say all but where its thread line runs.",
"properties": {
"line": {
"type": "string",
"knownValues": ["face"],
"maxLength": 16,
"description": "face: the thread line runs down the items' face column (each starts with a Row whose first part is a face Image), as FeedContext's; absent: beside the items."
}
}
},
"chainProps": {
"type": "object",
"description": "A chain, as the posts a post replies to: its items (#treeItem, oldest first) say all but where its thread line runs.",
"properties": {
"line": {
"type": "string",
"knownValues": ["face"],
"maxLength": 16,
"description": "face: the thread line runs from under each item's face to the next's, the last's into the face of what follows the chain, as FeedContext's; absent: beside the items."
}
}
},
"treeItem": {
"type": "object",
"description": "A Tree's or a Chain's item, or a post a FeedContext shows: what it opens, its children drawn with it, and, in a Tree, its own items nested under it.",
"required": ["k"],
"properties": {
"open": { "type": "ref", "ref": "#open" },
"k": { "type": "array", "items": { "type": "ref", "ref": "#node" } },
"children": { "type": "array", "items": { "type": "ref", "ref": "#treeItem" } }
}
},
"galleryProps": {
"type": "object",
"description": "Photos in justified rows, one under another at full width, or one at a time (#galleryItem).",
"properties": {
"page": { "type": "boolean", "description": "As a List's." },
"style": { "type": "string", "maxLength": 16, "knownValues": ["stack", "carousel"], "description": "stack: each photo the full width at its own shape, one under another; carousel: one at a time, the full width, swiped, dots saying which, all in one frame (the narrowest photo's shape, no narrower than 9:16); absent: justified rows." },
"bleed": { "type": "boolean", "description": "Each photo drawn as an Image with bleed is. Present only when true." },
"showAlt": { "type": "boolean", "description": "Each photo with alt text marked ALT, as an Image with showAlt is. Present only when true." },
"zoom": { "type": "boolean", "description": "A carousel's tap opens the photo full screen, to be pinched and zoomed, rather than going to what holds it. Present only when true." },
"like": { "type": "string", "maxLength": 400, "description": "The label of an Action in the same list item as the gallery (in none, the view's own) that a double-tap on a photo runs where it is not done yet (a gallery's Favorite), never undoing it." }
}
},
"slidesProps": {
"type": "object",
"description": "Pictures shown one at a time, as stories (#slideItem): bars over them, the one shown filling over its seconds before the next.",
"properties": {
"page": { "type": "boolean", "description": "As a List's." },
"seconds": { "type": "integer", "minimum": 2, "maximum": 15, "description": "How long each is shown; absent, 5." },
"face": { "type": "ref", "ref": "#picture", "description": "Whose they are: their picture, drawn small and round over the top." },
"name": { "type": "string", "maxLength": 640, "description": "Whose they are: their name, beside the face." },
"start": { "type": "integer", "minimum": 1, "description": "The picture shown first, from 0; absent, the first." },
"empty": { "type": "string", "maxLength": 400, "description": "With no pictures, the words in the middle of its screen; its children (#node), a way to add one, under them." },
"like": { "type": "string", "maxLength": 400, "description": "The label of an Action among a picture's own children that a double-tap on the picture runs where it is not done yet (a story's Favorite), never undoing it." }
}
},
"slideItem": {
"type": "object",
"description": "A picture shown full size. Its ratio, width over height, is a number with a fraction or null where its record gives none, so not declared here.",
"required": ["src", "alt"],
"nullable": ["src"],
"properties": {
"src": { "type": "ref", "ref": "#picture" },
"alt": { "type": "string" },
"time": { "type": "string", "description": "When it was posted." },
"place": { "type": "string", "maxLength": 3000, "description": "Where." },
"call": { "type": "ref", "ref": "#procedureCall", "description": "Called once as the signed-in person when it is first shown (a story marked watched)." },
"open": { "type": "ref", "ref": "#open", "description": "The screen it is (a story's record's): never opened by a tap, but an app's address follows it while it shows." },
"k": { "type": "array", "items": { "type": "ref", "ref": "#node" }, "description": "Drawn over it: a Menu at its top row's end, as its ⋯ (Report, Delete); the rest at its bottom-right, icons alone (its comments, its Favorite)." }
}
},
"galleryItem": {
"type": "object",
"description": "A photo. Its ratio, width over height, is a number with a fraction or null where its record gives none, so not declared here.",
"required": ["src", "full", "alt"],
"nullable": ["src", "full", "alt"],
"properties": {
"src": { "type": "ref", "ref": "#picture", "description": "Drawn small." },
"full": { "type": "string", "description": "Its full size, an http(s) page to open." },
"alt": { "type": "string" },
"info": { "type": "array", "maxLength": 4, "items": { "type": "ref", "ref": "#galleryInfo" }, "description": "Its lines of words, as its camera; absent where it has none. Drawn behind an ⓘ in its bottom-left corner." },
"srcset": { "type": "string", "maxLength": 8192, "description": "The sizes it comes in, in a stack or a carousel whose view names them: an <img>'s srcset (url 1000w, url 2000w), narrowest first; absent where it names none." }
}
},
"galleryInfo": {
"type": "object",
"description": "A line of a photo's info, its parts' words joined.",
"required": ["text"],
"properties": {
"text": { "type": "string", "maxLength": 3000 }
}
},
"facesProps": {
"type": "object",
"description": "A few accounts' faces, overlapping, and words: lead, the names, and how many more; or, of style pile, the faces alone, each opening its account, a way to list them all where it expands.",
"required": ["faces", "count"],
"properties": {
"faces": { "type": "array", "maxLength": 100, "items": { "type": "ref", "ref": "#face" }, "description": "The first few's pictures, drawn small and round, the first two with their names; of a pile, every one's, each with its name." },
"count": { "type": "integer", "minimum": 1, "description": "How many there are." },
"lead": { "type": "string", "maxLength": 400, "description": "Before the names (Followed by)." },
"countNoun": { "type": "ref", "ref": "#countNoun", "description": "What the rest are (other you follow, others you follow)." },
"open": { "type": "ref", "ref": "#open" },
"style": { "type": "string", "maxLength": 16, "knownValues": ["pile"], "description": "pile: the faces alone, an avatar's size, the first max, past them +N, as a photo app's notification shows who favorited a gallery. Present only for pile." },
"max": { "type": "integer", "minimum": 1, "maximum": 8, "description": "A pile's: how many faces it draws." },
"expand": { "type": "boolean", "description": "A pile's: it lists them all, each its face, name and handle, opening its account. Present only when true." }
}
},
"face": {
"type": "object",
"description": "An account's picture, null where it has none (a placeholder drawn), and in a Faces' first two or a pile, its name; its handle and what it opens where it has them.",
"required": ["src"],
"nullable": ["src"],
"properties": {
"src": { "type": "ref", "ref": "#picture" },
"name": { "type": "string", "maxLength": 640, "description": "Its name, said in the words." },
"handle": { "type": "string", "maxLength": 640, "description": "Its handle, under its name where a pile lists them all." },
"open": { "type": "ref", "ref": "#open", "description": "What it opens: its account." }
}
},
"countNoun": {
"type": "object",
"description": "What something counted is called, one and many.",
"required": ["one", "many"],
"properties": {
"one": { "type": "string", "maxLength": 64 },
"many": { "type": "string", "maxLength": 64 }
}
},
"coversProps": {
"type": "object",
"description": "A grid of cover cards (#coverItem).",
"properties": {
"page": { "type": "boolean", "description": "As a List's." },
"style": { "type": "string", "knownValues": ["tiles"], "description": "tiles: square pictures edge to edge, without words; absent: cards." },
"select": { "type": "ref", "ref": "#coversSelect" },
"min": { "type": "ref", "ref": "#size", "description": "As a List grid's: the narrowest cover." },
"columns": { "type": "integer", "minimum": 1, "maximum": 6, "description": "As a List grid's: the most across." }
}
},
"coversSelect": {
"type": "object",
"description": "Picking some of the covers (those with a pick) and calling a procedure for each, one after another, once asked: as one deletes several of one's own galleries. The view is drawn again after.",
"required": ["label", "action", "one", "many", "method", "service"],
"properties": {
"label": { "type": "string", "maxLength": 400, "description": "The button that starts picking: Select." },
"action": { "type": "string", "maxLength": 400, "description": "What is done to those picked: Delete." },
"one": { "type": "string", "maxLength": 400, "description": "What one is called: gallery." },
"many": { "type": "string", "maxLength": 400, "description": "What several are called: galleries." },
"confirm": { "type": "string", "maxLength": 3000, "description": "Said after the question (Delete 3 galleries?)." },
"tone": { "type": "string", "maxLength": 16, "knownValues": ["danger"], "description": "danger: the action in the danger colour." },
"method": { "type": "string", "format": "nsid", "description": "The procedure called for each picked." },
"service": { "type": "string", "maxLength": 2048, "description": "The service it is called at: a DID and its #fragment." }
}
},
"coverItem": {
"type": "object",
"description": "A cover card, opening what it stands for.",
"required": ["src", "title", "count", "stat", "date", "labels"],
"nullable": ["src", "title", "count", "stat", "date"],
"properties": {
"open": { "type": "ref", "ref": "#open" },
"src": { "type": "ref", "ref": "#picture" },
"title": { "type": "string" },
"count": { "type": "string", "description": "Written out, as 16 photos." },
"stat": { "type": "ref", "ref": "#coverStat" },
"date": { "type": "string", "description": "The timestamp, as the data gave it." },
"labels": { "type": "array", "items": { "type": "string" }, "description": "The self-labels that hide its picture until shown." },
"many": { "type": "boolean", "description": "It holds more than one picture, marked so on a tile." },
"pick": { "type": "unknown", "description": "Where it may be picked (coversSelect): the input its call takes." }
}
},
"coverStat": {
"type": "object",
"description": "A number on a cover card, beside its count. Its value is a JSON number, which may have a fraction, so not declared here.",
"properties": {
"icon": { "type": "string", "knownValues": ["heart", "repost", "reply", "star", "play", "comment", "fork"] }
}
},
"mapProps": {
"type": "object",
"description": "A map with pins (#mapPin), drawn over OpenStreetMap's tiles on the web and Apple's maps on iOS.",
"required": ["height"],
"properties": {
"height": { "type": "string", "knownValues": ["short", "tall"], "description": "short: a page's header, still; tall: a map to move and zoom." },
"zoom": { "type": "integer", "minimum": 1, "maximum": 18, "description": "Centred on its pins at this zoom (1, the world; 18, a street). Absent: fitted to its pins, no closer than zoom 11." },
"bleed": { "type": "boolean", "description": "As an Image's: to the edges of what holds it, square-cornered. Present only when true." },
"pins": { "type": "boolean", "description": "false: no pin drawn, the map still placed by them, a plain map of where they are. Present only when false." }
}
},
"mapPin": {
"type": "object",
"description": "A pin, at lat and lng, in degrees: JSON numbers with fractions, which no lexicon type holds, so not declared here.",
"properties": {
"label": { "type": "string", "description": "What it is, as a place's name." },
"count": { "type": "integer", "minimum": 0, "description": "How many it stands for, as a place's galleries." },
"open": { "type": "ref", "ref": "#open" }
}
},
"playerProps": {
"type": "object",
"description": "An audio player's track list (#playerItem).",
"properties": {
"page": { "type": "boolean", "description": "As a List's." }
}
},
"playerItem": {
"type": "object",
"description": "A track. Its duration, in seconds, is a JSON number, which may have a fraction, or null, so not declared here.",
"required": ["src", "title", "subtitle", "art"],
"nullable": ["src", "title", "subtitle", "art"],
"properties": {
"src": { "type": "string", "description": "The audio; null where nothing may play." },
"title": { "type": "string" },
"subtitle": { "type": "string" },
"subtitleOpen": { "type": "ref", "ref": "#open", "description": "What its subtitle opens, as an artist's account." },
"art": { "type": "ref", "ref": "#picture" }
}
},
"profileProps": {
"type": "object",
"description": "An account's profile card. It always draws.",
"required": ["avatar", "banner"],
"nullable": ["avatar", "banner"],
"properties": {
"name": { "type": "string" },
"handle": { "type": "string", "description": "Without its leading @." },
"open": { "type": "ref", "ref": "#open", "description": "The account its handle names." },
"description": { "type": "string", "description": "No longer sent: descriptionRuns." },
"descriptionRuns": { "type": "array", "items": { "type": "ref", "ref": "#run" }, "description": "Its description, its links, @mentions and #tags found as Bluesky's app finds them." },
"avatar": { "type": "ref", "ref": "#picture", "description": "Drawn small." },
"banner": { "type": "ref", "ref": "#picture", "description": "Drawn large." }
}
},
"fieldsProps": {
"type": "object",
"description": "A record's fields read through its lexicon (fields, extra), or with none its value as it is (json).",
"properties": {
"uri": { "type": "string", "description": "The record's at-uri, drawn as a card under it; absent where a list's card is its frame." },
"fields": { "type": "array", "items": { "type": "ref", "ref": "#field" }, "description": "Those its lexicon names: the required first, then the rest, in its order." },
"extra": { "type": "array", "items": { "type": "ref", "ref": "#field" }, "description": "Those its lexicon does not name." },
"json": { "type": "unknown", "description": "The record's value, drawn open two levels." }
}
},
"field": {
"type": "object",
"description": "A field: its name, a small tag of its type, and its value as it is drawn.",
"required": ["name", "tag", "value"],
"properties": {
"name": { "type": "string" },
"tag": { "type": "string", "description": "Its format, or its type (unknown where its lexicon names none)." },
"value": { "type": "ref", "ref": "#fieldValue" }
}
},
"fieldValue": {
"type": "object",
"description": "A field's value as what it is drawn as, by kind: text { text, mono }, datetime { iso }, scalar { text }, record { uri, open }, link { url }, actor { actor, label, open }, image { src, mimeType, size }, audio { url, mimeType, size }, file { mimeType, size }, array { items, inline }, group { type, fields }, json { value }. A json value is anything at all, so not declared here.",
"required": ["kind"],
"nullable": ["src", "size", "type"],
"properties": {
"kind": { "type": "string", "knownValues": ["text", "datetime", "scalar", "record", "link", "actor", "image", "audio", "file", "array", "group", "json"] },
"text": { "type": "string" },
"mono": { "type": "boolean", "description": "An identifier, drawn in the monospace face." },
"iso": { "type": "string" },
"uri": { "type": "string" },
"open": { "type": "ref", "ref": "#open" },
"url": { "type": "string" },
"actor": { "type": "string", "description": "A DID or a handle." },
"label": { "type": "string", "description": "Its verified handle (@handle), or its DID." },
"src": { "type": "ref", "ref": "#picture" },
"mimeType": { "type": "string" },
"size": { "type": "integer", "description": "In bytes; null where unknown." },
"items": { "type": "array", "items": { "type": "ref", "ref": "#fieldValue" } },
"inline": { "type": "boolean", "description": "Every item is a short word or a number, drawn as chips." },
"type": { "type": "string", "description": "An object's $type, where it has one." },
"fields": { "type": "array", "items": { "type": "ref", "ref": "#field" } }
}
},
"jsonProps": {
"type": "object",
"description": "A value as it is, as a collapsible tree. The value is anything at all, so not declared here.",
"required": ["open"],
"properties": {
"open": { "type": "integer", "minimum": 0, "description": "How many levels are drawn open." }
}
},
"contentWarningProps": {
"type": "object",
"description": "A warning over its children; with no labels, its children as they are.",
"required": ["labels"],
"properties": {
"labels": { "type": "array", "items": { "type": "string" } },
"key": { "type": "string", "maxLength": 16, "description": "What it hides, for a reveal kept as it is drawn again; present with labels." }
}
},
"documentProps": {
"type": "object",
"description": "A long-form document's content read into blocks.",
"required": ["look", "blocks"],
"properties": {
"look": { "type": "string", "knownValues": ["leaflet", "markdown", "plain"], "description": "How its blocks are drawn." },
"blocks": { "type": "array", "items": { "type": "ref", "ref": "#block" } }
}
},
"block": {
"type": "object",
"description": "A block of text with structure, by kind: paragraph { runs }; heading { level, runs }; list { ordered, start?, tight?, items }; code { text, lang? }; quote { blocks }; rule; table { head, rows }; footnotes { items }, in the order they are first referred to; details { runs, blocks, expanded? }, markdown's <details>, its summary's runs and the blocks it hides; image { src, alt, ratio, width? }; gallery { images }; card { kicker, title, description?, image, open? }; button { label, open? }; bskyPost { uri, quote?, fallback }; gap; unsupported { text }; json { value }. An image's ratio, width over height, is a number with a fraction, and a json block's value anything at all, so neither is declared here.",
"required": ["kind"],
"nullable": ["src", "image"],
"properties": {
"kind": { "type": "string", "knownValues": ["paragraph", "heading", "list", "code", "quote", "rule", "table", "footnotes", "details", "image", "gallery", "card", "button", "bskyPost", "gap", "unsupported", "json"] },
"align": { "type": "string", "knownValues": ["center", "right", "justify"], "description": "A Leaflet block's own alignment." },
"runs": { "type": "array", "items": { "type": "ref", "ref": "#run" } },
"level": { "type": "integer", "minimum": 1, "maximum": 6 },
"ordered": { "type": "boolean" },
"start": { "type": "integer", "minimum": 0, "description": "Where an ordered list starts, where that is not 1." },
"tight": { "type": "boolean", "description": "Its items' paragraphs are drawn without their space." },
"expanded": { "type": "boolean", "description": "Details' own: it starts open." },
"items": { "type": "array", "items": { "type": "ref", "ref": "#blockItem" }, "description": "A list's items, or the footnotes." },
"text": { "type": "string" },
"lang": { "type": "string", "description": "The language its fence names." },
"blocks": { "type": "array", "items": { "type": "ref", "ref": "#block" } },
"head": { "type": "array", "items": { "type": "unknown" }, "description": "A table's head: its cells, each an array of #run." },
"rows": { "type": "array", "items": { "type": "unknown" }, "description": "A table's rows, each an array of cells, each an array of #run." },
"src": { "type": "ref", "ref": "#picture", "description": "An image's; null for a value that is no blob." },
"alt": { "type": "string" },
"width": { "type": "integer", "minimum": 1, "description": "An image's: the most CSS pixels it is drawn across, where its picture says; absent, as wide as its place." },
"images": { "type": "array", "items": { "type": "ref", "ref": "#blockImage" } },
"kicker": { "type": "string" },
"title": { "type": "string" },
"description": { "type": "string" },
"image": { "type": "ref", "ref": "#picture", "description": "A card's, drawn small." },
"open": { "type": "ref", "ref": "#open" },
"label": { "type": "string" },
"uri": { "type": "string", "description": "A Bluesky post's at-uri." },
"quote": { "type": "ref", "ref": "#embedProps", "description": "The post as an embed's quote, once the tool fetched it." },
"fallback": { "type": "ref", "ref": "#block", "description": "The block drawn without the post." }
}
},
"blockItem": {
"type": "object",
"description": "A list's item, or a footnote.",
"required": ["blocks"],
"properties": {
"check": { "type": "boolean", "description": "A task's, done or not." },
"blocks": { "type": "array", "items": { "type": "ref", "ref": "#block" } }
}
},
"blockImage": {
"type": "object",
"description": "A gallery block's picture, drawn small. Its ratio is a number with a fraction or null, so not declared here.",
"required": ["src", "alt"],
"nullable": ["src", "alt"],
"properties": {
"src": { "type": "ref", "ref": "#picture" },
"alt": { "type": "string" }
}
},
"embedProps": {
"type": "object",
"description": "A Bluesky post's embed as it is shown, by kind: images { images }; external { url, title, description, host, thumb, gif }; video { src, hls, poster, ratio, alt, watch }; quote { author, when, runs, open, embed }, a quoted post; post { uri, quote?, fallback }, a raw quote of a post, quote the post as a quote embed once the tool fetched it, else fallback, a compact card; gone { text }; card { avatar, title, byline, detail, open, compact? }, a feed, list, starter pack or labeler, or a record quoted raw; recordWithMedia { media, record }. A video's ratio, width over height, is a number with a fraction, so not declared here.",
"required": ["kind"],
"nullable": ["url", "description", "host", "thumb", "src", "hls", "poster", "watch", "when", "runs", "open", "embed", "avatar", "detail", "media", "record"],
"properties": {
"kind": { "type": "string", "knownValues": ["images", "external", "video", "quote", "post", "gone", "card", "recordWithMedia"] },
"images": { "type": "array", "items": { "type": "ref", "ref": "#embedImage" } },
"url": { "type": "string", "description": "An external link's page." },
"title": { "type": "string" },
"description": { "type": "string" },
"host": { "type": "string", "description": "An external link's host, without www." },
"thumb": { "type": "ref", "ref": "#picture" },
"gif": { "type": "boolean", "description": "An external link's picture is a GIF, drawn large." },
"src": { "type": "string", "description": "A video's stream, played from the server." },
"hls": { "type": "string", "maxLength": 2048, "description": "A video's HLS playlist on Bluesky's video service, played where the platform plays HLS, before src." },
"poster": { "type": "string", "description": "A video's poster picture." },
"alt": { "type": "string" },
"watch": { "type": "string", "description": "Where a video with no stream is watched: its post on bsky.app." },
"author": { "type": "ref", "ref": "#embedAuthor" },
"when": { "type": "string", "description": "A quoted post's timestamp, as the data gave it." },
"runs": { "type": "array", "items": { "type": "ref", "ref": "#run" } },
"open": { "type": "ref", "ref": "#open" },
"embed": { "type": "ref", "ref": "#embedProps", "description": "A quoted post's own embed, one level down." },
"uri": { "type": "string", "description": "A raw quote's at-uri." },
"quote": { "type": "ref", "ref": "#embedProps" },
"fallback": { "type": "ref", "ref": "#embedProps" },
"text": { "type": "string", "description": "Why a quoted post is gone." },
"avatar": { "type": "ref", "ref": "#picture" },
"byline": { "type": "string" },
"detail": { "type": "string", "description": "A card's count, written out." },
"compact": { "type": "boolean", "description": "A record quoted raw: drawn small." },
"media": { "type": "ref", "ref": "#embedProps" },
"record": { "type": "ref", "ref": "#embedProps" }
}
},
"embedImage": {
"type": "object",
"description": "An embed's picture. Its ratio, width over height, a quarter to 4, is a number with a fraction, so not declared here.",
"required": ["src", "full", "alt"],
"nullable": ["src", "full"],
"properties": {
"src": { "type": "ref", "ref": "#picture", "description": "Drawn small." },
"full": { "type": "string", "description": "Its full size, an http(s) page to open." },
"alt": { "type": "string" }
}
},
"embedAuthor": {
"type": "object",
"description": "A quoted post's author.",
"required": ["name", "handle", "avatar"],
"nullable": ["handle", "avatar"],
"properties": {
"name": { "type": "string" },
"handle": { "type": "string" },
"avatar": { "type": "ref", "ref": "#picture" }
}
},
"feedContextProps": {
"type": "object",
"description": "What a feed item's post comes with: above it, why it is in the feed (reason) and the posts it replies to (thread); or, under its author, what it replied to (replyTo).",
"properties": {
"reason": { "type": "ref", "ref": "#feedReason" },
"thread": { "type": "ref", "ref": "#feedThread" },
"replyTo": { "type": "ref", "ref": "#feedReplyTo" }
}
},
"feedReason": {
"type": "object",
"description": "Why an item is in its feed: reposted (by name, opening the reposter), or pinned.",
"required": ["kind"],
"properties": {
"kind": { "type": "string", "knownValues": ["repost", "pin"] },
"name": { "type": "string" },
"open": { "type": "ref", "ref": "#open" }
}
},
"feedThread": {
"type": "object",
"description": "The posts a reply replies to: its thread's top where that is not its parent, a gap where posts between are left out, whom the parent replied to, and its parent; each post a #treeItem.",
"required": ["parent"],
"properties": {
"top": { "type": "ref", "ref": "#treeItem" },
"gap": { "type": "ref", "ref": "#feedGap" },
"repliedTo": { "type": "string", "description": "The name of whom the parent replied to." },
"parent": { "type": "ref", "ref": "#treeItem" }
}
},
"feedGap": {
"type": "object",
"description": "Posts left out of a thread: View full thread.",
"required": ["open"],
"nullable": ["open"],
"properties": {
"open": { "type": "ref", "ref": "#open" }
}
},
"feedReplyTo": {
"type": "object",
"description": "What a post replied to, under its author.",
"required": ["label"],
"properties": {
"label": { "type": "string", "description": "Replied to its author, a blocked post or a post." },
"open": { "type": "ref", "ref": "#open" }
}
},
"actionProps": {
"type": "object",
"description": "A button that writes as the signed-in account: exactly one of create, delete, interaction and call. The client stamps {\"$now\": true} in a record it creates or an input it sends.",
"required": ["label", "done", "key"],
"properties": {
"label": { "type": "string" },
"done": { "type": "string", "description": "Its label once it succeeded." },
"icon": { "type": "string", "knownValues": ["heart", "repost", "trash", "plus", "minus", "reply", "comment", "pin", "pinned", "up", "down"] },
"compose": { "type": "string", "maxLength": 400, "description": "No longer drawn: a box to write in is a Compose (#composeProps)." },
"key": { "type": "string", "maxLength": 16, "description": "What it is, for state kept as it is drawn again." },
"create": { "type": "ref", "ref": "#actionCreate" },
"delete": { "type": "ref", "ref": "#actionDelete" },
"interaction": { "type": "ref", "ref": "#actionInteraction" },
"call": { "type": "ref", "ref": "#procedureCall" },
"existing": { "type": "string", "description": "With create, the at-uri of the record the account already made: it starts done." },
"count": { "type": "integer", "minimum": 0, "description": "How many there are, as a post's likes, the account's own among them where it starts done: drawn as the icon and this number, counted up or down as it is done or undone, its label read aloud." },
"style": { "type": "string", "maxLength": 16, "knownValues": ["button", "row"], "description": "button: drawn as a button of its own, filled until done and outlined once done, as a profile's Follow; row: drawn as a row of a List with style rows, the whole width, joining the rows right before it (Settings' Delete account after Sign out); absent: compact, as a count beside it." },
"confirm": { "type": "string", "maxLength": 3000, "description": "A question asked before it writes (Block @alice?), in a trusted view too." },
"tone": { "type": "string", "maxLength": 16, "knownValues": ["danger"], "description": "danger: drawn in the danger colour, as Block and Delete." },
"leave": { "type": "boolean", "description": "Once it succeeds, the screen it is on closes, as deleting the gallery shown." },
"reload": { "type": "boolean", "description": "Once it succeeds, the view is read again, as deleting a comment in it." },
"repeat": { "type": "boolean", "description": "With call, a view's deletes that repeats: called again until its answer's output.done is true, each output.deleted the records it deleted, as an account's data." },
"signOut": { "type": "boolean", "description": "Once it succeeds, the host signs the account out, as deleting one's account; a host that does not sign out draws it not." },
"handle": { "type": "string", "maxLength": 253, "description": "With confirm, the account's handle, which the person types to confirm." }
}
},
"composeProps": {
"type": "object",
"description": "A button opening a form to write (a reply, a post, a gallery): sent, its values fill writes through apply_writes, and the tree is drawn again.",
"required": ["key", "label", "send", "fields", "given", "writes"],
"properties": {
"key": { "type": "string", "maxLength": 16, "description": "What it is, for a draft kept as it is drawn again." },
"label": { "type": "string", "maxLength": 400, "description": "The button's words, read aloud." },
"send": { "type": "string", "maxLength": 400, "description": "The form's primary button's word." },
"icon": { "type": "string", "maxLength": 32, "knownValues": ["reply", "comment", "plus", "quote", "photo"] },
"count": { "type": "integer", "minimum": 0, "description": "Drawn beside the icon, as a counted Action's." },
"style": { "type": "string", "maxLength": 16, "knownValues": ["button", "field"], "description": "button: drawn as an Action with style button is, a button of its own (a profile's New gallery); field: drawn as a field to write in, the whole width, holding prompt (a gallery's Add a comment… under its comments)." },
"prompt": { "type": "string", "maxLength": 400, "description": "With style field: the words the field holds." },
"signIn": { "type": "string", "maxLength": 400, "description": "Drawn where the form can't be sent because no one is signed in and the app can sign someone in, starting signing in (Sign in to comment); without it, nothing is drawn there but a count." },
"form": { "type": "string", "maxLength": 16, "knownValues": ["photo"], "description": "photo: drawn as a photo app's review of the one photo it takes (a story): its first field's photo, once picked, full-bleed, a place field from it a chip over the photo's foot." },
"call": { "type": "ref", "ref": "#procedureCall", "description": "In place of writes (then empty): the procedure called, the form's values set on its input by their names (a report)." },
"title": { "type": "string", "maxLength": 2000, "description": "The form's title, where not its label." },
"about": { "type": "string", "maxLength": 3000, "description": "A line over its fields: who is answered, the post quoted." },
"fields": { "type": "array", "maxLength": 10, "items": { "type": "ref", "ref": "#composeField" }, "description": "What it asks, in order." },
"given": { "type": "unknown", "description": "Values the view fixed, an object of names: sent with the fields' values." },
"writes": { "type": "array", "maxLength": 8, "items": { "type": "ref", "ref": "#composeWrite" }, "description": "The writes template, sent back as it is to apply_writes." },
"open": { "type": "boolean", "description": "Its form opens at once, once, where the tree is first drawn in a browser or an app (never on a server): the screen was opened at it (the query's compose), as one's own empty stories at Add to your story. A photo form of a camera field goes to the camera first where it can. Present only when true." }
}
},
"composeField": {
"type": "object",
"description": "One thing a composer asks: its name (what its writes read), its kind, and the keys that kind takes.",
"required": ["name", "kind"],
"properties": {
"name": { "type": "string", "maxLength": 32, "description": "Lowercase letters and digits." },
"kind": { "type": "string", "maxLength": 16, "knownValues": ["text", "line", "photos", "langs", "labels", "choice", "place", "card"] },
"label": { "type": "string", "maxLength": 400, "maxGraphemes": 40 },
"required": { "type": "boolean" },
"placeholder": { "type": "string", "maxLength": 800, "maxGraphemes": 80, "description": "Text or line: shown while it is empty." },
"max": { "type": "integer", "minimum": 1, "description": "Text or line: the most grapheme clusters it holds, the view's narrowed by its record's lexicon's maxGraphemes (left out where neither gives one); photos: photos; langs: languages." },
"min": { "type": "integer", "minimum": 0, "maximum": 10, "description": "Photos: the fewest sent." },
"facets": { "type": "boolean", "description": "Text: its links, mentions and tags are marked as written." },
"suggest": { "type": "unknown", "description": "Text: the query whose answers suggest accounts as @ is typed: { method, service?, param, params?, items, did, handle, name?, avatar? }." },
"alt": { "type": "boolean", "description": "Photos: each has its alt text asked." },
"exif": { "type": "boolean", "description": "Photos: each one's camera details are read and sent (false where the account's preference says not)." },
"maxBytes": { "type": "integer", "minimum": 1, "description": "Photos: the most bytes one is sent at, made smaller to fit. Text or line: the most UTF-8 bytes it holds, its record's lexicon's maxLength. Sending waits while either limit is passed." },
"maxSide": { "type": "integer", "minimum": 1, "description": "Photos: the longest side one is sent at, in pixels." },
"round": { "type": "boolean", "description": "Photos: drawn round, as an avatar: the picture it opens showing and the one picked." },
"camera": { "type": "boolean", "description": "Photos: taking one with the device's camera is offered beside picking one; where it has none, picking." },
"options": { "type": "array", "maxLength": 8, "items": { "type": "ref", "ref": "#composeOption" }, "description": "Labels or choice: what may be chosen." },
"multiple": { "type": "boolean", "description": "Choice: more than one may be chosen." },
"from": { "type": "string", "maxLength": 32, "description": "Card: the field whose first link the card is made from. Place: the photos field whose first located photo's place fills it while none is picked (left out where the account's preference says not)." },
"value": { "type": "string", "maxLength": 8192, "description": "Text or line: the words it opens holding (a profile's name, a reply's @handle of whom it answers)." },
"picture": { "type": "ref", "ref": "#picture", "description": "Photos: the picture it opens showing, kept unless another is picked (a profile's avatar)." }
}
},
"composeOption": {
"type": "object",
"description": "One option of a labels or choice field, and its value, what choosing it sends: any JSON value (a label's word, a threadgate's rules, null for none), so not declared here.",
"required": ["label"],
"properties": {
"label": { "type": "string", "maxLength": 400, "maxGraphemes": 40 },
"only": { "type": "boolean", "description": "Chosen, it is the only one chosen." }
}
},
"composeWrite": {
"type": "object",
"description": "One write of a composer's template (crate::compose), sent back as it is; its when, the 1 to 4 names of values that must be there for it to be made, an array of names, and its update, the one record it replaces (read first, the fields its record names set over it, {\"$stored\": path} reading it; created where there is none), a record key (self) or {\"$value\": name} holding one (a gallery's, given), a string or an object, so neither declared here.",
"required": ["collection", "record"],
"properties": {
"collection": { "type": "string", "format": "nsid" },
"record": { "type": "unknown", "description": "The record, a template of the values written and given." },
"as": { "type": "string", "maxLength": 32, "description": "Its name, for another write's $uri or $rkey." },
"each": { "type": "string", "maxLength": 32, "description": "A value whose elements each make one of it." },
"whenItem": { "type": "string", "maxLength": 64, "description": "With each: a path within the element that must be there." },
"rkey": { "type": "unknown", "description": "Its record key: {\"$rkey\": as}, another write's." }
}
},
"actionCreate": {
"type": "object",
"description": "A record to create.",
"required": ["collection", "record"],
"properties": {
"collection": { "type": "string", "maxLength": 317, "description": "Its collection's NSID." },
"record": { "type": "unknown", "description": "The record, its bindings read; {\"$now\": true} left for the client." }
}
},
"procedureCall": {
"type": "object",
"description": "A procedure a trusted view calls as the signed-in account, through call_procedure.",
"required": ["method", "service", "input"],
"properties": {
"method": { "type": "string", "format": "nsid", "description": "The procedure." },
"service": { "type": "string", "maxLength": 2048, "description": "The service: a DID and its service's #fragment." },
"input": { "type": "unknown", "description": "Its input, its bindings read; {\"$now\": true} and {\"$text\": true} left for the client." }
}
},
"actionDelete": {
"type": "object",
"description": "A record to delete.",
"required": ["uri"],
"properties": {
"uri": { "type": "string", "description": "Its at-uri." }
}
},
"actionInteraction": {
"type": "object",
"description": "What an item's feed is told the person thinks of it: a trusted view's alone.",
"required": ["event", "report"],
"properties": {
"event": { "type": "string", "description": "As app.bsky.feed.defs#requestMore." },
"report": { "type": "ref", "ref": "#itemReport" }
}
},
"errorProps": {
"type": "object",
"description": "Where a component could not draw.",
"required": ["component", "message"],
"properties": {
"component": { "type": "string", "maxLength": 64, "description": "The component that could not draw." },
"message": { "type": "string", "description": "Why." }
}
}
}
}