@colibri-social/lexicons 2.8.0 → 2.9.0

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

@@ -0,0 +1,49 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.beta.thread.getThread",
+	"defs": {
+		"main": {
+			"type": "query",
+			"description": "Gets one thread, with its anchor message resolved so a client can open it without having read the channel it belongs to.",
+			"parameters": {
+				"type": "params",
+				"required": ["thread"],
+				"properties": {
+					"thread": {
+						"type": "string",
+						"format": "space-ref",
+						"description": "The thread to get."
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["thread"],
+					"properties": {
+						"thread": {
+							"type": "ref",
+							"ref": "social.colibri.beta.thread.defs#threadView",
+							"description": "The requested thread."
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request has no valid service auth."
+				},
+				{
+					"name": "Forbidden",
+					"description": "The requesting user may not read this thread."
+				},
+				{
+					"name": "ThreadNotFound",
+					"description": "No thread matches the given space reference."
+				}
+			]
+		}
+	}
+}

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

@@ -0,0 +1,83 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.beta.thread.listThreads",
+	"defs": {
+		"main": {
+			"type": "query",
+			"description": "Lists a community's threads, most recently active first. Threads the requesting user may not read are absent rather than refused.",
+			"parameters": {
+				"type": "params",
+				"required": ["community"],
+				"properties": {
+					"community": {
+						"type": "string",
+						"format": "did",
+						"description": "The community to list threads in."
+					},
+					"channel": {
+						"type": "string",
+						"format": "space-ref",
+						"description": "Restrict the list to threads in one channel. Absent lists every channel's threads, which is what the community sidebar needs."
+					},
+					"filter": {
+						"type": "string",
+						"default": "all",
+						"knownValues": ["all", "unread", "following"],
+						"description": "Which threads to list."
+					},
+					"limit": {
+						"type": "integer",
+						"minimum": 1,
+						"maximum": 100,
+						"default": 50,
+						"description": "Maximum number of threads to return."
+					},
+					"cursor": {
+						"type": "string",
+						"description": "Pagination cursor from a previous call."
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["threads"],
+					"properties": {
+						"cursor": {
+							"type": "string",
+							"description": "Pagination cursor for the next page."
+						},
+						"threads": {
+							"type": "array",
+							"description": "The threads.",
+							"items": {
+								"type": "ref",
+								"ref": "social.colibri.beta.thread.defs#threadView",
+								"description": "A thread."
+							}
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request has no valid service auth."
+				},
+				{
+					"name": "Forbidden",
+					"description": "The requesting user is not a member of this community."
+				},
+				{
+					"name": "CommunityNotFound",
+					"description": "No community matches the given DID."
+				},
+				{
+					"name": "ChannelNotFound",
+					"description": "No channel matches the given space reference."
+				}
+			]
+		}
+	}
+}

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

@@ -0,0 +1,89 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.beta.thread.moveMessages",
+	"defs": {
+		"main": {
+			"type": "procedure",
+			"description": "Moves messages written by other people into another thread or channel. A message lives in its author's own repo and cannot be rewritten by a moderator, so the move is a `moved` label written into the source space for each message. Every label in one call shares a batch key, and the destination serves the moved messages ordered by that batch key and then by the messages' own record keys, which is what keeps a selection in the order it was in. The AppView withholds a moved message from the space it came from. A user moving only their own messages rewrites the records instead and does not call this method.",
+			"input": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["source", "destination", "subjects"],
+					"properties": {
+						"source": {
+							"type": "string",
+							"format": "space-ref",
+							"description": "The space the messages are in now, either a channel or a thread."
+						},
+						"destination": {
+							"type": "string",
+							"format": "space-ref",
+							"description": "The space to move them to, either a channel or a thread in the same community."
+						},
+						"subjects": {
+							"type": "array",
+							"items": {
+								"type": "ref",
+								"ref": "social.colibri.beta.label#subject",
+								"description": "A message to move."
+							},
+							"description": "The messages to move, at most fifty in one call.",
+							"minLength": 1,
+							"maxLength": 50
+						},
+						"reason": {
+							"type": "string",
+							"maxLength": 512,
+							"description": "Human-readable reason, recorded on every label in the batch."
+						}
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["batch", "count"],
+					"properties": {
+						"batch": {
+							"type": "string",
+							"format": "tid",
+							"description": "The batch key shared by every label this call wrote, which is what orders the moved messages in the destination."
+						},
+						"count": {
+							"type": "integer",
+							"description": "How many messages were moved."
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request has no valid service auth."
+				},
+				{
+					"name": "Forbidden",
+					"description": "The requesting user lacks the thread.move permission, or may not read the source or post in the destination."
+				},
+				{
+					"name": "SpaceNotFound",
+					"description": "No space exists at the source or destination reference."
+				},
+				{
+					"name": "MessageNotFound",
+					"description": "One of the subjects is not a message in the source space."
+				},
+				{
+					"name": "InvalidRequest",
+					"description": "The destination is the source, belongs to another community, or a subject is not a message."
+				},
+				{
+					"name": "CredentialsUnavailable",
+					"description": "The AppView cannot act as the community because its stored credentials are missing or unusable."
+				}
+			]
+		}
+	}
+}

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

@@ -0,0 +1,69 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.beta.thread.repoint",
+	"defs": {
+		"main": {
+			"type": "procedure",
+			"description": "Moves a thread to another channel by rewriting the channel its record links to. Who may read the thread follows the new channel. The anchor is left as it was, so the thread's marker leaves the old channel's river while the thread itself still quotes the message it came from.",
+			"input": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["thread", "channel"],
+					"properties": {
+						"thread": {
+							"type": "string",
+							"format": "space-ref",
+							"description": "The thread to move."
+						},
+						"channel": {
+							"type": "string",
+							"format": "space-ref",
+							"description": "The text channel to move it to."
+						}
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["thread"],
+					"properties": {
+						"thread": {
+							"type": "ref",
+							"ref": "social.colibri.beta.thread.defs#threadView",
+							"description": "The thread, after the move."
+						}
+					}
+				}
+			},
+			"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": "ChannelNotFound",
+					"description": "No channel matches the given space reference."
+				},
+				{
+					"name": "InvalidRequest",
+					"description": "The destination channel belongs to another community, is not a text channel, or is the channel the thread is already in."
+				},
+				{
+					"name": "CredentialsUnavailable",
+					"description": "The AppView cannot act as the community because its stored credentials are missing or unusable."
+				}
+			]
+		}
+	}
+}

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

