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

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

@@ -1,45 +1,12 @@
 // Copyright 2025 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
-export * from "./dataTypes/federatedCatalogueDataTypes.js";
-export * from "./models/api/ICatalogueEntryGetRequest.js";
-export * from "./models/api/ICompliancePresentationRequest.js";
-export * from "./models/api/IDataResourceGetResponse.js";
-export * from "./models/api/IDataResourceListRequest.js";
-export * from "./models/api/IDataResourceListResponse.js";
-export * from "./models/api/IDataSpaceConnectorGetResponse.js";
-export * from "./models/api/IDataSpaceConnectorListRequest.js";
-export * from "./models/api/IDataSpaceConnectorListResponse.js";
-export * from "./models/api/IFederatedCatalogueGetRequest.js";
-export * from "./models/api/IParticipantGetResponse.js";
-export * from "./models/api/IParticipantListRequest.js";
-export * from "./models/api/IParticipantListResponse.js";
-export * from "./models/api/IServiceOfferingGetResponse.js";
-export * from "./models/api/IServiceOfferingListRequest.js";
-export * from "./models/api/IServiceOfferingListResponse.js";
-export * from "./models/data-resource/IDataResourceCredential.js";
-export * from "./models/data-resource/IDataResourceEntry.js";
-export * from "./models/data-resource/IDataResourceList.js";
-export * from "./models/data-space-connector/IDataSpaceConnector.js";
-export * from "./models/data-space-connector/IDataSpaceConnectorCredential.js";
-export * from "./models/data-space-connector/IDataSpaceConnectorEntry.js";
-export * from "./models/data-space-connector/IDataSpaceConnectorList.js";
-export * from "./models/federatedCatalogueContextInstances.js";
+export * from "./factories/federatedCatalogueFilterFactory.js";
 export * from "./models/federatedCatalogueContexts.js";
-export * from "./models/federatedCatalogueContextType.js";
-export * from "./models/federatedCatalogueEntryType.js";
-export * from "./models/federatedCatalogueTypes.js";
-export * from "./models/ICatalogueEntry.js";
-export * from "./models/IComplianceCredential.js";
-export * from "./models/IComplianceEvidence.js";
-export * from "./models/IComplianceVerificationResult.js";
-export * from "./models/ICredential.js";
+export * from "./models/filters/IBaseFilter.js";
 export * from "./models/IFederatedCatalogueComponent.js";
