@lofcz/platejs-suggestion 52.0.11

package/LICENSE

@@ -0,0 +1,24 @@
+The MIT License (MIT)
+
+Copyright (c) Ziad Beyens, Dylan Schiemann, Joe Anderson, Felix Feng
+
+Unless otherwise specified in a LICENSE file within an individual package directory,
+this license applies to all files in this repository outside of those package directories.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,5 @@
+# Plate plugin for suggestion
+
+## License
+
+[MIT](../../LICENSE)

package/dist/index.d.ts

@@ -0,0 +1,218 @@
+import { Descendant, EditorNodesOptions, KEYS, Node, NodeEntry, OverrideEditor, PluginConfig, SetNodesOptions, SlateEditor, TElement, TInlineSuggestionData, TLocation, TNode, TRange, TSuggestionElement, TSuggestionText, TText, Text, UnknownObject, ValueOf } from "platejs";
+import { ComputeDiffOptions } from "@platejs/diff";
+
+//#region src/lib/BaseSuggestionPlugin.d.ts
+type BaseSuggestionConfig = PluginConfig<'suggestion', {
+  currentUserId: string | null;
+  isSuggesting: boolean;
+}, {
+  suggestion: {
+    dataList: (node: TSuggestionText) => TInlineSuggestionData[];
+    isBlockSuggestion: (node: TNode) => node is TSuggestionElement;
+    node: (options?: EditorNodesOptions & {
+      id?: string;
+      isText?: boolean;
+    }) => NodeEntry<TSuggestionElement | TSuggestionText> | undefined;
+    nodeId: (node: TElement | TSuggestionText) => string | undefined;
+    nodes: (options?: EditorNodesOptions & {
+      transient?: boolean;
+    }) => NodeEntry<TElement | TSuggestionText>[];
+    suggestionData: (node: TElement | TSuggestionText) => TInlineSuggestionData | TSuggestionElement['suggestion'] | undefined;
+    withoutSuggestions: (fn: () => void) => void;
+  };
+}>;
+declare const BaseSuggestionPlugin: any;
+//#endregion
+//#region src/lib/diffToSuggestions.d.ts
+declare function diffToSuggestions<E extends SlateEditor>(editor: E, doc0: Descendant[], doc1: Descendant[], {
+  getDeleteProps,
+  getInsertProps,
+  getUpdateProps,
+  isInline,
+  ...options
+}?: Partial<ComputeDiffOptions>): ValueOf<E>;
+//#endregion
+//#region src/lib/types.d.ts
+type SuggestionEditorProps = {
+  activeSuggestionId?: string | null;
+  isSuggesting?: boolean;
+};
+type SuggestionUser = UnknownObject & {
+  id: string;
+  name: string;
+  avatarUrl?: string;
+};
+type TResolvedSuggestion = {
+  createdAt: Date;
+  keyId: string;
+  suggestionId: string;
+  type: 'insert' | 'remove' | 'replace' | 'update';
+  userId: string;
+  newProperties?: any;
+  newText?: string;
+  properties?: any;
+  text?: string;
+};
+interface TSuggestion extends UnknownObject {
+  id: string;
+  isAccepted?: boolean;
+  isRejected?: boolean;
+}
+//#endregion
+//#region src/lib/withSuggestion.d.ts
+declare const withSuggestion: OverrideEditor<BaseSuggestionConfig>;
+//#endregion
+//#region src/lib/queries/findSuggestionNode.d.ts
+declare const findInlineSuggestionNode: <E extends SlateEditor>(editor: E, options?: EditorNodesOptions<ValueOf<E>>) => any;
+//#endregion
+//#region src/lib/queries/findSuggestionProps.d.ts
+declare const findSuggestionProps: (editor: SlateEditor, {
+  at,
+  type
+}: {
+  at: TLocation;
+  type: "insert" | "remove" | "update";
+}) => {
+  id: string;
+  createdAt: number;
+};
+//#endregion
+//#region src/lib/transforms/acceptSuggestion.d.ts
+declare const acceptSuggestion: (editor: SlateEditor, description: TResolvedSuggestion) => void;
+//#endregion
+//#region src/lib/transforms/addMarkSuggestion.d.ts
+declare const addMarkSuggestion: (editor: SlateEditor, key: string, value: any) => void;
+//#endregion
+//#region src/lib/transforms/deleteFragmentSuggestion.d.ts
+declare const deleteFragmentSuggestion: (editor: SlateEditor, {
+  reverse
+}?: {
+  reverse?: boolean;
+}) => string | undefined;
+//#endregion
+//#region src/lib/transforms/deleteSuggestion.d.ts
+/**
+ * Suggest deletion one character at a time until target point is reached.
+ * Suggest additions are safely deleted.
+ */
+declare const deleteSuggestion: (editor: SlateEditor, at: TRange, {
+  reverse
+}?: {
+  reverse?: boolean;
+}) => string | undefined;
+//#endregion
+//#region src/lib/transforms/getSuggestionProps.d.ts
+declare const getSuggestionProps: (editor: SlateEditor, node: Descendant, {
+  id,
+  createdAt,
+  suggestionDeletion,
+  suggestionUpdate,
+  transient
+}?: {
+  id?: string;
+  createdAt?: number;
+  suggestionDeletion?: boolean;
+  suggestionUpdate?: any;
+  transient?: boolean;
+}) => {
+  [x: string]: {
+    id: string;
+    createdAt: number;
+    type: string;
+    userId: any;
+  };
+  [KEYS.suggestion]: boolean;
+} | {
+  [KEYS.suggestion]: {
+    id: string;
+    createdAt: number;
+    type: string;
+    userId: any;
+  };
+};
+//#endregion
+//#region src/lib/transforms/insertFragmentSuggestion.d.ts
+declare const insertFragmentSuggestion: (editor: SlateEditor, fragment: Descendant[], {
+  insertFragment
+}?: {
+  insertFragment?: (fragment: Descendant[]) => void;
+}) => void;
+//#endregion
+//#region src/lib/transforms/insertTextSuggestion.d.ts
+declare const insertTextSuggestion: (editor: SlateEditor, text: string) => void;
+//#endregion
+//#region src/lib/transforms/rejectSuggestion.d.ts
+declare const rejectSuggestion: (editor: SlateEditor, description: TResolvedSuggestion) => void;
+//#endregion
+//#region src/lib/transforms/removeMarkSuggestion.d.ts
+declare const removeMarkSuggestion: (editor: SlateEditor, key: string) => void;
+//#endregion
+//#region src/lib/transforms/removeNodesSuggestion.d.ts
+declare const removeNodesSuggestion: (editor: SlateEditor, nodes: NodeEntry<TElement | Text>[]) => void;
+//#endregion
+//#region src/lib/transforms/setSuggestionNodes.d.ts
+declare const setSuggestionNodes: (editor: SlateEditor, options?: {
+  createdAt?: number;
+  suggestionDeletion?: boolean;
+  suggestionId?: string;
+} & SetNodesOptions) => void;
+//#endregion
+//#region src/lib/utils/SkipSuggestionDeletes.d.ts
+/**
+ * Recursively extracts text content from a node tree, excluding any text marked
+ * with "remove" suggestions. but include the text marked with "insert" and
+ * "update" suggestions.
+ */
+declare const SkipSuggestionDeletes: (editor: SlateEditor, node: Node) => string;
+//#endregion
+//#region src/lib/utils/getActiveSuggestionDescriptions.d.ts
+type TSuggestionCommonDescription = {
+  suggestionId: string;
+  userId: string;
+};
+type TSuggestionDeletionDescription = {
+  deletedText: string;
+  type: 'deletion';
+} & TSuggestionCommonDescription;
+type TSuggestionDescription = TSuggestionDeletionDescription | TSuggestionInsertionDescription | TSuggestionReplacementDescription;
+type TSuggestionInsertionDescription = {
+  insertedText: string;
+  type: 'insertion';
+} & TSuggestionCommonDescription;
+type TSuggestionReplacementDescription = {
+  deletedText: string;
+  insertedText: string;
+  type: 'replacement';
+} & TSuggestionCommonDescription;
+/**
+ * Get the suggestion descriptions of the selected node. A node can have
+ * multiple suggestions (multiple users). Each description maps to a user
+ * suggestion.
+ */
+declare const getActiveSuggestionDescriptions: (editor: SlateEditor) => TSuggestionDescription[];
+//#endregion
+//#region src/lib/utils/getSuggestionId.d.ts
+declare const getSuggestionKeyId: (node: TElement | TText) => string | undefined;
+declare const getInlineSuggestionData: (node: TElement | TText) => any;
+declare const keyId2SuggestionId: (keyId: string) => string;
+//#endregion
+//#region src/lib/utils/getSuggestionKeys.d.ts
+declare const getSuggestionKey: (id?: string) => string;
+declare const isSuggestionKey: (key: string) => boolean;
+declare const getSuggestionKeys: (node: TNode) => string[];
+declare const getSuggestionUserIdByKey: (key?: string | null) => string | null;
+declare const getSuggestionUserIds: (node: TNode) => string[];
+declare const getSuggestionUserId: (node: TNode) => string;
+declare const isCurrentUserSuggestion: (editor: SlateEditor, node: TText) => boolean;
+//#endregion
+//#region src/lib/utils/getSuggestionNodeEntries.d.ts
+declare const getSuggestionNodeEntries: <E extends SlateEditor>(editor: E, suggestionId: string, {
+  at,
+  ...options
+}?: EditorNodesOptions<ValueOf<E>>) => any;
+//#endregion
+//#region src/lib/utils/getTransientSuggestionKey.d.ts
+declare const getTransientSuggestionKey: () => string;
+//#endregion
+export { BaseSuggestionConfig, BaseSuggestionPlugin, SkipSuggestionDeletes, SuggestionEditorProps, SuggestionUser, TResolvedSuggestion, TSuggestion, TSuggestionCommonDescription, TSuggestionDeletionDescription, TSuggestionDescription, TSuggestionInsertionDescription, TSuggestionReplacementDescription, acceptSuggestion, addMarkSuggestion, deleteFragmentSuggestion, deleteSuggestion, diffToSuggestions, findInlineSuggestionNode, findSuggestionProps, getActiveSuggestionDescriptions, getInlineSuggestionData, getSuggestionKey, getSuggestionKeyId, getSuggestionKeys, getSuggestionNodeEntries, getSuggestionProps, getSuggestionUserId, getSuggestionUserIdByKey, getSuggestionUserIds, getTransientSuggestionKey, insertFragmentSuggestion, insertTextSuggestion, isCurrentUserSuggestion, isSuggestionKey, keyId2SuggestionId, rejectSuggestion, removeMarkSuggestion, removeNodesSuggestion, setSuggestionNodes, withSuggestion };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/lib/BaseSuggestionPlugin.ts","../src/lib/diffToSuggestions.ts","../src/lib/types.ts","../src/lib/withSuggestion.ts","../src/lib/queries/findSuggestionNode.ts","../src/lib/queries/findSuggestionProps.ts","../src/lib/transforms/acceptSuggestion.ts","../src/lib/transforms/addMarkSuggestion.ts","../src/lib/transforms/deleteFragmentSuggestion.ts","../src/lib/transforms/deleteSuggestion.ts","../src/lib/transforms/getSuggestionProps.ts","../src/lib/transforms/insertFragmentSuggestion.ts","../src/lib/transforms/insertTextSuggestion.ts","../src/lib/transforms/rejectSuggestion.ts","../src/lib/transforms/removeMarkSuggestion.ts","../src/lib/transforms/removeNodesSuggestion.ts","../src/lib/transforms/setSuggestionNodes.ts","../src/lib/utils/SkipSuggestionDeletes.ts","../src/lib/utils/getActiveSuggestionDescriptions.ts","../src/lib/utils/getSuggestionId.ts","../src/lib/utils/getSuggestionKeys.ts","../src/lib/utils/getSuggestionNodeEntries.ts","../src/lib/utils/getTransientSuggestionKey.ts"],"sourcesContent":[],"mappings":";;;;KAoBY,oBAAA,GAAuB;;;AAAnC,CAAA,EAAA;EAWuB,UAAA,EAAA;IAAoB,QAAA,EAAA,CAAA,IAAA,EAApB,eAAoB,EAAA,GAAA,qBAAA,EAAA;IACX,iBAAA,EAAA,CAAA,IAAA,EAAA,KAAA,EAAA,GAAA,IAAA,IAAkB,kBAAlB;IAAkB,IAAA,EAAA,CAAA,OAGR,CAHQ,EAEhC,kBAFgC,GAAA;MAEhC,EAAA,CAAA,EAAA,MAAA;MACG,MAAA,CAAA,EAAA,OAAA;IAAqB,CAAA,EAAA,GAA/B,SAA+B,CAArB,kBAAqB,GAAA,eAAA,CAAA,GAAA,SAAA;IAA/B,MAAA,EAAA,CAAA,IAAA,EACU,QADV,GACqB,eADrB,EAAA,GAAA,MAAA,GAAA,SAAA;IACU,KAAA,EAAA,CAAA,OAEH,CAFG,EAEH,kBAFG,GAAA;MAAW,SAAA,CAAA,EAAA,OAAA;IAEd,CAAA,EAAA,GACP,SADO,CACG,QADH,GACc,eADd,CAAA,EAAA;IACG,cAAA,EAAA,CAAA,IAAA,EAEP,QAFO,GAEI,eAFJ,EAAA,GAGV,qBAHU,GAGc,kBAHd,CAAA,YAAA,CAAA,GAAA,SAAA;IAAW,kBAAA,EAAA,CAAA,EAAA,EAAA,GAAA,GAAA,IAAA,EAAA,GAAA,IAAA;EAArB,CAAA;CAEG,CAAA;AAAW,cAOZ,oBAPY,EAAA,GAAA;;;iBC3BT,4BAA4B,qBAClC,SACF,oBACA;;;;;;IAaH,QAAQ,sBACV,QAAQ;;;KC5BC,qBAAA;;;AFiBZ,CAAA;AAWuB,KEvBX,cAAA,GAAiB,aFuBN,GAAA;EAAoB,EAAA,EAAA,MAAA;EACX,IAAA,EAAA,MAAA;EAAkB,SAAA,CAAA,EAAA,MAAA;CAEhC;AACG,KErBT,mBAAA,GFqBS;EAAqB,SAAA,EEpB7B,IFoB6B;EAA/B,KAAA,EAAA,MAAA;EACU,YAAA,EAAA,MAAA;EAAW,IAAA,EAAA,QAAA,GAAA,QAAA,GAAA,SAAA,GAAA,QAAA;EAEd,MAAA,EAAA,MAAA;EACG,aAAA,CAAA,EAAA,GAAA;EAAW,OAAA,CAAA,EAAA,MAAA;EAArB,UAAA,CAAA,EAAA,GAAA;EAEG,IAAA,CAAA,EAAA,MAAA;CAAW;AACd,UEhBM,WAAA,SAAoB,aFgB1B,CAAA;EAAwB,EAAA,EAAA,MAAA;EAtBA,UAAA,CAAA,EAAA,OAAA;EAAY,UAAA,CAAA,EAAA,OAAA;AA4B/C;;;cGzBa,gBAAgB,eAAe;;;cCb/B,qCAAsC,qBACzC,aACC,mBAAmB,QAAQ;;;cCCzB,8BACH;;;ALMV;MKLsB;;ALKtB,CAAA,EAAA,GAAY;EAWW,EAAA,EAAA,MAAA;EAAoB,SAAA,EAAA,MAAA;CACX;;;cMjBnB,2BACH,0BACK;;;cCHF,4BACH;;;cCXG,mCACH;;;;;;;;;;AReV;AAWuB,cSTV,gBTSU,EAAA,CAAA,MAAA,ESRb,WTQa,EAAA,EAAA,ESPjB,MTOiB,EAAA;EAAA;CACS,CADT,EAAA;EAAoB,OAAA,CAAA,EAAA,OAAA;CACX,EAAA,GAAA,MAAA,GAAA,SAAA;;;cUzBnB,6BACH,mBACF;;;;;;CVuB0C;;EAZtC,SAAA,CAAA,EAAA,MAAA;EAWW,kBAAA,CAAA,EAAA,OAAA;EAAoB,gBAAA,CAAA,EAAA,GAAA;EACX,SAAA,CAAA,EAAA,OAAA;CAAkB,EAAA,GAAA;EAEhC,CAAA,CAAA,EAAA,MAAA,CAAA,EAAA;IACG,EAAA,EAAA,MAAA;IAAqB,SAAA,EAAA,MAAA;IAA/B,IAAA,EAAA,MAAA;IACU,MAAA,EAAA,GAAA;EAAW,CAAA;EAEd,CUSb,IAAA,CAAK,UAAA,CVTQ,EAAA,OAAA;CACG,GAAA;EAAW,CUEzB,IAAA,CAAK,UAAA,CVFoB,EAAA;IAArB,EAAA,EAAA,MAAA;IAEG,SAAA,EAAA,MAAA;IAAW,IAAA,EAAA,MAAA;IACd,MAAA,EAAA,GAAA;EAAwB,CAAA;CAtBA;;;cWbtB,mCACH,uBACE;;;8BAIoB;;;;cCNnB,+BAAgC;;;cCahC,2BACH,0BACK;;;cCPF,+BAAgC;;;cCThC,gCACH,oBACD,UAAU,WAAW;;;cCMjB,6BACH,oBhBgBa;;;EAXX,YAAA,CAAA,EAAA,MAAA;CAWW,GgBXjB,ehBWiB,EAAA,GAAA,IAAA;;;;;;AAXvB;;AAW2C,ciBd9B,qBjBc8B,EAAA,CAAA,MAAA,EiBbjC,WjBaiC,EAAA,IAAA,EiBZnC,IjBYmC,EAAA,GAAA,MAAA;;;KkBzB/B,4BAAA;;;AlBcZ,CAAA;AAWuB,KkBpBX,8BAAA,GlBoBW;EAAoB,WAAA,EAAA,MAAA;EACX,IAAA,EAAA,UAAA;CAAkB,GkBlB9C,4BlBkB8C;AAEhC,KkBlBN,sBAAA,GACR,8BlBiBc,GkBhBd,+BlBgBc,GkBfd,iClBec;AACG,KkBbT,+BAAA,GlBaS;EAAqB,YAAA,EAAA,MAAA;EAA/B,IAAA,EAAA,WAAA;CACU,GkBXjB,4BlBWiB;AAAW,KkBTpB,iCAAA,GlBSoB;EAEd,WAAA,EAAA,MAAA;EACG,YAAA,EAAA,MAAA;EAAW,IAAA,EAAA,aAAA;CAArB,GkBRP,4BlBQO;;;;;;AAnBoC,ckBkBlC,+BlBlBkC,EAAA,CAAA,MAAA,EkBmBrC,WlBnBqC,EAAA,GkBoB5C,sBlBpB4C,EAAA;;;cmBflC,2BAA4B,WAAW;cAQvC,gCAAiC,WAAW;cAQ5C;;;cCVA;cAGA;cAGA,0BAA2B;ApBG5B,coBOC,wBpBPmB,EAAA,CAAA,GAAA,CAAA,EAAA,MAAA,GAAA,IAAA,EAAA,GAAA,MAAA,GAAA,IAAA;AAWT,coBDV,oBpBCU,EAAA,CAAA,IAAA,EoBDoB,KpBCpB,EAAA,GAAA,MAAA,EAAA;AAAoB,coBE9B,mBpBF8B,EAAA,CAAA,IAAA,EoBED,KpBFC,EAAA,GAAA,MAAA;AACX,coBInB,uBpBJmB,EAAA,CAAA,MAAA,EoBIgB,WpBJhB,EAAA,IAAA,EoBImC,KpBJnC,EAAA,GAAA,OAAA;;;cqBxBnB,qCAAsC,qBACzC;;;IAEiB,mBAAmB,QAAQ;;;cCRzC"}

