@raphiniert/ra-data-postgrest 1.1.6 → 1.1.7

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 Find all notable changes of this project in this file.
 
+## v1.1.7 - 2022-01-07
+### Fixes
+- fixed bad behaivor with compound keys while using field named `id` [issue #27](https://github.com/raphiniert-com/ra-data-postgrest/issues/27) and [issue #19](https://github.com/raphiniert-com/ra-data-postgrest/pull/19) - @[kenfehling](https://github.com/kenfehling)
+
+### New feature
+- added rpc filter support, which is explained [here](https://github.com/raphiniert-com/ra-data-postgrest#special-filter-feature-rpc-functions) - @[TheRealAstroboy](https://github.com/TheRealAstroboy)
+
 ## v1.1.6 - 2021-01-16
 ### Fixes
 - fixed eq. prefix for non-compound keys [issue #23](https://github.com/raphiniert-com/ra-data-postgrest/issues/23) - @[andymed-jlp](https://github.com/andymed-jlp)

package/README.md

@@ -135,6 +135,19 @@ The dataProvider is designed to enable you to specify the comparator in your rea
 
 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.
 
+### Special Filter Feature (RPC Functions)
+The dataProvider is designed to enable you to use Get RPC functions:
+
+```GET /rpc/add_them?post_author=Herbert HTTP/1.1```
+The function parameter names match the query parameters ```&post_author=Herbert``` if you end the field with an `@` (neither default comparator nor special comparator)
+
+```jsx
+<Filter {...props}>
+  <TextInput label="Search" source="post_title" alwaysOn />
+  <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:

package/esm/dataProvider/index.js

@@ -111,7 +111,7 @@ var encodeId = function (data, primaryKey) {
     }
 };
 var dataWithId = function (data, primaryKey) {
-    if (primaryKey === ['id'] || (data && data.id)) {
+    if (primaryKey === ['id']) {
         return data;
     }
     return Object.assign(data, {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@raphiniert/ra-data-postgrest",
-    "version": "1.1.6",
+    "version": "1.1.7",
     "description": "postgREST data provider for react-admin",
     "main": "lib/index.js",
     "module": "esm/index.js",

package/src/dataProvider/index.ts

@@ -53,7 +53,9 @@ function parseFilters(filter, defaultListOp) {
     }
 
     values.forEach(value => {
-      let op = operation.includes('like') ? `${operation}.*${value}*` : `${operation}.${value}`;
+      // if operator is intentionally blank, rpc syntax 
+      let op = operation.includes('like') ? `${operation}.*${value}*` : operation.length == 0 ? `${value}` : `${operation}.${value}`;
+
       if (result[splitKey[0]] === undefined) {
         // first operator for the key, we add it to the dict
         result[splitKey[0]] = op;
@@ -99,7 +101,7 @@ const encodeId = (data: any, primaryKey: PrimaryKey): Identifier => {
 }
 
 const dataWithId = (data: any, primaryKey: PrimaryKey) => {
-  if (primaryKey === ['id'] || (data && data.id)) {
+  if (primaryKey === ['id']) {
     return data;
   }
 
@@ -251,12 +253,17 @@ export default (apiUrl, httpClient = fetchUtils.fetchJson, defaultListOp = 'eq',
     const parsedFilter = parseFilters(params.filter, defaultListOp);
     const primaryKey = getPrimaryKey(resource, primaryKeys);
 
-    const query = {
+    const query = params.target ? {
       [params.target]: `eq.${params.id}`,
       order: getOrderBy(field, order, primaryKey),
       offset: (page - 1) * perPage,
       limit: perPage,
       ...parsedFilter,
+    }:{
+      order: getOrderBy(field, order, primaryKey),
+      offset: (page - 1) * perPage,
+      limit: perPage,
+      ...parsedFilter,
     };
 
     // add header that Content-Range is in returned header

package/lib/authProvider/index.d.ts

@@ -1,11 +0,0 @@
-declare const _default: {
-    login: ({ username, password }: {
-        username: any;
-        password: any;
-    }) => Promise<void>;
-    logout: (params: any) => Promise<void>;
-    checkAuth: (params: any) => Promise<void>;
-    checkError: (error: any) => Promise<void>;
-    getPermissions: (params: any) => Promise<any>;
-};
-export default _default;

package/lib/authProvider/index.js

@@ -1,60 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = {
-    login: function (_a) {
-        var username = _a.username, password = _a.password;
-        var request = new Request('rest/rpc/login', {
-            method: 'POST',
-            body: JSON.stringify({ email: username, password: password }),
-            headers: new Headers({
-                'Content-Type': 'application/json',
-                'Accept': 'application/vnd.pgrst.object+json',
-                'Prefer': 'return=representation'
-            }),
-        });
-        return fetch(request)
-            .then(function (response) {
-            if (response.status < 200 || response.status >= 300) {
-                throw new Error(response.statusText);
-            }
-            return response.json();
-        })
-            .then(function (data) {
-            localStorage.setItem('me', JSON.stringify(data));
-        });
-    },
-    logout: function (params) {
-        var request = new Request('rest/rpc/logout', {
-            method: 'POST',
-            headers: new Headers({
-                'Content-Type': 'application/json',
-                'Accept': 'application/vnd.pgrst.object+json',
-                'Prefer': 'return=representation'
-            }),
-        });
-        return fetch(request)
-            .then(function (response) {
-            if (response.status < 200 || response.status >= 300) {
-                throw new Error(response.statusText);
-            }
-            return response.json();
-        })
-            .then(function (data) {
-            localStorage.removeItem('me');
-        });
-    },
-    checkAuth: function (params) { return (localStorage.getItem('me') ? Promise.resolve() : Promise.reject()); },
-    checkError: function (error) {
-        var status = error.status;
-        if (status === 401 || status === 403) {
-            localStorage.removeItem('me');
-            return Promise.reject();
-        }
-        return Promise.resolve();
-    },
-    getPermissions: function (params) {
-        var _a;
-        var role = (_a = JSON.parse(localStorage.getItem('me'))) === null || _a === void 0 ? void 0 : _a.role;
-        return role ? Promise.resolve(role) : Promise.reject();
-    },
-};

package/lib/dataProvider/index.d.ts

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

package/lib/dataProvider/index.js

@@ -1,362 +0,0 @@
-"use strict";
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    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 });
-var query_string_1 = require("query-string");
-var ra_core_1 = require("ra-core");
-/**
- * Maps react-admin queries to a postgrest REST API
- *
- * This REST dialect uses postgrest syntax
- *
- * @see https://postgrest.org/en/stable/api.html#embedded-filters
- *
- * @example
- *
- * 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)
- *
- * @example
- *
- * import * as React from 'react';
- * import { Admin, Resource } from 'react-admin';
- * import postgrestRestProvider from '@raphiniert/ra-data-postgrest';
- *
- * import { PostList } from './posts';
- *
- * const App = () => (
- *     <Admin dataProvider={postgrestRestProvider('http://path.to.my.api/')}>
- *         <Resource name="posts" list={PostList} />
- *     </Admin>
- * );
- *
- * export default App;
- */
-function parseFilters(filter, defaultListOp) {
-    var result = {};
-    Object.keys(filter).forEach(function (key) {
-        // key: the name of the object key
-        var splitKey = key.split('@');
-        var operation = splitKey.length == 2 ? splitKey[1] : defaultListOp;
-        var values;
-        if (operation.includes('like')) {
-            // we split the search term in words
-            values = filter[key].trim().split(' ');
-        }
-        else {
-            values = [filter[key]];
-        }
-        values.forEach(function (value) {
-            var op = operation.includes('like') ? operation + ".*" + value + "*" : operation + "." + value;
-            if (result[splitKey[0]] === undefined) {
-                // first operator for the key, we add it to the dict
-                result[splitKey[0]] = op;
-            }
-            else {
-                if (!Array.isArray(result[splitKey[0]])) {
-                    // second operator, we transform to an array
-                    result[splitKey[0]] = [result[splitKey[0]], op];
-                }
-                else {
-                    // third and subsequent, we add to array
-                    result[splitKey[0]].push(op);
-                }
-            }
-        });
-    });
-    return result;
-}
-var getPrimaryKey = function (resource, primaryKeys) {
-    return primaryKeys.get(resource) || ['id'];
-};
-var decodeId = function (id, primaryKey) {
-    if (isCompoundKey(primaryKey)) {
-        return JSON.parse(id.toString());
-    }
-    else {
-        return [id.toString()];
-    }
-};
-var encodeId = function (data, primaryKey) {
-    if (isCompoundKey(primaryKey)) {
-        return JSON.stringify(primaryKey.map(function (key) { return data[key]; }));
-    }
-    else {
-        return data[primaryKey[0]];
-    }
-};
-var dataWithId = function (data, primaryKey) {
-    if (primaryKey === ['id'] || (data && data.id)) {
-        return data;
-    }
-    return Object.assign(data, {
-        id: encodeId(data, primaryKey)
-    });
-};
-var isCompoundKey = function (primaryKey) {
-    return primaryKey.length > 1;
-};
-var getQuery = function (primaryKey, ids, resource) {
-    var _a, _b;
-    if (Array.isArray(ids) && ids.length > 1) {
-        // no standardized query with multiple ids possible for rpc endpoints which are api-exposed database functions
-        if (resource.startsWith('rpc/')) {
-            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 (isCompoundKey(primaryKey)) {
-            return "or=(\n          " + ids.map(function (id) {
-                var primaryKeyParams = decodeId(id, primaryKey);
-                return "and(" + primaryKey.map(function (key, i) { return key + ".eq." + primaryKeyParams[i]; }).join(',') + ")";
-            }) + "\n        )";
-        }
-        else {
-            return query_string_1.stringify((_a = {}, _a[primaryKey[0]] = "in.(" + ids.join(',') + ")", _a));
-        }
-    }
-    else {
-        // if ids is one Identifier
-        var id = ids.toString();
-        var primaryKeyParams_1 = decodeId(id, primaryKey);
-        if (isCompoundKey(primaryKey)) {
-            if (resource.startsWith('rpc/'))
-                return "" + primaryKey.map(function (key, i) { return key + "=" + primaryKeyParams_1[i]; }).join('&');
-            else
-                return "and=(" + primaryKey.map(function (key, i) { return key + ".eq." + primaryKeyParams_1[i]; }).join(',') + ")";
-        }
-        else {
-            return query_string_1.stringify((_b = {}, _b[primaryKey[0]] = "eq." + id, _b));
-        }
-    }
-};
-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;
-    }
-};
-var getOrderBy = function (field, order, primaryKey) {
-    if (field == 'id') {
-        return primaryKey.map(function (key) { return (key + "." + order.toLowerCase()); }).join(',');
-    }
-    else {
-        return field + "." + order.toLowerCase();
-    }
-};
-var defaultPrimaryKeys = new Map();
-exports.default = (function (apiUrl, httpClient, defaultListOp, primaryKeys) {
-    if (httpClient === void 0) { httpClient = ra_core_1.fetchUtils.fetchJson; }
-    if (defaultListOp === void 0) { defaultListOp = 'eq'; }
-    if (primaryKeys === void 0) { primaryKeys = defaultPrimaryKeys; }
-    return ({
-        getList: function (resource, params) {
-            var primaryKey = getPrimaryKey(resource, primaryKeys);
-            var _a = params.pagination, page = _a.page, perPage = _a.perPage;
-            var _b = params.sort, field = _b.field, order = _b.order;
-            var parsedFilter = parseFilters(params.filter, defaultListOp);
-            var query = __assign({ order: getOrderBy(field, order, primaryKey), offset: (page - 1) * perPage, limit: perPage }, parsedFilter);
-            // add header that Content-Range is in returned header
-            var options = {
-                headers: new Headers({
-                    Accept: 'application/json',
-                    Prefer: 'count=exact'
-                })
-            };
-            var url = apiUrl + "/" + resource + "?" + query_string_1.stringify(query);
-            return httpClient(url, options).then(function (_a) {
-                var headers = _a.headers, json = _a.json;
-                if (!headers.has('content-range')) {
-                    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); }),
-                    total: parseInt(headers
-                        .get('content-range')
-                        .split('/')
-                        .pop(), 10)
-                };
-            });
-        },
-        getOne: function (resource, params) {
-            var id = params.id;
-            var primaryKey = getPrimaryKey(resource, primaryKeys);
-            var query = getQuery(primaryKey, id, resource);
-            var url = apiUrl + "/" + resource + "?" + query;
-            return httpClient(url, {
-                headers: new Headers({ 'accept': 'application/vnd.pgrst.object+json' }),
-            }).then(function (_a) {
-                var json = _a.json;
-                return ({
-                    data: dataWithId(json, primaryKey),
-                });
-            });
-        },
-        getMany: function (resource, params) {
-            var ids = params.ids;
-            var primaryKey = getPrimaryKey(resource, primaryKeys);
-            var query = getQuery(primaryKey, ids, resource);
-            var url = apiUrl + "/" + resource + "?" + query;
-            return httpClient(url).then(function (_a) {
-                var json = _a.json;
-                return ({ data: json.map(function (data) { return dataWithId(data, primaryKey); }) });
-            });
-        },
-        getManyReference: function (resource, params) {
-            var _a;
-            var _b = params.pagination, page = _b.page, perPage = _b.perPage;
-            var _c = params.sort, field = _c.field, order = _c.order;
-            var parsedFilter = parseFilters(params.filter, defaultListOp);
-            var primaryKey = getPrimaryKey(resource, primaryKeys);
-            var query = __assign((_a = {}, _a[params.target] = "eq." + params.id, _a.order = getOrderBy(field, order, primaryKey), _a.offset = (page - 1) * perPage, _a.limit = perPage, _a), parsedFilter);
-            // add header that Content-Range is in returned header
-            var options = {
-                headers: new Headers({
-                    Accept: 'application/json',
-                    Prefer: 'count=exact'
-                })
-            };
-            var url = apiUrl + "/" + resource + "?" + query_string_1.stringify(query);
-            return httpClient(url, options).then(function (_a) {
-                var headers = _a.headers, json = _a.json;
-                if (!headers.has('content-range')) {
-                    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); }),
-                    total: parseInt(headers
-                        .get('content-range')
-                        .split('/')
-                        .pop(), 10),
-                };
-            });
-        },
-        update: function (resource, params) {
-            var id = params.id, data = params.data;
-            var primaryKey = getPrimaryKey(resource, primaryKeys);
-            var query = getQuery(primaryKey, id, resource);
-            var primaryKeyData = getKeyData(primaryKey, data);
-            var url = apiUrl + "/" + resource + "?" + query;
-            var body = JSON.stringify(__assign(__assign({}, data), primaryKeyData));
-            return httpClient(url, {
-                method: 'PATCH',
-                headers: new Headers({
-                    'Accept': 'application/vnd.pgrst.object+json',
-                    'Prefer': 'return=representation',
-                    'Content-Type': 'application/json'
-                }),
-                body: body,
-            }).then(function (_a) {
-                var json = _a.json;
-                return ({ data: dataWithId(json, primaryKey) });
-            });
-        },
-        updateMany: function (resource, params) {
-            var ids = params.ids;
-            var primaryKey = getPrimaryKey(resource, primaryKeys);
-            var query = getQuery(primaryKey, ids, resource);
-            var body = JSON.stringify(params.data.map(function (obj) {
-                var id = obj.id, data = __rest(obj, ["id"]);
-                var primaryKeyData = getKeyData(primaryKey, data);
-                return __assign(__assign({}, data), primaryKeyData);
-            }));
-            var url = apiUrl + "/" + resource + "?" + query;
-            return httpClient(url, {
-                method: 'PATCH',
-                headers: new Headers({
-                    'Prefer': 'return=representation',
-                    'Content-Type': 'application/json',
-                }),
-                body: body,
-            }).then(function (_a) {
-                var json = _a.json;
-                return ({
-                    data: json.map(function (data) { return encodeId(data, primaryKey); })
-                });
-            });
-        },
-        create: function (resource, params) {
-            var primaryKey = getPrimaryKey(resource, primaryKeys);
-            var url = apiUrl + "/" + resource;
-            return httpClient(url, {
-                method: 'POST',
-                headers: new Headers({
-                    'Accept': 'application/vnd.pgrst.object+json',
-                    'Prefer': 'return=representation',
-                    'Content-Type': 'application/json'
-                }),
-                body: JSON.stringify(params.data),
-            }).then(function (_a) {
-                var json = _a.json;
-                return ({
-                    data: __assign(__assign({}, params.data), { id: encodeId(json, primaryKey) })
-                });
-            });
-        },
-        delete: function (resource, params) {
-            var id = params.id;
-            var primaryKey = getPrimaryKey(resource, primaryKeys);
-            var query = getQuery(primaryKey, id, resource);
-            var url = apiUrl + "/" + resource + "?" + query;
-            return httpClient(url, {
-                method: 'DELETE',
-                headers: new Headers({
-                    'Accept': 'application/vnd.pgrst.object+json',
-                    'Prefer': 'return=representation',
-                    'Content-Type': 'application/json'
-                }),
-            }).then(function (_a) {
-                var json = _a.json;
-                return ({ data: dataWithId(json, primaryKey) });
-            });
-        },
-        deleteMany: function (resource, params) {
-            var ids = params.ids;
-            var primaryKey = getPrimaryKey(resource, primaryKeys);
-            var query = getQuery(primaryKey, ids, resource);
-            var url = apiUrl + "/" + resource + "?" + query;
-            return httpClient(url, {
-                method: 'DELETE',
-                headers: new Headers({
-                    'Prefer': 'return=representation',
-                    'Content-Type': 'application/json'
-                }),
-            }).then(function (_a) {
-                var json = _a.json;
-                return ({ data: json.map(function (data) { return encodeId(data, primaryKey); }) });
-            });
-        },
-    });
-});

package/lib/index.d.ts

@@ -1,4 +0,0 @@
-import dataProvider from './dataProvider';
-import authProvider from './authProvider';
-export { authProvider };
-export default dataProvider;

package/lib/index.js

@@ -1,10 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.authProvider = void 0;
-var dataProvider_1 = __importDefault(require("./dataProvider"));
-var authProvider_1 = __importDefault(require("./authProvider"));
-exports.authProvider = authProvider_1.default;
-exports.default = dataProvider_1.default;