From bc778f507d38f36ce239e1afa1e75ff791a98193 Mon Sep 17 00:00:00 2001
From: Jake Barnby <jakeb994@gmail.com>
Date: Fri, 23 May 2025 22:51:20 +1200
Subject: [PATCH] Update to sequence

---
 .../Utopia/Response/Model/Document.php        |  8 ++++----
 .../e2e/Services/Databases/DatabasesBase.php  | 20 +++++++++----------
 2 files changed, 14 insertions(+), 14 deletions(-)

diff --git a/src/Appwrite/Utopia/Response/Model/Document.php b/src/Appwrite/Utopia/Response/Model/Document.php
index 6c4e92b983..d43ab0d1e6 100644
--- a/src/Appwrite/Utopia/Response/Model/Document.php
+++ b/src/Appwrite/Utopia/Response/Model/Document.php
@@ -36,11 +36,11 @@ class Document extends Any
                 'default' => '',
                 'example' => '5e5ea5c16897e',
             ])
-            ->addRule('$internalId', [
+            ->addRule('$sequence', [
                 'type' => self::TYPE_INTEGER,
-                'description' => 'Auto increment integer.',
-                'default' => '',
-                'example' => '1',
+                'description' => 'Document automatically incrementing ID.',
+                'default' => 0,
+                'example' => 1,
             ])
             ->addRule('$collectionId', [
                 'type' => self::TYPE_STRING,
diff --git a/tests/e2e/Services/Databases/DatabasesBase.php b/tests/e2e/Services/Databases/DatabasesBase.php
index b62ff224fb..f80f9dae0a 100644
--- a/tests/e2e/Services/Databases/DatabasesBase.php
+++ b/tests/e2e/Services/Databases/DatabasesBase.php
@@ -1645,7 +1645,7 @@ trait DatabasesBase
         $this->assertEquals($document1['body']['actors'][0], 'Chris Evans');
         $this->assertEquals($document1['body']['actors'][1], 'Samuel Jackson');
         $this->assertEquals($document1['body']['birthDay'], '1975-06-12T12:12:55.000+00:00');
-        $this->assertTrue(array_key_exists('$internalId', $document1['body']));
+        $this->assertTrue(array_key_exists('$sequence', $document1['body']));
 
         $this->assertEquals(201, $document2['headers']['status-code']);
         $this->assertEquals($data['moviesId'], $document2['body']['$collectionId']);
@@ -1663,7 +1663,7 @@ trait DatabasesBase
         $this->assertEquals($document2['body']['birthDay'], null);
         $this->assertEquals($document2['body']['integers'][0], 50);
         $this->assertEquals($document2['body']['integers'][1], 60);
-        $this->assertTrue(array_key_exists('$internalId', $document2['body']));
+        $this->assertTrue(array_key_exists('$sequence', $document2['body']));
 
         $this->assertEquals(201, $document3['headers']['status-code']);
         $this->assertEquals($data['moviesId'], $document3['body']['$collectionId']);
@@ -1678,7 +1678,7 @@ trait DatabasesBase
         $this->assertEquals($document3['body']['actors'][0], 'Tom Holland');
         $this->assertEquals($document3['body']['actors'][1], 'Zendaya Maree Stoermer');
         $this->assertEquals($document3['body']['birthDay'], '1975-06-12T18:12:55.000+00:00'); // UTC for NY
-        $this->assertTrue(array_key_exists('$internalId', $document3['body']));
+        $this->assertTrue(array_key_exists('$sequence', $document3['body']));
 
         $this->assertEquals(400, $document4['headers']['status-code']);
 
@@ -2128,7 +2128,7 @@ trait DatabasesBase
         $this->assertEquals($document['title'], $response['body']['title']);
         $this->assertEquals($document['releaseYear'], $response['body']['releaseYear']);
         $this->assertArrayNotHasKey('birthDay', $response['body']);
-        $this->assertFalse(array_key_exists('$internalId', $response['body']));
+        $this->assertFalse(array_key_exists('$sequence', $response['body']));
 
         // selecting internal id as well
         $response = $this->client->call(Client::METHOD_GET, '/databases/' . $databaseId . '/collections/' . $document['$collectionId'] . '/documents/' . $document['$id'], array_merge([
@@ -2136,7 +2136,7 @@ trait DatabasesBase
             'x-appwrite-project' => $this->getProject()['$id'],
         ], $this->getHeaders()), [
             'queries' => [
-                Query::select(['title', 'releaseYear', '$id','$internalId'])->toString(),
+                Query::select(['title', 'releaseYear', '$id','$sequence'])->toString(),
             ],
         ]);
 
@@ -2144,23 +2144,23 @@ trait DatabasesBase
         $this->assertEquals($document['title'], $response['body']['title']);
         $this->assertEquals($document['releaseYear'], $response['body']['releaseYear']);
         $this->assertArrayNotHasKey('birthDay', $response['body']);
-        $this->assertTrue(array_key_exists('$internalId', $response['body']));
-        $internalId = $response['body']['$internalId'];
+        $this->assertTrue(array_key_exists('$sequence', $response['body']));
+        $sequence = $response['body']['$sequence'];
 
-        // Query by internalId
+        // Query by sequence
         $response = $this->client->call(Client::METHOD_GET, '/databases/' . $databaseId . '/collections/' . $document['$collectionId'] . '/documents/' . $document['$id'], array_merge([
             'content-type' => 'application/json',
             'x-appwrite-project' => $this->getProject()['$id'],
         ], $this->getHeaders()), [
             'queries' => [
-                Query::equal('$internalId', [$internalId])
+                Query::equal('$sequence', [$sequence])
             ],
         ]);
 
         $this->assertEquals(200, $response['headers']['status-code']);
         $this->assertEquals($document['title'], $response['body']['title']);
         $this->assertEquals($document['releaseYear'], $response['body']['releaseYear']);
-        $this->assertTrue(array_key_exists('$internalId', $response['body']));
+        $this->assertTrue(array_key_exists('$sequence', $response['body']));
     }
 
     /**