@adaptabletools/adaptable-react-aggrid 23.0.4 → 23.0.5-canary.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable-react-aggrid",
-  "version": "23.0.4",
+  "version": "23.0.5-canary.0",
   "description": "React version of AdapTable - the powerful data-agnostic HTML5 AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements",
   "keywords": [],
   "license": "contact sales@adaptabletools.com for details",
@@ -8,7 +8,7 @@
   "dependencies": {
     "tslib": "^2.8.1",
     "react-redux": "9.2.0",
-    "@adaptabletools/adaptable": "23.0.4"
+    "@adaptabletools/adaptable": "23.0.5-canary.0"
   },
   "peerDependencies": {
     "ag-grid-enterprise": ">=35.3.0",

package/src/components/AdaptableProvider.js

@@ -10,7 +10,6 @@ const PLACEHOLDER_REDUX_STORE = {
     getState: () => ({}),
     subscribe: () => {
         return () => {
-            /* noop unsubscribe */
         };
     },
     dispatch: (a) => a,
@@ -22,7 +21,6 @@ var AdaptableAgGridStateTransitions;
     AdaptableAgGridStateTransitions["INITIALIZE_AG_GRID"] = "INITIALIZE_AG_GRID";
 })(AdaptableAgGridStateTransitions || (AdaptableAgGridStateTransitions = {}));
 const agGridPropertySet = new Set(_GET_ALL_GRID_OPTIONS());
