@raphiniert/ra-data-postgrest 2.0.0-alpha.3 → 2.0.0

package/CHANGELOG.md

@@ -2,6 +2,28 @@
 
 Find all notable changes of this project in this file.
 
+## v2.0.0 - 2023-12-29
+### Improvements
+- updated dependencies
+
+### Fixes
+- [#113](https://github.com/raphiniert-com/ra-data-postgrest/pull/113) remove {} value wrapping for cs/cd @[ruslantalpa](https://github.com/ruslantalpa)
+
+### Breaking changes
+- the fix in this version might break old versions, as the {} are removed. Thus, one needs to manually add the {} for cs/cd.
+
+
+## v2.0.0-alpha.4 - 2023-10-23
+### Improvements
+- updated dependencies
+
+### New feature
+- [#100](https://github.com/raphiniert-com/ra-data-postgrest/pull/100) support "meta.columns" on all code paths (useful when the user does not have permissions on all the columns in which case doing select=* gives permissions errors) - @[ruslantalpa](https://github.com/ruslantalpa)
+
+### Fixes
+- [#50](https://github.com/raphiniert-com/ra-data-postgrest/issues/50) and [#88](https://github.com/raphiniert-com/ra-data-postgrest/issues/88) solved by [#100](https://github.com/raphiniert-com/ra-data-postgrest/pull/100) including other fixes - @[ruslantalpa](https://github.com/ruslantalpa)
+
+
 ## v2.0.0-alpha.3 - 2023-06-16
 ### Improvements
 - updated dependencies

package/esm/index.js

@@ -9,7 +9,7 @@ var __assign = (this && this.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
-import { getPrimaryKey, parseFilters, getOrderBy, dataWithId, getQuery, getKeyData, encodeId, decodeId, isCompoundKey, } from './urlBuilder';
+import { getPrimaryKey, parseFilters, getOrderBy, dataWithVirtualId, dataWithoutVirtualId, removePrimaryKey, getQuery, encodeId, } from './urlBuilder';
 import qs from 'qs';
 export var defaultPrimaryKeys = new Map();
 export var defaultSchema = function () { return ''; };
@@ -61,7 +61,7 @@ export default (function (config) { return ({
                 throw new Error("The Content-Range header is missing in the HTTP Response. The postgREST data provider expects \n          responses for lists of resources to contain this header with the total number of results to build \n          the pagination. If you are using CORS, did you declare Content-Range in the Access-Control-Expose-Headers header?");
             }
             return {
-                data: json.map(function (obj) { return dataWithId(obj, primaryKey); }),
+                data: json.map(function (obj) { return dataWithVirtualId(obj, primaryKey); }),
                 total: parseInt(headers.get('content-range').split('/').pop(), 10),
             };
         });
@@ -81,7 +81,7 @@ export default (function (config) { return ({
             .then(function (_a) {
             var json = _a.json;
             return ({
-                data: dataWithId(json, primaryKey),
+                data: dataWithVirtualId(json, primaryKey),
             });
         });
     },
@@ -100,7 +100,7 @@ export default (function (config) { return ({
             .then(function (_a) {
             var json = _a.json;
             return ({
-                data: json.map(function (data) { return dataWithId(data, primaryKey); }),
+                data: json.map(function (data) { return dataWithVirtualId(data, primaryKey); }),
             });
         });
     },
@@ -129,7 +129,7 @@ export default (function (config) { return ({
                 throw new Error("The Content-Range header is missing in the HTTP Response. The postgREST data provider expects \n          responses for lists of resources to contain this header with the total number of results to build \n          the pagination. If you are using CORS, did you declare Content-Range in the Access-Control-Expose-Headers header?");
             }
             return {
-                data: json.map(function (data) { return dataWithId(data, primaryKey); }),
+                data: json.map(function (data) { return dataWithVirtualId(data, primaryKey); }),
                 total: parseInt(headers.get('content-range').split('/').pop(), 10),
             };
         });
@@ -140,10 +140,9 @@ export default (function (config) { return ({
         var id = params.id, data = params.data, meta = params.meta;
         var primaryKey = getPrimaryKey(resource, config.primaryKeys);
         var query = getQuery(primaryKey, id, resource, meta);
-        var primaryKeyData = getKeyData(primaryKey, data);
         var url = "".concat(config.apiUrl, "/").concat(resource, "?").concat(qs.stringify(query));
         var metaSchema = (_a = params.meta) === null || _a === void 0 ? void 0 : _a.schema;
-        var body = JSON.stringify(__assign(__assign({}, data), primaryKeyData));
+        var body = JSON.stringify(__assign({}, dataWithoutVirtualId(removePrimaryKey(data, primaryKey), primaryKey)));
         return config
             .httpClient(url, {
             method: 'PATCH',
@@ -152,29 +151,19 @@ export default (function (config) { return ({
         })
             .then(function (_a) {
             var json = _a.json;
-            return ({ data: dataWithId(json, primaryKey) });
+            return ({
+                data: dataWithVirtualId(json, primaryKey),
+            });
         });
     },
     updateMany: function (resource, params) {
         var _a, _b;
         if (params === void 0) { params = {}; }
-        var ids = params.ids;
+        var ids = params.ids, meta = params.meta, data = params.data;
         var primaryKey = getPrimaryKey(resource, config.primaryKeys);
-        var body = JSON.stringify(params.ids.map(function (id) {
-            var data = params.data;
-            var primaryKeyParams = decodeId(id, primaryKey);
-            var primaryKeyData = {};
-            if (isCompoundKey(primaryKey)) {
-                primaryKey.forEach(function (key, index) {
-                    primaryKeyData[key] = primaryKeyParams[index];
-                });
-            }
-            else {
-                primaryKeyData[primaryKey[0]] = primaryKeyParams[0];
-            }
-            return __assign(__assign({}, data), primaryKeyData);
-        }));
-        var url = "".concat(config.apiUrl, "/").concat(resource);
+        var query = getQuery(primaryKey, ids, resource, meta);
+        var url = "".concat(config.apiUrl, "/").concat(resource, "?").concat(qs.stringify(query));
+        var body = JSON.stringify(__assign({}, dataWithoutVirtualId(removePrimaryKey(data, primaryKey), primaryKey)));
         var metaSchema = (_a = params.meta) === null || _a === void 0 ? void 0 : _a.schema;
         return config
             .httpClient(url, {
@@ -192,14 +181,17 @@ export default (function (config) { return ({
     create: function (resource, params) {
         var _a, _b;
         if (params === void 0) { params = {}; }
+        var meta = params.meta;
         var primaryKey = getPrimaryKey(resource, config.primaryKeys);
-        var url = "".concat(config.apiUrl, "/").concat(resource);
+        var query = getQuery(primaryKey, undefined, resource, meta);
+        var queryStr = qs.stringify(query);
+        var url = "".concat(config.apiUrl, "/").concat(resource).concat(queryStr.length > 0 ? '?' : '').concat(queryStr);
         var metaSchema = (_a = params.meta) === null || _a === void 0 ? void 0 : _a.schema;
         return config
             .httpClient(url, {
             method: 'POST',
             headers: new Headers(__assign(__assign({ Accept: 'application/vnd.pgrst.object+json', Prefer: 'return=representation', 'Content-Type': 'application/json' }, (((_b = params.meta) === null || _b === void 0 ? void 0 : _b.headers) || {})), useCustomSchema(config.schema, metaSchema, 'POST'))),
-            body: JSON.stringify(params.data),
+            body: JSON.stringify(dataWithoutVirtualId(params.data, primaryKey)),
         })
             .then(function (_a) {
             var json = _a.json;
@@ -223,7 +215,9 @@ export default (function (config) { return ({
         })
             .then(function (_a) {
             var json = _a.json;
-            return ({ data: dataWithId(json, primaryKey) });
+            return ({
+                data: dataWithVirtualId(json, primaryKey),
+            });
         });
     },
     deleteMany: function (resource, params) {

package/esm/urlBuilder.d.ts

@@ -14,9 +14,9 @@ export type PrimaryKey = Array<string>;
 export declare const getPrimaryKey: (resource: string, primaryKeys: Map<string, PrimaryKey>) => PrimaryKey;
 export declare const decodeId: (id: Identifier, primaryKey: PrimaryKey) => string[] | number[];
 export declare const encodeId: (data: any, primaryKey: PrimaryKey) => Identifier;
-export declare const dataWithId: (data: any, primaryKey: PrimaryKey) => any;
-export declare const isCompoundKey: (primaryKey: PrimaryKey) => Boolean;
-export declare const getQuery: (primaryKey: PrimaryKey, ids: Identifier | Array<Identifier>, resource: string, meta?: any) => any;
-export declare const getKeyData: (primaryKey: PrimaryKey, data: object) => object;
+export declare const removePrimaryKey: (data: any, primaryKey: PrimaryKey) => any;
+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 {};

package/esm/urlBuilder.js

@@ -9,6 +9,17 @@ var __assign = (this && this.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 /**
  * List of all possible operators in PostgRest
  * (https://postgrest.org/en/stable/api.html#operators)
@@ -42,25 +53,53 @@ var postgrestOperators = [
     'or',
     'and',
 ];
+var isObject = function (obj) {
+    return typeof obj === 'object' && !Array.isArray(obj) && obj !== null;
+};
+var resolveKeys = function (filter, keys) {
+    var result = filter[keys[0]];
+    for (var i = 1; i < keys.length; ++i) {
+        result = result[keys[i]];
+    }
+    return result;
+};
 export var parseFilters = function (params, defaultListOp) {
     var filter = params.filter, _a = params.meta, meta = _a === void 0 ? {} : _a;
     var result = {};
     result.filter = {};
     Object.keys(filter).forEach(function (key) {
         // key: the name of the object key
+        var keyArray = [key];
+        var values;
+        // in case of a nested object selection in a text field
+        // RA returns object{ object } structure which is resolved here
+        // see issue https://github.com/raphiniert-com/ra-data-postgrest/issues/58
+        if (key.split('@')[0] !== '' && isObject(filter[key])) {
+            var innerVal = filter[key];
+            do {
+                var inner = resolveKeys(filter, keyArray);
+                var innerKey = Object.keys(inner)[0];
+                keyArray.push(innerKey);
+                innerVal = inner[innerKey];
+            } while (isObject(innerVal));
+            key = keyArray.join('.');
+            values = [innerVal];
+        }
+        else {
+            values = [filter[key]];
+        }
         var splitKey = key.split('@');
         var operation = splitKey.length == 2
             ? splitKey[1]
             : defaultListOp;
-        var values;
         if (['like', 'ilike'].includes(operation)) {
             // we split the search term in words
-            values = filter[key].trim().split(/\s+/);
+            values = resolveKeys(filter, keyArray).trim().split(/\s+/);
         }
         // CASE: Logical operator
         else if (['or', 'and'].includes(operation)) {
             // we extract each value entries and make it dot separated string.
-            var subFilter = parseFilters({ filter: filter[key] }, defaultListOp).filter;
+            var subFilter = parseFilters({ filter: resolveKeys(filter, keyArray) }, defaultListOp).filter;
             // something like { "age@lt": 18 } and { "age@gt": 21 }
             var filterExpressions_1 = [];
             Object.entries(subFilter).forEach(function (_a) {
@@ -73,9 +112,6 @@ export var parseFilters = function (params, defaultListOp) {
             // finally we flatten all as single string and enclose with bracket.
             values = ["(".concat(filterExpressions_1.join(','), ")")];
         }
-        else {
-            values = [filter[key]];
-        }
         values.forEach(function (value) {
             var op = (function () {
                 // if operator is intentionally blank, rpc syntax
@@ -85,11 +121,9 @@ export var parseFilters = function (params, defaultListOp) {
                     return "".concat(operation, ".*").concat(value, "*");
                 if (['and', 'or'].includes(operation))
                     return "".concat(value);
-                if (['cs', 'cd'].includes(operation))
-                    return "".concat(operation, ".{").concat(value, "}");
                 return "".concat(operation, ".").concat(value);
             })();
-            // If resulting filter haven't contains the fieldname, then add it.
+            // If resulting filter doesn't contain the fieldname, then add it.
             if (result.filter[splitKey[0]] === undefined) {
                 // first operator for the key,
                 if (['and', 'or'].includes(operation)) {
@@ -141,15 +175,29 @@ export var encodeId = function (data, primaryKey) {
         return data[primaryKey[0]];
     }
 };
-export var dataWithId = function (data, primaryKey) {
-    if (JSON.stringify(primaryKey) === JSON.stringify(['id'])) {
+export var removePrimaryKey = function (data, primaryKey) {
+    var newData = __assign({}, data);
+    primaryKey.forEach(function (key) {
+        delete newData[key];
+    });
+    return newData;
+};
+export var dataWithVirtualId = function (data, primaryKey) {
+    if (primaryKey.length === 1 && primaryKey[0] === 'id') {
         return data;
     }
     return Object.assign(data, {
         id: encodeId(data, primaryKey),
     });
 };
-export var isCompoundKey = function (primaryKey) {
+export var dataWithoutVirtualId = function (data, primaryKey) {
+    if (primaryKey.length === 1 && primaryKey[0] === 'id') {
+        return data;
+    }
+    var id = data.id, dataWithoutId = __rest(data, ["id"]);
+    return dataWithoutId;
+};
+var isCompoundKey = function (primaryKey) {
     return primaryKey.length > 1;
 };
 export var getQuery = function (primaryKey, ids, resource, meta) {
@@ -178,7 +226,7 @@ export var getQuery = function (primaryKey, ids, resource, meta) {
                 _a);
         }
     }
-    else {
+    else if (ids) {
         // if ids is one Identifier
         var id = ids.toString();
         var primaryKeyParams_1 = decodeId(id, primaryKey);
@@ -210,18 +258,6 @@ export var getQuery = function (primaryKey, ids, resource, meta) {
     }
     return result;
 };
-export var getKeyData = function (primaryKey, data) {
-    var _a;
-    if (isCompoundKey(primaryKey)) {
-        return primaryKey.reduce(function (keyData, key) {
-            var _a;
-            return (__assign(__assign({}, keyData), (_a = {}, _a[key] = data[key], _a)));
-        }, {});
-    }
-    else {
-        return _a = {}, _a[primaryKey[0]] = data[primaryKey[0]], _a;
-    }
-};
 export var getOrderBy = function (field, order, primaryKey) {
     if (field == 'id') {
         return primaryKey.map(function (key) { return "".concat(key, ".").concat(order.toLowerCase()); }).join(',');

package/lib/index.js

@@ -68,7 +68,7 @@ exports.default = (function (config) { return ({
                 throw new Error("The Content-Range header is missing in the HTTP Response. The postgREST data provider expects \n          responses for lists of resources to contain this header with the total number of results to build \n          the pagination. If you are using CORS, did you declare Content-Range in the Access-Control-Expose-Headers header?");
             }
             return {
-                data: json.map(function (obj) { return (0, urlBuilder_1.dataWithId)(obj, primaryKey); }),
+                data: json.map(function (obj) { return (0, urlBuilder_1.dataWithVirtualId)(obj, primaryKey); }),
                 total: parseInt(headers.get('content-range').split('/').pop(), 10),
             };
         });
@@ -88,7 +88,7 @@ exports.default = (function (config) { return ({
             .then(function (_a) {
             var json = _a.json;
             return ({
-                data: (0, urlBuilder_1.dataWithId)(json, primaryKey),
+                data: (0, urlBuilder_1.dataWithVirtualId)(json, primaryKey),
             });
         });
     },
@@ -107,7 +107,7 @@ exports.default = (function (config) { return ({
             .then(function (_a) {
             var json = _a.json;
             return ({
-                data: json.map(function (data) { return (0, urlBuilder_1.dataWithId)(data, primaryKey); }),
+                data: json.map(function (data) { return (0, urlBuilder_1.dataWithVirtualId)(data, primaryKey); }),
             });
         });
     },
@@ -136,7 +136,7 @@ exports.default = (function (config) { return ({
                 throw new Error("The Content-Range header is missing in the HTTP Response. The postgREST data provider expects \n          responses for lists of resources to contain this header with the total number of results to build \n          the pagination. If you are using CORS, did you declare Content-Range in the Access-Control-Expose-Headers header?");
             }
             return {
-                data: json.map(function (data) { return (0, urlBuilder_1.dataWithId)(data, primaryKey); }),
+                data: json.map(function (data) { return (0, urlBuilder_1.dataWithVirtualId)(data, primaryKey); }),
                 total: parseInt(headers.get('content-range').split('/').pop(), 10),
             };
         });
@@ -147,10 +147,9 @@ exports.default = (function (config) { return ({
         var id = params.id, data = params.data, meta = params.meta;
         var primaryKey = (0, urlBuilder_1.getPrimaryKey)(resource, config.primaryKeys);
         var query = (0, urlBuilder_1.getQuery)(primaryKey, id, resource, meta);
-        var primaryKeyData = (0, urlBuilder_1.getKeyData)(primaryKey, data);
         var url = "".concat(config.apiUrl, "/").concat(resource, "?").concat(qs_1.default.stringify(query));
         var metaSchema = (_a = params.meta) === null || _a === void 0 ? void 0 : _a.schema;
-        var body = JSON.stringify(__assign(__assign({}, data), primaryKeyData));
+        var body = JSON.stringify(__assign({}, (0, urlBuilder_1.dataWithoutVirtualId)((0, urlBuilder_1.removePrimaryKey)(data, primaryKey), primaryKey)));
         return config
             .httpClient(url, {
             method: 'PATCH',
@@ -159,29 +158,19 @@ exports.default = (function (config) { return ({
         })
             .then(function (_a) {
             var json = _a.json;
-            return ({ data: (0, urlBuilder_1.dataWithId)(json, primaryKey) });
+            return ({
+                data: (0, urlBuilder_1.dataWithVirtualId)(json, primaryKey),
+            });
         });
     },
     updateMany: function (resource, params) {
         var _a, _b;
         if (params === void 0) { params = {}; }
-        var ids = params.ids;
+        var ids = params.ids, meta = params.meta, data = params.data;
         var primaryKey = (0, urlBuilder_1.getPrimaryKey)(resource, config.primaryKeys);
-        var body = JSON.stringify(params.ids.map(function (id) {
-            var data = params.data;
-            var primaryKeyParams = (0, urlBuilder_1.decodeId)(id, primaryKey);
-            var primaryKeyData = {};
-            if ((0, urlBuilder_1.isCompoundKey)(primaryKey)) {
-                primaryKey.forEach(function (key, index) {
-                    primaryKeyData[key] = primaryKeyParams[index];
-                });
-            }
-            else {
-                primaryKeyData[primaryKey[0]] = primaryKeyParams[0];
-            }
-            return __assign(__assign({}, data), primaryKeyData);
-        }));
-        var url = "".concat(config.apiUrl, "/").concat(resource);
+        var query = (0, urlBuilder_1.getQuery)(primaryKey, ids, resource, meta);
+        var url = "".concat(config.apiUrl, "/").concat(resource, "?").concat(qs_1.default.stringify(query));
+        var body = JSON.stringify(__assign({}, (0, urlBuilder_1.dataWithoutVirtualId)((0, urlBuilder_1.removePrimaryKey)(data, primaryKey), primaryKey)));
         var metaSchema = (_a = params.meta) === null || _a === void 0 ? void 0 : _a.schema;
         return config
             .httpClient(url, {
@@ -199,14 +188,17 @@ exports.default = (function (config) { return ({
     create: function (resource, params) {
         var _a, _b;
         if (params === void 0) { params = {}; }
+        var meta = params.meta;
         var primaryKey = (0, urlBuilder_1.getPrimaryKey)(resource, config.primaryKeys);
-        var url = "".concat(config.apiUrl, "/").concat(resource);
+        var query = (0, urlBuilder_1.getQuery)(primaryKey, undefined, resource, meta);
+        var queryStr = qs_1.default.stringify(query);
+        var url = "".concat(config.apiUrl, "/").concat(resource).concat(queryStr.length > 0 ? '?' : '').concat(queryStr);
         var metaSchema = (_a = params.meta) === null || _a === void 0 ? void 0 : _a.schema;
         return config
             .httpClient(url, {
             method: 'POST',
             headers: new Headers(__assign(__assign({ Accept: 'application/vnd.pgrst.object+json', Prefer: 'return=representation', 'Content-Type': 'application/json' }, (((_b = params.meta) === null || _b === void 0 ? void 0 : _b.headers) || {})), useCustomSchema(config.schema, metaSchema, 'POST'))),
-            body: JSON.stringify(params.data),
+            body: JSON.stringify((0, urlBuilder_1.dataWithoutVirtualId)(params.data, primaryKey)),
         })
             .then(function (_a) {
             var json = _a.json;
@@ -230,7 +222,9 @@ exports.default = (function (config) { return ({
         })
             .then(function (_a) {
             var json = _a.json;
-            return ({ data: (0, urlBuilder_1.dataWithId)(json, primaryKey) });
+            return ({
+                data: (0, urlBuilder_1.dataWithVirtualId)(json, primaryKey),
+            });
         });
     },
     deleteMany: function (resource, params) {

package/lib/urlBuilder.d.ts

@@ -14,9 +14,9 @@ export type PrimaryKey = Array<string>;
 export declare const getPrimaryKey: (resource: string, primaryKeys: Map<string, PrimaryKey>) => PrimaryKey;
 export declare const decodeId: (id: Identifier, primaryKey: PrimaryKey) => string[] | number[];
 export declare const encodeId: (data: any, primaryKey: PrimaryKey) => Identifier;
-export declare const dataWithId: (data: any, primaryKey: PrimaryKey) => any;
-export declare const isCompoundKey: (primaryKey: PrimaryKey) => Boolean;
-export declare const getQuery: (primaryKey: PrimaryKey, ids: Identifier | Array<Identifier>, resource: string, meta?: any) => any;
-export declare const getKeyData: (primaryKey: PrimaryKey, data: object) => object;
+export declare const removePrimaryKey: (data: any, primaryKey: PrimaryKey) => any;
+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 {};

package/lib/urlBuilder.js

@@ -10,8 +10,19 @@ var __assign = (this && this.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getOrderBy = exports.getKeyData = exports.getQuery = exports.isCompoundKey = exports.dataWithId = 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)
@@ -45,25 +56,53 @@ var postgrestOperators = [
     'or',
     'and',
 ];
+var isObject = function (obj) {
+    return typeof obj === 'object' && !Array.isArray(obj) && obj !== null;
+};
+var resolveKeys = function (filter, keys) {
+    var result = filter[keys[0]];
+    for (var i = 1; i < keys.length; ++i) {
+        result = result[keys[i]];
+    }
+    return result;
+};
 var parseFilters = function (params, defaultListOp) {
     var filter = params.filter, _a = params.meta, meta = _a === void 0 ? {} : _a;
     var result = {};
     result.filter = {};
     Object.keys(filter).forEach(function (key) {
         // key: the name of the object key
+        var keyArray = [key];
+        var values;
+        // in case of a nested object selection in a text field
+        // RA returns object{ object } structure which is resolved here
+        // see issue https://github.com/raphiniert-com/ra-data-postgrest/issues/58
+        if (key.split('@')[0] !== '' && isObject(filter[key])) {
+            var innerVal = filter[key];
+            do {
+                var inner = resolveKeys(filter, keyArray);
+                var innerKey = Object.keys(inner)[0];
+                keyArray.push(innerKey);
+                innerVal = inner[innerKey];
+            } while (isObject(innerVal));
+            key = keyArray.join('.');
+            values = [innerVal];
+        }
+        else {
+            values = [filter[key]];
+        }
         var splitKey = key.split('@');
         var operation = splitKey.length == 2
             ? splitKey[1]
             : defaultListOp;
-        var values;
         if (['like', 'ilike'].includes(operation)) {
             // we split the search term in words
-            values = filter[key].trim().split(/\s+/);
+            values = resolveKeys(filter, keyArray).trim().split(/\s+/);
         }
         // CASE: Logical operator
         else if (['or', 'and'].includes(operation)) {
             // we extract each value entries and make it dot separated string.
-            var subFilter = (0, exports.parseFilters)({ filter: filter[key] }, defaultListOp).filter;
+            var subFilter = (0, exports.parseFilters)({ filter: resolveKeys(filter, keyArray) }, defaultListOp).filter;
             // something like { "age@lt": 18 } and { "age@gt": 21 }
             var filterExpressions_1 = [];
             Object.entries(subFilter).forEach(function (_a) {
@@ -76,9 +115,6 @@ var parseFilters = function (params, defaultListOp) {
             // finally we flatten all as single string and enclose with bracket.
             values = ["(".concat(filterExpressions_1.join(','), ")")];
         }
-        else {
-            values = [filter[key]];
-        }
         values.forEach(function (value) {
             var op = (function () {
                 // if operator is intentionally blank, rpc syntax
@@ -88,11 +124,9 @@ var parseFilters = function (params, defaultListOp) {
                     return "".concat(operation, ".*").concat(value, "*");
                 if (['and', 'or'].includes(operation))
                     return "".concat(value);
-                if (['cs', 'cd'].includes(operation))
-                    return "".concat(operation, ".{").concat(value, "}");
                 return "".concat(operation, ".").concat(value);
             })();
-            // If resulting filter haven't contains the fieldname, then add it.
+            // If resulting filter doesn't contain the fieldname, then add it.
             if (result.filter[splitKey[0]] === undefined) {
                 // first operator for the key,
                 if (['and', 'or'].includes(operation)) {
@@ -131,7 +165,7 @@ var getPrimaryKey = function (resource, primaryKeys) {
 };
 exports.getPrimaryKey = getPrimaryKey;
 var decodeId = function (id, primaryKey) {
-    if ((0, exports.isCompoundKey)(primaryKey)) {
+    if (isCompoundKey(primaryKey)) {
         return JSON.parse(id.toString());
     }
     else {
@@ -140,7 +174,7 @@ var decodeId = function (id, primaryKey) {
 };
 exports.decodeId = decodeId;
 var encodeId = function (data, primaryKey) {
-    if ((0, exports.isCompoundKey)(primaryKey)) {
+    if (isCompoundKey(primaryKey)) {
         return JSON.stringify(primaryKey.map(function (key) { return data[key]; }));
     }
     else {
@@ -148,19 +182,34 @@ var encodeId = function (data, primaryKey) {
     }
 };
 exports.encodeId = encodeId;
-var dataWithId = function (data, primaryKey) {
-    if (JSON.stringify(primaryKey) === JSON.stringify(['id'])) {
+var removePrimaryKey = function (data, primaryKey) {
+    var newData = __assign({}, data);
+    primaryKey.forEach(function (key) {
+        delete newData[key];
+    });
+    return newData;
+};
+exports.removePrimaryKey = removePrimaryKey;
+var dataWithVirtualId = function (data, primaryKey) {
+    if (primaryKey.length === 1 && primaryKey[0] === 'id') {
         return data;
     }
     return Object.assign(data, {
         id: (0, exports.encodeId)(data, primaryKey),
     });
 };
-exports.dataWithId = dataWithId;
+exports.dataWithVirtualId = dataWithVirtualId;
+var dataWithoutVirtualId = function (data, primaryKey) {
+    if (primaryKey.length === 1 && primaryKey[0] === 'id') {
+        return data;
+    }
+    var id = data.id, dataWithoutId = __rest(data, ["id"]);
+    return dataWithoutId;
+};
+exports.dataWithoutVirtualId = dataWithoutVirtualId;
 var isCompoundKey = function (primaryKey) {
     return primaryKey.length > 1;
 };
-exports.isCompoundKey = isCompoundKey;
 var getQuery = function (primaryKey, ids, resource, meta) {
     var _a, _b;
     if (meta === void 0) { meta = null; }
@@ -171,7 +220,7 @@ var getQuery = function (primaryKey, ids, resource, meta) {
             console.error("PostgREST's rpc endpoints are not intended to be handled as views. Therefore, no query generation for multiple key values implemented!");
             return;
         }
-        if ((0, exports.isCompoundKey)(primaryKey)) {
+        if (isCompoundKey(primaryKey)) {
             result = {
                 or: "(".concat(ids.map(function (id) {
                     var primaryKeyParams = (0, exports.decodeId)(id, primaryKey);
@@ -187,11 +236,11 @@ var getQuery = function (primaryKey, ids, resource, meta) {
                 _a);
         }
     }
-    else {
+    else if (ids) {
         // if ids is one Identifier
         var id = ids.toString();
         var primaryKeyParams_1 = (0, exports.decodeId)(id, primaryKey);
-        if ((0, exports.isCompoundKey)(primaryKey)) {
+        if (isCompoundKey(primaryKey)) {
             if (resource.startsWith('rpc/')) {
                 result = {};
                 primaryKey.map(function (key, i) {
@@ -220,19 +269,6 @@ var getQuery = function (primaryKey, ids, resource, meta) {
     return result;
 };
 exports.getQuery = getQuery;
-var getKeyData = function (primaryKey, data) {
-    var _a;
-    if ((0, exports.isCompoundKey)(primaryKey)) {
-        return primaryKey.reduce(function (keyData, key) {
-            var _a;
-            return (__assign(__assign({}, keyData), (_a = {}, _a[key] = data[key], _a)));
-        }, {});
-    }
-    else {
-        return _a = {}, _a[primaryKey[0]] = data[primaryKey[0]], _a;
-    }
-};
-exports.getKeyData = getKeyData;
 var getOrderBy = function (field, order, primaryKey) {
     if (field == 'id') {
         return primaryKey.map(function (key) { return "".concat(key, ".").concat(order.toLowerCase()); }).join(',');

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@raphiniert/ra-data-postgrest",
-    "version": "2.0.0-alpha.3",
+    "version": "2.0.0",
     "description": "postgREST data provider for react-admin",
     "main": "lib/index.js",
     "module": "esm/index.js",
@@ -12,7 +12,6 @@
         "src"
     ],
     "authors": [
-        "François Zaninotto",
         "Raphael Scheible"
     ],
     "repository": "raphiniert-com/ra-data-postgrest",
@@ -30,17 +29,17 @@
         "prettier": "prettier --config ./.prettierrc.js --write --list-different \"src/**/*.{js,json,ts,tsx,css,md}\""
     },
     "devDependencies": {
-        "@types/jest": "^28.1.4",
-        "@types/qs": "^6.9.7",
+        "@types/jest": "^29.5.11",
+        "@types/qs": "^6.9.11",
         "cross-env": "^7.0.3",
-        "eslint-config-prettier": "^8.8.0",
-        "eslint-plugin-prettier": "^4.2.1",
+        "eslint-config-prettier": "^9.1.0",
+        "eslint-plugin-prettier": "^5.0.1",
         "install-peers-cli": "^2.2.0",
-        "jest": "^28.1.2",
-        "prettier": "~2.8.8",
+        "jest": "^29.7.0",
+        "prettier": "^3.1.1",
         "rimraf": "^5.0.0",
-        "ts-jest": "^28.0.5",
-        "typescript": "^5.0.4"
+        "ts-jest": "^29.1.1",
+        "typescript": "^5.3.3"
     },
     "peerDependencies": {
         "ra-core": "^4.1.0"

package/src/index.ts

@@ -1,5 +1,4 @@
 import {
-    fetchUtils,
     DataProvider,
     GetListParams,
     GetOneParams,
@@ -17,12 +16,11 @@ import {
     getPrimaryKey,
     parseFilters,
     getOrderBy,
-    dataWithId,
+    dataWithVirtualId,
+    dataWithoutVirtualId,
+    removePrimaryKey,
     getQuery,
-    getKeyData,
     encodeId,
-    decodeId,
-    isCompoundKey,
 } from './urlBuilder';
 import qs from 'qs';
 
@@ -154,7 +152,7 @@ export default (config: IDataProviderConfig): DataProvider => ({
                 );
             }
             return {
-                data: json.map(obj => dataWithId(obj, primaryKey)),
+                data: json.map(obj => dataWithVirtualId(obj, primaryKey)),
                 total: parseInt(
                     headers.get('content-range').split('/').pop(),
                     10
@@ -181,7 +179,7 @@ export default (config: IDataProviderConfig): DataProvider => ({
                 }),
             })
             .then(({ json }) => ({
-                data: dataWithId(json, primaryKey),
+                data: dataWithVirtualId(json, primaryKey),
             }));
     },
 
@@ -201,7 +199,7 @@ export default (config: IDataProviderConfig): DataProvider => ({
                 }),
             })
             .then(({ json }) => ({
-                data: json.map(data => dataWithId(data, primaryKey)),
+                data: json.map(data => dataWithVirtualId(data, primaryKey)),
             }));
     },
 
@@ -257,7 +255,7 @@ export default (config: IDataProviderConfig): DataProvider => ({
                 );
             }
             return {
-                data: json.map(data => dataWithId(data, primaryKey)),
+                data: json.map(data => dataWithVirtualId(data, primaryKey)),
                 total: parseInt(
                     headers.get('content-range').split('/').pop(),
                     10
@@ -269,17 +267,15 @@ export default (config: IDataProviderConfig): DataProvider => ({
     update: (resource, params: Partial<UpdateParams> = {}) => {
         const { id, data, meta } = params;
         const primaryKey = getPrimaryKey(resource, config.primaryKeys);
-
         const query = getQuery(primaryKey, id, resource, meta);
-
-        const primaryKeyData = getKeyData(primaryKey, data);
-
         const url = `${config.apiUrl}/${resource}?${qs.stringify(query)}`;
         const metaSchema = params.meta?.schema;
 
         const body = JSON.stringify({
-            ...data,
-            ...primaryKeyData,
+            ...dataWithoutVirtualId(
+                removePrimaryKey(data, primaryKey),
+                primaryKey
+            ),
         });
 
         return config
@@ -294,35 +290,23 @@ export default (config: IDataProviderConfig): DataProvider => ({
                 }),
                 body,
             })
-            .then(({ json }) => ({ data: dataWithId(json, primaryKey) }));
+            .then(({ json }) => ({
+                data: dataWithVirtualId(json, primaryKey),
+            }));
     },
 
     updateMany: (resource, params: Partial<UpdateManyParams> = {}) => {
-        const ids = params.ids;
+        const { ids, meta, data } = params;
         const primaryKey = getPrimaryKey(resource, config.primaryKeys);
+        const query = getQuery(primaryKey, ids, resource, meta);
+        const url = `${config.apiUrl}/${resource}?${qs.stringify(query)}`;
+        const body = JSON.stringify({
+            ...dataWithoutVirtualId(
+                removePrimaryKey(data, primaryKey),
+                primaryKey
+            ),
+        });
 
-        const body = JSON.stringify(
-            params.ids.map(id => {
-                const { data } = params;
-                const primaryKeyParams = decodeId(id, primaryKey);
-
-                const primaryKeyData = {};
-                if (isCompoundKey(primaryKey)) {
-                    primaryKey.forEach((key, index) => {
-                        primaryKeyData[key] = primaryKeyParams[index];
-                    });
-                } else {
-                    primaryKeyData[primaryKey[0]] = primaryKeyParams[0];
-                }
-
-                return {
-                    ...data,
-                    ...primaryKeyData,
-                };
-            })
-        );
-
-        const url = `${config.apiUrl}/${resource}`;
         const metaSchema = params.meta?.schema;
 
         return config
@@ -342,8 +326,13 @@ export default (config: IDataProviderConfig): DataProvider => ({
     },
 
     create: (resource, params: Partial<CreateParams> = {}) => {
+        const { meta } = params;
         const primaryKey = getPrimaryKey(resource, config.primaryKeys);
-        const url = `${config.apiUrl}/${resource}`;
+        const query = getQuery(primaryKey, undefined, resource, meta);
+        const queryStr = qs.stringify(query);
+        const url = `${config.apiUrl}/${resource}${
+            queryStr.length > 0 ? '?' : ''
+        }${queryStr}`;
         const metaSchema = params.meta?.schema;
 
         return config
@@ -356,7 +345,9 @@ export default (config: IDataProviderConfig): DataProvider => ({
                     ...(params.meta?.headers || {}),
                     ...useCustomSchema(config.schema, metaSchema, 'POST'),
                 }),
-                body: JSON.stringify(params.data),
+                body: JSON.stringify(
+                    dataWithoutVirtualId(params.data, primaryKey)
+                ),
             })
             .then(({ json }) => ({
                 data: {
@@ -386,7 +377,9 @@ export default (config: IDataProviderConfig): DataProvider => ({
                     ...useCustomSchema(config.schema, metaSchema, 'DELETE'),
                 }),
             })
-            .then(({ json }) => ({ data: dataWithId(json, primaryKey) }));
+            .then(({ json }) => ({
+                data: dataWithVirtualId(json, primaryKey),
+            }));
     },
 
     deleteMany: (resource, params: Partial<DeleteManyParams> = {}) => {

package/src/urlBuilder.ts

@@ -49,6 +49,18 @@ type ParsedFiltersResult = {
     select: any;
 };
 
+const isObject = obj =>
+    typeof obj === 'object' && !Array.isArray(obj) && obj !== null;
+
+const resolveKeys = (filter: any, keys: Array<any>) => {
+    let result = filter[keys[0]];
+    for (let i = 1; i < keys.length; ++i) {
+        result = result[keys[i]];
+    }
+
+    return result;
+};
+
 export type PostgRestOperator = (typeof postgrestOperators)[number];
 
 export const parseFilters = (
@@ -62,22 +74,44 @@ export const parseFilters = (
     Object.keys(filter).forEach(function (key) {
         // key: the name of the object key
 
+        let keyArray = [key];
+        let values: Array<string>;
+
+        // in case of a nested object selection in a text field
+        // RA returns object{ object } structure which is resolved here
+        // see issue https://github.com/raphiniert-com/ra-data-postgrest/issues/58
+        if (key.split('@')[0] !== '' && isObject(filter[key])) {
+            let innerVal = filter[key];
+
+            do {
+                const inner = resolveKeys(filter, keyArray);
+                const [innerKey] = Object.keys(inner);
+
+                keyArray.push(innerKey);
+                innerVal = inner[innerKey];
+            } while (isObject(innerVal));
+
+            key = keyArray.join('.');
+            values = [innerVal];
+        } else {
+            values = [filter[key]];
+        }
+
         const splitKey = key.split('@');
         const operation: PostgRestOperator =
             splitKey.length == 2
                 ? (splitKey[1] as PostgRestOperator)
                 : defaultListOp;
 
-        let values: Array<string>;
         if (['like', 'ilike'].includes(operation)) {
             // we split the search term in words
-            values = filter[key].trim().split(/\s+/);
+            values = resolveKeys(filter, keyArray).trim().split(/\s+/);
         }
         // CASE: Logical operator
         else if (['or', 'and'].includes(operation)) {
             // we extract each value entries and make it dot separated string.
             const { filter: subFilter } = parseFilters(
-                { filter: filter[key] },
+                { filter: resolveKeys(filter, keyArray) },
                 defaultListOp
             );
 
@@ -91,8 +125,6 @@ export const parseFilters = (
 
             // finally we flatten all as single string and enclose with bracket.
             values = [`(${filterExpressions.join(',')})`];
-        } else {
-            values = [filter[key]];
         }
 
         values.forEach(value => {
@@ -103,12 +135,10 @@ export const parseFilters = (
                 if (operation.includes('like'))
                     return `${operation}.*${value}*`;
                 if (['and', 'or'].includes(operation)) return `${value}`;
-                if (['cs', 'cd'].includes(operation))
-                    return `${operation}.{${value}}`;
                 return `${operation}.${value}`;
             })();
 
-            // If resulting filter haven't contains the fieldname, then add it.
+            // If resulting filter doesn't contain the fieldname, then add it.
             if (result.filter[splitKey[0]] === undefined) {
                 // first operator for the key,
                 if (['and', 'or'].includes(operation)) {
@@ -170,8 +200,16 @@ export const encodeId = (data: any, primaryKey: PrimaryKey): Identifier => {
     }
 };
 
-export const dataWithId = (data: any, primaryKey: PrimaryKey) => {
-    if (JSON.stringify(primaryKey) === JSON.stringify(['id'])) {
+export const removePrimaryKey = (data: any, primaryKey: PrimaryKey) => {
+    const newData = { ...data };
+    primaryKey.forEach(key => {
+        delete newData[key];
+    });
+    return newData;
+};
+
+export const dataWithVirtualId = (data: any, primaryKey: PrimaryKey) => {
+    if (primaryKey.length === 1 && primaryKey[0] === 'id') {
         return data;
     }
 
@@ -180,13 +218,22 @@ export const dataWithId = (data: any, primaryKey: PrimaryKey) => {
     });
 };
 
-export const isCompoundKey = (primaryKey: PrimaryKey): Boolean => {
+export const dataWithoutVirtualId = (data: any, primaryKey: PrimaryKey) => {
+    if (primaryKey.length === 1 && primaryKey[0] === 'id') {
+        return data;
+    }
+
+    const { id, ...dataWithoutId } = data;
+    return dataWithoutId;
+};
+
+const isCompoundKey = (primaryKey: PrimaryKey): Boolean => {
     return primaryKey.length > 1;
 };
 
 export const getQuery = (
     primaryKey: PrimaryKey,
-    ids: Identifier | Array<Identifier>,
+    ids: Identifier | Array<Identifier> | undefined,
     resource: string,
     meta: any = null
 ): any => {
@@ -215,7 +262,7 @@ export const getQuery = (
                 [primaryKey[0]]: `in.(${ids.join(',')})`,
             };
         }
-    } else {
+    } else if (ids) {
         // if ids is one Identifier
         const id: Identifier = ids.toString();
         const primaryKeyParams = decodeId(id, primaryKey);
@@ -251,20 +298,6 @@ export const getQuery = (
     return result;
 };
 
-export const getKeyData = (primaryKey: PrimaryKey, data: object): object => {
-    if (isCompoundKey(primaryKey)) {
-        return primaryKey.reduce(
-            (keyData, key) => ({
-                ...keyData,
-                [key]: data[key],
-            }),
-            {}
-        );
-    } else {
-        return { [primaryKey[0]]: data[primaryKey[0]] };
-    }
-};
-
 export const getOrderBy = (
     field: string,
     order: string,