@qlik/api 1.30.0 → 1.31.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 (86) hide show
  1. package/api-keys.d.ts +2 -2
  2. package/api-keys.js +2 -2
  3. package/apps.d.ts +4 -2
  4. package/apps.js +2 -2
  5. package/audits.d.ts +2 -2
  6. package/audits.js +2 -2
  7. package/{auth-types-PkN9CAF_.d.ts → auth-types-DqfMuSRX.d.ts} +1 -0
  8. package/auth.d.ts +27 -3
  9. package/auth.js +8 -4
  10. package/automations.d.ts +2 -2
  11. package/automations.js +2 -2
  12. package/brands.d.ts +2 -2
  13. package/brands.js +2 -2
  14. package/chunks/{JIX6RMFP.js → 6ZONDHRN.js} +1 -1
  15. package/chunks/{TXC5XORK.js → DLKLPD7T.js} +3 -3
  16. package/chunks/ETNHFALU.js +61 -0
  17. package/chunks/{G6QUM5WQ.js → FKDGGR2O.js} +137 -45
  18. package/chunks/{QK4TMJ64.js → GUU3KZGK.js} +11 -1
  19. package/chunks/{IQBP2PKS.js → KBSD75QL.js} +1 -1
  20. package/chunks/{OTTC4QSX.js → LY7RP2HA.js} +7 -3
  21. package/chunks/{FKCZFVJL.js → M64RLKVG.js} +2074 -12
  22. package/chunks/{F5UDCCRD.js → PLVPW5IR.js} +1 -1
  23. package/chunks/{QWQLGDMI.js → UZTIZ4H5.js} +392 -372
  24. package/chunks/{PTDXR7AY.js → YKZ2QYHN.js} +2 -2
  25. package/collections.d.ts +3 -3
  26. package/collections.js +2 -2
  27. package/csp-origins.d.ts +2 -2
  28. package/csp-origins.js +2 -2
  29. package/data-assets.d.ts +2 -2
  30. package/data-assets.js +2 -2
  31. package/data-connections.d.ts +7 -7
  32. package/data-connections.js +2 -2
  33. package/data-credentials.d.ts +2 -2
  34. package/data-credentials.js +2 -2
  35. package/data-files.d.ts +2 -2
  36. package/data-files.js +2 -2
  37. package/docs/authentication.md +47 -0
  38. package/extensions.d.ts +2 -2
  39. package/extensions.js +2 -2
  40. package/glossaries.d.ts +2 -2
  41. package/glossaries.js +2 -2
  42. package/groups.d.ts +5 -4
  43. package/groups.js +2 -2
  44. package/identity-providers.d.ts +2 -2
  45. package/identity-providers.js +2 -2
  46. package/index.d.ts +5 -3
  47. package/index.js +4 -4
  48. package/interceptors.d.ts +2 -2
  49. package/{invoke-fetch-types-BXn-uSF5.d.ts → invoke-fetch-types-Cq7bjkqn.d.ts} +10 -2
  50. package/items.d.ts +3 -3
  51. package/items.js +2 -2
  52. package/licenses.d.ts +5 -2
  53. package/licenses.js +2 -2
  54. package/oauth-clients.d.ts +7 -2
  55. package/oauth-clients.js +2 -2
  56. package/package.json +3 -2
  57. package/qix.d.ts +421 -26
  58. package/qix.js +2 -2
  59. package/quotas.d.ts +2 -2
  60. package/quotas.js +2 -2
  61. package/reload-tasks.d.ts +4 -2
  62. package/reload-tasks.js +2 -2
  63. package/reloads.d.ts +4 -2
  64. package/reloads.js +2 -2
  65. package/reports.d.ts +2 -2
  66. package/reports.js +2 -2
  67. package/roles.d.ts +2 -2
  68. package/roles.js +2 -2
  69. package/spaces.d.ts +3 -7
  70. package/spaces.js +2 -2
  71. package/temp-contents.d.ts +2 -2
  72. package/temp-contents.js +2 -2
  73. package/tenants.d.ts +2 -2
  74. package/tenants.js +2 -2
  75. package/themes.d.ts +2 -2
  76. package/themes.js +2 -2
  77. package/transports.d.ts +2 -2
  78. package/transports.js +2 -2
  79. package/users.d.ts +2 -2
  80. package/users.js +2 -2
  81. package/web-integrations.d.ts +2 -2
  82. package/web-integrations.js +2 -2
  83. package/web-notifications.d.ts +2 -2
  84. package/web-notifications.js +2 -2
  85. package/webhooks.d.ts +2 -2
  86. package/webhooks.js +2 -2
