mppx 0.8.17 → 0.8.18

package/src/PaymentRequest.test.ts

@@ -1,147 +0,0 @@
-import { PaymentRequest } from 'mppx'
-import { Methods } from 'mppx/tempo'
-import { describe, expect, test } from 'vp/test'
-
-describe('from', () => {
-  test('creates a request', () => {
-    const request = PaymentRequest.from({
-      amount: '1000000',
-      currency: 'USD',
-      recipient: '0x1234',
-    })
-    expect(request).toMatchInlineSnapshot(`
-      {
-        "amount": "1000000",
-        "currency": "USD",
-        "recipient": "0x1234",
-      }
-    `)
-  })
-})
-
-describe('fromMethod', () => {
-  test('creates a validated request from intent', () => {
-    const request = PaymentRequest.fromMethod(Methods.charge, {
-      amount: '1',
-      currency: '0x20c0000000000000000000000000000000000001',
-      decimals: 6,
-      recipient: '0x742d35Cc6634C0532925a3b844Bc9e7595f8fE00',
-    })
-    expect(request).toMatchInlineSnapshot(`
-      {
-        "amount": "1000000",
-        "currency": "0x20c0000000000000000000000000000000000001",
-        "recipient": "0x742d35Cc6634C0532925a3b844Bc9e7595f8fE00",
-      }
-    `)
-  })
-
-  test('includes methodDetails fields', () => {
-    const request = PaymentRequest.fromMethod(Methods.charge, {
-      amount: '1',
-      currency: '0x20c0000000000000000000000000000000000001',
-      decimals: 6,
-      recipient: '0x742d35Cc6634C0532925a3b844Bc9e7595f8fE00',
-      chainId: 42431,
-    })
-    expect(request).toMatchInlineSnapshot(`
-      {
-        "amount": "1000000",
-        "currency": "0x20c0000000000000000000000000000000000001",
-        "methodDetails": {
-          "chainId": 42431,
-        },
-        "recipient": "0x742d35Cc6634C0532925a3b844Bc9e7595f8fE00",
-      }
-    `)
-  })
-
-  test('throws on invalid request', () => {
-    expect(() =>
-      PaymentRequest.fromMethod(Methods.charge, {
-        amount: 123,
-        currency: '0x20c0000000000000000000000000000000000001',
-        recipient: '0x742d35Cc6634C0532925a3b844Bc9e7595f8fE00',
-      } as any),
-    ).toThrowErrorMatchingInlineSnapshot(`
-      [$ZodError: [
-        {
-          "expected": "string",
-          "code": "invalid_type",
-          "path": [
-            "amount"
-          ],
-          "message": "Invalid input"
-        },
-        {
-          "expected": "number",
-          "code": "invalid_type",
-          "path": [
-            "decimals"
-          ],
-          "message": "Invalid input"
-        }
-      ]]
-    `)
-  })
-})
-
-describe('serialize', () => {
-  test('serializes request to base64url', () => {
-    const request = PaymentRequest.from({
-      amount: '1000000',
-      currency: 'USD',
-    })
-    const serialized = PaymentRequest.serialize(request)
-    expect(serialized).toMatch(/^[A-Za-z0-9_-]+$/)
-    expect(serialized).not.toContain('=')
-    expect(serialized).not.toContain('+')
-    expect(serialized).not.toContain('/')
-  })
-
-  test('roundtrips correctly', () => {
-    const original = PaymentRequest.from({
-      amount: '1000000',
-      currency: 'USD',
-      recipient: '0x742d35Cc6634C0532925a3b844Bc9e7595f8fE00',
-    })
-    const serialized = PaymentRequest.serialize(original)
-    const deserialized = PaymentRequest.deserialize(serialized)
-    expect(deserialized).toMatchInlineSnapshot(`
-      {
-        "amount": "1000000",
-        "currency": "USD",
-        "recipient": "0x742d35Cc6634C0532925a3b844Bc9e7595f8fE00",
-      }
-    `)
-  })
-})
-
-describe('deserialize', () => {
-  test('deserializes base64url to request', () => {
-    const original = { amount: '500', currency: 'EUR' }
-    const serialized = PaymentRequest.serialize(original)
-    const result = PaymentRequest.deserialize(serialized)
-    expect(result).toMatchInlineSnapshot(`
-      {
-        "amount": "500",
-        "currency": "EUR",
-      }
-    `)
-  })
-
-  test('handles special characters in values', () => {
-    const original = {
-      amount: '1000000',
-      description: 'Payment for café & más',
-    }
-    const serialized = PaymentRequest.serialize(original)
-    const result = PaymentRequest.deserialize(serialized)
-    expect(result).toMatchInlineSnapshot(`
-      {
-        "amount": "1000000",
-        "description": "Payment for café & más",
-      }
-    `)
-  })
-})

