@raphiniert/ra-data-postgrest 2.1.0 → 2.3.0

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 Find all notable changes of this project in this file.
 
+## v2.3.0 - 2024-06-28
+### Improvements
+- [#142](https://github.com/raphiniert-com/ra-data-postgrest/pull/142) Add support for React Admin v5 @[slax57](https://github.com/slax57)
+- updated dependencies
+
+## v2.2.0 - 2024-06-28
+### Improvements
+- [#123](https://github.com/raphiniert-com/ra-data-postgrest/pull/125) Adding global sort order options @[kav](https://github.com/kav)
+
 ## v2.1.0 - 2024-02-27
 ### Improvements
 - updated dependencies

package/README.md

@@ -1,232 +1,247 @@
-# 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.
-
-## Installation
-
-```sh
-npm install --save @raphiniert/ra-data-postgrest
-```
-
-**NOTE**: When using RA 3.x.x, use the data-provider 1.x.x. For RA >= 4.1.x use the data-provider starting from 1.2.x.
-
-## REST Dialect
-
-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)`                                 |
-
-**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.
-
-```
-Content-Range: posts 0-24/319
-```
-
-If your API is on another domain as the JS code, you'll need to whitelist this header with an `Access-Control-Expose-Headers` [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS) header.
-
-```
-Access-Control-Expose-Headers: Content-Range
-```
-
-## Usage
-
-```jsx
-// in src/App.js
-import * as React from 'react';
-import { Admin, Resource, fetchUtils } from 'react-admin';
-import postgrestRestProvider, 
-     { IDataProviderConfig, 
-       defaultPrimaryKeys, 
-       defaultSchema } from '@raphiniert/ra-data-postgrest';
-
-import { PostList } from './posts';
-
-const config: IDataProviderConfig = {
-    apiUrl: 'http://path.to.my.api/',
-    httpClient: fetchUtils.fetchJson,
-    defaultListOp: 'eq',
-    primaryKeys: defaultPrimaryKeys,
-    schema: defaultSchema
-}
-
-const App = () => (
-    <Admin dataProvider={postgrestRestProvider(config)}>
-        <Resource name="posts" list={PostList} />
-    </Admin>
-);
-
-export default App;
-```
-
-### Adding Custom Headers
-
-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:
-
-```jsx
-import { fetchUtils, Admin, Resource } from 'react-admin';
-import postgrestRestProvider from '@raphiniert/ra-data-postgrest';
-
-const httpClient = (url, options = {}) => {
-    if (!options.headers) {
-        options.headers = new Headers({ Accept: 'application/json' });
-    }
-    // add your own headers here
-    options.headers.set('X-Custom-Header', 'foobar');
-    return fetchUtils.fetchJson(url, options);
-};
-
-const config: IDataProviderConfig = {
-    ...
-    httpClient: httpClient,
-    ...
-}
-
-const dataProvider = postgrestRestProvider(config);
-
-render(
-    <Admin dataProvider={dataProvider} title="Example Admin">
-        ...
-    </Admin>,
-    document.getElementById('root')
-);
-```
-
-Now all the requests to the REST API will contain the `X-Custom-Header: foobar` header.
-
-**Tip**: The most common usage of custom headers is for authentication. `fetchJson` has built-on support for the `Authorization` token header:
-
-```js
-const httpClient = (url, options = {}) => {
-    options.user = {
-        authenticated: true,
-        token: 'SRTRDFVESGNJYTUKTYTHRG',
-    };
-    return fetchUtils.fetchJson(url, options);
-};
-```
-
-Now all the requests to the REST API will contain the `Authorization: SRTRDFVESGNJYTUKTYTHRG` header.
-
-### Special Filter Feature
-
-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
-</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:
-
-```jsx
-<Filter {...props}>
-    <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 config: IDataProviderConfig = {
-    ...
-    primaryKeys: new Map([
-        ['some_table', ['custom_id']],
-        ['another_table', ['first_column', 'second_column']],
-    ]),
-    ...
-}
-
-const dataProvider = postgrestRestProvider(config);
-```
-
-### Custom schema
-PostgREST allows to [select and switch the database schema](https://postgrest.org/en/stable/api.html#switching-schemas) by setting a custom header. Thus, one way to use this function would be adding the custom header as a string while using react-admin hooks within `meta.schema` (compare to next section) or to set it up as function of `() => (string)` while using the data provider just component based. The latter can be done as follows and gives the opportunity to use some central storage (e.g. localStorage) which can be changed at multiple points of the application:
-```jsx
-const config: IDataProviderConfig = {
-    ...
-    schema: () => localStorage.getItem("schema") || "api",
-    ...
-}
-
-const dataProvider = postgrestRestProvider(config);
-```
-
-### 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.:
-
-```jsx
-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:
-
-```jsx
-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:
-```jsx
-columns: ['id', 'somealias:title']
-```
-, to cast columns:
-```jsx
-columns: ['id::text', 'title']
-```
-and even get bits from a json or jsonb column"
-```jsx
-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).
+# 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.
+
+## Installation
+
+```sh
+npm install --save @raphiniert/ra-data-postgrest
+```
+
+**NOTE**: When using RA 3.x.x, use the data-provider 1.x.x. For RA >= 4.1.x use the data-provider starting from 1.2.x.
+
+## REST Dialect
+
+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)`                                 |
+
+**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.
+
+```
+Content-Range: posts 0-24/319
+```
+
+If your API is on another domain as the JS code, you'll need to whitelist this header with an `Access-Control-Expose-Headers` [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS) header.
+
+```
+Access-Control-Expose-Headers: Content-Range
+```
+
+## Usage
+
+```jsx
+// in src/App.js
+import * as React from 'react';
+import { Admin, Resource, fetchUtils } from 'react-admin';
+import postgrestRestProvider,
+     { IDataProviderConfig,
+       defaultPrimaryKeys,
+       defaultSchema } from '@raphiniert/ra-data-postgrest';
+
+import { PostList } from './posts';
+
+const config: IDataProviderConfig = {
+    apiUrl: 'http://path.to.my.api/',
+    httpClient: fetchUtils.fetchJson,
+    defaultListOp: 'eq',
+    primaryKeys: defaultPrimaryKeys,
+    schema: defaultSchema
+}
+
+const App = () => (
+    <Admin dataProvider={postgrestRestProvider(config)}>
+        <Resource name="posts" list={PostList} />
+    </Admin>
+);
+
+export default App;
+```
+
+### Adding Custom Headers
+
+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:
+
+```jsx
+import { fetchUtils, Admin, Resource } from 'react-admin';
+import postgrestRestProvider from '@raphiniert/ra-data-postgrest';
+
+const httpClient = (url, options = {}) => {
+    if (!options.headers) {
+        options.headers = new Headers({ Accept: 'application/json' });
+    }
+    // add your own headers here
+    options.headers.set('X-Custom-Header', 'foobar');
+    return fetchUtils.fetchJson(url, options);
+};
+
+const config: IDataProviderConfig = {
+    ...
+    httpClient: httpClient,
+    ...
+}
+
+const dataProvider = postgrestRestProvider(config);
+
+render(
+    <Admin dataProvider={dataProvider} title="Example Admin">
+        ...
+    </Admin>,
+    document.getElementById('root')
+);
+```
+
+Now all the requests to the REST API will contain the `X-Custom-Header: foobar` header.
+
+**Tip**: The most common usage of custom headers is for authentication. `fetchJson` has built-on support for the `Authorization` token header:
+
+```js
+const httpClient = (url, options = {}) => {
+    options.user = {
+        authenticated: true,
+        token: 'SRTRDFVESGNJYTUKTYTHRG',
+    };
+    return fetchUtils.fetchJson(url, options);
+};
+```
+
+Now all the requests to the REST API will contain the `Authorization: SRTRDFVESGNJYTUKTYTHRG` header.
+
+### Special Filter Feature
+
+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
+</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:
+
+```jsx
+<Filter {...props}>
+    <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 config: IDataProviderConfig = {
+    ...
+    primaryKeys: new Map([
+        ['some_table', ['custom_id']],
+        ['another_table', ['first_column', 'second_column']],
+    ]),
+    ...
+}
+
+const dataProvider = postgrestRestProvider(config);
+```
+
+### Custom schema
+PostgREST allows to [select and switch the database schema](https://postgrest.org/en/stable/api.html#switching-schemas) by setting a custom header. Thus, one way to use this function would be adding the custom header as a string while using react-admin hooks within `meta.schema` (compare to next section) or to set it up as function of `() => (string)` while using the data provider just component based. The latter can be done as follows and gives the opportunity to use some central storage (e.g. localStorage) which can be changed at multiple points of the application:
+```jsx
+const config: IDataProviderConfig = {
+    ...
+    schema: () => localStorage.getItem("schema") || "api",
+    ...
+}
+
+const dataProvider = postgrestRestProvider(config);
+```
+
+### 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.:
+
+```jsx
+const [create, { isLoading, error }] = useCreate(
+    'rpc/my-function',
+    {
+        data: { ... },
+        meta: { headers: { Prefer: 'params=single-object' } },
+    }
+);
+```
+
+### Null sort order
+Postgrest supports specifying the position of nulls in [sort ordering](https://postgrest.org/en/v12/references/api/tables_views.html#ordering). This can be configured via an optional data provider parameter:
+
+```jsx
+const config: IDataProviderConfig = {
+    ...
+    sortOrder: PostgRestSortOrder.AscendingNullsLastDescendingNullsLast
+    ...
+}
+
+const dataProvider = postgrestRestProvider(config);
+```
+
+It is important to note that null positioning in sort will impact index utilization so in some cases you'll want to add  corresponding index on the database side.
+
+### 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:
+
+```jsx
+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:
+```jsx
+columns: ['id', 'somealias:title']
+```
+, to cast columns:
+```jsx
+columns: ['id::text', 'title']
+```
+and even get bits from a json or jsonb column"
+```jsx
+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,5 +1,5 @@
 import { DataProvider } from 'ra-core';
-import { PrimaryKey, PostgRestOperator } from './urlBuilder';
+import { PrimaryKey, PostgRestOperator, PostgRestSortOrder } from './urlBuilder';
 /**
  * Maps react-admin queries to a postgrest REST API
  *
@@ -53,6 +53,7 @@ export interface IDataProviderConfig {
     apiUrl: string;
     httpClient: (string: any, Options: any) => Promise<any>;
     defaultListOp: PostgRestOperator;
+    sortOrder?: PostgRestSortOrder;
     primaryKeys: Map<string, PrimaryKey>;
     schema: () => string;
 }

package/esm/index.js

@@ -115,7 +115,7 @@ export default (function (config) { return ({
         var primaryKey = getPrimaryKey(resource, config.primaryKeys);
         var metaSchema = (_b = params.meta) === null || _b === void 0 ? void 0 : _b.schema;
         var query = params.target
-            ? __assign((_a = {}, _a[params.target] = "eq.".concat(params.id), _a.order = getOrderBy(field, order, primaryKey), _a.offset = String((page - 1) * perPage), _a.limit = String(perPage), _a), filter) : __assign({ order: getOrderBy(field, order, primaryKey), offset: String((page - 1) * perPage), limit: String(perPage) }, filter);
+            ? __assign((_a = {}, _a[params.target] = "eq.".concat(params.id), _a.order = getOrderBy(field, order, primaryKey, config.sortOrder), _a.offset = String((page - 1) * perPage), _a.limit = String(perPage), _a), filter) : __assign({ order: getOrderBy(field, order, primaryKey), offset: String((page - 1) * perPage), limit: String(perPage) }, filter);
         if (select) {
             query.select = select;
         }

package/esm/urlBuilder.d.ts

@@ -18,5 +18,11 @@ export declare const removePrimaryKey: (data: any, primaryKey: PrimaryKey) => an
 export declare const dataWithVirtualId: (data: any, primaryKey: PrimaryKey) => any;
 export declare const dataWithoutVirtualId: (data: any, primaryKey: PrimaryKey) => any;
 export declare const getQuery: (primaryKey: PrimaryKey, ids: Identifier | Array<Identifier> | undefined, resource: string, meta?: any) => any;
-export declare const getOrderBy: (field: string, order: string, primaryKey: PrimaryKey) => string;
+export declare enum PostgRestSortOrder {
+    AscendingNullsLastDescendingNullsFirst = "asc,desc",
+    AscendingNullsLastDescendingNullsLast = "asc,desc.nullslast",
+    AscendingNullsFirstDescendingNullsFirst = "asc.nullsfirst,desc",
+    AscendingNullsFirstDescendingNullsLast = "asc.nullsfirst,desc.nullslast"
+}
+export declare const getOrderBy: (field: string, order: string, primaryKey: PrimaryKey, sortOrder?: PostgRestSortOrder) => string;
 export {};

package/esm/urlBuilder.js

@@ -258,11 +258,20 @@ export var getQuery = function (primaryKey, ids, resource, meta) {
     }
     return result;
 };
-export var getOrderBy = function (field, order, primaryKey) {
+export var PostgRestSortOrder;
+(function (PostgRestSortOrder) {
+    PostgRestSortOrder["AscendingNullsLastDescendingNullsFirst"] = "asc,desc";
+    PostgRestSortOrder["AscendingNullsLastDescendingNullsLast"] = "asc,desc.nullslast";
+    PostgRestSortOrder["AscendingNullsFirstDescendingNullsFirst"] = "asc.nullsfirst,desc";
+    PostgRestSortOrder["AscendingNullsFirstDescendingNullsLast"] = "asc.nullsfirst,desc.nullslast";
+})(PostgRestSortOrder || (PostgRestSortOrder = {}));
+export var getOrderBy = function (field, order, primaryKey, sortOrder) {
+    if (sortOrder === void 0) { sortOrder = PostgRestSortOrder.AscendingNullsLastDescendingNullsFirst; }
+    var postgRestOrder = sortOrder.split(',')[order === 'ASC' ? 0 : 1];
     if (field == 'id') {
-        return primaryKey.map(function (key) { return "".concat(key, ".").concat(order.toLowerCase()); }).join(',');
+        return primaryKey.map(function (key) { return "".concat(key, ".").concat(postgRestOrder); }).join(',');
     }
     else {
-        return "".concat(field, ".").concat(order.toLowerCase());
+        return "".concat(field, ".").concat(postgRestOrder);
     }
 };

package/lib/index.d.ts

@@ -1,5 +1,5 @@
 import { DataProvider } from 'ra-core';
-import { PrimaryKey, PostgRestOperator } from './urlBuilder';
+import { PrimaryKey, PostgRestOperator, PostgRestSortOrder } from './urlBuilder';
 /**
  * Maps react-admin queries to a postgrest REST API
  *
@@ -53,6 +53,7 @@ export interface IDataProviderConfig {
     apiUrl: string;
     httpClient: (string: any, Options: any) => Promise<any>;
     defaultListOp: PostgRestOperator;
+    sortOrder?: PostgRestSortOrder;
     primaryKeys: Map<string, PrimaryKey>;
     schema: () => string;
 }

package/lib/index.js

@@ -122,7 +122,7 @@ exports.default = (function (config) { return ({
         var primaryKey = (0, urlBuilder_1.getPrimaryKey)(resource, config.primaryKeys);
         var metaSchema = (_b = params.meta) === null || _b === void 0 ? void 0 : _b.schema;
         var query = params.target
-            ? __assign((_a = {}, _a[params.target] = "eq.".concat(params.id), _a.order = (0, urlBuilder_1.getOrderBy)(field, order, primaryKey), _a.offset = String((page - 1) * perPage), _a.limit = String(perPage), _a), filter) : __assign({ order: (0, urlBuilder_1.getOrderBy)(field, order, primaryKey), offset: String((page - 1) * perPage), limit: String(perPage) }, filter);
+            ? __assign((_a = {}, _a[params.target] = "eq.".concat(params.id), _a.order = (0, urlBuilder_1.getOrderBy)(field, order, primaryKey, config.sortOrder), _a.offset = String((page - 1) * perPage), _a.limit = String(perPage), _a), filter) : __assign({ order: (0, urlBuilder_1.getOrderBy)(field, order, primaryKey), offset: String((page - 1) * perPage), limit: String(perPage) }, filter);
         if (select) {
             query.select = select;
         }

package/lib/urlBuilder.d.ts

@@ -18,5 +18,11 @@ export declare const removePrimaryKey: (data: any, primaryKey: PrimaryKey) => an
 export declare const dataWithVirtualId: (data: any, primaryKey: PrimaryKey) => any;
 export declare const dataWithoutVirtualId: (data: any, primaryKey: PrimaryKey) => any;
 export declare const getQuery: (primaryKey: PrimaryKey, ids: Identifier | Array<Identifier> | undefined, resource: string, meta?: any) => any;
-export declare const getOrderBy: (field: string, order: string, primaryKey: PrimaryKey) => string;
+export declare enum PostgRestSortOrder {
+    AscendingNullsLastDescendingNullsFirst = "asc,desc",
+    AscendingNullsLastDescendingNullsLast = "asc,desc.nullslast",
+    AscendingNullsFirstDescendingNullsFirst = "asc.nullsfirst,desc",
+    AscendingNullsFirstDescendingNullsLast = "asc.nullsfirst,desc.nullslast"
+}
+export declare const getOrderBy: (field: string, order: string, primaryKey: PrimaryKey, sortOrder?: PostgRestSortOrder) => string;
 export {};

package/lib/urlBuilder.js

@@ -22,7 +22,7 @@ var __rest = (this && this.__rest) || function (s, e) {
     return t;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getOrderBy = exports.getQuery = exports.dataWithoutVirtualId = exports.dataWithVirtualId = exports.removePrimaryKey = exports.encodeId = exports.decodeId = exports.getPrimaryKey = exports.parseFilters = void 0;
+exports.getOrderBy = exports.PostgRestSortOrder = exports.getQuery = exports.dataWithoutVirtualId = exports.dataWithVirtualId = exports.removePrimaryKey = exports.encodeId = exports.decodeId = exports.getPrimaryKey = exports.parseFilters = void 0;
 /**
  * List of all possible operators in PostgRest
  * (https://postgrest.org/en/stable/api.html#operators)
@@ -269,12 +269,21 @@ var getQuery = function (primaryKey, ids, resource, meta) {
     return result;
 };
 exports.getQuery = getQuery;
-var getOrderBy = function (field, order, primaryKey) {
+var PostgRestSortOrder;
+(function (PostgRestSortOrder) {
+    PostgRestSortOrder["AscendingNullsLastDescendingNullsFirst"] = "asc,desc";
+    PostgRestSortOrder["AscendingNullsLastDescendingNullsLast"] = "asc,desc.nullslast";
+    PostgRestSortOrder["AscendingNullsFirstDescendingNullsFirst"] = "asc.nullsfirst,desc";
+    PostgRestSortOrder["AscendingNullsFirstDescendingNullsLast"] = "asc.nullsfirst,desc.nullslast";
+})(PostgRestSortOrder || (exports.PostgRestSortOrder = PostgRestSortOrder = {}));
+var getOrderBy = function (field, order, primaryKey, sortOrder) {
+    if (sortOrder === void 0) { sortOrder = PostgRestSortOrder.AscendingNullsLastDescendingNullsFirst; }
+    var postgRestOrder = sortOrder.split(',')[order === 'ASC' ? 0 : 1];
     if (field == 'id') {
-        return primaryKey.map(function (key) { return "".concat(key, ".").concat(order.toLowerCase()); }).join(',');
+        return primaryKey.map(function (key) { return "".concat(key, ".").concat(postgRestOrder); }).join(',');
     }
     else {
-        return "".concat(field, ".").concat(order.toLowerCase());
+        return "".concat(field, ".").concat(postgRestOrder);
     }
 };
 exports.getOrderBy = getOrderBy;

package/package.json

@@ -1,51 +1,51 @@
-{
-    "name": "@raphiniert/ra-data-postgrest",
-    "version": "2.1.0",
-    "description": "postgREST data provider for react-admin",
-    "main": "lib/index.js",
-    "module": "esm/index.js",
-    "sideEffects": false,
-    "files": [
-        "*.md",
-        "lib",
-        "esm",
-        "src"
-    ],
-    "authors": [
-        "Raphael Scheible"
-    ],
-    "repository": "raphiniert-com/ra-data-postgrest",
-    "homepage": "https://github.com/raphiniert-com/ra-data-postgrest",
-    "bugs": "https://github.com/raphiniert-com/ra-data-postgrest/issues",
-    "license": "MIT",
-    "scripts": {
-        "coverage": "jest --coverage",
-        "test": "jest --watchAll",
-        "build": "npm run build-cjs && npm run build-esm",
-        "build-cjs": "rimraf ./lib && tsc",
-        "build-esm": "rimraf ./esm && tsc --outDir esm --module es2015",
-        "watch": "tsc --outDir esm --module es2015 --watch",
-        "prepare": "install-peers",
-        "prettier": "prettier --config ./.prettierrc.js --write --list-different \"src/**/*.{js,json,ts,tsx,css,md}\""
-    },
-    "devDependencies": {
-        "@types/jest": "^29.5.11",
-        "@types/qs": "^6.9.11",
-        "cross-env": "^7.0.3",
-        "eslint-config-prettier": "^9.1.0",
-        "eslint-plugin-prettier": "^5.0.1",
-        "install-peers-cli": "^2.2.0",
-        "jest": "^29.7.0",
-        "prettier": "^3.1.1",
-        "rimraf": "^5.0.0",
-        "ts-jest": "^29.1.1",
-        "typescript": "^5.3.3"
-    },
-    "peerDependencies": {
-        "ra-core": "^4.1.0"
-    },
-    "dependencies": {
-        "lodash.isequal": "^4.5.0",
-        "qs": "^6.11.1"
-    }
-}
+{
+    "name": "@raphiniert/ra-data-postgrest",
+    "version": "2.3.0",
+    "description": "postgREST data provider for react-admin",
+    "main": "lib/index.js",
+    "module": "esm/index.js",
+    "sideEffects": false,
+    "files": [
+        "*.md",
+        "lib",
+        "esm",
+        "src"
+    ],
+    "authors": [
+        "Raphael Scheible"
+    ],
+    "repository": "raphiniert-com/ra-data-postgrest",
+    "homepage": "https://github.com/raphiniert-com/ra-data-postgrest",
+    "bugs": "https://github.com/raphiniert-com/ra-data-postgrest/issues",
+    "license": "MIT",
+    "scripts": {
+        "coverage": "jest --coverage",
+        "test": "jest --watchAll",
+        "build": "npm run build-cjs && npm run build-esm",
+        "build-cjs": "rimraf ./lib && tsc",
+        "build-esm": "rimraf ./esm && tsc --outDir esm --module es2015",
+        "watch": "tsc --outDir esm --module es2015 --watch",
+        "prepare": "install-peers",
+        "prettier": "prettier --config ./.prettierrc.js --write --list-different \"src/**/*.{js,json,ts,tsx,css,md}\""
+    },
+    "devDependencies": {
+        "@types/jest": "^29.5.12",
+        "@types/qs": "^6.9.15",
+        "cross-env": "^7.0.3",
+        "eslint-config-prettier": "^9.1.0",
+        "eslint-plugin-prettier": "^5.1.3",
+        "install-peers-cli": "^2.2.0",
+        "jest": "^29.7.0",
+        "prettier": "^3.3.2",
+        "rimraf": "^5.0.7",
+        "ts-jest": "^29.1.5",
+        "typescript": "^5.5.2"
+    },
+    "peerDependencies": {
+        "ra-core": "^4.1.0 || ^5.0.1"
+    },
+    "dependencies": {
+        "lodash.isequal": "^4.5.0",
+        "qs": "^6.12.1"
+    }
+}

package/src/index.ts

@@ -21,6 +21,7 @@ import {
     removePrimaryKey,
     getQuery,
     encodeId,
+    PostgRestSortOrder,
 } from './urlBuilder';
 import qs from 'qs';
 import isEqual from 'lodash/isEqual';
@@ -82,6 +83,7 @@ export interface IDataProviderConfig {
     apiUrl: string;
     httpClient: (string, Options) => Promise<any>;
     defaultListOp: PostgRestOperator;
+    sortOrder?: PostgRestSortOrder;
     primaryKeys: Map<string, PrimaryKey>;
     schema: () => string;
 }
@@ -219,7 +221,7 @@ export default (config: IDataProviderConfig): DataProvider => ({
         let query = params.target
             ? {
                   [params.target]: `eq.${params.id}`,
-                  order: getOrderBy(field, order, primaryKey),
+                  order: getOrderBy(field, order, primaryKey, config.sortOrder),
                   offset: String((page - 1) * perPage),
                   limit: String(perPage),
                   ...filter,

package/src/urlBuilder.ts

@@ -298,14 +298,23 @@ export const getQuery = (
     return result;
 };
 
+export enum PostgRestSortOrder {
+    AscendingNullsLastDescendingNullsFirst = 'asc,desc',
+    AscendingNullsLastDescendingNullsLast = 'asc,desc.nullslast',
+    AscendingNullsFirstDescendingNullsFirst = 'asc.nullsfirst,desc',
+    AscendingNullsFirstDescendingNullsLast = 'asc.nullsfirst,desc.nullslast',
+}
+
 export const getOrderBy = (
     field: string,
     order: string,
-    primaryKey: PrimaryKey
+    primaryKey: PrimaryKey,
+    sortOrder: PostgRestSortOrder = PostgRestSortOrder.AscendingNullsLastDescendingNullsFirst
 ) => {
+    const postgRestOrder = sortOrder.split(',')[order === 'ASC' ? 0 : 1];
     if (field == 'id') {
-        return primaryKey.map(key => `${key}.${order.toLowerCase()}`).join(',');
+        return primaryKey.map(key => `${key}.${postgRestOrder}`).join(',');
     } else {
-        return `${field}.${order.toLowerCase()}`;
+        return `${field}.${postgRestOrder}`;
     }
 };