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

package/dist/es/factories/federatedCatalogueFilterFactory.js

@@ -0,0 +1,10 @@
+// Copyright 2025 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Factory } from "@twin.org/core";
+/**
+ * Factory for managing filter plugin registration and retrieval.
+ * Follows the TWIN Platform factory pattern used by ComponentFactory and EntityStorageConnectorFactory.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const FederatedCatalogueFilterFactory = Factory.createFactory("federated-catalogue-filter");
+//# sourceMappingURL=federatedCatalogueFilterFactory.js.map

package/dist/es/factories/federatedCatalogueFilterFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"federatedCatalogueFilterFactory.js","sourceRoot":"","sources":["../../../src/factories/federatedCatalogueFilterFactory.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAGzC;;;GAGG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,+BAA+B,GAAG,OAAO,CAAC,aAAa,CACnE,4BAA4B,CAC5B,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Factory } from \"@twin.org/core\";\nimport type { IFederatedCatalogueFilter } from \"../models/IFederatedCatalogueFilter.js\";\n\n/**\n * Factory for managing filter plugin registration and retrieval.\n * Follows the TWIN Platform factory pattern used by ComponentFactory and EntityStorageConnectorFactory.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const FederatedCatalogueFilterFactory = Factory.createFactory<IFederatedCatalogueFilter>(\n\t\"federated-catalogue-filter\"\n);\n"]}

package/dist/es/index.js

@@ -0,0 +1,10 @@
+// Copyright 2025 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./factories/federatedCatalogueFilterFactory.js";
+export * from "./models/api/ICatalogRequestRequest.js";
+export * from "./models/api/ICatalogRequestResponse.js";
+export * from "./models/api/IGetDatasetRequest.js";
+export * from "./models/api/IGetDatasetResponse.js";
+export * from "./models/IFederatedCatalogueComponent.js";
+export * from "./models/IFederatedCatalogueFilter.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,gDAAgD,CAAC;AAC/D,cAAc,wCAAwC,CAAC;AACvD,cAAc,yCAAyC,CAAC;AACxD,cAAc,oCAAoC,CAAC;AACnD,cAAc,qCAAqC,CAAC;AACpD,cAAc,0CAA0C,CAAC;AACzD,cAAc,uCAAuC,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./factories/federatedCatalogueFilterFactory.js\";\nexport * from \"./models/api/ICatalogRequestRequest.js\";\nexport * from \"./models/api/ICatalogRequestResponse.js\";\nexport * from \"./models/api/IGetDatasetRequest.js\";\nexport * from \"./models/api/IGetDatasetResponse.js\";\nexport * from \"./models/IFederatedCatalogueComponent.js\";\nexport * from \"./models/IFederatedCatalogueFilter.js\";\n"]}

package/dist/es/models/IFederatedCatalogueComponent.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IFederatedCatalogueComponent.js.map

package/dist/es/models/IFederatedCatalogueComponent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IFederatedCatalogueComponent.js","sourceRoot":"","sources":["../../../src/models/IFederatedCatalogueComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type {\n\tIDataspaceProtocolCatalog,\n\tIDataspaceProtocolCatalogError\n} from \"@twin.org/standards-dataspace-protocol\";\nimport type { IDcatDataset } from \"@twin.org/standards-w3c-dcat\";\n\n/**\n * Interface describing a federated catalogue component.\n * Provides Dataspace Protocol-compliant catalog endpoints for dataset registry and query.\n */\nexport interface IFederatedCatalogueComponent extends IComponent {\n\t/**\n\t * Retrieve a dataset by its unique identifier.\n\t * @param dataSetId The unique identifier of the dataset.\n\t * @returns The dataset if found, or a CatalogError if not found or an error occurs.\n\t */\n\tget(dataSetId: string): Promise<IDcatDataset | IDataspaceProtocolCatalogError>;\n\n\t/**\n\t * Insert or update a dataset in the catalogue.\n\t * This method is internal and should not be exposed via REST endpoints.\n\t * @param dataSet The dataset to store.\n\t * @returns Nothing.\n\t */\n\tset(dataSet: IDcatDataset): Promise<void>;\n\n\t/**\n\t * Execute a query against the catalogue using registered filter plugins.\n\t * Returns a DS Protocol compliant Catalog object with participantId.\n\t *\n\t * The root catalog's participantId is the requesting participant (from context).\n\t * Own datasets (matching requestingParticipantId) go directly in root dataset[].\n\t * Other participants' datasets are grouped in nested catalog[] entries.\n\t *\n\t * For anonymous requests (no context), uses the first publisher found as fallback.\n\t * Returns CatalogError 404 when no datasets exist.\n\t *\n\t * @param filter The filter criteria containing @type.\n\t * @param cursor Optional cursor for pagination.\n\t * @param limit Optional limit for pagination.\n\t * @returns Complete IDataspaceProtocolCatalog with @context, @id, @type, participantId, dataset/catalog,\n\t * or IDataspaceProtocolCatalogError if no datasets found.\n\t */\n\tquery(\n\t\tfilter?: unknown[],\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{\n\t\tresult: IDataspaceProtocolCatalog | IDataspaceProtocolCatalogError;\n\t\tcursor?: string;\n\t}>;\n\n\t/**\n\t * Remove a dataset from the catalogue by its unique identifier.\n\t * @param dataSetId The unique identifier of the dataset to remove.\n\t * @returns Nothing.\n\t */\n\tremove(dataSetId: string): Promise<void>;\n}\n"]}

package/dist/es/models/IFederatedCatalogueFilter.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IFederatedCatalogueFilter.js.map

package/dist/es/models/IFederatedCatalogueFilter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IFederatedCatalogueFilter.js","sourceRoot":"","sources":["../../../src/models/IFederatedCatalogueFilter.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IDcatDataset } from \"@twin.org/standards-w3c-dcat\";\n\n/**\n * Interface describing a filter plugin for the federated catalogue.\n * Filter plugins provide extensible query semantics and indexing strategies.\n * Filters are registered by name in the FilterFactory and do not need to self-identify.\n */\nexport interface IFederatedCatalogueFilter extends IComponent {\n\t/**\n\t * Execute a filter-specific query over the catalogue.\n\t * Each filter interprets the payload according to its own semantics.\n\t * @param filter The filter criteria (structure depends on the filter implementation).\n\t * @param cursor The pagination cursor from the previous query, if any.\n\t * @param limit The maximum number of results to return.\n\t * @returns Object containing datasets matching the filter criteria and optional cursor for next page.\n\t */\n\tquery(\n\t\tfilter: unknown,\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{ datasets: IDcatDataset[]; cursor?: string }>;\n\n\t/**\n\t * Generate filter indexes for a dataset to optimize future queries.\n\t * Indexes are stored as properties on the dataset entity itself.\n\t * @param dataSet The dataset to index.\n\t * @returns Record mapping filter-specific index keys to values.\n\t */\n\tcreateIndex(dataSet: IDcatDataset): Promise<{ [key: string]: unknown }>;\n}\n"]}

