@atlaskit/editor-plugin-annotation 0.1.0

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

@@ -0,0 +1,44 @@
+import type { AnalyticsEventPayloadCallback, INPUT_METHOD } from '@atlaskit/editor-common/analytics';
+import { containsAnyAnnotations, hasAnnotationMark } from '@atlaskit/editor-common/utils';
+import type { Mark, Node, ResolvedPos, Schema, Slice } from '@atlaskit/editor-prosemirror/model';
+import type { EditorState, Selection } from '@atlaskit/editor-prosemirror/state';
+import { AllSelection, PluginKey, TextSelection } from '@atlaskit/editor-prosemirror/state';
+import { Decoration } from '@atlaskit/editor-prosemirror/view';
+import type { InlineCommentPluginState } from './pm-plugins/types';
+import type { AnnotationInfo } from './types';
+import { AnnotationSelectionType } from './types';
+export { hasAnnotationMark, containsAnyAnnotations };
+/**
+ * Finds the marks in the nodes to the left and right.
+ * @param $pos Position to center search around
+ */
+export declare const surroundingMarks: ($pos: ResolvedPos) => (readonly Mark[])[];
+export declare const getAllAnnotations: (doc: Node) => string[];
+export declare const addDraftDecoration: (start: number, end: number) => Decoration;
+export declare const getAnnotationViewKey: (annotations: AnnotationInfo[]) => string;
+export declare const findAnnotationsInSelection: (selection: Selection, doc: Node) => AnnotationInfo[];
+/**
+ * get selection from position to apply new comment for
+ * @return bookmarked positions if they exists, otherwise current selection positions
+ */
+export declare function getSelectionPositions(editorState: EditorState, inlineCommentState?: InlineCommentPluginState | null | undefined): Selection;
+export declare const inlineCommentPluginKey: PluginKey<InlineCommentPluginState>;
+export declare const getPluginState: (state: EditorState) => InlineCommentPluginState | undefined;
+/**
+ * get payload for the open/close analytics event
+ */
+export declare const getDraftCommandAnalyticsPayload: (drafting: boolean, inputMethod: INPUT_METHOD.TOOLBAR | INPUT_METHOD.SHORTCUT) => AnalyticsEventPayloadCallback;
+export declare const isSelectionValid: (state: EditorState) => AnnotationSelectionType;
+export declare const hasInvalidNodes: (state: EditorState) => boolean;
+/**
+ * Checks if any of the nodes in a given selection are completely whitespace
+ * This is to conform to Confluence annotation specifications
+ */
+export declare function hasInvalidWhitespaceNode(selection: TextSelection | AllSelection, schema: Schema): boolean;
+export declare function annotationExists(annotationId: string, state: EditorState): boolean;
+export declare function stripNonExistingAnnotations(slice: Slice, state: EditorState): false | undefined;
+/**
+ * Compares two sets of annotationInfos to see if the annotations have changed
+ * This function assumes annotations will have unique id's for simplicity
+ */
+export declare function isSelectedAnnotationsChanged(oldSelectedAnnotations: AnnotationInfo[], newSelectedAnnotations: AnnotationInfo[]): boolean;

package/package.json

@@ -0,0 +1,106 @@
+{
+  "name": "@atlaskit/editor-plugin-annotation",
+  "version": "0.1.0",
+  "description": "Annotation plugin for @atlaskit/editor-core",
+  "author": "Atlassian Pty Ltd",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "atlassian": {
+    "team": "Editor: AI",
+    "inPublicMirror": false,
+    "releaseModel": "continuous",
+    "website": {
+      "name": "EditorPluginAnnotation",
+      "category": "Components"
+    }
+  },
+  "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/adf-schema": "^35.2.0",
+    "@atlaskit/editor-common": "^76.28.0",
+    "@atlaskit/editor-plugin-analytics": "^0.4.0",
+    "@atlaskit/editor-prosemirror": "1.1.0",
+    "@atlaskit/icon": "^22.0.0",
+    "@atlaskit/platform-feature-flags": "^0.2.0",
+    "@babel/runtime": "^7.0.0"
+  },
+  "peerDependencies": {
+    "react": "^16.8.0"
+  },
+  "devDependencies": {
+    "@af/integration-testing": "*",
+    "@af/visual-regression": "*",
+    "@atlaskit/ssr": "*",
+    "@atlaskit/visual-regression": "*",
+    "@atlaskit/webdriver-runner": "*",
+    "@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
+    "@atlassian/feature-flags-test-utils": "^0.1.1",
+    "@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"
+      ],
+      "imports": [
+        "import-no-extraneous-disable-for-examples-and-docs"
+      ]
+    }
+  },
+  "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.0",
+  "platform-feature-flags": {
+    "platform.editor.annotation.decouple-inline-comment-closed_flmox": {
+      "type": "boolean"
+    },
+    "platform.editor.enable-selection-toolbar_ucdwd": {
+      "type": "boolean"
+    }
+  }
+}