async-matrix 0.1.2 → 1.0.0

data/data/matrix-spec/event-schemas/schema/m.room_key.withheld.yaml

@@ -0,0 +1,88 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/event.yaml
+
+description: |-
+  This event type is used to indicate that the sender is not sharing room keys
+  with the recipient. It is sent as a to-device event.
+
+  Possible values for `code` include:
+
+  * `m.blacklisted`: the user/device was blacklisted.
+  * `m.unverified`: the user/device was not verified, and the sender is only
+    sharing keys with verified users/devices.
+  * `m.unauthorised`: the user/device is not allowed to have the key. For
+    example, this could be sent in response to a key request if the user/device
+    was not in the room when the original message was sent.
+  * `m.unavailable`: sent in reply to a key request if the device that the
+    key is requested from does not have the requested key.
+  * `m.no_olm`: an olm session could not be established.
+
+  In most cases, this event refers to a specific room key. The one exception to
+  this is when the sender is unable to establish an olm session with the
+  recipient. When this happens, multiple sessions will be affected.  In order
+  to avoid filling the recipient\'s device mailbox, the sender should only send
+  one `m.room_key.withheld` message with no `room_id` nor `session_id`
+  set.  If the sender retries and fails to create an olm session again in the
+  future, it should not send another `m.room_key.withheld` message with a
+  `code` of `m.no_olm`, unless another olm session was previously
+  established successfully.  In response to receiving an
+  `m.room_key.withheld` message with a `code` of `m.no_olm`, the
+  recipient may start an olm session with the sender and send an `m.dummy`
+  message to notify the sender of the new olm session.  The recipient may
+  assume that this `m.room_key.withheld` message applies to all encrypted
+  room messages sent before it receives the message.
+properties:
+  content:
+    properties:
+      algorithm:
+        type: string
+        enum: ["m.megolm.v1.aes-sha2"]
+        description: |-
+          The encryption algorithm for the key that this event is about.
+      room_id:
+        type: string
+        description: |-
+          Required if `code` is not `m.no_olm`.  The room for the key that
+          this event is about.
+      session_id:
+        type: string
+        description: |-
+          Required if `code` is not `m.no_olm`.  The session ID of the key
+          that this event is about.
+      sender_key:
+        type: string
+        description: |-
+          The unpadded base64-encoded device curve25519 key of the event\'s
+          sender.
+      code:
+        type: string
+        enum:
+          - m.blacklisted
+          - m.unverified
+          - m.unauthorised
+          - m.unavailable
+          - m.no_olm
+        description: |-
+          A machine-readable code for why the key was not sent. Codes beginning
+          with `m.` are reserved for codes defined in the Matrix
+          specification. Custom codes must use the Java package naming
+          convention.
+      reason:
+        type: string
+        description: |-
+          A human-readable reason for why the key was not sent. The receiving
+          client should only use this string if it does not understand the
+          `code`.
+    required:
+      - algorithm
+      - sender_key
+      - code
+    type: object
+  type:
+    enum:
+      - m.room_key.withheld
+    type: string
+type: object

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

