@twin.org/federated-catalogue-models 0.0.3-next.18 → 0.0.3-next.19

package/dist/es/index.js

@@ -3,8 +3,12 @@
 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/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;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"]}
+{"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 {\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"]}
+{"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 { 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"]}
+{"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.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 { 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"]}
+{"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/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/{IGetDatasetResponse.js.map → IDatasetGetResponse.js.map}

@@ -1 +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"]}
+{"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,7 +1,11 @@
 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/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

@@ -8,17 +8,19 @@ import type { IDcatDataset } 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.
+     * @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<IDcatDataset | IDataspaceProtocolCatalogError>;
+    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: IDcatDataset): Promise<void>;
+    set(dataset: IDcatDataset, trustPayload: unknown): Promise<string | IDataspaceProtocolCatalogError>;
     /**
      * Execute a query against the catalogue using registered filter plugins.
      * Returns a DS Protocol compliant Catalog object with participantId.
@@ -33,17 +35,19 @@ export interface IFederatedCatalogueComponent extends IComponent {
      * @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[], cursor?: string, limit?: number): Promise<{
+    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

@@ -21,10 +21,10 @@ export interface IFederatedCatalogueFilter extends IComponent {
     /**
      * 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: IDcatDataset): Promise<{
+    createIndex(dataset: IDcatDataset): Promise<{
         [key: string]: unknown;
     }>;
 }

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

@@ -1,8 +1,15 @@
 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.
      */

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/{IGetDatasetResponse.d.ts → IDatasetGetResponse.d.ts}

@@ -4,7 +4,7 @@ import type { HttpStatusCode } from "@twin.org/web";
 /**
  * The response payload for the get dataset method.
  */
-export interface IGetDatasetResponse {
+export interface IDatasetGetResponse {
     /**
      * Response status code.
      */

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,5 +1,12 @@
 # Changelog
 
+## [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)
 
 

package/docs/reference/index.md

@@ -6,8 +6,12 @@
 - [IFederatedCatalogueFilter](interfaces/IFederatedCatalogueFilter.md)
 - [ICatalogRequestRequest](interfaces/ICatalogRequestRequest.md)
 - [ICatalogRequestResponse](interfaces/ICatalogRequestResponse.md)
-- [IGetDatasetRequest](interfaces/IGetDatasetRequest.md)
-- [IGetDatasetResponse](interfaces/IGetDatasetResponse.md)
+- [IDatasetGetRequest](interfaces/IDatasetGetRequest.md)
+- [IDatasetGetResponse](interfaces/IDatasetGetResponse.md)
+- [IDatasetRemoveRequest](interfaces/IDatasetRemoveRequest.md)
+- [IDatasetRemoveResponse](interfaces/IDatasetRemoveResponse.md)
+- [IDatasetSetRequest](interfaces/IDatasetSetRequest.md)
+- [IDatasetSetResponse](interfaces/IDatasetSetResponse.md)
 
 ## Variables
 

package/docs/reference/interfaces/ICatalogRequestRequest.md

@@ -4,6 +4,18 @@ The request parameters for the catalog request method.
 
 ## Properties
 
+### headers? {#headers}
+
+> `optional` **headers?**: `object`
+
+The request headers. Authorization header carries the trust token (Bearer scheme).
+
+#### authorization?
+
+> `optional` **authorization?**: `string`
+
+***
+
 ### body {#body}
 
 > **body**: `IDataspaceProtocolCatalogRequestMessage`

package/docs/reference/interfaces/IDatasetGetRequest.md

@@ -0,0 +1,29 @@
+# Interface: IDatasetGetRequest
+
+The request parameters for the get dataset method.
+
+## Properties
+
+### headers? {#headers}
+
+> `optional` **headers?**: `object`
+
+The request headers. Authorization header carries the trust token (Bearer scheme).
+
+#### authorization?
+
+> `optional` **authorization?**: `string`
+
+***
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### datasetId
+
+> **datasetId**: `string`
+
+The unique identifier of the dataset.

package/docs/reference/interfaces/{IGetDatasetResponse.md → IDatasetGetResponse.md}

@@ -1,4 +1,4 @@
-# Interface: IGetDatasetResponse
+# Interface: IDatasetGetResponse
 
 The response payload for the get dataset method.
 

package/docs/reference/interfaces/IDatasetRemoveRequest.md

@@ -0,0 +1,29 @@
+# Interface: IDatasetRemoveRequest
+
+The request parameters for the remove dataset method.
+
+## Properties
+
+### headers? {#headers}
+
+> `optional` **headers?**: `object`
+
+The request headers. Authorization header carries the trust token (Bearer scheme).
+
+#### authorization?
+
+> `optional` **authorization?**: `string`
+
+***
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### datasetId
+
+> **datasetId**: `string`
+
+The unique identifier of the dataset.

package/docs/reference/interfaces/IDatasetRemoveResponse.md

@@ -0,0 +1,19 @@
+# Interface: IDatasetRemoveResponse
+
+The response payload for the remove dataset method.
+
+## Properties
+
+### statusCode? {#statuscode}
+
+> `optional` **statusCode?**: `HttpStatusCode`
+
+Response status code.
+
+***
+
+### body? {#body}
+
+> `optional` **body?**: `IDataspaceProtocolCatalogError`
+
+The response payload containing the dataset or error.

package/docs/reference/interfaces/IDatasetSetRequest.md

@@ -0,0 +1,23 @@
+# Interface: IDatasetSetRequest
+
+The request parameters for the set dataset method.
+
+## Properties
+
+### headers? {#headers}
+
+> `optional` **headers?**: `object`
+
+The request headers. Authorization header carries the trust token (Bearer scheme).
+
+#### authorization?
+
+> `optional` **authorization?**: `string`
+
+***
+
+### body {#body}
+
+> **body**: `IDcatDataset`
+
+The response payload containing the dataset or error.

package/docs/reference/interfaces/IDatasetSetResponse.md

@@ -0,0 +1,31 @@
+# Interface: IDatasetSetResponse
+
+The response payload for the set dataset method.
+
+## Properties
+
+### statusCode? {#statuscode}
+
+> `optional` **statusCode?**: `HttpStatusCode`
+
+Response status code.
+
+***
+
+### headers? {#headers}
+
+> `optional` **headers?**: `object`
+
+Optional headers.
+
+#### location?
+
+> `optional` **location?**: `string`
+
+***
+
+### body? {#body}
+
+> `optional` **body?**: `IDataspaceProtocolCatalogError`
+
+The response payload containing the dataset or error.

package/docs/reference/interfaces/IFederatedCatalogueComponent.md

@@ -11,18 +11,24 @@ Provides Dataspace Protocol-compliant catalog endpoints for dataset registry and
 
 ### get() {#get}
 
-> **get**(`dataSetId`): `Promise`\<`IDcatDataset` \| `IDataspaceProtocolCatalogError`\>
+> **get**(`datasetId`, `trustPayload`): `Promise`\<`IDcatDataset` \| `IDataspaceProtocolCatalogError`\>
 
 Retrieve a dataset by its unique identifier.
 
 #### Parameters
 
-##### dataSetId
+##### datasetId
 
 `string`
 
 The unique identifier of the dataset.
 
+##### trustPayload
+
+`unknown`
+
+Optional payload for trust evaluation, if applicable.
+
 #### Returns
 
 `Promise`\<`IDcatDataset` \| `IDataspaceProtocolCatalogError`\>
@@ -33,30 +39,36 @@ The dataset if found, or a CatalogError if not found or an error occurs.
 
 ### set() {#set}
 
-> **set**(`dataSet`): `Promise`\<`void`\>
+> **set**(`dataset`, `trustPayload`): `Promise`\<`string` \| `IDataspaceProtocolCatalogError`\>
 
 Insert or update a dataset in the catalogue.
 This method is internal and should not be exposed via REST endpoints.
 
 #### Parameters
 
-##### dataSet
+##### dataset
 
 `IDcatDataset`
 
 The dataset to store.
 
+##### trustPayload
+
+`unknown`
+
+Optional payload for trust evaluation, if applicable.
+
 #### Returns
 
-`Promise`\<`void`\>
+`Promise`\<`string` \| `IDataspaceProtocolCatalogError`\>
 
-Nothing.
+The unique identifier of the stored dataset, or a CatalogError if an error occurs.
 
 ***
 
 ### query() {#query}
 
-> **query**(`filter?`, `cursor?`, `limit?`): `Promise`\<\{ `result`: `IDataspaceProtocolCatalog` \| `IDataspaceProtocolCatalogError`; `cursor?`: `string`; \}\>
+> **query**(`filter`, `cursor`, `limit`, `trustPayload`): `Promise`\<\{ `result`: `IDataspaceProtocolCatalog` \| `IDataspaceProtocolCatalogError`; `cursor?`: `string`; \}\>
 
 Execute a query against the catalogue using registered filter plugins.
 Returns a DS Protocol compliant Catalog object with participantId.
@@ -70,24 +82,30 @@ Returns CatalogError 404 when no datasets exist.
 
 #### Parameters
 
-##### filter?
+##### filter
 
-`unknown`[]
+`unknown`[] \| `undefined`
 
 The filter criteria containing @type.
 
-##### cursor?
+##### cursor
 
-`string`
+`string` \| `undefined`
 
 Optional cursor for pagination.
 
-##### limit?
+##### limit
 
-`number`
+`number` \| `undefined`
 
 Optional limit for pagination.
 
+##### trustPayload
+
+`unknown`
+
+Optional payload for trust evaluation, if applicable.
+
 #### Returns
 
 `Promise`\<\{ `result`: `IDataspaceProtocolCatalog` \| `IDataspaceProtocolCatalogError`; `cursor?`: `string`; \}\>
@@ -99,20 +117,26 @@ or IDataspaceProtocolCatalogError if no datasets found.
 
 ### remove() {#remove}
 
-> **remove**(`dataSetId`): `Promise`\<`void`\>
+> **remove**(`datasetId`, `trustPayload`): `Promise`\<`IDataspaceProtocolCatalogError` \| `undefined`\>
 
 Remove a dataset from the catalogue by its unique identifier.
 
 #### Parameters
 
-##### dataSetId
+##### datasetId
 
 `string`
 
 The unique identifier of the dataset to remove.
 
+##### trustPayload
+
+`unknown`
+
+Optional payload for trust evaluation, if applicable.
+
 #### Returns
 
-`Promise`\<`void`\>
+`Promise`\<`IDataspaceProtocolCatalogError` \| `undefined`\>
 
 Nothing.

package/docs/reference/interfaces/IFederatedCatalogueFilter.md

@@ -47,14 +47,14 @@ Object containing datasets matching the filter criteria and optional cursor for
 
 ### createIndex() {#createindex}
 
-> **createIndex**(`dataSet`): `Promise`\<\{\[`key`: `string`\]: `unknown`; \}\>
+> **createIndex**(`dataset`): `Promise`\<\{\[`key`: `string`\]: `unknown`; \}\>
 
 Generate filter indexes for a dataset to optimize future queries.
 Indexes are stored as properties on the dataset entity itself.
 
 #### Parameters
 
-##### dataSet
+##### dataset
 
 `IDcatDataset`
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/federated-catalogue-models",
-	"version": "0.0.3-next.18",
+	"version": "0.0.3-next.19",
 	"description": "Models which define the structure of the Federated Catalogue Service",
 	"repository": {
 		"type": "git",

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

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

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

@@ -1 +0,0 @@
-{"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

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

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

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

package/docs/reference/interfaces/IGetDatasetRequest.md

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