@colibri-social/lexicons 0.1.0

package/lexicons/com/atproto/space/registerNotify.json

@@ -0,0 +1,49 @@
+{
+  "lexicon": 1,
+  "id": "com.atproto.space.registerNotify",
+  "defs": {
+    "main": {
+      "type": "procedure",
+      "description": "Register a service to be notified of writes to any repo in a space. Called on the space host. The registering service is named by its service identifier rather than a bare URL, because notifyWrite is delivered with service auth addressed to that identifier; the delivery endpoint is resolved from the service's DID document. Authenticated with a space credential. Re-registering an existing service replaces its registration and extends the expiry.",
+      "input": {
+        "encoding": "application/json",
+        "schema": {
+          "type": "object",
+          "required": ["space", "service"],
+          "properties": {
+            "space": {
+              "type": "string",
+              "format": "space-ref",
+              "description": "Reference to the space."
+            },
+            "service": {
+              "type": "string",
+              "description": "Service identifier of the subscriber: a DID with an optional service fragment naming the entry in its DID document to deliver to (e.g. 'did:web:syncer.example.com#atproto_space_syncer'). notifyWrite calls are addressed to this identifier."
+            }
+          }
+        }
+      },
+      "output": {
+        "encoding": "application/json",
+        "schema": {
+          "type": "object",
+          "required": ["expiresAt"],
+          "properties": {
+            "expiresAt": {
+              "type": "string",
+              "format": "datetime",
+              "description": "When the registration expires. May be later than the expiry of the space credential the request was authenticated with; renew before this time to stay subscribed."
+            }
+          }
+        }
+      },
+      "errors": [
+        { "name": "SpaceNotFound" },
+        {
+          "name": "ServiceNotResolvable",
+          "description": "The service identifier could not be resolved to a DID document with a matching service endpoint."
+        }
+      ]
+    }
+  }
+}

package/lexicons/com/atproto/space/unregisterNotify.json

@@ -0,0 +1,29 @@
+{
+  "lexicon": 1,
+  "id": "com.atproto.space.unregisterNotify",
+  "defs": {
+    "main": {
+      "type": "procedure",
+      "description": "Withdraw a write-notification registration made through registerNotify. Called on the space host. Idempotent: succeeds whether or not a matching registration existed. Registrations also lapse on their own at the expiry returned by registerNotify, so this is for explicit withdrawal rather than cleanup. Authenticated with a space credential.",
+      "input": {
+        "encoding": "application/json",
+        "schema": {
+          "type": "object",
+          "required": ["space", "service"],
+          "properties": {
+            "space": {
+              "type": "string",
+              "format": "space-ref",
+              "description": "Reference to the space."
+            },
+            "service": {
+              "type": "string",
+              "description": "Service identifier of the subscriber to remove, as passed to registerNotify."
+            }
+          }
+        }
+      },
+      "errors": [{ "name": "SpaceNotFound" }]
+    }
+  }
+}

package/lexicons/social/colibri/actor/defs.json

