shortcutkit 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +15 -7
  2. package/package.json +5 -1
package/README.md CHANGED
@@ -7,13 +7,21 @@ Build, validate and sign Apple Shortcuts (`.shortcut`) files from TypeScript or
7
7
 
8
8
  ## About
9
9
 
10
- Shortcuts has no public file-format specification and no public list of what its actions
11
- accept. shortcutkit fills that gap by extracting the action definitions and value encodings
12
- from WorkflowKit, the engine inside the Shortcuts app, and generating a typed catalogue from
13
- them. Every one of the 339 built-in actions is available with its parameter keys and value
14
- shapes checked at compile time in TypeScript, or at run time in Python. Nothing was
15
- transcribed by hand, and `data/provenance.json` records exactly which macOS and Shortcuts build
16
- the data came from.
10
+ Apple has never documented the `.shortcut` format or what its actions accept. shortcutkit
11
+ does not guess at either. The tools in this repository load WorkflowKit, the private framework
12
+ behind the Shortcuts app, and ask its own classes to describe and serialize every built-in
13
+ action. Every action identifier, parameter key, value encoding, icon colour, and even the
14
+ UTF-16 offset rule for embedded references came out of the engine, not from a person reading
15
+ files. The package cannot disagree with the app.
16
+
17
+ That turns an undocumented format into a typed one. In TypeScript, a wrong parameter key or a
18
+ string where a boolean belongs is a compile error. In Python the same checks run when you call
19
+ `action()`. A file built from plain code signs, imports and runs.
20
+
21
+ The data stays current the same way it was made. After a macOS update, one command re-extracts
22
+ everything in about a minute and prints a diff of what Apple changed, along with the semver
23
+ bump it deserves. `data/provenance.json` records which macOS and Shortcuts build produced the
24
+ files you are using.
17
25
 
18
26
  ## Features
19
27
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "shortcutkit",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Build, validate and sign Apple Shortcuts files. Every built-in action typed, straight from the Shortcuts engine.",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
@@ -39,10 +39,14 @@
39
39
  "homepage": "https://github.com/frontboat/shortcutkit#readme",
40
40
  "keywords": [
41
41
  "apple",
42
+ "apple-shortcuts",
42
43
  "shortcuts",
44
+ "shortcuts-app",
45
+ "workflowkit",
43
46
  "workflow",
44
47
  "automation",
45
48
  "macos",
49
+ "macos-automation",
46
50
  "ios",
47
51
  "plist"
48
52
  ],