nappup 2.3.4 → 2.3.5

package/README.md

@@ -138,3 +138,20 @@ await publishApp(fileList, signer, {
 - **`fileList`** — a `FileList` or array of `File` objects (each needs `webkitRelativePath`).
 - **`signer`** — a [NIP-07](https://github.com/nostr-protocol/nips/blob/master/07.md)-compatible signer. In the browser, `window.nostr` is used automatically if omitted.
 - **`onEvent`** — optional callback that receives progress events with a `type` (`'init'`, `'file-uploaded'`, `'complete'`, `'error'`, …) and `progress` (0–100).
+
+Rejected uploads use `NappupError`, with a stable code from
+`NAPPUP_ERROR_CODES`. The original error is retained as `cause`, and some
+errors include structured `details`, so applications can show their own
+recovery instructions without matching CLI-oriented message text:
+
+```js
+import publishApp, { NAPPUP_ERROR_CODES } from 'nappup'
+
+try {
+  await publishApp(fileList, signer)
+} catch (error) {
+  if (error.code === NAPPUP_ERROR_CODES.GENERIC_FOLDER_NAME) {
+    // Ask the user to choose a unique app folder name.
+  }
+}
+```

package/package.json

@@ -6,7 +6,7 @@
     "url": "git+https://github.com/44billion/nappup.git"
   },
   "license": "MIT",
-  "version": "2.3.4",
+  "version": "2.3.5",
   "description": "Nostr App Uploader",
   "type": "module",
   "scripts": {

package/src/errors.js

@@ -0,0 +1,78 @@
+const ERROR_CODE = /^[A-Z][A-Z0-9_]*$/
+
+export const NAPPUP_ERROR_CODES = Object.freeze({
+  UPLOAD_CANCELLED: 'NAPPUP_UPLOAD_CANCELLED',
+  NO_SIGNER: 'NAPPUP_NO_SIGNER',
+  EMPTY_FILE_LIST: 'NAPPUP_EMPTY_FILE_LIST',
+  RELAY_LOOKUP_FAILED: 'NAPPUP_RELAY_LOOKUP_FAILED',
+  NO_OUTBOX_RELAYS: 'NAPPUP_NO_OUTBOX_RELAYS',
+  INVALID_D_TAG: 'NAPPUP_INVALID_D_TAG',
+  GENERIC_FOLDER_NAME: 'NAPPUP_GENERIC_FOLDER_NAME',
+  INVALID_FOLDER_NAME: 'NAPPUP_INVALID_FOLDER_NAME',
+  BLOSSOM_UPLOAD_FAILED: 'NAPPUP_BLOSSOM_UPLOAD_FAILED',
+  IRFS_UPLOAD_FAILED: 'NAPPUP_IRFS_UPLOAD_FAILED',
+  MANIFEST_UPLOAD_FAILED: 'NAPPUP_MANIFEST_UPLOAD_FAILED',
+  UPLOAD_FAILED: 'NAPPUP_UPLOAD_FAILED'
+})
+
+// Carries a stable machine-readable code while retaining technical context.
+export class NappupError extends Error {
+  constructor (code, messageOrOptions = code, causeOrOptions) {
+    if (typeof code !== 'string' || !ERROR_CODE.test(code)) {
+      throw new TypeError('Nappup error code should be uppercase snake case')
+    }
+    const objectOptions = messageOrOptions && typeof messageOrOptions === 'object'
+      ? messageOrOptions
+      : null
+    const trailingOptions = !objectOptions && causeOrOptions && typeof causeOrOptions === 'object' &&
+      (Object.hasOwn(causeOrOptions, 'cause') || Object.hasOwn(causeOrOptions, 'details'))
+      ? causeOrOptions
+      : null
+    const options = objectOptions || trailingOptions
+    const message = objectOptions
+      ? (objectOptions.message ?? code)
+      : (messageOrOptions ?? code)
+    const cause = objectOptions
+      ? objectOptions.cause
+      : trailingOptions
+        ? trailingOptions.cause
+        : causeOrOptions
+    super(message, cause === undefined ? undefined : { cause })
+    Object.defineProperty(this, 'name', {
+      configurable: true,
+      value: 'NappupError',
+      writable: true
+    })
+    Object.defineProperty(this, 'code', {
+      configurable: false,
+      enumerable: true,
+      value: code,
+      writable: false
+    })
+    if (options?.details !== undefined) {
+      Object.defineProperty(this, 'details', {
+        configurable: false,
+        enumerable: true,
+        value: options.details,
+        writable: false
+      })
+    }
+  }
+}
+
+// Ensures every error crossing nappup's public API has a documented code.
+export function normalizeNappupError (error) {
+  if (typeof error?.code === 'string' && error.code.startsWith('NAPPUP_')) return error
+  if (error?.name === 'AbortError' || error?.code === 'ABORT_ERR') {
+    return new NappupError(
+      NAPPUP_ERROR_CODES.UPLOAD_CANCELLED,
+      error?.message || 'Upload cancelled',
+      { cause: error }
+    )
+  }
+  return new NappupError(
+    NAPPUP_ERROR_CODES.UPLOAD_FAILED,
+    error?.message || 'Upload failed',
+    { cause: error }
+  )
+}

package/src/helpers/app.js

@@ -5,5 +5,5 @@ export const GENERIC_BUILD_FOLDER_NAMES = new Set([
 ])
 
 export function isNostrAppDTagSafe (string) {
-  return typeof string === 'string' && string.length <= NOSTR_APP_D_TAG_MAX_LENGTH
+  return typeof string === 'string' && string.length > 0 && string.length <= NOSTR_APP_D_TAG_MAX_LENGTH
 }

package/src/index.js

@@ -8,6 +8,9 @@ import { extractHtmlMetadata, findAppIcon, findIndexFile } from '#helpers/app-me
 import { getBlossomServers, healthCheckServers, uploadFilesToBlossom } from '#services/blossom-upload.js'
 import { uploadBinaryDataChunks } from '#services/irfs-upload.js'
 import { uploadSiteManifest } from '#services/site-manifest.js'
+import { NappupError, NAPPUP_ERROR_CODES, normalizeNappupError } from '#errors.js'
+
+export { NappupError, NAPPUP_ERROR_CODES } from '#errors.js'
 
 // TL;DR
 // import publishApp from 'nappup'
@@ -26,21 +29,8 @@ import { uploadSiteManifest } from '#services/site-manifest.js'
 // }
 //
 export default async function (fileList, nostrSigner, opts = {}) {
-  const onEvent = typeof opts.onEvent === 'function' ? opts.onEvent : null
-  let lastProgress = 0
   try {
-    return await toApp(fileList, nostrSigner, onEvent
-      ? {
-          ...opts,
-          onEvent (event) {
-            lastProgress = event.progress ?? lastProgress
-            onEvent(event)
-          }
-        }
-      : opts)
-  } catch (err) {
-    if (onEvent) try { onEvent({ type: 'error', error: err, progress: lastProgress }) } catch (_) {}
-    throw err
+    return await toApp(fileList, nostrSigner, opts)
   } finally {
     await nostrRelays.disconnectAll()
   }
@@ -59,8 +49,34 @@ export default async function (fileList, nostrSigner, opts = {}) {
  *   'manifest-published' — unified site manifest and app metadata published
  *   'complete'           — { napp } (terminal, progress === 100)
  *   'error'              — { error } (terminal, error is rethrown)
+ *
+ * Every rejected error has a stable `NAPPUP_*` code and may retain its cause.
  */
-export async function toApp (fileList, nostrSigner, {
+export async function toApp (fileList, nostrSigner, opts = {}) {
+  const onEvent = typeof opts.onEvent === 'function' ? opts.onEvent : null
+  let lastProgress = 0
+  const publishOptions = onEvent
+    ? {
+        ...opts,
+        onEvent (event) {
+          lastProgress = event.progress ?? lastProgress
+          onEvent(event)
+        }
+      }
+    : opts
+  try {
+    return await publishApp(fileList, nostrSigner, publishOptions)
+  } catch (error) {
+    const normalized = normalizeNappupError(error)
+    if (onEvent) {
+      try { onEvent({ type: 'error', error: normalized, progress: lastProgress }) } catch (_) {}
+    }
+    throw normalized
+  }
+}
+
+// Implements publishing after the public boundary has installed error normalization.
+async function publishApp (fileList, nostrSigner, {
   log = () => {}, onEvent = () => {}, dTag, channel = 'main', shouldReupload = false
 } = {}) {
   let steps = 0
@@ -74,27 +90,66 @@ export async function toApp (fileList, nostrSigner, {
     } catch (_) {}
   }
   if (!nostrSigner && typeof window !== 'undefined') nostrSigner = window.nostr
-  if (!nostrSigner) throw new Error('No Nostr signer found')
+  if (!nostrSigner) {
+    throw new NappupError(NAPPUP_ERROR_CODES.NO_SIGNER, 'No Nostr signer found')
+  }
   if (typeof window !== 'undefined' && nostrSigner === window.nostr) nostrSigner.getRelays = getRelays
 
-  const writeRelays = [...new Set((await nostrSigner.getRelays()).write
-    .map(relay => relay.trim().replace(/\/$/, '')))]
-  log(`Found ${writeRelays.length} outbox relays:\n${writeRelays.join(', ')}`)
-  if (!writeRelays.length) throw new Error('No outbox relays found')
+  fileList = Array.from(fileList || [])
+  if (!fileList.length) {
+    throw new NappupError(NAPPUP_ERROR_CODES.EMPTY_FILE_LIST, 'No app files were provided')
+  }
 
-  if (typeof dTag === 'string') {
-    if (!isNostrAppDTagSafe(dTag)) throw new Error('dTag must be a non-empty string with at most 260 characters')
+  if (dTag !== undefined && dTag !== null) {
+    if (!isNostrAppDTagSafe(dTag)) {
+      throw new NappupError(
+        NAPPUP_ERROR_CODES.INVALID_D_TAG,
+        'dTag must be a non-empty string with at most 260 characters',
+        { details: { dTag } }
+      )
+    }
   } else {
-    const folderName = fileList[0].webkitRelativePath.split('/')[0].trim()
+    const relativePath = typeof fileList[0]?.webkitRelativePath === 'string'
+      ? fileList[0].webkitRelativePath
+      : ''
+    const folderName = relativePath.split('/')[0].trim()
     if (GENERIC_BUILD_FOLDER_NAMES.has(folderName.toLowerCase())) {
-      throw new Error(`Folder name "${folderName}" is a generic build folder. Please provide a d tag with the -d flag.`)
+      throw new NappupError(
+        NAPPUP_ERROR_CODES.GENERIC_FOLDER_NAME,
+        `Folder name "${folderName}" is a generic build folder. Please provide a d tag with the -d flag.`,
+        { details: { folderName } }
+      )
     }
     dTag = folderName
     if (!isNostrAppDTagSafe(dTag)) {
-      throw new Error('Could not derive a valid d tag from the folder name. Please provide one with the -d flag.')
+      throw new NappupError(
+        NAPPUP_ERROR_CODES.INVALID_FOLDER_NAME,
+        'Could not derive a valid d tag from the folder name. Please provide one with the -d flag.',
+        { details: { folderName } }
+      )
     }
   }
 
+  let signerRelays
+  try {
+    signerRelays = await nostrSigner.getRelays()
+  } catch (error) {
+    throw new NappupError(
+      NAPPUP_ERROR_CODES.RELAY_LOOKUP_FAILED,
+      'Could not read the signer outbox relays',
+      { cause: error }
+    )
+  }
+  const writeRelays = [...new Set((Array.isArray(signerRelays?.write) ? signerRelays.write : [])
+    .flatMap(relay => typeof relay === 'string' && relay.trim()
+      ? [relay.trim().replace(/\/$/, '')]
+      : []
+    ))]
+  log(`Found ${writeRelays.length} outbox relays:\n${writeRelays.join(', ')}`)
+  if (!writeRelays.length) {
+    throw new NappupError(NAPPUP_ERROR_CODES.NO_OUTBOX_RELAYS, 'No outbox relays found')
+  }
+
   const fileMetadata = []
   const nappJsonFile = fileList.find(file => file.webkitRelativePath.split('/').slice(1).join('/') === '.well-known/napp.json')
   let nappJson = {}
@@ -128,7 +183,12 @@ export async function toApp (fileList, nostrSigner, {
   let pause = 1000
 
   log('Checking for blossom servers...')
-  const blossomServerUrls = await getBlossomServers(nostrSigner, writeRelays)
+  let blossomServerUrls = []
+  try {
+    blossomServerUrls = await getBlossomServers(nostrSigner, writeRelays)
+  } catch (error) {
+    log('Could not read Blossom server preferences; using relay-based upload instead', error)
+  }
   let healthyBlossomServers = []
   if (blossomServerUrls.length) {
     log(`Found ${blossomServerUrls.length} blossom servers: ${blossomServerUrls.join(', ')}`)
@@ -238,7 +298,18 @@ export async function toApp (fileList, nostrSigner, {
       shouldReupload,
       log
     })
-    if (failedFiles.length) throw new Error(`${failedFiles.length} file(s) failed to upload to blossom`)
+    if (failedFiles.length) {
+      throw new NappupError(
+        NAPPUP_ERROR_CODES.BLOSSOM_UPLOAD_FAILED,
+        `${failedFiles.length} file(s) failed to upload to Blossom`,
+        {
+          details: {
+            failedFileCount: failedFiles.length,
+            filenames: failedFiles.map(failed => failed.filename).filter(Boolean)
+          }
+        }
+      )
+    }
 
     for (const uploaded of uploadedFiles) {
       const metadata = {
@@ -254,65 +325,82 @@ export async function toApp (fileList, nostrSigner, {
     }
   } else {
     for (const file of fileList) {
-      const nmmr = new NMMR()
-      let chunkLength = 0
-      for await (const chunk of streamToChunks(file.stream(), 51000)) {
-        chunkLength++
-        await nmmr.append(chunk)
-      }
-      // Empty IRFS blobs deliberately have no chunks and no manifest reference.
-      if (!chunkLength) {
-        steps++
-        emit({ type: 'file-uploaded', filename: file.webkitRelativePath.split('/').slice(1).join('/'), service: 'irfs' })
-        continue
-      }
-
       const filename = file.webkitRelativePath.split('/').slice(1).join('/')
-      log(`Uploading ${chunkLength} file parts of ${filename}`)
-      ;({ pause } = await uploadBinaryDataChunks({
-        nmmr, signer: nostrSigner, filename, chunkLength, log, pause, shouldReupload
-      }))
-      const metadata = {
-        rootHash: nmmr.getRoot(),
-        filename,
-        mimeType: file.type || 'application/octet-stream',
-        size: file.size
+      try {
+        const nmmr = new NMMR()
+        let chunkLength = 0
+        for await (const chunk of streamToChunks(file.stream(), 51000)) {
+          chunkLength++
+          await nmmr.append(chunk)
+        }
+        // Empty IRFS blobs deliberately have no chunks and no manifest reference.
+        if (!chunkLength) {
+          steps++
+          emit({ type: 'file-uploaded', filename, service: 'irfs' })
+          continue
+        }
+
+        log(`Uploading ${chunkLength} file parts of ${filename}`)
+        ;({ pause } = await uploadBinaryDataChunks({
+          nmmr, signer: nostrSigner, filename, chunkLength, log, pause, shouldReupload
+        }))
+        const metadata = {
+          rootHash: nmmr.getRoot(),
+          filename,
+          mimeType: file.type || 'application/octet-stream',
+          size: file.size
+        }
+        fileMetadata.push(metadata)
+        if (!iconMetadata && faviconFile && file === faviconFile) iconMetadata = { ...metadata }
+        steps++
+        emit({ type: 'file-uploaded', filename, service: 'irfs' })
+      } catch (error) {
+        throw new NappupError(
+          NAPPUP_ERROR_CODES.IRFS_UPLOAD_FAILED,
+          `Failed to upload "${filename}" to Nostr relays`,
+          { cause: error, details: { filename } }
+        )
       }
-      fileMetadata.push(metadata)
-      if (!iconMetadata && faviconFile && file === faviconFile) iconMetadata = { ...metadata }
-      steps++
-      emit({ type: 'file-uploaded', filename, service: 'irfs' })
     }
   }
 
   log(`Uploading unified site manifest ${dTag}`)
-  const manifest = await uploadSiteManifest({
-    dTag,
-    channel,
-    fileMetadata,
-    name: manifestName,
-    nameLang: nappJson.name?.[0]?.[1],
-    isNameAuto: !nappJson.name?.[0]?.[0],
-    summary: manifestSummary,
-    summaryLang: nappJson.summary?.[0]?.[1],
-    isSummaryAuto: !nappJson.summary?.[0]?.[0],
-    icon: iconMetadata,
-    isIconAuto: !isExplicitIcon,
-    descriptions: nappJson.description,
-    keyArt: keyArtMetadata,
-    screenshots: screenshotMetadata,
-    uploadService,
-    sourceRelays: writeRelays,
-    blossomServers: healthyBlossomServers,
-    signer: nostrSigner,
-    log,
-    pause,
-    shouldReupload,
-    self: nappJson.self?.[0]?.[0],
-    countries: nappJson.country,
-    categories: nappJson.category,
-    hashtags: nappJson.hashtag
-  })
+  let manifest
+  try {
+    manifest = await uploadSiteManifest({
+      dTag,
+      channel,
+      fileMetadata,
+      name: manifestName,
+      nameLang: nappJson.name?.[0]?.[1],
+      isNameAuto: !nappJson.name?.[0]?.[0],
+      summary: manifestSummary,
+      summaryLang: nappJson.summary?.[0]?.[1],
+      isSummaryAuto: !nappJson.summary?.[0]?.[0],
+      icon: iconMetadata,
+      isIconAuto: !isExplicitIcon,
+      descriptions: nappJson.description,
+      keyArt: keyArtMetadata,
+      screenshots: screenshotMetadata,
+      uploadService,
+      sourceRelays: writeRelays,
+      blossomServers: healthyBlossomServers,
+      signer: nostrSigner,
+      log,
+      pause,
+      shouldReupload,
+      self: nappJson.self?.[0]?.[0],
+      countries: nappJson.country,
+      categories: nappJson.category,
+      hashtags: nappJson.hashtag
+    })
+  } catch (error) {
+    throw new NappupError(
+      NAPPUP_ERROR_CODES.MANIFEST_UPLOAD_FAILED,
+      'Failed to publish the app manifest to Nostr relays',
+      { cause: error }
+    )
+  }
 
   const appEntity = appEncode({
     dTag: manifest.tags.find(tag => tag[0] === 'd')[1],