@colibri-social/lexicons 2.8.0 → 2.9.0

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

@@ -4,7 +4,7 @@
 	"defs": {
 		"main": {
 			"type": "query",
-			"description": "Lists messages in a channel, newest first by default. Messages from the repo-backed channel this one was migrated from are included and marked legacy.",
+			"description": "Lists messages in a channel or in a thread, newest first by default. Messages from the repo-backed channel this one was migrated from are included and marked legacy. Messages moved in from another space are included in their move order, and messages moved out are absent.",
 			"parameters": {
 				"type": "params",
 				"required": ["channel"],
@@ -12,7 +12,7 @@
 					"channel": {
 						"type": "string",
 						"format": "space-ref",
-						"description": "The channel to list messages from."
+						"description": "The channel or thread to list messages from."
 					},
 					"limit": {
 						"type": "integer",
@@ -49,6 +49,15 @@
 								"type": "ref",
 								"ref": "social.colibri.beta.channel.defs#messageView"
 							}
+						},
+						"threads": {
+							"type": "array",
+							"description": "Threads whose anchor message is in this page, so a client can draw a thread's marker under the message it was opened from without a second call. Threads the requesting user may not read are absent.",
+							"items": {
+								"type": "ref",
+								"ref": "social.colibri.beta.thread.defs#threadView",
+								"description": "A thread."
+							}
 						}
 					}
 				}
@@ -60,11 +69,11 @@
 				},
 				{
 					"name": "Forbidden",
-					"description": "The requesting user may not read this channel."
+					"description": "The requesting user may not read this channel or thread."
 				},
 				{
 					"name": "ChannelNotFound",
-					"description": "No channel matches the given space reference."
+					"description": "No channel or thread matches the given space reference."
 				}
 			]
 		}

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

@@ -0,0 +1,19 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.beta.channel.thread",
+	"defs": {
+		"main": {
+			"type": "space",
+			"description": "A thread beside a text channel. The space key is the thread's identity, and the thread's own configuration is the social.colibri.beta.thread record at key 'self' inside it. That record carries the link to the parent channel and only the community may write it, so a thread cannot claim a channel its community did not put it in.",
+			"key": "tid",
+			"name": "Colibri thread",
+			"collections": [
+				"social.colibri.beta.thread",
+				"social.colibri.beta.thread.follow",
+				"social.colibri.beta.message",
+				"social.colibri.beta.reaction",
+				"social.colibri.beta.label"
+			]
+		}
+	}
+}

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

@@ -18,6 +18,33 @@
 					"description": "Record key of the referenced record."
 				}
 			}
+		},
+		"spaceRecordRef": {
+			"type": "object",
+			"description": "A reference to a record in a named space, for pointing at something outside the space the pointer lives in.",
+			"required": ["space", "did", "rkey"],
+			"properties": {
+				"space": {
+					"type": "string",
+					"format": "space-ref",
+					"description": "The space holding the referenced record."
+				},
+				"did": {
+					"type": "string",
+					"format": "did",
+					"description": "DID of the repo holding the referenced record."
+				},
+				"rkey": {
+					"type": "string",
+					"format": "record-key",
+					"description": "Record key of the referenced record."
+				},
+				"cid": {
+					"type": "string",
+					"format": "cid",
+					"description": "The referenced record's CID as it stood when the reference was made."
+				}
+			}
 		}
 	}
 }

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

@@ -18,8 +18,8 @@
 					"val": {
 						"type": "string",
 						"maxLength": 128,
-						"knownValues": ["hidden", "spoiler", "embeds-suppressed"],
-						"description": "The label value. `hidden` is enforced: the AppView withholds a hidden record instead of serving it. `spoiler` and `embeds-suppressed` are display hints the AppView passes through for the client to honour."
+						"knownValues": ["hidden", "spoiler", "embeds-suppressed", "moved"],
+						"description": "The label value. `hidden` is enforced: the AppView withholds a hidden record instead of serving it. `moved` is enforced too: the AppView withholds the record from this space and serves it in the space named by `destination` instead, ordered by `batch` and then by the record's own key. `spoiler` and `embeds-suppressed` are display hints the AppView passes through for the client to honour."
 					},
 					"scope": {
 						"type": "array",
@@ -29,6 +29,16 @@
 						},
 						"description": "URIs within the subject record the label narrows to, for values that can apply to part of a record. Absent means the whole record."
 					},
