@twin.org/federated-catalogue-service 0.0.1-next.3

package/docs/overview.md

@@ -0,0 +1,21 @@
+# Federated Catalogue Service
+
+Federated Catalogue contract implementation and REST endpoint definitions.
+
+## Installation
+
+```shell
+npm install @twin.org/federated-catalogue-service
+```
+
+## Examples
+
+Usage of the APIs is shown in the examples [examples.md](examples.md)
+
+## Reference
+
+Detailed reference documentation for the API can be found in [reference/globals.md](reference/globals.md)
+
+## Changelog
+
+The changes between each version can be found in [changelog.md](changelog.md)

package/docs/reference/classes/DataResourceEntry.md

@@ -0,0 +1,118 @@
+# Class: DataResourceEntry
+
+Data Resource Entry.
+
+## Constructors
+
+### Constructor
+
+> **new DataResourceEntry**(): `DataResourceEntry`
+
+#### Returns
+
+`DataResourceEntry`
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+The Id.
+
+***
+
+### issuer
+
+> **issuer**: `string`
+
+The trusted issuer of the compliance credential
+
+***
+
+### name
+
+> **name**: `string`
+
+The name.
+
+***
+
+### description?
+
+> `optional` **description**: `string`
+
+The description.
+
+***
+
+### producedBy
+
+> **producedBy**: `string`
+
+The Id of the producer of the data described by this Data Resource.
+
+***
+
+### copyrightOwnedBy
+
+> **copyrightOwnedBy**: `string`
+
+The copyright owner
+
+***
+
+### license
+
+> **license**: `string`
+
+The license
+
+***
+
+### exposedThrough
+
+> **exposedThrough**: `string`
+
+The data exchange component used to expose the Data Resource.
+Only a URL pointing to the resource is stored
+
+***
+
+### resourcePolicy
+
+> **resourcePolicy**: `IOdrlPolicy`[]
+
+The Data Resource policy
+
+***
+
+### validFrom
+
+> **validFrom**: `string`
+
+Valid from
+
+***
+
+### validUntil
+
+> **validUntil**: `string`
+
+Valid to
+
+***
+
+### dateCreated
+
+> **dateCreated**: `string`
+
+Date created
+
+***
+
+### evidence
+
+> **evidence**: `string`[]
+
+Evidences

package/docs/reference/classes/DataSpaceConnectorEntry.md

@@ -0,0 +1,133 @@
+# Class: DataSpaceConnectorEntry
+
+Data Space Connector Entry.
+
+## Constructors
+
+### Constructor
+
+> **new DataSpaceConnectorEntry**(): `DataSpaceConnectorEntry`
+
+#### Returns
+
+`DataSpaceConnectorEntry`
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+The Id.
+
+***
+
+### issuer
+
+> **issuer**: `string`
+
+The trusted issuer of the compliance credential.
+
+***
+
+### name?
+
+> `optional` **name**: `string`
+
+The name.
+
+***
+
+### description?
+
+> `optional` **description**: `string`
+
+The description.
+
+***
+
+### identity
+
+> **identity**: `string`
+
+The identity of the Data Space Connector
+
+***
+
+### maintainer
+
+> **maintainer**: `string`
+
+Who maintains the Data Space Connector
+
+***
+
+### defaultEndpoint
+
+> **defaultEndpoint**: `IEndpoint`
+
+The default endpoint
+
+***
+
+### pushActivityEndpoint
+
+> **pushActivityEndpoint**: `IEndpoint`
+
+The activity push endpoint
+
+***
+
+### subscriptionActivityEndpoint?
+
+> `optional` **subscriptionActivityEndpoint**: `IEndpoint`
+
+The activity subscribe endpoint
+
+***
+
+### pullDataEndpoint
+
+> **pullDataEndpoint**: `IEndpoint`
+
+The pull data endpoint
+
+***
+
+### offeredResource
+
+> **offeredResource**: `string`[]
+
+The pull data endpoint
+
+***
+
+### validFrom
+
+> **validFrom**: `string`
+
+Valid from
+
+***
+
+### validUntil
+
+> **validUntil**: `string`
+
+Valid to
+
+***
+
+### dateCreated
+
+> **dateCreated**: `string`
+
+Date created
+
+***
+
+### evidence
+
+> **evidence**: `string`[]
+
+Evidences

