@twin.org/federated-catalogue-service 0.0.3-next.2 → 0.0.3-next.21

package/docs/reference/classes/Dataset.md

@@ -2,7 +2,7 @@
 
 Class describing a DCAT dataset for entity storage.
 This wrapper enables efficient database indexing and querying while preserving
-the full IDataset JSON-LD structure.
+the full IDcatDataset JSON-LD structure.
 
 ## Constructors
 
@@ -16,240 +16,248 @@ the full IDataset JSON-LD structure.
 
 ## Properties
 
-### @id
+### id {#id}
 
-> **@id**: `string`
+> **id**: `string`
 
-The unique identifier for the dataset (@id from JSON-LD).
+The unique identifier for the dataset (mapped from JSON-LD identifier).
 
 ***
 
-### @context
+### ownerId {#ownerid}
 
-> **@context**: `DcatContextType` \| `undefined`
+> **ownerId**: `string`
+
+The owner of the dataset.
+
+***
+
+### @context {#context}
+
+> **@context**: `DcatContextType`
 
 The JSON-LD context for the dataset.
 
 ***
 
-### @type
+### @type {#type}
 
-> **@type**: `"Catalog"` \| `"Dataset"` \| `"DatasetSeries"`
+> **@type**: `"dcat:Dataset"` \| `"dcat:Catalog"` \| `"dcat:DatasetSeries"`
 
 The type of the resource (typically "Dataset").
 
 ***
 
-### dcterms:title?
+### dcterms:title? {#dctermstitle}
 
-> `optional` **dcterms:title**: `LiteralType`
+> `optional` **dcterms:title?**: `ObjectOrArray`\<`string`\>
 
 A name given to the resource.
 
 ***
 
-### dcterms:description?
+### dcterms:description? {#dctermsdescription}
 
-> `optional` **dcterms:description**: `LiteralType`
+> `optional` **dcterms:description?**: `ObjectOrArray`\<`string`\>
 
 A free-text account of the resource.
 
 ***
 
-### dcterms:identifier?
+### dcterms:identifier? {#dctermsidentifier}
 
-> `optional` **dcterms:identifier**: `LiteralType`
+> `optional` **dcterms:identifier?**: `ObjectOrArray`\<`string`\>
 
 A unique identifier of the resource.
 
 ***
 
-### dcterms:issued?
+### dcterms:issued? {#dctermsissued}
 
-> `optional` **dcterms:issued**: `string`
+> `optional` **dcterms:issued?**: `string`
 
 Date of formal issuance (publication) of the resource.
 
 ***
 
-### dcterms:modified?
+### dcterms:modified? {#dctermsmodified}
 
-> `optional` **dcterms:modified**: `string`
+> `optional` **dcterms:modified?**: `string`
 
 Most recent date on which the resource was changed, updated or modified.
 
 ***
 
-### dcterms:language?
+### dcterms:language? {#dctermslanguage}
 
-> `optional` **dcterms:language**: `ObjectOrArray`\<`string`\>
+> `optional` **dcterms:language?**: `ObjectOrArray`\<`string`\>
 
 A language of the resource.
 
 ***
 
-### dcterms:publisher?
+### dcterms:publisher? {#dctermspublisher}
 
-> `optional` **dcterms:publisher**: `string` \| `IAgent`
+> `optional` **dcterms:publisher?**: `string` \| `JsonLdObjectWithAliases`\<`IFoafAgent`, `"foaf"`\>
 
 An entity responsible for making the resource available.
 
 ***
 
-### dcterms:creator?
+### dcterms:creator? {#dctermscreator}
 
-> `optional` **dcterms:creator**: `IAgent`
+> `optional` **dcterms:creator?**: `string` \| `JsonLdObjectWithAliases`\<`IFoafAgent`, `"foaf"`\>
 
 An entity responsible for producing the resource.
 
 ***
 
-### dcterms:accessRights?
+### dcterms:accessRights? {#dctermsaccessrights}
 
