Migrate to App Intents

AppIntents/GetItemState.swift

@@ -0,0 +1,130 @@
+// Copyright (c) 2010-2025 Contributors to the openHAB project
+//
+// See the NOTICE file(s) distributed with this work for additional
+// information.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0
+//
+// SPDX-License-Identifier: EPL-2.0
+
+import AppIntents
+import Foundation
+import OpenHABCore
+
+enum GetItemStateError: Error, CustomLocalizedStringResourceConvertible {
+    case invalidHomeIdentifier
+    case unknownHome
+    case itemNotFound(String)
+
+    var localizedStringResource: LocalizedStringResource {
+        switch self {
+        case .invalidHomeIdentifier:
+            "Invalid home identifier"
+        case .unknownHome:
+            "Unknown home"
+        case let .itemNotFound(itemName):
+            "Item '\(itemName)' not found"
+        }
+    }
+}
+
+@available(iOS 16.0, macOS 13.0, watchOS 9.0, tvOS 16.0, *)
+struct GetItemState: AppIntent, CustomIntentMigratedAppIntent, PredictableIntent {
+    struct StringOptionsProvider: DynamicOptionsProvider {
+        func results() async throws -> [String] {
+            let allItems = await OpenHABItemCache.instance.getAllCachedItems()
+            return allItems.flatMap { $0.value.map(\.name) }
+        }
+    }
+
+    static let intentClassName = "OpenHABGetItemStateIntent"
+
+    static let title: LocalizedStringResource = "Get Item State"
+    static let description = IntentDescription("Retrieve the current state of an item")
+
+    // swiftlint:disable type_contents_order
+    @Parameter(title: "Item", optionsProvider: StringOptionsProvider())
+    var item: String
+
+    @Parameter(title: "Home")
+    var home: Home
+
+    static var parameterSummary: some ParameterSummary {
+        Summary("Get \(\.$item) State") {
+            \.$home
+        }
+    }
+
+    // swiftlint:enable type_contents_order
+
+    static var predictionConfiguration: some IntentPredictionConfiguration {
+        IntentPrediction(parameters: (\.$item, \.$home)) { item, _ in
+            DisplayRepresentation(
+                title: "Get \(item) State",
+                subtitle: ""
+            )
+        }
+    }
+
+    func perform() async throws -> some IntentResult & ReturnsValue<String> {
+        guard let homeId = UUID(uuidString: home.id) else {
+            throw GetItemStateError.invalidHomeIdentifier
+        }
+
+        let homeExists = await MainActor.run {
+            Preferences.shared.storedHomes[homeId] != nil
+        }
+
+        guard homeExists else {
+            throw GetItemStateError.unknownHome
+        }
+
+        guard let openHABItem = await OpenHABItemCache.instance.getItemUncached(name: item, home: homeId) else {
+            throw GetItemStateError.itemNotFound(item)
+        }
+
+        let state = openHABItem.state ?? "Unknown state"
+
+        return .result(
+            value: state,
+            dialog: .responseSuccess(item: item, state: state)
+        )
+    }
+}
+
+@available(iOS 16.0, macOS 13.0, watchOS 9.0, tvOS 16.0, *)
+private extension IntentDialog {
+    static var itemParameterConfiguration: Self {
+        "Item Name"
+    }
+
+    static var homeParameterConfiguration: Self {
+        "Home name"
+    }
+
+    static var homeParameterPrompt: Self {
+        "blabla"
+    }
+
+    static var homeParameterDisambiguationSelection: Self {
+        "For which home do you want to get the value?"
+    }
+
+    static func homeParameterDisambiguationIntro(count: Int, item: String) -> Self {
+        "There are \(count) configured homes with an item named '\(item)'’."
+    }
+
+    static func homeParameterConfirmation(home: Home) -> Self {
+        "Just to confirm, you wanted ‘\(home)’?"
+    }
+
+    static func responseSuccess(item: String, state: String) -> Self {
+        "The state of \(item) is \(state)"
+    }
+
+    static func responseFailureInvalidItem(item: String) -> Self {
+        "Sorry can't find \(item)"
+    }
+}

AppIntents/Home.swift

@@ -0,0 +1,52 @@
+// Copyright (c) 2010-2025 Contributors to the openHAB project
+//
+// See the NOTICE file(s) distributed with this work for additional
+// information.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0
+//
+// SPDX-License-Identifier: EPL-2.0
+
+import AppIntents
+import Foundation
+import OpenHABCore
+
+@available(iOS 16.0, macOS 13.0, watchOS 9.0, tvOS 16.0, *)
+struct Home: AppEntity {
+    struct HomeQuery: EntityQuery {
+        @MainActor
+        func entities(for identifiers: [Home.ID]) async throws -> [Home] {
+            identifiers.compactMap { identifier in
+                guard let uuid = UUID(uuidString: identifier),
+                      let homePrefs = Preferences.shared.storedHomes[uuid] else {
+                    return nil
+                }
+                return Home(id: homePrefs.id.uuidString, displayString: homePrefs.homeName)
+            }
+        }
+
+        @MainActor
+        func suggestedEntities() async throws -> [Home] {
+            Preferences.shared.storedHomes.map { homePrefs in
+                Home(id: homePrefs.value.id.uuidString, displayString: homePrefs.value.homeName)
+            }
+        }
+    }
+
+    static let typeDisplayRepresentation = TypeDisplayRepresentation(name: "Home")
+
+    static let defaultQuery = HomeQuery()
+
+    var id: String // if your identifier is not a String, conform the entity to EntityIdentifierConvertible.
+    var displayString: String
+    var displayRepresentation: DisplayRepresentation {
+        DisplayRepresentation(title: "\(displayString)")
+    }
+
+    init(id: String, displayString: String) {
+        self.id = id
+        self.displayString = displayString
+    }
+}

