@twin.org/federated-catalogue-models 0.0.3-next.22 → 0.0.3-next.23

package/dist/es/index.js

@@ -9,6 +9,8 @@ export * from "./models/api/IDatasetRemoveRequest.js";
 export * from "./models/api/IDatasetRemoveResponse.js";
 export * from "./models/api/IDatasetSetRequest.js";
 export * from "./models/api/IDatasetSetResponse.js";
+export * from "./models/federatedCatalogueMetricIds.js";
+export * from "./models/federatedCatalogueMetrics.js";
 export * from "./models/IFederatedCatalogueComponent.js";
 export * from "./models/IFederatedCatalogueFilter.js";
 //# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,gDAAgD,CAAC;AAC/D,cAAc,wCAAwC,CAAC;AACvD,cAAc,yCAAyC,CAAC;AACxD,cAAc,oCAAoC,CAAC;AACnD,cAAc,qCAAqC,CAAC;AACpD,cAAc,uCAAuC,CAAC;AACtD,cAAc,wCAAwC,CAAC;AACvD,cAAc,oCAAoC,CAAC;AACnD,cAAc,qCAAqC,CAAC;AACpD,cAAc,0CAA0C,CAAC;AACzD,cAAc,uCAAuC,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./factories/federatedCatalogueFilterFactory.js\";\nexport * from \"./models/api/ICatalogRequestRequest.js\";\nexport * from \"./models/api/ICatalogRequestResponse.js\";\nexport * from \"./models/api/IDatasetGetRequest.js\";\nexport * from \"./models/api/IDatasetGetResponse.js\";\nexport * from \"./models/api/IDatasetRemoveRequest.js\";\nexport * from \"./models/api/IDatasetRemoveResponse.js\";\nexport * from \"./models/api/IDatasetSetRequest.js\";\nexport * from \"./models/api/IDatasetSetResponse.js\";\nexport * from \"./models/IFederatedCatalogueComponent.js\";\nexport * from \"./models/IFederatedCatalogueFilter.js\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,gDAAgD,CAAC;AAC/D,cAAc,wCAAwC,CAAC;AACvD,cAAc,yCAAyC,CAAC;AACxD,cAAc,oCAAoC,CAAC;AACnD,cAAc,qCAAqC,CAAC;AACpD,cAAc,uCAAuC,CAAC;AACtD,cAAc,wCAAwC,CAAC;AACvD,cAAc,oCAAoC,CAAC;AACnD,cAAc,qCAAqC,CAAC;AACpD,cAAc,yCAAyC,CAAC;AACxD,cAAc,uCAAuC,CAAC;AACtD,cAAc,0CAA0C,CAAC;AACzD,cAAc,uCAAuC,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./factories/federatedCatalogueFilterFactory.js\";\nexport * from \"./models/api/ICatalogRequestRequest.js\";\nexport * from \"./models/api/ICatalogRequestResponse.js\";\nexport * from \"./models/api/IDatasetGetRequest.js\";\nexport * from \"./models/api/IDatasetGetResponse.js\";\nexport * from \"./models/api/IDatasetRemoveRequest.js\";\nexport * from \"./models/api/IDatasetRemoveResponse.js\";\nexport * from \"./models/api/IDatasetSetRequest.js\";\nexport * from \"./models/api/IDatasetSetResponse.js\";\nexport * from \"./models/federatedCatalogueMetricIds.js\";\nexport * from \"./models/federatedCatalogueMetrics.js\";\nexport * from \"./models/IFederatedCatalogueComponent.js\";\nexport * from \"./models/IFederatedCatalogueFilter.js\";\n"]}

package/dist/es/models/federatedCatalogueMetricIds.js

@@ -0,0 +1,33 @@
+// Copyright 2025 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Metric IDs for the federated catalogue service.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const FederatedCatalogueMetricIds = {
+    /**
+     * Number of datasets retrieved.
+     */
+    DatasetsRetrieved: "fc_datasets_retrieved",
+    /**
+     * Number of datasets stored.
+     */
+    DatasetsStored: "fc_datasets_stored",
+    /**
+     * Number of datasets removed.
+     */
+    DatasetsRemoved: "fc_datasets_removed",
+    /**
+     * Number of queries executed.
+     */
+    QueriesExecuted: "fc_queries_executed",
+    /**
+     * Number of filter indexes created.
+     */
+    FilterIndexesCreated: "fc_filter_indexes_created",
+    /**
+     * Number of filter index failures.
+     */
+    FilterIndexFailures: "fc_filter_index_failures"
+};
+//# sourceMappingURL=federatedCatalogueMetricIds.js.map