package/dist/es/models/api/ICatalogRequestRequest.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ICatalogRequestRequest.js.map

package/dist/es/models/api/ICatalogRequestRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ICatalogRequestRequest.js","sourceRoot":"","sources":["../../../../src/models/api/ICatalogRequestRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDataspaceProtocolCatalogRequestMessage } from \"@twin.org/standards-dataspace-protocol\";\n\n/**\n * The request parameters for the catalog request method.\n */\nexport interface ICatalogRequestRequest {\n\t/**\n\t * The request body containing the catalog query.\n\t */\n\tbody: IDataspaceProtocolCatalogRequestMessage;\n\n\t/**\n\t * Optional query parameters for pagination.\n\t * Used when following Link header URLs per DS Protocol spec.\n\t */\n\tquery?: {\n\t\t/**\n\t\t * Opaque cursor token for pagination.\n\t\t */\n\t\tcursor?: string;\n\n\t\t/**\n\t\t * Limit for pagination.\n\t\t */\n\t\tlimit?: string;\n\t};\n}\n"]}

package/dist/es/models/api/ICatalogRequestResponse.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ICatalogRequestResponse.js.map

package/dist/es/models/api/ICatalogRequestResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ICatalogRequestResponse.js","sourceRoot":"","sources":["../../../../src/models/api/ICatalogRequestResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {\n\tIDataspaceProtocolCatalog,\n\tIDataspaceProtocolCatalogError\n} from \"@twin.org/standards-dataspace-protocol\";\nimport type { HeaderTypes, HttpStatusCode } from \"@twin.org/web\";\n\n/**\n * The response payload for the catalog request method.\n * Returns a DS Protocol compliant Catalog with participantId, or CatalogError if no datasets found.\n */\nexport interface ICatalogRequestResponse {\n\t/**\n\t * Optional headers including RFC 8288 Link header for pagination.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.Link]?: string | string[];\n\t};\n\n\t/**\n\t * Response status code.\n\t * Per DS Protocol: Returns appropriate HTTP code (e.g., 404) when returning CatalogError.\n\t */\n\tstatusCode?: HttpStatusCode;\n\n\t/**\n\t * The response payload containing the DS Protocol compliant catalog with participantId,\n\t * or a CatalogError if no datasets are found (404).\n\t * Per DS Protocol: Single participant returns flat catalog, multiple participants return nested catalogs.\n\t */\n\tbody: IDataspaceProtocolCatalog | IDataspaceProtocolCatalogError;\n}\n"]}

