@graphql-codegen/flutter-freezed 2.11.1

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

@@ -0,0 +1,146 @@
+import { indent } from '@graphql-codegen/visitor-plugin-common';
+import { camelCase } from 'change-case-all';
+import { getCustomDecorators, transformCustomDecorators, FreezedConfigValue } from '../utils.js';
+/**
+ * maps GraphQL scalar types to Dart's scalar types
+ */
+export const DART_SCALARS = {
+    ID: 'String',
+    String: 'String',
+    Boolean: 'bool',
+    Int: 'int',
+    Float: 'double',
+    DateTime: 'DateTime',
+};
+export class FreezedParameterBlock {
+    constructor(_config, _appliesOn, _node, _field) {
+        this._config = _config;
+        this._appliesOn = _appliesOn;
+        this._node = _node;
+        this._field = _field;
+        /** document the property */
+        this._comment = '';
+        /** a list of decorators to copy paste to the generator */
+        this._decorators = [];
+        this.propertyType = (field, type, parentType) => {
+            if (this.isNonNullType(type)) {
+                return this.propertyType(field, type.type, type);
+            }
+            if (this.isListType(type)) {
+                const T = this.propertyType(field, type.type, type);
+                return `List<${T}>${this.isNonNullType(parentType) ? '' : '?'}`;
+            }
+            if (this.isNamedType(type)) {
+                return `${this.scalar(type.name.value)}${this.isNonNullType(parentType) ? '' : '?'}`;
+            }
+            return '';
+        };
+        this.isListType = (type) => (type === null || type === void 0 ? void 0 : type.kind) === 'ListType';
+        this.isNonNullType = (type) => (type === null || type === void 0 ? void 0 : type.kind) === 'NonNullType';
+        this.isNamedType = (type) => (type === null || type === void 0 ? void 0 : type.kind) === 'NamedType';
+        this._config = _config;
+        this._appliesOn = _appliesOn;
+        this._node = _node;
+        this._field = _field;
+        this._freezedConfigValue = new FreezedConfigValue(_config, _node.name.value);
+    }
+    init() {
+        this.setComment().setDecorators().setRequired().setType().setName().setShape().setBlock();
+        return this;
+    }
+    setComment() {
+        var _a;
+        const comment = (_a = this._field.description) === null || _a === void 0 ? void 0 : _a.value;
+        if (comment && comment !== null && comment !== '') {
+            this._comment = indent(`/// ${comment}\n`, 2);
+        }
+        return this;
+    }
+    setDecorators() {
+        var _a, _b, _c, _d, _e, _f, _g, _h;
+        const nodeName = this._node.name.value;
+        const fieldName = this._field.name.value;
+        // determine if should mark as deprecated
+        const isDeprecated = (_d = (_c = (_b = (_a = this._config.typeSpecificFreezedConfig) === null || _a === void 0 ? void 0 : _a[nodeName]) === null || _b === void 0 ? void 0 : _b.fields) === null || _c === void 0 ? void 0 : _c[fieldName]) === null || _d === void 0 ? void 0 : _d.deprecated;
+        const defaultValue = (_h = (_g = (_f = (_e = this._config.typeSpecificFreezedConfig) === null || _e === void 0 ? void 0 : _e[nodeName]) === null || _f === void 0 ? void 0 : _f.fields) === null || _g === void 0 ? void 0 : _g[fieldName]) === null || _h === void 0 ? void 0 : _h.defaultValue;
+        if (this._freezedConfigValue.get('alwaysUseJsonKeyName') || fieldName !== camelCase(fieldName)) {
+            this._decorators = [...this._decorators, `@JsonKey(name: '${fieldName}')`];
+        }
+        this._decorators = [
+            ...this._decorators,
+            ...transformCustomDecorators(getCustomDecorators(this._config, this._appliesOn, this._node.name.value, fieldName), this._node, this._field),
+        ];
+        // @deprecated
+        // if this._decorators doesn't include an @deprecated decorator but the field is marked as @deprecated...
+        if (!this._decorators.includes('@deprecated') && isDeprecated) {
+            this._decorators = [...this._decorators, '@deprecated'];
+        }
+        // @Default
+        if (defaultValue) {
+            //overwrite the customDecorator's defaultValue
+            this._decorators = this._decorators.filter(d => !d.startsWith('@Default'));
+            this._decorators = [...this._decorators, `@Default(value: ${defaultValue})`];
+        }
+        return this;
+    }
+    setRequired() {
+        this._required = this.isNonNullType(this._field.type);
+        return this;
+    }
+    setType() {
+        this._type = this.propertyType(this._field, this._field.type);
+        return this;
+    }
+    setName() {
+        this._name = camelCase(this._field.name.value);
+        return this;
+    }
+    /** compose the freezed constructor property */
+    setShape() {
+        var _a, _b, _c, _d;
+        let shape = '';
+        const nodeName = this._node.name.value;
+        const fieldName = this._field.name.value;
+        // determine if should mark as final
+        const isFinal = this._decorators.includes('final') ||
+            ((_d = (_c = (_b = (_a = this._config.typeSpecificFreezedConfig) === null || _a === void 0 ? void 0 : _a[nodeName]) === null || _b === void 0 ? void 0 : _b.fields) === null || _c === void 0 ? void 0 : _c[fieldName]) === null || _d === void 0 ? void 0 : _d.final);
+        //append comment
+        shape += this._comment;
+        // append the decorators
+        shape += this._decorators
+            .filter(d => d !== 'final')
+            .map(d => indent(`${d}\n`, 2))
+            .join('');
+        // append required for non-nullable types
+        shape += indent(this._required ? 'required ' : '', 2);
+        // append isFinal
+        shape += isFinal ? 'final ' : '';
+        // append the Dart Type, name and trailing comma
+        shape += `${this._type} ${this._name},\n`;
+        // store it in the shape
+        this._shape = shape;
+        return this;
+    }
+    /** composes the full block */
+    setBlock() {
+        this._block = this._shape;
+        return this;
+    }
+    scalar(_scalar) {
+        var _a, _b;
+        if ((_b = (_a = this._config) === null || _a === void 0 ? void 0 : _a.customScalars) === null || _b === void 0 ? void 0 : _b[_scalar]) {
+            return this._config.customScalars[_scalar];
+        }
+        if (DART_SCALARS[_scalar]) {
+            return DART_SCALARS[_scalar];
+        }
+        return _scalar;
+    }
+    /** returns the block */
+    toString() {
+        if (!this._block) {
+            throw new Error('FreezedParameterBlock: setShape must be called before calling toString()');
+        }
+        return this._block;
+    }
+}

