@campnetwork/origin 0.0.17 → 1.0.0-alpha.1

package/dist/core.d.ts

@@ -196,6 +196,18 @@ declare class SpotifyAPI {
     _fetchDataWithAuth(url: string): Promise<object>;
 }
 
+interface Environment {
+    NAME: string;
+    AUTH_HUB_BASE_API: string;
+    AUTH_ENDPOINT: string;
+    ORIGIN_DASHBOARD: string;
+    DATANFT_CONTRACT_ADDRESS: string;
+    MARKETPLACE_CONTRACT_ADDRESS: string;
+    CHAIN: any;
+    IPNFT_ABI?: any;
+    MARKETPLACE_ABI?: any;
+}
+
 /**
  * Represents the terms of a license for a digital asset.
  * @property price - The price of the asset in wei.
@@ -230,7 +242,7 @@ type IpNFTSource = "spotify" | "twitter" | "tiktok" | "file";
  * Mints a Data NFT with a signature.
  * @param to The address to mint the NFT to.
  * @param tokenId The ID of the token to mint.
- * @param parentId The ID of the parent NFT, if applicable.
+ * @param parents The IDs of the parent NFTs, if applicable.
  * @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.
@@ -238,7 +250,7 @@ type IpNFTSource = "spotify" | "twitter" | "tiktok" | "file";
  * @param signature The signature for the minting operation.
  * @returns A promise that resolves when the minting is complete.
  */
-declare function mintWithSignature(this: Origin, to: Address, tokenId: bigint, parentId: bigint, hash: Hex, uri: string, licenseTerms: LicenseTerms, deadline: bigint, signature: Hex): Promise<any>;
+declare function mintWithSignature(this: Origin, to: Address, tokenId: bigint, parents: bigint[], hash: Hex, uri: string, licenseTerms: LicenseTerms, deadline: bigint, signature: Hex): Promise<any>;
 /**
  * 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").
@@ -246,7 +258,7 @@ declare function mintWithSignature(this: Origin, to: Address, tokenId: bigint, p
  * @param fileKey Optional file key for file uploads.
  * @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[], parentId?: bigint): Promise<any>;
+declare function registerIpNFT(this: Origin, source: IpNFTSource, deadline: bigint, licenseTerms: LicenseTerms, metadata: Record<string, unknown>, fileKey?: string | string[], parents?: bigint[]): Promise<any>;
 
 declare function updateTerms(this: Origin, tokenId: bigint, royaltyReceiver: Address, newTerms: LicenseTerms): Promise<any>;
 
@@ -278,7 +290,7 @@ declare function approve(this: Origin, to: Address, tokenId: bigint): Promise<an
 
 declare function setApprovalForAll(this: Origin, operator: Address, approved: boolean): Promise<any>;
 
-declare function buyAccess(this: Origin, buyer: Address, tokenId: bigint, periods: number, value?: bigint): Promise<any>;
+declare function buyAccess(this: Origin, buyer: Address, tokenId: bigint, expectedPrice: bigint, expectedDuration: bigint, expectedPaymentToken: Address, value?: bigint): Promise<any>;
 
 declare function renewAccess(this: Origin, tokenId: bigint, buyer: Address, periods: number, value?: bigint): Promise<any>;
 
@@ -328,14 +340,15 @@ declare class Origin {
     hasAccess: typeof hasAccess;
     subscriptionExpiry: typeof subscriptionExpiry;
     private jwt;
+    environment: Environment;
     private viemClient?;
-    constructor(jwt: string, viemClient?: any);
+    constructor(jwt: string, environment: Environment, viemClient?: any);
     getJwt(): string;
     setViemClient(client: any): void;
     uploadFile: (file: File, options?: {
         progressCallback?: (percent: number) => void;
     }) => Promise<any>;
-    mintFile: (file: File, metadata: Record<string, unknown>, license: LicenseTerms, parentId?: bigint, options?: {
+    mintFile: (file: File, metadata: Record<string, unknown>, license: LicenseTerms, parents?: bigint[], options?: {
         progressCallback?: (percent: number) => void;
     }) => Promise<string | null>;
     mintSocial: (source: "spotify" | "twitter" | "tiktok", metadata: Record<string, unknown>, license: LicenseTerms) => Promise<string | null>;
@@ -373,10 +386,9 @@ declare class Origin {
     /**
      * Buy access to an asset by first checking its price via getTerms, then calling buyAccess.
      * @param {bigint} tokenId The token ID of the asset.
-     * @param {number} periods The number of periods to buy access for.
      * @returns {Promise<any>} The result of the buyAccess call.
      */
