Merge pull request #3837 from yf-yang/decoratetype

feat: add DecoratedRange/TDecoratedRange types
udecode · Dec 9, 2024 · 06f6cac · 06f6cac
2 parents d649052 + 7eab6df
commit 06f6cac
Show file tree

Hide file tree

Showing 73 changed files with 155 additions and 189 deletions.
diff --git a/.changeset/twenty-mayflies-fry.md b/.changeset/twenty-mayflies-fry.md
@@ -0,0 +1,6 @@
+---
+'@udecode/slate': patch
+'@udecode/plate-core': patch
+---
+
+feat: Change Decorate's return type to DecoratedRange/TDecoratedRange
diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml
@@ -42,7 +42,7 @@ body:
     attributes:
       label: "Slate React version"
       description: Please give the version of slate-react
-      placeholder: ex. 0.103.0
+      placeholder: ex. 0.112.0
     validations:
       required: true
   - type: textarea

diff --git a/apps/www/package.json b/apps/www/package.json
@@ -170,7 +170,7 @@
     "react-wrap-balancer": "^1.1.1",
     "remark-emoji": "5.0.1",
     "sass": "^1.78.0",
-    "slate": "0.110.2",
+    "slate": "0.112.0",
     "slate-dom": "0.111.0",
     "slate-history": "0.110.3",
     "slate-hyperscript": "0.100.0",

diff --git a/package.json b/package.json
@@ -148,7 +148,7 @@
     "react-test-renderer": "18.3.1",
     "rimraf": "^6.0.1",
     "shadcx": "workspace:^",
-    "slate": "0.110.2",
+    "slate": "0.112.0",
     "slate-dom": "0.111.0",
     "slate-history": "0.110.3",
     "slate-hyperscript": "0.100.0",

diff --git a/packages/ai/package.json b/packages/ai/package.json
@@ -62,7 +62,7 @@
     "@udecode/plate-common": ">=40.0.0",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
-    "slate": ">=0.103.0",
+    "slate": ">=0.112.0",
     "slate-dom": ">=0.111.0",
     "slate-history": ">=0.93.0",
     "slate-hyperscript": ">=0.66.0",

diff --git a/packages/alignment/package.json b/packages/alignment/package.json
@@ -56,7 +56,7 @@
     "@udecode/plate-common": ">=40.2.8",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
-    "slate": ">=0.103.0",
+    "slate": ">=0.112.0",
     "slate-dom": ">=0.111.0",
     "slate-history": ">=0.93.0",
     "slate-hyperscript": ">=0.66.0",

diff --git a/packages/autoformat/package.json b/packages/autoformat/package.json
@@ -59,7 +59,7 @@
     "@udecode/plate-common": ">=40.2.8",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
-    "slate": ">=0.103.0",
+    "slate": ">=0.112.0",
     "slate-dom": ">=0.111.0",
     "slate-history": ">=0.93.0",
     "slate-hyperscript": ">=0.66.0",

diff --git a/packages/basic-elements/package.json b/packages/basic-elements/package.json
@@ -61,7 +61,7 @@
     "@udecode/plate-common": ">=40.2.8",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
-    "slate": ">=0.103.0",
+    "slate": ">=0.112.0",
     "slate-dom": ">=0.111.0",
     "slate-history": ">=0.93.0",
     "slate-hyperscript": ">=0.66.0",

diff --git a/packages/basic-marks/package.json b/packages/basic-marks/package.json
@@ -55,7 +55,7 @@
     "@udecode/plate-common": ">=40.2.8",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
-    "slate": ">=0.103.0",
+    "slate": ">=0.112.0",
     "slate-dom": ">=0.111.0",
     "slate-history": ">=0.93.0",
     "slate-hyperscript": ">=0.66.0",

diff --git a/packages/block-quote/package.json b/packages/block-quote/package.json
@@ -56,7 +56,7 @@
     "@udecode/plate-common": ">=40.2.8",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
-    "slate": ">=0.103.0",
+    "slate": ">=0.112.0",
     "slate-dom": ">=0.111.0",
     "slate-history": ">=0.93.0",
     "slate-hyperscript": ">=0.66.0",

diff --git a/packages/break/package.json b/packages/break/package.json
@@ -56,7 +56,7 @@
     "@udecode/plate-common": ">=40.2.8",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
-    "slate": ">=0.103.0",
+    "slate": ">=0.112.0",
     "slate-dom": ">=0.111.0",
     "slate-history": ">=0.93.0",
     "slate-hyperscript": ">=0.66.0",

