@colibri-social/lexicons 2.12.1 → 2.14.0

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

@@ -13,12 +13,25 @@
 						"text": {
 							"type": "string",
 							"description": "The status text. Absent leaves the current value unchanged.",
-							"maxLength": 32
+							"maxLength": 64
 						},
 						"emoji": {
 							"type": "string",
 							"description": "An emoji shown beside the status. Absent leaves the current value unchanged."
 						},
+						"expiresAt": {
+							"type": "string",
+							"format": "datetime",
+							"description": "When the status clears. Absent leaves the current value unchanged. Takes precedence over removeExpiresAt."
+						},
+						"removeExpiresAt": {
+							"type": "boolean",
+							"description": "Removes the status expiry, so the status stays until it is changed. Ignored when expiresAt is also given."
+						},
+						"showWhileOffline": {
+							"type": "boolean",
+							"description": "Whether a client shows the status while the user is offline. Absent leaves the current value unchanged."
+						},
 						"onlineState": {
 							"type": "string",
 							"description": "Derived online state. Absent leaves the current value unchanged.",

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/putReadCursors.json

@@ -4,7 +4,7 @@
 	"defs": {
 		"main": {
 			"type": "procedure",
-			"description": "Pushes the requesting user's read cursors for one community to the AppView, so unread counts update immediately instead of waiting for a sync notification. The client writes its social.colibri.beta.channel.read record for the community to its own personal space first, then calls this. Clients should debounce this rather than calling it on every message.",
+			"description": "Pushes the requesting user's read cursors for one community to the AppView, so unread counts update immediately instead of waiting for a sync notification. The client writes its social.colibri.beta.channel.read record for the community to its own personal space first, then calls this. Clients should debounce this rather than calling it on every message. The user's other sessions receive the cursors that moved as a social.colibri.beta.sync.defs#readCursorEvent.",
 			"input": {
 				"encoding": "application/json",
 				"schema": {
@@ -18,7 +18,7 @@
 						},
 						"cursors": {
 							"type": "array",
-							"description": "The complete, replacement set of read cursors for the community's channels.",
+							"description": "Read cursors for the community's channels and threads. Each one replaces the stored cursor only when it is newer, and channels left out keep their stored cursor.",
 							"items": {
 								"type": "ref",
 								"ref": "social.colibri.beta.channel.read#cursor"

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

@@ -29,6 +29,10 @@
 						"requiresApprovalToJoin": {
 							"type": "boolean",
 							"description": "Whether joining produces an application a moderator must approve. Defaults to false."
+						},
+						"overrideUserNameColors": {
+							"type": "boolean",
+							"description": "Whether only role colours are shown in chat. Members' own name colours are hidden, and a member without a coloured role shows the default name colour. Defaults to false."
 						}
 					}
 				}

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

@@ -56,6 +56,15 @@
 					"type": "boolean",
 					"description": "Whether link previews are shown by default."
 				},
+				"overrideUserNameColors": {
+					"type": "boolean",
+					"description": "Whether only role colours are shown in chat. Members' own name colours are hidden, and a member without a coloured role shows the default name colour. Absent means false."
+				},
+				"customEmoji": {
+					"type": "string",
+					"knownValues": ["all", "local", "none"],
+					"description": "Which custom emoji render in this community. all allows custom emoji from any source, local only the community's own emoji, none disables custom emoji. Disallowed emoji show their fallback text. Absent means all."
+				},
 				"labelers": {
 					"type": "array",
 					"items": {
@@ -142,6 +151,50 @@
 						"ref": "#channelView"
 					},
 					"description": "Channels in display order."
+				},
+				"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."
+					}
+				},
+				"private": {
+					"type": "boolean",
+					"description": "Whether the category restricts who may read its channels."
 				}
 			}
 		},
@@ -275,6 +328,11 @@
 					"description": "Hex colour as #rrggbb.",
 					"maxLength": 7
 				},
+				"badge": {
+					"type": "union",
+					"refs": ["#roleIconBadge", "#roleImageBadgeView"],
+					"description": "The role's badge, if it has one."
+				},
 				"permissions": {
 					"type": "array",
 					"items": {
@@ -341,6 +399,36 @@
 				}
 			}
 		},