-    buyAccessSmart(tokenId: bigint, periods: number): Promise<any>;
+    buyAccessSmart(tokenId: bigint): Promise<any>;
     getData(tokenId: bigint): Promise<any>;
 }
 
@@ -400,6 +412,7 @@ declare class Auth {
     userId: string | null;
     viem: any;
     origin: Origin | null;
+    environment: Environment;
     /**
      * Constructor for the Auth class.
      * @param {object} options The options object.
@@ -407,13 +420,15 @@ declare class Auth {
      * @param {string|object} options.redirectUri The redirect URI used for oauth. Leave empty if you want to use the current URL. If you want different redirect URIs for different socials, pass an object with the socials as keys and the redirect URIs as values.
      * @param {boolean} [options.allowAnalytics=true] Whether to allow analytics to be sent.
      * @param {object} [options.ackeeInstance] The Ackee instance.
+     * @param {("DEVELOPMENT"|"PRODUCTION")} [options.environment="DEVELOPMENT"] The environment to use.
      * @throws {APIError} - Throws an error if the clientId is not provided.
      */
-    constructor({ clientId, redirectUri, allowAnalytics, ackeeInstance, }: {
+    constructor({ clientId, redirectUri, allowAnalytics, ackeeInstance, environment, }: {
         clientId: string;
         redirectUri: string | Record<string, string>;
         allowAnalytics?: boolean;
         ackeeInstance?: any;
+        environment?: "DEVELOPMENT" | "PRODUCTION";
     });
     /**
      * Subscribe to an event. Possible events are "state", "provider", "providers", and "viem".
@@ -449,6 +464,10 @@ declare class Auth {
      * @returns {void}
      */
     setWalletAddress(walletAddress: string): void;
+    /**
+     * Recover the provider from local storage.
+     * @returns {Promise<void>}
+     */
     recoverProvider(): Promise<void>;
     /**
      * Disconnect the user.

package/dist/core.esm.d.ts

@@ -196,6 +196,18 @@ declare class SpotifyAPI {
     _fetchDataWithAuth(url: string): Promise<object>;
 }
 
+interface Environment {
+    NAME: string;
+    AUTH_HUB_BASE_API: string;
+    AUTH_ENDPOINT: string;
+    ORIGIN_DASHBOARD: string;
+    DATANFT_CONTRACT_ADDRESS: string;
+    MARKETPLACE_CONTRACT_ADDRESS: string;
+    CHAIN: any;
+    IPNFT_ABI?: any;
+    MARKETPLACE_ABI?: any;
+}
+
 /**
  * Represents the terms of a license for a digital asset.
  * @property price - The price of the asset in wei.
@@ -230,7 +242,7 @@ type IpNFTSource = "spotify" | "twitter" | "tiktok" | "file";
  * Mints a Data NFT with a signature.
  * @param to The address to mint the NFT to.
  * @param tokenId The ID of the token to mint.
- * @param parentId The ID of the parent NFT, if applicable.
+ * @param parents The IDs of the parent NFTs, if applicable.
  * @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.
@@ -238,7 +250,7 @@ type IpNFTSource = "spotify" | "twitter" | "tiktok" | "file";
  * @param signature The signature for the minting operation.
  * @returns A promise that resolves when the minting is complete.
  */
-declare function mintWithSignature(this: Origin, to: Address, tokenId: bigint, parentId: bigint, hash: Hex, uri: string, licenseTerms: LicenseTerms, deadline: bigint, signature: Hex): Promise<any>;
+declare function mintWithSignature(this: Origin, to: Address, tokenId: bigint, parents: bigint[], hash: Hex, uri: string, licenseTerms: LicenseTerms, deadline: bigint, signature: Hex): Promise<any>;
 /**
  * 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").
@@ -246,7 +258,7 @@ declare function mintWithSignature(this: Origin, to: Address, tokenId: bigint, p
  * @param fileKey Optional file key for file uploads.
  * @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[], parentId?: bigint): Promise<any>;
+declare function registerIpNFT(this: Origin, source: IpNFTSource, deadline: bigint, licenseTerms: LicenseTerms, metadata: Record<string, unknown>, fileKey?: string | string[], parents?: bigint[]): Promise<any>;
 
 declare function updateTerms(this: Origin, tokenId: bigint, royaltyReceiver: Address, newTerms: LicenseTerms): Promise<any>;
 
@@ -278,7 +290,7 @@ declare function approve(this: Origin, to: Address, tokenId: bigint): Promise<an
 
 declare function setApprovalForAll(this: Origin, operator: Address, approved: boolean): Promise<any>;
 
-declare function buyAccess(this: Origin, buyer: Address, tokenId: bigint, periods: number, value?: bigint): Promise<any>;
+declare function buyAccess(this: Origin, buyer: Address, tokenId: bigint, expectedPrice: bigint, expectedDuration: bigint, expectedPaymentToken: Address, value?: bigint): Promise<any>;
 
 declare function renewAccess(this: Origin, tokenId: bigint, buyer: Address, periods: number, value?: bigint): Promise<any>;
 
@@ -328,14 +340,15 @@ declare class Origin {
     hasAccess: typeof hasAccess;
     subscriptionExpiry: typeof subscriptionExpiry;
     private jwt;
+    environment: Environment;
     private viemClient?;
-    constructor(jwt: string, viemClient?: any);
+    constructor(jwt: string, environment: Environment, viemClient?: any);
     getJwt(): string;
     setViemClient(client: any): void;
     uploadFile: (file: File, options?: {
         progressCallback?: (percent: number) => void;
     }) => Promise<any>;
-    mintFile: (file: File, metadata: Record<string, unknown>, license: LicenseTerms, parentId?: bigint, options?: {
+    mintFile: (file: File, metadata: Record<string, unknown>, license: LicenseTerms, parents?: bigint[], options?: {
         progressCallback?: (percent: number) => void;
     }) => Promise<string | null>;
     mintSocial: (source: "spotify" | "twitter" | "tiktok", metadata: Record<string, unknown>, license: LicenseTerms) => Promise<string | null>;
@@ -373,10 +386,9 @@ declare class Origin {
     /**
      * Buy access to an asset by first checking its price via getTerms, then calling buyAccess.
      * @param {bigint} tokenId The token ID of the asset.
-     * @param {number} periods The number of periods to buy access for.
      * @returns {Promise<any>} The result of the buyAccess call.
      */
-    buyAccessSmart(tokenId: bigint, periods: number): Promise<any>;
+    buyAccessSmart(tokenId: bigint): Promise<any>;
     getData(tokenId: bigint): Promise<any>;
 }
 
@@ -400,6 +412,7 @@ declare class Auth {
     userId: string | null;
     viem: any;
     origin: Origin | null;
+    environment: Environment;
     /**
      * Constructor for the Auth class.
      * @param {object} options The options object.
@@ -407,13 +420,15 @@ declare class Auth {
      * @param {string|object} options.redirectUri The redirect URI used for oauth. Leave empty if you want to use the current URL. If you want different redirect URIs for different socials, pass an object with the socials as keys and the redirect URIs as values.
      * @param {boolean} [options.allowAnalytics=true] Whether to allow analytics to be sent.
      * @param {object} [options.ackeeInstance] The Ackee instance.
+     * @param {("DEVELOPMENT"|"PRODUCTION")} [options.environment="DEVELOPMENT"] The environment to use.
      * @throws {APIError} - Throws an error if the clientId is not provided.
      */
-    constructor({ clientId, redirectUri, allowAnalytics, ackeeInstance, }: {
+    constructor({ clientId, redirectUri, allowAnalytics, ackeeInstance, environment, }: {
         clientId: string;
         redirectUri: string | Record<string, string>;
         allowAnalytics?: boolean;
         ackeeInstance?: any;
+        environment?: "DEVELOPMENT" | "PRODUCTION";
     });
     /**
      * Subscribe to an event. Possible events are "state", "provider", "providers", and "viem".
@@ -449,6 +464,10 @@ declare class Auth {
      * @returns {void}
      */
     setWalletAddress(walletAddress: string): void;
+    /**
+     * Recover the provider from local storage.
+     * @returns {Promise<void>}
+     */
     recoverProvider(): Promise<void>;
     /**
      * Disconnect the user.