@atlaskit/editor-plugin-code-block 13.0.1 → 13.1.1

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

@@ -1,9 +1,25 @@
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 import type { DecorationSet } from '@atlaskit/editor-prosemirror/view';
+import type { FormatCodeResult, LanguageSource } from '../utils/format-code/formatter';
+export type PendingFormatRequest = {
+    languageSource: LanguageSource;
+    pos: number;
+    requestId: string;
+};
+export type ResolveFormatCodeOutcome = 'failed' | 'formatted' | 'unchanged';
+export type FormatCodeErrorState = {
+    errorType: Extract<FormatCodeResult, {
+        status: 'failed';
+    }>['errorType'];
+    languageSource: LanguageSource;
+    localId: string;
+};
 export type CodeBlockState = {
     contentCopied: boolean;
     decorations: DecorationSet;
+    formatCodeErrors: Record<string, FormatCodeErrorState>;
     isNodeSelected: boolean;
+    pendingFormats: Record<string, PendingFormatRequest>;
     pos: number | null;
     shouldIgnoreFollowingMutations: boolean;
 };

package/dist/types/ui/FormatCodeErrorFlag.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { CodeBlockPlugin } from '../index';
+export declare const FormatCodeErrorFlag: ({ api, }: {
+    api?: ExtractInjectionAPI<CodeBlockPlugin>;
+}) => React.JSX.Element | null;

package/dist/types/utils/format-code/format-code-state.d.ts

@@ -0,0 +1,4 @@
+import type { EditorState, ReadonlyTransaction } from '@atlaskit/editor-prosemirror/state';
+import type { CodeBlockState } from '../../pm-plugins/main-state';
+export declare const mapPendingFormats: (pendingFormats: CodeBlockState["pendingFormats"], tr: ReadonlyTransaction, newState: EditorState) => CodeBlockState["pendingFormats"];
+export declare const applyFormatCodeMeta: (pluginState: CodeBlockState, meta: ReturnType<ReadonlyTransaction["getMeta"]>) => CodeBlockState;

package/dist/types/utils/format-code/formatter-impl.d.ts

@@ -0,0 +1,5 @@
+import type { FormatCodeResult } from './formatter';
+export declare const formatCode: ({ content, language, }: {
+    content: string;
+    language: FormatCodeResult["language"];
+}) => Promise<FormatCodeResult>;

package/dist/types/utils/format-code/formatter.d.ts

@@ -0,0 +1,25 @@
+import type { Command } from '@atlaskit/editor-common/types';
+declare const supportedFormatLanguages: readonly ["json", "javascript", "jsx", "typescript", "tsx", "sql"];
+type FormatCodeLanguage = (typeof supportedFormatLanguages)[number];
+export type FormatCodeResult = {
+    content: string;
+    language: FormatCodeLanguage;
+    status: 'formatted' | 'unchanged';
+} | {
+    errorType: 'formatter-execution-failed' | 'formatter-load-failed';
+    language: FormatCodeLanguage;
+    status: 'failed';
+};
+export type LanguageSource = 'auto-detected' | 'selected';
+type FormatCode = (args: {
+    content: string;
+    language: FormatCodeLanguage;
+}) => Promise<FormatCodeResult>;
+type FormatterModule = {
+    formatCode: FormatCode;
+};
+export declare const isSupportedFormatLanguage: (language: string | null | undefined) => language is FormatCodeLanguage;
+export declare const preloadFormatterModule: () => Promise<FormatterModule>;
+export declare const preloadFormatterOnIntent: () => Command;
+export declare const formatCode: FormatCode;
+export {};

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

