ponder-enrich-gql-docs-middleware/lib/src/index.js

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

"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
    if (k2 === undefined) k2 = k;
    var desc = Object.getOwnPropertyDescriptor(m, k);
    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
      desc = { enumerable: true, get: function() { return m[k]; } };
    }
    Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
    if (k2 === undefined) k2 = k;
    o[k2] = m[k];
}));
var __exportStar = (this && this.__exportStar) || function(m, exports) {
    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
};
Object.defineProperty(exports, "__esModule", { value: true });
__exportStar(require("./types"), exports);
__exportStar(require("./introspection"), exports);
__exportStar(require("./middleware"), exports);
__exportStar(require("./base-definitions"), exports);
// Usage example:
/*
import {
  createDocumentationMiddleware,
  extendWithBaseDefinitions,
  generateFilterDocs,
  generatePageDocs
} from '@your-org/graphql-docs';
import { ponder } from 'ponder:registry';
import { graphql } from 'ponder';

// Define custom documentation and combine with base definitions
const docs = extendWithBaseDefinitions({
  // Define your types
  tokenPaid: "Represents a token that was paid by a user",
  "tokenPaid.address": "Ethereum address that paid the token",
  "tokenPaid.amount": "Number of tokens that were paid",

  // Automatically generate filter documentation
  ...generateFilterDocs('address', 'Filter by token address'),
  ...generateFilterDocs('amount', 'Filter by token amount'),

  // Automatically generate pagination documentation
  ...generatePageDocs('tokenPaid', 'token payment'),

  // Your other custom types...
  tokenBorrowed: "Represents a token that was borrowed",
  "tokenBorrowed.address": "Ethereum address that borrowed the token",
  "tokenBorrowed.amount": "Number of tokens that were borrowed",
  ...generateFilterDocs('address', 'Filter by borrower address'),
  ...generateFilterDocs('amount', 'Filter by borrowed amount'),
  ...generatePageDocs('tokenBorrowed', 'token borrow'),
});

// Common GraphQL scalars, pagination fields, and filter operators
// are automatically included via extendWithBaseDefinitions

const middleware = createDocumentationMiddleware(docs, {
  debug: true,
  path: '/graphql'
});

ponder.use('/graphql', middleware);
ponder.use('/graphql', graphql());
*/