@jahia/cypress 1.0.9 → 1.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/.graphqlconfig +16 -0
  2. package/dist/page-object/baseComponent.d.ts +2 -0
  3. package/dist/page-object/baseComponent.js +14 -0
  4. package/dist/page-object/moonstone/menu.js +5 -1
  5. package/dist/support/fixture.js +6 -2
  6. package/dist/support/provisioning/executeGroovy.d.ts +8 -2
  7. package/dist/support/provisioning/executeGroovy.js +8 -2
  8. package/dist/support/provisioning/runProvisioningScript.d.ts +7 -2
  9. package/dist/support/provisioning/runProvisioningScript.js +11 -5
  10. package/fixtures/graphql/jcr/addNode.graphql +16 -0
  11. package/fixtures/graphql/jcr/deleteNode.graphql +5 -0
  12. package/fixtures/graphql/jcr/mutateNode.graphql +13 -0
  13. package/fixtures/groovy/admin/createSite.groovy +14 -0
  14. package/fixtures/groovy/admin/deleteSite.groovy +6 -0
  15. package/package.json +2 -2
  16. package/schema.graphql +2874 -0
  17. package/src/page-object/baseComponent.ts +5 -0
  18. package/src/page-object/moonstone/menu.ts +5 -1
  19. package/src/support/fixture.ts +5 -2
  20. package/src/support/provisioning/executeGroovy.md +9 -0
  21. package/src/support/provisioning/executeGroovy.ts +15 -3
  22. package/src/support/provisioning/runProvisioningScript.md +9 -0
  23. package/src/support/provisioning/runProvisioningScript.ts +18 -6
  24. package/workflows/npm_publish.yml +18 -0
  25. package/.idea/jahia-cypress.iml +0 -9
  26. package/.idea/misc.xml +0 -6
  27. package/.idea/modules.xml +0 -8
  28. package/.idea/sonarlint/issuestore/8/9/8995cd54601f633e8bca96b4e0b06ae4272afe02 +0 -3
  29. package/.idea/sonarlint/issuestore/index.pb +0 -3
  30. package/.idea/vcs.xml +0 -6
  31. package/dist/page-object/iframe.d.ts +0 -10
  32. package/dist/page-object/iframe.js +0 -46
  33. package/dist/page-object/moonstone/muiinput.d.ts +0 -8
  34. package/dist/page-object/moonstone/muiinput.js +0 -36
  35. package/dist/page-object/moonstone/muiradio.d.ts +0 -5
  36. package/dist/page-object/moonstone/muiradio.js +0 -32
  37. package/dist/support/reloadUntil.d.ts +0 -15
  38. package/dist/support/reloadUntil.js +0 -50
  39. package/dist/support/waitUntil.d.ts +0 -15
  40. package/dist/support/waitUntil.js +0 -44
  41. package/fixtures/test.json +0 -0
  42. package/yalc.lock +0 -9
