@twin.org/federated-catalogue-models 0.0.3-next.12 → 0.0.3-next.14

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/docs/changelog.md

@@ -1,4 +1,18 @@
-# @twin.org/federated-catalogue-models - Changelog
+# Changelog
+
+## [0.0.3-next.14](https://github.com/twinfoundation/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/twinfoundation/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/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.3-next.11...federated-catalogue-models-v0.0.3-next.12) (2026-03-06)
 

package/docs/examples.md

@@ -1 +1,55 @@
-# @twin.org/federated-catalogue-models - Examples
+# Federated Catalogue Models Examples
+
+These examples show how to register, discover and resolve filter components so catalogue services can select filtering logic at runtime.
+
+## FederatedCatalogueFilterFactory
+
+```typescript
+import { FederatedCatalogueFilterFactory } from '@twin.org/federated-catalogue-models';
+
+FederatedCatalogueFilterFactory.clear();
+
+FederatedCatalogueFilterFactory.register('PublisherFilter', () => ({
+  className() {
+    return 'PublisherFilter';
+  },
+  async query() {
+    return { datasets: [] };
+  },
+  async createIndex() {
+    return {};
+  }
+}));
+
+FederatedCatalogueFilterFactory.clear();
+
+FederatedCatalogueFilterFactory.register('PublisherFilter', () => ({
+  className() {
+    return 'PublisherFilter';
+  },
+  async query() {
+    return { datasets: [] };
+  },
+  async createIndex() {
+    return {};
+  }
+}));
+
+const filterNames = FederatedCatalogueFilterFactory.names();
+
+console.log(filterNames.includes('PublisherFilter')); // true
+```
+
+```typescript
+import { FederatedCatalogueFilterFactory } from '@twin.org/federated-catalogue-models';
+
+const filter = FederatedCatalogueFilterFactory.get('PublisherFilter');
+const queryResult = await filter.query([
+  {
+    '@type': 'PublisherFilter'
+  }
+]);
+
+console.log(filter.className()); // PublisherFilter
+console.log(queryResult.datasets.length); // 0
+```

package/docs/reference/interfaces/ICatalogRequestRequest.md

@@ -4,7 +4,7 @@ The request parameters for the catalog request method.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `IDataspaceProtocolCatalogRequestMessage`
 
@@ -12,21 +12,21 @@ The request body containing the catalog query.
 
 ***
 
-### query?
+### query? {#query}
 
-> `optional` **query**: `object`
+> `optional` **query?**: `object`
 
 Optional query parameters for pagination.
 Used when following Link header URLs per DS Protocol spec.
 
 #### cursor?
 
-> `optional` **cursor**: `string`
+> `optional` **cursor?**: `string`
 
 Opaque cursor token for pagination.
 
 #### limit?
 
-> `optional` **limit**: `string`
+> `optional` **limit?**: `string`
 
 Limit for pagination.

package/docs/reference/interfaces/ICatalogRequestResponse.md

@@ -5,28 +5,28 @@ Returns a DS Protocol compliant Catalog with participantId, or CatalogError if n
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 Optional headers including RFC 8288 Link header for pagination.
 
 #### link?
 
-> `optional` **link**: `string` \| `string`[]
+> `optional` **link?**: `string` \| `string`[]
 
 ***
 
-### statusCode?
+### statusCode? {#statuscode}
 
-> `optional` **statusCode**: `HttpStatusCode`
+> `optional` **statusCode?**: `HttpStatusCode`
 
 Response status code.
 Per DS Protocol: Returns appropriate HTTP code (e.g., 404) when returning CatalogError.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: `IDataspaceProtocolCatalog` \| `IDataspaceProtocolCatalogError`
 

package/docs/reference/interfaces/IFederatedCatalogueComponent.md

@@ -9,7 +9,7 @@ Provides Dataspace Protocol-compliant catalog endpoints for dataset registry and
 
 ## Methods
 
-### get()
+### get() {#get}
 
 > **get**(`dataSetId`): `Promise`\<`IDcatDataset` \| `IDataspaceProtocolCatalogError`\>
 
@@ -31,7 +31,7 @@ The dataset if found, or a CatalogError if not found or an error occurs.
 
 ***
 
-### set()
+### set() {#set}
 
 > **set**(`dataSet`): `Promise`\<`void`\>
 
@@ -54,7 +54,7 @@ Nothing.
 
 ***
 
-### query()
+### query() {#query}
 
 > **query**(`filter?`, `cursor?`, `limit?`): `Promise`\<\{ `result`: `IDataspaceProtocolCatalog` \| `IDataspaceProtocolCatalogError`; `cursor?`: `string`; \}\>
 
@@ -97,7 +97,7 @@ or IDataspaceProtocolCatalogError if no datasets found.
 
 ***
 
-### remove()
+### remove() {#remove}
 
 > **remove**(`dataSetId`): `Promise`\<`void`\>
 

package/docs/reference/interfaces/IFederatedCatalogueFilter.md

@@ -10,7 +10,7 @@ Filters are registered by name in the FilterFactory and do not need to self-iden
 
 ## Methods
 
-### query()
+### query() {#query}
 
 > **query**(`filter`, `cursor?`, `limit?`): `Promise`\<\{ `datasets`: `IDcatDataset`[]; `cursor?`: `string`; \}\>
 
@@ -45,7 +45,7 @@ Object containing datasets matching the filter criteria and optional cursor for
 
 ***
 
-### createIndex()
+### createIndex() {#createindex}
 
 > **createIndex**(`dataSet`): `Promise`\<\{\[`key`: `string`\]: `unknown`; \}\>
 

package/docs/reference/interfaces/IGetDatasetRequest.md

@@ -4,7 +4,7 @@ The request parameters for the get dataset method.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 

package/docs/reference/interfaces/IGetDatasetResponse.md

@@ -4,15 +4,15 @@ The response payload for the get dataset method.
 
 ## Properties
 
-### statusCode?
+### statusCode? {#statuscode}
 
-> `optional` **statusCode**: `HttpStatusCode`
+> `optional` **statusCode?**: `HttpStatusCode`
 
 Response status code.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: `IDcatDataset` \| `IDataspaceProtocolCatalogError`
 

package/package.json

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