catalog.js

/*
Copyright (c) 2022-2026 Super Durable, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/

function flowId(name = "workflowId") {
  return { name, in: "query", role: "flowId" };
}

function query(name, extra) {
  return Object.assign({ name, in: "query" }, extra || {});
}

function body(name, extra) {
  return Object.assign({ name, in: "body" }, extra || {});
}

function endpoint(method, path, title, fields, extra) {
  return Object.assign({ method, path, title, fields: fields || [] }, extra || {});
}

window.PLAYGROUND_CATALOG = [
  {
    group: "products",
    id: "engagement",
    title: "Job seeker engagement",
    flowIdPrefix: "engagement",
    note: "Start mints its own flowID in most languages; copy it from the response.",
    endpoints: [
      endpoint("GET", "/products/engagement/start", "Start"),
      endpoint("GET", "/products/engagement/describe", "Describe", [flowId()]),
      endpoint("GET", "/products/engagement/optout", "Opt out of reminder", [flowId()]),
      endpoint("GET", "/products/engagement/decline", "Decline", [
        flowId(),
        query("notes", { default: "not a fit" }),
      ]),
      endpoint("GET", "/products/engagement/accept", "Accept", [
        flowId(),
        query("notes", { default: "looks good" }),
      ]),
      endpoint("GET", "/products/engagement/list", "List / search", [
        query("query", { default: 'ExecutionStatus="Running"' }),
      ]),
    ],
  },
  {
    group: "products",
    id: "job-post",
    title: "Job posting",
    flowIdPrefix: "job_id",
    note: "Create mints job_id_<unix>; Rust also exposes GET /start.",
    endpoints: [
      endpoint("GET", "/products/job-post/create", "Create", [
        query("title", { default: "Staff engineer" }),
        query("description", { default: "Build durable workflows" }),
      ]),
      endpoint("GET", "/products/job-post/read", "Read", [flowId()]),
      endpoint("GET", "/products/job-post/update", "Update", [
        flowId(),
        query("title", { default: "Staff engineer" }),
        query("description", { default: "Updated description" }),
        query("notes", { default: "test-notes" }),
      ]),
      endpoint("GET", "/products/job-post/delete", "Delete / stop", [flowId()]),
      endpoint("GET", "/products/job-post/search", "Search", [
        query("query", { default: "" }),
      ]),
      endpoint("GET", "/products/job-post/start", "Start (Rust)", [flowId()]),
    ],
  },
  {
    group: "products",
    id: "microservices",
    title: "Microservices",
    flowIdPrefix: "microservices",
    endpoints: [
      endpoint("GET", "/products/microservices/start", "Start", [flowId()]),
      endpoint("GET", "/products/microservices/swap", "Swap data (RPC)", [
        flowId(),
        query("data", { default: "swapped payload" }),
      ]),
      endpoint("GET", "/products/microservices/signal", "Signal ready", [flowId()]),
    ],
  },
  {
    group: "products",
    id: "money-transfer",
    title: "Money transfer",
    flowIdPrefix: "money-transfer",
    note: "Start mints its own flowID in most languages; copy it from the response.",
    endpoints: [
      endpoint("GET", "/products/money-transfer/start", "Start", [
        query("fromAccount", { default: "from-checking" }),
        query("toAccount", { default: "to-savings" }),
        query("amount", { type: "number", default: "100" }),
        query("notes", { default: "playground transfer" }),
      ]),
    ],
  },
  {
    group: "products",
    id: "order-processing",
    title: "Order processing",
    flowIdPrefix: "order-processing",
    note: "Start waits until charged, then returns. Copy flowID from the response and approve shipment.",
    endpoints: [
      endpoint("GET", "/products/order-processing/start", "Start", [
        query("testFailAtShipping", { default: "false" }),
      ]),
      endpoint("GET", "/products/order-processing/approve", "Approve shipment", [flowId()]),
      endpoint("GET", "/products/order-processing/describe", "Describe", [flowId()]),
    ],
  },
  {
    group: "products",
    id: "signup",
    title: "User onboarding process",
    flowIdPrefix: "signup-user",
    idParam: "username",
    note: "username is the flowID. Rust also exposes GET /start for a generated ID.",
    endpoints: [
      endpoint("GET", "/products/signup/submit", "Submit", [
        query("username", { role: "flowId" }),
        query("email", { default: "user@example.com" }),
      ]),
      endpoint("GET", "/products/signup/verify", "Verify", [
        query("username", { role: "flowId" }),
      ]),
      endpoint("GET", "/products/signup/accomplish-task-1", "Accomplish task 1", [
        query("username", { role: "flowId" }),
      ]),
      endpoint("GET", "/products/signup/accomplish-task-2", "Accomplish task 2", [
        query("username", { role: "flowId" }),
      ]),
      endpoint("GET", "/products/signup/start", "Start (Rust)", [flowId()]),
    ],
  },
  {
    group: "products",
    id: "subscription",
    title: "Subscription",
    flowIdPrefix: "subscription",
    note: "Start mints its own flowID in most languages; copy it from the response.",
    endpoints: [
      endpoint("GET", "/products/subscription/start", "Start"),
      endpoint("GET", "/products/subscription/cancel", "Cancel", [flowId()]),
      endpoint("GET", "/products/subscription/updateChargeAmount", "Update charge amount", [
        flowId(),
        query("newChargeAmount", { type: "number", default: "200" }),
      ]),
      endpoint("GET", "/products/subscription/describe", "Describe", [flowId()]),
    ],
  },
  {
    group: "patterns",
    id: "drain-channels-internal",
    title: "Drain channels (internal)",
    flowIdPrefix: "drain-internal",
    endpoints: [
      endpoint("GET", "/patterns/drain-channels/internal/start", "Start", [flowId()]),
    ],
  },
  {
    group: "patterns",
    id: "drain-channels-signal",
    title: "Drain channels (signal)",
    flowIdPrefix: "drain-signal",
    note: "Go uses /start-or-signal; other languages use /startorsignal.",
    endpoints: [
      endpoint("GET", "/patterns/drain-channels/signal/startorsignal", "Start or signal", [flowId()]),
      endpoint("GET", "/patterns/drain-channels/signal/start-or-signal", "Start or signal (Go)", [flowId()]),
    ],
  },
  {
    group: "patterns",
    id: "entity-store",
    title: "Entity store",
    flowIdPrefix: "user",
    idParam: "userId",
    note: "userId is the flowID. Rust also exposes GET /start.",
    endpoints: [
      endpoint("POST", "/patterns/entity-store/profile", "Create profile", [
        {
          name: "body",
          in: "raw-json",
          injectFlowId: "userId",
          default: JSON.stringify(
            {
              userId: "",
              displayName: "Ada Lovelace",
              email: "ada@example.com",
              marketingOptIn: true,
              credits: 100,
              weight: 61.5,
              lastLoggedInTime: "2026-01-15T09:30:00Z",
              metadata: { source: "playground", tags: ["example"] },
            },
            null,
            2,
          ),
        },
      ]),
      endpoint("POST", "/patterns/entity-store/profile/update", "Update profile", [
        {
          name: "body",
          in: "raw-json",
          injectFlowId: "userId",
          default: JSON.stringify(
            {
              userId: "",
              displayName: "Ada Lovelace",
              email: "ada@example.com",
              marketingOptIn: false,
              credits: 80,
              weight: 61.5,
              lastLoggedInTime: "2026-01-16T09:30:00Z",
              metadata: { source: "playground", tags: ["updated"] },
            },
            null,
            2,
          ),
        },
      ]),
      endpoint("GET", "/patterns/entity-store/profile", "Get profile", [
        query("userId", { role: "flowId" }),
      ]),
      endpoint("POST", "/patterns/entity-store/profile/clear", "Clear profile", [
        query("userId", { role: "flowId" }),
      ]),
      endpoint("GET", "/patterns/entity-store/start", "Start (Rust)", [flowId()]),
    ],
  },
  {
    group: "patterns",
    id: "interruptible",
    title: "Interruptible",
    flowIdPrefix: "interruptible",
    endpoints: [
      endpoint("GET", "/patterns/interruptible/start", "Start", [flowId()]),
      endpoint("GET", "/patterns/interruptible/cancel", "Cancel", [flowId()]),
    ],
  },
  {
    group: "patterns",
    id: "sequentially-chunked-attribute-map",
    title: "Sequentially chunked AttributeMap",
    endpoints: [
      endpoint("POST", "/patterns/sequentially-chunked-attribute-map/start", "Start"),
      endpoint("POST", "/patterns/sequentially-chunked-attribute-map/register", "Register subscriber", [
        {
          name: "body",
          in: "raw-json",
          default: JSON.stringify(
            {
              subscriberId: "subscriber-001",
              deliveryAddress: "alice@example.com",
            },
            null,
            2,
          ),
        },
      ]),
      endpoint("GET", "/patterns/sequentially-chunked-attribute-map/subscribers", "Get subscriber page", [
        query("pageToken", { default: "current" }),
      ]),
    ],
  },
  {
    group: "patterns",
    id: "hash-partitioned-attribute-map",
    title: "Hash-partitioned AttributeMap",
    endpoints: [
      endpoint("POST", "/patterns/hash-partitioned-attribute-map/start", "Start"),
      endpoint("PUT", "/patterns/hash-partitioned-attribute-map/customer-profile", "Upsert customer profile", [
        {
          name: "body",
          in: "raw-json",
          default: JSON.stringify(
            {
              emailAddress: "alice@example.com",
              fullName: "Alice Example",
              companyName: "Example Corp",
              customerTier: "gold",
            },
            null,
            2,
          ),
        },
      ]),
      endpoint("GET", "/patterns/hash-partitioned-attribute-map/customer-profile", "Get customer profile", [
        query("emailAddress", { default: "alice@example.com" }),
      ]),
    ],
  },
  {
    group: "patterns",
    id: "manual-recovery",
    title: "Manual Recovery",
    flowIdPrefix: "manual-recovery",
    endpoints: [
      endpoint("GET", "/patterns/manual-recovery/start", "Start", [flowId()]),
    ],
  },
  {
    group: "patterns",
    id: "parallel",
    title: "Parallel Steps",
    flowIdPrefix: "parallel",
    endpoints: [
      endpoint("GET", "/patterns/parallel/start/static", "Start static", [flowId()]),
      endpoint("GET", "/patterns/parallel/start/dynamic", "Start dynamic", [flowId()]),
      endpoint("GET", "/patterns/parallel/start/await", "Start await", [flowId()]),
      endpoint("GET", "/patterns/parallel/start/first-win", "Start first win", [flowId()]),
    ],
  },
  {
    group: "patterns",
    id: "parallel-subflows",
    title: "Parallel SubFlows",
    flowIdPrefix: "parallel-subflows",
    endpoints: [
      endpoint("GET", "/patterns/parallel-subflows/start/basic", "Start basic", [flowId()]),
      endpoint("GET", "/patterns/parallel-subflows/start/long-lived-parent", "Start long-lived parent", [flowId()]),
      endpoint("GET", "/patterns/parallel-subflows/start/short-lived-parent", "Start short-lived parent", [flowId()]),
      endpoint("GET", "/patterns/parallel-subflows/start/submit", "Start submit request", [flowId()]),
    ],
  },
  {
    group: "patterns",
    id: "polling",
    title: "Polling",
    flowIdPrefix: "pattern-polling",
    endpoints: [
      endpoint("GET", "/patterns/polling/start", "Start", [flowId()]),
      endpoint("GET", "/patterns/polling/complete-job", "Complete job", [flowId()]),
    ],
  },
  {
    group: "patterns",
    id: "recovery",
    title: "Recovery",
    flowIdPrefix: "recovery",
    endpoints: [
      endpoint("GET", "/patterns/recovery/start", "Start", [
        flowId(),
        query("itemName", { default: "widget" }),
        query("quantity", { type: "number", default: "2" }),
      ]),
    ],
  },
  {
    group: "patterns",
    id: "reminders",
    title: "Reminders",
    flowIdPrefix: "reminder_test_id",
    note: "Start mints reminder_test_id_<nanos>; copy it from the response.",
    endpoints: [
      endpoint("GET", "/patterns/reminders/start", "Start"),
      endpoint("GET", "/patterns/reminders/optout", "Opt out", [flowId()]),
    ],
  },
  {
    group: "patterns",
    id: "inactiveness-tracker-timer",
    title: "Inactiveness Tracker Timer",
    flowIdPrefix: "inactiveness-tracker",
    endpoints: [
      endpoint("GET", "/patterns/inactiveness-tracker-timer/start", "Start", [flowId()]),
      endpoint("GET", "/patterns/inactiveness-tracker-timer/activity", "Record activity", [flowId()]),
    ],
  },
  {
    group: "patterns",
    id: "resource-control",
    title: "Resource control",
    flowIdPrefix: "controller_flow",
    note: "Python-only. request id becomes processing-<id>; shutdown takes instance_id.",
    endpoints: [
      endpoint("GET", "/patterns/resource-control/request", "Enqueue request", [
        query("id", { default: "req-1" }),
        query("data", { default: "abcd" }),
      ]),
      endpoint("GET", "/patterns/resource-control/shutdown", "Shutdown instance", [
        query("instance_id", { default: "1" }),
      ]),
      endpoint("GET", "/patterns/resource-control/processing/describe", "Describe processing", [
        query("id", { default: "req-1" }),
      ]),
    ],
  },
  {
    group: "patterns",
    id: "timeout",
    title: "Timeout",
    flowIdPrefix: "timeout",
    endpoints: [
      endpoint("GET", "/patterns/timeout/start", "Start", [
        flowId(),
        query("successfulWorkflow", { type: "boolean", default: "true" }),
      ]),
    ],
  },
  {
    group: "patterns",
    id: "wait-for-step-completion",
    title: "Wait for Step completion",
    flowIdPrefix: "wait-state",
    endpoints: [
      endpoint("GET", "/patterns/wait-for-step-completion/start", "Start", [flowId()]),
    ],
  },
  {
    group: "primitives",
    id: "attribute",
    title: "Attribute",
    flowIdPrefix: "attribute",
    endpoints: [
      endpoint("GET", "/primitives/attribute/start", "Start", [
        flowId(),
        query("message", { default: "hello from playground" }),
      ]),
      endpoint("GET", "/primitives/attribute/read", "Read Attributes", [flowId()]),
    ],
  },
  {
    group: "primitives",
    id: "channel",
    title: "Channel",
    flowIdPrefix: "channel",
    endpoints: [
      endpoint("GET", "/primitives/channel/start", "Start", [
        flowId(),
        query("inputNum", { type: "number", default: "1" }),
      ]),
      endpoint("GET", "/primitives/channel/approve", "Approve", [flowId()]),
    ],
  },
  {
    group: "primitives",
    id: "client-apis",
    title: "Client APIs",
    flowIdPrefix: "client-apis",
    endpoints: [
      endpoint("GET", "/primitives/client-apis/start", "Start", [
        flowId(),
        query("keyword", { default: "playground" }),
      ]),
      endpoint("GET", "/primitives/client-apis/search", "Search", [
        query("query", { default: 'ExecutionStatus="Running"' }),
      ]),
    ],
  },
  {
    group: "primitives",
    id: "rpc",
    title: "RPC",
    flowIdPrefix: "rpc",
    endpoints: [
      endpoint("GET", "/primitives/rpc/start", "Start", [flowId()]),
      endpoint("GET", "/primitives/rpc/trigger", "Trigger", [
        flowId(),
        query("message", { default: "ping" }),
      ]),
    ],
  },
  {
    group: "primitives",
    id: "rpc-canceling-steps",
    title: "RPC canceling steps",
    flowIdPrefix: "rpc-canceling-steps",
    note: "Not in Rust. Call Stop within ten seconds of Start.",
    endpoints: [
      endpoint("GET", "/primitives/rpc-canceling-steps/start", "Start", [
        flowId(),
        query("reportName", { default: "q3" }),
      ]),
      endpoint("GET", "/primitives/rpc-canceling-steps/stop", "Stop", [flowId()]),
    ],
  },
  {
    group: "primitives",
    id: "step",
    title: "Step",
    flowIdPrefix: "step",
    endpoints: [
      endpoint("GET", "/primitives/step/start", "Start", [
        flowId(),
        query("inputNum", { type: "number", default: "1" }),
      ]),
    ],
  },
  {
    group: "primitives",
    id: "step-retry",
    title: "Step retry",
    flowIdPrefix: "step-retry",
    endpoints: [
      endpoint("GET", "/primitives/step/retry/start", "Start", [
        flowId(),
        query("readyAfterAttempt", { type: "number", default: "2" }),
      ]),
    ],
  },
  {
    group: "primitives",
    id: "subflow",
    title: "SubFlow",
    flowIdPrefix: "subflow",
    endpoints: [
      endpoint("GET", "/primitives/subflow/start", "Start", [
        flowId(),
        query("inputNum", { type: "number", default: "1" }),
      ]),
    ],
  },
  {
    group: "primitives",
    id: "timer",
    title: "Timer",
    flowIdPrefix: "timer",
    endpoints: [
      endpoint("GET", "/primitives/timer/start", "Start", [
        flowId(),
        query("seconds", { type: "number", default: "2" }),
      ]),
    ],
  },
];