@twin.org/federated-catalogue-models 0.0.3-next.3 → 0.0.3-next.4

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 { IDcatCatalog, 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.\n\t * @throws NotFoundError if the dataset does not exist.\n\t */\n\tget(dataSetId: string): Promise<IDcatDataset>;\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 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<IDcatCatalog>;\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.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\";\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: 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\";\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"]}

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 { IDcatCatalog } 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: IDcatCatalog;\n}\n"]}

package/dist/es/models/api/IGetDatasetResponse.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 { 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"]}
+{"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 { IDcatDataset } 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: IDcatDataset;\n}\n"]}

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

@@ -1,5 +1,5 @@
 import type { IComponent } from "@twin.org/core";
-import type { ICatalog, IDataset } from "@twin.org/standards-w3c-dcat";
+import type { IDcatCatalog, IDcatDataset } from "@twin.org/standards-w3c-dcat";
 /**
  * Interface describing a federated catalogue component.
  * Provides Dataspace Protocol-compliant catalog endpoints for dataset registry and query.
@@ -11,14 +11,14 @@ export interface IFederatedCatalogueComponent extends IComponent {
      * @returns The dataset if found.
      * @throws NotFoundError if the dataset does not exist.
      */
-    get(dataSetId: string): Promise<IDataset>;
+    get(dataSetId: string): Promise<IDcatDataset>;
     /**
      * Insert or update a dataset in the catalogue.
      * This method is internal and should not be exposed via REST endpoints.
      * @param dataSet The dataset to store.
      * @returns Nothing.
      */
-    set(dataSet: IDataset): Promise<void>;
+    set(dataSet: IDcatDataset): Promise<void>;
     /**
      * Execute a query against the catalogue using registered filter plugins.
      * Returns a complete DCAT Catalog object with proper JSON-LD context, metadata, and datasets.
@@ -30,7 +30,7 @@ export interface IFederatedCatalogueComponent extends IComponent {
      * @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.
      */
-    query(filter?: unknown[]): Promise<ICatalog>;
+    query(filter?: unknown[]): Promise<IDcatCatalog>;
     /**
      * Remove a dataset from the catalogue by its unique identifier.
      * @param dataSetId The unique identifier of the dataset to remove.

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

@@ -1,5 +1,5 @@
 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";
 /**
  * Interface describing a filter plugin for the federated catalogue.
  * Filter plugins provide extensible query semantics and indexing strategies.
@@ -14,7 +14,7 @@ export interface IFederatedCatalogueFilter extends IComponent {
      * @returns Object containing datasets matching the filter criteria and optional cursor for next page.
      */
     query(filter: unknown): Promise<{
-        datasets: IDataset[];
+        datasets: IDcatDataset[];
         cursor?: string;
     }>;
     /**
@@ -23,7 +23,7 @@ export interface IFederatedCatalogueFilter extends IComponent {
      * @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,4 +1,4 @@
-import type { ICatalogRequestMessage } from "@twin.org/standards-dataspace-protocol";
+import type { IDataspaceProtocolCatalogRequestMessage } from "@twin.org/standards-dataspace-protocol";
 /**
  * The request parameters for the catalog request method.
  */
@@ -6,5 +6,5 @@ export interface ICatalogRequestRequest {
     /**
      * The request body containing the catalog query.
      */
-    body: ICatalogRequestMessage;
+    body: IDataspaceProtocolCatalogRequestMessage;
 }

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

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

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

@@ -1,4 +1,4 @@
-import type { IDataset } from "@twin.org/standards-w3c-dcat";
+import type { IDcatDataset } from "@twin.org/standards-w3c-dcat";
 /**
  * The response payload for the get dataset method.
  */
@@ -6,5 +6,5 @@ export interface IGetDatasetResponse {
     /**
      * The response payload containing the dataset.
      */
-    body: IDataset;
+    body: IDcatDataset;
 }

package/docs/changelog.md

@@ -1,5 +1,12 @@
 # @twin.org/federated-catalogue-models - Changelog
 
