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

package/lib/index.js

@@ -1,10 +1,247 @@
 "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 __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;
+var ra_core_1 = require("ra-core");
+var urlBuilder_1 = require("./urlBuilder");
+var qs_1 = __importDefault(require("qs"));
+/**
+ * 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;
+ */
+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 _a;
+            if (params === void 0) { params = {}; }
+            var primaryKey = (0, urlBuilder_1.getPrimaryKey)(resource, primaryKeys);
+            var _b = params.pagination, page = _b.page, perPage = _b.perPage;
+            var _c = params.sort || {}, field = _c.field, order = _c.order;
+            var _d = (0, urlBuilder_1.parseFilters)(params, defaultListOp), filter = _d.filter, select = _d.select;
+            var query = __assign({ offset: String((page - 1) * perPage), limit: String(perPage) }, filter);
+            if (field) {
+                query.order = (0, urlBuilder_1.getOrderBy)(field, order, primaryKey);
+            }
+            if (select) {
+                query.select = select;
+            }
+            // add header that Content-Range is in returned header
+            var options = {
+                headers: new Headers(__assign({ Accept: 'application/json', Prefer: 'count=exact' }, (((_a = params.meta) === null || _a === void 0 ? void 0 : _a.headers) || {}))),
+            };
+            var url = "".concat(apiUrl, "/").concat(resource, "?").concat(qs_1.default.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 (0, urlBuilder_1.dataWithId)(obj, primaryKey); }),
+                    total: parseInt(headers.get('content-range').split('/').pop(), 10),
+                };
+            });
+        },
+        getOne: function (resource, params) {
+            var _a;
+            if (params === void 0) { params = {}; }
+            var id = params.id, meta = params.meta;
+            var primaryKey = (0, urlBuilder_1.getPrimaryKey)(resource, primaryKeys);
+            var query = (0, urlBuilder_1.getQuery)(primaryKey, id, resource, meta);
+            var url = "".concat(apiUrl, "/").concat(resource, "?").concat(qs_1.default.stringify(query));
+            return httpClient(url, {
+                headers: new Headers(__assign({ accept: 'application/vnd.pgrst.object+json' }, (((_a = params.meta) === null || _a === void 0 ? void 0 : _a.headers) || {}))),
+            }).then(function (_a) {
+                var json = _a.json;
+                return ({
+                    data: (0, urlBuilder_1.dataWithId)(json, primaryKey),
+                });
+            });
+        },
+        getMany: function (resource, params) {
+            if (params === void 0) { params = {}; }
+            var ids = params.ids;
+            var primaryKey = (0, urlBuilder_1.getPrimaryKey)(resource, primaryKeys);
+            var query = (0, urlBuilder_1.getQuery)(primaryKey, ids, resource, params.meta);
+            var url = "".concat(apiUrl, "/").concat(resource, "?").concat(qs_1.default.stringify(query));
+            return httpClient(url).then(function (_a) {
+                var json = _a.json;
+                return ({
+                    data: json.map(function (data) { return (0, urlBuilder_1.dataWithId)(data, primaryKey); }),
+                });
+            });
+        },
+        getManyReference: function (resource, params) {
+            var _a;
+            var _b;
+            if (params === void 0) { params = {}; }
+            var _c = params.pagination, page = _c.page, perPage = _c.perPage;
+            var _d = params.sort, field = _d.field, order = _d.order;
+            var _e = (0, urlBuilder_1.parseFilters)(params, defaultListOp), filter = _e.filter, select = _e.select;
+            var primaryKey = (0, urlBuilder_1.getPrimaryKey)(resource, primaryKeys);
+            var query = params.target
+                ? __assign((_a = {}, _a[params.target] = "eq.".concat(params.id), _a.order = (0, urlBuilder_1.getOrderBy)(field, order, primaryKey), _a.offset = String((page - 1) * perPage), _a.limit = String(perPage), _a), filter) : __assign({ order: (0, urlBuilder_1.getOrderBy)(field, order, primaryKey), offset: String((page - 1) * perPage), limit: String(perPage) }, filter);
+            if (select) {
+                query.select = select;
+            }
+            // add header that Content-Range is in returned header
+            var options = {
+                headers: new Headers(__assign({ Accept: 'application/json', Prefer: 'count=exact' }, (((_b = params.meta) === null || _b === void 0 ? void 0 : _b.headers) || {}))),
+            };
+            var url = "".concat(apiUrl, "/").concat(resource, "?").concat(qs_1.default.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 (0, urlBuilder_1.dataWithId)(data, primaryKey); }),
+                    total: parseInt(headers.get('content-range').split('/').pop(), 10),
+                };
+            });
+        },
+        update: function (resource, params) {
+            var _a;
+            if (params === void 0) { params = {}; }
+            var id = params.id, data = params.data, meta = params.meta;
+            var primaryKey = (0, urlBuilder_1.getPrimaryKey)(resource, primaryKeys);
+            var query = (0, urlBuilder_1.getQuery)(primaryKey, id, resource, meta);
+            var primaryKeyData = (0, urlBuilder_1.getKeyData)(primaryKey, data);
+            var url = "".concat(apiUrl, "/").concat(resource, "?").concat(qs_1.default.stringify(query));
+            var body = JSON.stringify(__assign(__assign({}, data), primaryKeyData));
+            return httpClient(url, {
+                method: 'PATCH',
+                headers: new Headers(__assign({ Accept: 'application/vnd.pgrst.object+json', Prefer: 'return=representation', 'Content-Type': 'application/json' }, (((_a = params.meta) === null || _a === void 0 ? void 0 : _a.headers) || {}))),
+                body: body,
+            }).then(function (_a) {
+                var json = _a.json;
+                return ({ data: (0, urlBuilder_1.dataWithId)(json, primaryKey) });
+            });
+        },
+        updateMany: function (resource, params) {
+            var _a;
+            if (params === void 0) { params = {}; }
+            var ids = params.ids;
+            var primaryKey = (0, urlBuilder_1.getPrimaryKey)(resource, 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(apiUrl, "/").concat(resource);
+            return httpClient(url, {
+                method: 'PATCH',
+                headers: new Headers(__assign({ Prefer: 'return=representation', 'Content-Type': 'application/json' }, (((_a = params.meta) === null || _a === void 0 ? void 0 : _a.headers) || {}))),
+                body: body,
+            }).then(function (_a) {
+                var json = _a.json;
+                return ({
+                    data: json.map(function (data) { return (0, urlBuilder_1.encodeId)(data, primaryKey); }),
+                });
+            });
+        },
+        create: function (resource, params) {
+            var _a;
+            if (params === void 0) { params = {}; }
+            var primaryKey = (0, urlBuilder_1.getPrimaryKey)(resource, primaryKeys);
+            var url = "".concat(apiUrl, "/").concat(resource);
+            return httpClient(url, {
+                method: 'POST',
+                headers: new Headers(__assign({ Accept: 'application/vnd.pgrst.object+json', Prefer: 'return=representation', 'Content-Type': 'application/json' }, (((_a = params.meta) === null || _a === void 0 ? void 0 : _a.headers) || {}))),
+                body: JSON.stringify(params.data),
+            }).then(function (_a) {
+                var json = _a.json;
+                return ({
+                    data: __assign(__assign({}, json), { id: (0, urlBuilder_1.encodeId)(json, primaryKey) }),
+                });
+            });
+        },
+        delete: function (resource, params) {
+            var _a;
+            if (params === void 0) { params = {}; }
+            var id = params.id, meta = params.meta;
+            var primaryKey = (0, urlBuilder_1.getPrimaryKey)(resource, primaryKeys);
+            var query = (0, urlBuilder_1.getQuery)(primaryKey, id, resource, meta);
+            var url = "".concat(apiUrl, "/").concat(resource, "?").concat(qs_1.default.stringify(query));
+            return httpClient(url, {
+                method: 'DELETE',
+                headers: new Headers(__assign({ Accept: 'application/vnd.pgrst.object+json', Prefer: 'return=representation', 'Content-Type': 'application/json' }, (((_a = params.meta) === null || _a === void 0 ? void 0 : _a.headers) || {}))),
+            }).then(function (_a) {
+                var json = _a.json;
+                return ({ data: (0, urlBuilder_1.dataWithId)(json, primaryKey) });
+            });
+        },
+        deleteMany: function (resource, params) {
+            var _a;
+            if (params === void 0) { params = {}; }
+            var ids = params.ids, meta = params.meta;
+            var primaryKey = (0, urlBuilder_1.getPrimaryKey)(resource, primaryKeys);
+            var query = (0, urlBuilder_1.getQuery)(primaryKey, ids, resource, meta);
+            var url = "".concat(apiUrl, "/").concat(resource, "?").concat(qs_1.default.stringify(query));
+            return httpClient(url, {
+                method: 'DELETE',
+                headers: new Headers(__assign({ Prefer: 'return=representation', 'Content-Type': 'application/json' }, (((_a = params.meta) === null || _a === void 0 ? void 0 : _a.headers) || {}))),
+            }).then(function (_a) {
+                var json = _a.json;
+                return ({
+                    data: json.map(function (data) { return (0, urlBuilder_1.encodeId)(data, primaryKey); }),
+                });
+            });
+        },
+    });
+});

