@qlik/api 0.0.9 → 0.0.11

package/chunks/{YDB23Q56.mjs → QJNIUMNI.mjs}

@@ -1,8 +1,9 @@
 import {
+  generateRandomString,
   getRestCallAuthParams,
   getWebSocketAuthParams,
   toValidWebsocketLocationUrl
-} from "./KDW6ZD2R.mjs";
+} from "./MHLTST5J.mjs";
 import "./VSY5YIQY.mjs";
 
 // src/qix/session/enigma-session.ts
@@ -9675,6 +9676,148 @@ var mixin5 = {
   }
 };
 
+// src/qix/session/mixins/doc/create-client-objects.js
+import merge2 from "lodash/merge.js";
+var mixin6 = {
+  types: "Doc",
+  override: {
+    createBookmark(_createBookmark, props) {
+      return _createBookmark(
+        merge2(
+          {},
+          {
+            qInfo: {
+              qType: "bookmark"
+            },
+            qMetaDef: {
+              title: "",
+              description: ""
+            },
+            creationDate: (/* @__PURE__ */ new Date()).toISOString()
+          },
+          props
+        )
+      );
+    },
+    createBookmarkEx(_createBookmarkEx, props, patchObjs) {
+      return _createBookmarkEx(
+        merge2(
+          true,
+          {
+            qInfo: {
+              qType: "bookmark"
+            },
+            qMetaDef: {
+              title: "",
+              description: ""
+            },
+            creationDate: (/* @__PURE__ */ new Date()).toISOString()
+          },
+          props
+        ),
+        patchObjs
+      );
+    }
+  },
+  extend: {
+    /**
+     * Creates a Qlik Sense Sheet
+     * @param {Object} [props] The sheet properties to override
+     * @param {String} [props.title] - The new sheet's title
+     * @param {String} [props.description] - The new sheet's description
+     * @param {String} [props.thumbnail] - URL to a thumbnail image
+     * @param {String} [props.rank] - Sorting rank
+     * @param {Number} [props.rows] - number of grid rows
+     * @param {Number} [props.columns] - number of grid columns
+     * @param {Number} [props.customRowBase] - number of rows for grid resolution
+     * @param {String} [props.gridResolution] - number of grid cells: small|medium|large
+     * @param {Object} [props.layoutOptions] - layout options for the sheet
+     *
+     * @returns {Promise<Object,Error>} A Promise that returns an api to the new sheet if resolved or an Error if rejected
+     */
+    createSheet(props) {
+      return this.createObject({
+        qInfo: {
+          // generating id on client side to support multiple undo create operations
+          // raised an engine bug to solve this, when resolved can be changed
+          // TODO: update the jira id for engine bug once created
+          qId: generateRandomString(43),
+          qType: "sheet"
+        },
+        qMetaDef: {
+          title: props.title || "",
+          description: props.description || ""
+        },
+        rank: typeof props.rank !== "undefined" ? props.rank : -1,
+        thumbnail: { qStaticContentUrlDef: props.thumbnail || null },
+        columns: props.columns || 24,
+        rows: props.rows || 12,
+        cells: [],
+        customRowBase: props.rows || void 0,
+        gridResolution: props.gridResolution || void 0,
+        layoutOptions: props.layoutOptions || void 0,
+        qChildListDef: {
+          qData: {
+            title: "/title"
+          }
+        }
+      });
+    },
+    /**
+     * Creates a Qlik Sense Story
+     * @param {Object} [props] The story properties to override
+     * @param {String} [props.title] - The new story's title
+     * @param {String} [props.description] - The new story's description
+     * @param {String} [props.thumbnail] - URL to a thumbnail image
+     * @param {String} [props.rank] - Sorting rank
+     * @returns {Promise<Object,Error>} A Promise that returns an api to the new story if resolved or an Error if rejected
+     */
+    createStory(props) {
+      return this.createObject({
+        qInfo: {
+          // generating id on client side to support multiple undo create operations
+          // raised an engine bug to solve this, when resolved can be changed
+          qId: util.generateId(),
+          qType: "story"
+        },
+        qMetaDef: {
+          title: props.title || "",
+          description: ""
+        },
+        rank: typeof props.rank !== "undefined" ? props.rank : -1,
+        thumbnail: { qStaticContentUrlDef: props.thumbnail || null },
+        qChildListDef: {
+          qData: {
+            title: "/title",
+            rank: "/rank"
+          }
+        }
+      });
+    },
+    /**
+     * Creates a Qlik Sense Master Object
+     * @param {Object} [props] The properties to override
+     * @param {String} [props.title] - The master object title
+     * @param {String} [props.description] - The master object description
+     * @param {String} [props.tags] - The list of tags
+     * @returns {Promise<Object,Error>} A Promise that returns an api to the new master object if resolved or an Error if rejected
+     */
+    createMasterObject(props) {
+      props = props || {};
+      return this.createObject({
+        qInfo: {
+          qType: "masterobject"
+        },
+        qMetaDef: {
+          title: props.title || "",
+          description: props.description || "",
+          tags: props.tags || ""
+        }
+      });
+    }
+  }
+};
+
 // src/qix/session/mixins/doc/current-selections.ts
 var currentSelectionProps = {
   qInfo: {
@@ -9683,7 +9826,7 @@ var currentSelectionProps = {
   },
   qSelectionObjectDef: {}
 };
-var mixin6 = {
+var mixin7 = {
   types: ["Doc"],
   extend: {
     getCurrentSelectionObject() {
@@ -9710,7 +9853,7 @@ var dimensionListProps = {
     }
   }
 };
-var mixin7 = {
+var mixin8 = {
   types: "Doc",
   extend: {
     getDimensionList() {
@@ -9736,7 +9879,7 @@ var listProps = {
     }
   }
 };
-var mixin8 = {
+var mixin9 = {
   types: "Doc",
   extend: {
     getDynamicAppViewList() {
@@ -9790,7 +9933,7 @@ var onTheFlyWithHiddenListProps = {
     qShowDefinitionOnly: true
   }
 };
-var mixin9 = {
+var mixin10 = {
   types: "Doc",
   extend: {
     getFieldList() {
@@ -9824,7 +9967,7 @@ var masterObjectListProps = {
     }
   }
 };
-var mixin10 = {
+var mixin11 = {
   types: "Doc",
   extend: {
     getMasterObjectList() {
@@ -9851,7 +9994,7 @@ var measureListProps = {
     }
   }
 };
-var mixin11 = {
+var mixin12 = {
   types: "Doc",
   extend: {
     getMeasureList() {
@@ -9877,7 +10020,7 @@ var sheetListProps = {
     }
   }
 };
-var mixin12 = {
+var mixin13 = {
   types: "Doc",
   extend: {
     getODAGAppLinkList() {
@@ -9915,7 +10058,7 @@ var sheetListProps2 = {
     }
   }
 };
-var mixin13 = {
+var mixin14 = {
   types: "Doc",
   extend: {
     /**
@@ -9950,7 +10093,7 @@ var snapshotListProps = {
     }
   }
 };
-var mixin14 = {
+var mixin15 = {
   types: "Doc",
   extend: {
     getSnapshotListObject() {
@@ -9978,7 +10121,7 @@ var storyListProps = {
     }
   }
 };
-var mixin15 = {
+var mixin16 = {
   types: "Doc",
   extend: {
     getStoryList() {
@@ -9999,7 +10142,7 @@ var undoInfoProps = {
   qUndoInfoDef: {},
   markers: []
 };
-var mixin16 = {
+var mixin17 = {
   types: ["Doc"],
   extend: {
     getUndoInfoObject() {
@@ -10024,7 +10167,7 @@ var variableListProps = {
     }
   }
 };
-var mixin17 = {
+var mixin18 = {
   types: "Doc",
   extend: {
     getVariableList() {
@@ -10044,16 +10187,17 @@ var mixins3 = [
   mixin5,
   mixin6,
   mixin7,
-  mixin9,
+  mixin8,
   mixin10,
   mixin11,
   mixin12,
-  mixin8,
   mixin13,
+  mixin9,
   mixin14,
   mixin15,
   mixin16,
-  mixin17
+  mixin17,
+  mixin18
 ];
 
 // src/qix/session/mixins/genericobject/effective-properties.js
@@ -10070,7 +10214,7 @@ function updateQAttribute(properties) {
     });
   }
 }
-var mixin18 = {
+var mixin19 = {
   types: ["GenericObject"],
   override: {
     setProperties(_setProperties, properties) {
@@ -10089,7 +10233,7 @@ var mixin18 = {
 };
 
 // src/qix/session/mixins/genericobject/export-data.js
-var mixin19 = {
+var mixin20 = {
   types: "GenericObject",
   override: {
     /**
@@ -10116,7 +10260,7 @@ var mixin19 = {
 };
 
 // src/qix/session/mixins/genericobject/publishing.js
-var mixin20 = {
+var mixin21 = {
   types: ["GenericObject"],
   override: {
     /**
@@ -10149,7 +10293,7 @@ var mixin20 = {
 };
 
 // src/qix/session/mixins/genericobject/index.ts
-var mixins4 = [mixin19, mixin18, mixin20];
+var mixins4 = [mixin20, mixin19, mixin21];
 
 // src/qix/session/mixins/index.ts
 var mixins5 = [...mixins3, ...mixins, ...mixins4, ...mixins2];

package/chunks/{F7GJTDIU.js → QMOQD6PE.js}

@@ -4,7 +4,7 @@
 
 
 
-var _PQ4OWSWXjs = require('./PQ4OWSWX.js');
+var _FT7SZRB6js = require('./FT7SZRB6.js');
 require('./4HB3TAEO.js');
 
 // src/qix/session/shared-sessions.ts
@@ -36,7 +36,7 @@ async function resumeAll() {
 var initialActions = {};
 var sharedSessions = {};
 function toGlobalAppSessionId({ appId, identity, hostConfig }) {
-  const locationUrl = _PQ4OWSWXjs.toValidWebsocketLocationUrl.call(void 0, hostConfig);
+  const locationUrl = _FT7SZRB6js.toValidWebsocketLocationUrl.call(void 0, hostConfig);
   return identity ? locationUrl + "/" + appId + "/" + identity : locationUrl + "/" + appId;
 }
 async function runPendingInitialActions(initialActionsForApp, sharedSession, doc) {
@@ -83,16 +83,16 @@ function listenForWindowsAuthenticationInformation(session) {
   return authSuggestedInWebsocket;
 }
 async function createAndSetupEnigmaSession(props, canRetry) {
-  const { createEnigmaSession } = await Promise.resolve().then(() => _interopRequireWildcard(require("./AGASWXYW.js")));
+  const { createEnigmaSession } = await Promise.resolve().then(() => _interopRequireWildcard(require("./MQGSH6BQ.js")));
   const session = await createEnigmaSession(props);
   setupSessionListeners(session, props);
   let global;
-  if (await _PQ4OWSWXjs.isWindows.call(void 0, props.hostConfig)) {
+  if (await _FT7SZRB6js.isWindows.call(void 0, props.hostConfig)) {
     const loginInfoPromise = listenForWindowsAuthenticationInformation(session);
     global = await session.open();
     const loginInfo = await loginInfoPromise;
     if (_optionalChain([loginInfo, 'optionalAccess', _ => _.mustAuthenticate])) {
-      const action = await _PQ4OWSWXjs.handleAuthenticationError.call(void 0, {
+      const action = await _FT7SZRB6js.handleAuthenticationError.call(void 0, {
         headers: new Headers(),
         status: 101,
         canRetry,
@@ -389,8 +389,8 @@ async function checkConnectivity(hostConfig) {
     timeoutMs: 2e3,
     noCache: true
   };
-  const fetchRoot = _PQ4OWSWXjs.invokeFetch.call(void 0, "", { method, pathTemplate: "", options }).catch(catchFunc);
-  const fetchMe = _PQ4OWSWXjs.invokeFetch.call(void 0, "", { method, pathTemplate: "/api/v1/users/me", options }).catch(catchFunc);
+  const fetchRoot = _FT7SZRB6js.invokeFetch.call(void 0, "", { method, pathTemplate: "", options }).catch(catchFunc);
+  const fetchMe = _FT7SZRB6js.invokeFetch.call(void 0, "", { method, pathTemplate: "/api/v1/users/me", options }).catch(catchFunc);
   await Promise.all([fetchRoot, fetchMe]);
   return Promise.resolve(status);
 }
@@ -435,7 +435,7 @@ function getOrCreateSharedSession(props) {
 // src/qix/qix-functions.ts
 async function createSessionApp() {
   let sharedSession;
-  if ((await _PQ4OWSWXjs.getPlatform.call(void 0, )).isCloud) {
+  if ((await _FT7SZRB6js.getPlatform.call(void 0, )).isCloud) {
     sharedSession = await getOrCreateSharedSession({ appId: `SessionApp_${Date.now()}` });
   } else {
     sharedSession = await getOrCreateSharedSession({

package/chunks/SPJKF5VW.js

@@ -0,0 +1,17 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+
+
+
+
+var _FT7SZRB6js = require('./FT7SZRB6.js');
+require('./4HB3TAEO.js');
+
+
+
+
+
+
+
+exports.EncodingError = _FT7SZRB6js.EncodingError; exports.InvokeFetchError = _FT7SZRB6js.InvokeFetchError; exports.clearApiCache = _FT7SZRB6js.clearApiCache; exports.default = _FT7SZRB6js.invoke_fetch_default; exports.invokeFetch = _FT7SZRB6js.invokeFetch; exports.parseFetchResponse = _FT7SZRB6js.parseFetchResponse;

package/chunks/{L7DRRU3T.mjs → TPTPAX2U.mjs}

@@ -4,7 +4,7 @@ import {
   invokeFetch,
   isWindows,
   toValidWebsocketLocationUrl
-} from "./KDW6ZD2R.mjs";
+} from "./MHLTST5J.mjs";
 import "./VSY5YIQY.mjs";
 
 // src/qix/session/shared-sessions.ts
@@ -83,7 +83,7 @@ function listenForWindowsAuthenticationInformation(session) {
   return authSuggestedInWebsocket;
 }
 async function createAndSetupEnigmaSession(props, canRetry) {
-  const { createEnigmaSession } = await import("./YDB23Q56.mjs");
+  const { createEnigmaSession } = await import("./QJNIUMNI.mjs");
   const session = await createEnigmaSession(props);
   setupSessionListeners(session, props);
   let global;

package/chunks/X3YDQVZ6.js

@@ -0,0 +1,41 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+var _FT7SZRB6js = require('./FT7SZRB6.js');
+require('./4HB3TAEO.js');
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+exports.AuthorizationError = _FT7SZRB6js.AuthorizationError; exports.InvalidAuthTypeError = _FT7SZRB6js.InvalidAuthTypeError; exports.InvalidHostConfigError = _FT7SZRB6js.InvalidHostConfigError; exports.UnexpectedAuthTypeError = _FT7SZRB6js.UnexpectedAuthTypeError; exports.checkForCrossDomainRequest = _FT7SZRB6js.checkForCrossDomainRequest; exports.default = _FT7SZRB6js.auth_default; exports.getRestCallAuthParams = _FT7SZRB6js.getRestCallAuthParams; exports.getWebResourceAuthParams = _FT7SZRB6js.getWebResourceAuthParams; exports.getWebSocketAuthParams = _FT7SZRB6js.getWebSocketAuthParams; exports.handleAuthenticationError = _FT7SZRB6js.handleAuthenticationError; exports.isHostCrossOrigin = _FT7SZRB6js.isHostCrossOrigin; exports.isWindows = _FT7SZRB6js.isWindows; exports.logout = _FT7SZRB6js.logout; exports.registerAuthModule = _FT7SZRB6js.registerAuthModule; exports.setDefaultHostConfig = _FT7SZRB6js.setDefaultHostConfig; exports.toValidEnigmaLocationUrl = _FT7SZRB6js.toValidEnigmaLocationUrl; exports.toValidLocationUrl = _FT7SZRB6js.toValidLocationUrl; exports.toValidWebsocketLocationUrl = _FT7SZRB6js.toValidWebsocketLocationUrl;

package/chunks/{AULTUQC4.js → XP7ALS4O.js}

@@ -1,10 +1,10 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
-var _W2I5OQA5js = require('./W2I5OQA5.js');
+var _NBNOAZT5js = require('./NBNOAZT5.js');
 
 // src/public/qix.ts
 function openAppSession(appSessionProps) {
-  const appSessionPromise = _W2I5OQA5js.getQixRuntimeModule.call(void 0, appSessionProps.hostConfig).then(
+  const appSessionPromise = _NBNOAZT5js.getQixRuntimeModule.call(void 0, appSessionProps.hostConfig).then(
     (impl) => impl.openAppSession(appSessionProps)
   );
   const appSessionProxy = {

package/collections.d.mts

@@ -22,9 +22,15 @@ type CollectionsCreateCollectionRequestBody = {
     name: string;
     type: CollectionTypes;
 };
+/**
+ * ListCollectionItemsResponseBody result type
+ */
 type CollectionsListCollectionItemsResponseBody = {
     data: ItemResultResponseBody[];
 };
+/**
+ * ListCollectionsResponseBody result type
+ */
 type CollectionsListCollectionsResponseBody = {
     data: CollectionResultResponseBody[];
     links: CollectionsLinksResponseBody;
@@ -52,10 +58,16 @@ type CollectionLinksResponseBody = {
     items?: Link;
     self?: Link;
 };
+/**
+ * Collection metadata and computed fields.
+ */
 type CollectionMetaResponseBody = {
     /** Multiple items. */
     items?: ItemsResultResponseBody;
 };
+/**
+ * A collection.
+ */
 type CollectionResultResponseBody = {
     /** The RFC3339 datetime when the collection was created. */
     createdAt: string;
@@ -92,6 +104,9 @@ type ItemLinksResponseBody = {
     self?: Link;
     thumbnail?: Link;
 };
+/**
+ * Item metadata and computed fields.
+ */
 type ItemMetaResponseBody = {
     /** The actions that the user can perform on the item. */
     actions: string[];
@@ -102,7 +117,13 @@ type ItemMetaResponseBody = {
     /** An array of tags that the item is part of. */
     tags: ItemTagResponseBody[];
 };
+/**
+ * The case-sensitive string defining the item's type.
+ */
 type ItemResourceTypeEnum = "app" | "collection" | "qlikview" | "insight" | "qvapp" | "genericlink" | "sharingservicetask" | "note" | "dataasset" | "dataset" | "automation" | "automl-experiment" | "automl-deployment";
+/**
+ * An item.
+ */
 type ItemResultResponseBody = {
     /** The actions that the user can perform on the item. */
     actions: string[];
@@ -154,6 +175,9 @@ type ItemResultResponseBody = {
     /** ID of the user who last updated the item. This is only populated if the JWT contains a userId. */
     updaterId?: string;
 };
+/**
+ * Holds basic information about a tag or collection.
+ */
 type ItemTagResponseBody = {
     /** The ID of the tag/collection. */
     id: string;
@@ -191,6 +215,9 @@ type ItemsResourceSizeResponseBody = {
     /** Size of the app in memory in bytes. */
     appMemory?: number;
 };
+/**
+ * Multiple items.
+ */
 type ItemsResultResponseBody = {
     data: ItemResultResponseBody[];
     links: ItemsLinksResponseBody;
@@ -381,7 +408,8 @@ declare const getCollectionItems: (collectionId: string, query: {
     resourceLink?: string | undefined;
     /** The case-sensitive string used to search for an item by resourceType. */
     resourceType?: ItemResourceTypeEnum | undefined;
-    /** Whether or not to return items in a shared space. */
+    /** @deprecated
+     * Whether or not to return items in a shared space. */
     shared?: boolean | undefined;
     /** 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?: "-name" | "+name" | "+createdAt" | "-createdAt" | "+updatedAt" | "-updatedAt" | undefined;

package/collections.d.ts

@@ -22,9 +22,15 @@ type CollectionsCreateCollectionRequestBody = {
     name: string;
     type: CollectionTypes;
 };
+/**
+ * ListCollectionItemsResponseBody result type
+ */
 type CollectionsListCollectionItemsResponseBody = {
     data: ItemResultResponseBody[];
 };
+/**
+ * ListCollectionsResponseBody result type
+ */
 type CollectionsListCollectionsResponseBody = {
     data: CollectionResultResponseBody[];
     links: CollectionsLinksResponseBody;
@@ -52,10 +58,16 @@ type CollectionLinksResponseBody = {
     items?: Link;
     self?: Link;
 };
+/**
+ * Collection metadata and computed fields.
+ */
 type CollectionMetaResponseBody = {
     /** Multiple items. */
     items?: ItemsResultResponseBody;
 };
+/**
+ * A collection.
+ */
 type CollectionResultResponseBody = {
     /** The RFC3339 datetime when the collection was created. */
     createdAt: string;
@@ -92,6 +104,9 @@ type ItemLinksResponseBody = {
     self?: Link;
     thumbnail?: Link;
 };
+/**
+ * Item metadata and computed fields.
+ */
 type ItemMetaResponseBody = {
     /** The actions that the user can perform on the item. */
     actions: string[];
@@ -102,7 +117,13 @@ type ItemMetaResponseBody = {
     /** An array of tags that the item is part of. */
     tags: ItemTagResponseBody[];
 };
+/**
+ * The case-sensitive string defining the item's type.
+ */
 type ItemResourceTypeEnum = "app" | "collection" | "qlikview" | "insight" | "qvapp" | "genericlink" | "sharingservicetask" | "note" | "dataasset" | "dataset" | "automation" | "automl-experiment" | "automl-deployment";
+/**
+ * An item.
+ */
 type ItemResultResponseBody = {
     /** The actions that the user can perform on the item. */
     actions: string[];
@@ -154,6 +175,9 @@ type ItemResultResponseBody = {
     /** ID of the user who last updated the item. This is only populated if the JWT contains a userId. */
     updaterId?: string;
 };
+/**
+ * Holds basic information about a tag or collection.
+ */
 type ItemTagResponseBody = {
     /** The ID of the tag/collection. */
     id: string;
@@ -191,6 +215,9 @@ type ItemsResourceSizeResponseBody = {
     /** Size of the app in memory in bytes. */
     appMemory?: number;
 };
+/**
+ * Multiple items.
+ */
 type ItemsResultResponseBody = {
     data: ItemResultResponseBody[];
     links: ItemsLinksResponseBody;
@@ -381,7 +408,8 @@ declare const getCollectionItems: (collectionId: string, query: {
     resourceLink?: string | undefined;
     /** The case-sensitive string used to search for an item by resourceType. */
     resourceType?: ItemResourceTypeEnum | undefined;
-    /** Whether or not to return items in a shared space. */
+    /** @deprecated
+     * Whether or not to return items in a shared space. */
     shared?: boolean | undefined;
     /** 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?: "-name" | "+name" | "+createdAt" | "-createdAt" | "+updatedAt" | "-updatedAt" | undefined;