package/dist/es/models/api/IGetDatasetRequest.js

@@ -0,0 +1,4 @@
+// Copyright 2025 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IGetDatasetRequest.js.map

package/dist/es/models/api/IGetDatasetRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IGetDatasetRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IGetDatasetRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The request parameters for the get dataset method.\n */\nexport interface IGetDatasetRequest {\n\t/**\n\t * The path parameters.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The unique identifier of the dataset.\n\t\t */\n\t\tdatasetId: string;\n\t};\n}\n"]}

package/dist/es/models/api/IGetDatasetResponse.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IGetDatasetResponse.js.map

package/dist/es/models/api/IGetDatasetResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IGetDatasetResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IGetDatasetResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDataspaceProtocolCatalogError } from \"@twin.org/standards-dataspace-protocol\";\nimport type { IDcatDataset } from \"@twin.org/standards-w3c-dcat\";\nimport type { HttpStatusCode } from \"@twin.org/web\";\n\n/**\n * The response payload for the get dataset method.\n */\nexport interface IGetDatasetResponse {\n\t/**\n\t * Response status code.\n\t */\n\tstatusCode?: HttpStatusCode;\n\n\t/**\n\t * The response payload containing the dataset or error.\n\t */\n\tbody: IDcatDataset | IDataspaceProtocolCatalogError;\n}\n"]}

package/dist/types/factories/federatedCatalogueFilterFactory.d.ts

@@ -0,0 +1,7 @@
+import { Factory } from "@twin.org/core";
+import type { IFederatedCatalogueFilter } from "../models/IFederatedCatalogueFilter.js";
+/**
+ * Factory for managing filter plugin registration and retrieval.
+ * Follows the TWIN Platform factory pattern used by ComponentFactory and EntityStorageConnectorFactory.
+ */
+export declare const FederatedCatalogueFilterFactory: Factory<IFederatedCatalogueFilter>;

package/dist/types/index.d.ts

@@ -1,42 +1,7 @@
-export * from "./dataTypes/federatedCatalogueDataTypes";
-export * from "./models/api/ICatalogueEntryGetRequest";
-export * from "./models/api/ICompliancePresentationRequest";
-export * from "./models/api/IDataResourceGetResponse";
-export * from "./models/api/IDataResourceListRequest";
-export * from "./models/api/IDataResourceListResponse";
-export * from "./models/api/IDataSpaceConnectorGetResponse";
-export * from "./models/api/IDataSpaceConnectorListRequest";
-export * from "./models/api/IDataSpaceConnectorListResponse";
-export * from "./models/api/IFederatedCatalogueGetRequest";
-export * from "./models/api/IParticipantGetResponse";
-export * from "./models/api/IParticipantListRequest";
-export * from "./models/api/IParticipantListResponse";
-export * from "./models/api/IServiceOfferingGetResponse";
-export * from "./models/api/IServiceOfferingListRequest";
-export * from "./models/api/IServiceOfferingListResponse";
-export * from "./models/data-resource/IDataResourceCredential";
-export * from "./models/data-resource/IDataResourceEntry";
-export * from "./models/data-resource/IDataResourceList";
-export * from "./models/data-space-connector/IDataSpaceConnector";
-export * from "./models/data-space-connector/IDataSpaceConnectorCredential";
-export * from "./models/data-space-connector/IDataSpaceConnectorEntry";
-export * from "./models/data-space-connector/IDataSpaceConnectorList";
-export * from "./models/federatedCatalogueContextInstances";
-export * from "./models/federatedCatalogueContexts";
-export * from "./models/federatedCatalogueContextType";
-export * from "./models/federatedCatalogueEntryType";
-export * from "./models/federatedCatalogueTypes";
-export * from "./models/ICatalogueEntry";
-export * from "./models/IComplianceCredential";
-export * from "./models/IComplianceEvidence";
-export * from "./models/IComplianceVerificationResult";
-export * from "./models/ICredential";
-export * from "./models/IFederatedCatalogueComponent";
-export * from "./models/IVerificationResult";
-export * from "./models/participant/IParticipantCredential";
-export * from "./models/participant/IParticipantEntry";
-export * from "./models/participant/IParticipantList";
-export * from "./models/service-offering/IServiceOfferingCredential";
-export * from "./models/service-offering/IServiceOfferingEntry";
-export * from "./models/service-offering/IServiceOfferingList";
-export * from "./models/verificationFailureReasons";
+export * from "./factories/federatedCatalogueFilterFactory.js";
+export * from "./models/api/ICatalogRequestRequest.js";
+export * from "./models/api/ICatalogRequestResponse.js";
+export * from "./models/api/IGetDatasetRequest.js";
+export * from "./models/api/IGetDatasetResponse.js";
+export * from "./models/IFederatedCatalogueComponent.js";
+export * from "./models/IFederatedCatalogueFilter.js";

