@atlaskit/editor-core 185.9.5 → 185.10.0

package/CHANGELOG.md

@@ -1,5 +1,41 @@
 # @atlaskit/editor-core
 
+## 185.10.0
+
+### Minor Changes
+
+- [`41820924223`](https://bitbucket.org/atlassian/atlassian-frontend/commits/41820924223) - [ux] [ED-15876] Add additional value option to `allowDate` editor prop. Previously it could only be a boolean (true or false) but now it can be a boolean OR an object with `weekStartDay` and `WeekDay` (from `@atlaskit/calendar/types`) type as the value.
+
+  Example Usage:
+
+  ```tsx
+  const startOfWeekDay = get(
+    getLocale(locale),
+    'options.weekStartsOn',
+    DEFAULT_WEEK_START_DAY,
+  );
+
+  <Editor
+    editorProps={{
+      allowDate: { weekStartDay: 5 },
+    }}
+  />;
+  ```
+
+  OR
+
+  ```tsx
+  <Editor
+    editorProps={{
+      allowDate: false,
+    }}
+  />
+  ```
+
+  is also still valid.
+
+  This allows the users preferred day for the week to begin in the date calendar picker to be passed in to the editor. Eg. instead of it always defaulting to the week starting on Sunday (0), we could pass in 1 to make it Monday.
+
 ## 185.9.5
 
 ### Patch Changes

package/dist/cjs/labs/next/presets/universal.js

@@ -263,7 +263,10 @@ function createUniversalPreset(appearance, props, featureFlags, prevAppearance,
     return builder;
   }).maybeAdd(_plugins.datePlugin, function (plugin, builder) {
     if (props.allowDate) {
-      return builder.add(plugin);
+      var dateConfig = (0, _typeof2.default)(props.allowDate) === 'object' ? props.allowDate : {};
+      return builder.add([plugin, {
+        weekStartDay: dateConfig.weekStartDay
+      }]);
     }
     return builder;
   }).maybeAdd(_plugins.placeholderTextPlugin, function (plugin, builder) {

package/dist/cjs/plugins/date/index.js

@@ -38,7 +38,8 @@ function ContentComponent(_ref) {
     popupsMountPoint = _ref.popupsMountPoint,
     popupsBoundariesElement = _ref.popupsBoundariesElement,
     popupsScrollableElement = _ref.popupsScrollableElement,
-    dependencyApi = _ref.dependencyApi;
+    dependencyApi = _ref.dependencyApi,
+    weekStartDay = _ref.weekStartDay;
   var dispatch = editorView.dispatch;
   var domAtPos = editorView.domAtPos.bind(editorView);
   var _useSharedPluginState = (0, _hooks.useSharedPluginState)(dependencyApi, ['date', 'editorDisabled']),
@@ -86,10 +87,13 @@ function ContentComponent(_ref) {
       })(editorView.state, dispatch);
       editorView.focus();
     },
-    dispatchAnalyticsEvent: dispatchAnalyticsEvent
+    dispatchAnalyticsEvent: dispatchAnalyticsEvent,
+    weekStartDay: weekStartDay
   });
 }
-var datePlugin = function datePlugin(_, api) {
+var datePlugin = function datePlugin() {
+  var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  var api = arguments.length > 1 ? arguments[1] : undefined;
   return {
     name: 'date',
     getSharedState: function getSharedState(editorState) {
@@ -143,7 +147,8 @@ var datePlugin = function datePlugin(_, api) {
         dispatchAnalyticsEvent: dispatchAnalyticsEvent,
         popupsMountPoint: popupsMountPoint,
         popupsBoundariesElement: popupsBoundariesElement,
-        popupsScrollableElement: popupsScrollableElement
+        popupsScrollableElement: popupsScrollableElement,
+        weekStartDay: options.weekStartDay
       });
     },
     pluginsOptions: {

package/dist/cjs/plugins/date/ui/DatePicker/index.js

@@ -108,7 +108,8 @@ var DatePicker = /*#__PURE__*/function (_React$Component) {
         intl = _this$props.intl,
         dispatchAnalyticsEvent = _this$props.dispatchAnalyticsEvent,
         isNew = _this$props.isNew,
-        autoFocus = _this$props.autoFocus;
+        autoFocus = _this$props.autoFocus,
+        weekStartDay = _this$props.weekStartDay;
       var timestamp = element.getAttribute('timestamp');
       if (this.state === null) {
         // Without this, you can blow up the page by slowing down cpu, opening date, typing after date
@@ -156,7 +157,8 @@ var DatePicker = /*#__PURE__*/function (_React$Component) {
         month: month,
         year: year,
         selected: selected,
-        ref: this.handleRef
+        ref: this.handleRef,
+        weekStartDay: weekStartDay
       })));
     }
   }]);

