@twin.org/federated-catalogue-models 0.0.2-next.6 → 0.0.3-next.2

package/docs/reference/index.md

@@ -1,58 +1,20 @@
 # @twin.org/federated-catalogue-models
 
-## Classes
-
-- [FederatedCatalogueDataTypes](classes/FederatedCatalogueDataTypes.md)
-- [FederatedCatalogueContextInstances](classes/FederatedCatalogueContextInstances.md)
-
 ## Interfaces
 
-- [IComplianceCredential](interfaces/IComplianceCredential.md)
-- [IComplianceEvidence](interfaces/IComplianceEvidence.md)
-- [IComplianceVerificationResult](interfaces/IComplianceVerificationResult.md)
-- [ICredential](interfaces/ICredential.md)
 - [IFederatedCatalogueComponent](interfaces/IFederatedCatalogueComponent.md)
-- [IVerificationResult](interfaces/IVerificationResult.md)
-- [ICatalogueEntryGetRequest](interfaces/ICatalogueEntryGetRequest.md)
-- [ICompliancePresentationRequest](interfaces/ICompliancePresentationRequest.md)
-- [IDataResourceGetResponse](interfaces/IDataResourceGetResponse.md)
-- [IDataResourceListRequest](interfaces/IDataResourceListRequest.md)
-- [IDataResourceListResponse](interfaces/IDataResourceListResponse.md)
-- [IDataSpaceConnectorGetResponse](interfaces/IDataSpaceConnectorGetResponse.md)
-- [IDataSpaceConnectorListRequest](interfaces/IDataSpaceConnectorListRequest.md)
-- [IDataSpaceConnectorListResponse](interfaces/IDataSpaceConnectorListResponse.md)
-- [IFederatedCatalogueGetRequest](interfaces/IFederatedCatalogueGetRequest.md)
-- [IParticipantGetResponse](interfaces/IParticipantGetResponse.md)
-- [IParticipantListRequest](interfaces/IParticipantListRequest.md)
-- [IParticipantListResponse](interfaces/IParticipantListResponse.md)
-- [IServiceOfferingGetResponse](interfaces/IServiceOfferingGetResponse.md)
-- [IServiceOfferingListRequest](interfaces/IServiceOfferingListRequest.md)
-- [IServiceOfferingListResponse](interfaces/IServiceOfferingListResponse.md)
-- [IDataResourceCredential](interfaces/IDataResourceCredential.md)
-- [IDataResourceEntry](interfaces/IDataResourceEntry.md)
-- [IDataResourceList](interfaces/IDataResourceList.md)
-- [IDataSpaceConnector](interfaces/IDataSpaceConnector.md)
-- [IDataSpaceConnectorCredential](interfaces/IDataSpaceConnectorCredential.md)
-- [IDataSpaceConnectorEntry](interfaces/IDataSpaceConnectorEntry.md)
-- [IDataSpaceConnectorList](interfaces/IDataSpaceConnectorList.md)
-- [IParticipantCredential](interfaces/IParticipantCredential.md)
-- [IParticipantEntry](interfaces/IParticipantEntry.md)
-- [IParticipantList](interfaces/IParticipantList.md)
-- [IServiceOfferingCredential](interfaces/IServiceOfferingCredential.md)
-- [IServiceOfferingEntry](interfaces/IServiceOfferingEntry.md)
-- [IServiceOfferingList](interfaces/IServiceOfferingList.md)
+- [IFederatedCatalogueFilter](interfaces/IFederatedCatalogueFilter.md)
+- [ICatalogRequestRequest](interfaces/ICatalogRequestRequest.md)
+- [ICatalogRequestResponse](interfaces/ICatalogRequestResponse.md)
+- [IGetDatasetRequest](interfaces/IGetDatasetRequest.md)
+- [IGetDatasetResponse](interfaces/IGetDatasetResponse.md)
+- [IBaseFilter](interfaces/IBaseFilter.md)
 
 ## Type Aliases
 
-- [ICatalogueEntry](type-aliases/ICatalogueEntry.md)
-- [FederatedCatalogueContextType](type-aliases/FederatedCatalogueContextType.md)
 - [FederatedCatalogueContexts](type-aliases/FederatedCatalogueContexts.md)
