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

package/cjs/utils.js

@@ -1,228 +1,73 @@
 "use strict";
+//#region helpers
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DefaultFreezedConfig = exports.DefaultFreezedPluginConfig = exports.FreezedFactoryBlockRepository = exports.FreezedConfigValue = exports.addFreezedImportStatements = exports.transformCustomDecorators = exports.getCustomDecorators = exports.getFreezedConfigValue = exports.transformDefinition = void 0;
-const index_js_1 = require("./freezed-declaration-blocks/index.js");
-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 '';
+exports.stringIsNotEmpty = exports.atJsonKeyDecorator = exports.escapeDartKeyword = exports.isDartKeyword = exports.dartCasing = exports.appliesOnBlock = exports.nodeIsObjectType = exports.resetIndex = exports.arrayWrap = exports.strToList = void 0;
+const change_case_all_1 = require("change-case-all");
+const graphql_1 = require("graphql");
+const config_value_js_1 = require("./config/config-value.js");
+const plugin_config_js_1 = require("./config/plugin-config.js");
+const strToList = (str) => (str.length < 1 ? [] : str.split(/\s*,\s*/gim).filter(s => s.length > 0));
+exports.strToList = strToList;
+const arrayWrap = (value) => value === undefined ? [] : Array.isArray(value) ? value : [value];
+exports.arrayWrap = arrayWrap;
+const resetIndex = (regexp) => (regexp.lastIndex = 0);
+exports.resetIndex = resetIndex;
+const nodeIsObjectType = (node) => node.kind === graphql_1.Kind.OBJECT_TYPE_DEFINITION || node.kind === graphql_1.Kind.INPUT_OBJECT_TYPE_DEFINITION;
+exports.nodeIsObjectType = nodeIsObjectType;
+const appliesOnBlock = (configAppliesOn, blockAppliesOn) => configAppliesOn.some(a => blockAppliesOn.includes(a));
+exports.appliesOnBlock = appliesOnBlock;
+const dartCasing = (name, casing) => {
+    if (casing === 'camelCase') {
+        return (0, change_case_all_1.camelCase)(name);
     }
-    return new index_js_1.FreezedDeclarationBlock(config, freezedFactoryBlockRepository, node).init();
-}
-exports.transformDefinition = transformDefinition;
-/**
- * returns the value of the FreezedConfig option
- * for a specific type if given typeName
- * or else fallback to the global FreezedConfig value
- */
-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);
+    else if (casing === 'PascalCase') {
+        return (0, change_case_all_1.pascalCase)(name);
     }
-    return (_e = config === null || config === void 0 ? void 0 : config.globalFreezedConfig) === null || _e === void 0 ? void 0 : _e[option];
-}
-exports.getFreezedConfigValue = getFreezedConfigValue;
-/**
- * @description filters the customDirectives to return those that are applied on a list of blocks
- */
-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 };
-        }
+    else if (casing === 'snake_case') {
+        return (0, change_case_all_1.snakeCase)(name);
     }
-    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;
-}
-exports.getCustomDecorators = getCustomDecorators;
-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;
-}
-exports.transformCustomDecorators = transformCustomDecorators;
+    return name;
+};
+exports.dartCasing = dartCasing;
 /**
- * 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
+ * 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`
  */
