@qlik/api 1.31.0 → 1.33.0

package/interceptors.d.ts

@@ -1,5 +1,12 @@
-import { I as InvokeFetchResponse, a as InvokeFetchProperties } from './invoke-fetch-types-Cq7bjkqn.js';
-import './auth-types-DqfMuSRX.js';
+import { I as InvokeFetchResponse, a as InvokeFetchProperties } from './invoke-fetch-types-BYCD4pc9.js';
+import './auth-types-Cj5bM3Yk.js';
+
+/**
+ * This module provides a way to intercept requests and responses in the qmfe-api.
+ * It allows you to modify the request before it is sent and the response before it is returned.
+ * This is useful for adding headers, modifying the request body, or handling errors.
+ * @module interceptors
+ */
 
 /**
  * The RestInterceptor type is a function that can be used to intercept requests and responses

package/interceptors.js

@@ -5,8 +5,8 @@ import {
   getInterceptors,
   interceptors_default,
   removeInterceptor
-} from "./chunks/3RGGGGAR.js";
-import "./chunks/2ZQ3ZX7F.js";
+} from "./chunks/ZCTVPXGO.js";
+import "./chunks/7MMXU6EL.js";
 export {
   addDefaultInterceptors,
   addInterceptor,

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

@@ -0,0 +1,98 @@
+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 };

package/items.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
-import './auth-types-DqfMuSRX.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-BYCD4pc9.js';
+import './auth-types-Cj5bM3Yk.js';
 
 type CollectionTypes = "private" | "public" | "publicgoverned";
 type ErrorResponseBody = {
@@ -110,6 +110,7 @@ type CollectionsLinksResponseBody = {
 type ItemLinksResponseBody = {
     collections?: Link;
     open?: Link;
+    qvPlugin?: Link;
     self?: Link;
     thumbnail?: Link;
 };
@@ -251,7 +252,7 @@ type SpaceTypeEnum = "shared" | "managed" | "personal" | "data";
  * @param query an object with query parameters
  * @throws GetItemsHttpError
  */
