@atlaskit/editor-plugin-media 1.29.8 → 1.30.0

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

@@ -1,6 +1,7 @@
 /**
  * @jsxRuntime classic
  * @jsx jsx
+ * @jsxFrag
  */
 import type { MouseEvent } from 'react';
 import React, { Component } from 'react';
@@ -34,7 +35,6 @@ export default class MediaSingleNode extends Component<MediaSingleNodeProps, Med
     state: MediaSingleNodeState;
     mediaSingleWrapperRef: React.RefObject<HTMLDivElement>;
     captionPlaceHolderRef: React.RefObject<HTMLSpanElement>;
-    commentBadgeRef: React.RefObject<HTMLDivElement>;
     createOrUpdateMediaNodeUpdater: (props: MediaSingleNodeProps) => void;
     UNSAFE_componentWillReceiveProps(nextProps: MediaSingleNodeProps): void;
     setViewMediaClientConfig: (props: MediaSingleNodeProps) => Promise<void>;

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

@@ -1,5 +1,6 @@
 import React from 'react';
 import type { IntlShape } from 'react-intl-next';
+import type { AnnotationMarkDefinition } from '@atlaskit/adf-schema';
 import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
@@ -18,5 +19,20 @@ type CommentBadgeProps = {
 export declare const CommentBadge: React.FC<import("react-intl-next").WithIntlProps<CommentBadgeProps>> & {
     WrappedComponent: React.ComponentType<CommentBadgeProps>;
 };
-export declare const CommentBadgeWithRef: React.ForwardRefExoticComponent<Omit<CommentBadgeProps, "intl"> & React.RefAttributes<HTMLDivElement>>;
+/**
+ * Remove CommentBadgeWrapper component above
+ * and rename CommentBadgeNextWrapper to CommentBadgeWrapper
+ * when clean up platform_editor_insert_media_plugin_phase_one feature flag
+ */
+type CommentBadgeNextWrapperProps = {
+    mediaSingleElement?: HTMLElement | null;
+    marks?: AnnotationMarkDefinition[];
+    isDrafting?: boolean;
+    api: ExtractInjectionAPI<MediaNextEditorPluginType>;
+    mediaNode: PMNode | null;
+    view: EditorView;
+    getPos: getPosHandler;
+    badgeSize: 'small' | 'medium';
+};
+export declare const CommentBadgeNextWrapper: ({ api, mediaNode, view, getPos, isDrafting, badgeSize, }: CommentBadgeNextWrapperProps) => JSX.Element | null;
 export {};

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

@@ -0,0 +1,54 @@
+import { type MediaAttributes } from '@atlaskit/adf-schema';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+type MediaId = string;
+type Props = {
+    id: MediaId;
+    nextAttributes: Partial<MediaAttributes>;
+};
+export type MediaAttributesMap = Record<MediaId, Partial<MediaAttributes>>;
+type MediaAttributesCachePerView = MediaAttributesMap;
+export type MediaAttributesCache = WeakMap<EditorView, MediaAttributesCachePerView>;
+export declare const containsSameAttributes: (a: MediaAttributes, b: Partial<MediaAttributes>) => boolean;
+/**
+ * Updates media node attributes in the editor view based on the provided cache.
+ *
+ * @param {EditorView} editorView - The editor view instance where the updates will be applied.
+ * @param {MediaAttributesCache} cache - The cache containing media attributes to be updated.
+ *
+ * This function performs the following steps:
+ * 1. Retrieves the media attributes to update from the cache for the given editor view.
+ * 2. Clears the media attributes cache for the editor view.
+ * 3. Searches for media nodes in the document and collects their positions and new attributes.
+ * 4. If there are any media nodes to update, it applies the updates in a batch.
+ */
+export declare const runUpdate: (editorView: EditorView, cache: MediaAttributesCache) => void;
+/**
+ * Creates a debounced version of the `runUpdate` function to update media node attributes in the editor view.
+ *
+ * @constant
+ * @type {Function}
+ * @param {Function} runUpdate - The function to be debounced.
+ * @param {number} debouncedTime - The debounce delay in milliseconds.
+ * @param {Object} [options] - The debounce options. Defaults to {leading: false, trailing: true}.
+ * @param {Function} keyResolver - A function that returns the key to be used for memoization. In this case, it returns the editor view instance.
+ *
+ * This function performs the following steps:
+ * 1. Debounces the `runUpdate` function with the specified delay and options.
+ * 2. Uses the editor view instance as the key for memoization to ensure that updates are applied correctly.
+ */
+export declare const runUpdateDebounced: (editorView: EditorView, cache: MediaAttributesCache) => void | undefined;
+/**
+ * Updates the media node attributes cache for the given editor view and triggers a debounced update.
+ *
+ * @param {EditorView} editorView - The editor view instance where the updates will be applied.
+ * @param {Props} props - The properties containing the media node ID and the next attributes to be updated.
+ *
+ * This function performs the following steps:
+ * 1. Retrieves the media attributes cache for the given editor view.
+ * 2. If no cache exists, initializes a new cache.
+ * 3. Updates the cache with the new attributes for the specified media node ID.
+ * 4. Sets the updated cache back to the media attributes cache.
+ * 5. Triggers a debounced update to apply the changes in the editor view.
+ */
+export declare const batchMediaNodeAttrsUpdate: (editorView: EditorView, props: Props) => void;
+export {};

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

@@ -0,0 +1,19 @@
+import { type BatchAttrsStepData } from '@atlaskit/adf-schema/steps';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+/**
+ * Applies a batch of attribute update steps to media nodes in the editor view.
+ *
+ * @param {EditorView} editorView - The editor view instance where the updates will be applied.
+ * @param {BatchAttrsStepData[]} steps - An array of steps containing the positions and new attributes for media nodes.
+ * @returns {boolean} - Returns false if no steps were applied or if the document remains unchanged after applying the steps.
+ *
+ * This function performs the following steps:
+ * 1. Creates a new transaction from the current editor state.
+ * 2. If there are no steps to apply, it returns false.
+ * 3. Adds a new `BatchAttrsStep` to the transaction with the provided steps.
+ * 4. If the transaction has no steps or the document remains unchanged, it returns false.
+ * 5. Dispatches the transaction to apply the updates to the editor view.
+ *
+ * TODO: use pluginInjectionAPI to batch updates from a command in a separate PR later
+ */
+export declare const batchStepsUpdate: (editorView: EditorView, steps: BatchAttrsStepData[]) => false | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-media",
-	"version": "1.29.8",
+	"version": "1.30.0",
 	"description": "Media plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -9,9 +9,8 @@
 	},
 	"atlassian": {
 		"team": "Editor: Media Experience Porygon",
-		"releaseModel": "continuous",
 		"singleton": true,
-		"runReact18": false
+		"runReact18": true
 	},
 	"repository": "https://bitbucket.org/atlassian/atlassian-frontend-mirror",
 	"main": "dist/cjs/index.js",
