async-matrix 0.1.3 → 1.0.0

data/data/matrix-spec/event-schemas/schema/m.policy.rule.server.yaml

@@ -0,0 +1,17 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/state_event.yaml
+description: A moderation policy rule which affects servers.
+properties:
+  content:
+    $ref: "../moderation_policy_rule.yaml"
+  state_key:
+    description: An arbitrary string decided upon by the sender.
+    type: string
+  type:
+    enum:
+      - m.policy.rule.server
+    type: string
+type: object

data/data/matrix-spec/event-schemas/schema/m.policy.rule.user.yaml

@@ -0,0 +1,17 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/state_event.yaml
+description: A moderation policy rule which affects users.
+properties:
+  content:
+    $ref: "../moderation_policy_rule.yaml"
+  state_key:
+    description: An arbitrary string decided upon by the sender.
+    type: string
+  type:
+    enum:
+      - m.policy.rule.user
+    type: string
+type: object

data/data/matrix-spec/event-schemas/schema/m.presence.yaml

@@ -0,0 +1,50 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "type": "object",
+    "title": "Presence Event",
+    "description": "Informs the client of a user's presence state change.",
+    "allOf": [{
+        "$ref": "core-event-schema/event.yaml"
+    }],
+    "properties": {
+        "content": {
+            "type": "object",
+            "properties": {
+                "avatar_url": {
+                    "type": "string",
+                    "description": "The current avatar URL for this user, if any."
+                },
+                "displayname": {
+                    "type": "string",
+                    "description": "The current display name for this user, if any."
+                },
+                "last_active_ago": {
+                    "type": "number",
+                    "description": "The last time since this used performed some action, in milliseconds."
+                },
+                "presence": {
+                    "type": "string",
+                    "description": "The presence state for this user.",
+                    "enum": ["online", "offline", "unavailable"]
+                },
+                "currently_active": {
+                    "type": boolean,
+                    "description": "Whether the user is currently active"
+                },
+                "status_msg": {
+                    "type": "string",
+                    "description": "An optional description to accompany the presence."
+                }
+            },
+            "required": ["presence"]
+        },
+        "type": {
+            "type": "string",
+            "enum": ["m.presence"]
+        },
+        "sender": {
+            "type": "string"
+        }
+    },
+    "required": ["sender", "type", "content"]
+}

data/data/matrix-spec/event-schemas/schema/m.push_rules.yaml

@@ -0,0 +1,23 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/event.yaml
+description: Describes all push rules for this user.
+properties:
+  content:
+    properties:
+      global:
+        type: object
+        title: Ruleset
+        description: The global ruleset
+        allOf:
+          - $ref: ../../api/client-server/definitions/push_ruleset.yaml
+    type: object
+  type:
+    enum:
+      - m.push_rules
+    type: string
+title: Push rules
+type: object
+

data/data/matrix-spec/event-schemas/schema/m.reaction.yaml

