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

package/README.md

@@ -1,6 +1,6 @@
 # Federated Catalogue Models
 
-Models which define the structure of the Federated Catalogue.
+This package defines shared data contracts for catalogue interactions, including request and response models used by service and client components. It provides a stable schema layer so integrations can exchange catalogue data in a consistent format.
 
 ## Installation
 

package/dist/es/index.js

@@ -1,12 +1,14 @@
 // Copyright 2025 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 export * from "./factories/federatedCatalogueFilterFactory.js";
-export * from "./models/federatedCatalogueContexts.js";
-export * from "./models/filters/IBaseFilter.js";
-export * from "./models/IFederatedCatalogueComponent.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";
+export * from "./models/api/IDatasetGetRequest.js";
+export * from "./models/api/IDatasetGetResponse.js";
+export * from "./models/api/IDatasetRemoveRequest.js";
+export * from "./models/api/IDatasetRemoveResponse.js";
+export * from "./models/api/IDatasetSetRequest.js";
+export * from "./models/api/IDatasetSetResponse.js";
+export * from "./models/IFederatedCatalogueComponent.js";
+export * from "./models/IFederatedCatalogueFilter.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,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"]}
+{"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,uCAAuC,CAAC;AACtD,cAAc,wCAAwC,CAAC;AACvD,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/IDatasetGetRequest.js\";\nexport * from \"./models/api/IDatasetGetResponse.js\";\nexport * from \"./models/api/IDatasetRemoveRequest.js\";\nexport * from \"./models/api/IDatasetRemoveResponse.js\";\nexport * from \"./models/api/IDatasetSetRequest.js\";\nexport * from \"./models/api/IDatasetSetResponse.js\";\nexport * from \"./models/IFederatedCatalogueComponent.js\";\nexport * from \"./models/IFederatedCatalogueFilter.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 { 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"]}
+{"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 * @param trustPayload Optional payload for trust evaluation, if applicable.\n\t * @returns The dataset if found, or a CatalogError if not found or an error occurs.\n\t */\n\tget(\n\t\tdatasetId: string,\n\t\ttrustPayload: unknown\n\t): 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 * @param trustPayload Optional payload for trust evaluation, if applicable.\n\t * @returns The unique identifier of the stored dataset, or a CatalogError if an error occurs.\n\t */\n\tset(\n\t\tdataset: IDcatDataset,\n\t\ttrustPayload: unknown\n\t): Promise<string | IDataspaceProtocolCatalogError>;\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 * @param trustPayload Optional payload for trust evaluation, if applicable.\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[] | undefined,\n\t\tcursor: string | undefined,\n\t\tlimit: number | undefined,\n\t\ttrustPayload: unknown\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 * @param trustPayload Optional payload for trust evaluation, if applicable.\n\t * @returns Nothing.\n\t */\n\tremove(\n\t\tdatasetId: string,\n\t\ttrustPayload: unknown\n\t): Promise<IDataspaceProtocolCatalogError | undefined>;\n}\n"]}

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

