Add type checks

.gitattributes

@@ -1,6 +1,7 @@
 /.docker                export-ignore
 /.github                export-ignore
 /tests                  export-ignore
+/types                  export-ignore
 .gitattributes          export-ignore
 .gitignore              export-ignore
 docker-compose.ci.yml   export-ignore

.github/workflows/static-analysis.yml

@@ -31,3 +31,7 @@ jobs:
         run: |
           docker compose -f docker-compose.yml -f docker-compose.ci.yml run --rm php${{ matrix.php }} \
             vendor/bin/phpstan analyse --error-format=github --memory-limit=-1
+      - name: Analyse types
+        run: |
+          docker compose -f docker-compose.yml -f docker-compose.ci.yml run --rm php${{ matrix.php }} \
+            vendor/bin/phpstan analyse --configuration=phpstan.types.neon.dist --error-format=github --memory-limit=-1

phpstan.types.neon.dist

@@ -0,0 +1,6 @@
+includes:
+    - ./vendor/larastan/larastan/extension.neon
+parameters:
+    level: 9
+    paths:
+        - types

types/Graph/Builder.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Staudenmeir\LaravelAdjacencyList\Types\Tree;
+
+use Staudenmeir\LaravelAdjacencyList\Types\Graph\Models\Node;
+
+use function PHPStan\Testing\assertType;
+
+function test(Node $node): void
+{
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Builder<Staudenmeir\LaravelAdjacencyList\Types\Graph\Models\Node>',
+        $node->newQuery()
+    );
+}

types/Graph/Models/Node.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Staudenmeir\LaravelAdjacencyList\Types\Graph\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use Staudenmeir\LaravelAdjacencyList\Eloquent\HasGraphRelationships;
+
+class Node extends Model
+{
+    use HasGraphRelationships;
+
+    public function getPivotTableName(): string
+    {
+        return 'edges';
+    }
+}

types/Graph/Relationships.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace Staudenmeir\LaravelAdjacencyList\Types\Graph;
+
+use Staudenmeir\LaravelAdjacencyList\Types\Graph\Models\Node;
+
+use function PHPStan\Testing\assertType;
+
+function test(Node $node): void
+{
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Graph\Ancestors<Staudenmeir\LaravelAdjacencyList\Types\Graph\Models\Node>',
+        $node->ancestors()
+    );
+
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Graph\Ancestors<Staudenmeir\LaravelAdjacencyList\Types\Graph\Models\Node>',
+        $node->ancestorsAndSelf()
+    );
+
+    assertType(
+        'Illuminate\Database\Eloquent\Relations\BelongsToMany<Staudenmeir\LaravelAdjacencyList\Types\Graph\Models\Node>',
+        $node->children()
+    );
+
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Graph\Descendants<Staudenmeir\LaravelAdjacencyList\Types\Graph\Models\Node>',
+        $node->childrenAndSelf()
+    );
+
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Graph\Descendants<Staudenmeir\LaravelAdjacencyList\Types\Graph\Models\Node>',
+        $node->descendants()
+    );
+
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Graph\Descendants<Staudenmeir\LaravelAdjacencyList\Types\Graph\Models\Node>',
+        $node->descendantsAndSelf()
+    );
+
+    assertType(
+        'Illuminate\Database\Eloquent\Relations\BelongsToMany<Staudenmeir\LaravelAdjacencyList\Types\Graph\Models\Node>',
+        $node->parents()
+    );
+
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Graph\Ancestors<Staudenmeir\LaravelAdjacencyList\Types\Graph\Models\Node>',
+        $node->parentsAndSelf()
+    );
+}

