@adaptabletools/adaptable 16.0.1-canary.1 → 16.0.1

package/package.json

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

package/publishTimestamp.js

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

package/src/AdaptableOptions/AdaptablePlugin.js

@@ -25,6 +25,8 @@ class AdaptablePlugin {
         return !!this.values[name];
     }
     // plugin lifecycle methods, executed in this exact order
+    // wondering if this is better? 
+    //  beforeInit(adaptableOptions: AdaptableOptions,   gridOptions: GridOptions): void {}
     beforeInit(adaptableOptions) { }
     afterInitOptions(adaptable, adaptableOptions) { }
     afterInitApi(adaptable, api) { }

package/src/AdaptableOptions/Fdc3Options.d.ts

@@ -10,7 +10,7 @@ import { ButtonStyle } from '../PredefinedConfig/Common/ButtonStyle';
  */
 export interface Fdc3Options {
     /**
-     * Enable logging of message exchanges to Console
+     * Enable logging message exchanges to Console
      *
      * @defaultValue false
      */
@@ -196,6 +196,9 @@ export declare const ColumnRefTypePrefix = "_colId.";
 export declare const FieldRefTypePrefix = "_field.";
 export declare type GridDataRef = `_colId.${string}` | `_field.${string}`;
 export declare type Fdc3ContentMapping<T> = PropertiesToGridRefs<Omit<T, 'type'>>;
+/**
+ * Config used when raising an FDC3 Intent
+ */
 export interface RaiseIntentConfig<K extends Fdc3IntentType = any> {
     contextType: CompatibleContext<K>;
     contextMenu?: {
@@ -210,6 +213,9 @@ export interface RaiseIntentConfig<K extends Fdc3IntentType = any> {
     };
     handleIntentResolution?: (context: HandleFdc3IntentResolutionContext) => Promise<IntentResult>;
 }
+/**
+ * Config used when broadcasting FDC3 Context
+ */
 export interface BroadcastConfig {
     contextMenu?: {
         columnIds: string[];
@@ -256,33 +262,36 @@ export interface Fdc3ButtonContext extends BaseContext {
      */
     primaryKeyValue: any;
 }
+/**
+ * Button used in FDC3 Action Columns
+ */
 export interface Fdc3AdaptableButton {
     /**
      * Unique id for the button
      */
     id: string;
     /**
-     * Icon for Button - can be object or function that provides a `AdaptableIcon` object
+     * Button's Icon; can be object or function that provides `AdaptableIcon` object
      */
     icon?: '_defaultFdc3' | AdaptableIcon | ((button: Fdc3AdaptableButton, context: Fdc3ButtonContext) => AdaptableIcon);
     /**
-     * Label for Button - can be string or function that provides string
+     * Button' Label; can be string or function that provides string
      */
     label?: '_defaultFdc3' | string | ((button: Fdc3AdaptableButton, context: Fdc3ButtonContext) => string);
     /**
-     * Tooltip for Button - can be string or function that provides string
+     * Button's Tooltip; can be string or function that provides string
      */
     tooltip?: '_defaultFdc3' | string | ((button: Fdc3AdaptableButton, context: Fdc3ButtonContext) => string);
     /**
-     * Style for Button - can be object or function that provides a `ButtonStyle` object
+     * Button's Style; can be object or function that provides `ButtonStyle` object
      */
     buttonStyle?: ButtonStyle | ((button: Fdc3AdaptableButton, context: Fdc3ButtonContext) => ButtonStyle);
     /**
-     * Function that disables / enables the button based on its evaluation result
+     * Function to disable / enable button based on evaluation result
      */
     disabled?: (button: Fdc3AdaptableButton, context: Fdc3ButtonContext) => boolean;
     /**
-     * Function which sets whether Button is hidden
+     * Function to hide the Button
      */
     hidden?: (button: Fdc3AdaptableButton, context: Fdc3ButtonContext) => boolean;
 }

package/src/PredefinedConfig/CommentsState.d.ts

@@ -31,6 +31,9 @@ export interface AdaptableComment extends AdaptableObject {
      */
     AdaptableId: string;
 }
+/**
+ * Collection of Cell Comments
+ */
 export declare type AdaptableComments = AdaptableComment[];
 /**
  * Predefined Configuration for Comments Module

package/src/Utilities/Services/ModuleService.js

@@ -100,7 +100,7 @@ class ModuleService {
             case 'Filter':
                 return learnUrl + 'handbook-filtering';
             case 'FlashingCell':
-                return learnUrl + 'handbook-cell-flashing';
+                return learnUrl + 'handbook-flashing-cell';
             case 'FormatColumn':
                 return learnUrl + 'handbook-column-formatting';
             case 'FreeTextColumn':

package/src/agGrid/Adaptable.d.ts

@@ -120,7 +120,7 @@ export declare class Adaptable implements IAdaptable {
      * Initializer for Adaptable
      *
      * @param adaptableOptions the AdaptableOptions
-     * @param runtimeConfig the list of all the provided AG Grid modules (which will be passed to the underlying AG Grid instance)
+     * @param agGridConfig AG Grid
      * @returns a Promise containing the AdaptableAPI object in order to enable run-time access to Adaptable's properties and functions
      */
     static init(adaptableOptions: AdaptableOptions, agGridConfig: AgGridConfig): Promise<AdaptableApi>;

package/src/agGrid/Adaptable.js

@@ -280,7 +280,7 @@ class Adaptable {
      * Initializer for Adaptable
      *
      * @param adaptableOptions the AdaptableOptions
-     * @param runtimeConfig the list of all the provided AG Grid modules (which will be passed to the underlying AG Grid instance)
+     * @param agGridConfig AG Grid
      * @returns a Promise containing the AdaptableAPI object in order to enable run-time access to Adaptable's properties and functions
      */
     static init(adaptableOptions, agGridConfig) {
@@ -308,8 +308,10 @@ class Adaptable {
                 promise =
                     promise && promise.then
                         ? promise.then(() => {
+                            // JW: perhaps?:   return plugin.beforeInit(adaptableOptions, runtimeConfig.gridOptions);
                             return plugin.beforeInit(adaptableOptions);
                         })
+                        // JW: perhaps?   : plugin.beforeInit(adaptableOptions, runtimeConfig.gridOptions);
                         : plugin.beforeInit(adaptableOptions);
             }
             // instead of

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

@@ -334,6 +334,11 @@ export declare const ADAPTABLE_METAMODEL: {
             desc: string;
         }[];
     };
+    AdaptableComments: {
+        name: string;
+        kind: string;
+        desc: string;
+    };
     AdaptableComparerFunction: {
         name: string;
         kind: string;
@@ -1278,6 +1283,11 @@ export declare const ADAPTABLE_METAMODEL: {
             ref: string;
         }[];
     };
+    BroadcastConfig: {
+        name: string;
+        kind: string;
+        desc: string;
+    };
     BulkUpdatePermittedValues: {
         name: string;
         kind: string;
@@ -2609,6 +2619,22 @@ export declare const ADAPTABLE_METAMODEL: {
             desc: string;
         }[];
     };
+    Fdc3AdaptableButton: {
+        name: string;
+        kind: string;
+        desc: string;
+        props: ({
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt?: undefined;
+        })[];
+    };
     Fdc3ButtonContext: {
         name: string;
         kind: string;
@@ -3881,6 +3907,11 @@ export declare const ADAPTABLE_METAMODEL: {
             ref: string;
         })[];
     };
+    RaiseIntentConfig: {
+        name: string;
+        kind: string;
+        desc: string;
+    };
     RangeValueType: {
         name: string;
         kind: string;