kentico-cloud-graphql-schema-generator

Kentico GraphQl schema generator

GraphQL schema generator used to generate schema based on specified project.

This schema could be used when creating GraphQl endpoint from Kentico Cloud Delivery API REST endpoint.

Get started

Prerequisites

• Node installed

Installation

npm i kentico-cloud-graphql-schema-generator -g

Generating schema with NPM script

Provide a project ID of your project.

kc-generate-gql-schema --projectId xxx

Development

1. Clone the repository
2. Run npm install to intall all rewuired dependencies
3. Run npm run build to build the solution

Run

Run node ./_commonjs/index.js --projectId xxx

Test

• Run npm test to run all tests

Run watch mode

• Run npm run watch to run the watch mode

Example output

type SystemInfo {
  id: String!
  name: String!
  codename: String!
  language: String!
  type: String!
  lastModified: String!
}
interface ContentItem {
  system: SystemInfo!
}
type MultipleChoiceElementOption {
  name: String!
  codename: String
}
type TaxonomyTerm {
  name: String!
  codename: String
}
type Asset {
  name: String
  type: String
  size: Int
  description: String
  url: String,
}
type Link {
  codename: String
  itemID: String
  urlSlug: String
  type: String
}
type TextElement {
  type: String!
  name: String!
  value: String
}
type NumberElement {
  type: String!
  name: String!
  value: String
  number: Int
}
type DateTimeElement {
  type: String!
  name: String!
  value: String
  datetime: String
}
type MultipleChoiceElement {
  type: String!
  name: String!
  value: String
  options: [MultipleChoiceElementOption]
}
type UrlSlugElement {
  type: String!
  name: String!
  value: String
  data: String
}
type TaxonomyElement {
  type: String!
  name: String!
  value: String
  taxonomyGroup: String
  taxonomyTerms: [TaxonomyTerm]
}
type AssetElement {
  type: String!
  name: String!
  value: String
  assets: [Asset]
}
type RichTextElement {
  type: String!
  name: String!
  value: String
  linkedItemCodenames: [String]
  links: [Link]
}

type AboutUsContentType implements ContentItem {
  system: SystemInfo!
  metadata__og_description: TextElement
  metadata__meta_title: TextElement
  metadata__og_title: TextElement
  metadata__meta_description: TextElement
  metadata__twitter_site: TextElement
  url_pattern: UrlSlugElement
  metadata__twitter_image: AssetElement
  metadata__twitter_creator: TextElement
  metadata__twitter_title: TextElement
  metadata__twitter_description: TextElement
  metadata__og_image: AssetElement
  facts: [ContentItem]
}

type AccessoryContentType implements ContentItem {
  system: SystemInfo!
  metadata__og_description: TextElement
  metadata__meta_title: TextElement
  metadata__og_title: TextElement
  long_description: RichTextElement
  metadata__meta_description: TextElement
  metadata__twitter_site: TextElement
  price: NumberElement
  metadata__twitter_image: AssetElement
  metadata__twitter_creator: TextElement
  url_pattern: UrlSlugElement
  short_description: RichTextElement
  manufacturer: TextElement
  metadata__twitter_title: TextElement
  metadata__twitter_description: TextElement
  metadata__og_image: AssetElement
  product_status: TaxonomyElement
  image: AssetElement
  product_name: TextElement
}

type ArticleContentType implements ContentItem {
  system: SystemInfo!
  metadata__og_description: TextElement
  metadata__meta_title: TextElement
  personas: TaxonomyElement
  body_copy: RichTextElement
  metadata__og_title: TextElement
  metadata__meta_description: TextElement
  metadata__twitter_site: TextElement
  post_date: DateTimeElement
  meta_keywords: TextElement
  teaser_image: AssetElement
  metadata__twitter_image: AssetElement
  metadata__twitter_creator: TextElement
  title: TextElement
  summary: TextElement
  metadata__twitter_title: TextElement
  metadata__twitter_description: TextElement
  meta_description: TextElement
  metadata__og_image: AssetElement
  related_articles: [ContentItem]
  url_pattern: UrlSlugElement
}

