shortcutkit 0.7.0 → 1.0.0

package/dist/values.d.ts

@@ -1,8 +1,15 @@
 import type { PlistValue } from "./plist.js";
-export type Attachment = {
+/** The variable kinds a reference can name, as the engine spells them. */
+export type VariableType = "ActionOutput" | "ExtensionInput" | "Variable" | "Clipboard" | "CurrentDate" | "Ask" | "DeviceDetails" | "CurrentApp";
+/** A run-time reference. Each helper returns the narrow type (ref() an Attachment<"ActionOutput">), so a key the
+ *  engine reads only some references for (PARAM_VARIABLE_TYPES) can say which at compile time. */
+export type Attachment<T extends VariableType = VariableType> = {
     WFSerializationType: "WFTextTokenAttachment";
-    Value: Record<string, PlistValue>;
+    Value: {
+        Type: T;
+    } & Record<string, PlistValue>;
 };
+export type AskAttachment = Attachment<"Ask">;
 export type TokenString = {
     WFSerializationType: "WFTextTokenString";
     Value: {
@@ -10,10 +17,13 @@ export type TokenString = {
         attachmentsByRange: Record<string, Record<string, PlistValue>>;
     };
 };
-export type Picker = {
+/** The subject of an If condition (`WFInput` on `is.workflow.actions.conditional`): an attachment wrapped as the app writes it. Not the variable-picker form, which is the bare attachment. */
+export type ConditionSubject = {
     Type: "Variable";
     Variable: Attachment;
 };
+/** @deprecated Misnamed: this is the If-subject form. Variable-picker parameters take a bare `Attachment`. */
+export type Picker = ConditionSubject;
 export type DictionaryValue = {
     WFSerializationType: "WFDictionaryFieldValue";
     Value: {
@@ -45,7 +55,7 @@ export type FilterTemplateValue = {
         }>;
     };
 };
-export type Value = PlistValue | Attachment | TokenString | Picker | DictionaryValue | QuantityValue | FilterTemplateValue;
+export type Value = PlistValue | Attachment | TokenString | ConditionSubject | DictionaryValue | QuantityValue | FilterTemplateValue;
 /** Keeps literal suggestions in editors while still accepting any string. */
 export type Loose<T extends string> = T | (string & {});
 export type BoolValue = boolean | Attachment;
@@ -53,7 +63,8 @@ export type NumberValue = number | Attachment;
 export type StringValue = string | Attachment;
 export type EnumValue<T extends string> = Loose<T> | Attachment;
 export type TextValue = string | TokenString | Attachment;
-export type PickerValue = Picker | Attachment;
+export type PickerValue = Attachment;
+export type SubjectValue = ConditionSubject | Attachment;
 export type PlainString = string;
 export type PlainNumber = number;
 export type AnyValue = Value;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "shortcutkit",
-  "version": "0.7.0",
-  "description": "Build, validate and sign Apple Shortcuts files. Every built-in action typed, straight from the Shortcuts engine.",
+  "version": "1.0.0",
+  "description": "Build, validate, and sign Apple Shortcuts files from TypeScript. All 434 built-in actions and 1,449 Apple app actions typed, extracted from the Shortcuts engine.",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -24,7 +24,8 @@
     "demo": "bun run src/cli.ts demo",
     "extract": "./tools/extract-builtin-actions.sh",
     "diff-data": "python3 tools/diff-data.py",
-    "changelog": "python3 tools/diff-data.py --changelog"
+    "changelog": "python3 tools/diff-data.py --changelog",
+    "verify": "./test/verify/run.sh"
   },
   "devDependencies": {
     "@types/bun": "^1.4",
@@ -34,9 +35,12 @@
   "author": "frontboat",
   "repository": {
     "type": "git",
-    "url": "https://github.com/frontboat/shortcutkit"
+    "url": "git+https://github.com/frontboat/shortcutkit.git"
   },
   "homepage": "https://github.com/frontboat/shortcutkit#readme",
+  "bugs": {
+    "url": "https://github.com/frontboat/shortcutkit/issues"
+  },
   "keywords": [
     "apple",
     "apple-shortcuts",