+					"destination": {
+						"type": "string",
+						"format": "space-ref",
+						"description": "Where a `moved` record is served instead of here. Honoured only on a `moved` label."
+					},
+					"batch": {
+						"type": "string",
+						"format": "tid",
+						"description": "Shared by every `moved` label written in one move, and what orders the moved records in the destination ahead of their own record keys. A selection moved together therefore keeps the order it had."
+					},
 					"neg": {
 						"type": "boolean",
 						"default": false,

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

@@ -26,6 +26,11 @@
 					"format": "space-ref",
 					"description": "The channel it happened in."
 				},
+				"thread": {
+					"type": "string",
+					"format": "space-ref",
+					"description": "The thread it happened in, when it happened in a thread rather than in the channel itself. `channel` stays the thread's parent channel, so a client can route to the thread inside it."
+				},
 				"community": {
 					"type": "string",
 					"format": "did",

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

@@ -55,6 +55,14 @@
 					"action": ["read"],
 					"manage": ["create", "update", "delete"]
 				},
+				{
+					"type": "permission",
+					"resource": "space",
+					"spaceType": "social.colibri.beta.channel.thread",
+					"authority": "*",
+					"action": ["read"],
+					"manage": ["create", "update", "delete"]
+				},
 				{
 					"type": "permission",
 					"resource": "rpc",
@@ -95,7 +103,10 @@
 						"social.colibri.beta.role.create",
 						"social.colibri.beta.role.update",
 						"social.colibri.beta.role.delete",
-						"social.colibri.beta.voice.moderate"
+						"social.colibri.beta.voice.moderate",
+						"social.colibri.beta.thread.delete",
+						"social.colibri.beta.thread.repoint",
+						"social.colibri.beta.thread.moveMessages"
 					]
 				},
 				{

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

@@ -15,6 +15,18 @@
 					"collection": ["social.colibri.beta.message", "social.colibri.beta.reaction"],
 					"action": ["read", "create", "update", "delete"]
 				},
+				{
+					"type": "permission",
+					"resource": "space",
+					"spaceType": "social.colibri.beta.channel.thread",
+					"authority": "*",
+					"collection": [
+						"social.colibri.beta.message",
+						"social.colibri.beta.reaction",
+						"social.colibri.beta.thread.follow"
+					],
+					"action": ["read", "create", "update", "delete"]
+				},
 				{
 					"type": "permission",
 					"resource": "space",
@@ -65,7 +77,11 @@
 						"social.colibri.beta.embed.searchGifs",
 						"social.colibri.beta.embed.trendingGifs",
 						"social.colibri.beta.embed.gifCategories",
-						"social.colibri.beta.blob.get"
+						"social.colibri.beta.blob.get",
+						"social.colibri.beta.thread.create",
+						"social.colibri.beta.thread.update",
+						"social.colibri.beta.thread.getThread",
+						"social.colibri.beta.thread.listThreads"
 					]
 				},
 				{

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

@@ -4,7 +4,7 @@
 	"defs": {
 		"subscribe": {
 			"type": "object",
-			"description": "Adds communities and channels to what this connection receives. Subscription is explicit: a connection is sent nothing it did not ask for.",
+			"description": "Adds communities, channels and threads to what this connection receives. Subscription is explicit: a connection is sent nothing it did not ask for.",
 			"required": [],
 			"properties": {
 				"communities": {
@@ -21,15 +21,15 @@
 					"items": {
 						"type": "string",
 						"format": "space-ref",
-						"description": "A channel."
+						"description": "A channel or a thread."
 					},
-					"description": "Channels to start receiving messages for."
+					"description": "Channels and threads to start receiving messages for."
 				}
 			}
 		},
 		"unsubscribe": {
 			"type": "object",
-			"description": "Removes communities and channels from what this connection receives.",
+			"description": "Removes communities, channels and threads from what this connection receives.",
 			"required": [],
 			"properties": {
 				"communities": {
@@ -46,9 +46,9 @@
 					"items": {
 						"type": "string",
 						"format": "space-ref",
-						"description": "A channel."
+						"description": "A channel or a thread."
 					},
-					"description": "Channels to stop receiving messages for."
+					"description": "Channels and threads to stop receiving messages for."
 				}
 			}
 		},
@@ -177,9 +177,9 @@
 					"items": {
 						"type": "string",
 						"format": "space-ref",
-						"description": "A channel."
+						"description": "A channel or a thread."
 					},
-					"description": "Channels being received."
+					"description": "Channels and threads being received."
 				}
 			}
 		},