-> `optional` **dcterms:accessRights**: `string` \| `IJsonLdNodeObject`
+> `optional` **dcterms:accessRights?**: `string` \| `IJsonLdNodeObject`
 
 Information about who can access the resource or an indication of its security status.
 
 ***
 
-### dcterms:license?
+### dcterms:license? {#dctermslicense}
 
-> `optional` **dcterms:license**: `string` \| `IJsonLdNodeObject`
+> `optional` **dcterms:license?**: `string` \| `IJsonLdNodeObject`
 
 A legal document under which the resource is made available.
 
 ***
 
-### dcterms:rights?
+### dcterms:rights? {#dctermsrights}
 
-> `optional` **dcterms:rights**: `string` \| `IJsonLdNodeObject`
+> `optional` **dcterms:rights?**: `string` \| `IJsonLdNodeObject`
 
 Information about rights held in and over the resource.
 
 ***
 
-### dcterms:conformsTo?
+### dcterms:conformsTo? {#dctermsconformsto}
 
-> `optional` **dcterms:conformsTo**: `ObjectOrArray`\<`string`\>
+> `optional` **dcterms:conformsTo?**: `ObjectOrArray`\<`string`\>
 
 An established standard to which the resource conforms.
 
 ***
 
-### dcterms:type?
+### dcterms:type? {#dctermstype}
 
-> `optional` **dcterms:type**: `string`
+> `optional` **dcterms:type?**: `string`
 
 The nature or genre of the resource.
 
 ***
 
-### dcat:contactPoint?
+### dcat:contactPoint? {#dcatcontactpoint}
 
-> `optional` **dcat:contactPoint**: `string` \| `IJsonLdNodeObject`
+> `optional` **dcat:contactPoint?**: `string` \| `IJsonLdNodeObject`
 
 Relevant contact information for the catalogued resource.
 
 ***
 
-### dcat:keyword?
+### dcat:keyword? {#dcatkeyword}
 
-> `optional` **dcat:keyword**: `LiteralType`
+> `optional` **dcat:keyword?**: `ObjectOrArray`\<`string`\>
 
 A keyword or tag describing the resource.
 
 ***
 
-### dcat:theme?
+### dcat:theme? {#dcattheme}
 
-> `optional` **dcat:theme**: `ObjectOrArray`\<`string`\>
+> `optional` **dcat:theme?**: `ObjectOrArray`\<`string`\>
 
 A main category of the resource. A resource can have multiple themes.
 
 ***
 
-### dcat:landingPage?
+### dcat:landingPage? {#dcatlandingpage}
 
-> `optional` **dcat:landingPage**: `ObjectOrArray`\<`string`\>
+> `optional` **dcat:landingPage?**: `ObjectOrArray`\<`string`\>
 
 A Web page that can be navigated to gain access to the resource.
 
 ***
 
-### dcat:qualifiedRelation?
+### dcat:qualifiedRelation? {#dcatqualifiedrelation}
 
-> `optional` **dcat:qualifiedRelation**: `string` \| `IRelationship`
+> `optional` **dcat:qualifiedRelation?**: `string` \| `IDcatRelationship`
 
 Link to a description of a relationship with another resource.
 
 ***
 
-### odrl:hasPolicy?
+### odrl:hasPolicy? {#odrlhaspolicy}
 
-> `optional` **odrl:hasPolicy**: `IOdrlPolicy`
+> `optional` **odrl:hasPolicy?**: `JsonLdObjectWithOptionalContext`\<`IOdrlPolicy`\>
 
 An ODRL conformant policy expressing the rights associated with the resource.
 
 ***
 
-### dcat:distribution?
+### dcat:distribution? {#dcatdistribution}
 
-> `optional` **dcat:distribution**: `ObjectOrArray`\<`IDistribution`\>
+> `optional` **dcat:distribution?**: `ObjectOrArray`\<`IDcatDistributionBase`\>
 
 An available distribution of the dataset.
 
 ***
 
-### dcterms:accrualPeriodicity?
+### dcterms:accrualPeriodicity? {#dctermsaccrualperiodicity}
 
