@bigbinary/neeto-commons-frontend 4.13.83 → 4.13.84

package/README.md

@@ -69,6 +69,7 @@ React utilities [↗](./docs/react/README.md)
 - [useStateWithDependency](./docs/react/hooks/useStateWithDependency.md)
 - [useQueryParams](./docs/react/hooks/useQueryParams.md)
 - [useBreakpoints](./docs/react/hooks/useBreakpoints.md)
+- [useColumnConfig](./docs/react/hooks/useColumnConfig.md)
 - [PrivateRoute](./docs/react/components/PrivateRoute.md)
 - [AppContainer](./docs/react/components/AppContainer.md)
 - [QueryClientProvider](./docs/react/components/QueryClientProvider.md)
@@ -176,7 +177,7 @@ them to read more:
 2. [React utilities](./docs/react/README.md)
 3. [Web utility functions](./docs/utils/README.md)
 4. [Default configurations](./docs/configs/README.md)
-6. [Common constants](./docs/constants#common-constants)
+5. [Common constants](./docs/constants#common-constants)
 
 ## Other references
 

package/dist/cjs/react-utils/index.js

@@ -22,6 +22,7 @@ var reactUtils_useTimer_useTimer = require('./useTimer/useTimer.js');
 var reactUtils_useUpdateEffect_useUpdateEffect = require('./useUpdateEffect/useUpdateEffect.js');
 var reactUtils_useBreakpoints_index = require('./useBreakpoints/index.js');
 var reactUtils_useRestoreScrollPosition_useRestoreScrollPosition = require('./useRestoreScrollPosition/useRestoreScrollPosition.js');
+var reactUtils_useColumnConfig_useColumnConfig = require('./useColumnConfig/useColumnConfig.js');
 var reactUtils_BrowserPushNotifications_pushHelper = require('./BrowserPushNotifications/pushHelper.js');
 var reactUtils_metaClick_metaClick = require('./metaClick/metaClick.js');
 var reactUtils_withImmutableActions_withImmutableActions = require('./withImmutableActions/withImmutableActions.js');
@@ -75,6 +76,10 @@ require('@bigbinary/neeto-time-zones');
 require('ua-parser-js');
 require('@tanstack/react-query');
 require('./useBreakpoints/utils.js');
+require('./useColumnConfig/useConfigApi.js');
+require('./useColumnConfig/api.js');
+require('./useColumnConfig/constants.js');
+require('./useColumnConfig/utils.js');
 require('./BrowserPushNotifications/devices.js');
 require('./BrowserPushNotifications/registerServiceWorker.js');
 require('../constants/index.js');
@@ -114,6 +119,7 @@ exports.useGetScrollPosition = reactUtils_useRestoreScrollPosition_useRestoreScr
 exports.useRemoveScrollPosition = reactUtils_useRestoreScrollPosition_useRestoreScrollPosition.useRemoveScrollPosition;
 exports.useRestoreScrollPosition = reactUtils_useRestoreScrollPosition_useRestoreScrollPosition.default;
 exports.useSetScrollPosition = reactUtils_useRestoreScrollPosition_useRestoreScrollPosition.useSetScrollPosition;
+exports.useColumnConfig = reactUtils_useColumnConfig_useColumnConfig;
 exports.destroyBrowserSubscription = reactUtils_BrowserPushNotifications_pushHelper.destroyBrowserSubscription;
 exports.registerBrowserNotifications = reactUtils_BrowserPushNotifications_pushHelper.registerBrowserNotifications;
 exports.handleMetaClick = reactUtils_metaClick_metaClick.handleMetaClick;

package/dist/cjs/react-utils/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/cjs/react-utils/useColumnConfig/api.js

@@ -0,0 +1,22 @@
+'use strict';
+
+var axios = require('axios');
+
+var baseUrl = "api/v1/table_configurations";
+var fetch = function fetch(tableKey) {
+  return axios.get("".concat(baseUrl, "/").concat(tableKey));
+};
+var update = function update(_ref) {
+  var tableKey = _ref.tableKey,
+    payload = _ref.payload;
+  return axios.patch("".concat(baseUrl, "/").concat(tableKey), {
+    tableConfiguration: payload
+  });
+};
+var configApi = {
+  fetch: fetch,
+  update: update
+};
+
+module.exports = configApi;
+//# sourceMappingURL=api.js.map

package/dist/cjs/react-utils/useColumnConfig/api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.js","sources":["../../../../src/react-utils/useColumnConfig/api.js"],"sourcesContent":["import axios from \"axios\";\n\nconst baseUrl = \"api/v1/table_configurations\";\n\nconst fetch = tableKey => axios.get(`${baseUrl}/${tableKey}`);\n\nconst update = ({ tableKey, payload }) =>\n  axios.patch(`${baseUrl}/${tableKey}`, { tableConfiguration: payload });\n\nconst configApi = { fetch, update };\n\nexport default configApi;\n"],"names":["baseUrl","fetch","tableKey","axios","get","concat","update","_ref","payload","patch","tableConfiguration","configApi"],"mappings":";;;;AAEA,IAAMA,OAAO,GAAG,6BAA6B;AAE7C,IAAMC,KAAK,GAAG,SAARA,KAAKA,CAAGC,QAAQ,EAAA;AAAA,EAAA,OAAIC,KAAK,CAACC,GAAG,CAAA,EAAA,CAAAC,MAAA,CAAIL,OAAO,EAAA,GAAA,CAAA,CAAAK,MAAA,CAAIH,QAAQ,CAAE,CAAC;AAAA,CAAA;AAE7D,IAAMI,MAAM,GAAG,SAATA,MAAMA,CAAAC,IAAA,EAAA;AAAA,EAAA,IAAML,QAAQ,GAAAK,IAAA,CAARL,QAAQ;IAAEM,OAAO,GAAAD,IAAA,CAAPC,OAAO;EAAA,OACjCL,KAAK,CAACM,KAAK,CAAAJ,EAAAA,CAAAA,MAAA,CAAIL,OAAO,EAAAK,GAAAA,CAAAA,CAAAA,MAAA,CAAIH,QAAQ,CAAI,EAAA;AAAEQ,IAAAA,kBAAkB,EAAEF;AAAQ,GAAC,CAAC;AAAA,CAAA;AAExE,IAAMG,SAAS,GAAG;AAAEV,EAAAA,KAAK,EAALA,KAAK;AAAEK,EAAAA,MAAM,EAANA;AAAO;;;;"}

