@colibri-social/lexicons 0.1.0

package/lexicons/social/colibri/community/listModerationLog.json

@@ -0,0 +1,68 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.community.listModerationLog",
+	"defs": {
+		"main": {
+			"type": "query",
+			"description": "Lists a community's moderation audit log.",
+			"parameters": {
+				"type": "params",
+				"required": ["community"],
+				"properties": {
+					"community": {
+						"type": "string",
+						"format": "did",
+						"description": "The community to list the moderation log for."
+					},
+					"limit": {
+						"type": "integer",
+						"minimum": 1,
+						"maximum": 100,
+						"default": 50,
+						"description": "Maximum number of log entries to return."
+					},
+					"cursor": {
+						"type": "string",
+						"description": "Pagination cursor from a previous response."
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["entries"],
+					"properties": {
+						"cursor": {
+							"type": "string",
+							"description": "Pagination cursor for the next page, if more entries exist."
+						},
+						"entries": {
+							"type": "array",
+							"items": {
+								"type": "ref",
+								"ref": "social.colibri.community.defs#moderationView",
+								"description": "A moderation log entry."
+							},
+							"description": "Log entries, most recent first."
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request is missing, malformed, or unverifiable service auth."
+				},
+				{
+					"name": "Forbidden",
+					"description": "The caller lacks the moderation.viewLog permission."
+				},
+				{
+					"name": "CommunityNotFound",
+					"description": "No community exists at the given DID."
+				}
+			]
+		}
+	}
+}

package/lexicons/social/colibri/community/listRoles.json

@@ -0,0 +1,52 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.community.listRoles",
+	"defs": {
+		"main": {
+			"type": "query",
+			"description": "Lists a community's roles.",
+			"parameters": {
+				"type": "params",
+				"required": ["community"],
+				"properties": {
+					"community": {
+						"type": "string",
+						"format": "did",
+						"description": "The community to list roles of."
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["roles"],
+					"properties": {
+						"roles": {
+							"type": "array",
+							"items": {
+								"type": "ref",
+								"ref": "social.colibri.community.defs#roleView"
+							},
+							"description": "The community's roles."
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request is missing, malformed, or unverifiable service auth."
+				},
+				{
+					"name": "Forbidden",
+					"description": "The requesting user lacks permission to view this community's roles."
+				},
+				{
+					"name": "CommunityNotFound",
+					"description": "No community exists with that DID."
+				}
+			]
+		}
+	}
+}

package/lexicons/social/colibri/community/members.json

@@ -0,0 +1,13 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.community.members",
+	"defs": {
+		"main": {
+			"type": "space",
+			"description": "A community's membership and the roles that can be assigned within it.",
+			"key": "literal:self",
+			"name": "Colibri community members",
+			"collections": ["social.colibri.member", "social.colibri.role", "social.colibri.label"]
+		}
+	}
+}

package/lexicons/social/colibri/community/migrate.json

@@ -0,0 +1,64 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.community.migrate",
+	"defs": {
+		"main": {
+			"type": "procedure",
+			"description": "Migrates a repo-backed community onto spaces. Structure is recreated in new spaces and stamped with migratedFrom. Message history stays in the legacy public repos and is served alongside, because messages live in their authors' repos and only their authors can move them.",
+			"input": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["legacy"],
+					"properties": {
+						"legacy": {
+							"type": "string",
+							"format": "at-uri",
+							"description": "The legacy social.colibri.community record to migrate."
+						}
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["community"],
+					"properties": {
+						"community": {
+							"type": "ref",
+							"ref": "social.colibri.community.defs#communityView",
+							"description": "The newly created, space-backed community."
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request is missing, malformed, or unverifiable service auth."
+				},
+				{
+					"name": "Forbidden",
+					"description": "The requesting user lacks permission to migrate this community."
+				},
+				{
+					"name": "CommunityNotFound",
+					"description": "No community exists at the legacy record's DID."
+				},
+				{
+					"name": "AlreadyExists",
+					"description": "This legacy community has already been migrated."
+				},
+				{
+					"name": "CredentialsUnavailable",
+					"description": "The AppView's stored credentials for this community are missing or unusable."
+				},
+				{
+					"name": "UpstreamFailure",
+					"description": "A PDS or third-party call the AppView depends on failed."
+				}
+			]
+		}
+	}
+}

package/lexicons/social/colibri/community/moderation.json

@@ -0,0 +1,13 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.community.moderation",
+	"defs": {
+		"main": {
+			"type": "space",
+			"description": "A community's moderation audit log. Kept in its own space so it can be read by moderators without being readable by the whole membership.",
+			"key": "literal:self",
+			"name": "Colibri community moderation log",
+			"collections": ["social.colibri.moderation"]
+		}
+	}
+}

package/lexicons/social/colibri/community/negateLabel.json

@@ -0,0 +1,71 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.community.negateLabel",
+	"defs": {
+		"main": {
+			"type": "procedure",
+			"description": "Retracts a label by writing a negating one. The original label record is left in place.",
+			"input": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["space", "subject", "val"],
+					"properties": {
+						"space": {
+							"type": "string",
+							"format": "space-ref",
+							"description": "The space the labelled record lives in."
+						},
+						"subject": {
+							"type": "ref",
+							"ref": "social.colibri.label#subject",
+							"description": "The labelled record."
+						},
+						"val": {
+							"type": "string",
+							"description": "The label value to retract."
+						},
+						"reason": {
+							"type": "string",
+							"maxLength": 512,
+							"description": "Human-readable reason for the retraction."
+						}
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"properties": {}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request is missing, malformed, or unverifiable service auth."
+				},
+				{
+					"name": "Forbidden",
+					"description": "The caller lacks the label.apply permission."
+				},
+				{
+					"name": "CommunityNotFound",
+					"description": "No community exists at the given DID."
+				},
+				{
+					"name": "SpaceNotFound",
+					"description": "No space exists at the given reference."
+				},
+				{
+					"name": "LabelNotFound",
+					"description": "No active label matching the subject and value exists to negate."
+				},
+				{
+					"name": "CredentialsUnavailable",
+					"description": "The AppView cannot act as the community because its stored credentials are missing or unusable."
+				}
+			]
+		}
+	}
+}

