@campnetwork/origin 1.2.3 → 1.2.5

package/dist/core.d.ts

@@ -331,26 +331,28 @@ interface TransactionResult {
     receipt?: any;
 }
 /**
- * Settles an X402 payment response by purchasing access if needed.
+ * EXPERIMENTAL METHOD
+ * Settles a payment intent response by purchasing access if needed.
  * This method checks if the user already has access to the item, and if not,
- * it calls buyAccess with the parameters from the X402 response.
+ * it calls buyAccess with the parameters from the payment intent response.
  * Supports viem WalletClient, ethers Signer, and custom signer implementations.
  *
- * @param x402Response - The response from getDataWithX402 containing payment details.
+ * @param paymentIntentResponse - The response from getDataWithIntent containing payment details.
  * @param signer - Optional signer object used to interact with the blockchain. If not provided, uses the connected wallet client.
  * @returns A promise that resolves with the transaction hash and receipt, or null if access already exists.
  * @throws {Error} If the response doesn't contain marketplace action or if the method is not buyAccess.
  */
-declare function settleX402(this: Origin, x402Response: X402Response, signer?: any): Promise<TransactionResult | null>;
+declare function settlePaymentIntent(this: Origin, paymentIntentResponse: X402Response, signer?: any): Promise<TransactionResult | null>;
 
 /**
+ * EXPERIMENTAL METHOD
  * Fetch data with X402 payment handling.
  * @param {bigint} tokenId The token ID to fetch data for.
  * @param {any} [signer] Optional signer object for signing the X402 intent.
  * @returns {Promise<any>} A promise that resolves with the fetched data.
  * @throws {Error} Throws an error if the data cannot be fetched or if no signer/wallet client is provided.
  */
