@colibri-social/lexicons 0.1.0

package/lexicons/social/colibri/message.json

@@ -0,0 +1,77 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.message",
+	"defs": {
+		"main": {
+			"type": "record",
+			"description": "A message in a channel. Lives in the author's own permissioned repo for the channel's space.",
+			"key": "tid",
+			"record": {
+				"type": "object",
+				"required": ["text", "createdAt"],
+				"properties": {
+					"text": {
+						"type": "string",
+						"maxLength": 2048,
+						"description": "The message body."
+					},
+					"facets": {
+						"type": "array",
+						"items": {
+							"type": "ref",
+							"ref": "social.colibri.richtext.facet"
+						},
+						"description": "Annotations over ranges of the text."
+					},
+					"createdAt": {
+						"type": "string",
+						"format": "datetime",
+						"description": "When the message was sent."
+					},
+					"updatedAt": {
+						"type": "string",
+						"format": "datetime",
+						"description": "When the message was last edited. Absent means never edited."
+					},
+					"parent": {
+						"type": "ref",
+						"ref": "social.colibri.defs#recordRef",
+						"description": "The message this one replies to."
+					},
+					"attachments": {
+						"type": "array",
+						"items": {
+							"type": "ref",
+							"ref": "#attachment"
+						},
+						"description": "Files attached to this message."
+					},
+					"suppressedEmbeds": {
+						"type": "array",
+						"items": {
+							"type": "string",
+							"format": "uri"
+						},
+						"description": "URLs from this message's link facets whose preview the author chose not to show. Moderator suppression is a label instead."
+					}
+				}
+			}
+		},
+		"attachment": {
+			"type": "object",
+			"description": "A file attached to a message.",
+			"required": ["blob"],
+			"properties": {
+				"blob": {
+					"type": "blob",
+					"description": "The attached file."
+				},
+				"name": {
+					"type": "string",
+					"maxLength": 256,
+					"description": "The original filename."
+				}
+			}
+		}
+	}
+}

package/lexicons/social/colibri/moderation.json

@@ -0,0 +1,42 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.moderation",
+	"defs": {
+		"main": {
+			"type": "record",
+			"description": "An audit log entry for a moderation action taken by the community. Enforcement is the space authority declining to issue credentials, and this records that it happened.",
+			"key": "tid",
+			"record": {
+				"type": "object",
+				"required": ["action", "subject", "createdBy", "createdAt"],
+				"properties": {
+					"action": {
+						"type": "string",
+						"knownValues": ["ban", "unban", "kick"],
+						"description": "The action taken."
+					},
+					"subject": {
+						"type": "string",
+						"format": "did",
+						"description": "The member the action was taken against."
+					},
+					"reason": {
+						"type": "string",
+						"maxLength": 512,
+						"description": "Human-readable reason."
+					},
+					"createdBy": {
+						"type": "string",
+						"format": "did",
+						"description": "DID of the moderator who took the action."
+					},
+					"createdAt": {
+						"type": "string",
+						"format": "datetime",
+						"description": "When the action was taken."
+					}
+				}
+			}
+		}
+	}
+}

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

@@ -0,0 +1,56 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.notification.defs",
+	"defs": {
+		"notificationView": {
+			"type": "object",
+			"description": "A notification for the requesting user.",
+			"required": ["id", "kind", "author", "channel", "community", "indexedAt"],
+			"properties": {
+				"id": {
+					"type": "string",
+					"description": "Opaque identifier, used to mark this notification seen."
+				},
+				"kind": {
+					"type": "string",
+					"description": "Why it was raised.",
+					"knownValues": ["mention", "reply", "message"]
+				},
+				"author": {
+					"type": "ref",
+					"ref": "social.colibri.actor.defs#profileView",
+					"description": "Who caused it."
+				},
+				"channel": {
+					"type": "string",
+					"format": "space-ref",
+					"description": "The channel it happened in."
+				},
+				"community": {
+					"type": "string",
+					"format": "did",
+					"description": "The community it happened in."
+				},
+				"message": {
+					"type": "ref",
+					"ref": "social.colibri.channel.defs#messageView",
+					"description": "The message, when still readable."
+				},
+				"mentionRole": {
+					"type": "string",
+					"description": "Name of the role whose mention raised this, for role mentions."
+				},
+				"indexedAt": {
+					"type": "string",
+					"format": "datetime",
+					"description": "When the AppView raised it."
+				},
+				"seenAt": {
+					"type": "string",
+					"format": "datetime",
+					"description": "When the user marked it seen."
+				}
+			}
+		}
+	}
+}

