@remirror/core-extensions - npm Package Compare versions

Comparing version 0.4.2-canary.0 to 0.4.2-canary.1

lib/core-extensions.d.ts

@@ -1,2 +0,4 @@
-import { PrioritizedExtension } from '@remirror/core';
+import { DocExtension, PrioritizedExtension, TextExtension } from '@remirror/core';
+import { BaseKeymapExtension, CompositionExtension, DropCursorExtension, GapCursorExtension, HistoryExtension } from './extensions';
+import { ParagraphExtension } from './nodes';
 /**
@@ -9,2 +11,8 @@ * Base extensions are automatically injected into the default RemirrorEditor.
 export declare const baseExtensions: PrioritizedExtension[];
+/**
+ * The BaseExtensions union type shows the extension provided by default in a remirror editor.
+ * This union is useful for extending with your own types to provide better typechecking
+ * throughout your codebase
+ */
+export declare type BaseExtensions = DocExtension | TextExtension | ParagraphExtension | CompositionExtension | HistoryExtension | GapCursorExtension | DropCursorExtension | BaseKeymapExtension;
 //# sourceMappingURL=core-extensions.d.ts.map

lib/core-extensions.js

@@ -45,3 +45,9 @@ "use strict";
 }];
+/**
+ * The BaseExtensions union type shows the extension provided by default in a remirror editor.
+ * This union is useful for extending with your own types to provide better typechecking
+ * throughout your codebase
+ */
+
 exports.baseExtensions = baseExtensions;
 //# sourceMappingURL=core-extensions.js.map

lib/extensions/composition/composition-plugin.d.ts

@@ -16,3 +16,3 @@ import { Extension } from '@remirror/core';
  */
-export declare const createCompositionPlugin: (ctx: Extension<CompositionExtensionOptions, string, import("@remirror/core").PlainObject, never>) => Plugin<any, any>;
+export declare const createCompositionPlugin: (ctx: Extension<CompositionExtensionOptions, never>) => Plugin<any, any>;
 /**
@@ -19,0 +19,0 @@ * Borrowed from https://bitbucket.org/atlassian/atlaskit-mk-2/src/14c0461025a93936d83117ccdd5b34e3623b7a16/packages/editor/editor-core/src/plugins/composition/events/deleteContentBackward.ts?at=master&fileviewer=file-view-default

lib/extensions/history-extension.d.ts

@@ -1,2 +0,2 @@
-import { BaseExtensionOptions, BooleanExtensionCheck, CommandFunction, Extension, ExtensionManagerParams } from '@remirror/core';
+import { BaseExtensionOptions, CommandFunction, Extension, ExtensionManagerParams } from '@remirror/core';
 import { redo, undo } from 'prosemirror-history';
@@ -20,3 +20,2 @@ export interface HistoryExtensionOptions extends BaseExtensionOptions {
 }
-declare type HistoryExtensionCommands = 'undo' | 'redo';
 /**
@@ -28,3 +27,3 @@ * This extension provides undo and redo commands and inserts a plugin which
  */