diff --git a/packages/callout/package.json b/packages/callout/package.json
@@ -56,7 +56,7 @@
     "@udecode/plate-common": ">=40.2.8",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
-    "slate": ">=0.103.0",
+    "slate": ">=0.112.0",
     "slate-dom": ">=0.111.0",
     "slate-history": ">=0.93.0",
     "slate-hyperscript": ">=0.66.0",

diff --git a/packages/caption/package.json b/packages/caption/package.json
@@ -58,7 +58,7 @@
     "@udecode/plate-common": ">=40.2.8",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
-    "slate": ">=0.103.0",
+    "slate": ">=0.112.0",
     "slate-dom": ">=0.111.0",
     "slate-history": ">=0.93.0",
     "slate-hyperscript": ">=0.66.0",

diff --git a/packages/cloud/package.json b/packages/cloud/package.json
@@ -55,7 +55,7 @@
     "@udecode/plate-common": ">=40.2.8",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
-    "slate": ">=0.103.0",
+    "slate": ">=0.112.0",
     "slate-dom": ">=0.111.0",
     "slate-history": ">=0.93.0",
     "slate-hyperscript": ">=0.66.0",

diff --git a/packages/code-block/package.json b/packages/code-block/package.json
@@ -57,7 +57,7 @@
     "@udecode/plate-common": ">=40.2.8",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
-    "slate": ">=0.103.0",
+    "slate": ">=0.112.0",
     "slate-dom": ">=0.111.0",
     "slate-history": ">=0.93.0",
     "slate-hyperscript": ">=0.66.0",

diff --git a/packages/combobox/package.json b/packages/combobox/package.json
@@ -56,7 +56,7 @@
     "@udecode/plate-common": ">=40.2.8",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
-    "slate": ">=0.103.0",
+    "slate": ">=0.112.0",
     "slate-dom": ">=0.111.0",
     "slate-history": ">=0.93.0",
     "slate-hyperscript": ">=0.66.0",

diff --git a/packages/comments/package.json b/packages/comments/package.json
@@ -59,7 +59,7 @@
     "@udecode/plate-common": ">=40.2.8",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
-    "slate": ">=0.103.0",
+    "slate": ">=0.112.0",
     "slate-dom": ">=0.111.0",
     "slate-history": ">=0.93.0",
     "slate-hyperscript": ">=0.66.0",

