@graphql-eslint/eslint-plugin
Version:
GraphQL plugin for ESLint
101 lines (100 loc) • 4.59 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.rule = void 0;
const graphql_1 = require("graphql");
const relay_connection_types_js_1 = require("./relay-connection-types.js");
const utils_js_1 = require("../utils.js");
const RULE_ID = 'relay-page-info';
const MESSAGE_MUST_EXIST = 'MESSAGE_MUST_EXIST';
const MESSAGE_MUST_BE_OBJECT_TYPE = 'MESSAGE_MUST_BE_OBJECT_TYPE';
const notPageInfoTypesSelector = `:matches(${relay_connection_types_js_1.NON_OBJECT_TYPES})[name.value=PageInfo] > .name`;
let hasPageInfoChecked = false;
exports.rule = {
meta: {
type: 'problem',
docs: {
category: 'Schema',
description: [
'Set of rules to follow Relay specification for `PageInfo` object.',
'',
'- `PageInfo` must be an Object type',
'- `PageInfo` must contain fields `hasPreviousPage` and `hasNextPage`, that return non-null Boolean',
'- `PageInfo` must contain fields `startCursor` and `endCursor`, that return either String or Scalar, which can be null if there are no results',
].join('\n'),
url: `https://github.com/B2o5T/graphql-eslint/blob/master/docs/rules/${RULE_ID}.md`,
examples: [
{
title: 'Correct',
code: /* GraphQL */ `
type PageInfo {
hasPreviousPage: Boolean!
hasNextPage: Boolean!
startCursor: String
endCursor: String
}
`,
},
],
isDisabledForAllConfig: true,
requiresSchema: true,
},
messages: {
[MESSAGE_MUST_EXIST]: 'The server must provide a `PageInfo` object.',
[MESSAGE_MUST_BE_OBJECT_TYPE]: '`PageInfo` must be an Object type.',
},
schema: [],
},
create(context) {
const schema = (0, utils_js_1.requireGraphQLSchemaFromContext)(RULE_ID, context);
if (process.env.NODE_ENV === 'test' || !hasPageInfoChecked) {
const pageInfoType = schema.getType('PageInfo');
if (!pageInfoType) {
context.report({
loc: utils_js_1.REPORT_ON_FIRST_CHARACTER,
messageId: MESSAGE_MUST_EXIST,
});
}
hasPageInfoChecked = true;
}
return {
[notPageInfoTypesSelector](node) {
context.report({ node, messageId: MESSAGE_MUST_BE_OBJECT_TYPE });
},
'ObjectTypeDefinition[name.value=PageInfo]'(node) {
const fieldMap = Object.fromEntries(node.fields.map(field => [field.name.value, field]));
const checkField = (fieldName, typeName) => {
const field = fieldMap[fieldName];
let isAllowedType = false;
if (field) {
const type = field.gqlType;
if (typeName === 'Boolean') {
isAllowedType =
type.kind === graphql_1.Kind.NON_NULL_TYPE &&
type.gqlType.kind === graphql_1.Kind.NAMED_TYPE &&
type.gqlType.name.value === 'Boolean';
}
else if (type.kind === graphql_1.Kind.NAMED_TYPE) {
isAllowedType =
type.name.value === 'String' || (0, graphql_1.isScalarType)(schema.getType(type.name.value));
}
}
if (!isAllowedType) {
const returnType = typeName === 'Boolean'
? 'non-null Boolean'
: 'either String or Scalar, which can be null if there are no results';
context.report({
node: field ? field.name : node.name,
message: field
? `Field \`${fieldName}\` must return ${returnType}.`
: `\`PageInfo\` must contain a field \`${fieldName}\`, that return ${returnType}.`,
});
}
};
checkField('hasPreviousPage', 'Boolean');
checkField('hasNextPage', 'Boolean');
checkField('startCursor', 'String');
checkField('endCursor', 'String');
},
};
},
};