@jant/core 0.6.16 → 0.7.1

package/src/ui/dash/settings/GeneralContent.tsx

@@ -2,8 +2,8 @@
  * General settings form
  *
  * Server-side template that renders the <jant-settings-general> Lit
- * component for site name, description, footer, homepage branding, language,
- * timezone, and search settings.
+ * component: site name, description, and footer; site visibility (search
+ * indexing and Jant Discover); feeds; time zone; and home page branding.
  * The settings-bridge.ts script handles server communication.
  */
 
@@ -11,13 +11,85 @@ import { msg } from "@lingui/core/macro";
 import { useLingui } from "../../../i18n/context.js";
 import type { TimezoneEntry } from "../../../lib/timezones.js";
 import type { AboutPageStatus } from "../../../services/about-page.js";
+import type {
+  DiscoverMode,
+  DiscoverPageUrls,
+  DiscoverSetting,
+} from "../../../lib/discover.js";
+import { getJantDocsUrl } from "../../../lib/jant-docs.js";
+import { now } from "../../../lib/time.js";
+import { getDiscoverCopy } from "./discover-copy.js";
+
+const FEEDS_DOCS_URL = getJantDocsUrl("feeds");
+
+/**
+ * Where the site stands in the directory, as far as the site itself can tell.
+ *
+ * Every field is local evidence. The directory takes no status queries, so
+ * nothing here is fetched, and nothing here can say whether a person has
+ * moderated the site.
+ */
+export interface DiscoverStatus {
+  /** Last announcement succeeded, failed, or was never made. */
+  announced: boolean | null;
+  /** Why the last announcement failed. */
+  announceError: string | null;
+  /** Unix seconds of the last announcement attempt. */
+  announceAt: number | null;
+  /** A directory is configured at all. */
+  hasDirectory: boolean;
+  /**
+   * A control plane runs this deployment and enrols its blogs itself.
+   *
+   * The announcement exists because a directory cannot list a site it has
+   * never heard of. That is not this site's situation: the platform hosting it
+   * registers its whole fleet, so "never announced" is not a defect here and
+   * there is nothing for the owner to send. The ping still fires when they
+   * switch this back on — a directory reads it as "read me now" and re-polls
+   * at once instead of waiting out the backstop — but that is plumbing, not a
+   * task, and it is reported nowhere.
+   */
+  managedByHost: boolean;
+  /** The directory's manual submission form, when there is one. */
+  submitUrl: string | null;
+  /** What this site's feeds actually declare right now. */
+  declaredMode: DiscoverMode;
+  publicPostCount: number;
+  /** Featured thread roots — what a `featured` feed would actually carry. */
+  featuredPostCount: number;
+  /** The directory's threshold is met. */
+  established: boolean;
+  minPublicPosts: number;
+  firstReadMaxHours: number;
+}
+
+/**
+ * Whether a directory could still be reading the announcement for the first
+ * time.
+ *
+ * The window is the directory's own backstop: it polls a newly announced feed
+ * within `firstReadMaxHours`, so up to that point "sent, nothing visible yet"
+ * is the expected state and worth saying. Past it, the site is either listed
+ * or it is not, and neither answer comes back here.
+ *
+ * @param status - The site's Discover status, as assembled by the route
+ * @returns `true` while the first read is still due
+ * @example
+ * ```ts
+ * isFirstReadPending({ announceAt: now() - 60, firstReadMaxHours: 6 }); // true
+ * ```
+ */
+function isFirstReadPending(status: {
+  announceAt: number | null;
+  firstReadMaxHours: number;
+}): boolean {
+  if (status.announceAt === null) return false;
+  return now() < status.announceAt + status.firstReadMaxHours * 3600;
+}
 
 export function GeneralContent({
   siteName,
   siteDescription,
-  siteLanguage,
-  dashboardLanguage,
-  cjkSerifFont,
   siteNameFallback,
   siteDescriptionFallback,
   mainRssFeed,
@@ -29,6 +101,11 @@ export function GeneralContent({
   siteFooter,
   showJantBrandingOnHome,
   noindex,
+  discover,
+  discoverDefault,
+  discoverPages,
+  discoverStatus,
+  rssFeedsEnabled,
   demoMode,
   timezones,
   aboutPage,
@@ -37,9 +114,6 @@ export function GeneralContent({
 }: {
   siteName: string;
   siteDescription: string;
-  siteLanguage: string;
-  dashboardLanguage: string;
-  cjkSerifFont: string;
   siteNameFallback: string;
   siteDescriptionFallback: string;
   mainRssFeed: string;
@@ -51,6 +125,21 @@ export function GeneralContent({
   siteFooter: string;
   showJantBrandingOnHome: boolean;
   noindex: boolean;
+  /** The stored choice, or "" when the owner has never used the control. */
+  discover: string;
+  /**
+   * The deployment's own answer, unresolved: `""` when it has none.
+   *
+   * Not the effective mode. `noindex` is a control on this same page, so
+   * folding it in here would hand the browser a value that is already stale by
+   * the first click; the component applies it, and the rest of the rules,
+   * itself.
+   */
+  discoverDefault: DiscoverSetting | "";
+  /** The directory's own pages, or `null` when none is configured. */
+  discoverPages: DiscoverPageUrls | null;
+  discoverStatus: DiscoverStatus;
+  rssFeedsEnabled: boolean;
   demoMode: boolean;
   timezones: TimezoneEntry[];
   aboutPage: AboutPageStatus;
@@ -59,7 +148,17 @@ export function GeneralContent({
 }) {
   const { i18n } = useLingui();
 
+  // Shared with the setup screen, which asks the same question once.
+  const discoverCopy = getDiscoverCopy(i18n);
+
   const labels = JSON.stringify({
+    // The component finds the name and the rules in the help line (and the
+    // name in the demo notice that replaces it) to make them links, so it gets
+    // them on their own as well as inside the lines.
+    discoverName: discoverCopy.name,
+    discoverRules: discoverCopy.rules,
+    discoverEnabled: discoverCopy.label,
+    discoverIntro: discoverCopy.intro,
     general: i18n._(
       msg({
         message: "General",
@@ -104,11 +203,11 @@ export function GeneralContent({
         comment: "@context: Compact conflict message when /about is occupied",
       }),
     ),
-    languageAndTime: i18n._(
+    timeSection: i18n._(
       msg({
-        message: "Language & Time",
+        message: "Time",
         comment:
-          "@context: Settings subsection heading for language and time zone fields",
+          "@context: Settings subsection heading for the time zone field",
       }),
     ),
     home: i18n._(
@@ -117,11 +216,11 @@ export function GeneralContent({
         comment: "@context: Settings subsection heading for home page settings",
       }),
     ),
-    search: i18n._(
+    siteVisibility: i18n._(
       msg({
-        message: "Search",
+        message: "Site visibility",
         comment:
-          "@context: Settings section heading for search engine indexing settings",
+          "@context: Settings section heading covering search engine indexing and the Jant Discover directory",
       }),
     ),
     siteName: i18n._(
@@ -142,69 +241,6 @@ export function GeneralContent({
         comment: "@context: Help text for site description field",
       }),
     ),
-    siteLanguage: i18n._(
-      msg({
-        message: "Content language",
-        comment:
-          "@context: Settings form field for the public content language",
-      }),
-    ),
-    siteLanguageHelp: i18n._(
-      msg({
-        message:
-          "The language your posts are written in. Announced to readers and search engines through HTML lang and your RSS feed. Any BCP 47 tag works.",
-        comment: "@context: Help text under the content language picker",
-      }),
-    ),
-    contentLanguagePreview: i18n._(
-      msg({
-        message: "Readers and search engines see",
-        comment:
-          "@context: Lead text before a live <html lang> preview of the content language",
-      }),
-    ),
-    dashboardLanguage: i18n._(
-      msg({
-        message: "Dashboard language",
-        comment:
-          "@context: Settings form field for the admin interface language",
-      }),
-    ),
-    dashboardLanguageHelp: i18n._(
-      msg({
-        message:
-          "The language this admin dashboard shows in. Available in English, 简体中文, and 繁體中文.",
-        comment: "@context: Help text under the dashboard language picker",
-      }),
-    ),
-    siteLanguageSearchPlaceholder: i18n._(
-      msg({
-        message: "Search…",
-        comment:
-          "@context: Placeholder inside the language combobox search field",
-      }),
-    ),
-    siteLanguageNoMatches: i18n._(
-      msg({
-        message: "No matches.",
-        comment:
-          "@context: Empty state shown when the language search filters out every entry",
-      }),
-    ),
-    cjkFont: i18n._(
-      msg({
-        message: "CJK fallback",
-        comment:
-          "@context: Settings field for a manual Chinese, Japanese, or Korean font fallback",
-      }),
-    ),
-    cjkFontHelp: i18n._(
-      msg({
-        message:
-          "Used when the content language has no built-in font profile. Your font theme still controls serif and sans styling.",
-        comment: "@context: Help text for the manual CJK font fallback setting",
-      }),
-    ),
     timeZone: i18n._(
       msg({
         message: "Time Zone",
@@ -251,6 +287,13 @@ export function GeneralContent({
         comment: "@context: Label for the list of stable RSS feed URLs",
       }),
     ),
+    feedsDocs: i18n._(
+      msg({
+        message: "All feed addresses",
+        comment:
+          "@context: Link text to the feeds documentation, under the fixed feed URLs in General settings",
+      }),
+    ),
     availableFeedUrlsHelp: i18n._(
       msg({
         message: "Use these when you want a feed URL that never changes.",
@@ -349,6 +392,43 @@ export function GeneralContent({
           "@context: Help text explaining that SEO indexing is locked in demo mode",
       }),
     ),
+    discoverSearchOff: i18n._(
+      msg({
+        message:
+          "Search engine indexing is off, so this site is not listed by default. Ticking the box above lists it anyway.",
+        comment:
+          "@context: Shown under the Jant Discover checkbox when the site has turned search engines away and has never answered Discover itself, which is what unticks the box. Says why the box moved, and that it is still the owner's to tick.",
+      }),
+    ),
+    discoverAnnounce: i18n._(
+      msg({
+        message: "Announce my site",
+        comment:
+          "@context: Button sending the Discover announcement, shown when the site has never announced itself or when the announcement failed",
+      }),
+    ),
+    discoverAnnounceManual: i18n._(
+      msg({
+        message: "Or submit your address by hand",
+        comment:
+          "@context: Link to the directory's manual submission form, shown only when the automatic announcement failed",
+      }),
+    ),
+    discoverDemoLocked: i18n._(
+      msg({
+        message: "Demo sites are never listed in {name}.",
+        comment:
+          "@context: Help text under the Jant Discover checkbox explaining that Discover is locked off in demo mode, shown in place of the usual help line. {name} is the directory's name and is rendered as the link to it, so keep it as one run of text.",
+      }),
+      { name: discoverCopy.name },
+    ),
+    discoverFeedsOffLocked: i18n._(
+      msg({
+        message: "Discover reads your Atom feed, so it needs feeds turned on.",
+        comment:
+          "@context: Help text explaining that Discover cannot work while Atom feeds are disabled",
+      }),
+    ),
     save: i18n._(
       msg({
         message: "Save",
@@ -387,67 +467,151 @@ export function GeneralContent({
     timezones.map((tz) => ({ value: tz.value, label: tz.label })),
   ).replace(/</g, "\\u003c");
 
-  // The 3 catalog locales Jant's dashboard is translated into. Native-script
-  // labels so each reads in its own language, like the CJK font options.
-  const dashboardLanguagesJson = JSON.stringify([
-    { value: "en", label: "English" },
-    { value: "zh-Hans", label: "简体中文" },
-    { value: "zh-Hant", label: "繁體中文" },
-  ]).replace(/</g, "\\u003c");
-
-  const cjkFontsJson = JSON.stringify([
-    {
-      value: "off",
-      label: i18n._(
-        msg({
-          message: "Follow content language",
-          comment:
-            "@context: CJK font fallback option that uses the configured content language",
-        }),
-      ),
-    },
-    {
-      value: "zh-Hans",
-      label: "\u7B80\u4F53\u4E2D\u6587 (Simplified Chinese)",
-    },
-    {
-      value: "zh-Hant",
-      label: "\u7E41\u9AD4\u4E2D\u6587 (Traditional Chinese)",
-    },
-    { value: "ja", label: "\u65E5\u672C\u8A9E (Japanese)" },
-    { value: "ko", label: "\uD55C\uAD6D\uC5B4 (Korean)" },
-  ]).replace(/</g, "\\u003c");
-
   const aboutPageJson = JSON.stringify(aboutPage).replace(/</g, "\\u003c");
 
   const initialData = JSON.stringify({
     siteName,
     siteDescription,
-    siteLanguage,
-    dashboardLanguage,
-    cjkSerifFont,
     mainRssFeed,
     timeZone,
     siteFooter,
     showJantBrandingOnHome,
     noindex,
+    discover,
   }).replace(/</g, "\\u003c");
 
+  // The status sentences carry runtime numbers, so they are translated here
+  // rather than handed to the component as templates — values belong with the
+  // `i18n._` call that has them. The component renders what it is given.
+  //
+  // Only what the controls above cannot say for themselves gets a line. The
+  // ticked box and the picked mode already state that the site is listed and
+  // what its feed declares, and a site past the directory's threshold has
+  // nothing to do about being past it — printing either turns this into a
+  // report that is read once and skipped forever after. What is left is a
+  // problem, a task, or an answer that is still outstanding.
+  const statusLines: string[] = [];
+
+  // A site that is not listed gets no status block at all: every line under
+  // it would only restate the unticked checkbox above.
+  if (discoverStatus.declaredMode !== "none") {
+    if (discoverStatus.hasDirectory && !discoverStatus.managedByHost) {
+      if (discoverStatus.announced === false) {
+        statusLines.push(
+          i18n._(
+            msg({
+              message: "The directory could not be reached: {reason}",
+              comment:
+                "@context: Discover status line when the announcement failed. {reason} is the error, such as an HTTP status or a network message.",
+            }),
+            { reason: discoverStatus.announceError ?? "" },
+          ),
+        );
+      } else if (discoverStatus.announced === null) {
+        statusLines.push(
+          i18n._(
+            msg({
+              message:
+                "Not announced yet. No directory has been told this site exists.",
+              comment:
+                "@context: Discover status line before the site has ever announced itself. The button under the lines is how it is sent.",
+            }),
+          ),
+        );
+      } else if (isFirstReadPending(discoverStatus)) {
+        // A successful announcement is worth confirming only while its answer
+        // is still outstanding. Inside the first-read window the owner is
+        // waiting for a directory to come round; after it, the directory
+        // either lists the site — which the directory itself shows — or has
+        // declined to, and this page can see neither.
+        statusLines.push(
+          i18n._(
+            msg({
+              message:
+                "Feed address sent. A directory reads a newly announced feed within {hours} hours.",
+              comment:
+                "@context: Discover status line right after a successful announcement, while the first crawl is still due",
+            }),
+            { hours: discoverStatus.firstReadMaxHours },
+          ),
+        );
+      }
+    }
+
+    // A site that stored `featured` under an older release: the directory
+    // reads only its featured feed, on every list. The box still reads as on,
+    // and only the owner ticking it again widens what the directory may show.
+    if (
+      discoverStatus.declaredMode === "featured" &&
+      discoverStatus.publicPostCount > 0 &&
+      discoverStatus.featuredPostCount === 0
+    ) {
+      statusLines.push(
+        i18n._(
+          msg({
+            message:
+              "This site still limits Discover to featured posts, and no post is marked Featured, so your feed carries nothing to show. Untick and tick the box to let Discover read every public post.",
+            comment:
+              "@context: Discover status line for a site that chose the old featured-only mode and has no featured posts. Says how to move to the current setting, which reads every public post.",
+          }),
+        ),
+      );
+    }
+
+    if (!discoverStatus.established) {
+      statusLines.push(
+        i18n._(
+          msg({
+            message:
+              "Nothing published yet. jant.me lists a blog once it has {minCount, plural, one {one public post} other {# public posts}}.",
+            comment:
+              "@context: Discover status line when the site does not meet the directory's threshold yet. Stated as jant.me's rule, because a directory of your own may decide differently.",
+          }),
+          { minCount: discoverStatus.minPublicPosts },
+        ),
+      );
+    }
+  }
+
+  const statusView = {
+    lines: statusLines,
+    // The button covers both halves of "the directory has not heard from us":
+    // an announcement that failed, and one that was never made — a site whose
+    // mode came from the deployment default has nothing else to send it with.
+    // The manual form, by contrast, is offered only when the automatic path
+    // failed. Shown next to a working announcement it would read as a normal
+    // route in, which is what made it look like the primary one.
+    showAnnounce:
+      discoverStatus.announced !== true &&
+      discoverStatus.hasDirectory &&
+      !discoverStatus.managedByHost &&
+      discoverStatus.declaredMode !== "none",
+    submitUrl:
+      discoverStatus.announced === false && !discoverStatus.managedByHost
+        ? discoverStatus.submitUrl
+        : null,
+  };
+
   return (
     <>
       <div class="flex flex-col max-w-form">
         <jant-settings-general
           labels={labels}
           timezones={timezonesJson}
-          cjk-fonts={cjkFontsJson}
-          dashboard-languages={dashboardLanguagesJson}
           sitename-fallback={siteNameFallback}
           sitedescription-fallback={siteDescriptionFallback}
           main-feed-url={mainFeedUrl}
           latest-feed-url={latestFeedUrl}
           featured-feed-url={featuredFeedUrl}
           archive-feed-url={archiveFeedUrl}
+          feeds-docs-url={FEEDS_DOCS_URL}
           demo-mode={demoMode || undefined}
+          discover-default={discoverDefault}
+          discover-pages={
+            discoverPages ? JSON.stringify(discoverPages) : undefined
+          }
+          discover-status={JSON.stringify(statusView)}
+          feeds-enabled={rssFeedsEnabled || undefined}
           about-page={aboutPageJson}
           about-edit-url={aboutEditUrl}
           about-create-url={aboutCreateUrl}