@colibri-social/lexicons 0.1.0 → 2.0.0

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

@@ -0,0 +1,113 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.beta.role.update",
+	"defs": {
+		"main": {
+			"type": "procedure",
+			"description": "Updates a role's settings.",
+			"input": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["community", "role"],
+					"properties": {
+						"community": {
+							"type": "string",
+							"format": "did",
+							"description": "The community the role belongs to."
+						},
+						"role": {
+							"type": "string",
+							"format": "record-key",
+							"description": "The role's record key."
+						},
+						"name": {
+							"type": "string",
+							"minLength": 1,
+							"maxLength": 32,
+							"description": "Display name."
+						},
+						"color": {
+							"type": "string",
+							"maxLength": 7,
+							"description": "Hex colour as #rrggbb."
+						},
+						"permissions": {
+							"type": "array",
+							"items": {
+								"type": "string",
+								"description": "A namespaced permission identifier."
+							},
+							"description": "Permissions granted by this role."
+						},
+						"position": {
+							"type": "integer",
+							"description": "Hierarchy position. Higher outranks lower."
+						},
+						"hoisted": {
+							"type": "boolean",
+							"description": "Whether holders are listed separately in the member list."
+						},
+						"mentionable": {
+							"type": "boolean",
+							"description": "Whether @role mentions resolve to this role."
+						},
+						"channelOverrides": {
+							"type": "array",
+							"items": {
+								"type": "ref",
+								"ref": "social.colibri.beta.community.defs#roleChannelOverride",
+								"description": "A per-channel permission override."
+							},
+							"description": "Per-channel overrides."
+						}
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["role"],
+					"properties": {
+						"role": {
+							"type": "ref",
+							"ref": "social.colibri.beta.community.defs#roleView",
+							"description": "The updated role."
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request is missing, malformed, or unverifiable service auth."
+				},
+				{
+					"name": "Forbidden",
+					"description": "The caller lacks the role.manage permission."
+				},
+				{
+					"name": "CommunityNotFound",
+					"description": "No community exists at the given DID."
+				},
+				{
+					"name": "RoleNotFound",
+					"description": "No role exists at the given record key."
+				},
+				{
+					"name": "RoleProtected",
+					"description": "The role is marked protected and cannot be modified."
+				},
+				{
+					"name": "RoleHierarchy",
+					"description": "The change would place the role at or above the caller's highest role position, or grants a permission the caller does not hold."
+				},
+				{
+					"name": "CredentialsUnavailable",
+					"description": "The AppView cannot act as the community because its stored credentials are missing or unusable."
+				}
+			]
+		}
+	}
+}

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

@@ -0,0 +1,89 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.beta.role",
+	"defs": {
+		"main": {
+			"type": "record",
+			"description": "A named bundle of permissions assignable to community members.",
+			"key": "tid",
+			"record": {
+				"type": "object",
+				"required": ["name", "permissions", "position"],
+				"properties": {
+					"name": {
+						"type": "string",
+						"minLength": 1,
+						"maxLength": 32,
+						"description": "Display name."
+					},
+					"color": {
+						"type": "string",
+						"maxLength": 7,
+						"description": "Hex colour as #rrggbb."
+					},
+					"permissions": {
+						"type": "array",
+						"items": {
+							"type": "string",
+							"description": "A namespaced permission identifier."
+						},
+						"description": "Permissions granted by this role."
+					},
+					"position": {
+						"type": "integer",
+						"description": "Hierarchy position. Higher outranks lower."
+					},
+					"hoisted": {
+						"type": "boolean",
+						"default": false,
+						"description": "Whether holders are listed separately in the member list."
+					},
+					"mentionable": {
+						"type": "boolean",
+						"default": false,
+						"description": "Whether @role mentions resolve to this role."
+					},
+					"protected": {
+						"type": "boolean",
+						"default": false,
+						"description": "Whether this role is exempt from modification and deletion. Set on the owner role created with the community."
+					},
+					"channelOverrides": {
+						"type": "array",
+						"items": {
+							"type": "ref",
+							"ref": "#channelOverride"
+						},
+						"description": "Per-channel permission overrides."
+					}
+				}
+			}
+		},
+		"channelOverride": {
+			"type": "object",
+			"description": "Allow and deny lists scoped to a single channel.",
+			"required": ["channel"],
+			"properties": {
+				"channel": {
+					"type": "string",
+					"format": "record-key",
+					"description": "The space key of the channel this override applies to."
+				},
+				"allow": {
+					"type": "array",
+					"items": {
+						"type": "string"
+					},
+					"description": "Permissions granted within this channel."
+				},
+				"deny": {
+					"type": "array",
+					"items": {
+						"type": "string"
+					},
+					"description": "Permissions denied within this channel. Deny beats both the base permissions and allow."
+				}
+			}
+		}
+	}
+}

package/lexicons/social/colibri/beta/server/describeServer.json

@@ -0,0 +1,59 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.beta.server.describeServer",
+	"defs": {
+		"main": {
+			"type": "query",
+			"description": "Gets information about this AppView.",
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["did", "version", "handleDomain", "pds"],
+					"properties": {
+						"did": {
+							"type": "string",
+							"format": "did",
+							"description": "The AppView's own identity."
+						},
+						"version": {
+							"type": "string",
+							"description": "The running software version."
+						},
+						"handleDomain": {
+							"type": "string",
+							"description": "The domain community handles are minted under."
+						},
+						"pds": {
+							"type": "string",
+							"format": "uri",
+							"description": "The PDS communities are created on."
+						},
+						"contact": {
+							"type": "string",
+							"description": "How to reach the operator."
+						},
+						"features": {
+							"type": "array",
+							"description": "Optional features this AppView supports.",
+							"items": {
+								"type": "string",
+								"description": "A feature identifier.",
+								"knownValues": ["voice", "push", "gifs", "embeds"]
+							}
+						},
+						"spaceTypes": {
+							"type": "array",
+							"description": "The space types this AppView understands.",
+							"items": {
+								"type": "string",
+								"format": "nsid",
+								"description": "A space type."
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}