package/dist/cjs/version-wrapper.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.version = exports.nextMajorVersion = exports.name = void 0;
 var name = "@atlaskit/editor-core";
 exports.name = name;
-var version = "185.9.5";
+var version = "185.10.0";
 exports.version = version;
 var nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-core",
-	"version": "185.9.5",
+	"version": "185.10.0",
 	"sideEffects": false
 }

package/dist/es2019/labs/next/presets/universal.js

@@ -258,7 +258,10 @@ export default function createUniversalPreset(appearance, props, featureFlags, p
     return builder;
   }).maybeAdd(datePlugin, (plugin, builder) => {
     if (props.allowDate) {
-      return builder.add(plugin);
+      const dateConfig = typeof props.allowDate === 'object' ? props.allowDate : {};
+      return builder.add([plugin, {
+        weekStartDay: dateConfig.weekStartDay
+      }]);
     }
     return builder;
   }).maybeAdd(placeholderTextPlugin, (plugin, builder) => {

package/dist/es2019/plugins/date/index.js

@@ -20,7 +20,8 @@ function ContentComponent({
   popupsMountPoint,
   popupsBoundariesElement,
   popupsScrollableElement,
-  dependencyApi
+  dependencyApi,
+  weekStartDay
 }) {
   const {
     dispatch
@@ -75,10 +76,11 @@ function ContentComponent({
       })(editorView.state, dispatch);
       editorView.focus();
     },
-    dispatchAnalyticsEvent: dispatchAnalyticsEvent
+    dispatchAnalyticsEvent: dispatchAnalyticsEvent,
+    weekStartDay: weekStartDay
   });
 }
-const datePlugin = (_, api) => ({
+const datePlugin = (options = {}, api) => ({
   name: 'date',
   getSharedState(editorState) {
     if (!editorState) {
@@ -133,7 +135,8 @@ const datePlugin = (_, api) => ({
       dispatchAnalyticsEvent: dispatchAnalyticsEvent,
       popupsMountPoint: popupsMountPoint,
       popupsBoundariesElement: popupsBoundariesElement,
-      popupsScrollableElement: popupsScrollableElement
+      popupsScrollableElement: popupsScrollableElement,
+      weekStartDay: options.weekStartDay
     });
   },
   pluginsOptions: {

package/dist/es2019/plugins/date/ui/DatePicker/index.js

@@ -91,7 +91,8 @@ class DatePicker extends React.Component {
       intl,
       dispatchAnalyticsEvent,
       isNew,
-      autoFocus
+      autoFocus,
+      weekStartDay
     } = this.props;
     const timestamp = element.getAttribute('timestamp');
     if (this.state === null) {
@@ -141,7 +142,8 @@ class DatePicker extends React.Component {
       month: month,
       year: year,
       selected: selected,
-      ref: this.handleRef
+      ref: this.handleRef,
+      weekStartDay: weekStartDay
     })));
   }
 }

package/dist/es2019/version-wrapper.js

@@ -1,5 +1,5 @@
 export const name = "@atlaskit/editor-core";
-export const version = "185.9.5";
+export const version = "185.10.0";
 export const nextMajorVersion = () => {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-core",
-	"version": "185.9.5",
+	"version": "185.10.0",
 	"sideEffects": false
 }

package/dist/esm/labs/next/presets/universal.js

@@ -256,7 +256,10 @@ export default function createUniversalPreset(appearance, props, featureFlags, p
     return builder;
   }).maybeAdd(datePlugin, function (plugin, builder) {
     if (props.allowDate) {
-      return builder.add(plugin);
+      var dateConfig = _typeof(props.allowDate) === 'object' ? props.allowDate : {};
+      return builder.add([plugin, {
+        weekStartDay: dateConfig.weekStartDay
+      }]);
     }
     return builder;
   }).maybeAdd(placeholderTextPlugin, function (plugin, builder) {

package/dist/esm/plugins/date/index.js

@@ -26,7 +26,8 @@ function ContentComponent(_ref) {
     popupsMountPoint = _ref.popupsMountPoint,
     popupsBoundariesElement = _ref.popupsBoundariesElement,
     popupsScrollableElement = _ref.popupsScrollableElement,
-    dependencyApi = _ref.dependencyApi;
+    dependencyApi = _ref.dependencyApi,
+    weekStartDay = _ref.weekStartDay;
   var dispatch = editorView.dispatch;
   var domAtPos = editorView.domAtPos.bind(editorView);
   var _useSharedPluginState = useSharedPluginState(dependencyApi, ['date', 'editorDisabled']),
@@ -74,10 +75,13 @@ function ContentComponent(_ref) {
       })(editorView.state, dispatch);
       editorView.focus();
     },
-    dispatchAnalyticsEvent: dispatchAnalyticsEvent
+    dispatchAnalyticsEvent: dispatchAnalyticsEvent,
+    weekStartDay: weekStartDay
   });
 }
