@nevermined-io/payments 1.5.0 → 1.7.0

package/README.md

@@ -19,16 +19,15 @@ The Nevermined Payments Library is a TypeScript SDK that allows AI Builders and
 
 The Payments Library enables:
 
-* Easy registration and discovery of AI agents and the payment plans required to access them. All agents registered in Nevermined expose their metadata in a generic way, making them searchable and discoverable for specific purposes.
-* Flexible definition of pricing options and how AI agents can be queried. This is achieved through payment plans (based on time or credits) and consumption costs (fixed per request or dynamic). All of this can be defined by the AI builder or agent during the registration process.
-* Subscribers (humans or other agents) to purchase credits that grant access to AI agent services. Payments can be made in crypto or fiat via Stripe integration. The protocol registers the payment and credits distribution settlement on-chain.
-* Agents or users with access credits to query other AI agents. Nevermined authorizes only users with sufficient balance and keeps track of their credit usage.
-
+- Easy registration and discovery of AI agents and the payment plans required to access them. All agents registered in Nevermined expose their metadata in a generic way, making them searchable and discoverable for specific purposes.
+- Flexible definition of pricing options and how AI agents can be queried. This is achieved through payment plans (based on time or credits) and consumption costs (fixed per request or dynamic). All of this can be defined by the AI builder or agent during the registration process.
+- Subscribers (humans or other agents) to purchase credits that grant access to AI agent services. Payments can be made in crypto or fiat via Stripe integration. The protocol registers the payment and credits distribution settlement on-chain.
+- Agents or users with access credits to query other AI agents. Nevermined authorizes only users with sufficient balance and keeps track of their credit usage.
 
 The library is designed for use in browser environments or as part of AI Agents:
 
-* In a browser, the library provides a simple way to connect to the Nevermined protocol, allowing users to query AI Agents or publish their own.
-* As part of an AI Agent, the library allows the agent to query other agents programmatically. Additionally, agents can use the library to expose their own services and make them available to other agents or humans.
+- In a browser, the library provides a simple way to connect to the Nevermined protocol, allowing users to query AI Agents or publish their own.
+- As part of an AI Agent, the library allows the agent to query other agents programmatically. Additionally, agents can use the library to expose their own services and make them available to other agents or humans.
 
 ## Quickstart
 
@@ -41,6 +40,7 @@ npm install @nevermined-io/payments@^1.1
 ```
 
 > Pin the major version (or rely on a committed lockfile) so SDK upgrades are explicit. Always commit `package-lock.json` / `pnpm-lock.yaml`.
+
 ## A2A Integration (Agents‑to‑Agents)
 
 Nevermined Payments integrates with the A2A protocol to authorize and charge per request between agents:
@@ -78,13 +78,13 @@ Add a payment extension under `capabilities.extensions` carrying Nevermined meta
 ```
 
 Important notes:
+
 - The `url` must match exactly the URL registered in Nevermined for the agent/plan.
 - The final streaming event must include `metadata.creditsUsed` with the consumed cost.
 
-
 ## Requirements
 
-To use the Nevermined Payments Library, you need to get your Nevermined API key. You can get yours freely from the  [Nevermined App](https://nevermined.app).
+To use the Nevermined Payments Library, you need to get your Nevermined API key. You can get yours freely from the [Nevermined App](https://nevermined.app).
 
 ### Environments
 
@@ -92,6 +92,15 @@ To use the Nevermined Payments Library, you need to get your Nevermined API key.
 
 Pick the environment that matches where your agent and plans are registered. The agent card `url` must belong to that environment.
 
+### Optional peer dependencies
+
+The core SDK has no required runtime peers. Some integrations are gated behind optional peer dependencies you install only if you use them:
+
+- **LangChain tool protection** (`@nevermined-io/payments/langchain`) — requires `@langchain/core` and `@langchain/langgraph >=1.0.0 <2`.
+- **LangSmith observability** (`@nevermined-io/payments/langsmith`, and the spans the `requiresPayment` wrapper emits when `LANGSMITH_TRACING=true`) — requires **`langsmith >=0.7`**. The spans rely on `getCurrentRunTree` (exported from `langsmith/singletons/traceable`) and the merging `RunTree.metadata` setter, both of which are only reliably present from `0.7` onward. Install it yourself: `pnpm add langsmith`.
+
+These are declared as optional peers, so npm/pnpm will not pull them in automatically and the SDK no-ops cleanly when they are absent.
+
 ### Initialize the Payments library in the Browser
 
 This is a browser only method. Here we have an example using react.
@@ -124,7 +133,7 @@ export default function Home() {
 ### Initialize the Payments library in an AI Agent
 
 ```typescript
-import { Payments } from "@nevermined-io/payments";
+import { Payments } from '@nevermined-io/payments'
 
 const payments = Payments.getInstance({
   nvmApiKey,
@@ -138,19 +147,29 @@ Once the app is initialized we can create a payment plan:
 
 ```typescript
 const planMetadata: PlanMetadata = {
-    name: 'E2E test Payments Plan',
-  }
+  name: 'E2E test Payments Plan',
+}
 const priceConfig = payments.plans.getERC20PriceConfig(20n, ERC20_ADDRESS, builderAddress)
 const creditsConfig = payments.plans.getFixedCreditsConfig(100n)
-const { planId } = await payments.plans.registerCreditsPlan(planMetadata, priceConfig, creditsConfig)
+const { planId } = await payments.plans.registerCreditsPlan(
+  planMetadata,
+  priceConfig,
+  creditsConfig,
+)
 ```
 
 Or register a plan limited by time:
 
 ```typescript
 const priceConfig = payments.plans.getERC20PriceConfig(50n, ERC20_ADDRESS, builderAddress)
-const expirablePlanConfig = payments.plans.getExpirableDurationConfig(payments.plans.ONE_DAY_DURATION) // 1 day
-const response = await payments.plans.registerTimePlan(planMetadata, priceConfig, expirablePlanConfig)
+const expirablePlanConfig = payments.plans.getExpirableDurationConfig(
+  payments.plans.ONE_DAY_DURATION,
+) // 1 day
+const response = await payments.plans.registerTimePlan(
+  planMetadata,
+  priceConfig,
+  expirablePlanConfig,
+)
 ```
 
 You can also create trial plans (free plans that can only be purchased once):
@@ -166,7 +185,7 @@ const trialCreditsConfig = payments.plans.getFixedCreditsConfig(10n)
 const trialPlan = await payments.plans.registerCreditsTrialPlan(
   trialPlanMetadata,
   freePriceConfig,
-  trialCreditsConfig
+  trialCreditsConfig,
 )
 
 // Time-based trial plan
@@ -174,7 +193,7 @@ const timeTrialConfig = payments.plans.getExpirableDurationConfig(ONE_DAY_DURATI
 const timeTrialPlan = await payments.plans.registerTimeTrialPlan(
   trialPlanMetadata,
   freePriceConfig,
-  timeTrialConfig
+  timeTrialConfig,
 )
 ```
 
@@ -192,12 +211,13 @@ const agentMetadata = {
 // The API that the agent will expose
 const agentApi = {
   endpoints: [
-    { 'POST': `https://example.com/api/v1/agents/:agentId/tasks` },
-    { 'GET': `https://example.com/api/v1/agents/:agentId/tasks/invoke` }
-]}
+    { POST: `https://example.com/api/v1/agents/:agentId/tasks` },
+    { GET: `https://example.com/api/v1/agents/:agentId/tasks/invoke` },
+  ],
+}
 
 // This is the list of payment plans that the agent will accept
-const paymentPlans = [ creditsPlanId, expirablePlanId ]
+const paymentPlans = [creditsPlanId, expirablePlanId]
 const result = await payments.agents.registerAgent(agentMetadata, agentApi, paymentPlans)
 ```
 
@@ -212,9 +232,7 @@ const agentMetadata = {
 }
 
 const agentApi = {
-  endpoints: [
-    { 'POST': 'https://example.com/api/v1/agents/:agentId/tasks' }
-  ]
+  endpoints: [{ POST: 'https://example.com/api/v1/agents/:agentId/tasks' }],
 }
 
 const planMetadata = { name: 'Basic Plan' }
@@ -228,11 +246,12 @@ const { agentId, planId, txHash } = await payments.agents.registerAgentAndPlan(
   planMetadata,
   priceConfig,
   creditsConfig,
-  'time' // Optionally set access limit to 'time' or 'credits'
+  'time', // Optionally set access limit to 'time' or 'credits'
 )
 ```
 
 The `accessLimit` parameter is optional. If not specified, it's automatically inferred:
+
 - `'credits'` if `creditsConfig.durationSecs === 0n` (non-expirable)
 - `'time'` if `creditsConfig.durationSecs > 0n` (expirable)
 
@@ -261,7 +280,7 @@ const agentHTTPOptions = {
   headers: {
     Accept: 'application/json',
     'Content-Type': 'application/json',
-    'payment-signature': accessToken
+    'payment-signature': accessToken,
   },
 }
 const response = await fetch(new URL(agentURL), agentHTTPOptions)
@@ -281,7 +300,7 @@ MCP servers expose handlers (tools/resources/prompts) with their logical URLs, s
 
 ### Why Nevermined Payments?
 
-While MCP defines *what* an agent can do, it doesn't specify *who* can access it or *how* to charge for it. **Nevermined Payments** adds:
+While MCP defines _what_ an agent can do, it doesn't specify _who_ can access it or _how_ to charge for it. **Nevermined Payments** adds:
 
 - **Authentication**: Validates user tokens via `Authorization` header
 - **Credit System**: Checks and deducts credits per request
@@ -292,77 +311,77 @@ While MCP defines *what* an agent can do, it doesn't specify *who* can access it
 #### 1. Initialize Nevermined Payments
 
 ```typescript
-import { Payments, EnvironmentName } from "@nevermined-io/payments";
+import { Payments, EnvironmentName } from '@nevermined-io/payments'
 
 const payments = Payments.getInstance({
   nvmApiKey: process.env.NVM_API_KEY!,
   environment: process.env.NVM_ENVIRONMENT! as EnvironmentName,
-});
+})
 ```
 
 #### 2. Register Protected Tools
 
 ```typescript
-import { z } from "zod";
+import { z } from 'zod'
 
 const schema = z.object({
-  city: z.string().describe("City name"),
-}) as any;
+  city: z.string().describe('City name'),
+}) as any
 
 payments.mcp.registerTool(
-  "weather.today",
+  'weather.today',
   {
     title: "Today's Weather",
-    description: "Get weather for a city",
+    description: 'Get weather for a city',
     inputSchema: schema,
   },
   async (args) => {
-    const { city } = args as { city: string };
+    const { city } = args as { city: string }
     return {
-      content: [{ type: "text", text: `Weather for ${city}: Sunny, 25C` }],
-    };
+      content: [{ type: 'text', text: `Weather for ${city}: Sunny, 25C` }],
+    }
   },
-  { credits: 1n }
-);
+  { credits: 1n },
+)
 ```
 
 #### 3. Register Protected Resources
 
 ```typescript
 payments.mcp.registerResource(
-  "Weather Data",
-  "weather://today",
+  'Weather Data',
+  'weather://today',
   {
     title: "Today's Weather",
-    description: "JSON weather data",
-    mimeType: "application/json",
+    description: 'JSON weather data',
+    mimeType: 'application/json',
   },
   async (uri) => {
     return {
-      contents: [{ uri: uri.href, text: "{...}", mimeType: "application/json" }],
-    };
+      contents: [{ uri: uri.href, text: '{...}', mimeType: 'application/json' }],
+    }
   },
-  { credits: 5n }
-);
+  { credits: 5n },
+)
 ```
 
 #### 4. Register Protected Prompts
 
 ```typescript
 payments.mcp.registerPrompt(
-  "weather.ensureCity",
+  'weather.ensureCity',
   {
-    title: "Ensure city",
-    description: "Guide to call weather.today",
+    title: 'Ensure city',
+    description: 'Guide to call weather.today',
     argsSchema: schema,
   },
   (args) => {
     return {
-      messages: [{ role: "user", content: { type: "text", text: "..." } }],
-    };
+      messages: [{ role: 'user', content: { type: 'text', text: '...' } }],
+    }
   },
-  { credits: (ctx) => ctx.result.length > 100 ? 2n : 1n }  // Dynamic credits
-);
+  { credits: (ctx) => (ctx.result.length > 100 ? 2n : 1n) }, // Dynamic credits
+)
 ```
 
 #### 5. Start the Server
@@ -371,9 +390,9 @@ payments.mcp.registerPrompt(
 const { info, stop } = await payments.mcp.start({
   port: 3002,
   agentId: process.env.NVM_AGENT_ID!,
-  serverName: "weather-mcp",
-  version: "0.1.0",
-});
+  serverName: 'weather-mcp',
+  version: '0.1.0',
+})
 ```
 
 ### Credit Configuration
@@ -382,22 +401,32 @@ All registration functions support fixed or dynamic credits:
 
 ```typescript
 // Fixed credits