@@ -0,0 +1,175 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.actor.defs",
+	"defs": {
+		"profileView": {
+			"type": "object",
+			"description": "A Colibri user as the AppView serves them: identity, resolved profile, and presence.",
+			"required": ["did", "handle", "displayName", "isBot", "syncBluesky"],
+			"properties": {
+				"did": {
+					"type": "string",
+					"format": "did",
+					"description": "The user's DID."
+				},
+				"handle": {
+					"type": "string",
+					"description": "The user's handle, or 'handle.invalid' when it does not resolve.",
+					"format": "handle"
+				},
+				"displayName": {
+					"type": "string",
+					"description": "Resolved display name, falling back to the handle."
+				},
+				"description": {
+					"type": "string",
+					"description": "Resolved bio."
+				},
+				"avatar": {
+					"type": "string",
+					"format": "uri",
+					"description": "URL of the user's avatar, served by this AppView's blob proxy."
+				},
+				"banner": {
+					"type": "string",
+					"format": "uri",
+					"description": "URL of the user's profile banner, served by this AppView's blob proxy."
+				},
+				"isBot": {
+					"type": "boolean",
+					"description": "Whether the account is labelled as an automated account."
+				},
+				"syncBluesky": {
+					"type": "boolean",
+					"description": "Whether the mirrored profile fields come from app.bsky.actor.profile."
+				},
+				"theme": {
+					"type": "ref",
+					"ref": "social.colibri.actor.profile#theme",
+					"description": "Colibri-only profile theming, read from the profile record even when the mirrored fields come from Bluesky."
+				},
+				"preferredBadge": {
+					"type": "string",
+					"description": "Label value of the badge the user chose to display."
+				},
+				"presence": {
+					"type": "ref",
+					"ref": "#presence",
+					"description": "Live presence, when the AppView is tracking any."
+				}
+			}
+		},
+		"presence": {
+			"type": "object",
+			"description": "A user's live, off-protocol state.",
+			"required": ["onlineState"],
+			"properties": {
+				"onlineState": {
+					"type": "string",
+					"description": "Derived online state.",
+					"knownValues": ["online", "away", "dnd", "offline"]
+				},
+				"status": {
+					"type": "ref",
+					"ref": "#status",
+					"description": "The user's status line."
+				},
+				"voice": {
+					"type": "ref",
+					"ref": "#voiceState",
+					"description": "Where the user is connected for voice, if anywhere."
+				}
+			}
+		},
+		"status": {
+			"type": "object",
+			"description": "A user's status line.",
+			"required": ["text"],
+			"properties": {
+				"text": {
+					"type": "string",
+					"description": "The status text.",
+					"maxLength": 32
+				},
+				"emoji": {
+					"type": "string",
+					"description": "An emoji shown beside the status."
+				}
+			}
+		},
+		"voiceState": {
+			"type": "object",
+			"description": "A user's voice connection.",
+			"required": ["channel"],
+			"properties": {
+				"channel": {
+					"type": "string",
+					"format": "space-ref",
+					"description": "The voice channel the user is connected to."
+				},
+				"muted": {
+					"type": "boolean",
+					"description": "Whether the user has muted their microphone."
+				},
+				"deafened": {
+					"type": "boolean",
+					"description": "Whether the user has deafened themselves."
+				}
+			}
+		},
+		"preferences": {
+			"type": "object",
+			"description": "The authenticated user's own settings, as the AppView currently holds them.",
+			"required": ["notificationLevel", "communityOrder", "mutes", "gifFavorites"],
+			"properties": {
+				"notificationLevel": {
+					"type": "string",
+					"description": "Which messages produce a notification.",
+					"knownValues": ["all", "mentionsAndReplies"]
+				},
+				"communityOrder": {
+					"type": "array",
+					"items": {
+						"type": "string",
+						"format": "did",
+						"description": "A community."
+					},
+					"description": "Communities in preferred sidebar order."
+				},
+				"mutes": {
+					"type": "array",
+					"items": {
+						"type": "ref",
+						"ref": "#mute"
+					},
+					"description": "Subjects the user has muted."
+				},
+				"gifFavorites": {
+					"type": "array",
+					"items": {
+						"type": "string",
+						"description": "A GIF identifier."
+					},
+					"description": "GIFs saved from the picker."
+				}
+			}
+		},
+		"mute": {
+			"type": "object",
+			"description": "A muted subject.",
+			"required": ["subject", "createdAt"],
+			"properties": {
+				"subject": {
+					"type": "string",
+					"format": "did",
+					"description": "The muted user or community."
+				},
+				"createdAt": {
+					"type": "string",
+					"format": "datetime",
+					"description": "When the mute was created."
+				}
+			}
+		}
+	}
+}

package/lexicons/social/colibri/actor/deleteAccount.json

@@ -0,0 +1,40 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.actor.deleteAccount",
+	"defs": {
+		"main": {
+			"type": "procedure",
+			"description": "Erases the requesting user's Colibri data held by this AppView. This does not touch the user's repos, which only they control.",
+			"input": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"properties": {}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["deleted"],
+					"properties": {
+						"deleted": {
+							"type": "integer",
+							"description": "How many indexed records were removed."
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request has no valid service auth."
+				},
+				{
+					"name": "SoleOwnerOfCommunity",
+					"description": "The user solely owns at least one community and must transfer or delete it before deleting their account."
+				}
+			]
+		}
+	}
+}

