@camstack/types 1.2.429 → 1.2.431

package/dist/capabilities/actions.cap.d.ts

@@ -0,0 +1,459 @@
+import { z } from 'zod';
+import { type InferProvider } from './capability-definition.js';
+export declare const ActionLinksSchema: z.ZodObject<{
+    deviceId: z.ZodNumber;
+    actionIds: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+export type ActionLinks = z.infer<typeof ActionLinksSchema>;
+export declare const actionsCapability: {
+    readonly name: 'actions';
+    readonly scope: 'system';
+    readonly mode: 'singleton';
+    readonly methods: {
+        /** Every action, live from the providers, with its run status. Admin. */
+        readonly list: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{}, z.core.$strip>, z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            name: z.ZodString;
+            addonId: z.ZodString;
+            source: z.ZodEnum<{
+                addon: "addon";
+                internal: "internal";
+            }>;
+            readOnly: z.ZodBoolean;
+            steps: z.ZodOptional<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+                kind: z.ZodLiteral<"wait">;
+                seconds: z.ZodNumber;
+            }, z.core.$strip>, z.ZodObject<{
+                kind: z.ZodLiteral<"cap">;
+                deviceId: z.ZodUnion<readonly [z.ZodNumber, z.ZodArray<z.ZodNumber>, z.ZodObject<{
+                    $var: z.ZodString;
+                }, z.core.$strip>]>;
+                cap: z.ZodString;
+                method: z.ZodString;
+                args: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+            }, z.core.$strip>], "kind">>>;
+            variables: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                name: z.ZodString;
+                label: z.ZodOptional<z.ZodString>;
+                type: z.ZodEnum<{
+                    boolean: "boolean";
+                    number: "number";
+                    select: "select";
+                    string: "string";
+                }>;
+                required: z.ZodOptional<z.ZodBoolean>;
+                default: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
+                options: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            }, z.core.$strip>>>;
+            status: z.ZodObject<{
+                isRunning: z.ZodBoolean;
+                lastRunAt: z.ZodNullable<z.ZodNumber>;
+                lastError: z.ZodNullable<z.ZodString>;
+            }, z.core.$strip>;
+        }, z.core.$strip>>, import("./capability-definition.js").CapabilityMethodKind>;
+        /**
+         * One action. A non-admin names the camera (`deviceId`) that links it.
+         * `null` when it does not exist.
+         */
+        readonly get: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
+            actionId: z.ZodString;
+            deviceId: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>, z.ZodObject<{
+            action: z.ZodNullable<z.ZodObject<{
+                id: z.ZodString;
+                name: z.ZodString;
+                addonId: z.ZodString;
+                source: z.ZodEnum<{
+                    addon: "addon";
+                    internal: "internal";
+                }>;
+                readOnly: z.ZodBoolean;
+                steps: z.ZodOptional<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+                    kind: z.ZodLiteral<"wait">;
+                    seconds: z.ZodNumber;
+                }, z.core.$strip>, z.ZodObject<{
+                    kind: z.ZodLiteral<"cap">;
+                    deviceId: z.ZodUnion<readonly [z.ZodNumber, z.ZodArray<z.ZodNumber>, z.ZodObject<{
+                        $var: z.ZodString;
+                    }, z.core.$strip>]>;
+                    cap: z.ZodString;
+                    method: z.ZodString;
+                    args: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                }, z.core.$strip>], "kind">>>;
+                variables: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                    name: z.ZodString;
+                    label: z.ZodOptional<z.ZodString>;
+                    type: z.ZodEnum<{
+                        boolean: "boolean";
+                        number: "number";
+                        select: "select";
+                        string: "string";
+                    }>;
+                    required: z.ZodOptional<z.ZodBoolean>;
+                    default: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
+                    options: z.ZodOptional<z.ZodArray<z.ZodString>>;
+                }, z.core.$strip>>>;
+                status: z.ZodObject<{
+                    isRunning: z.ZodBoolean;
+                    lastRunAt: z.ZodNullable<z.ZodNumber>;
+                    lastError: z.ZodNullable<z.ZodString>;
+                }, z.core.$strip>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>, "query"> & {
+            readonly caller: 'required';
+        };
+        /**
+         * Start an action. `wait` holds the call until the run ended (an automation
+         * step does); without it the call returns `started`. A non-admin names the
+         * camera (`deviceId`) that links the action.
+         */
+        readonly run: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
+            actionId: z.ZodString;
+            variables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>>;
+            wait: z.ZodOptional<z.ZodBoolean>;
+            origin: z.ZodOptional<z.ZodObject<{
+                blockId: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>>;
+            deviceId: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>, z.ZodObject<{
+            runId: z.ZodString;
+            outcome: z.ZodUnion<readonly [z.ZodEnum<{
+                aborted: "aborted";
+                failed: "failed";
+                ran: "ran";
+                "skipped-conditions": "skipped-conditions";
+                "skipped-cooldown": "skipped-cooldown";
+                "skipped-overlap": "skipped-overlap";
+                "skipped-trigger": "skipped-trigger";
+            }>, z.ZodLiteral<"started">]>;
+            message: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>, "mutation"> & {
+            readonly caller: 'required';
+        };
+        readonly stop: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
+            actionId: z.ZodString;
+        }, z.core.$strip>, z.ZodVoid, "mutation">;
+        readonly getTraces: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
+            actionId: z.ZodString;
+        }, z.core.$strip>, z.ZodObject<{
+            traces: z.ZodArray<z.ZodObject<{
+                runId: z.ZodString;
+                startedAt: z.ZodNumber;
+                endedAt: z.ZodNumber;
+                trigger: z.ZodObject<{
+                    kind: z.ZodString;
+                    outcome: z.ZodEnum<{
+                        fail: "fail";
+                        pass: "pass";
+                    }>;
+                    reason: z.ZodString;
+                    vars: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>]>>;
+                }, z.core.$strip>;
+                conditions: z.ZodArray<z.ZodObject<{
+                    path: z.ZodString;
+                    kind: z.ZodEnum<{
+                        all: "all";
+                        any: "any";
+                        condition: "condition";
+                        expression: "expression";
+                        not: "not";
+                    }>;
+                    outcome: z.ZodEnum<{
+                        fail: "fail";
+                        "not-evaluated": "not-evaluated";
+                        pass: "pass";
+                    }>;
+                    reason: z.ZodString;
+                    deviceId: z.ZodOptional<z.ZodNumber>;
+                    cap: z.ZodOptional<z.ZodString>;
+                    fieldPath: z.ZodOptional<z.ZodString>;
+                    operator: z.ZodOptional<z.ZodString>;
+                    expected: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>]>>;
+                    observed: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>]>>;
+                }, z.core.$strip>>;
+                verdict: z.ZodOptional<z.ZodObject<{
+                    mode: z.ZodDiscriminatedUnion<[z.ZodObject<{
+                        mode: z.ZodLiteral<"single">;
+                    }, z.core.$strip>, z.ZodObject<{
+                        mode: z.ZodLiteral<"restart">;
+                    }, z.core.$strip>, z.ZodObject<{
+                        mode: z.ZodLiteral<"queued">;
+                        max: z.ZodNumber;
+                    }, z.core.$strip>, z.ZodObject<{
+                        mode: z.ZodLiteral<"parallel">;
+                        max: z.ZodNumber;
+                    }, z.core.$strip>, z.ZodObject<{
+                        mode: z.ZodLiteral<"cooldown">;
+                        minutes: z.ZodNumber;
+                    }, z.core.$strip>], "mode">;
+                    decision: z.ZodEnum<{
+                        bypass: "bypass";
+                        cooldown: "cooldown";
+                        drop: "drop";
+                        queued: "queued";
+                        restart: "restart";
+                        run: "run";
+                    }>;
+                    reason: z.ZodString;
+                }, z.core.$strip>>;
+                steps: z.ZodArray<z.ZodObject<{
+                    path: z.ZodString;
+                    kind: z.ZodString;
+                    cap: z.ZodOptional<z.ZodString>;
+                    method: z.ZodOptional<z.ZodString>;
+                    deviceId: z.ZodOptional<z.ZodNumber>;
+                    startedAt: z.ZodOptional<z.ZodNumber>;
+                    endedAt: z.ZodOptional<z.ZodNumber>;
+                    outcome: z.ZodEnum<{
+                        error: "error";
+                        "not-run": "not-run";
+                        ok: "ok";
+                    }>;
+                    message: z.ZodOptional<z.ZodString>;
+                }, z.core.$strip>>;
+                outcome: z.ZodEnum<{
+                    aborted: "aborted";
+                    failed: "failed";
+                    ran: "ran";
+                    "skipped-conditions": "skipped-conditions";
+                    "skipped-cooldown": "skipped-cooldown";
+                    "skipped-overlap": "skipped-overlap";
+                    "skipped-trigger": "skipped-trigger";
+                }>;
+                repeat: z.ZodNumber;
+                lastAt: z.ZodNumber;
+            }, z.core.$strip>>;
+        }, z.core.$strip>, import("./capability-definition.js").CapabilityMethodKind>;
+        /** Internal actions only. A read-only (addon) entry is refused with `[read-only]`. */
+        readonly create: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
+            action: z.ZodObject<{
+                name: z.ZodString;
+                steps: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+                    kind: z.ZodLiteral<"wait">;
+                    seconds: z.ZodNumber;
+                }, z.core.$strip>, z.ZodObject<{
+                    kind: z.ZodLiteral<"cap">;
+                    deviceId: z.ZodUnion<readonly [z.ZodNumber, z.ZodArray<z.ZodNumber>, z.ZodObject<{
+                        $var: z.ZodString;
+                    }, z.core.$strip>]>;
+                    cap: z.ZodString;
+                    method: z.ZodString;
+                    args: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                }, z.core.$strip>], "kind">>;
+                variables: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                    name: z.ZodString;
+                    label: z.ZodOptional<z.ZodString>;
+                    type: z.ZodEnum<{
+                        boolean: "boolean";
+                        number: "number";
+                        select: "select";
+                        string: "string";
+                    }>;
+                    required: z.ZodOptional<z.ZodBoolean>;
+                    default: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
+                    options: z.ZodOptional<z.ZodArray<z.ZodString>>;
+                }, z.core.$strip>>>;
+            }, z.core.$strip>;
+        }, z.core.$strip>, z.ZodObject<{
+            action: z.ZodObject<{
+                id: z.ZodString;
+                name: z.ZodString;
+                addonId: z.ZodString;
+                source: z.ZodEnum<{
+                    addon: "addon";
+                    internal: "internal";
+                }>;
+                readOnly: z.ZodBoolean;
+                steps: z.ZodOptional<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+                    kind: z.ZodLiteral<"wait">;
+                    seconds: z.ZodNumber;
+                }, z.core.$strip>, z.ZodObject<{
+                    kind: z.ZodLiteral<"cap">;
+                    deviceId: z.ZodUnion<readonly [z.ZodNumber, z.ZodArray<z.ZodNumber>, z.ZodObject<{
+                        $var: z.ZodString;
+                    }, z.core.$strip>]>;
+                    cap: z.ZodString;
+                    method: z.ZodString;
+                    args: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                }, z.core.$strip>], "kind">>>;
+                variables: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                    name: z.ZodString;
+                    label: z.ZodOptional<z.ZodString>;
+                    type: z.ZodEnum<{
+                        boolean: "boolean";
+                        number: "number";
+                        select: "select";
+                        string: "string";
+                    }>;
+                    required: z.ZodOptional<z.ZodBoolean>;
+                    default: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
+                    options: z.ZodOptional<z.ZodArray<z.ZodString>>;
+                }, z.core.$strip>>>;
+                status: z.ZodObject<{
+                    isRunning: z.ZodBoolean;
+                    lastRunAt: z.ZodNullable<z.ZodNumber>;
+                    lastError: z.ZodNullable<z.ZodString>;
+                }, z.core.$strip>;
+            }, z.core.$strip>;
+        }, z.core.$strip>, "mutation">;
+        readonly update: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
+            actionId: z.ZodString;
+            action: z.ZodObject<{
+                name: z.ZodOptional<z.ZodString>;
+                steps: z.ZodOptional<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+                    kind: z.ZodLiteral<"wait">;
+                    seconds: z.ZodNumber;
+                }, z.core.$strip>, z.ZodObject<{
+                    kind: z.ZodLiteral<"cap">;
+                    deviceId: z.ZodUnion<readonly [z.ZodNumber, z.ZodArray<z.ZodNumber>, z.ZodObject<{
+                        $var: z.ZodString;
+                    }, z.core.$strip>]>;
+                    cap: z.ZodString;
+                    method: z.ZodString;
+                    args: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                }, z.core.$strip>], "kind">>>;
+                variables: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodObject<{
+                    name: z.ZodString;
+                    label: z.ZodOptional<z.ZodString>;
+                    type: z.ZodEnum<{
+                        boolean: "boolean";
+                        number: "number";
+                        select: "select";
+                        string: "string";
+                    }>;
+                    required: z.ZodOptional<z.ZodBoolean>;
+                    default: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
+                    options: z.ZodOptional<z.ZodArray<z.ZodString>>;
+                }, z.core.$strip>>>>;
+            }, z.core.$strip>;
+        }, z.core.$strip>, z.ZodObject<{
+            action: z.ZodObject<{
+                id: z.ZodString;
+                name: z.ZodString;
+                addonId: z.ZodString;
+                source: z.ZodEnum<{
+                    addon: "addon";
+                    internal: "internal";
+                }>;
+                readOnly: z.ZodBoolean;
+                steps: z.ZodOptional<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+                    kind: z.ZodLiteral<"wait">;
+                    seconds: z.ZodNumber;
+                }, z.core.$strip>, z.ZodObject<{
+                    kind: z.ZodLiteral<"cap">;
+                    deviceId: z.ZodUnion<readonly [z.ZodNumber, z.ZodArray<z.ZodNumber>, z.ZodObject<{
+                        $var: z.ZodString;
+                    }, z.core.$strip>]>;
+                    cap: z.ZodString;
+                    method: z.ZodString;
+                    args: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                }, z.core.$strip>], "kind">>>;
+                variables: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                    name: z.ZodString;
+                    label: z.ZodOptional<z.ZodString>;
+                    type: z.ZodEnum<{
+                        boolean: "boolean";
+                        number: "number";
+                        select: "select";
+                        string: "string";
+                    }>;
+                    required: z.ZodOptional<z.ZodBoolean>;
+                    default: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
+                    options: z.ZodOptional<z.ZodArray<z.ZodString>>;
+                }, z.core.$strip>>>;
+                status: z.ZodObject<{
+                    isRunning: z.ZodBoolean;
+                    lastRunAt: z.ZodNullable<z.ZodNumber>;
+                    lastError: z.ZodNullable<z.ZodString>;
+                }, z.core.$strip>;
+            }, z.core.$strip>;
+        }, z.core.$strip>, "mutation">;
+        readonly delete: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
+            actionId: z.ZodString;
+        }, z.core.$strip>, z.ZodVoid, "mutation">;
+        /**
+         * What a viewer sees under a camera: the actions this camera LINKS, with
+         * their variables, and only when the caller may see the camera. The scope
+         * gate admits the camera; the answer is cut to the linked ones.
+         */
+        readonly listForCamera: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
+            deviceId: z.ZodNumber;
+        }, z.core.$strip>, z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            name: z.ZodString;
+            addonId: z.ZodString;
+            source: z.ZodEnum<{
+                addon: "addon";
+                internal: "internal";
+            }>;
+            readOnly: z.ZodBoolean;
+            steps: z.ZodOptional<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+                kind: z.ZodLiteral<"wait">;
+                seconds: z.ZodNumber;
+            }, z.core.$strip>, z.ZodObject<{
+                kind: z.ZodLiteral<"cap">;
+                deviceId: z.ZodUnion<readonly [z.ZodNumber, z.ZodArray<z.ZodNumber>, z.ZodObject<{
+                    $var: z.ZodString;
+                }, z.core.$strip>]>;
+                cap: z.ZodString;
+                method: z.ZodString;
+                args: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+            }, z.core.$strip>], "kind">>>;
+            variables: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                name: z.ZodString;
+                label: z.ZodOptional<z.ZodString>;
+                type: z.ZodEnum<{
+                    boolean: "boolean";
+                    number: "number";
+                    select: "select";
+                    string: "string";
+                }>;
+                required: z.ZodOptional<z.ZodBoolean>;
+                default: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
+                options: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            }, z.core.$strip>>>;
+            status: z.ZodObject<{
+                isRunning: z.ZodBoolean;
+                lastRunAt: z.ZodNullable<z.ZodNumber>;
+                lastError: z.ZodNullable<z.ZodString>;
+            }, z.core.$strip>;
+        }, z.core.$strip>>, "query">;
+        /** The actions a camera links. Admin (the picker). */
+        readonly getLinks: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
+            deviceId: z.ZodNumber;
+        }, z.core.$strip>, z.ZodObject<{
+            deviceId: z.ZodNumber;
+            actionIds: z.ZodArray<z.ZodString>;
+        }, z.core.$strip>, import("./capability-definition.js").CapabilityMethodKind>;
+        /** Replace a camera's linked actions with what the operator picked. */
+        readonly setLinks: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
+            deviceId: z.ZodNumber;
+            actionIds: z.ZodArray<z.ZodString>;
+        }, z.core.$strip>, z.ZodObject<{
+            deviceId: z.ZodNumber;
+            actionIds: z.ZodArray<z.ZodString>;
+        }, z.core.$strip>, "mutation">;
+    };
+    readonly events: {
+        /** A run started or ended. Telemetry (D8): `list` is the authority. */
+        readonly onRunChanged: {
+            readonly data: z.ZodObject<{
+                actionId: z.ZodString;
+                runId: z.ZodString;
+                isRunning: z.ZodBoolean;
+                outcome: z.ZodOptional<z.ZodEnum<{
+                    aborted: "aborted";
+                    failed: "failed";
+                    ran: "ran";
+                    "skipped-conditions": "skipped-conditions";
+                    "skipped-cooldown": "skipped-cooldown";
+                    "skipped-overlap": "skipped-overlap";
+                    "skipped-trigger": "skipped-trigger";
+                }>>;
+                lastRunAt: z.ZodNullable<z.ZodNumber>;
+                lastError: z.ZodNullable<z.ZodString>;
+            }, z.core.$strip>;
+        };
+    };
+};
+export type IActionsProvider = InferProvider<typeof actionsCapability>;