-var datePlugin = function datePlugin(_, api) {
+var datePlugin = function datePlugin() {
+  var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  var api = arguments.length > 1 ? arguments[1] : undefined;
   return {
     name: 'date',
     getSharedState: function getSharedState(editorState) {
@@ -131,7 +135,8 @@ var datePlugin = function datePlugin(_, api) {
         dispatchAnalyticsEvent: dispatchAnalyticsEvent,
         popupsMountPoint: popupsMountPoint,
         popupsBoundariesElement: popupsBoundariesElement,
-        popupsScrollableElement: popupsScrollableElement
+        popupsScrollableElement: popupsScrollableElement,
+        weekStartDay: options.weekStartDay
       });
     },
     pluginsOptions: {

package/dist/esm/plugins/date/ui/DatePicker/index.js

@@ -101,7 +101,8 @@ var DatePicker = /*#__PURE__*/function (_React$Component) {
         intl = _this$props.intl,
         dispatchAnalyticsEvent = _this$props.dispatchAnalyticsEvent,
         isNew = _this$props.isNew,
-        autoFocus = _this$props.autoFocus;
+        autoFocus = _this$props.autoFocus,
+        weekStartDay = _this$props.weekStartDay;
       var timestamp = element.getAttribute('timestamp');
       if (this.state === null) {
         // Without this, you can blow up the page by slowing down cpu, opening date, typing after date
@@ -149,7 +150,8 @@ var DatePicker = /*#__PURE__*/function (_React$Component) {
         month: month,
         year: year,
         selected: selected,
-        ref: this.handleRef
+        ref: this.handleRef,
+        weekStartDay: weekStartDay
       })));
     }
   }]);

package/dist/esm/version-wrapper.js

@@ -1,5 +1,5 @@
 export var name = "@atlaskit/editor-core";
-export var version = "185.9.5";
+export var version = "185.10.0";
 export var nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-core",
-	"version": "185.9.5",
+	"version": "185.10.0",
 	"sideEffects": false
 }

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

@@ -1,7 +1,9 @@
 import { NextEditorPlugin } from '@atlaskit/editor-common/types';
 import type editorDisabledPlugin from '../editor-disabled';
