@colibri-social/lexicons 2.13.0 → 2.15.0

package/lexicons/social/colibri/beta/actor/clientPreferences.json

@@ -0,0 +1,78 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.beta.actor.clientPreferences",
+	"defs": {
+		"main": {
+			"type": "record",
+			"description": "Client settings that follow the user across devices. Every field is optional and a client applies its own default for an absent one.",
+			"key": "literal:self",
+			"record": {
+				"type": "object",
+				"required": [],
+				"properties": {
+					"controls": {
+						"type": "ref",
+						"ref": "social.colibri.beta.actor.defs#controls",
+						"description": "Touch gestures in a channel."
+					},
+					"theme": {
+						"type": "string",
+						"knownValues": ["system", "dark", "light"],
+						"description": "The color theme. system follows the operating system."
+					},
+					"messagePreviews": {
+						"type": "boolean",
+						"description": "Whether the channel list shows the latest message under each channel name."
+					},
+					"linkEmbedsByDefault": {
+						"type": "boolean",
+						"description": "Whether a link in a new message gets a preview by default."
+					},
+					"warnOnExternalLinks": {
+						"type": "boolean",
+						"description": "Whether opening a link to another site asks for confirmation first."
+					},
+					"blueskyClient": {
+						"type": "string",
+						"maxLength": 64,
+						"knownValues": [
+							"anisota",
+							"blacksky",
+							"bluesky",
+							"deer",
+							"mu",
+							"northsky",
+							"witchsky",
+							"custom"
+						],
+						"description": "The client that Bluesky posts and profiles open in."
+					},
+					"customBlueskyClientBase": {
+						"type": "string",
+						"maxLength": 253,
+						"description": "The domain of the client used when blueskyClient is custom."
+					},
+					"developerMode": {
+						"type": "boolean",
+						"description": "Whether the client shows identifiers and links to inspect records."
+					},
+					"voiceView": {
+						"type": "ref",
+						"ref": "social.colibri.beta.actor.defs#voiceView",
+						"description": "Options for voice channels."
+					},
+					"experiments": {
+						"type": "array",
+						"maxLength": 64,
+						"items": {
+							"type": "string",
+							"maxLength": 64,
+							"description": "An experiment id."
+						},
+						"description": "The experiments the user turned on."
+					}
+				}
+			}
+		}
+	}
+}

package/lexicons/social/colibri/beta/actor/composerState.json

@@ -0,0 +1,41 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.beta.actor.composerState",
+	"defs": {
+		"main": {
+			"type": "record",
+			"description": "Emoji usage, skin tone and recent GIFs, kept apart from social.colibri.beta.actor.clientPreferences because it changes with every message.",
+			"key": "literal:self",
+			"record": {
+				"type": "object",
+				"required": [],
+				"properties": {
+					"emojiUsage": {
+						"type": "array",
+						"maxLength": 50,
+						"items": {
+							"type": "ref",
+							"ref": "social.colibri.beta.actor.defs#emojiUse"
+						},
+						"description": "The emoji the user picks most, with counts."
+					},
+					"skinTone": {
+						"type": "integer",
+						"minimum": 0,
+						"maximum": 5,
+						"description": "The skin tone for emoji that support one. 0 is the default yellow."
+					},
+					"recentGifs": {
+						"type": "array",
+						"maxLength": 24,
+						"items": {
+							"type": "ref",
+							"ref": "social.colibri.beta.embed.defs#gifView"
+						},
+						"description": "The GIFs the user sent last, newest first, stored whole."
+					}
+				}
+			}
+		}
+	}
+}

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

@@ -208,7 +208,7 @@
 				"notificationLevel": {
 					"type": "string",
 					"description": "Which messages produce a notification.",
-					"knownValues": ["all", "mentionsAndReplies"]
+					"knownValues": ["all", "mentionsAndReplies", "nothing"]
 				},
 				"communityOrder": {
 					"type": "array",
@@ -238,6 +238,24 @@
 				"shareActivity": {
 					"type": "boolean",
 					"description": "Whether the AppView may read what the user is listening to and show it to others."
+				},
+				"spaceNotifications": {
+					"type": "array",
+					"items": {
+						"type": "ref",
+						"ref": "#spaceNotification"
+					},
+					"description": "Notification levels the user set for single communities. A community without an entry follows notificationLevel."
+				},
+				"clientPreferences": {
+					"type": "ref",
+					"ref": "#clientPreferences",
+					"description": "Client settings that follow the user across devices."
+				},
+				"composerState": {
+					"type": "ref",
+					"ref": "#composerState",
+					"description": "Emoji usage, skin tone and recent GIFs."
 				}
 			}
 		},
