@atlaskit/editor-plugin-loom 5.1.2 → 5.1.3

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-plugin-loom
 
+## 5.1.3
+
+### 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.2
 
 ### Patch Changes

package/dist/types/loomPluginType.d.ts

@@ -10,29 +10,7 @@ import type { WidthPlugin } from '@atlaskit/editor-plugin-width';
 import type { LoomPluginState } from './pm-plugins/main';
 import type { LoomPluginOptions, LoomProviderOptions, PositionType, VideoMeta } from './types';
 export type LoomPlugin = NextEditorPlugin<'loom', {
-    pluginConfiguration: LoomPluginOptions;
-    dependencies: [
-        OptionalPlugin<AnalyticsPlugin>,
-        WidthPlugin,
-        HyperlinkPlugin,
-        OptionalPlugin<PrimaryToolbarPlugin>,
-        OptionalPlugin<QuickInsertPlugin>,
-        OptionalPlugin<ConnectivityPlugin>
-    ];
-    sharedState: LoomPluginState | undefined;
     actions: {
-        recordVideo: ({ inputMethod, editorAnalyticsAPI, }: {
-            inputMethod: INPUT_METHOD;
-            editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
-        }) => EditorCommand;
-        /**
-         * Insert loom into the document.
-         *
-         * @param video Video metadata (`sharedUrl` and `title`)
-         * @param positionType {'start' | 'end' | 'current'} Where you want to insert the loom
-         * @returns {boolean} If the loom was successfully inserted
-         */
-        insertLoom: (video: VideoMeta, positionType: PositionType) => boolean;
         /**
          * Given loom provider, initialise loom SDK
          * @returns error message if initialisation failed
@@ -42,5 +20,27 @@ export type LoomPlugin = NextEditorPlugin<'loom', {
         }) => Promise<{
             error?: string;
         }>;
+        /**
+         * Insert loom into the document.
+         *
+         * @param video Video metadata (`sharedUrl` and `title`)
+         * @param positionType {'start' | 'end' | 'current'} Where you want to insert the loom
+         * @returns {boolean} If the loom was successfully inserted
+         */
+        insertLoom: (video: VideoMeta, positionType: PositionType) => boolean;
+        recordVideo: ({ inputMethod, editorAnalyticsAPI, }: {
+            editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
+            inputMethod: INPUT_METHOD;
+        }) => EditorCommand;
     };
+    dependencies: [
+        OptionalPlugin<AnalyticsPlugin>,
+        WidthPlugin,
+        HyperlinkPlugin,
+        OptionalPlugin<PrimaryToolbarPlugin>,
+        OptionalPlugin<QuickInsertPlugin>,
+        OptionalPlugin<ConnectivityPlugin>
+    ];
+    pluginConfiguration: LoomPluginOptions;
+    sharedState: LoomPluginState | undefined;
 }>;

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

