tomberek / aor-postgrest-client

postREST client for admin-on-rest

postgREST Client for admin-on-rest

For using postgREST with admin-on-rest, use the postgrestClient function to convert AOR's REST dialect into one compatible with postgREST.

Installation

npm install aor-postgrest-client --save

Usage

See the example in App.js.example

// in src/App.js
import React from 'react';
import { Admin, Resource } from 'react-admin';
import postgrestClient from 'aor-postgrest-client';
import { List, Datagrid, TextField, NumberField } from 'react-admin';

import { ShowButton, EditButton, Edit, SimpleForm, DisabledInput, TextInput, NumberInput } from 'react-admin';
import { Create} from 'react-admin';
import { Show, SimpleShowLayout } from 'react-admin';

const BookList = (props) => (
    <List {...props}>
        <Datagrid>
            <ShowButton />
            <EditButton />
            <TextField source="author" />
            <NumberField source="count" />
        </Datagrid>
    </List>
);
export const BookShow = (props) => (
    <Show {...props}>
        <SimpleShowLayout>
            <TextField source="author" />
            <NumberField source="count" />
        </SimpleShowLayout>
    </Show>
);
export const BookEdit = (props) => (
    <Edit {...props}>
        <SimpleForm>
            <DisabledInput source="id" />
            <TextInput source="author" />
            <NumberInput source="count" />
        </SimpleForm>
    </Edit>
);
export const BookCreate = (props) => (
    <Create {...props}>
        <SimpleForm>
            <TextInput source="author" />
            <NumberInput source="count" />
        </SimpleForm>
    </Create>
);
const App = () => (
    <Admin dataProvider={postgrestClient('http://localhost:3000')}>
        <Resource name="books" show={BookShow} create={BookCreate} edit={BookEdit} list={BookList} />
    </Admin>
);

export default App;

License

This library is licensed under the MIT Licence, and sponsored by tomberek.

aor-postgrest-client's Issues

Foreign Key Picker?

Front end dev here feeling a bit out of my depth, but...Postgrest appears to support a syntax to join or get values from the matching foreign key. I'm using a nice app on desktop called Postico which allows you to lookup the foreign key values (and filter on them in the paid version).

Postgrest docs example:
GET /films?select=title,directors(id,last_name)

If I am for instance building a plant database, I have a plant_table with a row of Broccoli of ID 5 which belongs to plant family of Brassicas (ID: 1), when I create or edit this plant I would like to be able to type in "br" and see Brassicas listed, which once selected maps to the correct foreign key of ID: 1.

The following works, obviously:

export const PlantEdit = (props) => (
    <Edit {...props}>
        <SimpleForm>
            <TextInput source="name" />
            <NumberInput source="plant_family_f" />
        </SimpleForm>
    </Edit>
);

This doesn't work, for various reasons.

export const PlantEdit = (props) => (
    <Edit {...props}>
        <SimpleForm>
            <TextInput source="name" />
            <AutocompleteInput source="plant_family_f" options="plant_family_f(id,name)"/>
        </SimpleForm>
    </Edit>
);

Is what I'm trying to do possible out of the box, or am I going to have to maintain a separate dictionary for the foreign key values or something in my front end code?

npm run build fails to minify

I'm using create-react-app for bootstrapping my application and it fails to build when this package is added. Here is what they say in docs:

https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md#npm-run-build-fails-to-minify

Resolves too many React dependencies when used with admin-on-rest 1.3.2

When using admin-on-rest 1.3.2 with this package, it causes admin-on-rest@^0.7.0 to be loaded with an older, conflicting version of React. This prevents the app from starting.

This does not apply to current trunk, which does not support the new REST response format, but it will once #2 is fixed -- possibly by accepting PR #3.

ra-postgrest-client

Hello, I'm trying to get "ra-postgrest-clien" to work, which I installed by https://www.npmjs.com/package/ra-postgrest-client, but I'm returning the error: index.js: 1375 Warning: Missing translation for key: "Can not read property 'length' of null"
How can you solve it?

Tks!!!!

Module not found with admin-on-rest

Im looking forward to using this client with admin-on-rest 0.7.2 version

I'm on Fedora 25 x86_64 with npm 3.10.10 and node 6.9.4

My sec/App.js looks like -

// in src/App.js
import React from 'react';
import { Admin, Resource } from 'admin-on-rest';
import postgrestClient from 'aor-postgrest-client';
import { CityList } from './geo_city';

const App = () => (
    <Admin restClient={postgrestClient('http://localhost:3000')}>
        <Resource name="geo_city" list={CityList} />
    </Admin>
);

export default App;

and I get

Failed to compile.

Error in ./src/App.js
Module not found: 'aor-postgrest-client' in /home/xxx/src/test-admin/test-admin/src

 @ ./src/App.js 14:26-57

aor-postgrest-client is installed in node_modules/aor-postgrest-client/

Copy repo into tomberek/ra-postgrest-client

A few weeks back I upgraded from admin-on-rest to react-admin. I had to change a few things to this postgrest client in order for it to be compatible with react-admin.

Care to copy this repo into tomberek/ra-postgrest-client?

Afterwards, I will propose some PR's to it with the changes I had to make.

Semicolon replace issue

aor-postgrest-client/src/index.js

Line 35 in bb78191

rest[key]='ilike.*' + filters[key].replace(/:/,'') + '*';

For some reason, semicolons are replaced from the search field. This is a problem when you want to create a search-by-mac-address field for example.

Is ReferenceField not implemented?

Whenever I try to use react-admin's ReferenceField component, the client logs the error below:
"Cannot read property 'data' of undefined"

Is this feature not implemented yet & if not, is this something you're wanting a developer to work on to submit a PR?

Add data property to all responses

The future release of admin-on-rest changes the expected format for REST responses (see https://github.com/marmelab/admin-on-rest/pull/385). It should be released within 2 weeks.

You need to release a new major version of aor-postgrest-client to take this change into account.

Wrong call for GET_MANY

PostgREST expects braces around the list of ids even if it's only one (eg. "id=in.(1)"). Currently "convertRESTRequestToHTTP" creates a request without the braces. Hence, PostgREST returns an error.

Here's the fix:
case _reactAdmin.GET_MANY:
{
url = apiUrl + '/' + resource + '?id=in.(' + params.ids.join(',') + ')';
break;
}