-{ credits: 1n }
-{ credits: 5n }
+{
+  credits: 1n
+}
+{
+  credits: 5n
+}
 
 // Dynamic credits based on input
-{ credits: (ctx) => ctx.args.premium ? 5n : 1n }
+{
+  credits: (ctx) => (ctx.args.premium ? 5n : 1n)
+}
 
 // Dynamic credits based on result
-{ credits: (ctx) => ctx.result.length > 1000 ? 3n : 1n }
+{
+  credits: (ctx) => (ctx.result.length > 1000 ? 3n : 1n)
+}
 
 // Tiered pricing
-{ credits: (ctx) => {
-  const size = JSON.stringify(ctx.result).length;
-  if (size > 1000) return 5n;
-  if (size > 500) return 3n;
-  return 1n;
-}}
+{
+  credits: (ctx) => {
+    const size = JSON.stringify(ctx.result).length
+    if (size > 1000) return 5n
+    if (size > 500) return 3n
+    return 1n
+  }
+}
 ```
 
 ### Client Usage
@@ -405,55 +434,54 @@ All registration functions support fixed or dynamic credits:
 #### Get Access Token
 
 ```typescript
-import { Payments } from "@nevermined-io/payments";
+import { Payments } from '@nevermined-io/payments'
 
 const payments = Payments.getInstance({
   nvmApiKey: process.env.NVM_API_KEY!,
-  environment: "sandbox",
-});
+  environment: 'sandbox',
+})
 
 const { accessToken } = await payments.x402.getX402AccessToken(
   process.env.NVM_PLAN_ID!,
-  process.env.NVM_AGENT_ID!
-);
+  process.env.NVM_AGENT_ID!,
+)
 ```
 
 #### Call Protected Tools
 
 ```typescript
-import { Client } from "@modelcontextprotocol/sdk/client";
-import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp";
+import { Client } from '@modelcontextprotocol/sdk/client'
+import { StreamableHTTPClientTransport } from '@modelcontextprotocol/sdk/client/streamableHttp'
 
-const transport = new StreamableHTTPClientTransport(
-  new URL("http://localhost:3002/mcp"),
-  { requestInit: { headers: { Authorization: `Bearer ${accessToken}` } } }
-);
+const transport = new StreamableHTTPClientTransport(new URL('http://localhost:3002/mcp'), {
+  requestInit: { headers: { Authorization: `Bearer ${accessToken}` } },
+})
 