package/dist/cjs/react-utils/useColumnConfig/constants.js

@@ -0,0 +1,8 @@
+'use strict';
+
+var ALLOWED_CONFIG_KEYS = ["key", "isShown", "description"];
+var TABLE_CONFIGURATION_QUERY_KEY = "table-configuration";
+
+exports.ALLOWED_CONFIG_KEYS = ALLOWED_CONFIG_KEYS;
+exports.TABLE_CONFIGURATION_QUERY_KEY = TABLE_CONFIGURATION_QUERY_KEY;
+//# sourceMappingURL=constants.js.map

package/dist/cjs/react-utils/useColumnConfig/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sources":["../../../../src/react-utils/useColumnConfig/constants.js"],"sourcesContent":["export const ALLOWED_CONFIG_KEYS = [\"key\", \"isShown\", \"description\"];\nexport const TABLE_CONFIGURATION_QUERY_KEY = \"table-configuration\";\n"],"names":["ALLOWED_CONFIG_KEYS","TABLE_CONFIGURATION_QUERY_KEY"],"mappings":";;AAAO,IAAMA,mBAAmB,GAAG,CAAC,KAAK,EAAE,SAAS,EAAE,aAAa;AAC5D,IAAMC,6BAA6B,GAAG;;;;;"}

package/dist/cjs/react-utils/useColumnConfig/index.js

@@ -0,0 +1,20 @@
+'use strict';
+
+var reactUtils_useColumnConfig_useColumnConfig = require('./useColumnConfig.js');
+require('react');
+require('./useConfigApi.js');
+require('@tanstack/react-query');
+require('../useMutationWithInvalidation/useMutationWithInvalidation.js');
+require('../../defineProperty-lChFfVqi.js');
+require('../../typeof-D4ZZ_FlZ.js');
+require('../../objectWithoutProperties-wSsbHFcG.js');
+require('ramda');
+require('./api.js');
+require('axios');
+require('./constants.js');
+require('./utils.js');
+
+
+
+module.exports = reactUtils_useColumnConfig_useColumnConfig;
+//# sourceMappingURL=index.js.map

package/dist/cjs/react-utils/useColumnConfig/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;"}

package/dist/cjs/react-utils/useColumnConfig/useColumnConfig.js

@@ -0,0 +1,51 @@
+'use strict';
+
+var react = require('react');
+var reactUtils_useColumnConfig_useConfigApi = require('./useConfigApi.js');
+var reactUtils_useColumnConfig_utils = require('./utils.js');
+require('@tanstack/react-query');
+require('../useMutationWithInvalidation/useMutationWithInvalidation.js');
+require('../../defineProperty-lChFfVqi.js');
+require('../../typeof-D4ZZ_FlZ.js');
+require('../../objectWithoutProperties-wSsbHFcG.js');
+require('ramda');
+require('./api.js');
+require('axios');
+require('./constants.js');
+
+var useColumnConfig = function useColumnConfig(_ref) {
+  var tableKey = _ref.tableKey,
+    defaultColumnData = _ref.defaultColumnData;
+  var _useFetchConfig = reactUtils_useColumnConfig_useConfigApi.useFetchConfig({
+      tableKey: tableKey
+    }),
+    isLoading = _useFetchConfig.isLoading,
+    configData = _useFetchConfig.data;
+  var _useUpdateConfig = reactUtils_useColumnConfig_useConfigApi.useUpdateConfig({
+      tableKey: tableKey
+    }),
+    updateConfig = _useUpdateConfig.mutate;
+  var configuration = configData === null || configData === void 0 ? void 0 : configData.columns;
+  var columnData = react.useMemo(function () {
+    return reactUtils_useColumnConfig_utils.mergeConfig(defaultColumnData, configuration);
+  }, [configuration]);
+  var onUpdateColumns = function onUpdateColumns(columnsOrCallback) {
+    var columns = typeof columnsOrCallback === "function" ? columnsOrCallback(columnData) : columnsOrCallback;
+    var payload = {
+      tableKey: tableKey,
+      columns: reactUtils_useColumnConfig_utils.packConfig(columns)
+    };
+    updateConfig({
+      tableKey: tableKey,
+      payload: payload
+    });
+  };
+  return {
+    isLoading: isLoading,
+    columnData: columnData,
+    onUpdateColumns: onUpdateColumns
+  };
+};
+
+module.exports = useColumnConfig;
+//# sourceMappingURL=useColumnConfig.js.map

