@raphiniert/ra-data-postgrest 2.0.0 → 2.2.0

package/lib/index.js

@@ -17,6 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.defaultSchema = exports.defaultPrimaryKeys = void 0;
 var urlBuilder_1 = require("./urlBuilder");
 var qs_1 = __importDefault(require("qs"));
+var isEqual_1 = __importDefault(require("lodash/isEqual"));
 exports.defaultPrimaryKeys = new Map();
 var defaultSchema = function () { return ''; };
 exports.defaultSchema = defaultSchema;
@@ -65,7 +66,7 @@ exports.default = (function (config) { return ({
         return config.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?");
+                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.dataWithVirtualId)(obj, primaryKey); }),
@@ -121,7 +122,7 @@ exports.default = (function (config) { return ({
         var primaryKey = (0, urlBuilder_1.getPrimaryKey)(resource, config.primaryKeys);
         var metaSchema = (_b = params.meta) === null || _b === void 0 ? void 0 : _b.schema;
         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);
+            ? __assign((_a = {}, _a[params.target] = "eq.".concat(params.id), _a.order = (0, urlBuilder_1.getOrderBy)(field, order, primaryKey, config.sortOrder), _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;
         }
@@ -133,7 +134,7 @@ exports.default = (function (config) { return ({
         return config.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?");
+                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.dataWithVirtualId)(data, primaryKey); }),
@@ -144,12 +145,13 @@ exports.default = (function (config) { return ({
     update: function (resource, params) {
         var _a, _b;
         if (params === void 0) { params = {}; }
-        var id = params.id, data = params.data, meta = params.meta;
+        var id = params.id, data = params.data, meta = params.meta, previousData = params.previousData;
         var primaryKey = (0, urlBuilder_1.getPrimaryKey)(resource, config.primaryKeys);
         var query = (0, urlBuilder_1.getQuery)(primaryKey, id, resource, meta);
         var url = "".concat(config.apiUrl, "/").concat(resource, "?").concat(qs_1.default.stringify(query));
+        var changedData = getChanges(data, previousData);
         var metaSchema = (_a = params.meta) === null || _a === void 0 ? void 0 : _a.schema;
-        var body = JSON.stringify(__assign({}, (0, urlBuilder_1.dataWithoutVirtualId)((0, urlBuilder_1.removePrimaryKey)(data, primaryKey), primaryKey)));
+        var body = JSON.stringify(__assign({}, (0, urlBuilder_1.dataWithoutVirtualId)((0, urlBuilder_1.removePrimaryKey)(changedData, primaryKey), primaryKey)));
         return config
             .httpClient(url, {
             method: 'PATCH',
@@ -248,3 +250,12 @@ exports.default = (function (config) { return ({
         });
     },
 }); });
+var getChanges = function (data, previousData) {
+    var changes = Object.keys(data).reduce(function (changes, key) {
+        if (!(0, isEqual_1.default)(data[key], previousData[key])) {
+            changes[key] = data[key];
+        }
+        return changes;
+    }, {});
+    return changes;
+};

package/lib/urlBuilder.d.ts

@@ -18,5 +18,11 @@ export declare const removePrimaryKey: (data: any, primaryKey: PrimaryKey) => an
 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 declare enum PostgRestSortOrder {
+    AscendingNullsLastDescendingNullsFirst = "asc,desc",
+    AscendingNullsLastDescendingNullsLast = "asc,desc.nullslast",
+    AscendingNullsFirstDescendingNullsFirst = "asc.nullsfirst,desc",
+    AscendingNullsFirstDescendingNullsLast = "asc.nullsfirst,desc.nullslast"
+}
+export declare const getOrderBy: (field: string, order: string, primaryKey: PrimaryKey, sortOrder?: PostgRestSortOrder) => string;
 export {};

package/lib/urlBuilder.js

@@ -22,7 +22,7 @@ var __rest = (this && this.__rest) || function (s, e) {
     return t;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getOrderBy = exports.getQuery = exports.dataWithoutVirtualId = exports.dataWithVirtualId = exports.removePrimaryKey = exports.encodeId = exports.decodeId = exports.getPrimaryKey = exports.parseFilters = void 0;
+exports.getOrderBy = exports.PostgRestSortOrder = 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)
@@ -269,12 +269,21 @@ var getQuery = function (primaryKey, ids, resource, meta) {
     return result;
 };
 exports.getQuery = getQuery;
-var getOrderBy = function (field, order, primaryKey) {
+var PostgRestSortOrder;
+(function (PostgRestSortOrder) {
+    PostgRestSortOrder["AscendingNullsLastDescendingNullsFirst"] = "asc,desc";
+    PostgRestSortOrder["AscendingNullsLastDescendingNullsLast"] = "asc,desc.nullslast";
+    PostgRestSortOrder["AscendingNullsFirstDescendingNullsFirst"] = "asc.nullsfirst,desc";
+    PostgRestSortOrder["AscendingNullsFirstDescendingNullsLast"] = "asc.nullsfirst,desc.nullslast";
+})(PostgRestSortOrder || (exports.PostgRestSortOrder = PostgRestSortOrder = {}));
+var getOrderBy = function (field, order, primaryKey, sortOrder) {
+    if (sortOrder === void 0) { sortOrder = PostgRestSortOrder.AscendingNullsLastDescendingNullsFirst; }
+    var postgRestOrder = sortOrder.split(',')[order === 'ASC' ? 0 : 1];
     if (field == 'id') {
-        return primaryKey.map(function (key) { return "".concat(key, ".").concat(order.toLowerCase()); }).join(',');
+        return primaryKey.map(function (key) { return "".concat(key, ".").concat(postgRestOrder); }).join(',');
     }
     else {
-        return "".concat(field, ".").concat(order.toLowerCase());
+        return "".concat(field, ".").concat(postgRestOrder);
     }
 };
 exports.getOrderBy = getOrderBy;

package/package.json

@@ -1,50 +1,51 @@
-{
-    "name": "@raphiniert/ra-data-postgrest",
-    "version": "2.0.0",
-    "description": "postgREST data provider for react-admin",
-    "main": "lib/index.js",
-    "module": "esm/index.js",
-    "sideEffects": false,
-    "files": [
-        "*.md",
-        "lib",
-        "esm",
-        "src"
-    ],
-    "authors": [
-        "Raphael Scheible"
-    ],
-    "repository": "raphiniert-com/ra-data-postgrest",
-    "homepage": "https://github.com/raphiniert-com/ra-data-postgrest",
-    "bugs": "https://github.com/raphiniert-com/ra-data-postgrest/issues",
-    "license": "MIT",
-    "scripts": {
-        "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",
-        "prettier": "prettier --config ./.prettierrc.js --write --list-different \"src/**/*.{js,json,ts,tsx,css,md}\""
-    },
-    "devDependencies": {
-        "@types/jest": "^29.5.11",
-        "@types/qs": "^6.9.11",
-        "cross-env": "^7.0.3",
-        "eslint-config-prettier": "^9.1.0",
-        "eslint-plugin-prettier": "^5.0.1",
-        "install-peers-cli": "^2.2.0",
-        "jest": "^29.7.0",
-        "prettier": "^3.1.1",
-        "rimraf": "^5.0.0",
-        "ts-jest": "^29.1.1",
-        "typescript": "^5.3.3"
-    },
-    "peerDependencies": {
-        "ra-core": "^4.1.0"
-    },
-    "dependencies": {
-        "qs": "^6.11.1"
-    }
-}
+{
+    "name": "@raphiniert/ra-data-postgrest",
+    "version": "2.2.0",
+    "description": "postgREST data provider for react-admin",
+    "main": "lib/index.js",
+    "module": "esm/index.js",
+    "sideEffects": false,
+    "files": [
+        "*.md",
+        "lib",
+        "esm",
+        "src"
+    ],
+    "authors": [
+        "Raphael Scheible"
+    ],
+    "repository": "raphiniert-com/ra-data-postgrest",
+    "homepage": "https://github.com/raphiniert-com/ra-data-postgrest",
+    "bugs": "https://github.com/raphiniert-com/ra-data-postgrest/issues",
+    "license": "MIT",
+    "scripts": {
+        "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",
+        "prettier": "prettier --config ./.prettierrc.js --write --list-different \"src/**/*.{js,json,ts,tsx,css,md}\""
+    },
+    "devDependencies": {
+        "@types/jest": "^29.5.11",
+        "@types/qs": "^6.9.11",
+        "cross-env": "^7.0.3",
+        "eslint-config-prettier": "^9.1.0",
+        "eslint-plugin-prettier": "^5.0.1",
+        "install-peers-cli": "^2.2.0",
+        "jest": "^29.7.0",
+        "prettier": "^3.1.1",
+        "rimraf": "^5.0.0",
+        "ts-jest": "^29.1.1",
+        "typescript": "^5.3.3"
+    },
+    "peerDependencies": {
+        "ra-core": "^4.1.0"
+    },
+    "dependencies": {
+        "lodash.isequal": "^4.5.0",
+        "qs": "^6.11.1"
+    }
+}