package/lexicons/social/colibri/notification/getUnreadCount.json

@@ -0,0 +1,29 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.notification.getUnreadCount",
+	"defs": {
+		"main": {
+			"type": "query",
+			"description": "Gets how many of the requesting user's notifications are unread.",
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["count"],
+					"properties": {
+						"count": {
+							"type": "integer",
+							"description": "Number of unread notifications."
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request has no valid service auth."
+				}
+			]
+		}
+	}
+}

package/lexicons/social/colibri/notification/getUnseen.json

@@ -0,0 +1,55 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.notification.getUnseen",
+	"defs": {
+		"main": {
+			"type": "query",
+			"description": "Gets the requesting user's unseen notifications for one channel, used to render that channel's unread badge detail.",
+			"parameters": {
+				"type": "params",
+				"required": ["channel"],
+				"properties": {
+					"channel": {
+						"type": "string",
+						"format": "space-ref",
+						"description": "The channel to get unseen notifications for."
+					},
+					"limit": {
+						"type": "integer",
+						"minimum": 1,
+						"maximum": 100,
+						"default": 50,
+						"description": "Maximum number of notifications to return."
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["notifications"],
+					"properties": {
+						"notifications": {
+							"type": "array",
+							"description": "Unseen notifications raised in the given channel.",
+							"items": {
+								"type": "ref",
+								"ref": "social.colibri.notification.defs#notificationView"
+							}
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request has no valid service auth."
+				},
+				{
+					"name": "ChannelNotFound",
+					"description": "No channel matches the given space reference."
+				}
+			]
+		}
+	}
+}

package/lexicons/social/colibri/notification/listNotifications.json

@@ -0,0 +1,53 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.notification.listNotifications",
+	"defs": {
+		"main": {
+			"type": "query",
+			"description": "Gets the requesting user's notifications, newest first.",
+			"parameters": {
+				"type": "params",
+				"properties": {
+					"limit": {
+						"type": "integer",
+						"minimum": 1,
+						"maximum": 100,
+						"default": 50,
+						"description": "Maximum number of notifications to return."
+					},
+					"cursor": {
+						"type": "string",
+						"description": "Pagination cursor from a previous call."
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["notifications"],
+					"properties": {
+						"cursor": {
+							"type": "string",
+							"description": "Pagination cursor for the next page, when more notifications remain."
+						},
+						"notifications": {
+							"type": "array",
+							"description": "The requesting user's notifications, newest first.",
+							"items": {
+								"type": "ref",
+								"ref": "social.colibri.notification.defs#notificationView"
+							}
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request has no valid service auth."
+				}
+			]
+		}
+	}
+}

package/lexicons/social/colibri/notification/registerPush.json

@@ -0,0 +1,67 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.notification.registerPush",
+	"defs": {
+		"main": {
+			"type": "procedure",
+			"description": "Registers a push endpoint for the requesting user's device. Web Push requires endpoint, p256dh, and auth. FCM requires token.",
+			"input": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["provider", "platform"],
+					"properties": {
+						"provider": {
+							"type": "string",
+							"description": "The push provider to register with.",
+							"knownValues": ["webpush", "fcm"]
+						},
+						"platform": {
+							"type": "string",
+							"description": "The platform the device runs.",
+							"knownValues": ["web", "ios", "android"]
+						},
+						"endpoint": {
+							"type": "string",
+							"format": "uri",
+							"description": "The Web Push subscription endpoint. Required when provider is webpush."
+						},
+						"p256dh": {
+							"type": "string",
+							"description": "The Web Push subscription's p256dh key. Required when provider is webpush."
+						},
+						"auth": {
+							"type": "string",
+							"description": "The Web Push subscription's auth secret. Required when provider is webpush."
+						},
+						"token": {
+							"type": "string",
+							"description": "The FCM registration token. Required when provider is fcm."
+						}
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"properties": {}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request has no valid service auth."
+				},
+				{
+					"name": "InvalidRequest",
+					"description": "The fields required for the given provider are missing or malformed."
+				},
+				{
+					"name": "PushNotConfigured",
+					"description": "This AppView has no keypair for the requested provider."
+				}
+			]
+		}
+	}
+}

package/lexicons/social/colibri/notification/unregisterPush.json

@@ -0,0 +1,50 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.notification.unregisterPush",
+	"defs": {
+		"main": {
+			"type": "procedure",
+			"description": "Removes a previously registered push endpoint.",
+			"input": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["provider"],
+					"properties": {
+						"provider": {
+							"type": "string",
+							"description": "The push provider to unregister from.",
+							"knownValues": ["webpush", "fcm"]
+						},
+						"endpoint": {
+							"type": "string",
+							"format": "uri",
+							"description": "The Web Push subscription endpoint to remove."
+						},
+						"token": {
+							"type": "string",
+							"description": "The FCM registration token to remove."
+						}
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"properties": {}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request has no valid service auth."
+				},
+				{
+					"name": "InvalidRequest",
+					"description": "The arguments are inconsistent or malformed beyond schema validation."
+				}
+			]
+		}
+	}
+}

