@qlik/api 1.19.0 → 1.20.0

package/api-keys.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/BOJLTXK6.js";
-import "./chunks/VISO65GO.js";
+} from "./chunks/T6AQ34ZJ.js";
+import "./chunks/IMLCMV4X.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/api-keys.ts

package/apps.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/BOJLTXK6.js";
-import "./chunks/VISO65GO.js";
+} from "./chunks/T6AQ34ZJ.js";
+import "./chunks/IMLCMV4X.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/apps.ts

package/audits.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/BOJLTXK6.js";
-import "./chunks/VISO65GO.js";
+} from "./chunks/T6AQ34ZJ.js";
+import "./chunks/IMLCMV4X.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/audits.ts

package/auth.d.ts

@@ -18,13 +18,36 @@ declare function logout(): void;
  * @param hostConfig the default HostConfig to use
  */
 declare function setDefaultHostConfig(hostConfig: HostConfig | undefined): void;
+/**
+ * Returns an access token using the supplied host config. Typically used on the backend to supply the access token to the frontend
+ */
 declare function getAccessToken({ hostConfig }: {
     hostConfig?: HostConfig;
 }): Promise<string>;
+/**
+ * The AuthApi interface provides the public interface for the auth module.
+ */
+interface AuthAPI {
+    /**
+     * 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.
+     * @param name the name of the module
+     * @param authModule the implementation of the AuthModule interface
+     */
+    registerAuthModule: typeof registerAuthModule;
+    /**
+     * Sets the default host config that will be used for all qmfe api calls that do not include a host config
+     * @param hostConfig the default HostConfig to use
+     */
+    setDefaultHostConfig: typeof setDefaultHostConfig;
+    /**
+     * Returns an access token using the supplied host config. Typically used on the backend to supply the access token to the frontend
+     */
+    getAccessToken: typeof getAccessToken;
+}
 declare const _default: {
     registerAuthModule: typeof registerAuthModule;
     setDefaultHostConfig: typeof setDefaultHostConfig;
     getAccessToken: typeof getAccessToken;
 };
 
-export { AuthModule, AuthType, HostConfig, _default as default, getAccessToken, logout, registerAuthModule, setDefaultHostConfig };
+export { type AuthAPI, AuthModule, AuthType, HostConfig, _default as default, getAccessToken, logout, registerAuthModule, setDefaultHostConfig };

package/auth.js

@@ -4,8 +4,8 @@ import {
   logout,
   registerAuthModule,
   setDefaultHostConfig
-} from "./chunks/J6G5ZOKI.js";
-import "./chunks/VISO65GO.js";
+} from "./chunks/MP5FOM4F.js";
+import "./chunks/IMLCMV4X.js";
 export {
   auth_default as default,
   getAccessToken,

package/automations.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/BOJLTXK6.js";
-import "./chunks/VISO65GO.js";
+} from "./chunks/T6AQ34ZJ.js";
+import "./chunks/IMLCMV4X.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/automations.ts

package/brands.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/BOJLTXK6.js";
-import "./chunks/VISO65GO.js";
+} from "./chunks/T6AQ34ZJ.js";
+import "./chunks/IMLCMV4X.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/brands.ts

package/chunks/{GLS4DAZ4.js → 4VH5O5UL.js}

@@ -1,4 +1,4 @@
-// node_modules/.pnpm/@qlik+runtime-module-loader@1.0.10/node_modules/@qlik/runtime-module-loader/dist/index.js
+// node_modules/.pnpm/@qlik+runtime-module-loader@1.0.11/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/chunks/{ILZFMC3L.js → 4XKAFB25.js}

@@ -4,7 +4,7 @@ import {
   invokeFetch,
   isWindows,
   toValidWebsocketLocationUrl
-} from "./63L3IUY2.js";
+} from "./OQWY73NC.js";
 import {
   isBrowser
 } from "./2ZQ3ZX7F.js";
