@oceanprotocol/lib 3.0.3 → 3.1.0

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

@@ -1,55 +1,55 @@
-import { Service, Metadata, Credentials, Event } from '..';
-/**
- * DID Descriptor Object.
- * Contains metadata about the asset, and define access in at least one service.
- */
-export interface DDO {
-    /**
-     * Contexts used for validation.
-     * @type {string[]}
-     */
-    '@context': string[];
-    /**
-     * DID, descentralized ID.
-     * Computed as sha256(address of NFT contract + chainId)
-     * @type {string}
-     */
-    id: string;
-    /**
-     * Version information in SemVer notation
-     * referring to the DDO spec version
-     * @type {string}
-     */
-    version: string;
-    /**
-     * NFT contract address
-     * @type {string}
-     */
-    nftAddress: string;
-    /**
-     * ChainId of the network the DDO was published to.
-     * @type {number}
-     */
-    chainId: number;
-    /**
-     * Stores an object describing the asset.
-     * @type {Metadata}
-     */
-    metadata: Metadata;
-    /**
-     * Stores an array of services defining access to the asset.
-     * @type {Service[]}
-     */
-    services: Service[];
-    /**
-     * Describes the credentials needed to access a dataset
-     * in addition to the services definition.
-     * @type {Credentials}
-     */
-    credentials?: Credentials;
-    /**
-     * Describes the event of last metadata event
-     * @type {Event}
-     */
-    event?: Event;
-}
+import { Service, Metadata, Credentials, Event } from '..';
+/**
+ * DID Descriptor Object.
+ * Contains metadata about the asset, and define access in at least one service.
+ */
+export interface DDO {
+    /**
+     * Contexts used for validation.
+     * @type {string[]}
+     */
+    '@context': string[];
+    /**
+     * DID, descentralized ID.
+     * Computed as sha256(address of NFT contract + chainId)
+     * @type {string}
+     */
+    id: string;
+    /**
+     * Version information in SemVer notation
+     * referring to the DDO spec version
+     * @type {string}
+     */
+    version: string;
+    /**
+     * NFT contract address
+     * @type {string}
+     */
+    nftAddress: string;
+    /**
+     * ChainId of the network the DDO was published to.
+     * @type {number}
+     */
+    chainId: number;
+    /**
+     * Stores an object describing the asset.
+     * @type {Metadata}
+     */
+    metadata: Metadata;
+    /**
+     * Stores an array of services defining access to the asset.
+     * @type {Service[]}
+     */
+    services: Service[];
+    /**
+     * Describes the credentials needed to access a dataset
+     * in addition to the services definition.
+     * @type {Credentials}
+     */
+    credentials?: Credentials;
+    /**
+     * Describes the event of last metadata event
+     * @type {Event}
+     */
+    event?: Event;
+}

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

@@ -1,27 +1,27 @@
-export interface Event {
-    /**
-     * TX id of the last create/update
-     * @type {string}
-     */
-    txid?: string;
-    /**
-     * Block of txid
-     * @type {number}
-     */
-    block?: number;
-    /**
-     * Sender of tx
-     * @type {String}
-     */
-    from?: string;
-    /**
-     * Contract
-     * @type {String}
-     */
-    contract?: string;
-    /**
-     * datetime of tx
-     * @type {String}
-     */
-    datetime?: string;
-}
+export interface Event {
+    /**
+     * TX id of the last create/update
+     * @type {string}
+     */
+    txid?: string;
+    /**
+     * Block of txid
+     * @type {number}
+     */
+    block?: number;
+    /**
+     * Sender of tx
+     * @type {String}
+     */
+    from?: string;
+    /**
+     * Contract
+     * @type {String}
+     */
+    contract?: string;
+    /**
+     * datetime of tx
+     * @type {String}
+     */
+    datetime?: string;
+}

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

