shelving 1.50.1 → 1.50.2

package/markup/render.d.ts

@@ -33,8 +33,3 @@ import type { MarkupOptions, MarkupNode } from "./types.js";
  * @returns ReactNode, i.e. either a complete `ReactElement`, `null`, `undefined`, `string`, or an array of zero or more of those.
  */
 export declare function renderMarkup(content: string, options?: Partial<MarkupOptions>): MarkupNode;
-/**
- * Parse a text string as user-generated markup.
- * - Like `renderMarkup()` but only enables a subset of rules and applies `rel="nofollow ugc"` to all links.
- */
-export declare function renderUgcMarkup(content: string, options?: Partial<MarkupOptions>): MarkupNode;

package/markup/render.js

@@ -1,6 +1,6 @@
 /* eslint-disable no-param-reassign */
 import { sanitizeLines } from "../index.js";
-import { MARKUP_RULES, MARKUP_RULES_UGC } from "./rules.js";
+import { MARKUP_RULES } from "./rules.js";
 /** Convert a string into an array of React nodes using a set of rules. */
 function renderString(content, options) {
     // If there's no context return the unmodified string.
@@ -154,15 +154,3 @@ const defaults = {
     rel: undefined,
     schemes: ["http:", "https:"],
 };
-/**
- * Parse a text string as user-generated markup.
- * - Like `renderMarkup()` but only enables a subset of rules and applies `rel="nofollow ugc"` to all links.
- */
-export function renderUgcMarkup(content, options) {
-    return renderString(sanitizeLines(content), { ...defaultsUgc, ...options });
-}
-const defaultsUgc = {
-    ...defaults,
-    rules: MARKUP_RULES_UGC,
-    rel: "nofollow ugc",
-};

package/markup/rules.d.ts

@@ -1,4 +1,115 @@
-import type { MarkupRule } from "./types.js";
+import type { MarkupRule, MarkupRuleMatcher } from "./types.js";
+export declare const getMarkupMatcher: (regexp: RegExp) => MarkupRuleMatcher;
+export declare const getMarkupBlockMatcher: (middle?: string, end?: string, start?: string) => MarkupRuleMatcher;
+export declare const getMarkupLineMatcher: (middle?: string, end?: string, start?: string) => MarkupRuleMatcher;
+export declare const getMarkupWrapMatcher: (chars: string, middle?: string) => MarkupRuleMatcher;
+/**
+ * Headings are single line only (don't allow multiline).
+ * - 1-6 hashes then 1+ spaces, then the title.
+ * - Same as Markdown syntax.
+ * - Markdown's underline syntax is not supported (for simplification).
+ */
+export declare const HEADING_RULE: MarkupRule;
+/**
+ * Horizontal rules
+ * - Same as Markdown syntax but also allows `•` bullet character (in addition to `-` dash, `+` plus, `*` asterisk, and `_` underscore).
+ * - Character must be repeated three (or more) times.
+ * - Character must be the same every time (can't mix)
+ * - Might have infinite number of spaces between the characters.
+ */
+export declare const HORIZONTAL_RULE: MarkupRule;
+export declare const UNORDERED_LIST_RULE: MarkupRule;
+export declare const ORDERED_LIST_RULE: MarkupRule;
+/**
+ * Blockquote block.
+ * - Same as Markdown's syntax.
+ * - Block continues until it finds a line that doesn't start with `>`
+ * - Quote indent symbol can be followed by zero or more spaces.
+ */
+export declare const BLOCKQUOTE_RULE: MarkupRule;
+/**
+ * Fenced code blocks
+ * - Same as Markdown syntax.
+ * - Closing fence must be exactly the same as the opening fence, and can be made of at least three "```" backticks or three `~~~` tildes.
+ * - If there's no closing fence the code block will run to the end of the current string.
+ * - Markdown-style four-space indent syntax is not supported (only fenced code, since it's easier to use).
+ */
+export declare const FENCED_CODE_RULE: MarkupRule;
+/**
+ * Paragraph.
+ * - When ordering rules, paragraph should go after other "block" context elements (because it has a very generous capture).
+ */
+export declare const PARAGRAPH_RULE: MarkupRule;
+/**
+ * Markdown-style link.
+ * - Link in standard Markdown format, e.g. `[http://google.com/maps](Google Maps)`
+ * - If no title is specified a cleaned up version of the URL will be used, e.g. `google.com/maps`
+ * - Does not need space before/after the link.
+ * - If link is not valid (using `new URL(url)` then unparsed text will be returned.
+ * - For security only `http://` or `https://` links will work (if invalid the unparsed text will be returned).
+ */
+export declare const LINK_MARKUP: MarkupRule;
+/**
+ * Autolinked URL starts with `http:` or `https:` and matches an unlimited number of non-space characters.
+ * - If followed by space and then text in `()` round or `[]` square brackets that will be used as the title, e.g. `http://google.com/maps (Google Maps)` or `http://google.com/maps [Google Maps]` (this syntax is from Todoist and maybe other things too).
+ * - If no title is specified a cleaned up version of the URL will be used, e.g. `google.com/maps`
+ * - If link is not valid (using `new URL(url)` then unparsed text will be returned.
+ * - For security only schemes that appear in the `options.schemes` will match (defaults to `http:` and `https:`).
+ */
+export declare const AUTOLINK_RULE: MarkupRule;
+/**
+ * Inline code.
+ * - Text surrounded by one or more "`" backtick tilde characters.
+ * - Unlike strong/emphasis first or last character of the element can be space, (e.g. `- abc -` will not work).
+ * - Closing characters must exactly match opening characters.
+ * - Same as Markdown syntax.
+ */
+export declare const CODE_RULE: MarkupRule;
+/**
+ * Inline strong.
+ * - Inline text wrapped in one or more `*` asterisks.
+ * - Must be surrounded by space (e.g. ` *abc* `) — so formatting cannot be applied inside a word (e.g. `a*b*c`).
+ * - Whitespace cannot be the first or last character of the element (e.g. `* abc *` will not work).
+ * - Closing characters must exactly match opening characters.
+ * - Different to Markdown: strong is always surrounded by `*asterisks*` and emphasis is always surrounded by `_underscores_` (strong isn't 'double emphasis').
+ */
+export declare const STRONG_MARKUP: MarkupRule;
+/**
+ * Inline emphasis.
+ * - Inline text wrapped in one or more `_` underscore symbols.
+ * - Works inside words (e.g. `magi_carp_carp`).
+ * - Whitespace cannot be the first or last character of the element (e.g. `_ abc _` will not work).
+ * - Closing characters must exactly match opening characters.
+ * - Different to Markdown: strong is always surrounded by `*asterisks*` and emphasis is always surrounded by `_underscores_` (strong isn't 'double emphasis').
+ */
+export declare const EMPHASIS_RULE: MarkupRule;
+/**
+ * Inserted text (`<ins>` tag),
+ * - Inline text wrapped in two or more `++` pluses.
+ * - Works inside words (e.g. `magi+karp+carp`).
+ * - Whitespace cannot be the first or last character of the element (e.g. `+ abc +` will not work).
+ * - Closing characters must exactly match opening characters.
+ * - Markdown doesn't have this.
+ */
+export declare const INSERT_RULE: MarkupRule;
+/**
+ * Deleted text (`<del>` tag),
+ * - Inline text wrapped in two or more `--` hyphens or `~~` tildes.
+ * - Works inside words (e.g. `magi--karp--carp`).
+ * - Whitespace cannot be the first or last character of the element (e.g. `-- abc --` will not work).
+ * - Closing characters must exactly match opening characters.
+ * - Markdown doesn't have this.
+ */
+export declare const DELETE_RULE: MarkupRule;
+/**
+ * Hard linebreak (`<br />` tag).
+ * - Any line break in a paragraph will become a hard `<br />` tag.
+ * - Different to Markdown:
+ *   - Markdown needs two spaces at the end of a line, any line break in a paragraph will be a `<br />` tag (lines without two spaces are not joined together).
+ *   - This is more intuitive (a linebreak becomes a linebreak is isn't silently ignored).
+ *   - This works better with textareas that wrap text (since manually breaking up long lines is no longer necessary).
+ */
+export declare const LINEBREAK_RULE: MarkupRule;
 /**
  * All markup rules.
  * - Syntax parsed by `renderMarkup()` is defined entirely by the list of rules (i.e. not by code).
@@ -9,5 +120,9 @@ import type { MarkupRule } from "./types.js";
  * - HTML tags and character entities are never allowed (our use cases generally require a locked-down subset of syntax).
  */
 export declare const MARKUP_RULES: MarkupRule[];
-/** Default markup rules for user-generated-content rendering. */
-export declare const MARKUP_RULES_UGC: MarkupRule[];
+/** Subset of markup rules that work in a block context. */
+export declare const MARKUP_RULES_BLOCK: MarkupRule[];
+/** Subset of markup rules that work in an inline context. */
+export declare const MARKUP_RULES_INLINE: MarkupRule[];
+/** Subset of markup rules that are relevant for collapsed shortform content. */
+export declare const MARKUP_RULES_SHORTFORM: MarkupRule[];

package/markup/rules.js

@@ -11,10 +11,10 @@ const WORDS = `\\S(?:[\\s\\S]*?\\S)?`; // Run of text that starts and ends with
 // Regular expressions.
 const REPLACE_INDENT = /^ {1,2}/gm;
 // Regular expression makers.
-const getMatcher = regexp => content => content.match(regexp);
-const getBlockMatcher = (middle = BLOCK, end = BLOCK_END, start = BLOCK_START) => getMatcher(new RegExp(`(?:${start})${middle}(?:${end})`));
-const getLineMatcher = (middle = LINE, end = LINE_END, start = LINE_START) => getMatcher(new RegExp(`(?:${start})${middle}(?:${end})`));
-const getWrapMatcher = (chars, middle = WORDS) => {
+export const getMarkupMatcher = regexp => content => content.match(regexp);
+export const getMarkupBlockMatcher = (middle = BLOCK, end = BLOCK_END, start = BLOCK_START) => getMarkupMatcher(new RegExp(`(?:${start})${middle}(?:${end})`));
+export const getMarkupLineMatcher = (middle = LINE, end = LINE_END, start = LINE_START) => getMarkupMatcher(new RegExp(`(?:${start})${middle}(?:${end})`));
+export const getMarkupWrapMatcher = (chars, middle = WORDS) => {
     const regexp = new RegExp(`(${chars})(${middle})\\1`);
     return content => content.match(regexp);
 };
@@ -24,8 +24,8 @@ const getWrapMatcher = (chars, middle = WORDS) => {
  * - Same as Markdown syntax.
  * - Markdown's underline syntax is not supported (for simplification).
  */
-const HEADING = {
-    match: getLineMatcher(`(#{1,6}) +(${LINE})`),
+export const HEADING_RULE = {
+    match: getMarkupLineMatcher(`(#{1,6}) +(${LINE})`),
     render: ([, prefix = "", children = ""]) => ({ type: `h${prefix.length}`, key: null, props: { children } }),
     contexts: ["block"],
     childContext: "inline",
@@ -37,8 +37,8 @@ const HEADING = {
  * - Character must be the same every time (can't mix)
  * - Might have infinite number of spaces between the characters.
  */
-const HR = {
-    match: getLineMatcher(`([${BULLETS}])(?: *\\1){2,}`),
+export const HORIZONTAL_RULE = {
+    match: getMarkupLineMatcher(`([${BULLETS}])(?: *\\1){2,}`),
     render: () => ({ type: "hr", key: null, props: {} }),
     contexts: ["block"],
 };
@@ -50,8 +50,8 @@ const HR = {
  * - Second-level list can be indented with 1-2 spaces.
  */
 const UNORDERED = `[${BULLETS}] +`; // Anything that can be a bullet (used for unordered lists and horizontal rules).
-const UL = {
-    match: getBlockMatcher(`${UNORDERED}(${BLOCK})`),
+export const UNORDERED_LIST_RULE = {
+    match: getMarkupBlockMatcher(`${UNORDERED}(${BLOCK})`),
     render: ([, list = ""]) => {
         const children = list.split(SPLIT_UL_ITEMS).map(mapUnorderedItem);
         return { type: "ul", key: null, props: { children } };
@@ -70,8 +70,8 @@ const mapUnorderedItem = (item, key) => {
  * - Second-level list can be indented with 1-3 spaces.
  */
 const ORDERED = "[0-9]+[.):] +"; // Number for a numbered list (e.g. `1.` or `2)` or `3:`)
-const OL = {
-    match: getBlockMatcher(`(${ORDERED}${BLOCK})`),
+export const ORDERED_LIST_RULE = {
+    match: getMarkupBlockMatcher(`(${ORDERED}${BLOCK})`),
     render: ([, list = ""]) => {
         const children = list.split(SPLIT_OL_ITEMS).map(mapOrderedItem);
         return { type: "ol", key: null, props: { children } };
@@ -95,8 +95,8 @@ const mapOrderedItem = (item, key) => {
  * - Block continues until it finds a line that doesn't start with `>`
  * - Quote indent symbol can be followed by zero or more spaces.
  */
-const BLOCKQUOTE = {
-    match: getLineMatcher(`(>${LINE}(?:\\n>${LINE})*)`),
+export const BLOCKQUOTE_RULE = {
+    match: getMarkupLineMatcher(`(>${LINE}(?:\\n>${LINE})*)`),
     render: ([, quote = ""]) => ({
         type: "blockquote",
         key: null,
@@ -113,9 +113,9 @@ const BLOCKQUOTE_LINES = /^>/gm;
  * - If there's no closing fence the code block will run to the end of the current string.
  * - Markdown-style four-space indent syntax is not supported (only fenced code, since it's easier to use).
  */
-const FENCED = {
+export const FENCED_CODE_RULE = {
     // Matcher has its own end that only stops when it reaches a matching closing fence or the end of the string.
-    match: getBlockMatcher(`(\`{3,}|~{3,}) *(${LINE})\\n(${BLOCK})`, `\\n\\1\\n+|\\n\\1$|$`),
+    match: getMarkupBlockMatcher(`(\`{3,}|~{3,}) *(${LINE})\\n(${BLOCK})`, `\\n\\1\\n+|\\n\\1$|$`),
     render: ([, , file, children]) => ({
         type: "pre",
         key: null,
@@ -133,8 +133,8 @@ const FENCED = {
  * Paragraph.
  * - When ordering rules, paragraph should go after other "block" context elements (because it has a very generous capture).
  */
-const PARAGRAPH = {
-    match: getBlockMatcher(` *(${BLOCK})`),
+export const PARAGRAPH_RULE = {
+    match: getMarkupBlockMatcher(` *(${BLOCK})`),
     render: ([, children]) => ({ type: `p`, key: null, props: { children } }),
     contexts: ["block"],
     childContext: "inline",
@@ -148,7 +148,7 @@ const PARAGRAPH = {
  * - If link is not valid (using `new URL(url)` then unparsed text will be returned.
  * - For security only `http://` or `https://` links will work (if invalid the unparsed text will be returned).
  */
-const LINK = {
+export const LINK_MARKUP = {
     // Custom matcher to check the URL against the allowed schemes.
     match: (content, { schemes, url: base }) => {
         const matches = content.match(MATCH_LINK);
@@ -178,7 +178,7 @@ const MATCH_LINK = /\[([^\]]*?)\]\(([^)]*?)\)/;
  * - If link is not valid (using `new URL(url)` then unparsed text will be returned.
  * - For security only schemes that appear in the `options.schemes` will match (defaults to `http:` and `https:`).
  */
-const AUTOLINK = {
+export const AUTOLINK_RULE = {
     // Custom matcher to check the URL against the allowed schemes.
     match: (content, { schemes, url: base }) => {
         const matches = content.match(MATCH_AUTOLINK);
@@ -192,7 +192,7 @@ const AUTOLINK = {
             }
         }
     },
-    render: LINK.render,
+    render: LINK_MARKUP.render,
     contexts: ["inline", "list"],
     childContext: "link",
 };
@@ -204,8 +204,8 @@ const MATCH_AUTOLINK = /([a-z][a-z0-9-]*[a-z0-9]:\S+)(?: +(?:\(([^)]*?)\)|\[([^\
  * - Closing characters must exactly match opening characters.
  * - Same as Markdown syntax.
  */
-const CODE = {
-    match: getWrapMatcher("`+", BLOCK),
+export const CODE_RULE = {
+    match: getMarkupWrapMatcher("`+", BLOCK),
     render: ([, , children]) => ({ type: "code", key: null, props: { children } }),
     contexts: ["inline", "list"],
     priority: 10, // Higher priority than other inlines so it matches first before e.g. `strong` or `em` (from CommonMark spec: "Code span backticks have higher precedence than any other inline constructs except HTML tags and autolinks.")
@@ -218,8 +218,8 @@ const CODE = {
  * - Closing characters must exactly match opening characters.
  * - Different to Markdown: strong is always surrounded by `*asterisks*` and emphasis is always surrounded by `_underscores_` (strong isn't 'double emphasis').
  */
-const STRONG = {
-    match: getWrapMatcher("\\*+"),
+export const STRONG_MARKUP = {
+    match: getMarkupWrapMatcher("\\*+"),
     render: ([, , children]) => ({ type: "strong", key: null, props: { children } }),
     contexts: ["inline", "list", "link"],
     childContext: "inline",
@@ -232,36 +232,36 @@ const STRONG = {
  * - Closing characters must exactly match opening characters.
  * - Different to Markdown: strong is always surrounded by `*asterisks*` and emphasis is always surrounded by `_underscores_` (strong isn't 'double emphasis').
  */
-const EM = {
-    match: getWrapMatcher("_+"),
+export const EMPHASIS_RULE = {
+    match: getMarkupWrapMatcher("_+"),
     render: ([, , children]) => ({ type: "em", key: null, props: { children } }),
     contexts: ["inline", "list", "link"],
     childContext: "inline",
 };
 /**
  * Inserted text (`<ins>` tag),
- * - Inline text wrapped in one or more `+` pluses.
+ * - Inline text wrapped in two or more `++` pluses.
  * - Works inside words (e.g. `magi+karp+carp`).
  * - Whitespace cannot be the first or last character of the element (e.g. `+ abc +` will not work).
  * - Closing characters must exactly match opening characters.
  * - Markdown doesn't have this.
  */
-const INS = {
-    match: getWrapMatcher("\\++"),
+export const INSERT_RULE = {
+    match: getMarkupWrapMatcher("\\+\\++"),
     render: ([, , children]) => ({ type: "ins", key: null, props: { children } }),
     contexts: ["inline", "list", "link"],
     childContext: "inline",
 };
 /**
  * Deleted text (`<del>` tag),
- * - Inline text wrapped in one or more `~` tildes.
- * - Works inside words (e.g. `magi~karp~carp`).
- * - Whitespace cannot be the first or last character of the element (e.g. `~ abc ~` will not work).
+ * - Inline text wrapped in two or more `--` hyphens or `~~` tildes.
+ * - Works inside words (e.g. `magi--karp--carp`).
+ * - Whitespace cannot be the first or last character of the element (e.g. `-- abc --` will not work).
  * - Closing characters must exactly match opening characters.
  * - Markdown doesn't have this.
  */
-const DEL = {
-    match: getWrapMatcher("~+"),
+export const DELETE_RULE = {
+    match: getMarkupWrapMatcher("--+|~~+"),
     render: ([, , children]) => ({ type: "del", key: null, props: { children } }),
     contexts: ["inline", "list", "link"],
     childContext: "inline",
@@ -274,8 +274,8 @@ const DEL = {
  *   - This is more intuitive (a linebreak becomes a linebreak is isn't silently ignored).
  *   - This works better with textareas that wrap text (since manually breaking up long lines is no longer necessary).
  */
-const BR = {
-    match: getMatcher(/\n/),
+export const LINEBREAK_RULE = {
+    match: getMarkupMatcher(/\n/),
     render: () => ({ type: "br", key: null, props: {} }),
     contexts: ["inline", "list", "link"],
     childContext: "inline",
@@ -289,6 +289,55 @@ const BR = {
  *   3. more aligned with smaller textboxes and editors that have line wrapping
  * - HTML tags and character entities are never allowed (our use cases generally require a locked-down subset of syntax).
  */
-export const MARKUP_RULES = [HEADING, HR, UL, OL, BLOCKQUOTE, FENCED, PARAGRAPH, LINK, AUTOLINK, CODE, STRONG, EM, INS, DEL, BR];
-/** Default markup rules for user-generated-content rendering. */
-export const MARKUP_RULES_UGC = [UL, OL, PARAGRAPH, LINK, AUTOLINK, CODE, STRONG, EM, INS, DEL, BR];
+export const MARKUP_RULES = [
+    HEADING_RULE,
+    HORIZONTAL_RULE,
+    UNORDERED_LIST_RULE,
+    ORDERED_LIST_RULE,
+    BLOCKQUOTE_RULE,
+    FENCED_CODE_RULE,
+    PARAGRAPH_RULE,
+    LINK_MARKUP,
+    AUTOLINK_RULE,
+    CODE_RULE,
+    STRONG_MARKUP,
+    EMPHASIS_RULE,
+    INSERT_RULE,
+    DELETE_RULE,
+    LINEBREAK_RULE,
+];
+/** Subset of markup rules that work in a block context. */
+export const MARKUP_RULES_BLOCK = [
+    HEADING_RULE,
+    HORIZONTAL_RULE,
+    UNORDERED_LIST_RULE,
+    ORDERED_LIST_RULE,
+    BLOCKQUOTE_RULE,
+    FENCED_CODE_RULE,
+    PARAGRAPH_RULE,
+];
+/** Subset of markup rules that work in an inline context. */
+export const MARKUP_RULES_INLINE = [
+    LINK_MARKUP,
+    AUTOLINK_RULE,
+    CODE_RULE,
+    STRONG_MARKUP,
+    EMPHASIS_RULE,
+    INSERT_RULE,
+    DELETE_RULE,
+    LINEBREAK_RULE,
+];
+/** Subset of markup rules that are relevant for collapsed shortform content. */
+export const MARKUP_RULES_SHORTFORM = [
+    UNORDERED_LIST_RULE,
+    ORDERED_LIST_RULE,
+    PARAGRAPH_RULE,
+    LINK_MARKUP,
+    AUTOLINK_RULE,
+    CODE_RULE,
+    STRONG_MARKUP,
+    EMPHASIS_RULE,
+    INSERT_RULE,
+    DELETE_RULE,
+    LINEBREAK_RULE,
+];

package/package.json

@@ -11,7 +11,7 @@
 		"state-management",
 		"query-builder"
 	],
-	"version": "1.50.1",
+	"version": "1.50.2",
 	"repository": "https://github.com/dhoulb/shelving",
 	"author": "Dave Houlbrooke <dave@shax.com>",
 	"license": "0BSD",