@colibri-social/lexicons 0.1.0

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

@@ -0,0 +1,88 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.community.update",
+	"defs": {
+		"main": {
+			"type": "procedure",
+			"description": "Updates a community's settings. A field left absent stays unchanged.",
+			"input": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["community"],
+					"properties": {
+						"community": {
+							"type": "string",
+							"format": "did",
+							"description": "The community to update."
+						},
+						"name": {
+							"type": "string",
+							"minLength": 1,
+							"maxLength": 32,
+							"description": "The community's name."
+						},
+						"description": {
+							"type": "string",
+							"maxLength": 256,
+							"description": "The community's description."
+						},
+						"requiresApprovalToJoin": {
+							"type": "boolean",
+							"description": "Whether joining produces an application to approve."
+						},
+						"linkEmbeds": {
+							"type": "boolean",
+							"description": "Whether link previews are shown by default."
+						},
+						"labelers": {
+							"type": "array",
+							"items": {
+								"type": "string",
+								"format": "did",
+								"description": "A labeler."
+							},
+							"description": "DIDs whose labels this community honours."
+						}
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["community"],
+					"properties": {
+						"community": {
+							"type": "ref",
+							"ref": "social.colibri.community.defs#communityView",
+							"description": "The updated community."
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request is missing, malformed, or unverifiable service auth."
+				},
+				{
+					"name": "Forbidden",
+					"description": "The requesting user lacks the community.manage permission."
+				},
+				{
+					"name": "CommunityNotFound",
+					"description": "No community exists with that DID."
+				},
+				{
+					"name": "CredentialsUnavailable",
+					"description": "The AppView's stored credentials for this community are missing or unusable."
+				},
+				{
+					"name": "UpstreamFailure",
+					"description": "A PDS or third-party call the AppView depends on failed."
+				}
+			]
+		}
+	}
+}

package/lexicons/social/colibri/community.json

@@ -0,0 +1,43 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.community",
+	"defs": {
+		"main": {
+			"type": "record",
+			"description": "A community's public identity. Lives in the community's profile space, which is readable without membership unless the community is private.",
+			"key": "literal:self",
+			"record": {
+				"type": "object",
+				"required": ["name"],
+				"properties": {
+					"name": {
+						"type": "string",
+						"minLength": 1,
+						"maxLength": 32,
+						"description": "The community's name."
+					},
+					"description": {
+						"type": "string",
+						"maxLength": 256,
+						"description": "A short description."
+					},
+					"picture": {
+						"type": "blob",
+						"accept": ["image/jpeg", "image/png", "image/gif", "image/webp"],
+						"description": "Square image shown as the community's icon."
+					},
+					"banner": {
+						"type": "blob",
+						"accept": ["image/jpeg", "image/png", "image/gif", "image/webp"],
+						"description": "Wide image shown at the top of the community."
+					},
+					"migratedFrom": {
+						"type": "string",
+						"format": "at-uri",
+						"description": "Set on a community created by migrating a repo-backed community. Points at the legacy community record it replaces, so its history can be served alongside."
+					}
+				}
+			}
+		}
+	}
+}

package/lexicons/social/colibri/defs.json

@@ -0,0 +1,23 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.defs",
+	"defs": {
+		"recordRef": {
+			"type": "object",
+			"description": "A reference to a record in the same space. Record keys are unique per repo rather than per space, so a bare key cannot address a record in a space that aggregates many authors.",
+			"required": ["did", "rkey"],
+			"properties": {
+				"did": {
+					"type": "string",
+					"format": "did",
+					"description": "DID of the repo holding the referenced record."
+				},
+				"rkey": {
+					"type": "string",
+					"format": "record-key",
+					"description": "Record key of the referenced record."
+				}
+			}
+		}
+	}
+}

package/lexicons/social/colibri/embed/defs.json