package/dist/es/models/federatedCatalogueMetricIds.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"federatedCatalogueMetricIds.js","sourceRoot":"","sources":["../../../src/models/federatedCatalogueMetricIds.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,2BAA2B,GAAG;IAC1C;;OAEG;IACH,iBAAiB,EAAE,uBAAuB;IAE1C;;OAEG;IACH,cAAc,EAAE,oBAAoB;IAEpC;;OAEG;IACH,eAAe,EAAE,qBAAqB;IAEtC;;OAEG;IACH,eAAe,EAAE,qBAAqB;IAEtC;;OAEG;IACH,oBAAoB,EAAE,2BAA2B;IAEjD;;OAEG;IACH,mBAAmB,EAAE,0BAA0B;CACtC,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Metric IDs for the federated catalogue service.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const FederatedCatalogueMetricIds = {\n\t/**\n\t * Number of datasets retrieved.\n\t */\n\tDatasetsRetrieved: \"fc_datasets_retrieved\",\n\n\t/**\n\t * Number of datasets stored.\n\t */\n\tDatasetsStored: \"fc_datasets_stored\",\n\n\t/**\n\t * Number of datasets removed.\n\t */\n\tDatasetsRemoved: \"fc_datasets_removed\",\n\n\t/**\n\t * Number of queries executed.\n\t */\n\tQueriesExecuted: \"fc_queries_executed\",\n\n\t/**\n\t * Number of filter indexes created.\n\t */\n\tFilterIndexesCreated: \"fc_filter_indexes_created\",\n\n\t/**\n\t * Number of filter index failures.\n\t */\n\tFilterIndexFailures: \"fc_filter_index_failures\"\n} as const;\n\n/**\n * Metric IDs for the federated catalogue service.\n */\nexport type FederatedCatalogueMetricIds =\n\t(typeof FederatedCatalogueMetricIds)[keyof typeof FederatedCatalogueMetricIds];\n"]}

package/dist/es/models/federatedCatalogueMetrics.js

