@colibri-social/lexicons 2.18.0 → 2.19.0

package/lexicons/social/colibri/beta/emoji/updatePack.json

@@ -0,0 +1,102 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.beta.emoji.updatePack",
+	"defs": {
+		"main": {
+			"type": "procedure",
+			"description": "Renames a community's pack or replaces its emoji. Omitted fields stay as they are.",
+			"input": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["community", "pack"],
+					"properties": {
+						"community": {
+							"type": "string",
+							"format": "did",
+							"description": "The community that owns the emoji."
+						},
+						"pack": {
+							"type": "string",
+							"format": "at-uri",
+							"description": "The pack's record URI in the community's repo."
+						},
+						"name": {
+							"type": "string",
+							"minLength": 1,
+							"maxLength": 64,
+							"description": "The new name."
+						},
+						"description": {
+							"type": "string",
+							"maxLength": 3000,
+							"maxGraphemes": 300,
+							"description": "The new description. An empty string clears it."
+						},
+						"emojis": {
+							"type": "array",
+							"maxLength": 500,
+							"items": {
+								"type": "string",
+								"format": "at-uri"
+							},
+							"description": "The full new list of emoji URIs, in order."
+						}
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["pack"],
+					"properties": {
+						"pack": {
+							"type": "ref",
+							"ref": "social.colibri.beta.emoji.defs#packView",
+							"description": "The pack as stored."
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request is missing, malformed, or unverifiable service auth."
+				},
+				{
+					"name": "Forbidden",
+					"description": "The caller lacks the community.manage permission."
+				},
+				{
+					"name": "CommunityNotFound",
+					"description": "No community exists at the given DID."
+				},
+				{
+					"name": "PackNotFound",
+					"description": "No pack of this community exists at the given URI."
+				},
+				{
+					"name": "EmojiNotFound",
+					"description": "No emoji of this community exists at the given URI."
+				},
+				{
+					"name": "UnsupportedProvider",
+					"description": "The emoji provider is unknown, or it does not support the requested operation."
+				},
+				{
+					"name": "InvalidName",
+					"description": "The pack name is empty or longer than 64 characters."
+				},
+				{
+					"name": "CredentialsUnavailable",
+					"description": "The AppView cannot act as the community because its stored credentials are missing or unusable."
+				},
+				{
+					"name": "UpstreamFailure",
+					"description": "A PDS call the AppView depends on failed."
+				}
+			]
+		}
+	}
+}

package/lexicons/social/colibri/beta/emoji/upload.json

@@ -0,0 +1,101 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.beta.emoji.upload",
+	"defs": {
+		"main": {
+			"type": "procedure",
+			"description": "Adds a custom emoji to a community. The bytes are uploaded to the community's own repo and the AppView writes the provider's record there with the community's credentials.",
+			"parameters": {
+				"type": "params",
+				"required": ["community", "name"],
+				"properties": {
+					"community": {
+						"type": "string",
+						"format": "did",
+						"description": "The community that owns the emoji."
+					},
+					"name": {
+						"type": "string",
+						"minLength": 2,
+						"maxLength": 32,
+						"description": "The emoji's name without colons. Lowercase letters, digits and underscores."
+					},
+					"pack": {
+						"type": "string",
+						"format": "at-uri",
+						"description": "A pack of the community to add the emoji to."
+					},
+					"provider": {
+						"type": "string",
+						"description": "The emoji provider that writes the records. Defaults to the AppView's default provider.",
+						"knownValues": ["blue.moji"]
+					}
+				}
+			},
+			"input": {
+				"encoding": "image/*",
+				"description": "The raw image bytes. The provider sets the size limit and the accepted types, which is 128000 bytes of image/png, image/webp or image/gif for blue.moji. The content type is sniffed rather than trusted."
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["emoji"],
+					"properties": {
+						"emoji": {
+							"type": "ref",
+							"ref": "social.colibri.beta.emoji.defs#emojiView",
+							"description": "The emoji as stored."
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request is missing, malformed, or unverifiable service auth."
+				},
+				{
+					"name": "Forbidden",
+					"description": "The caller lacks the community.manage permission."
+				},
+				{
+					"name": "CommunityNotFound",
+					"description": "No community exists at the given DID."
+				},
+				{
+					"name": "InvalidName",
+					"description": "The name is not 2 to 32 characters of lowercase letters, digits and underscores."
+				},
+				{
+					"name": "NameTaken",
+					"description": "The community already has an emoji with this name."
+				},
+				{
+					"name": "PackNotFound",
+					"description": "No pack of this community exists at the given URI."
+				},
+				{
+					"name": "UnsupportedProvider",
+					"description": "The emoji provider is unknown, or it does not support the requested operation."
+				},
+				{
+					"name": "UnsupportedImage",
+					"description": "The bytes are not an image type the provider accepts."
+				},
+				{
+					"name": "ImageTooLarge",
+					"description": "The image exceeds the provider's size limit."
+				},
+				{
+					"name": "CredentialsUnavailable",
+					"description": "The AppView cannot act as the community because its stored credentials are missing or unusable."
+				},
+				{
+					"name": "UpstreamFailure",
+					"description": "A PDS call the AppView depends on failed."
+				}
+			]
+		}
+	}
+}

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

@@ -105,6 +105,13 @@
 						"social.colibri.beta.role.update",
 						"social.colibri.beta.role.delete",
 						"social.colibri.beta.role.putBadgeImage",
+						"social.colibri.beta.emoji.getCatalog",
+						"social.colibri.beta.emoji.upload",
+						"social.colibri.beta.emoji.rename",
+						"social.colibri.beta.emoji.delete",
+						"social.colibri.beta.emoji.createPack",
+						"social.colibri.beta.emoji.updatePack",
+						"social.colibri.beta.emoji.deletePack",
 						"social.colibri.beta.voice.moderate",
 						"social.colibri.beta.thread.delete",
 						"social.colibri.beta.thread.repoint",

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

@@ -47,7 +47,7 @@
 							"items": {
 								"type": "string",
 								"description": "A feature identifier.",
-								"knownValues": ["voice", "push", "gifs", "embeds"]
+								"knownValues": ["voice", "push", "gifs", "embeds", "emoji"]
 							}
 						},
 						"defaultCommunity": {

package/lexicons/social/colibri/beta/sync/defs.json

@@ -465,6 +465,23 @@
 				}
 			}
 		},
+		"emojiEvent": {
+			"type": "object",
+			"description": "A repo's custom emoji or packs changed. Sent to a community's subscribers for its own emoji, and to a user's own connections for theirs. Carries the whole catalog so clients replace it in one step.",
+			"required": ["owner", "catalog"],
+			"properties": {
+				"owner": {
+					"type": "string",
+					"format": "did",
+					"description": "The community or user whose catalog changed."
+				},
+				"catalog": {
+					"type": "ref",
+					"ref": "social.colibri.beta.emoji.defs#catalogView",
+					"description": "The catalog after the change."
+				}
+			}
+		},
 		"labelEvent": {
 			"type": "object",
 			"description": "A label was applied or retracted on a record in a subscribed space.",

package/package.json

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