package/esm/index.js

@@ -0,0 +1,23 @@
+import { oldVisit } from '@graphql-codegen/plugin-helpers';
+import { transformSchemaAST } from '@graphql-codegen/schema-ast';
+import { FreezedDeclarationBlock } from './freezed-declaration-blocks/index.js';
+import { schemaVisitor } from './schema-visitor.js';
+import { addFreezedImportStatements, DefaultFreezedPluginConfig } from './utils.js';
+export const plugin = (schema, _documents, config) => {
+    // sets the defaults for the config
+    config = { ...new DefaultFreezedPluginConfig(config) };
+    const { schema: _schema, ast } = transformSchemaAST(schema, config);
+    const { freezedFactoryBlockRepository, ...visitor } = schemaVisitor(_schema, config);
+    const visitorResult = oldVisit(ast, { leave: visitor });
+    const generated = visitorResult.definitions.filter((def) => def instanceof FreezedDeclarationBlock);
+    return (addFreezedImportStatements(config.fileName) +
+        generated
+            .map(freezedDeclarationBlock => freezedDeclarationBlock.toString().replace(/==>factory==>.+/gm, s => {
+            const pattern = s.replace('==>factory==>', '').trim();
+            const [key, appliesOn, name, typeName] = pattern.split('==>');
+            return freezedFactoryBlockRepository.retrieve(key, appliesOn, name, typeName !== null && typeName !== void 0 ? typeName : null).toString();
+        }))
+            .join('')
+            .trim() +
+        '\n');
+};

