@atlaskit/editor-plugin-emoji 0.1.1 → 0.2.0

package/dist/types/plugin.d.ts

@@ -0,0 +1,38 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { Command, PMPluginFactoryParams, TypeAheadItem } from '@atlaskit/editor-common/types';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+import type { EmojiDescription, EmojiProvider } from '@atlaskit/emoji';
+import type { EmojiPlugin, EmojiPluginState } from './types';
+export declare const emojiToTypeaheadItem: (emoji: EmojiDescription, emojiProvider?: EmojiProvider) => TypeAheadItem;
+export declare function memoize<ResultFn extends (emoji: EmojiDescription, emojiProvider?: EmojiProvider) => TypeAheadItem>(fn: ResultFn): {
+    call: ResultFn;
+    clear(): void;
+};
+export declare const defaultListLimit = 50;
+export declare const emojiPlugin: EmojiPlugin;
+/**
+ * Actions
+ */
+export declare const ACTIONS: {
+    SET_PROVIDER: string;
+    SET_RESULTS: string;
+    SET_ASCII_MAP: string;
+};
+/**
+ *
+ * Wrapper to call `onLimitReached` when a specified number of calls of that function
+ * have been made within a time period.
+ *
+ * Note: It does not rate limit
+ *
+ * @param fn Function to wrap
+ * @param limitTime Time limit in milliseconds
+ * @param limitCount Number of function calls before `onRateReached` is called (per time period)
+ * @returns Wrapped function
+ */
+export declare function createRateLimitReachedFunction<LimitedFunction extends (...args: any[]) => any>(fn: Function, limitTime: number, limitCount: number, onLimitReached: () => void): (...args: Parameters<LimitedFunction>) => ReturnType<LimitedFunction> | undefined;
+export declare const setProvider: ((provider?: EmojiProvider) => Command) | undefined;
+export declare const emojiPluginKey: PluginKey<EmojiPluginState>;
+export declare function getEmojiPluginState(state: EditorState): EmojiPluginState;
+export declare function createEmojiPlugin(pmPluginFactoryParams: PMPluginFactoryParams): SafePlugin<EmojiPluginState>;

package/dist/types/pm-plugins/ascii-input-rules.d.ts

