@colibri-social/lexicons 0.1.0

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

@@ -0,0 +1,45 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.community.getCommunity",
+	"defs": {
+		"main": {
+			"type": "query",
+			"description": "Gets a community by DID or handle.",
+			"parameters": {
+				"type": "params",
+				"required": ["community"],
+				"properties": {
+					"community": {
+						"type": "string",
+						"description": "A DID or handle identifying the community.",
+						"format": "at-identifier"
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["community"],
+					"properties": {
+						"community": {
+							"type": "ref",
+							"ref": "social.colibri.community.defs#communityView",
+							"description": "The requested community."
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request is missing, malformed, or unverifiable service auth."
+				},
+				{
+					"name": "CommunityNotFound",
+					"description": "No community exists at that identifier."
+				}
+			]
+		}
+	}
+}

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

@@ -0,0 +1,45 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.community.getInvitation",
+	"defs": {
+		"main": {
+			"type": "query",
+			"description": "Resolves an invitation code, so a client can show what it leads to before the user accepts. This is readable without membership.",
+			"parameters": {
+				"type": "params",
+				"required": ["code"],
+				"properties": {
+					"code": {
+						"type": "string",
+						"description": "The invitation code to resolve."
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["invitation", "community"],
+					"properties": {
+						"invitation": {
+							"type": "ref",
+							"ref": "social.colibri.community.defs#invitationView",
+							"description": "The resolved invitation."
+						},
+						"community": {
+							"type": "ref",
+							"ref": "social.colibri.community.defs#communityView",
+							"description": "The community the invitation leads to."
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "InvitationNotFound",
+					"description": "No invitation exists with that code."
+				}
+			]
+		}
+	}
+}

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

@@ -0,0 +1,73 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.community.join",
+	"defs": {
+		"main": {
+			"type": "procedure",
+			"description": "Admits the requesting user to a community. Joining is an AppView procedure rather than a record the user writes, because admission is what makes the community's spaces readable to them.",
+			"input": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["community"],
+					"properties": {
+						"community": {
+							"type": "string",
+							"format": "did",
+							"description": "The community to join."
+						},
+						"invitation": {
+							"type": "string",
+							"description": "An invitation code."
+						}
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["status"],
+					"properties": {
+						"status": {
+							"type": "string",
+							"description": "The result of the join attempt.",
+							"knownValues": ["joined", "pending"]
+						},
+						"member": {
+							"type": "ref",
+							"ref": "social.colibri.community.defs#memberView",
+							"description": "The new member view. Present only when status is joined."
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request is missing, malformed, or unverifiable service auth."
+				},
+				{
+					"name": "CommunityNotFound",
+					"description": "No community exists with that DID."
+				},
+				{
+					"name": "InvitationNotFound",
+					"description": "No invitation exists with that code."
+				},
+				{
+					"name": "AlreadyMember",
+					"description": "The requesting user already holds a member record in this community."
+				},
+				{
+					"name": "Banned",
+					"description": "The requesting user is banned from this community."
+				},
+				{
+					"name": "CredentialsUnavailable",
+					"description": "The AppView's stored credentials for this community are missing or unusable."
+				}
+			]
+		}
+	}
+}

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

@@ -0,0 +1,67 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.community.kick",
+	"defs": {
+		"main": {
+			"type": "procedure",
+			"description": "Removes a member from a community. The member may rejoin unless the community requires approval to join.",
+			"input": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["community", "subject"],
+					"properties": {
+						"community": {
+							"type": "string",
+							"format": "did",
+							"description": "The community to remove the member from."
+						},
+						"subject": {
+							"type": "string",
+							"format": "did",
+							"description": "The member to remove."
+						},
+						"reason": {
+							"type": "string",
+							"maxLength": 512,
+							"description": "Human-readable reason for the kick."
+						}
+					}
+				}
+			},
+			"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.kick permission."
+				},
+				{
+					"name": "CommunityNotFound",
+					"description": "No community exists at the given DID."
+				},
+				{
+					"name": "MemberNotFound",
+					"description": "The subject does not hold a member record in this community."
+				},
+				{
+					"name": "RoleHierarchy",
+					"description": "The subject holds a role at or above the caller's highest role position."
+				},
+				{
+					"name": "CredentialsUnavailable",
+					"description": "The AppView cannot act as the community because its stored credentials are missing or unusable."
+				}
+			]
+		}
+	}
+}

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

