@nevermined-io/payments 0.1.2 → 0.1.4

package/README.md

@@ -4,3 +4,68 @@
 
 > Typescript SDK to interact with the Nevermined Payments Protocol
 > [nevermined.io](https://nevermined.io)
+
+## Quickstart
+
+```
+# yarn
+yarn add @nevermined-io/payments
+
+# npm
+
+npm install @nevermined-io/payments
+```
+
+### Initialize the payments library
+
+This is a browser only method. Here we have an example using react.
+For a full example please refer to [payments-nextjs-example](https://github.com/nevermined-io/tutorials/tree/main/payments-nextjs-example)
+
+```typescript
+import { useEffect } from "react";
+import { Payments } from "@nevermined-io/payments";
+
+export default function Home() {
+  const payments = new Payments({
+    returnUrl: "http://localhost:8080",
+    environment: "staging",
+  });
+
+  const onLogin = () => {
+    payments.connect();
+  };
+
+  useEffect(() => {
+    payments.init();
+  }, []);
+
+  return (
+    <main>
+      <div>
+        <button onClick={onLogin}>Login</button>
+      </div>
+    </main>
+  );
+}
+```
+
+The `init()` method should be called immediately after the app returns the user to `returnUrl`.
+
+### Create a subscription
+
+Once the app is initialized we can create a subscription:
+
+```typescript
+async function createSubscription() {
+  if (payments.isLoggedIn) {
+    const { did } = await payments.createSubscription({
+      name: 'test subscription',
+      description: 'test',
+      price: 10000000n,
+      tokenAddress: '0x75faf114eafb1BDbe2F0316DF893fd58CE46AA4d',
+      duration: 30,
+      tags: ['test'],
+    })
+  }
+}
+```

package/dist/environments.d.ts

@@ -2,6 +2,6 @@ export interface EnvironmentInfo {
     frontend: string;
     backend: string;
 }
-export type EnvironmentName = 'staging';
+export type EnvironmentName = 'appStaging' | 'appTesting' | 'appArbitrum' | 'appGnosis' | 'appMatic';
 export declare const Environments: Record<EnvironmentName, EnvironmentInfo>;
 //# sourceMappingURL=environments.d.ts.map

package/dist/environments.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"environments.d.ts","sourceRoot":"","sources":["../src/environments.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,MAAM,eAAe,GAAG,SAAS,CAAA;AAEvC,eAAO,MAAM,YAAY,EAAE,MAAM,CAAC,eAAe,EAAE,eAAe,CAKjE,CAAA"}
+{"version":3,"file":"environments.d.ts","sourceRoot":"","sources":["../src/environments.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,MAAM,eAAe,GAAG,YAAY,GAAG,YAAY,GAAG,aAAa,GAAG,WAAW,GAAG,UAAU,CAAA;AAEpG,eAAO,MAAM,YAAY,EAAE,MAAM,CAAC,eAAe,EAAE,eAAe,CAqBjE,CAAA"}

package/dist/environments.js

@@ -2,9 +2,25 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Environments = void 0;
 exports.Environments = {
-    staging: {
+    appStaging: {
         frontend: 'https://staging.nevermined.app',
         backend: 'https://one-backend.staging.nevermined.app',
     },
+    appTesting: {
+        frontend: 'https://testing.nevermined.app',
+        backend: 'https://one-backend.testing.nevermined.app',
+    },
+    appArbitrum: {
+        frontend: 'https://nevermined.app',
+        backend: 'https://one-backend.arbitrum.nevermined.app',
+    },
+    appGnosis: {
+        frontend: 'https://gnosis.nevermined.app',
+        backend: 'https://one-backend.gnosis.nevermined.app',
+    },
+    appMatic: {
+        frontend: 'https://matic.nevermined.app',
+        backend: 'https://one-backend.matic.nevermined.app',
+    },
 };
 //# sourceMappingURL=environments.js.map

package/dist/environments.js.map

@@ -1 +1 @@
-{"version":3,"file":"environments.js","sourceRoot":"","sources":["../src/environments.ts"],"names":[],"mappings":";;;AAOa,QAAA,YAAY,GAA6C;IACpE,OAAO,EAAE;QACP,QAAQ,EAAE,gCAAgC;QAC1C,OAAO,EAAE,4CAA4C;KACtD;CACF,CAAA"}
+{"version":3,"file":"environments.js","sourceRoot":"","sources":["../src/environments.ts"],"names":[],"mappings":";;;AAOa,QAAA,YAAY,GAA6C;IACpE,UAAU,EAAE;QACV,QAAQ,EAAE,gCAAgC;QAC1C,OAAO,EAAE,4CAA4C;KACtD;IACD,UAAU,EAAE;QACV,QAAQ,EAAE,gCAAgC;QAC1C,OAAO,EAAE,4CAA4C;KACtD;IACD,WAAW,EAAE;QACX,QAAQ,EAAE,wBAAwB;QAClC,OAAO,EAAE,6CAA6C;KACvD;IACD,SAAS,EAAE;QACT,QAAQ,EAAE,+BAA+B;QACzC,OAAO,EAAE,2CAA2C;KACrD;IACD,QAAQ,EAAE;QACR,QAAQ,EAAE,8BAA8B;QACxC,OAAO,EAAE,0CAA0C;KACpD;CACF,CAAA"}

package/dist/payments.d.ts

@@ -1,19 +1,149 @@
 import { EnvironmentInfo, EnvironmentName } from './environments';
+/**
+ * Options to initialize the Payments class.
+ */
 export interface PaymentOptions {
+    /**
+     * The URL to return to the app after a successful login.
+     */
     returnUrl: string;
+    /**
+     * The environment to connect to.
+     */
     environment: EnvironmentName;
+    /**
+     * The app id.
+     */
+    appId?: string;
+    /**
+     * The version of the library.
+     */
+    version?: string;
 }
 export interface Endpoint {
     [verb: string]: string;
 }
+/**
+ * Main class that interacts with the Nevermined payments API.
+ */
 export declare class Payments {
     returnUrl: string;
     environment: EnvironmentInfo;
+    appId?: string;
+    version?: string;
     private sessionKey?;
+    /**
+     * Initialize the payments class.
+     *
+     * @param options - The options to initialize the payments class.
+     *
+     * @example
+     * ```
+     * const payments = new Payments({
+     *   returnUrl: 'https://mysite.example'
+     *   environment: 'staging'
+     *   appId: 'my-app-id'
+     *   version: '1.0.0'
+     * })
+     * ```
+     *
+     * @returns An instance of {@link Payments}
+     */
     constructor(options: PaymentOptions);
-    init(): void;
+    /**
+     * Initiate the connect flow. The user's browser will be redirected to
+     * the Nevermined App login page.
+     *
+     * @remarks
+     *
+     * This is a browser only function.
+     *
+     * @example
+     * ```
+     * payments.connect()
+     * ```
+     */
     connect(): void;
+    /**
+     * Method to initialize the class once the user has been logged in.
+     * This method should be called has soon as the user has been redirected
+     * back to the app ({@link returnUrl}).
+     *
+     * @remarks
+     *
+     * This is a browser only function.
+     *
+     * @example
+     * ```
+     * payments.init()
+     * ```
+     *
+     * @example Using react
+     *
+     * You may want to use `useEffect` on the route that matches the passed
+     * {@link returnUrl}
+     *
+     * ```
+     * useEffect(() => {
+     *   payments.init()
+     * })
+     * ```
+     */
+    init(): void;
+    /**
+     * Logout the user by removing the session key.
+     *
+     * @remarks
+     *
+     * This is a browser only function.
+     *
+     * @example
+     * ```
+     * payments.logout()
+     * ```
+     */
+    logout(): void;
+    /**
+     * Property to check if a user logged in.
+     *
+     * @example
+     * ```
+     * payments.isLoggedIn
+     * ```
+     *
+     * @returns True if the user is logged in.
+     */
     get isLoggedIn(): boolean;
+    /**
+     *
+     * Create a subscription on Nevermined.
+     *
+     * @param name - The name of the subscription.
+     * @param description - A description of what the subscription offers.
+     * @param price - The price of the subscription.
+     * @param tokenAddress - The ERC-20 token address of the currency used to price the subscription.
+     * Using the zero address will use the chain's native currency instead.
+     * @param amountOfCredits - The amount of credits associated with the credit based subscription.
+     * Leave unset to use time limited time subscriptions instead.
+     * @param duration - The duration of the subscription in days.
+     * If `amountOfCredits` and `duration` is left undefined an unlimited time duration subscription
+     * will be created.
+     * @param tags - An array of tags or keywords that best fit the subscription.
+     *
+     * @example
+     * ```
+     *  const { did } = await payments.createSubscription({
+     *    name: "test subscription",
+     *    description: "test",
+     *    price: 10000000n,
+     *    tokenAddress: "0x75faf114eafb1BDbe2F0316DF893fd58CE46AA4d",
+     *    duration: 30,
+     *    tags: ["test"]
+     *   }
+     * ```
+     *
+     * @returns The DID of the newly created subscription.
+     */
     createSubscription({ name, description, price, tokenAddress, amountOfCredits, duration, tags, }: {
         name: string;
         description: string;
@@ -25,7 +155,34 @@ export declare class Payments {
     }): Promise<{
         did: string;
     }>;
-    createWebservice({ subscriptionDid, name, description, price, tokenAddress, amountOfCredits, duration, tags, serviceChargeType, minCreditsToCharge, maxCreditsToCharge, authType, username, password, token, endpoints, openEndpoints, openApiUrl, integration, sampleLink, apiDescription, curation, }: {
+    /**
+     * Creates a service.
+     *
+     * @param subscriptionDid - The subscription DID.
+     * @param name - The name of the service.
+     * @param description - The description of the service.
+     * @param price - The price of the service.
+     * @param tokenAddress - The token address.
+     * @param amountOfCredits - The amount of credits.
+     * @param duration - The duration of the service.
+     * @param tags - The tags associated with the service.
+     * @param serviceChargeType - The service charge type ('fixed' or 'dynamic').
+     * @param minCreditsToCharge - The minimum credits to charge.
+     * @param maxCreditsToCharge - The maximum credits to charge.
+     * @param authType - The authentication type ('none', 'basic', or 'oauth').
+     * @param username - The username for authentication.
+     * @param password - The password for authentication.
+     * @param token - The token for authentication.
+     * @param endpoints - The endpoints of the service.
+     * @param openEndpoints - The open endpoints of the service.
+     * @param openApiUrl - The OpenAPI URL.
+     * @param integration - The integration details.
+     * @param sampleLink - The sample link.
+     * @param apiDescription - The API description.
+     * @param curation - The curation details.
+     * @returns A promise that resolves to the created service DID.
+     */
+    createService({ subscriptionDid, name, description, price, tokenAddress, amountOfCredits, duration, tags, serviceChargeType, minCreditsToCharge, maxCreditsToCharge, authType, username, password, token, endpoints, openEndpoints, openApiUrl, integration, sampleLink, apiDescription, curation, }: {
         subscriptionDid: string;
         name: string;
         description: string;
@@ -51,5 +208,80 @@ export declare class Payments {
     }): Promise<{
         did: string;
     }>;
+    /**
+     * Creates a file with the specified parameters.
+     *
+     * @param subscriptionDid - The subscription DID.
+     * @param assetType - The type of asset.
+     * @param name - The name of the file.
+     * @param description - The description of the file.
+     * @param files - The array of files.
+     * @param price - The price of the file.
+     * @param tokenAddress - The token address.
+     * @param amountOfCredits - The amount of credits.
+     * @param duration - The duration of the file.
+     * @param tags - The array of tags.
+     * @param dataSchema - The data schema.
+     * @param sampleCode - The sample code.
+     * @param filesFormat - The format of the files.
+     * @param usageExample - The usage example.
+     * @param programmingLanguage - The programming language.
+     * @param framework - The framework.
+     * @param task - The task.
+     * @param trainingDetails - The training details.
+     * @param variations - The variations.
+     * @param fineTunable - Indicates if the file is fine-tunable.
+     * @param minCreditsToCharge - The minimum credits to charge.
+     * @param maxCreditsToCharge - The maximum credits to charge.
+     * @param curation - The curation object.
+     * @returns The promise that resolves to the created file's DID.
+     */
+    createFile({ subscriptionDid, assetType, name, description, files, price, tokenAddress, amountOfCredits, duration, tags, dataSchema, sampleCode, filesFormat, usageExample, programmingLanguage, framework, task, trainingDetails, variations, fineTunable, minCreditsToCharge, maxCreditsToCharge, curation, }: {
+        subscriptionDid: string;
+        assetType: string;
+        name: string;
+        description: string;
+        files: object[];
+        price: bigint;
+        tokenAddress: string;
+        dataSchema?: string;
+        sampleCode?: string;
+        filesFormat?: string;
+        usageExample?: string;
+        programmingLanguage?: string;
+        framework?: string;
+        task?: string;
+        trainingDetails?: string;
+        variations?: string;
+        fineTunable?: boolean;
+        amountOfCredits?: number;
+        minCreditsToCharge?: number;
+        maxCreditsToCharge?: number;
+        curation?: object;
+        duration?: number;
+        tags?: string[];
+    }): Promise<{
+        did: string;
+    }>;
+    /**
+     * Redirects the user to the subscription details for a given DID.
+     * @param did - The DID (Decentralized Identifier) of the subscription.
+     */
+    getSubscriptionDetails(did: string): void;
+    /**
+     * Redirects the user to the service details for a given DID.
+     * @param did - The DID (Decentralized Identifier) of the service.
+     */
+    getServiceDetails(did: string): void;
+    /**
+     * Redirects the user to the file details for the specified DID (Decentralized Identifier).
+     * @param did - The DID of the file.
+     */
+    getFileDetails(did: string): void;
+    /**
+     * Redirects the user to the subscription checkout page for the specified DID.
+     * @param did - The DID (Decentralized Identifier) of the item to be subscribed to.
+     */
+    checkoutSubscription(did: string): void;
 }
 //# sourceMappingURL=payments.d.ts.map

package/dist/payments.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"payments.d.ts","sourceRoot":"","sources":["../src/payments.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,eAAe,EAAgB,MAAM,gBAAgB,CAAA;AAE/E,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,EAAE,eAAe,CAAA;CAC7B;AAED,MAAM,WAAW,QAAQ;IACvB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;CACvB;AAED,qBAAa,QAAQ;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,EAAE,eAAe,CAAA;IACnC,OAAO,CAAC,UAAU,CAAC,CAAQ;gBAEf,OAAO,EAAE,cAAc;IAK5B,IAAI;IAWJ,OAAO;IAQd,IAAI,UAAU,IAAI,OAAO,CAExB;IAEY,kBAAkB,CAAC,EAC9B,IAAI,EACJ,WAAW,EACX,KAAK,EACL,YAAY,EACZ,eAAe,EACf,QAAQ,EACR,IAAI,GACL,EAAE;QACD,IAAI,EAAE,MAAM,CAAA;QACZ,WAAW,EAAE,MAAM,CAAA;QACnB,KAAK,EAAE,MAAM,CAAA;QACb,YAAY,EAAE,MAAM,CAAA;QACpB,eAAe,CAAC,EAAE,MAAM,CAAA;QACxB,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;KAChB,GAAG,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;IA6Bf,gBAAgB,CAAC,EAC5B,eAAe,EACf,IAAI,EACJ,WAAW,EACX,KAAK,EACL,YAAY,EACZ,eAAe,EACf,QAAQ,EACR,IAAI,EACJ,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,KAAK,EACL,SAAS,EACT,aAAa,EACb,UAAU,EACV,WAAW,EACX,UAAU,EACV,cAAc,EACd,QAAQ,GACT,EAAE;QACD,eAAe,EAAE,MAAM,CAAA;QACvB,IAAI,EAAE,MAAM,CAAA;QACZ,WAAW,EAAE,MAAM,CAAA;QACnB,KAAK,EAAE,MAAM,CAAA;QACb,YAAY,EAAE,MAAM,CAAA;QACpB,iBAAiB,EAAE,OAAO,GAAG,SAAS,CAAA;QACtC,QAAQ,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,CAAA;QACpC,eAAe,CAAC,EAAE,MAAM,CAAA;QACxB,kBAAkB,CAAC,EAAE,MAAM,CAAA;QAC3B,kBAAkB,CAAC,EAAE,MAAM,CAAA;QAC3B,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAA;QACtB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;QACxB,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,cAAc,CAAC,EAAE,MAAM,CAAA;QACvB,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;KAChB,GAAG,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;CA4C7B"}
+{"version":3,"file":"payments.d.ts","sourceRoot":"","sources":["../src/payments.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,eAAe,EAAgB,MAAM,gBAAgB,CAAA;AAC/E;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,WAAW,EAAE,eAAe,CAAA;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,QAAQ;IACvB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;CACvB;AAED;;GAEG;AACH,qBAAa,QAAQ;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,EAAE,eAAe,CAAA;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,CAAA;IACvB,OAAO,CAAC,UAAU,CAAC,CAAQ;IAE3B;;;;;;;;;;;;;;;;OAgBG;gBACS,OAAO,EAAE,cAAc;IAOnC;;;;;;;;;;;;OAYG;IACI,OAAO;IAQd;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACI,IAAI;IAWX;;;;;;;;;;;OAWG;IACI,MAAM;IAIb;;;;;;;;;OASG;IACH,IAAI,UAAU,IAAI,OAAO,CAExB;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACU,kBAAkB,CAAC,EAC9B,IAAI,EACJ,WAAW,EACX,KAAK,EACL,YAAY,EACZ,eAAe,EACf,QAAQ,EACR,IAAI,GACL,EAAE;QACD,IAAI,EAAE,MAAM,CAAA;QACZ,WAAW,EAAE,MAAM,CAAA;QACnB,KAAK,EAAE,MAAM,CAAA;QACb,YAAY,EAAE,MAAM,CAAA;QACpB,eAAe,CAAC,EAAE,MAAM,CAAA;QACxB,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;KAChB,GAAG,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;IA6B5B;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,aAAa,CAAC,EACzB,eAAe,EACf,IAAI,EACJ,WAAW,EACX,KAAK,EACL,YAAY,EACZ,eAAe,EACf,QAAQ,EACR,IAAI,EACJ,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,KAAK,EACL,SAAS,EACT,aAAa,EACb,UAAU,EACV,WAAW,EACX,UAAU,EACV,cAAc,EACd,QAAQ,GACT,EAAE;QACD,eAAe,EAAE,MAAM,CAAA;QACvB,IAAI,EAAE,MAAM,CAAA;QACZ,WAAW,EAAE,MAAM,CAAA;QACnB,KAAK,EAAE,MAAM,CAAA;QACb,YAAY,EAAE,MAAM,CAAA;QACpB,iBAAiB,EAAE,OAAO,GAAG,SAAS,CAAA;QACtC,QAAQ,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,CAAA;QACpC,eAAe,CAAC,EAAE,MAAM,CAAA;QACxB,kBAAkB,CAAC,EAAE,MAAM,CAAA;QAC3B,kBAAkB,CAAC,EAAE,MAAM,CAAA;QAC3B,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAA;QACtB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;QACxB,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,cAAc,CAAC,EAAE,MAAM,CAAA;QACvB,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;KAChB,GAAG,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;IA4C5B;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACU,UAAU,CAAC,EACtB,eAAe,EACf,SAAS,EACT,IAAI,EACJ,WAAW,EACX,KAAK,EACL,KAAK,EACL,YAAY,EACZ,eAAe,EACf,QAAQ,EACR,IAAI,EACJ,UAAU,EACV,UAAU,EACV,WAAW,EACX,YAAY,EACZ,mBAAmB,EACnB,SAAS,EACT,IAAI,EACJ,eAAe,EACf,UAAU,EACV,WAAW,EACX,kBAAkB,EAClB,kBAAkB,EAClB,QAAQ,GACT,EAAE;QACD,eAAe,EAAE,MAAM,CAAA;QACvB,SAAS,EAAE,MAAM,CAAA;QACjB,IAAI,EAAE,MAAM,CAAA;QACZ,WAAW,EAAE,MAAM,CAAA;QACnB,KAAK,EAAE,MAAM,EAAE,CAAA;QACf,KAAK,EAAE,MAAM,CAAA;QACb,YAAY,EAAE,MAAM,CAAA;QACpB,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB,mBAAmB,CAAC,EAAE,MAAM,CAAA;QAC5B,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,eAAe,CAAC,EAAE,MAAM,CAAA;QACxB,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,WAAW,CAAC,EAAE,OAAO,CAAA;QACrB,eAAe,CAAC,EAAE,MAAM,CAAA;QACxB,kBAAkB,CAAC,EAAE,MAAM,CAAA;QAC3B,kBAAkB,CAAC,EAAE,MAAM,CAAA;QAC3B,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;KAChB,GAAG,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;IA6C5B;;;OAGG;IACI,sBAAsB,CAAC,GAAG,EAAE,MAAM;IAKzC;;;OAGG;IACI,iBAAiB,CAAC,GAAG,EAAE,MAAM;IAKpC;;;OAGG;IACI,cAAc,CAAC,GAAG,EAAE,MAAM;IAKjC;;;OAGG;IACI,oBAAoB,CAAC,GAAG,EAAE,MAAM;CAIxC"}

package/dist/payments.js

@@ -1,29 +1,145 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Payments = void 0;
+const jose_1 = require("jose");
 const environments_1 = require("./environments");
+/**
+ * Main class that interacts with the Nevermined payments API.
+ */
 class Payments {
+    /**
+     * Initialize the payments class.
+     *
+     * @param options - The options to initialize the payments class.
+     *
+     * @example
+     * ```
+     * const payments = new Payments({
+     *   returnUrl: 'https://mysite.example'
+     *   environment: 'staging'
+     *   appId: 'my-app-id'
+     *   version: '1.0.0'
+     * })
+     * ```
+     *
+     * @returns An instance of {@link Payments}
+     */
     constructor(options) {
         this.returnUrl = options.returnUrl;
         this.environment = environments_1.Environments[options.environment];
+        this.appId = options.appId;
+        this.version = options.version;
     }
+    /**
+     * Initiate the connect flow. The user's browser will be redirected to
+     * the Nevermined App login page.
+     *
+     * @remarks
+     *
+     * This is a browser only function.
+     *
+     * @example
+     * ```
+     * payments.connect()
+     * ```
+     */
+    connect() {
+        const url = new URL(`/en/login?nvm-export=session-key&returnUrl=${this.returnUrl}`, this.environment.frontend);
+        window.location.href = url.toString();
+    }
+    /**
+     * Method to initialize the class once the user has been logged in.
+     * This method should be called has soon as the user has been redirected
+     * back to the app ({@link returnUrl}).
+     *
+     * @remarks
+     *
+     * This is a browser only function.
+     *
+     * @example
+     * ```
+     * payments.init()
+     * ```
+     *
+     * @example Using react
+     *
+     * You may want to use `useEffect` on the route that matches the passed
+     * {@link returnUrl}
+     *
+     * ```
+     * useEffect(() => {
+     *   payments.init()
+     * })
+     * ```
+     */
     init() {
         const url = new URL(window.location.href);
-        const sessionKey = url.searchParams.get('sessionKey');
-        if (sessionKey) {
-            this.sessionKey = sessionKey;
-            console.log('sessionKey:', sessionKey);
+        const sessionKeyJwt = url.searchParams.get('sessionKey');
+        if (sessionKeyJwt) {
+            const jwtDecoded = (0, jose_1.decodeJwt)(sessionKeyJwt);
+            this.sessionKey = jwtDecoded.sessionKey;
             url.searchParams.delete('sessionKey');
             history.replaceState(history.state, '', url.toString());
         }
     }
-    connect() {
-        const url = new URL(`/en/login?nvm-export=session-key&returnUrl=${this.returnUrl}`, this.environment.frontend);
-        window.location.href = url.toString();
+    /**
+     * Logout the user by removing the session key.
+     *
+     * @remarks
+     *
+     * This is a browser only function.
+     *
+     * @example
+     * ```
+     * payments.logout()
+     * ```
+     */
+    logout() {
+        this.sessionKey = undefined;
     }
+    /**
+     * Property to check if a user logged in.
+     *
+     * @example
+     * ```
+     * payments.isLoggedIn
+     * ```
+     *
+     * @returns True if the user is logged in.
+     */
     get isLoggedIn() {
         return !!this.sessionKey;
     }
+    /**
+     *
+     * Create a subscription on Nevermined.
+     *
+     * @param name - The name of the subscription.
+     * @param description - A description of what the subscription offers.
+     * @param price - The price of the subscription.
+     * @param tokenAddress - The ERC-20 token address of the currency used to price the subscription.
+     * Using the zero address will use the chain's native currency instead.
+     * @param amountOfCredits - The amount of credits associated with the credit based subscription.
+     * Leave unset to use time limited time subscriptions instead.
+     * @param duration - The duration of the subscription in days.
+     * If `amountOfCredits` and `duration` is left undefined an unlimited time duration subscription
+     * will be created.
+     * @param tags - An array of tags or keywords that best fit the subscription.
+     *
+     * @example
+     * ```
+     *  const { did } = await payments.createSubscription({
+     *    name: "test subscription",
+     *    description: "test",
+     *    price: 10000000n,
+     *    tokenAddress: "0x75faf114eafb1BDbe2F0316DF893fd58CE46AA4d",
+     *    duration: 30,
+     *    tags: ["test"]
+     *   }
+     * ```
+     *
+     * @returns The DID of the newly created subscription.
+     */
     async createSubscription({ name, description, price, tokenAddress, amountOfCredits, duration, tags, }) {
         const body = {
             sessionKey: this.sessionKey,
@@ -50,7 +166,34 @@ class Payments {
         }
         return response.json();
     }
-    async createWebservice({ subscriptionDid, name, description, price, tokenAddress, amountOfCredits, duration, tags, serviceChargeType, minCreditsToCharge, maxCreditsToCharge, authType, username, password, token, endpoints, openEndpoints, openApiUrl, integration, sampleLink, apiDescription, curation, }) {
+    /**
+     * Creates a service.
+     *
+     * @param subscriptionDid - The subscription DID.
+     * @param name - The name of the service.
+     * @param description - The description of the service.
+     * @param price - The price of the service.
+     * @param tokenAddress - The token address.
+     * @param amountOfCredits - The amount of credits.
+     * @param duration - The duration of the service.
+     * @param tags - The tags associated with the service.
+     * @param serviceChargeType - The service charge type ('fixed' or 'dynamic').
+     * @param minCreditsToCharge - The minimum credits to charge.
+     * @param maxCreditsToCharge - The maximum credits to charge.
+     * @param authType - The authentication type ('none', 'basic', or 'oauth').
+     * @param username - The username for authentication.
+     * @param password - The password for authentication.
+     * @param token - The token for authentication.
+     * @param endpoints - The endpoints of the service.
+     * @param openEndpoints - The open endpoints of the service.
+     * @param openApiUrl - The OpenAPI URL.
+     * @param integration - The integration details.
+     * @param sampleLink - The sample link.
+     * @param apiDescription - The API description.
+     * @param curation - The curation details.
+     * @returns A promise that resolves to the created service DID.
+     */
+    async createService({ subscriptionDid, name, description, price, tokenAddress, amountOfCredits, duration, tags, serviceChargeType, minCreditsToCharge, maxCreditsToCharge, authType, username, password, token, endpoints, openEndpoints, openApiUrl, integration, sampleLink, apiDescription, curation, }) {
         const body = {
             sessionKey: this.sessionKey,
             name,
@@ -76,7 +219,6 @@ class Payments {
             apiDescription,
             curation,
         };
-        console.log(body);
         const options = {
             method: 'POST',
             headers: {
@@ -85,13 +227,115 @@ class Payments {
             },
             body: JSON.stringify(body),
         };
-        const url = new URL('/api/v1/payments/webservice', this.environment.backend);
+        const url = new URL('/api/v1/payments/service', this.environment.backend);
         const response = await fetch(url, options);
         if (!response.ok) {
             throw Error(response.statusText);
         }
         return response.json();
     }
+    /**
+     * Creates a file with the specified parameters.
+     *
+     * @param subscriptionDid - The subscription DID.
+     * @param assetType - The type of asset.
+     * @param name - The name of the file.
+     * @param description - The description of the file.
+     * @param files - The array of files.
+     * @param price - The price of the file.
+     * @param tokenAddress - The token address.
+     * @param amountOfCredits - The amount of credits.
+     * @param duration - The duration of the file.
+     * @param tags - The array of tags.
+     * @param dataSchema - The data schema.
+     * @param sampleCode - The sample code.
+     * @param filesFormat - The format of the files.
+     * @param usageExample - The usage example.
+     * @param programmingLanguage - The programming language.
+     * @param framework - The framework.
+     * @param task - The task.
+     * @param trainingDetails - The training details.
+     * @param variations - The variations.
+     * @param fineTunable - Indicates if the file is fine-tunable.
+     * @param minCreditsToCharge - The minimum credits to charge.
+     * @param maxCreditsToCharge - The maximum credits to charge.
+     * @param curation - The curation object.
+     * @returns The promise that resolves to the created file's DID.
+     */
+    async createFile({ subscriptionDid, assetType, name, description, files, price, tokenAddress, amountOfCredits, duration, tags, dataSchema, sampleCode, filesFormat, usageExample, programmingLanguage, framework, task, trainingDetails, variations, fineTunable, minCreditsToCharge, maxCreditsToCharge, curation, }) {
+        const body = {
+            sessionKey: this.sessionKey,
+            assetType,
+            name,
+            description,
+            files,
+            price: price.toString(),
+            tokenAddress,
+            amountOfCredits,
+            duration,
+            tags,
+            subscriptionDid,
+            dataSchema,
+            sampleCode,
+            filesFormat,
+            usageExample,
+            programmingLanguage,
+            framework,
+            task,
+            trainingDetails,
+            variations,
+            fineTunable,
+            minCreditsToCharge,
+            maxCreditsToCharge,
+            curation,
+        };
+        const options = {
+            method: 'POST',
+            headers: {
+                Accept: 'application/json',
+                'Content-Type': 'application/json',
+            },
+            body: JSON.stringify(body),
+        };
+        const url = new URL('/api/v1/payments/file', this.environment.backend);
+        const response = await fetch(url, options);
+        if (!response.ok) {
+            throw Error(response.statusText);
+        }
+        return response.json();
+    }
+    /**
+     * Redirects the user to the subscription details for a given DID.
+     * @param did - The DID (Decentralized Identifier) of the subscription.
+     */
+    getSubscriptionDetails(did) {
+        const url = new URL(`/en/subscription/${did}`, this.environment.frontend);
+        window.location.href = url.toString();
+    }
+    /**
+     * Redirects the user to the service details for a given DID.
+     * @param did - The DID (Decentralized Identifier) of the service.
+     */
+    getServiceDetails(did) {
+        const url = new URL(`/en/webservice/${did}`, this.environment.frontend);
+        window.location.href = url.toString();
+    }
+    /**
+     * Redirects the user to the file details for the specified DID (Decentralized Identifier).
+     * @param did - The DID of the file.
+     */
+    getFileDetails(did) {
+        const url = new URL(`/en/file/${did}`, this.environment.frontend);
+        window.location.href = url.toString();
+    }
+    /**
+     * Redirects the user to the subscription checkout page for the specified DID.
+     * @param did - The DID (Decentralized Identifier) of the item to be subscribed to.
+     */
+    checkoutSubscription(did) {
+        const url = new URL(`/en/subscription/checkout/${did}`, this.environment.frontend);
+        window.location.href = url.toString();
+    }
 }
 exports.Payments = Payments;
 //# sourceMappingURL=payments.js.map

package/dist/payments.js.map

@@ -1 +1 @@
-{"version":3,"file":"payments.js","sourceRoot":"","sources":["../src/payments.ts"],"names":[],"mappings":";;;AAAA,iDAA+E;AAW/E,MAAa,QAAQ;IAKnB,YAAY,OAAuB;QACjC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAA;QAClC,IAAI,CAAC,WAAW,GAAG,2BAAY,CAAC,OAAO,CAAC,WAAW,CAAC,CAAA;IACtD,CAAC;IAEM,IAAI;QACT,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;QACzC,MAAM,UAAU,GAAG,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,CAAC,CAAA;QACrD,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;YAC5B,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,UAAU,CAAC,CAAA;YACtC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;YACrC,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,EAAE,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAA;QACzD,CAAC;IACH,CAAC;IAEM,OAAO;QACZ,MAAM,GAAG,GAAG,IAAI,GAAG,CACjB,8CAA8C,IAAI,CAAC,SAAS,EAAE,EAC9D,IAAI,CAAC,WAAW,CAAC,QAAQ,CAC1B,CAAA;QACD,MAAM,CAAC,QAAQ,CAAC,IAAI,GAAG,GAAG,CAAC,QAAQ,EAAE,CAAA;IACvC,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,CAAC,CAAC,IAAI,CAAC,UAAU,CAAA;IAC1B,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAAC,EAC9B,IAAI,EACJ,WAAW,EACX,KAAK,EACL,YAAY,EACZ,eAAe,EACf,QAAQ,EACR,IAAI,GASL;QACC,MAAM,IAAI,GAAG;YACX,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,IAAI;YACJ,WAAW;YACX,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE;YACvB,YAAY;YACZ,eAAe;YACf,QAAQ;YACR,IAAI;SACL,CAAA;QACD,MAAM,OAAO,GAAG;YACd,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,MAAM,EAAE,kBAAkB;gBAC1B,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;SAC3B,CAAA;QACD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,+BAA+B,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;QAE9E,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QAC1C,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;QAClC,CAAC;QAED,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAA;IACxB,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,EAC5B,eAAe,EACf,IAAI,EACJ,WAAW,EACX,KAAK,EACL,YAAY,EACZ,eAAe,EACf,QAAQ,EACR,IAAI,EACJ,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,KAAK,EACL,SAAS,EACT,aAAa,EACb,UAAU,EACV,WAAW,EACX,UAAU,EACV,cAAc,EACd,QAAQ,GAwBT;QACC,MAAM,IAAI,GAAG;YACX,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,IAAI;YACJ,WAAW;YACX,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE;YACvB,YAAY;YACZ,eAAe;YACf,QAAQ;YACR,IAAI;YACJ,eAAe;YACf,iBAAiB;YACjB,kBAAkB;YAClB,kBAAkB;YAClB,QAAQ;YACR,QAAQ;YACR,QAAQ;YACR,KAAK;YACL,SAAS;YACT,aAAa;YACb,UAAU;YACV,WAAW;YACX,UAAU;YACV,cAAc;YACd,QAAQ;SACT,CAAA;QACD,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QACjB,MAAM,OAAO,GAAG;YACd,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,MAAM,EAAE,kBAAkB;gBAC1B,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;SAC3B,CAAA;QACD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,6BAA6B,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;QAE5E,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QAC1C,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;QAClC,CAAC;QAED,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAA;IACxB,CAAC;CACF;AAxKD,4BAwKC"}
+{"version":3,"file":"payments.js","sourceRoot":"","sources":["../src/payments.ts"],"names":[],"mappings":";;;AAAA,+BAAgC;AAChC,iDAA+E;AA6B/E;;GAEG;AACH,MAAa,QAAQ;IAOnB;;;;;;;;;;;;;;;;OAgBG;IACH,YAAY,OAAuB;QACjC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAA;QAClC,IAAI,CAAC,WAAW,GAAG,2BAAY,CAAC,OAAO,CAAC,WAAW,CAAC,CAAA;QACpD,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAA;QAC1B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;IAChC,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,OAAO;QACZ,MAAM,GAAG,GAAG,IAAI,GAAG,CACjB,8CAA8C,IAAI,CAAC,SAAS,EAAE,EAC9D,IAAI,CAAC,WAAW,CAAC,QAAQ,CAC1B,CAAA;QACD,MAAM,CAAC,QAAQ,CAAC,IAAI,GAAG,GAAG,CAAC,QAAQ,EAAE,CAAA;IACvC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACI,IAAI;QACT,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;QACzC,MAAM,aAAa,GAAG,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,CAAC,CAAA;QACxD,IAAI,aAAa,EAAE,CAAC;YAClB,MAAM,UAAU,GAAG,IAAA,gBAAS,EAAC,aAAa,CAAC,CAAA;YAC3C,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,UAAoB,CAAA;YACjD,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;YACrC,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,EAAE,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAA;QACzD,CAAC;IACH,CAAC;IAED;;;;;;;;;;;OAWG;IACI,MAAM;QACX,IAAI,CAAC,UAAU,GAAG,SAAS,CAAA;IAC7B,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,UAAU;QACZ,OAAO,CAAC,CAAC,IAAI,CAAC,UAAU,CAAA;IAC1B,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACI,KAAK,CAAC,kBAAkB,CAAC,EAC9B,IAAI,EACJ,WAAW,EACX,KAAK,EACL,YAAY,EACZ,eAAe,EACf,QAAQ,EACR,IAAI,GASL;QACC,MAAM,IAAI,GAAG;YACX,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,IAAI;YACJ,WAAW;YACX,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE;YACvB,YAAY;YACZ,eAAe;YACf,QAAQ;YACR,IAAI;SACL,CAAA;QACD,MAAM,OAAO,GAAG;YACd,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,MAAM,EAAE,kBAAkB;gBAC1B,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;SAC3B,CAAA;QACD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,+BAA+B,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;QAE9E,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QAC1C,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;QAClC,CAAC;QAED,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAA;IACxB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACI,KAAK,CAAC,aAAa,CAAC,EACzB,eAAe,EACf,IAAI,EACJ,WAAW,EACX,KAAK,EACL,YAAY,EACZ,eAAe,EACf,QAAQ,EACR,IAAI,EACJ,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,KAAK,EACL,SAAS,EACT,aAAa,EACb,UAAU,EACV,WAAW,EACX,UAAU,EACV,cAAc,EACd,QAAQ,GAwBT;QACC,MAAM,IAAI,GAAG;YACX,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,IAAI;YACJ,WAAW;YACX,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE;YACvB,YAAY;YACZ,eAAe;YACf,QAAQ;YACR,IAAI;YACJ,eAAe;YACf,iBAAiB;YACjB,kBAAkB;YAClB,kBAAkB;YAClB,QAAQ;YACR,QAAQ;YACR,QAAQ;YACR,KAAK;YACL,SAAS;YACT,aAAa;YACb,UAAU;YACV,WAAW;YACX,UAAU;YACV,cAAc;YACd,QAAQ;SACT,CAAA;QACD,MAAM,OAAO,GAAG;YACd,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,MAAM,EAAE,kBAAkB;gBAC1B,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;SAC3B,CAAA;QACD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,0BAA0B,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;QAEzE,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QAC1C,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;QAClC,CAAC;QAED,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAA;IACxB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACI,KAAK,CAAC,UAAU,CAAC,EACtB,eAAe,EACf,SAAS,EACT,IAAI,EACJ,WAAW,EACX,KAAK,EACL,KAAK,EACL,YAAY,EACZ,eAAe,EACf,QAAQ,EACR,IAAI,EACJ,UAAU,EACV,UAAU,EACV,WAAW,EACX,YAAY,EACZ,mBAAmB,EACnB,SAAS,EACT,IAAI,EACJ,eAAe,EACf,UAAU,EACV,WAAW,EACX,kBAAkB,EAClB,kBAAkB,EAClB,QAAQ,GAyBT;QACC,MAAM,IAAI,GAAG;YACX,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,SAAS;YACT,IAAI;YACJ,WAAW;YACX,KAAK;YACL,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE;YACvB,YAAY;YACZ,eAAe;YACf,QAAQ;YACR,IAAI;YACJ,eAAe;YACf,UAAU;YACV,UAAU;YACV,WAAW;YACX,YAAY;YACZ,mBAAmB;YACnB,SAAS;YACT,IAAI;YACJ,eAAe;YACf,UAAU;YACV,WAAW;YACX,kBAAkB;YAClB,kBAAkB;YAClB,QAAQ;SACT,CAAA;QACD,MAAM,OAAO,GAAG;YACd,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,MAAM,EAAE,kBAAkB;gBAC1B,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;SAC3B,CAAA;QACD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,uBAAuB,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;QAEtE,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QAC1C,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;QAClC,CAAC;QAED,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAA;IACxB,CAAC;IAED;;;OAGG;IACI,sBAAsB,CAAC,GAAW;QACvC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,oBAAoB,GAAG,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAA;QACzE,MAAM,CAAC,QAAQ,CAAC,IAAI,GAAG,GAAG,CAAC,QAAQ,EAAE,CAAA;IACvC,CAAC;IAED;;;OAGG;IACI,iBAAiB,CAAC,GAAW;QAClC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,kBAAkB,GAAG,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAA;QACvE,MAAM,CAAC,QAAQ,CAAC,IAAI,GAAG,GAAG,CAAC,QAAQ,EAAE,CAAA;IACvC,CAAC;IAED;;;OAGG;IACI,cAAc,CAAC,GAAW;QAC/B,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,YAAY,GAAG,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAA;QACjE,MAAM,CAAC,QAAQ,CAAC,IAAI,GAAG,GAAG,CAAC,QAAQ,EAAE,CAAA;IACvC,CAAC;IAED;;;OAGG;IACI,oBAAoB,CAAC,GAAW;QACrC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,6BAA6B,GAAG,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAA;QAClF,MAAM,CAAC,QAAQ,CAAC,IAAI,GAAG,GAAG,CAAC,QAAQ,EAAE,CAAA;IACvC,CAAC;CACF;AAldD,4BAkdC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nevermined-io/payments",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "Typescript SDK to interact with the Nevermined Payments Protocol",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -20,7 +20,9 @@
     "format": "prettier --check ./src",
     "prepublishOnly": "yarn build"
   },
-  "dependencies": {},
+  "dependencies": {
+    "jose": "^5.2.2"
+  },
   "devDependencies": {
     "@types/node": "^20.11.19",
     "@typescript-eslint/eslint-plugin": "^7.0.2",
@@ -29,6 +31,7 @@
     "eslint-config-nevermined": "^0.2.0",
     "eslint-config-next": "^14.1.0",
     "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-tsdoc": "^0.2.17",
     "prettier": "^3.2.5",
     "ts-node": "^10.9.2",
     "tslib": "^2.6.2",