package/lexicons/social/colibri/community/profile.json

@@ -0,0 +1,13 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.community.profile",
+	"defs": {
+		"main": {
+			"type": "space",
+			"description": "A community's public identity: the one part of a community that can be read before joining it.",
+			"key": "literal:self",
+			"name": "Colibri community profile",
+			"collections": ["social.colibri.community"]
+		}
+	}
+}

package/lexicons/social/colibri/community/registerCredentials.json

@@ -0,0 +1,62 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.community.registerCredentials",
+	"defs": {
+		"main": {
+			"type": "procedure",
+			"description": "Hands the AppView credentials for a community hosted elsewhere, so it can administer a community it did not create. The password is stored encrypted at rest.",
+			"input": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["community", "identifier", "password"],
+					"properties": {
+						"community": {
+							"type": "string",
+							"format": "did",
+							"description": "The community the credentials belong to."
+						},
+						"identifier": {
+							"type": "string",
+							"description": "The identifier used to authenticate with the community's PDS, such as its handle or DID."
+						},
+						"password": {
+							"type": "string",
+							"description": "The password or app password used to authenticate with the community's PDS."
+						}
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": [],
+					"properties": {}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request is missing, malformed, or unverifiable service auth."
+				},
+				{
+					"name": "Forbidden",
+					"description": "The requesting user lacks permission to register credentials for this community."
+				},
+				{
+					"name": "InvalidRequest",
+					"description": "The arguments are inconsistent or malformed beyond schema validation."
+				},
+				{
+					"name": "CredentialsRejected",
+					"description": "The PDS refused the identifier and password."
+				},
+				{
+					"name": "UpstreamFailure",
+					"description": "A PDS or third-party call the AppView depends on failed."
+				}
+			]
+		}
+	}
+}

package/lexicons/social/colibri/community/reorderCategories.json

@@ -0,0 +1,63 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.community.reorderCategories",
+	"defs": {
+		"main": {
+			"type": "procedure",
+			"description": "Sets the complete display order of a community's categories.",
+			"input": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["community", "categories"],
+					"properties": {
+						"community": {
+							"type": "string",
+							"format": "did",
+							"description": "The community whose categories are being reordered."
+						},
+						"categories": {
+							"type": "array",
+							"items": {
+								"type": "string",
+								"format": "record-key",
+								"description": "A category."
+							},
+							"description": "The complete new display order of the community's categories."
+						}
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": [],
+					"properties": {}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request is missing, malformed, or unverifiable service auth."
+				},
+				{
+					"name": "Forbidden",
+					"description": "The requesting user lacks the category.update permission."
+				},
+				{
+					"name": "CommunityNotFound",
+					"description": "No community exists with that DID."
+				},
+				{
+					"name": "InvalidRequest",
+					"description": "The supplied categories do not match the community's existing set."
+				},
+				{
+					"name": "CredentialsUnavailable",
+					"description": "The AppView's stored credentials for this community are missing or unusable."
+				}
+			]
+		}
+	}
+}

package/lexicons/social/colibri/community/setMemberRoles.json

