@atlaskit/editor-plugin-loom 2.8.3 → 3.0.0

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

@@ -1,3 +1,5 @@
+import type React from 'react';
+import { type ButtonProps as AKButtonProps } from '@atlaskit/button';
 export type VideoMeta = {
     sharedUrl: string;
     title: string;
@@ -23,8 +25,37 @@ export type GetClient = Promise<GetClientResult>;
 export type LoomProviderOptions = {
     getClient: () => GetClient;
 };
-export type LoomPluginOptions = {
+export interface ButtonComponentProps extends Pick<AKButtonProps, 'selected' | 'isDisabled' | 'onBlur' | 'onFocus' | 'onKeyDown' | 'onMouseEnter' | 'onMouseLeave' | 'aria-controls' | 'aria-expanded' | 'aria-haspopup' | 'href' | 'target'> {
+    'data-ds--level'?: string;
+    /**
+     * on click handler that will only be called before the Loom SDK is initialised.
+     * Once the SDK is initialised, onClick will be handled by editor to start recording.
+     */
+    onClickBeforeInit?: (event: React.MouseEvent<HTMLElement>) => void;
+}
+export type ButtonComponent = React.ForwardRefExoticComponent<ButtonComponentProps & React.RefAttributes<HTMLElement>>;
+export type RenderButton = (ButtonComponent: ButtonComponent) => JSX.Element | null;
+type LoomPluginOptionsWithProvider = {
     loomProvider: LoomProviderOptions;
+    /**
+     * Customize the button component, e.g. adding pulse, a11y.
+     * @note When this is provided, `shouldShowToolbarButton` can be skipped and the button will still show. \
+     * If `shouldShowToolbarButton` is false, the button will not show regardless of this prop.
+     * @param ButtonComponent Loom toolbar button component (mainly UI)
+     */
+    renderButton?: RenderButton;
     shouldShowToolbarButton?: boolean;
 };
+type LoomPluginOptionsWithoutProvider = {
+    loomProvider?: LoomProviderOptions;
+    /**
+     * Customize the button component, e.g. adding pulse, a11y.
+     * @note When this is provided, `shouldShowToolbarButton` can be skipped and the button will still show. \
+     * If `shouldShowToolbarButton` is false, the button will not show regardless of this prop.
+     * @param ButtonComponent Loom toolbar button component (mainly UI)
+     */
+    renderButton: RenderButton;
+    shouldShowToolbarButton?: boolean;
+};
+export type LoomPluginOptions = LoomPluginOptionsWithProvider | LoomPluginOptionsWithoutProvider;
 export {};

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

@@ -0,0 +1,4 @@
+import type { ExtractInjectionAPI, ToolbarUIComponentFactory } from '@atlaskit/editor-common/types';
+import type { LoomPlugin } from '../plugin';
+import { type LoomPluginOptions } from '../types';
+export declare const loomPrimaryToolbarComponent: (config: LoomPluginOptions, api: ExtractInjectionAPI<LoomPlugin> | undefined) => ToolbarUIComponentFactory;

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

@@ -0,0 +1,20 @@
+/**
+ * @jsxRuntime classic
+ * @jsx jsx
+ */
+import React from 'react';
+import type { WrappedComponentProps } from 'react-intl-next';
+import type { EditorAppearance, ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { LoomPlugin } from '../plugin';
+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;
+    hideTooltip?: boolean;
+}
+declare const _default: React.ForwardRefExoticComponent<Pick<import("react-intl-next").WithIntlProps<React.PropsWithChildren<Props & WrappedComponentProps & React.RefAttributes<HTMLElement>>>, "children" | "key" | keyof Props | "forwardedRef"> & React.RefAttributes<any>> & {
+    WrappedComponent: React.ComponentType<Props & WrappedComponentProps & React.RefAttributes<HTMLElement>>;
+};
+export default _default;

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

@@ -0,0 +1,3 @@
+import { type EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
+import type { QuickInsertHandlerFn } from '@atlaskit/editor-common/types';
+export declare const getQuickInsertItem: (editorAnalyticsAPI?: EditorAnalyticsAPI) => QuickInsertHandlerFn;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-loom",
-	"version": "2.8.3",
+	"version": "3.0.0",
 	"description": "Loom plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -34,10 +34,12 @@
 		".": "./src/index.ts"
 	},
 	"dependencies": {
-		"@atlaskit/editor-common": "^89.0.0",
+		"@atlaskit/button": "^20.1.0",
+		"@atlaskit/editor-common": "^90.2.0",
 		"@atlaskit/editor-plugin-analytics": "^1.8.0",
 		"@atlaskit/editor-plugin-hyperlink": "^2.9.0",
 		"@atlaskit/editor-plugin-primary-toolbar": "^2.0.0",
+		"@atlaskit/editor-plugin-quick-insert": "^1.4.0",
 		"@atlaskit/editor-plugin-width": "^1.3.0",
 		"@atlaskit/editor-prosemirror": "6.0.0",
 		"@atlaskit/logo": "^14.2.0",
@@ -62,7 +64,7 @@
 		"@atlaskit/editor-plugin-decorations": "^1.3.0",
 		"@atlaskit/editor-plugin-editor-disabled": "^1.3.0",
 		"@atlaskit/editor-plugin-feature-flags": "^1.2.0",
-		"@atlaskit/editor-plugin-floating-toolbar": "^1.12.0",
+		"@atlaskit/editor-plugin-floating-toolbar": "^1.13.0",
 		"@atlaskit/editor-plugin-grid": "^1.2.0",
 		"@testing-library/react": "^12.1.5",
 		"@testing-library/user-event": "^14.4.3",

package/.eslintrc.js

@@ -1,6 +0,0 @@
-module.exports = {
-	rules: {
-		'@typescript-eslint/no-duplicate-imports': 'error',
-		'@typescript-eslint/no-explicit-any': 'error',
-	},
-};