type BrewerContentType implements ContentItem {
  system: SystemInfo!
  product_name: TextElement
  metadata__og_description: TextElement
  metadata__meta_title: TextElement
  long_description: RichTextElement
  metadata__og_title: TextElement
  metadata__meta_description: TextElement
  metadata__twitter_site: TextElement
  price: NumberElement
  manufacturer: TaxonomyElement
  metadata__twitter_image: AssetElement
  metadata__twitter_creator: TextElement
  url_pattern: UrlSlugElement
  short_description: RichTextElement
  product_status: TaxonomyElement
  metadata__twitter_title: TextElement
  metadata__twitter_description: TextElement
  metadata__og_image: AssetElement
  image: AssetElement
}

type CafeContentType implements ContentItem {
  system: SystemInfo!
  phone: TextElement
  city: TextElement
  photo: AssetElement
  email: TextElement
  country: TextElement
  street: TextElement
  state: TextElement
  zip_code: TextElement
}

type CoffeeContentType implements ContentItem {
  system: SystemInfo!
  metadata__og_description: TextElement
  metadata__meta_title: TextElement
  metadata__og_title: TextElement
  product_status: TaxonomyElement
  altitude: TextElement
  metadata__meta_description: TextElement
  variety: TextElement
  image: AssetElement
  metadata__twitter_site: TextElement
  url_pattern: UrlSlugElement
  price: NumberElement
  metadata__twitter_image: AssetElement
  metadata__twitter_creator: TextElement
  country: TextElement
  metadata__twitter_title: TextElement
  short_description: RichTextElement
  processing: TaxonomyElement
  metadata__twitter_description: TextElement
  metadata__og_image: AssetElement
  long_description: RichTextElement
  farm: TextElement
  product_name: TextElement
}

type FactAboutUsContentType implements ContentItem {
  system: SystemInfo!
  description: RichTextElement
  title: TextElement
  image: AssetElement
}

type GrinderContentType implements ContentItem {
  system: SystemInfo!
  metadata__og_description: TextElement
  metadata__meta_title: TextElement
  metadata__og_title: TextElement
  price: NumberElement
  long_description: RichTextElement
  short_description: RichTextElement
  manufacturer: TextElement
  metadata__meta_description: TextElement
  metadata__twitter_site: TextElement
  product_status: TaxonomyElement
  metadata__twitter_image: AssetElement
  metadata__twitter_creator: TextElement
  image: AssetElement
  metadata__twitter_title: TextElement
  product_name: TextElement
  metadata__twitter_description: TextElement
  url_pattern: UrlSlugElement
  metadata__og_image: AssetElement
}

type HeroUnitContentType implements ContentItem {
  system: SystemInfo!
  title: TextElement
  image: AssetElement
  marketing_message: RichTextElement
}

type HomeContentType implements ContentItem {
  system: SystemInfo!
  metadata__og_description: TextElement
  metadata__meta_title: TextElement
  metadata__og_title: TextElement
  articles: [ContentItem]
  hero_unit: [ContentItem]
  metadata__meta_description: TextElement
  metadata__twitter_site: TextElement
  our_story: [ContentItem]
  cafes: [ContentItem]
  metadata__twitter_image: AssetElement
  metadata__twitter_creator: TextElement
  metadata__twitter_title: TextElement
  metadata__twitter_description: TextElement
  metadata__og_image: AssetElement
  url_pattern: UrlSlugElement
  contact: RichTextElement
}

type HostedVideoContentType implements ContentItem {
  system: SystemInfo!
  video_id: TextElement
  video_host: MultipleChoiceElement
}

type OfficeContentType implements ContentItem {
  system: SystemInfo!
  state: TextElement
  email: TextElement
  phone: TextElement
  country: TextElement
  city: TextElement
  name: TextElement
  zip_code: TextElement
  street: TextElement
}

type TweetContentType implements ContentItem {
  system: SystemInfo!
  tweet_link: TextElement
  theme: MultipleChoiceElement
  display_options: MultipleChoiceElement
}