create-safest-tools 0.2.0

package/template/console/workflows/templates.ts

@@ -0,0 +1,70 @@
+import type { JsonObject, WorkflowGraph, WorkflowNodeKind, WorkflowPurpose } from "./types";
+
+function node(id: string, kind: WorkflowNodeKind, name: string, x: number, y: number, config: JsonObject = {}, inputMapping: JsonObject = {}) {
+  return { id, kind, name, input_mapping: inputMapping, config, metadata: { x, y } };
+}
+
+function edge(id: string, from: string, fromPort: string, to: string, toPort = "input") {
+  return { id, from: { node_id: from, port: fromPort }, to: { node_id: to, port: toPort } };
+}
+
+export type WorkflowTemplate = "human" | "phishing" | "blank";
+
+export const workflowTemplateOptions: Array<{ value: WorkflowTemplate; name: string; detail: string }> = [
+  { value: "human", name: "Human review", detail: "A clear review and decision path. Best for a first workflow." },
+  { value: "phishing", name: "Phishing triage", detail: "Parallel evidence checks followed by required human review." },
+  { value: "blank", name: "Blank", detail: "Only a start and end step. Build the path yourself." },
+];
+
+export function workflowTemplate(template: WorkflowTemplate, purpose: WorkflowPurpose): WorkflowGraph {
+  const base = {
+    schema_version: "1" as const,
+    purpose,
+    entry_node_id: "start",
+    input_schema: { type: "object" },
+    terminal_codes: ["resolved"],
+    default_policies: {},
+  };
+  if (template === "blank") return {
+    ...base,
+    nodes: [node("start", "start", "Report accepted", 40, 220), node("end", "end", "Resolved", 520, 220, { terminal_code: "resolved" })],
+    edges: [edge("edge-start-end", "start", "success", "end")],
+  };
+  if (template === "phishing") return {
+    ...base,
+    nodes: [
+      node("start", "start", "Report accepted", 30, 260),
+      node("url-check", "enrichment", "Phishing URL specialist", 270, 40, { component_version_id: "select-a-published-component-version" }, { url: "report.answers.url" }),
+      node("account-check", "enrichment", "Account history", 270, 260, { component_version_id: "select-a-published-component-version" }, { account: "report.target.reference" }),
+      node("related-check", "enrichment", "Related reports", 270, 480, { component_version_id: "select-a-published-component-version" }, { target: "report.target.reference" }),
+      node("join", "join", "Evidence ready", 520, 260, { required_ports: ["url", "account"], optional_ports: ["related"] }),
+      node("review", "human_task", "Human review", 760, 90, { queue_id: "select-a-queue", response_schema: { type: "object" } }),
+      node("decision", "decision", "Record decision", 760, 260, { policy_version_id: "select-a-policy-version" }, { decision_code: "reviewed", policy_code: "manual-review", rationale: "Recorded after review.", evidence_references: [], finding_ids: [] }),
+      node("end", "end", "Resolved", 1000, 260, { terminal_code: "resolved" }),
+    ],
+    edges: [
+      edge("e1", "start", "success", "url-check"), edge("e2", "start", "success", "account-check"), edge("e3", "start", "success", "related-check"),
+      edge("e4", "url-check", "success", "join", "url"), edge("e5", "account-check", "success", "join", "account"), edge("e6", "related-check", "success", "join", "related"),
+      edge("e7", "join", "success", "review"), edge("e8", "review", "completed", "decision"), edge("e9", "review", "timeout", "decision"), edge("e10", "decision", "recorded", "end"), edge("e11", "decision", "error", "end"),
+    ],
+  };
+  return {
+    ...base,
+    nodes: [
+      node("start", "start", "Report accepted", 40, 220),
+      node("review", "human_task", "Human review", 280, 220, { queue_id: "general-review", response_schema: { type: "object" } }),
+      node("decision", "decision", "Record decision", 520, 220, { policy_version_id: "policy-v1" }, { decision_code: "reviewed", policy_code: "manual-review", rationale: "Recorded after the required human review step.", evidence_references: [], finding_ids: [] }),
+      node("end", "end", "Resolved", 760, 220, { terminal_code: "resolved" }),
+    ],
+    edges: [edge("e1", "start", "success", "review"), edge("e2", "review", "completed", "decision"), edge("e3", "review", "timeout", "decision"), edge("e4", "decision", "recorded", "end"), edge("e5", "decision", "error", "end")],
+  };
+}
+
+export const happyPathFixture = {
+  name: "Happy path",
+  input: {},
+  component_results: {},
+  human_responses: { review: { outcome: "reviewed" } },
+  expected: { status: "passed", terminal_code: "resolved" },
+  failure_injection: {},
+};

package/template/console/workflows/types.ts