@@ -0,0 +1,142 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.embed.defs",
+	"defs": {
+		"linkEmbed": {
+			"type": "object",
+			"description": "A link preview.",
+			"required": ["uri"],
+			"properties": {
+				"uri": {
+					"type": "string",
+					"format": "uri",
+					"description": "The URL previewed."
+				},
+				"title": {
+					"type": "string",
+					"description": "Page title."
+				},
+				"description": {
+					"type": "string",
+					"description": "Page description."
+				},
+				"siteName": {
+					"type": "string",
+					"description": "Publisher name."
+				},
+				"image": {
+					"type": "ref",
+					"ref": "#embedImage",
+					"description": "Preview image."
+				},
+				"video": {
+					"type": "ref",
+					"ref": "#embedVideo",
+					"description": "Playable video."
+				}
+			}
+		},
+		"embedImage": {
+			"type": "object",
+			"description": "A preview image.",
+			"required": ["url"],
+			"properties": {
+				"url": {
+					"type": "string",
+					"format": "uri",
+					"description": "URL served by this AppView's image proxy."
+				},
+				"width": {
+					"type": "integer",
+					"description": "Intrinsic pixel width."
+				},
+				"height": {
+					"type": "integer",
+					"description": "Intrinsic pixel height."
+				},
+				"alt": {
+					"type": "string",
+					"description": "Alternative text."
+				}
+			}
+		},
+		"embedVideo": {
+			"type": "object",
+			"description": "A playable video.",
+			"required": ["url", "mimeType"],
+			"properties": {
+				"url": {
+					"type": "string",
+					"format": "uri",
+					"description": "URL served by this AppView's video proxy."
+				},
+				"mimeType": {
+					"type": "string",
+					"description": "Content type.",
+					"knownValues": ["video/mp4", "video/webm"]
+				},
+				"width": {
+					"type": "integer",
+					"description": "Intrinsic pixel width."
+				},
+				"height": {
+					"type": "integer",
+					"description": "Intrinsic pixel height."
+				},
+				"duration": {
+					"type": "integer",
+					"description": "Duration in seconds."
+				}
+			}
+		},
+		"gifView": {
+			"type": "object",
+			"description": "A GIF from the picker.",
+			"required": ["id", "url", "previewUrl", "width", "height"],
+			"properties": {
+				"id": {
+					"type": "string",
+					"description": "Provider identifier, stable enough to save as a favourite."
+				},
+				"url": {
+					"type": "string",
+					"format": "uri",
+					"description": "Full-size GIF URL."
+				},
+				"previewUrl": {
+					"type": "string",
+					"format": "uri",
+					"description": "Smaller preview URL for the picker grid."
+				},
+				"width": {
+					"type": "integer",
+					"description": "Intrinsic pixel width."
+				},
+				"height": {
+					"type": "integer",
+					"description": "Intrinsic pixel height."
+				},
+				"title": {
+					"type": "string",
+					"description": "Human-readable title."
+				}
+			}
+		},
+		"gifCategory": {
+			"type": "object",
+			"description": "A category in the GIF picker.",
+			"required": ["name"],
+			"properties": {
+				"name": {
+					"type": "string",
+					"description": "Category name."
+				},
+				"previewUrl": {
+					"type": "string",
+					"format": "uri",
+					"description": "Representative image for the category."
+				}
+			}
+		}
+	}
+}

package/lexicons/social/colibri/embed/getMetadata.json

