@atlaskit/editor-plugin-track-changes 0.0.0

package/LICENSE.md

@@ -0,0 +1,11 @@
+Copyright 2019 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 @@
+# Editor plugin track changes

package/build/tsconfig.json

@@ -0,0 +1,17 @@
+{
+	"extends": "../tsconfig",
+	"compilerOptions": {
+		"target": "es5",
+		"paths": {}
+	},
+	"include": [
+		"../src/**/*.ts",
+		"../src/**/*.tsx"
+	],
+	"exclude": [
+		"../src/**/__tests__/*",
+		"../src/**/*.test.*",
+		"../src/**/test.*",
+		"../src/**/examples.*"
+	]
+}

package/dist/cjs/index.js

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

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

@@ -0,0 +1,29 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.trackChangesPluginKey = exports.createTrackChangesPlugin = void 0;
+var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
+var _state = require("@atlaskit/editor-prosemirror/state");
+var trackChangesPluginKey = exports.trackChangesPluginKey = new _state.PluginKey('showDiffPlugin');
+
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
+
+var createTrackChangesPlugin = exports.createTrackChangesPlugin = function createTrackChangesPlugin() {
+  return new _safePlugin.SafePlugin({
+    key: trackChangesPluginKey,
+    state: {
+      init: function init() {
+        return {};
+      },
+      apply: function apply(tr, currentPluginState) {
+        var meta = tr.getMeta(trackChangesPluginKey);
+        if (meta) {
+          return meta;
+        }
+        return currentPluginState;
+      }
+    }
+  });
+};

package/dist/cjs/trackChangesPlugin.js

@@ -0,0 +1,24 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.trackChangesPlugin = void 0;
+var _main = require("./pm-plugins/main");
+var trackChangesPlugin = exports.trackChangesPlugin = function trackChangesPlugin() {
+  return {
+    name: 'trackChanges',
+    pmPlugins: function pmPlugins() {
+      return [{
+        name: 'trackChangesPlugin',
+        plugin: _main.createTrackChangesPlugin
+      }];
+    },
+    commands: {
+      setBaseline: function setBaseline(_ref) {
+        var tr = _ref.tr;
+        return tr.setMeta('setBaseline', true);
+      }
+    }
+  };
+};

package/dist/cjs/trackChangesPluginType.js

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

package/dist/es2019/index.js

@@ -0,0 +1,4 @@
+/* eslint-disable @atlaskit/editor/no-re-export */
+// Entry file in package.json
+
+export { trackChangesPlugin } from './trackChangesPlugin';

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 trackChangesPluginKey = new PluginKey('showDiffPlugin');
+
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
+
+export const createTrackChangesPlugin = () => {
+  return new SafePlugin({
+    key: trackChangesPluginKey,
+    state: {
+      init() {
+        return {};
+      },
+      apply: (tr, currentPluginState) => {
+        const meta = tr.getMeta(trackChangesPluginKey);
+        if (meta) {
+          return meta;
+        }
+        return currentPluginState;
+      }
+    }
+  });
+};

package/dist/es2019/trackChangesPlugin.js

@@ -0,0 +1,17 @@
+import { createTrackChangesPlugin } from './pm-plugins/main';
+export const trackChangesPlugin = () => ({
+  name: 'trackChanges',
+  pmPlugins() {
+    return [{
+      name: 'trackChangesPlugin',
+      plugin: createTrackChangesPlugin
+    }];
+  },
+  commands: {
+    setBaseline: ({
+      tr
+    }) => {
+      return tr.setMeta('setBaseline', true);
+    }
+  }
+});

package/dist/es2019/trackChangesPluginType.js

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

package/dist/esm/index.js

@@ -0,0 +1,4 @@
+/* eslint-disable @atlaskit/editor/no-re-export */
+// Entry file in package.json
+
+export { trackChangesPlugin } from './trackChangesPlugin';

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 trackChangesPluginKey = new PluginKey('showDiffPlugin');
+
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
+
+export var createTrackChangesPlugin = function createTrackChangesPlugin() {
+  return new SafePlugin({
+    key: trackChangesPluginKey,
+    state: {
+      init: function init() {
+        return {};
+      },
+      apply: function apply(tr, currentPluginState) {
+        var meta = tr.getMeta(trackChangesPluginKey);
+        if (meta) {
+          return meta;
+        }
+        return currentPluginState;
+      }
+    }
+  });
+};

package/dist/esm/trackChangesPlugin.js

@@ -0,0 +1,18 @@
+import { createTrackChangesPlugin } from './pm-plugins/main';
+export var trackChangesPlugin = function trackChangesPlugin() {
+  return {
+    name: 'trackChanges',
+    pmPlugins: function pmPlugins() {
+      return [{
+        name: 'trackChangesPlugin',
+        plugin: createTrackChangesPlugin
+      }];
+    },
+    commands: {
+      setBaseline: function setBaseline(_ref) {
+        var tr = _ref.tr;
+        return tr.setMeta('setBaseline', true);
+      }
+    }
+  };
+};