package/dist/cjs/react-utils/useColumnConfig/useColumnConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useColumnConfig.js","sources":["../../../../src/react-utils/useColumnConfig/useColumnConfig.js"],"sourcesContent":["import { useMemo } from \"react\";\n\nimport { useFetchConfig, useUpdateConfig } from \"./useConfigApi\";\nimport { mergeConfig, packConfig } from \"./utils\";\n\nconst useColumnConfig = ({ tableKey, defaultColumnData }) => {\n  const { isLoading, data: configData } = useFetchConfig({ tableKey });\n  const { mutate: updateConfig } = useUpdateConfig({ tableKey });\n\n  const configuration = configData?.columns;\n  const columnData = useMemo(\n    () => mergeConfig(defaultColumnData, configuration),\n    [configuration]\n  );\n\n  const onUpdateColumns = columnsOrCallback => {\n    const columns =\n      typeof columnsOrCallback === \"function\"\n        ? columnsOrCallback(columnData)\n        : columnsOrCallback;\n    const payload = { tableKey, columns: packConfig(columns) };\n    updateConfig({ tableKey, payload });\n  };\n\n  return { isLoading, columnData, onUpdateColumns };\n};\n\nexport default useColumnConfig;\n"],"names":["useColumnConfig","_ref","tableKey","defaultColumnData","_useFetchConfig","useFetchConfig","isLoading","configData","data","_useUpdateConfig","useUpdateConfig","updateConfig","mutate","configuration","columns","columnData","useMemo","mergeConfig","onUpdateColumns","columnsOrCallback","payload","packConfig"],"mappings":";;;;;;;;;;;;;;;AAKA,IAAMA,eAAe,GAAG,SAAlBA,eAAeA,CAAAC,IAAA,EAAwC;AAAA,EAAA,IAAlCC,QAAQ,GAAAD,IAAA,CAARC,QAAQ;IAAEC,iBAAiB,GAAAF,IAAA,CAAjBE,iBAAiB;EACpD,IAAAC,eAAA,GAAwCC,sDAAc,CAAC;AAAEH,MAAAA,QAAQ,EAARA;AAAS,KAAC,CAAC;IAA5DI,SAAS,GAAAF,eAAA,CAATE,SAAS;IAAQC,UAAU,GAAAH,eAAA,CAAhBI,IAAI;EACvB,IAAAC,gBAAA,GAAiCC,uDAAe,CAAC;AAAER,MAAAA,QAAQ,EAARA;AAAS,KAAC,CAAC;IAA9CS,YAAY,GAAAF,gBAAA,CAApBG,MAAM;EAEd,IAAMC,aAAa,GAAGN,UAAU,KAAA,IAAA,IAAVA,UAAU,KAAVA,MAAAA,GAAAA,MAAAA,GAAAA,UAAU,CAAEO,OAAO;EACzC,IAAMC,UAAU,GAAGC,aAAO,CACxB,YAAA;AAAA,IAAA,OAAMC,4CAAW,CAACd,iBAAiB,EAAEU,aAAa,CAAC;GACnD,EAAA,CAACA,aAAa,CAChB,CAAC;AAED,EAAA,IAAMK,eAAe,GAAG,SAAlBA,eAAeA,CAAGC,iBAAiB,EAAI;AAC3C,IAAA,IAAML,OAAO,GACX,OAAOK,iBAAiB,KAAK,UAAU,GACnCA,iBAAiB,CAACJ,UAAU,CAAC,GAC7BI,iBAAiB;AACvB,IAAA,IAAMC,OAAO,GAAG;AAAElB,MAAAA,QAAQ,EAARA,QAAQ;MAAEY,OAAO,EAAEO,2CAAU,CAACP,OAAO;KAAG;AAC1DH,IAAAA,YAAY,CAAC;AAAET,MAAAA,QAAQ,EAARA,QAAQ;AAAEkB,MAAAA,OAAO,EAAPA;AAAQ,KAAC,CAAC;GACpC;EAED,OAAO;AAAEd,IAAAA,SAAS,EAATA,SAAS;AAAES,IAAAA,UAAU,EAAVA,UAAU;AAAEG,IAAAA,eAAe,EAAfA;GAAiB;AACnD;;;;"}

package/dist/cjs/react-utils/useColumnConfig/useConfigApi.js

@@ -0,0 +1,32 @@
+'use strict';
+
+var reactQuery = require('@tanstack/react-query');
+var reactUtils_useMutationWithInvalidation_useMutationWithInvalidation = require('../useMutationWithInvalidation/useMutationWithInvalidation.js');
+var reactUtils_useColumnConfig_api = require('./api.js');
+var reactUtils_useColumnConfig_constants = require('./constants.js');
+require('../../defineProperty-lChFfVqi.js');
+require('../../typeof-D4ZZ_FlZ.js');
+require('../../objectWithoutProperties-wSsbHFcG.js');
+require('ramda');
+require('axios');
+
+var useFetchConfig = function useFetchConfig(_ref) {
+  var tableKey = _ref.tableKey;
+  return reactQuery.useQuery({
+    queryKey: [reactUtils_useColumnConfig_constants.TABLE_CONFIGURATION_QUERY_KEY, tableKey],
+    enabled: !!tableKey,
+    queryFn: function queryFn() {
+      return reactUtils_useColumnConfig_api.fetch(tableKey);
+    }
+  });
+};
+var useUpdateConfig = function useUpdateConfig(_ref2) {
+  var tableKey = _ref2.tableKey;
+  return reactUtils_useMutationWithInvalidation_useMutationWithInvalidation(reactUtils_useColumnConfig_api.update, {
+    keysToInvalidate: [[reactUtils_useColumnConfig_constants.TABLE_CONFIGURATION_QUERY_KEY, tableKey]]
+  });
+};
+
+exports.useFetchConfig = useFetchConfig;
+exports.useUpdateConfig = useUpdateConfig;
+//# sourceMappingURL=useConfigApi.js.map