types/Graph/Scopes.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Staudenmeir\LaravelAdjacencyList\Types\Graph;
+
+use Staudenmeir\LaravelAdjacencyList\Types\Graph\Models\Node;
+
+use function PHPStan\Testing\assertType;
+
+function test(Node $node): void
+{
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Graph\Ancestors<Staudenmeir\LaravelAdjacencyList\Types\Graph\Models\Node>',
+        $node->ancestors()->subgraph(fn () => null)
+    );
+
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Graph\Ancestors<Staudenmeir\LaravelAdjacencyList\Types\Graph\Models\Node>',
+        $node->ancestors()->whereDepth(3)
+    );
+
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Graph\Ancestors<Staudenmeir\LaravelAdjacencyList\Types\Graph\Models\Node>',
+        $node->ancestors()->breadthFirst()
+    );
+
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Graph\Ancestors<Staudenmeir\LaravelAdjacencyList\Types\Graph\Models\Node>',
+        $node->ancestors()->depthFirst()
+    );
+
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Graph\Ancestors<Staudenmeir\LaravelAdjacencyList\Types\Graph\Models\Node>',
+        $node->ancestors()->whereDepth(3)->breadthFirst()
+    );
+}

types/Tree/Builder.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Staudenmeir\LaravelAdjacencyList\Types\Tree;
+
+use Staudenmeir\LaravelAdjacencyList\Types\Tree\Models\User;
+
+use function PHPStan\Testing\assertType;
+
+function test(User $user): void
+{
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Builder<Staudenmeir\LaravelAdjacencyList\Types\Tree\Models\User>',
+        $user->newQuery()
+    );
+}

types/Tree/Models/Post.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Staudenmeir\LaravelAdjacencyList\Types\Tree\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+class Post extends Model
+{
+    //
+}

types/Tree/Models/Role.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Staudenmeir\LaravelAdjacencyList\Types\Tree\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+class Role extends Model
+{
+    //
+}

types/Tree/Models/Tag.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Staudenmeir\LaravelAdjacencyList\Types\Tree\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+class Tag extends Model
+{
+    //
+}

types/Tree/Models/User.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Staudenmeir\LaravelAdjacencyList\Types\Tree\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use Staudenmeir\LaravelAdjacencyList\Eloquent\HasRecursiveRelationships;
+
+class User extends Model
+{
+    use HasRecursiveRelationships;
+}

types/Tree/Relationships.php

@@ -0,0 +1,107 @@
+<?php
+
+namespace Staudenmeir\LaravelAdjacencyList\Types\Tree;
+
+use Staudenmeir\LaravelAdjacencyList\Types\Tree\Models\Post;
+use Staudenmeir\LaravelAdjacencyList\Types\Tree\Models\Role;
+use Staudenmeir\LaravelAdjacencyList\Types\Tree\Models\Tag;
+use Staudenmeir\LaravelAdjacencyList\Types\Tree\Models\User;
+
+use function PHPStan\Testing\assertType;
+
+function test(User $user): void
+{
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Ancestors<Staudenmeir\LaravelAdjacencyList\Types\Tree\Models\User>',
+        $user->ancestors()
+    );
+
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Ancestors<Staudenmeir\LaravelAdjacencyList\Types\Tree\Models\User>',
+        $user->ancestorsAndSelf()
+    );
+
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Bloodline<Staudenmeir\LaravelAdjacencyList\Types\Tree\Models\User>',
+        $user->bloodline()
+    );
+
+    assertType(
+        'Illuminate\Database\Eloquent\Relations\HasMany<Staudenmeir\LaravelAdjacencyList\Types\Tree\Models\User>',
+        $user->children()
+    );
+
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Descendants<Staudenmeir\LaravelAdjacencyList\Types\Tree\Models\User>',
+        $user->childrenAndSelf()
+    );
+
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Descendants<Staudenmeir\LaravelAdjacencyList\Types\Tree\Models\User>',
+        $user->descendants()
+    );
+
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Descendants<Staudenmeir\LaravelAdjacencyList\Types\Tree\Models\User>',
+        $user->descendantsAndSelf()
+    );
+
+    assertType(
+        'Illuminate\Database\Eloquent\Relations\BelongsTo<Staudenmeir\LaravelAdjacencyList\Types\Tree\Models\User, Staudenmeir\LaravelAdjacencyList\Types\Tree\Models\User>',
+        $user->parent()
+    );
+
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Ancestors<Staudenmeir\LaravelAdjacencyList\Types\Tree\Models\User>',
+        $user->parentAndSelf()
+    );
+
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\RootAncestor<Staudenmeir\LaravelAdjacencyList\Types\Tree\Models\User>',
+        $user->rootAncestor()
+    );
+
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\RootAncestorOrSelf<Staudenmeir\LaravelAdjacencyList\Types\Tree\Models\User>',
+        $user->rootAncestorOrSelf()
+    );
+
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Siblings<Staudenmeir\LaravelAdjacencyList\Types\Tree\Models\User>',
+        $user->siblings()
+    );
+
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Siblings<Staudenmeir\LaravelAdjacencyList\Types\Tree\Models\User>',
+        $user->siblingsAndSelf()
+    );
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\BelongsToManyOfDescendants<Staudenmeir\LaravelAdjacencyList\Types\Tree\Models\Role>',
+        $user->belongsToManyOfDescendants(Role::class)
+    );
+
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\BelongsToManyOfDescendants<Staudenmeir\LaravelAdjacencyList\Types\Tree\Models\Role>',
+        $user->belongsToManyOfDescendantsAndSelf(Role::class)
+    );
+
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\HasManyOfDescendants<Staudenmeir\LaravelAdjacencyList\Types\Tree\Models\Post>',
+        $user->hasManyOfDescendantsAndSelf(Post::class)
+    );
+
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\HasManyOfDescendants<Staudenmeir\LaravelAdjacencyList\Types\Tree\Models\Post>',
+        $user->hasManyOfDescendantsAndSelf(Post::class)
+    );
+
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\MorphToManyOfDescendants<Staudenmeir\LaravelAdjacencyList\Types\Tree\Models\Tag>',
+        $user->morphToManyOfDescendants(Tag::class, 'taggable')
+    );
+
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\MorphToManyOfDescendants<Staudenmeir\LaravelAdjacencyList\Types\Tree\Models\Tag>',
+        $user->morphToManyOfDescendantsAndSelf(Tag::class, 'taggable')
+    );
+}

