@oceanprotocol/lib 4.1.4 → 4.2.0

package/dist/types/services/Aquarius.d.ts

@@ -21,7 +21,7 @@ export declare class Aquarius {
      * @param {AbortSignal} signal abort signal
      * @return {Promise<Asset>} Asset
      */
-    resolve(did: string, signal?: AbortSignal): Promise<Asset>;
+    resolve(did: string, signal?: AbortSignal, authorization?: string): Promise<Asset>;
     /**
      * Blocks until Indexer will cache the did (or the update for that did) or timeouts
      * @param {string} did DID of the asset.
@@ -29,7 +29,7 @@ export declare class Aquarius {
      * @param {AbortSignal} signal abort signal
      * @return {Promise<Asset>} DDO of the asset.
      */
-    waitForIndexer(did: string, txid?: string, signal?: AbortSignal, interval?: number, maxRetries?: number): Promise<Asset>;
+    waitForIndexer(did: string, txid?: string, signal?: AbortSignal, interval?: number, maxRetries?: number, authorization?: string): Promise<Asset>;
     /**
      * Validate DDO content
      * @param {DDO} ddo DID Descriptor Object content.
@@ -38,19 +38,19 @@ export declare class Aquarius {
      * @param {AbortSignal} signal abort signal
      * @return {Promise<ValidateMetadata>}.
      */
-    validate(ddo: DDO, signer: Signer, providerUrl: string, signal?: AbortSignal): Promise<ValidateMetadata>;
+    validate(ddo: DDO, signer: Signer, providerUrl: string, signal?: AbortSignal, authorization?: string): Promise<ValidateMetadata>;
     /**
      * Search over the DDOs using a query.
      * @param {string} did DID of the asset
      * @param {AbortSignal} signal abort signal
      * @return {Promise<QueryResult>}
      */
-    getAssetMetadata(did: string, signal?: AbortSignal): Promise<any>;
+    getAssetMetadata(did: string, signal?: AbortSignal, authorization?: string): Promise<any>;
     /**
      * Search over the DDOs using a query.
      * @param  {SearchQuery} query Query to filter the DDOs.
      * @param {AbortSignal} signal abort signal
      * @return {Promise<QueryResult>}
      */
-    querySearch(query: SearchQuery, signal?: AbortSignal): Promise<any>;
+    querySearch(query: SearchQuery, signal?: AbortSignal, authorization?: string): Promise<any>;
 }

package/dist/types/services/Provider.d.ts

