mirror of
https://github.com/home-assistant/iOS.git
synced 2026-05-01 19:59:27 -05:00
Add "Run Script" AppIntent and Widget (#2900)
<!-- Thank you for submitting a Pull Request and helping to improve Home Assistant. Please complete the following sections to help the processing and review of your changes. Please do not delete anything from this template. --> ## Summary <!-- Provide a brief summary of the changes you have made and most importantly what they aim to achieve --> Pending: - Allow color customisation - Choose to receive or not notification confirmation ## Screenshots <!-- If this is a user-facing change not in the frontend, please include screenshots in light and dark mode. --> ## Link to pull request in Documentation repository <!-- Pull requests that add, change or remove functionality must have a corresponding pull request in the Companion App Documentation repository (https://github.com/home-assistant/companion.home-assistant). Please add the number of this pull request after the "#" --> Documentation: home-assistant/companion.home-assistant# ## Any other notes <!-- If there is any other information of note, like if this Pull Request is part of a bigger change, please include it here. -->
This commit is contained in:
Bruno Pantaleão Gonçalves
committed by
GitHub
GitHub
parent
d7a3930703
commit
c65519658e
171
Sources/Extensions/AppIntents/Script/ScriptAppIntent.swift
Normal file
171
Sources/Extensions/AppIntents/Script/ScriptAppIntent.swift
Normal file
@@ -0,0 +1,171 @@
|
||||
import AppIntents
|
||||
import Foundation
|
||||
import PromiseKit
|
||||
import Shared
|
||||
import SwiftUI
|
||||
|
||||
@available(iOS 16.4, *)
|
||||
final class ScriptAppIntent: AppIntent {
|
||||
static let title: LocalizedStringResource = .init("widgets.script.description.title", defaultValue: "Run Script")
|
||||
|
||||
@Parameter(title: LocalizedStringResource("app_intents.scripts.script.title", defaultValue: "Run Script"))
|
||||
var script: IntentScriptEntity
|
||||
|
||||
@Parameter(
|
||||
title: LocalizedStringResource(
|
||||
"app_intents.scripts.requires_confirmation_before_run.title",
|
||||
defaultValue: "Confirm before run"
|
||||
),
|
||||
description: LocalizedStringResource(
|
||||
"app_intents.scripts.requires_confirmation_before_run.description",
|
||||
defaultValue: "Requires manual confirmation before running the script."
|
||||
),
|
||||
default: true
|
||||
)
|
||||
var requiresConfirmationBeforeRun: Bool
|
||||
|
||||
@Parameter(
|
||||
title: LocalizedStringResource(
|
||||
"app_intents.scripts.show_confirmation_dialog.title",
|
||||
defaultValue: "Confirmation notification"
|
||||
),
|
||||
description: LocalizedStringResource(
|
||||
"app_intents.scripts.show_confirmation_dialog.description",
|
||||
defaultValue: "Shows confirmation notification after executed"
|
||||
),
|
||||
default: true
|
||||
)
|
||||
var showConfirmationDialog: Bool
|
||||
|
||||
func perform() async throws -> some IntentResult & ReturnsValue<Bool> {
|
||||
if requiresConfirmationBeforeRun {
|
||||
try await requestConfirmation()
|
||||
}
|
||||
|
||||
let success: Bool = try await withCheckedThrowingContinuation { continuation in
|
||||
guard let server = Current.servers.all.first(where: { $0.identifier.rawValue == script.serverId }) else {
|
||||
continuation.resume(returning: false)
|
||||
return
|
||||
}
|
||||
let domain = Domain.script.rawValue
|
||||
let service = script.id.replacingOccurrences(of: "\(domain).", with: "")
|
||||
Current.api(for: server).CallService(domain: domain, service: service, serviceData: [:])
|
||||
.pipe { [weak self] result in
|
||||
switch result {
|
||||
case .fulfilled:
|
||||
continuation.resume(returning: true)
|
||||
case let .rejected(error):
|
||||
Current.Log
|
||||
.error(
|
||||
"Failed to execute script from ScriptAppIntent, name: \(String(describing: self?.script.displayString)), error: \(error.localizedDescription)"
|
||||
)
|
||||
continuation.resume(returning: false)
|
||||
}
|
||||
}
|
||||
}
|
||||
if showConfirmationDialog {
|
||||
LocalNotificationDispatcher().send(.init(
|
||||
id: .scriptAppIntentRun,
|
||||
title: success ? L10n.AppIntents.Scripts.SuccessMessage.content(script.displayString) : L10n.AppIntents
|
||||
.Scripts.FailureMessage.content(script.displayString)
|
||||
))
|
||||
}
|
||||
return .result(value: success)
|
||||
}
|
||||
}
|
||||
|
||||
@available(iOS 16.4, macOS 13.0, watchOS 9.0, *)
|
||||
struct IntentScriptEntity: AppEntity {
|
||||
static let typeDisplayRepresentation = TypeDisplayRepresentation(name: "Script")
|
||||
|
||||
static let defaultQuery = IntentScriptAppEntityQuery()
|
||||
|
||||
var id: String
|
||||
var serverId: String
|
||||
var serverName: String
|
||||
var displayString: String
|
||||
var iconName: String
|
||||
var displayRepresentation: DisplayRepresentation {
|
||||
DisplayRepresentation(title: "\(displayString)")
|
||||
}
|
||||
|
||||
init(
|
||||
id: String,
|
||||
serverId: String,
|
||||
serverName: String,
|
||||
displayString: String,
|
||||
iconName: String
|
||||
) {
|
||||
self.id = id
|
||||
self.serverId = serverId
|
||||
self.serverName = serverName
|
||||
self.displayString = displayString
|
||||
self.iconName = iconName
|
||||
}
|
||||
}
|
||||
|
||||
@available(iOS 16.4, macOS 13.0, watchOS 9.0, *)
|
||||
struct IntentScriptAppEntityQuery: EntityQuery, EntityStringQuery {
|
||||
func entities(for identifiers: [String]) async throws -> [IntentScriptEntity] {
|
||||
await getScriptEntities().flatMap(\.value).filter { identifiers.contains($0.id) }
|
||||
}
|
||||
|
||||
func entities(matching string: String) async throws -> IntentItemCollection<IntentScriptEntity> {
|
||||
let scriptsPerServer = await getScriptEntities()
|
||||
|
||||
return .init(sections: scriptsPerServer.map { (key: Server, value: [IntentScriptEntity]) in
|
||||
.init(.init(stringLiteral: key.info.name), items: value)
|
||||
})
|
||||
}
|
||||
|
||||
func suggestedEntities() async throws -> IntentItemCollection<IntentScriptEntity> {
|
||||
let scriptsPerServer = await getScriptEntities()
|
||||
|
||||
return .init(sections: scriptsPerServer.map { (key: Server, value: [IntentScriptEntity]) in
|
||||
.init(.init(stringLiteral: key.info.name), items: value)
|
||||
})
|
||||
}
|
||||
|
||||
private func getScriptEntities(matching string: String? = nil) async -> [Server: [IntentScriptEntity]] {
|
||||
await withCheckedContinuation { continuation in
|
||||
var entities: [Server: [IntentScriptEntity]] = [:]
|
||||
var serverCheckedCount = 0
|
||||
for server in Current.servers.all.sorted(by: { $0.info.name < $1.info.name }) {
|
||||
(
|
||||
Current.diskCache
|
||||
.value(
|
||||
for: HAScript
|
||||
.cacheKey(serverId: server.identifier.rawValue)
|
||||
) as? Promise<[HAScript]>
|
||||
)?.pipe(to: { result in
|
||||
switch result {
|
||||
case let .fulfilled(scripts):
|
||||
var scripts = scripts.sorted(by: { $0.name ?? "" < $1.name ?? "" })
|
||||
if let string {
|
||||
scripts = scripts.filter { $0.name?.contains(string) ?? false }
|
||||
}
|
||||
|
||||
entities[server] = scripts.compactMap { script in
|
||||
IntentScriptEntity(
|
||||
id: script.id,
|
||||
serverId: server.identifier.rawValue,
|
||||
serverName: server.info.name,
|
||||
displayString: script.name ?? "Unknown",
|
||||
iconName: script.iconName ?? ""
|
||||
)
|
||||
}
|
||||
case let .rejected(error):
|
||||
Current.Log
|
||||
.error(
|
||||
"Failed to get scripts cache for server identifier: \(server.identifier.rawValue), error: \(error.localizedDescription)"
|
||||
)
|
||||
}
|
||||
serverCheckedCount += 1
|
||||
if serverCheckedCount == Current.servers.all.count {
|
||||
continuation.resume(returning: entities)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user