Feature/prd 1013 add spm

.gitignore

@@ -29,6 +29,7 @@ migrate_working_dir/
 **/doc/api/
 .dart_tool/
 .packages
+**/.swiftpm/
 build/
 
 # Project

CHANGELOG_UNRELEASED.md

@@ -0,0 +1,17 @@
+## 4.0.0
+
+### Breaking changes
+
+- Require Flutter 3.44.0 or later.
+- Require Dart 3.12.0 or later.
+- Require iOS 16.0 or later.
+
+### Added
+
+- Add Swift Package Manager support for the iOS plugin while keeping CocoaPods support.
+- Migrate the iOS example app to Swift Package Manager.
+
+### Notes
+
+- Document the `-ObjC` linker flag required by SitumSDK when using Swift Package Manager.
+- Update WebView Flutter dependencies to versions that can participate in a Swift Package Manager iOS build.

README.md

@@ -23,6 +23,14 @@ There is a comprehensive tutorial on how to set-up a new application using this
 Below you will find the basic steps to install and configure the plugin on your Flutter project.
 These steps have already been done for you in the example application of this repository, but they are required for other projects.
 
+## Requirements
+
+Starting with version 4.0.0, this plugin requires:
+
+- Flutter 3.44.0 or later
+- Dart 3.12.0 or later
+- iOS 16.0 or later
+
 ## Running the example
 
 Check the [example/README](./example/README.md) file of this repository to create your first Flutter application using Situm Flutter.
@@ -56,11 +64,31 @@ up a Situm account.
 
 ### iOS
 
-1. Remove the "use_frameworks!" directive in the `Podfile` of your iOS project:
+On iOS, the plugin supports both CocoaPods and Swift Package Manager for native
+dependencies. Flutter 3.44.0 and later enables Swift Package Manager by default.
+
+When using Swift Package Manager, add `$(inherited) -ObjC` to your app target's
+`Other Linker Flags` build setting. This is required by SitumSDK's Swift package.
+
+> [!NOTE]
+> The repository folder name requirement only affects local development of this
+> repository and the bundled example app when using Swift Package Manager. Apps
+> that consume `situm_flutter` from pub.dev are not affected.
+>
+> For local development with the example app and Swift Package Manager, clone or
+> place this repository in a folder named `situm_flutter`. Some Flutter versions
+> generate local Swift package overrides using the plugin directory name, and a
+> different checkout folder name can cause Swift package resolution failures.
+
+If your project uses CocoaPods:
+
+1. Remove the "use_frameworks!" directive in the `Podfile` of your iOS project.
 
 2. Run `pod install` or `pod update` to bring the dependencies to your project.
 
-3. Declare the following permissions in your app's `Info.plist` file to successfully start positioning:
+For both CocoaPods and Swift Package Manager:
+
+1. Declare the following permissions in your app's `Info.plist` file to successfully start positioning:
 
 ```
 <key>NSLocationWhenInUseUsageDescription</key>
@@ -71,7 +99,7 @@ up a Situm account.
 <string>We use your phone sensors (giroscope, accelerometer and altimeter) to improve location quality</string>
 ```
 
-4. For offline support you will have to add the underlying web application's domain inside the entry `WKAppBoundDomains` on `Info.plist` as follows:
+2. For offline support you will have to add the underlying web application's domain inside the entry `WKAppBoundDomains` on `Info.plist` as follows:
 
 ```
 <key>WKAppBoundDomains</key>

azure-pipelines.yml

@@ -35,12 +35,12 @@ steps:
       - checkout: self
         fetchTags: false
         fetchDepth: 1
-        path: flutter
+        path: situm_flutter
         displayName: checkout self
 
       - template: azure-templates/static-analyse.yml@sys_kubernetes_templates
         parameters:
-          repoFolder: $(Pipeline.Workspace)/flutter
+          repoFolder: $(Pipeline.Workspace)/situm_flutter
           teams: mobile
           phase: semgrep
 
@@ -61,8 +61,8 @@ steps:
 
           export PATH="$PATH:$(Agent.BuildDirectory)/binaries/flutter/bin"
 
-          if [ -d "flutter" ];then
-            cd $(Pipeline.Workspace)/flutter
+          if [ -d "$(Pipeline.Workspace)/situm_flutter" ];then
+            cd $(Pipeline.Workspace)/situm_flutter
           fi
 
           echo -e "\n[+] Get Dependencies\n"
@@ -73,14 +73,15 @@ steps:
 
       - template: azure-templates/static-analyse.yml@sys_kubernetes_templates
         parameters:
-          repoFolder: $(Pipeline.Workspace)/flutter
+          repoFolder: $(Pipeline.Workspace)/situm_flutter
           teams: mobile
           phase: trivy
 
   - ${{ if contains(variables['Build.SourceBranch'], 'release/') }}:
       - checkout: self
         fetchTags: false
         fetchDepth: 1
+        path: situm_flutter
         displayName: checkout self
 
       - ${{ if eq(variables['Build.Reason'],'manual') }}:
@@ -109,8 +110,8 @@ steps:
       - bash: |
 
           set -euo pipefail
-          if [ -d "flutter" ];then
-            cd flutter
+          if [ -d "$(Pipeline.Workspace)/situm_flutter" ];then
+            cd $(Pipeline.Workspace)/situm_flutter
           fi
           currentBranch=$(echo $(Build.SourceBranch) | cut -d "/" -f 3,4)
           echo "##vso[task.setvariable variable=currentBranch]$(echo $currentBranch)"
@@ -151,8 +152,8 @@ steps:
 
       - bash: |
           set -euo pipefail
-          if [ -d "flutter" ];then
-            cd flutter
+          if [ -d "$(Pipeline.Workspace)/situm_flutter" ];then
+            cd $(Pipeline.Workspace)/situm_flutter
           fi
           #Export binary paths
           export PATH="$PATH:$(Agent.BuildDirectory)/binaries/flutter/bin"
@@ -188,7 +189,7 @@ steps:
             bitbucket_user: situmops
           system: "N/A"
           server: "github"
-          repofolder: "flutter"
+          repofolder: "situm_flutter"
           mergeBranches:
             - "master"
             - "develop"
@@ -219,8 +220,8 @@ steps:
           echo -e "\n[+] Create temporary token \n"
           gcloud auth print-identity-token --audiences=https://pub.dev | dart pub token add https://pub.dev
 
-          if [ -d "flutter" ];then
-            cd flutter
+          if [ -d "$(Pipeline.Workspace)/situm_flutter" ];then
+            cd $(Pipeline.Workspace)/situm_flutter
           fi
 
           echo -e "\n[+] Publish flutter package\n"
@@ -231,8 +232,8 @@ steps:
       - bash: |
 
           set -euo pipefail
-          if [ -d "flutter" ]; then
-            cd flutter
+          if [ -d "$(Pipeline.Workspace)/situm_flutter" ]; then
+            cd $(Pipeline.Workspace)/situm_flutter
           fi
 
           echo -e "\n[+] Pull master changes and change to master branch \n"

example/README.md

@@ -32,19 +32,29 @@ This folder contains the necessary source code for an example application using
 The first step is to download this repo:
 
 ```bash
