@atlaskit/editor-plugin-engagement-platform 2.0.0

package/CHANGELOG.md

@@ -0,0 +1 @@
+# @atlaskit/editor-plugin-engagement-platform

package/LICENSE.md

@@ -0,0 +1,11 @@
+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,32 @@
+# EditorPluginEngagementPlatform
+
+Engagement platform plugin for @atlaskit/editor-core“
+
+**Note:** This component is designed for internal Atlassian development.
+External contributors will be able to use this component but will not be able to submit issues.
+
+
+## Usage
+---
+**Internal use only**
+
+@atlaskit/editor-plugin-engagement-platform is intended for internal use by the @atlaskit/editor-core and as a plugin dependency of the Editor within your product.
+
+Direct use of this component is not supported.
+
+Please see [Atlaskit - Editor Engagement Platform Plugin](https://atlaskit.atlassian.com/packages/editor/editor-plugin-engagement-platform) for documentation and examples for this package.
+
+## Support
+---
+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://hello.atlassian.net/wiki/spaces/AF/pages/2589099144/Documentation#Platform-License) for more licensing information.
+
+
+## Usage
+
+`import EditorPluginEngagementPlatform from '@atlaskit/editor-plugin-engagement-platform';`
+
+
+Detailed docs and example usage can be found [here](https://atlaskit.atlassian.com/packages/editor/editor-plugin-engagement-platform).

package/dist/cjs/engagementPlatformPlugin.js

@@ -0,0 +1,27 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.engagementPlatformPlugin = void 0;
+var _main = require("./pm-plugins/main");
+var engagementPlatformPlugin = exports.engagementPlatformPlugin = function engagementPlatformPlugin(_ref) {
+  var config = _ref.config;
+  return {
+    name: 'engagementPlatform',
+    pmPlugins: function pmPlugins() {
+      return [{
+        name: 'engagementPlatform',
+        plugin: function plugin() {
+          return (0, _main.createPlugin)(config);
+        }
+      }];
+    },
+    getSharedState: function getSharedState(editorState) {
+      if (!config || !editorState) {
+        return undefined;
+      }
+      return _main.engagementPlatformPluginKey.getState(editorState);
+    }
+  };
+};

package/dist/cjs/engagementPlatformPluginType.js

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

package/dist/cjs/index.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "engagementPlatformPlugin", {
+  enumerable: true,
+  get: function get() {
+    return _engagementPlatformPlugin.engagementPlatformPlugin;
+  }
+});
+var _engagementPlatformPlugin = require("./engagementPlatformPlugin");

package/dist/cjs/pm-plugins/main.js

@@ -0,0 +1,29 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.engagementPlatformPluginKey = exports.createPlugin = void 0;
+var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
+var _state = require("@atlaskit/editor-prosemirror/state");
+var engagementPlatformPluginKey = exports.engagementPlatformPluginKey = new _state.PluginKey('engagementPlatformPlugin');
+var createPlugin = exports.createPlugin = function createPlugin(pluginOptions) {
+  return new _safePlugin.SafePlugin({
+    key: engagementPlatformPluginKey,
+    state: {
+      init: function init() {
+        if (!pluginOptions) {
+          return undefined;
+        }
+        return {
+          epComponents: pluginOptions.epComponents,
+          epHooks: pluginOptions.epHooks,
+          coordinationClient: pluginOptions.coordinationClient
+        };
+      },
+      apply: function apply(_tr, pluginState) {
+        return pluginState;
+      }
+    }
+  });
+};

package/dist/es2019/engagementPlatformPlugin.js

@@ -0,0 +1,20 @@
+import { createPlugin, engagementPlatformPluginKey } from './pm-plugins/main';
+export const engagementPlatformPlugin = ({
+  config
+}) => {
+  return {
+    name: 'engagementPlatform',
+    pmPlugins() {
+      return [{
+        name: 'engagementPlatform',
+        plugin: () => createPlugin(config)
+      }];
+    },
+    getSharedState(editorState) {
+      if (!config || !editorState) {
+        return undefined;
+      }
+      return engagementPlatformPluginKey.getState(editorState);
+    }
+  };
+};

package/dist/es2019/engagementPlatformPluginType.js

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

package/dist/es2019/index.js

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

package/dist/es2019/pm-plugins/main.js

@@ -0,0 +1,23 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+export const engagementPlatformPluginKey = new PluginKey('engagementPlatformPlugin');
+export const createPlugin = pluginOptions => {
+  return new SafePlugin({
+    key: engagementPlatformPluginKey,
+    state: {
+      init: () => {
+        if (!pluginOptions) {
+          return undefined;
+        }
+        return {
+          epComponents: pluginOptions.epComponents,
+          epHooks: pluginOptions.epHooks,
+          coordinationClient: pluginOptions.coordinationClient
+        };
+      },
+      apply: (_tr, pluginState) => {
+        return pluginState;
+      }
+    }
+  });
+};

package/dist/esm/engagementPlatformPlugin.js

@@ -0,0 +1,21 @@
+import { createPlugin, engagementPlatformPluginKey } from './pm-plugins/main';
+export var engagementPlatformPlugin = function engagementPlatformPlugin(_ref) {
+  var config = _ref.config;
+  return {
+    name: 'engagementPlatform',
+    pmPlugins: function pmPlugins() {
+      return [{
+        name: 'engagementPlatform',
+        plugin: function plugin() {
+          return createPlugin(config);
+        }
+      }];
+    },
+    getSharedState: function getSharedState(editorState) {
+      if (!config || !editorState) {
+        return undefined;
+      }
+      return engagementPlatformPluginKey.getState(editorState);
+    }
+  };
+};

package/dist/esm/engagementPlatformPluginType.js

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

package/dist/esm/index.js

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

package/dist/esm/pm-plugins/main.js

@@ -0,0 +1,23 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+export var engagementPlatformPluginKey = new PluginKey('engagementPlatformPlugin');
+export var createPlugin = function createPlugin(pluginOptions) {
+  return new SafePlugin({
+    key: engagementPlatformPluginKey,
+    state: {
+      init: function init() {
+        if (!pluginOptions) {
+          return undefined;
+        }
+        return {
+          epComponents: pluginOptions.epComponents,
+          epHooks: pluginOptions.epHooks,
+          coordinationClient: pluginOptions.coordinationClient
+        };
+      },
+      apply: function apply(_tr, pluginState) {
+        return pluginState;
+      }
+    }
+  });
+};

package/dist/types/engagementPlatformPlugin.d.ts

@@ -0,0 +1,2 @@
+import type { EngagementPlatformPlugin } from './engagementPlatformPluginType';
+export declare const engagementPlatformPlugin: EngagementPlatformPlugin;

package/dist/types/engagementPlatformPluginType.d.ts

@@ -0,0 +1,38 @@
+import type { PropsWithChildren, ReactNode } from 'react';
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+export type EngagementPlatformPlugin = NextEditorPlugin<'engagementPlatform', {
+    pluginConfiguration: EngagementPlatformPluginOptions;
+    dependencies: [];
+    sharedState: EngagementPlatformPluginState;
+}>;
+export interface CoordinationClient {
+    start(messageId: string, variationId?: string): Promise<boolean>;
+    stop(messageId: string): Promise<boolean>;
+}
+export type EngagementPlatformPluginOptions = {
+    epComponents: EpComponents;
+    epHooks: EpHooks;
+    coordinationClient: CoordinationClient;
+};
+export type EpComponents = {
+    EngagementProvider: React.ComponentType<PropsWithChildren<{}>>;
+    EngagementSpotlight: React.ComponentType<{
+        engagementId: string;
+    }>;
+    EngagementInlineDialog: React.ComponentType<PropsWithChildren<{
+        engagementId: string;
+    }>>;
+    Coordination: React.ComponentType<PropsWithChildren<{
+        client: CoordinationClient;
+        messageId: string;
+        fallback: ReactNode;
+    }>>;
+};
+export type EpHooks = {
+    useCoordination: (client: CoordinationClient, messageId: string) => [boolean, (force?: boolean) => Promise<void>];
+};
+export type EngagementPlatformPluginState = {
+    epComponents: EpComponents;
+    epHooks: EpHooks;
+    coordinationClient: CoordinationClient;
+} | undefined;

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export { engagementPlatformPlugin } from './engagementPlatformPlugin';
+export type { EngagementPlatformPlugin, EngagementPlatformPluginOptions, EpComponents, EpHooks, CoordinationClient, } from './engagementPlatformPluginType';

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

@@ -0,0 +1,9 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+import type { EngagementPlatformPluginOptions, EngagementPlatformPluginState } from '../engagementPlatformPluginType';
+export declare const engagementPlatformPluginKey: PluginKey<EngagementPlatformPluginState>;
+export declare const createPlugin: (pluginOptions: EngagementPlatformPluginOptions) => SafePlugin<{
+    epComponents: import("../engagementPlatformPluginType").EpComponents;
+    epHooks: import("../engagementPlatformPluginType").EpHooks;
+    coordinationClient: import("../engagementPlatformPluginType").CoordinationClient;
+} | undefined>;

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

@@ -0,0 +1,2 @@
+import type { EngagementPlatformPlugin } from './engagementPlatformPluginType';
+export declare const engagementPlatformPlugin: EngagementPlatformPlugin;

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

@@ -0,0 +1,42 @@
+import type { PropsWithChildren, ReactNode } from 'react';
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+export type EngagementPlatformPlugin = NextEditorPlugin<'engagementPlatform', {
+    pluginConfiguration: EngagementPlatformPluginOptions;
+    dependencies: [
+    ];
+    sharedState: EngagementPlatformPluginState;
+}>;
+export interface CoordinationClient {
+    start(messageId: string, variationId?: string): Promise<boolean>;
+    stop(messageId: string): Promise<boolean>;
+}
+export type EngagementPlatformPluginOptions = {
+    epComponents: EpComponents;
+    epHooks: EpHooks;
+    coordinationClient: CoordinationClient;
+};
+export type EpComponents = {
+    EngagementProvider: React.ComponentType<PropsWithChildren<{}>>;
+    EngagementSpotlight: React.ComponentType<{
+        engagementId: string;
+    }>;
+    EngagementInlineDialog: React.ComponentType<PropsWithChildren<{
+        engagementId: string;
+    }>>;
+    Coordination: React.ComponentType<PropsWithChildren<{
+        client: CoordinationClient;
+        messageId: string;
+        fallback: ReactNode;
+    }>>;
+};
+export type EpHooks = {
+    useCoordination: (client: CoordinationClient, messageId: string) => [
+        boolean,
+        (force?: boolean) => Promise<void>
+    ];
+};
+export type EngagementPlatformPluginState = {
+    epComponents: EpComponents;
+    epHooks: EpHooks;
+    coordinationClient: CoordinationClient;
+} | undefined;

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

@@ -0,0 +1,2 @@
+export { engagementPlatformPlugin } from './engagementPlatformPlugin';
+export type { EngagementPlatformPlugin, EngagementPlatformPluginOptions, EpComponents, EpHooks, CoordinationClient, } from './engagementPlatformPluginType';

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

@@ -0,0 +1,9 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+import type { EngagementPlatformPluginOptions, EngagementPlatformPluginState } from '../engagementPlatformPluginType';
+export declare const engagementPlatformPluginKey: PluginKey<EngagementPlatformPluginState>;
+export declare const createPlugin: (pluginOptions: EngagementPlatformPluginOptions) => SafePlugin<{
+    epComponents: import("../engagementPlatformPluginType").EpComponents;
+    epHooks: import("../engagementPlatformPluginType").EpHooks;
+    coordinationClient: import("../engagementPlatformPluginType").CoordinationClient;
+} | undefined>;

package/package.json

@@ -0,0 +1,75 @@
+{
+	"name": "@atlaskit/editor-plugin-engagement-platform",
+	"version": "2.0.0",
+	"description": "Engagement platform plugin for @atlaskit/editor-core“",
+	"author": "Atlassian Pty Ltd",
+	"license": "Apache-2.0",
+	"publishConfig": {
+		"registry": "https://registry.npmjs.org/"
+	},
+	"atlassian": {
+		"team": "Editor: Core Experiences",
+		"inPublicMirror": false,
+		"singleton": true,
+		"releaseModel": "continuous",
+		"runReact18": false
+	},
+	"repository": "https://stash.atlassian.com/projects/ATLASSIAN/repos/atlassian-frontend-monorepo",
+	"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 <5.4": {
+			"*": [
+				"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": "^93.1.0",
+		"@atlaskit/editor-prosemirror": "6.0.0",
+		"@babel/runtime": "^7.0.0"
+	},
+	"peerDependencies": {
+		"react": "^16.8.0"
+	},
+	"techstack": {
+		"@atlassian/frontend": {
+			"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": [
+				"emotion",
+				"emotion"
+			]
+		}
+	}
+}