+		"roleIconBadge": {
+			"type": "object",
+			"description": "A role badge drawn from the client's curated icon set.",
+			"required": ["icon"],
+			"properties": {
+				"icon": {
+					"type": "string",
+					"minLength": 1,
+					"maxLength": 64,
+					"description": "The icon's identifier in the client's curated set, for example shield-check."
+				},
+				"color": {
+					"type": "string",
+					"maxLength": 7,
+					"description": "Hex colour as #rrggbb. Absent means the role colour, or the client's default badge colour."
+				}
+			}
+		},
+		"roleImageBadgeView": {
+			"type": "object",
+			"description": "A badge drawn from an uploaded image.",
+			"required": ["image"],
+			"properties": {
+				"image": {
+					"type": "string",
+					"format": "uri",
+					"description": "URL of the badge image, served by this AppView's blob proxy."
+				}
+			}
+		},
 		"memberView": {
 			"type": "object",
 			"description": "An admitted community member.",

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

@@ -29,6 +29,17 @@
 						"default": true,
 						"description": "Whether link previews are shown by default. Channels may override this."
 					},
+					"overrideUserNameColors": {
+						"type": "boolean",
+						"default": false,
+						"description": "Whether only role colours are shown in chat. Members' own name colours are hidden, and a member without a coloured role shows the default name colour. Defaults to false."
+					},
+					"customEmoji": {
+						"type": "string",
+						"knownValues": ["all", "local", "none"],
+						"default": "all",
+						"description": "Which custom emoji render in this community. all allows custom emoji from any source, local only the community's own emoji, none disables custom emoji. Disallowed emoji show their fallback text. Defaults to all."
+					},
 					"labelers": {
 						"type": "array",
 						"items": {

package/lexicons/social/colibri/beta/community/transferOwnership.json

@@ -0,0 +1,78 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.beta.community.transferOwnership",
+	"defs": {
+		"main": {
+			"type": "procedure",
+			"description": "Hands the community's protected owner role from the caller to another member. The subject gains every protected role the caller holds, then the caller loses them. The caller keeps their other roles.",
+			"input": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["community", "subject"],
+					"properties": {
+						"community": {
+							"type": "string",
+							"format": "did",
+							"description": "The community whose ownership is transferred."
+						},
+						"subject": {
+							"type": "string",
+							"format": "did",
+							"description": "The member who becomes the owner."
+						}
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["owner", "previousOwner"],
+					"properties": {
+						"owner": {
+							"type": "ref",
+							"ref": "social.colibri.beta.community.defs#memberView",
+							"description": "The new owner, with their updated roles."
+						},
+						"previousOwner": {
+							"type": "ref",
+							"ref": "social.colibri.beta.community.defs#memberView",
+							"description": "The caller, with their updated roles."
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request is missing, malformed, or unverifiable service auth."
+				},
+				{
+					"name": "Forbidden",
+					"description": "The caller does not hold a protected owner role in this community."
+				},
+				{
+					"name": "CommunityNotFound",
+					"description": "No community exists with that DID."
+				},
+				{
+					"name": "MemberNotFound",
+					"description": "The subject does not hold a member record in this community."
+				},
+				{
+					"name": "Banned",
+					"description": "The subject is banned from this community."
+				},
+				{
+					"name": "AlreadyOwner",
+					"description": "The subject already holds a protected owner role."
+				},
+				{
+					"name": "CredentialsUnavailable",
+					"description": "The AppView's stored credentials for this community are missing or unusable."
+				}
+			]
+		}
+	}
+}

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

@@ -43,6 +43,15 @@
 								"description": "A labeler."
 							},
 							"description": "DIDs whose labels this community honours."
+						},
+						"overrideUserNameColors": {
+							"type": "boolean",
+							"description": "Whether only role colours are shown in chat. Members' own name colours are hidden, and a member without a coloured role shows the default name colour."
+						},
+						"customEmoji": {
+							"type": "string",
+							"knownValues": ["all", "local", "none"],
+							"description": "Which custom emoji render in this community. all allows custom emoji from any source, local only the community's own emoji, none disables custom emoji. Disallowed emoji show their fallback text."
 						}
 					}
 				}

package/lexicons/social/colibri/beta/notification/registerPush.json