@@ -1 +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"]}
+{"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\";\nimport type { ITrustVerificationInfo } from \"@twin.org/trust-models\";\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 trustInfo The trust verification information for the current request.\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\ttrustInfo: ITrustVerificationInfo,\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.map

@@ -1 +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"]}
+{"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\";\nimport type { HeaderTypes } from \"@twin.org/web\";\n\n/**\n * The request parameters for the catalog request method.\n */\nexport interface ICatalogRequestRequest {\n\t/**\n\t * The request headers. Authorization header carries the trust token (Bearer scheme).\n\t */\n\theaders?: {\n\t\t[HeaderTypes.Authorization]?: string;\n\t};\n\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.map

@@ -1 +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"]}
+{"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/IDatasetGetRequest.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IDatasetGetRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IDatasetGetRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes } from \"@twin.org/web\";\n\n/**\n * The request parameters for the get dataset method.\n */\nexport interface IDatasetGetRequest {\n\t/**\n\t * The request headers. Authorization header carries the trust token (Bearer scheme).\n\t */\n\theaders?: {\n\t\t[HeaderTypes.Authorization]?: string;\n\t};\n\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/IDatasetGetResponse.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IDatasetGetResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IDatasetGetResponse.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 IDatasetGetResponse {\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/es/models/api/IDatasetRemoveRequest.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IDatasetRemoveRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IDatasetRemoveRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes } from \"@twin.org/web\";\n\n/**\n * The request parameters for the remove dataset method.\n */\nexport interface IDatasetRemoveRequest {\n\t/**\n\t * The request headers. Authorization header carries the trust token (Bearer scheme).\n\t */\n\theaders?: {\n\t\t[HeaderTypes.Authorization]?: string;\n\t};\n\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/IDatasetRemoveResponse.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IDatasetRemoveResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IDatasetRemoveResponse.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 { HttpStatusCode } from \"@twin.org/web\";\n\n/**\n * The response payload for the remove dataset method.\n */\nexport interface IDatasetRemoveResponse {\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?: IDataspaceProtocolCatalogError;\n}\n"]}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IDatasetSetRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IDatasetSetRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDcatDataset } from \"@twin.org/standards-w3c-dcat\";\nimport type { HeaderTypes } from \"@twin.org/web\";\n\n/**\n * The request parameters for the set dataset method.\n */\nexport interface IDatasetSetRequest {\n\t/**\n\t * The request headers. Authorization header carries the trust token (Bearer scheme).\n\t */\n\theaders?: {\n\t\t[HeaderTypes.Authorization]?: string;\n\t};\n\n\t/**\n\t * The response payload containing the dataset or error.\n\t */\n\tbody: IDcatDataset;\n}\n"]}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IDatasetSetResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IDatasetSetResponse.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 { HeaderTypes, HttpStatusCode } from \"@twin.org/web\";\n\n/**\n * The response payload for the set dataset method.\n */\nexport interface IDatasetSetResponse {\n\t/**\n\t * Response status code.\n\t */\n\tstatusCode?: HttpStatusCode;\n\n\t/**\n\t * Optional headers.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.Location]?: string;\n\t};\n\n\t/**\n\t * The response payload containing the dataset or error.\n\t */\n\tbody?: IDataspaceProtocolCatalogError;\n}\n"]}

package/dist/types/index.d.ts

@@ -1,9 +1,11 @@
 export * from "./factories/federatedCatalogueFilterFactory.js";
-export * from "./models/federatedCatalogueContexts.js";
-export * from "./models/filters/IBaseFilter.js";
-export * from "./models/IFederatedCatalogueComponent.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";
+export * from "./models/api/IDatasetGetRequest.js";
+export * from "./models/api/IDatasetGetResponse.js";
+export * from "./models/api/IDatasetRemoveRequest.js";
+export * from "./models/api/IDatasetRemoveResponse.js";
+export * from "./models/api/IDatasetSetRequest.js";
+export * from "./models/api/IDatasetSetResponse.js";
+export * from "./models/IFederatedCatalogueComponent.js";
+export * from "./models/IFederatedCatalogueFilter.js";

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

@@ -1,5 +1,6 @@
 import type { IComponent } from "@twin.org/core";
-import type { ICatalog, IDataset } from "@twin.org/standards-w3c-dcat";
+import type { IDataspaceProtocolCatalog, IDataspaceProtocolCatalogError } from "@twin.org/standards-dataspace-protocol";
+import type { IDcatDataset } from "@twin.org/standards-w3c-dcat";
 /**
  * Interface describing a federated catalogue component.
  * Provides Dataspace Protocol-compliant catalog endpoints for dataset registry and query.
@@ -7,34 +8,46 @@ import type { ICatalog, IDataset } from "@twin.org/standards-w3c-dcat";
 export interface IFederatedCatalogueComponent extends IComponent {
     /**
      * 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.
+     * @param datasetId The unique identifier of the dataset.
+     * @param trustPayload Optional payload for trust evaluation, if applicable.
+     * @returns The dataset if found, or a CatalogError if not found or an error occurs.
      */
-    get(dataSetId: string): Promise<IDataset>;
+    get(datasetId: string, trustPayload: unknown): 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.
+     * @param dataset The dataset to store.
+     * @param trustPayload Optional payload for trust evaluation, if applicable.
+     * @returns The unique identifier of the stored dataset, or a CatalogError if an error occurs.
      */
