@bigbinary/neeto-fields-frontend 2.3.5 → 2.3.7

package/README.md

@@ -8,28 +8,28 @@ Rails engine for development.
 # Contents
 
 1. [Development with Host Application](#development-with-host-application)
-    - [Engine](#engine)
-        - [Installation](#installation)
-        - [customizability](#customizability)
-    - [Frontend package](#frontend-package)
-      - [Installation](#installation-1)
-      - [Instructions for development](#instructions-for-development)
-      - [Components](#components)
-        - [FieldsDashBoard](#1-fieldsdashboard)
-        - [FieldsPane](#2-fieldspane)
-        - [FieldValuesContainer](#3-fieldvaluescontainer)
-        - [FieldInputs](#4-fieldinputs)
-        - [InlineFieldValueInput](#5-inlinefieldvalueinput)
-        - [FieldDeleteAlert](#6-fielddeletealert)
-      - [Functions](#functions)
-        - [mergeInitialValues](#1-neetofieldsutilsmergeinitialvalues)
-        - [transformValues](#2-neetofieldsutilstransformvalues)
-      - [Hooks](#hooks)
-        - [useFetchFields](#1-usefetchfields)
-        - [useShowFields](#2-useshowfield)
-        - [useCreateField](#3-usecreatefield)
-        - [useUpdateField](#4-useupdatefield)
-        - [useDestroyField](#5-usedestroyfield)
+   - [Engine](#engine)
+     - [Installation](#installation)
+     - [customizability](#customizability)
+   - [Frontend package](#frontend-package)
+     - [Installation](#installation-1)
+     - [Instructions for development](#instructions-for-development)
+     - [Components](#components)
+       - [FieldsDashBoard](#1-fieldsdashboard)
+       - [FieldsPane](#2-fieldspane)
+       - [FieldValuesContainer](#3-fieldvaluescontainer)
+       - [FieldInputs](#4-fieldinputs)
+       - [InlineFieldValueInput](#5-inlinefieldvalueinput)
+       - [FieldDeleteAlert](#6-fielddeletealert)
+     - [Functions](#functions)
+       - [mergeInitialValues](#1-neetofieldsutilsmergeinitialvalues)
+       - [transformValues](#2-neetofieldsutilstransformvalues)
+     - [Hooks](#hooks)
+       - [useFetchFields](#1-usefetchfields)
+       - [useShowFields](#2-useshowfield)
+       - [useCreateField](#3-usecreatefield)
+       - [useUpdateField](#4-useupdatefield)
+       - [useDestroyField](#5-usedestroyfield)
 2. [Instructions for Publishing](#instructions-for-publishing)
 
 ## Development with Host Application
@@ -91,6 +91,9 @@ The engine is used to manage fields for any entity across neeto products.
    [Owner & Resource Information](docs/engine/owner-resource-information.md) for
    details.
 
+7. Add the permission `neeto_fields_engine.manage_fields` to your
+   `permissions.yml` file.
+
 #### Customizability
 
 Refer [Engine customizability](docs/engine/customizability.md) to learn about
@@ -476,6 +479,7 @@ The `InlineFieldValueInput` component render the field value input UI.
 6. `onMutate`: The callback function which is triggered on the mutations
 7. `onMutationSuccess`: The callback function which is triggered on the success
    of mutation functions of field value.
+8. `canManageFieldValues`: Boolean value which specifies whether the values can be modified.
 
 #### Usage
 
@@ -484,7 +488,7 @@ tables. The example shows one such usage of building the `columnData` for table
 with inline editable field value inputs in cell.
 
 ```jsx
-const buildColumnDataForFields = (fields, onFieldValueUpdateSuccess) =>
+const buildColumnDataForFields = (fields, onFieldValueUpdateSuccess, canWriteForm) =>
   fields.map(field => ({
     dataIndex: "field.id",
     key: field.id,
@@ -497,6 +501,7 @@ const buildColumnDataForFields = (fields, onFieldValueUpdateSuccess) =>
         resourceId={user.id}
         resourceType="users"
         onMutationSuccess={onFieldValueUpdateSuccess}
+        canManageFieldValues={canWriteForm}
       />
     ),
   }));

package/dist/FieldsDashboard.js

@@ -24,7 +24,6 @@ import NoData from '@bigbinary/neetoui/NoData';
 import Table from '@bigbinary/neetoui/Table';
 import { jsx, jsxs, Fragment } from 'react/jsx-runtime';
 import NeetoUIHeader from '@bigbinary/neeto-molecules/Header';
-import HelpPopover from '@bigbinary/neeto-molecules/HelpPopover';
 import Button from '@bigbinary/neetoui/Button';
 import MenuBar from '@bigbinary/neeto-molecules/MenuBar';
 import { unstable_batchedUpdates, createPortal } from 'react-dom';
@@ -57,18 +56,18 @@ var configsApi = {
   fetchConfigs: fetchConfigs
 };
 
-function ownKeys$5(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$5(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys$5(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys$5(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function ownKeys$4(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$4(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys$4(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys$4(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 var useFetchConfigs = function useFetchConfigs(options) {
-  return useQuery(_objectSpread$5({
+  return useQuery(_objectSpread$4({
     queryKey: [QUERY_KEYS.CONFIGS],
     queryFn: configsApi.fetchConfigs,
     staleTime: DEFAULT_STALE_TIME
   }, options));
 };
 
-function ownKeys$4(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$4(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys$4(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys$4(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function ownKeys$3(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$3(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys$3(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys$3(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 var useFieldsDashboard = function useFieldsDashboard(_ref) {
   var buildColumnData = _ref.buildColumnData,
     isOwnerBased = _ref.isOwnerBased,
@@ -191,7 +190,7 @@ var useFieldsDashboard = function useFieldsDashboard(_ref) {
     defaultColumns: defaultColumns
   });
   var handleBlockClick = function handleBlockClick(params) {
-    return handleMetaClick(history, buildUrl("", _objectSpread$4({
+    return handleMetaClick(history, buildUrl("", _objectSpread$3({
       resource: resource,
       state: state
     }, params)));
@@ -299,8 +298,8 @@ var useFieldsDashboard = function useFieldsDashboard(_ref) {
   };
 };
 
-function ownKeys$3(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$3(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys$3(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys$3(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function ownKeys$2(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$2(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys$2(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys$2(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 var FieldsTable = function FieldsTable(_ref) {
   var totalCount = _ref.totalCount,
     isFetched = _ref.isFetched,
@@ -343,7 +342,7 @@ var FieldsTable = function FieldsTable(_ref) {
     hasPagination: totalCount > DEFAULT_PAGE_SIZE,
     children: showNoDataScreen ? /*#__PURE__*/jsx("div", {
       className: "flex h-full w-full items-center justify-center",
-      children: /*#__PURE__*/jsx(NoData, _objectSpread$3({
+      children: /*#__PURE__*/jsx(NoData, _objectSpread$2({
         title: showStateFilter ? t("neetoFields.messages.noFieldsWithState", {
           title: title,
           state: state
@@ -360,7 +359,7 @@ var FieldsTable = function FieldsTable(_ref) {
       currentPageNumber: page,
       defaultPageSize: pageSize,
       handlePageChange: function handlePageChange(page) {
-        return setPageProps(_objectSpread$3(_objectSpread$3({}, pageProps), {}, {
+        return setPageProps(_objectSpread$2(_objectSpread$2({}, pageProps), {}, {
           page: page
         }));
       },
@@ -369,8 +368,6 @@ var FieldsTable = function FieldsTable(_ref) {
   });
 };
 
-function ownKeys$2(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$2(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys$2(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys$2(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 var Header = withT(function (_ref) {
   var searchInputProps = _ref.searchInputProps,
     breadcrumbs = _ref.breadcrumbs,
@@ -383,6 +380,7 @@ var Header = withT(function (_ref) {
   return /*#__PURE__*/jsx(NeetoUIHeader, {
     breadcrumbs: breadcrumbs,
     size: size,
+    title: title,
     searchProps: searchInputProps,
     actionBlock: /*#__PURE__*/jsx(Button, {
       "data-cy": "neeto-fields-add-button",
@@ -391,19 +389,13 @@ var Header = withT(function (_ref) {
         return setIsPaneOpen(true);
       }
     }),
-    title: /*#__PURE__*/jsxs("span", {
-      children: [title, (helpDocUrl || helpDescription) && /*#__PURE__*/jsx(HelpPopover, _objectSpread$2(_objectSpread$2(_objectSpread$2({
-        className: "ml-2 self-center"
-      }, helpDocUrl && {
-        title: title
-      }), helpDescription && {
-        description: helpDescription
-      }), helpDocUrl && {
-        helpLinkProps: {
-          href: helpDocUrl
-        }
-      }))]
-    })
+    titleHelpPopoverProps: (helpDocUrl || helpDescription) && {
+      title: title,
+      description: helpDescription,
+      helpLinkProps: helpDocUrl && {
+        href: helpDocUrl
+      }
+    }
   });
 });