Issue/rdt 440

.gitattributes

@@ -4,10 +4,12 @@
 * text eol=lf
 
 # Ignore all test and documentation with "export-ignore".
+/.github            export-ignore
 /.gitattributes     export-ignore
 /.gitignore         export-ignore
 /.travis.yml        export-ignore
 /phpunit.xml.dist   export-ignore
+/.php_cs.dist.php   export-ignore
 /.scrutinizer.yml   export-ignore
 /tests              export-ignore
 /.editorconfig      export-ignore

.github/workflows/dependabot-auto-merge.yml

@@ -13,7 +13,7 @@ jobs:
 
       - name: Dependabot metadata
         id: metadata
-        uses: dependabot/fetch-metadata@v2.1.0
+        uses: dependabot/fetch-metadata@v2.4.0
         with:
           github-token: "${{ secrets.GITHUB_TOKEN }}"
           compat-lookup: true

.github/workflows/run-tests.yml

@@ -1,82 +1,73 @@
 name: run-tests
 
 on:
-    push:
-        paths:
-            - '**.php'
-            - '.github/workflows/run-tests.yml'
-            - 'phpunit.xml.dist'
-            - 'composer.json'
-            - 'composer.lock'
+  push
 
 jobs:
-    test:
-        runs-on: ${{ matrix.os }}
-        timeout-minutes: 5
-        strategy:
-            fail-fast: true
-            matrix:
-                os: [ubuntu-latest]
-                php: [8.3, 8.2]
-                laravel: [10.*, 11.*]
-                stability: [prefer-stable]
-                include:
-                    - laravel: 11.*
-                      testbench: 9.*
-                      carbon: ^2.63
-                    - laravel: 10.*
-                      testbench: 8.*
+  test:
+    runs-on: ${{ matrix.os }}
 
-        name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.stability }} - ${{ matrix.os }}
+    timeout-minutes: 5
 
-        services:
-            mysql:
-                image: mysql:8.0
-                env:
-                    MYSQL_USER: user
-                    MYSQL_PASSWORD: secret
-                    MYSQL_DATABASE: laravel_query_builder
-                    MYSQL_ROOT_PASSWORD: secretroot
-                ports:
-                    - 3306
-                options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
+    strategy:
+      fail-fast: true
+      matrix:
+        os: [ubuntu-latest]
+        php: [8.4, 8.3, 8.2]
+        laravel: ['10.*', '11.*', '12.*']
+        stability: [prefer-stable]
+        include:
+          - laravel: 11.*
+            testbench: 9.*
+          - laravel: 10.*
+            testbench: 8.*
+          - laravel: 12.*
+            testbench: 10.*
 
-            redis:
-                image: redis
-                ports:
-                    - 6379:6379
-                options: >-
-                    --health-cmd "redis-cli ping"
-                    --health-interval 10s
-                    --health-timeout 5s
-                    --health-retries 5
+    name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.stability }} - ${{ matrix.os }}
 
-        steps:
-            - name: Checkout code
-              uses: actions/checkout@v4
+    services:
+      mysql:
+        image: mysql:8.0
+        env:
+          MYSQL_USER: user
+          MYSQL_PASSWORD: secret
+          MYSQL_DATABASE: laravel_query_builder
+          MYSQL_ROOT_PASSWORD: secretroot
+        ports:
+          - 3306
+        options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
+      redis:
+        image: redis
+        ports:
+          - 6379:6379
+        options: --health-cmd "redis-cli ping" --health-interval 10s --health-timeout 5s --health-retries 5
 
-            - name: Setup PHP
-              uses: shivammathur/setup-php@v2
-              with:
-                  php-version: ${{ matrix.php }}
-                  extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick, fileinfo
-                  coverage: none
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
 
-            - name: Setup problem matchers
-              run: |
-                  echo "::add-matcher::${{ runner.tool_cache }}/php.json"
-                  echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick, fileinfo
+          coverage: none
 
-            - name: Install dependencies
-              run: |
-                  composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}"  --no-interaction --no-update
-                  composer update --${{ matrix.stability }} --prefer-dist --no-interaction
+      - name: Setup problem matchers
+        run: |
+          echo "::add-matcher::${{ runner.tool_cache }}/php.json"
+          echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
 
