mirror of
https://github.com/vale981/Vulcan
synced 2025-03-09 20:16:39 -04:00
399 lines
8.8 KiB
JavaScript
399 lines
8.8 KiB
JavaScript
import { Utils } from './utils';
|
|
import { getFragmentName } from './fragments';
|
|
|
|
export const convertToGraphQL = (fields, indentation) => {
|
|
return fields.length > 0 ? fields.map(f => fieldTemplate(f, indentation)).join(`\n`) : '';
|
|
}
|
|
|
|
export const arrayToGraphQL = fields => fields.map(f => `${f.name}: ${f.type}`).join(', ');
|
|
|
|
/*
|
|
|
|
For backwards-compatibility reasons, args can either be a string or an array of objects
|
|
|
|
*/
|
|
export const getArguments = args => {
|
|
if (Array.isArray(args) && args.length > 0) {
|
|
return `(${arrayToGraphQL(args)})`;
|
|
} else if (typeof args === 'string') {
|
|
return `(${args})`;
|
|
} else {
|
|
return '';
|
|
}
|
|
}
|
|
|
|
/* ------------------------------------- Generic Field Template ------------------------------------- */
|
|
|
|
export const fieldTemplate = ({ name, type, args, directive, description, required }, indentation = '') =>
|
|
`${description ? `${indentation}# ${description}\n` : ''}${indentation}${name}${getArguments(args)}: ${type}${required ? '!' : ''} ${directive ? directive : ''}`;
|
|
|
|
/* ------------------------------------- Main Type ------------------------------------- */
|
|
|
|
/*
|
|
|
|
The main type
|
|
|
|
type Movie{
|
|
_id: String
|
|
title: String
|
|
description: String
|
|
createdAt: Date
|
|
}
|
|
|
|
*/
|
|
export const mainTypeTemplate = ({ typeName, description, interfaces, fields }) =>
|
|
`# ${description}
|
|
type ${typeName} ${interfaces.length ? `implements ${interfaces.join(`, `)} ` : ''}{
|
|
${convertToGraphQL(fields, ' ')}
|
|
}
|
|
`;
|
|
|
|
/* ------------------------------------- Selector Types ------------------------------------- */
|
|
|
|
/*
|
|
|
|
The selector type is used to query for one or more documents
|
|
|
|
type MovieSelectorInput {
|
|
AND: [MovieSelectorInput]
|
|
OR: [MovieSelectorInput]
|
|
id: String
|
|
id_not: String
|
|
id_in: [String!]
|
|
id_not_in: [String!]
|
|
...
|
|
name: String
|
|
name_not: String
|
|
name_in: [String!]
|
|
name_not_in: [String!]
|
|
...
|
|
}
|
|
|
|
see https://www.opencrud.org/#sec-Data-types
|
|
|
|
*/
|
|
export const selectorInputTemplate = ({ typeName, fields }) =>
|
|
`input ${typeName}SelectorInput {
|
|
AND: [${typeName}SelectorInput]
|
|
OR: [${typeName}SelectorInput]
|
|
${convertToGraphQL(fields, ' ')}
|
|
}`;
|
|
|
|
/*
|
|
|
|
The unique selector type is used to query for exactly one document
|
|
|
|
type MovieSelectorUniqueInput {
|
|
_id: String
|
|
slug: String
|
|
}
|
|
|
|
*/
|
|
export const selectorUniqueInputTemplate = ({ typeName, fields }) =>
|
|
`input ${typeName}SelectorUniqueInput {
|
|
foobar: String
|
|
${convertToGraphQL(fields, ' ')}
|
|
}`;
|
|
|
|
/*
|
|
|
|
The orderBy type defines which fields a query can be ordered by
|
|
|
|
enum MovieOrderByInput {
|
|
title
|
|
createdAt
|
|
}
|
|
|
|
*/
|
|
export const orderByInputTemplate = ({ typeName, fields }) =>
|
|
`enum ${typeName}OrderByInput {
|
|
foobar
|
|
${fields.join('\n ')}
|
|
}`;
|
|
|
|
/* ------------------------------------- Query Types ------------------------------------- */
|
|
|
|
/*
|
|
|
|
A query for a single document
|
|
|
|
movie(input: SingleMovieInput) : SingleMovieOutput
|
|
|
|
*/
|
|
export const singleQueryTemplate = ({ typeName }) => `${Utils.camelCaseify(typeName)}(input: Single${typeName}Input): Single${typeName}Output`;
|
|
|
|
|
|
/*
|
|
|
|
A query for multiple documents
|
|
|
|
movies(input: MultiMovieInput) : MultiMovieOutput
|
|
|
|
*/
|
|
export const multiQueryTemplate = ({ typeName }) => `${Utils.camelCaseify(typeName)}s(input: Multi${typeName}Input): Multi${typeName}Output`;
|
|
|
|
/* ------------------------------------- Query Input Types ------------------------------------- */
|
|
|
|
/*
|
|
|
|
The argument type when querying for a single document
|
|
|
|
type SingleMovieInput {
|
|
documentId: String
|
|
slug: String
|
|
enableCache: Boolean
|
|
}
|
|
|
|
*/
|
|
export const singleInputTemplate = ({ typeName }) =>
|
|
`input Single${typeName}Input {
|
|
# The document's unique ID
|
|
documentId: String,
|
|
# A unique slug identifying the document
|
|
slug: String,
|
|
# Whether to enable caching for this query
|
|
enableCache: Boolean
|
|
}`;
|
|
|
|
/*
|
|
|
|
The argument type when querying for multiple documents
|
|
|
|
type MultiMovieInput {
|
|
terms: JSON
|
|
offset: Int
|
|
limit: Int
|
|
enableCache: Boolean
|
|
}
|
|
|
|
*/
|
|
export const multiInputTemplate = ({ typeName }) =>
|
|
`input Multi${typeName}Input {
|
|
# A JSON object that contains the query terms used to fetch data
|
|
terms: JSON,
|
|
# How much to offset the results by
|
|
offset: Int,
|
|
# A limit for the query
|
|
limit: Int,
|
|
# Whether to enable caching for this query
|
|
enableCache: Boolean
|
|
# OpenCRUD fields
|
|
where: ${typeName}SelectorInput
|
|
orderBy: ${typeName}OrderByInput
|
|
skip: Int
|
|
after: String
|
|
before: String
|
|
first: Int
|
|
last: Int
|
|
}`;
|
|
|
|
/* ------------------------------------- Query Output Types ------------------------------------- */
|
|
|
|
/*
|
|
|
|
The type for the return value when querying for a single document
|
|
|
|
type SingleMovieOuput{
|
|
result: Movie
|
|
}
|
|
|
|
*/
|
|
export const singleOutputTemplate = ({ typeName }) =>
|
|
`type Single${typeName}Output{
|
|
result: ${typeName}
|
|
}`;
|
|
|
|
/*
|
|
|
|
The type for the return value when querying for multiple documents
|
|
|
|
type MultiMovieOuput{
|
|
results: [Movie]
|
|
totalCount: Int
|
|
}
|
|
|
|
*/
|
|
export const multiOutputTemplate = ({ typeName }) =>
|
|
`type Multi${typeName}Output{
|
|
results: [${typeName}]
|
|
totalCount: Int
|
|
}`;
|
|
|
|
/* ------------------------------------- Query Queries ------------------------------------- */
|
|
|
|
export const singleClientTemplate = ({ typeName, fragment, extraQueries }) =>
|
|
`query Single${typeName}Query($input: Single${typeName}Input) {
|
|
${Utils.camelCaseify(typeName)}(input: $input) {
|
|
__typename
|
|
result {
|
|
...${getFragmentName(fragment)}
|
|
}
|
|
}
|
|
${extraQueries ? extraQueries : ''}
|
|
}`;
|
|
|
|
export const multiClientTemplate = ({ typeName, fragment, extraQueries }) =>
|
|
`query Multi${typeName}Query($input: Multi${typeName}Input) {
|
|
${Utils.camelCaseify(typeName)}s(input: $input) {
|
|
__typename
|
|
results {
|
|
...${getFragmentName(fragment)}
|
|
}
|
|
totalCount
|
|
}
|
|
${extraQueries ? extraQueries : ''}
|
|
}`;
|
|
|
|
/* ------------------------------------- Mutation Types ------------------------------------- */
|
|
|
|
/*
|
|
|
|
Mutation for creating a new document
|
|
|
|
createMovie(input: CreateMovieInput) : MovieOutput
|
|
|
|
*/
|
|
export const createMutationTemplate = ({ typeName }) =>
|
|
`create${typeName}(input: Create${typeName}Input) : ${typeName}Output`;
|
|
|
|
/*
|
|
|
|
Mutation for updating an existing document
|
|
|
|
updateMovie(input: UpdateMovieInput) : MovieOutput
|
|
|
|
*/
|
|
export const updateMutationTemplate = ({ typeName }) =>
|
|
`update${typeName}(input: Update${typeName}Input) : ${typeName}Output`;
|
|
|
|
/*
|
|
|
|
Mutation for updating an existing document; or creating it if it doesn't exist yet
|
|
|
|
upsertMovie(input: UpsertMovieInput) : MovieOutput
|
|
|
|
*/
|
|
export const upsertMutationTemplate = ({ typeName }) =>
|
|
`upsert${typeName}(input: Upsert${typeName}Input) : ${typeName}Output`;
|
|
|
|
/*
|
|
|
|
Mutation for deleting an existing document
|
|
|
|
deleteMovie(input: DeleteMovieInput) : MovieOutput
|
|
|
|
*/
|
|
export const deleteMutationTemplate = ({ typeName }) =>
|
|
`delete${typeName}(input: Delete${typeName}Input) : ${typeName}Output`;
|
|
|
|
/* ------------------------------------- Mutation Input Types ------------------------------------- */
|
|
|
|
/*
|
|
|
|
Type for create mutation input argument
|
|
|
|
type CreateMovieInput {
|
|
data: CreateMovieDataInput!
|
|
}
|
|
|
|
*/
|
|
export const createInputTemplate = ({ typeName }) =>
|
|
`input Create${typeName}Input{
|
|
data: Create${typeName}DataInput!
|
|
}`;
|
|
|
|
/*
|
|
|
|
Type for update mutation input argument
|
|
|
|
type UpdateMovieInput {
|
|
selector: MovieSelectorUniqueInput!
|
|
data: UpdateMovieDataInput!
|
|
}
|
|
|
|
*/
|
|
export const updateInputTemplate = ({ typeName }) =>
|
|
`input Update${typeName}Input{
|
|
selector: ${typeName}SelectorUniqueInput!
|
|
data: Update${typeName}DataInput!
|
|
}`;
|
|
|
|
/*
|
|
|
|
Type for upsert mutation input argument
|
|
|
|
Note: upsertInputTemplate uses same data type as updateInputTemplate
|
|
|
|
type UpsertMovieInput {
|
|
selector: MovieSelectorUniqueInput!
|
|
data: UpdateMovieDataInput!
|
|
}
|
|
|
|
*/
|
|
export const upsertInputTemplate = ({ typeName }) =>
|
|
`input Upsert${typeName}Input{
|
|
selector: ${typeName}SelectorUniqueInput!
|
|
data: Update${typeName}DataInput!
|
|
}`;
|
|
|
|
/*
|
|
|
|
Type for delete mutation input argument
|
|
|
|
type DeleteMovieInput {
|
|
selector: MovieSelectorUniqueInput!
|
|
}
|
|
|
|
*/
|
|
export const deleteInputTemplate = ({ typeName }) =>
|
|
`input Delete${typeName}Input{
|
|
selector: ${typeName}SelectorUniqueInput!
|
|
}`;
|
|
|
|
/*
|
|
|
|
Type for the create mutation input argument's data property
|
|
|
|
type CreateMovieDataInput {
|
|
title: String
|
|
description: String
|
|
}
|
|
|
|
*/
|
|
export const createDataInputTemplate = ({ typeName, fields }) =>
|
|
`input Create${typeName}DataInput {
|
|
${convertToGraphQL(fields, ' ')}
|
|
}`;
|
|
|
|
/*
|
|
|
|
Type for the update mutation input argument's data property
|
|
|
|
type UpdateMovieDataInput {
|
|
title: String
|
|
description: String
|
|
}
|
|
|
|
*/
|
|
export const updateDataInputTemplate = ({ typeName, fields }) =>
|
|
`input Update${typeName}DataInput {
|
|
${convertToGraphQL(fields, ' ')}
|
|
}`;
|
|
|
|
/* ------------------------------------- Mutation Output Type ------------------------------------- */
|
|
|
|
/*
|
|
|
|
Type for the return value of all mutations
|
|
|
|
type MovieOutput {
|
|
data: Movie
|
|
}
|
|
|
|
*/
|
|
export const mutationOutputTemplate = ({ typeName }) =>
|
|
`type ${typeName}Output{
|
|
data: ${typeName}
|
|
}`;
|
|
|
|
/* ------------------------------------- Mutation Queries ------------------------------------- */
|