@atlaskit/editor-plugin-tasks-and-decisions 2.4.7 → 2.5.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/editor-plugin-tasks-and-decisions
 
+## 2.5.0
+
+### Minor Changes
+
+- [#140548](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/140548)
+  [`36d26892db64c`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/36d26892db64c) -
+  ED-24762 Add support for hasEditPermission in tasks and decision plugin
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 2.4.7
 
 ### Patch Changes

package/dist/cjs/nodeviews/taskItem.js

@@ -18,6 +18,7 @@ var _steps = require("@atlaskit/adf-schema/steps");
 var _analyticsNext = require("@atlaskit/analytics-next");
 var _hooks = require("@atlaskit/editor-common/hooks");
 var _reactNodeView = _interopRequireDefault(require("@atlaskit/editor-common/react-node-view"));
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _Task = _interopRequireDefault(require("../ui/Task"));
 var _useShowPlaceholder = require("./hooks/use-show-placeholder");
 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; }
@@ -99,6 +100,7 @@ var Task = /*#__PURE__*/function (_ReactNodeView) {
         var listSize = resolvedPos.parent.childCount;
         var listLocalId = resolvedPos.parent.attrs.localId;
         event.update(function (payload) {
+          var _this$api;
           var _payload$attributes = payload.attributes,
             attributes = _payload$attributes === void 0 ? {} : _payload$attributes,
             actionSubject = payload.actionSubject;
@@ -111,6 +113,8 @@ var Task = /*#__PURE__*/function (_ReactNodeView) {
               position: position,
               listSize: listSize,
               listLocalId: listLocalId
+            }, (0, _platformFeatureFlags.fg)('editor_request_to_edit_task') && {
+              hasEditPermission: (_this$api = _this.api) === null || _this$api === void 0 || (_this$api = _this$api.taskDecision) === null || _this$api === void 0 || (_this$api = _this$api.sharedState.currentState()) === null || _this$api === void 0 ? void 0 : _this$api.hasEditPermission
             })
           });
         });

package/dist/cjs/plugin.js

@@ -115,6 +115,7 @@ var tasksAndDecisionsPlugin = exports.tasksAndDecisionsPlugin = function tasksAn
     allowNestedTasks = _ref2$config2.allowNestedTasks,
     consumeTabs = _ref2$config2.consumeTabs,
     useLongPressSelection = _ref2$config2.useLongPressSelection,
