@qlik/api 1.34.0 → 1.36.0

package/auth-types-Cj5bM3Yk.d.ts

@@ -1,127 +0,0 @@
-/** 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 reqeust 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 = {
-    queryParams: Record<string, string>;
-};
-/** Props for function getWebResourceAuthParams */
-type GetWebResourceAuthParamsProps<A extends AuthType = AuthType> = {
-    hostConfig: HostConfig<A>;
-};
-/** Webresource 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 conifg 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 extends keyof QlikAuthModules> = (K extends keyof ImplicitQlikAuthModules ? {
-    authType?: K;
-} : {
-    authType: K;
-}) & QlikAuthModules[K]["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[];
-
-export { type AuthType as A, type Credentials as C, type GetRestCallAuthParamsProps as G, type HostConfig as H, type RestCallAuthParams as R, type WebResourceAuthParams as W, type AuthModule as a, type GetWebSocketAuthParamsProps as b, type WebSocketAuthParams as c, type GetWebResourceAuthParamsProps as d, type GetRemoteAuthDataProps as e, type HandleAuthenticationErrorProps as f, type AuthenticationErrorAction as g, type HostConfigCommon as h, hostConfigCommonProperties as i, type AuthTypeThatCanBeOmitted as j, authTypesThatCanBeOmitted as k };

package/invoke-fetch-types-BYCD4pc9.d.ts

@@ -1,98 +0,0 @@
-import { H as HostConfig } from './auth-types-Cj5bM3Yk.js';
-
-/** The typical base return type of a fetch call */
-type InvokeFetchResponse = {
-    status: number;
-    headers: Headers;
-    data: unknown;
-    prev?: () => Promise<InvokeFetchResponse>;
-    next?: () => Promise<InvokeFetchResponse>;
-};
-/** 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 configif 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"];
-};
-
-export type { ApiCallOptions as A, DownloadableBlob as D, InvokeFetchResponse as I, InvokeFetchProperties as a };