@@ -1,141 +1,141 @@
-import { ConsumerParameter } from './ConsumerParameter';
-export interface MetadataAlgorithm {
-    /**
-     * Programming language used to implement the software.
-     * @type {string}
-     */
-    language?: string;
-    /**
-     * Version of the software preferably in SemVer notation.
-     * @type {string}
-     */
-    version?: string;
-    /**
-     * Rawcode
-     * @type {string}
-     */
-    rawcode?: string;
-    /**
-     * Object describing the Docker container image.
-     * @type {Object}
-     */
-    container: {
-        /**
-         * The command to execute, or script to run inside the Docker image.
-         * @type {string}
-         */
-        entrypoint: string;
-        /**
-         * Name of the Docker image.
-         * @type {string}
-         */
-        image: string;
-        /**
-         * Tag of the Docker image.
-         * @type {string}
-         */
-        tag: string;
-        /**
-         * Checksum of the Docker image.
-         * @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 {
-    /**
-     * Contains the date of publishing in ISO Date Time
-     * @type {string}
-     */
-    created: string;
-    /**
-     * Contains the the date of last update in ISO Date Time
-     * @type {string}
-     */
-    updated: string;
-    /**
-     * Descriptive name or title of the asset.
-     * @type {string}
-     */
-    name: string;
-    /**
-     * Details of what the resource is.
-     * @type {string}
-     */
-    description: string;
-    /**
-     * Asset type. Includes "dataset" (e.g. csv file), "algorithm" (e.g. Python script).
-     * Each type needs a different subset of metadata attributes.
-     * @type {'dataset' | 'algorithm'}
-     */
-    type: 'dataset' | 'algorithm';
-    /**
-     * Name of the entity generating this data (e.g. Tfl, Disney Corp, etc.).
-     * @type {string}
-     */
-    author: string;
-    /**
-     * Short name referencing the license of the asset.
-     * If it’s not specified, the following value will be added: “No License Specified”.
-     * @type {string}
-     */
-    license: string;
-    /**
-     * Mapping of URL strings for data samples, or links to find out more information.
-     * Links may be to either a URL or another asset.
-     * @type {string[]}
-     */
-    links?: string[];
-    /**
-     * Array of keywords or tags used to describe this content. Empty by default.
-     * @type {string[]}
-     */
-    tags?: string[];
-    /**
-     * Array of categories associated to the asset. Note: recommended to use tags instead of this.
-     * @type {string[]}
-     */
-    categories?: string[];
-    /**
-     * The party holding the legal copyright. Empty by default.
-     * @type {string}
-     */
-    copyrightHolder?: string;
-    /**
-     *The language of the content. Use one of the language codes from the IETF BCP 47 standard
-     * @type {string}
-     */
-    contentLanguage?: string;
-    /**
-     * Information about asset of type algorithm. Required for algorithm assets.
-     * @type {MetadataAlgorithm}
-     */
-    algorithm?: MetadataAlgorithm;
-    /**
-     * Stores additional information, this is customizable by publisher
-     * @type {any}
-     */
-    additionalInformation?: any;
-}
-export interface MetadataProof {
-    validatorAddress?: string;
-    r?: string;
-    s?: string;
-    v?: number;
-}
-export interface ValidateMetadata {
-    valid: Boolean;
-    errors?: Object;
-    hash?: string;
-    proof?: MetadataProof;
-}
+import { ConsumerParameter } from './ConsumerParameter';
+export interface MetadataAlgorithm {
+    /**
+     * Programming language used to implement the software.
+     * @type {string}
+     */
+    language?: string;
+    /**
+     * Version of the software preferably in SemVer notation.
+     * @type {string}
+     */
+    version?: string;
+    /**
+     * Rawcode
+     * @type {string}
+     */
+    rawcode?: string;
+    /**
+     * Object describing the Docker container image.
+     * @type {Object}
+     */
+    container: {
+        /**
+         * The command to execute, or script to run inside the Docker image.
+         * @type {string}
+         */
+        entrypoint: string;
+        /**
+         * Name of the Docker image.
+         * @type {string}
+         */
+        image: string;
+        /**
+         * Tag of the Docker image.
+         * @type {string}
+         */
+        tag: string;
+        /**
+         * Checksum of the Docker image.
+         * @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 {
+    /**
+     * Contains the date of publishing in ISO Date Time
+     * @type {string}
+     */
+    created: string;
+    /**
+     * Contains the the date of last update in ISO Date Time
+     * @type {string}
+     */
+    updated: string;
+    /**
+     * Descriptive name or title of the asset.
+     * @type {string}
+     */
+    name: string;
+    /**
+     * Details of what the resource is.
+     * @type {string}
+     */
+    description: string;
+    /**
+     * Asset type. Includes "dataset" (e.g. csv file), "algorithm" (e.g. Python script).
+     * Each type needs a different subset of metadata attributes.
+     * @type {'dataset' | 'algorithm'}
+     */
+    type: 'dataset' | 'algorithm';
+    /**
+     * Name of the entity generating this data (e.g. Tfl, Disney Corp, etc.).
+     * @type {string}
+     */
+    author: string;
+    /**
+     * Short name referencing the license of the asset.
+     * If it’s not specified, the following value will be added: “No License Specified”.
+     * @type {string}
+     */
+    license: string;
+    /**
+     * Mapping of URL strings for data samples, or links to find out more information.
+     * Links may be to either a URL or another asset.
+     * @type {string[]}
+     */
+    links?: string[];
+    /**
+     * Array of keywords or tags used to describe this content. Empty by default.
+     * @type {string[]}
+     */
+    tags?: string[];
+    /**
+     * Array of categories associated to the asset. Note: recommended to use tags instead of this.
+     * @type {string[]}
+     */
+    categories?: string[];
+    /**
+     * The party holding the legal copyright. Empty by default.
+     * @type {string}
+     */
+    copyrightHolder?: string;
+    /**
+     *The language of the content. Use one of the language codes from the IETF BCP 47 standard
+     * @type {string}
+     */
+    contentLanguage?: string;
+    /**
+     * Information about asset of type algorithm. Required for algorithm assets.
+     * @type {MetadataAlgorithm}
+     */
+    algorithm?: MetadataAlgorithm;
+    /**
+     * Stores additional information, this is customizable by publisher
+     * @type {any}
+     */
+    additionalInformation?: any;
+}
+export interface MetadataProof {
+    validatorAddress?: string;
+    r?: string;
+    s?: string;
+    v?: number;
+}
+export interface ValidateMetadata {
+    valid: Boolean;
+    errors?: Object;
+    hash?: string;
+    proof?: MetadataProof;
+}

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

@@ -1,100 +1,100 @@
-import { ConsumerParameter } from './ConsumerParameter';
-export interface PublisherTrustedAlgorithm {
-    /**
-     * The DID of the algorithm which is trusted by the publisher.
-     * @type {string}
-     */
-    did: string;
-    /**
-     * Hash of algorithm’s files section.
-     * @type {string}
-     */
-    filesChecksum: string;
-    /**
-     * Hash of algorithm’s metadata.algorithm.container section.
-     * @type {string}
-     */
-    containerSectionChecksum: string;
-}
-export interface ServiceComputeOptions {
-    /**
-     * If true, any passed raw text will be allowed to run.
-     * Useful for an algorithm drag & drop use case, but increases risk of data escape through malicious user input.
-     * Should be false by default in all implementations.
-     * @type {boolean}
-     */
-    allowRawAlgorithm: boolean;
-    /**
-     * If true, the algorithm job will have network access.
-     * @type {boolean}
-     */
-    allowNetworkAccess: boolean;
-    /**
-     * If empty, then any published algorithm is allowed.
-     * Otherwise, only published algorithms by some publishers are allowed
-     * @type {string[]}
-     */
-    publisherTrustedAlgorithmPublishers: string[];
-    /**
-     * If empty, then any published algorithm is allowed. (see below)
-     * @type {PublisherTrustedAlgorithm[]}
-     */
-    publisherTrustedAlgorithms: PublisherTrustedAlgorithm[];
-}
-export interface Service {
-    /**
-     * Unique ID
-     * @type {string}
-     */
-    id: string;
-    /**
-     * Type of service (access, compute, wss.
-     * @type {string}
-     */
-    type: 'access' | 'compute' | string;
-    /**
-     * Encrypted file URLs.
-     * @type {string}
-     */
-    files: string;
-    /**
-     * Datatoken address
-     * @type {string}
-     */
-    datatokenAddress: string;
-    /**
-     * Provider URL (schema + host).
-     * @type {string}
-     */
-    serviceEndpoint: string;
-    /**
-     * Describing how long the service can be used after consumption is initiated.
-     * @type {number}
-     */
-    timeout: number;
-    /**
-     * Service friendly name
-     * @type {string}
-     */
-    name?: string;
-    /**
-     * Service description
-     * @type {string}
-     */
-    description?: string;
-    /**
-     * If service is of type compute, holds information about the compute-related privacy settings & resources.
-     * @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}
-     */
-    additionalInformation?: any;
-}
+import { ConsumerParameter } from './ConsumerParameter';
+export interface PublisherTrustedAlgorithm {
+    /**
+     * The DID of the algorithm which is trusted by the publisher.
+     * @type {string}
+     */
+    did: string;
+    /**
+     * Hash of algorithm’s files section.
+     * @type {string}
+     */
+    filesChecksum: string;
+    /**
+     * Hash of algorithm’s metadata.algorithm.container section.
+     * @type {string}
+     */
+    containerSectionChecksum: string;
+}
+export interface ServiceComputeOptions {
+    /**
+     * If true, any passed raw text will be allowed to run.
+     * Useful for an algorithm drag & drop use case, but increases risk of data escape through malicious user input.
+     * Should be false by default in all implementations.
+     * @type {boolean}
+     */
+    allowRawAlgorithm: boolean;
+    /**
+     * If true, the algorithm job will have network access.
+     * @type {boolean}
+     */
+    allowNetworkAccess: boolean;
+    /**
+     * If empty, then any published algorithm is allowed.
+     * Otherwise, only published algorithms by some publishers are allowed
+     * @type {string[]}
+     */
+    publisherTrustedAlgorithmPublishers: string[];
+    /**
+     * If empty, then any published algorithm is allowed. (see below)
+     * @type {PublisherTrustedAlgorithm[]}
+     */
+    publisherTrustedAlgorithms: PublisherTrustedAlgorithm[];
+}
+export interface Service {
+    /**
+     * Unique ID
+     * @type {string}
+     */
+    id: string;
+    /**
+     * Type of service (access, compute, wss.
+     * @type {string}
+     */
+    type: 'access' | 'compute' | string;
+    /**
+     * Encrypted file URLs.
+     * @type {string}
+     */
+    files: string;
+    /**
+     * Datatoken address
+     * @type {string}
+     */
+    datatokenAddress: string;
+    /**
+     * Provider URL (schema + host).
+     * @type {string}
+     */
+    serviceEndpoint: string;
+    /**
+     * Describing how long the service can be used after consumption is initiated.
+     * @type {number}
+     */
+    timeout: number;
+    /**
+     * Service friendly name
+     * @type {string}
+     */
+    name?: string;
+    /**
+     * Service description
+     * @type {string}
+     */
+    description?: string;
+    /**
+     * If service is of type compute, holds information about the compute-related privacy settings & resources.
+     * @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}
+     */
+    additionalInformation?: any;
+}