package/lexicons/social/colibri/notification/updateSeen.json

@@ -0,0 +1,43 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.notification.updateSeen",
+	"defs": {
+		"main": {
+			"type": "procedure",
+			"description": "Marks every notification raised at or before a point in time seen.",
+			"input": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["seenAt"],
+					"properties": {
+						"seenAt": {
+							"type": "string",
+							"format": "datetime",
+							"description": "Notifications raised at or before this time are marked seen."
+						}
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["unread"],
+					"properties": {
+						"unread": {
+							"type": "integer",
+							"description": "Number of unread notifications remaining."
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request has no valid service auth."
+				}
+			]
+		}
+	}
+}

package/lexicons/social/colibri/notification/updateSeenForMessage.json

@@ -0,0 +1,56 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.notification.updateSeenForMessage",
+	"defs": {
+		"main": {
+			"type": "procedure",
+			"description": "Marks the notifications raised by one message seen.",
+			"input": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["channel", "message"],
+					"properties": {
+						"channel": {
+							"type": "string",
+							"format": "space-ref",
+							"description": "The channel the message was posted in."
+						},
+						"message": {
+							"type": "ref",
+							"ref": "social.colibri.defs#recordRef",
+							"description": "The message whose notifications are marked seen."
+						}
+					}
+				}
+			},
+			"output": {
+				"encoding": "application/json",
+				"schema": {
+					"type": "object",
+					"required": ["unread"],
+					"properties": {
+						"unread": {
+							"type": "integer",
+							"description": "Number of unread notifications remaining."
+						}
+					}
+				}
+			},
+			"errors": [
+				{
+					"name": "AuthRequired",
+					"description": "The request has no valid service auth."
+				},
+				{
+					"name": "ChannelNotFound",
+					"description": "No channel matches the given space reference."
+				},
+				{
+					"name": "MessageNotFound",
+					"description": "No message matches the given record reference in that channel."
+				}
+			]
+		}
+	}
+}

package/lexicons/social/colibri/permissionAccount.json