package/src/PaymentRequest.ts

@@ -1,108 +0,0 @@
-import { Base64, Json } from 'ox'
-
-import type { Compute } from './internal/types.js'
-import type * as Method from './Method.js'
-import type * as z from './zod.js'
-
-/**
- * Intent-specific payment parameters.
- *
- * @example
- * ```ts
- * import { PaymentRequest } from 'mppx'
- *
- * const request: PaymentRequest.Request = {
- *   amount: '1000000',
- *   currency: '0x20c0000000000000000000000000000000000001',
- *   recipient: '0x742d35Cc6634C0532925a3b844Bc9e7595f8fE00',
- * }
- * ```
- */
-export type Request<request extends Record<string, unknown> = Record<string, unknown>> =
-  Compute<request>
-
-/**
- * Deserializes a base64url string to a request.
- *
- * @param encoded - The base64url-encoded string.
- * @returns The deserialized request.
- *
- * @example
- * ```ts
- * import { PaymentRequest } from 'mppx'
- *
- * const request = PaymentRequest.deserialize(serialized)
- * ```
- */
-export function deserialize(encoded: string): Request {
-  const json = Base64.toString(encoded)
-  return JSON.parse(json)
-}
-
-/**
- * Creates a request from the given parameters.
- *
- * @param request - Request parameters.
- * @returns A request.
- *
- * @example
- * ```ts
- * import { PaymentRequest } from 'mppx'
- *
- * const request = PaymentRequest.from({
- *   amount: '1000000',
- *   currency: '0x20c0000000000000000000000000000000000001',
- *   recipient: '0x742d35Cc6634C0532925a3b844Bc9e7595f8fE00',
- * })
- * ```
- */
-export function from<const request extends Request>(request: request): request {
-  return request
-}
-
-/**
- * Creates a validated request from a method intent.
- *
- * @param method - The method to validate against.
- * @param request - Request parameters.
- * @returns A validated request.
- *
- * @example
- * ```ts
- * import { PaymentRequest } from 'mppx'
- * import { Methods } from 'mppx/tempo'
- *
- * const request = PaymentRequest.fromMethod(Methods.charge, {
- *   amount: '1000000',
- *   currency: '0x20c0000000000000000000000000000000000001',
- *   recipient: '0x742d35Cc6634C0532925a3b844Bc9e7595f8fE00',
- *   expires: '2025-01-06T12:00:00Z',
- *   chainId: 42431,
- * })
- * ```
- */
-export function fromMethod<const method extends Method.Method>(
-  method: method,
-  request: z.input<method['schema']['request']>,
-): Request<z.output<method['schema']['request']>> {
-  return method.schema.request.parse(request) as Request<z.output<method['schema']['request']>>
-}
-
-/**
- * Serializes a request to a base64url string.
- *
- * @param request - The request to serialize.
- * @returns A base64url-encoded string (no padding).
- *
- * @example
- * ```ts
- * import { PaymentRequest } from 'mppx'
- *
- * const serialized = PaymentRequest.serialize(request)
- * // => "eyJhbW91bnQiOiIxMDAwMDAwIiwiY3VycmVuY3kiOiIweC4uLiJ9"
- * ```
- */
-export function serialize(request: Request): string {
-  const json = Json.canonicalize(request)
-  return Base64.fromString(json, { pad: false, url: true })
-}

package/src/Receipt.test.ts

