GraphQL allows to ask for what you need and get exactly that. But what about the shape?
GraphQL Lodash gives you the power of lodash right inside your GraphQL Query using @_ directive.
Note: This is an experimental project created to explore the concept of Query and transformation collocation.
We encourage you to try it inside our demo or check detailed walkthrough.
Example queries
Here are a few query examples you can run against StartWars API:
Find the planet with the biggest population
Get gender statistics
Map characters to films they are featured in
Install
npm install --save graphql-lodash
or
yarn add graphql-lodash
API
graphqlLodash(query, [operationName])
query (required) - query string or query AST
operationName (optional) - required only if the query contains multiple operations
Returns
{
query: string|object,
transform: Function
}
query - the original query with stripped @_ directives
transform - function that receives response.data as a single argument and returns
the same data in the intended shape.
Usage Examples
The simplest way to integrate graphql-lodash is to write wrapper function for graphql client of you choice:
import{graphqlLodash}from'graphql-lodash';functionlodashQuery(queryWithLodash){let{ query, transform }=graphqlLodash(queryWithLodash);// Make a GraphQL call using 'query' variable as a query// And place result in 'result' variable
...
result.data=transform(result.data);returnresult;}
When using with Apollo you can use props option to apply transformations:
constrawQuery=gql` # query with @_ directives`;const{query, transform}=graphqlLodash(rawQuery);exportdefaultgraphql(query,{props: (props)=>({...props,rawData: props.data,data: transform(props.data)})})(Component);
You can write a simple wrapper for simplicity:
import{graphql}from'react-apollo';import{graphqlLodash}from'graphql-lodash';exportfunctiongqlLodash(rawQuery,config){const{query, transform}=graphqlLodash(rawQuery);letorigProps=(config&&config.props)||((props)=>props);return(comp)=>graphql(query,{...config,props: (props)=>origProps({
...props,rawData: props.data,data: transform(props.data)})})(comp);}// then use as bellowexportdefaultgqlLodash(query)(Component);
Just replace graphql with gqlLodash and you are ready to use lodash in your queries.
Check out the react-apollo-lodash-demo repo.
You can also do the transformation inside an Apollo
Link by rewriting the
parsed GraphQL Document:
Chaining this link with the other links passed to your ApolloClient
will apply the transformation to every query that
Apollo runs, such as those from the <Query /> component or
subscriptions.
Introspection queries
If your application uses introspection queries (like GraphiQL does to
get documentation and autocomplete information), you will also need to
extend the introspection query result with the directives from
graphql-lodash. One way you could do this is:
import{buildClientSchema,extendSchema,graphqlSync,introspectionQuery,}from'graphql';// inside the above ApolloLink functionif(response.data&&response.data.__schema){constschema=extendSchema(buildClientSchema(response.data),lodashDirectiveAST,);returngraphqlSync(schema,introspectionQuery);}
See the demo/ source in this repo for another example of modifying
the introspection query result.
Usage on server side
In theory, this tool can be used on the server. But this will break the contract and, most likely,
will break all the GraphQL tooling you use. Use it on server-side only if you know what you do.
请发表评论