package/docs/reference/classes/FederatedCatalogueService.md

@@ -0,0 +1,381 @@
+# Class: FederatedCatalogueService
+
+Service for performing logging operations to a connector.
+
+## Implements
+
+- `IFederatedCatalogue`
+
+## Constructors
+
+### Constructor
+
+> **new FederatedCatalogueService**(`options`): `FederatedCatalogueService`
+
+Create a new instance of FederatedCatalogue service.
+
+#### Parameters
+
+##### options
+
+[`IFederatedCatalogueConstructorOptions`](../interfaces/IFederatedCatalogueConstructorOptions.md)
+
+The options for the connector.
+
+#### Returns
+
+`FederatedCatalogueService`
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+#### Implementation of
+
+`IFederatedCatalogue.CLASS_NAME`
+
+## Methods
+
+### registerComplianceCredential()
+
+> **registerComplianceCredential**(`credentialJwt`): `Promise`\<`string`\>
+
+Registers a Participant's compliance Credential.
+
+#### Parameters
+
+##### credentialJwt
+
+`string`
+
+The credential (wrapped into a presentation) as JWT.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The Id of the Participant (DID usually).
+
+#### Implementation of
+
+`IFederatedCatalogue.registerComplianceCredential`
+
+***
+
+### queryParticipants()
+
+> **queryParticipants**(`id?`, `legalRegistrationNumber?`, `lrnType?`, `cursor?`, `pageSize?`): `Promise`\<`IParticipantList`\>
+
+Query the federated catalogue.
+
+#### Parameters
+
+##### id?
+
+`string`
+
+The identity of the participant.
+
+##### legalRegistrationNumber?
+
+`string`
+
+The legal registration number.
+
+##### lrnType?
+
+`string`
+
+The legal registration number type (EORI, VATID, GLEIF, KENYA_PIN, etc.)
+
+##### cursor?
+
+`string`
+
+The cursor to request the next page of entities.
+
+##### pageSize?
+
+`number`
+
+The maximum number of entities in a page.
+
+#### Returns
+
+`Promise`\<`IParticipantList`\>
+
+All the entities for the storage matching the conditions,
+and a cursor which can be used to request more entities.
+
+#### Throws
+
+NotImplementedError if the implementation does not support retrieval.
+
+#### Implementation of
+
+`IFederatedCatalogue.queryParticipants`
+
+***
+
+### getEntry()
+
+> **getEntry**(`entryType`, `entryId`): `Promise`\<`ICatalogueEntry`\>
+
+Returns a Federated Catalogue entry.
+
+#### Parameters
+
+##### entryType
+
+`FederatedCatalogueEntryType`
+
+The type of entry.
+
+##### entryId
+
+`string`
+
+The entry's id.
+
+#### Returns
+
+`Promise`\<`ICatalogueEntry`\>
+
+Catalogue Entry
+
+#### Throws
+
+NotFoundError if not found.
+
+#### Implementation of
+
+`IFederatedCatalogue.getEntry`
+
+***
+
+### registerDataSpaceConnectorCredential()
+
+> **registerDataSpaceConnectorCredential**(`credentialJwt`): `Promise`\<`string`\>
+
+Registers a compliance Credential concerning a Data Space Connector.
+
+#### Parameters
+
+##### credentialJwt
+
+`string`
+
+The credential (wrapped into a presentation) as JWT.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The identifier of the Data Space Connector registered.
+
+#### Implementation of
+
+`IFederatedCatalogue.registerDataSpaceConnectorCredential`
+
+***
+
+### registerDataResourceCredential()
+
+> **registerDataResourceCredential**(`credentialJwt`): `Promise`\<`string`[]\>
+
+Registers a data resource Credential concerning a Data Space Connector.
+
+#### Parameters
+
+##### credentialJwt
+
+`string`
+
+The credential (wrapped into a presentation) as JWT.
+
+#### Returns
+
+`Promise`\<`string`[]\>
+
+The list of Data Resources created.
+
+#### Implementation of
+
+`IFederatedCatalogue.registerDataResourceCredential`
+
+***
+
+### queryDataSpaceConnectors()
+
+> **queryDataSpaceConnectors**(`id?`, `maintainer?`, `cursor?`, `pageSize?`): `Promise`\<`IDataSpaceConnectorList`\>
+
+Query the federated catalogue.
+
+#### Parameters
+
+##### id?
+
+`string`
+
+The identity of the participant.
+
+##### maintainer?
+
+`string`
+
+The DS Connector maintainer.
+
+##### cursor?
+
+`string`
+
+The cursor to request the next page of entities.
+
+##### pageSize?
+
+`number`
+
+The maximum number of entities in a page.
+
+#### Returns
+
+`Promise`\<`IDataSpaceConnectorList`\>
+
+All the entities for the storage matching the conditions,
+and a cursor which can be used to request more entities.
+
+#### Throws
+
+NotImplementedError if the implementation does not support retrieval.
+
+#### Implementation of
+
+`IFederatedCatalogue.queryDataSpaceConnectors`
+
+***
+
+### registerServiceOfferingCredential()
+
+> **registerServiceOfferingCredential**(`credentialJwt`): `Promise`\<`string`[]\>
+
+Registers a Service Offering Credential.
+
+#### Parameters
+
+##### credentialJwt
+
+`string`
+
+The credential (wrapped into a presentation) as JWT.
+
+#### Returns
+
+`Promise`\<`string`[]\>
+
+Nothing.
+
+#### Implementation of
+
+`IFederatedCatalogue.registerServiceOfferingCredential`
+
+***
+
+### queryServiceOfferings()
+
+> **queryServiceOfferings**(`id?`, `providedBy?`, `cursor?`, `pageSize?`): `Promise`\<`IServiceOfferingList`\>
+
+Query the federated catalogue.
+
+#### Parameters
+
+##### id?
+
+`string`
+
+Service Id.
+
+##### providedBy?
+
+`string`
+
+The identity of the participant.
+
+##### cursor?
+
+`string`
+
+The cursor to request the next page of entities.
+
+##### pageSize?
+
+`number`
+
+The maximum number of entities in a page.
+
+#### Returns
+
+`Promise`\<`IServiceOfferingList`\>
+
+All the entities for the storage matching the conditions,
+and a cursor which can be used to request more entities.
+
+#### Throws
+
+NotImplementedError if the implementation does not support retrieval.
+
+#### Implementation of
+
+`IFederatedCatalogue.queryServiceOfferings`
+
+***
+
+### queryDataResources()
+
+> **queryDataResources**(`id?`, `producedBy?`, `cursor?`, `pageSize?`): `Promise`\<`IDataResourceList`\>
+
+Query the federated catalogue.
+
+#### Parameters
+
+##### id?
+
+`string`
+
+The identity of the DataResource.
+
+##### producedBy?
+
+`string`
+
+The identity of the participant.
+
+##### cursor?
+
+`string`
+
+The cursor to request the next page of entities.
+
+##### pageSize?
+
+`number`
+
+The maximum number of entities in a page.
+
+#### Returns
+
+`Promise`\<`IDataResourceList`\>
+
+All the entities for the storage matching the conditions,
+and a cursor which can be used to request more entities.
+
+#### Throws
+
+NotImplementedError if the implementation does not support retrieval.
+
+#### Implementation of
+
+`IFederatedCatalogue.queryDataResources`

package/docs/reference/classes/ParticipantEntry.md

@@ -0,0 +1,85 @@
+# Class: ParticipantEntry
+
+Participant entry.
+
+## Constructors
+
+### Constructor
+
+> **new ParticipantEntry**(): `ParticipantEntry`
+
+#### Returns
+
+`ParticipantEntry`
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+The participant Id.
+
+***
+
+### issuer
+
+> **issuer**: `string`
+
+The trusted issuer of the compliance credential
+
+***
+
+### registrationNumber
+
+> **registrationNumber**: `IRegistrationNumber`
+
+The legal registration number.
+
+***
+
+### legalName
+
+> **legalName**: `string`
+
+The legal name.
+
+***
+
+### legalAddress
+
+> **legalAddress**: `IAddress`
+
+Address
+
+***
+
+### validFrom
+
+> **validFrom**: `string`
+
+Valid from
+
+***
+
+### validUntil
+
+> **validUntil**: `string`
+
+Valid to
+
+***
+
+### dateCreated
+
+> **dateCreated**: `string`
+
+Date created
+
+***
+
+### evidence
+
+> **evidence**: `string`[]
+
+Evidences