Skip to content

Commit 3a2d79a

Browse files
authored
Merge pull request #88 from eclipse-thingweb/rework-library-exports
feat!: rework package structure
2 parents cc69c5b + 05e628f commit 3a2d79a

File tree

115 files changed

+656
-432
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

115 files changed

+656
-432
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,8 @@ Afterward, the actual interactions with the counter are performed by calling the
4949
`invokeAction()` and `readProperty()` methods on the `ConsumedThing`.
5050

5151
```dart
52-
import "package:dart_wot/dart_wot.dart";
52+
import "package:dart_wot/binding_coap.dart";
53+
import "package:dart_wot/core.dart";
5354
5455
Future<void> main(List<String> args) async {
5556
final servient = Servient(

example/coap_discovery.dart

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66

77
// ignore_for_file: avoid_print
88

9-
import "package:dart_wot/dart_wot.dart";
9+
import "package:dart_wot/binding_coap.dart";
10+
import "package:dart_wot/core.dart";
1011

1112
const propertyName = "string";
1213

example/coap_dns_sd_discovery.dart

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66

77
// ignore_for_file: avoid_print
88

9-
import "package:dart_wot/dart_wot.dart";
9+
import "package:dart_wot/binding_coap.dart";
10+
import "package:dart_wot/core.dart";
1011

1112
void handleThingDescription(ThingDescription thingDescription) =>
1213
print('Discovered TD with title "${thingDescription.title}".');

example/coaps_readproperty.dart

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@
88

99
import "dart:typed_data";
1010

11-
import "package:dart_wot/dart_wot.dart";
11+
import "package:dart_wot/binding_coap.dart";
12+
import "package:dart_wot/core.dart";
1213

1314
/// Matches [PskCredentials] by hostname and URI scheme.
1415
final Map<Uri, PskCredentials> _pskCredentialsStore = {

example/complex_example.dart

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@
66

77
// ignore_for_file: avoid_print
88

9-
import "package:dart_wot/dart_wot.dart";
9+
import "package:dart_wot/binding_coap.dart";
10+
import "package:dart_wot/binding_http.dart";
11+
import "package:dart_wot/core.dart";
1012

1113
const thingDescriptionJson = {
1214
"@context": [

example/core_link_format_discovery.dart

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66

77
// ignore_for_file: avoid_print
88

9-
import "package:dart_wot/dart_wot.dart";
9+
import "package:dart_wot/binding_coap.dart";
10+
import "package:dart_wot/core.dart";
1011

1112
Future<void> main(List<String> args) async {
1213
final servient = Servient(clientFactories: [CoapClientFactory()]);

example/example.dart

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66

77
// ignore_for_file: avoid_print
88

9-
import "package:dart_wot/dart_wot.dart";
9+
import "package:dart_wot/binding_coap.dart";
10+
import "package:dart_wot/core.dart";
1011

1112
Future<void> main(List<String> args) async {
1213
final servient = Servient(

example/http_basic_authentication.dart

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66

77
// ignore_for_file: avoid_print
88

9-
import "package:dart_wot/dart_wot.dart";
9+
import "package:dart_wot/binding_http.dart";
10+
import "package:dart_wot/core.dart";
1011

1112
const username = "username";
1213
const password = "password";

example/mqtt_example.dart

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66

77
// ignore_for_file: avoid_print
88

9-
import "package:dart_wot/dart_wot.dart";
9+
import "package:dart_wot/binding_mqtt.dart";
10+
import "package:dart_wot/core.dart";
1011

1112
const thingDescriptionJson = {
1213
"@context": "https://www.w3.org/2022/wot/td/v1.1",

lib/core.dart

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,6 @@
99
/// runtime used for consuming, exposing, and discovering Things.
1010
library core;
1111

12-
export "package:dcaf/dcaf.dart";
13-
14-
export "src/core/augmented_form.dart";
15-
export "src/core/codecs/content_codec.dart";
16-
export "src/core/content_serdes.dart";
17-
export "src/core/credentials/ace_credentials.dart";
18-
export "src/core/credentials/apikey_credentials.dart";
19-
export "src/core/credentials/basic_credentials.dart";
20-
export "src/core/credentials/bearer_credentials.dart";
21-
export "src/core/credentials/callbacks.dart";
22-
export "src/core/credentials/credentials.dart";
23-
export "src/core/credentials/digest_credentials.dart";
24-
export "src/core/credentials/oauth2_credentials.dart";
25-
export "src/core/credentials/psk_credentials.dart";
26-
export "src/core/protocol_interfaces/protocol_client.dart";
27-
export "src/core/protocol_interfaces/protocol_client_factory.dart";
28-
export "src/core/protocol_interfaces/protocol_server.dart";
29-
export "src/core/servient.dart";
12+
export "src/core/definitions.dart";
13+
export "src/core/implementation.dart";
14+
export "src/core/scripting_api.dart";

lib/dart_wot.dart

Lines changed: 0 additions & 15 deletions
This file was deleted.

lib/definitions.dart

Lines changed: 0 additions & 17 deletions
This file was deleted.

lib/scripting_api.dart

Lines changed: 0 additions & 23 deletions
This file was deleted.

lib/src/binding_coap/coap_client.dart

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,8 @@ import "package:coap/coap.dart" as coap;
1111
import "package:coap/config/coap_config_default.dart";
1212
import "package:dcaf/dcaf.dart";
1313

14-
import "../core/augmented_form.dart";
15-
import "../core/content.dart";
16-
import "../core/credentials/ace_credentials.dart";
17-
import "../core/credentials/callbacks.dart";
18-
import "../core/credentials/psk_credentials.dart";
19-
import "../core/protocol_interfaces/protocol_client.dart";
20-
import "../definitions/form.dart";
21-
import "../definitions/operation_type.dart";
22-
import "../scripting_api/subscription.dart";
14+
import "../../core.dart";
15+
2316
import "coap_binding_exception.dart";
2417
import "coap_config.dart";
2518
import "coap_definitions.dart";
@@ -256,7 +249,7 @@ final class CoapClient implements ProtocolClient {
256249
}
257250

258251
/// Obtains an ACE creation hint serialized as a [List] of [int] from a
259-
/// [Form].
252+
/// [form].
260253
///
261254
/// Returns `null` if no `ACESecurityScheme` is defined.
262255
Future<AuthServerRequestCreationHint?> _obtainAceCreationHintFromForm(

lib/src/binding_coap/coap_client_factory.dart

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@
44
//
55
// SPDX-License-Identifier: BSD-3-Clause
66

7-
import "../core/credentials/callbacks.dart";
8-
import "../core/protocol_interfaces/protocol_client.dart";
9-
import "../core/protocol_interfaces/protocol_client_factory.dart";
7+
import "../../core.dart";
8+
109
import "coap_client.dart";
1110
import "coap_config.dart";
1211

lib/src/binding_coap/coap_extensions.dart

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,8 @@ import "package:cbor/cbor.dart";
1111
import "package:coap/coap.dart";
1212
import "package:dcaf/dcaf.dart";
1313

14-
import "../core/augmented_form.dart";
15-
import "../core/content.dart";
16-
import "../definitions/expected_response.dart";
17-
import "../definitions/form.dart";
18-
import "../definitions/operation_type.dart";
19-
import "../definitions/security/ace_security_scheme.dart";
20-
import "../definitions/security/auto_security_scheme.dart";
21-
import "../definitions/security/psk_security_scheme.dart";
22-
import "../definitions/validation/validation_exception.dart";
14+
import "../../core.dart" hide PskCredentials;
15+
2316
import "coap_binding_exception.dart";
2417
import "coap_definitions.dart";
2518

@@ -32,7 +25,7 @@ extension InternetAddressMethods on Uri {
3225
}
3326
}
3427

35-
/// CoAP-specific extensions for the [Form] class.
28+
/// CoAP-specific extensions for the [AugmentedForm] class.
3629
extension CoapFormExtension on AugmentedForm {
3730
T? _obtainVocabularyTerm<T>(String vocabularyTerm) {
3831
final curieString = coapPrefixMapping.expandCurieString(vocabularyTerm);
@@ -45,15 +38,15 @@ extension CoapFormExtension on AugmentedForm {
4538
return null;
4639
}
4740

48-
/// Determines if this [Form] supports the [PskSecurityScheme].
41+
/// Determines if this [AugmentedForm] supports the [PskSecurityScheme].
4942
bool get usesPskScheme =>
5043
securityDefinitions.whereType<PskSecurityScheme>().isNotEmpty;
5144

52-
/// Determines if this [Form] supports the [AutoSecurityScheme].
45+
/// Determines if this [AugmentedForm] supports the [AutoSecurityScheme].
5346
bool get usesAutoScheme =>
5447
securityDefinitions.whereType<AutoSecurityScheme>().isNotEmpty;
5548

56-
/// Get the [CoapSubprotocol] for this [Form], if one is set.
49+
/// Get the [CoapSubprotocol] for this [AugmentedForm], if one is set.
5750
CoapSubprotocol? get coapSubprotocol {
5851
if (subprotocol == coapPrefixMapping.expandCurieString("observe")) {
5952
return CoapSubprotocol.observe;
@@ -113,7 +106,7 @@ extension CoapFormExtension on AugmentedForm {
113106
BlockSize? get block1Size => _determineBlockSize("block1Size");
114107

115108
// TODO: Consider default method
116-
/// Indicates the [CoapRequestMethod] contained in this [Form].
109+
/// Indicates the [CoapRequestMethod] contained in this [AugmentedForm].
117110
CoapRequestMethod? get method {
118111
final methodDefinition = _obtainVocabularyTerm<String>("method");
119112

lib/src/binding_coap/coap_server.dart

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@
44
//
55
// SPDX-License-Identifier: BSD-3-Clause
66

7-
import "../core/credentials/callbacks.dart";
8-
import "../core/protocol_interfaces/protocol_server.dart";
9-
import "../scripting_api/exposed_thing.dart";
7+
import "../../core.dart";
8+
109
import "coap_config.dart";
1110

1211
/// A [ProtocolServer] for the Constrained Application Protocol (CoAP).

lib/src/binding_coap/coap_subscription.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
import "package:coap/coap.dart";
88

9-
import "../scripting_api/subscription.dart";
9+
import "../../core.dart";
1010

1111
/// [Subscription] to a CoAP resource, based on the observe option ([RFC 7641]).
1212
///

lib/src/binding_http/http_client.dart

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,8 @@ import "dart:io";
99

1010
import "package:http/http.dart";
1111

12-
import "../core/augmented_form.dart";
13-
import "../core/content.dart";
14-
import "../core/credentials/basic_credentials.dart";
15-
import "../core/credentials/bearer_credentials.dart";
16-
import "../core/credentials/callbacks.dart";
17-
import "../core/protocol_interfaces/protocol_client.dart";
18-
import "../definitions/form.dart";
19-
import "../definitions/operation_type.dart";
20-
import "../definitions/security/basic_security_scheme.dart";
21-
import "../definitions/security/bearer_security_scheme.dart";
22-
import "../scripting_api/subscription.dart";
12+
import "../../core.dart";
13+
2314
import "http_request_method.dart";
2415
import "http_security_exception.dart";
2516

lib/src/binding_http/http_client_factory.dart

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,8 @@
44
//
55
// SPDX-License-Identifier: BSD-3-Clause
66

7-
import "../core/credentials/basic_credentials.dart";
8-
import "../core/credentials/bearer_credentials.dart";
9-
import "../core/credentials/callbacks.dart";
10-
import "../core/protocol_interfaces/protocol_client.dart";
11-
import "../core/protocol_interfaces/protocol_client_factory.dart";
7+
import "../../core.dart";
8+
129
import "http_client.dart";
1310
import "http_config.dart";
1411

lib/src/binding_http/http_request_method.dart

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@
44
//
55
// SPDX-License-Identifier: BSD-3-Clause
66

7-
import "../definitions/form.dart";
8-
import "../definitions/operation_type.dart";
7+
import "../../core.dart";
98

109
const _getString = "GET";
1110
const _putString = "PUT";

lib/src/binding_http/http_server.dart

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@
44
//
55
// SPDX-License-Identifier: BSD-3-Clause
66

7-
import "../core/credentials/callbacks.dart";
8-
import "../core/protocol_interfaces/protocol_server.dart";
9-
import "../scripting_api/exposed_thing.dart";
7+
import "../../core.dart";
8+
109
import "http_config.dart";
1110

1211
/// A [ProtocolServer] for the Hypertext Transfer Protocol (HTTP).

lib/src/binding_mqtt/mqtt_client.dart

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,12 @@
66

77
import "dart:async";
88

9-
import "package:mqtt_client/mqtt_client.dart";
9+
import "package:mqtt_client/mqtt_client.dart" hide Subscription;
1010
import "package:mqtt_client/mqtt_server_client.dart";
1111
import "package:typed_data/typed_buffers.dart";
1212

13-
import "../core/augmented_form.dart";
14-
import "../core/content.dart";
15-
import "../core/credentials/basic_credentials.dart";
16-
import "../core/credentials/callbacks.dart";
17-
import "../core/protocol_interfaces/protocol_client.dart";
18-
import "../scripting_api/subscription.dart" as scripting_api;
13+
import "../../core.dart";
14+
1915
import "constants.dart";
2016
import "mqtt_binding_exception.dart";
2117
import "mqtt_config.dart";
@@ -181,7 +177,7 @@ final class MqttClient implements ProtocolClient {
181177
}
182178

183179
@override
184-
Future<scripting_api.Subscription> subscribeResource(
180+
Future<Subscription> subscribeResource(
185181
AugmentedForm form, {
186182
required void Function(Content content) next,
187183
void Function(Exception error)? error,

lib/src/binding_mqtt/mqtt_client_factory.dart

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,8 @@
44
//
55
// SPDX-License-Identifier: BSD-3-Clause
66

7-
import "../core/credentials/basic_credentials.dart";
8-
import "../core/credentials/callbacks.dart";
9-
import "../core/protocol_interfaces/protocol_client.dart";
10-
import "../core/protocol_interfaces/protocol_client_factory.dart";
7+
import "../../core.dart";
8+
119
import "constants.dart";
1210
import "mqtt_client.dart";
1311
import "mqtt_config.dart";

0 commit comments

Comments
 (0)