@neus/sdk 1.1.5 → 1.1.7

package/package.json

@@ -1,147 +1,150 @@
-{
-  "name": "@neus/sdk",
-  "version": "1.1.5",
-  "description": "NEUS makes trust portable across the internet — so people, apps, and AI agents can prove what is real before access, payout, or execution.",
-  "bin": {
-    "neus": "cli/neus.mjs"
-  },
-  "main": "index.js",
-  "type": "module",
-  "types": "types.d.ts",
-  "exports": {
-    ".": {
-      "types": "./types.d.ts",
-      "import": "./index.js",
-      "require": "./cjs/index.cjs"
-    },
-    "./client": {
-      "types": "./types.d.ts",
-      "import": "./client.js",
-      "require": "./cjs/client.cjs"
-    },
-    "./utils": {
-      "import": "./utils.js",
-      "require": "./cjs/utils.cjs"
-    },
-    "./errors": {
-      "import": "./errors.js",
-      "require": "./cjs/errors.cjs"
-    },
-    "./gates": {
-      "import": "./gates.js",
-      "require": "./cjs/gates.cjs"
-    },
-    "./mcp-hosts": {
-      "import": "./mcp-hosts.js",
-      "require": "./cjs/mcp-hosts.cjs"
-    },
-    "./widgets": {
-      "types": "./types.d.ts",
-      "import": "./widgets/index.js",
-      "require": "./widgets.cjs"
-    },
-    "./widgets/verify-gate": {
-      "types": "./types.d.ts",
-      "import": "./widgets/verify-gate/index.js",
-      "require": "./widgets.cjs"
-    }
-  },
-  "sideEffects": false,
-  "scripts": {
-    "test": "npm run build:cjs && vitest run",
-    "test:coverage": "vitest run --coverage",
-    "lint": "eslint . --ignore-pattern widgets/verify-gate/dist/**",
-    "format": "prettier --write \"**/*.js\"",
-    "build": "npm run build:widgets && npm run build:cjs",
-    "build:widgets": "npx esbuild widgets/verify-gate/VerifyGate.jsx widgets/verify-gate/ProofBadge.jsx --bundle --platform=browser --format=esm --outdir=widgets/verify-gate/dist --jsx=automatic --legal-comments=none --external:react --external:react-dom --external:react/jsx-runtime --external:@neus/sdk/client",
-    "build:cjs": "npx esbuild index.js client.js utils.js errors.js gates.js mcp-hosts.js --bundle --platform=node --format=cjs --outdir=cjs --out-extension:.js=.cjs --legal-comments=none --external:ethers --external:@zkpassport/sdk --external:react --external:react-dom --external:react/jsx-runtime",
-    "prepack": "npm run build",
-    "prepublishOnly": "npm run lint && npm test && npm run build"
-  },
-  "keywords": [
-    "neus",
-    "verification",
-    "cryptographic-proofs",
-    "identity",
-    "authentication",
-    "blockchain",
-    "cross-chain",
-    "web3",
-    "passwordless",
-    "universal-protocol",
-    "proof",
-    "ownership",
-    "sdk",
-    "mcp",
-    "model-context-protocol",
-    "oauth"
-  ],
-  "author": "NEUS Network",
-  "license": "Apache-2.0",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/neus/network.git",
-    "directory": "sdk"
-  },
-  "bugs": {
-    "url": "https://github.com/neus/network/issues"
-  },
-  "homepage": "https://neus.network",
-  "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org"
-  },
-  "engines": {
-    "node": ">=20.0.0"
-  },
-  "peerDependencies": {
-    "ethers": "^6.0.0",
-    "react": ">=17.0.0",
-    "react-dom": ">=17.0.0"
-  },
-  "peerDependenciesMeta": {
-    "@zkpassport/sdk": {
-      "optional": true
-    },
-    "react": {
-      "optional": true
-    },
-    "react-dom": {
-      "optional": true
-    }
-  },
-  "optionalDependencies": {
-    "@zkpassport/sdk": "^0.14.0"
-  },
-  "dependencies": {
-    "bs58": "^6.0.0"
-  },
-  "devDependencies": {
-    "@vitest/coverage-v8": "^4.1.3",
-    "esbuild": "^0.28.0",
-    "eslint": "^8.56.0",
-    "eslint-plugin-react": "^7.37.2",
-    "prettier": "^3.2.0",
-    "vitest": "^4.1.3"
-  },
-  "files": [
-    "cli/neus.mjs",
-    "mcp-hosts.js",
-    "index.js",
-    "client.js",
-    "utils.js",
-    "errors.js",
-    "gates.js",
-    "sponsor.js",
-    "cjs/**",
-    "widgets.cjs",
-    "types.d.ts",
-    "README.md",
-    "SECURITY.md",
-    "LICENSE",
-    "widgets/index.js",
-    "widgets/verify-gate/index.js",
-    "widgets/verify-gate/dist/VerifyGate.js",
-    "widgets/verify-gate/dist/ProofBadge.js"
-  ]
-}
+{
+  "name": "@neus/sdk",
+  "version": "1.1.7",
+  "description": "NEUS makes trust portable across the internet — so people, apps, and AI agents can prove what is real before access, payout, or execution.",
+  "bin": {
+    "neus": "cli/neus.mjs"
+  },
+  "main": "index.js",
+  "type": "module",
+  "types": "types.d.ts",
+  "exports": {
+    ".": {
+      "types": "./types.d.ts",
+      "import": "./index.js",
+      "require": "./cjs/index.cjs"
+    },
+    "./client": {
+      "types": "./types.d.ts",
+      "import": "./client.js",
+      "require": "./cjs/client.cjs"
+    },
+    "./utils": {
+      "import": "./utils.js",
+      "require": "./cjs/utils.cjs"
+    },
+    "./errors": {
+      "import": "./errors.js",
+      "require": "./cjs/errors.cjs"
+    },
+    "./gates": {
+      "import": "./gates.js",
+      "require": "./cjs/gates.cjs"
+    },
+    "./mcp-hosts": {
+      "import": "./mcp-hosts.js",
+      "require": "./cjs/mcp-hosts.cjs"
+    },
+    "./widgets": {
+      "types": "./types.d.ts",
+      "import": "./widgets/index.js",
+      "require": "./widgets.cjs"
+    },
+    "./widgets/verify-gate": {
+      "types": "./types.d.ts",
+      "import": "./widgets/verify-gate/index.js",
+      "require": "./widgets.cjs"
+    }
+  },
+  "sideEffects": false,
+  "scripts": {
+    "test": "npm run build:cjs && vitest run",
+    "test:coverage": "vitest run --coverage",
+    "lint": "eslint . --ignore-pattern widgets/verify-gate/dist/**",
+    "format": "prettier --write \"**/*.js\"",
+    "build": "npm run build:widgets && npm run build:cjs",
+    "build:widgets": "npx esbuild widgets/verify-gate/VerifyGate.jsx widgets/verify-gate/ProofBadge.jsx --bundle --platform=browser --format=esm --outdir=widgets/verify-gate/dist --jsx=automatic --legal-comments=none --external:react --external:react-dom --external:react/jsx-runtime --external:@neus/sdk/client",
+    "build:cjs": "npx esbuild index.js client.js utils.js errors.js gates.js mcp-hosts.js --bundle --platform=node --format=cjs --outdir=cjs --out-extension:.js=.cjs --legal-comments=none --external:ethers --external:@zkpassport/sdk --external:react --external:react-dom --external:react/jsx-runtime",
+    "prepack": "npm run build",
+    "prepublishOnly": "npm run lint && npm test && npm run build"
+  },
+  "keywords": [
+    "neus",
+    "verification",
+    "cryptographic-proofs",
+    "identity",
+    "authentication",
+    "blockchain",
+    "cross-chain",
+    "web3",
+    "passwordless",
+    "universal-protocol",
+    "proof",
+    "ownership",
+    "sdk",
+    "mcp",
+    "model-context-protocol",
+    "oauth"
+  ],
+  "author": "NEUS Network",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/neus/network.git",
+    "directory": "sdk"
+  },
+  "bugs": {
+    "url": "https://github.com/neus/network/issues"
+  },
+  "homepage": "https://neus.network",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "peerDependencies": {
+    "ethers": "^6.0.0",
+    "react": ">=17.0.0",
+    "react-dom": ">=17.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@zkpassport/sdk": {
+      "optional": true
+    },
+    "react": {
+      "optional": true
+    },
+    "react-dom": {
+      "optional": true
+    }
+  },
+  "optionalDependencies": {
+    "@zkpassport/sdk": "^0.14.0"
+  },
+  "overrides": {
+    "ws": "8.21.0"
+  },
+  "dependencies": {
+    "bs58": "^6.0.0"
+  },
+  "devDependencies": {
+    "@vitest/coverage-v8": "^4.1.3",
+    "esbuild": "^0.28.0",
+    "eslint": "^8.56.0",
+    "eslint-plugin-react": "^7.37.2",
+    "prettier": "^3.2.0",
+    "vitest": "^4.1.3"
+  },
+  "files": [
+    "cli/neus.mjs",
+    "mcp-hosts.js",
+    "index.js",
+    "client.js",
+    "utils.js",
+    "errors.js",
+    "gates.js",
+    "sponsor.js",
+    "cjs/**",
+    "widgets.cjs",
+    "types.d.ts",
+    "README.md",
+    "SECURITY.md",
+    "LICENSE",
+    "widgets/index.js",
+    "widgets/verify-gate/index.js",
+    "widgets/verify-gate/dist/VerifyGate.js",
+    "widgets/verify-gate/dist/ProofBadge.js"
+  ]
+}

