@atlaskit/editor-plugin-date 5.1.9 → 5.1.11

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @atlaskit/editor-plugin-date
 
+## 5.1.11
+
+### Patch Changes
+
+- [`db857b08dd89a`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/db857b08dd89a) -
+  [EDITOR-1202] Make dates in blockTaskItem be formatted correctly
+- Updated dependencies
+
+## 5.1.10
+
+### Patch Changes
+
+- [`265c1bf0cefa4`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/265c1bf0cefa4) -
+  Sorted type and interface props to improve Atlaskit docs
+- Updated dependencies
+
 ## 5.1.9
 
 ### Patch Changes

package/dist/cjs/nodeviews/utils.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.getDateInformation = void 0;
 var _utils = require("@atlaskit/editor-common/utils");
+var _utils2 = require("@atlaskit/editor-prosemirror/utils");
 var getDateInformation = exports.getDateInformation = function getDateInformation(timestamp, intl, state, pos) {
   if (!state) {
     return {
@@ -14,13 +15,25 @@ var getDateInformation = exports.getDateInformation = function getDateInformatio
   }
   var doc = state.doc,
     selection = state.selection;
-  var taskItem = state.schema.nodes.taskItem;
+  var _state$schema$nodes = state.schema.nodes,
+    taskItem = _state$schema$nodes.taskItem,
+    blockTaskItem = _state$schema$nodes.blockTaskItem;
 
   // We fall back to selection.$from even though it does not cover all use cases
   // eg. upon Editor init, selection is at the start, not at the Date node
   var $nodePos = typeof pos === 'number' ? doc.resolve(pos) : selection.$from;
   var parent = $nodePos.parent;
   var withinIncompleteTask = parent.type === taskItem && parent.attrs.state !== 'DONE';
+
+  // If there is blockTaskItem in the schema and it's not nested in an incomplete task item,
+  // check if it's nested in an incomplete block task item
+  if (blockTaskItem && !withinIncompleteTask) {
+    var blockTaskItemParent = (0, _utils2.findParentNodeOfTypeClosestToPos)($nodePos, blockTaskItem);
+    // If nested in a blockTaskItem that is incomplete
+    if (blockTaskItemParent) {
+      withinIncompleteTask = blockTaskItemParent.node.attrs.state !== 'DONE';
+    }
+  }
   var color = withinIncompleteTask && (0, _utils.isPastDate)(timestamp) ? 'red' : undefined;
   var displayString = withinIncompleteTask ? (0, _utils.timestampToTaskContext)(timestamp, intl) : (0, _utils.timestampToString)(timestamp, intl);
   return {

package/dist/es2019/nodeviews/utils.js

@@ -1,4 +1,5 @@
 import { isPastDate, timestampToString, timestampToTaskContext } from '@atlaskit/editor-common/utils';
+import { findParentNodeOfTypeClosestToPos } from '@atlaskit/editor-prosemirror/utils';
 export const getDateInformation = (timestamp, intl, state, pos) => {
   if (!state) {
     return {
@@ -11,14 +12,25 @@ export const getDateInformation = (timestamp, intl, state, pos) => {
     selection
   } = state;
   const {
-    taskItem
+    taskItem,
+    blockTaskItem
   } = state.schema.nodes;
 
   // We fall back to selection.$from even though it does not cover all use cases
   // eg. upon Editor init, selection is at the start, not at the Date node
   const $nodePos = typeof pos === 'number' ? doc.resolve(pos) : selection.$from;
   const parent = $nodePos.parent;
-  const withinIncompleteTask = parent.type === taskItem && parent.attrs.state !== 'DONE';
+  let withinIncompleteTask = parent.type === taskItem && parent.attrs.state !== 'DONE';
+
+  // If there is blockTaskItem in the schema and it's not nested in an incomplete task item,
+  // check if it's nested in an incomplete block task item
+  if (blockTaskItem && !withinIncompleteTask) {
+    const blockTaskItemParent = findParentNodeOfTypeClosestToPos($nodePos, blockTaskItem);
+    // If nested in a blockTaskItem that is incomplete
+    if (blockTaskItemParent) {
+      withinIncompleteTask = blockTaskItemParent.node.attrs.state !== 'DONE';
+    }
+  }
   const color = withinIncompleteTask && isPastDate(timestamp) ? 'red' : undefined;
   const displayString = withinIncompleteTask ? timestampToTaskContext(timestamp, intl) : timestampToString(timestamp, intl);
   return {

package/dist/esm/nodeviews/utils.js

@@ -1,4 +1,5 @@
 import { isPastDate, timestampToString, timestampToTaskContext } from '@atlaskit/editor-common/utils';
+import { findParentNodeOfTypeClosestToPos } from '@atlaskit/editor-prosemirror/utils';
 export var getDateInformation = function getDateInformation(timestamp, intl, state, pos) {
   if (!state) {
     return {
@@ -8,13 +9,25 @@ export var getDateInformation = function getDateInformation(timestamp, intl, sta
   }
   var doc = state.doc,
     selection = state.selection;
-  var taskItem = state.schema.nodes.taskItem;
+  var _state$schema$nodes = state.schema.nodes,
+    taskItem = _state$schema$nodes.taskItem,
+    blockTaskItem = _state$schema$nodes.blockTaskItem;
 
   // We fall back to selection.$from even though it does not cover all use cases
   // eg. upon Editor init, selection is at the start, not at the Date node
   var $nodePos = typeof pos === 'number' ? doc.resolve(pos) : selection.$from;
   var parent = $nodePos.parent;
   var withinIncompleteTask = parent.type === taskItem && parent.attrs.state !== 'DONE';
+
+  // If there is blockTaskItem in the schema and it's not nested in an incomplete task item,
+  // check if it's nested in an incomplete block task item
+  if (blockTaskItem && !withinIncompleteTask) {
+    var blockTaskItemParent = findParentNodeOfTypeClosestToPos($nodePos, blockTaskItem);
+    // If nested in a blockTaskItem that is incomplete
+    if (blockTaskItemParent) {
+      withinIncompleteTask = blockTaskItemParent.node.attrs.state !== 'DONE';
+    }
+  }
   var color = withinIncompleteTask && isPastDate(timestamp) ? 'red' : undefined;
   var displayString = withinIncompleteTask ? timestampToTaskContext(timestamp, intl) : timestampToString(timestamp, intl);
   return {

package/dist/types/datePluginType.d.ts

@@ -11,11 +11,11 @@ export type DatePluginDependencies = [
     OptionalPlugin<EditorViewModePlugin>
 ];
 export type DatePlugin = NextEditorPlugin<'date', {
-    pluginConfiguration: DatePluginOptions | undefined;
-    dependencies: DatePluginDependencies;
-    sharedState: DatePluginSharedState;
     commands: {
-        insertDate: InsertDate;
         deleteDate: DeleteDate;
+        insertDate: InsertDate;
     };
+    dependencies: DatePluginDependencies;
+    pluginConfiguration: DatePluginOptions | undefined;
+    sharedState: DatePluginSharedState;
 }>;

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

@@ -1,14 +1,14 @@
 export type DatePluginState = {
-    isQuickInsertAction?: boolean;
-    isNew: boolean;
-    showDatePickerAt: number | null;
-    isDateEmpty: boolean;
     focusDateInput: boolean;
+    isDateEmpty: boolean;
     isInitialised: boolean;
+    isNew: boolean;
+    isQuickInsertAction?: boolean;
+    showDatePickerAt: number | null;
 };
 export type DatePluginMeta = {
-    isNew?: boolean;
-    showDatePickerAt?: number | null;
     isDateEmpty?: boolean;
     isInitialised: boolean;
+    isNew?: boolean;
+    showDatePickerAt?: number | null;
 };

package/dist/types/types/index.d.ts

@@ -7,9 +7,9 @@ import type { EditorDisabledPlugin } from '@atlaskit/editor-plugin-editor-disabl
 import type { EditorViewModePlugin } from '@atlaskit/editor-plugin-editor-viewmode';
 export type DateSegment = 'day' | 'month' | 'year';
 export type DateType = {
-    year: number;
-    month: number;
     day?: number;
+    month: number;
+    year: number;
 };
 export interface DatePluginOptions {
     weekStartDay?: WeekDay;
@@ -21,29 +21,29 @@ export interface DatePluginOptions {
  */
 export type DatePluginConfig = DatePluginOptions;
 export type DatePluginSharedState = {
-    showDatePickerAt?: number | null;
-    isNew: boolean;
     focusDateInput: boolean;
     isInitialised: boolean;
+    isNew: boolean;
+    showDatePickerAt?: number | null;
 };
 export type InsertDate = (props: {
-    date?: DateType;
-    inputMethod?: TOOLBAR_MENU_TYPE;
     commitMethod?: INPUT_METHOD.PICKER | INPUT_METHOD.KEYBOARD;
+    date?: DateType;
     enterPressed?: boolean;
+    inputMethod?: TOOLBAR_MENU_TYPE;
 }) => EditorCommand;
 export type DeleteDate = EditorCommand;
 export type DatePlugin = NextEditorPlugin<'date', {
-    pluginConfiguration: DatePluginOptions | undefined;
+    commands: {
+        deleteDate: DeleteDate;
+        insertDate: InsertDate;
+    };
     dependencies: [
         typeof analyticsPlugin,
         EditorDisabledPlugin,
         OptionalPlugin<AnnotationPlugin>,
         OptionalPlugin<EditorViewModePlugin>
     ];
+    pluginConfiguration: DatePluginOptions | undefined;
     sharedState: DatePluginSharedState;
-    commands: {
-        insertDate: InsertDate;
-        deleteDate: DeleteDate;
-    };
 }>;

package/dist/types/ui/DatePicker/date-picker-input.d.ts

@@ -7,17 +7,17 @@ import type { WrappedComponentProps } from 'react-intl-next';
 import type { DispatchAnalyticsEvent } from '@atlaskit/editor-common/analytics';
 import type { DateType } from '../../types';
 export interface InputProps {
-    /** Locale code string (eg. "en-AU") */
-    locale: string;
-    date: DateType;
-    dispatchAnalyticsEvent?: DispatchAnalyticsEvent;
-    onNewDate: (date: DateType) => void;
-    onSubmitDate: (date: DateType | null) => void;
-    onEmptySubmit: () => void;
     /** Automatically focus the text field */
     autoFocus?: boolean;
     /** Automatically select all text in the field. Requires autoFocus to be true. */
     autoSelectAll?: boolean;
+    date: DateType;
+    dispatchAnalyticsEvent?: DispatchAnalyticsEvent;
+    /** Locale code string (eg. "en-AU") */
+    locale: string;
+    onEmptySubmit: () => void;
+    onNewDate: (date: DateType) => void;
+    onSubmitDate: (date: DateType | null) => void;
 }
 export interface InputState {
     inputText: string;

package/dist/types/ui/DatePicker/index.d.ts

@@ -9,29 +9,29 @@ import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import type { DispatchAnalyticsEvent } from '@atlaskit/editor-common/analytics';
 import type { DateType } from '../../types';
 export interface Props {
-    element: HTMLElement | null;
-    closeDatePicker: () => void;
-    /** Whether the date is newly created, selcting and focusing the input */
-    isNew: boolean;
     /** Whether to automatically focus the input */
     autoFocus?: boolean;
-    onSelect: (date: DateType | null, commitMethod: INPUT_METHOD.PICKER | INPUT_METHOD.KEYBOARD) => void;
-    onDelete: () => void;
-    mountTo?: HTMLElement;
     boundariesElement?: HTMLElement;
-    scrollableElement?: HTMLElement;
+    closeDatePicker: () => void;
     closeDatePickerWithAnalytics: ({ date }: {
         date?: DateType;
     }) => void;
-    onTextChanged: (date: DateType) => void;
     dispatchAnalyticsEvent?: DispatchAnalyticsEvent;
+    element: HTMLElement | null;
+    /** Whether the date is newly created, selcting and focusing the input */
+    isNew: boolean;
+    mountTo?: HTMLElement;
+    onDelete: () => void;
+    onSelect: (date: DateType | null, commitMethod: INPUT_METHOD.PICKER | INPUT_METHOD.KEYBOARD) => void;
+    onTextChanged: (date: DateType) => void;
+    scrollableElement?: HTMLElement;
     weekStartDay?: WeekDay;
 }
 export interface State {
     date: DateType;
+    latestValidDate: DateType;
     selected: Array<string>;
     setInputSelectionPos?: number;
-    latestValidDate: DateType;
 }
 declare const _default: React.FC<import("react-intl-next").WithIntlProps<Props & WrappedComponentProps>> & {
     WrappedComponent: React.ComponentType<Props & WrappedComponentProps>;

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

@@ -11,11 +11,11 @@ export type DatePluginDependencies = [
     OptionalPlugin<EditorViewModePlugin>
 ];
 export type DatePlugin = NextEditorPlugin<'date', {
-    pluginConfiguration: DatePluginOptions | undefined;
-    dependencies: DatePluginDependencies;
-    sharedState: DatePluginSharedState;
     commands: {
-        insertDate: InsertDate;
         deleteDate: DeleteDate;
+        insertDate: InsertDate;
     };
+    dependencies: DatePluginDependencies;
+    pluginConfiguration: DatePluginOptions | undefined;
+    sharedState: DatePluginSharedState;
 }>;

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

@@ -1,14 +1,14 @@
 export type DatePluginState = {
-    isQuickInsertAction?: boolean;
-    isNew: boolean;
-    showDatePickerAt: number | null;
-    isDateEmpty: boolean;
     focusDateInput: boolean;
+    isDateEmpty: boolean;
     isInitialised: boolean;
+    isNew: boolean;
+    isQuickInsertAction?: boolean;
+    showDatePickerAt: number | null;
 };
 export type DatePluginMeta = {
-    isNew?: boolean;
-    showDatePickerAt?: number | null;
     isDateEmpty?: boolean;
     isInitialised: boolean;
+    isNew?: boolean;
+    showDatePickerAt?: number | null;
 };

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

@@ -7,9 +7,9 @@ import type { EditorDisabledPlugin } from '@atlaskit/editor-plugin-editor-disabl
 import type { EditorViewModePlugin } from '@atlaskit/editor-plugin-editor-viewmode';
 export type DateSegment = 'day' | 'month' | 'year';
 export type DateType = {
-    year: number;
-    month: number;
     day?: number;
+    month: number;
+    year: number;
 };
 export interface DatePluginOptions {
     weekStartDay?: WeekDay;
@@ -21,29 +21,29 @@ export interface DatePluginOptions {
  */
 export type DatePluginConfig = DatePluginOptions;
 export type DatePluginSharedState = {
-    showDatePickerAt?: number | null;
-    isNew: boolean;
     focusDateInput: boolean;
     isInitialised: boolean;
+    isNew: boolean;
+    showDatePickerAt?: number | null;
 };
 export type InsertDate = (props: {
-    date?: DateType;
-    inputMethod?: TOOLBAR_MENU_TYPE;
     commitMethod?: INPUT_METHOD.PICKER | INPUT_METHOD.KEYBOARD;
+    date?: DateType;
     enterPressed?: boolean;
+    inputMethod?: TOOLBAR_MENU_TYPE;
 }) => EditorCommand;
 export type DeleteDate = EditorCommand;
 export type DatePlugin = NextEditorPlugin<'date', {
-    pluginConfiguration: DatePluginOptions | undefined;
+    commands: {
+        deleteDate: DeleteDate;
+        insertDate: InsertDate;
+    };
     dependencies: [
         typeof analyticsPlugin,
         EditorDisabledPlugin,
         OptionalPlugin<AnnotationPlugin>,
         OptionalPlugin<EditorViewModePlugin>
     ];
+    pluginConfiguration: DatePluginOptions | undefined;
     sharedState: DatePluginSharedState;
-    commands: {
-        insertDate: InsertDate;
-        deleteDate: DeleteDate;
-    };
 }>;

package/dist/types-ts4.5/ui/DatePicker/date-picker-input.d.ts

@@ -7,17 +7,17 @@ import type { WrappedComponentProps } from 'react-intl-next';
 import type { DispatchAnalyticsEvent } from '@atlaskit/editor-common/analytics';
 import type { DateType } from '../../types';
 export interface InputProps {
-    /** Locale code string (eg. "en-AU") */
-    locale: string;
-    date: DateType;
-    dispatchAnalyticsEvent?: DispatchAnalyticsEvent;
-    onNewDate: (date: DateType) => void;
-    onSubmitDate: (date: DateType | null) => void;
-    onEmptySubmit: () => void;
     /** Automatically focus the text field */
     autoFocus?: boolean;
     /** Automatically select all text in the field. Requires autoFocus to be true. */
     autoSelectAll?: boolean;
+    date: DateType;
+    dispatchAnalyticsEvent?: DispatchAnalyticsEvent;
+    /** Locale code string (eg. "en-AU") */
+    locale: string;
+    onEmptySubmit: () => void;
+    onNewDate: (date: DateType) => void;
+    onSubmitDate: (date: DateType | null) => void;
 }
 export interface InputState {
     inputText: string;

package/dist/types-ts4.5/ui/DatePicker/index.d.ts

@@ -9,29 +9,29 @@ import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import type { DispatchAnalyticsEvent } from '@atlaskit/editor-common/analytics';
 import type { DateType } from '../../types';
 export interface Props {
-    element: HTMLElement | null;
-    closeDatePicker: () => void;
-    /** Whether the date is newly created, selcting and focusing the input */
-    isNew: boolean;
     /** Whether to automatically focus the input */
     autoFocus?: boolean;
-    onSelect: (date: DateType | null, commitMethod: INPUT_METHOD.PICKER | INPUT_METHOD.KEYBOARD) => void;
-    onDelete: () => void;
-    mountTo?: HTMLElement;
     boundariesElement?: HTMLElement;
-    scrollableElement?: HTMLElement;
+    closeDatePicker: () => void;
     closeDatePickerWithAnalytics: ({ date }: {
         date?: DateType;
     }) => void;
-    onTextChanged: (date: DateType) => void;
     dispatchAnalyticsEvent?: DispatchAnalyticsEvent;
+    element: HTMLElement | null;
+    /** Whether the date is newly created, selcting and focusing the input */
+    isNew: boolean;
+    mountTo?: HTMLElement;
+    onDelete: () => void;
+    onSelect: (date: DateType | null, commitMethod: INPUT_METHOD.PICKER | INPUT_METHOD.KEYBOARD) => void;
+    onTextChanged: (date: DateType) => void;
+    scrollableElement?: HTMLElement;
     weekStartDay?: WeekDay;
 }
 export interface State {
     date: DateType;
+    latestValidDate: DateType;
     selected: Array<string>;
     setInputSelectionPos?: number;
-    latestValidDate: DateType;
 }
 declare const _default: React.FC<import("react-intl-next").WithIntlProps<Props & WrappedComponentProps>> & {
     WrappedComponent: React.ComponentType<Props & WrappedComponentProps>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-date",
-	"version": "5.1.9",
+	"version": "5.1.11",
 	"description": "Date plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -32,7 +32,7 @@
 		".": "./src/index.ts"
 	},
 	"dependencies": {
-		"@atlaskit/adf-schema": "^50.2.1",
+		"@atlaskit/adf-schema": "^50.2.2",
 		"@atlaskit/calendar": "^17.1.0",
 		"@atlaskit/css": "^0.12.0",
 		"@atlaskit/date": "^2.0.0",
@@ -42,13 +42,13 @@
 		"@atlaskit/editor-plugin-editor-viewmode": "^5.0.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@atlaskit/editor-shared-styles": "^3.6.0",
-		"@atlaskit/form": "^12.1.0",
+		"@atlaskit/form": "^12.2.0",
 		"@atlaskit/icon": "^28.0.0",
 		"@atlaskit/locale": "^3.0.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/textfield": "^8.0.0",
 		"@atlaskit/theme": "^19.0.0",
-		"@atlaskit/tmp-editor-statsig": "^11.3.0",
+		"@atlaskit/tmp-editor-statsig": "^11.6.0",
 		"@atlaskit/tokens": "^6.0.0",
 		"@atlaskit/visually-hidden": "^3.0.0",
 		"@babel/runtime": "^7.0.0",
@@ -60,19 +60,19 @@
 	"devDependencies": {
 		"@atlaskit/editor-plugin-composition": "^2.0.0",
 		"@atlaskit/editor-plugin-content-insertion": "^3.1.0",
-		"@atlaskit/editor-plugin-decorations": "^3.0.0",
+		"@atlaskit/editor-plugin-decorations": "^3.1.0",
 		"@atlaskit/editor-plugin-feature-flags": "^2.0.0",
 		"@atlaskit/editor-plugin-guideline": "^3.0.0",
 		"@atlaskit/editor-plugin-quick-insert": "^3.0.0",
-		"@atlaskit/editor-plugin-selection": "^3.1.0",
-		"@atlaskit/editor-plugin-table": "^12.2.0",
+		"@atlaskit/editor-plugin-selection": "^3.2.0",
+		"@atlaskit/editor-plugin-table": "^12.3.0",
 		"@atlaskit/editor-plugin-tasks-and-decisions": "^6.4.0",
 		"@atlaskit/editor-plugin-type-ahead": "^3.1.0",
 		"@atlaskit/editor-plugin-width": "^4.0.0",
 		"@testing-library/react": "^13.4.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^107.26.0",
+		"@atlaskit/editor-common": "^107.30.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0"
 	},