package/esm/schema-visitor.js

@@ -0,0 +1,11 @@
+import { FreezedFactoryBlockRepository, transformDefinition } from './utils.js';
+export const schemaVisitor = (_schema, config) => {
+    const freezedFactoryBlockRepository = new FreezedFactoryBlockRepository();
+    return {
+        freezedFactoryBlockRepository,
+        EnumTypeDefinition: (node) => transformDefinition(config, freezedFactoryBlockRepository, node),
+        UnionTypeDefinition: (node) => transformDefinition(config, freezedFactoryBlockRepository, node),
+        ObjectTypeDefinition: (node) => transformDefinition(config, freezedFactoryBlockRepository, node),
+        InputObjectTypeDefinition: (node) => transformDefinition(config, freezedFactoryBlockRepository, node),
+    };
+};

package/esm/utils.js

@@ -0,0 +1,209 @@
+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();
+}
+/**
+ * returns the value of the FreezedConfig option
+ * for a specific type if given typeName
+ * or else fallback to the global FreezedConfig value
+ */
+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(', ')})`];
+            }
+            else {
+                // else return the customDecorator key just as it is
+                result = [...result, key];
+            }
+        }
+    });
+    return result;
+}
+/**
+ * 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
+ */
+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(', ')})`;
+        }
+    }
+    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})`;
+        }
+    }
+    // returns either "@deprecated" || "final".
+    // `final` to be filtered from the decorators array when applying the decorators
+    return value.mapsToFreezedAs;
+}
+/** 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}.dart;\n`,
+        `part '${fileName}.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 = {};
+    }
+    register(key, value) {
+        this._store[key] = value;
+        return value;
+    }
+    retrieve(key, appliesOn, name, typeName) {
+        return this._store[key]
+            .setDecorators(appliesOn, key)
+            .setKey(key)
+            .setName(name)
+            .setNamedConstructor(typeName)
+            .init();
+    }
+}
+/** initializes a FreezedPluginConfig with the defaults values */
+export class DefaultFreezedPluginConfig {
+    constructor(config = {}) {
+        var _a, _b, _c, _d, _e, _f;
+        Object.assign(this, {
+            customScalars: (_a = config.customScalars) !== null && _a !== void 0 ? _a : {},
+            fileName: (_b = config.fileName) !== null && _b !== void 0 ? _b : 'app_models',
+            globalFreezedConfig: { ...new DefaultFreezedConfig(), ...((_c = config.globalFreezedConfig) !== null && _c !== void 0 ? _c : {}) },
+            typeSpecificFreezedConfig: (_d = config.typeSpecificFreezedConfig) !== null && _d !== void 0 ? _d : {},
+            ignoreTypes: (_e = config.ignoreTypes) !== null && _e !== void 0 ? _e : [],
+            lowercaseEnums: (_f = config.lowercaseEnums) !== null && _f !== void 0 ? _f : true,
+        });
+    }
+}
+/** 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,
+        });
+    }
+}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@graphql-codegen/flutter-freezed",
+  "version": "2.11.1",
+  "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.6.0",
+    "@graphql-codegen/schema-ast": "^2.5.0",
+    "@graphql-codegen/visitor-plugin-common": "2.12.0",
+    "auto-bind": "~4.0.0",
+    "tslib": "~2.4.0",
+    "change-case-all": "1.0.14"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dotansimha/graphql-code-generator.git",
+    "directory": "packages/plugins/typescript/typescript"
+  },
+  "license": "MIT",
+  "main": "cjs/index.js",
+  "module": "esm/index.js",
+  "typings": "typings/index.d.ts",
+  "typescript": {
+    "definition": "typings/index.d.ts"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "require": {
+        "types": "./typings/index.d.cts",
+        "default": "./cjs/index.js"
+      },
+      "import": {
+        "types": "./typings/index.d.ts",
+        "default": "./esm/index.js"
+      },
+      "default": {
+        "types": "./typings/index.d.ts",
+        "default": "./esm/index.js"
+      }
+    },
+    "./package.json": "./package.json"
+  }
+}