Flutter Freezed 3 Support

[AlexKDawson]

Hey @dotansimha @Parables

I recently started using the flutter-freezed package and with the release of Freezed 3. I think the docs here need to be more clear that the generated code outputs for freezed 2, and will not be compatible with 3 out of the box.

Let me know if I missed something here! Thanks for creating/maintaining a great plugin and library!

[Parables]

Hello @AlexKDawson, thanks for trying out this package...

I have been away from the Flutter ecosystem for a while now so I am not up to speed with the latest changes.

Can you provide these:

• A sample of your Graphql Schema
• Any config being used for this plugin...
• The current output of this plugin
• The expected output of this plugin to make compatible with Freezed 3

Standing by... Don't forget to mention @Parables in your responses.

[AlexKDawson]

@Parables I think the migration is pretty straightforward but I'm new to flutter so probably a little out of my depth.

The main issue I'm running into is the abstract/sealed keyword mentioned here:
https://github.com/rrousselGit/freezed/blob/master/packages/freezed/migration_guide.md

I have not personally run into the Pattern Matching case mentioned in the migration.

For example data here's my schema

GraphSchema
"""Represents a deck of cards for vocabulary learning"""
type Deck {
  """The unique identifier"""
  id: Int!

  """The name of the deck"""
  name: String!

  """When this deck was created"""
  createdAt: String!

  """The owner of the deck"""
  owner: String!

  """The cards of the deck"""
  cards: [Int!]!
}

type Query {
  myDecks: [Deck!]!
}

The Output:

import 'package:freezed_annotation/freezed_annotation.dart';
import 'package:flutter/foundation.dart';

part 'graphql_models.freezed.dart';
part 'graphql_models.g.dart';

@freezed
class Deck with _$Deck {
  const Deck._();

/// Represents a deck of cards for vocabulary learning
  const factory Deck({
/// The cards of the deck
    required List<int> cards,
/// When this deck was created
    required String createdAt,
/// The unique identifier
    required int id,
/// The name of the deck
    required String name,
/// The owner of the deck
    required String owner,
  }) = _Deck;

  factory Deck.fromJson(Map<String, dynamic> json) => _$DeckFromJson(json);
}

The desired output (basically just an abstract added).

import 'package:freezed_annotation/freezed_annotation.dart';
import 'package:flutter/foundation.dart';

part 'graphql_models.freezed.dart';
part 'graphql_models.g.dart';

@freezed
abstract class Deck with _$Deck {
  const Deck._();

/// Represents a deck of cards for vocabulary learning
  const factory Deck({
/// The cards of the deck
    required List<int> cards,
/// When this deck was created
    required String createdAt,
/// The unique identifier
    required int id,
/// The name of the deck
    required String name,
/// The owner of the deck
    required String owner,
  }) = _Deck;

  factory Deck.fromJson(Map<String, dynamic> json) => _$DeckFromJson(json);
}

And my config:

import type { CodegenConfig } from '@graphql-codegen/cli';

const config: CodegenConfig = {
  schema: './schema.graphql',
  generates: {
    'lib/models/generated/graphql_models.dart': {
      plugins: [
        {
          'flutter-freezed': {
            immutable: true,
          }
        }
      ]
    }
  }
};

export default config;

Thanks again!