@@ -0,0 +1,54 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.community.leave",
+	"defs": {
+		"main": {
+			"type": "procedure",
+			"description": "Removes the requesting user's membership in a community.",
+			"input": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["community"],
+					"properties": {
+						"community": {
+							"type": "string",
+							"format": "did",
+							"description": "The community to leave."
+						}
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": [],
+					"properties": {}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request is missing, malformed, or unverifiable service auth."
+				},
+				{
+					"name": "CommunityNotFound",
+					"description": "No community exists with that DID."
+				},
+				{
+					"name": "MemberNotFound",
+					"description": "The requesting user does not hold a member record in this community."
+				},
+				{
+					"name": "SoleOwner",
+					"description": "The requesting user is the last holder of a protected role and cannot leave."
+				},
+				{
+					"name": "CredentialsUnavailable",
+					"description": "The AppView's stored credentials for this community are missing or unusable."
+				}
+			]
+		}
+	}
+}

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

@@ -0,0 +1,73 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.community.listApplications",
+	"defs": {
+		"main": {
+			"type": "query",
+			"description": "Lists pending requests to join a community that requires approval.",
+			"parameters": {
+				"type": "params",
+				"required": ["community"],
+				"properties": {
+					"community": {
+						"type": "string",
+						"format": "did",
+						"description": "The community to list applications for."
+					},
+					"includeDismissed": {
+						"type": "boolean",
+						"default": false,
+						"description": "Whether to include applications a moderator has hidden from the active queue."
+					},
+					"limit": {
+						"type": "integer",
+						"minimum": 1,
+						"maximum": 100,
+						"default": 50,
+						"description": "Maximum number of applications to return."
+					},
+					"cursor": {
+						"type": "string",
+						"description": "Pagination cursor from a previous response."
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["applications"],
+					"properties": {
+						"cursor": {
+							"type": "string",
+							"description": "Pagination cursor for the next page, if more applications exist."
+						},
+						"applications": {
+							"type": "array",
+							"items": {
+								"type": "ref",
+								"ref": "social.colibri.community.defs#applicationView",
+								"description": "A pending application."
+							},
+							"description": "Applications matching the request."
+						}
+					}
+				}
+			},
+			"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."
+				}
+			]
+		}
+	}
+}

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

@@ -0,0 +1,68 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.community.listBans",
+	"defs": {
+		"main": {
+			"type": "query",
+			"description": "Lists the members currently banned from a community. Being banned means the community declines to issue them space credentials, so they cannot read it. Their existing messages stay in their own repos.",
+			"parameters": {
+				"type": "params",
+				"required": ["community"],
+				"properties": {
+					"community": {
+						"type": "string",
+						"format": "did",
+						"description": "The community to list bans for."
+					},
+					"limit": {
+						"type": "integer",
+						"minimum": 1,
+						"maximum": 100,
+						"default": 50,
+						"description": "Maximum number of bans to return."
+					},
+					"cursor": {
+						"type": "string",
+						"description": "Pagination cursor from a previous response."
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["bans"],
+					"properties": {
+						"cursor": {
+							"type": "string",
+							"description": "Pagination cursor for the next page, if more bans exist."
+						},
+						"bans": {
+							"type": "array",
+							"items": {
+								"type": "ref",
+								"ref": "social.colibri.community.defs#bannedActorView",
+								"description": "A ban."
+							},
+							"description": "Members currently banned, most recently banned first."
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request is missing, malformed, or unverifiable service auth."
+				},
+				{
+					"name": "Forbidden",
+					"description": "The caller lacks the member.ban permission."
+				},
+				{
+					"name": "CommunityNotFound",
+					"description": "No community exists at the given DID."
+				}
+			]
+		}
+	}
+}

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

@@ -0,0 +1,52 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.community.listCategories",
+	"defs": {
+		"main": {
+			"type": "query",
+			"description": "Gets the community's category layout, each category with its channels already nested. This is what a client needs to draw the sidebar in one call.",
+			"parameters": {
+				"type": "params",
+				"required": ["community"],
+				"properties": {
+					"community": {
+						"type": "string",
+						"format": "did",
+						"description": "The community to list categories of."
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["categories"],
+					"properties": {
+						"categories": {
+							"type": "array",
+							"items": {
+								"type": "ref",
+								"ref": "social.colibri.community.defs#categoryView"
+							},
+							"description": "The community's categories, in display order."
+						}
+					}
+				}
+			},
+			"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 categories."
+				},
+				{
+					"name": "CommunityNotFound",
+					"description": "No community exists with that DID."
+				}
+			]
+		}
+	}
+}

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

