@twin.org/federated-catalogue-models 0.0.3-next.13 → 0.0.3-next.15
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.
- package/docs/changelog.md +32 -18
- package/docs/reference/interfaces/ICatalogRequestRequest.md +5 -5
- package/docs/reference/interfaces/ICatalogRequestResponse.md +6 -6
- package/docs/reference/interfaces/IFederatedCatalogueComponent.md +4 -4
- package/docs/reference/interfaces/IFederatedCatalogueFilter.md +2 -2
- package/docs/reference/interfaces/IGetDatasetRequest.md +1 -1
- package/docs/reference/interfaces/IGetDatasetResponse.md +3 -3
- package/package.json +3 -3
package/docs/changelog.md
CHANGED
|
@@ -1,88 +1,102 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
-
## [0.0.3-next.
|
|
3
|
+
## [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)
|
|
4
4
|
|
|
5
5
|
|
|
6
6
|
### Miscellaneous Chores
|
|
7
7
|
|
|
8
8
|
* **federated-catalogue-models:** Synchronize repo versions
|
|
9
9
|
|
|
10
|
-
## [0.0.3-next.
|
|
10
|
+
## [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)
|
|
11
11
|
|
|
12
12
|
|
|
13
13
|
### Miscellaneous Chores
|
|
14
14
|
|
|
15
15
|
* **federated-catalogue-models:** Synchronize repo versions
|
|
16
16
|
|
|
17
|
-
## [0.0.3-next.
|
|
17
|
+
## [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)
|
|
18
18
|
|
|
19
19
|
|
|
20
20
|
### Miscellaneous Chores
|
|
21
21
|
|
|
22
22
|
* **federated-catalogue-models:** Synchronize repo versions
|
|
23
23
|
|
|
24
|
-
## [0.0.3-next.
|
|
24
|
+
## [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)
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
### Miscellaneous Chores
|
|
28
|
+
|
|
29
|
+
* **federated-catalogue-models:** Synchronize repo versions
|
|
30
|
+
|
|
31
|
+
## [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)
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
### Miscellaneous Chores
|
|
35
|
+
|
|
36
|
+
* **federated-catalogue-models:** Synchronize repo versions
|
|
37
|
+
|
|
38
|
+
## [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)
|
|
25
39
|
|
|
26
40
|
|
|
27
41
|
### Features
|
|
28
42
|
|
|
29
|
-
* update json-ld patterns ([172aff0](https://github.com/
|
|
43
|
+
* update json-ld patterns ([172aff0](https://github.com/iotaledger/twin-federated-catalogue/commit/172aff07d0f0b780f72d1be3a4896bbf12f6173a))
|
|
30
44
|
|
|
31
|
-
## [0.0.3-next.9](https://github.com/
|
|
45
|
+
## [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)
|
|
32
46
|
|
|
33
47
|
|
|
34
48
|
### Miscellaneous Chores
|
|
35
49
|
|
|
36
50
|
* **federated-catalogue-models:** Synchronize repo versions
|
|
37
51
|
|
|
38
|
-
## [0.0.3-next.8](https://github.com/
|
|
52
|
+
## [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)
|
|
39
53
|
|
|
40
54
|
|
|
41
55
|
### Features
|
|
42
56
|
|
|
43
|
-
* use new hosting url for cursor links ([e42c934](https://github.com/
|
|
57
|
+
* use new hosting url for cursor links ([e42c934](https://github.com/iotaledger/twin-federated-catalogue/commit/e42c934b9c8748ec5bdd4803c1cdc05c82ccace8))
|
|
44
58
|
|
|
45
|
-
## [0.0.3-next.7](https://github.com/
|
|
59
|
+
## [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)
|
|
46
60
|
|
|
47
61
|
|
|
48
62
|
### Miscellaneous Chores
|
|
49
63
|
|
|
50
64
|
* **federated-catalogue-models:** Synchronize repo versions
|
|
51
65
|
|
|
52
|
-
## [0.0.3-next.6](https://github.com/
|
|
66
|
+
## [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)
|
|
53
67
|
|
|
54
68
|
|
|
55
69
|
### Bug Fixes
|
|
56
70
|
|
|
57
|
-
* transform GuardError to CatalogError for DS Protocol compliance ([#49](https://github.com/
|
|
71
|
+
* 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))
|
|
58
72
|
|
|
59
|
-
## [0.0.3-next.5](https://github.com/
|
|
73
|
+
## [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)
|
|
60
74
|
|
|
61
75
|
|
|
62
76
|
### Bug Fixes
|
|
63
77
|
|
|
64
|
-
* pagination and ld context ([#45](https://github.com/
|
|
78
|
+
* pagination and ld context ([#45](https://github.com/iotaledger/twin-federated-catalogue/issues/45)) ([e36f096](https://github.com/iotaledger/twin-federated-catalogue/commit/e36f096aa4fdc61eb5b929a0fc4403247dbd41ce))
|
|
65
79
|
|
|
66
|
-
## [0.0.3-next.4](https://github.com/
|
|
80
|
+
## [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)
|
|
67
81
|
|
|
68
82
|
|
|
69
83
|
### Features
|
|
70
84
|
|
|
71
|
-
* updates standards dependencies ([62f5d9c](https://github.com/
|
|
85
|
+
* updates standards dependencies ([62f5d9c](https://github.com/iotaledger/twin-federated-catalogue/commit/62f5d9c6180bc27497ac43624ffd714e7ce65ce6))
|
|
72
86
|
|
|
73
|
-
## [0.0.3-next.3](https://github.com/
|
|
87
|
+
## [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)
|
|
74
88
|
|
|
75
89
|
|
|
76
90
|
### Miscellaneous Chores
|
|
77
91
|
|
|
78
92
|
* **federated-catalogue-models:** Synchronize repo versions
|
|
79
93
|
|
|
80
|
-
## [0.0.3-next.2](https://github.com/
|
|
94
|
+
## [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)
|
|
81
95
|
|
|
82
96
|
|
|
83
97
|
### Features
|
|
84
98
|
|
|
85
|
-
* implement Dataspace Protocol federated catalogue ([#36](https://github.com/
|
|
99
|
+
* 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))
|
|
86
100
|
|
|
87
101
|
## v0.0.1-next.1
|
|
88
102
|
|
|
@@ -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
|
|
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
|
|
24
|
+
> `optional` **cursor?**: `string`
|
|
25
25
|
|
|
26
26
|
Opaque cursor token for pagination.
|
|
27
27
|
|
|
28
28
|
#### limit?
|
|
29
29
|
|
|
30
|
-
> `optional` **limit
|
|
30
|
+
> `optional` **limit?**: `string`
|
|
31
31
|
|
|
32
32
|
Limit for pagination.
|
|
@@ -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
|
|
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
|
|
16
|
+
> `optional` **link?**: `string` \| `string`[]
|
|
17
17
|
|
|
18
18
|
***
|
|
19
19
|
|
|
20
|
-
### statusCode?
|
|
20
|
+
### statusCode? {#statuscode}
|
|
21
21
|
|
|
22
|
-
> `optional` **statusCode
|
|
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
|
|
|
@@ -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
|
|
|
@@ -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
|
|
|
@@ -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
|
|
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,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@twin.org/federated-catalogue-models",
|
|
3
|
-
"version": "0.0.3-next.
|
|
3
|
+
"version": "0.0.3-next.15",
|
|
4
4
|
"description": "Models which define the structure of the Federated Catalogue Service",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
7
|
-
"url": "https://github.com/
|
|
7
|
+
"url": "git+https://github.com/iotaledger/federated-catalogue.git",
|
|
8
8
|
"directory": "packages/federated-catalogue-models"
|
|
9
9
|
},
|
|
10
10
|
"author": "cornel.filip@iota.org",
|
|
@@ -51,7 +51,7 @@
|
|
|
51
51
|
"schemas"
|
|
52
52
|
],
|
|
53
53
|
"bugs": {
|
|
54
|
-
"url": "git+https://github.com/
|
|
54
|
+
"url": "git+https://github.com/iotaledger/federated-catalogue/issues"
|
|
55
55
|
},
|
|
56
56
|
"homepage": "https://twindev.org"
|
|
57
57
|
}
|