social.showcase.defs

lexicons.showcase.social

Documentation

activitySettings object

Activity sharing preferences

Properties

retentionDays integer Required

Activity retention period

shareActivity string Required

Who sees your activity feed

maxLength: 10 bytes
Known values: all, followers, none
shareNewItems boolean Required

Share new items in followers' feeds

View raw schema 
{
  "type": "object",
  "required": [
    "shareNewItems",
    "shareActivity",
    "retentionDays"
  ],
  "properties": {
    "retentionDays": {
      "type": "integer",
      "default": 90,
      "description": "Activity retention period"
    },
    "shareActivity": {
      "type": "string",
      "maxLength": 10,
      "description": "Who sees your activity feed",
      "knownValues": [
        "all",
        "followers",
        "none"
      ]
    },
    "shareNewItems": {
      "type": "boolean",
      "description": "Share new items in followers' feeds"
    }
  },
  "description": "Activity sharing preferences"
}
aspectRatio object

Image aspect ratio

Properties

height integer Optional

No description available.

minimum: 1
width integer Optional

No description available.

minimum: 1
View raw schema 
{
  "type": "object",
  "properties": {
    "width": {
      "type": "integer",
      "minimum": 1
    },
    "height": {
      "type": "integer",
      "minimum": 1
    }
  },
  "description": "Image aspect ratio"
}
collectionItem object

Reference to an item in a collection

Properties

addedAt string datetime Required

An RFC 3339 formatted timestamp.

order integer Required

For custom sorting

uri string Required

AT-URI reference to item (always shows latest version)

maxLength: 8192 bytes
View raw schema 
{
  "type": "object",
  "required": [
    "uri",
    "addedAt",
    "order"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "maxLength": 8192,
      "description": "AT-URI reference to item (always shows latest version)"
    },
    "order": {
      "type": "integer",
      "description": "For custom sorting"
    },
    "addedAt": {
      "type": "string",
      "format": "datetime"
    }
  },
  "description": "Reference to an item in a collection"
}
collectionView object

View of a collection with items

Properties

author ref #profileView Required

No description available.

cid string cid Required

A content identifier (CID) referencing immutable data.

coverImage blob Optional

No description available.

createdAt string datetime Required

An RFC 3339 formatted timestamp.

description string Optional

No description available.

maxLength: 1000 bytes
itemCount integer Optional

No description available.

items array of ref#itemView Optional

No description available.

name string Required

No description available.

maxLength: 200 bytes
tags array of string Required

No description available.

type string Required

No description available.

maxLength: 20 bytes
updatedAt string datetime Optional

An RFC 3339 formatted timestamp.

uri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

visibility string Required

No description available.

maxLength: 10 bytes
View raw schema 
{
  "type": "object",
  "required": [
    "uri",
    "cid",
    "name",
    "tags",
    "type",
    "visibility",
    "author",
    "createdAt"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "name": {
      "type": "string",
      "maxLength": 200
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 64
      }
    },
    "type": {
      "type": "string",
      "maxLength": 20
    },
    "items": {
      "type": "array",
      "items": {
        "ref": "#itemView",
        "type": "ref"
      }
    },
    "author": {
      "ref": "#profileView",
      "type": "ref"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "itemCount": {
      "type": "integer"
    },
    "updatedAt": {
      "type": "string",
      "format": "datetime"
    },
    "coverImage": {
      "type": "blob"
    },
    "visibility": {
      "type": "string",
      "maxLength": 10
    },
    "description": {
      "type": "string",
      "maxLength": 1000
    }
  },
  "description": "View of a collection with items"
}
displaySettings object

Display preferences

Properties

gridLayout string Optional

No description available.

maxLength: 10 bytes
Known values: compact, spacious
theme string Optional

No description available.

maxLength: 10 bytes
Known values: light, dark, auto
View raw schema 
{
  "type": "object",
  "properties": {
    "theme": {
      "type": "string",
      "maxLength": 10,
      "knownValues": [
        "light",
        "dark",
        "auto"
      ]
    },
    "gridLayout": {
      "type": "string",
      "maxLength": 10,
      "knownValues": [
        "compact",
        "spacious"
      ]
    }
  },
  "description": "Display preferences"
}
itemImage object

Image embedded in an item

Properties

alt string Optional

Alt text for accessibility

maxLength: 300 bytes
aspectRatio ref #aspectRatio Optional

No description available.

blob blob Required

No description available.

maxSize: 5.0 MB
View raw schema 
{
  "type": "object",
  "required": [
    "blob"
  ],
  "properties": {
    "alt": {
      "type": "string",
      "maxLength": 300,
      "description": "Alt text for accessibility"
    },
    "blob": {
      "type": "blob",
      "accept": [
        "image/png",
        "image/jpeg",
        "image/webp"
      ],
      "maxSize": 5000000
    },
    "aspectRatio": {
      "ref": "#aspectRatio",
      "type": "ref"
    }
  },
  "description": "Image embedded in an item"
}
itemView object

View of an item with metadata

Properties

author ref #profileView Required

No description available.

category string Optional

No description available.

maxLength: 100 bytes
cid string cid Required

A content identifier (CID) referencing immutable data.

createdAt string datetime Required

An RFC 3339 formatted timestamp.

description string Optional

No description available.

maxLength: 3000 bytes
images array of ref#itemImage Required

No description available.

metadata unknown Optional

No description available.

reactionCount integer Optional

No description available.

tags array of string Required

No description available.

title string Required

No description available.

maxLength: 300 bytes
updatedAt string datetime Optional

An RFC 3339 formatted timestamp.

