@colibri-social/lexicons 2.17.0 → 2.19.0

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

@@ -0,0 +1,173 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.beta.emoji.defs",
+	"defs": {
+		"emojiImage": {
+			"type": "object",
+			"description": "One stored rendition of an emoji.",
+			"required": ["cid", "format", "animated"],
+			"properties": {
+				"cid": {
+					"type": "string",
+					"format": "cid",
+					"description": "The blob's CID in the owner's repo."
+				},
+				"format": {
+					"type": "string",
+					"description": "The image format.",
+					"knownValues": ["png", "webp", "gif", "apng", "lottie", "other"]
+				},
+				"mimeType": {
+					"type": "string",
+					"description": "The blob's MIME type."
+				},
+				"size": {
+					"type": "integer",
+					"minimum": 0,
+					"description": "The blob's size in bytes."
+				},
+				"animated": {
+					"type": "boolean",
+					"description": "Whether the format is animated."
+				},
+				"pixels": {
+					"type": "integer",
+					"minimum": 1,
+					"description": "The rendition's longest edge in pixels, when the provider fixes one."
+				}
+			}
+		},
+		"emojiView": {
+			"type": "object",
+			"description": "A custom emoji, normalised from its provider's record.",
+			"required": ["uri", "provider", "owner", "name", "images", "createdAt"],
+			"properties": {
+				"uri": {
+					"type": "string",
+					"format": "at-uri",
+					"description": "The emoji's record URI."
+				},
+				"cid": {
+					"type": "string",
+					"format": "cid",
+					"description": "The record's CID."
+				},
+				"provider": {
+					"type": "string",
+					"description": "The emoji provider whose lexicon the record uses.",
+					"knownValues": ["blue.moji"]
+				},
+				"owner": {
+					"type": "string",
+					"format": "did",
+					"description": "The repo that holds the record and its blobs."
+				},
+				"name": {
+					"type": "string",
+					"description": "The name without colons."
+				},
+				"alt": {
+					"type": "string",
+					"description": "Alt text for the image."
+				},
+				"fallback": {
+					"type": "string",
+					"description": "The text shown where the image cannot render."
+				},
+				"images": {
+					"type": "array",
+					"items": {
+						"type": "ref",
+						"ref": "#emojiImage"
+					},
+					"description": "Every rendition the record carries."
+				},
+				"adultOnly": {
+					"type": "boolean",
+					"description": "Whether the owner marked the emoji as adult content."
+				},
+				"copyOf": {
+					"type": "string",
+					"format": "at-uri",
+					"description": "The emoji this one was copied from."
+				},
+				"createdAt": {
+					"type": "string",
+					"format": "datetime",
+					"description": "When the record was created."
+				}
+			}
+		},
+		"packView": {
+			"type": "object",
+			"description": "A named group of custom emoji, normalised from its provider's records.",
+			"required": ["uri", "provider", "owner", "name", "emojis", "createdAt"],
+			"properties": {
+				"uri": {
+					"type": "string",
+					"format": "at-uri",
+					"description": "The pack's record URI."
+				},
+				"provider": {
+					"type": "string",
+					"description": "The emoji provider whose lexicon the record uses.",
+					"knownValues": ["blue.moji"]
+				},
+				"owner": {
+					"type": "string",
+					"format": "did",
+					"description": "The repo that holds the pack."
+				},
+				"name": {
+					"type": "string",
+					"description": "The pack's name."
+				},
+				"description": {
+					"type": "string",
+					"description": "The pack's description."
+				},
+				"emojis": {
+					"type": "array",
+					"items": {
+						"type": "string",
+						"format": "at-uri"
+					},
+					"description": "The URIs of the emoji in the pack, in the order they were added. Only emoji present in the catalog are listed."
+				},
+				"createdAt": {
+					"type": "string",
+					"format": "datetime",
+					"description": "When the record was created."
+				}
+			}
+		},
+		"catalogView": {
+			"type": "object",
+			"description": "Every custom emoji and pack in one repo. For a community this is its own emoji. For a user it is the emoji they uploaded or copied.",
+			"required": ["owner", "emojis", "packs"],
+			"properties": {
+				"owner": {
+					"type": "string",
+					"format": "did",
+					"description": "The repo the catalog belongs to."
+				},
+				"emojis": {
+					"type": "array",
+					"items": {
+						"type": "ref",
+						"ref": "#emojiView"
+					},
+					"description": "Every emoji in the repo."
+				},
+				"packs": {
+					"type": "array",
+					"items": {
+						"type": "ref",
+						"ref": "#packView"
+					},
+					"description": "Every pack in the repo."
+				}
+			}
+		}
+	}
+}

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

