From 8cdd508bc7a3db3c12b3196a809299616129fdb2 Mon Sep 17 00:00:00 2001
From: Jan Romann <jan.romann@hs-emden-leer.de>
Date: Wed, 22 May 2024 15:21:06 +0200
Subject: [PATCH] feat(discovery): add ExploreDirectoryConfiguration for TDDs

---
 .../discovery/discovery_configuration.dart    | 34 +++++++++++++++++++
 .../core/implementation/thing_discovery.dart  |  6 ++++
 2 files changed, 40 insertions(+)

diff --git a/lib/src/core/implementation/discovery/discovery_configuration.dart b/lib/src/core/implementation/discovery/discovery_configuration.dart
index dbee63c8..2e9c6f4d 100644
--- a/lib/src/core/implementation/discovery/discovery_configuration.dart
+++ b/lib/src/core/implementation/discovery/discovery_configuration.dart
@@ -4,6 +4,8 @@
 //
 // SPDX-License-Identifier: BSD-3-Clause
 
+import "../../scripting_api/discovery/thing_filter.dart";
+
 /// Used to indicate whether the discovery mechanism will be used to discover
 /// Thing Descriptions of Things or Thing Description Directories.
 enum DiscoveryType {
@@ -99,6 +101,38 @@ final class DirectConfiguration extends DiscoveryConfiguration {
   final Uri uri;
 }
 
+/// A configuration that is used for retrieving Thing Descriptions from a Thing
+/// Description Directory (TDD).
+final class ExploreDirectoryConfiguration extends DiscoveryConfiguration {
+  /// Instantiates a new [ExploreDirectoryConfiguration].
+  ///
+  /// The [uri] needs to point to the Thing Description exposed by the TDD that
+  /// is supposed to be used for this [DiscoveryConfiguration].
+  ///
+  /// A [thingFilter] can be provided for filtering and the total number of TDs
+  /// can be [limit]ed.
+  ExploreDirectoryConfiguration(
+    this.uri, {
+    this.thingFilter,
+    this.limit,
+  });
+
+  /// The [Uri] the TDD's Thing Description can be retrieved from.
+  final Uri uri;
+
+  /// Optional filter that is supposed to used as a query parameter and
+  /// to filter received TDs.
+  ///
+  /// Currently, this configuration parameter is unused, however.
+  final ThingFilter? thingFilter;
+
+  /// The maximum number of TDs that should be returned by the Thing Description
+  /// Directory.
+  ///
+  /// Note that, currently, this limit is not being enforced at the client side.
+  final int? limit;
+}
+
 /// Base class for configuring discovery mechanisms that involve a two-step
 /// approach.
 ///
diff --git a/lib/src/core/implementation/thing_discovery.dart b/lib/src/core/implementation/thing_discovery.dart
index 5e6f75c5..b6ddd9ab 100644
--- a/lib/src/core/implementation/thing_discovery.dart
+++ b/lib/src/core/implementation/thing_discovery.dart
@@ -63,6 +63,12 @@ class ThingDiscovery extends Stream<ThingDescription>
           yield* _discoverFromCoreResourceDirectory(uri, discoveryType);
         case DirectConfiguration(:final uri):
           yield* Stream.fromFuture(_servient.requestThingDescription(uri));
+        case ExploreDirectoryConfiguration(:final uri, :final thingFilter):
+          final thingDiscoveryProcess = await _servient.exploreDirectory(
+            uri,
+            thingFilter: thingFilter,
+          );
+          yield* thingDiscoveryProcess;
       }
     }
   }