-declare function getDataWithX402(this: Origin, tokenId: bigint, signer?: any): Promise<any>;
+declare function getDataWithIntent(this: Origin, tokenId: bigint, signer?: any, decide?: (terms: any) => Promise<boolean>): Promise<any>;
 
 interface RoyaltyInfo {
     tokenBoundAccount: Address;
@@ -365,7 +367,7 @@ type CallOptions = {
 };
 /**
  * The Origin class
- * Handles the upload of files to Origin, as well as querying the user's stats
+ * Handles interactions with Origin protocol.
  */
 declare class Origin {
     #private;
@@ -387,18 +389,36 @@ declare class Origin {
     buyAccess: typeof buyAccess;
     hasAccess: typeof hasAccess;
     subscriptionExpiry: typeof subscriptionExpiry;
-    settleX402: typeof settleX402;
-    getDataWithX402: typeof getDataWithX402;
+    settlePaymentIntent: typeof settlePaymentIntent;
+    getDataWithIntent: typeof getDataWithIntent;
     private jwt?;
     environment: Environment;
     private viemClient?;
     baseParentId?: bigint;
-    constructor(environment: Environment | string, jwt?: string, viemClient?: WalletClient, baseParentId?: bigint);
+    constructor(environment?: Environment | string, jwt?: string, viemClient?: WalletClient, baseParentId?: bigint);
     getJwt(): string | undefined;
     setViemClient(client: WalletClient): void;
+    /**
+     * Mints a file-based IpNFT.
+     * @param file The file to mint.
+     * @param metadata The metadata associated with the file.
+     * @param license The license terms for the IpNFT.
+     * @param parents Optional parent token IDs for lineage tracking.
+     * @param options Optional parameters including progress callback, preview image, and use asset as preview flag.
+     * @returns The token ID of the minted IpNFT as a string, or null if minting failed.
+     */
     mintFile(file: File, metadata: Record<string, unknown>, license: LicenseTerms, parents?: bigint[], options?: {
         progressCallback?: (percent: number) => void;
+        previewImage?: File | null;
+        useAssetAsPreview?: boolean;
     }): Promise<string | null>;
+    /**
+     * Mints a social IpNFT.
+     * @param source The social media source (spotify, twitter, tiktok).
+     * @param metadata The metadata associated with the social media content.
+     * @param license The license terms for the IpNFT.
+     * @return The token ID of the minted IpNFT as a string, or null if minting failed.
+     */
     mintSocial(source: "spotify" | "twitter" | "tiktok", metadata: Record<string, unknown>, license: LicenseTerms): Promise<string | null>;
     /**
      * Call a contract method.

package/dist/core.esm.d.ts

@@ -331,26 +331,28 @@ interface TransactionResult {
     receipt?: any;
 }
 /**
- * Settles an X402 payment response by purchasing access if needed.
+ * EXPERIMENTAL METHOD
+ * Settles a payment intent response by purchasing access if needed.
  * This method checks if the user already has access to the item, and if not,
- * it calls buyAccess with the parameters from the X402 response.
+ * it calls buyAccess with the parameters from the payment intent response.
  * Supports viem WalletClient, ethers Signer, and custom signer implementations.
  *
- * @param x402Response - The response from getDataWithX402 containing payment details.
+ * @param paymentIntentResponse - The response from getDataWithIntent containing payment details.
  * @param signer - Optional signer object used to interact with the blockchain. If not provided, uses the connected wallet client.
  * @returns A promise that resolves with the transaction hash and receipt, or null if access already exists.
  * @throws {Error} If the response doesn't contain marketplace action or if the method is not buyAccess.
  */
-declare function settleX402(this: Origin, x402Response: X402Response, signer?: any): Promise<TransactionResult | null>;
+declare function settlePaymentIntent(this: Origin, paymentIntentResponse: X402Response, signer?: any): Promise<TransactionResult | null>;
 
 /**
+ * EXPERIMENTAL METHOD
  * Fetch data with X402 payment handling.
  * @param {bigint} tokenId The token ID to fetch data for.
  * @param {any} [signer] Optional signer object for signing the X402 intent.
  * @returns {Promise<any>} A promise that resolves with the fetched data.
  * @throws {Error} Throws an error if the data cannot be fetched or if no signer/wallet client is provided.
  */
-declare function getDataWithX402(this: Origin, tokenId: bigint, signer?: any): Promise<any>;
+declare function getDataWithIntent(this: Origin, tokenId: bigint, signer?: any, decide?: (terms: any) => Promise<boolean>): Promise<any>;
 
 interface RoyaltyInfo {
     tokenBoundAccount: Address;
@@ -365,7 +367,7 @@ type CallOptions = {
 };
 /**
  * The Origin class
- * Handles the upload of files to Origin, as well as querying the user's stats
+ * Handles interactions with Origin protocol.
  */
 declare class Origin {
     #private;
@@ -387,18 +389,36 @@ declare class Origin {
     buyAccess: typeof buyAccess;
     hasAccess: typeof hasAccess;
     subscriptionExpiry: typeof subscriptionExpiry;
-    settleX402: typeof settleX402;
-    getDataWithX402: typeof getDataWithX402;
+    settlePaymentIntent: typeof settlePaymentIntent;
+    getDataWithIntent: typeof getDataWithIntent;
     private jwt?;
     environment: Environment;
     private viemClient?;
     baseParentId?: bigint;
-    constructor(environment: Environment | string, jwt?: string, viemClient?: WalletClient, baseParentId?: bigint);
+    constructor(environment?: Environment | string, jwt?: string, viemClient?: WalletClient, baseParentId?: bigint);
     getJwt(): string | undefined;
     setViemClient(client: WalletClient): void;
+    /**
+     * Mints a file-based IpNFT.
+     * @param file The file to mint.
+     * @param metadata The metadata associated with the file.
+     * @param license The license terms for the IpNFT.
+     * @param parents Optional parent token IDs for lineage tracking.
+     * @param options Optional parameters including progress callback, preview image, and use asset as preview flag.
+     * @returns The token ID of the minted IpNFT as a string, or null if minting failed.
+     */
     mintFile(file: File, metadata: Record<string, unknown>, license: LicenseTerms, parents?: bigint[], options?: {
         progressCallback?: (percent: number) => void;
+        previewImage?: File | null;
+        useAssetAsPreview?: boolean;
     }): Promise<string | null>;
+    /**
+     * Mints a social IpNFT.
+     * @param source The social media source (spotify, twitter, tiktok).
+     * @param metadata The metadata associated with the social media content.
+     * @param license The license terms for the IpNFT.
+     * @return The token ID of the minted IpNFT as a string, or null if minting failed.
+     */
     mintSocial(source: "spotify" | "twitter" | "tiktok", metadata: Record<string, unknown>, license: LicenseTerms): Promise<string | null>;
     /**
      * Call a contract method.