artemis 1.0.1

Artemis

Build dart types from GraphQL schemas and queries

Pub Package GitHub Actions

Artemis is a code generator that looks for *.schema.json (GraphQL Introspection Query response data) and *.graphql files and builds .dart files typing that query, based on the schema. That's similar to what Apollo does (Artemis is his sister anyway).


Installation #

Add the following to your pubspec.yaml file:

dependencies:
  artemis: <1.0.0

dev_dependencies:
  build_runner: ^1.5.0
  json_serializable: ^3.0.0

ℹ️ Note that build_runner and json_serializable are required on dev_dependencies!

ℹ️ If you're not using ArtemisClient, the lib can be included on dev_dependencies instead.

Then run:

pub packages get

or

flutter packages get

Now Artemis will generate the API files for you by running:

pub run build_runner build

or

flutter pub run build_runner build

Configuration #

Artemis offers some configuration options to generate code. All options should be included on build.yaml file on the root of the project:

targets:
  $default:
    builders:
      artemis:
        options:
          # custom configuration options!
OptionDefault valueDescription
generate_helperstrueIf Artemis should generate query/mutation helper GraphQLQuery subclasses.
custom_parser_importnullImport path to the file implementing coercer functions for custom scalars. See Custom scalars.
scalar_mapping[]Mapping of GraphQL and Dart types. See Custom scalars.
schema_mapping[]Mapping of queries and which schemas they will use for code generation. See Schema mapping.

It's important to remember that, by default, build will follow Dart's package layout conventions, meaning that only some folders will be considered to parse the input files. So, if you want to reference files from a folder other than lib/, make sure you've included it on sources:

targets:
  $default:
    sources:
      - lib/**
      - graphql/**
      - data/**
      - schema.json

Schema mapping #

By default, Artemis won't generate anything. That's because your queries/mutations should be linked to GraphQL schemas. To configure it, you need to point a schema_mapping to the path of those queries and schemas:

targets:
  $default:
    builders:
      artemis:
        options:
          schema_mapping:
            - output: 'lib/graphql_api.dart'
              schema: lib/my_graphql.schema.json
              queries_glob: lib/**.query.graphql

Each SchemaMap is configured this way:

OptionDefault valueDescription
outputRelative path to output the generated code.
schemaRelative path to the GraphQL schema.
queries_globGlob that selects all query files to be used with this schema. Their extension must be .query.graphql.
resolve_type_field__resolveTypeThe name of the field used to differentiatiate interfaces and union types (commonly __resolveType or __typename). Note that __resolveType field are not added automatically to the query. If you want interface/union type resolution, you need to manually add it to the query.
add_query_prefixfalseWheter to add the name of the query as a prefix for each dependent object of this query input or response.

See examples for more information and configuration options.

Custom scalars #

If your schema uses custom scalars, they must be defined on build.yaml. If it needs a custom parser (to decode from/to json), the custom_parser_import path must be set and the file must implement both fromGraphQL___ToDart___ and fromDart___toGraphQL___ constant functions.

targets:
  $default:
    builders:
      artemis:
        options:
          custom_parser_import: 'package:graphbrainz_example/coercers.dart'
          scalar_mapping:
            - graphql_type: Date
              dart_type: DateTime

If your custom scalar needs to import Dart libraries, you can provide it in the config as well:

targets:
  $default:
    builders:
      artemis:
        options:
          custom_parser_import: 'package:graphbrainz_example/coercers.dart'
          scalar_mapping:
            - graphql_type: BigDecimal
              dart_type:
                name: Decimal
                imports:
                  - 'package:decimal/decimal.dart'

Each ScalarMap is configured this way:

OptionDefault valueDescription
graphql_typeThe GraphQL custom scalar name on schema.
dart_typeThe Dart type this custom scalar should be converted from/to.
use_custom_parserfalseWheter custom_parser_import should be imported on the beginning of the file.

See examples for more information and configuration options.

ArtemisClient #

If you have generate_helpers then, Artemis will create a subclass of GraphQLQuery for you, this class can be used in conjunction with ArtemisClient.

final client = ArtemisClient();
final gitHubReposQuery = MyGitHubReposQuery();
final response = await client.query(gitHubReposQuery);

Check the examples to see how to use it in details.

CHANGELOG #

1.0.1 #

  • Upgrade gql to version 0.2.0 to get rid of direct dependency on source_span and for better parsing errors.
  • Filter for SchemaMap with output when generating code

1.0.0 #

  • Breaking: Add required output option to SchemaMap
  • Make Artemis a $lib$ synthetic generator
  • Add add_query_prefix option to SchemaMap

0.7.0 #

  • Make generated classes a mixin of Equatable, meaning they can be easily comparable with ==

0.6.1 #

  • Include pubspec.lock files of examples

0.6.0 #

  • Replace graphql_parser with gql package

0.5.1 #

  • Add most documentation
  • Increase pana grade (health and maintenance)
  • Fix some stuff related to importing http on client

0.5.0 #

  • Start using code_builder to better generate Dart code

0.4.0 #

  • Allow scalar mappings to include imports for types

0.3.2 #

  • Decode HTTP response as UTF-8 on execute helper.

0.3.1 #

  • Export common used files on default package route (package:artemis/artemis.dart)
  • Use single schemaMap globbing stream to make sure only one schema will be found
  • Add missing changelog
  • Test new github actions

0.3.0 BREAKING #

  • Add new generators to GraphQLQuery and QueryArguments
  • Fix toJson() on JsonSerializable classes (for nested entities)
  • [BREAKING] Remove the execute* functions generations, to use instead the generic ArtemisClient class that should receive a GraphQLQuery generated subclass.

0.2.1 #

Set HTTP headers only when using default HTTP client.

0.2.0 BREAKING #

Completely overhaul how this works.

Artemis won't generate a full schema typing anymore. Instead, it will use the schema to generate typings from a specific query or mutation. It will also create helper functions to execute those queries. See README for more info.

This is totally a breaking change but as this library is still on alpha, I should keep it under 1.0.

0.1.3 #

  • Make objects that implement interfaces override resolveType

0.1.2 #

  • Improve package score

0.1.1 #

  • Enable tests on pipeline

0.1.0 #

  • "Fix" json_serializable dependency
  • Add tests
  • Generate union types as inheritance
  • Generate interface types as implementation
  • Make generated code choose inheritance

0.0.1 #

  • First release
  • No tests
  • No documentation
  • Parse complex GraphQL schemas (incorrectly, now I know)
  • Parse all GraphQL types types (union, interface, enum, input object, object, scalar, list, non null)
  • Consider custom scalars
  • Not even compile from scratch
  • Lot of bugs

example/README.md

Examples #

This folder contains some examples on how to use artemis.

pokemon #

A simple example, showing Pokémon GraphQL schema generation.

graphqbrainz #

A more complex example, for graphbrainz (a MusicBrainz GraphQL server). Featuring union types, interfaces and custom scalars.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  artemis: ^1.0.1

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter pub get

Alternatively, your editor might support pub get or flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:artemis/artemis.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
72
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
90
Overall:
Weighted score of the above. [more]
84
Learn more about scoring.

We analyzed this package on Sep 16, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.5.0
  • pana: 0.12.21

Platforms

Detected platforms: Flutter, web, other

No platform restriction found in primary library package:artemis/artemis.dart.

Maintenance issues and suggestions

Support latest dependencies. (-10 points)

The version constraint in pubspec.yaml does not support the latest published versions for 1 dependency (gql).

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0 <3.0.0
analyzer ^0.38.2 0.38.2
build ^1.1.4 1.1.6
build_config ^0.4.0 0.4.1+1
code_builder ^3.2.0 3.2.0
equatable ^0.5.1 0.5.1
glob ^1.1.7 1.1.7
gql ^0.2.0 0.2.0 0.5.0
http ^0.12.0+2 0.12.0+2
path ^1.6.2 1.6.4
recase ^2.0.1 2.0.1
source_gen ^0.9.4+2 0.9.4+4
Transitive dependencies
async 2.3.0
built_collection 4.2.2
built_value 6.7.1
charcode 1.1.2
checked_yaml 1.0.2
collection 1.14.12
convert 2.1.1
crypto 2.1.3
csslib 0.16.1
dart_style 1.2.10
fixnum 0.10.9
front_end 0.1.24
html 0.14.0+2
http_parser 3.1.3
json_annotation 3.0.0
kernel 0.3.24
logging 0.11.3+2
matcher 0.12.5
meta 1.1.7
package_config 1.1.0
pub_semver 1.4.2
pubspec_parse 0.1.5
quiver 2.0.5
source_span 1.5.5
stack_trace 1.9.3
string_scanner 1.0.5
term_glyph 1.1.0
typed_data 1.1.6
watcher 0.9.7+12
yaml 2.1.16
Dev dependencies
args ^1.5.2 1.5.2
build_runner ^1.5.0
build_test ^0.10.7+3
json_serializable ^3.0.0
pedantic ^1.8.0+1 1.8.0+1
test ^1.6.3