types/Tree/Scopes.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace Staudenmeir\LaravelAdjacencyList\Types\Tree;
+
+use Staudenmeir\LaravelAdjacencyList\Types\Tree\Models\User;
+
+use function PHPStan\Testing\assertType;
+
+function test(User $user): void
+{
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Builder<Staudenmeir\LaravelAdjacencyList\Types\Tree\Models\User>',
+        $user->tree()
+    );
+
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Builder<Staudenmeir\LaravelAdjacencyList\Types\Tree\Models\User>',
+        $user->treeOf(fn () => null)
+    );
+
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Ancestors<Staudenmeir\LaravelAdjacencyList\Types\Tree\Models\User>',
+        $user->ancestors()->doesntHaveChildren()
+    );
+
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Ancestors<Staudenmeir\LaravelAdjacencyList\Types\Tree\Models\User>',
+        $user->ancestors()->hasChildren()
+    );
+
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Ancestors<Staudenmeir\LaravelAdjacencyList\Types\Tree\Models\User>',
+        $user->ancestors()->hasParent()
+    );
+
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Ancestors<Staudenmeir\LaravelAdjacencyList\Types\Tree\Models\User>',
+        $user->ancestors()->isLeaf()
+    );
+
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Ancestors<Staudenmeir\LaravelAdjacencyList\Types\Tree\Models\User>',
+        $user->ancestors()->isRoot()
+    );
+
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Ancestors<Staudenmeir\LaravelAdjacencyList\Types\Tree\Models\User>',
+        $user->ancestors()->breadthFirst()
+    );
+
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Ancestors<Staudenmeir\LaravelAdjacencyList\Types\Tree\Models\User>',
+        $user->ancestors()->depthFirst()
+    );
+
+    assertType(
+        'Staudenmeir\LaravelAdjacencyList\Eloquent\Relations\Ancestors<Staudenmeir\LaravelAdjacencyList\Types\Tree\Models\User>',
+        $user->ancestors()->hasChildren()->breadthFirst()
+    );
+}