@@ -0,0 +1,201 @@
+export type JsonPrimitive = string | number | boolean | null;
+export type JsonValue = JsonPrimitive | JsonValue[] | JsonObject;
+export interface JsonObject { [key: string]: JsonValue }
+
+export type WorkflowPurpose = "report" | "appeal" | "quality" | "operations";
+export type WorkflowAuthorityMode = "off" | "shadow" | "assist" | "bounded_auto";
+export type WorkflowNodeKind =
+  | "start"
+  | "enrichment"
+  | "parallel_group"
+  | "join"
+  | "condition"
+  | "ai_proposal"
+  | "human_task"
+  | "send_message"
+  | "wait_for_event"
+  | "delay"
+  | "delay_until"
+  | "decision"
+  | "action"
+  | "handoff"
+  | "start_linked_workflow"
+  | "end";
+
+export interface WorkflowNode {
+  id: string;
+  kind: WorkflowNodeKind;
+  name: string;
+  description?: string;
+  input_mapping: JsonObject;
+  timeout_policy?: JsonObject;
+  retry_policy?: JsonObject;
+  error_port?: string;
+  config: JsonObject;
+  metadata?: { x?: number; y?: number; group_id?: string };
+}
+
+export interface WorkflowEdge {
+  id: string;
+  from: { node_id: string; port: string };
+  to: { node_id: string; port: string };
+  label?: string;
+}
+
+export interface WorkflowGraph {
+  schema_version: "1";
+  purpose: WorkflowPurpose;
+  entry_node_id: string;
+  nodes: WorkflowNode[];
+  edges: WorkflowEdge[];
+  input_schema: JsonObject;
+  terminal_codes: string[];
+  default_policies: JsonObject;
+}
+
+export interface WorkflowValidationIssue {
+  code: string;
+  message: string;
+  path?: string;
+  nodeId?: string;
+  edgeId?: string;
+}
+
+export interface WorkflowValidation {
+  valid: boolean;
+  errors: WorkflowValidationIssue[];
+  warnings: WorkflowValidationIssue[];
+  estimatedMaximumSteps?: number;
+}
+
+export interface WorkflowDraftSummary {
+  id: string;
+  revision: number;
+  validationStatus: string;
+  validation: WorkflowValidation;
+}
+
+export interface WorkflowDraft extends WorkflowDraftSummary {
+  graphDigest: string;
+  graph: WorkflowGraph;
+  updatedAt: string;
+}
+
+export interface WorkflowVersionSummary {
+  id: string;
+  version: number;
+  authorityMode: WorkflowAuthorityMode;
+  publishedAt: string;
+  graphDigest?: string;
+  bundleDigest?: string;
+  retiredAt?: string | null;
+}
+
+export interface WorkflowFixture {
+  id: string;
+  name: string;
+  input: JsonObject;
+  expected: JsonObject;
+  failureInjection: JsonObject;
+  updatedAt: string;
+}
+
+export interface WorkflowSummary {
+  id: string;
+  key: string;
+  name: string;
+  description: string;
+  purpose: WorkflowPurpose;
+  status: string;
+  activeVersionId: string | null;
+  createdBy: string;
+  createdAt: string;
+  updatedAt: string;
+  draft: WorkflowDraftSummary | null;
+  activeVersion: WorkflowVersionSummary | null;
+  activePinCount: number;
+}
+
+export interface WorkflowDetail extends Omit<WorkflowSummary, "draft"> {
+  draft: WorkflowDraft | null;
+  versions: WorkflowVersionSummary[];
+  fixtures: WorkflowFixture[];
+}
+
+export interface WorkflowListResponse {
+  workflows: WorkflowSummary[];
+}
+
+export interface WorkflowResponse {
+  workflow: WorkflowDetail;
+}
+
+export interface WorkflowVersionResponse {
+  version: WorkflowVersionSummary & { graph: WorkflowGraph };
+}
+
+export interface WorkflowCreateResponse {
+  workflowId: string;
+  draftId: string;
+  revision: number;
+}
+
+export interface WorkflowSaveResponse {
+  draftId: string;
+  revision: number;
+  graphDigest: string;
+  validation: WorkflowValidation;
+}
+
+export interface WorkflowValidationResponse {
+  revision: number;
+  graphDigest: string;
+  validation: WorkflowValidation;
+}
+
+export interface WorkflowTestStep {
+  nodeId?: string;
+  node_id?: string;
+  state?: string;
+}
+
+export interface WorkflowTestResponse {
+  testRunId: string;
+  status: "passed" | "failed";
+  graphDigest: string;
+  result?: {
+    terminalCode?: string;
+    terminal_code?: string;
+    steps?: WorkflowTestStep[];
+  };
+}
+
+export interface WorkflowPublishResponse {
+  workflowId: string;
+  versionId: string;
+  version: number;
+  artifactId: string;
+  bundleDigest: string;
+}
+
+export interface QueueListItem {
+  id: string;
+  name: string;
+  status: string;
+}
+
+export interface QueueListResponse {
+  queues: QueueListItem[];
+}
+
+export interface WorkflowPinResponse {
+  pinId: string;
+  workflowVersionId: string;
+  mode: "primary" | "shadow";
+}
+
+export type StudioConsoleState =
+  | { kind: "message"; heading: string; detail: string }
+  | { kind: "validation"; heading: string; validation: WorkflowValidation }
+  | { kind: "test"; fixtureName: string; result: WorkflowTestResponse }
+  | { kind: "pin"; heading: string; detail: string };

package/template/gitignore.template

@@ -0,0 +1,18 @@
+node_modules/
+.wrangler/
+coverage/
+dist/
+.dev.vars
+.safest/secrets.env
+backups/
+exports/
+*.log
+.DS_Store
+.env
+.env.*
+!.env.example
+.safest/
+dogfood-output/
+test-zone/dogfood-output/
+test-results/
+playwright-report/