package/dist/types/models/IFederatedCatalogueComponent.d.ts

@@ -1,89 +1,49 @@
 import type { IComponent } from "@twin.org/core";
-import type { IDataResourceList } from "./data-resource/IDataResourceList";
-import type { IDataSpaceConnectorList } from "./data-space-connector/IDataSpaceConnectorList";
-import type { FederatedCatalogueEntryType } from "./federatedCatalogueEntryType";
-import type { ICatalogueEntry } from "./ICatalogueEntry";
-import type { IParticipantList } from "./participant/IParticipantList";
-import type { IServiceOfferingList } from "./service-offering/IServiceOfferingList";
+import type { IDataspaceProtocolCatalog, IDataspaceProtocolCatalogError } from "@twin.org/standards-dataspace-protocol";
+import type { IDcatDataset } from "@twin.org/standards-w3c-dcat";
 /**
- * Interface describing a Federated Catalogue Contract.
+ * Interface describing a federated catalogue component.
+ * Provides Dataspace Protocol-compliant catalog endpoints for dataset registry and query.
  */
 export interface IFederatedCatalogueComponent extends IComponent {
     /**
-     * Registers a Participant's compliance Credential to the service.
-     * @param credential The credential as JWT.
-     * @returns The participant Id (usually a DID).
-     */
-    registerComplianceCredential(credential: string): Promise<string>;
-    /**
-     * Query the federated catalogue.
-     * @param participant The identity of the participant.
-     * @param legalRegistrationNumber The legal registration number.
-     * @param lrnType The legal registration number type (EORI, VATID, GLEIF, Kenya's PIN, etc.)
-     * @param cursor The cursor to request the next chunk of entities.
-     * @param limit Limit the number of entities to return.
-     * @returns 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.
-     */
-    queryParticipants(participant?: string, legalRegistrationNumber?: string, lrnType?: string, cursor?: string, limit?: number): Promise<IParticipantList>;
-    /**
-     * Registers a Data Space Connector to the service.
-     * @param credential The credential as JWT.
-     * @returns The Data Space Connector Id registered.
-     */
-    registerDataSpaceConnectorCredential(credential: string): Promise<string>;
-    /**
-     * Query the federated catalogue.
-     * @param id Data Space Connector Id.
-     * @param maintainer The identity of the participant maintaining the Data Space Connector.
-     * @param cursor The cursor to request the next chunk of entities.
-     * @param limit Limit the number of entities to return.
-     * @returns 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.
-     */
-    queryDataSpaceConnectors(id?: string, maintainer?: string, cursor?: string, limit?: number): Promise<IDataSpaceConnectorList>;
-    /**
-     * Registers a service offering Credential to the service.
-     * @param credential The credential as JWT.
-     * @returns The Id of the Service Offerings registered.
-     */
-    registerServiceOfferingCredential(credential: string): Promise<string[]>;
-    /**
-     * Registers a data resource Credential to the service.
-     * @param credential The credential as JWT.
-     * @returns The Id of the Data Resources registered.
-     */
-    registerDataResourceCredential(credential: string): Promise<string[]>;
-    /**
-     * Query the federated catalogue.
-     * @param id Service Offering id.
-     * @param providedBy The identity of the participant providing the Offering.
-     * @param cursor The cursor to request the next chunk of entities.
-     * @param limit Limit the number of entities to return.
-     * @returns 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.
-     */
-    queryServiceOfferings(id?: string, providedBy?: string, cursor?: string, limit?: number): Promise<IServiceOfferingList>;
-    /**
-     * Query the federated catalogue.
-     * @param id The id of the Data Resource.
-     * @param producedBy The identity of the participant producing the data behind the data resource.
-     * @param cursor The cursor to request the next chunk of entities.
-     * @param limit Limit the number of entities to return.
-     * @returns 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(id?: string, producedBy?: string, cursor?: string, limit?: number): Promise<IDataResourceList>;
-    /**
-     * Returns a Federated Catalogue entry.
-     * @param entryType The type of entry.
-     * @param entryId The entry's id.
-     * @returns Catalogue Entry
-     * @throws NotFoundError if not found.
-     */
-    getEntry(entryType: FederatedCatalogueEntryType, entryId: string): Promise<ICatalogueEntry>;
+     * Retrieve a dataset by its unique identifier.
+     * @param dataSetId The unique identifier of the dataset.
+     * @returns The dataset if found, or a CatalogError if not found or an error occurs.
+     */
+    get(dataSetId: string): Promise<IDcatDataset | IDataspaceProtocolCatalogError>;
+    /**
+     * Insert or update a dataset in the catalogue.
+     * This method is internal and should not be exposed via REST endpoints.
+     * @param dataSet The dataset to store.
+     * @returns Nothing.
+     */
+    set(dataSet: IDcatDataset): Promise<void>;
+    /**
+     * 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.
+     *
+     * @param filter The filter criteria containing @type.
+     * @param cursor Optional cursor for pagination.
+     * @param limit Optional limit for pagination.
+     * @returns Complete IDataspaceProtocolCatalog with @context, @id, @type, participantId, dataset/catalog,
+     * or IDataspaceProtocolCatalogError if no datasets found.
+     */
+    query(filter?: unknown[], cursor?: string, limit?: number): Promise<{
+        result: IDataspaceProtocolCatalog | IDataspaceProtocolCatalogError;
+        cursor?: string;
+    }>;
+    /**
+     * Remove a dataset from the catalogue by its unique identifier.
+     * @param dataSetId The unique identifier of the dataset to remove.
+     * @returns Nothing.
+     */
+    remove(dataSetId: string): Promise<void>;
 }

