@colibri-social/lexicons 0.1.0

package/lexicons/social/colibri/permissionMessaging.json

@@ -0,0 +1,74 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.permissionMessaging",
+	"defs": {
+		"main": {
+			"type": "permission-set",
+			"title": "Colibri messages",
+			"detail": "Read and post in the Colibri communities you belong to.",
+			"permissions": [
+				{
+					"type": "permission",
+					"resource": "space",
+					"spaceType": "social.colibri.channel.text",
+					"authority": "*",
+					"collection": ["social.colibri.message", "social.colibri.reaction"],
+					"action": ["read", "create", "update", "delete"]
+				},
+				{
+					"type": "permission",
+					"resource": "space",
+					"spaceType": "social.colibri.channel.voice",
+					"authority": "*",
+					"action": ["read"]
+				},
+				{
+					"type": "permission",
+					"resource": "space",
+					"spaceType": "social.colibri.community.profile",
+					"authority": "*",
+					"action": ["read"]
+				},
+				{
+					"type": "permission",
+					"resource": "space",
+					"spaceType": "social.colibri.community.configuration",
+					"authority": "*",
+					"action": ["read"]
+				},
+				{
+					"type": "permission",
+					"resource": "space",
+					"spaceType": "social.colibri.community.members",
+					"authority": "*",
+					"action": ["read"]
+				},
+				{
+					"type": "permission",
+					"resource": "rpc",
+					"inheritAud": true,
+					"lxm": [
+						"social.colibri.community.getCommunity",
+						"social.colibri.community.join",
+						"social.colibri.community.leave",
+						"social.colibri.community.listCategories",
+						"social.colibri.community.listChannels",
+						"social.colibri.community.listMembers",
+						"social.colibri.community.listRoles",
+						"social.colibri.community.getInvitation",
+						"social.colibri.channel.getChannel",
+						"social.colibri.channel.listMessages",
+						"social.colibri.channel.listReactions",
+						"social.colibri.channel.listUnreadStatus",
+						"social.colibri.channel.putReadCursors",
+						"social.colibri.embed.getMetadata",
+						"social.colibri.embed.searchGifs",
+						"social.colibri.embed.trendingGifs",
+						"social.colibri.embed.gifCategories",
+						"social.colibri.blob.get"
+					]
+				}
+			]
+		}
+	}
+}

package/lexicons/social/colibri/permissionNotification.json

@@ -0,0 +1,25 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.permissionNotification",
+	"defs": {
+		"main": {
+			"type": "permission-set",
+			"title": "Colibri notifications",
+			"detail": "Read your Colibri notifications and mark them as seen.",
+			"permissions": [
+				{
+					"type": "permission",
+					"resource": "rpc",
+					"inheritAud": true,
+					"lxm": [
+						"social.colibri.notification.listNotifications",
+						"social.colibri.notification.getUnreadCount",
+						"social.colibri.notification.getUnseen",
+						"social.colibri.notification.updateSeen",
+						"social.colibri.notification.updateSeenForMessage"
+					]
+				}
+			]
+		}
+	}
+}

package/lexicons/social/colibri/permissionPush.json

@@ -0,0 +1,22 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.permissionPush",
+	"defs": {
+		"main": {
+			"type": "permission-set",
+			"title": "Colibri push notifications",
+			"detail": "Send push notifications to this device when Colibri is closed.",
+			"permissions": [
+				{
+					"type": "permission",
+					"resource": "rpc",
+					"inheritAud": true,
+					"lxm": [
+						"social.colibri.notification.registerPush",
+						"social.colibri.notification.unregisterPush"
+					]
+				}
+			]
+		}
+	}
+}

package/lexicons/social/colibri/reaction.json

@@ -0,0 +1,27 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.reaction",
+	"defs": {
+		"main": {
+			"type": "record",
+			"description": "A reaction to a message in the same channel space.",
+			"key": "tid",
+			"record": {
+				"type": "object",
+				"required": ["emoji", "target"],
+				"properties": {
+					"emoji": {
+						"type": "string",
+						"maxLength": 64,
+						"description": "The reaction, as an emoji or a custom shortcode."
+					},
+					"target": {
+						"type": "ref",
+						"ref": "social.colibri.defs#recordRef",
+						"description": "The message being reacted to."
+					}
+				}
+			}
+		}
+	}
+}

package/lexicons/social/colibri/richtext/facet.json

