Skip to content

Add support for embedded resources in ra-data-simple-rest #10898

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
djhi merged 3 commits into from
Aug 27, 2025
Merged

Add support for embedded resources in ra-data-simple-rest #10898

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
17fe861
Add support for embedded resources in ra-data-simple-rest
fzaninotto Aug 26, 2025
cfa02ad
Add support for embed in all getters
fzaninotto Aug 26, 2025
bcedd93
add tests
fzaninotto Aug 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions packages/ra-data-simple-rest/src/index.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,28 @@ describe('Data Simple REST Client', () => {

expect(result.total).toEqual(42);
});
it('should support embeds via meta', async () => {
const httpClient = jest.fn(() =>
Promise.resolve({
headers: new Headers({
'content-range': '0/4-8',
}),
})
);
const client = simpleClient('http://localhost:3000', httpClient);

await client.getList('posts', {
filter: {},
pagination: { page: 1, perPage: 10 },
sort: { field: 'title', order: 'DESC' },
meta: { embed: ['author'] },
});

expect(httpClient).toHaveBeenCalledWith(
'http://localhost:3000/posts?embed=%5B%22author%22%5D&filter=%7B%7D&range=%5B0%2C9%5D&sort=%5B%22title%22%2C%22DESC%22%5D',
{ headers: { map: { range: 'posts=0-9' } } }
);
});
});
describe('getOne', () => {
it('should allow numeric id in path', async () => {
Expand All @@ -91,6 +113,20 @@ describe('Data Simple REST Client', () => {
expect.any(Object)
);
});
it('should support embeds via meta', async () => {
const httpClient = jest.fn().mockResolvedValue({ id: 'Post#123' });
const client = simpleClient('http://localhost:3000', httpClient);

await client.getOne('posts', {
id: 'Post#123',
meta: { embed: ['author'] },
});

expect(httpClient).toHaveBeenCalledWith(
'http://localhost:3000/posts/Post%23123?embed=%5B%22author%22%5D',
expect.any(Object)
);
});
});
describe('update', () => {
it('should escape id in path', async () => {
Expand Down
43 changes: 34 additions & 9 deletions packages/ra-data-simple-rest/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,19 @@ export default (
const rangeStart = (page - 1) * perPage;
const rangeEnd = page * perPage - 1;

const query = {
const query: {
sort: string;
range: string;
filter: string;
embed?: string;
} = {
sort: JSON.stringify([field, order]),
range: JSON.stringify([rangeStart, rangeEnd]),
filter: JSON.stringify(params.filter),
};
if (params.meta && params.meta.embed) {
query.embed = JSON.stringify(params.meta.embed);
}
const url = `${apiUrl}/${resource}?${stringify(query)}`;
const options =
countHeader === 'Content-Range'
Expand Down Expand Up @@ -82,17 +90,26 @@ export default (
});
},

getOne: (resource, params) =>
httpClient(`${apiUrl}/${resource}/${encodeURIComponent(params.id)}`, {
signal: params?.signal,
}).then(({ json }) => ({
data: json,
})),
getOne: async (resource, params) => {
let query: string = '';
if (params.meta && params.meta.embed) {
query =
'?' + stringify({ embed: JSON.stringify(params.meta.embed) });
}
const { json } = await httpClient(
`${apiUrl}/${resource}/${encodeURIComponent(params.id)}${query}`,
{ signal: params?.signal }
);
return { data: json };
},

getMany: (resource, params) => {
const query = {
const query: { filter: string; embed?: string } = {
filter: JSON.stringify({ id: params.ids }),
};
if (params.meta && params.meta.embed) {
query.embed = JSON.stringify(params.meta.embed);
}
const url = `${apiUrl}/${resource}?${stringify(query)}`;
return httpClient(url, { signal: params?.signal }).then(({ json }) => ({
data: json,
Expand All @@ -106,14 +123,22 @@ export default (
const rangeStart = (page - 1) * perPage;
const rangeEnd = page * perPage - 1;

const query = {
const query: {
sort: string;
range: string;
filter: string;
embed?: string;
} = {
sort: JSON.stringify([field, order]),
range: JSON.stringify([(page - 1) * perPage, page * perPage - 1]),
filter: JSON.stringify({
...params.filter,
[params.target]: params.id,
}),
};
if (params.meta && params.meta.embed) {
query.embed = JSON.stringify(params.meta.embed);
}
const url = `${apiUrl}/${resource}?${stringify(query)}`;
const options =
countHeader === 'Content-Range'
Expand Down
Loading