@raphiniert/ra-data-postgrest 1.1.9 → 2.0.0-alpha.0

package/CHANGELOG.md

@@ -2,7 +2,21 @@
 
 Find all notable changes of this project in this file.
 
-## v1.1.9 - 2023-08-23
+## v2.0.0-alpha.0 - 2022-11-23
+- [#42](https://github.com/raphiniert-com/ra-data-postgrest/issues/42), started adding some unit tests - @[christiaanwesterbeek](https://github.com/christiaanwesterbeek)
+- dropped authProvider
+- code cleanup & restructuring
+- minor bugfixes - @[christiaanwesterbeek](https://github.com/christiaanwesterbeek)
+- added some notes to README.md
+
+### Breaking changes
+- dropped authProvider as this should rather be an own package in case of a generic piece of software or application specific.
+
+## v1.2.0 - 2022-08-23
+- [#33](https://github.com/raphiniert-com/ra-data-postgrest/pull/33), adding dependabot - @[promitheus7](https://github.com/promitheus7)
+- [#30](https://github.com/raphiniert-com/ra-data-postgrest/pull/30) and [#33](https://github.com/raphiniert-com/ra-data-postgrest/pull/33), updated dependency to compatible starting from `ra-core` 4.1.x - @[corrideat](https://github.com/corrideat), @[promitheus7](https://github.com/promitheus7)
+
+## v1.1.9 - 2022-08-23
 - [#30](https://github.com/raphiniert-com/ra-data-postgrest/pull/30), updated ts and modified code, such that some package dependencies became unrequired - @[corrideat](https://github.com/corrideat)
 
 ## v1.1.8 - 2022-01-07

package/README.md

@@ -5,9 +5,11 @@ PostgREST Data Provider for [react-admin](https://github.com/marmelab/react-admi
 ## Installation
 
 ```sh
-npm install --save @raphiniert/ra-data-postgrest
+npm install --save @promitheus/ra-data-postgrest
 ```
 
+**NOTE**: When using RA 3.x.x, use the data-provider 1.x.x. For RA >= 4.1.x use the data-provider starting from 1.2.x.
+
 ## REST Dialect
 
 This Data Provider fits REST APIs using simple GET parameters for filters and sorting. This is the dialect used for instance in [PostgREST](http://postgrest.org).
@@ -42,7 +44,7 @@ Access-Control-Expose-Headers: Content-Range
 // in src/App.js
 import React from 'react';
 import { Admin, Resource } from 'react-admin';
-import postgrestRestProvider from '@raphiniert/ra-data-postgrest';
+import postgrestRestProvider from '@promitheus/ra-data-postgrest';
 
 import { PostList } from './posts';
 
@@ -63,7 +65,7 @@ That means that if you need to add custom headers to your requests, you just nee
 
 ```jsx
 import { fetchUtils, Admin, Resource } from 'react-admin';
-import postgrestRestProvider from '@raphiniert/ra-data-postgrest';
+import postgrestRestProvider from '@promitheus/ra-data-postgrest';
 
 const httpClient = (url, options = {}) => {
     if (!options.headers) {
@@ -107,7 +109,7 @@ With one of the starter kits it is very easy to use the authProvider:
 // in src/App.js
 import React from 'react';
 import { Admin, Resource } from 'react-admin';
-import postgrestRestProvider, { authProvider } from '@raphiniert/ra-data-postgrest';
+import postgrestRestProvider, { authProvider } from '@promitheus/ra-data-postgrest';
 
 import { PostList } from './posts';
 
@@ -155,6 +157,11 @@ const dataProvider = postgrestRestProvider(API_URL, fetchUtils.fetchJson, 'eq',
 ]));
 ```
 
+## Developers notes
+
+The current development of this library was done with node v19.10 and npm 8.19.3. In this version the unit tests and the development environment should work.
+
+
 ## License
 
 This data provider is licensed under the MIT License and sponsored by [raphiniert.com](https://raphiniert.com).

package/esm/index.d.ts

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

package/esm/index.js

@@ -1,4 +1,241 @@
-import dataProvider from './dataProvider';
-import authProvider from './authProvider';
-export { authProvider };
-export default dataProvider;
+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);
+};
+import { fetchUtils } from 'ra-core';
+import { getPrimaryKey, parseFilters, getOrderBy, dataWithId, getQuery, getKeyData, encodeId, decodeId, isCompoundKey, } from './urlBuilder';
+/**
+ * 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 '@promitheus/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;
+ */
+var defaultPrimaryKeys = new Map();
+export default (function (apiUrl, httpClient, defaultListOp, primaryKeys) {
+    if (httpClient === void 0) { httpClient = 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: String((page - 1) * perPage), limit: String(perPage) }, parsedFilter);
+            // add header that Content-Range is in returned header
+            var options = {
+                headers: new Headers({
+                    Accept: 'application/json',
+                    Prefer: 'count=exact',
+                }),
+            };
+            var url = "".concat(apiUrl, "/").concat(resource, "?").concat(new URLSearchParams(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 = "".concat(apiUrl, "/").concat(resource, "?").concat(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 = "".concat(apiUrl, "/").concat(resource, "?").concat(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 = params.target
+                ? __assign((_a = {}, _a[params.target] = "eq.".concat(params.id), _a.order = getOrderBy(field, order, primaryKey), _a.offset = String((page - 1) * perPage), _a.limit = String(perPage), _a), parsedFilter) : __assign({ order: getOrderBy(field, order, primaryKey), offset: String((page - 1) * perPage), limit: String(perPage) }, parsedFilter);
+            // add header that Content-Range is in returned header
+            var options = {
+                headers: new Headers({
+                    Accept: 'application/json',
+                    Prefer: 'count=exact',
+                }),
+            };
+            var url = "".concat(apiUrl, "/").concat(resource, "?").concat(new URLSearchParams(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 = "".concat(apiUrl, "/").concat(resource, "?").concat(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 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(apiUrl, "/").concat(resource);
+            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 = "".concat(apiUrl, "/").concat(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 = "".concat(apiUrl, "/").concat(resource, "?").concat(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 = "".concat(apiUrl, "/").concat(resource, "?").concat(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/esm/urlBuilder.d.ts

@@ -0,0 +1,18 @@
+import { Identifier } from 'ra-core';
+/**
+ * List of all possible operators in PostgRest
+ * (https://postgrest.org/en/stable/api.html#operators)
+ */
+declare const postgrestOperators: readonly ["eq", "gt", "gte", "lt", "lte", "neq", "like", "ilike", "match", "imatch", "in", "is", "fts", "plfts", "phfts", "wfts", "cs", "cd", "ov", "sl", "sr", "nxr", "nxl", "adj", "not", "or", "and"];
+export type PostgRestOperator = typeof postgrestOperators[number];
+export declare const parseFilters: (filter: Record<string, any>, defaultListOp: PostgRestOperator) => {};
+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) => string;
+export declare const getKeyData: (primaryKey: PrimaryKey, data: object) => object;
+export declare const getOrderBy: (field: string, order: string, primaryKey: PrimaryKey) => string;
+export {};

package/esm/urlBuilder.js

@@ -0,0 +1,183 @@
+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);
+};
+/**
+ * List of all possible operators in PostgRest
+ * (https://postgrest.org/en/stable/api.html#operators)
+ */
+var postgrestOperators = [
+    'eq',
+    'gt',
+    'gte',
+    'lt',
+    'lte',
+    'neq',
+    'like',
+    'ilike',
+    'match',
+    'imatch',
+    'in',
+    'is',
+    'fts',
+    'plfts',
+    'phfts',
+    'wfts',
+    'cs',
+    'cd',
+    'ov',
+    'sl',
+    'sr',
+    'nxr',
+    'nxl',
+    'adj',
+    'not',
+    'or',
+    'and',
+];
+export var parseFilters = function (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 (['like', 'ilike'].includes(operation)) {
+            // we split the search term in words
+            values = filter[key].trim().split(/\s+/);
+        }
+        else {
+            values = [filter[key]];
+        }
+        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);
+            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;
+};
+export var getPrimaryKey = function (resource, primaryKeys) {
+    return primaryKeys.get(resource) || ['id'];
+};
+export var decodeId = function (id, primaryKey) {
+    if (isCompoundKey(primaryKey)) {
+        return JSON.parse(id.toString());
+    }
+    else {
+        return [id.toString()];
+    }
+};
+export var encodeId = function (data, primaryKey) {
+    if (isCompoundKey(primaryKey)) {
+        return JSON.stringify(primaryKey.map(function (key) { return data[key]; }));
+    }
+    else {
+        return data[primaryKey[0]];
+    }
+};
+export var dataWithId = function (data, primaryKey) {
+    if (JSON.stringify(primaryKey) === JSON.stringify(['id'])) {
+        return data;
+    }
+    return Object.assign(data, {
+        id: encodeId(data, primaryKey),
+    });
+};
+export var isCompoundKey = function (primaryKey) {
+    return primaryKey.length > 1;
+};
+export var getQuery = function (primaryKey, ids, resource) {
+    var _a;
+    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)) {
+            // TODO: Should be URL encoded
+            return "or=(".concat(ids.map(function (id) {
+                var primaryKeyParams = decodeId(id, primaryKey);
+                return "and(".concat(primaryKey
+                    .map(function (key, i) { return "".concat(key, ".eq.").concat(primaryKeyParams[i]); })
+                    .join(','), ")");
+            }), ")");
+        }
+        else {
+            return new URLSearchParams((_a = {},
+                _a[primaryKey[0]] = "in.(".concat(ids.join(','), ")"),
+                _a)).toString();
+        }
+    }
+    else {
+        // if ids is one Identifier
+        var id = ids.toString();
+        var primaryKeyParams_1 = decodeId(id, primaryKey);
+        if (isCompoundKey(primaryKey)) {
+            if (resource.startsWith('rpc/'))
+                // TODO: Should be URL encoded
+                return "".concat(primaryKey
+                    .map(function (key, i) { return "".concat(key, "=").concat(primaryKeyParams_1[i]); })
+                    .join('&'));
+            // TODO: Should be URL encoded
+            else
+                return "and=(".concat(primaryKey
+                    .map(function (key, i) {
+                    return "".concat(key, ".eq.").concat(primaryKeyParams_1[i]);
+                })
+                    .join(','), ")");
+        }
+        else {
+            return new URLSearchParams([
+                [primaryKey[0], "eq.".concat(id)],
+            ]).toString();
+        }
+    }
+};
+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(',');
+    }
+    else {
+        return "".concat(field, ".").concat(order.toLowerCase());
+    }
+};

package/lib/index.d.ts

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