@atlaskit/editor-plugin-type-ahead 0.3.2 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/editor-plugin-type-ahead
 
+## 0.5.0
+
+### Minor Changes
+
+- [#41143](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/41143) [`7d6dfe2befa`](https://bitbucket.org/atlassian/atlassian-frontend/commits/7d6dfe2befa) - [ED-20003] Replace TyepAhead API for Editor Plugin Injection API
+
+## 0.4.0
+
+### Minor Changes
+
+- [#40955](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/40955) [`30dc2b1e6c9`](https://bitbucket.org/atlassian/atlassian-frontend/commits/30dc2b1e6c9) - [ED-19746] Decoupling mentions plugin from Editor-core libraries
+
 ## 0.3.2
 
 ### Patch Changes
@@ -16,16 +28,16 @@
 
 ### Minor Changes
 
-- [`ef0c2a89c72`](https://bitbucket.org/atlassian/atlassian-frontend/commits/ef0c2a89c72) - Add isTypeAheadOpen action to type-ahead plugin. Decouple placeholder plugin from editor-core.
+- [#39575](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/39575) [`ef0c2a89c72`](https://bitbucket.org/atlassian/atlassian-frontend/commits/ef0c2a89c72) - Add isTypeAheadOpen action to type-ahead plugin. Decouple placeholder plugin from editor-core.
 
 ## 0.2.0
 
 ### Minor Changes
 
-- [`ad3c5c21079`](https://bitbucket.org/atlassian/atlassian-frontend/commits/ad3c5c21079) - Updating all plugins with minor version to correct issue with semver.
+- [#39325](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/39325) [`ad3c5c21079`](https://bitbucket.org/atlassian/atlassian-frontend/commits/ad3c5c21079) - Updating all plugins with minor version to correct issue with semver.
 
 ## 0.1.1
 
 ### Patch Changes
 
-- [`24e27147cbd`](https://bitbucket.org/atlassian/atlassian-frontend/commits/24e27147cbd) - Added atlaskit docs to all existing plugins.
+- [#39177](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/39177) [`24e27147cbd`](https://bitbucket.org/atlassian/atlassian-frontend/commits/24e27147cbd) - Added atlaskit docs to all existing plugins.

package/README.md

@@ -27,4 +27,4 @@ Please see [Atlaskit - Editor plugin type ahead](https://atlaskit.atlassian.com/
 For internal Atlassian, visit the slack channel [#help-editor](https://atlassian.slack.com/archives/CFG3PSQ9E) for support or visit [go/editor-help](https://go/editor-help) to submit a bug.
 ## License
 ---
- Please see [Atlassian Frontend - License](https://developer.atlassian.com/cloud/framework/atlassian-frontend/#license) for more licensing information.
+ Please see [Atlassian Frontend - License](https://hello.atlassian.net/wiki/spaces/AF/pages/2589099144/Documentation#License) for more licensing information.

package/dist/types/types.d.ts

@@ -1,29 +1,48 @@
 import type { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
 import type { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
-import type { EditorCommand, NextEditorPlugin, TypeAheadHandler } from '@atlaskit/editor-common/types';
-import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import type { SelectItemMode } from '@atlaskit/editor-common/type-ahead';
+import type { Command, NextEditorPlugin, OptionalPlugin, TypeAheadHandler, TypeAheadItem } from '@atlaskit/editor-common/types';
+import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
 export type TypeAheadInputMethod = INPUT_METHOD.INSERT_MENU | INPUT_METHOD.KEYBOARD | INPUT_METHOD.QUICK_INSERT | INPUT_METHOD.TOOLBAR;
-type Props = {
+export type TypeAheadPluginOptions = {
+    isMobile?: boolean;
+    createAnalyticsEvent?: CreateUIAnalyticsEvent;
+};
+type OpenTypeAheadProps = {
     triggerHandler: TypeAheadHandler;
     inputMethod: TypeAheadInputMethod;
     query?: string;
 };
-export type TypeAheadPluginOptions = {
-    isMobile?: boolean;
-    createAnalyticsEvent?: CreateUIAnalyticsEvent;
+type InsertTypeAheadItemProps = {
+    triggerHandler: TypeAheadHandler;
+    contentItem: TypeAheadItem;
+    query: string;
+    sourceListItem: TypeAheadItem[];
+    mode?: SelectItemMode;
+};
+type CloseTypeAheadProps = {
+    insertCurrentQueryAsRawText: boolean;
+    attachCommand?: Command;
 };
-type OpenTypeAheadAtCursorType = (props: Props) => EditorCommand;
 /**
  * Type ahead plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
  * from `@atlaskit/editor-core`.
  */
 export type TypeAheadPlugin = NextEditorPlugin<'typeAhead', {
     pluginConfiguration: TypeAheadPluginOptions | undefined;
+    dependencies: [OptionalPlugin<AnalyticsPlugin>];
+    sharedState: {
+        query: string;
+    };
     actions: {
         isOpen: (editorState: EditorState) => boolean;
-    };
-    commands: {
-        openTypeAheadAtCursor: OpenTypeAheadAtCursorType;
+        isAllowed: (editorState: EditorState) => boolean;
+        insert: (props: InsertTypeAheadItemProps) => boolean;
+        findHandlerByTrigger: (trigger: string) => TypeAheadHandler | null;
+        open: (props: OpenTypeAheadProps) => boolean;
+        close: (props: CloseTypeAheadProps) => boolean;
+        openAtTransaction: (props: OpenTypeAheadProps) => (tr: Transaction) => boolean;
     };
 }>;
 export {};

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

@@ -1,29 +1,50 @@
 import type { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
 import type { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
-import type { EditorCommand, NextEditorPlugin, TypeAheadHandler } from '@atlaskit/editor-common/types';
-import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import type { SelectItemMode } from '@atlaskit/editor-common/type-ahead';
+import type { Command, NextEditorPlugin, OptionalPlugin, TypeAheadHandler, TypeAheadItem } from '@atlaskit/editor-common/types';
+import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
 export type TypeAheadInputMethod = INPUT_METHOD.INSERT_MENU | INPUT_METHOD.KEYBOARD | INPUT_METHOD.QUICK_INSERT | INPUT_METHOD.TOOLBAR;
-type Props = {
+export type TypeAheadPluginOptions = {
+    isMobile?: boolean;
+    createAnalyticsEvent?: CreateUIAnalyticsEvent;
+};
+type OpenTypeAheadProps = {
     triggerHandler: TypeAheadHandler;
     inputMethod: TypeAheadInputMethod;
     query?: string;
 };
-export type TypeAheadPluginOptions = {
-    isMobile?: boolean;
-    createAnalyticsEvent?: CreateUIAnalyticsEvent;
+type InsertTypeAheadItemProps = {
+    triggerHandler: TypeAheadHandler;
+    contentItem: TypeAheadItem;
+    query: string;
+    sourceListItem: TypeAheadItem[];
+    mode?: SelectItemMode;
+};
+type CloseTypeAheadProps = {
+    insertCurrentQueryAsRawText: boolean;
+    attachCommand?: Command;
 };
-type OpenTypeAheadAtCursorType = (props: Props) => EditorCommand;
 /**
  * Type ahead plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
  * from `@atlaskit/editor-core`.
  */
 export type TypeAheadPlugin = NextEditorPlugin<'typeAhead', {
     pluginConfiguration: TypeAheadPluginOptions | undefined;
+    dependencies: [
+        OptionalPlugin<AnalyticsPlugin>
+    ];
+    sharedState: {
+        query: string;
+    };
     actions: {
         isOpen: (editorState: EditorState) => boolean;
-    };
-    commands: {
-        openTypeAheadAtCursor: OpenTypeAheadAtCursorType;
+        isAllowed: (editorState: EditorState) => boolean;
+        insert: (props: InsertTypeAheadItemProps) => boolean;
+        findHandlerByTrigger: (trigger: string) => TypeAheadHandler | null;
+        open: (props: OpenTypeAheadProps) => boolean;
+        close: (props: CloseTypeAheadProps) => boolean;
+        openAtTransaction: (props: OpenTypeAheadProps) => (tr: Transaction) => boolean;
     };
 }>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-type-ahead",
-  "version": "0.3.2",
+  "version": "0.5.0",
   "description": "Type-ahead plugin for @atlaskit/editor-core",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -31,7 +31,8 @@
     ".": "./src/index.ts"
   },
   "dependencies": {
-    "@atlaskit/editor-common": "^76.0.0",
+    "@atlaskit/editor-common": "^76.6.0",
+    "@atlaskit/editor-plugin-analytics": "^0.2.0",
     "@atlaskit/editor-prosemirror": "1.1.0",
     "@babel/runtime": "^7.0.0"
   },

package/report.api.md

@@ -15,18 +15,35 @@
 <!--SECTION START: Main Entry Types-->
 
 ```ts
+import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { Command } from '@atlaskit/editor-common/types';
 import type { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
-import type { EditorCommand } from '@atlaskit/editor-common/types';
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 import type { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { OptionalPlugin } from '@atlaskit/editor-common/types';
+import type { SelectItemMode } from '@atlaskit/editor-common/type-ahead';
+import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 import type { TypeAheadHandler } from '@atlaskit/editor-common/types';
+import type { TypeAheadItem } from '@atlaskit/editor-common/types';
 
 // @public (undocumented)
-type OpenTypeAheadAtCursorType = (props: Props) => EditorCommand;
+type CloseTypeAheadProps = {
+  insertCurrentQueryAsRawText: boolean;
+  attachCommand?: Command;
+};
 
 // @public (undocumented)
-type Props = {
+type InsertTypeAheadItemProps = {
+  triggerHandler: TypeAheadHandler;
+  contentItem: TypeAheadItem;
+  query: string;
+  sourceListItem: TypeAheadItem[];
+  mode?: SelectItemMode;
+};
+
+// @public (undocumented)
+type OpenTypeAheadProps = {
   triggerHandler: TypeAheadHandler;
   inputMethod: TypeAheadInputMethod;
   query?: string;
@@ -44,11 +61,20 @@ export type TypeAheadPlugin = NextEditorPlugin<
   'typeAhead',
   {
     pluginConfiguration: TypeAheadPluginOptions | undefined;
+    dependencies: [OptionalPlugin<AnalyticsPlugin>];
+    sharedState: {
+      query: string;
+    };
     actions: {
       isOpen: (editorState: EditorState) => boolean;
-    };
-    commands: {
-      openTypeAheadAtCursor: OpenTypeAheadAtCursorType;
+      isAllowed: (editorState: EditorState) => boolean;
+      insert: (props: InsertTypeAheadItemProps) => boolean;
+      findHandlerByTrigger: (trigger: string) => TypeAheadHandler | null;
+      open: (props: OpenTypeAheadProps) => boolean;
+      close: (props: CloseTypeAheadProps) => boolean;
+      openAtTransaction: (
+        props: OpenTypeAheadProps,
+      ) => (tr: Transaction) => boolean;
     };
   }
 >;

package/tmp/api-report-tmp.d.ts

@@ -4,18 +4,35 @@
 
 ```ts
 
+import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { Command } from '@atlaskit/editor-common/types';
 import type { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
-import type { EditorCommand } from '@atlaskit/editor-common/types';
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 import type { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { OptionalPlugin } from '@atlaskit/editor-common/types';
+import type { SelectItemMode } from '@atlaskit/editor-common/type-ahead';
+import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 import type { TypeAheadHandler } from '@atlaskit/editor-common/types';
+import type { TypeAheadItem } from '@atlaskit/editor-common/types';
 
 // @public (undocumented)
-type OpenTypeAheadAtCursorType = (props: Props) => EditorCommand;
+type CloseTypeAheadProps = {
+    insertCurrentQueryAsRawText: boolean;
+    attachCommand?: Command;
+};
 
 // @public (undocumented)
-type Props = {
+type InsertTypeAheadItemProps = {
+    triggerHandler: TypeAheadHandler;
+    contentItem: TypeAheadItem;
+    query: string;
+    sourceListItem: TypeAheadItem[];
+    mode?: SelectItemMode;
+};
+
+// @public (undocumented)
+type OpenTypeAheadProps = {
     triggerHandler: TypeAheadHandler;
     inputMethod: TypeAheadInputMethod;
     query?: string;
@@ -27,11 +44,18 @@ export type TypeAheadInputMethod = INPUT_METHOD.INSERT_MENU | INPUT_METHOD.KEYBO
 // @public
 export type TypeAheadPlugin = NextEditorPlugin<'typeAhead', {
     pluginConfiguration: TypeAheadPluginOptions | undefined;
+    dependencies: [OptionalPlugin<AnalyticsPlugin>];
+    sharedState: {
+        query: string;
+    };
     actions: {
         isOpen: (editorState: EditorState) => boolean;
-    };
-    commands: {
-        openTypeAheadAtCursor: OpenTypeAheadAtCursorType;
+        isAllowed: (editorState: EditorState) => boolean;
+        insert: (props: InsertTypeAheadItemProps) => boolean;
+        findHandlerByTrigger: (trigger: string) => TypeAheadHandler | null;
+        open: (props: OpenTypeAheadProps) => boolean;
+        close: (props: CloseTypeAheadProps) => boolean;
+        openAtTransaction: (props: OpenTypeAheadProps) => (tr: Transaction) => boolean;
     };
 }>;