@raphiniert/ra-data-postgrest 1.2.1 → 2.0.0-alpha.1

package/CHANGELOG.md

@@ -2,99 +2,163 @@
 
 Find all notable changes of this project in this file.
 
+## v2.0.0-alpha.1 - 2023-04-09
+### 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
 - small fix in condition
 - fixed package name
 
+## v2.0.0-alpha.0 - 2022-11-23
+
+-   [#42](https://github.com/raphiniert-com/ra-data-postgrest/issues/42), started adding some unit tests - @[christiaanwesterbeek](https://github.com/christiaanwesterbeek)
+-   dropped authProvider
+-   code cleanup & restructuring
+-   minor bugfixes - @[christiaanwesterbeek](https://github.com/christiaanwesterbeek)
+-   added some notes to README.md
+
+### Breaking changes
+
+-   dropped authProvider as this should rather be an own package in case of a generic piece of software or application specific.
+
 ## v1.2.0 - 2022-08-23
-- [#33](https://github.com/raphiniert-com/ra-data-postgrest/pull/33), adding dependabot - @[promitheus7](https://github.com/promitheus7)
-- [#30](https://github.com/raphiniert-com/ra-data-postgrest/pull/30) and [#33](https://github.com/raphiniert-com/ra-data-postgrest/pull/33), updated dependency to compatible starting from `ra-core` 4.1.x - @[corrideat](https://github.com/corrideat), @[promitheus7](https://github.com/promitheus7)
+
+-   [#33](https://github.com/raphiniert-com/ra-data-postgrest/pull/33), adding dependabot - @[promitheus7](https://github.com/promitheus7)
+-   [#30](https://github.com/raphiniert-com/ra-data-postgrest/pull/30) and [#33](https://github.com/raphiniert-com/ra-data-postgrest/pull/33), updated dependency to compatible starting from `ra-core` 4.1.x - @[corrideat](https://github.com/corrideat), @[promitheus7](https://github.com/promitheus7)
 
 ## v1.1.9 - 2022-08-23
-- [#30](https://github.com/raphiniert-com/ra-data-postgrest/pull/30), updated ts and modified code, such that some package dependencies became unrequired - @[corrideat](https://github.com/corrideat)
+
+-   [#30](https://github.com/raphiniert-com/ra-data-postgrest/pull/30), updated ts and modified code, such that some package dependencies became unrequired - @[corrideat](https://github.com/corrideat)
 
 ## v1.1.8 - 2022-01-07
-- required re-release as I missed to transpile all and upload the features of 1.1.7 to npm.
+
+-   required re-release as I missed to transpile all and upload the features of 1.1.7 to npm.
 
 ## v1.1.7 - 2022-01-07
+
 ### Fixes
-- fixed bad behaivor with compound keys while using field named `id` [issue #27](https://github.com/raphiniert-com/ra-data-postgrest/issues/27) and [issue #19](https://github.com/raphiniert-com/ra-data-postgrest/pull/19) - @[kenfehling](https://github.com/kenfehling)
+
+-   fixed bad behaivor with compound keys while using field named `id` [issue #27](https://github.com/raphiniert-com/ra-data-postgrest/issues/27) and [issue #19](https://github.com/raphiniert-com/ra-data-postgrest/pull/19) - @[kenfehling](https://github.com/kenfehling)
 
 ### New feature
-- [#26](https://github.com/raphiniert-com/ra-data-postgrest/pull/26), added rpc filter support, which is explained [here](https://github.com/raphiniert-com/ra-data-postgrest#special-filter-feature-rpc-functions) - @[TheRealAstroboy](https://github.com/TheRealAstroboy)
 
+-   [#26](https://github.com/raphiniert-com/ra-data-postgrest/pull/26), added rpc filter support, which is explained [here](https://github.com/raphiniert-com/ra-data-postgrest#special-filter-feature-rpc-functions) - @[TheRealAstroboy](https://github.com/TheRealAstroboy)
 
 ## v1.1.6 - 2021-01-16
+
 ### Fixes
-- [#24](https://github.com/raphiniert-com/ra-data-postgrest/pull/24), fixed eq. prefix for non-compound keys [issue #23](https://github.com/raphiniert-com/ra-data-postgrest/issues/23) - @[andymed-jlp](https://github.com/andymed-jlp)
+
+-   [#24](https://github.com/raphiniert-com/ra-data-postgrest/pull/24), fixed eq. prefix for non-compound keys [issue #23](https://github.com/raphiniert-com/ra-data-postgrest/issues/23) - @[andymed-jlp](https://github.com/andymed-jlp)
 
 ## v1.1.5 - 2021-01-16
+
 ### Fixes
-- fixed query string generation of rpc endpoints [issue #22](https://github.com/raphiniert-com/ra-data-postgrest/issues/22)
+
+-   fixed query string generation of rpc endpoints [issue #22](https://github.com/raphiniert-com/ra-data-postgrest/issues/22)
 
 ### Breaking changes
-- Support was dropped for generating the query string given many ids in case of an rpc endpoint. If your application has some psql functions which parse the standard input, I recommend to rework your db design. If this change causes strong damage to your application, please contact me in order to find a proper generic solution. Query strings of single rpc calls now drop the operator (`eq.`) and are generated properly.
+
+-   Support was dropped for generating the query string given many ids in case of an rpc endpoint. If your application has some psql functions which parse the standard input, I recommend to rework your db design. If this change causes strong damage to your application, please contact me in order to find a proper generic solution. Query strings of single rpc calls now drop the operator (`eq.`) and are generated properly.
 
 ## v1.1.4 - 2021-01-16
-- deployment error
+
+-   deployment error
 
 ## v1.1.3 - 2020-11-30
+
 ### Fixes
-- [#20](https://github.com/raphiniert-com/ra-data-postgrest/pull/20), fixed small bug in update - @[mkkane](https://github.com/mkkane)
-- removed console log
+
+-   [#20](https://github.com/raphiniert-com/ra-data-postgrest/pull/20), fixed small bug in update - @[mkkane](https://github.com/mkkane)
+-   removed console log
 
 ## v1.1.2 - 2020-10-05
+
 ### Fixes
-- fixed the last fix of getMany and getManyReferecnce for compound keys :)
+
+-   fixed the last fix of getMany and getManyReferecnce for compound keys :)
 
 ## v1.1.1 - 2020-09-28
+
 ### Fixes
-- fixed getMany and getManyReferecnce for compound keys
+
+-   fixed getMany and getManyReferecnce for compound keys
 
 ## v1.1.0 - 2020-09-16
+
 ### Fixes
-- removed requirement to define order key in react admin, when using compound keys: default was `id`, now it's the compound key
+
+-   removed requirement to define order key in react admin, when using compound keys: default was `id`, now it's the compound key
 
 ### Breaking changes
-- refactored compound primary keys:
-  For single custom keys wrap an array as follows:
-  ```jsx
-  const dataProvider = postgrestRestProvider(API_URL, fetchUtils.fetchJson, 'eq', new Map([
-    ['some_table',    ['custom_id']], // <- instead of ['some_table','custom_id']
-    ['another_table', ['first_column', 'second_column']],
-  ]));
-  ```
+
+-   refactored compound primary keys:
+    For single custom keys wrap an array as follows:
+    ```jsx
+    const dataProvider = postgrestRestProvider(
+        API_URL,
+        fetchUtils.fetchJson,
+        'eq',
+        new Map([
+            ['some_table', ['custom_id']], // <- instead of ['some_table','custom_id']
+            ['another_table', ['first_column', 'second_column']],
+        ])
+    );
+    ```
 
 ## v1.0.7 - 2020-08-23
+
 ### New feature
-- [#14](https://github.com/raphiniert-com/ra-data-postgrest/pull/14), added compound primary keys (see [README.md](https://github.com/raphiniert-com/ra-data-postgrest/blob/master/README.md#compound-primary-keys)) - @[programmarchy](https://github.com/programmarchy)
+
+-   [#14](https://github.com/raphiniert-com/ra-data-postgrest/pull/14), added compound primary keys (see [README.md](https://github.com/raphiniert-com/ra-data-postgrest/blob/master/README.md#compound-primary-keys)) - @[programmarchy](https://github.com/programmarchy)
 
 ### Maintenance
-- `import React from 'react';` -> `import * as React from 'react';`
-- Some minor code cleanup
+
+-   `import React from 'react';` -> `import * as React from 'react';`
+-   Some minor code cleanup
 
 ## v1.0.6 - 2020-06-15
+
 ### Fixes
-- Fixed wrong support statement concerning [postgrest starter kit](https://github.com/subzerocloud/postgrest-starter-kit) in readme
+
+-   Fixed wrong support statement concerning [postgrest starter kit](https://github.com/subzerocloud/postgrest-starter-kit) in readme
 
 ## v1.0.5 - 2020-06-15
+
 ### Fixes
-- [#13](https://github.com/raphiniert-com/ra-data-postgrest/pull/13), Remove console.log - @[jpagex](https://github.com/jpagex)
-- [#12](https://github.com/raphiniert-com/ra-data-postgrest/pull/12), Fixed limit parameter - @[jpagex](https://github.com/jpagex)
+
+-   [#13](https://github.com/raphiniert-com/ra-data-postgrest/pull/13), Remove console.log - @[jpagex](https://github.com/jpagex)
+-   [#12](https://github.com/raphiniert-com/ra-data-postgrest/pull/12), Fixed limit parameter - @[jpagex](https://github.com/jpagex)
 
 ## v1.0.4 - 2020-06-08
+
 ### Fixes
-- Fixed missing js files in npm package [#8](https://github.com/raphiniert-com/ra-data-postgrest/issues/8)
-- [#9](https://github.com/raphiniert-com/ra-data-postgrest/pull/9), Fixed typo in readme - @[seclace](https://github.com/seclace)
+
+-   Fixed missing js files in npm package [#8](https://github.com/raphiniert-com/ra-data-postgrest/issues/8)
+-   [#9](https://github.com/raphiniert-com/ra-data-postgrest/pull/9), Fixed typo in readme - @[seclace](https://github.com/seclace)
 
 ## v1.0.3 - 2020-05-17
+
 ### Fixes
-- Fixed bug when multidelete - @[colonist4096](https://github.com/colonist4096)
-- [#5](https://github.com/raphiniert-com/ra-data-postgrest/pull/6), Fixed bug while using multiple filters on the same attribute - @[olivierdalang](https://github.com/olivierdalang)
+
+-   Fixed bug when multidelete - @[colonist4096](https://github.com/colonist4096)
+-   [#5](https://github.com/raphiniert-com/ra-data-postgrest/pull/6), Fixed bug while using multiple filters on the same attribute - @[olivierdalang](https://github.com/olivierdalang)
 
 ## v1.0.2 - 2020-03-10
+
 ### Fixes
-- [#4](https://github.com/raphiniert-com/ra-data-postgrest/pull/4), Fixed bug while using ReferenceField with UUID - @[xero88](https://github.com/xero88)
+
+-   [#4](https://github.com/raphiniert-com/ra-data-postgrest/pull/4), Fixed bug while using ReferenceField with UUID - @[xero88](https://github.com/xero88)
 
 ## v1.0.1 - 2020-02-01
-- initial release
+
+-   initial release

package/README.md

@@ -1,4 +1,9 @@
 # PostgREST Data Provider For React-Admin
+[![npm](https://img.shields.io/npm/v/@raphiniert/ra-data-postgrest.svg)](https://www.npmjs.com/package/@raphiniert/ra-data-postgrest)
+[![npm downloads](https://img.shields.io/npm/dm/@raphiniert/ra-data-postgrest.svg)](https://www.npmjs.com/package/@raphiniert/ra-data-postgrest)
+[![Coverage Status](https://coveralls.io/repos/github/raphiniert-com/ra-data-postgrest/badge.svg?branch=master)](https://coveralls.io/github/raphiniert-com/ra-data-postgrest?branch=master)
+[![License: MIT](https://img.shields.io/gitlab/license/24181795)](https://github.com/raphiniert-com/ra-data-postgrest/blob/master/LICENSE)
+
 
 PostgREST Data Provider for [react-admin](https://github.com/marmelab/react-admin), the frontend framework for building admin applications on top of REST/GraphQL services.
 
@@ -14,17 +19,17 @@ npm install --save @raphiniert/ra-data-postgrest
 
 This Data Provider fits REST APIs using simple GET parameters for filters and sorting. This is the dialect used for instance in [PostgREST](http://postgrest.org).
 
-| Method             | API calls
-|--------------------|----------------------------------------------------------------
-| `getList`          | `GET http://my.api.url/posts?order=title.asc&offset=0&limit=24&filterField=eq.value`
-| `getOne`           | `GET http://my.api.url/posts?id=eq.123`
-| `getMany`          | `GET http://my.api.url/posts?id=in.(123,456,789)`
-| `getManyReference` | `GET http://my.api.url/posts?author_id=eq.345`
-| `create`           | `POST http://my.api.url/posts`
-| `update`           | `PATCH http://my.api.url/posts?id=eq.123`
-| `updateMany`       | `PATCH http://my.api.url/posts?id=in.(123,456,789)`
-| `delete`           | `DELETE http://my.api.url/posts?id=eq.123`
-| `deleteMany`       | `DELETE http://my.api.url/posts?id=in.(123,456,789)`
+| Method             | API calls                                                                            |
+| ------------------ | ------------------------------------------------------------------------------------ |
+| `getList`          | `GET http://my.api.url/posts?order=title.asc&offset=0&limit=24&filterField=eq.value` |
+| `getOne`           | `GET http://my.api.url/posts?id=eq.123`                                              |
+| `getMany`          | `GET http://my.api.url/posts?id=in.(123,456,789)`                                    |
+| `getManyReference` | `GET http://my.api.url/posts?author_id=eq.345`                                       |
+| `create`           | `POST http://my.api.url/posts`                                                       |
+| `update`           | `PATCH http://my.api.url/posts?id=eq.123`                                            |
+| `updateMany`       | `PATCH http://my.api.url/posts?id=in.(123,456,789)`                                  |
+| `delete`           | `DELETE http://my.api.url/posts?id=eq.123`                                           |
+| `deleteMany`       | `DELETE http://my.api.url/posts?id=in.(123,456,789)`                                 |
 
 **Note**: The PostgREST data provider expects the API to include a `Content-Range` header in the response to `getList` calls. The value must be the total number of resources in the collection. This allows react-admin to know how many pages of resources there are in total, and build the pagination controls.
 
@@ -61,7 +66,7 @@ export default App;
 
 The provider function accepts an HTTP client function as second argument. By default, they use react-admin's `fetchUtils.fetchJson()` as HTTP client. It's similar to HTML5 `fetch()`, except it handles JSON decoding and HTTP error codes automatically.
 
-That means that if you need to add custom headers to your requests, you just need to *wrap* the `fetchJson()` call inside your own function:
+That means that if you need to add custom headers to your requests, you just need to _wrap_ the `fetchJson()` call inside your own function:
 
 ```jsx
 import { fetchUtils, Admin, Resource } from 'react-admin';
@@ -79,7 +84,7 @@ const dataProvider = postgrestRestProvider('http://localhost:3000', httpClient);
 
 render(
     <Admin dataProvider={dataProvider} title="Example Admin">
-       ...
+        ...
     </Admin>,
     document.getElementById('root')
 );
@@ -93,7 +98,7 @@ Now all the requests to the REST API will contain the `X-Custom-Header: foobar`
 const httpClient = (url, options = {}) => {
     options.user = {
         authenticated: true,
-        token: 'SRTRDFVESGNJYTUKTYTHRG'
+        token: 'SRTRDFVESGNJYTUKTYTHRG',
     };
     return fetchUtils.fetchJson(url, options);
 };
@@ -101,62 +106,94 @@ const httpClient = (url, options = {}) => {
 
 Now all the requests to the REST API will contain the `Authorization: SRTRDFVESGNJYTUKTYTHRG` header.
 
-### Using authProvider
-This package also comes with an [authProvider](https://github.com/marmelab/react-admin/blob/master/docs/Authentication.md) for react-admin which enables you to enable authentification. The provider is designed to work together with [subzero-starter-kit](https://github.com/subzerocloud/subzero-starter-kit). This starter kit sends the JWT within a session cookie. The authProvider expects that. If you want to use postgREST without the starter kit you'll need to write your own. Feel free to contribute!
-
-With one of the starter kits it is very easy to use the authProvider:
-```jsx
-// in src/App.js
-import React from 'react';
-import { Admin, Resource } from 'react-admin';
-import postgrestRestProvider, { authProvider } from '@raphiniert/ra-data-postgrest';
-
-import { PostList } from './posts';
-
-const App = () => (
-    <Admin dataProvider={postgrestRestProvider('http://path.to.my.api/')} 
-           authProvider={authProvider}>
-        <Resource name="posts" list={PostList} />
-    </Admin>
-);
-
-export default App;
-```
-
 ### Special Filter Feature
-As postgRest allows several comparators, e.g. `ilike`, `like`, `eq`... 
+
+As postgRest allows several comparators, e.g. `ilike`, `like`, `eq`...
 The dataProvider is designed to enable you to specify the comparator in your react filter component:
 
 ```jsx
 <Filter {...props}>
-  <TextInput label="Search" source="post_title@ilike" alwaysOn />
-  <TextInput label="Search" source="post_author" alwaysOn />
-  // some more filters
+    <TextInput label="Search" source="post_title@ilike" alwaysOn />
+    <TextInput label="Search" source="post_author" alwaysOn />
+    // some more filters
 </Filter>
 ```
 
 One can simply append the comparator with an `@` to the source. In this example the field `post_title` would be filtered with `ilike` whereas `post_author` would be filtered using `eq` which is the default if no special comparator is specified.
 
 #### RPC Functions
-Given a RPC call as ```GET /rpc/add_them?post_author=Herbert HTTP/1.1```, the dataProvider allows you to filter such endpoints. As they are no view, but a SQL procedure, several postgREST features do not apply. I.e. no comparators such as `ilike`, `like`, `eq` are applicable. Only the raw value without comparator needs to be send to the API. In order to realize this behavior, just add an "empty" comparator to the field, i.e. end `source` with an `@` as in the example:
+
+Given a RPC call as `GET /rpc/add_them?post_author=Herbert HTTP/1.1`, the dataProvider allows you to filter such endpoints. As they are no view, but a SQL procedure, several postgREST features do not apply. I.e. no comparators such as `ilike`, `like`, `eq` are applicable. Only the raw value without comparator needs to be send to the API. In order to realize this behavior, just add an "empty" comparator to the field, i.e. end `source` with an `@` as in the example:
 
 ```jsx
 <Filter {...props}>
-  <TextInput label="Search" source="post_author@" alwaysOn />
-  // some more filters
+    <TextInput label="Search" source="post_author@" alwaysOn />
+    // some more filters
 </Filter>
 ```
 
 ### Compound primary keys
+
 If one has data resources without primary keys named `id`, one will have to define this specifically. Also, if there is a primary key, which is defined over multiple columns:
 
 ```jsx
-const dataProvider = postgrestRestProvider(API_URL, fetchUtils.fetchJson, 'eq', new Map([
-  ['some_table',    ['custom_id']],
-  ['another_table', ['first_column', 'second_column']],
-]));
+const dataProvider = postgrestRestProvider(
+    API_URL,
+    fetchUtils.fetchJson,
+    'eq',
+    new Map([
+        ['some_table', ['custom_id']],
+        ['another_table', ['first_column', 'second_column']],
+    ])
+);
 ```
 
+### 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.
+
 ## License
 
 This data provider is licensed under the MIT License and sponsored by [raphiniert.com](https://raphiniert.com).

package/esm/index.d.ts

@@ -1,4 +1,9 @@
-import dataProvider from './dataProvider';
-import authProvider from './authProvider';
-export { authProvider };
-export default dataProvider;
+import { fetchUtils, DataProvider } from 'ra-core';
+import { PrimaryKey, PostgRestOperator } from './urlBuilder';
+declare const _default: (apiUrl: string, httpClient?: (url: any, options?: fetchUtils.Options) => Promise<{
+    status: number;
+    headers: Headers;
+    body: string;
+    json: any;
+}>, defaultListOp?: PostgRestOperator, primaryKeys?: Map<string, PrimaryKey>) => DataProvider;
+export default _default;