@graphql-inspector/cli 3.4.13-alpha-20230417141810-fd2d33e7 → 3.4.13

package/cjs/core/src/diff/changes/field.js

@@ -1,166 +1,357 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fieldArgumentRemoved = exports.fieldArgumentAdded = exports.fieldTypeChanged = exports.fieldDeprecationReasonRemoved = exports.fieldDeprecationReasonAdded = exports.fieldDeprecationReasonChanged = exports.fieldDeprecationRemoved = exports.fieldDeprecationAdded = exports.fieldDescriptionRemoved = exports.fieldDescriptionAdded = exports.fieldDescriptionChanged = exports.fieldAdded = exports.fieldRemoved = void 0;
+exports.fieldArgumentRemoved = exports.fieldArgumentRemovedFromMeta = exports.fieldArgumentAdded = exports.fieldArgumentAddedFromMeta = exports.fieldTypeChanged = exports.fieldTypeChangedFromMeta = exports.fieldDeprecationReasonRemoved = exports.fieldDeprecationReasonRemovedFromMeta = exports.fieldDeprecationReasonAdded = exports.fieldDeprecationReasonAddedFromMeta = exports.fieldDeprecationReasonChanged = exports.fieldDeprecationReasonChangedFromMeta = exports.fieldDeprecationRemoved = exports.fieldDeprecationRemovedFromMeta = exports.fieldDeprecationAdded = exports.fieldDeprecationAddedFromMeta = exports.fieldDescriptionRemoved = exports.fieldDescriptionRemovedFromMeta = exports.fieldDescriptionAdded = exports.fieldDescriptionAddedFromMeta = exports.fieldDescriptionChanged = exports.fieldDescriptionChangedFromMeta = exports.fieldAdded = exports.fieldAddedFromMeta = exports.fieldRemoved = exports.fieldRemovedFromMeta = void 0;
 const graphql_1 = require("graphql");
 const graphql_js_1 = require("../../utils/graphql.js");
-const is_deprecated_js_1 = require("../../utils/is-deprecated.js");
 const change_js_1 = require("./change.js");
