mppx 0.8.15 → 0.8.18

package/src/Errors.ts

@@ -1,448 +0,0 @@
-/** Default hint messages for payment errors. */
-export const Hints = {
-  paymentRequired:
-    'Use a supported wallet to pay for this resource using one of the supported payment methods returned in the WWW-Authenticate header. See https://mpp.dev/tools/wallet.md',
-  malformedCredential:
-    'Use a supported wallet to construct valid credentials for one of the supported payment methods returned in the WWW-Authenticate header. See https://mpp.dev/tools/wallet.md',
-  methodUnsupported:
-    'Use a supported wallet to pay for this resource using one of the supported payment methods returned in the WWW-Authenticate header. See https://mpp.dev/tools/wallet.md',
-} as const
-
-/**
- * Base class for all payment-related errors.
- */
-export abstract class PaymentError extends Error {
-  /** Safe method-specific context for diagnostics and relay responses. */
-  readonly details: Readonly<Record<string, unknown>> | undefined
-
-  /** RFC 9457 Problem Details type URI. */
-  abstract readonly type: string
-
-  /** Human-readable summary for RFC 9457 Problem Details. */
-  abstract readonly title: string
-
-  /** HTTP status code. */
-  readonly status: number = 402
-
-  /** Actionable hint for resolving the error (RFC 9457 extension member). */
-  readonly hint: string | undefined
-
-  protected constructor(message: string, options: PaymentError.Options = {}) {
-    super(message)
-    this.details = options.details
-  }
-
-  /** Converts the error to RFC 9457 Problem Details format. */
-  toProblemDetails(challengeId?: string): PaymentError.ProblemDetails {
-    return {
-      type: this.type,
-      title: this.title,
-      status: this.status,
-      detail: this.message,
-      ...(this.details && Object.keys(this.details).length > 0 && { details: this.details }),
-      ...(this.hint && { hint: this.hint }),
-      ...(challengeId && { challengeId }),
-    }
-  }
-}
-
-export declare namespace PaymentError {
-  type Options = {
-    details?: Record<string, unknown> | undefined
-  }
-
-  type ProblemDetails = {
-    /** RFC 9457 Problem Details type URI. */
-    type: string
-    /** Human-readable summary. */
-    title: string
-    /** HTTP status code. */
-    status: number
-    /** Human-readable explanation. */
-    detail: string
-    /** Safe method-specific diagnostic context. */
-    details?: Readonly<Record<string, unknown>>
-    /** Actionable hint for resolving the error (RFC 9457 extension member). */
-    hint?: string
-    /** Associated challenge ID, if applicable. */
-    challengeId?: string
-  }
-}
-
-/**
- * Credential is malformed (invalid base64url, bad JSON structure).
- */
-export class MalformedCredentialError extends PaymentError {
-  override readonly name = 'MalformedCredentialError'
-  readonly title = 'Malformed Credential'
-  override readonly status = 402
-  readonly type = 'https://paymentauth.org/problems/malformed-credential'
-  override readonly hint = Hints.malformedCredential
-
-  constructor(options: MalformedCredentialError.Options = {}) {
-    const { reason } = options
-    super(reason ? `Credential is malformed: ${reason}.` : 'Credential is malformed.')
-  }
-}
-
-export declare namespace MalformedCredentialError {
-  type Options = {
-    /** Reason the credential is malformed (e.g., "invalid base64url", "invalid JSON"). */
-    reason?: string
-  }
-}
-
-/**
- * Challenge ID is unknown, expired, or already used.
- */
-export class InvalidChallengeError extends PaymentError {
-  override readonly name = 'InvalidChallengeError'
-  readonly title = 'Invalid Challenge'
-  override readonly status = 402
-  readonly type = 'https://paymentauth.org/problems/invalid-challenge'
-
-  constructor(options: InvalidChallengeError.Options = {}) {
-    const { id, reason } = options
-    const idPart = id ? ` "${id}"` : ''
-    const reasonPart = reason ? `: ${reason}` : ''
-    super(`Challenge${idPart} is invalid${reasonPart}.`)
-  }
-}
-
-export declare namespace InvalidChallengeError {
-  type Options = {
-    /** The invalid challenge ID. */
-    id?: string
-    /** Reason the challenge is invalid (e.g., "expired", "already used", "unknown"). */
-    reason?: string
-  }
-}
-
-/**
- * Payment proof is invalid or verification failed.
- */
-export class VerificationFailedError extends PaymentError {
-  override readonly name = 'VerificationFailedError'
-  readonly title = 'Verification Failed'
-  readonly type = 'https://paymentauth.org/problems/verification-failed'
-
-  constructor(options: VerificationFailedError.Options = {}) {
-    const { details, reason } = options
-    super(reason ? `Payment verification failed: ${reason}.` : 'Payment verification failed.', {
-      details,
-    })
-  }
-}
-
-export declare namespace VerificationFailedError {
-  type Options = {
-    /** Safe method-specific diagnostic context. */
-    details?: Record<string, unknown> | undefined
-    /** Reason verification failed (e.g., "invalid signature", "insufficient amount"). */
-    reason?: string
-  }
-}
-
-/**
- * Payment requires additional action (e.g., 3DS authentication).
- */
-export class PaymentActionRequiredError extends PaymentError {
-  override readonly name = 'PaymentActionRequiredError'
-  readonly title = 'Payment Action Required'
-  readonly type = 'https://paymentauth.org/problems/payment-action-required'
-
-  constructor(options: PaymentActionRequiredError.Options = {}) {
-    const { reason } = options
-    super(reason ? `Payment requires action: ${reason}.` : 'Payment requires action.')
-  }
-}
-
-export declare namespace PaymentActionRequiredError {
-  type Options = {
-    /** Reason action is required (e.g., "requires_action"). */
-    reason?: string
-  }
-}
-
-/**
- * Payment has expired.
- */
-export class PaymentExpiredError extends PaymentError {
-  override readonly name = 'PaymentExpiredError'
-  readonly title = 'Payment Expired'
-  readonly type = 'https://paymentauth.org/problems/payment-expired'
-
-  constructor(options: PaymentExpiredError.Options = {}) {
-    const { expires } = options
-    super(expires ? `Payment expired at ${expires}.` : 'Payment has expired.')
-  }
-}
-
-export declare namespace PaymentExpiredError {
-  type Options = {
-    /** ISO 8601 expiration timestamp. */
-    expires?: string
-  }
-}
-
-/**
- * No credential was provided but payment is required.
- */
-export class PaymentRequiredError extends PaymentError {
-  override readonly name = 'PaymentRequiredError'
-  readonly title = 'Payment Required'
-  readonly type = 'https://paymentauth.org/problems/payment-required'
-  override readonly hint = Hints.paymentRequired
-
-  constructor(options: PaymentRequiredError.Options = {}) {
-    const { description } = options
-    const parts = ['Payment is required']
-    if (description) parts.push(`(${description})`)
-    super(`${parts.join(' ')}.`)
-  }
-}
-
-export declare namespace PaymentRequiredError {
-  type Options = {
-    /** Human-readable description of the payment. */
-    description?: string | undefined
-  }
-}
-
-/**
- * Credential payload does not match the expected schema.
- */
-export class InvalidPayloadError extends PaymentError {
-  override readonly name = 'InvalidPayloadError'
-  readonly title = 'Invalid Payload'
-  readonly type = 'https://paymentauth.org/problems/invalid-payload'
-
-  constructor(options: InvalidPayloadError.Options = {}) {
-    const { reason } = options
-    super(reason ? `Credential payload is invalid: ${reason}.` : 'Credential payload is invalid.')
-  }
-}
-
-export declare namespace InvalidPayloadError {
-  type Options = {
-    /** Reason the payload is invalid (e.g., "missing signature field"). */
-    reason?: string
-  }
-}
-
-/**
- * Request is malformed or contains invalid parameters.
- */
-export class BadRequestError extends PaymentError {
-  override readonly name = 'BadRequestError'
-  readonly title = 'Bad Request'
-  override readonly status = 400
-  readonly type = 'https://paymentauth.org/problems/bad-request'
-
-  constructor(options: BadRequestError.Options = {}) {
-    const { reason } = options
-    super(reason ? `Bad request: ${reason}.` : 'Bad request.')
-  }
-}
-
-export declare namespace BadRequestError {
-  type Options = {
-    /** Reason the request is invalid. */
-    reason?: string
-  }
-}
-
-/**
- * Payment amount is insufficient (too low).
- */
-export class PaymentInsufficientError extends PaymentError {
-  override readonly name = 'PaymentInsufficientError'
-  readonly title = 'Payment Insufficient'
-  readonly type = 'https://paymentauth.org/problems/payment-insufficient'
-
-  constructor(options: PaymentInsufficientError.Options = {}) {
-    const { reason } = options
-    super(reason ? `Payment insufficient: ${reason}.` : 'Payment amount is insufficient.')
-  }
-}
-
-export declare namespace PaymentInsufficientError {
-  type Options = {
-    /** Reason the payment is insufficient (e.g., "expected 1000, received 500"). */
-    reason?: string
-  }
-}
-
-/**
- * Payment method is not supported by the server.
- */
-export class PaymentMethodUnsupportedError extends PaymentError {
-  override readonly name = 'PaymentMethodUnsupportedError'
-  readonly title = 'Method Unsupported'
-  override readonly status = 400
-  readonly type = 'https://paymentauth.org/problems/method-unsupported'
-  override readonly hint = Hints.methodUnsupported
-
-  constructor(options: PaymentMethodUnsupportedError.Options = {}) {
-    const { method } = options
-    super(
-      method ? `Payment method "${method}" is not supported.` : 'Payment method is not supported.',
-    )
-  }
-}
-
-export declare namespace PaymentMethodUnsupportedError {
-  type Options = {
-    /** The unsupported method identifier. */
-    method?: string
-  }
-}
-
-/**
- * Insufficient balance in the payment channel.
- */
-export class InsufficientBalanceError extends PaymentError {
-  override readonly name = 'InsufficientBalanceError'
-  readonly title = 'Insufficient Balance'
-  override readonly status = 402
-  readonly type = 'https://paymentauth.org/problems/session/insufficient-balance'
-
-  constructor(options: InsufficientBalanceError.Options = {}) {
-    const { reason } = options
-    super(reason ? `Insufficient balance: ${reason}.` : 'Insufficient balance.')
-  }
-}
-
-export declare namespace InsufficientBalanceError {
-  type Options = {
-    /** Reason for insufficient balance. */
-    reason?: string
-  }
-}
-
-/**
- * Voucher or close request signature is invalid.
- */
-export class InvalidSignatureError extends PaymentError {
-  override readonly name = 'InvalidSignatureError'
-  readonly title = 'Invalid Signature'
-  override readonly status = 402
-  readonly type = 'https://paymentauth.org/problems/session/invalid-signature'
-
-  constructor(options: InvalidSignatureError.Options = {}) {
-    const { reason } = options
-    super(reason ? `Invalid signature: ${reason}.` : 'Invalid signature.')
-  }
-}
-
-export declare namespace InvalidSignatureError {
-  type Options = {
-    reason?: string
-  }
-}
-
-/**
- * Recovered signer is not authorized for this channel.
- */
-export class SignerMismatchError extends PaymentError {
-  override readonly name = 'SignerMismatchError'
-  readonly title = 'Signer Mismatch'
-  override readonly status = 402
-  readonly type = 'https://paymentauth.org/problems/session/signer-mismatch'
-
-  constructor(options: SignerMismatchError.Options = {}) {
-    const { reason } = options
-    super(reason ? `Signer mismatch: ${reason}.` : 'Signer is not authorized for this channel.')
-  }
-}
-
-export declare namespace SignerMismatchError {
-  type Options = {
-    reason?: string
-  }
-}
-
-/**
- * Voucher cumulative amount exceeds the channel deposit.
- */
-export class AmountExceedsDepositError extends PaymentError {
-  override readonly name = 'AmountExceedsDepositError'
-  readonly title = 'Amount Exceeds Deposit'
-  override readonly status = 402
-  readonly type = 'https://paymentauth.org/problems/session/amount-exceeds-deposit'
-
-  constructor(options: AmountExceedsDepositError.Options = {}) {
-    const { reason } = options
-    super(reason ? `Amount exceeds deposit: ${reason}.` : 'Voucher amount exceeds channel deposit.')
-  }
-}
-
-export declare namespace AmountExceedsDepositError {
-  type Options = {
-    reason?: string
-  }
-}
-
-/**
- * Voucher amount increase is below the minimum delta.
- */
-export class DeltaTooSmallError extends PaymentError {
-  override readonly name = 'DeltaTooSmallError'
-  readonly title = 'Delta Too Small'
-  override readonly status = 402
-  readonly type = 'https://paymentauth.org/problems/session/delta-too-small'
-
-  constructor(options: DeltaTooSmallError.Options = {}) {
-    const { reason } = options
-    super(reason ? `Delta too small: ${reason}.` : 'Amount increase below minimum voucher delta.')
-  }
-}
-
-export declare namespace DeltaTooSmallError {
-  type Options = {
-    reason?: string
-  }
-}
-
-/**
- * No channel with this ID exists.
- */
-export class ChannelNotFoundError extends PaymentError {
-  override readonly name = 'ChannelNotFoundError'
-  readonly title = 'Channel Not Found'
-  override readonly status = 410
-  readonly type = 'https://paymentauth.org/problems/session/channel-not-found'
-
-  constructor(options: ChannelNotFoundError.Options = {}) {
-    const { reason } = options
-    super(reason ? `Channel not found: ${reason}.` : 'No channel with this ID exists.')
-  }
-}
-
-export declare namespace ChannelNotFoundError {
-  type Options = {
-    reason?: string
-  }
-}
-
-/**
- * Channel is closed or finalized.
- */
-export class ChannelClosedError extends PaymentError {
-  override readonly name = 'ChannelClosedError'
-  readonly title = 'Channel Closed'
-  override readonly status = 410
-  readonly type = 'https://paymentauth.org/problems/session/channel-finalized'
-
-  constructor(options: ChannelClosedError.Options = {}) {
-    const { reason } = options
-    super(reason ? `Channel closed: ${reason}.` : 'Channel is closed.')
-  }
-}
-
-export declare namespace ChannelClosedError {
-  type Options = {
-    /** Reason the channel is closed. */
-    reason?: string
-  }
-}