@@ -294,6 +312,186 @@
 					"description": "The muted thread's space."
 				}
 			}
+		},
+		"spaceNotification": {
+			"type": "object",
+			"description": "A notification level for one community.",
+			"required": ["community", "level"],
+			"properties": {
+				"community": {
+					"type": "string",
+					"format": "did",
+					"description": "The community."
+				},
+				"level": {
+					"type": "string",
+					"knownValues": ["all", "mentionsAndReplies", "nothing"],
+					"description": "Which messages in this community produce a notification."
+				}
+			}
+		},
+		"clientPreferences": {
+			"type": "object",
+			"description": "Client settings that follow the user across devices. Every field is optional and a client applies its own default for an absent one.",
+			"properties": {
+				"controls": {
+					"type": "ref",
+					"ref": "#controls",
+					"description": "Touch gestures in a channel."
+				},
+				"theme": {
+					"type": "string",
+					"knownValues": ["system", "dark", "light"],
+					"description": "The color theme. system follows the operating system."
+				},
+				"messagePreviews": {
+					"type": "boolean",
+					"description": "Whether the channel list shows the latest message under each channel name."
+				},
+				"linkEmbedsByDefault": {
+					"type": "boolean",
+					"description": "Whether a link in a new message gets a preview by default."
+				},
+				"warnOnExternalLinks": {
+					"type": "boolean",
+					"description": "Whether opening a link to another site asks for confirmation first."
+				},
+				"blueskyClient": {
+					"type": "string",
+					"maxLength": 64,
+					"knownValues": [
+						"anisota",
+						"blacksky",
+						"bluesky",
+						"deer",
+						"mu",
+						"northsky",
+						"witchsky",
+						"custom"
+					],
+					"description": "The client that Bluesky posts and profiles open in."
+				},
+				"customBlueskyClientBase": {
+					"type": "string",
+					"maxLength": 253,
+					"description": "The domain of the client used when blueskyClient is custom."
+				},
+				"developerMode": {
+					"type": "boolean",
+					"description": "Whether the client shows identifiers and links to inspect records."
+				},
+				"voiceView": {
+					"type": "ref",
+					"ref": "#voiceView",
+					"description": "Options for voice channels."
+				},
+				"experiments": {
+					"type": "array",
+					"maxLength": 64,
+					"items": {
+						"type": "string",
+						"maxLength": 64,
+						"description": "An experiment id."
+					},
+					"description": "The experiments the user turned on."
+				}
+			}
+		},
+		"controls": {
+			"type": "object",
+			"description": "Touch gestures in a channel.",
+			"properties": {
+				"swipeLeftAction": {
+					"type": "string",
+					"knownValues": ["members", "reply"],
+					"description": "What swiping left on a message does."
+				},
+				"doubleTapEnabled": {
+					"type": "boolean",
+					"description": "Whether double tapping a message does anything."
+				},
+				"doubleTapAction": {
+					"type": "string",
+					"knownValues": ["react", "editOrReply"],
+					"description": "What double tapping a message does."
+				},
+				"doubleTapReactionEmoji": {
+					"type": "string",
+					"maxLength": 64,
+					"maxGraphemes": 1,
+					"description": "The emoji a double tap reacts with."
+				}
+			}
+		},
+		"voiceView": {
+			"type": "object",
+			"description": "Options for voice channels.",
+			"properties": {
+				"confirmJoin": {
+					"type": "boolean",
+					"description": "Whether opening a voice channel waits for the user to press join."
+				},
+				"showNonVideoParticipants": {
+					"type": "boolean",
+					"description": "Whether the call grid shows participants without video."
+				},
+				"showOwnCamera": {
+					"type": "boolean",
+					"description": "Whether the call grid shows the user's own camera."
+				}
+			}
+		},
+		"composerState": {
+			"type": "object",
+			"description": "Emoji usage, skin tone and recent GIFs.",
+			"properties": {
+				"emojiUsage": {
+					"type": "array",
+					"maxLength": 50,
+					"items": {
+						"type": "ref",
+						"ref": "#emojiUse"
+					},
+					"description": "The emoji the user picks most, with counts."
+				},
+				"skinTone": {
+					"type": "integer",
+					"minimum": 0,
+					"maximum": 5,
+					"description": "The skin tone for emoji that support one. 0 is the default yellow."
+				},
+				"recentGifs": {
+					"type": "array",
+					"maxLength": 24,
+					"items": {
+						"type": "ref",
+						"ref": "social.colibri.beta.embed.defs#gifView"
+					},
+					"description": "The GIFs the user sent last, newest first, stored whole."
+				}
+			}
+		},
+		"emojiUse": {
+			"type": "object",
+			"description": "How often and how recently the user picked one emoji.",
+			"required": ["emoji", "count", "lastUsed"],
+			"properties": {
+				"emoji": {
+					"type": "string",
+					"maxLength": 512,
+					"description": "A Unicode emoji, or a custom emoji's AT URI."
+				},
+				"count": {
+					"type": "integer",
+					"minimum": 1,
+					"description": "How many times the user picked it."
+				},
+				"lastUsed": {
+					"type": "string",
+					"format": "datetime",
+					"description": "When the user last picked it."
+				}
+			}
 		}
 	}
 }

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