@@ -268,6 +268,43 @@
 				}
 			}
 		},
+		"threadEvent": {
+			"type": "object",
+			"description": "A thread was opened, changed, deleted, or written to. This rides the community's topic rather than a topic per thread, so a client keeps every thread's activity age and unread dot live without subscribing to each one.",
+			"required": ["event", "community"],
+			"properties": {
+				"event": {
+					"type": "string",
+					"description": "What happened. `activity` means someone posted, which moves the thread's last activity and nothing else.",
+					"knownValues": ["create", "update", "delete", "activity"]
+				},
+				"community": {
+					"type": "string",
+					"format": "did",
+					"description": "The community it belongs to."
+				},
+				"channel": {
+					"type": "string",
+					"format": "space-ref",
+					"description": "The channel the thread belongs to."
+				},
+				"thread": {
+					"type": "ref",
+					"ref": "social.colibri.beta.thread.defs#threadView",
+					"description": "The thread. Absent on delete and on activity."
+				},
+				"space": {
+					"type": "string",
+					"format": "space-ref",
+					"description": "Which thread, for deletes and for activity."
+				},
+				"lastActivityAt": {
+					"type": "string",
+					"format": "datetime",
+					"description": "The thread's new last activity, on activity events."
+				}
+			}
+		},
 		"categoryEvent": {
 			"type": "object",
 			"description": "A category was created, changed, or deleted.",

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

@@ -0,0 +1,114 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.beta.thread.create",
+	"defs": {
+		"main": {
+			"type": "procedure",
+			"description": "Opens a thread beside a text channel. This creates a space for the thread, then writes the thread's configuration record at key 'self' inside it. The anchor message is referenced rather than copied, so it stays in its author's repo in the channel where it was written.",
+			"input": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["community", "channel", "name"],
+					"properties": {
+						"community": {
+							"type": "string",
+							"format": "did",
+							"description": "The community the thread's channel belongs to."
+						},
+						"channel": {
+							"type": "string",
+							"format": "space-ref",
+							"description": "The text channel to open the thread beside."
+						},
+						"name": {
+							"type": "string",
+							"minLength": 1,
+							"maxLength": 128,
+							"description": "The thread's title."
+						},
+						"anchor": {
+							"type": "ref",
+							"ref": "social.colibri.beta.defs#spaceRecordRef",
+							"description": "The message to open the thread from. Absent opens a thread from scratch, which has no marker in the channel river and is reachable from the channel's thread list and the sidebar."
+						},
+						"visibleToRoles": {
+							"type": "array",
+							"items": {
+								"type": "string",
+								"format": "record-key",
+								"description": "A role."
+							},
+							"description": "Roles that may read this thread. Empty means everyone who may read the channel may read the thread."
+						},
+						"visibleToMembers": {
+							"type": "array",
+							"items": {
+								"type": "string",
+								"format": "did",
+								"description": "A member."
+							},
+							"description": "Members that may read this thread beyond visibleToRoles."
+						}
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["thread"],
+					"properties": {
+						"thread": {
+							"type": "ref",
+							"ref": "social.colibri.beta.thread.defs#threadView",
+							"description": "The thread."
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request has no valid service auth."
+				},
+				{
+					"name": "Forbidden",
+					"description": "The requesting user lacks the thread.create permission or may not post in the channel."
+				},
+				{
+					"name": "CommunityNotFound",
+					"description": "No community matches the given DID."
+				},
+				{
+					"name": "ChannelNotFound",
+					"description": "No channel matches the given space reference."
+				},
+				{
+					"name": "MessageNotFound",
+					"description": "The anchor message does not exist in the given channel."
+				},
+				{
+					"name": "RoleHierarchy",
+					"description": "The requesting user cannot grant a role that outranks their own."
+				},
+				{
+					"name": "InvalidRequest",
+					"description": "The arguments are inconsistent or malformed beyond schema validation."
+				},
+				{
+					"name": "CredentialsUnavailable",
+					"description": "The AppView cannot act as the community because its stored credentials are missing or unusable."
+				},
+				{
+					"name": "PdsUnavailable",
+					"description": "The community's PDS is unreachable or the AppView has no administrative access to it."
+				},
+				{
+					"name": "UpstreamFailure",
+					"description": "The community's PDS failed while creating the thread's space."
+				}
+			]
+		}
+	}
+}

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

@@ -0,0 +1,163 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.beta.thread.defs",
+	"defs": {
+		"threadView": {
+			"type": "object",
+			"description": "A thread as the AppView serves it. The thread's identity is its space.",
+			"required": [
+				"space",
+				"channel",
+				"community",
+				"name",
+				"createdBy",
+				"createdAt",
+				"lastActivityAt",
+				"messageCount",
+				"participants",
+				"viewer"
+			],
+			"properties": {
+				"space": {
+					"type": "string",
+					"format": "space-ref",
+					"description": "The thread's space, which is its identity."
+				},
+				"channel": {
+					"type": "string",
+					"format": "space-ref",
+					"description": "The channel the thread belongs to."
+				},
+				"community": {
+					"type": "string",
+					"format": "did",
+					"description": "The community the thread's channel belongs to."
+				},
+				"name": {
+					"type": "string",
+					"description": "The thread's title."
+				},
+				"anchor": {
+					"type": "ref",
+					"ref": "social.colibri.beta.defs#spaceRecordRef",
+					"description": "The message the thread was opened from. Absent on a thread opened from scratch. Its space stays where the thread was opened even after the thread moves to another channel, which is what drops the thread's marker out of the old channel without losing the quoted message. A client draws the thread's marker in the channel river only where the anchor's space is the channel being read."
+				},
+				"anchorMessage": {
+					"type": "union",
+					"refs": [
+						"social.colibri.beta.channel.defs#messageView",
+						"social.colibri.beta.channel.defs#deletedMessageView"
+					],
+					"description": "The anchor message itself, for opening a thread without having read its channel. Served by getThread rather than by listThreads."
+				},
+				"createdBy": {
+					"type": "string",
+					"format": "did",
+					"description": "Who opened the thread."
+				},
+				"createdAt": {
+					"type": "string",
+					"format": "datetime",
+					"description": "When the thread was opened."
+				},
+				"lastActivityAt": {
+					"type": "string",
+					"format": "datetime",
+					"description": "When the thread was last written to. This is what drives the activity age a client shows, since threads carry no presence roster of their own."
+				},
+				"messageCount": {
+					"type": "integer",
+					"description": "How many messages the thread holds."
+				},
+				"movedInCount": {
+					"type": "integer",
+					"description": "How many of those messages were moved in from somewhere else."
+				},
+				"participants": {
+					"type": "array",
+					"items": {
+						"type": "string",
+						"format": "did",
+						"description": "Someone who has posted in the thread."
+					},
+					"description": "Who has posted, most recently active first, capped at a handful."
+				},
+				"private": {
+					"type": "boolean",
+					"description": "Whether the thread restricts who may read it beyond who may read its channel."
+				},
+				"visibleToRoles": {
+					"type": "array",
+					"items": {
+						"type": "string",
+						"format": "record-key",
+						"description": "A role."
+					},
+					"description": "Roles that may read this thread. Empty means everyone who can read the channel may."
+				},
+				"visibleToMembers": {
+					"type": "array",
+					"items": {
+						"type": "string",
+						"format": "did",
+						"description": "A member."
+					},
+					"description": "Members that may read this thread beyond visibleToRoles."
+				},
+				"viewer": {
+					"type": "ref",
+					"ref": "#threadViewerState",
+					"description": "The requesting user's relationship to this thread."
+				}
+			}
+		},
+		"threadViewerState": {
+			"type": "object",
+			"description": "The requesting user's access and unread state for a thread.",
+			"required": [
+				"canRead",
+				"canPost",
+				"canManage",
+				"following",
+				"muted",
+				"hasUnread",
+				"unreadMentions"
+			],
+			"properties": {
+				"canRead": {
+					"type": "boolean",
+					"description": "Whether the user may read this thread."
+				},
+				"canPost": {
+					"type": "boolean",
+					"description": "Whether the user may post in this thread."
+				},
+				"canManage": {
+					"type": "boolean",
+					"description": "Whether the user may rename, move or delete this thread."
+				},
+				"following": {
+					"type": "boolean",
+					"description": "Whether the user follows this thread."
+				},
+				"muted": {
+					"type": "boolean",
+					"description": "Whether the user has muted this thread."
+				},
+				"hasUnread": {
+					"type": "boolean",
+					"description": "Whether anything in the thread is unread."
+				},
+				"unreadMentions": {
+					"type": "integer",
+					"description": "How many unread messages in the thread mention the user."
+				},
+				"cursor": {
+					"type": "string",
+					"format": "tid",
+					"description": "The user's read cursor in this thread."
+				}
+			}
+		}
+	}
+}