-- [FederatedCatalogueEntryType](type-aliases/FederatedCatalogueEntryType.md)
-- [FederatedCatalogueTypes](type-aliases/FederatedCatalogueTypes.md)
-- [VerificationFailureReasons](type-aliases/VerificationFailureReasons.md)
 
 ## Variables
 
+- [FederatedCatalogueFilterFactory](variables/FederatedCatalogueFilterFactory.md)
 - [FederatedCatalogueContexts](variables/FederatedCatalogueContexts.md)
-- [FederatedCatalogueTypes](variables/FederatedCatalogueTypes.md)
-- [VerificationFailureReasons](variables/VerificationFailureReasons.md)

package/docs/reference/interfaces/IBaseFilter.md

@@ -0,0 +1,55 @@
+# Interface: IBaseFilter
+
+Base filter interface with pagination support.
+All filter objects in the federated catalogue extend this base.
+
+Per Eclipse Dataspace Protocol constraints, cursor and limit cannot be
+top-level properties in CatalogRequestMessage. They must be embedded
+within the filter object using a custom JSON-LD vocabulary.
+
+After JSON-LD compaction, properties use direct names (cursor, limit) rather
+than prefixed names. Each filter implementation should extend this interface
+to define its own filter-specific properties.
+
+## Extends
+
+- `IJsonLdNodeObject`
+
+## Indexable
+
+\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinition` \| `IJsonLdContextDefinitionElement`[] \| `string`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
+
+## Properties
+
+### @type
+
+> **@type**: `string`
+
+Filter type discriminator.
+Used to route filter to appropriate filter implementation.
+Example: "FilterByExample", "FilterByPolicy", etc.
+Required for filter routing.
+
+#### Overrides
+
+`IJsonLdNodeObject.@type`
+
+***
+
+### cursor?
+
+> `optional` **cursor**: `string`
+
+Optional cursor for pagination.
+When provided, returns results starting after this cursor.
+Namespace: https://schema.twindev.org/federated-catalogue/cursor
+
+***
+
+### limit?
+
+> `optional` **limit**: `number`
+
+Optional limit for number of results.
+Defaults to implementation-specific value if not provided.
+Namespace: https://schema.twindev.org/federated-catalogue/limit

package/docs/reference/interfaces/ICatalogRequestRequest.md

@@ -0,0 +1,11 @@
+# Interface: ICatalogRequestRequest
+
+The request parameters for the catalog request method.
+
+## Properties
+
+### body
+
+> **body**: `ICatalogRequestMessage`
+
+The request body containing the catalog query.

package/docs/reference/interfaces/ICatalogRequestResponse.md

@@ -0,0 +1,11 @@
+# Interface: ICatalogRequestResponse
+
+The response payload for the catalog request method.
+
+## Properties
+
+### body
+
+> **body**: `ICatalog`
+
+The response payload containing the catalog with matching datasets.

package/docs/reference/interfaces/IFederatedCatalogueComponent.md

@@ -1,321 +1,110 @@
 # Interface: IFederatedCatalogueComponent
 
-Interface describing a Federated Catalogue Contract.
+Interface describing a federated catalogue component.
+Provides Dataspace Protocol-compliant catalog endpoints for dataset registry and query.
 
 ## Extends
 
 - `IComponent`
 
-## Indexable
-
-\[`key`: `string`\]: `any`
-
-All methods are optional, so we introduce an index signature to allow
-any additional properties or methods, which removes the TypeScript error where
-the class has no properties in common with the type.
-
 ## 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?`, `limit?`): `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?
+### get()
 
-`string`
-
-The cursor to request the next chunk of entities.
-
-##### limit?
-
-`number`
-
-Limit the number of entities to return.
-
-#### 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.
+> **get**(`dataSetId`): `Promise`\<`IDataset`\>
 
-#### Throws
-
-NotImplementedError if the implementation does not support retrieval.
-
-***
-
-### registerDataSpaceConnectorCredential()
-
-> **registerDataSpaceConnectorCredential**(`credential`): `Promise`\<`string`\>
-
-Registers a Data Space Connector to the service.
+Retrieve a dataset by its unique identifier.
 
 #### Parameters
 
-##### credential
-
-`string`
-
-The credential as JWT.
-
-#### Returns
-
-`Promise`\<`string`\>
-
-The Data Space Connector Id registered.
-
-***
-
-### queryDataSpaceConnectors()
-
-> **queryDataSpaceConnectors**(`id?`, `maintainer?`, `cursor?`, `limit?`): `Promise`\<[`IDataSpaceConnectorList`](IDataSpaceConnectorList.md)\>
-
-Query the federated catalogue.
-
-#### Parameters
-
-##### id?
-
-`string`
-
-Data Space Connector Id.
-
-##### maintainer?
+##### dataSetId
 
 `string`
 
-The identity of the participant maintaining the Data Space Connector.
-
-##### cursor?
-
-`string`
-
-The cursor to request the next chunk of entities.
-
-##### limit?
-
-`number`
-
-Limit the number of entities to return.
+The unique identifier of the dataset.
 
 #### Returns
 
-`Promise`\<[`IDataSpaceConnectorList`](IDataSpaceConnectorList.md)\>
+`Promise`\<`IDataset`\>
 
-All the entities for the storage matching the conditions,
-and a cursor which can be used to request more entities.
+The dataset if found.
 
 #### 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.
+NotFoundError if the dataset does not exist.
 
 ***
 
-### queryServiceOfferings()
+### set()
 
-> **queryServiceOfferings**(`id?`, `providedBy?`, `cursor?`, `limit?`): `Promise`\<[`IServiceOfferingList`](IServiceOfferingList.md)\>
+> **set**(`dataSet`): `Promise`\<`void`\>
 
-Query the federated catalogue.
+Insert or update a dataset in the catalogue.
+This method is internal and should not be exposed via REST endpoints.
 
 #### Parameters
 
-##### id?
-
-`string`
-
-Service Offering id.
-
-##### providedBy?
-
-`string`
-
-The identity of the participant providing the Offering.
+##### dataSet
 
-##### cursor?
+`IDataset`
 
-`string`
-
-The cursor to request the next chunk of entities.
-
-##### limit?
-
-`number`
-
-Limit the number of entities to return.
+The dataset to store.
 
 #### Returns
 
-`Promise`\<[`IServiceOfferingList`](IServiceOfferingList.md)\>
+`Promise`\<`void`\>
 
-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.
+Nothing.
 
 ***
 
-### queryDataResources()
+### query()
 
-> **queryDataResources**(`id?`, `producedBy?`, `cursor?`, `limit?`): `Promise`\<[`IDataResourceList`](IDataResourceList.md)\>
+> **query**(`filter?`): `Promise`\<`ICatalog`\>
 
-Query the federated catalogue.
+Execute a query against the catalogue using registered filter plugins.
+Returns a complete DCAT Catalog object with proper JSON-LD context, metadata, and datasets.
+Filter plugins must be registered in FilterFactory before service initialization.
+The filter payload is evaluated by the appropriate filter plugin based on its structure.
+Pagination properties (cursor, limit) and filter type (@type) should be included
+within the filter object per Eclipse Dataspace Protocol JSON-LD extension patterns.
 
 #### Parameters
 
-##### id?
+##### filter?
 
-`string`
+`unknown`[]
 
-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 chunk of entities.
-
-##### limit?
-
-`number`
-
-Limit the number of entities to return.
+The filter criteria containing @type, optional cursor and limit properties.
 
 #### Returns
 
-`Promise`\<[`IDataResourceList`](IDataResourceList.md)\>
+`Promise`\<`ICatalog`\>
 
-All the entities for the storage matching the conditions,
-and a cursor which can be used to request more entities.
+Complete ICatalog object with @context, @id, @type, dcat:dataset, and optional cursor.
 
 #### Throws
 
-NotImplementedError if the implementation does not support retrieval.
+NotFoundError if the
 
 ***
 
-### getEntry()
+### remove()
 
-> **getEntry**(`entryType`, `entryId`): `Promise`\<[`ICatalogueEntry`](../type-aliases/ICatalogueEntry.md)\>
+> **remove**(`dataSetId`): `Promise`\<`void`\>
 
-Returns a Federated Catalogue entry.
+Remove a dataset from the catalogue by its unique identifier.
 
 #### Parameters
 
-##### entryType
-
-[`FederatedCatalogueEntryType`](../type-aliases/FederatedCatalogueEntryType.md)
-
-The type of entry.
-
-##### entryId
+##### dataSetId
 
 `string`
 
-The entry's id.
+The unique identifier of the dataset to remove.
 
 #### Returns
 
-`Promise`\<[`ICatalogueEntry`](../type-aliases/ICatalogueEntry.md)\>
-
-Catalogue Entry
-
-#### Throws
+`Promise`\<`void`\>
 
-NotFoundError if not found.
+Nothing.

package/docs/reference/interfaces/IFederatedCatalogueFilter.md

@@ -0,0 +1,56 @@
+# Interface: IFederatedCatalogueFilter
+
+Interface describing a filter plugin for the federated catalogue.
+Filter plugins provide extensible query semantics and indexing strategies.
+Filters are registered by name in the FilterFactory and do not need to self-identify.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### query()
+
+> **query**(`filter`): `Promise`\<\{ `datasets`: `IDataset`[]; `cursor?`: `string`; \}\>
+
+Execute a filter-specific query over the catalogue.
+Each filter interprets the payload according to its own semantics.
+Pagination properties (cursor, limit) are extracted from the filter object by the service layer.
+
+#### Parameters
+
+##### filter
+
+`unknown`
+
+The filter criteria (structure depends on the filter implementation).
+
+#### Returns
+
+`Promise`\<\{ `datasets`: `IDataset`[]; `cursor?`: `string`; \}\>
+
+Object containing datasets matching the filter criteria and optional cursor for next page.
+
+***
+
+### createIndex()
+
+> **createIndex**(`dataSet`): `Promise`\<\{\[`key`: `string`\]: `unknown`; \}\>
+
+Generate filter indexes for a dataset to optimize future queries.
+Indexes are stored as properties on the dataset entity itself.
+
+#### Parameters
+
+##### dataSet
+
+`IDataset`
+
+The dataset to index.
+
+#### Returns
+
+`Promise`\<\{\[`key`: `string`\]: `unknown`; \}\>
+
+Record mapping filter-specific index keys to values.

package/docs/reference/interfaces/IGetDatasetRequest.md

@@ -0,0 +1,17 @@
+# Interface: IGetDatasetRequest
+
+The request parameters for the get dataset method.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### datasetId
+
+> **datasetId**: `string`
+
+The unique identifier of the dataset.

package/docs/reference/interfaces/IGetDatasetResponse.md

@@ -0,0 +1,11 @@
+# Interface: IGetDatasetResponse
+
+The response payload for the get dataset method.
+
+## Properties
+
+### body
+
+> **body**: `IDataset`
+
+The response payload containing the dataset.

package/docs/reference/type-aliases/FederatedCatalogueContexts.md

@@ -2,4 +2,4 @@
 
 > **FederatedCatalogueContexts** = *typeof* [`FederatedCatalogueContexts`](../variables/FederatedCatalogueContexts.md)\[keyof *typeof* [`FederatedCatalogueContexts`](../variables/FederatedCatalogueContexts.md)\]
 
-The Exported types
+The contexts of federated catalogue data.

package/docs/reference/variables/FederatedCatalogueContexts.md

@@ -2,7 +2,7 @@
 
 > `const` **FederatedCatalogueContexts**: `object`
 
-The LD context concerning the Federated Catalogue.
+The contexts of federated catalogue data.
 
 ## Type Declaration
 

package/docs/reference/variables/FederatedCatalogueFilterFactory.md

@@ -0,0 +1,6 @@
+# Variable: FederatedCatalogueFilterFactory
+
+> `const` **FederatedCatalogueFilterFactory**: `Factory`\<[`IFederatedCatalogueFilter`](../interfaces/IFederatedCatalogueFilter.md)\>
+
+Factory for managing filter plugin registration and retrieval.
+Follows the TWIN Platform factory pattern used by ComponentFactory and EntityStorageConnectorFactory.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/federated-catalogue-models",
-	"version": "0.0.2-next.6",
+	"version": "0.0.3-next.2",
 	"description": "Models which define the structure of the Federated Catalogue Service",
 	"repository": {
 		"type": "git",
@@ -19,25 +19,21 @@
 		"@twin.org/data-json-ld": "next",
 		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next",
-		"@twin.org/standards-gaia-x": "next",
-		"@twin.org/standards-schema-org": "next",
-		"@twin.org/standards-w3c-did": "next",
-		"@twin.org/standards-w3c-odrl": "next"
+		"@twin.org/standards-dataspace-protocol": "next",
+		"@twin.org/standards-w3c-dcat": "next"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/types",
 		"locales",
 		"docs"