@@ -14,10 +14,11 @@
 						"type": "union",
 						"refs": [
 							"social.colibri.beta.actor.defs#mutedActor",
-							"social.colibri.beta.actor.defs#mutedChannel"
+							"social.colibri.beta.actor.defs#mutedChannel",
+							"social.colibri.beta.actor.defs#mutedThread"
 						],
 						"closed": true,
-						"description": "What is muted. A user or a community is named by DID, a channel by its space."
+						"description": "What is muted. A user or a community is named by DID, a channel or a thread by its space."
 					},
 					"createdAt": {
 						"type": "string",

package/lexicons/social/colibri/beta/actor/putSettings.json

@@ -13,7 +13,7 @@
 						"notificationLevel": {
 							"type": "string",
 							"description": "Which messages produce a notification. Absent leaves the current value unchanged.",
-							"knownValues": ["all", "mentionsAndReplies"]
+							"knownValues": ["all", "mentionsAndReplies", "nothing"]
 						},
 						"communityOrder": {
 							"type": "array",
@@ -35,6 +35,16 @@
 						"shareActivity": {
 							"type": "boolean",
 							"description": "Whether the AppView may show what the user is listening to. Absent leaves the current value unchanged."
+						},
+						"clientPreferences": {
+							"type": "ref",
+							"ref": "social.colibri.beta.actor.defs#clientPreferences",
+							"description": "The contents of the user's social.colibri.beta.actor.clientPreferences record. Replaces the stored copy whole. Absent leaves the current value unchanged."
+						},
+						"composerState": {
+							"type": "ref",
+							"ref": "social.colibri.beta.actor.defs#composerState",
+							"description": "The contents of the user's social.colibri.beta.actor.composerState record. Replaces the stored copy whole. Absent leaves the current value unchanged."
 						}
 					}
 				}

package/lexicons/social/colibri/beta/actor/putSpaceNotification.json

