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

package/docs/reference/classes/ServiceOfferingEntry.md

@@ -0,0 +1,109 @@
+# Class: ServiceOfferingEntry
+
+Service Offering Entry.
+
+## Constructors
+
+### Constructor
+
+> **new ServiceOfferingEntry**(): `ServiceOfferingEntry`
+
+#### Returns
+
+`ServiceOfferingEntry`
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+The service Id.
+
+***
+
+### issuer
+
+> **issuer**: `string`
+
+The trusted issuer of the compliance credential associated with
+
+***
+
+### name
+
+> **name**: `string`
+
+The service name.
+
+***
+
+### description?
+
+> `optional` **description**: `string`
+
+The service description.
+
+***
+
+### providedBy
+
+> **providedBy**: `string`
+
+The provider Id
+
+***
+
+### endpoint
+
+> **endpoint**: `IEndpoint`
+
+The REST endpoint
+
+***
+
+### servicePolicy
+
+> **servicePolicy**: `IOdrlPolicy`[]
+
+The policy
+
+***
+
+### aggregationOfResources?
+
+> `optional` **aggregationOfResources**: `string`[]
+
+Resources aggregated
+
+***
+
+### validFrom
+
+> **validFrom**: `string`
+
+Valid from
+
+***
+
+### validUntil
+
+> **validUntil**: `string`
+
+Valid to
+
+***
+
+### dateCreated
+
+> **dateCreated**: `string`
+
+Date created
+
+***
+
+### evidence
+
+> **evidence**: `string`[]
+
+Evidences

package/docs/reference/functions/complianceCredentialPresentation.md

@@ -0,0 +1,37 @@
+# Function: complianceCredentialPresentation()
+
+> **complianceCredentialPresentation**(`baseRouteName`, `httpRequestContext`, `factoryServiceName`, `request`): `Promise`\<`ICreatedResponse`\>
+
+Register a new participant.
+
+## Parameters
+
+### baseRouteName
+
+`string`
+
+The base route name.
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### factoryServiceName
+
+`string`
+
+The name of the service to use in the routes.
+
+### request
+
+`ICompliancePresentationRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`ICreatedResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/dataResourceCredentialPresentation.md

@@ -0,0 +1,37 @@
+# Function: dataResourceCredentialPresentation()
+
+> **dataResourceCredentialPresentation**(`baseRouteName`, `httpRequestContext`, `factoryServiceName`, `request`): `Promise`\<`ICreatedResponse`\>
+
+Register a new data resource.
+
+## Parameters
+
+### baseRouteName
+
+`string`
+
+The base route name.
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### factoryServiceName
+
+`string`
+
+The name of the service to use in the routes.
+
+### request
+
+`ICompliancePresentationRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`ICreatedResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/dataResourceGet.md

@@ -0,0 +1,31 @@
+# Function: dataResourceGet()
+
+> **dataResourceGet**(`httpRequestContext`, `factoryServiceName`, `request`): `Promise`\<`INotFoundResponse` \| `IDataResourceGetResponse`\>
+
+Get a Data Resource entry.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### factoryServiceName
+
+`string`
+
+The name of the service to use in the routes.
+
+### request
+
+`ICatalogueEntryGetRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INotFoundResponse` \| `IDataResourceGetResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/dataResourceList.md

@@ -0,0 +1,31 @@
+# Function: dataResourceList()
+
+> **dataResourceList**(`httpRequestContext`, `factoryServiceName`, `request`): `Promise`\<`IDataResourceListResponse`\>
+
+Get a list of the data resource entries.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### factoryServiceName
+
+`string`
+
+The name of the service to use in the routes.
+
+### request
+
+`IDataResourceListRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IDataResourceListResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/dataSpaceConnectorCredentialPresentation.md

@@ -0,0 +1,37 @@
+# Function: dataSpaceConnectorCredentialPresentation()
+
+> **dataSpaceConnectorCredentialPresentation**(`baseRouteName`, `httpRequestContext`, `factoryServiceName`, `request`): `Promise`\<`ICreatedResponse`\>
+
+Register a new data space connector.
+
+## Parameters
+
+### baseRouteName
+
+`string`
+
+the base route name.
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### factoryServiceName
+
+`string`
+
+The name of the service to use in the routes.
+
+### request
+
+`ICompliancePresentationRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`ICreatedResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/dataSpaceConnectorGet.md

