npm - @adaptabletools/adaptable - Versions diffs - 16.2.3 → 17.0.0-canary.0 - Mend

@adaptabletools/adaptable 16.2.3 → 17.0.0-canary.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1343) hide show

package/src/Api/LayoutApi.js CHANGED Viewed

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

package/src/Api/{QueryApi.d.ts → NamedQueryApi.d.ts} RENAMED Viewed

@@ -1,13 +1,23 @@
-import { NamedQuery, QueryState } from '../PredefinedConfig/QueryState';
+import { NamedQuery, NamedQueryState } from '../types';
 /**
  * Provides run-time access to Named and Current Queries
  */
-export interface QueryApi {
+export interface NamedQueryApi {
+    /**
+     * Adds a new Named Query to Adaptable State
+     * @param namedQueries
+     */
+    addNamedQuery(namedQueries: NamedQuery): void;
+    /**
+     * Adds multiple new Named Query to Adaptable State
+     * @param namedQueries
+     */
+    addNamedQueries(namedQueries: NamedQuery[]): void;
     /**
      * Retrieves Query section from Adaptable State
      *
      */
-    getQueryState(): QueryState;
+    getNamedQueryState(): NamedQueryState;
     /**
      * Gets all Named Queries in Adaptable State
      */
@@ -28,24 +38,15 @@ export interface QueryApi {
     /**
      * Opens Settings Panel with Query section selected and visible
      */
-    openQuerySettingsPanel(): void;
+    openNamedQuerySettingsPanel(): void;
     /**
-     * Set a Query as Current Query
-     * @param query - Query to set
+     * Runs the given Named Query
+     * @param namedQuery Query to Run
      */
-    setCurrentQuery(query: string): void;
+    runNamedQuery(namedQuery: NamedQuery): void;
     /**
-     * Clears the Current Query
-     */
-    clearCurrentQuery(): void;
-    /**
-     * Returns the Current Query
-     */
-    getCurrentQuery(): string | undefined;
-    /**
-     * Opens current query editor
-     *
-     * @param query - query to edit
+     * Runs Named Query which has given name
+     * @param queryName Name of Named Query
      */
-    expandCurrentQuery(query?: string): void;
+    runQueryByName(queryName: string): void;
 }

package/src/Api/NamedQueryApi.js ADDED Viewed

	@@ -0,0 +1 @@
1	+ export {};

package/src/Api/NotesAPi.js CHANGED Viewed

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

package/src/Api/OpenFinApi.js CHANGED Viewed

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

package/src/Api/OptionsApi.d.ts CHANGED Viewed

@@ -1,7 +1,7 @@
 import { CustomSortOptions } from '../AdaptableOptions/CustomSortOptions';
 import { DataSetOptions } from '../AdaptableOptions/DataSetOptions';
 import { GroupingOptions } from '../AdaptableOptions/GroupingOptions';
-import { ActionColumnOptions, ActionRowOptions, AdaptableOptions, AlertOptions, CalendarOptions, CellSummaryOptions, ChartingOptions, ColumnOptions, ContainerOptions, DashboardOptions, DataChangeHistoryOptions, EditOptions, EntitlementOptions, ExportOptions, FilterOptions, FlashingCellOptions, FormatColumnOptions, LayoutOptions, MenuOptions, NotesOptions, NotificationsOptions, QuickSearchOptions, SettingsPanelOptions, StateOptions, TeamSharingOptions, ToolPanelOptions, UserInterfaceOptions } from '../types';
+import { ActionColumnOptions, ActionRowOptions, AdaptableOptions, AlertOptions, CalendarOptions, CellSummaryOptions, ChartingOptions, ColumnFilterOptions, ColumnOptions, ContainerOptions, DashboardOptions, DataChangeHistoryOptions, EditOptions, EntitlementOptions, ExportOptions, FlashingCellOptions, FormatColumnOptions, LayoutOptions, MenuOptions, NotesOptions, NotificationsOptions, QuickSearchOptions, SettingsPanelOptions, StateOptions, TeamSharingOptions, ToolPanelOptions, UserInterfaceOptions } from '../types';
 import { Fdc3Options } from '../AdaptableOptions/Fdc3Options';
 import { ExpressionOptions } from '../AdaptableOptions/ExpressionOptions';
 import { DataImportOptions } from '../AdaptableOptions/DataImportOptions';
@@ -106,9 +106,9 @@ export interface OptionsApi {
      */
     getExportOptions(): Readonly<ExportOptions>;
     /**
-     * Returns `AdaptableOptions.filterOptions`
+     * Returns `AdaptableOptions.columnFilterOptions`
      */
-    getFilterOptions(): Readonly<FilterOptions>;
+    getColumnFilterOptions(): Readonly<ColumnFilterOptions>;
     /**
      * Returns `AdaptableOptions.flashingCellOptions`
      */

package/src/Api/OptionsApi.js CHANGED Viewed

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

package/src/Api/PluginsApi.js CHANGED Viewed

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

package/src/Api/PlusMinusApi.js CHANGED Viewed

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

package/src/Api/PredicateApi.d.ts CHANGED Viewed

@@ -12,6 +12,11 @@ export interface PredicateApi {
      * Returns Predicate Definitions provided by AdapTable
      */
     getSystemPredicateDefs(): AdaptablePredicateDef[];
+    /**
+     * Returns Predicate Definitions provided by AdapTable for given Module Scope
+     * @param moduleScope Module Scope to use
+     */
+    getSystemPredicateDefsByModuleScope<PREDICATE_TYPE extends string = string>(moduleScope: PredicateModuleScope): AdaptablePredicateDef<PREDICATE_TYPE>[];
     /**
      * Returns Predicate Definitions provided by users
      */

package/src/Api/PredicateApi.js CHANGED Viewed

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

package/src/Api/QuickSearchApi.js CHANGED Viewed

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

package/src/Api/ScheduleApi.js CHANGED Viewed

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

package/src/Api/ScopeApi.js CHANGED Viewed

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

package/src/Api/SettingsPanelApi.js CHANGED Viewed

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

package/src/Api/ShortcutApi.js CHANGED Viewed

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

package/src/Api/SmartEditApi.js CHANGED Viewed

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

package/src/Api/StatusBarApi.js CHANGED Viewed

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

package/src/Api/StyledColumnApi.js CHANGED Viewed

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

package/src/Api/SystemStatusApi.js CHANGED Viewed

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

package/src/Api/TeamSharingApi.js CHANGED Viewed

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

package/src/Api/ThemeApi.js CHANGED Viewed

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

package/src/Api/ToolPanelApi.js CHANGED Viewed

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

package/src/Api/UserInterfaceApi.js CHANGED Viewed

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

package/src/PredefinedConfig/AdaptableState.d.ts CHANGED Viewed

@@ -24,6 +24,7 @@ import { StatusBarState } from './StatusBarState';
 import { ChartingState } from './ChartingState';
 import { StyledColumnState } from './StyledColumnState';
 import { NotesState } from './NotesState';
+import { NamedQueryState } from './NamedQueryState';
 /**
  * The main state object of Adaptable
  */
@@ -45,7 +46,7 @@ export interface AdaptablePersistentState {
     FreeTextColumn: FreeTextColumnState;
     Layout: LayoutState;
     PlusMinus: PlusMinusState;
-    Query: QueryState;
+    NamedQuery: NamedQueryState;
     QuickSearch: QuickSearchState;
     Schedule: ScheduleState;
     StyledColumn: StyledColumnState;
@@ -56,6 +57,10 @@ export interface AdaptablePersistentState {
     ToolPanel: ToolPanelState;
     Charting: ChartingState;
     Notes: NotesState;
+    /**
+      * @deprecated
+      */
+    Query: QueryState;
 }
 /**
  * The state which is available in the internal Redux store but never persisted

package/src/PredefinedConfig/AdaptableState.js CHANGED Viewed

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

package/src/PredefinedConfig/AlertState.js CHANGED Viewed

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

package/src/PredefinedConfig/ApplicationState.js CHANGED Viewed

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

package/src/PredefinedConfig/CalculatedColumnState.js CHANGED Viewed

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

package/src/PredefinedConfig/ChartingState.js CHANGED Viewed

@@ -1,11 +1,6 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isAgChartDefinition = exports.isExternalChartDefinition = void 0;
-const isExternalChartDefinition = (chartDefinition) => {
+export const isExternalChartDefinition = (chartDefinition) => {
     return chartDefinition && 'Data' in chartDefinition;
 };
-exports.isExternalChartDefinition = isExternalChartDefinition;
-const isAgChartDefinition = (chartDefinition) => {
+export const isAgChartDefinition = (chartDefinition) => {
     return chartDefinition && 'Model' in chartDefinition;
 };
-exports.isAgChartDefinition = isAgChartDefinition;

package/src/PredefinedConfig/Common/AdaptableAlert.js CHANGED Viewed

@@ -1,11 +1,6 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isAdaptableRowChangedAlert = exports.isAdaptableCellChangedAlert = void 0;
-const isAdaptableCellChangedAlert = (alert) => {
+export const isAdaptableCellChangedAlert = (alert) => {
     return alert.alertType === 'cellChanged';
 };
-exports.isAdaptableCellChangedAlert = isAdaptableCellChangedAlert;
-const isAdaptableRowChangedAlert = (alert) => {
+export const isAdaptableRowChangedAlert = (alert) => {
     return alert.alertType === 'rowChanged';
 };
-exports.isAdaptableRowChangedAlert = isAdaptableRowChangedAlert;

package/src/PredefinedConfig/Common/AdaptableButton.js CHANGED Viewed

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

package/src/PredefinedConfig/Common/AdaptableColumn.d.ts CHANGED Viewed

@@ -73,6 +73,10 @@ export interface AdaptableColumn<TData = any> extends AdaptableColumnBase {
      * Is Column currently visible
      */
     visible: boolean;
+    /**
+     * Is the Column ONLY available as a field and never visible
+     */
+    fieldOnly: boolean;
     /**
      * Is Column sortable
      */

package/src/PredefinedConfig/Common/AdaptableColumn.js CHANGED Viewed

@@ -1,12 +1,9 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isValidOrderForColumnGroups = void 0;
 const isAdaptableColumn = (input) => {
     return (typeof (input === null || input === void 0 ? void 0 : input.columnId) === 'string' &&
         typeof input.dataType === 'string');
 };
 // this is only implemented for 1 level groups
-const isValidOrderForColumnGroups = ({ oldColumns, newColumns, }) => {
+export const isValidOrderForColumnGroups = ({ oldColumns, newColumns, }) => {
     const getGroups = (columns) => {
         let prevGroup = '';
         let count = 0;
@@ -29,4 +26,3 @@ const isValidOrderForColumnGroups = ({ oldColumns, newColumns, }) => {
     }
     return true;
 };
-exports.isValidOrderForColumnGroups = isValidOrderForColumnGroups;

package/src/PredefinedConfig/Common/AdaptableComparerFunction.js CHANGED Viewed

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

package/src/PredefinedConfig/Common/AdaptableFlashingCell.js CHANGED Viewed

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

package/src/PredefinedConfig/Common/AdaptableForm.js CHANGED Viewed

@@ -1,11 +1,7 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDefaultAdaptableFormData = void 0;
-function getDefaultAdaptableFormData(formDef) {
+export function getDefaultAdaptableFormData(formDef) {
     return (formDef.fields || []).flat().reduce((data, field) => {
         var _a;
         data[field.name] = (_a = field.defaultValue) !== null && _a !== void 0 ? _a : '';
         return data;
     }, {});
 }
-exports.getDefaultAdaptableFormData = getDefaultAdaptableFormData;

package/src/PredefinedConfig/Common/AdaptableFormat.js CHANGED Viewed

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

package/src/PredefinedConfig/Common/AdaptableIcon.d.ts CHANGED Viewed

@@ -54,4 +54,4 @@ export interface AdaptableBaseIcon {
 /**
  * All AdapTable System Icon names
  */
-export declare type AdaptableSystemIconName = 'add' | 'alert' | 'building' | 'laptop' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up' | 'arrow-up-long' | 'arrow-down-long' | 'arrow-expand' | 'paperclip' | 'unfilled-circle' | 'boolean-list' | 'broadcast' | 'brush' | 'spanner' | 'edit-table' | 'chart-and-grid' | 'calendar' | 'call' | 'cells' | 'fdc3' | 'flag' | 'chart' | 'chat' | 'check' | 'check-circle' | 'checked' | 'clone' | 'close' | 'cloud-upload' | 'collapse' | 'column-add' | 'columns' | 'filter-list' | 'comment' | 'contains' | 'dashboard' | 'data-set' | 'date-range' | 'delete' | 'division' | 'dock' | 'dollar' | 'drag' | 'edit' | 'ends-with' | 'equals' | 'equation' | 'error' | 'expand' | 'exponent' | 'export' | 'export-data' | 'fast-backward' | 'fast-forward' | 'filter' | 'lightning' | 'folder' | 'folder-open' | 'folder-shared' | 'color-palette' | 'horizontal-lines' | 'function' | 'greater-than' | 'greater-than-or-equal' | 'history' | 'home' | 'import-export' | 'info' | 'brain' | 'download' | 'grid' | 'interactions' | 'less-than' | 'less-than-or-equal' | 'list' | 'logout' | 'mail' | 'menu' | 'minus' | 'multiplication' | 'money' | 'newpage' | 'news' | 'filled-circle' | 'not-contains' | 'not-equal' | 'open-in-new' | 'order' | 'organisation' | 'pause' | 'percent' | 'percent-tag' | 'person' | 'contact' | 'pie-chart' | 'play' | 'plus' | 'add-circle' | 'search' | 'search-table' | 'quote' | 'refresh' | 'regex' | 'reminder' | 'save' | 'schedule' | 'science' | 'settings' | 'link' | 'sort-asc' | 'sort-desc' | 'spark-line' | 'starts-with' | 'assignment' | 'statusbar' | 'stop' | 'traffic-lights' | 'tab-unselected' | 'theme' | 'clipboard' | 'target' | 'triangle-down' | 'triangle-up' | 'unchecked' | 'undo' | 'downloaded' | 'upload' | 'warning' | 'gradient' | 'badge' | 'italic' | 'bold' | 'align-left' | 'align-right' | 'align-center' | 'align-justify' | 'underline' | 'strikethrough' | 'overline' | 'case-upper' | 'case-lower' | 'case-sentence' | 'visibility-on' | 'visibility-off' | 'visibility-off-bold' | 'visibility-on-bold' | 'note' | 'import';
+export declare type AdaptableSystemIconName = 'add' | 'alert' | 'building' | 'laptop' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up' | 'arrow-up-long' | 'arrow-down-long' | 'arrow-expand' | 'paperclip' | 'unfilled-circle' | 'boolean-list' | 'broadcast' | 'brush' | 'spanner' | 'edit-table' | 'chart-and-grid' | 'calendar' | 'call' | 'cells' | 'fdc3' | 'flag' | 'chart' | 'chat' | 'check' | 'check-circle' | 'checked' | 'clone' | 'close' | 'cloud-upload' | 'collapse' | 'column-add' | 'columns' | 'filter-list' | 'comment' | 'contains' | 'dashboard' | 'data-set' | 'date-range' | 'delete' | 'division' | 'dock' | 'dollar' | 'drag' | 'edit' | 'ends-with' | 'equals' | 'equation' | 'error' | 'expand' | 'exponent' | 'export' | 'export-data' | 'fast-backward' | 'fast-forward' | 'filter' | 'lightning' | 'folder' | 'folder-open' | 'folder-shared' | 'color-palette' | 'horizontal-lines' | 'function' | 'greater-than' | 'greater-than-or-equal' | 'history' | 'home' | 'import-export' | 'info' | 'brain' | 'download' | 'grid' | 'interactions' | 'less-than' | 'less-than-or-equal' | 'list' | 'logout' | 'mail' | 'menu' | 'minus' | 'multiplication' | 'money' | 'newpage' | 'news' | 'filled-circle' | 'not-contains' | 'not-equal' | 'open-in-new' | 'order' | 'organisation' | 'pause' | 'percent' | 'percent-tag' | 'person' | 'contact' | 'pie-chart' | 'play' | 'plus' | 'add-circle' | 'search' | 'search-table' | 'quote' | 'refresh' | 'regex' | 'reminder' | 'save' | 'schedule' | 'science' | 'settings' | 'link' | 'sort-asc' | 'sort-desc' | 'spark-line' | 'starts-with' | 'assignment' | 'statusbar' | 'stop' | 'traffic-lights' | 'tab-unselected' | 'theme' | 'clipboard' | 'target' | 'triangle-down' | 'triangle-up' | 'unchecked' | 'undo' | 'downloaded' | 'upload' | 'warning' | 'gradient' | 'badge' | 'italic' | 'bold' | 'align-left' | 'align-right' | 'align-center' | 'align-justify' | 'underline' | 'strikethrough' | 'overline' | 'case-upper' | 'case-lower' | 'case-sentence' | 'visibility-on' | 'visibility-off' | 'visibility-off-bold' | 'visibility-on-bold' | 'note' | 'import' | 'grid-filter';

package/src/PredefinedConfig/Common/AdaptableIcon.js CHANGED Viewed

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

package/src/PredefinedConfig/Common/AdaptableMessageType.js CHANGED Viewed

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

package/src/PredefinedConfig/Common/AdaptableObject.js CHANGED Viewed

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

package/src/PredefinedConfig/Common/AdaptablePredicate.d.ts CHANGED Viewed

@@ -6,11 +6,11 @@ import { BaseContext } from './BaseContext';
 /**
  * Predicate object used by AdapTableQL - essentially a boolean function
  */
-export interface AdaptablePredicate {
+export interface AdaptablePredicate<PREDICATE_TYPE = string> {
     /**
      * Id of Predicate (e.g. `Equals`, `GreaterThan`)
      */
-    PredicateId: string;
+    PredicateId: PREDICATE_TYPE;
     /**
      * Optional Inputs that might be needed for evaluation
      */
@@ -28,11 +28,11 @@ export interface AdaptableColumnPredicate extends AdaptablePredicate {
 /**
  * Defines a Predicate - include where it can run and what it does
  */
-export interface AdaptablePredicateDef {
+export interface AdaptablePredicateDef<PREDICATE_TYPE = string> {
     /**
-     * Unique Id for the object
+     * Predicate Id
      */
-    id: string;
+    id: PREDICATE_TYPE;
     /**
      * Name of the Predicate
      */