shortcutkit 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,92 @@
+import { type PlistValue } from "./plist.js";
+import type { ActionId, MetaParams, ParamTypes } from "./generated/actions.js";
+import type { Attachment, Picker, TokenString, Value } from "./values.js";
+export { actions, ACTIONS, type ActionId, type ActionKey, type ParamKey, type ParamTypes, type MetaParams } from "./generated/actions.js";
+export type { PlistValue } from "./plist.js";
+export type * from "./values.js";
+export { getDefinition, allDefinitions, type ActionDefinition, type ParameterDefinition, type Localized } from "./definitions.js";
+export { provenance, type Provenance } from "./provenance.js";
+/** Parameters accepted for an identifier: typed per key for built-in actions, open for anything else. */
+export type ParamsFor<I extends string> = I extends ActionId ? Partial<ParamTypes[I] & MetaParams> : Record<string, Value>;
+export type Action = {
+    WFWorkflowActionIdentifier: string;
+    WFWorkflowActionParameters: Record<string, Value>;
+    outputName?: string;
+};
+/** WFWorkflowIcon.backgroundColorValue for palette colors 0-14, unsigned as the plist stores it. */
+export declare const ICON_COLORS: {
+    readonly Red: 4282601983;
+    readonly DarkOrange: 4251333119;
+    readonly Orange: 4271458815;
+    readonly Yellow: 4274264319;
+    readonly Green: 4292093695;
+    readonly Teal: 431817727;
+    readonly LightBlue: 1440408063;
+    readonly Blue: 463140863;
+    readonly DarkBlue: 946986751;
+    readonly Violet: 2071128575;
+    readonly Purple: 3679049983;
+    readonly Pink: 3980825855;
+    readonly Taupe: 255;
+    readonly Gray: 3031607807;
+    readonly DarkGray: 2846468607;
+};
+export type IconColor = keyof typeof ICON_COLORS;
+export declare const DEFAULT_GLYPH = 61440;
+/** Legacy WFCondition codes. Marked (v) = verified on this Mac or in Apple's gallery; others follow community docs. */
+export declare const CONDITION: {
+    readonly less_than: 0;
+    readonly less_or_equal: 1;
+    readonly greater_than: 2;
+    readonly greater_or_equal: 3;
+    readonly is: 4;
+    readonly is_not: 5;
+    readonly begins_with: 8;
+    readonly ends_with: 9;
+    readonly contains: 99;
+    readonly has_any_value: 100;
+    readonly has_no_value: 101;
+    readonly does_not_contain: 999;
+    readonly is_between: 1003;
+};
+export type Condition = keyof typeof CONDITION;
+/** Reference another action's output. */
+export declare const ref: (action: Action, outputName?: string) => Attachment;
+export declare const variable: (name: string) => Attachment;
+export declare const shortcutInput: () => Attachment;
+export declare const clipboard: () => Attachment;
+export declare const currentDate: () => Attachment;
+export declare const ask: (prompt?: string) => Attachment;
+/** Wrap an attachment for WFVariablePickerParameter keys (Repeat with Each, If). */
+export declare const picker: (a: Attachment) => Picker;
+/** A WFTextTokenString: strings and attachments interleaved; each attachment becomes U+FFFC. */
+export declare function text(...parts: Array<string | number | Attachment>): TokenString;
+export interface ShortcutOptions {
+    color?: IconColor | number;
+    glyph?: number;
+    inputClasses?: string[];
+}
+export declare class Shortcut {
+    readonly name: string;
+    readonly actions: Action[];
+    private readonly color;
+    private readonly glyph;
+    private readonly inputClasses;
+    constructor(name: string, options?: ShortcutOptions);
+    /**
+     * Append an action. With an identifier from `actions`, parameter keys are checked at compile
+     * time; any identifier is also validated at run time against the bundled definitions.
+     */
+    action<I extends string>(identifier: I, params?: ParamsFor<I>): Action;
+    if(subject: Attachment, condition: Condition | number, value?: string | number): string;
+    otherwise(gid: string): void;
+    endIf(gid: string): void;
+    repeatEach(items: Attachment): string;
+    endRepeatEach(gid: string): void;
+    toPlist(): Record<string, PlistValue>;
+    toXml(): string;
+    /** Write the unsigned file. Shortcuts names an import after the file, so the default is "<name>.shortcut". Converts to binary plist via plutil when present. */
+    write(path?: string): Promise<string>;
+    /** Sign with the macOS `shortcuts` command so Shortcuts will import the file. */
+    static sign(input: string, output: string, mode?: "anyone" | "people-who-know-me"): string;
+}