@@ -16,13 +16,13 @@ export declare const disableLoom: ({ error }: {
     error: string;
 }) => EditorCommand;
 export declare const recordVideo: ({ inputMethod, editorAnalyticsAPI, }: {
-    inputMethod: INPUT_METHOD;
     editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
+    inputMethod: INPUT_METHOD;
 }) => EditorCommand;
 export declare const recordVideoFailed: ({ inputMethod, error, editorAnalyticsAPI, }: {
-    inputMethod: INPUT_METHOD;
-    error: SDKUnsupportedReasons | undefined;
     editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
+    error: SDKUnsupportedReasons | undefined;
+    inputMethod: INPUT_METHOD;
 }) => EditorCommand;
 export declare const insertVideo: ({ editorAnalyticsAPI, video, }: {
     editorAnalyticsAPI: EditorAnalyticsAPI | undefined;

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

@@ -9,10 +9,10 @@ declare enum SDKUnsupportedReasons {
     NoMediaStreamsSupport = "no-media-streams-support"
 }
 export interface LoomPluginState {
+    error: SDKUnsupportedReasons | undefined;
     isEnabled: boolean;
-    loomButton: HTMLButtonElement | null;
     isRecordingVideo: boolean;
-    error: SDKUnsupportedReasons | undefined;
+    loomButton: HTMLButtonElement | null;
 }
 export declare enum LoomPluginAction {
     ENABLE = 0,
@@ -22,7 +22,7 @@ export declare enum LoomPluginAction {
 }
 export declare const loomPluginKey: PluginKey<LoomPluginState>;
 export declare const createPlugin: ({ config, api, }: {
-    config: LoomPluginOptions;
     api: ExtractInjectionAPI<LoomPlugin> | undefined;
+    config: LoomPluginOptions;
 }) => SafePlugin<LoomPluginState>;
 export {};

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

@@ -1,9 +1,9 @@
 import type React from 'react';
 import { type ButtonProps as AKButtonProps } from '@atlaskit/button';
 export type VideoMeta = {
+    duration?: number;
     sharedUrl: string;
     title: string;
-    duration?: number;
 };
 type LoomClient = {
     attachToButton: (options: {
@@ -15,11 +15,11 @@ export type PositionType = 'start' | 'end' | 'current';
 export type LoomPluginErrorMessages = 'is-supported-failure' | 'failed-to-initialise' | 'api-key-not-provided';
 export type LoomSDKErrorMessages = 'incompatible-browser' | 'third-party-cookies-disabled' | 'no-media-streams-support';
 export type GetClientResult = {
-    status: 'loaded';
     client: LoomClient;
+    status: 'loaded';
 } | {
-    status: 'error';
     message: LoomPluginErrorMessages | LoomSDKErrorMessages;
+    status: 'error';
 };
 export type GetClient = Promise<GetClientResult>;
 export type LoomProviderOptions = {

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

@@ -8,11 +8,11 @@ import type { EditorAppearance, ExtractInjectionAPI } from '@atlaskit/editor-com
 import type { LoomPlugin } from '../loomPluginType';
 import { type ButtonComponentProps } from '../types';
 interface Props extends Omit<ButtonComponentProps, 'onClickBeforeInit'> {
-    disabled: boolean;
-    appearance: EditorAppearance;
     api: ExtractInjectionAPI<LoomPlugin> | undefined;
-    onClick: (event: React.MouseEvent<HTMLElement>) => void;
+    appearance: EditorAppearance;
+    disabled: boolean;
     hideTooltip?: boolean;
+    onClick: (event: React.MouseEvent<HTMLElement>) => void;
 }
 declare const _default: React.ForwardRefExoticComponent<Omit<import("react-intl-next").WithIntlProps<React.PropsWithChildren<Props & WrappedComponentProps & React.RefAttributes<HTMLElement>>>, "ref"> & React.RefAttributes<any>> & {
     WrappedComponent: React.ComponentType<Props & WrappedComponentProps & React.RefAttributes<HTMLElement>>;

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

@@ -10,29 +10,7 @@ import type { WidthPlugin } from '@atlaskit/editor-plugin-width';
 import type { LoomPluginState } from './pm-plugins/main';
 import type { LoomPluginOptions, LoomProviderOptions, PositionType, VideoMeta } from './types';
 export type LoomPlugin = NextEditorPlugin<'loom', {
-    pluginConfiguration: LoomPluginOptions;
-    dependencies: [
-        OptionalPlugin<AnalyticsPlugin>,
-        WidthPlugin,
-        HyperlinkPlugin,
-        OptionalPlugin<PrimaryToolbarPlugin>,
-        OptionalPlugin<QuickInsertPlugin>,
-        OptionalPlugin<ConnectivityPlugin>
-    ];
-    sharedState: LoomPluginState | undefined;
     actions: {
-        recordVideo: ({ inputMethod, editorAnalyticsAPI, }: {
-            inputMethod: INPUT_METHOD;
-            editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
-        }) => EditorCommand;
-        /**
-         * Insert loom into the document.
-         *
-         * @param video Video metadata (`sharedUrl` and `title`)
-         * @param positionType {'start' | 'end' | 'current'} Where you want to insert the loom
-         * @returns {boolean} If the loom was successfully inserted
-         */
-        insertLoom: (video: VideoMeta, positionType: PositionType) => boolean;
         /**
          * Given loom provider, initialise loom SDK
          * @returns error message if initialisation failed
@@ -42,5 +20,27 @@ export type LoomPlugin = NextEditorPlugin<'loom', {
         }) => Promise<{
             error?: string;
         }>;
+        /**
+         * Insert loom into the document.
+         *
+         * @param video Video metadata (`sharedUrl` and `title`)
+         * @param positionType {'start' | 'end' | 'current'} Where you want to insert the loom
+         * @returns {boolean} If the loom was successfully inserted
+         */
+        insertLoom: (video: VideoMeta, positionType: PositionType) => boolean;
+        recordVideo: ({ inputMethod, editorAnalyticsAPI, }: {
+            editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
+            inputMethod: INPUT_METHOD;
+        }) => EditorCommand;
     };
+    dependencies: [
+        OptionalPlugin<AnalyticsPlugin>,
+        WidthPlugin,
+        HyperlinkPlugin,
+        OptionalPlugin<PrimaryToolbarPlugin>,
+        OptionalPlugin<QuickInsertPlugin>,
+        OptionalPlugin<ConnectivityPlugin>
+    ];
+    pluginConfiguration: LoomPluginOptions;
+    sharedState: LoomPluginState | undefined;
 }>;

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

@@ -16,13 +16,13 @@ export declare const disableLoom: ({ error }: {
     error: string;
 }) => EditorCommand;
 export declare const recordVideo: ({ inputMethod, editorAnalyticsAPI, }: {
-    inputMethod: INPUT_METHOD;
     editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
+    inputMethod: INPUT_METHOD;
 }) => EditorCommand;
 export declare const recordVideoFailed: ({ inputMethod, error, editorAnalyticsAPI, }: {
-    inputMethod: INPUT_METHOD;
-    error: SDKUnsupportedReasons | undefined;
     editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
+    error: SDKUnsupportedReasons | undefined;
+    inputMethod: INPUT_METHOD;
 }) => EditorCommand;
 export declare const insertVideo: ({ editorAnalyticsAPI, video, }: {
     editorAnalyticsAPI: EditorAnalyticsAPI | undefined;

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

@@ -9,10 +9,10 @@ declare enum SDKUnsupportedReasons {
     NoMediaStreamsSupport = "no-media-streams-support"
 }
 export interface LoomPluginState {
+    error: SDKUnsupportedReasons | undefined;
     isEnabled: boolean;
-    loomButton: HTMLButtonElement | null;
     isRecordingVideo: boolean;
-    error: SDKUnsupportedReasons | undefined;
+    loomButton: HTMLButtonElement | null;
 }
 export declare enum LoomPluginAction {
     ENABLE = 0,
@@ -22,7 +22,7 @@ export declare enum LoomPluginAction {
 }
 export declare const loomPluginKey: PluginKey<LoomPluginState>;
 export declare const createPlugin: ({ config, api, }: {
-    config: LoomPluginOptions;
     api: ExtractInjectionAPI<LoomPlugin> | undefined;
+    config: LoomPluginOptions;
 }) => SafePlugin<LoomPluginState>;
 export {};

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

@@ -1,9 +1,9 @@
 import type React from 'react';
 import { type ButtonProps as AKButtonProps } from '@atlaskit/button';
 export type VideoMeta = {
+    duration?: number;
     sharedUrl: string;
     title: string;
-    duration?: number;
 };
 type LoomClient = {
     attachToButton: (options: {
@@ -15,11 +15,11 @@ export type PositionType = 'start' | 'end' | 'current';
 export type LoomPluginErrorMessages = 'is-supported-failure' | 'failed-to-initialise' | 'api-key-not-provided';
 export type LoomSDKErrorMessages = 'incompatible-browser' | 'third-party-cookies-disabled' | 'no-media-streams-support';
 export type GetClientResult = {
-    status: 'loaded';
     client: LoomClient;
+    status: 'loaded';
 } | {
-    status: 'error';
     message: LoomPluginErrorMessages | LoomSDKErrorMessages;
+    status: 'error';
 };
 export type GetClient = Promise<GetClientResult>;
 export type LoomProviderOptions = {

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

@@ -8,11 +8,11 @@ import type { EditorAppearance, ExtractInjectionAPI } from '@atlaskit/editor-com
 import type { LoomPlugin } from '../loomPluginType';
 import { type ButtonComponentProps } from '../types';
 interface Props extends Omit<ButtonComponentProps, 'onClickBeforeInit'> {
-    disabled: boolean;
-    appearance: EditorAppearance;
     api: ExtractInjectionAPI<LoomPlugin> | undefined;
-    onClick: (event: React.MouseEvent<HTMLElement>) => void;
+    appearance: EditorAppearance;
+    disabled: boolean;
     hideTooltip?: boolean;
+    onClick: (event: React.MouseEvent<HTMLElement>) => void;
 }
 declare const _default: React.ForwardRefExoticComponent<Omit<import("react-intl-next").WithIntlProps<React.PropsWithChildren<Props & WrappedComponentProps & React.RefAttributes<HTMLElement>>>, "ref"> & React.RefAttributes<any>> & {
     WrappedComponent: React.ComponentType<Props & WrappedComponentProps & React.RefAttributes<HTMLElement>>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-loom",
-	"version": "5.1.2",
+	"version": "5.1.3",
 	"description": "Loom plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -50,7 +50,7 @@
 		"@loomhq/record-sdk": "^2.36.18"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^107.26.0",
+		"@atlaskit/editor-common": "^107.28.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0",
 		"react-intl-next": "npm:react-intl@^5.18.1"
@@ -62,7 +62,7 @@
 		"@atlaskit/editor-plugin-decorations": "^3.0.0",
 		"@atlaskit/editor-plugin-editor-disabled": "^3.0.0",
 		"@atlaskit/editor-plugin-feature-flags": "^2.0.0",
-		"@atlaskit/editor-plugin-floating-toolbar": "^5.1.0",
+		"@atlaskit/editor-plugin-floating-toolbar": "^5.2.0",
 		"@atlaskit/editor-plugin-grid": "^3.1.0",
 		"@testing-library/react": "^13.4.0",
 		"@testing-library/user-event": "^14.4.3",