async-matrix 3.0.1 → 4.0.0

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

@@ -1,45 +0,0 @@
-$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

@@ -1,65 +0,0 @@
-$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

@@ -1,29 +0,0 @@
-{
-  "$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

@@ -1,29 +0,0 @@
----
-$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

@@ -1,40 +0,0 @@
----
-$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

@@ -1,86 +0,0 @@
----
-$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.guest_access.yaml

@@ -1,28 +0,0 @@
----
-$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

@@ -1,30 +0,0 @@
----
-$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

@@ -1,78 +0,0 @@
----
-$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

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

@@ -1,174 +0,0 @@
----
-$schema: https://json-schema.org/draft/2020-12/schema
-
-allOf:
-  - $ref: core-event-schema/state_event.yaml
-description: |-
-  Adjusts the membership state for a user in a room. It is preferable to use the membership APIs
-  (`/rooms/<room id>/invite` etc) when performing membership actions rather than adjusting the
-  state directly as there are a restricted set of valid transformations. For example, user A cannot
-  force user B to join a room, and trying to force this state change directly will fail.
-
-  The following membership states are specified:
-
-  - `invite` - The user has been invited to join a room, but has not yet joined it. They may not
-    participate in the room until they join.
-  - `join` - The user has joined the room (possibly after accepting an invite), and may participate
-    in it.
-  - `leave` - The user was once joined to the room, but has since left (possibly by choice, or
-    possibly by being kicked).
-  - `ban` - The user has been banned from the room, and is no longer allowed to join it until they
-    are un-banned from the room (by having their membership state set to a value other than `ban`).
-  - `knock` - The user has knocked on the room, requesting permission to participate. They may not
-    participate in the room until they join.
-
-  The `third_party_invite` property will be set if this invite is an `invite` event and is the
-  successor of an [`m.room.third_party_invite`](/client-server-api/#mroomthird_party_invite) event,
-  and absent otherwise.
-
-  This event may also include an `invite_room_state` key inside the event's `unsigned` data.
-  If present, this contains an array of [stripped state events](/client-server-api/#stripped-state)
-  to assist the receiver in identifying the room.
-
-  The user for which a membership applies is represented by the `state_key`. Under some conditions,
-  the `sender` and `state_key` may not match - this may be interpreted as the `sender` affecting
-  the membership state of the `state_key` user.
-
-  The `membership` for a given user can change over time. The table below represents the various changes
-  over time and how clients and servers must interpret those changes. Previous membership can be retrieved
-  from the `prev_content` object on an event. If not present, the user's previous membership must be assumed
-  as `leave`.
-
-  |                   | to `invite`          | to `join`                              | to `leave`                                                                                                                              | to `ban`                    | to `knock`           |
-  |-------------------|----------------------|----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|-----------------------------|----------------------|
-  | **from `invite`** | No change.           | User joined the room.                  | If the `state_key` is the same as the `sender`, the user rejected the invite. Otherwise, the `state_key` user had their invite revoked. | User was banned.            | User is re-knocking. |
-  | **from `join`**   | Must never happen.   | `displayname` or `avatar_url` changed. | If the `state_key` is the same as the `sender`, the user left. Otherwise, the `state_key` user was kicked.                              | User was kicked and banned. | Must never happen.   |
-  | **from `leave`**  | New invitation sent. | User joined.                           | No change.                                                                                                                              | User was banned.            | User is knocking.    |
-  | **from `ban`**    | Must never happen.   | Must never happen.                     | User was unbanned.                                                                                                                      | No change.                  | Must never happen.   |
-  | **from `knock`**  | Knock accepted.      | Must never happen.                     | If the `state_key` is the same as the `sender`, the user retracted the knock. Otherwise, the `state_key` user had their knock denied.   | User was banned.            | No change.           |
-
-properties:
-  content:
-    properties:
-      avatar_url:
-        description: 'The avatar URL for this user, if any.'
-        type: string
-        format: uri
-      displayname:
-        description: 'The display name for this user, if any.'
-        type:
-          - "string"
-          - "null"
-      membership:
-        description: The membership state of the user.
-        enum:
-          - invite
-          - join
-          - knock
-          - leave
-          - ban
-        type: string
-      is_direct:
-        description: |-
-          Flag indicating if the room containing this event was created with the intention of being
-          a direct chat. See [Direct Messaging](/client-server-api/#direct-messaging).
-        type: boolean
-      join_authorised_via_users_server:
-        x-addedInMatrixVersion: "1.2"
-        type: string
-        format: mx-user-id
-        pattern: "^@"
-        description: |-
-          Usually found on `join` events, this field is used to denote which homeserver (through
-          representation of a user with sufficient power level) authorised the user's join. More
-          information about this field can be found in the [Restricted Rooms Specification](/client-server-api/#restricted-rooms).
-
-          Client and server implementations should be aware of the [signing implications](/rooms/v8/#authorization-rules)
-          of including this field in further events: in particular, the event must be signed by the
-          server which owns the user ID in the field. When copying the membership event's `content`
-          (for profile updates and similar) it is therefore encouraged to exclude this field in the
-          copy, as otherwise the event might fail event authorization.
-      reason:
-        x-addedInMatrixVersion: "1.1"
-        type: string
-        description: |-
-          Optional user-supplied text for why their membership has changed. For kicks and bans,
-          this is typically the reason for the kick or ban. For other membership changes, this is a
-          way for the user to communicate their intent without having to send a message to the
-          room, such as in a case where Bob rejects an invite from Alice about an upcoming concert,
-          but can't make it that day.
-
-          Clients are not recommended to show this reason to users when receiving an invite due to
-          the potential for spam and abuse. Hiding the reason behind a button or other component is
-          recommended.
-      third_party_invite:
-        title: ThirdPartyInvite
-        description: |-
-          A third-party invite, if this `m.room.member` is the successor to an
-          [`m.room.third_party_invite`](/client-server-api/#mroomthird_party_invite)
-          event.
-        type: object
-        properties:
-          display_name:
-            description: |-
-              A name which can be displayed to represent the user instead of their
-              third-party identifier
-            type: string
-          signed:
-            $ref: components/signed_third_party_invite.yaml
-        required:
-          - display_name
-          - signed
-    required:
-      - membership
-    title: EventContent
-    type: object
-  state_key:
-    description: |-
-      The `user_id` this membership event relates to. In all cases except for when `membership` is
-      `join`, the user ID sending the event does not need to match the user ID in the `state_key`,
-      unlike other events. Regular authorisation rules still apply.
-    type: string
-    format: mx-user-id
-    pattern: "^@"
-  type:
-    enum:
-      - m.room.member
-    type: string
-  unsigned:
-    allOf:
-      - $ref: "core-event-schema/unsigned_prop.yaml"
-      - type: object
-        properties:
-          invite_room_state:
-            x-changedInMatrixVersion:
-              "1.16": |
-                `m.room.create` was made a required event type for stripped state.
-            description: |-
-              A subset of the state of the room at the time of the invite, if `membership` is `invite`.
-              Note that this state is informational, and SHOULD NOT be trusted; once the client has
-              joined the room, it SHOULD fetch the live state from the server and discard the
-              invite_room_state. Also, clients must not rely on any particular state being present here;
-              they SHOULD behave properly (with possibly a degraded but not a broken experience) in
-              the absence of any particular events here. If they are set on the room, at least the
-              state for `m.room.avatar`, `m.room.canonical_alias`, `m.room.join_rules`, and `m.room.name`
-              SHOULD be included. The `m.room.create` event MUST be included, though MAY be missing if
-              the server hasn't updated to support the Matrix 1.16 specification.
-            items:
-              $ref: "core-event-schema/stripped_state.yaml"
-            type: array
-          knock_room_state:
-            x-changedInMatrixVersion:
-              "1.16": |
-                `m.room.create` was made a required event type for stripped state.
-            description: |-
-              A subset of the state of the room at the time of the knock, if `membership` is `knock`.
-              This has the same restrictions as `invite_room_state`. If they are set on the room, at least
-              the state for `m.room.avatar`, `m.room.canonical_alias`, `m.room.join_rules`, `m.room.name`,
-              and `m.room.encryption` SHOULD be included. The `m.room.create` event MUST be included,
-              though MAY be missing if the server hasn't updated to support the Matrix 1.16 specification.
-            items:
-              $ref: "core-event-schema/stripped_state.yaml"
-            type: array
-title: The current membership state of a user in the room.
-type: object