package/src/Expires.test.ts

@@ -1,112 +0,0 @@
-import { afterEach, beforeEach, describe, expect, test, vi } from 'vp/test'
-
-import * as Expires from './Expires.js'
-
-const FIXED_NOW = new Date('2025-06-15T12:00:00.000Z').getTime()
-
-beforeEach(() => {
-  vi.useFakeTimers()
-  vi.setSystemTime(FIXED_NOW)
-})
-
-afterEach(() => {
-  vi.useRealTimers()
-})
-
-describe('seconds', () => {
-  test('returns ISO string n seconds from now', () => {
-    expect(Expires.seconds(30)).toBe('2025-06-15T12:00:30.000Z')
-  })
-
-  test('0 returns current time', () => {
-    expect(Expires.seconds(0)).toBe('2025-06-15T12:00:00.000Z')
-  })
-
-  test('negative n returns past time', () => {
-    expect(Expires.seconds(-60)).toBe('2025-06-15T11:59:00.000Z')
-  })
-})
-
-describe('minutes', () => {
-  test('returns ISO string n minutes from now', () => {
-    expect(Expires.minutes(5)).toBe('2025-06-15T12:05:00.000Z')
-  })
-
-  test('0 returns current time', () => {
-    expect(Expires.minutes(0)).toBe('2025-06-15T12:00:00.000Z')
-  })
-
-  test('negative n returns past time', () => {
-    expect(Expires.minutes(-10)).toBe('2025-06-15T11:50:00.000Z')
-  })
-})
-
-describe('hours', () => {
-  test('returns ISO string n hours from now', () => {
-    expect(Expires.hours(2)).toBe('2025-06-15T14:00:00.000Z')
-  })
-
-  test('0 returns current time', () => {
-    expect(Expires.hours(0)).toBe('2025-06-15T12:00:00.000Z')
-  })
-
-  test('negative n returns past time', () => {
-    expect(Expires.hours(-3)).toBe('2025-06-15T09:00:00.000Z')
-  })
-})
-
-describe('days', () => {
-  test('returns ISO string n days from now', () => {
-    expect(Expires.days(1)).toBe('2025-06-16T12:00:00.000Z')
-  })
-
-  test('0 returns current time', () => {
-    expect(Expires.days(0)).toBe('2025-06-15T12:00:00.000Z')
-  })
-
-  test('negative n returns past time', () => {
-    expect(Expires.days(-2)).toBe('2025-06-13T12:00:00.000Z')
-  })
-})
-
-describe('weeks', () => {
-  test('returns ISO string n weeks from now', () => {
-    expect(Expires.weeks(1)).toBe('2025-06-22T12:00:00.000Z')
-  })
-
-  test('0 returns current time', () => {
-    expect(Expires.weeks(0)).toBe('2025-06-15T12:00:00.000Z')
-  })
-
-  test('negative n returns past time', () => {
-    expect(Expires.weeks(-1)).toBe('2025-06-08T12:00:00.000Z')
-  })
-})
-
-describe('months', () => {
-  test('returns ISO string n months (30 days) from now', () => {
-    expect(Expires.months(1)).toBe('2025-07-15T12:00:00.000Z')
-  })
-
-  test('0 returns current time', () => {
-    expect(Expires.months(0)).toBe('2025-06-15T12:00:00.000Z')
-  })
-
-  test('negative n returns past time', () => {
-    expect(Expires.months(-1)).toBe('2025-05-16T12:00:00.000Z')
-  })
-})
-
-describe('years', () => {
-  test('returns ISO string n years (365 days) from now', () => {
-    expect(Expires.years(1)).toBe('2026-06-15T12:00:00.000Z')
-  })
-
-  test('0 returns current time', () => {
-    expect(Expires.years(0)).toBe('2025-06-15T12:00:00.000Z')
-  })
-
-  test('negative n returns past time', () => {
-    expect(Expires.years(-1)).toBe('2024-06-15T12:00:00.000Z')
-  })
-})