-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 */
-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('');
-}
-exports.addFreezedImportStatements = addFreezedImportStatements;
-/** 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
- */
-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);
-    }
-}
-exports.FreezedConfigValue = FreezedConfigValue;
+const isDartKeyword = (identifier) => plugin_config_js_1.DART_KEYWORDS[identifier] !== undefined;
+exports.isDartKeyword = isDartKeyword;
 /**
- * stores an instance of  FreezedFactoryBlock using the node names as the key
- * and returns that instance when replacing tokens
- * */
-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 '';
-    }
-}
-exports.FreezedFactoryBlockRepository = FreezedFactoryBlockRepository;
-/** initializes a FreezedPluginConfig with the defaults values */
-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 : [],
-        });
-    }
-}
-exports.DefaultFreezedPluginConfig = DefaultFreezedPluginConfig;
-/** initializes a FreezedConfig with the defaults values */
-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,
-        });
+ * 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
+ */
+const escapeDartKeyword = (config, blockAppliesOn, identifier, typeName, fieldName) => {
+    if ((0, exports.isDartKeyword)(identifier)) {
+        const [prefix, suffix] = config_value_js_1.Config.escapeDartKeywords(config, blockAppliesOn, typeName, fieldName);
+        return `${prefix}${identifier}${suffix}`;
     }
-}
-exports.DefaultFreezedConfig = DefaultFreezedConfig;
+    return identifier;
+};
+exports.escapeDartKeyword = escapeDartKeyword;
+const atJsonKeyDecorator = ({ defaultValue, disallowNullValue, fromJson, ignore, includeIfNull, name, required, toJson, }) => {
+    const body = [
+        (0, exports.stringIsNotEmpty)(defaultValue) ? `defaultValue: ${defaultValue}` : undefined,
+        disallowNullValue ? `disallowNullValue: ${disallowNullValue}` : undefined,
+        (0, exports.stringIsNotEmpty)(fromJson) ? `fromJson: ${fromJson}` : undefined,
+        ignore ? `ignore: ${ignore}` : undefined,
+        includeIfNull ? `includeIfNull: ${includeIfNull}` : undefined,
+        (0, exports.stringIsNotEmpty)(name) ? `name: '${name}'` : undefined,
+        required ? `required: ${required}` : undefined,
+        (0, exports.stringIsNotEmpty)(toJson) ? `toJson: ${toJson}` : undefined,
+    ]
+        .filter(value => value !== undefined)
+        .join(',');
+    return (0, exports.stringIsNotEmpty)(body) ? `@JsonKey(${body})\n` : '';
+};
+exports.atJsonKeyDecorator = atJsonKeyDecorator;
+const stringIsNotEmpty = (str) => (str === null || str === void 0 ? void 0 : str.length) > 0;
+exports.stringIsNotEmpty = stringIsNotEmpty;
+//#endregion

package/esm/config/config-value.js

