/
generator.ts
405 lines (326 loc) · 11.8 KB
/
generator.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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
import * as _ from 'lodash';
import { RELAY_TYPE_PROMOTER_FIELD } from './protocolGraphqlConstants';
import { graphRegistry } from './graphRegistry';
import { ProtocolGraphQL } from './ProtocolGraphQL';
import { ProtocolGraphQLConfiguration } from './ProtocolGraphQLConfiguration';
import { shaper } from 'json-shaper';
import {
GraphQLObjectType,
GraphQLSchema,
GraphQLNonNull,
GraphQLID,
} from 'graphql';
import { nodeDefinitions, fromGlobalId, toGlobalId } from 'graphql-relay';
import { registerConnection, generateReverseConnections } from './connection';
import { generateListQueries, generateInstanceQueries } from './query';
import { generateMutations } from './mutation';
import { generateActions } from './action';
import { generateSubscriptions } from './subscription';
import { resolveByFindOne } from './resolver';
import { isConfiguration } from '../engine/configuration/Configuration';
import { isEntity } from '../engine/entity/Entity';
import { DataTypeI18n } from '../engine/datatype/dataTypes';
import {
ACTION_TYPE_MUTATION,
ACTION_TYPE_QUERY,
} from '../engine/action/Action';
import { isViewEntity } from '../engine/entity/ViewEntity';
import { isShadowEntity } from '../engine/entity/ShadowEntity';
import { generateInstanceUniquenessInputs } from './operation';
export const getTypeForEntityFromGraphRegistry = entity => {
const typeName = entity.graphql.typeName;
return graphRegistry.types[typeName];
};
// prepare models for graphql
export const extendModelsForGql = entities => {
const protocolConfiguration = ProtocolGraphQL.getProtocolConfiguration() as ProtocolGraphQLConfiguration;
_.forEach(entities, entity => {
entity.graphql = entity.graphql || {};
// generate type names for various cases
entity.graphql.typeName = protocolConfiguration.generateEntityTypeName(
entity,
);
entity.graphql.typeNamePlural = protocolConfiguration.generateEntityTypeNamePlural(
entity,
);
entity.graphql.typeNamePascalCase = protocolConfiguration.generateEntityTypeNamePascalCase(
entity,
);
entity.graphql.typeNamePluralPascalCase = protocolConfiguration.generateEntityTypeNamePluralPascalCase(
entity,
);
const dataShaperMap = {};
_.forEach(entity.getAttributes(), attribute => {
attribute.gqlFieldName = attribute.primary
? 'id'
: protocolConfiguration.generateFieldName(attribute);
dataShaperMap[attribute.gqlFieldName] = attribute.name;
if (attribute.i18n) {
attribute.gqlFieldNameI18n = protocolConfiguration.generateI18nFieldName(
attribute,
);
dataShaperMap[attribute.gqlFieldNameI18n] = `${attribute.name}.i18n`;
attribute.gqlFieldNameI18nJson = protocolConfiguration.generateI18nJsonFieldName(
attribute,
);
dataShaperMap[
attribute.gqlFieldNameI18nJson
] = `${attribute.name}.i18n`;
}
});
// forward relay type promoter field as well
dataShaperMap[RELAY_TYPE_PROMOTER_FIELD] = RELAY_TYPE_PROMOTER_FIELD;
// generate json shaper - translate schema attribute names to graphql attribute names
const dataShaper = shaper(dataShaperMap);
entity.graphql.dataShaper = data => {
return data ? dataShaper(data) : data;
};
entity.graphql.dataSetShaper = set => {
return set.map(entity.graphql.dataShaper);
};
// remove i18n JSON output mapping so it doesn't overwrite values in mutation inputs
_.forEach(entity.getAttributes(), attribute => {
if (attribute.i18n) {
delete dataShaperMap[attribute.gqlFieldNameI18nJson];
}
});
const reverseDataShaper = shaper(_.invert(dataShaperMap));
entity.graphql.reverseDataShaper = data => {
return data ? reverseDataShaper(data) : data;
};
});
};
// get node definitions for relay
const getNodeDefinitions = () => {
const idFetcher = (globalId, context) => {
const { type, id } = fromGlobalId(globalId);
// resolve based on type and id
const entity = graphRegistry.types[type]
? graphRegistry.types[type].entity
: null;
if (entity) {
const resolver = resolveByFindOne(entity, () => id);
return resolver(null, null, context);
}
return null;
};
const typeResolver = obj => {
const typeName = obj[RELAY_TYPE_PROMOTER_FIELD];
return graphRegistry.types[typeName]
? graphRegistry.types[typeName].type
: null;
};
return {
...nodeDefinitions(idFetcher, typeResolver),
idFetcher,
};
};
const registerAction = action => {
const actionName = action.name;
graphRegistry.actions[actionName] = {
action,
};
};
export const registerActions = actions => {
_.forEach(actions, action => registerAction(action));
};
export const generateGraphQLSchema = configuration => {
if (!isConfiguration(configuration)) {
throw new Error(
'Invalid configuration object provided to generateGraphQLSchema()',
);
}
const schema = configuration.getSchema();
const protocolConfiguration = configuration.getProtocolConfiguration();
ProtocolGraphQL.setProtocolConfiguration(protocolConfiguration);
const { nodeInterface, nodeField, idFetcher } = getNodeDefinitions();
registerActions(schema.getActions());
// prepare models for graphql
extendModelsForGql(schema.getEntities());
_.forEach(schema.getEntities(), entity => {
const typeName = entity.graphql.typeName;
const objectType = new GraphQLObjectType({
name: protocolConfiguration.generateEntityTypeNamePascalCase(entity),
description: entity.description,
interfaces: [nodeInterface],
fields: () => {
const fields = {
id: {
type: new GraphQLNonNull(GraphQLID),
},
nodeId: {
description: 'The node ID of an object',
type: new GraphQLNonNull(GraphQLID),
resolve: obj => toGlobalId(typeName, obj.id),
},
};
const fieldsReference = {};
const fieldsI18n = {};
_.forEach(entity.getAttributes(), attribute => {
if (attribute.hidden || attribute.mutationInput) {
return;
}
// const field = {
// description: attribute.description,
// };
let attributeType = attribute.type;
// it's a reference
if (isEntity(attributeType) || isShadowEntity(attributeType)) {
const targetEntity = attributeType;
const primaryAttribute = targetEntity.getPrimaryAttribute();
attributeType = primaryAttribute.type;
// const reference = {
// description: attribute.description,
// };
const targetTypeName = targetEntity.graphql.typeName;
// reference.type = graphRegistry.types[targetTypeName].type;
// reference.resolve = resolveByFindOne(
// targetEntity,
// ({ source }) => source[attribute.gqlFieldName],
// );
const reference = {
description: attribute.description,
type: graphRegistry.types[targetTypeName].type,
resolve: resolveByFindOne(
targetEntity,
({ source }) => source[attribute.gqlFieldName],
),
};
const referenceFieldName = protocolConfiguration.generateReferenceFieldName(
targetEntity,
attribute,
);
fieldsReference[referenceFieldName] = reference;
}
const fieldType = ProtocolGraphQL.convertToProtocolDataType(
attributeType,
entity.name,
false,
);
// make it non-nullable if it's required
// if (attribute.required) {
// field.type = new GraphQLNonNull(fieldType);
// } else {
// field.type = fieldType;
// }
// use computed value's function as the field resolver
// if (attribute.resolve) {
// field.resolve = attribute.resolve;
// }
const field = {
description: attribute.description,
type: attribute.required
? new GraphQLNonNull(fieldType)
: fieldType,
resolve: attribute.resolve ? attribute.resolve : undefined,
};
fields[attribute.gqlFieldName] = field;
if (attribute.i18n) {
// JSON i18n output
const i18nJsonFieldType = ProtocolGraphQL.convertToProtocolDataType(
DataTypeI18n,
entity.name,
false,
);
const i18nJsonField = {
type: attribute.required
? new GraphQLNonNull(i18nJsonFieldType)
: i18nJsonFieldType,
description: `Translations of **\`${attribute.gqlFieldName}\`** in JSON format`,
};
fieldsI18n[attribute.gqlFieldNameI18nJson] = i18nJsonField;
// Object Type i18n output
const i18nFieldType = new GraphQLObjectType({
name: protocolConfiguration.generateI18nFieldTypeName(
entity,
attribute,
),
description: `Translations of **\`${attribute.gqlFieldName}\`**`,
fields: () => {
const languages = configuration.getLanguages();
const i18nFields = {};
languages.map((language, langIdx) => {
const type =
langIdx === 0 && attribute.required
? new GraphQLNonNull(fieldType)
: fieldType;
i18nFields[language] = {
type,
};
});
return i18nFields;
},
});
fieldsI18n[attribute.gqlFieldNameI18n] = {
type: attribute.required
? new GraphQLNonNull(i18nFieldType)
: i18nFieldType,
};
}
});
Object.assign(
fields,
fieldsI18n,
fieldsReference,
generateReverseConnections(configuration, graphRegistry, entity),
);
return fields;
},
});
graphRegistry.types[typeName] = {
entity,
type: objectType,
};
if (isEntity(entity) || isViewEntity(entity)) {
registerConnection(graphRegistry, entity);
}
});
generateInstanceUniquenessInputs(graphRegistry);
// build the query type
const queryType = new GraphQLObjectType({
name: 'Query',
// root: 'The root query type',
fields: () => {
const listQueries = generateListQueries(graphRegistry);
const instanceQueries = generateInstanceQueries(graphRegistry, idFetcher);
const actions = generateActions(graphRegistry, ACTION_TYPE_QUERY);
// override args.id of relay to args.nodeId
nodeField.args.nodeId = nodeField.args.id;
nodeField.resolve = (_obj, { nodeId }, context, info) =>
idFetcher(nodeId, context, info);
delete nodeField.args.id;
return {
node: nodeField,
...instanceQueries,
...listQueries,
...actions,
};
},
});
const mutationType = new GraphQLObjectType({
name: 'Mutation',
// root: 'The root mutation type',
fields: () => {
const mutations = generateMutations(graphRegistry);
const actions = generateActions(graphRegistry, ACTION_TYPE_MUTATION);
return {
...mutations,
...actions,
};
},
});
const subscriptionType = new GraphQLObjectType({
name: 'Subscription',
// root: 'The root subscription type',
fields: () => {
const subscriptions = generateSubscriptions(graphRegistry);
return subscriptions;
},
});
// put it all together into a graphQL schema
return new GraphQLSchema({
query: queryType,
mutation: mutationType,
subscription: subscriptionType,
});
};