async-matrix 0.1.2 → 1.0.0

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

@@ -0,0 +1,23 @@
+{
+  "$ref": "core/room_event.json",
+  "type": "m.room.message",
+  "content": {
+    "body": "Gangnam Style",
+    "url": "mxc://example.org/a526eYUSFFxlgbQYZmo442",
+    "info": {
+      "thumbnail_url": "mxc://example.org/FHyPlCeYUSFFxlgbQYZmoEoe",
+      "thumbnail_info": {
+        "mimetype": "image/jpeg",
+        "size": 46144,
+        "w": 300,
+        "h": 300
+      },
+      "w": 480,
+      "h": 320,
+      "duration": 2140786,
+      "size": 1563685,
+      "mimetype": "video/mp4"
+    },
+    "msgtype": "m.video"
+  }
+} 

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

@@ -0,0 +1,8 @@
+{
+  "$ref": "core/state_event.json",
+  "type": "m.room.name",
+  "state_key": "",
+  "content": {
+    "name": "The room name"
+  }
+}

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

@@ -0,0 +1,8 @@
+{
+  "$ref": "core/state_event.json",
+  "type": "m.room.pinned_events",
+  "state_key": "",
+  "content": {
+    "pinned": ["$someevent:example.org"]
+  }
+}

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

@@ -0,0 +1,11 @@
+{
+  "$ref": "core/state_event.json",
+  "type": "m.room.policy",
+  "state_key": "",
+  "content": {
+    "via": "policy.example.org",
+    "public_keys": {
+      "ed25519": "6yhHGKhCiXTSEN2ksjV7kX_N6rBQZ3Xb-M7LlC6NS-s"
+    }
+  }
+}

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

@@ -0,0 +1,24 @@
+{
+  "$ref": "core/state_event.json",
+  "type": "m.room.power_levels",
+  "state_key": "",
+  "content": {
+    "ban": 50,
+    "events": {
+      "m.room.name": 100,
+      "m.room.power_levels": 100
+    },
+    "events_default": 0,
+    "invite": 50,
+    "kick": 50,
+    "redact": 50,
+    "state_default": 50,
+    "users": {
+      "@example:localhost": 100
+    },
+    "users_default": 0,
+    "notifications": {
+      "room": 20
+    }
+  }
+}

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

@@ -0,0 +1,8 @@
+{
+  "$ref": "core/room_event.json",
+  "type": "m.room.redaction",
+  "content": {
+    "redacts": "$fukweghifu23:localhost",
+    "reason": "Spamming"
+  }
+}

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

@@ -0,0 +1,10 @@
+{
+  "$ref": "core/state_event.json",
+  "type": "m.room.server_acl",
+  "state_key": "",
+  "content": {
+    "allow_ip_literals": false,
+    "allow": ["*"],
+    "deny": ["*.evil.com", "evil.com"]
+  }
+}

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

@@ -0,0 +1,14 @@
+{
+  "$ref": "core/state_event.json",
+  "type": "m.room.third_party_invite",
+  "state_key": "pc98",
+  "content": {
+    "display_name": "Alice Margatroid",
+    "key_validity_url": "https://magic.forest/verifykey",
+    "public_key": "abc123",
+    "public_keys": [{
+      "public_key": "def456",
+      "key_validity_url": "https://magic.forest/verifykey"
+    }]
+  }
+}

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

@@ -0,0 +1,9 @@
+{
+  "$ref": "core/state_event.json",
+  "type": "m.room.tombstone",
+  "state_key": "",
+  "content": {
+    "body": "This room has been replaced",
+    "replacement_room": "!newroom:example.org"
+  }
+}

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

@@ -0,0 +1,16 @@
+{
+  "$ref": "core/state_event.json",
+  "type": "m.room.topic",
+  "state_key": "",
+  "content": {
+    "m.topic": {
+      "m.text": [ {
+        "mimetype": "text/html",
+        "body": "An <em>interesting</em> room topic"
+      }, {
+        "body": "An interesting room topic"
+      }]
+    },
+    "topic": "An interesting room topic"
+  }
+}

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