-> `optional` **dcterms:accrualPeriodicity**: `string`
+> `optional` **dcterms:accrualPeriodicity?**: `string`
 
 The frequency at which the dataset is published.
 
 ***
 
-### dcat:inSeries?
+### dcat:inSeries? {#dcatinseries}
 
-> `optional` **dcat:inSeries**: `string`
+> `optional` **dcat:inSeries?**: `string`
 
 A dataset series of which the dataset is part.
 
 ***
 
-### dcterms:spatial?
+### dcterms:spatial? {#dctermsspatial}
 
-> `optional` **dcterms:spatial**: `IJsonLdNodeObject` \| `ObjectOrArray`\<`string`\>
+> `optional` **dcterms:spatial?**: `string` \| `string`[] \| `IJsonLdNodeObject`
 
 The geographical area covered by the dataset.
 
 ***
 
-### dcat:spatialResolutionInMeters?
+### dcat:spatialResolutionInMeters? {#dcatspatialresolutioninmeters}
 
-> `optional` **dcat:spatialResolutionInMeters**: `number`
+> `optional` **dcat:spatialResolutionInMeters?**: `number`
 
 Minimum spatial separation resolvable in a dataset, measured in meters.
 
 ***
 
-### dcterms:temporal?
+### dcterms:temporal? {#dctermstemporal}
 
-> `optional` **dcterms:temporal**: `IPeriodOfTime`
+> `optional` **dcterms:temporal?**: `IDublinCorePeriodOfTime`
 
 The temporal period that the dataset covers.
 
 ***
 
-### dcat:temporalResolution?
+### dcat:temporalResolution? {#dcattemporalresolution}
 
-> `optional` **dcat:temporalResolution**: `string`
+> `optional` **dcat:temporalResolution?**: `string`
 
 Minimum time period resolvable in the dataset.
 
 ***
 
-### prov:wasGeneratedBy?
+### prov:wasGeneratedBy? {#provwasgeneratedby}
 
-> `optional` **prov:wasGeneratedBy**: `string` \| `IJsonLdNodeObject`
+> `optional` **prov:wasGeneratedBy?**: `string` \| `IJsonLdNodeObject`
 
 An activity that generated, or provides the business context for, the creation of the dataset.

package/docs/reference/classes/FederatedCatalogueService.md

@@ -29,7 +29,7 @@ The options for the service.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -37,7 +37,7 @@ Runtime name for the class.
 
 ## Methods
 
-### className()
+### className() {#classname}
 
 > **className**(): `string`
 
@@ -55,29 +55,31 @@ The class name of the component.
 
 ***
 
-### get()
+### get() {#get}
 
-> **get**(`dataSetId`): `Promise`\<`IDataset`\>
+> **get**(`datasetId`, `trustPayload`): `Promise`\<`IDataspaceProtocolCatalogError` \| `IDcatDataset`\>
 
 Retrieve a dataset by its unique identifier.
 
 #### Parameters
 
-##### dataSetId
+##### datasetId
 
 `string`
 
 The unique identifier of the dataset.
 
-#### Returns
+##### trustPayload
+
+`unknown`
 
-`Promise`\<`IDataset`\>
+Optional payload for trust evaluation, if applicable.
 
-The dataset if found.
+#### Returns
 
-#### Throws
+`Promise`\<`IDataspaceProtocolCatalogError` \| `IDcatDataset`\>
 
-NotFoundError if the dataset does not exist.
+The dataset if found, or a CatalogError if not found or an error occurs.
 
 #### Implementation of
 
@@ -85,24 +87,31 @@ NotFoundError if the dataset does not exist.
 
 ***
 
-### set()
+### set() {#set}
 
-> **set**(`dataSet`): `Promise`\<`void`\>
+> **set**(`dataset`, `trustPayload`): `Promise`\<`string` \| `IDataspaceProtocolCatalogError`\>
 
 Insert or update a dataset in the catalogue.
-This method is internal and should not be exposed via REST endpoints.
 
 #### Parameters
 
-##### dataSet
+##### dataset
 
-`IDataset`
+`IDcatDataset`
 
 The dataset to store.
 