@@ -0,0 +1,51 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.permissionAccount",
+	"defs": {
+		"main": {
+			"type": "permission-set",
+			"title": "Your Colibri account",
+			"detail": "Read and change your Colibri profile, settings, mutes and read state.",
+			"permissions": [
+				{
+					"type": "permission",
+					"resource": "space",
+					"spaceType": "social.colibri.actor.preferences",
+					"authority": "self",
+					"skey": "self",
+					"collection": [
+						"social.colibri.actor.mute",
+						"social.colibri.actor.settings",
+						"social.colibri.channel.read"
+					],
+					"action": ["read", "create", "update", "delete"],
+					"manage": ["create", "update"]
+				},
+				{
+					"type": "permission",
+					"resource": "repo",
+					"collection": ["social.colibri.actor.profile"],
+					"action": ["create", "update", "delete"]
+				},
+				{
+					"type": "permission",
+					"resource": "rpc",
+					"inheritAud": true,
+					"lxm": [
+						"social.colibri.actor.getProfile",
+						"social.colibri.actor.getPreferences",
+						"social.colibri.actor.putSettings",
+						"social.colibri.actor.putMutes",
+						"social.colibri.actor.grantSpaceAccess",
+						"social.colibri.actor.listCommunities",
+						"social.colibri.actor.setStatus",
+						"social.colibri.actor.getDeletionStatus",
+						"social.colibri.actor.deleteAccount",
+						"social.colibri.server.describeServer",
+						"social.colibri.blob.get"
+					]
+				}
+			]
+		}
+	}
+}

package/lexicons/social/colibri/permissionCommunity.json

@@ -0,0 +1,100 @@
+{
+	"lexicon": 1,
+	"id": "social.colibri.permissionCommunity",
+	"defs": {
+		"main": {
+			"type": "permission-set",
+			"title": "Manage Colibri communities",
+			"detail": "Create and administer Colibri communities, including their channels, roles, members and moderation.",
+			"permissions": [
+				{
+					"type": "permission",
+					"resource": "space",
+					"spaceType": "social.colibri.community.profile",
+					"authority": "*",
+					"action": ["read"],
+					"manage": ["create", "update", "delete"]
+				},
+				{
+					"type": "permission",
+					"resource": "space",
+					"spaceType": "social.colibri.community.configuration",
+					"authority": "*",
+					"action": ["read"],
+					"manage": ["create", "update", "delete"]
+				},
+				{
+					"type": "permission",
+					"resource": "space",
+					"spaceType": "social.colibri.community.members",
+					"authority": "*",
+					"action": ["read"],
+					"manage": ["create", "update", "delete"]
+				},
+				{
+					"type": "permission",
+					"resource": "space",
+					"spaceType": "social.colibri.community.moderation",
+					"authority": "*",
+					"action": ["read"],
+					"manage": ["create", "update", "delete"]
+				},
+				{
+					"type": "permission",
+					"resource": "space",
+					"spaceType": "social.colibri.channel.text",
+					"authority": "*",
+					"action": ["read"],
+					"manage": ["create", "update", "delete"]
+				},
+				{
+					"type": "permission",
+					"resource": "space",
+					"spaceType": "social.colibri.channel.voice",
+					"authority": "*",
+					"action": ["read"],
+					"manage": ["create", "update", "delete"]
+				},
+				{
+					"type": "permission",
+					"resource": "rpc",
+					"inheritAud": true,
+					"lxm": [
+						"social.colibri.community.create",
+						"social.colibri.community.update",
+						"social.colibri.community.delete",
+						"social.colibri.community.migrate",
+						"social.colibri.community.registerCredentials",
+						"social.colibri.community.setMemberRoles",
+						"social.colibri.community.reorderCategories",
+						"social.colibri.community.createInvitation",
+						"social.colibri.community.listInvitations",
+						"social.colibri.community.deleteInvitation",
+						"social.colibri.community.kick",
+						"social.colibri.community.ban",
+						"social.colibri.community.unban",
+						"social.colibri.community.listBans",
+						"social.colibri.community.listApplications",
+						"social.colibri.community.approveApplication",
+						"social.colibri.community.dismissApplication",
+						"social.colibri.community.undismissApplication",
+						"social.colibri.community.listModerationLog",
+						"social.colibri.community.applyLabel",
+						"social.colibri.community.negateLabel",
+						"social.colibri.category.create",
+						"social.colibri.category.update",
+						"social.colibri.category.delete",
+						"social.colibri.channel.create",
+						"social.colibri.channel.update",
+						"social.colibri.channel.delete",
+						"social.colibri.channel.reorder",
+						"social.colibri.role.create",
+						"social.colibri.role.update",
+						"social.colibri.role.delete",
+						"social.colibri.voice.moderate"
+					]
+				}
+			]
+		}
+	}
+}