@boardwalk-labs/workflow 0.1.4 → 0.1.5

package/README.md

@@ -6,7 +6,8 @@ Author **Boardwalk workflows** in plain TypeScript — agent loops, schedules, d
 import { agent, output, secrets, type WorkflowMeta } from "@boardwalk-labs/workflow";
 
 export const meta = {
-  name: "morning-digest",
+  slug: "morning-digest",
+  title: "Morning Digest",
   description: "Summarize my open issues every weekday at 9am",
   triggers: [{ kind: "cron", expr: "0 9 * * 1-5" }],
   permissions: { secrets: [{ name: "GITHUB_TOKEN" }] },
@@ -35,7 +36,7 @@ A workflow is **a script**: the `meta` export is a **pure literal** (engines der
 
 - **`agent(prompt, opts?)`** — run an agent loop and get its final text (or `schema`-validated JSON). `model` is optional: name one explicitly, or let the engine resolve it. Loops can use **tools** (built-in or program-defined), **MCP servers**, **skills**, and **memory** — each brought **per call** on `agent()`; the manifest declares none of them.
 - **`sleep(ms | { until })`** — durable wait; the run holds, locals survive.
-- **`workflows.call(name, input)`** — durably invoke another workflow and await its result; idempotent across restarts. `workflows.run` is the fire-and-forget sibling.
+- **`workflows.call(slug, input)`** — durably invoke another workflow by its slug and await its result; idempotent across restarts. `workflows.run` is the fire-and-forget sibling.
 - **`secrets.get(name)`** — read a secret declared in `permissions.secrets`. Resolved from your `.env` locally, from the encrypted vault on hosted Boardwalk. Secret values never reach model context — the SDK contract requires engines to redact them.
 - **`output(value)`** — declare the run's result.
 - **Memory = a persistent directory, per agent.** `agent(prompt, { memory: "memory/triager" })` names any workspace-relative directory; the engine auto-persists it across runs — no declaration needed. The loop gets read/write file tools scoped to it, and your code can read and write the same files. (`workspace.persist` is the separate knob for non-memory state your program manages directly.)

package/dist/manifest.d.ts

@@ -1,6 +1,7 @@
 import { z } from "zod";
 export declare const workflowManifestSchema: z.ZodObject<{
-    name: z.ZodString;
+    slug: z.ZodString;
+    title: z.ZodOptional<z.ZodString>;
     description: z.ZodOptional<z.ZodString>;
     triggers: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
         kind: z.ZodLiteral<"cron">;

package/dist/manifest.js

@@ -12,12 +12,21 @@ import { z } from "zod";
 // ============================================================================
 // Shared scalars
 // ============================================================================
-const NAME_RE = /^[a-zA-Z0-9-]+$/;
-const workflowName = z
+const SLUG_RE = /^[a-zA-Z0-9-]+$/;
+/** The workflow's identity: a URL-safe slug, stable across the program's life (referenced by the
+ *  CLI, `workflows.call`, and the API). The human-readable label is `title`, not this. */
+const workflowSlug = z
     .string()
     .min(1)
     .max(100)
-    .regex(NAME_RE, "name must be alphanumeric with hyphens");
+    .regex(SLUG_RE, "slug must be alphanumeric with hyphens");
+/** The workflow's display label — free text, author-controlled. Falls back to a title-cased slug
+ *  in UIs when omitted. One line only. */
+const workflowTitle = z
+    .string()
+    .min(1)
+    .max(200)
+    .refine((s) => !s.includes("\n"), "title must be a single line");
 /** A short identifier (tool/MCP/skill/secret names). */
 const shortName = z.string().min(1).max(120);
 /** Loosely-typed JSON Schema objects (input_schema / output_schema / tool inputSchema). */
@@ -153,7 +162,7 @@ const permissionsSchema = z.strictObject({
 });
 const callableBySchema = z.union([
     z.strictObject({ roles: z.array(z.enum(["owner", "admin", "member", "viewer"])).min(1) }),
-    z.strictObject({ workflows: z.array(workflowName).min(1) }),
+    z.strictObject({ workflows: z.array(workflowSlug).min(1) }),
     z.enum(["anyone_in_org", "users_only", "workflows_only"]),
 ]);
 const egressSchema = z.union([
@@ -181,7 +190,8 @@ const notificationSchema = z.union([
 // The manifest
 // ============================================================================
 export const workflowManifestSchema = z.strictObject({
-    name: workflowName,
+    slug: workflowSlug,
+    title: workflowTitle.optional(),
     description: z.string().max(1000).optional(),
     triggers: z.array(triggerSchema).min(1),
     // NO top-level `secrets` — the secret allowlist is `permissions.secrets` (a secret you may read

package/dist/meta.d.ts

@@ -141,7 +141,12 @@ export interface Workspace {
  * the program. Validated by `workflowManifestSchema`; unknown fields are errors.
  */
 export interface WorkflowMeta {
-    name: string;
+    /** The workflow's identity: a URL-safe slug (alphanumeric + hyphens), stable across the program's
+     *  life. Referenced by the CLI, `workflows.call`, and the API. The human label is `title`. */
+    slug: string;
+    /** Optional human-readable display label (free text, one line). UIs fall back to a title-cased
+     *  slug when this is omitted, so set it only when the slug doesn't read well. */
+    title?: string;
     description?: string;
     /** At least one trigger is required. */
     triggers: readonly Trigger[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@boardwalk-labs/workflow",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "description": "Author Boardwalk workflows in TypeScript: agent(), sleep(), workflows.call(), secrets, the manifest schema, and the run-event wire format.",
   "license": "MIT",
   "repository": {