@atlaskit/editor-plugin-loom 13.0.1 → 14.0.0

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @atlaskit/editor-plugin-loom
 
+## 14.0.0
+
+### Major Changes
+
+- [`f2dc9097319f0`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/f2dc9097319f0) - ###
+  Dropped support for _legacy_ Typescript 4 types. **Typescript 5 is now the new minimum**.
+
+  Removes the `typesVersions` property and `dist/types-ts4.5` directory from the dist.
+
+  Types are now exclusively via the `"types": "dist/types/index.d.ts"` property.
+
+  ```diff
+  - "typesVersions": {
+  -    ">=4.5 <4.9": {
+  -        "*": [
+  -            "dist/types-ts4.5/*",
+  -            "dist/types-ts4.5/index.d.ts"
+  -        ]
+  -    }
+  - },
+  ```
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 13.0.1
 
 ### Patch Changes

package/loom-plugin/package.json

@@ -6,12 +6,5 @@
   "sideEffects": [
     "*.compiled.css"
   ],
-  "types": "../dist/types/entry-points/loom-plugin.d.ts",
-  "typesVersions": {
-    ">=4.5 <5.9": {
-      "*": [
-        "../dist/types-ts4.5/entry-points/loom-plugin.d.ts"
-      ]
-    }
-  }
+  "types": "../dist/types/entry-points/loom-plugin.d.ts"
 }

package/loom-plugin-state-type/package.json

@@ -6,12 +6,5 @@
   "sideEffects": [
     "*.compiled.css"
   ],
-  "types": "../dist/types/entry-points/loom-plugin-state-type.d.ts",
-  "typesVersions": {
-    ">=4.5 <5.9": {
-      "*": [
-        "../dist/types-ts4.5/entry-points/loom-plugin-state-type.d.ts"
-      ]
-    }
-  }
+  "types": "../dist/types/entry-points/loom-plugin-state-type.d.ts"
 }

package/loom-plugin-type/package.json

@@ -6,12 +6,5 @@
   "sideEffects": [
     "*.compiled.css"
   ],
-  "types": "../dist/types/entry-points/loom-plugin-type.d.ts",
-  "typesVersions": {
-    ">=4.5 <5.9": {
-      "*": [
-        "../dist/types-ts4.5/entry-points/loom-plugin-type.d.ts"
-      ]
-    }
-  }
+  "types": "../dist/types/entry-points/loom-plugin-type.d.ts"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-loom",
-	"version": "13.0.1",
+	"version": "14.0.0",
 	"description": "Loom plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -19,39 +19,31 @@
 	"module": "dist/esm/index.js",
 	"module:es2019": "dist/es2019/index.js",
 	"types": "dist/types/index.d.ts",
-	"typesVersions": {
-		">=4.5 <4.9": {
-			"*": [
-				"dist/types-ts4.5/*",
-				"dist/types-ts4.5/index.d.ts"
-			]
-		}
-	},
 	"sideEffects": [
 		"*.compiled.css"
 	],
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
-		"@atlaskit/button": "^23.11.0",
-		"@atlaskit/editor-plugin-analytics": "^11.0.0",
-		"@atlaskit/editor-plugin-connectivity": "^11.0.0",
-		"@atlaskit/editor-plugin-editor-viewmode": "^13.0.0",
-		"@atlaskit/editor-plugin-hyperlink": "^13.1.0",
-		"@atlaskit/editor-plugin-primary-toolbar": "^12.0.0",
-		"@atlaskit/editor-plugin-quick-insert": "^11.1.0",
-		"@atlaskit/editor-plugin-toolbar": "^8.0.0",
-		"@atlaskit/editor-plugin-width": "^12.0.0",
-		"@atlaskit/editor-prosemirror": "^7.3.0",
-		"@atlaskit/editor-toolbar": "^1.10.0",
-		"@atlaskit/icon": "^35.4.0",
-		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/tokens": "^13.3.0",
+		"@atlaskit/button": "^24.0.0",
+		"@atlaskit/editor-plugin-analytics": "^12.0.0",
+		"@atlaskit/editor-plugin-connectivity": "^12.0.0",
+		"@atlaskit/editor-plugin-editor-viewmode": "^14.0.0",
+		"@atlaskit/editor-plugin-hyperlink": "^14.0.0",
+		"@atlaskit/editor-plugin-primary-toolbar": "^13.0.0",
+		"@atlaskit/editor-plugin-quick-insert": "^12.0.0",
+		"@atlaskit/editor-plugin-toolbar": "^9.0.0",
+		"@atlaskit/editor-plugin-width": "^13.0.0",
+		"@atlaskit/editor-prosemirror": "^8.0.0",
+		"@atlaskit/editor-toolbar": "^2.0.0",
+		"@atlaskit/icon": "^36.0.0",
+		"@atlaskit/platform-feature-flags": "^2.0.0",
+		"@atlaskit/tokens": "^14.0.0",
 		"@babel/runtime": "^7.0.0",
 		"@emotion/react": "^11.7.1",
 		"@loomhq/record-sdk": "^4.12.2"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^115.10.0",
