API reference

Exported symbols from TypeScript — names, parameters, return types, and documentation comments pulled from source JSDoc.

Exports from `src/index.ts`

function

`buildFederationProjectionLayer`

function buildFederationProjectionLayer(source: FederationProjectionSource): FederationProjectionLayer

Builds the Federation Projection Layer.

Name	Type	Docs
`source`	`FederationProjectionSource`

Returns FederationProjectionLayer

src/federation-projection.ts:263

function

`buildRuntimeIoProjectionLayer`

function buildRuntimeIoProjectionLayer(source: RuntimeIoProjectionSource): RuntimeIoProjectionLayer

Builds the Runtime Io Projection Layer.

Name	Type	Docs
`source`	`RuntimeIoProjectionSource`

Returns RuntimeIoProjectionLayer

src/runtime-io-projection.ts:997

function

`createApolloExpressMiddleware`

function createApolloExpressMiddleware(server: ApolloServer<TContext>, options: ApolloExpressMiddlewareOptions<TContext> = {}): Promise<RequestHandler>

No documentation comment.

Name	Type	Docs
`server`	`ApolloServer<TContext>`
`options?`	`ApolloExpressMiddlewareOptions<TContext>`

Returns Promise<RequestHandler>

src/server.ts:416

function

`createApolloFastifyPlugin`

function createApolloFastifyPlugin(server: ApolloServer<TContext>, options: ApolloFastifyPluginOptions<TContext> = {}): FastifyPluginAsync

No documentation comment.

Name	Type	Docs
`server`	`ApolloServer<TContext>`
`options?`	`ApolloFastifyPluginOptions<TContext>`

Returns FastifyPluginAsync

src/server.ts:462

function

`createApolloServer`

function createApolloServer(options: GqlServerOptions, apolloOptions: ApolloServerFactoryOptions<TContext> = {}): ApolloServer<TContext>

No documentation comment.

Name	Type	Docs
`options`	`GqlServerOptions`
`apolloOptions?`	`ApolloServerFactoryOptions<TContext>`

Returns ApolloServer<TContext>

src/server.ts:404

function

`createApolloServerAdapter`

function createApolloServerAdapter(options: GqlServerOptions): ApolloConfigAdapter

Creates the Apollo Server Adapter.

Name	Type	Docs
`options`	`GqlServerOptions`

Returns ApolloConfigAdapter

src/server.ts:398

function

`createGqlServer`

function createGqlServer(options: GqlServerOptions): GqlServer

Create a GraphQL server projected from one or more Gnosis `.gg` topologies.

Builds a GraphQL schema (types/queries/mutations/subscriptions), optional
Apollo/Yoga adapters, and OpenAPI/Postman export helpers. GraphQL is a
projection layer — the topology remains the authority.

```ts
const server = createGqlServer({
topologies: ['./app.gg'],
resolvers: { Query: { readUser: () => ({ id: '1' }) } },
});
const result = await server.executeOperation({ query: '{ readUser { id } }' });
```

Name	Type	Docs
`options`	`GqlServerOptions`	Topology sources, resolvers, endpoint, and export titles

Returns GqlServer

@param options - Topology sources, resolvers, endpoint, and export titles
@returns A {@link GqlServer} with `executeOperation`, `fetch`, and export methods
@example

src/server.ts:223

function

`createYogaHttpServer`

function createYogaHttpServer(server: FetchCompatibleGraphQLServer): import('node:http').Server

Creates the Yoga Http Server.

Name	Type	Docs
`server`	`FetchCompatibleGraphQLServer`

Returns import('node:http').Server

src/server.ts:568

function

`createYogaNodeRequestListener`

function createYogaNodeRequestListener(server: FetchCompatibleGraphQLServer): (request: IncomingMessage, response: ServerResponse) => void

Creates the Yoga Node Request Listener.

Name	Type	Docs
`server`	`FetchCompatibleGraphQLServer`

Returns (request: IncomingMessage, response: ServerResponse) => void

src/server.ts:545

function

`createYogaServerAdapter`

function createYogaServerAdapter(options: GqlServerOptions): YogaCompatibleServer

Creates the Yoga Server Adapter.

Name	Type	Docs
`options`	`GqlServerOptions`

Returns YogaCompatibleServer

src/server.ts:513

function

`generateSchema`

function generateSchema(ast: GraphAST): GqlSchema

Generate a GraphQL schema model from a Betty/GGL graph AST.

Maps topology nodes to object types, PROCESS edges to queries, FOLD to
mutations, FORK to subscriptions, and RACE to unions.

Name	Type	Docs
`ast`	`GraphAST`	Parsed graph AST (nodes + edges) from a `.gg` topology

Returns GqlSchema

@param ast - Parsed graph AST (nodes + edges) from a `.gg` topology
@returns Intermediate {@link GqlSchema} used by SDL / OpenAPI / Postman export

src/gg-to-graphql.ts:201

function

`initXGqlTracingFromEnv`

function initXGqlTracingFromEnv(env: TraceEnv | undefined = defaultTraceEnv(): void

Handles the x gql init XGql Tracing From Env workflow.

Name	Type	Docs
`env?`	`TraceEnv \| undefined`

Returns void

src/tracing.ts:144

function

`isXGqlTracingEnabled`

function isXGqlTracingEnabled(env: TraceEnv | undefined): boolean

Returns whether is XGql Tracing Enabled is true.

Name	Type	Docs
`env`	`TraceEnv \| undefined`

Returns boolean

src/tracing.ts:114

function

`schemaToGraphQL`

function schemaToGraphQL(schema: GqlSchema): string

Serialize a {@link GqlSchema} to GraphQL SDL text.

Name	Type	Docs
`schema`	`GqlSchema`	Intermediate schema from {@link generateSchema}

Returns string

@param schema - Intermediate schema from {@link generateSchema}
@returns GraphQL SDL string (types, Query, Mutation, Subscription, directives)

src/gg-to-graphql.ts:256

function

`schemaToOpenAPI`

function schemaToOpenAPI(schema: GqlSchema, title: string): object

Project a {@link GqlSchema} into an OpenAPI 3.1 document.

Each query becomes `GET /api/{name}`; each mutation becomes `POST /api/{name}`.

Name	Type	Docs
`schema`	`GqlSchema`	Intermediate schema from {@link generateSchema}
`title`	`string`	OpenAPI `info.title`

Returns object

@param schema - Intermediate schema from {@link generateSchema}
@param title - OpenAPI `info.title`
@returns OpenAPI 3.1 document object

src/gg-to-graphql.ts:352

function

`schemaToPostman`

function schemaToPostman(schema: GqlSchema, name: string, baseUrl: string): object

Project a {@link GqlSchema} into a Postman Collection v2.1.

Name	Type	Docs
`schema`	`GqlSchema`	Intermediate schema from {@link generateSchema}
`name`	`string`	Collection name
`baseUrl`	`string`	GraphQL HTTP endpoint base URL

Returns object

@param schema - Intermediate schema from {@link generateSchema}
@param name - Collection name
@param baseUrl - GraphQL HTTP endpoint base URL
@returns Postman collection object

src/gg-to-graphql.ts:423

function

`withXGqlSpan`

function withXGqlSpan(name: string, fn: (span: Span): void

No documentation comment.

Name	Type	Docs
`name`	`string`
`fn`	`(span: Span`

Returns void

src/tracing.ts:166

variable

`xGqlTracer`

const xGqlTracer: unknown

No documentation comment.

src/tracing.ts:13

API reference

Exports from src/index.ts

Exports from `src/index.ts`