@colibri-social/lexicons 2.17.0 → 2.18.0

package/lexicons/social/colibri/beta/notification/clear.json

@@ -0,0 +1,48 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.beta.notification.clear",
+	"defs": {
+		"main": {
+			"type": "procedure",
+			"description": "Clears the requesting user's inbox up to a point in time. Every notification raised at or before it is marked seen and left out of listNotifications, getUnreadCount and getUnseen from then on.",
+			"input": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["clearedAt"],
+					"properties": {
+						"clearedAt": {
+							"type": "string",
+							"format": "datetime",
+							"description": "Notifications raised at or before this time are cleared. A time in the future is treated as now, and a time before an earlier clear leaves that clear in place."
+						}
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["clearedAt", "unread"],
+					"properties": {
+						"clearedAt": {
+							"type": "string",
+							"format": "datetime",
+							"description": "The point the inbox is now cleared up to."
+						},
+						"unread": {
+							"type": "integer",
+							"description": "Number of unread notifications remaining."
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request has no valid service auth."
+				}
+			]
+		}
+	}
+}

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

@@ -31,6 +31,10 @@
 					"format": "space-ref",
 					"description": "The thread it happened in, when it happened in a thread rather than in the channel itself. `channel` stays the thread's parent channel, so a client can route to the thread inside it."
 				},
+				"threadName": {
+					"type": "string",
+					"description": "The name of the thread in thread, when it is set and the thread is still indexed."
+				},
 				"community": {
 					"type": "string",
 					"format": "did",

package/lexicons/social/colibri/beta/notification/markReadFromNotification.json

@@ -0,0 +1,41 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.beta.notification.markReadFromNotification",
+	"defs": {
+		"main": {
+			"type": "procedure",
+			"description": "Marks a channel or thread read through the message a push notification announced, from the notification's Mark as read action. Takes no auth: the signed token from the push payload's readToken names the user, the channel and the message, and expires after seven days. Moves the user's read cursor forward, marks that channel's notifications through the message seen, and tells the user's sessions and push devices.",
+			"input": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["token"],
+					"properties": {
+						"token": {
+							"type": "string",
+							"maxLength": 4096,
+							"description": "The readToken from the push payload."
+						}
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"properties": {}
+				}
+			},
+			"errors": [
+				{
+					"name": "InvalidToken",
+					"description": "The token is malformed, its signature does not verify, or the channel it names no longer exists."
+				},
+				{
+					"name": "ExpiredToken",
+					"description": "The token is older than seven days."
+				}
+			]
+		}
+	}
+}

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

@@ -73,6 +73,7 @@
 						"social.colibri.beta.channel.listMessages",
 						"social.colibri.beta.channel.listReactions",
 						"social.colibri.beta.channel.listUnreadStatus",
+						"social.colibri.beta.channel.listSummaries",
 						"social.colibri.beta.channel.putReadCursors",
 						"social.colibri.beta.embed.getMetadata",
 						"social.colibri.beta.embed.searchGifs",

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

@@ -16,7 +16,8 @@
 						"social.colibri.beta.notification.getUnreadCount",
 						"social.colibri.beta.notification.getUnseen",
 						"social.colibri.beta.notification.updateSeen",
-						"social.colibri.beta.notification.updateSeenForMessage"
+						"social.colibri.beta.notification.updateSeenForMessage",
+						"social.colibri.beta.notification.clear"
 					]
 				}
 			]

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

@@ -13,7 +13,8 @@
 					"inheritAud": true,
 					"lxm": [
 						"social.colibri.beta.notification.registerPush",
-						"social.colibri.beta.notification.unregisterPush"
+						"social.colibri.beta.notification.unregisterPush",
+						"social.colibri.beta.notification.markReadFromNotification"
 					]
 				}
 			]

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

@@ -444,6 +444,27 @@
 				}
 			}
 		},
+		"invitationEvent": {
+			"type": "object",
+			"description": "A community's invitation list changed. Only sent to members who can create invitations.",
+			"required": ["event", "community", "code"],
+			"properties": {
+				"event": {
+					"type": "string",
+					"description": "What happened.",
+					"knownValues": ["create", "delete"]
+				},
+				"community": {
+					"type": "string",
+					"format": "did",
+					"description": "The community."
+				},
+				"code": {
+					"type": "string",
+					"description": "The invitation code that was created or deleted."
+				}
+			}
+		},
 		"labelEvent": {
 			"type": "object",
 			"description": "A label was applied or retracted on a record in a subscribed space.",
@@ -527,6 +548,11 @@
 					"type": "string",
 					"format": "datetime",
 					"description": "The point everything was marked seen up to."
+				},
+				"clearedAt": {
+					"type": "string",
+					"format": "datetime",
+					"description": "Set when the user cleared their inbox. Notifications raised at or before this time are gone from it."
 				}
 			}
 		},

package/package.json

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