@@ -0,0 +1,31 @@
+# Function: dataSpaceConnectorGet()
+
+> **dataSpaceConnectorGet**(`httpRequestContext`, `factoryServiceName`, `request`): `Promise`\<`INotFoundResponse` \| `IDataSpaceConnectorGetResponse`\>
+
+Get a Data Space Connector entry.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### factoryServiceName
+
+`string`
+
+The name of the service to use in the routes.
+
+### request
+
+`ICatalogueEntryGetRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INotFoundResponse` \| `IDataSpaceConnectorGetResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/dataSpaceConnectorList.md

@@ -0,0 +1,31 @@
+# Function: dataSpaceConnectorList()
+
+> **dataSpaceConnectorList**(`httpRequestContext`, `factoryServiceName`, `request`): `Promise`\<`IDataSpaceConnectorListResponse`\>
+
+Get a list of the data space connector entries.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### factoryServiceName
+
+`string`
+
+The name of the service to use in the routes.
+
+### request
+
+`IDataSpaceConnectorListRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IDataSpaceConnectorListResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/generateRestRoutesFederatedCatalogue.md

@@ -0,0 +1,25 @@
+# Function: generateRestRoutesFederatedCatalogue()
+
+> **generateRestRoutesFederatedCatalogue**(`baseRouteName`, `factoryServiceName`): `IRestRoute`\<`any`, `any`\>[]
+
+The REST routes for Federated Catalogue.
+
+## Parameters
+
+### baseRouteName
+
+`string`
+
+Prefix to prepend to the paths.
+
+### factoryServiceName
+
+`string`
+
+The name of the service to use in the routes store in the ServiceFactory.
+
+## Returns
+
+`IRestRoute`\<`any`, `any`\>[]
+
+The generated routes.

package/docs/reference/functions/initSchema.md

@@ -0,0 +1,9 @@
+# Function: initSchema()
+
+> **initSchema**(): `void`
+
+Inits schemas.
+
+## Returns
+
+`void`

package/docs/reference/functions/participantGet.md

@@ -0,0 +1,31 @@
+# Function: participantGet()
+
+> **participantGet**(`httpRequestContext`, `factoryServiceName`, `request`): `Promise`\<`IParticipantGetResponse` \| `INotFoundResponse`\>
+
+Get a Participant entry.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### factoryServiceName
+
+`string`
+
+The name of the service to use in the routes.
+
+### request
+
+`ICatalogueEntryGetRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IParticipantGetResponse` \| `INotFoundResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/participantList.md

@@ -0,0 +1,31 @@
+# Function: participantList()
+
+> **participantList**(`httpRequestContext`, `factoryServiceName`, `request`): `Promise`\<`IParticipantListResponse`\>
+
+Get a list of the participant entries.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### factoryServiceName
+
+`string`
+
+The name of the service to use in the routes.
+
+### request
+
+`IParticipantListRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IParticipantListResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/serviceOfferingCredentialPresentation.md

@@ -0,0 +1,37 @@
+# Function: serviceOfferingCredentialPresentation()
+
+> **serviceOfferingCredentialPresentation**(`baseRouteName`, `httpRequestContext`, `factoryServiceName`, `request`): `Promise`\<`ICreatedResponse`\>
+
+Register a new service offering.
+
+## Parameters
+
+### baseRouteName
+
+`string`
+
+The base route used.
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### factoryServiceName
+
+`string`
+
+The name of the service to use in the routes.
+
+### request
+
+`ICompliancePresentationRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`ICreatedResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/serviceOfferingGet.md

@@ -0,0 +1,31 @@
+# Function: serviceOfferingGet()
+
+> **serviceOfferingGet**(`httpRequestContext`, `factoryServiceName`, `request`): `Promise`\<`INotFoundResponse` \| `IServiceOfferingGetResponse`\>
+
+Get a Service Offering entry.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### factoryServiceName
+
+`string`
+
+The name of the service to use in the routes.
+
+### request
+
+`ICatalogueEntryGetRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INotFoundResponse` \| `IServiceOfferingGetResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/serviceOfferingList.md

@@ -0,0 +1,31 @@
+# Function: serviceOfferingList()
+
+> **serviceOfferingList**(`httpRequestContext`, `factoryServiceName`, `request`): `Promise`\<`IServiceOfferingListResponse`\>
+
+Get a list of the service offering entries.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### factoryServiceName
+
+`string`
+
+The name of the service to use in the routes.
+
+### request
+
+`IServiceOfferingListRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IServiceOfferingListResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/index.md

