@qlik/api 1.31.0 → 1.33.0

package/qix.d.ts

@@ -1,7 +1,6 @@
-import { H as HostConfig } from './auth-types-DqfMuSRX.js';
-import './invoke-fetch-types-Cq7bjkqn.js';
+import { H as HostConfig } from './auth-types-Cj5bM3Yk.js';
 
-declare const QIX_SCHEMA_VERSION = "12.2409.0";
+declare const QIX_SCHEMA_VERSION = "12.2459.0";
 type AlfaNumString = {
     /**
      * Calculated value.
@@ -441,6 +440,12 @@ type BookmarkList<QData> = {
      * Information about the list of bookmarks.
      */
     qItems?: NxContainerEntry<QData>[];
+    /**
+     * Hierarchy of groups and bookmarks, below the top level group pointed to by the qGroupId property.
+     *
+     * Stability: *experimental*
+     */
+    qHierarchy?: NxGroupMember[];
 };
 /**
  * Defines the list of bookmarks.
@@ -458,6 +463,12 @@ type BookmarkListDef = {
      * Include the bookmark patches. Patches can be very large and may make the list result unmanageable.
      */
     qIncludePatches?: boolean;
+    /**
+     * ID of separate generic object that holds an NxGroupDef, specifying a grouping and ordering of bookmarks.
+     *
+     * Stability: *experimental*
+     */
+    qGroupId?: string;
 };
 type BookmarkStateFieldPages = {
     /**
@@ -3972,6 +3983,48 @@ type NxGetObjectOptions = {
      */
     qData?: Record<string, string>;
 };
