@qlik/api 0.0.14 → 0.0.16

package/data-connections.js

@@ -1,60 +1,60 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
 
-var _TH75GYUYjs = require('./chunks/TH75GYUY.js');
-require('./chunks/SEXEAWEC.js');
+var _URIW2U5Mjs = require('./chunks/URIW2U5M.js');
+require('./chunks/2YWCEGTS.js');
 require('./chunks/4HB3TAEO.js');
 
 // src/public/rest/data-connections.ts
-var getDataConnections = async (query, options) => _TH75GYUYjs.invokeFetch.call(void 0, "data-connections", {
+var getDataConnections = async (query, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "data-connections", {
   method: "get",
   pathTemplate: "/api/v1/data-connections",
   query,
   options
 });
-var createDataConnection = async (body, options) => _TH75GYUYjs.invokeFetch.call(void 0, "data-connections", {
+var createDataConnection = async (body, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "data-connections", {
   method: "post",
   pathTemplate: "/api/v1/data-connections",
   body,
   contentType: "application/json",
   options
 });
-var deleteDataConnections = async (body, options) => _TH75GYUYjs.invokeFetch.call(void 0, "data-connections", {
+var deleteDataConnections = async (body, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "data-connections", {
   method: "post",
   pathTemplate: "/api/v1/data-connections/actions/delete",
   body,
   contentType: "application/json",
   options
 });
-var duplicateDataAConnection = async (body, options) => _TH75GYUYjs.invokeFetch.call(void 0, "data-connections", {
+var duplicateDataAConnection = async (body, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "data-connections", {
   method: "post",
   pathTemplate: "/api/v1/data-connections/actions/duplicate",
   body,
   contentType: "application/json",
   options
 });
-var updateDataConnections = async (body, options) => _TH75GYUYjs.invokeFetch.call(void 0, "data-connections", {
+var updateDataConnections = async (body, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "data-connections", {
   method: "post",
   pathTemplate: "/api/v1/data-connections/actions/update",
   body,
   contentType: "application/json",
   options
 });
-var deleteDataConnection = async (qID, query, options) => _TH75GYUYjs.invokeFetch.call(void 0, "data-connections", {
+var deleteDataConnection = async (qID, query, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "data-connections", {
   method: "delete",
   pathTemplate: "/api/v1/data-connections/{qID}",
   pathVariables: { qID },
   query,
   options
 });
-var getDataConnection = async (qID, query, options) => _TH75GYUYjs.invokeFetch.call(void 0, "data-connections", {
+var getDataConnection = async (qID, query, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "data-connections", {
   method: "get",
   pathTemplate: "/api/v1/data-connections/{qID}",
   pathVariables: { qID },
   query,
   options
 });
-var patchDataConnection = async (qID, query, body, options) => _TH75GYUYjs.invokeFetch.call(void 0, "data-connections", {
+var patchDataConnection = async (qID, query, body, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "data-connections", {
   method: "patch",
   pathTemplate: "/api/v1/data-connections/{qID}",
   pathVariables: { qID },
@@ -63,7 +63,7 @@ var patchDataConnection = async (qID, query, body, options) => _TH75GYUYjs.invok
   contentType: "application/json",
   options
 });
-var updateDataConnection = async (qID, query, body, options) => _TH75GYUYjs.invokeFetch.call(void 0, "data-connections", {
+var updateDataConnection = async (qID, query, body, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "data-connections", {
   method: "put",
   pathTemplate: "/api/v1/data-connections/{qID}",
   pathVariables: { qID },
@@ -73,7 +73,7 @@ var updateDataConnection = async (qID, query, body, options) => _TH75GYUYjs.invo
   options
 });
 function clearCache() {
-  return _TH75GYUYjs.clearApiCache.call(void 0, "data-connections");
+  return _URIW2U5Mjs.clearApiCache.call(void 0, "data-connections");
 }
 var dataConnectionsExport = {
   getDataConnections,

package/data-connections.mjs

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/VCYQUP4Y.mjs";
-import "./chunks/X474LM7J.mjs";
+} from "./chunks/3YV6X7S6.mjs";
+import "./chunks/EHAANYDL.mjs";
 import "./chunks/VSY5YIQY.mjs";
 
 // src/public/rest/data-connections.ts

package/data-credentials.d.mts

@@ -26,11 +26,11 @@ type CredentialCreate = {
     datasourceID?: string;
     /** UUID of the credential */
     qID?: string;
-    /** UName of the credential */
+    /** Name of the credential */
     qName: string;
     /** Password */
     qPassword: string;
-    /** Type of credential */
+    /** Type of credential (i.e. connector provider of the corresponding connection) */
     qType: string;
     /** User name */
     qUsername: string;
@@ -49,6 +49,7 @@ type Errors = Error[];
 type Link = {
     /** Link to cirrent query */
     self: {
+        /** URL pointing to the resource */
         href: string;
     };
 };

package/data-credentials.d.ts

@@ -26,11 +26,11 @@ type CredentialCreate = {
     datasourceID?: string;
     /** UUID of the credential */
     qID?: string;
-    /** UName of the credential */
+    /** Name of the credential */
     qName: string;
     /** Password */
     qPassword: string;
-    /** Type of credential */
+    /** Type of credential (i.e. connector provider of the corresponding connection) */
     qType: string;
     /** User name */
     qUsername: string;
@@ -49,6 +49,7 @@ type Errors = Error[];
 type Link = {
     /** Link to cirrent query */
     self: {
+        /** URL pointing to the resource */
         href: string;
     };
 };

package/data-credentials.js

@@ -1,26 +1,26 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
 
-var _TH75GYUYjs = require('./chunks/TH75GYUY.js');
-require('./chunks/SEXEAWEC.js');
+var _URIW2U5Mjs = require('./chunks/URIW2U5M.js');
+require('./chunks/2YWCEGTS.js');
 require('./chunks/4HB3TAEO.js');
 
 // src/public/rest/data-credentials.ts
-var deleteDataCredential = async (qID, query, options) => _TH75GYUYjs.invokeFetch.call(void 0, "data-credentials", {
+var deleteDataCredential = async (qID, query, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "data-credentials", {
   method: "delete",
   pathTemplate: "/api/v1/data-credentials/{qID}",
   pathVariables: { qID },
   query,
   options
 });
-var getDataCredential = async (qID, query, options) => _TH75GYUYjs.invokeFetch.call(void 0, "data-credentials", {
+var getDataCredential = async (qID, query, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "data-credentials", {
   method: "get",
   pathTemplate: "/api/v1/data-credentials/{qID}",
   pathVariables: { qID },
   query,
   options
 });
-var patchDataCredential = async (qID, query, body, options) => _TH75GYUYjs.invokeFetch.call(void 0, "data-credentials", {
+var patchDataCredential = async (qID, query, body, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "data-credentials", {
   method: "patch",
   pathTemplate: "/api/v1/data-credentials/{qID}",
   pathVariables: { qID },
@@ -29,7 +29,7 @@ var patchDataCredential = async (qID, query, body, options) => _TH75GYUYjs.invok
   contentType: "application/json",
   options
 });
-var updateDataCredential = async (qID, query, body, options) => _TH75GYUYjs.invokeFetch.call(void 0, "data-credentials", {
+var updateDataCredential = async (qID, query, body, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "data-credentials", {
   method: "put",
   pathTemplate: "/api/v1/data-credentials/{qID}",
   pathVariables: { qID },
@@ -39,7 +39,7 @@ var updateDataCredential = async (qID, query, body, options) => _TH75GYUYjs.invo
   options
 });
 function clearCache() {
-  return _TH75GYUYjs.clearApiCache.call(void 0, "data-credentials");
+  return _URIW2U5Mjs.clearApiCache.call(void 0, "data-credentials");
 }
 var dataCredentialsExport = {
   deleteDataCredential,

package/data-credentials.mjs

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/VCYQUP4Y.mjs";
-import "./chunks/X474LM7J.mjs";
+} from "./chunks/3YV6X7S6.mjs";
+import "./chunks/EHAANYDL.mjs";
 import "./chunks/VSY5YIQY.mjs";
 
 // src/public/rest/data-credentials.ts

package/data-files.js

@@ -1,68 +1,68 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
 
-var _TH75GYUYjs = require('./chunks/TH75GYUY.js');
-require('./chunks/SEXEAWEC.js');
+var _URIW2U5Mjs = require('./chunks/URIW2U5M.js');
+require('./chunks/2YWCEGTS.js');
 require('./chunks/4HB3TAEO.js');
 
 // src/public/rest/data-files.ts
-var getDataFiles = async (query, options) => _TH75GYUYjs.invokeFetch.call(void 0, "data-files", {
+var getDataFiles = async (query, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "data-files", {
   method: "get",
   pathTemplate: "/api/v1/data-files",
   query,
   options
 });
-var uploadDataFile = async (body, options) => _TH75GYUYjs.invokeFetch.call(void 0, "data-files", {
+var uploadDataFile = async (body, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "data-files", {
   method: "post",
   pathTemplate: "/api/v1/data-files",
   body,
   contentType: "multipart/form-data",
   options
 });
-var moveDataFiles = async (body, options) => _TH75GYUYjs.invokeFetch.call(void 0, "data-files", {
+var moveDataFiles = async (body, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "data-files", {
   method: "post",
   pathTemplate: "/api/v1/data-files/actions/change-space",
   body,
   contentType: "application/json",
   options
 });
-var deleteDataFiles = async (body, options) => _TH75GYUYjs.invokeFetch.call(void 0, "data-files", {
+var deleteDataFiles = async (body, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "data-files", {
   method: "post",
   pathTemplate: "/api/v1/data-files/actions/delete",
   body,
   contentType: "application/json",
   options
 });
-var getDataFilesConnections = async (query, options) => _TH75GYUYjs.invokeFetch.call(void 0, "data-files", {
+var getDataFilesConnections = async (query, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "data-files", {
   method: "get",
   pathTemplate: "/api/v1/data-files/connections",
   query,
   options
 });
-var getDataFileConnection = async (id, options) => _TH75GYUYjs.invokeFetch.call(void 0, "data-files", {
+var getDataFileConnection = async (id, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "data-files", {
   method: "get",
   pathTemplate: "/api/v1/data-files/connections/{id}",
   pathVariables: { id },
   options
 });
-var getDataFilesQuotas = async (options) => _TH75GYUYjs.invokeFetch.call(void 0, "data-files", {
+var getDataFilesQuotas = async (options) => _URIW2U5Mjs.invokeFetch.call(void 0, "data-files", {
   method: "get",
   pathTemplate: "/api/v1/data-files/quotas",
   options
 });
-var deleteDataFile = async (id, options) => _TH75GYUYjs.invokeFetch.call(void 0, "data-files", {
+var deleteDataFile = async (id, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "data-files", {
   method: "delete",
   pathTemplate: "/api/v1/data-files/{id}",
   pathVariables: { id },
   options
 });
-var getDataFile = async (id, options) => _TH75GYUYjs.invokeFetch.call(void 0, "data-files", {
+var getDataFile = async (id, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "data-files", {
   method: "get",
   pathTemplate: "/api/v1/data-files/{id}",
   pathVariables: { id },
   options
 });
-var reuploadDataFile = async (id, body, options) => _TH75GYUYjs.invokeFetch.call(void 0, "data-files", {
+var reuploadDataFile = async (id, body, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "data-files", {
   method: "put",
   pathTemplate: "/api/v1/data-files/{id}",
   pathVariables: { id },
@@ -70,7 +70,7 @@ var reuploadDataFile = async (id, body, options) => _TH75GYUYjs.invokeFetch.call
   contentType: "multipart/form-data",
   options
 });
-var changeDataFileOwner = async (id, body, options) => _TH75GYUYjs.invokeFetch.call(void 0, "data-files", {
+var changeDataFileOwner = async (id, body, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "data-files", {
   method: "post",
   pathTemplate: "/api/v1/data-files/{id}/actions/change-owner",
   pathVariables: { id },
@@ -78,7 +78,7 @@ var changeDataFileOwner = async (id, body, options) => _TH75GYUYjs.invokeFetch.c
   contentType: "application/json",
   options
 });
-var moveDataFile = async (id, body, options) => _TH75GYUYjs.invokeFetch.call(void 0, "data-files", {
+var moveDataFile = async (id, body, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "data-files", {
   method: "post",
   pathTemplate: "/api/v1/data-files/{id}/actions/change-space",
   pathVariables: { id },
@@ -87,7 +87,7 @@ var moveDataFile = async (id, body, options) => _TH75GYUYjs.invokeFetch.call(voi
   options
 });
 function clearCache() {
-  return _TH75GYUYjs.clearApiCache.call(void 0, "data-files");
+  return _URIW2U5Mjs.clearApiCache.call(void 0, "data-files");
 }
 var dataFilesExport = {
   getDataFiles,

package/data-files.mjs

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/VCYQUP4Y.mjs";
-import "./chunks/X474LM7J.mjs";
+} from "./chunks/3YV6X7S6.mjs";
+import "./chunks/EHAANYDL.mjs";
 import "./chunks/VSY5YIQY.mjs";
 
 // src/public/rest/data-files.ts

package/docs/examples/open-without-data.md

@@ -0,0 +1,40 @@
+# Open app without data
+
+◁ [Back to examples](../examples.md)
+
+This examples shows how to:
+
+- Open an app without data
+
+Sometimes when apps are big they open slowly in qix engine and if you only want to read or write some metadata in the app it's faster to open the app without the data.
+
+```ts
+import { apps, auth, qix } from "@qlik/api";
+
+const hostConfig = {
+  host: "your-tenant.region.qlikcloud.com",
+  authType: "apikey",
+  apiKey: "<api-key>",
+};
+
+auth.setDefaultHostConfig(hostConfig);
+
+async function main() {
+  try {
+    const appId = "<app-id>"; // <- replace this with an appid
+
+    const session = qix.openAppSession({ appId, withoutData: true });
+    const app = await session.getDoc();
+    const appLayout = await app.getLayout();
+    console.log(appLayout);
+  } catch (e) {
+    console.error(e);
+  } finally {
+    session.close();
+  }
+}
+
+await main();
+```
+
+◁ [Back to examples](../examples.md)

package/docs/examples.md

@@ -10,3 +10,4 @@ The code in the examples use ES Module Syntax. It is possible to use CommonJS fo
 - [Show Sheet List in an app](./examples/show-sheet-list.md)
 - [Create an app](./examples/create-app.md)
 - [Create session app](./examples/create-session-app.md)
+- [Open app without data](./examples/open-without-data.md)

package/docs/qix.md

@@ -20,6 +20,23 @@ The `@qlik/api/qix` module gives you a fully typed API to the QIX engine and to
 
 When a session gets a suspend event `@qlik/api` will automatically handle the suspend/resume logic and attempt to re-connect to the same engine session. Hopefully a user will never even notice that the websocket was closed for a little while.
 
+## The App session
+
+An app session in qix means a websocket connected to one app by one user in qix engine.
+
+```js
+qix.openAppSession({ ...appSessionProps });
+```
+
+The app sesssion settings have the following properties.
+
+- `appId` - Required string to open an App
+- `identity` - Optional string to open an individual session to the same app that is different from the default. Useful if different selection states are needed simultaneously.
+- `hostConfig` - Optional Hostconfig to connect to a URL and authenticate an app session. Only needed if default HostConfig has not been set, or if connection should be different from the default.
+- `withoutData` - Optional boolean, set to true if app should be opened without loading the data blob
+
+**_note_** - when using `withoutData: true` and no `identity` the websocket url will include `/identity/no_data` to prevent that engine throws error "App is opened in a different mode".
+
 ## Usage example
 
 ```ts
@@ -28,8 +45,10 @@ import { setDefaultHostConfig } from "@qlik/api/auth";
 
 setDefaultHostConfig({ ... });
 
-// sets up a websocket to engine
-appSession = openAppSession({ appId: "<app-id>" });
+// sets up a session to a Qix Engine App
+appSession = openAppSession({ appId: <app-id>, identity: <empty-or-anystring>, hostConfig: <only-if-different-from-default>, withoutData: <default to false>" });
+// or use the shorthand
+// appSession = openAppSession(<app-id>);
 
 // get the "qix document (qlik app)"
 const app = await appSession.getDoc();

package/extensions.js

@@ -1,36 +1,36 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
 
-var _TH75GYUYjs = require('./chunks/TH75GYUY.js');
-require('./chunks/SEXEAWEC.js');
+var _URIW2U5Mjs = require('./chunks/URIW2U5M.js');
+require('./chunks/2YWCEGTS.js');
 require('./chunks/4HB3TAEO.js');
 
 // src/public/rest/extensions.ts
-var getExtensions = async (options) => _TH75GYUYjs.invokeFetch.call(void 0, "extensions", {
+var getExtensions = async (options) => _URIW2U5Mjs.invokeFetch.call(void 0, "extensions", {
   method: "get",
   pathTemplate: "/api/v1/extensions",
   options
 });
-var uploadExtension = async (body, options) => _TH75GYUYjs.invokeFetch.call(void 0, "extensions", {
+var uploadExtension = async (body, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "extensions", {
   method: "post",
   pathTemplate: "/api/v1/extensions",
   body,
   contentType: "multipart/form-data",
   options
 });
-var deleteExtension = async (id, options) => _TH75GYUYjs.invokeFetch.call(void 0, "extensions", {
+var deleteExtension = async (id, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "extensions", {
   method: "delete",
   pathTemplate: "/api/v1/extensions/{id}",
   pathVariables: { id },
   options
 });
-var getExtension = async (id, options) => _TH75GYUYjs.invokeFetch.call(void 0, "extensions", {
+var getExtension = async (id, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "extensions", {
   method: "get",
   pathTemplate: "/api/v1/extensions/{id}",
   pathVariables: { id },
   options
 });
-var patchExtension = async (id, body, options) => _TH75GYUYjs.invokeFetch.call(void 0, "extensions", {
+var patchExtension = async (id, body, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "extensions", {
   method: "patch",
   pathTemplate: "/api/v1/extensions/{id}",
   pathVariables: { id },
@@ -38,20 +38,20 @@ var patchExtension = async (id, body, options) => _TH75GYUYjs.invokeFetch.call(v
   contentType: "multipart/form-data",
   options
 });
-var downloadExtension = async (id, options) => _TH75GYUYjs.invokeFetch.call(void 0, "extensions", {
+var downloadExtension = async (id, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "extensions", {
   method: "get",
   pathTemplate: "/api/v1/extensions/{id}/file",
   pathVariables: { id },
   options
 });
-var downloadFileFromExtension = async (id, filepath, options) => _TH75GYUYjs.invokeFetch.call(void 0, "extensions", {
+var downloadFileFromExtension = async (id, filepath, options) => _URIW2U5Mjs.invokeFetch.call(void 0, "extensions", {
   method: "get",
   pathTemplate: "/api/v1/extensions/{id}/file/{filepath}",
   pathVariables: { id, filepath },
   options
 });
 function clearCache() {
-  return _TH75GYUYjs.clearApiCache.call(void 0, "extensions");
+  return _URIW2U5Mjs.clearApiCache.call(void 0, "extensions");
 }
 var extensionsExport = {
   getExtensions,

package/extensions.mjs

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/VCYQUP4Y.mjs";
-import "./chunks/X474LM7J.mjs";
+} from "./chunks/3YV6X7S6.mjs";
+import "./chunks/EHAANYDL.mjs";
 import "./chunks/VSY5YIQY.mjs";
 
 // src/public/rest/extensions.ts