-    set(dataSet: IDataset): Promise<void>;
+    set(dataset: IDcatDataset, trustPayload: unknown): Promise<string | IDataspaceProtocolCatalogError>;
     /**
      * 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.
+     * 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.
+     * @param trustPayload Optional payload for trust evaluation, if applicable.
+     * @returns Complete IDataspaceProtocolCatalog with @context, @id, @type, participantId, dataset/catalog,
+     * or IDataspaceProtocolCatalogError if no datasets found.
      */
-    query(filter?: unknown[]): Promise<ICatalog>;
+    query(filter: unknown[] | undefined, cursor: string | undefined, limit: number | undefined, trustPayload: unknown): 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.
+     * @param datasetId The unique identifier of the dataset to remove.
+     * @param trustPayload Optional payload for trust evaluation, if applicable.
      * @returns Nothing.
      */
-    remove(dataSetId: string): Promise<void>;
+    remove(datasetId: string, trustPayload: unknown): Promise<IDataspaceProtocolCatalogError | undefined>;
 }

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

@@ -1,5 +1,6 @@
 import type { IComponent } from "@twin.org/core";
-import type { IDataset } from "@twin.org/standards-w3c-dcat";
+import type { IDcatDataset } from "@twin.org/standards-w3c-dcat";
+import type { ITrustVerificationInfo } from "@twin.org/trust-models";
 /**
  * Interface describing a filter plugin for the federated catalogue.
  * Filter plugins provide extensible query semantics and indexing strategies.
@@ -9,21 +10,23 @@ 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 trustInfo The trust verification information for the current request.
      * @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): Promise<{
-        datasets: IDataset[];
+    query(trustInfo: ITrustVerificationInfo, 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.
+     * @param dataset The dataset to index.
      * @returns Record mapping filter-specific index keys to values.
      */
-    createIndex(dataSet: IDataset): Promise<{
+    createIndex(dataset: IDcatDataset): Promise<{
         [key: string]: unknown;
     }>;
 }

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

@@ -1,10 +1,31 @@
-import type { ICatalogRequestMessage } from "@twin.org/standards-dataspace-protocol";
+import type { IDataspaceProtocolCatalogRequestMessage } from "@twin.org/standards-dataspace-protocol";
+import type { HeaderTypes } from "@twin.org/web";
 /**
  * The request parameters for the catalog request method.
  */
 export interface ICatalogRequestRequest {
+    /**
+     * The request headers. Authorization header carries the trust token (Bearer scheme).
+     */
+    headers?: {
+        [HeaderTypes.Authorization]?: string;
+    };
     /**
      * The request body containing the catalog query.
      */
-    body: ICatalogRequestMessage;
+    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

@@ -1,10 +1,25 @@
-import type { ICatalog } from "@twin.org/standards-w3c-dcat";
+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 {
     /**
-     * The response payload containing the catalog with matching datasets.
+     * Optional headers including RFC 8288 Link header for pagination.
      */
-    body: ICatalog;
+    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/IDatasetGetRequest.d.ts

@@ -0,0 +1,21 @@
+import type { HeaderTypes } from "@twin.org/web";
+/**
+ * The request parameters for the get dataset method.
+ */
+export interface IDatasetGetRequest {
+    /**
+     * The request headers. Authorization header carries the trust token (Bearer scheme).
+     */
+    headers?: {
+        [HeaderTypes.Authorization]?: string;
+    };
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The unique identifier of the dataset.
+         */
+        datasetId: string;
+    };
+}

package/dist/types/models/api/IDatasetGetResponse.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 IDatasetGetResponse {
+    /**
+     * Response status code.
+     */
+    statusCode?: HttpStatusCode;
+    /**
+     * The response payload containing the dataset or error.
+     */
+    body: IDcatDataset | IDataspaceProtocolCatalogError;
+}

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

@@ -0,0 +1,21 @@
+import type { HeaderTypes } from "@twin.org/web";
+/**
+ * The request parameters for the remove dataset method.
+ */
+export interface IDatasetRemoveRequest {
+    /**
+     * The request headers. Authorization header carries the trust token (Bearer scheme).
+     */
+    headers?: {
+        [HeaderTypes.Authorization]?: string;
+    };
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The unique identifier of the dataset.
+         */
+        datasetId: string;
+    };
+}

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

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

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