package/dist/types/models/IFederatedCatalogueFilter.d.ts

@@ -0,0 +1,30 @@
+import type { IComponent } from "@twin.org/core";
+import type { IDcatDataset } from "@twin.org/standards-w3c-dcat";
+/**
+ * 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.
+ */
+export interface IFederatedCatalogueFilter extends IComponent {
+    /**
+     * Execute a filter-specific query over the catalogue.
+     * Each filter interprets the payload according to its own semantics.
+     * @param filter The filter criteria (structure depends on the filter implementation).
+     * @param cursor The pagination cursor from the previous query, if any.
+     * @param limit The maximum number of results to return.
+     * @returns Object containing datasets matching the filter criteria and optional cursor for next page.
+     */
+    query(filter: unknown, cursor?: string, limit?: number): Promise<{
+        datasets: IDcatDataset[];
+        cursor?: string;
+    }>;
+    /**
+     * Generate filter indexes for a dataset to optimize future queries.
+     * Indexes are stored as properties on the dataset entity itself.
+     * @param dataSet The dataset to index.
+     * @returns Record mapping filter-specific index keys to values.
+     */
+    createIndex(dataSet: IDcatDataset): Promise<{
+        [key: string]: unknown;
+    }>;
+}

package/dist/types/models/api/ICatalogRequestRequest.d.ts

@@ -0,0 +1,24 @@
+import type { IDataspaceProtocolCatalogRequestMessage } from "@twin.org/standards-dataspace-protocol";
+/**
+ * The request parameters for the catalog request method.
+ */
+export interface ICatalogRequestRequest {
+    /**
+     * The request body containing the catalog query.
+     */
+    body: IDataspaceProtocolCatalogRequestMessage;
+    /**
+     * Optional query parameters for pagination.
+     * Used when following Link header URLs per DS Protocol spec.
+     */
+    query?: {
+        /**
+         * Opaque cursor token for pagination.
+         */
+        cursor?: string;
+        /**
+         * Limit for pagination.
+         */
+        limit?: string;
+    };
+}

