@colibri-social/lexicons

Every Colibri Social schema, the space type declarations, and the TypeScript generated from them.

Layout

• lexicons/social/colibri/**: Colibri's own schemas
• lexicons/com/atproto/{space,memberspace,managedspace,personalspace}/**: vendored from bluesky-social/atproto, pinned to the commit in lexicons/com/atproto/PINNED_COMMIT. Do not edit them!
• src/generated/**: produced by pnpm codegen, verified by CI

The atproto space lexicons

lexicons/com/atproto/PINNED_COMMIT holds a commit hash, and CI fetches every vendored file from bluesky-social/atproto at that commit and fails if a single byte differs.

To move the pin:

ref=<new commit sha>
for f in packages/lexicons/lexicons/com/atproto/{space,memberspace,managedspace,personalspace}/*.json; do
  rel="lexicons/com/atproto/${f#packages/lexicons/lexicons/com/atproto/}"
  curl -sfL "https://raw.githubusercontent.com/bluesky-social/atproto/$ref/$rel" -o "$f"
done
printf '%s\n' "$ref" > packages/lexicons/lexicons/com/atproto/PINNED_COMMIT
pnpm codegen

Then read the diff. A re-vendor is a protocol change and needs a changeset.

Space types

Seven, each a lexicon whose main is "type": "space". The name field is what an OAuth consent screen shows a user, so it is written for people, not developers. Which space holds what is at the docs.

A channel is a space. The space key is the channel's identity and its configuration is the record at key self inside it, which is why the channel record carries no community or category field.

Conventions the test enforces

src/conformance.test.ts fails the build on any of these:

• a document whose id does not match its path
• a reference that does not resolve, uses the legacy lex: prefix, or spells out its own document instead of using #name
• a method with no declared errors, an error that is not PascalCase, or an error with no description
• a limit parameter that is not an integer with a minimum and a default, or an output that marks cursor required
• a definition or property with no description
• an em dash or a semicolon in any description
• a space type listing a collection that is not a defined record, or with no consent-screen name
• a permission set naming a method or space type that does not exist
• a method not covered by any permission set, which is what stops a new endpoint shipping that no client can be granted

Commands

pnpm --filter @colibri-social/lexicons codegen