@twin.org/federated-catalogue-models 0.0.3-next.19 → 0.0.3-next.20
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":"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 * @param filter The filter criteria (structure depends on the filter implementation).\n\t * @param cursor The pagination cursor from the previous query, if any.\n\t * @param limit The maximum number of results to return.\n\t * @returns Object containing datasets matching the filter criteria and optional cursor for next page.\n\t */\n\tquery(\n\t\tfilter: unknown,\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): 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"]}
|
|
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 { IDcatDataset } from \"@twin.org/standards-w3c-dcat\";\nimport type { ITrustVerificationInfo } from \"@twin.org/trust-models\";\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 * @param trustInfo The trust verification information for the current request.\n\t * @param filter The filter criteria (structure depends on the filter implementation).\n\t * @param cursor The pagination cursor from the previous query, if any.\n\t * @param limit The maximum number of results to return.\n\t * @returns Object containing datasets matching the filter criteria and optional cursor for next page.\n\t */\n\tquery(\n\t\ttrustInfo: ITrustVerificationInfo,\n\t\tfilter: unknown,\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): 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"]}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type { IComponent } from "@twin.org/core";
|
|
2
2
|
import type { IDcatDataset } from "@twin.org/standards-w3c-dcat";
|
|
3
|
+
import type { ITrustVerificationInfo } from "@twin.org/trust-models";
|
|
3
4
|
/**
|
|
4
5
|
* Interface describing a filter plugin for the federated catalogue.
|
|
5
6
|
* Filter plugins provide extensible query semantics and indexing strategies.
|
|
@@ -9,12 +10,13 @@ export interface IFederatedCatalogueFilter extends IComponent {
|
|
|
9
10
|
/**
|
|
10
11
|
* Execute a filter-specific query over the catalogue.
|
|
11
12
|
* Each filter interprets the payload according to its own semantics.
|
|
13
|
+
* @param trustInfo The trust verification information for the current request.
|
|
12
14
|
* @param filter The filter criteria (structure depends on the filter implementation).
|
|
13
15
|
* @param cursor The pagination cursor from the previous query, if any.
|
|
14
16
|
* @param limit The maximum number of results to return.
|
|
15
17
|
* @returns Object containing datasets matching the filter criteria and optional cursor for next page.
|
|
16
18
|
*/
|
|
17
|
-
query(filter: unknown, cursor?: string, limit?: number): Promise<{
|
|
19
|
+
query(trustInfo: ITrustVerificationInfo, filter: unknown, cursor?: string, limit?: number): Promise<{
|
|
18
20
|
datasets: IDcatDataset[];
|
|
19
21
|
cursor?: string;
|
|
20
22
|
}>;
|
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,12 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.0.3-next.20](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-models-v0.0.3-next.19...federated-catalogue-models-v0.0.3-next.20) (2026-06-11)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* organization identifiers ([#84](https://github.com/iotaledger/twin-federated-catalogue/issues/84)) ([1e02971](https://github.com/iotaledger/twin-federated-catalogue/commit/1e02971a12e40bd20a0034ee1de0988a689d3dc8))
|
|
9
|
+
|
|
3
10
|
## [0.0.3-next.19](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-models-v0.0.3-next.18...federated-catalogue-models-v0.0.3-next.19) (2026-06-08)
|
|
4
11
|
|
|
5
12
|
|
|
@@ -12,13 +12,19 @@ Filters are registered by name in the FilterFactory and do not need to self-iden
|
|
|
12
12
|
|
|
13
13
|
### query() {#query}
|
|
14
14
|
|
|
15
|
-
> **query**(`filter`, `cursor?`, `limit?`): `Promise`\<\{ `datasets`: `IDcatDataset`[]; `cursor?`: `string`; \}\>
|
|
15
|
+
> **query**(`trustInfo`, `filter`, `cursor?`, `limit?`): `Promise`\<\{ `datasets`: `IDcatDataset`[]; `cursor?`: `string`; \}\>
|
|
16
16
|
|
|
17
17
|
Execute a filter-specific query over the catalogue.
|
|
18
18
|
Each filter interprets the payload according to its own semantics.
|
|
19
19
|
|
|
20
20
|
#### Parameters
|
|
21
21
|
|
|
22
|
+
##### trustInfo
|
|
23
|
+
|
|
24
|
+
`ITrustVerificationInfo`
|
|
25
|
+
|
|
26
|
+
The trust verification information for the current request.
|
|
27
|
+
|
|
22
28
|
##### filter
|
|
23
29
|
|
|
24
30
|
`unknown`
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@twin.org/federated-catalogue-models",
|
|
3
|
-
"version": "0.0.3-next.
|
|
3
|
+
"version": "0.0.3-next.20",
|
|
4
4
|
"description": "Models which define the structure of the Federated Catalogue Service",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -21,6 +21,7 @@
|
|
|
21
21
|
"@twin.org/nameof": "next",
|
|
22
22
|
"@twin.org/standards-dataspace-protocol": "next",
|
|
23
23
|
"@twin.org/standards-w3c-dcat": "next",
|
|
24
|
+
"@twin.org/trust-models": "next",
|
|
24
25
|
"@twin.org/web": "next"
|
|
25
26
|
},
|
|
26
27
|
"main": "./dist/es/index.js",
|