@shortlink-org/portolan 0.1.0 → 0.2.0

package/src/pages/settings/PreferencesSettings.tsx

@@ -0,0 +1,101 @@
+import { Moon, Rows2, Rows4, Sun } from "lucide-react";
+import { useDensity } from "../../app/density";
+import { useTheme } from "../../app/theme";
+import { ChatSection } from "../../chat/ChatSettings";
+import { BUILD as CHAT_BUILD } from "../../chat/flags";
+import { useEditorStore } from "../../components/EditorLink";
+import { Select } from "../../components/Select";
+import { EDITORS } from "../../lib/editor-link";
+import { parseEditor } from "../../lib/editor-prefs";
+import { SectionTitle } from "../../components/PageHeader";
+
+function EditorChoice() {
+  const editor = useEditorStore((state) => state.editor);
+  const setEditor = useEditorStore((state) => state.set);
+  const options = EDITORS.map((item) => ({
+    value: item.id,
+    label: item.name,
+  }));
+  return (
+    <div className="rounded-card border border-line p-card shadow-xs">
+      <div className="label mb-3">open source in</div>
+      <Select
+        value={editor}
+        options={options}
+        onChange={(value) => setEditor(parseEditor(value))}
+        label="Editor for source links"
+        menuWidth={200}
+      />
+      <p className="mono mt-2 text-muted">Used by the edit links in local mode.</p>
+    </div>
+  );
+}
+
+function Appearance() {
+  const { theme, toggle: toggleTheme } = useTheme();
+  const { density, toggle: toggleDensity } = useDensity();
+  return (
+    <div className="grid gap-grid sm:grid-cols-2 xl:grid-cols-3">
+      <div className="rounded-card border border-line p-card shadow-xs">
+        <div className="label mb-3">theme</div>
+        <div className="seg inline-flex" role="group" aria-label="Theme">
+          <button
+            type="button"
+            aria-pressed={theme === "dark"}
+            onClick={() => theme !== "dark" && toggleTheme()}
+            className={`flex items-center gap-1.5 ${theme === "dark" ? "is-on" : ""}`}
+          >
+            <Moon size={15} aria-hidden /> dark
+          </button>
+          <button
+            type="button"
+            aria-pressed={theme === "light"}
+            onClick={() => theme !== "light" && toggleTheme()}
+            className={`flex items-center gap-1.5 ${theme === "light" ? "is-on" : ""}`}
+          >
+            <Sun size={15} aria-hidden /> light
+          </button>
+        </div>
+      </div>
+      <div className="rounded-card border border-line p-card shadow-xs">
+        <div className="label mb-3">row density</div>
+        <div className="seg inline-flex" role="group" aria-label="Row density">
+          <button
+            type="button"
+            aria-pressed={density === "comfortable"}
+            onClick={() => density !== "comfortable" && toggleDensity()}
+            className={`flex items-center gap-1.5 ${density === "comfortable" ? "is-on" : ""}`}
+          >
+            <Rows4 size={15} aria-hidden /> comfortable
+          </button>
+          <button
+            type="button"
+            aria-pressed={density === "compact"}
+            onClick={() => density !== "compact" && toggleDensity()}
+            className={`flex items-center gap-1.5 ${density === "compact" ? "is-on" : ""}`}
+          >
+            <Rows2 size={15} aria-hidden /> compact
+          </button>
+        </div>
+      </div>
+      <EditorChoice />
+    </div>
+  );
+}
+
+export function PreferencesSettings() {
+  return (
+    <div className="space-y-section">
+      <section>
+        <SectionTitle right="stored in this browser">Appearance</SectionTitle>
+        <Appearance />
+      </section>
+      {CHAT_BUILD.built ? (
+        <section>
+          <SectionTitle right="stored in this browser">Ask the catalog</SectionTitle>
+          <ChatSection />
+        </section>
+      ) : null}
+    </div>
+  );
+}

package/src/routes.test.ts