@@ -0,0 +1,12 @@
+{
+  "$ref": "core/event.json",
+  "type": "m.room_key.withheld",
+  "content": {
+    "algorithm": "m.megolm.v1.aes-sha2",
+    "room_id": "!Cuyf34gef24t:localhost",
+    "session_id": "X3lUlvLELLYxeTx4yOVu6UDpasGEVO0Jbu+QFnm0cKQ",
+    "sender_key": "RF3s+E7RkTQTGF2d8Deol0FkQvgII2aJDf3/Jp5mxVU",
+    "code": "m.unverified",
+    "reason": "Device not verified"
+  }
+}

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

@@ -0,0 +1,10 @@
+{
+  "$ref": "core/event.json",
+  "type": "m.room_key",
+  "content": {
+    "algorithm": "m.megolm.v1.aes-sha2",
+    "room_id": "!Cuyf34gef24t:localhost",
+    "session_id": "X3lUlvLELLYxeTx4yOVu6UDpasGEVO0Jbu+QFnm0cKQ",
+    "session_key": "AgAAAADxKHa9uFxcXzwYoNueL5Xqi69IkD4sni8LlfJL7qNBEY..."
+  }
+}

data/data/matrix-spec/event-schemas/examples/m.room_key_request$cancel_request.yaml

@@ -0,0 +1,8 @@
+{
+  "content": {
+    "action": "request_cancellation",
+    "requesting_device_id": "RJYKSTBOIE",
+    "request_id": "1495474790150.19"
+  },
+  "type": "m.room_key_request"
+}

data/data/matrix-spec/event-schemas/examples/m.room_key_request$request.yaml

@@ -0,0 +1,14 @@
+{
+  "content": {
+    "body": {
+      "algorithm": "m.megolm.v1.aes-sha2",
+      "room_id": "!Cuyf34gef24t:localhost",
+      "session_id": "X3lUlvLELLYxeTx4yOVu6UDpasGEVO0Jbu+QFnm0cKQ",
+      "sender_key": "RF3s+E7RkTQTGF2d8Deol0FkQvgII2aJDf3/Jp5mxVU"
+    },
+    "action": "request",
+    "requesting_device_id": "RJYKSTBOIE",
+    "request_id": "1495474790150.19"
+  },
+  "type": "m.room_key_request"
+}

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

@@ -0,0 +1,9 @@
+{
+  "type": "m.secret.request",
+  "content": {
+    "name": "org.example.some.secret",
+    "action": "request",
+    "requesting_device_id": "ABCDEFG",
+    "request_id": "randomly_generated_id_9573"
+  }
+}

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

@@ -0,0 +1,7 @@
+{
+  "type": "m.secret.send",
+  "content": {
+    "request_id": "randomly_generated_id_9573",
+    "secret": "ThisIsASecretDon'tTellAnyone"
+  }
+}

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

@@ -0,0 +1,10 @@
+{
+  "$ref": "core/state_event.json",
+  "type": "m.space.child",
+  "state_key": "!roomid:example.org",
+  "content": {
+    "suggested": true,
+    "via": ["example.org", "other.example.org"],
+    "order": "lexicographically_compare_me"
+  }
+}

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

@@ -0,0 +1,9 @@
+{
+  "$ref": "core/state_event.json",
+  "type": "m.space.parent",
+  "state_key": "!parent_roomid:example.org",
+  "content": {
+    "canonical": true,
+    "via": ["example.org", "other.example.org"]
+  }
+}

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

@@ -0,0 +1,22 @@
+{
+  "$ref": "core/room_event.json",
+  "type": "m.sticker",
+  "content": {
+    "body": "Landing",
+    "info": {
+      "mimetype": "image/png",
+      "thumbnail_info": {
+        "mimetype": "image/png",
+        "h": 200,
+        "w": 140,
+        "size": 73602,
+        "is_animated": true
+      },
+      "h": 200,
+      "thumbnail_url": "mxc://matrix.org/sHhqkFCvSkFwtmvtETOtKnLP",
+      "w": 140,
+      "size": 73602
+    },
+    "url": "mxc://matrix.org/sHhqkFCvSkFwtmvtETOtKnLP"
+  }
+}

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

