1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
|
import 'dart:typed_data';
import 'package:dio/dio.dart';
import '../models/models.dart';
/// High-level API surface that maps 1-to-1 with the player-server REST API
/// (see player-server/docs/api.md for the authoritative contract).
///
/// Each method corresponds to a single HTTP endpoint. All HTTP plumbing
/// (bearer-token injection, 401 → login redirect, base-URL configuration) is
/// handled by the [Dio] instance provided at construction time.
///
/// In production, create the [Dio] via [DioClient] which wires up the auth
/// and 401-redirect interceptors. In tests, pass a plain or mocked [Dio].
///
/// Concrete implementations of the stub methods will be added incrementally as
/// features are built.
class PlayerApiClient {
/// Creates a client backed by [dio].
///
/// Prefer creating [dio] via [DioClient] in production to get bearer-token
/// injection and 401 → login redirect out of the box.
PlayerApiClient({required Dio dio}) : _dio = dio;
// The configured Dio instance with auth/401 interceptors already applied.
final Dio _dio;
// ---------------------------------------------------------------------------
// Auth
// ---------------------------------------------------------------------------
Future<User> bootstrap({
required String username,
required String password,
}) =>
throw UnimplementedError();
Future<User> login({
required String username,
required String password,
}) =>
throw UnimplementedError();
Future<void> logout() => throw UnimplementedError();
// ---------------------------------------------------------------------------
// Health
// ---------------------------------------------------------------------------
Future<void> healthz() => throw UnimplementedError();
Future<void> readyz() => throw UnimplementedError();
// ---------------------------------------------------------------------------
// Shared / public endpoints (no auth required)
// ---------------------------------------------------------------------------
Future<String> getSharedMediaPage(String token) =>
throw UnimplementedError();
Future<Uint8List> streamSharedMedia(String token, {String? range}) =>
throw UnimplementedError();
Future<Uint8List> getSharedThumbnail(String token) =>
throw UnimplementedError();
Future<Uint8List> downloadSharedMedia(String token) =>
throw UnimplementedError();
// ---------------------------------------------------------------------------
// Config
// ---------------------------------------------------------------------------
Future<Map<String, dynamic>> getConfig() => throw UnimplementedError();
// ---------------------------------------------------------------------------
// Sets
// ---------------------------------------------------------------------------
Future<List<MediaSet>> listSets() => throw UnimplementedError();
Future<Map<String, dynamic>> browseSet(int setId, {String? parent}) =>
throw UnimplementedError();
Future<Uint8List> getSetCover(int setId, {String? folder}) =>
throw UnimplementedError();
Future<void> updateSetCover(int setId, {String? folder}) =>
throw UnimplementedError();
Future<Media> uploadToSet(
int setId, {
required String fileName,
required List<int> bytes,
}) =>
throw UnimplementedError();
// ---------------------------------------------------------------------------
// Media
// ---------------------------------------------------------------------------
Future<List<Media>> listMedia({
String? search,
int? setId,
List<int>? setIds,
String? type,
bool? favorites,
List<String>? tags,
double? minDuration,
double? maxDuration,
int? fileSizeMin,
int? fileSizeMax,
String? sort,
int? limit,
int? offset,
String? folder,
String? parent,
}) =>
throw UnimplementedError();
Future<Media> getMedia(int mediaId) => throw UnimplementedError();
Future<Uint8List> streamMedia(int mediaId, {String? range}) =>
throw UnimplementedError();
Future<Uint8List> downloadMedia(int mediaId) => throw UnimplementedError();
Future<Uint8List> getThumbnail(int mediaId) => throw UnimplementedError();
Future<void> regenerateThumbnail(int mediaId) => throw UnimplementedError();
Future<bool> toggleFavorite(int mediaId) => throw UnimplementedError();
Future<void> deleteMedia(int mediaId) => throw UnimplementedError();
Future<void> restoreMedia(int mediaId) => throw UnimplementedError();
// ---------------------------------------------------------------------------
// Tags
// ---------------------------------------------------------------------------
Future<List<Tag>> listTags() => throw UnimplementedError();
Future<void> addTag(int mediaId, String tag) => throw UnimplementedError();
Future<void> removeTag(int mediaId, String tag) =>
throw UnimplementedError();
// ---------------------------------------------------------------------------
// Shares
// ---------------------------------------------------------------------------
Future<Share> createShare(
int mediaId, {
DateTime? expiresAt,
int? maxUses,
}) =>
throw UnimplementedError();
Future<List<Share>> listSharesForMedia(int mediaId) =>
throw UnimplementedError();
Future<List<Share>> listMyShares() => throw UnimplementedError();
Future<void> revokeShare(String token) => throw UnimplementedError();
// ---------------------------------------------------------------------------
// Notes
// ---------------------------------------------------------------------------
Future<Note?> getNote(int mediaId) => throw UnimplementedError();
Future<Note> upsertNote(int mediaId, String content) =>
throw UnimplementedError();
Future<void> deleteNote(int mediaId) => throw UnimplementedError();
// ---------------------------------------------------------------------------
// Progress
// ---------------------------------------------------------------------------
Future<void> updateProgress({
required int mediaId,
required double positionSeconds,
}) =>
throw UnimplementedError();
Future<void> updateProgressStatus({
required int mediaId,
required String status,
}) =>
throw UnimplementedError();
Future<List<Media>> listInProgress() => throw UnimplementedError();
// ---------------------------------------------------------------------------
// Podcasts
// ---------------------------------------------------------------------------
Future<List<PodcastFeed>> listPodcasts() => throw UnimplementedError();
Future<List<PodcastEpisode>> listEpisodes(
int podcastSetId, {
int? limit,
int? offset,
}) =>
throw UnimplementedError();
Future<Media> downloadEpisode(int episodeId) => throw UnimplementedError();
Future<void> toggleEpisodeComplete(int episodeId) =>
throw UnimplementedError();
Future<PodcastFeed> subscribePodcast({
required String feedUrl,
String? setName,
}) =>
throw UnimplementedError();
// ---------------------------------------------------------------------------
// Admin – Users
// ---------------------------------------------------------------------------
Future<List<User>> listUsers() => throw UnimplementedError();
Future<User> createUser({
required String username,
required String password,
required bool isAdmin,
}) =>
throw UnimplementedError();
Future<void> deleteUser(int userId) => throw UnimplementedError();
// ---------------------------------------------------------------------------
// Admin – Permissions
// ---------------------------------------------------------------------------
Future<List<Map<String, dynamic>>> listPermissions() =>
throw UnimplementedError();
Future<void> grantPermission({
required int setId,
required int userId,
required String role,
}) =>
throw UnimplementedError();
Future<void> revokePermission({
required int setId,
required int userId,
}) =>
throw UnimplementedError();
// ---------------------------------------------------------------------------
// Admin – Scanner
// ---------------------------------------------------------------------------
Future<void> triggerRescan() => throw UnimplementedError();
Future<Map<String, dynamic>> getScanProgress() => throw UnimplementedError();
Future<List<Media>> listTrash() => throw UnimplementedError();
// Expose the underlying Dio for advanced callers (e.g. binary streaming).
// This should not be used for ordinary JSON requests; prefer the typed
// methods above.
Dio get rawDio => _dio;
}
|
