@graphql-codegen/flutter-freezed 3.0.0 → 3.0.1-alpha-20230130180936-04996f117

package/cjs/config/config-value.js

@@ -47,7 +47,7 @@ Config.escapeDartKeywords = (config, blockAppliesOn, typeName, fieldName) => {
     else if (typeName && Array.isArray(escapeDartKeywords) && escapeDartKeywords.length > 0) {
         const [, prefix, suffix] = escapeDartKeywords
             .filter(([pattern, , , configAppliesOn]) => pattern_js_1.Pattern.findLastConfiguration(pattern, typeName, fieldName) &&
-            (0, utils_js_1.appliesOnBlock)(configAppliesOn, blockAppliesOn))
+            (0, utils_js_1.appliesOnBlock)(configAppliesOn !== null && configAppliesOn !== void 0 ? configAppliesOn : [...plugin_config_js_1.APPLIES_ON_ALL_BLOCKS], blockAppliesOn))
             .slice(-1)[0];
         return [prefix, suffix];
     }
@@ -115,7 +115,7 @@ Config.unionKey = ( /* config: FlutterFreezedPluginConfig, typeName: TypeName */
 Config.unionValueCase = ( /* config: FlutterFreezedPluginConfig, typeName: TypeName */) => {
     return undefined;
 };
-Config.unionValueDecorator = () => {
+Config.unionValueFactoryDecorator = () => {
     return undefined;
 };
 Config.enableWithBooleanOrTypeFieldName = (value, typeName) => {

package/cjs/config/plugin-config.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaultFreezedPluginConfig = exports.DART_KEYWORDS = exports.DART_SCALARS = exports.APPLIES_ON_PARAMETERS = exports.APPLIES_ON_MERGED_FACTORY_PARAMETERS = exports.APPLIES_ON_UNION_FACTORY_PARAMETERS = exports.APPLIES_ON_DEFAULT_FACTORY_PARAMETERS = exports.APPLIES_ON_FACTORY = exports.APPLIES_ON_MERGED_FACTORY = exports.APPLIES_ON_UNION_FACTORY = exports.APPLIES_ON_DEFAULT_FACTORY = exports.APPLIES_ON_CLASS = exports.APPLIES_ON_ENUM_VALUE = exports.APPLIES_ON_ENUM = void 0;
+exports.defaultFreezedPluginConfig = exports.DART_KEYWORDS = exports.DART_SCALARS = exports.APPLIES_ON_ALL_BLOCKS = exports.APPLIES_ON_PARAMETERS = exports.APPLIES_ON_MERGED_FACTORY_PARAMETERS = exports.APPLIES_ON_UNION_FACTORY_PARAMETERS = exports.APPLIES_ON_DEFAULT_FACTORY_PARAMETERS = exports.APPLIES_ON_FACTORY = exports.APPLIES_ON_MERGED_FACTORY = exports.APPLIES_ON_UNION_FACTORY = exports.APPLIES_ON_DEFAULT_FACTORY = exports.APPLIES_ON_CLASS = exports.APPLIES_ON_ENUM_VALUE = exports.APPLIES_ON_ENUM = void 0;
 exports.APPLIES_ON_ENUM = ['enum'];
 exports.APPLIES_ON_ENUM_VALUE = ['enum_value'];
 exports.APPLIES_ON_CLASS = ['class'];
@@ -26,6 +26,7 @@ exports.APPLIES_ON_PARAMETERS = [
     'union_factory_parameter',
     'merged_factory_parameter',
 ];
+exports.APPLIES_ON_ALL_BLOCKS = ['enum', 'enum_value', 'class', 'factory', 'parameter'];
 /**
  * maps GraphQL scalar types to Dart's scalar types
  */

package/cjs/freezed-declaration-blocks/class-block.js

@@ -19,7 +19,7 @@ class ClassBlock {
         block += this.buildDecorators(config, node);
         block += this.buildHeader(config, typeName, _className);
         block += this.buildBody(config, node);
-        block += this.buildFooter(config, typeName, _className);
+        block += this.buildFooter(_className);
         return block;
     }
 }
@@ -83,13 +83,12 @@ ClassBlock.buildBody = (config, node) => {
             .join('');
     }
     body += config_value_js_1.Config.mergeTypes(config, className)
-        .map(value => {
-        const factoryName = pattern_js_1.TypeName.fromString(value);
+        .map(factoryName => {
         return factory_block_js_1.FactoryBlock.serializeMergedFactory(className, factoryName);
     })
         .join('');
     return body;
 };
-ClassBlock.buildFooter = (config, typeName, _className) => {
+ClassBlock.buildFooter = (_className) => {
     return (0, visitor_plugin_common_1.indent)(`factory ${_className}.fromJson(Map<String, dynamic> json) => _$${_className}FromJson(json);\n}\n\n`);
 };

package/esm/config/config-value.js

@@ -1,6 +1,6 @@
 import { appliesOnBlock } from '../utils.js';
 import { Pattern } from './pattern.js';
-import { DART_SCALARS, defaultFreezedPluginConfig, } from './plugin-config.js';
+import { APPLIES_ON_ALL_BLOCKS, DART_SCALARS, defaultFreezedPluginConfig, } from './plugin-config.js';
 export class Config {
 }
 Config.camelCasedEnums = (config) => {
@@ -43,7 +43,7 @@ Config.escapeDartKeywords = (config, blockAppliesOn, typeName, fieldName) => {
     else if (typeName && Array.isArray(escapeDartKeywords) && escapeDartKeywords.length > 0) {
         const [, prefix, suffix] = escapeDartKeywords
             .filter(([pattern, , , configAppliesOn]) => Pattern.findLastConfiguration(pattern, typeName, fieldName) &&
-            appliesOnBlock(configAppliesOn, blockAppliesOn))
+            appliesOnBlock(configAppliesOn !== null && configAppliesOn !== void 0 ? configAppliesOn : [...APPLIES_ON_ALL_BLOCKS], blockAppliesOn))
             .slice(-1)[0];
         return [prefix, suffix];
     }
@@ -111,7 +111,7 @@ Config.unionKey = ( /* config: FlutterFreezedPluginConfig, typeName: TypeName */
 Config.unionValueCase = ( /* config: FlutterFreezedPluginConfig, typeName: TypeName */) => {
     return undefined;
 };
-Config.unionValueDecorator = () => {
+Config.unionValueFactoryDecorator = () => {
     return undefined;
 };
 Config.enableWithBooleanOrTypeFieldName = (value, typeName) => {

package/esm/config/plugin-config.js

@@ -23,6 +23,7 @@ export const APPLIES_ON_PARAMETERS = [
     'union_factory_parameter',
     'merged_factory_parameter',
 ];
+export const APPLIES_ON_ALL_BLOCKS = ['enum', 'enum_value', 'class', 'factory', 'parameter'];
 /**
  * maps GraphQL scalar types to Dart's scalar types
  */

package/esm/freezed-declaration-blocks/class-block.js

@@ -16,7 +16,7 @@ export class ClassBlock {
         block += this.buildDecorators(config, node);
         block += this.buildHeader(config, typeName, _className);
         block += this.buildBody(config, node);
-        block += this.buildFooter(config, typeName, _className);
+        block += this.buildFooter(_className);
         return block;
     }
 }
@@ -79,13 +79,12 @@ ClassBlock.buildBody = (config, node) => {
             .join('');
     }
     body += Config.mergeTypes(config, className)
-        .map(value => {
-        const factoryName = TypeName.fromString(value);
+        .map(factoryName => {
         return FactoryBlock.serializeMergedFactory(className, factoryName);
     })
         .join('');
     return body;
 };
-ClassBlock.buildFooter = (config, typeName, _className) => {
+ClassBlock.buildFooter = (_className) => {
     return indent(`factory ${_className}.fromJson(Map<String, dynamic> json) => _$${_className}FromJson(json);\n}\n\n`);
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-codegen/flutter-freezed",
-  "version": "3.0.0",
+  "version": "3.0.1-alpha-20230130180936-04996f117",
   "description": "GraphQL Code Generator plugin to generate Freezed models from your GraphQL schema",
   "peerDependencies": {
     "graphql": "^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0"

package/typings/config/config-value.d.cts

@@ -12,13 +12,13 @@ export declare class Config {
     static ignoreTypes: (config: FlutterFreezedPluginConfig, typeName: TypeName) => string[];
     static immutable: (config: FlutterFreezedPluginConfig, typeName?: TypeName) => boolean;
     static makeCollectionsUnmodifiable: (config: FlutterFreezedPluginConfig, typeName?: TypeName) => boolean;
-    static mergeTypes: (config: FlutterFreezedPluginConfig, typeName: TypeName) => string[];
+    static mergeTypes: (config: FlutterFreezedPluginConfig, typeName: TypeName) => TypeName[];
     static mutableInputs: (config: FlutterFreezedPluginConfig, typeName?: TypeName) => boolean;
     static privateEmptyConstructor: (config: FlutterFreezedPluginConfig, typeName?: TypeName) => boolean;
     static unionClass: () => any;
     static unionKey: () => string | undefined;
     static unionValueCase: () => string | undefined;
-    static unionValueDecorator: () => any;
+    static unionValueFactoryDecorator: () => any;
     static enableWithBooleanOrTypeFieldName: (value?: boolean | TypeNamePattern, typeName?: TypeName) => boolean;
     static create: (...config: Partial<FlutterFreezedPluginConfig>[]) => FlutterFreezedPluginConfig;
 }

package/typings/config/config-value.d.ts

@@ -12,13 +12,13 @@ export declare class Config {
     static ignoreTypes: (config: FlutterFreezedPluginConfig, typeName: TypeName) => string[];
     static immutable: (config: FlutterFreezedPluginConfig, typeName?: TypeName) => boolean;
     static makeCollectionsUnmodifiable: (config: FlutterFreezedPluginConfig, typeName?: TypeName) => boolean;
-    static mergeTypes: (config: FlutterFreezedPluginConfig, typeName: TypeName) => string[];
+    static mergeTypes: (config: FlutterFreezedPluginConfig, typeName: TypeName) => TypeName[];
     static mutableInputs: (config: FlutterFreezedPluginConfig, typeName?: TypeName) => boolean;
     static privateEmptyConstructor: (config: FlutterFreezedPluginConfig, typeName?: TypeName) => boolean;
     static unionClass: () => any;
     static unionKey: () => string | undefined;
     static unionValueCase: () => string | undefined;
-    static unionValueDecorator: () => any;
+    static unionValueFactoryDecorator: () => any;
     static enableWithBooleanOrTypeFieldName: (value?: boolean | TypeNamePattern, typeName?: TypeName) => boolean;
     static create: (...config: Partial<FlutterFreezedPluginConfig>[]) => FlutterFreezedPluginConfig;
 }

package/typings/config/plugin-config.d.cts

@@ -64,6 +64,9 @@ export declare type FlutterFreezedPluginConfig = {
      * ```ts filename='codegen.ts'
      * import type { CodegenConfig } from '@graphql-codegen/cli';
      *
+     * const Droid = TypeName.fromString('Droid');
+     * const Starship = TypeName.fromString('Starship');
+     *
      * const config: CodegenConfig = {
      *   // ...
      *   generates: {
@@ -119,7 +122,7 @@ export declare type FlutterFreezedPluginConfig = {
     customScalars?: Record<string, string>;
     /**
      * @name defaultValues
-     * @type {([pattern: FieldNamePattern, value: string, appliesOn: AppliesOnParameters[], directiveName?: string, directiveArgName?: string][])}
+     * @type {([pattern: FieldNamePattern, value: string, appliesOn: AppliesOnParameters[]][])}
      * @default undefined
      * @see {@link https://pub.dev/packages/freezed#default-values Default values}
      * @see {@link https://pub.dev/documentation/freezed_annotation/latest/freezed_annotation/Default-class.html Default class}
@@ -132,12 +135,14 @@ export declare type FlutterFreezedPluginConfig = {
      *
      * Use the `appliesOn` to specify where this option should be applied on
      *
-     * If the `directiveName` and `directiveArgName` are passed, the value of the argument of the given directive specified in the Graphql Schema will be used as the defaultValue
      * @exampleMarkdown
      * ## Usage:
      * ```ts filename='codegen.ts'
      * import type { CodegenConfig } from '@graphql-codegen/cli';
      *
+     * const MovieCharacter = TypeName.fromString('MovieCharacter');
+     * const appearsIn = FieldName.fromString('appearsIn');
+     *
      * const config: CodegenConfig = {
      *   // ...
      *   generates: {
@@ -182,6 +187,14 @@ export declare type FlutterFreezedPluginConfig = {
      * ```ts filename='codegen.ts'
      * import type { CodegenConfig } from '@graphql-codegen/cli';
      *
+     * const MovieCharacter = TypeName.fromString('MovieCharacter');
+     * const Droid = TypeName.fromString('Droid');
+     * const Starship = TypeName.fromString('Starship');
+     * const Human = TypeName.fromString('Human');
+     *
+     * const name = FieldName.fromString('name');
+     * const appearsIn = FieldName.fromString('appearsIn');
+     *
      * const config: CodegenConfig = {
      *   // ...
      *   generates: {
@@ -208,7 +221,7 @@ export declare type FlutterFreezedPluginConfig = {
      * @name equal
      * @type {(boolean | TypeNamePattern)}
      * @default undefined
-     * @see {@link url Freezed equal helper method usage}
+     * @see {@link https://pub.dev/packages/freezed#changing-the-behavior-for-a-specific-model Freezed equal helper method usage}
      * @see {@link https://pub.dev/documentation/freezed_annotation/latest/freezed_annotation/Freezed/equal.html Freezed annotation equal property}
      * @summary enables Freezed equal helper method
      * @description The [`freezed`](https://pub.dev/packages/freezed) library has this option enabled by default.
@@ -225,6 +238,9 @@ export declare type FlutterFreezedPluginConfig = {
      * ```ts filename='codegen.ts'
      * import type { CodegenConfig } from '@graphql-codegen/cli';
      *
+     * const Droid = TypeName.fromString('Droid');
+     * const Starship = TypeName.fromString('Starship');
+     *
      * const config: CodegenConfig = {
      *   // ...
      *   generates: {
@@ -246,11 +262,11 @@ export declare type FlutterFreezedPluginConfig = {
     equal?: boolean | TypeNamePattern;
     /**
      * @name escapeDartKeywords
+     * @type {(boolean | [pattern: Pattern, prefix?: string, suffix?: string, appliesOn?: AppliesOn[]][])}
      * @default true
      * @see_also [dartKeywordEscapePrefix,dartKeywordEscapeSuffix]
-     * @summary ensures that the generated Freezed models doesn't use any of Dart's reserved keywords as identifiers
-     * @description Wraps the fields names that are valid Dart keywords with the prefix and suffix given and allows you to specify your preferred casing: "snake_case" | "camelCase" | "PascalCase"
-     *
+     * @summary ensures that the generated Freezed models do not use any of Dart's reserved keywords as identifiers
+     * @description Wraps the fields names that are valid Dart keywords with the prefix and suffix given
      *
      * @exampleMarkdown
      * ## Usage:
@@ -258,6 +274,8 @@ export declare type FlutterFreezedPluginConfig = {
      * ```ts filename='codegen.ts'
      * import type { CodegenConfig } from '@graphql-codegen/cli';
      *
+     * const Episode = TypeName.fromString('Episode');
+     *
      * const config: CodegenConfig = {
      *   // ...
      *   generates: {
@@ -270,15 +288,15 @@ export declare type FlutterFreezedPluginConfig = {
      *           // OR configure how Dart keywords are handled for each type
      *           escapeDartKeywords: [
      *             [
-     *               'Episode.@*FieldNames',
+     *               Pattern.compose([
+     *                 TypeNamePattern.forAllTypeNames(),
+     *                 FieldNamePattern.forAllFieldNamesOfTypeName([Episode]),
+     *               ]),
      *               // `prefix`: defaults to an empty string `''` if undefined.
-     *               // Note that using a underscore `_` as a prefix will make the field as private
+     *               // WARNING: Note that using a underscore `_` as a prefix will make the field as private
      *               undefined,
      *               // `suffix`: defaults to an underscore `_` if undefined
      *               undefined,
-     *               // `casing`: maintains the original casing if undefined.
-     *               // Available options: `snake_cased`, `camelCase` or `PascalCase`
-     *               undefined,
      *               // `appliesOn`: defaults to an ['enum', 'enum_value', 'class', 'factory', 'parameter'] if undefined.
      *               undefined,
      *             ],
@@ -294,18 +312,18 @@ export declare type FlutterFreezedPluginConfig = {
     escapeDartKeywords?: boolean | [pattern: Pattern, prefix?: string, suffix?: string, appliesOn?: AppliesOn[]][];
     /**
      * @name final
+     * @type {([pattern: FieldNamePattern, appliesOn: AppliesOnParameters[]][])}
+     * @default undefined
+     * @see {@link https://pub.dev/packages/freezed#defining-a-mutable-class-instead-of-an-immutable-one Freezed annotation equal property}
      * @summary  marks fields as final
      * @description This will mark the specified parameters as final
-     *
-     *   Requires a an array of tuples with the type signature below:
-     *
-     * ` [typeFieldName: TypeFieldName, appliesOn: AppliesOnParameters[]]`
-     * @default undefined
      * @exampleMarkdown
      * ## Usage:
      * ```ts filename='codegen.ts'
      * import type { CodegenConfig } from '@graphql-codegen/cli';
      *
+     * const id = FieldName.fromString('id');
+     *
      * const config: CodegenConfig = {
      *   // ...
      *   generates: {
@@ -313,10 +331,7 @@ export declare type FlutterFreezedPluginConfig = {
      *       plugins: {
      *         'flutter-freezed': {
      *           // ...
-     *           final: [
-     *             ['Human.[name]', ['parameter']],
-     *             ['Starship.[id],Droid.[id],Human.[id]', ['default_factory_parameter']],
-     *           ],
+     *           final: [[FieldNamePattern.forFieldNamesOfAllTypeNames([id]), ['parameter']]],
      *         },
      *       },
      *     },
@@ -337,6 +352,8 @@ export declare type FlutterFreezedPluginConfig = {
      * ```ts filename='codegen.ts'
      * import type { CodegenConfig } from '@graphql-codegen/cli';
      *
+     * const PaginatorInfo = TypeName.fromString('PaginatorInfo');
+     *
      * const config: CodegenConfig = {
      *   // ...
      *   generates: {
@@ -344,7 +361,7 @@ export declare type FlutterFreezedPluginConfig = {
      *       plugins: {
      *         'flutter-freezed': {
      *           // ...
-     *           ignoreTypes: ['PaginatorInfo'],
+     *           ignoreTypes: TypeNamePattern.forTypeNames([PaginatorInfo]),
      *         },
      *       },
      *     },
@@ -371,6 +388,9 @@ export declare type FlutterFreezedPluginConfig = {
      * ```ts filename='codegen.ts'
      * import type { CodegenConfig } from '@graphql-codegen/cli';
      *
+     * const Droid = TypeName.fromString('Droid');
+     * const Starship = TypeName.fromString('Starship');
+     *
      * const config: CodegenConfig = {
      *   // ...
      *   generates: {
@@ -392,14 +412,19 @@ export declare type FlutterFreezedPluginConfig = {
     immutable?: boolean | TypeNamePattern;
     /**
      * @name makeCollectionsUnmodifiable
-     * @description allows collections(lists/maps) to be modified even if class is immutable
+     * @type {(boolean | TypeNamePattern)}
      * @default undefined
+     * @see {@link https://pub.dev/packages/freezed#allowing-the-mutation-of-listsmapssets Allowing the mutation of Lists/Maps/Sets}
+     * @description allows collections(lists/maps) to be modified even if class is immutable
      *
      * @exampleMarkdown
      * ## Usage:
      * ```ts filename='codegen.ts'
      * import type { CodegenConfig } from '@graphql-codegen/cli';
      *
+     * const Droid = TypeName.fromString('Droid');
+     * const Starship = TypeName.fromString('Starship');
+     *
      * const config: CodegenConfig = {
      *   // ...
      *   generates: {
@@ -408,10 +433,8 @@ export declare type FlutterFreezedPluginConfig = {
      *         'flutter-freezed': {
      *           // ...
      *           makeCollectionsUnmodifiable: true,
-     *           // OR: a comma-separated string
-     *           makeCollectionsUnmodifiable: 'Droid,Starship',
-     *           // OR: a list of GRaphQL Type names
-     *           makeCollectionsUnmodifiable: ['Droid', 'Starship'],
+     *           // OR: enable it for only Droid and Starship GraphQL types
+     *           makeCollectionsUnmodifiable: TypeNamePattern.forTypeNames([Droid, Starship]),
      *         },
      *       },
      *     },
@@ -423,25 +446,43 @@ export declare type FlutterFreezedPluginConfig = {
     makeCollectionsUnmodifiable?: boolean | TypeNamePattern;
     /**
      * @name mergeTypes
+     * @type {(Record<string, TypeName[]>)}
      * @default undefined
-     * @description merges other GraphQL Types as a named factory constructor inside a class generated for the target GraphQL ObjectType.
-     * This option takes an array of strings that are expected to be valid typeNames of GraphQL Types to be merged with the GraphQL Type used as the key.
-     * The array is mapped and each string is converted into a TypeName so please ensure that the strings are valid GraphQL TypeNames
-     * A string that contains any invalid characters will throw an exception.
+     * @description maps over the value(array of typeNames) and transform each as a named factory constructor inside a class generated for the key(target GraphQL Object Type).
      * @exampleMarkdown
-     * ```yaml
-     * generates:
-     *   flutter_app/lib/data/models/app_models.dart
-     *     plugins:
-     *       - flutter-freezed
-     *     config:
-     *      mergeTypes: ["Create$Input", "Update$Input", "Delete$Input"]
+     * ## Usage:
+     * ```ts filename='codegen.ts'
+     * import type { CodegenConfig } from '@graphql-codegen/cli';
+     *
+     * const Movie = TypeName.fromString('Movie');
+     * const CreateMovieInput = TypeName.fromString('CreateMovieInput');
+     * const UpdateMovieInput = TypeName.fromString('UpdateMovieInput');
+     * const UpsertMovieInput = TypeName.fromString('UpsertMovieInput');
+     *
+     * const config: CodegenConfig = {
+     *   // ...
+     *   generates: {
+     *     'lib/data/models/app_models.dart': {
+     *       plugins: {
+     *         'flutter-freezed': {
+     *           // ...
+     *          mergeTypes: {
+     *            [Movie.value]: [CreateMovieInput, UpdateMovieInput, UpsertMovieInput],
+     *          },
+     *         },
+     *       },
+     *     },
+     *   },
+     * };
+     * export default config;
      * ```
      */
-    mergeTypes?: Record<string, string[]>;
+    mergeTypes?: Record<string, TypeName[]>;
     /**
      * @name mutableInputs
-     * @description  since inputs will be used to collect data, it makes sense to make them mutable with Freezed's `@unfreezed` decorator. This overrides(in order words: has a higher precedence than) the `immutable` config value `ONLY` for GraphQL `input types`.
+     * @description  since inputs will be used to collect data, it makes sense to make them mutable with Freezed's `@unfreezed` decorator.
+     *
+     * This overrides(in order words: has a higher precedence than) the `immutable` config value `ONLY` for GraphQL `input types`.
      * @default true
      *
      * @exampleMarkdown
@@ -449,6 +490,9 @@ export declare type FlutterFreezedPluginConfig = {
      * ```ts filename='codegen.ts'
      * import type { CodegenConfig } from '@graphql-codegen/cli';
      *
+     * const CreateMovieInput = TypeName.fromString('CreateMovieInput');
+     * const UpdateMovieInput = TypeName.fromString('UpdateMovieInput');
+     *
      * const config: CodegenConfig = {
      *   // ...
      *   generates: {
@@ -457,10 +501,8 @@ export declare type FlutterFreezedPluginConfig = {
      *         'flutter-freezed': {
      *           // ...
      *           mutableInputs: true,
-     *           // OR: a comma-separated string
-     *           mutableInputs: 'Droid,Starship',
-     *           // OR: a list of GRaphQL Type names
-     *           mutableInputs: ['Droid', 'Starship'],
+     *           // OR: enable it for only Droid and Starship GraphQL types
+     *           mutableInputs: TypeNamePattern.forTypeNames([CreateMovieInput, UpdateMovieInput]),
      *         },
      *       },
      *     },
@@ -480,6 +522,9 @@ export declare type FlutterFreezedPluginConfig = {
      * ```ts filename='codegen.ts'
      * import type { CodegenConfig } from '@graphql-codegen/cli';
      *
+     * const Droid = TypeName.fromString('Droid');
+     * const Starship = TypeName.fromString('Starship');
+     *
      * const config: CodegenConfig = {
      *   // ...
      *   generates: {
@@ -488,10 +533,8 @@ export declare type FlutterFreezedPluginConfig = {
      *         'flutter-freezed': {
      *           // ...
      *           privateEmptyConstructor: true,
-     *           // OR: a comma-separated string
-     *           privateEmptyConstructor: 'Droid,Starship',
-     *           // OR: a list of GRaphQL Type names
-     *           privateEmptyConstructor: ['Droid', 'Starship'],
+     *           // OR: enable it for only Droid and Starship GraphQL types
+     *           privateEmptyConstructor: TypeNamePattern.forTypeNames([Droid, Starship]),
      *         },
      *       },
      *     },
@@ -586,6 +629,7 @@ export declare type AppliesOnMergedFactoryParameters = (typeof APPLIES_ON_MERGED
 export declare type AppliesOnNamedParameters = AppliesOnUnionFactoryParameters | AppliesOnMergedFactoryParameters;
 export declare const APPLIES_ON_PARAMETERS: readonly ["parameter", "default_factory_parameter", "named_factory_parameter", "union_factory_parameter", "merged_factory_parameter"];
 export declare type AppliesOnParameters = AppliesOnDefaultFactoryParameters | AppliesOnNamedParameters;
+export declare const APPLIES_ON_ALL_BLOCKS: readonly ["enum", "enum_value", "class", "factory", "parameter"];
 export declare type DartIdentifierCasing = 'snake_case' | 'camelCase' | 'PascalCase';
 export declare type NodeType = ObjectTypeDefinitionNode | InputObjectTypeDefinitionNode | UnionTypeDefinitionNode | EnumTypeDefinitionNode;
 export declare type FieldType = FieldDefinitionNode | InputValueDefinitionNode;

package/typings/config/plugin-config.d.ts

@@ -64,6 +64,9 @@ export declare type FlutterFreezedPluginConfig = {
      * ```ts filename='codegen.ts'
      * import type { CodegenConfig } from '@graphql-codegen/cli';
      *
+     * const Droid = TypeName.fromString('Droid');
+     * const Starship = TypeName.fromString('Starship');
+     *
      * const config: CodegenConfig = {
      *   // ...
      *   generates: {
@@ -119,7 +122,7 @@ export declare type FlutterFreezedPluginConfig = {
     customScalars?: Record<string, string>;
     /**
      * @name defaultValues
-     * @type {([pattern: FieldNamePattern, value: string, appliesOn: AppliesOnParameters[], directiveName?: string, directiveArgName?: string][])}
+     * @type {([pattern: FieldNamePattern, value: string, appliesOn: AppliesOnParameters[]][])}
      * @default undefined
      * @see {@link https://pub.dev/packages/freezed#default-values Default values}
      * @see {@link https://pub.dev/documentation/freezed_annotation/latest/freezed_annotation/Default-class.html Default class}
@@ -132,12 +135,14 @@ export declare type FlutterFreezedPluginConfig = {
      *
      * Use the `appliesOn` to specify where this option should be applied on
      *
-     * If the `directiveName` and `directiveArgName` are passed, the value of the argument of the given directive specified in the Graphql Schema will be used as the defaultValue
      * @exampleMarkdown
      * ## Usage:
      * ```ts filename='codegen.ts'
      * import type { CodegenConfig } from '@graphql-codegen/cli';
      *
+     * const MovieCharacter = TypeName.fromString('MovieCharacter');
+     * const appearsIn = FieldName.fromString('appearsIn');
+     *
      * const config: CodegenConfig = {
      *   // ...
      *   generates: {
@@ -182,6 +187,14 @@ export declare type FlutterFreezedPluginConfig = {
      * ```ts filename='codegen.ts'
      * import type { CodegenConfig } from '@graphql-codegen/cli';
      *
+     * const MovieCharacter = TypeName.fromString('MovieCharacter');
+     * const Droid = TypeName.fromString('Droid');
+     * const Starship = TypeName.fromString('Starship');
+     * const Human = TypeName.fromString('Human');
+     *
+     * const name = FieldName.fromString('name');
+     * const appearsIn = FieldName.fromString('appearsIn');
+     *
      * const config: CodegenConfig = {
      *   // ...
      *   generates: {
@@ -208,7 +221,7 @@ export declare type FlutterFreezedPluginConfig = {
      * @name equal
      * @type {(boolean | TypeNamePattern)}
      * @default undefined
-     * @see {@link url Freezed equal helper method usage}
+     * @see {@link https://pub.dev/packages/freezed#changing-the-behavior-for-a-specific-model Freezed equal helper method usage}
      * @see {@link https://pub.dev/documentation/freezed_annotation/latest/freezed_annotation/Freezed/equal.html Freezed annotation equal property}
      * @summary enables Freezed equal helper method
      * @description The [`freezed`](https://pub.dev/packages/freezed) library has this option enabled by default.
@@ -225,6 +238,9 @@ export declare type FlutterFreezedPluginConfig = {
      * ```ts filename='codegen.ts'
      * import type { CodegenConfig } from '@graphql-codegen/cli';
      *
+     * const Droid = TypeName.fromString('Droid');
+     * const Starship = TypeName.fromString('Starship');
+     *
      * const config: CodegenConfig = {
      *   // ...
      *   generates: {
@@ -246,11 +262,11 @@ export declare type FlutterFreezedPluginConfig = {
     equal?: boolean | TypeNamePattern;
     /**
      * @name escapeDartKeywords
+     * @type {(boolean | [pattern: Pattern, prefix?: string, suffix?: string, appliesOn?: AppliesOn[]][])}
      * @default true
      * @see_also [dartKeywordEscapePrefix,dartKeywordEscapeSuffix]
-     * @summary ensures that the generated Freezed models doesn't use any of Dart's reserved keywords as identifiers
-     * @description Wraps the fields names that are valid Dart keywords with the prefix and suffix given and allows you to specify your preferred casing: "snake_case" | "camelCase" | "PascalCase"
-     *
+     * @summary ensures that the generated Freezed models do not use any of Dart's reserved keywords as identifiers
+     * @description Wraps the fields names that are valid Dart keywords with the prefix and suffix given
      *
      * @exampleMarkdown
      * ## Usage:
@@ -258,6 +274,8 @@ export declare type FlutterFreezedPluginConfig = {
      * ```ts filename='codegen.ts'
      * import type { CodegenConfig } from '@graphql-codegen/cli';
      *
+     * const Episode = TypeName.fromString('Episode');
+     *
      * const config: CodegenConfig = {
      *   // ...
      *   generates: {
@@ -270,15 +288,15 @@ export declare type FlutterFreezedPluginConfig = {
      *           // OR configure how Dart keywords are handled for each type
      *           escapeDartKeywords: [
      *             [
-     *               'Episode.@*FieldNames',
+     *               Pattern.compose([
+     *                 TypeNamePattern.forAllTypeNames(),
+     *                 FieldNamePattern.forAllFieldNamesOfTypeName([Episode]),
+     *               ]),
      *               // `prefix`: defaults to an empty string `''` if undefined.
-     *               // Note that using a underscore `_` as a prefix will make the field as private
+     *               // WARNING: Note that using a underscore `_` as a prefix will make the field as private
      *               undefined,
      *               // `suffix`: defaults to an underscore `_` if undefined
      *               undefined,
-     *               // `casing`: maintains the original casing if undefined.
-     *               // Available options: `snake_cased`, `camelCase` or `PascalCase`
-     *               undefined,
      *               // `appliesOn`: defaults to an ['enum', 'enum_value', 'class', 'factory', 'parameter'] if undefined.
      *               undefined,
      *             ],
@@ -294,18 +312,18 @@ export declare type FlutterFreezedPluginConfig = {
     escapeDartKeywords?: boolean | [pattern: Pattern, prefix?: string, suffix?: string, appliesOn?: AppliesOn[]][];
     /**
      * @name final
+     * @type {([pattern: FieldNamePattern, appliesOn: AppliesOnParameters[]][])}
+     * @default undefined
+     * @see {@link https://pub.dev/packages/freezed#defining-a-mutable-class-instead-of-an-immutable-one Freezed annotation equal property}
      * @summary  marks fields as final
      * @description This will mark the specified parameters as final
-     *
-     *   Requires a an array of tuples with the type signature below:
-     *
-     * ` [typeFieldName: TypeFieldName, appliesOn: AppliesOnParameters[]]`
-     * @default undefined
      * @exampleMarkdown
      * ## Usage:
      * ```ts filename='codegen.ts'
      * import type { CodegenConfig } from '@graphql-codegen/cli';
      *
+     * const id = FieldName.fromString('id');
+     *
      * const config: CodegenConfig = {
      *   // ...
      *   generates: {
@@ -313,10 +331,7 @@ export declare type FlutterFreezedPluginConfig = {
      *       plugins: {
      *         'flutter-freezed': {
      *           // ...
-     *           final: [
-     *             ['Human.[name]', ['parameter']],
-     *             ['Starship.[id],Droid.[id],Human.[id]', ['default_factory_parameter']],
-     *           ],
+     *           final: [[FieldNamePattern.forFieldNamesOfAllTypeNames([id]), ['parameter']]],
      *         },
      *       },
      *     },
@@ -337,6 +352,8 @@ export declare type FlutterFreezedPluginConfig = {
      * ```ts filename='codegen.ts'
      * import type { CodegenConfig } from '@graphql-codegen/cli';
      *
+     * const PaginatorInfo = TypeName.fromString('PaginatorInfo');
+     *
      * const config: CodegenConfig = {
      *   // ...
      *   generates: {
@@ -344,7 +361,7 @@ export declare type FlutterFreezedPluginConfig = {
      *       plugins: {
      *         'flutter-freezed': {
      *           // ...
-     *           ignoreTypes: ['PaginatorInfo'],
+     *           ignoreTypes: TypeNamePattern.forTypeNames([PaginatorInfo]),
      *         },
      *       },
      *     },
@@ -371,6 +388,9 @@ export declare type FlutterFreezedPluginConfig = {
      * ```ts filename='codegen.ts'
      * import type { CodegenConfig } from '@graphql-codegen/cli';
      *
+     * const Droid = TypeName.fromString('Droid');
+     * const Starship = TypeName.fromString('Starship');
+     *
      * const config: CodegenConfig = {
      *   // ...
      *   generates: {
@@ -392,14 +412,19 @@ export declare type FlutterFreezedPluginConfig = {
     immutable?: boolean | TypeNamePattern;
     /**
      * @name makeCollectionsUnmodifiable
-     * @description allows collections(lists/maps) to be modified even if class is immutable
+     * @type {(boolean | TypeNamePattern)}
      * @default undefined
+     * @see {@link https://pub.dev/packages/freezed#allowing-the-mutation-of-listsmapssets Allowing the mutation of Lists/Maps/Sets}
+     * @description allows collections(lists/maps) to be modified even if class is immutable
      *
      * @exampleMarkdown
      * ## Usage:
      * ```ts filename='codegen.ts'
      * import type { CodegenConfig } from '@graphql-codegen/cli';
      *
+     * const Droid = TypeName.fromString('Droid');
+     * const Starship = TypeName.fromString('Starship');
+     *
      * const config: CodegenConfig = {
      *   // ...
      *   generates: {
@@ -408,10 +433,8 @@ export declare type FlutterFreezedPluginConfig = {
      *         'flutter-freezed': {
      *           // ...
      *           makeCollectionsUnmodifiable: true,
-     *           // OR: a comma-separated string
-     *           makeCollectionsUnmodifiable: 'Droid,Starship',
-     *           // OR: a list of GRaphQL Type names
-     *           makeCollectionsUnmodifiable: ['Droid', 'Starship'],
+     *           // OR: enable it for only Droid and Starship GraphQL types
+     *           makeCollectionsUnmodifiable: TypeNamePattern.forTypeNames([Droid, Starship]),
      *         },
      *       },
      *     },
@@ -423,25 +446,43 @@ export declare type FlutterFreezedPluginConfig = {
     makeCollectionsUnmodifiable?: boolean | TypeNamePattern;
     /**
      * @name mergeTypes
+     * @type {(Record<string, TypeName[]>)}
      * @default undefined
-     * @description merges other GraphQL Types as a named factory constructor inside a class generated for the target GraphQL ObjectType.
-     * This option takes an array of strings that are expected to be valid typeNames of GraphQL Types to be merged with the GraphQL Type used as the key.
-     * The array is mapped and each string is converted into a TypeName so please ensure that the strings are valid GraphQL TypeNames
-     * A string that contains any invalid characters will throw an exception.
+     * @description maps over the value(array of typeNames) and transform each as a named factory constructor inside a class generated for the key(target GraphQL Object Type).
      * @exampleMarkdown
-     * ```yaml
-     * generates:
-     *   flutter_app/lib/data/models/app_models.dart
-     *     plugins:
-     *       - flutter-freezed
-     *     config:
-     *      mergeTypes: ["Create$Input", "Update$Input", "Delete$Input"]
+     * ## Usage:
+     * ```ts filename='codegen.ts'
+     * import type { CodegenConfig } from '@graphql-codegen/cli';
+     *
+     * const Movie = TypeName.fromString('Movie');
+     * const CreateMovieInput = TypeName.fromString('CreateMovieInput');
+     * const UpdateMovieInput = TypeName.fromString('UpdateMovieInput');
+     * const UpsertMovieInput = TypeName.fromString('UpsertMovieInput');
+     *
+     * const config: CodegenConfig = {
+     *   // ...
+     *   generates: {
+     *     'lib/data/models/app_models.dart': {
+     *       plugins: {
+     *         'flutter-freezed': {
+     *           // ...
+     *          mergeTypes: {
+     *            [Movie.value]: [CreateMovieInput, UpdateMovieInput, UpsertMovieInput],
+     *          },
+     *         },
+     *       },
+     *     },
+     *   },
+     * };
+     * export default config;
      * ```
      */
-    mergeTypes?: Record<string, string[]>;
+    mergeTypes?: Record<string, TypeName[]>;
     /**
      * @name mutableInputs
-     * @description  since inputs will be used to collect data, it makes sense to make them mutable with Freezed's `@unfreezed` decorator. This overrides(in order words: has a higher precedence than) the `immutable` config value `ONLY` for GraphQL `input types`.
+     * @description  since inputs will be used to collect data, it makes sense to make them mutable with Freezed's `@unfreezed` decorator.
+     *
+     * This overrides(in order words: has a higher precedence than) the `immutable` config value `ONLY` for GraphQL `input types`.
      * @default true
      *
      * @exampleMarkdown
@@ -449,6 +490,9 @@ export declare type FlutterFreezedPluginConfig = {
      * ```ts filename='codegen.ts'
      * import type { CodegenConfig } from '@graphql-codegen/cli';
      *
+     * const CreateMovieInput = TypeName.fromString('CreateMovieInput');
+     * const UpdateMovieInput = TypeName.fromString('UpdateMovieInput');
+     *
      * const config: CodegenConfig = {
      *   // ...
      *   generates: {
@@ -457,10 +501,8 @@ export declare type FlutterFreezedPluginConfig = {
      *         'flutter-freezed': {
      *           // ...
      *           mutableInputs: true,
-     *           // OR: a comma-separated string
-     *           mutableInputs: 'Droid,Starship',
-     *           // OR: a list of GRaphQL Type names
-     *           mutableInputs: ['Droid', 'Starship'],
+     *           // OR: enable it for only Droid and Starship GraphQL types
+     *           mutableInputs: TypeNamePattern.forTypeNames([CreateMovieInput, UpdateMovieInput]),
      *         },
      *       },
      *     },
@@ -480,6 +522,9 @@ export declare type FlutterFreezedPluginConfig = {
      * ```ts filename='codegen.ts'
      * import type { CodegenConfig } from '@graphql-codegen/cli';
      *
+     * const Droid = TypeName.fromString('Droid');
+     * const Starship = TypeName.fromString('Starship');
+     *
      * const config: CodegenConfig = {
      *   // ...
      *   generates: {
@@ -488,10 +533,8 @@ export declare type FlutterFreezedPluginConfig = {
      *         'flutter-freezed': {
      *           // ...
      *           privateEmptyConstructor: true,
-     *           // OR: a comma-separated string
-     *           privateEmptyConstructor: 'Droid,Starship',
-     *           // OR: a list of GRaphQL Type names
-     *           privateEmptyConstructor: ['Droid', 'Starship'],
+     *           // OR: enable it for only Droid and Starship GraphQL types
+     *           privateEmptyConstructor: TypeNamePattern.forTypeNames([Droid, Starship]),
      *         },
      *       },
      *     },
@@ -586,6 +629,7 @@ export declare type AppliesOnMergedFactoryParameters = (typeof APPLIES_ON_MERGED
 export declare type AppliesOnNamedParameters = AppliesOnUnionFactoryParameters | AppliesOnMergedFactoryParameters;
 export declare const APPLIES_ON_PARAMETERS: readonly ["parameter", "default_factory_parameter", "named_factory_parameter", "union_factory_parameter", "merged_factory_parameter"];
 export declare type AppliesOnParameters = AppliesOnDefaultFactoryParameters | AppliesOnNamedParameters;
+export declare const APPLIES_ON_ALL_BLOCKS: readonly ["enum", "enum_value", "class", "factory", "parameter"];
 export declare type DartIdentifierCasing = 'snake_case' | 'camelCase' | 'PascalCase';
 export declare type NodeType = ObjectTypeDefinitionNode | InputObjectTypeDefinitionNode | UnionTypeDefinitionNode | EnumTypeDefinitionNode;
 export declare type FieldType = FieldDefinitionNode | InputValueDefinitionNode;

package/typings/freezed-declaration-blocks/class-block.d.cts

@@ -8,5 +8,5 @@ export declare class ClassBlock {
     static decorateAsUnfreezed: (config: FlutterFreezedPluginConfig, node: NodeType) => "@unfreezed\n" | "@freezed\n";
     static buildHeader: (config: FlutterFreezedPluginConfig, typeName: TypeName, _className: string) => string;
     static buildBody: (config: FlutterFreezedPluginConfig, node: NodeType) => string;
-    static buildFooter: (config: FlutterFreezedPluginConfig, typeName: TypeName, _className: string) => string;
+    static buildFooter: (_className: string) => string;
 }

package/typings/freezed-declaration-blocks/class-block.d.ts

@@ -8,5 +8,5 @@ export declare class ClassBlock {
     static decorateAsUnfreezed: (config: FlutterFreezedPluginConfig, node: NodeType) => "@unfreezed\n" | "@freezed\n";
     static buildHeader: (config: FlutterFreezedPluginConfig, typeName: TypeName, _className: string) => string;
     static buildBody: (config: FlutterFreezedPluginConfig, node: NodeType) => string;
-    static buildFooter: (config: FlutterFreezedPluginConfig, typeName: TypeName, _className: string) => string;
+    static buildFooter: (_className: string) => string;
 }