@qlik/api 1.31.0 → 1.33.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 (142) hide show
  1. package/api-keys.d.ts +10 -10
  2. package/api-keys.js +64 -50
  3. package/apps.d.ts +56 -56
  4. package/apps.js +392 -304
  5. package/assistants.d.ts +1301 -0
  6. package/assistants.js +329 -0
  7. package/audits.d.ts +10 -10
  8. package/audits.js +48 -36
  9. package/{auth-types-DqfMuSRX.d.ts → auth-types-Cj5bM3Yk.d.ts} +29 -9
  10. package/auth.d.ts +17 -4
  11. package/auth.js +4 -2
  12. package/automation-connections.d.ts +366 -0
  13. package/automation-connections.js +107 -0
  14. package/automations.d.ts +27 -27
  15. package/automations.js +159 -123
  16. package/automl-deployments.d.ts +97 -0
  17. package/automl-deployments.js +29 -0
  18. package/automl-predictions.d.ts +214 -0
  19. package/automl-predictions.js +84 -0
  20. package/brands.d.ts +18 -18
  21. package/brands.js +107 -83
  22. package/chunks/{KBSD75QL.js → 33GQY7N7.js} +1 -1
  23. package/chunks/{M64RLKVG.js → 62DXIH3S.js} +7 -5
  24. package/chunks/7MMXU6EL.js +86 -0
  25. package/chunks/{DLKLPD7T.js → GPRUNZV4.js} +3 -3
  26. package/chunks/{YKZ2QYHN.js → LIEZG7IM.js} +3 -3
  27. package/chunks/{FKDGGR2O.js → OTIO4SEJ.js} +698 -708
  28. package/chunks/{UZTIZ4H5.js → RP3EJGHG.js} +74 -74
  29. package/chunks/{GUU3KZGK.js → SPATCXXU.js} +9 -2
  30. package/chunks/{LY7RP2HA.js → XF3TPZKZ.js} +23 -8
  31. package/chunks/{6ZONDHRN.js → YYZCS5PW.js} +11 -4
  32. package/chunks/{3RGGGGAR.js → ZCTVPXGO.js} +1 -1
  33. package/collections.d.ts +16 -15
  34. package/collections.js +98 -76
  35. package/conditions.d.ts +662 -0
  36. package/conditions.js +135 -0
  37. package/consumption.d.ts +182 -0
  38. package/consumption.js +26 -0
  39. package/csp-origins.d.ts +9 -9
  40. package/csp-origins.js +53 -41
  41. package/csrf-token.d.ts +62 -0
  42. package/csrf-token.js +25 -0
  43. package/data-alerts.d.ts +1004 -0
  44. package/data-alerts.js +187 -0
  45. package/data-assets.d.ts +8 -8
  46. package/data-assets.js +50 -40
  47. package/data-connections.d.ts +16 -16
  48. package/data-connections.js +87 -69
  49. package/data-credentials.d.ts +11 -11
  50. package/data-credentials.js +52 -42
  51. package/data-files.d.ts +18 -18
  52. package/data-files.js +107 -83
  53. package/data-qualities.d.ts +175 -0
  54. package/data-qualities.js +50 -0
  55. package/data-sets.d.ts +424 -0
  56. package/data-sets.js +87 -0
  57. package/data-sources.d.ts +268 -0
  58. package/data-sources.js +45 -0
  59. package/data-stores.d.ts +537 -0
  60. package/data-stores.js +128 -0
  61. package/dcaas.d.ts +192 -0
  62. package/dcaas.js +45 -0
  63. package/di-projects.d.ts +673 -0
  64. package/di-projects.js +196 -0
  65. package/direct-access-agents.d.ts +328 -0
  66. package/direct-access-agents.js +108 -0
  67. package/encryption.d.ts +370 -0
  68. package/encryption.js +118 -0
  69. package/extensions.d.ts +11 -11
  70. package/extensions.js +61 -47
  71. package/glossaries.d.ts +33 -33
  72. package/glossaries.js +221 -173
  73. package/groups.d.ts +12 -12
  74. package/groups.js +72 -56
  75. package/identity-providers.d.ts +11 -11
  76. package/identity-providers.js +67 -51
  77. package/index.d.ts +113 -4
  78. package/index.js +626 -40
  79. package/interceptors.d.ts +9 -2
  80. package/interceptors.js +2 -2
  81. package/invoke-fetch-types-BYCD4pc9.d.ts +98 -0
  82. package/items.d.ts +14 -13
  83. package/items.js +71 -55
  84. package/knowledgebases.d.ts +890 -0
  85. package/knowledgebases.js +203 -0
  86. package/licenses.d.ts +14 -14
  87. package/licenses.js +76 -58
  88. package/lineage-graphs.d.ts +712 -0
  89. package/lineage-graphs.js +108 -0
  90. package/ml.d.ts +2676 -0
  91. package/ml.js +477 -0
  92. package/notes.d.ts +110 -0
  93. package/notes.js +35 -0
  94. package/notifications.d.ts +98 -0
  95. package/notifications.js +26 -0
  96. package/oauth-clients.d.ts +14 -14
  97. package/oauth-clients.js +96 -74
  98. package/oauth-tokens.d.ts +126 -0
  99. package/oauth-tokens.js +35 -0
  100. package/package.json +34 -6
  101. package/qix.d.ts +145 -4
  102. package/qix.js +2 -2
  103. package/questions.d.ts +364 -0
  104. package/questions.js +38 -0
  105. package/quotas.d.ts +6 -6
  106. package/quotas.js +20 -16
  107. package/reload-tasks.d.ts +8 -8
  108. package/reload-tasks.js +46 -36
  109. package/reloads.d.ts +7 -7
  110. package/reloads.js +36 -28
  111. package/report-templates.d.ts +287 -0
  112. package/report-templates.js +94 -0
  113. package/reports.d.ts +4 -4
  114. package/reports.js +20 -16
  115. package/roles.d.ts +8 -8
  116. package/roles.js +46 -36
  117. package/sharing-tasks.d.ts +952 -0
  118. package/sharing-tasks.js +125 -0
  119. package/spaces.d.ts +22 -22
  120. package/spaces.js +153 -119
  121. package/tasks.d.ts +564 -0
  122. package/tasks.js +126 -0
  123. package/temp-contents.d.ts +7 -7
  124. package/temp-contents.js +30 -24
  125. package/tenants.d.ts +8 -8
  126. package/tenants.js +57 -45
  127. package/themes.d.ts +11 -11
  128. package/themes.js +61 -47
  129. package/transports.d.ts +8 -8
  130. package/transports.js +49 -37
  131. package/ui-config.d.ts +274 -0
  132. package/ui-config.js +91 -0
  133. package/users.d.ts +15 -15
  134. package/users.js +81 -63
  135. package/web-integrations.d.ts +8 -8
  136. package/web-integrations.js +46 -36
  137. package/web-notifications.d.ts +9 -9
  138. package/web-notifications.js +53 -41
  139. package/webhooks.d.ts +14 -14
  140. package/webhooks.js +88 -68
  141. package/chunks/2ZQ3ZX7F.js +0 -33
  142. package/invoke-fetch-types-Cq7bjkqn.d.ts +0 -243
