buildanything 1.7.0 → 1.8.0

package/skills/ios/app-intents/LICENSE

@@ -0,0 +1,131 @@
+Required Notice: Copyright (c) 2025 dpearson2699 (https://github.com/dpearson2699)
+
+# PolyForm Perimeter License 1.0.0
+
+<https://polyformproject.org/licenses/perimeter/1.0.0>
+
+## Acceptance
+
+In order to get any license under these terms, you must agree
+to them as both strict obligations and conditions to all
+your licenses.
+
+## Copyright License
+
+The licensor grants you a copyright license for the
+software to do everything you might do with the software
+that would otherwise infringe the licensor's copyright
+in it for any permitted purpose.  However, you may
+only distribute the software according to [Distribution
+License](#distribution-license) and make changes or new works
+based on the software according to [Changes and New Works
+License](#changes-and-new-works-license).
+
+## Distribution License
+
+The licensor grants you an additional copyright license
+to distribute copies of the software.  Your license
+to distribute covers distributing the software with
+changes and new works permitted by [Changes and New Works
+License](#changes-and-new-works-license).
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of
+the software from you also gets a copy of these terms or the
+URL for them above, as well as copies of any plain-text lines
+beginning with `Required Notice:` that the licensor provided
+with the software.  For example:
+
+> Required Notice: Copyright Yoyodyne, Inc. (http://example.com)
+
+## Changes and New Works License
+
+The licensor grants you an additional copyright license to
+make changes and new works based on the software for any
+permitted purpose.
+
+## Patent License
+
+The licensor grants you a patent license for the software that
+covers patent claims the licensor can license, or becomes able
+to license, that you would infringe by using the software.
+
+## Noncompete
+
+Any purpose is a permitted purpose, except for providing to
+others any product that competes with the software.
+
+## Competition
+
+If you use this software to market a product as a substitute
+for the functionality or value of the software, it competes
+with the software. A product may compete regardless how it is
+designed or deployed. For example, a product may compete even
+if it provides its functionality via any kind of interface
+(including services, libraries or plug-ins), even if it is
+ported to a different platforms or programming languages,
+and even if it is provided free of charge.
+
+## Fair Use
+
+You may have "fair use" rights for the software under the
+law. These terms do not limit them.
+
+## No Other Rights
+
+These terms do not allow you to sublicense or transfer any of
+your licenses to anyone else, or prevent the licensor from
+granting licenses to anyone else.  These terms do not imply
+any other licenses.
+
+## Patent Defense
+
+If you make any written claim that the software infringes or
+contributes to infringement of any patent, your patent license
+for the software granted under these terms ends immediately. If
+your company makes such a claim, your patent license ends
+immediately for work on behalf of your company.
+
+## Violations
+
+The first time you are notified in writing that you have
+violated any of these terms, or done anything with the software
+not covered by your licenses, your licenses can nonetheless
+continue if you come into full compliance with these terms,
+and take practical steps to correct past violations, within
+32 days of receiving notice.  Otherwise, all your licenses
+end immediately.
+
+## No Liability
+
+***As far as the law allows, the software comes as is, without
+any warranty or condition, and the licensor will not be liable
+to you for any damages arising out of these terms or the use
+or nature of the software, under any kind of legal claim.***
+
+## Definitions
+
+The **licensor** is the individual or entity offering these
+terms, and the **software** is the software the licensor makes
+available under these terms.
+
+A **product** can be a good or service, or a combination
+of them.
+
+**You** refers to the individual or entity agreeing to these
+terms.
+
+**Your company** is any legal entity, sole proprietorship,
+or other kind of organization that you work for, plus all
+organizations that have control over, are under the control of,
+or are under common control with that organization.  **Control**
+means ownership of substantially all the assets of an entity,
+or the power to direct its management and policies by vote,
+contract, or otherwise.  Control can be direct or indirect.
+
+**Your licenses** are all the licenses granted to you for the
+software under these terms.
+
+**Use** means anything you do with the software requiring one
+of your licenses.

package/skills/ios/app-intents/SKILL.md

@@ -0,0 +1,494 @@
+---
+name: app-intents
+description: "Implement App Intents for Siri, Shortcuts, Spotlight, widgets, Control Center, and Apple Intelligence on iOS. Covers AppIntent actions, AppEntity and EntityQuery models, AppShortcutsProvider phrases, IndexedEntity Spotlight indexing, WidgetConfigurationIntent, SnippetIntent, and assistant schemas. Use when exposing app actions or entities to system surfaces."
+---
+
+# App Intents (iOS 26+)
+
+Implement, review, and extend App Intents to expose app functionality to Siri,
+Shortcuts, Spotlight, widgets, Control Center, and Apple Intelligence.
+
+## Contents
+
+- [Triage Workflow](#triage-workflow)
+- [AppIntent Protocol](#appintent-protocol)
+- [@Parameter](#parameter)
+- [AppEntity](#appentity)
+- [EntityQuery (4 Variants)](#entityquery-4-variants)
+- [AppEnum](#appenum)
+- [AppShortcutsProvider](#appshortcutsprovider)
+- [Siri Integration](#siri-integration)
+- [Interactive Widget Intents](#interactive-widget-intents)
+- [Control Center Widgets (iOS 18+)](#control-center-widgets-ios-18)
+- [Spotlight and IndexedEntity (iOS 18+)](#spotlight-and-indexedentity-ios-18)
+- [iOS 26 Additions](#ios-26-additions)
+- [Common Mistakes](#common-mistakes)
+- [Review Checklist](#review-checklist)
+- [References](#references)
+
+## Triage Workflow
+
+### Step 1: Identify the integration surface
+
+Determine which system feature the intent targets:
+
+| Surface | Protocol | Since |
+|---|---|---|
+| Siri / Shortcuts | `AppIntent` | iOS 16 |
+| Configurable widget | `WidgetConfigurationIntent` | iOS 17 |
+| Control Center | `ControlConfigurationIntent` | iOS 18 |
+| Spotlight search | `IndexedEntity` | iOS 18 |
+| Apple Intelligence | `@AppIntent(schema:)` | iOS 18 |
+| Interactive snippets | `SnippetIntent` | iOS 26 |
+| Visual Intelligence | `IntentValueQuery` | iOS 26 |
+
+### Step 2: Define the data model
+
+- Create `AppEntity` shadow models (do NOT conform core data models directly).
+- Create `AppEnum` types for fixed parameter choices.
+- Choose the right `EntityQuery` variant for resolution.
+- Mark searchable entities with `IndexedEntity` and `@Property(indexingKey:)`.
+
+### Step 3: Implement the intent
+
+- Conform to `AppIntent` (or a specialized sub-protocol).
+- Declare `@Parameter` properties for all user-facing inputs.
+- Implement `perform() async throws -> some IntentResult`.
+- Add `parameterSummary` for Shortcuts UI.
+- Register phrases via `AppShortcutsProvider`.
+
+### Step 4: Verify
+
+- Build and run in Shortcuts app to confirm parameter resolution.
+- Test Siri phrases with the intent preview in Xcode.
+- Confirm Spotlight results for `IndexedEntity` types.
+- Check widget configuration for `WidgetConfigurationIntent` intents.
+
+## AppIntent Protocol
+
+The system instantiates the struct via `init()`, sets parameters, then calls
+`perform()`. Declare a `title` and `parameterSummary` for Shortcuts UI.
+
+```swift
+struct OrderSoupIntent: AppIntent {
+    static var title: LocalizedStringResource = "Order Soup"
+    static var description = IntentDescription("Place a soup order.")
+
+    @Parameter(title: "Soup") var soup: SoupEntity
+    @Parameter(title: "Quantity", default: 1) var quantity: Int
+
+    static var parameterSummary: some ParameterSummary {
+        Summary("Order \(\.$soup)") { \.$quantity }
+    }
+
+    func perform() async throws -> some IntentResult {
+        try await OrderService.shared.place(soup: soup.id, quantity: quantity)
+        return .result(dialog: "Ordered \(quantity) \(soup.name).")
+    }
+}
+```
+
+Optional members: `description` (`IntentDescription`), `openAppWhenRun` (`Bool`),
+`isDiscoverable` (`Bool`), `authenticationPolicy` (`IntentAuthenticationPolicy`).
+
+## @Parameter
+
+Declare each user-facing input with `@Parameter`. Optional parameters are not
+required; non-optional parameters with a `default` are pre-filled.
+
+```swift
+// WRONG: Non-optional parameter without default -- system cannot preview
+@Parameter(title: "Count")
+var count: Int
+
+// CORRECT: Provide a default or make optional
+@Parameter(title: "Count", default: 1)
+var count: Int
+
+@Parameter(title: "Count")
+var count: Int?
+```
+
+### Supported value types
+
+Primitives: `Int`, `Double`, `Bool`, `String`, `URL`, `Date`, `DateComponents`.
+Framework: `Currency`, `Person`, `IntentFile`. Measurements: `Measurement<UnitLength>`,
+`Measurement<UnitTemperature>`, and others. Custom: any `AppEntity` or `AppEnum`.
+
+### Common initializer patterns
+
+```swift
+// Basic
+@Parameter(title: "Name")
+var name: String
+
+// With default
+@Parameter(title: "Count", default: 5)
+var count: Int
+
+// Numeric slider
+@Parameter(title: "Volume", controlStyle: .slider, inclusiveRange: (0, 100))
+var volume: Int
+
+// Options provider (dynamic list)
+@Parameter(title: "Category", optionsProvider: CategoryOptionsProvider())
+var category: Category
+
+// File with content types
+@Parameter(title: "Document", supportedContentTypes: [.pdf, .plainText])
+var document: IntentFile
+
+// Measurement with unit
+@Parameter(title: "Distance", defaultUnit: .miles, supportsNegativeNumbers: false)
+var distance: Measurement<UnitLength>
+```
+
+See [references/appintents-advanced.md](references/appintents-advanced.md) for all initializer variants.
+
+## AppEntity
+
+Create shadow models that mirror app data -- never conform core data model
+types directly.
+
+```swift
+struct SoupEntity: AppEntity {
+    static let defaultQuery = SoupEntityQuery()
+    static var typeDisplayRepresentation: TypeDisplayRepresentation = "Soup"
+    var id: String
+
+    @Property(title: "Name") var name: String
+    @Property(title: "Price") var price: Double
+
+    var displayRepresentation: DisplayRepresentation {
+        DisplayRepresentation(title: "\(name)", subtitle: "$\(String(format: "%.2f", price))")
+    }
+
+    init(from soup: Soup) {
+        self.id = soup.id; self.name = soup.name; self.price = soup.price
+    }
+}
+```
+
+Required: `id`, `defaultQuery` (static), `displayRepresentation`,
+`typeDisplayRepresentation` (static). Mark properties with `@Property(title:)`
+to expose for filtering/sorting. Properties without `@Property` remain internal.
+
+## EntityQuery (4 Variants)
+
+### 1. EntityQuery (base -- resolve by ID)
+
+```swift
+struct SoupEntityQuery: EntityQuery {
+    func entities(for identifiers: [String]) async throws -> [SoupEntity] {
+        SoupStore.shared.soups.filter { identifiers.contains($0.id) }.map { SoupEntity(from: $0) }
+    }
+    func suggestedEntities() async throws -> [SoupEntity] {
+        SoupStore.shared.featured.map { SoupEntity(from: $0) }
+    }
+}
+```
+
+### 2. EntityStringQuery (free-text search)
+
+```swift
+struct SoupStringQuery: EntityStringQuery {
+    func entities(matching string: String) async throws -> [SoupEntity] {
+        SoupStore.shared.search(string).map { SoupEntity(from: $0) }
+    }
+    func entities(for identifiers: [String]) async throws -> [SoupEntity] {
+        SoupStore.shared.soups.filter { identifiers.contains($0.id) }.map { SoupEntity(from: $0) }
+    }
+}
+```
+
+### 3. EnumerableEntityQuery (finite set)
+
+```swift
+struct AllSoupsQuery: EnumerableEntityQuery {
+    func allEntities() async throws -> [SoupEntity] {
+        SoupStore.shared.allSoups.map { SoupEntity(from: $0) }
+    }
+    func entities(for identifiers: [String]) async throws -> [SoupEntity] {
+        SoupStore.shared.soups.filter { identifiers.contains($0.id) }.map { SoupEntity(from: $0) }
+    }
+}
+```
+
+### 4. UniqueAppEntityQuery (singleton, iOS 18+)
+
+Use for single-instance entities like app settings.
+
+```swift
+struct AppSettingsEntity: UniqueAppEntity {
+    static let defaultQuery = AppSettingsQuery()
+    static var typeDisplayRepresentation: TypeDisplayRepresentation = "Settings"
+    var displayRepresentation: DisplayRepresentation { "App Settings" }
+
+    var id: String { "app-settings" }
+}
+
+struct AppSettingsQuery: UniqueAppEntityQuery {
+    func entity() async throws -> AppSettingsEntity {
+        AppSettingsEntity()
+    }
+}
+```
+
+See [references/appintents-advanced.md](references/appintents-advanced.md) for `EntityPropertyQuery` with
+filter/sort support.
+
+## AppEnum
+
+Define fixed sets of selectable values. Must be backed by a
+`LosslessStringConvertible` raw value (use `String`).
+
+```swift
+enum SoupSize: String, AppEnum {
+    case small, medium, large
+
+    static var typeDisplayRepresentation: TypeDisplayRepresentation = "Size"
+
+    static var caseDisplayRepresentations: [SoupSize: DisplayRepresentation] = [
+        .small: "Small",
+        .medium: "Medium",
+        .large: "Large"
+    ]
+}
+```
+
+```swift
+// WRONG: Using Int raw value
+enum Priority: Int, AppEnum { // Compiler error -- Int is not LosslessStringConvertible
+    case low = 1, medium = 2, high = 3
+}
+
+// CORRECT: Use String raw value
+enum Priority: String, AppEnum {
+    case low, medium, high
+    // ...
+}
+```
+
+## AppShortcutsProvider
+
+Register pre-built shortcuts that appear in Siri and the Shortcuts app without
+user configuration.
+
+```swift
+struct MyAppShortcuts: AppShortcutsProvider {
+    static var appShortcuts: [AppShortcut] {
+        AppShortcut(
+            intent: OrderSoupIntent(),
+            phrases: [
+                "Order \(\.$soup) in \(.applicationName)",
+                "Get soup from \(.applicationName)"
+            ],
+            shortTitle: "Order Soup",
+            systemImageName: "cup.and.saucer"
+        )
+    }
+
+    static var shortcutTileColor: ShortcutTileColor = .navy
+}
+```
+
+### Phrase rules
+
+- Every phrase MUST include `\(.applicationName)`.
+- Phrases can reference parameters: `\(\.$soup)`.
+- Call `updateAppShortcutParameters()` when dynamic option values change.
+- Use `negativePhrases` to prevent false Siri activations.
+
+## Siri Integration
+
+### Donating intents
+
+Donate intents so the system learns user patterns and suggests them in Spotlight:
+
+```swift
+let intent = OrderSoupIntent()
+intent.soup = favoriteSoupEntity
+try await intent.donate()
+```
+
+### Predictable intents
+
+Conform to `PredictableIntent` for Siri prediction of upcoming actions.
+
+## Interactive Widget Intents
+
+Use `AppIntent` with `Button`/`Toggle` in widgets. Use
+`WidgetConfigurationIntent` for configurable widget parameters.
+
+```swift
+struct ToggleFavoriteIntent: AppIntent {
+    static var title: LocalizedStringResource = "Toggle Favorite"
+    @Parameter(title: "Item ID") var itemID: String
+
+    func perform() async throws -> some IntentResult {
+        FavoriteStore.shared.toggle(itemID)
+        return .result()
+    }
+}
+
+// In widget view:
+Button(intent: ToggleFavoriteIntent(itemID: entry.id)) {
+    Image(systemName: entry.isFavorite ? "heart.fill" : "heart")
+}
+```
+
+### WidgetConfigurationIntent
+
+```swift
+struct BookWidgetConfig: WidgetConfigurationIntent {
+    static var title: LocalizedStringResource = "Favorite Book"
+    @Parameter(title: "Book", default: "The Swift Programming Language") var bookTitle: String
+}
+
+// Connect to WidgetKit:
+struct MyWidget: Widget {
+    var body: some WidgetConfiguration {
+        AppIntentConfiguration(kind: "FavoriteBook", intent: BookWidgetConfig.self, provider: MyTimelineProvider()) { entry in
+            BookWidgetView(entry: entry)
+        }
+    }
+}
+```
+
+## Control Center Widgets (iOS 18+)
+
+Expose controls in Control Center and Lock Screen with
+`ControlConfigurationIntent` and `ControlWidget`.
+
+```swift
+struct LightControlConfig: ControlConfigurationIntent {
+    static var title: LocalizedStringResource = "Light Control"
+    @Parameter(title: "Light", default: .livingRoom) var light: LightEntity
+}
+
+struct ToggleLightIntent: AppIntent {
+    static var title: LocalizedStringResource = "Toggle Light"
+    @Parameter(title: "Light") var light: LightEntity
+    func perform() async throws -> some IntentResult {
+        try await LightService.shared.toggle(light.id)
+        return .result()
+    }
+}
+
+struct LightControl: ControlWidget {
+    var body: some ControlWidgetConfiguration {
+        AppIntentControlConfiguration(kind: "LightControl", intent: LightControlConfig.self) { config in
+            ControlWidgetToggle(config.light.name, isOn: config.light.isOn, action: ToggleLightIntent(light: config.light))
+        }
+    }
+}
+```
+
+## Spotlight and IndexedEntity (iOS 18+)
+
+Conform to `IndexedEntity` for Spotlight search. On iOS 26+, use `indexingKey`
+for structured metadata:
+
+```swift
+struct RecipeEntity: IndexedEntity {
+    static let defaultQuery = RecipeQuery()
+    static var typeDisplayRepresentation: TypeDisplayRepresentation = "Recipe"
+    var id: String
+
+    @Property(title: "Name", indexingKey: .title) var name: String   // iOS 26+
+    @ComputedProperty(indexingKey: .description)                      // iOS 26+
+    var summary: String { "\(name) -- a delicious recipe" }
+
+    var displayRepresentation: DisplayRepresentation {
+        DisplayRepresentation(title: "\(name)")
+    }
+}
+```
+
+## iOS 26 Additions
+
+### SnippetIntent
+
+Display interactive snippets in system UI:
+
+```swift
+struct OrderStatusSnippet: SnippetIntent {
+    static var title: LocalizedStringResource = "Order Status"
+    func perform() async throws -> some IntentResult & ShowsSnippetView {
+        let status = await OrderTracker.currentStatus()
+        return .result(view: OrderStatusSnippetView(status: status))
+    }
+    static func reload() { /* notify system to refresh */ }
+}
+
+// A calling intent can display this snippet via:
+// return .result(snippetIntent: OrderStatusSnippet())
+```
+
+### IntentValueQuery (Visual Intelligence)
+
+```swift
+struct ProductValueQuery: IntentValueQuery {
+    typealias Input = String
+    typealias Result = ProductEntity
+    func values(for input: String) async throws -> [ProductEntity] {
+        ProductStore.shared.search(input).map { ProductEntity(from: $0) }
+    }
+}
+```
+
+## Common Mistakes
+
+1. **Conforming core data models to AppEntity.** Create dedicated shadow models
+   instead. Core models carry persistence logic that conflicts with intent
+   lifecycle.
+
+2. **Missing `\(.applicationName)` in phrases.** Every `AppShortcut` phrase
+   MUST include the application name token. Siri uses it for disambiguation.
+
+3. **Non-optional @Parameter without default.** The system cannot preview or
+   pre-fill such parameters. Make non-optional parameters have a `default`, or
+   mark them optional.
+
+   ```swift
+   // WRONG
+   @Parameter(title: "Count")
+   var count: Int
+
+   // CORRECT
+   @Parameter(title: "Count", default: 1)
+   var count: Int
+   ```
+
+4. **Using Int raw value for AppEnum.** `AppEnum` requires `RawRepresentable`
+   where `RawValue: LosslessStringConvertible`. Use `String`.
+
+5. **Forgetting `suggestedEntities()`.** Without it, the Shortcuts picker shows no defaults.
+6. **Throwing for missing entities in `entities(for:)`.** Omit missing entities instead.
+7. **Stale Spotlight index.** Call `updateAppShortcutParameters()` when entity data changes.
+8. **Missing `typeDisplayRepresentation`.** Both `AppEntity` and `AppEnum` require it.
+9. **Using deprecated `@AssistantEntity(schema:)` / `@AssistantEnum(schema:)`.** Use `@AppEntity(schema:)` and `@AppEnum(schema:)` instead. Note: `@AssistantIntent(schema:)` is still active.
+10. **Blocking perform().** `perform()` is async -- use `await` for I/O.
+
+## Review Checklist
+
+- [ ] Every `AppIntent` has a descriptive `title` (verb + noun, title case)
+- [ ] `@Parameter` types are optional or have defaults for system preview
+- [ ] `AppEntity` types are shadow models, not core data model conformances
+- [ ] `AppEntity` has `displayRepresentation` and `typeDisplayRepresentation`
+- [ ] `EntityQuery.entities(for:)` omits missing IDs; `suggestedEntities()` implemented
+- [ ] `AppEnum` uses `String` raw value with `caseDisplayRepresentations`
+- [ ] `AppShortcutsProvider` phrases include `\(.applicationName)`; `parameterSummary` defined
+- [ ] `IndexedEntity` properties use `@Property(indexingKey:)` on iOS 26+
+- [ ] Control Center intents conform to `ControlConfigurationIntent`; widget intents to `WidgetConfigurationIntent`
+- [ ] No deprecated `@AssistantEntity` / `@AssistantEnum` macros (note: `@AssistantIntent(schema:)` is still active)
+- [ ] `perform()` uses async/await (no blocking); runs in expected isolation context; intent types are `Sendable`
+
+## References
+
+- See [references/appintents-advanced.md](references/appintents-advanced.md) for @Parameter variants, EntityPropertyQuery, assistant schemas, focus filters, SiriKit migration, error handling, confirmation flows, authentication, URL-representable types, and Spotlight indexing details.
+
+
+---
+
+Vendored from: https://github.com/dpearson2699/swift-ios-skills/tree/main/skills/app-intents