@atlaskit/editor-plugin-type-ahead 0.1.0

package/CHANGELOG.md

@@ -0,0 +1 @@
+# @atlaskit/editor-plugin-type-ahead

package/LICENSE.md

@@ -0,0 +1,13 @@
+Copyright 2023 Atlassian Pty Ltd
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,9 @@
+# EditorPluginTypeAhead
+
+Type-ahead plugin for @atlaskit/editor-core
+
+## Usage
+
+`import { TypeAheadPlugin } from @atlaskit/editor-plugin-type-ahead';`
+
+Detailed docs and example usage can be found [here](https://atlaskit.atlassian.com/packages/editor/editor-plugin-type-ahead).

package/dist/cjs/index.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/dist/cjs/types.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/dist/es2019/index.js

@@ -0,0 +1 @@
+export {};

package/dist/es2019/types.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/index.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/types.js

@@ -0,0 +1 @@
+export {};

package/dist/types/index.d.ts

@@ -0,0 +1 @@
+export type { TypeAheadPlugin, TypeAheadPluginOptions, TypeAheadInputMethod, } from './types';

package/dist/types/types.d.ts

@@ -0,0 +1,21 @@
+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';
+export type TypeAheadInputMethod = INPUT_METHOD.INSERT_MENU | INPUT_METHOD.KEYBOARD | INPUT_METHOD.QUICK_INSERT | INPUT_METHOD.TOOLBAR;
+type Props = {
+    triggerHandler: TypeAheadHandler;
+    inputMethod: TypeAheadInputMethod;
+    query?: string;
+};
+export type TypeAheadPluginOptions = {
+    isMobile?: boolean;
+    createAnalyticsEvent?: CreateUIAnalyticsEvent;
+};
+type OpenTypeAheadAtCursorType = (props: Props) => EditorCommand;
+export type TypeAheadPlugin = NextEditorPlugin<'typeAhead', {
+    pluginConfiguration: TypeAheadPluginOptions | undefined;
+    commands: {
+        openTypeAheadAtCursor: OpenTypeAheadAtCursorType;
+    };
+}>;
+export {};

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

@@ -0,0 +1 @@
+export type { TypeAheadPlugin, TypeAheadPluginOptions, TypeAheadInputMethod, } from './types';

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

@@ -0,0 +1,21 @@
+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';
+export type TypeAheadInputMethod = INPUT_METHOD.INSERT_MENU | INPUT_METHOD.KEYBOARD | INPUT_METHOD.QUICK_INSERT | INPUT_METHOD.TOOLBAR;
+type Props = {
+    triggerHandler: TypeAheadHandler;
+    inputMethod: TypeAheadInputMethod;
+    query?: string;
+};
+export type TypeAheadPluginOptions = {
+    isMobile?: boolean;
+    createAnalyticsEvent?: CreateUIAnalyticsEvent;
+};
+type OpenTypeAheadAtCursorType = (props: Props) => EditorCommand;
+export type TypeAheadPlugin = NextEditorPlugin<'typeAhead', {
+    pluginConfiguration: TypeAheadPluginOptions | undefined;
+    commands: {
+        openTypeAheadAtCursor: OpenTypeAheadAtCursorType;
+    };
+}>;
+export {};

package/package.json

@@ -0,0 +1,90 @@
+{
+  "name": "@atlaskit/editor-plugin-type-ahead",
+  "version": "0.1.0",
+  "description": "Type-ahead plugin for @atlaskit/editor-core",
+  "author": "Atlassian Pty Ltd",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "atlassian": {
+    "team": "Editor",
+    "releaseModel": "continuous",
+    "singleton": true
+  },
+  "repository": "https://bitbucket.org/atlassian/atlassian-frontend",
+  "main": "dist/cjs/index.js",
+  "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": false,
+  "atlaskit:src": "src/index.ts",
+  "af:exports": {
+    ".": "./src/index.ts"
+  },
+  "dependencies": {
+    "@atlaskit/editor-common": "^74.49.0",
+    "@babel/runtime": "^7.0.0"
+  },
+  "peerDependencies": {
+    "react": "^16.8.0"
+  },
+  "devDependencies": {
+    "@af/visual-regression": "*",
+    "@atlaskit/ssr": "*",
+    "@atlaskit/visual-regression": "*",
+    "@atlaskit/webdriver-runner": "*",
+    "@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
+    "@testing-library/react": "^12.1.5",
+    "react-dom": "^16.8.0",
+    "typescript": "~4.9.5",
+    "wait-for-expect": "^1.2.0"
+  },
+  "techstack": {
+    "@atlassian/frontend": {
+      "code-structure": [
+        "tangerine-next"
+      ],
+      "import-structure": [
+        "atlassian-conventions"
+      ],
+      "circular-dependencies": [
+        "file-and-folder-level"
+      ]
+    },
+    "@repo/internal": {
+      "dom-events": "use-bind-event-listener",
+      "analytics": [
+        "analytics-next"
+      ],
+      "design-tokens": [
+        "color"
+      ],
+      "theming": [
+        "react-context"
+      ],
+      "ui-components": [
+        "lite-mode"
+      ],
+      "deprecation": [
+        "no-deprecated-imports"
+      ],
+      "styling": [
+        "static",
+        "emotion"
+      ],
+      "imports": [
+        "import-no-extraneous-disable-for-examples-and-docs"
+      ]
+    }
+  },
+  "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.0"
+}

package/report.api.md

@@ -0,0 +1,73 @@
+<!-- API Report Version: 2.3 -->
+
+## API Report File for "@atlaskit/editor-plugin-type-ahead"
+
+> Do not edit this file. This report is auto-generated using [API Extractor](https://api-extractor.com/).
+> [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
+
+### Table of contents
+
+- [Main Entry Types](#main-entry-types)
+- [Peer Dependencies](#peer-dependencies)
+
+### Main Entry Types
+
+<!--SECTION START: Main Entry Types-->
+
+```ts
+import type { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
+import type { EditorCommand } from '@atlaskit/editor-common/types';
+import type { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { TypeAheadHandler } from '@atlaskit/editor-common/types';
+
+// @public (undocumented)
+type OpenTypeAheadAtCursorType = (props: Props) => EditorCommand;
+
+// @public (undocumented)
+type Props = {
+  triggerHandler: TypeAheadHandler;
+  inputMethod: TypeAheadInputMethod;
+  query?: string;
+};
+
+// @public (undocumented)
+export type TypeAheadInputMethod =
+  | INPUT_METHOD.INSERT_MENU
+  | INPUT_METHOD.KEYBOARD
+  | INPUT_METHOD.QUICK_INSERT
+  | INPUT_METHOD.TOOLBAR;
+
+// @public (undocumented)
+export type TypeAheadPlugin = NextEditorPlugin<
+  'typeAhead',
+  {
+    pluginConfiguration: TypeAheadPluginOptions | undefined;
+    commands: {
+      openTypeAheadAtCursor: OpenTypeAheadAtCursorType;
+    };
+  }
+>;
+
+// @public (undocumented)
+export type TypeAheadPluginOptions = {
+  isMobile?: boolean;
+  createAnalyticsEvent?: CreateUIAnalyticsEvent;
+};
+
+// (No @packageDocumentation comment for this package)
+```
+
+<!--SECTION END: Main Entry Types-->
+
+### Peer Dependencies
+
+<!--SECTION START: Peer Dependencies-->
+
+```json
+{
+  "react": "^16.8.0"
+}
+```
+
+<!--SECTION END: Peer Dependencies-->

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

@@ -0,0 +1,42 @@
+## API Report File for "@atlaskit/editor-plugin-type-ahead"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import type { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
+import type { EditorCommand } from '@atlaskit/editor-common/types';
+import type { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { TypeAheadHandler } from '@atlaskit/editor-common/types';
+
+// @public (undocumented)
+type OpenTypeAheadAtCursorType = (props: Props) => EditorCommand;
+
+// @public (undocumented)
+type Props = {
+    triggerHandler: TypeAheadHandler;
+    inputMethod: TypeAheadInputMethod;
+    query?: string;
+};
+
+// @public (undocumented)
+export type TypeAheadInputMethod = INPUT_METHOD.INSERT_MENU | INPUT_METHOD.KEYBOARD | INPUT_METHOD.QUICK_INSERT | INPUT_METHOD.TOOLBAR;
+
+// @public (undocumented)
+export type TypeAheadPlugin = NextEditorPlugin<'typeAhead', {
+    pluginConfiguration: TypeAheadPluginOptions | undefined;
+    commands: {
+        openTypeAheadAtCursor: OpenTypeAheadAtCursorType;
+    };
+}>;
+
+// @public (undocumented)
+export type TypeAheadPluginOptions = {
+    isMobile?: boolean;
+    createAnalyticsEvent?: CreateUIAnalyticsEvent;
+};
+
+// (No @packageDocumentation comment for this package)
+
+```