@qlik/api 1.50.0 → 2.1.0

package/chunks/{auth-FQsMkh58.js → auth-sNi1A67-.js}

@@ -1,8 +1,8 @@
-import "./utils-DI6bFnHB.js";
-import "./interceptors-CT9deBo6.js";
-import "./global-types-BGMD2sDY.js";
-import "./auth-types-BuIzsuoh.js";
-import { _ as unregisterHostConfig, a as getWebResourceAuthParams, b as InvalidHostConfigError, c as isHostCrossOrigin, d as registerAuthModule, f as registerHostConfig, g as toValidWebsocketLocationUrl, h as toValidLocationUrl, i as getRestCallAuthParams, l as isWindows, m as setDefaultHostConfig, n as getAccessToken, o as getWebSocketAuthParams, p as serializeHostConfig, r as getDefaultHostConfig, s as handleAuthenticationError, t as determineAuthType, u as logout, v as AuthorizationError, x as UnexpectedAuthTypeError, y as InvalidAuthTypeError } from "./auth-functions-BZN9dCw1.js";
+import "./utils-UaAiVTcc.js";
+import "./interceptors-DoQ44M-n.js";
+import "./global-types-DW_kb7P7.js";
+import "./auth-types-BEj8JjOA.js";
+import { _ as unregisterHostConfig, a as getWebResourceAuthParams, b as InvalidHostConfigError, c as isHostCrossOrigin, d as registerAuthModule, f as registerHostConfig, g as toValidWebsocketLocationUrl, h as toValidLocationUrl, i as getRestCallAuthParams, l as isWindows, m as setDefaultHostConfig, n as getAccessToken, o as getWebSocketAuthParams, p as serializeHostConfig, r as getDefaultHostConfig, s as handleAuthenticationError, t as determineAuthType, u as logout, v as AuthorizationError, x as UnexpectedAuthTypeError, y as InvalidAuthTypeError } from "./auth-functions-C27LB1gE.js";
 
 //#region src/auth/auth.ts
 /**

package/chunks/{auth-types-BK8AvfyD.d.ts → auth-types-CHOUViJI.d.ts}

@@ -112,6 +112,35 @@ type PartialProgressEvent = {
 };
 declare const _default: {};
 //#endregion
+//#region src/platform/platform-types.d.ts
+
+/** Data is accessible on `/resources/autogenerated/product-info.json` on any deployment */
+type ProductInfo = {
+  composition?: {
+    contentHash?: string;
+    senseId: string;
+    releaseLabel?: string;
+    originalClassName?: string;
+    productName?: string;
+    version?: string;
+    copyrightYearRange?: string;
+    deploymentEnvironment?: string;
+    deploymentType?: "qliksenseserver" | "qliksensedesktop" | "QlikSenseMobile" | "qlikcloudservices" | "cloud-console";
+    provider?: string;
+  };
+  externalUrls: {
+    contentHash?: string;
+    originalClassName?: string;
+    personalUpgradeBase: string;
+    cloudUploadUrl: string;
+    serverHelpBaseUrl: string;
+    personalHelpBaseUrl: string;
+    personalUpgradeUrl: string;
+    qlikWebPageUrl: string;
+    cloudBaseUrl: string;
+  };
+};
+//#endregion
 //#region src/global-types.d.ts
 /** ApiKey Auth Configuration for a HostConfig */
 type ApiKeyAuthConfig = {
@@ -129,13 +158,15 @@ type CookieAuthConfig = {
 };
 /** WindowsCookie Auth Configuration for a HostConfig */
 type WindowsCookieAuthConfig = {
-  /** location of the login page, auth module will redirect to this page when an unauthenticated api call is made */
+  /** location of the login page, auth module will redirect to this page when an unauthenticated api call is made. Not applicable in Node.js environments. */
   loginUri?: string;
-  /** If set to false the `credentials` property will be set to same-origin  */
+  /** If set to false the `credentials` property will be set to same-origin. Not applicable in Node.js environments. */
   crossSiteCookies?: boolean;
   /**
-   * A custom function that can be used on the client side to fetch a windows auth jwt from a custom backend.
+   * A custom function that can be used to fetch a windows auth jwt.
    * The jwt will be exchanged for a session cookie.
+   * In the browser this should typically fetch the jwt from a custom backend service.
+   * Mandatory in Node.js environments.
    */
   getAccessToken?: string | (() => Promise<string>);
 };
@@ -252,6 +283,7 @@ declare global {
   var QlikMain: {
     resourceNeedsCredentials: (resourcesUrl: string) => boolean;
     applyFeatureOverrides: (featureFlags: Record<string, boolean>) => Promise<void>;
+    productInfo: () => ProductInfo;
   } | undefined;
 }
 //#endregion
@@ -276,7 +308,9 @@ type GetWebSocketAuthParamsProps<A extends AuthType = AuthType> = {
 };
 /** Websocket auth parameters to use when setting up a websocket based on a host config */
 type WebSocketAuthParams = {
-  queryParams: Record<string, string>;
+  /** Note that headers are only applied in NodeJS environments and NOT in the browser */
+  headers?: Record<string, string>;
+  queryParams?: Record<string, string>;
 };
 /** Props for function getWebResourceAuthParams */
 type GetWebResourceAuthParamsProps<A extends AuthType = AuthType> = {

package/chunks/{automation-connections-BRSXAkab.d.ts → automation-connections-Cyhb0FaN.d.ts}

@@ -1,4 +1,4 @@
-import { y as ApiCallOptions } from "./auth-types-BK8AvfyD.js";
+import { y as ApiCallOptions } from "./auth-types-CHOUViJI.js";
 
 //#region src/public/rest/automation-connections.d.ts
 type AutomationConnectionChangeOwnerObject = {

package/chunks/{automation-connectors-Bx48-M4g.d.ts → automation-connectors-LrawaoDq.d.ts}

@@ -1,4 +1,4 @@
-import { y as ApiCallOptions } from "./auth-types-BK8AvfyD.js";
+import { y as ApiCallOptions } from "./auth-types-CHOUViJI.js";
 
 //#region src/public/rest/automation-connectors.d.ts
 type AutomationConnectorsList = {

package/chunks/{automations-Dugu45RA.d.ts → automations-BYujmPxM.d.ts}

@@ -1,4 +1,4 @@
-import { y as ApiCallOptions } from "./auth-types-BK8AvfyD.js";
+import { y as ApiCallOptions } from "./auth-types-CHOUViJI.js";
 
 //#region src/public/rest/automations.d.ts
 type AutomationDetailRequestObject = {

package/chunks/{automl-deployments-Boip7E0T.d.ts → automl-deployments-Bz4hIBQD.d.ts}

@@ -1,4 +1,4 @@
-import { y as ApiCallOptions } from "./auth-types-BK8AvfyD.js";
+import { y as ApiCallOptions } from "./auth-types-CHOUViJI.js";
 
 //#region src/public/rest/automl-deployments.d.ts
 type AppErrorResponse = {

package/chunks/{automl-predictions-DdkRNsA7.d.ts → automl-predictions-DnnHn5n_.d.ts}

@@ -1,4 +1,4 @@
-import { y as ApiCallOptions } from "./auth-types-BK8AvfyD.js";
+import { y as ApiCallOptions } from "./auth-types-CHOUViJI.js";
 
 //#region src/public/rest/automl-predictions.d.ts
 type AppErrorResponse = {

package/chunks/banners-C8iUbLA2.d.ts

@@ -0,0 +1,184 @@
+import { y as ApiCallOptions } from "./auth-types-CHOUViJI.js";
+
+//#region src/public/rest/banners.d.ts
+type BannerResponse = {
+  readonly createdAt: string;
+  /** userId of the user who created the banner */
+  createdBy: string;
+  enabled: boolean;
+  /** date-time in UTC. */
+  endTime: string;
+  readonly id: string;
+  linkEnabled: boolean;
+  linkLabel?: string;
+  linkUrl?: string;
+  message: string;
+  /** date-time in UTC. */
+  startTime: string;
+  readonly tenantId: string;
+  type: "info" | "warning" | "error" | "resolved";
+  readonly updatedAt: string;
+  /** userId of the user who last modified the banner */
+  updatedBy: string;
+};
+type BannerUpsertDefinition = {
+  enabled: boolean;
+  /** date-time in UTC. */
+  endTime: string;
+  linkEnabled: boolean;
+  linkLabel?: string;
+  linkUrl?: string;
+  message: string;
+  /** date-time in UTC. */
+  startTime: string;
+  type: "info" | "warning" | "error" | "resolved";
+};
+type ErrorResponse400 = {
+  errors?: {
+    code?: string;
+    detail?: string;
+    status?: number;
+    title?: string;
+  }[];
+  traceId?: string;
+};
+type ErrorResponse401 = {
+  errors?: {
+    code?: string;
+    detail?: string;
+    status?: number;
+    title?: string;
+  }[];
+  traceId?: string;
+};
+type ErrorResponse403 = {
+  errors?: {
+    code?: string;
+    detail?: string;
+    status?: number;
+    title?: string;
+  }[];
+  traceId?: string;
+};
+type ErrorResponse404 = {
+  errors?: {
+    code?: string;
+    detail?: string;
+    status?: number;
+    title?: string;
+  }[];
+  traceId?: string;
+};
+type ErrorResponse500 = {
+  errors?: {
+    code?: string;
+    detail?: string;
+    status?: number;
+    title?: string;
+  }[];
+  traceId?: string;
+};
+/**
+ * Retrieves announcement banner configuration for the tenant, including content, scheduling, and link information for display at the top of the client interface.
+ *
+ * @throws GetBannersHttpError
+ */
+declare function getBanners(options?: ApiCallOptions): Promise<GetBannersHttpResponse>;
+type GetBannersHttpResponse = {
+  data: BannerResponse;
+  headers: Headers;
+  status: 200;
+};
+type GetBannersHttpError = GetBanners400HttpError | GetBanners401HttpError | GetBanners403HttpError | GetBanners404HttpError | GetBanners500HttpError;
+type GetBanners400HttpError = {
+  data: ErrorResponse400;
+  headers: Headers;
+  status: 400;
+};
+type GetBanners401HttpError = {
+  data: ErrorResponse401;
+  headers: Headers;
+  status: 401;
+};
+type GetBanners403HttpError = {
+  data: ErrorResponse403;
+  headers: Headers;
+  status: 403;
+};
+type GetBanners404HttpError = {
+  data: ErrorResponse404;
+  headers: Headers;
+  status: 404;
+};
+type GetBanners500HttpError = {
+  data: ErrorResponse500;
+  headers: Headers;
+  status: 500;
+};
+/**
+ * Sets content, scheduling, and optional action links for the tenant-wide announcement banner. Requires `TenantAdmin` role.
+ *
+ * @param body an object with the body content
+ * @throws UpsertBannersHttpError
+ */
+declare function upsertBanners(body: BannerUpsertDefinition, options?: ApiCallOptions): Promise<UpsertBannersHttpResponse>;
+type UpsertBannersHttpResponse = {
+  data: BannerResponse;
+  headers: Headers;
+  status: 201;
+};
+type UpsertBannersHttpError = UpsertBanners400HttpError | UpsertBanners401HttpError | UpsertBanners403HttpError | UpsertBanners404HttpError | UpsertBanners500HttpError;
+type UpsertBanners400HttpError = {
+  data: ErrorResponse400;
+  headers: Headers;
+  status: 400;
+};
+type UpsertBanners401HttpError = {
+  data: ErrorResponse401;
+  headers: Headers;
+  status: 401;
+};
+type UpsertBanners403HttpError = {
+  data: ErrorResponse403;
+  headers: Headers;
+  status: 403;
+};
+type UpsertBanners404HttpError = {
+  data: ErrorResponse404;
+  headers: Headers;
+  status: 404;
+};
+type UpsertBanners500HttpError = {
+  data: ErrorResponse500;
+  headers: Headers;
+  status: 500;
+};
+/**
+ * Clears the cache for banners api requests.
+ */
+declare function clearCache(): void;
+type BannersAPI = {
+  /**
+   * Retrieves announcement banner configuration for the tenant, including content, scheduling, and link information for display at the top of the client interface.
+   *
+   * @throws GetBannersHttpError
+   */
+  getBanners: typeof getBanners;
+  /**
+   * Sets content, scheduling, and optional action links for the tenant-wide announcement banner. Requires `TenantAdmin` role.
+   *
+   * @param body an object with the body content
+   * @throws UpsertBannersHttpError
+   */
+  upsertBanners: typeof upsertBanners;
+  /**
+   * Clears the cache for banners api requests.
+   */
+  clearCache: typeof clearCache;
+};
+/**
+ * Functions for the banners api
+ */
+declare const bannersExport: BannersAPI;
+//#endregion
+export { bannersExport as C, upsertBanners as E, UpsertBannersHttpResponse as S, getBanners as T, UpsertBanners401HttpError as _, ErrorResponse401 as a, UpsertBanners500HttpError as b, ErrorResponse500 as c, GetBanners403HttpError as d, GetBanners404HttpError as f, UpsertBanners400HttpError as g, GetBannersHttpResponse as h, ErrorResponse400 as i, GetBanners400HttpError as l, GetBannersHttpError as m, BannerUpsertDefinition as n, ErrorResponse403 as o, GetBanners500HttpError as p, BannersAPI as r, ErrorResponse404 as s, BannerResponse as t, GetBanners401HttpError as u, UpsertBanners403HttpError as v, clearCache as w, UpsertBannersHttpError as x, UpsertBanners404HttpError as y };

package/chunks/{brands-jxEjeVGK.d.ts → brands-C_VLS_bl.d.ts}

@@ -1,4 +1,4 @@
-import { S as DownloadableBlob, y as ApiCallOptions } from "./auth-types-BK8AvfyD.js";
+import { S as DownloadableBlob, y as ApiCallOptions } from "./auth-types-CHOUViJI.js";
 
 //#region src/public/rest/brands.d.ts
 

package/chunks/{collections-DFvDeYCC.d.ts → collections-tmWJxgrt.d.ts}

@@ -1,4 +1,4 @@
-import { y as ApiCallOptions } from "./auth-types-BK8AvfyD.js";
+import { y as ApiCallOptions } from "./auth-types-CHOUViJI.js";
 
 //#region src/public/rest/collections.d.ts
 type CollectionByIdPatch = {

package/chunks/{conditions-DpjEG64S.d.ts → conditions-XN35BSPh.d.ts}

@@ -1,4 +1,4 @@
-import { y as ApiCallOptions } from "./auth-types-BK8AvfyD.js";
+import { y as ApiCallOptions } from "./auth-types-CHOUViJI.js";
 
 //#region src/public/rest/conditions.d.ts
 type APISettings = {

package/chunks/{consumption-CGna485O.d.ts → consumption-DX2Ei4od.d.ts}

@@ -1,4 +1,4 @@
-import { y as ApiCallOptions } from "./auth-types-BK8AvfyD.js";
+import { y as ApiCallOptions } from "./auth-types-CHOUViJI.js";
 
 //#region src/public/rest/consumption.d.ts
 type Enforcement = {

package/chunks/{csp-origins-Dm1bcm6D.d.ts → csp-origins-fyrVQMkf.d.ts}

@@ -1,4 +1,4 @@
-import { y as ApiCallOptions } from "./auth-types-BK8AvfyD.js";
+import { y as ApiCallOptions } from "./auth-types-CHOUViJI.js";
 
 //#region src/public/rest/csp-origins.d.ts
 type CSPEntry = {

package/chunks/{csrf-token-Dl422Xl8.d.ts → csrf-token-VrKslIAO.d.ts}

@@ -1,4 +1,4 @@
-import { y as ApiCallOptions } from "./auth-types-BK8AvfyD.js";
+import { y as ApiCallOptions } from "./auth-types-CHOUViJI.js";
 
 //#region src/public/rest/csrf-token.d.ts
 

package/chunks/{data-alerts-Dsdht3R_.d.ts → data-alerts-Db2z8nxG.d.ts}

@@ -1,4 +1,4 @@
-import { y as ApiCallOptions } from "./auth-types-BK8AvfyD.js";
+import { y as ApiCallOptions } from "./auth-types-CHOUViJI.js";
 
 //#region src/public/rest/data-alerts.d.ts
 type AlertingActionsTriggerCreateRequest = {

package/chunks/{data-assets-BvAuaPP1.d.ts → data-assets-COFtmbYv.d.ts}

@@ -1,4 +1,4 @@
-import { y as ApiCallOptions } from "./auth-types-BK8AvfyD.js";
+import { y as ApiCallOptions } from "./auth-types-CHOUViJI.js";
 
 //#region src/public/rest/data-assets.d.ts
 type BatchIdDto = {

package/chunks/{data-connections-DKs7Dj0l.d.ts → data-connections-CZmEfGNG.d.ts}

@@ -1,4 +1,4 @@
-import { y as ApiCallOptions } from "./auth-types-BK8AvfyD.js";
+import { y as ApiCallOptions } from "./auth-types-CHOUViJI.js";
 
 //#region src/public/rest/data-connections.d.ts
 type ActionDeleteRequest = {

package/chunks/{data-credentials-Dz7QHnsV.d.ts → data-credentials-BJteSNF-.d.ts}

@@ -1,4 +1,4 @@
-import { y as ApiCallOptions } from "./auth-types-BK8AvfyD.js";
+import { y as ApiCallOptions } from "./auth-types-CHOUViJI.js";
 
 //#region src/public/rest/data-credentials.d.ts
 type ActionFilterOrphanRequest = {

package/chunks/{data-files-DwaxubSK.d.ts → data-files-E3LDdwu9.d.ts}

@@ -1,4 +1,4 @@
-import { y as ApiCallOptions } from "./auth-types-BK8AvfyD.js";
+import { y as ApiCallOptions } from "./auth-types-CHOUViJI.js";
 
 //#region src/public/rest/data-files.d.ts
 type BatchChangeSpaceItem = {

package/chunks/{data-qualities-D_epSJNj.d.ts → data-qualities-CDgLWYzn.d.ts}

@@ -1,4 +1,4 @@
-import { y as ApiCallOptions } from "./auth-types-BK8AvfyD.js";
+import { y as ApiCallOptions } from "./auth-types-CHOUViJI.js";
 
 //#region src/public/rest/data-qualities.d.ts
 

package/chunks/{data-sets-BCB4zxdl.d.ts → data-sets-DS9oCHyh.d.ts}

@@ -1,4 +1,4 @@
-import { y as ApiCallOptions } from "./auth-types-BK8AvfyD.js";
+import { y as ApiCallOptions } from "./auth-types-CHOUViJI.js";
 
 //#region src/public/rest/data-sets.d.ts
 type BatchIdDto = {

package/chunks/{data-sources-C6bpRD99.d.ts → data-sources-CsARydcs.d.ts}

@@ -1,4 +1,4 @@
-import { y as ApiCallOptions } from "./auth-types-BK8AvfyD.js";
+import { y as ApiCallOptions } from "./auth-types-CHOUViJI.js";
 
 //#region src/public/rest/data-sources.d.ts
 type ApiSpecResponse = {

package/chunks/{data-stores-NpZrP7K-.d.ts → data-stores-BrMPbFTB.d.ts}

@@ -1,4 +1,4 @@
-import { y as ApiCallOptions } from "./auth-types-BK8AvfyD.js";
+import { y as ApiCallOptions } from "./auth-types-CHOUViJI.js";
 
 //#region src/public/rest/data-stores.d.ts
 type BatchIdDto = {

package/chunks/{dcaas-BjVAcAO6.d.ts → dcaas-BOgO88is.d.ts}

@@ -1,4 +1,4 @@
-import { y as ApiCallOptions } from "./auth-types-BK8AvfyD.js";
+import { y as ApiCallOptions } from "./auth-types-CHOUViJI.js";
 
 //#region src/public/rest/dcaas.d.ts
 type ApiSpecResponse = {

package/chunks/{di-projects-CERxkUMp.d.ts → di-projects-6CTj-fZS.d.ts}

@@ -1,4 +1,4 @@
-import { S as DownloadableBlob, y as ApiCallOptions } from "./auth-types-BK8AvfyD.js";
+import { S as DownloadableBlob, y as ApiCallOptions } from "./auth-types-CHOUViJI.js";
 
 //#region src/public/rest/di-projects.d.ts
 type AsyncActionDetails = {