@colibri-social/lexicons 2.0.0 → 2.2.0

package/dist/nsids.js.map

@@ -1 +1 @@
-{"version":3,"file":"nsids.js","sourceRoot":"","sources":["../src/nsids.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,WAAW,GAAG;IAC1B,gBAAgB,EAAE,uCAAuC;IACzD,sBAAsB,EAAE,6CAA6C;IACrE,gBAAgB,EAAE,uCAAuC;IACzD,mBAAmB,EAAE,0CAA0C;IAC/D,WAAW,EAAE,kCAAkC;IAC/C,YAAY,EAAE,mCAAmC;IACjD,gBAAgB,EAAE,uCAAuC;CAChD,CAAC;AAIX,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,WAAW,CAAC,WAAW,EAAE,WAAW,CAAC,YAAY,CAAU,CAAC;AAIhG,MAAM,sBAAsB,GAAwB,IAAI,GAAG,CAAC,mBAAmB,CAAC,CAAC;AAEjF,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,KAAa,EAA6B,EAAE,CAC9E,sBAAsB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;AAEnC,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACpC,WAAW,CAAC,gBAAgB;IAC5B,WAAW,CAAC,sBAAsB;IAClC,WAAW,CAAC,gBAAgB;IAC5B,WAAW,CAAC,mBAAmB;CACtB,CAAC;AAEX,MAAM,CAAC,MAAM,WAAW,GAAG;IAC1B,QAAQ,EAAE,8BAA8B;IACxC,OAAO,EAAE,6BAA6B;IACtC,WAAW,EAAE,kCAAkC;IAC/C,SAAS,EAAE,+BAA+B;IAC1C,iBAAiB,EAAE,wCAAwC;IAC3D,KAAK,EAAE,2BAA2B;IAClC,MAAM,EAAE,4BAA4B;IACpC,OAAO,EAAE,6BAA6B;IACtC,UAAU,EAAE,gCAAgC;IAC5C,IAAI,EAAE,gCAAgC;IACtC,QAAQ,EAAE,8BAA8B;IACxC,IAAI,EAAE,0BAA0B;IAChC,QAAQ,EAAE,oCAAoC;IAC9C,OAAO,EAAE,mCAAmC;CACnC,CAAC;AAIX,MAAM,CAAC,MAAM,IAAI,GAAG,MAAM,CAAC;AAE3B,MAAM,CAAC,MAAM,YAAY,GAAG;IAC3B,MAAM,EAAE,QAAQ;IAChB,OAAO,EAAE,SAAS;IAClB,gBAAgB,EAAE,mBAAmB;CAC5B,CAAC;AAIX,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,SAAiB,EAAE,SAAiB,EAAE,IAAY,EAAE,EAAE,CAC9E,QAAQ,SAAS,UAAU,SAAS,IAAI,IAAI,EAAE,CAAC;AAShD,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,SAAiB,EAAmB,EAAE,CAAC,CAAC;IACvE,OAAO,EAAE,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC,gBAAgB,EAAE,IAAI,CAAC;IAChE,aAAa,EAAE,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC,sBAAsB,EAAE,IAAI,CAAC;IAC5E,OAAO,EAAE,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC,gBAAgB,EAAE,IAAI,CAAC;IAChE,UAAU,EAAE,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC,mBAAmB,EAAE,IAAI,CAAC;CACtE,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,KAAa,EAAE,EAAE,CACjD,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC;AAErD,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,SAAiB,EAAE,IAAsB,EAAE,IAAY,EAAE,EAAE,CACvF,QAAQ,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC"}
+{"version":3,"file":"nsids.js","sourceRoot":"","sources":["../src/nsids.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,WAAW,GAAG;IAC1B,gBAAgB,EAAE,uCAAuC;IACzD,sBAAsB,EAAE,6CAA6C;IACrE,gBAAgB,EAAE,uCAAuC;IACzD,mBAAmB,EAAE,0CAA0C;IAC/D,WAAW,EAAE,kCAAkC;IAC/C,YAAY,EAAE,mCAAmC;IACjD,gBAAgB,EAAE,uCAAuC;CAChD,CAAC;AAIX,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,WAAW,CAAC,WAAW,EAAE,WAAW,CAAC,YAAY,CAAU,CAAC;AAIhG,MAAM,sBAAsB,GAAwB,IAAI,GAAG,CAAC,mBAAmB,CAAC,CAAC;AAEjF,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,KAAa,EAA6B,EAAE,CAC9E,sBAAsB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;AAEnC,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACpC,WAAW,CAAC,gBAAgB;IAC5B,WAAW,CAAC,sBAAsB;IAClC,WAAW,CAAC,gBAAgB;IAC5B,WAAW,CAAC,mBAAmB;CACtB,CAAC;AAEX,MAAM,CAAC,MAAM,WAAW,GAAG;IAC1B,QAAQ,EAAE,8BAA8B;IACxC,OAAO,EAAE,6BAA6B;IACtC,WAAW,EAAE,kCAAkC;IAC/C,SAAS,EAAE,+BAA+B;IAC1C,iBAAiB,EAAE,wCAAwC;IAC3D,KAAK,EAAE,2BAA2B;IAClC,MAAM,EAAE,4BAA4B;IACpC,OAAO,EAAE,6BAA6B;IACtC,UAAU,EAAE,gCAAgC;IAC5C,IAAI,EAAE,gCAAgC;IACtC,QAAQ,EAAE,8BAA8B;IACxC,IAAI,EAAE,0BAA0B;IAChC,QAAQ,EAAE,oCAAoC;IAC9C,OAAO,EAAE,mCAAmC;CACnC,CAAC;AAIX,MAAM,CAAC,MAAM,kBAAkB,GAAG;IACjC,SAAS,EAAE,2BAA2B;IACtC,QAAQ,EAAE,yBAAyB;IACnC,OAAO,EAAE,wBAAwB;IACjC,SAAS,EAAE,0BAA0B;IACrC,MAAM,EAAE,uBAAuB;IAC/B,UAAU,EAAE,2BAA2B;IACvC,OAAO,EAAE,wBAAwB;IACjC,IAAI,EAAE,qBAAqB;CAClB,CAAC;AAIX,MAAM,CAAC,MAAM,oBAAoB,GAAG;IACnC,IAAI,EAAE,6BAA6B;IACnC,KAAK,EAAE,8BAA8B;IACrC,KAAK,EAAE,8BAA8B;IACrC,IAAI,EAAE,6BAA6B;CAC1B,CAAC;AAEX,MAAM,CAAC,MAAM,IAAI,GAAG,MAAM,CAAC;AAE3B,MAAM,CAAC,MAAM,YAAY,GAAG;IAC3B,MAAM,EAAE,QAAQ;IAChB,OAAO,EAAE,SAAS;IAClB,gBAAgB,EAAE,mBAAmB;CAC5B,CAAC;AAIX,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,SAAiB,EAAE,SAAiB,EAAE,IAAY,EAAE,EAAE,CAC9E,QAAQ,SAAS,UAAU,SAAS,IAAI,IAAI,EAAE,CAAC;AAShD,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,SAAiB,EAAmB,EAAE,CAAC,CAAC;IACvE,OAAO,EAAE,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC,gBAAgB,EAAE,IAAI,CAAC;IAChE,aAAa,EAAE,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC,sBAAsB,EAAE,IAAI,CAAC;IAC5E,OAAO,EAAE,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC,gBAAgB,EAAE,IAAI,CAAC;IAChE,UAAU,EAAE,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC,mBAAmB,EAAE,IAAI,CAAC;CACtE,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,KAAa,EAAE,EAAE,CACjD,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC;AAErD,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,SAAiB,EAAE,IAAsB,EAAE,IAAY,EAAE,EAAE,CACvF,QAAQ,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC"}

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

@@ -109,11 +109,19 @@
 				},
 				"muted": {
 					"type": "boolean",
-					"description": "Whether the user has muted their microphone."
+					"description": "Whether the user's microphone is muted, for any reason."
 				},
 				"deafened": {
 					"type": "boolean",
-					"description": "Whether the user has deafened themselves."
+					"description": "Whether the user has incoming audio silenced, for any reason."
+				},
+				"serverMuted": {
+					"type": "boolean",
+					"description": "Whether a moderator muted them. When this is true they cannot unmute themselves, and a client must not offer them the control."
+				},
+				"serverDeafened": {
+					"type": "boolean",
+					"description": "Whether a moderator deafened them. When this is true they cannot undeafen themselves."
 				}
 			}
 		},
