@oceanprotocol/lib 4.2.1 → 4.3.0

package/dist/types/@types/Compute.d.ts

@@ -56,6 +56,9 @@ export interface ComputeResult {
     type: ComputeResultType;
     index?: number;
 }
+export type ComputeJobMetadata = {
+    [key: string]: string | number | boolean;
+};
 export interface ComputeJob {
     owner: string;
     did?: string;
@@ -69,6 +72,7 @@ export interface ComputeJob {
     algoDID?: string;
     agreementId?: string;
     expireTimestamp: number;
+    metadata?: ComputeJobMetadata;
 }
 export interface ComputeOutput {
     publishAlgorithmLog?: boolean;

package/dist/types/@types/PolicyServer.d.ts

@@ -0,0 +1,7 @@
+export interface PolicyServer {
+    sessionId?: string;
+    successRedirectUri?: string;
+    errorRedirectUri?: string;
+    responseRedirectUri?: string;
+    presentationDefinitionUri?: string;
+}

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

@@ -1,5 +1,6 @@
 import { Signer } from 'ethers';
-import { Arweave, FileInfo, ComputeJob, ComputeOutput, ComputeAlgorithm, ComputeAsset, ComputeEnvironment, ProviderInitialize, ProviderComputeInitializeResults, ServiceEndpoint, UrlFile, UserCustomParameters, Ipfs, ComputeResourceRequest } from '../@types';
+import { Arweave, FileInfo, ComputeJob, ComputeOutput, ComputeAlgorithm, ComputeAsset, ComputeEnvironment, ProviderInitialize, ProviderComputeInitializeResults, ServiceEndpoint, UrlFile, UserCustomParameters, Ipfs, ComputeResourceRequest, ComputeJobMetadata } from '../@types';
+import { PolicyServer } from '../@types/PolicyServer.js';
 export declare class Provider {
     private getConsumerAddress;
     private getSignature;
@@ -111,10 +112,11 @@ export declare class Provider {
      * @param {SignerOrAuthToken} signerOrAuthToken Signer or auth token
      * @param {ComputeResourceRequest[]} resources The resources to start compute job with.
      * @param {number} chainId The chain used to do payments
+     * @param {PolicyServer} policyServer The policy server object.
      * @param {AbortSignal} signal abort signal
      * @return {Promise<ProviderComputeInitialize>} ProviderComputeInitialize data
      */
-    initializeCompute(assets: ComputeAsset[], algorithm: ComputeAlgorithm, computeEnv: string, token: string, validUntil: number, providerUri: string, signerOrAuthToken: Signer | string, resources: ComputeResourceRequest[], chainId: number, signal?: AbortSignal): Promise<ProviderComputeInitializeResults>;
+    initializeCompute(assets: ComputeAsset[], algorithm: ComputeAlgorithm, computeEnv: string, token: string, validUntil: number, providerUri: string, signerOrAuthToken: Signer | string, resources: ComputeResourceRequest[], chainId: number, policyServer?: PolicyServer, signal?: AbortSignal): Promise<ProviderComputeInitializeResults>;
     /**
      * Gets the download URL.
      * @param {string} did - The DID.
@@ -123,11 +125,11 @@ export declare class Provider {
      * @param {string} transferTxId - The transfer transaction ID.
      * @param {string} providerUri - The provider URI.
      * @param {SignerOrAuthToken} signerOrAuthToken - The signer or auth token.
-     * @param {any} policyServer - The policy server (if any is to be used).
+     * @param {PolicyServer} policyServer - The policy server (if any is to be used).
      * @param {UserCustomParameters} userCustomParameters - The user custom parameters.
      * @returns {Promise<any>} The download URL.
      */
-    getDownloadUrl(did: string, serviceId: string, fileIndex: number, transferTxId: string, providerUri: string, signerOrAuthToken: Signer | string, policyServer?: any, userCustomParameters?: UserCustomParameters): Promise<any>;
+    getDownloadUrl(did: string, serviceId: string, fileIndex: number, transferTxId: string, providerUri: string, signerOrAuthToken: Signer | string, policyServer?: PolicyServer, userCustomParameters?: UserCustomParameters): 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.
@@ -151,12 +153,14 @@ export declare class Provider {
      * @param {string} token The token address for compute payment.
      * @param {ComputeResourceRequest} resources The resources to start compute job with.
      * @param {chainId} chainId The chain used to do payments
+     * @param {ComputeJobMetadata} metadata The compute job metadata. Additional metadata to be stored in the database.
      * @param {ComputeOutput} output The compute job output settings.
+     * @param {PolicyServer} policyServer The policy server object.
      * @param {AbortSignal} signal abort signal
      * @return {Promise<ComputeJob | ComputeJob[]>} The compute job or jobs.
      */
     computeStart(providerUri: string, signerOrAuthToken: Signer | string, 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[]>;
+    metadata?: ComputeJobMetadata, output?: ComputeOutput, policyServer?: PolicyServer, signal?: AbortSignal): Promise<ComputeJob | ComputeJob[]>;
     /** Instruct the provider to start a FREE compute job (new C2D V2)
      * @param {string} providerUri The provider URI.
      * @param {SignerOrAuthToken} signerOrAuthToken The consumer signer object or auth token.
@@ -164,11 +168,13 @@ export declare class Provider {
      * @param {ComputeAsset} datasets The dataset to start compute on + additionalDatasets (the additional datasets if that is the case)
      * @param {ComputeAlgorithm} algorithm The algorithm to start compute with.
      * @param {ComputeResourceRequest} resources The resources to start compute job with.
+     * @param {ComputeJobMetadata} metadata The compute job metadata. Additional metadata to be stored in the database.
      * @param {ComputeOutput} output The compute job output settings.
+     * @param {PolicyServer} policyServer The policy server object.
      * @param {AbortSignal} signal abort signal
      * @return {Promise<ComputeJob | ComputeJob[]>} The compute job or jobs.
      */
-    freeComputeStart(providerUri: string, signerOrAuthToken: Signer | string, computeEnv: string, datasets: ComputeAsset[], algorithm: ComputeAlgorithm, resources?: ComputeResourceRequest[], output?: ComputeOutput, signal?: AbortSignal): Promise<ComputeJob | ComputeJob[]>;
+    freeComputeStart(providerUri: string, signerOrAuthToken: Signer | string, computeEnv: string, datasets: ComputeAsset[], algorithm: ComputeAlgorithm, resources?: ComputeResourceRequest[], metadata?: ComputeJobMetadata, output?: ComputeOutput, policyServer?: PolicyServer, signal?: AbortSignal): Promise<ComputeJob | ComputeJob[]>;
     /**
      *
      * @param providerUri provider URL

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oceanprotocol/lib",
   "source": "./src/index.ts",
-  "version": "4.2.1",
+  "version": "4.3.0",
   "description": "JavaScript client library for Ocean Protocol",
   "main": "./dist/lib.cjs",
   "umd:main": "dist/lib.umd.js",
@@ -58,7 +58,7 @@
   "dependencies": {
     "@oasisprotocol/sapphire-paratime": "^1.3.2",
     "@oceanprotocol/contracts": "^2.3.0",
-    "@oceanprotocol/ddo-js": "^0.1.0",
+    "@oceanprotocol/ddo-js": "^0.1.2",
     "@rdfjs/dataset": "^2.0.2",
     "@rdfjs/formats-common": "^3.1.0",
     "@zazuko/env-node": "^2.1.4",