@@ -0,0 +1,128 @@
+import { appliesOnBlock } from '../utils.js';
+import { Pattern } from './pattern.js';
+import { DART_SCALARS, defaultFreezedPluginConfig, } from './plugin-config.js';
+export class Config {
+}
+Config.camelCasedEnums = (config) => {
+    const _camelCasedEnums = config.camelCasedEnums;
+    if (_camelCasedEnums === true) {
+        return 'camelCase';
+    }
+    else if (_camelCasedEnums === false) {
+        return undefined;
+    }
+    return _camelCasedEnums;
+};
+Config.copyWith = (config, typeName) => {
+    return Config.enableWithBooleanOrTypeFieldName(config.copyWith, typeName);
+};
+Config.customScalars = (config, graphqlScalar) => {
+    var _a, _b, _c;
+    return (_c = (_b = (_a = config.customScalars) === null || _a === void 0 ? void 0 : _a[graphqlScalar]) !== null && _b !== void 0 ? _b : DART_SCALARS[graphqlScalar]) !== null && _c !== void 0 ? _c : graphqlScalar;
+};
+Config.defaultValues = (config, blockAppliesOn, typeName, fieldName) => {
+    var _a, _b, _c, _d;
+    const decorator = (defaultValue) => (defaultValue ? `@Default(${defaultValue})\n` : '');
+    const defaultValue = (_d = (_c = (_b = (_a = config.defaultValues) === null || _a === void 0 ? void 0 : _a.filter(([pattern, , configAppliesOn]) => Pattern.findLastConfiguration(pattern, typeName, fieldName) && appliesOnBlock(configAppliesOn, blockAppliesOn))) === null || _b === void 0 ? void 0 : _b.slice(-1)) === null || _c === void 0 ? void 0 : _c[0]) === null || _d === void 0 ? void 0 : _d[1];
+    return decorator(defaultValue);
+};
+Config.deprecated = (config, blockAppliesOn, typeName, fieldName) => {
+    var _a, _b, _c;
+    const isDeprecated = ((_c = (_b = (_a = config.deprecated) === null || _a === void 0 ? void 0 : _a.filter(([pattern, configAppliesOn]) => Pattern.findLastConfiguration(pattern, typeName, fieldName) &&
+        appliesOnBlock(configAppliesOn, blockAppliesOn))) === null || _b === void 0 ? void 0 : _b.slice(-1)) === null || _c === void 0 ? void 0 : _c[0]) !== undefined;
+    return isDeprecated ? '@deprecated\n' : '';
+};
+Config.equal = (config, typeName) => {
+    return Config.enableWithBooleanOrTypeFieldName(config.equal, typeName);
+};
+Config.escapeDartKeywords = (config, blockAppliesOn, typeName, fieldName) => {
+    const escapeDartKeywords = config.escapeDartKeywords;
+    if (escapeDartKeywords === true) {
+        return ['', '_']; // use a suffix `_`
+    }
+    else if (typeName && Array.isArray(escapeDartKeywords) && escapeDartKeywords.length > 0) {
+        const [, prefix, suffix] = escapeDartKeywords
+            .filter(([pattern, , , configAppliesOn]) => Pattern.findLastConfiguration(pattern, typeName, fieldName) &&
+            appliesOnBlock(configAppliesOn, blockAppliesOn))
+            .slice(-1)[0];
+        return [prefix, suffix];
+    }
+    return ['', '']; // no suffix
+};
+Config.final = (config, blockAppliesOn, typeName, fieldName) => {
+    var _a, _b, _c;
+    return (((_c = (_b = (_a = config.final) === null || _a === void 0 ? void 0 : _a.filter(([pattern, configAppliesOn]) => Pattern.findLastConfiguration(pattern, typeName, fieldName) &&
+        appliesOnBlock(configAppliesOn, blockAppliesOn))) === null || _b === void 0 ? void 0 : _b.slice(-1)) === null || _c === void 0 ? void 0 : _c[0]) !== undefined);
+};
+/*  static fromJsonToJson = ( // TODO: @next-version
+  config: FlutterFreezedPluginConfig,
+  blockAppliesOn?: readonly AppliesOnParameters[],
+  typeName?: TypeName,
+  fieldName?: FieldName
+) => {
+  const fromJsonToJson = config.fromJsonToJson;
+
+  if (typeName && fieldName && Array.isArray(fromJsonToJson)) {
+    const [, classOrFunctionName, useClassConverter] = (fromJsonToJson ?? [])
+      ?.filter(
+        ([pattern, , , appliesOn]) =>
+          Pattern.findLastConfiguration(pattern, typeName, fieldName) && appliesOnBlock(appliesOn, blockAppliesOn)
+      )
+      ?.slice(-1)?.[0];
+    return [classOrFunctionName, useClassConverter] as [classOrFunctionName: string, useClassConverter?: boolean];
+  } else if (typeName && fromJsonToJson instanceof TypeNamePattern) {
+    return Pattern.findLastConfiguration(fromJsonToJson, typeName);
+  }
+
+  return fromJsonToJson as boolean;
+};
+*/
+Config.ignoreTypes = (config, typeName) => {
+    const ignoreTypes = config.ignoreTypes;
+    if (ignoreTypes) {
+        const isIgnored = Pattern.findLastConfiguration(ignoreTypes, typeName);
+        return isIgnored ? [typeName.value] : [];
+    }
+    return [];
+};
+Config.immutable = (config, typeName) => {
+    return Config.enableWithBooleanOrTypeFieldName(config.immutable, typeName);
+};
+Config.makeCollectionsUnmodifiable = (config, typeName) => {
+    return Config.enableWithBooleanOrTypeFieldName(config.makeCollectionsUnmodifiable, typeName);
+};
+Config.mergeTypes = (config, typeName) => {
+    var _a, _b;
+    return (_b = (_a = config.mergeTypes) === null || _a === void 0 ? void 0 : _a[typeName.value]) !== null && _b !== void 0 ? _b : [];
+};
+Config.mutableInputs = (config, typeName) => {
+    return Config.enableWithBooleanOrTypeFieldName(config.mutableInputs, typeName);
+};
+Config.privateEmptyConstructor = (config, typeName) => {
+    return Config.enableWithBooleanOrTypeFieldName(config.privateEmptyConstructor, typeName);
+};
+Config.unionClass = ( /* config: FlutterFreezedPluginConfig, index: number, unionTypeName: TypeName */) => {
+    // const unionClass = config['unionClass'];
+    return undefined;
+};
+Config.unionKey = ( /* config: FlutterFreezedPluginConfig, typeName: TypeName */) => {
+    return undefined;
+};
+Config.unionValueCase = ( /* config: FlutterFreezedPluginConfig, typeName: TypeName */) => {
+    return undefined;
+};
+Config.unionValueDecorator = () => {
+    return undefined;
+};
+Config.enableWithBooleanOrTypeFieldName = (value, typeName) => {
+    if (typeof value === 'boolean') {
+        return value;
+    }
+    else if (value !== undefined && typeName !== undefined) {
+        return Pattern.findLastConfiguration(value, typeName);
+    }
+    return undefined;
+};
+Config.create = (...config) => {
+    return Object.assign({}, defaultFreezedPluginConfig, ...config);
+};