@graphql-codegen/flutter-freezed 2.11.2-alpha-20221101110911-a036e7a25 → 3.0.0

package/esm/utils.js

@@ -1,216 +1,60 @@
-import { FreezedDeclarationBlock } from './freezed-declaration-blocks/index.js';
-export function transformDefinition(config, freezedFactoryBlockRepository, node) {
-    var _a;
-    // ignore these...
-    if (['Query', 'Mutation', 'Subscription', ...((_a = config === null || config === void 0 ? void 0 : config.ignoreTypes) !== null && _a !== void 0 ? _a : [])].includes(node.name.value)) {
-        return '';
-    }
-    return new FreezedDeclarationBlock(config, freezedFactoryBlockRepository, node).init();
-}
+//#region helpers
+import { camelCase, pascalCase, snakeCase } from 'change-case-all';
+import { Kind } from 'graphql';
+import { Config } from './config/config-value.js';
+import { DART_KEYWORDS } from './config/plugin-config.js';
+export const strToList = (str) => (str.length < 1 ? [] : str.split(/\s*,\s*/gim).filter(s => s.length > 0));
+export const arrayWrap = (value) => value === undefined ? [] : Array.isArray(value) ? value : [value];
+export const resetIndex = (regexp) => (regexp.lastIndex = 0);
+export const nodeIsObjectType = (node) => node.kind === Kind.OBJECT_TYPE_DEFINITION || node.kind === Kind.INPUT_OBJECT_TYPE_DEFINITION;
+export const appliesOnBlock = (configAppliesOn, blockAppliesOn) => configAppliesOn.some(a => blockAppliesOn.includes(a));
+export const dartCasing = (name, casing) => {
+    if (casing === 'camelCase') {
+        return camelCase(name);
+    }
+    else if (casing === 'PascalCase') {
+        return pascalCase(name);
+    }
+    else if (casing === 'snake_case') {
+        return snakeCase(name);
+    }
+    return name;
+};
 /**
- * returns the value of the FreezedConfig option
- * for a specific type if given typeName
- * or else fallback to the global FreezedConfig value
+ * checks whether name is a Dart Language keyword
+ * @param identifier The name or identifier to be checked
+ * @returns `true` if name is a Dart Language keyword, otherwise `false`
  */