@@ -147,10 +155,10 @@
 				"gifFavorites": {
 					"type": "array",
 					"items": {
-						"type": "string",
-						"description": "A GIF identifier."
+						"type": "ref",
+						"ref": "social.colibri.beta.embed.defs#gifView"
 					},
-					"description": "GIFs saved from the picker."
+					"description": "GIFs saved from the picker, stored whole."
 				}
 			}
 		},
@@ -160,9 +168,10 @@
 			"required": ["subject", "createdAt"],
 			"properties": {
 				"subject": {
-					"type": "string",
-					"format": "did",
-					"description": "The muted user or community."
+					"type": "union",
+					"refs": ["#mutedActor", "#mutedChannel"],
+					"closed": true,
+					"description": "What is muted. A user or a community is named by DID, a channel by its space."
 				},
 				"createdAt": {
 					"type": "string",
@@ -170,6 +179,30 @@
 					"description": "When the mute was created."
 				}
 			}
+		},
+		"mutedActor": {
+			"type": "object",
+			"description": "A muted user or community.",
+			"required": ["did"],
+			"properties": {
+				"did": {
+					"type": "string",
+					"format": "did",
+					"description": "The muted user or community."
+				}
+			}
+		},
+		"mutedChannel": {
+			"type": "object",
+			"description": "A muted channel. Muting a channel silences it without leaving the community it belongs to.",
+			"required": ["channel"],
+			"properties": {
+				"channel": {
+					"type": "string",
+					"format": "space-ref",
+					"description": "The muted channel's space."
+				}
+			}
 		}
 	}
 }