package/lexicons/social/colibri/beta/thread/delete.json

@@ -0,0 +1,57 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.beta.thread.delete",
+	"defs": {
+		"main": {
+			"type": "procedure",
+			"description": "Deletes a thread's space. Messages members wrote in it stay in their own repos and become unreadable to everyone but their authors, the same way deleting a channel works. Messages that were moved into the thread go with it.",
+			"input": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["thread"],
+					"properties": {
+						"thread": {
+							"type": "string",
+							"format": "space-ref",
+							"description": "The thread to delete."
+						}
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"properties": {}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request has no valid service auth."
+				},
+				{
+					"name": "Forbidden",
+					"description": "The requesting user lacks the thread.manage permission."
+				},
+				{
+					"name": "ThreadNotFound",
+					"description": "No thread matches the given space reference."
+				},
+				{
+					"name": "CredentialsUnavailable",
+					"description": "The AppView cannot act as the community because its stored credentials are missing or unusable."
+				},
+				{
+					"name": "PdsUnavailable",
+					"description": "The community's PDS is unreachable or the AppView has no administrative access to it."
+				},
+				{
+					"name": "UpstreamFailure",
+					"description": "The community's PDS failed while deleting the thread's space."
+				}
+			]
+		}
+	}
+}

package/lexicons/social/colibri/beta/thread/follow.json

@@ -0,0 +1,22 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.beta.thread.follow",
+	"defs": {
+		"main": {
+			"type": "record",
+			"description": "Marks its author as following the thread it lives in. Presence means following and deleting it means leaving. The follower writes it into the thread's own space, so following is visible to everyone who can read the thread.",
+			"key": "literal:self",
+			"record": {
+				"type": "object",
+				"required": ["createdAt"],
+				"properties": {
+					"createdAt": {
+						"type": "string",
+						"format": "datetime",
+						"description": "When the user started following."
+					}
+				}
+			}
+		}
+	}
+}