-export function getFreezedConfigValue(option, config, typeName) {
-    var _a, _b, _c, _d, _e;
-    if (typeName) {
-        return (_d = (_c = (_b = (_a = config === null || config === void 0 ? void 0 : config.typeSpecificFreezedConfig) === null || _a === void 0 ? void 0 : _a[typeName]) === null || _b === void 0 ? void 0 : _b.config) === null || _c === void 0 ? void 0 : _c[option]) !== null && _d !== void 0 ? _d : getFreezedConfigValue(option, config);
-    }
-    return (_e = config === null || config === void 0 ? void 0 : config.globalFreezedConfig) === null || _e === void 0 ? void 0 : _e[option];
-}
-/**
- * @description filters the customDirectives to return those that are applied on a list of blocks
- */
-export function getCustomDecorators(config, appliesOn, nodeName, fieldName) {
-    var _a, _b, _c, _d, _e, _f, _g, _h;
-    const filteredCustomDecorators = {};
-    const globalCustomDecorators = (_b = (_a = config === null || config === void 0 ? void 0 : config.globalFreezedConfig) === null || _a === void 0 ? void 0 : _a.customDecorators) !== null && _b !== void 0 ? _b : {};
-    let customDecorators = { ...globalCustomDecorators };
-    if (nodeName) {
-        const typeConfig = (_c = config === null || config === void 0 ? void 0 : config.typeSpecificFreezedConfig) === null || _c === void 0 ? void 0 : _c[nodeName];
-        const typeSpecificCustomDecorators = (_e = (_d = typeConfig === null || typeConfig === void 0 ? void 0 : typeConfig.config) === null || _d === void 0 ? void 0 : _d.customDecorators) !== null && _e !== void 0 ? _e : {};
-        customDecorators = { ...customDecorators, ...typeSpecificCustomDecorators };
-        if (fieldName) {
-            const fieldSpecificCustomDecorators = (_h = (_g = (_f = typeConfig === null || typeConfig === void 0 ? void 0 : typeConfig.fields) === null || _f === void 0 ? void 0 : _f[fieldName]) === null || _g === void 0 ? void 0 : _g.customDecorators) !== null && _h !== void 0 ? _h : {};
-            customDecorators = { ...customDecorators, ...fieldSpecificCustomDecorators };
-        }
-    }
-    Object.entries(customDecorators).forEach(([key, value]) => {
-        var _a;
-        return (_a = value === null || value === void 0 ? void 0 : value.applyOn) === null || _a === void 0 ? void 0 : _a.forEach(a => {
-            if (appliesOn.includes(a)) {
-                filteredCustomDecorators[key] = value;
-            }
-        });
-    });
-    return filteredCustomDecorators;
-}
-export function transformCustomDecorators(customDecorators, node, field) {
-    var _a, _b;
-    let result = [];
-    result = [
-        ...result,
-        ...((_a = node === null || node === void 0 ? void 0 : node.directives) !== null && _a !== void 0 ? _a : [])
-            .concat((_b = field === null || field === void 0 ? void 0 : field.directives) !== null && _b !== void 0 ? _b : [])
-            // extract only the directives whose names were specified as keys
-            // and have values that not undefined or null in the customDecorator record
-            .filter(d => {
-            var _a;
-            const key = d.name.value;
-            const value = (_a = customDecorators[key]) !== null && _a !== void 0 ? _a : customDecorators[`@${key}`];
-            if (value && value.mapsToFreezedAs !== 'custom') {
-                return true;
-            }
-            return false;
-        })
-            // transform each directive to string
-            .map(d => directiveToString(d, customDecorators)),
-    ];
-    // for  decorators that mapsToFreezedAs === 'custom'
-    Object.entries(customDecorators).forEach(([key, value]) => {
-        if (value.mapsToFreezedAs === 'custom') {
-            const args = value === null || value === void 0 ? void 0 : value.arguments;
-            // if the custom directives have arguments,
-            if (args && args !== []) {
-                // join them with a comma in the parenthesis
-                result = [...result, `${key}(${args.join(', ')})\n`];
-            }
-            else {
-                // else return the customDecorator key just as it is
-                result = [...result, key + '\n'];
-            }
-        }
-    });
-    return result;
-}
+export const isDartKeyword = (identifier) => DART_KEYWORDS[identifier] !== undefined;
 /**
- * transforms the directive into a decorator array
- * this decorator array might contain a `final` string which would be filtered out
- * and used to mark the parameter block as final
+ * Ensures that the blockName isn't a valid Dart language reserved keyword.
+ * It wraps the identifier with the prefix and suffix then transforms the casing as specified in the config
+ * @param config
+ * @param name
+ * @param typeName
+ * @returns
  */