package/schema.graphql ADDED
@@ -0,0 +1,2874 @@
1
+ # This file was generated based on ".graphqlconfig". Do not edit manually.
2
+
3
+ schema {
4
+ query: Query
5
+ mutation: Mutation
6
+ subscription: Subscription
7
+ }
8
+
9
+ "GraphQL representation of a JCR item definition"
10
+ interface JCRItemDefinition {
11
+ "Reports whether the item is to be automatically created when its parent node is created."
12
+ autoCreated: Boolean!
13
+ "Gets the node type that contains the declaration of this definition."
14
+ declaringNodeType: JCRNodeType!
15
+ "Reports whether the child item is hidden from UI."
16
+ hidden: Boolean!
17
+ "Reports whether the item is mandatory. A mandatory item is one that, if its parent node exists, must also exist."
18
+ mandatory: Boolean!
19
+ "Gets the name of the child item."
20
+ name: String!
21
+ "Reports whether the child item is protected."
22
+ protected: Boolean!
23
+ }
24
+
25
+ "GraphQL representation of a JCR node"
26
+ interface JCRNode {
27
+ "Get the last modified date of this node and its descendants. The recursion in descendants can be controlled by recursionTypesFilter. If no filter is passed, recursion will stop by default on sub pages."
28
+ aggregatedLastModifiedDate(
29
+ "The language to use to get the last modified date, if not specified, returns last modification date in any language"
30
+ language: String,
31
+ "Stop recursion on nodes by their types; null to avoid such filtering"
32
+ recursionTypesFilter: InputNodeTypesInput
33
+ ): String
34
+ "Aggregated publication info about the JCR node"
35
+ aggregatedPublicationInfo(
36
+ "Publication language"
37
+ language: String!,
38
+ "Whether to take references into account when calculating the aggregated publication status"
39
+ references: Boolean = false,
40
+ "Whether to take sub-nodes into account when calculating the aggregated publication status"
41
+ subNodes: Boolean = false
42
+ ): GqlPublicationInfo!
43
+ "Render URL in ajax mode"
44
+ ajaxRenderUrl: String
45
+ "Returns a list of types allowed under the provided node"
46
+ allowedChildNodeTypes(
47
+ "Filter by GraphQL fields values"
48
+ fieldFilter: InputFieldFiltersInput,
49
+ "Whether all sub-types of allowed child node types should be included"
50
+ includeSubTypes: Boolean = true
51
+ ): [JCRNodeType]
52
+ "GraphQL representations of the ancestor nodes of the JCR node, top down direction"
53
+ ancestors(
54
+ "Filter by graphQL fields values"
55
+ fieldFilter: InputFieldFiltersInput,
56
+ "The path of the topmost ancestor node to include in the result; null or empty string to include all the ancestor nodes"
57
+ upToPath: String
58
+ ): [JCRNode]!
59
+ "GraphQL representations of the child nodes, according to parameters passed"
60
+ children(
61
+ "fetching only nodes after this node (exclusive)"
62
+ after: String,
63
+ "fetching only nodes before this node (exclusive)"
64
+ before: String,
65
+ "Filter by graphQL fields values"
66
+ fieldFilter: InputFieldFiltersInput,
67
+ "Group fields according to specified criteria"
68
+ fieldGrouping: InputFieldGroupingInput,
69
+ "Sort by graphQL fields values"
70
+ fieldSorter: InputFieldSorterInput,
71
+ "fetching only the first certain number of nodes"
72
+ first: Int,
73
+ "Include the current node itself in results"
74
+ includesSelf: Boolean = false,
75
+ "fetching only the last certain number of nodes"
76
+ last: Int,
77
+ "fetching only the first certain number of nodes"
78
+ limit: Int,
79
+ "Filter of child nodes by their names; null to avoid such filtering"
80
+ names: [String],
81
+ "fetching only nodes after this node (inclusive)"
82
+ offset: Int,
83
+ "Filter of child nodes by their property values; null to avoid such filtering"
84
+ propertiesFilter: InputNodePropertiesInput,
85
+ "Filter of child nodes by their types; null to avoid such filtering"
86
+ typesFilter: InputNodeTypesInput
87
+ ): JCRNodeConnection!
88
+ "Read default Work in progress information. Set by \"wip.checkbox.checked\" system proprety"
89
+ defaultWipInfo: wipInfo
90
+ "Returns the node definition that applies to this node."
91
+ definition: JCRNodeDefinition
92
+ "GraphQL representation of a descendant node, based on its relative path"
93
+ descendant(
94
+ "Name or relative path of the sub node"
95
+ relPath: String!
96
+ ): JCRNode
97
+ "GraphQL representations of the descendant nodes, according to parameters passed"
98
+ descendants(
99
+ "fetching only nodes after this node (exclusive)"
100
+ after: String,
101
+ "fetching only nodes before this node (exclusive)"
102
+ before: String,
103
+ "Filter by graphQL fields values"
104
+ fieldFilter: InputFieldFiltersInput,
105
+ "Group fields according to specified criteria"
106
+ fieldGrouping: InputFieldGroupingInput,
107
+ "Sort by graphQL fields values"
108
+ fieldSorter: InputFieldSorterInput,
109
+ "fetching only the first certain number of nodes"
110
+ first: Int,
111
+ "fetching only the last certain number of nodes"
112
+ last: Int,
113
+ "fetching only the first certain number of nodes"
114
+ limit: Int,
115
+ "fetching only nodes after this node (inclusive)"
116
+ offset: Int,
117
+ "Filter of descendant nodes by their property values; null to avoid such filtering"
118
+ propertiesFilter: InputNodePropertiesInput,
119
+ "Filter out and stop recursion on nodes by their property values; null to avoid such filtering"
120
+ recursionPropertiesFilter: InputNodePropertiesInput,
121
+ "Filter out and stop recursion on nodes by their types; null to avoid such filtering"
122
+ recursionTypesFilter: InputNodeTypesInput,
123
+ "Filter of descendant nodes by their types; null to avoid such filtering"
124
+ typesFilter: InputNodeTypesInput
125
+ ): JCRNodeConnection!
126
+ "The display name of the JCR node this object represents in the requested language"
127
+ displayName(
128
+ "The language to obtain the display name in"
129
+ language: String
130
+ ): String
131
+ "Returns the first parent of the current node that can be displayed in full page. If no matching node is found, null is returned."
132
+ displayableNode: JCRNode
133
+ "Returns the next available name for a node, appending if needed numbers."
134
+ findAvailableNodeName(language: String, nodeType: String): String
135
+ "Check if the current user has a specific permission"
136
+ hasPermission(
137
+ "The name of the permission"
138
+ permissionName: String!
139
+ ): Boolean
140
+ "Check if the node as a renderable template associated with it (not a view a template)."
141
+ isDisplayableNode: Boolean
142
+ "Reports if the current node matches the nodetype(s) passed in parameter"
143
+ isNodeType(
144
+ "Node type name"
145
+ type: InputNodeTypesInput!
146
+ ): Boolean!
147
+ "Check if the given locales need translation, by comparing last modifications dates with already existing translations"
148
+ languagesToTranslate(
149
+ "List of languages potentially to be translated"
150
+ languagesToCheck: [String],
151
+ "List of known translated languages, will be used to compare modifications dates"
152
+ languagesTranslated: [String]
153
+ ): [String]
154
+ "Retrieve lock info of the current node"
155
+ lockInfo: LockInfo
156
+ "Returns edit lock status of the current node object"
157
+ lockedAndCannotBeEdited: Boolean
158
+ "Returns an array of <code>NodeType</code> objects representing the mixin node types in effect for this node."
159
+ mixinTypes(
160
+ "Filter by GraphQL fields values"
161
+ fieldFilter: InputFieldFiltersInput
162
+ ): [JCRNodeType]!
163
+ "The name of the JCR node this object represents"
164
+ name: String!
165
+ "GraphQL representation of this node in certain workspace"
166
+ nodeInWorkspace(
167
+ "The target workspace"
168
+ workspace: Workspace!
169
+ ): JCRNode
170
+ "Get information on the operations that can be done on this node"
171
+ operationsSupport: GqlOperationsSupport
172
+ "GraphQL representation of the parent JCR node"
173
+ parent: JCRNode
174
+ "The path of the JCR node this object represents"
175
+ path: String!
176
+ "Get the primary node type of this node"
177
+ primaryNodeType: JCRNodeType!
178
+ "GraphQL representations of the properties in the requested language"
179
+ properties(
180
+ "Filter by graphQL fields values"
181
+ fieldFilter: InputFieldFiltersInput,
182
+ "The language to obtain the properties in; must be a valid language code in case any internationalized properties are requested, does not matter for non-internationalized ones"
183
+ language: String,
184
+ "The names of the JCR properties; null to obtain all properties"
185
+ names: [String]
186
+ ): [JCRProperty]!
187
+ "The GraphQL representation of the property in the requested language; null if the property does not exist"
188
+ property(
189
+ "The language to obtain the property in; must be a valid language code for internationalized properties, does not matter for non-internationalized ones"
190
+ language: String,
191
+ "The name of the JCR property"
192
+ name: String!
193
+ ): JCRProperty
194
+ "GraphQL representations of the reference properties that target the current JCR Node"
195
+ references(
196
+ "fetching only nodes after this node (exclusive)"
197
+ after: String,
198
+ "fetching only nodes before this node (exclusive)"
199
+ before: String,
200
+ "Filter by graphQL fields values"
201
+ fieldFilter: InputFieldFiltersInput,
202
+ "fetching only the first certain number of nodes"
203
+ first: Int,
204
+ "fetching only the last certain number of nodes"
205
+ last: Int,
206
+ "fetching only the first certain number of nodes"
207
+ limit: Int,
208
+ "fetching only nodes after this node (inclusive)"
209
+ offset: Int
210
+ ): JCRPropertyConnection!
211
+ "Gets the fully rendered content for this node"
212
+ renderedContent(
213
+ "Rendering context configuration"
214
+ contextConfiguration: String,
215
+ "Language"
216
+ language: String,
217
+ "Additional request attributes"
218
+ requestAttributes: [InputRenderRequestAttributeInput],
219
+ "Template type"
220
+ templateType: String,
221
+ "Name of the view"
222
+ view: String
223
+ ): RenderedNode
224
+ "GraphQL representation of the site the JCR node belongs to, or the system site in case the node does not belong to any site"
225
+ site: JCRSite
226
+ "The UUID of the JCR node this object represents"
227
+ uuid: String!
228
+ "Get vanity URLs from the current node filtered by the parameters"
229
+ vanityUrls(
230
+ "Filter results based on graphql field values"
231
+ fieldFilter: InputFieldFiltersInput,
232
+ "Languages"
233
+ languages: [String]
234
+ ): [VanityUrl]
235
+ "Read work in progress information for a given node"
236
+ wipInfo: wipInfo
237
+ "Get the workspace of the query"
238
+ workspace: Workspace!
239
+ }
240
+
241
+ "GraphQL representation of a principal"
242
+ interface Principal {
243
+ "Full display name"
244
+ displayName: String
245
+ "Is this principal member of the specified group"
246
+ memberOf(
247
+ "Target group"
248
+ group: String,
249
+ "Site where the group is defined"
250
+ site: String
251
+ ): Boolean
252
+ "Name"
253
+ name: String!
254
+ "Get the corresponding JCR node"
255
+ node: JCRNode
256
+ "Site where the principal is defined"
257
+ site: JCRSite
258
+ }
259
+
260
+ "Admin queries root"
261
+ type AdminQuery {
262
+ "Current datetime"
263
+ datetime: String
264
+ "Personal API tokens queries"
265
+ personalApiTokens: PersonalApiTokensQuery
266
+ "Version of the running Jahia instance"
267
+ version: String! @deprecated(reason : "Deprecated")
268
+ }
269
+
270
+ "Asset type for files"
271
+ type Asset {
272
+ "Asset metadata"
273
+ metadata: Metadata
274
+ path: String
275
+ "Asset size"
276
+ size: Long
277
+ "Mime type of the asset"
278
+ type: String
279
+ url: String
280
+ uuid: String
281
+ }
282
+
283
+ "Category type"
284
+ type Category {
285
+ "Description"
286
+ description: String
287
+ "Asset metadata"
288
+ metadata: Metadata
289
+ path: String
290
+ "Title"
291
+ title: String
292
+ uuid: String
293
+ }
294
+
295
+ "Simple node count aggregation"
296
+ type CountAggregation {
297
+ "Count all values"
298
+ values(
299
+ "The language to obtain the property in; must be a valid language code for internationalized properties, does not matter for non-internationalized ones"
300
+ language: String,
301
+ "The name of the JCR property"
302
+ name: String!
303
+ ): Int
304
+ }
305
+
306
+ type EditorForm {
307
+ "Retrieve a description text for the form, might contain explanations on how to use the form"
308
+ description: String
309
+ "Retrieve the displayable name of the form (in a specific language)"
310
+ displayName: String
311
+ "Returns the preview status of the form. If true, the form can display a preview."
312
+ hasPreview: Boolean
313
+ "Retrieve the name (aka identifier) of the form"
314
+ name: String
315
+ "Retrieve the sections that make up the form"
316
+ sections: [EditorFormSection]
317
+ }
318
+
319
+ type EditorFormField {
320
+ "This value contains the current existing values for the field."
321
+ currentValues: [EditorFormFieldValue]
322
+ "This value contains the default values for the field."
323
+ defaultValues: [EditorFormFieldValue]
324
+ "The description of the field"
325
+ description: String
326
+ "The displayable name of the field"
327
+ displayName: String
328
+ "The error message of the field"
329
+ errorMessage: String
330
+ "This value is true if the field allows for internationalized values"
331
+ i18n: Boolean
332
+ "This value is true if the field is mandatory"
333
+ mandatory: Boolean
334
+ "This value is true if the field value is multi-valued."
335
+ multiple: Boolean
336
+ "The name of the field"
337
+ name: String
338
+ "This value is true if the field is readonly. This could be due to locks or permissions"
339
+ readOnly: Boolean
340
+ "The required type for the field"
341
+ requiredType: JCRPropertyType
342
+ "Options for the selector type. For JCR definitions, this will usually include choicelist initializer name and properties."
343
+ selectorOptions: [EditorFormProperty]
344
+ "The selector type for the field. In the case of fields generated from node types, this is actually the SelectorType."
345
+ selectorType: String
346
+ "This array contains the list of possible values to choose from"
347
+ valueConstraints: [EditorFormFieldValueConstraint]
348
+ }
349
+
350
+ type EditorFormFieldSet {
351
+ "Only used in the case of a dynamic field set. Set to true if it is activated"
352
+ activated: Boolean
353
+ "Get the internationalized description of the field set"
354
+ description: String
355
+ "Get the internationalized displayable name of the field set"
356
+ displayName: String
357
+ "Defines if the field has to be displayed or not"
358
+ displayed: Boolean
359
+ "True if this is dynamic field set (meaningin it can be activated or not)"
360
+ dynamic: Boolean
361
+ "Get the fields contained in the target"
362
+ fields: [EditorFormField]
363
+ "Get the name of the field set"
364
+ name: String
365
+ "This value is true if the fieldset is readonly. This could be due to locks or permissions"
366
+ readOnly: Boolean
367
+ }
368
+
369
+ type EditorFormFieldValue {
370
+ "This value's string representation"
371
+ string: String
372
+ "The type of this value"
373
+ type: String
374
+ }
375
+
376
+ type EditorFormFieldValueConstraint {
377
+ "The value as it is intended to be displayed in UIs"
378
+ displayValue: String
379
+ "The properties for the value"
380
+ properties: [EditorFormProperty]
381
+ "The actual value to be used in storage"
382
+ value: EditorFormFieldValue
383
+ }
384
+
385
+ type EditorFormProperty {
386
+ "Property name"
387
+ name: String
388
+ "Property value"
389
+ value: String
390
+ }
391
+
392
+ type EditorFormSection {
393
+ "Returns the description of the section"
394
+ description: String
395
+ "Retrieve the displayable name of the section"
396
+ displayName: String
397
+ "Returns the field sets contained in this section"
398
+ fieldSets: [EditorFormFieldSet]
399
+ "Check if this section should be hide"
400
+ hide: Boolean
401
+ "Retrieve the name (aka identifier) of the section"
402
+ name: String
403
+ }
404
+
405
+ "GraphQL representation of a generic JCR node"
406
+ type GenericJCRNode implements JCRNode {
407
+ "Get the last modified date of this node and its descendants. The recursion in descendants can be controlled by recursionTypesFilter. If no filter is passed, recursion will stop by default on sub pages."
408
+ aggregatedLastModifiedDate(
409
+ "The language"
410
+ language: String,
411
+ "Stop recursion on graphql field values"
412
+ recursionTypesFilter: InputNodeTypesInput
413
+ ): String
414
+ "Aggregated publication info about the JCR node"
415
+ aggregatedPublicationInfo(
416
+ "Publication language"
417
+ language: String!,
418
+ "Whether to take references into account when calculating the aggregated publication status"
419
+ references: Boolean = false,
420
+ "Whether to take sub-nodes into account when calculating the aggregated publication status"
421
+ subNodes: Boolean = false
422
+ ): GqlPublicationInfo!
423
+ "Render URL in ajax mode"
424
+ ajaxRenderUrl: String
425
+ "Returns a list of types allowed under the provided node"
426
+ allowedChildNodeTypes(
427
+ "Filter by GraphQL fields values"
428
+ fieldFilter: InputFieldFiltersInput,
429
+ "Whether all sub-types of allowed child node types should be included"
430
+ includeSubTypes: Boolean = true
431
+ ): [JCRNodeType]
432
+ "GraphQL representations of the ancestor nodes of the JCR node, top down direction"
433
+ ancestors(
434
+ "Filter by graphQL fields values"
435
+ fieldFilter: InputFieldFiltersInput,
436
+ "The path of the topmost ancestor node to include in the result; null or empty string to include all the ancestor nodes"
437
+ upToPath: String
438
+ ): [JCRNode]!
439
+ "GraphQL representations of the child nodes, according to parameters passed"
440
+ children(
441
+ "fetching only nodes after this node (exclusive)"
442
+ after: String,
443
+ "fetching only nodes before this node (exclusive)"
444
+ before: String,
445
+ "Filter by graphQL fields values"
446
+ fieldFilter: InputFieldFiltersInput,
447
+ "Group fields according to specified criteria"
448
+ fieldGrouping: InputFieldGroupingInput,
449
+ "Sort by graphQL fields values"
450
+ fieldSorter: InputFieldSorterInput,
451
+ "fetching only the first certain number of nodes"
452
+ first: Int,
453
+ "Include the current node itself in results"
454
+ includesSelf: Boolean = false,
455
+ "fetching only the last certain number of nodes"
456
+ last: Int,
457
+ "fetching only the first certain number of nodes"
458
+ limit: Int,
459
+ "Filter of child nodes by their names; null to avoid such filtering"
460
+ names: [String],
461
+ "fetching only nodes after this node (inclusive)"
462
+ offset: Int,
463
+ "Filter of child nodes by their property values; null to avoid such filtering"
464
+ propertiesFilter: InputNodePropertiesInput,
465
+ "Filter of child nodes by their types; null to avoid such filtering"
466
+ typesFilter: InputNodeTypesInput
467
+ ): JCRNodeConnection!
468
+ "Read default Work in progress information. Set by \"wip.checkbox.checked\" system proprety"
469
+ defaultWipInfo: wipInfo
470
+ "Returns the node definition that applies to this node."
471
+ definition: JCRNodeDefinition
472
+ "GraphQL representation of a descendant node, based on its relative path"
473
+ descendant(
474
+ "Name or relative path of the sub node"
475
+ relPath: String!
476
+ ): JCRNode
477
+ "GraphQL representations of the descendant nodes, according to parameters passed"
478
+ descendants(
479
+ "fetching only nodes after this node (exclusive)"
480
+ after: String,
481
+ "fetching only nodes before this node (exclusive)"
482
+ before: String,
483
+ "Filter by graphQL fields values"
484
+ fieldFilter: InputFieldFiltersInput,
485
+ "Group fields according to specified criteria"
486
+ fieldGrouping: InputFieldGroupingInput,
487
+ "Sort by graphQL fields values"
488
+ fieldSorter: InputFieldSorterInput,
489
+ "fetching only the first certain number of nodes"
490
+ first: Int,
491
+ "fetching only the last certain number of nodes"
492
+ last: Int,
493
+ "fetching only the first certain number of nodes"
494
+ limit: Int,
495
+ "fetching only nodes after this node (inclusive)"
496
+ offset: Int,
497
+ "Filter of descendant nodes by their property values; null to avoid such filtering"
498
+ propertiesFilter: InputNodePropertiesInput,
499
+ "Filter out and stop recursion on nodes by their property values; null to avoid such filtering"
500
+ recursionPropertiesFilter: InputNodePropertiesInput,
501
+ "Filter out and stop recursion on nodes by their types; null to avoid such filtering"
502
+ recursionTypesFilter: InputNodeTypesInput,
503
+ "Filter of descendant nodes by their types; null to avoid such filtering"
504
+ typesFilter: InputNodeTypesInput
505
+ ): JCRNodeConnection!
506
+ "GraphQL representation of the parent JCR node"
507
+ displayName(
508
+ "Language"
509
+ language: String
510
+ ): String
511
+ "Returns the first parent of the current node that can be displayed in full page. If no matching node is found, null is returned."
512
+ displayableNode: JCRNode
513
+ "Returns the next available name for a node, appending if needed numbers."
514
+ findAvailableNodeName(language: String, nodeType: String): String
515
+ "Check if the current user has a specific permission"
516
+ hasPermission(
517
+ "The name of the permission"
518
+ permissionName: String!
519
+ ): Boolean
520
+ "Check if the node as a renderable template associated with it (not a view a template)."
521
+ isDisplayableNode: Boolean
522
+ "Reports if the current node matches the nodetype(s) passed in parameter"
523
+ isNodeType(
524
+ "Node type name"
525
+ type: InputNodeTypesInput!
526
+ ): Boolean!
527
+ "Check if the given locales need translation, by comparing last modifications dates with already existing translations"
528
+ languagesToTranslate(
529
+ "The languages to check"
530
+ languagesToCheck: [String],
531
+ "The translated languages"
532
+ languagesTranslated: [String]
533
+ ): [String]
534
+ "Retrieve lock info of the current node"
535
+ lockInfo: LockInfo
536
+ "Returns edit lock status of the current node object"
537
+ lockedAndCannotBeEdited: Boolean
538
+ "Returns an array of <code>NodeType</code> objects representing the mixin node types in effect for this node."
539
+ mixinTypes(
540
+ "Filter by GraphQL fields values"
541
+ fieldFilter: InputFieldFiltersInput
542
+ ): [JCRNodeType]!
543
+ "The name of the JCR node this object represents"
544
+ name: String!
545
+ "GraphQL representation of this node in certain workspace"
546
+ nodeInWorkspace(
547
+ "The target workspace"
548
+ workspace: Workspace!
549
+ ): JCRNode
550
+ "Get information on the operations that can be done on this node"
551
+ operationsSupport: GqlOperationsSupport
552
+ "GraphQL representation of the parent JCR node"
553
+ parent: JCRNode
554
+ "The path of the JCR node this object represents"
555
+ path: String!
556
+ "Get the primary node type of this node"
557
+ primaryNodeType: JCRNodeType!
558
+ "GraphQL representations of the properties in the requested language"
559
+ properties(
560
+ "Filter by graphQL fields values"
561
+ fieldFilter: InputFieldFiltersInput,
562
+ "The language to obtain the properties in; must be a valid language code in case any internationalized properties are requested, does not matter for non-internationalized ones"
563
+ language: String,
564
+ "The names of the JCR properties; null to obtain all properties"
565
+ names: [String]
566
+ ): [JCRProperty]!
567
+ "The GraphQL representation of the property in the requested language; null if the property does not exist"
568
+ property(
569
+ "The language to obtain the property in; must be a valid language code for internationalized properties, does not matter for non-internationalized ones"
570
+ language: String,
571
+ "The name of the JCR property"
572
+ name: String!
573
+ ): JCRProperty
574
+ "GraphQL representations of the reference properties that target the current JCR Node"
575
+ references(
576
+ "fetching only nodes after this node (exclusive)"
577
+ after: String,
578
+ "fetching only nodes before this node (exclusive)"
579
+ before: String,
580
+ "Filter by graphQL fields values"
581
+ fieldFilter: InputFieldFiltersInput,
582
+ "fetching only the first certain number of nodes"
583
+ first: Int,
584
+ "fetching only the last certain number of nodes"
585
+ last: Int,
586
+ "fetching only the first certain number of nodes"
587
+ limit: Int,
588
+ "fetching only nodes after this node (inclusive)"
589
+ offset: Int
590
+ ): JCRPropertyConnection!
591
+ "Gets the fully rendered content for this node"
592
+ renderedContent(
593
+ "Rendering context configuration"
594
+ contextConfiguration: String,
595
+ "Language"
596
+ language: String,
597
+ "Additional request attributes"
598
+ requestAttributes: [InputRenderRequestAttributeInput],
599
+ "Template type"
600
+ templateType: String,
601
+ "Name of the view"
602
+ view: String
603
+ ): RenderedNode
604
+ "GraphQL representation of the site the JCR node belongs to, or the system site in case the node does not belong to any site"
605
+ site: JCRSite
606
+ "The UUID of the JCR node this object represents"
607
+ uuid: String!
608
+ "Get vanity URLs from the current node filtered by the parameters"
609
+ vanityUrls(
610
+ "Filter results based on graphql field values"
611
+ fieldFilter: InputFieldFiltersInput,
612
+ "Languages"
613
+ languages: [String]
614
+ ): [VanityUrl]
615
+ "Read work in progress information for a given node"
616
+ wipInfo: wipInfo
617
+ "Get the workspace of the query"
618
+ workspace: Workspace!
619
+ }
620
+
621
+ type GqlBackgroundJob {
622
+ "The amount of time the job ran for (in milliseconds). The returned value will be -1 until the job has actually completed"
623
+ duration: Long
624
+ "The job group name"
625
+ group: String
626
+ "The job (Boolean) property that correspond to the given name. The returned value will be null in case the job doesn't have the property"
627
+ jobBooleanProperty(name: String): Boolean
628
+ "The job (Int) property that correspond to the given name. The returned value will be null in case the job doesn't have the property"
629
+ jobIntegerProperty(name: String): Int
630
+ "The job (Long) property that correspond to the given name. The returned value will be null in case the job doesn't have the property"
631
+ jobLongProperty(name: String): Long
632
+ "The job state is different from the status, it reflect the last action done on the job instance (Started, Vetoed, Finished)"
633
+ jobState: GqlBackgroundJobState
634
+ "The job status"
635
+ jobStatus: GqlBackgroundJobStatus
636
+ "The job (String) property that correspond to the given name. The returned value will be null in case the job doesn't have the property"
637
+ jobStringProperty(name: String): String
638
+ "The job name"
639
+ name: String
640
+ "The site key. The returned value will be null in case the job doesn't have associated site key"
641
+ siteKey: String
642
+ "The user key. The returned value will be null in case the job doesn't have associated user key"
643
+ userKey: String
644
+ }
645
+
646
+ type GqlDashboard {
647
+ "Retrieves the list of modules currently available on the platform"
648
+ modules: [GqlModule]
649
+ "Whether the tools are accessible on the installation"
650
+ toolsAccess: Boolean
651
+ }
652
+
653
+ type GqlEditorFormMutations {
654
+ "Unlock the given node for edition, if the node is locked."
655
+ unlockEditor(
656
+ "An ID generated client side used to identify the lock"
657
+ editorID: String!
658
+ ): Boolean
659
+ }
660
+
661
+ type GqlEditorForms {
662
+ "Retrieve the custom configuration path for CKEditor"
663
+ ckeditorConfigPath(
664
+ "node path"
665
+ nodePath: String
666
+ ): String
667
+ "Retrieve the toolbar type for CKEditor"
668
+ ckeditorToolbar(
669
+ "node path"
670
+ nodePath: String
671
+ ): String
672
+ "Get a list of allowed child nodeTypes for a given nodeType and path. (Note that it returns nothing for type [jnt:page]. [jnt:contentFolder] is filterered by [jmix:editorialContent])"
673
+ contentTypesAsTree(
674
+ "the child node name, used to check the type allowed for this named child node, do not specify if you want to check for unnamed children"
675
+ childNodeName: String,
676
+ "List of types we want to exclude, null for all"
677
+ excludedNodeTypes: [String],
678
+ "if true, retrieves all the sub types of the given node types, if false, returns the type only. Default value is true"
679
+ includeSubTypes: Boolean = true,
680
+ "thPath of an existing node under with the new content will be created."
681
+ nodePath: String!,
682
+ "List of types we want to retrieve, null for all"
683
+ nodeTypes: [String],
684
+ "A string representation of a locale, in IETF BCP 47 language tag format, ie en_US, en, fr, fr_CH, ..."
685
+ uiLocale: String!,
686
+ "if true, check the contribute property of the node. Default value is true"
687
+ useContribute: Boolean = true
688
+ ): [NodeTypeTreeEntry]
689
+ "Get a editor form to create a new content from its nodetype and parent"
690
+ createForm(
691
+ "A string representation of a locale, in IETF BCP 47 language tag format, ie en_US, en, fr, fr_CH, ..."
692
+ locale: String!,
693
+ "The primary node type name identifying the form we want to retrieve"
694
+ primaryNodeType: String!,
695
+ "A string representation of a locale, in IETF BCP 47 language tag format, ie en_US, en, fr, fr_CH, ..."
696
+ uiLocale: String!,
697
+ "uuid or path of an existing node under with the new content will be created."
698
+ uuidOrPath: String!
699
+ ): EditorForm
700
+ "Get a editor form from a locale and an existing node"
701
+ editForm(
702
+ "A string representation of a locale, in IETF BCP 47 language tag format, ie en_US, en, fr, fr_CH, ..."
703
+ locale: String!,
704
+ "A string representation of a locale, in IETF BCP 47 language tag format, ie en_US, en, fr, fr_CH, ..."
705
+ uiLocale: String!,
706
+ "UUID or path of an existing node under with the new content will be created."
707
+ uuidOrPath: String!
708
+ ): EditorForm
709
+ "Get field constraints"
710
+ fieldConstraints(
711
+ "Object contains additional information of the node"
712
+ context: [InputContextEntryInput],
713
+ "A string representation of field name"
714
+ fieldName: String!,
715
+ "A string representation of the field node type (the node type that contains the field, can be the node type of the node, a mixin or a super type)"
716
+ fieldNodeType: String!,
717
+ "A string representation of a locale, in IETF BCP 47 language tag format, ie en_US, en, fr, fr_CH, ..."
718
+ locale: String!,
719
+ "UUID or path of the node (optional in case you are creating it, and it doesnt exist yet)"
720
+ nodeUuidOrPath: String,
721
+ "UUID or path of the parent node"
722
+ parentNodeUuidOrPath: String!,
723
+ "A string representation of the primary node type of the node"
724
+ primaryNodeType: String!,
725
+ "A string representation of a locale, in IETF BCP 47 language tag format, ie en_US, en, fr, fr_CH, ..."
726
+ uiLocale: String!
727
+ ): [EditorFormFieldValueConstraint]
728
+ "Retrieve the number of sub contents under the node for given types"
729
+ subContentsCount(
730
+ "List of node types to check for"
731
+ includeTypes: [String],
732
+ "Limit of sub contents count"
733
+ limit: Int,
734
+ "node path"
735
+ nodePath: String
736
+ ): Int
737
+ }
738
+
739
+ type GqlEditorLockHeartBeat {
740
+ "The empty heartbeat signal"
741
+ heartbeat: String
742
+ }
743
+
744
+ type GqlJcrImageTransformMutation {
745
+ "Crop an image under the current node"
746
+ cropImage(
747
+ "new height"
748
+ height: Int!,
749
+ "left"
750
+ left: Int!,
751
+ "top"
752
+ top: Int!,
753
+ "new width"
754
+ width: Int!
755
+ ): Boolean
756
+ "The transformed node"
757
+ node: JCRNode
758
+ "Resize an image under the current node"
759
+ resizeImage(
760
+ "new height"
761
+ height: Int!,
762
+ "new width"
763
+ width: Int!
764
+ ): Boolean
765
+ "Rotate an image under the current node"
766
+ rotateImage(
767
+ "angle in degrees"
768
+ angle: Float!
769
+ ): Boolean
770
+ }
771
+
772
+ "Details on a lock"
773
+ type GqlLockDetail {
774
+ "Language"
775
+ language: String
776
+ "Lock owner"
777
+ owner: String
778
+ "Lock type"
779
+ type: String
780
+ }
781
+
782
+ type GqlModule {
783
+ "User facing description for the module"
784
+ description: String
785
+ "Unique identifier for the module"
786
+ id: String
787
+ "If the module is in development, mostly because the sources have been downloaded."
788
+ inDevelopment: Boolean
789
+ "Bundle last modification date"
790
+ lastModified: Long
791
+ "User facing name for the module"
792
+ name: String
793
+ "Version number for the module"
794
+ version: String
795
+ }
796
+
797
+ "Possible operations on a node"
798
+ type GqlOperationsSupport {
799
+ "Can node be locked"
800
+ lock: Boolean
801
+ "Can node be marked for deletion"
802
+ markForDeletion: Boolean
803
+ "does the node supports publication"
804
+ publication: Boolean!
805
+ }
806
+
807
+ "Publication status information for a JCR node"
808
+ type GqlPublicationInfo {
809
+ "Whether current user is allowed to publish the node omitting any workflows"
810
+ allowedToPublishWithoutWorkflow: Boolean
811
+ "Whether node exists in live workspace"
812
+ existsInLive: Boolean
813
+ "Aggregated locked status of the node"
814
+ locked: Boolean
815
+ "Aggregated publication status of the node"
816
+ publicationStatus: PublicationStatus!
817
+ "Aggregated work-in-progress status of the node"
818
+ workInProgress: Boolean
819
+ }
820
+
821
+ type GqlScope {
822
+ "The description of the scope"
823
+ description: String
824
+ "The name of the scope"
825
+ name: String
826
+ }
827
+
828
+ "Asset type for image"
829
+ type ImageAsset {
830
+ "Image height"
831
+ height: Long
832
+ "Asset metadata"
833
+ metadata: Metadata
834
+ path: String
835
+ "Image size"
836
+ size: Long
837
+ "Mime type of image"
838
+ type: String
839
+ url: String
840
+ uuid: String
841
+ "Image width"
842
+ width: Long
843
+ }
844
+
845
+ "JCR Mutations"
846
+ type JCRMutation {
847
+ "Creates a new JCR node under the specified parent"
848
+ addNode(
849
+ children: [InputJCRNode],
850
+ "The collection of mixin type names"
851
+ mixins: [String],
852
+ "The name of the node to create"
853
+ name: String!,
854
+ "The path or id of the parent node"
855
+ parentPathOrId: String!,
856
+ "The primary node type of the node to create"
857
+ primaryNodeType: String!,
858
+ properties: [InputJCRProperty],
859
+ "If true, use the next available name for a node, appending if needed numbers. Default is false"
860
+ useAvailableNodeName: Boolean
861
+ ): JCRNodeMutation
862
+ "Batch creates a number of new JCR nodes under the specified parent"
863
+ addNodesBatch(
864
+ "The collection of nodes to create"
865
+ nodes: [InputJCRNodeWithParent]!
866
+ ): [JCRNodeMutation]
867
+ "Copy a single node to a different parent node"
868
+ copyNode(
869
+ "The name of the node at the new location or null if its current name should be preserved"
870
+ destName: String,
871
+ "Path or UUID of the destination parent node to copy the node to"
872
+ destParentPathOrId: String!,
873
+ "Path or UUID of the node to be copied"
874
+ pathOrId: String!
875
+ ): JCRNodeMutation
876
+ "Copy multiple nodes to different parent node(s)"
877
+ copyNodes(nodes: [InputCarriedJCRNode!]!): [JCRNodeMutation]
878
+ "Delete an existing node and all its children"
879
+ deleteNode(
880
+ "The path or id of the node to delete"
881
+ pathOrId: String!
882
+ ): Boolean
883
+ "Import a file under the specified parent"
884
+ importContent(
885
+ "Name of the request part that contains desired import file body"
886
+ file: String!,
887
+ "The path or id of the parent node"
888
+ parentPathOrId: String!
889
+ ): Boolean
890
+ "Marks the existing node and all its children for deletion"
891
+ markNodeForDeletion(
892
+ "Optional deletion comment"
893
+ comment: String,
894
+ "The path or id of the node to mark for deletion"
895
+ pathOrId: String!
896
+ ): Boolean
897
+ "Get a collection of nodes that were modified by current GraphQL request"
898
+ modifiedNodes: [JCRNode]
899
+ "Move a single node to a different parent node"
900
+ moveNode(
901
+ "The name of the node at the new location or null if its current name should be preserved"
902
+ destName: String,
903
+ "Path or UUID of the destination parent node to move the node to"
904
+ destParentPathOrId: String!,
905
+ "Path or UUID of the node to be moved"
906
+ pathOrId: String!
907
+ ): JCRNodeMutation
908
+ "Move multiple nodes to different parent node(s)"
909
+ moveNodes(nodes: [InputCarriedJCRNode!]!): [JCRNodeMutation]
910
+ "Mutates an existing node, based on path or id"
911
+ mutateNode(
912
+ "The path or id of the node to mutate"
913
+ pathOrId: String!
914
+ ): JCRNodeMutation
915
+ "Mutates a set of existing nodes, based on path or id"
916
+ mutateNodes(
917
+ "The paths or id ofs the nodes to mutate"
918
+ pathsOrIds: [String]!
919
+ ): [JCRNodeMutation]
920
+ "Mutates a set of existing nodes, based on query execution"
921
+ mutateNodesByQuery(
922
+ "The maximum size of the result set"
923
+ limit: Long,
924
+ "The start offset of the result set"
925
+ offset: Long,
926
+ "The query string"
927
+ query: String!,
928
+ "The query language"
929
+ queryLanguage: QueryLanguage = SQL2
930
+ ): [JCRNodeMutation]
931
+ "Vanity URL Mutation"
932
+ mutateVanityUrls(
933
+ "Paths or UUIDs of vanity URL nodes to mutate"
934
+ pathsOrIds: [String]!
935
+ ): [VanityUrlMappingMutation]
936
+ "Paste a single node to a different parent node"
937
+ pasteNode(
938
+ "The name of the node at the new location or null if its current name should be preserved"
939
+ destName: String,
940
+ "Path or UUID of the destination parent node to paste the node to"
941
+ destParentPathOrId: String!,
942
+ "Paste mode, either COPY or MOVE"
943
+ mode: PasteMode!,
944
+ "The way to deal with duplicate node names when they are not allowed, either FAIL or RENAME"
945
+ namingConflictResolution: NodeNamingConflictResolutionStrategy = FAIL,
946
+ "Path or UUID of the node to be pasted"
947
+ pathOrId: String!
948
+ ): JCRNodeMutation
949
+ "Paste multiple nodes to different parent node(s)"
950
+ pasteNodes(
951
+ "Paste mode, either COPY or MOVE"
952
+ mode: PasteMode!,
953
+ "The way to deal with duplicate node names when they are not allowed, either FAIL or RENAME"
954
+ namingConflictResolution: NodeNamingConflictResolutionStrategy = FAIL,
955
+ "Info about nodes to paste and their new parent node(s)"
956
+ nodes: [InputCarriedJCRNode!]!
957
+ ): [JCRNodeMutation]
958
+ "Unmarks the specified node and all its children for deletion"
959
+ unmarkNodeForDeletion(
960
+ "The path or id of the node to unmark for deletion"
961
+ pathOrId: String!
962
+ ): Boolean
963
+ }
964
+
965
+ "Aggregations on JCR Nodes"
966
+ type JCRNodeAggregation {
967
+ "Average aggregation"
968
+ avg: StatAggregation
969
+ "Count aggregation"
970
+ count: CountAggregation
971
+ "Max aggregation"
972
+ max: StatAggregation
973
+ "Min aggregation"
974
+ min: StatAggregation
975
+ "Sum aggregation"
976
+ sum: StatAggregation
977
+ }
978
+
979
+ "A connection to a list of items."
980
+ type JCRNodeConnection {
981
+ "Get an aggregation by fields on nodes of this connection"
982
+ aggregation: JCRNodeAggregation
983
+ "a list of edges"
984
+ edges: [JCRNodeEdge]
985
+ "a list of nodes"
986
+ nodes: [JCRNode]
987
+ "details about this specific page"
988
+ pageInfo: PageInfo!
989
+ }
990
+
991
+ "GraphQL representation of a JCR node definition"
992
+ type JCRNodeDefinition implements JCRItemDefinition {
993
+ "Reports whether this child node can have same-name siblings. In other words, whether the parent node can have more than one child node of this name."
994
+ allowsSameNameSiblings: Boolean!
995
+ "Reports whether the item is to be automatically created when its parent node is created."
996
+ autoCreated: Boolean!
997
+ "Gets the node type that contains the declaration of this definition."
998
+ declaringNodeType: JCRNodeType!
999
+ "Gets the default primary node type that will be assigned to the child node if it is created without an explicitly specified primary node type."
1000
+ defaultPrimaryType: JCRNodeType
1001
+ "Reports whether the child item is hidden from UI."
1002
+ hidden: Boolean!
1003
+ "Reports whether the item is mandatory. A mandatory item is one that, if its parent node exists, must also exist."
1004
+ mandatory: Boolean!
1005
+ "Gets the name of the child item."
1006
+ name: String!
1007
+ "Reports whether the child item is protected."
1008
+ protected: Boolean!
1009
+ "Gets the minimum set of primary node types that the child node must have."
1010
+ requiredPrimaryType: [JCRNodeType]
1011
+ }
1012
+
1013
+ "An edge in a connection"
1014
+ type JCRNodeEdge {
1015
+ "cursor marks a unique position or index into the connection"
1016
+ cursor: String!
1017
+ "index in the connection"
1018
+ index: Int
1019
+ "The item at the end of the edge"
1020
+ node: JCRNode
1021
+ }
1022
+
1023
+ "Mutations on a JCR node"
1024
+ type JCRNodeMutation {
1025
+ "Creates a new JCR node under the current node"
1026
+ addChild(
1027
+ children: [InputJCRNode],
1028
+ "The collection of mixin type names"
1029
+ mixins: [String],
1030
+ "The name of the node to create"
1031
+ name: String!,
1032
+ "The primary node type of the node to create"
1033
+ primaryNodeType: String!,
1034
+ properties: [InputJCRProperty],
1035
+ "If true, use the next available name for a node, appending if needed numbers. Default is false"
1036
+ useAvailableNodeName: Boolean
1037
+ ): JCRNodeMutation
1038
+ "Batch creates a number of new JCR nodes under the current node"
1039
+ addChildrenBatch(
1040
+ "The collection of nodes to create"
1041
+ nodes: [InputJCRNode]!
1042
+ ): [JCRNodeMutation]
1043
+ "Adds mixin types on the current node"
1044
+ addMixins(
1045
+ "The collection of mixin type names"
1046
+ mixins: [String]!
1047
+ ): [String]
1048
+ "Add vanity URL"
1049
+ addVanityUrl(
1050
+ "The list of vanity url to create"
1051
+ vanityUrlInputList: [InputVanityUrl]!
1052
+ ): [VanityUrlMappingMutation]
1053
+ "Unlock all nodes under the specified node"
1054
+ clearAllLocks: Boolean
1055
+ "Add wip information"
1056
+ createWipInfo(
1057
+ "Work in progress information to save"
1058
+ wipInfo: InputwipInfo!
1059
+ ): Boolean
1060
+ "Delete the current node (and its subgraph)"
1061
+ delete: Boolean
1062
+ "Import a file under the current node"
1063
+ importContent(
1064
+ "Name of the request part that contains desired import file body"
1065
+ file: String!
1066
+ ): Boolean
1067
+ "Lock the node"
1068
+ lock(
1069
+ "Type of lock, defaults to user"
1070
+ type: String = "user"
1071
+ ): Boolean
1072
+ "Mark the current node (and its subgraph) for deletion"
1073
+ markForDeletion(
1074
+ "Optional deletion comment"
1075
+ comment: String
1076
+ ): Boolean
1077
+ "Moves the current node to a specified destination path (if destPath is specified) or moves it under the specified node (if parentPathOrId is specified). Either of two parameters is expected."
1078
+ move(
1079
+ "The target node path of the current node after the move operation"
1080
+ destPath: String,
1081
+ "The parent node path or id under which the current node will be moved to"
1082
+ parentPathOrId: String
1083
+ ): String
1084
+ "Mutates a set of existing direct sub nodes, based on filters passed as parameter"
1085
+ mutateChildren(
1086
+ "Filter of child nodes by their names; null to avoid such filtering"
1087
+ names: [String],
1088
+ "Filter of child nodes by their property values; null to avoid such filtering"
1089
+ propertiesFilter: InputNodePropertiesInput,
1090
+ "Filter of child nodes by their types; null to avoid such filtering"
1091
+ typesFilter: InputNodeTypesInput
1092
+ ): [JCRNodeMutation]
1093
+ "Mutates an existing sub node, based on its relative path to the current node"
1094
+ mutateDescendant(
1095
+ "Name or relative path of the sub node to mutate"
1096
+ relPath: String!
1097
+ ): JCRNodeMutation
1098
+ "Mutates a set of existing descendant nodes, based on filters passed as parameter"
1099
+ mutateDescendants(
1100
+ "Filter of descendant nodes by their property values; null to avoid such filtering"
1101
+ propertiesFilter: InputNodePropertiesInput,
1102
+ "Filter out and stop recursion on nodes by their property values; null to avoid such filtering"
1103
+ recursionPropertiesFilter: InputNodePropertiesInput,
1104
+ "Filter out and stop recursion on nodes by their types; null to avoid such filtering"
1105
+ recursionTypesFilter: InputNodeTypesInput,
1106
+ "Filter of descendant nodes by their types; null to avoid such filtering"
1107
+ typesFilter: InputNodeTypesInput
1108
+ ): [JCRNodeMutation]
1109
+ "Mutates or creates a set of properties on the current node"
1110
+ mutateProperties(
1111
+ "The names of the JCR properties; null to obtain all properties"
1112
+ names: [String]
1113
+ ): [JCRPropertyMutation]
1114
+ "Mutates or creates a property on the current node"
1115
+ mutateProperty(
1116
+ "The name of the property to update"
1117
+ name: String!
1118
+ ): JCRPropertyMutation
1119
+ "Update a vanity URL"
1120
+ mutateVanityUrl(
1121
+ "The url to edit"
1122
+ url: String!
1123
+ ): VanityUrlMappingMutation
1124
+ "Update vanity URLs"
1125
+ mutateVanityUrls(
1126
+ "Filter by languages"
1127
+ languages: [String]
1128
+ ): [VanityUrlMappingMutation]
1129
+ "Mutate wip information"
1130
+ mutateWipInfo(
1131
+ "Work in progress information to save"
1132
+ wipInfo: InputwipInfo!
1133
+ ): Boolean
1134
+ "Get the graphQL representation of the node currently being mutated"
1135
+ node: JCRNode
1136
+ "Publish the node in certain languages"
1137
+ publish(
1138
+ "Languages to publish the node in"
1139
+ languages: [String],
1140
+ "Publish all sub and related nodes. Default is true."
1141
+ publishSubNodes: Boolean = true
1142
+ ): Boolean
1143
+ "Removes mixin types on the current node"
1144
+ removeMixins(
1145
+ "The collection of mixin type names"
1146
+ mixins: [String]!
1147
+ ): [String]
1148
+ "Rename the current node"
1149
+ rename(
1150
+ "The new name of the node"
1151
+ name: String!
1152
+ ): String
1153
+ "Reorder child nodes according to the list of names passed"
1154
+ reorderChildren(
1155
+ "List of child node names in the desired order"
1156
+ names: [String]!,
1157
+ "The target position of reordered child nodes. The default value is inplace."
1158
+ position: ReorderedChildrenPosition = INPLACE
1159
+ ): Boolean
1160
+ "Mutates or creates a set of properties on the current node"
1161
+ setPropertiesBatch(
1162
+ "The collection of JCR properties to set"
1163
+ properties: [InputJCRProperty]
1164
+ ): [JCRPropertyMutation]
1165
+ startWorkflow(definition: String, language: String): Boolean
1166
+ "Return image transformation mutation"
1167
+ transformImage(
1168
+ "name of target file, if different"
1169
+ name: String,
1170
+ "target path, if different"
1171
+ targetPath: String
1172
+ ): GqlJcrImageTransformMutation
1173
+ "Unlock the node"
1174
+ unlock(
1175
+ "Type of lock, defaults to user"
1176
+ type: String = "user"
1177
+ ): Boolean
1178
+ "Unmark this node and all the sub-nodes for deletion"
1179
+ unmarkForDeletion: Boolean
1180
+ "Unpublish the node in certain languages"
1181
+ unpublish(
1182
+ "Languages to publish the node in"
1183
+ languages: [String]
1184
+ ): Boolean
1185
+ "Get the identifier of the node currently being mutated"
1186
+ uuid: String
1187
+ "Return zip mutation"
1188
+ zip: ZipFileMutation
1189
+ }
1190
+
1191
+ "GraphQL representation of a JCR node type"
1192
+ type JCRNodeType {
1193
+ "Returns true if this is an abstract node type; returns false otherwise."
1194
+ abstract: Boolean
1195
+ "Node type displayable name"
1196
+ displayName(
1197
+ "Language"
1198
+ language: String!
1199
+ ): String
1200
+ "Returns true if nodes of this type must support orderable child nodes; returns false otherwise."
1201
+ hasOrderableChildNodes: Boolean
1202
+ "Node type icon"
1203
+ icon: String
1204
+ "Reports if the current node type matches the nodetype(s) passed in parameter"
1205
+ isNodeType(
1206
+ "Node type name"
1207
+ type: InputNodeTypesInput!
1208
+ ): Boolean!
1209
+ "Returns true if this is a mixin type; returns false otherwise."
1210
+ mixin: Boolean
1211
+ "Node type name"
1212
+ name: String
1213
+ "Returns an array containing the child node definitions of this node type."
1214
+ nodes(
1215
+ "Filter by graphQL fields values"
1216
+ fieldFilter: InputFieldFiltersInput
1217
+ ): [JCRNodeDefinition]
1218
+ "Returns the name of the primary item (one of the child items of the nodes of this node type). If this node has no primary item, then this method null."
1219
+ primaryItem: JCRItemDefinition
1220
+ "Returns an array containing the property definitions of this node type."
1221
+ properties(
1222
+ "Filter by graphQL fields values"
1223
+ fieldFilter: InputFieldFiltersInput
1224
+ ): [JCRPropertyDefinition]
1225
+ "Returns true if the node type is queryable."
1226
+ queryable: Boolean
1227
+ "Returns all subtypes of this node type in the node type inheritance hierarchy."
1228
+ subTypes(
1229
+ "fetching only nodes after this node (exclusive)"
1230
+ after: String,
1231
+ "fetching only nodes before this node (exclusive)"
1232
+ before: String,
1233
+ "fetching only the first certain number of nodes"
1234
+ first: Int,
1235
+ "fetching only the last certain number of nodes"
1236
+ last: Int,
1237
+ "fetching only the first certain number of nodes"
1238
+ limit: Int,
1239
+ "fetching only nodes after this node (inclusive)"
1240
+ offset: Int
1241
+ ): JCRNodeTypeConnection
1242
+ "Returns all supertypes of this node type in the node type inheritance hierarchy."
1243
+ supertypes(
1244
+ "Filter by graphQL fields values"
1245
+ fieldFilter: InputFieldFiltersInput
1246
+ ): [JCRNodeType]
1247
+ "System ID of the node type, corresponding to the name of the module declaring it."
1248
+ systemId: String
1249
+ }
1250
+
1251
+ "A connection to a list of items."
1252
+ type JCRNodeTypeConnection {
1253
+ "a list of edges"
1254
+ edges: [JCRNodeTypeEdge]
1255
+ "a list of nodes"
1256
+ nodes: [JCRNodeType]
1257
+ "details about this specific page"
1258
+ pageInfo: PageInfo!
1259
+ }
1260
+
1261
+ "An edge in a connection"
1262
+ type JCRNodeTypeEdge {
1263
+ "cursor marks a unique position or index into the connection"
1264
+ cursor: String!
1265
+ "index in the connection"
1266
+ index: Int
1267
+ "The item at the end of the edge"
1268
+ node: JCRNodeType
1269
+ }
1270
+
1271
+ "GraphQL representation of a JCR property."
1272
+ type JCRProperty {
1273
+ "The decrypted value of the JCR encrypted property as a String in case the property is single-valued, null otherwise"
1274
+ decryptedValue: String
1275
+ "The decrypted values of the JCR encrypted property as a Strings in case the property is multiple-valued, null otherwise"
1276
+ decryptedValues: [String]
1277
+ "Returns the property definition that applies to this property."
1278
+ definition: JCRPropertyDefinition
1279
+ "The value of the JCR property as a Float in case the property is single-valued, null otherwise"
1280
+ floatValue: Float
1281
+ "The values of the JCR property as Floats in case the property is multiple-valued, null otherwise"
1282
+ floatValues: [Float]
1283
+ "Whether the property is internationalized"
1284
+ internationalized: Boolean!
1285
+ "The language the property value was obtained in for internationalized properties; null for non-internationalized ones"
1286
+ language: String
1287
+ "The value of the JCR property as a Long in case the property is single-valued, null otherwise"
1288
+ longValue: Long
1289
+ "The values of the JCR property as Longs in case the property is multiple-valued, null otherwise"
1290
+ longValues: [Long]
1291
+ "The name of the JCR property"
1292
+ name: String!
1293
+ "The GraphQL representation of the JCR node the property belongs to."
1294
+ node: JCRNode!
1295
+ "The value of the JCR property casted as date and returned in this string format: [yyyy-MM-dd'T'HH:mm:ss.SSS] in case the property is single-valued, null otherwise"
1296
+ notZonedDateValue: String
1297
+ "The values of the JCR property casted as date and returned in this string format: [yyyy-MM-dd'T'HH:mm:ss.SSS] in case the property is multiple-valued, null otherwise"
1298
+ notZonedDateValues: [String]
1299
+ "The path of the JCR property"
1300
+ path: String!
1301
+ "GraphQL representation of the node this property references in case the property is single-valued, null otherwise"
1302
+ refNode: JCRNode
1303
+ "GraphQL representations of the nodes this property references in case the property is multiple-valued, null otherwise"
1304
+ refNodes: [JCRNode]
1305
+ "The binary size of the JCR node as a Long, null otherwise"
1306
+ size: Long
1307
+ "The type of the JCR property"
1308
+ type: JCRPropertyType!
1309
+ "The value of the JCR property as a String in case the property is single-valued, null otherwise"
1310
+ value: String
1311
+ "The values of the JCR property as Strings in case the property is multiple-valued, null otherwise"
1312
+ values: [String]
1313
+ }
1314
+
1315
+ "A connection to a list of items."
1316
+ type JCRPropertyConnection {
1317
+ "a list of edges"
1318
+ edges: [JCRPropertyEdge]
1319
+ "a list of nodes"
1320
+ nodes: [JCRProperty]
1321
+ "details about this specific page"
1322
+ pageInfo: PageInfo!
1323
+ }
1324
+
1325
+ "GraphQL representation of a JCR property definition"
1326
+ type JCRPropertyDefinition implements JCRItemDefinition {
1327
+ "Reports whether the item is to be automatically created when its parent node is created."
1328
+ autoCreated: Boolean!
1329
+ "Property constraints"
1330
+ constraints: [String]!
1331
+ "Gets the node type that contains the declaration of this definition."
1332
+ declaringNodeType: JCRNodeType!
1333
+ "Gets the displayable name of the property for the given language code. Return the system name in case the label doesn't exists"
1334
+ displayName(
1335
+ "Language"
1336
+ language: String!
1337
+ ): String!
1338
+ "Reports whether the child item is hidden from UI."
1339
+ hidden: Boolean!
1340
+ "Reports whether this property has language dependant values."
1341
+ internationalized: Boolean!
1342
+ "Reports whether the item is mandatory. A mandatory item is one that, if its parent node exists, must also exist."
1343
+ mandatory: Boolean!
1344
+ "Reports whether this property can have multiple values."
1345
+ multiple: Boolean!
1346
+ "Gets the name of the child item."
1347
+ name: String!
1348
+ "Reports whether the child item is protected."
1349
+ protected: Boolean!
1350
+ "Gets the required type of the property."
1351
+ requiredType: JCRPropertyType!
1352
+ }
1353
+
1354
+ "An edge in a connection"
1355
+ type JCRPropertyEdge {
1356
+ "cursor marks a unique position or index into the connection"
1357
+ cursor: String!
1358
+ "index in the connection"
1359
+ index: Int
1360
+ "The item at the end of the edge"
1361
+ node: JCRProperty
1362
+ }
1363
+
1364
+ "Mutations on a JCR property"
1365
+ type JCRPropertyMutation {
1366
+ "Add a new value to this property"
1367
+ addValue(language: String, option: JCRPropertyOption, type: JCRPropertyType, value: String): Boolean
1368
+ "Add new values to this property"
1369
+ addValues(language: String, option: JCRPropertyOption, type: JCRPropertyType, values: [String]): Boolean
1370
+ "Delete this property"
1371
+ delete(language: String): Boolean
1372
+ "Get the path of the property currently being mutated"
1373
+ path: String
1374
+ "Get the graphQL representation of the property currently being mutated"
1375
+ property: JCRProperty
1376
+ "Remove a new value from this property"
1377
+ removeValue(language: String, option: JCRPropertyOption, type: JCRPropertyType, value: String): Boolean
1378
+ "Remove values from this property"
1379
+ removeValues(language: String, option: JCRPropertyOption, type: JCRPropertyType, values: [String]): Boolean
1380
+ "Set property value"
1381
+ setValue(language: String, option: JCRPropertyOption, type: JCRPropertyType, value: String): Boolean
1382
+ "Set property values"
1383
+ setValues(language: String, option: JCRPropertyOption, type: JCRPropertyType, values: [String]): Boolean
1384
+ }
1385
+
1386
+ "JCR Queries"
1387
+ type JCRQuery {
1388
+ "Retrieves the number of active workflow tasks for the current user"
1389
+ activeWorkflowTaskCountForUser: Int
1390
+ "Get GraphQL representation of a node by its UUID"
1391
+ nodeById(
1392
+ "The UUID of the node"
1393
+ uuid: String!
1394
+ ): JCRNode
1395
+ "Get GraphQL representation of a node by its path"
1396
+ nodeByPath(
1397
+ "The path of the node"
1398
+ path: String!
1399
+ ): JCRNode
1400
+ "Get a node type by its name"
1401
+ nodeTypeByName(
1402
+ "Node type name"
1403
+ name: String!
1404
+ ): JCRNodeType
1405
+ "Get a list of nodetypes based on specified parameter"
1406
+ nodeTypes(
1407
+ "fetching only nodes after this node (exclusive)"
1408
+ after: String,
1409
+ "fetching only nodes before this node (exclusive)"
1410
+ before: String,
1411
+ "Filter by graphQL fields values"
1412
+ fieldFilter: InputFieldFiltersInput,
1413
+ "Filter on node type"
1414
+ filter: InputNodeTypesListInput,
1415
+ "fetching only the first certain number of nodes"
1416
+ first: Int,
1417
+ "fetching only the last certain number of nodes"
1418
+ last: Int,
1419
+ "fetching only the first certain number of nodes"
1420
+ limit: Int,
1421
+ "fetching only nodes after this node (inclusive)"
1422
+ offset: Int
1423
+ ): JCRNodeTypeConnection
1424
+ "Get multiple node types by their names"
1425
+ nodeTypesByNames(
1426
+ "Node type names"
1427
+ names: [String]!
1428
+ ): [JCRNodeType]
1429
+ "handles query nodes with QOM factory"
1430
+ nodesByCriteria(
1431
+ "fetching only nodes after this node (exclusive)"
1432
+ after: String,
1433
+ "fetching only nodes before this node (exclusive)"
1434
+ before: String,
1435
+ "The criteria to fetch nodes by"
1436
+ criteria: InputGqlJcrNodeCriteriaInput!,
1437
+ "Filter by GraphQL field values"
1438
+ fieldFilter: InputFieldFiltersInput,
1439
+ "Group fields by criteria"
1440
+ fieldGrouping: InputFieldGroupingInput,
1441
+ "sort by GraphQL field values"
1442
+ fieldSorter: InputFieldSorterInput,
1443
+ "fetching only the first certain number of nodes"
1444
+ first: Int,
1445
+ "fetching only the last certain number of nodes"
1446
+ last: Int,
1447
+ "fetching only the first certain number of nodes"
1448
+ limit: Int,
1449
+ "fetching only nodes after this node (inclusive)"
1450
+ offset: Int
1451
+ ): JCRNodeConnection
1452
+ "Get GraphQL representations of multiple nodes by their UUIDs"
1453
+ nodesById(
1454
+ "The UUIDs of the nodes"
1455
+ uuids: [String!]!
1456
+ ): [JCRNode]!
1457
+ "Get GraphQL representations of multiple nodes by their paths"
1458
+ nodesByPath(
1459
+ "The paths of the nodes"
1460
+ paths: [String!]!
1461
+ ): [JCRNode]!
1462
+ "Get GraphQL representations of nodes using a query language supported by JCR"
1463
+ nodesByQuery(
1464
+ "fetching only nodes after this node (exclusive)"
1465
+ after: String,
1466
+ "fetching only nodes before this node (exclusive)"
1467
+ before: String,
1468
+ "Filter by graphQL fields values"
1469
+ fieldFilter: InputFieldFiltersInput,
1470
+ "Group fields by criteria"
1471
+ fieldGrouping: InputFieldGroupingInput,
1472
+ "sort by GraphQL field values"
1473
+ fieldSorter: InputFieldSorterInput,
1474
+ "fetching only the first certain number of nodes"
1475
+ first: Int,
1476
+ "Language to access node properties in"
1477
+ language: String,
1478
+ "fetching only the last certain number of nodes"
1479
+ last: Int,
1480
+ "fetching only the first certain number of nodes"
1481
+ limit: Int,
1482
+ "fetching only nodes after this node (inclusive)"
1483
+ offset: Int,
1484
+ "The query string"
1485
+ query: String!,
1486
+ "The query language"
1487
+ queryLanguage: QueryLanguage = SQL2
1488
+ ): JCRNodeConnection
1489
+ "Get the workspace of the query"
1490
+ workspace: Workspace!
1491
+ }
1492
+
1493
+ "GraphQL representation of a site node"
1494
+ type JCRSite implements JCRNode {
1495
+ "Get the last modified date of this node and its descendants. The recursion in descendants can be controlled by recursionTypesFilter. If no filter is passed, recursion will stop by default on sub pages."
1496
+ aggregatedLastModifiedDate(
1497
+ "The language"
1498
+ language: String,
1499
+ "Stop recursion on graphql field values"
1500
+ recursionTypesFilter: InputNodeTypesInput
1501
+ ): String
1502
+ "Aggregated publication info about the JCR node"
1503
+ aggregatedPublicationInfo(
1504
+ "Publication language"
1505
+ language: String!,
1506
+ "Whether to take references into account when calculating the aggregated publication status"
1507
+ references: Boolean = false,
1508
+ "Whether to take sub-nodes into account when calculating the aggregated publication status"
1509
+ subNodes: Boolean = false
1510
+ ): GqlPublicationInfo!
1511
+ "Render URL in ajax mode"
1512
+ ajaxRenderUrl: String
1513
+ "Returns a list of types allowed under the provided node"
1514
+ allowedChildNodeTypes(
1515
+ "Filter by GraphQL fields values"
1516
+ fieldFilter: InputFieldFiltersInput,
1517
+ "Whether all sub-types of allowed child node types should be included"
1518
+ includeSubTypes: Boolean = true
1519
+ ): [JCRNodeType]
1520
+ "GraphQL representations of the ancestor nodes of the JCR node, top down direction"
1521
+ ancestors(
1522
+ "Filter by graphQL fields values"
1523
+ fieldFilter: InputFieldFiltersInput,
1524
+ "The path of the topmost ancestor node to include in the result; null or empty string to include all the ancestor nodes"
1525
+ upToPath: String
1526
+ ): [JCRNode]!
1527
+ "GraphQL representations of the child nodes, according to parameters passed"
1528
+ children(
1529
+ "fetching only nodes after this node (exclusive)"
1530
+ after: String,
1531
+ "fetching only nodes before this node (exclusive)"
1532
+ before: String,
1533
+ "Filter by graphQL fields values"
1534
+ fieldFilter: InputFieldFiltersInput,
1535
+ "Group fields according to specified criteria"
1536
+ fieldGrouping: InputFieldGroupingInput,
1537
+ "Sort by graphQL fields values"
1538
+ fieldSorter: InputFieldSorterInput,
1539
+ "fetching only the first certain number of nodes"
1540
+ first: Int,
1541
+ "Include the current node itself in results"
1542
+ includesSelf: Boolean = false,
1543
+ "fetching only the last certain number of nodes"
1544
+ last: Int,
1545
+ "fetching only the first certain number of nodes"
1546
+ limit: Int,
1547
+ "Filter of child nodes by their names; null to avoid such filtering"
1548
+ names: [String],
1549
+ "fetching only nodes after this node (inclusive)"
1550
+ offset: Int,
1551
+ "Filter of child nodes by their property values; null to avoid such filtering"
1552
+ propertiesFilter: InputNodePropertiesInput,
1553
+ "Filter of child nodes by their types; null to avoid such filtering"
1554
+ typesFilter: InputNodeTypesInput
1555
+ ): JCRNodeConnection!
1556
+ "Site default language"
1557
+ defaultLanguage: String
1558
+ "Read default Work in progress information. Set by \"wip.checkbox.checked\" system proprety"
1559
+ defaultWipInfo: wipInfo
1560
+ "Returns the node definition that applies to this node."
1561
+ definition: JCRNodeDefinition
1562
+ "GraphQL representation of a descendant node, based on its relative path"
1563
+ descendant(
1564
+ "Name or relative path of the sub node"
1565
+ relPath: String!
1566
+ ): JCRNode
1567
+ "GraphQL representations of the descendant nodes, according to parameters passed"
1568
+ descendants(
1569
+ "fetching only nodes after this node (exclusive)"
1570
+ after: String,
1571
+ "fetching only nodes before this node (exclusive)"
1572
+ before: String,
1573
+ "Filter by graphQL fields values"
1574
+ fieldFilter: InputFieldFiltersInput,
1575
+ "Group fields according to specified criteria"
1576
+ fieldGrouping: InputFieldGroupingInput,
1577
+ "Sort by graphQL fields values"
1578
+ fieldSorter: InputFieldSorterInput,
1579
+ "fetching only the first certain number of nodes"
1580
+ first: Int,
1581
+ "fetching only the last certain number of nodes"
1582
+ last: Int,
1583
+ "fetching only the first certain number of nodes"
1584
+ limit: Int,
1585
+ "fetching only nodes after this node (inclusive)"
1586
+ offset: Int,
1587
+ "Filter of descendant nodes by their property values; null to avoid such filtering"
1588
+ propertiesFilter: InputNodePropertiesInput,
1589
+ "Filter out and stop recursion on nodes by their property values; null to avoid such filtering"
1590
+ recursionPropertiesFilter: InputNodePropertiesInput,
1591
+ "Filter out and stop recursion on nodes by their types; null to avoid such filtering"
1592
+ recursionTypesFilter: InputNodeTypesInput,
1593
+ "Filter of descendant nodes by their types; null to avoid such filtering"
1594
+ typesFilter: InputNodeTypesInput
1595
+ ): JCRNodeConnection!
1596
+ "Site description"
1597
+ description: String
1598
+ "GraphQL representation of the parent JCR node"
1599
+ displayName(
1600
+ "Language"
1601
+ language: String
1602
+ ): String
1603
+ "Returns the first parent of the current node that can be displayed in full page. If no matching node is found, null is returned."
1604
+ displayableNode: JCRNode
1605
+ "Returns the next available name for a node, appending if needed numbers."
1606
+ findAvailableNodeName(language: String, nodeType: String): String
1607
+ "Check if the current user has a specific permission"
1608
+ hasPermission(
1609
+ "The name of the permission"
1610
+ permissionName: String!
1611
+ ): Boolean
1612
+ "Retrieves a collection of module IDs, which are installed on the site, the node belongs to"
1613
+ installedModules: [String]
1614
+ "Retrieves a collection of module IDs, which are installed on the site, the node belongs to, as well as dependencies of those modules"
1615
+ installedModulesWithAllDependencies: [String]
1616
+ "Check if the node as a renderable template associated with it (not a view a template)."
1617
+ isDisplayableNode: Boolean
1618
+ "Reports if the current node matches the nodetype(s) passed in parameter"
1619
+ isNodeType(
1620
+ "Node type name"
1621
+ type: InputNodeTypesInput!
1622
+ ): Boolean!
1623
+ "Site languages"
1624
+ languages: [JCRSiteLanguage]
1625
+ "Check if the given locales need translation, by comparing last modifications dates with already existing translations"
1626
+ languagesToTranslate(
1627
+ "The languages to check"
1628
+ languagesToCheck: [String],
1629
+ "The translated languages"
1630
+ languagesTranslated: [String]
1631
+ ): [String]
1632
+ "Retrieve lock info of the current node"
1633
+ lockInfo: LockInfo
1634
+ "Returns edit lock status of the current node object"
1635
+ lockedAndCannotBeEdited: Boolean
1636
+ "Returns an array of <code>NodeType</code> objects representing the mixin node types in effect for this node."
1637
+ mixinTypes(
1638
+ "Filter by GraphQL fields values"
1639
+ fieldFilter: InputFieldFiltersInput
1640
+ ): [JCRNodeType]!
1641
+ "The name of the JCR node this object represents"
1642
+ name: String!
1643
+ "GraphQL representation of this node in certain workspace"
1644
+ nodeInWorkspace(
1645
+ "The target workspace"
1646
+ workspace: Workspace!
1647
+ ): JCRNode
1648
+ "Get information on the operations that can be done on this node"
1649
+ operationsSupport: GqlOperationsSupport
1650
+ "GraphQL representation of the parent JCR node"
1651
+ parent: JCRNode
1652
+ "The path of the JCR node this object represents"
1653
+ path: String!
1654
+ "Get the primary node type of this node"
1655
+ primaryNodeType: JCRNodeType!
1656
+ "GraphQL representations of the properties in the requested language"
1657
+ properties(
1658
+ "Filter by graphQL fields values"
1659
+ fieldFilter: InputFieldFiltersInput,
1660
+ "The language to obtain the properties in; must be a valid language code in case any internationalized properties are requested, does not matter for non-internationalized ones"
1661
+ language: String,
1662
+ "The names of the JCR properties; null to obtain all properties"
1663
+ names: [String]
1664
+ ): [JCRProperty]!
1665
+ "The GraphQL representation of the property in the requested language; null if the property does not exist"
1666
+ property(
1667
+ "The language to obtain the property in; must be a valid language code for internationalized properties, does not matter for non-internationalized ones"
1668
+ language: String,
1669
+ "The name of the JCR property"
1670
+ name: String!
1671
+ ): JCRProperty
1672
+ "GraphQL representations of the reference properties that target the current JCR Node"
1673
+ references(
1674
+ "fetching only nodes after this node (exclusive)"
1675
+ after: String,
1676
+ "fetching only nodes before this node (exclusive)"
1677
+ before: String,
1678
+ "Filter by graphQL fields values"
1679
+ fieldFilter: InputFieldFiltersInput,
1680
+ "fetching only the first certain number of nodes"
1681
+ first: Int,
1682
+ "fetching only the last certain number of nodes"
1683
+ last: Int,
1684
+ "fetching only the first certain number of nodes"
1685
+ limit: Int,
1686
+ "fetching only nodes after this node (inclusive)"
1687
+ offset: Int
1688
+ ): JCRPropertyConnection!
1689
+ "Gets the fully rendered content for this node"
1690
+ renderedContent(
1691
+ "Rendering context configuration"
1692
+ contextConfiguration: String,
1693
+ "Language"
1694
+ language: String,
1695
+ "Additional request attributes"
1696
+ requestAttributes: [InputRenderRequestAttributeInput],
1697
+ "Template type"
1698
+ templateType: String,
1699
+ "Name of the view"
1700
+ view: String
1701
+ ): RenderedNode
1702
+ "Site server name"
1703
+ serverName: String
1704
+ "GraphQL representation of the site the JCR node belongs to, or the system site in case the node does not belong to any site"
1705
+ site: JCRSite
1706
+ "Site key"
1707
+ sitekey: String
1708
+ "The UUID of the JCR node this object represents"
1709
+ uuid: String!
1710
+ "Get vanity URLs from the current node filtered by the parameters"
1711
+ vanityUrls(
1712
+ "Filter results based on graphql field values"
1713
+ fieldFilter: InputFieldFiltersInput,
1714
+ "Languages"
1715
+ languages: [String]
1716
+ ): [VanityUrl]
1717
+ "Read work in progress information for a given node"
1718
+ wipInfo: wipInfo
1719
+ "Get the workspace of the query"
1720
+ workspace: Workspace!
1721
+ }
1722
+
1723
+ "Site language representation"
1724
+ type JCRSiteLanguage {
1725
+ "Is this language active in edit"
1726
+ activeInEdit: Boolean
1727
+ "Is this language active in live"
1728
+ activeInLive: Boolean
1729
+ "Display name"
1730
+ displayName(
1731
+ "Language"
1732
+ language: String
1733
+ ): String
1734
+ "Language code"
1735
+ language: String
1736
+ "Is this language mandatory"
1737
+ mandatory: Boolean
1738
+ }
1739
+
1740
+ "GraphQL representation of a Tag"
1741
+ type JCRTag {
1742
+ "The name of the tag"
1743
+ name: String!
1744
+ "Get the occurences of a tag"
1745
+ occurences: Long!
1746
+ }
1747
+
1748
+ "JCR Queries"
1749
+ type JCRTags {
1750
+ "Handles suggestion tags queries"
1751
+ suggest(
1752
+ "Max number of tags to get"
1753
+ limit: Long!,
1754
+ "Minimal occurrences to return a tag"
1755
+ minCount: Long,
1756
+ "Offset value"
1757
+ offset: Long,
1758
+ "The prefix of the tags"
1759
+ prefix: String!,
1760
+ "Sort the tags by occurrences"
1761
+ sortByCount: Boolean,
1762
+ "The root node to start the search"
1763
+ startPath: String!
1764
+ ): [JCRTag]
1765
+ }
1766
+
1767
+ type JWTToken {
1768
+ claims: String
1769
+ id: String
1770
+ token: String
1771
+ }
1772
+
1773
+ "Information on node lock"
1774
+ type LockInfo {
1775
+ "Can the node be locked"
1776
+ canLock: Boolean
1777
+ "Can the node be unlocked"
1778
+ canUnlock: Boolean
1779
+ "Is node lockable"
1780
+ details(
1781
+ "language in which to retrieve details"
1782
+ language: String
1783
+ ): [GqlLockDetail]
1784
+ "Is node lockable"
1785
+ lockable: Boolean
1786
+ }
1787
+
1788
+ "Metadata properties for all content"
1789
+ type Metadata {
1790
+ "Date of creation for the associated content"
1791
+ created: Date
1792
+ "Original author of the associated content"
1793
+ createdBy: String
1794
+ "Date of last modification of the associated content"
1795
+ lastModified: Date
1796
+ "Author of last modification of the associated content"
1797
+ lastModifiedBy: String
1798
+ "Date of last publication of the associated content"
1799
+ lastPublished: Date
1800
+ "Author of last publication of the associated content"
1801
+ lastPublishedBy: String
1802
+ path: String
1803
+ uuid: String
1804
+ }
1805
+
1806
+ "Root mutation type"
1807
+ type Mutation {
1808
+ "Admin Mutation"
1809
+ admin: adminMutation
1810
+ "Main access field to the DX GraphQL Form mutation API"
1811
+ forms: GqlEditorFormMutations
1812
+ "JCR Mutation"
1813
+ jcr(
1814
+ "Should save"
1815
+ save: Boolean = true,
1816
+ "The name of the workspace to fetch the node from; either 'edit', 'live', or null to use 'edit' by default"
1817
+ workspace: Workspace
1818
+ ): JCRMutation
1819
+ "Generate a new JWT token"
1820
+ jwtToken(ips: [String], referer: [String], scopes: [String]!): JWTToken
1821
+ mutateWorkflows(definition: String): [WorkflowMutation]
1822
+ }
1823
+
1824
+ "GraphQL representation of node type tree entry"
1825
+ type NodeTypeTreeEntry {
1826
+ "Return the children if any"
1827
+ children: [NodeTypeTreeEntry]
1828
+ "Return icon URL with png extension"
1829
+ iconURL(
1830
+ "if true (default) add '.png' to the icon path."
1831
+ addExtension: Boolean = true
1832
+ ): String
1833
+ "Return uniq identifier for tree entry"
1834
+ id: String
1835
+ "Return the i18n label"
1836
+ label: String
1837
+ "Return nodeType name"
1838
+ name: String
1839
+ "Return nodeType"
1840
+ nodeType: JCRNodeType
1841
+ "Return the parent tree entry (if any)"
1842
+ parent: NodeTypeTreeEntry
1843
+ }
1844
+
1845
+ "Information about pagination in a connection."
1846
+ type PageInfo {
1847
+ "When paginating forwards, the cursor to continue."
1848
+ endCursor: String
1849
+ "When paginating forwards, are there more items?"
1850
+ hasNextPage: Boolean!
1851
+ "When paginating backwards, are there more items?"
1852
+ hasPreviousPage: Boolean!
1853
+ "When paginating forwards, the cursor to continue."
1854
+ nodesCount: Int
1855
+ "When paginating backwards, the cursor to continue."
1856
+ startCursor: String
1857
+ "When paginating forwards, the cursor to continue."
1858
+ totalCount: Int
1859
+ }
1860
+
1861
+ "Token details"
1862
+ type PersonalApiToken {
1863
+ "Creation date and time"
1864
+ createdAt: String
1865
+ "Expiration date"
1866
+ expireAt: String
1867
+ "The key of the token, used for looking it up"
1868
+ key: String
1869
+ "The name of the token"
1870
+ name: String
1871
+ "Token state"
1872
+ state: TokenState
1873
+ "Last modification date and time"
1874
+ updatedAt: String
1875
+ "The user associated to the token"
1876
+ user: User
1877
+ }
1878
+
1879
+ "A connection to a list of items."
1880
+ type PersonalApiTokenConnection {
1881
+ "a list of edges"
1882
+ edges: [PersonalApiTokenEdge]
1883
+ "a list of nodes"
1884
+ nodes: [PersonalApiToken]
1885
+ "details about this specific page"
1886
+ pageInfo: PageInfo!
1887
+ }
1888
+
1889
+ "An edge in a connection"
1890
+ type PersonalApiTokenEdge {
1891
+ "cursor marks a unique position or index into the connection"
1892
+ cursor: String!
1893
+ "index in the connection"
1894
+ index: Int
1895
+ "The item at the end of the edge"
1896
+ node: PersonalApiToken
1897
+ }
1898
+
1899
+ "Mutations for Personal Api Tokens"
1900
+ type PersonalApiTokensMutation {
1901
+ "Create a new token"
1902
+ createToken(
1903
+ "Expiration date of the token"
1904
+ expireAt: String,
1905
+ "Name to give to the token"
1906
+ name: String!,
1907
+ "Scopes attached to this token"
1908
+ scopes: [String],
1909
+ "The site the user belongs to, null if global user"
1910
+ site: String,
1911
+ "State to give the newly created token"
1912
+ state: TokenState
1913
+ ): String
1914
+ "Delete an existing token"
1915
+ deleteToken(
1916
+ "The token key"
1917
+ key: String!
1918
+ ): Boolean
1919
+ "Update an existing token"
1920
+ updateToken(
1921
+ "Expiration date of the token, use empty string to unset expiration date"
1922
+ expireAt: String,
1923
+ "The token key"
1924
+ key: String!,
1925
+ "Name to give to the token"
1926
+ name: String,
1927
+ "Scopes attached to this token"
1928
+ scopes: [String],
1929
+ "State to give the token"
1930
+ state: TokenState
1931
+ ): Boolean
1932
+ }
1933
+
1934
+ "Queries for Personal Api Tokens"
1935
+ type PersonalApiTokensQuery {
1936
+ availableScopes: [GqlScope]
1937
+ "Get token details, based on key"
1938
+ tokenByKey(
1939
+ "The token key"
1940
+ key: String!
1941
+ ): PersonalApiToken
1942
+ "Get token details, based on user and token name"
1943
+ tokenByUserAndName(
1944
+ "The site the user belongs to, null if global user"
1945
+ site: String,
1946
+ "The token name"
1947
+ tokenName: String!,
1948
+ "The user id"
1949
+ userId: String!
1950
+ ): PersonalApiToken
1951
+ "List tokens attached to the provided user ID and site key"
1952
+ tokens(
1953
+ "fetching only nodes after this node (exclusive)"
1954
+ after: String,
1955
+ "fetching only nodes before this node (exclusive)"
1956
+ before: String,
1957
+ "Sort by graphQL fields values"
1958
+ fieldSorter: InputFieldSorterInput,
1959
+ "fetching only the first certain number of nodes"
1960
+ first: Int,
1961
+ "fetching only the last certain number of nodes"
1962
+ last: Int,
1963
+ "fetching only the first certain number of nodes"
1964
+ limit: Int,
1965
+ "fetching only nodes after this node (inclusive)"
1966
+ offset: Int,
1967
+ "The site the user belongs to, null if global user"
1968
+ site: String,
1969
+ "If a userId is provided, only returns tokens assigned to that user."
1970
+ userId: String
1971
+ ): PersonalApiTokenConnection
1972
+ "Check if the token is valid for authentication"
1973
+ verifyToken(
1974
+ "The token"
1975
+ token: String!
1976
+ ): Boolean
1977
+ }
1978
+
1979
+ "Root query type"
1980
+ type Query {
1981
+ "Admin Queries"
1982
+ admin: AdminQuery!
1983
+ "default finder for categoryById"
1984
+ categoryById(
1985
+ id: String,
1986
+ "Content language, defaults to English"
1987
+ language: String = "en",
1988
+ "Return content from live or default workspace"
1989
+ preview: Boolean = false
1990
+ ): Category
1991
+ "default finder for categoryByPath"
1992
+ categoryByPath(
1993
+ "Content language, defaults to English"
1994
+ language: String = "en",
1995
+ path: String,
1996
+ "Return content from live or default workspace"
1997
+ preview: Boolean = false
1998
+ ): Category
1999
+ "Get the current user"
2000
+ currentUser: User
2001
+ "Main access field to the DX GraphQL Dashboard API"
2002
+ dashboard: GqlDashboard
2003
+ "Main access field to the DX GraphQL Form API"
2004
+ forms: GqlEditorForms
2005
+ "JCR Queries"
2006
+ jcr(
2007
+ "The name of the workspace to fetch the node from; either EDIT, LIVE, or null to use EDIT by default"
2008
+ workspace: Workspace
2009
+ ): JCRQuery!
2010
+ "Tag Queries"
2011
+ tag: JCRTags
2012
+ }
2013
+
2014
+ "Rendering result for a node"
2015
+ type RenderedNode {
2016
+ "Contraints on this node"
2017
+ constraints: String
2018
+ "Rendering output"
2019
+ output: String
2020
+ "List of static assets"
2021
+ staticAssets(
2022
+ "Assets type"
2023
+ type: String!
2024
+ ): [StaticAsset]
2025
+ }
2026
+
2027
+ "Simple numeric aggregation on properties values"
2028
+ type StatAggregation {
2029
+ "The date representation of a JCR node property"
2030
+ datePropertyValue(
2031
+ "The language to obtain the property in; must be a valid language code for internationalized properties, does not matter for non-internationalized ones"
2032
+ language: String,
2033
+ "The name of the JCR property"
2034
+ name: String!
2035
+ ): String
2036
+ "The float representation of a JCR node property"
2037
+ floatPropertyValue(
2038
+ "The language to obtain the property in; must be a valid language code for internationalized properties, does not matter for non-internationalized ones"
2039
+ language: String,
2040
+ "The name of the JCR property"
2041
+ name: String!
2042
+ ): Float
2043
+ "The long representation of a JCR node property"
2044
+ longPropertyValue(
2045
+ "The language to obtain the property in; must be a valid language code for internationalized properties, does not matter for non-internationalized ones"
2046
+ language: String,
2047
+ "The name of the JCR property"
2048
+ name: String!
2049
+ ): Long
2050
+ }
2051
+
2052
+ "Representation of a static assert"
2053
+ type StaticAsset {
2054
+ "Asset key"
2055
+ key: String
2056
+ "Asset option"
2057
+ option(
2058
+ "Asset option name"
2059
+ name: String!
2060
+ ): String
2061
+ }
2062
+
2063
+ "Root subscription type"
2064
+ type Subscription {
2065
+ "Subscription on background jobs"
2066
+ backgroundJobSubscription(
2067
+ "Subscribe only to job with matching group names"
2068
+ filterByGroups: [String],
2069
+ "Subscribe only to job with matching job states"
2070
+ filterByJobStates: [GqlBackgroundJobState],
2071
+ "Subscribe only to job with matching job statuses"
2072
+ filterByJobStatuses: [GqlBackgroundJobStatus],
2073
+ "Subscribe only to job with matching names"
2074
+ filterByNames: [String],
2075
+ "The target scheduler for listening jobs"
2076
+ targetScheduler: TargetScheduler = BOTH
2077
+ ): GqlBackgroundJob
2078
+ "Lock the node for edition and subscribe to hold the lock. The node is automatically unlocked when the client disconnect or close the connection"
2079
+ subscribeToEditorLock(
2080
+ "An ID generated client side used to identify the lock"
2081
+ editorID: String!,
2082
+ "Path of the node to be locked."
2083
+ nodePath: String!
2084
+ ): GqlEditorLockHeartBeat
2085
+ }
2086
+
2087
+ "GraphQL representation of a Jahia user"
2088
+ type User implements Principal {
2089
+ "Full display name"
2090
+ displayName: String
2091
+ "Is this principal member of the specified group"
2092
+ memberOf(
2093
+ "Target group"
2094
+ group: String,
2095
+ "Site where the group is defined"
2096
+ site: String
2097
+ ): Boolean
2098
+ "User name"
2099
+ name: String!
2100
+ "Get the corresponding JCR node"
2101
+ node: JCRNode
2102
+ "User property"
2103
+ property(
2104
+ "The name of the property"
2105
+ name: String!
2106
+ ): String
2107
+ "Site where the user is defined"
2108
+ site: JCRSite
2109
+ }
2110
+
2111
+ "GraphQL representation of a vanity URL"
2112
+ type VanityUrl implements JCRNode {
2113
+ "true if the URL mapping is activated or false if it is not activated"
2114
+ active: Boolean
2115
+ "Get the last modified date of this node and its descendants. The recursion in descendants can be controlled by recursionTypesFilter. If no filter is passed, recursion will stop by default on sub pages."
2116
+ aggregatedLastModifiedDate(
2117
+ "The language"
2118
+ language: String,
2119
+ "Stop recursion on graphql field values"
2120
+ recursionTypesFilter: InputNodeTypesInput
2121
+ ): String
2122
+ "Aggregated publication info about the JCR node"
2123
+ aggregatedPublicationInfo(
2124
+ "Publication language"
2125
+ language: String!,
2126
+ "Whether to take references into account when calculating the aggregated publication status"
2127
+ references: Boolean = false,
2128
+ "Whether to take sub-nodes into account when calculating the aggregated publication status"
2129
+ subNodes: Boolean = false
2130
+ ): GqlPublicationInfo!
2131
+ "Render URL in ajax mode"
2132
+ ajaxRenderUrl: String
2133
+ "Returns a list of types allowed under the provided node"
2134
+ allowedChildNodeTypes(
2135
+ "Filter by GraphQL fields values"
2136
+ fieldFilter: InputFieldFiltersInput,
2137
+ "Whether all sub-types of allowed child node types should be included"
2138
+ includeSubTypes: Boolean = true
2139
+ ): [JCRNodeType]
2140
+ "GraphQL representations of the ancestor nodes of the JCR node, top down direction"
2141
+ ancestors(
2142
+ "Filter by graphQL fields values"
2143
+ fieldFilter: InputFieldFiltersInput,
2144
+ "The path of the topmost ancestor node to include in the result; null or empty string to include all the ancestor nodes"
2145
+ upToPath: String
2146
+ ): [JCRNode]!
2147
+ "GraphQL representations of the child nodes, according to parameters passed"
2148
+ children(
2149
+ "fetching only nodes after this node (exclusive)"
2150
+ after: String,
2151
+ "fetching only nodes before this node (exclusive)"
2152
+ before: String,
2153
+ "Filter by graphQL fields values"
2154
+ fieldFilter: InputFieldFiltersInput,
2155
+ "Group fields according to specified criteria"
2156
+ fieldGrouping: InputFieldGroupingInput,
2157
+ "Sort by graphQL fields values"
2158
+ fieldSorter: InputFieldSorterInput,
2159
+ "fetching only the first certain number of nodes"
2160
+ first: Int,
2161
+ "Include the current node itself in results"
2162
+ includesSelf: Boolean = false,
2163
+ "fetching only the last certain number of nodes"
2164
+ last: Int,
2165
+ "fetching only the first certain number of nodes"
2166
+ limit: Int,
2167
+ "Filter of child nodes by their names; null to avoid such filtering"
2168
+ names: [String],
2169
+ "fetching only nodes after this node (inclusive)"
2170
+ offset: Int,
2171
+ "Filter of child nodes by their property values; null to avoid such filtering"
2172
+ propertiesFilter: InputNodePropertiesInput,
2173
+ "Filter of child nodes by their types; null to avoid such filtering"
2174
+ typesFilter: InputNodeTypesInput
2175
+ ): JCRNodeConnection!
2176
+ "true whether this URL mapping is the default one for the language"
2177
+ default: Boolean
2178
+ "Read default Work in progress information. Set by \"wip.checkbox.checked\" system proprety"
2179
+ defaultWipInfo: wipInfo
2180
+ "Returns the node definition that applies to this node."
2181
+ definition: JCRNodeDefinition
2182
+ "GraphQL representation of a descendant node, based on its relative path"
2183
+ descendant(
2184
+ "Name or relative path of the sub node"
2185
+ relPath: String!
2186
+ ): JCRNode
2187
+ "GraphQL representations of the descendant nodes, according to parameters passed"
2188
+ descendants(
2189
+ "fetching only nodes after this node (exclusive)"
2190
+ after: String,
2191
+ "fetching only nodes before this node (exclusive)"
2192
+ before: String,
2193
+ "Filter by graphQL fields values"
2194
+ fieldFilter: InputFieldFiltersInput,
2195
+ "Group fields according to specified criteria"
2196
+ fieldGrouping: InputFieldGroupingInput,
2197
+ "Sort by graphQL fields values"
2198
+ fieldSorter: InputFieldSorterInput,
2199
+ "fetching only the first certain number of nodes"
2200
+ first: Int,
2201
+ "fetching only the last certain number of nodes"
2202
+ last: Int,
2203
+ "fetching only the first certain number of nodes"
2204
+ limit: Int,
2205
+ "fetching only nodes after this node (inclusive)"
2206
+ offset: Int,
2207
+ "Filter of descendant nodes by their property values; null to avoid such filtering"
2208
+ propertiesFilter: InputNodePropertiesInput,
2209
+ "Filter out and stop recursion on nodes by their property values; null to avoid such filtering"
2210
+ recursionPropertiesFilter: InputNodePropertiesInput,
2211
+ "Filter out and stop recursion on nodes by their types; null to avoid such filtering"
2212
+ recursionTypesFilter: InputNodeTypesInput,
2213
+ "Filter of descendant nodes by their types; null to avoid such filtering"
2214
+ typesFilter: InputNodeTypesInput
2215
+ ): JCRNodeConnection!
2216
+ "GraphQL representation of the parent JCR node"
2217
+ displayName(
2218
+ "Language"
2219
+ language: String
2220
+ ): String
2221
+ "Returns the first parent of the current node that can be displayed in full page. If no matching node is found, null is returned."
2222
+ displayableNode: JCRNode
2223
+ "Returns the next available name for a node, appending if needed numbers."
2224
+ findAvailableNodeName(language: String, nodeType: String): String
2225
+ "Check if the current user has a specific permission"
2226
+ hasPermission(
2227
+ "The name of the permission"
2228
+ permissionName: String!
2229
+ ): Boolean
2230
+ "Check if the node as a renderable template associated with it (not a view a template)."
2231
+ isDisplayableNode: Boolean
2232
+ "Reports if the current node matches the nodetype(s) passed in parameter"
2233
+ isNodeType(
2234
+ "Node type name"
2235
+ type: InputNodeTypesInput!
2236
+ ): Boolean!
2237
+ "The language of the content object to which the vanity URL maps to"
2238
+ language: String
2239
+ "Check if the given locales need translation, by comparing last modifications dates with already existing translations"
2240
+ languagesToTranslate(
2241
+ "The languages to check"
2242
+ languagesToCheck: [String],
2243
+ "The translated languages"
2244
+ languagesTranslated: [String]
2245
+ ): [String]
2246
+ "Retrieve lock info of the current node"
2247
+ lockInfo: LockInfo
2248
+ "Returns edit lock status of the current node object"
2249
+ lockedAndCannotBeEdited: Boolean
2250
+ "Returns an array of <code>NodeType</code> objects representing the mixin node types in effect for this node."
2251
+ mixinTypes(
2252
+ "Filter by GraphQL fields values"
2253
+ fieldFilter: InputFieldFiltersInput
2254
+ ): [JCRNodeType]!
2255
+ "The name of the JCR node this object represents"
2256
+ name: String!
2257
+ "GraphQL representation of this node in certain workspace"
2258
+ nodeInWorkspace(
2259
+ "The target workspace"
2260
+ workspace: Workspace!
2261
+ ): JCRNode
2262
+ "Get information on the operations that can be done on this node"
2263
+ operationsSupport: GqlOperationsSupport
2264
+ "GraphQL representation of the parent JCR node"
2265
+ parent: JCRNode
2266
+ "The path of the JCR node this object represents"
2267
+ path: String!
2268
+ "Get the primary node type of this node"
2269
+ primaryNodeType: JCRNodeType!
2270
+ "GraphQL representations of the properties in the requested language"
2271
+ properties(
2272
+ "Filter by graphQL fields values"
2273
+ fieldFilter: InputFieldFiltersInput,
2274
+ "The language to obtain the properties in; must be a valid language code in case any internationalized properties are requested, does not matter for non-internationalized ones"
2275
+ language: String,
2276
+ "The names of the JCR properties; null to obtain all properties"
2277
+ names: [String]
2278
+ ): [JCRProperty]!
2279
+ "The GraphQL representation of the property in the requested language; null if the property does not exist"
2280
+ property(
2281
+ "The language to obtain the property in; must be a valid language code for internationalized properties, does not matter for non-internationalized ones"
2282
+ language: String,
2283
+ "The name of the JCR property"
2284
+ name: String!
2285
+ ): JCRProperty
2286
+ "GraphQL representations of the reference properties that target the current JCR Node"
2287
+ references(
2288
+ "fetching only nodes after this node (exclusive)"
2289
+ after: String,
2290
+ "fetching only nodes before this node (exclusive)"
2291
+ before: String,
2292
+ "Filter by graphQL fields values"
2293
+ fieldFilter: InputFieldFiltersInput,
2294
+ "fetching only the first certain number of nodes"
2295
+ first: Int,
2296
+ "fetching only the last certain number of nodes"
2297
+ last: Int,
2298
+ "fetching only the first certain number of nodes"
2299
+ limit: Int,
2300
+ "fetching only nodes after this node (inclusive)"
2301
+ offset: Int
2302
+ ): JCRPropertyConnection!
2303
+ "Gets the fully rendered content for this node"
2304
+ renderedContent(
2305
+ "Rendering context configuration"
2306
+ contextConfiguration: String,
2307
+ "Language"
2308
+ language: String,
2309
+ "Additional request attributes"
2310
+ requestAttributes: [InputRenderRequestAttributeInput],
2311
+ "Template type"
2312
+ templateType: String,
2313
+ "Name of the view"
2314
+ view: String
2315
+ ): RenderedNode
2316
+ "GraphQL representation of the site the JCR node belongs to, or the system site in case the node does not belong to any site"
2317
+ site: JCRSite
2318
+ "The node targeted by this vanity URL"
2319
+ targetNode: JCRNode
2320
+ "The vanity URL"
2321
+ url: String
2322
+ "The UUID of the JCR node this object represents"
2323
+ uuid: String!
2324
+ "Get vanity URLs from the current node filtered by the parameters"
2325
+ vanityUrls(
2326
+ "Filter results based on graphql field values"
2327
+ fieldFilter: InputFieldFiltersInput,
2328
+ "Languages"
2329
+ languages: [String]
2330
+ ): [VanityUrl]
2331
+ "Read work in progress information for a given node"
2332
+ wipInfo: wipInfo
2333
+ "Get the workspace of the query"
2334
+ workspace: Workspace!
2335
+ }
2336
+
2337
+ type VanityUrlMappingMutation {
2338
+ "Deletes the current vanity url"
2339
+ delete: Boolean
2340
+ "Move the vanity URL to another node"
2341
+ move(
2342
+ "The path of the target node"
2343
+ target: String!
2344
+ ): Boolean
2345
+ "Get mutation on underlying node"
2346
+ nodeMutation: JCRNodeMutation
2347
+ "Update vanity URL"
2348
+ update(
2349
+ "Desired value of the active flag or null to keep existing value"
2350
+ active: Boolean,
2351
+ "Desired value of the default flag or null to keep existing value"
2352
+ defaultMapping: Boolean,
2353
+ "Desired vanity URL language or null to keep existing value"
2354
+ language: String,
2355
+ "Desired URL value or null to keep existing value"
2356
+ url: String
2357
+ ): Boolean
2358
+ "Get the identifier of the node currently being mutated"
2359
+ uuid: String
2360
+ }
2361
+
2362
+ type Workflow {
2363
+ startUser: String
2364
+ }
2365
+
2366
+ type WorkflowMutation {
2367
+ abortWorkflow: Boolean
2368
+ workflow: Workflow
2369
+ }
2370
+
2371
+ type ZipFileMutation {
2372
+ "zip a file"
2373
+ addToZip(
2374
+ "list of paths or ids to zip"
2375
+ pathsOrIds: [String]!
2376
+ ): Boolean
2377
+ "unzip a zip file"
2378
+ unzip(
2379
+ "destination path to unzip"
2380
+ path: String!
2381
+ ): Boolean
2382
+ }
2383
+
2384
+ "Admin mutations"
2385
+ type adminMutation {
2386
+ "Personal API tokens mutations"
2387
+ personalApiTokens: PersonalApiTokensMutation
2388
+ "Stub mutation to get version of the running Jahia instance"
2389
+ version: String!
2390
+ }
2391
+
2392
+ "Work in progress information"
2393
+ type wipInfo {
2394
+ "The languages set for Work in progress"
2395
+ languages: [String]
2396
+ "Get WIP status"
2397
+ status: WipStatus
2398
+ }
2399
+
2400
+ enum FieldEvaluation {
2401
+ "The property value is among given Strings"
2402
+ AMONG
2403
+ "The property value contains given String "
2404
+ CONTAINS
2405
+ "The property value contains given String ignoring the case"
2406
+ CONTAINS_IGNORE_CASE
2407
+ "The field value is different from given one"
2408
+ DIFFERENT
2409
+ "The field value is empty - either null value, or no items for a list"
2410
+ EMPTY
2411
+ "The field value is equal to given one"
2412
+ EQUAL
2413
+ "The field value is not empty - if a list, must contain at least one item"
2414
+ NOT_EMPTY
2415
+ }
2416
+
2417
+ enum GqlBackgroundJobState {
2418
+ "FINISHED"
2419
+ FINISHED
2420
+ "STARTED"
2421
+ STARTED
2422
+ "VETOED"
2423
+ VETOED
2424
+ }
2425
+
2426
+ enum GqlBackgroundJobStatus {
2427
+ "ADDED"
2428
+ ADDED
2429
+ "CANCELED"
2430
+ CANCELED
2431
+ "EXECUTING"
2432
+ EXECUTING
2433
+ "FAILED"
2434
+ FAILED
2435
+ "SCHEDULED"
2436
+ SCHEDULED
2437
+ "SUCCESSFUL"
2438
+ SUCCESSFUL
2439
+ }
2440
+
2441
+ enum GroupingType {
2442
+ "Put grouped items at the end in the order groups appear in the 'groups' list"
2443
+ END
2444
+ "Put grouped items at the start in the order groups appear in the 'groups' list"
2445
+ START
2446
+ }
2447
+
2448
+ enum JCRPropertyOption {
2449
+ "ENCRYPTED"
2450
+ ENCRYPTED
2451
+ "NOT_ZONED_DATE"
2452
+ NOT_ZONED_DATE
2453
+ }
2454
+
2455
+ enum JCRPropertyType {
2456
+ "BINARY"
2457
+ BINARY
2458
+ "BOOLEAN"
2459
+ BOOLEAN
2460
+ "DATE"
2461
+ DATE
2462
+ "DECIMAL"
2463
+ DECIMAL
2464
+ "DOUBLE"
2465
+ DOUBLE
2466
+ "LONG"
2467
+ LONG
2468
+ "NAME"
2469
+ NAME
2470
+ "PATH"
2471
+ PATH
2472
+ "REFERENCE"
2473
+ REFERENCE
2474
+ "STRING"
2475
+ STRING
2476
+ "UNDEFINED"
2477
+ UNDEFINED
2478
+ "URI"
2479
+ URI
2480
+ "WEAKREFERENCE"
2481
+ WEAKREFERENCE
2482
+ }
2483
+
2484
+ enum MulticriteriaEvaluation {
2485
+ "The result criteria evaluates positive if all sub-criteria evaluate positive"
2486
+ ALL
2487
+ "The result criteria evaluates positive if any sub-criteria evaluates positive"
2488
+ ANY
2489
+ "The result criteria evaluates positive if no sub-criteria evaluates positive"
2490
+ NONE
2491
+ }
2492
+
2493
+ enum NodeNamingConflictResolutionStrategy {
2494
+ "FAIL"
2495
+ FAIL
2496
+ "RENAME"
2497
+ RENAME
2498
+ }
2499
+
2500
+ enum OrderType {
2501
+ "Ascendant order"
2502
+ ASC
2503
+ "Descendant order"
2504
+ DESC
2505
+ }
2506
+
2507
+ enum PasteMode {
2508
+ "COPY"
2509
+ COPY
2510
+ "MOVE"
2511
+ MOVE
2512
+ }
2513
+
2514
+ enum PathType {
2515
+ "The specified path is an ancestor, so all its descendants will be considered in the query"
2516
+ ANCESTOR
2517
+ "The specified path is a node itself, so only this node will be considered in the query"
2518
+ OWN
2519
+ "The specified path is a parent, so all its direct children will be considered in the query"
2520
+ PARENT
2521
+ }
2522
+
2523
+ enum PropertyEvaluation {
2524
+ "The property is absent"
2525
+ ABSENT
2526
+ "The property value is different from given one"
2527
+ DIFFERENT
2528
+ "The property value is equal to given one"
2529
+ EQUAL
2530
+ "The property is present"
2531
+ PRESENT
2532
+ }
2533
+
2534
+ enum PublicationStatus {
2535
+ "CONFLICT"
2536
+ CONFLICT
2537
+ "DELETED"
2538
+ DELETED
2539
+ "LIVE_MODIFIED"
2540
+ LIVE_MODIFIED
2541
+ "LIVE_ONLY"
2542
+ LIVE_ONLY
2543
+ "MANDATORY_LANGUAGE_UNPUBLISHABLE"
2544
+ MANDATORY_LANGUAGE_UNPUBLISHABLE
2545
+ "MANDATORY_LANGUAGE_VALID"
2546
+ MANDATORY_LANGUAGE_VALID
2547
+ "MARKED_FOR_DELETION"
2548
+ MARKED_FOR_DELETION
2549
+ "MODIFIED"
2550
+ MODIFIED
2551
+ "NOT_PUBLISHED"
2552
+ NOT_PUBLISHED
2553
+ "PUBLISHED"
2554
+ PUBLISHED
2555
+ "UNPUBLISHED"
2556
+ UNPUBLISHED
2557
+ }
2558
+
2559
+ enum QueryFunction {
2560
+ "Query function for lower case comparison"
2561
+ LOWER_CASE
2562
+ "Query function for node local name comparison"
2563
+ NODE_LOCAL_NAME
2564
+ "Query function for node name comparison"
2565
+ NODE_NAME
2566
+ "Query function for upper case comparison"
2567
+ UPPER_CASE
2568
+ }
2569
+
2570
+ "JCR query languages available to use for nodes querying"
2571
+ enum QueryLanguage {
2572
+ "SQL2 query language"
2573
+ SQL2
2574
+ "XPath query language"
2575
+ XPATH
2576
+ }
2577
+
2578
+ "The target position of reordered child nodes"
2579
+ enum ReorderedChildrenPosition {
2580
+ "Specified children are sorted in a requested order and placed at the top, before all remaining children"
2581
+ FIRST
2582
+ "Specified children are sorted in a requested order, but remaining are kept at their places"
2583
+ INPLACE
2584
+ "Specified children are sorted in a requested order and placed at the end of the list after the remaining children"
2585
+ LAST
2586
+ }
2587
+
2588
+ enum SortType {
2589
+ "Ascendant order"
2590
+ ASC
2591
+ "Descendant order"
2592
+ DESC
2593
+ }
2594
+
2595
+ "The target scheduler(s)"
2596
+ enum TargetScheduler {
2597
+ "Both persisted and RAM schedulers will be used"
2598
+ BOTH
2599
+ "RAM scheduler will be used"
2600
+ RAM_SCHEDULER
2601
+ "Persisted scheduler will be used"
2602
+ SCHEDULER
2603
+ }
2604
+
2605
+ enum TokenState {
2606
+ "ACTIVE"
2607
+ ACTIVE
2608
+ "DISABLED"
2609
+ DISABLED
2610
+ }
2611
+
2612
+ enum WipStatus {
2613
+ "Work in progress for all languages"
2614
+ ALL_CONTENT
2615
+ "Work in progress disabled"
2616
+ DISABLED
2617
+ "Work in progress for specified languages"
2618
+ LANGUAGES
2619
+ }
2620
+
2621
+ "JCR workspace to use for the operations"
2622
+ enum Workspace {
2623
+ "Edit workspace"
2624
+ EDIT
2625
+ "Live workspace"
2626
+ LIVE
2627
+ }
2628
+
2629
+ "Info about a node to be reproduced at (moved or copied to) another parent node"
2630
+ input InputCarriedJCRNode {
2631
+ "The name of the node at the new location or null if its current name should be preserved"
2632
+ destName: String
2633
+ "Path or UUID of the destination parent node to copy/move the node to"
2634
+ destParentPathOrId: String!
2635
+ "Path or UUID of the node to be copied/moved"
2636
+ pathOrId: String!
2637
+ }
2638
+
2639
+ input InputContextEntryInput {
2640
+ key: String
2641
+ value: [String]
2642
+ }
2643
+
2644
+ "Input object representing either a sub-filter (so that nested conditional logic can be composed), or a condition to filter by a single field"
2645
+ input InputFieldFilterInput {
2646
+ "The way to evaluate the property; null indicates default (EQUAL)"
2647
+ evaluation: FieldEvaluation
2648
+ "Either a non-null sub-filter, or null in case the input object represents a simple field filter configured via its other properties"
2649
+ fieldFilter: InputFieldFiltersInput
2650
+ "The name of the field or its alias to filter by"
2651
+ fieldName: String
2652
+ "The value to evaluate the field against (for single-valued operations)"
2653
+ value: String
2654
+ "The values to evaluate the field against (for multi-valued operations)"
2655
+ values: [String]
2656
+ }
2657
+
2658
+ "Filter any GraphQL node based on a sub-fields values"
2659
+ input InputFieldFiltersInput {
2660
+ "Individual property filters"
2661
+ filters: [InputFieldFilterInput]!
2662
+ "The way to combine multiple individual property filters; null indicates default (ALL)"
2663
+ multi: MulticriteriaEvaluation
2664
+ }
2665
+
2666
+ "Group entries according to criteria"
2667
+ input InputFieldGroupingInput {
2668
+ "fieldName to group on"
2669
+ fieldName: String!
2670
+ "grouping type"
2671
+ groupingType: GroupingType!
2672
+ "specified groups"
2673
+ groups: [String]!
2674
+ }
2675
+
2676
+ "object with fieldName and sort direction (ASC/DESC)"
2677
+ input InputFieldSorterInput {
2678
+ "fieldName to sort"
2679
+ fieldName: String
2680
+ "ignore case when sorting"
2681
+ ignoreCase: Boolean
2682
+ "direction of the sort"
2683
+ sortType: SortType
2684
+ }
2685
+
2686
+ "An optional part of the JCR node criteria to filter nodes, specifically by their arbitrary properties"
2687
+ input InputGqlJcrNodeConstraintInput {
2688
+ "A list of child constraint input for all composition"
2689
+ all: [InputGqlJcrNodeConstraintInput]
2690
+ "A list of child constraint input for any composition"
2691
+ any: [InputGqlJcrNodeConstraintInput]
2692
+ "A search expression to match the node property value(s) against, either specific property only or all node properties, dependent on the 'property' parameter value passed"
2693
+ contains: String
2694
+ "A value to compare the node property value to, using the 'equals to' operator"
2695
+ equals: String
2696
+ "A value to compare the node property value to, using the 'exists' operator"
2697
+ exists: Boolean
2698
+ "The query function name for the node for comparison"
2699
+ function: QueryFunction
2700
+ "A value to compare the node property value to, using the 'greater than' operator"
2701
+ gt: String
2702
+ "A value to compare the node property value to, using the 'greater than or equals to' operator"
2703
+ gte: String
2704
+ "A value to pick the last days for node property date value, using the 'lastDays' operator"
2705
+ lastDays: Int
2706
+ "A value to compare the node property value to, using the 'like' operator"
2707
+ like: String
2708
+ "A value to compare the node property value to, using the 'less than' operator"
2709
+ lt: String
2710
+ "A value to compare the node property value to, using the 'less than or equals to' operator"
2711
+ lte: String
2712
+ "A list of child constraint input for none composition"
2713
+ none: [InputGqlJcrNodeConstraintInput]
2714
+ "A value to compare the node property value to, using the 'not equals to' operator"
2715
+ notEquals: String
2716
+ "The name of the node property to compare/match; may be null when optional or not applicable, dependent on other parameter values"
2717
+ property: String
2718
+ }
2719
+
2720
+ "Node criterias"
2721
+ input InputGqlJcrNodeCriteriaInput {
2722
+ "Language to access node properties in"
2723
+ language: String
2724
+ "Additional constraint to filter nodes by their arbitrary properties"
2725
+ nodeConstraint: InputGqlJcrNodeConstraintInput
2726
+ "The type of nodes to query"
2727
+ nodeType: String!
2728
+ "Ordering strategies"
2729
+ ordering: InputGqlOrdering
2730
+ "The exact meaning of the paths field"
2731
+ pathType: PathType
2732
+ "Paths that restrict areas to fetch nodes from; the exact meaning is defined by the pathType field; null or empty collection means no path restrictions"
2733
+ paths: [String]
2734
+ }
2735
+
2736
+ "Ordering"
2737
+ input InputGqlOrdering {
2738
+ "ASC or DESC order"
2739
+ orderType: OrderType
2740
+ "The property to order by"
2741
+ property: String
2742
+ }
2743
+
2744
+ "GraphQL representation of a JCR node to be created"
2745
+ input InputJCRNode {
2746
+ "The collection of sub nodes to create"
2747
+ children: [InputJCRNode]
2748
+ "The collection of mixins to add to the node"
2749
+ mixins: [String]
2750
+ "The name of the node to create"
2751
+ name: String!
2752
+ "The primary node type of the node to create"
2753
+ primaryNodeType: String!
2754
+ "The collection of properties to set to the node"
2755
+ properties: [InputJCRProperty]
2756
+ "If true, use the next available name for a node, appending if needed numbers. Default is false"
2757
+ useAvailableNodeName: Boolean
2758
+ }
2759
+
2760
+ "GraphQL representation of a JCR node to be created"
2761
+ input InputJCRNodeWithParent {
2762
+ "The collection of sub nodes to create"
2763
+ children: [InputJCRNode]
2764
+ "The collection of mixins to add to the node"
2765
+ mixins: [String]
2766
+ "The name of the node to create"
2767
+ name: String!
2768
+ "The parent path or id where the node will be created"
2769
+ parentPathOrId: String!
2770
+ "The primary node type of the node to create"
2771
+ primaryNodeType: String!
2772
+ "The collection of properties to set to the node"
2773
+ properties: [InputJCRProperty]
2774
+ "If true, use the next available name for a node, appending if needed numbers. Default is false"
2775
+ useAvailableNodeName: Boolean
2776
+ }
2777
+
2778
+ "GraphQL representation of a JCR property to set"
2779
+ input InputJCRProperty {
2780
+ "The language in which the property will be set (for internationalized properties"
2781
+ language: String
2782
+ "The name of the property to set"
2783
+ name: String!
2784
+ "The option of the property"
2785
+ option: JCRPropertyOption
2786
+ "The type of the property"
2787
+ type: JCRPropertyType
2788
+ "The value to set (for single valued properties)"
2789
+ value: String
2790
+ "The values to set (for multivalued properties)"
2791
+ values: [String]
2792
+ }
2793
+
2794
+ "Node properties selection"
2795
+ input InputNodePropertiesInput {
2796
+ "Individual property filters"
2797
+ filters: [InputNodePropertyInput]!
2798
+ "The way to combine multiple individual property filters; null indicates default (ALL)"
2799
+ multi: MulticriteriaEvaluation
2800
+ }
2801
+
2802
+ "Node property selection"
2803
+ input InputNodePropertyInput {
2804
+ "The way to evaluate the property; null indicates default (EQUAL)"
2805
+ evaluation: PropertyEvaluation
2806
+ "Language to use when evaluating the property"
2807
+ language: String
2808
+ "The name of the property to filter by"
2809
+ property: String!
2810
+ "The value to evaluate the property against"
2811
+ value: String
2812
+ }
2813
+
2814
+ "Node types selection"
2815
+ input InputNodeTypesInput {
2816
+ "The way to combine multiple type criteria; null indicates default (ANY)"
2817
+ multi: MulticriteriaEvaluation
2818
+ "Node type names required for a node to pass the filter"
2819
+ types: [String]!
2820
+ }
2821
+
2822
+ "Input for nodetypes list"
2823
+ input InputNodeTypesListInput {
2824
+ "Consider sub-types when checking for included/excluded nodetypes (default true)"
2825
+ considerSubTypes: Boolean
2826
+ "Exclude the types, specified by this list (also considering sub-types, if considerSubTypes is true)"
2827
+ excludeTypes: [String]
2828
+ "Include abstract types (default true)"
2829
+ includeAbstract: Boolean
2830
+ "Include mixin types (default true)"
2831
+ includeMixins: Boolean
2832
+ "Include non mixin types (default true)"
2833
+ includeNonMixins: Boolean
2834
+ "Only include types specified by this list (also considering sub-types, if considerSubTypes is true)"
2835
+ includeTypes: [String]
2836
+ "Filter on nodetypes defined in these modules"
2837
+ modules: [String]
2838
+ "Consider only nodetypes for the specified site"
2839
+ siteKey: String
2840
+ }
2841
+
2842
+ "Request attribute that can be use by rendering API"
2843
+ input InputRenderRequestAttributeInput {
2844
+ "The name of the request attribute"
2845
+ name: String!
2846
+ "The value of the request attribute"
2847
+ value: String!
2848
+ }
2849
+
2850
+ input InputVanityUrl {
2851
+ "true if the URL mapping is activated or false if it is not activated"
2852
+ active: Boolean
2853
+ "true whether this URL mapping is the default one for the language"
2854
+ defaultMapping: Boolean!
2855
+ "The language of the content object to which the vanity URL maps to"
2856
+ language: String!
2857
+ "The vanity URL"
2858
+ url: String!
2859
+ }
2860
+
2861
+ "Work in progress information"
2862
+ input InputwipInfo {
2863
+ "The languages set for Work in progress"
2864
+ languages: [String]
2865
+ "Get WIP status"
2866
+ status: WipStatus
2867
+ }
2868
+
2869
+
2870
+ "Long type"
2871
+ scalar Long
2872
+
2873
+ "Date type"
2874
+ scalar Date