package/lib/urlBuilder.d.ts

@@ -0,0 +1,22 @@
+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"];
+type ParsedFiltersResult = {
+    filter: any;
+    select: any;
+};
+export type PostgRestOperator = (typeof postgrestOperators)[number];
+export declare const parseFilters: (params: any, defaultListOp: PostgRestOperator) => Partial<ParsedFiltersResult>;
+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 getOrderBy: (field: string, order: string, primaryKey: PrimaryKey) => string;
+export {};

package/lib/urlBuilder.js

@@ -0,0 +1,215 @@
+"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);
+};
+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;
+/**
+ * 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',
+];
+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 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.filter[splitKey[0]] === undefined) {
+                // first operator for the key, we add it to the dict
+                result.filter[splitKey[0]] = op;
+            }
+            else {
+                if (!Array.isArray(result[splitKey[0]])) {
+                    // second operator, we transform to an array
+                    result.filter[splitKey[0]] = [
+                        result.filter[splitKey[0]],
+                        op,
+                    ];
+                }
+                else {
+                    // third and subsequent, we add to array
+                    result.filter[splitKey[0]].push(op);
+                }
+            }
+        });
+    });
+    if (meta === null || meta === void 0 ? void 0 : meta.columns) {
+        result.select = Array.isArray(meta.columns)
+            ? meta.columns.join(',')
+            : meta.columns;
+    }
+    return result;
+};
+exports.parseFilters = parseFilters;
+var getPrimaryKey = function (resource, primaryKeys) {
+    return primaryKeys.get(resource) || ['id'];
+};
+exports.getPrimaryKey = getPrimaryKey;
+var decodeId = function (id, primaryKey) {
+    if ((0, exports.isCompoundKey)(primaryKey)) {
+        return JSON.parse(id.toString());
+    }
+    else {
+        return [id.toString()];
+    }
+};
+exports.decodeId = decodeId;
+var encodeId = function (data, primaryKey) {
+    if ((0, exports.isCompoundKey)(primaryKey)) {
+        return JSON.stringify(primaryKey.map(function (key) { return data[key]; }));
+    }
+    else {
+        return data[primaryKey[0]];
+    }
+};
+exports.encodeId = encodeId;
+var dataWithId = function (data, primaryKey) {
+    if (JSON.stringify(primaryKey) === JSON.stringify(['id'])) {
+        return data;
+    }
+    return Object.assign(data, {
+        id: (0, exports.encodeId)(data, primaryKey),
+    });
+};
+exports.dataWithId = dataWithId;
+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; }
+    var result = {};
+    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 ((0, exports.isCompoundKey)(primaryKey)) {
+            result = {
+                or: "(".concat(ids.map(function (id) {
+                    var primaryKeyParams = (0, exports.decodeId)(id, primaryKey);
+                    return "and(".concat(primaryKey
+                        .map(function (key, i) { return "".concat(key, ".eq.").concat(primaryKeyParams[i]); })
+                        .join(','), ")");
+                }), ")"),
+            };
+        }
+        else {
+            result = (_a = {},
+                _a[primaryKey[0]] = "in.(".concat(ids.join(','), ")"),
+                _a);
+        }
+    }
+    else {
+        // if ids is one Identifier
+        var id = ids.toString();
+        var primaryKeyParams_1 = (0, exports.decodeId)(id, primaryKey);
+        if ((0, exports.isCompoundKey)(primaryKey)) {
+            if (resource.startsWith('rpc/')) {
+                result = {};
+                primaryKey.map(function (key, i) {
+                    return (result[key] = "".concat(primaryKeyParams_1[i]));
+                });
+            }
+            else {
+                result = {
+                    and: "(".concat(primaryKey.map(function (key, i) {
+                        return "".concat(key, ".eq.").concat(primaryKeyParams_1[i]);
+                    }), ")"),
+                };
+            }
+        }
+        else {
+            result = (_b = {},
+                _b[primaryKey[0]] = "eq.".concat(id),
+                _b);
+        }
+    }
+    if (meta && meta.columns) {
+        result.select = Array.isArray(meta.columns)
+            ? meta.columns.join(',')
+            : meta.columns;
+    }
+    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(',');
+    }
+    else {
+        return "".concat(field, ".").concat(order.toLowerCase());
+    }
+};
+exports.getOrderBy = getOrderBy;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@raphiniert/ra-data-postgrest",
-    "version": "1.2.1",
+    "version": "2.0.0-alpha.1",
     "description": "postgREST data provider for react-admin",
     "main": "lib/index.js",
     "module": "esm/index.js",
@@ -20,19 +20,31 @@
     "bugs": "https://github.com/raphiniert-com/ra-data-postgrest/issues",
     "license": "MIT",
     "scripts": {
-        "build": "yarn run build-cjs && yarn run build-esm",
+        "coverage": "jest --coverage",
+        "test": "jest --watchAll",
+        "build": "npm run build-cjs && npm run build-esm",
         "build-cjs": "rimraf ./lib && tsc",
         "build-esm": "rimraf ./esm && tsc --outDir esm --module es2015",
         "watch": "tsc --outDir esm --module es2015 --watch",
-        "prepare": "install-peers"
+        "prepare": "install-peers",
+        "prettier": "prettier --config ./.prettierrc.js --write --list-different \"src/**/*.{js,json,ts,tsx,css,md}\""
     },
     "devDependencies": {
+        "@types/jest": "^28.1.4",
         "cross-env": "^7.0.3",
+        "eslint-config-prettier": "^8.8.0",
+        "eslint-plugin-prettier": "^4.2.1",
         "install-peers-cli": "^2.2.0",
-        "rimraf": "^3.0.2",
-        "typescript": "^4.6.4"
+        "jest": "^28.1.2",
+        "prettier": "~2.8.7",
+        "rimraf": "^4.4.1",
+        "ts-jest": "^28.0.5",
+        "typescript": "^4.9.5"
     },
     "peerDependencies": {
         "ra-core": "^4.1.0"
+    },
+    "dependencies": {
+        "qs": "^6.11.1"
     }
 }