package/dist/index.js

@@ -0,0 +1,3 @@
+import { A as SkipSuggestionDeletes, C as getSuggestionUserIdByKey, D as getInlineSuggestionData, E as isSuggestionKey, O as getSuggestionKeyId, S as getSuggestionUserId, T as isCurrentUserSuggestion, _ as getTransientSuggestionKey, a as BaseSuggestionPlugin, b as getSuggestionKey, c as removeMarkSuggestion, d as deleteFragmentSuggestion, f as deleteSuggestion, g as findInlineSuggestionNode, h as findSuggestionProps, i as acceptSuggestion, k as keyId2SuggestionId, l as insertTextSuggestion, m as addMarkSuggestion, n as rejectSuggestion, o as withSuggestion, p as setSuggestionNodes, r as getSuggestionProps, s as removeNodesSuggestion, t as diffToSuggestions, u as insertFragmentSuggestion, v as getActiveSuggestionDescriptions, w as getSuggestionUserIds, x as getSuggestionKeys, y as getSuggestionNodeEntries } from "./src-COX5sId2.js";
+
+export { BaseSuggestionPlugin, SkipSuggestionDeletes, acceptSuggestion, addMarkSuggestion, deleteFragmentSuggestion, deleteSuggestion, diffToSuggestions, findInlineSuggestionNode, findSuggestionProps, getActiveSuggestionDescriptions, getInlineSuggestionData, getSuggestionKey, getSuggestionKeyId, getSuggestionKeys, getSuggestionNodeEntries, getSuggestionProps, getSuggestionUserId, getSuggestionUserIdByKey, getSuggestionUserIds, getTransientSuggestionKey, insertFragmentSuggestion, insertTextSuggestion, isCurrentUserSuggestion, isSuggestionKey, keyId2SuggestionId, rejectSuggestion, removeMarkSuggestion, removeNodesSuggestion, setSuggestionNodes, withSuggestion };