@@ -0,0 +1,17 @@
+import type { IDcatDataset } from "@twin.org/standards-w3c-dcat";
+import type { HeaderTypes } from "@twin.org/web";
+/**
+ * The request parameters for the set dataset method.
+ */
+export interface IDatasetSetRequest {
+    /**
+     * The request headers. Authorization header carries the trust token (Bearer scheme).
+     */
+    headers?: {
+        [HeaderTypes.Authorization]?: string;
+    };
+    /**
+     * The response payload containing the dataset or error.
+     */
+    body: IDcatDataset;
+}

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

@@ -0,0 +1,21 @@
+import type { IDataspaceProtocolCatalogError } from "@twin.org/standards-dataspace-protocol";
+import type { HeaderTypes, HttpStatusCode } from "@twin.org/web";
+/**
+ * The response payload for the set dataset method.
+ */
+export interface IDatasetSetResponse {
+    /**
+     * Response status code.
+     */
+    statusCode?: HttpStatusCode;
+    /**
+     * Optional headers.
+     */
+    headers?: {
+        [HeaderTypes.Location]?: string;
+    };
+    /**
+     * The response payload containing the dataset or error.
+     */
+    body?: IDataspaceProtocolCatalogError;
+}

package/docs/changelog.md

@@ -1,11 +1,144 @@
-# @twin.org/federated-catalogue-models - Changelog
+# Changelog
 
