@prosekit/extensions 0.9.2 → 0.9.3

package/dist/prosekit-extensions-autocomplete.d.ts

@@ -2,32 +2,93 @@ import { Extension } from "@prosekit/core";
 import { EditorState } from "@prosekit/pm/state";
 
 //#region src/autocomplete/autocomplete-rule.d.ts
-type MatchHandler = (options: {
+/**
+* Options for the {@link MatchHandler} callback.
+*/
+interface MatchHandlerOptions {
+  /**
+  * The editor state.
+  */
   state: EditorState;
+  /**
+  * The result of `RegExp.exec`.
+  */
   match: RegExpExecArray;
+  /**
+  * The start position of the matched text.
+  */
   from: number;
+  /**
+  * The end position of the matched text.
+  */
   to: number;
+  /**
+  * Call this function to ignore the match. You probably want to call this
+  * function when the user presses the `Escape` key.
+  */
   ignoreMatch: () => void;
+  /**
+  * Call this function to delete the matched text. For example, in a slash
+  * menu, you might want to delete the matched text first then do something
+  * else when the user presses the `Enter` key.
+  */
   deleteMatch: () => void;
-}) => void;
+}
+/**
+* A callback that is called when the rule starts to match, and also on
+* subsequent updates while the rule continues to match.
+*/
+type MatchHandler = (options: MatchHandlerOptions) => void;
+/**
+* Options for creating an {@link AutocompleteRule}
+*/
+interface AutocompleteRuleOptions {
+  /**
+  * The regular expression to match against the text before the cursor. The
+  * last match before the cursor is used.
+  *
+  * For a slash menu, you might use `/\/(|\S.*)$/u`.
+  * For a mention, you might use `/@\w*$/`
+  */
+  regex: RegExp;
+  /**
+  * A callback that is called when the rule starts to match, and also on
+  * subsequent updates while the rule continues to match.
+  */
+  onEnter: MatchHandler;
+  /**
+  * A callback that is called when the rule stops matching.
+  */
+  onLeave?: VoidFunction;
+  /**
+  * A predicate to determine if the rule can be applied in the current editor
+  * state. If not provided, it defaults to only allowing matches in empty
+  * selections that are not inside a code block or code mark.
+  */
+  canMatch?: (options: {
+    state: EditorState;
+  }) => boolean;
+}
+/**
+* An autocomplete rule that can be used to create an autocomplete extension.
+*
+* @public
+*/
 declare class AutocompleteRule {
+  /** @internal */
   readonly regex: RegExp;
+  /** @internal */
   readonly onMatch: MatchHandler;
+  /** @internal */
   readonly onLeave?: VoidFunction;
+  /** @internal */
   readonly canMatch: (options: {
     state: EditorState;
   }) => boolean;
-  constructor(options: {
-    regex: RegExp;
-    onEnter: MatchHandler;
-    onLeave?: VoidFunction;
-    canMatch?: (options: {
-      state: EditorState;
-    }) => boolean;
-  });
+  constructor(options: AutocompleteRuleOptions);
 }
 //#endregion
 //#region src/autocomplete/autocomplete.d.ts
 declare function defineAutocomplete(rule: AutocompleteRule): Extension;
 //#endregion
-export { AutocompleteRule, MatchHandler, defineAutocomplete };
+export { AutocompleteRule, AutocompleteRuleOptions, MatchHandler, MatchHandlerOptions, defineAutocomplete };

package/dist/prosekit-extensions-autocomplete.js

