@qlik/api 1.4.1 → 1.6.0

package/chunks/{5GE4XPP3.js → KSB5ROQL.js}

@@ -1,3 +1,8 @@
+import {
+  isBrowser,
+  isNode
+} from "./2ZQ3ZX7F.js";
+
 // src/platform/platform-functions.ts
 var getPlatform = async (options = {}) => {
   const isNodeEnvironment = typeof window === "undefined";
@@ -497,39 +502,6 @@ var none_default = {
   validateHostConfig: (hostConfig) => internalValidateHostConfig(hostConfig, { requiredProps: [], optionalProps: [] })
 };
 
-// src/utils/utils.ts
-import { nanoid } from "nanoid";
-function isBrowserInternal() {
-  if (typeof window !== "undefined" && typeof window.document !== "undefined" && typeof self !== "undefined") {
-    return true;
-  }
-  return false;
-}
-function isNodeInternal() {
-  if (typeof process !== "undefined" && process.version && process.versions.node) {
-    return true;
-  }
-  return false;
-}
-function getEnvironment() {
-  if (isNodeInternal()) {
-    return "node";
-  }
-  if (isBrowserInternal()) {
-    return "browser";
-  }
-  throw new Error("Environment detection failed. Supported environments are either a browser or in a node environment");
-}
-function isBrowser() {
-  return getEnvironment() === "browser";
-}
-function isNode() {
-  return getEnvironment() === "node";
-}
-function generateRandomString(targetLength) {
-  return nanoid(targetLength);
-}
-
 // src/auth/internal/default-auth-modules/oauth/storage-helpers.ts
 var storagePrefix = "qlik-qmfe-api";
 function getTopicFromHostConfig(hostConfig) {
@@ -665,6 +637,12 @@ function handleOAuthCallback() {
   }
 }
 
+// src/random/random.ts
+import { nanoid } from "nanoid";
+function generateRandomString(targetLength) {
+  return nanoid(targetLength);
+}
+
 // src/auth/internal/default-auth-modules/oauth/oauth-utils.ts
 function lookupGetAccessFn(getAccessToken2) {
   return globalThis[getAccessToken2];
@@ -1327,7 +1305,7 @@ async function fetchAndTransformExceptions(input, init) {
     return Promise.reject(new InvokeFetchError(getErrorMessage(e), 0, new Headers(), {}));
   }
 }
-async function performActualHttpFetch(method, completeUrl, unencodedBody, contentType, options, interceptors, authHeaders, credentials) {
+async function performActualHttpFetch(method, completeUrl, unencodedBody, contentType, options, interceptors, authHeaders, credentials, userAgent) {
   const { body, contentTypeHeader, requestOptions } = encodeBody(unencodedBody, contentType ?? "");
   const headers = {
     ...contentTypeHeader,
@@ -1335,6 +1313,9 @@ async function performActualHttpFetch(method, completeUrl, unencodedBody, conten
     ...options?.headers,
     ...getServiceOverrideHeaderFromLocalStorage()
   };
+  if (!headers["User-Agent"] && userAgent) {
+    headers["User-Agent"] = userAgent;
+  }
   const isCrossOrigin = isHostCrossOrigin(options?.hostConfig);
   let request = {
     method,
@@ -1348,7 +1329,9 @@ async function performActualHttpFetch(method, completeUrl, unencodedBody, conten
     // This adds 'duplex: "half"' if we're sending application/octet-stream, needed in node only.
   };
   let fetchTimeoutId;
-  if (options?.timeoutMs && options.timeoutMs > 0) {
+  if (options?.signal) {
+    request.signal = options.signal;
+  } else if (options?.timeoutMs && options.timeoutMs > 0) {
     const controller = new AbortController();
     fetchTimeoutId = setTimeout(() => {
       controller.abort();
@@ -1499,7 +1482,17 @@ function invokeFetchWithUrl(api, props, interceptors) {
     interceptors
   );
 }
-function invokeFetchWithUrlAndRetry(api, { method, completeUrl, cacheKey, body, options, authHeaders, credentials, contentType }, performRetry, interceptors) {
+function invokeFetchWithUrlAndRetry(api, {
+  method,
+  completeUrl,
+  cacheKey,
+  body,
+  options,
+  authHeaders,
+  credentials,
+  contentType,
+  userAgent
+}, performRetry, interceptors) {
   if (!cache[api]) {
     cache[api] = {};
   }
@@ -1521,7 +1514,8 @@ function invokeFetchWithUrlAndRetry(api, { method, completeUrl, cacheKey, body,
     options,
     interceptors,
     authHeaders,
-    credentials
+    credentials,
+    userAgent
   );
   const resultAfterAuthenticationCheck = interceptAuthenticationErrors(
     options?.hostConfig,
@@ -1698,12 +1692,21 @@ function cleanStack(stack) {
 }
 
 // src/invoke-fetch/invoke-fetch-functions.ts
+var defaultUserAgent = "qmfe-api/latest";
 async function invokeFetch(api, props, interceptors) {
   checkForCrossDomainRequest(props.options?.hostConfig);
+  let userAgent;
+  if (props?.userAgent) {
+    userAgent = props.userAgent;
+  } else if (isBrowser()) {
+    userAgent = `${window.navigator.userAgent} ${defaultUserAgent}`;
+  } else {
+    userAgent = defaultUserAgent;
+  }
   const { completeUrl, cacheKey, authHeaders, credentials } = await getInvokeFetchUrlParams(props);
   return invokeFetchWithUrl(
     api,
-    { ...props, method: props.method.toUpperCase(), completeUrl, cacheKey, authHeaders, credentials },
+    { ...props, method: props.method.toUpperCase(), completeUrl, cacheKey, authHeaders, credentials, userAgent },
     interceptors
   );
 }
@@ -1777,13 +1780,12 @@ export {
   setDefaultHostConfig2 as setDefaultHostConfig,
   checkForCrossDomainRequest,
   logout,
-  isBrowser,
-  generateRandomString,
   InvokeFetchError,
   EncodingError,
   invokeFetch,
   clearApiCache,
   parseFetchResponse,
   invoke_fetch_default,
+  generateRandomString,
   auth_default
 };

package/chunks/{3IA4SDJA.js → NR2F7MAJ.js}

@@ -1,6 +1,6 @@
 import {
   getQixRuntimeModule
-} from "./54UDXFVD.js";
+} from "./I5CSZHWM.js";
 
 // src/public/qix.ts
 function openAppSession(appSessionProps) {
@@ -41,15 +41,16 @@ function openAppSession(appSessionProps) {
      * this is basically a no op, but if this is the last/only usage
      * of the underlying enigma websocket that websocket will be closed.
      */
-    async close() {
-      return (await appSessionPromise).close();
+    async close(props) {
+      return (await appSessionPromise).close(props);
     }
   };
   return appSessionProxy;
 }
-var qix_default = {
+var qix = {
   openAppSession
 };
+var qix_default = qix;
 
 export {
   openAppSession,

package/chunks/{W3BAQSQ7.js → S3X62FNR.js}

@@ -1,11 +1,23 @@
+import {
+  isBrowser
+} from "./2ZQ3ZX7F.js";
 import {
   getInvokeFetchRuntimeModule
-} from "./54UDXFVD.js";
+} from "./I5CSZHWM.js";
 
 // src/public/invoke-fetch.ts
+var defaultUserAgent = "qlik-api/1.6.0";
 async function invokeFetch(api, props) {
   const hostConfig = props.options?.hostConfig;
-  return (await getInvokeFetchRuntimeModule(hostConfig)).invokeFetch(api, props);
+  let userAgent;
+  if (props?.userAgent) {
+    userAgent = props.userAgent;
+  } else if (isBrowser()) {
+    userAgent = `${window.navigator.userAgent} ${defaultUserAgent}`;
+  } else {
+    userAgent = defaultUserAgent;
+  }
+  return (await getInvokeFetchRuntimeModule(hostConfig)).invokeFetch(api, { ...props, userAgent });
 }
 function clearApiCache(api) {
   void getInvokeFetchRuntimeModule().then((runtimeModule) => runtimeModule.clearApiCache(api));

package/chunks/{LDQGW22R.js → SW3DXPAP.js}

@@ -5,7 +5,8 @@ import {
   invokeFetch,
   invoke_fetch_default,
   parseFetchResponse
-} from "./5GE4XPP3.js";
+} from "./KSB5ROQL.js";
+import "./2ZQ3ZX7F.js";
 export {
   EncodingError,
   InvokeFetchError,

package/collections.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types-CMQsAHYd.js';
+import { A as ApiCallOptions } from './global.types-Xt6XzwlN.js';
 import './auth-types-Bqw3vbLs.js';
 
 type CollectionByIdPatch = {

package/collections.js

@@ -1,8 +1,9 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/W3BAQSQ7.js";
-import "./chunks/54UDXFVD.js";
+} from "./chunks/S3X62FNR.js";
+import "./chunks/2ZQ3ZX7F.js";
+import "./chunks/I5CSZHWM.js";
 
 // src/public/rest/collections.ts
 var getCollections = async (query, options) => invokeFetch("collections", {

package/csp-origins.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types-CMQsAHYd.js';
+import { A as ApiCallOptions } from './global.types-Xt6XzwlN.js';
 import './auth-types-Bqw3vbLs.js';
 
 type CSPEntry = {

package/csp-origins.js

@@ -1,8 +1,9 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/W3BAQSQ7.js";
-import "./chunks/54UDXFVD.js";
+} from "./chunks/S3X62FNR.js";
+import "./chunks/2ZQ3ZX7F.js";
+import "./chunks/I5CSZHWM.js";
 
 // src/public/rest/csp-origins.ts
 var getCSPEntries = async (query, options) => invokeFetch("csp-origins", {

package/data-assets.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types-CMQsAHYd.js';
+import { A as ApiCallOptions } from './global.types-Xt6XzwlN.js';
 import './auth-types-Bqw3vbLs.js';
 
 type BatchIdDto = {

package/data-assets.js

@@ -1,8 +1,9 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/W3BAQSQ7.js";
-import "./chunks/54UDXFVD.js";
+} from "./chunks/S3X62FNR.js";
+import "./chunks/2ZQ3ZX7F.js";
+import "./chunks/I5CSZHWM.js";
 
 // src/public/rest/data-assets.ts
 var deleteDataAssets = async (body, options) => invokeFetch("data-assets", {

package/data-connections.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types-CMQsAHYd.js';
+import { A as ApiCallOptions } from './global.types-Xt6XzwlN.js';
 import './auth-types-Bqw3vbLs.js';
 
 type ActionDeleteRequest = {

package/data-connections.js

@@ -1,8 +1,9 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/W3BAQSQ7.js";
-import "./chunks/54UDXFVD.js";
+} from "./chunks/S3X62FNR.js";
+import "./chunks/2ZQ3ZX7F.js";
+import "./chunks/I5CSZHWM.js";
 
 // src/public/rest/data-connections.ts
 var getDataConnections = async (query, options) => invokeFetch("data-connections", {

package/data-credentials.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types-CMQsAHYd.js';
+import { A as ApiCallOptions } from './global.types-Xt6XzwlN.js';
 import './auth-types-Bqw3vbLs.js';
 
 type Credential = {

package/data-credentials.js

@@ -1,8 +1,9 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/W3BAQSQ7.js";
-import "./chunks/54UDXFVD.js";
+} from "./chunks/S3X62FNR.js";
+import "./chunks/2ZQ3ZX7F.js";
+import "./chunks/I5CSZHWM.js";
 
 // src/public/rest/data-credentials.ts
 var deleteDataCredential = async (qID, query, options) => invokeFetch("data-credentials", {

package/data-files.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types-CMQsAHYd.js';
+import { A as ApiCallOptions } from './global.types-Xt6XzwlN.js';
 import './auth-types-Bqw3vbLs.js';
 
 type BatchChangeSpaceItem = {

package/data-files.js

@@ -1,8 +1,9 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/W3BAQSQ7.js";
-import "./chunks/54UDXFVD.js";
+} from "./chunks/S3X62FNR.js";
+import "./chunks/2ZQ3ZX7F.js";
+import "./chunks/I5CSZHWM.js";
 
 // src/public/rest/data-files.ts
 var getDataFiles = async (query, options) => invokeFetch("data-files", {

package/docs/examples/fetch-spaces.md

@@ -34,7 +34,7 @@ const hostConfig = {
   host: "your-tenant.region.qlikcloud.com",
   authType: "oauth2",
   clientId: "<client-id>",
-  clientSecret "<client-secret>",
+  clientSecret: "<client-secret>",
 };
 
 auth.setDefaultHostConfig(hostConfig);

package/extensions.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types-CMQsAHYd.js';
+import { A as ApiCallOptions } from './global.types-Xt6XzwlN.js';
 import './auth-types-Bqw3vbLs.js';
 
 /**

package/extensions.js

@@ -1,8 +1,9 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/W3BAQSQ7.js";
-import "./chunks/54UDXFVD.js";
+} from "./chunks/S3X62FNR.js";
+import "./chunks/2ZQ3ZX7F.js";
+import "./chunks/I5CSZHWM.js";
 
 // src/public/rest/extensions.ts
 var getExtensions = async (options) => invokeFetch("extensions", {

package/{global.types-CMQsAHYd.d.ts → global.types-Xt6XzwlN.d.ts}

@@ -32,8 +32,15 @@ type ApiCallOptions = {
     /**
      * Set the amount of time to wait for a response.
      * If the timeout is exceeded the request is aborted.
+     * If both timeoutMs and signal is present, timeoutMs will have no effect, as
+     * there is already an abort-signal specified.
      */
     timeoutMs?: number;
+    /**
+     * An abort-signal lets you abort an ongoing fetch request. The abort-signal is created
+     * by taking the .signal property of an AbortController.
+     */
+    signal?: AbortSignal;
 };
 type DownloadableBlob = Blob & {
     /** download the blob in a using the specified filename */

package/glossaries.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types-CMQsAHYd.js';
+import { A as ApiCallOptions } from './global.types-Xt6XzwlN.js';
 import './auth-types-Bqw3vbLs.js';
 
 /**
@@ -113,10 +113,10 @@ type Category = {
     id: string;
     name: string;
     parentId?: string;
-    /** This list contains the uuids of the stewards of the category. */
+    /** This list contains the uids of the stewards of the category. */
     stewards?: string[];
     readonly updatedAt: string;
-    /** The uuid of the user who last updated the category */
+    /** The uid of the user who last updated the category */
     readonly updatedBy: string;
 };
 type CreateCategory = {
@@ -127,7 +127,7 @@ type CreateCategory = {
     /** The name of the category. May not be identical to another category belonging to the same parent. */
     name?: string;
     parentId?: string;
-    /** This list contains the uuids of the stewards of the category. */
+    /** This list contains the uids of the stewards of the category. */
     stewards?: string[];
 };
 type CreateGlossary = {
@@ -152,7 +152,7 @@ type CreateTerm = {
     name: string;
     relatedInformation?: string;
     relatesTo?: TermRelatesTo[];
-    /** This list contain the uuids for the terms stewards */
+    /** This list contain the uids for the term's stewards */
     stewards?: string[];
     tags?: string[];
 };
@@ -233,7 +233,7 @@ type ExportGlossary = {
     termTemplate?: TermTemplate;
     terms?: ExportTerm[];
     readonly updatedAt?: string;
-    /** The uuid of the user who last updated the glossary */
+    /** The uid of the user who last updated the glossary */
     readonly updatedBy?: string;
 };
 type ExportTerm = {
@@ -358,11 +358,11 @@ type Term = {
     revision: number;
     /** Terms status is used determine the status of a term */
     status: TermStatus;
-    /** This list contains the uuids of the terms data stewards. */
+    /** This list contains the uids of the terms data stewards. */
     stewards: string[];
     tags: string[];
     readonly updatedAt: string;
-    /** The uuid of the user who last updated the term */
+    /** The uid of the user who last updated the term */
     readonly updatedBy: string;
 };
 /**
@@ -385,11 +385,13 @@ type TermLinksTo = {
     id?: string;
     name?: string;
     openUrl?: string;
+    /** Different formats based on resource type. Could be e.g. OID or UUID. */
     resourceId?: string;
     resourceSpaceId?: string;
     resourceType?: "app" | "dataset";
     /** Http status code for item during batch operation. */
     status?: number;
+    /** Different formats based on subresource type. Could be e.g. OID or UUID. */
     subResourceId?: string;
     subResourceName?: string;
     subResourceType?: "master_dimension" | "master_measure";

package/glossaries.js

@@ -1,8 +1,9 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/W3BAQSQ7.js";
-import "./chunks/54UDXFVD.js";
+} from "./chunks/S3X62FNR.js";
+import "./chunks/2ZQ3ZX7F.js";
+import "./chunks/I5CSZHWM.js";
 
 // src/public/rest/glossaries.ts
 var getGlossaries = async (query, options) => invokeFetch("glossaries", {

package/groups.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types-CMQsAHYd.js';
+import { A as ApiCallOptions } from './global.types-Xt6XzwlN.js';
 import './auth-types-Bqw3vbLs.js';
 
 /**

package/groups.js

@@ -1,8 +1,9 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/W3BAQSQ7.js";
-import "./chunks/54UDXFVD.js";
+} from "./chunks/S3X62FNR.js";
+import "./chunks/2ZQ3ZX7F.js";
+import "./chunks/I5CSZHWM.js";
 
 // src/public/rest/groups.ts
 var getGroups = async (query, options) => invokeFetch("groups", {

package/identity-providers.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types-CMQsAHYd.js';
+import { A as ApiCallOptions } from './global.types-Xt6XzwlN.js';
 import './auth-types-Bqw3vbLs.js';
 
 type BaseIDP = {

package/identity-providers.js

@@ -1,8 +1,9 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/W3BAQSQ7.js";
-import "./chunks/54UDXFVD.js";
+} from "./chunks/S3X62FNR.js";
+import "./chunks/2ZQ3ZX7F.js";
+import "./chunks/I5CSZHWM.js";
 
 // src/public/rest/identity-providers.ts
 var getIdps = async (query, options) => invokeFetch("identity-providers", {

package/index.d.ts

@@ -30,7 +30,7 @@ import { UsersAPI } from './users.js';
 import { WebIntegrationsAPI } from './web-integrations.js';
 import { WebNotificationsAPI } from './web-notifications.js';
 import { WebhooksAPI } from './webhooks.js';
-import './global.types-CMQsAHYd.js';
+import './global.types-Xt6XzwlN.js';
 import './auth-types-Bqw3vbLs.js';
 
 declare const apiKeys: ApiKeysAPI;

package/index.js

@@ -1,14 +1,15 @@
 import {
   auth_default
-} from "./chunks/JK564JXC.js";
+} from "./chunks/BPM4DLZK.js";
 import {
   qix_default
-} from "./chunks/3IA4SDJA.js";
+} from "./chunks/NR2F7MAJ.js";
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/W3BAQSQ7.js";
-import "./chunks/54UDXFVD.js";
+} from "./chunks/S3X62FNR.js";
+import "./chunks/2ZQ3ZX7F.js";
+import "./chunks/I5CSZHWM.js";
 
 // src/public/public-runtime-api-generator/public-runtime-api-generator.ts
 var methodAbbreviations = {
@@ -257,7 +258,7 @@ var automations = apiDefToApi("automations", {
         settings: ["getAutomationsSettings:G:", "updateAutomationsSettings:UBJ:"],
         usage: ["getAutomationsUsageMetrics:GQ:"],
         "{id}": {
-          "": ["deleteAutomation:D:", "getAutomation:G:", "updateAutomation:UBJ:"],
+          "": ["deleteAutomation:D:", "getAutomationWithQuery:GQ:", "getAutomation:G:", "updateAutomation:UBJ:"],
           actions: {
             copy: ["copyAutomation:PBJ:"],
             disable: ["disableAutomation:P:"],
@@ -267,7 +268,7 @@ var automations = apiDefToApi("automations", {
           runs: {
             "": ["getAutomationRuns:GQ:", "queueAutomationRun:PBJ:"],
             "{runId}": {
-              "": ["getAutomationRun:G:"],
+              "": ["getAutomationRunWithQuery:GQ:", "getAutomationRun:G:"],
               actions: {
                 export: ["getAutomationRunDetails:P:"],
                 retry: ["retryAutomationRun:P:"],

package/items.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types-CMQsAHYd.js';
+import { A as ApiCallOptions } from './global.types-Xt6XzwlN.js';
 import './auth-types-Bqw3vbLs.js';
 
 type CollectionTypes = "private" | "public" | "publicgoverned";

package/items.js

@@ -1,8 +1,9 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/W3BAQSQ7.js";
-import "./chunks/54UDXFVD.js";
+} from "./chunks/S3X62FNR.js";
+import "./chunks/2ZQ3ZX7F.js";
+import "./chunks/I5CSZHWM.js";
 
 // src/public/rest/items.ts
 var getItems = async (query, options) => invokeFetch("items", {

package/licenses.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types-CMQsAHYd.js';
+import { A as ApiCallOptions } from './global.types-Xt6XzwlN.js';
 import './auth-types-Bqw3vbLs.js';
 
 type AssignmentsActionsAddRequest = {

package/licenses.js

@@ -1,8 +1,9 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/W3BAQSQ7.js";
-import "./chunks/54UDXFVD.js";
+} from "./chunks/S3X62FNR.js";
+import "./chunks/2ZQ3ZX7F.js";
+import "./chunks/I5CSZHWM.js";
 
 // src/public/rest/licenses.ts
 var getLicenseAssignments = async (query, options) => invokeFetch("licenses", {

package/package.json

@@ -11,13 +11,9 @@
     "fs": false
   },
   "dependencies": {
-    "@qlik/embed-runtime": "^0.7.0",
-    "@qlik/runtime-module-loader": "^0.2.7",
-    "ajv": "^8.12.0",
-    "bufferutil": "^4.0.8",
     "enigma.js": "^2.14.0",
     "lodash": "^4.17.21",
-    "nanoid": "^5.0.6",
+    "nanoid": "^5.0.7",
     "ws": "^8.17.0"
   },
   "engines": {
@@ -58,5 +54,5 @@
     "./qix": "./qix.js",
     "./auth": "./auth.js"
   },
-  "version": "1.4.1"
+  "version": "1.6.0"
 }