package/dist/cjs/react-utils/useColumnConfig/useConfigApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useConfigApi.js","sources":["../../../../src/react-utils/useColumnConfig/useConfigApi.js"],"sourcesContent":["import { useQuery } from \"@tanstack/react-query\";\nimport useMutationWithInvalidation from \"react-utils/useMutationWithInvalidation\";\n\nimport configApi from \"./api\";\nimport { TABLE_CONFIGURATION_QUERY_KEY } from \"./constants\";\n\nconst useFetchConfig = ({ tableKey }) =>\n  useQuery({\n    queryKey: [TABLE_CONFIGURATION_QUERY_KEY, tableKey],\n    enabled: !!tableKey,\n    queryFn: () => configApi.fetch(tableKey),\n  });\n\nconst useUpdateConfig = ({ tableKey }) =>\n  useMutationWithInvalidation(configApi.update, {\n    keysToInvalidate: [[TABLE_CONFIGURATION_QUERY_KEY, tableKey]],\n  });\n\nexport { useFetchConfig, useUpdateConfig };\n"],"names":["useFetchConfig","_ref","tableKey","useQuery","queryKey","TABLE_CONFIGURATION_QUERY_KEY","enabled","queryFn","configApi","fetch","useUpdateConfig","_ref2","useMutationWithInvalidation","update","keysToInvalidate"],"mappings":";;;;;;;;;;;;AAMA,IAAMA,cAAc,GAAG,SAAjBA,cAAcA,CAAAC,IAAA,EAAA;AAAA,EAAA,IAAMC,QAAQ,GAAAD,IAAA,CAARC,QAAQ;AAAA,EAAA,OAChCC,mBAAQ,CAAC;AACPC,IAAAA,QAAQ,EAAE,CAACC,kEAA6B,EAAEH,QAAQ,CAAC;IACnDI,OAAO,EAAE,CAAC,CAACJ,QAAQ;IACnBK,OAAO,EAAE,SAATA,OAAOA,GAAA;AAAA,MAAA,OAAQC,8BAAS,CAACC,KAAK,CAACP,QAAQ,CAAC;AAAA;AAC1C,GAAC,CAAC;AAAA;AAEJ,IAAMQ,eAAe,GAAG,SAAlBA,eAAeA,CAAAC,KAAA,EAAA;AAAA,EAAA,IAAMT,QAAQ,GAAAS,KAAA,CAART,QAAQ;AAAA,EAAA,OACjCU,kEAA2B,CAACJ,8BAAS,CAACK,MAAM,EAAE;AAC5CC,IAAAA,gBAAgB,EAAE,CAAC,CAACT,kEAA6B,EAAEH,QAAQ,CAAC;AAC9D,GAAC,CAAC;AAAA;;;;;"}

package/dist/cjs/react-utils/useColumnConfig/utils.js

@@ -0,0 +1,29 @@
+'use strict';
+
+var defineProperty = require('../../defineProperty-lChFfVqi.js');
+var ramda = require('ramda');
+var reactUtils_useColumnConfig_constants = require('./constants.js');
+require('../../typeof-D4ZZ_FlZ.js');
+
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), true).forEach(function (r) { defineProperty._defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+var mergeConfig = function mergeConfig(columnData) {
+  var configuration = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
+  var columnMap = new Map(); // Using Map for correct ordering of columns.
+
+  configuration.forEach(function (config) {
+    columnMap.set(config.key, config);
+  });
+  columnData.forEach(function (column) {
+    var _col$hidden;
+    var col = _objectSpread(_objectSpread({}, column), columnMap.get(column.key));
+    col.hidden = (_col$hidden = col.hidden) !== null && _col$hidden !== void 0 ? _col$hidden : col.isShown === false;
+    columnMap.set(column.key, col);
+  });
+  return Array.from(columnMap.values());
+};
+var packConfig = ramda.map(ramda.pick(reactUtils_useColumnConfig_constants.ALLOWED_CONFIG_KEYS));
+
+exports.mergeConfig = mergeConfig;
+exports.packConfig = packConfig;
+//# sourceMappingURL=utils.js.map

package/dist/cjs/react-utils/useColumnConfig/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sources":["../../../../src/react-utils/useColumnConfig/utils.js"],"sourcesContent":["import { map, pick } from \"ramda\";\nimport { ALLOWED_CONFIG_KEYS } from \"./constants\";\n\nexport const mergeConfig = (columnData, configuration = []) => {\n  const columnMap = new Map(); // Using Map for correct ordering of columns.\n\n  configuration.forEach(config => {\n    columnMap.set(config.key, config);\n  });\n\n  columnData.forEach(column => {\n    const col = { ...column, ...columnMap.get(column.key) };\n    col.hidden = col.hidden ?? col.isShown === false;\n    columnMap.set(column.key, col);\n  });\n\n  return Array.from(columnMap.values());\n};\n\nexport const packConfig = map(pick(ALLOWED_CONFIG_KEYS));\n"],"names":["mergeConfig","columnData","configuration","arguments","length","undefined","columnMap","Map","forEach","config","set","key","column","_col$hidden","col","_objectSpread","get","hidden","isShown","Array","from","values","packConfig","map","pick","ALLOWED_CONFIG_KEYS"],"mappings":";;;;;;;;;IAGaA,WAAW,GAAG,SAAdA,WAAWA,CAAIC,UAAU,EAAyB;AAAA,EAAA,IAAvBC,aAAa,GAAAC,SAAA,CAAAC,MAAA,GAAA,CAAA,IAAAD,SAAA,CAAA,CAAA,CAAA,KAAAE,SAAA,GAAAF,SAAA,CAAA,CAAA,CAAA,GAAG,EAAE;AACxD,EAAA,IAAMG,SAAS,GAAG,IAAIC,GAAG,EAAE,CAAC;;AAE5BL,EAAAA,aAAa,CAACM,OAAO,CAAC,UAAAC,MAAM,EAAI;IAC9BH,SAAS,CAACI,GAAG,CAACD,MAAM,CAACE,GAAG,EAAEF,MAAM,CAAC;AACnC,GAAC,CAAC;AAEFR,EAAAA,UAAU,CAACO,OAAO,CAAC,UAAAI,MAAM,EAAI;AAAA,IAAA,IAAAC,WAAA;AAC3B,IAAA,IAAMC,GAAG,GAAAC,aAAA,CAAAA,aAAA,KAAQH,MAAM,CAAA,EAAKN,SAAS,CAACU,GAAG,CAACJ,MAAM,CAACD,GAAG,CAAC,CAAE;AACvDG,IAAAA,GAAG,CAACG,MAAM,GAAA,CAAAJ,WAAA,GAAGC,GAAG,CAACG,MAAM,MAAAJ,IAAAA,IAAAA,WAAA,cAAAA,WAAA,GAAIC,GAAG,CAACI,OAAO,KAAK,KAAK;IAChDZ,SAAS,CAACI,GAAG,CAACE,MAAM,CAACD,GAAG,EAAEG,GAAG,CAAC;AAChC,GAAC,CAAC;EAEF,OAAOK,KAAK,CAACC,IAAI,CAACd,SAAS,CAACe,MAAM,EAAE,CAAC;AACvC;AAEO,IAAMC,UAAU,GAAGC,SAAG,CAACC,UAAI,CAACC,wDAAmB,CAAC;;;;;"}

