@prosekit/extensions 0.11.0 → 0.11.2

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

@@ -4,103 +4,103 @@ import { EditorView } from "@prosekit/pm/view";
 //#region src/file/file-drop-handler.d.ts
 interface FileDropHandlerOptions {
   /**
-  * The editor view.
-  */
+   * The editor view.
+   */
   view: EditorView;
   /**
-  * The event that triggered the drop.
-  */
+   * The event that triggered the drop.
+   */
   event: DragEvent;
   /**
-  * The file that was dropped.
-  */
+   * The file that was dropped.
+   */
   file: File;
   /**
-  * The position of the document where the file was dropped.
-  */
+   * The position of the document where the file was dropped.
+   */
   pos: number;
 }
 /**
-* A function that handles one of the files in a drop event.
-*
-* Returns `true` if the file was handled and thus should not be handled by
-* other handlers.
-*/
+ * A function that handles one of the files in a drop event.
+ *
+ * Returns `true` if the file was handled and thus should not be handled by
+ * other handlers.
+ */
 type FileDropHandler = (options: FileDropHandlerOptions) => boolean | void;
 declare function defineFileDropHandler(handler: FileDropHandler): PlainExtension;
 //#endregion
 //#region src/file/file-paste-handler.d.ts
 interface FilePasteHandlerOptions {
   /**
-  * The editor view.
-  */
+   * The editor view.
+   */
   view: EditorView;
   /**
-  * The event that triggered the paste.
-  */
+   * The event that triggered the paste.
+   */
   event: ClipboardEvent;
   /**
-  * The file that was pasted.
-  */
+   * The file that was pasted.
+   */
   file: File;
 }
 /**
-* A function that handles one of the files in a paste event.
-*
-* Returns `true` if the file was handled and thus should not be handled by
-* other handlers.
-*/
+ * A function that handles one of the files in a paste event.
+ *
+ * Returns `true` if the file was handled and thus should not be handled by
+ * other handlers.
+ */
 type FilePasteHandler = (options: FilePasteHandlerOptions) => boolean | void;
 declare function defineFilePasteHandler(handler: FilePasteHandler): PlainExtension;
 //#endregion
 //#region src/file/file-upload.d.ts
 /**
-* An interface representing the upload progress.
-*/
+ * An interface representing the upload progress.
+ */
 interface UploadProgress {
   loaded: number;
   total: number;
 }
 interface UploaderOptions {
   /**
-  * The file to be uploaded.
-  */
+   * The file to be uploaded.
+   */
   file: File;
   /**
-  * A callback function that should be called with the upload progress updates.
-  */
+   * A callback function that should be called with the upload progress updates.
+   */
   onProgress: (progress: UploadProgress) => void;
 }
 /**
-* The implementation of the actual upload function. You need to implement this
-* function to upload files to your desired destination.
-*/
+ * The implementation of the actual upload function. You need to implement this
+ * function to upload files to your desired destination.
+ */
 type Uploader<Result> = (options: UploaderOptions) => Promise<Result>;
 /**
-* A class that represents a upload task.
-*/
+ * A class that represents a upload task.
+ */
 declare class UploadTask<Result> {
   /**
-  * An [object URL](https://developer.mozilla.org/en-US/docs/Web/API/URL/createObjectURL)
-  * representing the file to be uploaded. This URL will be revoked once the
-  * upload is complete successfully.
-  */
+   * An [object URL](https://developer.mozilla.org/en-US/docs/Web/API/URL/createObjectURL)
+   * representing the file to be uploaded. This URL will be revoked once the
+   * upload is complete successfully.
+   */
   readonly objectURL: string;
   /**
-  * A boolean indicating whether the upload is complete (either successfully or with an error).
-  */
+   * A boolean indicating whether the upload is complete (either successfully or with an error).
+   */
   protected done: boolean;
   /**
-  * A promise that fulfills once the upload is complete, or rejects if an error occurs.
-  */
+   * A promise that fulfills once the upload is complete, or rejects if an error occurs.
+   */
   readonly finished: Promise<Result>;
   private subscribers;
   /**
-  * Creates a new upload task. You can find the upload task by its object URL
-  * later using `UploadTask.get()`.
-  *
-  * @param options - The options for the upload task.
-  */
+   * Creates a new upload task. You can find the upload task by its object URL
+   * later using `UploadTask.get()`.
+   *
+   * @param options - The options for the upload task.
+   */
   constructor({
     file,
     uploader
@@ -109,16 +109,16 @@ declare class UploadTask<Result> {
     uploader: Uploader<Result>;
   });
   /**
-  * Subscribes to progress updates. Returns a function to unsubscribe.
-  */
+   * Subscribes to progress updates. Returns a function to unsubscribe.
+   */
   subscribeProgress(callback: (progress: UploadProgress) => void): VoidFunction;
   /**
-  * Finds an upload task by its object URL.
-  */
+   * Finds an upload task by its object URL.
+   */
   static get<Result = unknown>(objectURL: string): UploadTask<Result> | undefined;
   /**
-  * Deletes an upload task by its object URL.
-  */
+   * Deletes an upload task by its object URL.
+   */
   static delete(objectURL: string): void;
 }
 //#endregion

package/dist/prosekit-extensions-gap-cursor.d.ts

@@ -4,23 +4,23 @@ import "prosemirror-gapcursor";
 //#region src/gap-cursor/gap-cursor.d.ts
 
 /**
-* @internal
-*/
+ * @internal
+ */
 type GapCursorExtension = PlainExtension;
 /**
-* Capture clicks near and arrow-key-motion past places that don't have a
-* normally selectable position nearby, and create a gap cursor selection for
-* them. The cursor is drawn as an element with class `ProseMirror-gapcursor`.
-*
-* You can either include `prosekit/extensions/gap-cursor.css` or add your own
-* styles to make it visible.
-*
-* See
-* [prosemirror-gapcursor](https://github.com/ProseMirror/prosemirror-gapcursor)
-* for more information.
-*
-* @public
-*/
+ * Capture clicks near and arrow-key-motion past places that don't have a
+ * normally selectable position nearby, and create a gap cursor selection for
+ * them. The cursor is drawn as an element with class `ProseMirror-gapcursor`.
+ *
+ * You can either include `prosekit/extensions/gap-cursor.css` or add your own
+ * styles to make it visible.
+ *
+ * See
+ * [prosemirror-gapcursor](https://github.com/ProseMirror/prosemirror-gapcursor)
+ * for more information.
+ *
+ * @public
+ */
 declare function defineGapCursor(): GapCursorExtension;
 //#endregion
 export { type GapCursorExtension, defineGapCursor };

package/dist/prosekit-extensions-hard-break.d.ts

@@ -4,50 +4,50 @@ import { Attrs } from "@prosekit/pm/model";
 
 //#region src/hard-break/hard-break-commands.d.ts
 /**
-* @internal
-*/
+ * @internal
+ */
 type HardBreakCommandsExtension = Extension<{
   Commands: {
     insertHardBreak: [];
   };
 }>;
 /**
-* @internal
-*/
+ * @internal
+ */
 
 /**
-* @internal
-*/
+ * @internal
+ */
 declare function defineHardBreakCommands(): HardBreakCommandsExtension;
 //#endregion
 //#region src/hard-break/hard-break-spec.d.ts
 /**
-* @internal
-*/
+ * @internal
+ */
 type HardBreakSpecExtension = Extension<{
   Nodes: {
     hardBreak: Attrs;
   };
 }>;
 /**
-* @internal
-*/
+ * @internal
+ */
 declare function defineHardBreakSpec(): HardBreakSpecExtension;
 //#endregion
 //#region src/hard-break/hard-break.d.ts
 /**
-* @internal
-*/
+ * @internal
+ */
 type HardBreakExtension = Union<[HardBreakSpecExtension, HardBreakCommandsExtension]>;
 /**
-* @public
-*/
+ * @public
+ */
 declare function defineHardBreak(): HardBreakExtension;
 //#endregion
 //#region src/hard-break/hard-break-keymap.d.ts
 /**
-* @internal
-*/
+ * @internal
+ */
 declare function defineHardBreakKeymap(): PlainExtension;
 //#endregion
 export { type HardBreakCommandsExtension, type HardBreakExtension, type HardBreakSpecExtension, defineHardBreak, defineHardBreakCommands, defineHardBreakKeymap, defineHardBreakSpec };

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

@@ -7,8 +7,8 @@ interface HeadingAttrs {
 //#endregion
 //#region src/heading/heading-commands.d.ts
 /**
-* @internal
-*/
+ * @internal
+ */
 type HeadingCommandsExtension = Extension<{
   Commands: {
     setHeading: [attrs?: HeadingAttrs | undefined];
@@ -17,47 +17,47 @@ type HeadingCommandsExtension = Extension<{
   };
 }>;
 /**
-* @internal
-*/
+ * @internal
+ */
 declare function defineHeadingCommands(): HeadingCommandsExtension;
 //#endregion
 //#region src/heading/heading-spec.d.ts
 /**
-* @internal
-*/
+ * @internal
+ */
 type HeadingSpecExtension = Extension<{
   Nodes: {
     heading: HeadingAttrs;
   };
 }>;
 /**
-* @internal
-*/
+ * @internal
+ */
 declare function defineHeadingSpec(): HeadingSpecExtension;
 //#endregion
 //#region src/heading/heading.d.ts
 /**
-* @internal
-*/
+ * @internal
+ */
 type HeadingExtension = Union<[HeadingSpecExtension, HeadingCommandsExtension]>;
 /**
-* @public
-*/
+ * @public
+ */
 declare function defineHeading(): HeadingExtension;
 //#endregion
 //#region src/heading/heading-input-rule.d.ts
 /**
-* Converts the text block to a heading when `#` is typed at the start of a new
-* line followed by a space.
-*
-* @internal
-*/
+ * Converts the text block to a heading when `#` is typed at the start of a new
+ * line followed by a space.
+ *
+ * @internal
+ */
 declare function defineHeadingInputRule(): PlainExtension;
 //#endregion
 //#region src/heading/heading-keymap.d.ts
 /**
-* @internal
-*/
+ * @internal
+ */
 declare function defineHeadingKeymap(): PlainExtension;
 //#endregion
 export { type HeadingAttrs, type HeadingCommandsExtension, type HeadingExtension, type HeadingSpecExtension, defineHeading, defineHeadingCommands, defineHeadingInputRule, defineHeadingKeymap, defineHeadingSpec };

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

@@ -9,8 +9,8 @@ type HorizontalRuleCommandsExtension = Extension<{
   };
 }>;
 /**
-* Returns a command that inserts a horizontal rule at the current selection.
-*/
+ * Returns a command that inserts a horizontal rule at the current selection.
+ */
 declare function insertHorizontalRule(): Command;
 declare function defineHorizontalRuleCommands(): HorizontalRuleCommandsExtension;
 //#endregion
@@ -25,14 +25,14 @@ declare function defineHorizontalRuleSpec(): HorizontalRuleSpecExtension;
 //#region src/horizontal-rule/horizontal-rule.d.ts
 type HorizontalRuleExtension = Union<[HorizontalRuleSpecExtension, HorizontalRuleCommandsExtension]>;
 /**
-* @public
-*/
+ * @public
+ */
 declare function defineHorizontalRule(): HorizontalRuleExtension;
 //#endregion
 //#region src/horizontal-rule/horizontal-rule-input-rule.d.ts
 /**
-* @public
-*/
+ * @public
+ */
 declare function defineHorizontalRuleInputRule(): PlainExtension;
 //#endregion
 export { type HorizontalRuleCommandsExtension, type HorizontalRuleExtension, type HorizontalRuleSpecExtension, defineHorizontalRule, defineHorizontalRuleCommands, defineHorizontalRuleInputRule, defineHorizontalRuleSpec, insertHorizontalRule };

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

@@ -3,48 +3,48 @@ import { Extension, Union } from "@prosekit/core";
 //#region src/image/image-spec.d.ts
 
 /**
-* @public
-*/
+ * @public
+ */
 interface ImageAttrs {
   src?: string | null;
   width?: number | null;
   height?: number | null;
 }
 /**
-* @internal
-*/
+ * @internal
+ */
 type ImageSpecExtension = Extension<{
   Nodes: {
     image: ImageAttrs;
   };
 }>;
 /**
-* @internal
-*/
+ * @internal
+ */
 declare function defineImageSpec(): ImageSpecExtension;
 //#endregion
 //#region src/image/image-commands.d.ts
 /**
-* @internal
-*/
+ * @internal
+ */
 type ImageCommandsExtension = Extension<{
   Commands: {
     insertImage: [attrs?: ImageAttrs];
   };
 }>;
 /**
-* @internal
-*/
+ * @internal
+ */
 declare function defineImageCommands(): ImageCommandsExtension;
 //#endregion
 //#region src/image/image.d.ts
 /**
-* @internal
-*/
+ * @internal
+ */
 type ImageExtension = Union<[ImageSpecExtension, ImageCommandsExtension]>;
 /**
-* @public
-*/
+ * @public
+ */
 declare function defineImage(): ImageExtension;
 //#endregion
 export { type ImageAttrs, type ImageCommandsExtension, type ImageExtension, type ImageSpecExtension, defineImage, defineImageCommands, defineImageSpec };

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

@@ -5,43 +5,43 @@ import { Attrs, MarkType, NodeType, ProseMirrorNode } from "@prosekit/pm/model";
 //#region src/input-rule/index.d.ts
 
 /**
-* Defines an input rule extension.
-*
-* @param rule - The ProseMirror input rule to add.
-*
-* @public
-*/
+ * Defines an input rule extension.
+ *
+ * @param rule - The ProseMirror input rule to add.
+ *
+ * @public
+ */
 declare function defineInputRule(rule: InputRule): PlainExtension;
 /**
-* Options for {@link defineMarkInputRule}.
-*
-* @public
-*/
+ * Options for {@link defineMarkInputRule}.
+ *
+ * @public
+ */
 interface MarkInputRuleOptions {
   /**
-  * The regular expression to match against, which should end with `$` and has
-  * exactly one capture group. All other matched text outside the capture group
-  * will be deleted.
-  */
+   * The regular expression to match against, which should end with `$` and has
+   * exactly one capture group. All other matched text outside the capture group
+   * will be deleted.
+   */
   regex: RegExp;
   /**
-  * The type of mark to set.
-  */
+   * The type of mark to set.
+   */
   type: string | MarkType;
   /**
-  * Attributes to set on the mark.
-  */
+   * Attributes to set on the mark.
+   */
   attrs?: Attrs | null | ((match: RegExpMatchArray) => Attrs | null);
   /**
-  * Whether this rule should fire inside marks marked as [code](https://prosemirror.net/docs/ref/#model.MarkSpec.code).
-  *
-  * @default `false`
-  */
+   * Whether this rule should fire inside marks marked as [code](https://prosemirror.net/docs/ref/#model.MarkSpec.code).
+   *
+   * @default `false`
+   */
   inCodeMark?: boolean;
 }
 /**
-* @internal
-*/
+ * @internal
+ */
 declare function createMarkInputRule({
   regex,
   type,
@@ -49,52 +49,52 @@ declare function createMarkInputRule({
   inCodeMark
 }: MarkInputRuleOptions): InputRule;
 /**
-* Defines an input rule for automatically adding inline marks when a given
-* pattern is typed.
-*
-* @public
-*/
+ * Defines an input rule for automatically adding inline marks when a given
+ * pattern is typed.
+ *
+ * @public
+ */
 declare function defineMarkInputRule(options: MarkInputRuleOptions): PlainExtension;
 /**
-* Defines an input rule that changes the type of a textblock when the matched
-* text is typed into it.
-*
-* See also [textblockTypeInputRule](https://prosemirror.net/docs/ref/#inputrules.textblockTypeInputRule)
-*
-* @param options
-*
-* @public
-*/
+ * Defines an input rule that changes the type of a textblock when the matched
+ * text is typed into it.
+ *
+ * See also [textblockTypeInputRule](https://prosemirror.net/docs/ref/#inputrules.textblockTypeInputRule)
+ *
+ * @param options
+ *
+ * @public
+ */
 declare function defineTextBlockInputRule({
   regex,
   type,
   attrs
 }: {
   /**
-  * The regular expression to match against, which should end with `$`. It
-  * usually also starts with `^` to that it is only matched at the start of a
-  * textblock.
-  */
+   * The regular expression to match against, which should end with `$`. It
+   * usually also starts with `^` to that it is only matched at the start of a
+   * textblock.
+   */
   regex: RegExp;
   /**
-  * The node type to replace the matched text with.
-  */
+   * The node type to replace the matched text with.
+   */
   type: string | NodeType;
   /**
-  * Attributes to set on the node.
-  */
+   * Attributes to set on the node.
+   */
   attrs?: Attrs | null | ((match: RegExpMatchArray) => Attrs | null);
 }): PlainExtension;
 /**
-* Defines an input rule for automatically wrapping a textblock when a given
-* string is typed.
-*
-* See also [wrappingInputRule](https://prosemirror.net/docs/ref/#inputrules.wrappingInputRule)
-*
-* @param options
-*
-* @public
-*/
+ * Defines an input rule for automatically wrapping a textblock when a given
+ * string is typed.
+ *
+ * See also [wrappingInputRule](https://prosemirror.net/docs/ref/#inputrules.wrappingInputRule)
+ *
+ * @param options
+ *
+ * @public
+ */
 declare function defineWrappingInputRule({
   regex,
   type,
@@ -102,27 +102,27 @@ declare function defineWrappingInputRule({
   join
 }: {
   /**
-  * The regular expression to match against, which should end with `$`. It
-  * usually also starts with `^` to that it is only matched at the start of a
-  * textblock.
-  */
+   * The regular expression to match against, which should end with `$`. It
+   * usually also starts with `^` to that it is only matched at the start of a
+   * textblock.
+   */
   regex: RegExp;
   /**
-  * The type of node to wrap in.
-  */
+   * The type of node to wrap in.
+   */
   type: string | NodeType;
   /**
-  * Attributes to set on the node.
-  */
+   * Attributes to set on the node.
+   */
   attrs?: Attrs | null | ((match: RegExpMatchArray) => Attrs | null);
   /**
-  * By default, if there's a node with the same type above the newly wrapped
-  * node, the rule will try to
-  * [join](https://prosemirror.net/docs/ref/#transform.Transform.join) those
-  * two nodes. You can pass a join predicate, which takes a regular expression
-  * match and the node before the wrapped node, and can return a boolean to
-  * indicate whether a join should happen.
-  */
+   * By default, if there's a node with the same type above the newly wrapped
+   * node, the rule will try to
+   * [join](https://prosemirror.net/docs/ref/#transform.Transform.join) those
+   * two nodes. You can pass a join predicate, which takes a regular expression
+   * match and the node before the wrapped node, and can return a boolean to
+   * indicate whether a join should happen.
+   */
   join?: (match: RegExpMatchArray, node: ProseMirrorNode) => boolean;
 }): PlainExtension;
 //#endregion