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

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,34 +56,88 @@ 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+/);
         }
-        else {
-            values = [filter[key]];
+        // 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: resolveKeys(filter, keyArray) }, defaultListOp).filter;
+            // something like { "age@lt": 18 } and { "age@gt": 21 }
+            var filterExpressions_1 = [];
+            Object.entries(subFilter).forEach(function (_a) {
+                var op = _a[0], val = _a[1];
+                if (Array.isArray(val))
+                    filterExpressions_1.push.apply(filterExpressions_1, val.map(function (v) { return [op, v].join('.'); }));
+                else
+                    filterExpressions_1.push([op, val].join('.'));
+            });
+            // finally we flatten all as single string and enclose with bracket.
+            values = ["(".concat(filterExpressions_1.join(','), ")")];
         }
         values.forEach(function (value) {
-            // if operator is intentionally blank, rpc syntax
-            var op = operation.includes('like')
-                ? "".concat(operation, ".*").concat(value, "*")
-                : operation.length == 0
-                    ? "".concat(value)
-                    : "".concat(operation, ".").concat(value);
+            var op = (function () {
+                // if operator is intentionally blank, rpc syntax
+                if (operation.length === 0)
+                    return "".concat(value);
+                if (operation.includes('like'))
+                    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 doesn't contain the fieldname, then add it.
             if (result.filter[splitKey[0]] === undefined) {
-                // first operator for the key, we add it to the dict
-                result.filter[splitKey[0]] = op;
+                // first operator for the key,
+                if (['and', 'or'].includes(operation)) {
+                    result.filter[operation] = op;
+                }
+                else {
+                    // we add it to the dict
+                    result.filter[splitKey[0]] = op;
+                }
             }
             else {
                 if (!Array.isArray(result[splitKey[0]])) {
@@ -102,7 +167,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 {
@@ -111,7 +176,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 {
@@ -119,19 +184,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; }
@@ -142,7 +222,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);
@@ -158,11 +238,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) {
@@ -191,19 +271,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.1",
+    "version": "2.0.0-alpha.4",
     "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,16 +29,17 @@
         "prettier": "prettier --config ./.prettierrc.js --write --list-different \"src/**/*.{js,json,ts,tsx,css,md}\""
     },
     "devDependencies": {
-        "@types/jest": "^28.1.4",
+        "@types/jest": "^29.5.6",
+        "@types/qs": "^6.9.7",
         "cross-env": "^7.0.3",
-        "eslint-config-prettier": "^8.8.0",
-        "eslint-plugin-prettier": "^4.2.1",
+        "eslint-config-prettier": "^9.0.0",
+        "eslint-plugin-prettier": "^5.0.1",
         "install-peers-cli": "^2.2.0",
-        "jest": "^28.1.2",
-        "prettier": "~2.8.7",
-        "rimraf": "^4.4.1",
-        "ts-jest": "^28.0.5",
-        "typescript": "^4.9.5"
+        "jest": "^29.7.0",
+        "prettier": "^3.0.3",
+        "rimraf": "^5.0.0",
+        "ts-jest": "^29.1.1",
+        "typescript": "^5.0.4"
     },
     "peerDependencies": {
         "ra-core": "^4.1.0"