uri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

visibility string Required

No description available.

maxLength: 10 bytes
View raw schema 
{
  "type": "object",
  "required": [
    "uri",
    "cid",
    "title",
    "tags",
    "images",
    "visibility",
    "author",
    "createdAt"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 64
      }
    },
    "title": {
      "type": "string",
      "maxLength": 300
    },
    "author": {
      "ref": "#profileView",
      "type": "ref"
    },
    "images": {
      "type": "array",
      "items": {
        "ref": "#itemImage",
        "type": "ref"
      }
    },
    "category": {
      "type": "string",
      "maxLength": 100
    },
    "metadata": {
      "type": "unknown"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "updatedAt": {
      "type": "string",
      "format": "datetime"
    },
    "visibility": {
      "type": "string",
      "maxLength": 10
    },
    "description": {
      "type": "string",
      "maxLength": 3000
    },
    "externalLink": {
      "type": "string",
      "format": "uri",
      "maxLength": 2048
    },
    "reactionCount": {
      "type": "integer"
    }
  },
  "description": "View of an item with metadata"
}
notificationSettings object

Notification preferences

Properties

comments boolean Required

No description available.

follows boolean Required

No description available.

reactions boolean Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "reactions",
    "follows",
    "comments"
  ],
  "properties": {
    "follows": {
      "type": "boolean"
    },
    "comments": {
      "type": "boolean"
    },
    "reactions": {
      "type": "boolean"
    }
  },
  "description": "Notification preferences"
}
privacySettings object

Privacy preferences

Properties

allowComments boolean Required

Let others comment

allowReactions boolean Required

Let others react to your items

indexable boolean Required

Appear in search results

View raw schema 
{
  "type": "object",
  "required": [
    "allowReactions",
    "allowComments",
    "indexable"
  ],
  "properties": {
    "indexable": {
      "type": "boolean",
      "description": "Appear in search results"
    },
    "allowComments": {
      "type": "boolean",
      "description": "Let others comment"
    },
    "allowReactions": {
      "type": "boolean",
      "description": "Let others react to your items"
    }
  },
  "description": "Privacy preferences"
}
profileView object

View of a user profile

Properties

avatar blob Optional

No description available.

banner blob Optional

No description available.

did string Required

No description available.

maxLength: 2048 bytes
displayName string Optional

No description available.

maxLength: 64 bytes
handle string Required

No description available.

maxLength: 253 bytes
tags array of string Optional

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "did",
    "handle"
  ],
  "properties": {
    "did": {
      "type": "string",
      "maxLength": 2048
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 64
      }
    },
    "avatar": {
      "type": "blob"
    },
    "banner": {
      "type": "blob"
    },
    "handle": {
      "type": "string",
      "maxLength": 253
    },
    "displayName": {
      "type": "string",
      "maxLength": 64
    }
  },
  "description": "View of a user profile"
}
reactionSubject object

Subject of a reaction

Properties

cid string cid Required

A content identifier (CID) referencing immutable data.

uri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema 
{
  "type": "object",
  "required": [
    "uri",
    "cid"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    }
  },
  "description": "Subject of a reaction"
}
reactionView object

View of a reaction to content

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

type string Required

Emoji shortcode

maxLength: 100 bytes
uri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema 
{
  "type": "object",
  "required": [
    "uri",
    "actor",
    "subject",
    "type",
    "createdAt"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "type": {
      "type": "string",
      "maxLength": 100,
      "description": "Emoji shortcode"
    },
    "actor": {
      "ref": "#profileView",
      "type": "ref"
    },
    "subject": {
      "ref": "#reactionSubject",
      "type": "ref"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    }
  },
  "description": "View of a reaction to content"
}
showcaseItem object

A reference to an item featured in a user's showcase (hydrated at read time)

Properties

addedAt string datetime Required

An RFC 3339 formatted timestamp.

order integer Required

Display order (0 = first)

uri string at-uri Required

AT-URI reference to the item (e.g., at://did:plc:.../social.showcase.library.item/abc123)

View raw schema 
{
  "type": "object",
  "required": [
    "uri",
    "addedAt",
    "order"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT-URI reference to the item (e.g., at://did:plc:.../social.showcase.library.item/abc123)"
    },
    "order": {
      "type": "integer",
      "description": "Display order (0 = first)"
    },
    "addedAt": {
      "type": "string",
      "format": "datetime"
    }
  },
  "description": "A reference to an item featured in a user's showcase (hydrated at read time)"
}
visibilitySettings object

Visibility preferences

Properties

defaultCollectionVisibility string Required

No description available.

maxLength: 10 bytes
Known values: public, private
defaultItemVisibility string Required

No description available.

maxLength: 10 bytes
Known values: public, unlisted, private
profileVisibility string Required

No description available.

maxLength: 10 bytes
Known values: public, unlisted, private
View raw schema 
{
  "type": "object",
  "required": [
    "profileVisibility",
    "defaultItemVisibility",
    "defaultCollectionVisibility"
  ],
  "properties": {
    "profileVisibility": {
      "type": "string",
      "maxLength": 10,
      "knownValues": [
        "public",
        "unlisted",
        "private"
      ]
    },
    "defaultItemVisibility": {
      "type": "string",
      "maxLength": 10,
      "knownValues": [
        "public",
        "unlisted",
        "private"
      ]
    },
    "defaultCollectionVisibility": {
      "type": "string",
      "maxLength": 10,
      "knownValues": [
        "public",
        "private"
      ]
    }
  },
  "description": "Visibility preferences"
}

Lexicon Garden

@