@qlik/api 1.25.0 → 1.27.0

package/data-files.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
 import './auth-types-PkN9CAF_.js';
 
 type BatchChangeSpaceItem = {
@@ -313,14 +313,14 @@ declare const getDataFiles: (query: {
 type GetDataFilesHttpResponse = {
     data: GetDataFileInfosResponse;
     headers: Headers;
-    status: number;
+    status: 200;
     prev?: (options?: ApiCallOptions) => Promise<GetDataFilesHttpResponse>;
     next?: (options?: ApiCallOptions) => Promise<GetDataFilesHttpResponse>;
 };
 type GetDataFilesHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 403;
 };
 /**
  * Upload a new data file or create a new folder.
@@ -370,12 +370,12 @@ declare const uploadDataFile: (body: {
 type UploadDataFileHttpResponse = {
     data: DataFileUploadResponse;
     headers: Headers;
-    status: number;
+    status: 201;
 };
 type UploadDataFileHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 403 | 409 | 413 | 423 | 501;
 };
 /**
  * This is to allow for a separate admin type of operation that is more global in terms of access in cases
@@ -390,12 +390,12 @@ declare const moveDataFiles: (body: DataFileBatchChangeSpaceRequest, options?: A
 type MoveDataFilesHttpResponse = {
     data: MultiStatusResponse;
     headers: Headers;
-    status: number;
+    status: 207;
 };
 type MoveDataFilesHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400;
 };
 /**
  * Delete the specified set of data files and/or folders as a single batch.
@@ -407,12 +407,12 @@ declare const deleteDataFiles: (body: DataFileBatchDeleteRequest, options?: ApiC
 type DeleteDataFilesHttpResponse = {
     data: MultiStatusResponse;
     headers: Headers;
-    status: number;
+    status: 207;
 };
 type DeleteDataFilesHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400;
 };
 /**
  * The non-filtered list contains a set of hardcoded connections, along with one connection per team space that
@@ -444,14 +444,14 @@ declare const getDataFilesConnections: (query: {
 type GetDataFilesConnectionsHttpResponse = {
     data: GetConnectionsResponse;
     headers: Headers;
-    status: number;
+    status: 200;
     prev?: (options?: ApiCallOptions) => Promise<GetDataFilesConnectionsHttpResponse>;
     next?: (options?: ApiCallOptions) => Promise<GetDataFilesConnectionsHttpResponse>;
 };
 type GetDataFilesConnectionsHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 403;
 };
 /**
  * Get the built-in connection used by the engine to load/write data files given a connection ID.
@@ -463,12 +463,12 @@ declare const getDataFileConnection: (id: string, options?: ApiCallOptions) => P
 type GetDataFileConnectionHttpResponse = {
     data: ConnectionsResponse;
     headers: Headers;
-    status: number;
+    status: 200;
 };
 type GetDataFileConnectionHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 403 | 404;
 };
 /**
  * Get quota information for the calling user.
@@ -479,12 +479,12 @@ declare const getDataFilesQuotas: (options?: ApiCallOptions) => Promise<GetDataF
 type GetDataFilesQuotasHttpResponse = {
     data: QuotaResponse;
     headers: Headers;
-    status: number;
+    status: 200;
 };
 type GetDataFilesQuotasHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 403;
 };
 /**
  * Delete the specified data file or folder.  Deleting a folder will also recursively delete all files and
@@ -497,12 +497,12 @@ declare const deleteDataFile: (id: string, options?: ApiCallOptions) => Promise<
 type DeleteDataFileHttpResponse = {
     data: void;
     headers: Headers;
-    status: number;
+    status: 204;
 };
 type DeleteDataFileHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 403 | 404;
 };
 /**
  * Get descriptive info for the specified data file.
@@ -514,12 +514,12 @@ declare const getDataFile: (id: string, options?: ApiCallOptions) => Promise<Get
 type GetDataFileHttpResponse = {
     data: DataFileUploadResponse;
     headers: Headers;
-    status: number;
+    status: 200;
 };
 type GetDataFileHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 403 | 404;
 };
 /**
  * Re-upload an existing data file or update an existing folder.
@@ -582,12 +582,12 @@ declare const reuploadDataFile: (id: string, body: {
 type ReuploadDataFileHttpResponse = {
     data: DataFileUploadResponse;
     headers: Headers;
-    status: number;
+    status: 201;
 };
 type ReuploadDataFileHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 403 | 404 | 409 | 413 | 423;
 };
 /**
  * This is primarily an admin type of operation.  In general, the owner of a data file or folder is implicitly
@@ -606,12 +606,12 @@ declare const changeDataFileOwner: (id: string, body: ChangeDataFileOwnerRequest
 type ChangeDataFileOwnerHttpResponse = {
     data: void;
     headers: Headers;
-    status: number;
+    status: 204;
 };
 type ChangeDataFileOwnerHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 403 | 404 | 409 | 423;
 };
 /**
  * This is to allow for a separate admin type of operation that is more global in terms of access in cases
@@ -631,12 +631,12 @@ declare const moveDataFile: (id: string, body: ChangeDataFileSpaceRequest, optio
 type MoveDataFileHttpResponse = {
     data: void;
     headers: Headers;
-    status: number;
+    status: 204;
 };
 type MoveDataFileHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 403 | 404 | 409 | 423;
 };
 /**
  * Clears the cache for data-files api requests.

package/data-files.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/UA6BE3VB.js";
-import "./chunks/CZC7KEJN.js";
+} from "./chunks/WY7IOA3Q.js";
+import "./chunks/V3TZ54UE.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/data-files.ts

package/docs/authentication.md

@@ -52,7 +52,7 @@ As an alternative to the methods above it is also possible to create an instance
 Example:
 
 ```ts
-import { createQlikApi } from "@qlik-trial/qmfe-api";
+import { createQlikApi } from "@qlik/api";
 
 const api = createQlikApi({
   authType: "apikey"

package/docs/qix.md

@@ -62,15 +62,36 @@ const sheetlist = await app.getSheetList();
 React example of getting the sheet list from a Qlik Sense app.
 
 ```tsx
+import { type HostConfig } from "@qlik/api/auth";
+import { openAppSession, type Doc } from "@qlik/api/qix";
 import React from "react";
 import usePromise from "react-use-promise";
-import { useAppHook } from "@qlik/api/qix";
-import { setDefaultHostConfig } from "@qlik/api/auth";
 
-setDefaultHostConfig({ ... });
+const hostConfig: HostConfig = {
+  ..., // add host config values here
+};
 
-// send in the react instance (avoid unnecessary dependencies to react in @qlik/api)
-const useApp = useAppHook(React);
+
+/**
+ * Use App Hook
+ */
+function useApp(appId: string): Doc | undefined {
+  const [app, setApp] = React.useState<Doc | undefined>(undefined);
+  React.useEffect(() => {
+    // open a websocket using the specified hostConfig. If `setDefaultHostConfig` has been used,
+    //  passing host config here is not needed here.
+    const appSession = openAppSession({ appId, hostConfig });
+    appSession.getDoc().then((x) => {
+      setApp(x);
+    });
+    return () => {
+      if (appSession) {
+        appSession.close();
+      }
+    };
+  }, [appId]);
+  return app;
+}
 
 type SheetListProps = {
   appId: string;
@@ -79,10 +100,9 @@ type SheetListProps = {
 const SheetList = ({ appId }: SheetListProps): JSX.Element | null => {
   const app = useApp(appId);
 
-  // this could be nicely wrapped in your own local getSheetList hook
+  // this could be nicely wrapped in your own local getSheetList hook similar to the useApp hook above
   const [sheetList] = usePromise(async () => app && app.getSheetList(), [app]);
   // getSheetList above is coming from mixins, fully typed
-
   if (!sheetList) {
     return <div>Loading</div>;
   }
@@ -90,7 +110,7 @@ const SheetList = ({ appId }: SheetListProps): JSX.Element | null => {
     <div>
       <div>Sheets:</div>
       {sheetList.map((item) => (
-        <div key={item.qInfo?.qId}>{item.qData.title}</div>
+        <div key={item.qInfo?.qId}>{item.qData?.title}</div>
       ))}
     </div>
   );

package/extensions.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
+import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
 import './auth-types-PkN9CAF_.js';
 
 /**
@@ -104,7 +104,7 @@ declare const getExtensions: (options?: ApiCallOptions) => Promise<GetExtensions
 type GetExtensionsHttpResponse = {
     data: Extensions;
     headers: Headers;
-    status: number;
+    status: 200;
 };
 type GetExtensionsHttpError = {
     data: unknown;
@@ -126,7 +126,7 @@ declare const uploadExtension: (body: {
 type UploadExtensionHttpResponse = {
     data: Extension;
     headers: Headers;
-    status: number;
+    status: 201;
 };
 type UploadExtensionHttpError = {
     data: Error;
@@ -143,12 +143,12 @@ declare const deleteExtension: (id: string, options?: ApiCallOptions) => Promise
 type DeleteExtensionHttpResponse = {
     data: void;
     headers: Headers;
-    status: number;
+    status: 204;
 };
 type DeleteExtensionHttpError = {
     data: Error;
     headers: Headers;
-    status: number;
+    status: 403 | 404 | 410;
 };
 /**
  * Returns a specific extension matching either extension ID or extension name.
@@ -160,12 +160,12 @@ declare const getExtension: (id: string, options?: ApiCallOptions) => Promise<Ge
 type GetExtensionHttpResponse = {
     data: Extension;
     headers: Headers;
-    status: number;
+    status: 200;
 };
 type GetExtensionHttpError = {
     data: Error;
     headers: Headers;
-    status: number;
+    status: 403 | 404 | 410;
 };
 /**
  * Updates a specific extension matching either extension ID or extension name. Accepts either provided file or data object.
@@ -183,7 +183,7 @@ declare const patchExtension: (id: string, body: {
 type PatchExtensionHttpResponse = {
     data: Extension;
     headers: Headers;
-    status: number;
+    status: 200;
 };
 type PatchExtensionHttpError = {
     data: Error;
@@ -200,12 +200,12 @@ declare const downloadExtension: (id: string, options?: ApiCallOptions) => Promi
 type DownloadExtensionHttpResponse = {
     data: void;
     headers: Headers;
-    status: number;
+    status: 200;
 };
 type DownloadExtensionHttpError = {
     data: Error;
     headers: Headers;
-    status: number;
+    status: 403 | 404 | 410;
 };
 /**
  * Downloads a specific file from the extension matching either extension ID or extension name, identified by the file path within the imported extension.
@@ -218,12 +218,12 @@ declare const downloadFileFromExtension: (id: string, filepath: string, options?
 type DownloadFileFromExtensionHttpResponse = {
     data: void;
     headers: Headers;
-    status: number;
+    status: 200;
 };
 type DownloadFileFromExtensionHttpError = {
     data: Error;
     headers: Headers;
-    status: number;
+    status: 403 | 404 | 410;
 };
 /**
  * Clears the cache for extensions api requests.

package/extensions.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/UA6BE3VB.js";
-import "./chunks/CZC7KEJN.js";
+} from "./chunks/WY7IOA3Q.js";
+import "./chunks/V3TZ54UE.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/extensions.ts