-export * from "./models/IVerificationResult.js";
-export * from "./models/participant/IParticipantCredential.js";
-export * from "./models/participant/IParticipantEntry.js";
-export * from "./models/participant/IParticipantList.js";
-export * from "./models/service-offering/IServiceOfferingCredential.js";
-export * from "./models/service-offering/IServiceOfferingEntry.js";
-export * from "./models/service-offering/IServiceOfferingList.js";
-export * from "./models/verificationFailureReasons.js";
+export * from "./models/IFederatedCatalogueFilter.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";
 //# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,4CAA4C,CAAC;AAC3D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,gDAAgD,CAAC;AAC/D,cAAc,0CAA0C,CAAC;AACzD,cAAc,0CAA0C,CAAC;AACzD,cAAc,2CAA2C,CAAC;AAC1D,cAAc,gDAAgD,CAAC;AAC/D,cAAc,gDAAgD,CAAC;AAC/D,cAAc,iDAAiD,CAAC;AAChE,cAAc,+CAA+C,CAAC;AAC9D,cAAc,yCAAyC,CAAC;AACxD,cAAc,yCAAyC,CAAC;AACxD,cAAc,0CAA0C,CAAC;AACzD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,6CAA6C,CAAC;AAC5D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,mDAAmD,CAAC;AAClE,cAAc,8CAA8C,CAAC;AAC7D,cAAc,6CAA6C,CAAC;AAC5D,cAAc,sDAAsD,CAAC;AACrE,cAAc,gEAAgE,CAAC;AAC/E,cAAc,2DAA2D,CAAC;AAC1E,cAAc,0DAA0D,CAAC;AACzE,cAAc,gDAAgD,CAAC;AAC/D,cAAc,wCAAwC,CAAC;AACvD,cAAc,2CAA2C,CAAC;AAC1D,cAAc,yCAAyC,CAAC;AACxD,cAAc,qCAAqC,CAAC;AACpD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,mCAAmC,CAAC;AAClD,cAAc,iCAAiC,CAAC;AAChD,cAAc,2CAA2C,CAAC;AAC1D,cAAc,yBAAyB,CAAC;AACxC,cAAc,0CAA0C,CAAC;AACzD,cAAc,iCAAiC,CAAC;AAChD,cAAc,gDAAgD,CAAC;AAC/D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,0CAA0C,CAAC;AACzD,cAAc,yDAAyD,CAAC;AACxE,cAAc,oDAAoD,CAAC;AACnE,cAAc,mDAAmD,CAAC;AAClE,cAAc,wCAAwC,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./dataTypes/federatedCatalogueDataTypes.js\";\nexport * from \"./models/api/ICatalogueEntryGetRequest.js\";\nexport * from \"./models/api/ICompliancePresentationRequest.js\";\nexport * from \"./models/api/IDataResourceGetResponse.js\";\nexport * from \"./models/api/IDataResourceListRequest.js\";\nexport * from \"./models/api/IDataResourceListResponse.js\";\nexport * from \"./models/api/IDataSpaceConnectorGetResponse.js\";\nexport * from \"./models/api/IDataSpaceConnectorListRequest.js\";\nexport * from \"./models/api/IDataSpaceConnectorListResponse.js\";\nexport * from \"./models/api/IFederatedCatalogueGetRequest.js\";\nexport * from \"./models/api/IParticipantGetResponse.js\";\nexport * from \"./models/api/IParticipantListRequest.js\";\nexport * from \"./models/api/IParticipantListResponse.js\";\nexport * from \"./models/api/IServiceOfferingGetResponse.js\";\nexport * from \"./models/api/IServiceOfferingListRequest.js\";\nexport * from \"./models/api/IServiceOfferingListResponse.js\";\nexport * from \"./models/data-resource/IDataResourceCredential.js\";\nexport * from \"./models/data-resource/IDataResourceEntry.js\";\nexport * from \"./models/data-resource/IDataResourceList.js\";\nexport * from \"./models/data-space-connector/IDataSpaceConnector.js\";\nexport * from \"./models/data-space-connector/IDataSpaceConnectorCredential.js\";\nexport * from \"./models/data-space-connector/IDataSpaceConnectorEntry.js\";\nexport * from \"./models/data-space-connector/IDataSpaceConnectorList.js\";\nexport * from \"./models/federatedCatalogueContextInstances.js\";\nexport * from \"./models/federatedCatalogueContexts.js\";\nexport * from \"./models/federatedCatalogueContextType.js\";\nexport * from \"./models/federatedCatalogueEntryType.js\";\nexport * from \"./models/federatedCatalogueTypes.js\";\nexport * from \"./models/ICatalogueEntry.js\";\nexport * from \"./models/IComplianceCredential.js\";\nexport * from \"./models/IComplianceEvidence.js\";\nexport * from \"./models/IComplianceVerificationResult.js\";\nexport * from \"./models/ICredential.js\";\nexport * from \"./models/IFederatedCatalogueComponent.js\";\nexport * from \"./models/IVerificationResult.js\";\nexport * from \"./models/participant/IParticipantCredential.js\";\nexport * from \"./models/participant/IParticipantEntry.js\";\nexport * from \"./models/participant/IParticipantList.js\";\nexport * from \"./models/service-offering/IServiceOfferingCredential.js\";\nexport * from \"./models/service-offering/IServiceOfferingEntry.js\";\nexport * from \"./models/service-offering/IServiceOfferingList.js\";\nexport * from \"./models/verificationFailureReasons.js\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,gDAAgD,CAAC;AAE/D,cAAc,wCAAwC,CAAC;AACvD,cAAc,iCAAiC,CAAC;AAChD,cAAc,0CAA0C,CAAC;AACzD,cAAc,uCAAuC,CAAC;AAEtD,cAAc,wCAAwC,CAAC;AACvD,cAAc,yCAAyC,CAAC;AACxD,cAAc,oCAAoC,CAAC;AACnD,cAAc,qCAAqC,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./factories/federatedCatalogueFilterFactory.js\";\n\nexport * from \"./models/federatedCatalogueContexts.js\";\nexport * from \"./models/filters/IBaseFilter.js\";\nexport * from \"./models/IFederatedCatalogueComponent.js\";\nexport * from \"./models/IFederatedCatalogueFilter.js\";\n\nexport * from \"./models/api/ICatalogRequestRequest.js\";\nexport * from \"./models/api/ICatalogRequestResponse.js\";\nexport * from \"./models/api/IGetDatasetRequest.js\";\nexport * from \"./models/api/IGetDatasetResponse.js\";\n"]}

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

