Initial commit

Author: marekVrican

.gitignore

@@ -0,0 +1,9 @@
+.DS_Store
+/.build
+/Packages
+/*.xcodeproj
+xcuserdata/
+DerivedData/
+.swiftpm/config/registries.json
+.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
+.netrc

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 GoodRequest
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Package.resolved

@@ -0,0 +1,35 @@
+// swift-tools-version: 6.0
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+    name: "GoodRemoteNotifier",
+    platforms: [
+        .iOS(.v16),
+        .macOS(.v13)
+    ],
+    products: [
+        .library(
+            name: "GoodRemoteNotifier",
+            targets: ["GoodRemoteNotifier"]
+        )
+    ],
+    dependencies: [
+        .package(url: "https://github.com/firebase/firebase-ios-sdk.git", .upToNextMajor(from: "11.9.0")),
+        .package(url: "https://github.com/GoodRequest/GoodLogger.git", .upToNextMajor(from: "1.2.3"))
+    ],
+    targets: [
+        .target(
+            name: "GoodRemoteNotifier",
+            dependencies: [
+                .product(name: "FirebaseCore", package: "firebase-ios-sdk"),
+                .product(name: "FirebaseRemoteConfig", package: "firebase-ios-sdk"),
+                .product(name: "GoodLogger", package: "GoodLogger")
+            ],
+            path: "./Sources/GoodRemoteNotifier",
+            swiftSettings: [.swiftLanguageMode(.v6)]
+        ),
+
+    ]
+)

Package.swift

@@ -0,0 +1,80 @@
+# GoodRemoteNotifier
+
+`GoodRemoteNotifier` is a Swift package designed to fetch and display remote notifications based on a JSON template. It allows you to integrate messages, titles, and buttons for different languages, all fetched from Firebase Remote Config.
+
+This package is useful for applications that need to display localized messages and UI elements like update notifications, with multiple language capabilities and appearance customization.
+
+## Features
+
+- Fetches remote configuration based on a given topic.
+- Supports multi-language messages for app notifications (e.g., update alerts).
+- Displays customizable messages, titles, and buttons based on the selected language.
+- Supports debug mode for easier testing.
+- Allows customization of the appearance of messages.
+
+## Installation
+
+You can install `GoodRemoteNotifier` via Swift Package Manager by adding it to your `Package.swift` file:
+
+```swift
+dependencies: [
+    .package(url: "https://github.com/yourusername/GoodRemoteNotifier.git", from: "1.0.0")
+]
+```
+
+## Configuration Data
+
+The remote configuration is fetched from Firebase Remote Config in JSON format. The JSON template for the configuration should follow this structure:
+
+- **frequency** (optional): Defines how often the notification should appear (e.g., once, daily, weekly, monthly). If not defined, the default value is `once`.
+- **title**: Localized titles for the notification. These will be displayed based on the user's selected language.
+- **message**: Localized messages containing the content of the notification. These messages explain what's new in the app or what the user should do.
+- **updateButton** (optional): Localized text for the action button, used for opening the app in the app store.
+- **closeButton** (optional): Localized text for the close button, used for dismissing the notification. If not defined, the message is not dismissible.
+
+> **⚠️ Important**: If the `frequency`, `title`, or `message` values change for the specified language, the notification will be treated as a new message.
+
+```JSON
+{
+  "frequency": "daily",
+  "title": {
+    "en": "An Update is Available!",
+    "de": "Ein Update ist verfügbar!"
+  },
+  "message": {
+    "en": "The new version of the app is here...",
+    "de": "Die neue Version der App ist da..."
+  },
+  "updateButton": {
+    "en": "Update Now",
+    "de": "Jetzt aktualisieren"
+  },
+  "closeButton": {
+    "en": "Close",
+    "de": "Schließen"
+  }
+}
+```
+
+## Usage
+
+Make sure that you have imported the `GoogleService-Info.plist` file into your project. 
+Additionally, ensure that `Firebase.configure()` is called before initializing the GoodRemote notifier.
+
+Initialize the notifier in `AppDelegate` or in the `@main` App struct for SwiftUI. It will automatically listen for the selected topic and display notifications based on the chosen frequency.
+
+```Swift
+import GoodRemoteNotifier
+
+let notifier = GoodRemoteNotifier(
+    appId: "123456789", // The App Store ID of the app for redirection.
+    topic: "update", // Firebase remote config parameter key
+    selectedLanguage: { "en" },
+    appearance: RemoteMessageAppearance.default, // Configuration for how remote messages should be displayed.
+    isDebugSession: { false } // If true, disables caching and sets the minimum fetching interval to 0.
+)
+```
+
+## License
+
+`GoodRemoteNotifier` is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.

README.md

@@ -0,0 +1,24 @@
+//
+//  SwiftUIExtensions.swift
+//  GoodRemoteNotifier
+//
+//  Created by Marek Vríčan on 17/04/2025.
+//
+
+import Foundation
+
+internal extension Bundle {
+
+    /// Retrieves the last icon file name from the app's primary icon settings in the Info.plist.
+    /// - Returns: The name of the last icon file in the array of icon files, or `nil` if not found.
+    var iconFileName: String? {
+        guard let icons = infoDictionary?["CFBundleIcons"] as? [String: Any],
+              let primaryIcon = icons["CFBundlePrimaryIcon"] as? [String: Any],
+              let iconFiles = primaryIcon["CFBundleIconFiles"] as? [String],
+              let iconFileName = iconFiles.last
+        else { return nil }
+
+        return iconFileName
+    }
+
+}

Sources/GoodRemoteNotifier/Extensions/BundleExtensions.swift

@@ -0,0 +1,41 @@
+//
+//  UIViewControllerExtensions.swift
+//  GoodRemoteNotifier
+//
+//  Created by Marek Vríčan on 06/03/2025.
+//
+
+import UIKit
+
+internal extension UIViewController {
+
+    /// Adds a blur effect to the view with an animation.
+    /// - Parameters:
+    ///   - duration: The duration of the blur effect animation. Default is `0.2` seconds.
+    ///   - completion: An optional closure that is called after the animation completes.
+    func addBlurEffect(duration: TimeInterval = 0.2, completion: (() -> Void)? = nil) {
+        let blurView = UIVisualEffectView(effect: UIBlurEffect(style: .systemThinMaterialDark))
+        blurView.layer.opacity = 0
+        blurView.frame = view.bounds
+        blurView.autoresizingMask = [.flexibleWidth, .flexibleHeight]
+        view.addSubview(blurView)
+
+        UIView.animate(withDuration: duration) {
+            blurView.layer.opacity = 1
+        } completion: { _ in completion?() }
+    }
+
+
+    /// Removes the blur effect from the view with an animation.
+    /// - Parameters:
+    ///   - duration: The duration of the blur effect removal animation. Default is `0.2` seconds.
+    ///   - completion: An optional closure that is called after the animation completes.
+    func removeBlurEffect(duration: TimeInterval = 0.2, completion: (() -> Void)? = nil) {
+        guard let blurView = view.subviews.first(where: { $0 is UIVisualEffectView }) else { return }
+
+        UIView.animate(withDuration: duration) {
+            blurView.layer.opacity = 0
+        } completion: { _ in completion?() }
+    }
+
+}