prosemirror-schema-basic 1.2.1 → 1.2.3

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 1.2.3 (2024-07-14)
+
+### Bug fixes
+
+Add attribute type validation for headings, images, and link marks.
+
+## 1.2.2 (2023-05-17)
+
+### Bug fixes
+
+Include CommonJS type declarations in the package to please new TypeScript resolution settings.
+
 ## 1.2.1 (2023-01-18)
 
 ### Bug fixes

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (C) 2015-2017 by Marijn Haverbeke <marijnh@gmail.com> and others
+Copyright (C) 2015-2017 by Marijn Haverbeke <marijn@haverbeke.berlin> and others
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/dist/index.cjs

@@ -1,16 +1,11 @@
 'use strict';
 
-Object.defineProperty(exports, '__esModule', {
-  value: true
-});
-
 var prosemirrorModel = require('prosemirror-model');
-
 var pDOM = ["p", 0],
-    blockquoteDOM = ["blockquote", 0],
-    hrDOM = ["hr"],
-    preDOM = ["pre", ["code", 0]],
-    brDOM = ["br"];
+  blockquoteDOM = ["blockquote", 0],
+  hrDOM = ["hr"],
+  preDOM = ["pre", ["code", 0]],
+  brDOM = ["br"];
 var nodes = {
   doc: {
     content: "block+"
@@ -48,7 +43,8 @@ var nodes = {
   heading: {
     attrs: {
       level: {
-        "default": 1
+        "default": 1,
+        validate: "number"
       }
     },
     content: "inline*",
@@ -109,12 +105,16 @@ var nodes = {
   image: {
     inline: true,
     attrs: {
-      src: {},
+      src: {
+        validate: "string"
+      },
       alt: {
-        "default": null
+        "default": null,
+        validate: "string|null"
       },
       title: {
-        "default": null
+        "default": null,
+        validate: "string|null"
       }
     },
     group: "inline",
@@ -131,9 +131,9 @@ var nodes = {
     }],
     toDOM: function toDOM(node) {
       var _node$attrs = node.attrs,
-          src = _node$attrs.src,
-          alt = _node$attrs.alt,
-          title = _node$attrs.title;
+        src = _node$attrs.src,
+        alt = _node$attrs.alt,
+        title = _node$attrs.title;
       return ["img", {
         src: src,
         alt: alt,
@@ -154,14 +154,17 @@ var nodes = {
   }
 };
 var emDOM = ["em", 0],
-    strongDOM = ["strong", 0],
-    codeDOM = ["code", 0];
+  strongDOM = ["strong", 0],
+  codeDOM = ["code", 0];
 var marks = {
   link: {
     attrs: {
-      href: {},
+      href: {
+        validate: "string"
+      },
       title: {
-        "default": null
+        "default": null,
+        validate: "string|null"
       }
     },
     inclusive: false,
@@ -176,8 +179,8 @@ var marks = {
     }],
     toDOM: function toDOM(node) {
       var _node$attrs2 = node.attrs,
-          href = _node$attrs2.href,
-          title = _node$attrs2.title;
+        href = _node$attrs2.href,
+        title = _node$attrs2.title;
       return ["a", {
         href: href,
         title: title

package/dist/index.d.cts

@@ -0,0 +1,87 @@
+import { NodeSpec, MarkSpec, Schema } from 'prosemirror-model';
+
+/**
+[Specs](https://prosemirror.net/docs/ref/#model.NodeSpec) for the nodes defined in this schema.
+*/
+declare const nodes: {
+    /**
+    NodeSpec The top level document node.
+    */
+    doc: NodeSpec;
+    /**
+    A plain paragraph textblock. Represented in the DOM
+    as a `<p>` element.
+    */
+    paragraph: NodeSpec;
+    /**
+    A blockquote (`<blockquote>`) wrapping one or more blocks.
+    */
+    blockquote: NodeSpec;
+    /**
+    A horizontal rule (`<hr>`).
+    */
+    horizontal_rule: NodeSpec;
+    /**
+    A heading textblock, with a `level` attribute that
+    should hold the number 1 to 6. Parsed and serialized as `<h1>` to
+    `<h6>` elements.
+    */
+    heading: NodeSpec;
+    /**
+    A code listing. Disallows marks or non-text inline
+    nodes by default. Represented as a `<pre>` element with a
+    `<code>` element inside of it.
+    */
+    code_block: NodeSpec;
+    /**
+    The text node.
+    */
+    text: NodeSpec;
+    /**
+    An inline image (`<img>`) node. Supports `src`,
+    `alt`, and `href` attributes. The latter two default to the empty
+    string.
+    */
+    image: NodeSpec;
+    /**
+    A hard line break, represented in the DOM as `<br>`.
+    */
+    hard_break: NodeSpec;
+};
+/**
+[Specs](https://prosemirror.net/docs/ref/#model.MarkSpec) for the marks in the schema.
+*/
+declare const marks: {
+    /**
+    A link. Has `href` and `title` attributes. `title`
+    defaults to the empty string. Rendered and parsed as an `<a>`
+    element.
+    */
+    link: MarkSpec;
+    /**
+    An emphasis mark. Rendered as an `<em>` element. Has parse rules
+    that also match `<i>` and `font-style: italic`.
+    */
+    em: MarkSpec;
+    /**
+    A strong mark. Rendered as `<strong>`, parse rules also match
+    `<b>` and `font-weight: bold`.
+    */
+    strong: MarkSpec;
+    /**
+    Code font mark. Represented as a `<code>` element.
+    */
+    code: MarkSpec;
+};
+/**
+This schema roughly corresponds to the document schema used by
+[CommonMark](http://commonmark.org/), minus the list elements,
+which are defined in the [`prosemirror-schema-list`](https://prosemirror.net/docs/ref/#schema-list)
+module.
+
+To reuse elements from this schema, extend or read from its
+`spec.nodes` and `spec.marks` [properties](https://prosemirror.net/docs/ref/#model.Schema.spec).
+*/
+declare const schema: Schema<"blockquote" | "image" | "text" | "doc" | "paragraph" | "horizontal_rule" | "heading" | "code_block" | "hard_break", "link" | "code" | "em" | "strong">;
+
+export { marks, nodes, schema };

package/dist/index.js

@@ -45,7 +45,7 @@ const nodes = {
     `<h6>` elements.
     */
     heading: {
-        attrs: { level: { default: 1 } },
+        attrs: { level: { default: 1, validate: "number" } },
         content: "inline*",
         group: "block",
         defining: true,
@@ -85,9 +85,9 @@ const nodes = {
     image: {
         inline: true,
         attrs: {
-            src: {},
-            alt: { default: null },
-            title: { default: null }
+            src: { validate: "string" },
+            alt: { default: null, validate: "string|null" },
+            title: { default: null, validate: "string|null" }
         },
         group: "inline",
         draggable: true,
@@ -123,8 +123,8 @@ const marks = {
     */
     link: {
         attrs: {
-            href: {},
-            title: { default: null }
+            href: { validate: "string" },
+            title: { default: null, validate: "string|null" }
         },
         inclusive: false,
         parseDOM: [{ tag: "a[href]", getAttrs(dom) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prosemirror-schema-basic",
-  "version": "1.2.1",
+  "version": "1.2.3",
   "description": "Basic schema elements for ProseMirror",
   "type": "module",
   "main": "dist/index.cjs",
@@ -15,7 +15,7 @@
   "maintainers": [
     {
       "name": "Marijn Haverbeke",
-      "email": "marijnh@gmail.com",
+      "email": "marijn@haverbeke.berlin",
       "web": "http://marijnhaverbeke.nl"
     }
   ],

package/src/schema-basic.ts

@@ -40,7 +40,7 @@ export const nodes = {
   /// should hold the number 1 to 6. Parsed and serialized as `<h1>` to
   /// `<h6>` elements.
   heading: {
-    attrs: {level: {default: 1}},
+    attrs: {level: {default: 1, validate: "number"}},
     content: "inline*",
     group: "block",
     defining: true,
@@ -77,9 +77,9 @@ export const nodes = {
   image: {
     inline: true,
     attrs: {
-      src: {},
-      alt: {default: null},
-      title: {default: null}
+      src: {validate: "string"},
+      alt: {default: null, validate: "string|null"},
+      title: {default: null, validate: "string|null"}
     },
     group: "inline",
     draggable: true,
@@ -112,8 +112,8 @@ export const marks = {
   /// element.
   link: {
     attrs: {
-      href: {},
-      title: {default: null}
+      href: {validate: "string"},
+      title: {default: null, validate: "string|null"}
     },
     inclusive: false,
     parseDOM: [{tag: "a[href]", getAttrs(dom: HTMLElement) {