-// -- ADAPTABLE PROVIDER -
 const AdaptableAgGridContext = React.createContext(null);
 export const useAdaptableAgGridContext = () => {
     const context = React.useContext(AdaptableAgGridContext);
@@ -50,8 +48,6 @@ function usePromise() {
 const AdaptableProvider = (props) => {
     const [currentTransition, setCurrentTransition] = React.useState(AdaptableAgGridStateTransitions.AG_GRID_EMIT_PROPS);
     const useIdResult = useId();
-    // Stable for the lifetime of this Provider — must not change when adaptableOptions
-    // is recreated on parent re-render (e.g. inline object literals in JSX).
     const idRef = React.useRef(null);
     if (idRef.current === null) {
         idRef.current = `${props.adaptableOptions.adaptableId || 'adaptable'}-${useIdResult}`;
@@ -76,15 +72,8 @@ const AdaptableProvider = (props) => {
         setCurrentTransition(AdaptableAgGridStateTransitions.INITIALIZE_AG_GRID);
         return gridApiPromise;
     }, [gridApiPromise]);
-    // this is a check to make sure the user is rendering Adaptable.AgGridReact inside Adaptable.Provider
-    // and not AgGridReact directly
-    // we're waiting 1s for this to happen
     React.useEffect(() => {
         const timeoutId = setTimeout(() => {
-            // this ref is updated in setAgridProps function in the context
-            // which is called by the Adaptable.AgGridReact component on mount
-            // so if this has not been updated, it means the user is not rendering Adaptable.AgGridReact
-            // so we show an error in the console and link to the docs
             if (!adaptableAgGridReactRenderedRef.current) {
                 console.error('You are not rendering <Adaptable.AgGridReact /> inside <Adaptable.Provider />.');
                 console.error('You are probably rendering <AgGridReact /> directly. Please use <Adaptable.AgGridReact /> instead.');
@@ -111,17 +100,14 @@ const AdaptableProvider = (props) => {
             setAgGridProps: (agGridProps) => {
                 adaptableAgGridReactRenderedRef.current = true;
                 setAgGridProps(agGridProps);
-                // get props and add the to gridOptions
                 const newGridOptions = {
                     ...gridOptions,
                     ...agGridProps,
                 };
-                // Check null or undefined
                 if (newGridOptions.reactiveCustomComponents == null) {
                     newGridOptions.reactiveCustomComponents = true;
                 }
                 setGridOptions(newGridOptions);
-                // Adaptable has everything it needs to initialize
                 setCurrentTransition(AdaptableAgGridStateTransitions.INITIALIZE_ADAPTABLE);
             },
             adaptableProps: {
@@ -131,15 +117,12 @@ const AdaptableProvider = (props) => {
         }, children: _jsx(ReduxProvider, { store: adaptableApi?.internalApi.getAdaptableInstance()?.adaptableStore?.TheStore ??
                 PLACEHOLDER_REDUX_STORE, children: props.children }) }));
 };
-// -- ADAPTABLE UI WRAPPER -
 const AdaptableUI = (props) => {
     const { adaptableProps, modules, gridOptions, transition, onAdaptableReady } = useAdaptableAgGridContext();
     if (transition === AdaptableAgGridStateTransitions.AG_GRID_EMIT_PROPS) {
         return null;
     }
-    return (_jsx(AdaptableReactComponent
-    // This needs to be first, so gridOptions is the one passed and not from props
-    , { ...adaptableProps, onAdaptableReady: onAdaptableReady, style: props.style, className: props.className, gridOptions: gridOptions, modules: modules }));
+    return (_jsx(AdaptableReactComponent, { ...adaptableProps, onAdaptableReady: onAdaptableReady, style: props.style, className: props.className, gridOptions: gridOptions, modules: modules }));
 };
 const readyAGGridAdaptableInstances = new Map();
 const destroyCalledInstances = new Map();
@@ -181,7 +164,6 @@ const AdaptableAgGridReact = (props) => {
     const agGridPassThroughProps = React.useMemo(() => {
         return LIST_OF_PROPS_NOT_ON_GRID_OPTIONS.reduce((acc, key) => {
             if (key in props) {
-                // @ts-ignore
                 acc[key] = props[key];
             }
             return acc;
@@ -191,7 +173,6 @@ const AdaptableAgGridReact = (props) => {
         return null;
     }
     return (_jsx(AgGridReact, { ref: agGridRef, ...agGridPassThroughProps, modules: modules, onGridReady: (event) => {
-            // this is not called extra in strict mode
             setAgGridApi(event.api);
             if (props.onGridReady) {
                 props.onGridReady(event);
@@ -202,30 +183,17 @@ const AdaptableAgGridReact = (props) => {
             setAgGridIsReady(true);
             readyAGGridAdaptableInstances.set(id, true);
         }, onGridPreDestroyed: () => {
-            // this is extra called in strict mode
-            // when doing the double render
-            // when we are in strict mode,
-            // if gridPreDestroyed is called the second time
-            // then we know it's a real destroy
             if (destroyCalledInstances.get(id) === true) {
-                // so go ahead and reject the promise
                 gridApiPromiseReject('ag grid destroy');
                 destroyCalledInstances.delete(id);
                 return;
             }
             destroyCalledInstances.set(id, true);
             if (readyAGGridAdaptableInstances.get(id) === true) {
-                // in strict mode, gridPreDestroyed is called extra on mount, before the onGridReady
-                // so if the instance is ready, we know it's a real destroy, not due to strict mode
-                // so we can reject the promise
                 readyAGGridAdaptableInstances.delete(id);
                 gridApiPromiseReject('ag grid destroy');
             }
             else {
-                // STILL, we might have an exception
-                // when strict mode is not enabled,
-                // then we really need to destroy the instance
-                // but we'll only do this if the instance is not in readyAGGridAdaptableInstances
                 setTimeout(() => {
                     if (!readyAGGridAdaptableInstances.get(id)) {
                         gridApiPromiseReject('ag grid destroy');

package/src/components/AdaptableReact.js

@@ -25,18 +25,6 @@ const AdaptableReact = ({ adaptableOptions, gridOptions, onAdaptableReady, ...pr
                 destroyAgGrid: false,
             });
             adaptableApiRef.current = null;
-            // We fully tore down a *ready* instance — i.e. a real unmount such as
-            // navigation or an HMR / Fast Refresh update (where the container is
-            // remounted but `id`, derived from `useId()`, stays the same). Clear the
-            // module-level guards so the instance is recreated when the container
-            // mounts again. Without this, `isInstanceStarted(id)` stays `true` and
-            // the destroyed instance is never replaced, leaving components holding a
-            // null api.
-            //
-            // In React StrictMode the transient unmount happens *before* the instance
-            // becomes ready, so `successInstances.get(id)` is not yet `true` and this
-            // branch is skipped — preserving the single in-flight init (no double
-            // initialization).
             startedInstances.delete(id);
             successInstances.delete(id);
         }
@@ -69,7 +57,6 @@ const AdaptableReact = ({ adaptableOptions, gridOptions, onAdaptableReady, ...pr
         })
             .then((api) => {
             adaptableApiRef.current = api;
-            //see #no_additional_react_root
             setAdaptableJSXElement(api.internalApi.getAdaptableJSXElement());
             if (onAdaptableReady) {
                 api.eventApi.on('AdaptableReady', onAdaptableReady);

package/src/index.js

@@ -1,9 +1,5 @@
-// export { default } from './components/AdaptableReact';
 import { AdaptableReactDateEditor, AdaptableReactNumberEditor, AdaptableReactPercentageEditor } from '@adaptabletools/adaptable';
 export * from '@adaptabletools/adaptable';
-// we want to shadow the `AdaptableNumberEditor`,
-//  `AdaptablePercentageEditor`, and `AdaptableDateEditor` from `@adaptabletools/adaptable`
-// and pass the react variants for those editors
 export const AdaptableNumberEditor = AdaptableReactNumberEditor;
 export const AdaptablePercentageEditor = AdaptableReactPercentageEditor;
 export const AdaptableDateEditor = AdaptableReactDateEditor;