package/types.d.ts

@@ -51,6 +51,12 @@
 
     checkGate(params: CheckGateParams): Promise<CheckGateResult>;
 
+    /** Public gate snapshot (requirements, charge, schedule — never the secret reward value). */
+    getGate(gateId: string): Promise<PublicGateSnapshot>;
+
+    /** Post-verify reward delivery for hosted gate checkout (session or wallet-bound). */
+    fulfillGate(params: FulfillGateParams): Promise<GateFulfillmentResponse>;
+
   }
 
   export type PrivacyLevel = 'public' | 'private';
@@ -102,6 +108,8 @@
     enableIpfs?: boolean;
     storeOriginalContent?: boolean;
     targetChains?: number[];
+    /** Anchor the receipt on the hub registry chain. Defaults to false (receipts persist offchain). */
+    publishToHub?: boolean;
     publicDisplay?: boolean;
     meta?: Record<string, any>;
     verifierOptions?: Record<string, any>;
@@ -429,12 +437,102 @@
     scheme: string;
     label: string;
     amountUsd: number;
-    methods: string[];
+    /** Payment methods offered to visitors: 'usdc' and/or 'stripe' (card). */
+    methods: Array<'usdc' | 'stripe' | string>;
+    /** True when the owner can receive card payouts (Stripe Connect ready). */
+    cardPayoutReady?: boolean;
     appliesTo: string;
