ng-qubee 3.4.0 → 3.5.0

package/package.json

@@ -4,7 +4,7 @@
     "name": "Andrea Tantimonaco",
     "url": "https://andreatantimonaco.me"
   },
-  "version": "3.4.0",
+  "version": "3.5.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -18,6 +18,8 @@
     "angular",
     "api",
     "builder",
+    "django",
+    "drf",
     "filter",
     "headless-cms",
     "json-api",

package/types/ng-qubee.d.ts

@@ -46,6 +46,7 @@ declare class PaginatedCollection<T extends IPaginatedObject> {
  * request building (URI generation) and response parsing.
  */
 declare enum DriverEnum {
+    DRF = "drf",
     JSON_API = "json-api",
     LARAVEL = "laravel",
     NESTJS = "nestjs",
@@ -1642,6 +1643,36 @@ declare class LaravelRequestStrategy extends AbstractRequestStrategy {
     protected parts(state: IQueryBuilderState, options: QueryBuilderOptions): string[];
 }
 
+/**
+ * Base class for response strategies whose pagination metadata is a flat
+ * key-value envelope on the response body
+ *
+ * Laravel's stock pagination and Spatie's `QueryBuilder` both emit the
+ * same flat shape — `{ data, current_page, total, per_page, from, to,
+ * next_page_url, prev_page_url, first_page_url, last_page, last_page_url
+ * }` — and both response strategies were duplicating the byte-identical
+ * `new PaginatedCollection(response[options.X], ...)` body before this
+ * base existed. Concrete classes now extend and provide only the
+ * docstring describing their driver's specific shape (see
+ * `LaravelResponseStrategy`, `SpatieResponseStrategy`).
+ *
+ * Drivers whose pagination metadata is a nested envelope (JSON:API,
+ * NestJS, Strapi) extend `AbstractDotPathResponseStrategy` instead.
+ * Drivers whose metadata comes from HTTP headers (PostgREST) or is
+ * derived from response URLs (DRF) implement `IResponseStrategy`
+ * directly.
+ */
+declare abstract class AbstractFlatResponseStrategy implements IResponseStrategy {
+    /**
+     * Parse a flat-envelope pagination response into a PaginatedCollection
+     *
+     * @param response - The raw API response object
+     * @param options - The response key name configuration
+     * @returns A typed PaginatedCollection instance
+     */
+    paginate<T extends IPaginatedObject>(response: Record<string, any>, options: ResponseOptions): PaginatedCollection<T>;
+}
+
 /**
  * Response strategy for the Laravel (pagination-only) driver
  *
@@ -1654,19 +1685,20 @@ declare class LaravelRequestStrategy extends AbstractRequestStrategy {
  *   "per_page": 15,
  *   "from": 1,
  *   "to": 15,
- *   ...
+ *   "next_page_url": "...",
+ *   "prev_page_url": "...",
+ *   "first_page_url": "...",
+ *   "last_page": 7,
+ *   "last_page_url": "..."
  * }
  * ```
+ *
+ * The traversal algorithm (flat `response[options.X]` lookups) is
+ * inherited from `AbstractFlatResponseStrategy`; this class exists so
+ * `DriverEnum.LARAVEL` resolves to a distinct identity at the DI layer
+ * even though the parsing logic is shared with Spatie.
  */
-declare class LaravelResponseStrategy implements IResponseStrategy {
-    /**
-     * Parse a flat Laravel pagination response into a PaginatedCollection
-     *
-     * @param response - The raw API response object
-     * @param options - The response key name configuration
-     * @returns A typed PaginatedCollection instance
-     */
-    paginate<T extends IPaginatedObject>(response: Record<string, any>, options: ResponseOptions): PaginatedCollection<T>;
+declare class LaravelResponseStrategy extends AbstractFlatResponseStrategy {
 }
 
 /**
@@ -2085,7 +2117,8 @@ declare class SpatieRequestStrategy extends AbstractRequestStrategy {
 /**
  * Response strategy for the Spatie Query Builder driver
  *
- * Parses flat Laravel pagination responses:
+ * Parses flat Laravel-style pagination responses (Spatie's Query Builder
+ * is built on Laravel's pagination):
  * ```json
  * {
  *   "data": [...],
@@ -2098,17 +2131,14 @@ declare class SpatieRequestStrategy extends AbstractRequestStrategy {
  * }
  * ```
  *
+ * The traversal algorithm (flat `response[options.X]` lookups) is
+ * inherited from `AbstractFlatResponseStrategy`; this class exists so
+ * `DriverEnum.SPATIE` resolves to a distinct identity at the DI layer
+ * even though the parsing logic is shared with the plain Laravel driver.
+ *
  * @see https://spatie.be/docs/laravel-query-builder
  */
-declare class SpatieResponseStrategy implements IResponseStrategy {
-    /**
-     * Parse a flat Laravel pagination response into a PaginatedCollection
-     *
-     * @param response - The raw API response object
-     * @param options - The response key name configuration
-     * @returns A typed PaginatedCollection instance
-     */
-    paginate<T extends IPaginatedObject>(response: Record<string, any>, options: ResponseOptions): PaginatedCollection<T>;
+declare class SpatieResponseStrategy extends AbstractFlatResponseStrategy {
 }
 
 /**