@@ -0,0 +1,45 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/room_event.yaml
+description: |-
+  Indicates a reaction to a previous event.
+
+  Has no defined `content` properties of its own. Its only purpose is to hold an
+  [`m.relates_to`](/client-server-api/#definition-mrelates_to) property.
+
+  Since they contain no content other than `m.relates_to`, `m.reaction` events
+  are normally not encrypted, as there would be no benefit in doing so.
+type: object
+properties:
+  content:
+    type: object
+    properties:
+      m.relates_to:
+        description: |-
+          Indicates the event being reacted to, and the type of reaction.
+        type: object
+        title: ReactionRelatesTo
+        properties:
+          rel_type:
+            type: string
+            enum: ["m.annotation"]
+          event_id:
+            type: string
+            description: |-
+              The event ID of the event that this is a reaction to.
+            example: "$some_event_id"
+          key:
+            type: string
+            description: |-
+              The reaction being made, usually an emoji.
+
+              If this is an emoji, it should include the unicode emoji
+              presentation selector (`\uFE0F`) for codepoints which allow it
+              (see the [emoji variation sequences
+              list](https://www.unicode.org/Public/UCD/latest/ucd/emoji/emoji-variation-sequences.txt)).
+            example: "👍"
+  type:
+    enum:
+      - m.reaction
+    type: string

data/data/matrix-spec/event-schemas/schema/m.receipt.yaml

@@ -0,0 +1,65 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+
+type: object
+title: Receipt Event
+description: Informs the client of new receipts.
+x-changedInMatrixVersion:
+    "1.4": |
+        Added `m.read.private` receipts to the event's `content`.
+allOf:
+    - $ref: "core-event-schema/event.yaml"
+properties:
+    content:
+        type: object
+        description: |-
+            The mapping of event ID to a collection of receipts for this
+            event ID. The event ID is the ID of the event being acknowledged
+            and *not* an ID for the receipt itself.
+        patternProperties:
+            "^\\$":
+                type: object
+                x-pattern-format: "mx-event-id"
+                title: Event Receipts
+                description: |-
+                    The collection of receipts for this event ID.
+                properties:
+                    "m.read":
+                        type: object
+                        description: |-
+                            A collection of users who have sent `m.read` receipts for
+                            this event. The string key is the user ID the receipt 
+                            belongs to.
+                        patternProperties:
+                            "^@": &receiptUserMap
+                                type: object
+                                title: Receipt
+                                description: |-
+                                    The mapping of user ID to receipt. The user ID is the
+                                    entity who sent this receipt.
+                                x-pattern-format: "mx-user-id"
+                                properties:
+                                    ts:
+                                        type: integer
+                                        format: int64
+                                        description: The timestamp the receipt was sent at.
+                                    thread_id:
+                                        type: string
+                                        x-addedInMatrixVersion: "1.4"
+                                        description: |-
+                                            The root thread event's ID (or `main`) for which
+                                            thread this receipt is intended to be under. If
+                                            not specified, the read receipt is *unthreaded*
+                                            (default).
+                    "m.read.private":
+                        type: object
+                        description: |-
+                            Similar to `m.read`, the users who have sent `m.read.private`
+                            receipts for this event. Due to the nature of private read
+                            receipts, this should only ever have the current user's ID.
+                        patternProperties:
+                            "^@": *receiptUserMap
+        additionalProperties: false
+    type:
+        type: string
+        enum: ["m.receipt", "m.receipt.private"]
+required: ["type", "content"]

data/data/matrix-spec/event-schemas/schema/m.recent_emoji.yaml

@@ -0,0 +1,29 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "title": "Recent Emoji Event",
+  "description": "Lets clients maintain a list of recently used emoji.",
+  "allOf": [{
+    "$ref": "core-event-schema/event.yaml"
+  }],
+  "properties": {
+    "type": {
+      "type": "string",
+      "enum": ["m.recent_emoji"]
+    },
+    "content": {
+      "type": "object",
+      "properties": {
+        "recent_emoji": {
+          "description": "The list of recently used emoji. Elements in the list are ordered descendingly by last usage time.",
+          "type": "array",
+          "items": {
+            "$ref": "../../api/client-server/definitions/recent_emoji.yaml"
+          },
+        }
+      },
+      "required": ["recent_emoji"]
+    }
+  },
+  "required": ["type", "content"]
+}

data/data/matrix-spec/event-schemas/schema/m.room.avatar.yaml

@@ -0,0 +1,29 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/state_event.yaml
+description: A picture that is associated with the room. This can be displayed alongside the room information.
+properties:
+  content:
+    properties:
+      info:
+        allOf:
+          - $ref: core-event-schema/msgtype_infos/avatar_info.yaml
+        description: Metadata about the image referred to in `url`.
+      url:
+        description: |-
+          The URL to the image. If this property is not present, the room has no avatar. This can be useful
+          to remove a previous room avatar.
+        type: string
+    type: object
+  state_key:
+    description: A zero-length string.
+    pattern: '^$'
+    type: string
+  type:
+    enum:
+      - m.room.avatar
+    type: string
+title: RoomAvatar
+type: object

data/data/matrix-spec/event-schemas/schema/m.room.canonical_alias.yaml

@@ -0,0 +1,40 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/state_event.yaml
+description: |-
+    This event is used to inform the room about which alias should be
+    considered the canonical one, and which other aliases point to the room.
+    This could be for display purposes or as suggestion to users which alias
+    to use to advertise and access the room.
+properties:
+  content:
+    properties:
+      alias:
+        description: |
+          The canonical alias for the room. If not present, null, or empty the
+          room should be considered to have no canonical alias.
+        type: string
+        format: mx-room-alias
+        pattern: "^#"
+      alt_aliases:
+        description: |
+          Alternative aliases the room advertises. This list can have aliases
+          despite the `alias` field being null, empty, or otherwise not present.
+        type: array
+        items:
+          type: string
+          format: mx-room-alias
+          pattern: "^#"
+    type: object
+  state_key:
+    description: A zero-length string.
+    pattern: '^$'
+    type: string
+  type:
+    enum:
+      - m.room.canonical_alias
+    type: string
+title: Informs the room as to which alias is the canonical one.
+type: object

data/data/matrix-spec/event-schemas/schema/m.room.create.yaml

@@ -0,0 +1,86 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/state_event.yaml
+description: This is the first event in a room and cannot be changed. It acts as the root of all other events.
+properties:
+  content:
+    properties:
+      creator:
+        description: |-
+          The `user_id` of the room creator. **Required** for, and only present in, room versions 1 - 10. Starting with
+          room version 11 the event `sender` should be used instead.
+        type: string
+        format: mx-user-id
+        pattern: "^@"
+      m.federate:
+        description: Whether users on other servers can join this room. Defaults to `true` if key does not exist.
+        type: boolean
+      room_version:
+        description: The version of the room. Defaults to `"1"` if the key does not exist.
+        type: string
+      type:
+        description: |-
+          Optional [room type](/client-server-api/#types) to denote a room's intended function outside of traditional
+          conversation.
+
+          Unspecified room types are possible using [Namespaced Identifiers](/appendices/#common-namespaced-identifier-grammar).
+        type: string
+      predecessor:
+        description: A reference to the room this room replaces, if the previous room was upgraded.
+        type: object
+        title: Previous Room
+        properties:
+          room_id:
+            type: string
+            format: mx-room-id
+            pattern: "^!"
+            description: The ID of the old room.
+          event_id:
+            type: string
+            format: mx-event-id
+            pattern: "^\\$"
+            deprecated: true
+            x-changedInMatrixVersion:
+              "1.16": |-
+                This field became deprecated and may not be present in all cases. It SHOULD still
+                be populated where possible/practical. Previously, it was required.
+            description: |-
+              The event ID of the last known event in the old room, if known.
+
+              If not set, clients SHOULD search for the `m.room.tombstone` state event to navigate to
+              when directing the user to the old room (potentially after joining the room, if requested
+              by the user).
+        required: [room_id]
+      additional_creators:
+        type: array
+        items:
+          type: string
+          format: mx-user-id
+          pattern: "^@"
+          description: Additional user ID to consider a creator of the room, if supported by the room version.
+        x-addedInMatrixVersion: "1.16"
+        description: |-
+          Starting with room version 12, the other user IDs to consider as creators for the room in
+          addition to the `sender` of this event. Each string MUST be a valid [user ID](/appendices#user-identifiers)
+          for the room version.
+
+          When not present or empty, the `sender` of the event is the only creator.
+
+          In room versions 1 through 11, this field serves no purpose and is not validated. Clients
+          SHOULD NOT attempt to parse or understand this field in these room versions.
+
+          **Note**: Because `creator` was removed in room version 11, the field is not used to determine
+          which user(s) are room creators in room version 12 and beyond either.
+    type: object
+  state_key:
+    description: A zero-length string.
+    pattern: '^$'
+    type: string
+  type:
+    enum:
+      - m.room.create
+    type: string
+title: The first event in the room.
+type: object

data/data/matrix-spec/event-schemas/schema/m.room.encrypted.yaml

@@ -0,0 +1,91 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/event.yaml
+
+description: |-
+  This event type is used when sending encrypted events. It can be used either
+  within a room (in which case it will have all of the normal properties in
+  [Room events](/client-server-api/#room-event-format)), or
+  as a [to-device](/client-server-api/#send-to-device-messaging) event.
+
+properties:
+  content:
+    properties:
+      algorithm:
+        type: string
+        enum:
+          - m.olm.v1.curve25519-aes-sha2
+          - m.megolm.v1.aes-sha2
+        description: |-
+          The encryption algorithm used to encrypt this event. The
+          value of this field determines which other properties will be
+          present.
+      ciphertext:
+        oneOf:
+          - type: string
+          - type: object
+            additionalProperties:
+              type: object
+              title: CiphertextInfo
+              properties:
+                body:
+                  type: string
+                  description: The encrypted payload.
+                type:
+                  type: integer
+                  description: The Olm message type.
+        description: |-
+          The encrypted content of the event. Either the encrypted payload
+          itself, in the case of a Megolm event, or a map from the recipient
+          Curve25519 identity key to ciphertext information, in the case of an
+          Olm event. For more details, see [Messaging Algorithms](/client-server-api/#messaging-algorithms).
+      sender_key:
+        type: string
+        deprecated: true
+        x-changedInMatrixVersion:
+          "1.3": |-
+            Previously this field was required, however given it offers no additional
+            security or privacy benefit it has been deprecated for Megolm messages.
+            See [`m.megolm.v1.aes-sha2`](/client-server-api/#mmegolmv1aes-sha2) for
+            more information.
+        description: |-
+          The Curve25519 key of the sender. Required (not deprecated) if not using Megolm.
+
+          **Deprecated**: This field provides no additional security or privacy benefit
+          for Megolm messages and must not be read from if the encrypted event is using
+          Megolm. It should still be included on outgoing messages, however must not be
+          used to find the corresponding session. See [`m.megolm.v1.aes-sha2`](/client-server-api/#mmegolmv1aes-sha2)
+          for more information.
+      device_id:
+        type: string
+        deprecated: true
+        x-changedInMatrixVersion:
+          "1.3": |-
+            Previously this field was required for Megolm messages, however given it
+            offers no additional security or privacy benefit it has been deprecated
+            for Megolm messages. See [`m.megolm.v1.aes-sha2`](/client-server-api/#mmegolmv1aes-sha2)
+            for more information.
+        description: |-
+          The ID of the sending device.
+
+          **Deprecated**: This field provides no additional security or privacy benefit
+          for Megolm messages and must not be read from if the encrypted event is using
+          Megolm. It should still be included on outgoing messages, however must not be
+          used to find the corresponding session. See [`m.megolm.v1.aes-sha2`](/client-server-api/#mmegolmv1aes-sha2)
+          for more information.
+      session_id:
+        type: string
+        description: |-
+          The ID of the session used to encrypt the message. Required with
+          Megolm.
+    required:
+      - algorithm
+      - ciphertext
+    type: object
+  type:
+    enum:
+      - m.room.encrypted
+    type: string
+type: object

data/data/matrix-spec/event-schemas/schema/m.room.encryption.yaml

@@ -0,0 +1,38 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/state_event.yaml
+description: Defines how messages sent in this room should be encrypted.
+properties:
+  content:
+    properties:
+      algorithm:
+        type: string
+        enum:
+          - "m.megolm.v1.aes-sha2"
+        description: |-
+          The encryption algorithm to be used to encrypt messages sent in this
+          room.
+      rotation_period_ms:
+        type: integer
+        description: |-
+          How long the session should be used before changing it. `604800000`
+          (a week) is the recommended default.
+      rotation_period_msgs:
+        type: integer
+        description: |-
+          How many messages should be sent before changing the session. `100` is the
+          recommended default.
+    required:
+      - algorithm
+    type: object
+  state_key:
+    description: A zero-length string.
+    pattern: '^$'
+    type: string
+  type:
+    enum:
+      - m.room.encryption
+    type: string
+type: object

data/data/matrix-spec/event-schemas/schema/m.room.guest_access.yaml

@@ -0,0 +1,28 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/state_event.yaml
+description: 'This event controls whether guest users are allowed to join rooms. If this event is absent, servers should act as if it is present and has the guest_access value "forbidden".'
+properties:
+  content:
+    properties:
+      guest_access:
+        description: Whether guests can join the room.
+        enum:
+          - can_join
+          - forbidden
+        type: string
+    required:
+      - guest_access
+    type: object
+  state_key:
+    description: A zero-length string.
+    pattern: '^$'
+    type: string
+  type:
+    enum:
+      - m.room.guest_access
+    type: string
+title: Controls whether guest users are allowed to join rooms.
+type: object

data/data/matrix-spec/event-schemas/schema/m.room.history_visibility.yaml

@@ -0,0 +1,30 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/state_event.yaml
+description: This event controls whether a user can see the events that happened in a room from before they joined.
+properties:
+  content:
+    properties:
+      history_visibility:
+        description: Who can see the room history.
+        enum:
+          - invited
+          - joined
+          - shared
+          - world_readable
+        type: string
+    required:
+      - history_visibility
+    type: object
+  state_key:
+    description: A zero-length string.
+    pattern: '^$'
+    type: string
+  type:
+    enum:
+      - m.room.history_visibility
+    type: string
+title: Controls visibility of history.
+type: object

data/data/matrix-spec/event-schemas/schema/m.room.join_rules.yaml

@@ -0,0 +1,78 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/state_event.yaml
+description: |
+  A room may have one of the following designations:
+  * `public` - anyone can join the room without any prior action.
+  * `invite` - a user must first receive an invite from someone already in the room
+    in order to join.
+  * `knock` - a user can request an invite to the room. They can be allowed (invited)
+    or denied (kicked/banned) access. Otherwise, users need to be invited in. Only
+    available in rooms [which support knocking](/rooms/#feature-matrix).
+  * `restricted` - anyone able to satisfy at least one of the allow conditions is
+    able to join the room without prior action. Otherwise, an invite is required.
+    Only available in rooms [which support the join rule](/rooms/#feature-matrix).
+  * `knock_restricted` - a user can request an invite using the same functions offered
+    by the `knock` join rule, or can attempt to join having satisfied an allow condition
+    per the `restricted` join rule. Only available in rooms
+    [which support the join rule](/rooms/#feature-matrix).
+  * `private` - reserved without implementation. No significant meaning.
+properties:
+  content:
+    properties:
+      join_rule:
+        description: The type of rules used for users wishing to join this room.
+        enum:
+          - public
+          - knock
+          - invite
+          - private
+          - restricted
+          - knock_restricted
+        type: string
+      allow:
+        x-addedInMatrixVersion: "1.2"
+        description: |-
+          For `restricted` rooms, the conditions the user will be tested against. The
+          user needs only to satisfy one of the conditions to join the `restricted`
+          room. If the user fails to meet any condition, or the condition is unable
+          to be confirmed as satisfied, then the user requires an invite to join the
+          room. Improper or no `allow` conditions on a `restricted` join rule imply
+          the room is effectively invite-only (no conditions can be satisfied).
+        type: array
+        items:
+          type: object
+          title: AllowCondition
+          properties:
+            type:
+              type: string
+              description: |-
+                The type of condition:
+                * `m.room_membership` - the user satisfies the condition if they are
+                  joined to the referenced room.
+              enum: ['m.room_membership']
+            room_id:
+              type: string
+              format: mx-room-id
+              pattern: "^!"
+              description: |-
+                Required if `type` is `m.room_membership`. The room ID to check the
+                user's membership against. If the user is joined to this room, they
+                satisfy the condition and thus are permitted to join the `restricted`
+                room.
+          required: ['type']
+    required:
+      - join_rule
+    type: object
+  state_key:
+    description: A zero-length string.
+    pattern: '^$'
+    type: string
+  type:
+    enum:
+      - m.room.join_rules
+    type: string
+title: Describes how users are allowed to join the room.
+type: object