-## [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)
+## [0.0.3-next.21](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-models-v0.0.3-next.20...federated-catalogue-models-v0.0.3-next.21) (2026-06-12)
+
+
+### Miscellaneous Chores
+
+* **federated-catalogue-models:** Synchronize repo versions
+
+## [0.0.3-next.20](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-models-v0.0.3-next.19...federated-catalogue-models-v0.0.3-next.20) (2026-06-11)
+
+
+### Features
+
+* organization identifiers ([#84](https://github.com/iotaledger/twin-federated-catalogue/issues/84)) ([1e02971](https://github.com/iotaledger/twin-federated-catalogue/commit/1e02971a12e40bd20a0034ee1de0988a689d3dc8))
+
+## [0.0.3-next.19](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-models-v0.0.3-next.18...federated-catalogue-models-v0.0.3-next.19) (2026-06-08)
+
+
+### Features
+
+* replace sync storage with shared DB and trust-token auth ([#79](https://github.com/iotaledger/twin-federated-catalogue/issues/79)) ([3a07f02](https://github.com/iotaledger/twin-federated-catalogue/commit/3a07f02aba8d6f3540a23e5c2cebc7b0e579ef30))
+
+## [0.0.3-next.18](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-models-v0.0.3-next.17...federated-catalogue-models-v0.0.3-next.18) (2026-06-01)
+
+
+### Miscellaneous Chores
+
+* **federated-catalogue-models:** Synchronize repo versions
+
+## [0.0.3-next.17](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-models-v0.0.3-next.16...federated-catalogue-models-v0.0.3-next.17) (2026-05-20)
+
+
+### Miscellaneous Chores
+
+* **federated-catalogue-models:** Synchronize repo versions
+
+## [0.0.3-next.16](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-models-v0.0.3-next.15...federated-catalogue-models-v0.0.3-next.16) (2026-05-12)
+
+
+### Features
+
+* typescript 6 update ([ead042d](https://github.com/iotaledger/twin-federated-catalogue/commit/ead042d09f4e6b03a2db46ace2ea95d197f0f4b0))
+
+## [0.0.3-next.15](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-models-v0.0.3-next.14...federated-catalogue-models-v0.0.3-next.15) (2026-05-08)
+
+
+### Miscellaneous Chores
+
+* **federated-catalogue-models:** Synchronize repo versions
+
+## [0.0.3-next.14](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-models-v0.0.3-next.13...federated-catalogue-models-v0.0.3-next.14) (2026-03-20)
+
+
+### Miscellaneous Chores
+
+* **federated-catalogue-models:** Synchronize repo versions
+
+## [0.0.3-next.13](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-models-v0.0.3-next.12...federated-catalogue-models-v0.0.3-next.13) (2026-03-12)
+
+
+### Miscellaneous Chores
+
+* **federated-catalogue-models:** Synchronize repo versions
+
+## [0.0.3-next.12](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-models-v0.0.3-next.11...federated-catalogue-models-v0.0.3-next.12) (2026-03-06)
+
+
+### Miscellaneous Chores
+
+* **federated-catalogue-models:** Synchronize repo versions
+
+## [0.0.3-next.11](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-models-v0.0.3-next.10...federated-catalogue-models-v0.0.3-next.11) (2026-03-05)
+
+
+### Miscellaneous Chores
+
+* **federated-catalogue-models:** Synchronize repo versions
+
+## [0.0.3-next.10](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-models-v0.0.3-next.9...federated-catalogue-models-v0.0.3-next.10) (2026-02-25)
+
+
+### Features
+
+* update json-ld patterns ([172aff0](https://github.com/iotaledger/twin-federated-catalogue/commit/172aff07d0f0b780f72d1be3a4896bbf12f6173a))
+
+## [0.0.3-next.9](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-models-v0.0.3-next.8...federated-catalogue-models-v0.0.3-next.9) (2026-02-12)
+
+
+### Miscellaneous Chores
+
+* **federated-catalogue-models:** Synchronize repo versions
+
+## [0.0.3-next.8](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-models-v0.0.3-next.7...federated-catalogue-models-v0.0.3-next.8) (2026-01-26)
+
+
+### Features
+
+* use new hosting url for cursor links ([e42c934](https://github.com/iotaledger/twin-federated-catalogue/commit/e42c934b9c8748ec5bdd4803c1cdc05c82ccace8))
+
+## [0.0.3-next.7](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-models-v0.0.3-next.6...federated-catalogue-models-v0.0.3-next.7) (2026-01-22)
+
+
+### Miscellaneous Chores
+
+* **federated-catalogue-models:** Synchronize repo versions
+
+## [0.0.3-next.6](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-models-v0.0.3-next.5...federated-catalogue-models-v0.0.3-next.6) (2026-01-20)
+
+
+### Bug Fixes
+
+* transform GuardError to CatalogError for DS Protocol compliance ([#49](https://github.com/iotaledger/twin-federated-catalogue/issues/49)) ([d0f1090](https://github.com/iotaledger/twin-federated-catalogue/commit/d0f10900c251b9abc18e58c90562c393c3265727))
+
+## [0.0.3-next.5](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-models-v0.0.3-next.4...federated-catalogue-models-v0.0.3-next.5) (2026-01-15)
+
+
+### Bug Fixes
+
+* pagination and ld context ([#45](https://github.com/iotaledger/twin-federated-catalogue/issues/45)) ([e36f096](https://github.com/iotaledger/twin-federated-catalogue/commit/e36f096aa4fdc61eb5b929a0fc4403247dbd41ce))
+
+## [0.0.3-next.4](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-models-v0.0.3-next.3...federated-catalogue-models-v0.0.3-next.4) (2026-01-06)
+
+
+### Features
+
+* updates standards dependencies ([62f5d9c](https://github.com/iotaledger/twin-federated-catalogue/commit/62f5d9c6180bc27497ac43624ffd714e7ce65ce6))
+
+## [0.0.3-next.3](https://github.com/iotaledger/twin-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.3-next.2](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-models-v0.0.3-next.1...federated-catalogue-models-v0.0.3-next.2) (2025-11-28)
 
 
 ### Features
 
-* implement Dataspace Protocol federated catalogue ([#36](https://github.com/twinfoundation/federated-catalogue/issues/36)) ([4765aba](https://github.com/twinfoundation/federated-catalogue/commit/4765aba4485ef8ad61e7ec1affbf0e454d974d36))
+* implement Dataspace Protocol federated catalogue ([#36](https://github.com/iotaledger/twin-federated-catalogue/issues/36)) ([4765aba](https://github.com/iotaledger/twin-federated-catalogue/commit/4765aba4485ef8ad61e7ec1affbf0e454d974d36))
 
 ## v0.0.1-next.1