@@ -0,0 +1,57 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.beta.actor.putSpaceNotification",
+	"defs": {
+		"main": {
+			"type": "procedure",
+			"description": "Pushes one of the requesting user's social.colibri.beta.actor.spaceNotification records to the AppView, so it takes effect immediately instead of waiting for a sync notification. The client writes or deletes the record in its own personal space first, then calls this.",
+			"input": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["community"],
+					"properties": {
+						"community": {
+							"type": "string",
+							"format": "did",
+							"description": "The community."
+						},
+						"level": {
+							"type": "string",
+							"knownValues": ["all", "mentionsAndReplies", "nothing"],
+							"description": "The new level. Absent together with removeLevel returns the community to the global level."
+						},
+						"removeLevel": {
+							"type": "boolean",
+							"description": "Removes the community's level so it follows the global one. Ignored when level is present."
+						}
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["preferences"],
+					"properties": {
+						"preferences": {
+							"type": "ref",
+							"ref": "social.colibri.beta.actor.defs#preferences",
+							"description": "The requesting user's settings, after the update."
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request has no valid service auth."
+				},
+				{
+					"name": "InvalidRequest",
+					"description": "Neither level nor removeLevel is present, or level does not hold an allowed value."
+				}
+			]
+		}
+	}
+}

package/lexicons/social/colibri/beta/actor/settings.json

@@ -12,7 +12,7 @@
 				"properties": {
 					"notificationLevel": {
 						"type": "string",
-						"knownValues": ["all", "mentionsAndReplies"],
+						"knownValues": ["all", "mentionsAndReplies", "nothing"],
 						"default": "all",
 						"description": "Which messages produce a notification."
 					},

package/lexicons/social/colibri/beta/actor/spaceNotification.json

@@ -0,0 +1,27 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.beta.actor.spaceNotification",
+	"defs": {
+		"main": {
+			"type": "record",
+			"description": "A notification level for one community, overriding the level in social.colibri.beta.actor.settings. The record key is the community's DID. Deleting the record returns the community to the global level.",
+			"key": "any",
+			"record": {
+				"type": "object",
+				"required": ["level", "createdAt"],
+				"properties": {
+					"level": {
+						"type": "string",
+						"knownValues": ["all", "mentionsAndReplies", "nothing"],
+						"description": "Which messages in this community produce a notification."
+					},
+					"createdAt": {
+						"type": "string",
+						"format": "datetime",
+						"description": "When the level was set."
+					}
+				}
+			}
+		}
+	}
+}

package/lexicons/social/colibri/beta/bridge/defs.json

@@ -211,6 +211,11 @@
 					"format": "did",
 					"description": "The community the registration belongs to."
 				},
+				"communityName": {
+					"type": "string",
+					"maxLength": 32,
+					"description": "The community's name, when the AppView knows it."
+				},
 				"bridge": {
 					"type": "string",
 					"format": "did",

package/lexicons/social/colibri/beta/category/create.json

@@ -21,6 +21,46 @@
 							"minLength": 1,
 							"maxLength": 32,
 							"description": "The category's name."
+						},
+						"ownerOnly": {
+							"type": "boolean",
+							"description": "Whether only community admins may post in the category's channels. A channel that sets its own posting restriction overrides this."
+						},
+						"allowedRoles": {
+							"type": "array",
+							"items": {
+								"type": "string",
+								"format": "record-key",
+								"description": "A role permitted to post."
+							},
+							"description": "Roles allowed to post in the category's channels. Empty means no role restriction. A channel that sets its own posting restriction overrides this."
+						},
+						"allowedMembers": {
+							"type": "array",
+							"items": {
+								"type": "string",
+								"format": "did",
+								"description": "A member permitted to post."
+							},
+							"description": "Members allowed to post in the category's channels in addition to allowedRoles."
+						},
+						"visibleToRoles": {
+							"type": "array",
+							"description": "Roles that may read the category's channels. Empty or absent means every member may read them. A channel with its own non-empty visibleToRoles or visibleToMembers overrides this. A non-empty list makes the category's other channels private, enforced the same way as a private channel.",
+							"items": {
+								"type": "string",
+								"format": "record-key",
+								"description": "A role permitted to read."
+							}
+						},
+						"visibleToMembers": {
+							"type": "array",
+							"description": "Members that may read the category's channels in addition to visibleToRoles.",
+							"items": {
+								"type": "string",
+								"format": "did",
+								"description": "A member permitted to read."
+							}
 						}
 					}
 				}