package/assistants.js ADDED
@@ -0,0 +1,329 @@
1
+ import {
2
+ clearApiCache,
3
+ invokeFetch
4
+ } from "./chunks/LIEZG7IM.js";
5
+ import "./chunks/GPRUNZV4.js";
6
+ import "./chunks/7MMXU6EL.js";
7
+
8
+ // src/public/rest/assistants.ts
9
+ async function getAssistants(query, options) {
10
+ return invokeFetch("assistants", {
11
+ method: "get",
12
+ pathTemplate: "/api/v1/assistants",
13
+ query,
14
+ options
15
+ });
16
+ }
17
+ async function createAssistant(body, options) {
18
+ return invokeFetch("assistants", {
19
+ method: "post",
20
+ pathTemplate: "/api/v1/assistants",
21
+ body,
22
+ contentType: "application/json",
23
+ options
24
+ });
25
+ }
26
+ async function getAssistantFeedback(assistantId, options) {
27
+ return invokeFetch("assistants", {
28
+ method: "get",
29
+ pathTemplate: "/api/v1/assistants/{assistantId}/feedback",
30
+ pathVariables: { assistantId },
31
+ options
32
+ });
33
+ }
34
+ async function getAssistantSources(assistantId, body, options) {
35
+ return invokeFetch("assistants", {
36
+ method: "post",
37
+ pathTemplate: "/api/v1/assistants/{assistantId}/sources/plaintexts",
38
+ pathVariables: { assistantId },
39
+ body,
40
+ contentType: "application/json",
41
+ options
42
+ });
43
+ }
44
+ async function getAssistantStarters(assistantId, query, options) {
45
+ return invokeFetch("assistants", {
46
+ method: "get",
47
+ pathTemplate: "/api/v1/assistants/{assistantId}/starters",
48
+ pathVariables: { assistantId },
49
+ query,
50
+ options
51
+ });
52
+ }
53
+ async function createAssistantStarter(assistantId, body, options) {
54
+ return invokeFetch("assistants", {
55
+ method: "post",
56
+ pathTemplate: "/api/v1/assistants/{assistantId}/starters",
57
+ pathVariables: { assistantId },
58
+ body,
59
+ contentType: "application/json",
60
+ options
61
+ });
62
+ }
63
+ async function deleteAssistantStarter(assistantId, starterId, options) {
64
+ return invokeFetch("assistants", {
65
+ method: "delete",
66
+ pathTemplate: "/api/v1/assistants/{assistantId}/starters/{starterId}",
67
+ pathVariables: { assistantId, starterId },
68
+ options
69
+ });
70
+ }
71
+ async function getAssistantStarter(assistantId, starterId, options) {
72
+ return invokeFetch("assistants", {
73
+ method: "get",
74
+ pathTemplate: "/api/v1/assistants/{assistantId}/starters/{starterId}",
75
+ pathVariables: { assistantId, starterId },
76
+ options
77
+ });
78
+ }
79
+ async function updateAssistantStarter(assistantId, starterId, body, options) {
80
+ return invokeFetch("assistants", {
81
+ method: "put",
82
+ pathTemplate: "/api/v1/assistants/{assistantId}/starters/{starterId}",
83
+ pathVariables: { assistantId, starterId },
84
+ body,
85
+ contentType: "application/json",
86
+ options
87
+ });
88
+ }
89
+ async function deleteAssistantStarterFollowup(assistantId, starterId, followupId, options) {
90
+ return invokeFetch("assistants", {
91
+ method: "delete",
92
+ pathTemplate: "/api/v1/assistants/{assistantId}/starters/{starterId}/followups/{followupId}",
93
+ pathVariables: { assistantId, starterId, followupId },
94
+ options
95
+ });
96
+ }
97
+ async function updateAssistantStarterFollowup(assistantId, starterId, followupId, body, options) {
98
+ return invokeFetch("assistants", {
99
+ method: "put",
100
+ pathTemplate: "/api/v1/assistants/{assistantId}/starters/{starterId}/followups/{followupId}",
101
+ pathVariables: { assistantId, starterId, followupId },
102
+ body,
103
+ contentType: "application/json",
104
+ options
105
+ });
106
+ }
107
+ async function getAssistantThreads(assistantId, query, options) {
108
+ return invokeFetch("assistants", {
109
+ method: "get",
110
+ pathTemplate: "/api/v1/assistants/{assistantId}/threads",
111
+ pathVariables: { assistantId },
112
+ query,
113
+ options
114
+ });
115
+ }
116
+ async function createAssistantThread(assistantId, body, options) {
117
+ return invokeFetch("assistants", {
118
+ method: "post",
119
+ pathTemplate: "/api/v1/assistants/{assistantId}/threads",
120
+ pathVariables: { assistantId },
121
+ body,
122
+ contentType: "application/json",
123
+ options
124
+ });
125
+ }
126
+ async function invokeAssistantThread(assistantId, threadId, body, options) {
127
+ return invokeFetch("assistants", {
128
+ method: "post",
129
+ pathTemplate: "/api/v1/assistants/{assistantId}/threads/{threadId}/actions/invoke",
130
+ pathVariables: { assistantId, threadId },
131
+ body,
132
+ contentType: "application/json",
133
+ options
134
+ });
135
+ }
136
+ async function streamAssistantThread(assistantId, threadId, body, options) {
137
+ return invokeFetch("assistants", {
138
+ method: "post",
139
+ pathTemplate: "/api/v1/assistants/{assistantId}/threads/{threadId}/actions/stream",
140
+ pathVariables: { assistantId, threadId },
141
+ body,
142
+ contentType: "application/json",
143
+ options
144
+ });
145
+ }
146
+ async function getAssistantThreadInteractions(assistantId, threadId, query, options) {
147
+ return invokeFetch("assistants", {
148
+ method: "get",
149
+ pathTemplate: "/api/v1/assistants/{assistantId}/threads/{threadId}/interactions",
150
+ pathVariables: { assistantId, threadId },
151
+ query,
152
+ options
153
+ });
154
+ }
155
+ async function createAssistantThreadInteraction(assistantId, threadId, body, options) {
156
+ return invokeFetch("assistants", {
157
+ method: "post",
158
+ pathTemplate: "/api/v1/assistants/{assistantId}/threads/{threadId}/interactions",
159
+ pathVariables: { assistantId, threadId },
160
+ body,
161
+ contentType: "application/json",
162
+ options
163
+ });
164
+ }
165
+ async function deleteAssistantThreadInteraction(assistantId, threadId, interactionId, options) {
166
+ return invokeFetch("assistants", {
167
+ method: "delete",
168
+ pathTemplate: "/api/v1/assistants/{assistantId}/threads/{threadId}/interactions/{interactionId}",
169
+ pathVariables: { assistantId, threadId, interactionId },
170
+ options
171
+ });
172
+ }
173
+ async function getAssistantThreadInteraction(assistantId, threadId, interactionId, options) {
174
+ return invokeFetch("assistants", {
175
+ method: "get",
176
+ pathTemplate: "/api/v1/assistants/{assistantId}/threads/{threadId}/interactions/{interactionId}",
177
+ pathVariables: { assistantId, threadId, interactionId },
178
+ options
179
+ });
180
+ }
181
+ async function createAssistantThreadInteractionFeedback(assistantId, threadId, interactionId, body, options) {
182
+ return invokeFetch("assistants", {
183
+ method: "post",
184
+ pathTemplate: "/api/v1/assistants/{assistantId}/threads/{threadId}/interactions/{interactionId}/feedback",
185
+ pathVariables: { assistantId, threadId, interactionId },
186
+ body,
187
+ contentType: "application/json",
188
+ options
189
+ });
190
+ }
191
+ async function patchAssistantThreadInteractionFeedback(assistantId, threadId, interactionId, feedbackId, body, options) {
192
+ return invokeFetch("assistants", {
193
+ method: "patch",
194
+ pathTemplate: "/api/v1/assistants/{assistantId}/threads/{threadId}/interactions/{interactionId}/feedback/{feedbackId}",
195
+ pathVariables: { assistantId, threadId, interactionId, feedbackId },
196
+ body,
197
+ contentType: "application/json",
198
+ options
199
+ });
200
+ }
201
+ async function createAssistantThreadInteractionReview(assistantId, threadId, interactionId, body, options) {
202
+ return invokeFetch("assistants", {
203
+ method: "post",
204
+ pathTemplate: "/api/v1/assistants/{assistantId}/threads/{threadId}/interactions/{interactionId}/reviews",
205
+ pathVariables: { assistantId, threadId, interactionId },
206
+ body,
207
+ contentType: "application/json",
208
+ options
209
+ });
210
+ }
211
+ async function deleteAssistantThread(assistantid, threadid, options) {
212
+ return invokeFetch("assistants", {
213
+ method: "delete",
214
+ pathTemplate: "/api/v1/assistants/{assistantid}/threads/{threadid}",
215
+ pathVariables: { assistantid, threadid },
216
+ options
217
+ });
218
+ }
219
+ async function getAssistantThread(assistantid, threadid, options) {
220
+ return invokeFetch("assistants", {
221
+ method: "get",
222
+ pathTemplate: "/api/v1/assistants/{assistantid}/threads/{threadid}",
223
+ pathVariables: { assistantid, threadid },
224
+ options
225
+ });
226
+ }
227
+ async function patchAssistantThread(assistantid, threadid, body, options) {
228
+ return invokeFetch("assistants", {
229
+ method: "patch",
230
+ pathTemplate: "/api/v1/assistants/{assistantid}/threads/{threadid}",
231
+ pathVariables: { assistantid, threadid },
232
+ body,
233
+ contentType: "application/json",
234
+ options
235
+ });
236
+ }
237
+ async function deleteAssistant(id, options) {
238
+ return invokeFetch("assistants", {
239
+ method: "delete",
240
+ pathTemplate: "/api/v1/assistants/{id}",
241
+ pathVariables: { id },
242
+ options
243
+ });
244
+ }
245
+ async function getAssistant(id, options) {
246
+ return invokeFetch("assistants", {
247
+ method: "get",
248
+ pathTemplate: "/api/v1/assistants/{id}",
249
+ pathVariables: { id },
250
+ options
251
+ });
252
+ }
253
+ async function patchAssistant(id, body, options) {
254
+ return invokeFetch("assistants", {
255
+ method: "patch",
256
+ pathTemplate: "/api/v1/assistants/{id}",
257
+ pathVariables: { id },
258
+ body,
259
+ contentType: "application/json",
260
+ options
261
+ });
262
+ }
263
+ function clearCache() {
264
+ return clearApiCache("assistants");
265
+ }
266
+ var assistantsExport = {
267
+ getAssistants,
268
+ createAssistant,
269
+ getAssistantFeedback,
270
+ getAssistantSources,
271
+ getAssistantStarters,
272
+ createAssistantStarter,
273
+ deleteAssistantStarter,
274
+ getAssistantStarter,
275
+ updateAssistantStarter,
276
+ deleteAssistantStarterFollowup,
277
+ updateAssistantStarterFollowup,
278
+ getAssistantThreads,
279
+ createAssistantThread,
280
+ invokeAssistantThread,
281
+ streamAssistantThread,
282
+ getAssistantThreadInteractions,
283
+ createAssistantThreadInteraction,
284
+ deleteAssistantThreadInteraction,
285
+ getAssistantThreadInteraction,
286
+ createAssistantThreadInteractionFeedback,
287
+ patchAssistantThreadInteractionFeedback,
288
+ createAssistantThreadInteractionReview,
289
+ deleteAssistantThread,
290
+ getAssistantThread,
291
+ patchAssistantThread,
292
+ deleteAssistant,
293
+ getAssistant,
294
+ patchAssistant,
295
+ clearCache
296
+ };
297
+ var assistants_default = assistantsExport;
298
+ export {
299
+ clearCache,
300
+ createAssistant,
301
+ createAssistantStarter,
302
+ createAssistantThread,
303
+ createAssistantThreadInteraction,
304
+ createAssistantThreadInteractionFeedback,
305
+ createAssistantThreadInteractionReview,
306
+ assistants_default as default,
307
+ deleteAssistant,
308
+ deleteAssistantStarter,
309
+ deleteAssistantStarterFollowup,
310
+ deleteAssistantThread,
311
+ deleteAssistantThreadInteraction,
312
+ getAssistant,
313
+ getAssistantFeedback,
314
+ getAssistantSources,
315
+ getAssistantStarter,
316
+ getAssistantStarters,
317
+ getAssistantThread,
318
+ getAssistantThreadInteraction,
319
+ getAssistantThreadInteractions,
320
+ getAssistantThreads,
321
+ getAssistants,
322
+ invokeAssistantThread,
323
+ patchAssistant,
324
+ patchAssistantThread,
325
+ patchAssistantThreadInteractionFeedback,
326
+ streamAssistantThread,
327
+ updateAssistantStarter,
328
+ updateAssistantStarterFollowup
329
+ };
package/audits.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
2
- import './auth-types-DqfMuSRX.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BYCD4pc9.js';
2
+ import './auth-types-Cj5bM3Yk.js';
3
3
 
