@resolution/jira-api-client 0.1.0 → 0.1.2

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 (201) hide show
  1. package/CHANGELOG.md +22 -0
  2. package/package.json +10 -3
  3. package/.eslintrc.js +0 -3
  4. package/config/api-typescript-generator.config.ts +0 -91
  5. package/config/compare-schemas.ts +0 -307
  6. package/src/index.ts +0 -47
  7. package/src/openapi/platform/base-jira-platform-api-client.ts +0 -2298
  8. package/src/openapi/platform/core/common-http-client.ts +0 -723
  9. package/src/openapi/platform/core/common-http-service.ts +0 -22
  10. package/src/openapi/platform/core/common-validation-schema-storage.ts +0 -105
  11. package/src/openapi/platform/models/announcement-banner.ts +0 -59
  12. package/src/openapi/platform/models/app-data-policies.ts +0 -79
  13. package/src/openapi/platform/models/app-migration.ts +0 -172
  14. package/src/openapi/platform/models/app-properties.ts +0 -32
  15. package/src/openapi/platform/models/audit-records.ts +0 -140
  16. package/src/openapi/platform/models/avatars.ts +0 -48
  17. package/src/openapi/platform/models/classification-levels.ts +0 -58
  18. package/src/openapi/platform/models/common.ts +0 -2669
  19. package/src/openapi/platform/models/dashboards.ts +0 -849
  20. package/src/openapi/platform/models/dynamic-modules.ts +0 -121
  21. package/src/openapi/platform/models/filter-sharing.ts +0 -103
  22. package/src/openapi/platform/models/filters.ts +0 -319
  23. package/src/openapi/platform/models/group-and-user-picker.ts +0 -85
  24. package/src/openapi/platform/models/groups.ts +0 -247
  25. package/src/openapi/platform/models/issue-attachments.ts +0 -290
  26. package/src/openapi/platform/models/issue-comment-properties.ts +0 -27
  27. package/src/openapi/platform/models/issue-comments.ts +0 -91
  28. package/src/openapi/platform/models/issue-custom-field-configuration-apps.ts +0 -96
  29. package/src/openapi/platform/models/issue-custom-field-contexts.ts +0 -1072
  30. package/src/openapi/platform/models/issue-custom-field-options-apps.ts +0 -273
  31. package/src/openapi/platform/models/issue-custom-field-options.ts +0 -283
  32. package/src/openapi/platform/models/issue-custom-field-values-apps.ts +0 -118
  33. package/src/openapi/platform/models/issue-field-configurations.ts +0 -435
  34. package/src/openapi/platform/models/issue-fields.ts +0 -392
  35. package/src/openapi/platform/models/issue-link-types.ts +0 -28
  36. package/src/openapi/platform/models/issue-links.ts +0 -185
  37. package/src/openapi/platform/models/issue-notification-schemes.ts +0 -370
  38. package/src/openapi/platform/models/issue-priorities.ts +0 -196
  39. package/src/openapi/platform/models/issue-properties.ts +0 -259
  40. package/src/openapi/platform/models/issue-remote-links.ts +0 -207
  41. package/src/openapi/platform/models/issue-resolutions.ts +0 -180
  42. package/src/openapi/platform/models/issue-search.ts +0 -367
  43. package/src/openapi/platform/models/issue-security-level.ts +0 -76
  44. package/src/openapi/platform/models/issue-security-schemes.ts +0 -496
  45. package/src/openapi/platform/models/issue-type-schemes.ts +0 -290
  46. package/src/openapi/platform/models/issue-type-screen-schemes.ts +0 -286
  47. package/src/openapi/platform/models/issue-types.ts +0 -66
  48. package/src/openapi/platform/models/issue-votes.ts +0 -38
  49. package/src/openapi/platform/models/issue-watchers.ts +0 -67
  50. package/src/openapi/platform/models/issue-worklogs.ts +0 -190
  51. package/src/openapi/platform/models/issues.ts +0 -1268
  52. package/src/openapi/platform/models/jira-expressions.ts +0 -578
  53. package/src/openapi/platform/models/jira-settings.ts +0 -118
  54. package/src/openapi/platform/models/jql-functions-apps.ts +0 -128
  55. package/src/openapi/platform/models/jql.ts +0 -783
  56. package/src/openapi/platform/models/labels.ts +0 -42
  57. package/src/openapi/platform/models/license-metrics.ts +0 -68
  58. package/src/openapi/platform/models/myself.ts +0 -29
  59. package/src/openapi/platform/models/permission-schemes.ts +0 -89
  60. package/src/openapi/platform/models/permissions.ts +0 -308
  61. package/src/openapi/platform/models/priority-schemes.ts +0 -527
  62. package/src/openapi/platform/models/project-avatars.ts +0 -29
  63. package/src/openapi/platform/models/project-classification-levels.ts +0 -24
  64. package/src/openapi/platform/models/project-components.ts +0 -231
  65. package/src/openapi/platform/models/project-email.ts +0 -27
  66. package/src/openapi/platform/models/project-features.ts +0 -78
  67. package/src/openapi/platform/models/project-permission-schemes.ts +0 -43
  68. package/src/openapi/platform/models/project-role-actors.ts +0 -107
  69. package/src/openapi/platform/models/project-roles.ts +0 -76
  70. package/src/openapi/platform/models/project-types.ts +0 -36
  71. package/src/openapi/platform/models/project-versions.ts +0 -216
  72. package/src/openapi/platform/models/projects.ts +0 -429
  73. package/src/openapi/platform/models/screen-schemes.ts +0 -192
  74. package/src/openapi/platform/models/screen-tab-fields.ts +0 -45
  75. package/src/openapi/platform/models/screens.ts +0 -171
  76. package/src/openapi/platform/models/server-info.ts +0 -100
  77. package/src/openapi/platform/models/service-registry.ts +0 -68
  78. package/src/openapi/platform/models/status.ts +0 -229
  79. package/src/openapi/platform/models/time-tracking.ts +0 -38
  80. package/src/openapi/platform/models/ui-modifications-apps.ts +0 -229
  81. package/src/openapi/platform/models/user-search.ts +0 -69
  82. package/src/openapi/platform/models/users.ts +0 -121
  83. package/src/openapi/platform/models/webhooks.ts +0 -307
  84. package/src/openapi/platform/models/workflow-scheme-drafts.ts +0 -58
  85. package/src/openapi/platform/models/workflow-scheme-project-associations.ts +0 -68
  86. package/src/openapi/platform/models/workflow-schemes.ts +0 -545
  87. package/src/openapi/platform/models/workflow-transition-properties.ts +0 -33
  88. package/src/openapi/platform/models/workflow-transition-rules.ts +0 -261
  89. package/src/openapi/platform/models/workflows.ts +0 -1943
  90. package/src/openapi/platform/services/announcement-banner-service.ts +0 -142
  91. package/src/openapi/platform/services/app-data-policies-service.ts +0 -136
  92. package/src/openapi/platform/services/app-migration-service.ts +0 -289
  93. package/src/openapi/platform/services/app-properties-service.ts +0 -441
  94. package/src/openapi/platform/services/application-roles-service.ts +0 -247
  95. package/src/openapi/platform/services/audit-records-service.ts +0 -164
  96. package/src/openapi/platform/services/avatars-service.ts +0 -769
  97. package/src/openapi/platform/services/classification-levels-service.ts +0 -131
  98. package/src/openapi/platform/services/dashboards-service.ts +0 -1721
  99. package/src/openapi/platform/services/dynamic-modules-service.ts +0 -127
  100. package/src/openapi/platform/services/filter-sharing-service.ts +0 -687
  101. package/src/openapi/platform/services/filters-service.ts +0 -1901
  102. package/src/openapi/platform/services/group-and-user-picker-service.ts +0 -224
  103. package/src/openapi/platform/services/groups-service.ts +0 -751
  104. package/src/openapi/platform/services/issue-attachments-service.ts +0 -900
  105. package/src/openapi/platform/services/issue-comment-properties-service.ts +0 -324
  106. package/src/openapi/platform/services/issue-comments-service.ts +0 -812
  107. package/src/openapi/platform/services/issue-custom-field-configuration-apps-service.ts +0 -277
  108. package/src/openapi/platform/services/issue-custom-field-contexts-service.ts +0 -1339
  109. package/src/openapi/platform/services/issue-custom-field-options-apps-service.ts +0 -994
  110. package/src/openapi/platform/services/issue-custom-field-options-service.ts +0 -651
  111. package/src/openapi/platform/services/issue-custom-field-values-apps-service.ts +0 -201
  112. package/src/openapi/platform/services/issue-field-configurations-service.ts +0 -1294
  113. package/src/openapi/platform/services/issue-fields-service.ts +0 -837
  114. package/src/openapi/platform/services/issue-link-types-service.ts +0 -360
  115. package/src/openapi/platform/services/issue-links-service.ts +0 -345
  116. package/src/openapi/platform/services/issue-navigator-settings-service.ts +0 -119
  117. package/src/openapi/platform/services/issue-notification-schemes-service.ts +0 -1209
  118. package/src/openapi/platform/services/issue-priorities-service.ts +0 -575
  119. package/src/openapi/platform/services/issue-properties-service.ts +0 -606
  120. package/src/openapi/platform/services/issue-remote-links-service.ts +0 -597
  121. package/src/openapi/platform/services/issue-resolutions-service.ts +0 -534
  122. package/src/openapi/platform/services/issue-search-service.ts +0 -1139
  123. package/src/openapi/platform/services/issue-security-level-service.ts +0 -250
  124. package/src/openapi/platform/services/issue-security-schemes-service.ts +0 -1240
  125. package/src/openapi/platform/services/issue-type-properties-service.ts +0 -325
  126. package/src/openapi/platform/services/issue-type-schemes-service.ts +0 -940
  127. package/src/openapi/platform/services/issue-type-screen-schemes-service.ts +0 -994
  128. package/src/openapi/platform/services/issue-types-service.ts +0 -679
  129. package/src/openapi/platform/services/issue-votes-service.ts +0 -221
  130. package/src/openapi/platform/services/issue-watchers-service.ts +0 -331
  131. package/src/openapi/platform/services/issue-worklog-properties-service.ts +0 -348
  132. package/src/openapi/platform/services/issue-worklogs-service.ts +0 -1089
  133. package/src/openapi/platform/services/issues-service.ts +0 -3346
  134. package/src/openapi/platform/services/jira-expressions-service.ts +0 -407
  135. package/src/openapi/platform/services/jira-settings-service.ts +0 -415
  136. package/src/openapi/platform/services/jql-functions-apps-service.ts +0 -219
  137. package/src/openapi/platform/services/jql-service.ts +0 -896
  138. package/src/openapi/platform/services/labels-service.ts +0 -89
  139. package/src/openapi/platform/services/license-metrics-service.ts +0 -216
  140. package/src/openapi/platform/services/myself-service.ts +0 -520
  141. package/src/openapi/platform/services/permission-schemes-service.ts +0 -926
  142. package/src/openapi/platform/services/permissions-service.ts +0 -407
  143. package/src/openapi/platform/services/priority-schemes-service.ts +0 -1001
  144. package/src/openapi/platform/services/project-avatars-service.ts +0 -341
  145. package/src/openapi/platform/services/project-categories-service.ts +0 -318
  146. package/src/openapi/platform/services/project-classification-levels-service.ts +0 -232
  147. package/src/openapi/platform/services/project-components-service.ts +0 -1332
  148. package/src/openapi/platform/services/project-email-service.ts +0 -161
  149. package/src/openapi/platform/services/project-features-service.ts +0 -207
  150. package/src/openapi/platform/services/project-key-and-name-validation-service.ts +0 -200
  151. package/src/openapi/platform/services/project-permission-schemes-service.ts +0 -384
  152. package/src/openapi/platform/services/project-properties-service.ts +0 -320
  153. package/src/openapi/platform/services/project-role-actors-service.ts +0 -627
  154. package/src/openapi/platform/services/project-roles-service.ts +0 -867
  155. package/src/openapi/platform/services/project-types-service.ts +0 -297
  156. package/src/openapi/platform/services/project-versions-service.ts +0 -1287
  157. package/src/openapi/platform/services/projects-service.ts +0 -2196
  158. package/src/openapi/platform/services/screen-schemes-service.ts +0 -334
  159. package/src/openapi/platform/services/screen-tab-fields-service.ts +0 -276
  160. package/src/openapi/platform/services/screen-tabs-service.ts +0 -421
  161. package/src/openapi/platform/services/screens-service.ts +0 -528
  162. package/src/openapi/platform/services/server-info-service.ts +0 -88
  163. package/src/openapi/platform/services/service-registry-service.ts +0 -89
  164. package/src/openapi/platform/services/status-service.ts +0 -498
  165. package/src/openapi/platform/services/tasks-service.ts +0 -159
  166. package/src/openapi/platform/services/time-tracking-service.ts +0 -386
  167. package/src/openapi/platform/services/ui-modifications-apps-service.ts +0 -403
  168. package/src/openapi/platform/services/user-properties-service.ts +0 -413
  169. package/src/openapi/platform/services/user-search-service.ts +0 -1214
  170. package/src/openapi/platform/services/users-service.ts +0 -1108
  171. package/src/openapi/platform/services/webhooks-service.ts +0 -458
  172. package/src/openapi/platform/services/workflow-scheme-drafts-service.ts +0 -1313
  173. package/src/openapi/platform/services/workflow-scheme-project-associations-service.ts +0 -189
  174. package/src/openapi/platform/services/workflow-schemes-service.ts +0 -1617
  175. package/src/openapi/platform/services/workflow-status-categories-service.ts +0 -151
  176. package/src/openapi/platform/services/workflow-statuses-service.ts +0 -176
  177. package/src/openapi/platform/services/workflow-transition-properties-service.ts +0 -388
  178. package/src/openapi/platform/services/workflow-transition-rules-service.ts +0 -485
  179. package/src/openapi/platform/services/workflows-service.ts +0 -3477
  180. package/src/openapi/platform/validation-schema-storage.ts +0 -186
  181. package/src/openapi/software/base-jira-software-api-client.ts +0 -447
  182. package/src/openapi/software/core/common-http-client.ts +0 -723
  183. package/src/openapi/software/core/common-http-service.ts +0 -22
  184. package/src/openapi/software/core/common-validation-schema-storage.ts +0 -105
  185. package/src/openapi/software/models/board.ts +0 -918
  186. package/src/openapi/software/services/backlog-service.ts +0 -160
  187. package/src/openapi/software/services/board-service.ts +0 -4189
  188. package/src/openapi/software/services/builds-service.ts +0 -571
  189. package/src/openapi/software/services/deployments-service.ts +0 -403
  190. package/src/openapi/software/services/dev-ops-components-service.ts +0 -371
  191. package/src/openapi/software/services/development-information-service.ts +0 -2357
  192. package/src/openapi/software/services/epic-service.ts +0 -854
  193. package/src/openapi/software/services/feature-flags-service.ts +0 -303
  194. package/src/openapi/software/services/issue-service.ts +0 -529
  195. package/src/openapi/software/services/operations-service.ts +0 -741
  196. package/src/openapi/software/services/remote-links-service.ts +0 -653
  197. package/src/openapi/software/services/security-information-service.ts +0 -495
  198. package/src/openapi/software/services/sprint-service.ts +0 -969
  199. package/src/openapi/software/validation-schema-storage.ts +0 -186
  200. package/tsconfig.build.json +0 -7
  201. package/tsconfig.json +0 -4
