@checkstack/common 0.11.0 → 0.12.0

package/CHANGELOG.md

@@ -1,5 +1,50 @@
 # @checkstack/common
 
+## 0.12.0
+
+### Minor Changes
+
+- 6d52276: feat(automation): expose `trigger.actor` so automations can filter on who/what caused an event
+
+  Every platform event now carries an **actor** - the user, application (API
+  client), service (backend-to-backend), or `system` (background /
+  unauthenticated) that caused it - and the automation engine surfaces it to
+  automations as `trigger.actor`. This lets a trigger filter gate on the
+  origin of the event it reacts to:
+
+  ```text
+  {{ trigger.actor.type == "system" }}      # auto-created by the platform
+  {{ trigger.actor.type == "user" }}         # a human
+  {{ trigger.actor.id == "app-deploybot" }}  # a specific application
+  ```
+
+  `trigger.actor` is available on **every** trigger - it is injected by the
+  platform, not declared per trigger - and editor autocomplete + Run Script
+  context types include `trigger.actor.{type,id,name}`.
+
+  How it works:
+
+  - **`@checkstack/common`** adds the canonical `Actor` type / `ActorSchema`
+    and `SYSTEM_ACTOR`.
+  - **`@checkstack/backend-api`** adds `resolveActor(user)` and a
+    `HookEventMeta` envelope. The hook listener / `onHook` signature gains an
+    optional second `meta` argument (additive, backward compatible).
+  - **`@checkstack/backend`** wraps emitted hooks in an envelope so the actor
+    travels with the payload through the distributed queue, unwrapping it
+    before delivery. The RPC emit path captures the authenticated caller;
+    background emits default to the system actor. Raw/legacy queue data is
+    treated as a system-actor payload, so delivery stays backward compatible.
+  - **`@checkstack/automation-backend`** threads the actor into the dispatch
+    scope (`trigger.actor`), available to trigger filters, top-level
+    conditions, and all run templates, and persisted in the run's scope
+    snapshot. Manual runs are attributed to the invoking user.
+  - **`@checkstack/automation-common`** / **`@checkstack/automation-frontend`**
+    expose `trigger.actor` in the editor variable scope and the generated
+    Run Script `context.trigger.actor` types.
+
+  No database migration and no per-trigger schema changes: the actor rides as
+  event-envelope metadata and in the run scope snapshot.
+
 ## 0.11.0
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@checkstack/common",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "license": "Elastic-2.0",
   "type": "module",
   "main": "./src/index.ts",
@@ -20,7 +20,7 @@
   "devDependencies": {
     "typescript": "^5.7.2",
     "@checkstack/tsconfig": "0.0.7",
-    "@checkstack/scripts": "0.3.2"
+    "@checkstack/scripts": "0.3.3"
   },
   "scripts": {
     "typecheck": "tsgo -b",

package/src/actor.ts

@@ -0,0 +1,39 @@
+import { z } from "zod";
+
+/**
+ * Who (or what) caused a platform event. Travels as event-envelope metadata
+ * on every emitted hook and is surfaced to automations as `trigger.actor`, so
+ * an automation can filter on the origin of the event it reacts to - e.g.
+ * "only incidents auto-created by the system" or "systems created by a
+ * specific application/API client".
+ *
+ * - `system`      - no authenticated caller (platform-internal / background /
+ *                   automatic events such as healthcheck or SLO triggers).
+ * - `user`        - a human user (session/token authenticated).
+ * - `application` - an external application authenticated via API key.
+ * - `service`     - a trusted backend-to-backend (plugin) call; `id` is the
+ *                   originating plugin id.
+ */
+export const ACTOR_TYPES = ["system", "user", "application", "service"] as const;
+
+export type ActorType = (typeof ACTOR_TYPES)[number];
+
+export const ActorSchema = z.object({
+  type: z.enum(ACTOR_TYPES),
+  /**
+   * Stable identifier for the actor: the user id, application id, originating
+   * plugin id for services, or the literal `"system"`.
+   */
+  id: z.string(),
+  /** Human-readable display name when known (absent for system/service). */
+  name: z.string().optional(),
+});
+
+export type Actor = z.infer<typeof ActorSchema>;
+
+/** Canonical actor for platform-internal / unauthenticated events. */
+export const SYSTEM_ACTOR: Actor = {
+  type: "system",
+  id: "system",
+  name: "System",
+};

package/src/index.ts

@@ -1,4 +1,5 @@
 export * from "./types";
+export * from "./actor";
 export * from "./pagination";
 export * from "./routes";
 export * from "./plugin-metadata";