+		"@atlaskit/editor-common": "^116.0.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0",
 		"react-intl": "^5.25.1 || ^6.0.0 || ^7.0.0"

package/types/package.json

@@ -6,12 +6,5 @@
   "sideEffects": [
     "*.compiled.css"
   ],
-  "types": "../dist/types/entry-points/types.d.ts",
-  "typesVersions": {
-    ">=4.5 <5.9": {
-      "*": [
-        "../dist/types-ts4.5/entry-points/types.d.ts"
-      ]
-    }
-  }
+  "types": "../dist/types/entry-points/types.d.ts"
 }

package/dist/types-ts4.5/entry-points/loom-plugin-state-type.d.ts

@@ -1 +0,0 @@
-export type { LoomPluginState } from '../pm-plugins/main';

package/dist/types-ts4.5/entry-points/loom-plugin-type.d.ts

@@ -1 +0,0 @@
-export type { LoomPlugin } from '../loomPluginType';

package/dist/types-ts4.5/entry-points/loom-plugin.d.ts

@@ -1 +0,0 @@
-export { loomPlugin } from '../loomPlugin';

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

@@ -1 +0,0 @@
-export type { LoomPluginOptions, LoomPluginOptionsWithProvider, LoomPluginOptionsWithoutProvider, LoomProviderOptions, VideoMeta, GetClient, GetClientResult, LoomPluginErrorMessages, LoomSDKErrorMessages, ButtonComponentProps, ButtonComponent, RenderButton, PositionType, } from '../types/index';

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

@@ -1,4 +0,0 @@
-export { loomPlugin } from './loomPlugin';
-export type { LoomPlugin } from './loomPluginType';
-export type { LoomPluginState } from './pm-plugins/main';
-export type { LoomPluginOptions, LoomPluginOptionsWithProvider, LoomPluginOptionsWithoutProvider, LoomProviderOptions, VideoMeta, GetClient, GetClientResult, LoomPluginErrorMessages, LoomSDKErrorMessages, ButtonComponentProps, ButtonComponent, RenderButton, PositionType, } from './types';

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

@@ -1,2 +0,0 @@
-import type { LoomPlugin } from './loomPluginType';
-export declare const loomPlugin: LoomPlugin;

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