-const client = new Client({ name: "my-client" });
-await client.connect(transport);
+const client = new Client({ name: 'my-client' })
+await client.connect(transport)
 
 const result = await client.callTool({
-  name: "weather.today",
-  arguments: { city: "London" },
-});
+  name: 'weather.today',
+  arguments: { city: 'London' },
+})
 ```
 
 ### Endpoints
 
-| Endpoint | Description |
-|----------|-------------|
-| `POST /mcp` | MCP JSON-RPC requests |
-| `GET /mcp` | SSE stream for notifications |
-| `DELETE /mcp` | Session termination |
-| `GET /health` | Health check |
-| `GET /` | Server info |
+| Endpoint      | Description                  |
+| ------------- | ---------------------------- |
+| `POST /mcp`   | MCP JSON-RPC requests        |
+| `GET /mcp`    | SSE stream for notifications |
+| `DELETE /mcp` | Session termination          |
+| `GET /health` | Health check                 |
+| `GET /`       | Server info                  |
 
 ### Error Codes
 
-| Code | Description |
-|------|-------------|
+| Code     | Description                                                      |
+| -------- | ---------------------------------------------------------------- |
 | `-32003` | Authorization required / Payment required / Insufficient credits |
-| `-32002` | Server error |
+| `-32002` | Server error                                                     |
 
 ### Notes
 

package/dist/api/agents-api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"agents-api.d.ts","sourceRoot":"","sources":["../../src/api/agents-api.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,kBAAkB,EAClB,aAAa,EACb,YAAY,EACZ,iBAAiB,EACjB,cAAc,EACd,iBAAiB,EACjB,YAAY,EACZ,eAAe,EAChB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,eAAe,EAAE,kBAAkB,EAA6B,MAAM,oBAAoB,CAAA;AAWnG,YAAY,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAA;AAE5D;;GAEG;AACH,qBAAa,SAAU,SAAQ,eAAe;IAC5C;;;;;OAKG;IACH,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,cAAc,GAAG,SAAS;IAItD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,aAAa,CACxB,aAAa,EAAE,aAAa,EAC5B,QAAQ,EAAE,kBAAkB,EAC5B,YAAY,EAAE,MAAM,EAAE,EACtB,kBAAkB,CAAC,EAAE,kBAAkB,GACtC,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAsB/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACU,oBAAoB,CAC/B,aAAa,EAAE,aAAa,EAC5B,QAAQ,EAAE,kBAAkB,EAC5B,YAAY,EAAE,YAAY,EAC1B,WAAW,EAAE,eAAe,EAC5B,aAAa,EAAE,iBAAiB,EAChC,WAAW,CAAC,EAAE,SAAS,GAAG,MAAM,EAChC,kBAAkB,CAAC,EAAE,kBAAkB,GACtC,OAAO,CAAC;QACT,OAAO,EAAE,MAAM,CAAA;QACf,MAAM,EAAE,MAAM,CAAA;QACd,MAAM,EAAE,MAAM,CAAA;KACf,CAAC;IAyCF;;;;;;;;;;;OAWG;IACU,QAAQ,CAAC,OAAO,EAAE,MAAM;IASrC;;;;;;;;;;;;;;;;OAgBG;IACU,mBAAmB,CAC9B,OAAO,EAAE,MAAM,EACf,aAAa,EAAE,aAAa,EAC5B,QAAQ,EAAE,kBAAkB,GAC3B,OAAO,CAAC,YAAY,CAAC;IAcxB;;;;;;;;;;;;;;;;;;OAkBG;IACU,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,oBAA0B;IAWhF;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAYnF;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;CAczF"}
+{"version":3,"file":"agents-api.d.ts","sourceRoot":"","sources":["../../src/api/agents-api.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,kBAAkB,EAClB,aAAa,EACb,YAAY,EACZ,iBAAiB,EACjB,cAAc,EACd,iBAAiB,EACjB,YAAY,EACZ,eAAe,EAChB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,eAAe,EAAE,kBAAkB,EAA6B,MAAM,oBAAoB,CAAA;AAWnG,YAAY,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAA;AAE5D;;GAEG;AACH,qBAAa,SAAU,SAAQ,eAAe;IAC5C;;;;;OAKG;IACH,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,cAAc,GAAG,SAAS;IAItD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,aAAa,CACxB,aAAa,EAAE,aAAa,EAC5B,QAAQ,EAAE,kBAAkB,EAC5B,YAAY,EAAE,MAAM,EAAE,EACtB,kBAAkB,CAAC,EAAE,kBAAkB,GACtC,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAsB/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACU,oBAAoB,CAC/B,aAAa,EAAE,aAAa,EAC5B,QAAQ,EAAE,kBAAkB,EAC5B,YAAY,EAAE,YAAY,EAC1B,WAAW,EAAE,eAAe,EAC5B,aAAa,EAAE,iBAAiB,EAChC,WAAW,CAAC,EAAE,SAAS,GAAG,MAAM,EAChC,kBAAkB,CAAC,EAAE,kBAAkB,GACtC,OAAO,CAAC;QACT,OAAO,EAAE,MAAM,CAAA;QACf,MAAM,EAAE,MAAM,CAAA;QACd,MAAM,EAAE,MAAM,CAAA;KACf,CAAC;IA4CF;;;;;;;;;;;OAWG;IACU,QAAQ,CAAC,OAAO,EAAE,MAAM;IASrC;;;;;;;;;;;;;;;;OAgBG;IACU,mBAAmB,CAC9B,OAAO,EAAE,MAAM,EACf,aAAa,EAAE,aAAa,EAC5B,QAAQ,EAAE,kBAAkB,GAC3B,OAAO,CAAC,YAAY,CAAC;IAcxB;;;;;;;;;;;;;;;;;;OAkBG;IACU,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,oBAA0B;IAWhF;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAYnF;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;CAiBzF"}

package/dist/api/agents-api.js

@@ -138,7 +138,7 @@ export class AgentsAPI extends BasePaymentsAPI {
      */
     async getAgent(agentId) {
         const url = new URL(API_URL_GET_AGENT.replace(':agentId', agentId), this.environment.backend);
-        const response = await fetch(url);
+        const response = await fetch(url, this.getPublicHTTPOptions('GET'));
         if (!response.ok) {
             throw PaymentsError.fromBackend('Agent not found', await safeParseJson(response));
         }
@@ -196,7 +196,7 @@ export class AgentsAPI extends BasePaymentsAPI {
     async getAgentPlans(agentId, pagination = new PaginationOptions()) {
         const query = API_URL_GET_AGENT_PLANS.replace(':agentId', agentId) + '?' + pagination.asQueryParams();
         const url = new URL(query, this.environment.backend);
-        const response = await fetch(url);
+        const response = await fetch(url, this.getPublicHTTPOptions('GET'));
         if (!response.ok) {
             throw PaymentsError.fromBackend('Agent not found', await safeParseJson(response));
         }

package/dist/api/agents-api.js.map

@@ -1 +1 @@
-{"version":3,"file":"agents-api.js","sourceRoot":"","sources":["../../src/api/agents-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAA;AAC3D,OAAO,EAIL,iBAAiB,GAKlB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,eAAe,EAAsB,yBAAyB,EAAE,MAAM,oBAAoB,CAAA;AACnG,OAAO,EACL,sBAAsB,EACtB,iBAAiB,EACjB,uBAAuB,EACvB,sBAAsB,EACtB,gCAAgC,EAChC,yBAAyB,EACzB,oBAAoB,GACrB,MAAM,cAAc,CAAA;AAIrB;;GAEG;AACH,MAAM,OAAO,SAAU,SAAQ,eAAe;IAC5C;;;;;OAKG;IACH,MAAM,CAAC,WAAW,CAAC,OAAuB;QACxC,OAAO,IAAI,SAAS,CAAC,OAAO,CAAC,CAAA;IAC/B,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACI,KAAK,CAAC,aAAa,CACxB,aAA4B,EAC5B,QAA4B,EAC5B,YAAsB,EACtB,kBAAuC;QAEvC,MAAM,IAAI,GAAG;YACX,kBAAkB,EAAE,aAAa;YACjC,kBAAkB,EAAE,QAAQ;YAC5B,KAAK,EAAE,YAAY;SACpB,CAAA;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,qBAAqB,CACxC,MAAM,EACN,IAAI,EACJ,yBAAyB,CAAC,kBAAkB,CAAC,CAC9C,CAAA;QACD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,sBAAsB,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;QAErE,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QAC1C,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,aAAa,CAAC,WAAW,CAAC,0BAA0B,EAAE,MAAM,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAA;QAC5F,CAAC;QACD,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;QACvC,OAAO,EAAE,OAAO,EAAE,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,CAAA;IAC5C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACI,KAAK,CAAC,oBAAoB,CAC/B,aAA4B,EAC5B,QAA4B,EAC5B,YAA0B,EAC1B,WAA4B,EAC5B,aAAgC,EAChC,WAAgC,EAChC,kBAAuC;QAMvC,IAAI,WAAW,IAAI,CAAC,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;YAC9D,MAAM,IAAI,aAAa,CACrB,sBAAsB,EACtB,gDAAgD,CACjD,CAAA;QACH,CAAC;QACD,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,WAAW,GAAG,aAAa,CAAC,YAAY,GAAG,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAA;QACpE,CAAC;QACD,MAAM,IAAI,GAAG;YACX,IAAI,EAAE;gBACJ,kBAAkB,EAAE,YAAY;gBAChC,WAAW,EAAE,WAAW;gBACxB,aAAa,EAAE,aAAa;gBAC5B,WAAW;aACZ;YACD,KAAK,EAAE;gBACL,kBAAkB,EAAE,aAAa;gBACjC,kBAAkB,EAAE,QAAQ;aAC7B;SACF,CAAA;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,qBAAqB,CACxC,MAAM,EACN,IAAI,EACJ,yBAAyB,CAAC,kBAAkB,CAAC,CAC9C,CAAA;QACD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,gCAAgC,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;QAE/E,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QAC1C,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,aAAa,CAAC,WAAW,CAAC,iCAAiC,EAAE,MAAM,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAA;QACnG,CAAC;QACD,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;QACpC,OAAO;YACL,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO;YAC5B,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM;YAC1B,MAAM,EAAE,MAAM,CAAC,MAAM;SACtB,CAAA;IACH,CAAC;IAED;;;;;;;;;;;OAWG;IACI,KAAK,CAAC,QAAQ,CAAC,OAAe;QACnC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,iBAAiB,CAAC,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;QAC7F,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAA;QACjC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,aAAa,CAAC,WAAW,CAAC,iBAAiB,EAAE,MAAM,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAA;QACnF,CAAC;QACD,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAA;IACxB,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACI,KAAK,CAAC,mBAAmB,CAC9B,OAAe,EACf,aAA4B,EAC5B,QAA4B;QAE5B,MAAM,IAAI,GAAG;YACX,kBAAkB,EAAE,aAAa;YACjC,kBAAkB,EAAE,QAAQ;SAC7B,CAAA;QACD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,oBAAoB,CAAC,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;QAChG,MAAM,OAAO,GAAG,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;QACvD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QAC1C,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,aAAa,CAAC,WAAW,CAAC,sBAAsB,EAAE,MAAM,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAA;QACxF,CAAC;QACD,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAA;IACxB,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACI,KAAK,CAAC,aAAa,CAAC,OAAe,EAAE,UAAU,GAAG,IAAI,iBAAiB,EAAE;QAC9E,MAAM,KAAK,GACT,uBAAuB,CAAC,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,GAAG,GAAG,GAAG,UAAU,CAAC,aAAa,EAAE,CAAA;QACzF,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;QACpD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAA;QACjC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,aAAa,CAAC,WAAW,CAAC,iBAAiB,EAAE,MAAM,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAA;QACnF,CAAC;QACD,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAA;IACxB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,KAAK,CAAC,cAAc,CAAC,MAAc,EAAE,OAAe;QACzD,MAAM,OAAO,GAAG,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAA;QAClD,MAAM,QAAQ,GAAG,sBAAsB,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,CAAA;QAC/F,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;QACvD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QAC1C,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,aAAa,CAAC,WAAW,CAAC,6BAA6B,EAAE,MAAM,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAA;QAC/F,CAAC;QAED,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAA;IACxB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,KAAK,CAAC,mBAAmB,CAAC,MAAc,EAAE,OAAe;QAC9D,MAAM,OAAO,GAAG,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAA;QACpD,MAAM,QAAQ,GAAG,yBAAyB,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,OAAO,CAC3E,UAAU,EACV,OAAO,CACR,CAAA;QACD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;QACvD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QAC1C,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,aAAa,CAAC,WAAW,CAAC,kCAAkC,EAAE,MAAM,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAA;QACpG,CAAC;QAED,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAA;IACxB,CAAC;CACF","sourcesContent":["import { safeParseJson } from '../common/helper.js'\nimport { PaymentsError } from '../common/payments.error.js'\nimport {\n  AgentAPIAttributes,\n  AgentMetadata,\n  NvmAPIResult,\n  PaginationOptions,\n  PaymentOptions,\n  PlanCreditsConfig,\n  PlanMetadata,\n  PlanPriceConfig,\n} from '../common/types.js'\nimport { BasePaymentsAPI, PublicationOptions, resolvePublicationHeaders } from './base-payments.js'\nimport {\n  API_URL_ADD_PLAN_AGENT,\n  API_URL_GET_AGENT,\n  API_URL_GET_AGENT_PLANS,\n  API_URL_REGISTER_AGENT,\n  API_URL_REGISTER_AGENTS_AND_PLAN,\n  API_URL_REMOVE_PLAN_AGENT,\n  API_URL_UPDATE_AGENT,\n} from './nvm-api.js'\n\nexport type { PublicationOptions } from './base-payments.js'\n\n/**\n * The AgentsAPI class provides methods to register and interact with AI Agents on Nevermined.\n */\nexport class AgentsAPI extends BasePaymentsAPI {\n  /**\n   * This method is used to create a singleton instance of the AgentsAPI class.\n   *\n   * @param options - The options to initialize the payments class.\n   * @returns The instance of the AgentsAPI class.\n   */\n  static getInstance(options: PaymentOptions): AgentsAPI {\n    return new AgentsAPI(options)\n  }\n\n  /**\n   *\n   * It registers a new AI Agent on Nevermined.\n   * The agent must be associated to one or multiple Payment Plans. Users that are subscribers of a payment plan can query the agent.\n   * Depending on the Payment Plan and the configuration of the agent, the usage of the agent/service will consume credits.\n   * When the plan expires (because the time is over or the credits are consumed), the user needs to renew the plan to continue using the agent.\n   *\n   * @remarks This method is oriented to AI Builders\n   * @remarks To call this method, the NVM API Key must have publication permissions\n   *\n   * @see https://nevermined.ai/docs/tutorials/builders/register-agent\n   *\n   * @param agentMetadata - @see {@link AgentMetadata}\n   * @param agentApi - @see {@link AgentAPIAttributes}\n   * @param paymentPlans - the list of payment plans giving access to the agent.\n   *\n   * @example\n   * ```\n   *  const agentMetadata = { name: 'My AI Payments Agent', tags: ['test'] }\n   *  const agentApi = { endpoints: [{ 'POST': 'https://example.com/api/v1/agents/:agentId/tasks' }] }\n   *  const paymentPlans = [planId]\n   *\n   *  const { agentId } = await payments.agents.registerAgent(agentMetadata, agentApi, paymentPlans)\n   * ```\n   *\n   * @returns The unique identifier of the newly created agent (Agent Id).\n   */\n  public async registerAgent(\n    agentMetadata: AgentMetadata,\n    agentApi: AgentAPIAttributes,\n    paymentPlans: string[],\n    publicationOptions?: PublicationOptions,\n  ): Promise<{ agentId: string }> {\n    const body = {\n      metadataAttributes: agentMetadata,\n      agentApiAttributes: agentApi,\n      plans: paymentPlans,\n    }\n\n    const options = this.getBackendHTTPOptions(\n      'POST',\n      body,\n      resolvePublicationHeaders(publicationOptions),\n    )\n    const url = new URL(API_URL_REGISTER_AGENT, this.environment.backend)\n\n    const response = await fetch(url, options)\n    if (!response.ok) {\n      throw PaymentsError.fromBackend('Unable to register agent', await safeParseJson(response))\n    }\n    const agentData = await response.json()\n    return { agentId: agentData.data.agentId }\n  }\n\n  /**\n   *\n   * It registers a new AI Agent and a Payment Plan associated to this new agent.\n   * Depending on the Payment Plan and the configuration of the agent, the usage of the agent/service will consume credits.\n   * When the plan expires (because the time is over or the credits are consumed), the user needs to renew the plan to continue using the agent.\n   *\n   * @remarks This method is oriented to AI Builders\n   * @remarks To call this method, the NVM API Key must have publication permissions\n   *\n   * @see https://nevermined.ai/docs/tutorials/builders/register-agent\n   *\n   * @param agentMetadata - @see {@link AgentMetadata}\n   * @param agentApi - @see {@link AgentAPIAttributes}\n   * @param planMetadata - @see {@link PlanMetadata}\n   * @param priceConfig - @see {@link PlanPriceConfig}\n   * @param creditsConfig - @see {@link PlanCreditsConfig}\n   *\n   * @example\n   * ```\n   *  const agentMetadata = { name: 'My AI Payments Agent', tags: ['test'] }\n   *  const agentApi { endpoints: [{ 'POST': 'https://example.com/api/v1/agents/:agentId/tasks' }] }\n   *  const cryptoPriceConfig = getNativeTokenPriceConfig(100n, builderAddress)\n   *  const 1dayDurationPlan = getExpirableDurationConfig(ONE_DAY_DURATION)\n   *  const { agentId, planId } = await payments.agents.registerAgentAndPlan(\n   *    agentMetadata,\n   *    agentApi,\n   *    cryptoPriceConfig,\n   *    1dayDurationPlan\n   *  )\n   * ```\n   *\n   * @returns The unique identifier of the newly created agent (agentId).\n   * @returns The unique identifier of the newly created plan (planId).\n   */\n  public async registerAgentAndPlan(\n    agentMetadata: AgentMetadata,\n    agentApi: AgentAPIAttributes,\n    planMetadata: PlanMetadata,\n    priceConfig: PlanPriceConfig,\n    creditsConfig: PlanCreditsConfig,\n    accessLimit?: 'credits' | 'time',\n    publicationOptions?: PublicationOptions,\n  ): Promise<{\n    agentId: string\n    planId: string\n    txHash: string\n  }> {\n    if (accessLimit && !['credits', 'time'].includes(accessLimit)) {\n      throw new PaymentsError(\n        'Invalid access limit',\n        'accessLimit must be either \"credits\" or \"time\"',\n      )\n    }\n    if (!accessLimit) {\n      accessLimit = creditsConfig.durationSecs > 0n ? 'time' : 'credits'\n    }\n    const body = {\n      plan: {\n        metadataAttributes: planMetadata,\n        priceConfig: priceConfig,\n        creditsConfig: creditsConfig,\n        accessLimit,\n      },\n      agent: {\n        metadataAttributes: agentMetadata,\n        agentApiAttributes: agentApi,\n      },\n    }\n    const options = this.getBackendHTTPOptions(\n      'POST',\n      body,\n      resolvePublicationHeaders(publicationOptions),\n    )\n    const url = new URL(API_URL_REGISTER_AGENTS_AND_PLAN, this.environment.backend)\n\n    const response = await fetch(url, options)\n    if (!response.ok) {\n      throw PaymentsError.fromBackend('Unable to register agent & plan', await safeParseJson(response))\n    }\n    const result = await response.json()\n    return {\n      agentId: result.data.agentId,\n      planId: result.data.planId,\n      txHash: result.txHash,\n    }\n  }\n\n  /**\n   * Gets the metadata for a given Agent identifier.\n   *\n   * @param agentId - The unique identifier of the agent.\n   * @returns A promise that resolves to the agent's metadata.\n   * @throws PaymentsError if the agent is not found.\n   *\n   * @example\n   * ```\n   *  const plan = payments.agents.getAgent(agentId)\n   * ```\n   */\n  public async getAgent(agentId: string) {\n    const url = new URL(API_URL_GET_AGENT.replace(':agentId', agentId), this.environment.backend)\n    const response = await fetch(url)\n    if (!response.ok) {\n      throw PaymentsError.fromBackend('Agent not found', await safeParseJson(response))\n    }\n    return response.json()\n  }\n\n  /**\n   * Updates the metadata and API attributes of an existing AI Agent.\n   *\n   * @param agentId - The unique identifier of the agent.\n   * @param agentMetadata - The new metadata attributes for the agent.\n   * @param agentApi - The new API attributes for the agent.\n   * @returns  @see {@link NvmAPIResult} A promise that resolves indicating if the operation was successful.\n   * @throws PaymentsError if the agent is not found or if the update fails.\n   *\n   * @example\n   * ```\n   *  const agentMetadata = { name: 'My Updated Agent', tags: ['test'] }\n   *  const agentApi = { endpoints: [{ 'POST': 'https://nevermined.app/api/v1/agents/:agentId/tasks' }] }\n   *\n   *  await payments.agents.updateAgentMetadata(agentId, agentMetadata, agentApi)\n   * ```\n   */\n  public async updateAgentMetadata(\n    agentId: string,\n    agentMetadata: AgentMetadata,\n    agentApi: AgentAPIAttributes,\n  ): Promise<NvmAPIResult> {\n    const body = {\n      metadataAttributes: agentMetadata,\n      agentApiAttributes: agentApi,\n    }\n    const url = new URL(API_URL_UPDATE_AGENT.replace(':agentId', agentId), this.environment.backend)\n    const options = this.getBackendHTTPOptions('PUT', body)\n    const response = await fetch(url, options)\n    if (!response.ok) {\n      throw PaymentsError.fromBackend('Error updating agent', await safeParseJson(response))\n    }\n    return response.json()\n  }\n\n  /**\n   * Gets the list of plans that can be ordered to get access to an agent.\n   *\n   * @param agentId - The unique identifier of the agent.\n   * @param pagination - Optional pagination options to control the number of results returned.p\n   * @returns A promise that resolves to the list of all different plans giving access to the agent.\n   * @throws PaymentsError if the agent is not found.\n   *\n   * @example\n   * ```\n   *  const result = payments.agents.getAgentPlans(planId)\n   *  // {\n   *  //  total: 10,\n   *  //  page: 1,\n   *  //  offset: 5,\n   *  //  plans: [ ..]\n   *  // }\n   * ```\n   */\n  public async getAgentPlans(agentId: string, pagination = new PaginationOptions()) {\n    const query =\n      API_URL_GET_AGENT_PLANS.replace(':agentId', agentId) + '?' + pagination.asQueryParams()\n    const url = new URL(query, this.environment.backend)\n    const response = await fetch(url)\n    if (!response.ok) {\n      throw PaymentsError.fromBackend('Agent not found', await safeParseJson(response))\n    }\n    return response.json()\n  }\n\n  /**\n   * Adds an existing Payment Plan to an AI Agent.\n   * After this operation, users with access to the Payment Plan will be able to access the AI Agent.\n   *\n   * @remarks\n   * Only the owner of the Payment Plan can call this method.\n   *\n   * @param planId - The unique identifier of the Payment Plan.\n   * @param agentId - The unique identifier of the AI Agent.\n   * @returns  @see {@link NvmAPIResult} A promise that resolves indicating if the operation was successful.\n   * @throws PaymentsError if unable to add the plan to the agent.\n   *\n   * @example\n   * ```\n   * const result = await payments.agents.addPlanToAgent(planId, agentId)\n   * // {\n   * //   txHash: '0x8d29d5769e832a35e53f80cd4e8890d941c50a09c33dbd975533debc894f2535',\n   * //   success: true\n   * // }\n   * ```\n   */\n  public async addPlanToAgent(planId: string, agentId: string): Promise<NvmAPIResult> {\n    const options = this.getBackendHTTPOptions('POST')\n    const endpoint = API_URL_ADD_PLAN_AGENT.replace(':planId', planId).replace(':agentId', agentId)\n    const url = new URL(endpoint, this.environment.backend)\n    const response = await fetch(url, options)\n    if (!response.ok) {\n      throw PaymentsError.fromBackend('Unable to add plan to agent', await safeParseJson(response))\n    }\n\n    return response.json()\n  }\n\n  /**\n   * Removes a Payment Plan from an AI Agent.\n   * After this operation, users with access to the Payment Plan will no longer be able to access the AI Agent.\n   *\n   * @remarks\n   * Only the owner of the Payment Plan can call this method.\n   *\n   * @param planId - The unique identifier of the Payment Plan.\n   * @param agentId - The unique identifier of the AI Agent.\n   * @returns  @see {@link NvmAPIResult} A promise that resolves indicating if the operation was successful.\n   * @throws PaymentsError if unable to remove the plan from the agent.\n   *\n   * @example\n   * ```\n   * const result = await payments.agents.removePlanFromAgent(planId, agentId)\n   * // {\n   * //   txHash: '0x8d29d5769e832a35e53f80cd4e8890d941c50a09c33dbd975533debc894f2535',\n   * //   success: true\n   * // }\n   * ```\n   */\n  public async removePlanFromAgent(planId: string, agentId: string): Promise<NvmAPIResult> {\n    const options = this.getBackendHTTPOptions('DELETE')\n    const endpoint = API_URL_REMOVE_PLAN_AGENT.replace(':planId', planId).replace(\n      ':agentId',\n      agentId,\n    )\n    const url = new URL(endpoint, this.environment.backend)\n    const response = await fetch(url, options)\n    if (!response.ok) {\n      throw PaymentsError.fromBackend('Unable to remove plan from agent', await safeParseJson(response))\n    }\n\n    return response.json()\n  }\n}\n"]}
+{"version":3,"file":"agents-api.js","sourceRoot":"","sources":["../../src/api/agents-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAA;AAC3D,OAAO,EAIL,iBAAiB,GAKlB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,eAAe,EAAsB,yBAAyB,EAAE,MAAM,oBAAoB,CAAA;AACnG,OAAO,EACL,sBAAsB,EACtB,iBAAiB,EACjB,uBAAuB,EACvB,sBAAsB,EACtB,gCAAgC,EAChC,yBAAyB,EACzB,oBAAoB,GACrB,MAAM,cAAc,CAAA;AAIrB;;GAEG;AACH,MAAM,OAAO,SAAU,SAAQ,eAAe;IAC5C;;;;;OAKG;IACH,MAAM,CAAC,WAAW,CAAC,OAAuB;QACxC,OAAO,IAAI,SAAS,CAAC,OAAO,CAAC,CAAA;IAC/B,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACI,KAAK,CAAC,aAAa,CACxB,aAA4B,EAC5B,QAA4B,EAC5B,YAAsB,EACtB,kBAAuC;QAEvC,MAAM,IAAI,GAAG;YACX,kBAAkB,EAAE,aAAa;YACjC,kBAAkB,EAAE,QAAQ;YAC5B,KAAK,EAAE,YAAY;SACpB,CAAA;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,qBAAqB,CACxC,MAAM,EACN,IAAI,EACJ,yBAAyB,CAAC,kBAAkB,CAAC,CAC9C,CAAA;QACD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,sBAAsB,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;QAErE,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QAC1C,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,aAAa,CAAC,WAAW,CAAC,0BAA0B,EAAE,MAAM,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAA;QAC5F,CAAC;QACD,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;QACvC,OAAO,EAAE,OAAO,EAAE,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,CAAA;IAC5C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACI,KAAK,CAAC,oBAAoB,CAC/B,aAA4B,EAC5B,QAA4B,EAC5B,YAA0B,EAC1B,WAA4B,EAC5B,aAAgC,EAChC,WAAgC,EAChC,kBAAuC;QAMvC,IAAI,WAAW,IAAI,CAAC,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;YAC9D,MAAM,IAAI,aAAa,CACrB,sBAAsB,EACtB,gDAAgD,CACjD,CAAA;QACH,CAAC;QACD,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,WAAW,GAAG,aAAa,CAAC,YAAY,GAAG,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAA;QACpE,CAAC;QACD,MAAM,IAAI,GAAG;YACX,IAAI,EAAE;gBACJ,kBAAkB,EAAE,YAAY;gBAChC,WAAW,EAAE,WAAW;gBACxB,aAAa,EAAE,aAAa;gBAC5B,WAAW;aACZ;YACD,KAAK,EAAE;gBACL,kBAAkB,EAAE,aAAa;gBACjC,kBAAkB,EAAE,QAAQ;aAC7B;SACF,CAAA;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,qBAAqB,CACxC,MAAM,EACN,IAAI,EACJ,yBAAyB,CAAC,kBAAkB,CAAC,CAC9C,CAAA;QACD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,gCAAgC,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;QAE/E,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QAC1C,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,aAAa,CAAC,WAAW,CAC7B,iCAAiC,EACjC,MAAM,aAAa,CAAC,QAAQ,CAAC,CAC9B,CAAA;QACH,CAAC;QACD,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;QACpC,OAAO;YACL,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO;YAC5B,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM;YAC1B,MAAM,EAAE,MAAM,CAAC,MAAM;SACtB,CAAA;IACH,CAAC;IAED;;;;;;;;;;;OAWG;IACI,KAAK,CAAC,QAAQ,CAAC,OAAe;QACnC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,iBAAiB,CAAC,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;QAC7F,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAA;QACnE,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,aAAa,CAAC,WAAW,CAAC,iBAAiB,EAAE,MAAM,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAA;QACnF,CAAC;QACD,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAA;IACxB,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACI,KAAK,CAAC,mBAAmB,CAC9B,OAAe,EACf,aAA4B,EAC5B,QAA4B;QAE5B,MAAM,IAAI,GAAG;YACX,kBAAkB,EAAE,aAAa;YACjC,kBAAkB,EAAE,QAAQ;SAC7B,CAAA;QACD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,oBAAoB,CAAC,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;QAChG,MAAM,OAAO,GAAG,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;QACvD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QAC1C,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,aAAa,CAAC,WAAW,CAAC,sBAAsB,EAAE,MAAM,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAA;QACxF,CAAC;QACD,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAA;IACxB,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACI,KAAK,CAAC,aAAa,CAAC,OAAe,EAAE,UAAU,GAAG,IAAI,iBAAiB,EAAE;QAC9E,MAAM,KAAK,GACT,uBAAuB,CAAC,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,GAAG,GAAG,GAAG,UAAU,CAAC,aAAa,EAAE,CAAA;QACzF,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;QACpD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAA;QACnE,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,aAAa,CAAC,WAAW,CAAC,iBAAiB,EAAE,MAAM,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAA;QACnF,CAAC;QACD,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAA;IACxB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,KAAK,CAAC,cAAc,CAAC,MAAc,EAAE,OAAe;QACzD,MAAM,OAAO,GAAG,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAA;QAClD,MAAM,QAAQ,GAAG,sBAAsB,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,CAAA;QAC/F,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;QACvD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QAC1C,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,aAAa,CAAC,WAAW,CAAC,6BAA6B,EAAE,MAAM,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAA;QAC/F,CAAC;QAED,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAA;IACxB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,KAAK,CAAC,mBAAmB,CAAC,MAAc,EAAE,OAAe;QAC9D,MAAM,OAAO,GAAG,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAA;QACpD,MAAM,QAAQ,GAAG,yBAAyB,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,OAAO,CAC3E,UAAU,EACV,OAAO,CACR,CAAA;QACD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;QACvD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QAC1C,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,aAAa,CAAC,WAAW,CAC7B,kCAAkC,EAClC,MAAM,aAAa,CAAC,QAAQ,CAAC,CAC9B,CAAA;QACH,CAAC;QAED,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAA;IACxB,CAAC;CACF","sourcesContent":["import { safeParseJson } from '../common/helper.js'\nimport { PaymentsError } from '../common/payments.error.js'\nimport {\n  AgentAPIAttributes,\n  AgentMetadata,\n  NvmAPIResult,\n  PaginationOptions,\n  PaymentOptions,\n  PlanCreditsConfig,\n  PlanMetadata,\n  PlanPriceConfig,\n} from '../common/types.js'\nimport { BasePaymentsAPI, PublicationOptions, resolvePublicationHeaders } from './base-payments.js'\nimport {\n  API_URL_ADD_PLAN_AGENT,\n  API_URL_GET_AGENT,\n  API_URL_GET_AGENT_PLANS,\n  API_URL_REGISTER_AGENT,\n  API_URL_REGISTER_AGENTS_AND_PLAN,\n  API_URL_REMOVE_PLAN_AGENT,\n  API_URL_UPDATE_AGENT,\n} from './nvm-api.js'\n\nexport type { PublicationOptions } from './base-payments.js'\n\n/**\n * The AgentsAPI class provides methods to register and interact with AI Agents on Nevermined.\n */\nexport class AgentsAPI extends BasePaymentsAPI {\n  /**\n   * This method is used to create a singleton instance of the AgentsAPI class.\n   *\n   * @param options - The options to initialize the payments class.\n   * @returns The instance of the AgentsAPI class.\n   */\n  static getInstance(options: PaymentOptions): AgentsAPI {\n    return new AgentsAPI(options)\n  }\n\n  /**\n   *\n   * It registers a new AI Agent on Nevermined.\n   * The agent must be associated to one or multiple Payment Plans. Users that are subscribers of a payment plan can query the agent.\n   * Depending on the Payment Plan and the configuration of the agent, the usage of the agent/service will consume credits.\n   * When the plan expires (because the time is over or the credits are consumed), the user needs to renew the plan to continue using the agent.\n   *\n   * @remarks This method is oriented to AI Builders\n   * @remarks To call this method, the NVM API Key must have publication permissions\n   *\n   * @see https://nevermined.ai/docs/tutorials/builders/register-agent\n   *\n   * @param agentMetadata - @see {@link AgentMetadata}\n   * @param agentApi - @see {@link AgentAPIAttributes}\n   * @param paymentPlans - the list of payment plans giving access to the agent.\n   *\n   * @example\n   * ```\n   *  const agentMetadata = { name: 'My AI Payments Agent', tags: ['test'] }\n   *  const agentApi = { endpoints: [{ 'POST': 'https://example.com/api/v1/agents/:agentId/tasks' }] }\n   *  const paymentPlans = [planId]\n   *\n   *  const { agentId } = await payments.agents.registerAgent(agentMetadata, agentApi, paymentPlans)\n   * ```\n   *\n   * @returns The unique identifier of the newly created agent (Agent Id).\n   */\n  public async registerAgent(\n    agentMetadata: AgentMetadata,\n    agentApi: AgentAPIAttributes,\n    paymentPlans: string[],\n    publicationOptions?: PublicationOptions,\n  ): Promise<{ agentId: string }> {\n    const body = {\n      metadataAttributes: agentMetadata,\n      agentApiAttributes: agentApi,\n      plans: paymentPlans,\n    }\n\n    const options = this.getBackendHTTPOptions(\n      'POST',\n      body,\n      resolvePublicationHeaders(publicationOptions),\n    )\n    const url = new URL(API_URL_REGISTER_AGENT, this.environment.backend)\n\n    const response = await fetch(url, options)\n    if (!response.ok) {\n      throw PaymentsError.fromBackend('Unable to register agent', await safeParseJson(response))\n    }\n    const agentData = await response.json()\n    return { agentId: agentData.data.agentId }\n  }\n\n  /**\n   *\n   * It registers a new AI Agent and a Payment Plan associated to this new agent.\n   * Depending on the Payment Plan and the configuration of the agent, the usage of the agent/service will consume credits.\n   * When the plan expires (because the time is over or the credits are consumed), the user needs to renew the plan to continue using the agent.\n   *\n   * @remarks This method is oriented to AI Builders\n   * @remarks To call this method, the NVM API Key must have publication permissions\n   *\n   * @see https://nevermined.ai/docs/tutorials/builders/register-agent\n   *\n   * @param agentMetadata - @see {@link AgentMetadata}\n   * @param agentApi - @see {@link AgentAPIAttributes}\n   * @param planMetadata - @see {@link PlanMetadata}\n   * @param priceConfig - @see {@link PlanPriceConfig}\n   * @param creditsConfig - @see {@link PlanCreditsConfig}\n   *\n   * @example\n   * ```\n   *  const agentMetadata = { name: 'My AI Payments Agent', tags: ['test'] }\n   *  const agentApi { endpoints: [{ 'POST': 'https://example.com/api/v1/agents/:agentId/tasks' }] }\n   *  const cryptoPriceConfig = getNativeTokenPriceConfig(100n, builderAddress)\n   *  const 1dayDurationPlan = getExpirableDurationConfig(ONE_DAY_DURATION)\n   *  const { agentId, planId } = await payments.agents.registerAgentAndPlan(\n   *    agentMetadata,\n   *    agentApi,\n   *    cryptoPriceConfig,\n   *    1dayDurationPlan\n   *  )\n   * ```\n   *\n   * @returns The unique identifier of the newly created agent (agentId).\n   * @returns The unique identifier of the newly created plan (planId).\n   */\n  public async registerAgentAndPlan(\n    agentMetadata: AgentMetadata,\n    agentApi: AgentAPIAttributes,\n    planMetadata: PlanMetadata,\n    priceConfig: PlanPriceConfig,\n    creditsConfig: PlanCreditsConfig,\n    accessLimit?: 'credits' | 'time',\n    publicationOptions?: PublicationOptions,\n  ): Promise<{\n    agentId: string\n    planId: string\n    txHash: string\n  }> {\n    if (accessLimit && !['credits', 'time'].includes(accessLimit)) {\n      throw new PaymentsError(\n        'Invalid access limit',\n        'accessLimit must be either \"credits\" or \"time\"',\n      )\n    }\n    if (!accessLimit) {\n      accessLimit = creditsConfig.durationSecs > 0n ? 'time' : 'credits'\n    }\n    const body = {\n      plan: {\n        metadataAttributes: planMetadata,\n        priceConfig: priceConfig,\n        creditsConfig: creditsConfig,\n        accessLimit,\n      },\n      agent: {\n        metadataAttributes: agentMetadata,\n        agentApiAttributes: agentApi,\n      },\n    }\n    const options = this.getBackendHTTPOptions(\n      'POST',\n      body,\n      resolvePublicationHeaders(publicationOptions),\n    )\n    const url = new URL(API_URL_REGISTER_AGENTS_AND_PLAN, this.environment.backend)\n\n    const response = await fetch(url, options)\n    if (!response.ok) {\n      throw PaymentsError.fromBackend(\n        'Unable to register agent & plan',\n        await safeParseJson(response),\n      )\n    }\n    const result = await response.json()\n    return {\n      agentId: result.data.agentId,\n      planId: result.data.planId,\n      txHash: result.txHash,\n    }\n  }\n\n  /**\n   * Gets the metadata for a given Agent identifier.\n   *\n   * @param agentId - The unique identifier of the agent.\n   * @returns A promise that resolves to the agent's metadata.\n   * @throws PaymentsError if the agent is not found.\n   *\n   * @example\n   * ```\n   *  const plan = payments.agents.getAgent(agentId)\n   * ```\n   */\n  public async getAgent(agentId: string) {\n    const url = new URL(API_URL_GET_AGENT.replace(':agentId', agentId), this.environment.backend)\n    const response = await fetch(url, this.getPublicHTTPOptions('GET'))\n    if (!response.ok) {\n      throw PaymentsError.fromBackend('Agent not found', await safeParseJson(response))\n    }\n    return response.json()\n  }\n\n  /**\n   * Updates the metadata and API attributes of an existing AI Agent.\n   *\n   * @param agentId - The unique identifier of the agent.\n   * @param agentMetadata - The new metadata attributes for the agent.\n   * @param agentApi - The new API attributes for the agent.\n   * @returns  @see {@link NvmAPIResult} A promise that resolves indicating if the operation was successful.\n   * @throws PaymentsError if the agent is not found or if the update fails.\n   *\n   * @example\n   * ```\n   *  const agentMetadata = { name: 'My Updated Agent', tags: ['test'] }\n   *  const agentApi = { endpoints: [{ 'POST': 'https://nevermined.app/api/v1/agents/:agentId/tasks' }] }\n   *\n   *  await payments.agents.updateAgentMetadata(agentId, agentMetadata, agentApi)\n   * ```\n   */\n  public async updateAgentMetadata(\n    agentId: string,\n    agentMetadata: AgentMetadata,\n    agentApi: AgentAPIAttributes,\n  ): Promise<NvmAPIResult> {\n    const body = {\n      metadataAttributes: agentMetadata,\n      agentApiAttributes: agentApi,\n    }\n    const url = new URL(API_URL_UPDATE_AGENT.replace(':agentId', agentId), this.environment.backend)\n    const options = this.getBackendHTTPOptions('PUT', body)\n    const response = await fetch(url, options)\n    if (!response.ok) {\n      throw PaymentsError.fromBackend('Error updating agent', await safeParseJson(response))\n    }\n    return response.json()\n  }\n\n  /**\n   * Gets the list of plans that can be ordered to get access to an agent.\n   *\n   * @param agentId - The unique identifier of the agent.\n   * @param pagination - Optional pagination options to control the number of results returned.p\n   * @returns A promise that resolves to the list of all different plans giving access to the agent.\n   * @throws PaymentsError if the agent is not found.\n   *\n   * @example\n   * ```\n   *  const result = payments.agents.getAgentPlans(planId)\n   *  // {\n   *  //  total: 10,\n   *  //  page: 1,\n   *  //  offset: 5,\n   *  //  plans: [ ..]\n   *  // }\n   * ```\n   */\n  public async getAgentPlans(agentId: string, pagination = new PaginationOptions()) {\n    const query =\n      API_URL_GET_AGENT_PLANS.replace(':agentId', agentId) + '?' + pagination.asQueryParams()\n    const url = new URL(query, this.environment.backend)\n    const response = await fetch(url, this.getPublicHTTPOptions('GET'))\n    if (!response.ok) {\n      throw PaymentsError.fromBackend('Agent not found', await safeParseJson(response))\n    }\n    return response.json()\n  }\n\n  /**\n   * Adds an existing Payment Plan to an AI Agent.\n   * After this operation, users with access to the Payment Plan will be able to access the AI Agent.\n   *\n   * @remarks\n   * Only the owner of the Payment Plan can call this method.\n   *\n   * @param planId - The unique identifier of the Payment Plan.\n   * @param agentId - The unique identifier of the AI Agent.\n   * @returns  @see {@link NvmAPIResult} A promise that resolves indicating if the operation was successful.\n   * @throws PaymentsError if unable to add the plan to the agent.\n   *\n   * @example\n   * ```\n   * const result = await payments.agents.addPlanToAgent(planId, agentId)\n   * // {\n   * //   txHash: '0x8d29d5769e832a35e53f80cd4e8890d941c50a09c33dbd975533debc894f2535',\n   * //   success: true\n   * // }\n   * ```\n   */\n  public async addPlanToAgent(planId: string, agentId: string): Promise<NvmAPIResult> {\n    const options = this.getBackendHTTPOptions('POST')\n    const endpoint = API_URL_ADD_PLAN_AGENT.replace(':planId', planId).replace(':agentId', agentId)\n    const url = new URL(endpoint, this.environment.backend)\n    const response = await fetch(url, options)\n    if (!response.ok) {\n      throw PaymentsError.fromBackend('Unable to add plan to agent', await safeParseJson(response))\n    }\n\n    return response.json()\n  }\n\n  /**\n   * Removes a Payment Plan from an AI Agent.\n   * After this operation, users with access to the Payment Plan will no longer be able to access the AI Agent.\n   *\n   * @remarks\n   * Only the owner of the Payment Plan can call this method.\n   *\n   * @param planId - The unique identifier of the Payment Plan.\n   * @param agentId - The unique identifier of the AI Agent.\n   * @returns  @see {@link NvmAPIResult} A promise that resolves indicating if the operation was successful.\n   * @throws PaymentsError if unable to remove the plan from the agent.\n   *\n   * @example\n   * ```\n   * const result = await payments.agents.removePlanFromAgent(planId, agentId)\n   * // {\n   * //   txHash: '0x8d29d5769e832a35e53f80cd4e8890d941c50a09c33dbd975533debc894f2535',\n   * //   success: true\n   * // }\n   * ```\n   */\n  public async removePlanFromAgent(planId: string, agentId: string): Promise<NvmAPIResult> {\n    const options = this.getBackendHTTPOptions('DELETE')\n    const endpoint = API_URL_REMOVE_PLAN_AGENT.replace(':planId', planId).replace(\n      ':agentId',\n      agentId,\n    )\n    const url = new URL(endpoint, this.environment.backend)\n    const response = await fetch(url, options)\n    if (!response.ok) {\n      throw PaymentsError.fromBackend(\n        'Unable to remove plan from agent',\n        await safeParseJson(response),\n      )\n    }\n\n    return response.json()\n  }\n}\n"]}

package/dist/api/base-payments.d.ts

@@ -38,6 +38,11 @@ export declare abstract class BasePaymentsAPI {
     protected environmentName: EnvironmentName;
     protected returnUrl: string;
     protected appId?: string;
+    /**
+     * Backend API version (MAJOR.MINOR) pinned by this instance, set from
+     * `options.version`. When unset, every request defaults to
+     * {@link LOCKED_API_VERSION}.
+     */
     protected version?: string;
     protected accountAddress: string;
     protected heliconeApiKey: string;
@@ -101,10 +106,7 @@ export declare abstract class BasePaymentsAPI {
      */
     protected getPublicHTTPOptions(method: string, body?: any): {
         method: string;
-        headers: {
-            Accept: string;
-            "Content-Type": string;
-        };
+        headers: Record<string, string>;
         body?: string;
     };
 }

package/dist/api/base-payments.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"base-payments.d.ts","sourceRoot":"","sources":["../../src/api/base-payments.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAClE,OAAO,EAAE,eAAe,EAAE,eAAe,EAAgB,MAAM,oBAAoB,CAAA;AAEnF;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,qBAAqB,CAAA;AAUvD;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB,CAAA;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,CACvC,OAAO,CAAC,EAAE,kBAAkB,GAC3B,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAKpC;AAED;;;GAGG;AACH,8BAAsB,eAAe;IACnC,SAAS,CAAC,SAAS,EAAE,MAAM,CAAA;IAC3B,SAAS,CAAC,MAAM,EAAE,aAAa,CAAA;IAC/B,SAAS,CAAC,WAAW,EAAE,eAAe,CAAA;IACtC,SAAS,CAAC,eAAe,EAAE,eAAe,CAAA;IAC1C,SAAS,CAAC,SAAS,EAAE,MAAM,CAAA;IAC3B,SAAS,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACxB,SAAS,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;IAC1B,SAAS,CAAC,cAAc,EAAE,MAAM,CAAA;IAChC,SAAS,CAAC,cAAc,EAAE,MAAM,CAAA;IAChC,SAAS,CAAC,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAA;IACvC,iBAAiB,UAAO;gBAEnB,OAAO,EAAE,cAAc;IA0BnC;;;OAGG;IACH,SAAS,CAAC,cAAc,IAAI;QAAE,cAAc,EAAE,MAAM,CAAC;QAAC,cAAc,EAAE,MAAM,CAAA;KAAE;IAc9E;;;OAGG;IACI,kBAAkB,IAAI,eAAe;IAI5C;;;OAGG;IACI,iBAAiB,IAAI,MAAM,GAAG,SAAS;IAI9C;;;;;;OAMG;IACI,iBAAiB,IAAI,MAAM,GAAG,IAAI;IAIzC;;;;;;;OAOG;IACI,iBAAiB,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI;IAI7D;;;;;;;;;OASG;IACH,SAAS,CAAC,qBAAqB,CAC7B,MAAM,EAAE,MAAM,EACd,IAAI,CAAC,EAAE,GAAG,EACV,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IA2BvC;;;;;;;;OAQG;IACH,SAAS,CAAC,oBAAoB,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG;gBAE7C,MAAM;iBACL;YACP,MAAM,EAAE,MAAM,CAAA;YACd,cAAc,EAAE,MAAM,CAAA;SACvB;eACM,MAAM;;CAelB"}
+{"version":3,"file":"base-payments.d.ts","sourceRoot":"","sources":["../../src/api/base-payments.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAClE,OAAO,EAAE,eAAe,EAAE,eAAe,EAAgB,MAAM,oBAAoB,CAAA;AAEnF;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,qBAAqB,CAAA;AAUvD;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB,CAAA;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,CACvC,OAAO,CAAC,EAAE,kBAAkB,GAC3B,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAKpC;AAED;;;GAGG;AACH,8BAAsB,eAAe;IACnC,SAAS,CAAC,SAAS,EAAE,MAAM,CAAA;IAC3B,SAAS,CAAC,MAAM,EAAE,aAAa,CAAA;IAC/B,SAAS,CAAC,WAAW,EAAE,eAAe,CAAA;IACtC,SAAS,CAAC,eAAe,EAAE,eAAe,CAAA;IAC1C,SAAS,CAAC,SAAS,EAAE,MAAM,CAAA;IAC3B,SAAS,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACxB;;;;OAIG;IACH,SAAS,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;IAC1B,SAAS,CAAC,cAAc,EAAE,MAAM,CAAA;IAChC,SAAS,CAAC,cAAc,EAAE,MAAM,CAAA;IAChC,SAAS,CAAC,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAA;IACvC,iBAAiB,UAAO;gBAEnB,OAAO,EAAE,cAAc;IAmCnC;;;OAGG;IACH,SAAS,CAAC,cAAc,IAAI;QAAE,cAAc,EAAE,MAAM,CAAC;QAAC,cAAc,EAAE,MAAM,CAAA;KAAE;IAc9E;;;OAGG;IACI,kBAAkB,IAAI,eAAe;IAI5C;;;OAGG;IACI,iBAAiB,IAAI,MAAM,GAAG,SAAS;IAI9C;;;;;;OAMG;IACI,iBAAiB,IAAI,MAAM,GAAG,IAAI;IAIzC;;;;;;;OAOG;IACI,iBAAiB,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI;IAI7D;;;;;;;;;OASG;IACH,SAAS,CAAC,qBAAqB,CAC7B,MAAM,EAAE,MAAM,EACd,IAAI,CAAC,EAAE,GAAG,EACV,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IA4BvC;;;;;;;;OAQG;IACH,SAAS,CAAC,oBAAoB,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG;gBAE7C,MAAM;iBACL,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;eACxB,MAAM;;CAgBlB"}

package/dist/api/base-payments.js

@@ -1,4 +1,5 @@
 import { decodeJwt } from 'jose';
+import { API_VERSION_HEADER, LOCKED_API_VERSION } from '../common/api-version.js';
 import { jsonReplacer } from '../common/helper.js';
 import { PaymentsError } from '../common/payments.error.js';
 import { Environments } from '../environments.js';
@@ -49,6 +50,13 @@ export class BasePaymentsAPI {
         this.environment = Environments[options.environment];
         this.environmentName = options.environment;
         this.appId = options.appId;
+        // `version` is the backend API pin (MAJOR.MINOR) sent verbatim as
+        // Nevermined-Version. Fail fast on a malformed value rather than shipping
+        // an invalid header (e.g. an SDK package version '1.0.0', 'v1.1', or '')
+        // that the backend rejects with 400 on every call.
+        if (options.version !== undefined && !/^\d+\.\d+$/.test(options.version)) {
+            throw new PaymentsError(`Invalid 'version' option '${options.version}': expected a backend API version as MAJOR.MINOR (e.g. '1.1'). Omit it to use the SDK's default pin.`);
+        }
         this.version = options.version;
         this.currentOrganizationId = options.organizationId ?? null;
         const { accountAddress, heliconeApiKey } = this.parseNvmApiKey();
@@ -123,6 +131,7 @@ export class BasePaymentsAPI {
             Accept: 'application/json',
             'Content-Type': 'application/json',
             Authorization: `Bearer ${this.nvmApiKey}`,
+            [API_VERSION_HEADER]: this.version ?? LOCKED_API_VERSION,
         };
         if (this.currentOrganizationId) {
             headers[CURRENT_ORG_ID_HEADER] = this.currentOrganizationId;
@@ -158,6 +167,7 @@ export class BasePaymentsAPI {
             headers: {
                 Accept: 'application/json',
                 'Content-Type': 'application/json',
+                [API_VERSION_HEADER]: this.version ?? LOCKED_API_VERSION,
             },
         };
         if (body) {