-export declare class HistoryExtension extends Extension<HistoryExtensionOptions, HistoryExtensionCommands, {}> {
+export declare class HistoryExtension extends Extension<HistoryExtensionOptions> {
     readonly name: "history";
@@ -51,3 +50,5 @@ readonly defaultOptions: {
      */
-    isEnabled({ getState }: ExtensionManagerParams): BooleanExtensionCheck<HistoryExtensionCommands>;
+    isEnabled({ getState }: ExtensionManagerParams): ({ command }: {
+        command?: string | undefined;
+    }) => boolean;
     /**
@@ -61,7 +62,25 @@ * The history plugin doesn't really have an active state.
     commands(): {
+        /**
+         * Undo the last action that occurred. This can be overriden by
+         * setting an `"addToHistory"` [metadata property](#state.Transaction.setMeta) of `false` on a transaction
+         * to prevent it from being rolled back by undo.
+         *
+         * ```ts
+         * actions.undo()
+         *
+         * // To prevent this use
+         * tr.setMeta(pluginKey, { addToHistory: false })
+         * ```
+         */
         undo: () => typeof undo;
+        /**
+         * Redo an action that was in the undo stack.
+         *
+         * ```ts
+         * actions.redo()
+         * ```
+         */
         redo: () => typeof redo;
     };
 }
-export {};
 //# sourceMappingURL=history-extension.d.ts.map

lib/extensions/history-extension.js

@@ -123,5 +123,25 @@ "use strict";
       return {
+        /**
+         * Undo the last action that occurred. This can be overriden by
+         * setting an `"addToHistory"` [metadata property](#state.Transaction.setMeta) of `false` on a transaction
+         * to prevent it from being rolled back by undo.
+         *
+         * ```ts
+         * actions.undo()
+         *
+         * // To prevent this use
+         * tr.setMeta(pluginKey, { addToHistory: false })
+         * ```
+         */
         undo: function undo() {
           return _prosemirrorHistory.undo;
         },
+
+        /**
+         * Redo an action that was in the undo stack.
+         *
+         * ```ts
+         * actions.redo()
+         * ```
+         */
         redo: function redo() {
@@ -128,0 +148,0 @@ return _prosemirrorHistory.redo;

lib/extensions/placeholder/placeholder-plugin.d.ts

@@ -9,3 +9,3 @@ import { Extension } from '@remirror/core';
  */
-export declare const createPlaceholderPlugin: (extension: Extension<PlaceholderExtensionOptions, string, import("@remirror/core").PlainObject, never>) => Plugin<PlaceholderPluginState, import("prosemirror-model").Schema<string, string>>;
+export declare const createPlaceholderPlugin: (extension: Extension<PlaceholderExtensionOptions, never>) => Plugin<PlaceholderPluginState, import("prosemirror-model").Schema<string, string>>;
 //# sourceMappingURL=placeholder-plugin.d.ts.map

lib/marks/bold-extension.d.ts

@@ -1,6 +0,6 @@
-import { CommandMarkTypeParams, MarkExtension, MarkExtensionOptions, MarkExtensionSpec, SchemaMarkTypeParams } from '@remirror/core';
-export declare class BoldExtension extends MarkExtension<MarkExtensionOptions, 'bold', {}> {
+import { CommandMarkTypeParams, ExtensionManagerMarkTypeParams, MarkExtension, MarkExtensionOptions, MarkExtensionSpec } from '@remirror/core';
+export declare class BoldExtension extends MarkExtension<MarkExtensionOptions> {
     readonly name: "bold";
     readonly schema: MarkExtensionSpec;
-    keys({ type }: SchemaMarkTypeParams): {
+    keys({ type }: ExtensionManagerMarkTypeParams): {
         'Mod-b': (state: import("prosemirror-state").EditorState<import("prosemirror-model").Schema<string, string>>, dispatch?: ((tr: import("prosemirror-state").Transaction<import("prosemirror-model").Schema<string, string>>) => void) | undefined) => boolean;
@@ -11,4 +11,4 @@ };
     };
-    inputRules({ type }: SchemaMarkTypeParams): import("prosemirror-inputrules").InputRule<any>[];
+    inputRules({ type }: ExtensionManagerMarkTypeParams): import("prosemirror-inputrules").InputRule<any>[];
 }
 //# sourceMappingURL=bold-extension.d.ts.map

lib/marks/code-extension.d.ts

@@ -1,6 +0,6 @@
-import { CommandMarkTypeParams, MarkExtension, MarkExtensionOptions, MarkExtensionSpec, SchemaMarkTypeParams } from '@remirror/core';
-export declare class CodeExtension extends MarkExtension<MarkExtensionOptions, 'code', {}> {
+import { CommandMarkTypeParams, ExtensionManagerMarkTypeParams, MarkExtension, MarkExtensionOptions, MarkExtensionSpec } from '@remirror/core';
+export declare class CodeExtension extends MarkExtension<MarkExtensionOptions> {
     readonly name: "code";
     readonly schema: MarkExtensionSpec;
-    keys({ type }: SchemaMarkTypeParams): {
+    keys({ type }: ExtensionManagerMarkTypeParams): {
         'Mod-`': (state: import("prosemirror-state").EditorState<import("prosemirror-model").Schema<string, string>>, dispatch?: ((tr: import("prosemirror-state").Transaction<import("prosemirror-model").Schema<string, string>>) => void) | undefined) => boolean;
@@ -11,5 +11,5 @@ };
     };
-    inputRules({ type }: SchemaMarkTypeParams): import("prosemirror-inputrules").InputRule<any>[];
-    pasteRules({ type }: SchemaMarkTypeParams): import("prosemirror-state").Plugin<any, any>[];
+    inputRules({ type }: ExtensionManagerMarkTypeParams): import("prosemirror-inputrules").InputRule<any>[];
+    pasteRules({ type }: ExtensionManagerMarkTypeParams): import("prosemirror-state").Plugin<any, any>[];
 }
 //# sourceMappingURL=code-extension.d.ts.map

lib/marks/italic-extension.d.ts

@@ -1,6 +0,6 @@
-import { CommandMarkTypeParams, MarkExtension, MarkExtensionOptions, MarkExtensionSpec, SchemaMarkTypeParams } from '@remirror/core';
-export declare class ItalicExtension extends MarkExtension<MarkExtensionOptions, 'italic', {}> {
+import { CommandMarkTypeParams, ExtensionManagerMarkTypeParams, MarkExtension, MarkExtensionOptions, MarkExtensionSpec } from '@remirror/core';
+export declare class ItalicExtension extends MarkExtension<MarkExtensionOptions> {
     readonly name: "italic";
     readonly schema: MarkExtensionSpec;
-    keys({ type }: SchemaMarkTypeParams): {
+    keys({ type }: ExtensionManagerMarkTypeParams): {
         'Mod-i': (state: import("prosemirror-state").EditorState<import("prosemirror-model").Schema<string, string>>, dispatch?: ((tr: import("prosemirror-state").Transaction<import("prosemirror-model").Schema<string, string>>) => void) | undefined) => boolean;
@@ -11,5 +11,5 @@ };
     };
-    inputRules({ type }: SchemaMarkTypeParams): import("prosemirror-inputrules").InputRule<any>[];
-    pasteRules({ type }: SchemaMarkTypeParams): import("prosemirror-state").Plugin<any, any>[];
+    inputRules({ type }: ExtensionManagerMarkTypeParams): import("prosemirror-inputrules").InputRule<any>[];
+    pasteRules({ type }: ExtensionManagerMarkTypeParams): import("prosemirror-state").Plugin<any, any>[];
 }
 //# sourceMappingURL=italic-extension.d.ts.map

lib/marks/link-extension.d.ts

@@ -1,4 +0,3 @@
-import { BooleanExtensionCheck, CommandMarkTypeParams, ExtensionCommands, KeyboardBindings, MarkExtension, MarkExtensionOptions, MarkExtensionSpec, SchemaMarkTypeParams } from '@remirror/core';
+import { BooleanExtensionCheck, CommandMarkTypeParams, ExtensionManagerMarkTypeParams, KeyboardBindings, MarkExtension, MarkExtensionOptions, MarkExtensionSpec } from '@remirror/core';
 import { Plugin } from 'prosemirror-state';
-export declare type InvokedFromType = 'keyboard' | 'input-rule';
 export interface LinkExtensionOptions extends MarkExtensionOptions {
@@ -11,3 +10,3 @@ /**
 export declare type LinkExtensionCommands = 'updateLink' | 'removeLink';
-export declare class LinkExtension extends MarkExtension<LinkExtensionOptions, LinkExtensionCommands, {}> {
+export declare class LinkExtension extends MarkExtension<LinkExtensionOptions> {
     readonly name: "link";
@@ -20,9 +19,15 @@ readonly defaultOptions: {
     commands({ type }: CommandMarkTypeParams): {
+        /**
+         * A command to update the selected link
+         */
         updateLink: (attrs?: Record<string, unknown> | undefined) => import("@remirror/core").CommandFunction;
+        /**
+         * Remove the link at the current position
+         */
         removeLink: () => import("@remirror/core").CommandFunction;
     };
-    isEnabled({ getState, type }: SchemaMarkTypeParams): BooleanExtensionCheck<ExtensionCommands<this>>;
-    pasteRules({ type }: SchemaMarkTypeParams): Plugin<any, any>[];
-    plugin({ type }: SchemaMarkTypeParams): Plugin<any, any>;
+    isEnabled({ getState, type }: ExtensionManagerMarkTypeParams): BooleanExtensionCheck;
+    pasteRules({ type }: ExtensionManagerMarkTypeParams): Plugin<any, any>[];
+    plugin({ type }: ExtensionManagerMarkTypeParams): Plugin<any, any>;
 }
 //# sourceMappingURL=link-extension.d.ts.map

lib/marks/link-extension.js

@@ -73,2 +73,5 @@ "use strict";
       return {
+        /**
+         * A command to update the selected link
+         */
         updateLink: function updateLink(attrs) {
@@ -80,2 +83,6 @@ return (0, _core.updateMark)({
         },
+
+        /**
+         * Remove the link at the current position
+         */
         removeLink: function removeLink() {
@@ -82,0 +89,0 @@ return (0, _core.removeMark)({

lib/marks/strike-extension.d.ts

@@ -1,6 +0,6 @@
-import { CommandMarkTypeParams, MarkExtension, MarkExtensionOptions, MarkExtensionSpec, SchemaMarkTypeParams } from '@remirror/core';
-export declare class StrikeExtension extends MarkExtension<MarkExtensionOptions, 'strike'> {
+import { CommandMarkTypeParams, ExtensionManagerMarkTypeParams, MarkExtension, MarkExtensionOptions, MarkExtensionSpec } from '@remirror/core';
+export declare class StrikeExtension extends MarkExtension<MarkExtensionOptions> {
     readonly name: "strike";
     readonly schema: MarkExtensionSpec;
-    keys({ type }: SchemaMarkTypeParams): {
+    keys({ type }: ExtensionManagerMarkTypeParams): {
         'Mod-d': (state: import("prosemirror-state").EditorState<import("prosemirror-model").Schema<string, string>>, dispatch?: ((tr: import("prosemirror-state").Transaction<import("prosemirror-model").Schema<string, string>>) => void) | undefined) => boolean;
@@ -11,5 +11,5 @@ };
     };
-    inputRules({ type }: SchemaMarkTypeParams): import("prosemirror-inputrules").InputRule<any>[];
-    pasteRules({ type }: SchemaMarkTypeParams): import("prosemirror-state").Plugin<any, any>[];
+    inputRules({ type }: ExtensionManagerMarkTypeParams): import("prosemirror-inputrules").InputRule<any>[];
+    pasteRules({ type }: ExtensionManagerMarkTypeParams): import("prosemirror-state").Plugin<any, any>[];
 }
 //# sourceMappingURL=strike-extension.d.ts.map

lib/marks/underline-extension.d.ts

@@ -1,6 +0,6 @@
-import { CommandMarkTypeParams, MarkExtension, MarkExtensionOptions, MarkExtensionSpec, SchemaMarkTypeParams } from '@remirror/core';
-export declare class UnderlineExtension extends MarkExtension<MarkExtensionOptions, 'underline', {}> {
+import { CommandMarkTypeParams, ExtensionManagerMarkTypeParams, MarkExtension, MarkExtensionOptions, MarkExtensionSpec } from '@remirror/core';
+export declare class UnderlineExtension extends MarkExtension<MarkExtensionOptions> {
     readonly name: "underline";
     readonly schema: MarkExtensionSpec;
-    keys({ type }: SchemaMarkTypeParams): {
+    keys({ type }: ExtensionManagerMarkTypeParams): {
         'Mod-u': (state: import("prosemirror-state").EditorState<import("prosemirror-model").Schema<string, string>>, dispatch?: ((tr: import("prosemirror-state").Transaction<import("prosemirror-model").Schema<string, string>>) => void) | undefined) => boolean;
@@ -7,0 +7,0 @@ };

lib/nodes/blockquote-extension.d.ts

@@ -1,3 +0,3 @@
-import { CommandNodeTypeParams, NodeExtension, NodeExtensionOptions, NodeExtensionSpec, SchemaNodeTypeParams } from '@remirror/core';
-export declare class BlockquoteExtension extends NodeExtension<NodeExtensionOptions, 'blockquote', {}> {
+import { CommandNodeTypeParams, ExtensionManagerNodeTypeParams, NodeExtension, NodeExtensionOptions, NodeExtensionSpec } from '@remirror/core';
+export declare class BlockquoteExtension extends NodeExtension<NodeExtensionOptions> {
     readonly name: "blockquote";
@@ -9,7 +9,7 @@ readonly schema: NodeExtensionSpec;
     styles(): string;
-    keys({ type }: SchemaNodeTypeParams): {
+    keys({ type }: ExtensionManagerNodeTypeParams): {
         'Ctrl->': import("@remirror/core").CommandFunction;
     };
-    inputRules({ type }: SchemaNodeTypeParams): import("prosemirror-inputrules").InputRule<import("prosemirror-model").Schema<string, string>>[];
+    inputRules({ type }: ExtensionManagerNodeTypeParams): import("prosemirror-inputrules").InputRule<import("prosemirror-model").Schema<string, string>>[];
 }
 //# sourceMappingURL=blockquote-extension.d.ts.map

lib/nodes/bullet-list-extension.d.ts

@@ -1,3 +0,3 @@
-import { CommandNodeTypeParams, NodeExtension, NodeExtensionOptions, NodeExtensionSpec, SchemaNodeTypeParams } from '@remirror/core';
-export declare class BulletListExtension extends NodeExtension<NodeExtensionOptions, 'toggleBulletList', {}> {
+import { CommandNodeTypeParams, ExtensionManagerNodeTypeParams, NodeExtension, NodeExtensionOptions, NodeExtensionSpec } from '@remirror/core';
+export declare class BulletListExtension extends NodeExtension<NodeExtensionOptions> {
     readonly name: "bulletList";
@@ -8,7 +8,7 @@ readonly schema: NodeExtensionSpec;
     };
-    keys({ type, schema }: SchemaNodeTypeParams): {
+    keys({ type, schema }: ExtensionManagerNodeTypeParams): {
         'Shift-Ctrl-8': import("@remirror/core").CommandFunction;
     };
-    inputRules({ type }: SchemaNodeTypeParams): import("prosemirror-inputrules").InputRule<import("prosemirror-model").Schema<string, string>>[];
+    inputRules({ type }: ExtensionManagerNodeTypeParams): import("prosemirror-inputrules").InputRule<import("prosemirror-model").Schema<string, string>>[];
 }
 //# sourceMappingURL=bullet-list-extension.d.ts.map

lib/nodes/hard-break-extension.d.ts

@@ -1,6 +0,6 @@
-import { NodeExtension, NodeExtensionSpec, SchemaNodeTypeParams } from '@remirror/core';
+import { ExtensionManagerNodeTypeParams, NodeExtension, NodeExtensionSpec } from '@remirror/core';
 export declare class HardBreakExtension extends NodeExtension {
     readonly name: "hardBreak";
     readonly schema: NodeExtensionSpec;
-    keys({ type }: SchemaNodeTypeParams): {
+    keys({ type }: ExtensionManagerNodeTypeParams): {
         'Mod-Enter': <S extends import("prosemirror-model").Schema<any, any> = any>(p1: import("prosemirror-state").EditorState<S>, p2?: ((tr: import("prosemirror-state").Transaction<S>) => void) | undefined, p3?: import("prosemirror-view").EditorView<S> | undefined) => boolean;
@@ -7,0 +7,0 @@ 'Shift-Enter': <S extends import("prosemirror-model").Schema<any, any> = any>(p1: import("prosemirror-state").EditorState<S>, p2?: ((tr: import("prosemirror-state").Transaction<S>) => void) | undefined, p3?: import("prosemirror-view").EditorView<S> | undefined) => boolean;

lib/nodes/heading-extension.d.ts

@@ -1,2 +0,2 @@
-import { CommandNodeTypeParams, NodeExtension, NodeExtensionOptions, NodeExtensionSpec, SchemaNodeTypeParams } from '@remirror/core';
+import { CommandNodeTypeParams, ExtensionManagerNodeTypeParams, NodeExtension, NodeExtensionOptions, NodeExtensionSpec } from '@remirror/core';
 export interface HeadingExtensionOptions extends NodeExtensionOptions {
@@ -10,3 +10,3 @@ levels?: number[];
 };
-export declare class HeadingExtension extends NodeExtension<HeadingExtensionOptions, 'toggleHeading'> {
+export declare class HeadingExtension extends NodeExtension<HeadingExtensionOptions> {
     readonly name: "heading";
@@ -21,5 +21,5 @@ readonly defaultOptions: {
     };
-    keys({ type }: SchemaNodeTypeParams): Record<string, import("@remirror/core").CommandFunction>;
-    inputRules({ type }: SchemaNodeTypeParams): import("prosemirror-inputrules").InputRule<import("prosemirror-model").Schema<string, string>>[];
+    keys({ type }: ExtensionManagerNodeTypeParams): Record<string, import("@remirror/core").CommandFunction>;
+    inputRules({ type }: ExtensionManagerNodeTypeParams): import("prosemirror-inputrules").InputRule<import("prosemirror-model").Schema<string, string>>[];
 }
 //# sourceMappingURL=heading-extension.d.ts.map

lib/nodes/horizontal-rule-extension.d.ts

@@ -1,3 +0,3 @@
-import { CommandFunction, CommandNodeTypeParams, NodeExtension, NodeExtensionOptions, NodeExtensionSpec, SchemaNodeTypeParams } from '@remirror/core';
-export declare class HorizontalRuleExtension extends NodeExtension<NodeExtensionOptions, 'horizontalRule', {}> {
+import { CommandFunction, CommandNodeTypeParams, ExtensionManagerNodeTypeParams, NodeExtension, NodeExtensionOptions, NodeExtensionSpec } from '@remirror/core';
+export declare class HorizontalRuleExtension extends NodeExtension<NodeExtensionOptions> {
     readonly name: "horizontalRule";
@@ -8,4 +8,4 @@ readonly schema: NodeExtensionSpec;
     };
-    inputRules({ type }: SchemaNodeTypeParams): import("prosemirror-inputrules").InputRule<any>[];
+    inputRules({ type }: ExtensionManagerNodeTypeParams): import("prosemirror-inputrules").InputRule<any>[];
 }
 //# sourceMappingURL=horizontal-rule-extension.d.ts.map

lib/nodes/image-extension.d.ts

 import { CommandFunction, CommandNodeTypeParams, NodeExtension, NodeExtensionOptions, NodeExtensionSpec } from '@remirror/core';
 import { Plugin } from 'prosemirror-state';
-export declare class ImageExtension extends NodeExtension<NodeExtensionOptions, 'image', {}> {
+export declare class ImageExtension extends NodeExtension<NodeExtensionOptions> {
     readonly name: "image";
@@ -5,0 +5,0 @@ readonly schema: NodeExtensionSpec;

lib/nodes/list-item-extension.d.ts

@@ -1,6 +0,6 @@
-import { NodeExtension, NodeExtensionSpec, SchemaNodeTypeParams } from '@remirror/core';
+import { ExtensionManagerNodeTypeParams, NodeExtension, NodeExtensionSpec } from '@remirror/core';
 export declare class ListItemExtension extends NodeExtension {
     readonly name: "listItem";
     readonly schema: NodeExtensionSpec;
-    keys({ type }: SchemaNodeTypeParams): {
+    keys({ type }: ExtensionManagerNodeTypeParams): {
         Enter: (state: import("prosemirror-state").EditorState<import("prosemirror-model").Schema<string, string>>, dispatch?: ((tr: import("prosemirror-state").Transaction<import("prosemirror-model").Schema<string, string>>) => void) | undefined) => boolean;
@@ -7,0 +7,0 @@ Tab: (state: import("prosemirror-state").EditorState<import("prosemirror-model").Schema<string, string>>, dispatch?: ((tr: import("prosemirror-state").Transaction<import("prosemirror-model").Schema<string, string>>) => void) | undefined) => boolean;

lib/nodes/ordered-list-extension.d.ts

@@ -1,3 +0,3 @@
-import { CommandNodeTypeParams, NodeExtension, NodeExtensionOptions, NodeExtensionSpec, SchemaNodeTypeParams } from '@remirror/core';
-export declare class OrderedListExtension extends NodeExtension<NodeExtensionOptions, 'toggleOrderedList', {}> {
+import { CommandNodeTypeParams, ExtensionManagerNodeTypeParams, NodeExtension, NodeExtensionOptions, NodeExtensionSpec } from '@remirror/core';
+export declare class OrderedListExtension extends NodeExtension<NodeExtensionOptions> {
     readonly name: "orderedList";
@@ -8,7 +8,7 @@ readonly schema: NodeExtensionSpec;
     };
-    keys({ type, schema }: SchemaNodeTypeParams): {
+    keys({ type, schema }: ExtensionManagerNodeTypeParams): {
         'Shift-Ctrl-9': import("@remirror/core").CommandFunction;
     };
-    inputRules({ type }: SchemaNodeTypeParams): import("prosemirror-inputrules").InputRule<import("prosemirror-model").Schema<string, string>>[];
+    inputRules({ type }: ExtensionManagerNodeTypeParams): import("prosemirror-inputrules").InputRule<import("prosemirror-model").Schema<string, string>>[];
 }
 //# sourceMappingURL=ordered-list-extension.d.ts.map

lib/nodes/paragraph/paragraph-extension.d.ts

@@ -9,3 +9,3 @@ import { CommandNodeTypeParams, NodeExtension, NodeExtensionSpec, Tags } from '@remirror/core';
  */
-export declare class ParagraphExtension extends NodeExtension<ParagraphExtensionOptions, 'createParagraph', {}> {
+export declare class ParagraphExtension extends NodeExtension<ParagraphExtensionOptions> {
     readonly name: "paragraph";
@@ -12,0 +12,0 @@ readonly tags: Tags[];

lib/nodes/simple-code-block-extension.d.ts

 import { Interpolation } from '@emotion/core';
-import { CommandNodeTypeParams, NodeExtension, NodeExtensionOptions, NodeExtensionSpec, SchemaNodeTypeParams } from '@remirror/core';
-export declare class CodeBlockExtension extends NodeExtension<NodeExtensionOptions, 'toggleCodeBlock', {}> {
+import { CommandNodeTypeParams, ExtensionManagerNodeTypeParams, NodeExtension, NodeExtensionOptions, NodeExtensionSpec } from '@remirror/core';
+export declare class CodeBlockExtension extends NodeExtension<NodeExtensionOptions> {
     readonly name: "codeBlock";
@@ -9,8 +9,8 @@ readonly schema: NodeExtensionSpec;
     };
-    keys({ type, schema }: SchemaNodeTypeParams): {
+    keys({ type, schema }: ExtensionManagerNodeTypeParams): {
         'Shift-Ctrl-\\': import("@remirror/core").CommandFunction;
     };
     styles(): Interpolation;
-    inputRules({ type }: SchemaNodeTypeParams): import("prosemirror-inputrules").InputRule<import("prosemirror-model").Schema<string, string>>[];
+    inputRules({ type }: ExtensionManagerNodeTypeParams): import("prosemirror-inputrules").InputRule<import("prosemirror-model").Schema<string, string>>[];
 }
 //# sourceMappingURL=simple-code-block-extension.d.ts.map

package.json

@@ -12,3 +12,3 @@ {
   },
-  "version": "0.4.2-canary.0",
+  "version": "0.4.2-canary.1",
   "main": "lib/index.js",
@@ -34,4 +34,4 @@ "module": "lib/dist/core-extensions.esm.js",
     "@emotion/core": "^10.0.14",
-    "@remirror/core": "0.4.2-canary.0",
-    "@remirror/react-utils": "0.4.2-canary.0",
+    "@remirror/core": "0.4.2-canary.1",
+    "@remirror/react-utils": "0.4.2-canary.1",
     "@types/prosemirror-commands": "^1.0.1",
@@ -65,3 +65,3 @@ "@types/prosemirror-dropcursor": "^1.0.0",
   "sideEffects": false,
-  "gitHead": "e6500c65aecbffad1b0f9bb2c0b8d4891ba764d3"
+  "gitHead": "0330899c87713ed1398df695715d1fed87267462"
 }

src/core-extensions.ts

@@ -27,1 +27,16 @@ import { DocExtension, PrioritizedExtension, TextExtension } from '@remirror/core';
 ];
+
+/**
+ * The BaseExtensions union type shows the extension provided by default in a remirror editor.
+ * This union is useful for extending with your own types to provide better typechecking
+ * throughout your codebase
+ */
+export type BaseExtensions =
+  | DocExtension
+  | TextExtension
+  | ParagraphExtension
+  | CompositionExtension
+  | HistoryExtension
+  | GapCursorExtension
+  | DropCursorExtension
+  | BaseKeymapExtension;

src/extensions/history-extension.ts

 import {
   BaseExtensionOptions,
-  BooleanExtensionCheck,
   CommandFunction,
@@ -30,4 +29,2 @@ environment,
 
-type HistoryExtensionCommands = 'undo' | 'redo';
-
 /**
@@ -39,3 +36,3 @@ * This extension provides undo and redo commands and inserts a plugin which
  */
-export class HistoryExtension extends Extension<HistoryExtensionOptions, HistoryExtensionCommands, {}> {
+export class HistoryExtension extends Extension<HistoryExtensionOptions> {
   get name() {
@@ -85,4 +82,4 @@ return 'history' as const;
    */
-  public isEnabled({ getState }: ExtensionManagerParams): BooleanExtensionCheck<HistoryExtensionCommands> {
-    return ({ command }) => {
+  public isEnabled({ getState }: ExtensionManagerParams) {
+    return ({ command }: { command?: string }) => {
       switch (command) {
@@ -111,3 +108,23 @@ case 'undo':
     return {
+      /**
+       * Undo the last action that occurred. This can be overriden by
+       * setting an `"addToHistory"` [metadata property](#state.Transaction.setMeta) of `false` on a transaction
+       * to prevent it from being rolled back by undo.
+       *
+       * ```ts
+       * actions.undo()
+       *
+       * // To prevent this use
+       * tr.setMeta(pluginKey, { addToHistory: false })
+       * ```
+       */
       undo: () => undo,
+
+      /**
+       * Redo an action that was in the undo stack.
+       *
+       * ```ts
+       * actions.redo()
+       * ```
+       */
       redo: () => redo,
@@ -114,0 +131,0 @@ };

src/marks/bold-extension.ts

 import {
   CommandMarkTypeParams,
+  ExtensionManagerMarkTypeParams,
   isElementDOMNode,
@@ -10,7 +11,6 @@ isString,
   markInputRule,
-  SchemaMarkTypeParams,
 } from '@remirror/core';
 import { toggleMark } from 'prosemirror-commands';
 
-export class BoldExtension extends MarkExtension<MarkExtensionOptions, 'bold', {}> {
+export class BoldExtension extends MarkExtension<MarkExtensionOptions> {
   get name() {
@@ -43,3 +43,3 @@ return 'bold' as const;
 
-  public keys({ type }: SchemaMarkTypeParams) {
+  public keys({ type }: ExtensionManagerMarkTypeParams) {
     return {
@@ -58,5 +58,5 @@ 'Mod-b': toggleMark(type),
 
-  public inputRules({ type }: SchemaMarkTypeParams) {
+  public inputRules({ type }: ExtensionManagerMarkTypeParams) {
     return [markInputRule({ regexp: /(?:\*\*|__)([^*_]+)(?:\*\*|__)$/, type })];
   }
 }

src/marks/code-extension.ts

 import {
   CommandMarkTypeParams,
+  ExtensionManagerMarkTypeParams,
   MarkExtension,
@@ -9,7 +10,6 @@ MarkExtensionOptions,
   markPasteRule,
-  SchemaMarkTypeParams,
 } from '@remirror/core';
 import { toggleMark } from 'prosemirror-commands';
 
-export class CodeExtension extends MarkExtension<MarkExtensionOptions, 'code', {}> {
+export class CodeExtension extends MarkExtension<MarkExtensionOptions> {
   get name() {
@@ -27,3 +27,3 @@ return 'code' as const;
 
-  public keys({ type }: SchemaMarkTypeParams) {
+  public keys({ type }: ExtensionManagerMarkTypeParams) {
     return {
@@ -38,9 +38,9 @@ 'Mod-`': toggleMark(type),
 
-  public inputRules({ type }: SchemaMarkTypeParams) {
+  public inputRules({ type }: ExtensionManagerMarkTypeParams) {
     return [markInputRule({ regexp: /(?:`)([^`]+)(?:`)$/, type })];
   }
 
-  public pasteRules({ type }: SchemaMarkTypeParams) {
+  public pasteRules({ type }: ExtensionManagerMarkTypeParams) {
     return [markPasteRule({ regexp: /(?:`)([^`]+)(?:`)/g, type })];
   }
 }

src/marks/italic-extension.ts

 import {
   CommandMarkTypeParams,
+  ExtensionManagerMarkTypeParams,
   MarkExtension,
@@ -9,7 +10,6 @@ MarkExtensionOptions,
   markPasteRule,
-  SchemaMarkTypeParams,
 } from '@remirror/core';
 import { toggleMark } from 'prosemirror-commands';
 
-export class ItalicExtension extends MarkExtension<MarkExtensionOptions, 'italic', {}> {
+export class ItalicExtension extends MarkExtension<MarkExtensionOptions> {
   get name() {
@@ -27,3 +27,3 @@ return 'italic' as const;
 
-  public keys({ type }: SchemaMarkTypeParams) {
+  public keys({ type }: ExtensionManagerMarkTypeParams) {
     return {
@@ -38,9 +38,9 @@ 'Mod-i': toggleMark(type),
 
-  public inputRules({ type }: SchemaMarkTypeParams) {
+  public inputRules({ type }: ExtensionManagerMarkTypeParams) {
     return [markInputRule({ regexp: /(?:^|[^*_])(?:\*|_)([^*_]+)(?:\*|_)$/, type })];
   }
 
-  public pasteRules({ type }: SchemaMarkTypeParams) {
+  public pasteRules({ type }: ExtensionManagerMarkTypeParams) {
     return [markPasteRule({ regexp: /(?:^|[^*_])(?:\*|_)([^*_]+)(?:\*|_)/g, type })];
   }
 }

src/marks/link-extension.ts

@@ -6,3 +6,3 @@ import {
   CommandMarkTypeParams,
-  ExtensionCommands,
+  ExtensionManagerMarkTypeParams,
   getMarkRange,
@@ -20,3 +20,2 @@ getMatchString,
   removeMark,
-  SchemaMarkTypeParams,
   selectionEmpty,
@@ -27,4 +26,2 @@ updateMark,
 
-export type InvokedFromType = 'keyboard' | 'input-rule';
-
 export interface LinkExtensionOptions extends MarkExtensionOptions {
@@ -39,3 +36,3 @@ /**
 
-export class LinkExtension extends MarkExtension<LinkExtensionOptions, LinkExtensionCommands, {}> {
+export class LinkExtension extends MarkExtension<LinkExtensionOptions> {
   get name() {
@@ -104,3 +101,9 @@ return 'link' as const;
     return {
+      /**
+       * A command to update the selected link
+       */
       updateLink: (attrs?: Attrs) => updateMark({ type, attrs }),
+      /**
+       * Remove the link at the current position
+       */
       removeLink: () => {
@@ -112,3 +115,3 @@ return removeMark({ type, expand: true });
 
-  public isEnabled({ getState, type }: SchemaMarkTypeParams): BooleanExtensionCheck<ExtensionCommands<this>> {
+  public isEnabled({ getState, type }: ExtensionManagerMarkTypeParams): BooleanExtensionCheck {
     return ({ command }) => {
@@ -130,3 +133,3 @@ switch (command) {
 
-  public pasteRules({ type }: SchemaMarkTypeParams) {
+  public pasteRules({ type }: ExtensionManagerMarkTypeParams) {
     return [
@@ -141,3 +144,3 @@ markPasteRule({
 
-  public plugin({ type }: SchemaMarkTypeParams) {
+  public plugin({ type }: ExtensionManagerMarkTypeParams) {
     return new Plugin({
@@ -144,0 +147,0 @@ props: {

src/marks/strike-extension.ts

 import {
   CommandMarkTypeParams,
+  ExtensionManagerMarkTypeParams,
   MarkExtension,
@@ -9,7 +10,6 @@ MarkExtensionOptions,
   markPasteRule,
-  SchemaMarkTypeParams,
 } from '@remirror/core';
 import { toggleMark } from 'prosemirror-commands';
 
-export class StrikeExtension extends MarkExtension<MarkExtensionOptions, 'strike'> {
+export class StrikeExtension extends MarkExtension<MarkExtensionOptions> {
   get name() {
@@ -41,3 +41,3 @@ return 'strike' as const;
 
-  public keys({ type }: SchemaMarkTypeParams) {
+  public keys({ type }: ExtensionManagerMarkTypeParams) {
     return {
@@ -52,9 +52,9 @@ 'Mod-d': toggleMark(type),
 
-  public inputRules({ type }: SchemaMarkTypeParams) {
+  public inputRules({ type }: ExtensionManagerMarkTypeParams) {
     return [markInputRule({ regexp: /~([^~]+)~$/, type })];
   }
 
-  public pasteRules({ type }: SchemaMarkTypeParams) {
+  public pasteRules({ type }: ExtensionManagerMarkTypeParams) {
     return [markPasteRule({ regexp: /~([^~]+)~/g, type })];
   }
 }

src/marks/underline-extension.ts

 import {
   CommandMarkTypeParams,
+  ExtensionManagerMarkTypeParams,
   MarkExtension,
@@ -7,7 +8,6 @@ MarkExtensionOptions,
   MarkGroup,
-  SchemaMarkTypeParams,
 } from '@remirror/core';
 import { toggleMark } from 'prosemirror-commands';
 
-export class UnderlineExtension extends MarkExtension<MarkExtensionOptions, 'underline', {}> {
+export class UnderlineExtension extends MarkExtension<MarkExtensionOptions> {
   get name() {
@@ -33,3 +33,3 @@ return 'underline' as const;
 
-  public keys({ type }: SchemaMarkTypeParams) {
+  public keys({ type }: ExtensionManagerMarkTypeParams) {
     return {
@@ -36,0 +36,0 @@ 'Mod-u': toggleMark(type),

src/nodes/blockquote-extension.ts

 import {
   CommandNodeTypeParams,
   EDITOR_CLASS_SELECTOR,
+  ExtensionManagerNodeTypeParams,
   NodeExtension,
@@ -8,3 +9,2 @@ NodeExtensionOptions,
   NodeGroup,
-  SchemaNodeTypeParams,
   toggleWrap,
@@ -14,3 +14,3 @@ } from '@remirror/core';
 
-export class BlockquoteExtension extends NodeExtension<NodeExtensionOptions, 'blockquote', {}> {
+export class BlockquoteExtension extends NodeExtension<NodeExtensionOptions> {
   get name() {
@@ -50,3 +50,3 @@ return 'blockquote' as const;
 
-  public keys({ type }: SchemaNodeTypeParams) {
+  public keys({ type }: ExtensionManagerNodeTypeParams) {
     return {
@@ -57,5 +57,5 @@ 'Ctrl->': toggleWrap(type),
 
-  public inputRules({ type }: SchemaNodeTypeParams) {
+  public inputRules({ type }: ExtensionManagerNodeTypeParams) {
     return [wrappingInputRule(/^\s*>\s$/, type)];
   }
 }

src/nodes/bullet-list-extension.ts

 import {
   CommandNodeTypeParams,
+  ExtensionManagerNodeTypeParams,
   NodeExtension,
@@ -7,3 +8,2 @@ NodeExtensionOptions,
   NodeGroup,
-  SchemaNodeTypeParams,
   toggleList,
@@ -13,3 +13,3 @@ } from '@remirror/core';
 
-export class BulletListExtension extends NodeExtension<NodeExtensionOptions, 'toggleBulletList', {}> {
+export class BulletListExtension extends NodeExtension<NodeExtensionOptions> {
   get name() {
@@ -33,3 +33,3 @@ return 'bulletList' as const;
 
-  public keys({ type, schema }: SchemaNodeTypeParams) {
+  public keys({ type, schema }: ExtensionManagerNodeTypeParams) {
     return {
@@ -40,5 +40,5 @@ 'Shift-Ctrl-8': toggleList(type, schema.nodes.listItem),
 
-  public inputRules({ type }: SchemaNodeTypeParams) {
+  public inputRules({ type }: ExtensionManagerNodeTypeParams) {
     return [wrappingInputRule(/^\s*([-+*])\s$/, type)];
   }
 }

src/nodes/hard-break-extension.ts

@@ -1,2 +0,2 @@
-import { NodeExtension, NodeExtensionSpec, SchemaNodeTypeParams } from '@remirror/core';
+import { ExtensionManagerNodeTypeParams, NodeExtension, NodeExtensionSpec } from '@remirror/core';
 import { chainCommands, exitCode } from 'prosemirror-commands';
@@ -20,3 +20,3 @@
 
-  public keys({ type }: SchemaNodeTypeParams) {
+  public keys({ type }: ExtensionManagerNodeTypeParams) {
     const command = chainCommands(exitCode, (state, dispatch) => {
@@ -23,0 +23,0 @@ if (dispatch) {

src/nodes/heading-extension.ts

 import {
   Attrs,
   CommandNodeTypeParams,
+  ExtensionManagerNodeTypeParams,
   KeyboardBindings,
@@ -10,3 +11,2 @@ NodeExtension,
   ProsemirrorNode,
-  SchemaNodeTypeParams,
   toggleBlockItem,
@@ -27,3 +27,3 @@ } from '@remirror/core';
 
-export class HeadingExtension extends NodeExtension<HeadingExtensionOptions, 'toggleHeading'> {
+export class HeadingExtension extends NodeExtension<HeadingExtensionOptions> {
   get name() {
@@ -70,3 +70,3 @@ return 'heading' as const;
 
-  public keys({ type }: SchemaNodeTypeParams) {
+  public keys({ type }: ExtensionManagerNodeTypeParams) {
     const keys: KeyboardBindings = {};
@@ -80,3 +80,3 @@
 
-  public inputRules({ type }: SchemaNodeTypeParams) {
+  public inputRules({ type }: ExtensionManagerNodeTypeParams) {
     return this.options.levels.map(level =>
@@ -83,0 +83,0 @@ textblockTypeInputRule(new RegExp(`^(#{1,${level}})\\s$`), type, () => ({ level })),

src/nodes/horizontal-rule-extension.ts

 import {
   CommandFunction,
   CommandNodeTypeParams,
+  ExtensionManagerNodeTypeParams,
   NodeExtension,
@@ -9,6 +10,5 @@ NodeExtensionOptions,
   nodeInputRule,
-  SchemaNodeTypeParams,
 } from '@remirror/core';
 
-export class HorizontalRuleExtension extends NodeExtension<NodeExtensionOptions, 'horizontalRule', {}> {
+export class HorizontalRuleExtension extends NodeExtension<NodeExtensionOptions> {
   get name() {
@@ -39,5 +39,5 @@ return 'horizontalRule' as const;
 
-  public inputRules({ type }: SchemaNodeTypeParams) {
+  public inputRules({ type }: ExtensionManagerNodeTypeParams) {
     return [nodeInputRule({ regexp: /^(?:---|___\s|\*\*\*\s)$/, type })];
   }
 }

src/nodes/image-extension.ts

@@ -19,3 +19,3 @@ import {
 
-export class ImageExtension extends NodeExtension<NodeExtensionOptions, 'image', {}> {
+export class ImageExtension extends NodeExtension<NodeExtensionOptions> {
   get name() {
@@ -22,0 +22,0 @@ return 'image' as const;

src/nodes/list-item-extension.ts

@@ -1,2 +0,2 @@
-import { NodeExtension, NodeExtensionSpec, SchemaNodeTypeParams } from '@remirror/core';
+import { ExtensionManagerNodeTypeParams, NodeExtension, NodeExtensionSpec } from '@remirror/core';
 import { liftListItem, sinkListItem, splitListItem } from 'prosemirror-schema-list';
@@ -20,3 +20,3 @@
 
-  public keys({ type }: SchemaNodeTypeParams) {
+  public keys({ type }: ExtensionManagerNodeTypeParams) {
     return {
@@ -23,0 +23,0 @@ Enter: splitListItem(type),

src/nodes/ordered-list-extension.ts

 import {
   Cast,
   CommandNodeTypeParams,
+  ExtensionManagerNodeTypeParams,
   NodeExtension,
@@ -8,3 +9,2 @@ NodeExtensionOptions,
   NodeGroup,
-  SchemaNodeTypeParams,
   toggleList,
@@ -14,3 +14,3 @@ } from '@remirror/core';
 
-export class OrderedListExtension extends NodeExtension<NodeExtensionOptions, 'toggleOrderedList', {}> {
+export class OrderedListExtension extends NodeExtension<NodeExtensionOptions> {
   get name() {
@@ -48,3 +48,3 @@ return 'orderedList' as const;
 
-  public keys({ type, schema }: SchemaNodeTypeParams) {
+  public keys({ type, schema }: ExtensionManagerNodeTypeParams) {
     return {
@@ -55,3 +55,3 @@ 'Shift-Ctrl-9': toggleList(type, schema.nodes.listItem),
 
-  public inputRules({ type }: SchemaNodeTypeParams) {
+  public inputRules({ type }: ExtensionManagerNodeTypeParams) {
     return [
@@ -58,0 +58,0 @@ wrappingInputRule(

src/nodes/paragraph/paragraph-extension.ts

@@ -13,3 +13,3 @@ import { CommandNodeTypeParams, NodeExtension, NodeExtensionSpec, NodeGroup, Tags } from '@remirror/core';
  */
-export class ParagraphExtension extends NodeExtension<ParagraphExtensionOptions, 'createParagraph', {}> {
+export class ParagraphExtension extends NodeExtension<ParagraphExtensionOptions> {
   get name() {
@@ -16,0 +16,0 @@ return 'paragraph' as const;

src/nodes/simple-code-block-extension.ts

@@ -5,2 +5,3 @@ import { Interpolation } from '@emotion/core';
   EDITOR_CLASS_SELECTOR,
+  ExtensionManagerNodeTypeParams,
   NodeExtension,
@@ -10,3 +11,2 @@ NodeExtensionOptions,
   NodeGroup,
-  SchemaNodeTypeParams,
   toggleBlockItem,
@@ -16,3 +16,3 @@ } from '@remirror/core';
 
-export class CodeBlockExtension extends NodeExtension<NodeExtensionOptions, 'toggleCodeBlock', {}> {
+export class CodeBlockExtension extends NodeExtension<NodeExtensionOptions> {
   get name() {
@@ -40,3 +40,3 @@ return 'codeBlock' as const;
 
-  public keys({ type, schema }: SchemaNodeTypeParams) {
+  public keys({ type, schema }: ExtensionManagerNodeTypeParams) {
     return {
@@ -63,5 +63,5 @@ 'Shift-Ctrl-\\': toggleBlockItem({ type, toggleType: schema.nodes.paragraph }),
 
-  public inputRules({ type }: SchemaNodeTypeParams) {
+  public inputRules({ type }: ExtensionManagerNodeTypeParams) {
     return [textblockTypeInputRule(/^```$/, type)];
   }
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

801974

decreased by-18.77%

Number of package files

237

decreased by-29.67%

Lines of code

12374

decreased by-15.94%

Dependency changes

• + Added@remirror/core@0.4.2-canary.1(transitive)

• + Added@remirror/react-utils@0.4.2-canary.1(transitive)

• - Removed@remirror/core@0.4.2-canary.0(transitive)

• - Removed@remirror/react-utils@0.4.2-canary.0(transitive)

• Updated@remirror/core@0.4.2-canary.1

• Updated@remirror/react-utils@0.4.2-canary.1