@qlik/api 2.3.0 → 2.4.0

package/direct-access-agents.js

@@ -1,5 +1,5 @@
-import "./chunks/public-runtime-modules-QhLPeQr5.js";
-import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-B7lGscuQ.js";
+import "./chunks/public-runtime-modules-2KfyI2qM.js";
+import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DMAi6Fg3.js";
 
 //#region src/public/rest/direct-access-agents.ts
 /**
@@ -333,7 +333,6 @@ const directAccessAgentsExport = {
 	setDirectAccessAgentToolsMetricsCollectorConfiguration,
 	clearCache
 };
-var direct_access_agents_default = directAccessAgentsExport;
 
 //#endregion
-export { clearCache, createDirectAccessAgentBenchmark, createDirectAccessAgentBenchmarkCancel, direct_access_agents_default as default, getDirectAccessAgentBenchmark, getDirectAccessAgentConfiguration, getDirectAccessAgentConnectorFile, getDirectAccessAgentConnectorFiles, getDirectAccessAgentConnectorFilesWithoutQuery, getDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths, getDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings, getDirectAccessAgentToolsMetricsCollectorConfiguration, patchDirectAccessAgentConfiguration, putDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths, putDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings, restartDirectAccessAgent, setDirectAccessAgentToolsMetricsCollectorConfiguration, updateDirectAccessAgentConnectorFile, updateDirectAccessAgentConnectorFileWithoutQuery };
+export { clearCache, createDirectAccessAgentBenchmark, createDirectAccessAgentBenchmarkCancel, directAccessAgentsExport as default, getDirectAccessAgentBenchmark, getDirectAccessAgentConfiguration, getDirectAccessAgentConnectorFile, getDirectAccessAgentConnectorFiles, getDirectAccessAgentConnectorFilesWithoutQuery, getDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths, getDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings, getDirectAccessAgentToolsMetricsCollectorConfiguration, patchDirectAccessAgentConfiguration, putDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths, putDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings, restartDirectAccessAgent, setDirectAccessAgentToolsMetricsCollectorConfiguration, updateDirectAccessAgentConnectorFile, updateDirectAccessAgentConnectorFileWithoutQuery };

package/encryption.d.ts

@@ -1,8 +1,7 @@
-import { y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
-import "./chunks/invoke-fetch-C1Z0RJYU.js";
+import { ApiCallOptions } from "./invoke-fetch-types.js";
+import "./chunks/invoke-fetch-DFc3yzaj.js";
 
 //#region src/public/rest/encryption.d.ts
-
 /**
  * @example
  * {
@@ -21,33 +20,20 @@ import "./chunks/invoke-fetch-C1Z0RJYU.js";
  * }
  */
 type KeyProvider = {
-  /** The provider resource notation for the key. */
-  arn: string;
-  /** The ARN fingerprint. */
-  readonly arnFingerPrint?: string;
-  /** When key entry was created. */
-  readonly createdAt?: string;
-  /** Indicates whether the key is being used to encrypt/decrypt secrets. */
-  readonly current?: boolean;
-  /** When the key was demoted from being current to non active. */
-  readonly demotedFromCurrentAt?: string;
-  /** Description of key provider entry. */
-  description?: string;
-  /** Key Provider type. */
-  keyprovider: "AWS-KMS";
-  /** Indicates whether the key has multi-region configurations and has replica key in qcs secondary region. */
-  readonly multiRegion?: boolean;
-  /** Name of key provider entry. */
-  name: string;
-  /** When the key was promoted to being the current active one. */
+  /** The provider resource notation for the key. */arn: string; /** The ARN fingerprint. */
+  readonly arnFingerPrint?: string; /** When key entry was created. */
+  readonly createdAt?: string; /** Indicates whether the key is being used to encrypt/decrypt secrets. */
+  readonly current?: boolean; /** When the key was demoted from being current to non active. */
+  readonly demotedFromCurrentAt?: string; /** Description of key provider entry. */
+  description?: string; /** Key Provider type. */
+  keyprovider: "AWS-KMS"; /** Indicates whether the key has multi-region configurations and has replica key in qcs secondary region. */
+  readonly multiRegion?: boolean; /** Name of key provider entry. */
+  name: string; /** When the key was promoted to being the current active one. */
   readonly promotedToCurrentAt?: string;
   readonly replicaKeys?: {
-    /** Replica key keeps list of backup keys from the supported qcs secondary region. */
-    arn?: string;
-    /** Region indicates the backup qcs-region link to the primary region. */
+    /** Replica key keeps list of backup keys from the supported qcs secondary region. */arn?: string; /** Region indicates the backup qcs-region link to the primary region. */
     region?: string;
-  }[];
-  /** Tenant ID. */
+  }[]; /** Tenant ID. */
   readonly tenantId?: string;
 };
 /**
@@ -60,11 +46,8 @@ type KeyProvider = {
  * }
  */
 type KeyProviderPatchBase = {
-  /** The operation to be performed. */
-  op: "replace";
-  /** The property path. */
-  path: string;
-  /** The value to be used for this operation. */
+  /** The operation to be performed. */op: "replace"; /** The property path. */
+  path: string; /** The value to be used for this operation. */
   value: string;
 };
 type KeyProviderPatchSchema = KeyProviderPatchBase[];