package/lexicons/social/colibri/beta/actor/mute.json

@@ -11,9 +11,13 @@
 				"required": ["subject", "createdAt"],
 				"properties": {
 					"subject": {
-						"type": "string",
-						"format": "did",
-						"description": "The muted user or community."
+						"type": "union",
+						"refs": [
+							"social.colibri.beta.actor.defs#mutedActor",
+							"social.colibri.beta.actor.defs#mutedChannel"
+						],
+						"closed": true,
+						"description": "What is muted. A user or a community is named by DID, a channel by its space."
 					},
 					"createdAt": {
 						"type": "string",

package/lexicons/social/colibri/beta/actor/putSettings.json

@@ -26,11 +26,10 @@
 						},
 						"gifFavorites": {
 							"type": "array",
-							"description": "GIFs saved from the picker. Absent leaves the current value unchanged.",
+							"description": "GIFs saved from the picker, stored whole. Absent leaves the current value unchanged.",
 							"items": {
-								"type": "string",
-								"description": "A GIF identifier.",
-								"maxLength": 256
+								"type": "ref",
+								"ref": "social.colibri.beta.embed.defs#gifView"
 							}
 						}
 					}

package/lexicons/social/colibri/beta/actor/settings.json

@@ -28,11 +28,10 @@
 					"gifFavorites": {
 						"type": "array",
 						"items": {
-							"type": "string",
-							"maxLength": 256,
-							"description": "A GIF identifier."
+							"type": "ref",
+							"ref": "social.colibri.beta.embed.defs#gifView"
 						},
-						"description": "GIFs the user saved from the picker."
+						"description": "GIFs the user saved from the picker, stored whole. A saved GIF has to render without another lookup, and an identifier cannot be turned back into one: a GIF favourited from a chat message carries its own URL as the id rather than a provider key, so no provider can resolve it."
 					}
 				}
 			}

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

@@ -529,6 +529,43 @@
 					"description": "When the ban took effect."
 				}
 			}
+		},
+		"legacyCommunityView": {
+			"type": "object",
+			"description": "A repo-backed community that has not been migrated onto spaces yet, as read live from its own public repo. This is not an indexed view: the AppView holds nothing about a community until it is migrated.",
+			"required": ["did", "name"],
+			"properties": {
+				"did": {
+					"type": "string",
+					"format": "did",
+					"description": "The legacy community's DID, which becomes the authority for its spaces once migrated."
+				},
+				"handle": {
+					"type": "string",
+					"format": "handle",
+					"description": "The community's handle, when its DID document still resolves one."
+				},
+				"name": {
+					"type": "string",
+					"description": "The community's name."
+				},
+				"description": {
+					"type": "string",
+					"description": "The community's description."
+				},
+				"memberCount": {
+					"type": "integer",
+					"description": "How many member records the legacy repo holds."
+				},
+				"channelCount": {
+					"type": "integer",
+					"description": "How many channel records the legacy repo holds. Migration recreates one space per channel."
+				},
+				"viewerIsAdmin": {
+					"type": "boolean",
+					"description": "Whether the requesting user may migrate this community. Only an administrator of the legacy community can."
+				}
+			}
 		}
 	}
 }

package/lexicons/social/colibri/beta/community/listMigratable.json