@@ -4,7 +4,7 @@
 	"defs": {
 		"main": {
 			"type": "procedure",
-			"description": "Registers a push endpoint for the requesting user's device. Web Push requires endpoint, p256dh, and auth. FCM requires token.",
+			"description": "Registers a push endpoint for the requesting user's device. Web Push requires endpoint, p256dh, and auth. FCM requires token. APNs requires token and environment.",
 			"input": {
 				"encoding": "application/json",
 				"schema": {
@@ -14,12 +14,12 @@
 						"provider": {
 							"type": "string",
 							"description": "The push provider to register with.",
-							"knownValues": ["webpush", "fcm"]
+							"knownValues": ["webpush", "fcm", "apns"]
 						},
 						"platform": {
 							"type": "string",
 							"description": "The platform the device runs.",
-							"knownValues": ["web", "ios", "android"]
+							"knownValues": ["web", "ios", "android", "macos"]
 						},
 						"endpoint": {
 							"type": "string",
@@ -36,7 +36,12 @@
 						},
 						"token": {
 							"type": "string",
-							"description": "The FCM registration token. Required when provider is fcm."
+							"description": "The FCM registration token or the hex-encoded APNs device token. Required when provider is fcm or apns."
+						},
+						"environment": {
+							"type": "string",
+							"description": "The APNs environment the device token belongs to. Required when provider is apns.",
+							"knownValues": ["sandbox", "production"]
 						}
 					}
 				}

package/lexicons/social/colibri/beta/notification/unregisterPush.json

@@ -14,7 +14,7 @@
 						"provider": {
 							"type": "string",
 							"description": "The push provider to unregister from.",
-							"knownValues": ["webpush", "fcm"]
+							"knownValues": ["webpush", "fcm", "apns"]
 						},
 						"endpoint": {
 							"type": "string",
@@ -23,7 +23,7 @@
 						},
 						"token": {
 							"type": "string",
-							"description": "The FCM registration token to remove."
+							"description": "The FCM registration token or APNs device token to remove."
 						}
 					}
 				}

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

@@ -78,6 +78,7 @@
 						"social.colibri.beta.community.migrate",
 						"social.colibri.beta.community.registerCredentials",
 						"social.colibri.beta.community.setMemberRoles",
+						"social.colibri.beta.community.transferOwnership",
 						"social.colibri.beta.community.reorderCategories",
 						"social.colibri.beta.community.createInvitation",
 						"social.colibri.beta.community.listInvitations",
@@ -103,6 +104,7 @@
 						"social.colibri.beta.role.create",
 						"social.colibri.beta.role.update",
 						"social.colibri.beta.role.delete",
+						"social.colibri.beta.role.putBadgeImage",
 						"social.colibri.beta.voice.moderate",
 						"social.colibri.beta.thread.delete",
 						"social.colibri.beta.thread.repoint",

package/lexicons/social/colibri/beta/richtext/facet.json

@@ -33,7 +33,8 @@
 							"#role",
 							"#channel",
 							"#link",
-							"#time"
+							"#time",
+							"#customEmoji"
 						]
 					},
 					"description": "What the range means. A range may carry more than one feature."
@@ -232,6 +233,23 @@
 					"description": "How to render it."
 				}
 			}
+		},
+		"customEmoji": {
+			"type": "object",
+			"description": "A custom emoji. The text under the facet is the emoji's fallback: a Unicode alternative when the emoji has one, otherwise its :name: shortcode.",
+			"required": ["uri"],
+			"properties": {
+				"uri": {
+					"type": "string",
+					"format": "at-uri",
+					"description": "The emoji record. Its collection identifies the emoji lexicon, for example blue.moji.collection.item."
+				},
+				"cid": {
+					"type": "string",
+					"format": "cid",
+					"description": "The version of the emoji record the message was written against."
+				}
+			}
 		}
 	}
 }

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

@@ -35,6 +35,11 @@
 							"maxLength": 7,
 							"description": "Hex colour as #rrggbb."
 						},
+						"badge": {
+							"type": "ref",
+							"ref": "social.colibri.beta.community.defs#roleIconBadge",
+							"description": "An icon badge. Image badges are set with social.colibri.beta.role.putBadgeImage."
+						},
 						"position": {
 							"type": "integer",
 							"description": "Hierarchy position. Higher outranks lower."