@@ -1,50 +0,0 @@
-import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
-import type { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
-import type { EditorCommand, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
-import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
-import type { ConnectivityPlugin } from '@atlaskit/editor-plugin-connectivity';
-import type { EditorViewModePlugin } from '@atlaskit/editor-plugin-editor-viewmode';
-import type { HyperlinkPlugin } from '@atlaskit/editor-plugin-hyperlink';
-import type { PrimaryToolbarPlugin } from '@atlaskit/editor-plugin-primary-toolbar';
-import type { QuickInsertPlugin } from '@atlaskit/editor-plugin-quick-insert';
-import type { ToolbarPlugin } from '@atlaskit/editor-plugin-toolbar';
-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', {
-    actions: {
-        /**
-         * Given loom provider, initialise loom SDK
-         * @returns error message if initialisation failed
-         */
-        initLoom: ({ loomProvider, }: {
-            loomProvider: LoomProviderOptions;
-        }) => 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>,
-        OptionalPlugin<ToolbarPlugin>,
-        OptionalPlugin<EditorViewModePlugin>
-    ];
-    pluginConfiguration: LoomPluginOptions;
-    sharedState: LoomPluginState | undefined;
-}>;

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

@@ -1,35 +0,0 @@
-import type { SDKUnsupportedReasons } from '@loomhq/record-sdk';
-import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
-import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
-import type { EditorCommand, ExtractInjectionAPI } from '@atlaskit/editor-common/types';
-import type { EditorView } from '@atlaskit/editor-prosemirror/view';
-import type { LoomPlugin } from '../loomPluginType';
-import type { LoomProviderOptions, PositionType, VideoMeta } from '../types';
-export declare const enableLoom: ({ loomButton }: {
-    loomButton: HTMLButtonElement;
-}) => EditorCommand;
-export declare const disableLoom: ({ error }: {
-    error: string;
-}) => EditorCommand;
-export declare const recordVideo: ({ inputMethod, editorAnalyticsAPI, }: {
-    editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
-    inputMethod: INPUT_METHOD;
-}) => EditorCommand;
-export declare const recordVideoFailed: ({ inputMethod, error, editorAnalyticsAPI, }: {
-    editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
-    error: SDKUnsupportedReasons | undefined;
-    inputMethod: INPUT_METHOD;
-}) => EditorCommand;
-export declare const insertVideo: ({ editorAnalyticsAPI, video, }: {
-    editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
-    video: VideoMeta;
-}) => EditorCommand;
-export declare const insertLoom: (editorView: EditorView | null, api: ExtractInjectionAPI<LoomPlugin> | undefined, video: VideoMeta, positionType: PositionType) => boolean;
-export declare const executeRecordVideo: (api: ExtractInjectionAPI<LoomPlugin> | undefined) => void;
-export declare const setupLoom: (loomProvider: LoomProviderOptions, api: ExtractInjectionAPI<LoomPlugin> | undefined, editorView: EditorView | null, 
-/**
- * Whether loom initialisation is evoked via `initLoom` command.
- */
-initViaCommand?: boolean) => Promise<{
-    error?: string;
-}>;

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

@@ -1,23 +0,0 @@
-import type { SDKUnsupportedReasons } from '@loomhq/record-sdk';
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
-import { PluginKey } from '@atlaskit/editor-prosemirror/state';
-import type { LoomPlugin } from '../loomPluginType';
-import type { LoomPluginOptions } from '../types';
-export interface LoomPluginState {
-    error: SDKUnsupportedReasons | undefined;
-    isEnabled: boolean;
-    isRecordingVideo: boolean;
-    loomButton: HTMLButtonElement | null;
-}
-export declare enum LoomPluginAction {
-    ENABLE = 0,
-    DISABLE = 1,
-    RECORD_VIDEO = 2,
-    INSERT_VIDEO = 3
-}
-export declare const loomPluginKey: PluginKey<LoomPluginState>;
-export declare const createPlugin: ({ config, api, }: {
-    api: ExtractInjectionAPI<LoomPlugin> | undefined;
-    config: LoomPluginOptions;
-}) => SafePlugin<LoomPluginState>;

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

@@ -1,71 +0,0 @@
-import type React from 'react';
-import type { ButtonProps as AKButtonProps } from '@atlaskit/button';
-export type VideoMeta = {
-    duration?: number;
-    sharedUrl: string;
-    title: string;
-};
-type LoomClient = {
-    attachToButton: (options: {
-        button: HTMLElement;
-        onInsert: (videoMeta: VideoMeta) => void;
-    }) => void;
-};
-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 = {
-    client: LoomClient;
-    status: 'loaded';
-} | {
-    message: LoomPluginErrorMessages | LoomSDKErrorMessages;
-    status: 'error';
-};
-export type GetClient = Promise<GetClientResult>;
-export type LoomProviderOptions = {
-    getClient: () => GetClient;
-};
-export interface ButtonComponentProps extends Pick<AKButtonProps, 'selected' | 'isDisabled' | 'onBlur' | 'onFocus' | 'onKeyDown' | 'onMouseEnter' | 'onMouseLeave' | 'aria-controls' | 'aria-expanded' | 'aria-haspopup' | 'href' | 'target' | 'rel'> {
-    '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;
-export 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;
-    /**
-     * Due to contrainsts with the toolbar model the menu needs to know if any menu items will truely render. Right now
-     * it's not possible to inspect the output of renderButton to detemine this so we need to pass it in as a prop.
-     */
-    shouldRenderButton?: () => boolean;
-    shouldShowToolbarButton?: boolean;
-};
-export 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;
-    /**
-     * Due to contrainsts with the toolbar model the menu needs to know if any menu items will truely render. Right now
-     * it's not possible to inspect the output of renderButton to detemine this so we need to pass it in as a prop.
-     */
-    shouldRenderButton?: () => boolean;
-    shouldShowToolbarButton?: boolean;
-};
-export type LoomPluginOptions = LoomPluginOptionsWithProvider | LoomPluginOptionsWithoutProvider;
-export {};

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