@@ -0,0 +1,66 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.beta.emoji.delete",
+	"defs": {
+		"main": {
+			"type": "procedure",
+			"description": "Deletes a community's custom emoji and removes it from every pack of the community. Copies other people made stay in their repos.",
+			"input": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["community", "emoji"],
+					"properties": {
+						"community": {
+							"type": "string",
+							"format": "did",
+							"description": "The community that owns the emoji."
+						},
+						"emoji": {
+							"type": "string",
+							"format": "at-uri",
+							"description": "The emoji's record URI in the community's repo."
+						}
+					}
+				}
+			},
+			"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 community.manage permission."
+				},
+				{
+					"name": "CommunityNotFound",
+					"description": "No community exists at the given DID."
+				},
+				{
+					"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": "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/deletePack.json

@@ -0,0 +1,66 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.beta.emoji.deletePack",
+	"defs": {
+		"main": {
+			"type": "procedure",
+			"description": "Deletes a community's pack. The emoji in it stay.",
+			"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."
+						}
+					}
+				}
+			},
+			"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 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": "UnsupportedProvider",
+					"description": "The emoji provider is unknown, or it does not support the requested operation."
+				},
+				{
+					"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/getCatalog.json

@@ -0,0 +1,41 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.beta.emoji.getCatalog",
+	"defs": {
+		"main": {
+			"type": "query",
+			"description": "Lists the custom emoji and packs in one repo, from every supported emoji provider. Works for communities and users alike, since the records are public.",
+			"parameters": {
+				"type": "params",
+				"required": ["owner"],
+				"properties": {
+					"owner": {
+						"type": "string",
+						"format": "did",
+						"description": "The community or user whose emoji to list."
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["catalog"],
+					"properties": {
+						"catalog": {
+							"type": "ref",
+							"ref": "social.colibri.beta.emoji.defs#catalogView",
+							"description": "The repo's emoji and packs."
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "UpstreamFailure",
+					"description": "A PDS call the AppView depends on failed."
+				}
+			]
+		}
+	}
+}

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

@@ -0,0 +1,87 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.beta.emoji.rename",
+	"defs": {
+		"main": {
+			"type": "procedure",
+			"description": "Renames a community's custom emoji. Providers that key records by name move the record to a new key and repoint pack memberships, so the emoji's URI changes.",
+			"input": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["community", "emoji", "name"],
+					"properties": {
+						"community": {
+							"type": "string",
+							"format": "did",
+							"description": "The community that owns the emoji."
+						},
+						"emoji": {
+							"type": "string",
+							"format": "at-uri",
+							"description": "The emoji's record URI in the community's repo."
+						},
+						"name": {
+							"type": "string",
+							"minLength": 2,
+							"maxLength": 32,
+							"description": "The emoji's name without colons. Lowercase letters, digits and underscores."
+						}
+					}
+				}
+			},
+			"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": "EmojiNotFound",
+					"description": "No emoji of this community exists at the given URI."
+				},
+				{
+					"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": "UnsupportedProvider",
+					"description": "The emoji provider is unknown, or it does not support the requested operation."
+				},
+				{
+					"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/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/message.json

@@ -121,6 +121,16 @@
 					"maxLength": 256,
 					"description": "The original filename."
 				},
+				"width": {
+					"type": "integer",
+					"minimum": 1,
+					"description": "Intrinsic pixel width, when the file is an image or video."
+				},
+				"height": {
+					"type": "integer",
+					"minimum": 1,
+					"description": "Intrinsic pixel height, when the file is an image or video."
+				},
 				"spoiler": {
 					"type": "boolean",
 					"description": "Whether clients hide the file behind a reveal step until the reader chooses to see it."