@@ -0,0 +1,88 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.beta.thread.update",
+	"defs": {
+		"main": {
+			"type": "procedure",
+			"description": "Renames a thread or changes who may read it. An absent field leaves the current value unchanged.",
+			"input": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["thread"],
+					"properties": {
+						"thread": {
+							"type": "string",
+							"format": "space-ref",
+							"description": "The thread to update."
+						},
+						"name": {
+							"type": "string",
+							"minLength": 1,
+							"maxLength": 128,
+							"description": "The thread's title. Absent leaves the current value unchanged."
+						},
+						"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, after the update."
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request has no valid service auth."
+				},
+				{
+					"name": "Forbidden",
+					"description": "The requesting user lacks the thread.manage permission, and is not the user who opened the thread renaming it."
+				},
+				{
+					"name": "ThreadNotFound",
+					"description": "No thread matches the given space reference."
+				},
+				{
+					"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."
+				}
+			]
+		}
+	}
+}

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

@@ -0,0 +1,61 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.beta.thread",
+	"defs": {
+		"main": {
+			"type": "record",
+			"description": "A thread's configuration, including the link to the channel it belongs to. Lives at key 'self' in the thread's own space and is written only by the community.",
+			"key": "literal:self",
+			"record": {
+				"type": "object",
+				"required": ["name", "channel", "createdBy", "createdAt"],
+				"properties": {
+					"name": {
+						"type": "string",
+						"minLength": 1,
+						"maxLength": 128,
+						"description": "The thread's title."
+					},
+					"channel": {
+						"type": "string",
+						"format": "space-ref",
+						"description": "The text channel this thread belongs to. Moving the thread to another channel rewrites this field."
+					},
+					"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."
+					},
+					"createdBy": {
+						"type": "string",
+						"format": "did",
+						"description": "Who opened the thread."
+					},
+					"createdAt": {
+						"type": "string",
+						"format": "datetime",
+						"description": "When the thread was opened."
+					},
+					"visibleToRoles": {
+						"type": "array",
+						"items": {
+							"type": "string",
+							"format": "record-key",
+							"description": "A role permitted to read."
+						},
+						"description": "Roles that may read this thread. Empty or absent means everyone who can read the parent channel can read the thread. A non-empty list makes the thread private: the community declines space credentials for it to anyone outside the list, so it is enforced by the protocol rather than only by a read handler."
+					},
+					"visibleToMembers": {
+						"type": "array",
+						"items": {
+							"type": "string",
+							"format": "did",
+							"description": "A member permitted to read."
+						},
+						"description": "Members that may read this thread in addition to visibleToRoles."
+					}
+				}
+			}
+		}
+	}
+}

package/package.json

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