@twango/twiki 0.0.0-stage → 0.1.0-rc.0

package/site/src/routes/admin/access/+page.svelte

@@ -0,0 +1,118 @@
+<script lang="ts">
+	import { site } from '$lib/config';
+	import { enhance } from '$app/forms';
+	import type { SubmitFunction } from '@sveltejs/kit';
+	import { lookupGithubUser } from '$lib/github-user';
+	import ShieldCheck from '@lucide/svelte/icons/shield-check';
+	import UserPlus from '@lucide/svelte/icons/user-plus';
+	import type { PageProps } from './$types';
+
+	let { data, form }: PageProps = $props();
+	let adding = $state(false);
+	let lookupError = $state('');
+
+	const addAccess: SubmitFunction = async ({ formData, cancel }) => {
+		if (adding) return cancel();
+		adding = true;
+		lookupError = '';
+		form = null;
+		const result = await lookupGithubUser(formData.get('username'));
+		if ('error' in result) {
+			lookupError = result.error;
+			adding = false;
+			return cancel();
+		}
+		formData.set('githubId', result.user.id);
+		formData.set('githubLogin', result.user.login);
+		return async ({ update }) => {
+			try {
+				await update();
+			} finally {
+				adding = false;
+			}
+		};
+	};
+</script>
+
+<svelte:head><title>Access · {site.title}</title></svelte:head>
+
+<section class="mx-auto w-full max-w-xl">
+	<header class="mb-6">
+		<h1 class="mb-2 text-3xl font-semibold tracking-tight">Access</h1>
+		<p class="text-sm text-muted">
+			Approved people can read all notes. Only you can manage access.
+		</p>
+	</header>
+
+	<form method="POST" action="?/add" use:enhance={addAccess} class="mb-6">
+		<label for="github-username" class="mb-2 block text-sm font-medium">GitHub username</label>
+		<div class="flex gap-2">
+			<input
+				id="github-username"
+				name="username"
+				disabled={adding}
+				required
+				maxlength="40"
+				autocomplete="off"
+				autocapitalize="none"
+				spellcheck="false"
+				placeholder="username"
+				class="min-w-0 flex-1 rounded-lg border border-border bg-bg px-3 py-2 text-sm outline-none focus:border-accent focus:ring-1 focus:ring-accent"
+			/>
+			<button
+				disabled={adding}
+				class="flex shrink-0 items-center gap-2 rounded-lg bg-text px-3 py-2 text-sm font-medium text-bg focus-visible:outline-2 focus-visible:outline-offset-2 focus-visible:outline-accent"
+				><UserPlus size={16} />{adding ? 'Adding…' : 'Add access'}</button
+			>
+		</div>
+	</form>
+
+	<noscript><p>Enable JavaScript to look up GitHub accounts and add access.</p></noscript>
+	{#if lookupError || form?.error}<p role="alert" class="mb-4 text-sm text-accent">
+			{lookupError || form?.error}
+		</p>{/if}
+	{#if form?.message}<p role="status" class="mb-4 text-sm text-muted">{form.message}</p>{/if}
+
+	<ul
+		class="m-0 list-none divide-y divide-border border-y border-border p-0"
+		aria-label="People with access"
+	>
+		<li class="flex items-center justify-between gap-3 py-4">
+			<div>
+				<p class="font-medium">You</p>
+				<p class="text-xs text-muted">GitHub ID {data.ownerId}</p>
+			</div>
+			<span class="flex items-center gap-1.5 text-xs text-muted"
+				><ShieldCheck size={14} />Owner</span
+			>
+		</li>
+		{#each data.grants as grant (grant.githubId)}
+			<li class="flex items-center justify-between gap-3 py-4">
+				<div class="min-w-0">
+					<a
+						class="font-medium text-text hover:text-accent"
+						href={`https://github.com/${grant.githubLogin}`}
+						target="_blank"
+						rel="noreferrer">@{grant.githubLogin}</a
+					>
+					<p class="text-xs text-muted">GitHub ID {grant.githubId}</p>
+				</div>
+				<form
+					method="POST"
+					action="?/revoke"
+					use:enhance={({ cancel }) => {
+						if (!confirm(`Revoke @${grant.githubLogin}'s access and sign out their sessions?`))
+							cancel();
+					}}
+				>
+					<input type="hidden" name="githubId" value={grant.githubId} />
+					<button
+						class="rounded-md px-2 py-1 text-sm text-muted hover:bg-accent-soft hover:text-accent focus-visible:outline-2 focus-visible:outline-accent"
+						aria-label={`Revoke @${grant.githubLogin}`}>Revoke</button
+					>
+				</form>
+			</li>
+		{/each}
+	</ul>
+	{#if !data.grants.length}<p class="mt-4 text-sm text-muted">Only you have access.</p>{/if}
+</section>

package/site/src/routes/graph.json/+server.ts

@@ -0,0 +1,7 @@
+import type { RequestHandler } from './$types';
+import { requestContent } from '$lib/server/runtime-content';
+export const prerender = import.meta.env.VITE_STATIC_EXPORT === 'true';
+export const GET: RequestHandler = async ({ platform }) =>
+	new Response(JSON.stringify((await requestContent(platform).manifest()).graph), {
+		headers: { 'Content-Type': 'application/json' }
+	});

package/site/src/routes/index.xml/+server.ts

@@ -0,0 +1,7 @@
+import type { RequestHandler } from './$types';
+import { requestContent } from '$lib/server/runtime-content';
+export const prerender = import.meta.env.VITE_STATIC_EXPORT === 'true';
+export const GET: RequestHandler = async ({ platform }) =>
+	new Response((await requestContent(platform).model()).rssXml(), {
+		headers: { 'Content-Type': 'application/rss+xml; charset=utf-8' }
+	});

package/site/src/routes/layout.css

@@ -0,0 +1,10 @@
+@import 'tailwindcss';
+@source not '../../docs';
+@source not '../../tests';
+@source not '../../benchmarks';
+@import '../lib/styles/foundation.css';
+@import '../lib/styles/shell.css';
+@import '../lib/styles/article.css';
+@import '../lib/styles/print.css';
+@plugin '@tailwindcss/typography';
+@custom-variant dark (&:where(:root.dark, :root.dark *));

package/site/src/routes/robots.txt/+server.ts

@@ -0,0 +1,9 @@
+import { site } from '$lib/config';
+
+export const prerender = import.meta.env.VITE_STATIC_EXPORT === 'true';
+
+export function GET() {
+	return new Response(`User-agent: *\nAllow: /\nSitemap: ${site.url}/sitemap.xml\n`, {
+		headers: { 'Content-Type': 'text/plain; charset=utf-8' }
+	});
+}

package/site/src/routes/sitemap.xml/+server.ts

@@ -0,0 +1,7 @@
+import type { RequestHandler } from './$types';
+import { requestContent } from '$lib/server/runtime-content';
+export const prerender = import.meta.env.VITE_STATIC_EXPORT === 'true';
+export const GET: RequestHandler = async ({ platform }) =>
+	new Response((await requestContent(platform).model()).sitemapXml(), {
+		headers: { 'Content-Type': 'application/xml; charset=utf-8' }
+	});

package/site/src/routes/tags/+page.server.ts

@@ -0,0 +1,5 @@
+import type { PageServerLoad } from './$types';
+import { requestContent } from '$lib/server/runtime-content';
+export const load: PageServerLoad = async ({ platform }) => ({
+	tags: (await requestContent(platform).model()).tagIndex()
+});

package/site/src/routes/tags/+page.svelte

@@ -0,0 +1,38 @@
+<script lang="ts">
+	import SEO from '$lib/components/SEO.svelte';
+	import Breadcrumbs from '$lib/components/doc/Breadcrumbs.svelte';
+	import type { PageData } from './$types';
+
+	interface Props {
+		data: PageData;
+	}
+
+	const { data }: Props = $props();
+</script>
+
+<SEO
+	title="Tag Index"
+	description="Browse topics across notes and reference material."
+	canonical="/tags"
+/>
+
+<Breadcrumbs route="tags" current="Tag Index" />
+
+<article class="prose dark:prose-invert max-w-none">
+	<h1>Tag Index</h1>
+	<p class="text-muted">Found {data.tags.length} total tags.</p>
+</article>
+
+<ul class="m-0 mt-4 flex list-none flex-wrap gap-2 p-0">
+	{#each data.tags as { tag, count } (tag)}
+		<li>
+			<a
+				class="inline-flex items-center gap-1.5 rounded-md border border-border px-2.5 py-1 text-sm text-text no-underline transition-colors hover:border-accent hover:text-accent"
+				href={`/tags/${tag}`}
+			>
+				<span>{tag}</span>
+				<span class="text-xs text-muted">{count}</span>
+			</a>
+		</li>
+	{/each}
+</ul>

package/site/src/routes/tags/[...tag]/+page.server.ts

@@ -0,0 +1,22 @@
+import { error } from '@sveltejs/kit';
+import type { EntryGenerator, PageServerLoad } from './$types';
+import { requestContent } from '$lib/server/runtime-content';
+export const entries: EntryGenerator = async () => {
+	if (import.meta.env.VITE_STATIC_EXPORT !== 'true') return [];
+	return Object.keys((await requestContent(undefined).manifest()).tags).map((tag) => ({ tag }));
+};
+export const load: PageServerLoad = async ({ params, platform }) => {
+	const model = await requestContent(platform).model();
+	const pages = model.tagPages(params.tag);
+	if (!pages) error(404, 'Tag not found');
+	return {
+		tag: params.tag,
+		pages: pages.map((p) => ({
+			route: `/${model.displayRoute(p.slug)}`,
+			title: p.title,
+			description: p.description,
+			modified: p.dates.modified,
+			tags: p.tags
+		}))
+	};
+};

package/site/src/routes/tags/[...tag]/+page.svelte

@@ -0,0 +1,52 @@
+<script lang="ts">
+	import SEO from '$lib/components/SEO.svelte';
+	import Breadcrumbs from '$lib/components/doc/Breadcrumbs.svelte';
+	import type { PageData } from './$types';
+
+	interface Props {
+		data: PageData;
+	}
+
+	const { data }: Props = $props();
+
+	function shortDate(iso: string): string {
+		if (!iso) return '';
+		return new Date(iso).toLocaleDateString('en-US', {
+			year: 'numeric',
+			month: 'short',
+			day: 'numeric'
+		});
+	}
+</script>
+
+<SEO
+	title={`Tag: ${data.tag}`}
+	description={`Browse course notes and reference material tagged ${data.tag}.`}
+	canonical={`/tags/${data.tag}`}
+/>
+
+<Breadcrumbs route={`tags/${data.tag}`} current={`Tag: ${data.tag}`} />
+
+<article class="prose dark:prose-invert max-w-none">
+	<h1>Tag: {data.tag}</h1>
+	<p class="text-muted">
+		{data.pages.length}
+		{data.pages.length === 1 ? 'item' : 'items'} with this tag.
+	</p>
+</article>
+
+<ul class="m-0 mt-4 list-none space-y-1 p-0">
+	{#each data.pages as page (page.route)}
+		<li>
+			<a class="block rounded-md px-3 py-2 no-underline hover:bg-surface" href={page.route}>
+				<span class="flex items-baseline justify-between gap-3">
+					<span class="min-w-0 truncate text-sm font-medium text-text">{page.title}</span>
+					<span class="shrink-0 text-xs text-muted">{shortDate(page.modified)}</span>
+				</span>
+				{#if page.description}
+					<span class="mt-0.5 line-clamp-1 block text-xs text-muted">{page.description}</span>
+				{/if}
+			</a>
+		</li>
+	{/each}
+</ul>

package/site/svelte.config.js

@@ -0,0 +1,71 @@
+import site from './src/lib/site-config.json' with { type: 'json' };
+import { staticDirectory } from './tooling/lib/edition-paths.js';
+import adapter from './tooling/adapter.js';
+import { readFileSync } from 'node:fs';
+import { applicationVersion } from './tooling/lib/app-version.js';
+import { emptyTagRoute } from './tooling/lib/empty-tag-route.js';
+
+const prerenderConcurrency = Number(process.env.WISCONSIN_PRERENDER_CONCURRENCY ?? 1);
+if (!Number.isInteger(prerenderConcurrency) || prerenderConcurrency < 1)
+	throw new Error('WISCONSIN_PRERENDER_CONCURRENCY must be a positive integer');
+
+/** @param {string} filename @param {string} value */
+function expectedDiagnostic(filename, value) {
+	try {
+		return JSON.parse(readFileSync(`build/generated/${filename}.json`, 'utf8')).includes(value);
+	} catch {
+		return false;
+	}
+}
+
+/** @type {import('@sveltejs/kit').Config} */
+const config = {
+	compilerOptions: {
+		// Force runes mode everywhere except libraries.
+		runes: ({ filename }) => {
+			if (filename.split(/[/\\]/).includes('node_modules')) return undefined;
+			return true;
+		}
+	},
+	kit: {
+		paths: { relative: process.env.VITE_STATIC_EXPORT === 'true' },
+		outDir: 'build/.svelte-kit',
+		files: { assets: process.env.WISCONSIN_APP_STATIC_DIR ?? staticDirectory(process.cwd()) },
+		adapter: adapter(),
+		// Content is served separately. Rebuilding it should not change the
+		// application version, hydration IDs, and every prerendered HTML asset.
+		version: { name: applicationVersion(process.cwd()) },
+		prerender: {
+			concurrency: prerenderConcurrency,
+			origin: site.url,
+			handleUnseenRoutes: ({ routes, message }) => {
+				if (emptyTagRoute(process.cwd(), routes)) return;
+				if (
+					process.env.VITE_PUBLIC_EDITION === 'true' &&
+					routes.every((route) => ['/tags/[...tag]', '/[course]/files/[...file]'].includes(route))
+				)
+					return;
+				throw new Error(message);
+			},
+			handleHttpError: ({ status, path, referrer, message }) => {
+				if (status === 404 && path === '/login') return;
+				if (status === 404 && expectedDiagnostic('expected-404', path)) {
+					console.warn(`[prerender] unresolved content link: ${path} <- ${referrer}`);
+					return;
+				}
+				throw new Error(message);
+			},
+			handleMissingId: ({ path, id, referrers, message }) => {
+				if (expectedDiagnostic('expected-missing-id', `${path}#${id}`)) {
+					console.warn(
+						`[prerender] unresolved content anchor: ${path}#${id} <- ${referrers.join(', ')}`
+					);
+					return;
+				}
+				throw new Error(message);
+			}
+		}
+	}
+};
+
+export default config;

package/site/tooling/LICENSE-quartz

@@ -0,0 +1,25 @@
+Portions of the content pipeline in this directory (slug.ts, ofm.ts,
+lastmod.ts, autotag.ts and the link-resolution logic) are derived from
+Quartz v4 (https://github.com/jackyzha0/quartz), used under the MIT License:
+
+MIT License
+
+Copyright (c) 2021 jackyzha0
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/site/tooling/adapter.js

@@ -0,0 +1,55 @@
+import cloudflare from '@sveltejs/adapter-cloudflare';
+import { readFileSync, renameSync, writeFileSync } from 'node:fs';
+import path from 'node:path';
+import { prepareWranglerPaths } from './wrangler-paths.js';
+import { indexSearch } from './search.js';
+import { prewarmCloudflareEmulator } from './lib/cloudflare-prewarm.js';
+
+export default function () {
+	const directory = prepareWranglerPaths(path.resolve(import.meta.dirname, '..'));
+	process.env.WRANGLER_CACHE_DIR ??= path.join(directory, 'cache');
+	const adapter = cloudflare({
+		platformProxy: { persist: { path: path.join(directory, 'state/v3') } }
+	});
+	return {
+		...adapter,
+		async emulate() {
+			return prewarmCloudflareEmulator((await adapter.emulate?.()) ?? {});
+		},
+		/** @param {import('@sveltejs/kit').Builder} builder */
+		async adapt(builder) {
+			const started = performance.now();
+			await adapter.adapt(builder);
+			console.log(`adapter: cloudflare in ${((performance.now() - started) / 1000).toFixed(2)}s`);
+			if (process.env.VITE_STATIC_EXPORT === 'true') {
+				await indexSearch(builder.getBuildDirectory('cloudflare'));
+				const shell = path.join(builder.getBuildDirectory('cloudflare'), '_file-browser.html');
+				const fallbackStarted = performance.now();
+				await builder.generateFallback(shell);
+				console.log(
+					`adapter: file browser shell in ${((performance.now() - fallbackStarted) / 1000).toFixed(2)}s`
+				);
+				writeFileSync(
+					shell,
+					readFileSync(shell, 'utf8').replace(
+						'</body>',
+						'<noscript><p>Enable JavaScript to use the file browser.</p></noscript></body>'
+					)
+				);
+				if (process.env.VITE_PUBLIC_EDITION === 'true') {
+					writeFileSync(
+						'build/generated/public-routes.json',
+						JSON.stringify(
+							Object.fromEntries(
+								[...builder.prerendered.pages].map(([route, page]) => [route, page.file])
+							)
+						)
+					);
+				}
+			}
+			const directory = builder.getBuildDirectory('');
+			renameSync(`${directory}/worker.js`, `${directory}/svelte-worker.js`);
+			writeFileSync(`${directory}/worker.js`, "export { default } from '../../worker/index.ts';\n");
+		}
+	};
+}