-function fieldRemoved(type, field) {
-    const entity = (0, graphql_1.isInterfaceType)(type) ? 'interface' : 'object type';
+function buildFieldRemovedMessage(args) {
+    return `Field '${args.removedFieldName}' ${args.isRemovedFieldDeprecated ? '(deprecated) ' : ''}was removed from ${args.typeType} '${args.typeName}'`;
+}
+function fieldRemovedFromMeta(args) {
     return {
+        type: change_js_1.ChangeType.FieldRemoved,
         criticality: {
             level: change_js_1.CriticalityLevel.Breaking,
-            reason: field.deprecationReason
+            reason: args.meta.isRemovedFieldDeprecated
                 ? `Removing a deprecated field is a breaking change. Before removing it, you may want to look at the field's usage to see the impact of removing the field.`
                 : `Removing a field is a breaking change. It is preferable to deprecate the field before removing it.`,
         },
-        type: change_js_1.ChangeType.FieldRemoved,
-        message: `Field '${field.name}' ${(0, is_deprecated_js_1.isDeprecated)(field) ? '(deprecated) ' : ''}was removed from ${entity} '${type.name}'`,
-        path: [type.name, field.name].join('.'),
+        message: buildFieldRemovedMessage(args.meta),
+        meta: args.meta,
+        path: [args.meta.typeName, args.meta.removedFieldName].join('.'),
     };
 }
-exports.fieldRemoved = fieldRemoved;
-function fieldAdded(type, field) {
+exports.fieldRemovedFromMeta = fieldRemovedFromMeta;
+function fieldRemoved(type, field) {
     const entity = (0, graphql_1.isInterfaceType)(type) ? 'interface' : 'object type';
+    return fieldRemovedFromMeta({
+        type: change_js_1.ChangeType.FieldRemoved,
+        meta: {
+            typeName: type.name,
+            removedFieldName: field.name,
+            isRemovedFieldDeprecated: field.deprecationReason != null,
+            typeType: entity,
+        },
+    });
+}
+exports.fieldRemoved = fieldRemoved;
+function buildFieldAddedMessage(args) {
+    return `Field '${args.addedFieldName}' was added to ${args.typeType} '${args.typeName}'`;
+}
+function fieldAddedFromMeta(args) {
     return {
+        type: change_js_1.ChangeType.FieldAdded,
         criticality: {
             level: change_js_1.CriticalityLevel.NonBreaking,
         },
-        type: change_js_1.ChangeType.FieldAdded,
-        message: `Field '${field.name}' was added to ${entity} '${type.name}'`,
-        path: [type.name, field.name].join('.'),
+        message: buildFieldAddedMessage(args.meta),
+        meta: args.meta,
+        path: [args.meta.typeName, args.meta.addedFieldName].join('.'),
     };
 }
+exports.fieldAddedFromMeta = fieldAddedFromMeta;
+function fieldAdded(type, field) {
+    const entity = (0, graphql_1.isInterfaceType)(type) ? 'interface' : 'object type';
+    return fieldAddedFromMeta({
+        type: change_js_1.ChangeType.FieldAdded,
+        meta: {
+            typeName: type.name,
+            addedFieldName: field.name,
+            typeType: entity,
+        },
+    });
+}
 exports.fieldAdded = fieldAdded;
-function fieldDescriptionChanged(type, oldField, newField) {
+function buildFieldDescriptionChangedMessage(args) {
+    return `Field '${args.typeName}.${args.fieldName}' description changed from '${args.oldDescription}' to '${args.newDescription}'`;
+}
+function fieldDescriptionChangedFromMeta(args) {
     return {
+        type: change_js_1.ChangeType.FieldDescriptionChanged,
         criticality: {
             level: change_js_1.CriticalityLevel.NonBreaking,
         },
-        type: change_js_1.ChangeType.FieldDescriptionChanged,
-        message: `Field '${type.name}.${oldField.name}' description changed from '${oldField.description}' to '${newField.description}'`,
-        path: [type.name, oldField.name].join('.'),
+        message: buildFieldDescriptionChangedMessage(args.meta),
+        meta: args.meta,
+        path: [args.meta.typeName, args.meta.fieldName].join('.'),
     };
 }
+exports.fieldDescriptionChangedFromMeta = fieldDescriptionChangedFromMeta;
+function fieldDescriptionChanged(type, oldField, newField) {
+    var _a, _b;
+    return fieldDescriptionChangedFromMeta({
+        type: change_js_1.ChangeType.FieldDescriptionChanged,
+        meta: {
+            fieldName: oldField.name,
+            typeName: type.name,
+            oldDescription: (_a = oldField.description) !== null && _a !== void 0 ? _a : '',
+            newDescription: (_b = newField.description) !== null && _b !== void 0 ? _b : '',
+        },
+    });
+}
 exports.fieldDescriptionChanged = fieldDescriptionChanged;
-function fieldDescriptionAdded(type, field) {
+function buildFieldDescriptionAddedMessage(args) {
+    return `Field '${args.typeName}.${args.fieldName}' has description '${args.addedDescription}'`;
+}
+function fieldDescriptionAddedFromMeta(args) {
     return {
+        type: change_js_1.ChangeType.FieldDescriptionAdded,
         criticality: {
             level: change_js_1.CriticalityLevel.NonBreaking,
         },
-        type: change_js_1.ChangeType.FieldDescriptionAdded,
-        message: `Field '${type.name}.${field.name}' has description '${field.description}'`,
-        path: [type.name, field.name].join('.'),
+        message: buildFieldDescriptionAddedMessage(args.meta),
+        meta: args.meta,
+        path: [args.meta.typeName, args.meta.fieldName].join('.'),
     };
 }
+exports.fieldDescriptionAddedFromMeta = fieldDescriptionAddedFromMeta;
+function fieldDescriptionAdded(type, field) {
+    var _a;
+    return fieldDescriptionAddedFromMeta({
+        type: change_js_1.ChangeType.FieldDescriptionAdded,
+        meta: {
+            typeName: type.name,
+            fieldName: field.name,
+            addedDescription: (_a = field.description) !== null && _a !== void 0 ? _a : '',
+        },
+    });
+}
 exports.fieldDescriptionAdded = fieldDescriptionAdded;
-function fieldDescriptionRemoved(type, field) {
+function buildFieldDescriptionRemovedMessage(args) {
+    return `Description was removed from field '${args.typeName}.${args.fieldName}'`;
+}
+function fieldDescriptionRemovedFromMeta(args) {
     return {
+        type: change_js_1.ChangeType.FieldDescriptionRemoved,
         criticality: {
             level: change_js_1.CriticalityLevel.NonBreaking,
         },
-        type: change_js_1.ChangeType.FieldDescriptionRemoved,
-        message: `Description was removed from field '${type.name}.${field.name}'`,
-        path: [type.name, field.name].join('.'),
+        message: buildFieldDescriptionRemovedMessage(args.meta),
+        meta: args.meta,
+        path: [args.meta.typeName, args.meta.fieldName].join('.'),
     };
 }
+exports.fieldDescriptionRemovedFromMeta = fieldDescriptionRemovedFromMeta;
+function fieldDescriptionRemoved(type, field) {
+    return fieldDescriptionRemovedFromMeta({
+        type: change_js_1.ChangeType.FieldDescriptionRemoved,
+        meta: {
+            typeName: type.name,
+            fieldName: field.name,
+        },
+    });
+}
 exports.fieldDescriptionRemoved = fieldDescriptionRemoved;
-function fieldDeprecationAdded(type, field) {
+function buildFieldDeprecatedAddedMessage(args) {
+    return `Field '${args.typeName}.${args.fieldName}' is deprecated`;
+}
+function fieldDeprecationAddedFromMeta(args) {
     return {
+        type: change_js_1.ChangeType.FieldDeprecationAdded,
         criticality: {
             level: change_js_1.CriticalityLevel.NonBreaking,
         },
-        type: change_js_1.ChangeType.FieldDeprecationAdded,
-        message: `Field '${type.name}.${field.name}' is deprecated`,
-        path: [type.name, field.name].join('.'),
+        message: buildFieldDeprecatedAddedMessage(args.meta),
+        meta: args.meta,
+        path: [args.meta.typeName, args.meta.fieldName].join('.'),
     };
 }
+exports.fieldDeprecationAddedFromMeta = fieldDeprecationAddedFromMeta;
+function fieldDeprecationAdded(type, field) {
+    return fieldDeprecationAddedFromMeta({
+        type: change_js_1.ChangeType.FieldDeprecationAdded,
+        meta: {
+            typeName: type.name,
+            fieldName: field.name,
+        },
+    });
+}
 exports.fieldDeprecationAdded = fieldDeprecationAdded;
-function fieldDeprecationRemoved(type, field) {
+function fieldDeprecationRemovedFromMeta(args) {
     return {
+        type: change_js_1.ChangeType.FieldDeprecationRemoved,
         criticality: {
             level: change_js_1.CriticalityLevel.Dangerous,
         },
-        type: change_js_1.ChangeType.FieldDeprecationRemoved,
-        message: `Field '${type.name}.${field.name}' is no longer deprecated`,
-        path: [type.name, field.name].join('.'),
+        message: `Field '${args.meta.typeName}.${args.meta.fieldName}' is no longer deprecated`,
+        meta: args.meta,
+        path: [args.meta.typeName, args.meta.fieldName].join('.'),
     };
 }
+exports.fieldDeprecationRemovedFromMeta = fieldDeprecationRemovedFromMeta;
+function fieldDeprecationRemoved(type, field) {
+    return fieldDeprecationRemovedFromMeta({
+        type: change_js_1.ChangeType.FieldDeprecationRemoved,
+        meta: {
+            fieldName: field.name,
+            typeName: type.name,
+        },
+    });
+}
 exports.fieldDeprecationRemoved = fieldDeprecationRemoved;
-function fieldDeprecationReasonChanged(type, oldField, newField) {
+function buildFieldDeprecationReasonChangedMessage(args) {
+    return `Deprecation reason on field '${args.typeName}.${args.fieldName}' has changed from '${args.oldDeprecationReason}' to '${args.newDeprecationReason}'`;
+}
+function fieldDeprecationReasonChangedFromMeta(args) {
     return {
+        type: change_js_1.ChangeType.FieldDeprecationReasonChanged,
         criticality: {
             level: change_js_1.CriticalityLevel.NonBreaking,
         },
-        type: change_js_1.ChangeType.FieldDeprecationReasonChanged,
-        message: `Deprecation reason on field '${type.name}.${newField.name}' has changed from '${oldField.deprecationReason}' to '${newField.deprecationReason}'`,
-        path: [type.name, oldField.name].join('.'),
+        message: buildFieldDeprecationReasonChangedMessage(args.meta),
+        meta: args.meta,
+        path: [args.meta.typeName, args.meta.fieldName].join('.'),
     };
 }
+exports.fieldDeprecationReasonChangedFromMeta = fieldDeprecationReasonChangedFromMeta;
+function fieldDeprecationReasonChanged(type, oldField, newField) {
+    var _a, _b;
+    return fieldDeprecationReasonChangedFromMeta({
+        type: change_js_1.ChangeType.FieldDeprecationReasonChanged,
+        meta: {
+            fieldName: newField.name,
+            typeName: type.name,
+            newDeprecationReason: (_a = newField.deprecationReason) !== null && _a !== void 0 ? _a : '',
+            oldDeprecationReason: (_b = oldField.deprecationReason) !== null && _b !== void 0 ? _b : '',
+        },
+    });
+}
 exports.fieldDeprecationReasonChanged = fieldDeprecationReasonChanged;
-function fieldDeprecationReasonAdded(type, field) {
+function buildFieldDeprecationReasonAddedMessage(args) {
+    return `Field '${args.typeName}.${args.fieldName}' has deprecation reason '${args.addedDeprecationReason}'`;
+}
+function fieldDeprecationReasonAddedFromMeta(args) {
     return {
+        type: change_js_1.ChangeType.FieldDeprecationReasonAdded,
         criticality: {
             level: change_js_1.CriticalityLevel.NonBreaking,
         },
-        type: change_js_1.ChangeType.FieldDeprecationReasonAdded,
-        message: `Field '${type.name}.${field.name}' has deprecation reason '${field.deprecationReason}'`,
-        path: [type.name, field.name].join('.'),
+        message: buildFieldDeprecationReasonAddedMessage(args.meta),
+        meta: args.meta,
+        path: [args.meta.typeName, args.meta.fieldName].join('.'),
     };
 }
+exports.fieldDeprecationReasonAddedFromMeta = fieldDeprecationReasonAddedFromMeta;
+function fieldDeprecationReasonAdded(type, field) {
+    var _a;
+    return fieldDeprecationReasonAddedFromMeta({
+        type: change_js_1.ChangeType.FieldDeprecationReasonAdded,
+        meta: {
+            typeName: type.name,
+            fieldName: field.name,
+            addedDeprecationReason: (_a = field.deprecationReason) !== null && _a !== void 0 ? _a : '',
+        },
+    });
+}
 exports.fieldDeprecationReasonAdded = fieldDeprecationReasonAdded;
-function fieldDeprecationReasonRemoved(type, field) {
+function fieldDeprecationReasonRemovedFromMeta(args) {
     return {
+        type: change_js_1.ChangeType.FieldDeprecationReasonRemoved,
         criticality: {
             level: change_js_1.CriticalityLevel.NonBreaking,
         },
-        type: change_js_1.ChangeType.FieldDeprecationReasonRemoved,
-        message: `Deprecation reason was removed from field '${type.name}.${field.name}'`,
-        path: [type.name, field.name].join('.'),
+        message: `Deprecation reason was removed from field '${args.meta.typeName}.${args.meta.fieldName}'`,
+        meta: args.meta,
+        path: [args.meta.typeName, args.meta.fieldName].join('.'),
     };
 }
+exports.fieldDeprecationReasonRemovedFromMeta = fieldDeprecationReasonRemovedFromMeta;
+function fieldDeprecationReasonRemoved(type, field) {
+    return fieldDeprecationReasonRemovedFromMeta({
+        type: change_js_1.ChangeType.FieldDeprecationReasonRemoved,
+        meta: {
+            typeName: type.name,
+            fieldName: field.name,
+        },
+    });
+}
 exports.fieldDeprecationReasonRemoved = fieldDeprecationReasonRemoved;
-function fieldTypeChanged(type, oldField, newField) {
+function buildFieldTypeChangedMessage(args) {
+    return `Field '${args.meta.typeName}.${args.meta.fieldName}' changed type from '${args.meta.oldFieldType}' to '${args.meta.newFieldType}'`;
+}
+function fieldTypeChangedFromMeta(args) {
     return {
+        type: change_js_1.ChangeType.FieldTypeChanged,
         criticality: {
-            level: (0, graphql_js_1.safeChangeForField)(oldField.type, newField.type)
+            level: args.meta.isSafeFieldTypeChange
                 ? change_js_1.CriticalityLevel.NonBreaking
                 : change_js_1.CriticalityLevel.Breaking,
         },
-        type: change_js_1.ChangeType.FieldTypeChanged,
-        message: `Field '${type}.${oldField.name}' changed type from '${oldField.type}' to '${newField.type}'`,
-        path: [type.name, oldField.name].join('.'),
+        message: buildFieldTypeChangedMessage(args),
+        meta: args.meta,
+        path: [args.meta.typeName, args.meta.fieldName].join('.'),
     };
 }
+exports.fieldTypeChangedFromMeta = fieldTypeChangedFromMeta;
+function fieldTypeChanged(type, oldField, newField) {
+    return fieldTypeChangedFromMeta({
+        type: change_js_1.ChangeType.FieldTypeChanged,
+        meta: {
+            typeName: type.name,
+            fieldName: oldField.name,
+            oldFieldType: oldField.type.toString(),
+            newFieldType: newField.type.toString(),
+            isSafeFieldTypeChange: (0, graphql_js_1.safeChangeForField)(oldField.type, newField.type),
+        },
+    });
+}
 exports.fieldTypeChanged = fieldTypeChanged;
-function fieldArgumentAdded(type, field, arg) {
-    const isBreaking = (0, graphql_1.isNonNullType)(arg.type) && typeof arg.defaultValue === 'undefined';
-    const defaultValueMsg = typeof arg.defaultValue === 'undefined' ? ' ' : ' (with default value) ';
+function buildFieldArgumentAddedMessage(args) {
+    return `Argument '${args.addedArgumentName}: ${args.addedArgumentType}'${args.hasDefaultValue ? ' (with default value) ' : ' '}added to field '${args.typeName}.${args.fieldName}'`;
+}
+function fieldArgumentAddedFromMeta(args) {
     return {
-        criticality: isBreaking
-            ? {
-                level: change_js_1.CriticalityLevel.Breaking,
-                reason: `Adding a required argument to an existing field is a breaking change because it will cause existing uses of this field to error.`,
-            }
-            : {
-                level: change_js_1.CriticalityLevel.Dangerous,
-                reason: `Adding a new argument to an existing field may involve a change in resolve function logic that potentially may cause some side effects.`,
-            },
         type: change_js_1.ChangeType.FieldArgumentAdded,
-        message: `Argument '${arg.name}: ${arg.type}'${defaultValueMsg}added to field '${type.name}.${field.name}'`,
-        path: [type.name, field.name, arg.name].join('.'),
+        criticality: {
+            level: args.meta.isAddedFieldArgumentBreaking
+                ? change_js_1.CriticalityLevel.Breaking
+                : change_js_1.CriticalityLevel.Dangerous,
+        },
+        message: buildFieldArgumentAddedMessage(args.meta),
+        meta: args.meta,
+        path: [args.meta.typeName, args.meta.fieldName, args.meta.addedArgumentName].join('.'),
     };
 }
+exports.fieldArgumentAddedFromMeta = fieldArgumentAddedFromMeta;
+function fieldArgumentAdded(type, field, arg) {
+    const isBreaking = (0, graphql_1.isNonNullType)(arg.type) && typeof arg.defaultValue === 'undefined';
+    return fieldArgumentAddedFromMeta({
+        type: change_js_1.ChangeType.FieldArgumentAdded,
+        meta: {
+            typeName: type.name,
+            fieldName: field.name,
+            addedArgumentName: arg.name,
+            addedArgumentType: arg.type.toString(),
+            hasDefaultValue: arg.defaultValue != null,
+            isAddedFieldArgumentBreaking: isBreaking,
+        },
+    });
+}
 exports.fieldArgumentAdded = fieldArgumentAdded;
-function fieldArgumentRemoved(type, field, arg) {
+function buildFieldArgumentRemovedMessage(args) {
+    return `Argument '${args.meta.removedFieldArgumentName}: ${args.meta.removedFieldType}' was removed from field '${args.meta.typeName}.${args.meta.fieldName}'`;
+}
+function fieldArgumentRemovedFromMeta(args) {
     return {
+        type: change_js_1.ChangeType.FieldArgumentRemoved,
         criticality: {
             level: change_js_1.CriticalityLevel.Breaking,
-            reason: `Removing a field argument is a breaking change because it will cause existing queries that use this argument to error.`,
         },
-        type: change_js_1.ChangeType.FieldArgumentRemoved,
-        message: `Argument '${arg.name}: ${arg.type}' was removed from field '${type.name}.${field.name}'`,
-        path: [type.name, field.name, arg.name].join('.'),
+        message: buildFieldArgumentRemovedMessage(args),
+        meta: args.meta,
+        path: [args.meta.typeName, args.meta.fieldName, args.meta.removedFieldArgumentName].join('.'),
     };
 }
+exports.fieldArgumentRemovedFromMeta = fieldArgumentRemovedFromMeta;
+function fieldArgumentRemoved(type, field, arg) {
+    return fieldArgumentRemovedFromMeta({
+        type: change_js_1.ChangeType.FieldArgumentRemoved,
+        meta: {
+            typeName: type.name,
+            fieldName: field.name,
+            removedFieldArgumentName: arg.name,
+            removedFieldType: arg.type.toString(),
+        },
+    });
+}
 exports.fieldArgumentRemoved = fieldArgumentRemoved;