@@ -0,0 +1,53 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.embed.getMetadata",
+	"defs": {
+		"main": {
+			"type": "query",
+			"description": "Fetches and parses a link preview. The AppView fetches the URL on the client's behalf, so the client's address is never exposed to the target site.",
+			"parameters": {
+				"type": "params",
+				"required": ["uri"],
+				"properties": {
+					"uri": {
+						"type": "string",
+						"format": "uri",
+						"description": "The URL to preview."
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["embed"],
+					"properties": {
+						"embed": {
+							"type": "ref",
+							"ref": "social.colibri.embed.defs#linkEmbed",
+							"description": "The parsed preview."
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request has no valid service auth."
+				},
+				{
+					"name": "InvalidRequest",
+					"description": "The arguments are inconsistent or malformed beyond schema validation."
+				},
+				{
+					"name": "NotFetchable",
+					"description": "The target refused the request, timed out, or resolves to an address the AppView will not fetch."
+				},
+				{
+					"name": "UpstreamFailure",
+					"description": "The target site failed while the AppView fetched or parsed it."
+				}
+			]
+		}
+	}
+}

package/lexicons/social/colibri/embed/gifCategories.json

@@ -0,0 +1,41 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.embed.gifCategories",
+	"defs": {
+		"main": {
+			"type": "query",
+			"description": "Lists the categories shown in the GIF picker.",
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["categories"],
+					"properties": {
+						"categories": {
+							"type": "array",
+							"description": "The GIF picker's categories.",
+							"items": {
+								"type": "ref",
+								"ref": "social.colibri.embed.defs#gifCategory"
+							}
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request has no valid service auth."
+				},
+				{
+					"name": "GifsNotConfigured",
+					"description": "This AppView has no GIF provider key configured."
+				},
+				{
+					"name": "UpstreamFailure",
+					"description": "The GIF provider failed."
+				}
+			]
+		}
+	}
+}

package/lexicons/social/colibri/embed/searchGifs.json

@@ -0,0 +1,66 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.embed.searchGifs",
+	"defs": {
+		"main": {
+			"type": "query",
+			"description": "Searches the GIF picker's provider.",
+			"parameters": {
+				"type": "params",
+				"required": ["q"],
+				"properties": {
+					"q": {
+						"type": "string",
+						"description": "The search query."
+					},
+					"limit": {
+						"type": "integer",
+						"minimum": 1,
+						"maximum": 100,
+						"default": 50,
+						"description": "Maximum number of GIFs to return."
+					},
+					"cursor": {
+						"type": "string",
+						"description": "Pagination cursor from a previous call."
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["gifs"],
+					"properties": {
+						"cursor": {
+							"type": "string",
+							"description": "Pagination cursor for the next page."
+						},
+						"gifs": {
+							"type": "array",
+							"description": "GIFs matching the query.",
+							"items": {
+								"type": "ref",
+								"ref": "social.colibri.embed.defs#gifView"
+							}
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request has no valid service auth."
+				},
+				{
+					"name": "GifsNotConfigured",
+					"description": "This AppView has no GIF provider key configured."
+				},
+				{
+					"name": "UpstreamFailure",
+					"description": "The GIF provider failed."
+				}
+			]
+		}
+	}
+}

package/lexicons/social/colibri/embed/trendingGifs.json

@@ -0,0 +1,61 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.embed.trendingGifs",
+	"defs": {
+		"main": {
+			"type": "query",
+			"description": "Gets trending GIFs from the GIF picker's provider.",
+			"parameters": {
+				"type": "params",
+				"properties": {
+					"limit": {
+						"type": "integer",
+						"minimum": 1,
+						"maximum": 100,
+						"default": 50,
+						"description": "Maximum number of GIFs to return."
+					},
+					"cursor": {
+						"type": "string",
+						"description": "Pagination cursor from a previous call."
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["gifs"],
+					"properties": {
+						"cursor": {
+							"type": "string",
+							"description": "Pagination cursor for the next page."
+						},
+						"gifs": {
+							"type": "array",
+							"description": "Currently trending GIFs.",
+							"items": {
+								"type": "ref",
+								"ref": "social.colibri.embed.defs#gifView"
+							}
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request has no valid service auth."
+				},
+				{
+					"name": "GifsNotConfigured",
+					"description": "This AppView has no GIF provider key configured."
+				},
+				{
+					"name": "UpstreamFailure",
+					"description": "The GIF provider failed."
+				}
+			]
+		}
+	}
+}

package/lexicons/social/colibri/label.json

@@ -0,0 +1,73 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.label",
+	"defs": {
+		"main": {
+			"type": "record",
+			"description": "A label applied to a record in the same space. Permissioned content cannot be taken down by anyone but its author, so moderation of content is advisory: a reader honours the labels published by the labelers its community names.",
+			"key": "tid",
+			"record": {
+				"type": "object",
+				"required": ["subject", "val", "createdAt"],
+				"properties": {
+					"subject": {
+						"type": "ref",
+						"ref": "#subject",
+						"description": "The record this label applies to."
+					},
+					"val": {
+						"type": "string",
+						"maxLength": 128,
+						"knownValues": ["hidden", "spoiler", "embeds-suppressed"],
+						"description": "The label value."
+					},
+					"scope": {
+						"type": "array",
+						"items": {
+							"type": "string",
+							"format": "uri"
+						},
+						"description": "URIs within the subject record the label narrows to, for values that can apply to part of a record. Absent means the whole record."
+					},
+					"neg": {
+						"type": "boolean",
+						"default": false,
+						"description": "Whether this record retracts an earlier label of the same value."
+					},
+					"reason": {
+						"type": "string",
+						"maxLength": 512,
+						"description": "Human-readable reason."
+					},
+					"createdAt": {
+						"type": "string",
+						"format": "datetime",
+						"description": "When the label was applied."
+					}
+				}
+			}
+		},
+		"subject": {
+			"type": "object",
+			"description": "The labelled record, addressed within the space the label lives in.",
+			"required": ["did", "collection", "rkey"],
+			"properties": {
+				"did": {
+					"type": "string",
+					"format": "did",
+					"description": "DID of the repo holding the labelled record."
+				},
+				"collection": {
+					"type": "string",
+					"format": "nsid",
+					"description": "The labelled record's collection."
+				},
+				"rkey": {
+					"type": "string",
+					"format": "record-key",
+					"description": "The labelled record's key."
+				}
+			}
+		}
+	}
+}

package/lexicons/social/colibri/member.json

@@ -0,0 +1,41 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.member",
+	"defs": {
+		"main": {
+			"type": "record",
+			"description": "A community member. The record key is the member's DID, so membership is a direct lookup and a member cannot hold two of these.",
+			"key": "any",
+			"record": {
+				"type": "object",
+				"required": ["subject", "joinedAt"],
+				"properties": {
+					"subject": {
+						"type": "string",
+						"format": "did",
+						"description": "The member's DID. Matches the record key."
+					},
+					"roles": {
+						"type": "array",
+						"items": {
+							"type": "string",
+							"format": "record-key",
+							"description": "A role in this community."
+						},
+						"description": "Roles assigned to this member."
+					},
+					"joinedAt": {
+						"type": "string",
+						"format": "datetime",
+						"description": "When the member was admitted."
+					},
+					"nickname": {
+						"type": "string",
+						"maxLength": 32,
+						"description": "Per-community display name override."
+					}
+				}
+			}
+		}
+	}
+}