+##### trustPayload
+
+`unknown`
+
+Optional payload for trust evaluation, if applicable.
+
 #### Returns
 
-`Promise`\<`void`\>
+`Promise`\<`string` \| `IDataspaceProtocolCatalogError`\>
+
+The unique identifier of the stored dataset, or a CatalogError if an error occurs.
 
 #### Implementation of
 
@@ -110,58 +119,86 @@ The dataset to store.
 
 ***
 
-### query()
+### remove() {#remove}
 
-> **query**(`filter?`): `Promise`\<`ICatalog`\>
+> **remove**(`datasetId`, `trustPayload`): `Promise`\<`IDataspaceProtocolCatalogError` \| `undefined`\>
 
-Execute a query against the catalogue using registered filter plugins.
-Returns a complete DCAT Catalog object with proper JSON-LD context, metadata, and datasets.
-The filter payload is evaluated by the appropriate filter plugin based on its structure.
-Pagination properties (cursor, limit) and filter type (@type) are extracted from the filter object.
+Remove a dataset from the catalogue by its unique identifier.
+Indexes are automatically removed as they are stored with the dataset.
 
 #### Parameters
 
-##### filter?
+##### datasetId
 
-`IBaseFilter`[]
+`string`
 
-The filter criteria containing @type, optional cursor and limit properties.
+The unique identifier of the dataset to remove.
 
-#### Returns
+##### trustPayload
 
-`Promise`\<`ICatalog`\>
+`unknown`
 
-Complete ICatalog object with @context, @id, @type, dcat:dataset, and optional cursor.
+Optional payload for trust evaluation, if applicable.
 
-#### Throws
+#### Returns
 
-NotFoundError if
+`Promise`\<`IDataspaceProtocolCatalogError` \| `undefined`\>
+
+Nothing, or a CatalogError if an error occurs.
 
 #### Implementation of
 
-`IFederatedCatalogueComponent.query`
+`IFederatedCatalogueComponent.remove`
 
 ***
 
-### remove()
+### query() {#query}
 
-> **remove**(`dataSetId`): `Promise`\<`void`\>
+> **query**(`filter`, `cursor`, `limit`, `trustPayload`): `Promise`\<\{ `result`: `IDataspaceProtocolCatalogError` \| `IDataspaceProtocolCatalog`; `cursor?`: `string`; \}\>
 
-Remove a dataset from the catalogue by its unique identifier.
-Indexes are automatically removed as they are stored with the dataset.
+Execute a query against the catalogue using registered filter plugins.
+Returns a DS Protocol compliant Catalog object with participantId.
+
+The root catalog's participantId is the requesting participant (from context).
+Own datasets (matching requestingParticipantId) go directly in root dataset[].
+Other participants' datasets are grouped in nested catalog[] entries.
+
+For anonymous requests (no context), uses the first publisher found as fallback.
+Returns CatalogError 404 when no datasets exist, CatalogError 400 for invalid requests.
 
 #### Parameters
 
-##### dataSetId
+##### filter
 
-`string`
+`unknown`[] \| `undefined`
 
-The unique identifier of the dataset to remove.
+The filter criteria containing @type, optional cursor and limit properties.
+
+##### cursor
+
+`string` \| `undefined`
+
+Optional cursor for pagination.
+
+##### limit
+
+`number` \| `undefined`
+
+Optional limit for pagination.
+
+##### trustPayload
+
+`unknown`
+
+Optional payload for trust evaluation, if applicable.
 
 #### Returns
 
-`Promise`\<`void`\>
+`Promise`\<\{ `result`: `IDataspaceProtocolCatalogError` \| `IDataspaceProtocolCatalog`; `cursor?`: `string`; \}\>
+
+Complete IDataspaceProtocolCatalog with @context, @id, @type, participantId, dataset/catalog,
+or CatalogError if validation fails or an error occurs.
 
 #### Implementation of
 
-`IFederatedCatalogueComponent.remove`
+`IFederatedCatalogueComponent.query`

package/docs/reference/functions/datasetEntityToModel.md