-declare const getItems: (query: {
+declare function getItems(query: {
     /** The collection's unique identifier. Used to filter for items with a specific tag (collection type `public`), or collection. */
     collectionId?: string;
     /** User's unique identifier. */
@@ -295,7 +296,7 @@ declare const getItems: (query: {
     spaceId?: string;
     /** The case-sensitive string used to filter items on space type(s). For example '?spaceType=shared,personal'. */
     spaceType?: SpaceTypeEnum;
-}, options?: ApiCallOptions) => Promise<GetItemsHttpResponse>;
+}, options?: ApiCallOptions): Promise<GetItemsHttpResponse>;
 type GetItemsHttpResponse = {
     data: ItemsListItemsResponseBody;
     headers: Headers;
@@ -313,7 +314,7 @@ type GetItemsHttpError = {
  *
  * @throws GetItemsSettingsHttpError
  */
-declare const getItemsSettings: (options?: ApiCallOptions) => Promise<GetItemsSettingsHttpResponse>;
+declare function getItemsSettings(options?: ApiCallOptions): Promise<GetItemsSettingsHttpResponse>;
 type GetItemsSettingsHttpResponse = {
     data: ItemsSettingsResponseBody;
     headers: Headers;
@@ -330,7 +331,7 @@ type GetItemsSettingsHttpError = {
  * @param body an object with the body content
  * @throws PatchItemsSettingsHttpError
  */
-declare const patchItemsSettings: (body: ItemsSettingsPatch, options?: ApiCallOptions) => Promise<PatchItemsSettingsHttpResponse>;
+declare function patchItemsSettings(body: ItemsSettingsPatch, options?: ApiCallOptions): Promise<PatchItemsSettingsHttpResponse>;
 type PatchItemsSettingsHttpResponse = {
     data: ItemsSettingsResponseBody;
     headers: Headers;
@@ -347,7 +348,7 @@ type PatchItemsSettingsHttpError = {
  * @param itemId The item's unique identifier.
  * @throws DeleteItemHttpError
  */
-declare const deleteItem: (itemId: string, options?: ApiCallOptions) => Promise<DeleteItemHttpResponse>;
+declare function deleteItem(itemId: string, options?: ApiCallOptions): Promise<DeleteItemHttpResponse>;
 type DeleteItemHttpResponse = {
     data: void;
     headers: Headers;
@@ -364,7 +365,7 @@ type DeleteItemHttpError = {
  * @param itemId The item's unique identifier
  * @throws GetItemHttpError
  */
-declare const getItem: (itemId: string, options?: ApiCallOptions) => Promise<GetItemHttpResponse>;
+declare function getItem(itemId: string, options?: ApiCallOptions): Promise<GetItemHttpResponse>;
 type GetItemHttpResponse = {
     data: ItemResultResponseBody;
     headers: Headers;
@@ -382,7 +383,7 @@ type GetItemHttpError = {
  * @param body an object with the body content
  * @throws UpdateItemHttpError
  */
-declare const updateItem: (itemId: string, body: ItemsUpdateItemRequestBody, options?: ApiCallOptions) => Promise<UpdateItemHttpResponse>;
+declare function updateItem(itemId: string, body: ItemsUpdateItemRequestBody, options?: ApiCallOptions): Promise<UpdateItemHttpResponse>;
 type UpdateItemHttpResponse = {
     data: ItemResultResponseBody;
     headers: Headers;
@@ -400,7 +401,7 @@ type UpdateItemHttpError = {
  * @param query an object with query parameters
  * @throws GetItemCollectionsHttpError
  */
-declare const getItemCollections: (itemId: string, query: {
+declare function getItemCollections(itemId: string, query: {
     /** The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive). */
     limit?: number;
     /** The case-sensitive string used to search for a collection by name. */
@@ -415,7 +416,7 @@ declare const getItemCollections: (itemId: string, query: {
     sort?: "+createdAt" | "-createdAt" | "+name" | "-name" | "+updatedAt" | "-updatedAt";
     /** The case-sensitive string used to search for a collection by type. */
     type?: CollectionTypes;
-}, options?: ApiCallOptions) => Promise<GetItemCollectionsHttpResponse>;
+}, options?: ApiCallOptions): Promise<GetItemCollectionsHttpResponse>;
 type GetItemCollectionsHttpResponse = {
     data: ItemsListItemCollectionsResponseBody;
     headers: Headers;
@@ -435,7 +436,7 @@ type GetItemCollectionsHttpError = {
  * @param query an object with query parameters
  * @throws GetPublishedItemsHttpError
  */
-declare const getPublishedItems: (itemId: string, query: {
+declare function getPublishedItems(itemId: string, query: {
     /** The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive). */
     limit?: number;
     /** The cursor to the next page of resources. Provide either the next or prev cursor, but not both. */
@@ -446,7 +447,7 @@ declare const getPublishedItems: (itemId: string, query: {
     resourceType?: ItemResourceTypeEnum;
     /** The property of a resource to sort on (default sort is +createdAt). The supported properties are createdAt, updatedAt, and name. A property must be prefixed by + or   - to indicate ascending or descending sort order respectively. */
     sort?: "+createdAt" | "-createdAt" | "+name" | "-name" | "+updatedAt" | "-updatedAt";
-}, options?: ApiCallOptions) => Promise<GetPublishedItemsHttpResponse>;
+}, options?: ApiCallOptions): Promise<GetPublishedItemsHttpResponse>;
 type GetPublishedItemsHttpResponse = {
     data: ItemsListItemCollectionsResponseBody;
     headers: Headers;

package/items.js

@@ -1,63 +1,79 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/YKZ2QYHN.js";
-import "./chunks/DLKLPD7T.js";
-import "./chunks/2ZQ3ZX7F.js";
+} from "./chunks/LIEZG7IM.js";
+import "./chunks/GPRUNZV4.js";
+import "./chunks/7MMXU6EL.js";
 
 // src/public/rest/items.ts
-var getItems = async (query, options) => invokeFetch("items", {
-  method: "get",
-  pathTemplate: "/api/v1/items",
-  query,
-  options
-});
-var getItemsSettings = async (options) => invokeFetch("items", {
-  method: "get",
-  pathTemplate: "/api/v1/items/settings",
-  options
-});
-var patchItemsSettings = async (body, options) => invokeFetch("items", {
-  method: "patch",
-  pathTemplate: "/api/v1/items/settings",
-  body,
-  contentType: "application/json",
-  options
-});
-var deleteItem = async (itemId, options) => invokeFetch("items", {
-  method: "delete",
-  pathTemplate: "/api/v1/items/{itemId}",
-  pathVariables: { itemId },
-  options
-});
-var getItem = async (itemId, options) => invokeFetch("items", {
-  method: "get",
-  pathTemplate: "/api/v1/items/{itemId}",
-  pathVariables: { itemId },
-  options
-});
-var updateItem = async (itemId, body, options) => invokeFetch("items", {
-  method: "put",
-  pathTemplate: "/api/v1/items/{itemId}",
-  pathVariables: { itemId },
-  body,
-  contentType: "application/json",
-  options
-});
-var getItemCollections = async (itemId, query, options) => invokeFetch("items", {
-  method: "get",
-  pathTemplate: "/api/v1/items/{itemId}/collections",
-  pathVariables: { itemId },
-  query,
-  options
-});
-var getPublishedItems = async (itemId, query, options) => invokeFetch("items", {
-  method: "get",
-  pathTemplate: "/api/v1/items/{itemId}/publisheditems",
-  pathVariables: { itemId },
-  query,
-  options
-});
+async function getItems(query, options) {
+  return invokeFetch("items", {
+    method: "get",
+    pathTemplate: "/api/v1/items",
+    query,
+    options
+  });
+}
+async function getItemsSettings(options) {
+  return invokeFetch("items", {
+    method: "get",
+    pathTemplate: "/api/v1/items/settings",
+    options
+  });
+}
+async function patchItemsSettings(body, options) {
+  return invokeFetch("items", {
+    method: "patch",
+    pathTemplate: "/api/v1/items/settings",
+    body,
+    contentType: "application/json",
+    options
+  });
+}
+async function deleteItem(itemId, options) {
+  return invokeFetch("items", {
+    method: "delete",
+    pathTemplate: "/api/v1/items/{itemId}",
+    pathVariables: { itemId },
+    options
+  });
+}
+async function getItem(itemId, options) {
+  return invokeFetch("items", {
+    method: "get",
+    pathTemplate: "/api/v1/items/{itemId}",
+    pathVariables: { itemId },
+    options
+  });
+}
+async function updateItem(itemId, body, options) {
+  return invokeFetch("items", {
+    method: "put",
+    pathTemplate: "/api/v1/items/{itemId}",
+    pathVariables: { itemId },
+    body,
+    contentType: "application/json",
+    options
+  });
+}
+async function getItemCollections(itemId, query, options) {
+  return invokeFetch("items", {
+    method: "get",
+    pathTemplate: "/api/v1/items/{itemId}/collections",
+    pathVariables: { itemId },
+    query,
+    options
+  });
+}
+async function getPublishedItems(itemId, query, options) {
+  return invokeFetch("items", {
+    method: "get",
+    pathTemplate: "/api/v1/items/{itemId}/publisheditems",
+    pathVariables: { itemId },
+    query,
+    options
+  });
+}
 function clearCache() {
   return clearApiCache("items");
 }