package/dist/react-utils/index.js

@@ -20,6 +20,7 @@ export { default as useTimer } from './useTimer/useTimer.js';
 export { default as useUpdateEffect } from './useUpdateEffect/useUpdateEffect.js';
 export { default as useBreakpoints } from './useBreakpoints/index.js';
 export { useGetScrollPosition, useRemoveScrollPosition, default as useRestoreScrollPosition, useSetScrollPosition } from './useRestoreScrollPosition/useRestoreScrollPosition.js';
+export { default as useColumnConfig } from './useColumnConfig/useColumnConfig.js';
 export { destroyBrowserSubscription, registerBrowserNotifications } from './BrowserPushNotifications/pushHelper.js';
 export { handleMetaClick, isMetaKeyPressed } from './metaClick/metaClick.js';
 export { default as withImmutableActions } from './withImmutableActions/withImmutableActions.js';
@@ -73,6 +74,10 @@ import '@bigbinary/neeto-time-zones';
 import 'ua-parser-js';
 import '@tanstack/react-query';
 import './useBreakpoints/utils.js';
+import './useColumnConfig/useConfigApi.js';
+import './useColumnConfig/api.js';
+import './useColumnConfig/constants.js';
+import './useColumnConfig/utils.js';
 import './BrowserPushNotifications/devices.js';
 import './BrowserPushNotifications/registerServiceWorker.js';
 import '../constants/index.js';

package/dist/react-utils/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/react-utils/useColumnConfig/api.js

@@ -0,0 +1,20 @@
+import axios from 'axios';
+
+var baseUrl = "api/v1/table_configurations";
+var fetch = function fetch(tableKey) {
+  return axios.get("".concat(baseUrl, "/").concat(tableKey));
+};
+var update = function update(_ref) {
+  var tableKey = _ref.tableKey,
+    payload = _ref.payload;
+  return axios.patch("".concat(baseUrl, "/").concat(tableKey), {
+    tableConfiguration: payload
+  });
+};
+var configApi = {
+  fetch: fetch,
+  update: update
+};
+
+export { configApi as default };
+//# sourceMappingURL=api.js.map

package/dist/react-utils/useColumnConfig/api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.js","sources":["../../../src/react-utils/useColumnConfig/api.js"],"sourcesContent":["import axios from \"axios\";\n\nconst baseUrl = \"api/v1/table_configurations\";\n\nconst fetch = tableKey => axios.get(`${baseUrl}/${tableKey}`);\n\nconst update = ({ tableKey, payload }) =>\n  axios.patch(`${baseUrl}/${tableKey}`, { tableConfiguration: payload });\n\nconst configApi = { fetch, update };\n\nexport default configApi;\n"],"names":["baseUrl","fetch","tableKey","axios","get","concat","update","_ref","payload","patch","tableConfiguration","configApi"],"mappings":";;AAEA,IAAMA,OAAO,GAAG,6BAA6B;AAE7C,IAAMC,KAAK,GAAG,SAARA,KAAKA,CAAGC,QAAQ,EAAA;AAAA,EAAA,OAAIC,KAAK,CAACC,GAAG,CAAA,EAAA,CAAAC,MAAA,CAAIL,OAAO,EAAA,GAAA,CAAA,CAAAK,MAAA,CAAIH,QAAQ,CAAE,CAAC;AAAA,CAAA;AAE7D,IAAMI,MAAM,GAAG,SAATA,MAAMA,CAAAC,IAAA,EAAA;AAAA,EAAA,IAAML,QAAQ,GAAAK,IAAA,CAARL,QAAQ;IAAEM,OAAO,GAAAD,IAAA,CAAPC,OAAO;EAAA,OACjCL,KAAK,CAACM,KAAK,CAAAJ,EAAAA,CAAAA,MAAA,CAAIL,OAAO,EAAAK,GAAAA,CAAAA,CAAAA,MAAA,CAAIH,QAAQ,CAAI,EAAA;AAAEQ,IAAAA,kBAAkB,EAAEF;AAAQ,GAAC,CAAC;AAAA,CAAA;AAExE,IAAMG,SAAS,GAAG;AAAEV,EAAAA,KAAK,EAALA,KAAK;AAAEK,EAAAA,MAAM,EAANA;AAAO;;;;"}

package/dist/react-utils/useColumnConfig/constants.js

@@ -0,0 +1,5 @@
+var ALLOWED_CONFIG_KEYS = ["key", "isShown", "description"];
+var TABLE_CONFIGURATION_QUERY_KEY = "table-configuration";
+
+export { ALLOWED_CONFIG_KEYS, TABLE_CONFIGURATION_QUERY_KEY };
+//# sourceMappingURL=constants.js.map

package/dist/react-utils/useColumnConfig/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sources":["../../../src/react-utils/useColumnConfig/constants.js"],"sourcesContent":["export const ALLOWED_CONFIG_KEYS = [\"key\", \"isShown\", \"description\"];\nexport const TABLE_CONFIGURATION_QUERY_KEY = \"table-configuration\";\n"],"names":["ALLOWED_CONFIG_KEYS","TABLE_CONFIGURATION_QUERY_KEY"],"mappings":"AAAO,IAAMA,mBAAmB,GAAG,CAAC,KAAK,EAAE,SAAS,EAAE,aAAa;AAC5D,IAAMC,6BAA6B,GAAG;;;;"}

package/dist/react-utils/useColumnConfig/index.js

@@ -0,0 +1,14 @@
+export { default } from './useColumnConfig.js';
+import 'react';
+import './useConfigApi.js';
+import '@tanstack/react-query';
+import '../useMutationWithInvalidation/useMutationWithInvalidation.js';
+import '../../defineProperty-CrCYjjU3.js';
+import '../../typeof-D-UKOauR.js';
+import '../../objectWithoutProperties-DN7d1SzH.js';
+import 'ramda';
+import './api.js';
+import 'axios';
+import './constants.js';
+import './utils.js';
+//# sourceMappingURL=index.js.map

package/dist/react-utils/useColumnConfig/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;"}