-function directiveToString(directive, customDecorators) {
-    var _a, _b, _c, _d, _e;
-    const key = directive.name.value;
-    const value = customDecorators[key];
-    if (value.mapsToFreezedAs === 'directive') {
-        // get the directive's arguments
-        const directiveArgs = (_a = directive === null || directive === void 0 ? void 0 : directive.arguments) !== null && _a !== void 0 ? _a : [];
-        // extract the directive's argument using the template index: ["$0", "$1", ...]
-        // specified in the customDecorator.arguments array
-        const args = (_b = value === null || value === void 0 ? void 0 : value.arguments) === null || _b === void 0 ? void 0 : _b.filter(a => directiveArgs[argToInt(a)]).map(a => directiveArgs[argToInt(a)]).map(a => `${a.name}: ${a.value}`);
-        // if the args is not empty
-        if (args !== []) {
-            // returns "@directiveName(argName: argValue, argName: argValue ...)"
-            return `@${directive.name.value}(${args === null || args === void 0 ? void 0 : args.join(', ')})\n`;
-        }
-    }
-    else if (value.mapsToFreezedAs === '@Default') {
-        const defaultValue = (_c = directive === null || directive === void 0 ? void 0 : directive.arguments) === null || _c === void 0 ? void 0 : _c[argToInt((_e = (_d = value === null || value === void 0 ? void 0 : value.arguments) === null || _d === void 0 ? void 0 : _d[0]) !== null && _e !== void 0 ? _e : '0')];
-        if (defaultValue) {
-            return `@Default(value: ${defaultValue})\n`;
-        }
-    }
-    // returns either "@deprecated" || "final".
-    // `final` to be filtered from the decorators array when applying the decorators
-    return value.mapsToFreezedAs + '\n';
-}
-/** transforms string template: "$0" into an integer: 1 */
-function argToInt(arg) {
-    var _a;
-    const parsedIndex = Number.parseInt((_a = arg.replace('$', '').trim()) !== null && _a !== void 0 ? _a : '0'); // '$1 => 1
-    return parsedIndex ? parsedIndex : 0;
-}
-/** returns freezed import statements */
-export function addFreezedImportStatements(fileName) {
-    return [
-        "import 'package:freezed_annotation/freezed_annotation.dart';\n",
-        "import 'package:flutter/foundation.dart';\n\n",
-        `part ${fileName.replace(/\.dart/g, '')}.dart;\n`,
-        `part '${fileName.replace(/\.dart/g, '')}.g.dart';\n\n`,
-    ].join('');
-}
-/** a class variant of the getFreezedConfigValue helper function
- *
- * returns the value of the FreezedConfig option
- * for a specific type if given typeName
- * or else fallback to the global FreezedConfig value
- */
-export class FreezedConfigValue {
-    constructor(_config, _typeName) {
-        this._config = _config;
-        this._typeName = _typeName;
-        this._config = _config;
-        this._typeName = _typeName;
-    }
-    /**
-     * returns the value of the FreezedConfig option
-     * for a specific type if given typeName
-     * or else fallback to the global FreezedConfig value
-     */
-    get(option) {
-        return getFreezedConfigValue(option, this._config, this._typeName);
-    }
-}
-/**
- * stores an instance of  FreezedFactoryBlock using the node names as the key
- * and returns that instance when replacing tokens
- * */
-export class FreezedFactoryBlockRepository {
-    constructor() {
-        this._store = {};
-    }
-    get(key) {
-        return this._store[key];
-    }
-    register(key, value) {
-        this._store[key] = value;
-        return value;
-    }
-    retrieve(key, appliesOn, name, typeName) {
-        if (this._store[key]) {
-            return (this._store[key]
-                .setDecorators(appliesOn, key)
-                .setKey(key)
-                .setName(name)
-                .setNamedConstructor(typeName)
-                .init()
-                .toString() + '\n');
-        }
-        return '';
-    }
-}
-/** initializes a FreezedPluginConfig with the defaults values */
-export class DefaultFreezedPluginConfig {
-    constructor(config = {}) {
-        var _a, _b, _c, _d, _e, _f;
-        Object.assign(this, {
-            camelCasedEnums: (_a = config.camelCasedEnums) !== null && _a !== void 0 ? _a : true,
-            customScalars: (_b = config.customScalars) !== null && _b !== void 0 ? _b : {},
-            fileName: (_c = config.fileName) !== null && _c !== void 0 ? _c : 'app_models',
-            globalFreezedConfig: { ...new DefaultFreezedConfig(), ...((_d = config.globalFreezedConfig) !== null && _d !== void 0 ? _d : {}) },
-            typeSpecificFreezedConfig: (_e = config.typeSpecificFreezedConfig) !== null && _e !== void 0 ? _e : {},
-            ignoreTypes: (_f = config.ignoreTypes) !== null && _f !== void 0 ? _f : [],
-        });
-    }
-}
-/** initializes a FreezedConfig with the defaults values */
-export class DefaultFreezedConfig {
-    constructor() {
-        Object.assign(this, {
-            alwaysUseJsonKeyName: false,
-            copyWith: undefined,
-            customDecorators: {},
-            defaultUnionConstructor: true,
-            equal: undefined,
-            fromJsonToJson: true,
-            immutable: true,
-            makeCollectionsUnmodifiable: undefined,
-            mergeInputs: [],
-            mutableInputs: true,
-            privateEmptyConstructor: true,
-            unionKey: undefined,
-            unionValueCase: undefined,
-        });
-    }
-}
+export const escapeDartKeyword = (config, blockAppliesOn, identifier, typeName, fieldName) => {
+    if (isDartKeyword(identifier)) {
+        const [prefix, suffix] = Config.escapeDartKeywords(config, blockAppliesOn, typeName, fieldName);
+        return `${prefix}${identifier}${suffix}`;
+    }
+    return identifier;
+};
+export const atJsonKeyDecorator = ({ defaultValue, disallowNullValue, fromJson, ignore, includeIfNull, name, required, toJson, }) => {
+    const body = [
+        stringIsNotEmpty(defaultValue) ? `defaultValue: ${defaultValue}` : undefined,
+        disallowNullValue ? `disallowNullValue: ${disallowNullValue}` : undefined,
+        stringIsNotEmpty(fromJson) ? `fromJson: ${fromJson}` : undefined,
+        ignore ? `ignore: ${ignore}` : undefined,
+        includeIfNull ? `includeIfNull: ${includeIfNull}` : undefined,
+        stringIsNotEmpty(name) ? `name: '${name}'` : undefined,
+        required ? `required: ${required}` : undefined,
+        stringIsNotEmpty(toJson) ? `toJson: ${toJson}` : undefined,
+    ]
+        .filter(value => value !== undefined)
+        .join(',');
+    return stringIsNotEmpty(body) ? `@JsonKey(${body})\n` : '';
+};
+export const stringIsNotEmpty = (str) => (str === null || str === void 0 ? void 0 : str.length) > 0;
+//#endregion

