@adaptabletools/adaptable 15.0.0-canary.5 → 15.0.0-canary.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "15.0.0-canary.5",
+  "version": "15.0.0-canary.7",
   "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: 1676380997995;
+declare const _default: 1676552062102;
 export default _default;

package/publishTimestamp.js

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

package/src/AdaptableOptions/ExportOptions.d.ts

@@ -58,6 +58,9 @@ export interface ExportOptions {
      */
     isColumnExportable?: (exportableColumnContext: ExportableColumnContext) => boolean;
 }
+/**
+ * Format of exported Data - 'rawValue' or 'formattedValue'
+ */
 export declare type DataFormatType = 'rawValue' | 'formattedValue';
 /**
  * Defines a Report where all the data is provided entirely by the user

package/src/AdaptableOptions/FinsemblePluginOptions.d.ts

@@ -16,6 +16,9 @@ export interface FinsemblePluginOptions {
      */
     showAdaptableAlertsAsNotifications?: boolean;
 }
+/**
+ * Options for managing state while using Finsemble
+ */
 export interface FinsemblePluginStateOptions {
     /**
      * Whether to persist AdapTable State inside Finsemble

package/src/AdaptableOptions/MasterDetailPluginOptions.d.ts

@@ -12,5 +12,8 @@ export interface MasterDetailPluginOptions {
      */
     onDetailInit?: (context: DetailInitContext) => void;
 }
+/**
+ * Context passed to Detail Grids when using Master Detail
+ */
 export interface DetailInitContext extends BaseContext {
 }

package/src/AdaptableOptions/PredicateOptions.d.ts

@@ -20,6 +20,9 @@ export interface PredicateOptions {
      */
     systemFlashingCellPredicates?: SystemFlashingCellPredicateIds | ((context: SystemPredicatesContext) => SystemFlashingCellPredicateIds);
 }