@@ -0,0 +1,36 @@
+# @twin.org/federated-catalogue-service
+
+## Classes
+
+- [DataResourceEntry](classes/DataResourceEntry.md)
+- [DataSpaceConnectorEntry](classes/DataSpaceConnectorEntry.md)
+- [ParticipantEntry](classes/ParticipantEntry.md)
+- [ServiceOfferingEntry](classes/ServiceOfferingEntry.md)
+- [FederatedCatalogueService](classes/FederatedCatalogueService.md)
+
+## Interfaces
+
+- [IFederatedCatalogueServiceConfig](interfaces/IFederatedCatalogueServiceConfig.md)
+- [IFederatedCatalogueServiceConstructorOptions](interfaces/IFederatedCatalogueServiceConstructorOptions.md)
+
+## Variables
+
+- [tagsFederatedCatalogue](variables/tagsFederatedCatalogue.md)
+- [restEntryPoints](variables/restEntryPoints.md)
+
+## Functions
+
+- [generateRestRoutesFederatedCatalogue](functions/generateRestRoutesFederatedCatalogue.md)
+- [complianceCredentialPresentation](functions/complianceCredentialPresentation.md)
+- [participantList](functions/participantList.md)
+- [participantGet](functions/participantGet.md)
+- [serviceOfferingCredentialPresentation](functions/serviceOfferingCredentialPresentation.md)
+- [serviceOfferingList](functions/serviceOfferingList.md)
+- [serviceOfferingGet](functions/serviceOfferingGet.md)
+- [dataResourceCredentialPresentation](functions/dataResourceCredentialPresentation.md)
+- [dataResourceList](functions/dataResourceList.md)
+- [dataResourceGet](functions/dataResourceGet.md)
+- [dataSpaceConnectorCredentialPresentation](functions/dataSpaceConnectorCredentialPresentation.md)
+- [dataSpaceConnectorList](functions/dataSpaceConnectorList.md)
+- [dataSpaceConnectorGet](functions/dataSpaceConnectorGet.md)
+- [initSchema](functions/initSchema.md)

package/docs/reference/interfaces/IFederatedCatalogueServiceConfig.md

@@ -0,0 +1,21 @@
+# Interface: IFederatedCatalogueServiceConfig
+
+Federated Catalogue service configuration
+
+## Properties
+
+### subResourceCacheTtlMs?
+
+> `optional` **subResourceCacheTtlMs**: `number`
+
+The number of ms that sub-resources can live in the fetch cache.
+0 means they can live forever.
+undefined means they are never cached.
+
+***
+
+### clearingHouseApproverList
+
+> **clearingHouseApproverList**: `string`[]
+
+Clearing House approver list

package/docs/reference/interfaces/IFederatedCatalogueServiceConstructorOptions.md

@@ -0,0 +1,83 @@
+# Interface: IFederatedCatalogueServiceConstructorOptions
+
+Federated Catalogue service options
+
+## Properties
+
+### identityResolverComponentType?
+
+> `optional` **identityResolverComponentType**: `string`
+
+The identity resolver component used.
+
+***
+
+### loggingConnectorType?
+
+> `optional` **loggingConnectorType**: `string`
+
+Logging connector type
+
+***
+
+### config
+
+> **config**: [`IFederatedCatalogueServiceConfig`](IFederatedCatalogueServiceConfig.md)
+
+The configuration of the Federated Catalogue service.
+
+***
+
+### participantEntityStorageType?
+
+> `optional` **participantEntityStorageType**: `string`
+
+The entity storage for participants.
+
+#### Default
+
+```ts
+participant-entry
+```
+
+***
+
+### dataResourceEntityStorageType?
+
+> `optional` **dataResourceEntityStorageType**: `string`
+
+The entity storage for data resources.
+
+#### Default
+
+```ts
+data-resource-entry
+```
+
+***
+
+### serviceOfferingEntityStorageType?
+
+> `optional` **serviceOfferingEntityStorageType**: `string`
+
+The entity storage for service offerings.
+
+#### Default
+
+```ts
+service-offering-entry
+```
+
+***
+
+### dataSpaceConnectorStorageType?
+
+> `optional` **dataSpaceConnectorStorageType**: `string`
+
+The entity storage for data space connectors.
+
+#### Default
+
+```ts
+data-space-connector-entry
+```

package/docs/reference/variables/restEntryPoints.md

@@ -0,0 +1,3 @@
+# Variable: restEntryPoints
+
+> `const` **restEntryPoints**: `IRestRouteEntryPoint`[]

package/docs/reference/variables/tagsFederatedCatalogue.md

@@ -0,0 +1,5 @@
+# Variable: tagsFederatedCatalogue
+
+> `const` **tagsFederatedCatalogue**: `ITag`[]
+
+The tag to associate with the routes.