@remirror/core-constants - npm Package Compare versions

Comparing version 2.0.0 to 2.0.1

dist-types/core-constants.d.ts

@@ -70,3 +70,3 @@ /**
  */
-export declare type ExtensionTag = Remirror.ExtensionTags & typeof BaseExtensionTag;
+export type ExtensionTag = Remirror.ExtensionTags & typeof BaseExtensionTag;
 /**
@@ -216,3 +216,3 @@ * A method for updating the extension tags.
  */
-export declare type ExtensionTagType = ExtensionTag[keyof ExtensionTag];
+export type ExtensionTagType = ExtensionTag[keyof ExtensionTag];
 /**
@@ -391,4 +391,7 @@ * The identifier key which is used to check objects for whether they are a
     InsertLink = "_|link|_",
+    /** @deprecated */
     Find = "_|find|_",
+    /** @deprecated */
     FindBackwards = "_|find-backwards|_",
+    /** @deprecated */
     FindReplace = "_|find-replace|_",
@@ -395,0 +398,0 @@ AddFootnote = "_|footnote|_",

dist/remirror-core-constants.js

@@ -26,21 +26,105 @@ // packages/remirror__core-constants/src/core-constants.ts
 var BaseExtensionTag = {
+  /**
+   * Describes a node that can be used as the last node of a document and
+   * doesn't need to have anything else rendered after itself.
+   *
+   * @remarks
+   *
+   * e.g. `paragraph`
+   */
   LastNodeCompatible: "lastNodeCompatible",
+  /**
+   * A mark that is used to change the formatting of the node it wraps.
+   *
+   * @remarks
+   *
+   * e.g. `bold`, `italic`
+   */
   FormattingMark: "formattingMark",
+  /**
+   * A node that formats text in a non-standard way.
+   *
+   * @remarks
+   *
+   * e.g. `codeBlock`, `heading`, `blockquote`
+   */
   FormattingNode: "formattingNode",
+  /**
+   * Identifies a node which has problems with cursor navigation.
+   *
+   * @remarks
+   *
+   * When this tag is added to an extension this will be picked up by
+   * behavioural extensions such as the NodeCursorExtension which makes hard to
+   * reach nodes reachable using keyboard arrows.
+   */
   NodeCursor: "nodeCursor",
+  /**
+   * Mark group for font styling (e.g. bold, italic, underline, superscript).
+   */
   FontStyle: "fontStyle",
+  /**
+   * Mark groups for links.
+   */
   Link: "link",
+  /**
+   * Mark groups for colors (text-color, background-color, etc).
+   */
   Color: "color",
+  /**
+   * Mark group for alignment.
+   */
   Alignment: "alignment",
+  /**
+   * Mark group for indentation.
+   */
   Indentation: "indentation",
+  /**
+   * Extension which affect the behaviour of the content. Can be nodes marks or
+   * plain.
+   */
   Behavior: "behavior",
+  /**
+   * Marks and nodes which contain code.
+   */
   Code: "code",
+  /**
+   * Whether this node is an inline node.
+   *
+   * - `text` is an inline node, but `paragraph` is a block node.
+   */
   InlineNode: "inline",
+  /**
+   * This is a node that can contain list items.
+   */
   ListContainerNode: "listContainer",
+  /**
+   * Tags the extension as a list item node which can be contained by
+   * [[`ExtensionTag.ListNode`]].
+   */
   ListItemNode: "listItemNode",
+  /**
+   * Sets this as a block level node.
+   */
   Block: "block",
+  /**
+   * @deprecate use `ExtensionTags.Block` instead.
+   */
   BlockNode: "block",
+  /**
+   * Set this as a text block
+   */
   TextBlock: "textBlock",
+  /**
+   * A tag that excludes this from input rules.
+   */
   ExcludeInputRules: "excludeFromInputRules",
+  /**
+   * A mark or node that can't  be exited when at the end and beginning of the
+   * document with an arrow key or backspace key.
+   */
   PreventExits: "preventsExits",
+  /**
+   * Represents a media compatible node.
+   */
   Media: "media"
@@ -188,2 +272,1 @@ };
 };
-//# sourceMappingURL=remirror-core-constants.js.map

package.json

 {
   "name": "@remirror/core-constants",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "The core constants used throughout the remirror codebase",
@@ -19,5 +19,5 @@ "homepage": "https://github.com/remirror/remirror/tree/HEAD/packages/remirror__core-constants",
     ".": {
+      "types": "./dist/remirror-core-constants.d.ts",
       "import": "./dist/remirror-core-constants.js",
-      "require": "./dist/remirror-core-constants.cjs",
-      "types": "./dist-types/index.d.ts"
+      "require": "./dist/remirror-core-constants.cjs"
     },
@@ -28,3 +28,3 @@ "./package.json": "./package.json"
   "module": "./dist/remirror-core-constants.js",
-  "types": "./dist-types/index.d.ts",
+  "types": "./dist/remirror-core-constants.d.ts",
   "files": [
@@ -35,11 +35,7 @@ "dist",
   "dependencies": {
-    "@babel/runtime": "^7.13.10"
+    "@babel/runtime": "^7.21.0"
   },
-  "publishConfig": {
-    "access": "public"
-  },
   "@remirror": {
     "sizeLimit": "2 KB"
-  },
-  "readme": "# @remirror/core-constants\n\n> core constants used throughout the `remirror` codebase.\n\n[![Version][version]][npm] [![Weekly Downloads][downloads-badge]][npm] [![Bundled size][size-badge]][size] [![Typed Codebase][typescript]](#) [![MIT License][license]](#)\n\n[version]: https://flat.badgen.net/npm/v/@remirror/core-constants\n[npm]: https://npmjs.com/package/@remirror/core-constants\n[license]: https://flat.badgen.net/badge/license/MIT/purple\n[size]: https://bundlephobia.com/result?p=@remirror/core-constants\n[size-badge]: https://flat.badgen.net/bundlephobia/minzip/@remirror/core-constants\n[typescript]: https://flat.badgen.net/badge/icon/TypeScript?icon=typescript&label\n[downloads-badge]: https://badgen.net/npm/dw/@remirror/core-constants/red?icon=npm\n\n## Installation\n\nThis is included by default when you install the recommended `remirror` package. All exports are also available via `remirror/core/constants` and `remirror/core`.\n"
+  }
 }

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

Improved metrics

Lines of code

2004

increased by111.84%

Worsened metrics

Total package byte prevSize

82702

decreased by-5.14%

Dependency changes

• Updated@babel/runtime@^7.21.0