@@ -0,0 +1,52 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.community.listChannels",
+	"defs": {
+		"main": {
+			"type": "query",
+			"description": "Lists a community's channels as a flat list, for clients that do not need the category grouping.",
+			"parameters": {
+				"type": "params",
+				"required": ["community"],
+				"properties": {
+					"community": {
+						"type": "string",
+						"format": "did",
+						"description": "The community to list channels of."
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["channels"],
+					"properties": {
+						"channels": {
+							"type": "array",
+							"items": {
+								"type": "ref",
+								"ref": "social.colibri.community.defs#channelView"
+							},
+							"description": "The community's channels."
+						}
+					}
+				}
+			},
+			"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 channels."
+				},
+				{
+					"name": "CommunityNotFound",
+					"description": "No community exists with that DID."
+				}
+			]
+		}
+	}
+}

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

@@ -0,0 +1,67 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.community.listInvitations",
+	"defs": {
+		"main": {
+			"type": "query",
+			"description": "Lists a community's invitation codes.",
+			"parameters": {
+				"type": "params",
+				"required": ["community"],
+				"properties": {
+					"community": {
+						"type": "string",
+						"format": "did",
+						"description": "The community to list invitations for."
+					},
+					"limit": {
+						"type": "integer",
+						"minimum": 1,
+						"maximum": 100,
+						"default": 50,
+						"description": "The maximum number of results to return."
+					},
+					"cursor": {
+						"type": "string",
+						"description": "The cursor from a previous call, for fetching the next page."
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["invitations"],
+					"properties": {
+						"cursor": {
+							"type": "string",
+							"description": "A cursor for fetching the next page."
+						},
+						"invitations": {
+							"type": "array",
+							"items": {
+								"type": "ref",
+								"ref": "social.colibri.community.defs#invitationView"
+							},
+							"description": "The community's invitations."
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request is missing, malformed, or unverifiable service auth."
+				},
+				{
+					"name": "Forbidden",
+					"description": "The requesting user lacks the invitation.create permission."
+				},
+				{
+					"name": "CommunityNotFound",
+					"description": "No community exists with that DID."
+				}
+			]
+		}
+	}
+}

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

@@ -0,0 +1,72 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.community.listMembers",
+	"defs": {
+		"main": {
+			"type": "query",
+			"description": "Lists a community's admitted members.",
+			"parameters": {
+				"type": "params",
+				"required": ["community"],
+				"properties": {
+					"community": {
+						"type": "string",
+						"format": "did",
+						"description": "The community to list members of."
+					},
+					"role": {
+						"type": "string",
+						"format": "record-key",
+						"description": "Filters to members holding this role."
+					},
+					"limit": {
+						"type": "integer",
+						"minimum": 1,
+						"maximum": 100,
+						"default": 50,
+						"description": "The maximum number of results to return."
+					},
+					"cursor": {
+						"type": "string",
+						"description": "The cursor from a previous call, for fetching the next page."
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["members"],
+					"properties": {
+						"cursor": {
+							"type": "string",
+							"description": "A cursor for fetching the next page."
+						},
+						"members": {
+							"type": "array",
+							"items": {
+								"type": "ref",
+								"ref": "social.colibri.community.defs#memberView"
+							},
+							"description": "The community's members."
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request is missing, malformed, or unverifiable service auth."
+				},
+				{
+					"name": "Forbidden",
+					"description": "The requesting user lacks permission to list this community's members."
+				},
+				{
+					"name": "CommunityNotFound",
+					"description": "No community exists with that DID."
+				}
+			]
+		}
+	}
+}