From b08047ba485f86038f33175162943c0a9878ab1a Mon Sep 17 00:00:00 2001
From: Daniel Weipert <git@mail.dweipert.de>
Date: Fri, 19 Sep 2025 17:03:47 +0200
Subject: add separate matrix specification package

---
 .../Requests/ClientLoginGetRequest.php             |  6 +++
 .../Requests/ClientLoginPostRequest.php            | 53 ++++++++++++++++++++++
 .../Requests/ClientSyncGetRequest.php              |  8 ++++
 matrix-specification/Requests/RateLimited.php      |  8 ++++
 .../Requests/RequiresAuthentication.php            |  8 ++++
 5 files changed, 83 insertions(+)
 create mode 100644 matrix-specification/Requests/ClientLoginGetRequest.php
 create mode 100644 matrix-specification/Requests/ClientLoginPostRequest.php
 create mode 100644 matrix-specification/Requests/ClientSyncGetRequest.php
 create mode 100644 matrix-specification/Requests/RateLimited.php
 create mode 100644 matrix-specification/Requests/RequiresAuthentication.php

(limited to 'matrix-specification/Requests')

diff --git a/matrix-specification/Requests/ClientLoginGetRequest.php b/matrix-specification/Requests/ClientLoginGetRequest.php
new file mode 100644
index 0000000..73cc24c
--- /dev/null
+++ b/matrix-specification/Requests/ClientLoginGetRequest.php
@@ -0,0 +1,6 @@
+<?php
+
+namespace Matrix\Requests;
+
+class ClientLoginGetRequest implements RateLimited
+{}
diff --git a/matrix-specification/Requests/ClientLoginPostRequest.php b/matrix-specification/Requests/ClientLoginPostRequest.php
new file mode 100644
index 0000000..d17c558
--- /dev/null
+++ b/matrix-specification/Requests/ClientLoginPostRequest.php
@@ -0,0 +1,53 @@
+<?php
+
+namespace Matrix\Requests;
+
+use Matrix\Enums\LoginType;
+use Matrix\UserIdentifier;
+
+class ClientLoginPostRequest implements RateLimited, \JsonSerializable
+{
+  public function __construct(
+    private LoginType $type,
+    private ?string $deviceId = null,
+    private ?UserIdentifier $identifier = null,
+    private ?string $initialDeviceDisplayName = null,
+    private ?string $password = null,
+    private ?bool $refreshToken = null,
+    private ?string $token = null,
+  )
+  {
+    if ($type == LoginType::PASSWORD && is_null($password)) {
+      throw new \InvalidArgumentException("password is required when using LoginType password");
+    }
+
+    if ($type == LoginType::TOKEN && is_null($token)) {
+      throw new \InvalidArgumentException("token is required when using LoginType token");
+    }
+  }
+
+  public function jsonSerialize(): array
+  {
+    $request = [
+      "device_id" => $this->deviceId,
+      "identifier" => $this->identifier,
+      "initial_device_display_name" => $this->initialDeviceDisplayName,
+      "refresh_token" => $this->refreshToken,
+      "type" => $this->type,
+    ];
+
+    $request += match ($this->type) {
+      LoginType::PASSWORD => [
+        "password" => $this->password,
+      ],
+
+      LoginType::TOKEN => [
+        "token" => $this->token,
+      ],
+
+      default => [],
+    };
+
+    return array_filter($request, "is_null");
+  }
+}
diff --git a/matrix-specification/Requests/ClientSyncGetRequest.php b/matrix-specification/Requests/ClientSyncGetRequest.php
new file mode 100644
index 0000000..2921fcf
--- /dev/null
+++ b/matrix-specification/Requests/ClientSyncGetRequest.php
@@ -0,0 +1,8 @@
+<?php
+
+namespace Matrix\Requests;
+
+class ClientSyncGetRequest
+{
+  # TODO
+}
diff --git a/matrix-specification/Requests/RateLimited.php b/matrix-specification/Requests/RateLimited.php
new file mode 100644
index 0000000..9f917a4
--- /dev/null
+++ b/matrix-specification/Requests/RateLimited.php
@@ -0,0 +1,8 @@
+<?php
+
+namespace Matrix\Requests;
+
+interface RateLimited
+{
+  # TODO
+}
diff --git a/matrix-specification/Requests/RequiresAuthentication.php b/matrix-specification/Requests/RequiresAuthentication.php
new file mode 100644
index 0000000..c494f13
--- /dev/null
+++ b/matrix-specification/Requests/RequiresAuthentication.php
@@ -0,0 +1,8 @@
+<?php
+
+namespace Matrix\Requests;
+
+interface RequiresAuthentication
+{
+  public function authenticateUser(): bool;
+}
-- 
cgit v1.2.3