-            - name: Execute tests
-              run: vendor/bin/pest
-              env:
-                  DB_USERNAME: user
-                  DB_PASSWORD: secret
-                  DB_PORT: ${{ job.services.mysql.ports[3306] }}
-                  REDIS_PORT: 6379
+      - name: Install dependencies
+        run: |
+          composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}"  --no-interaction --no-update
+          composer update --${{ matrix.stability }} --prefer-dist --no-interaction
 
+      - name: Execute tests
+        run: vendor/bin/pest
+        env:
+          DB_USERNAME: user
+          DB_PASSWORD: secret
+          DB_PORT: ${{ job.services.mysql.ports[3306] }}
+          REDIS_PORT: 6379

.gitignore

@@ -3,7 +3,7 @@ composer.lock
 vendor
 .php_cs.cache
 coverage
+.phpunit.cache
 .phpunit.result.cache
 /.idea
 .php-cs-fixer.cache
-

CHANGELOG.md

@@ -2,6 +2,118 @@
 
 All notable changes to `laravel-query-builder` will be documented in this file
 
+## 6.3.2 - 2025-04-16
+
+### What's Changed
+
+* Enhance QueryBuilder with generics support for better type inference by @alexkart in https://github.com/spatie/laravel-query-builder/pull/1002
+
+### New Contributors
+
+* @alexkart made their first contribution in https://github.com/spatie/laravel-query-builder/pull/1002
+
+**Full Changelog**: https://github.com/spatie/laravel-query-builder/compare/6.3.1...6.3.2
+
+## 6.3.1 - 2025-02-21
+
+### What's Changed
+
+* General code health improvements by @xHeaven in https://github.com/spatie/laravel-query-builder/pull/988
+* Bump dependabot/fetch-metadata from 2.2.0 to 2.3.0 by @dependabot in https://github.com/spatie/laravel-query-builder/pull/992
+* Laravel 12.x Compatibility by @laravel-shift in https://github.com/spatie/laravel-query-builder/pull/994
+* Exclude `.github` folder and `.php_cs` from being included in composer installation by @stevebauman in https://github.com/spatie/laravel-query-builder/pull/993
+
+### New Contributors
+
+* @xHeaven made their first contribution in https://github.com/spatie/laravel-query-builder/pull/988
+
+**Full Changelog**: https://github.com/spatie/laravel-query-builder/compare/6.3.0...6.3.1
+
+## 6.3.0 - 2024-12-23
+
+### What's Changed
+
+* Feature: Add "belongs to" filter by @gpibarra in https://github.com/spatie/laravel-query-builder/pull/975
+* Feature: Additional config options to better match the API spec by @CoolGoose in https://github.com/spatie/laravel-query-builder/pull/983
+
+### New Contributors
+
+* @CoolGoose made their first contribution in https://github.com/spatie/laravel-query-builder/pull/983
+
+**Full Changelog**: https://github.com/spatie/laravel-query-builder/compare/6.2.3...6.3.0
+
+## 6.2.3 - 2024-12-23
+
+### What's Changed
+
+* Fix selecting fields on belongs to many relations by @rasmuscnielsen in https://github.com/spatie/laravel-query-builder/pull/986
+
+### New Contributors
+
+* @rasmuscnielsen made their first contribution in https://github.com/spatie/laravel-query-builder/pull/986
+
+**Full Changelog**: https://github.com/spatie/laravel-query-builder/compare/6.2.2...6.2.3
+
+## 6.2.2 - 2024-12-11
+
+### What's Changed
+
+* Update filtering.md to clarify handling of array scope parameter by @g-gullstrand in https://github.com/spatie/laravel-query-builder/pull/976
+* Remove PHPUnit cache by @tarexme in https://github.com/spatie/laravel-query-builder/pull/982
+* Fix typo in filtering.md by @yngc0der in https://github.com/spatie/laravel-query-builder/pull/984
+* Fixed IncludedCount.php by @dash8x in https://github.com/spatie/laravel-query-builder/pull/978
+
+### New Contributors
+
+* @g-gullstrand made their first contribution in https://github.com/spatie/laravel-query-builder/pull/976
+* @tarexme made their first contribution in https://github.com/spatie/laravel-query-builder/pull/982
+* @yngc0der made their first contribution in https://github.com/spatie/laravel-query-builder/pull/984
+* @dash8x made their first contribution in https://github.com/spatie/laravel-query-builder/pull/978
+
+**Full Changelog**: https://github.com/spatie/laravel-query-builder/compare/6.2.1...6.2.2
+
+## 6.2.1 - 2024-10-03
+
+### What's Changed
+
+* Removed explicit escaping for `pgsql` driver in `FiltersPartial` - Fixes #941 by @Talpx1 in https://github.com/spatie/laravel-query-builder/pull/968
+
+**Full Changelog**: https://github.com/spatie/laravel-query-builder/compare/6.2.0...6.2.1
+
+## 6.2.0 - 2024-09-27
+
+### What's Changed
+
+* [FEAT] add filter by operator by @AbdelrahmanBl in https://github.com/spatie/laravel-query-builder/pull/940
+* Add documentation for the operator filter by @AlexVanderbist in https://github.com/spatie/laravel-query-builder/pull/974
+
+### New Contributors
+
+* @AbdelrahmanBl made their first contribution in https://github.com/spatie/laravel-query-builder/pull/940
+
+**Full Changelog**: https://github.com/spatie/laravel-query-builder/compare/6.1.0...6.2.0
+
+## 6.1.0 - 2024-09-23
+
+### What's Changed
+
+* Bump ramsey/composer-install from 2 to 3 by @dependabot in https://github.com/spatie/laravel-query-builder/pull/939
+* Add issue #175 link in selecting-fields.md by @alipadron in https://github.com/spatie/laravel-query-builder/pull/951
+* Update filtering.md by @justinkekeocha in https://github.com/spatie/laravel-query-builder/pull/954
+* Bump dependabot/fetch-metadata from 2.1.0 to 2.2.0 by @dependabot in https://github.com/spatie/laravel-query-builder/pull/955
+* [DOCS] Update Frontend implementation with a new one by @cgarciagarcia in https://github.com/spatie/laravel-query-builder/pull/961
+* Update Documentation for php markdown by @chengkangzai in https://github.com/spatie/laravel-query-builder/pull/969
+* AllowedFilter should return static rather than self by @kosarinin in https://github.com/spatie/laravel-query-builder/pull/964
+
+### New Contributors
+
+* @alipadron made their first contribution in https://github.com/spatie/laravel-query-builder/pull/951
+* @cgarciagarcia made their first contribution in https://github.com/spatie/laravel-query-builder/pull/961
+* @chengkangzai made their first contribution in https://github.com/spatie/laravel-query-builder/pull/969
+* @kosarinin made their first contribution in https://github.com/spatie/laravel-query-builder/pull/964
+
+**Full Changelog**: https://github.com/spatie/laravel-query-builder/compare/6.0.1...6.1.0
+
 ## 6.0.1 - 2024-05-21
 
 ### What's Changed