@@ -72,47 +55,33 @@ type KeyProviders = {
   errors?: KeyProvider[];
 };
 type KeyProvidersDeleteResponseBody = {
-  /** Successful response message. */
-  response?: string;
+  /** Successful response message. */response?: string;
 };
 type ListKeyProviders = {
   errors?: KeyProvider[];
 };
 type MigrationInformation = {
-  completedAt?: string;
-  /** Migration operation ID. */
+  completedAt?: string; /** Migration operation ID. */
   id?: string;
-  initiatedAt?: string;
-  /** The key ARN being migrated from (in case of QlikVault, could be a short name only). */
-  migratingFrom?: string;
-  /** The new key ARN that keys should be migrated to. */
-  migratingTo?: string;
-  /** The new key ARN fingerprint. */
-  migratingToFingerprint?: string;
-  /** The new key prefix (to help services know which prefix should NOT be migrated). */
-  migratingToPrefix?: string;
-  /** Progress in percentage. */
-  progress?: number;
-  /** Migration operation state. */
-  state?: "New" | "InProgress" | "Completed";
-  /** Tenant ID. */
+  initiatedAt?: string; /** The key ARN being migrated from (in case of QlikVault, could be a short name only). */
+  migratingFrom?: string; /** The new key ARN that keys should be migrated to. */
+  migratingTo?: string; /** The new key ARN fingerprint. */
+  migratingToFingerprint?: string; /** The new key prefix (to help services know which prefix should NOT be migrated). */
+  migratingToPrefix?: string; /** Progress in percentage. */
+  progress?: number; /** Migration operation state. */
+  state?: "New" | "InProgress" | "Completed"; /** Tenant ID. */
   tenantId?: string;
 };
 type ResetMigrationNotNeeded = {
-  /** Tenant is already using Qlik KMS, no migration is required. */
-  message?: string;
+  /** Tenant is already using Qlik KMS, no migration is required. */message?: string;
 };
 type StandardError = {
   errors: StandardErrorItem[];
 };
 type StandardErrorItem = {
-  /** The error code. */
-  code: string;
-  /** Extra information about the error. */
-  detail?: string;
-  /** Additional error object metadata. */
-  meta?: unknown;
-  /** Description of the error. */
+  /** The error code. */code: string; /** Extra information about the error. */
+  detail?: string; /** Additional error object metadata. */
+  meta?: unknown; /** Description of the error. */
   title: string;
 };
 /**

package/encryption.js

@@ -1,5 +1,5 @@
-import "./chunks/public-runtime-modules-QhLPeQr5.js";
-import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-B7lGscuQ.js";
+import "./chunks/public-runtime-modules-2KfyI2qM.js";
+import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DMAi6Fg3.js";
 
 //#region src/public/rest/encryption.ts
 /**
@@ -160,7 +160,6 @@ const encryptionExport = {
 	testEncryptionKeyprovider,
 	clearCache
 };
-var encryption_default = encryptionExport;
 
 //#endregion
-export { clearCache, createEncryptionKeyprovider, encryption_default as default, deleteEncryptionKeyprovider, getEncryptionKeyprovider, getEncryptionKeyproviders, getEncryptionKeyprovidersMigrationDetails, listEncryptionKeyproviders, migrateEncryptionKeyprovider, patchEncryptionKeyprovider, resetEncryptionKeyproviders, testEncryptionKeyprovider };
+export { clearCache, createEncryptionKeyprovider, encryptionExport as default, deleteEncryptionKeyprovider, getEncryptionKeyprovider, getEncryptionKeyproviders, getEncryptionKeyprovidersMigrationDetails, listEncryptionKeyproviders, migrateEncryptionKeyprovider, patchEncryptionKeyprovider, resetEncryptionKeyproviders, testEncryptionKeyprovider };

package/extensions.d.ts

@@ -1,87 +1,56 @@
-import { y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
-import "./chunks/invoke-fetch-C1Z0RJYU.js";
+import { ApiCallOptions, DownloadableBlob } from "./invoke-fetch-types.js";
+import "./chunks/invoke-fetch-DFc3yzaj.js";
 
 //#region src/public/rest/extensions.d.ts
 /**
  * Object containing meta data regarding the bundle the extension belongs to. If it does not belong to a bundle, this object is not defined.
  */
 type BundleMeta = {
-  /** Description of the bundle. */
-  description?: string;
-  /** Unique identifier of the bundle. */
-  id?: string;
-  /** Name of the bundle. */
+  /** Description of the bundle. */description?: string; /** Unique identifier of the bundle. */
+  id?: string; /** Name of the bundle. */
   name?: string;
 };
 /**
  * An error object.
  */
 type Error = {
-  /** Object containing meta data regarding an error. It does not necessarily contain all the properties. */
-  meta?: Meta;
-  /** Optional JSON patch object pointing to an invalid property. */
-  source?: unknown;
-  /** The HTTP status code. */
-  status?: number;
-  /** Title of the HTTP status code. */
-  title: string;
-  /** The active traceId. */
+  /** Object containing meta data regarding an error. It does not necessarily contain all the properties. */meta?: Meta; /** Optional JSON patch object pointing to an invalid property. */
+  source?: unknown; /** The HTTP status code. */
+  status?: number; /** Title of the HTTP status code. */
+  title: string; /** The active traceId. */
   traceId?: string;
 };
 /**
  * The extension model.
  */
 type Extension = {
-  /** Author of the extension. */
-  author?: string;
-  /** Object containing meta data regarding the bundle the extension belongs to. If it does not belong to a bundle, this object is not defined. */
-  bundle?: BundleMeta;
-  /** If the extension is part of an extension bundle. */
-  bundled?: boolean;
-  /** Checksum of the extension contents. */
+  /** Author of the extension. */author?: string; /** Object containing meta data regarding the bundle the extension belongs to. If it does not belong to a bundle, this object is not defined. */
+  bundle?: BundleMeta; /** If the extension is part of an extension bundle. */
+  bundled?: boolean; /** Checksum of the extension contents. */
   checksum?: string;
-  readonly createdAt?: string;
-  /** Map of dependencies describing version of the component it requires. */
-  dependencies?: unknown;
-  /** A date noting when the extension was deprecated. */
-  deprecated?: string;
-  /** Description of the extension. */
-  description?: string;
-  /** The file that was uploaded with the extension. */
-  file?: unknown;
-  /** Home page of the extension. */
-  homepage?: string;
-  /** Icon to show in the client. */
+  readonly createdAt?: string; /** Map of dependencies describing version of the component it requires. */
+  dependencies?: unknown; /** A date noting when the extension was deprecated. */
+  deprecated?: string; /** Description of the extension. */
+  description?: string; /** The file that was uploaded with the extension. */
+  file?: unknown; /** Home page of the extension. */
+  homepage?: string; /** Icon to show in the client. */
   icon?: string;
-  readonly id?: string;
-  /** Keywords for the extension. */
-  keywords?: string;
-  /** Under which license this extension is published. */
-  license?: string;
-  /** Relative path to the extension's entry file, defaults to `filename` from the qext file. */
-  loadpath?: string;
-  /** The display name of this extension. */
-  name?: string;
-  /** Path to an image that enables users to preview the extension. */
-  preview?: string;
-  /** The name of the qext file that was uploaded with this extension. */
-  qextFilename?: string;
-  /** The version from the qext file that was uploaded with this extension. */
-  qextVersion?: string;
-  /** Link to the extension source code. */
-  repository?: string;
-  /** If the extension is a supernova extension or not. */
-  supernova?: boolean;
-  /** Supplier of the extension. */
-  supplier?: string;
-  /** List of tags. */
+  readonly id?: string; /** Keywords for the extension. */
+  keywords?: string; /** Under which license this extension is published. */
+  license?: string; /** Relative path to the extension's entry file, defaults to `filename` from the qext file. */
+  loadpath?: string; /** The display name of this extension. */
+  name?: string; /** Path to an image that enables users to preview the extension. */
+  preview?: string; /** The name of the qext file that was uploaded with this extension. */
+  qextFilename?: string; /** The version from the qext file that was uploaded with this extension. */
+  qextVersion?: string; /** Link to the extension source code. */
+  repository?: string; /** If the extension is a supernova extension or not. */
+  supernova?: boolean; /** Supplier of the extension. */
+  supplier?: string; /** List of tags. */
   tags?: string[];
-  readonly tenantId?: string;
-  /** The type of this extension (visualization, etc.). */
+  readonly tenantId?: string; /** The type of this extension (visualization, etc.). */
   type?: string;
   readonly updateAt?: string;
-  readonly userId?: string;
-  /** Version of the extension. */
+  readonly userId?: string; /** Version of the extension. */
   version?: string;
 };
 type Extensions = {
@@ -91,11 +60,8 @@ type Extensions = {
  * Object containing meta data regarding an error. It does not necessarily contain all the properties.
  */
 type Meta = {
-  /** A more detailed message explaining the error. */
-  message?: string;
-  /** Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created. */
-  resourceName?: string;
-  /** Full stack trace of the error that was raised. */
+  /** A more detailed message explaining the error. */message?: string; /** Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created. */
+  resourceName?: string; /** Full stack trace of the error that was raised. */
   stack?: string;
 };
 /**
@@ -121,9 +87,7 @@ type GetExtensionsHttpError = {
  * @throws UploadExtensionHttpError
  */
 declare function uploadExtension(body: {
-  /** The extension model. */
-  data?: Extension;
-  /** Extension archive. */
+  /** The extension model. */data?: Extension; /** Extension archive. */
   file?: BodyInit;
 }, options?: ApiCallOptions): Promise<UploadExtensionHttpResponse>;
 type UploadExtensionHttpResponse = {
@@ -178,9 +142,7 @@ type GetExtensionHttpError = {
  * @throws PatchExtensionHttpError
  */
 declare function patchExtension(id: string, body: {
-  /** The extension model. */
-  data?: Extension;
-  /** Extension archive. */
+  /** The extension model. */data?: Extension; /** Extension archive. */
   file?: BodyInit;
 }, options?: ApiCallOptions): Promise<PatchExtensionHttpResponse>;
 type PatchExtensionHttpResponse = {
@@ -201,7 +163,7 @@ type PatchExtensionHttpError = {
  */
 declare function downloadExtension(id: string, options?: ApiCallOptions): Promise<DownloadExtensionHttpResponse>;
 type DownloadExtensionHttpResponse = {
-  data: void;
+  data: DownloadableBlob;
   headers: Headers;
   status: 200;
 };

package/extensions.js

@@ -1,5 +1,5 @@
-import "./chunks/public-runtime-modules-QhLPeQr5.js";
-import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-B7lGscuQ.js";
+import "./chunks/public-runtime-modules-2KfyI2qM.js";
+import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DMAi6Fg3.js";
 
 //#region src/public/rest/extensions.ts
 /**
@@ -125,7 +125,6 @@ const extensionsExport = {
 	downloadFileFromExtension,
 	clearCache
 };
-var extensions_default = extensionsExport;
 
 //#endregion
-export { clearCache, extensions_default as default, deleteExtension, downloadExtension, downloadFileFromExtension, getExtension, getExtensions, patchExtension, uploadExtension };
+export { clearCache, extensionsExport as default, deleteExtension, downloadExtension, downloadFileFromExtension, getExtension, getExtensions, patchExtension, uploadExtension };

package/global-types.d.ts

@@ -1,2 +1,140 @@
-import { v as PerformInteractiveLoginFn } from "./chunks/auth-types-YrlH_R9f.js";
+import { CacheEntry } from "./invoke-fetch-types.js";
+import { t as ProductInfo } from "./chunks/platform-types-CECrZkOF.js";
+
+//#region src/global-types.d.ts
+/** ApiKey Auth Configuration for a HostConfig */
+type ApiKeyAuthConfig = {
+  /** api key created by a developer role on a tenant */apiKey: string;
+};
+/** Cookie Auth Configuration for a HostConfig */
+type CookieAuthConfig = {
+  /** Web Integration Id created by tenant admin */webIntegrationId?: string; /** If set to false the `credentials` property will be set to same-origin  */
+  crossSiteCookies?: boolean; /** Set to true if browser is running in anonymous mode, which is detected if there's a eac token in the url */
+  anonymousMode?: boolean;
+};
+/** WindowsCookie Auth Configuration for a HostConfig */
+type WindowsCookieAuthConfig = {
+  /** location of the login page, auth module will redirect to this page when an unauthenticated api call is made. Not applicable in Node.js environments. */loginUri?: string; /** If set to false the `credentials` property will be set to same-origin. Not applicable in Node.js environments. */
+  crossSiteCookies?: boolean;
+  /**
+   * A custom function that can be used to fetch a windows auth jwt.
+   * The jwt will be exchanged for a session cookie.
+   * In the browser this should typically fetch the jwt from a custom backend service.
+   * Mandatory in Node.js environments.
+   */
+  getAccessToken?: string | (() => Promise<string>);
+};
+type PerformInteractiveLoginFn = (props: {
+  /**
+   * Returns the url to the login page. The redirectUri parameter property is used to tell the login page where to redirect the browser after the login has succeeded.
+   * Note that the redirectUri needs to be registered in the oauth configuration.
+   */
+  getLoginUrl: (props: {
+    redirectUri: string;
+  }) => Promise<string>;
+}) => Promise<{
+  code: string;
+  state: string;
+} | string>;
+/** OAuth2 Auth Configuration for a HostConfig */
+type Oauth2AuthConfig = {
+  /** client id of oauth client created by tenant admin */clientId: string; /** client id of oauth client created by tenant admin */
+  clientSecret?: string; /** location of where the client should be redirected after getting hold of the access token */
+  redirectUri?: string; /** If set, store the access token in either local or session storage, otherwise not stored */
+  accessTokenStorage?: "session" | "local"; /** A string with comma separated values of oauth2 scopes https://oauth.net/2/scope defaults to "user_default" */
+  scope?: string;
+  /**
+   * A custom function that can be used on the client side to fetch an oauth access token from a custom backend.
+   * Typically used in oauth impersonation.
+   */
+  getAccessToken?: string | (() => Promise<string>);
+  /**
+   * If set to true no caching or storing of the access token is done.
+   * This is typically used on the serverside with impersonation so that a client always gets a fresh token.
+   * Caching is in that case handled on the client side.
+   */
+  noCache?: boolean;
+  /**
+   * Can be used on the serverside to impersonate a specific user when authenticating using a client secret.
+   * Typically used together with the `noCache` since caching is done on the browser side.
+   */
+  subject?: string;
+  /**
+   * Can be used on the serverside to impersonate a specific user when authenticating using a client secret.
+   * Typically used together with the `noCache` since caching is done on the browser side.
+   */
+  userId?: string;
+  /**
+   * Can be used to customize the login flow, for instance if the login page should be shown in another browser tab/window.
+   * The function is asynchronous and when the loging flow is finished it should return the code and state provided in the
+   * query of the oauth redirect callback. The code and state can either be provided as an object or as the entire callback url.
+   */
+  performInteractiveLogin?: PerformInteractiveLoginFn;
+};
+/** Anonymous Auth Configuration for a HostConfig - used when embedding UI's linked to an anonymous tenant/app */
+type AnonymousAuthConfig = {
+  /**
+   * Experimental and unsupported
+   */
+  accessCode: string; /** 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.
+   */
+  interface QlikAuthModules {
+    apikey: {
+      config: ApiKeyAuthConfig;
+    };
+    oauth2: {
+      config: Oauth2AuthConfig;
+    };
+    cookie: {
+      config: CookieAuthConfig;
+    };
+    anonymous: {
+      config: AnonymousAuthConfig;
+    };
+    windowscookie: {
+      config: WindowsCookieAuthConfig;
+    };
+    reference: {
+      config: ReferenceConfig;
+    };
+    none: {
+      config: object;
+    };
+    noauth: {
+      config: object;
+    };
+  }
+  /**
+   * Property set on the window when the user is logging out.
+   * This prevents unnecessary redirect calls when pending requests
+   * resolved.
+   */
+  var loggingOut: boolean;
+  /**
+   * Attaching cache to the window so it can be viewed from the devtool.
+   * Do not use this for anything!
+   */
+  var __API_CACHE__DO_NOT_USE_OR_YOU_WILL_BE_FIRED: Record<string, Record<string, CacheEntry> | undefined>;
+  /**
+   * QlikMain object
+   */
+  var QlikMain: {
+    resourceNeedsCredentials: (resourcesUrl: string) => boolean;
+    applyFeatureOverrides: (featureFlags: Record<string, boolean>) => Promise<void>;
+    PRODUCT_INFO?: ProductInfo;
+    REGION?: string;
+    ENVIRONMENT?: string;
+    INTERNAL__DO_NOT_USE: Record<string, unknown>;
+  } | undefined;
+}
+//#endregion
 export { PerformInteractiveLoginFn };