package/package.json

@@ -1,21 +1,21 @@
 {
   "name": "@graphql-codegen/flutter-freezed",
-  "version": "2.11.2-alpha-20221101110911-a036e7a25",
+  "version": "3.0.0",
   "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"
   },
   "dependencies": {
-    "@graphql-codegen/plugin-helpers": "2.7.2-alpha-20221101110911-a036e7a25",
+    "@graphql-codegen/plugin-helpers": "^3.0.0",
     "@graphql-codegen/schema-ast": "^2.5.0",
-    "@graphql-codegen/visitor-plugin-common": "2.13.1-alpha-20221101110911-a036e7a25",
+    "@graphql-codegen/visitor-plugin-common": "2.13.1",
     "auto-bind": "~4.0.0",
-    "tslib": "~2.4.0",
-    "change-case-all": "1.0.14"
+    "change-case-all": "1.0.15",
+    "tslib": "~2.4.0"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/dotansimha/graphql-code-generator.git",
+    "url": "https://github.com/dotansimha/graphql-code-generator-community.git",
     "directory": "packages/plugins/typescript/typescript"
   },
   "license": "MIT",

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

@@ -0,0 +1,24 @@
+import { FieldName, TypeName, TypeNamePattern } from './pattern.cjs';
+import { AppliesOn, AppliesOnFactory, AppliesOnParameters, FlutterFreezedPluginConfig } from './plugin-config.cjs';
+export declare class Config {
+    static camelCasedEnums: (config: FlutterFreezedPluginConfig) => import("./plugin-config.js").DartIdentifierCasing;
+    static copyWith: (config: FlutterFreezedPluginConfig, typeName?: TypeName) => boolean;
+    static customScalars: (config: FlutterFreezedPluginConfig, graphqlScalar: string) => string;
+    static defaultValues: (config: FlutterFreezedPluginConfig, blockAppliesOn: readonly AppliesOnParameters[], typeName: TypeName, fieldName: FieldName) => string;
+    static deprecated: (config: FlutterFreezedPluginConfig, blockAppliesOn: readonly (AppliesOnFactory | AppliesOnParameters)[], typeName: TypeName, fieldName?: FieldName) => "" | "@deprecated\n";
+    static equal: (config: FlutterFreezedPluginConfig, typeName?: TypeName) => boolean;
+    static escapeDartKeywords: (config: FlutterFreezedPluginConfig, blockAppliesOn: readonly AppliesOn[], typeName?: TypeName, fieldName?: FieldName) => [prefix?: string, suffix?: string];
+    static final: (config: FlutterFreezedPluginConfig, blockAppliesOn: readonly AppliesOnParameters[], typeName: TypeName, fieldName: FieldName) => boolean;
+    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 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 enableWithBooleanOrTypeFieldName: (value?: boolean | TypeNamePattern, typeName?: TypeName) => boolean;
+    static create: (...config: Partial<FlutterFreezedPluginConfig>[]) => FlutterFreezedPluginConfig;
+}

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