@@ -1 +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 { IDataResourceList } from \"./data-resource/IDataResourceList.js\";\nimport type { IDataSpaceConnectorList } from \"./data-space-connector/IDataSpaceConnectorList.js\";\nimport type { FederatedCatalogueEntryType } from \"./federatedCatalogueEntryType.js\";\nimport type { ICatalogueEntry } from \"./ICatalogueEntry.js\";\nimport type { IParticipantList } from \"./participant/IParticipantList.js\";\nimport type { IServiceOfferingList } from \"./service-offering/IServiceOfferingList.js\";\n\n/**\n * Interface describing a Federated Catalogue Contract.\n */\nexport interface IFederatedCatalogueComponent extends IComponent {\n\t/**\n\t * Registers a Participant's compliance Credential to the service.\n\t * @param credential The credential as JWT.\n\t * @returns The participant Id (usually a DID).\n\t */\n\tregisterComplianceCredential(credential: string): Promise<string>;\n\n\t/**\n\t * Query the federated catalogue.\n\t * @param participant The identity of the participant.\n\t * @param legalRegistrationNumber The legal registration number.\n\t * @param lrnType The legal registration number type (EORI, VATID, GLEIF, Kenya's PIN, etc.)\n\t * @param cursor The cursor to request the next chunk of entities.\n\t * @param limit Limit the number of entities to return.\n\t * @returns All the entities for the storage matching the conditions,\n\t * and a cursor which can be used to request more entities.\n\t * @throws NotImplementedError if the implementation does not support retrieval.\n\t */\n\tqueryParticipants(\n\t\tparticipant?: string,\n\t\tlegalRegistrationNumber?: string,\n\t\tlrnType?: string,\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<IParticipantList>;\n\n\t/**\n\t * Registers a Data Space Connector to the service.\n\t * @param credential The credential as JWT.\n\t * @returns The Data Space Connector Id registered.\n\t */\n\tregisterDataSpaceConnectorCredential(credential: string): Promise<string>;\n\n\t/**\n\t * Query the federated catalogue.\n\t * @param id Data Space Connector Id.\n\t * @param maintainer The identity of the participant maintaining the Data Space Connector.\n\t * @param cursor The cursor to request the next chunk of entities.\n\t * @param limit Limit the number of entities to return.\n\t * @returns All the entities for the storage matching the conditions,\n\t * and a cursor which can be used to request more entities.\n\t * @throws NotImplementedError if the implementation does not support retrieval.\n\t */\n\tqueryDataSpaceConnectors(\n\t\tid?: string,\n\t\tmaintainer?: string,\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<IDataSpaceConnectorList>;\n\n\t/**\n\t * Registers a service offering Credential to the service.\n\t * @param credential The credential as JWT.\n\t * @returns The Id of the Service Offerings registered.\n\t */\n\tregisterServiceOfferingCredential(credential: string): Promise<string[]>;\n\n\t/**\n\t * Registers a data resource Credential to the service.\n\t * @param credential The credential as JWT.\n\t * @returns The Id of the Data Resources registered.\n\t */\n\tregisterDataResourceCredential(credential: string): Promise<string[]>;\n\n\t/**\n\t * Query the federated catalogue.\n\t * @param id Service Offering id.\n\t * @param providedBy The identity of the participant providing the Offering.\n\t * @param cursor The cursor to request the next chunk of entities.\n\t * @param limit Limit the number of entities to return.\n\t * @returns All the entities for the storage matching the conditions,\n\t * and a cursor which can be used to request more entities.\n\t * @throws NotImplementedError if the implementation does not support retrieval.\n\t */\n\tqueryServiceOfferings(\n\t\tid?: string,\n\t\tprovidedBy?: string,\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<IServiceOfferingList>;\n\n\t/**\n\t * Query the federated catalogue.\n\t * @param id The id of the Data Resource.\n\t * @param producedBy The identity of the participant producing the data behind the data resource.\n\t * @param cursor The cursor to request the next chunk of entities.\n\t * @param limit Limit the number of entities to return.\n\t * @returns All the entities for the storage matching the conditions,\n\t * and a cursor which can be used to request more entities.\n\t * @throws NotImplementedError if the implementation does not support retrieval.\n\t */\n\tqueryDataResources(\n\t\tid?: string,\n\t\tproducedBy?: string,\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<IDataResourceList>;\n\n\t/**\n\t * Returns a Federated Catalogue entry.\n\t * @param entryType The type of entry.\n\t * @param entryId The entry's id.\n\t * @returns Catalogue Entry\n\t * @throws NotFoundError if not found.\n\t */\n\tgetEntry(entryType: FederatedCatalogueEntryType, entryId: string): Promise<ICatalogueEntry>;\n}\n"]}
+{"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 { ICatalog, IDataset } 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.\n\t * @throws NotFoundError if the dataset does not exist.\n\t */\n\tget(dataSetId: string): Promise<IDataset>;\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: IDataset): Promise<void>;\n\n\t/**\n\t * Execute a query against the catalogue using registered filter plugins.\n\t * Returns a complete DCAT Catalog object with proper JSON-LD context, metadata, and datasets.\n\t * Filter plugins must be registered in FilterFactory before service initialization.\n\t * The filter payload is evaluated by the appropriate filter plugin based on its structure.\n\t * Pagination properties (cursor, limit) and filter type (@type) should be included\n\t * within the filter object per Eclipse Dataspace Protocol JSON-LD extension patterns.\n\t * @param filter The filter criteria containing @type, optional cursor and limit properties.\n\t * @returns Complete ICatalog object with @context, @id, @type, dcat:dataset, and optional cursor.\n\t * @throws NotFoundError if the @type field is missing or if the filter type is not registered.\n\t */\n\tquery(filter?: unknown[]): Promise<ICatalog>;\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 { IDataset } 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 * Pagination properties (cursor, limit) are extracted from the filter object by the service layer.\n\t * @param filter The filter criteria (structure depends on the filter implementation).\n\t * @returns Object containing datasets matching the filter criteria and optional cursor for next page.\n\t */\n\tquery(filter: unknown): Promise<{ datasets: IDataset[]; 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: IDataset): 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 { ICatalogRequestMessage } 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: ICatalogRequestMessage;\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 { ICatalog } from \"@twin.org/standards-w3c-dcat\";\n\n/**\n * The response payload for the catalog request method.\n */\nexport interface ICatalogRequestResponse {\n\t/**\n\t * The response payload containing the catalog with matching datasets.\n\t */\n\tbody: ICatalog;\n}\n"]}