package/lexicons/social/colibri/actor/getDeletionStatus.json

@@ -0,0 +1,41 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.actor.getDeletionStatus",
+	"defs": {
+		"main": {
+			"type": "query",
+			"description": "Gets what would happen if the requesting user deleted their account.",
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["records", "notifications", "soleOwnedCommunities"],
+					"properties": {
+						"records": {
+							"type": "integer",
+							"description": "How many indexed records would be removed."
+						},
+						"notifications": {
+							"type": "integer",
+							"description": "How many notifications would be removed."
+						},
+						"soleOwnedCommunities": {
+							"type": "array",
+							"description": "Communities the user solely owns, which block deletion until transferred or deleted.",
+							"items": {
+								"type": "ref",
+								"ref": "social.colibri.community.defs#communityView"
+							}
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request has no valid service auth."
+				}
+			]
+		}
+	}
+}

package/lexicons/social/colibri/actor/getPreferences.json

@@ -0,0 +1,30 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.actor.getPreferences",
+	"defs": {
+		"main": {
+			"type": "query",
+			"description": "Gets the requesting user's own settings, as the AppView currently holds them.",
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["preferences"],
+					"properties": {
+						"preferences": {
+							"type": "ref",
+							"ref": "social.colibri.actor.defs#preferences",
+							"description": "The requesting user's settings."
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request has no valid service auth."
+				}
+			]
+		}
+	}
+}

package/lexicons/social/colibri/actor/getProfile.json

@@ -0,0 +1,45 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.actor.getProfile",
+	"defs": {
+		"main": {
+			"type": "query",
+			"description": "Gets a user's profile.",
+			"parameters": {
+				"type": "params",
+				"required": ["actor"],
+				"properties": {
+					"actor": {
+						"type": "string",
+						"description": "The user's DID or handle.",
+						"format": "at-identifier"
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["profile"],
+					"properties": {
+						"profile": {
+							"type": "ref",
+							"ref": "social.colibri.actor.defs#profileView",
+							"description": "The user's profile."
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request has no valid service auth."
+				},
+				{
+					"name": "ActorNotFound",
+					"description": "No user matches the given DID or handle."
+				}
+			]
+		}
+	}
+}

package/lexicons/social/colibri/actor/grantSpaceAccess.json

@@ -0,0 +1,68 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.actor.grantSpaceAccess",
+	"defs": {
+		"main": {
+			"type": "procedure",
+			"description": "Hands the AppView access to one of the requesting user's personal spaces. The client mints a delegation token on its own PDS for the space and passes it here, because a delegation token is single-use and short-lived and the AppView has no OAuth session of its own. The AppView exchanges the token for a space credential and syncs the space.",
+			"input": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["space", "delegationToken"],
+					"properties": {
+						"space": {
+							"type": "string",
+							"format": "space-ref",
+							"description": "The space to grant access to."
+						},
+						"delegationToken": {
+							"type": "string",
+							"description": "A delegation token minted by the user's PDS for the space."
+						}
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["expiresAt"],
+					"properties": {
+						"expiresAt": {
+							"type": "string",
+							"format": "datetime",
+							"description": "When the resulting space credential expires. The client should call this again before then to keep access current."
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request has no valid service auth."
+				},
+				{
+					"name": "InvalidRequest",
+					"description": "The arguments are inconsistent or malformed beyond schema validation."
+				},
+				{
+					"name": "InvalidDelegationToken",
+					"description": "The delegation token is malformed, expired, or already used."
+				},
+				{
+					"name": "SpaceNotFound",
+					"description": "No space matches the given space reference."
+				},
+				{
+					"name": "NotAuthorized",
+					"description": "The delegation token does not grant access to the given space."
+				},
+				{
+					"name": "UpstreamFailure",
+					"description": "The user's PDS failed while the AppView exchanged the delegation token or synced the space."
+				}
+			]
+		}
+	}
+}

package/lexicons/social/colibri/actor/listCommunities.json

@@ -0,0 +1,33 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.actor.listCommunities",
+	"defs": {
+		"main": {
+			"type": "query",
+			"description": "Gets the requesting user's communities, in their preferred order.",
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["communities"],
+					"properties": {
+						"communities": {
+							"type": "array",
+							"description": "The requesting user's communities, in preferred sidebar order.",
+							"items": {
+								"type": "ref",
+								"ref": "social.colibri.community.defs#communityView"
+							}
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request has no valid service auth."
+				}
+			]
+		}
+	}
+}

package/lexicons/social/colibri/actor/mute.json

@@ -0,0 +1,27 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.actor.mute",
+	"defs": {
+		"main": {
+			"type": "record",
+			"description": "A muted subject. One record per mute, so unmuting is a delete rather than a rewrite of a list.",
+			"key": "tid",
+			"record": {
+				"type": "object",
+				"required": ["subject", "createdAt"],
+				"properties": {
+					"subject": {
+						"type": "string",
+						"format": "did",
+						"description": "The muted user or community."
+					},
+					"createdAt": {
+						"type": "string",
+						"format": "datetime",
+						"description": "When the mute was created."
+					}
+				}
+			}
+		}
+	}
+}