@@ -145,7 +145,7 @@ function listenForWindowsAuthenticationInformation(session) {
   return authSuggestedInWebsocket;
 }
 async function createAndSetupEnigmaSession(props, canRetry) {
-  const { createEnigmaSession } = await import("./P5AG7AME.js");
+  const { createEnigmaSession } = await import("./Z37XXMYQ.js");
   const session = await createEnigmaSession(props);
   setupSessionListeners(session, props);
   let global;
@@ -684,7 +684,23 @@ var qix = {
   onWebSocketEvent,
   onCombinedWebSocketStateChange,
   resumeSuspendedSessions,
-  resumeOnlyOnReattach
+  resumeOnlyOnReattach,
+  withHostConfig: (hostConfig) => ({
+    addInitialAppAction: (openAppSessionProps, action) => addInitialAppAction(
+      typeof openAppSessionProps === "string" ? { hostConfig, appId: openAppSessionProps } : { hostConfig, ...openAppSessionProps },
+      action
+    ),
+    createSessionApp,
+    openAppSession: (openAppSessionProps) => openAppSession(
+      typeof openAppSessionProps === "string" ? { hostConfig, appId: openAppSessionProps } : { hostConfig, ...openAppSessionProps }
+    ),
+    registerExternalAppSession,
+    useAppHook,
+    onWebSocketEvent,
+    onCombinedWebSocketStateChange,
+    resumeSuspendedSessions,
+    resumeOnlyOnReattach
+  })
 };
 var qix_default = qix;
 export {

package/chunks/{AKBUFQRX.js → DT5F6REC.js}

@@ -5,7 +5,7 @@ import {
   invokeFetch,
   invoke_fetch_default,
   parseFetchResponse
-} from "./63L3IUY2.js";
+} from "./OQWY73NC.js";
 import "./2ZQ3ZX7F.js";
 export {
   EncodingError,

package/chunks/{VISO65GO.js → IMLCMV4X.js}

@@ -1,21 +1,21 @@
 // src/public/public-runtime-modules.ts
 function getAuthRuntimeModule(hostConfig) {
   const isNode = !!globalThis.process?.argv;
-  return isNode ? import("./64RJJHEL.js") : import("./GLS4DAZ4.js").then(
+  return isNode ? import("./TEGSUED7.js") : import("./4VH5O5UL.js").then(
     (mod) => mod.importRuntimeModule("auth@v1", hostConfig)
   );
 }
 async function getQixRuntimeModule(hostConfig) {
   await getAuthRuntimeModule(hostConfig);
   const isNode = !!globalThis.process?.argv;
-  return isNode ? import("./ILZFMC3L.js") : import("./GLS4DAZ4.js").then(
+  return isNode ? import("./4XKAFB25.js") : import("./4VH5O5UL.js").then(
     (mod) => mod.importRuntimeModule("qix@v1", hostConfig)
   );
 }
 async function getInvokeFetchRuntimeModule(hostConfig) {
   await getAuthRuntimeModule(hostConfig);
   const isNode = !!globalThis.process?.argv;
-  return isNode ? import("./AKBUFQRX.js") : import("./GLS4DAZ4.js").then(
+  return isNode ? import("./DT5F6REC.js") : import("./4VH5O5UL.js").then(
     (mod) => mod.importRuntimeModule("invoke-fetch@v1", hostConfig)
   );
 }

package/chunks/{J6G5ZOKI.js → MP5FOM4F.js}

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

package/chunks/{KKAWWYOT.js → MX5NVZPW.js}

@@ -1,6 +1,6 @@
 import {
   getQixRuntimeModule
-} from "./VISO65GO.js";
+} from "./IMLCMV4X.js";
 
 // src/public/qix.ts
 function openAppSession(appSessionProps) {
@@ -47,12 +47,21 @@ function openAppSession(appSessionProps) {
   };
   return appSessionProxy;
 }
+function withHostConfig(hostConfig) {
+  return {
+    openAppSession: (openAppSessionProps) => openAppSession(
+      typeof openAppSessionProps === "string" ? { hostConfig, appId: openAppSessionProps } : { hostConfig, ...openAppSessionProps }
+    )
+  };
+}
 var qix = {
-  openAppSession
+  openAppSession,
+  withHostConfig
 };
 var qix_default = qix;
 
 export {
   openAppSession,
+  withHostConfig,
   qix_default
 };

package/chunks/{63L3IUY2.js → OQWY73NC.js}

@@ -341,6 +341,10 @@ function registerAuthModule2(name, authModule) {
 function setDefaultHostConfig2(hostConfig) {
   setDefaultHostConfig(hostConfig);
 }
+function serializeHostConfig(hostConfig) {
+  const hostConfigToUse = withDefaultHostConfig(hostConfig);
+  return JSON.stringify(hostConfigToUse, hostConfigPropertyIgnorer);
+}
 function checkForCrossDomainRequest(hostConfig) {
   const hostConfigToUse = withDefaultHostConfig(hostConfig);
   if (isHostCrossOrigin(hostConfigToUse)) {
@@ -368,6 +372,19 @@ function normalizeInbandAuthError({ errorBody, status }) {
 function normalizeAuthModuleError(err) {
   return { message: err.message || "Unknown error" };
 }
+function hostConfigPropertyIgnorer(key, value) {
+  if (key === "") {
+    return value;
+  }
+  if (key === "authType") {
+    return void 0;
+  }
+  const vtype = typeof value;
+  if (vtype === "object" || vtype === "function") {
+    return void 0;
+  }
+  return value;
+}
 
 // src/random/random.ts
 import { customAlphabet, nanoid } from "nanoid";
@@ -1398,7 +1415,7 @@ function applyPathVariables(pathTemplate, pathVariables) {
   }
   return result2;
 }
-function toCacheKey(url, query, headers) {
+function toCacheKey(url, query, serializedHostConfig, headers) {
   let cacheKey = url;
   if (query !== "") {
     cacheKey = cacheKey.concat(`?${query}`);
@@ -1406,6 +1423,9 @@ function toCacheKey(url, query, headers) {
   if (headers) {
     cacheKey = cacheKey.concat(`+headers=${JSON.stringify(headers)}`);
   }
+  if (serializedHostConfig) {
+    cacheKey = cacheKey.concat(`+host-config=${serializedHostConfig}`);
+  }
   return cacheKey;
 }
 function toCompleteUrl(url, query) {
@@ -1675,7 +1695,7 @@ async function getInvokeFetchUrlParams({
   const url = locationUrl + applyPathVariables(pathTemplate, pathVariables);
   const queryString = encodeQueryParams({ ...query, ...authQueryParams });
   const completeUrl = toCompleteUrl(url, queryString);
-  const cacheKey = toCacheKey(url, queryString, options?.headers);
+  const cacheKey = toCacheKey(url, queryString, serializeHostConfig(options?.hostConfig), options?.headers);
   return { completeUrl, cacheKey, authHeaders, credentials };
 }
 function invokeFetchWithUrl(api, props, interceptors) {
@@ -1762,6 +1782,7 @@ function invokeFetchWithUrlAndRetry(api, {
   return cloneResultPromise(resultPromiseAfterCacheClearing);
 }
 function addPagingFunctions(api, value, method, body, options, interceptors, authHeaders, credentials) {
+  const serializedHostConfig = serializeHostConfig(options?.hostConfig);
   return value.then((resp) => {
     const dataWithPotentialLinks = resp.data;
     if (!dataWithPotentialLinks) {
@@ -1777,7 +1798,7 @@ function addPagingFunctions(api, value, method, body, options, interceptors, aut
           completeUrl: prevUrl,
           body,
           options: prevOptions || options,
-          cacheKey: toCacheKey(prevUrl, "", options?.headers),
+          cacheKey: toCacheKey(prevUrl, "", serializedHostConfig, options?.headers),
           authHeaders,
           credentials
         },
@@ -1792,7 +1813,7 @@ function addPagingFunctions(api, value, method, body, options, interceptors, aut
           completeUrl: nextUrl,
           body,
           options: nextOptions || options,
-          cacheKey: toCacheKey(nextUrl, "", options?.headers),
+          cacheKey: toCacheKey(nextUrl, "", serializedHostConfig, options?.headers),
           authHeaders,
           credentials
         },
@@ -1862,7 +1883,9 @@ async function download(blob, filename) {
     window.URL.revokeObjectURL(blobUrl);
   } else {
     const { writeFileSync } = await import("fs");
-    writeFileSync(filename, Buffer.from(await blob.arrayBuffer()));
+    const arrayBuffer = await blob.arrayBuffer();
+    const uint8Array = new Uint8Array(arrayBuffer);
+    writeFileSync(filename, uint8Array);
   }
 }
 
@@ -2012,6 +2035,7 @@ export {
   getAccessToken,
   registerAuthModule2 as registerAuthModule,
   setDefaultHostConfig2 as setDefaultHostConfig,
+  serializeHostConfig,
   checkForCrossDomainRequest,
   logout,
   generateRandomString,

package/chunks/{BOJLTXK6.js → T6AQ34ZJ.js}

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

package/chunks/{64RJJHEL.js → TEGSUED7.js}

@@ -14,11 +14,12 @@ import {
   isWindows,
   logout,
   registerAuthModule,
+  serializeHostConfig,
   setDefaultHostConfig,
   toValidEnigmaLocationUrl,
   toValidLocationUrl,
   toValidWebsocketLocationUrl
-} from "./63L3IUY2.js";
+} from "./OQWY73NC.js";
 import "./2ZQ3ZX7F.js";
 export {
   AuthorizationError,
@@ -36,6 +37,7 @@ export {
   isWindows,
   logout,
   registerAuthModule,
+  serializeHostConfig,
   setDefaultHostConfig,
   toValidEnigmaLocationUrl,
   toValidLocationUrl,

package/chunks/{P5AG7AME.js → Z37XXMYQ.js}

@@ -4,7 +4,7 @@ import {
   getRestCallAuthParams,
   getWebSocketAuthParams,
   toValidWebsocketLocationUrl
-} from "./63L3IUY2.js";
+} from "./OQWY73NC.js";
 import {
   isBrowser,
   isNode

package/collections.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/BOJLTXK6.js";
-import "./chunks/VISO65GO.js";
+} from "./chunks/T6AQ34ZJ.js";
+import "./chunks/IMLCMV4X.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/collections.ts

package/csp-origins.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/BOJLTXK6.js";
-import "./chunks/VISO65GO.js";
+} from "./chunks/T6AQ34ZJ.js";
+import "./chunks/IMLCMV4X.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/csp-origins.ts

package/data-assets.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/BOJLTXK6.js";
-import "./chunks/VISO65GO.js";
+} from "./chunks/T6AQ34ZJ.js";
+import "./chunks/IMLCMV4X.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/data-assets.ts

package/data-connections.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/BOJLTXK6.js";
-import "./chunks/VISO65GO.js";
+} from "./chunks/T6AQ34ZJ.js";
+import "./chunks/IMLCMV4X.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/data-connections.ts

package/data-credentials.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/BOJLTXK6.js";
-import "./chunks/VISO65GO.js";
+} from "./chunks/T6AQ34ZJ.js";
+import "./chunks/IMLCMV4X.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/data-credentials.ts

package/data-files.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/BOJLTXK6.js";
-import "./chunks/VISO65GO.js";
+} from "./chunks/T6AQ34ZJ.js";
+import "./chunks/IMLCMV4X.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/data-files.ts

package/docs/authentication.md

@@ -27,7 +27,7 @@ const { data: mySpaces } = spaces.getSpaces();
 console.log(mySpaces);
 ```
 
-A host config can also be passed in to every single api request which then will override any default host config previously set.
+A host config can also be passed in to every single api request which then will override any default host config previously set. This way multiple host configs can be used if needed.
 
 ```ts
 import spaces from "@qlik/api/spaces";
@@ -45,6 +45,35 @@ const { data: mySpaces } = spaces.getSpaces({}, {
 console.log(mySpaces);
 ```
 
+### Binding an instance of `@qlik/api` to a specific host config
+
+As an alternative to the methods above it is also possible to create an instance of `@qlik/api` bound to a specific host config. This allows users to use several host configs in their solutions and easily separate them by having seperate `@qlik/api` instances.
+
+Example:
+
+```ts
+import { createQlikApi } from "@qlik-trial/qmfe-api";
+
+const api = createQlikApi({
+  authType: "apikey"
+  host: "my-org.region.qlikcloud.com", // a qlikcloud tenant
+  apiKey: "<api-key>",
+});
+
+// "api" now has the full @qlik/api bound to one specific hostconfig
+const { data: mySpaces } = api.spaces.getSpaces();
+
+// create another api with a different auth mechanism
+const apiToOtherTenant = createQlikApi({
+  authType: "oauth2"
+  host: "my-other-tenant.region.qlikcloud.com", // a qlikcloud tenant
+  clientId: "<client-id>",
+});
+
+// "apiToOtherTenant" is now bound to another hostconfig
+const { data: myOtherSpaces } = apiToOtherTenant.spaces.getSpaces();
+```
+
 ## The Auth Module
 
 An auth module in `@qlik/api` is an object with a few implemented methods. When connecting to Qlik Cloud Services (or Qlik Sense Enterprise for Windows) with `@qlik/api` or with `@qlik/embed` libraries an auth module is used for configuring the communication.

package/extensions.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/BOJLTXK6.js";
-import "./chunks/VISO65GO.js";
+} from "./chunks/T6AQ34ZJ.js";
+import "./chunks/IMLCMV4X.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/extensions.ts

package/glossaries.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/BOJLTXK6.js";
-import "./chunks/VISO65GO.js";
+} from "./chunks/T6AQ34ZJ.js";
+import "./chunks/IMLCMV4X.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/glossaries.ts

package/groups.d.ts

@@ -74,6 +74,10 @@ type Group = {
     assignedRoles?: AssignedRoles;
     /** The timestamp for when the group record was created. */
     createdAt: string;
+    /** Id of user that created role. */
+    readonly createdBy?: string;
+    /** A description of a custom group. */
+    description?: string;
     /** The unique identifier for the group */
     readonly id: string;
     /** The timestamp for when the group record was last updated. */
@@ -87,10 +91,14 @@ type Group = {
     };
     /** The name of the group. */
     name: string;
+    /** The type of provider for the group. */
+    providerType?: "idp" | "custom";
     /** The state of the group. */
     status: "active" | "disabled";
     /** The tenant identifier associated with the given group */
     tenantId: string;
+    /** Id of user that last updated this role. */
+    readonly updatedBy?: string;
 };
 /**
  * A JSON Patch document.
@@ -98,8 +106,8 @@ type Group = {
 type GroupPatch = {
     /** The operation to be performed. Currently "replace" is the only supported operation. */
     op: "replace";
-    /** Attribute name of a field of the Groups entity. */
-    path: "assignedRoles";
+    /** 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;
 };
@@ -110,8 +118,12 @@ type GroupPatchSchema = GroupPatch[];
 type GroupPostSchema = {
     /** The roles to assign to the group (limit of 100 roles per group). */
     assignedRoles?: AssignedRolesRefIDs | AssignedRolesRefNames;
+    /** The description of the group. */
+    description?: string;
     /** The name of the group (maximum length of 256 characters). */
     name: string;
+    /** The type of group provider. Must be "idp" or "custom". Defaults to "idp" if not provided. */
+    providerType?: "idp" | "custom";
     /** The status of the created group within the tenant. Defaults to active if empty. */
     status?: "active";
 };
@@ -222,7 +234,7 @@ type GetGroupsHttpError = {
     status: number;
 };
 /**
- * Creates a group. The maximum number of groups a tenant can have is 10,000.
+ * Creates a new group. The maximum number of groups a tenant can have is 10,000. Group names are case-sensitive, and must be unique.
  *
  * @param body an object with the body content
  * @throws CreateGroupHttpError
@@ -365,7 +377,7 @@ interface GroupsAPI {
      */
     getGroups: typeof getGroups;
     /**
-     * Creates a group. The maximum number of groups a tenant can have is 10,000.
+     * Creates a new group. The maximum number of groups a tenant can have is 10,000. Group names are case-sensitive, and must be unique.
      *
      * @param body an object with the body content
      * @throws CreateGroupHttpError

package/groups.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/BOJLTXK6.js";
-import "./chunks/VISO65GO.js";
+} from "./chunks/T6AQ34ZJ.js";
+import "./chunks/IMLCMV4X.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/groups.ts

package/identity-providers.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/BOJLTXK6.js";
-import "./chunks/VISO65GO.js";
+} from "./chunks/T6AQ34ZJ.js";
+import "./chunks/IMLCMV4X.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/identity-providers.ts