diff --git a/packages/common/package.json b/packages/common/package.json
@@ -62,7 +62,7 @@
   "peerDependencies": {
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
-    "slate": ">=0.103.0",
+    "slate": ">=0.112.0",
     "slate-dom": ">=0.111.0",
     "slate-history": ">=0.93.0",
     "slate-hyperscript": ">=0.66.0",

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -77,7 +77,7 @@
   "peerDependencies": {
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
-    "slate": ">=0.103.0",
+    "slate": ">=0.112.0",
     "slate-dom": ">=0.111.0",
     "slate-history": ">=0.93.0",
     "slate-hyperscript": ">=0.66.0",

diff --git a/packages/core/src/lib/plugin/SlatePlugin.ts b/packages/core/src/lib/plugin/SlatePlugin.ts
@@ -1,6 +1,6 @@
 import type { TDescendant, TNodeEntry, Value } from '@udecode/slate';
 import type { AnyObject } from '@udecode/utils';
-import type { Range } from 'slate';
+import type { DecoratedRange } from 'slate';
 
 import type { SlateEditor } from '../editor';
 import type { Nullable } from '../types/misc';
@@ -393,7 +393,7 @@ export type HtmlSerializer<C extends AnyPluginConfig = PluginConfig> =
  */
 export type Decorate<C extends AnyPluginConfig = PluginConfig> = (
   ctx: SlatePluginContext<C> & { entry: TNodeEntry }
-) => Range[] | undefined;
+) => DecoratedRange[] | undefined;
 
 export type InjectNodeProps<C extends AnyPluginConfig = PluginConfig> =
   BaseInjectProps & {

diff --git a/packages/core/src/react/plugin/PlatePlugin.ts b/packages/core/src/react/plugin/PlatePlugin.ts
@@ -6,10 +6,10 @@ import type {
   Keys,
 } from '@udecode/react-hotkeys';
 import type {
+  TDecoratedRange,
   TDescendant,
   TElement,
   TNodeEntry,
-  TRange,
   TText,
   Value,
 } from '@udecode/slate';
@@ -657,7 +657,7 @@ export type HtmlReactSerializer<C extends AnyPluginConfig = PluginConfig> = {
  */
 export type Decorate<C extends AnyPluginConfig = PluginConfig> = (
   ctx: PlatePluginContext<C> & { entry: TNodeEntry }
-) => TRange[] | undefined;
+) => TDecoratedRange[] | undefined;
 
 /** Properties used by Plate to inject props into any {@link NodeComponent}. */
 export type InjectNodeProps<C extends AnyPluginConfig = PluginConfig> =

diff --git a/packages/csv/package.json b/packages/csv/package.json
@@ -57,7 +57,7 @@
     "@udecode/plate-common": ">=40.2.8",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
-    "slate": ">=0.103.0",
+    "slate": ">=0.112.0",
     "slate-dom": ">=0.111.0",
     "slate-history": ">=0.93.0",
     "slate-hyperscript": ">=0.66.0",

diff --git a/packages/cursor/package.json b/packages/cursor/package.json
@@ -50,7 +50,7 @@
     "@udecode/plate-common": ">=40.2.8",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
-    "slate": ">=0.103.0",
+    "slate": ">=0.112.0",
     "slate-dom": ">=0.111.0",
     "slate-history": ">=0.93.0",
     "slate-hyperscript": ">=0.66.0",

diff --git a/packages/diff/package.json b/packages/diff/package.json
@@ -53,7 +53,7 @@
     "@udecode/plate-common": ">=40.2.8",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
-    "slate": ">=0.103.0",
+    "slate": ">=0.112.0",
     "slate-dom": ">=0.111.0",
     "slate-history": ">=0.93.0",
     "slate-hyperscript": ">=0.66.0",

diff --git a/packages/dnd/package.json b/packages/dnd/package.json
@@ -56,7 +56,7 @@
     "react-dnd": ">=14.0.0",
     "react-dnd-html5-backend": ">=14.0.0",
     "react-dom": ">=16.8.0",
-    "slate": ">=0.103.0",
+    "slate": ">=0.112.0",
     "slate-dom": ">=0.111.0",
     "slate-history": ">=0.93.0",
     "slate-hyperscript": ">=0.66.0",

diff --git a/packages/docx/package.json b/packages/docx/package.json
@@ -60,7 +60,7 @@
     "@udecode/plate-common": ">=40.2.8",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
-    "slate": ">=0.103.0",
+    "slate": ">=0.112.0",
     "slate-dom": ">=0.111.0",
     "slate-history": ">=0.93.0",
     "slate-hyperscript": ">=0.66.0",

diff --git a/packages/emoji/package.json b/packages/emoji/package.json
@@ -60,7 +60,7 @@
     "@udecode/plate-common": ">=40.2.8",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
-    "slate": ">=0.103.0",
+    "slate": ">=0.112.0",
     "slate-dom": ">=0.111.0",
     "slate-history": ">=0.93.0",
     "slate-hyperscript": ">=0.66.0",

diff --git a/packages/excalidraw/package.json b/packages/excalidraw/package.json
@@ -59,7 +59,7 @@
     "@udecode/plate-common": ">=40.2.8",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
-    "slate": ">=0.103.0",
+    "slate": ">=0.112.0",
     "slate-dom": ">=0.111.0",
     "slate-history": ">=0.93.0",
     "slate-hyperscript": ">=0.66.0",

diff --git a/packages/find-replace/package.json b/packages/find-replace/package.json
@@ -50,7 +50,7 @@
     "@udecode/plate-common": ">=40.2.8",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
-    "slate": ">=0.103.0",
+    "slate": ">=0.112.0",
     "slate-dom": ">=0.111.0",
     "slate-history": ">=0.93.0",
     "slate-hyperscript": ">=0.66.0",

diff --git a/packages/floating/package.json b/packages/floating/package.json
@@ -54,7 +54,7 @@
     "@udecode/plate-common": ">=40.2.8",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
-    "slate": ">=0.103.0",
+    "slate": ">=0.112.0",
     "slate-dom": ">=0.111.0",
     "slate-history": ">=0.93.0",
     "slate-hyperscript": ">=0.66.0",

diff --git a/packages/font/package.json b/packages/font/package.json
@@ -59,7 +59,7 @@
     "@udecode/plate-common": ">=40.2.8",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
-    "slate": ">=0.103.0",
+    "slate": ">=0.112.0",
     "slate-dom": ">=0.111.0",
     "slate-history": ">=0.93.0",
     "slate-hyperscript": ">=0.66.0",

diff --git a/packages/heading/package.json b/packages/heading/package.json
@@ -56,7 +56,7 @@
     "@udecode/plate-common": ">=40.2.8",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
-    "slate": ">=0.103.0",
+    "slate": ">=0.112.0",
     "slate-dom": ">=0.111.0",
     "slate-history": ">=0.93.0",
     "slate-hyperscript": ">=0.66.0",

diff --git a/packages/highlight/package.json b/packages/highlight/package.json
@@ -56,7 +56,7 @@
     "@udecode/plate-common": ">=40.2.8",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
-    "slate": ">=0.103.0",
+    "slate": ">=0.112.0",
     "slate-dom": ">=0.111.0",
     "slate-history": ">=0.93.0",
     "slate-hyperscript": ">=0.66.0",

diff --git a/packages/horizontal-rule/package.json b/packages/horizontal-rule/package.json
@@ -56,7 +56,7 @@
     "@udecode/plate-common": ">=40.2.8",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
-    "slate": ">=0.103.0",
+    "slate": ">=0.112.0",
     "slate-dom": ">=0.111.0",
     "slate-history": ">=0.93.0",
     "slate-hyperscript": ">=0.66.0",

diff --git a/packages/html/package.json b/packages/html/package.json
@@ -62,7 +62,7 @@
     "@udecode/plate-common": ">=40.2.8",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
-    "slate": ">=0.103.0",
+    "slate": ">=0.112.0",
     "slate-dom": ">=0.111.0",
     "slate-history": ">=0.93.0",
     "slate-hyperscript": ">=0.66.0",

diff --git a/packages/indent-list/package.json b/packages/indent-list/package.json
@@ -61,7 +61,7 @@
     "@udecode/plate-common": ">=40.2.8",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
-    "slate": ">=0.103.0",
+    "slate": ">=0.112.0",
     "slate-dom": ">=0.111.0",
     "slate-history": ">=0.93.0",
     "slate-hyperscript": ">=0.66.0",

diff --git a/packages/indent/package.json b/packages/indent/package.json
@@ -56,7 +56,7 @@
     "@udecode/plate-common": ">=40.2.8",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
-    "slate": ">=0.103.0",
+    "slate": ">=0.112.0",
     "slate-dom": ">=0.111.0",
     "slate-history": ">=0.93.0",
     "slate-hyperscript": ">=0.66.0",

diff --git a/packages/juice/package.json b/packages/juice/package.json
@@ -53,7 +53,7 @@
     "@udecode/plate-common": ">=40.2.8",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
-    "slate": ">=0.103.0",
+    "slate": ">=0.112.0",
     "slate-dom": ">=0.111.0",
     "slate-history": ">=0.93.0",
     "slate-hyperscript": ">=0.66.0",

diff --git a/packages/kbd/package.json b/packages/kbd/package.json
@@ -56,7 +56,7 @@
     "@udecode/plate-common": ">=40.2.8",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
-    "slate": ">=0.103.0",
+    "slate": ">=0.112.0",
     "slate-dom": ">=0.111.0",
     "slate-history": ">=0.93.0",
     "slate-hyperscript": ">=0.66.0",

diff --git a/packages/layout/package.json b/packages/layout/package.json
@@ -56,7 +56,7 @@
     "@udecode/plate-common": ">=40.2.8",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
-    "slate": ">=0.103.0",
+    "slate": ">=0.112.0",
     "slate-dom": ">=0.111.0",
     "slate-history": ">=0.93.0",
     "slate-hyperscript": ">=0.66.0",

diff --git a/packages/line-height/package.json b/packages/line-height/package.json
@@ -56,7 +56,7 @@
     "@udecode/plate-common": ">=40.2.8",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
-    "slate": ">=0.103.0",
+    "slate": ">=0.112.0",
     "slate-dom": ">=0.111.0",
     "slate-history": ">=0.93.0",
     "slate-hyperscript": ">=0.66.0",

diff --git a/packages/link/package.json b/packages/link/package.json
@@ -60,7 +60,7 @@
     "@udecode/plate-common": ">=40.2.8",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
-    "slate": ">=0.103.0",
+    "slate": ">=0.112.0",
     "slate-dom": ">=0.111.0",
     "slate-history": ">=0.93.0",
     "slate-hyperscript": ">=0.66.0",