{
  "generator": "x-ranger/site-docs/reference",
  "package": "x-gql",
  "entrypoints": [
    "src/index.ts"
  ],
  "sourceBase": "https://forgo.cloud/ide/forkjoin-ai/x-gql",
  "count": 18,
  "entries": [
    {
      "kind": "function",
      "name": "buildFederationProjectionLayer",
      "signature": "function buildFederationProjectionLayer(source: FederationProjectionSource): FederationProjectionLayer",
      "params": [
        {
          "name": "source",
          "type": "FederationProjectionSource",
          "optional": false
        }
      ],
      "returnType": "FederationProjectionLayer",
      "doc": "Builds the Federation Projection Layer.",
      "sourceFile": "src/federation-projection.ts",
      "line": 263,
      "exportedAs": "buildFederationProjectionLayer",
      "tags": [],
      "sourceUrl": "https://forgo.cloud/ide/forkjoin-ai/x-gql?file=src%2Ffederation-projection.ts&line=263"
    },
    {
      "kind": "function",
      "name": "buildRuntimeIoProjectionLayer",
      "signature": "function buildRuntimeIoProjectionLayer(source: RuntimeIoProjectionSource): RuntimeIoProjectionLayer",
      "params": [
        {
          "name": "source",
          "type": "RuntimeIoProjectionSource",
          "optional": false
        }
      ],
      "returnType": "RuntimeIoProjectionLayer",
      "doc": "Builds the Runtime Io Projection Layer.",
      "sourceFile": "src/runtime-io-projection.ts",
      "line": 997,
      "exportedAs": "buildRuntimeIoProjectionLayer",
      "tags": [],
      "sourceUrl": "https://forgo.cloud/ide/forkjoin-ai/x-gql?file=src%2Fruntime-io-projection.ts&line=997"
    },
    {
      "kind": "function",
      "name": "createApolloExpressMiddleware",
      "signature": "function createApolloExpressMiddleware(server: ApolloServer<TContext>, options: ApolloExpressMiddlewareOptions<TContext> = {}): Promise<RequestHandler>",
      "params": [
        {
          "name": "server",
          "type": "ApolloServer<TContext>",
          "optional": false
        },
        {
          "name": "options",
          "type": "ApolloExpressMiddlewareOptions<TContext>",
          "optional": true,
          "defaultValue": "{}"
        }
      ],
      "returnType": "Promise<RequestHandler>",
      "doc": "",
      "sourceFile": "src/server.ts",
      "line": 416,
      "exportedAs": "createApolloExpressMiddleware",
      "tags": [],
      "sourceUrl": "https://forgo.cloud/ide/forkjoin-ai/x-gql?file=src%2Fserver.ts&line=416"
    },
    {
      "kind": "function",
      "name": "createApolloFastifyPlugin",
      "signature": "function createApolloFastifyPlugin(server: ApolloServer<TContext>, options: ApolloFastifyPluginOptions<TContext> = {}): FastifyPluginAsync",
      "params": [
        {
          "name": "server",
          "type": "ApolloServer<TContext>",
          "optional": false
        },
        {
          "name": "options",
          "type": "ApolloFastifyPluginOptions<TContext>",
          "optional": true,
          "defaultValue": "{}"
        }
      ],
      "returnType": "FastifyPluginAsync",
      "doc": "",
      "sourceFile": "src/server.ts",
      "line": 462,
      "exportedAs": "createApolloFastifyPlugin",
      "tags": [],
      "sourceUrl": "https://forgo.cloud/ide/forkjoin-ai/x-gql?file=src%2Fserver.ts&line=462"
    },
    {
      "kind": "function",
      "name": "createApolloServer",
      "signature": "function createApolloServer(options: GqlServerOptions, apolloOptions: ApolloServerFactoryOptions<TContext> = {}): ApolloServer<TContext>",
      "params": [
        {
          "name": "options",
          "type": "GqlServerOptions",
          "optional": false
        },
        {
          "name": "apolloOptions",
          "type": "ApolloServerFactoryOptions<TContext>",
          "optional": true,
          "defaultValue": "{}"
        }
      ],
      "returnType": "ApolloServer<TContext>",
      "doc": "",
      "sourceFile": "src/server.ts",
      "line": 404,
      "exportedAs": "createApolloServer",
      "tags": [],
      "sourceUrl": "https://forgo.cloud/ide/forkjoin-ai/x-gql?file=src%2Fserver.ts&line=404"
    },
    {
      "kind": "function",
      "name": "createApolloServerAdapter",
      "signature": "function createApolloServerAdapter(options: GqlServerOptions): ApolloConfigAdapter",
      "params": [
        {
          "name": "options",
          "type": "GqlServerOptions",
          "optional": false
        }
      ],
      "returnType": "ApolloConfigAdapter",
      "doc": "Creates the Apollo Server Adapter.",
      "sourceFile": "src/server.ts",
      "line": 398,
      "exportedAs": "createApolloServerAdapter",
      "tags": [],
      "sourceUrl": "https://forgo.cloud/ide/forkjoin-ai/x-gql?file=src%2Fserver.ts&line=398"
    },
    {
      "kind": "function",
      "name": "createGqlServer",
      "signature": "function createGqlServer(options: GqlServerOptions): GqlServer",
      "params": [
        {
          "name": "options",
          "type": "GqlServerOptions",
          "optional": false,
          "doc": "Topology sources, resolvers, endpoint, and export titles"
        }
      ],
      "returnType": "GqlServer",
      "doc": "Create a GraphQL server projected from one or more Gnosis `.gg` topologies.\n\nBuilds a GraphQL schema (types/queries/mutations/subscriptions), optional\nApollo/Yoga adapters, and OpenAPI/Postman export helpers. GraphQL is a\nprojection layer — the topology remains the authority.\n\n\n```ts\nconst server = createGqlServer({\n  topologies: ['./app.gg'],\n  resolvers: { Query: { readUser: () => ({ id: '1' }) } },\n});\nconst result = await server.executeOperation({ query: '{ readUser { id } }' });\n```",
      "sourceFile": "src/server.ts",
      "line": 223,
      "exportedAs": "createGqlServer",
      "tags": [
        {
          "tag": "param",
          "text": "options - Topology sources, resolvers, endpoint, and export titles"
        },
        {
          "tag": "returns",
          "text": "A {@link GqlServer} with `executeOperation`, `fetch`, and export methods"
        },
        {
          "tag": "example",
          "text": ""
        }
      ],
      "sourceUrl": "https://forgo.cloud/ide/forkjoin-ai/x-gql?file=src%2Fserver.ts&line=223"
    },
    {
      "kind": "function",
      "name": "createYogaHttpServer",
      "signature": "function createYogaHttpServer(server: FetchCompatibleGraphQLServer): import('node:http').Server",
      "params": [
        {
          "name": "server",
          "type": "FetchCompatibleGraphQLServer",
          "optional": false
        }
      ],
      "returnType": "import('node:http').Server",
      "doc": "Creates the Yoga Http Server.",
      "sourceFile": "src/server.ts",
      "line": 568,
      "exportedAs": "createYogaHttpServer",
      "tags": [],
      "sourceUrl": "https://forgo.cloud/ide/forkjoin-ai/x-gql?file=src%2Fserver.ts&line=568"
    },
    {
      "kind": "function",
      "name": "createYogaNodeRequestListener",
      "signature": "function createYogaNodeRequestListener(server: FetchCompatibleGraphQLServer): (request: IncomingMessage, response: ServerResponse) => void",
      "params": [
        {
          "name": "server",
          "type": "FetchCompatibleGraphQLServer",
          "optional": false
        }
      ],
      "returnType": "(request: IncomingMessage, response: ServerResponse) => void",
      "doc": "Creates the Yoga Node Request Listener.",
      "sourceFile": "src/server.ts",
      "line": 545,
      "exportedAs": "createYogaNodeRequestListener",
      "tags": [],
      "sourceUrl": "https://forgo.cloud/ide/forkjoin-ai/x-gql?file=src%2Fserver.ts&line=545"
    },
    {
      "kind": "function",
      "name": "createYogaServerAdapter",
      "signature": "function createYogaServerAdapter(options: GqlServerOptions): YogaCompatibleServer",
      "params": [
        {
          "name": "options",
          "type": "GqlServerOptions",
          "optional": false
        }
      ],
      "returnType": "YogaCompatibleServer",
      "doc": "Creates the Yoga Server Adapter.",
      "sourceFile": "src/server.ts",
      "line": 513,
      "exportedAs": "createYogaServerAdapter",
      "tags": [],
      "sourceUrl": "https://forgo.cloud/ide/forkjoin-ai/x-gql?file=src%2Fserver.ts&line=513"
    },
    {
      "kind": "function",
      "name": "generateSchema",
      "signature": "function generateSchema(ast: GraphAST): GqlSchema",
      "params": [
        {
          "name": "ast",
          "type": "GraphAST",
          "optional": false,
          "doc": "Parsed graph AST (nodes + edges) from a `.gg` topology"
        }
      ],
      "returnType": "GqlSchema",
      "doc": "Generate a GraphQL schema model from a Betty/GGL graph AST.\n\nMaps topology nodes to object types, PROCESS edges to queries, FOLD to\nmutations, FORK to subscriptions, and RACE to unions.",
      "sourceFile": "src/gg-to-graphql.ts",
      "line": 201,
      "exportedAs": "generateSchema",
      "tags": [
        {
          "tag": "param",
          "text": "ast - Parsed graph AST (nodes + edges) from a `.gg` topology"
        },
        {
          "tag": "returns",
          "text": "Intermediate {@link GqlSchema} used by SDL / OpenAPI / Postman export"
        }
      ],
      "sourceUrl": "https://forgo.cloud/ide/forkjoin-ai/x-gql?file=src%2Fgg-to-graphql.ts&line=201"
    },
    {
      "kind": "function",
      "name": "initXGqlTracingFromEnv",
      "signature": "function initXGqlTracingFromEnv(env: TraceEnv | undefined = defaultTraceEnv(): void",
      "params": [
        {
          "name": "env",
          "type": "TraceEnv | undefined",
          "optional": true,
          "defaultValue": "defaultTraceEnv("
        }
      ],
      "returnType": "void",
      "doc": "Handles the x gql init XGql Tracing From Env workflow.",
      "sourceFile": "src/tracing.ts",
      "line": 144,
      "exportedAs": "initXGqlTracingFromEnv",
      "tags": [],
      "sourceUrl": "https://forgo.cloud/ide/forkjoin-ai/x-gql?file=src%2Ftracing.ts&line=144"
    },
    {
      "kind": "function",
      "name": "isXGqlTracingEnabled",
      "signature": "function isXGqlTracingEnabled(env: TraceEnv | undefined): boolean",
      "params": [
        {
          "name": "env",
          "type": "TraceEnv | undefined",
          "optional": false
        }
      ],
      "returnType": "boolean",
      "doc": "Returns whether is XGql Tracing Enabled is true.",
      "sourceFile": "src/tracing.ts",
      "line": 114,
      "exportedAs": "isXGqlTracingEnabled",
      "tags": [],
      "sourceUrl": "https://forgo.cloud/ide/forkjoin-ai/x-gql?file=src%2Ftracing.ts&line=114"
    },
    {
      "kind": "function",
      "name": "schemaToGraphQL",
      "signature": "function schemaToGraphQL(schema: GqlSchema): string",
      "params": [
        {
          "name": "schema",
          "type": "GqlSchema",
          "optional": false,
          "doc": "Intermediate schema from {@link generateSchema}"
        }
      ],
      "returnType": "string",
      "doc": "Serialize a {@link GqlSchema} to GraphQL SDL text.",
      "sourceFile": "src/gg-to-graphql.ts",
      "line": 256,
      "exportedAs": "schemaToGraphQL",
      "tags": [
        {
          "tag": "param",
          "text": "schema - Intermediate schema from {@link generateSchema}"
        },
        {
          "tag": "returns",
          "text": "GraphQL SDL string (types, Query, Mutation, Subscription, directives)"
        }
      ],
      "sourceUrl": "https://forgo.cloud/ide/forkjoin-ai/x-gql?file=src%2Fgg-to-graphql.ts&line=256"
    },
    {
      "kind": "function",
      "name": "schemaToOpenAPI",
      "signature": "function schemaToOpenAPI(schema: GqlSchema, title: string): object",
      "params": [
        {
          "name": "schema",
          "type": "GqlSchema",
          "optional": false,
          "doc": "Intermediate schema from {@link generateSchema}"
        },
        {
          "name": "title",
          "type": "string",
          "optional": false,
          "doc": "OpenAPI `info.title`"
        }
      ],
      "returnType": "object",
      "doc": "Project a {@link GqlSchema} into an OpenAPI 3.1 document.\n\nEach query becomes `GET /api/{name}`; each mutation becomes `POST /api/{name}`.",
      "sourceFile": "src/gg-to-graphql.ts",
      "line": 352,
      "exportedAs": "schemaToOpenAPI",
      "tags": [
        {
          "tag": "param",
          "text": "schema - Intermediate schema from {@link generateSchema}"
        },
        {
          "tag": "param",
          "text": "title - OpenAPI `info.title`"
        },
        {
          "tag": "returns",
          "text": "OpenAPI 3.1 document object"
        }
      ],
      "sourceUrl": "https://forgo.cloud/ide/forkjoin-ai/x-gql?file=src%2Fgg-to-graphql.ts&line=352"
    },
    {
      "kind": "function",
      "name": "schemaToPostman",
      "signature": "function schemaToPostman(schema: GqlSchema, name: string, baseUrl: string): object",
      "params": [
        {
          "name": "schema",
          "type": "GqlSchema",
          "optional": false,
          "doc": "Intermediate schema from {@link generateSchema}"
        },
        {
          "name": "name",
          "type": "string",
          "optional": false,
          "doc": "Collection name"
        },
        {
          "name": "baseUrl",
          "type": "string",
          "optional": false,
          "doc": "GraphQL HTTP endpoint base URL"
        }
      ],
      "returnType": "object",
      "doc": "Project a {@link GqlSchema} into a Postman Collection v2.1.",
      "sourceFile": "src/gg-to-graphql.ts",
      "line": 423,
      "exportedAs": "schemaToPostman",
      "tags": [
        {
          "tag": "param",
          "text": "schema - Intermediate schema from {@link generateSchema}"
        },
        {
          "tag": "param",
          "text": "name - Collection name"
        },
        {
          "tag": "param",
          "text": "baseUrl - GraphQL HTTP endpoint base URL"
        },
        {
          "tag": "returns",
          "text": "Postman collection object"
        }
      ],
      "sourceUrl": "https://forgo.cloud/ide/forkjoin-ai/x-gql?file=src%2Fgg-to-graphql.ts&line=423"
    },
    {
      "kind": "function",
      "name": "withXGqlSpan",
      "signature": "function withXGqlSpan(name: string, fn: (span: Span): void",
      "params": [
        {
          "name": "name",
          "type": "string",
          "optional": false
        },
        {
          "name": "fn",
          "type": "(span: Span",
          "optional": false
        }
      ],
      "returnType": "void",
      "doc": "",
      "sourceFile": "src/tracing.ts",
      "line": 166,
      "exportedAs": "withXGqlSpan",
      "tags": [],
      "sourceUrl": "https://forgo.cloud/ide/forkjoin-ai/x-gql?file=src%2Ftracing.ts&line=166"
    },
    {
      "kind": "variable",
      "name": "xGqlTracer",
      "signature": "const xGqlTracer: unknown",
      "params": [],
      "doc": "",
      "sourceFile": "src/tracing.ts",
      "line": 13,
      "exportedAs": "xGqlTracer",
      "tags": [],
      "sourceUrl": "https://forgo.cloud/ide/forkjoin-ai/x-gql?file=src%2Ftracing.ts&line=13"
    }
  ]
}