@@ -1,151 +0,0 @@
-import { Receipt } from 'mppx'
-import { describe, expect, test } from 'vp/test'
-
-describe('from', () => {
-  test('behavior: creates receipt with success status', () => {
-    const receipt = Receipt.from({
-      method: 'tempo',
-      reference: '0x1234',
-      status: 'success',
-      timestamp: '2025-01-21T12:00:00.000Z',
-    })
-
-    expect(receipt).toMatchInlineSnapshot(`
-      {
-        "method": "tempo",
-        "reference": "0x1234",
-        "status": "success",
-        "timestamp": "2025-01-21T12:00:00.000Z",
-      }
-    `)
-  })
-
-  test('error: rejects receipt with failed status', () => {
-    expect(() =>
-      Receipt.from({
-        method: 'tempo',
-        reference: '0xabcd',
-        status: 'failed' as 'success',
-        timestamp: '2025-01-21T13:00:00.000Z',
-      }),
-    ).toThrow()
-  })
-
-  test('behavior: preserves method-specific extension fields', () => {
-    const receipt = Receipt.from({
-      method: 'nearintents',
-      reference: 'FtChYxxQh1k6vKjQ9wq5q1f8s2n3p4r5t6u7v8w9x0yz',
-      status: 'success',
-      timestamp: '2025-01-21T12:00:00.000Z',
-      challengeId: 'qB3wErTyU7iOpAsD9fGhJk',
-      originTxHash: '0x9bcff372aee89b648c922b850573b22387c31d693079f5e37cd255814e2d615a',
-      destinationNetwork: 'near:mainnet',
-    })
-
-    expect(receipt).toMatchInlineSnapshot(`
-      {
-        "challengeId": "qB3wErTyU7iOpAsD9fGhJk",
-        "destinationNetwork": "near:mainnet",
-        "method": "nearintents",
-        "originTxHash": "0x9bcff372aee89b648c922b850573b22387c31d693079f5e37cd255814e2d615a",
-        "reference": "FtChYxxQh1k6vKjQ9wq5q1f8s2n3p4r5t6u7v8w9x0yz",
-        "status": "success",
-        "timestamp": "2025-01-21T12:00:00.000Z",
-      }
-    `)
-  })
-
-  test('error: rejects invalid base field even with extension fields present', () => {
-    expect(() =>
-      Receipt.from({
-        method: 'nearintents',
-        reference: 'FtChYxxQh1k6vKjQ9wq5q1f8s2n3p4r5t6u7v8w9x0yz',
-        status: 'failed' as 'success',
-        timestamp: '2025-01-21T12:00:00.000Z',
-        originTxHash: '0x9bcff372aee89b648c922b850573b22387c31d693079f5e37cd255814e2d615a',
-      }),
-    ).toThrow()
-  })
-})
-
-describe('serialize', () => {
-  test('behavior: serializes receipt to base64url', () => {
-    const receipt = Receipt.from({
-      method: 'tempo',
-      reference: '0x1234',
-      status: 'success',
-      timestamp: '2025-01-21T12:00:00.000Z',
-    })
-
-    const header = Receipt.serialize(receipt)
-
-    expect(header).toMatchInlineSnapshot(
-      `"eyJtZXRob2QiOiJ0ZW1wbyIsInJlZmVyZW5jZSI6IjB4MTIzNCIsInN0YXR1cyI6InN1Y2Nlc3MiLCJ0aW1lc3RhbXAiOiIyMDI1LTAxLTIxVDEyOjAwOjAwLjAwMFoifQ"`,
-    )
-  })
-})
-
-describe('deserialize', () => {
-  test('behavior: deserializes base64url to receipt', () => {
-    const encoded =
-      'eyJtZXRob2QiOiJ0ZW1wbyIsInJlZmVyZW5jZSI6IjB4MTIzNCIsInN0YXR1cyI6InN1Y2Nlc3MiLCJ0aW1lc3RhbXAiOiIyMDI1LTAxLTIxVDEyOjAwOjAwLjAwMFoifQ'
-
-    const receipt = Receipt.deserialize(encoded)
-
-    expect(receipt).toMatchInlineSnapshot(`
-      {
-        "method": "tempo",
-        "reference": "0x1234",
-        "status": "success",
-        "timestamp": "2025-01-21T12:00:00.000Z",
-      }
-    `)
-  })
-})
-
-describe('serialize + deserialize', () => {
-  test('behavior: round-trips method-specific extension fields', () => {
-    const receipt = Receipt.from({
-      method: 'nearintents',
-      reference: 'FtChYxxQh1k6vKjQ9wq5q1f8s2n3p4r5t6u7v8w9x0yz',
-      status: 'success',
-      timestamp: '2025-01-21T12:00:00.000Z',
-      externalId: 'order_12345',
-      challengeId: 'qB3wErTyU7iOpAsD9fGhJk',
-      originTxHash: '0x9bcff372aee89b648c922b850573b22387c31d693079f5e37cd255814e2d615a',
-      destinationNetwork: 'near:mainnet',
-    })
-
-    expect(Receipt.deserialize(Receipt.serialize(receipt))).toEqual(receipt)
-  })
-})
-
-describe('fromResponse', () => {
-  test('behavior: extracts receipt from Payment-Receipt header', () => {
-    const encoded =
-      'eyJtZXRob2QiOiJ0ZW1wbyIsInJlZmVyZW5jZSI6IjB4MTIzNCIsInN0YXR1cyI6InN1Y2Nlc3MiLCJ0aW1lc3RhbXAiOiIyMDI1LTAxLTIxVDEyOjAwOjAwLjAwMFoifQ'
-
-    const response = new Response('OK', {
-      headers: { 'Payment-Receipt': encoded },
-    })
-
-    const receipt = Receipt.fromResponse(response)
-
-    expect(receipt).toMatchInlineSnapshot(`
-      {
-        "method": "tempo",
-        "reference": "0x1234",
-        "status": "success",
-        "timestamp": "2025-01-21T12:00:00.000Z",
-      }
-    `)
-  })
-
-  test('error: throws when Payment-Receipt header is missing', () => {
-    const response = new Response('OK')
-
-    expect(() => Receipt.fromResponse(response)).toThrowErrorMatchingInlineSnapshot(
-      `[Error: Missing Payment-Receipt header.]`,
-    )
-  })
-})

