@sjolystinnovation/app-kit 0.10.0 → 0.12.0

package/README.md

@@ -28,7 +28,7 @@ const nextConfig: NextConfig = {
 };
 ```
 
-The components in `@sjolystinnovation/app-kit/ui` and `session/react` are styled with Tailwind CSS.
+The components in `@sjolystinnovation/app-kit/ui`, `markdown` and `session/react` are styled with Tailwind CSS.
 Import the package's stylesheet after Tailwind:
 
 ```css
@@ -348,6 +348,36 @@ The pieces are exported too: `securityHeaders(options)`, `contentSecurityPolicy(
 `apiBaseUrl(apiUrl)`. Scripts allow `'unsafe-inline'`, since a nonce would make every statically
 rendered page dynamic.
 
+### `@sjolystinnovation/app-kit/markdown`
+
+Renders Markdown from an editor or the API, with GitHub tables, task lists and footnotes. Raw HTML is
+never rendered and the output is sanitized, so the text cannot inject scripts, styles, event
+handlers or `javascript:` links. It works in a server component. It needs `react-markdown`,
+`remark-gfm` and `rehype-sanitize`, which are optional peer dependencies:
+
+```sh
+npm install react-markdown remark-gfm rehype-sanitize
+```
+
+```tsx
+import { Markdown } from "@sjolystinnovation/app-kit/markdown";
+
+<div className="space-y-4 text-sm text-gray-700">
+  <Markdown>{build.description}</Markdown>
+</div>;
+```
+
+| Prop | Type | Default | Description |
+| --- | --- | --- | --- |
+| `children` | `string \| null \| undefined` | | The Markdown. Empty, null or undefined renders nothing. |
+| `components` | `Components` | | Replaces the element for a tag, such as `{ p: MyParagraph }`. Tags not named keep the default. It gets the props without `node`, so it can spread them onto an element. |
+| `externalLinks` | `boolean` | `false` | Opens `http` and `https` links in a new tab with `rel="noopener noreferrer"`. Site-relative links stay in the tab. |
+| `className` | `string` | | Wraps the output in a `div` with these classes. Without it the elements render bare, so a parent's `space-y-*` spaces them. |
+
+The text takes its colour and size from the parent. A level one heading becomes a level two, since
+the page has its own `h1`. `markdownComponents` holds the default elements, for an app that builds
+on them.
+
 ### `@sjolystinnovation/app-kit/session`
 
 Decides when a user has to sign in again. Safe to import from server code, such as the next-auth
@@ -660,6 +690,70 @@ import { Alert } from "@sjolystinnovation/app-kit/ui";
 | `className` | `string` | | Classes for placing the alert, such as a margin. Restyle it through the theme variables. A clashing class wins or loses by the order Tailwind emits them in. |
 | `children` | `ReactNode` | | Content. |
 
+### `ContentImage`
+
+From `@sjolystinnovation/app-kit/ui`. An uploaded image from the content API, as a plain `<img>`
+with a `srcset` of the widths the API serves. It goes through the content images rewrite from
+`defineAppConfig({ contentImages: true })`, so the browser never contacts the API host. It works in
+a server component.
+
+```tsx
+<ContentImage imageId={post.imageId} alt={post.title} sizes="(min-width: 768px) 50vw, 100vw" />
+<ContentImage imageId={hero.imageId} fallbackSrc="/hero.jpg" alt="" sizes="100vw" priority aria-hidden />
+```
+
+| Prop | Type | Default | Description |
+| --- | --- | --- | --- |
+| `imageId` | `string \| null` | | Uploaded image id. Null or empty shows `fallbackSrc` as it is, with no `srcset`. |
+| `alt` | `string` | | Empty for a decorative image. |
+| `sizes` | `string` | | Widths the image is shown at. Required, since a browser assumes `100vw` without it. |
+| `fallbackSrc` | `string` | | A static path for when there is no uploaded image. With neither, nothing renders. |
+| `priority` | `boolean` | `false` | For the one image visible without scrolling. It loads eagerly, at high priority. |
+| `width`, `height` | `number` | | Intrinsic size, to reserve space where the layout fixes no ratio. |
+| `base` | `string` | `"/content-images"` | Path the content images rewrite serves. |
+| `widths` | `number[]` | `CONTENT_IMAGE_WIDTHS` | Widths in the `srcset`. |
+| `className` | `string` | | Classes on the `<img>`. |
+
+`contentImagePath(id, base?)` and `contentImageSrcSet(id, widths?, base?)` build the same URLs for
+other uses, such as a CSS background or an Open Graph image.
+
+### `ErrorState`
+
+From `@sjolystinnovation/app-kit/ui`. What an `error.tsx` shows. It is a client component, as an
+error boundary has to be.
+
+```tsx
+"use client";
+
+export default function Error({ reset }: { error: Error; reset: () => void }) {
+  return <ErrorState reset={reset} homeHref="/" />;
+}
+```
+
+| Prop | Type | Description |
+| --- | --- | --- |
+| `reset` | `() => void` | The `reset` Next passes to `error.tsx`. The try again button calls it. |
+| `homeHref` | `string` | Where the front page link goes, such as `/` or `/en`. |
+| `strings` | `TextOverrides<ErrorStateStrings>` | `title`, `body`, `tryAgain` and `home`. |
+| `className` | `string` | Classes for placing it, on the outer element. |
+
+The error itself is never shown.
+
+### `NotFoundState`
+
+From `@sjolystinnovation/app-kit/ui`. What a `not-found.tsx` shows: a large code, the message as
+the page's heading, and a link home. It works in a server component.
+
+```tsx
+<NotFoundState homeHref="/no" strings={{ body: dict.notFound, home: dict.toFrontPage }} />
+```
+
+| Prop | Type | Description |
+| --- | --- | --- |
+| `homeHref` | `string` | Where the home link goes. |
+| `strings` | `TextOverrides<NotFoundStrings>` | `code`, `body` and `home`. |
+| `className` | `string` | Classes for placing it, on the outer element. |
+
 ### `PasswordInput`
 
 A labelled password field with a button that shows and hides the value. It also takes the other
@@ -767,6 +861,16 @@ selector such as `.dark` for a scoped theme:
 | `--color-dialog-bg` | white |
 | `--color-dialog-title` | gray 900 |
 | `--color-dialog-text` | gray 600 |
+| `--color-state-heading` | gray 900, the heading of an `ErrorState` |
+| `--color-state-text` | gray 600, the text of an `ErrorState` or `NotFoundState` |
+| `--color-state-code` | gray 900, the code of a `NotFoundState` |
+| `--font-state-code` | `inherit`, the font of that code |
+| `--color-state-link`, `-hover` | gray 900, the home link |
+| `--color-markdown-heading`, `-strong` | gray 900, headings and bold text in `Markdown` |
+| `--color-markdown-link` | gray 900 |
+| `--color-markdown-link-hover` | gray 600 |
+| `--color-markdown-border` | gray 200, rules, quotes and table lines |
+| `--color-markdown-code-bg`, `-code-text` | gray 100, gray 900 |
 
 A default that points at another variable is read once for the whole page. The focus ring and the
 primary button point at `--color-primary` and `--color-primary-foreground`. A scoped theme that

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sjolystinnovation/app-kit",
-  "version": "0.10.0",
+  "version": "0.12.0",
   "description": "Building blocks for Next.js apps that sign in against a JWT API through next-auth",
   "license": "Apache-2.0",
   "author": "Sjølyst Innovation AS",
@@ -26,6 +26,7 @@
     "./toast": "./src/toast/index.ts",
     "./validation": "./src/validation/index.ts",
     "./next-config": "./src/next-config/index.ts",
+    "./markdown": "./src/markdown/index.ts",
     "./styles.css": "./src/styles.css"
   },
   "files": [
@@ -46,6 +47,9 @@
     "next-auth": "^4.24",
     "react": "^19",
     "react-dom": "^19",
+    "react-markdown": "^10",
+    "rehype-sanitize": "^6",
+    "remark-gfm": "^4",
     "sonner": "^2",
     "zod": "^4"
   },
@@ -55,6 +59,15 @@
     },
     "zod": {
       "optional": true
+    },
+    "react-markdown": {
+      "optional": true
+    },
+    "rehype-sanitize": {
+      "optional": true
+    },
+    "remark-gfm": {
+      "optional": true
     }
   },
   "devDependencies": {
@@ -71,6 +84,9 @@
     "next-auth": "^4.24.15",
     "react": "^19.3.0",
     "react-dom": "^19.3.0",
+    "react-markdown": "^10.1.0",
+    "rehype-sanitize": "^6.0.0",
+    "remark-gfm": "^4.0.1",
     "sonner": "^2.0.8",
     "typescript": "^6.0.3",
     "vitest": "^5.0.3",
@@ -85,7 +101,7 @@
     "tailwindcss"
   ],
   "dependencies": {
-    "@types/jsonwebtoken": "^9.0.8",
-    "jsonwebtoken": "^9.0.2"
+    "@types/jsonwebtoken": "^9.0.10",
+    "jsonwebtoken": "^9.0.3"
   }
 }

package/src/markdown/Markdown.tsx

@@ -0,0 +1,89 @@
+import type { ComponentPropsWithoutRef, ElementType } from "react";
+import ReactMarkdown, { type Components, type ExtraProps } from "react-markdown";
+import rehypeSanitize from "rehype-sanitize";
+import remarkGfm from "remark-gfm";
+
+type Tag = keyof React.JSX.IntrinsicElements;
+
+/** The props without the `node` react-markdown passes, which is no DOM attribute. */
+function domProps<P extends ExtraProps>(props: P): Omit<P, "node"> {
+  const rest = { ...props };
+  delete rest.node;
+  return rest;
+}
+
+/** An app's element, given the props without `node`, so it can spread them onto a DOM element. */
+function withoutNode(Element: ElementType) {
+  const Wrapped = (props: ExtraProps) => <Element {...domProps(props)} />;
+  return Wrapped;
+}
+
+/** An element with fixed classes. */
+function styled<T extends Tag>(Element: T, className: string) {
+  const Styled = (props: ComponentPropsWithoutRef<T> & ExtraProps) => {
+    const Component = Element as ElementType;
+    return <Component className={className} {...domProps(props)} />;
+  };
+  return Styled;
+}
+
+/** The default look. A heading level one becomes a level two, since the page has its own `h1`. */
+export const markdownComponents: Components = {
+  h1: styled("h2", "text-lg font-semibold text-markdown-heading"),
+  h2: styled("h2", "text-base font-semibold text-markdown-heading pt-2"),
+  h3: styled("h3", "text-sm font-semibold text-markdown-heading"),
+  p: styled("p", "leading-relaxed"),
+  ul: styled("ul", "list-disc list-outside pl-5 space-y-1"),
+  ol: styled("ol", "list-decimal list-outside pl-5 space-y-1"),
+  li: styled("li", "leading-relaxed"),
+  a: styled("a", "font-medium text-markdown-link underline hover:text-markdown-link-hover"),
+  strong: styled("strong", "font-semibold text-markdown-strong"),
+  hr: styled("hr", "border-markdown-border"),
+  blockquote: styled("blockquote", "border-l-2 border-markdown-border pl-4 italic"),
+  code: styled("code", "rounded bg-markdown-code-bg px-1 py-0.5 text-xs font-mono text-markdown-code-text"),
+  table: props => (
+    <div className="overflow-x-auto">
+      <table className="w-full text-xs border-collapse" {...domProps(props)} />
+    </div>
+  ),
+  thead: styled("thead", "border-b border-markdown-border"),
+  tbody: styled("tbody", "divide-y divide-markdown-border"),
+  th: styled("th", "text-left py-2 pr-4 font-semibold text-markdown-heading"),
+  td: styled("td", "py-2 pr-4 align-top"),
+};
+
+const isExternal = (href: string | undefined) => href != null && /^https?:\/\//i.test(href);
+
+export interface MarkdownProps {
+  /** Markdown text. Empty, null or undefined renders nothing. */
+  children: string | null | undefined;
+  /** Replaces the default element for a tag, such as `{ p: MyParagraph }`. It gets the props without `node`. */
+  components?: Components | undefined;
+  /** Opens links to other sites in a new tab, without passing the opener or referrer. */
+  externalLinks?: boolean | undefined;
+  /** Wraps the output in a `div` with these classes. Without it the elements render bare, so a parent's `space-y-*` spaces them. */
+  className?: string | undefined;
+}
+
+/**
+ * Markdown from an editor or the API, with GitHub tables, lists and links. Raw HTML is never
+ * rendered, and the output is sanitized, so the text cannot inject scripts, styles or event handlers.
+ */
+export function Markdown({ children, components, externalLinks = false, className }: MarkdownProps) {
+  if (!children) return null;
+
+  const own = Object.entries(components ?? {}).map(([tag, Element]) => [tag, withoutNode(Element as ElementType)]);
+  const merged: Components = { ...markdownComponents, ...Object.fromEntries(own) };
+  if (externalLinks) {
+    const Link = (merged.a ?? "a") as ElementType;
+    merged.a = props =>
+      isExternal(props.href) ? <Link {...props} target="_blank" rel="noopener noreferrer" /> : <Link {...props} />;
+  }
+
+  const output = (
+    <ReactMarkdown remarkPlugins={[remarkGfm]} rehypePlugins={[rehypeSanitize]} components={merged}>
+      {children}
+    </ReactMarkdown>
+  );
+  return className === undefined ? output : <div className={className}>{output}</div>;
+}

package/src/markdown/index.ts

@@ -0,0 +1 @@
+export { Markdown, markdownComponents, type MarkdownProps } from "./Markdown";

package/src/styles.css

@@ -45,6 +45,21 @@
   --color-toggle-off: var(--color-gray-200);
   --color-toggle-thumb: var(--color-white);
 
+  --color-state-heading: var(--color-gray-900);
+  --color-state-text: var(--color-gray-600);
+  --color-state-code: var(--color-gray-900);
+  --font-state-code: inherit;
+  --color-state-link: var(--color-gray-900);
+  --color-state-link-hover: var(--color-gray-900);
+
+  --color-markdown-heading: var(--color-gray-900);
+  --color-markdown-strong: var(--color-gray-900);
+  --color-markdown-link: var(--color-gray-900);
+  --color-markdown-link-hover: var(--color-gray-600);
+  --color-markdown-border: var(--color-gray-200);
+  --color-markdown-code-bg: var(--color-gray-100);
+  --color-markdown-code-text: var(--color-gray-900);
+
   --radius-button: var(--radius-lg);
   --color-button-primary-bg: var(--color-primary);
   --color-button-primary-text: var(--color-primary-foreground);

package/src/ui/ContentImage.tsx

@@ -0,0 +1,73 @@
+/** The widths the API serves an uploaded image at, as webp. */
+export const CONTENT_IMAGE_WIDTHS: readonly number[] = [384, 640, 768, 1024, 1366, 1600];
+
+/** Where the browser fetches an uploaded image. Site-relative, through the app's content images rewrite. */
+export function contentImagePath(id: string, base = "/content-images"): string {
+  return `${base}/${encodeURIComponent(id)}`;
+}
+
+/**
+ * The `srcset` for an uploaded image. The API serves the nearest webp at or above the requested
+ * width, or the original when the browser does not accept webp.
+ */
+export function contentImageSrcSet(id: string, widths: readonly number[] = CONTENT_IMAGE_WIDTHS, base?: string): string {
+  return widths.map(w => `${contentImagePath(id, base)}?w=${w} ${w}w`).join(", ");
+}
+
+export interface ContentImageProps {
+  /** Uploaded image id. Null falls back to `fallbackSrc`, which is served as it is. */
+  imageId: string | null;
+  /** Empty for an image that carries no meaning of its own, such as a decorative backdrop. */
+  alt: string;
+  /** Widths the image is shown at. Required, since a browser assumes 100vw without it. */
+  sizes: string;
+  /** A static path for when there is no uploaded image. */
+  fallbackSrc?: string | undefined;
+  className?: string | undefined;
+  /** Intrinsic size, to reserve space. Only needed where the layout fixes no ratio. */
+  width?: number | undefined;
+  height?: number | undefined;
+  /** Set on the one image visible without scrolling. It loads eagerly, at high priority. */
+  priority?: boolean | undefined;
+  "aria-hidden"?: boolean | undefined;
+  /** Path the content images rewrite serves, `/content-images` by default. */
+  base?: string | undefined;
+  /** Widths in the `srcset`. Defaults to the widths the API serves. */
+  widths?: readonly number[] | undefined;
+}
+
+/** An image from the content API, served responsively from the `sizes` a call site declares. */
+export function ContentImage({
+  imageId,
+  alt,
+  sizes,
+  fallbackSrc,
+  className,
+  width,
+  height,
+  priority = false,
+  "aria-hidden": ariaHidden,
+  base,
+  widths,
+}: ContentImageProps) {
+  const uploaded = imageId != null && imageId !== "";
+  const src = uploaded ? contentImagePath(imageId, base) : fallbackSrc;
+  if (!src) return null;
+
+  return (
+    // A plain img, because the API already serves the sizes. next/image would resize them again.
+    <img
+      src={src}
+      srcSet={uploaded ? contentImageSrcSet(imageId, widths, base) : undefined}
+      sizes={uploaded ? sizes : undefined}
+      alt={alt}
+      className={className}
+      width={width}
+      height={height}
+      loading={priority ? "eager" : "lazy"}
+      fetchPriority={priority ? "high" : undefined}
+      decoding={priority ? "sync" : "async"}
+      aria-hidden={ariaHidden}
+    />
+  );
+}

package/src/ui/ErrorState.tsx

@@ -0,0 +1,52 @@
+"use client";
+
+import Link from "next/link";
+import { cx } from "./cx";
+import { withDefaults, type TextOverrides } from "./withDefaults";
+
+export interface ErrorStateStrings {
+  title: string;
+  body: string;
+  tryAgain: string;
+  home: string;
+}
+
+export const defaultErrorStateStrings: ErrorStateStrings = {
+  title: "Temporarily unavailable",
+  body: "We can't reach the service right now. Please try again shortly.",
+  tryAgain: "Try again",
+  home: "Go to the front page",
+};
+
+export interface ErrorStateProps {
+  /** The `reset` Next passes to an `error.tsx`. It renders the page again. */
+  reset: () => void;
+  /** Where the front page link goes, such as `/` or `/en`. */
+  homeHref: string;
+  strings?: TextOverrides<ErrorStateStrings> | undefined;
+  /** Classes for placing it, on the outer element. */
+  className?: string | undefined;
+}
+
+/** What an `error.tsx` shows when a page cannot be rendered. The response is still a 500. */
+export function ErrorState({ reset, homeHref, strings, className }: ErrorStateProps) {
+  const text = withDefaults(defaultErrorStateStrings, strings);
+  return (
+    <div className={cx("min-h-[60vh] flex flex-col items-center justify-center gap-4 px-4 text-center", className)}>
+      <h1 className="text-3xl font-black text-state-heading">{text.title}</h1>
+      <p className="text-lg text-state-text max-w-md">{text.body}</p>
+      <div className="mt-2 flex flex-wrap items-center justify-center gap-4">
+        <button
+          type="button"
+          onClick={reset}
+          className="rounded-button bg-button-primary-bg text-button-primary-text font-semibold px-6 py-3 hover:brightness-95 transition"
+        >
+          {text.tryAgain}
+        </button>
+        <Link href={homeHref} className="font-semibold text-state-link hover:text-state-link-hover underline">
+          {text.home}
+        </Link>
+      </div>
+    </div>
+  );
+}

package/src/ui/NotFoundState.tsx

@@ -0,0 +1,37 @@
+import Link from "next/link";
+import { cx } from "./cx";
+import { withDefaults, type TextOverrides } from "./withDefaults";
+
+export interface NotFoundStrings {
+  code: string;
+  body: string;
+  home: string;
+}
+
+export const defaultNotFoundStrings: NotFoundStrings = {
+  code: "404",
+  body: "This page does not exist.",
+  home: "Go home",
+};
+
+export interface NotFoundStateProps {
+  /** Where the home link goes, such as `/` or `/en`. */
+  homeHref: string;
+  strings?: TextOverrides<NotFoundStrings> | undefined;
+  /** Classes for placing it, on the outer element. */
+  className?: string | undefined;
+}
+
+/** What a `not-found.tsx` shows. The message is the page's heading. */
+export function NotFoundState({ homeHref, strings, className }: NotFoundStateProps) {
+  const text = withDefaults(defaultNotFoundStrings, strings);
+  return (
+    <div className={cx("min-h-[60vh] flex flex-col items-center justify-center gap-4 px-4 text-center", className)}>
+      <span className="text-6xl font-black font-state-code text-state-code">{text.code}</span>
+      <h1 className="text-lg text-state-text">{text.body}</h1>
+      <Link href={homeHref} className="font-semibold text-state-link hover:text-state-link-hover underline">
+        {text.home}
+      </Link>
+    </div>
+  );
+}

package/src/ui/index.ts

@@ -1,9 +1,15 @@
 export { Alert } from "./Alert";
 export type { AlertProps } from "./Alert";
+export { ContentImage, CONTENT_IMAGE_WIDTHS, contentImagePath, contentImageSrcSet } from "./ContentImage";
+export type { ContentImageProps } from "./ContentImage";
 export { CredentialsForm } from "./CredentialsForm";
 export type { CredentialsFormProps } from "./CredentialsForm";
 export { SignInRejected, defaultCredentialsFormStrings } from "./credentialsFormStrings";
 export type { CredentialsFormStrings } from "./credentialsFormStrings";
+export { ErrorState, defaultErrorStateStrings } from "./ErrorState";
+export type { ErrorStateProps, ErrorStateStrings } from "./ErrorState";
+export { NotFoundState, defaultNotFoundStrings } from "./NotFoundState";
+export type { NotFoundStateProps, NotFoundStrings } from "./NotFoundState";
 export { PasswordInput } from "./PasswordInput";
 export type { PasswordInputProps } from "./PasswordInput";
 export { TextArea } from "./TextArea";