laravel-query-builder-js 1.0.1 → 1.0.2

package/README.md

@@ -22,6 +22,12 @@ const query = new QueryBuilder()
 fetch("/api/leads?" + query.toQueryParams());
 ```
 
+> 💡 **Pairs perfectly with a Laravel backend.** The query params this package
+> produces are fully compatible with [**qubuilder**](https://github.com/kalimulhaq/qubuilder)
+> — a PHP/Laravel package that turns the same `select` / `filter` / `sort` / `include` /
+> pagination payload into a fully-chained Eloquent query. Build the query on the client here,
+> consume it on the server there. See [Laravel backend (qubuilder)](#laravel-backend-qubuilder).
+
 ---
 
 ## Table of contents
@@ -34,6 +40,7 @@ fetch("/api/leads?" + query.toQueryParams());
   - [Vue 3](#vue-3)
   - [Angular](#angular)
   - [Plain fetch / Node](#plain-fetch--node)
+- [Laravel backend (qubuilder)](#laravel-backend-qubuilder)
 - [API reference](#api-reference)
   - [Filtering](#filtering)
   - [Grouped & nested conditions](#grouped--nested-conditions)
@@ -163,6 +170,44 @@ const query = new QueryBuilder().whereIn("id", [1, 2, 3]);
 const res = await fetch(`https://api.example.com/users?${query.toQueryParams()}`);
 ```
 
+## Laravel backend (qubuilder)
+
+This package is **fully compatible** with [**qubuilder**](https://github.com/kalimulhaq/qubuilder),
+a PHP 8.3+ / Laravel 11+ package that consumes the exact payload produced by
+`toParams()` / `toQueryParams()` and turns it into a fully-chained Eloquent query — no manual
+`if` chains. Together they give you an end-to-end, Laravel-style query pipeline: **compose on
+the client with `laravel-query-builder-js`, execute on the server with qubuilder.**
+
+The `select`, `filter`, `sort`, `include` and pagination keys map 1:1, so you don't have to
+translate anything between the two layers.
+
+```ts
+// Frontend — laravel-query-builder-js
+const params = new QueryBuilder()
+  .select(["id", "firstName", "email"])
+  .where("state", "=", "Open")
+  .sort({ createdAt: "desc" })
+  .paginate(1, 25)
+  .toParams();
+
+await fetch("/api/leads?" + new URLSearchParams(params));
+```
+
+```php
+// Backend — qubuilder (Laravel controller)
+use Kalimulhaq\Qubuilder\Qubuilder;
+
+public function index(GetCollectionRequest $request)
+{
+    return Qubuilder::make($request->validated(), Lead::class)
+        ->query()
+        ->paginate();
+}
+```
+
+See the [qubuilder documentation](https://github.com/kalimulhaq/qubuilder) for the full list of
+supported operators, aggregates and configuration.
+
 ## API reference
 
 Create a builder with the constructor or a static factory:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "laravel-query-builder-js",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "A fluent, framework-agnostic, Laravel-style query builder for JavaScript & TypeScript. Compose select / filter / sort / include / pagination and serialise to API query params. Works in React, Vue, Angular, and Node.",
   "keywords": [
     "query-builder",