+import { DatePluginConfig } from './types';
 import type { analyticsPlugin } from '@atlaskit/editor-plugin-analytics';
 declare const datePlugin: NextEditorPlugin<'date', {
+    pluginConfiguration: DatePluginConfig | undefined;
     dependencies: [typeof analyticsPlugin, typeof editorDisabledPlugin];
     sharedState: {
         showDatePickerAt?: number | null;

package/dist/types/plugins/date/types.d.ts

@@ -1,6 +1,10 @@
+import type { WeekDay } from '@atlaskit/calendar/types';
 export type DateType = {
     year: number;
     month: number;
     day?: number;
 };
 export type DateSegment = 'day' | 'month' | 'year';
+export interface DatePluginConfig {
+    weekStartDay?: WeekDay;
+}

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

@@ -1,5 +1,6 @@
 /** @jsx jsx */
 import React from 'react';
+import type { WeekDay } from '@atlaskit/calendar/types';
 import { DateType } from '../../types';
 import { INPUT_METHOD } from '../../../analytics/types/enums';
 import type { DispatchAnalyticsEvent } from '@atlaskit/editor-common/analytics';
@@ -21,6 +22,7 @@ export interface Props {
     }) => void;
     onTextChanged: (date: DateType) => void;
     dispatchAnalyticsEvent?: DispatchAnalyticsEvent;
+    weekStartDay?: WeekDay;
 }
 export interface State {
     date: DateType;

package/dist/types/types/editor-props.d.ts

@@ -15,6 +15,7 @@ import { AnnotationProviders } from '../plugins/annotation/types';
 import { BlockTypePluginOptions } from '../plugins/block-type/types';
 import { CodeBlockOptions } from '../plugins/code-block/types';
 import { CollabEditOptions } from '../plugins/collab-edit/types';
+import { DatePluginConfig } from '../plugins/date/types';
 import { FindReplaceOptions } from '../plugins/find-replace/types';
 import type { LinkingOptions } from '@atlaskit/editor-common/types';
 import { LayoutPluginOptions } from '../plugins/layout/types';
@@ -208,7 +209,7 @@ export interface EditorPluginFeatureProps {
     allowExtension?: boolean | ExtensionConfig;
     allowConfluenceInlineComment?: boolean;
     allowTemplatePlaceholders?: boolean | PlaceholderTextOptions;
-    allowDate?: boolean;
+    allowDate?: boolean | DatePluginConfig;
     allowLayouts?: boolean | LayoutPluginOptions;
     allowStatus?: boolean | {
         menuDisabled: boolean;

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

@@ -1,7 +1,9 @@
 import { NextEditorPlugin } from '@atlaskit/editor-common/types';
 import type editorDisabledPlugin from '../editor-disabled';
+import { DatePluginConfig } from './types';
 import type { analyticsPlugin } from '@atlaskit/editor-plugin-analytics';
 declare const datePlugin: NextEditorPlugin<'date', {
+    pluginConfiguration: DatePluginConfig | undefined;
     dependencies: [
         typeof analyticsPlugin,
         typeof editorDisabledPlugin

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

@@ -1,6 +1,10 @@
+import type { WeekDay } from '@atlaskit/calendar/types';
 export type DateType = {
     year: number;
     month: number;
     day?: number;
 };
 export type DateSegment = 'day' | 'month' | 'year';
+export interface DatePluginConfig {
+    weekStartDay?: WeekDay;
+}

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

@@ -1,5 +1,6 @@
 /** @jsx jsx */
 import React from 'react';
+import type { WeekDay } from '@atlaskit/calendar/types';
 import { DateType } from '../../types';
 import { INPUT_METHOD } from '../../../analytics/types/enums';
 import type { DispatchAnalyticsEvent } from '@atlaskit/editor-common/analytics';
@@ -21,6 +22,7 @@ export interface Props {
     }) => void;
     onTextChanged: (date: DateType) => void;
     dispatchAnalyticsEvent?: DispatchAnalyticsEvent;
+    weekStartDay?: WeekDay;
 }
 export interface State {
     date: DateType;

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

@@ -15,6 +15,7 @@ import { AnnotationProviders } from '../plugins/annotation/types';
 import { BlockTypePluginOptions } from '../plugins/block-type/types';
 import { CodeBlockOptions } from '../plugins/code-block/types';
 import { CollabEditOptions } from '../plugins/collab-edit/types';
+import { DatePluginConfig } from '../plugins/date/types';
 import { FindReplaceOptions } from '../plugins/find-replace/types';
 import type { LinkingOptions } from '@atlaskit/editor-common/types';
 import { LayoutPluginOptions } from '../plugins/layout/types';
@@ -208,7 +209,7 @@ export interface EditorPluginFeatureProps {
     allowExtension?: boolean | ExtensionConfig;
     allowConfluenceInlineComment?: boolean;
     allowTemplatePlaceholders?: boolean | PlaceholderTextOptions;
-    allowDate?: boolean;
+    allowDate?: boolean | DatePluginConfig;
     allowLayouts?: boolean | LayoutPluginOptions;
     allowStatus?: boolean | {
         menuDisabled: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-core",
-  "version": "185.9.5",
+  "version": "185.10.0",
   "description": "A package contains Atlassian editor core functionality",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -71,7 +71,7 @@
     "@atlaskit/icon-object": "^6.3.0",
     "@atlaskit/link-analytics": "^8.2.0",
     "@atlaskit/link-datasource": "^0.27.0",
-    "@atlaskit/link-picker": "^1.25.0",
+    "@atlaskit/link-picker": "^1.26.0",
     "@atlaskit/locale": "^2.5.0",
     "@atlaskit/logo": "^13.14.0",
     "@atlaskit/media-card": "^76.0.0",

package/report.api.md

@@ -164,6 +164,7 @@ import { UploadEndEventPayload } from '@atlaskit/media-picker/types';
 import { UploadErrorEventPayload } from '@atlaskit/media-picker/types';
 import { UploadParams } from '@atlaskit/media-picker/types';
 import { UploadPreviewUpdateEventPayload } from '@atlaskit/media-picker/types';
+import type { WeekDay } from '@atlaskit/calendar/types';
 import type { widthPlugin } from '@atlaskit/editor-plugin-width';
 import { WithIntlProps } from 'react-intl-next';
 import { WithPluginState } from '@atlaskit/editor-common/with-plugin-state';
@@ -525,6 +526,12 @@ export const dateMessages: {
   };
 };
 
+// @public (undocumented)
+interface DatePluginConfig {
+  // (undocumented)
+  weekStartDay?: WeekDay;
+}
+
 // @public (undocumented)
 export const datePluginKey: PluginKey<DatePluginState>;
 
@@ -859,7 +866,7 @@ interface EditorPluginFeatureProps {
   // (undocumented)
   allowConfluenceInlineComment?: boolean;
   // (undocumented)
-  allowDate?: boolean;
+  allowDate?: DatePluginConfig | boolean;
   // (undocumented)
   allowExpand?:
     | boolean