@oceanprotocol/lib 3.0.0-next.4 → 3.0.0-next.5

package/dist/src/@types/DDO/ConsumerParameter.d.ts

@@ -0,0 +1,37 @@
+export interface ConsumerParameter {
+    /**
+     * Parameter name.
+     * @type {string}
+     */
+    name: string;
+    /**
+     * Field type.
+     * @type {'text' | 'number' | 'boolean' | 'select'}
+     */
+    type: 'text' | 'number' | 'boolean' | 'select';
+    /**
+     * Displayed field label.
+     * @type {string}
+     */
+    label: string;
+    /**
+     * Defines if customer input for this field is mandatory.
+     * @type {boolean}
+     */
+    required: boolean;
+    /**
+     * Field description.
+     * @type {string}
+     */
+    description: string;
+    /**
+     * Field default value. For select types, string key of default option.
+     * @type {string}
+     */
+    default: string;
+    /**
+     * For select types, a list of options.
+     * @type {string}
+     */
+    options?: string;
+}

package/dist/src/@types/DDO/Metadata.d.ts

@@ -1,3 +1,4 @@
+import { ConsumerParameter } from './ConsumerParameter';
 export interface MetadataAlgorithm {
     /**
      * Programming language used to implement the software.
@@ -39,7 +40,17 @@ export interface MetadataAlgorithm {
          * @type {string}
          */
         checksum: string;
+        /**
+         * Array of objects describing the consumer parameters
+         * @type {ConsumerParameter[]}
+         */
+        consumerParameters?: ConsumerParameter[];
     };
+    /**
+     * Array of objects describing the consumer parameters
+     * @type {ConsumerParameter[]}
+     */
+    consumerParameters?: ConsumerParameter[];
 }
 export interface Metadata {
     /**

package/dist/src/@types/DDO/Service.d.ts

@@ -1,3 +1,4 @@
+import { ConsumerParameter } from './ConsumerParameter';
 export interface PublisherTrustedAlgorithm {
     /**
      * The DID of the algorithm which is trusted by the publisher.
@@ -86,6 +87,11 @@ export interface Service {
      * @type {ServiceComputeOptions}
      */
     compute?: ServiceComputeOptions;
+    /**
+     * Array of objects describing the consumer parameters
+     * @type {ConsumerParameter[]}
+     */
+    consumerParameters?: ConsumerParameter[];
     /**
      * Stores service specific additional information, this is customizable by publisher
      * @type {any}

package/dist/src/@types/index.d.ts

@@ -2,6 +2,7 @@ export * from './DDO/Credentials';
 export * from './DDO/DDO';
 export * from './DDO/Event';
 export * from './DDO/Metadata';
+export * from './DDO/ConsumerParameter';
 export * from './DDO/Service';
 export * from './Asset';
 export * from './Contracts';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oceanprotocol/lib",
   "source": "./src/index.ts",
-  "version": "3.0.0-next.4",
+  "version": "3.0.0-next.5",
   "description": "JavaScript client library for Ocean Protocol",
   "main": "./dist/lib.js",
   "umd:main": "dist/lib.umd.js",