@@ -1,783 +0,0 @@
1
- // DO NOT EDIT!
2
- // This file is generated by "api-typescript-generator".
3
- // To update this file run "yarn build:openapi".
4
- import { z, type ZodTypeAny } from "zod";
5
-
6
- import type { CommonValidationSchemaStorage } from "../core/common-validation-schema-storage";
7
- import {
8
- type ErrorCollection,
9
- registerCommonValidationSchemas,
10
- } from "./common";
11
- /** A field auto-complete suggestion. */
12
- export interface AutoCompleteSuggestion {
13
- /**
14
- * The display name of a suggested item. If `fieldValue` or `predicateValue` are
15
- * provided, the matching text is highlighted with the HTML bold tag.
16
- */
17
- displayName?: string;
18
- /** The value of a suggested item. */
19
- value?: string;
20
- }
21
- /** The results from a JQL query. */
22
- export interface AutoCompleteSuggestions {
23
- /** The list of suggested item. */
24
- results?: AutoCompleteSuggestion[];
25
- }
26
- /**
27
- * A JQL query clause that consists of nested clauses. For example, `(labels in
28
- * (urgent, blocker) OR lastCommentedBy = currentUser()). Note that, where nesting
29
- * is not defined, the parser nests JQL clauses based on the operator precedence.
30
- * For example, "A OR B AND C" is parsed as "(A OR B) AND C". See Setting the
31
- * precedence of operators for more information about precedence in JQL queries.`
32
- */
33
- export interface CompoundClause {
34
- /** The list of nested clauses. */
35
- clauses: JqlQueryClause[];
36
- /** The operator between the clauses. */
37
- operator: "and" | "or" | "not";
38
- }
39
- /** The converted JQL queries. */
40
- export interface ConvertedJqlQueries {
41
- /**
42
- * List of queries containing user information that could not be mapped to an
43
- * existing user
44
- */
45
- queriesWithUnknownUsers?: JqlQueryWithUnknownUsers[];
46
- /**
47
- * The list of converted query strings with account IDs in place of user
48
- * identifiers.
49
- */
50
- queryStrings?: string[];
51
- }
52
- /**
53
- * A clause that asserts whether a field was changed. For example, `status CHANGED
54
- * AFTER startOfMonth(-1M)`.See
55
- * [CHANGED](https://confluence.atlassian.com/x/dgiiLQ#Advancedsearching-operatorsreference-CHANGEDCHANGED)
56
- * for more information about the CHANGED operator.
57
- */
58
- export interface FieldChangedClause {
59
- /**
60
- * A field used in a JQL query. See [Advanced searching - fields
61
- * reference](https://confluence.atlassian.com/x/dAiiLQ) for more information
62
- * about fields in JQL queries.
63
- */
64
- field: JqlQueryField;
65
- /** The operator applied to the field. */
66
- operator: "changed";
67
- /** The list of time predicates. */
68
- predicates: JqlQueryClauseTimePredicate[];
69
- }
70
- /** Details of a field that can be used in advanced searches. */
71
- export interface FieldReferenceData {
72
- /** Whether the field provide auto-complete suggestions. */
73
- auto?: "true" | "false";
74
- /** If the item is a custom field, the ID of the custom field. */
75
- cfid?: string;
76
- /** Whether this field has been deprecated. */
77
- deprecated?: "true" | "false";
78
- /** The searcher key of the field, only passed when the field is deprecated. */
79
- deprecatedSearcherKey?: string;
80
- /**
81
- * The display name contains the following:
82
- *
83
- * * for system fields, the field name. For example, `Summary`.
84
- * * for collapsed custom fields, the field name followed by a hyphen and then
85
- * the field name and field type. For example, `Component - Component[Dropdown]`.
86
- * * for other custom fields, the field name followed by a hyphen and then the
87
- * custom field ID. For example, `Component - cf[10061]`.
88
- */
89
- displayName?: string;
90
- /** The valid search operators for the field. */
91
- operators?: string[];
92
- /** Whether the field can be used in a query's `ORDER BY` clause. */
93
- orderable?: "true" | "false";
94
- /** Whether the content of this field can be searched. */
95
- searchable?: "true" | "false";
96
- /** The data types of items in the field. */
97
- types?: string[];
98
- /** The field identifier. */
99
- value?: string;
100
- }
101
- /**
102
- * A clause that asserts the current value of a field. For example, `summary ~
103
- * test`.
104
- */
105
- export interface FieldValueClause {
106
- /**
107
- * A field used in a JQL query. See [Advanced searching - fields
108
- * reference](https://confluence.atlassian.com/x/dAiiLQ) for more information
109
- * about fields in JQL queries.
110
- */
111
- field: JqlQueryField;
112
- /** Details of an operand in a JQL clause. */
113
- operand: JqlQueryClauseOperand;
114
- /** The operator between the field and operand. */
115
- operator:
116
- | "="
117
- | "!="
118
- | ">"
119
- | "<"
120
- | ">="
121
- | "<="
122
- | "in"
123
- | "not in"
124
- | "~"
125
- | "~="
126
- | "is"
127
- | "is not";
128
- }
129
- /**
130
- * A clause that asserts a previous value of a field. For example, `status WAS
131
- * "Resolved" BY currentUser() BEFORE "2019/02/02"`. See
132
- * [WAS](https://confluence.atlassian.com/x/dgiiLQ#Advancedsearching-operatorsreference-WASWAS)
133
- * for more information about the WAS operator.
134
- */
135
- export interface FieldWasClause {
136
- /**
137
- * A field used in a JQL query. See [Advanced searching - fields
138
- * reference](https://confluence.atlassian.com/x/dAiiLQ) for more information
139
- * about fields in JQL queries.
140
- */
141
- field: JqlQueryField;
142
- /** Details of an operand in a JQL clause. */
143
- operand: JqlQueryClauseOperand;
144
- /** The operator between the field and operand. */
145
- operator: "was" | "was in" | "was not in" | "was not";
146
- /** The list of time predicates. */
147
- predicates: JqlQueryClauseTimePredicate[];
148
- }
149
- /**
150
- * An operand that is a function. See [Advanced searching - functions
151
- * reference](https://confluence.atlassian.com/x/dwiiLQ) for more information
152
- * about JQL functions.
153
- */
154
- export interface FunctionOperand extends Record<string, unknown> {
155
- /** The list of function arguments. */
156
- arguments: string[];
157
- /** Encoded operand, which can be used directly in a JQL query. */
158
- encodedOperand?: string;
159
- /** The name of the function. */
160
- function: string;
161
- }
162
- /** Details of functions that can be used in advanced searches. */
163
- export interface FunctionReferenceData {
164
- /** The display name of the function. */
165
- displayName?: string;
166
- /** Whether the function can take a list of arguments. */
167
- isList?: "true" | "false";
168
- /** Whether the function supports both single and list value operators. */
169
- supportsListAndSingleValueOperators?: "true" | "false";
170
- /** The data types returned by the function. */
171
- types?: string[];
172
- /** The function identifier. */
173
- value?: string;
174
- }
175
- /** The JQL queries to be converted. */
176
- export interface JqlPersonalDataMigrationRequest {
177
- /** A list of queries with user identifiers. Maximum of 100 queries. */
178
- queryStrings?: string[];
179
- }
180
- /** A list of JQL queries to parse. */
181
- export interface JqlQueriesToParse {
182
- /** A list of queries to parse. */
183
- queries: string[];
184
- }
185
- /** The list of JQL queries to sanitize for the given account IDs. */
186
- export interface JqlQueriesToSanitize {
187
- /**
188
- * The list of JQL queries to sanitize. Must contain unique values. Maximum of 20
189
- * queries.
190
- */
191
- queries: JqlQueryToSanitize[];
192
- }
193
- /** A parsed JQL query. */
194
- export interface JqlQuery {
195
- /** Details of the order-by JQL clause. */
196
- orderBy?: JqlQueryOrderByClause;
197
- /** A JQL query clause. */
198
- where?: JqlQueryClause;
199
- }
200
- /** A JQL query clause. */
201
- export type JqlQueryClause =
202
- | CompoundClause
203
- | FieldValueClause
204
- | FieldWasClause
205
- | FieldChangedClause;
206
- /** Details of an operand in a JQL clause. */
207
- export type JqlQueryClauseOperand =
208
- | ListOperand
209
- | ValueOperand
210
- | FunctionOperand
211
- | KeywordOperand;
212
- /** A time predicate for a temporal JQL clause. */
213
- export interface JqlQueryClauseTimePredicate extends Record<string, unknown> {
214
- /** Details of an operand in a JQL clause. */
215
- operand: JqlQueryClauseOperand;
216
- /** The operator between the field and the operand. */
217
- operator: "before" | "after" | "from" | "to" | "on" | "during" | "by";
218
- }
219
- /**
220
- * A field used in a JQL query. See [Advanced searching - fields
221
- * reference](https://confluence.atlassian.com/x/dAiiLQ) for more information
222
- * about fields in JQL queries.
223
- */
224
- export interface JqlQueryField {
225
- /** The encoded name of the field, which can be used directly in a JQL query. */
226
- encodedName?: string;
227
- /** The name of the field. */
228
- name: string;
229
- /**
230
- * When the field refers to a value in an entity property, details of the entity
231
- * property value.
232
- */
233
- property?: JqlQueryFieldEntityProperty[];
234
- }
235
- /** Details of an entity property. */
236
- export interface JqlQueryFieldEntityProperty extends Record<string, unknown> {
237
- /**
238
- * The object on which the property is set.
239
- *
240
- * @example issue
241
- */
242
- entity: string;
243
- /**
244
- * The key of the property.
245
- *
246
- * @example stats
247
- */
248
- key: string;
249
- /**
250
- * The path in the property value to query.
251
- *
252
- * @example comments.count
253
- */
254
- path: string;
255
- /**
256
- * The type of the property value extraction. Not available if the extraction for
257
- * the property is not registered on the instance with the [Entity
258
- * property](https://developer.atlassian.com/cloud/jira/platform/modules/entity-property/)
259
- * module.
260
- *
261
- * @example number
262
- */
263
- type?: "number" | "string" | "text" | "date" | "user";
264
- }
265
- /** Details of the order-by JQL clause. */
266
- export interface JqlQueryOrderByClause {
267
- /** The list of order-by clause fields and their ordering directives. */
268
- fields: JqlQueryOrderByClauseElement[];
269
- }
270
- /** An element of the order-by JQL clause. */
271
- export interface JqlQueryOrderByClauseElement {
272
- /** The direction in which to order the results. */
273
- direction?: "asc" | "desc";
274
- /**
275
- * A field used in a JQL query. See [Advanced searching - fields
276
- * reference](https://confluence.atlassian.com/x/dAiiLQ) for more information
277
- * about fields in JQL queries.
278
- */
279
- field: JqlQueryField;
280
- }
281
- /**
282
- * The JQL query to sanitize for the account ID. If the account ID is null,
283
- * sanitizing is performed for an anonymous user.
284
- */
285
- export interface JqlQueryToSanitize {
286
- /**
287
- * The account ID of the user, which uniquely identifies the user across all
288
- * Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
289
- */
290
- accountId?: string | null;
291
- /** The query to sanitize. */
292
- query: string;
293
- }
294
- /** An operand that can be part of a list operand. */
295
- export type JqlQueryUnitaryOperand =
296
- | ValueOperand
297
- | FunctionOperand
298
- | KeywordOperand;
299
- /** JQL queries that contained users that could not be found */
300
- export interface JqlQueryWithUnknownUsers {
301
- /**
302
- * The converted query, with accountIDs instead of user identifiers, or 'unknown'
303
- * for users that could not be found
304
- */
305
- convertedQuery?: string;
306
- /** The original query, for reference */
307
- originalQuery?: string;
308
- }
309
- /** Lists of JQL reference data. */
310
- export interface JqlReferenceData {
311
- /** List of JQL query reserved words. */
312
- jqlReservedWords?: string[];
313
- /** List of fields usable in JQL queries. */
314
- visibleFieldNames?: FieldReferenceData[];
315
- /** List of functions usable in JQL queries. */
316
- visibleFunctionNames?: FunctionReferenceData[];
317
- }
318
- /**
319
- * An operand that is a JQL keyword. See [Advanced searching - keywords
320
- * reference](https://confluence.atlassian.com/jiracorecloud/advanced-searching-keywords-reference-765593717.html#Advancedsearching-keywordsreference-EMPTYEMPTY)
321
- * for more information about operand keywords.
322
- */
323
- export interface KeywordOperand extends Record<string, unknown> {
324
- /** The keyword that is the operand value. */
325
- keyword: "empty";
326
- }
327
- /** An operand that is a list of values. */
328
- export interface ListOperand extends Record<string, unknown> {
329
- /** Encoded operand, which can be used directly in a JQL query. */
330
- encodedOperand?: string;
331
- /** The list of operand values. */
332
- values: JqlQueryUnitaryOperand[];
333
- }
334
- /** A list of parsed JQL queries. */
335
- export interface ParsedJqlQueries {
336
- /** A list of parsed JQL queries. */
337
- queries: ParsedJqlQuery[];
338
- }
339
- /** Details of a parsed JQL query. */
340
- export interface ParsedJqlQuery {
341
- /** The list of syntax or validation errors. */
342
- errors?: string[];
343
- /** The JQL query that was parsed and validated. */
344
- query: string;
345
- /** The syntax tree of the query. Empty if the query was invalid. */
346
- structure?: JqlQuery;
347
- }
348
- /** The sanitized JQL queries for the given account IDs. */
349
- export interface SanitizedJqlQueries {
350
- /** The list of sanitized JQL queries. */
351
- queries?: SanitizedJqlQuery[];
352
- }
353
- /** Details of the sanitized JQL query. */
354
- export interface SanitizedJqlQuery {
355
- /** The account ID of the user for whom sanitization was performed. */
356
- accountId?: string | null;
357
- /** The list of errors. */
358
- errors?: ErrorCollection;
359
- /** The initial query. */
360
- initialQuery?: string;
361
- /** The sanitized query, if there were no errors. */
362
- sanitizedQuery?: string | null;
363
- }
364
- /** Details of how to filter and list search auto complete information. */
365
- export interface SearchAutoCompleteFilter {
366
- /** Include collapsed fields for fields that have non-unique names. */
367
- includeCollapsedFields?: boolean;
368
- /** List of project IDs used to filter the visible field details returned. */
369
- projectIds?: number[];
370
- }
371
- /** An operand that is a user-provided value. */
372
- export interface ValueOperand extends Record<string, unknown> {
373
- /** Encoded value, which can be used directly in a JQL query. */
374
- encodedValue?: string;
375
- /** The operand value. */
376
- value: string;
377
- }
378
- export function registerJqlValidationSchemas(
379
- validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
380
- ) {
381
- validationSchemaStorage.register(
382
- "AutoCompleteSuggestion",
383
- z
384
- .object({
385
- displayName: z.string().optional(),
386
- value: z.string().optional(),
387
- })
388
- .strict()
389
- .describe("AutoCompleteSuggestion"),
390
- );
391
- validationSchemaStorage.register(
392
- "AutoCompleteSuggestions",
393
- z
394
- .object({
395
- results: z
396
- .array(validationSchemaStorage.lazy("AutoCompleteSuggestion"))
397
- .optional(),
398
- })
399
- .strict()
400
- .describe("AutoCompleteSuggestions"),
401
- );
402
- validationSchemaStorage.register(
403
- "CompoundClause",
404
- z
405
- .object({
406
- clauses: z.array(validationSchemaStorage.lazy("JqlQueryClause")),
407
- operator: z.enum(["and", "or", "not"]),
408
- })
409
- .strict()
410
- .describe("CompoundClause"),
411
- );
412
- validationSchemaStorage.register(
413
- "ConvertedJqlQueries",
414
- z
415
- .object({
416
- queriesWithUnknownUsers: z
417
- .array(validationSchemaStorage.lazy("JqlQueryWithUnknownUsers"))
418
- .optional(),
419
- queryStrings: z.array(z.string()).optional(),
420
- })
421
- .strict()
422
- .describe("ConvertedJqlQueries"),
423
- );
424
- validationSchemaStorage.register(
425
- "FieldChangedClause",
426
- z
427
- .object({
428
- field: validationSchemaStorage.lazy("JqlQueryField"),
429
- operator: z.enum(["changed"]),
430
- predicates: z.array(
431
- validationSchemaStorage.lazy("JqlQueryClauseTimePredicate"),
432
- ),
433
- })
434
- .strict()
435
- .describe("FieldChangedClause"),
436
- );
437
- validationSchemaStorage.register(
438
- "FieldReferenceData",
439
- z
440
- .object({
441
- auto: z.enum(["true", "false"]).optional(),
442
- cfid: z.string().optional(),
443
- deprecated: z.enum(["true", "false"]).optional(),
444
- deprecatedSearcherKey: z.string().optional(),
445
- displayName: z.string().optional(),
446
- operators: z.array(z.string()).optional(),
447
- orderable: z.enum(["true", "false"]).optional(),
448
- searchable: z.enum(["true", "false"]).optional(),
449
- types: z.array(z.string()).optional(),
450
- value: z.string().optional(),
451
- })
452
- .strict()
453
- .describe("FieldReferenceData"),
454
- );
455
- validationSchemaStorage.register(
456
- "FieldValueClause",
457
- z
458
- .object({
459
- field: validationSchemaStorage.lazy("JqlQueryField"),
460
- operand: validationSchemaStorage.lazy("JqlQueryClauseOperand"),
461
- operator: z.enum([
462
- "=",
463
- "!=",
464
- ">",
465
- "<",
466
- ">=",
467
- "<=",
468
- "in",
469
- "not in",
470
- "~",
471
- "~=",
472
- "is",
473
- "is not",
474
- ]),
475
- })
476
- .strict()
477
- .describe("FieldValueClause"),
478
- );
479
- validationSchemaStorage.register(
480
- "FieldWasClause",
481
- z
482
- .object({
483
- field: validationSchemaStorage.lazy("JqlQueryField"),
484
- operand: validationSchemaStorage.lazy("JqlQueryClauseOperand"),
485
- operator: z.enum(["was", "was in", "was not in", "was not"]),
486
- predicates: z.array(
487
- validationSchemaStorage.lazy("JqlQueryClauseTimePredicate"),
488
- ),
489
- })
490
- .strict()
491
- .describe("FieldWasClause"),
492
- );
493
- validationSchemaStorage.register(
494
- "FunctionOperand",
495
- z
496
- .object({
497
- arguments: z.array(z.string()),
498
- encodedOperand: z.string().optional(),
499
- function: z.string(),
500
- })
501
- .catchall(z.unknown())
502
- .describe("FunctionOperand"),
503
- );
504
- validationSchemaStorage.register(
505
- "FunctionReferenceData",
506
- z
507
- .object({
508
- displayName: z.string().optional(),
509
- isList: z.enum(["true", "false"]).optional(),
510
- supportsListAndSingleValueOperators: z
511
- .enum(["true", "false"])
512
- .optional(),
513
- types: z.array(z.string()).optional(),
514
- value: z.string().optional(),
515
- })
516
- .strict()
517
- .describe("FunctionReferenceData"),
518
- );
519
- validationSchemaStorage.register(
520
- "JqlPersonalDataMigrationRequest",
521
- z
522
- .object({
523
- queryStrings: z.array(z.string()).optional(),
524
- })
525
- .strict()
526
- .describe("JqlPersonalDataMigrationRequest"),
527
- );
528
- validationSchemaStorage.register(
529
- "JqlQueriesToParse",
530
- z
531
- .object({
532
- queries: z.array(z.string().min(1)),
533
- })
534
- .strict()
535
- .describe("JqlQueriesToParse"),
536
- );
537
- validationSchemaStorage.register(
538
- "JqlQueriesToSanitize",
539
- z
540
- .object({
541
- queries: z.array(validationSchemaStorage.lazy("JqlQueryToSanitize")),
542
- })
543
- .strict()
544
- .describe("JqlQueriesToSanitize"),
545
- );
546
- validationSchemaStorage.register(
547
- "JqlQuery",
548
- z
549
- .object({
550
- orderBy: validationSchemaStorage
551
- .lazy("JqlQueryOrderByClause")
552
- .optional(),
553
- where: validationSchemaStorage.lazy("JqlQueryClause").optional(),
554
- })
555
- .strict()
556
- .describe("JqlQuery"),
557
- );
558
- validationSchemaStorage.register(
559
- "JqlQueryClause",
560
- z
561
- .union([
562
- validationSchemaStorage.lazy("CompoundClause"),
563
- validationSchemaStorage.lazy("FieldValueClause"),
564
- validationSchemaStorage.lazy("FieldWasClause"),
565
- validationSchemaStorage.lazy("FieldChangedClause"),
566
- ])
567
- .describe("JqlQueryClause"),
568
- );
569
- validationSchemaStorage.register(
570
- "JqlQueryClauseOperand",
571
- z
572
- .union([
573
- validationSchemaStorage.lazy("ListOperand"),
574
- validationSchemaStorage.lazy("ValueOperand"),
575
- validationSchemaStorage.lazy("FunctionOperand"),
576
- validationSchemaStorage.lazy("KeywordOperand"),
577
- ])
578
- .describe("JqlQueryClauseOperand"),
579
- );
580
- validationSchemaStorage.register(
581
- "JqlQueryClauseTimePredicate",
582
- z
583
- .object({
584
- operand: validationSchemaStorage.lazy("JqlQueryClauseOperand"),
585
- operator: z.enum([
586
- "before",
587
- "after",
588
- "from",
589
- "to",
590
- "on",
591
- "during",
592
- "by",
593
- ]),
594
- })
595
- .catchall(z.unknown())
596
- .describe("JqlQueryClauseTimePredicate"),
597
- );
598
- validationSchemaStorage.register(
599
- "JqlQueryField",
600
- z
601
- .object({
602
- encodedName: z.string().optional(),
603
- name: z.string(),
604
- property: z
605
- .array(validationSchemaStorage.lazy("JqlQueryFieldEntityProperty"))
606
- .optional(),
607
- })
608
- .strict()
609
- .describe("JqlQueryField"),
610
- );
611
- validationSchemaStorage.register(
612
- "JqlQueryFieldEntityProperty",
613
- z
614
- .object({
615
- entity: z.string(),
616
- key: z.string(),
617
- path: z.string(),
618
- type: z.enum(["number", "string", "text", "date", "user"]).optional(),
619
- })
620
- .catchall(z.unknown())
621
- .describe("JqlQueryFieldEntityProperty"),
622
- );
623
- validationSchemaStorage.register(
624
- "JqlQueryOrderByClause",
625
- z
626
- .object({
627
- fields: z.array(
628
- validationSchemaStorage.lazy("JqlQueryOrderByClauseElement"),
629
- ),
630
- })
631
- .strict()
632
- .describe("JqlQueryOrderByClause"),
633
- );
634
- validationSchemaStorage.register(
635
- "JqlQueryOrderByClauseElement",
636
- z
637
- .object({
638
- direction: z.enum(["asc", "desc"]).optional(),
639
- field: validationSchemaStorage.lazy("JqlQueryField"),
640
- })
641
- .strict()
642
- .describe("JqlQueryOrderByClauseElement"),
643
- );
644
- validationSchemaStorage.register(
645
- "JqlQueryToSanitize",
646
- z
647
- .object({
648
- accountId: z.nullable(z.string().max(128)).optional(),
649
- query: z.string(),
650
- })
651
- .strict()
652
- .describe("JqlQueryToSanitize"),
653
- );
654
- validationSchemaStorage.register(
655
- "JqlQueryUnitaryOperand",
656
- z
657
- .union([
658
- validationSchemaStorage.lazy("ValueOperand"),
659
- validationSchemaStorage.lazy("FunctionOperand"),
660
- validationSchemaStorage.lazy("KeywordOperand"),
661
- ])
662
- .describe("JqlQueryUnitaryOperand"),
663
- );
664
- validationSchemaStorage.register(
665
- "JqlQueryWithUnknownUsers",
666
- z
667
- .object({
668
- convertedQuery: z.string().optional(),
669
- originalQuery: z.string().optional(),
670
- })
671
- .strict()
672
- .describe("JqlQueryWithUnknownUsers"),
673
- );
674
- validationSchemaStorage.register(
675
- "JqlReferenceData",
676
- z
677
- .object({
678
- jqlReservedWords: z.array(z.string()).optional(),
679
- visibleFieldNames: z
680
- .array(validationSchemaStorage.lazy("FieldReferenceData"))
681
- .optional(),
682
- visibleFunctionNames: z
683
- .array(validationSchemaStorage.lazy("FunctionReferenceData"))
684
- .optional(),
685
- })
686
- .strict()
687
- .describe("JqlReferenceData"),
688
- );
689
- validationSchemaStorage.register(
690
- "KeywordOperand",
691
- z
692
- .object({
693
- keyword: z.enum(["empty"]),
694
- })
695
- .catchall(z.unknown())
696
- .describe("KeywordOperand"),
697
- );
698
- validationSchemaStorage.register(
699
- "ListOperand",
700
- z
701
- .object({
702
- encodedOperand: z.string().optional(),
703
- values: z.array(validationSchemaStorage.lazy("JqlQueryUnitaryOperand")),
704
- })
705
- .catchall(z.unknown())
706
- .describe("ListOperand"),
707
- );
708
- validationSchemaStorage.register(
709
- "ParsedJqlQueries",
710
- z
711
- .object({
712
- queries: z.array(validationSchemaStorage.lazy("ParsedJqlQuery")),
713
- })
714
- .strict()
715
- .describe("ParsedJqlQueries"),
716
- );
717
- validationSchemaStorage.register(
718
- "ParsedJqlQuery",
719
- z
720
- .object({
721
- errors: z
722
- .array(z.string())
723
- .superRefine((items, ctx) => {
724
- if (new Set(items).size !== items.length) {
725
- ctx.addIssue({
726
- code: z.ZodIssueCode.custom,
727
- path: [],
728
- message: "Array items must be unique",
729
- });
730
- }
731
- })
732
- .optional(),
733
- query: z.string(),
734
- structure: validationSchemaStorage.lazy("JqlQuery").optional(),
735
- })
736
- .strict()
737
- .describe("ParsedJqlQuery"),
738
- );
739
- validationSchemaStorage.register(
740
- "SanitizedJqlQueries",
741
- z
742
- .object({
743
- queries: z
744
- .array(validationSchemaStorage.lazy("SanitizedJqlQuery"))
745
- .optional(),
746
- })
747
- .strict()
748
- .describe("SanitizedJqlQueries"),
749
- );
750
- validationSchemaStorage.register(
751
- "SanitizedJqlQuery",
752
- z
753
- .object({
754
- accountId: z.nullable(z.string().max(128)).optional(),
755
- errors: validationSchemaStorage.lazy("ErrorCollection").optional(),
756
- initialQuery: z.string().optional(),
757
- sanitizedQuery: z.nullable(z.string()).optional(),
758
- })
759
- .strict()
760
- .describe("SanitizedJqlQuery"),
761
- );
762
- validationSchemaStorage.register(
763
- "SearchAutoCompleteFilter",
764
- z
765
- .object({
766
- includeCollapsedFields: z.boolean().optional(),
767
- projectIds: z.array(z.number().int()).optional(),
768
- })
769
- .strict()
770
- .describe("SearchAutoCompleteFilter"),
771
- );
772
- validationSchemaStorage.register(
773
- "ValueOperand",
774
- z
775
- .object({
776
- encodedValue: z.string().optional(),
777
- value: z.string(),
778
- })
779
- .catchall(z.unknown())
780
- .describe("ValueOperand"),
781
- );
782
- validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
783
- }