@@ -46,7 +86,7 @@
 				},
 				{
 					"name": "Forbidden",
-					"description": "The caller lacks the category.create permission."
+					"description": "The caller lacks the category.create permission, or grants visibility to a role at or above their own highest position."
 				},
 				{
 					"name": "CommunityNotFound",

package/lexicons/social/colibri/beta/category/update.json

@@ -4,7 +4,7 @@
 	"defs": {
 		"main": {
 			"type": "procedure",
-			"description": "Updates a category's name.",
+			"description": "Updates a category's name and the permissions its channels inherit.",
 			"input": {
 				"encoding": "application/json",
 				"schema": {
@@ -26,6 +26,46 @@
 							"minLength": 1,
 							"maxLength": 32,
 							"description": "The category's new name."
+						},
+						"ownerOnly": {
+							"type": "boolean",
+							"description": "Whether only community admins may post in the category's channels. Absent leaves the current value unchanged."
+						},
+						"allowedRoles": {
+							"type": "array",
+							"items": {
+								"type": "string",
+								"format": "record-key",
+								"description": "A role permitted to post."
+							},
+							"description": "Roles allowed to post in the category's channels. Absent leaves the current value unchanged."
+						},
+						"allowedMembers": {
+							"type": "array",
+							"items": {
+								"type": "string",
+								"format": "did",
+								"description": "A member permitted to post."
+							},
+							"description": "Members allowed to post in the category's channels in addition to allowedRoles. Absent leaves the current value unchanged."
+						},
+						"visibleToRoles": {
+							"type": "array",
+							"description": "Roles that may read the category's channels. Absent leaves the current value unchanged.",
+							"items": {
+								"type": "string",
+								"format": "record-key",
+								"description": "A role permitted to read."
+							}
+						},
+						"visibleToMembers": {
+							"type": "array",
+							"description": "Members that may read the category's channels in addition to visibleToRoles. Absent leaves the current value unchanged.",
+							"items": {
+								"type": "string",
+								"format": "did",
+								"description": "A member permitted to read."
+							}
 						}
 					}
 				}
@@ -51,7 +91,7 @@
 				},
 				{
 					"name": "Forbidden",
-					"description": "The caller lacks the category.update permission."
+					"description": "The caller lacks the category.update permission, or grants visibility to a role at or above their own highest position."
 				},
 				{
 					"name": "CommunityNotFound",

package/lexicons/social/colibri/beta/category.json

@@ -24,6 +24,47 @@
 							"description": "The space key of a channel in this category."
 						},
 						"description": "The channels in this category, in display order, by space key."
+					},
+					"ownerOnly": {
+						"type": "boolean",
+						"default": false,
+						"description": "Whether only community admins may post in the category's channels. A channel that sets its own posting restriction overrides this."
+					},
+					"allowedRoles": {
+						"type": "array",
+						"items": {
+							"type": "string",
+							"format": "record-key",
+							"description": "A role permitted to post."
+						},
+						"description": "Roles allowed to post in the category's channels. Empty means no role restriction. A channel that sets its own posting restriction overrides this."
+					},
+					"allowedMembers": {
+						"type": "array",
+						"items": {
+							"type": "string",
+							"format": "did",
+							"description": "A member permitted to post."
+						},
+						"description": "Members allowed to post in the category's channels in addition to allowedRoles."
+					},
+					"visibleToRoles": {
+						"type": "array",
+						"description": "Roles that may read the category's channels. Empty or absent means every member may read them. A channel with its own non-empty visibleToRoles or visibleToMembers overrides this. A non-empty list makes the category's other channels private, enforced the same way as a private channel.",
+						"items": {
+							"type": "string",
+							"format": "record-key",
+							"description": "A role permitted to read."
+						}
+					},
+					"visibleToMembers": {
+						"type": "array",
+						"description": "Members that may read the category's channels in addition to visibleToRoles.",
+						"items": {
+							"type": "string",
+							"format": "did",
+							"description": "A member permitted to read."
+						}
 					}
 				}
 			}

package/lexicons/social/colibri/beta/channel/defs.json

@@ -216,6 +216,10 @@
 				"height": {
 					"type": "integer",
 					"description": "Intrinsic pixel height, when the file is a decodable image or video."
+				},
+				"spoiler": {
+					"type": "boolean",
+					"description": "Whether the author marked the file as a spoiler. Clients hide it behind a reveal step."
 				}
 			}
 		},