Add interaction metadata to interactions.

Author: mplatypus

hikari/impl/entity_factory.py

@@ -643,9 +643,7 @@ def deserialize_application(self, payload: data_binding.JSONObject) -> applicati
             oauth2_install_parameters = None
             if (oauth2_install_params_payload := integration_payload.get("oauth2_install_params")) is not None:
                 oauth2_install_parameters = application_models.OAuth2InstallParameters(
-                    scopes=[
-                        application_models.OAuth2Scope(scope) for scope in oauth2_install_params_payload["scopes"]
-                    ],
+                    scopes=[application_models.OAuth2Scope(scope) for scope in oauth2_install_params_payload["scopes"]],
                     permissions=permission_models.Permissions(int(oauth2_install_params_payload["permissions"])),
                 )
 
@@ -2590,6 +2588,30 @@ def _deserialize_resolved_option_data(
             attachments=attachments, channels=channels, members=members, messages=messages, roles=roles, users=users
         )
 
+    def _deserialize_command_message_interaction_metadata(
+        self, payload: data_binding.JSONObject
+    ) -> command_interactions.CommandMessageInteractionMetadata:
+        authorizing_integration_owners = {
+            application_models.ApplicationIntegrationType(int(integration_type)): snowflakes.Snowflake(
+                integration_owner_id
+            )
+            for integration_type, integration_owner_id in payload["authorizing_integration_owners"].items()
+        }
+
+        return command_interactions.CommandMessageInteractionMetadata(
+            interaction_id=payload["id"],
+            type=base_interactions.InteractionType(payload["type"]),
+            user=self.deserialize_user(payload["user"]),
+            authorizing_integration_owners=authorizing_integration_owners,
+            original_response_message_id=snowflakes.Snowflake(payload["original_response_message_id"])
+            if "original_response_message_id" in payload
+            else None,
+            target_user=self.deserialize_user(payload["target_user"]) if "target_user" in payload else None,
+            target_message_id=snowflakes.Snowflake(payload["target_message_id"])
+            if "target_message_id" in payload
+            else None,
+        )
+
     def deserialize_command_interaction(
         self, payload: data_binding.JSONObject
     ) -> command_interactions.CommandInteraction:
@@ -2653,6 +2675,9 @@ def deserialize_command_interaction(
             entitlements=entitlements,
             authorizing_integration_owners=authorizing_integration_owners,
             context=application_models.ApplicationContextType(payload["context"]),
+            interaction_metadata=self._deserialize_command_message_interaction_metadata(payload["interaction_metadata"])
+            if "interaction_metadata" in payload
+            else None,
         )
 
     def deserialize_autocomplete_interaction(
@@ -2707,6 +2732,27 @@ def deserialize_autocomplete_interaction(
             context=application_models.ApplicationContextType(payload["context"]),
         )
 
+    def _deserialize_modal_message_interaction_metadata(
+        self, payload: data_binding.JSONObject
+    ) -> modal_interactions.ModalMessageInteractionMetadata:
+        authorizing_integration_owners = {
+            application_models.ApplicationIntegrationType(int(integration_type)): snowflakes.Snowflake(
+                integration_owner_id
+            )
+            for integration_type, integration_owner_id in payload["authorizing_integration_owners"].items()
+        }
+
+        return modal_interactions.ModalMessageInteractionMetadata(
+            interaction_id=payload["id"],
+            type=base_interactions.InteractionType(payload["type"]),
+            user=self.deserialize_user(payload["user"]),
+            authorizing_integration_owners=authorizing_integration_owners,
+            original_response_message_id=snowflakes.Snowflake(payload["original_response_message_id"])
+            if "original_response_message_id" in payload
+            else None,
+            triggering_interaction_metadata=NotImplemented,  # FIXME: Unsure how to handle this.
+        )
+
     def deserialize_modal_interaction(self, payload: data_binding.JSONObject) -> modal_interactions.ModalInteraction:
         data_payload = payload["data"]
 
@@ -2756,6 +2802,9 @@ def deserialize_modal_interaction(self, payload: data_binding.JSONObject) -> mod
             entitlements=[self.deserialize_entitlement(entitlement) for entitlement in payload.get("entitlements", ())],
             authorizing_integration_owners=authorizing_integration_owners,
             context=application_models.ApplicationContextType(payload["context"]),
+            interaction_metadata=self._deserialize_modal_message_interaction_metadata(payload["interaction_metadata"])
+            if "interaction_metadata" in payload
+            else None,
         )
 
     def deserialize_interaction(self, payload: data_binding.JSONObject) -> base_interactions.PartialInteraction:
@@ -2804,6 +2853,27 @@ def serialize_command_option(self, option: commands.CommandOption) -> data_bindi
 
         return payload
 
+    def _deserialize_component_message_interaction_metadata(
+        self, payload: data_binding.JSONObject
+    ) -> component_interactions.ComponentMessageInteractionMetadata:
+        authorizing_integration_owners = {
+            application_models.ApplicationIntegrationType(int(integration_type)): snowflakes.Snowflake(
+                integration_owner_id
+            )
+            for integration_type, integration_owner_id in payload["authorizing_integration_owners"].items()
+        }
+
+        return component_interactions.ComponentMessageInteractionMetadata(
+            interaction_id=payload["id"],
+            type=base_interactions.InteractionType(payload["type"]),
+            user=self.deserialize_user(payload["user"]),
+            authorizing_integration_owners=authorizing_integration_owners,
+            original_response_message_id=snowflakes.Snowflake(payload["original_response_message_id"])
+            if "original_response_message_id" in payload
+            else None,
+            interacted_message_id=snowflakes.Snowflake(payload["interacted_message_id"]),
+        )
+
     def deserialize_component_interaction(
         self, payload: data_binding.JSONObject
     ) -> component_interactions.ComponentInteraction:
@@ -2857,6 +2927,11 @@ def deserialize_component_interaction(
             entitlements=[self.deserialize_entitlement(entitlement) for entitlement in payload.get("entitlements", ())],
             authorizing_integration_owners=authorizing_integration_owners,
             context=application_models.ApplicationContextType(payload["context"]),
+            interaction_metadata=self._deserialize_component_message_interaction_metadata(
+                payload["interaction_metadata"]
+            )
+            if "interaction_metadata" in payload
+            else None,
         )
 
     ##################

hikari/interactions/base_interactions.py

@@ -234,6 +234,29 @@ def webhook_id(self) -> snowflakes.Snowflake:
         return self.application_id
 
 
+@attrs_extensions.with_copy
+@attrs.define(unsafe_hash=True, kw_only=True, weakref_slot=False)
+class PartialMessageInteractionMetadata:
+    """Metadata about the interaction, including the source of the interaction and relevant server and user IDs."""
+
+    interaction_id: snowflakes.Snowflake = attrs.field(hash=True, repr=True)
+    """The ID for this message interaction."""
+
+    type: typing.Union[InteractionType, int] = attrs.field(eq=False, repr=True)
+    """The type of this message interaction."""
+
+    user: users.User = attrs.field(eq=False, repr=True)
+    """The user who triggered the interaction."""
+
+    authorizing_integration_owners: typing.Mapping[applications.ApplicationIntegrationType, snowflakes.Snowflake] = (
+        attrs.field(eq=False, repr=True)
+    )
+    """A mapping of the [applications.ApplicationIntegrationType] to the related guild or user ID."""
+
+    original_response_message_id: typing.Optional[snowflakes.Snowflake] = attrs.field(hash=True, repr=True)
+    """The ID of the original response message."""
+
+
 class PremiumResponseMixin(PartialInteraction):
     """Mixin' class for all interaction types which can be responded to with a premium upsell."""
 

hikari/interactions/command_interactions.py

