@qlik/api 1.21.0 → 1.23.0

package/api-keys.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types--37uwGji.js';
+import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
 import './auth-types-PkN9CAF_.js';
 
 type ApiKey = {

package/api-keys.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/DTGUILK5.js";
-import "./chunks/2OQLWLWE.js";
+} from "./chunks/SMQGR3VM.js";
+import "./chunks/3KD5W26Z.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/api-keys.ts

package/apps.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions, D as DownloadableBlob } from './global.types--37uwGji.js';
+import { A as ApiCallOptions, D as DownloadableBlob } from './global.types-qsBNouXJ.js';
 import './auth-types-PkN9CAF_.js';
 
 type Analysis = "breakdown" | "changePoint" | "comparison" | "contribution" | "correlation" | "fact" | "mutualInfo" | "rank" | "spike" | "trend" | "values";
@@ -463,7 +463,15 @@ type FilterError = {
      * - "REP-500000" Fail to resolve resource.
      * - "REP-503005" Engine unavailable, qix-sessions error no engines available.
      * - "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
-     * - "REP-504042" Context deadline exceeded applying selections of the Filter. */
+     * - "REP-504042" Context deadline exceeded applying selections of the Filter.
+     * - "REP-500031" Error creating bookmark.
+     * - "REP-404032" Bookmark not found after creating the bookmark.
+     * - "REP-500033" Error destroying bookmark.
+     * - "REP-404033" Bookmark not found destroying the bookmark.
+     * - "REP-409043" Dupliacate bookmark name.
+     * - "REP-429034" Filters quota exceeded.
+     * - "REP-400044" Missing or renamed field.
+     * - "REP-403049" Report filter access not allowed. */
     code: string;
     /** A summary in english explaining what went wrong. */
     title: string;

package/apps.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/DTGUILK5.js";
-import "./chunks/2OQLWLWE.js";
+} from "./chunks/SMQGR3VM.js";
+import "./chunks/3KD5W26Z.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/apps.ts

package/audits.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types--37uwGji.js';
+import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
 import './auth-types-PkN9CAF_.js';
 
 type ErrorResponse = {

package/audits.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/DTGUILK5.js";
-import "./chunks/2OQLWLWE.js";
+} from "./chunks/SMQGR3VM.js";
+import "./chunks/3KD5W26Z.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/audits.ts

package/auth.js

@@ -4,8 +4,8 @@ import {
   logout,
   registerAuthModule,
   setDefaultHostConfig
-} from "./chunks/JCJIPO2A.js";
-import "./chunks/2OQLWLWE.js";
+} from "./chunks/3W4PFUMC.js";
+import "./chunks/3KD5W26Z.js";
 export {
   auth_default as default,
   getAccessToken,

package/automations.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types--37uwGji.js';
+import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
 import './auth-types-PkN9CAF_.js';
 
 type AutomationDetailRequestObject = {

package/automations.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/DTGUILK5.js";
-import "./chunks/2OQLWLWE.js";
+} from "./chunks/SMQGR3VM.js";
+import "./chunks/3KD5W26Z.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/automations.ts

package/brands.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions, D as DownloadableBlob } from './global.types--37uwGji.js';
+import { A as ApiCallOptions, D as DownloadableBlob } from './global.types-qsBNouXJ.js';
 import './auth-types-PkN9CAF_.js';
 
 /**
@@ -100,7 +100,7 @@ type Link = {
  */
 type NoActiveBrand = unknown;
 /**
- * Lists all brand entries for a tenant
+ * Lists all brand entries for a tenant.
  *
  * @param query an object with query parameters
  * @throws GetBrandsHttpError
@@ -144,7 +144,7 @@ type GetBrands500HttpError = {
 };
 type GetBrandsHttpError = GetBrands400HttpError | GetBrands401HttpError | GetBrands403HttpError | GetBrands500HttpError;
 /**
- * Creates a new brand
+ * Creates a new brand.
  *
  * @param body an object with the body content
  * @throws CreateBrandHttpError
@@ -188,7 +188,7 @@ type CreateBrand500HttpError = {
 };
 type CreateBrandHttpError = CreateBrand400HttpError | CreateBrand401HttpError | CreateBrand403HttpError | CreateBrand500HttpError;
 /**
- * Retrieves the current active brand
+ * Returns the current active brand. If using the Qlik default brand, no value is returned.
  *
  * @throws GetActiveBrandHttpError
  */