@@ -34,17 +33,17 @@
 	},
 	"dependencies": {
 		"@atlaskit/adf-schema": "^40.9.0",
-		"@atlaskit/analytics-namespaced-context": "^6.11.0",
+		"@atlaskit/analytics-namespaced-context": "^6.12.0",
 		"@atlaskit/analytics-next": "^10.1.0",
 		"@atlaskit/button": "^20.1.0",
-		"@atlaskit/editor-common": "^88.3.0",
+		"@atlaskit/editor-common": "^88.12.0",
 		"@atlaskit/editor-palette": "1.6.0",
 		"@atlaskit/editor-plugin-analytics": "^1.8.0",
-		"@atlaskit/editor-plugin-annotation": "1.19.3",
+		"@atlaskit/editor-plugin-annotation": "1.19.4",
 		"@atlaskit/editor-plugin-decorations": "^1.3.0",
 		"@atlaskit/editor-plugin-editor-disabled": "^1.3.0",
 		"@atlaskit/editor-plugin-editor-viewmode": "^2.1.0",
-		"@atlaskit/editor-plugin-floating-toolbar": "^1.11.0",
+		"@atlaskit/editor-plugin-floating-toolbar": "^1.12.0",
 		"@atlaskit/editor-plugin-focus": "^1.3.0",
 		"@atlaskit/editor-plugin-grid": "^1.2.0",
 		"@atlaskit/editor-plugin-guideline": "^1.2.0",
@@ -54,17 +53,17 @@
 		"@atlaskit/editor-shared-styles": "^2.13.0",
 		"@atlaskit/editor-tables": "^2.8.0",
 		"@atlaskit/form": "^10.5.0",
-		"@atlaskit/icon": "^22.15.0",
-		"@atlaskit/media-card": "^78.1.0",
-		"@atlaskit/media-client": "^27.5.0",
-		"@atlaskit/media-client-react": "^2.1.0",
+		"@atlaskit/icon": "^22.16.0",
+		"@atlaskit/media-card": "^78.2.0",
+		"@atlaskit/media-client": "^27.6.0",
+		"@atlaskit/media-client-react": "^2.2.0",
 		"@atlaskit/media-common": "^11.4.0",
 		"@atlaskit/media-filmstrip": "^47.2.0",
 		"@atlaskit/media-picker": "^66.5.0",
 		"@atlaskit/media-ui": "^25.11.0",
 		"@atlaskit/media-viewer": "^48.7.0",
 		"@atlaskit/platform-feature-flags": "^0.3.0",
-		"@atlaskit/primitives": "^12.0.0",
+		"@atlaskit/primitives": "^12.1.0",
 		"@atlaskit/textfield": "^6.5.0",
 		"@atlaskit/theme": "^13.0.0",
 		"@atlaskit/tokens": "^1.59.0",
@@ -83,8 +82,8 @@
 	},
 	"peerDependencies": {
 		"@atlaskit/media-core": "^34.3.0",
-		"react": "^16.8.0",
-		"react-dom": "^16.8.0",
+		"react": "^16.8.0 || ^17.0.0 || ~18.2.0",
+		"react-dom": "^16.8.0 || ^17.0.0 || ~18.2.0",
 		"react-intl-next": "npm:react-intl@^5.18.1"
 	},
 	"techstack": {
@@ -149,6 +148,9 @@
 		},
 		"platform_editor_insert_media_plugin_phase_one": {
 			"type": "boolean"
+		},
+		"platform_editor_media_batch_updates": {
+			"type": "boolean"
 		}
 	},
 	"stricter": {