@atlaskit/editor-plugin-editor-disabled 0.1.0

package/CHANGELOG.md

@@ -0,0 +1 @@
+# @atlaskit/editor-plugin-editor-disabled

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,7 @@
+# EditorPluginEditorDisabled
+
+Editor disabled plugin for @atlaskit/editor-core
+
+## Usage
+
+`import { editorDisabledPlugin } from '@atlaskit/editor-plugin-editor-disabled';`

package/dist/cjs/index.js

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

package/dist/cjs/plugin.js

@@ -0,0 +1,72 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.editorDisabledPlugin = void 0;
+var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
+var _utils = require("@atlaskit/editor-common/utils");
+var _state = require("@atlaskit/editor-prosemirror/state");
+var pluginKey = new _state.PluginKey('editorDisabledPlugin');
+function reducer(_pluginState, meta) {
+  return meta;
+}
+var _pluginFactory = (0, _utils.pluginFactory)(pluginKey, reducer),
+  createPluginState = _pluginFactory.createPluginState,
+  getPluginState = _pluginFactory.getPluginState;
+
+/*
+Stores the state of the editor enabled/disabled for panel and floating
+toolbar to subscribe to through <WithPluginState>. Otherwise the NodeViews
+won't re-render when it changes.
+*/
+function createPlugin(dispatch) {
+  return new _safePlugin.SafePlugin({
+    key: pluginKey,
+    state: createPluginState(dispatch, {
+      editorDisabled: false
+    }),
+    view: function view() {
+      return {
+        update: function update(view) {
+          if (getPluginState(view.state).editorDisabled !== !view.editable) {
+            var tr = view.state.tr.setMeta(pluginKey, {
+              editorDisabled: !view.editable
+            });
+            tr.setMeta('isLocal', true);
+            view.dispatch(tr);
+          }
+        }
+      };
+    }
+  });
+}
+var editorDisabledPlugin = function editorDisabledPlugin() {
+  return {
+    name: 'editorDisabled',
+    getSharedState: function getSharedState(editorState) {
+      if (!editorState) {
+        return {
+          editorDisabled: false
+        };
+      }
+      var pluginState = pluginKey.getState(editorState);
+      if (!pluginState) {
+        return {
+          editorDisabled: false
+        };
+      }
+      return pluginState;
+    },
+    pmPlugins: function pmPlugins() {
+      return [{
+        name: 'editorDisabled',
+        plugin: function plugin(_ref) {
+          var dispatch = _ref.dispatch;
+          return createPlugin(dispatch);
+        }
+      }];
+    }
+  };
+};
+exports.editorDisabledPlugin = editorDisabledPlugin;

package/dist/cjs/version.json

@@ -0,0 +1,5 @@
+{
+	"name": "@atlaskit/editor-plugin-editor-disabled",
+	"version": "0.1.0",
+	"sideEffects": false
+}

package/dist/es2019/index.js

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

package/dist/es2019/plugin.js

@@ -0,0 +1,61 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { pluginFactory } from '@atlaskit/editor-common/utils';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+const pluginKey = new PluginKey('editorDisabledPlugin');
+function reducer(_pluginState, meta) {
+  return meta;
+}
+const {
+  createPluginState,
+  getPluginState
+} = pluginFactory(pluginKey, reducer);
+
+/*
+Stores the state of the editor enabled/disabled for panel and floating
+toolbar to subscribe to through <WithPluginState>. Otherwise the NodeViews
+won't re-render when it changes.
+*/
+function createPlugin(dispatch) {
+  return new SafePlugin({
+    key: pluginKey,
+    state: createPluginState(dispatch, {
+      editorDisabled: false
+    }),
+    view: () => {
+      return {
+        update(view) {
+          if (getPluginState(view.state).editorDisabled !== !view.editable) {
+            const tr = view.state.tr.setMeta(pluginKey, {
+              editorDisabled: !view.editable
+            });
+            tr.setMeta('isLocal', true);
+            view.dispatch(tr);
+          }
+        }
+      };
+    }
+  });
+}
+export const editorDisabledPlugin = () => ({
+  name: 'editorDisabled',
+  getSharedState(editorState) {
+    if (!editorState) {
+      return {
+        editorDisabled: false
+      };
+    }
+    const pluginState = pluginKey.getState(editorState);
+    if (!pluginState) {
+      return {
+        editorDisabled: false
+      };
+    }
+    return pluginState;
+  },
+  pmPlugins: () => [{
+    name: 'editorDisabled',
+    plugin: ({
+      dispatch
+    }) => createPlugin(dispatch)
+  }]
+});

package/dist/es2019/version.json

@@ -0,0 +1,5 @@
+{
+	"name": "@atlaskit/editor-plugin-editor-disabled",
+	"version": "0.1.0",
+	"sideEffects": false
+}

package/dist/esm/index.js

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

package/dist/esm/plugin.js

