Skip to content

Commit aa88c1a

Browse files
committed
chore: remove deprecated KinesisDataStreams and KinesisDataStreamsOptions typedefs\n\nThese aliases were never shipped publicly, so there's nothing to be backward-compatible with. Updated README to use current class names.
1 parent 8ec0ec5 commit aa88c1a

File tree

4 files changed

+7
-33
lines changed

4 files changed

+7
-33
lines changed

packages/kinesis/aws_kinesis_datastreams/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ import 'dart:typed_data';
3030
import 'package:aws_kinesis_datastreams/aws_kinesis_datastreams.dart';
3131

3232
// Using static credentials (for testing only)
33-
final kinesis = KinesisDataStreams(
33+
final kinesis = AmplifyKinesisClient(
3434
region: 'us-east-1',
3535
credentialsProvider: AWSCredentialsProvider(
3636
AWSCredentials(
@@ -74,7 +74,7 @@ class AmplifyCredentialsAdapter implements AWSCredentialsProvider {
7474
}
7575
7676
// Initialize with Amplify Auth
77-
final kinesis = KinesisDataStreams(
77+
final kinesis = AmplifyKinesisClient(
7878
region: 'us-east-1',
7979
credentialsProvider: AmplifyCredentialsAdapter(amplifyAuth),
8080
);
@@ -83,10 +83,10 @@ final kinesis = KinesisDataStreams(
8383
### Custom Configuration
8484

8585
```dart
86-
final kinesis = KinesisDataStreams(
86+
final kinesis = AmplifyKinesisClient(
8787
region: 'us-east-1',
8888
credentialsProvider: myCredentialsProvider,
89-
options: KinesisDataStreamsOptions(
89+
options: AmplifyKinesisClientOptions(
9090
cacheMaxBytes: 10 * 1024 * 1024, // 10MB cache
9191
maxRetries: 3,
9292
flushStrategy: KinesisDataStreamsInterval(
@@ -166,7 +166,7 @@ The library handles credentials securely:
166166

167167
## API Reference
168168

169-
### KinesisDataStreams
169+
### AmplifyKinesisClient
170170

171171
The main client class for recording and streaming data.
172172

@@ -179,7 +179,7 @@ The main client class for recording and streaming data.
179179
| `clearCache()` | Removes all cached records |
180180
| `close()` | Closes the client and releases resources |
181181

182-
### KinesisDataStreamsOptions
182+
### AmplifyKinesisClientOptions
183183

184184
Configuration options for the client.
185185

@@ -193,7 +193,7 @@ Configuration options for the client.
193193

194194
| Exception | Description |
195195
|-----------|-------------|
196-
| `KinesisDataStreamsException` | Base exception for all errors |
196+
| `AmplifyKinesisException` | Base exception for all errors |
197197
| `CacheFullException` | Thrown when the cache is full |
198198
| `CredentialsException` | Thrown when credentials cannot be resolved |
199199
| `NetworkException` | Thrown when a network error occurs |

packages/kinesis/aws_kinesis_datastreams/lib/src/amplify_kinesis_client.dart

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -195,11 +195,3 @@ class AmplifyKinesisClient {
195195
await _recordClient.close();
196196
}
197197
}
198-
199-
// ---------------------------------------------------------------------------
200-
// Deprecated alias for backward compatibility
201-
// ---------------------------------------------------------------------------
202-
203-
/// Deprecated: Use [AmplifyKinesisClient] instead.
204-
@Deprecated('Use AmplifyKinesisClient instead')
205-
typedef KinesisDataStreams = AmplifyKinesisClient;

packages/kinesis/aws_kinesis_datastreams/lib/src/kinesis_data_streams_options.dart

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,3 @@ class AmplifyKinesisClientOptions {
9494
/// Optional logger for debug and error output.
9595
final Logger? logger;
9696
}
97-
98-
/// Deprecated: Use [AmplifyKinesisClientOptions] instead.
99-
@Deprecated('Use AmplifyKinesisClientOptions instead')
100-
typedef KinesisDataStreamsOptions = AmplifyKinesisClientOptions;

packages/kinesis/aws_kinesis_datastreams/test/kinesis_data_streams_test.dart

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -264,19 +264,5 @@ void main() {
264264
expect(client.isClosed, isTrue);
265265
});
266266
});
267-
268-
group('deprecated aliases', () {
269-
test('KinesisDataStreams is an alias for AmplifyKinesisClient', () {
270-
// ignore: deprecated_member_use_from_same_package
271-
// This just verifies the typedef exists and compiles
272-
// ignore: deprecated_member_use
273-
expect(
274-
AmplifyKinesisClient.withRecordClient(
275-
recordClient: mockRecordClient,
276-
),
277-
isA<AmplifyKinesisClient>(),
278-
);
279-
});
280-
});
281267
});
282268
}

0 commit comments

Comments
 (0)