[cross_file] Updates cross_file to a package separated federated plugin

.github/dependabot.yml

@@ -29,6 +29,9 @@ updates:
       - /packages/camera/camera_android/example/android/app
       - /packages/camera/camera_android_camerax/example/android/app
       - /packages/camera/camera/example/android/app
+      - /packages/cross_file/cross_file/example/android/app
+      - /packages/cross_file/cross_file_android/android
+      - /packages/cross_file/cross_file_android/example/android/app
       - /packages/espresso/example/android/app
       - /packages/extension_google_sign_in_as_googleapis_auth/example/android/app
       - /packages/file_selector/file_selector/example/android/app

CODEOWNERS

@@ -6,7 +6,8 @@
 
 packages/animations/**                                   @hannah-hyj
 packages/camera/**                                       @bparrishMines
-packages/cross_file/**                                   @stuartmorgan-g
+packages/cross_file/**                                   @bparrishMines
+packages/cross_file/cross_file_io/**                     @bparrishMines
 packages/extension_google_sign_in_as_googleapis_auth/**  @stuartmorgan-g
 packages/file_selector/**                                @stuartmorgan-g
 packages/flutter_lints/**                                @chunhtai
@@ -54,6 +55,7 @@ third_party/packages/path_parsing/**                     @domesticmouse
 
 # - Web
 packages/camera/camera_web/**                                 @mdebbar
+packages/cross_file/cross_file_web/**                         @bparrishMines
 packages/file_selector/file_selector_web/**                   @mdebbar
 packages/google_maps_flutter/google_maps_flutter_web/**       @mdebbar
 packages/google_sign_in/google_sign_in_web/**                 @mdebbar
@@ -67,6 +69,7 @@ packages/webview_flutter/webview_flutter_web/**               @mdebbar
 # - Android
 packages/camera/camera_android/**                             @camsim99
 packages/camera/camera_android_camerax/**                     @camsim99
+packages/cross_file/cross_file_android/**                     @bparrishMines
 packages/espresso/**                                          @jesswrd
 packages/file_selector/file_selector_android/**               @mboetger
 packages/flutter_plugin_android_lifecycle/**                  @reidbaker
@@ -85,6 +88,7 @@ packages/webview_flutter/webview_flutter_android/**           @bparrishMines
 
 # - Darwin
 packages/camera/camera_avfoundation/**                        @hellohuanlin @louisehsu
+packages/cross_file/cross_file_darwin/**                      @bparrishMines
 packages/file_selector/file_selector_ios/**                   @okorohelijah @vashworth
 packages/file_selector/file_selector_macos/**                 @okorohelijah @vashworth
 packages/google_maps_flutter/google_maps_flutter_ios/**       @vashworth @LongCatIsLooong

packages/cross_file/CHANGELOG.md → packages/cross_file/cross_file/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.4.0
+
+* Updates `cross_file` to a package separated federated plugin.
+
 ## 0.3.5+2
 
 * Separates "Save As" implementation details from XFile web class.

packages/cross_file/cross_file/README.md

@@ -0,0 +1,112 @@
+# cross_file
+
+An abstraction to allow working with files across multiple platforms.
+
+<?code-excerpt path-base="example/lib"?>
+
+[![pub package](https://img.shields.io/pub/v/cross_file.svg)](https://pub.dartlang.org/packages/cross_file)
+
+A Flutter plugin that manages files and interactions with file dialogs.
+
+|             | Android | iOS     | Linux | macOS  | Web | Windows     |
+|-------------|---------|---------|-------|--------|-----|-------------|
+| **Support** | SDK 24+ | iOS 13+ | Any   | 10.15+ | Any | Windows 10+ |
+
+## Usage
+
+Import `package:cross_file/cross_file.dart`, instantiate a `XFile`
+using a path or byte array and use its methods and properties to
+access the file and its metadata.
+
+Example:
+
+<?code-excerpt "readme_excerpts.dart (Instantiate)"?>
+```dart
+final file = XFile.fromUri(Uri.file('assets/hello.txt'));
+
+debugPrint('File information:');
+debugPrint('- URI: ${file.uri}');
+debugPrint('- Name: ${await file.name()}');
+
+if (await file.canRead()) {
+  final String fileContent = await file.readAsString();
+  debugPrint('Content of the file: $fileContent');
+}
+```
+
+You will find links to the API docs on the [pub page](https://pub.dev/packages/cross_file).
+
+### Implementation-Specific Features
+
+Classes in this package contain an underlying platform implementation that provides features that
+are specific to an implementation.
+
+To access implementation-specific features, start by adding the platform implementation packages to
+your app or package:
+
+* **dart:io** [cross_file_io](https://pub.dev/packages/cross_file_io/install)
+* **Android Scoped Storage**: [cross_file_android](https://pub.dev/packages/cross_file_android/install)
+* **iOS/macOS App Sandbox**: [cross_file_darwin](https://pub.dev/packages/cross_file_darwin/install)
+* **Web**: [cross_file_web](https://pub.dev/packages/cross_file_web/install)
+
+Next, add the imports of the implementation packages to your app or package:
+
+<?code-excerpt "readme_excerpts.dart (platform_imports)"?>
+```dart
+// Import for Darwin App Sandbox features.
+import 'package:cross_file_darwin/cross_file_darwin.dart';
+// Import for Web features.
+import 'package:cross_file_web/cross_file_web.dart';
+```
+
+Now, additional features can be accessed through the platform implementations. Classes
+[XFile], [XDirectory], [ScopedStorageXFile], and [ScopedStorageXDirectory] pass their
+functionality to a class provided by the current platform. Below are a couple of ways to access
+additional functionality provided by the platform and is followed by an example.
+
+1. Pass a creation params class provided by a platform implementation to a `fromCreationParams`
+   constructor (e.g. `XFile.fromCreationParams`, `XDirectory.fromCreationParams`, etc.).
+2. Call methods on an implementation of a class by using `getExtension`/`maybeGetExtension` methods (e.g.
+   `XFile.getExtension`, `XDirectory.maybeGetExtension`, etc.).
+
+Below is an example of setting additional iOS/macOS and Android parameters on a `XFile`.
+
+<?code-excerpt "readme_excerpts.dart (platform_features)"?>
+```dart
+late final XFile file;
+
+if (CrossFilePlatform.instance is CrossFileWeb) {
+  final params = WebXFileCreationParams.fromObjectUrl(
+    objectUrl: 'blob:https://some/url:for/file',
+  );
+  file = XFile.fromCreationParams(params);
+} else if (CrossFilePlatform.instance is CrossFileDarwin) {
+  final params = PlatformScopedStorageXFileCreationParams(
+    uri: Uri.file('/my/file.txt').toString(),
+  );
+  file = ScopedStorageXFile.fromCreationParams(params);
+
+  await file
+      .getExtension<DarwinScopedStorageXFileExtension>()
+      .startAccessingSecurityScopedResource();
+} else {
+  file = XFile.fromUri(Uri.file('/my/file.txt'));
+}
+
+debugPrint(await file.readAsString());
+await file
+    .maybeGetExtension<DarwinScopedStorageXFileExtension>()
+    ?.stopAccessingSecurityScopedResource();
+```
+
+See https://pub.dev/documentation/cross_file_darwin/latest/cross_file_darwin/cross_file_darwin-library.html
+for more details on iOS/macOS App Sandbox features.
+
+See https://pub.dev/documentation/cross_file_android/latest/cross_file_android/cross_file_android-library.html
+for more details on Android Scoped Storage features.
+
+See https://pub.dev/documentation/cross_file_io/latest/cross_file_io/cross_file_io-library.html
+for more details on `dart:io` features.
+
+See https://pub.dev/documentation/cross_file_web/latest/cross_file_web/cross_file_web-library.html
+for more details on Web features.

packages/cross_file/cross_file/example/README.md

@@ -0,0 +1,9 @@
+# Platform Implementation Test App
+
+This is a test app for manual testing and automated integration testing
+of this platform implementation. It is not intended to demonstrate actual use of
+this package, since the intent is that plugin clients use the app-facing
+package.
+
+Unless you are making changes to this implementation package, this example is
+very unlikely to be relevant.

packages/cross_file/cross_file/example/android/app/build.gradle.kts

@@ -0,0 +1,44 @@
+plugins {
+    id("com.android.application")
+    id("kotlin-android")
+    // The Flutter Gradle Plugin must be applied after the Android and Kotlin Gradle plugins.
+    id("dev.flutter.flutter-gradle-plugin")
+}
+
+android {
+    namespace = "dev.flutter.packages.cross_file_example"
+    compileSdk = flutter.compileSdkVersion
+    ndkVersion = flutter.ndkVersion
+
+    compileOptions {
+        sourceCompatibility = JavaVersion.VERSION_17
+        targetCompatibility = JavaVersion.VERSION_17
+    }
+
+    kotlinOptions {
+        jvmTarget = JavaVersion.VERSION_17.toString()
+    }
+
+    defaultConfig {
+        // TODO: Specify your own unique Application ID (https://developer.android.com/studio/build/application-id.html).
+        applicationId = "dev.flutter.packages.cross_file_example"
+        // You can update the following values to match your application needs.
+        // For more information, see: https://flutter.dev/to/review-gradle-config.
+        minSdk = flutter.minSdkVersion
+        targetSdk = flutter.targetSdkVersion
+        versionCode = flutter.versionCode
+        versionName = flutter.versionName
+    }
+
+    buildTypes {
+        release {
+            // TODO: Add your own signing config for the release build.
+            // Signing with the debug keys for now, so `flutter run --release` works.
+            signingConfig = signingConfigs.getByName("debug")
+        }
+    }
+}
+
+flutter {
+    source = "../.."
+}

packages/cross_file/cross_file/example/android/app/src/debug/AndroidManifest.xml

@@ -0,0 +1,7 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+    <!-- The INTERNET permission is required for development. Specifically,
+         the Flutter tool needs it to communicate with the running application
+         to allow setting breakpoints, to provide hot reload, etc.
+    -->
+    <uses-permission android:name="android.permission.INTERNET"/>
+</manifest>

packages/cross_file/cross_file/example/android/app/src/main/AndroidManifest.xml

@@ -0,0 +1,45 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+    <application
+        android:label="cross_file_example"
+        android:name="${applicationName}"
+        android:icon="@mipmap/ic_launcher">
+        <activity
+            android:name=".MainActivity"
+            android:exported="true"
+            android:launchMode="singleTop"
+            android:taskAffinity=""
+            android:theme="@style/LaunchTheme"
+            android:configChanges="orientation|keyboardHidden|keyboard|screenSize|smallestScreenSize|locale|layoutDirection|fontScale|screenLayout|density|uiMode"
+            android:hardwareAccelerated="true"
+            android:windowSoftInputMode="adjustResize">
+            <!-- Specifies an Android theme to apply to this Activity as soon as
+                 the Android process has started. This theme is visible to the user
+                 while the Flutter UI initializes. After that, this theme continues
+                 to determine the Window background behind the Flutter UI. -->
+            <meta-data
+              android:name="io.flutter.embedding.android.NormalTheme"
+              android:resource="@style/NormalTheme"
+              />
+            <intent-filter>
+                <action android:name="android.intent.action.MAIN"/>
+                <category android:name="android.intent.category.LAUNCHER"/>
+            </intent-filter>
+        </activity>
+        <!-- Don't delete the meta-data below.
+             This is used by the Flutter tool to generate GeneratedPluginRegistrant.java -->
+        <meta-data
+            android:name="flutterEmbedding"
+            android:value="2" />
+    </application>
+    <!-- Required to query activities that can process text, see:
+         https://developer.android.com/training/package-visibility and
+         https://developer.android.com/reference/android/content/Intent#ACTION_PROCESS_TEXT.
+
+         In particular, this is used by the Flutter engine in io.flutter.plugin.text.ProcessTextPlugin. -->
+    <queries>
+        <intent>
+            <action android:name="android.intent.action.PROCESS_TEXT"/>
+            <data android:mimeType="text/plain"/>
+        </intent>
+    </queries>
+</manifest>

packages/cross_file/cross_file/example/android/app/src/main/kotlin/dev/flutter/packages/cross_file_example/MainActivity.kt

@@ -0,0 +1,9 @@
+// Copyright 2013 The Flutter Authors
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+package dev.flutter.packages.cross_file_example
+
+import io.flutter.embedding.android.FlutterActivity
+
+class MainActivity : FlutterActivity()

packages/cross_file/cross_file/example/android/app/src/main/res/drawable-v21/launch_background.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Modify this file to customize your launch splash screen -->
+<layer-list xmlns:android="http://schemas.android.com/apk/res/android">
+    <item android:drawable="?android:colorBackground" />
+
+    <!-- You can insert your own image assets here -->
+    <!-- <item>
+        <bitmap
+            android:gravity="center"
+            android:src="@mipmap/launch_image" />
+    </item> -->
+</layer-list>

packages/cross_file/cross_file/example/android/app/src/main/res/drawable/launch_background.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Modify this file to customize your launch splash screen -->
+<layer-list xmlns:android="http://schemas.android.com/apk/res/android">
+    <item android:drawable="@android:color/white" />
+
+    <!-- You can insert your own image assets here -->
+    <!-- <item>
+        <bitmap
+            android:gravity="center"
+            android:src="@mipmap/launch_image" />
+    </item> -->
+</layer-list>

packages/cross_file/cross_file/example/android/app/src/main/res/values-night/styles.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="utf-8"?>
+<resources>
+    <!-- Theme applied to the Android Window while the process is starting when the OS's Dark Mode setting is on -->
+    <style name="LaunchTheme" parent="@android:style/Theme.Black.NoTitleBar">
+        <!-- Show a splash screen on the activity. Automatically removed when
+             the Flutter engine draws its first frame -->
+        <item name="android:windowBackground">@drawable/launch_background</item>
+    </style>
+    <!-- Theme applied to the Android Window as soon as the process has started.
+         This theme determines the color of the Android Window while your
+         Flutter UI initializes, as well as behind your Flutter UI while its
+         running.
+
+         This Theme is only used starting with V2 of Flutter's Android embedding. -->
+    <style name="NormalTheme" parent="@android:style/Theme.Black.NoTitleBar">
+        <item name="android:windowBackground">?android:colorBackground</item>
+    </style>
+</resources>