@@ -0,0 +1,65 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { pluginFactory } from '@atlaskit/editor-common/utils';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+var pluginKey = new PluginKey('editorDisabledPlugin');
+function reducer(_pluginState, meta) {
+  return meta;
+}
+var _pluginFactory = pluginFactory(pluginKey, reducer),
+  createPluginState = _pluginFactory.createPluginState,
+  getPluginState = _pluginFactory.getPluginState;
+
+/*
+Stores the state of the editor enabled/disabled for panel and floating
+toolbar to subscribe to through <WithPluginState>. Otherwise the NodeViews
+won't re-render when it changes.
+*/
+function createPlugin(dispatch) {
+  return new SafePlugin({
+    key: pluginKey,
+    state: createPluginState(dispatch, {
+      editorDisabled: false
+    }),
+    view: function view() {
+      return {
+        update: function update(view) {
+          if (getPluginState(view.state).editorDisabled !== !view.editable) {
+            var tr = view.state.tr.setMeta(pluginKey, {
+              editorDisabled: !view.editable
+            });
+            tr.setMeta('isLocal', true);
+            view.dispatch(tr);
+          }
+        }
+      };
+    }
+  });
+}
+export var editorDisabledPlugin = function editorDisabledPlugin() {
+  return {
+    name: 'editorDisabled',
+    getSharedState: function getSharedState(editorState) {
+      if (!editorState) {
+        return {
+          editorDisabled: false
+        };
+      }
+      var pluginState = pluginKey.getState(editorState);
+      if (!pluginState) {
+        return {
+          editorDisabled: false
+        };
+      }
+      return pluginState;
+    },
+    pmPlugins: function pmPlugins() {
+      return [{
+        name: 'editorDisabled',
+        plugin: function plugin(_ref) {
+          var dispatch = _ref.dispatch;
+          return createPlugin(dispatch);
+        }
+      }];
+    }
+  };
+};

package/dist/esm/version.json

@@ -0,0 +1,5 @@
+{
+	"name": "@atlaskit/editor-plugin-editor-disabled",
+	"version": "0.1.0",
+	"sideEffects": false
+}

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export { editorDisabledPlugin } from './plugin';
+export type { EditorDisabledPluginState, EditorDisabledPlugin } from './plugin';

package/dist/types/plugin.d.ts

@@ -0,0 +1,8 @@
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+export type EditorDisabledPluginState = {
+    editorDisabled: boolean;
+};
+export type EditorDisabledPlugin = NextEditorPlugin<'editorDisabled', {
+    sharedState: EditorDisabledPluginState;
+}>;
+export declare const editorDisabledPlugin: EditorDisabledPlugin;

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

@@ -0,0 +1,2 @@
+export { editorDisabledPlugin } from './plugin';
+export type { EditorDisabledPluginState, EditorDisabledPlugin } from './plugin';

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

@@ -0,0 +1,8 @@
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+export type EditorDisabledPluginState = {
+    editorDisabled: boolean;
+};
+export type EditorDisabledPlugin = NextEditorPlugin<'editorDisabled', {
+    sharedState: EditorDisabledPluginState;
+}>;
+export declare const editorDisabledPlugin: EditorDisabledPlugin;

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "@atlaskit/editor-plugin-editor-disabled",
+  "version": "0.1.0",
+  "description": "Editor disabled plugin for @atlaskit/editor-core",
+  "author": "Atlassian Pty Ltd",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "atlassian": {
+    "team": "Editor",
+    "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",
+  "sideEffects": false,
+  "atlaskit:src": "src/index.ts",
+  "af:exports": {
+    ".": "./src/index.ts"
+  },
+  "dependencies": {
+    "@atlaskit/editor-common": "^74.20.0",
+    "@atlaskit/editor-prosemirror": "1.0.2",
+    "@babel/runtime": "^7.0.0"
+  },
+  "peerDependencies": {
+    "react": "^16.8.0"
+  },
+  "devDependencies": {
+    "@atlaskit/editor-test-helpers": "^18.10.0",
+    "@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": {
+      "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,51 @@
+<!-- API Report Version: 2.3 -->
+
+## API Report File for "@atlaskit/editor-plugin-editor-disabled"
+
+> 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 { NextEditorPlugin } from '@atlaskit/editor-common/types';
+
+// @public (undocumented)
+export type EditorDisabledPlugin = NextEditorPlugin<
+  'editorDisabled',
+  {
+    sharedState: EditorDisabledPluginState;
+  }
+>;
+
+// @public (undocumented)
+export const editorDisabledPlugin: EditorDisabledPlugin;
+
+// @public (undocumented)
+export type EditorDisabledPluginState = {
+  editorDisabled: 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,24 @@
+## API Report File for "@atlaskit/editor-plugin-editor-disabled"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+
+// @public (undocumented)
+export type EditorDisabledPlugin = NextEditorPlugin<'editorDisabled', {
+    sharedState: EditorDisabledPluginState;
+}>;
+
+// @public (undocumented)
+export const editorDisabledPlugin: EditorDisabledPlugin;
+
+// @public (undocumented)
+export type EditorDisabledPluginState = {
+    editorDisabled: boolean;
+};
+
+// (No @packageDocumentation comment for this package)
+
+```