-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
visitor.ts
254 lines (220 loc) · 10 KB
/
visitor.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
import {
ClientSideBaseVisitor,
ClientSideBasePluginConfig,
getConfigValue,
LoadedFragment,
DocumentMode,
} from '@graphql-codegen/visitor-plugin-common';
import { VueApolloRawPluginConfig } from './config';
import autoBind from 'auto-bind';
import { OperationDefinitionNode, GraphQLSchema } from 'graphql';
import { Types } from '@graphql-codegen/plugin-helpers';
import { pascalCase } from 'pascal-case';
export interface VueApolloPluginConfig extends ClientSideBasePluginConfig {
withCompositionFunctions: boolean;
vueApolloComposableImportFrom: string;
addDocBlocks: boolean;
}
interface BuildCompositionFunctions {
operationName: string;
operationType: 'Query' | 'Mutation' | 'Subscription';
operationResultType: string;
operationVariablesTypes: string;
operationHasNonNullableVariable: boolean;
operationHasVariables: boolean;
documentNodeVariable: string;
}
function insertIf(condition: boolean, ...elements: any[]) {
return condition ? elements : [];
}
export class VueApolloVisitor extends ClientSideBaseVisitor<VueApolloRawPluginConfig, VueApolloPluginConfig> {
private externalImportPrefix: string;
private imports = new Set<string>();
constructor(
schema: GraphQLSchema,
fragments: LoadedFragment[],
rawConfig: VueApolloRawPluginConfig,
documents: Types.DocumentFile[]
) {
super(schema, fragments, rawConfig, {
withCompositionFunctions: getConfigValue(rawConfig.withCompositionFunctions, true),
vueApolloComposableImportFrom: getConfigValue(rawConfig.vueApolloComposableImportFrom, '@vue/apollo-composable'),
addDocBlocks: getConfigValue(rawConfig.addDocBlocks, true),
});
this.externalImportPrefix = this.config.importOperationTypesFrom ? `${this.config.importOperationTypesFrom}.` : '';
this._documents = documents;
autoBind(this);
}
private get vueApolloComposableImport(): string {
return `import * as VueApolloComposable from '${this.config.vueApolloComposableImportFrom}';`;
}
private get vueCompositionApiImport(): string {
return `import * as VueCompositionApi from '@vue/composition-api';`;
}
private get reactiveFunctionType(): string {
return 'export type ReactiveFunction<TParam> = () => TParam;';
}
private getDocumentNodeVariable(node: OperationDefinitionNode, documentVariableName: string): string {
return this.config.documentMode === DocumentMode.external ? `Operations.${node.name.value}` : documentVariableName;
}
public getImports(): string[] {
const baseImports = super.getImports();
const hasOperations = this._collectedOperations.length > 0;
if (!hasOperations) {
return baseImports;
}
return [...baseImports, ...Array.from(this.imports)];
}
private buildCompositionFunctionsJSDoc(
node: OperationDefinitionNode,
operationName: string,
operationType: string
): string {
const variableString = node.variableDefinitions?.reduce((accumulator, currentDefinition) => {
const name = currentDefinition.variable.name.value;
return `${accumulator}\n * ${name}: // value for '${name}'`;
}, '');
const queryDescription = `
* To run a query within a Vue component, call \`use${operationName}\` and pass it any options that fit your needs.
* When your component renders, \`use${operationName}\` returns an object from Apollo Client that contains result, loading and error properties
* you can use to render your UI.`;
const queryExample = `
* const { result, loading, error } = use${operationName}(
* {${variableString}
* }
* );`;
const mutationDescription = `
* To run a mutation, you first call \`use${operationName}\` within a Vue component and pass it any options that fit your needs.
* When your component renders, \`use${operationName}\` returns an object that includes:
* - A mutate function that you can call at any time to execute the mutation
* - Several other properties: https://v4.apollo.vuejs.org/api/use-mutation.html#return`;
const mutationExample = `
* const { mutate, loading, error, onDone } = use${operationName}({
* variables: {${variableString}
* },
* });`;
return `
/**
* __use${operationName}__
*${operationType === 'Mutation' ? mutationDescription : queryDescription}
*
* @param options that will be passed into the ${operationType.toLowerCase()}, supported options are listed on: https://v4.apollo.vuejs.org/guide-composable/${
operationType === 'Mutation' ? 'mutation' : operationType === 'Subscription' ? 'subscription' : 'query'
}.html#options;
*
* @example${operationType === 'Mutation' ? mutationExample : queryExample}
*/`;
}
private getCompositionFunctionSuffix(name: string, operationType: string) {
if (!this.config.dedupeOperationSuffix) {
return pascalCase(operationType);
}
if (name.includes('Query') || name.includes('Mutation') || name.includes('Subscription')) {
return '';
}
return pascalCase(operationType);
}
protected buildOperation(
node: OperationDefinitionNode,
documentVariableName: string,
operationType: 'Query' | 'Mutation' | 'Subscription',
operationResultType: string,
operationVariablesTypes: string
): string {
operationResultType = this.externalImportPrefix + operationResultType;
operationVariablesTypes = this.externalImportPrefix + operationVariablesTypes;
if (!this.config.withCompositionFunctions) {
// todo - throw human readable error
return '';
}
if (!node.name?.value) {
// todo - throw human readable error
return '';
}
const suffix = this.getCompositionFunctionSuffix(node.name.value, operationType);
const operationName: string = this.convertName(node.name.value, {
suffix,
useTypesPrefix: false,
});
const operationHasVariables = node.variableDefinitions?.length > 0;
const operationHasNonNullableVariable = !!node.variableDefinitions?.some(({ type }) => type.kind === 'NonNullType');
this.imports.add(this.vueApolloComposableImport);
this.imports.add(this.vueCompositionApiImport);
// hacky: technically not an import, but a typescript type that is required in the generated code
this.imports.add(this.reactiveFunctionType);
const documentNodeVariable = this.getDocumentNodeVariable(node, documentVariableName); // i.e. TestDocument
const compositionFunctionResultType = this.buildCompositionFunctionReturnType({
operationName,
operationType,
operationResultType,
operationVariablesTypes,
});
const compositionFunction = this.buildCompositionFunction({
operationName,
operationType,
operationResultType,
operationVariablesTypes,
operationHasNonNullableVariable,
operationHasVariables,
documentNodeVariable,
});
return [
...insertIf(this.config.addDocBlocks, [this.buildCompositionFunctionsJSDoc(node, operationName, operationType)]),
compositionFunction,
compositionFunctionResultType,
].join('\n');
}
private buildCompositionFunction({
operationName,
operationType,
operationResultType,
operationVariablesTypes,
operationHasNonNullableVariable,
operationHasVariables,
documentNodeVariable,
}: BuildCompositionFunctions): string {
switch (operationType) {
case 'Query': {
return `export function use${operationName}(${
operationHasVariables
? `variables${
operationHasNonNullableVariable ? '' : '?'
}: ${operationVariablesTypes} | VueCompositionApi.Ref<${operationVariablesTypes}> | ReactiveFunction<${operationVariablesTypes}>, `
: ''
}options: VueApolloComposable.Use${operationType}Options<${operationResultType}, ${operationVariablesTypes}> | VueCompositionApi.Ref<VueApolloComposable.Use${operationType}Options<${operationResultType}, ${operationVariablesTypes}>> | ReactiveFunction<VueApolloComposable.Use${operationType}Options<${operationResultType}, ${operationVariablesTypes}>> = {}) {
return VueApolloComposable.use${operationType}<${operationResultType}, ${
operationHasVariables ? operationVariablesTypes : 'undefined'
}>(${documentNodeVariable}, ${operationHasVariables ? 'variables' : 'undefined'}, options);
}`;
}
case 'Mutation': {
return `export function use${operationName}(options: VueApolloComposable.Use${operationType}Options${
operationHasVariables ? (operationHasNonNullableVariable ? 'WithVariables' : '') : 'NoVariables'
}<${operationResultType}, ${operationVariablesTypes}>${operationHasNonNullableVariable ? '' : ' = {}'}) {
return VueApolloComposable.use${operationType}<${operationResultType}, ${operationVariablesTypes}>(${documentNodeVariable}, options);
}`;
}
case 'Subscription': {
return `export function use${operationName}(${
operationHasVariables
? `variables${
operationHasNonNullableVariable ? '' : '?'
}: ${operationVariablesTypes} | VueCompositionApi.Ref<${operationVariablesTypes}> | ReactiveFunction<${operationVariablesTypes}>, `
: ''
}options: VueApolloComposable.Use${operationType}Options<${operationResultType}, ${operationVariablesTypes}> | VueCompositionApi.Ref<VueApolloComposable.Use${operationType}Options<${operationResultType}, ${operationVariablesTypes}>> | ReactiveFunction<VueApolloComposable.Use${operationType}Options<${operationResultType}, ${operationVariablesTypes}>> = {}) {
return VueApolloComposable.use${operationType}<${operationResultType}, ${
operationHasVariables ? operationVariablesTypes : 'undefined'
}>(${documentNodeVariable}, ${operationHasVariables ? 'variables' : 'undefined'}, options);
}`;
}
}
}
private buildCompositionFunctionReturnType({
operationName,
operationType,
operationResultType,
operationVariablesTypes,
}: Partial<BuildCompositionFunctions>) {
return `export type ${operationName}CompositionFunctionResult = VueApolloComposable.Use${operationType}Return<${operationResultType}, ${operationVariablesTypes}>;`;
}
}