@colibri-social/lexicons 2.27.0 → 2.29.0

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

@@ -79,6 +79,11 @@
 					"format": "at-uri",
 					"description": "The repo-backed community this one replaces, if any."
 				},
+				"migration": {
+					"type": "ref",
+					"ref": "#migrationInfo",
+					"description": "When and by whom this community moved from its repo-backed predecessor. Set on migrated communities."
+				},
 				"memberCount": {
 					"type": "integer",
 					"description": "Number of admitted members."
@@ -656,6 +661,88 @@
 				"viewerIsAdmin": {
 					"type": "boolean",
 					"description": "Whether the requesting user may migrate this community. Only an administrator of the legacy community can."
+				},
+				"picture": {
+					"type": "string",
+					"format": "uri",
+					"description": "URL of the legacy community's icon, served by this AppView's blob proxy."
+				},
+				"owner": {
+					"type": "ref",
+					"ref": "#legacyOwner",
+					"description": "The member who owns the legacy community, for members to ask about the move."
+				},
+				"state": {
+					"type": "string",
+					"knownValues": ["migratable", "migrating", "blocked"],
+					"description": "Where the community stands. migratable waits for an administrator, migrating is moving now, blocked cannot move. Absent means migratable."
+				},
+				"blockedReason": {
+					"type": "string",
+					"knownValues": ["ownerRepo", "unreadable", "noAdmin"],
+					"description": "Why a blocked community cannot move. ownerRepo lives inside its owner's repo, unreadable has a repo that did not respond, noAdmin has nobody left who may migrate it."
+				},
+				"progress": {
+					"type": "ref",
+					"ref": "#migrationProgress",
+					"description": "How far a running migration has come. Set while state is migrating."
+				}
+			}
+		},
+		"legacyOwner": {
+			"type": "object",
+			"description": "The owner of a legacy community.",
+			"required": ["did"],
+			"properties": {
+				"did": {
+					"type": "string",
+					"format": "did",
+					"description": "The owner's DID."
+				},
+				"handle": {
+					"type": "string",
+					"format": "handle",
+					"description": "The owner's handle, when it resolves."
+				}
+			}
+		},
+		"migrationProgress": {
+			"type": "object",
+			"description": "How far a migration has come.",
+			"required": ["step", "completed", "total"],
+			"properties": {
+				"step": {
+					"type": "string",
+					"description": "The step running now. Same values as social.colibri.beta.sync.defs#communityProgressEvent."
+				},
+				"completed": {
+					"type": "integer",
+					"description": "Steps finished."
+				},
+				"total": {
+					"type": "integer",
+					"description": "Steps in total."
+				},
+				"failed": {
+					"type": "boolean",
+					"description": "Whether the last attempt failed. Starting the migration again resumes it from the last finished step."
+				}
+			}
+		},
+		"migrationInfo": {
+			"type": "object",
+			"description": "When and by whom a community moved onto spaces.",
+			"required": ["at", "by"],
+			"properties": {
+				"at": {
+					"type": "string",
+					"format": "datetime",
+					"description": "When the migration finished."
+				},
+				"by": {
+					"type": "string",
+					"format": "did",
+					"description": "The administrator who started it."
 				}
 			}
 		}

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

@@ -4,7 +4,7 @@
 	"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.",
+			"description": "Lists the repo-backed communities the requesting user belongs to that have not finished moving onto spaces. The AppView reads this live from the user's own public repo and each candidate's public repo. A community that cannot move, such as one inside its owner's repo or one whose repo did not respond, is listed in state blocked with a reason.",
 			"parameters": {
 				"type": "params",
 				"required": [],
@@ -12,7 +12,7 @@
 					"includeUnadministered": {
 						"type": "boolean",
 						"default": false,
-						"description": "Whether to include communities the user belongs to but cannot migrate. They come back with viewerIsAdmin false."
+						"description": "Whether to include communities the user belongs to but does not administer. They come back with viewerIsAdmin false."
 					}
 				}
 			},
@@ -30,15 +30,6 @@
 								"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."
 						}
 					}
 				}

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

@@ -4,7 +4,7 @@
 	"defs": {
 		"main": {
 			"type": "procedure",
-			"description": "Migrates a repo-backed community onto spaces. Structure is recreated in new spaces and stamped with migratedFrom. Message history stays in the legacy public repos and is served alongside, because messages live in their authors' repos and only their authors can move them.",
+			"description": "Starts moving a repo-backed community onto spaces and returns once the move is queued. Structure, roles, members and bans are recreated in spaces stamped with migratedFrom. Message history of current members is copied from their public repos and served alongside as read-only legacy messages. The move runs in the background and reports progress through social.colibri.beta.sync.defs#communityProgressEvent. Calling it again while it runs returns the current state, and calling it after a failed attempt resumes from the last finished step.",
 			"input": {
 				"encoding": "application/json",
 				"schema": {
@@ -27,8 +27,8 @@
 					"properties": {
 						"community": {
 							"type": "ref",
-							"ref": "social.colibri.beta.community.defs#communityView",
-							"description": "The newly created, space-backed community."
+							"ref": "social.colibri.beta.community.defs#legacyCommunityView",
+							"description": "The legacy community, in state migrating with its progress."
 						}
 					}
 				}
@@ -50,6 +50,10 @@
 					"name": "AlreadyExists",
 					"description": "This legacy community has already been migrated."
 				},
+				{
+					"name": "NotMigratable",
+					"description": "The community cannot move onto spaces, for example because it lives inside its owner's repo."
+				},
 				{
 					"name": "CredentialsUnavailable",
 					"description": "The AppView's stored credentials for this community are missing or unusable."

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

@@ -689,7 +689,7 @@
 		},
 		"communityProgressEvent": {
 			"type": "object",
-			"description": "Progress while a community is being created, which takes several PDS round-trips.",
+			"description": "Progress while a community is being created or migrated, which takes several PDS round-trips.",
 			"required": ["step", "completed", "total"],
 			"properties": {
 				"step": {
@@ -701,6 +701,15 @@
 						"writingProfile",
 						"creatingOwnerRole",
 						"creatingStarterChannels",
+						"readingLegacyRepo",
+						"writingSettings",
+						"migratingRoles",
+						"migratingMembers",
+						"migratingBans",
+						"migratingChannels",
+						"migratingCategories",
+						"mirroringMessages",
+						"retiringLegacyCommunity",
 						"done",
 						"failed"
 					]

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

@@ -73,6 +73,11 @@
 					"type": "integer",
 					"description": "How many of those messages were moved in from somewhere else."
 				},
+				"lastMessage": {
+					"type": "ref",
+					"ref": "social.colibri.beta.channel.defs#channelSummary",
+					"description": "The latest message in the thread the requesting user may see, reduced to what a thread list preview shows. Its channel is the thread's space. Absent when the thread holds no message the user may see."
+				},
 				"participants": {
 					"type": "array",
 					"items": {

package/package.json

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