@@ -0,0 +1,24 @@
+import { FieldName, TypeName, TypeNamePattern } from './pattern.js';
+import { AppliesOn, AppliesOnFactory, AppliesOnParameters, FlutterFreezedPluginConfig } from './plugin-config.js';
+export declare class Config {
+    static camelCasedEnums: (config: FlutterFreezedPluginConfig) => import("./plugin-config.js").DartIdentifierCasing;
+    static copyWith: (config: FlutterFreezedPluginConfig, typeName?: TypeName) => boolean;
+    static customScalars: (config: FlutterFreezedPluginConfig, graphqlScalar: string) => string;
+    static defaultValues: (config: FlutterFreezedPluginConfig, blockAppliesOn: readonly AppliesOnParameters[], typeName: TypeName, fieldName: FieldName) => string;
+    static deprecated: (config: FlutterFreezedPluginConfig, blockAppliesOn: readonly (AppliesOnFactory | AppliesOnParameters)[], typeName: TypeName, fieldName?: FieldName) => "" | "@deprecated\n";
+    static equal: (config: FlutterFreezedPluginConfig, typeName?: TypeName) => boolean;
+    static escapeDartKeywords: (config: FlutterFreezedPluginConfig, blockAppliesOn: readonly AppliesOn[], typeName?: TypeName, fieldName?: FieldName) => [prefix?: string, suffix?: string];
+    static final: (config: FlutterFreezedPluginConfig, blockAppliesOn: readonly AppliesOnParameters[], typeName: TypeName, fieldName: FieldName) => boolean;
+    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 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 enableWithBooleanOrTypeFieldName: (value?: boolean | TypeNamePattern, typeName?: TypeName) => boolean;
+    static create: (...config: Partial<FlutterFreezedPluginConfig>[]) => FlutterFreezedPluginConfig;
+}

package/typings/config/pattern.d.cts