+    hasEditPermission = _ref2$config2.hasEditPermission,
     api = _ref2.api;
   var getIdentifierProvider = function getIdentifierProvider() {
     var _api$contextIdentifie;
@@ -148,7 +149,8 @@ var tasksAndDecisionsPlugin = exports.tasksAndDecisionsPlugin = function tasksAn
         focusedTaskItemLocalId: (pluginState === null || pluginState === void 0 ? void 0 : pluginState.focusedTaskItemLocalId) || null,
         isInsideTask: (0, _helpers.isInsideTask)(editorState),
         indentDisabled: itemIndex === 0 || indentLevel >= _indentation.MAX_INDENTATION_LEVEL,
-        outdentDisabled: indentLevel <= 1
+        outdentDisabled: indentLevel <= 1,
+        hasEditPermission: pluginState === null || pluginState === void 0 ? void 0 : pluginState.hasEditPermission
       };
     },
     actions: {
@@ -164,7 +166,7 @@ var tasksAndDecisionsPlugin = exports.tasksAndDecisionsPlugin = function tasksAn
             providerFactory = _ref3.providerFactory,
             eventDispatcher = _ref3.eventDispatcher,
             dispatch = _ref3.dispatch;
-          return (0, _main.createPlugin)(portalProviderAPI, eventDispatcher, providerFactory, dispatch, api, useLongPressSelection);
+          return (0, _main.createPlugin)(portalProviderAPI, eventDispatcher, providerFactory, dispatch, api, useLongPressSelection, hasEditPermission);
         }
       }, {
         name: 'tasksAndDecisionsInputRule',

package/dist/cjs/pm-plugins/main.js

@@ -30,6 +30,7 @@ function nodesBetweenChanged(tr, f, startPos) {
 }
 function createPlugin(portalProviderAPI, eventDispatcher, providerFactory, dispatch, api) {
   var useLongPressSelection = arguments.length > 5 && arguments[5] !== undefined ? arguments[5] : false;
+  var hasEditPermission = arguments.length > 6 ? arguments[6] : undefined;
   return new _safePlugin.SafePlugin({
     props: {
       nodeViews: {
@@ -164,7 +165,8 @@ function createPlugin(portalProviderAPI, eventDispatcher, providerFactory, dispa
     state: {
       init: function init() {
         return {
-          insideTaskDecisionItem: false
+          insideTaskDecisionItem: false,
+          hasEditPermission: hasEditPermission
         };
       },
       apply: function apply(tr, pluginState) {

package/dist/es2019/nodeviews/taskItem.js

@@ -4,6 +4,7 @@ import { SetAttrsStep } from '@atlaskit/adf-schema/steps';
 import { AnalyticsListener } from '@atlaskit/analytics-next';
 import { useSharedPluginState } from '@atlaskit/editor-common/hooks';
 import ReactNodeView from '@atlaskit/editor-common/react-node-view';
+import { fg } from '@atlaskit/platform-feature-flags';
 import TaskItem from '../ui/Task';
 import { useShowPlaceholder } from './hooks/use-show-placeholder';
 const TaskItemWrapper = ({
@@ -78,6 +79,7 @@ class Task extends ReactNodeView {
         const listSize = resolvedPos.parent.childCount;
         const listLocalId = resolvedPos.parent.attrs.localId;
         event.update(payload => {
+          var _this$api, _this$api$taskDecisio, _this$api$taskDecisio2;
           const {
             attributes = {},
             actionSubject
@@ -92,7 +94,10 @@ class Task extends ReactNodeView {
               ...attributes,
               position,
               listSize,
-              listLocalId
+              listLocalId,
+              ...(fg('editor_request_to_edit_task') && {
+                hasEditPermission: (_this$api = this.api) === null || _this$api === void 0 ? void 0 : (_this$api$taskDecisio = _this$api.taskDecision) === null || _this$api$taskDecisio === void 0 ? void 0 : (_this$api$taskDecisio2 = _this$api$taskDecisio.sharedState.currentState()) === null || _this$api$taskDecisio2 === void 0 ? void 0 : _this$api$taskDecisio2.hasEditPermission
+              })
             }
           };
         });

package/dist/es2019/plugin.js

@@ -103,7 +103,8 @@ export const tasksAndDecisionsPlugin = ({
   config: {
     allowNestedTasks,
     consumeTabs,
-    useLongPressSelection
+    useLongPressSelection,
+    hasEditPermission
   } = {},
   api
 }) => {
@@ -140,7 +141,8 @@ export const tasksAndDecisionsPlugin = ({
         focusedTaskItemLocalId: (pluginState === null || pluginState === void 0 ? void 0 : pluginState.focusedTaskItemLocalId) || null,
         isInsideTask: isInsideTask(editorState),
         indentDisabled: itemIndex === 0 || indentLevel >= MAX_INDENTATION_LEVEL,
-        outdentDisabled: indentLevel <= 1
+        outdentDisabled: indentLevel <= 1,
+        hasEditPermission: pluginState === null || pluginState === void 0 ? void 0 : pluginState.hasEditPermission
       };
     },
     actions: {
@@ -157,7 +159,7 @@ export const tasksAndDecisionsPlugin = ({
           eventDispatcher,
           dispatch
         }) => {
-          return createPlugin(portalProviderAPI, eventDispatcher, providerFactory, dispatch, api, useLongPressSelection);
+          return createPlugin(portalProviderAPI, eventDispatcher, providerFactory, dispatch, api, useLongPressSelection, hasEditPermission);
         }
       }, {
         name: 'tasksAndDecisionsInputRule',

package/dist/es2019/pm-plugins/main.js

@@ -16,7 +16,7 @@ function nodesBetweenChanged(tr, f, startPos) {
   }
   tr.doc.nodesBetween(stepRange.from, stepRange.to, f, startPos);
 }
-export function createPlugin(portalProviderAPI, eventDispatcher, providerFactory, dispatch, api, useLongPressSelection = false) {
+export function createPlugin(portalProviderAPI, eventDispatcher, providerFactory, dispatch, api, useLongPressSelection = false, hasEditPermission) {
   return new SafePlugin({
     props: {
       nodeViews: {
@@ -159,7 +159,8 @@ export function createPlugin(portalProviderAPI, eventDispatcher, providerFactory
     state: {
       init() {
         return {
-          insideTaskDecisionItem: false
+          insideTaskDecisionItem: false,
+          hasEditPermission
         };
       },
       apply(tr, pluginState) {

package/dist/esm/nodeviews/taskItem.js

@@ -15,6 +15,7 @@ import { SetAttrsStep } from '@atlaskit/adf-schema/steps';
 import { AnalyticsListener } from '@atlaskit/analytics-next';
 import { useSharedPluginState } from '@atlaskit/editor-common/hooks';
 import ReactNodeView from '@atlaskit/editor-common/react-node-view';
+import { fg } from '@atlaskit/platform-feature-flags';
 import TaskItem from '../ui/Task';
 import { useShowPlaceholder } from './hooks/use-show-placeholder';
 var TaskItemWrapper = function TaskItemWrapper(_ref) {
@@ -92,6 +93,7 @@ var Task = /*#__PURE__*/function (_ReactNodeView) {
         var listSize = resolvedPos.parent.childCount;
         var listLocalId = resolvedPos.parent.attrs.localId;
         event.update(function (payload) {
+          var _this$api;
           var _payload$attributes = payload.attributes,
             attributes = _payload$attributes === void 0 ? {} : _payload$attributes,
             actionSubject = payload.actionSubject;
@@ -104,6 +106,8 @@ var Task = /*#__PURE__*/function (_ReactNodeView) {
               position: position,
               listSize: listSize,
               listLocalId: listLocalId
+            }, fg('editor_request_to_edit_task') && {
+              hasEditPermission: (_this$api = _this.api) === null || _this$api === void 0 || (_this$api = _this$api.taskDecision) === null || _this$api === void 0 || (_this$api = _this$api.sharedState.currentState()) === null || _this$api === void 0 ? void 0 : _this$api.hasEditPermission
             })
           });
         });

package/dist/esm/plugin.js

@@ -107,6 +107,7 @@ export var tasksAndDecisionsPlugin = function tasksAndDecisionsPlugin(_ref2) {
     allowNestedTasks = _ref2$config2.allowNestedTasks,
     consumeTabs = _ref2$config2.consumeTabs,
     useLongPressSelection = _ref2$config2.useLongPressSelection,
+    hasEditPermission = _ref2$config2.hasEditPermission,
     api = _ref2.api;
   var getIdentifierProvider = function getIdentifierProvider() {
     var _api$contextIdentifie;
@@ -140,7 +141,8 @@ export var tasksAndDecisionsPlugin = function tasksAndDecisionsPlugin(_ref2) {
         focusedTaskItemLocalId: (pluginState === null || pluginState === void 0 ? void 0 : pluginState.focusedTaskItemLocalId) || null,
         isInsideTask: isInsideTask(editorState),
         indentDisabled: itemIndex === 0 || indentLevel >= MAX_INDENTATION_LEVEL,
-        outdentDisabled: indentLevel <= 1
+        outdentDisabled: indentLevel <= 1,
+        hasEditPermission: pluginState === null || pluginState === void 0 ? void 0 : pluginState.hasEditPermission
       };
     },
     actions: {
@@ -156,7 +158,7 @@ export var tasksAndDecisionsPlugin = function tasksAndDecisionsPlugin(_ref2) {
             providerFactory = _ref3.providerFactory,
             eventDispatcher = _ref3.eventDispatcher,
             dispatch = _ref3.dispatch;
-          return createPlugin(portalProviderAPI, eventDispatcher, providerFactory, dispatch, api, useLongPressSelection);
+          return createPlugin(portalProviderAPI, eventDispatcher, providerFactory, dispatch, api, useLongPressSelection, hasEditPermission);
         }
       }, {
         name: 'tasksAndDecisionsInputRule',

package/dist/esm/pm-plugins/main.js

@@ -23,6 +23,7 @@ function nodesBetweenChanged(tr, f, startPos) {
 }
 export function createPlugin(portalProviderAPI, eventDispatcher, providerFactory, dispatch, api) {
   var useLongPressSelection = arguments.length > 5 && arguments[5] !== undefined ? arguments[5] : false;
+  var hasEditPermission = arguments.length > 6 ? arguments[6] : undefined;
   return new SafePlugin({
     props: {
       nodeViews: {
@@ -157,7 +158,8 @@ export function createPlugin(portalProviderAPI, eventDispatcher, providerFactory
     state: {
       init: function init() {
         return {
-          insideTaskDecisionItem: false
+          insideTaskDecisionItem: false,
+          hasEditPermission: hasEditPermission
         };
       },
       apply: function apply(tr, pluginState) {

package/dist/types/pm-plugins/main.d.ts

@@ -4,4 +4,4 @@ import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { type PortalProviderAPI } from '@atlaskit/editor-common/src/portal';
 import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { TasksAndDecisionsPlugin } from '../types';
-export declare function createPlugin(portalProviderAPI: PortalProviderAPI, eventDispatcher: EventDispatcher, providerFactory: ProviderFactory, dispatch: Dispatch, api: ExtractInjectionAPI<TasksAndDecisionsPlugin> | undefined, useLongPressSelection?: boolean): SafePlugin<any>;
+export declare function createPlugin(portalProviderAPI: PortalProviderAPI, eventDispatcher: EventDispatcher, providerFactory: ProviderFactory, dispatch: Dispatch, api: ExtractInjectionAPI<TasksAndDecisionsPlugin> | undefined, useLongPressSelection?: boolean, hasEditPermission?: boolean): SafePlugin<any>;

package/dist/types/types.d.ts

@@ -26,15 +26,40 @@ export type AddItemTransactionCreator = (opts: {
     itemLocalId: string;
     itemAttrs?: AddItemAttrs;
 }) => Transaction | null;
+/**
+ * Interface representing the options for the TaskDecisionPlugin.
+ * Extends the LongPressSelectionPluginOptions interface.
+ */
+/**
+ * Represents the options for the TaskDecisionPlugin.
+ */
 export interface TaskDecisionPluginOptions extends LongPressSelectionPluginOptions {
+    /**
+     * Indicates whether nested tasks are allowed.
+     * @default false
+     */
     allowNestedTasks?: boolean;
+    /**
+     * Indicates whether tab key presses should be consumed.
+     * @default false
+     */
     consumeTabs?: boolean;
+    /**
+     * Indicates whether the user has permission to edit.
+     * @default false
+     */
+    hasEditPermission?: boolean;
+    /**
+     * Function to request edit permission.
+     */
+    requestEditPermission?: () => void;
 }
 export type TaskAndDecisionsSharedState = {
     focusedTaskItemLocalId: string | null;
     indentDisabled: boolean;
     outdentDisabled: boolean;
     isInsideTask: boolean;
+    hasEditPermission?: boolean;
 };
 export type TasksAndDecisionsPlugin = NextEditorPlugin<'taskDecision', {
     pluginConfiguration: TaskDecisionPluginOptions | undefined;

package/dist/types-ts4.5/pm-plugins/main.d.ts

@@ -4,4 +4,4 @@ import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { type PortalProviderAPI } from '@atlaskit/editor-common/src/portal';
 import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { TasksAndDecisionsPlugin } from '../types';
-export declare function createPlugin(portalProviderAPI: PortalProviderAPI, eventDispatcher: EventDispatcher, providerFactory: ProviderFactory, dispatch: Dispatch, api: ExtractInjectionAPI<TasksAndDecisionsPlugin> | undefined, useLongPressSelection?: boolean): SafePlugin<any>;
+export declare function createPlugin(portalProviderAPI: PortalProviderAPI, eventDispatcher: EventDispatcher, providerFactory: ProviderFactory, dispatch: Dispatch, api: ExtractInjectionAPI<TasksAndDecisionsPlugin> | undefined, useLongPressSelection?: boolean, hasEditPermission?: boolean): SafePlugin<any>;

package/dist/types-ts4.5/types.d.ts

@@ -26,15 +26,40 @@ export type AddItemTransactionCreator = (opts: {
     itemLocalId: string;
     itemAttrs?: AddItemAttrs;
 }) => Transaction | null;
+/**
+ * Interface representing the options for the TaskDecisionPlugin.
+ * Extends the LongPressSelectionPluginOptions interface.
+ */
+/**
+ * Represents the options for the TaskDecisionPlugin.
+ */
 export interface TaskDecisionPluginOptions extends LongPressSelectionPluginOptions {
+    /**
+     * Indicates whether nested tasks are allowed.
+     * @default false
+     */
     allowNestedTasks?: boolean;
+    /**
+     * Indicates whether tab key presses should be consumed.
+     * @default false
+     */
     consumeTabs?: boolean;
+    /**
+     * Indicates whether the user has permission to edit.
+     * @default false
+     */
+    hasEditPermission?: boolean;
+    /**
+     * Function to request edit permission.
+     */
+    requestEditPermission?: () => void;
 }
 export type TaskAndDecisionsSharedState = {
     focusedTaskItemLocalId: string | null;
     indentDisabled: boolean;
     outdentDisabled: boolean;
     isInsideTask: boolean;
+    hasEditPermission?: boolean;
 };
 export type TasksAndDecisionsPlugin = NextEditorPlugin<'taskDecision', {
     pluginConfiguration: TaskDecisionPluginOptions | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-tasks-and-decisions",
-	"version": "2.4.7",
+	"version": "2.5.0",
 	"description": "Tasks and decisions plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -34,12 +34,13 @@
 		"@atlaskit/adf-schema": "^40.9.0",
 		"@atlaskit/analytics-namespaced-context": "^6.12.0",
 		"@atlaskit/analytics-next": "^10.1.0",
-		"@atlaskit/editor-common": "^89.0.0",
+		"@atlaskit/editor-common": "^89.1.0",
 		"@atlaskit/editor-plugin-analytics": "^1.8.0",
 		"@atlaskit/editor-plugin-context-identifier": "^1.3.0",
 		"@atlaskit/editor-plugin-type-ahead": "^1.8.0",
 		"@atlaskit/editor-prosemirror": "6.0.0",
-		"@atlaskit/icon": "^22.16.0",
+		"@atlaskit/icon": "^22.18.0",
+		"@atlaskit/platform-feature-flags": "0.3.0",
 		"@atlaskit/prosemirror-input-rules": "^3.2.0",
 		"@atlaskit/task-decision": "^17.10.0",
 		"@atlaskit/tmp-editor-statsig": "^2.1.8",
@@ -94,5 +95,10 @@
 				"import-no-extraneous-disable-for-examples-and-docs"
 			]
 		}
+	},
+	"platform-feature-flags": {
+		"editor_request_to_edit_task": {
+			"type": "boolean"
+		}
 	}
 }