@@ -6,7 +6,7 @@ export declare class Provider {
      * @param {string} providerUri - the provider url
      * @return {Promise<any>}
      */
-    getEndpoints(providerUri: string): Promise<any>;
+    getEndpoints(providerUri: string, authorization?: string): Promise<any>;
     /**
      * This function returns the endpoint URL for a given service name.
      * @param {ServiceEndpoint[]} servicesEndpoints - The array of service endpoints
@@ -30,7 +30,7 @@ export declare class Provider {
      * @param {string} serviceEndpoints document description object (DDO)=
      * @return {Promise<string>} urlDetails
      */
-    getNonce(providerUri: string, consumerAddress: string, signal?: AbortSignal, providerEndpoints?: any, serviceEndpoints?: ServiceEndpoint[]): Promise<number>;
+    getNonce(providerUri: string, consumerAddress: string, signal?: AbortSignal, providerEndpoints?: any, serviceEndpoints?: ServiceEndpoint[], authorization?: string): Promise<number>;
     /**
      * Sign a provider request with a signer.
      * @param {Signer} signer - The signer to use.
@@ -46,7 +46,7 @@ export declare class Provider {
      * @param {AbortSignal} signal abort signal
      * @return {Promise<string>} urlDetails
      */
-    encrypt(data: any, chainId: number, providerUri: string, signal?: AbortSignal): Promise<string>;
+    encrypt(data: any, chainId: number, providerUri: string, signal?: AbortSignal, authorization?: string): Promise<string>;
     /**
      * Get file details for a given DID and service ID.
      * @param {string} did - The DID to check.
@@ -56,7 +56,7 @@ export declare class Provider {
      * @param {AbortSignal} [signal] - An optional abort signal.
      * @returns {Promise<FileInfo[]>} A promise that resolves with an array of file info objects.
      */
-    checkDidFiles(did: string, serviceId: string, providerUri: string, withChecksum?: boolean, signal?: AbortSignal): Promise<FileInfo[]>;
+    checkDidFiles(did: string, serviceId: string, providerUri: string, withChecksum?: boolean, signal?: AbortSignal, authorization?: string): Promise<FileInfo[]>;
     /**
      * Get File details (if possible)
      * @param {UrlFile | Arweave | Ipfs | GraphqlQuery | Smartcontract} file one of the supported file structures
@@ -65,14 +65,14 @@ export declare class Provider {
      * @param {AbortSignal} [signal] - An optional abort signal.
      * @returns {Promise<FileInfo[]>} A promise that resolves with an array of file info objects.
      */
-    getFileInfo(file: UrlFile | Arweave | Ipfs, providerUri: string, withChecksum?: boolean, signal?: AbortSignal): Promise<FileInfo[]>;
+    getFileInfo(file: UrlFile | Arweave | Ipfs, providerUri: string, withChecksum?: boolean, signal?: AbortSignal, authorization?: string): Promise<FileInfo[]>;
     /**
      * Returns compute environments from a provider.
      * @param {string} providerUri - The URI of the provider.
      * @param {AbortSignal} [signal] - An optional abort signal.
      * @returns {Promise<{[chainId: number]: ComputeEnvironment[]}>} A promise that resolves with an object containing compute environments for each chain ID.
      */
-    getComputeEnvironments(providerUri: string, signal?: AbortSignal): Promise<ComputeEnvironment[]>;
+    getComputeEnvironments(providerUri: string, signal?: AbortSignal, authorization?: string): Promise<ComputeEnvironment[]>;
     /**
      * Initializes the provider for a service request.
      * @param {string} did - The asset DID .
@@ -86,7 +86,7 @@ export declare class Provider {
      * @param {number} [validUntil] - The validity time if any.
      * @returns {Promise<ProviderInitialize>} A promise that resolves with ProviderInitialize response.
      */
-    initialize(did: string, serviceId: string, fileIndex: number, consumerAddress: string, providerUri: string, signal?: AbortSignal, userCustomParameters?: UserCustomParameters, computeEnv?: string, validUntil?: number): Promise<ProviderInitialize>;
+    initialize(did: string, serviceId: string, fileIndex: number, consumerAddress: string, providerUri: string, signal?: AbortSignal, userCustomParameters?: UserCustomParameters, computeEnv?: string, validUntil?: number, authorization?: string): Promise<ProviderInitialize>;
     /** Initializes the provider for a compute request.
      * @param {ComputeAsset[]} assets The datasets array to initialize compute request.
      * @param {ComputeAlgorithmber} algorithm The algorithm to use.
@@ -97,7 +97,7 @@ export declare class Provider {
      * @param {AbortSignal} signal abort signal
      * @return {Promise<ProviderComputeInitialize>} ProviderComputeInitialize data
      */
-    initializeComputeV1(assets: ComputeAsset[], algorithm: ComputeAlgorithm, computeEnv: string, providerUri: string, accountId: string, chainId: number, token: string, maxJobDuration: number, signal?: AbortSignal): Promise<ProviderComputeInitializeResults>;
+    initializeComputeV1(assets: ComputeAsset[], algorithm: ComputeAlgorithm, computeEnv: string, providerUri: string, accountId: string, chainId: number, token: string, maxJobDuration: number, signal?: AbortSignal, authorization?: string): Promise<ProviderComputeInitializeResults>;
     /** Initializes the provider for a compute request.
      * @param {ComputeAsset[]} assets The datasets array to initialize compute request.
      * @param {ComputeAlgorithmber} algorithm The algorithm to use.
@@ -109,7 +109,7 @@ export declare class Provider {
      * @param {AbortSignal} signal abort signal
      * @return {Promise<ProviderComputeInitialize>} ProviderComputeInitialize data
      */
-    initializeCompute(assets: ComputeAsset[], algorithm: ComputeAlgorithm, computeEnv: string, token: string, validUntil: number, providerUri: string, signer: Signer, resources: ComputeResourceRequest[], signal?: AbortSignal): Promise<ProviderComputeInitializeResults>;
+    initializeCompute(assets: ComputeAsset[], algorithm: ComputeAlgorithm, computeEnv: string, token: string, validUntil: number, providerUri: string, signer: Signer, resources: ComputeResourceRequest[], signal?: AbortSignal, authorization?: string): Promise<ProviderComputeInitializeResults>;
     /**
      * Gets the download URL.
      * @param {string} did - The DID.
@@ -122,7 +122,7 @@ export declare class Provider {
      * @param {UserCustomParameters} userCustomParameters - The user custom parameters.
      * @returns {Promise<any>} The download URL.
      */
-    getDownloadUrl(did: string, serviceId: string, fileIndex: number, transferTxId: string, providerUri: string, signer: Signer, policyServer?: any, userCustomParameters?: UserCustomParameters): Promise<any>;
+    getDownloadUrl(did: string, serviceId: string, fileIndex: number, transferTxId: string, providerUri: string, signer: Signer, policyServer?: any, userCustomParameters?: UserCustomParameters, authorization?: string): Promise<any>;
     /** Instruct the provider to start a compute job (Old C2D V1) Kept for now, for backwards compatibility
      * @param {string} providerUri The provider URI.
      * @param {Signer} signer The consumer signer object.
@@ -135,7 +135,7 @@ export declare class Provider {
      * @return {Promise<ComputeJob | ComputeJob[]>} The compute job or jobs.
      * @deprecated Use {@link computeStart} instead.
      */
-    computeStartV1(providerUri: string, consumer: Signer, computeEnv: string, dataset: ComputeAsset, algorithm: ComputeAlgorithm, signal?: AbortSignal, additionalDatasets?: ComputeAsset[], output?: ComputeOutput): Promise<ComputeJob | ComputeJob[]>;
+    computeStartV1(providerUri: string, consumer: Signer, computeEnv: string, dataset: ComputeAsset, algorithm: ComputeAlgorithm, signal?: AbortSignal, additionalDatasets?: ComputeAsset[], output?: ComputeOutput, authorization?: string): Promise<ComputeJob | ComputeJob[]>;
     /** Instruct the provider to start a PAYED compute job (new C2D V2)
      * @param {string} providerUri The provider URI.
      * @param {Signer} signer The consumer signer object.
@@ -151,7 +151,7 @@ export declare class Provider {
      * @return {Promise<ComputeJob | ComputeJob[]>} The compute job or jobs.
      */
     computeStart(providerUri: string, consumer: Signer, computeEnv: string, datasets: ComputeAsset[], algorithm: ComputeAlgorithm, maxJobDuration: number, token: string, resources: ComputeResourceRequest[], chainId?: number, // network used by payment (only for payed compute jobs)
-    output?: ComputeOutput, signal?: AbortSignal): Promise<ComputeJob | ComputeJob[]>;
+    output?: ComputeOutput, signal?: AbortSignal, authorization?: string): Promise<ComputeJob | ComputeJob[]>;
     /** Instruct the provider to start a FREE compute job (new C2D V2)
      * @param {string} providerUri The provider URI.
      * @param {Signer} signer The consumer signer object.
@@ -163,7 +163,7 @@ export declare class Provider {
      * @param {AbortSignal} signal abort signal
      * @return {Promise<ComputeJob | ComputeJob[]>} The compute job or jobs.
      */
