base on Build dart types from GraphQL schemas and queries <!-- @formatter:off --> <p align="center"> <img src="https://user-images.githubusercontent.com/735858/58768495-8ecbd600-8572-11e9-9321-4fa5ce4ea007.png" height="200"> <h1><b>Artemis</b></h1> </p> <!-- **Build dart types from GraphQL schemas and queries** --> ## Notice Artemis has been [discontinued](https://github.com/gql-dart/ferry/issues/541). For alternatives, take a look at the [Ferry](https://pub.dev/packages/ferry) project, featuring code generation for data types, customizable network layer (using `gql_link`), cache, data store connections, refetching + pagination support and more. Also check out [graphql](https://pub.dev/packages/graphql), with features closely matching the current Artemis state: fully-featured client (for Dart and Flutter) with persistence, type generation (with [graphql_codegen](https://pub.dev/packages/graphql_codegen)), cache, and more. Users and community are also invited to join the [GraphQL Dart](https://discord.gg/Pu8AMajSd) Discord to discuss migration approaches and ask for support. Thanks to all contributors and users that made this project possible. <details> <summary>To check out the old README, click here.</summary> <!-- Badges --> [![View at pub.dev][pub-badge]][pub-link] [![Test][actions-badge]][actions-link] [![PRs Welcome][prs-badge]][prs-link] [![Star on GitHub][github-star-badge]][github-star-link] [![Fork on GitHub][github-forks-badge]][github-forks-link] [![Discord][discord-badge]][discord-link] [pub-badge]: https://img.shields.io/pub/v/artemis?style=for-the-badge [pub-link]: https://pub.dev/packages/artemis [actions-badge]: https://img.shields.io/github/workflow/status/comigor/artemis/test?style=for-the-badge [actions-link]: https://github.com/comigor/artemis/actions [prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge [prs-link]: https://github.com/comigor/artemis/issues [github-star-badge]: https://img.shields.io/github/stars/comigor/artemis.svg?style=for-the-badge&logo=github&logoColor=ffffff [github-star-link]: https://github.com/comigor/artemis/stargazers [github-forks-badge]: https://img.shields.io/github/forks/comigor/artemis.svg?style=for-the-badge&logo=github&logoColor=ffffff [github-forks-link]: https://github.com/comigor/artemis/network/members [discord-badge]: https://img.shields.io/discord/559455668810153989.svg?style=for-the-badge&logo=discord&logoColor=ffffff [discord-link]: https://discord.gg/2Y4wdE4 Check the [**beta**](https://github.com/comigor/artemis/tree/beta) branch for the bleeding edge (and breaking) stuff. Artemis is a code generator that looks for `schema.graphql` (GraphQL SDL - Schema Definition Language) and `*.graphql` files and builds `.graphql.dart` files typing that query, based on the schema. That's similar to what [Apollo](https://github.com/apollographql/apollo-client) does (Artemis is his sister anyway). --- ## **Installation** Add the following to your `pubspec.yaml` file to be able to do code generation: ```yaml dev_dependencies: artemis: '>=7.0.0 <8.0.0' build_runner: ^2.1.4 json_serializable: ^6.0.1 ``` The generated code uses the following packages in run-time: ```yaml dependencies: artemis: '>=8.0.0 <8.0.0' # only if you're using ArtemisClient! json_annotation: ^4.3.0 equatable: ^2.0.3 gql: ^0.13.1-alpha ``` Then run: ```shell dart pub get ``` or ```shell flutter pub get ``` Now Artemis will generate the API files for you by running: ```shell dart run build_runner build ``` or ```shell 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: ```yaml targets: $default: builders: artemis: options: # custom configuration options! ``` > ⚠️ Make sure your configuration file is called `build.yaml` (with `.yaml` extension, not `.yml`)! | Option | Default value | Description | | - | - | - | | `generate_helpers` | `true` | If Artemis should generate query/mutation helper GraphQLQuery subclasses. | | `scalar_mapping` | `[]` | Mapping of GraphQL and Dart types. See [Custom scalars](#custom-scalars). | | `schema_mapping` | `[]` | Mapping of queries and which schemas they will use for code generation. See [Schema mapping](#schema-mapping). | | `fragments_glob` | `null` | Import path to the file implementing fragments for all queries mapped in schema_mapping. If it's assigned, fragments defined in schema_mapping will be ignored. | | `ignore_for_file` | `[]` | The linter rules to ignore for artemis generated files. | | `generate_queries` | `true` | If Artemis should generate query documents and operation names. If you are using Artemis with `graphql` library it is useful to have those queries and operation names generated but without Atremis specific classes to exclude Artemis from dependancies | It's important to remember that, by default, [build](https://github.com/dart-lang/build) will follow [Dart's package layout conventions](https://dart.dev/tools/pub/package-layout), 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`: ```yaml targets: $default: sources: - lib/** - graphql/** - data/** - schema.graphql ``` ### **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: ```yaml targets: $default: builders: artemis: options: schema_mapping: - output: lib/graphql_api.graphql.dart schema: lib/my_graphql_schema.graphql queries_glob: lib/**.graphql ``` Each `SchemaMap` is configured this way: | Option | Default value | Description | | - | - | - | | `output` | | Relative path to output the generated code. It should end with `.graphql.dart` or else the generator will need to generate one more file. | | `schema` | | Relative path to the GraphQL schema. | | `queries_glob` | | Glob that selects all query files to be used with this schema. | | `naming_scheme` | `pathedWithTypes` | The naming scheme to be used on generated classes names. `pathedWithTypes` is the default for retrocompatibility, where the names of previous types are used as prefix of the next class. This can generate duplication on certain schemas. With `pathedWithFields`, the names of previous fields are used as prefix of the next class and with `simple`, only the actual GraphQL class nameis considered. | | `type_name_field` | `__typename` | The name of the field used to differentiate interfaces and union types (commonly `__typename` or `__resolveType`). Note that `__typename` field are not added automatically to the query. If you want interface/union type resolution, you need to manually add it there or set `append_type_name` to `true`. | | `append_type_name` | `false` | Appends `type_name_field` value to the query selections set. | | `fragments_glob` | `null` | Import path to the file implementing fragments for all queries mapped in schema_mapping. | See [examples](./example) 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. `___ToDart___` and `___ToGraphQL___` should be named including nullability, here is an example: * `file: Upload` => `fromGraphQLUploadNullableToDartMultipartFileNullable` and `fromDartMultipartFileNullableToGraphQLUploadNullable` * `file: Upload!` => `fromGraphQLUploadToDartMultipartFile` and `fromDartMultipartFileToGraphQLUpload` * `file: [Upload]` => `fromGraphQLListNullableUploadNullableToDartListNullableMultipartFileNullable` and `fromDartListNullableMultipartFileNullableToGraphQLListNullableUploadNullable` * `file: [Upload]!` => `fromGraphQLListUploadNullableToDartListMultipartFileNullable` and `fromDartListMultipartFileNullableToGraphQLListUploadNullable` * `file: [Upload!]!` => `fromGraphQLListUploadToDartListMultipartFile` and `fromDartListMultipartFileToGraphQLListUpload` ```yaml targets: $default: builders: artemis: options: scalar_mapping: - custom_parser_import: 'package:graphbrainz_example/coercers.dart' graphql_type: Date dart_type: DateTime ``` If your custom scalar needs to import Dart libraries, you can provide it in the config as well: ```yaml targets: $default: builders: artemis: options: scalar_mapping: - custom_parser_import: 'package:graphbrainz_example/coercers.dart' graphql_type: BigDecimal dart_type: name: Decimal imports: - 'package:decimal/decimal.dart' ``` Each `ScalarMap` is configured this way: | Option | Default value | Description | | - | - | - | | `graphql_type` | | The GraphQL custom scalar name on schema. | | `dart_type` | | The Dart type this custom scalar should be converted from/to. | | `custom_parser_import` | `null` | Import path to the file implementing coercer functions for custom scalars. See [Custom scalars](#custom-scalars). | See [examples](./example) for more information and configuration options. ## **Articles and videos** 1. [Ultimate toolchain to work with GraphQL in Flutter](https://medium.com/@v.ditsyak/ultimate-toolchain-to-work-with-graphql-in-flutter-13aef79c6484) 2. [Awesome GraphQL](https://github.com/chentsulin/awesome-graphql) ## **ArtemisClient** If you have `generate_helpers`, Artemis will create a subclass of `GraphQLQuery` for you, this class can be used in conjunction with `ArtemisClient`. ```dart final client = ArtemisClient('/graphql'); final gitHubReposQuery = MyGitHubReposQuery(); final response = await client.execute(gitHubReposQuery); ``` `ArtemisClient` adds type-awareness around `Link` from [`package:gql/link`](https://pub.dev/packages/gql). You can create `ArtemisClient` from any `Link` using `ArtemisClient.fromLink`. Check the [examples](./example) to see how to use it in details. </details> ", Assign "at most 3 tags" to the expected json: {"id":"11078","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"