@@ -0,0 +1,41 @@
+// Copyright 2025 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { MetricType } from "@twin.org/telemetry-models";
+import { FederatedCatalogueMetricIds } from "./federatedCatalogueMetricIds.js";
+/**
+ * Metrics registered by the federated catalogue service.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const FederatedCatalogueMetrics = [
+    {
+        id: FederatedCatalogueMetricIds.DatasetsRetrieved,
+        label: "Datasets retrieved",
+        type: MetricType.Counter
+    },
+    {
+        id: FederatedCatalogueMetricIds.DatasetsStored,
+        label: "Datasets stored",
+        type: MetricType.Counter
+    },
+    {
+        id: FederatedCatalogueMetricIds.DatasetsRemoved,
+        label: "Datasets removed",
+        type: MetricType.Counter
+    },
+    {
+        id: FederatedCatalogueMetricIds.QueriesExecuted,
+        label: "Queries executed",
+        type: MetricType.Counter
+    },
+    {
+        id: FederatedCatalogueMetricIds.FilterIndexesCreated,
+        label: "Filter indexes created",
+        type: MetricType.Counter
+    },
+    {
+        id: FederatedCatalogueMetricIds.FilterIndexFailures,
+        label: "Filter index failures",
+        type: MetricType.Counter
+    }
+];
+//# sourceMappingURL=federatedCatalogueMetrics.js.map

package/dist/es/models/federatedCatalogueMetrics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"federatedCatalogueMetrics.js","sourceRoot":"","sources":["../../../src/models/federatedCatalogueMetrics.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAyB,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAC/E,OAAO,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC;AAE/E;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,yBAAyB,GAAuB;IAC5D;QACC,EAAE,EAAE,2BAA2B,CAAC,iBAAiB;QACjD,KAAK,EAAE,oBAAoB;QAC3B,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,2BAA2B,CAAC,cAAc;QAC9C,KAAK,EAAE,iBAAiB;QACxB,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,2BAA2B,CAAC,eAAe;QAC/C,KAAK,EAAE,kBAAkB;QACzB,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,2BAA2B,CAAC,eAAe;QAC/C,KAAK,EAAE,kBAAkB;QACzB,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,2BAA2B,CAAC,oBAAoB;QACpD,KAAK,EAAE,wBAAwB;QAC/B,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,2BAA2B,CAAC,mBAAmB;QACnD,KAAK,EAAE,uBAAuB;QAC9B,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;CACD,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { type ITelemetryMetric, MetricType } from \"@twin.org/telemetry-models\";\nimport { FederatedCatalogueMetricIds } from \"./federatedCatalogueMetricIds.js\";\n\n/**\n * Metrics registered by the federated catalogue service.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const FederatedCatalogueMetrics: ITelemetryMetric[] = [\n\t{\n\t\tid: FederatedCatalogueMetricIds.DatasetsRetrieved,\n\t\tlabel: \"Datasets retrieved\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: FederatedCatalogueMetricIds.DatasetsStored,\n\t\tlabel: \"Datasets stored\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: FederatedCatalogueMetricIds.DatasetsRemoved,\n\t\tlabel: \"Datasets removed\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: FederatedCatalogueMetricIds.QueriesExecuted,\n\t\tlabel: \"Queries executed\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: FederatedCatalogueMetricIds.FilterIndexesCreated,\n\t\tlabel: \"Filter indexes created\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: FederatedCatalogueMetricIds.FilterIndexFailures,\n\t\tlabel: \"Filter index failures\",\n\t\ttype: MetricType.Counter\n\t}\n];\n"]}

package/dist/types/index.d.ts

@@ -7,5 +7,7 @@ export * from "./models/api/IDatasetRemoveRequest.js";
 export * from "./models/api/IDatasetRemoveResponse.js";
 export * from "./models/api/IDatasetSetRequest.js";
 export * from "./models/api/IDatasetSetResponse.js";
+export * from "./models/federatedCatalogueMetricIds.js";
+export * from "./models/federatedCatalogueMetrics.js";
 export * from "./models/IFederatedCatalogueComponent.js";
 export * from "./models/IFederatedCatalogueFilter.js";

package/dist/types/models/federatedCatalogueMetricIds.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Metric IDs for the federated catalogue service.
+ */
+export declare const FederatedCatalogueMetricIds: {
+    /**
+     * Number of datasets retrieved.
+     */
+    readonly DatasetsRetrieved: "fc_datasets_retrieved";
+    /**
+     * Number of datasets stored.
+     */
+    readonly DatasetsStored: "fc_datasets_stored";
+    /**
+     * Number of datasets removed.
+     */
+    readonly DatasetsRemoved: "fc_datasets_removed";
+    /**
+     * Number of queries executed.
+     */
+    readonly QueriesExecuted: "fc_queries_executed";
+    /**
+     * Number of filter indexes created.
+     */
+    readonly FilterIndexesCreated: "fc_filter_indexes_created";
+    /**
+     * Number of filter index failures.
+     */
+    readonly FilterIndexFailures: "fc_filter_index_failures";
+};
+/**
+ * Metric IDs for the federated catalogue service.
+ */
+export type FederatedCatalogueMetricIds = (typeof FederatedCatalogueMetricIds)[keyof typeof FederatedCatalogueMetricIds];

package/dist/types/models/federatedCatalogueMetrics.d.ts

@@ -0,0 +1,5 @@
+import { type ITelemetryMetric } from "@twin.org/telemetry-models";
+/**
+ * Metrics registered by the federated catalogue service.
+ */
+export declare const FederatedCatalogueMetrics: ITelemetryMetric[];