package/dist/react/index.d.ts

@@ -0,0 +1,6 @@
+//#region src/react/SuggestionPlugin.d.ts
+/** @experimental Enables support for suggestions in the editor. */
+declare const SuggestionPlugin: any;
+//#endregion
+export { SuggestionPlugin };
+//# sourceMappingURL=index.d.ts.map

package/dist/react/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../../src/react/SuggestionPlugin.tsx"],"sourcesContent":[],"mappings":";;AAKa,cAAA,gBAAsD,EAAA,GAAA"}

package/dist/react/index.js

@@ -0,0 +1,10 @@
+import { a as BaseSuggestionPlugin } from "../src-COX5sId2.js";
+import { toPlatePlugin } from "platejs/react";
+
+//#region src/react/SuggestionPlugin.tsx
+/** @experimental Enables support for suggestions in the editor. */
+const SuggestionPlugin = toPlatePlugin(BaseSuggestionPlugin);
+
+//#endregion
+export { SuggestionPlugin };
+//# sourceMappingURL=index.js.map

package/dist/react/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["toPlatePlugin","BaseSuggestionPlugin","SuggestionPlugin"],"sources":["../../src/react/SuggestionPlugin.tsx"],"sourcesContent":["import { toPlatePlugin } from 'platejs/react';\n\nimport { BaseSuggestionPlugin } from '../lib/BaseSuggestionPlugin';\n\n/** @experimental Enables support for suggestions in the editor. */\nexport const SuggestionPlugin = toPlatePlugin(BaseSuggestionPlugin);\n"],"mappings":";;;;;AAKA,MAAaE,mBAAmBF,cAAcC,qBAAqB"}