@@ -327,6 +327,9 @@ class CommandInteraction(
     target_id: typing.Optional[snowflakes.Snowflake] = attrs.field(default=None, eq=False, hash=False, repr=True)
     """The target of the command. Only available if the command is a context menu command."""
 
+    interaction_metadata: typing.Optional[CommandMessageInteractionMetadata] = attrs.field(eq=False, repr=True)
+    """Sent if the message is sent as a result of an interaction."""
+
     def build_response(self) -> special_endpoints.InteractionMessageBuilder:
         """Get a message response builder for use in the REST server flow.
 
@@ -441,3 +444,15 @@ async def create_response(self, choices: typing.Sequence[special_endpoints.Autoc
             The choices for the autocomplete.
         """
         await self.app.rest.create_autocomplete_response(self.id, self.token, choices)
+
+
+@attrs_extensions.with_copy
+@attrs.define(unsafe_hash=True, kw_only=True, weakref_slot=False)
+class CommandMessageInteractionMetadata(base_interactions.PartialMessageInteractionMetadata):
+    """FIXME: Do docs."""
+
+    target_user: typing.Optional[users_.User] = attrs.field(eq=False, hash=False, repr=True)
+    """The user the command was run on, present only on user command interactions."""
+
+    target_message_id: typing.Optional[snowflakes.Snowflake] = attrs.field(eq=False, hash=False, repr=True)
+    """The ID of the message the command was run on, present only on message command interactions."""

hikari/interactions/component_interactions.py

@@ -153,6 +153,9 @@ class ComponentInteraction(
     entitlements: typing.Sequence[monetization.Entitlement] = attrs.field(eq=False, hash=False, repr=True)
     """For monetized apps, any entitlements for the invoking user, represents access to SKUs."""
 
+    interaction_metadata: typing.Optional[ComponentMessageInteractionMetadata] = attrs.field(eq=False, repr=True)
+    """Sent if the message is sent as a result of an interaction."""
+
     def build_response(self, type_: _ImmediateTypesT, /) -> special_endpoints.InteractionMessageBuilder:
         """Get a message response builder for use in the REST server flow.
 
@@ -316,3 +319,14 @@ def get_guild(self) -> typing.Optional[guilds.GatewayGuild]:
             return self.app.cache.get_guild(self.guild_id)
 
         return None
+
+
+@attrs.define(unsafe_hash=True, kw_only=True, weakref_slot=False)
+class ComponentMessageInteractionMetadata(base_interactions.PartialMessageInteractionMetadata):
+    """FIXME: Do docs."""
+
+    original_response_message_id: typing.Optional[snowflakes.Snowflake] = attrs.field(eq=False, hash=False, repr=True)
+    """The ID of the original response message, present only on follow-up messages."""
+
+    interacted_message_id: snowflakes.Snowflake = attrs.field(eq=False, hash=False, repr=True)
+    """The ID of the message that contained the interactive component"""

hikari/interactions/modal_interactions.py

@@ -23,6 +23,9 @@
 
 from __future__ import annotations
 
+from hikari.interactions.command_interactions import CommandMessageInteractionMetadata
+from hikari.interactions.component_interactions import ComponentMessageInteractionMetadata
+
 __all__: list[str] = ["ModalResponseTypesT", "ModalInteraction", "ModalInteraction"]
 
 import typing
@@ -127,6 +130,9 @@ class ModalInteraction(
     entitlements: typing.Sequence[monetization.Entitlement] = attrs.field(eq=False, hash=False, repr=True)
     """For monetized apps, any entitlements for the invoking user, represents access to SKUs."""
 
+    interaction_metadata: typing.Optional[ModalMessageInteractionMetadata] = attrs.field(eq=False, repr=True)
+    """Sent if the message is sent as a result of an interaction."""
+
     async def fetch_channel(self) -> channels.TextableChannel:
         """Fetch the guild channel this interaction was triggered in.
 
@@ -266,3 +272,16 @@ def build_deferred_response(self) -> special_endpoints.InteractionDeferredBuilde
             Deferred interaction message response builder object.
         """
         return self.app.rest.interaction_deferred_builder(base_interactions.ResponseType.DEFERRED_MESSAGE_CREATE)
+
+
+@attrs.define(unsafe_hash=True, kw_only=True, weakref_slot=False)
+class ModalMessageInteractionMetadata(base_interactions.PartialMessageInteractionMetadata):
+    """FIXME: Do docs."""
+
+    original_response_message_id: typing.Optional[snowflakes.Snowflake] = attrs.field(eq=False, hash=False, repr=True)
+    """The ID of the original response message, present only on follow-up messages."""
+
+    triggering_interaction_metadata: typing.Union[
+        CommandMessageInteractionMetadata, ComponentMessageInteractionMetadata
+    ] = attrs.field(eq=False, hash=False, repr=True)  # FIXME: Might have to do some mixin object for this?
+    """The metadata for the interaction that was used to open the modal."""