package/dist/react-utils/useColumnConfig/useColumnConfig.js

@@ -0,0 +1,49 @@
+import { useMemo } from 'react';
+import { useFetchConfig, useUpdateConfig } from './useConfigApi.js';
+import { mergeConfig, packConfig } from './utils.js';
+import '@tanstack/react-query';
+import '../useMutationWithInvalidation/useMutationWithInvalidation.js';
+import '../../defineProperty-CrCYjjU3.js';
+import '../../typeof-D-UKOauR.js';
+import '../../objectWithoutProperties-DN7d1SzH.js';
+import 'ramda';
+import './api.js';
+import 'axios';
+import './constants.js';
+
+var useColumnConfig = function useColumnConfig(_ref) {
+  var tableKey = _ref.tableKey,
+    defaultColumnData = _ref.defaultColumnData;
+  var _useFetchConfig = useFetchConfig({
+      tableKey: tableKey
+    }),
+    isLoading = _useFetchConfig.isLoading,
+    configData = _useFetchConfig.data;
+  var _useUpdateConfig = useUpdateConfig({
+      tableKey: tableKey
+    }),
+    updateConfig = _useUpdateConfig.mutate;
+  var configuration = configData === null || configData === void 0 ? void 0 : configData.columns;
+  var columnData = useMemo(function () {
+    return mergeConfig(defaultColumnData, configuration);
+  }, [configuration]);
+  var onUpdateColumns = function onUpdateColumns(columnsOrCallback) {
+    var columns = typeof columnsOrCallback === "function" ? columnsOrCallback(columnData) : columnsOrCallback;
+    var payload = {
+      tableKey: tableKey,
+      columns: packConfig(columns)
+    };
+    updateConfig({
+      tableKey: tableKey,
+      payload: payload
+    });
+  };
+  return {
+    isLoading: isLoading,
+    columnData: columnData,
+    onUpdateColumns: onUpdateColumns
+  };
+};
+
+export { useColumnConfig as default };
+//# sourceMappingURL=useColumnConfig.js.map

package/dist/react-utils/useColumnConfig/useColumnConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useColumnConfig.js","sources":["../../../src/react-utils/useColumnConfig/useColumnConfig.js"],"sourcesContent":["import { useMemo } from \"react\";\n\nimport { useFetchConfig, useUpdateConfig } from \"./useConfigApi\";\nimport { mergeConfig, packConfig } from \"./utils\";\n\nconst useColumnConfig = ({ tableKey, defaultColumnData }) => {\n  const { isLoading, data: configData } = useFetchConfig({ tableKey });\n  const { mutate: updateConfig } = useUpdateConfig({ tableKey });\n\n  const configuration = configData?.columns;\n  const columnData = useMemo(\n    () => mergeConfig(defaultColumnData, configuration),\n    [configuration]\n  );\n\n  const onUpdateColumns = columnsOrCallback => {\n    const columns =\n      typeof columnsOrCallback === \"function\"\n        ? columnsOrCallback(columnData)\n        : columnsOrCallback;\n    const payload = { tableKey, columns: packConfig(columns) };\n    updateConfig({ tableKey, payload });\n  };\n\n  return { isLoading, columnData, onUpdateColumns };\n};\n\nexport default useColumnConfig;\n"],"names":["useColumnConfig","_ref","tableKey","defaultColumnData","_useFetchConfig","useFetchConfig","isLoading","configData","data","_useUpdateConfig","useUpdateConfig","updateConfig","mutate","configuration","columns","columnData","useMemo","mergeConfig","onUpdateColumns","columnsOrCallback","payload","packConfig"],"mappings":";;;;;;;;;;;;;AAKA,IAAMA,eAAe,GAAG,SAAlBA,eAAeA,CAAAC,IAAA,EAAwC;AAAA,EAAA,IAAlCC,QAAQ,GAAAD,IAAA,CAARC,QAAQ;IAAEC,iBAAiB,GAAAF,IAAA,CAAjBE,iBAAiB;EACpD,IAAAC,eAAA,GAAwCC,cAAc,CAAC;AAAEH,MAAAA,QAAQ,EAARA;AAAS,KAAC,CAAC;IAA5DI,SAAS,GAAAF,eAAA,CAATE,SAAS;IAAQC,UAAU,GAAAH,eAAA,CAAhBI,IAAI;EACvB,IAAAC,gBAAA,GAAiCC,eAAe,CAAC;AAAER,MAAAA,QAAQ,EAARA;AAAS,KAAC,CAAC;IAA9CS,YAAY,GAAAF,gBAAA,CAApBG,MAAM;EAEd,IAAMC,aAAa,GAAGN,UAAU,KAAA,IAAA,IAAVA,UAAU,KAAVA,MAAAA,GAAAA,MAAAA,GAAAA,UAAU,CAAEO,OAAO;EACzC,IAAMC,UAAU,GAAGC,OAAO,CACxB,YAAA;AAAA,IAAA,OAAMC,WAAW,CAACd,iBAAiB,EAAEU,aAAa,CAAC;GACnD,EAAA,CAACA,aAAa,CAChB,CAAC;AAED,EAAA,IAAMK,eAAe,GAAG,SAAlBA,eAAeA,CAAGC,iBAAiB,EAAI;AAC3C,IAAA,IAAML,OAAO,GACX,OAAOK,iBAAiB,KAAK,UAAU,GACnCA,iBAAiB,CAACJ,UAAU,CAAC,GAC7BI,iBAAiB;AACvB,IAAA,IAAMC,OAAO,GAAG;AAAElB,MAAAA,QAAQ,EAARA,QAAQ;MAAEY,OAAO,EAAEO,UAAU,CAACP,OAAO;KAAG;AAC1DH,IAAAA,YAAY,CAAC;AAAET,MAAAA,QAAQ,EAARA,QAAQ;AAAEkB,MAAAA,OAAO,EAAPA;AAAQ,KAAC,CAAC;GACpC;EAED,OAAO;AAAEd,IAAAA,SAAS,EAATA,SAAS;AAAES,IAAAA,UAAU,EAAVA,UAAU;AAAEG,IAAAA,eAAe,EAAfA;GAAiB;AACnD;;;;"}

