async-matrix 0.1.2 → 1.0.0

data/data/matrix-spec/event-schemas/schema/m.room.message$m.video.yaml

@@ -0,0 +1,95 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/room_event.yaml
+description: This message represents a single video clip.
+properties:
+  content:
+    properties:
+      body:
+        description: |-
+          If `filename` is not set or the value of both properties are
+          identical, this is the filename of the original upload. Otherwise,
+          this is a caption for the video.
+        type: string
+        x-changedInMatrixVersion:
+          "1.10": This property can act as a caption for the video.
+      format:
+        description: |-
+          The format used in the `formatted_body`. This is required if `formatted_body`
+          is specified. Currently only `org.matrix.custom.html` is supported.
+        type: string
+        x-addedInMatrixVersion: "1.10"
+      formatted_body:
+        description: |-
+          The formatted version of the `body`, when it acts as a caption. This
+          is required if `format` is specified.
+        type: string
+        x-addedInMatrixVersion: "1.10"
+      filename:
+        description: The original filename of the uploaded file.
+        type: string
+        x-addedInMatrixVersion: "1.10"
+      info:
+        description: Metadata about the video clip referred to in `url`.
+        properties:
+          duration:
+            description: The duration of the video in milliseconds.
+            type: integer
+          h:
+            description: The height of the video in pixels.
+            type: integer
+          w:
+            description: The width of the video in pixels.
+            type: integer
+          mimetype:
+            description: The mimetype of the video e.g. `video/mp4`.
+            type: string
+          size:
+            description: The size of the video in bytes.
+            type: integer
+          thumbnail_url:
+            description: |-
+              The URL (typically [`mxc://` URI](/client-server-api/#matrix-content-mxc-uris)) to an image thumbnail of
+              the video clip. Only present if the thumbnail is unencrypted.
+            type: string
+          thumbnail_file:
+            description: |-
+              Information on the encrypted thumbnail file, as specified in
+              [End-to-end encryption](/client-server-api/#sending-encrypted-attachments).
+              Only present if the thumbnail is encrypted.
+            title: EncryptedFile
+            type: object
+          thumbnail_info:
+            allOf:
+              - $ref: core-event-schema/msgtype_infos/thumbnail_info.yaml
+            description: Metadata about the image referred to in `thumbnail_url`.
+        title: VideoInfo
+        type: object
+      msgtype:
+        enum:
+          - m.video
+        type: string
+      url:
+        description: |-
+          Required if the file is unencrypted. The URL (typically [`mxc://` URI](/client-server-api/#matrix-content-mxc-uris))
+          to the video clip.
+        type: string
+      file:
+        description: |-
+          Required if the file is encrypted. Information on the encrypted
+          file, as specified in
+          [End-to-end encryption](/client-server-api/#sending-encrypted-attachments).
+        title: EncryptedFile
+        type: object
+    required:
+      - msgtype
+      - body
+    type: object
+  type:
+    enum:
+      - m.room.message
+    type: string
+title: VideoMessage
+type: object

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

@@ -0,0 +1,25 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/room_event.yaml
+description: 'This event is used when sending messages in a room. Messages are not limited to be text. The `msgtype` key outlines the type of message, e.g. text, audio, image, video, etc. The `body` key is text and MUST be used with every kind of `msgtype` as a fallback mechanism for when a client cannot render a message. This allows clients to display *something* even if it is just plain text.'
+properties:
+  content:
+    properties:
+      body:
+        description: The textual representation of this message.
+        type: string
+      msgtype:
+        description: 'The type of message, e.g. `m.image`, `m.text`'
+        type: string
+    required:
+      - msgtype
+      - body
+    type: object
+  type:
+    enum:
+      - m.room.message
+    type: string
+title: Message
+type: object

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

@@ -0,0 +1,35 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/state_event.yaml
+description: |-
+    A room has an opaque room ID which is not human-friendly to read. A room
+    alias is human-friendly, but not all rooms have room aliases. The room name
+    is a human-friendly string designed to be displayed to the end-user. The
+    room name is not unique, as multiple rooms can have the same room name set.
+
+    If a room has an `m.room.name` event with an absent, null, or empty `name`
+    field, it should be treated the same as a room with no `m.room.name` event.
+
+    An event of this type is automatically created when creating a room using
+    `/createRoom` with the `name` key.
+properties:
+  content:
+    properties:
+      name:
+        description: The name of the room.
+        type: string
+    required:
+      - name
+    type: object
+  state_key:
+    description: A zero-length string.
+    pattern: '^$'
+    type: string
+  type:
+    enum:
+      - m.room.name
+    type: string
+title: RoomName
+type: object

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

@@ -0,0 +1,27 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/state_event.yaml
+description: This event is used to "pin" particular events in a room for other participants to review later. The order of the pinned events is guaranteed and based upon the order supplied in the event. Clients should be aware that the current user may not be able to see some of the events pinned due to visibility settings in the room. Clients are responsible for determining if a particular event in the pinned list is displayable, and have the option to not display it if it cannot be pinned in the client.
+properties:
+  content:
+    properties:
+      pinned:
+        description: An ordered list of event IDs to pin.
+        items:
+          type: string
+        type: array
+    required:
+      - pinned
+    type: object
+  state_key:
+    description: A zero-length string.
+    pattern: '^$'
+    type: string
+  type:
+    enum:
+      - m.room.pinned_events
+    type: string
+title: Pinned events in a room
+type: object

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

@@ -0,0 +1,41 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/state_event.yaml
+description: |-
+  A [Policy Server](/client-server-api/#policy-servers) configuration. If invalid
+  or not set, the room does not use a Policy Server.
+properties:
+  content:
+    properties:
+      via:
+        description: |-
+          The server name to use as a Policy Server. MUST have a joined user in
+          the room.
+        type: string
+      public_keys:
+        description: |-
+          The unpadded base64-encoded public keys for the Policy Server. MUST contain at
+          least `ed25519`.
+        type: object
+        properties:
+          ed25519:
+            type: string
+            description: The unpadded base64-encoded ed25519 public key for the Policy Server.
+        required: ['ed25519']
+        additionalProperties:
+          description: The unpadded base64-encoded public key for the key algorithm.
+          type: string
+    type: object
+    required:
+      - via
+      - public_keys
+  state_key:
+    description: An empty string.
+    type: string
+  type:
+    enum:
+      - m.room.policy
+    type: string
+type: object

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

@@ -0,0 +1,139 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/state_event.yaml
+description: |-
+  This event specifies the minimum level a user must have in order to perform a
+  certain action. It also specifies the levels of each user in the room.
+
+  If a `user_id` is in the `users` list, then that `user_id` has the
+  associated power level. Otherwise they have the default level
+  `users_default`. If `users_default` is not supplied, it is assumed to be
+  0. If the room contains no `m.room.power_levels` event, the room's creator has
+  a power level of 100, and all other users have a power level of 0.
+
+  Except for membership events and redactions, the level required to
+  send a certain event is governed purely by `events`, `state_default`
+  and `events_default`. If an event type is specified in `events`, then
+  the user must have at least the level specified in order to send that
+  event. If the event type is not supplied, it defaults to `events_default`
+  for message events and `state_default` for state events.
+
+  If there is no `state_default` in the `m.room.power_levels` event, or
+  there is no `m.room.power_levels` event, the `state_default` is 50.
+  If there is no `events_default` in the `m.room.power_levels` event,
+  or there is no `m.room.power_levels` event, the `events_default` is 0.
+
+  Membership events are not subject to `events`, `events_default`, or
+  `state_default`. Instead, the power level required to invite a user
+  to the room, kick a user from the room, or ban a user from the room
+  is defined by `invite`, `kick`, and `ban`, respectively. The levels
+  for `kick` and `ban` default to 50 if they are not specified in the
+  `m.room.power_levels` event, or if the room contains no
+  `m.room.power_levels` event. `invite` defaults to 0 in either case.
+  Other membership values are handled during event authorization. See
+  the authorization rules in [room versions](/rooms) for further details.
+
+  For redactions of a user's own events, the required power level is
+  determined by the `m.room.redaction` event power level, as per `events`
+  and `events_default`. The power level required to redact an event sent
+  by another user is _additionally_ governed by `redact`. The level for
+  `redact` defaults to 50 if it is not specified in the `m.room.power_levels`
+  event, or if the room contains no `m.room.power_levels` event.
+
+  **Note:**
+
+  The allowed range for power level values is `[-(2**53)+1, (2**53)-1]`,
+  as required by the [Canonical JSON specification](/appendices/#canonical-json).
+
+properties:
+  content:
+    properties:
+      ban:
+        description: The level required to ban a user. Defaults to 50 if unspecified.
+        type: integer
+      events:
+        additionalProperties:
+          type: integer
+        description: |-
+          The level required to send specific event types. This is a mapping from event type to power level required.
+
+          Though not a default, when the server sends the initial power levels event during [room creation](/client-server-api#creation)
+          in [room versions](/rooms) 12 and higher, the `m.room.tombstone` event MUST be explicitly defined and given
+          a power level higher than `state_default`. For example, power level 150. Clients may override this using the
+          described `power_level_content_override` field.
+        x-changedInMatrixVersion:
+          "1.16": Described `m.room.tombstone` defaults during creation of a room version 12 or higher room.
+        title: Event power levels
+        type: object
+      events_default:
+        description: |-
+            The default level required to send message events. Can be
+            overridden by the `events` key.  Defaults to 0 if unspecified.
+        type: integer
+      invite:
+        description: The level required to invite a user. Defaults to 0 if unspecified.
+        type: integer
+      kick:
+        description: The level required to kick a user. Defaults to 50 if unspecified.
+        type: integer
+      redact:
+        description: The level required to redact an event sent by another user. Defaults to 50 if unspecified.
+        type: integer
+      state_default:
+        description: |-
+            The default level required to send state events. Can be overridden
+            by the `events` key. Defaults to 50 if unspecified.
+        type: integer
+      users:
+        patternProperties:
+          "^@":
+            x-pattern-format: mx-user-id
+            type: integer
+        description: |-
+          The power levels for specific users. This is a mapping from `user_id` to power level for that user.
+
+          **Note**: In [room versions](/rooms) 12 and higher it is not permitted to specify the room creators here.
+        x-changedInMatrixVersion:
+          "1.16": Added a note that room creators cannot be specified here in room versions 12 and higher.
+        title: User power levels
+        type: object
+      users_default:
+        x-changedInMatrixVersion:
+          "1.16": The room creator power level now changes depending on room version.
+        description: |-
+            The power level for users in the room whose `user_id` is not mentioned in the `users` key. Defaults to 0 if
+            unspecified.
+
+            **Note**: In [room versions](/rooms) 1 through 11, when there is no `m.room.power_levels`
+            event in the room, the room creator has a power level of 100, and all other users have a
+            power level of 0.
+
+            **Note**: In room versions 12 and higher, room creators have infinite power level regardless
+            of the existence of `m.room.power_levels` in the room. When `m.room.power_levels` is not
+            in the room however, all other users have a power level of 0.
+        type: integer
+      notifications:
+        properties:
+          room:
+            type: integer
+            description: The level required to trigger an `@room` notification. Defaults to 50 if unspecified.
+        additionalProperties:
+          type: integer
+        description: |-
+            The power level requirements for specific notification types.
+            This is a mapping from `key` to power level for that notifications key.
+        title: Notifications
+        type: object
+    type: object
+  state_key:
+    description: A zero-length string.
+    pattern: '^$'
+    type: string
+  type:
+    enum:
+      - m.room.power_levels
+    type: string
+title: Defines the power levels (privileges) of users in the room.
+type: object

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

@@ -0,0 +1,29 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/room_event.yaml
+description: 'This event is created by the server to describe which event has been redacted, by whom, and optionally why. The event that has been redacted is specified in the `redacts` event level key. Redacting an event means that all keys not required by the protocol are stripped off, allowing messages to be hidden or allowing admins to remove offensive or illegal content.'
+properties:
+  content:
+    properties:
+      redacts:
+        description: The event ID that was redacted. Required for, and present starting in, room version 11.
+        type: string
+        format: mx-event-id
+        pattern: "^\\$"
+      reason:
+        description: 'The reason for the redaction, if any.'
+        type: string
+    type: object
+  redacts:
+    description: Required for, and only present in, room versions 1 - 10. The event ID that was redacted.
+    type: string
+    format: mx-event-id
+    pattern: "^\\$"
+  type:
+    enum:
+      - m.room.redaction
+    type: string
+title: Redaction
+type: object

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

@@ -0,0 +1,88 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+title: Server ACL
+description: |-
+  An event to indicate which servers are permitted to participate in the
+  room. Server ACLs may allow or deny groups of hosts. All servers participating
+  in the room, including those that are denied, are expected to uphold the
+  server ACL. Servers that do not uphold the ACLs MUST be added to the denied hosts
+  list in order for the ACLs to remain effective.
+
+  The `allow` and `deny` lists are lists of [glob-style patterns](/appendices#glob-style-matching).
+  When comparing against the server ACLs, the suspect server's port
+  number must not be considered. Therefore `evil.com`, `evil.com:8448`, and
+  `evil.com:1234` would all match rules that apply to `evil.com`, for example.
+
+  The ACLs are applied to servers when they make requests, and are applied in
+  the following order:
+
+  1. If there is no `m.room.server_acl` event in the room state, allow.
+  2. If the server name is an IP address (v4 or v6) literal, and `allow_ip_literals`
+     is present and `false`, deny.
+  3. If the server name matches an entry in the `deny` list, deny.
+  4. If the server name matches an entry in the `allow` list, allow.
+  5. Otherwise, deny.
+
+  **Note:**
+  Server ACLs do not restrict the events relative to the room DAG via authorisation
+  rules, but instead act purely at the network layer to determine which servers are
+  allowed to connect and interact with a given room.
+
+  **Warning:**
+  Failing to provide an `allow` rule of some kind will prevent **all**
+  servers from participating in the room, including the sender. This renders
+  the room unusable. A common allow rule is `[ "*" ]` which would still
+  permit the use of the `deny` list without losing the room.
+
+  **Warning:**
+  All compliant servers must implement server ACLs.  However, legacy or noncompliant
+  servers exist which do not uphold ACLs, and these MUST be manually appended to
+  the denied hosts list when setting an ACL to prevent them from leaking events from
+  banned servers into a room. Currently, the only way to determine noncompliant hosts is
+  to check the `prev_events` of leaked events, therefore detecting servers which
+  are not upholding the ACLs. Server versions can also be used to try to detect hosts that
+  will not uphold the ACLs, although this is not comprehensive. Server ACLs were added
+  in Synapse v0.32.0, although other server implementations and versions exist in the world.
+allOf:
+  - $ref: core-event-schema/state_event.yaml
+type: object
+properties:
+  content:
+    properties:
+      allow_ip_literals:
+        type: boolean
+        description: |-
+          True to allow server names that are IP address literals. False to
+          deny. Defaults to `true` if missing or otherwise not a boolean.
+
+          This is strongly recommended to be set to `false` as servers running
+          with IP literal names are strongly discouraged in order to require
+          legitimate homeservers to be backed by a valid registered domain name.
+      allow:
+        type: array
+        description: |-
+          The server names to allow in the room, excluding any port information.
+          Each entry is interpreted as a [glob-style pattern](/appendices#glob-style-matching).
+
+          **This defaults to an empty list when not provided, effectively disallowing
+          every server.**
+        items:
+          type: string
+      deny:
+        type: array
+        description: |-
+          The server names to disallow in the room, excluding any port information.
+          Each entry is interpreted as a [glob-style pattern](/appendices#glob-style-matching).
+
+          This defaults to an empty list when not provided.
+        items:
+          type: string
+    type: object
+  state_key:
+    description: A zero-length string.
+    pattern: '^$'
+    type: string
+  type:
+    enum: ['m.room.server_acl']
+    type: string

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

@@ -0,0 +1,79 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/state_event.yaml
+description: |-
+  Acts as an `m.room.member` invite event, where there isn't a target user_id to
+  invite. This event contains a token and a public key whose private key must be
+  used to sign the token. Any user who can present that signature may use this
+  invitation to join the target room.
+properties:
+  content:
+    properties:
+      display_name:
+        description: |-
+          A user-readable string which represents the user who has been invited.
+          This should not contain the user's third-party ID, as otherwise when
+          the invite is accepted it would leak the association between the
+          matrix ID and the third-party ID.
+        type: string
+      key_validity_url:
+        description: |-
+          A URL which can be fetched, with querystring public_key=public_key, to
+          validate whether the key has been revoked. The URL must return a JSON
+          object containing a boolean property named 'valid'.
+        type: string
+        format: uri
+      public_key:
+        description: |-
+          An Ed25519 key with which the token must be signed (though a signature
+          from any entry in `public_keys` is also sufficient).
+
+          The key is encoded using [Unpadded Base64](/appendices/#unpadded-base64),
+          using the standard or URL-safe alphabets.
+
+          This exists for backwards compatibility.
+        type: string
+      public_keys:
+        description: Keys with which the token may be signed.
+        items:
+          properties:
+            key_validity_url:
+              description: |-
+                An optional URL which can be fetched, with querystring
+                `public_key=<public_key>`, to validate whether the key has been
+                revoked. The URL must return a JSON object containing a boolean
+                property named `valid`. If this URL is absent, the key must be
+                considered valid indefinitely.
+              type: string
+            public_key:
+              description: |-
+                An Ed25519 key with which the token may be signed.
+
+                The key is encoded using [Unpadded Base64](/appendices/#unpadded-base64),
+                using the standard or URL-safe alphabets.
+              type: string
+          required:
+            - public_key
+          title: PublicKeys
+          type: object
+        type: array
+    required:
+      - display_name
+      - key_validity_url
+      - public_key
+    type: object
+  state_key:
+    description: |-
+      The token, of which a signature must be produced in order to join the
+      room.
+    type: string
+  type:
+    enum:
+      - m.room.third_party_invite
+    type: string
+title: |-
+  An invitation to a room issued to a third-party identifier, rather than a
+  matrix user ID.
+type: object

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

@@ -0,0 +1,29 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/state_event.yaml
+description: 'A state event signifying that a room has been upgraded to a different room version, and that clients should go there.'
+properties:
+  content:
+    properties:
+      body:
+        type: string
+        description: A server-defined message.
+      replacement_room:
+        type: string
+        description: The room ID of the new room the client should be visiting.
+    required:
+      - replacement_room
+      - body
+    type: object
+  state_key:
+    description: A zero-length string.
+    pattern: '^$'
+    type: string
+  type:
+    enum:
+      - m.room.tombstone
+    type: string
+title: Indication that the room has been upgraded.
+type: object

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

@@ -0,0 +1,53 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/state_event.yaml
+description: |-
+    A topic is a short message detailing what is currently being discussed
+    in the room.  It can also be used as a way to display extra information
+    about the room, which may not be suitable for the room name. The room
+    topic can also be set when creating a room using
+    [`/createRoom`](client-server-api/#post_matrixclientv3createroom), either
+    with the `topic` key or by specifying a full event in `initial_state`.
+  
+    If the `topic` property is absent, null, or empty then the topic is unset. In other words,
+    an empty `topic` property effectively resets the room to having no topic.
+
+    In order to prevent formatting abuse in room topics, clients SHOULD
+    limit the length of topics during both entry and display, for instance,
+    by capping the number of displayed lines. Additionally, clients SHOULD
+    ignore things like headings and enumerations (or format them as regular
+    text).
+properties:
+  content:
+    properties:
+      topic:
+        description: |-
+          The topic in plain text.
+
+          This SHOULD duplicate the content of the `text/plain`
+          representation in `m.topic` if any exists.
+        type: string
+      m.topic:
+        type: object
+        title: TopicContentBlock
+        x-addedInMatrixVersion: "1.15"
+        description: |-
+          Textual representation of the room topic in different mimetypes.
+        properties:
+          m.text:
+            $ref: components/m_text_content_block.yaml
+    required:
+      - topic
+    type: object
+  state_key:
+    description: A zero-length string.
+    pattern: '^$'
+    type: string
+  type:
+    enum:
+      - m.room.topic
+    type: string
+title: Topic
+type: object