+/**
+ * Defines the properties of an object group.
+ *
+ * Stability: *experimental*
+ */
+type NxGroupDef = {
+    /**
+     * Specifies the class of the group's object members.
+     *
+     * One of:
+     * * bookmark or MEMBER_BOOKMARK
+     * * object or MEMBER_OBJECT
+     */
+    qClass?: NxGroupMemberClass;
+    /**
+     * Specifies the type of the group's object members.
+     */
+    qType?: string;
+    /**
+     * The group's label. Will be evaluated as an expression if it starts with '='.
+     */
+    qLabel?: string;
+    /**
+     * The objects and sub-groups that are members of the group.
+     */
+    qMemberIds?: NxGroupObjectId[];
+};
+type NxGroupMember = {
+    qObjectId?: string;
+};
+type NxGroupMemberClass = "bookmark" | "MEMBER_BOOKMARK" | "object" | "MEMBER_OBJECT";
+/**
+ * Holds the ID of a _NxGroupDef_'s member.
+ * _GroupId_ holds the ID of a sub-group while _ObjectId_ holds the ID of an object.
+ * Only one Id should be set. _GroupId_ takes precedence if both are set.
+ *
+ * Stability: *experimental*
+ */
+type NxGroupObjectId = {
+    qGroupId?: string;
+    qObjectId?: string;
+};
 type NxGroupTail = {
     /**
      * Number of elements that are part of the previous tail.
@@ -8685,6 +8738,21 @@ type NativeDocFunctions<FieldRpcObject, GenericBookmarkRpcObject, GenericDimensi
      * Stability: *locked*
      */
     getObjects: <QData>(options: NxGetObjectOptions) => Promise<NxContainerEntry<QData>[]>;
+    /**
+     * Get or create a generic object at app level with a specific Id and Type.
+     * Id and Type are specified in the GenericObjectProperties passed in.
+     * All other fields in this parameter serve as default properties.
+     * If the object does not exist with that Id, it is created and initialized from the default properties.
+     * If the object already exists, it is not changed. The properties passed in are not used.
+     * The call will fail if the Id is already used for another purpose, such as for an object of a different Type.
+     *
+     * Parameters:
+     *
+     * - `prop`   -   GenericObjectProperties with at least Info : { "qId": "&lt;identifier of the new generic object&gt;", "qType": "&lt;type of the new generic object&gt;" }
+     *
+     * Stability: *experimental*
+     */
+    getOrCreateObject: <CustomProperties = DefaultGenericObjectProperties, CustomGenericObject = GenericObjectRpcObject>(prop: CustomProperties) => Promise<CustomGenericObject>;
     /**
      * Gets values in script.
      *
@@ -9814,6 +9882,21 @@ type NativeGenericObjectFunctions<CustomProperties, CustomLayout, GenericObjectR
      * Stability: *locked*
      */
     acceptListObjectSearch: (path: string, toggleMode: boolean, softLock?: boolean) => Promise<void>;
+    /**
+     * You can use the AddGroupMembers method with any object that contains an object grouping definition.
+     * This method allows you to add one or more members to an existing group of objects directly.
+     *
+     * Parameters:
+     *
+     * - `path`            -   Path to the definition of the object to be selected.
+     * For exampleb _/qNxGroupDef_ .
+     * - `members`         -   Array of IDs for the objects and/or subgroups to add to the group.
+     * - `targetGroupId`   -   Name of the group the Members will be added to (if not the called object).
+     * - `posId`           -   Id of the member whose position to insert into.
+     *
+     * Stability: *experimental*
+     */
+    addGroupMembers: (path: string, members: NxGroupObjectId[], targetGroupId?: string, posId?: string) => Promise<void>;
     /**
      * Applies a patch to the properties of an object. Allows an update to some of the properties.
      * It is possible to apply a patch to the properties of a generic object, that is not persistent. Such a patch is called a soft patch.
@@ -9938,6 +10021,20 @@ type NativeGenericObjectFunctions<CustomProperties, CustomLayout, GenericObjectR
      * Stability: *locked*
      */
     createChild: <CustomChildProperties = GenericObjectProperties, CustomGenericObject = GenericObjectRpcObject>(prop: CustomChildProperties, propForThis?: CustomProperties) => Promise<CustomGenericObject>;
+    /**
+     * You can use the CreateGroup method with any object that contains an object grouping definition.
+     * This method allows you to create a new subgroup of objects directly and add it to a groups members.
+     *
+     * Parameters:
+     *
+     * - `path`            -   Path to the definition of the object to be selected.
+     * For example _/qNxGroupDef_ .
+     * - `groupDef`        -   Definition of the new group.
+     * - `targetGroupId`   -   Id of the group to create the new subgroup in (if not the called object).
+     *
+     * Stability: *experimental*
+     */
+    createGroup: (path: string, groupDef: NxGroupDef, targetGroupId?: string) => Promise<string>;
     /**
      * Removes all children and all children to the children on an object.
      *
@@ -10557,6 +10654,35 @@ type NativeGenericObjectFunctions<CustomProperties, CustomLayout, GenericObjectR
      * Stability: *locked*
      */
     rangeSelectHyperCubeValues: (path: string, ranges: NxRangeSelectInfo[], columnsToSelect?: number[], orMode?: boolean, deselectOnlyOneSelected?: boolean) => Promise<boolean>;
+    /**
+     * You can use the RemoveGroup method with any object that contains an object grouping definition.
+     * This method allows you to remove a group of objects directly.
+     * This action only removes the group, not any of its members.
+     *
+     * Parameters:
+     *
+     * - `path`      -   Path to the definition of the object to be selected.
+     * For example _/qNxGroupDef_ .
+     * - `groupId`   -   Name of the group to be removed.
+     * May not be an empty string.
+     *
+     * Stability: *experimental*
+     */
+    removeGroup: (path: string, groupId: string) => Promise<void>;
+    /**
+     * You can use the RemoveGroupMembers method with any object that contains an object grouping definition.
+     * This method allows you to remove one or more members from an existing group of objects directly.
+     *
+     * Parameters:
+     *
+     * - `path`            -   Path to the definition of the object to be selected.
+     * For example _/qNxGroupDef_ .
+     * - `members`         -   Array of IDs for the objects and/or subgroups to remove from the group.
+     * - `targetGroupId`   -   Name of the group the Members will be removed from (if not the called object).
+     *
+     * Stability: *experimental*
+     */
+    removeGroupMembers: (path: string, members: string[], targetGroupId?: string) => Promise<void>;
     /**
      * Resets all selections made in selection mode.
      *
@@ -10836,6 +10962,21 @@ type NativeGenericObjectFunctions<CustomProperties, CustomLayout, GenericObjectR
      * Stability: *locked*
      */
     setFullPropertyTree: (propEntry: GenericObjectEntry) => Promise<void>;
+    /**
+     * You can use the SetGroupLabel method with any object that contains an object grouping definition.
+     * This method allows you to change the label of an existing group of objects directly.
+     *
+     * Parameters:
+     *
+     * - `path`            -   Path to the definition of the object to be selected.
+     * For example _/qNxGroupDef_ .
+     * - `newLabel`        -   New label for the group.
+     * A label starting with an '=' will be evaluated as an expression.
+     * - `targetGroupId`   -   Id of the group whose label will be set (if not the called object).
+     *
+     * Stability: *experimental*
+     */
+    setGroupLabel: (path: string, newLabel: string, targetGroupId?: string) => Promise<void>;
     /**
      * Sets some properties for a generic object.
      * <div class=note>The properties depends on the generic object type, see [properties](genericobject-property.html).</div>
@@ -12242,4 +12383,4 @@ declare const qix: QixAPI & {
     withHostConfig: (hostConfig: HostConfig | undefined) => QixAPI;
 };
 
-export { type AlfaNumString, type AlternateStateData, type AnyGenericObjectLayout, type AnyGenericObjectProperties, type AppEntry, type AppObjectList, type AppObjectListDef, type AppScript, type AppScriptMeta, type AppSession, type ApplyGroupStateWarning, type ApplyGroupStateWarningType, type ApplyGroupStatesResult, type ArrayOfNxValuePoint, type AssociationScore, type BNFDef, type BNFDefMetaType, type BNFType, type Blob, type Bookmark, type BookmarkApplyAndVerifyResult, type BookmarkFieldItem, type BookmarkFieldPage, type BookmarkFieldPageEx, type BookmarkFieldVerifyResultState, type BookmarkFieldVerifyWarning, type BookmarkList, type BookmarkListData, type BookmarkListDef, type BookmarkListItem, type BookmarkStateFieldPages, type BookmarkVariableItem, type CalendarStrings, type CharEncodingType, type CharRange, type ChildList, type ChildListDef, type CloseProps, type CodePage, type CombinedWebSocketStateEvent, type CondDef, type Connection, type ContentLibraryList, type ContentLibraryListItem, type CurrentSelections, type CustomConnector, type CyclicGroupPosition, type DataField, type DataRecord, type DataTable, type DataTableEx, type Database, type DatabaseInfo, type DatabaseOwner, type DelimiterInfo, type DerivedFieldsInTableData, type DimensionList, type DimensionListData, type DimensionListDef, type DimensionListItem, type DimensionReference, type DoReloadExParams, type DoReloadExResult, type Doc, type DocAction, type DocListEntry, type DriveInfo, type DriveType, type DynamicAppViewListData, type DynamicAppViewListItem, type EditorBreakpoint, type EmbeddedSnapshot, type EmbeddedSnapshotDef, type ErrorData, type ErrorDataCode, type ExpandedFieldListItem, type ExpansionData, type ExtendedLayoutBookmarkData, type ExtendedPivotStateData, type ExtensionList, type ExtensionListDef, type FailureData, type Field, type FieldAttrType, type FieldAttributes, type FieldDefEx, type FieldDescription, type FieldInTableData, type FieldInTableProfilingData, type FieldList, type FieldListDef, type FieldListObject, type FieldOrColumn, type FieldScores, type FieldType, type FieldValue, type FileDataFormat, type FileType, type FilterInfo, type FilterType, type FolderItem, type FolderItemType, type FrequencyDistributionData, type FunctionGroup, type GenericBookmark, type GenericBookmarkEntry, type GenericBookmarkLayout, type GenericBookmarkProperties, type GenericConnectMachine, type GenericDimension, type GenericDimensionInfo, type GenericDimensionLayout, type GenericDimensionProperties, type GenericListObject, type GenericMeasure, type GenericMeasureLayout, type GenericMeasureProperties, type GenericObject, type GenericObjectEntry, type GenericObjectLayout, type GenericObjectLayoutAdditionalProperties, type GenericObjectLayoutNode, type GenericObjectLayoutNodeLevel2, type GenericObjectLayoutNodeLevel3, type GenericObjectLayoutNodeLevel4, type GenericObjectLayoutNodeLevel5, type GenericObjectLayoutNodeRec, type GenericObjectProperties, type GenericObjectPropertiesAdditionalProperties, type GenericObjectPropertiesNode, type GenericObjectPropertiesNodeLevel2, type GenericObjectPropertiesNodeLevel3, type GenericObjectPropertiesNodeLevel4, type GenericObjectPropertiesNodeLevel5, type GenericObjectPropertiesNodeRec, type GenericVariable, type GenericVariableConstraints, type GenericVariableLayout, type GenericVariableProperties, type GenericVariableType, type Global, type GraphMode, type GroupBookmarkData, type GroupState, type GroupStateInfo, type HyperCube, type HyperCubeDef, type InputFieldItem, type InterFieldSortData, type InteractDef, type InteractType, type KeyType, type LayoutBookmarkData, type LayoutExclude, type LayoutFieldInfo, type LineageInfo, type ListBoxProperties, type ListFunctions, type ListItem, type ListObject, type ListObjectDef, type LocaleInfo, type LogOnType, type MasterObjectListData, type MasterObjectListItem, type MeasureList, type MeasureListData, type MeasureListDef, type MeasureListItem, type MediaListDef, type MediaListItem, type MetaData, type ModalFunctions, type NativeDocFunctions, type NativeFieldFunctions, type NativeGenericBookmarkFunctions, type NativeGenericDimensionFunctions, type NativeGenericMeasureFunctions, type NativeGenericObjectFunctions, type NativeGenericVariableFunctions, type NativeGlobalFunctions, type NativeReactHooks, type NativeVariableFunctions, type NxAppLayout, type NxAppProperties, type NxAttrDimDef, type NxAttrDimInfo, type NxAttrExprDef, type NxAttrExprInfo, type NxAttributeDimValues, type NxAttributeExpressionValues, type NxAutoSortByStateDef, type NxAxisData, type NxAxisTicks, type NxBookmark, type NxCalcCond, type NxCardinalities, type NxCell, type NxCellPosition, type NxCellRows, type NxContainerEntry, type NxContinuousDataOptions, type NxContinuousMode, type NxContinuousRangeSelectInfo, type NxCurrentSelectionItem, type NxDataAreaPage, type NxDataPage, type NxDataReductionMode, type NxDerivedField, type NxDerivedFieldDescriptionList, type NxDerivedFieldsData, type NxDerivedGroup, type NxDimCellType, type NxDimension, type NxDimensionInfo, type NxDimensionType, type NxDownloadInfo, type NxDownloadOptions, type NxEngineVersion, type NxExportFileType, type NxExportState, type NxFeature, type NxFieldDescription, type NxFieldProperties, type NxFieldResourceId, type NxFieldSelectionInfo, type NxFieldSelectionMode, type NxFieldTableResourceId, type NxFrequencyMode, type NxGetBookmarkOptions, type NxGetObjectOptions, type NxGroupTail, type NxGrpType, type NxHighlightRanges, type NxHypercubeMode, type NxInfo, type NxInlineDimensionDef, type NxInlineMeasureDef, type NxLTrendlineType, type NxLayoutErrors, type NxLibraryDimension, type NxLibraryDimensionDef, type NxLibraryMeasure, type NxLibraryMeasureDef, type NxLinkedObjectInfo, type NxListObjectExpression, type NxListObjectExpressionDef, type NxLocalizedErrorCode, type NxLocalizedWarningCode, type NxMatchingFieldInfo, type NxMatchingFieldMode, type NxMeasure, type NxMeasureInfo, type NxMeta, type NxMetaDef, type NxMiniChart, type NxMiniChartCell, type NxMiniChartData, type NxMiniChartDef, type NxMiniChartRows, type NxMultiRangeSelectInfo, type NxPage, type NxPageTreeLevel, type NxPageTreeNode, type NxPatch, type NxPatchOperationType, type NxPatches, type NxPivotDimensionCell, type NxPivotPage, type NxPivotValuePoint, type NxRange, type NxRangeSelectInfo, type NxSelectionCell, type NxSelectionCellType, type NxSelectionInfo, type NxSimpleDimValue, type NxSimpleValue, type NxSortIndicatorType, type NxStackPage, type NxStackedPivotCell, type NxStateCounts, type NxStreamListEntry, type NxTempBookmarkOptions, type NxTickCell, type NxTreeDataOption, type NxTreeDimensionDef, type NxTreeDimensionInfo, type NxTreeMultiRangeSelectInfo, type NxTreeNode, type NxTreeRangeSelectInfo, type NxTreeValue, type NxTrendline, type NxTrendlineDef, type NxTrendlineMode, type NxValidationError, type NxVariableListItem, type NxVariableProperties, type NxViewPort, type ODAGAppLinkListData, type ODAGAppLinkListItem, type ObjectHelperFunctions, type ObjectInterface, type OdbcDsn, type OleDbProvider, type OpenAppSessionProps, type OtherLimitMode, type OtherMode, type OtherSortMode, type OtherTotalSpecProp, type Point, type PositionMark, type ProgressData, type ProgressMessage, type QFunction, QIX_SCHEMA_VERSION, type QMediaList, type QRange, type QixAPI, type RangeSelectInfo, type Rect, type ReloadError, type RpcObject, type SampleResult, type ScriptSyntaxError, type ScrollPosition, type SearchAssociationResult, type SearchAttribute, type SearchCharRange, type SearchCombinationOptions, type SearchContextType, type SearchFieldDictionary, type SearchFieldMatch, type SearchFieldMatchType, type SearchFieldMatchesItem, type SearchFieldSelectionMode, type SearchFieldValueItem, type SearchGroup, type SearchGroupItem, type SearchGroupItemMatch, type SearchGroupItemOptions, type SearchGroupItemType, type SearchGroupOptions, type SearchGroupType, type SearchMatchCombination, type SearchMatchCombinations, type SearchObjectOptions, type SearchPage, type SearchResult, type SearchSuggestItem, type SearchSuggestionResult, type SearchTermResult, type SearchValueOptions, type SearchValuePage, type SearchValueResult, type SelectInfo, type SelectionObject, type SelectionObjectDef, type SheetListData, type SheetListDataCell, type SheetListDataCellBounds, type SheetListItem, type Size, type SortCriteria, type SourceKeyRecord, type SpecialObjectFunctions, type StandardFunctions, type StateEnumType, type StateFieldValues, type StaticContentList, type StaticContentListItem, type StaticContentUrl, type StaticContentUrlDef, type StoryListData, type StoryListItem, type StringExpr, type StringExpression, type SymbolFrequency, type SymbolValue, type TableProfilingData, type TableRecord, type TableRow, type TableViewBroomPointSaveInfo, type TableViewConnectionPointSaveInfo, type TableViewCtlSaveInfo, type TableViewDlgSaveInfo, type TableViewSaveInfo, type TableViewTableWinSaveInfo, type TextMacro, type TotalMode, type TransformAppParameters, type TransformAppResult, type TreeData, type TreeDataDef, type UndoInfo, type UndoInfoDef, type UndoInfoObject, type UsageEnum, type UseAppHook, type ValueExpr, type ValueExpression, type VariableList, type VariableListData, type VariableListDef, type VariableListItem, type WebSocketEvent, type WorkloadType, qix as default, openAppSession, withHostConfig };
+export { type AlfaNumString, type AlternateStateData, type AnyGenericObjectLayout, type AnyGenericObjectProperties, type AppEntry, type AppObjectList, type AppObjectListDef, type AppScript, type AppScriptMeta, type AppSession, type ApplyGroupStateWarning, type ApplyGroupStateWarningType, type ApplyGroupStatesResult, type ArrayOfNxValuePoint, type AssociationScore, type BNFDef, type BNFDefMetaType, type BNFType, type Blob, type Bookmark, type BookmarkApplyAndVerifyResult, type BookmarkFieldItem, type BookmarkFieldPage, type BookmarkFieldPageEx, type BookmarkFieldVerifyResultState, type BookmarkFieldVerifyWarning, type BookmarkList, type BookmarkListData, type BookmarkListDef, type BookmarkListItem, type BookmarkStateFieldPages, type BookmarkVariableItem, type CalendarStrings, type CharEncodingType, type CharRange, type ChildList, type ChildListDef, type CloseProps, type CodePage, type CombinedWebSocketStateEvent, type CondDef, type Connection, type ContentLibraryList, type ContentLibraryListItem, type CurrentSelections, type CustomConnector, type CyclicGroupPosition, type DataField, type DataRecord, type DataTable, type DataTableEx, type Database, type DatabaseInfo, type DatabaseOwner, type DelimiterInfo, type DerivedFieldsInTableData, type DimensionList, type DimensionListData, type DimensionListDef, type DimensionListItem, type DimensionReference, type DoReloadExParams, type DoReloadExResult, type Doc, type DocAction, type DocListEntry, type DriveInfo, type DriveType, type DynamicAppViewListData, type DynamicAppViewListItem, type EditorBreakpoint, type EmbeddedSnapshot, type EmbeddedSnapshotDef, type ErrorData, type ErrorDataCode, type ExpandedFieldListItem, type ExpansionData, type ExtendedLayoutBookmarkData, type ExtendedPivotStateData, type ExtensionList, type ExtensionListDef, type FailureData, type Field, type FieldAttrType, type FieldAttributes, type FieldDefEx, type FieldDescription, type FieldInTableData, type FieldInTableProfilingData, type FieldList, type FieldListDef, type FieldListObject, type FieldOrColumn, type FieldScores, type FieldType, type FieldValue, type FileDataFormat, type FileType, type FilterInfo, type FilterType, type FolderItem, type FolderItemType, type FrequencyDistributionData, type FunctionGroup, type GenericBookmark, type GenericBookmarkEntry, type GenericBookmarkLayout, type GenericBookmarkProperties, type GenericConnectMachine, type GenericDimension, type GenericDimensionInfo, type GenericDimensionLayout, type GenericDimensionProperties, type GenericListObject, type GenericMeasure, type GenericMeasureLayout, type GenericMeasureProperties, type GenericObject, type GenericObjectEntry, type GenericObjectLayout, type GenericObjectLayoutAdditionalProperties, type GenericObjectLayoutNode, type GenericObjectLayoutNodeLevel2, type GenericObjectLayoutNodeLevel3, type GenericObjectLayoutNodeLevel4, type GenericObjectLayoutNodeLevel5, type GenericObjectLayoutNodeRec, type GenericObjectProperties, type GenericObjectPropertiesAdditionalProperties, type GenericObjectPropertiesNode, type GenericObjectPropertiesNodeLevel2, type GenericObjectPropertiesNodeLevel3, type GenericObjectPropertiesNodeLevel4, type GenericObjectPropertiesNodeLevel5, type GenericObjectPropertiesNodeRec, type GenericVariable, type GenericVariableConstraints, type GenericVariableLayout, type GenericVariableProperties, type GenericVariableType, type Global, type GraphMode, type GroupBookmarkData, type GroupState, type GroupStateInfo, type HyperCube, type HyperCubeDef, type InputFieldItem, type InterFieldSortData, type InteractDef, type InteractType, type KeyType, type LayoutBookmarkData, type LayoutExclude, type LayoutFieldInfo, type LineageInfo, type ListBoxProperties, type ListFunctions, type ListItem, type ListObject, type ListObjectDef, type LocaleInfo, type LogOnType, type MasterObjectListData, type MasterObjectListItem, type MeasureList, type MeasureListData, type MeasureListDef, type MeasureListItem, type MediaListDef, type MediaListItem, type MetaData, type ModalFunctions, type NativeDocFunctions, type NativeFieldFunctions, type NativeGenericBookmarkFunctions, type NativeGenericDimensionFunctions, type NativeGenericMeasureFunctions, type NativeGenericObjectFunctions, type NativeGenericVariableFunctions, type NativeGlobalFunctions, type NativeReactHooks, type NativeVariableFunctions, type NxAppLayout, type NxAppProperties, type NxAttrDimDef, type NxAttrDimInfo, type NxAttrExprDef, type NxAttrExprInfo, type NxAttributeDimValues, type NxAttributeExpressionValues, type NxAutoSortByStateDef, type NxAxisData, type NxAxisTicks, type NxBookmark, type NxCalcCond, type NxCardinalities, type NxCell, type NxCellPosition, type NxCellRows, type NxContainerEntry, type NxContinuousDataOptions, type NxContinuousMode, type NxContinuousRangeSelectInfo, type NxCurrentSelectionItem, type NxDataAreaPage, type NxDataPage, type NxDataReductionMode, type NxDerivedField, type NxDerivedFieldDescriptionList, type NxDerivedFieldsData, type NxDerivedGroup, type NxDimCellType, type NxDimension, type NxDimensionInfo, type NxDimensionType, type NxDownloadInfo, type NxDownloadOptions, type NxEngineVersion, type NxExportFileType, type NxExportState, type NxFeature, type NxFieldDescription, type NxFieldProperties, type NxFieldResourceId, type NxFieldSelectionInfo, type NxFieldSelectionMode, type NxFieldTableResourceId, type NxFrequencyMode, type NxGetBookmarkOptions, type NxGetObjectOptions, type NxGroupDef, type NxGroupMember, type NxGroupMemberClass, type NxGroupObjectId, type NxGroupTail, type NxGrpType, type NxHighlightRanges, type NxHypercubeMode, type NxInfo, type NxInlineDimensionDef, type NxInlineMeasureDef, type NxLTrendlineType, type NxLayoutErrors, type NxLibraryDimension, type NxLibraryDimensionDef, type NxLibraryMeasure, type NxLibraryMeasureDef, type NxLinkedObjectInfo, type NxListObjectExpression, type NxListObjectExpressionDef, type NxLocalizedErrorCode, type NxLocalizedWarningCode, type NxMatchingFieldInfo, type NxMatchingFieldMode, type NxMeasure, type NxMeasureInfo, type NxMeta, type NxMetaDef, type NxMiniChart, type NxMiniChartCell, type NxMiniChartData, type NxMiniChartDef, type NxMiniChartRows, type NxMultiRangeSelectInfo, type NxPage, type NxPageTreeLevel, type NxPageTreeNode, type NxPatch, type NxPatchOperationType, type NxPatches, type NxPivotDimensionCell, type NxPivotPage, type NxPivotValuePoint, type NxRange, type NxRangeSelectInfo, type NxSelectionCell, type NxSelectionCellType, type NxSelectionInfo, type NxSimpleDimValue, type NxSimpleValue, type NxSortIndicatorType, type NxStackPage, type NxStackedPivotCell, type NxStateCounts, type NxStreamListEntry, type NxTempBookmarkOptions, type NxTickCell, type NxTreeDataOption, type NxTreeDimensionDef, type NxTreeDimensionInfo, type NxTreeMultiRangeSelectInfo, type NxTreeNode, type NxTreeRangeSelectInfo, type NxTreeValue, type NxTrendline, type NxTrendlineDef, type NxTrendlineMode, type NxValidationError, type NxVariableListItem, type NxVariableProperties, type NxViewPort, type ODAGAppLinkListData, type ODAGAppLinkListItem, type ObjectHelperFunctions, type ObjectInterface, type OdbcDsn, type OleDbProvider, type OpenAppSessionProps, type OtherLimitMode, type OtherMode, type OtherSortMode, type OtherTotalSpecProp, type Point, type PositionMark, type ProgressData, type ProgressMessage, type QFunction, QIX_SCHEMA_VERSION, type QMediaList, type QRange, type QixAPI, type RangeSelectInfo, type Rect, type ReloadError, type RpcObject, type SampleResult, type ScriptSyntaxError, type ScrollPosition, type SearchAssociationResult, type SearchAttribute, type SearchCharRange, type SearchCombinationOptions, type SearchContextType, type SearchFieldDictionary, type SearchFieldMatch, type SearchFieldMatchType, type SearchFieldMatchesItem, type SearchFieldSelectionMode, type SearchFieldValueItem, type SearchGroup, type SearchGroupItem, type SearchGroupItemMatch, type SearchGroupItemOptions, type SearchGroupItemType, type SearchGroupOptions, type SearchGroupType, type SearchMatchCombination, type SearchMatchCombinations, type SearchObjectOptions, type SearchPage, type SearchResult, type SearchSuggestItem, type SearchSuggestionResult, type SearchTermResult, type SearchValueOptions, type SearchValuePage, type SearchValueResult, type SelectInfo, type SelectionObject, type SelectionObjectDef, type SheetListData, type SheetListDataCell, type SheetListDataCellBounds, type SheetListItem, type Size, type SortCriteria, type SourceKeyRecord, type SpecialObjectFunctions, type StandardFunctions, type StateEnumType, type StateFieldValues, type StaticContentList, type StaticContentListItem, type StaticContentUrl, type StaticContentUrlDef, type StoryListData, type StoryListItem, type StringExpr, type StringExpression, type SymbolFrequency, type SymbolValue, type TableProfilingData, type TableRecord, type TableRow, type TableViewBroomPointSaveInfo, type TableViewConnectionPointSaveInfo, type TableViewCtlSaveInfo, type TableViewDlgSaveInfo, type TableViewSaveInfo, type TableViewTableWinSaveInfo, type TextMacro, type TotalMode, type TransformAppParameters, type TransformAppResult, type TreeData, type TreeDataDef, type UndoInfo, type UndoInfoDef, type UndoInfoObject, type UsageEnum, type UseAppHook, type ValueExpr, type ValueExpression, type VariableList, type VariableListData, type VariableListDef, type VariableListItem, type WebSocketEvent, type WorkloadType, qix as default, openAppSession, withHostConfig };

package/qix.js

@@ -2,8 +2,8 @@ import {
   openAppSession,
   qix_default,
   withHostConfig
-} from "./chunks/KBSD75QL.js";
-import "./chunks/DLKLPD7T.js";
+} from "./chunks/33GQY7N7.js";
+import "./chunks/GPRUNZV4.js";
 export {
   qix_default as default,
   openAppSession,

package/questions.d.ts

@@ -0,0 +1,364 @@
+import { A as ApiCallOptions } from './invoke-fetch-types-BYCD4pc9.js';
+import './auth-types-Cj5bM3Yk.js';
+
+type Analysis = "breakdown" | "changePoint" | "comparison" | "contribution" | "correlation" | "fact" | "mutualInfo" | "rank" | "spike" | "trend" | "values";
+type AnalysisGroup = "anomaly" | "brekadown" | "comparison" | "correl" | "fact" | "list" | "mutualInfo" | "rank";
+/**
+ * Metadata for app
+ */
+type AppMetadata = {
+    id?: string;
+    last_reload_date?: string;
+    limited_access?: boolean;
+    name?: string;
+    space_id?: string;
+    space_name?: string;
+    space_type?: string;
+};
+/**
+ * Chart type given to current recommendation
+ */
+type ChartType = "barchart" | "combochart" | "distributionplot" | "kpi" | "linechart" | "map" | "scatterplot" | "table";
+type ConversationalResponsePart = {
+    errorMessage?: string;
+    followupSentence?: string;
+    imageUrl?: string;
+    infoType?: string;
+    infoValues?: (string[] | QlikApp[])[];
+    narrative?: NarrativeResponse;
+    renderVisualization?: RenderVisualization;
+    sentence?: {
+        text?: string;
+    };
+    type?: string;
+};
+/**
+ * An error object.
+ */
+type Error = {
+    /** The error code. */
+    code: string;
+    /** A human-readable explanation specific to this occurrence of the problem. */
+    detail?: string;
+    /** Additional properties relating to the error. */
+    meta?: unknown;
+    /** References to the source of the error. */
+    source?: {
+        /** The URI query parameter that caused the error. */
+        parameter?: string;
+        /** A JSON Pointer to the property that caused the error. */
+        pointer?: string;
+    };
+    /** Summary of the problem. */
+    title: string;
+};
+type Errors = {
+    errors?: Error[];
+};
+type Href = {
+    href?: string;
+};
+type Links = {
+    next?: Href;
+    prev?: Href;
+    self?: Href;
+};
+/**
+ * Visualisation recommendation specs for the query
+ */
+type NLMetricRecommendation = {
+    analysis?: Analysis;
+    analysisGroup?: AnalysisGroup;
+    /** Chart type given to current recommendation */
+    chartType?: ChartType;
+    /** Dimension(s) considered for recommendation */
+    dims?: string[];
+    /** Measure(s) considered for recommendation */
+    msrs?: string[];
+    relevance?: number;
+};
+type NLMetricRecord = {
+    /** Qlik sense app id that is being used to answer the question */
+    appId: string;
+    /** Qlik sense app name that is being used to answer the question */
+    appName?: string;
+    apps?: AppMetadata[];
+    /** Source from which conversation is happening */
+    channelId?: string;
+    /** Chart type for given query. For insight advisor it would be 'native' and for insight advisor chat, it could be 'static' or 'responsive' */
+    chartType?: string;
+    /** Record created date */
+    createdAt: string;
+    /** Qlik sense user id who is interacting with insight advisor or insight advisor chat or third party api */
+    createdBy?: string;
+    feedback?: RecFeedback[];
+    /** Unique record id stored in database */
+    id: string;
+    /** Boolean value indicates whether given query is contextual or not. It would be false for insight advisor */
+    isContextualQuery?: boolean;
+    /** language selected for query from insight advisor or insight advisor chat or third party api */
+    lang?: string;
+    nluInfo?: PartialNluInfo[];
+    queryError?: boolean;
+    /** Refers to source from where narrative request is called */
+    queryOrigin?: "askQuestion" | "iaAnalysis" | "iaAssetsPanel";
+    /** Query asked by user in insight advisor or insight advisor or third party api */
+    queryText?: string;
+    /** Nature of query being asked during the conversation e.g. query, applist, measurelist, dimensionlist */
+    queryType?: "appList" | "appSuggested" | "dimensionList" | "exploreThisFurther" | "followup" | "greetings" | "measureList" | "query" | "sampleQuestion";
+    /** Unique id assigned to user query */
+    questionId: string;
+    recommendations?: NLMetricRecommendation[];
+    /** Provides info what was included in response for given query */
+    responses?: NLResponses;
+    /** Tokens from question parsed which are ignored */
+    stopWords?: string[];
+    /** Qlik sense tenant Id */
+    tenantId?: string;
+    /** Tokens parsed as entities but not matched with app's field/dimension/measure */
+    unmatchedEntities?: string[];
+    /** Record modified date */
+    updatedAt: string;
+    /** Version of the metric model */
+    version: string;
+};
+type NLMetricsRequest = {
+    /** The advanced filtering to use for the query. Refer to [RFC 7644](https://www.rfc-editor.org/rfc/rfc7644#section-3.4.2.2) for the syntax.
+     *
+     * Filter on createdAt and updatedAt fields are encouraged and support `eq`, `ne`, `gt`, `ge`, `lt`, `le` comparison operators along with `and` and `or` logical operators.
+     *
+     * Filter on tenantId field is not supported.
+     *
+     * `co`, `sw` and `ew` operators are not supported.
+     *
+     * Examples:
+     * ```
+     * appId eq 'appId1'
+     * ```
+     * ```
+     * (appId eq 'appId1' or appId eq 'appId2')
+     * ```
+     * ```
+     * (appId eq 'appId1' or appId eq 'appId2') and (createdAt gt '2022-08-03T00:00:00.000Z' and createdAt lt '2022-08-04T00:00:00.000Z')
+     * ```
+     *
+     * ```
+     * (appId eq 'appId1') and (createdAt ge '2022-08-03T00:00:00.000Z')
+     * ```
+     *
+     * ```
+     * (appId eq 'appId1') and (createdAt le '2022-08-23:59:59.000Z')
+     * ```
+     *
+     * ```
+     * (appId eq 'appId1') and (questionId eq '12345')
+     * ``` */
+    filter: string;
+};
+type NLMetricsResponse = {
+    data?: NLMetricRecord[];
+    links?: Links;
+    readonly meta?: {
+        /** The total number of metrics matching the current filter. */
+        total: number;
+    };
+};
+/**
+ * Provides info what was included in response for given query
+ */
+type NLResponses = {
+    /** Chart was provided */
+    hasChart?: boolean;
+    /** Narrative was provided */
+    hasInsights?: boolean;
+    /** App list was provided */
+    hasMetadataApps?: boolean;
+    /** Dimensions list was provided */
+    hasMetadataDimensions?: boolean;
+    /** Measures list was provided */
+    hasMetadataMeasures?: boolean;
+    /** Sample questions was provided */
+    hasSampleQueries?: boolean;
+    /** Suggestion questions was provided */
+    hasSuggestions?: boolean;
+};
+type NarrativeResponse = {
+    text?: string;
+};
+type NluInfo = {
+    elements?: NluInfoElements[];
+};
+type NluInfoElements = {
+    entity?: boolean;
+    errorText?: string;
+    filterFieldName?: string;
+    filterText?: string;
+    isFilter?: boolean;
+    text?: string;
+    type?: string;
+    typeName?: string;
+    typeTranslated?: string;
+};
+/**
+ * Contains break down of the asked question in the form of tokens with their classification.
+ */
+type PartialNluInfo = {
+    /** Qlik sense application field selected for given token or phrase */
+    fieldName?: string;
+    /** Filter value found from query */
+    fieldValue?: string;
+    /** Role of the token or phrase from query */
+    role?: "dimension" | "measure" | "date";
+    /** Matching token or phrase from query */
+    text?: string;
+    /** Type of token from query */
+    type?: "field" | "filter" | "master_dimension" | "master_measure" | "custom_analysis";
+};
+type QlikApp = {
+    id?: string;
+    name?: string;
+};
+type QueryCreate = {
+    app?: QlikApp;
+    /** Flag that clears the entity context. */
+    clearEntityContext?: boolean;
+    /** Flag that specifies either to enable converastion context. */
+    disableConversationContext?: boolean;
+    /** The flag specifies whether to disable follow-up recommendations. */
+    disableFollowups?: boolean;
+    /** Flag that specifies whether the narratives should be generated for the user query or not. */
+    disableNarrative?: boolean;
+    /** Flag that specifies whether visualization object should be provided or not. */
+    enableVisualizations?: boolean;
+    /** The language to assume when parsing, specified as an ISO-639-1 code.
+     * Defaults to 'en' (English). */
+    lang?: string;
+    /** property that contains the Id of the recommendation for which the response should be generated. */
+    recommendationId?: string;
+    /** The sentence that will be parsed. */
+    text: string;
+    /** Specify visualizationTypes for only which visualization object should be provided if enableVisualizations is set to true. For eg. ['linechart', 'barchart'] */
+    visualizationTypes?: string[];
+};
+/**
+ * The attributes of sentences.
+ */
+type QueryCreated = {
+    apps?: QlikApp[];
+    /** A list of conversational responses. */
+    conversationalResponse?: QueryResponse[];
+    nluInfo?: NluInfo;
+};
+type QueryNotCreated = {
+    apps?: QlikApp[];
+    conversationalResponse?: QueryResponse;
+    errors?: Error[];
+    nluInfo?: NluInfo;
+};
+type QueryResponse = {
+    apps?: QlikApp[];
+    /** For contextual responses, this string contains a list of entities that are used to produce the response. */
+    contextInfo?: string;
+    /** The URL with the query injected to insight advisor of the app to which the query belongs. */
+    drillDownURI?: string;
+    responses?: ConversationalResponsePart[];
+    sentenceWithMatches?: string;
+};
+/**
+ * Any feedback from the user about a given recommendation
+ */
+type RecFeedback = {
+    analysisType?: string;
+    chartType?: string;
+    comment?: string;
+    recommendationAddedToHub: boolean;
+    recommendationAddedToSheet: boolean;
+    recommendationDisliked: boolean;
+    recommendationLiked: boolean;
+};
+type RenderVisualization = {
+    /** Data object should be used to render visualization */
+    data?: unknown;
+    language?: string;
+};
+/**
+ * Returns the generated response for parsed chat queries, if no app was specified nor present in conversation context, suggests matching apps.
+ *
+ * @param body an object with the body content
+ * @throws AskQuestionsHttpError
+ */
+declare function askQuestions(body: QueryCreate, options?: ApiCallOptions): Promise<AskQuestionsHttpResponse>;
+type AskQuestionsHttpResponse = AskQuestions200HttpResponse | AskQuestions201HttpResponse;
+type AskQuestions200HttpResponse = {
+    data: QueryNotCreated;
+    headers: Headers;
+    status: 200;
+};
+type AskQuestions201HttpResponse = {
+    data: QueryCreated;
+    headers: Headers;
+    status: 201;
+};
+type AskQuestionsHttpError = {
+    data: Errors;
+    headers: Headers;
+    status: number;
+};
+/**
+ * Returns NL metrics based on provided app IDs the user has access to.
+ *
+ * @param query an object with query parameters
+ * @param body an object with the body content
+ * @throws FilterQuestionsHttpError
+ */
+declare function filterQuestions(query: {
+    /** The preferred number of entries returned */
+    limit?: number;
+    /** A cursor pointing to the page of data to retrieve. */
+    page?: string;
+    /** A single field from the data model on which to sort the response. The '+' or '-' operator may be used to specify ascending or desending order. */
+    sort?: "createdAt" | "updatedAt" | "+createdAt" | "+updatedAt" | "-createdAt" | "-updatedAt";
+}, body: NLMetricsRequest, options?: ApiCallOptions): Promise<FilterQuestionsHttpResponse>;
+type FilterQuestionsHttpResponse = {
+    data: NLMetricsResponse;
+    headers: Headers;
+    status: 200;
+    prev?: (options?: ApiCallOptions) => Promise<FilterQuestionsHttpResponse>;
+    next?: (options?: ApiCallOptions) => Promise<FilterQuestionsHttpResponse>;
+};
+type FilterQuestionsHttpError = {
+    data: Errors;
+    headers: Headers;
+    status: 400 | 401 | 422 | 500;
+};
+/**
+ * Clears the cache for questions api requests.
+ */
+declare function clearCache(): void;
+interface QuestionsAPI {
+    /**
+     * Returns the generated response for parsed chat queries, if no app was specified nor present in conversation context, suggests matching apps.
+     *
+     * @param body an object with the body content
+     * @throws AskQuestionsHttpError
+     */
+    askQuestions: typeof askQuestions;
+    /**
+     * Returns NL metrics based on provided app IDs the user has access to.
+     *
+     * @param query an object with query parameters
+     * @param body an object with the body content
+     * @throws FilterQuestionsHttpError
+     */
+    filterQuestions: typeof filterQuestions;
+    /**
+     * Clears the cache for questions api requests.
+     */
+    clearCache: typeof clearCache;
+}
+/**
+ * Functions for the questions api
+ */
+declare const questionsExport: QuestionsAPI;
+
+export { type Analysis, type AnalysisGroup, type AppMetadata, type AskQuestions200HttpResponse, type AskQuestions201HttpResponse, type AskQuestionsHttpError, type AskQuestionsHttpResponse, type ChartType, type ConversationalResponsePart, type Error, type Errors, type FilterQuestionsHttpError, type FilterQuestionsHttpResponse, type Href, type Links, type NLMetricRecommendation, type NLMetricRecord, type NLMetricsRequest, type NLMetricsResponse, type NLResponses, type NarrativeResponse, type NluInfo, type NluInfoElements, type PartialNluInfo, type QlikApp, type QueryCreate, type QueryCreated, type QueryNotCreated, type QueryResponse, type QuestionsAPI, type RecFeedback, type RenderVisualization, askQuestions, clearCache, questionsExport as default, filterQuestions };

package/questions.js

@@ -0,0 +1,38 @@
+import {
+  clearApiCache,
+  invokeFetch
+} from "./chunks/LIEZG7IM.js";
+import "./chunks/GPRUNZV4.js";
+import "./chunks/7MMXU6EL.js";
+
+// src/public/rest/questions.ts
+async function askQuestions(body, options) {
+  return invokeFetch("questions", {
+    method: "post",
+    pathTemplate: "/api/v1/questions/actions/ask",
+    body,
+    contentType: "application/json",
+    options
+  });
+}
+async function filterQuestions(query, body, options) {
+  return invokeFetch("questions", {
+    method: "post",
+    pathTemplate: "/api/v1/questions/actions/filter",
+    query,
+    body,
+    contentType: "application/json",
+    options
+  });
+}
+function clearCache() {
+  return clearApiCache("questions");
+}
+var questionsExport = { askQuestions, filterQuestions, clearCache };
+var questions_default = questionsExport;
+export {
+  askQuestions,
+  clearCache,
+  questions_default as default,
+  filterQuestions
+};