-    freeComputeStart(providerUri: string, consumer: Signer, computeEnv: string, datasets: ComputeAsset[], algorithm: ComputeAlgorithm, resources?: ComputeResourceRequest[], output?: ComputeOutput, signal?: AbortSignal): Promise<ComputeJob | ComputeJob[]>;
+    freeComputeStart(providerUri: string, consumer: Signer, computeEnv: string, datasets: ComputeAsset[], algorithm: ComputeAlgorithm, resources?: ComputeResourceRequest[], output?: ComputeOutput, signal?: AbortSignal, authorization?: string): Promise<ComputeJob | ComputeJob[]>;
     /**
      *
      * @param providerUri provider URL
@@ -172,7 +172,7 @@ export declare class Provider {
      * @param signal abort signal
      * @returns logs response
      */
-    computeStreamableLogs(providerUri: string, signer: Signer, jobId: string, signal?: AbortSignal): Promise<any>;
+    computeStreamableLogs(providerUri: string, signer: Signer, jobId: string, signal?: AbortSignal, authorization?: string): Promise<any>;
     getComputeStartRoutes(providerUri: string, isFreeCompute?: boolean): Promise<string | null>;
     /** Instruct the provider to Stop the execution of a to stop a compute job.
      * @param {string} did the asset did
@@ -183,7 +183,7 @@ export declare class Provider {
      * @param {AbortSignal} signal abort signal
      * @return {Promise<ComputeJob | ComputeJob[]>}
      */
