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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/docs/changelog.md +7 -0
  2. package/docs/reference/interfaces/ICatalogRequestRequest.md +5 -5
  3. package/docs/reference/interfaces/ICatalogRequestResponse.md +6 -6
  4. package/docs/reference/interfaces/IFederatedCatalogueComponent.md +4 -4
  5. package/docs/reference/interfaces/IFederatedCatalogueFilter.md +2 -2
  6. package/docs/reference/interfaces/IGetDatasetRequest.md +1 -1
  7. package/docs/reference/interfaces/IGetDatasetResponse.md +3 -3
  8. package/package.json +1 -1
package/docs/changelog.md CHANGED
@@ -1,5 +1,12 @@
1
1
  # Changelog
2
2
 
3
+ ## [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)
4
+
5
+
6
+ ### Miscellaneous Chores
7
+
8
+ * **federated-catalogue-models:** Synchronize repo versions
9
+
3
10
  ## [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)
4
11
 
5
12
 
package/docs/reference/interfaces/ICatalogRequestRequest.md CHANGED
@@ -4,7 +4,7 @@ The request parameters for the catalog request method.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### body
7
+ ### body {#body}
8
8
 
9
9
  > **body**: `IDataspaceProtocolCatalogRequestMessage`
10
10
 
@@ -12,21 +12,21 @@ The request body containing the catalog query.
12
12
 
13
13
  ***
14
14
 
15
- ### query?
15
+ ### query? {#query}
16
16
 
17
- > `optional` **query**: `object`
17
+ > `optional` **query?**: `object`
18
18
 
19
19
  Optional query parameters for pagination.
20
20
  Used when following Link header URLs per DS Protocol spec.
21
21
 
22
22
  #### cursor?
23
23
 
24
- > `optional` **cursor**: `string`
24
+ > `optional` **cursor?**: `string`
25
25
 
26
26
  Opaque cursor token for pagination.
27
27
 
28
28
  #### limit?
29
29
 
30
- > `optional` **limit**: `string`
30
+ > `optional` **limit?**: `string`
31
31
 
32
32
  Limit for pagination.
package/docs/reference/interfaces/ICatalogRequestResponse.md CHANGED
@@ -5,28 +5,28 @@ Returns a DS Protocol compliant Catalog with participantId, or CatalogError if n
5
5
 
6
6
  ## Properties
7
7
 
8
- ### headers?
8
+ ### headers? {#headers}
9
9
 
10
- > `optional` **headers**: `object`
10
+ > `optional` **headers?**: `object`
11
11
 
12
12
  Optional headers including RFC 8288 Link header for pagination.
13
13
 
14
14
  #### link?
15
15
 
16
- > `optional` **link**: `string` \| `string`[]
16
+ > `optional` **link?**: `string` \| `string`[]
17
17
 
18
18
  ***
19
19
 
20
- ### statusCode?
20
+ ### statusCode? {#statuscode}
21
21
 
22
- > `optional` **statusCode**: `HttpStatusCode`
22
+ > `optional` **statusCode?**: `HttpStatusCode`
23
23
 
24
24
  Response status code.
25
25
  Per DS Protocol: Returns appropriate HTTP code (e.g., 404) when returning CatalogError.
26
26
 
27
27
  ***
28
28
 
29
- ### body
29
+ ### body {#body}
30
30
 
31
31
  > **body**: `IDataspaceProtocolCatalog` \| `IDataspaceProtocolCatalogError`
32
32
 
package/docs/reference/interfaces/IFederatedCatalogueComponent.md CHANGED
@@ -9,7 +9,7 @@ Provides Dataspace Protocol-compliant catalog endpoints for dataset registry and
9
9
 
10
10
  ## Methods
11
11
 
12
- ### get()
12
+ ### get() {#get}
13
13
 
14
14
  > **get**(`dataSetId`): `Promise`\<`IDcatDataset` \| `IDataspaceProtocolCatalogError`\>
15
15
 
@@ -31,7 +31,7 @@ The dataset if found, or a CatalogError if not found or an error occurs.
31
31
 
32
32
  ***
33
33
 
34
- ### set()
34
+ ### set() {#set}
35
35
 
36
36
  > **set**(`dataSet`): `Promise`\<`void`\>
37
37
 
@@ -54,7 +54,7 @@ Nothing.
54
54
 
55
55
  ***
56
56
 
57
- ### query()
57
+ ### query() {#query}
58
58
 
59
59
  > **query**(`filter?`, `cursor?`, `limit?`): `Promise`\<\{ `result`: `IDataspaceProtocolCatalog` \| `IDataspaceProtocolCatalogError`; `cursor?`: `string`; \}\>
60
60
 
@@ -97,7 +97,7 @@ or IDataspaceProtocolCatalogError if no datasets found.
97
97
 
98
98
  ***
99
99
 
100
- ### remove()
100
+ ### remove() {#remove}
101
101
 
102
102
  > **remove**(`dataSetId`): `Promise`\<`void`\>
103
103
 
package/docs/reference/interfaces/IFederatedCatalogueFilter.md CHANGED
@@ -10,7 +10,7 @@ Filters are registered by name in the FilterFactory and do not need to self-iden
10
10
 
11
11
  ## Methods
12
12
 
13
- ### query()
13
+ ### query() {#query}
14
14
 
15
15
  > **query**(`filter`, `cursor?`, `limit?`): `Promise`\<\{ `datasets`: `IDcatDataset`[]; `cursor?`: `string`; \}\>
16
16
 
@@ -45,7 +45,7 @@ Object containing datasets matching the filter criteria and optional cursor for
45
45
 
46
46
  ***
47
47
 
48
- ### createIndex()
48
+ ### createIndex() {#createindex}
49
49
 
50
50
  > **createIndex**(`dataSet`): `Promise`\<\{\[`key`: `string`\]: `unknown`; \}\>
51
51
 
package/docs/reference/interfaces/IGetDatasetRequest.md CHANGED
@@ -4,7 +4,7 @@ The request parameters for the get dataset method.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### pathParams
7
+ ### pathParams {#pathparams}
8
8
 
9
9
  > **pathParams**: `object`
10
10
 
package/docs/reference/interfaces/IGetDatasetResponse.md CHANGED
@@ -4,15 +4,15 @@ The response payload for the get dataset method.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### statusCode?
7
+ ### statusCode? {#statuscode}
8
8
 
9
- > `optional` **statusCode**: `HttpStatusCode`
9
+ > `optional` **statusCode?**: `HttpStatusCode`
10
10
 
11
11
  Response status code.
12
12
 
13
13
  ***
14
14
 
15
- ### body
15
+ ### body {#body}
16
16
 
17
17
  > **body**: `IDcatDataset` \| `IDataspaceProtocolCatalogError`
18
18
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/federated-catalogue-models",
3
- "version": "0.0.3-next.13",
3
+ "version": "0.0.3-next.14",
4
4
  "description": "Models which define the structure of the Federated Catalogue Service",
5
5
  "repository": {
6
6
  "type": "git",