package/src/Receipt.ts

@@ -1,146 +0,0 @@
-import { Base64 } from 'ox'
-
-import * as Constants from './Constants.js'
-import * as z from './zod.js'
-
-const shape = {
-  /** Payment method used (e.g., "tempo", "stripe"). */
-  method: z.string(),
-  /** Method-specific reference (e.g., transaction hash). */
-  reference: z.string(),
-  /** Optional external reference ID echoed from the credential payload. */
-  externalId: z.optional(z.string()),
-  /** Optional server-issued subscription identifier for recurring payments. */
-  subscriptionId: z.optional(z.string()),
-  /** Payment status. Always "success" — failures use 402 + Problem Details. */
-  status: z.literal('success'),
-  /** RFC 3339 settlement timestamp. */
-  timestamp: z.datetime(),
-}
-
-/** Base-field schema used only to derive the {@link Receipt} type without an index signature. */
-const BaseSchema = z.object(shape)
-
-/**
- * Schema for a payment receipt.
- *
- * Method specifications may define additional receipt fields beyond the
- * base set (per the core spec's Payment-Receipt section); unknown fields
- * are preserved through parse/serialize round-trips rather than stripped.
- *
- * @example
- * ```ts
- * import { Receipt } from 'mppx'
- *
- * const receipt = Receipt.Schema.parse(data)
- * ```
- */
-export const Schema = z.looseObject(shape)
-
-/**
- * Payment receipt returned after verification.
- *
- * Method-specific extension fields are preserved at runtime but not part of
- * this base type; method packages can type them via intersection
- * (e.g. `Receipt.Receipt & { originTxHash: string }`).
- *
- * @example
- * ```ts
- * import { Receipt } from 'mppx'
- *
- * const receipt: Receipt.Receipt = {
- *   method: 'tempo',
- *   status: 'success',
- *   timestamp: new Date().toISOString(),
- *   reference: '0x...',
- * }
- * ```
- */
-export type Receipt = z.infer<typeof BaseSchema>
-
-/**
- * Deserializes a Payment-Receipt header value to a receipt.
- *
- * @param encoded - The base64url-encoded header value.
- * @returns The deserialized receipt.
- *
- * @example
- * ```ts
- * import { Receipt } from 'mppx'
- *
- * const receipt = Receipt.deserialize(encoded)
- * ```
- */
-export function deserialize(encoded: string): Receipt {
-  const json = Base64.toString(encoded)
-  return from(JSON.parse(json))
-}
-
-/**
- * Creates a receipt from the given parameters.
- *
- * @param parameters - Receipt parameters.
- * @returns A receipt.
- *
- * @example
- * ```ts
- * import { Receipt } from 'mppx'
- *
- * const receipt = Receipt.from({
- *   method: 'tempo',
- *   status: 'success',
- *   timestamp: new Date().toISOString(),
- *   reference: '0x...',
- * })
- * ```
- */
-export function from(parameters: from.Parameters): Receipt {
-  return Schema.parse(parameters)
-}
-
-export declare namespace from {
-  type Parameters = z.input<typeof Schema>
-}
-
-/**
- * Serializes a receipt to the Payment-Receipt header format.
- *
- * @param receipt - The receipt to serialize.
- * @returns A base64url-encoded string suitable for the Payment-Receipt header value.
- *
- * @example
- * ```ts
- * import { Receipt } from 'mppx'
- *
- * const header = Receipt.serialize(receipt)
- * // => "eyJzdGF0dXMiOiJzdWNjZXNzIiwidGltZXN0YW1wIjoi..."
- * ```
- */
-export function serialize(receipt: Receipt): string {
-  const json = JSON.stringify(receipt)
-  return Base64.fromString(json, { pad: false, url: true })
-}
-
-/**
- * Extracts the receipt from a Response's Payment-Receipt header.
- *
- * @param response - The HTTP response.
- * @returns The deserialized receipt.
- *
- * @example
- * ```ts
- * import { Receipt } from 'mppx'
- *
- * const response = await fetch('/resource', {
- *   headers: { Authorization: Credential.serialize(credential) },
- * })
- * if (response.ok) {
- *   const receipt = Receipt.fromResponse(response)
- * }
- * ```
- */
-export function fromResponse(response: Response): Receipt {
-  const header = response.headers.get(Constants.Headers.paymentReceipt)
-  if (!header) throw new Error(`Missing ${Constants.Headers.paymentReceipt} header.`)
-  return deserialize(header)
-}