@qlik/api 2.3.1 → 2.4.0

package/chunks/auth-types-YrlH_R9f.d.ts

@@ -1,416 +0,0 @@
-//#region src/invoke-fetch/invoke-fetch-types.d.ts
-/** The typical base return type of a fetch call */
-type InvokeFetchResponse = {
-  status: number;
-  headers: Headers;
-  data: unknown;
-  prev?: () => Promise<InvokeFetchResponse>;
-  next?: () => Promise<InvokeFetchResponse>;
-};
-/** An entry in the cache for one specific cacheKey */
-type CacheEntry = {
-  lastPulled: number;
-  /** last time the cache was accessed and prevented an api call */
-  lastHit: Date | null;
-  /** number of times the cache has been hit by a client */
-  hitCount: number;
-  /** the url path of the cache hit. Useful to determine how many different qmfes are accessing the cache key */
-  accessedPaths: Set<string>;
-  value: Promise<unknown>;
-};
-/** Part of the ApiOptions type that includes caching-related properties */
-type CacheOptions = {
-  noCache?: boolean;
-  maxCacheAge?: number;
-  useCacheIfAfter?: Date;
-};
-/** Additional options for an api call done with invoke-fetch */
-type ApiCallOptions = {
-  /** Additional headers to pass on to the request. */
-  headers?: Record<string, string>;
-  /** if set to true the call will not use a cached result */
-  noCache?: boolean;
-  /**
-   * Only used cached results whose age in milliseconds are less than that or equal to `maxCacheAge`.
-   */
-  maxCacheAge?: number | undefined;
-  /**
-   * Only results cached on or after the `ifCachedSince` timestamp are used.
-   */
-  useCacheIfAfter?: Date;
-  /**
-   * Specify the host config if the api call is a cross-domain request. Typically used in embedding and mashups
-   */
-  hostConfig?: HostConfig;
-  /**
-   * 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;
-  /**
-   * Ensure that the request is kept alive even if the page that initiated it is unloaded
-   * before the request is completed.
-   */
-  keepalive?: boolean;
-  /**
-   * Options for progress-reporting. Specify any combination of the callbacks `onUpload`
-   * and `onDownload`. Progress will be reported continuously.
-   */
-  progress?: ProgressOptions;
-};
-type InvokeFetchProperties = {
-  /** http method */
-  method: string;
-  /** data passed to api call */
-  body?: unknown;
-  /** additional api call options */
-  options?: ApiCallOptions;
-  /** override default RequestInit options */
-  requestInitOverrides?: RequestInit;
-  /** path to api endpoint, can be in a template format e.g. /api/v1/space/{spaceId} */
-  pathTemplate: string;
-  /** path variables to be used in the path template */
-  pathVariables?: Record<string, string>;
-  /** additional query to url */
-  query?: Record<string, unknown>;
-  /** specify what content-type to send, if omitted "application/json" is assumed */
-  contentType?: string;
-  /** override the default user-agent with this value. This will also override any browser's UA. */
-  userAgent?: string;
-};
-type DownloadableBlob = Blob & {
-  /** download the blob in a using the specified filename */
-  download: (filename: string) => Promise<void>;
-};
-/** The callback options for reporting progress. */
-type ProgressOptions = {
-  /** upload callback, called repeatedly when upload-progress is available */
-  onUpload?: (event: PartialProgressEvent) => void;
-  /** download callback, called repeatedly when upload-progress is available */
-  onDownload?: (event: PartialProgressEvent) => void;
-};
-/** Represents the current upload or download progress a API-call.
- *
- * It contains the number of loaded bytes and, if computable, the total payload size.
- * If the total size cannot be determined, `total` will be undefined.
- *
- *
- * See MDN: {@link https://developer.mozilla.org/en-US/docs/Web/API/ProgressEvent}
- */
-type PartialProgressEvent = {
-  /** Number of bytes currently loaded. */
-  loaded: ProgressEvent["loaded"];
-  /** The total size of the payload, if computable. */
-  total?: ProgressEvent["total"];
-};
-declare const _default: {};
-//#endregion
-//#region src/platform/platform-types.d.ts
-
-/** Data is accessible on `/resources/autogenerated/product-info.json` on any deployment */
-type ProductInfo = {
-  composition?: {
-    contentHash?: string;
-    senseId: string;
-    releaseLabel?: string;
-    originalClassName?: string;
-    productName?: string;
-    version?: string;
-    copyrightYearRange?: string;
-    deploymentEnvironment?: string;
-    deploymentType?: "qliksenseserver" | "qliksensedesktop" | "QlikSenseMobile" | "qlikcloudservices" | "cloud-console";
-    provider?: string;
-  };
-  externalUrls: {
-    contentHash?: string;
-    originalClassName?: string;
-    personalUpgradeBase: string;
-    cloudUploadUrl: string;
-    serverHelpBaseUrl: string;
-    personalHelpBaseUrl: string;
-    personalUpgradeUrl: string;
-    qlikWebPageUrl: string;
-    cloudBaseUrl: string;
-  };
-};
-//#endregion
-//#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
-//#region src/auth/auth-types.d.ts
-/** Credentials setting for http requests */
-type Credentials = "include" | "same-origin" | "omit";
-/** Props for function getRestCallAuthParams */
-type GetRestCallAuthParamsProps<A extends AuthType = AuthType> = {
-  hostConfig: HostConfig<A>;
-  /** The HTTP method in the outgoing REST call */
-  method: string;
-};
-/** Http request parameters for auth to use when making a rest call based on a host config */
-type RestCallAuthParams = {
-  headers: Record<string, string>;
-  queryParams: Record<string, string>;
-  credentials: Credentials;
-};
-/** Props for function getWebsocketAuthParams */
-type GetWebSocketAuthParamsProps<A extends AuthType = AuthType> = {
-  hostConfig: HostConfig<A>;
-};
-/** Websocket auth parameters to use when setting up a websocket based on a host config */
-type WebSocketAuthParams = {
-  /** Note that headers are only applied in NodeJS environments and NOT in the browser */
-  headers?: Record<string, string>;
-  queryParams?: Record<string, string>;
-};
-/** Props for function getWebResourceAuthParams */
-type GetWebResourceAuthParamsProps<A extends AuthType = AuthType> = {
-  hostConfig: HostConfig<A>;
-};
-/** Web resource auth parameters to use when fetching a web resource with a host config */
-type WebResourceAuthParams = {
-  queryParams: Record<string, string>;
-};
-type GetRemoteAuthDataProps<A extends AuthType = AuthType> = {
-  hostConfig: HostConfig<A>;
-  queryParams?: Record<string, string>;
-};
-/** Props for function handleAuthenticationError */
-type HandleAuthenticationErrorProps<A extends AuthType = AuthType> = {
-  /** host config for connecting to a host */
-  hostConfig: HostConfig<A>;
-  /** HTTP status of the response */
-  status: number;
-  /** Body of the error response */
-  errorBody?: Record<string, unknown>;
-  /** HTTP response headers */
-  headers: Headers;
-  /** Set to true if it is possible to perform a retry. This will be true for the first call, and false if the call is actually a retry */
-  canRetry: boolean;
-};
-/** Action to take when error occurs during authentication */
-type AuthenticationErrorAction = {
-  /**
-   * If set to true the request will be retried and its AuthParams will be fetched again
-   */
-  retry?: boolean;
-  /**
-   * Set to true to prevent the api call result promise from ever resolving.
-   * Typically used when redirecting the window to a login page to prevent
-   * transient errors from happening in the page while the browser is loading the login page.
-   */
-  preventDefault?: boolean;
-};
-/** A typed string array with extracted required properties from a type */
-type RequiredKeys<T> = { [K in keyof T]-?: {} extends Pick<T, K> ? never : K }[keyof T];
-/** A typed string array with extracted optional properties from a type */
-type OptionalKeys<T> = { [K in keyof T]-?: {} extends Pick<T, K> ? K : never }[keyof T];
-/** An authentication module for a specific authentication format, like oauth, cookies etc */
-type AuthModule<A extends AuthType = AuthType> = {
-  /** Properties required for this auth module */
-  requiredProps?: RequiredKeys<HostConfig<A>>[];
-  /** Properties that are optional for this auth module */
-  optionalProps?: OptionalKeys<HostConfig<A>>[];
-  /** Get auth params for rest api calls */
-  getRestCallAuthParams: (props: GetRestCallAuthParamsProps<A>) => Promise<RestCallAuthParams>;
-  /** Get auth params for websocket api calls */
-  getWebSocketAuthParams: (props: GetWebSocketAuthParamsProps<A>) => Promise<WebSocketAuthParams>;
-  /** Get auth params for web resource request */
-  getWebResourceAuthParams?: (props: GetWebResourceAuthParamsProps<A>) => Promise<WebResourceAuthParams>;
-  /** Callback for when auth error happens */
-  handleAuthenticationError: (props: HandleAuthenticationErrorProps<A>) => Promise<AuthenticationErrorAction>;
-  /** Runtime check for validating host config */
-  validateHostConfig?: (hostConfig: Record<string, unknown>) => boolean;
-};
-/** Valid strings for known authentication types */
-type AuthType = keyof QlikAuthModules;
-/** Configuration object for connecting and authenticating with Qlik platform(s) */
-type HostConfig<A extends AuthType = AuthType> = { [K in keyof QlikAuthModules]: QlikAuthModuleConfigUnion<K> & HostConfigCommon }[A];
-type QlikAuthModuleConfigUnion<K$1 extends keyof QlikAuthModules> = (K$1 extends keyof ImplicitQlikAuthModules ? {
-  authType?: K$1;
-} : {
-  authType: K$1;
-}) & QlikAuthModules[K$1]["config"];
-type HostConfigCommon = {
-  /** The URL to the cloud tenant or windows server. If scheme is excluded https is used. May include a virtual proxy prefix on windows. Any trailing slashes are stripped. */
-  host?: string;
-  autoRedirect?: boolean;
-  authRedirectUserConfirmation?: () => Promise<void>;
-  /**
-   * Optional parameter that can be used to point to a Qlik Cloud tenant domain from which the embed runtime should be loaded. If omitted the host parameter will be used.
-   */
-  embedRuntimeUrl?: string;
-  onAuthFailed?: (props: {
-    message: string;
-  }) => unknown;
-};
-/**
- * These properties are always allowed in the host config, even if they are not defined in the HostConfig interface
- * for the specific auth module.
- */
-declare const hostConfigCommonProperties: (keyof HostConfig)[];
-/** The keys in this interface are used to determine what auth types that are allowed to be set to undefined */
-interface ImplicitQlikAuthModules {
-  apikey: object;
-  oauth2: object;
-  cookie: object;
-  windowscookie: object;
-  reference: object;
-  anonymous: object;
-}
-type AuthTypeThatCanBeOmitted = keyof ImplicitQlikAuthModules;
-declare const authTypesThatCanBeOmitted: AuthTypeThatCanBeOmitted[];
-//#endregion
-export { InvokeFetchProperties as C, _default as D, ProgressOptions as E, DownloadableBlob as S, PartialProgressEvent as T, hostConfigCommonProperties as _, Credentials as a, CacheEntry as b, GetWebResourceAuthParamsProps as c, HostConfig as d, HostConfigCommon as f, authTypesThatCanBeOmitted as g, WebSocketAuthParams as h, AuthenticationErrorAction as i, GetWebSocketAuthParamsProps as l, WebResourceAuthParams as m, AuthType as n, GetRemoteAuthDataProps as o, RestCallAuthParams as p, AuthTypeThatCanBeOmitted as r, GetRestCallAuthParamsProps as s, AuthModule as t, HandleAuthenticationErrorProps as u, PerformInteractiveLoginFn as v, InvokeFetchResponse as w, CacheOptions as x, ApiCallOptions as y };

package/chunks/auth-types-h43TVDpB.js

@@ -1,24 +0,0 @@
-//#region src/auth/auth-types.ts
-/**
-* These properties are always allowed in the host config, even if they are not defined in the HostConfig interface
-* for the specific auth module.
-*/
-const hostConfigCommonProperties = [
-	"authType",
-	"autoRedirect",
-	"authRedirectUserConfirmation",
-	"embedRuntimeUrl",
-	"host",
-	"onAuthFailed"
-];
-const authTypesThatCanBeOmitted = [
-	"apikey",
-	"oauth2",
-	"cookie",
-	"windowscookie",
-	"reference",
-	"anonymous"
-];
-
-//#endregion
-export { hostConfigCommonProperties as n, authTypesThatCanBeOmitted as t };

package/chunks/global-types-CEVAJebk.js

@@ -1 +0,0 @@
-export {  };