AppIntents/SetColorValue.swift

@@ -0,0 +1,149 @@
+// Copyright (c) 2010-2025 Contributors to the openHAB project
+//
+// See the NOTICE file(s) distributed with this work for additional
+// information.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0
+//
+// SPDX-License-Identifier: EPL-2.0
+
+import AppIntents
+import Foundation
+import OpenHABCore
+
+enum SetColorValueError: Error, CustomLocalizedStringResourceConvertible {
+    case invalidHomeIdentifier
+    case unknownHome
+    case itemNotFound(String)
+    case invalidValue(String, String)
+
+    var localizedStringResource: LocalizedStringResource {
+        switch self {
+        case .invalidHomeIdentifier:
+            "Invalid home identifier"
+        case .unknownHome:
+            "Unknown home"
+        case let .itemNotFound(itemName):
+            "Item '\(itemName)' not found"
+        case let .invalidValue(value, itemName):
+            "Invalid value: \(value) for \(itemName) must be HSB (0-360,0-100,0-100)"
+        }
+    }
+}
+
+@available(iOS 16.0, macOS 13.0, watchOS 9.0, tvOS 16.0, *)
+struct SetColorValue: AppIntent, CustomIntentMigratedAppIntent, PredictableIntent {
+    struct StringOptionsProvider: DynamicOptionsProvider {
+        func results() async throws -> [String] {
+            let allItems = await OpenHABItemCache.instance.getAllCachedItems()
+            let items = allItems.flatMap(\.value).filter { $0.type == .color }
+            return items.map(\.name)
+        }
+    }
+
+    static let intentClassName = "OpenHABSetColorValueIntent"
+
+    static let title: LocalizedStringResource = "Set Color Control Value"
+    static let description = IntentDescription("Set the color of a color control item")
+
+    // swiftlint:disable type_contents_order
+    @Parameter(title: "Item", optionsProvider: StringOptionsProvider())
+    var item: String
+
+    @Parameter(title: "Value", default: "240,100,100")
+    var value: String
+
+    @Parameter(title: "Home")
+    var home: Home
+
+    static var parameterSummary: some ParameterSummary {
+        Summary("Set \(\.$item) to \(\.$value) (HSB)") {
+            \.$home
+        }
+    }
+
+    // swiftlint:enable type_contents_order
+
+    static var predictionConfiguration: some IntentPredictionConfiguration {
+        IntentPrediction(parameters: (\.$item, \.$value, \.$home)) { item, value, _ in
+            DisplayRepresentation(
+                title: "Set \(item) to \(value) (HSB)",
+                subtitle: ""
+            )
+        }
+    }
+
+    func perform() async throws -> some IntentResult & ProvidesDialog {
+        var colorValue = value
+
+        guard let homeId = UUID(uuidString: home.id) else {
+            throw SetColorValueError.invalidHomeIdentifier
+        }
+
+        let homeExists = await MainActor.run {
+            Preferences.shared.storedHomes[homeId] != nil
+        }
+
+        guard homeExists else {
+            throw SetColorValueError.unknownHome
+        }
+
+        let hsb = colorValue.split(separator: ",")
+        guard hsb.count == 3,
+              let hue = Int(hsb[0]), (0 ... 360).contains(hue),
+              let sat = Int(hsb[1]), (0 ... 100).contains(sat),
+              let val = Int(hsb[2]), (0 ... 100).contains(val) else {
+            throw SetColorValueError.invalidValue(colorValue, item)
+        }
+
+        colorValue = "\(hue),\(sat),\(val)"
+
+        guard let items = await OpenHABItemCache.instance.getCachedItem(name: item, home: homeId),
+              !items.isEmpty else {
+            throw SetColorValueError.itemNotFound(item)
+        }
+
+        let openHABItem = items[0]
+
+        await OpenHABItemCache.instance.sendCommand(to: openHABItem, home: homeId, command: colorValue)
+
+        return .result(dialog: .responseSuccess(value: colorValue, item: item))
+    }
+}
+
+@available(iOS 16.0, macOS 13.0, watchOS 9.0, tvOS 16.0, *)
+private extension IntentDialog {
+    static var itemParameterConfiguration: Self {
+        "Color Item Name"
+    }
+
+    static var homeParameterConfiguration: Self {
+        "Home name"
+    }
+
+    static var homeParameterDisambiguationSelection: Self {
+        "For which home do you want to get the value?"
+    }
+
+    static func homeParameterDisambiguationIntro(count: Int, item: String) -> Self {
+        "There are \(count) configured homes with an item named '\(item)'."
+    }
+
+    static func homeParameterConfirmation(home: Home) -> Self {
+        "Just to confirm, you wanted '\(home)'?"
+    }
+
+    static func responseSuccess(value: String, item: String) -> Self {
+        "Sent the color value of \(value) to \(item)"
+    }
+
+    static func responseFailureInvalidItem(item: String) -> Self {
+        "Sorry can't find \(item)"
+    }
+
+    static func responseFailureInvalidValue(value: String, item: String) -> Self {
+        "Invalid value: \(value) for \(item) must be HSB (0-360,0-100,0-100)"
+    }
+}