package/dist/es/models/{ICatalogueBase.js → api/IGetDatasetRequest.js}

@@ -1,4 +1,4 @@
 // Copyright 2025 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 export {};
-//# sourceMappingURL=ICatalogueBase.js.map
+//# 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 { IDataset } from \"@twin.org/standards-w3c-dcat\";\n\n/**\n * The response payload for the get dataset method.\n */\nexport interface IGetDatasetResponse {\n\t/**\n\t * The response payload containing the dataset.\n\t */\n\tbody: IDataset;\n}\n"]}

package/dist/es/models/federatedCatalogueContexts.js

@@ -1,7 +1,7 @@
-// Copyright 2025 IOTA Stiftung.
+// Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
- * The LD context concerning the Federated Catalogue.
+ * The contexts of federated catalogue data.
  */
 // eslint-disable-next-line @typescript-eslint/naming-convention
 export const FederatedCatalogueContexts = {

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

@@ -1 +1 @@
-{"version":3,"file":"federatedCatalogueContexts.js","sourceRoot":"","sources":["../../../src/models/federatedCatalogueContexts.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,0BAA0B,GAAG;IACzC;;OAEG;IACH,WAAW,EAAE,iDAAiD;CACrD,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The LD context concerning the Federated Catalogue.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const FederatedCatalogueContexts = {\n\t/**\n\t * The context root for the federated catalogue types.\n\t */\n\tContextRoot: \"https://schema.twindev.org/federated-catalogue/\"\n} as const;\n\n/**\n * The Exported types\n */\nexport type FederatedCatalogueContexts =\n\t(typeof FederatedCatalogueContexts)[keyof typeof FederatedCatalogueContexts];\n"]}
+{"version":3,"file":"federatedCatalogueContexts.js","sourceRoot":"","sources":["../../../src/models/federatedCatalogueContexts.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,0BAA0B,GAAG;IACzC;;OAEG;IACH,WAAW,EAAE,iDAAiD;CACrD,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The contexts of federated catalogue data.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const FederatedCatalogueContexts = {\n\t/**\n\t * The context root for the federated catalogue types.\n\t */\n\tContextRoot: \"https://schema.twindev.org/federated-catalogue/\"\n} as const;\n\n/**\n * The contexts of federated catalogue data.\n */\nexport type FederatedCatalogueContexts =\n\t(typeof FederatedCatalogueContexts)[keyof typeof FederatedCatalogueContexts];\n"]}

package/dist/es/models/filters/IBaseFilter.js

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

package/dist/es/models/filters/IBaseFilter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IBaseFilter.js","sourceRoot":"","sources":["../../../../src/models/filters/IBaseFilter.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\n\n/**\n * Base filter interface with pagination support.\n * All filter objects in the federated catalogue extend this base.\n *\n * Per Eclipse Dataspace Protocol constraints, cursor and limit cannot be\n * top-level properties in CatalogRequestMessage. They must be embedded\n * within the filter object using a custom JSON-LD vocabulary.\n *\n * After JSON-LD compaction, properties use direct names (cursor, limit) rather\n * than prefixed names. Each filter implementation should extend this interface\n * to define its own filter-specific properties.\n */\nexport interface IBaseFilter extends IJsonLdNodeObject {\n\t/**\n\t * Filter type discriminator.\n\t * Used to route filter to appropriate filter implementation.\n\t * Example: \"FilterByExample\", \"FilterByPolicy\", etc.\n\t * Required for filter routing.\n\t */\n\t\"@type\": string;\n\n\t/**\n\t * Optional cursor for pagination.\n\t * When provided, returns results starting after this cursor.\n\t * Namespace: https://schema.twindev.org/federated-catalogue/cursor\n\t */\n\tcursor?: string;\n\n\t/**\n\t * Optional limit for number of results.\n\t * Defaults to implementation-specific value if not provided.\n\t * Namespace: https://schema.twindev.org/federated-catalogue/limit\n\t */\n\tlimit?: number;\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,9 @@
-export * from "./dataTypes/federatedCatalogueDataTypes.js";
-export * from "./models/api/ICatalogueEntryGetRequest.js";
-export * from "./models/api/ICompliancePresentationRequest.js";
-export * from "./models/api/IDataResourceGetResponse.js";
-export * from "./models/api/IDataResourceListRequest.js";
-export * from "./models/api/IDataResourceListResponse.js";
-export * from "./models/api/IDataSpaceConnectorGetResponse.js";
-export * from "./models/api/IDataSpaceConnectorListRequest.js";
-export * from "./models/api/IDataSpaceConnectorListResponse.js";
-export * from "./models/api/IFederatedCatalogueGetRequest.js";
-export * from "./models/api/IParticipantGetResponse.js";
-export * from "./models/api/IParticipantListRequest.js";
-export * from "./models/api/IParticipantListResponse.js";
-export * from "./models/api/IServiceOfferingGetResponse.js";
-export * from "./models/api/IServiceOfferingListRequest.js";
-export * from "./models/api/IServiceOfferingListResponse.js";
-export * from "./models/data-resource/IDataResourceCredential.js";
-export * from "./models/data-resource/IDataResourceEntry.js";
-export * from "./models/data-resource/IDataResourceList.js";
-export * from "./models/data-space-connector/IDataSpaceConnector.js";
-export * from "./models/data-space-connector/IDataSpaceConnectorCredential.js";
-export * from "./models/data-space-connector/IDataSpaceConnectorEntry.js";
-export * from "./models/data-space-connector/IDataSpaceConnectorList.js";
-export * from "./models/federatedCatalogueContextInstances.js";
+export * from "./factories/federatedCatalogueFilterFactory.js";
 export * from "./models/federatedCatalogueContexts.js";
-export * from "./models/federatedCatalogueContextType.js";
-export * from "./models/federatedCatalogueEntryType.js";
-export * from "./models/federatedCatalogueTypes.js";
-export * from "./models/ICatalogueEntry.js";
-export * from "./models/IComplianceCredential.js";
-export * from "./models/IComplianceEvidence.js";
-export * from "./models/IComplianceVerificationResult.js";
-export * from "./models/ICredential.js";
+export * from "./models/filters/IBaseFilter.js";
 export * from "./models/IFederatedCatalogueComponent.js";
-export * from "./models/IVerificationResult.js";
-export * from "./models/participant/IParticipantCredential.js";
-export * from "./models/participant/IParticipantEntry.js";
-export * from "./models/participant/IParticipantList.js";
-export * from "./models/service-offering/IServiceOfferingCredential.js";
-export * from "./models/service-offering/IServiceOfferingEntry.js";
-export * from "./models/service-offering/IServiceOfferingList.js";
-export * from "./models/verificationFailureReasons.js";
+export * from "./models/IFederatedCatalogueFilter.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";

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

@@ -1,89 +1,40 @@
 import type { IComponent } from "@twin.org/core";
-import type { IDataResourceList } from "./data-resource/IDataResourceList.js";
-import type { IDataSpaceConnectorList } from "./data-space-connector/IDataSpaceConnectorList.js";
-import type { FederatedCatalogueEntryType } from "./federatedCatalogueEntryType.js";
-import type { ICatalogueEntry } from "./ICatalogueEntry.js";
-import type { IParticipantList } from "./participant/IParticipantList.js";
-import type { IServiceOfferingList } from "./service-offering/IServiceOfferingList.js";
+import type { ICatalog, IDataset } 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).
+     * Retrieve a dataset by its unique identifier.
+     * @param dataSetId The unique identifier of the dataset.
+     * @returns The dataset if found.
+     * @throws NotFoundError if the dataset does not exist.
      */
-    registerComplianceCredential(credential: string): Promise<string>;
+    get(dataSetId: string): Promise<IDataset>;
     /**
-     * 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.
+     * 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.
      */
-    queryParticipants(participant?: string, legalRegistrationNumber?: string, lrnType?: string, cursor?: string, limit?: number): Promise<IParticipantList>;
+    set(dataSet: IDataset): Promise<void>;
     /**
-     * Registers a Data Space Connector to the service.
-     * @param credential The credential as JWT.
-     * @returns The Data Space Connector Id registered.
+     * 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.
+     * @param filter The filter criteria containing @type, optional cursor and limit properties.
+     * @returns Complete ICatalog object with @context, @id, @type, dcat:dataset, and optional cursor.
+     * @throws NotFoundError if the @type field is missing or if the filter type is not registered.
      */
-    registerDataSpaceConnectorCredential(credential: string): Promise<string>;
+    query(filter?: unknown[]): Promise<ICatalog>;
     /**
-     * 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.
+     * Remove a dataset from the catalogue by its unique identifier.
+     * @param dataSetId The unique identifier of the dataset to remove.
+     * @returns Nothing.
      */
-    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>;
+    remove(dataSetId: string): Promise<void>;
 }

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