README.md

@@ -1,11 +1,19 @@
-# Build Eloquent queries from API requests
+<div align="left">
+    <a href="https://spatie.be/open-source?utm_source=github&utm_medium=banner&utm_campaign=laravel-query-builder">
+      <picture>
+        <source media="(prefers-color-scheme: dark)" srcset="https://spatie.be/packages/header/laravel-query-builder/html/dark.webp">
+        <img alt="Logo for laravel-query-builder" src="https://spatie.be/packages/header/laravel-query-builder/html/light.webp" height="190">
+      </picture>
+    </a>
+
+<h1>Build Eloquent queries from API requests</h1>
 
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/spatie/laravel-query-builder.svg?style=flat-square)](https://packagist.org/packages/spatie/laravel-query-builder)
 ![Test Status](https://img.shields.io/github/actions/workflow/status/spatie/laravel-query-builder/run-tests.yml?label=tests&branch=main)
 ![Code Style Status](https://img.shields.io/github/actions/workflow/status/spatie/laravel-query-builder/php-cs-fixer.yml?label=code%20style&branch=main)
 [![Total Downloads](https://img.shields.io/packagist/dt/spatie/laravel-query-builder.svg?style=flat-square)](https://packagist.org/packages/spatie/laravel-query-builder)
-
-This package allows you to filter, sort and include eloquent relations based on a request. The `QueryBuilder` used in this package extends Laravel's default Eloquent builder. This means all your favorite methods and macros are still available. Query parameter names follow the [JSON API specification](http://jsonapi.org/) as closely as possible.
+    
+</div>
 
 ## Caching foreign keys
 Add this line to your composer.json file to cache foreign keys. This will allow the query builder to automatically detect foreign keys without having to make a database call.

composer.json

@@ -21,19 +21,18 @@
     ],
     "require": {
         "php": "^8.2",
-        "illuminate/database": "^10.0|^11.0",
-        "illuminate/http": "^10.0|^11.0",
-        "illuminate/support": "^10.0|^11.0",
+        "illuminate/database": "^10.0|^11.0|^12.0",
+        "illuminate/http": "^10.0|^11.0|^12.0",
+        "illuminate/support": "^10.0|^11.0|^12.0",
         "spatie/laravel-package-tools": "^1.11",
         "doctrine/dbal": "^3.5"
     },
     "require-dev": {
         "ext-json": "*",
         "mockery/mockery": "^1.4",
-        "nunomaduro/larastan": "^2.0",
-        "orchestra/testbench": "^7.0|^8.0",
-        "phpunit/phpunit": "^10.0",
-        "pestphp/pest": "^2.0",
+        "orchestra/testbench": "^7.0|^8.0|^10.0",
+        "pestphp/pest": "^2.0|^3.7",
+        "phpunit/phpunit": "^10.0|^11.5.3",
         "spatie/invade": "^2.0"
     },
     "autoload": {

config/query-builder.php

@@ -60,4 +60,23 @@
      * GET /users?fields[userOwner]=id,name
      */
     'convert_relation_names_to_snake_case_plural' => true,
+
+    /*
+     * By default, the package expects relationship names to be snake case plural when using fields[relationship].
+     * For example, fetching the id and name for a userOwner relation would look like this:
+     * GET /users?fields[user_owner]=id,name
+     *
+     * Set this to one of `snake_case`, `camelCase` or `none` if you want to enable table name resolution in addition to the relation name resolution
+     * GET /users?include=topOrders&fields[orders]=id,name
+     */
+    'convert_relation_table_name_strategy' => false,
+
+    /*
+     * By default, the package expects the field names to match the database names
+     * For example, fetching the field named firstName would look like this:
+     * GET /users?fields=firstName
+     *
+     * Set this to `true` if you want to convert the firstName into first_name for the underlying query
+     */
+    'convert_field_names_to_snake_case' => false,
 ];

database/factories/AppendModelFactory.php

@@ -2,8 +2,8 @@
 
 namespace Spatie\QueryBuilder\Database\Factories;
 
-use Spatie\QueryBuilder\Tests\TestClasses\Models\AppendModel;
 use Illuminate\Database\Eloquent\Factories\Factory;
+use Spatie\QueryBuilder\Tests\TestClasses\Models\AppendModel;
 
 class AppendModelFactory extends Factory
 {

database/factories/TestModelFactory.php

@@ -16,4 +16,3 @@ public function definition()
         ];
     }
 }
-

docs/_index.md

@@ -1,5 +1,5 @@
 ---
-title: v5
+title: v6
 slogan: Easily build Eloquent queries from API requests.
 githubUrl: https://github.com/spatie/laravel-query-builder
 branch: main

docs/advanced-usage/front-end-implementation.md

@@ -1,6 +1,6 @@
 ---
 title: Front-end implementation
-weight: 3
+weight: 6
 ---
 
 If you're interested in building query urls on the front-end to match this package, you could use one of the below:
@@ -11,3 +11,4 @@ If you're interested in building query urls on the front-end to match this packa
 Pascal Baljet](https://github.com/pascalbaljet).
 - React: [cogent-js package](https://www.npmjs.com/package/cogent-js) by [Joel Male](https://github.com/joelwmale).
 - Typescript: [query-builder-ts package](https://www.npmjs.com/package/@vortechron/query-builder-ts) by [Amirul Adli](https://www.npmjs.com/~vortechron)
+- Typescript + React [react-query-builder](https://www.npmjs.com/package/@cgarciagarcia/react-query-builder) by [Carlos Garcia](https://github.com/cgarciagarcia)