@@ -130,10 +130,19 @@ const autocompleteFacet = defineFacet({
 
 //#endregion
 //#region src/autocomplete/autocomplete-rule.ts
+/**
+* An autocomplete rule that can be used to create an autocomplete extension.
+*
+* @public
+*/
 var AutocompleteRule = class {
+	/** @internal */
 	regex;
+	/** @internal */
 	onMatch;
+	/** @internal */
 	onLeave;
+	/** @internal */
 	canMatch;
 	constructor(options) {
 		this.regex = options.regex;

package/dist/prosekit-extensions-enter-rule.d.ts

@@ -6,8 +6,10 @@ import { Attrs, NodeType } from "@prosekit/pm/model";
 
 /**
 * @public
+*
+* Options for {@link EnterRuleHandler}.
 */
-type EnterRuleHandler = (options: {
+interface EnterRuleHandlerOptions {
   /**
   * The current editor state.
   */
@@ -24,7 +26,11 @@ type EnterRuleHandler = (options: {
   * The matched result from the regular expression.
   */
   match: RegExpExecArray;
-}) => Transaction | null;
+}
+/**
+* @public
+*/
+type EnterRuleHandler = (options: EnterRuleHandlerOptions) => Transaction | null;
 /**
 * Options for {@link defineEnterRule}.
 *
@@ -51,7 +57,7 @@ type EnterRuleOptions = {
 *
 * @public
 */
-type TextBlockEnterRuleOptions = {
+interface TextBlockEnterRuleOptions {
   /**
   * The regular expression to match against. It should end with `$`.
   */
@@ -71,7 +77,7 @@ type TextBlockEnterRuleOptions = {
   * @default true
   */
   stop?: boolean;
-};
+}
 /**
 * Defines an enter rule. An enter rule applies when the text directly in front of
 * the cursor matches `regex` and user presses Enter. The `regex` should end
@@ -102,4 +108,4 @@ declare function defineTextBlockEnterRule({
   stop
 }: TextBlockEnterRuleOptions): PlainExtension;
 //#endregion
-export { EnterRuleHandler, EnterRuleOptions, TextBlockEnterRuleOptions, defineEnterRule, defineTextBlockEnterRule };
+export { EnterRuleHandler, EnterRuleHandlerOptions, EnterRuleOptions, TextBlockEnterRuleOptions, defineEnterRule, defineTextBlockEnterRule };

package/dist/prosekit-extensions-link.d.ts

@@ -7,6 +7,8 @@ import { Extension, PlainExtension, Union } from "@prosekit/core";
 */
 interface LinkAttrs {
   href: string;
+  target?: string | null;
+  rel?: string | null;
 }
 /**
 * @internal

package/dist/prosekit-extensions-link.js

@@ -26,18 +26,36 @@ function defineLinkSpec() {
 	return defineMarkSpec({
 		name: "link",
 		inclusive: false,
-		attrs: { href: { validate: "string" } },
+		attrs: {
+			href: { validate: "string" },
+			target: {
+				default: null,
+				validate: "string|null"
+			},
+			rel: {
+				default: null,
+				validate: "string|null"
+			}
+		},
 		parseDOM: [{
 			tag: "a[href]",
 			getAttrs: (dom) => {
-				return { href: dom.getAttribute("href") || "" };
+				return {
+					href: dom.getAttribute("href") || "",
+					target: dom.getAttribute("target") || null,
+					rel: dom.getAttribute("rel") || null
+				};
 			}
 		}],
 		toDOM(node) {
-			const { href } = node.attrs;
+			const { href, target, rel } = node.attrs;
 			return [
 				"a",
-				{ href },
+				{
+					href,
+					target,
+					rel
+				},
 				0
 			];
 		}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@prosekit/extensions",
   "type": "module",
-  "version": "0.9.2",
+  "version": "0.9.3",
   "private": false,
   "description": "A collection of common extensions for ProseKit",
   "author": {
@@ -207,8 +207,8 @@
     "prosemirror-search": "^1.1.0",
     "prosemirror-tables": "^1.7.1",
     "shiki": "^3.6.0",
-    "@prosekit/pm": "^0.1.11",
-    "@prosekit/core": "^0.8.2"
+    "@prosekit/core": "^0.8.2",
+    "@prosekit/pm": "^0.1.11"
   },
   "peerDependencies": {
     "loro-crdt": ">= 0.16.7",