@@ -1,8 +0,0 @@
-import React from 'react';
-import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
-import type { LoomPlugin } from '../loomPluginType';
-import type { ButtonComponentProps, LoomPluginOptions } from '../types';
-export declare const LoomMenuItem: ({ api, renderButton, }: {
-    api: ExtractInjectionAPI<LoomPlugin> | undefined;
-} & Pick<LoomPluginOptions, "renderButton">) => React.JSX.Element | null | undefined;
-export declare const CustomisableLoomMenuItem: (api: ExtractInjectionAPI<LoomPlugin> | undefined) => React.ForwardRefExoticComponent<ButtonComponentProps & React.RefAttributes<HTMLElement>>;

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

@@ -1,9 +0,0 @@
-import React from 'react';
-import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
-import type { LoomPlugin } from '../loomPluginType';
-type MenuSectionProps = {
-    api: ExtractInjectionAPI<LoomPlugin> | undefined;
-    children: React.ReactNode;
-};
-export declare const MenuSection: ({ children, api }: MenuSectionProps) => React.JSX.Element | null;
-export {};

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

@@ -1,4 +0,0 @@
-import type { ExtractInjectionAPI, ToolbarUIComponentFactory } from '@atlaskit/editor-common/types';
-import type { LoomPlugin } from '../loomPluginType';
-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

@@ -1,20 +0,0 @@
-/**
- * @jsxRuntime classic
- * @jsx jsx
- */
-import React from 'react';
-import type { WithIntlProps, WrappedComponentProps } from 'react-intl';
-import type { EditorAppearance, ExtractInjectionAPI } from '@atlaskit/editor-common/types';
-import type { LoomPlugin } from '../loomPluginType';
-import type { ButtonComponentProps } from '../types';
-interface Props extends Omit<ButtonComponentProps, 'onClickBeforeInit'> {
-    api: ExtractInjectionAPI<LoomPlugin> | undefined;
-    appearance: EditorAppearance;
-    disabled: boolean;
-    hideTooltip?: boolean;
-    onClick: (event: React.MouseEvent<HTMLElement>) => void;
-}
-declare const _default_1: React.ForwardRefExoticComponent<Omit<WithIntlProps<React.PropsWithChildren<Props & WrappedComponentProps & React.RefAttributes<HTMLElement>>>, 'ref'> & React.RefAttributes<any>> & {
-    WrappedComponent: React.ComponentType<Props & WrappedComponentProps & React.RefAttributes<HTMLElement>>;
-};
-export default _default_1;

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

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

package/dist/types-ts4.5/ui/toolbar-components.d.ts

@@ -1,5 +0,0 @@
-import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
-import type { RegisterComponent } from '@atlaskit/editor-toolbar-model';
-import type { LoomPlugin } from '../loomPluginType';
-import type { LoomPluginOptions } from '../types';
-export declare const getToolbarComponents: (config: LoomPluginOptions, api: ExtractInjectionAPI<LoomPlugin> | undefined) => RegisterComponent[];