@@ -11,6 +11,7 @@ import type { InteractionPlugin } from '@atlaskit/editor-plugin-interaction';
 import type { SelectionPlugin } from '@atlaskit/editor-plugin-selection';
 import type { ToolbarPlugin } from '@atlaskit/editor-plugin-toolbar';
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+import type { CodeBlockState } from './pm-plugins/main-state';
 import type { CodeBlockPluginOptions } from './types';
 type CodeBlockDependencies = [
     DecorationsPlugin,
@@ -32,6 +33,8 @@ export type CodeBlockPlugin = NextEditorPlugin<'codeBlock', {
     pluginConfiguration: CodeBlockPluginOptions | undefined;
     sharedState: {
         copyButtonHoverNode: PMNode;
+        formatCodeErrors: CodeBlockState['formatCodeErrors'];
+        pendingFormats: CodeBlockState['pendingFormats'];
     } | undefined;
 }>;
 export {};

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

@@ -1,13 +1,18 @@
 import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
-import type { Command, EditorCommand } from '@atlaskit/editor-common/types';
+import type { Command, EditorCommand, ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
+import type { CodeBlockPlugin } from '../codeBlockPluginType';
 import type { LanguagePickerSelectionSource } from '../ui/language-picker-options';
 export declare const removeCodeBlockWithAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => Command;
 export declare const removeCodeBlock: Command;
 export declare const changeLanguage: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (language: string | null, selectionSource?: LanguagePickerSelectionSource) => Command;
 /** Queue auto-detection for selected code block. */
 export declare const detectLanguage: () => Command;
+export declare const createFormatCodeOnClick: ({ api, editorAnalyticsAPI, }: {
+    api?: ExtractInjectionAPI<CodeBlockPlugin>;
+    editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
+}) => Command;
 export declare const copyContentToClipboardWithAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => Command;
 export declare const copyContentToClipboard: Command;
 export declare const resetCopiedState: Command;

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

@@ -1,7 +1,10 @@
 export declare const ACTIONS: {
+    CLEAR_FORMAT_CODE_ERROR: string;
+    REMOVE_AUTO_DETECT_ENTRY: string;
+    RESOLVE_FORMAT_CODE: string;
+    SET_AUTO_DETECT_ENTRY: string;
     SET_COPIED_TO_CLIPBOARD: string;
-    SET_SHOULD_IGNORE_FOLLOWING_MUTATIONS: string;
     SET_IS_WRAPPED: string;
-    SET_AUTO_DETECT_ENTRY: string;
-    REMOVE_AUTO_DETECT_ENTRY: string;
+    SET_SHOULD_IGNORE_FOLLOWING_MUTATIONS: string;
+    START_FORMAT_CODE: string;
 };

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

@@ -1,9 +1,25 @@
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 import type { DecorationSet } from '@atlaskit/editor-prosemirror/view';
+import type { FormatCodeResult, LanguageSource } from '../utils/format-code/formatter';
+export type PendingFormatRequest = {
+    languageSource: LanguageSource;
+    pos: number;
+    requestId: string;
+};
+export type ResolveFormatCodeOutcome = 'failed' | 'formatted' | 'unchanged';
+export type FormatCodeErrorState = {
+    errorType: Extract<FormatCodeResult, {
+        status: 'failed';
+    }>['errorType'];
+    languageSource: LanguageSource;
+    localId: string;
+};
 export type CodeBlockState = {
     contentCopied: boolean;
     decorations: DecorationSet;
+    formatCodeErrors: Record<string, FormatCodeErrorState>;
     isNodeSelected: boolean;
+    pendingFormats: Record<string, PendingFormatRequest>;
     pos: number | null;
     shouldIgnoreFollowingMutations: boolean;
 };

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

@@ -0,0 +1,6 @@
+import React from 'react';
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { CodeBlockPlugin } from '../index';
+export declare const FormatCodeErrorFlag: ({ api, }: {
+    api?: ExtractInjectionAPI<CodeBlockPlugin>;
+}) => React.JSX.Element | null;

package/dist/types-ts4.5/utils/format-code/format-code-state.d.ts

@@ -0,0 +1,4 @@
+import type { EditorState, ReadonlyTransaction } from '@atlaskit/editor-prosemirror/state';
+import type { CodeBlockState } from '../../pm-plugins/main-state';
+export declare const mapPendingFormats: (pendingFormats: CodeBlockState["pendingFormats"], tr: ReadonlyTransaction, newState: EditorState) => CodeBlockState["pendingFormats"];
+export declare const applyFormatCodeMeta: (pluginState: CodeBlockState, meta: ReturnType<ReadonlyTransaction["getMeta"]>) => CodeBlockState;

package/dist/types-ts4.5/utils/format-code/formatter-impl.d.ts

@@ -0,0 +1,5 @@
+import type { FormatCodeResult } from './formatter';
+export declare const formatCode: ({ content, language, }: {
+    content: string;
+    language: FormatCodeResult["language"];
+}) => Promise<FormatCodeResult>;

package/dist/types-ts4.5/utils/format-code/formatter.d.ts

@@ -0,0 +1,32 @@
+import type { Command } from '@atlaskit/editor-common/types';
+declare const supportedFormatLanguages: readonly [
+    "json",
+    "javascript",
+    "jsx",
+    "typescript",
+    "tsx",
+    "sql"
+];
+type FormatCodeLanguage = (typeof supportedFormatLanguages)[number];
+export type FormatCodeResult = {
+    content: string;
+    language: FormatCodeLanguage;
+    status: 'formatted' | 'unchanged';
+} | {
+    errorType: 'formatter-execution-failed' | 'formatter-load-failed';
+    language: FormatCodeLanguage;
+    status: 'failed';
+};
+export type LanguageSource = 'auto-detected' | 'selected';
+type FormatCode = (args: {
+    content: string;
+    language: FormatCodeLanguage;
+}) => Promise<FormatCodeResult>;
+type FormatterModule = {
+    formatCode: FormatCode;
+};
+export declare const isSupportedFormatLanguage: (language: string | null | undefined) => language is FormatCodeLanguage;
+export declare const preloadFormatterModule: () => Promise<FormatterModule>;
+export declare const preloadFormatterOnIntent: () => Command;
+export declare const formatCode: FormatCode;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-code-block",
-	"version": "13.0.1",
+	"version": "13.1.1",
 	"description": "Code block plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -43,19 +43,20 @@
 		"@atlaskit/editor-prosemirror": "^7.3.0",
 		"@atlaskit/editor-shared-styles": "^3.11.0",
 		"@atlaskit/editor-toolbar": "^1.10.0",
+		"@atlaskit/flag": "^17.12.0",
 		"@atlaskit/frontend-utilities": "^3.4.0",
 		"@atlaskit/icon": "^35.4.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/primitives": "^19.0.0",
 		"@atlaskit/prosemirror-input-rules": "^3.7.0",
 		"@atlaskit/select": "^21.12.0",
-		"@atlaskit/tmp-editor-statsig": "^89.0.0",
-		"@atlaskit/tokens": "^13.1.0",
+		"@atlaskit/tmp-editor-statsig": "^89.4.0",
+		"@atlaskit/tokens": "^13.3.0",
 		"@babel/runtime": "^7.0.0",
-		"@compiled/react": "^0.20.0"
+		"@compiled/react": "patch:@compiled/react@npm%3A0.20.0#~/.yarn/patches/@compiled-react-npm-0.20.0-a771aa67a6.patch"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^115.2.0",
+		"@atlaskit/editor-common": "^115.7.0",
 		"react": "^18.2.0",
 		"react-intl": "^5.25.1 || ^6.0.0 || ^7.0.0"
 	},
@@ -110,6 +111,9 @@
 		"platform_editor_code_block_add_line_number_button": {
 			"type": "boolean"
 		},
+		"platform_editor_code_block_formatting": {
+			"type": "boolean"
+		},
 		"platform_editor_code_block_language_detection_flow": {
 			"type": "boolean"
 		}