@@ -6,6 +6,7 @@ import {
   allCatalogPaths,
   blockPath,
   eventPath,
+  isLandingPath,
   isRoutable,
   paths,
   servicePath,
@@ -18,6 +19,14 @@ import { allAggregates, allStores, allViews, enumsOf } from "./catalog";
 import { registryCatalog } from "./lib/scenarios";
 
 describe("routes", () => {
+  it("routes the public landing page", () => {
+    expect(paths.landing()).toBe("/landing");
+    expect(isLandingPath("/landing")).toBe(true);
+    expect(isLandingPath("/landing/")).toBe(true);
+    expect(isRoutable(paths.landing())).toBe(true);
+    expect(isRoutable("/landing/")).toBe(true);
+  });
+
   it("routes every URL the catalog can produce", () => {
     const unroutable = allCatalogPaths(catalog).filter((p) => !isRoutable(p));
     expect(unroutable).toEqual([]);
@@ -157,6 +166,17 @@ describe("routes", () => {
   it("routes the build settings page", () => {
     expect(paths.settings()).toBe("/settings");
     expect(isRoutable(paths.settings())).toBe(true);
+    expect(paths.settingsProjects()).toBe("/settings/projects");
+    expect(paths.settingsPipeline()).toBe("/settings/pipeline");
+    expect(paths.settingsDelivery()).toBe("/settings/delivery");
+    expect(paths.settingsPreferences()).toBe("/settings/preferences");
+    for (const path of [
+      paths.settingsProjects(),
+      paths.settingsPipeline(),
+      paths.settingsDelivery(),
+      paths.settingsPreferences(),
+    ]) expect(isRoutable(path)).toBe(true);
+    expect(isRoutable("/settings/nope")).toBe(false);
     expect(allCatalogPaths(catalog)).toContain(paths.settings());
   });
 

package/src/routes.ts

@@ -8,6 +8,7 @@ import { selectionHash } from "./selection/hash";
 import { flowStepId } from "./selection/model";
 
 export const paths = {
+  landing: () => "/landing",
   overview: () => "/",
   flows: () => "/flows",
   flow: (slug: string) => `/flows/${slug}`,
@@ -41,6 +42,10 @@ export const paths = {
   problems: () => "/problems",
   changes: () => "/changes",
   settings: () => "/settings",
+  settingsProjects: () => "/settings/projects",
+  settingsPipeline: () => "/settings/pipeline",
+  settingsDelivery: () => "/settings/delivery",
+  settingsPreferences: () => "/settings/preferences",
   external: (slug: string) => `/externals/${slug}`,
   registry: () => "/registry",
   /**
@@ -103,6 +108,11 @@ export const paths = {
     `/c/${contextId}/${serviceSlug}/data/${storeSlug}`,
 } as const;
 
+/** GitHub Pages canonicalizes extensionless routes with a trailing slash. */
+export function isLandingPath(pathname: string): boolean {
+  return /^\/landing\/?$/.test(pathname);
+}
+
 /** The section anchors on an aggregate page, as used by the building-blocks strip. */
 export const AGGREGATE_ANCHOR = {
   entities: "bb-entities",
@@ -201,6 +211,7 @@ export const OVERVIEW_ANCHOR = {
   landscape: "landscape",
   contexts: "contexts",
   flows: "flows-by-reach",
+  problems: "problems",
 } as const;
 
 /** Path to the page that owns an event, or null if the event is not in the catalog. */
@@ -355,6 +366,7 @@ export function backlinkPath(link: Backlink): string | null {
 
 /** Route patterns declared in App.tsx, in the same order. */
 const ROUTES: RegExp[] = [
+  /^\/landing\/?$/,
   /^\/$/,
   /^\/flows$/,
   /^\/flows\/[^/]+$/,
@@ -362,7 +374,7 @@ const ROUTES: RegExp[] = [
   /^\/language$/,
   /^\/problems$/,
   /^\/changes$/,
-  /^\/settings$/,
+  /^\/settings(?:\/(?:projects|pipeline|delivery|preferences))?$/,
   /^\/externals\/[^/]+$/,
   /^\/map$/,
   /^\/adrs\/[^/]+$/,

package/vite.config.ts

@@ -111,17 +111,11 @@ const buildInfo = {
 // the executable commands or arbitrary options in portolan.json. Reduce the
 // manifest here, while building, and expose only the read-only inventory the
 // Settings page needs.
-const manifestText = readFileSync(
-  resolve(workspace, "portolan.json"),
-  "utf8",
-);
+const manifestText = readFileSync(resolve(workspace, "portolan.json"), "utf8");
 let buildReport: unknown;
 try {
   buildReport = JSON.parse(
-    readFileSync(
-      resolve(workspace, ".portolan/build-report.json"),
-      "utf8",
-    ),
+    readFileSync(resolve(workspace, ".portolan/build-report.json"), "utf8"),
   ) as unknown;
 } catch {
   // A clean checkout has no run to report yet. Settings says so explicitly.
@@ -141,6 +135,16 @@ export default defineConfig({
     // .portolan. Their tsconfig files and generated output are inputs to the
     // local control plane, not another Vite application to hot-reload.
     watch: { ignored: ["**/.portolan/**"] },
+    proxy: {
+      "/api/portolan-chat": {
+        target: "https://portolan-chat.batazor.workers.dev",
+        changeOrigin: true,
+        rewrite: () => "/chat",
+        // The browser talks to Vite on the same origin. Vite talks to the
+        // worker as the public demo, whose origin is deliberately allowlisted.
+        headers: { Origin: "https://shortlink-org.github.io" },
+      },
+    },
   },
   define: {
     __BUILD_INFO__: JSON.stringify(buildInfo),

package/catalog/enum_test.go

@@ -1,46 +0,0 @@
-package catalog
-
-import (
-	"encoding/json"
-	"testing"
-)
-
-// An enum round-trips whole: the aggregate's list, the values with their
-// docs, the deprecation marks - and the proto side's numbers. The fixture is
-// literal rather than read from a catalog so that the test says exactly what
-// the mirror is expected to keep.
-func TestEnumRoundTrip(t *testing.T) {
-	raw := `{"id":"a","slug":"a","name":"A","readme":"","root":"A","entities":[],"valueObjects":[],"operations":[],"events":[],
-		"enums":[{"id":"shop.oms.order.status","slug":"status","name":"Status","doc":"Where an order is.","deprecated":true,
-		"values":[{"name":"placed","doc":"just in"},{"name":"legacy","doc":"","deprecated":true}]}]}`
-
-	var agg Aggregate
-	if err := json.Unmarshal([]byte(raw), &agg); err != nil {
-		t.Fatal(err)
-	}
-	if len(agg.Enums) != 1 || agg.Enums[0].ID != "shop.oms.order.status" || !agg.Enums[0].Deprecated {
-		t.Fatalf("enum not read: %+v", agg.Enums)
-	}
-	if got := agg.Enums[0].Values; len(got) != 2 || got[0].Name != "placed" || !got[1].Deprecated {
-		t.Fatalf("values not read: %+v", got)
-	}
-
-	out, err := json.Marshal(agg)
-	if err != nil {
-		t.Fatal(err)
-	}
-	var before, after any
-	_ = json.Unmarshal([]byte(raw), &before)
-	_ = json.Unmarshal(out, &after)
-	if diffs := compare("aggregate", normalize(before), normalize(after)); len(diffs) != 0 {
-		t.Fatalf("round trip lost something: %v", diffs)
-	}
-
-	var svc RpcService
-	if err := json.Unmarshal([]byte(`{"id":"shop.v1.OrderService","methods":[],"source":"","enums":[{"name":"Status","values":[{"name":"STATUS_UNSPECIFIED","number":0},{"name":"PLACED","number":1,"doc":"in"}]}]}`), &svc); err != nil {
-		t.Fatal(err)
-	}
-	if len(svc.Enums) != 1 || svc.Enums[0].Values[1].Number != 1 || svc.Enums[0].Values[0].Number != 0 {
-		t.Fatalf("proto enum not read: %+v", svc.Enums)
-	}
-}