@@ -0,0 +1,208 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.richtext.facet",
+	"defs": {
+		"main": {
+			"type": "object",
+			"description": "An annotation over a range of a message's text.",
+			"required": ["index", "features"],
+			"properties": {
+				"index": {
+					"type": "ref",
+					"ref": "#byteSlice",
+					"description": "The range of the text this facet covers."
+				},
+				"features": {
+					"type": "array",
+					"items": {
+						"type": "union",
+						"refs": [
+							"#bold",
+							"#italic",
+							"#underline",
+							"#strikethrough",
+							"#code",
+							"#codeblock",
+							"#quote",
+							"#heading",
+							"#list",
+							"#subtext",
+							"#spoiler",
+							"#mention",
+							"#role",
+							"#channel",
+							"#link",
+							"#time"
+						]
+					},
+					"description": "What the range means. A range may carry more than one feature."
+				}
+			}
+		},
+		"byteSlice": {
+			"type": "object",
+			"description": "The range a feature applies to, as zero-based byte offsets into the UTF-8 encoded text. Start is inclusive, end is exclusive.",
+			"required": ["byteStart", "byteEnd"],
+			"properties": {
+				"byteStart": {
+					"type": "integer",
+					"minimum": 0,
+					"description": "First byte of the range, inclusive."
+				},
+				"byteEnd": {
+					"type": "integer",
+					"minimum": 0,
+					"description": "Byte after the range, exclusive."
+				}
+			}
+		},
+		"bold": {
+			"type": "object",
+			"description": "Bold text.",
+			"properties": {}
+		},
+		"italic": {
+			"type": "object",
+			"description": "Italic text.",
+			"properties": {}
+		},
+		"underline": {
+			"type": "object",
+			"description": "Underlined text.",
+			"properties": {}
+		},
+		"strikethrough": {
+			"type": "object",
+			"description": "Struck-through text.",
+			"properties": {}
+		},
+		"code": {
+			"type": "object",
+			"description": "Inline code.",
+			"properties": {}
+		},
+		"codeblock": {
+			"type": "object",
+			"description": "A multi-line code block.",
+			"properties": {
+				"lang": {
+					"type": "string",
+					"maxLength": 32,
+					"description": "Language hint."
+				}
+			}
+		},
+		"quote": {
+			"type": "object",
+			"description": "A block quote.",
+			"properties": {}
+		},
+		"heading": {
+			"type": "object",
+			"description": "A heading line.",
+			"required": ["level"],
+			"properties": {
+				"level": {
+					"type": "integer",
+					"minimum": 1,
+					"maximum": 3,
+					"description": "Heading level, from 1 to 3."
+				}
+			}
+		},
+		"list": {
+			"type": "object",
+			"description": "A list item line.",
+			"required": ["ordered"],
+			"properties": {
+				"ordered": {
+					"type": "boolean",
+					"description": "Whether the list is numbered."
+				}
+			}
+		},
+		"subtext": {
+			"type": "object",
+			"description": "Small, muted text.",
+			"properties": {}
+		},
+		"spoiler": {
+			"type": "object",
+			"description": "Text hidden until revealed.",
+			"properties": {}
+		},
+		"mention": {
+			"type": "object",
+			"description": "A user mention.",
+			"required": ["did"],
+			"properties": {
+				"did": {
+					"type": "string",
+					"format": "did",
+					"description": "The mentioned user."
+				}
+			}
+		},
+		"role": {
+			"type": "object",
+			"description": "A role mention. Roles are only ever written by the community, and a channel space's authority is its community, so the role key alone is unambiguous.",
+			"required": ["role"],
+			"properties": {
+				"role": {
+					"type": "string",
+					"format": "record-key",
+					"description": "The mentioned role."
+				}
+			}
+		},
+		"channel": {
+			"type": "object",
+			"description": "A channel reference, by the channel's space key within the same community.",
+			"required": ["channel"],
+			"properties": {
+				"channel": {
+					"type": "string",
+					"format": "record-key",
+					"description": "The referenced channel."
+				}
+			}
+		},
+		"link": {
+			"type": "object",
+			"description": "A hyperlink.",
+			"required": ["uri"],
+			"properties": {
+				"uri": {
+					"type": "string",
+					"format": "uri",
+					"description": "Where the link points."
+				}
+			}
+		},
+		"time": {
+			"type": "object",
+			"description": "A timestamp rendered in the reader's locale.",
+			"required": ["datetime"],
+			"properties": {
+				"datetime": {
+					"type": "string",
+					"format": "datetime",
+					"description": "The instant being referred to."
+				},
+				"style": {
+					"type": "string",
+					"knownValues": [
+						"time-short",
+						"time-long",
+						"date-short",
+						"date-long",
+						"datetime-short",
+						"datetime-long",
+						"relative"
+					],
+					"description": "How to render it."
+				}
+			}
+		}
+	}
+}

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

@@ -0,0 +1,95 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.role.create",
+	"defs": {
+		"main": {
+			"type": "procedure",
+			"description": "Creates a role in a community.",
+			"input": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["community", "name", "permissions"],
+					"properties": {
+						"community": {
+							"type": "string",
+							"format": "did",
+							"description": "The community to create the role in."
+						},
+						"name": {
+							"type": "string",
+							"minLength": 1,
+							"maxLength": 32,
+							"description": "Display name."
+						},
+						"permissions": {
+							"type": "array",
+							"items": {
+								"type": "string",
+								"description": "A namespaced permission identifier."
+							},
+							"description": "Permissions granted by this role."
+						},
+						"color": {
+							"type": "string",
+							"maxLength": 7,
+							"description": "Hex colour as #rrggbb."
+						},
+						"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."
+						}
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["role"],
+					"properties": {
+						"role": {
+							"type": "ref",
+							"ref": "social.colibri.community.defs#roleView",
+							"description": "The newly created 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": "InvalidRequest",
+					"description": "The arguments are inconsistent or malformed beyond schema validation."
+				},
+				{
+					"name": "RoleHierarchy",
+					"description": "The requested position is at or above the caller's highest role position, or the permissions include one 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/role/delete.json

@@ -0,0 +1,66 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.role.delete",
+	"defs": {
+		"main": {
+			"type": "procedure",
+			"description": "Deletes a role.",
+			"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."
+						}
+					}
+				}
+			},
+			"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 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 deleted."
+				},
+				{
+					"name": "RoleHierarchy",
+					"description": "The role is 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/role/update.json

@@ -0,0 +1,113 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.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.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.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."
+				}
+			]
+		}
+	}
+}