@@ -0,0 +1,58 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.beta.community.listMigratable",
+	"defs": {
+		"main": {
+			"type": "query",
+			"description": "Lists the repo-backed communities the requesting user belongs to that have not been migrated onto spaces yet, so a client can offer them as a choice rather than asking for a handle. The AppView reads this live from the user's own public repo and each candidate's public repo, because nothing about an unmigrated community is indexed. Only a community that holds its own DID is listed: an older community that lived in its owner's repo cannot be migrated.",
+			"parameters": {
+				"type": "params",
+				"required": [],
+				"properties": {
+					"includeUnadministered": {
+						"type": "boolean",
+						"default": false,
+						"description": "Whether to include communities the user belongs to but cannot migrate. They come back with viewerIsAdmin false."
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["communities"],
+					"properties": {
+						"communities": {
+							"type": "array",
+							"items": {
+								"type": "ref",
+								"ref": "social.colibri.beta.community.defs#legacyCommunityView",
+								"description": "An unmigrated legacy community."
+							},
+							"description": "Unmigrated legacy communities, in the user's preferred sidebar order where the legacy repo recorded one. This is not paginated: a user's community list is small and every entry costs a live read."
+						},
+						"unreadable": {
+							"type": "array",
+							"items": {
+								"type": "string",
+								"format": "did",
+								"description": "A community DID whose repo could not be read."
+							},
+							"description": "Communities named by the user's repo whose own repo could not be read, so the client can say so instead of silently dropping them."
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request is missing, malformed, or unverifiable service auth."
+				},
+				{
+					"name": "UpstreamFailure",
+					"description": "The requesting user's own PDS could not be read, so no candidate list could be built at all."
+				}
+			]
+		}
+	}
+}

package/lexicons/social/colibri/beta/community/migrate.json

@@ -9,12 +9,12 @@
 				"encoding": "application/json",
 				"schema": {
 					"type": "object",
-					"required": ["legacy"],
+					"required": ["community"],
 					"properties": {
-						"legacy": {
+						"community": {
 							"type": "string",
-							"format": "at-uri",
-							"description": "The legacy social.colibri.beta.community record to migrate."
+							"format": "at-identifier",
+							"description": "The legacy community to migrate, by handle or DID. Only a community that holds its own DID can be migrated, so the DID is the whole address: the record to read is always social.colibri.community at self in that repo."
 						}
 					}
 				}

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

@@ -66,6 +66,7 @@
 						"social.colibri.beta.community.putImage",
 						"social.colibri.beta.community.deleteImage",
 						"social.colibri.beta.community.delete",
+						"social.colibri.beta.community.listMigratable",
 						"social.colibri.beta.community.migrate",
 						"social.colibri.beta.community.registerCredentials",
 						"social.colibri.beta.community.setMemberRoles",

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

@@ -9,13 +9,21 @@
 				"encoding": "application/json",
 				"schema": {
 					"type": "object",
-					"required": ["did", "version", "handleDomain", "pds"],
+					"required": ["did", "software", "flavor", "version", "handleDomain", "pds"],
 					"properties": {
 						"did": {
 							"type": "string",
 							"format": "did",
 							"description": "The AppView's own identity."
 						},
+						"software": {
+							"type": "string",
+							"description": "Stable software identifier, always 'colibri-appview'. Clients key on this to confirm a host is a Colibri AppView before pointing themselves at it."
+						},
+						"flavor": {
+							"type": "string",
+							"description": "Which build of the software this is. 'vanilla' for the stock AppView, and any string a fork or a customised deployment chooses for itself."
+						},
 						"version": {
 							"type": "string",
 							"description": "The running software version."

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

@@ -26,8 +26,12 @@
 					"description": "The opaque mediasoup ICE parameters blob."
 				},
 				"iceCandidates": {
-					"type": "unknown",
-					"description": "The opaque mediasoup ICE candidates blob."
+					"type": "array",
+					"description": "The mediasoup ICE candidates, one opaque blob per candidate. This is an array, not a single object, because that is what a WebRTC transport hands back.",
+					"items": {
+						"type": "unknown",
+						"description": "One opaque mediasoup ICE candidate."
+					}
 				},
 				"dtlsParameters": {
 					"type": "unknown",
@@ -335,7 +339,7 @@
 		},
 		"moderationChanged": {
 			"type": "object",
-			"description": "A peer's server-enforced mute or deafen state changed.",
+			"description": "A peer's mute or deafen state changed, whether they did it themselves or a moderator did it to them.",
 			"required": ["did", "muted", "deafened"],
 			"properties": {
 				"did": {
@@ -345,11 +349,19 @@
 				},
 				"muted": {
 					"type": "boolean",
-					"description": "Whether the microphone is server-muted."
+					"description": "Whether the microphone is muted, for any reason."
 				},
 				"deafened": {
 					"type": "boolean",
-					"description": "Whether incoming audio is server-silenced."
+					"description": "Whether incoming audio is silenced, for any reason."
+				},
+				"serverMuted": {
+					"type": "boolean",
+					"description": "Whether a moderator muted them. When this is true the peer cannot unmute themselves."
+				},
+				"serverDeafened": {
+					"type": "boolean",
+					"description": "Whether a moderator deafened them. When this is true the peer cannot undeafen themselves."
 				}
 			}
 		}

package/package.json

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