feat!: rework library structure

eclipse-thingweb · Jan 4, 2024 · 970ed35 · 970ed35
1 parent a6396c2
commit 970ed35
Show file tree

Hide file tree

Showing 103 changed files with 541 additions and 314 deletions.
diff --git a/example/coap_discovery.dart b/example/coap_discovery.dart
@@ -6,7 +6,8 @@
 
 // ignore_for_file: avoid_print
 
-import "package:dart_wot/dart_wot.dart";
+import "package:dart_wot/binding_coap.dart";
+import "package:dart_wot/core.dart";
 
 const propertyName = "string";
 

diff --git a/example/coap_dns_sd_discovery.dart b/example/coap_dns_sd_discovery.dart
@@ -6,7 +6,8 @@
 
 // ignore_for_file: avoid_print
 
-import "package:dart_wot/dart_wot.dart";
+import "package:dart_wot/binding_coap.dart";
+import "package:dart_wot/core.dart";
 
 void handleThingDescription(ThingDescription thingDescription) =>
     print('Discovered TD with title "${thingDescription.title}".');

diff --git a/example/coaps_readproperty.dart b/example/coaps_readproperty.dart
@@ -8,7 +8,8 @@
 
 import "dart:typed_data";
 
-import "package:dart_wot/dart_wot.dart";
+import "package:dart_wot/binding_coap.dart";
+import "package:dart_wot/core.dart";
 
 /// Matches [PskCredentials] by hostname and URI scheme.
 final Map<Uri, PskCredentials> _pskCredentialsStore = {

diff --git a/example/complex_example.dart b/example/complex_example.dart
@@ -6,7 +6,9 @@
 
 // ignore_for_file: avoid_print
 
-import "package:dart_wot/dart_wot.dart";
+import "package:dart_wot/binding_coap.dart";
+import "package:dart_wot/binding_http.dart";
+import "package:dart_wot/core.dart";
 
 const thingDescriptionJson = {
   "@context": [

diff --git a/example/core_link_format_discovery.dart b/example/core_link_format_discovery.dart
@@ -6,7 +6,8 @@
 
 // ignore_for_file: avoid_print
 
-import "package:dart_wot/dart_wot.dart";
+import "package:dart_wot/binding_coap.dart";
+import "package:dart_wot/core.dart";
 
 Future<void> main(List<String> args) async {
   final servient = Servient(clientFactories: [CoapClientFactory()]);

diff --git a/example/example.dart b/example/example.dart
@@ -6,7 +6,8 @@
 
 // ignore_for_file: avoid_print
 
-import "package:dart_wot/dart_wot.dart";
+import "package:dart_wot/binding_coap.dart";
+import "package:dart_wot/core.dart";
 
 Future<void> main(List<String> args) async {
   final servient = Servient(

diff --git a/example/http_basic_authentication.dart b/example/http_basic_authentication.dart
@@ -6,7 +6,8 @@
 
 // ignore_for_file: avoid_print
 
-import "package:dart_wot/dart_wot.dart";
+import "package:dart_wot/binding_http.dart";
+import "package:dart_wot/core.dart";
 
 const username = "username";
 const password = "password";

diff --git a/example/mqtt_example.dart b/example/mqtt_example.dart
@@ -6,7 +6,8 @@
 
 // ignore_for_file: avoid_print
 
-import "package:dart_wot/dart_wot.dart";
+import "package:dart_wot/binding_mqtt.dart";
+import "package:dart_wot/core.dart";
 
 const thingDescriptionJson = {
   "@context": "https://www.w3.org/2022/wot/td/v1.1",

diff --git a/lib/core.dart b/lib/core.dart
@@ -23,7 +23,39 @@ export "src/core/credentials/credentials.dart";
 export "src/core/credentials/digest_credentials.dart";
 export "src/core/credentials/oauth2_credentials.dart";
 export "src/core/credentials/psk_credentials.dart";
+
+export "src/core/definitions/form.dart";
+
+export "src/core/definitions/security/ace_security_scheme.dart";
+export "src/core/definitions/security/apikey_security_scheme.dart";
+export "src/core/definitions/security/auto_security_scheme.dart";
+export "src/core/definitions/security/basic_security_scheme.dart";
+export "src/core/definitions/security/bearer_security_scheme.dart";
+export "src/core/definitions/security/combo_security_scheme.dart";
+export "src/core/definitions/security/digest_security_scheme.dart";
+export "src/core/definitions/security/no_security_scheme.dart";
+export "src/core/definitions/security/oauth2_security_scheme.dart";
+export "src/core/definitions/security/psk_security_scheme.dart";
+
+export "src/core/definitions/thing_description.dart";
+export "src/core/definitions/thing_model.dart";
+export "src/core/definitions/validation/thing_description_schema.dart"
+    show thingDescriptionSchema;
+
 export "src/core/protocol_interfaces/protocol_client.dart";
 export "src/core/protocol_interfaces/protocol_client_factory.dart";
 export "src/core/protocol_interfaces/protocol_server.dart";
+
+export "src/core/scripting_api/consumed_thing.dart";
+export "src/core/scripting_api/data_schema_value.dart";
+export "src/core/scripting_api/discovery/discovery_method.dart";
+export "src/core/scripting_api/discovery/thing_discovery.dart";
+export "src/core/scripting_api/discovery/thing_filter.dart";
+export "src/core/scripting_api/exposed_thing.dart";
+export "src/core/scripting_api/interaction_input.dart";
+export "src/core/scripting_api/interaction_output.dart";
+export "src/core/scripting_api/subscription.dart";
+export "src/core/scripting_api/types.dart";
+export "src/core/scripting_api/wot.dart";
+
 export "src/core/servient.dart";
diff --git a/lib/dart_wot.dart b/lib/dart_wot.dart
diff --git a/lib/definitions.dart b/lib/definitions.dart
diff --git a/lib/scripting_api.dart b/lib/scripting_api.dart
diff --git a/lib/src/binding_coap/coap_client.dart b/lib/src/binding_coap/coap_client.dart
@@ -16,10 +16,9 @@ import "../core/content.dart";
 import "../core/credentials/ace_credentials.dart";
 import "../core/credentials/callbacks.dart";
 import "../core/credentials/psk_credentials.dart";
+import "../core/definitions/operation_type.dart";
 import "../core/protocol_interfaces/protocol_client.dart";
-import "../definitions/form.dart";
-import "../definitions/operation_type.dart";
-import "../scripting_api/subscription.dart";
+import "../core/scripting_api/subscription.dart";
 import "coap_binding_exception.dart";
 import "coap_config.dart";
 import "coap_definitions.dart";
@@ -256,7 +255,7 @@ final class CoapClient implements ProtocolClient {
   }
 
   /// Obtains an ACE creation hint serialized as a [List] of [int] from a
-  /// [Form].
+  /// [form].
   ///
   /// Returns `null` if no `ACESecurityScheme` is defined.
   Future<AuthServerRequestCreationHint?> _obtainAceCreationHintFromForm(

diff --git a/lib/src/binding_coap/coap_extensions.dart b/lib/src/binding_coap/coap_extensions.dart
@@ -3,17 +3,13 @@ import "dart:typed_data";
 
 import "package:cbor/cbor.dart";
 import "package:coap/coap.dart";
-import "package:dcaf/dcaf.dart";
-
-import "../core/augmented_form.dart";
-import "../core/content.dart";
-import "../definitions/expected_response.dart";
-import "../definitions/form.dart";
-import "../definitions/operation_type.dart";
-import "../definitions/security/ace_security_scheme.dart";
-import "../definitions/security/auto_security_scheme.dart";
-import "../definitions/security/psk_security_scheme.dart";
-import "../definitions/validation/validation_exception.dart";
+
+import "package:dart_wot/core.dart" hide PskCredentials;
+import "package:dart_wot/src/core/content.dart";
+import "package:dart_wot/src/core/definitions/expected_response.dart";
+import "package:dart_wot/src/core/definitions/operation_type.dart";
+import "package:dart_wot/src/core/definitions/validation/validation_exception.dart";
+
 import "coap_binding_exception.dart";
 import "coap_definitions.dart";
 

diff --git a/lib/src/binding_coap/coap_server.dart b/lib/src/binding_coap/coap_server.dart
@@ -6,7 +6,7 @@
 
 import "../core/credentials/callbacks.dart";
 import "../core/protocol_interfaces/protocol_server.dart";
-import "../scripting_api/exposed_thing.dart";
+import '../core/scripting_api/exposed_thing.dart';
 import "coap_config.dart";
 
 /// A [ProtocolServer] for the Constrained Application Protocol (CoAP).

diff --git a/lib/src/binding_coap/coap_subscription.dart b/lib/src/binding_coap/coap_subscription.dart
@@ -6,7 +6,7 @@
 
 import "package:coap/coap.dart";
 
-import "../scripting_api/subscription.dart";
+import '../core/scripting_api/subscription.dart';
 
 /// [Subscription] to a CoAP resource, based on the observe option ([RFC 7641]).
 ///

diff --git a/lib/src/binding_http/http_client.dart b/lib/src/binding_http/http_client.dart
@@ -7,19 +7,11 @@
 import "dart:convert";
 import "dart:io";
 
+import "package:dart_wot/core.dart";
+import "package:dart_wot/src/core/definitions/operation_type.dart";
 import "package:http/http.dart";
 
-import "../core/augmented_form.dart";
 import "../core/content.dart";
-import "../core/credentials/basic_credentials.dart";
-import "../core/credentials/bearer_credentials.dart";
-import "../core/credentials/callbacks.dart";
-import "../core/protocol_interfaces/protocol_client.dart";
-import "../definitions/form.dart";
-import "../definitions/operation_type.dart";
-import "../definitions/security/basic_security_scheme.dart";
-import "../definitions/security/bearer_security_scheme.dart";
-import "../scripting_api/subscription.dart";
 import "http_request_method.dart";
 import "http_security_exception.dart";
 

diff --git a/lib/src/binding_http/http_request_method.dart b/lib/src/binding_http/http_request_method.dart
@@ -1,5 +1,5 @@
-import "../definitions/form.dart";
-import "../definitions/operation_type.dart";
+import "package:dart_wot/src/core/definitions/form.dart";
+import "package:dart_wot/src/core/definitions/operation_type.dart";
 
 const _getString = "GET";
 const _putString = "PUT";

diff --git a/lib/src/binding_http/http_server.dart b/lib/src/binding_http/http_server.dart
@@ -6,7 +6,7 @@
 
 import "../core/credentials/callbacks.dart";
 import "../core/protocol_interfaces/protocol_server.dart";
-import "../scripting_api/exposed_thing.dart";
+import "../core/scripting_api/exposed_thing.dart";
 import "http_config.dart";
 
 /// A [ProtocolServer] for the Hypertext Transfer Protocol (HTTP).

diff --git a/lib/src/binding_mqtt/mqtt_client.dart b/lib/src/binding_mqtt/mqtt_client.dart
@@ -15,7 +15,7 @@ import "../core/content.dart";
 import "../core/credentials/basic_credentials.dart";
 import "../core/credentials/callbacks.dart";
 import "../core/protocol_interfaces/protocol_client.dart";
-import "../scripting_api/subscription.dart" as scripting_api;
+import "../core/scripting_api/subscription.dart" as scripting_api;
 import "constants.dart";
 import "mqtt_binding_exception.dart";
 import "mqtt_config.dart";

diff --git a/lib/src/binding_mqtt/mqtt_extensions.dart b/lib/src/binding_mqtt/mqtt_extensions.dart
@@ -5,16 +5,13 @@
 // SPDX-License-Identifier: BSD-3-Clause
 
 import "package:curie/curie.dart";
+import "package:dart_wot/src/core/definitions/validation/validation_exception.dart";
 import "package:mqtt_client/mqtt_client.dart";
 import "package:mqtt_client/mqtt_server_client.dart";
 import "package:uuid/uuid.dart";
 
-import "../core/augmented_form.dart";
-import "../core/credentials/basic_credentials.dart";
-import "../definitions/form.dart";
-import "../definitions/security/auto_security_scheme.dart";
-import "../definitions/security/basic_security_scheme.dart";
-import "../definitions/validation/validation_exception.dart";
+import "../../core.dart";
+
 import "constants.dart";
 import "mqtt_binding_exception.dart";
 

diff --git a/lib/src/binding_mqtt/mqtt_subscription.dart b/lib/src/binding_mqtt/mqtt_subscription.dart
@@ -4,12 +4,12 @@
 //
 // SPDX-License-Identifier: BSD-3-Clause
 
+import "package:dart_wot/core.dart";
 import "package:mqtt_client/mqtt_client.dart";
 import "package:mqtt_client/mqtt_server_client.dart";
 
 import "../core/content.dart";
-import "../definitions/form.dart";
-import "../scripting_api/subscription.dart" as scripting_api;
+import "../core/scripting_api/subscription.dart" as scripting_api;
 
 /// [scripting_api.Subscription] for the MQTT protocol.
 class MqttSubscription implements scripting_api.Subscription {

diff --git a/lib/src/core/augmented_form.dart b/lib/src/core/augmented_form.dart
@@ -9,14 +9,14 @@ import "package:json_schema/json_schema.dart";
 import "package:meta/meta.dart";
 import "package:uri/uri.dart";
 
-import "../definitions/additional_expected_response.dart";
-import "../definitions/expected_response.dart";
-import "../definitions/form.dart";
-import "../definitions/interaction_affordances/interaction_affordance.dart";
-import "../definitions/operation_type.dart";
-import "../definitions/security/security_scheme.dart";
-import "../definitions/thing_description.dart";
-import "../definitions/validation/validation_exception.dart";
+import "definitions/additional_expected_response.dart";
+import "definitions/expected_response.dart";
+import "definitions/form.dart";
+import "definitions/interaction_affordances/interaction_affordance.dart";
+import "definitions/operation_type.dart";
+import "definitions/security/security_scheme.dart";
+import "definitions/thing_description.dart";
+import "definitions/validation/validation_exception.dart";
 
 /// A [Form] augmented with information from its asscociated [_thingDescription]
 /// and [_interactionAffordance].

diff --git a/lib/src/core/codecs/cbor_codec.dart b/lib/src/core/codecs/cbor_codec.dart
@@ -6,8 +6,8 @@
 
 import "package:cbor/cbor.dart" as cbor;
 
-import "../../definitions/data_schema.dart";
-import "../../scripting_api/data_schema_value.dart";
+import "../definitions/data_schema.dart";
+import "../scripting_api/data_schema_value.dart";
 import "content_codec.dart";
 
 /// A [ContentCodec] that encodes and decodes CBOR data.

diff --git a/lib/src/core/codecs/content_codec.dart b/lib/src/core/codecs/content_codec.dart
@@ -4,8 +4,8 @@
 //
 // SPDX-License-Identifier: BSD-3-Clause
 
-import "../../definitions/data_schema.dart";
-import "../../scripting_api/data_schema_value.dart";
+import "../definitions/data_schema.dart";
+import "../scripting_api/data_schema_value.dart";
 
 /// Interface for providing a codec for a specific media type.
 abstract class ContentCodec {

diff --git a/lib/src/core/codecs/json_codec.dart b/lib/src/core/codecs/json_codec.dart
@@ -6,9 +6,9 @@
 
 import "dart:convert";
 
-import "../../definitions/data_schema.dart";
+import "../definitions/data_schema.dart";
 
-import "../../scripting_api/data_schema_value.dart";
+import "../scripting_api/data_schema_value.dart";
 import "content_codec.dart";
 
 /// A [ContentCodec] that encodes and decodes JSON data.

diff --git a/lib/src/core/codecs/text_codec.dart b/lib/src/core/codecs/text_codec.dart
@@ -6,9 +6,9 @@
 
 import "dart:convert";
 
-import "../../definitions/data_schema.dart";
+import "../definitions/data_schema.dart";
 
-import "../../scripting_api/data_schema_value.dart";
+import "../scripting_api/data_schema_value.dart";
 import "content_codec.dart";
 
 const _utf8Coding = "utf-8";