GraphQL Schema

In FrogBot the schema is controlled by your collections. Run the generate command to create the entire schema.

Schema generation script

Install @frogbotai/graphql as a dev dependency:

pnpm add @frogbotai/graphql -D

Run the following command to generate the schema:

pnpm frogbot-graphql generate:schema

The command finds your FrogBot config the same way frogbot generate:types does and writes schema.graphql to the directory you run it in. The schema contains a type for each of your collections, plus FrogBot’s public built-in collections and search queries. FrogBot’s internal collections aren’t included. To write the file somewhere else, set graphQL.schemaOutputFile in your FrogBot config. A relative path is resolved from the directory you run the command in:

import type { FrogBotConfig } from 'frogbot'

export const graphQL: FrogBotConfig['graphQL'] = {
  schemaOutputFile: './graphql/schema.graphql',
}

Pass graphQL to buildConfig in your FrogBot config.

Custom Field Schemas

For array, block, group and named tab fields, you can generate top level reusable interfaces. The following group field config:

import type { CollectionConfig } from 'frogbot'

export const Collection1: CollectionConfig = {
  slug: 'collection1',
  fields: [
    {
      type: 'group',
      name: 'meta',
      interfaceName: 'SharedMeta',
      fields: [
        {
          name: 'title',
          type: 'text',
        },
        {
          name: 'description',
          type: 'text',
        },
      ],
    },
  ],
}

will generate:

# A top level reusable type will be generated
type SharedMeta {
  title: String
  description: String
}

# And will be referenced inside the generated schema
type Collection1 {
  # ...other fields
  meta: SharedMeta
}

Adding an npm script

FrogBot needs to be able to find your config to generate your GraphQL schema.

FrogBot looks for frogbot.config.{ts,js,mjs} in the current directory, its src folder, and each parent directory. If your config lives somewhere else, tell FrogBot where to find it with the FROGBOT_CONFIG_PATH environment variable. If this applies to you, create an npm script to make generating the schema easier:

// package.json

{
  "scripts": {
    "generate:graphQLSchema": "cross-env FROGBOT_CONFIG_PATH=config/frogbot.config.ts frogbot-graphql generate:schema"
  }
}

Now you can run pnpm generate:graphQLSchema to easily generate your schema.

Start here

Basics

Managing Data

Features

Ecosystem

Deployment

Schema generation script

Custom Field Schemas

Adding an npm script

​Schema generation script

​Custom Field Schemas

​Adding an npm script

Schema generation script

Custom Field Schemas

Adding an npm script