+    /** 'verifyThenCharge' (default) or 'chargeThenVerify'. */
     executionOrder?: string;
     recipient?: string;
   };
 
+  /** One gate requirement row on the wire (protocol shape used by published gates). */
+  export interface GateMatchRowWire {
+    path: string;
+    op?: 'eq' | 'gte' | 'lte' | string;
+    value: string;
+  }
+
+  export interface GateRequirementWire {
+    verifierId: string;
+    match?: GateMatchRowWire[];
+    optional?: boolean;
+    minCount?: number;
+    maxAgeMs?: number;
+  }
+
+  /** Public snapshot returned by GET /api/v1/profile/gates/{gateId} — never includes the secret reward value. */
+  export interface PublicGateSnapshot {
+    schemaVersion: number;
+    gateId: string;
+    name?: string;
+    status?: string;
+    version?: number;
+    requirements: GateRequirementWire[];
+    policy?: {
+      visibility?: string;
+      gateFreshnessHours?: number;
+    };
+    monetization?: {
+      charge?: NeusPublicGateCharge | null;
+    };
+    checkout?: {
+      mode?: string;
+      flowPlan?: {
+        batches?: number;
+        hasInteractive?: boolean;
+        hasBackground?: boolean;
+      };
+      description?: string;
+      successReturnUrl?: string;
+    };
+    marketplaceTemplate?: {
+      templateId: string;
+      label?: string;
+      tags?: string[];
+    };
+    schedule?: {
+      startsAt?: string;
+      endsAt?: string;
+    };
+    artifact?: {
+      type: string;
+      label?: string;
+    };
+  }
+
+  export interface FulfillGateParams {
+    gateId: string;
+    /** Verified proof receipt id for this checkout. */
+    qHash: string;
+    /** Required when no session cookie binds the wallet. */
+    walletAddress?: string;
+    /** Stripe checkout session id for paid gates (card rail). */
+    paymentCheckoutSessionId?: string;
+    /** USDC payment transaction hash for paid gates (wallet rail). */
+    paymentTxHash?: string;
+  }
+
+  export interface GateFulfillmentResult {
+    delivery: 'access_granted' | 'redirect' | 'download' | 'reveal' | string;
+    type?: string;
+    value?: string;
+    label?: string;
+    message?: string;
+  }
+
+  export interface GateFulfillmentResponse {
+    success: boolean;
+    data?: {
+      gateId: string;
+      qHash: string;
+      fulfillment: GateFulfillmentResult;
+      successReturnUrl?: string;
+    };
+    error?: any;
+  }
+
   export const NEUS_CONSTANTS: {
     HUB_CHAIN_ID: number;
     TESTNET_CHAINS: number[];
@@ -482,16 +580,36 @@
     cursor?: string;
     chain?: string;
     signatureMethod?: string;
+    q?: string;
+    qHash?: string;
+    verifierId?: string;
+    verifierIds?: string;
+    tags?: string;
+    tagPrefix?: string;
+    tagContains?: string;
+    tagPrefixesAll?: string;
+    status?: string;
+    appId?: string;
+    chainCoverage?: 'hub-only' | 'cross-chain';
+    privacyLevel?: 'public' | 'private';
+    includeHistory?: boolean;
+    includeFacets?: string;
+    visibility?: 'public';
+    isPublicRead?: boolean;
   }
 
   export interface ProofsResult {
     success: boolean;
     proofs: any[];
-    totalCount: number;
+    totalCount: number | null;
     hasMore: boolean;
     nextOffset?: number | null;
     /** Keyset continuation when the API returns cursor paging (preferred over deep offsets). */
     nextCursor?: string | null;
+    facets?: {
+      tags?: string[];
+      truncated?: boolean;
+    } | null;
   }
 
   export interface GateRequirement {
@@ -499,7 +617,11 @@
     maxAgeMs?: number;
     optional?: boolean;
     minCount?: number;
-    match?: Record<string, any>;
+    /**
+     * Either the protocol wire shape (array of { path, op, value } rows — what
+     * published gates store) or a flat { path: value } map for client-side checks.
+     */
+    match?: GateMatchRowWire[] | Record<string, any>;
   }
 
   export interface CheckGateParams {
@@ -577,6 +699,25 @@
       matchedTags?: string[];
       projections?: Array<Record<string, any>> | null;
       criteria?: Record<string, any>;
+      /**
+       * Per-requirement gate evaluation — present whenever `gateId` was passed.
+       * `allRequiredSatisfied === true` is the ONLY readiness signal for gate
+       * checkout; `eligible`/`matchedCount` alone are not sufficient.
+       */
+      gate?: {
+        gateId: string | null;
+        allRequiredSatisfied: boolean;
+        satisfiedVerifierIds: string[];
+        missingVerifierIds: string[];
+        /** verifierId → qHash map for `options.reusedVerifierProofs` on submit (requires includeQHashes=true). */
+        reusedVerifierProofs?: Record<string, string>;
+        /** Per-requirement rows (requires includeQHashes=true). */
+        rows?: Array<{
+          verifierId: string;
+          satisfied: boolean;
+          qHashes?: string[];
+        }>;
+      };
     };
     error?: any;
   }
@@ -830,6 +971,8 @@
   
   interface VerifyOptions {
     targetChains?: number[];
+    /** Anchor the receipt on the hub registry chain. Defaults to false (receipts persist offchain). */
+    publishToHub?: boolean;
     enableIpfs?: boolean;
     privacyLevel?: 'private' | 'public';
     publicDisplay?: boolean;