Registry / database / ra-data-graphql-amplication

ra-data-graphql-amplication

library1.0.2jsnpmunverified

A GraphQL data provider for react-admin (v5.x), built by Amplication to work with Amplication-generated GraphQL APIs. Currently at v1.0.2, this package wraps the standard ra-data-graphql-simple but adds Amplication-specific query batching and filtering conventions. It requires graphql ^15.6.0 and ra-core ^5.1.4 as peer dependencies. Key differentiator: optimized for Amplication's CRUD endpoints out of the box, with auto-generated IDs and sorting.

database

npm install ra-data-graphql-amplication

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · RA-DATA-GRAPHQL-AM

ra-data-graphql-amplication

databasejavascriptv1.0.2

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default

✓ import buildAmplicationProvider from 'ra-data-graphql-amplication';

✗ import { buildAmplicationProvider } from 'ra-data-graphql-amplication';

This is a default export, not a named export. Common mistake is to destructure it.

buildAmplicationProvider

✓ import buildAmplicationProvider from 'ra-data-graphql-amplication';

✗ const buildAmplicationProvider = require('ra-data-graphql-amplication');

This package is ESM-only; CJS require() will fail with 'ERR_REQUIRE_ESM'.

TypeScript

✓ import type { BuildOptions } from 'ra-data-graphql-amplication';

Types are exported; use import type for type-only imports in TS.

Shows how to set up the Amplication GraphQL data provider with a React Admin v5 application.

import React from 'react'; import { Admin, Resource, ListGuesser } from 'react-admin'; import buildAmplicationProvider from 'ra-data-graphql-amplication'; const dataProvider = await buildAmplicationProvider({ clientOptions: { uri: 'http://localhost:3000/graphql' }, // Optional: override query/mutation }); const App = () => ( <Admin dataProvider={dataProvider}> <Resource name="Customer" list={ListGuesser} /> </Admin> ); export default App;

Debug

Known issues

breakingRequires react-admin >=5.0 - incompatible with react-admin v4 or earlier.

fix

Upgrade react-admin to v5 or use ra-data-graphql-amplication@0.x for v4.

affects: >=1.0

gotchaThe provider expects Amplication-generated schema; custom GraphQL servers may not work.

fix

Use buildGraphQLProvider from ra-data-graphql-simple for custom schemas.

affects: >=1.0

deprecatedbuildAmplicationProvider may receive breaking changes in minor releases.

fix

Pin version to exact minor and test upgrades.

affects: <2.0

Errors

Common errors & fixes

Cannot find module 'ra-data-graphql-amplication'

Package not installed or missing from package.json

fix

npm install ra-data-graphql-amplication react-admin@^5.1 graphql@^15.6

ERR_REQUIRE_ESM: require() of ES Module not supported

Using CommonJS require() in a Node.js environment without ESM support

fix

Use dynamic import() or enable ESM in your project: {"type": "module"} in package.json.

Cannot use GraphQL field 'id' - Amplication expects 'id' field

Amplication's generated API uses a different ID field than your GraphQL schema

fix

Ensure your GraphQL schema exposes 'id' field on all types, or override the field mapping in options.

Upgrade

Version history

1.0.2latest on npm

Audit

Dependencies

graphqlrequiredPeer dependency required for GraphQL operations.

ra-corerequiredPeer dependency required as base for react-admin integration.

Agent activity

12 hits · last 30 days

node

Amazon

Resources

githubhttps://github.com/amplication/amplication ↗

packagera-data-graphql-amplication ↗

homepagehttps://amplication.com ↗