libp2r2p 0.10.14 → 0.10.16

package/README.md

@@ -371,13 +371,84 @@ event. Their `assert…` counterparts return the original event or throw a
 `ValidationError` with a stable code.
 
 NIP-27 text references live in `libp2r2p/nip27`. `extractMedia()` splits
-content into text, URL, profile, event, relay, NIP-05 and hashtag items in
+content into text, URL, profile, event, relay, NIP-05, app and hashtag items in
 occurrence order, accepting the optional `@` and `nostr:` mention prefixes
 plus NIP-05 in its standard, root and custom compact spellings.
 `decodeReference()` parses a single reference, and `decodeMediaMetadata()`
 reads the file/media metadata carried in a URL fragment
 (`#m=image/png&dim=640x480&...`).
 
+App references are a library extension to NIP-27. `extractMedia()` recognizes
+encoded `+…` app entities and named references such as `+hallway@fiatjaf.com`,
+`++myapp@bob@example.com` and `+++myapp@npub1…`, with optional `nostr:` before
+the entire reference. Named authors accept the NIP-05 spellings above, `npub`,
+`nprofile` and hex pubkeys; app names may be URL-encoded. The one-to-three `+`
+prefix selects `main`, `next` or `draft` respectively.
+
+Bare app names use the `defaultAppAuthor` option, which defaults to
+`'44billion.net'`: `+apps` identifies the same app as `+apps@44billion.net`.
+The option accepts a NIP-05 reference (including compact spellings), `npub`,
+`nprofile` or hex pubkey and is validated locally on every call. An invalid
+value throws `ValidationError` with code `INVALID_DEFAULT_APP_AUTHOR`.
+Explicit authors and encoded app entities are never overridden. Malformed
+explicit authors remain text instead of falling back to the default.
+
+```js
+extractMedia('+apps', { defaultAppAuthor: 'bob@example.com' })
+// app.user: { type: 'nip05', local: 'bob', domain: 'example.com', raw: 'bob.example.com' }
+// app.original remains '+apps'.
+```
+
+These references produce `{ key: 'app', app: { original, ...decoded } }`, where
+`decoded` is the result of `decodeAppUrl()` from `libp2r2p/url`, with a missing
+named author filled from `defaultAppAuthor` as described above. Named apps
+include `type: 'named'`, `prefix`, `channel`, `appName` (the manifest's `d` tag)
+and the decoded `user`; entities include `type: 'entity'` and `entity`, usable
+with `appDecode()` from `libp2r2p/nip19`. Extraction performs no network lookup
+and does not verify that the app exists. For example:
+
+```js
+extractMedia('Open nostr:++myapp@bob@example.com')
+// [
+//   { key: 'text', text: { value: 'Open ' } },
+//   { key: 'app', app: {
+//     original: 'nostr:++myapp@bob@example.com', type: 'named',
+//     prefix: '++', channel: 'next', appName: 'myapp',
+//     user: { type: 'nip05', local: 'bob', domain: 'example.com', raw: 'bob.example.com' }
+//   } }
+// ]
+```
+
+App references must be standalone inline tokens, not concatenated to event
+pointers or embedded in URL paths. Invalid app candidates remain text.
+Bare names can use letters, numbers, dots, underscores, hyphens and tildes;
+URL-encode spaces, `@` and other punctuation in them.
+`+naddr1…` is recognized as an app only for site-manifest kinds; unprefixed
+`naddr1…` and `nostr:naddr1…` keep their existing `event` item shape.
+
+`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

@@ -1,12 +1,13 @@
 import { ValidationError } from '../error/index.js'
 import {
+  NAPP_ENTITY_REGEX,
   naddrDecode,
   neventDecode,
   noteDecode,
   nrelayDecode
 } from '../nip19/index.js'
 import { queryProfile } from '../nip05/index.js'
-import { normalizeRelayUrl } from '../url/index.js'
+import { normalizeRelayUrl, tryDecodeAppUrl } from '../url/index.js'
 import {
   decodeUserReference,
   encodeUserReference,
@@ -14,6 +15,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
@@ -36,6 +38,15 @@ const NIP05_AT_CUSTOM = `@(?<nip05AtCustom>${NIP05_LOCAL}\\.${NIP05_DOMAIN})`
 const NIP05_BARE_ROOT = '(?<nip05BareRoot>[a-z0-9-]+\\.[a-z]{2,63})'
 const NIP05_BARE_CUSTOM = `(?<nip05BareCustom>${NIP05_LOCAL}\\.${NIP05_DOMAIN})`
 
+// App references are a library extension. Names may contain punctuation, but
+// author spellings and encoded entities delimit the token. decodeAppUrl owns
+// validation. Literal + inside a name must be encoded, so a named candidate
+// cannot consume a neighboring app reference. Prose punctuation stays outside.
+const APP_SOURCE = '(?:nostr:)?(?<app>' +
+  NAPP_ENTITY_REGEX.source.slice(1, -1) + '|' +
+  /\+{1,3}[^\s/<>+]+?@[a-zA-Z0-9._%@-]*[a-zA-Z0-9]/.source + '|' +
+  /\+{1,3}[\p{L}\p{N}._%~-]*[\p{L}\p{N}_%~-]/.source + ')'
+
 function entitySource (name) {
   const bodyLength = name === 'npub' ? '58' : (name === 'nrelay' ? '10,5000' : '58,5000')
   return `(?:@|nostr:)?(?<${name}>${name}1${BECH32_BODY}{${bodyLength}})`
@@ -65,6 +76,7 @@ function getReferencesRegex (bareNip05) {
   ]
   const alternatives = [
     URL_SOURCE,
+    APP_SOURCE,
     NIP05_STANDARD,
     ...nip05Compact,
     ...ENTITY_SOURCES,
@@ -276,7 +288,17 @@ function decodeFragmentValue (value) {
   }
 }
 
-function getReferenceItem (original, groups, { getMimeType }) {
+function getReferenceItem (original, groups, { getMimeType, defaultAppUser }) {
+  if (groups.app) {
+    const app = tryDecodeAppUrl(groups.app)
+    // An omitted author uses the configured default. An explicit but invalid
+    // author must never silently resolve to a different app.
+    if (app?.type === 'named' && !app.user && !groups.app.includes('@')) app.user = defaultAppUser
+    return app && (app.type === 'entity' || app.user)
+      ? { key: 'app', app: { original, ...app } }
+      : { key: 'text', text: { value: original } }
+  }
+
   if (groups.url) {
     const url = `${groups.protocol ? '' : 'https://'}${groups.url}`
     let mediaMetadata = {}
@@ -376,10 +398,20 @@ function getReferenceItem (original, groups, { getMimeType }) {
 // Bare compact NIP-05 spellings (`bob.example.com`) are only recognized when
 // `{ bareNip05: true }` is passed, since they are otherwise indistinguishable
 // from plain hostnames; prefixed forms (`@bob.example.com`) always work.
-export function extractMedia (content, { bareNip05 = false, getMimeType } = {}) {
+// App references (+encodedEntity, +app@author or +app, with optional nostr:) return
+// { key: 'app', app: { original, ...decodeAppUrlResult } } without resolution.
+// Missing app authors use defaultAppAuthor, validated as a user reference.
+export function extractMedia (content, { bareNip05 = false, getMimeType, defaultAppAuthor = '44billion.net' } = {}) {
   if (typeof content !== 'string') {
     throw new ValidationError('INVALID_MEDIA_CONTENT', { message: 'CONTENT_SHOULD_BE_A_STRING' })
   }
+  let defaultAppUser
+  try {
+    defaultAppUser = decodeUserReference(defaultAppAuthor)
+  } catch (cause) {
+    if (!(cause instanceof ValidationError)) throw cause
+    throw new ValidationError('INVALID_DEFAULT_APP_AUTHOR', { cause })
+  }
   const regex = getReferencesRegex(bareNip05)
   const items = []
   let end = 0
@@ -391,7 +423,7 @@ export function extractMedia (content, { bareNip05 = false, getMimeType } = {})
     }
     const original = match[0]
     end = start + original.length
-    const item = getReferenceItem(original, match.groups, { getMimeType })
+    const item = getReferenceItem(original, match.groups, { getMimeType, defaultAppUser })
     if (item) items.push(item)
   }
 

package/package.json

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