@@ -0,0 +1,10 @@
+import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
+import type { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
+import type { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { FeatureFlags } from '@atlaskit/editor-common/types';
+import type { Schema } from '@atlaskit/editor-prosemirror/model';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+export declare function inputRulePlugin(schema: Schema, providerFactory: ProviderFactory, featureFlags: FeatureFlags, editorAnalyticsAPI: EditorAnalyticsAPI | undefined): SafePlugin | undefined;
+export declare const stateKey: PluginKey<any>;
+declare const plugins: (schema: Schema, providerFactory: ProviderFactory, featureFlags: FeatureFlags, editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => SafePlugin<any>[];
+export default plugins;

package/dist/types/types.d.ts

@@ -1,9 +1,8 @@
 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 { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
 import type { TypeAheadPlugin } from '@atlaskit/editor-plugin-type-ahead';
-import type { EmojiId } from '@atlaskit/emoji';
-import type { EmojiDescription, EmojiProvider, EmojiResourceConfig } from '@atlaskit/emoji';
+import type { EmojiDescription, EmojiId, EmojiProvider, EmojiResourceConfig } from '@atlaskit/emoji';
 export interface EmojiPluginOptions {
     headless?: boolean;
 }
@@ -14,7 +13,7 @@ export type EmojiPluginState = {
 };
 export type EmojiPlugin = NextEditorPlugin<'emoji', {
     pluginConfiguration: EmojiPluginOptions | undefined;
-    dependencies: [OptionalPlugin<typeof analyticsPlugin>, TypeAheadPlugin];
+    dependencies: [OptionalPlugin<AnalyticsPlugin>, TypeAheadPlugin];
     sharedState: EmojiPluginState | undefined;
     commands: {
         insertEmoji: (emojiId: EmojiId, inputMethod?: INPUT_METHOD.PICKER | INPUT_METHOD.ASCII | INPUT_METHOD.TYPEAHEAD) => EditorCommand;

package/dist/types/ui/Emoji/index.d.ts

@@ -0,0 +1,4 @@
+/** @jsx jsx */
+import { jsx } from '@emotion/react';
+import type { EmojiProps } from '@atlaskit/editor-common/emoji';
+export default function EmojiNode(props: EmojiProps): jsx.JSX.Element;

package/dist/types-ts4.5/commands/insert-emoji.d.ts

@@ -0,0 +1,4 @@
+import type { EditorAnalyticsAPI, INPUT_METHOD } from '@atlaskit/editor-common/analytics';
+import type { EditorCommand } from '@atlaskit/editor-common/types';
+import type { EmojiId } from '@atlaskit/emoji';
+export declare const insertEmoji: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (emojiId: EmojiId, inputMethod?: INPUT_METHOD.PICKER | INPUT_METHOD.ASCII | INPUT_METHOD.TYPEAHEAD) => EditorCommand;

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

@@ -1 +1,2 @@
 export type { EmojiPlugin, EmojiPluginOptions, EmojiPluginState, } from './types';
+export { emojiPlugin } from './plugin';

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

@@ -0,0 +1,7 @@
+export declare const messages: {
+    emojiNodeLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};

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

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+import type { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
+import type { InlineNodeViewComponentProps } from '@atlaskit/editor-common/react-node-view';
+export type Props = InlineNodeViewComponentProps & {
+    providerFactory: ProviderFactory;
+};
+export declare function EmojiNodeView(props: Props): JSX.Element;

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

@@ -0,0 +1,38 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { Command, PMPluginFactoryParams, TypeAheadItem } from '@atlaskit/editor-common/types';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+import type { EmojiDescription, EmojiProvider } from '@atlaskit/emoji';
+import type { EmojiPlugin, EmojiPluginState } from './types';
+export declare const emojiToTypeaheadItem: (emoji: EmojiDescription, emojiProvider?: EmojiProvider) => TypeAheadItem;
+export declare function memoize<ResultFn extends (emoji: EmojiDescription, emojiProvider?: EmojiProvider) => TypeAheadItem>(fn: ResultFn): {
+    call: ResultFn;
+    clear(): void;
+};
+export declare const defaultListLimit = 50;
+export declare const emojiPlugin: EmojiPlugin;
+/**
+ * Actions
+ */
+export declare const ACTIONS: {
+    SET_PROVIDER: string;
+    SET_RESULTS: string;
+    SET_ASCII_MAP: string;
+};
+/**
+ *
+ * Wrapper to call `onLimitReached` when a specified number of calls of that function
+ * have been made within a time period.
+ *
+ * Note: It does not rate limit
+ *
+ * @param fn Function to wrap
+ * @param limitTime Time limit in milliseconds
+ * @param limitCount Number of function calls before `onRateReached` is called (per time period)
+ * @returns Wrapped function
+ */
+export declare function createRateLimitReachedFunction<LimitedFunction extends (...args: any[]) => any>(fn: Function, limitTime: number, limitCount: number, onLimitReached: () => void): (...args: Parameters<LimitedFunction>) => ReturnType<LimitedFunction> | undefined;
+export declare const setProvider: ((provider?: EmojiProvider) => Command) | undefined;
+export declare const emojiPluginKey: PluginKey<EmojiPluginState>;
+export declare function getEmojiPluginState(state: EditorState): EmojiPluginState;
+export declare function createEmojiPlugin(pmPluginFactoryParams: PMPluginFactoryParams): SafePlugin<EmojiPluginState>;

package/dist/types-ts4.5/pm-plugins/ascii-input-rules.d.ts

@@ -0,0 +1,10 @@
+import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
+import type { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
+import type { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { FeatureFlags } from '@atlaskit/editor-common/types';
+import type { Schema } from '@atlaskit/editor-prosemirror/model';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+export declare function inputRulePlugin(schema: Schema, providerFactory: ProviderFactory, featureFlags: FeatureFlags, editorAnalyticsAPI: EditorAnalyticsAPI | undefined): SafePlugin | undefined;
+export declare const stateKey: PluginKey<any>;
+declare const plugins: (schema: Schema, providerFactory: ProviderFactory, featureFlags: FeatureFlags, editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => SafePlugin<any>[];
+export default plugins;

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

@@ -1,9 +1,8 @@
 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 { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
 import type { TypeAheadPlugin } from '@atlaskit/editor-plugin-type-ahead';
-import type { EmojiId } from '@atlaskit/emoji';
-import type { EmojiDescription, EmojiProvider, EmojiResourceConfig } from '@atlaskit/emoji';
+import type { EmojiDescription, EmojiId, EmojiProvider, EmojiResourceConfig } from '@atlaskit/emoji';
 export interface EmojiPluginOptions {
     headless?: boolean;
 }
@@ -15,7 +14,7 @@ export type EmojiPluginState = {
 export type EmojiPlugin = NextEditorPlugin<'emoji', {
     pluginConfiguration: EmojiPluginOptions | undefined;
     dependencies: [
-        OptionalPlugin<typeof analyticsPlugin>,
+        OptionalPlugin<AnalyticsPlugin>,
         TypeAheadPlugin
     ];
     sharedState: EmojiPluginState | undefined;

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

@@ -0,0 +1,4 @@
+/** @jsx jsx */
+import { jsx } from '@emotion/react';
+import type { EmojiProps } from '@atlaskit/editor-common/emoji';
+export default function EmojiNode(props: EmojiProps): jsx.JSX.Element;

package/package.json

@@ -1,47 +1,45 @@
 {
   "name": "@atlaskit/editor-plugin-emoji",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Emoji 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",
+  "author": "Atlassian Pty Ltd",
+  "license": "Apache-2.0",
   "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"
+  "atlassian": {
+    "team": "Editor",
+    "releaseModel": "continuous",
+    "singleton": true
   },
   "dependencies": {
-    "@atlaskit/editor-common": "^74.50.0",
+    "@atlaskit/adf-schema": "^28.1.0",
+    "@atlaskit/editor-common": "^74.53.0",
     "@atlaskit/editor-plugin-analytics": "^0.1.4",
     "@atlaskit/editor-plugin-type-ahead": "^0.1.0",
-    "@babel/runtime": "^7.0.0"
+    "@atlaskit/editor-prosemirror": "1.1.0",
+    "@atlaskit/emoji": "^67.4.0",
+    "@atlaskit/prosemirror-input-rules": "^2.4.0",
+    "@babel/runtime": "^7.0.0",
+    "@emotion/react": "^11.7.1",
+    "react-intl-next": "npm:react-intl@^5.18.1"
   },
   "peerDependencies": {
     "react": "^16.8.0"
   },
   "devDependencies": {
     "@af/visual-regression": "*",
+    "@atlaskit/editor-plugin-composition": "^0.0.2",
+    "@atlaskit/editor-plugin-decorations": "^0.1.0",
     "@atlaskit/ssr": "*",
+    "@atlaskit/util-data-test": "^17.8.0",
     "@atlaskit/visual-regression": "*",
     "@atlaskit/webdriver-runner": "*",
     "@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
@@ -52,9 +50,6 @@
   },
   "techstack": {
     "@atlassian/frontend": {
-      "code-structure": [
-        "tangerine-next"
-      ],
       "import-structure": [
         "atlassian-conventions"
       ],
@@ -88,5 +83,16 @@
       ]
     }
   },
+  "typesVersions": {
+    ">=4.5 <4.9": {
+      "*": [
+        "dist/types-ts4.5/*",
+        "dist/types-ts4.5/index.d.ts"
+      ]
+    }
+  },
+  "af:exports": {
+    ".": "./src/index.ts"
+  },
   "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.0"
 }

package/report.api.md

@@ -15,7 +15,7 @@
 <!--SECTION START: Main Entry Types-->
 
 ```ts
-import type { analyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
 import type { EditorCommand } from '@atlaskit/editor-common/types';
 import type { EmojiDescription } from '@atlaskit/emoji';
 import type { EmojiId } from '@atlaskit/emoji';
@@ -31,7 +31,7 @@ export type EmojiPlugin = NextEditorPlugin<
   'emoji',
   {
     pluginConfiguration: EmojiPluginOptions | undefined;
-    dependencies: [OptionalPlugin<typeof analyticsPlugin>, TypeAheadPlugin];
+    dependencies: [OptionalPlugin<AnalyticsPlugin>, TypeAheadPlugin];
     sharedState: EmojiPluginState | undefined;
     commands: {
       insertEmoji: (
@@ -45,6 +45,9 @@ export type EmojiPlugin = NextEditorPlugin<
   }
 >;
 
+// @public (undocumented)
+export const emojiPlugin: EmojiPlugin;
+
 // @public (undocumented)
 export interface EmojiPluginOptions {
   // (undocumented)

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

@@ -4,7 +4,7 @@
 
 ```ts
 
-import type { analyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
 import type { EditorCommand } from '@atlaskit/editor-common/types';
 import type { EmojiDescription } from '@atlaskit/emoji';
 import type { EmojiId } from '@atlaskit/emoji';
@@ -18,13 +18,16 @@ import type { TypeAheadPlugin } from '@atlaskit/editor-plugin-type-ahead';
 // @public (undocumented)
 export type EmojiPlugin = NextEditorPlugin<'emoji', {
     pluginConfiguration: EmojiPluginOptions | undefined;
-    dependencies: [OptionalPlugin<typeof analyticsPlugin>, TypeAheadPlugin];
+    dependencies: [OptionalPlugin<AnalyticsPlugin>, TypeAheadPlugin];
     sharedState: EmojiPluginState | undefined;
     commands: {
         insertEmoji: (emojiId: EmojiId, inputMethod?: INPUT_METHOD.ASCII | INPUT_METHOD.PICKER | INPUT_METHOD.TYPEAHEAD) => EditorCommand;
     };
 }>;
 
+// @public (undocumented)
+export const emojiPlugin: EmojiPlugin;
+
 // @public (undocumented)
 export interface EmojiPluginOptions {
     // (undocumented)