@qlik/api 1.23.0 → 1.25.0

package/chunks/{OCV75U5H.js → I5UOE4ZZ.js}

@@ -1,3 +1,6 @@
+import {
+  getInterceptors
+} from "./7BDAXGID.js";
 import {
   isBrowser,
   isNode
@@ -1142,19 +1145,27 @@ async function getCsrfToken(hostConfig, noCache) {
     pathTemplate = "/api/v1/csrf-token";
   }
   const fetchCsrfToken = async () => {
-    const res = await invokeFetch("csrf-token", {
-      method: "get",
-      pathTemplate,
-      options: {
-        hostConfig,
-        noCache: true
+    try {
+      const res = await invokeFetch("csrf-token", {
+        method: "get",
+        pathTemplate,
+        options: {
+          hostConfig,
+          noCache: true
+        }
+      });
+      const csrfToken = res.headers.get(QLIK_CSRF_TOKEN);
+      if (!csrfToken) {
+        return "";
       }
-    });
-    const csrfToken = res.headers.get(QLIK_CSRF_TOKEN);
-    if (!csrfToken) {
-      return "";
+      return csrfToken;
+    } catch (e) {
+      const error = e;
+      if (error.status === 404) {
+        return "";
+      }
+      throw e;
     }
-    return csrfToken;
   };
   if (noCache) {
     csrfTokens[locationUrl] = fetchCsrfToken();
@@ -1636,10 +1647,10 @@ async function fetchAndTransformExceptions(input, init) {
   try {
     return await fetch(input, init);
   } catch (e) {
-    return Promise.reject(new InvokeFetchError(getErrorMessage(e), 0, new Headers(), {}));
+    return Promise.reject(new InvokeFetchError2(getErrorMessage(e), 0, new Headers(), {}));
   }
 }
-async function performActualHttpFetch(method, completeUrl, unencodedBody, contentType, options, interceptors, authHeaders, credentials, userAgent) {
+async function performActualHttpFetch(method, completeUrl, unencodedBody, contentType, options, authHeaders, credentials, userAgent) {
   const { body, contentTypeHeader, requestOptions } = encodeBody(unencodedBody, contentType ?? "");
   const headers = {
     ...contentTypeHeader,
@@ -1651,12 +1662,13 @@ async function performActualHttpFetch(method, completeUrl, unencodedBody, conten
     headers["User-Agent"] = userAgent;
   }
   const isCrossOrigin = isHostCrossOrigin(options?.hostConfig);
-  let request = {
+  const request = {
     method,
     credentials,
     mode: isCrossOrigin ? "cors" : "same-origin",
     headers,
     redirect: await isWindows(options?.hostConfig) ? "manual" : "follow",
+    keepalive: options?.keepalive,
     body,
     // body data type must match "Content-Type" header
     ...requestOptions
@@ -1672,17 +1684,11 @@ async function performActualHttpFetch(method, completeUrl, unencodedBody, conten
     }, options.timeoutMs);
     request.signal = controller.signal;
   }
-  if (interceptors?.request.hasInterceptors()) {
-    request = await interceptors.request.apply(completeUrl, request);
-  }
   const fetchResponse = await fetchAndTransformExceptions(completeUrl, request);
   if (fetchTimeoutId) {
     clearTimeout(fetchTimeoutId);
   }
-  let invokeFetchResponse = await parseFetchResponse(fetchResponse, completeUrl);
-  if (interceptors?.response.hasInterceptors()) {
-    invokeFetchResponse = await interceptors.response.apply(invokeFetchResponse);
-  }
+  const invokeFetchResponse = await parseFetchResponse(fetchResponse, completeUrl);
   return invokeFetchResponse;
 }
 function encodeBody(unencodedBody, contentType) {
@@ -1799,23 +1805,17 @@ async function getInvokeFetchUrlParams({
   const cacheKey = toCacheKey(url, queryString, serializeHostConfig(options?.hostConfig), options?.headers);
   return { completeUrl, cacheKey, authHeaders, credentials };
 }
-function invokeFetchWithUrl(api, props, interceptors) {
-  return invokeFetchWithUrlAndRetry(
-    api,
-    props,
-    async () => {
-      const { cacheKey, authHeaders, credentials } = await getInvokeFetchUrlParams(props);
-      return invokeFetchWithUrlAndRetry(
-        api,
-        { ...props, cacheKey, authHeaders, credentials, options: { ...props.options, noCache: true } },
-        // don't cache the retry
-        void 0,
-        // only retry once
-        interceptors
-      );
-    },
-    interceptors
-  );
+function invokeFetchWithUrl(api, props) {
+  return invokeFetchWithUrlAndRetry(api, props, async () => {
+    const { cacheKey, authHeaders, credentials } = await getInvokeFetchUrlParams(props);
+    return invokeFetchWithUrlAndRetry(
+      api,
+      { ...props, cacheKey, authHeaders, credentials, options: { ...props.options, noCache: true } },
+      // don't cache the retry
+      void 0
+      // only retry once
+    );
+  });
 }
 function invokeFetchWithUrlAndRetry(api, {
   method,
@@ -1827,7 +1827,7 @@ function invokeFetchWithUrlAndRetry(api, {
   credentials,
   contentType,
   userAgent
-}, performRetry, interceptors) {
+}, performRetry) {
   if (!cache[api]) {
     cache[api] = {};
   }
@@ -1847,7 +1847,6 @@ function invokeFetchWithUrlAndRetry(api, {
     body,
     contentType,
     options,
-    interceptors,
     authHeaders,
     credentials,
     userAgent
@@ -1863,7 +1862,6 @@ function invokeFetchWithUrlAndRetry(api, {
     method,
     body,
     options,
-    interceptors,
     authHeaders,
     credentials
   );
@@ -1882,7 +1880,7 @@ function invokeFetchWithUrlAndRetry(api, {
   }
   return cloneResultPromise(resultPromiseAfterCacheClearing);
 }
-function addPagingFunctions(api, value, method, body, options, interceptors, authHeaders, credentials) {
+function addPagingFunctions(api, value, method, body, options, authHeaders, credentials) {
   const serializedHostConfig = serializeHostConfig(options?.hostConfig);
   return value.then((resp) => {
     const dataWithPotentialLinks = resp.data;
@@ -1892,34 +1890,26 @@ function addPagingFunctions(api, value, method, body, options, interceptors, aut
     const prevUrl = dataWithPotentialLinks.links?.prev?.href;
     const nextUrl = dataWithPotentialLinks.links?.next?.href;
     if (prevUrl) {
-      resp.prev = (prevOptions) => invokeFetchWithUrl(
-        api,
-        {
-          method,
-          completeUrl: prevUrl,
-          body,
-          options: prevOptions || options,
-          cacheKey: toCacheKey(prevUrl, "", serializedHostConfig, options?.headers),
-          authHeaders,
-          credentials
-        },
-        interceptors
-      );
+      resp.prev = (prevOptions) => invokeFetchWithUrl(api, {
+        method,
+        completeUrl: prevUrl,
+        body,
+        options: prevOptions || options,
+        cacheKey: toCacheKey(prevUrl, "", serializedHostConfig, options?.headers),
+        authHeaders,
+        credentials
+      });
     }
     if (nextUrl) {
-      resp.next = (nextOptions) => invokeFetchWithUrl(
-        api,
-        {
-          method,
-          completeUrl: nextUrl,
-          body,
-          options: nextOptions || options,
-          cacheKey: toCacheKey(nextUrl, "", serializedHostConfig, options?.headers),
-          authHeaders,
-          credentials
-        },
-        interceptors
-      );
+      resp.next = (nextOptions) => invokeFetchWithUrl(api, {
+        method,
+        completeUrl: nextUrl,
+        body,
+        options: nextOptions || options,
+        cacheKey: toCacheKey(nextUrl, "", serializedHostConfig, options?.headers),
+        authHeaders,
+        credentials
+      });
     }
     return resp;
   });
@@ -1991,7 +1981,7 @@ async function download(blob, filename) {
 }
 
 // src/invoke-fetch/invoke-fetch-error.ts
-var InvokeFetchError = class extends Error {
+var InvokeFetchError2 = class extends Error {
   status;
   headers;
   data;
@@ -2037,6 +2027,15 @@ function cleanStack(stack) {
 // src/invoke-fetch/invoke-fetch-functions.ts
 var defaultUserAgent = "qmfe-api/latest";
 async function invokeFetch(api, props, interceptors) {
+  interceptors = interceptors || getInterceptors();
+  const invokeFetchFinal = (reqeust) => invokeFetchIntercepted(api, reqeust);
+  const withInterceptors = (interceptors || []).reduce(
+    (proceed, interceptor) => (request) => interceptor(request, proceed),
+    invokeFetchFinal
+  );
+  return withInterceptors(props);
+}
+async function invokeFetchIntercepted(api, props) {
   checkForCrossDomainRequest(props.options?.hostConfig);
   let userAgent;
   if (props?.userAgent) {
@@ -2047,11 +2046,15 @@ async function invokeFetch(api, props, interceptors) {
     userAgent = defaultUserAgent;
   }
   const { completeUrl, cacheKey, authHeaders, credentials } = await getInvokeFetchUrlParams(props);
-  return invokeFetchWithUrl(
-    api,
-    { ...props, method: props.method.toUpperCase(), completeUrl, cacheKey, authHeaders, credentials, userAgent },
-    interceptors
-  );
+  return invokeFetchWithUrl(api, {
+    ...props,
+    method: props.method.toUpperCase(),
+    completeUrl,
+    cacheKey,
+    authHeaders,
+    credentials,
+    userAgent
+  });
 }
 function clearApiCache(api) {
   clearApiCacheInternal(api);
@@ -2073,6 +2076,7 @@ async function parseFetchResponse(fetchResponse, url) {
     resultData = toDownloadableBlob(await fetchResponse.blob(), filename);
   } else {
     switch (contentType) {
+      // Note: This list is by no means exhaustive, populate with more types as needed.
       case "image/png":
       case "image/jpeg":
       case "image/x-icon":
@@ -2098,10 +2102,10 @@ async function parseFetchResponse(fetchResponse, url) {
   const { status, statusText, headers } = fetchResponse;
   const errorMsg = `request to '${url}' failed with status ${status} ${statusText}.`;
   if (status >= 300) {
-    throw new InvokeFetchError(errorMsg, status, headers, resultData);
+    throw new InvokeFetchError2(errorMsg, status, headers, resultData);
   }
   if (status === 0) {
-    throw new InvokeFetchError(errorMsg, 302, headers, resultData);
+    throw new InvokeFetchError2(errorMsg, 302, headers, resultData);
   }
   const invokeFetchResponse = {
     status,
@@ -2141,7 +2145,7 @@ export {
   checkForCrossDomainRequest,
   logout,
   generateRandomString,
-  InvokeFetchError,
+  InvokeFetchError2 as InvokeFetchError,
   EncodingError,
   invokeFetch,
   clearApiCache,

package/chunks/{UJV2QU2J.js → N3ZFICDU.js}

@@ -4,8 +4,8 @@ import {
   invokeFetch,
   isWindows,
   toValidWebsocketLocationUrl
-} from "./OCV75U5H.js";
-import "./7RHSSS4W.js";
+} from "./I5UOE4ZZ.js";
+import "./7BDAXGID.js";
 import {
   isBrowser
 } from "./2ZQ3ZX7F.js";
@@ -161,7 +161,7 @@ function listenForWindowsAuthenticationInformation(session) {
   return authSuggestedInWebsocket;
 }
 async function createAndSetupEnigmaSession(props, canRetry) {
-  const { createEnigmaSession } = await import("./3REGOC54.js");
+  const { createEnigmaSession } = await import("./6QRR5VUM.js");
   const session = await createEnigmaSession(props);
   setupSessionListeners(session, props);
   let global;

package/chunks/{VXEOAWM6.js → OIQ5ELGS.js}

@@ -1,6 +1,6 @@
 import {
   getQixRuntimeModule
-} from "./3KD5W26Z.js";
+} from "./CZC7KEJN.js";
 
 // src/public/qix.ts
 function openAppSession(appSessionProps) {

package/chunks/{SMQGR3VM.js → UA6BE3VB.js}

@@ -1,12 +1,12 @@
 import {
   getInvokeFetchRuntimeModule
-} from "./3KD5W26Z.js";
+} from "./CZC7KEJN.js";
 import {
   isBrowser
 } from "./2ZQ3ZX7F.js";
 
 // src/public/invoke-fetch.ts
-var defaultUserAgent = "qlik-api/1.23.0";
+var defaultUserAgent = "qlik-api/1.25.0";
 async function invokeFetch(api, props) {
   const hostConfig = props.options?.hostConfig;
   let userAgent;

package/chunks/{EUWNVVK5.js → VX3MQBE7.js}

@@ -1,4 +1,4 @@
-// node_modules/.pnpm/@qlik+runtime-module-loader@1.0.13/node_modules/@qlik/runtime-module-loader/dist/index.js
+// node_modules/.pnpm/@qlik+runtime-module-loader@1.0.14/node_modules/@qlik/runtime-module-loader/dist/index.js
 window.__qlikMainPrivateResolvers = window.__qlikMainPrivateResolvers || {};
 window.__qlikMainPrivateResolvers.mainUrlPromise = window.__qlikMainPrivateResolvers.mainUrlPromise || new Promise((resolve) => {
   window.__qlikMainPrivateResolvers.resolveMainJsUrl = (value) => resolve(value);

package/collections.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
 import './auth-types-PkN9CAF_.js';
 
 type CollectionByIdPatch = {

package/collections.js

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

package/csp-origins.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
 import './auth-types-PkN9CAF_.js';
 
 type CSPEntry = {

package/csp-origins.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/SMQGR3VM.js";
-import "./chunks/3KD5W26Z.js";
+} from "./chunks/UA6BE3VB.js";
+import "./chunks/CZC7KEJN.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/csp-origins.ts

package/data-assets.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
 import './auth-types-PkN9CAF_.js';
 
 type BatchIdDto = {

package/data-assets.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/SMQGR3VM.js";
-import "./chunks/3KD5W26Z.js";
+} from "./chunks/UA6BE3VB.js";
+import "./chunks/CZC7KEJN.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/data-assets.ts

package/data-connections.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
 import './auth-types-PkN9CAF_.js';
 
 type ActionDeleteRequest = {

package/data-connections.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/SMQGR3VM.js";
-import "./chunks/3KD5W26Z.js";
+} from "./chunks/UA6BE3VB.js";
+import "./chunks/CZC7KEJN.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/data-connections.ts

package/data-credentials.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
 import './auth-types-PkN9CAF_.js';
 
 type ActionFilterOrphanRequest = {

package/data-credentials.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/SMQGR3VM.js";
-import "./chunks/3KD5W26Z.js";
+} from "./chunks/UA6BE3VB.js";
+import "./chunks/CZC7KEJN.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/data-credentials.ts

package/data-files.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
 import './auth-types-PkN9CAF_.js';
 
 type BatchChangeSpaceItem = {

package/data-files.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/SMQGR3VM.js";
-import "./chunks/3KD5W26Z.js";
+} from "./chunks/UA6BE3VB.js";
+import "./chunks/CZC7KEJN.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/data-files.ts

package/docs/rest.md

@@ -62,3 +62,50 @@ try {
 ## Caching
 
 Every GET request is cached so that subsequent calls to the same api will resolve immediately from the cache. Read more about caching [here](features.md#caching).
+
+## Rest Interceptors
+
+Interceptors can be added to allow custom functionality to happen before or after an api call. They run globally always on every request. The format is:
+
+```ts
+// the interceptor format
+const interceptor = async (request, proceed) => {
+  // do things before the request
+  const result = await proceed(request);
+  // do things after the request
+  return result;
+};
+```
+
+> [!WARNING]
+> Use Interceptors with caution. They affect every request made by the library and can introduce strange side effects that are hard to discover and debug.
+
+#### Examples
+
+```ts
+import { addInterceptor, removeInterceptor } from "@qlik/api/interceptors";
+
+// add a logging interceptor, which logs all requests, responses and errors
+addInterceptor(async (request, proceed) => {
+  try {
+    console.log("-->", request.method, request.pathTemplate, request.pathVariables, request.query, request.body);
+    const result = await proceed(request);
+    console.log("<--", result.data);
+    return result;
+  } catch (err) {
+    console.log("<-*", err);
+    throw err;
+  }
+});
+
+// add additional header to a request
+const headerInterceptor = addInterceptor(async (request, proceed) => {
+  // make sure headers object exists
+  (request.options = request.options || {}).headers = request.options.headers || {};
+  request.options.headers["x-another-header"] = "foobarvalue";
+  return proceed(request);
+});
+
+// remove an interceptor
+removeInterceptor(headerInterceptor);
+```

package/extensions.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
 import './auth-types-PkN9CAF_.js';
 
 /**

package/extensions.js

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

package/glossaries.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
 import './auth-types-PkN9CAF_.js';
 
 /**
@@ -110,6 +110,8 @@ type Category = {
     readonly createdBy: string;
     description: string;
     glossaryId: string;
+    /** The id for resolving updates in future imports/updates.
+     * Opposed to the id of terms, id on category are not resolved by backend. Any category referred in the category array in terms will have to be identical to the id property of the category. If not, the category reference will be discarded. */
     id: string;
     name: string;
     parentId?: string;
@@ -121,9 +123,6 @@ type Category = {
 };
 type CreateCategory = {
     description?: string;
-    /** The id for resolving updates in future imports/updates.
-     * Opposed to the id of terms, id on category are not resolved by backend. Any category referred in the category array in terms will have to be identical to the id property of the category. If not, the category reference will be discarded. */
-    id?: string;
     /** The name of the category. May not be identical to another category belonging to the same parent. */
     name?: string;
     parentId?: string;

package/glossaries.js

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

package/groups.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
 import './auth-types-PkN9CAF_.js';
 
 /**
@@ -108,8 +108,8 @@ type GroupPatch = {
     op: "replace";
     /** Attribute name of a field of the Groups entity. "Name" and "description" is only available for custom groups. */
     path: "assignedRoles" | "name" | "description";
-    /** The roles to assign to the group (limit of 100 roles per group). */
-    value: AssignedRolesRefIDs | AssignedRolesRefNames;
+    /** The roles to assign to the group (limit of 100 roles per group) or the new custom group name or description. */
+    value: AssignedRolesRefIDs | AssignedRolesRefNames | string;
 };
 /**
  * An array of JSON Patches for a group.

package/groups.js

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

package/identity-providers.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
 import './auth-types-PkN9CAF_.js';
 
 type BaseIDP = {

package/identity-providers.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/SMQGR3VM.js";
-import "./chunks/3KD5W26Z.js";
+} from "./chunks/UA6BE3VB.js";
+import "./chunks/CZC7KEJN.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/identity-providers.ts