@adaptabletools/adaptable 14.0.0-canary.1 → 14.0.0-canary.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "14.0.0-canary.1",
+  "version": "14.0.0-canary.2",
   "description": "Powerful data-agnostic HTML5 AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements",
   "keywords": [
     "web-components",

package/publishTimestamp.d.ts

@@ -1,2 +1,2 @@
-declare const _default: 1671464671709;
+declare const _default: 1671469051327;
 export default _default;

package/publishTimestamp.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = 1671464671709;
+exports.default = 1671469051327;

package/src/Api/AdaptableApi.d.ts

@@ -39,6 +39,7 @@ import { ChartingApi } from './ChartingApi';
 import { SettingsPanelApi } from './SettingsPanelApi';
 import { StatusBarApi } from './StatusBarApi';
 import { StyledColumnApi } from './StyledColumnApi';
+import { OptionsApi } from './OptionsApi';
 /**
  *
  * The `AdaptableApi` provides developers with run-time access to AdapTable.
@@ -46,6 +47,10 @@ import { StyledColumnApi } from './StyledColumnApi';
  * Has a huge number of classes each dedicated to a specific AdapTable Module or functionality
  */
 export interface AdaptableApi {
+    /**
+     * Provides access to the Adaptable Options
+     */
+    optionsApi: OptionsApi;
     /**
      * Provides access to Action Rows and Columns
      */
@@ -151,7 +156,7 @@ export interface AdaptableApi {
      */
     queryApi: QueryApi;
     /**
-     * Mangages AdapTableQL (Query Language)
+     * Manages AdapTableQL (Query Language)
      */
     queryLanguageApi: QueryLanguageApi;
     /**
@@ -178,6 +183,9 @@ export interface AdaptableApi {
      * Provides access to the Smart Edit Module
      */
     smartEditApi: SmartEditApi;
+    /**
+     * Provides access to the Styled Column Module
+     */
     styledColumnApi: StyledColumnApi;
     /**
      * Methods related to displaying System Status and application health messages

package/src/Api/ConfigApi.d.ts

@@ -22,11 +22,7 @@ import { QueryState } from '../PredefinedConfig/QueryState';
  */
 export interface ConfigApi {
     /**
-     * Initialised Adaptable State (for internal use only)
-     */
-    configInit(): void;
-    /**
-     * Changes the key used for persisting the Adaptablestate into localStorage
+     * Changes the key used for persisting the AdaptableState into localStorage
      * @param adaptableStateKey key for persisting the AdaptableState into localStorage
      */
     setAdaptableStateKey(adaptableStateKey: string, config?: {

package/src/Api/Implementation/AdaptableApiImpl.d.ts

@@ -1,6 +1,6 @@
 import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
 import { AdaptableInternalApi } from '../Internal/AdaptableInternalApi';
-import { AdaptableApi, SettingsPanelApi } from '../../types';
+import { AdaptableApi, OptionsApi, SettingsPanelApi } from '../../types';
 import { AlertApi } from '../AlertApi';
 import { BulkUpdateApi } from '../BulkUpdateApi';
 import { CalendarApi } from '../CalendarApi';
@@ -44,6 +44,7 @@ import { StyledColumnApi } from '../StyledColumnApi';
 export declare class AdaptableApiImpl implements AdaptableApi {
     protected adaptable: IAdaptable;
     internalApi: AdaptableInternalApi;
+    optionsApi: OptionsApi;
     actionApi: ActionApi;
     applicationApi: ApplicationApi;
     alertApi: AlertApi;

package/src/Api/Implementation/AdaptableApiImpl.js

@@ -43,11 +43,13 @@ const ActionApiImpl_1 = require("./ActionApiImpl");
 const StyledColumnApiImpl_1 = require("./StyledColumnApiImpl");
 const CalendarApiImpl_1 = require("./CalendarApiImpl");
 const EntitlementApiImpl_1 = require("./EntitlementApiImpl");
+const OptionsApiImpl_1 = require("./OptionsApiImpl");
 class AdaptableApiImpl {
     constructor(adaptable) {
         this.adaptable = adaptable;
         this.destroyed = false;
         this.adaptable = adaptable;
+        this.optionsApi = new OptionsApiImpl_1.OptionsApiImpl(adaptable);
         this.actionApi = new ActionApiImpl_1.ActionApiImpl(adaptable);
         this.applicationApi = new ApplicationApiImpl_1.ApplicationApiImpl(adaptable);
         this.alertApi = new AlertApiImpl_1.AlertApiImpl(adaptable);
@@ -101,6 +103,7 @@ class AdaptableApiImpl {
         }
         this.destroyed = true;
         this.eventApi.destroy();
+        this.optionsApi = null;
         this.alertApi = null;
         this.applicationApi = null;
         this.bulkUpdateApi = null;

package/src/Api/Implementation/ApiBase.d.ts

@@ -7,7 +7,7 @@ import { ModuleInfo } from '../../Strategy/Interface/IModule';
 import { AdaptableOptions } from '../../AdaptableOptions/AdaptableOptions';
 import { AdaptableApi } from '../AdaptableApi';
 import { ExportOptions } from '../../AdaptableOptions/ExportOptions';
-import { ActionApi, ActionOptions, AlertApi, ApplicationApi, BulkUpdateApi, CalculatedColumnApi, CalendarApi, CellSummaryApi, ChartingApi, ColumnApi, ConfigApi, ContainerOptions, CustomSortApi, DashboardApi, DashboardOptions, DataChangeHistoryApi, DataSetApi, EditOptions, EntitlementApi, EventApi, ExportApi, FilterApi, FilterOptions, FlashingCellApi, FormatColumnApi, FreeTextColumnApi, GeneralOptions, GridApi, LayoutApi, LayoutAssociatedObject, LayoutOptions, MenuOptions, PluginsApi, PlusMinusApi, PredicateApi, QueryApi, QueryLanguageApi, QuickSearchApi, ScheduleApi, ScopeApi, SearchOptions, SettingsPanelApi, ShortcutApi, SmartEditApi, StateOptions, StatusBarApi, StyledColumnApi, SystemStatusApi, TeamSharingApi, TeamSharingOptions, ThemeApi, ToolPanelApi, UserInterfaceApi, UserInterfaceOptions } from '../../types';
+import { ActionApi, ActionOptions, AlertApi, ApplicationApi, BulkUpdateApi, CalculatedColumnApi, CalendarApi, CellSummaryApi, ChartingApi, ChartingOptions, ColumnApi, ConfigApi, ContainerOptions, CustomSortApi, DashboardApi, DashboardOptions, DataChangeHistoryApi, DataChangeHistoryOptions, DataSetApi, EditOptions, EntitlementApi, EntitlementOptions, EventApi, ExportApi, FilterApi, FilterOptions, FlashingCellApi, FlashingCellOptions, FormatColumnApi, FreeTextColumnApi, GeneralOptions, GridApi, LayoutApi, LayoutAssociatedObject, LayoutOptions, MenuOptions, PluginsApi, PlusMinusApi, PredicateApi, QueryApi, QueryLanguageApi, QuickSearchApi, ScheduleApi, ScopeApi, SearchOptions, SettingsPanelApi, SettingsPanelOptions, ShortcutApi, SmartEditApi, StateOptions, StatusBarApi, StyledColumnApi, SystemStatusApi, TeamSharingApi, TeamSharingOptions, ThemeApi, ToolPanelApi, UserInterfaceApi, UserInterfaceOptions } from '../../types';
 import { NotificationsOptions } from '../../AdaptableOptions/NotificationsOptions';
 import { ToolPanelOptions } from '../../AdaptableOptions/ToolPanelOptions';
 import { ModuleParams } from '../../View/Components/SharedProps/ModuleViewPopupProps';
@@ -70,6 +70,11 @@ export declare abstract class ApiBase {
     protected getUserInterfaceOptions(): UserInterfaceOptions;
     protected getToolPanelOptions(): ToolPanelOptions;
     protected getExpressionOptions(): ExpressionOptions;
+    protected getChartingOptions(): ChartingOptions;
+    protected getDataChangeHistoryOptions(): DataChangeHistoryOptions;
+    protected getEntitlementOptions(): EntitlementOptions;
+    protected getFlashingCellOptions(): FlashingCellOptions;
+    protected getSettingsPanelOptions(): SettingsPanelOptions;
     protected getAdaptableApi(): AdaptableApi;
     protected getActionApi(): ActionApi;
     protected getApplicationApi(): ApplicationApi;

package/src/Api/Implementation/ApiBase.js

@@ -139,6 +139,21 @@ class ApiBase {
     getExpressionOptions() {
         return this.getAdaptableQLOptions().expressionOptions;
     }
+    getChartingOptions() {
+        return this.adaptable.adaptableOptions.chartingOptions;
+    }
+    getDataChangeHistoryOptions() {
+        return this.adaptable.adaptableOptions.dataChangeHistoryOptions;
+    }
+    getEntitlementOptions() {
+        return this.adaptable.adaptableOptions.entitlementOptions;
+    }
+    getFlashingCellOptions() {
+        return this.adaptable.adaptableOptions.flashingCellOptions;
+    }
+    getSettingsPanelOptions() {
+        return this.adaptable.adaptableOptions.settingsPanelOptions;
+    }
     getAdaptableApi() {
         return this.adaptable.api;
     }

package/src/Api/Implementation/ConfigApiImpl.d.ts

@@ -17,7 +17,7 @@ import { FreeTextColumnState } from '../../PredefinedConfig/FreeTextColumnState'
 import { ToolPanelState } from '../../PredefinedConfig/ToolPanelState';
 import { ConfigApi } from '../ConfigApi';
 import { AdaptableModule, AdaptableStateKey } from '../../PredefinedConfig/Common/Types';
-import { AdaptableSearchState, AdaptableSortState, ScheduleState } from '../../types';
+import { AdaptableOptions, AdaptableSearchState, AdaptableSortState, ScheduleState } from '../../types';
 import { QueryState } from '../../PredefinedConfig/QueryState';
 import { PredefinedConfig } from '../../PredefinedConfig/PredefinedConfig';
 import { ChartingState } from '../../PredefinedConfig/ChartingState';
@@ -35,6 +35,7 @@ export declare class ConfigApiImpl extends ApiBase implements ConfigApi {
     }): void;
     getAdaptableSearchState(): AdaptableSearchState;
     getAdaptableSortState(): AdaptableSortState;
+    getAdaptableOptions(): Readonly<AdaptableOptions>;
     setAdaptableStateKey(adaptableStateKey: string, config?: {
         predefinedConfig: PredefinedConfig;
         flushCurrentState?: boolean;

package/src/Api/Implementation/ConfigApiImpl.js

@@ -113,6 +113,9 @@ class ConfigApiImpl extends ApiBase_1.ApiBase {
         };
         return adaptableSortState;
     }
+    getAdaptableOptions() {
+        return undefined;
+    }
     setAdaptableStateKey(adaptableStateKey, config) {
         return new Promise((resolve, reject) => {
             this.adaptable.api.internalApi.executeWithProgressIndicator(`Initialising...`, () => {

package/src/Api/Implementation/OptionsApiImpl.d.ts

@@ -0,0 +1,36 @@
+import { ApiBase } from './ApiBase';
+import { GridOptions } from '@ag-grid-community/core';
+import { ActionOptions, AdaptableOptions, AdaptableQLOptions, AlertOptions, ChartingOptions, ColumnOptions, ContainerOptions, DashboardOptions, DataChangeHistoryOptions, EditOptions, EntitlementOptions, ExportOptions, FilterOptions, FlashingCellOptions, GeneralOptions, LayoutOptions, MenuOptions, NotificationsOptions, OptionsApi, SearchOptions, SettingsPanelOptions, StateOptions, TeamSharingOptions, ToolPanelOptions, UserInterfaceOptions } from '../../types';
+export declare class OptionsApiImpl extends ApiBase implements OptionsApi {
+    getAdaptableId(): string;
+    getAdaptableStateKey(): string;
+    getAgGridOptions(): GridOptions;
+    getAutogeneratePrimaryKey(): boolean;
+    getLicenseKey(): string;
+    getPrimaryKey(): string;
+    getUserName(): string;
+    getAdaptableOptions(): AdaptableOptions;
+    getActionOptions(): ActionOptions;
+    getColumnOptions(): ColumnOptions;
+    getContainerOptions(): ContainerOptions;
+    getNotificationsOptions(): NotificationsOptions;
+    getAlertOptions(): AlertOptions;
+    getDashboardOptions(): DashboardOptions;
+    getEditOptions(): EditOptions;
+    getExportOptions(): ExportOptions;
+    getGeneralOptions(): GeneralOptions;
+    getLayoutOptions(): LayoutOptions;
+    getMenuOptions(): MenuOptions;
+    getFilterOptions(): FilterOptions;
+    getAdaptableQLOptions(): AdaptableQLOptions;
+    getSearchOptions(): SearchOptions;
+    getStateOptions(): StateOptions;
+    getTeamSharingOptions(): TeamSharingOptions;
+    getUserInterfaceOptions(): UserInterfaceOptions;
+    getToolPanelOptions(): ToolPanelOptions;
+    getChartingOptions(): ChartingOptions;
+    getDataChangeHistoryOptions(): DataChangeHistoryOptions;
+    getEntitlementOptions(): EntitlementOptions;
+    getFlashingCellOptions(): FlashingCellOptions;
+    getSettingsPanelOptions(): SettingsPanelOptions;
+}

package/src/Api/Implementation/OptionsApiImpl.js

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OptionsApiImpl = void 0;
+const ApiBase_1 = require("./ApiBase");
+class OptionsApiImpl extends ApiBase_1.ApiBase {
+    getAdaptableId() {
+        return this.adaptable.adaptableOptions.adaptableId;
+    }
+    getAdaptableStateKey() {
+        return this.adaptable.adaptableOptions.adaptableStateKey;
+    }
+    getAgGridOptions() {
+        return this.adaptable.adaptableOptions.gridOptions;
+    }
+    getAutogeneratePrimaryKey() {
+        return this.adaptable.adaptableOptions.autogeneratePrimaryKey;
+    }
+    getLicenseKey() {
+        return this.adaptable.adaptableOptions.licenseKey;
+    }
+    getPrimaryKey() {
+        return this.adaptable.adaptableOptions.primaryKey;
+    }
+    getUserName() {
+        return this.adaptable.adaptableOptions.userName;
+    }
+    getAdaptableOptions() {
+        return this.getOptions();
+    }
+    getActionOptions() {
+        return this.getOptions().actionOptions;
+    }
+    getColumnOptions() {
+        return this.getOptions().columnOptions;
+    }
+    getContainerOptions() {
+        return this.getOptions().containerOptions;
+    }
+    getNotificationsOptions() {
+        return this.getOptions().notificationsOptions;
+    }
+    getAlertOptions() {
+        return this.getOptions().alertOptions;
+    }
+    getDashboardOptions() {
+        return this.getOptions().dashboardOptions;
+    }
+    getEditOptions() {
+        return this.getOptions().editOptions;
+    }
+    getExportOptions() {
+        return this.getOptions().exportOptions;
+    }
+    getGeneralOptions() {
+        return this.getOptions().generalOptions;
+    }
+    getLayoutOptions() {
+        return this.getOptions().layoutOptions;
+    }
+    getMenuOptions() {
+        return this.getOptions().menuOptions;
+    }
+    getFilterOptions() {
+        return this.getOptions().filterOptions;
+    }
+    getAdaptableQLOptions() {
+        return this.getOptions().adaptableQLOptions;
+    }
+    getSearchOptions() {
+        return this.getOptions().searchOptions;
+    }
+    getStateOptions() {
+        return this.getOptions().stateOptions;
+    }
+    getTeamSharingOptions() {
+        return this.getOptions().teamSharingOptions;
+    }
+    getUserInterfaceOptions() {
+        return this.getOptions().userInterfaceOptions;
+    }
+    getToolPanelOptions() {
+        return this.getOptions().toolPanelOptions;
+    }
+    getChartingOptions() {
+        return this.getOptions().chartingOptions;
+    }
+    getDataChangeHistoryOptions() {
+        return this.getOptions().dataChangeHistoryOptions;
+    }
+    getEntitlementOptions() {
+        return this.getOptions().entitlementOptions;
+    }
+    getFlashingCellOptions() {
+        return this.getOptions().flashingCellOptions;
+    }
+    getSettingsPanelOptions() {
+        return this.getOptions().settingsPanelOptions;
+    }
+}
+exports.OptionsApiImpl = OptionsApiImpl;

package/src/Api/Internal/AdaptableInternalApi.d.ts

@@ -46,11 +46,17 @@ export declare class AdaptableInternalApi extends ApiBase {
     isGridInTreeMode(): boolean;
     getToolbarTitle(): string;
     buildDataChangedInfo(config: Pick<CellDataChangedInfo, 'newValue' | 'oldValue' | 'column' | 'primaryKeyValue' | 'rowNode' | 'trigger'>): CellDataChangedInfo;
+    /**
+     * @deprecated use `OptionsApi.getPrimaryKey()`
+     */
     getPrimaryKey(): any;
     getAdaptableInstance(): IAdaptable;
     getAgGridInstance(): any;
     getPredefinedConfig(): any;
     getState(): AdaptableState;
+    /**
+     * @deprecated use OptionsApi.getAdaptableOptions()
+     */
     getAdaptableOptions(): AdaptableOptions;
     getValidationService(): IValidationService;
     getModuleService(): IModuleService;

package/src/Api/Internal/AdaptableInternalApi.js

@@ -79,6 +79,9 @@ class AdaptableInternalApi extends ApiBase_1.ApiBase {
         var _a;
         return Object.assign(Object.assign({}, config), { rowData: (_a = config.rowNode) === null || _a === void 0 ? void 0 : _a.data, changedAt: Date.now() });
     }
+    /**
+     * @deprecated use `OptionsApi.getPrimaryKey()`
+     */
     getPrimaryKey() {
         return this.adaptable.adaptableOptions.primaryKey;
     }
@@ -94,6 +97,9 @@ class AdaptableInternalApi extends ApiBase_1.ApiBase {
     getState() {
         return this.getAdaptableState();
     }
+    /**
+     * @deprecated use OptionsApi.getAdaptableOptions()
+     */
     getAdaptableOptions() {
         return this.getOptions();
     }

package/src/Api/OptionsApi.d.ts

@@ -0,0 +1,131 @@
+import { GridOptions } from '@ag-grid-community/core';
+import { ActionOptions, AdaptableOptions, AdaptableQLOptions, AlertOptions, ChartingOptions, ColumnOptions, ContainerOptions, DashboardOptions, DataChangeHistoryOptions, EditOptions, EntitlementOptions, ExportOptions, FilterOptions, FlashingCellOptions, GeneralOptions, LayoutOptions, MenuOptions, NotificationsOptions, SearchOptions, SettingsPanelOptions, StateOptions, TeamSharingOptions, ToolPanelOptions, UserInterfaceOptions } from '../types';
+/**
+ * Range of functions to access AdaptableOptions
+ */
+export interface OptionsApi {
+    /**
+     * Returns `AdaptableOptions.adaptableId`
+     */
+    getAdaptableId(): string;
+    /**
+     * Returns `AdaptableOptions.adaptableStateKey`
+     */
+    getAdaptableStateKey(): string;
+    /**
+     * Returns `AdaptableOptions.autogeneratePrimaryKey`
+     */
+    getAutogeneratePrimaryKey(): boolean;
+    /**
+     * Returns `AdaptableOptions.gridOptions`
+     */
+    getAgGridOptions(): GridOptions;
+    /**
+     * Returns `AdaptableOptions.licenseKey`
+     */
+    getLicenseKey(): string;
+    /**
+     * Returns `AdaptableOptions.primaryKey`
+     */
+    getPrimaryKey(): string;
+    /**
+     * Returns `AdaptableOptions.userName`
+     */
+    getUserName(): string;
+    /**
+     * Returns provided `AdaptableOptions`
+     */
+    getAdaptableOptions(): AdaptableOptions;
+    /**
+     * Returns `AdaptableOptions.actionOptions`
+     */
+    getActionOptions(): Readonly<ActionOptions>;
+    /**
+     * Returns `AdaptableOptions.alertOptions`
+     */
+    getAlertOptions(): Readonly<AlertOptions>;
+    /**
+     * Returns `AdaptableOptions.adaptableQLOptions`
+     */
+    getAdaptableQLOptions(): Readonly<AdaptableQLOptions>;
+    /**
+     * Returns `AdaptableOptions.chartingOptions`
+     */
+    getChartingOptions(): Readonly<ChartingOptions>;
+    /**
+     * Returns `AdaptableOptions.containerOptions`
+     */
+    getContainerOptions(): Readonly<ContainerOptions>;
+    /**
+     * Returns `AdaptableOptions.columnOptions`
+     */
+    getColumnOptions(): Readonly<ColumnOptions>;
+    /**
+     * Returns `AdaptableOptions.dashboardOptions`
+     */
+    getDashboardOptions(): Readonly<DashboardOptions>;
+    /**
+     * Returns `AdaptableOptions.dataChangeHistoryOptions`
+     */
+    getDataChangeHistoryOptions(): Readonly<DataChangeHistoryOptions>;
+    /**
+     * Returns `AdaptableOptions.editOptions`
+     */
+    getEditOptions(): Readonly<EditOptions>;
+    /**
+     * Returns `AdaptableOptions.entitlementOptions`
+     */
+    getEntitlementOptions(): Readonly<EntitlementOptions>;
+    /**
+     * Returns `AdaptableOptions.exportOptions`
+     */
+    getExportOptions(): Readonly<ExportOptions>;
+    /**
+     * Returns `AdaptableOptions.filterOptions`
+     */
+    getFilterOptions(): Readonly<FilterOptions>;
+    /**
+     * Returns `AdaptableOptions.flashingCellOptions`
+     */
+    getFlashingCellOptions(): Readonly<FlashingCellOptions>;
+    /**
+     * Returns `AdaptableOptions.generalOptions`
+     */
+    getGeneralOptions(): Readonly<GeneralOptions>;
+    /**
+     * Returns `AdaptableOptions.layoutOptions`
+     */
+    getLayoutOptions(): Readonly<LayoutOptions>;
+    /**
+     * Returns `AdaptableOptions.menuOptions`
+     */
+    getMenuOptions(): Readonly<MenuOptions>;
+    /**
+     * Returns `AdaptableOptions.notificationsOptions`
+     */
+    getNotificationsOptions(): Readonly<NotificationsOptions>;
+    /**
+     * Returns `AdaptableOptions.searchOptions`
+     */
+    getSearchOptions(): Readonly<SearchOptions>;
+    /**
+     * Returns `AdaptableOptions.settingsPanelOptions`
+     */
+    getSettingsPanelOptions(): Readonly<SettingsPanelOptions>;
+    /**
+     * Returns `AdaptableOptions.stateOptions`
+     */
+    getStateOptions(): Readonly<StateOptions>;
+    /**
+     * Returns `AdaptableOptions.teamSharingOptions`
+     */
+    getTeamSharingOptions(): Readonly<TeamSharingOptions>;
+    /**
+     * Returns `AdaptableOptions.toolPanelOptions`
+     */
+    getToolPanelOptions(): Readonly<ToolPanelOptions>;
+    /**
+     * Returns `AdaptableOptions.userInterfaceOptions`
+     */
+    getUserInterfaceOptions(): Readonly<UserInterfaceOptions>;
+}

package/src/Api/OptionsApi.js

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

package/src/metamodel/adaptable.metamodel.d.ts

@@ -4139,6 +4139,17 @@ export declare const ADAPTABLE_METAMODEL: {
         kind: string;
         description: string;
     };
+    OptionsApi: {
+        name: string;
+        kind: string;
+        description: string;
+        properties: {
+            name: string;
+            kind: string;
+            description: string;
+            uiLabel: string;
+        }[];
+    };
     OrganizationColumn: {
         name: string;
         kind: string;