package/src/Expires.ts

@@ -1,59 +0,0 @@
-import { InvalidChallengeError, PaymentExpiredError } from './Errors.js'
-
-/**
- * Asserts that `expires` is present, well-formed, and not in the past.
- *
- * Throws `InvalidChallengeError` when missing or malformed,
- * and `PaymentExpiredError` when the timestamp is in the past.
- */
-export function assert(
-  expires: string | undefined,
-  challengeId?: string,
-): asserts expires is string {
-  if (!expires)
-    throw new InvalidChallengeError({
-      ...(challengeId && { id: challengeId }),
-      reason: 'missing required expires field',
-    })
-  if (Number.isNaN(new Date(expires).getTime()))
-    throw new InvalidChallengeError({
-      ...(challengeId && { id: challengeId }),
-      reason: 'malformed expires timestamp',
-    })
-  if (new Date(expires) < new Date()) throw new PaymentExpiredError({ expires })
-}
-
-/** Returns an ISO 8601 datetime string `n` days from now. */
-export function days(n: number) {
-  return new Date(Date.now() + n * 24 * 60 * 60 * 1000).toISOString()
-}
-
-/** Returns an ISO 8601 datetime string `n` hours from now. */
-export function hours(n: number) {
-  return new Date(Date.now() + n * 60 * 60 * 1000).toISOString()
-}
-
-/** Returns an ISO 8601 datetime string `n` minutes from now. */
-export function minutes(n: number) {
-  return new Date(Date.now() + n * 60 * 1000).toISOString()
-}
-
-/** Returns an ISO 8601 datetime string `n` months (30 days) from now. */
-export function months(n: number) {
-  return new Date(Date.now() + n * 30 * 24 * 60 * 60 * 1000).toISOString()
-}
-
-/** Returns an ISO 8601 datetime string `n` seconds from now. */
-export function seconds(n: number) {
-  return new Date(Date.now() + n * 1000).toISOString()
-}
-
-/** Returns an ISO 8601 datetime string `n` weeks from now. */
-export function weeks(n: number) {
-  return new Date(Date.now() + n * 7 * 24 * 60 * 60 * 1000).toISOString()
-}
-
-/** Returns an ISO 8601 datetime string `n` years (365 days) from now. */
-export function years(n: number) {
-  return new Date(Date.now() + n * 365 * 24 * 60 * 60 * 1000).toISOString()
-}