package/dist/react-utils/useColumnConfig/useConfigApi.js

@@ -0,0 +1,29 @@
+import { useQuery } from '@tanstack/react-query';
+import useMutationWithInvalidation from '../useMutationWithInvalidation/useMutationWithInvalidation.js';
+import configApi from './api.js';
+import { TABLE_CONFIGURATION_QUERY_KEY } from './constants.js';
+import '../../defineProperty-CrCYjjU3.js';
+import '../../typeof-D-UKOauR.js';
+import '../../objectWithoutProperties-DN7d1SzH.js';
+import 'ramda';
+import 'axios';
+
+var useFetchConfig = function useFetchConfig(_ref) {
+  var tableKey = _ref.tableKey;
+  return useQuery({
+    queryKey: [TABLE_CONFIGURATION_QUERY_KEY, tableKey],
+    enabled: !!tableKey,
+    queryFn: function queryFn() {
+      return configApi.fetch(tableKey);
+    }
+  });
+};
+var useUpdateConfig = function useUpdateConfig(_ref2) {
+  var tableKey = _ref2.tableKey;
+  return useMutationWithInvalidation(configApi.update, {
+    keysToInvalidate: [[TABLE_CONFIGURATION_QUERY_KEY, tableKey]]
+  });
+};
+
+export { useFetchConfig, useUpdateConfig };
+//# sourceMappingURL=useConfigApi.js.map

package/dist/react-utils/useColumnConfig/useConfigApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useConfigApi.js","sources":["../../../src/react-utils/useColumnConfig/useConfigApi.js"],"sourcesContent":["import { useQuery } from \"@tanstack/react-query\";\nimport useMutationWithInvalidation from \"react-utils/useMutationWithInvalidation\";\n\nimport configApi from \"./api\";\nimport { TABLE_CONFIGURATION_QUERY_KEY } from \"./constants\";\n\nconst useFetchConfig = ({ tableKey }) =>\n  useQuery({\n    queryKey: [TABLE_CONFIGURATION_QUERY_KEY, tableKey],\n    enabled: !!tableKey,\n    queryFn: () => configApi.fetch(tableKey),\n  });\n\nconst useUpdateConfig = ({ tableKey }) =>\n  useMutationWithInvalidation(configApi.update, {\n    keysToInvalidate: [[TABLE_CONFIGURATION_QUERY_KEY, tableKey]],\n  });\n\nexport { useFetchConfig, useUpdateConfig };\n"],"names":["useFetchConfig","_ref","tableKey","useQuery","queryKey","TABLE_CONFIGURATION_QUERY_KEY","enabled","queryFn","configApi","fetch","useUpdateConfig","_ref2","useMutationWithInvalidation","update","keysToInvalidate"],"mappings":";;;;;;;;;;AAMA,IAAMA,cAAc,GAAG,SAAjBA,cAAcA,CAAAC,IAAA,EAAA;AAAA,EAAA,IAAMC,QAAQ,GAAAD,IAAA,CAARC,QAAQ;AAAA,EAAA,OAChCC,QAAQ,CAAC;AACPC,IAAAA,QAAQ,EAAE,CAACC,6BAA6B,EAAEH,QAAQ,CAAC;IACnDI,OAAO,EAAE,CAAC,CAACJ,QAAQ;IACnBK,OAAO,EAAE,SAATA,OAAOA,GAAA;AAAA,MAAA,OAAQC,SAAS,CAACC,KAAK,CAACP,QAAQ,CAAC;AAAA;AAC1C,GAAC,CAAC;AAAA;AAEJ,IAAMQ,eAAe,GAAG,SAAlBA,eAAeA,CAAAC,KAAA,EAAA;AAAA,EAAA,IAAMT,QAAQ,GAAAS,KAAA,CAART,QAAQ;AAAA,EAAA,OACjCU,2BAA2B,CAACJ,SAAS,CAACK,MAAM,EAAE;AAC5CC,IAAAA,gBAAgB,EAAE,CAAC,CAACT,6BAA6B,EAAEH,QAAQ,CAAC;AAC9D,GAAC,CAAC;AAAA;;;;"}

package/dist/react-utils/useColumnConfig/utils.js

@@ -0,0 +1,26 @@
+import { _ as _defineProperty } from '../../defineProperty-CrCYjjU3.js';
+import { map, pick } from 'ramda';
+import { ALLOWED_CONFIG_KEYS } from './constants.js';
+import '../../typeof-D-UKOauR.js';
+
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), true).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+var mergeConfig = function mergeConfig(columnData) {
+  var configuration = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
+  var columnMap = new Map(); // Using Map for correct ordering of columns.
+
+  configuration.forEach(function (config) {
+    columnMap.set(config.key, config);
+  });
+  columnData.forEach(function (column) {
+    var _col$hidden;
+    var col = _objectSpread(_objectSpread({}, column), columnMap.get(column.key));
+    col.hidden = (_col$hidden = col.hidden) !== null && _col$hidden !== void 0 ? _col$hidden : col.isShown === false;
+    columnMap.set(column.key, col);
+  });
+  return Array.from(columnMap.values());
+};
+var packConfig = map(pick(ALLOWED_CONFIG_KEYS));
+
+export { mergeConfig, packConfig };
+//# sourceMappingURL=utils.js.map