@@ -0,0 +1,252 @@
+/**
+ * A list of GraphQL Type Names
+ */
+declare type TypeNames = TypeName | TypeName[];
+/**
+ * A list of field names of a GraphQL Type
+ */
+declare type FieldNames = FieldName | FieldName[];
+/**
+ * @name TypeName
+ * @description represents a single valid GraphQL Type Name used in the GraphQL Schema provided
+ * @exampleMarkdown
+ * ```ts filename:"config.ts"
+ * // returns a TypeName
+ * let typeName: TypeName = TypeName.fromString('Droid');
+ *
+ * // to configure a FactoryBlock, use the `TypeName.fromUnionOfTypeNames(className, factoryName)`
+ * let typeName: TypeName = TypeName.fromUnionOfTypeNames(SearchResult, Droid);
+
+ * // the following will throw an error
+ * // can contain only a single value...
+ * let typeName: TypeName = TypeName.fromString('Droid, Human'); // throws an Error
+ *
+ * // value can not be an empty string...
+ * let typeName: TypeName = TypeName.fromString(''); // throws an Error
+ *
+ * // value must contain only AlphaNumeric characters only...
+ * let typeName: TypeName = TypeName.fromString('Invalid.Name'); // throws an Error
+ * ```
+ */
+export declare class TypeName {
+    private _value;
+    private constructor();
+    get value(): string;
+    static get allTypeNames(): string;
+    static fromUnionOfTypeNames: (className: TypeName, factoryName: TypeName) => TypeName;
+    static fromString: (value: string) => TypeName;
+}
+/**
+ * @name FieldName
+ * @description Represents a single valid name of a field belong to a Graphql Type.
+ * @exampleMarkdown
+ * ```ts filename:"config.ts"
+ * // returns a FieldName
+ * let fieldName: FieldName = FieldName.fromString('id');
+ *
+ * // the following will throw an error
+ * // can contain only a single value...
+ * let fieldName: FieldName = FieldName.fromString('id, name'); // throws an Error
+ *
+ * // value can not be an empty string...
+ * let fieldName: FieldName = FieldName.fromString(''); // throws an Error
+ *
+ * // value must contain only AlphaNumeric characters only...
+ * let fieldName: FieldName = FieldName.fromString('Invalid.Name'); // throws an Error
+ * ```
+ */
+export declare class FieldName {
+    private _value;
+    private constructor();
+    get value(): string;
+    static get allFieldNames(): string;
+    static fromString: (value: string) => FieldName;
+}
+/**
+ * @name Pattern
+ * @description The base class for TypeNamePattern and FieldNamePattern
+ * @see {@link url TypeNamePattern}
+ * @see {@link url FieldNamePattern}
+ */
+export declare class Pattern {
+    private _value;
+    protected constructor(value: string);
+    get value(): string;
+    protected static fromString: (value: string) => Pattern;
+    static attemptMatchAndConfigure: (pattern: FieldNamePattern, typeName: TypeName, fieldName?: FieldName) => MatchAndConfigure;
+    static compose: (data: Pattern[]) => Pattern;
+    static split: (pattern: Pattern) => Pattern[];
+    static getMatchList: (patternType: 'TypeNamePattern' | 'FieldNamePattern' | 'Pattern') => string[];
+    /**
+     * finds the last pattern that configures the typeName and/or fieldName given
+     * @param pattern
+     * @param typeName
+     * @param fieldName
+     * @returns true if a pattern marks the typeName and or fieldName given to be configured, otherwise false
+     */
+    static findLastConfiguration: (pattern: Pattern, typeName: TypeName, fieldName?: FieldName) => boolean;
+}
+/**
+ *  @name TypeNamePattern
+ *
+ * @description A compact string of patterns used in the config for granular configuration of Graphql Types.
+ *
+ * The string can contain one or more patterns, each pattern ends with a semi-colon (`;`).
+ *
+ * To apply an option to all Graphql Types or all fields, use the allTypeNames (`@*TypeNames`) tokens.
+ *
+ * Wherever you use the allTypeNames token, know very well that you can make some exceptions. After all, to every rule, there is an exception.
+ *
+ * A **square bracket** (`[]`) is used to specify what should be included and a **negated square bracket** (`-[]`) is used to specify what should be excluded.
+ *
+ * Manually typing out a pattern may be prone to typos resulting in invalid patterns therefore the [`TypeNamePattern`]() class exposes some builder methods to be used in the plugin config file.
+ *
+ * ## Available Builder Methods and the patterns they make
+ * ```ts
+ * const Droid = TypeName.fromString('Droid');
+ * const Starship = TypeName.fromString('Starship');
+ * const Human = TypeName.fromString('Human');
+ * const Movie = TypeName.fromString('Movie');
+
+ *
+ * // Configuring specific Graphql Types
+ * const pattern = TypeNamePattern.forTypeNames([Droid, Starship]);
+ * console.log(pattern); // "Droid;Starship;"
+ *
+ * // Configuring all Graphql Types
+ * const pattern = TypeNamePattern.forAllTypeNames();
+ * console.log(pattern); // "@*TypeNames;"
+
+ * // Configuring all Graphql Types except those specified in the exclusion list of TypeNames
+ * const pattern = TypeNamePattern.forAllTypeNamesExcludeTypeNames([Droid, Starship]);
+ * console.log(pattern); // "@*TypeNames-[Droid,Starship];"
+ *
+ */
+export declare class TypeNamePattern extends Pattern {
+    private constructor();
+    static forTypeNames: (typeNames: TypeNames) => TypeNamePattern;
+    static regexpForTypeNames: RegExp;
+    static matchAndConfigureTypeNames: (pattern: TypeNamePattern, typeName: TypeName) => MatchAndConfigure;
+    static forAllTypeNames: () => TypeNamePattern;
+    static regexpForAllTypeNames: RegExp;
+    static matchAndConfigureAllTypeNames: (pattern: TypeNamePattern, typeName: TypeName) => MatchAndConfigure;
+    static forAllTypeNamesExcludeTypeNames: (typeNames: TypeNames) => TypeNamePattern;
+    static regexpForAllTypeNamesExcludeTypeNames: RegExp;
+    static matchAndConfigureAllTypeNamesExcludeTypeNames: (pattern: TypeNamePattern, typeName: TypeName) => MatchAndConfigure;
+}
+/**
+ *  @name FieldNamePattern
+ *
+ * @description A compact string of patterns used in the config for granular configuration the fields of a Graphql Type
+ *
+ * The string can contain one or more patterns, each pattern ends with a semi-colon (`;`).
+ *
+ * A dot (`.`) is used to separate the TypeName from the FieldNames in each pattern.
+ *
+ * To apply an option to all Graphql Types or all fields, use the allTypeNames (`@*TypeNames`) and allFieldNames (`@*FieldNames`) tokens respectively.
+ *
+ * Wherever you use the allTypeNames and the allFieldNames, know very well that you can make some exceptions. After all, to every rule, there is an exception.
+ *
+ * A **square bracket** (`[]`) is used to specify what should be included and a **negated square bracket** (`-[]`) is used to specify what should be excluded.
+ *
+ * Manually typing out a pattern may be prone to typos resulting in invalid patterns therefore the [`FieldName`]() class exposes some builder methods to be used in your plugin config file.
+ *
+ * ## Available Builder Methods and the patterns they make
+ * ```ts
+ * const Droid = TypeName.fromString('Droid');
+ * const Starship = TypeName.fromString('Starship');
+ * const Human = TypeName.fromString('Human');
+ * const Movie = TypeName.fromString('Movie');
+ *
+ * const id = FieldName.fromString('id');
+ * const name = FieldName.fromString('name');
+ * const friends = FieldName.fromString('friends');
+ * const friend = FieldName.fromString('friend');
+ * const title = FieldName.fromString('title');
+ * const episode = FieldName.fromString('episode');
+ * const length = FieldName.fromString('length');
+ *
+ * // Configuring specific fields of a specific Graphql Type
+ * const pattern = FieldNamePattern.forFieldNamesOfTypeName([
+ *   [Droid, [id, name, friends]], // individual
+ *   [Human, [id, name, title]], // individual
+ *   [Starship, [name, length]], // individual
+ * ]);
+ * console.log(pattern); // "Droid.[id,name,friends];Human.[id,name,title];Starship.[name,length];"
+ *
+ * // Configuring all fields of a specific Graphql Type
+ * const pattern = FieldNamePattern.forAllFieldNamesOfTypeName([Droid, Movie]);
+ * console.log(pattern); // "Droid.@*FieldNames;Movie.@*FieldNames;"
+ *
+ * // Configuring all fields except those specified in the exclusion list of FieldNames for a specific GraphQL Type
+ * const pattern = FieldNamePattern.forAllFieldNamesExcludeFieldNamesOfTypeName([
+ *   [Droid, [id, name, friends]], // individual
+ *   [Human, [id, name, title]], // individual
+ *   [Starship, [name, length]], // individual
+ * ]);
+ * console.log(pattern); // "Droid.@*FieldNames-[id,name,friends];Human.@*FieldNames-[id,name,title];Starship.@*FieldNames-[name,length];"
+ *
+ * // Configuring specific fields of all Graphql Types
+ * const pattern = FieldNamePattern.forFieldNamesOfAllTypeNames([id, name, friends]);
+ * console.log(pattern); // "@*TypeNames.[id,name,friends];"
+ *
+ * // Configuring all fields of all Graphql Types
+ * const pattern = FieldNamePattern.forAllFieldNamesOfAllTypeNames();
+ * console.log(pattern); // "@*TypeNames.@*FieldNames;"
+ *
+ * // Configuring all fields except those specified in the exclusion list of FieldNames for all GraphQL Types
+ * const pattern = FieldNamePattern.forAllFieldNamesExcludeFieldNamesOfAllTypeNames([id, name, friends]);
+ * console.log(pattern); // "@*TypeNames.@*FieldNames-[id,name,friends];"
+ *
+ * // Configuring specific fields of all GraphQL Types except those specified in the exclusion list of TypeNames
+ * const pattern = FieldNamePattern.forFieldNamesOfAllTypeNamesExcludeTypeNames([Droid, Human], [id, name, friends]);
+ * console.log(pattern); // "@*TypeNames-[Droid,Human].[id,name,friends];"
+ *
+ * // Configuring all fields of all GraphQL Types except those specified in the exclusion list of TypeNames
+ * const pattern = FieldNamePattern.forAllFieldNamesOfAllTypeNamesExcludeTypeNames([Droid, Human]);
+ * console.log(pattern); // "@*TypeNames-[Droid,Human].@*FieldNames;"
+ *
+ * // Configuring all fields except those specified in the exclusion list of FieldNames of all GraphQL Types except those specified in the exclusion list of TypeNames
+ * const pattern = FieldNamePattern.forAllFieldNamesExcludeFieldNamesOfAllTypeNamesExcludeTypeNames(
+ *   [Droid, Human],
+ *   [id, name, friends]
+ * );
+ * console.log(pattern); // "@*TypeNames-[Droid,Human].@*FieldNames-[id,name,friends];"
+ * ```
+ *
+ */
+export declare class FieldNamePattern extends Pattern {
+    private constructor();
+    static forFieldNamesOfTypeName: (data: [typeNames: TypeNames, fieldNames: FieldNames][]) => FieldNamePattern;
+    static regexpForFieldNamesOfTypeName: RegExp;
+    static matchAndConfigureFieldNamesOfTypeName: (pattern: FieldNamePattern, typeName: TypeName, fieldName: FieldName) => MatchAndConfigure;
+    static forAllFieldNamesOfTypeName: (typeNames: TypeNames) => FieldNamePattern;
+    static regexpForAllFieldNamesOfTypeName: RegExp;
+    static matchAndConfigureAllFieldNamesOfTypeName: (pattern: FieldNamePattern, typeName: TypeName, fieldName: FieldName) => MatchAndConfigure;
+    static forAllFieldNamesExcludeFieldNamesOfTypeName: (data: [typeNames: TypeNames, fieldNames: FieldNames][]) => FieldNamePattern;
+    static regexpForAllFieldNamesExcludeFieldNamesOfTypeName: RegExp;
+    static matchAndConfigureAllFieldNamesExcludeFieldNamesOfTypeName: (pattern: FieldNamePattern, typeName: TypeName, fieldName: FieldName) => MatchAndConfigure;
+    static forFieldNamesOfAllTypeNames: (fieldNames: FieldNames) => FieldNamePattern;
+    static regexpForFieldNamesOfAllTypeNames: RegExp;
+    static matchAndConfigureFieldNamesOfAllTypeNames: (pattern: FieldNamePattern, typeName: TypeName, fieldName: FieldName) => MatchAndConfigure;
+    static forAllFieldNamesOfAllTypeNames: () => FieldNamePattern;
+    static regexpForAllFieldNamesOfAllTypeNames: RegExp;
+    static matchAndConfigureAllFieldNamesOfAllTypeNames: (pattern: FieldNamePattern, typeName: TypeName, fieldName: FieldName) => MatchAndConfigure;
+    static forAllFieldNamesExcludeFieldNamesOfAllTypeNames: (fieldNames: FieldNames) => FieldNamePattern;
+    static regexpForAllFieldNamesExcludeFieldNamesOfAllTypeNames: RegExp;
+    static matchAndConfigureAllFieldNamesExcludeFieldNamesOfAllTypeNames: (pattern: FieldNamePattern, typeName: TypeName, fieldName: FieldName) => MatchAndConfigure;
+    static forFieldNamesOfAllTypeNamesExcludeTypeNames: (typeNames: TypeNames, fieldNames: FieldNames) => FieldNamePattern;
+    static regexpForFieldNamesOfAllTypeNamesExcludeTypeNames: RegExp;
+    static matchAndConfigureFieldNamesOfAllTypeNamesExcludeTypeNames: (pattern: FieldNamePattern, typeName: TypeName, fieldName: FieldName) => MatchAndConfigure;
+    static forAllFieldNamesOfAllTypeNamesExcludeTypeNames: (typeNames: TypeNames) => FieldNamePattern;
+    static regexpForAllFieldNamesOfAllTypeNamesExcludeTypeNames: RegExp;
+    static matchAndConfigureAllFieldNamesOfAllTypeNamesExcludeTypeNames: (pattern: FieldNamePattern, typeName: TypeName, fieldName: FieldName) => MatchAndConfigure;
+    static forAllFieldNamesExcludeFieldNamesOfAllTypeNamesExcludeTypeNames: (typeNames: TypeNames, fieldNames: FieldNames) => FieldNamePattern;
+    static regexpForAllFieldNamesExcludeFieldNamesOfAllTypeNamesExcludeTypeNames: RegExp;
+    static matchAndConfigureAllFieldNamesExcludeFieldNamesOfAllTypeNamesExcludeTypeNames: (pattern: FieldNamePattern, typeName: TypeName, fieldName: FieldName) => MatchAndConfigure;
+}
+export declare type MatchAndConfigure = Record<string, {
+    matchFound: boolean;
+    shouldBeConfigured: boolean;
+}>;
+export {};