@@ -0,0 +1,82 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.community.setMemberRoles",
+	"defs": {
+		"main": {
+			"type": "procedure",
+			"description": "Sets the complete set of roles a member holds.",
+			"input": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["community", "subject", "roles"],
+					"properties": {
+						"community": {
+							"type": "string",
+							"format": "did",
+							"description": "The community the member belongs to."
+						},
+						"subject": {
+							"type": "string",
+							"format": "did",
+							"description": "The member whose roles are being set."
+						},
+						"roles": {
+							"type": "array",
+							"items": {
+								"type": "string",
+								"format": "record-key",
+								"description": "A role."
+							},
+							"description": "The complete new set of roles the member should hold."
+						}
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["member"],
+					"properties": {
+						"member": {
+							"type": "ref",
+							"ref": "social.colibri.community.defs#memberView",
+							"description": "The updated member."
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request is missing, malformed, or unverifiable service auth."
+				},
+				{
+					"name": "Forbidden",
+					"description": "The requesting user lacks the role.manage permission."
+				},
+				{
+					"name": "CommunityNotFound",
+					"description": "No community exists with that DID."
+				},
+				{
+					"name": "MemberNotFound",
+					"description": "The subject does not hold a member record in this community."
+				},
+				{
+					"name": "RoleNotFound",
+					"description": "One of the requested roles does not exist."
+				},
+				{
+					"name": "RoleHierarchy",
+					"description": "The requesting user cannot grant or revoke a role at or above their own highest position."
+				},
+				{
+					"name": "CredentialsUnavailable",
+					"description": "The AppView's stored credentials for this community are missing or unusable."
+				}
+			]
+		}
+	}
+}

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

@@ -0,0 +1,45 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.community.settings",
+	"defs": {
+		"main": {
+			"type": "record",
+			"description": "A community's operational settings. Separate from the profile record so the two have different read audiences.",
+			"key": "literal:self",
+			"record": {
+				"type": "object",
+				"required": ["categoryOrder", "requiresApprovalToJoin"],
+				"properties": {
+					"categoryOrder": {
+						"type": "array",
+						"items": {
+							"type": "string",
+							"format": "record-key",
+							"description": "A category in this community."
+						},
+						"description": "The order categories are displayed in."
+					},
+					"requiresApprovalToJoin": {
+						"type": "boolean",
+						"default": false,
+						"description": "Whether joining produces an application a moderator must approve."
+					},
+					"linkEmbeds": {
+						"type": "boolean",
+						"default": true,
+						"description": "Whether link previews are shown by default. Channels may override this."
+					},
+					"labelers": {
+						"type": "array",
+						"items": {
+							"type": "string",
+							"format": "did",
+							"description": "A labeler this community honours."
+						},
+						"description": "DIDs whose labels this community honours, in addition to the community's own. Empty means the community labels its content itself."
+					}
+				}
+			}
+		}
+	}
+}

package/lexicons/social/colibri/community/unban.json

@@ -0,0 +1,63 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.community.unban",
+	"defs": {
+		"main": {
+			"type": "procedure",
+			"description": "Lifts a ban, letting the community issue the subject space credentials again.",
+			"input": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["community", "subject"],
+					"properties": {
+						"community": {
+							"type": "string",
+							"format": "did",
+							"description": "The community to lift the ban in."
+						},
+						"subject": {
+							"type": "string",
+							"format": "did",
+							"description": "The member to unban."
+						},
+						"reason": {
+							"type": "string",
+							"maxLength": 512,
+							"description": "Human-readable reason for lifting the ban."
+						}
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"properties": {}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request is missing, malformed, or unverifiable service auth."
+				},
+				{
+					"name": "Forbidden",
+					"description": "The caller lacks the member.unban permission."
+				},
+				{
+					"name": "CommunityNotFound",
+					"description": "No community exists at the given DID."
+				},
+				{
+					"name": "NotBanned",
+					"description": "The subject is not currently banned from this community."
+				},
+				{
+					"name": "CredentialsUnavailable",
+					"description": "The AppView cannot act as the community because its stored credentials are missing or unusable."
+				}
+			]
+		}
+	}
+}

package/lexicons/social/colibri/community/undismissApplication.json

@@ -0,0 +1,54 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.community.undismissApplication",
+	"defs": {
+		"main": {
+			"type": "procedure",
+			"description": "Restores a dismissed application to the active queue. This is an AppView-local change and is never written to the community's repo.",
+			"input": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["community", "subject"],
+					"properties": {
+						"community": {
+							"type": "string",
+							"format": "did",
+							"description": "The community the application belongs to."
+						},
+						"subject": {
+							"type": "string",
+							"format": "did",
+							"description": "The applicant whose application to restore."
+						}
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"properties": {}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request is missing, malformed, or unverifiable service auth."
+				},
+				{
+					"name": "Forbidden",
+					"description": "The caller lacks the approval.manage permission."
+				},
+				{
+					"name": "CommunityNotFound",
+					"description": "No community exists at the given DID."
+				},
+				{
+					"name": "ApplicationNotFound",
+					"description": "No pending application exists for the subject in this community."
+				}
+			]
+		}
+	}
+}