@@ -0,0 +1,29 @@
+import type { IComponent } from "@twin.org/core";
+import type { IDataset } 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.
+     * Pagination properties (cursor, limit) are extracted from the filter object by the service layer.
+     * @param filter The filter criteria (structure depends on the filter implementation).
+     * @returns Object containing datasets matching the filter criteria and optional cursor for next page.
+     */
+    query(filter: unknown): Promise<{
+        datasets: IDataset[];
+        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: IDataset): Promise<{
+        [key: string]: unknown;
+    }>;
+}

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

@@ -0,0 +1,10 @@
+import type { ICatalogRequestMessage } 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: ICatalogRequestMessage;
+}

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

@@ -0,0 +1,10 @@
+import type { ICatalog } from "@twin.org/standards-w3c-dcat";
+/**
+ * The response payload for the catalog request method.
+ */
+export interface ICatalogRequestResponse {
+    /**
+     * The response payload containing the catalog with matching datasets.
+     */
+    body: ICatalog;
+}

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,10 @@
+import type { IDataset } from "@twin.org/standards-w3c-dcat";
+/**
+ * The response payload for the get dataset method.
+ */
+export interface IGetDatasetResponse {
+    /**
+     * The response payload containing the dataset.
+     */
+    body: IDataset;
+}

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