package/api-keys.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
2
- import './auth-types-PkN9CAF_.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
2
+ import './auth-types-DqfMuSRX.js';
3
3
 
4
4
  type ApiKey = {
5
5
  /** When the API key was created. */
package/api-keys.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/PTDXR7AY.js";
5
- import "./chunks/TXC5XORK.js";
4
+ } from "./chunks/YKZ2QYHN.js";
5
+ import "./chunks/DLKLPD7T.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/api-keys.ts
package/apps.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { A as ApiCallOptions, D as DownloadableBlob } from './invoke-fetch-types-BXn-uSF5.js';
2
- import './auth-types-PkN9CAF_.js';
1
+ import { A as ApiCallOptions, D as DownloadableBlob } from './invoke-fetch-types-Cq7bjkqn.js';
2
+ import './auth-types-DqfMuSRX.js';
3
3
 
4
4
  type Analysis = "breakdown" | "changePoint" | "comparison" | "contribution" | "correlation" | "fact" | "mutualInfo" | "rank" | "spike" | "trend" | "values";
5
5
  type AnalysisComposition = {
@@ -286,6 +286,8 @@ type FieldInTableProfilingData = {
286
286
  Average?: number;
287
287
  /** Average string length of textual values. 0 otherwise. */
288
288
  AvgStringLen?: number;
289
+ /** Data evenness aka Shannon's entropy normalized to [0,1] */
290
+ DataEvenness?: number;
289
291
  /** Number of distinct numeric values */
290
292
  DistinctNumericValues?: number;
291
293
  /** Number of distinct text values */
package/apps.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/PTDXR7AY.js";
5
- import "./chunks/TXC5XORK.js";
4
+ } from "./chunks/YKZ2QYHN.js";
5
+ import "./chunks/DLKLPD7T.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/apps.ts
package/audits.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
2
- import './auth-types-PkN9CAF_.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
2
+ import './auth-types-DqfMuSRX.js';
3
3
 
4
4
  type ArchiveItem = {
5
5
  /** The type that content is encoded in, always "application/json". */
package/audits.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/PTDXR7AY.js";
5
- import "./chunks/TXC5XORK.js";
4
+ } from "./chunks/YKZ2QYHN.js";
5
+ import "./chunks/DLKLPD7T.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/audits.ts
@@ -82,6 +82,7 @@ interface ImplicitQlikAuthModules {
82
82
  apikey: object;
83
83
  oauth2: object;
84
84
  cookie: object;
85
+ reference: object;
85
86
  anonymous: object;
86
87
  }
87
88
  type QlikAuthModuleConfigUnion<K extends keyof QlikAuthModules> = (K extends keyof ImplicitQlikAuthModules ? {
package/auth.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { A as AuthType, a as AuthModule, H as HostConfig } from './auth-types-PkN9CAF_.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-PkN9CAF_.js';
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';
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.
@@ -18,6 +18,17 @@ declare function logout(): void;
18
18
  * @param hostConfig the default HostConfig to use
19
19
  */
20
20
  declare function setDefaultHostConfig(hostConfig: HostConfig | undefined): void;
21
+ /**
22
+ * Registers a host config with the given name.
23
+ * @param name The name of the host config to be used to reference the host config later.
24
+ * @param hostConfig The host config to register.
25
+ */
26
+ declare function registerHostConfig(name: string, hostConfig: HostConfig): void;
27
+ /**
28
+ * Unregisters a host config with the given name.
29
+ * @param name The name of the host config to unregister.
30
+ */
31
+ declare function unregisterHostConfig(name: string): void;
21
32
  /**
22
33
  * Returns an access token using the supplied host config. Typically used on the backend to supply the access token to the frontend
23
34
  */
@@ -39,6 +50,17 @@ interface AuthAPI {
39
50
  * @param hostConfig the default HostConfig to use
40
51
  */
41
52
  setDefaultHostConfig: typeof setDefaultHostConfig;
53
+ /**
54
+ * Registers a host config with the given name.
55
+ * @param name The name of the host config to be used to reference the host config later.
56
+ * @param hostConfig The host config to register.
57
+ */
58
+ registerHostConfig: typeof registerHostConfig;
59
+ /**
60
+ * Unregisters a host config with the given name.
61
+ * @param name The name of the host config to unregister.
62
+ */
63
+ unregisterHostConfig: typeof unregisterHostConfig;
42
64
  /**
43
65
  * Returns an access token using the supplied host config. Typically used on the backend to supply the access token to the frontend
44
66
  */
@@ -47,7 +69,9 @@ interface AuthAPI {
47
69
  declare const _default: {
48
70
  registerAuthModule: typeof registerAuthModule;
49
71
  setDefaultHostConfig: typeof setDefaultHostConfig;
72
+ registerHostConfig: typeof registerHostConfig;
73
+ unregisterHostConfig: typeof unregisterHostConfig;
50
74
  getAccessToken: typeof getAccessToken;
51
75
  };
52
76
 
53
- export { type AuthAPI, AuthModule, AuthType, HostConfig, _default as default, getAccessToken, logout, registerAuthModule, setDefaultHostConfig };
77
+ export { type AuthAPI, AuthModule, AuthType, HostConfig, _default as default, getAccessToken, logout, registerAuthModule, registerHostConfig, setDefaultHostConfig, unregisterHostConfig };
package/auth.js CHANGED
@@ -3,13 +3,17 @@ import {
3
3
  getAccessToken,
4
4
  logout,
5
5
  registerAuthModule,
6
- setDefaultHostConfig
7
- } from "./chunks/QK4TMJ64.js";
8
- import "./chunks/TXC5XORK.js";
6
+ registerHostConfig,
7
+ setDefaultHostConfig,
8
+ unregisterHostConfig
9
+ } from "./chunks/GUU3KZGK.js";
10
+ import "./chunks/DLKLPD7T.js";
9
11
  export {
10
12
  auth_default as default,
11
13
  getAccessToken,
12
14
  logout,
13
15
  registerAuthModule,
14
- setDefaultHostConfig
16
+ registerHostConfig,
17
+ setDefaultHostConfig,
18
+ unregisterHostConfig
15
19
  };
package/automations.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
2
- import './auth-types-PkN9CAF_.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
2
+ import './auth-types-DqfMuSRX.js';
3
3
 
4
4
  type AutomationDetailRequestObject = {
5
5
  description?: string;
package/automations.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/PTDXR7AY.js";
5
- import "./chunks/TXC5XORK.js";
4
+ } from "./chunks/YKZ2QYHN.js";
5
+ import "./chunks/DLKLPD7T.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/automations.ts
package/brands.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { A as ApiCallOptions, D as DownloadableBlob } from './invoke-fetch-types-BXn-uSF5.js';
2
- import './auth-types-PkN9CAF_.js';
1
+ import { A as ApiCallOptions, D as DownloadableBlob } from './invoke-fetch-types-Cq7bjkqn.js';
2
+ import './auth-types-DqfMuSRX.js';
3
3
 
4
4
  /**
5
5
  * A brand is a collection of assets for applying custom branding. Only a single brand can be active in a tenant.
package/brands.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/PTDXR7AY.js";
5
- import "./chunks/TXC5XORK.js";
4
+ } from "./chunks/YKZ2QYHN.js";
5
+ import "./chunks/DLKLPD7T.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/brands.ts
@@ -5,7 +5,7 @@ import {
5
5
  invokeFetch,
6
6
  invoke_fetch_default,
7
7
  parseFetchResponse
8
- } from "./G6QUM5WQ.js";
8
+ } from "./FKDGGR2O.js";
9
9
  import "./3RGGGGAR.js";
10
10
  import "./2ZQ3ZX7F.js";
11
11
  export {
@@ -1,21 +1,21 @@
1
1
  // src/public/public-runtime-modules.ts
2
2
  function getAuthRuntimeModule(hostConfig) {
3
3
  const isNode = !!globalThis.process?.argv;
4
- return isNode ? import("./OTTC4QSX.js") : import("./F5UDCCRD.js").then(
4
+ return isNode ? import("./LY7RP2HA.js") : import("./PLVPW5IR.js").then(
5
5
  (mod) => mod.importRuntimeModule("auth@v1", hostConfig)
6
6
  );
7
7
  }
8
8
  async function getQixRuntimeModule(hostConfig) {
9
9
  await getAuthRuntimeModule(hostConfig);
10
10
  const isNode = !!globalThis.process?.argv;
11
- return isNode ? import("./QWQLGDMI.js") : import("./F5UDCCRD.js").then(
11
+ return isNode ? import("./UZTIZ4H5.js") : import("./PLVPW5IR.js").then(
12
12
  (mod) => mod.importRuntimeModule("qix@v1", hostConfig)
13
13
  );
14
14
  }
15
15
  async function getInvokeFetchRuntimeModule(hostConfig) {
16
16
  await getAuthRuntimeModule(hostConfig);
17
17
  const isNode = !!globalThis.process?.argv;
18
- return isNode ? import("./JIX6RMFP.js") : import("./F5UDCCRD.js").then(
18
+ return isNode ? import("./6ZONDHRN.js") : import("./PLVPW5IR.js").then(
19
19
  (mod) => mod.importRuntimeModule("invoke-fetch@v1", hostConfig)
20
20
  );
21
21
  }
@@ -0,0 +1,61 @@
1
+ // src/qix/session/websocket-errors.ts
2
+ var closeCodeEngineTerminating = 4003;
3
+ var closeCodeEngineProxyGeneric = 4200;
4
+ var closeCodeClientTimeout = 4201;
5
+ var closeCodeBadRequest = 4202;
6
+ var closeCodePermissions = 4203;
7
+ var closeCodeNotFound = 4204;
8
+ var closeCodeTooManyRequests = 4205;
9
+ var closeCodeNetwork = 4206;
10
+ var closeCodeDependencyGeneric = 4210;
11
+ var closeCodeDependencyUnavailable = 4211;
12
+ var closeCodeEngineGeneric = 4220;
13
+ var closeCodeEntitlement = 4230;
14
+ var closeCodeNoEnginesAvailable = 4240;
15
+ var CloseCodeSessionReservationMissing = 4222;
16
+ var closeCodeMessages = {
17
+ 1e3: "Connection closed normally.",
18
+ 1001: "Going away.",
19
+ 1002: "Protocol error.",
20
+ 1003: "Unsupported data.",
21
+ 1005: "No status received.",
22
+ 1006: "Abnormal closure.",
23
+ 1007: "Invalid frame payload data.",
24
+ 1008: "Policy violation.",
25
+ 1009: "Message too big.",
26
+ 1010: "Mandatory extension missing.",
27
+ 1011: "Server internal error.",
28
+ 1012: "Service restart.",
29
+ 1013: "Try again later.",
30
+ 1014: "Bad gateway.",
31
+ 1015: "TLS handshake failure.",
32
+ [closeCodeEngineTerminating]: "The engine is in terminating state",
33
+ [closeCodeEngineProxyGeneric]: "A problem occurred in engine-proxy",
34
+ [closeCodeClientTimeout]: "The client has closed the connection",
35
+ [closeCodeBadRequest]: "The provided request is invalid and/or malformed",
36
+ [closeCodePermissions]: "No permission to open the app",
37
+ [closeCodeNotFound]: "App not found",
38
+ [closeCodeTooManyRequests]: "Too many requests have been sent in a given amount of time",
39
+ [closeCodeNetwork]: "Networking issues",
40
+ [closeCodeDependencyGeneric]: "A problem occurred in a dependency of engine-proxy",
41
+ [closeCodeDependencyUnavailable]: "A dependency is unavailable and not serving any requests",
42
+ [closeCodeEngineGeneric]: "A problem occurred in an engine",
43
+ [closeCodeEntitlement]: "You are not entitled to perform that operation",
44
+ [closeCodeNoEnginesAvailable]: "There are currently no engines available",
45
+ [CloseCodeSessionReservationMissing]: "The reserved session is missing"
46
+ };
47
+ var uknownCloseErrorMessage = "websocket closed for unknown reason";
48
+ function getHumanReadableSocketClosedErrorMessage(err, { appId, hostConfig }) {
49
+ const closeCode = err?.original?.code || err?.code;
50
+ const reason = err?.original?.reason || err?.reason;
51
+ const closeMessage = closeCode && closeCodeMessages[closeCode] || reason || err.message || uknownCloseErrorMessage;
52
+ if (hostConfig?.host) {
53
+ return `Failed to open app ${appId} on ${hostConfig?.host}: ${closeMessage}`;
54
+ } else {
55
+ return `Failed to open app ${appId}: ${closeMessage}`;
56
+ }
57
+ }
58
+
59
+ export {
60
+ getHumanReadableSocketClosedErrorMessage
61
+ };