package/dist/react-utils/useColumnConfig/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sources":["../../../src/react-utils/useColumnConfig/utils.js"],"sourcesContent":["import { map, pick } from \"ramda\";\nimport { ALLOWED_CONFIG_KEYS } from \"./constants\";\n\nexport const mergeConfig = (columnData, configuration = []) => {\n  const columnMap = new Map(); // Using Map for correct ordering of columns.\n\n  configuration.forEach(config => {\n    columnMap.set(config.key, config);\n  });\n\n  columnData.forEach(column => {\n    const col = { ...column, ...columnMap.get(column.key) };\n    col.hidden = col.hidden ?? col.isShown === false;\n    columnMap.set(column.key, col);\n  });\n\n  return Array.from(columnMap.values());\n};\n\nexport const packConfig = map(pick(ALLOWED_CONFIG_KEYS));\n"],"names":["mergeConfig","columnData","configuration","arguments","length","undefined","columnMap","Map","forEach","config","set","key","column","_col$hidden","col","_objectSpread","get","hidden","isShown","Array","from","values","packConfig","map","pick","ALLOWED_CONFIG_KEYS"],"mappings":";;;;;;;IAGaA,WAAW,GAAG,SAAdA,WAAWA,CAAIC,UAAU,EAAyB;AAAA,EAAA,IAAvBC,aAAa,GAAAC,SAAA,CAAAC,MAAA,GAAA,CAAA,IAAAD,SAAA,CAAA,CAAA,CAAA,KAAAE,SAAA,GAAAF,SAAA,CAAA,CAAA,CAAA,GAAG,EAAE;AACxD,EAAA,IAAMG,SAAS,GAAG,IAAIC,GAAG,EAAE,CAAC;;AAE5BL,EAAAA,aAAa,CAACM,OAAO,CAAC,UAAAC,MAAM,EAAI;IAC9BH,SAAS,CAACI,GAAG,CAACD,MAAM,CAACE,GAAG,EAAEF,MAAM,CAAC;AACnC,GAAC,CAAC;AAEFR,EAAAA,UAAU,CAACO,OAAO,CAAC,UAAAI,MAAM,EAAI;AAAA,IAAA,IAAAC,WAAA;AAC3B,IAAA,IAAMC,GAAG,GAAAC,aAAA,CAAAA,aAAA,KAAQH,MAAM,CAAA,EAAKN,SAAS,CAACU,GAAG,CAACJ,MAAM,CAACD,GAAG,CAAC,CAAE;AACvDG,IAAAA,GAAG,CAACG,MAAM,GAAA,CAAAJ,WAAA,GAAGC,GAAG,CAACG,MAAM,MAAAJ,IAAAA,IAAAA,WAAA,cAAAA,WAAA,GAAIC,GAAG,CAACI,OAAO,KAAK,KAAK;IAChDZ,SAAS,CAACI,GAAG,CAACE,MAAM,CAACD,GAAG,EAAEG,GAAG,CAAC;AAChC,GAAC,CAAC;EAEF,OAAOK,KAAK,CAACC,IAAI,CAACd,SAAS,CAACe,MAAM,EAAE,CAAC;AACvC;AAEO,IAAMC,UAAU,GAAGC,GAAG,CAACC,IAAI,CAACC,mBAAmB,CAAC;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigbinary/neeto-commons-frontend",
-  "version": "4.13.83",
+  "version": "4.13.84",
   "description": "A package encapsulating common code across neeto projects including initializers, utility functions, common components and hooks and so on.",
   "repository": "git@github.com:bigbinary/neeto-commons-frontend.git",
   "author": "Amaljith K <amaljith.k@bigbinary.com>",

package/react-utils.d.ts

@@ -1820,4 +1820,88 @@ type Breakpoints = { [key in BreakpointKeys]: boolean };
 export function useBreakpoints<T extends {}>(breakpointOverrides?: (window: Window) => Partial<T & Breakpoints>): {
   currentSize: BreakpointKeys | keyof T;
   isSize: (size: BreakpointKeys | keyof T) => boolean;
+};
+/**
+ *
+ * The useColumnConfig hook is used to manage attributes of table columns and
+ *
+ * their updates. This hook provides functionality to fetch, merge, and persist
+ *
+ * column configurations for data tables. The changes made to column configurations
+ *
+ * are automatically saved to the database, ensuring that user preferences for
+ *
+ * table layouts are preserved across sessions.
+ *
+ * The hook handles merging default column data with user-saved configurations.
+ *
+ * This hook returns an object with the following properties:
+ *
+ * The following code snippet demonstrates how to use useColumnConfig in a table
+ *
+ * component:
+ *
+ * @example 
+ *
+ * import { useColumnConfig } from "@bigbinary/neeto-commons-frontend/react-utils";
+ * 
+ * const defaultColumns = [
+ *   { key: "name", isShown: true, description: "User Name" },
+ *   { key: "email", isShown: true, description: "Email Address" },
+ *   { key: "created_at", isShown: false, description: "Created Date" },
+ *   { key: "updated_at", isShown: false, description: "Last Updated" },
+ * ];
+ * 
+ * const MyTable = () => {
+ *   const { columnData, onUpdateColumns } = useColumnConfig({
+ *     tableKey: "users_table",
+ *     defaultColumnData: defaultColumns,
+ *   });
+ * 
+ *   const handleColumnToggle = columnKey => {
+ *     onUpdateColumns(columns =>
+ *       columns.map(column =>
+ *         column.key === columnKey
+ *           ? { ...column, isShown: !column.isShown }
+ *           : column
+ *       )
+ *     );
+ *   };
+ * 
+ *   const handleColumnReorder = newColumnOrder => {
+ *     onUpdateColumns(newColumnOrder);
+ *   };
+ * 
+ *   return (
+ *     <div>
+ *       {columnData.map(column => (
+ *         <div key={column.key}>
+ *           <label>
+ *             <input
+ *               type="checkbox"
+ *               checked={column.isShown}
+ *               onChange={() => handleColumnToggle(column.key)}
+ *             />
+ *             {column.description}
+ *           </label>
+ *         </div>
+ *       ))}
+ *     </div>
+ *   );
+ * };
+ * @endexample
+ * Each column object in the configuration can contain the following properties:
+ *
+ * Currently, only these properties are persisted to the database
+ *
+*/
+export function useColumnConfig<ColumnData>({
+  tableKey,
+  defaultColumnData
+}: {
+  tableKey: string;
+  defaultColumnData: ColumnData[];
+}): {
+  columnData: ColumnData[];
+  onUpdateColumns: (columnsOrCallback: ColumnData[] | ((columnData: ColumnData[]) => ColumnData[])) => void;
 };