@twin.org/federated-catalogue-models 0.0.3-next.7 → 0.0.3-next.9
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.
|
@@ -1 +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 {\n\tIDataspaceProtocolCatalog,\n\tIDataspaceProtocolCatalogError\n} from \"@twin.org/standards-dataspace-protocol\";\nimport type { HeaderTypes, HttpStatusCode } from \"@twin.org/web\";\n\n/**\n * The response payload for the catalog request method.\n * Returns a DS Protocol compliant Catalog with participantId, or CatalogError if no datasets found.\n */\nexport interface ICatalogRequestResponse {\n\t/**\n\t * Response status code.\n\t * Per DS Protocol: Returns appropriate HTTP code (e.g., 404) when returning CatalogError.\n\t */\n\tstatusCode?: HttpStatusCode;\n\n\t/**\n\t * The response payload containing the DS Protocol compliant catalog with participantId,\n\t * or a CatalogError if no datasets are found (404).\n\t * Per DS Protocol: Single participant returns flat catalog, multiple participants return nested catalogs.\n\t */\n\tbody: IDataspaceProtocolCatalog | IDataspaceProtocolCatalogError;\n
|
|
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 {\n\tIDataspaceProtocolCatalog,\n\tIDataspaceProtocolCatalogError\n} from \"@twin.org/standards-dataspace-protocol\";\nimport type { HeaderTypes, HttpStatusCode } from \"@twin.org/web\";\n\n/**\n * The response payload for the catalog request method.\n * Returns a DS Protocol compliant Catalog with participantId, or CatalogError if no datasets found.\n */\nexport interface ICatalogRequestResponse {\n\t/**\n\t * Optional headers including RFC 8288 Link header for pagination.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.Link]?: string | string[];\n\t};\n\n\t/**\n\t * Response status code.\n\t * Per DS Protocol: Returns appropriate HTTP code (e.g., 404) when returning CatalogError.\n\t */\n\tstatusCode?: HttpStatusCode;\n\n\t/**\n\t * The response payload containing the DS Protocol compliant catalog with participantId,\n\t * or a CatalogError if no datasets are found (404).\n\t * Per DS Protocol: Single participant returns flat catalog, multiple participants return nested catalogs.\n\t */\n\tbody: IDataspaceProtocolCatalog | IDataspaceProtocolCatalogError;\n}\n"]}
|
|
@@ -5,6 +5,12 @@ import type { HeaderTypes, HttpStatusCode } from "@twin.org/web";
|
|
|
5
5
|
* Returns a DS Protocol compliant Catalog with participantId, or CatalogError if no datasets found.
|
|
6
6
|
*/
|
|
7
7
|
export interface ICatalogRequestResponse {
|
|
8
|
+
/**
|
|
9
|
+
* Optional headers including RFC 8288 Link header for pagination.
|
|
10
|
+
*/
|
|
11
|
+
headers?: {
|
|
12
|
+
[HeaderTypes.Link]?: string | string[];
|
|
13
|
+
};
|
|
8
14
|
/**
|
|
9
15
|
* Response status code.
|
|
10
16
|
* Per DS Protocol: Returns appropriate HTTP code (e.g., 404) when returning CatalogError.
|
|
@@ -16,10 +22,4 @@ export interface ICatalogRequestResponse {
|
|
|
16
22
|
* Per DS Protocol: Single participant returns flat catalog, multiple participants return nested catalogs.
|
|
17
23
|
*/
|
|
18
24
|
body: IDataspaceProtocolCatalog | IDataspaceProtocolCatalogError;
|
|
19
|
-
/**
|
|
20
|
-
* Optional headers including RFC 8288 Link header for pagination.
|
|
21
|
-
*/
|
|
22
|
-
headers?: {
|
|
23
|
-
[HeaderTypes.Link]?: string | string[];
|
|
24
|
-
};
|
|
25
25
|
}
|
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
# @twin.org/federated-catalogue-models - Changelog
|
|
2
2
|
|
|
3
|
+
## [0.0.3-next.9](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.3-next.8...federated-catalogue-models-v0.0.3-next.9) (2026-02-12)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Miscellaneous Chores
|
|
7
|
+
|
|
8
|
+
* **federated-catalogue-models:** Synchronize repo versions
|
|
9
|
+
|
|
10
|
+
## [0.0.3-next.8](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.3-next.7...federated-catalogue-models-v0.0.3-next.8) (2026-01-26)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### Features
|
|
14
|
+
|
|
15
|
+
* use new hosting url for cursor links ([e42c934](https://github.com/twinfoundation/federated-catalogue/commit/e42c934b9c8748ec5bdd4803c1cdc05c82ccace8))
|
|
16
|
+
|
|
3
17
|
## [0.0.3-next.7](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.3-next.6...federated-catalogue-models-v0.0.3-next.7) (2026-01-22)
|
|
4
18
|
|
|
5
19
|
|
|
@@ -5,6 +5,18 @@ Returns a DS Protocol compliant Catalog with participantId, or CatalogError if n
|
|
|
5
5
|
|
|
6
6
|
## Properties
|
|
7
7
|
|
|
8
|
+
### headers?
|
|
9
|
+
|
|
10
|
+
> `optional` **headers**: `object`
|
|
11
|
+
|
|
12
|
+
Optional headers including RFC 8288 Link header for pagination.
|
|
13
|
+
|
|
14
|
+
#### link?
|
|
15
|
+
|
|
16
|
+
> `optional` **link**: `string` \| `string`[]
|
|
17
|
+
|
|
18
|
+
***
|
|
19
|
+
|
|
8
20
|
### statusCode?
|
|
9
21
|
|
|
10
22
|
> `optional` **statusCode**: `HttpStatusCode`
|
|
@@ -21,15 +33,3 @@ Per DS Protocol: Returns appropriate HTTP code (e.g., 404) when returning Catalo
|
|
|
21
33
|
The response payload containing the DS Protocol compliant catalog with participantId,
|
|
22
34
|
or a CatalogError if no datasets are found (404).
|
|
23
35
|
Per DS Protocol: Single participant returns flat catalog, multiple participants return nested catalogs.
|
|
24
|
-
|
|
25
|
-
***
|
|
26
|
-
|
|
27
|
-
### headers?
|
|
28
|
-
|
|
29
|
-
> `optional` **headers**: `object`
|
|
30
|
-
|
|
31
|
-
Optional headers including RFC 8288 Link header for pagination.
|
|
32
|
-
|
|
33
|
-
#### link?
|
|
34
|
-
|
|
35
|
-
> `optional` **link**: `string` \| `string`[]
|