package/dist/types/models/api/ICatalogRequestResponse.d.ts

@@ -0,0 +1,25 @@
+import type { IDataspaceProtocolCatalog, IDataspaceProtocolCatalogError } from "@twin.org/standards-dataspace-protocol";
+import type { HeaderTypes, HttpStatusCode } from "@twin.org/web";
+/**
+ * The response payload for the catalog request method.
+ * Returns a DS Protocol compliant Catalog with participantId, or CatalogError if no datasets found.
+ */
+export interface ICatalogRequestResponse {
+    /**
+     * Optional headers including RFC 8288 Link header for pagination.
+     */
+    headers?: {
+        [HeaderTypes.Link]?: string | string[];
+    };
+    /**
+     * Response status code.
+     * Per DS Protocol: Returns appropriate HTTP code (e.g., 404) when returning CatalogError.
+     */
+    statusCode?: HttpStatusCode;
+    /**
+     * The response payload containing the DS Protocol compliant catalog with participantId,
+     * or a CatalogError if no datasets are found (404).
+     * Per DS Protocol: Single participant returns flat catalog, multiple participants return nested catalogs.
+     */
+    body: IDataspaceProtocolCatalog | IDataspaceProtocolCatalogError;
+}

package/dist/types/models/api/IGetDatasetRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * The request parameters for the get dataset method.
+ */
+export interface IGetDatasetRequest {
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The unique identifier of the dataset.
+         */
+        datasetId: string;
+    };
+}

package/dist/types/models/api/IGetDatasetResponse.d.ts

@@ -0,0 +1,16 @@
+import type { IDataspaceProtocolCatalogError } from "@twin.org/standards-dataspace-protocol";
+import type { IDcatDataset } from "@twin.org/standards-w3c-dcat";
+import type { HttpStatusCode } from "@twin.org/web";
+/**
+ * The response payload for the get dataset method.
+ */
+export interface IGetDatasetResponse {
+    /**
+     * Response status code.
+     */
+    statusCode?: HttpStatusCode;
+    /**
+     * The response payload containing the dataset or error.
+     */
+    body: IDcatDataset | IDataspaceProtocolCatalogError;
+}

package/docs/changelog.md

@@ -1,143 +1,68 @@
 # @twin.org/federated-catalogue-models - Changelog
 