package/lexicons/social/colibri/actor/preferences.json

@@ -0,0 +1,17 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.actor.preferences",
+	"defs": {
+		"main": {
+			"type": "space",
+			"description": "A user's own Colibri settings, mutes and read state.",
+			"key": "literal:self",
+			"name": "Colibri preferences",
+			"collections": [
+				"social.colibri.actor.mute",
+				"social.colibri.actor.settings",
+				"social.colibri.channel.read"
+			]
+		}
+	}
+}

package/lexicons/social/colibri/actor/profile.json

@@ -0,0 +1,93 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.actor.profile",
+	"defs": {
+		"main": {
+			"type": "record",
+			"description": "A Colibri profile. A public record on the user's own repo, kept separate from app.bsky.actor.profile so Colibri never needs write access to the Bluesky record.",
+			"key": "literal:self",
+			"record": {
+				"type": "object",
+				"required": [],
+				"properties": {
+					"displayName": {
+						"type": "string",
+						"maxGraphemes": 64,
+						"maxLength": 640,
+						"description": "Display name."
+					},
+					"description": {
+						"type": "string",
+						"maxGraphemes": 256,
+						"maxLength": 2560,
+						"description": "Bio."
+					},
+					"avatar": {
+						"type": "blob",
+						"accept": ["image/jpeg", "image/png", "image/gif", "image/webp"],
+						"description": "Avatar image."
+					},
+					"banner": {
+						"type": "blob",
+						"accept": ["image/jpeg", "image/png", "image/gif", "image/webp"],
+						"description": "Profile banner image."
+					},
+					"syncBluesky": {
+						"type": "boolean",
+						"default": false,
+						"description": "When true, displayName, description, avatar and banner are served from app.bsky.actor.profile instead of from this record."
+					},
+					"theme": {
+						"type": "ref",
+						"ref": "#theme",
+						"description": "Colibri-only profile theming."
+					},
+					"preferredBadge": {
+						"type": "string",
+						"maxLength": 64,
+						"description": "Label value of the badge to display. Absent means the highest-priority badge."
+					}
+				}
+			}
+		},
+		"theme": {
+			"type": "object",
+			"description": "Colibri-only profile theming. Always read from this record, even when syncBluesky is set.",
+			"required": [],
+			"properties": {
+				"accentColor": {
+					"type": "string",
+					"maxLength": 7,
+					"description": "Accent colour as #rrggbb."
+				},
+				"bannerColor": {
+					"type": "string",
+					"maxLength": 7,
+					"description": "Fallback banner colour as #rrggbb, used when no banner image is set."
+				},
+				"gradient": {
+					"type": "ref",
+					"ref": "#themeGradient",
+					"description": "Two-colour gradient."
+				}
+			}
+		},
+		"themeGradient": {
+			"type": "object",
+			"description": "A two-colour gradient.",
+			"required": [],
+			"properties": {
+				"primary": {
+					"type": "string",
+					"maxLength": 7,
+					"description": "Primary colour as #rrggbb."
+				},
+				"secondary": {
+					"type": "string",
+					"maxLength": 7,
+					"description": "Secondary colour as #rrggbb."
+				}
+			}
+		}
+	}
+}