package/dist/esm/trackChangesPluginType.js

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

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export { trackChangesPlugin } from './trackChangesPlugin';
+export type { TrackChangesPlugin } from './trackChangesPluginType';

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

@@ -0,0 +1,6 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+export declare const trackChangesPluginKey: PluginKey<any>;
+type TrackChangesPluginState = {};
+export declare const createTrackChangesPlugin: () => SafePlugin<TrackChangesPluginState>;
+export {};

package/dist/types/trackChangesPlugin.d.ts

@@ -0,0 +1,2 @@
+import type { TrackChangesPlugin } from './trackChangesPluginType';
+export declare const trackChangesPlugin: TrackChangesPlugin;

package/dist/types/trackChangesPluginType.d.ts

@@ -0,0 +1,2 @@
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+export type TrackChangesPlugin = NextEditorPlugin<'trackChanges'>;

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

@@ -0,0 +1,2 @@
+export { trackChangesPlugin } from './trackChangesPlugin';
+export type { TrackChangesPlugin } from './trackChangesPluginType';

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

@@ -0,0 +1,6 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+export declare const trackChangesPluginKey: PluginKey<any>;
+type TrackChangesPluginState = {};
+export declare const createTrackChangesPlugin: () => SafePlugin<TrackChangesPluginState>;
+export {};

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

@@ -0,0 +1,2 @@
+import type { TrackChangesPlugin } from './trackChangesPluginType';
+export declare const trackChangesPlugin: TrackChangesPlugin;

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

@@ -0,0 +1,2 @@
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+export type TrackChangesPlugin = NextEditorPlugin<'trackChanges'>;

package/docs/0-intro.tsx

@@ -0,0 +1,43 @@
+import React from 'react';
+
+import { AtlassianInternalWarning, code, md } from '@atlaskit/docs';
+// eslint-disable-next-line @atlassian/tangerine/import/entry-points
+import { createEditorUseOnlyNotice } from '@atlaskit/editor-common/doc-utils';
+import { token } from '@atlaskit/tokens';
+
+export default md`
+
+${createEditorUseOnlyNotice('Editor Plugin Track Changes', [
+	{ name: 'Editor Core', link: '/packages/editor/editor-core' },
+])}
+
+
+  ${
+		(
+			// eslint-disable-next-line @atlaskit/ui-styling-standard/enforce-style-prop -- Ignored via go/DSP-18766
+			<div style={{ marginTop: token('space.100', '8px') }}>
+				<AtlassianInternalWarning />
+			</div>
+		)
+	}
+
+  This package includes the track changes plugin used by \`@atlaskit/editor-core\`.
+
+  ## Usage
+---
+
+The \`dependencies\`, \`configuration\`, \`state\`, \`actions\`, and \`commands\` of the plugin are defined
+below:
+
+${code`
+type TrackChangesPlugin = NextEditorPlugin<'trackChanges'>;
+`}
+
+
+  ## 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/package.json

@@ -0,0 +1,80 @@
+{
+	"name": "@atlaskit/editor-plugin-track-changes",
+	"version": "0.0.0",
+	"description": "ShowDiff plugin for @atlaskit/editor-core",
+	"author": "Atlassian Pty Ltd",
+	"license": "Apache-2.0",
+	"publishConfig": {
+		"registry": "https://registry.npmjs.org/"
+	},
+	"atlassian": {
+		"team": "Editor: AI",
+		"releaseModel": "continuous",
+		"singleton": true
+	},
+	"repository": "https://bitbucket.org/atlassian/atlassian-frontend-mirror",
+	"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": "^107.7.0",
+		"@atlaskit/editor-prosemirror": "7.0.0",
+		"@babel/runtime": "^7.0.0"
+	},
+	"peerDependencies": {
+		"react": "^18.2.0"
+	},
+	"devDependencies": {
+		"typescript": "~5.4.2"
+	},
+	"techstack": {
+		"@atlassian/frontend": {
+			"code-structure": [
+				"editor-plugin"
+			],
+			"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"
+			],
+			"imports": [
+				"import-no-extraneous-disable-for-examples-and-docs"
+			]
+		}
+	}
+}

package/tsconfig.json

@@ -0,0 +1,12 @@
+{
+	"extends": "../../../tsconfig.json",
+	"include": [
+		"examples/**/*.ts",
+		"examples/**/*.tsx",
+		"example-helpers/**/*.ts",
+		"example-helpers/**/*.tsx",
+		"src/**/*.ts",
+		"src/**/*.tsx"
+	],
+	"compilerOptions": {}
+}