@graphql-codegen/typescript-apollo-client-helpers/esm/index.js

GraphQL Code Generator plugin for generating TypeScript helpers for Apollo Client > 3

import { extname } from 'path';
import { isInterfaceType, isObjectType } from 'graphql';
export const plugin = (schema, documents, config) => {
    const results = [];
    results.push(generateTypePoliciesSignature(schema, config));
    return {
        prepend: results.reduce((prev, r) => [...prev, ...(r.prepend || [])], []),
        append: results.reduce((prev, r) => [...prev, ...(r.append || [])], []),
        content: results.map(r => r.content).join('\n'),
    };
};
function generateTypePoliciesSignature(schema, config) {
    var _a, _b, _c;
    const typeMap = schema.getTypeMap();
    const perTypePolicies = [];
    const typedTypePolicies = Object.keys(typeMap).reduce((prev, typeName) => {
        const type = typeMap[typeName];
        if (!typeName.startsWith('__') && (isObjectType(type) || isInterfaceType(type))) {
            const fieldsNames = Object.keys(type.getFields()).filter(f => !f.startsWith('__'));
            const keySpecifierVarName = `${typeName}KeySpecifier`;
            const fieldPolicyVarName = `${typeName}FieldPolicy`;
            perTypePolicies.push(`export type ${keySpecifierVarName} = (${fieldsNames
                .map(f => `'${f}'`)
                .join(' | ')} | ${keySpecifierVarName})[];`);
            perTypePolicies.push(`export type ${fieldPolicyVarName} = {
${fieldsNames
                .map(fieldName => `\t${fieldName}?: FieldPolicy<any> | FieldReadFunction<any>`)
                .join(',\n')}
};`);
            return {
                ...prev,
                [typeName]: `Omit<TypePolicy, "fields" | "keyFields"> & {
\t\tkeyFields${config.requireKeyFields ? '' : '?'}: false | ${keySpecifierVarName} | (() => undefined | ${keySpecifierVarName}),
\t\tfields?: ${fieldPolicyVarName},
\t}`,
            };
        }
        return prev;
    }, {});
    const rootTypes = [
        (_a = schema.getQueryType()) === null || _a === void 0 ? void 0 : _a.name,
        (_b = schema.getMutationType()) === null || _b === void 0 ? void 0 : _b.name,
        (_c = schema.getSubscriptionType()) === null || _c === void 0 ? void 0 : _c.name,
    ].filter(Boolean);
    const rootContent = `export type StrictTypedTypePolicies = {${Object.keys(typedTypePolicies)
        .map(typeName => {
        const nonOptional = config.requirePoliciesForAllTypes && !rootTypes.includes(typeName);
        return `\n\t${typeName}${nonOptional ? '' : '?'}: ${typedTypePolicies[typeName]}`;
    })
        .join(',')}\n};\nexport type TypedTypePolicies = StrictTypedTypePolicies & TypePolicies;`;
    return {
        prepend: [
            `import ${config.useTypeImports ? 'type ' : ''}{ FieldPolicy, FieldReadFunction, TypePolicies, TypePolicy } from '@apollo/client/cache';`,
        ],
        content: [...perTypePolicies, rootContent].join('\n'),
    };
}
export const validate = async (schema, documents, config, outputFile) => {
    if (extname(outputFile) !== '.ts' && extname(outputFile) !== '.tsx') {
        throw new Error(`Plugin "apollo-client-helpers" requires extension to be ".ts" or ".tsx"!`);
    }
};