libp2r2p 0.10.14 → 0.10.15

package/README.md

@@ -378,6 +378,29 @@ plus NIP-05 in its standard, root and custom compact spellings.
 reads the file/media metadata carried in a URL fragment
 (`#m=image/png&dim=640x480&...`).
 
+`compactWhitespace(text, options?)` is also exported from `libp2r2p/nip27` as an
+opt-in display helper. It removes carriage returns, collapses spaces and
+tabs, removes spaces around line breaks, limits consecutive line breaks to
+two, keeps the first eight line breaks (replacing subsequent runs with a
+space), and trims the result. Empty strings are accepted; non-string inputs
+throw `ValidationError` with code `INVALID_WHITESPACE_TEXT`. It is not
+applied automatically by `extractMedia()`.
+
+The option `maxLineBreaks` (default `8`) sets the total limit and accepts a
+non-negative safe integer. Setting it to `0` replaces all line-break runs
+with spaces. `consecutiveLineBreakThreshold` (default `3`) sets the minimum
+run length that collapses to **two** line breaks; shorter runs are preserved.
+It accepts safe integers of at least `3`. Either option accepts `Infinity`
+to disable its rule. Runs are collapsed before applying the total limit,
+and trimming happens last. Invalid options throw `ValidationError` with
+code `INVALID_WHITESPACE_OPTIONS`.
+
+```js
+import { compactWhitespace } from 'libp2r2p/nip27'
+
+compactWhitespace(text, { maxLineBreaks: 12, consecutiveLineBreakThreshold: 5 })
+```
+
 User references (`npub`, `nprofile`, hex pubkeys and every NIP-05 spelling)
 are handled by `libp2r2p/nip27`: `decodeUserReference()` returns the decoded
 form with its canonical compact spelling, `encodeUserReference()` returns

package/nip27/helpers/compact-whitespace.js

@@ -0,0 +1,33 @@
+import { ValidationError } from '../../error/index.js'
+
+// Compacts display text, defaulting to collapsing runs of three or more line
+// breaks to two and keeping eight overall. extractMedia preserves input.
+export function compactWhitespace (text, options = {}) {
+  if (typeof text !== 'string') {
+    throw new ValidationError('INVALID_WHITESPACE_TEXT', { message: 'TEXT_SHOULD_BE_A_STRING' })
+  }
+
+  if (!options || typeof options !== 'object' || Array.isArray(options)) {
+    throw new ValidationError('INVALID_WHITESPACE_OPTIONS', { message: 'OPTIONS_SHOULD_BE_AN_OBJECT' })
+  }
+  const { maxLineBreaks = 8, consecutiveLineBreakThreshold = 3 } = options
+  if (maxLineBreaks !== Infinity && (!Number.isSafeInteger(maxLineBreaks) || maxLineBreaks < 0)) {
+    throw new ValidationError('INVALID_WHITESPACE_OPTIONS', { message: 'MAX_LINE_BREAKS_SHOULD_BE_A_NON_NEGATIVE_SAFE_INTEGER_OR_INFINITY' })
+  }
+  if (consecutiveLineBreakThreshold !== Infinity && (!Number.isSafeInteger(consecutiveLineBreakThreshold) || consecutiveLineBreakThreshold < 3)) {
+    throw new ValidationError('INVALID_WHITESPACE_OPTIONS', { message: 'CONSECUTIVE_LINE_BREAK_THRESHOLD_SHOULD_BE_A_SAFE_INTEGER_AT_LEAST_THREE_OR_INFINITY' })
+  }
+
+  let remainingLineBreaks = maxLineBreaks
+  return text
+    .replace(/\r/g, '')
+    .replace(/[\t ]+/g, ' ')
+    .replace(/ ?\n ?/g, '\n')
+    .replace(/\n+/g, lineBreaks => {
+      const consecutive = lineBreaks.length >= consecutiveLineBreakThreshold ? 2 : lineBreaks.length
+      const kept = Math.min(remainingLineBreaks, consecutive)
+      remainingLineBreaks -= kept
+      return lineBreaks.slice(0, kept) + (kept < consecutive ? ' ' : '')
+    })
+    .trim()
+}

package/nip27/index.js

@@ -14,6 +14,7 @@ import {
 } from './helpers/user-reference.js'
 
 export { decodeUserReference, encodeUserReference, tryDecodeUserReference }
+export { compactWhitespace } from './helpers/compact-whitespace.js'
 
 const BECH32_BODY = '[ac-hj-np-z02-9]'
 const BOUNDARY_PREFIX = /(?<=^|[\s"«„「¡¿:{([])/.source

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "libp2r2p",
-  "version": "0.10.14",
+  "version": "0.10.15",
   "description": "Peer-to-relay-to-peer",
   "keywords": [
     "p2r2p",