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

package/lib/AdaptableAgGridVue.js

@@ -14,34 +14,12 @@ const PASS_THROUGH_PROPS = [
 ];
 const watch = _ALL_GRID_OPTIONS_KEYS.reduce((acc, key) => {
     acc[key] = function (newValue) {
-        /**
-         * We need to unwrap all potential refs inside the new grid option.
-         */
         this.agGridApi.setGridOption(key, deepToRaw(newValue));
     };
     return acc;
 }, {});
 export const AdaptableAgGridVue = defineComponent({
     name: 'adaptable-ag-grid-vue',
-    /**
-     * Ag-Grid Vue only has typings for a few props, of which a few cannot find docs:
-     * - gridOptions
-     * - modules
-     *
-     * Not documented
-     * - componentDependencies
-     * - plugins
-     * - modelValue
-     *
-     * Other props have a flag of 'VUE_OMITTED_PROPERTY', that work, but are not typed.
-     * https://github.com/ag-grid/ag-grid/blob/latest/packages/ag-grid-vue3/src/Utils.ts#L16
-     *
-     * We let pass through:
-     * - class
-     * - style
-     *
-     * The rest we add to gridOptions, and we intercept when they change
-     */
     props: {
         class: {
             type: String,
@@ -51,7 +29,6 @@ export const AdaptableAgGridVue = defineComponent({
             type: [String, Object],
             required: false,
         },
-        // Internal types, that are passed through, defined in ag-grid-vue3.
         modelValue: {
             type: Array,
             default: undefined,
@@ -62,8 +39,6 @@ export const AdaptableAgGridVue = defineComponent({
             default: () => [],
         },
         plugins: [],
-        // These are not defined in AgGridVue typings
-        // But are useful for users to control via props
         columnDefs: {
             type: Array,
             required: false,
@@ -72,11 +47,6 @@ export const AdaptableAgGridVue = defineComponent({
     setup(props) {
         const { class: className, style } = props;
         const { gridOptions, transition, setAgGridProps, setTransition, modules, agGridApi } = inject(AdaptableProviderContextKey);
-        /**
-         * We pick up props that are on gridOptions.
-         * We send these to the the provider, where are added to gridOptions.
-         * These props do not make it to the AgGridVue component.
-         */
         const agGridProps = Object.entries(props).reduce((acc, [key, value]) => {
             if (PASS_THROUGH_PROPS.includes(key)) {
                 return acc;
@@ -105,9 +75,6 @@ export const AdaptableAgGridVue = defineComponent({
         if (this.transition !== AdaptableAgGridStateTransitions.INITIALIZE_AG_GRID) {
             return null;
         }
-        /**
-         * We pass through props that are internal, and adaptable does not use/change.
-         */
         const passedThroughProps = Object.entries(this.$props).reduce((acc, [key, value]) => {
             if (!PASS_THROUGH_PROPS.includes(key)) {
                 return acc;

package/lib/AdaptableProvider.js

@@ -1,9 +1,5 @@
 import { defineComponent, provide, ref } from 'vue';
 import { AdaptableAgGridStateTransitions, AdaptableProviderContextKey, } from './AdaptableProviderContext';
-/**
- * The provider handles the communication between the Adaptable and Ag-Grid.
- * Steps are very similar to the react wrapper.
- */
 export const AdaptableProvider = defineComponent({
     name: 'adaptable-provider',
     props: {
@@ -31,7 +27,6 @@ export const AdaptableProvider = defineComponent({
     },
     setup(props, { emit }) {
         const currentTransition = ref(AdaptableAgGridStateTransitions.AG_GRID_EMIT_PROPS);
-        // destructure gridOptions, to ensure we don't mutate the outer object
         const gridOptions = ref({ ...props.gridOptions });
         const agGridApi = ref(null);
         const agGridProps = ref(null);
@@ -58,7 +53,6 @@ export const AdaptableProvider = defineComponent({
             setTransition: (transition) => {
                 currentTransition.value = transition;
             },
-            // AG GRID
             modules: props.modules,
             gridOptions,
             setGridOptions: (gridOptions) => {
@@ -69,7 +63,6 @@ export const AdaptableProvider = defineComponent({
             setAgGridProps: (props) => {
                 agGridProps.value = props;
             },
-            // ADAPTABLE
             renderAgGridFrameworkComponent,
             onAdaptableReady(adaptableReadyInfo) {
                 emit('onAdaptableReady', adaptableReadyInfo);
@@ -79,9 +72,6 @@ export const AdaptableProvider = defineComponent({
         provide(AdaptableProviderContextKey, context);
     },
     render() {
-        /**
-         * This just renders whatever are passed as children.
-         */
         return this.$slots.default && this.$slots.default();
     },
 });

package/lib/AdaptableUI.js

@@ -1,4 +1,3 @@
-// AdaptableUI.ts
 import { ColumnApiModule } from 'ag-grid-enterprise';
 import { _AdaptableAgGrid, _AdaptableLogger } from '@adaptabletools/adaptable';
 import { defineComponent, h, inject, onMounted, onUnmounted, ref, watch, toRaw } from 'vue';
@@ -22,7 +21,6 @@ export const AdaptableUI = defineComponent({
         const isInitialized = ref(false);
         const initializeAdaptable = async () => {
             if (isInitialized.value) {
-                // Adaptable already initialized
                 logger.value?.warn('Adaptable already initialized');
                 return;
             }
@@ -45,12 +43,6 @@ export const AdaptableUI = defineComponent({
                     },
                     gridOptions: {
                         ...toRaw(gridOptions.value),
-                        /**
-                         * Because `columnDefs` are define in props, it is defined in props
-                         * and it's value is 'undefined'.
-                         * We need to allow gridOptions passed to provider to override undefined
-                         * values that come from props.
-                         */
                         ...deleteUndefinedShallow(rawAgGridProps),
                     },
                     variant: 'vue',
@@ -65,20 +57,17 @@ export const AdaptableUI = defineComponent({
                 logger.value?.error('Failed to initialize Adaptable:', error);
             }
         };
-        // Watch for transition changes after mount
         watch(transition, async (newTransition) => {
             if (newTransition !== AdaptableAgGridStateTransitions.INITIALIZE_ADAPTABLE) {
                 return;
             }
             await initializeAdaptable();
         });
-        // Ensure initialization after mount if transition is already correct
         onMounted(async () => {
             if (transition.value === AdaptableAgGridStateTransitions.INITIALIZE_ADAPTABLE) {
                 await initializeAdaptable();
             }
         });
-        // Cleanup
         onUnmounted(() => {
             logger.value?.info('Destroying Adaptable...');
             if (adaptableApi.value) {
@@ -91,7 +80,6 @@ export const AdaptableUI = defineComponent({
             else {
                 logger.value?.warn('Adaptable API not available for destruction');
             }
-            // Clear logger reference
             logger.value = null;
         });
         return () => h('div', {

package/lib/utils.js

@@ -20,7 +20,6 @@ export function deepToRaw(sourceObj) {
 export function deleteUndefinedShallow(sourceObj) {
     return Object.keys(sourceObj).reduce((acc, key) => {
         if (sourceObj[key] !== undefined) {
-            // @ts-ignore
             acc[key] = sourceObj[key];
         }
         return acc;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable-vue3-aggrid",
-  "version": "23.0.4",
+  "version": "23.0.5-canary.0",
   "type": "module",
   "typings": "lib/index.d.ts",
   "peerDependencies": {
@@ -9,7 +9,7 @@
     "vue": "^3.0.0"
   },
   "dependencies": {
-    "@adaptabletools/adaptable": "23.0.4"
+    "@adaptabletools/adaptable": "23.0.5-canary.0"
   },
   "module": "lib/index.js"
 }