ponder-enrich-gql-docs-middleware/lib/src/base-definitions.d.ts

A middleware for Ponder that allows devs to enrich their GraphQL docs with docstrings

import type { DocMap } from "./types";
export declare const baseDefinitions: {
    scalars: {
        JSON: string;
        BigInt: string;
        Boolean: string;
        String: string;
        Int: string;
    };
    pagination: {
        PageInfo: string;
        "PageInfo.hasNextPage": string;
        "PageInfo.hasPreviousPage": string;
        "PageInfo.startCursor": string;
        "PageInfo.endCursor": string;
        totalCount: string;
        items: string;
    };
    queryArgs: {
        where: string;
        orderBy: string;
        orderDirection: string;
        before: string;
        after: string;
        limit: string;
    };
    filterOperators: {
        AND: string;
        OR: string;
        equals: string;
        not: string;
        in: string;
        not_in: string;
        gt: string;
        gte: string;
        lt: string;
        lte: string;
        contains: string;
        not_contains: string;
        starts_with: string;
        ends_with: string;
        not_starts_with: string;
        not_ends_with: string;
    };
};
export declare function generateFilterDocs(fieldName: string, baseDesc?: string): DocMap;
export declare function generatePageDocs(typeName: string, description?: string): DocMap;
/**
 * Generate documentation for a query field based on its type name
 */
export declare function generateQueryDocs(typeName: string, description?: string): DocMap;
export declare function generateTypeDocSet(typeName: string, description: string, fields?: Record<string, string>): DocMap;
export declare function extendWithBaseDefinitions(userDocs: Record<string, string>): DocMap;