@atlaskit/editor-plugin-help-dialog 0.1.0

package/.eslintrc.js

@@ -0,0 +1,6 @@
+module.exports = {
+  rules: {
+    '@typescript-eslint/no-duplicate-imports': 'error',
+    '@typescript-eslint/no-explicit-any': 'error',
+  },
+};

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# @atlaskit/editor-plugin-help-dialog
+
+## 0.1.0
+
+### Minor Changes
+
+- [#41020](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/41020) [`ab49509530f`](https://bitbucket.org/atlassian/atlassian-frontend/commits/ab49509530f) - Add editor-plugin-help-dialog
+
+### Patch Changes
+
+- Updated dependencies

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,30 @@
+# Editor plugin help-dialog
+
+Help Dialog 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.
+
+## Install
+---
+- **Install** - *yarn add @atlaskit/editor-plugin-help-dialog*
+- **npm** - [@atlaskit/editor-plugin-help-dialog](https://www.npmjs.com/package/@atlaskit/editor-plugin-help-dialog)
+- **Source** - [Bitbucket](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-help-dialog)
+- **Bundle** - [unpkg.com](https://unpkg.com/@atlaskit/editor-plugin-help-dialog/dist/)
+
+## Usage
+---
+**Internal use only**
+
+@atlaskit/editor-plugin-help-dialog 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 plugin Help Dialog](https://atlaskit.atlassian.com/packages/editor/editor-plugin-help-dialog) 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#License) for more licensing information.

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 { HelpDialogPlugin, HelpDialogSharedState } from './types';

package/dist/types/types.d.ts

@@ -0,0 +1,15 @@
+import type { NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
+import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { QuickInsertPlugin } from '@atlaskit/editor-plugin-quick-insert';
+export interface HelpDialogSharedState {
+    isVisible: boolean;
+    imageEnabled: boolean;
+}
+export type HelpDialogPlugin = NextEditorPlugin<'helpDialog', {
+    dependencies: [
+        OptionalPlugin<AnalyticsPlugin>,
+        OptionalPlugin<QuickInsertPlugin>
+    ];
+    pluginConfiguration: boolean;
+    sharedState: HelpDialogSharedState | null;
+}>;

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

@@ -0,0 +1 @@
+export type { HelpDialogPlugin, HelpDialogSharedState } from './types';

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

@@ -0,0 +1,15 @@
+import type { NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
+import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { QuickInsertPlugin } from '@atlaskit/editor-plugin-quick-insert';
+export interface HelpDialogSharedState {
+    isVisible: boolean;
+    imageEnabled: boolean;
+}
+export type HelpDialogPlugin = NextEditorPlugin<'helpDialog', {
+    dependencies: [
+        OptionalPlugin<AnalyticsPlugin>,
+        OptionalPlugin<QuickInsertPlugin>
+    ];
+    pluginConfiguration: boolean;
+    sharedState: HelpDialogSharedState | null;
+}>;

package/package.json

@@ -0,0 +1,78 @@
+{
+  "name": "@atlaskit/editor-plugin-help-dialog",
+  "version": "0.1.0",
+  "description": "Help Dialog plugin for @atlaskit/editor-core",
+  "author": "Atlassian Pty Ltd",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "atlassian": {
+    "team": "Editor: Lego",
+    "singleton": true,
+    "releaseModel": "continuous"
+  },
+  "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": "^76.2.0",
+    "@atlaskit/editor-plugin-analytics": "^0.2.0",
+    "@atlaskit/editor-plugin-quick-insert": "^0.1.0",
+    "@babel/runtime": "^7.0.0"
+  },
+  "devDependencies": {
+    "@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.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": [
+        "static",
+        "emotion"
+      ]
+    }
+  },
+  "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.0"
+}

package/report.api.md

@@ -0,0 +1,59 @@
+<!-- API Report Version: 2.3 -->
+
+## API Report File for "@atlaskit/editor-plugin-help-dialog"
+
+> 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 { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { OptionalPlugin } from '@atlaskit/editor-common/types';
+import type { QuickInsertPlugin } from '@atlaskit/editor-plugin-quick-insert';
+
+// @public (undocumented)
+export type HelpDialogPlugin = NextEditorPlugin<
+  'helpDialog',
+  {
+    dependencies: [
+      OptionalPlugin<AnalyticsPlugin>,
+      OptionalPlugin<QuickInsertPlugin>,
+    ];
+    pluginConfiguration: boolean;
+    sharedState: HelpDialogSharedState | null;
+  }
+>;
+
+// @public (undocumented)
+export interface HelpDialogSharedState {
+  // (undocumented)
+  imageEnabled: boolean;
+  // (undocumented)
+  isVisible: boolean;
+}
+
+// (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,32 @@
+## API Report File for "@atlaskit/editor-plugin-help-dialog"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { OptionalPlugin } from '@atlaskit/editor-common/types';
+import type { QuickInsertPlugin } from '@atlaskit/editor-plugin-quick-insert';
+
+// @public (undocumented)
+export type HelpDialogPlugin = NextEditorPlugin<'helpDialog', {
+    dependencies: [
+    OptionalPlugin<AnalyticsPlugin>,
+    OptionalPlugin<QuickInsertPlugin>
+    ];
+    pluginConfiguration: boolean;
+    sharedState: HelpDialogSharedState | null;
+}>;
+
+// @public (undocumented)
+export interface HelpDialogSharedState {
+    // (undocumented)
+    imageEnabled: boolean;
+    // (undocumented)
+    isVisible: boolean;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```