shortcutkit 0.5.1 → 0.7.0

package/README.md

@@ -28,23 +28,28 @@ files you are using.
 
 - **Every built-in action, typed.** `actions.*` lists all 434 identifiers, with each action's
   name, description, summary, output and parameter keys as hover documentation.
-- **Apple's apps too.** 1,581 App Intents actions from 80 Apple apps and system components,
+- **Apple's apps too.** 1,441 App Intents actions from 77 Apple apps and system components,
   Create Reminder, Create Note, Send Message, the System Settings toggles, under the keys the
   Shortcuts app itself assigns them: `actions.reminders_create_reminder`. Enumeration cases are
   typed, and the `AppIntentDescriptor` the file needs is added for you.
 - **Parameters checked before you run anything.** `{ WFStoredContentGlobalValue: "yes" }` is a
   compile error; a switch takes a boolean or a reference. Enumeration choices are suggested.
-  Any plain value slot also accepts an attachment, because that is how Shortcuts works.
+  Any plain value slot also accepts an attachment, because that is how Shortcuts works. Every
+  action has a named parameter type (`ShowresultParams`, `RemindersCreateReminderParams`), and
+  its output content types are on `ACTIONS[id].outputTypes` and on the returned `Action`.
 - **Value helpers that match the engine's serialization.** `ref()` to another action's output,
   `variable()`, `shortcutInput()`, `clipboard()`, `currentDate()`, `ask()`, `text()` for
-  strings with embedded references, and `picker()` for variable-picker parameters.
+  strings with embedded references, and `picker()` for variable-picker parameters. A bare
+  `ref()` given to a text parameter is wrapped into the token string the engine writes.
 - **Control flow.** `if()` / `otherwise()` / `endIf()`, `repeatEach()` / `endRepeatEach()`,
   `repeatCount()` / `endRepeatCount()` and `chooseFromMenu()` / `menuItem()` / `endMenu()`
   manage the grouping identifiers for you.
 - **App Intents from installed apps.** Any identifier outside the built-in set is accepted;
   built-in identifiers and their parameter keys are also validated at run time.
-- **Definitions and provenance.** `getDefinition(id)` returns the full record (icon, keywords,
-  parameter classes, required resources); `provenance` says which build produced the data.
+- **Definitions and provenance.** `getAction(id)` describes any identifier, built-in or App
+  Intent: name, parameter keys and kinds, output, descriptor. `getDefinition(id)` returns the
+  engine's full record for a built-in (icon, keywords, parameter classes, required resources);
+  `provenance` says which build produced the data.
 - **Signing.** `Shortcut.sign()` wraps `shortcuts sign` so the output imports on any device.
 
 ## How it compares
@@ -60,7 +65,7 @@ manager, whose actions are defined in that language.
 
 shortcutkit is a library, not a language. You write TypeScript or Python you already know, and
 the action catalogue comes from the Shortcuts engine rather than from a maintainer. All 434
-built-in actions and 1,581 Apple App Intents are covered today, and the next macOS update is
+built-in actions and 1,441 Apple App Intents are covered today, and the next macOS update is
 one `bun run extract` away.
 
 ## Installation
@@ -165,7 +170,7 @@ python -m shortcutkit demo out.shortcut
   to end, every field.
 - [`docs/builtin-actions-reference.md`](docs/builtin-actions-reference.md): all 434 built-in
   actions with their parameters.
-- [`docs/apple-app-intents-reference.md`](docs/apple-app-intents-reference.md): the 1,581 App
+- [`docs/apple-app-intents-reference.md`](docs/apple-app-intents-reference.md): the 1,441 App
   Intents actions of Apple's apps, by app, with parameter kinds and enumeration cases.
 - [`docs/parameter-encodings.md`](docs/parameter-encodings.md): how each parameter class is
   serialized.