4
4
  type ArchiveItem = {
5
5
  /** The type that content is encoded in, always "application/json". */
@@ -116,7 +116,7 @@ type Href = {
116
116
  * @param query an object with query parameters
117
117
  * @throws GetAuditsHttpError
118
118
  */
119
- declare const getAudits: (query: {
119
+ declare function getAudits(query: {
120
120
  /** The start/end time interval formatted in ISO 8601 to search by eventTime. For example, "?eventTime=2021-07-14T18:41:15.00Z/2021-07-14T18:41:15.99Z". */
121
121
  eventTime?: string;
122
122
  /** The case-sensitive string used to search by eventType. Retrieve a list of possible eventTypes with `/v1/audits/types`. */
@@ -135,7 +135,7 @@ declare const getAudits: (query: {
135
135
  source?: string;
136
136
  /** The case-sensitive string used to search by userId. */
137
137
  userId?: string;
138
- }, options?: ApiCallOptions) => Promise<GetAuditsHttpResponse>;
138
+ }, options?: ApiCallOptions): Promise<GetAuditsHttpResponse>;
139
139
  type GetAuditsHttpResponse = {
140
140
  data: GetResult;
141
141
  headers: Headers;
@@ -154,10 +154,10 @@ type GetAuditsHttpError = {
154
154
  * @param query an object with query parameters
155
155
  * @throws GetArchivedAuditsHttpError
156
156
  */
157
- declare const getArchivedAudits: (query: {
157
+ declare function getArchivedAudits(query: {
158
158
  /** Date to be used as filter and criteria during extraction. */
159
159
  date: string;
160
- }, options?: ApiCallOptions) => Promise<GetArchivedAuditsHttpResponse>;
160
+ }, options?: ApiCallOptions): Promise<GetArchivedAuditsHttpResponse>;
161
161
  type GetArchivedAuditsHttpResponse = {
162
162
  data: GetArchiveResult;
163
163
  headers: Headers;
@@ -173,7 +173,7 @@ type GetArchivedAuditsHttpError = {
173
173
  *
174
174
  * @throws GetAuditsSettingsHttpError
175
175
  */
176
- declare const getAuditsSettings: (options?: ApiCallOptions) => Promise<GetAuditsSettingsHttpResponse>;
176
+ declare function getAuditsSettings(options?: ApiCallOptions): Promise<GetAuditsSettingsHttpResponse>;
177
177
  type GetAuditsSettingsHttpResponse = {
178
178
  data: GetSettingsResult;
179
179
  headers: Headers;
@@ -189,7 +189,7 @@ type GetAuditsSettingsHttpError = {
189
189
  *
190
190
  * @throws GetAuditSourcesHttpError
191
191
  */
192
- declare const getAuditSources: (options?: ApiCallOptions) => Promise<GetAuditSourcesHttpResponse>;
192
+ declare function getAuditSources(options?: ApiCallOptions): Promise<GetAuditSourcesHttpResponse>;
193
193
  type GetAuditSourcesHttpResponse = {
194
194
  data: GetObjectsResult;
195
195
  headers: Headers;
@@ -207,7 +207,7 @@ type GetAuditSourcesHttpError = {
207
207
  *
208
208
  * @throws GetAuditTypesHttpError
209
209
  */
210
- declare const getAuditTypes: (options?: ApiCallOptions) => Promise<GetAuditTypesHttpResponse>;
210
+ declare function getAuditTypes(options?: ApiCallOptions): Promise<GetAuditTypesHttpResponse>;
211
211
  type GetAuditTypesHttpResponse = {
212
212
  data: GetObjectsResult;
213
213
  headers: Headers;
@@ -226,7 +226,7 @@ type GetAuditTypesHttpError = {
226
226
  * @param id The audit item's unique identifier.
227
227
  * @throws GetAuditHttpError
228
228
  */
229
- declare const getAudit: (id: string, options?: ApiCallOptions) => Promise<GetAuditHttpResponse>;
229
+ declare function getAudit(id: string, options?: ApiCallOptions): Promise<GetAuditHttpResponse>;
230
230
  type GetAuditHttpResponse = {
231
231
  data: GetByIDResult;
232
232
  headers: Headers;
package/audits.js CHANGED
@@ -1,44 +1,56 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/YKZ2QYHN.js";
5
- import "./chunks/DLKLPD7T.js";
6
- import "./chunks/2ZQ3ZX7F.js";
4
+ } from "./chunks/LIEZG7IM.js";
5
+ import "./chunks/GPRUNZV4.js";
6
+ import "./chunks/7MMXU6EL.js";
7
7
 
8
8
  // src/public/rest/audits.ts
9
- var getAudits = async (query, options) => invokeFetch("audits", {
10
- method: "get",
11
- pathTemplate: "/api/v1/audits",
12
- query,
13
- options
14
- });
15
- var getArchivedAudits = async (query, options) => invokeFetch("audits", {
16
- method: "get",
17
- pathTemplate: "/api/v1/audits/archive",
18
- query,
19
- options
20
- });
21
- var getAuditsSettings = async (options) => invokeFetch("audits", {
22
- method: "get",
23
- pathTemplate: "/api/v1/audits/settings",
24
- options
25
- });
26
- var getAuditSources = async (options) => invokeFetch("audits", {
27
- method: "get",
28
- pathTemplate: "/api/v1/audits/sources",
29
- options
30
- });
31
- var getAuditTypes = async (options) => invokeFetch("audits", {
32
- method: "get",
33
- pathTemplate: "/api/v1/audits/types",
34
- options
35
- });
36
- var getAudit = async (id, options) => invokeFetch("audits", {
37
- method: "get",
38
- pathTemplate: "/api/v1/audits/{id}",
39
- pathVariables: { id },
40
- options
41
- });
9
+ async function getAudits(query, options) {
10
+ return invokeFetch("audits", {
11
+ method: "get",
12
+ pathTemplate: "/api/v1/audits",
13
+ query,
14
+ options
15
+ });
16
+ }
17
+ async function getArchivedAudits(query, options) {
18
+ return invokeFetch("audits", {
19
+ method: "get",
20
+ pathTemplate: "/api/v1/audits/archive",
21
+ query,
22
+ options
23
+ });
24
+ }
25
+ async function getAuditsSettings(options) {
26
+ return invokeFetch("audits", {
27
+ method: "get",
28
+ pathTemplate: "/api/v1/audits/settings",
29
+ options
30
+ });
31
+ }
32
+ async function getAuditSources(options) {
33
+ return invokeFetch("audits", {
34
+ method: "get",
35
+ pathTemplate: "/api/v1/audits/sources",
36
+ options
37
+ });
38
+ }
39
+ async function getAuditTypes(options) {
40
+ return invokeFetch("audits", {
41
+ method: "get",
42
+ pathTemplate: "/api/v1/audits/types",
43
+ options
44
+ });
45
+ }
46
+ async function getAudit(id, options) {
47
+ return invokeFetch("audits", {
48
+ method: "get",
49
+ pathTemplate: "/api/v1/audits/{id}",
50
+ pathVariables: { id },
51
+ options
52
+ });
53
+ }
42
54
  function clearCache() {
43
55
  return clearApiCache("audits");
44
56
  }
@@ -58,8 +58,20 @@ type AuthenticationErrorAction = {
58
58
  */
59
59
  preventDefault?: boolean;
60
60
  };
61
+ /** A typed string array with extracted required properties from a type */
62
+ type RequiredKeys<T> = {
63
+ [K in keyof T]-?: {} extends Pick<T, K> ? never : K;
64
+ }[keyof T];
65
+ /** A typed string array with extracted optional properties from a type */
66
+ type OptionalKeys<T> = {
67
+ [K in keyof T]-?: {} extends Pick<T, K> ? K : never;
68
+ }[keyof T];
61
69
  /** An authentication module for a specific authentication format, like oauth, cookies etc */
62
70
  type AuthModule<A extends AuthType = AuthType> = {
71
+ /** Properties required for this auth module */
72
+ requiredProps?: RequiredKeys<HostConfig<A>>[];
73
+ /** Properties that are optional for this auth module */
74
+ optionalProps?: OptionalKeys<HostConfig<A>>[];
63
75
  /** Get auth params for rest api calls */
64
76
  getRestCallAuthParams: (props: GetRestCallAuthParamsProps<A>) => Promise<RestCallAuthParams>;
65
77
  /** Get auth params for websocket api calls */
@@ -77,14 +89,6 @@ type AuthType = keyof QlikAuthModules;
77
89
  type HostConfig<A extends AuthType = AuthType> = {
78
90
  [K in keyof QlikAuthModules]: QlikAuthModuleConfigUnion<K> & HostConfigCommon;
79
91
  }[A];
80
- /** The keys in this interface are used to determine what auth types that are allowed to be set to undefined */
81
- interface ImplicitQlikAuthModules {
82
- apikey: object;
83
- oauth2: object;
84
- cookie: object;
85
- reference: object;
86
- anonymous: object;
87
- }
88
92
  type QlikAuthModuleConfigUnion<K extends keyof QlikAuthModules> = (K extends keyof ImplicitQlikAuthModules ? {
89
93
  authType?: K;
90
94
  } : {
@@ -103,5 +107,21 @@ type HostConfigCommon = {
103
107
  message: string;
104
108
  }) => unknown;
105
109
  };
110
+ /**
111
+ * These properties are always allowed in the host config, even if they are not defined in the HostConfig interface
112
+ * for the specific auth module.
113
+ */
114
+ declare const hostConfigCommonProperties: (keyof HostConfig)[];
115
+ /** The keys in this interface are used to determine what auth types that are allowed to be set to undefined */
116
+ interface ImplicitQlikAuthModules {
117
+ apikey: object;
118
+ oauth2: object;
119
+ cookie: object;
120
+ windowscookie: object;
121
+ reference: object;
122
+ anonymous: object;
123
+ }
124
+ type AuthTypeThatCanBeOmitted = keyof ImplicitQlikAuthModules;
125
+ declare const authTypesThatCanBeOmitted: AuthTypeThatCanBeOmitted[];
106
126
 
107
- export type { AuthType as A, Credentials as C, GetRestCallAuthParamsProps as G, HostConfig as H, RestCallAuthParams as R, WebSocketAuthParams as W, AuthModule as a, GetWebSocketAuthParamsProps as b, GetWebResourceAuthParamsProps as c, WebResourceAuthParams as d, GetRemoteAuthDataProps as e, HandleAuthenticationErrorProps as f, AuthenticationErrorAction as g };
127
+ export { type AuthType as A, type Credentials as C, type GetRestCallAuthParamsProps as G, type HostConfig as H, type RestCallAuthParams as R, type WebResourceAuthParams as W, type AuthModule as a, type GetWebSocketAuthParamsProps as b, type WebSocketAuthParams as c, type GetWebResourceAuthParamsProps as d, type GetRemoteAuthDataProps as e, type HandleAuthenticationErrorProps as f, type AuthenticationErrorAction as g, type HostConfigCommon as h, hostConfigCommonProperties as i, type AuthTypeThatCanBeOmitted as j, authTypesThatCanBeOmitted as k };
package/auth.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { A as AuthType, a as AuthModule, H as HostConfig } from './auth-types-DqfMuSRX.js';
2
- export { g as AuthenticationErrorAction, C as Credentials, e as GetRemoteAuthDataProps, G as GetRestCallAuthParamsProps, c as GetWebResourceAuthParamsProps, b as GetWebSocketAuthParamsProps, f as HandleAuthenticationErrorProps, R as RestCallAuthParams, d as WebResourceAuthParams, W as WebSocketAuthParams } from './auth-types-DqfMuSRX.js';
1
+ import { A as AuthType, a as AuthModule, H as HostConfig, W as WebResourceAuthParams } from './auth-types-Cj5bM3Yk.js';
2
+ export { j as AuthTypeThatCanBeOmitted, g as AuthenticationErrorAction, C as Credentials, e as GetRemoteAuthDataProps, G as GetRestCallAuthParamsProps, d as GetWebResourceAuthParamsProps, b as GetWebSocketAuthParamsProps, f as HandleAuthenticationErrorProps, h as HostConfigCommon, R as RestCallAuthParams, c as WebSocketAuthParams, k as authTypesThatCanBeOmitted, i as hostConfigCommonProperties } from './auth-types-Cj5bM3Yk.js';
3
3
 
4
4
  /**
5
5
  * Registers an auth module that can handle authentication. An auth module is used by specifying its name as authType in the HostConfig passed in to api calls.
@@ -36,7 +36,14 @@ declare function getAccessToken({ hostConfig }: {
36
36
  hostConfig?: HostConfig;
37
37
  }): Promise<string>;
38
38
  /**
39
- * The AuthApi interface provides the public interface for the auth module.
39
+ * Returns a record of query parameters that needs to be added to resources requests, e.g.
40
+ * image tags, etc.
41
+ */
42
+ declare function getWebResourceAuthParams({ hostConfig, }: {
43
+ hostConfig?: HostConfig;
44
+ }): Promise<WebResourceAuthParams>;
45
+ /**
46
+ * The AuthAPI interface provides the public interface for the auth module.
40
47
  */
41
48
  interface AuthAPI {
42
49
  /**
@@ -65,6 +72,11 @@ interface AuthAPI {
65
72
  * Returns an access token using the supplied host config. Typically used on the backend to supply the access token to the frontend
66
73
  */
67
74
  getAccessToken: typeof getAccessToken;
75
+ /**
76
+ * Returns a record of query parameters that needs to be added to resources requests, e.g.
77
+ * image tags, etc.
78
+ */
79
+ getWebResourceAuthParams: typeof getWebResourceAuthParams;
68
80
  }
69
81
  declare const _default: {
70
82
  registerAuthModule: typeof registerAuthModule;
@@ -72,6 +84,7 @@ declare const _default: {
72
84
  registerHostConfig: typeof registerHostConfig;
73
85
  unregisterHostConfig: typeof unregisterHostConfig;
74
86
  getAccessToken: typeof getAccessToken;
87
+ getWebResourceAuthParams: typeof getWebResourceAuthParams;
75
88
  };
76
89
 
77
- export { type AuthAPI, AuthModule, AuthType, HostConfig, _default as default, getAccessToken, logout, registerAuthModule, registerHostConfig, setDefaultHostConfig, unregisterHostConfig };
90
+ export { type AuthAPI, AuthModule, AuthType, HostConfig, WebResourceAuthParams, _default as default, getAccessToken, getWebResourceAuthParams, logout, registerAuthModule, registerHostConfig, setDefaultHostConfig, unregisterHostConfig };
package/auth.js CHANGED
@@ -1,16 +1,18 @@
1
1
  import {
2
2
  auth_default,
3
3
  getAccessToken,
4
+ getWebResourceAuthParams,
4
5
  logout,
5
6
  registerAuthModule,
6
7
  registerHostConfig,
7
8
  setDefaultHostConfig,
8
9
  unregisterHostConfig
9
- } from "./chunks/GUU3KZGK.js";
10
- import "./chunks/DLKLPD7T.js";
10
+ } from "./chunks/SPATCXXU.js";
11
+ import "./chunks/GPRUNZV4.js";
11
12
  export {
12
13
  auth_default as default,
13
14
  getAccessToken,
15
+ getWebResourceAuthParams,
14
16
  logout,
15
17
  registerAuthModule,
16
18
  registerHostConfig,