-git clone https://github.com/situmtech/flutter.git
+git clone https://github.com/situmtech/flutter.git situm_flutter
 ```
 
 And then install the plugin dependencies alongside the `example` app as follows:
 
 ```bash
-cd flutter/example
+cd situm_flutter/example
 flutter pub get
 ```
 
 #### iOS only
 
-Run `pod install` or `pod update` from the `example/ios` folder to bring the dependencies to your project.
+The bundled example app uses Swift Package Manager for iOS dependencies.
+
+> [!NOTE]
+> This limitation only affects local development of this repository and the
+> bundled example app when using Swift Package Manager. Apps that consume
+> `situm_flutter` from pub.dev are not affected.
+>
+> When running this example app on iOS with Swift Package Manager, make sure the
+> repository directory is named `situm_flutter`. Some Flutter versions generate
+> local Swift package overrides using the plugin directory name, and a different
+> checkout folder name can cause Swift package resolution failures.
 
 Also check out the project [code signing](https://developer.apple.com/support/code-signing/) before you run the example.
 

example/android/gradle.properties

@@ -1,3 +1,7 @@
 org.gradle.jvmargs=-Xmx1536M
 android.useAndroidX=true
 android.enableJetifier=true
+# This builtInKotlin flag was added automatically by Flutter migrator
+android.builtInKotlin=false
+# This newDsl flag was added automatically by Flutter migrator
+android.newDsl=false

example/azure/build-examples.yaml

@@ -53,7 +53,7 @@ steps:
 
           sudo xcode-select -switch $(xcodeVersion)
 
-          cd example/ios/fastlane
+          cd $(Pipeline.Workspace)/situm_flutter/example/ios/fastlane
 
           echo -e "\n[+] Setting Apple connection options"
 
@@ -71,14 +71,6 @@ steps:
           echo -e "\t[+] IPHONEOS_DEPLOYMENT_TARGET: $IPHONEOS_DEPLOYMENT_TARGET"
 
 
-          echo -e "\n[+] Pod deintegrate command \n"
-          cd ..
-          rm -rf Podfile.lock
-          pod deintegrate 
-
-          echo -e "\n[+] Pod install with --repo-update option \n"
-          pod install --repo-update
-
           echo -e "\n[+] Build example with fastlane \n"
           fastlane ios beta
 
@@ -87,13 +79,13 @@ steps:
   - ${{ if contains(parameters.system, 'ubuntu') }}:
       - bash: |
           export PATH="$PATH:$(Agent.BuildDirectory)/binaries/flutter/bin"
-          cd example
+          cd $(Pipeline.Workspace)/situm_flutter/example
 
           flutter build apk
         displayName: Build
 
       - bash: |
-          cd example
+          cd $(Pipeline.Workspace)/situm_flutter/example
 
           if [[ "$(Build.Reason)" == "Manual" ]];then
             folder="$(FlutterExample_folder)/Manual"

example/azure/common-steps.yaml

@@ -18,9 +18,11 @@ steps:
   - checkout: self
     fetchDepth: 1
     fetchTags: false
+    path: situm_flutter
     displayName: Clone repository
 
   - bash: |
+      cd $(Pipeline.Workspace)/situm_flutter
       pluginVersion=$(grep "^version: [0-9\.].*$" pubspec.yaml | awk -F":" '{print $2}')
       echo "##vso[task.setvariable variable=pluginVersion]$(echo $pluginVersion)"
       cd example
@@ -69,7 +71,7 @@ steps:
 
   - bash: |
       export PATH="$PATH:$(Agent.BuildDirectory)/binaries/flutter/bin"
-      cd example
+      cd $(Pipeline.Workspace)/situm_flutter/example
 
       echo -e "\n[+] Install flutter dependencies\n"
       flutter pub get