+/**
+ * Context used for setting which System Predicates are available
+ */
 export interface SystemPredicatesContext extends BaseContext {
     /**
      * AdapTable-provided System Predicate Definitions

package/src/AdaptableOptions/SettingsPanelOptions.d.ts

@@ -1,6 +1,9 @@
 import { AdaptableFrameworkComponent, AdaptableIcon } from '../../types';
 import { AdaptableSettingsPanel } from '../PredefinedConfig/Common/Types';
 import { CustomRenderContext } from './AdaptableFrameworkComponent';
+/**
+ * Options for managing the AdapTable Settings Panel
+ */
 export interface SettingsPanelOptions {
     /**
      * Title for the Settings Panel

package/src/AdaptableOptions/TeamSharingOptions.d.ts

@@ -12,23 +12,23 @@ export interface TeamSharingOptions {
      */
     enableTeamSharing: boolean;
     /**
-     * Async function which loads available Shared Entities that user can download and merge automatically with Adaptable State
+     * (Async) Loads available Shared Entities - user can download and auto-merge with Adaptable State
      *
      * @defaultValue null
      */
     loadSharedEntities: (context: SharedEntitiesContext) => Promise<SharedEntity[]>;
     /**
-     * Allows hooking into Shared Entities loading process. If defined, it will be invoked with the result of the `loadSharedEntities()` method invocation, and the result will be passed to Adaptable State.
+     * Allows hooking into Shared Entities loading process
      */
     applySharedEntities?: (sharedEntities: SharedEntity[], context: SharedEntitiesContext) => SharedEntity[];
     /**
-     * Async function which persists Shared Entities so that they can be downloaded by other team members
+     * (Async) Persists Shared Entities so that they can be downloaded by other team members
      *
      * @defaultValue null
      */
     persistSharedEntities: (sharedEntities: SharedEntity[], context: SharedEntitiesContext) => Promise<void>;
     /**
-     * Allows customization of Shared Entities persistence process. If defined, it will be invoked before `persistSharedEntities()`, and `persistSharedEntities()` will be invoked with the result of this method.
+     * Allows hooking into Shared Entities persistence process
      */
     saveSharedEntities?: (sharedEntities: SharedEntity[], context: SharedEntitiesContext) => SharedEntity[];
     /**
@@ -51,7 +51,7 @@ export interface TeamSharingOptions {
     updateNotification?: 'Alert' | 'AlertWithNotification' | 'SystemStatus';
 }
 /**
- * The context provided to the `TeamSharingOptions.loadSharedEntities()` callback
+ * Context provided to `TeamSharingOptions.loadSharedEntities()` callback
  */
 export interface SharedEntitiesContext extends BaseContext {
     /**

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

@@ -31,4 +31,5 @@ export declare class StyledColumnApiImpl extends ApiBase implements StyledColumn
     canDisplaySparklines(): boolean;
     suspendStyledColumn(styledColumn: StyledColumn): void;
     unSuspendStyledColumn(styledColumn: StyledColumn): void;
+    openStyledColumnSettingsPanel(): void;
 }

package/src/Api/Implementation/StyledColumnApiImpl.js

@@ -7,6 +7,7 @@ const StyledColumnRedux = tslib_1.__importStar(require("../../Redux/ActionsReduc
 const Helper_1 = tslib_1.__importDefault(require("../../Utilities/Helpers/Helper"));
 const StyledColumnInternalApi_1 = require("../Internal/StyledColumnInternalApi");
 const logDeprecation_1 = require("../../Utilities/logDeprecation");
+const ModuleConstants = tslib_1.__importStar(require("../../Utilities/Constants/ModuleConstants"));
 class StyledColumnApiImpl extends ApiBase_1.ApiBase {
     constructor(adaptable) {
         super(adaptable);
@@ -107,5 +108,8 @@ class StyledColumnApiImpl extends ApiBase_1.ApiBase {
     unSuspendStyledColumn(styledColumn) {
         this.dispatchAction(StyledColumnRedux.StyledColumnUnSuspend(styledColumn));
     }
+    openStyledColumnSettingsPanel() {
+        this.showModulePopup(ModuleConstants.StyledColumnModuleId);
+    }
 }
 exports.StyledColumnApiImpl = StyledColumnApiImpl;

package/src/Api/StyledColumnApi.d.ts

@@ -91,6 +91,10 @@ export interface StyledColumnApi {
      * @param column Column to check
      */
     getActiveStyledColumnForColumn(column: AdaptableColumn): StyledColumn | undefined;
+    /**
+     * Open Styled Column section of Settings Panel
+     */
+    openStyledColumnSettingsPanel(): void;
     /**
      * TO BE REMOVED
      */

package/src/Api/TeamSharingApi.d.ts

@@ -6,17 +6,17 @@ import { AdaptableModule, AdaptableSharedEntityConfig } from '../types';
  */
 export interface TeamSharingApi {
     /**
-     * Retrieves all shared entities which are currently shared. It is an asynchronous operation as it leverages the `TeamSharingOptions.loadSharedEntities(...)` method.
+     * Retrieves all currently shared entities; async operation leveraging `TeamSharingOptions.loadSharedEntities(...)` method
      */
     loadSharedEntities(): Promise<SharedEntity[]>;
     /**
-     * Sets the shared entities which are currently shared. It is an asynchronous operation as it leverages the `TeamSharingOptions.persistSharedEntities(...)` method.
+     * Sets currently shared entities; async operation leveraging `TeamSharingOptions.persistSharedEntities(...)` method
      * @param sharedEntities the shared entities
      * @return either TRUE if the shared entities were successfully set or FALSE if the shared entities were not set
      */
     persistSharedEntities(sharedEntities: SharedEntity[]): Promise<boolean>;
     /**
-     * Whether Team Sharing is Available to use
+     * Whether Team Sharing is available to use
      */
     isTeamSharingAvailable(): boolean;
     /**
@@ -50,13 +50,13 @@ export interface TeamSharingApi {
      */
     unshareEntity(entityId: string): void;
     /**
-     * Import shared entry.
+     * Import the given Shared Entity. In case of `CustomSharedEntity`, the import logic will be delegated to `TeamSharingOptions.handleCustomSharedEntityImport(...)`.
      *
      * @param sharedEntity shared entry to import
      */
     importSharedEntry(sharedEntity: SharedEntity): void;
     /**
-     * Retrieves already loaded shared entries.
+     * Retrieves all locally loaded shared entries (`AdaptableSharedEntity` & `CustomSharedEntity`).
      */
     getLoadedSharedEntities(): SharedEntity[];
     /**
@@ -83,7 +83,7 @@ export interface TeamSharingApi {
      */
     triggerLoadingTeamSharingEntries(): void;
     /**
-     * @deprecated use `loadSharedEntities()` instead
+     * @deprecated use `loadSharedEntities()` instead ()
      */
     getSharedEntities(): Promise<SharedEntity[]>;
     /**

package/src/PredefinedConfig/Common/AggregationColumns.d.ts

@@ -1,6 +1,15 @@
 export declare const WEIGHTED_AVERAGE_AGG_FN_NAME = "weightedAvg";
+/**
+ * Defines a Weighted Average Agg
+ */
 export interface WeightedAverageAggregation {
+    /**
+     * Type is always 'weightedAverage'
+     */
     type: 'weightedAverage';
+    /**
+     * Column which is weighted
+     */
     weightedColumnId: string;
 }
 export declare type AggregationColumns = Record<string, string | true | WeightedAverageAggregation>;

package/src/PredefinedConfig/Common/RowHighlightInfo.d.ts

@@ -1,4 +1,7 @@
 import { AdaptableStyle } from '../../../types';
+/**
+ * Define how to highlight a Row
+ */
 export interface RowHighlightInfo {
     /**
      * Primary key value for the row to be highlighted

package/src/PredefinedConfig/Common/RowsHighlightInfo.d.ts

@@ -1,4 +1,7 @@
 import { AdaptableStyle } from '../../../types';
+/**
+ * Defines how to highlight a set of Rows
+ */
 export interface RowsHighlightInfo {
     /**
      * Primary key valuse for the rows to be highlighted

package/src/PredefinedConfig/ExportState.d.ts

@@ -23,6 +23,9 @@ export interface ExportState extends ConfigState {
      */
     Reports?: Report[];
 }
+/**
+ * A Report which can export data from AdapTable
+ */
 export interface Report extends AdaptableObject {
     /**
      * Name of Report

package/src/PredefinedConfig/FormatColumnState.d.ts

@@ -56,6 +56,9 @@ export interface FormatColumn extends SuspendableObject {
 export declare type FormatColumnRule = XOR<{
     Predicates: FormatColumnPredicate[];
 }, AdaptableBooleanQuery>;
+/**
+ * Predicate used when creating a Format Column
+ */
 export interface FormatColumnPredicate extends AdaptableColumnPredicate {
     PredicateId: TypeHint<string, SystemFormatColumnPredicateId>;
 }

package/src/PredefinedConfig/TeamSharingState.d.ts

@@ -23,15 +23,11 @@ export interface TeamSharingState extends InternalState {
     importProcessInProgress: boolean;
 }
 /**
- * Any object that can be shared.
- */
-declare type ShareableEntity = Record<string, any> & AdaptableObject;
-/**
- * Defines an object used in Team Sharing
+ * Defines an object used in Team Sharing. The union type is discriminated by the `EntityType` property (`adaptableEntity` / `customEntity`).
  */
 export declare type SharedEntity = AdaptableSharedEntity | CustomSharedEntity;
 export declare const isAdaptableSharedEntity: (entity: SharedEntity) => entity is AdaptableSharedEntity;
-export declare const isCustomSharedEntity: (entity: SharedEntity) => entity is CustomSharedEntity;
+export declare const isCustomSharedEntity: (entity: SharedEntity) => entity is CustomSharedEntity<any>;
 /**
  * Defines an AdaptableObject shared with Team Sharing
  */
@@ -43,7 +39,7 @@ export interface AdaptableSharedEntity extends AdaptableObject {
     /**
      * Actual Adaptable Object being shared
      */
-    Entity: ShareableEntity;
+    Entity: AdaptableObject;
     /**
      * Ids of direct entity dependencies
      */
@@ -84,7 +80,7 @@ export interface AdaptableSharedEntity extends AdaptableObject {
 /**
  *
  */
-export interface CustomSharedEntity {
+export interface CustomSharedEntity<T = any> {
     /**
      * Type of shared entity (either Adaptable specific or custom object)
      */
@@ -104,7 +100,7 @@ export interface CustomSharedEntity {
     /**
      * Custom Object being shared
      */
-    Entity: any;
+    Entity: T;
     /**
      * When the object was shared
      */
@@ -121,6 +117,10 @@ export interface CustomSharedEntity {
      * Last time when the object was changed
      */
     ChangedAt: number;
+    /**
+     * Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')
+     */
+    IsReadOnly?: boolean;
     /**
      * List of Tags associated with the Object
      */
@@ -162,6 +162,9 @@ export interface CustomSharedEntityConfig {
      */
     Tags?: AdaptableObjectTag[];
 }
+/**
+ * Type of Shared Entity - Snapshot or Active
+ */
 export declare type SharedEntityType = 'Snapshot' | 'Active';
 export interface TeamSharingImportStep {
     sharedEntity: AdaptableSharedEntity;
@@ -172,4 +175,3 @@ export declare type SharedEntityActiveStatus = Record<TypeUuid, {
     importedRevision: number;
     sharedRevision: number;
 }>;
-export {};

package/src/View/Dashboard/CustomToolbarWrapper.js

@@ -85,7 +85,7 @@ const CustomToolbarWrapper = (props) => {
                 const disabled = button.disabled && button.disabled(button, dashboardContext);
                 let buttonVariant = buttonStyle && buttonStyle.variant ? buttonStyle.variant : 'outlined';
                 let buttonTone = buttonStyle && buttonStyle.tone ? buttonStyle.tone : 'neutral';
-                return (React.createElement(SimpleButton_1.default, { style: { marginLeft: index ? 'var(--ab-space-1)' : 0 }, key: index, disabled: disabled, tooltip: buttonTooltip, icon: buttonIcon, variant: buttonVariant, tone: buttonTone, onClick: () => {
+                return (React.createElement(SimpleButton_1.default, { style: { marginLeft: index ? 'var(--ab-space-1)' : 0 }, key: index, disabled: disabled, tooltip: buttonTooltip, icon: buttonIcon, variant: buttonVariant, tone: buttonTone, className: (buttonStyle === null || buttonStyle === void 0 ? void 0 : buttonStyle.className) || '', onClick: () => {
                         button.onClick ? button.onClick(button, dashboardContext) : null;
                         setTimeout(() => {
                             // mutate state to force a re-rendering

package/src/agGrid/Adaptable.js

@@ -3201,10 +3201,14 @@ class Adaptable {
                     ? this.getFormatColumnCellStyle(abColumn, activeFormatColumnsWithStyle, params)
                     : {})), (styledColumn ? this.getStyledColumnStyle(styledColumn, abColumn, params) : {})), (isQuickSearchActive ? quickSearchStyle : {})), this.getAlertCellStyle(abColumn, params)), this.getFlashingCellStyle(abColumn, params)), this.getCellHighlightStyle(abColumn, params));
                 // remove null values, AG Grid 29 fails, it asumes they are strings
+                // TODO AFL: remove once AG-7903 and AG-7917 are fixed
                 Object.keys(result).forEach((key) => {
                     if (result[key] === null || result[key] === undefined) {
                         delete result[key];
                     }
+                    if (typeof result[key] === 'number') {
+                        result[key] = String(result[key]);
+                    }
                 });
                 return result;
             };

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

@@ -2046,6 +2046,11 @@ export declare const ADAPTABLE_METAMODEL: {
             noCode?: undefined;
         })[];
     };
+    DataFormatType: {
+        name: string;
+        kind: string;
+        desc: string;
+    };
     DataSet: {
         name: string;
         kind: string;
@@ -2117,6 +2122,11 @@ export declare const ADAPTABLE_METAMODEL: {
             desc: string;
         }[];
     };
+    DetailInitContext: {
+        name: string;
+        kind: string;
+        desc: string;
+    };
     EditActionRowFormContext: {
         name: string;
         kind: string;
@@ -2568,6 +2578,16 @@ export declare const ADAPTABLE_METAMODEL: {
             defVal?: undefined;
         })[];
     };
+    FinsemblePluginStateOptions: {
+        name: string;
+        kind: string;
+        desc: string;
+        props: {
+            name: string;
+            kind: string;
+            desc: string;
+        }[];
+    };
     FlashingCellDefinition: {
         name: string;
         kind: string;
@@ -2660,6 +2680,11 @@ export declare const ADAPTABLE_METAMODEL: {
             defVal?: undefined;
         })[];
     };
+    FormatColumnPredicate: {
+        name: string;
+        kind: string;
+        desc: string;
+    };
     FormatColumnRule: {
         name: string;
         kind: string;
@@ -3688,6 +3713,30 @@ export declare const ADAPTABLE_METAMODEL: {
             isOpt?: undefined;
         })[];
     };
+    Report: {
+        name: string;
+        kind: string;
+        desc: string;
+        props: ({
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt?: undefined;
+            ref?: undefined;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+            ref: string;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            ref: string;
+            isOpt?: undefined;
+        })[];
+    };
     ReportColumnScope: {
         name: string;
         kind: string;
@@ -3737,6 +3786,30 @@ export declare const ADAPTABLE_METAMODEL: {
             ref: string;
         })[];
     };
+    RowHighlightInfo: {
+        name: string;
+        kind: string;
+        desc: string;
+        props: ({
+            name: string;
+            kind: string;
+            desc: string;
+            ref: string;
+            isOpt?: undefined;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            ref?: undefined;
+            isOpt?: undefined;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+            ref?: undefined;
+        })[];
+    };
     RowInfo: {
         name: string;
         kind: string;
@@ -3748,6 +3821,30 @@ export declare const ADAPTABLE_METAMODEL: {
             isOpt: boolean;
         }[];
     };
+    RowsHighlightInfo: {
+        name: string;
+        kind: string;
+        desc: string;
+        props: ({
+            name: string;
+            kind: string;
+            desc: string;
+            ref: string;
+            isOpt?: undefined;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            ref?: undefined;
+            isOpt?: undefined;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+            ref?: undefined;
+        })[];
+    };
     Schedule: {
         name: string;
         kind: string;
@@ -3843,6 +3940,44 @@ export declare const ADAPTABLE_METAMODEL: {
             desc: string;
         }[];
     };
+    SettingsPanelOptions: {
+        name: string;
+        kind: string;
+        desc: string;
+        props: ({
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+            gridInfo: string;
+            noCode: string;
+            defVal: string;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+            gridInfo?: undefined;
+            noCode?: undefined;
+            defVal?: undefined;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+            defVal: string;
+            gridInfo?: undefined;
+            noCode?: undefined;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+            gridInfo: string;
+            defVal: string;
+            noCode?: undefined;
+        })[];
+    };
     SharedEntitiesContext: {
         name: string;
         kind: string;
@@ -3858,6 +3993,11 @@ export declare const ADAPTABLE_METAMODEL: {
         kind: string;
         desc: string;
     };
+    SharedEntityType: {
+        name: string;
+        kind: string;
+        desc: string;
+    };
     Shortcut: {
         name: string;
         kind: string;
@@ -4096,6 +4236,22 @@ export declare const ADAPTABLE_METAMODEL: {
         kind: string;
         desc: string;
     };
+    SystemPredicatesContext: {
+        name: string;
+        kind: string;
+        desc: string;
+        props: ({
+            name: string;
+            kind: string;
+            desc: string;
+            ref: string;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            ref?: undefined;
+        })[];
+    };
     SystemReportName: {
         name: string;
         kind: string;
@@ -4339,4 +4495,14 @@ export declare const ADAPTABLE_METAMODEL: {
             isOpt: boolean;
         }[];
     };
+    WeightedAverageAggregation: {
+        name: string;
+        kind: string;
+        desc: string;
+        props: {
+            name: string;
+            kind: string;
+            desc: string;
+        }[];
+    };
 };