@atlaskit/editor-plugin-quick-insert 29.0.4 → 30.0.1

package/dist/types/ui/RegistryElementBrowser/model.d.ts

@@ -1,4 +1,4 @@
-import type { MenuItemMatchContext, RegisterComponent, RegisterMenuItem } from '@atlaskit/editor-ui-control-model/types';
+import type { MenuItemMatchContext, RegisterComponent, RegisterMenuItem, SurfaceContext } from '@atlaskit/editor-ui-control-model/types';
 export type RegistryElementBrowserSection = {
     key: string;
     rank: number;
@@ -18,11 +18,12 @@ export type RegistryElementBrowserModel = {
  * Builds the Element Browser's view of the resolved Quick Insert registry.
  * The caller provides only components rooted at the Quick Insert menu surface.
  */
-export declare const createRegistryElementBrowserModel: (components: RegisterComponent[], { footerKey, overflowKeys, recommendedSectionKey, rootKey, }: {
+export declare const createRegistryElementBrowserModel: (components: RegisterComponent[], { footerKey, overflowKeys, recommendedSectionKey, rootKey, surfaceContext, }: {
     footerKey: string;
     overflowKeys: Set<string>;
     recommendedSectionKey: string;
     rootKey: string;
+    surfaceContext?: SurfaceContext;
 }) => RegistryElementBrowserModel;
 export declare const getInitialRegistryElementBrowserSection: (model: RegistryElementBrowserModel, requestedSection?: string) => string | undefined;
 export declare const getRegistryElementBrowserItems: ({ formatMessage, model, query, section, }: {

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

@@ -1,12 +1,18 @@
+import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics/api';
 import type { IsRecommendedItem } from '@atlaskit/editor-common/quick-insert/is-recommended-item';
+import type { RegisteredItemRankResolver } from '@atlaskit/editor-common/registered-menu/item-rank';
+import type { EmptyStateHandler } from '@atlaskit/editor-common/types/empty-state-handler';
 import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types/next-editor-plugin';
-import type { CommonComponentProps, RegisterComponent } from '@atlaskit/editor-ui-control-model/types';
+import type { RegisterComponent } from '@atlaskit/editor-ui-control-model/types';
 import type { QuickInsertPlugin } from '../quickInsertPluginType';
 type Params = {
     api: ExtractInjectionAPI<QuickInsertPlugin> | undefined;
+    emptyStateHandler?: EmptyStateHandler;
+    fireAnalyticsEvent?: EditorAnalyticsAPI['fireAnalyticsEvent'];
+    getItemRank?: RegisteredItemRankResolver;
     includeElementBrowserItems: boolean;
     isRecommendedItem?: IsRecommendedItem;
     maxRecommendedItems?: number;
 };
-export declare const getQuickInsertComponents: <TProps extends CommonComponentProps = CommonComponentProps>({ api, includeElementBrowserItems, isRecommendedItem, maxRecommendedItems, }: Params) => RegisterComponent<TProps>[];
+export declare const getQuickInsertComponents: ({ api, includeElementBrowserItems, isRecommendedItem, maxRecommendedItems, getItemRank, emptyStateHandler, fireAnalyticsEvent, }: Params) => RegisterComponent[];
 export {};

package/dist/types/ui/registered-menu/QuickInsertEmptyState.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+type Props = {
+    mode: 'inline' | 'full';
+    spacing?: 'compact' | 'spacious';
+};
+export declare const QuickInsertEmptyState: ({ mode, spacing, }: Props) => React.JSX.Element;
+export {};

package/dist/types/ui/registered-menu/QuickInsertMenuRoot.d.ts

@@ -0,0 +1,11 @@
+import React from 'react';
+import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics/api';
+import type { RegisteredItemRankResolver } from '@atlaskit/editor-common/registered-menu/item-rank';
+import type { EmptyStateHandler } from '@atlaskit/editor-common/types/empty-state-handler';
+type Props = {
+    emptyStateHandler?: EmptyStateHandler;
+    fireAnalyticsEvent?: EditorAnalyticsAPI['fireAnalyticsEvent'];
+    getItemRank?: RegisteredItemRankResolver;
+};
+declare const QuickInsertMenuRoot: ({ emptyStateHandler, fireAnalyticsEvent, getItemRank, }: React.PropsWithChildren<Props>) => React.JSX.Element | null;
+export default QuickInsertMenuRoot;

package/dist/types/ui/registered-menu/QuickInsertMenuSection.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+export declare const QuickInsertMenuSection: ({ children, title, }: React.PropsWithChildren<{
+    title: string;
+}>) => React.JSX.Element;

package/dist/types/ui/registered-menu/QuickInsertSearchResultsSection.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const QuickInsertSearchResultsSection: ({ children, }: React.PropsWithChildren) => React.JSX.Element;

package/dist/types/ui/registered-menu/RegisteredQuickInsertMenuItem.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+import type { RegisteredMenuItemProps } from '@atlaskit/editor-common/registered-menu';
+export declare const RegisteredQuickInsertMenuItem: ({ id, isSelected, isActive, registration, }: RegisteredMenuItemProps) => React.JSX.Element;

package/dist/types/ui/registered-menu/ToolbarQuickInsertMenu.d.ts

@@ -0,0 +1,28 @@
+import React from 'react';
+import type { RegisteredMenuModel, RegisteredMenuItemProps } from '@atlaskit/editor-common/registered-menu';
+import type { EmptyStateHandler } from '@atlaskit/editor-common/types/empty-state-handler';
+import type { RegisterMenuItem, RegisterMenuSection } from '@atlaskit/editor-ui-control-model/types';
+type Props = {
+    activePreviewItemKey?: string;
+    emptyStateHandler?: EmptyStateHandler;
+    Item: React.ComponentType<RegisteredMenuItemProps>;
+    itemCount: number;
+    listId: string;
+    listLabel: string;
+    maxHeight: number;
+    model: RegisteredMenuModel;
+    onItemBlur: (key: string) => void;
+    onItemFocus: (index: number, key?: string) => void;
+    onItemHover: (index: number, key?: string) => void;
+    onItemLeave: (key: string) => void;
+    onItemVisibilityChange: (key: string, isVisible: boolean) => void;
+    onRenderedItemsChange: (range: {
+        startIndex: number;
+        stopIndex: number;
+    }) => void;
+    query: string;
+    rows: Array<RegisterMenuItem | RegisterMenuSection>;
+    selectedItemIndex: number;
+};
+export declare const ToolbarQuickInsertMenu: ({ Item, model, emptyStateHandler, listLabel, activePreviewItemKey, itemCount, listId, maxHeight, rows, onItemBlur, onItemFocus, onItemHover, onItemLeave, onItemVisibilityChange, onRenderedItemsChange, query, selectedItemIndex, }: Props) => React.JSX.Element | null;
+export {};

package/dist/types/ui/registered-menu/TypeAheadQuickInsertMenu.d.ts

@@ -0,0 +1,27 @@
+import React from 'react';
+import type { RegisteredMenuItemProps, RegisteredMenuModel } from '@atlaskit/editor-common/registered-menu';
+import type { RegisterMenuItem, RegisterMenuSection } from '@atlaskit/editor-ui-control-model/types';
+type Props = {
+    activeItemKey?: string;
+    hasScrollPadding?: boolean;
+    Item: React.ComponentType<RegisteredMenuItemProps>;
+    itemCount: number;
+    listId: string;
+    listLabel: string;
+    maxHeight: number;
+    model: RegisteredMenuModel;
+    onItemBlur: (itemKey: string) => void;
+    onItemFocus: (itemIndex: number, itemKey?: string) => void;
+    onItemHover: (itemIndex: number, itemKey?: string) => void;
+    onItemLeave: (itemKey: string) => void;
+    onItemVisibilityChange: (itemKey: string, isVisible: boolean) => void;
+    onRenderedItemsChange: (range: {
+        startIndex: number;
+        stopIndex: number;
+    }) => void;
+    query?: string;
+    rows: Array<RegisterMenuItem | RegisterMenuSection>;
+    selectedItemIndex: number;
+};
+export declare const TypeAheadQuickInsertMenu: ({ Item, rows, activeItemKey, itemCount, listId, listLabel, maxHeight, model, onItemFocus, onItemBlur, onItemHover, onItemLeave, onItemVisibilityChange, onRenderedItemsChange, query, selectedItemIndex, hasScrollPadding, }: Props) => React.JSX.Element | null;
+export {};

package/dist/types/ui/registered-menu/assets/no-results.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+type Props = {
+    height: number;
+    width: number;
+};
+export default function NoResultsIllustration({ height, width }: Props): React.JSX.Element;
+export {};

package/dist/types/ui/registered-menu/get-quick-insert-menu-model.d.ts

@@ -0,0 +1,19 @@
+import type { IntlShape } from 'react-intl';
+import type { RegisteredMenuModel } from '@atlaskit/editor-common/registered-menu';
+import { type RegisteredItemRankResolver } from '@atlaskit/editor-common/registered-menu/item-rank';
+import type { SurfaceIdentifier } from '@atlaskit/editor-ui-control-model/surface-renderer/types';
+import type { RegisterComponent, SurfaceContext } from '@atlaskit/editor-ui-control-model/types';
+import type { QuickInsertCategoryItemSelectionPolicy } from './selectQuickInsertCategoryItems';
+/**
+ * Builds the registered quick-insert menu model. An empty query browses every
+ * category; a non-empty query returns ranked matches. The footer is shared by both.
+ */
+export declare const getQuickInsertMenuModel: ({ components, formatMessage, getItemRank, query, rootComponent, selectCategoryItems, surfaceContext, }: {
+    components: RegisterComponent[];
+    formatMessage: IntlShape['formatMessage'];
+    getItemRank?: RegisteredItemRankResolver;
+    query: string;
+    rootComponent: SurfaceIdentifier;
+    selectCategoryItems?: QuickInsertCategoryItemSelectionPolicy;
+    surfaceContext?: SurfaceContext;
+}) => RegisteredMenuModel;

package/dist/types/ui/registered-menu/getQuickInsertMenuItemId.d.ts

@@ -0,0 +1 @@
+export declare const getQuickInsertMenuItemId: (listId: string, itemIndex: number) => string;

package/dist/types/ui/registered-menu/selectQuickInsertCategoryItems.d.ts

@@ -0,0 +1,7 @@
+import type { RegisterMenuItem } from '@atlaskit/editor-ui-control-model/types';
+export type QuickInsertCategoryItemSelectionPolicy = (items: RegisterMenuItem[]) => RegisterMenuItem[];
+/**
+ * Keeps the initial native and ecosystem results while ensuring ecosystem registrations
+ * remain discoverable beyond the default category item limit.
+ */
+export declare const selectQuickInsertCategoryItems: QuickInsertCategoryItemSelectionPolicy;

package/dist/types/ui/registered-menu/useQuickInsertSearchAnalytics.d.ts

@@ -0,0 +1,12 @@
+import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics/api';
+import type { QuickInsertSearchSurface } from '@atlaskit/editor-common/analytics/types/quick-insert-events';
+type Options = {
+    category?: string;
+    fireAnalyticsEvent?: EditorAnalyticsAPI['fireAnalyticsEvent'];
+    isOpen?: boolean;
+    query: string;
+    resultCount: number;
+    surface: QuickInsertSearchSurface;
+};
+export declare const useQuickInsertSearchAnalytics: ({ query, resultCount, surface, category, isOpen, fireAnalyticsEvent, }: Options) => (() => void);
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-quick-insert",
-	"version": "29.0.4",
+	"version": "30.0.1",
 	"description": "Quick insert plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -29,31 +29,34 @@
 		"@atlaskit/button": "^25.6.0",
 		"@atlaskit/css": "^1.1.0",
 		"@atlaskit/docs": "^12.3.0",
-		"@atlaskit/editor-plugin-analytics": "^29.0.0",
-		"@atlaskit/editor-plugin-connectivity": "^29.0.0",
-		"@atlaskit/editor-plugin-editor-viewmode": "^31.0.0",
-		"@atlaskit/editor-plugin-metrics": "^30.0.0",
-		"@atlaskit/editor-plugin-type-ahead": "^30.0.0",
-		"@atlaskit/editor-plugin-ui-control-registry": "^23.0.0",
+		"@atlaskit/editor-plugin-analytics": "^30.0.0",
+		"@atlaskit/editor-plugin-connectivity": "^30.0.0",
+		"@atlaskit/editor-plugin-editor-viewmode": "^32.0.0",
+		"@atlaskit/editor-plugin-metrics": "^31.0.0",
+		"@atlaskit/editor-plugin-type-ahead": "^31.0.0",
+		"@atlaskit/editor-plugin-ui-control-registry": "^24.0.0",
 		"@atlaskit/editor-prosemirror": "^9.0.0",
+		"@atlaskit/editor-shared-styles": "^4.6.0",
 		"@atlaskit/editor-tables": "^3.2.0",
-		"@atlaskit/editor-ui-control-model": "^2.10.0",
+		"@atlaskit/editor-ui-control-model": "^3.0.0",
 		"@atlaskit/heading": "^8.0.0",
 		"@atlaskit/icon": "^38.0.0",
+		"@atlaskit/menu": "^11.0.0",
 		"@atlaskit/modal-dialog": "^17.1.0",
 		"@atlaskit/platform-feature-experiments": "^0.3.0",
 		"@atlaskit/platform-feature-flags": "^2.2.0",
 		"@atlaskit/primitives": "^22.6.0",
 		"@atlaskit/textfield": "^10.2.0",
-		"@atlaskit/tmp-editor-statsig": "^246.0.0",
-		"@atlaskit/tokens": "^20.7.0",
+		"@atlaskit/tmp-editor-statsig": "^247.0.0",
+		"@atlaskit/tokens": "^20.8.0",
 		"@atlaskit/tooltip": "^24.4.0",
 		"@babel/runtime": "^7.0.0",
 		"@compiled/react": "^1.0.2",
-		"@emotion/react": "^11.7.1"
+		"@emotion/react": "^11.7.1",
+		"react-loosely-lazy": "^1.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^133.6.0",
+		"@atlaskit/editor-common": "^134.0.0",
 		"react": "^18.2.0 || ^19.2.0",
 		"react-dom": "^18.2.0 || ^19.2.0",
 		"react-intl": "^5.25.1 || ^6.0.0 || ^7.0.0"

package/registered-menu/model/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@atlaskit/editor-plugin-quick-insert/registered-menu/model",
+  "main": "../../dist/cjs/ui/registered-menu/get-quick-insert-menu-model.js",
+  "module": "../../dist/esm/ui/registered-menu/get-quick-insert-menu-model.js",
+  "module:es2019": "../../dist/es2019/ui/registered-menu/get-quick-insert-menu-model.js",
+  "sideEffects": [
+    "*.compiled.css"
+  ],
+  "types": "../../dist/types/ui/registered-menu/get-quick-insert-menu-model.d.ts"
+}

package/registered-menu/search-analytics/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@atlaskit/editor-plugin-quick-insert/registered-menu/search-analytics",
+  "main": "../../dist/cjs/ui/registered-menu/useQuickInsertSearchAnalytics.js",
+  "module": "../../dist/esm/ui/registered-menu/useQuickInsertSearchAnalytics.js",
+  "module:es2019": "../../dist/es2019/ui/registered-menu/useQuickInsertSearchAnalytics.js",
+  "sideEffects": [
+    "*.compiled.css"
+  ],
+  "types": "../../dist/types/ui/registered-menu/useQuickInsertSearchAnalytics.d.ts"
+}