@twin.org/federated-catalogue-models 0.0.1-next.10

package/docs/reference/interfaces/IDataSpaceConnectorCredential.md

@@ -0,0 +1,43 @@
+# Interface: IDataSpaceConnectorCredential
+
+Participant Credential.
+
+## Extends
+
+- [`ICredential`](ICredential.md)
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+The Id of the credential, it is mandatory.
+
+#### Inherited from
+
+[`ICredential`](ICredential.md).[`id`](ICredential.md#id)
+
+***
+
+### issuer
+
+> **issuer**: `string`
+
+The issuer of the credential, it is mandatory.
+
+#### Inherited from
+
+[`ICredential`](ICredential.md).[`issuer`](ICredential.md#issuer)
+
+***
+
+### credentialSubject
+
+> **credentialSubject**: [`IDataSpaceConnector`](IDataSpaceConnector.md)
+
+The Credential Subject
+
+#### Overrides
+
+[`ICredential`](ICredential.md).[`credentialSubject`](ICredential.md#credentialsubject)

package/docs/reference/interfaces/IDataSpaceConnectorEntry.md

@@ -0,0 +1,224 @@
+# Interface: IDataSpaceConnectorEntry
+
+Interface describing a participant.
+
+## Extends
+
+- [`IDataSpaceConnector`](IDataSpaceConnector.md).`ICatalogueBase`
+
+## Indexable
+
+\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinition` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{[`key`: `string`]: `string`; \}
+
+## Properties
+
+### issuer
+
+> **issuer**: `string`
+
+The trusted issuer of the compliance credential
+
+#### Inherited from
+
+`ICatalogueBase.issuer`
+
+***
+
+### validFrom
+
+> **validFrom**: `string`
+
+Valid from (as per W3C VC Data Model v2)
+
+#### Inherited from
+
+`ICatalogueBase.validFrom`
+
+***
+
+### validUntil
+
+> **validUntil**: `string`
+
+Valid until (as per W3C VC Data Model v2)
+
+#### Inherited from
+
+`ICatalogueBase.validUntil`
+
+***
+
+### dateCreated
+
+> **dateCreated**: `string`
+
+The creation date.
+
+#### Inherited from
+
+`ICatalogueBase.dateCreated`
+
+***
+
+### evidence
+
+> **evidence**: `string`[]
+
+The evidences concerning the data resource.
+
+#### Inherited from
+
+`ICatalogueBase.evidence`
+
+***
+
+### id
+
+> **id**: `string`
+
+A unique identifier given to this Data Space Connector.
+
+#### Inherited from
+
+[`IDataSpaceConnector`](IDataSpaceConnector.md).[`id`](IDataSpaceConnector.md#id)
+
+***
+
+### type
+
+> **type**: \[`"DataExchangeComponent"`, `"DataSpaceConnector"`, `...string[]`\]
+
+A Connector is a Data Exchange Component
+
+#### Inherited from
+
+[`IDataSpaceConnector`](IDataSpaceConnector.md).[`type`](IDataSpaceConnector.md#type)
+
+***
+
+### identity
+
+> **identity**: `string`
+
+Connector's Identity that allows to know public key of this Connector.
+
+#### Inherited from
+
+[`IDataSpaceConnector`](IDataSpaceConnector.md).[`identity`](IDataSpaceConnector.md#identity)
+
+***
+
+### maintainer
+
+> **maintainer**: `string`
+
+Who maintains this Data Space Connector.
+
+#### Inherited from
+
+[`IDataSpaceConnector`](IDataSpaceConnector.md).[`maintainer`](IDataSpaceConnector.md#maintainer)
+
+***
+
+### name?
+
+> `optional` **name**: `string`
+
+The name of this Data Space Connector
+
+#### Inherited from
+
+[`IDataSpaceConnector`](IDataSpaceConnector.md).[`name`](IDataSpaceConnector.md#name)
+
+***
+
+### description?
+
+> `optional` **description**: `string`
+
+A description of this Data Space Connector
+
+#### Inherited from
+
+[`IDataSpaceConnector`](IDataSpaceConnector.md).[`description`](IDataSpaceConnector.md#description)
+
+***
+
+### defaultEndpoint
+
+> **defaultEndpoint**: `IEndpoint`
+
+The default endpoint of the Connector.
+This endpoint can be used as a base to guess other endpoints in case they are not explicitly declared.
+
+#### Inherited from
+
+[`IDataSpaceConnector`](IDataSpaceConnector.md).[`defaultEndpoint`](IDataSpaceConnector.md#defaultendpoint)
+
+***
+
+### subscriptionActivityEndpoint?
+
+> `optional` **subscriptionActivityEndpoint**: `IEndpoint`
+
+The endpoint used for data subscription by Consumers.
+If the endpoint URL is a relative reference to a URL then it should be resolved using the
+default endpoint URL as a base URL.
+
+#### Inherited from
+
+[`IDataSpaceConnector`](IDataSpaceConnector.md).[`subscriptionActivityEndpoint`](IDataSpaceConnector.md#subscriptionactivityendpoint)
+
+***
+
+### pushActivityEndpoint
+
+> **pushActivityEndpoint**: `IEndpoint`
+
+The endpoint used by Providers to push data.
+If the endpoint URL is a relative reference to a URL then it should be resolved using the
+default endpoint URL as a base URL.
+
+#### Inherited from
+
+[`IDataSpaceConnector`](IDataSpaceConnector.md).[`pushActivityEndpoint`](IDataSpaceConnector.md#pushactivityendpoint)
+
+***
+
+### pullDataEndpoint
+
+> **pullDataEndpoint**: `IEndpoint`
+
+The endpoint used by Consumers to pull data from.
+If the endpoint URL is a relative reference to a URL then it should be resolved using the
+default endpoint URL as a base URL.
+
+#### Inherited from
+
+[`IDataSpaceConnector`](IDataSpaceConnector.md).[`pullDataEndpoint`](IDataSpaceConnector.md#pulldataendpoint)
+
+***
+
+### @context
+
+> **@context**: [`FederatedCatalogueContextType`](../type-aliases/FederatedCatalogueContextType.md)
+
+The LD Context
+
+#### Overrides
+
+[`IDataSpaceConnector`](IDataSpaceConnector.md).[`@context`](IDataSpaceConnector.md#context)
+
+***
+
+### offeredResource
+
+> **offeredResource**: `string`[]
+
+Offered resources. Probably in the future this wll be separated in a different entry so
+that a  Data Space Connector entry does not need to be modified when a new Data Resource
+is offered.
+
+#### Overrides
+
+[`IDataSpaceConnector`](IDataSpaceConnector.md).[`offeredResource`](IDataSpaceConnector.md#offeredresource)

package/docs/reference/interfaces/IDataSpaceConnectorGetResponse.md

@@ -0,0 +1,11 @@
+# Interface: IDataSpaceConnectorGetResponse
+
+Service Offering response
+
+## Properties
+
+### body
+
+> **body**: [`IDataSpaceConnectorEntry`](IDataSpaceConnectorEntry.md)
+
+The response payload.

package/docs/reference/interfaces/IDataSpaceConnectorList.md

@@ -0,0 +1,35 @@
+# Interface: IDataSpaceConnectorList
+
+Interface describing a list of Data Space Connectors.
+
+## Properties
+
+### @context
+
+> **@context**: [`FederatedCatalogueContextType`](../type-aliases/FederatedCatalogueContextType.md)
+
+The LD Context.
+
+***
+
+### type
+
+> **type**: `"ItemList"`
+
+The type
+
+***
+
+### itemListElement
+
+> **itemListElement**: `Omit`\<[`IDataSpaceConnectorEntry`](IDataSpaceConnectorEntry.md), `"@context"`\>[]
+
+The components of the Collection
+
+***
+
+### nextItem?
+
+> `optional` **nextItem**: `string`
+
+Next item cursor.

package/docs/reference/interfaces/IDataSpaceConnectorListRequest.md

@@ -0,0 +1,55 @@
+# Interface: IDataSpaceConnectorListRequest
+
+Get the a list of the data space connector entries.
+
+## Extends
+
+- [`IFederatedCatalogueGetRequest`](IFederatedCatalogueGetRequest.md)
+
+## Properties
+
+### query
+
+> **query**: `object`
+
+The query parameters.
+
+#### id?
+
+> `optional` **id**: `string`
+
+The id of the Data Space Connector.
+
+#### maintainedBy?
+
+> `optional` **maintainedBy**: `string`
+
+The maintainer
+
+#### cursor?
+
+> `optional` **cursor**: `string`
+
+The optional cursor to get next chunk.
+
+#### pageSize?
+
+> `optional` **pageSize**: `number`
+
+The maximum number of entities in a page.
+
+***
+
+### headers?
+
+> `optional` **headers**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### accept
+
+> **accept**: `"application/json"` \| `"application/ld+json"`
+
+#### Inherited from
+
+[`IFederatedCatalogueGetRequest`](IFederatedCatalogueGetRequest.md).[`headers`](IFederatedCatalogueGetRequest.md#headers)

package/docs/reference/interfaces/IDataSpaceConnectorListResponse.md

@@ -0,0 +1,11 @@
+# Interface: IDataSpaceConnectorListResponse
+
+Response for Data Space Connector list
+
+## Properties
+
+### body
+
+> **body**: [`IDataSpaceConnectorList`](IDataSpaceConnectorList.md)
+
+The response payload.

package/docs/reference/interfaces/IFederatedCatalogueComponent.md

@@ -0,0 +1,313 @@
+# Interface: IFederatedCatalogueComponent
+
+Interface describing a Federated Catalogue Contract.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### registerComplianceCredential()
+
+> **registerComplianceCredential**(`credential`): `Promise`\<`string`\>
+
+Registers a Participant's compliance Credential to the service.
+
+#### Parameters
+
+##### credential
+
+`string`
+
+The credential as JWT.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The participant Id (usually a DID).
+
+***
+
+### queryParticipants()
+
+> **queryParticipants**(`participant?`, `legalRegistrationNumber?`, `lrnType?`, `cursor?`, `pageSize?`): `Promise`\<[`IParticipantList`](IParticipantList.md)\>
+
+Query the federated catalogue.
+
+#### Parameters
+
+##### participant?
+
+`string`
+
+The identity of the participant.
+
+##### legalRegistrationNumber?
+
+`string`
+
+The legal registration number.
+
+##### lrnType?
+
+`string`
+
+The legal registration number type (EORI, VATID, GLEIF, Kenya's 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`](IParticipantList.md)\>
+
+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.
+
+***
+
+### registerDataSpaceConnectorCredential()
+
+> **registerDataSpaceConnectorCredential**(`credential`): `Promise`\<`string`\>
+
+Registers a Data Space Connector to the service.
+
+#### Parameters
+
+##### credential
+
+`string`
+
+The credential as JWT.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The Data Space Connector Id registered.
+
+***
+
+### queryDataSpaceConnectors()
+
+> **queryDataSpaceConnectors**(`id?`, `maintainer?`, `cursor?`, `pageSize?`): `Promise`\<[`IDataSpaceConnectorList`](IDataSpaceConnectorList.md)\>
+
+Query the federated catalogue.
+
+#### Parameters
+
+##### id?
+
+`string`
+
+Data Space Connector Id.
+
+##### maintainer?
+
+`string`
+
+The identity of the participant maintaining the Data Space Connector.
+
+##### cursor?
+
+`string`
+
+The cursor to request the next page of entities.
+
+##### pageSize?
+
+`number`
+
+The maximum number of entities in a page.
+
+#### Returns
+
+`Promise`\<[`IDataSpaceConnectorList`](IDataSpaceConnectorList.md)\>
+
+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.
+
+***
+
+### registerServiceOfferingCredential()
+
+> **registerServiceOfferingCredential**(`credential`): `Promise`\<`string`[]\>
+
+Registers a service offering Credential to the service.
+
+#### Parameters
+
+##### credential
+
+`string`
+
+The credential as JWT.
+
+#### Returns
+
+`Promise`\<`string`[]\>
+
+The Id of the Service Offerings registered.
+
+***
+
+### registerDataResourceCredential()
+
+> **registerDataResourceCredential**(`credential`): `Promise`\<`string`[]\>
+
+Registers a data resource Credential to the service.
+
+#### Parameters
+
+##### credential
+
+`string`
+
+The credential as JWT.
+
+#### Returns
+
+`Promise`\<`string`[]\>
+
+The Id of the Data Resources registered.
+
+***
+
+### queryServiceOfferings()
+
+> **queryServiceOfferings**(`id?`, `providedBy?`, `cursor?`, `pageSize?`): `Promise`\<[`IServiceOfferingList`](IServiceOfferingList.md)\>
+
+Query the federated catalogue.
+
+#### Parameters
+
+##### id?
+
+`string`
+
+Service Offering id.
+
+##### providedBy?
+
+`string`
+
+The identity of the participant providing the Offering.
+
+##### cursor?
+
+`string`
+
+The cursor to request the next page of entities.
+
+##### pageSize?
+
+`number`
+
+The maximum number of entities in a page.
+
+#### Returns
+
+`Promise`\<[`IServiceOfferingList`](IServiceOfferingList.md)\>
+
+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.
+
+***
+
+### queryDataResources()
+
+> **queryDataResources**(`id?`, `producedBy?`, `cursor?`, `pageSize?`): `Promise`\<[`IDataResourceList`](IDataResourceList.md)\>
+
+Query the federated catalogue.
+
+#### Parameters
+
+##### id?
+
+`string`
+
+The id of the Data Resource.
+
+##### producedBy?
+
+`string`
+
+The identity of the participant producing the data behind the data resource.
+
+##### cursor?
+
+`string`
+
+The cursor to request the next page of entities.
+
+##### pageSize?
+
+`number`
+
+The maximum number of entities in a page.
+
+#### Returns
+
+`Promise`\<[`IDataResourceList`](IDataResourceList.md)\>
+
+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.
+
+***
+
+### getEntry()
+
+> **getEntry**(`entryType`, `entryId`): `Promise`\<[`ICatalogueEntry`](../type-aliases/ICatalogueEntry.md)\>
+
+Returns a Federated Catalogue entry.
+
+#### Parameters
+
+##### entryType
+
+[`FederatedCatalogueEntryType`](../type-aliases/FederatedCatalogueEntryType.md)
+
+The type of entry.
+
+##### entryId
+
+`string`
+
+The entry's id.
+
+#### Returns
+
+`Promise`\<[`ICatalogueEntry`](../type-aliases/ICatalogueEntry.md)\>
+
+Catalogue Entry
+
+#### Throws
+
+NotFoundError if not found.

package/docs/reference/interfaces/IFederatedCatalogueGetRequest.md

@@ -0,0 +1,23 @@
+# Interface: IFederatedCatalogueGetRequest
+
+Base interface for Federated Catalogue Get Requests
+
+## Extended by
+
+- [`IParticipantListRequest`](IParticipantListRequest.md)
+- [`IServiceOfferingListRequest`](IServiceOfferingListRequest.md)
+- [`IDataResourceListRequest`](IDataResourceListRequest.md)
+- [`ICatalogueEntryGetRequest`](ICatalogueEntryGetRequest.md)
+- [`IDataSpaceConnectorListRequest`](IDataSpaceConnectorListRequest.md)
+
+## Properties
+
+### headers?
+
+> `optional` **headers**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### accept
+
+> **accept**: `"application/json"` \| `"application/ld+json"`