@@ -1,5 +1,5 @@
 /**
- * The LD context concerning the Federated Catalogue.
+ * The contexts of federated catalogue data.
  */
 export declare const FederatedCatalogueContexts: {
     /**
@@ -8,6 +8,6 @@ export declare const FederatedCatalogueContexts: {
     readonly ContextRoot: "https://schema.twindev.org/federated-catalogue/";
 };
 /**
- * The Exported types
+ * The contexts of federated catalogue data.
  */
 export type FederatedCatalogueContexts = (typeof FederatedCatalogueContexts)[keyof typeof FederatedCatalogueContexts];

package/dist/types/models/filters/IBaseFilter.d.ts

@@ -0,0 +1,34 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+/**
+ * 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.
+ */
+export interface IBaseFilter extends IJsonLdNodeObject {
+    /**
+     * Filter type discriminator.
+     * Used to route filter to appropriate filter implementation.
+     * Example: "FilterByExample", "FilterByPolicy", etc.
+     * Required for filter routing.
+     */
+    "@type": string;
+    /**
+     * Optional cursor for pagination.
+     * When provided, returns results starting after this cursor.
+     * Namespace: https://schema.twindev.org/federated-catalogue/cursor
+     */
+    cursor?: string;
+    /**
+     * Optional limit for number of results.
+     * Defaults to implementation-specific value if not provided.
+     * Namespace: https://schema.twindev.org/federated-catalogue/limit
+     */
+    limit?: number;
+}