{"_id":"@bobfang/ra-data-postgrest","_rev":"5-fcc32360d0b2521b66cbcf030ecd70c5","time":{"created":"2022-09-27T01:12:17.317Z","1.2.0":"2022-09-27T01:07:35.855Z","modified":"2022-10-20T21:22:45.318Z","1.2.1":"2022-09-27T01:12:17.693Z","1.2.2":"2022-10-20T19:23:39.207Z","1.2.3":"2022-10-20T21:22:45.240Z"},"name":"@bobfang/ra-data-postgrest","dist-tags":{"latest":"1.2.3"},"versions":{"1.2.1":{"name":"@bobfang/ra-data-postgrest","version":"1.2.1","description":"postgREST data provider for react-admin","main":"lib/index.js","module":"esm/index.js","sideEffects":false,"authors":["François Zaninotto","Raphael Scheible"],"repository":{"type":"git","url":"git+https://github.com/bobfang-com/ra-data-postgrest.git"},"homepage":"https://github.com/bobfang/ra-data-postgrest","bugs":{"url":"https://github.com/bobfang/ra-data-postgrest/issues"},"license":"MIT","scripts":{"build":"yarn run build-cjs && yarn 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"},"devDependencies":{"cross-env":"^7.0.3","install-peers-cli":"^2.2.0","rimraf":"^3.0.2","typescript":"^4.6.4"},"peerDependencies":{"ra-core":"^4.1.0"},"types":"./lib/index.d.ts","gitHead":"c0cbecbd853593dac2e9835e74a34ea94424908e","_id":"@bobfang/ra-data-postgrest@1.2.1","_nodeVersion":"18.9.0","_npmVersion":"8.19.1","dist":{"integrity":"sha512-F/lsExizobDQw33bO2BJXOD/kJziy7QhbTl5tAnoUjST0G+kGgXq75fry4mHxBSNX+tVr0rQ/sA18L529BafTg==","shasum":"6b861d2d2e92f8eb31fe1b19c0860bb58a3afe22","tarball":"https://registry.npmjs.org/@bobfang/ra-data-postgrest/-/ra-data-postgrest-1.2.1.tgz","fileCount":19,"unpackedSize":75885,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIELACFsRusnsuqgXJC32/2l9mO2Tnf514JSW+7oN+DClAiBGANSq/IQol9bg+Y17Xc3IiFjdyc7cTIJk54B+50AQ/A=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjMk3xACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoobhAAg6J4wQuzQu6tVd8Xqu3s0g0THot0n1zEbKYkhK66jTM52/n2\r\nvkwTcJLVWIx3aEyhStT5UG9hjs+GX66zo2+Hw894O6GiztTF9ChIz0XfLEJX\r\nzyBDHISskT2rGvK3/pSSmPwF6EdU3maEBpZ2Dmlh+gaE6zdx4Ik8aijlqmel\r\n9qFwVaic0JQNCtaIzFibD43LIOVg5try7FA3wenHF78zgEu1TaQ2l91XQrPC\r\nOLgY0ApfF9rUcHKsSgEVoPyGEYkKMPyfHRM6C7hiJ5oZz3nQR+85Uoi2FgJV\r\nQ+cG+gPqVcF/yviZEqQywTA2yPR2pq0OCojlqwEvSV73DTEEYjD0NRaCVBeB\r\n9RaTQW4D1C4PdJZCrvbl14HuF2MWFZU6MeQ/XMIjJJ+v/SK42BSbeDtz6FAH\r\nkHNyxUE849qdHKiLm3M3SRhN5YL1xEYXjJbpEZsmA6+62evj6VIr/ynhzTIu\r\n+YZf0gihFQIi/1wC8NKWrkdOq17qaAX+fsKgF6RDYjg8AlAR1bnsgVUDgaO6\r\nI/Ht2a5GJGBY4xkkPR4LO6DgZs9id+rDS0gAPMQaBV28p1ATNxg1rjM15oSo\r\nCbjuW04+B376Tp3ID8eNlunV0tvxOrtRG0bUbWDHLYFdLgci25eErr1+1vTp\r\n/GCZh2sedeB1codpjv3lvESVCFuXQ7s97nw=\r\n=xsnS\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"bobfang","email":"bobfang@gmail.com"},"directories":{},"maintainers":[{"name":"bobfang","email":"bobfang@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ra-data-postgrest_1.2.1_1664241137379_0.34899457900255637"},"_hasShrinkwrap":false},"1.2.2":{"name":"@bobfang/ra-data-postgrest","version":"1.2.2","description":"postgREST data provider for react-admin","main":"lib/index.js","module":"esm/index.js","sideEffects":false,"authors":["François Zaninotto","Raphael Scheible"],"repository":{"type":"git","url":"git+https://github.com/bobfang-com/ra-data-postgrest.git"},"homepage":"https://github.com/bobfang/ra-data-postgrest","bugs":{"url":"https://github.com/bobfang/ra-data-postgrest/issues"},"license":"MIT","scripts":{"build":"yarn run build-cjs && yarn 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"},"devDependencies":{"cross-env":"^7.0.3","install-peers-cli":"^2.2.0","rimraf":"^3.0.2","typescript":"^4.6.4"},"peerDependencies":{"ra-core":"^4.1.0"},"types":"./lib/index.d.ts","gitHead":"1882bf958fbc00d8e643ac17ed7df3c67cb3130d","_id":"@bobfang/ra-data-postgrest@1.2.2","_nodeVersion":"18.9.0","_npmVersion":"8.19.1","dist":{"integrity":"sha512-WMD1wgN5t152pbSna+2I31aU7aklpdVr2GejiPTeunELElYfQJPVwkJ2flNwHb6McOmjACCKjhU5HR2JkMUS1Q==","shasum":"9c7ad0824ada6573bab84872d2f899cff9a84c13","tarball":"https://registry.npmjs.org/@bobfang/ra-data-postgrest/-/ra-data-postgrest-1.2.2.tgz","fileCount":19,"unpackedSize":76622,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFumeYRMhwvBMbW9zet6DxPcQrYJybak8yJCy8id80C0AiEA7vCpoFqsyW9Xo0CV6Fuzzjf8kXpIGyLZQ8ZgtktATEA="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjUaA7ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmo11g//VDvsFCQni6H5uXj4/doKPUqV3zD+hPpEIjtXZGtdLPri2dXz\r\nS1buwPA0vYnwIG8Xd0v/EeuEIY0IFl63NCW8r9an+7XN/BQ8KHkCP4pG8Xjm\r\nYSR9Cwdolcz+jAAAPTrGrD1LqnZI9FMMiPcmu97ftOsFgWgGqoXFpfsC8K0+\r\nDfHwgfkXH7Pl7l4a5VMnWxAMzYQ5lyOmncqA/6+90SmcB0EVERd/v41RF8ZH\r\n4qgAOksEfDc7+6krxAfDzwOyfhfCQEYZpD+i4fXlbSgZdsAdzmQPJTIbv8VS\r\nvhauBS+VnDvaSK1p0vXJMBf7a2jOlvY9FV6yj2OXmMbxTBW1rV/oveF0XfFe\r\nx8tT5nUTmkImZsiqY8xmNf/9y1XxXUOzwyvIjYMHVuiHEI9qX3otWMHmg6wD\r\nQJMluoyeHMcN0fdKOfgV9Fhc60pPGuA7xXJ3KRJFALXz/yaF+NJfMBgrqJC6\r\n0f+Ki/geAkSC1knurNtTXQXUX0cpoV3lW3Fn51Tozq+sXRv0AF4jBzlNPTSz\r\n351UQt0cngrUPgNNb6B1L/1nAqGFbjFzR4a7n2UF/OJUhRYO8Co+w7BY37fT\r\n4RVkZM+DRaujCO+poaXBNBLOG10pTL+cU5l4krZIclsvXTPu/rYjfEHSR412\r\nDR9ysml9k+IwioqlJeEYFyu4DFNTUfcRWFc=\r\n=2HyJ\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"bobfang","email":"bobfang@gmail.com"},"directories":{},"maintainers":[{"name":"bobfang","email":"bobfang@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ra-data-postgrest_1.2.2_1666293819048_0.18565953471185948"},"_hasShrinkwrap":false},"1.2.3":{"name":"@bobfang/ra-data-postgrest","version":"1.2.3","description":"postgREST data provider for react-admin","main":"lib/index.js","module":"esm/index.js","sideEffects":false,"authors":["François Zaninotto","Raphael Scheible"],"repository":{"type":"git","url":"git+https://github.com/bobfang-com/ra-data-postgrest.git"},"homepage":"https://github.com/bobfang/ra-data-postgrest","bugs":{"url":"https://github.com/bobfang/ra-data-postgrest/issues"},"license":"MIT","scripts":{"build":"yarn run build-cjs && yarn 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"},"devDependencies":{"cross-env":"^7.0.3","install-peers-cli":"^2.2.0","rimraf":"^3.0.2","typescript":"^4.6.4"},"peerDependencies":{"ra-core":"^4.1.0"},"types":"./lib/index.d.ts","gitHead":"60e385b2c5293b7381c4b300e449bcf3e5e24af0","_id":"@bobfang/ra-data-postgrest@1.2.3","_nodeVersion":"18.9.0","_npmVersion":"8.19.1","dist":{"integrity":"sha512-mxE6eVzEwkH3DuohP3egbTAwxnMoDMU/cErxifMH3NzbcaiAtmlRucNqh2G+4HRCB2mblQIPoSYKz01DWbejKg==","shasum":"a29ec3db7e4ecd5d3a03c8e59ef8c9e47045033f","tarball":"https://registry.npmjs.org/@bobfang/ra-data-postgrest/-/ra-data-postgrest-1.2.3.tgz","fileCount":19,"unpackedSize":77348,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIDkuJoKNDQ9FaYSuWMCH0Tg6H6ZQIAsSPhUiJp2gnissAiATZJ72ssWQ/W4niPznw3RvVic2N29r5dT1mTpXP7PnOw=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjUbwlACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqJWA/9EwHrchIkeZbvimdsKOBBvXllK6/IwyQ30GE+lhIO3ptfr2az\r\nTtVKjfXu2pqPMEeDUahd4PMi6AUzVNOgo5AvcZEnhnZXbD/yml0UhwC8VjKh\r\nRNw+KXJPaLso+XUfBfn8PArCUtcJ34UC15LhrwZj3x1NtouKf1CjrTS7/+/Y\r\n8/DyXWt9iELhZ6CRH5FNTcAuv3J5m9Dge+FVx12gLnbf2Z9YHQGe9r3X1O/4\r\niri5ToeQi52rQ5fw+mQQVdVkmoyzmJGcUXYmqaHCNgKj0M98ZSYCyMYq5tXE\r\nadO53sLaQmo+tlK27XLYusQ98r4g7OdvGHty4W0Xmn1KMeL76gTroZQsBDhp\r\nKYnRur8Qjm/DKvY+Ja8zWWUiOh/8bumXVpn+f7nbOPUdvcLDHfrNURbNWk9p\r\n6ENUJKCyQG6YmPJONQY3qWJUdcf47znCR7FZauabF0NKYq0az1vDpxIInAOk\r\nxjN154S0eAx6YyI3tWOuphGPol32A9LbnzVfkN0j6kX5QkkvCLCNZYkPc+V4\r\nECEEIXg+V0QmehthapY1UnhuHGVc8T0KnG1In9inawK0qvNzvxZuiOLC5sYn\r\n1Qj0Ve4+R2lV8IeJ+hZlFxME1UGvDfw+SI4Nll12qKIgmmzDwuvnUBY/E8T0\r\nlPccRWLl0R8AwevQpfmpcu9m1m2RCStu83k=\r\n=BeXM\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"bobfang","email":"bobfang@gmail.com"},"directories":{},"maintainers":[{"name":"bobfang","email":"bobfang@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ra-data-postgrest_1.2.3_1666300965034_0.2596634084646392"},"_hasShrinkwrap":false}},"maintainers":[{"name":"bobfang","email":"bobfang@gmail.com"}],"description":"postgREST data provider for react-admin","homepage":"https://github.com/bobfang/ra-data-postgrest","repository":{"type":"git","url":"git+https://github.com/bobfang-com/ra-data-postgrest.git"},"bugs":{"url":"https://github.com/bobfang/ra-data-postgrest/issues"},"license":"MIT","readme":"# PostgREST Data Provider For React-Admin\n\nPostgREST Data Provider for [react-admin](https://github.com/marmelab/react-admin), the frontend framework for building admin applications on top of REST/GraphQL services.\n\n## Installation\n\n```sh\nnpm install --save @promitheus/ra-data-postgrest\n```\n\n**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.\n\n## REST Dialect\n\nThis 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).\n\n| Method             | API calls\n|--------------------|----------------------------------------------------------------\n| `getList`          | `GET http://my.api.url/posts?order=title.asc&offset=0&limit=24&filterField=eq.value`\n| `getOne`           | `GET http://my.api.url/posts?id=eq.123`\n| `getMany`          | `GET http://my.api.url/posts?id=in.(123,456,789)`\n| `getManyReference` | `GET http://my.api.url/posts?author_id=eq.345`\n| `create`           | `POST http://my.api.url/posts`\n| `update`           | `PATCH http://my.api.url/posts?id=eq.123`\n| `updateMany`       | `PATCH http://my.api.url/posts?id=in.(123,456,789)`\n| `delete`           | `DELETE http://my.api.url/posts?id=eq.123`\n| `deleteMany`       | `DELETE http://my.api.url/posts?id=in.(123,456,789)`\n\n**Note**: The PostgREST data provider expects the API to include a `Content-Range` header in the response to `getList` calls. The value must be the total number of resources in the collection. This allows react-admin to know how many pages of resources there are in total, and build the pagination controls.\n\n```\nContent-Range: posts 0-24/319\n```\n\nIf your API is on another domain as the JS code, you'll need to whitelist this header with an `Access-Control-Expose-Headers` [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS) header.\n\n```\nAccess-Control-Expose-Headers: Content-Range\n```\n\n## Usage\n\n```jsx\n// in src/App.js\nimport React from 'react';\nimport { Admin, Resource } from 'react-admin';\nimport postgrestRestProvider from '@promitheus/ra-data-postgrest';\n\nimport { PostList } from './posts';\n\nconst App = () => (\n    <Admin dataProvider={postgrestRestProvider('http://path.to.my.api/')}>\n        <Resource name=\"posts\" list={PostList} />\n    </Admin>\n);\n\nexport default App;\n```\n\n### Adding Custom Headers\n\nThe provider function accepts an HTTP client function as second argument. By default, they use react-admin's `fetchUtils.fetchJson()` as HTTP client. It's similar to HTML5 `fetch()`, except it handles JSON decoding and HTTP error codes automatically.\n\nThat means that if you need to add custom headers to your requests, you just need to *wrap* the `fetchJson()` call inside your own function:\n\n```jsx\nimport { fetchUtils, Admin, Resource } from 'react-admin';\nimport postgrestRestProvider from '@promitheus/ra-data-postgrest';\n\nconst httpClient = (url, options = {}) => {\n    if (!options.headers) {\n        options.headers = new Headers({ Accept: 'application/json' });\n    }\n    // add your own headers here\n    options.headers.set('X-Custom-Header', 'foobar');\n    return fetchUtils.fetchJson(url, options);\n};\nconst dataProvider = postgrestRestProvider('http://localhost:3000', httpClient);\n\nrender(\n    <Admin dataProvider={dataProvider} title=\"Example Admin\">\n       ...\n    </Admin>,\n    document.getElementById('root')\n);\n```\n\nNow all the requests to the REST API will contain the `X-Custom-Header: foobar` header.\n\n**Tip**: The most common usage of custom headers is for authentication. `fetchJson` has built-on support for the `Authorization` token header:\n\n```js\nconst httpClient = (url, options = {}) => {\n    options.user = {\n        authenticated: true,\n        token: 'SRTRDFVESGNJYTUKTYTHRG'\n    };\n    return fetchUtils.fetchJson(url, options);\n};\n```\n\nNow all the requests to the REST API will contain the `Authorization: SRTRDFVESGNJYTUKTYTHRG` header.\n\n### Using authProvider\nThis package also comes with an [authProvider](https://github.com/marmelab/react-admin/blob/master/docs/Authentication.md) for react-admin which enables you to enable authentification. The provider is designed to work together with [subzero-starter-kit](https://github.com/subzerocloud/subzero-starter-kit). This starter kit sends the JWT within a session cookie. The authProvider expects that. If you want to use postgREST without the starter kit you'll need to write your own. Feel free to contribute!\n\nWith one of the starter kits it is very easy to use the authProvider:\n```jsx\n// in src/App.js\nimport React from 'react';\nimport { Admin, Resource } from 'react-admin';\nimport postgrestRestProvider, { authProvider } from '@promitheus/ra-data-postgrest';\n\nimport { PostList } from './posts';\n\nconst App = () => (\n    <Admin dataProvider={postgrestRestProvider('http://path.to.my.api/')} \n           authProvider={authProvider}>\n        <Resource name=\"posts\" list={PostList} />\n    </Admin>\n);\n\nexport default App;\n```\n\n### Special Filter Feature\nAs postgRest allows several comparators, e.g. `ilike`, `like`, `eq`... \nThe dataProvider is designed to enable you to specify the comparator in your react filter component:\n\n```jsx\n<Filter {...props}>\n  <TextInput label=\"Search\" source=\"post_title@ilike\" alwaysOn />\n  <TextInput label=\"Search\" source=\"post_author\" alwaysOn />\n  // some more filters\n</Filter>\n```\n\nOne 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.\n\n#### RPC Functions\nGiven a RPC call as ```GET /rpc/add_them?post_author=Herbert HTTP/1.1```, the dataProvider allows you to filter such endpoints. As they are no view, but a SQL procedure, several postgREST features do not apply. I.e. no comparators such as `ilike`, `like`, `eq` are applicable. Only the raw value without comparator needs to be send to the API. In order to realize this behavior, just add an \"empty\" comparator to the field, i.e. end `source` with an `@` as in the example:\n\n```jsx\n<Filter {...props}>\n  <TextInput label=\"Search\" source=\"post_author@\" alwaysOn />\n  // some more filters\n</Filter>\n```\n\n### Compound primary keys\nIf 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:\n\n```jsx\nconst dataProvider = postgrestRestProvider(API_URL, fetchUtils.fetchJson, 'eq', new Map([\n  ['some_table',    ['custom_id']],\n  ['another_table', ['first_column', 'second_column']],\n]));\n```\n\n## License\n\nThis data provider is licensed under the MIT License and sponsored by [raphiniert.com](https://raphiniert.com).\n","readmeFilename":"README.md"}