@@ -0,0 +1,9 @@
+{
+  "$ref": "core/event.json",
+  "type": "m.tag",
+  "content": {
+    "tags": {
+      "u.work": {"order": 0.9}
+    }
+  }
+}

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

@@ -0,0 +1,7 @@
+{
+  "$ref": "core/room_edu.json",
+  "type": "m.typing",
+  "content": {
+    "user_ids": ["@alice:matrix.org", "@bob:example.com"]
+  }
+}

data/data/matrix-spec/event-schemas/moderation_policy_rule.yaml

@@ -0,0 +1,32 @@
+# Copyright 2020 The Matrix.org Foundation C.I.C.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+$schema: https://json-schema.org/draft/2020-12/schema
+
+properties:
+  entity:
+    description: |-
+      The entity affected by this rule. Glob characters `*` and `?` can be used
+      to match zero or more characters or exactly one character respectively.
+    type: string
+  recommendation:
+    description: The suggested action to take. Currently only `m.ban` is specified.
+    type: string
+  reason:
+    description: The human-readable description for the `recommendation`.
+    type: string
+type: object
+required:
+  - entity
+  - recommendation
+  - reason

data/data/matrix-spec/event-schemas/schema/components/m_text_content_block.yaml

@@ -0,0 +1,28 @@
+type: array
+description: |-
+  An ordered array of textual representations in different mimetypes.
+
+  Senders SHOULD specify at least one representation and SHOULD always
+  include a plaintext representation.
+  
+  Receivers SHOULD use the first representation in the array that
+  they understand.
+title: TextContentBlock
+items:
+  type: object
+  title: TextualRepresentation
+  properties:
+    mimetype:
+      type: string
+      description: The mimetype. Defaults to `text/plain` if omitted.
+      example: "text/html"
+    body:
+      type: string
+      description: |-
+        The string content.
+
+        Clients SHOULD validate and sanitize the content as they do
+        for rich content associated with [`msgtype`](/client-server-api/#mroommessage-msgtypes)
+        of [`m.room.message`](/client-server-api/#mroommessage).
+  required:
+  - body

data/data/matrix-spec/event-schemas/schema/components/sdp_stream_metadata.yaml

@@ -0,0 +1,43 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+
+type: object
+x-addedInMatrixVersion: "1.10"
+description: |-
+  Metadata describing the [streams](/client-server-api/#streams) that will be
+  sent.
+  
+  This is a map of stream ID to metadata about the stream.
+additionalProperties:
+  type: object
+  title: StreamMetadata
+  description: Metadata describing a stream.
+  properties:
+    purpose:
+      type: string
+      enum:
+      - m.usermedia
+      - m.screenshare
+      description: |-
+        The purpose of the stream.
+
+        The possible values are:
+
+        * `m.usermedia`: Stream that contains the webcam and/or microphone
+          tracks.
+        * `m.screenshare`: Stream with the screen-sharing tracks.
+    audio_muted:
+      type: boolean
+      description: |-
+        Whether the audio track in the stream is muted.
+
+        Defaults to `false` if not present.
+      x-addedInMatrixVersion: "1.11"        
+    video_muted:
+      type: boolean
+      description: |-
+        Whether the video track in the stream is muted.
+
+        Defaults to `false` if not present.
+      x-addedInMatrixVersion: "1.11"        
+  required:
+  - purpose

data/data/matrix-spec/event-schemas/schema/components/signed_third_party_invite.yaml

@@ -0,0 +1,48 @@
+title: SignedThirdPartyInvite
+description: |-
+  A block of content which has been signed by the identity server, which
+  homeservers can use to verify the event. Clients should ignore this.
+type: object
+properties:
+  mxid:
+    description: |-
+      The user ID that has been bound to the third-party identifier.
+    type: string
+    format: mx-user-id
+    pattern: "^@"
+    example: "@alice:example.org"
+  signatures:
+    title: IdentityServerSignatures
+    description: |-
+      The identity server signatures for this block. This is a map of identity
+      server name to signing key identifier to base64-encoded signature.
+
+      The signatures are calculated using the process described at
+      [Signing JSON](/appendices/#signing-json).
+    type: object
+    patternProperties:
+      "":
+        x-pattern-format: mx-server-name
+        type: object
+        additionalProperties:
+          type: string
+          format: mx-unpadded-base64
+    example: {
+      "magic.forest": {
+        "ed25519:3": "fQpGIW1Snz+pwLZu6sTy2aHy/DYWWTspTJRPyNp0PKkymfIsNffysMl6ObMMFdIJhk6g6pwlIqZ54rxo8SLmAg"
+      }
+    }
+  token:
+    description: |-
+      The token generated by the identity server at the
+      [`/store_invite`](/identity-service-api/#post_matrixidentityv2store-invite)
+      endpoint.
+
+      It matches the `state_key` of the corresponding [`m.room.third_party_invite`](/client-server-api/#mroomthird_party_invite)
+      event.
+    type: string
+    example: "abc123"
+required:
+  - mxid
+  - signatures
+  - token

data/data/matrix-spec/event-schemas/schema/core-event-schema/call_event.yaml

@@ -0,0 +1,27 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+
+description: "The content of all call events shares a set of common fields: those
+  of room events and some additional VoIP specific fields."
+properties:
+  call_id:
+    type: string
+    description: The ID of the call this event relates to.
+  version:
+    type: string
+    description: The version of the VoIP specification this message adheres to.
+      This specification is version 1. This field is a string such that experimental
+      implementations can use non-integer versions. This field was an integer
+      in the previous spec version and implementations must accept an integer
+      0.
+  party_id:
+    type: string
+    description: 'This identifies the party that sent this event. A client may
+      choose to re-use the device ID from end-to-end cryptography for the value
+      of this field.'
+    x-addedInMatrixVersion: "1.7"
+required:
+- call_id
+- version
+- party_id
+title: CallEvent
+type: object

data/data/matrix-spec/event-schemas/schema/core-event-schema/event.yaml

@@ -0,0 +1,16 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+
+description: The basic set of fields all events must have.
+properties:
+  content:
+    description: The fields in this object will vary depending on the type of event.
+      When interacting with the REST API, this is the HTTP body.
+    type: object
+  type:
+    description: The type of event, as defined by [the event type specification](/client-server-api/#types-of-room-events).
+    type: string
+required:
+  - type
+  - content
+title: Event
+type: object

data/data/matrix-spec/event-schemas/schema/core-event-schema/msgtype_infos/avatar_info.yaml

@@ -0,0 +1,30 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+
+description: Metadata about an avatar image.
+properties:
+  h:
+    description: |-
+      The intended display height of the image in pixels. This may
+      differ from the intrinsic dimensions of the image file.
+    type: integer
+  w:
+    description: |-
+      The intended display width of the image in pixels. This may
+      differ from the intrinsic dimensions of the image file.
+    type: integer
+  mimetype:
+    description: The mimetype of the image, e.g. `image/jpeg`.
+    type: string
+  size:
+    description: Size of the image in bytes.
+    type: integer
+  thumbnail_url:
+    description: |-
+      The URL (typically [`mxc://` URI](/client-server-api/#matrix-content-mxc-uris)) to a thumbnail of the image.
+    type: string
+  thumbnail_info:
+    allOf:
+      - $ref: thumbnail_info.yaml
+    description: Metadata about the image referred to in `thumbnail_url`.
+title: AvatarInfo
+type: object

data/data/matrix-spec/event-schemas/schema/core-event-schema/msgtype_infos/image_info.yaml

@@ -0,0 +1,52 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+
+description: Metadata about an image.
+properties:
+  h:
+    description: |-
+      The intended display height of the image in pixels. This may
+      differ from the intrinsic dimensions of the image file.
+    type: integer
+  w:
+    description: |-
+      The intended display width of the image in pixels. This may
+      differ from the intrinsic dimensions of the image file.
+    type: integer
+  mimetype:
+    description: The mimetype of the image, e.g. `image/jpeg`.
+    type: string
+  size:
+    description: Size of the image in bytes.
+    type: integer
+  thumbnail_url:
+    description: |-
+      The URL (typically [`mxc://` URI](/client-server-api/#matrix-content-mxc-uris)) to a thumbnail of the image.
+      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: thumbnail_info.yaml
+    description: Metadata about the image referred to in `thumbnail_url`.
+  is_animated:
+    x-addedInMatrixVersion: "1.18"
+    description: |-
+      If this flag is `true`, the original image SHOULD be assumed to be
+      animated. If this flag is `false`, the original image SHOULD be assumed to
+      NOT be animated.
+
+      If a sending client is unable to determine whether an image is animated,
+      it SHOULD leave the flag unset.
+
+      Receiving clients MAY use this flag to optimize whether to download the
+      original image rather than a thumbnail if it is animated, but they SHOULD
+      NOT trust this flag.
+    type: boolean
+title: ImageInfo
+type: object

data/data/matrix-spec/event-schemas/schema/core-event-schema/msgtype_infos/thumbnail_info.yaml

@@ -0,0 +1,22 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+
+description: Metadata about a thumbnail image.
+properties:
+  h:
+    description: |-
+      The intended display height of the image in pixels. This may
+      differ from the intrinsic dimensions of the image file.
+    type: integer
+  w:
+    description: |-
+      The intended display width of the image in pixels. This may
+      differ from the intrinsic dimensions of the image file.
+    type: integer
+  mimetype:
+    description: The mimetype of the image, e.g. `image/jpeg`.
+    type: string
+  size:
+    description: Size of the image in bytes.
+    type: integer
+title: ThumbnailInfo
+type: object

data/data/matrix-spec/event-schemas/schema/core-event-schema/room_event.yaml

@@ -0,0 +1,17 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+
+title: RoomEvent
+description: Room Events have the following fields.
+allOf:
+- $ref: sync_room_event.yaml
+- type: object
+  properties:
+    room_id:
+      description: |-
+        The ID of the room associated with this event. Will not be present on events
+        that arrive through `/sync`, despite being required everywhere else.
+      type: string
+      format: mx-room-id
+      pattern: "^!"
+  required:
+  - room_id

data/data/matrix-spec/event-schemas/schema/core-event-schema/state_event.yaml

@@ -0,0 +1,8 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+- $ref: room_event.yaml
+- $ref: sync_state_event.yaml
+description: State Events have the following fields.
+title: StateEvent
+type: object

data/data/matrix-spec/event-schemas/schema/core-event-schema/stripped_state.yaml

@@ -0,0 +1,48 @@
+# Copyright 2019 The Matrix.org Foundation C.I.C.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Note: this, and the example, are in the `event-schemas` directory because
+# the CS API uses a symlink. In order for the `m.room.member` event to
+# reference this, we'd need to use relative pathing. The symlink makes this
+# difficult because the schema would be at two different locations, with
+# different relative pathing.
+
+$schema: https://json-schema.org/draft/2020-12/schema
+
+title: StrippedStateEvent
+type: object
+description: |-
+  A stripped down state event, with only the `type`, `state_key`,
+  `sender`, and `content` keys.
+properties:
+  content:
+    description: The `content` for the event.
+    title: EventContent
+    type: object
+  state_key:
+    description: The `state_key` for the event.
+    type: string
+  type:
+    description: The `type` for the event.
+    type: string
+  sender:
+    description: The `sender` for the event.
+    type: string
+    format: mx-user-id
+    pattern: "^@"
+required:
+  - type
+  - state_key
+  - content
+  - sender