@neus/sdk 1.0.3 → 1.0.4

package/types.d.ts

@@ -31,18 +31,17 @@ declare module '@neus/sdk' {
     verify(params: VerifyParams): Promise<VerificationResult>;
     
     /**
-     * Get verification status by proof ID
-     * @param proofId - Proof ID (standard). `qHash` is a deprecated alias (same value).
-     * @returns Promise resolving to current status
+     * Get proof record by receipt ID.
+     * @param proofId - Proof receipt ID (0x + 64 hex).
      */
-    getStatus(proofId: string): Promise<StatusResult>;
+    getProof(proofId: string): Promise<StatusResult>;
     
     /**
-     * Get private proof status (owner-signed)
-     * @param proofId - Proof ID (standard). `qHash` is a deprecated alias (same value).
+     * Get private proof record (owner-signed)
+     * @param proofId - Proof receipt ID.
      * @param wallet - Optional injected wallet/provider (MetaMask/ethers Wallet)
      */
-    getPrivateStatus(proofId: string, wallet?: WalletLike | GatePrivateAuth): Promise<StatusResult>;
+    getPrivateProof(proofId: string, wallet?: WalletLike | GatePrivateAuth): Promise<StatusResult>;
     
     /**
      * Check API health
@@ -52,10 +51,13 @@ declare module '@neus/sdk' {
     
     /** List available verifiers */
     getVerifiers(): Promise<string[]>;
+
+    /** Get the public verifier catalog, including per-verifier capabilities. */
+    getVerifierCatalog(): Promise<VerifierCatalog>;
     
   /**
    * Poll verification status until completion
-   * @param proofId - Proof ID (standard). `qHash` is a deprecated alias (same value).
+   * @param proofId - Proof ID to poll.
    * @param options - Polling configuration options
    * @returns Promise resolving to final status
    * @example
@@ -90,7 +92,7 @@ declare module '@neus/sdk' {
     getPrivateProofsByWallet(walletAddress: string, options?: GetProofsOptions, wallet?: WalletLike): Promise<ProofsResult>;
 
     /**
-     * Minimal eligibility check against public + discoverable proofs only (API-backed).
+     * Minimal eligibility check against public + unlisted proofs by default (API-backed).
      * Prefer this for server-side integrations that do not need full proof payloads.
      */
     gateCheck(params: GateCheckApiParams): Promise<GateCheckApiResponse>;
@@ -139,15 +141,13 @@ declare module '@neus/sdk' {
     apiKey?: string;
     /** Optional public app attribution ID (maps to X-Neus-App) */
     appId?: string;
-    /** Optional sponsor capability token (maps to X-Sponsor-Grant) */
-    sponsorGrant?: string;
     /** Optional x402 receipt token for retry calls (maps to PAYMENT-SIGNATURE) */
     paymentSignature?: string;
     /** Optional extra passthrough headers for advanced integrations */
     extraHeaders?: Record<string, string>;
     /** Request timeout in milliseconds */
     timeout?: number;
-    /** Optional chain override used by some app integrations */
+    /** Advanced. NEUS protocol primary-chain id override; most integrators omit. */
     hubChainId?: number;
     /** Enable SDK logging */
     enableLogging?: boolean;
@@ -172,6 +172,24 @@ declare module '@neus/sdk' {
     /** Verifier-specific options */
     verifierOptions?: Record<string, any>;
   }
+
+  export interface VerifierCatalogMetadataEntry {
+    category?: string;
+    description?: string;
+    flowType?: 'instant' | 'interactive' | 'external_lookup' | string;
+    expiryType?: 'permanent' | 'point_in_time' | 'expiring' | string;
+    supportsDirectApi?: boolean;
+    supportsHostedVerify?: boolean;
+    dataSchema?: Record<string, any>;
+    requiredFields?: string[];
+    optionalFields?: string[];
+  }
+
+  export interface VerifierCatalog {
+    data: string[];
+    metadata: Record<string, VerifierCatalogMetadataEntry>;
+    meta?: Record<string, any>;
+  }
   
   /**
    * Parameters for manual verification
@@ -194,7 +212,7 @@ declare module '@neus/sdk' {
     signature?: string;
     /** Advanced/manual path: signed timestamp */
     signedTimestamp?: number;
-    /** Advanced/manual path: chain ID for verification context; optional, managed by protocol */
+    /** Advanced/optional. EVM signing-context hint; when omitted, resolved to the NEUS protocol primary chain for signing. For chain-specific asset claims (NFT, token, contract), set chainId inside verifier data instead. */
     chainId?: number;
     /** CAIP-2 chain reference for universal mode (e.g. eip155:1, solana:mainnet) */
     chain?: string;
@@ -208,16 +226,16 @@ declare module '@neus/sdk' {
    * Result from proof creation
    */
   export interface ProofResult {
-    /** Proof ID (standard) */
+    /** Proof receipt ID */
     proofId: string;
-    /** @deprecated qHash is a deprecated alias of proofId (same value). */
+    /** HTTP wire field for the proof receipt ID. */
     qHash: string;
     /** Current status */
     status: string;
     /** Wallet address that created proof */
     walletAddress?: string;
-    /** Status check URL */
-    statusUrl?: string;
+    /** Stable URL for GET proof record */
+    proofUrl?: string;
     /** Cross-chain enabled */
     crossChain?: boolean;
   }
@@ -226,9 +244,9 @@ declare module '@neus/sdk' {
    * Verification result
    */
   export interface VerificationResult {
-    /** Proof ID (standard) */
+    /** Proof receipt ID */
     proofId: string;
-    /** @deprecated qHash is a deprecated alias of proofId (same value). */
+    /** HTTP wire field for the proof receipt ID. */
     qHash: string;
     /** Current status */
     status: VerificationStatus;
@@ -242,10 +260,12 @@ declare module '@neus/sdk' {
    * Status check result
    */
   export interface StatusResult {
-    /** Proof ID (standard) */
+    /** Proof receipt ID */
     proofId?: string;
-    /** @deprecated qHash is a deprecated alias of proofId (same value). */
+    /** HTTP wire field for the proof receipt ID. */
     qHash?: string;
+    /** Stable URL for GET proof record */
+    proofUrl?: string | null;
     /** Whether verification succeeded */
     success: boolean;
     /** Current status */
@@ -253,7 +273,7 @@ declare module '@neus/sdk' {
     /** Full verification data */
     data?: {
       proofId?: string;
-      /** @deprecated qHash is a deprecated alias of proofId (same value). */
+      /** HTTP wire field for the proof receipt ID. */
       qHash?: string;
       status: string;
       walletAddress: string;
@@ -287,6 +307,7 @@ declare module '@neus/sdk' {
         }>;
         createdVouchers?: string[];
       };
+      /** Advanced. Primary-chain transaction metadata from the NEUS protocol. */
       hubTransaction?: {
         txHash: string;
         timestamp: number;
@@ -360,7 +381,7 @@ declare module '@neus/sdk' {
     | 'contract-ownership'
     | 'wallet-risk'            // Wallet risk assessment
     | 'proof-of-human'         // Hosted ZK personhood verification
-    // AI & Agent verifiers (ERC-8004 aligned)
+    // AI & Agent verifiers (portable, protocol-agnostic)
     | 'agent-identity'
     | 'agent-delegation'
     | 'ai-content-moderation'
@@ -410,6 +431,9 @@ declare module '@neus/sdk' {
     chainId?: number;
     chain?: string;
   }): string;
+
+  /** CAIP-380 six-line signer message — line 1 */
+  export const PORTABLE_PROOF_SIGNER_HEADER: string;
   
   /**
    * Validate Ethereum wallet address
@@ -438,8 +462,8 @@ declare module '@neus/sdk' {
 
   /**
    * Resolve DID from wallet identity via profile resolver endpoint.
-   * Use `chainId` for EVM wallets and `chain` (CAIP-2) for non-EVM wallets
-   * such as Solana (`solana:mainnet`).
+   * EVM wallets resolve to the NEUS protocol primary chain by default; chainId is optional.
+   * Use `chain` (CAIP-2) for non-EVM wallets (e.g. `solana:mainnet`).
    */
   export function resolveDID(
     params: {
@@ -577,19 +601,51 @@ declare module '@neus/sdk' {
     backoffFactor?: number;
   }): Promise<T>;
   
-  /**
-   * Proof status
-   */
-  // Use NeusClient.getStatus(proofId) for status checks (`qHash` remains as deprecated alias).
-  
-  
   // ============================================================================
   // CONSTANTS & REGISTRY
   // ============================================================================
+
+  /**
+   * Build `agent-delegation` maxSpend from a display decimal (e.g. USDC `"100.50"` with six decimal places).
+   * Returns a whole-number string in token base units (no decimal point) for the verifier API.
+   */
+  export function toAgentDelegationMaxSpend(
+    humanAmount: string | number,
+    decimals: number
+  ): string;
   
   /**
    * NEUS Network constants
    */
+  export const DEFAULT_HOSTED_VERIFY_URL: string;
+
+  export function getHostedCheckoutUrl(opts?: {
+    gateId?: string;
+    returnUrl?: string;
+    verifiers?: string[];
+    preset?: string;
+    mode?: string;
+    intent?: string;
+    origin?: string;
+    oauthProvider?: string;
+    baseUrl?: string;
+  }): string;
+
+  /**
+   * Public gate monetization.charge from GET /api/v1/profile/gates/{gateId} (sanitized).
+   * Safe for clients: no payout secrets; `recipient` is the published settlement address when enabled.
+   */
+  export type NeusPublicGateCharge = {
+    enabled: boolean;
+    scheme: string;
+    label: string;
+    amountUsd: number;
+    methods: string[];
+    appliesTo: string;
+    executionOrder?: string;
+    recipient?: string;
+  };
+
   export const NEUS_CONSTANTS: {
     HUB_CHAIN_ID: number;
     TESTNET_CHAINS: number[];
@@ -654,12 +710,6 @@ declare module '@neus/sdk' {
    */
   export class AuthenticationError extends SDKError {}
   
-  // ============================================================================
-  // SCHEMA ACCESS
-  // ============================================================================
-  
-  
-  
   // ============================================================================
   // PROOFS & GATING TYPES
   // ============================================================================
@@ -750,7 +800,7 @@ declare module '@neus/sdk' {
     since?: number;
     /** Max rows to scan (server may clamp) */
     limit?: number;
-    /** Include private proofs for owner-authenticated checks */
+    /** Include private proofs for owner/controller-authorized checks */
     includePrivate?: boolean;
     /** Include matched qHashes in response (minimal identifiers only) */
     includeQHashes?: boolean;
@@ -772,9 +822,10 @@ declare module '@neus/sdk' {
     content?: string;
     contentHash?: string;
 
-    // Asset/ownership filters
+    // Asset/ownership filters — chainId here is the chain where the asset lives (e.g. 8453 for Base, 1 for Ethereum)
     contractAddress?: string;
     tokenId?: string;
+    /** EVM chain ID of the asset (e.g. 1, 8453). Required for nft-ownership, token-holding, contract-ownership. */
     chainId?: number;
     domain?: string;
     minBalance?: string;
@@ -782,6 +833,10 @@ declare module '@neus/sdk' {
     // Wallet filters
     /** Risk assessment provider hint. Known value: webacy. */
     provider?: string;
+    /** Social handle (ownership-social) or pseudonym handle (ownership-pseudonym); server matches data.handle / pseudonymId */
+    handle?: string;
+    /** ownership-pseudonym namespace filter (matches GET /api/v1/proofs/check `namespace` query) */
+    namespace?: string;
     ownerAddress?: string;
     riskLevel?: string;
     sanctioned?: boolean;
@@ -805,7 +860,7 @@ declare module '@neus/sdk' {
       eligible: boolean;
       matchedCount?: number;
       matchedQHashes?: string[];
-      /** @deprecated matchedProofIds is a legacy alias of matchedQHashes (same values when provided). */
+      /** @deprecated matchedProofIds is a compatibility alias of matchedQHashes (same values when provided). */
       matchedProofIds?: string[];
       matchedTags?: string[];
       projections?: Array<Record<string, any>> | null;
@@ -1004,6 +1059,13 @@ declare module '@neus/sdk' {
     agentType?: 'ai' | 'bot' | 'service' | 'automation' | 'agent';
     description?: string;
     capabilities?: any[];
+    instructions?: string;
+    skills?: string[];
+    services?: Array<{
+      name: string;
+      endpoint: string;
+      version?: string;
+    }>;
     [key: string]: any;
   };
 
@@ -1013,10 +1075,13 @@ declare module '@neus/sdk' {
     agentId?: string;
     scope?: string;
     permissions?: any[];
+    /** Whole-number string, token base units (1–78 digits, no decimal point). Build via `toAgentDelegationMaxSpend`. */
     maxSpend?: string;
     allowedPaymentTypes?: string[];
     receiptDisclosure?: 'none' | 'summary' | 'full';
     expiresAt?: number;
+    instructions?: string;
+    skills?: string[];
     [key: string]: any;
   };
 
@@ -1114,16 +1179,16 @@ declare module '@neus/sdk/widgets' {
     /** Callback when verification completes successfully */
     onVerified?: (result: {
       proofId: string;
-      /** @deprecated qHash is a deprecated alias of proofId (same value). */
+      /** HTTP wire field for the proof receipt ID. */
       qHash: string;
       proofIds?: string[];
-      /** @deprecated qHashes is a deprecated alias of proofIds (same values). */
+      /** HTTP wire fields for proof receipt IDs. */
       qHashes?: string[];
       address?: string;
       txHash?: string | null;
       verifierIds: string[];
       verifiedVerifiers?: any[];
-      statusUrl?: string | null;
+      proofUrl?: string | null;
       existing?: boolean;
       eligible?: boolean;
       mode?: 'create' | 'access';
@@ -1131,12 +1196,12 @@ declare module '@neus/sdk/widgets' {
       results?: Array<{
         verifierId: string;
         proofId: string;
-        /** @deprecated qHash is a deprecated alias of proofId (same value). */
+        /** HTTP wire field for the proof receipt ID. */
         qHash: string;
         address?: string;
         txHash?: string | null;
         verifiedVerifiers?: any[];
-        statusUrl?: string | null;
+        proofUrl?: string | null;
       }>;
       proofsByVerifierId?: Record<string, any>;
     }) => void;
@@ -1144,14 +1209,14 @@ declare module '@neus/sdk/widgets' {
     apiUrl?: string;
     /** Optional public app attribution ID (maps to X-Neus-App) */
     appId?: string;
-    /** Optional sponsor capability token (maps to X-Sponsor-Grant) */
-    sponsorGrant?: string;
     /** Optional x402 receipt token for retry calls (maps to PAYMENT-SIGNATURE) */
     paymentSignature?: string;
     /** Optional extra passthrough headers for advanced integrations */
     extraHeaders?: Record<string, string>;
     /** Hosted checkout URL for interactive verifiers (default: https://neus.network/verify) */
     hostedCheckoutUrl?: string;
+    /** Optional OAuth provider id to pre-select for social/org verifiers (hosted flow) */
+    oauthProvider?: string;
     /** Custom inline styles */
     style?: Record<string, any>;
     /** Child content to show when verified */
@@ -1160,7 +1225,7 @@ declare module '@neus/sdk/widgets' {
     verifierOptions?: Record<string, any>;
     /** Pre-built verifier data for each verifier */
     verifierData?: Record<string, any>;
-    /** Proof creation options (privacyLevel, publicDisplay, storeOriginalContent) */
+    /** Proof creation options (defaults: private, publicDisplay false, storeOriginalContent true) */
     proofOptions?: Record<string, any>;
     /** Proof reuse strategy */
     strategy?: 'reuse-or-create' | 'reuse' | 'fresh';
@@ -1180,7 +1245,7 @@ declare module '@neus/sdk/widgets' {
     mode?: 'create' | 'access';
     /** proofId for private proof access (required when mode='access') */
     proofId?: string | null;
-    /** @deprecated qHash is a deprecated alias of proofId (same value). */
+    /** HTTP wire field for callers that receive API-shaped proof records. */
     qHash?: string | null;
     /** Optional injected wallet/provider for signing flows */
     wallet?: WalletLike | any;
@@ -1197,11 +1262,11 @@ declare module '@neus/sdk/widgets' {
   export function VerifyGate(props: VerifyGateProps): any;
 
   export interface ProofBadgeProps {
-    /** Proof ID (standard). Provide either proofId or qHash. */
+    /** Proof receipt ID. */
     proofId?: string;
-    /** @deprecated qHash is a deprecated alias of proofId (same value). */
+    /** HTTP wire field for callers that receive API-shaped proof records. Prefer proofId. */
     qHash?: string;
-    /** URL path pattern for proof links. Supports :proofId and legacy :qHash tokens. */
+    /** URL path pattern for proof links. Supports :proofId. */
     proofUrlPattern?: string;
     /** Badge size */
     size?: 'sm' | 'md';
@@ -1227,9 +1292,9 @@ declare module '@neus/sdk/widgets' {
 
   export interface SimpleProofBadgeProps {
     proofId?: string;
-    /** @deprecated qHash is a deprecated alias of proofId (same value). */
+    /** HTTP wire field for callers that receive API-shaped proof records. Prefer proofId. */
     qHash?: string;
-    /** URL path pattern for proof links. Supports :proofId and legacy :qHash tokens. */
+    /** URL path pattern for proof links. Supports :proofId. */
     proofUrlPattern?: string;
     uiLinkBase?: string;
     apiUrl?: string;
@@ -1247,9 +1312,9 @@ declare module '@neus/sdk/widgets' {
 
   export interface NeusPillLinkProps {
     proofId?: string;
-    /** @deprecated qHash is a deprecated alias of proofId (same value). */
+    /** HTTP wire field for callers that receive API-shaped proof records. Prefer proofId. */
     qHash?: string;
-    /** URL path pattern for proof links. Supports :proofId and legacy :qHash tokens. */
+    /** URL path pattern for proof links. Supports :proofId. */
     proofUrlPattern?: string;
     uiLinkBase?: string;
     label?: string;
@@ -1263,11 +1328,11 @@ declare module '@neus/sdk/widgets' {
   export function NeusPillLink(props: NeusPillLinkProps): any;
 
   export interface VerifiedIconProps {
-    /** Proof ID (standard) for link */
+    /** Proof receipt ID for link */
     proofId?: string;
-    /** @deprecated qHash is a deprecated alias of proofId (same value). */
+    /** HTTP wire field for callers that receive API-shaped proof records. Prefer proofId. */
     qHash?: string;
-    /** URL path pattern for proof links. Supports :proofId and legacy :qHash tokens. */
+    /** URL path pattern for proof links. Supports :proofId. */
     proofUrlPattern?: string;
     /** UI platform base URL */
     uiLinkBase?: string;