mirror of
https://github.com/kuhyx/utils.git
synced 2026-11-10 22:47:14 +01:00
Krzysztof kuhy Rudnicki
d4fca83c9f
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
39 lines
1.3 KiB
Markdown
39 lines
1.3 KiB
Markdown
# data_transfer_flutter
|
|
|
|
Shared "export to a JSON file / import from a JSON file" plumbing for kuhy's
|
|
Flutter apps. Apps keep their own export CONTENT; this owns the file plumbing
|
|
and the envelope.
|
|
|
|
## Install
|
|
|
|
```yaml
|
|
dependencies:
|
|
data_transfer_flutter:
|
|
git:
|
|
url: https://github.com/kuhyx/utils
|
|
ref: data_transfer_flutter-v0.2.1
|
|
path: data_transfer_flutter
|
|
```
|
|
|
|
## Use
|
|
|
|
```dart
|
|
final saved = await exportJson(fileName: 'x.json', json: envelope);
|
|
final map = await pickJson(); // null when cancelled
|
|
```
|
|
|
|
- `exportJson` / `exportJsonText` save to **device storage**: Android and iOS
|
|
use the system "Save as" document picker (`file_picker` `saveFile`, i.e.
|
|
ACTION_CREATE_DOCUMENT), desktop a save dialog (`file_selector`), web a
|
|
browser download. Returns false when cancelled.
|
|
- `exportTextFile` does the same for any text (`text/csv`, `text/calendar`).
|
|
- `shareJson` is an optional second action (share sheet). It is never the
|
|
only way out: a stock phone's share sheet has no local save target.
|
|
- `pickJson` / `pickJsonText` use the system open-document picker.
|
|
- `buildEnvelope` / `validateEnvelope` / `parseEnvelope` write and check
|
|
`{format, version, exported_at, ...}`; mismatches throw a typed
|
|
`EnvelopeException` (always a `FormatException`).
|
|
|
|
Tests fake `DataTransfer.platform` (a `DataTransferPlatform`); restore it in
|
|
`tearDown`.
|