@qlik/api 1.30.0 → 1.31.0

package/chunks/{PTDXR7AY.js → YKZ2QYHN.js}

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

package/collections.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
-import './auth-types-PkN9CAF_.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
+import './auth-types-DqfMuSRX.js';
 
 type CollectionByIdPatch = {
     /** The operation to be performed. */
@@ -121,7 +121,7 @@ type ItemMetaResponseBody = {
 /**
  * The case-sensitive string defining the item's type.
  */
-type ItemResourceTypeEnum = "app" | "qlikview" | "qvapp" | "genericlink" | "sharingservicetask" | "note" | "dataasset" | "dataset" | "automation" | "automl-experiment" | "automl-deployment";
+type ItemResourceTypeEnum = "app" | "qlikview" | "qvapp" | "genericlink" | "sharingservicetask" | "note" | "dataasset" | "dataset" | "automation" | "automl-experiment" | "automl-deployment" | "assistant" | "dataproduct" | "dataqualityrule" | "glossary" | "knowledgebase" | "script";
 /**
  * An item.
  */

package/collections.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/PTDXR7AY.js";
-import "./chunks/TXC5XORK.js";
+} from "./chunks/YKZ2QYHN.js";
+import "./chunks/DLKLPD7T.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/collections.ts

package/csp-origins.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
-import './auth-types-PkN9CAF_.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
+import './auth-types-DqfMuSRX.js';
 
 type CSPEntry = {
     /** The CSP entry's unique identifier. */

package/csp-origins.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/PTDXR7AY.js";
-import "./chunks/TXC5XORK.js";
+} from "./chunks/YKZ2QYHN.js";
+import "./chunks/DLKLPD7T.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/csp-origins.ts

package/data-assets.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
-import './auth-types-PkN9CAF_.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
+import './auth-types-DqfMuSRX.js';
 
 type BatchIdDto = {
     ids?: string[];

package/data-assets.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/PTDXR7AY.js";
-import "./chunks/TXC5XORK.js";
+} from "./chunks/YKZ2QYHN.js";
+import "./chunks/DLKLPD7T.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/data-assets.ts

package/data-connections.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
-import './auth-types-PkN9CAF_.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
+import './auth-types-DqfMuSRX.js';
 
 type ActionDeleteRequest = {
     connections: {
@@ -130,10 +130,10 @@ type ConnectionGet = {
     /** List of connection parsed from connection string (only available when query parseConnection=true is set) */
     connectionProperties?: unknown;
     /** Datetime when the connection was created */
-    created: string;
+    created?: string;
     /** Data source ID */
     datasourceID?: string;
-    links?: Link;
+    links: Link;
     /** Array of string (i.e. update, delete, read) indicating the user's privileges on the associated connection */
     privileges: Privilege[];
     /** 0 or 1 value indicating whether the data connector is 64-bit (0) or 32-bit (1). Defaults to 0 if not specified. */
@@ -153,7 +153,7 @@ type ConnectionGet = {
     /** Descriptive name of the data connection */
     qName: string;
     /** Indicates whether or not this is a credential-less connection */
-    qSeparateCredentials: boolean;
+    qSeparateCredentials?: boolean;
     /** Type of connection, i.e. provider type of underlying connector */
     qType: string;
     /** Encrypted base Qri string (filterable using SCIM filter, e.g. filter='qri co "snowflake"') */
@@ -165,9 +165,9 @@ type ConnectionGet = {
     /** Tenant ID of the connection's creator */
     tenant: string;
     /** Datetime when the connection was last updated */
-    updated: string;
+    updated?: string;
     /** User ID of the connection's creator */
-    user: string;
+    user?: string;
 };
 type ConnectionUpdate = {
     /** ID of the datasource associated with this connection */

package/data-connections.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/PTDXR7AY.js";
-import "./chunks/TXC5XORK.js";
+} from "./chunks/YKZ2QYHN.js";
+import "./chunks/DLKLPD7T.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/data-connections.ts

package/data-credentials.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
-import './auth-types-PkN9CAF_.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
+import './auth-types-DqfMuSRX.js';
 
 type ActionFilterOrphanRequest = {
     /** Filtering on datasource ID of credentials */

package/data-credentials.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/PTDXR7AY.js";
-import "./chunks/TXC5XORK.js";
+} from "./chunks/YKZ2QYHN.js";
+import "./chunks/DLKLPD7T.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/data-credentials.ts

package/data-files.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
-import './auth-types-PkN9CAF_.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
+import './auth-types-DqfMuSRX.js';
 
 type BatchChangeSpaceItem = {
     /** The ID of the data file whose space will be changed. */

package/data-files.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/PTDXR7AY.js";
-import "./chunks/TXC5XORK.js";
+} from "./chunks/YKZ2QYHN.js";
+import "./chunks/DLKLPD7T.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/data-files.ts

package/docs/authentication.md

@@ -246,4 +246,51 @@ const hostConfig: HostConfig = {
 setDefaultHostConfig(hostConfig);
 ```
 
+## Registering a Host Config
+
+It is possible to register a named host config and reference it when making api-calls.
+
+When referencing a registered host config we use a special host config type with the auth type `reference` which only
+takes one property with the same name (`.reference`). There is no need to specify the auth type in the host config
+when using this host config type.
+
+This example shows how to use the `registerHostConfig` function and how to reference it.
+
+```ts
+import { auth, spaces } from "@qlik/api";
+
+auth.registerHostConfig("tenant 1", {
+  host: "tenant1.eu.qlikcloud.com",
+  authType: "apikey",
+  apiKey: "<api-key>",
+});
+
+auth.registerHostConfig("tenant 2", {
+  host: "tenant2.eu.qlikcloud.com",
+  authType: "apikey",
+  apiKey: "<api-key>",
+});
+
+const response = await spaces.getSpaces({}, { hostConfig: { reference: "tenant 1" } });
+console.log(`Tenant 1 has ${response.data.data.length} spaces`);
+const response2 = await spaces.getSpaces({}, { hostConfig: { reference: "tenant 2" } });
+console.log(`Tenant 2 has ${response2.data.data.length} spaces`);
+```
+
+This works equally well when using it in the `createQlikApi` function.
+
+```ts
+import { auth, createQlikApi } from "@qlik/api";
+
+auth.registerHostConfig("tenant 1", {
+  host: "tenant1.eu.qlikcloud.com",
+  authType: "apikey",
+  apiKey: "<api-key>",
+});
+
+const api = createQlikApi({ reference: "tenant 1" });
+
+// api is now bound to the registered host config "tenant 1"
+```
+
 ◁ [Back to overview](../README.md)

package/extensions.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
-import './auth-types-PkN9CAF_.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
+import './auth-types-DqfMuSRX.js';
 
 /**
  * Object containing meta data regarding the bundle the extension belongs to. If it does not belong to a bundle, this object is not defined.

package/extensions.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/PTDXR7AY.js";
-import "./chunks/TXC5XORK.js";
+} from "./chunks/YKZ2QYHN.js";
+import "./chunks/DLKLPD7T.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/extensions.ts

package/glossaries.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
-import './auth-types-PkN9CAF_.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
+import './auth-types-DqfMuSRX.js';
 
 /**
  * A JSON Patch document as defined in https://tools.ietf.org/html/rfc6902.

package/glossaries.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/PTDXR7AY.js";
-import "./chunks/TXC5XORK.js";
+} from "./chunks/YKZ2QYHN.js";
+import "./chunks/DLKLPD7T.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/glossaries.ts

package/groups.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
-import './auth-types-PkN9CAF_.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
+import './auth-types-DqfMuSRX.js';
 
 /**
  * An array of role references. Visibility dependant on access level. Must have access to roles to view other users' assigned roles.
@@ -189,8 +189,9 @@ type GroupSettings = {
             href: string;
         };
     };
-    /** Determines if groups should be created on login. */
-    syncIdpGroups: boolean;
+    /** @deprecated
+     * Determines if groups should be created on login. */
+    syncIdpGroups?: boolean;
     systemGroups?: {
         "000000000000000000000001"?: {
             /** An array of role references. Visibility dependant on access level. Must have access to roles to view other users' assigned roles. */

package/groups.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/PTDXR7AY.js";
-import "./chunks/TXC5XORK.js";
+} from "./chunks/YKZ2QYHN.js";
+import "./chunks/DLKLPD7T.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/groups.ts

package/identity-providers.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
-import './auth-types-PkN9CAF_.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
+import './auth-types-DqfMuSRX.js';
 
 type BaseIDP = {
     /** Indicates whether the IdP is available for use. */

package/identity-providers.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/PTDXR7AY.js";
-import "./chunks/TXC5XORK.js";
+} from "./chunks/YKZ2QYHN.js";
+import "./chunks/DLKLPD7T.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/identity-providers.ts

package/index.d.ts

@@ -1,5 +1,5 @@
 import { InterceptorsAPI, createInterceptors } from './interceptors.js';
-import { AuthAPI, registerAuthModule, setDefaultHostConfig, getAccessToken } from './auth.js';
+import { AuthAPI, registerAuthModule, setDefaultHostConfig, registerHostConfig, unregisterHostConfig, getAccessToken } from './auth.js';
 import { QixAPI } from './qix.js';
 import { ApiKeysAPI } from './api-keys.js';
 import { AppsAPI } from './apps.js';
@@ -33,8 +33,8 @@ import { UsersAPI } from './users.js';
 import { WebIntegrationsAPI } from './web-integrations.js';
 import { WebNotificationsAPI } from './web-notifications.js';
 import { WebhooksAPI } from './webhooks.js';
-import { H as HostConfig } from './auth-types-PkN9CAF_.js';
-import './invoke-fetch-types-BXn-uSF5.js';
+import { H as HostConfig } from './auth-types-DqfMuSRX.js';
+import './invoke-fetch-types-Cq7bjkqn.js';
 
 declare const apiKeys: ApiKeysAPI;
 declare const apps: AppsAPI;
@@ -42,6 +42,8 @@ declare const audits: AuditsAPI;
 declare const auth: {
     registerAuthModule: typeof registerAuthModule;
     setDefaultHostConfig: typeof setDefaultHostConfig;
+    registerHostConfig: typeof registerHostConfig;
+    unregisterHostConfig: typeof unregisterHostConfig;
     getAccessToken: typeof getAccessToken;
 };
 declare const automations: AutomationsAPI;

package/index.js

@@ -1,17 +1,17 @@
 import {
   qix_default
-} from "./chunks/IQBP2PKS.js";
+} from "./chunks/KBSD75QL.js";
 import {
   auth_default
-} from "./chunks/QK4TMJ64.js";
+} from "./chunks/GUU3KZGK.js";
 import {
   interceptors_default
 } from "./chunks/3RGGGGAR.js";
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/PTDXR7AY.js";
-import "./chunks/TXC5XORK.js";
+} from "./chunks/YKZ2QYHN.js";
+import "./chunks/DLKLPD7T.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/runtime-api-generator/runtime-api-generator-common.ts

package/interceptors.d.ts

@@ -1,5 +1,5 @@
-import { I as InvokeFetchResponse, a as InvokeFetchProperties } from './invoke-fetch-types-BXn-uSF5.js';
-import './auth-types-PkN9CAF_.js';
+import { I as InvokeFetchResponse, a as InvokeFetchProperties } from './invoke-fetch-types-Cq7bjkqn.js';
+import './auth-types-DqfMuSRX.js';
 
 /**
  * The RestInterceptor type is a function that can be used to intercept requests and responses

package/{invoke-fetch-types-BXn-uSF5.d.ts → invoke-fetch-types-Cq7bjkqn.d.ts}

@@ -1,4 +1,4 @@
-import { H as HostConfig } from './auth-types-PkN9CAF_.js';
+import { H as HostConfig } from './auth-types-DqfMuSRX.js';
 
 /** ApiKey Auth Configuration for a HostConfig */
 type ApiKeyAuthConfig = {
@@ -82,6 +82,11 @@ type AnonymousAuthConfig = {
     /** client id of oauth client created by tenant admin */
     clientId: string;
 };
+/** Used to reference a registered host config as a single string */
+type ReferenceConfig = {
+    /** The name of the registered host config to reference */
+    reference: string;
+};
 declare global {
     /**
      * QlikAuthModules is a global interface that can be extended to add custom auth modules.
@@ -102,6 +107,9 @@ declare global {
         windowscookie: {
             config: WindowsCookieAuthConfig;
         };
+        reference: {
+            config: ReferenceConfig;
+        };
         none: {
             config: object;
         };
@@ -160,7 +168,7 @@ type ApiCallOptions = {
      */
     useCacheIfAfter?: Date;
     /**
-     * Specify if another host than `globalThis.location` is to be used. Typically used in embedding and mashups
+     * Specify the host configif the api call is a cross-domain request. Typically used in embedding and mashups
      */
     hostConfig?: HostConfig;
     /**

package/items.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
-import './auth-types-PkN9CAF_.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
+import './auth-types-DqfMuSRX.js';
 
 type CollectionTypes = "private" | "public" | "publicgoverned";
 type ErrorResponseBody = {
@@ -129,7 +129,7 @@ type ItemMetaResponseBody = {
 /**
  * The case-sensitive string defining the item's type.
  */
-type ItemResourceTypeEnum = "app" | "qlikview" | "qvapp" | "genericlink" | "sharingservicetask" | "note" | "dataasset" | "dataset" | "automation" | "automl-experiment" | "automl-deployment";
+type ItemResourceTypeEnum = "app" | "qlikview" | "qvapp" | "genericlink" | "sharingservicetask" | "note" | "dataasset" | "dataset" | "automation" | "automl-experiment" | "automl-deployment" | "assistant" | "dataproduct" | "dataqualityrule" | "glossary" | "knowledgebase" | "script";
 /**
  * An item.
  */

package/items.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/PTDXR7AY.js";
-import "./chunks/TXC5XORK.js";
+} from "./chunks/YKZ2QYHN.js";
+import "./chunks/DLKLPD7T.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/items.ts

package/licenses.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
-import './auth-types-PkN9CAF_.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
+import './auth-types-DqfMuSRX.js';
 
 /**
  * @example
@@ -367,6 +367,7 @@ type LicenseOverview = {
 /**
  * @example
  * {
+ *   extensionStatus: "Unavailable",
  *   origin: "Internal",
  *   product: "Qlik Sense Business",
  *   status: "Ok",
@@ -376,6 +377,8 @@ type LicenseOverview = {
  * }
  */
 type LicenseStatus = {
+    /** Enum with extension status of license. access. */
+    extensionStatus: "Unavailable" | "Pending" | "Available";
     /** Origin of license key. */
     origin: "Internal" | "External";
     /** The product the license is valid for. */

package/licenses.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/PTDXR7AY.js";
-import "./chunks/TXC5XORK.js";
+} from "./chunks/YKZ2QYHN.js";
+import "./chunks/DLKLPD7T.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/licenses.ts

package/oauth-clients.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
-import './auth-types-PkN9CAF_.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
+import './auth-types-DqfMuSRX.js';
 
 /**
  * Hints of any client application secrets
@@ -123,6 +123,11 @@ type OAuthClientCreateRequest = {
     clientName: string;
     /** URI for homepage of client */
     clientUri?: string;
+    /** Optional settings for configuring the client connection. */
+    connectionConfig?: {
+        /** Specifies the consent method for the connection. The only allowed value is "trusted." */
+        consentMethod?: "trusted";
+    };
     /** Client description */
     description?: string;
     /** URI for logo of client */

package/oauth-clients.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/PTDXR7AY.js";
-import "./chunks/TXC5XORK.js";
+} from "./chunks/YKZ2QYHN.js";
+import "./chunks/DLKLPD7T.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/oauth-clients.ts

package/package.json

@@ -12,11 +12,12 @@
   },
   "dependencies": {
     "enigma.js": "^2.14.0",
+    "extend": "3.0.2",
     "lodash": "^4.17.21",
     "nanoid": "^5.0.9",
     "ws": "^8.18.1"
   },
-  "packageManager": "pnpm@10.7.0",
+  "packageManager": "pnpm@10.8.1",
   "engines": {
     "node": ">=20"
   },
@@ -57,5 +58,5 @@
     "./qix": "./qix.js",
     "./auth": "./auth.js"
   },
-  "version": "1.30.0"
+  "version": "1.31.0"
 }