@jahia/cypress 3.33.0 → 3.35.0

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 (2) hide show
  1. package/package.json +1 -1
  2. package/schema.graphql +139 -98
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jahia/cypress",
3
- "version": "3.33.0",
3
+ "version": "3.35.0",
4
4
  "scripts": {
5
5
  "build": "tsc",
6
6
  "lint": "eslint src -c .eslintrc.json --ext .ts"
package/schema.graphql CHANGED
@@ -100,6 +100,8 @@ interface JCRNode {
100
100
  defaultWipInfo: wipInfo
101
101
  "Returns the node definition that applies to this node."
102
102
  definition: JCRNodeDefinition
103
+ "The depth in the JCR Tree of the JCR node this object represents"
104
+ depth: Int!
103
105
  "GraphQL representation of a descendant node, based on its relative path"
104
106
  descendant(
105
107
  "Name or relative path of the sub node"
@@ -123,6 +125,8 @@ interface JCRNode {
123
125
  last: Int,
124
126
  "fetching only the first certain number of nodes"
125
127
  limit: Int,
128
+ "Maximum depth in JCR tree for descendants from the current node, 0 (or less) for all sub nodes, 1 for one sub level, etc"
129
+ maxDepth: Int,
126
130
  "fetching only nodes after this node (inclusive)"
127
131
  offset: Int,
128
132
  "Filter of descendant nodes by their property values; null to avoid such filtering"
@@ -749,6 +753,8 @@ type GenericJCRNode implements JCRNode {
749
753
  defaultWipInfo: wipInfo
750
754
  "Returns the node definition that applies to this node."
751
755
  definition: JCRNodeDefinition
756
+ "The depth in the JCR Tree of the JCR node this object represents"
757
+ depth: Int!
752
758
  "GraphQL representation of a descendant node, based on its relative path"
753
759
  descendant(
754
760
  "Name or relative path of the sub node"
@@ -772,6 +778,8 @@ type GenericJCRNode implements JCRNode {
772
778
  last: Int,
773
779
  "fetching only the first certain number of nodes"
774
780
  limit: Int,
781
+ "Maximum depth in JCR tree for descendants from the current node, 0 (or less) for all sub nodes, 1 for one sub level, etc"
782
+ maxDepth: Int,
775
783
  "fetching only nodes after this node (inclusive)"
776
784
  offset: Int,
777
785
  "Filter of descendant nodes by their property values; null to avoid such filtering"
@@ -998,29 +1006,36 @@ type GqlBackgroundJob {
998
1006
  group: String
999
1007
  "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"
1000
1008
  jobBooleanProperty(
1001
- "The job name"
1009
+ "The name of the property"
1002
1010
  name: String
1003
1011
  ): Boolean
1012
+ "Job description"
1013
+ jobDescription: String
1004
1014
  "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"
1005
1015
  jobIntegerProperty(
1006
- "The job name"
1016
+ "The name of the property"
1007
1017
  name: String
1008
1018
  ): Int
1009
1019
  "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"
1010
1020
  jobLongProperty(
1011
- "The job name"
1021
+ "The name of the property"
1012
1022
  name: String
1013
1023
  ): Long
1014
1024
  "The job state is different from the status, it reflect the last action done on the job instance (Started, Vetoed, Finished)"
1015
1025
  jobState: GqlBackgroundJobState
1016
1026
  "The job status"
1017
1027
  jobStatus: GqlBackgroundJobStatus
1028
+ "List of strings property from the job map (eg. publicationInfos, publicationPaths)"
1029
+ jobStringListProperty(
1030
+ "The name of the property"
1031
+ name: String
1032
+ ): [String]
1018
1033
  "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"
1019
1034
  jobStringProperty(
1020
- "The job name"
1035
+ "The name of the property"
1021
1036
  name: String
1022
1037
  ): String
1023
- "The job name"
1038
+ "The name of the property"
1024
1039
  name: String
1025
1040
  "GraphQL representation of publication job"
1026
1041
  publicationJob: GqlPublicationBackgroundJob
@@ -1030,6 +1045,38 @@ type GqlBackgroundJob {
1030
1045
  userKey: String
1031
1046
  }
1032
1047
 
1048
+ "A connection to a list of items."
1049
+ type GqlBackgroundJobConnection {
1050
+ "a list of edges"
1051
+ edges: [GqlBackgroundJobEdge]
1052
+ "a list of nodes"
1053
+ nodes: [GqlBackgroundJob]
1054
+ "details about this specific page"
1055
+ pageInfo: PageInfo!
1056
+ }
1057
+
1058
+ "An edge in a connection"
1059
+ type GqlBackgroundJobEdge {
1060
+ "cursor marks a unique position or index into the connection"
1061
+ cursor: String!
1062
+ "index in the connection"
1063
+ index: Int
1064
+ "The item at the end of the edge"
1065
+ node: GqlBackgroundJob
1066
+ }
1067
+
1068
+ "Channel information"
1069
+ type GqlChannel {
1070
+ "Channel label (not localized)"
1071
+ displayName: String
1072
+ "Return true if channel is visible, otherwise false"
1073
+ isVisible: Boolean
1074
+ "Channel name/identifier"
1075
+ name: String
1076
+ "Return variants for this channel, if available"
1077
+ variants: [GqlVariant]
1078
+ }
1079
+
1033
1080
  "Condition for override item"
1034
1081
  type GqlCondition {
1035
1082
  "Item will apply only on this nodetype"
@@ -1109,58 +1156,6 @@ type GqlDashboard {
1109
1156
  toolsAccess: Boolean
1110
1157
  }
1111
1158
 
1112
- type GqlDistributedSessionsMutation {
1113
- "Delete a session"
1114
- removeSession(
1115
- "Session id"
1116
- id: String!
1117
- ): Boolean
1118
- }
1119
-
1120
- type GqlDistributedSessionsQuery {
1121
- localSessions(
1122
- "fetching only nodes after this node (exclusive)"
1123
- after: String,
1124
- "fetching only nodes before this node (exclusive)"
1125
- before: String,
1126
- "Filter by graphQL fields values"
1127
- fieldFilter: InputFieldFiltersInput,
1128
- "Group fields by criteria"
1129
- fieldGrouping: InputFieldGroupingInput,
1130
- "sort by GraphQL field values"
1131
- fieldSorter: InputFieldSorterInput,
1132
- "fetching only the first certain number of nodes"
1133
- first: Int,
1134
- "fetching only the last certain number of nodes"
1135
- last: Int,
1136
- "fetching only the first certain number of nodes"
1137
- limit: Int,
1138
- "fetching only nodes after this node (inclusive)"
1139
- offset: Int
1140
- ): GqlSessionConnection
1141
- sessions(
1142
- "fetching only nodes after this node (exclusive)"
1143
- after: String,
1144
- "fetching only nodes before this node (exclusive)"
1145
- before: String,
1146
- "Filter by graphQL fields values"
1147
- fieldFilter: InputFieldFiltersInput,
1148
- "Group fields by criteria"
1149
- fieldGrouping: InputFieldGroupingInput,
1150
- "sort by GraphQL field values"
1151
- fieldSorter: InputFieldSorterInput,
1152
- "fetching only the first certain number of nodes"
1153
- first: Int,
1154
- "fetching only the last certain number of nodes"
1155
- last: Int,
1156
- "fetching only the first certain number of nodes"
1157
- limit: Int,
1158
- "fetching only nodes after this node (inclusive)"
1159
- offset: Int
1160
- ): GqlSessionConnection
1161
- sessionsCount: Int
1162
- }
1163
-
1164
1159
  type GqlEditorForm {
1165
1160
  "Retrieve a description text for the form, might contain explanations on how to use the form"
1166
1161
  description: String
@@ -1380,9 +1375,31 @@ type GqlHealthCheck {
1380
1375
  status: GqlProbeStatus
1381
1376
  }
1382
1377
 
1383
- type GqlHzPartition {
1384
- id: Int
1385
- owner: String
1378
+ "jContent API"
1379
+ type GqlJContent {
1380
+ "Returns all available channels"
1381
+ channels: [GqlChannel]
1382
+ "Returns html with marked differences"
1383
+ diffHtml(
1384
+ "New html"
1385
+ newHtml: String,
1386
+ "Original html"
1387
+ originalHtml: String
1388
+ ): String
1389
+ }
1390
+
1391
+ "jContent API"
1392
+ type GqlJContentMutations {
1393
+ "Flushes cache for a page, checks adminCache permission and node type"
1394
+ flushPageCache(
1395
+ "Page path"
1396
+ pagePath: String!
1397
+ ): Boolean
1398
+ "Flushes cache for a site, will resolve site node if the path supplied is not a site, checks adminCache permission"
1399
+ flushSiteCache(
1400
+ "Site path"
1401
+ sitePath: String!
1402
+ ): Boolean
1386
1403
  }
1387
1404
 
1388
1405
  type GqlJcrImageTransformMutation {
@@ -1582,31 +1599,38 @@ type GqlPublicationBackgroundJob {
1582
1599
  group: String
1583
1600
  "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"
1584
1601
  jobBooleanProperty(
1585
- "The job name"
1602
+ "The name of the property"
1586
1603
  name: String
1587
1604
  ): Boolean
1605
+ "Job description"
1606
+ jobDescription: String
1588
1607
  "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"
1589
1608
  jobIntegerProperty(
1590
- "The job name"
1609
+ "The name of the property"
1591
1610
  name: String
1592
1611
  ): Int
1593
1612
  "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"
1594
1613
  jobLongProperty(
1595
- "The job name"
1614
+ "The name of the property"
1596
1615
  name: String
1597
1616
  ): Long
1598
1617
  "The job state is different from the status, it reflect the last action done on the job instance (Started, Vetoed, Finished)"
1599
1618
  jobState: GqlBackgroundJobState
1600
1619
  "The job status"
1601
1620
  jobStatus: GqlBackgroundJobStatus
1621
+ "List of strings property from the job map (eg. publicationInfos, publicationPaths)"
1622
+ jobStringListProperty(
1623
+ "The name of the property"
1624
+ name: String
1625
+ ): [String]
1602
1626
  "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"
1603
1627
  jobStringProperty(
1604
- "The job name"
1628
+ "The name of the property"
1605
1629
  name: String
1606
1630
  ): String
1607
1631
  "Publication language"
1608
1632
  language: String
1609
- "The job name"
1633
+ "The name of the property"
1610
1634
  name: String
1611
1635
  "The site key. The returned value will be null in case the job doesn't have associated site key"
1612
1636
  siteKey: String
@@ -1644,8 +1668,29 @@ type GqlPublicationInfo {
1644
1668
 
1645
1669
  "Scheduler object which allows to access to background jobs"
1646
1670
  type GqlScheduler {
1647
- "List of active jobs"
1648
- jobs: [GqlBackgroundJob]
1671
+ "List of active jobs (deprecated)"
1672
+ jobs: [GqlBackgroundJob] @deprecated(reason: "Use paginatedJobs instead")
1673
+ "List of active jobs (paginated)"
1674
+ paginatedJobs(
1675
+ "fetching only nodes after this node (exclusive)"
1676
+ after: String,
1677
+ "fetching only nodes before this node (exclusive)"
1678
+ before: String,
1679
+ "Exclude jobs with these statuses"
1680
+ excludeStatuses: [GqlBackgroundJobStatus],
1681
+ "fetching only the first certain number of nodes"
1682
+ first: Int,
1683
+ "The group jobs belong to"
1684
+ group: String,
1685
+ "Include jobs with these statuses"
1686
+ includeStatuses: [GqlBackgroundJobStatus],
1687
+ "fetching only the last certain number of nodes"
1688
+ last: Int,
1689
+ "fetching only the first certain number of nodes"
1690
+ limit: Int,
1691
+ "fetching only nodes after this node (inclusive)"
1692
+ offset: Int
1693
+ ): GqlBackgroundJobConnection
1649
1694
  }
1650
1695
 
1651
1696
  "API Scope"
@@ -1656,34 +1701,22 @@ type GqlScope {
1656
1701
  name: String
1657
1702
  }
1658
1703
 
1659
- type GqlSession {
1660
- cost: Long
1661
- creationTime: String
1662
- id: String
1663
- lastAccessedTime: String
1664
- maxInactiveIntervalInSeconds: Int
1665
- partition: GqlHzPartition
1666
- user: User
1667
- }
1668
-
1669
- "A connection to a list of items."
1670
- type GqlSessionConnection {
1671
- "a list of edges"
1672
- edges: [GqlSessionEdge]
1673
- "a list of nodes"
1674
- nodes: [GqlSession]
1675
- "details about this specific page"
1676
- pageInfo: PageInfo!
1704
+ "Variant information for a given channel"
1705
+ type GqlVariant {
1706
+ "Variant display name/label (not localized)"
1707
+ displayName: String
1708
+ "Variant dimension (width x height) if available"
1709
+ imageSize: GqlVariantDimension
1710
+ "Variant name/identifier"
1711
+ name: String
1677
1712
  }
1678
1713
 
1679
- "An edge in a connection"
1680
- type GqlSessionEdge {
1681
- "cursor marks a unique position or index into the connection"
1682
- cursor: String!
1683
- "index in the connection"
1684
- index: Int
1685
- "The item at the end of the edge"
1686
- node: GqlSession
1714
+ "Represents dimensions (width, height) of a variant"
1715
+ type GqlVariantDimension {
1716
+ "Variant height"
1717
+ height: String
1718
+ "Variant width"
1719
+ width: String
1687
1720
  }
1688
1721
 
1689
1722
  type GqlWorkflowEvent {
@@ -2630,6 +2663,8 @@ type JCRSite implements JCRNode {
2630
2663
  defaultWipInfo: wipInfo
2631
2664
  "Returns the node definition that applies to this node."
2632
2665
  definition: JCRNodeDefinition
2666
+ "The depth in the JCR Tree of the JCR node this object represents"
2667
+ depth: Int!
2633
2668
  "GraphQL representation of a descendant node, based on its relative path"
2634
2669
  descendant(
2635
2670
  "Name or relative path of the sub node"
@@ -2653,6 +2688,8 @@ type JCRSite implements JCRNode {
2653
2688
  last: Int,
2654
2689
  "fetching only the first certain number of nodes"
2655
2690
  limit: Int,
2691
+ "Maximum depth in JCR tree for descendants from the current node, 0 (or less) for all sub nodes, 1 for one sub level, etc"
2692
+ maxDepth: Int,
2656
2693
  "fetching only nodes after this node (inclusive)"
2657
2694
  offset: Int,
2658
2695
  "Filter of descendant nodes by their property values; null to avoid such filtering"
@@ -2682,7 +2719,7 @@ type JCRSite implements JCRNode {
2682
2719
  "The name of the permission"
2683
2720
  permissionName: String!
2684
2721
  ): Boolean
2685
- "Returns the node of the home page"
2722
+ "Returns the node of the home page or null if no home page is defined or is not accessible"
2686
2723
  homePage: JCRNode
2687
2724
  "Retrieves a collection of module IDs, which are installed on the site, the node belongs to"
2688
2725
  installedModules: [String]
@@ -2929,8 +2966,6 @@ type JahiaAdminMutation {
2929
2966
  "Service name"
2930
2967
  service: String!
2931
2968
  ): Boolean
2932
- "Distributed sessions admin"
2933
- distributedSessions: GqlDistributedSessionsMutation
2934
2969
  "Shutdown the server"
2935
2970
  shutdown(
2936
2971
  "Do not send the shutdown event"
@@ -2953,8 +2988,6 @@ type JahiaAdminQuery {
2953
2988
  ): GqlConfigurationQuery
2954
2989
  "Details about the database Jahia is connected to"
2955
2990
  database: JahiaDatabase
2956
- "Distributed sessions admin"
2957
- distributedSessions: GqlDistributedSessionsQuery
2958
2991
  "HealthCheck node"
2959
2992
  healthCheck(
2960
2993
  "Returns only SAM probes with probe names included in this list"
@@ -3112,6 +3145,8 @@ type Mutation {
3112
3145
  admin: AdminMutation!
3113
3146
  "Main access field to the DX GraphQL Form mutation API"
3114
3147
  forms: GqlEditorFormMutations
3148
+ "Main access field to the jContent mutation API"
3149
+ jcontent: GqlJContentMutations
3115
3150
  "JCR Mutation"
3116
3151
  jcr(
3117
3152
  "Should save"
@@ -3328,6 +3363,8 @@ type Query {
3328
3363
  dashboard: GqlDashboard
3329
3364
  "Main access field to the DX GraphQL Form API"
3330
3365
  forms: GqlEditorForms
3366
+ "Main access field to the jContent API"
3367
+ jcontent: GqlJContent
3331
3368
  "JCR Queries"
3332
3369
  jcr(
3333
3370
  "The name of the workspace to fetch the node from; either EDIT, LIVE, or null to use EDIT by default"
@@ -3686,6 +3723,8 @@ type VanityUrl implements JCRNode {
3686
3723
  defaultWipInfo: wipInfo
3687
3724
  "Returns the node definition that applies to this node."
3688
3725
  definition: JCRNodeDefinition
3726
+ "The depth in the JCR Tree of the JCR node this object represents"
3727
+ depth: Int!
3689
3728
  "GraphQL representation of a descendant node, based on its relative path"
3690
3729
  descendant(
3691
3730
  "Name or relative path of the sub node"
@@ -3709,6 +3748,8 @@ type VanityUrl implements JCRNode {
3709
3748
  last: Int,
3710
3749
  "fetching only the first certain number of nodes"
3711
3750
  limit: Int,
3751
+ "Maximum depth in JCR tree for descendants from the current node, 0 (or less) for all sub nodes, 1 for one sub level, etc"
3752
+ maxDepth: Int,
3712
3753
  "fetching only nodes after this node (inclusive)"
3713
3754
  offset: Int,
3714
3755
  "Filter of descendant nodes by their property values; null to avoid such filtering"