@@ -1,20 +1,20 @@
 # Function: datasetEntityToModel()
 
-> **datasetEntityToModel**(`entity`): `IDataset`
+> **datasetEntityToModel**(`entity`): `IDcatDataset`
 
-Convert a Dataset entity to an IDataset model.
-Removes internal entity properties that should not be exposed in API responses.
+Convert a Dataset entity to an IDcatDataset model.
+Maps entity.id back to model["@id"] and strips the storage-only id field.
 
 ## Parameters
 
 ### entity
 
-The dataset entity from storage (may be partial from query results).
+[`Dataset`](../classes/Dataset.md) \| `Partial`\<[`Dataset`](../classes/Dataset.md)\>
 
-[`Dataset`](../classes/Dataset.md) | `Partial`\<[`Dataset`](../classes/Dataset.md)\>
+The dataset entity from storage (may be partial from query results).
 
 ## Returns
 
-`IDataset`
+`IDcatDataset`
 
-The IDataset model for API responses.
+The IDcatDataset model for API responses.

package/docs/reference/functions/datasetModelToEntity.md

@@ -1,18 +1,23 @@
 # Function: datasetModelToEntity()
 
-> **datasetModelToEntity**(`model`): [`Dataset`](../classes/Dataset.md)
+> **datasetModelToEntity**(`model`, `ownerId`): [`Dataset`](../classes/Dataset.md)
 
-Convert an IDataset model to a Dataset entity.
-Prepares the model for storage by converting to entity type.
-Creates a shallow copy to avoid mutating the input model.
+Convert an IDcatDataset model to a Dataset entity.
+Maps model["@id"] to entity.id.
 
 ## Parameters
 
 ### model
 
-`IDataset`
+`IDcatDataset`
 
-The IDataset model from API requests.
+The IDcatDataset model from API requests.
+
+### ownerId
+
+`string`
+
+The owner ID to associate with the dataset entity.
 
 ## Returns
 

package/docs/reference/functions/transformErrorToStatusCode.md

@@ -0,0 +1,19 @@
+# Function: transformErrorToStatusCode()
+
+> **transformErrorToStatusCode**(`result`): `HttpStatusCode` \| `undefined`
+
+Transform the DS Protocol result to an HTTP status code.
+
+## Parameters
+
+### result
+
+`unknown`
+
+The result to transform.
+
+## Returns
+
+`HttpStatusCode` \| `undefined`
+
+The transformed status code or undefined if no transformation was found or not an error.

package/docs/reference/functions/transformToCatalogError.md

@@ -0,0 +1,20 @@
+# Function: transformToCatalogError()
+
+> **transformToCatalogError**(`error`): `IDataspaceProtocolCatalogError`
+
+Transform an error to DS Protocol CatalogError format.
+Used by both service and route layers to ensure consistent error responses.
+
+## Parameters
+
+### error
+
+`unknown`
+
+The error to transform.
+
+## Returns
+
+`IDataspaceProtocolCatalogError`
+
+The CatalogError.

package/docs/reference/index.md

@@ -7,6 +7,7 @@
 
 ## Interfaces
 
+- [IFederatedCatalogueServiceConfig](interfaces/IFederatedCatalogueServiceConfig.md)
 - [IFederatedCatalogueServiceConstructorOptions](interfaces/IFederatedCatalogueServiceConstructorOptions.md)
 
 ## Variables
@@ -18,5 +19,7 @@
 
 - [generateRestRoutesFederatedCatalogue](functions/generateRestRoutesFederatedCatalogue.md)
 - [initSchema](functions/initSchema.md)
+- [transformToCatalogError](functions/transformToCatalogError.md)
+- [transformErrorToStatusCode](functions/transformErrorToStatusCode.md)
 - [datasetEntityToModel](functions/datasetEntityToModel.md)
 - [datasetModelToEntity](functions/datasetModelToEntity.md)

package/docs/reference/interfaces/IFederatedCatalogueServiceConfig.md

@@ -0,0 +1,3 @@
+# Interface: IFederatedCatalogueServiceConfig
+
+Configuration for the FederatedCatalogueService.