@@ -204,7 +204,7 @@ type GetActiveBrandHttpError = {
     status: number;
 };
 /**
- * Deletes a specific brand
+ * Deletes a specific brand. If the active brand is deleted, the tenant will return to the Qlik default.
  *
  * @param brandId The brand's unique identifier.
  * @throws DeleteBrandHttpError
@@ -242,7 +242,7 @@ type DeleteBrand500HttpError = {
 };
 type DeleteBrandHttpError = DeleteBrand400HttpError | DeleteBrand401HttpError | DeleteBrand403HttpError | DeleteBrand404HttpError | DeleteBrand500HttpError;
 /**
- * Retrieves a specific brand
+ * Returns a specific brand.
  *
  * @param brandId The brand's unique identifier.
  * @throws GetBrandHttpError
@@ -280,7 +280,7 @@ type GetBrand500HttpError = {
 };
 type GetBrandHttpError = GetBrand400HttpError | GetBrand401HttpError | GetBrand403HttpError | GetBrand404HttpError | GetBrand500HttpError;
 /**
- * Patches a brand
+ * Patches a brand.
  *
  * @param brandId The brand's unique identifier.
  * @param body an object with the body content
@@ -358,7 +358,7 @@ type ActivateBrand500HttpError = {
 };
 type ActivateBrandHttpError = ActivateBrand400HttpError | ActivateBrand401HttpError | ActivateBrand403HttpError | ActivateBrand404HttpError | ActivateBrand500HttpError;
 /**
- * Sets the brand so it is no longer active. If the brand is already inactive, no action is taken.
+ * Sets the brand so it is no longer active, returning the tenant the Qlik default brand. If the brand is already inactive, no action is taken.
  *
  * @param brandId The brand's unique identifier.
  * @param body an object with the body content
@@ -397,7 +397,7 @@ type DeactivateBrand500HttpError = {
 };
 type DeactivateBrandHttpError = DeactivateBrand400HttpError | DeactivateBrand401HttpError | DeactivateBrand403HttpError | DeactivateBrand404HttpError | DeactivateBrand500HttpError;
 /**
- * Deletes a specific brand file
+ * Deletes the specified brand file.
  *
  * @param brandId The brand's unique identifier.
  * @param brandFileId The unique identifier of a file within a brand.
@@ -436,7 +436,7 @@ type DeleteBrandFile500HttpError = {
 };
 type DeleteBrandFileHttpError = DeleteBrandFile400HttpError | DeleteBrandFile401HttpError | DeleteBrandFile403HttpError | DeleteBrandFile404HttpError | DeleteBrandFile500HttpError;
 /**
- * Downloads the brand file
+ * Downloads the specified brand file.
  *
  * @param brandId The brand's unique identifier.
  * @param brandFileId The unique identifier of a file within a brand.
@@ -475,7 +475,7 @@ type GetBrandFile500HttpError = {
 };
 type GetBrandFileHttpError = GetBrandFile400HttpError | GetBrandFile401HttpError | GetBrandFile403HttpError | GetBrandFile404HttpError | GetBrandFile500HttpError;
 /**
- * Creates a brand file
+ * Creates a brand file for the specified identifier.
  *
  * @param brandId The brand's unique identifier.
  * @param brandFileId The unique identifier of a file within a brand.
@@ -518,7 +518,7 @@ type CreateBrandFile500HttpError = {
 };
 type CreateBrandFileHttpError = CreateBrandFile400HttpError | CreateBrandFile401HttpError | CreateBrandFile403HttpError | CreateBrandFile404HttpError | CreateBrandFile500HttpError;
 /**
- * Updates existing file
+ * Updates the specified brand file.
  *
  * @param brandId The brand's unique identifier.
  * @param brandFileId The unique identifier of a file within a brand.
@@ -566,41 +566,41 @@ type UpdateBrandFileHttpError = UpdateBrandFile400HttpError | UpdateBrandFile401
 declare function clearCache(): void;
 interface BrandsAPI {
     /**
-     * Lists all brand entries for a tenant
+     * Lists all brand entries for a tenant.
      *
      * @param query an object with query parameters
      * @throws GetBrandsHttpError
      */
     getBrands: typeof getBrands;
     /**
-     * Creates a new brand
+     * Creates a new brand.
      *
      * @param body an object with the body content
      * @throws CreateBrandHttpError
      */
     createBrand: typeof createBrand;
     /**
-     * Retrieves the current active brand
+     * Returns the current active brand. If using the Qlik default brand, no value is returned.
      *
      * @throws GetActiveBrandHttpError
      */
     getActiveBrand: typeof getActiveBrand;
     /**
-     * Deletes a specific brand
+     * Deletes a specific brand. If the active brand is deleted, the tenant will return to the Qlik default.
      *
      * @param brandId The brand's unique identifier.
      * @throws DeleteBrandHttpError
      */
     deleteBrand: typeof deleteBrand;
     /**
-     * Retrieves a specific brand
+     * Returns a specific brand.
      *
      * @param brandId The brand's unique identifier.
      * @throws GetBrandHttpError
      */
     getBrand: typeof getBrand;
     /**
-     * Patches a brand
+     * Patches a brand.
      *
      * @param brandId The brand's unique identifier.
      * @param body an object with the body content
@@ -616,7 +616,7 @@ interface BrandsAPI {
      */
     activateBrand: typeof activateBrand;
     /**
-     * Sets the brand so it is no longer active. If the brand is already inactive, no action is taken.
+     * Sets the brand so it is no longer active, returning the tenant the Qlik default brand. If the brand is already inactive, no action is taken.
      *
      * @param brandId The brand's unique identifier.
      * @param body an object with the body content
@@ -624,7 +624,7 @@ interface BrandsAPI {
      */
     deactivateBrand: typeof deactivateBrand;
     /**
-     * Deletes a specific brand file
+     * Deletes the specified brand file.
      *
      * @param brandId The brand's unique identifier.
      * @param brandFileId The unique identifier of a file within a brand.
@@ -632,7 +632,7 @@ interface BrandsAPI {
      */
     deleteBrandFile: typeof deleteBrandFile;
     /**
-     * Downloads the brand file
+     * Downloads the specified brand file.
      *
      * @param brandId The brand's unique identifier.
      * @param brandFileId The unique identifier of a file within a brand.
@@ -640,7 +640,7 @@ interface BrandsAPI {
      */
     getBrandFile: typeof getBrandFile;
     /**
-     * Creates a brand file
+     * Creates a brand file for the specified identifier.
      *
      * @param brandId The brand's unique identifier.
      * @param brandFileId The unique identifier of a file within a brand.
@@ -649,7 +649,7 @@ interface BrandsAPI {
      */
     createBrandFile: typeof createBrandFile;
     /**
-     * Updates existing file
+     * Updates the specified brand file.
      *
      * @param brandId The brand's unique identifier.
      * @param brandFileId The unique identifier of a file within a brand.

package/brands.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/DTGUILK5.js";
-import "./chunks/2OQLWLWE.js";
+} from "./chunks/SMQGR3VM.js";
+import "./chunks/3KD5W26Z.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/brands.ts

package/chunks/{2OQLWLWE.js → 3KD5W26Z.js}

@@ -1,21 +1,21 @@
 // src/public/public-runtime-modules.ts
 function getAuthRuntimeModule(hostConfig) {
   const isNode = !!globalThis.process?.argv;
-  return isNode ? import("./LVRC5AWE.js") : import("./EUWNVVK5.js").then(
+  return isNode ? import("./CUC5USM5.js") : import("./EUWNVVK5.js").then(
     (mod) => mod.importRuntimeModule("auth@v1", hostConfig)
   );
 }
 async function getQixRuntimeModule(hostConfig) {
   await getAuthRuntimeModule(hostConfig);
   const isNode = !!globalThis.process?.argv;
-  return isNode ? import("./4M3Q6QY3.js") : import("./EUWNVVK5.js").then(
+  return isNode ? import("./UJV2QU2J.js") : import("./EUWNVVK5.js").then(
     (mod) => mod.importRuntimeModule("qix@v1", hostConfig)
   );
 }
 async function getInvokeFetchRuntimeModule(hostConfig) {
   await getAuthRuntimeModule(hostConfig);
   const isNode = !!globalThis.process?.argv;
-  return isNode ? import("./GVE5ABSG.js") : import("./EUWNVVK5.js").then(
+  return isNode ? import("./E5TLRYTH.js") : import("./EUWNVVK5.js").then(
     (mod) => mod.importRuntimeModule("invoke-fetch@v1", hostConfig)
   );
 }

package/chunks/{3FHEUGST.js → 3REGOC54.js}

@@ -1,12 +1,11 @@
 import {
   generateRandomString,
-  getCsrfToken,
   getRestCallAuthParams,
   getWebSocketAuthParams,
   toValidWebsocketLocationUrl
-} from "./BUSRKHDX.js";
+} from "./OCV75U5H.js";
+import "./7RHSSS4W.js";
 import {
-  isBrowser,
   isNode
 } from "./2ZQ3ZX7F.js";
 
@@ -10366,48 +10365,49 @@ async function createEnigmaSession({
   appId,
   identity,
   hostConfig,
-  useReloadEngine = false
+  useReloadEngine = false,
+  ttlSeconds,
+  workloadType
 }) {
+  const isNodeEnvironment = isNode();
   const locationUrl = toValidWebsocketLocationUrl(hostConfig);
   const reloadUri = encodeURIComponent(`${locationUrl}/sense/app/${appId}`);
+  const ttlPart = ttlSeconds !== void 0 && ttlSeconds >= 0 ? `/ttl/${ttlSeconds}` : "";
   const identityPart = identity ? `/identity/${identity}` : "";
-  const reloadEnginePart = useReloadEngine ? "&workloadType=interactive-reload" : "";
-  let csrfToken = "";
-  if (isBrowser() && (!hostConfig || hostConfig.authType === "cookie" || hostConfig.authType === "windowscookie")) {
-    try {
-      csrfToken = await getCsrfToken(hostConfig);
-    } catch {
-    }
-  }
-  const csrfPart = csrfToken ? `&qlik-csrf-token=${csrfToken}` : "";
-  let url = `${locationUrl}/app/${appId}${identityPart}?reloadUri=${reloadUri}${reloadEnginePart}${csrfPart}`.replace(
+  const workloadTypePart = useReloadEngine ? "&workloadType=interactive-reload" : workloadType ? `&workloadType=${workloadType}` : "";
+  const baseUrl = `${locationUrl}/app/${appId}${identityPart}${ttlPart}?reloadUri=${reloadUri}${workloadTypePart}`.replace(
     /^http/,
     "ws"
   );
-  const isNodeEnvironment = isNode();
-  let createSocketMethod;
+  let createSocketBuilder;
   if (isNodeEnvironment) {
-    const { headers, queryParams } = await getRestCallAuthParams({ hostConfig, method: "POST" });
     const WS = (await import("ws")).default;
-    Object.entries(queryParams).forEach(([key, value]) => {
-      url = `${url}&${key}=${value}`;
-    });
-    createSocketMethod = (socketUrl) => new WS(socketUrl, void 0, {
-      headers
-    });
+    createSocketBuilder = async () => {
+      let url = baseUrl;
+      const { headers, queryParams } = await getRestCallAuthParams({ hostConfig, method: "POST" });
+      Object.entries(queryParams).forEach(([key, value]) => {
+        url = `${url}&${key}=${value}`;
+      });
+      return (socketUrl) => new WS(url, void 0, {
+        headers
+      });
+    };
   } else {
-    const { queryParams } = await getWebSocketAuthParams({ hostConfig });
-    Object.entries(queryParams).forEach(([key, value]) => {
-      url = `${url}&${key}=${value}`;
-    });
-    createSocketMethod = (socketUrl) => new WebSocket(socketUrl);
+    createSocketBuilder = async () => {
+      let url = baseUrl;
+      const { queryParams } = await getWebSocketAuthParams({ hostConfig });
+      Object.entries(queryParams).forEach(([key, value]) => {
+        url = `${url}&${key}=${value}`;
+      });
+      return (socketUrl) => new WebSocket(url);
+    };
   }
-  return enigma.create({
+  const session = enigma.create({
     schema: engine_api_default,
     mixins: mixins5,
-    url,
+    url: baseUrl,
     suspendOnClose: !useReloadEngine,
-    createSocket: createSocketMethod,
+    createSocket: await createSocketBuilder(),
     requestInterceptors: [somethingWithEmptyMethodsRequestInterceptor],
     responseInterceptors: [
       retryAbortedErrorResponseInterceptor,
@@ -10415,6 +10415,13 @@ async function createEnigmaSession({
       somethingWithErrorPopupsResponnseInterceptor
     ]
   });
+  const originalResume = session.resume.bind(session);
+  const resume = async (onlyIfAttached) => {
+    session.rpc.createSocket = await createSocketBuilder();
+    await originalResume(onlyIfAttached);
+  };
+  session.resume = resume;
+  return session;
 }
 export {
   createEnigmaSession

package/chunks/{JCJIPO2A.js → 3W4PFUMC.js}

@@ -1,6 +1,6 @@
 import {
   getAuthRuntimeModule
-} from "./2OQLWLWE.js";
+} from "./3KD5W26Z.js";
 
 // src/public/auth.ts
 function registerAuthModule(name, authModule) {

package/chunks/{LVRC5AWE.js → CUC5USM5.js}

@@ -19,7 +19,8 @@ import {
   toValidEnigmaLocationUrl,
   toValidLocationUrl,
   toValidWebsocketLocationUrl
-} from "./BUSRKHDX.js";
+} from "./OCV75U5H.js";
+import "./7RHSSS4W.js";
 import "./2ZQ3ZX7F.js";
 export {
   AuthorizationError,

package/chunks/{GVE5ABSG.js → E5TLRYTH.js}

@@ -5,7 +5,8 @@ import {
   invokeFetch,
   invoke_fetch_default,
   parseFetchResponse
-} from "./BUSRKHDX.js";
+} from "./OCV75U5H.js";
+import "./7RHSSS4W.js";
 import "./2ZQ3ZX7F.js";
 export {
   EncodingError,