package/src/Html.ts

@@ -1,67 +0,0 @@
-import { Json } from 'ox'
-
-import type * as Method from './Method.js'
-import {
-  attrs,
-  type Config,
-  type Data,
-  ids,
-  type Text,
-  type Theme,
-  vars,
-} from './server/internal/html/config.js'
-import { submitCredential } from './server/internal/html/serviceWorker.client.js'
-
-export function init<
-  method extends Method.Method = Method.Method,
-  config extends Record<string, unknown> = {},
->(methodName: method['name']): Context<method, config> {
-  const element = document.getElementById(ids.data)!
-  const dataMap = Json.parse(element.textContent) as Record<string, Data<method, config>>
-
-  const remaining = element.getAttribute(attrs.remaining)
-  if (!remaining || Number(remaining) <= 1) element.remove()
-  else element.setAttribute(attrs.remaining, String(Number(remaining) - 1))
-
-  const script = document.currentScript
-  const challengeId = script?.getAttribute(attrs.challengeId)
-  const data = challengeId
-    ? (script!.removeAttribute(attrs.challengeId), dataMap[challengeId]!)
-    : Object.values(dataMap).find((d) => d.challenge.method === methodName)!
-
-  return {
-    ...data,
-    error(message?: string | null | undefined) {
-      if (!message) {
-        document.getElementById(ids.error)?.remove()
-        return
-      }
-      const existing = document.getElementById(ids.error)
-      if (existing) {
-        existing.textContent = message
-        return
-      }
-      const el = document.createElement('p')
-      el.id = ids.error
-      el.className = 'mppx-error'
-      el.role = 'alert'
-      el.textContent = message
-      document.getElementById(data.rootId)?.after(el)
-    },
-    root: document.getElementById(data.rootId)!,
-    submit: submitCredential,
-    vars,
-  }
-}
-
-export type Context<
-  method extends Method.Method = Method.Method,
-  config extends Record<string, unknown> = {},
-> = Data<method, config> & {
-  error: (message?: string | null | undefined) => void
-  root: HTMLElement
-  submit: (credential: string) => Promise<void>
-  vars: typeof vars
-}
-
-export type { Config, Text, Theme }