@atlaskit/editor-plugin-date 10.0.1 → 10.0.2

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-plugin-date
 
+## 10.0.2
+
+### Patch Changes
+
+- [`5985f38f7104e`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/5985f38f7104e) -
+  Update README.md and 0-intro.tsx
+- Updated dependencies
+
 ## 10.0.1
 
 ### Patch Changes

package/README.md

@@ -1,9 +1,22 @@
-# Editor plugin date
+# Editor Plugin Date
 
 Date plugin for @atlaskit/editor-core
+
 **Note:** This component is designed for internal Atlassian development.
 External contributors will be able to use this component but will not be able to submit issues.
 
+## Overview
+
+The Date plugin provides date insertion and editing capabilities for the Atlassian Editor. It integrates with `@atlaskit/calendar` to enable users to select and insert dates into editor content with a visual date picker interface.
+
+## Key features
+
+- **Date insertion** - Insert dates into editor content with a calendar-based date picker
+- **Date editing** - Edit existing dates inline with the same date picker interface
+- **Configurable week start** - Configure the first day of the week in the date picker
+- **Date analytics** - Track date insertion and editing actions through the analytics plugin
+- **Inline date display** - Dates are displayed inline within the document content
+
 ## Install
 ---
 - **Install** - *yarn add @atlaskit/editor-plugin-date*
@@ -15,9 +28,12 @@ External contributors will be able to use this component but will not be able to
 ---
 
 **Internal use only**
+
 @atlaskit/editor-plugin-date is intended for internal use by the @atlaskit/editor-core and as a plugin dependency of the Editor within your product.
+
 Direct use of this component is not supported.