-    computeStop(did: string, consumerAddress: string, jobId: string, providerUri: string, signer: Signer, agreementId?: string, signal?: AbortSignal): Promise<ComputeJob | ComputeJob[]>;
+    computeStop(did: string, consumerAddress: string, jobId: string, providerUri: string, signer: Signer, agreementId?: string, signal?: AbortSignal, authorization?: string): Promise<ComputeJob | ComputeJob[]>;
     /** Get compute status for a specific jobId/documentId/owner.
      * @param {string} providerUri The URI of the provider we want to query
      * @param {string} consumerAddress The consumer ethereum address
@@ -192,7 +192,7 @@ export declare class Provider {
      * @param {AbortSignal} signal abort signal
      * @return {Promise<ComputeJob | ComputeJob[]>}
      */
-    computeStatus(providerUri: string, consumerAddress: string, jobId?: string, agreementId?: string, signal?: AbortSignal): Promise<ComputeJob | ComputeJob[]>;
+    computeStatus(providerUri: string, consumerAddress: string, jobId?: string, agreementId?: string, signal?: AbortSignal, authorization?: string): Promise<ComputeJob | ComputeJob[]>;
     /** Get compute result url
      * @param {string} providerUri The URI of the provider we want to query
      * @param {Signer} consumer consumer Signer wallet object
@@ -200,7 +200,7 @@ export declare class Provider {
      * @param {number} index Result index
      * @return {Promise<string>}
      */
-    getComputeResultUrl(providerUri: string, consumer: Signer, jobId: string, index: number): Promise<string>;
+    getComputeResultUrl(providerUri: string, consumer: Signer, jobId: string, index: number, authorization?: string): Promise<string>;
     /** Deletes a compute job.
      * @param {string} did asset did
      * @param {Signer} consumer consumer Signer wallet object
@@ -209,13 +209,30 @@ export declare class Provider {
      * @param {AbortSignal} signal abort signal
      * @return {Promise<ComputeJob | ComputeJob[]>}
      */
-    computeDelete(did: string, consumer: Signer, jobId: string, providerUri: string, signal?: AbortSignal): Promise<ComputeJob | ComputeJob[]>;
+    computeDelete(did: string, consumer: Signer, jobId: string, providerUri: string, signal?: AbortSignal, authorization?: string): Promise<ComputeJob | ComputeJob[]>;
+    /** Generates an auth token
+     * @param {Signer} consumer consumer Signer wallet object
+     * @param {string} providerUri The URI of the provider we want to query
+     * @param {AbortSignal} signal abort signal
+     * @return {Promise<ComputeJob | ComputeJob[]>}
+     */
+    generateAuthToken(consumer: Signer, providerUri: string, signal?: AbortSignal): Promise<string>;
+    /** Generates an auth token
+     * @param {Signer} consumer consumer Signer wallet object
+     * @param {string} token The auth token to invalidate
+     * @param {string} providerUri The URI of the provider we want to query
+     * @param {AbortSignal} signal abort signal
+     * @return {Promise<ComputeJob | ComputeJob[]>}
+     */
+    invalidateAuthToken(consumer: Signer, token: string, providerUri: string, signal?: AbortSignal): Promise<{
+        success: boolean;
+    }>;
     /** Check for a valid provider at URL
      * @param {String} url provider uri address
      * @param {AbortSignal} signal abort signal
      * @return {Promise<boolean>} valid or not
      */
-    isValidProvider(url: string, signal?: AbortSignal): Promise<boolean>;
+    isValidProvider(url: string, signal?: AbortSignal, authorization?: string): Promise<boolean>;
     /**
      * Private method that removes the leading 0x from a string.
      * @param {string} input - The input string.

package/dist/types/utils/Addresses.d.ts

@@ -20,4 +20,4 @@ export declare function getOceanArtifactsAddressesByChainId(chain: number): any;
  * @returns index of the template on the list
  */
 export declare function calculateActiveTemplateIndex(owner: Signer, nftContractAddress: string, // addresses.ERC721Factory,
-template: string | number, chainID: number): Promise<number>;
+template: string | number, chainID?: number): Promise<number>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oceanprotocol/lib",
   "source": "./src/index.ts",
-  "version": "4.1.4",
+  "version": "4.2.0",
   "description": "JavaScript client library for Ocean Protocol",
   "main": "./dist/lib.cjs",
   "umd:main": "dist/lib.umd.js",
@@ -86,7 +86,7 @@
     "cross-env": "^7.0.3",
     "eslint": "^8.23.1",
     "eslint-config-oceanprotocol": "^2.0.3",
-    "eslint-config-prettier": "^9.0.0",
+    "eslint-config-prettier": "^10.1.5",
     "eslint-plugin-prettier": "^4.2.1",
     "fs": "0.0.1-security",
     "microbundle": "0.14.2",