@checkstack/automation-common 0.2.0

package/src/shell-env.ts

@@ -0,0 +1,33 @@
+/**
+ * Shared naming rule for the run-context environment variables exposed to
+ * `run_shell` script actions.
+ *
+ * Two sides depend on this and must never drift:
+ *
+ *   - the backend (`integration-script-backend`) injects `NAME=value`
+ *     pairs into the shell subprocess at run time, and
+ *   - the automation editor lists the available `NAME`s for `$`
+ *     autocomplete.
+ *
+ * Keeping the derivation here, in the package both reach, guarantees the
+ * names the editor suggests are exactly the ones the script receives.
+ */
+
+/** Prefix on every auto-injected run-context shell env var. */
+export const SHELL_ENV_PREFIX = "CHECKSTACK_";
+
+/**
+ * Derive the shell env-var name a scope path is exposed under.
+ *
+ * Rule: uppercase, collapse each run of non-alphanumeric characters to a
+ * single `_`, trim leading/trailing `_`, then prefix with `CHECKSTACK_`.
+ * So `trigger.payload.title` becomes `CHECKSTACK_TRIGGER_PAYLOAD_TITLE`
+ * and `artifact.jira.issue.key` becomes `CHECKSTACK_ARTIFACT_JIRA_ISSUE_KEY`.
+ */
+export function toShellEnvKey(path: string): string {
+  const normalized = path
+    .toUpperCase()
+    .replaceAll(/[^A-Z0-9]+/g, "_")
+    .replaceAll(/^_+|_+$/g, "");
+  return `${SHELL_ENV_PREFIX}${normalized}`;
+}

package/src/signals.ts

@@ -0,0 +1,58 @@
+import { createSignal } from "@checkstack/signal-common";
+import { z } from "zod";
+import { pluginMetadata } from "./plugin-metadata";
+import { RunStatusSchema, StepStatusSchema } from "./schemas";
+
+/**
+ * Fired when an automation definition is created, updated, or deleted.
+ * Frontends use this to invalidate caches.
+ */
+export const AUTOMATION_DEFINITION_CHANGED = createSignal({
+  pluginMetadata,
+  event: "automation_definition_changed",
+  payloadSchema: z.object({
+    action: z.enum(["created", "updated", "deleted"]),
+    automationId: z.string(),
+  }),
+});
+
+/**
+ * Fired when an automation run starts.
+ */
+export const AUTOMATION_RUN_STARTED = createSignal({
+  pluginMetadata,
+  event: "automation_run_started",
+  payloadSchema: z.object({
+    runId: z.string(),
+    automationId: z.string(),
+    triggerId: z.string(),
+  }),
+});
+
+/**
+ * Fired when a run transitions to a terminal state.
+ */
+export const AUTOMATION_RUN_COMPLETED = createSignal({
+  pluginMetadata,
+  event: "automation_run_completed",
+  payloadSchema: z.object({
+    runId: z.string(),
+    automationId: z.string(),
+    status: RunStatusSchema,
+    errorMessage: z.string().optional(),
+  }),
+});
+
+/**
+ * Fired when a single action step completes — useful for the run-detail
+ * page to refresh step status live.
+ */
+export const AUTOMATION_RUN_STEP_COMPLETED = createSignal({
+  pluginMetadata,
+  event: "automation_run_step_completed",
+  payloadSchema: z.object({
+    runId: z.string(),
+    stepId: z.string(),
+    status: StepStatusSchema,
+  }),
+});