@omnitend/dashboard-for-laravel 0.33.0 → 0.33.1

package/dist/components/extended/DXTable.vue.d.ts

@@ -3,6 +3,25 @@ export interface FilterOption {
     value: string;
     text: string;
 }
+/**
+ * Adapts the built-in `apiUrl` provider's request/response to a backend whose
+ * convention differs from dfl's (spatie query-builder params, an envelope
+ * without the `{data, pagination}` shape). The sanctioned replacement for the
+ * axios-interceptor bridges #132 removed the route for: `request` maps the
+ * outgoing params (its return is what goes on the wire); `response` maps the
+ * body back, receiving the ORIGINAL dfl-shape params (`page`, `perPage`, …)
+ * so it can synthesize paginator metadata a foreign envelope lacks.
+ */
+export interface DXTableApiAdapter {
+    request?: (params: Record<string, any>) => Record<string, any>;
+    response?: (body: any, context: {
+        params: Record<string, any>;
+    }) => {
+        data: any[];
+        pagination?: PaginationData;
+        filterValues?: Record<string, string[]>;
+    };
+}
 export interface TableField {
     key: string;
     label?: string;
@@ -109,6 +128,9 @@ export interface Props<TItem = any> {
     provider?: BTableProvider<TItem>;
     /** API endpoint URL for auto-provider mode (alternative to provider function) */
     apiUrl?: string;
+    /** Adapts the built-in provider's request params / response body to a
+     *  backend convention that differs from dfl's (see DXTableApiAdapter). */
+    apiAdapter?: DXTableApiAdapter;
     /** Table field definitions */
     fields: TableField[];
     /** Sort configuration (v-model support) */