@campnetwork/origin 1.2.0-3 → 1.2.0

package/dist/core.d.ts

@@ -1,201 +1,5 @@
 import { Address, Hex, WalletClient, Abi, Account, Chain } from 'viem';
 
-/**
- * The TwitterAPI class.
- * @class
- * @classdesc The TwitterAPI class is used to interact with the Twitter API.
- */
-declare class TwitterAPI {
-    apiKey: string;
-    /**
-     * Constructor for the TwitterAPI class.
-     * @param {object} options - The options object.
-     * @param {string} options.apiKey - The API key. (Needed for data fetching)
-     */
-    constructor({ apiKey }: {
-        apiKey: string;
-    });
-    /**
-     * Fetch Twitter user details by username.
-     * @param {string} twitterUserName - The Twitter username.
-     * @returns {Promise<object>} - The user details.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    fetchUserByUsername(twitterUserName: string): Promise<object>;
-    /**
-     * Fetch tweets by Twitter username.
-     * @param {string} twitterUserName - The Twitter username.
-     * @param {number} page - The page number.
-     * @param {number} limit - The number of items per page.
-     * @returns {Promise<object>} - The tweets.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    fetchTweetsByUsername(twitterUserName: string, page?: number, limit?: number): Promise<object>;
-    /**
-     * Fetch followers by Twitter username.
-     * @param {string} twitterUserName - The Twitter username.
-     * @param {number} page - The page number.
-     * @param {number} limit - The number of items per page.
-     * @returns {Promise<object>} - The followers.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    fetchFollowersByUsername(twitterUserName: string, page?: number, limit?: number): Promise<object>;
-    /**
-     * Fetch following by Twitter username.
-     * @param {string} twitterUserName - The Twitter username.
-     * @param {number} page - The page number.
-     * @param {number} limit - The number of items per page.
-     * @returns {Promise<object>} - The following.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    fetchFollowingByUsername(twitterUserName: string, page?: number, limit?: number): Promise<object>;
-    /**
-     * Fetch tweet by tweet ID.
-     * @param {string} tweetId - The tweet ID.
-     * @returns {Promise<object>} - The tweet.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    fetchTweetById(tweetId: string): Promise<object>;
-    /**
-     * Fetch user by wallet address.
-     * @param {string} walletAddress - The wallet address.
-     * @param {number} page - The page number.
-     * @param {number} limit - The number of items per page.
-     * @returns {Promise<object>} - The user data.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    fetchUserByWalletAddress(walletAddress: string, page?: number, limit?: number): Promise<object>;
-    /**
-     * Fetch reposted tweets by Twitter username.
-     * @param {string} twitterUserName - The Twitter username.
-     * @param {number} page - The page number.
-     * @param {number} limit - The number of items per page.
-     * @returns {Promise<object>} - The reposted tweets.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    fetchRepostedByUsername(twitterUserName: string, page?: number, limit?: number): Promise<object>;
-    /**
-     * Fetch replies by Twitter username.
-     * @param {string} twitterUserName - The Twitter username.
-     * @param {number} page - The page number.
-     * @param {number} limit - The number of items per page.
-     * @returns {Promise<object>} - The replies.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    fetchRepliesByUsername(twitterUserName: string, page?: number, limit?: number): Promise<object>;
-    /**
-     * Fetch likes by Twitter username.
-     * @param {string} twitterUserName - The Twitter username.
-     * @param {number} page - The page number.
-     * @param {number} limit - The number of items per page.
-     * @returns {Promise<object>} - The likes.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    fetchLikesByUsername(twitterUserName: string, page?: number, limit?: number): Promise<object>;
-    /**
-     * Fetch follows by Twitter username.
-     * @param {string} twitterUserName - The Twitter username.
-     * @param {number} page - The page number.
-     * @param {number} limit - The number of items per page.
-     * @returns {Promise<object>} - The follows.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    fetchFollowsByUsername(twitterUserName: string, page?: number, limit?: number): Promise<object>;
-    /**
-     * Fetch viewed tweets by Twitter username.
-     * @param {string} twitterUserName - The Twitter username.
-     * @param {number} page - The page number.
-     * @param {number} limit - The number of items per page.
-     * @returns {Promise<object>} - The viewed tweets.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    fetchViewedTweetsByUsername(twitterUserName: string, page?: number, limit?: number): Promise<object>;
-    /**
-     * Private method to fetch data with authorization header.
-     * @param {string} url - The URL to fetch.
-     * @returns {Promise<object>} - The response data.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    _fetchDataWithAuth(url: string): Promise<object>;
-}
-
-interface SpotifyAPIOptions {
-    apiKey: string;
-}
-/**
- * The SpotifyAPI class.
- * @class
- */
-declare class SpotifyAPI {
-    apiKey: string;
-    /**
-     * Constructor for the SpotifyAPI class.
-     * @constructor
-     * @param {SpotifyAPIOptions} options - The Spotify API options.
-     * @param {string} options.apiKey - The Spotify API key.
-     * @throws {Error} - Throws an error if the API key is not provided.
-     */
-    constructor(options: SpotifyAPIOptions);
-    /**
-     * Fetch the user's saved tracks by Spotify user ID.
-     * @param {string} spotifyId - The user's Spotify ID.
-     * @returns {Promise<object>} - The saved tracks.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    fetchSavedTracksById(spotifyId: string): Promise<object>;
-    /**
-     * Fetch the played tracks of a user by Spotify ID.
-     * @param {string} spotifyId - The user's Spotify ID.
-     * @returns {Promise<object>} - The played tracks.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    fetchPlayedTracksById(spotifyId: string): Promise<object>;
-    /**
-     * Fetch the user's saved albums by Spotify user ID.
-     * @param {string} spotifyId - The user's Spotify ID.
-     * @returns {Promise<object>} - The saved albums.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    fetchSavedAlbumsById(spotifyId: string): Promise<object>;
-    /**
-     * Fetch the user's saved playlists by Spotify user ID.
-     * @param {string} spotifyId - The user's Spotify ID.
-     * @returns {Promise<object>} - The saved playlists.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    fetchSavedPlaylistsById(spotifyId: string): Promise<object>;
-    /**
-     * Fetch the tracks of an album by album ID.
-     * @param {string} spotifyId - The Spotify ID of the user.
-     * @param {string} albumId - The album ID.
-     * @returns {Promise<object>} - The tracks in the album.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    fetchTracksInAlbum(spotifyId: string, albumId: string): Promise<object>;
-    /**
-     * Fetch the tracks in a playlist by playlist ID.
-     * @param {string} spotifyId - The Spotify ID of the user.
-     * @param {string} playlistId - The playlist ID.
-     * @returns {Promise<object>} - The tracks in the playlist.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    fetchTracksInPlaylist(spotifyId: string, playlistId: string): Promise<object>;
-    /**
-     * Fetch the user's Spotify data by wallet address.
-     * @param {string} walletAddress - The wallet address.
-     * @returns {Promise<object>} - The user's Spotify data.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    fetchUserByWalletAddress(walletAddress: string): Promise<object>;
-    /**
-     * Private method to fetch data with authorization header.
-     * @param {string} url - The URL to fetch.
-     * @returns {Promise<object>} - The response data.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    _fetchDataWithAuth(url: string): Promise<object>;
-}
-
 interface Environment {
     NAME: string;
     AUTH_HUB_BASE_API: string;
@@ -254,6 +58,7 @@ type IpNFTSource = "spotify" | "twitter" | "tiktok" | "file";
  * @param to The address to mint the NFT to.
  * @param tokenId The ID of the token to mint.
  * @param parents The IDs of the parent NFTs, if applicable.
+ * @param isIp Whether the NFT is an IP NFT.
  * @param hash The hash of the data associated with the NFT.
  * @param uri The URI of the NFT metadata.
  * @param licenseTerms The terms of the license for the NFT.
@@ -266,7 +71,10 @@ declare function mintWithSignature(this: Origin, to: Address, tokenId: bigint, p
  * Registers a Data NFT with the Origin service in order to obtain a signature for minting.
  * @param source The source of the Data NFT (e.g., "spotify", "twitter", "tiktok", or "file").
  * @param deadline The deadline for the registration operation.
- * @param fileKey Optional file key for file uploads.
+ * @param licenseTerms The terms of the license for the NFT.
+ * @param metadata The metadata associated with the NFT.
+ * @param fileKey The file key(s) if the source is "file".
+ * @param parents The IDs of the parent NFTs, if applicable.
  * @return A promise that resolves with the registration data.
  */
 declare function registerIpNFT(this: Origin, source: IpNFTSource, deadline: bigint, licenseTerms: LicenseTerms, metadata: Record<string, unknown>, fileKey?: string | string[], parents?: bigint[]): Promise<any>;
@@ -414,7 +222,8 @@ declare class Origin {
     private jwt;
     environment: Environment;
     private viemClient?;
-    constructor(jwt: string, environment: Environment, viemClient?: WalletClient);
+    baseParentId?: bigint;
+    constructor(jwt: string, environment: Environment, viemClient?: WalletClient, baseParentId?: bigint);
     getJwt(): string;
     setViemClient(client: WalletClient): void;
     uploadFile(file: File, options?: {
@@ -547,6 +356,7 @@ declare class Auth {
     viem: any;
     origin: Origin | null;
     environment: Environment;
+    baseParentId?: bigint;
     /**
      * Constructor for the Auth class.
      * @param {object} options The options object.
@@ -556,10 +366,11 @@ declare class Auth {
      * @param {StorageAdapter} [options.storage] Custom storage adapter. Defaults to localStorage in browser, memory storage in Node.js.
      * @throws {APIError} - Throws an error if the clientId is not provided.
      */
-    constructor({ clientId, redirectUri, environment, storage, }: {
+    constructor({ clientId, redirectUri, environment, baseParentId, storage, }: {
         clientId: string;
         redirectUri: string | Record<string, string>;
         environment?: "DEVELOPMENT" | "PRODUCTION";
+        baseParentId?: bigint;
         storage?: StorageAdapter;
     });
     /**
@@ -840,4 +651,4 @@ declare const mainnet: {
     };
 };
 
-export { Auth, type BaseSigner, BrowserStorage, CustomSignerAdapter, DataStatus, EthersSignerAdapter, type LicenseTerms, MemoryStorage, type SignerAdapter, type SignerType, SpotifyAPI, type StorageAdapter, TwitterAPI, ViemSignerAdapter, mainnet as campMainnet, testnet as campTestnet, createLicenseTerms, createNodeWalletClient, createSignerAdapter };
+export { Auth, type BaseSigner, BrowserStorage, CustomSignerAdapter, DataStatus, EthersSignerAdapter, type LicenseTerms, MemoryStorage, type SignerAdapter, type SignerType, type StorageAdapter, ViemSignerAdapter, mainnet as campMainnet, testnet as campTestnet, createLicenseTerms, createNodeWalletClient, createSignerAdapter };

package/dist/core.esm.d.ts

@@ -1,201 +1,5 @@
 import { Address, Hex, WalletClient, Abi, Account, Chain } from 'viem';
 
-/**
- * The TwitterAPI class.
- * @class
- * @classdesc The TwitterAPI class is used to interact with the Twitter API.
- */
-declare class TwitterAPI {
-    apiKey: string;
-    /**
-     * Constructor for the TwitterAPI class.
-     * @param {object} options - The options object.
-     * @param {string} options.apiKey - The API key. (Needed for data fetching)
-     */
-    constructor({ apiKey }: {
-        apiKey: string;
-    });
-    /**
-     * Fetch Twitter user details by username.
-     * @param {string} twitterUserName - The Twitter username.
-     * @returns {Promise<object>} - The user details.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    fetchUserByUsername(twitterUserName: string): Promise<object>;
-    /**
-     * Fetch tweets by Twitter username.
-     * @param {string} twitterUserName - The Twitter username.
-     * @param {number} page - The page number.
-     * @param {number} limit - The number of items per page.
-     * @returns {Promise<object>} - The tweets.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    fetchTweetsByUsername(twitterUserName: string, page?: number, limit?: number): Promise<object>;
-    /**
-     * Fetch followers by Twitter username.
-     * @param {string} twitterUserName - The Twitter username.
-     * @param {number} page - The page number.
-     * @param {number} limit - The number of items per page.
-     * @returns {Promise<object>} - The followers.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    fetchFollowersByUsername(twitterUserName: string, page?: number, limit?: number): Promise<object>;
-    /**
-     * Fetch following by Twitter username.
-     * @param {string} twitterUserName - The Twitter username.
-     * @param {number} page - The page number.
-     * @param {number} limit - The number of items per page.
-     * @returns {Promise<object>} - The following.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    fetchFollowingByUsername(twitterUserName: string, page?: number, limit?: number): Promise<object>;
-    /**
-     * Fetch tweet by tweet ID.
-     * @param {string} tweetId - The tweet ID.
-     * @returns {Promise<object>} - The tweet.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    fetchTweetById(tweetId: string): Promise<object>;
-    /**
-     * Fetch user by wallet address.
-     * @param {string} walletAddress - The wallet address.
-     * @param {number} page - The page number.
-     * @param {number} limit - The number of items per page.
-     * @returns {Promise<object>} - The user data.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    fetchUserByWalletAddress(walletAddress: string, page?: number, limit?: number): Promise<object>;
-    /**
-     * Fetch reposted tweets by Twitter username.
-     * @param {string} twitterUserName - The Twitter username.
-     * @param {number} page - The page number.
-     * @param {number} limit - The number of items per page.
-     * @returns {Promise<object>} - The reposted tweets.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    fetchRepostedByUsername(twitterUserName: string, page?: number, limit?: number): Promise<object>;
-    /**
-     * Fetch replies by Twitter username.
-     * @param {string} twitterUserName - The Twitter username.
-     * @param {number} page - The page number.
-     * @param {number} limit - The number of items per page.
-     * @returns {Promise<object>} - The replies.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    fetchRepliesByUsername(twitterUserName: string, page?: number, limit?: number): Promise<object>;
-    /**
-     * Fetch likes by Twitter username.
-     * @param {string} twitterUserName - The Twitter username.
-     * @param {number} page - The page number.
-     * @param {number} limit - The number of items per page.
-     * @returns {Promise<object>} - The likes.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    fetchLikesByUsername(twitterUserName: string, page?: number, limit?: number): Promise<object>;
-    /**
-     * Fetch follows by Twitter username.
-     * @param {string} twitterUserName - The Twitter username.
-     * @param {number} page - The page number.
-     * @param {number} limit - The number of items per page.
-     * @returns {Promise<object>} - The follows.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    fetchFollowsByUsername(twitterUserName: string, page?: number, limit?: number): Promise<object>;
-    /**
-     * Fetch viewed tweets by Twitter username.
-     * @param {string} twitterUserName - The Twitter username.
-     * @param {number} page - The page number.
-     * @param {number} limit - The number of items per page.
-     * @returns {Promise<object>} - The viewed tweets.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    fetchViewedTweetsByUsername(twitterUserName: string, page?: number, limit?: number): Promise<object>;
-    /**
-     * Private method to fetch data with authorization header.
-     * @param {string} url - The URL to fetch.
-     * @returns {Promise<object>} - The response data.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    _fetchDataWithAuth(url: string): Promise<object>;
-}
-
-interface SpotifyAPIOptions {
-    apiKey: string;
-}
-/**
- * The SpotifyAPI class.
- * @class
- */
-declare class SpotifyAPI {
-    apiKey: string;
-    /**
-     * Constructor for the SpotifyAPI class.
-     * @constructor
-     * @param {SpotifyAPIOptions} options - The Spotify API options.
-     * @param {string} options.apiKey - The Spotify API key.
-     * @throws {Error} - Throws an error if the API key is not provided.
-     */
-    constructor(options: SpotifyAPIOptions);
-    /**
-     * Fetch the user's saved tracks by Spotify user ID.
-     * @param {string} spotifyId - The user's Spotify ID.
-     * @returns {Promise<object>} - The saved tracks.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    fetchSavedTracksById(spotifyId: string): Promise<object>;
-    /**
-     * Fetch the played tracks of a user by Spotify ID.
-     * @param {string} spotifyId - The user's Spotify ID.
-     * @returns {Promise<object>} - The played tracks.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    fetchPlayedTracksById(spotifyId: string): Promise<object>;
-    /**
-     * Fetch the user's saved albums by Spotify user ID.
-     * @param {string} spotifyId - The user's Spotify ID.
-     * @returns {Promise<object>} - The saved albums.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    fetchSavedAlbumsById(spotifyId: string): Promise<object>;
-    /**
-     * Fetch the user's saved playlists by Spotify user ID.
-     * @param {string} spotifyId - The user's Spotify ID.
-     * @returns {Promise<object>} - The saved playlists.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    fetchSavedPlaylistsById(spotifyId: string): Promise<object>;
-    /**
-     * Fetch the tracks of an album by album ID.
-     * @param {string} spotifyId - The Spotify ID of the user.
-     * @param {string} albumId - The album ID.
-     * @returns {Promise<object>} - The tracks in the album.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    fetchTracksInAlbum(spotifyId: string, albumId: string): Promise<object>;
-    /**
-     * Fetch the tracks in a playlist by playlist ID.
-     * @param {string} spotifyId - The Spotify ID of the user.
-     * @param {string} playlistId - The playlist ID.
-     * @returns {Promise<object>} - The tracks in the playlist.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    fetchTracksInPlaylist(spotifyId: string, playlistId: string): Promise<object>;
-    /**
-     * Fetch the user's Spotify data by wallet address.
-     * @param {string} walletAddress - The wallet address.
-     * @returns {Promise<object>} - The user's Spotify data.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    fetchUserByWalletAddress(walletAddress: string): Promise<object>;
-    /**
-     * Private method to fetch data with authorization header.
-     * @param {string} url - The URL to fetch.
-     * @returns {Promise<object>} - The response data.
-     * @throws {APIError} - Throws an error if the request fails.
-     */
-    _fetchDataWithAuth(url: string): Promise<object>;
-}
-
 interface Environment {
     NAME: string;
     AUTH_HUB_BASE_API: string;
@@ -254,6 +58,7 @@ type IpNFTSource = "spotify" | "twitter" | "tiktok" | "file";
  * @param to The address to mint the NFT to.
  * @param tokenId The ID of the token to mint.
  * @param parents The IDs of the parent NFTs, if applicable.
+ * @param isIp Whether the NFT is an IP NFT.
  * @param hash The hash of the data associated with the NFT.
  * @param uri The URI of the NFT metadata.
  * @param licenseTerms The terms of the license for the NFT.
@@ -266,7 +71,10 @@ declare function mintWithSignature(this: Origin, to: Address, tokenId: bigint, p
  * Registers a Data NFT with the Origin service in order to obtain a signature for minting.
  * @param source The source of the Data NFT (e.g., "spotify", "twitter", "tiktok", or "file").
  * @param deadline The deadline for the registration operation.
- * @param fileKey Optional file key for file uploads.
+ * @param licenseTerms The terms of the license for the NFT.
+ * @param metadata The metadata associated with the NFT.
+ * @param fileKey The file key(s) if the source is "file".
+ * @param parents The IDs of the parent NFTs, if applicable.
  * @return A promise that resolves with the registration data.
  */
 declare function registerIpNFT(this: Origin, source: IpNFTSource, deadline: bigint, licenseTerms: LicenseTerms, metadata: Record<string, unknown>, fileKey?: string | string[], parents?: bigint[]): Promise<any>;
@@ -414,7 +222,8 @@ declare class Origin {
     private jwt;
     environment: Environment;
     private viemClient?;
-    constructor(jwt: string, environment: Environment, viemClient?: WalletClient);
+    baseParentId?: bigint;
+    constructor(jwt: string, environment: Environment, viemClient?: WalletClient, baseParentId?: bigint);
     getJwt(): string;
     setViemClient(client: WalletClient): void;
     uploadFile(file: File, options?: {
@@ -547,6 +356,7 @@ declare class Auth {
     viem: any;
     origin: Origin | null;
     environment: Environment;
+    baseParentId?: bigint;
     /**
      * Constructor for the Auth class.
      * @param {object} options The options object.
@@ -556,10 +366,11 @@ declare class Auth {
      * @param {StorageAdapter} [options.storage] Custom storage adapter. Defaults to localStorage in browser, memory storage in Node.js.
      * @throws {APIError} - Throws an error if the clientId is not provided.
      */
-    constructor({ clientId, redirectUri, environment, storage, }: {
+    constructor({ clientId, redirectUri, environment, baseParentId, storage, }: {
         clientId: string;
         redirectUri: string | Record<string, string>;
         environment?: "DEVELOPMENT" | "PRODUCTION";
+        baseParentId?: bigint;
         storage?: StorageAdapter;
     });
     /**
@@ -840,4 +651,4 @@ declare const mainnet: {
     };
 };
 
-export { Auth, type BaseSigner, BrowserStorage, CustomSignerAdapter, DataStatus, EthersSignerAdapter, type LicenseTerms, MemoryStorage, type SignerAdapter, type SignerType, SpotifyAPI, type StorageAdapter, TwitterAPI, ViemSignerAdapter, mainnet as campMainnet, testnet as campTestnet, createLicenseTerms, createNodeWalletClient, createSignerAdapter };
+export { Auth, type BaseSigner, BrowserStorage, CustomSignerAdapter, DataStatus, EthersSignerAdapter, type LicenseTerms, MemoryStorage, type SignerAdapter, type SignerType, type StorageAdapter, ViemSignerAdapter, mainnet as campMainnet, testnet as campTestnet, createLicenseTerms, createNodeWalletClient, createSignerAdapter };