@colibri-social/lexicons 2.31.0 → 2.33.0

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

@@ -0,0 +1,94 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.beta.community.getHosting",
+	"defs": {
+		"main": {
+			"type": "query",
+			"description": "Describes where a community's account lives and whether the AppView can still act for it. Only administrators of the community can read it.",
+			"parameters": {
+				"type": "params",
+				"required": ["community"],
+				"properties": {
+					"community": {
+						"type": "string",
+						"format": "did",
+						"description": "The community."
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["hosting"],
+					"properties": {
+						"hosting": {
+							"type": "ref",
+							"ref": "#hostingView",
+							"description": "Where the community's account lives."
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request is missing, malformed, or unverifiable service auth."
+				},
+				{
+					"name": "Forbidden",
+					"description": "The requesting user lacks permission for this community."
+				},
+				{
+					"name": "CommunityNotFound",
+					"description": "No community exists at that identifier."
+				}
+			]
+		},
+		"hostingView": {
+			"type": "object",
+			"required": ["kind", "account", "server", "needsSignIn"],
+			"properties": {
+				"kind": {
+					"type": "string",
+					"knownValues": ["colibri", "own"],
+					"description": "colibri when the account lives on this AppView's server and the AppView holds its password. own when the account belongs to the community's owner and the AppView acts through a sign-in."
+				},
+				"account": {
+					"type": "string",
+					"description": "The account's handle, or its DID when it has none."
+				},
+				"server": {
+					"type": "string",
+					"format": "uri",
+					"description": "The server the account lives on, as the AppView last reached it."
+				},
+				"connectedBy": {
+					"type": "string",
+					"format": "did",
+					"description": "The user who signed in as the account, for kind own."
+				},
+				"connectedAt": {
+					"type": "string",
+					"format": "datetime",
+					"description": "When the AppView was last connected to the account."
+				},
+				"needsSignIn": {
+					"type": "boolean",
+					"description": "Whether the AppView lost access and needs the owner to sign in again. New writes fail until then."
+				},
+				"needsSignInSince": {
+					"type": "string",
+					"format": "datetime",
+					"description": "When the AppView lost access."
+				},
+				"handOverExpiresAt": {
+					"type": "string",
+					"format": "datetime",
+					"description": "When the password from handOverHost stops working, while a hand-over is active."
+				}
+			},
+			"description": "Where a community's account lives and whether the AppView can act for it."
+		}
+	}
+}

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

@@ -0,0 +1,77 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.beta.community.handOverHost",
+	"defs": {
+		"main": {
+			"type": "procedure",
+			"description": "Gives an administrator access to a community account that lives on this AppView's server, so they can move it to another server. The AppView sets the given email on the account, so codes the server sends reach the administrator, and returns a new password once. The password works for 60 minutes. If the account has not moved by then, the AppView replaces it and signs out every session.",
+			"input": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["community", "email"],
+					"properties": {
+						"community": {
+							"type": "string",
+							"format": "did",
+							"description": "The community."
+						},
+						"email": {
+							"type": "string",
+							"maxLength": 254,
+							"description": "The address that receives the server's codes for the move."
+						}
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["identifier", "password", "expiresAt"],
+					"properties": {
+						"identifier": {
+							"type": "string",
+							"description": "The account's handle, to sign in with."
+						},
+						"password": {
+							"type": "string",
+							"description": "The account's new password. It is not shown again."
+						},
+						"expiresAt": {
+							"type": "string",
+							"format": "datetime",
+							"description": "When the password stops working."
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request is missing, malformed, or unverifiable service auth."
+				},
+				{
+					"name": "Forbidden",
+					"description": "The requesting user lacks permission for this community."
+				},
+				{
+					"name": "InvalidRequest",
+					"description": "The arguments are inconsistent or malformed beyond schema validation."
+				},
+				{
+					"name": "CommunityNotFound",
+					"description": "No community exists at that identifier."
+				},
+				{
+					"name": "HandOverUnavailable",
+					"description": "The account does not live on this AppView's server, already moved, or the AppView cannot manage accounts there."
+				},
+				{
+					"name": "UpstreamFailure",
+					"description": "A PDS or third-party call the AppView depends on failed."
+				}
+			]
+		}
+	}
+}

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

@@ -34,6 +34,11 @@
 						"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."
 					},
+					"hideOwnerBadge": {
+						"type": "boolean",
+						"default": false,
+						"description": "Whether the owner badge next to the community owner's name is hidden. Defaults to false."
+					},
 					"customEmoji": {
 						"type": "string",
 						"knownValues": ["all", "local", "none"],

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

@@ -48,6 +48,10 @@
 							"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."
 						},
+						"hideOwnerBadge": {
+							"type": "boolean",
+							"description": "Whether the owner badge next to the community owner's name is hidden."
+						},
 						"customEmoji": {
 							"type": "string",
 							"knownValues": ["all", "local", "none"],

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

@@ -77,6 +77,10 @@
 						"social.colibri.beta.community.listMigratable",
 						"social.colibri.beta.community.migrate",
 						"social.colibri.beta.community.registerCredentials",
+						"social.colibri.beta.community.authorizeHost",
+						"social.colibri.beta.community.getHostAuthorization",
+						"social.colibri.beta.community.getHosting",
+						"social.colibri.beta.community.handOverHost",
 						"social.colibri.beta.community.setMemberRoles",
 						"social.colibri.beta.community.transferOwnership",
 						"social.colibri.beta.community.reorderCategories",

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

@@ -40,6 +40,11 @@
 							"ref": "social.colibri.beta.community.defs#roleIconBadge",
 							"description": "An icon badge. Image badges are set with social.colibri.beta.role.putBadgeImage."
 						},
+						"emojiBadge": {
+							"type": "ref",
+							"ref": "social.colibri.beta.community.defs#roleEmojiBadge",
+							"description": "An emoji badge. Cannot be combined with badge."
+						},
 						"position": {
 							"type": "integer",
 							"description": "Hierarchy position. Higher outranks lower."

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

@@ -37,9 +37,14 @@
 							"ref": "social.colibri.beta.community.defs#roleIconBadge",
 							"description": "An icon badge. Image badges are set with social.colibri.beta.role.putBadgeImage. Takes precedence over removeBadge."
 						},
+						"emojiBadge": {
+							"type": "ref",
+							"ref": "social.colibri.beta.community.defs#roleEmojiBadge",
+							"description": "An emoji badge. Cannot be combined with badge. Takes precedence over removeBadge."
+						},
 						"removeBadge": {
 							"type": "boolean",
-							"description": "Removes the role's badge, whichever kind it is. Ignored when badge is also given."
+							"description": "Removes the role's badge, whichever kind it is. Ignored when badge or emojiBadge is also given."
 						},
 						"permissions": {
 							"type": "array",

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

@@ -23,7 +23,7 @@
 					},
 					"badge": {
 						"type": "union",
-						"refs": ["#iconBadge", "#imageBadge"],
+						"refs": ["#iconBadge", "#imageBadge", "#emojiBadge"],
 						"description": "A small badge shown next to the names of members holding this role."
 					},
 					"permissions": {
@@ -125,6 +125,23 @@
 					"description": "A square image, shown at about 16 pixels."
 				}
 			}
+		},
+		"emojiBadge": {
+			"type": "object",
+			"description": "A badge drawn from an emoji. Exactly one of emoji and customEmoji is set.",
+			"properties": {
+				"emoji": {
+					"type": "string",
+					"maxLength": 64,
+					"maxGraphemes": 1,
+					"description": "A Unicode emoji."
+				},
+				"customEmoji": {
+					"type": "ref",
+					"ref": "social.colibri.beta.richtext.facet#customEmoji",
+					"description": "The record of a custom emoji."
+				}
+			}
 		}
 	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@colibri-social/lexicons",
-  "version": "2.31.0",
+  "version": "2.33.0",
   "description": "Colibri lexicon schemas and the types generated from them",
   "type": "module",
   "exports": {