π OpenHands: AI-Driven Development
import type { CloudSetupGuideSteps } from "#/api/cloud/types";
import { I18nKey } from "#/i18n/declaration";
import { automationTemplatesPath } from "#/manifests/automation-interface";
/** Server permission held by instance Super Admins (`/me` `permissions`). */
export const MANAGE_SUPER_ADMINS_PERMISSION = "manage_super_admins";
/** The enterprise setup guide page, on the cloud host. */
export const SUPER_ADMIN_SETUP_GUIDE_PAGE_PATH = "/super-admin/setup";
/**
* Names the setup step whose tour to start when a page loads. The enterprise
* guide reads it on the links this guide opens, and Canvas on the links the
* enterprise guide opens.
*/
export const SETUP_TOUR_PARAM = "setup_tour";
export type SuperAdminSetupStepId =
| "add-llm"
| "add-integration"
| "first-automation"
| "invite-users"
| "optional-saml";
/**
* What marks a step done: a server-derived flag from `guide_steps`, or
* "optional" for a link that never counts toward progress.
*/
export type SuperAdminSetupStepCompletion =
| keyof CloudSetupGuideSteps
| "optional";
/**
* Where a step opens: a page on the cloud host (`withOrg` adds the guide's
* organization so enterprise settings open on it) or a Canvas route.
*/
export type SuperAdminSetupStepDestination =
| { kind: "cloud"; path: string; withOrg: boolean }
| { kind: "canvas"; path: string };
export interface SuperAdminSetupStep {
id: SuperAdminSetupStepId;
labelKey: I18nKey;
completion: SuperAdminSetupStepCompletion;
destination: SuperAdminSetupStepDestination;
}
/**
* Mirrors the enterprise guide's steps and order so both apps show the same
* progress. Steps that Canvas can do itself (automation templates, MCP
* servers) open in Canvas; the rest open the enterprise app.
*/
export const SUPER_ADMIN_SETUP_STEPS: readonly SuperAdminSetupStep[] = [
{
id: "add-llm",
labelKey: I18nKey.ONBOARDING$SETUP_GUIDE_STEP_LLM,
completion: "org_llm",
destination: {
kind: "cloud",
path: "/settings/org-defaults",
withOrg: true,
},
},
{
id: "first-automation",
labelKey: I18nKey.ONBOARDING$SETUP_GUIDE_STEP_AUTOMATION,
completion: "automation",
destination: { kind: "canvas", path: automationTemplatesPath() },
},
{
id: "add-integration",
labelKey: I18nKey.ONBOARDING$SETUP_GUIDE_STEP_INTEGRATION,
completion: "mcp_server",
// Canvas's MCP page saves to the same cloud settings the step checks.
destination: { kind: "canvas", path: "/mcp" },
},
{
id: "invite-users",
labelKey: I18nKey.ONBOARDING$SETUP_GUIDE_STEP_INVITE,
completion: "invite",
destination: {
kind: "cloud",
path: "/settings/org-members",
withOrg: true,
},
},
{
id: "optional-saml",
labelKey: I18nKey.ONBOARDING$SETUP_GUIDE_STEP_SAML,
completion: "optional",
destination: {
kind: "cloud",
path: "/super-admin/auth-providers",
withOrg: false,
},
},
];