-## [0.0.2-next.6](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.2-next.5...federated-catalogue-models-v0.0.2-next.6) (2025-10-10)
-
-
-### Miscellaneous Chores
-
-* **federated-catalogue-models:** Synchronize repo versions
-
-## [0.0.2-next.5](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.2-next.4...federated-catalogue-models-v0.0.2-next.5) (2025-10-09)
-
-
-### Features
-
-* add validate-locales ([3d8d60d](https://github.com/twinfoundation/federated-catalogue/commit/3d8d60d9291e5a6f8c6d4562d6a862456a9917bc))
-* simplify node ([e80db0e](https://github.com/twinfoundation/federated-catalogue/commit/e80db0e1b4935daaa7ff7d4343280efaa6250bf8))
-
-## [0.0.2-next.4](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.2-next.3...federated-catalogue-models-v0.0.2-next.4) (2025-09-29)
-
-
-### Features
-
-* update to latest framework components ([aa30543](https://github.com/twinfoundation/federated-catalogue/commit/aa30543cef1309769d359d64fba0a85db490d69b))
-
-## [0.0.2-next.3](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.2-next.2...federated-catalogue-models-v0.0.2-next.3) (2025-08-29)
+## [0.0.3-next.10](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.3-next.9...federated-catalogue-models-v0.0.3-next.10) (2026-02-25)
 
 
 ### Features
 
-* eslint migration to flat config ([b5990d9](https://github.com/twinfoundation/federated-catalogue/commit/b5990d9ebdf403ac999da456052bee72787745de))
+* update json-ld patterns ([172aff0](https://github.com/twinfoundation/federated-catalogue/commit/172aff07d0f0b780f72d1be3a4896bbf12f6173a))
 
-## [0.0.2-next.2](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.2-next.1...federated-catalogue-models-v0.0.2-next.2) (2025-08-21)
+## [0.0.3-next.9](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.3-next.8...federated-catalogue-models-v0.0.3-next.9) (2026-02-12)
 
 
-### Features
+### Miscellaneous Chores
 
-* update framework core ([68293b6](https://github.com/twinfoundation/federated-catalogue/commit/68293b68aaf594d51431b942fa91e7cf7020a8d7))
+* **federated-catalogue-models:** Synchronize repo versions
 
-## [0.0.2-next.1](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.2-next.0...federated-catalogue-models-v0.0.2-next.1) (2025-07-15)
+## [0.0.3-next.8](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.3-next.7...federated-catalogue-models-v0.0.3-next.8) (2026-01-26)
 
 
 ### Features
 
-* add data types with fully qualified names ([993eb09](https://github.com/twinfoundation/federated-catalogue/commit/993eb09e25f6caad5d82a3908a2ba648900f5ca7))
-* consistent component naming with other repos ([83fc03d](https://github.com/twinfoundation/federated-catalogue/commit/83fc03dee3846600ae6a45d710248a0ae60af570))
-* synchronise with gaia-x types ([3e0d7f2](https://github.com/twinfoundation/federated-catalogue/commit/3e0d7f2f277ec0adef79d71165b6db778e15e315))
-* update dependencies ([24ff3d7](https://github.com/twinfoundation/federated-catalogue/commit/24ff3d772cf7bd7f60547c5b314355e75ba55424))
-* update schemas ([58d8581](https://github.com/twinfoundation/federated-catalogue/commit/58d85813231f6576490937d4394e7be0f6d8c58d))
-* update ts-to-schema generation ([41bdde7](https://github.com/twinfoundation/federated-catalogue/commit/41bdde7ff9f0cfa1ea4376b7a952bbaed9988d0a))
-* version 0 federated catalogue ([#2](https://github.com/twinfoundation/federated-catalogue/issues/2)) ([93fb8bd](https://github.com/twinfoundation/federated-catalogue/commit/93fb8bdbb03aa781ef9e8dc4053beea1b397cc36))
-
-
-### Bug Fixes
-
-* broken docs ([4588d86](https://github.com/twinfoundation/federated-catalogue/commit/4588d861575522da5374291167d57bacd1b21867))
-* query params force coercion ([a532329](https://github.com/twinfoundation/federated-catalogue/commit/a532329089b2b95c7f18cd8bd56ee47482755dc0))
+* use new hosting url for cursor links ([e42c934](https://github.com/twinfoundation/federated-catalogue/commit/e42c934b9c8748ec5bdd4803c1cdc05c82ccace8))
 
-## 0.0.1 (2025-07-10)
+## [0.0.3-next.7](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.3-next.6...federated-catalogue-models-v0.0.3-next.7) (2026-01-22)
 
 
-### Features
+### Miscellaneous Chores
 
-* release to production ([c9b5702](https://github.com/twinfoundation/federated-catalogue/commit/c9b570207fae4b31d43fa99e4df99be4baa34db2))
-* version 0 federated catalogue ([#2](https://github.com/twinfoundation/federated-catalogue/issues/2)) ([93fb8bd](https://github.com/twinfoundation/federated-catalogue/commit/93fb8bdbb03aa781ef9e8dc4053beea1b397cc36))
+* **federated-catalogue-models:** Synchronize repo versions
 
-## [0.0.1-next.11](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.1-next.10...federated-catalogue-models-v0.0.1-next.11) (2025-06-20)
+## [0.0.3-next.6](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.3-next.5...federated-catalogue-models-v0.0.3-next.6) (2026-01-20)
 
 
 ### Bug Fixes
 
-* query params force coercion ([a532329](https://github.com/twinfoundation/federated-catalogue/commit/a532329089b2b95c7f18cd8bd56ee47482755dc0))
-
-## [0.0.1-next.10](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.1-next.9...federated-catalogue-models-v0.0.1-next.10) (2025-06-18)
-
-
-### Features
-
-* update schemas ([58d8581](https://github.com/twinfoundation/federated-catalogue/commit/58d85813231f6576490937d4394e7be0f6d8c58d))
-
-## [0.0.1-next.9](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.1-next.8...federated-catalogue-models-v0.0.1-next.9) (2025-06-12)
-
-
-### Features
-
-* update dependencies ([24ff3d7](https://github.com/twinfoundation/federated-catalogue/commit/24ff3d772cf7bd7f60547c5b314355e75ba55424))
-
-## [0.0.1-next.8](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.1-next.7...federated-catalogue-models-v0.0.1-next.8) (2025-06-03)
-
-
-### Features
-
-* update ts-to-schema generation ([41bdde7](https://github.com/twinfoundation/federated-catalogue/commit/41bdde7ff9f0cfa1ea4376b7a952bbaed9988d0a))
-
-## [0.0.1-next.7](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.1-next.6...federated-catalogue-models-v0.0.1-next.7) (2025-05-28)
+* transform GuardError to CatalogError for DS Protocol compliance ([#49](https://github.com/twinfoundation/federated-catalogue/issues/49)) ([d0f1090](https://github.com/twinfoundation/federated-catalogue/commit/d0f10900c251b9abc18e58c90562c393c3265727))
 
-
-### Features
-
-* add data types with fully qualified names ([993eb09](https://github.com/twinfoundation/federated-catalogue/commit/993eb09e25f6caad5d82a3908a2ba648900f5ca7))
+## [0.0.3-next.5](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.3-next.4...federated-catalogue-models-v0.0.3-next.5) (2026-01-15)
 
 
 ### Bug Fixes
 
-* broken docs ([4588d86](https://github.com/twinfoundation/federated-catalogue/commit/4588d861575522da5374291167d57bacd1b21867))
-
-## [0.0.1-next.6](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.1-next.5...federated-catalogue-models-v0.0.1-next.6) (2025-05-23)
-
-
-### Miscellaneous Chores
-
-* **federated-catalogue-models:** Synchronize repo versions
+* pagination and ld context ([#45](https://github.com/twinfoundation/federated-catalogue/issues/45)) ([e36f096](https://github.com/twinfoundation/federated-catalogue/commit/e36f096aa4fdc61eb5b929a0fc4403247dbd41ce))
 
-## [0.0.1-next.5](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.1-next.4...federated-catalogue-models-v0.0.1-next.5) (2025-05-23)
+## [0.0.3-next.4](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.3-next.3...federated-catalogue-models-v0.0.3-next.4) (2026-01-06)
 
 
 ### Features
 
-* consistent component naming with other repos ([83fc03d](https://github.com/twinfoundation/federated-catalogue/commit/83fc03dee3846600ae6a45d710248a0ae60af570))
+* updates standards dependencies ([62f5d9c](https://github.com/twinfoundation/federated-catalogue/commit/62f5d9c6180bc27497ac43624ffd714e7ce65ce6))
 
-## [0.0.1-next.4](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.1-next.3...federated-catalogue-models-v0.0.1-next.4) (2025-05-23)
+## [0.0.3-next.3](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.3-next.2...federated-catalogue-models-v0.0.3-next.3) (2025-11-28)
 
 
 ### Miscellaneous Chores
 
 * **federated-catalogue-models:** Synchronize repo versions
 
-## [0.0.1-next.3](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.1-next.2...federated-catalogue-models-v0.0.1-next.3) (2025-05-22)
-
-
-### Features
-
-* version 0 federated catalogue ([#2](https://github.com/twinfoundation/federated-catalogue/issues/2)) ([93fb8bd](https://github.com/twinfoundation/federated-catalogue/commit/93fb8bdbb03aa781ef9e8dc4053beea1b397cc36))
-
-## [0.0.1-next.2](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.1-next.1...federated-catalogue-models-v0.0.1-next.2) (2025-05-22)
+## [0.0.3-next.2](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.3-next.1...federated-catalogue-models-v0.0.3-next.2) (2025-11-28)
 
 
 ### Features
 
-* version 0 federated catalogue ([#2](https://github.com/twinfoundation/federated-catalogue/issues/2)) ([93fb8bd](https://github.com/twinfoundation/federated-catalogue/commit/93fb8bdbb03aa781ef9e8dc4053beea1b397cc36))
+* implement Dataspace Protocol federated catalogue ([#36](https://github.com/twinfoundation/federated-catalogue/issues/36)) ([4765aba](https://github.com/twinfoundation/federated-catalogue/commit/4765aba4485ef8ad61e7ec1affbf0e454d974d36))
 
-## v0.0.1
+## v0.0.1-next.1
 
 - Initial Release