-Please see [Atlaskit - Editor plugin Date Dialog](https://atlaskit.atlassian.com/packages/editor/editor-plugin-date) for documentation and examples for this package.
+
+Please see [Atlaskit - Editor plugin Date](https://atlaskit.atlassian.com/packages/editor/editor-plugin-date) for documentation and examples for this package.
 
 ## Support
 ---

package/dist/cjs/datePlugin.js

@@ -213,7 +213,7 @@ var datePlugin = function datePlugin(_ref3) {
           icon: function icon() {
             return /*#__PURE__*/_react.default.createElement(_quickInsert.IconDate, null);
           },
-          action: function action(insert, state) {
+          action: function action(insert, state, source) {
             var _api$analytics, _api$analytics$attach;
             var tr = (0, _actions.createDate)(true)(state);
             api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 || (_api$analytics = _api$analytics.actions) === null || _api$analytics === void 0 || (_api$analytics$attach = _api$analytics.attachAnalyticsEvent) === null || _api$analytics$attach === void 0 || _api$analytics$attach.call(_api$analytics, {
@@ -222,7 +222,7 @@ var datePlugin = function datePlugin(_ref3) {
               actionSubjectId: _analytics.ACTION_SUBJECT_ID.DATE,
               eventType: _analytics.EVENT_TYPE.TRACK,
               attributes: {
-                inputMethod: _analytics.INPUT_METHOD.QUICK_INSERT
+                inputMethod: source !== null && source !== void 0 ? source : _analytics.INPUT_METHOD.QUICK_INSERT
               }
             })(tr);
             return tr;

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

@@ -9,6 +9,7 @@ var _utils = require("@atlaskit/editor-common/utils");
 var _model = require("@atlaskit/editor-prosemirror/model");
 var _state = require("@atlaskit/editor-prosemirror/state");
 var _utils2 = require("@atlaskit/editor-prosemirror/utils");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _internal = require("../ui/DatePicker/utils/internal");
 var _pluginKey = require("./plugin-key");
 /** Delete the date and close the datepicker */
@@ -47,13 +48,14 @@ var insertDateCommand = exports.insertDateCommand = function insertDateCommand(p
       }
       if (inputMethod) {
         var _pluginInjectionApi$a;
+        var resolvedInputMethod = (0, _platformFeatureFlags.fg)('platform_editor_element_browser_analytic') ? inputMethod : _analytics.INPUT_METHOD.QUICK_INSERT;
         pluginInjectionApi === null || pluginInjectionApi === void 0 || (_pluginInjectionApi$a = pluginInjectionApi.analytics) === null || _pluginInjectionApi$a === void 0 || (_pluginInjectionApi$a = _pluginInjectionApi$a.actions) === null || _pluginInjectionApi$a === void 0 || _pluginInjectionApi$a.attachAnalyticsEvent({
           action: _analytics.ACTION.INSERTED,
           actionSubject: _analytics.ACTION_SUBJECT.DOCUMENT,
           actionSubjectId: _analytics.ACTION_SUBJECT_ID.DATE,
           eventType: _analytics.EVENT_TYPE.TRACK,
           attributes: {
-            inputMethod: inputMethod
+            inputMethod: resolvedInputMethod
           }
         })(tr);
       }

package/dist/es2019/datePlugin.js

@@ -200,7 +200,7 @@ const datePlugin = ({
       keywords: ['calendar', 'day', 'time', 'today', '/'],
       keyshortcut: '//',
       icon: () => /*#__PURE__*/React.createElement(IconDate, null),
-      action(insert, state) {
+      action(insert, state, source) {
         var _api$analytics, _api$analytics$action, _api$analytics$action2;
         const tr = createDate(true)(state);
         api === null || api === void 0 ? void 0 : (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : (_api$analytics$action = _api$analytics.actions) === null || _api$analytics$action === void 0 ? void 0 : (_api$analytics$action2 = _api$analytics$action.attachAnalyticsEvent) === null || _api$analytics$action2 === void 0 ? void 0 : _api$analytics$action2.call(_api$analytics$action, {
@@ -209,7 +209,7 @@ const datePlugin = ({
           actionSubjectId: ACTION_SUBJECT_ID.DATE,
           eventType: EVENT_TYPE.TRACK,
           attributes: {
-            inputMethod: INPUT_METHOD.QUICK_INSERT
+            inputMethod: source !== null && source !== void 0 ? source : INPUT_METHOD.QUICK_INSERT
           }
         })(tr);
         return tr;

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

@@ -1,8 +1,9 @@
-import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE } from '@atlaskit/editor-common/analytics';
+import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE, INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import { todayTimestampInUTC } from '@atlaskit/editor-common/utils';
 import { Fragment } from '@atlaskit/editor-prosemirror/model';
 import { NodeSelection, Selection } from '@atlaskit/editor-prosemirror/state';
 import { canInsert } from '@atlaskit/editor-prosemirror/utils';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { isToday } from '../ui/DatePicker/utils/internal';
 import { pluginKey } from './plugin-key';
 /** Delete the date and close the datepicker */
@@ -42,13 +43,14 @@ export const insertDateCommand = pluginInjectionApi => ({
   }
   if (inputMethod) {
     var _pluginInjectionApi$a, _pluginInjectionApi$a2;
+    const resolvedInputMethod = fg('platform_editor_element_browser_analytic') ? inputMethod : INPUT_METHOD.QUICK_INSERT;
     pluginInjectionApi === null || pluginInjectionApi === void 0 ? void 0 : (_pluginInjectionApi$a = pluginInjectionApi.analytics) === null || _pluginInjectionApi$a === void 0 ? void 0 : (_pluginInjectionApi$a2 = _pluginInjectionApi$a.actions) === null || _pluginInjectionApi$a2 === void 0 ? void 0 : _pluginInjectionApi$a2.attachAnalyticsEvent({
       action: ACTION.INSERTED,
       actionSubject: ACTION_SUBJECT.DOCUMENT,
       actionSubjectId: ACTION_SUBJECT_ID.DATE,
       eventType: EVENT_TYPE.TRACK,
       attributes: {
-        inputMethod
+        inputMethod: resolvedInputMethod
       }
     })(tr);
   }

package/dist/esm/datePlugin.js

@@ -202,7 +202,7 @@ var datePlugin = function datePlugin(_ref3) {
           icon: function icon() {
             return /*#__PURE__*/React.createElement(IconDate, null);
           },
-          action: function action(insert, state) {
+          action: function action(insert, state, source) {
             var _api$analytics, _api$analytics$attach;
             var tr = createDate(true)(state);
             api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 || (_api$analytics = _api$analytics.actions) === null || _api$analytics === void 0 || (_api$analytics$attach = _api$analytics.attachAnalyticsEvent) === null || _api$analytics$attach === void 0 || _api$analytics$attach.call(_api$analytics, {
@@ -211,7 +211,7 @@ var datePlugin = function datePlugin(_ref3) {
               actionSubjectId: ACTION_SUBJECT_ID.DATE,
               eventType: EVENT_TYPE.TRACK,
               attributes: {
-                inputMethod: INPUT_METHOD.QUICK_INSERT
+                inputMethod: source !== null && source !== void 0 ? source : INPUT_METHOD.QUICK_INSERT
               }
             })(tr);
             return tr;

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

@@ -1,8 +1,9 @@
-import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE } from '@atlaskit/editor-common/analytics';
+import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE, INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import { todayTimestampInUTC } from '@atlaskit/editor-common/utils';
 import { Fragment } from '@atlaskit/editor-prosemirror/model';
 import { NodeSelection, Selection } from '@atlaskit/editor-prosemirror/state';
 import { canInsert } from '@atlaskit/editor-prosemirror/utils';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { isToday } from '../ui/DatePicker/utils/internal';
 import { pluginKey } from './plugin-key';
 /** Delete the date and close the datepicker */
@@ -41,13 +42,14 @@ export var insertDateCommand = function insertDateCommand(pluginInjectionApi) {
       }
       if (inputMethod) {
         var _pluginInjectionApi$a;
+        var resolvedInputMethod = fg('platform_editor_element_browser_analytic') ? inputMethod : INPUT_METHOD.QUICK_INSERT;
         pluginInjectionApi === null || pluginInjectionApi === void 0 || (_pluginInjectionApi$a = pluginInjectionApi.analytics) === null || _pluginInjectionApi$a === void 0 || (_pluginInjectionApi$a = _pluginInjectionApi$a.actions) === null || _pluginInjectionApi$a === void 0 || _pluginInjectionApi$a.attachAnalyticsEvent({
           action: ACTION.INSERTED,
           actionSubject: ACTION_SUBJECT.DOCUMENT,
           actionSubjectId: ACTION_SUBJECT_ID.DATE,
           eventType: EVENT_TYPE.TRACK,
           attributes: {
-            inputMethod: inputMethod
+            inputMethod: resolvedInputMethod
           }
         })(tr);
       }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-date",
-	"version": "10.0.1",
+	"version": "10.0.2",
 	"description": "Date plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -44,7 +44,7 @@
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/textfield": "^8.2.0",
 		"@atlaskit/theme": "^22.0.0",
-		"@atlaskit/tmp-editor-statsig": "^36.0.0",
+		"@atlaskit/tmp-editor-statsig": "^36.3.0",
 		"@atlaskit/tokens": "^11.1.0",
 		"@atlaskit/visually-hidden": "^3.0.0",
 		"@babel/runtime": "^7.0.0",
@@ -57,7 +57,7 @@
 		"@testing-library/react": "^16.3.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^112.0.0",
+		"@atlaskit/editor-common": "^112.2.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0"
 	},
@@ -97,6 +97,9 @@
 		}
 	},
 	"platform-feature-flags": {
+		"platform_editor_element_browser_analytic": {
+			"type": "boolean"
+		},
 		"platform_editor_adf_with_localid": {
 			"type": "boolean"
 		}