@adaptabletools/adaptable 13.1.1 → 14.0.0-canary.1

package/src/parser/src/types.d.ts

@@ -58,6 +58,7 @@ export interface ExpressionFunction {
     isHiddenFromMenu?: boolean;
     /**
      * Whether the AdaptableQL Function returns true, if so can be used as Query
+     * @deprecated is equivalent with `returnType === 'boolean'`
      */
     isPredicate?: boolean;
     /**
@@ -68,6 +69,14 @@ export interface ExpressionFunction {
      * How the AdaptableQL Function should be called
      */
     signatures?: string[];
+    /**
+     * Specify what the AdaptableQL Function returns
+     */
+    returnType?: 'boolean' | 'number' | 'string' | 'date' | 'any';
+    /**
+     * Used to group Functions in dropdown
+     */
+    category?: string;
     /**
      * Examples that use the AdaptableQL Function
      */

package/src/types.d.ts

@@ -21,7 +21,7 @@ export type { IPushPullPluginOptions } from './AdaptableOptions/IPushPullPluginO
 export type { LayoutOptions, LayoutViewOptions, LayoutTagOptions, LayoutAvailableContext, AutoGenerateTagsForLayoutsContext, LayoutAssociatedObject, PivotPreviewColumnsContext, } from './AdaptableOptions/LayoutOptions';
 export type { ChartingOptions, ChartContainer } from './AdaptableOptions/ChartingOptions';
 export type { OpenFinPluginOptions } from './AdaptableOptions/OpenFinPluginOptions';
-export type { MasterDetailPluginOptions } from './AdaptableOptions/MasterDetailPluginOptions';
+export type { MasterDetailPluginOptions, DetailInitContext, } from './AdaptableOptions/MasterDetailPluginOptions';
 export type { FinsemblePluginOptions, FinsemblePluginStateOptions, } from './AdaptableOptions/FinsemblePluginOptions';
 export type { FinancePluginOptions, WeightedAverageColumn, FDC3Column, InstrumentColumn, PositionColumn, CountryColumn, InstrumentIntent, InstrumentIntents, PositionIntent, PositionIntents, ContactIntent, ContactIntents, CountryIntent, CountryIntents, ContactColumn, OrganizationColumn, OrganizationIntent, OrganizationIntents, FDC3Intent, RaiseFDC3IntentContext, FDC3DesktopAgent, CustomFDC3Column, CustomFDC3Intent, } from './AdaptableOptions/FinancePluginOptions';
 export type { DateInputOptions } from './AdaptableOptions/DateInputOptions';
@@ -129,7 +129,7 @@ export type { SystemStatusMessageInfo } from './PredefinedConfig/Common/SystemSt
 export type { AlternativeModuleName } from './PredefinedConfig/Common/AlternativeModuleName';
 export type { AdaptableFormat, DateFormatterOptions, NumberFormatterOptions, StringFormatterOptions, } from './PredefinedConfig/Common/AdaptableFormat';
 export type { AdaptableMessageType } from './PredefinedConfig/Common/AdaptableMessageType';
-export type { AdaptableObject, AdaptableObjectTag, } from './PredefinedConfig/Common/AdaptableObject';
+export type { AdaptableObject, AdaptableObjectTag, AdaptableObjectLookupCriteria, } from './PredefinedConfig/Common/AdaptableObject';
 export type { SuspendableObject } from './PredefinedConfig/Common/SuspendableObject';
 export type { AdaptableQuery, AdaptableAggregatedBooleanQuery, AdaptableAggregatedScalarQuery, AdaptableBooleanQuery, AdaptableObservableQuery, AdaptableScalarQuery, } from './PredefinedConfig/Common/AdaptableQuery';
 export type { AdaptablePredicate, AdaptablePredicateDef, PredicateModuleScope, PredicateDefHandlerParams, PredicateDefInput, PredicateDefToStringParams, ColumnFilterDef, } from './PredefinedConfig/Common/AdaptablePredicate';
@@ -158,7 +158,7 @@ export type { DashboardState, DashboardTab, AdaptableCoordinate, } from './Prede
 export type { ExportState, Report, ReportData, ReportSchedule, SystemReportName, SystemReportNames, ReportRowScope, ReportColumnScope, } from './PredefinedConfig/ExportState';
 export type { ColumnFilter, ColumnFilterPredicate, SystemFilterPredicateIds, SystemFilterPredicateId, } from './PredefinedConfig/Common/ColumnFilter';
 export type { FormatColumn, FormatColumnState, FormatColumnRule, FormatColumnPredicate, SystemFormatColumnPredicateId, SystemFormatColumnPredicateIds, } from './PredefinedConfig/FormatColumnState';
-export type { StyledColumn, StyledColumnState, PercentBarStyle, GradientStyle, CellColorRange, ColumnComparison, CellTextOptions, CellTextOption, NumericStyledColumn, RangeValueType, } from './PredefinedConfig/StyledColumnState';
+export type { StyledColumn, StyledColumnState, PercentBarStyle, GradientStyle, CellColorRange, ColumnComparison, CellTextOptions, CellTextOption, NumericStyledColumn, RangeValueType, SparkLineStyle, } from './PredefinedConfig/StyledColumnState';
 export type { FreeTextColumn, FreeTextColumnState, FreeTextStoredValue, FreeTextColumnSettings, } from './PredefinedConfig/FreeTextColumnState';
 export type { StatusBarState, AdaptableStatusBar } from './PredefinedConfig/StatusBarState';
 export type { Glue42Report, Glue42Schedule, Glue42State } from './PredefinedConfig/Glue42State';

package/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "13.1.1";
+declare const _default: "14.0.0-canary.1";
 export default _default;

package/version.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = '13.1.1'; // PLEASE DONT UPDATE THIS!!! - will be updated at build time with the correct version
+exports.default = '14.0.0-canary.1'; // PLEASE DONT UPDATE THIS!!! - will be updated at build time with the correct version

package/src/Api/InternalApi.d.ts

@@ -1,155 +0,0 @@
-import { UIConfirmation } from '../Utilities/Interface/MessagePopups';
-import { SystemState } from '../PredefinedConfig/SystemState';
-import { Action } from 'redux';
-import { ModuleParams } from '../View/Components/SharedProps/ModuleViewPopupProps';
-import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
-import { AdaptableMenuItem } from '../PredefinedConfig/Common/Menu';
-import { SelectedCellInfo } from '../PredefinedConfig/Selection/SelectedCellInfo';
-import { SelectedRowInfo } from '../PredefinedConfig/Selection/SelectedRowInfo';
-import { AdaptableModule, AdaptableQLModule } from '../PredefinedConfig/Common/Types';
-import { GridCell } from '../PredefinedConfig/Selection/GridCell';
-import { IAdaptable } from '../AdaptableInterfaces/IAdaptable';
-import { IValidationService } from '../Utilities/Services/Interface/IValidationService';
-import { IModuleService } from '../Utilities/Services/Interface/IModuleService';
-import { IReportService } from '../Utilities/Services/Interface/IReportService';
-import { ICalculatedColumnExpressionService } from '../Utilities/Services/Interface/ICalculatedColumnExpressionService';
-import { AdaptableOptions } from '../AdaptableOptions/AdaptableOptions';
-import { Layout } from '../PredefinedConfig/LayoutState';
-import { AdaptableAlert, AdaptableCellChangedAlert, AdaptableRowChangedAlert } from '../PredefinedConfig/Common/AdaptableAlert';
-import { IDataService } from '../Utilities/Services/Interface/IDataService';
-import { AdaptableIcon, AdaptableMessageType, AdaptableQuery, AlertDefinition, BaseContext, CellDataChangedInfo, EditLookUpPermittedValues, LayoutAssociatedObject, SharedEntity, SystemStatusMessageInfo } from '../types';
-import { IEntitlementService } from '../Utilities/Services/Interface/IEntitlementService';
-import { AdaptableFlashingCell } from '../PredefinedConfig/Common/AdaptableFlashingCell';
-import { IQueryLanguageService } from '../Utilities/Services/Interface/IQueryLanguageService';
-import { IAlertService } from '../Utilities/Services/Interface/IAlertService';
-import { AdaptableState } from '../PredefinedConfig/AdaptableState';
-import { ITeamSharingService } from '../Utilities/Services/Interface/ITeamSharingService';
-import { AdaptableButton } from '../PredefinedConfig/Common/AdaptableButton';
-import { ColumnValuesComparer } from '../AdaptableOptions/GeneralOptions';
-import { ButtonStyle } from '../PredefinedConfig/Common/ButtonStyle';
-import { AdaptableForm } from '../PredefinedConfig/Common/AdaptableForm';
-import { AlertButtonForm } from '../PredefinedConfig/AlertState';
-import { AdaptableFrameworkComponent } from '../AdaptableOptions/AdaptableFrameworkComponent';
-import { IMetamodelService } from '../Utilities/Services/Interface/IMetamodelService';
-import { GridOptions, RowNode } from '@ag-grid-community/core';
-import { IModuleCollection } from '../Strategy/Interface/IModule';
-import { AdaptableObjectTag } from '../PredefinedConfig/Common/AdaptableObject';
-import { IRowEditService } from '../Utilities/Services/Interface/IRowEditService';
-/**
- * This set of api methods is designed for **internal use of Adaptable** only.
- *
- * None of these methods should be invoked by users of Adaptable and no guarantee is made regarding performance or any after affects if used 'externally'.
- */
-export interface InternalApi {
-    getSystemState(): SystemState;
-    getAdaptableFormFromAlertForm(alertForm: string | AlertButtonForm, context: any, defaultMessageType?: AdaptableMessageType): Omit<AdaptableForm<BaseContext>, 'buttons'> & {
-        buttons?: (Omit<AdaptableButton<BaseContext>, 'buttonStyle'> & {
-            buttonStyle?: ButtonStyle;
-        })[];
-    };
-    getAdaptableAlerts(): AdaptableAlert[];
-    getAdaptableCellChangedAlerts(): AdaptableCellChangedAlert[];
-    getAdaptableRowChangedAlerts(): AdaptableRowChangedAlert[];
-    getAdaptableAlertWithHighlightCell(columnId: string, rowNode: RowNode): AdaptableAlert | undefined;
-    getAdaptableAlertWithHighlightRow(rowNode: RowNode): AdaptableAlert | undefined;
-    isAlertDefinitionForAddedRowChangeEvent(alertDefinition: AlertDefinition): boolean;
-    isAlertDefinitionForRemovedRowChangeEvent(alertDefinition: AlertDefinition): boolean;
-    showPopupConfirmation(confirmation: UIConfirmation): void;
-    getAdaptableFlashingCellFor(primaryKey: string, columnId?: string): AdaptableFlashingCell | null;
-    addSystemStatusMessageInfo(systemStatusMessageInfo: SystemStatusMessageInfo): void;
-    getSystemStatusMessageInfos(): SystemStatusMessageInfo[];
-    showLoadingScreen(): void;
-    hideLoadingScreen(): void;
-    showPopupScreen(module: AdaptableModule, componentName: string, popupParams?: ModuleParams, popupProps?: {
-        [key: string]: any;
-    }): void;
-    showPopupWindow(Id: string, Title: string, Icon: string, PopupProps: any): void;
-    isDocumentationLinksDisplayed(): boolean;
-    hidePopupScreen(): void;
-    setColumns(columns: AdaptableColumn[]): void;
-    setSettingPanelModuleMenuItems(menuItems: AdaptableMenuItem[]): void;
-    setModuleButtonMenuItems(menuItems: AdaptableMenuItem[]): void;
-    setSelectedCells(selectedCellInfo: SelectedCellInfo): void;
-    setSelectedRows(selectedRowInfo: SelectedRowInfo): void;
-    getValueUsingField(rowData: Record<string, any>, column: AdaptableColumn): any;
-    setValueUsingField(rowData: Record<string, any>, column: AdaptableColumn, newValue: any): any;
-    setPivotModeOn(): void;
-    setPivotModeOff(): void;
-    isGridInPivotMode(): boolean;
-    setTreeModeOn(): void;
-    setTreeModeOff(): void;
-    isGridInTreeMode(): boolean;
-    addAdaptableColumn(AdaptableColumn: AdaptableColumn): void;
-    removeAdaptableColumn(colId: string): void;
-    setGridCells(gridCells: GridCell[]): void;
-    setGridCell(gridCell: GridCell): void;
-    setToolbarTitle(): string;
-    getQueryPreviewData(): any;
-    buildDataChangedInfo(config: Pick<CellDataChangedInfo, 'newValue' | 'oldValue' | 'column' | 'primaryKeyValue' | 'rowNode' | 'trigger'>): CellDataChangedInfo;
-    setLastAppliedShortCut(gridCell: GridCell | undefined): void;
-    updateCurrentDraftLayout(layout: Layout): void;
-    getPrimaryKey(): any;
-    getAdaptableInstance(): IAdaptable;
-    getAgGridInstance(): GridOptions;
-    getPredefinedConfig(): any;
-    getState(): AdaptableState;
-    getAdaptableOptions(): AdaptableOptions;
-    getValidationService(): IValidationService;
-    getModuleService(): IModuleService;
-    getReportService(): IReportService;
-    getDataService(): IDataService;
-    getCalculatedColumnExpressionService(): ICalculatedColumnExpressionService;
-    getEntitlementService(): IEntitlementService;
-    getQueryLanguageService(): IQueryLanguageService;
-    getAlertService(): IAlertService;
-    getTeamSharingService(): ITeamSharingService;
-    getMetamodelService(): IMetamodelService;
-    getRowEditService(): IRowEditService;
-    getModules(): IModuleCollection;
-    getModuleFriendlyName(adaptableModule: AdaptableModule): string;
-    /**
-     * @deprecated use `evaluateExpressionInAdaptableQL()` instead
-     */
-    runModuleInAdaptableQL(adaptableQLModule: AdaptableQLModule): boolean;
-    evaluateExpressionInAdaptableQL(adaptableQLModule: AdaptableQLModule, expression?: string): boolean;
-    forAllRowNodesDo(func: (rowNode: RowNode) => void): void;
-    forAllVisibleRowNodesDo(func: (rowNode: RowNode) => void): void;
-    buildStandaloneColumnHeader(column: AdaptableColumn): AdaptableMenuItem[];
-    getCustomSortComparer(column: AdaptableColumn): ColumnValuesComparer | undefined;
-    clearFlashingCellState(): void;
-    clearUpdatedRowState(): void;
-    clearGradientColumnState(): void;
-    clearPercentBarState(): void;
-    getLabelForButton(button: AdaptableButton<BaseContext>, context: BaseContext): string | undefined;
-    getTooltipForButton(button: AdaptableButton<BaseContext>, context: BaseContext): string | undefined;
-    getStyleForButton(button: AdaptableButton<BaseContext>, context: BaseContext): ButtonStyle | undefined;
-    getIconForButton(button: AdaptableButton<BaseContext>, context: BaseContext, defaultWidthHeight?: {
-        height: number | string;
-        width: number | string;
-    }): AdaptableIcon | undefined;
-    dispatchReduxAction(action: Action): void;
-    waitForTeamSharingImportEnd(): Promise<boolean>;
-    getLocalTeamSharingEntities(): SharedEntity[];
-    createFrameworkComponent(containerDomNode: HTMLElement, frameworkComponent: AdaptableFrameworkComponent, componentType: 'toolPanel' | 'toolbar' | string): void;
-    destroyFrameworkComponent(containerDomNode: HTMLElement, frameworkComponent: AdaptableFrameworkComponent, componentType: 'toolPanel' | 'toolbar' | string): void;
-    initializeDataChangeHistory(): void;
-    isTextComparisonCaseSensitive(): boolean;
-    hasLayoutSpecificObjects(): boolean;
-    isObjectAvailableInLayout(object: LayoutAssociatedObject, module: AdaptableModule, layout: Layout): boolean;
-    showLayoutNotAssociatedObjects(): boolean;
-    executeWithProgressIndicator(label: string, executeFn: () => unknown): void;
-    hideProgressIndicator(): void;
-    getCorrectEnglishVariant(wordToSpell: string): string;
-    shouldDisplayTagSections(): boolean;
-    getAvailableTags(): AdaptableObjectTag[] | undefined;
-    showSettingsPanel(module: AdaptableModule, moduleParams?: ModuleParams): void;
-    getLabelForTag(adaptableObjectTag: AdaptableObjectTag): string;
-    getValueForTag(adaptableObjectTag: AdaptableObjectTag): string | number;
-    getEditLookUpValuesForColumn(editLookUpItem: EditLookUpPermittedValues, column: AdaptableColumn, gridCell?: GridCell): any[] | undefined;
-    getAdaptableQueryExpressionText(query: Partial<AdaptableQuery>): string;
-    deleteConditionalStyles(conditionalStyles: any[]): void;
-    persistPreviousGroupedColumnsIndex(layoutId: string, columnId: string, columnIndex: number): void;
-    getPreviousGroupedColumnsIndex(layoutId: string): {
-        [key: string]: number;
-    } | undefined;
-}

package/src/Api/InternalApi.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });