@theholocron/cli 5.0.0-alpha.194 → 5.0.0-alpha.196

package/dist/cli.mjs

@@ -2898,11 +2898,6 @@ async function runNotificationsChannelAdd(input) {
 */
 /** Features not built yet, in the order of the table in holocron#1098. Move an entry into a real check when it lands. */
 const PLANNED_CHECKS = [
-	{
-		step: 11,
-		id: "welcome",
-		title: "welcome screen and onboarding set"
-	},
 	{
 		step: 12,
 		id: "webhook-appearance",
@@ -2932,8 +2927,21 @@ const PLANNED_CHECKS = [
 const same = (a, b) => a.toLowerCase() === b.toLowerCase();
 /** `everyone`, or the roles sorted and lower-cased, so order and case do not matter when comparing. */
 const accessKey = (v) => v === "everyone" ? "everyone" : JSON.stringify([...new Set(v.map((r) => r.toLowerCase()))].sort());
+/** The prompts of an onboarding in a form two of them can be compared in: the order of the channels and roles an answer gives, and case, do not matter. */
+const promptKey = (p) => JSON.stringify([
+	p.singleSelect ?? false,
+	p.required ?? false,
+	(p.options ?? []).map((o) => [
+		o.title,
+		o.description ?? "",
+		o.emoji ?? "",
+		[...new Set((o.channels ?? []).map((c) => c.toLowerCase()))].sort(),
+		[...new Set((o.roles ?? []).map((r) => r.toLowerCase()))].sort()
+	])
+]);
 const accessText = (v) => v === "everyone" ? "everyone" : v.length === 0 ? "nobody (bots and webhooks only)" : v.join(", ");
 const shown = (s) => sanitizeDetail(s);
+const WELCOME_TITLE = "welcome screen and onboarding set";
 const SERVER_TITLE = "server verification, notifications and community set";
 const ACCESS_TITLE = "channel and category access set";
 const ROLE_APPEARANCE_TITLE = "role colour, hoist and permissions set";
@@ -3055,7 +3063,8 @@ async function runDoctorNotifications(input) {
 			["roles", "roles exist and are mentionable"],
 			["role-appearance", ROLE_APPEARANCE_TITLE],
 			["access", ACCESS_TITLE],
-			["server-settings", SERVER_TITLE]
+			["server-settings", SERVER_TITLE],
+			["welcome-onboarding", WELCOME_TITLE]
 		]) failed(id, title, "not checked: could not read the server");
 	} else {
 		const inspected = found;
@@ -3186,6 +3195,57 @@ async function runDoctorNotifications(input) {
 		}
 		const serverFields = wantServer ? Object.values(wantServer).filter((v) => v !== void 0).length : 0;
 		add("server-settings", SERVER_TITLE, serverProblems, serverFields === 0 ? "none declared" : `${serverFields} of ${serverFields} as declared`);
+		const wantWelcome = layout.welcome;
+		const wantOnboarding = layout.onboarding;
+		const welcomeProblems = [];
+		if (wantWelcome) {
+			if (inspected.welcomeError) welcomeProblems.push(`not checked: could not read the welcome screen (${shown(inspected.welcomeError)})`);
+			else if (!inspected.welcome) welcomeProblems.push("the provider did not report the welcome screen");
+			else {
+				const have = inspected.welcome;
+				const enabled = wantWelcome.enabled ?? true;
+				if (have.enabled !== enabled) welcomeProblems.push(`welcome screen is ${have.enabled ? "on" : "off"} but the layout says ${enabled ? "on" : "off"}`);
+				if (have.description !== wantWelcome.description) welcomeProblems.push(`welcome description is "${shown(have.description)}" but the layout says "${shown(wantWelcome.description)}"`);
+				const key = (list) => JSON.stringify(list.map((c) => [
+					c.channel.toLowerCase(),
+					c.description,
+					c.emoji ?? ""
+				]));
+				if (key(have.channels) !== key(wantWelcome.channels)) {
+					const names = (list) => list.length === 0 ? "none" : list.map((c) => shown(c.channel)).join(", ");
+					welcomeProblems.push(`welcome channels are ${names(have.channels)} but the layout says ${names(wantWelcome.channels)} (or their descriptions or emoji differ)`);
+				}
+			}
+		}
+		const onboardingProblems = [];
+		if (wantOnboarding) {
+			if (inspected.onboardingError) onboardingProblems.push(`not checked: could not read onboarding (${shown(inspected.onboardingError)})`);
+			else if (!inspected.onboarding) onboardingProblems.push("the provider did not report onboarding");
+			else {
+				const have = inspected.onboarding;
+				if (wantOnboarding.enabled !== void 0 && have.enabled !== wantOnboarding.enabled) onboardingProblems.push(`onboarding is ${have.enabled ? "on" : "off"} but the layout says ${wantOnboarding.enabled ? "on" : "off"}`);
+				if (wantOnboarding.defaultChannels !== void 0) {
+					const set = (list) => [...new Set(list.map((c) => c.toLowerCase()))].sort().join(",");
+					if (set(have.defaultChannels ?? []) !== set(wantOnboarding.defaultChannels)) onboardingProblems.push(`default channels are ${(have.defaultChannels ?? []).map(shown).join(", ") || "none"} but the layout says ${wantOnboarding.defaultChannels.map(shown).join(", ") || "none"}`);
+				}
+				if (wantOnboarding.prompts !== void 0) {
+					const found = new Map((have.prompts ?? []).map((p) => [p.title, p]));
+					for (const p of wantOnboarding.prompts) {
+						const actual = found.get(p.title);
+						if (!actual) onboardingProblems.push(`question "${shown(p.title)}" is missing`);
+						else if (promptKey(actual) !== promptKey(p)) onboardingProblems.push(`question "${shown(p.title)}" differs from the layout`);
+						found.delete(p.title);
+					}
+					for (const title of found.keys()) onboardingProblems.push(`question "${shown(title)}" is not in the layout`);
+					const order = (titles) => titles.join("\0");
+					const wantedTitles = wantOnboarding.prompts.map((p) => p.title);
+					const haveTitles = (have.prompts ?? []).map((p) => p.title).filter((t) => wantedTitles.includes(t));
+					if (haveTitles.length === wantedTitles.length && order(haveTitles) !== order(wantedTitles)) onboardingProblems.push("the questions are in a different order from the layout");
+				}
+			}
+		}
+		const welcomeParts = (wantWelcome ? 1 : 0) + (wantOnboarding ? 1 : 0);
+		add("welcome-onboarding", WELCOME_TITLE, [...welcomeProblems, ...onboardingProblems], welcomeParts === 0 ? "none declared" : `${welcomeParts} of ${welcomeParts} as declared`);
 	}
 	const wanted = [...declaredChannels.filter(({ channel }) => channel.webhook).map(({ channel }) => channel.webhook !== true && channel.webhook && channel.webhook.secret ? channel.webhook.secret : defaultSecretName(channel.name)), ...(layout.roles ?? []).flatMap((r) => r.secret ? [r.secret] : [])];
 	if (wanted.length === 0) checks.push({
@@ -3884,24 +3944,49 @@ function accessRoleProblem(layout) {
 		}
 	}
 }
-/** The first problem with the layout's `server` section that needs no knowledge of the provider, or undefined. */
+/**
+* The first problem with the layout's `server`, `welcome` and `onboarding` sections that needs no knowledge of
+* the provider, or undefined: every channel or role they name must be in the layout, and a channel name must
+* not be used twice (it could mean either, so they would pick one at random).
+*/
 function serverLayoutProblem(layout) {
-	const server = layout.server;
-	if (!server) return void 0;
 	const counts = /* @__PURE__ */ new Map();
 	for (const name of (layout.categories ?? []).flatMap((c) => (c.channels ?? []).map((ch) => ch.name.toLowerCase()))) counts.set(name, (counts.get(name) ?? 0) + 1);
-	for (const field of [
-		"systemChannel",
-		"rulesChannel",
-		"updatesChannel"
-	]) {
-		const name = server[field];
-		if (name === void 0) continue;
+	const roles = new Set((layout.roles ?? []).map((r) => r.name.toLowerCase()));
+	const channel = (where, name) => {
 		const count = counts.get(name.toLowerCase()) ?? 0;
-		if (count === 0) return `server: \`${field}\` names the channel \`${name}\`, which is not in the layout's channels`;
-		if (count > 1) return `server: \`${field}\` names \`${name}\`, but more than one channel in the layout has that name`;
+		if (count === 0) return `${where} names the channel \`${name}\`, which is not in the layout's channels`;
+		if (count > 1) return `${where} names \`${name}\`, but more than one channel in the layout has that name`;
+	};
+	const server = layout.server;
+	if (server) {
+		for (const field of [
+			"systemChannel",
+			"rulesChannel",
+			"updatesChannel"
+		]) {
+			const name = server[field];
+			const problem = name === void 0 ? void 0 : channel(`server: \`${field}\``, name);
+			if (problem) return problem;
+		}
+		if (server.community === true && (!server.rulesChannel || !server.updatesChannel)) return "server: `community: true` needs both `rulesChannel` and `updatesChannel`";
+	}
+	for (const entry of layout.welcome?.channels ?? []) {
+		const problem = channel("welcome:", entry.channel);
+		if (problem) return problem;
+	}
+	const onboarding = layout.onboarding;
+	for (const name of onboarding?.defaultChannels ?? []) {
+		const problem = channel("onboarding: `defaultChannels`", name);
+		if (problem) return problem;
+	}
+	for (const prompt of onboarding?.prompts ?? []) for (const option of prompt.options) {
+		for (const name of option.channels ?? []) {
+			const problem = channel(`onboarding: the option \`${option.title}\``, name);
+			if (problem) return problem;
+		}
+		for (const role of option.roles ?? []) if (!roles.has(role.toLowerCase())) return `onboarding: the option \`${option.title}\` gives the role \`${role}\`, which is not in the layout's roles`;
 	}
-	if (server.community === true && (!server.rulesChannel || !server.updatesChannel)) return "server: `community: true` needs both `rulesChannel` and `updatesChannel`";
 }
 async function runNotificationsSetup(input) {
 	const print = input.print ?? ((line) => console.log(line));
@@ -3961,6 +4046,8 @@ async function runNotificationsSetup(input) {
 	const serverProblem = serverLayoutProblem(layout);
 	if (serverProblem) return refuse(serverProblem);
 	if (layout.server && !notifications.ensureServer) return refuse(`the layout declares \`server\` settings, but the \`${notifications.providerName}\` provider cannot manage them`);
+	if (layout.welcome && !notifications.ensureWelcome) return refuse(`the layout declares a \`welcome\` screen, but the \`${notifications.providerName}\` provider cannot manage one`);
+	if (layout.onboarding && !notifications.ensureOnboarding) return refuse(`the layout declares \`onboarding\`, but the \`${notifications.providerName}\` provider cannot manage it`);
 	const needsCategories = (layout.categories ?? []).find((c) => c.access);
 	if (needsCategories && !notifications.ensureCategory) return refuse(`category \`${needsCategories.name}\` declares \`access\`, but the \`${notifications.providerName}\` provider cannot manage categories`);
 	const providerProblem = notifications.validateLayout?.(layout);
@@ -4073,19 +4160,25 @@ async function runNotificationsSetup(input) {
 			});
 		});
 	}
-	if (layout.server) {
+	if (layout.server || layout.welcome || layout.onboarding) {
 		print(`\n${style.header("Server")}`);
-		await attempt("server settings", async () => {
-			if (dryRun) {
-				print(`  ${style.skip("would ensure server settings")}`);
-				tally.skip++;
-				return;
-			}
-			const result = await notifications.ensureServer(layout.server);
-			const changed = result.updated.length > 0;
-			print(`  ${(changed ? style.success : style.skip)(`${changed ? "updated" : "exists "} server settings${changed ? `: ${result.updated.join(", ")}` : ""}`)}`);
-			made(changed);
-		});
+		const apply = async (label, declared, run) => {
+			if (!declared) return;
+			await attempt(label, async () => {
+				if (dryRun) {
+					print(`  ${style.skip(`would ensure ${label}`)}`);
+					tally.skip++;
+					return;
+				}
+				const result = await run();
+				const changed = result.updated.length > 0;
+				print(`  ${(changed ? style.success : style.skip)(`${changed ? "updated" : "exists "} ${label}${changed ? `: ${result.updated.join(", ")}` : ""}`)}`);
+				made(changed);
+			});
+		};
+		await apply("server settings", !!layout.server, () => notifications.ensureServer(layout.server));
+		await apply("welcome screen", !!layout.welcome, () => notifications.ensureWelcome(layout.welcome));
+		await apply("onboarding", !!layout.onboarding, () => notifications.ensureOnboarding(layout.onboarding));
 	}
 	if (report.failures.length > 0) report.status = "fail";
 	else if (dryRun) report.status = "dry-run";