@raphiniert/ra-data-postgrest 2.3.0 → 2.4.0

package/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 Find all notable changes of this project in this file.
 
+## v2.4.0 - 2024-09-04
+### Fixes
+- [#166](https://github.com/raphiniert-com/ra-data-postgrest/pull/166) Fix update fails when nothing is changed @[fzaninotto](https://github.com/fzaninotto)
+- [#165](https://github.com/raphiniert-com/ra-data-postgrest/pull/165) Fix getMany fails when called with an empty array of ids @[fzaninotto](https://github.com/fzaninotto)
+
+### Improvements
+- [#164](https://github.com/raphiniert-com/ra-data-postgrest/pull/164) Add nullslast and nullsfirst support to getList @[fzaninotto](https://github.com/fzaninotto)
+- updated dependencies
+- updated README.md: added section "Citation"
+
 ## 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)

package/README.md

@@ -15,6 +15,22 @@ 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.
 
+## Citation
+If you use the PostgREST Data Provider in your research or project, please consider citing the (our paper)[https://www.sciencedirect.com/science/article/pii/S2665963824000873]. Feel free to include the following BibTeX entry in your publications:
+```bibtex
+@article{SCHEIBLE2024100699,
+    title = {PostgREST Data Provider for React-Admin: Bootstrap the creation of user interfaces on top of PostgreSQL databases},
+    journal = {Software Impacts},
+    volume = {21},
+    pages = {100699},
+    year = {2024},
+    issn = {2665-9638},
+    doi = {https://doi.org/10.1016/j.simpa.2024.100699},
+    author = {Raphael Scheible}
+}
+```
+
+
 ## 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).
@@ -195,9 +211,12 @@ const [create, { isLoading, error }] = useCreate(
 ```
 
 ### 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
+import { PostgRestSortOrder, IDataProviderConfig } from '@raphiniert/ra-data-postgrest';
+
 const config: IDataProviderConfig = {
     ...
     sortOrder: PostgRestSortOrder.AscendingNullsLastDescendingNullsLast
@@ -207,8 +226,23 @@ const config: IDataProviderConfig = {
 const dataProvider = postgrestRestProvider(config);
 ```
 
+This parameter impacts the `getList` and `getManyReference` calls.
+
 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.
 
+You can also override this parameter on a per-query basis by passing `nullsfirst: true` or `nullslast: true` in the `meta` object of the query:
+
+```jsx
+const { data, total, isLoading, error } = useGetList(
+    'posts',
+    {
+        pagination: { page: 1, perPage: 10 },
+        sort: { field: 'published_at', order: 'DESC' },
+        meta: { nullslast: true }
+    }
+);
+```
+
 ### 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:
 

package/esm/index.d.ts

@@ -49,6 +49,7 @@ import { PrimaryKey, PostgRestOperator, PostgRestSortOrder } from './urlBuilder'
 export type MetaOption = string | undefined;
 export declare const defaultPrimaryKeys: Map<string, PrimaryKey>;
 export declare const defaultSchema: () => string;
+export { PostgRestSortOrder };
 export interface IDataProviderConfig {
     apiUrl: string;
     httpClient: (string: any, Options: any) => Promise<any>;

package/esm/index.js

@@ -37,23 +37,42 @@ var useCustomSchema = function (schema, metaSchema, method) {
 };
 export default (function (config) { return ({
     getList: function (resource, params) {
-        var _a, _b;
+        var _a, _b, _c, _d, _e, _f;
         if (params === void 0) { params = {}; }
         var primaryKey = getPrimaryKey(resource, config.primaryKeys);
-        var _c = params.pagination, page = _c.page, perPage = _c.perPage;
-        var _d = params.sort || {}, field = _d.field, order = _d.order;
-        var _e = parseFilters(params, config.defaultListOp), filter = _e.filter, select = _e.select;
+        var _g = params.pagination, page = _g.page, perPage = _g.perPage;
+        var _h = params.sort || {}, field = _h.field, order = _h.order;
+        var _j = parseFilters(params, config.defaultListOp), filter = _j.filter, select = _j.select;
         var metaSchema = (_a = params.meta) === null || _a === void 0 ? void 0 : _a.schema;
         var query = __assign({ offset: String((page - 1) * perPage), limit: String(perPage) }, filter);
         if (field) {
-            query.order = getOrderBy(field, order, primaryKey);
+            query.order = getOrderBy(field, order, primaryKey, config.sortOrder);
+            if (((_b = params.meta) === null || _b === void 0 ? void 0 : _b.nullsfirst) &&
+                !query.order.includes('nullsfirst')) {
+                query.order = query.order.includes('nullslast')
+                    ? query.order.replace('nullslast', 'nullsfirst')
+                    : "".concat(query.order, ".nullsfirst");
+            }
+            if (((_c = params.meta) === null || _c === void 0 ? void 0 : _c.nullsfirst) === false &&
+                query.order.includes('nullsfirst')) {
+                query.order = query.order.replace('.nullsfirst', '');
+            }
+            if (((_d = params.meta) === null || _d === void 0 ? void 0 : _d.nullslast) && !query.order.includes('nullslast')) {
+                query.order = query.order.includes('nullsfirst')
+                    ? query.order.replace('nullsfirst', 'nullslast')
+                    : "".concat(query.order, ".nullslast");
+            }
+            if (((_e = params.meta) === null || _e === void 0 ? void 0 : _e.nullslast) === false &&
+                query.order.includes('nullslast')) {
+                query.order = query.order.replace('.nullslast', '');
+            }
         }
         if (select) {
             query.select = select;
         }
         // add header that Content-Range is in returned header
         var options = {
-            headers: new Headers(__assign(__assign({ Accept: 'application/json', Prefer: 'count=exact' }, (((_b = params.meta) === null || _b === void 0 ? void 0 : _b.headers) || {})), useCustomSchema(config.schema, metaSchema, 'GET'))),
+            headers: new Headers(__assign(__assign({ Accept: 'application/json', Prefer: 'count=exact' }, (((_f = params.meta) === null || _f === void 0 ? void 0 : _f.headers) || {})), useCustomSchema(config.schema, metaSchema, 'GET'))),
         };
         var url = "".concat(config.apiUrl, "/").concat(resource, "?").concat(qs.stringify(query));
         return config.httpClient(url, options).then(function (_a) {
@@ -90,6 +109,9 @@ export default (function (config) { return ({
         var _a;
         if (params === void 0) { params = {}; }
         var ids = params.ids;
+        if (ids.length === 0) {
+            return Promise.resolve({ data: [] });
+        }
         var primaryKey = getPrimaryKey(resource, config.primaryKeys);
         var query = getQuery(primaryKey, ids, resource, params.meta);
         var url = "".concat(config.apiUrl, "/").concat(resource, "?").concat(qs.stringify(query));
@@ -143,6 +165,9 @@ export default (function (config) { return ({
         var query = getQuery(primaryKey, id, resource, meta);
         var url = "".concat(config.apiUrl, "/").concat(resource, "?").concat(qs.stringify(query));
         var changedData = getChanges(data, previousData);
+        if (Object.keys(changedData).length === 0) {
+            return Promise.resolve({ data: __assign({}, previousData) });
+        }
         var metaSchema = (_a = params.meta) === null || _a === void 0 ? void 0 : _a.schema;
         var body = JSON.stringify(__assign({}, dataWithoutVirtualId(removePrimaryKey(changedData, primaryKey), primaryKey)));
         return config

package/esm/urlBuilder.d.ts

@@ -18,7 +18,7 @@ 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 enum PostgRestSortOrder {
+export declare const enum PostgRestSortOrder {
     AscendingNullsLastDescendingNullsFirst = "asc,desc",
     AscendingNullsLastDescendingNullsLast = "asc,desc.nullslast",
     AscendingNullsFirstDescendingNullsFirst = "asc.nullsfirst,desc",

package/esm/urlBuilder.js

@@ -157,7 +157,7 @@ export var parseFilters = function (params, defaultListOp) {
     return result;
 };
 export var getPrimaryKey = function (resource, primaryKeys) {
-    return primaryKeys.get(resource) || ['id'];
+    return (primaryKeys && primaryKeys.get(resource)) || ['id'];
 };
 export var decodeId = function (id, primaryKey) {
     if (isCompoundKey(primaryKey)) {
@@ -258,15 +258,8 @@ export var getQuery = function (primaryKey, ids, resource, meta) {
     }
     return result;
 };
-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; }
+    if (sortOrder === void 0) { sortOrder = "asc,desc" /* PostgRestSortOrder.AscendingNullsLastDescendingNullsFirst */; }
     var postgRestOrder = sortOrder.split(',')[order === 'ASC' ? 0 : 1];
     if (field == 'id') {
         return primaryKey.map(function (key) { return "".concat(key, ".").concat(postgRestOrder); }).join(',');

package/lib/index.d.ts

@@ -49,6 +49,7 @@ import { PrimaryKey, PostgRestOperator, PostgRestSortOrder } from './urlBuilder'
 export type MetaOption = string | undefined;
 export declare const defaultPrimaryKeys: Map<string, PrimaryKey>;
 export declare const defaultSchema: () => string;
+export { PostgRestSortOrder };
 export interface IDataProviderConfig {
     apiUrl: string;
     httpClient: (string: any, Options: any) => Promise<any>;

package/lib/index.js

@@ -44,23 +44,42 @@ var useCustomSchema = function (schema, metaSchema, method) {
 };
 exports.default = (function (config) { return ({
     getList: function (resource, params) {
-        var _a, _b;
+        var _a, _b, _c, _d, _e, _f;
         if (params === void 0) { params = {}; }
         var primaryKey = (0, urlBuilder_1.getPrimaryKey)(resource, config.primaryKeys);
-        var _c = params.pagination, page = _c.page, perPage = _c.perPage;
-        var _d = params.sort || {}, field = _d.field, order = _d.order;
-        var _e = (0, urlBuilder_1.parseFilters)(params, config.defaultListOp), filter = _e.filter, select = _e.select;
+        var _g = params.pagination, page = _g.page, perPage = _g.perPage;
+        var _h = params.sort || {}, field = _h.field, order = _h.order;
+        var _j = (0, urlBuilder_1.parseFilters)(params, config.defaultListOp), filter = _j.filter, select = _j.select;
         var metaSchema = (_a = params.meta) === null || _a === void 0 ? void 0 : _a.schema;
         var query = __assign({ offset: String((page - 1) * perPage), limit: String(perPage) }, filter);
         if (field) {
-            query.order = (0, urlBuilder_1.getOrderBy)(field, order, primaryKey);
+            query.order = (0, urlBuilder_1.getOrderBy)(field, order, primaryKey, config.sortOrder);
+            if (((_b = params.meta) === null || _b === void 0 ? void 0 : _b.nullsfirst) &&
+                !query.order.includes('nullsfirst')) {
+                query.order = query.order.includes('nullslast')
+                    ? query.order.replace('nullslast', 'nullsfirst')
+                    : "".concat(query.order, ".nullsfirst");
+            }
+            if (((_c = params.meta) === null || _c === void 0 ? void 0 : _c.nullsfirst) === false &&
+                query.order.includes('nullsfirst')) {
+                query.order = query.order.replace('.nullsfirst', '');
+            }
+            if (((_d = params.meta) === null || _d === void 0 ? void 0 : _d.nullslast) && !query.order.includes('nullslast')) {
+                query.order = query.order.includes('nullsfirst')
+                    ? query.order.replace('nullsfirst', 'nullslast')
+                    : "".concat(query.order, ".nullslast");
+            }
+            if (((_e = params.meta) === null || _e === void 0 ? void 0 : _e.nullslast) === false &&
+                query.order.includes('nullslast')) {
+                query.order = query.order.replace('.nullslast', '');
+            }
         }
         if (select) {
             query.select = select;
         }
         // add header that Content-Range is in returned header
         var options = {
-            headers: new Headers(__assign(__assign({ Accept: 'application/json', Prefer: 'count=exact' }, (((_b = params.meta) === null || _b === void 0 ? void 0 : _b.headers) || {})), useCustomSchema(config.schema, metaSchema, 'GET'))),
+            headers: new Headers(__assign(__assign({ Accept: 'application/json', Prefer: 'count=exact' }, (((_f = params.meta) === null || _f === void 0 ? void 0 : _f.headers) || {})), useCustomSchema(config.schema, metaSchema, 'GET'))),
         };
         var url = "".concat(config.apiUrl, "/").concat(resource, "?").concat(qs_1.default.stringify(query));
         return config.httpClient(url, options).then(function (_a) {
@@ -97,6 +116,9 @@ exports.default = (function (config) { return ({
         var _a;
         if (params === void 0) { params = {}; }
         var ids = params.ids;
+        if (ids.length === 0) {
+            return Promise.resolve({ data: [] });
+        }
         var primaryKey = (0, urlBuilder_1.getPrimaryKey)(resource, config.primaryKeys);
         var query = (0, urlBuilder_1.getQuery)(primaryKey, ids, resource, params.meta);
         var url = "".concat(config.apiUrl, "/").concat(resource, "?").concat(qs_1.default.stringify(query));
@@ -150,6 +172,9 @@ exports.default = (function (config) { return ({
         var query = (0, urlBuilder_1.getQuery)(primaryKey, id, resource, meta);
         var url = "".concat(config.apiUrl, "/").concat(resource, "?").concat(qs_1.default.stringify(query));
         var changedData = getChanges(data, previousData);
+        if (Object.keys(changedData).length === 0) {
+            return Promise.resolve({ data: __assign({}, previousData) });
+        }
         var metaSchema = (_a = params.meta) === null || _a === void 0 ? void 0 : _a.schema;
         var body = JSON.stringify(__assign({}, (0, urlBuilder_1.dataWithoutVirtualId)((0, urlBuilder_1.removePrimaryKey)(changedData, primaryKey), primaryKey)));
         return config

package/lib/urlBuilder.d.ts

@@ -18,7 +18,7 @@ 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 enum PostgRestSortOrder {
+export declare const enum PostgRestSortOrder {
     AscendingNullsLastDescendingNullsFirst = "asc,desc",
     AscendingNullsLastDescendingNullsLast = "asc,desc.nullslast",
     AscendingNullsFirstDescendingNullsFirst = "asc.nullsfirst,desc",

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.PostgRestSortOrder = exports.getQuery = exports.dataWithoutVirtualId = exports.dataWithVirtualId = exports.removePrimaryKey = exports.encodeId = exports.decodeId = exports.getPrimaryKey = exports.parseFilters = void 0;
+exports.getOrderBy = 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)
@@ -161,7 +161,7 @@ var parseFilters = function (params, defaultListOp) {
 };
 exports.parseFilters = parseFilters;
 var getPrimaryKey = function (resource, primaryKeys) {
-    return primaryKeys.get(resource) || ['id'];
+    return (primaryKeys && primaryKeys.get(resource)) || ['id'];
 };
 exports.getPrimaryKey = getPrimaryKey;
 var decodeId = function (id, primaryKey) {
@@ -269,15 +269,8 @@ var getQuery = function (primaryKey, ids, resource, meta) {
     return result;
 };
 exports.getQuery = getQuery;
-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; }
+    if (sortOrder === void 0) { sortOrder = "asc,desc" /* PostgRestSortOrder.AscendingNullsLastDescendingNullsFirst */; }
     var postgRestOrder = sortOrder.split(',')[order === 'ASC' ? 0 : 1];
     if (field == 'id') {
         return primaryKey.map(function (key) { return "".concat(key, ".").concat(postgRestOrder); }).join(',');

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@raphiniert/ra-data-postgrest",
-    "version": "2.3.0",
+    "version": "2.4.0",
     "description": "postgREST data provider for react-admin",
     "main": "lib/index.js",
     "module": "esm/index.js",
@@ -37,12 +37,12 @@
         "install-peers-cli": "^2.2.0",
         "jest": "^29.7.0",
         "prettier": "^3.3.2",
-        "rimraf": "^5.0.7",
+        "rimraf": "^6.0.1",
         "ts-jest": "^29.1.5",
         "typescript": "^5.5.2"
     },
     "peerDependencies": {
-        "ra-core": "^4.1.0 || ^5.0.1"
+        "ra-core": "^3.0.0 || ^4.1.0 || ^5.0.1"
     },
     "dependencies": {
         "lodash.isequal": "^4.5.0",

package/src/index.ts

@@ -79,6 +79,8 @@ export const defaultPrimaryKeys = new Map<string, PrimaryKey>();
 
 export const defaultSchema = () => '';
 
+export { PostgRestSortOrder };
+
 export interface IDataProviderConfig {
     apiUrl: string;
     httpClient: (string, Options) => Promise<any>;
@@ -127,7 +129,37 @@ export default (config: IDataProviderConfig): DataProvider => ({
         };
 
         if (field) {
-            query.order = getOrderBy(field, order, primaryKey);
+            query.order = getOrderBy(
+                field,
+                order,
+                primaryKey,
+                config.sortOrder
+            );
+            if (
+                params.meta?.nullsfirst &&
+                !query.order.includes('nullsfirst')
+            ) {
+                query.order = query.order.includes('nullslast')
+                    ? query.order.replace('nullslast', 'nullsfirst')
+                    : `${query.order}.nullsfirst`;
+            }
+            if (
+                params.meta?.nullsfirst === false &&
+                query.order.includes('nullsfirst')
+            ) {
+                query.order = query.order.replace('.nullsfirst', '');
+            }
+            if (params.meta?.nullslast && !query.order.includes('nullslast')) {
+                query.order = query.order.includes('nullsfirst')
+                    ? query.order.replace('nullsfirst', 'nullslast')
+                    : `${query.order}.nullslast`;
+            }
+            if (
+                params.meta?.nullslast === false &&
+                query.order.includes('nullslast')
+            ) {
+                query.order = query.order.replace('.nullslast', '');
+            }
         }
 
         if (select) {
@@ -188,6 +220,9 @@ export default (config: IDataProviderConfig): DataProvider => ({
 
     getMany: (resource, params: Partial<GetManyParams> = {}) => {
         const ids = params.ids;
+        if (ids.length === 0) {
+            return Promise.resolve({ data: [] });
+        }
         const primaryKey = getPrimaryKey(resource, config.primaryKeys);
 
         const query = getQuery(primaryKey, ids, resource, params.meta);
@@ -273,6 +308,9 @@ export default (config: IDataProviderConfig): DataProvider => ({
         const query = getQuery(primaryKey, id, resource, meta);
         const url = `${config.apiUrl}/${resource}?${qs.stringify(query)}`;
         const changedData = getChanges(data, previousData);
+        if (Object.keys(changedData).length === 0) {
+            return Promise.resolve({ data: { ...previousData } });
+        }
         const metaSchema = params.meta?.schema;
 
         const body = JSON.stringify({

package/src/urlBuilder.ts

@@ -178,7 +178,7 @@ export const getPrimaryKey = (
     resource: string,
     primaryKeys: Map<string, PrimaryKey>
 ) => {
-    return primaryKeys.get(resource) || ['id'];
+    return (primaryKeys && primaryKeys.get(resource)) || ['id'];
 };
 
 export const decodeId = (
@@ -298,7 +298,7 @@ export const getQuery = (
     return result;
 };
 
-export enum PostgRestSortOrder {
+export const enum PostgRestSortOrder {
     AscendingNullsLastDescendingNullsFirst = 'asc,desc',
     AscendingNullsLastDescendingNullsLast = 'asc,desc.nullslast',
     AscendingNullsFirstDescendingNullsFirst = 'asc.nullsfirst,desc',