mirror of
https://github.com/supabase/supabase.git
synced 2026-09-07 02:20:52 +08:00
f611fa11d9
Add models and GraphQL interface definitions for search results and guides (representing Markdown documents such as tutorials, etc.). These aren't connected to anything yet, but putting them in a separate PR to keep the review short and relatively simple. Towards DOCS-214
57 lines
2.2 KiB
TypeScript
57 lines
2.2 KiB
TypeScript
import { GraphQLObjectType, GraphQLString } from 'graphql'
|
|
import { GraphQLInterfaceTypeSearchResult } from '../globalSearch/globalSearchSchema'
|
|
import { createCollectionType, GraphQLCollectionBuilder } from '../utils/connections'
|
|
import { GuideModel, SubsectionModel } from './guideModel'
|
|
|
|
export const GraphQLObjectTypeSubsection = new GraphQLObjectType({
|
|
name: 'Subsection',
|
|
isTypeOf: (value: unknown) => value instanceof SubsectionModel,
|
|
description: 'A content chunk taken from a larger document in the Supabase docs',
|
|
fields: {
|
|
title: {
|
|
type: GraphQLString,
|
|
description: 'The title of the subsection',
|
|
},
|
|
href: {
|
|
type: GraphQLString,
|
|
description: 'The URL of the subsection',
|
|
},
|
|
content: {
|
|
type: GraphQLString,
|
|
description: 'The content of the subsection',
|
|
},
|
|
},
|
|
})
|
|
|
|
export const GraphQLObjectTypeGuide = new GraphQLObjectType({
|
|
name: 'Guide',
|
|
interfaces: [GraphQLInterfaceTypeSearchResult],
|
|
isTypeOf: (value: unknown) => value instanceof GuideModel,
|
|
description:
|
|
'A document containing content from the Supabase docs. This is a guide, which might describe a concept, or explain the steps for using or implementing a feature.',
|
|
fields: {
|
|
title: {
|
|
type: GraphQLString,
|
|
description: 'The title of the document',
|
|
},
|
|
href: {
|
|
type: GraphQLString,
|
|
description: 'The URL of the document',
|
|
},
|
|
content: {
|
|
type: GraphQLString,
|
|
description:
|
|
'The full content of the document, including all subsections (both those matching and not matching any query string) and possibly more content',
|
|
},
|
|
subsections: {
|
|
type: createCollectionType(GraphQLObjectTypeSubsection, {
|
|
skipPageInfo: true,
|
|
description: 'A collection of content chunks from a larger document in the Supabase docs.',
|
|
}),
|
|
description:
|
|
'The subsections of the document. If the document is returned from a search match, only matching content chunks are returned. For the full content of the original document, use the content field in the parent Guide.',
|
|
resolve: (node: GuideModel) => GraphQLCollectionBuilder.create({ items: node.subsections }),
|
|
},
|
|
},
|
|
})
|