Merge pull request #74 from raphiniert-com/christiaanwesterbeek-extra…

…-headers-via-meta

Collection of new features of old pull requests

CHANGELOG.md

@@ -3,7 +3,16 @@
 Find all notable changes of this project in this file.
 
 ## unpublished (v2.0.0)
-- package updates
+### Improvements
+- updated dependencies
+- updated `urlBuilder` and integrated URL encoding
+
+### New feature
+- [#48](https://github.com/raphiniert-com/ra-data-postgrest/issues/48) solved by pull request [#55](https://github.com/raphiniert-com/ra-data-postgrest/pull/55), the create method should return the data returned by postgrest and not the posted data - @[christiaanwesterbeek](https://github.com/christiaanwesterbeek)
+- [#39](https://github.com/raphiniert-com/ra-data-postgrest/pull/39), allow passing extra headers via meta for react-admin hooks - @[christiaanwesterbeek](https://github.com/christiaanwesterbeek)
+- [#41](https://github.com/raphiniert-com/ra-data-postgrest/pull/41), allow columns filtering for getList and getManyReference - @[christiaanwesterbeek](https://github.com/christiaanwesterbeek)
+- added support of [#41](https://github.com/raphiniert-com/ra-data-postgrest/pull/41) for other functions, but `create` and `updateMany`
+- [#38](https://github.com/raphiniert-com/ra-data-postgrest/pull/38), Let the sort param in getList be optional - @[christiaanwesterbeek](https://github.com/christiaanwesterbeek)
 
 
 ## v1.2.1 - 2023-04-07

README.md

@@ -148,6 +148,48 @@ const dataProvider = postgrestRestProvider(
 );
 ```
 
+### Passing extra headers via meta
+Postgrest supports calling functions with a single JSON parameter by sending the header Prefer: params=single-object with your request according to its [docs](https://postgrest.org/en/stable/api.html#calling-functions-with-a-single-json-parameter).
+
+Within the data provider one can add any kind of header to the request while calling react-admin hooks, e.g.:
+```
+const [create, { isLoading, error }] = useCreate(
+    'rpc/my-function',
+    {
+        data: { ... },
+        meta: { headers: { Prefer: 'params=single-object' } },
+    }
+);
+```
+
+### Vertical filtering
+Postgrest supports a feature of [Vertical Filtering (Columns)](https://postgrest.org/en/stable/api.html#vertical-filtering-columns). Within the react-admin hooks this feature can be used as in the following example:
+```
+const { data, total, isLoading, error } = useGetList(
+    'posts',
+    { 
+        pagination: { page: 1, perPage: 10 },
+        sort: { field: 'published_at', order: 'DESC' }
+        meta: { columns: ['id', 'title'] }
+    }
+);
+```
+
+Further, one should be able to leverage this feature to rename columns:
+```
+columns: ['id', 'somealias:title']
+```
+, to cast columns:
+```
+columns: ['id::text', 'title']
+```
+and even get bits from a json or jsonb column"
+```
+columns: ['id', 'json_data->>blood_type', 'json_data->phones']
+```
+
+**Note**: not working for `create` and `updateMany`.
+
 ## Developers notes
 
 The current development of this library was done with node v19.10 and npm 8.19.3. In this version the unit tests and the development environment should work.