@@ -0,0 +1,38 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/event.yaml
+
+description: |-
+  This event type is used to exchange keys for end-to-end encryption.
+  It is encrypted as an `m.room.encrypted` event using [Olm](/client-server-api/#molmv1curve25519-aes-sha2),
+  then sent as a [to-device](/client-server-api/#send-to-device-messaging) event.
+properties:
+  content:
+    properties:
+      algorithm:
+        type: string
+        enum: ["m.megolm.v1.aes-sha2"]
+        description: |-
+          The encryption algorithm the key in this event is to be used with.
+      room_id:
+        type: string
+        description: The room where the key is used.
+      session_id:
+        type: string
+        description: The ID of the session that the key is for.
+      session_key:
+        type: string
+        description: The key to be exchanged.
+    required:
+      - algorithm
+      - room_id
+      - session_id
+      - session_key
+    type: object
+  type:
+    enum:
+      - m.room_key
+    type: string
+type: object

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

@@ -0,0 +1,73 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/event.yaml
+
+description: |-
+  This event type is used to request keys for end-to-end encryption. It is sent as an
+  unencrypted [to-device](/client-server-api/#send-to-device-messaging) event.
+properties:
+  content:
+    properties:
+      body:
+        description: |-
+          Information about the requested key. Required when `action` is
+          `request`.
+        properties:
+          algorithm:
+            type: string
+            description: |-
+              The encryption algorithm the requested key in this event is to be used
+              with.
+          room_id:
+            type: string
+            description: The room where the key is used.
+          sender_key:
+            type: string
+            x-changedInMatrixVersion:
+              "1.3": |-
+                Previously this field was required, however given it offers no additional
+                security or privacy benefit it has been deprecated. See [`m.megolm.v1.aes-sha2`](/client-server-api/#mmegolmv1aes-sha2)
+                for more information.
+            description: |-
+              The Curve25519 key of the device which initiated the session originally.
+
+              **Deprecated**: This field provides no additional security or privacy benefit
+              and must not be read from. It should still be included on outgoing messages
+              (if the event for which keys are being requested for *also* has a `sender_key`),
+              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 that the key is for.
+        required:
+          - algorithm
+          - room_id
+          - session_id
+        type: object
+        title: RequestedKeyInfo
+      action:
+        enum:
+          - request
+          - request_cancellation
+        type: string
+      requesting_device_id:
+        description: ID of the device requesting the key.
+        type: string
+      request_id:
+        description: |-
+          A random string uniquely identifying the request for a key. If the key is
+          requested multiple times, it should be reused. It should also reused in order
+          to cancel a request.
+        type: string
+    required:
+      - action
+      - requesting_device_id
+      - request_id
+    type: object
+  type:
+    enum:
+      - m.room_key_request
+    type: string
+type: object

data/data/matrix-spec/event-schemas/schema/m.secret.request.yaml

@@ -0,0 +1,42 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/event.yaml
+description: |-
+  Sent by a client to request a secret from another device or to cancel a
+  previous request. It is sent as an unencrypted to-device event.
+properties:
+  content:
+    properties:
+      name:
+        type: string
+        description: |-
+          Required if `action` is `request`. The name of the secret that is
+          being requested.
+      action:
+        type: string
+        enum:
+          - request
+          - request_cancellation
+      requesting_device_id:
+        type: string
+        description: |-
+          The ID of the device requesting the secret.
+      request_id:
+        type: string
+        description: |-
+          A random string uniquely identifying (with respect to the requester
+          and the target) the target for a secret. If the secret is requested
+          from multiple devices at the same time, the same ID MAY be used for
+          every target. The same ID is also used in order to cancel a previous
+          request.
+    required:
+      - action
+      - requesting_device_id
+      - request_id
+  type:
+    enum:
+      - m.secret.request
+    type: string
+type: object

data/data/matrix-spec/event-schemas/schema/m.secret.send.yaml

@@ -0,0 +1,35 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/event.yaml
+description: |-
+  Sent by a client to share a secret with another device, in response to an
+  `m.secret.request` event. It must be encrypted as an `m.room.encrypted` event
+  using [Olm](/client-server-api/#molmv1curve25519-aes-sha2), then sent as a
+  to-device event.
+
+  The `request_id` must match the ID previously given in an `m.secret.request`
+  event. The recipient must ensure that this event comes from a device that the
+  `m.secret.request` event was originally sent to, and that the device is
+  a verified device owned by the recipient. This should be done by checking the
+  sender key of the Olm session that the event was sent over.
+properties:
+  content:
+    properties:
+      request_id:
+        type: string
+        description: |-
+          The ID of the request that this is a response to.
+      secret:
+        type: string
+        description: |-
+          The contents of the secret
+    required:
+      - request_id
+      - secret
+  type:
+    enum:
+      - m.secret.send
+    type: string
+type: object

data/data/matrix-spec/event-schemas/schema/m.space.child.yaml

@@ -0,0 +1,50 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/state_event.yaml
+description: Defines the relationship of a child room to a space-room. Has no effect in rooms which are not [spaces](/client-server-api/#spaces).
+properties:
+  content:
+    properties:
+      via:
+        type: array
+        description: |-
+          A list of servers to try and join through. See also: [Routing](/appendices/#routing).
+
+          When not present or invalid, the child room is not considered to be part of the space.
+        items:
+          type: string
+      order:
+        type: string
+        maxLength: 50
+        pattern: '^[\x20-\x7E]+$'
+        description: |-
+          Optional string to define ordering among space children. These are lexicographically
+          compared against other children's `order`, if present.
+
+          Must consist of ASCII characters within the range `\x20` (space) and `\x7E` (`~`),
+          inclusive. Must not exceed 50 characters.
+
+          `order` values with the wrong type, or otherwise invalid contents, are to be treated
+          as though the `order` key was not provided.
+
+          See [Ordering of children within a space](/client-server-api/#ordering-of-children-within-a-space) for information on how the ordering works.
+      suggested:
+        type: boolean
+        description: |-
+          Optional (default `false`) flag to denote whether the child is "suggested" or of interest
+          to members of the space. This is primarily intended as a rendering hint for clients to
+          display the room differently, such as eagerly rendering them in the room list.
+    required:
+      - via
+    type: object
+  state_key:
+    description: The child room ID being described.
+    type: string
+  type:
+    enum:
+      - m.space.child
+    type: string
+title: Space child room
+type: object

data/data/matrix-spec/event-schemas/schema/m.space.parent.yaml

@@ -0,0 +1,36 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/state_event.yaml
+description: Defines the relationship of a room to a parent space-room.
+properties:
+  content:
+    properties:
+      via:
+        type: array
+        description: |-
+          A list of servers to try and join through. See also: [Routing](/appendices/#routing).
+
+          When not present or invalid, the room is not considered to be part of the parent space.
+        items:
+          type: string
+      canonical:
+        type: boolean
+        description: |-
+          Optional (default `false`) flag to denote this parent is the primary parent for the room.
+
+          When multiple `canonical` parents are found, the lowest parent when ordering by room ID
+          lexicographically by Unicode code-points should be used.
+    required:
+      - via
+    type: object
+  state_key:
+    description: The parent room ID.
+    type: string
+  type:
+    enum:
+      - m.space.parent
+    type: string
+title: Room space parent
+type: object

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

@@ -0,0 +1,36 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/room_event.yaml
+description: This message represents a single sticker image.
+properties:
+  content:
+    properties:
+      body:
+        description: |-
+          A textual representation or associated description of the sticker
+          image. This could be the alt text of the original image, or a message
+          to accompany and further describe the sticker.
+        type: string
+      info:
+        allOf:
+          - $ref: core-event-schema/msgtype_infos/image_info.yaml
+        description: |-
+          Metadata about the image referred to in `url` including a thumbnail
+          representation.
+      url:
+        description: |-
+          The URL to the sticker image. This must be a valid `mxc://` URI.
+        type: string
+    required:
+      - body
+      - info
+      - url
+    type: object
+  type:
+    enum:
+      - m.sticker
+    type: string
+title: StickerMessage
+type: object

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

@@ -0,0 +1,28 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "title": "Tag Event",
+  "description": "Informs the client of tags on a room.",
+  "allOf": [{
+    "$ref": "core-event-schema/event.yaml"
+  }],
+  "properties": {
+    "type": {
+      "type": "string",
+      "enum": ["m.tag"]
+    },
+    "content": {
+      "type": "object",
+      "properties": {
+        "tags": {
+          "type": "object",
+          "description": "The tags on the room and their contents.",
+          "additionalProperties": {
+            "$ref": "../../api/client-server/definitions/tag.yaml"
+          }
+        }
+      }
+    }
+  },
+  "required": ["type", "content"]
+}

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

@@ -0,0 +1,29 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "type": "object",
+    "title": "Typing Event",
+    "description": "Informs the client of the list of users currently typing.",
+    "allOf": [{
+        "$ref": "core-event-schema/event.yaml"
+    }],
+    "properties": {
+        "content": {
+            "type": "object",
+            "properties": {
+                "user_ids": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    },
+                    "description": "The list of user IDs typing in this room, if any."
+                }
+            },
+            "required": ["user_ids"]
+        },
+        "type": {
+            "type": "string",
+            "enum": ["m.typing"]
+        }
+    },
+    "required": ["type", "content"]
+}