+## [0.0.3-next.4](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.3-next.3...federated-catalogue-models-v0.0.3-next.4) (2026-01-06)
+
+
+### Features
+
+* updates standards dependencies ([62f5d9c](https://github.com/twinfoundation/federated-catalogue/commit/62f5d9c6180bc27497ac43624ffd714e7ce65ce6))
+
 ## [0.0.3-next.3](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.3-next.2...federated-catalogue-models-v0.0.3-next.3) (2025-11-28)
 
 

package/docs/reference/interfaces/ICatalogRequestRequest.md

@@ -6,6 +6,6 @@ The request parameters for the catalog request method.
 
 ### body
 
-> **body**: `ICatalogRequestMessage`
+> **body**: `IDataspaceProtocolCatalogRequestMessage`
 
 The request body containing the catalog query.

package/docs/reference/interfaces/ICatalogRequestResponse.md

@@ -6,6 +6,6 @@ The response payload for the catalog request method.
 
 ### body
 
-> **body**: `ICatalog`
+> **body**: `IDcatCatalog`
 
 The response payload containing the catalog with matching datasets.

package/docs/reference/interfaces/IFederatedCatalogueComponent.md

@@ -11,7 +11,7 @@ Provides Dataspace Protocol-compliant catalog endpoints for dataset registry and
 
 ### get()
 
-> **get**(`dataSetId`): `Promise`\<`IDataset`\>
+> **get**(`dataSetId`): `Promise`\<`IDcatDataset`\>
 
 Retrieve a dataset by its unique identifier.
 
@@ -25,7 +25,7 @@ The unique identifier of the dataset.
 
 #### Returns
 
-`Promise`\<`IDataset`\>
+`Promise`\<`IDcatDataset`\>
 
 The dataset if found.
 
@@ -46,7 +46,7 @@ This method is internal and should not be exposed via REST endpoints.
 
 ##### dataSet
 
-`IDataset`
+`IDcatDataset`
 
 The dataset to store.
 
@@ -60,7 +60,7 @@ Nothing.
 
 ### query()
 
-> **query**(`filter?`): `Promise`\<`ICatalog`\>
+> **query**(`filter?`): `Promise`\<`IDcatCatalog`\>
 
 Execute a query against the catalogue using registered filter plugins.
 Returns a complete DCAT Catalog object with proper JSON-LD context, metadata, and datasets.
@@ -79,7 +79,7 @@ The filter criteria containing @type, optional cursor and limit properties.
 
 #### Returns
 
-`Promise`\<`ICatalog`\>
+`Promise`\<`IDcatCatalog`\>
 
 Complete ICatalog object with @context, @id, @type, dcat:dataset, and optional cursor.
 

package/docs/reference/interfaces/IFederatedCatalogueFilter.md

@@ -12,7 +12,7 @@ Filters are registered by name in the FilterFactory and do not need to self-iden
 
 ### query()
 
-> **query**(`filter`): `Promise`\<\{ `datasets`: `IDataset`[]; `cursor?`: `string`; \}\>
+> **query**(`filter`): `Promise`\<\{ `datasets`: `IDcatDataset`[]; `cursor?`: `string`; \}\>
 
 Execute a filter-specific query over the catalogue.
 Each filter interprets the payload according to its own semantics.
@@ -28,7 +28,7 @@ The filter criteria (structure depends on the filter implementation).
 
 #### Returns
 
-`Promise`\<\{ `datasets`: `IDataset`[]; `cursor?`: `string`; \}\>
+`Promise`\<\{ `datasets`: `IDcatDataset`[]; `cursor?`: `string`; \}\>
 
 Object containing datasets matching the filter criteria and optional cursor for next page.
 
@@ -45,7 +45,7 @@ Indexes are stored as properties on the dataset entity itself.
 
 ##### dataSet
 
-`IDataset`
+`IDcatDataset`
 
 The dataset to index.
 

package/docs/reference/interfaces/IGetDatasetResponse.md

@@ -6,6 +6,6 @@ The response payload for the get dataset method.
 
 ### body
 
-> **body**: `IDataset`
+> **body**: `IDcatDataset`
 
 The response payload containing the dataset.

package/package.json

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