package/docs/changelog.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.0.3-next.23](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-models-v0.0.3-next.22...federated-catalogue-models-v0.0.3-next.23) (2026-06-19)
+
+
+### Features
+
+* add telemetry metrics to federated catalogue ([#93](https://github.com/iotaledger/twin-federated-catalogue/issues/93)) ([abd8965](https://github.com/iotaledger/twin-federated-catalogue/commit/abd89657d3991e6a50f8ed3845186069549df769))
+
 ## [0.0.3-next.22](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-models-v0.0.3-next.21...federated-catalogue-models-v0.0.3-next.22) (2026-06-18)
 
 

package/docs/reference/index.md

@@ -13,6 +13,12 @@
 - [IDatasetSetRequest](interfaces/IDatasetSetRequest.md)
 - [IDatasetSetResponse](interfaces/IDatasetSetResponse.md)
 
+## Type Aliases
+
+- [FederatedCatalogueMetricIds](type-aliases/FederatedCatalogueMetricIds.md)
+
 ## Variables
 
 - [FederatedCatalogueFilterFactory](variables/FederatedCatalogueFilterFactory.md)
+- [FederatedCatalogueMetricIds](variables/FederatedCatalogueMetricIds.md)
+- [FederatedCatalogueMetrics](variables/FederatedCatalogueMetrics.md)

package/docs/reference/type-aliases/FederatedCatalogueMetricIds.md

@@ -0,0 +1,5 @@
+# Type Alias: FederatedCatalogueMetricIds
+
+> **FederatedCatalogueMetricIds** = *typeof* [`FederatedCatalogueMetricIds`](../variables/FederatedCatalogueMetricIds.md)\[keyof *typeof* [`FederatedCatalogueMetricIds`](../variables/FederatedCatalogueMetricIds.md)\]
+
+Metric IDs for the federated catalogue service.

package/docs/reference/variables/FederatedCatalogueMetricIds.md

@@ -0,0 +1,43 @@
+# Variable: FederatedCatalogueMetricIds
+
+> `const` **FederatedCatalogueMetricIds**: `object`
+
+Metric IDs for the federated catalogue service.
+
+## Type Declaration
+
+### DatasetsRetrieved {#datasetsretrieved}
+
+> `readonly` **DatasetsRetrieved**: `"fc_datasets_retrieved"` = `"fc_datasets_retrieved"`
+
+Number of datasets retrieved.
+
+### DatasetsStored {#datasetsstored}
+
+> `readonly` **DatasetsStored**: `"fc_datasets_stored"` = `"fc_datasets_stored"`
+
+Number of datasets stored.
+
+### DatasetsRemoved {#datasetsremoved}
+
+> `readonly` **DatasetsRemoved**: `"fc_datasets_removed"` = `"fc_datasets_removed"`
+
+Number of datasets removed.
+
+### QueriesExecuted {#queriesexecuted}
+
+> `readonly` **QueriesExecuted**: `"fc_queries_executed"` = `"fc_queries_executed"`
+
+Number of queries executed.
+
+### FilterIndexesCreated {#filterindexescreated}
+
+> `readonly` **FilterIndexesCreated**: `"fc_filter_indexes_created"` = `"fc_filter_indexes_created"`
+
+Number of filter indexes created.
+
+### FilterIndexFailures {#filterindexfailures}
+
+> `readonly` **FilterIndexFailures**: `"fc_filter_index_failures"` = `"fc_filter_index_failures"`
+
+Number of filter index failures.

package/docs/reference/variables/FederatedCatalogueMetrics.md

@@ -0,0 +1,5 @@
+# Variable: FederatedCatalogueMetrics
+
+> `const` **FederatedCatalogueMetrics**: `ITelemetryMetric`[]
+
+Metrics registered by the federated catalogue service.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/federated-catalogue-models",
-	"version": "0.0.3-next.22",
+	"version": "0.0.3-next.23",
 	"description": "Models which define the structure of the Federated Catalogue Service",
 	"repository": {
 		"type": "git",
@@ -21,6 +21,7 @@
 		"@twin.org/nameof": "next",
 		"@twin.org/standards-dataspace-protocol": "next",
 		"@twin.org/standards-w3c-dcat": "next",
+		"@twin.org/telemetry-models": "next",
 		"@twin.org/trust-models": "next",
 		"@twin.org/web": "next"
 	},